;’ (that isn't inside a string) is a
+ comment. There is another format: anything that follows a
+ ‘*’ that is placed right at the start of
+ a line is a comment. The assembler removes all comments from the code before
+ doing anything else.
Sometimes lines can be too long and it may be necessary to split them. The
syntax to do so is the following one:
@@ -65,7 +66,7 @@ Sometimes lines can be too long and it may be necessary to split them. The
This works anywhere in the code except inside of strings. To split strings it is
- needed to use STRCAT like this:
+ needed to use STRCAT() like this:
@@ -74,99 +75,140 @@ This works anywhere in the code except inside of strings. To split strings it is
- SECTION "CoolStuff",ROMX --
@@ -174,8 +216,19 @@ If a section is defined with no indications, it is a floating section. The
+ SECTION "CoolStuff",ROMX ++
@@ -183,8 +236,7 @@ If it is needed, the following syntax can be used to fix the base address of the
@@ -201,11 +253,7 @@ And if you only want to force the section into a certain bank, and not it's
| Command | -- | Meaning | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RSRESET | -Resets the _RS counter to zero. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Name | -Contents | |
| EQU | @ | -PC value | |
| EQU | _PI | -Fixed point π | |
| SET | _RS | -_RS Counter | |
| EQU | _NARG | -Number of arguments passed to macro | |
| EQU | __LINE__ | -The current line number | |
| EQUS | __FILE__ | -The current filename | |
| EQUS | __DATE__ | -Today's date | |
| EQUS | __TIME__ | -The current time | |
| EQU | __UTC_YEAR__ | -Today's year | |
| EQU | __UTC_MONTH__ | -Today's month number, 1-12 | |
| EQU | __UTC_DAY__ | -Today's day of the month, 1-31 | |
| EQU | __UTC_HOUR__ | -Current hour, 0-23 | |
| EQU | __UTC_MINUTE__ | -Current minute, 0-59 | |
| EQU | __UTC_SECOND__ | -Current second, 0-59 | |
| EQU | __RGBDS_MAJOR__ | -Major version number of RGBDS. | |
| EQU | __RGBDS_MINOR__ | -Minor version number of RGBDS. | |
| EQU | __RGBDS_PATCH__ | -Patch version number of RGBDS. |
| Operator | Meaning | |
| () | +(
+ ) |
Precedence override |
| Shift left/right | ||
&
- | ^ |
+ &
+ | ^ |
Binary and/or/xor |
| Boolean and/or | ||
| ! | +! |
Unary Boolean not |
| Name | -Operation | |||
DIV(x,y) |
- - | x/y | +DIV(x, + y) | ++ + |
MUL(x,y) |
- - | x*y | +MUL(x, + y) | ++ + |
SIN(x) |
- - | sin(x) | +SIN(x) | ++ + |
COS(x) |
- - | cos(x) | +COS(x) | ++ + |
TAN(x) |
- - | tan(x) | +TAN(x) | ++ + |
ASIN(x) |
- - | arcsin(x) | +ASIN(x) | ++ + |
ACOS(x) |
- - | arccos(x) | +ACOS(x) | ++ + |
ATAN(x) |
- - | arctan(x) | +ATAN(x) | ++ + |
ATAN2(x,y) |
- Angle between (x,y) and (1,0) | +ATAN2(x, + y) | +Angle between + + and + + |
| String | @@ -1258,7 +1311,7 @@ A funky feature is {symbol} withing a string. This HINT: The {symbol} construct can also be used outside strings. The symbol's value is again inserted as a string. This is - just a short way of doing "{symbol}". + just a short way of doing “{symbol}”. Whenever the macro-language expects a string you can actually use a string expression. This consists of one or more of these function (yes, you can nest @@ -1266,45 +1319,47 @@ Whenever the macro-language expects a string you can actually use a string used as part of an integer expression!
| Name | -- | Operation | |
STRLEN(string) |
+ STRLEN(string) | Returns the number of characters in string | |
STRCAT(str1,str2) |
+ STRCAT(str1, + str2) | Appends str2 to str1. | |
STRCMP(str1,str2) |
+ STRCMP(str1, + str2) | Returns negative if str1 is alphabetically lower than str2, zero if they match, positive if str1 is greater than str2. | |
STRIN(str1,str2) |
+ STRIN(str1, + str2) | Returns the position of str2 in str1 or zero if it's not present (first character is position 1). | |
STRSUB(str,pos,len) |
+ STRSUB(str, + pos, + len) | Returns a substring from str starting at pos (first character is position 1) and with len characters. | |
STRUPR(str) |
+ STRUPR(str) | Converts all characters in str to capitals and returns the new string. | |
STRLWR(str) |
+ STRLWR(str) | Converts all characters in str to lower case and returns the new string. |
| Name | -- | Operation | |
BANK(@/str/lbl) |
- Returns a bank number. If the argument is the symbol - @, this function returns the bank of the - current section. If the argument is a string, it returns the bank of the - section that has that name. If the argument is a label, it returns the - bank number the label is in. For labels, as the linker has to resolve - this, it can't be used when the expression has to be constant. | +BANK(arg) | +Returns a bank number. If + arg is the symbol + @, this function returns the bank of the + current section. If arg is a string, it + returns the bank of the section that has that name. If + arg is a label, it returns the bank + number the label is in. For labels, as the linker has to resolve this, it + can't be used when the expression has to be constant. |
DEF(label) |
- Returns TRUE if label has been defined. | +DEF(label) | +Returns TRUE if label + has been defined. |
HIGH(r16/cnst/lbl) |
- Returns the top 8 bits of the operand if it is a label - or constant, or the top 8-bit register if it is a 16-bit register. | +HIGH(arg) | +Returns the top 8 bits of the operand if + arg is a label or constant, or the top + 8-bit register if it is a 16-bit register. |
LOW(r16/cnst/lbl) |
- Returns the bottom 8 bits of the operand if it is a - label or constant, or the bottom 8-bit register if it is a 16-bit register - (AF isn't a valid register for this function). | +LOW(arg) | +Returns the bottom 8 bits of the operand if + arg is a label or constant, or the bottom + 8-bit register if it is a 16-bit register (AF isn't a valid register for + this function). |