scripting.h

#ifndef _SCRIPTING_H_INCLUDED
#define _SCRIPTING_H_INCLUDED

#define DELAY_FIRST_BUBBLE      25
#define DELAY_INFO_MESSAGE      50*4

// Command opcodes.
// The @params comments describe each command's byte-stream parameters for the
// debugger's stream visualizer (see @stream on _gCurrentStream). Tokens: an enum
// type name (decoded by name), byte (raw 8-bit), word (16-bit LE / address),
// str (inline NUL-terminated string), end (terminates the linear preview:
// stream-enders and jumps). These are debugger metadata only; they must contain
// ONLY tokens (no prose) and must match the byte layout the handler consumes.
typedef enum
{
	COMMAND_END             = 0,      // @params end
	COMMAND_RECTANGLE       = 1,      // @params byte byte byte byte byte
	COMMAND_FILL_RECTANGLE  = 2,      // @params byte byte byte byte byte
	COMMAND_TEXT            = 3,      // @params byte byte byte str
	COMMAND_WHITE_BUBBLE    = 4,      // @params byte end
	COMMAND_BLACK_BUBBLE    = 5,      // @params byte end
	COMMAND_WAIT            = 6,      // @params byte
	COMMAND_BITMAP          = 7,      // @params byte byte byte word word
	COMMAND_FADE_BUFFER     = 8,      // @params
	COMMAND_JUMP            = 9,      // @params word end
	COMMAND_JUMP_IF_TRUE    = 10,     // @params word cmd:operator_id
	COMMAND_JUMP_IF_FALSE   = 11,     // @params word cmd:operator_id
	COMMAND_INFO_MESSAGE    = 12,     // @params str
	COMMAND_DISPLAY_IMAGE   = 13,     // @params byte
	COMMAND_DISPLAY_IMAGE_ONLY = 14,  // @params byte
	COMMAND_END_AND_REFRESH = 15,     // @params end
	COMMAND_ERROR_MESSAGE   = 16,     // @params str
	COMMAND_SET_ITEM_LOCATION   = 17, // @params item_id location_id
	COMMAND_SET_ITEM_FLAGS  = 18,     // @params item_id item_flags
	COMMAND_UNSET_ITEM_FLAGS = 19,    // @params item_id item_flags
	COMMAND_SET_ITEM_DESCRIPTION = 20,// @params item_id str
	COMMAND_SET_LOCATION_DIRECTION = 21, // @params location_id direction_id location_id
	COMMAND_UNLOCK_ACHIEVEMENT = 22,  // @params achievement
	COMMAND_INCREASE_SCORE  = 23,     // @params word
	COMMAND_GAME_OVER       = 24,     // @params game_over_condition
	COMMAND_CLEAR_FULL_TEXT_AREA = 25,// @params byte
	COMMAND_SET_SCENE_IMAGE = 26,     // @params byte
	COMMAND_DISPLAY_IMAGE_NOBLIT = 27,// @params byte
	COMMAND_CLEAR_TEXT_AREA = 28,     // @params byte
	COMMAND_GOSUB           = 29,     // @params word
	COMMAND_RETURN          = 30,     // @params end
	COMMAND_DO_ONCE         = 31,     // @params byte word
	COMMAND_SET_CUT_SCENE   = 32,     // @params byte
	COMMAND_PLAY_SOUND      = 33,     // @params word
	COMMAND_WAIT_RANDOM     = 34,     // @params byte byte
	COMMAND_START_CLOCK     = 35,     // @params
	COMMAND_STOP_CLOCK      = 36,     // @params
	COMMAND_END_AND_PARTIAL_REFRESH = 37, // @params end
	COMMAND_LOAD_MUSIC      = 38,     // @params byte
	COMMAND_STOP_MUSIC      = 39,     // @params
	COMMAND_WAIT_KEYPRESS   = 40,     // @params
	COMMAND_QUICK_MESSAGE   = 41,     // @params str
	COMMAND_SET_SKIP_POINT  = 42,     // @params word
	COMMAND_SET_PLAYER_LOCATION = 43, // @params location_id
	COMMAND_SET_CURRENT_ITEM = 44,    // @params item_id
	COMMAND_CALL_NATIVE     = 45,     // @params word
	COMMAND_COMBINE_ITEMS   = 46,     // @params item_id item_id item_id item_id
	COMMAND_KEYPRESS_MESSAGE = 47,    // @params str
	COMMAND_CLEAR_BUBBLES   = 48,     // @params
	COMMAND_SET_STRIDE      = 49,     // @params byte
	COMMAND_DISPLAY_IMAGE_NO_CLEAR_TEXT = 50, // @params byte
	_COMMAND_COUNT          = 51
} script_command;

