X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fca65.sgml;h=4a14d02766cb6c3642360c1604cf7efd533aad24;hb=7b34609930c5308f9697a665000afba371a7bb21;hp=b1fd5779f50c69cf05bae1c2e74cbde5d0eab130;hpb=f06dc5dfa3a3ac7e22088ad954dde0e713ebbb7a;p=cc65 diff --git a/doc/ca65.sgml b/doc/ca65.sgml index b1fd5779f..4a14d0276 100644 --- a/doc/ca65.sgml +++ b/doc/ca65.sgml @@ -1,9 +1,9 @@ - +
ca65 Users Guide <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"> -<date>19.07.2000, 29.11.2000, 02.10.2001 +<date>2000-07-19, 2000-11-29, 2001-10-02, 2005-09-08 <abstract> ca65 is a powerful macro assembler for the 6502, 65C02 and 65816 CPUs. It is @@ -87,35 +87,44 @@ The assembler accepts the following options: --------------------------------------------------------------------------- Usage: ca65 [options] file Short options: - -D name[=value] Define a symbol - -I dir Set an include directory search path - -U Mark unresolved symbols as import - -V Print the assembler version - -W n Set warning level n - -g Add debug info to object file - -h Help (this text) - -i Ignore case of symbols - -l Create a listing if assembly was ok - -o name Name the output file - -s Enable smart mode - -t sys Set the target system - -v Increase verbosity + -D name[=value] Define a symbol + -I dir Set an include directory search path + -U Mark unresolved symbols as import + -V Print the assembler version + -W n Set warning level n + -g Add debug info to object file + -h Help (this text) + -i Ignore case of symbols + -l name Create a listing file if assembly was ok + -mm model Set the memory model + -o name Name the output file + -s Enable smart mode + -t sys Set the target system + -v Increase verbosity Long options: - --auto-import Mark unresolved symbols as import - --cpu type Set cpu type - --debug-info Add debug info to object file - --feature name Set an emulation feature - --help Help (this text) - --ignore-case Ignore case of symbols - --include-dir dir Set an include directory search path - --list-bytes n Maximum number of bytes per listing line - --listing Create a listing if assembly was ok - --pagelength n Set the page length for the listing - --smart Enable smart mode - --target sys Set the target system - --verbose Increase verbosity - --version Print the assembler version + --auto-import Mark unresolved symbols as import + --bin-include-dir dir Set a search path for binary includes + --cpu type Set cpu type + --create-dep name Create a make dependency file + --create-full-dep name Create a full make dependency file + --debug-info Add debug info to object file + --feature name Set an emulation feature + --forget-inc-paths Forget include search paths + --help Help (this text) + --ignore-case Ignore case of symbols + --include-dir dir Set an include directory search path + --large-alignment Don't warn about large alignments + --listing name Create a listing file if assembly was ok + --list-bytes n Maximum number of bytes per listing line + --macpack-dir dir Set a macro package directory + --memory-model model Set the memory model + --pagelength n Set the page length for the listing + --relax-checks Relax some checks (see docs) + --smart Enable smart mode + --target sys Set the target system + --verbose Increase verbosity + --version Print the assembler version --------------------------------------------------------------------------- </verb></tscreen> @@ -126,18 +135,46 @@ Here is a description of all the command line options: <descrip> + <label id="option--bin-include-dir"> + <tag><tt>--bin-include-dir dir</tt></tag> + + Name a directory which is searched for binary include files. The option + may be used more than once to specify more than one directory to search. The + current directory is always searched first before considering any + additional directories. See also the section about <ref id="search-paths" + name="search paths">. + + <label id="option--cpu"> <tag><tt>--cpu type</tt></tag> Set the default for the CPU type. The option takes a parameter, which may be one of - 6502, 65SC02, 65C02, 65816, sunplus, sweet16 + 6502, 65SC02, 65C02, 65816, sunplus, sweet16, HuC6280 The sunplus cpu is not available in the freeware version, because the instruction set is "proprietary and confidential". + <label id="option-create-dep"> + <tag><tt>--create-dep name</tt></tag> + + Tells the assembler to generate a file containing the dependency list for + the assembled module in makefile syntax. The output is written to a file + with the given name. The output does not include files passed via debug + information to the assembler. + + + <label id="option-create-full-dep"> + <tag><tt>--create-full-dep name</tt></tag> + + Tells the assembler to generate a file containing the dependency list for + the assembled module in makefile syntax. The output is written to a file + with the given name. The output does include files passed via debug + information to the assembler. + + <label id="option--feature"> <tag><tt>--feature name</tt></tag> @@ -150,6 +187,14 @@ Here is a description of all the command line options: command for a list of emulation features. + <label id="option--forget-inc-paths"> + <tag><tt>--forget-inc-paths</tt></tag> + + Forget the builtin include paths. This is most useful when building + customized assembler modules, in which case the standard header files should + be ignored. + + <label id="option-g"> <tag><tt>-g, --debug-info</tt></tag> @@ -161,25 +206,35 @@ Here is a description of all the command line options: monitor. + <label id="option-h"> <tag><tt>-h, --help</tt></tag> Print the short option summary shown above. + <label id="option-i"> <tag><tt>-i, --ignore-case</tt></tag> This option makes the assembler case insensitive on identifiers and labels. - This option will override the default, but may itself be overriden by the + This option will override the default, but may itself be overridden by the <tt><ref id=".CASE" name=".CASE"></tt> control command. - <tag><tt>-l, --listing</tt></tag> + <label id="option-l"> + <tag><tt>-l name, --listing name</tt></tag> + + Generate an assembler listing with the given name. A listing file will + never be generated in case of assembly errors. - Generate an assembler listing. The listing file will always have the - name of the main input file with the extension replaced by ".lst". This - may change in future versions. + <label id="option--large-alignment"> + <tag><tt>--large-alignment</tt></tag> + Disable warnings about a large combined alignment. See the discussion of the + <tt><ref id=".ALIGN" name=".ALIGN"></tt> directive for futher information. + + + <label id="option--list-bytes"> <tag><tt>--list-bytes n</tt></tag> Set the maximum number of bytes printed in the listing for one line of @@ -188,6 +243,25 @@ Here is a description of all the command line options: number of printed bytes. + <label id="option--macpack-dir"> + <tag><tt>--macpack-dir dir</tt></tag> + + This options allows to specify a directory containing macro files that are + used instead of the builtin images when a <tt><ref id=".MACPACK" + name=".MACPACK"></tt> directive is encountered. If <tt>--macpack-dir</tt> + was specified, a <tt>.mac</tt> extension is added to the package name and + the resulting file is loaded from the given directory. This is most useful + when debugging the builtin macro packages. + + + <label id="option-mm"> + <tag><tt>-mm model, --memory-model model</tt></tag> + + Define the default memory model. Possible model specifiers are near, far and + huge. + + + <label id="option-o"> <tag><tt>-o name</tt></tag> The default output name is the name of the input file with the extension @@ -196,12 +270,28 @@ Here is a description of all the command line options: the source file, or, if -o is given, the full path in this name is used. + <label id="option--pagelength"> <tag><tt>--pagelength n</tt></tag> sets the length of a listing page in lines. See the <tt><ref id=".PAGELENGTH" name=".PAGELENGTH"></tt> directive for more information. + <label id="option--relax-checks"> + <tag><tt>--relax-checks</tt></tag> + + Relax some checks done by the assembler. This will allow code that is an + error in most cases and flagged as such by the assembler, but can be valid + in special situations. + + Examples are: +<itemize> +<item>Short branches between two different segments. +<item>Byte sized address loads where the address is not a zeropage address. +</itemize> + + + <label id="option-s"> <tag><tt>-s, --smart-mode</tt></tag> In smart mode (enabled by -s or the <tt><ref id=".SMART" name=".SMART"></tt> @@ -220,13 +310,17 @@ Here is a description of all the command line options: <label id="option-t"> <tag><tt>-t sys, --target sys</tt></tag> - Set the target system. This will enable translation of character strings - and character constants into the character set of the target platform. - The default for the target system is "none", which means that no translation + Set the target system. This will enable translation of character strings and + character constants into the character set of the target platform. The + default for the target system is "none", which means that no translation will take place. The assembler supports the same target systems as the compiler, see there for a list. + Depending on the target, the default CPU type is also set. This can be + overriden by using the <tt/<ref id="option--cpu" name="--cpu">/ option. + + <label id="option-v"> <tag><tt>-v, --verbose</tt></tag> Increase the assembler verbosity. Usually only needed for debugging @@ -234,6 +328,7 @@ Here is a description of all the command line options: verbose output. + <label id="option-D"> <tag><tt>-D</tt></tag> This option allows you to define symbols on the command line. Without a @@ -243,14 +338,17 @@ Here is a description of all the command line options: you may have to quote the expression. + <label id="option-I"> <tag><tt>-I dir, --include-dir dir</tt></tag> Name a directory which is searched for include files. The option may be used more than once to specify more than one directory to search. The current directory is always searched first before considering any - additional directores. + additional directories. See also the section about <ref id="search-paths" + name="search paths">. + <label id="option-U"> <tag><tt>-U, --auto-import</tt></tag> Mark symbols that are not defined in the sources as imported symbols. This @@ -262,6 +360,7 @@ Here is a description of all the command line options: which is not always true for assembler programmers. + <label id="option-V"> <tag><tt>-V, --version</tt></tag> Print the version number of the assembler. If you send any suggestions @@ -280,6 +379,32 @@ Here is a description of all the command line options: <p> + +<sect>Search paths<label id="search-paths"><p> + +Normal include files are searched in the following places: + +<enum> +<item>The current directory. +<item>A compiled-in directory, which is often <tt>/usr/lib/cc65/asminc</tt> + on Linux systems. +<item>The value of the environment variable <tt/CA65_INC/ if it is defined. +<item>A subdirectory named <tt/asminc/ of the directory defined in the + environment variable <tt/CC65_HOME/, if it is defined. +<item>Any directory added with the <tt/<ref id="option-I" name="-I">/ option +on the command line. +</enum> + +Binary include files are searched in the following places: + +<enum> +<item>The current directory. +<item>Any directory added with the <tt/<ref id="option--bin-include-dir" +name="--bin-include-dir">/ option on the command line. +</enum> + + + <sect>Input format<p> <sect1>Assembler syntax<p> @@ -288,9 +413,9 @@ The assembler accepts the standard 6502/65816 assembler syntax. One line may contain a label (which is identified by a colon), and, in addition to the label, an assembler mnemonic, a macro, or a control command (see section <ref id="control-commands" name="Control Commands"> for supported control -commands). Alternatively, the line may contain a symbol definition using the -'=' token. Everything after a semicolon is handled as a comment (that is, it -is ignored). +commands). Alternatively, the line may contain a symbol definition using +the '=' token. Everything after a semicolon is handled as a comment (that is, +it is ignored). Here are some examples for valid input lines: @@ -334,7 +459,7 @@ mnemonics: DEA is an alias for DEC A INA is an alias for INC A SWA is an alias for XBA - TAD is an alias for TCD + TAD is an alias for TCD TAS is an alias for TCS TDA is an alias for TDC TSA is an alias for TSC @@ -345,16 +470,16 @@ mnemonics: <sect1>6502X mode<label id="6502X-mode"><p> 6502X mode is an extension to the normal 6502 mode. In this mode, several -mnemomics for illegal instructions of the NMOS 6502 CPUs are accepted. Since +mnemonics for illegal instructions of the NMOS 6502 CPUs are accepted. Since these instructions are illegal, there are no official mnemonics for them. The unofficial ones are taken from <htmlurl -url="http://oxyron.net/graham/opcodes02.html" -name="http://oxyron.net/graham/opcodes02.html">. Please note that only the +url="http://www.oxyron.de/html/opcodes02.html" +name="http://www.oxyron.de/html/opcodes02.html">. Please note that only the ones marked as "stable" are supported. The following table uses information from the mentioned web page, for more information, see there. <itemize> -<item><tt>ALR: A:=(A and #{imm})*2;</tt> +<item><tt>ALR: A:=(A and #{imm})/2;</tt> <item><tt>ANC: A:=A and #{imm};</tt> Generates opcode $0B. <item><tt>ARR: A:=(A and #{imm})/2;</tt> <item><tt>AXS: X:=A and X-#{imm};</tt> @@ -403,8 +528,8 @@ name="http://www.6502.org/source/interpreters/sweet16.htm">. <sect1>Number format<p> For literal values, the assembler accepts the widely used number formats: A -preceeding '$' or a trailing 'h' denotes a hex value, a preceeding '%' -denotes a binary value, and a bare number is interpeted as a decimal. There +preceding '$' or a trailing 'h' denotes a hex value, a preceding '%' +denotes a binary value, and a bare number is interpreted as a decimal. There are currently no octal values and no floats. @@ -452,7 +577,7 @@ expression: <item> If the expression contains symbols that are not defined, and these symbols are local symbols, the enclosing scopes are searched for a symbol with the same name. If one exists and this symbol is defined, - it's attributes are used to determine the result size. + its attributes are used to determine the result size. <item> In all other cases the expression is assumed to be word sized. </itemize> @@ -465,7 +590,7 @@ the result is known. In the context of a boolean expression, any non zero value is evaluated as true, any other value to false. The result of a boolean expression is 1 if -it's true, and zero if it's false. There are boolean operators with extrem +it's true, and zero if it's false. There are boolean operators with extreme low precedence with version 2.x (where x > 0). The <tt/.AND/ and <tt/.OR/ operators are shortcut operators. That is, if the result of the expression is already known, after evaluating the left hand side, the right hand side is @@ -494,94 +619,136 @@ problem in most cases. <sect1>Available operators<label id="operators"><p> -Available operators sorted by precedence: - -<tscreen><verb> - Op Description Precedence - ------------------------------------------------------------------- - Builtin string functions 0 - - Builtin pseudo variables 1 - Builtin pseudo functions 1 - + Unary plus 1 - - Unary minus 1 - ~ Unary bitwise not 1 - .BITNOT Unary bitwise not 1 - < Low byte operator 1 - > High byte operator 1 - ^ Bank byte operator 1 - - * Multiplication 2 - / Division 2 - .MOD Modulo operation 2 - & Bitwise and 2 - .BITAND Bitwise and 2 - ^ Bitwise xor 2 - .BITXOR Bitwise xor 2 - << Shift left operator 2 - .SHL Shift left operator 2 - >> Shift right operator - .SHR Shift right operator 2 - - + Binary plus 3 - - Binary minus 3 - | Binary or 3 - .BITOR Binary or 3 - - = Compare operation (equal) 4 - <> Compare operation (not equal) 4 - < Compare operation (less) 4 - > Compare operation (greater) 4 - <= Compare operation (less or equal) 4 - >= Compare operation (greater or equal) 4 - - && Boolean and 5 - .AND Boolean and 5 - .XOR Boolean xor 5 - - || Boolean or 6 - .OR Boolean or 6 - - ! Boolean not 7 - .NOT Boolean not 7 -</verb></tscreen> - - -To force a specific order of evaluation, braces may be used as usual. - -<p> +<table> +<tabular ca="clc"> +<bf/Operator/| <bf/Description/| <bf/Precedence/@<hline> +| Built-in string functions| 0@ +||~@ +| Built-in pseudo-variables| 1@ +| Built-in pseudo-functions| 1@ ++| Unary positive| 1@ +-| Unary negative| 1@ +˜<newline> +.BITNOT| Unary bitwise not| 1@ +<<newline> +.LOBYTE| Unary low-byte operator| 1@ +><newline> +.HIBYTE| Unary high-byte operator| 1@ +^<newline> +.BANKBYTE| Unary bank-byte operator| 1@ +||~@ +*| Multiplication| 2@ +/| Division| 2@ +.MOD| Modulo operator| 2@ +&<newline> +.BITAND| Bitwise and| 2@ +^<newline> +.BITXOR| Binary bitwise xor| 2@ +<<<newline> +.SHL| Shift-left operator| 2@ +>><newline> +.SHR| Shift-right operator| 2@ +||~@ ++| Binary addition| 3@ +-| Binary subtraction| 3@ +|<newline> +.BITOR| Bitwise or| 3@ +||~@ += | Compare operator (equal)| 4@ +<>| Compare operator (not equal)| 4@ +<| Compare operator (less)| 4@ +>| Compare operator (greater)| 4@ +<=| Compare operator (less or equal)| 4@ +>=| Compare operator (greater or equal)| 4@ +||~@ +&&<newline> +.AND| Boolean and| 5@ +.XOR| Boolean xor| 5@ +||~@ +||<newline> +.OR| Boolean or| 6@ +||~@ +!<newline> +.NOT| Boolean not| 7@<hline> +</tabular> +<caption>Available operators, sorted by precedence +</table> + +To force a specific order of evaluation, parentheses may be used, as usual. <sect>Symbols and labels<p> +A symbol or label is an identifier that starts with a letter and is followed +by letters and digits. Depending on some features enabled (see +<tt><ref id="at_in_identifiers" name="at_in_identifiers"></tt>, +<tt><ref id="dollar_in_identifiers" name="dollar_in_identifiers"></tt> and +<tt><ref id="leading_dot_in_identifiers" name="leading_dot_in_identifiers"></tt>) +other characters may be present. Use of identifiers consisting of a single +character will not work in all cases, because some of these identifiers are +reserved keywords (for example "A" is not a valid identifier for a label, +because it is the keyword for the accumulator). + The assembler allows you to use symbols instead of naked values to make the source more readable. There are a lot of different ways to define and use symbols and labels, giving a lot of flexibility. - <sect1>Numeric constants<p> Numeric constants are defined using the equal sign or the label assignment operator. After doing <tscreen><verb> - two = 2 + two = 2 </verb></tscreen> may use the symbol "two" in every place where a number is expected, and it is -evaluated to the value 2 in this context. The label assignment operator causes -the same, but causes the symbol to be marked as a label, which may cause a -different handling in the debugger: +evaluated to the value 2 in this context. The label assignment operator is +almost identical, but causes the symbol to be marked as a label, so it may be +handled differently in a debugger: <tscreen><verb> - io := $d000 + io := $d000 </verb></tscreen> The right side can of course be an expression: <tscreen><verb> - four = two * two + four = two * two +</verb></tscreen> + + +<label id="variables"> +<sect1>Numeric variables<p> + +Within macros and other control structures (<tt><ref id=".REPEAT" +name=".REPEAT"></tt>, ...) it is sometimes useful to have some sort of +variable. This can be achieved by the <tt>.SET</tt> operator. It creates a +symbol that may get assigned a different value later: + +<tscreen><verb> + four .set 4 + lda #four ; Loads 4 into A + four .set 3 + lda #four ; Loads 3 into A +</verb></tscreen> + +Since the value of the symbol can change later, it must be possible to +evaluate it when used (no delayed evaluation as with normal symbols). So the +expression used as the value must be constant. + +Following is an example for a macro that generates a different label each time +it is used. It uses the <tt><ref id=".SPRINTF" name=".SPRINTF"></tt> function +and a numeric variable named <tt>lcount</tt>. + +<tscreen><verb> + .lcount .set 0 ; Initialize the counter + + .macro genlab + .ident (.sprintf ("L%04X", lcount)): + lcount .set lcount + 1 + .endmacro </verb></tscreen> @@ -620,46 +787,46 @@ You may use cheap local labels as an easy way to reuse common label names like "Loop". Here is an example: <tscreen><verb> - Clear: lda #$00 ; Global label - ldy #$20 - @Loop: sta Mem,y ; Local label - dey - bne @Loop ; Ok - rts + Clear: lda #$00 ; Global label + ldy #$20 + @Loop: sta Mem,y ; Local label + dey + bne @Loop ; Ok + rts Sub: ... ; New global label - bne @Loop ; ERROR: Unknown identifier! + bne @Loop ; ERROR: Unknown identifier! </verb></tscreen> <sect1>Unnamed labels<p> -If you really want to write messy code, there are also unnamed -labels. These labels do not have a name (you guessed that already, -didn't you?). A colon is used to mark the absence of the name. +If you really want to write messy code, there are also unnamed labels. These +labels do not have a name (you guessed that already, didn't you?). A colon is +used to mark the absence of the name. -Unnamed labels may be accessed by using the colon plus several minus -or plus characters as a label designator. Using the '-' characters -will create a back reference (use the n'th label backwards), using -'+' will create a forward reference (use the n'th label in forward -direction). An example will help to understand this: +Unnamed labels may be accessed by using the colon plus several minus or plus +characters as a label designator. Using the '-' characters will create a back +reference (use the n'th label backwards), using '+' will create a forward +reference (use the n'th label in forward direction). An example will help to +understand this: <tscreen><verb> - : lda (ptr1),y ; #1 - cmp (ptr2),y - bne :+ ; -> #2 - tax - beq :+++ ; -> #4 - iny - bne :- ; -> #1 - inc ptr1+1 - inc ptr2+1 - bne :- ; -> #1 - - : bcs :+ ; #2 -> #3 - ldx #$FF - rts - - : ldx #$01 ; #3 - : rts ; #4 + : lda (ptr1),y ; #1 + cmp (ptr2),y + bne :+ ; -> #2 + tax + beq :+++ ; -> #4 + iny + bne :- ; -> #1 + inc ptr1+1 + inc ptr2+1 + bne :- ; -> #1 + + : bcs :+ ; #2 -> #3 + ldx #$FF + rts + + : ldx #$01 ; #3 + : rts ; #4 </verb></tscreen> As you can see from the example, unnamed labels will make even short @@ -668,28 +835,38 @@ to find branch targets (this is the reason why I for my part do prefer the "cheap" local labels). Nevertheless, unnamed labels are convenient in some situations, so it's your decision. +<bf/Note:/ <ref id="scopes" name="Scopes"> organize named symbols, not +unnamed ones, so scopes don't have an effect on unnamed labels. + + <sect1>Using macros to define labels and constants<p> -While there are drawbacks with this approach, it may be handy in some -situations. Using <tt><ref id=".DEFINE" name=".DEFINE"></tt>, it is -possible to define symbols or constants that may be used elsewhere. Since -the macro facility works on a very low level, there is no scoping. On the -other side, you may also define string constants this way (this is not +While there are drawbacks with this approach, it may be handy in a few rare +situations. Using <tt><ref id=".DEFINE" name=".DEFINE"></tt>, it is possible +to define symbols or constants that may be used elsewhere. One of the +advantages is that you can use it to define string constants (this is not possible with the other symbol types). +Please note: <tt/.DEFINE/ style macros do token replacements on a low level, +so the names do not adhere to scoping, diagnostics may be misleading, there +are no symbols to look up in the map file, and there is no debug info. +Especially the first problem in the list can lead to very nasty programming +errors. Because of these problems, the general advice is, <bf/NOT/ do use +<tt/.DEFINE/ if you don't have to. + Example: <tscreen><verb> - .DEFINE two 2 - .DEFINE version "SOS V2.3" + .DEFINE two 2 + .DEFINE version "SOS V2.3" - four = two * two ; Ok - .byte version ; Ok + four = two * two ; Ok + .byte version ; Ok - .PROC ; Start local scope - two = 3 ; Will give "2 = 3" - invalid! - .ENDPROC + .PROC ; Start local scope + two = 3 ; Will give "2 = 3" - invalid! + .ENDPROC </verb></tscreen> @@ -713,7 +890,7 @@ All (non cheap local) symbols that are declared outside of any nested scopes are in global scope. -<sect1>A special scope: cheap locals<p> +<sect1>Cheap locals<p> A special scope is the scope for cheap local symbols. It lasts from one non local symbol to the next one, without any provisions made by the programmer. @@ -784,7 +961,7 @@ value needs absolute addressing mode, this fails, and an error message "Range error" is output. Of course the most simple solution for the problem is to move the definition -of <tt/foo/ in scope <tt/inner/ upwards, so it preceeds its use. There may be +of <tt/foo/ in scope <tt/inner/ upwards, so it precedes its use. There may be rare cases when this cannot be done. In these cases, you can use one of the address size override operators: @@ -813,7 +990,7 @@ So <tscreen><verb> .proc foo ... - .endscope + .endproc </verb></tscreen> is actually the same as @@ -864,7 +1041,7 @@ The only way to deny access to a scope from the outside is to declare a scope without a name (using the <tt/<ref id=".SCOPE" name=".SCOPE">/ command). A special syntax is used to specify the global scope: If a symbol or scope is -preceeded by the namespace token, the global scope is searched: +preceded by the namespace token, the global scope is searched: <tscreen><verb> bar = 3 @@ -884,7 +1061,7 @@ the scope is found. However, one important thing to note when using explicit scope syntax is, that a symbol may be accessed before it is defined, but a scope may <bf/not/ be -used without a preceeding definition. This means that in the following +used without a preceding definition. This means that in the following example: <tscreen><verb> @@ -1123,6 +1300,49 @@ Pseudo functions expect their arguments in parenthesis, and they have a result, either a string or an expression. +<sect1><tt>.BANK</tt><label id=".BANK"><p> + + The <tt/.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 <tt/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 <tt/.BANK/ can be used to switch memory so that a memory bank + containing specific data is available. + + The <tt/bank/ attribute is a 32 bit integer and so is the result of the + <tt/.BANK/ function. You will have to use <tt><ref id=".LOBYTE" + name=".LOBYTE"></tt> or similar functions to address just part of it. + + Please note that <tt/.BANK/ will always get evaluated in the link stage, so + an expression containing <tt/.BANK/ can never be used where a constant known + result is expected (for example with <tt/.RES/). + + Example: + + <tscreen><verb> + .segment "BANK1" + .proc banked_func_1 + ... + .endproc + + .segment "BANK2" + .proc banked_func_2 + ... + .endproc + + .proc bank_table + .addr banked_func_1 + .byte <.BANK (banked_func_1) + + .addr banked_func_2 + .byte <.BANK (banked_func_2) + .endproc + </verb></tscreen> + + + <sect1><tt>.BANKBYTE</tt><label id=".BANKBYTE"><p> The function returns the bank byte (that is, bits 16-23) of its argument. @@ -1154,7 +1374,7 @@ either a string or an expression. 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 - concatentation of all arguments. This function is most useful in macros and + concatenation of all arguments. This function is most useful in macros and when used together with the <tt/.STRING/ builtin function. The function may be used in any case where a string constant is expected. @@ -1238,14 +1458,14 @@ either a string or an expression. Example: To check in a macro if the given argument has a '#' as first token - (immidiate addressing mode), use something like this: + (immediate addressing mode), use something like this: <tscreen><verb> .macro ldax arg ... .if (.match (.left (1, {arg}), #)) - ; ldax called with immidiate operand + ; ldax called with immediate operand ... .endif @@ -1331,6 +1551,26 @@ either a string or an expression. See: <tt><ref id=".XMATCH" name=".XMATCH"></tt> +<sect1><tt>.MAX</tt><label id=".MAX"><p> + + Builtin function. The result is the larger of two values. + + The syntax is + + <tscreen><verb> + .MAX (<value #1>, <value #2>) + </verb></tscreen> + + Example: + + <tscreen><verb> + ; Reserve space for the larger of two data blocks + savearea: .max (.sizeof (foo), .sizeof (bar)) + </verb></tscreen> + + See: <tt><ref id=".MIN" name=".MIN"></tt> + + <sect1><tt>.MID</tt><label id=".MID"><p> Builtin function. Takes a starting index, a count and a token list as @@ -1352,14 +1592,14 @@ either a string or an expression. Example: To check in a macro if the given argument has a '<tt/#/' as first token - (immidiate addressing mode), use something like this: + (immediate addressing mode), use something like this: <tscreen><verb> .macro ldax arg ... .if (.match (.mid (0, 1, {arg}), #)) - ; ldax called with immidiate operand + ; ldax called with immediate operand ... .endif @@ -1371,6 +1611,26 @@ either a string or an expression. name=".RIGHT"></tt> builtin functions. +<sect1><tt>.MIN</tt><label id=".MIN"><p> + + Builtin function. The result is the smaller of two values. + + The syntax is + + <tscreen><verb> + .MIN (<value #1>, <value #2>) + </verb></tscreen> + + Example: + + <tscreen><verb> + ; Reserve space for some data, but 256 bytes minimum + savearea: .min (.sizeof (foo), 256) + </verb></tscreen> + + See: <tt><ref id=".MAX" name=".MAX"></tt> + + <sect1><tt>.REF, .REFERENCED</tt><label id=".REFERENCED"><p> Builtin function. The function expects an identifier as argument in braces. @@ -1418,7 +1678,7 @@ either a string or an expression. Please note that a symbol or scope must exist, before it is used together with <tt/.SIZEOF/ (this may get relaxed later, but will always 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, the scope is choosen over the + of a name represents both, a scope and a symbol, the scope is chosen over the symbol. After the following code: @@ -1539,7 +1799,7 @@ either a string or an expression. <sect1><tt>.STRLEN</tt><label id=".STRLEN"><p> Builtin function. The function accepts a string argument in braces and - eveluates to the length of the string. + evaluates to the length of the string. Example: @@ -1564,14 +1824,14 @@ either a string or an expression. Example: - The <tt/ldax/ macro accepts the '#' token to denote immidiate addressing (as + The <tt/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: <tscreen><verb> .macro ldax arg .if (.match (.mid (0, 1, {arg}), #)) - ; ldax called with immidiate operand + ; ldax called with immediate operand lda #<(.right (.tcount ({arg})-1, {arg})) ldx #>(.right (.tcount ({arg})-1, {arg})) .else @@ -1624,7 +1884,7 @@ Here's a list of all control commands and a description, what they do: Valid only in 65816 mode. Switch the accumulator to 16 bit. Note: This command will not emit any code, it will tell the assembler to - create 16 bit operands for immediate accumulator adressing mode. + create 16 bit operands for immediate accumulator addressing mode. See also: <tt><ref id=".SMART" name=".SMART"></tt> @@ -1634,7 +1894,7 @@ Here's a list of all control commands and a description, what they do: Valid only in 65816 mode. Switch the accumulator to 8 bit. Note: This command will not emit any code, it will tell the assembler to - create 8 bit operands for immediate accu adressing mode. + create 8 bit operands for immediate accu addressing mode. See also: <tt><ref id=".SMART" name=".SMART"></tt> @@ -1660,14 +1920,20 @@ Here's a list of all control commands and a description, what they do: <sect1><tt>.ALIGN</tt><label id=".ALIGN"><p> Align data to a given boundary. The command expects a constant integer - argument that must be a power of two, plus an optional second argument + 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). - Since alignment depends on the base address of the module, you must - give the same (or a greater) alignment for the segment when linking. - The linker will give you a warning, if you don't do that. + <tt/.ALIGN/ will insert fill bytes, and the number of fill bytes depend of + the final address of the segment. <tt/.ALIGN/ cannot insert a variable + number of bytes, since that would break address calculations within the + module. So each <tt/.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: @@ -1675,6 +1941,50 @@ Here's a list of all control commands and a description, what they do: .align 256 </verb></tscreen> + Some unexpected behaviour might occur if there are multiple <tt/.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: + + <tscreen><verb> + .align 15 + .byte 15 + .align 18 + .byte 18 + </verb></tscreen> + + 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 + + <tscreen><verb> + .align 15 + .byte 15 + .align 18 + .byte 18 + .align 251 + .byte 0 + </verb></tscreen> + + 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, the + assembler will issue a warning when the combined alignment exceeds 256. The + command line option <tt><ref id="option--large-alignment" + name="--large-alignment"></tt> will disable this warning. + + Please note that with alignments that are a power of two (which were the + only alignments possible in older versions of the assembler), the problem is + less severe, because the least common multiple of powers to the same base is + always the larger one. + + <sect1><tt>.ASCIIZ</tt><label id=".ASCIIZ"><p> @@ -1696,9 +2006,10 @@ Here's a list of all control commands and a description, what they do: 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 <tt/warning/ or <tt/error/. The assertion is - evaluated by the assembler if possible, and also passed to the linker in the - object file (if one is generated). The linker will then evaluate the + action specifier may be one of <tt/warning/, <tt/error/, <tt/ldwarning/ or + <tt/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: @@ -1711,7 +2022,7 @@ Here's a list of all control commands and a description, what they do: 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 <tt/warning/ outputs a warning, while the <tt/error/ specifier outputs - an error message. In the latter case, generation if the output file is + an error message. In the latter case, generation of the output file is suppressed in both the assembler and linker. @@ -1722,7 +2033,7 @@ Here's a list of all control commands and a description, what they do: 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 outputing actual code, so it is + complete source was translated, before outputting actual code, so it is <em/not/ possible to switch this feature on or off for separate sections of code. The last setting is used for all symbols. @@ -1739,6 +2050,34 @@ Here's a list of all control commands and a description, what they do: .autoimport + ; Switch on auto import </verb></tscreen> +<sect1><tt>.BANKBYTES</tt><label id=".BANKBYTES"><p> + + Define byte sized data by extracting only the bank byte (that is, bits 16-23) from + each expression. This is equivalent to <tt><ref id=".BYTE" name=".BYTE"></tt> with + the operator '^' prepended to each expression in its list. + + Example: + + <tscreen><verb> + .define MyTable TableItem0, TableItem1, TableItem2, TableItem3 + + TableLookupLo: .lobytes MyTable + TableLookupHi: .hibytes MyTable + TableLookupBank: .bankbytes MyTable + </verb></tscreen> + + which is equivalent to + + <tscreen><verb> + TableLookupLo: .byte <TableItem0, <TableItem1, <TableItem2, <TableItem3 + TableLookupHi: .byte >TableItem0, >TableItem1, >TableItem2, >TableItem3 + TableLookupBank: .byte ^TableItem0, ^TableItem1, ^TableItem2, ^TableItem3 + </verb></tscreen> + + See also: <tt><ref id=".BYTE" name=".BYTE"></tt>, + <tt><ref id=".HIBYTES" name=".HIBYTES"></tt>, + <tt><ref id=".LOBYTES" name=".LOBYTES"></tt> + <sect1><tt>.BSS</tt><label id=".BSS"><p> @@ -1824,7 +2163,7 @@ Here's a list of all control commands and a description, what they do: <tt/.CONDES/ is followed by the type, which may be <tt/constructor/, <tt/destructor/ or a numeric value between 0 and 6 (where 0 is the same as - specifiying <tt/constructor/ and 1 is equal to specifying <tt/destructor/). + specifying <tt/constructor/ and 1 is equal to specifying <tt/destructor/). The <tt><ref id=".CONSTRUCTOR" name=".CONSTRUCTOR"></tt>, <tt><ref id=".DESTRUCTOR" name=".DESTRUCTOR"></tt> and <tt><ref id=".INTERRUPTOR" name=".INTERRUPTOR"></tt> commands are actually shortcuts for <tt/.CONDES/ @@ -1933,7 +2272,27 @@ Here's a list of all control commands and a description, what they do: 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 braces. - See section <ref id="macros" name="Macros">. + + Please note that <tt/.DEFINE/ shares most disadvantages with its C + counterpart, so the general advice is, <bf/NOT/ do use <tt/.DEFINE/ if you + don't have to. + + See also the <tt><ref id=".UNDEFINE" name=".UNDEFINE"></tt> command and + section <ref id="macros" name="Macros">. + + +<sect1><tt>.DELMAC, .DELMACRO</tt><label id=".DELMACRO"><p> + + Delete a classic macro (defined with <tt><ref id=".MACRO" + name=".MACRO"></tt>) . 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: <tt><ref id=".ENDMACRO" name=".ENDMACRO"></tt>, + <tt><ref id=".EXITMACRO" name=".EXITMACRO"></tt>, + <tt><ref id=".MACRO" name=".MACRO"></tt> + + See also section <ref id="macros" name="Macros">. <sect1><tt>.DEF, .DEFINED</tt><label id=".DEFINED"><p> @@ -1945,7 +2304,7 @@ Here's a list of all control commands and a description, what they do: <tt><ref id=".IFDEF" name=".IFDEF"></tt> statement may be replaced by <tscreen><verb> - .if .defined(a) + .if .defined(a) </verb></tscreen> @@ -2021,7 +2380,13 @@ Here's a list of all control commands and a description, what they do: <sect1><tt>.ENDMAC, .ENDMACRO</tt><label id=".ENDMACRO"><p> - End of macro definition (see section <ref id="macros" name="Macros">). + Marks the end of a macro definition. + + See: <tt><ref id=".DELMACRO" name=".DELMACRO"></tt>, + <tt><ref id=".EXITMACRO" name=".EXITMACRO"></tt>, + <tt><ref id=".MACRO" name=".MACRO"></tt> + + See also section <ref id="macros" name="Macros">. <sect1><tt>.ENDPROC</tt><label id=".ENDPROC"><p> @@ -2046,6 +2411,13 @@ Here's a list of all control commands and a description, what they do: and unions"">. +<sect1><tt>.ENDUNION</tt><label id=".ENDUNION"><p> + + Ends a union definition. See the <tt/<ref id=".UNION" name=".UNION">/ + command and the separate section named <ref id="structs" name=""Structs + and unions"">. + + <sect1><tt>.ENUM</tt><label id=".ENUM"><p> Start an enumeration. This directive is very similar to the C <tt/enum/ @@ -2053,8 +2425,8 @@ Here's a list of all control commands and a description, what they do: 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 preceeding plus - one. This behaviour may be overriden by an explicit assignment. Two symbols + of zero, and each following symbol will get the value of the preceding plus + one. This behaviour may be overridden by an explicit assignment. Two symbols may have the same value. Example: @@ -2109,7 +2481,8 @@ Here's a list of all control commands and a description, what they do: <sect1><tt>.ERROR</tt><label id=".ERROR"><p> Force an assembly error. The assembler will output an error message - preceeded by "User error" and will <em/not/ produce an object file. + 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. @@ -2126,32 +2499,45 @@ Here's a list of all control commands and a description, what they do: .endif </verb></tscreen> - See also the <tt><ref id=".WARNING" name=".WARNING"></tt> and <tt><ref - id=".OUT" name=".OUT"></tt> directives. + See also: <tt><ref id=".FATAL" name=".FATAL"></tt>, + <tt><ref id=".OUT" name=".OUT"></tt>, + <tt><ref id=".WARNING" name=".WARNING"></tt> <sect1><tt>.EXITMAC, .EXITMACRO</tt><label id=".EXITMACRO"><p> - Abort a macro expansion immidiately. This command is often useful in - recursive macros. See separate section <ref id="macros" name="Macros">. + Abort a macro expansion immediately. This command is often useful in + recursive macros. + + See: <tt><ref id=".DELMACRO" name=".DELMACRO"></tt>, + <tt><ref id=".ENDMACRO" name=".ENDMACRO"></tt>, + <tt><ref id=".MACRO" name=".MACRO"></tt> + + See also section <ref id="macros" name="Macros">. <sect1><tt>.EXPORT</tt><label id=".EXPORT"><p> 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. 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. + 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. - Example: + Examples: <tscreen><verb> .export foo .export bar: far + .export foobar: far = foo * bar + .export baz := foobar, zap: far = baz - bar </verb></tscreen> + As with constant definitions, using <tt/:=/ instead of <tt/=/ marks the + symbols as a label. + See: <tt><ref id=".EXPORTZP" name=".EXPORTZP"></tt> @@ -2159,12 +2545,15 @@ Here's a list of all control commands and a description, what they do: Make 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 symols. + marked as zero page symbols. An assignment may be included in the + <tt/.EXPORTZP/ statement. This allows to define and export a symbol in one + statement. - Example: + Examples: <tscreen><verb> .exportzp foo, bar + .exportzp baz := $02 </verb></tscreen> See: <tt><ref id=".EXPORT" name=".EXPORT"></tt> @@ -2184,6 +2573,32 @@ Here's a list of all control commands and a description, what they do: See: <tt><ref id=".ADDR" name=".ADDR"></tt> +<sect1><tt>.FATAL</tt><label id=".FATAL"><p> + + 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: + + <tscreen><verb> + .if foo = 1 + ... + .elseif bar = 1 + ... + .else + .fatal "Must define foo or bar!" + .endif + </verb></tscreen> + + See also: <tt><ref id=".ERROR" name=".ERROR"></tt>, + <tt><ref id=".OUT" name=".OUT"></tt>, + <tt><ref id=".WARNING" name=".WARNING"></tt> + + <sect1><tt>.FEATURE</tt><label id=".FEATURE"><p> This directive may be used to enable one or more compatibility features @@ -2202,30 +2617,50 @@ Here's a list of all control commands and a description, what they do: <descrip> - <tag><tt>at_in_identifiers</tt></tag> + <tag><tt>at_in_identifiers</tt><label id="at_in_identifiers"></tag> Accept the at character (`@') as a valid character in identifiers. The at character is not allowed to start an identifier, even with this feature enabled. - <tag><tt>dollar_in_identifiers</tt></tag> + <tag><tt>c_comments</tt><label id="c_comments"></tag> + + Allow C like comments using <tt>/*</tt> and <tt>*/</tt> as left and right + comment terminators. Note that C comments may not be nested. There's also a + pitfall when using C like comments: All statements must be terminated by + "end-of-line". Using C like comments, it is possible to hide the newline, + which results in error messages. See the following non working example: + + <tscreen><verb> + lda #$00 /* This comment hides the newline +*/ sta $82 + </verb></tscreen> + + <tag><tt>dollar_in_identifiers</tt><label id="dollar_in_identifiers"></tag> Accept the dollar sign (`$') as a valid character in identifiers. The - at character is not allowed to start an identifier, even with this + dollar character is not allowed to start an identifier, even with this feature enabled. - <tag><tt>dollar_is_pc</tt></tag> + <tag><tt>dollar_is_pc</tt><label id="dollar_is_pc"></tag> The dollar sign may be used as an alias for the star (`*'), which gives the value of the current PC in expressions. Note: Assignment to the pseudo variable is not allowed. - <tag><tt>labels_without_colons</tt></tag> + <tag><tt>force_range</tt><label id="force_range"></tag> + + Force expressions into their valid range for immediate addressing and + storage operators like <tt><ref id=".BYTE" name=".BYTE"></tt> and + <tt><ref id=".WORD" name=".WORD"></tt>. Be very careful with this one, + since it will completely disable error checks. + + <tag><tt>labels_without_colons</tt><label id="labels_without_colons"></tag> Allow labels without a trailing colon. These labels are only accepted, if they start at the beginning of a line (no leading white space). - <tag><tt>leading_dot_in_identifiers</tt></tag> + <tag><tt>leading_dot_in_identifiers</tt><label id="leading_dot_in_identifiers"></tag> Accept the dot (`.') as the first character of an identifier. This may be used for example to create macro names that start with a dot emulating @@ -2234,17 +2669,17 @@ Here's a list of all control commands and a description, what they do: overridden. When using this feature, you may also get into trouble if later versions of the assembler define new keywords starting with a dot. - <tag><tt>loose_char_term</tt></tag> + <tag><tt>loose_char_term</tt><label id="loose_char_term"></tag> Accept single quotes as well as double quotes as terminators for char constants. - <tag><tt>loose_string_term</tt></tag> + <tag><tt>loose_string_term</tt><label id="loose_string_term"></tag> Accept single quotes as well as double quotes as terminators for string constants. - <tag><tt>missing_char_term</tt></tag> + <tag><tt>missing_char_term</tt><label id="missing_char_term"></tag> Accept single quoted character constants where the terminating quote is missing. @@ -2252,9 +2687,16 @@ Here's a list of all control commands and a description, what they do: lda #'a </verb></tscreen> <bf/Note:/ This does not work in conjunction with <tt/.FEATURE - loose_string_term/, since in this case the input would be ambigous. + loose_string_term/, since in this case the input would be ambiguous. + + <tag><tt>org_per_seg</tt><label id="org_per_seg"></tag> + + This feature makes relocatable/absolute mode local to the current segment. + Using <tt><ref id=".ORG" name=".ORG"></tt> when <tt/org_per_seg/ is in + effect will only enable absolute mode for the current segment. Dito for + <tt><ref id=".RELOC" name=".RELOC"></tt>. - <tag><tt>pc_assignment</tt></tag> + <tag><tt>pc_assignment</tt><label id="pc_assignment"></tag> Allow assignments to the PC symbol (`*' or `$' if <tt/dollar_is_pc/ is enabled). Such an assignment is handled identical to the <tt><ref @@ -2262,7 +2704,7 @@ Here's a list of all control commands and a description, what they do: removing the lines with the assignments may also be an option when porting code written for older assemblers). - <tag><tt>ubiquitous_idents</tt></tag> + <tag><tt>ubiquitous_idents</tt><label id="ubiquitous_idents"></tag> Allow the use of instructions names as names for macros and symbols. This makes it possible to "overload" instructions by defining a macro with the @@ -2359,7 +2801,7 @@ Here's a list of all control commands and a description, what they do: source, are exported, all others are imported. Additional <tt><ref id=".IMPORTZP" name=".IMPORTZP"></tt> or <tt><ref id=".EXPORTZP" name=".EXPORTZP"></tt> commands for the same symbol are allowed. The symbols - in the list are explicitly marked as zero page symols. + in the list are explicitly marked as zero page symbols. Example: @@ -2367,6 +2809,46 @@ Here's a list of all control commands and a description, what they do: .globalzp foo, bar </verb></tscreen> +<sect1><tt>.HIBYTES</tt><label id=".HIBYTES"><p> + + Define byte sized data by extracting only the high byte (that is, bits 8-15) from + each expression. This is equivalent to <tt><ref id=".BYTE" name=".BYTE"></tt> with + the operator '>' prepended to each expression in its list. + + Example: + + <tscreen><verb> + .lobytes $1234, $2345, $3456, $4567 + .hibytes $fedc, $edcb, $dcba, $cba9 + </verb></tscreen> + + which is equivalent to + + <tscreen><verb> + .byte $34, $45, $56, $67 + .byte $fe, $ed, $dc, $cb + </verb></tscreen> + + Example: + + <tscreen><verb> + .define MyTable TableItem0, TableItem1, TableItem2, TableItem3 + + TableLookupLo: .lobytes MyTable + TableLookupHi: .hibytes MyTable + </verb></tscreen> + + which is equivalent to + + <tscreen><verb> + TableLookupLo: .byte <TableItem0, <TableItem1, <TableItem2, <TableItem3 + TableLookupHi: .byte >TableItem0, >TableItem1, >TableItem2, >TableItem3 + </verb></tscreen> + + See also: <tt><ref id=".BYTE" name=".BYTE"></tt>, + <tt><ref id=".LOBYTES" name=".LOBYTES"></tt>, + <tt><ref id=".BANKBYTES" name=".BANKBYTES"></tt> + <sect1><tt>.I16</tt><label id=".I16"><p> @@ -2392,7 +2874,7 @@ Here's a list of all control commands and a description, what they do: <sect1><tt>.IF</tt><label id=".IF"><p> - Conditional assembly: Evalute an expression and switch assembler output + 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. @@ -2410,7 +2892,7 @@ Here's a list of all control commands and a description, what they do: 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. + to TRUE if an empty parameter was given. Example: @@ -2688,6 +3170,47 @@ Here's a list of all control commands and a description, what they do: </verb></tscreen> +<sect1><tt>.LOBYTES</tt><label id=".LOBYTES"><p> + + Define byte sized data by extracting only the low byte (that is, bits 0-7) from + each expression. This is equivalent to <tt><ref id=".BYTE" name=".BYTE"></tt> with + the operator '<' prepended to each expression in its list. + + Example: + + <tscreen><verb> + .lobytes $1234, $2345, $3456, $4567 + .hibytes $fedc, $edcb, $dcba, $cba9 + </verb></tscreen> + + which is equivalent to + + <tscreen><verb> + .byte $34, $45, $56, $67 + .byte $fe, $ed, $dc, $cb + </verb></tscreen> + + Example: + + <tscreen><verb> + .define MyTable TableItem0, TableItem1, TableItem2, TableItem3 + + TableLookupLo: .lobytes MyTable + TableLookupHi: .hibytes MyTable + </verb></tscreen> + + which is equivalent to + + <tscreen><verb> + TableLookupLo: .byte <TableItem0, <TableItem1, <TableItem2, <TableItem3 + TableLookupHi: .byte >TableItem0, >TableItem1, >TableItem2, >TableItem3 + </verb></tscreen> + + See also: <tt><ref id=".BYTE" name=".BYTE"></tt>, + <tt><ref id=".HIBYTES" name=".HIBYTES"></tt>, + <tt><ref id=".BANKBYTES" name=".BANKBYTES"></tt> + + <sect1><tt>.LOCAL</tt><label id=".LOCAL"><p> This command may only be used inside a macro definition. It declares a @@ -2740,10 +3263,11 @@ Here's a list of all control commands and a description, what they do: packages are: <tscreen><verb> + atari Defines the scrcode macro. + cbm Defines the scrcode macro. + cpu Defines constants for the .CPU variable. generic Defines generic macros like add and sub. longbranch Defines conditional long jump macros. - cbm Defines the scrcode macro - cpu Defines constants for the .CPU variable </verb></tscreen> Including a macro package twice, or including a macro package that @@ -2754,21 +3278,34 @@ Here's a list of all control commands and a description, what they do: <tscreen><verb> .macpack longbranch ; Include macro package - cmp #$20 ; Set condition codes - jne Label ; Jump long on condition + cmp #$20 ; Set condition codes + jne Label ; Jump long on condition </verb></tscreen> Macro packages are explained in more detail in section <ref id="macropackages" name="Macro packages">. -<sect1><tt>.MAC, .MACRO</tt><label id=".MAC"><p> +<sect1><tt>.MAC, .MACRO</tt><label id=".MACRO"><p> Start 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. + that are macro parameters. A macro definition is terminated by <tt><ref + id=".ENDMACRO" name=".ENDMACRO"></tt>. - See section <ref id="macros" name="Macros">. + Example: + + <tscreen><verb> + .macro ldax arg ; Define macro ldax + lda arg + ldx arg+1 + </verb></tscreen> + + See: <tt><ref id=".DELMACRO" name=".DELMACRO"></tt>, + <tt><ref id=".ENDMACRO" name=".ENDMACRO"></tt>, + <tt><ref id=".EXITMACRO" name=".EXITMACRO"></tt> + + See also section <ref id="macros" name="Macros">. <sect1><tt>.ORG</tt><label id=".ORG"><p> @@ -2778,12 +3315,14 @@ Here's a list of all control commands and a description, what they do: assembled. Use <tt><ref id=".RELOC" name=".RELOC"></tt> to switch back to relocatable code. - Please note that you <em/do not need/ this command in most cases. Placing + By default, absolute/relocatable mode is global (valid even when switching + segments). Using <tt>.FEATURE <ref id="org_per_seg" name="org_per_seg"></tt> + it can be made segment local. + + Please note that you <em/do not need/ <tt/.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. - You may not switch segments while inside a section of absolute code. - Example: <tscreen><verb> @@ -2794,7 +3333,7 @@ Here's a list of all control commands and a description, what they do: <sect1><tt>.OUT</tt><label id=".OUT"><p> Output a string to the console without producing an error. This command - is similiar to <tt/.ERROR/, however, it does not force an assembler error + is similar to <tt/.ERROR/, however, it does not force an assembler error that prevents the creation of an object file. Example: @@ -2803,8 +3342,9 @@ Here's a list of all control commands and a description, what they do: .out "This code was written by the codebuster(tm)" </verb></tscreen> - See also the <tt><ref id=".WARNING" name=".WARNING"></tt> and <tt><ref - id=".ERROR" name=".ERROR"></tt> directives. + See also: <tt><ref id=".ERROR" name=".ERROR"></tt>, + <tt><ref id=".FATAL" name=".FATAL"></tt>, + <tt><ref id=".WARNING" name=".WARNING"></tt> <sect1><tt>.P02</tt><label id=".P02"><p> @@ -2854,6 +3394,21 @@ Here's a list of all control commands and a description, what they do: name=".PSC02"></tt> and <tt><ref id=".P816" name=".P816"></tt> +<sect1><tt>.POPCPU</tt><label id=".POPCPU"><p> + + Pop 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 <tt><ref id=".PUSHCPU" name=".PUSHCPU"></tt> 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: <tt><ref id=".CPU" name=".CPU"></tt>, <tt><ref id=".PUSHCPU" + name=".PUSHCPU"></tt>, <tt><ref id=".SETCPU" name=".SETCPU"></tt> + + <sect1><tt>.POPSEG</tt><label id=".POPSEG"><p> Pop the last pushed segment from the stack, and set it. @@ -2912,6 +3467,22 @@ Here's a list of all control commands and a description, what they do: name=".PC02"></tt> and <tt><ref id=".P816" name=".P816"></tt> +<sect1><tt>.PUSHCPU</tt><label id=".PUSHCPU"><p> + + Push the currently active CPU onto a stack. The stack has a size of 8 + entries. + + <tt/.PUSHCPU/ allows together with <tt><ref id=".POPCPU" + name=".POPCPU"></tt> 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: <tt><ref id=".CPU" name=".CPU"></tt>, <tt><ref id=".POPCPU" + name=".POPCPU"></tt>, <tt><ref id=".SETCPU" name=".SETCPU"></tt> + + <sect1><tt>.PUSHSEG</tt><label id=".PUSHSEG"><p> Push the currently active segment onto a stack. The entries on the stack @@ -2928,6 +3499,12 @@ Here's a list of all control commands and a description, what they do: See: <tt><ref id=".POPSEG" name=".POPSEG"></tt> +<sect1><tt>.RELOC</tt><label id=".RELOC"><p> + + Switch back to relocatable mode. See the <tt><ref id=".ORG" + name=".ORG"></tt> command. + + <sect1><tt>.REPEAT</tt><label id=".REPEAT"><p> Repeat all commands between <tt/.REPEAT/ and <tt><ref id=".ENDREPEAT" @@ -2958,12 +3535,6 @@ Here's a list of all control commands and a description, what they do: See: <tt><ref id=".ENDREPEAT" name=".ENDREPEAT"></tt> -<sect1><tt>.RELOC</tt><label id=".RELOC"><p> - - Switch back to relocatable mode. See the <tt><ref id=".ORG" - name=".ORG"></tt> command. - - <sect1><tt>.RES</tt><label id=".RES"><p> Reserve storage. The command is followed by one or two constant @@ -3019,7 +3590,7 @@ Here's a list of all control commands and a description, what they do: None = 0 ; No error File = 1 ; File error Parse = 2 ; Parse error - .endproc ; Close lexical level + .endscope ; Close lexical level ... lda #Error::File ; Use symbol from scope Error @@ -3073,15 +3644,21 @@ Here's a list of all control commands and a description, what they do: id=".RODATA" name=".RODATA"></tt> +<sect1><tt>.SET</tt><label id=".SET"><p> + + <tt/.SET/ is used to assign a value to a variable. See <ref id="variables" + name="Numeric variables"> for a full description. + + <sect1><tt>.SETCPU</tt><label id=".SETCPU"><p> Switch 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 <tt><ref id="option--cpu" name="--cpu"></tt> command line option, - namely: 6502, 6502X, 65SC02, 65C02, 65816 and sunplus. Please note that - support for the sunplus CPU is not available in the freeware version, - because the instruction set of the sunplus CPU is "proprietary and - confidential". + namely: 6502, 6502X, 65SC02, 65C02, 65816, sunplus and HuC6280. Please + note that support for the sunplus CPU is not available in the freeware + version, because the instruction set of the sunplus CPU is "proprietary + and confidential". See: <tt><ref id=".CPU" name=".CPU"></tt>, <tt><ref id=".IFP02" name=".IFP02"></tt>, @@ -3096,10 +3673,10 @@ Here's a list of all control commands and a description, what they do: <sect1><tt>.SMART</tt><label id=".SMART"><p> - Switch on or off smart mode. The command must 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. + Switch on or off smart mode. The command must 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: @@ -3135,7 +3712,9 @@ Here's a list of all control commands and a description, what they do: Starts a struct definition. Structs are covered in a separate section named <ref id="structs" name=""Structs and unions"">. - See: <tt><ref id=".ENDSTRUCT" name=".ENDSTRUCT"></tt> + See also: <tt><ref id=".ENDSTRUCT" name=".ENDSTRUCT"></tt>, + <tt><ref id=".ENDUNION" name=".ENDUNION"></tt>, + <tt><ref id=".UNION" name=".UNION"></tt> <sect1><tt>.SUNPLUS</tt><label id=".SUNPLUS"><p> @@ -3166,10 +3745,31 @@ Here's a list of all control commands and a description, what they do: </verb></tscreen> +<sect1><tt>.UNDEF, .UNDEFINE</tt><label id=".UNDEFINE"><p> + + Delete 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 <tt><ref id=".DEFINE" name=".DEFINE"></tt> command and + section <ref id="macros" name="Macros">. + + +<sect1><tt>.UNION</tt><label id=".UNION"><p> + + Starts a union definition. Unions are covered in a separate section named + <ref id="structs" name=""Structs and unions"">. + + See also: <tt><ref id=".ENDSTRUCT" name=".ENDSTRUCT"></tt>, + <tt><ref id=".ENDUNION" name=".ENDUNION"></tt>, + <tt><ref id=".STRUCT" name=".STRUCT"></tt> + + <sect1><tt>.WARNING</tt><label id=".WARNING"><p> Force an assembly warning. The assembler will output a warning message - preceeded by "User warning". This warning will always be output, even if + preceded by "User warning". This warning will always be output, even if other warnings are disabled with the <tt><ref id="option-W" name="-W0"></tt> command line option. @@ -3180,20 +3780,21 @@ Here's a list of all control commands and a description, what they do: <tscreen><verb> .macro jne target - .local L1 - .ifndef target - .warning "Forward jump in jne, cannot optimize!" - beq L1 - jmp target + .local L1 + .ifndef target + .warning "Forward jump in jne, cannot optimize!" + beq L1 + jmp target L1: .else - ... - .endif + ... + .endif .endmacro </verb></tscreen> - See also the <tt><ref id=".ERROR" name=".ERROR"></tt> and <tt><ref id=".OUT" - name=".OUT"></tt> directives. + See also: <tt><ref id=".ERROR" name=".ERROR"></tt>, + <tt><ref id=".FATAL" name=".FATAL"></tt>, + <tt><ref id=".OUT" name=".OUT"></tt> <sect1><tt>.WORD</tt><label id=".WORD"><p> @@ -3240,14 +3841,14 @@ were specified when the macro was defined. <sect1>Macros without parameters<p> -In it's simplest form, a macro does not have parameters. Here's an +In its simplest form, a macro does not have parameters. Here's an example: <tscreen><verb> .macro asr ; Arithmetic shift right - cmp #$80 ; Put bit 7 into carry - ror ; Rotate right with carry - .endmacro + cmp #$80 ; Put bit 7 into carry + ror ; Rotate right with carry + .endmacro </verb></tscreen> The macro above consists of two real instructions, that are inserted into @@ -3255,9 +3856,9 @@ the code, whenever the macro is expanded. Macro expansion is simply done by using the name, like this: <tscreen><verb> - lda $2010 - asr - sta $2010 + lda $2010 + asr + sta $2010 </verb></tscreen> @@ -3266,42 +3867,42 @@ by using the name, like this: When using macro parameters, macros can be even more useful: <tscreen><verb> - .macro inc16 addr - clc - lda addr - adc #$01 - sta addr - lda addr+1 - adc #$00 - sta addr+1 - .endmacro + .macro inc16 addr + clc + lda addr + adc #$01 + sta addr + lda addr+1 + adc #$00 + sta addr+1 + .endmacro </verb></tscreen> -When calling the macro, you may give a parameter, and each occurence of +When calling the macro, you may give a parameter, and each occurrence of the name "addr" in the macro definition will be replaced by the given parameter. So <tscreen><verb> - inc16 $1000 + inc16 $1000 </verb></tscreen> will be expanded to <tscreen><verb> - clc - lda $1000 - adc #$01 - sta $1000 - lda $1000+1 - adc #$00 - sta $1000+1 + clc + lda $1000 + adc #$01 + sta $1000 + lda $1000+1 + adc #$00 + sta $1000+1 </verb></tscreen> A macro may have more than one parameter, in this case, the parameters are separated by commas. You are free to give less parameters than the macro actually takes in the definition. You may also leave intermediate parameters empty. Empty parameters are replaced by empty space (that is, -they are removed when the macro is exanded). If you have a look at our +they are removed when the macro is expanded). If you have a look at our macro definition above, you will see, that replacing the "addr" parameter by nothing will lead to wrong code in most lines. To help you, writing macros with a variable parameter list, there are some control commands: @@ -3315,23 +3916,23 @@ opposite. Look at this example: <tscreen><verb> - .macro ldaxy a, x, y - .ifnblank a - lda #a - .endif - .ifnblank x - ldx #x - .endif - .ifnblank y - ldy #y - .endif - .endmacro + .macro ldaxy a, x, y + .ifnblank a + lda #a + .endif + .ifnblank x + ldx #x + .endif + .ifnblank y + ldy #y + .endif + .endmacro </verb></tscreen> This macro may be called as follows: <tscreen><verb> - ldaxy 1, 2, 3 ; Load all three registers + ldaxy 1, 2, 3 ; Load all three registers ldaxy 1, , 3 ; Load only a and y @@ -3429,27 +4030,27 @@ Macros may be used recursively: There's also a special macro to help writing recursive macros: <tt><ref id=".EXITMACRO" name=".EXITMACRO"></tt> This command will stop macro expansion -immidiately: +immediately: <tscreen><verb> - .macro push r1, r2, r3, r4, r5, r6, r7 - .ifblank r1 - ; First parameter is empty - .exitmacro - .else - lda r1 - pha - .endif - push r2, r3, r4, r5, r6, r7 - .endmacro + .macro push r1, r2, r3, r4, r5, r6, r7 + .ifblank r1 + ; First parameter is empty + .exitmacro + .else + lda r1 + pha + .endif + push r2, r3, r4, r5, r6, r7 + .endmacro </verb></tscreen> When expanding this macro, the expansion will push all given parameters until an empty one is encountered. The macro may be called like this: <tscreen><verb> - push $20, $21, $32 ; Push 3 ZP locations - push $21 ; Push one ZP location + push $20, $21, $32 ; Push 3 ZP locations + push $21 ; Push one ZP location </verb></tscreen> @@ -3483,16 +4084,31 @@ written more efficiently, like this: .endmacro </verb></tscreen> -But imagine what happens, if you use this macro twice? Since the label -"Skip" has the same name both times, you get a "duplicate symbol" error. -Without a way to circumvent this problem, macros are not as useful, as -they could be. One solution is, to start a new lexical block inside the -macro: +But imagine what happens, if you use this macro twice? Since the label "Skip" +has the same name both times, you get a "duplicate symbol" error. Without a +way to circumvent this problem, macros are not as useful, as they could be. +One possible solution is the command <tt><ref id=".LOCAL" name=".LOCAL"></tt>. +It declares one or more symbols as local to the macro expansion. The names of +local variables are replaced by a unique name in each separate macro +expansion. So we can solve the problem above by using <tt/.LOCAL/: + +<tscreen><verb> + .macro inc16 addr + .local Skip ; Make Skip a local symbol + inc addr + bne Skip + inc addr+1 + Skip: ; Not visible outside + .endmacro +</verb></tscreen> + +Another solution is of course to start a new lexical block inside the macro +that hides any labels: <tscreen><verb> .macro inc16 addr .proc - inc addr + inc addr bne Skip inc addr+1 Skip: @@ -3500,27 +4116,6 @@ macro: .endmacro </verb></tscreen> -Now the label is local to the block and not visible outside. However, -sometimes you want a label inside the macro to be visible outside. To make -that possible, there's a new command that's only usable inside a macro -definition: <tt><ref id=".LOCAL" name=".LOCAL"></tt>. <tt/.LOCAL/ declares one -or more symbols as local to the macro expansion. The names of local variables -are replaced by a unique name in each separate macro expansion. So we could -also solve the problem above by using <tt/.LOCAL/: - -<tscreen><verb> - .macro inc16 addr - .local Skip ; Make Skip a local symbol - clc - lda addr - adc #$01 - sta addr - bcc Skip - inc addr+1 - Skip: ; Not visible outside - .endmacro -</verb></tscreen> - <sect1>C style macros<p> @@ -3555,7 +4150,7 @@ different: be omitted. <item> Since <tt><ref id=".DEFINE" name=".DEFINE"></tt> style macros may not - contain end-of-line tokens, there are things that cannot be done. They + contain end-of-line tokens, there are things that cannot be done. They may not contain several processor instructions for example. So, while some things may be done with both macro types, each type has special usages. The types complement each other. @@ -3598,7 +4193,7 @@ detect the end of one parameter, only the first token is used. If you don't like that, use classic macros instead: <tscreen><verb> - .macro message + .macro DEBUG message .out message .endmacro </verb></tscreen> @@ -3620,6 +4215,47 @@ doing more complex macros. If you compare characters against numeric values, be sure to take the translation into account. +<sect1>Deleting macros<p> + +Macros can be deleted. This will not work if the macro that should be deleted +is currently expanded as in the following non working example: + +<tscreen><verb> + .macro notworking + .delmacro notworking + .endmacro + + notworking ; Will not work +</verb></tscreen> + +The commands to delete classic and define style macros differ. Classic macros +can be deleted by use of <tt><ref id=".DELMACRO" name=".DELMACRO"></tt>, while +for <tt><ref id=".DEFINE" name=".DEFINE"></tt> style macros, <tt><ref +id=".UNDEFINE" name=".UNDEFINE"></tt> must be used. Example: + +<tscreen><verb> + .define value 1 + .macro mac + .byte 2 + .endmacro + + .byte value ; Emit one byte with value 1 + mac ; Emit another byte with value 2 + + .undefine value + .delmacro mac + + .byte value ; Error: Unknown identifier + mac ; Error: Missing ":" +</verb></tscreen> + +A separate command for <tt>.DEFINE</tt> style macros was necessary, because +the name of such a macro is replaced by its replacement list on a very low +level. To get the actual name, macro replacement has to be switched off when +reading the argument to <tt>.UNDEFINE</tt>. This does also mean that the +argument to <tt>.UNDEFINE</tt> is not allowed to come from another +<tt>.DEFINE</tt>. All this is not necessary for classic macros, so having two +different commands increases flexibility. <sect>Macro packages<label id="macropackages"><p> @@ -3632,18 +4268,38 @@ are: <sect1><tt>.MACPACK generic</tt><p> This macro package defines macros that are useful in almost any program. -Currently, two macros are defined: +Currently defined macros are: <tscreen><verb> .macro add Arg clc - adc Arg - .endmacro + adc Arg + .endmacro - .macro sub Arg - sec - sbc Arg - .endmacro + .macro sub Arg + sec + sbc Arg + .endmacro + + .macro bge Arg + bcs Arg + .endmacro + + .macro blt Arg + bcc Arg + .endmacro + + .macro bgt Arg + .local L + beq L + bcs Arg + L: + .endmacro + + .macro ble Arg + beq Arg + bcc Arg + .endmacro </verb></tscreen> @@ -3655,12 +4311,12 @@ definition for the "<tt/jeq/" macro, the other macros are built using the same scheme: <tscreen><verb> - .macro jeq Target + .macro jeq Target .if .def(Target) .and ((*+2)-(Target) <= 127) beq Target .else - bne *+5 - jmp Target + bne *+5 + jmp Target .endif .endmacro </verb></tscreen> @@ -3678,6 +4334,13 @@ The package defines the following macros: +<sect1><tt>.MACPACK atari</tt><p> + +The atari macro package will define a macro named <tt/scrcode/. It takes a +string as argument and places this string into memory translated into screen +codes. + + <sect1><tt>.MACPACK cbm</tt><p> The cbm macro package will define a macro named <tt/scrcode/. It takes a @@ -3698,6 +4361,7 @@ each supported CPU a constant similar to CPU_65816 CPU_SUNPLUS CPU_SWEET16 + CPU_HUC6280 </verb></tscreen> is defined. These constants may be used to determine the exact type of the @@ -3711,6 +4375,7 @@ another constant is defined: CPU_ISET_65816 CPU_ISET_SUNPLUS CPU_ISET_SWEET16 + CPU_ISET_HUC6280 </verb></tscreen> The value read from the <tt/<ref id=".CPU" name=".CPU">/ pseudo variable may @@ -3746,31 +4411,30 @@ For better orthogonality, the assembler defines similar symbols as the compiler, depending on the target system selected: <itemize> -<item><tt/__ACE__/ - Target system is <tt/ace/ -<item><tt/__APPLE2__",/ - Target system is <tt/apple2/ -<item><tt/__APPLE2ENH__",/ - Target system is <tt/apple2enh/ +<item><tt/__APPLE2__/ - Target system is <tt/apple2/ +<item><tt/__APPLE2ENH__/ - Target system is <tt/apple2enh/ <item><tt/__ATARI__/ - Target system is <tt/atari/ -<item><tt/__ATMOS__",/ - Target system is <tt/atmos/ -<item><tt/__BBC__",/ - Target system is <tt/bbc/ +<item><tt/__ATMOS__/ - Target system is <tt/atmos/ +<item><tt/__BBC__/ - Target system is <tt/bbc/ <item><tt/__C128__/ - Target system is <tt/c128/ <item><tt/__C16__/ - Target system is <tt/c16/ <item><tt/__C64__/ - Target system is <tt/c64/ <item><tt/__CBM__/ - Target is a Commodore system <item><tt/__CBM510__/ - Target system is <tt/cbm510/ <item><tt/__CBM610__/ - Target system is <tt/cbm610/ -<item><tt/__GEOS__",/ - Target system is <tt/geos/ -<item><tt/__LUNIX__",/ - Target system is <tt/lunix/ -<item><tt/__NES__",/ - Target system is <tt/nes/ +<item><tt/__GEOS__/ - Target system is <tt/geos/ +<item><tt/__LUNIX__/ - Target system is <tt/lunix/ +<item><tt/__NES__/ - Target system is <tt/nes/ <item><tt/__PET__/ - Target system is <tt/pet/ <item><tt/__PLUS4__/ - Target system is <tt/plus4/ -<item><tt/__SUPERVISION__",/ - Target system is <tt/supervision/ +<item><tt/__SUPERVISION__/ - Target system is <tt/supervision/ <item><tt/__VIC20__/ - Target system is <tt/vic20/ </itemize> <sect>Structs and unions<label id="structs"><p> -<sect1>Overview<p> +<sect1>Structs and unions Overview<p> Structs and unions are special forms of <ref id="scopes" name="scopes">. They are to some degree comparable to their C counterparts. Both have a list of @@ -3792,7 +4456,15 @@ of 4 bytes: </verb></tscreen> A union shares the total space between all its members, its size is the same -as that of the largest member. +as that of the largest member. The offset of all members relative to the union +is zero. + +<tscreen><verb> + .union Entry + index .word + ptr .addr + .endunion +</verb></tscreen> A struct or union must not necessarily have a name. If it is anonymous, no local scope is opened, the identifiers used to name the members are placed @@ -3865,7 +4537,7 @@ below uses examples from the C libraries. However, the feature may also be useful for assembler programs. -<sect1>Overview<p> +<sect1>Module constructors/destructors Overview<p> Using the <tt><ref id=".CONSTRUCTOR" name=".CONSTRUCTOR"></tt>, <tt><ref id=".DESTRUCTOR" name=".DESTRUCTOR"></tt> and <tt><ref id=".INTERRUPTOR" @@ -3953,7 +4625,7 @@ be requested separately. <item> Constructors and destructors may have priorities. These priorities determine -the order of the functions in the table. If your intialization or cleanup code +the order of the functions in the table. If your initialization or cleanup code does depend on other initialization or cleanup code, you have to choose the priority for the functions accordingly. @@ -4013,17 +4685,16 @@ writing new code from scratch. <item>Replace all program counter assignments (which are not possible in ca65 by default, and the respective emulation feature works different from what -you'd expect) by another way to skip to another memory location, for example -the <tt><ref id=".RES" name=".RES"></tt>directive. +you'd expect) by another way to skip to memory locations, for example the +<tt><ref id=".RES" name=".RES"></tt> directive. <tscreen><verb> ; *=$2000 .res $2000-* ; reserve memory up to $2000 </verb></tscreen> -notice that other than the original TASS, ca65 can never move the -programmcounter backwards - think of it as if you are assembling to disc with -TASS. +Please note that other than the original TASS, ca65 can never move the program +counter backwards - think of it as if you are assembling to disk with TASS. <item>Conditional assembly (<tt/.ifeq//<tt/.endif//<tt/.goto/ etc.) must be rewritten to match ca65 syntax. Most importantly notice that due to the lack @@ -4048,8 +4719,8 @@ of <tt/.goto/, everything involving loops must be replaced by cl65 --start-addr 0x0ffe -t none myprog.s -o myprog.prg </verb></tscreen> -notice that you need to use the actual start address minus two, since two -bytes are used for the cbm load address. +Note that you need to use the actual start address minus two, since two bytes +are used for the cbm load address. </enum>