common.h

/*
 * Copyright (c) 2009-2015, Argon Sun (Fluorohydride)
 * Copyright (c) 2017-2024, Edoardo Lolletti (edo9300) <edoardo762@gmail.com>
 *
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
#ifndef COMMON_H_
#define COMMON_H_

#if defined( _MSC_VER) && !defined(__clang_analyzer__)
#pragma warning(disable: 4244)
#define unreachable() __assume(0)
#define NoInline __declspec(noinline)
#define ForceInline __forceinline
#else
#if !defined(__forceinline)
#define ForceInline __attribute__((always_inline)) inline
#else
#define ForceInline __forceinline
#endif
#define unreachable() __builtin_unreachable()
#define NoInline __attribute__ ((noinline))
#endif

#if defined(__clang_analyzer__)
#undef NDEBUG
#endif

#include <cassert>
#include <cstdint>

#define TRUE 1
#define FALSE 0

//Locations
#define LOCATION_DECK    0x01
#define LOCATION_HAND    0x02
#define LOCATION_MZONE   0x04
#define LOCATION_SZONE   0x08
#define LOCATION_GRAVE   0x10
#define LOCATION_REMOVED 0x20
#define LOCATION_EXTRA   0x40
#define LOCATION_OVERLAY 0x80
#define LOCATION_ONFIELD 0x0c
#define LOCATION_FZONE   0x100
#define LOCATION_PZONE   0x200
#define LOCATION_STZONE  0x400
#define LOCATION_MMZONE  0x800
#define LOCATION_EMZONE  0x1000
//For redirect
#define LOCATION_DECKBOT	0x10001		//Return to deck bottom
#define LOCATION_DECKSHF	0x20001		//Return to deck and shuffle

//
#define COIN_HEADS  1
#define COIN_TAILS  0

//Positions
#define POS_FACEUP_ATTACK    0x1
#define POS_FACEDOWN_ATTACK  0x2
#define POS_FACEUP_DEFENSE   0x4
#define POS_FACEDOWN_DEFENSE 0x8
#define POS_FACEUP           0x5
#define POS_FACEDOWN         0xa
#define POS_ATTACK           0x3
#define POS_DEFENSE          0xc

//Flip effect flags
#define NO_FLIP_EFFECT     0x10000

//Types of cards
#define TYPE_MONSTER     0x1
#define TYPE_SPELL       0x2
#define TYPE_TRAP        0x4
#define TYPE_NORMAL      0x10
#define TYPE_EFFECT      0x20
#define TYPE_FUSION      0x40
#define TYPE_RITUAL      0x80
#define TYPE_TRAPMONSTER 0x100
#define TYPE_SPIRIT      0x200
#define TYPE_UNION       0x400
#define TYPE_GEMINI      0x800
#define TYPE_TUNER       0x1000
#define TYPE_SYNCHRO     0x2000
#define TYPE_TOKEN       0x4000
#define TYPE_MAXIMUM     0x8000
#define TYPE_QUICKPLAY   0x10000
#define TYPE_CONTINUOUS  0x20000
#define TYPE_EQUIP       0x40000
#define TYPE_FIELD       0x80000
#define TYPE_COUNTER     0x100000
#define TYPE_FLIP        0x200000
#define TYPE_TOON        0x400000
#define TYPE_XYZ         0x800000
#define TYPE_PENDULUM    0x1000000
#define TYPE_SPSUMMON    0x2000000
#define TYPE_LINK        0x4000000

//Attributes
#define ATTRIBUTE_EARTH  0x01
#define ATTRIBUTE_WATER  0x02
#define ATTRIBUTE_FIRE   0x04
#define ATTRIBUTE_WIND   0x08
#define ATTRIBUTE_LIGHT  0x10
#define ATTRIBUTE_DARK   0x20
#define ATTRIBUTE_DIVINE 0x40
#define ATTRIBUTE_ALL    (ATTRIBUTE_DARK | ATTRIBUTE_DIVINE | ATTRIBUTE_EARTH | ATTRIBUTE_FIRE | ATTRIBUTE_LIGHT | ATTRIBUTE_WATER | ATTRIBUTE_WIND)

//Races
#define RACE_WARRIOR      0x1
#define RACE_SPELLCASTER  0x2
#define RACE_FAIRY        0x4
#define RACE_FIEND        0x8
#define RACE_ZOMBIE       0x10
#define RACE_MACHINE      0x20
#define RACE_AQUA         0x40
#define RACE_PYRO         0x80
#define RACE_ROCK         0x100
#define RACE_WINGEDBEAST  0x200
#define RACE_PLANT        0x400
#define RACE_INSECT       0x800
#define RACE_THUNDER      0x1000
#define RACE_DRAGON       0x2000
#define RACE_BEAST        0x4000
#define RACE_BEASTWARRIOR 0x8000
#define RACE_DINOSAUR     0x10000
#define RACE_FISH         0x20000
#define RACE_SEASERPENT   0x40000
#define RACE_REPTILE      0x80000
#define RACE_PSYCHIC      0x100000
#define RACE_DIVINE       0x200000
#define RACE_CREATORGOD   0x400000
#define RACE_WYRM         0x800000
#define RACE_CYBERSE      0x1000000
#define RACE_ILLUSION     0x2000000
#define RACE_CYBORG       0x4000000
#define RACE_MAGICALKNIGHT     0x8000000
#define RACE_HIGHDRAGON        0x10000000
#define RACE_OMEGAPSYCHIC      0x20000000
#define RACE_CELESTIALWARRIOR  0x40000000
#define RACE_GALAXY            0x80000000
#define RACE_MAX               RACE_GALAXY
#define RACE_ALL               (~(RACE_MAX<<1))

//Reasons
#define REASON_DESTROY     0x1
#define REASON_RELEASE     0x2
#define REASON_TEMPORARY   0x4
#define REASON_MATERIAL    0x8
#define REASON_SUMMON      0x10
#define REASON_BATTLE      0x20
#define REASON_EFFECT      0x40
#define REASON_COST        0x80
#define REASON_ADJUST      0x100
#define REASON_LOST_TARGET 0x200
#define REASON_RULE        0x400
#define REASON_SPSUMMON    0x800
#define REASON_DISSUMMON   0x1000
#define REASON_FLIP        0x2000
#define REASON_DISCARD     0x4000
#define REASON_RDAMAGE     0x8000
#define REASON_RRECOVER    0x10000
#define REASON_RETURN      0x20000
#define REASON_FUSION      0x40000
#define REASON_SYNCHRO     0x80000
#define REASON_RITUAL      0x100000
#define REASON_XYZ         0x200000
#define REASON_REPLACE     0x1000000
#define REASON_DRAW        0x2000000
#define REASON_REDIRECT    0x4000000
//#define REASON_REVEAL      0x8000000
#define REASON_LINK        0x10000000

//Status
#define STATUS_DISABLED           0x0001
#define STATUS_TO_ENABLE          0x0002
#define STATUS_TO_DISABLE         0x0004
#define STATUS_PROC_COMPLETE      0x0008
#define STATUS_SET_TURN           0x0010
#define STATUS_NO_LEVEL           0x0020
#define STATUS_BATTLE_RESULT      0x0040
#define STATUS_SPSUMMON_STEP      0x0080
#define STATUS_FORM_CHANGED       0x0100
#define STATUS_SUMMONING          0x0200
#define STATUS_EFFECT_ENABLED     0x0400
#define STATUS_SUMMON_TURN        0x0800
#define STATUS_DESTROY_CONFIRMED  0x1000
#define STATUS_LEAVE_CONFIRMED    0x2000
#define STATUS_BATTLE_DESTROYED   0x4000
#define STATUS_COPYING_EFFECT     0x8000
#define STATUS_CHAINING           0x10000
#define STATUS_SUMMON_DISABLED    0x20000
#define STATUS_ACTIVATE_DISABLED  0x40000
#define STATUS_EFFECT_REPLACED    0x80000
#define STATUS_FUTURE_FUSION      0x100000
#define STATUS_ATTACK_CANCELED    0x200000
#define STATUS_INITIALIZING       0x400000
//#define STATUS_ACTIVATED          0x800000
#define STATUS_JUST_POS           0x1000000
#define STATUS_CONTINUOUS_POS     0x2000000
#define STATUS_FORBIDDEN          0x4000000
#define STATUS_ACT_FROM_HAND      0x8000000
#define STATUS_OPPO_BATTLE        0x10000000
#define STATUS_FLIP_SUMMON_TURN   0x20000000
#define STATUS_SPSUMMON_TURN      0x40000000

//Query list
#define QUERY_CODE         0x1
#define QUERY_POSITION     0x2
#define QUERY_ALIAS        0x4
#define QUERY_TYPE         0x8
#define QUERY_LEVEL        0x10
#define QUERY_RANK         0x20
#define QUERY_ATTRIBUTE    0x40
#define QUERY_RACE         0x80
#define QUERY_ATTACK       0x100
#define QUERY_DEFENSE      0x200
#define QUERY_BASE_ATTACK  0x400
#define QUERY_BASE_DEFENSE 0x800
#define QUERY_REASON       0x1000
#define QUERY_REASON_CARD  0x2000
#define QUERY_EQUIP_CARD   0x4000
#define QUERY_TARGET_CARD  0x8000
#define QUERY_OVERLAY_CARD 0x10000
#define QUERY_COUNTERS     0x20000
#define QUERY_OWNER        0x40000
#define QUERY_STATUS       0x80000
#define QUERY_IS_PUBLIC    0x100000
#define QUERY_LSCALE       0x200000
#define QUERY_RSCALE       0x400000
#define QUERY_LINK         0x800000
#define QUERY_IS_HIDDEN	   0x1000000
#define QUERY_COVER        0x2000000
#define QUERY_END          0x80000000

//Link markers
#define LINK_MARKER_BOTTOM_LEFT  0001
#define LINK_MARKER_BOTTOM       0002
#define LINK_MARKER_BOTTOM_RIGHT 0004
#define LINK_MARKER_LEFT         0010
#define LINK_MARKER_RIGHT        0040
#define LINK_MARKER_TOP_LEFT     0100
#define LINK_MARKER_TOP          0200
#define LINK_MARKER_TOP_RIGHT    0400

//Messages
#define MSG_RETRY                1
#define MSG_HINT                 2
#define MSG_WAITING              3
#define MSG_START                4
#define MSG_WIN                  5
#define MSG_UPDATE_DATA          6
#define MSG_UPDATE_CARD          7
#define MSG_REQUEST_DECK         8
#define MSG_SELECT_BATTLECMD     10
#define MSG_SELECT_IDLECMD       11
#define MSG_SELECT_EFFECTYN      12
#define MSG_SELECT_YESNO         13
#define MSG_SELECT_OPTION        14
#define MSG_SELECT_CARD          15
#define MSG_SELECT_CHAIN         16
#define MSG_SELECT_PLACE         18
#define MSG_SELECT_POSITION      19
#define MSG_SELECT_TRIBUTE       20
#define MSG_SORT_CHAIN           21
#define MSG_SELECT_COUNTER       22
#define MSG_SELECT_SUM           23
#define MSG_SELECT_DISFIELD      24
#define MSG_SORT_CARD            25
#define MSG_SELECT_UNSELECT_CARD 26
#define MSG_CONFIRM_DECKTOP      30
#define MSG_CONFIRM_CARDS        31
#define MSG_SHUFFLE_DECK         32
#define MSG_SHUFFLE_HAND         33
#define MSG_REFRESH_DECK         34
#define MSG_SWAP_GRAVE_DECK      35
#define MSG_SHUFFLE_SET_CARD     36
#define MSG_REVERSE_DECK         37
#define MSG_DECK_TOP             38
#define MSG_SHUFFLE_EXTRA        39
#define MSG_NEW_TURN             40
#define MSG_NEW_PHASE            41
#define MSG_CONFIRM_EXTRATOP     42
#define MSG_MOVE                 50
#define MSG_POS_CHANGE           53
#define MSG_SET                  54
#define MSG_SWAP                 55
#define MSG_FIELD_DISABLED       56
#define MSG_SUMMONING            60
#define MSG_SUMMONED             61
#define MSG_SPSUMMONING          62
#define MSG_SPSUMMONED           63
#define MSG_FLIPSUMMONING        64
#define MSG_FLIPSUMMONED         65
#define MSG_CHAINING             70
#define MSG_CHAINED              71
#define MSG_CHAIN_SOLVING        72
#define MSG_CHAIN_SOLVED         73
#define MSG_CHAIN_END            74
#define MSG_CHAIN_NEGATED        75
#define MSG_CHAIN_DISABLED       76
#define MSG_CARD_SELECTED        80
#define MSG_RANDOM_SELECTED      81
#define MSG_BECOME_TARGET        83
#define MSG_DRAW                 90
#define MSG_DAMAGE               91
#define MSG_RECOVER              92
#define MSG_EQUIP                93
#define MSG_LPUPDATE             94
#define MSG_UNEQUIP              95
#define MSG_CARD_TARGET          96
#define MSG_CANCEL_TARGET        97
#define MSG_PAY_LPCOST           100
#define MSG_ADD_COUNTER          101
#define MSG_REMOVE_COUNTER       102
#define MSG_ATTACK               110
#define MSG_BATTLE               111
#define MSG_ATTACK_DISABLED      112
#define MSG_DAMAGE_STEP_START    113
#define MSG_DAMAGE_STEP_END      114
#define MSG_MISSED_EFFECT        120
#define MSG_BE_CHAIN_TARGET      121
#define MSG_CREATE_RELATION      122
#define MSG_RELEASE_RELATION     123
#define MSG_TOSS_COIN            130
#define MSG_TOSS_DICE            131
#define MSG_ROCK_PAPER_SCISSORS  132
#define MSG_HAND_RES             133
#define MSG_ANNOUNCE_RACE        140
#define MSG_ANNOUNCE_ATTRIB      141
#define MSG_ANNOUNCE_CARD        142
#define MSG_ANNOUNCE_NUMBER      143
#define MSG_CARD_HINT            160
#define MSG_TAG_SWAP             161
#define MSG_RELOAD_FIELD         162 // Debug.ReloadFieldEnd()
#define MSG_AI_NAME              163
#define MSG_SHOW_HINT            164
#define MSG_PLAYER_HINT          165
#define MSG_MATCH_KILL           170
#define MSG_CUSTOM_MSG           180
#define MSG_REMOVE_CARDS         190

#define OLD_REPLAY_MODE          231

//Hints
#define HINT_EVENT      1
#define HINT_MESSAGE    2
#define HINT_SELECTMSG  3
#define HINT_OPSELECTED 4
#define HINT_EFFECT     5
#define HINT_RACE       6
#define HINT_ATTRIB     7
#define HINT_CODE       8
#define HINT_NUMBER     9
#define HINT_CARD       10
#define HINT_ZONE       11


#define CHINT_TURN        1
#define CHINT_CARD        2
#define CHINT_RACE        3
#define CHINT_ATTRIBUTE   4
#define CHINT_NUMBER      5
#define CHINT_DESC_ADD    6
#define CHINT_DESC_REMOVE 7

#define PHINT_DESC_ADD    6
#define PHINT_DESC_REMOVE 7

#define EFFECT_CLIENT_MODE_NORMAL  0
#define EFFECT_CLIENT_MODE_RESOLVE 1
#define EFFECT_CLIENT_MODE_RESET   2

#define OPCODE_ADD          0x4000000000000000
#define OPCODE_SUB          0x4000000100000000
#define OPCODE_MUL          0x4000000200000000
#define OPCODE_DIV          0x4000000300000000
#define OPCODE_AND          0x4000000400000000
#define OPCODE_OR           0x4000000500000000
#define OPCODE_NEG          0x4000000600000000
#define OPCODE_NOT          0x4000000700000000
#define OPCODE_BAND         0x4000000800000000
#define OPCODE_BOR          0x4000000900000000
#define OPCODE_BNOT         0x4000001000000000
#define OPCODE_BXOR         0x4000001100000000
#define OPCODE_LSHIFT       0x4000001200000000
#define OPCODE_RSHIFT       0x4000001300000000
#define OPCODE_ALLOW_ALIASES 0x4000001400000000
#define OPCODE_ALLOW_TOKENS 0x4000001500000000
#define OPCODE_ISCODE       0x4000010000000000
#define OPCODE_ISSETCARD    0x4000010100000000
#define OPCODE_ISTYPE       0x4000010200000000
#define OPCODE_ISRACE       0x4000010300000000
#define OPCODE_ISATTRIBUTE  0x4000010400000000
#define OPCODE_GETCODE      0x4000010500000000
#define OPCODE_GETSETCARD   0x4000010600000000
#define OPCODE_GETTYPE      0x4000010700000000
#define OPCODE_GETRACE      0x4000010800000000
#define OPCODE_GETATTRIBUTE 0x4000010900000000

//Players
#define PLAYER_NONE 2
#define PLAYER_ALL  3
#define PLAYER_SELFDES  5

//Phases
#define PHASE_DRAW          0x01
#define PHASE_STANDBY       0x02
#define PHASE_MAIN1         0x04
#define PHASE_BATTLE_START  0x08
#define PHASE_BATTLE_STEP   0x10
#define PHASE_DAMAGE        0x20
#define PHASE_DAMAGE_CAL    0x40
#define PHASE_BATTLE        0x80
#define PHASE_MAIN2         0x100
#define PHASE_END           0x200

//Options
#define DUEL_TEST_MODE         0x01
#define DUEL_ATTACK_FIRST_TURN 0x02
#define DUEL_USE_TRAPS_IN_NEW_CHAIN 0x04
#define DUEL_6_STEP_BATLLE_STEP 0x08
#define DUEL_PSEUDO_SHUFFLE    0x10
#define DUEL_TRIGGER_WHEN_PRIVATE_KNOWLEDGE 0x20
#define DUEL_SIMPLE_AI         0x40
#define DUEL_RELAY             0x80
#define DUEL_OBSOLETE_IGNITION 0x100
#define DUEL_1ST_TURN_DRAW     0x200
#define DUEL_1_FACEUP_FIELD    0x400
#define DUEL_PZONE             0x800
#define DUEL_SEPARATE_PZONE    0x1000
#define DUEL_EMZONE            0x2000
#define DUEL_FSX_MMZONE        0x4000
#define DUEL_TRAP_MONSTERS_NOT_USE_ZONE    0x8000
#define DUEL_RETURN_TO_DECK_TRIGGERS 0x10000
#define DUEL_TRIGGER_ONLY_IN_LOCATION      0x20000
#define DUEL_SPSUMMON_ONCE_OLD_NEGATE      0x40000
#define DUEL_CANNOT_SUMMON_OATH_OLD        0x80000
#define DUEL_NO_STANDBY_PHASE  0x100000
#define DUEL_NO_MAIN_PHASE_2   0x200000
#define DUEL_3_COLUMNS_FIELD   0x400000
#define DUEL_DRAW_UNTIL_5      0x800000
#define DUEL_NO_HAND_LIMIT     0x1000000
#define DUEL_UNLIMITED_SUMMONS 0x2000000
#define DUEL_INVERTED_QUICK_PRIORITY       0x4000000
#define DUEL_EQUIP_NOT_SENT_IF_MISSING_TARGET       0x8000000
#define DUEL_0_ATK_DESTROYED   0x10000000
#define DUEL_STORE_ATTACK_REPLAYS   0x20000000
#define DUEL_SINGLE_CHAIN_IN_DAMAGE_SUBSTEP   0x40000000
#define DUEL_CAN_REPOS_IF_NON_SUMPLAYER 0x80000000
#define DUEL_TCG_SEGOC_NONPUBLIC	   0x100000000
#define DUEL_TCG_SEGOC_FIRSTTRIGGER 0x200000000
#define DUEL_MODE_SPEED        (DUEL_3_COLUMNS_FIELD | DUEL_NO_MAIN_PHASE_2 | DUEL_TRAP_MONSTERS_NOT_USE_ZONE | DUEL_TRIGGER_ONLY_IN_LOCATION)
#define DUEL_MODE_RUSH         (DUEL_3_COLUMNS_FIELD | DUEL_NO_MAIN_PHASE_2 | DUEL_NO_STANDBY_PHASE | DUEL_1ST_TURN_DRAW | DUEL_INVERTED_QUICK_PRIORITY | DUEL_DRAW_UNTIL_5 | DUEL_NO_HAND_LIMIT | DUEL_UNLIMITED_SUMMONS | DUEL_TRAP_MONSTERS_NOT_USE_ZONE | DUEL_TRIGGER_ONLY_IN_LOCATION)
#define DUEL_MODE_MR1          (DUEL_OBSOLETE_IGNITION | DUEL_1ST_TURN_DRAW | DUEL_1_FACEUP_FIELD | DUEL_SPSUMMON_ONCE_OLD_NEGATE | DUEL_RETURN_TO_DECK_TRIGGERS | DUEL_CANNOT_SUMMON_OATH_OLD)
#define DUEL_MODE_GOAT         (DUEL_MODE_MR1 | DUEL_USE_TRAPS_IN_NEW_CHAIN | DUEL_6_STEP_BATLLE_STEP | DUEL_TRIGGER_WHEN_PRIVATE_KNOWLEDGE | DUEL_EQUIP_NOT_SENT_IF_MISSING_TARGET | DUEL_0_ATK_DESTROYED | DUEL_STORE_ATTACK_REPLAYS | DUEL_SINGLE_CHAIN_IN_DAMAGE_SUBSTEP | DUEL_CAN_REPOS_IF_NON_SUMPLAYER | DUEL_TCG_SEGOC_NONPUBLIC | DUEL_TCG_SEGOC_FIRSTTRIGGER)
#define DUEL_MODE_MR2          (DUEL_1ST_TURN_DRAW | DUEL_1_FACEUP_FIELD | DUEL_SPSUMMON_ONCE_OLD_NEGATE | DUEL_RETURN_TO_DECK_TRIGGERS | DUEL_CANNOT_SUMMON_OATH_OLD)
#define DUEL_MODE_MR3          (DUEL_PZONE | DUEL_SEPARATE_PZONE | DUEL_SPSUMMON_ONCE_OLD_NEGATE | DUEL_RETURN_TO_DECK_TRIGGERS | DUEL_CANNOT_SUMMON_OATH_OLD)
#define DUEL_MODE_MR4          (DUEL_PZONE | DUEL_EMZONE | DUEL_SPSUMMON_ONCE_OLD_NEGATE | DUEL_RETURN_TO_DECK_TRIGGERS | DUEL_CANNOT_SUMMON_OATH_OLD)
#define DUEL_MODE_MR5          (DUEL_PZONE | DUEL_EMZONE | DUEL_FSX_MMZONE | DUEL_TRAP_MONSTERS_NOT_USE_ZONE | DUEL_TRIGGER_ONLY_IN_LOCATION)
#define DUEL_MODE_MR1_FORB     (TYPE_XYZ | TYPE_PENDULUM | TYPE_LINK)
#define DUEL_MODE_MR2_FORB     (TYPE_PENDULUM | TYPE_LINK)
#define DUEL_MODE_MR3_FORB     TYPE_LINK
#define DUEL_MODE_MR4_FORB     0
#define DUEL_MODE_MR5_FORB     0

enum ActivityType : uint8_t {
	ACTIVITY_SUMMON = 1,
	ACTIVITY_NORMALSUMMON = 2,
	ACTIVITY_SPSUMMON = 3,
	ACTIVITY_FLIPSUMMON = 4,
	ACTIVITY_ATTACK = 5,
	ACTIVITY_BATTLE_PHASE = 6,
	ACTIVITY_CHAIN = 7,
};


#endif /* COMMON_H_ */