// Operator opcodes (the condition byte + operands after a JUMP_IF_* label).
// @params describe each operator's operands for the debugger stream visualizer.
typedef enum
{
	OPERATOR_CHECK_ITEM_LOCATION   = 0,   // @params item_id location_id
	OPERATOR_CHECK_ITEM_FLAG       = 1,   // @params item_id item_flags
	OPERATOR_CHECK_PLAYER_LOCATION = 2,   // @params location_id
	OPERATOR_CHECK_ITEM_CONTAINER  = 3,   // @params item_id item_id
	OPERATOR_CHECK_ADDRESS_VALUE   = 4    // @params word byte
} operator_id;

#define CHECK_ITEM_LOCATION(item,location)   OPERATOR_CHECK_ITEM_LOCATION,item,location
#define CHECK_ITEM_FLAG(item,flag)           OPERATOR_CHECK_ITEM_FLAG,item,flag
#define CHECK_ITEM_CONTAINER(item,container) OPERATOR_CHECK_ITEM_CONTAINER,item,container
#define CHECK_PLAYER_LOCATION(location)      OPERATOR_CHECK_PLAYER_LOCATION,location
#define CHECK_ADDRESS_VALUE(address,value)   OPERATOR_CHECK_ADDRESS_VALUE,<address,>address,value

// Flow control
#define END                                  .byt COMMAND_END
#define END_AND_REFRESH                      .byt COMMAND_END_AND_REFRESH
#define END_AND_PARTIAL_REFRESH              .byt COMMAND_END_AND_PARTIAL_REFRESH
#define WAIT(duration)                       .byt COMMAND_WAIT,duration
#define WAIT_RANDOM(base_duration,rand_mask) .byt COMMAND_WAIT_RANDOM,base_duration,rand_mask
#define JUMP(label)                          .byt COMMAND_JUMP,<label,>label
#define DO_ONCE(label)                       .byt COMMAND_DO_ONCE,1,<label,>label
#define JUMP_IF_TRUE(label,expression)       .byt COMMAND_JUMP_IF_TRUE,<label,>label,expression
#define JUMP_IF_FALSE(label,expression)      .byt COMMAND_JUMP_IF_FALSE,<label,>label,expression
#define GOSUB(label)                         .byt COMMAND_GOSUB,<label,>label
#define RETURN                               .byt COMMAND_RETURN
#define CALL_NATIVE(address)                 .byt COMMAND_CALL_NATIVE,<address,>address
#define SET_CUT_SCENE(flag)                  .byt COMMAND_SET_CUT_SCENE,flag
#define SET_SKIP_POINT(label)                .byt COMMAND_SET_SKIP_POINT,<label,>label


#ifdef ASSEMBLER
#define IF_TRUE(expression,label)            .byt COMMAND_JUMP_IF_FALSE,<label,>label,expression   
#define IF_FALSE(expression,label)           .byt COMMAND_JUMP_IF_TRUE,<label,>label,expression 
#define ELSE(else,endif)          else = *+3: .byt COMMAND_JUMP,<endif,>endif                                          
#define ENDIF(endif)              endif
#define ENDDO(enddo)              enddo
#endif

// Text
#define INFO_MESSAGE(message)                .byt COMMAND_INFO_MESSAGE,message,0
#define QUICK_MESSAGE(message)               .byt COMMAND_QUICK_MESSAGE,message,0
#define ERROR_MESSAGE(message)               .byt COMMAND_ERROR_MESSAGE,message,0
#define KEYPRESS_MESSAGE(message)            .byt COMMAND_KEYPRESS_MESSAGE,message,0

#define WAIT_KEYPRESS                        .byt COMMAND_WAIT_KEYPRESS
#define CLEAR_BUBBLES                        .byt COMMAND_CLEAR_BUBBLES

