�* �Reading this pseudo variable will return the program counter at the start of the current input line. Assignment to this variable is possible when .FEATURE pc_assignment is used. Note: You should not use assignments to *, use .ORG instead. *https://cc65.github.io/doc/ca65.html#ss9.1.asize �&Reading this pseudo variable will return the current size of the Accumulator in bits. For the 65816 instruction set .ASIZE will return either 8 or 16, depending on the current size of the operand in immediate accu addressing mode. For all other CPU instruction sets, .ASIZE will always return 8. Example: ; Reverse Subtract with Accumulator ; A = memory - A .macro rsb param .if .asize = 8 eor #$ff .else eor #$ffff .endif sec adc param .endmacro See also: .ISIZE *https://cc65.github.io/doc/ca65.html#ss9.2.cpu �MReading this pseudo variable will give a constant integer value that tells which CPU is currently enabled. It can also tell which instruction set the CPU is able to translate. The value read from the pseudo variable should be further examined by using one of the constants defined by the "cpu" macro package (see .MACPACK). It may be used to replace the .IFPxx pseudo instructions or to construct even more complex expressions. Example: .macpack cpu .if (.cpu .bitand CPU_ISET_65816) phx phy .else txa pha tya pha .endif *https://cc65.github.io/doc/ca65.html#ss9.3.isize �<Reading this pseudo variable will return the current size of the Index register in bits. For the 65816 instruction set .ISIZE will return either 8 or 16, depending on the current size of the operand in immediate index addressing mode. For all other CPU instruction sets, .ISIZE will always return 8. See also: .ASIZE *https://cc65.github.io/doc/ca65.html#ss9.4 .paramcount �%This builtin pseudo variable is only available in macros. It is replaced by the actual number of parameters that were given in the macro invocation. Example: .macro foo arg1, arg2, arg3 3 .error "Too few parameters for macro foo" .endif ... .endmacro See section Macros. *https://cc65.github.io/doc/ca65.html#ss9.5.time �
Reading this pseudo variable will give a constant integer value that represents the current time in POSIX standard (as seconds since the Epoch). It may be used to encode the time of translation somewhere in the created code. Example: .dword .time ; Place time here *https://cc65.github.io/doc/ca65.html#ss9.6.version �gReading this pseudo variable will give the assembler version according to the following formula: (VER_MAJOR * 0x100) + VER_MINOR The upper 8 bits are the major-, the lower 8 bits are the minor version. Example: For example, version 47.11 of the assembler would have this macro defined as 0x2f0b. Note: until 2.19 this pseudo variable was defined as (VER_MAJOR * 0x100) + VER_MINOR * 0x10 - which resulted in broken values starting at version 2.16 of the assembler. For this reason the value of this pseudo variable is considered purely informal - you should not use it to check for a specific assembler version and use different code according to the detected version - please update your code to work with the recent version of the assembler instead (There is very little reason to not use the most recent version - and even less to support older versions in your code). *https://cc65.github.io/doc/ca65.html#ss9.7 .addrsize ��The .ADDRSIZE function is used to return the internal address size associated with a symbol. This can be helpful in macros when knowing the address size of a symbol can help with custom instructions. Example: .macro myLDA foo .if .ADDRSIZE(foo) = 1 ;do custom command based on zeropage addressing: .byte 0A5h, foo .elseif .ADDRSIZE(foo) = 2 ;do custom command based on absolute addressing: .byte 0ADh .word foo .elseif .ADDRSIZE(foo) = 0 ; no address size defined for this symbol: .out .sprintf("Error, address size unknown for symbol %s", .string(foo)) .endif .endmacro +https://cc65.github.io/doc/ca65.html#ss10.1.bank �{The .BANK function is used to support systems with banked memory. The argument is an expression with exactly one segment reference -- usually a label. The function result is the value of the bank attribute assigned to the run memory area of the segment. Please see the linker documentation for more information about memory areas and their attributes. The value of .BANK can be used to switch memory so that a memory bank containing specific data is available. The bank attribute is a 32-bit integer, and so is the result of the .BANK function. You will have to use .LOBYTE or similar functions to address just part of it. Please note that .BANK always will get evaluated in the link stage, so an expression containing .BANK never can be used where a constant, known result is expected (for example, with .RES). Example: .segment "BANK1" .proc banked_func_1 ... .endproc +https://cc65.github.io/doc/ca65.html#ss10.2 .bankbyte �The function returns the bank byte (that is, bits 16-23) of its argument. It works identical to the '^' operator. See: .HIBYTE .LOBYTE +https://cc65.github.io/doc/ca65.html#ss10.3.blank �EBuiltin function. The function evaluates its argument in parentheses and yields "false" if the argument is non blank (there is an argument), and "true" if there is no argument. The token list that makes up the function argument may optionally be enclosed in curly braces. This allows the inclusion of tokens that would otherwise terminate the list (the closing right parenthesis). The curly braces are not considered part of the list, a list just consisting of curly braces is considered to be empty. As an example, the .IFBLANK statement may be replaced by .if .blank({arg}) +https://cc65.github.io/doc/ca65.html#ss10.4.concat ��Builtin string function. The function allows to concatenate a list of string constants separated by commas. The result is a string constant that is the concatenation of all arguments. This function is most useful in macros and when used together with the .STRING builtin function. The function may be used in any case where a string constant is expected. Example: .include .concat ("myheader", ".", "inc") This is the same as the command .include "myheader.inc" +https://cc65.github.io/doc/ca65.html#ss10.5.const �.Builtin function. The function evaluates its argument in parentheses and yields "true" if the argument is a constant expression (that is, an expression that yields a constant value at assembly time) and "false" otherwise. As an example, the .IFCONST statement may be replaced by .if .const(a + 3) +https://cc65.github.io/doc/ca65.html#ss10.6.def �lBuiltin function. The function expects an identifier as argument in parentheses. The argument is evaluated, and the function yields "true" if the identifier is a symbol that already is defined somewhere in the source file up to the current position. Otherwise, the function yields false. As an example, the .IFDEF statement may be replaced by .if .defined(a) +https://cc65.github.io/doc/ca65.html#ss10.7.defined �lBuiltin function. The function expects an identifier as argument in parentheses. The argument is evaluated, and the function yields "true" if the identifier is a symbol that already is defined somewhere in the source file up to the current position. Otherwise, the function yields false. As an example, the .IFDEF statement may be replaced by .if .defined(a) +https://cc65.github.io/doc/ca65.html#ss10.7
.definedmacro �9Builtin function. The function expects an identifier as argument in parentheses. The argument is evaluated, and the function yields "true" if the identifier already has been defined as the name of a macro. Otherwise, the function yields false. Example: .macro add foo clc adc foo .endmacro +https://cc65.github.io/doc/ca65.html#ss10.8.hibyte kThe function returns the high byte (that is, bits 8-15) of its argument. ' operator. See: .LOBYTE .BANKBYTE +https://cc65.github.io/doc/ca65.html#ss10.9.hiword VThe function returns the high word (that is, bits 16-31) of its argument. See: .LOWORD ,https://cc65.github.io/doc/ca65.html#ss10.10.ident �]The function expects a string as its argument, and converts this argument into an identifier. If the string starts with the current .LOCALCHAR, it will be converted into a cheap local identifier, otherwise it will be converted into a normal identifier. Example: .macro makelabel arg1, arg2 .ident (.concat (arg1, arg2)): .endmacro ,https://cc65.github.io/doc/ca65.html#ss10.11.ismnem �eBuiltin function. The function expects an identifier as argument in parentheses. The argument is evaluated, and the function yields "true" if the identifier is defined as an instruction mnemonic that is recognized by the assembler. Example: .if .not .ismnemonic(ina) .macro ina clc adc #$01 .endmacro .endif ,https://cc65.github.io/doc/ca65.html#ss10.12 .ismnemonic �eBuiltin function. The function expects an identifier as argument in parentheses. The argument is evaluated, and the function yields "true" if the identifier is defined as an instruction mnemonic that is recognized by the assembler. Example: .if .not .ismnemonic(ina) .macro ina clc adc #$01 .endmacro .endif ,https://cc65.github.io/doc/ca65.html#ss10.12.left �wBuiltin function. Extracts the left part of a given token list. Syntax: .LEFT (<int expr>, <token list>) The first integer expression gives the number of tokens to extract from the token list. The second argument is the token list itself. The token list may optionally be enclosed into curly braces. This allows the inclusion of tokens that would otherwise terminate the list (the closing right paren in the given case). Example: To check in a macro if the given argument has a '#' as first token (immediate addressing mode), use something like this: .macro ldax arg ... .if (.match (.left (1, {arg}), #)) ,https://cc65.github.io/doc/ca65.html#ss10.13.lobyte �The function returns the low byte (that is, bits 0-7) of its argument. It works identical to the '<' operator. See: .HIBYTE .BANKBYTE ,https://cc65.github.io/doc/ca65.html#ss10.14.loword TThe function returns the low word (that is, bits 0-15) of its argument. See: .HIWORD ,https://cc65.github.io/doc/ca65.html#ss10.15.match ��Builtin function. Matches two token lists against each other. This is most useful within macros, since macros are not stored as strings, but as lists of tokens. The syntax is .MATCH(<token list #1>, <token list #2>) Both token list may contain arbitrary tokens with the exception of the terminator token (comma resp. right parenthesis) and end-of-line end-of-file The token lists may optionally be enclosed into curly braces. This allows the inclusion of tokens that would otherwise terminate the list (the closing right paren in the given case). Often a macro parameter is used for any of the token lists. Please note that the function does only compare tokens, not token attributes. So any number is equal to any other number, regardless of the actual value. The same is true for strings. If you need to compare tokens and token attributes, use the .XMATCH function. Example: Assume the macro ASR, that will shift right the accumulator by one, while honoring the sign bit. The builtin processor instructions will allow an optional "A" for accu addressing for instructions like ROL and ROR. We will use the .MATCH function to check for this and print and error for invalid calls. .macro asr arg ,https://cc65.github.io/doc/ca65.html#ss10.16.max �Builtin function. The result is the larger of two values. The syntax is .MAX (<value #1>, <value #2>) Example: ; Reserve space for the larger of two data blocks savearea: .res .max (.sizeof (foo), .sizeof (bar)) See: .MIN ,https://cc65.github.io/doc/ca65.html#ss10.17.mid �Builtin function. Takes a starting index, a count and a token list as arguments. Will return part of the token list. Syntax: .MID (<int expr>, <int expr>, <token list>) The first integer expression gives the starting token in the list (the first token has index 0). The second integer expression gives the number of tokens to extract from the token list. The third argument is the token list itself. The token list may optionally be enclosed into curly braces. This allows the inclusion of tokens that would otherwise terminate the list (the closing right paren in the given case). Example: To check in a macro if the given argument has a '#' as first token (immediate addressing mode), use something like this: .macro ldax arg ... .if (.match (.mid (0, 1, {arg}), #)) ,https://cc65.github.io/doc/ca65.html#ss10.18.min �Builtin function. The result is the smaller of two values. The syntax is .MIN (<value #1>, <value #2>) Example: ; Reserve space for some data, but 256 bytes maximum savearea: .res .min (.sizeof (foo), 256) See: .MAX ,https://cc65.github.io/doc/ca65.html#ss10.19.ref ��Builtin function. The function expects an identifier as argument in parentheses. The argument is evaluated, and the function yields "true" if the identifier is a symbol that has already been referenced somewhere in the source file up to the current position. Otherwise the function yields false. As an example, the .IFREF statement may be replaced by .if .referenced(a) See: .DEFINED ,https://cc65.github.io/doc/ca65.html#ss10.20 .referenced ��Builtin function. The function expects an identifier as argument in parentheses. The argument is evaluated, and the function yields "true" if the identifier is a symbol that has already been referenced somewhere in the source file up to the current position. Otherwise the function yields false. As an example, the .IFREF statement may be replaced by .if .referenced(a) See: .DEFINED ,https://cc65.github.io/doc/ca65.html#ss10.20.right ��Builtin function. Extracts the right part of a given token list. Syntax: .RIGHT (<int expr>, <token list>) The first integer expression gives the number of tokens to extract from the token list. The second argument is the token list itself. The token list may optionally be enclosed into curly braces. This allows the inclusion of tokens that would otherwise terminate the list (the closing right paren in the given case). See also the .LEFT and .MID builtin functions. ,https://cc65.github.io/doc/ca65.html#ss10.21.sizeof �^.SIZEOF() is a pseudo function that returns the size of its argument. The argument can be a struct/union, a struct member, a scope/procedure, or a label. In the case of a procedure or label, its size is defined by the amount of data placed in the segment where the label is relative to. If a line of code switches segments (for example, in a macro), data placed in other segments does not count for the size. Please note that a symbol or scope must exist before it can be used together with .SIZEOF() (that may get relaxed later, but always will be true for scopes). A scope has preference over a symbol with the same name; so, if the last part of a name represents both a scope and a symbol, then the scope is chosen over the symbol. After the following code: .struct Point ; Struct size = 4 xcoord .word ycoord .word .endstruct ,https://cc65.github.io/doc/ca65.html#ss10.22.sprintf �BBuiltin function. It expects a format string as first argument. The number and type of the following arguments depend on the format string. The format string is similar to the one of the C printf function. Missing things are: Length modifiers, variable width. The result of the function is a string. Example: num = 3 ,https://cc65.github.io/doc/ca65.html#ss10.23.strat �UBuiltin function. The function accepts a string and an index as arguments and returns the value of the character at the given position as an integer value. The index is zero based. Example: .macro M Arg ; Check if the argument string starts with '#' .if (.strat (Arg, 0) = '#') ... .endif .endmacro ,https://cc65.github.io/doc/ca65.html#ss10.24.string ��Builtin function. The function accepts an argument in parentheses and converts this argument into a string constant. The argument may be an identifier, or a constant numeric value. Since you can use a string in the first place, the use of the function may not be obvious. However, it is useful in macros, or more complex setups. Example: ; Emulate other assemblers: .macro section name .segment .string(name) .endmacro ,https://cc65.github.io/doc/ca65.html#ss10.25.strlen �Builtin function. The function accepts a string argument in parentheses and evaluates to the length of the string. Example: The following macro encodes a string as a pascal style string with a leading length byte. .macro PString Arg .byte .strlen(Arg), Arg .endmacro ,https://cc65.github.io/doc/ca65.html#ss10.26.tcount �lBuiltin function. The function accepts a token list in parentheses. The function result is the number of tokens given as argument. The token list may optionally be enclosed into curly braces which are not considered part of the list and not counted. Enclosement in curly braces allows the inclusion of tokens that would otherwise terminate the list (the closing right paren in the given case). Example: The ldax macro accepts the '#' token to denote immediate addressing (as with the normal 6502 instructions). To translate it into two separate 8 bit load instructions, the '#' token has to get stripped from the argument: .macro ldax arg .if (.match (.mid (0, 1, {arg}), #)) ; ldax called with immediate operand lda #<(.right (.tcount ({arg})-1, {arg})) (.right (.tcount ({arg})-1, {arg})) .else ... .endif .endmacro ,https://cc65.github.io/doc/ca65.html#ss10.27.xmatch �Builtin function. Matches two token lists against each other. This is most useful within macros, since macros are not stored as strings, but as lists of tokens. The syntax is .XMATCH(<token list #1>, <token list #2>) Both token list may contain arbitrary tokens with the exception of the terminator token (comma resp. right parenthesis) and end-of-line end-of-file The token lists may optionally be enclosed into curly braces. This allows the inclusion of tokens that would otherwise terminate the list (the closing right paren in the given case). Often a macro parameter is used for any of the token lists. The function compares tokens and token values. If you need a function that just compares the type of tokens, have a look at the .MATCH function. See: .MATCH ,https://cc65.github.io/doc/ca65.html#ss10.28.a16 �Valid only in 65816 mode. Assume the accumulator is 16 bit. Note: This command will not emit any code, it will tell the assembler to create 16 bit operands for immediate accumulator addressing mode. See also: .SMART +https://cc65.github.io/doc/ca65.html#ss11.1.a8 �Valid only in 65816 mode. Assume the accumulator is 8 bit. Note: This command will not emit any code, it will tell the assembler to create 8 bit operands for immediate accu addressing mode. See also: .SMART +https://cc65.github.io/doc/ca65.html#ss11.2.addr ��Define word sized data. In 6502 mode, this is an alias for .WORD and may be used for better readability if the data words are address values. In 65816 mode, the address is forced to be 16 bit wide to fit into the current segment. See also .FARADDR. The command must be followed by a sequence of (not necessarily constant) expressions. Example: .addr $0D00, $AF13, _Clear See: .FARADDR, .WORD +https://cc65.github.io/doc/ca65.html#ss11.3.align �g Align data to a given boundary. The command expects a constant integer argument in the range 1 ... 65536, plus an optional second argument in byte range. If there is a second argument, it is used as fill value, otherwise the value defined in the linker configuration file is used (the default for this value is zero). .ALIGN will insert fill bytes, and the number of fill bytes depend of the final address of the segment. .ALIGN cannot insert a variable number of bytes, since that would break address calculations within the module. So each .ALIGN expects the segment to be aligned to a multiple of the alignment, because that allows the number of fill bytes to be calculated in advance by the assembler. You are therefore required to specify a matching alignment for the segment in the linker config. The linker will output a warning if the alignment of the segment is less than what is necessary to have a correct alignment in the object file. Example: .align 256 Some unexpected behaviour might occur if there are multiple .ALIGN commands with different arguments. To allow the assembler to calculate the number of fill bytes in advance, the alignment of the segment must be a multiple of each of the alignment factors. This may result in unexpectedly large alignments for the segment within the module. Example: .align 15 .byte 15 .align 18 .byte 18 For the assembler to be able to align correctly, the segment must be aligned to the least common multiple of 15 and 18 which is 90. The assembler will calculate this automatically and will mark the segment with this value. Unfortunately, the combined alignment may get rather large without the user knowing about it, wasting space in the final executable. If we add another alignment to the example above .align 15 .byte 15 .align 18 .byte 18 .align 251 .byte 0 the assembler will force a segment alignment to the least common multiple of 15, 18 and 251 - which is 22590. To protect the user against errors, when the combined alignment is larger than the explicitly requested alignments, the assembler will issue a warning if it also exceeds 256. The command line option --large-alignment will disable this warning. Please note that with only alignments that are a power of two, a warning will never occur, because the least common multiple of powers to the same base is always simply the larger one. +https://cc65.github.io/doc/ca65.html#ss11.4.asciiz ��Define a string with a trailing zero. Example: Msg: .asciiz "Hello world" This will put the string "Hello world" followed by a binary zero into the current segment. There may be more strings separated by commas, but the binary zero is only appended once (after the last one). Strings will be translated using the current character mapping definition. See: .BYTE, .CHARMAP .LITERAL +https://cc65.github.io/doc/ca65.html#ss11.5.assert ��Add an assertion. The command is followed by an expression, an action specifier, and an optional message that is output in case the assertion fails. If no message was given, the string "Assertion failed" is used. The action specifier may be one of warning, error, ldwarning or lderror. In the former two cases, the assertion is evaluated by the assembler if possible, and in any case, it's also passed to the linker in the object file (if one is generated). The linker will then evaluate the expression when segment placement has been done. Example: .assert * = $8000, error, "Code not at $8000" The example assertion will check that the current location is at $8000, when the output file is written, and abort with an error if this is not the case. More complex expressions are possible. The action specifier warning outputs a warning, while the error specifier outputs an error message. In the latter case, generation of the output file is suppressed in both the assembler and linker. +https://cc65.github.io/doc/ca65.html#ss11.6 .autoimport ��Is followed by a plus or a minus character. When switched on (using a +), undefined symbols are automatically marked as import instead of giving errors. When switched off (which is the default so this does not make much sense), this does not happen and an error message is displayed. The state of the autoimport flag is evaluated when the complete source was translated, before outputting actual code, so it is not possible to switch this feature on or off for separate sections of code. The last setting is used for all symbols. You should probably not use this switch because it delays error messages about undefined symbols until the link stage. The cc65 compiler (which is supposed to produce correct assembler code in all circumstances, something which is not true for most assembler programmers) will insert this command to avoid importing each and every routine from the runtime library. Example: .autoimport + ; Switch on auto import +https://cc65.github.io/doc/ca65.html#ss11.7
.bankbytes � Define byte sized data by extracting only the bank byte (that is, bits 16-23) from each expression. This is equivalent to .BYTE with the operator '^' prepended to each expression in its list. Example: .define MyTable TableItem0, TableItem1, TableItem2, TableItem3 +https://cc65.github.io/doc/ca65.html#ss11.8.bss �Switch to the BSS segment. The name of the BSS segment is always "BSS", so this is a shortcut for .segment "BSS" See also the .SEGMENT command. +https://cc65.github.io/doc/ca65.html#ss11.9.byt �Define byte sized data. Must be followed by a sequence of (byte ranged) expressions or strings. Strings will be translated using the current character mapping definition. Example: .byte "Hello " .byt "world", $0D, $00 See: .ASCIIZ, .CHARMAP .LITERAL ,https://cc65.github.io/doc/ca65.html#ss11.10.byte �Define byte sized data. Must be followed by a sequence of (byte ranged) expressions or strings. Strings will be translated using the current character mapping definition. Example: .byte "Hello " .byt "world", $0D, $00 See: .ASCIIZ, .CHARMAP .LITERAL ,https://cc65.github.io/doc/ca65.html#ss11.10.case �MSwitch on or off case sensitivity on identifiers. The default is off (that is, identifiers are case sensitive), but may be changed by the -i switch on the command line. The command can be followed by a '+' or '-' character to switch the option on or off respectively. Example: .case - ; Identifiers are not case sensitive ,https://cc65.github.io/doc/ca65.html#ss11.11.charmap ��Apply a custom mapping for characters for the commands .ASCIIZ and .BYTE. The command is followed by two numbers. The first one is the index of the source character (range 0..255); the second one is the mapping (range 0..255). The mapping applies to all character and string constants when they generate output; and, overrides a mapping table specified with the -t command line switch. Example: .charmap $41, $61 ; Map 'A' to 'a' ,https://cc65.github.io/doc/ca65.html#ss11.12.code �Switch to the CODE segment. The name of the CODE segment is always "CODE", so this is a shortcut for .segment "CODE" See also the .SEGMENT command. ,https://cc65.github.io/doc/ca65.html#ss11.13.condes �vExport a symbol and mark it in a special way. The linker is able to build tables of all such symbols. This may be used to automatically create a list of functions needed to initialize linked library modules. Note: The linker has a feature to build a table of marked routines, but it is your code that must call these routines, so just declaring a symbol with .CONDES does nothing by itself. All symbols are exported as an absolute (16 bit) symbol. You don't need to use an additional .EXPORT statement, this is implied by .CONDES. .CONDES is followed by the type, which may be constructor destructor or a numeric value between 0 and 6 (where 0 is the same as specifying constructor and 1 is equal to specifying destructor). The .CONSTRUCTOR, .DESTRUCTOR and .INTERRUPTOR commands are actually shortcuts for .CONDES with a type of constructor resp. destructor or interruptor. After the type, an optional priority may be specified. Higher numeric values mean higher priority. If no priority is given, the default priority of 7 is used. Be careful when assigning priorities to your own module constructors so they won't interfere with the ones in the cc65 library. Example: .condes ModuleInit, constructor .condes ModInit, 0, 16 See the .CONSTRUCTOR, .DESTRUCTOR and .INTERRUPTOR commands and the separate section Module constructors/destructors explaining the feature in more detail. ,https://cc65.github.io/doc/ca65.html#ss11.14 .constructor ��Export a symbol and mark it as a module constructor. This may be used together with the linker to build a table of constructor subroutines that are called by the startup code. Note: The linker has a feature to build a table of marked routines, but it is your code that must call these routines, so just declaring a symbol as constructor does nothing by itself. A constructor is always exported as an absolute (16 bit) symbol. You don't need to use an additional .export statement, this is implied by .constructor. It may have an optional priority that is separated by a comma. Higher numeric values mean a higher priority. If no priority is given, the default priority of 7 is used. Be careful when assigning priorities to your own module constructors so they won't interfere with the ones in the cc65 library. Example: .constructor ModuleInit .constructor ModInit, 16 See the .CONDES and .DESTRUCTOR commands and the separate section Module constructors/destructors explaining the feature in more detail. ,https://cc65.github.io/doc/ca65.html#ss11.15.data �Switch to the DATA segment. The name of the DATA segment is always "DATA", so this is a shortcut for .segment "DATA" See also the .SEGMENT command. ,https://cc65.github.io/doc/ca65.html#ss11.16.dbyt �)Define word sized data with the hi and lo bytes swapped (use .WORD to create word sized data in native 65XX format). Must be followed by a sequence of (word ranged) expressions. Example: .dbyt $1234, $4512 This will emit the bytes $12 $34 $45 $12 into the current segment in that order. ,https://cc65.github.io/doc/ca65.html#ss11.17
.debuginfo �DSwitch on or off debug info generation. The default is off (that is, the object file will not contain debug infos), but may be changed by the -g switch on the command line. The command can be followed by a '+' or '-' character to switch the option on or off respectively. Example: .debuginfo + ; Generate debug info ,https://cc65.github.io/doc/ca65.html#ss11.18.define �^Start a define style macro definition. The command is followed by an identifier (the macro name) and optionally by a list of formal arguments in parentheses. Please note that .DEFINE shares most disadvantages with its C counterpart, so the general advice is, NOT do use .DEFINE if you don't have to. See also the .UNDEFINE command and section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.19.delmac �Delete a classic macro (defined with .MACRO) . The command is followed by the name of an existing macro. Its definition will be deleted together with the name. If necessary, another macro with this name may be defined later. See: .ENDMACRO .EXITMACRO .MACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.20 .delmacro �Delete a classic macro (defined with .MACRO) . The command is followed by the name of an existing macro. Its definition will be deleted together with the name. If necessary, another macro with this name may be defined later. See: .ENDMACRO .EXITMACRO .MACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.20 .destructor ��Export a symbol and mark it as a module destructor. This may be used together with the linker to build a table of destructor subroutines that are called by the startup code. Note: The linker has a feature to build a table of marked routines, but it is your code that must call these routines, so just declaring a symbol as constructor does nothing by itself. A destructor is always exported as an absolute (16 bit) symbol. You don't need to use an additional .export statement, this is implied by .destructor. It may have an optional priority that is separated by a comma. Higher numerical values mean a higher priority. If no priority is given, the default priority of 7 is used. Be careful when assigning priorities to your own module destructors so they won't interfere with the ones in the cc65 library. Example: .destructor ModuleDone .destructor ModDone, 16 See the .CONDES and .CONSTRUCTOR commands and the separate section Module constructors/destructors explaining the feature in more detail. ,https://cc65.github.io/doc/ca65.html#ss11.21.dword xDefine dword sized data (4 bytes) Must be followed by a sequence of expressions. Example: .dword $12344512, $12FA489 ,https://cc65.github.io/doc/ca65.html#ss11.22.else 4Conditional assembly: Reverse the current condition. ,https://cc65.github.io/doc/ca65.html#ss11.23.elseif CConditional assembly: Reverse current condition and test a new one. ,https://cc65.github.io/doc/ca65.html#ss11.24.end gForced end of assembly. Assembly stops at this point, even if the command is read from an include file. ,https://cc65.github.io/doc/ca65.html#ss11.25.endenum End a .ENUM declaration. ,https://cc65.github.io/doc/ca65.html#ss11.26.endif 5Conditional assembly: Close a .IF... or .ELSE branch. ,https://cc65.github.io/doc/ca65.html#ss11.27.endmac ��Marks the end of a macro definition. Note, .ENDMACRO should be on its own line to successfully end the macro definition. It is possible to use .DEFINE to create a symbol that references .ENDMACRO without ending the macro definition. Example: .macro new_mac .define startmac .macro .define endmac .endmacro .endmacro See: .DELMACRO .EXITMACRO .MACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.28 .endmacro ��Marks the end of a macro definition. Note, .ENDMACRO should be on its own line to successfully end the macro definition. It is possible to use .DEFINE to create a symbol that references .ENDMACRO without ending the macro definition. Example: .macro new_mac .define startmac .macro .define endmac .endmacro .endmacro See: .DELMACRO .EXITMACRO .MACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.28.endproc +End of the local lexical level (see .PROC). ,https://cc65.github.io/doc/ca65.html#ss11.29.endrep End a .REPEAT block. ,https://cc65.github.io/doc/ca65.html#ss11.30
.endrepeat End a .REPEAT block. ,https://cc65.github.io/doc/ca65.html#ss11.30 .endscope ,End of the local lexical level (see .SCOPE). ,https://cc65.github.io/doc/ca65.html#ss11.31
.endstruct gEnds a struct definition. See the .STRUCT command and the separate section named "Structs and unions". ,https://cc65.github.io/doc/ca65.html#ss11.32 .endunion eEnds a union definition. See the .UNION command and the separate section named "Structs and unions". ,https://cc65.github.io/doc/ca65.html#ss11.33.enum �Start an enumeration. This directive is very similar to the C enum keyword. If a name is given, a new scope is created for the enumeration, otherwise the enumeration members are placed in the enclosing scope. In the enumeration body, symbols are declared. The first symbol has a value of zero, and each following symbol will get the value of the preceding, plus one. That behaviour may be overridden by an explicit assignment. Two symbols may have the same value. Example: .enum errorcodes no_error file_error parse_error .endenum The above example will create a new scope named errorcodes with three symbols in it that get the values 0, 1, and 2 respectively. Another way to write that would have been: .scope errorcodes no_error = 0 file_error = 1 parse_error = 2 .endscope Please note that explicit scoping must be used to access the identifiers: .word errorcodes::no_error A more complex example: .enum EUNKNOWN = -1 EOK EFILE EBUSY EAGAIN EWOULDBLOCK = EAGAIN .endenum In that example, the enumeration does not have a name, which means that the members will be visible in the enclosing scope, and can be used in that scope without explicit scoping. The first member (EUNKNOWN) has the value -1. The values for the following members are incremented by one; so, EOK would be zero, and so on. EWOULDBLOCK is an alias for EAGAIN; so, it has an override for the value, using an already defined symbol. ,https://cc65.github.io/doc/ca65.html#ss11.34.error ��Force an assembly error. The assembler will output an error message preceded by "User error". Assembly is continued but no object file will generated. This command may be used to check for initial conditions that must be set before assembling a source file. Example: .if foo = 1 ... .elseif bar = 1 ... .else .error "Must define foo or bar!" .endif See also: .FATAL .OUT .WARNING ,https://cc65.github.io/doc/ca65.html#ss11.35.exitmac �Abort a macro expansion immediately. This command is often useful in recursive macros. See: .DELMACRO .ENDMACRO .MACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.36
.exitmacro �Abort a macro expansion immediately. This command is often useful in recursive macros. See: .DELMACRO .ENDMACRO .MACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.36.export ��Make symbols accessible from other modules. Must be followed by a comma separated list of symbols to export, with each one optionally followed by an address specification and (also optional) an assignment. Using an additional assignment in the export statement allows to define and export a symbol in one statement. The default is to export the symbol with the address size it actually has. The assembler will issue a warning, if the symbol is exported with an address size smaller than the actual address size. Examples: .export foo .export bar: far .export foobar: far = foo * bar .export baz := foobar, zap: far = baz - bar As with constant definitions, using := instead of = marks the symbols as a label. See: .EXPORTZP ,https://cc65.github.io/doc/ca65.html#ss11.37 .exportzp �kMake symbols accessible from other modules. Must be followed by a comma separated list of symbols to export. The exported symbols are explicitly marked as zero page symbols. An assignment may be included in the .EXPORTZP statement. This allows to define and export a symbol in one statement. Examples: .exportzp foo, bar .exportzp baz := $02 See: .EXPORT ,https://cc65.github.io/doc/ca65.html#ss11.38.faraddr �Define far (24 bit) address data. The command must be followed by a sequence of (not necessarily constant) expressions. Example: .faraddr DrawCircle, DrawRectangle, DrawHexagon See: .ADDR ,https://cc65.github.io/doc/ca65.html#ss11.39.fatal ��Force an assembly error and terminate assembly. The assembler will output an error message preceded by "User error" and will terminate assembly immediately. This command may be used to check for initial conditions that must be set before assembling a source file. Example: .if foo = 1 ... .elseif bar = 1 ... .else .fatal "Must define foo or bar!" .endif See also: .ERROR .OUT .WARNING ,https://cc65.github.io/doc/ca65.html#ss11.40.feature ��This directive may be used to enable one or more compatibility features of the assembler. While the use of .FEATURE should be avoided when possible, it may be useful when porting sources written for other assemblers. After the feature name an optional '+' or '-' may specify whether to enable or disable the feature (enable if omitted). Multiple features may be enabled, separated by commas. Examples: ; enable c_comments .feature c_comments .feature c_comments + ; enable force_range, disable underline_in_numbers, enable labels_without_colons .feature force_range, underline_in_numbers -, labels_without_colons + .feature force_range +, underline_in_numbers off, labels_without_colons on The following features are available: ,https://cc65.github.io/doc/ca65.html#ss11.41.fileopt ��Insert an option string into the object file. There are two forms of this command, one specifies the option by a keyword, the second specifies it as a number. Since usage of the second one needs knowledge of the internal encoding, its use is not recommended and I will only describe the first form here. The command is followed by one of the keywords author comment compiler a comma and a string. The option is written into the object file together with the string value. This is currently unidirectional and there is no way to actually use these options once they are in the object file. Examples: .fileopt comment, "Code stolen from my brother" .fileopt compiler, "BASIC 2.0" .fopt author, "J. R. User" ,https://cc65.github.io/doc/ca65.html#ss11.42.fopt ��Insert an option string into the object file. There are two forms of this command, one specifies the option by a keyword, the second specifies it as a number. Since usage of the second one needs knowledge of the internal encoding, its use is not recommended and I will only describe the first form here. The command is followed by one of the keywords author comment compiler a comma and a string. The option is written into the object file together with the string value. This is currently unidirectional and there is no way to actually use these options once they are in the object file. Examples: .fileopt comment, "Code stolen from my brother" .fileopt compiler, "BASIC 2.0" .fopt author, "J. R. User" ,https://cc65.github.io/doc/ca65.html#ss11.42 .forceimport ��Import an absolute symbol from another module. The command is followed by a comma separated list of symbols to import. The command is similar to .IMPORT, but the import reference is always written to the generated object file, even if the symbol is never referenced ( .IMPORT will not generate import references for unused symbols). Example: .forceimport needthisone, needthistoo See: .IMPORT ,https://cc65.github.io/doc/ca65.html#ss11.43.global �*Declare symbols as global. Must be followed by a comma separated list of symbols to declare. Symbols from the list, that are defined somewhere in the source, are exported, all others are imported. Additional .IMPORT or .EXPORT commands for the same symbol are allowed. Example: .global foo, bar ,https://cc65.github.io/doc/ca65.html#ss11.44 .globalzp �tDeclare symbols as global. Must be followed by a comma separated list of symbols to declare. Symbols from the list, that are defined somewhere in the source, are exported, all others are imported. Additional .IMPORTZP or .EXPORTZP commands for the same symbol are allowed. The symbols in the list are explicitly marked as zero page symbols. Example: .globalzp foo, bar ,https://cc65.github.io/doc/ca65.html#ss11.45.hibytes ��Define byte sized data by extracting only the high byte (that is, bits 8-15) from each expression. This is equivalent to .BYTE with ' prepended to each expression in its list. Example: .lobytes $1234, $2345, $3456, $4567 .hibytes $fedc, $edcb, $dcba, $cba9 which is equivalent to .byte $34, $45, $56, $67 .byte $fe, $ed, $dc, $cb Example: .define MyTable TableItem0, TableItem1, TableItem2, TableItem3 ,https://cc65.github.io/doc/ca65.html#ss11.46.i16 �Valid only in 65816 mode. Assume the index registers are 16 bit. Note: This command will not emit any code, it will tell the assembler to create 16 bit operands for immediate operands. See also the .I8 and .SMART commands. ,https://cc65.github.io/doc/ca65.html#ss11.47.i8 �Valid only in 65816 mode. Assume the index registers are 8 bit. Note: This command will not emit any code, it will tell the assembler to create 8 bit operands for immediate operands. See also the .I16 and .SMART commands. ,https://cc65.github.io/doc/ca65.html#ss11.48.if �Conditional assembly: Evaluate an expression and switch assembler output on or off depending on the expression. The expression must be a constant expression, that is, all operands must be defined. A expression value of zero evaluates to FALSE, any other value evaluates to TRUE. ,https://cc65.github.io/doc/ca65.html#ss11.49.ifblank �MConditional assembly: Check if there are any remaining tokens in this line, and evaluate to FALSE if this is the case, and to TRUE otherwise. If the condition is not true, further lines are not assembled until an .ELSE, .ELSEIF or .ENDIF directive. This command is often used to check if a macro parameter was given. Since an empty macro parameter will evaluate to nothing, the condition will evaluate to TRUE if an empty parameter was given. Example: .macro arg1, arg2 .ifblank arg2 lda #arg1 .else lda #arg2 .endif .endmacro See also: .BLANK ,https://cc65.github.io/doc/ca65.html#ss11.50.ifconst � Conditional assembly: Evaluate an expression and switch assembler output on or off depending on the constness of the expression. A const expression evaluates to to TRUE, a non const expression (one containing an imported or currently undefined symbol) evaluates to FALSE. See also: .CONST ,https://cc65.github.io/doc/ca65.html#ss11.51.ifdef �Conditional assembly: Check if a symbol is defined. Must be followed by a symbol name. The condition is true if the given symbol is already defined, and false otherwise. See also: .DEFINED ,https://cc65.github.io/doc/ca65.html#ss11.52 .ifnblank �DConditional assembly: Check if there are any remaining tokens in this line, and evaluate to TRUE if this is the case, and to FALSE otherwise. If the condition is not true, further lines are not assembled until an .ELSE, .ELSEIF or .ENDIF directive. This command is often used to check if a macro parameter was given. Since an empty macro parameter will evaluate to nothing, the condition will evaluate to FALSE if an empty parameter was given. Example: .macro arg1, arg2 lda #arg1 .ifnblank arg2 lda #arg2 .endif .endmacro See also: .BLANK ,https://cc65.github.io/doc/ca65.html#ss11.53.ifndef �Conditional assembly: Check if a symbol is defined. Must be followed by a symbol name. The condition is true if the given symbol is not defined, and false otherwise. See also: .DEFINED ,https://cc65.github.io/doc/ca65.html#ss11.54.ifnref �Conditional assembly: Check if a symbol is referenced. Must be followed by a symbol name. The condition is true if the given symbol was not referenced before, and false otherwise. See also: .REFERENCED ,https://cc65.github.io/doc/ca65.html#ss11.55.ifp02 ZConditional assembly: Check if the assembler is currently in 6502 mode (see .P02 command). ,https://cc65.github.io/doc/ca65.html#ss11.56.ifp4510 \Conditional assembly: Check if the assembler is currently in 4510 mode (see .P4510 command). ,https://cc65.github.io/doc/ca65.html#ss11.57.ifp816 \Conditional assembly: Check if the assembler is currently in 65816 mode (see .P816 command). ,https://cc65.github.io/doc/ca65.html#ss11.58.ifpc02 \Conditional assembly: Check if the assembler is currently in 65C02 mode (see .PC02 command). ,https://cc65.github.io/doc/ca65.html#ss11.59.ifpdtv ^Conditional assembly: Check if the assembler is currently in 6502DTV mode (see .PDTV command). ,https://cc65.github.io/doc/ca65.html#ss11.60.ifpsc02 ^Conditional assembly: Check if the assembler is currently in 65SC02 mode (see .PSC02 command). ,https://cc65.github.io/doc/ca65.html#ss11.61.ifref ��Conditional assembly: Check if a symbol is referenced. Must be followed by a symbol name. The condition is true if the given symbol was referenced before, and false otherwise. This command may be used to build subroutine libraries in include files (you may use separate object modules for this purpose too). Example: .ifref ToHex ; If someone used this subroutine ToHex: tay ; Define subroutine lda HexTab,y rts .endif See also: .REFERENCED, and .REFERTO ,https://cc65.github.io/doc/ca65.html#ss11.62.import �Import a symbol from another module. The command is followed by a comma separated list of symbols to import, with each one optionally followed by an address specification. Example: .import foo .import bar: zeropage See: .IMPORTZP ,https://cc65.github.io/doc/ca65.html#ss11.63 .importzp �Import a symbol from another module. The command is followed by a comma separated list of symbols to import. The symbols are explicitly imported as zero page symbols (that is, symbols with values in byte range). Example: .importzp foo, bar See: .IMPORT ,https://cc65.github.io/doc/ca65.html#ss11.64.incbin ��Include a file as binary data. The command expects a string argument that is the name of a file to include literally in the current segment. In addition to that, a start offset and a size value may be specified, separated by commas. If no size is specified, all of the file from the start offset to end-of-file is used. If no start position is specified either, zero is assumed (which means that the whole file is inserted). Example: ; Include whole file .incbin "sprites.dat" ,https://cc65.github.io/doc/ca65.html#ss11.65.include jInclude another file. Include files may be nested up to a depth of 16. Example: .include "subs.inc" ,https://cc65.github.io/doc/ca65.html#ss11.66 .interruptor ��Export a symbol and mark it as an interruptor. This may be used together with the linker to build a table of interruptor subroutines that are called in an interrupt. Note: The linker has a feature to build a table of marked routines, but it is your code that must call these routines, so just declaring a symbol as interruptor does nothing by itself. An interruptor is always exported as an absolute (16 bit) symbol. You don't need to use an additional .export statement, this is implied by .interruptor. It may have an optional priority that is separated by a comma. Higher numeric values mean a higher priority. If no priority is given, the default priority of 7 is used. Be careful when assigning priorities to your own module constructors so they won't interfere with the ones in the cc65 library. Example: .interruptor IrqHandler .interruptor Handler, 16 See the .CONDES command and the separate section Module constructors/destructors explaining the feature in more detail. ,https://cc65.github.io/doc/ca65.html#ss11.67.list ��Enable output to the listing. The command can be followed by a boolean switch ("on", "off", "+" or "-") and will enable or disable listing output. The option has no effect if the listing is not enabled by the command line switch -l. If -l is used, an internal counter is set to 1. Lines are output to the listing file, if the counter is greater than zero, and suppressed if the counter is zero. Each use of .LIST will increment or decrement the counter. Example: .list on ; Enable listing output ,https://cc65.github.io/doc/ca65.html#ss11.68
.listbytes ��Set, how many bytes are shown in the listing for one source line. The default is 12, so the listing will show only the first 12 bytes for any source line that generates more than 12 bytes of code or data. The directive needs an argument, which is either "unlimited", or an integer constant in the range 4..255. Examples: .listbytes unlimited ; List all bytes .listbytes 12 ; List the first 12 bytes .incbin "data.bin" ; Include large binary file ,https://cc65.github.io/doc/ca65.html#ss11.69.literal �Define byte sized data. Must be followed by a sequence of (byte ranged) expressions or strings. Strings will disregard the current character mapping definition and will be interpreted literally. Example: .literal "Hello " .literal "world", $0D, $00 See: .ASCIIZ, .BYTE ,https://cc65.github.io/doc/ca65.html#ss11.70.lobytes ��Define byte sized data by extracting only the low byte (that is, bits 0-7) from each expression. This is equivalent to .BYTE with the operator '<' prepended to each expression in its list. Example: .lobytes $1234, $2345, $3456, $4567 .hibytes $fedc, $edcb, $dcba, $cba9 which is equivalent to .byte $34, $45, $56, $67 .byte $fe, $ed, $dc, $cb Example: .define MyTable TableItem0, TableItem1, TableItem2, TableItem3 ,https://cc65.github.io/doc/ca65.html#ss11.71.local ��This command may only be used inside a macro definition. It declares a list of identifiers as local to the macro expansion. A problem when using macros are labels: Since they don't change their name, you get a "duplicate symbol" error if the macro is expanded the second time. Labels declared with .LOCAL have their name mapped to an internal unique name (___ABCD__) with each macro invocation. Some other assemblers start a new lexical block inside a macro expansion. This has some drawbacks however, since that will not allow any symbol to be visible outside a macro, a feature that is sometimes useful. The .LOCAL command is in my eyes a better way to address the problem. You get an error when using .LOCAL outside a macro. ,https://cc65.github.io/doc/ca65.html#ss11.72
.localchar �DDefines the character that start "cheap" local labels. You may use one of '@' and '?' as start character. The default is '@'. Cheap local labels are labels that are visible only between two non cheap labels. This way you can reuse identifiers like "loop" without using explicit lexical nesting. Example: .localchar '?' ,https://cc65.github.io/doc/ca65.html#ss11.73.macpack �LInsert a predefined macro package. The command is followed by an identifier specifying the macro package to insert. Available macro packages are: atari Defines the scrcode macro. cbm Defines the scrcode macro. cpu Defines constants for the .CPU variable. generic Defines generic macros like add, sub, and blt. longbranch Defines conditional long-jump macros. Including a macro package twice, or including a macro package that redefines already existing macros will lead to an error. Example: .macpack longbranch ; Include macro package ,https://cc65.github.io/doc/ca65.html#ss11.74.mac �yStart a classic macro definition. The command is followed by an identifier (the macro name) and optionally by a comma separated list of identifiers that are macro parameters. A macro definition is terminated by .ENDMACRO. Example: .macro ldax arg ; Define macro ldax lda arg ldx arg+1 See: .DELMACRO .ENDMACRO .EXITMACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.75.macro �yStart a classic macro definition. The command is followed by an identifier (the macro name) and optionally by a comma separated list of identifiers that are macro parameters. A macro definition is terminated by .ENDMACRO. Example: .macro ldax arg ; Define macro ldax lda arg ldx arg+1 See: .DELMACRO .ENDMACRO .EXITMACRO See also section Macros. ,https://cc65.github.io/doc/ca65.html#ss11.75.org �]Start a section of absolute code. The command is followed by a constant expression that gives the new PC counter location for which the code is assembled. Use .RELOC to switch back to relocatable code. By default, absolute/relocatable mode is global (valid even when switching segments). Using .FEATURE org_per_seg it can be made segment local. Please note that you do not need .ORG in most cases. Placing code at a specific address is the job of the linker, not the assembler, so there is usually no reason to assemble code to a specific address. Example: .org $7FF ; Emit code starting at $7FF ,https://cc65.github.io/doc/ca65.html#ss11.76.out � Output a string to the console without producing an error. This command is similar to .ERROR, however, it does not force an assembler error that prevents the creation of an object file. Example: .out "This code was written by the codebuster(tm)" See also: .ERROR .FATAL .WARNING ,https://cc65.github.io/doc/ca65.html#ss11.77.p02 �Enable the 6502 instruction set, disable 65SC02, 65C02 and 65816 instructions. This is the default if not overridden by the --cpu command line option. See: .PC02, .PSC02, .P816 and .P4510 ,https://cc65.github.io/doc/ca65.html#ss11.78.p4510 ~Enable the 4510 instruction set. This is a superset of the 65C02 and 6502 instruction sets. See: .P02, .PSC02, .PC02 and .P816 ,https://cc65.github.io/doc/ca65.html#ss11.79.p816 �Enable the 65816 instruction set. This is a superset of the 65SC02 and 6502 instruction sets. See: .P02, .PSC02, .PC02 and .P4510 ,https://cc65.github.io/doc/ca65.html#ss11.80.pagelen �7Set the page length for the listing. Must be followed by an integer constant. The value may be "unlimited", or in the range 32 to 127. The statement has no effect if no listing is generated. The default value is -1 (unlimited) but may be overridden by the --pagelength command line option. Beware: Since ca65 is a one pass assembler, the listing is generated after assembly is complete, you cannot use multiple line lengths with one source. Instead, the value set with the last .PAGELENGTH is used. Examples: .pagelength 66 ; Use 66 lines per listing page ,https://cc65.github.io/doc/ca65.html#ss11.81 .pagelength �7Set the page length for the listing. Must be followed by an integer constant. The value may be "unlimited", or in the range 32 to 127. The statement has no effect if no listing is generated. The default value is -1 (unlimited) but may be overridden by the --pagelength command line option. Beware: Since ca65 is a one pass assembler, the listing is generated after assembly is complete, you cannot use multiple line lengths with one source. Instead, the value set with the last .PAGELENGTH is used. Examples: .pagelength 66 ; Use 66 lines per listing page ,https://cc65.github.io/doc/ca65.html#ss11.81.pc02 �Enable the 65C02 instructions set. This instruction set includes all 6502 and 65SC02 instructions. See: .P02, .PSC02, .P816 and .P4510 ,https://cc65.github.io/doc/ca65.html#ss11.82.pdtv ]Enable the 6502DTV instruction set. This is a superset of the 6502 instruction set. See: .P02 ,https://cc65.github.io/doc/ca65.html#ss11.83 .popcharmap �tPop the last character mapping from the stack, and activate it. This command will switch back to the character mapping that was last pushed onto the character mapping stack using the .PUSHCHARMAP command, and remove this entry from the stack. The assembler will print an error message if the mappting stack is empty when this command is issued. See: .CHARMAP, .PUSHCHARMAP ,https://cc65.github.io/doc/ca65.html#ss11.84.popcpu �JPop the last CPU setting from the stack, and activate it. This command will switch back to the CPU that was last pushed onto the CPU stack using the .PUSHCPU command, and remove this entry from the stack. The assembler will print an error message if the CPU stack is empty when this command is issued. See: .CPU, .PUSHCPU, .SETCPU ,https://cc65.github.io/doc/ca65.html#ss11.85.popseg �EPop the last pushed segment from the stack, and set it. This command will switch back to the segment that was last pushed onto the segment stack using the .PUSHSEG command, and remove this entry from the stack. The assembler will print an error message if the segment stack is empty when this command is issued. See: .PUSHSEG ,https://cc65.github.io/doc/ca65.html#ss11.86.proc ��Start a nested lexical level with the given name and adds a symbol with this name to the enclosing scope. All new symbols from now on are in the local lexical level and are accessible from outside only via explicit scope specification. Symbols defined outside this local level may be accessed as long as their names are not used for new symbols inside the level. Symbols names in other lexical levels do not clash, so you may use the same names for identifiers. The lexical level ends when the .ENDPROC command is read. Lexical levels may be nested up to a depth of 16 (this is an artificial limit to protect against errors in the source). Note: Macro names are always in the global level and in a separate name space. There is no special reason for this, it's just that I've never had any need for local macro definitions. Example: .proc Clear ; Define Clear subroutine, start new level lda #$00 L1: sta Mem,y ; L1 is local and does not cause a ; duplicate symbol error if used in other ; places dey bne L1 ; Reference local symbol rts .endproc ; Leave lexical level See: .ENDPROC and .SCOPE ,https://cc65.github.io/doc/ca65.html#ss11.87.psc02 {Enable the 65SC02 instructions set. This instruction set includes all 6502 instructions. See: .P02, .PC02, .P816 and .P4510 ,https://cc65.github.io/doc/ca65.html#ss11.88 .pushcharmap ��Push the currently active character mapping onto a stack. The stack has a size of 16 entries. .PUSHCHARMAP allows together with .POPCHARMAP to switch to another character mapping and to restore the old character mapping later, without knowledge of the current mapping. The assembler will print an error message if the character mapping stack is already full, when this command is issued. See: .CHARMAP, .POPCHARMAP ,https://cc65.github.io/doc/ca65.html#ss11.89.pushcpu �bPush the currently active CPU onto a stack. The stack has a size of 8 entries. .PUSHCPU allows together with .POPCPU to switch to another CPU and to restore the old CPU later, without knowledge of the current CPU setting. The assembler will print an error message if the CPU stack is already full, when this command is issued. See: .CPU, .POPCPU, .SETCPU ,https://cc65.github.io/doc/ca65.html#ss11.90.pushseg ��Push the currently active segment onto a stack. The entries on the stack include the name of the segment and the segment type. The stack has a size of 16 entries. .PUSHSEG allows together with .POPSEG to switch to another segment and to restore the old segment later, without even knowing the name and type of the current segment. The assembler will print an error message if the segment stack is already full, when this command is issued. See: .POPSEG ,https://cc65.github.io/doc/ca65.html#ss11.91.referto ��Mark a symbol as referenced. It is useful in combination with the .IFREF command. A subroutine with two entry points can be created. When the first entry point is called, it sets some default value as an argument, and falls through into the second entry point. .REFERTO helps to ensure that the second part is included into binary when only the first entry point is actually used from the code. Example: .ifref NegateValue ; If this subroutine is used NegateValue: ; Define it lda #0 sec sbc Value .ifref ResetValue ; If the ResetValue is also used jmp SetValue ; Jump over it .else .refto SetValue ; Ensure that SetValue will be included .endif .endif ,https://cc65.github.io/doc/ca65.html#ss11.92.refto ��Mark a symbol as referenced. It is useful in combination with the .IFREF command. A subroutine with two entry points can be created. When the first entry point is called, it sets some default value as an argument, and falls through into the second entry point. .REFERTO helps to ensure that the second part is included into binary when only the first entry point is actually used from the code. Example: .ifref NegateValue ; If this subroutine is used NegateValue: ; Define it lda #0 sec sbc Value .ifref ResetValue ; If the ResetValue is also used jmp SetValue ; Jump over it .else .refto SetValue ; Ensure that SetValue will be included .endif .endif ,https://cc65.github.io/doc/ca65.html#ss11.92.reloc 6Switch back to relocatable mode. See the .ORG command. ,https://cc65.github.io/doc/ca65.html#ss11.93.repeat �pRepeat all commands between .REPEAT and .ENDREPEAT constant number of times. The command is followed by a constant expression that tells how many times the commands in the body should get repeated. Optionally, a comma and an identifier may be specified. If this identifier is found in the body of the repeat statement, it is replaced by the current repeat count (starting with zero for the first time the body is repeated). .REPEAT statements may be nested. If you use the same repeat count identifier for a nested .REPEAT statement, the one from the inner level will be used, not the one from the outer level. Example: The following macro will emit a string that is "encrypted" in that all characters of the string are XORed by the value $55. .macro Crypt Arg .repeat .strlen(Arg), I .byte .strat(Arg, I) ^ $55 .endrep .endmacro See: .ENDREPEAT ,https://cc65.github.io/doc/ca65.html#ss11.94.res ��Reserve storage. The command is followed by one or two constant expressions. The first one is mandatory and defines, how many bytes of storage should be defined. The second, optional expression must by a constant byte value that will be used as value of the data. If there is no fill value given, the linker will use the value defined in the linker configuration file (default: zero). Example: ; Reserve 12 bytes of memory with value $AA .res 12, $AA ,https://cc65.github.io/doc/ca65.html#ss11.95.rodata �Switch to the RODATA segment. The name of the RODATA segment is always "RODATA", so this is a shortcut for .segment "RODATA" The RODATA segment is a segment that is used by the compiler for readonly data like string constants. See also the .SEGMENT command. ,https://cc65.github.io/doc/ca65.html#ss11.96.scope ��Start a nested lexical level with the given name. All new symbols from now on are in the local lexical level and are accessible from outside only via explicit scope specification. Symbols defined outside this local level may be accessed as long as their names are not used for new symbols inside the level. Symbols names in other lexical levels do not clash, so you may use the same names for identifiers. The lexical level ends when the .ENDSCOPE command is read. Lexical levels may be nested up to a depth of 16 (this is an artificial limit to protect against errors in the source). Note: Macro names are always in the global level and in a separate name space. There is no special reason for this, it's just that I've never had any need for local macro definitions. Example: .scope Error ; Start new scope named Error None = 0 ; No error File = 1 ; File error Parse = 2 ; Parse error .endscope ; Close lexical level ,https://cc65.github.io/doc/ca65.html#ss11.97.segment � Switch to another segment. Code and data is always emitted into a segment, that is, a named section of data. The default segment is "CODE". There may be up to 254 different segments per object file (and up to 65534 per executable). There are shortcut commands for the most common segments ("ZEROPAGE", "CODE", "RODATA", "DATA", and "BSS"). The command is followed by a string containing the segment name (there are some constraints for the name - as a rule of thumb use only those segment names that would also be valid identifiers). There may also be an optional address size separated by a colon. See the section covering address sizes for more information. The default address size for a segment depends on the memory model specified on the command line. The default is "absolute", which means that you don't have to use an address size modifier in most cases. "absolute" means that the is a segment with 16 bit (absolute) addressing. That is, the segment will reside somewhere in core memory outside the zero page. "zeropage" (8 bit) means that the segment will be placed in the zero page and direct (short) addressing is possible for data in this segment. Beware: Only labels in a segment with the zeropage attribute are marked as reachable by short addressing. The '*' (PC counter) operator will work as in other segments and will create absolute variable values. Please note that a segment cannot have two different address sizes. A segment specified as zeropage cannot be declared as being absolute later. Examples: .segment "ROM2" ; Switch to ROM2 segment .segment "ZP2": zeropage ; New direct segment .segment "ZP2" ; Ok, will use last attribute .segment "ZP2": absolute ; Error, redecl mismatch See: .BSS, .CODE, .DATA, .RODATA, and .ZEROPAGE ,https://cc65.github.io/doc/ca65.html#ss11.98.set [.SET is used to assign a value to a variable. See Numeric variables for a full description. ,https://cc65.github.io/doc/ca65.html#ss11.99.setcpu �HSwitch the CPU instruction set. The command is followed by a string that specifies the CPU. Possible values are those that can also be supplied to the --cpu command line option, namely: 6502, 6502X, 6502DTV, 65SC02, 65C02, 65816, 4510 and HuC6280. See: .CPU .IFP02 .IFPDTV .IFP816 .IFPC02 .IFPSC02 .P02 .P816 .P4510 .PC02 .PSC02 -https://cc65.github.io/doc/ca65.html#ss11.100.smart �~Switch on or off smart mode. The command can be followed by a '+' or '-' character to switch the option on or off respectively. The default is off (that is, the assembler doesn't try to be smart), but this default may be changed by the -s switch on the command line. In smart mode the assembler will do the following: Track usage of the REP and SEP instructions in 65816 mode and update the operand sizes accordingly. If the operand of such an instruction cannot be evaluated by the assembler (for example, because the operand is an imported symbol), a warning is issued. Beware: Since the assembler cannot trace the execution flow this may lead to false results in some cases. If in doubt, use the .Inn and .Ann instructions to tell the assembler about the current settings. In 65816 mode, if the long_jsr_jmp_rts feature is enabled, smart mode will replace a RTS instruction by RTL if it is used within a procedure declared as far, or if the procedure has no explicit address specification, but it is far because of the memory model used. Example: .smart ; Be smart .smart - ; Stop being smart See: .A16 .A8 .I16 .I8 -https://cc65.github.io/doc/ca65.html#ss11.101.struct �Starts a struct definition. Structs are covered in a separate section named "Structs and unions". See also: .ENDSTRUCT .ENDUNION .UNION -https://cc65.github.io/doc/ca65.html#ss11.102.tag �Allocate space for a struct or union. This is equivalent to .RES with the .SIZEOF of a struct. Example: .struct Point xcoord .word ycoord .word .endstruct -https://cc65.github.io/doc/ca65.html#ss11.103.undef �FDelete a define style macro definition. The command is followed by an identifier which specifies the name of the macro to delete. Macro replacement is switched of when reading the token following the command (otherwise the macro name would be replaced by its replacement list). See also the .DEFINE command and section Macros. -https://cc65.github.io/doc/ca65.html#ss11.104 .undefine �FDelete a define style macro definition. The command is followed by an identifier which specifies the name of the macro to delete. Macro replacement is switched of when reading the token following the command (otherwise the macro name would be replaced by its replacement list). See also the .DEFINE command and section Macros. -https://cc65.github.io/doc/ca65.html#ss11.104.union �Starts a union definition. Unions are covered in a separate section named "Structs and unions". See also: .ENDSTRUCT .ENDUNION .STRUCT -https://cc65.github.io/doc/ca65.html#ss11.105.warning �(Force an assembly warning. The assembler will output a warning message preceded by "User warning". This warning will always be output, even if other warnings are disabled with the -W0 command line option. This command may be used to output possible problems when assembling the source file. Example: .macro jne target .local L1 .ifndef target .warning "Forward jump in jne, cannot optimize!" beq L1 jmp target L1: .else ... .endif .endmacro See also: .ERROR .FATAL .OUT -https://cc65.github.io/doc/ca65.html#ss11.106.word �Define word sized data. Must be followed by a sequence of (word ranged, but not necessarily constant) expressions. Example: .word $0D00, $AF13, _Clear -https://cc65.github.io/doc/ca65.html#ss11.107 .zeropage ��Switch to the ZEROPAGE segment and mark it as direct (zeropage) segment. The name of the ZEROPAGE segment is always "ZEROPAGE", so this is a shortcut for .segment "ZEROPAGE": zeropage Because of the "zeropage" attribute, labels declared in this segment are addressed using direct addressing mode if possible. You must instruct the linker to place this segment somewhere in the address range 0..$FF otherwise you will get errors. See: .SEGMENT -https://cc65.github.io/doc/ca65.html#ss11.108