#define MAX_BUBBLE 4                         // Should find a way to assert that at compile time
#define WHITE_BUBBLE(bubble_count)           .byt COMMAND_WHITE_BUBBLE,bubble_count
#define BLACK_BUBBLE(bubble_count)           .byt COMMAND_BLACK_BUBBLE,bubble_count
#define _BUBBLE_LINE(x,y,yoffset,text)       .byt x,y,yoffset,text,0
#define CLEAR_TEXT_AREA(paper_color)         .byt COMMAND_CLEAR_TEXT_AREA,16+(paper_color&7)
#define CLEAR_FULL_TEXT_AREA(paper_color)    .byt COMMAND_CLEAR_FULL_TEXT_AREA,16+(paper_color&7)

// Meta game
#define UNLOCK_ACHIEVEMENT(achievement)      .byt COMMAND_UNLOCK_ACHIEVEMENT,achievement
#define DECREASE_SCORE(points)               .byt COMMAND_INCREASE_SCORE,<(65536-points),>(65536-points)
#define INCREASE_SCORE(points)               .byt COMMAND_INCREASE_SCORE,<points,>points
#define GAME_OVER(condition)                 .byt COMMAND_GAME_OVER,condition

#define START_CLOCK                          .byt COMMAND_START_CLOCK
#define STOP_CLOCK                           .byt COMMAND_STOP_CLOCK

// Items
#define SET_CURRENT_ITEM(item)                  .byt COMMAND_SET_CURRENT_ITEM,item
#define SET_ITEM_LOCATION(item,location)        .byt COMMAND_SET_ITEM_LOCATION,item,location
#define SET_ITEM_FLAGS(item,flags)              .byt COMMAND_SET_ITEM_FLAGS,item,flags
#define UNSET_ITEM_FLAGS(item,flags)            .byt COMMAND_UNSET_ITEM_FLAGS,item,255^flags
#define SET_ITEM_DESCRIPTION(item,description)  .byt COMMAND_SET_ITEM_DESCRIPTION,item,description,0
#define COMBINE_ITEMS_2(result,item1,item2)           .byt COMMAND_COMBINE_ITEMS,item1,item2,255,result
#define COMBINE_ITEMS_3(result,item1,item2,item3)     .byt COMMAND_COMBINE_ITEMS,item1,item2,item3,result

// Locations
#define SET_LOCATION_DIRECTION(location,direction,value)  .byt COMMAND_SET_LOCATION_DIRECTION,location,direction,value
#define SET_PLAYER_LOCATION(location)                   .byt COMMAND_SET_PLAYER_LOCATION,location
#define SET_SCENE_IMAGE(imageId)                     .byt COMMAND_SET_SCENE_IMAGE,imageId

// Graphics
#define BLOCK_SIZE(w,h) w,h

// Stride defaults to 40; SET_STRIDE overrides it for the next BITMAP only (auto-resets to 40 after the blit).
#define SET_STRIDE(stride)                           .byt COMMAND_SET_STRIDE,stride

#define DRAW_BITMAP(imageId,size,src,dst)            .byt COMMAND_BITMAP,imageId,size,<src,>src,<dst,>dst
#define DRAW_BITMAP_STRIDE(imageId,size,stride,src,dst)  .byt COMMAND_SET_STRIDE,stride,COMMAND_BITMAP,imageId,size,<src,>src,<dst,>dst
#define DISPLAY_IMAGE(imageId)                       .byt COMMAND_DISPLAY_IMAGE,imageId
#define DISPLAY_IMAGE_NOBLIT(imageId)                .byt COMMAND_DISPLAY_IMAGE_NOBLIT,imageId
#define DISPLAY_IMAGE_ONLY(imageId)                  .byt COMMAND_DISPLAY_IMAGE_ONLY,imageId
#define DISPLAY_IMAGE_NO_CLEAR_TEXT(imageId)         .byt COMMAND_DISPLAY_IMAGE_NO_CLEAR_TEXT,imageId
#define FADE_BUFFER                                  .byt COMMAND_FADE_BUFFER

#define BLIT_BLOCK(imageId,w,h)                      .byt COMMAND_BITMAP,imageId,w,h
#define BLIT_BLOCK_STRIDE(imageId,w,h,stride)        .byt COMMAND_SET_STRIDE,stride,COMMAND_BITMAP,imageId,w,h
#define _BUFFER(x,y)                                 .byt <_ImageBuffer+x+(40*y),>_ImageBuffer+x+(40*y)
#define _IMAGE(x,y)                                  .byt <_SecondImageBuffer+x+(40*y),>_SecondImageBuffer+x+(40*y)
#define _IMAGE_STRIDE(x,y,stride)                    .byt <_SecondImageBuffer+x+(stride*y),>_SecondImageBuffer+x+(stride*y)
#define _SCREEN(x,y)                                 .byt <$a000+x+(40*y),>$a000+x+(40*y)

// Sound 
#ifdef ENABLE_SOUND_EFFECTS
#define PLAY_SOUND(sound)                            .byt COMMAND_PLAY_SOUND,<sound,>sound
#else
#define PLAY_SOUND(sound)                            
#endif

#ifdef ENABLE_MUSIC
#define LOAD_MUSIC(musicId)                          .byt COMMAND_LOAD_MUSIC,musicId
#define STOP_MUSIC()                                 .byt COMMAND_STOP_MUSIC
#else
#define LOAD_MUSIC(musicId)                          
#define STOP_MUSIC()                                 
#endif


// Audio commands
#define SOUND_NOT_PLAYING        255
#define SOUND_FLAG_END           128    // Can be added to a register value to mark the command as finished
#define SOUND_FLAG_END_FRAME     64     // Can be added to a register value to mark the command as the last one for that frame

#define SOUND_COMMAND_END        0      // End of the sound - DO NOT USE DIRECTLY, USE THE FLAG "SOUND_FLAG_END" on the command opcode instead
#define SOUND_COMMAND_END_FRAME  1      // End of command list for this frame
#define SOUND_COMMAND_SET_BANK   2      // Change a complete set of sounds: <14 values copied to registers 0 to 13>
#define SOUND_COMMAND_SET_VALUE  3      // Set a register value: <register index> <value to set>
#define SOUND_COMMAND_ADD_VALUE  4      // Add to a register:    <register index> <value to add>
#define SOUND_COMMAND_REPEAT     5      // Defines the start of a block that will repeat "n" times: <repeat count>
#define SOUND_COMMAND_ENDREPEAT  6      // Defines the end of a repeating block
#define SOUND_COMMAND_SET_VALUE2 7      // Set a 16 bit register value: <register index> <value to set>
#define SOUND_COMMAND_WAIT       8      // Wait a number of frames

#define SOUND_WAIT(delay)                 .byt SOUND_COMMAND_WAIT,delay
#define SOUND_REPEAT(count)               .byt SOUND_COMMAND_REPEAT,count
#define SOUND_ENDREPEAT()                 .byt SOUND_COMMAND_ENDREPEAT

#define SOUND_ADD_VALUE(register,value)   .byt SOUND_COMMAND_ADD_VALUE,register,value
#define SOUND_SET_VALUE(register,value)   .byt SOUND_COMMAND_SET_VALUE,register,value
#define SOUND_SET_VALUE2(register,value)  .byt SOUND_COMMAND_SET_VALUE2,register,<value,>value
#define SOUND_SET_NOISE(freq)             .byt SOUND_COMMAND_SET_VALUE,REG_NOISE_FREQ,freq
#define SOUND_SET_TONE_A(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_A_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE,REG_A_VOLUME,volume 
#define SOUND_SET_TONE_B(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_B_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE,REG_B_VOLUME,volume 
#define SOUND_SET_TONE_C(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_C_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE,REG_C_VOLUME,volume 

#define SOUND_SET_VALUE_END(register,value)   .byt SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END,register,value
#define SOUND_SET_VALUE2_END(register,value)  .byt SOUND_COMMAND_SET_VALUE2|SOUND_FLAG_END,register,<value,>value
#define SOUND_SET_NOISE_END(freq)             .byt SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END,REG_NOISE_FREQ,freq
#define SOUND_SET_TONE_A_END(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_A_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END,REG_A_VOLUME,volume 
#define SOUND_SET_TONE_B_END(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_B_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END,REG_B_VOLUME,volume 
#define SOUND_SET_TONE_C_END(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_C_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END,REG_C_VOLUME,volume 

#define SOUND_ADD_VALUE_ENDFRAME(register,value)   .byt SOUND_COMMAND_ADD_VALUE|SOUND_FLAG_END_FRAME,register,value
#define SOUND_SET_VALUE_ENDFRAME(register,value)   .byt SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END_FRAME,register,value
#define SOUND_SET_VALUE2_ENDFRAME(register,value)  .byt SOUND_COMMAND_SET_VALUE2|SOUND_FLAG_END_FRAME,register,<value,>value
#define SOUND_SET_NOISE_ENDFRAME(freq)             .byt SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END_FRAME,REG_NOISE_FREQ,freq
#define SOUND_SET_TONE_A_ENDFRAME(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_A_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END_FRAME,REG_A_VOLUME,volume 
#define SOUND_SET_TONE_B_ENDFRAME(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_B_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END_FRAME,REG_B_VOLUME,volume 
#define SOUND_SET_TONE_C_ENDFRAME(freq,volume)      .byt SOUND_COMMAND_SET_VALUE2,REG_C_FREQ,<freq,>freq,SOUND_COMMAND_SET_VALUE|SOUND_FLAG_END_FRAME,REG_C_VOLUME,volume 

#define REG_A_FREQ  	  0     ; Chanel A Frequency
#define REG_A_FREQ_LOW	  0     ; Chanel A Frequency (lower 8 bits)
#define REG_A_FREQ_HI	  1     ; Chanel A Frequency (higher 4 bits)

#define REG_B_FREQ        2     ; Chanel B Frequency
#define REG_B_FREQ_LOW	  2     ; Chanel B Frequency (lower 8 bits)
#define REG_B_FREQ_HI	  3     ; Chanel B Frequency (higher 4 bits)

#define REG_C_FREQ	      4     ; Chanel C Frequency
#define REG_C_FREQ_LOW	  4     ; Chanel C Frequency (lower 8 bits)
#define REG_C_FREQ_HI	  5     ; Chanel C Frequency (higher 4 bits)

#define REG_NOISE_FREQ	  6     ; Chanel sound generator (0-31)
#define REG_MIXER		  7     ; Mixer/Selector -> Everything is disabled by default

#define REG_A_VOLUME	  8     ; Volume A
#define REG_B_VOLUME      9     ; Volume B
#define REG_C_VOLUME	 10     ; Volume C

#define REG_ENV          11     ; Wave period
#define REG_ENV_LOW      11     ; Wave period
#define REG_ENV_HI       12     ; Wave period
#define REG_ENV_SHAPE    13     ; Wave form


// Text commands
#define TEXT_END                 255
#define TEXT_CRLF                254

// Stream-stop flags: OR'd together in _gCurrentStreamStop to end/pause a stream.
typedef enum
{
	FLAG_IS_RUNNING          = 0,
	FLAG_END_STREAM          = 1,
	FLAG_WAIT                = 2,
	FLAG_REFRESH_SCENE       = 4,
	FLAG_PARTIAL_REFRESH     = 8
} stream_stop_flags;


// Value mapping
#define MAPPING_DEFAULT          255            // Default handler when no match is found
#define MAPPING_REDIRECT         254            // Redirect: retry search with a different table
#define VALUE_MAPPING(value,address)            .byt value,<address,>address
#define VALUE_MAPPING2(value1,value2,address)   .byt value1,value2,<address,>address
#define COMBINE_MAPPING(value1,value2,address)  .byt (value1<value2)*value1+(value2<value1)*value2,(value1<value2)*value2+(value2<value1)*value1,<address,>address  // Auto-sorted; _DispatchStream2 sorts params to match
#define WORD_MAPPING(value,address,flag)        .byt value,flag,<address,>address

// This mapping list of flags should probably be redone, but good enough for now
// Basically, should separate concepts: Is it CODE or STREAM, and does it require an item(s) lookup in a table
#define FLAG_MAPPING_DEFAULT             0      // Just a simple C or assembler function to call
#define FLAG_MAPPING_STREAM              4      // 0 = Function pointer,  1 = Stream pointer
#define FLAG_MAPPING_STREAM_CALLBACK     8      // No item at all, just a stream callback

#endif // _SCRIPTING_H_INCLUDED