Compare commits

..

3 Commits

Author SHA1 Message Date
Rangi42
fb9fa6038c Release version 1.0.0 2025-10-31 20:19:24 -04:00
Rangi
35e5808423 Update rgbasm(5) docs based on @nummacway's feedback (#1852) 2025-10-31 18:36:53 -04:00
Rangi42
558d3ca0fc Disallow labels before ENDC 2025-10-31 18:21:59 -04:00
18 changed files with 160 additions and 114 deletions

View File

@@ -1,6 +1,6 @@
FROM debian:12-slim FROM debian:12-slim
LABEL org.opencontainers.image.source=https://github.com/gbdev/rgbds LABEL org.opencontainers.image.source=https://github.com/gbdev/rgbds
ARG version=1.0.0-rc2 ARG version=1.0.0
WORKDIR /rgbds WORKDIR /rgbds
COPY . . COPY . .

View File

@@ -6,7 +6,7 @@
#define PACKAGE_VERSION_MAJOR 1 #define PACKAGE_VERSION_MAJOR 1
#define PACKAGE_VERSION_MINOR 0 #define PACKAGE_VERSION_MINOR 0
#define PACKAGE_VERSION_PATCH 0 #define PACKAGE_VERSION_PATCH 0
#define PACKAGE_VERSION_RC 2 // #define PACKAGE_VERSION_RC 1
char const *get_package_version_string(); char const *get_package_version_string();

View File

@@ -1,6 +1,6 @@
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt GBZ80 7 .Dt GBZ80 7
.Os .Os
.Sh NAME .Sh NAME

View File

@@ -2,7 +2,7 @@
.\" .\"
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBASM-OLD 5 .Dt RGBASM-OLD 5
.Os .Os
.Sh NAME .Sh NAME

View File

@@ -1,6 +1,6 @@
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBASM 1 .Dt RGBASM 1
.Os .Os
.Sh NAME .Sh NAME

View File

@@ -2,7 +2,7 @@
.\" .\"
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBASM 5 .Dt RGBASM 5
.Os .Os
.Sh NAME .Sh NAME
@@ -27,10 +27,13 @@ but any program that processes RGBDS object files (described in
can be used in its place. can be used in its place.
.Sh SYNTAX .Sh SYNTAX
The syntax is line-based, just as in any other assembler. The syntax is line-based, just as in any other assembler.
Each line may have components in this order: Each line may have components in either of these orders:
.Pp .Bl -bullet -offset indent
.Dl Oo Ar directive Oc Oo ;\ Ns Ar comment Oc .It
.Dl Oo Ar label : Oc Oo Ar instruction Oo :: Ar instruction ... Oc Oc Oo ;\ Ns Ar comment Oc .Li Oo Ar label : Oc Oo Ar directive Oc Oo ;\ Ns Ar comment Oc
.It
.Li Oo Ar label : Oc Oo Ar instruction Oo :: Ar instruction ... Oc Oc Oo ;\ Ns Ar comment Oc
.El
.Pp .Pp
Directives are commands to the assembler itself, such as Directives are commands to the assembler itself, such as
.Ic PRINTLN , .Ic PRINTLN ,
@@ -41,6 +44,17 @@ or
Labels tie a name to a specific location within a section (see Labels tie a name to a specific location within a section (see
.Sx Labels .Sx Labels
below). below).
Labels are allowed before most directives, but not before
.Ic IF ,
.Ic ELIF ,
.Ic ELSE ,
.Ic ENDC ,
.Ic REPT ,
.Ic FOR ,
.Ic ENDR ,
.Ic MACRO ,
or
.Ic ENDM .
.Pp .Pp
Instructions are assembled into Game Boy opcodes. Instructions are assembled into Game Boy opcodes.
Multiple instructions on one line, as well as data directives (see Multiple instructions on one line, as well as data directives (see
@@ -84,8 +98,8 @@ as the opposite condition code; for example,
for for
.Ic z . .Ic z .
.Pp .Pp
All reserved keywords (directives, register names, etc.) are case-insensitive; All reserved keywords (directives, instructions, registers, built-in functions, etc.) are case-insensitive;
all identifiers (labels and other symbol names) are case-sensitive. all identifiers (labels, variables, etc) are case-sensitive.
.Pp .Pp
Comments are used to give humans information about the code, such as explanations. Comments are used to give humans information about the code, such as explanations.
The assembler The assembler
@@ -124,17 +138,17 @@ To do so, put a backslash at the end of the line:
world!"\ \ \ \ \ \ \ \ \ \ \ ;\ Any leading space is included world!"\ \ \ \ \ \ \ \ \ \ \ ;\ Any leading space is included
.Ed .Ed
.Ss Symbol interpolation .Ss Symbol interpolation
A funky feature is writing a symbol between Symbols with string or numeric values can be
.Ql {braces} , .Dq interpolated
called by writing them inside
.Dq symbol interpolation . .Ql {braces} .
This will paste the symbol's contents as if they were part of the source file. This will paste the symbol's contents as if they were part of the source file.
If it is a string symbol, its characters are simply inserted as-is. If it is a string symbol, its characters are simply inserted as-is.
If it is a numeric symbol, its value is converted to hexadecimal notation with a dollar sign If it is a numeric symbol, its value is converted to hexadecimal notation with a dollar sign
.Sq $ .Sq $
prepended. prepended.
.Pp .Pp
Symbol interpolations can be nested, too! Symbol interpolations can be nested, too.
.Bd -literal -offset indent .Bd -literal -offset indent
DEF topic EQUS "life, the universe, and \e"everything\e"" DEF topic EQUS "life, the universe, and \e"everything\e""
DEF meaning EQUS "answer" DEF meaning EQUS "answer"
@@ -145,11 +159,7 @@ PRINTLN "The {meaning} to {topic} is {{meaning}}"
PURGE topic, meaning, {meaning} PURGE topic, meaning, {meaning}
.Ed .Ed
.Pp .Pp
Symbols can be Symbols can be interpolated even in contexts that disable automatic expansion of string constants: that is,
.Em interpolated
even in the contexts that disable automatic
.Em expansion
of string constants:
.Ql name .Ql name
will be expanded in all of will be expanded in all of
.Ql DEF({name}) , .Ql DEF({name}) ,
@@ -159,15 +169,19 @@ will be expanded in all of
.Ql PURGE {name} , .Ql PURGE {name} ,
and and
.Ql MACRO {name} , .Ql MACRO {name} ,
but, for example, won't be in even though it won't be in
.Ql DEF(name) . .Ql DEF(name) ,
.Ql PURGE {name} ,
etc.
.Pp .Pp
It's possible to change the way symbols are printed by specifying a print format like so: It's possible to change the way symbols are printed by specifying a print format like so:
.Ql {fmt:symbol} . .Ql {fmt:symbol} .
The The
.Ql fmt .Ql fmt
specifier consists of these parts: specifier consists of parts, which must be in the following order:
.Ql <sign><exact><align><pad><width><frac><prec><type> . .Ql <sign><exact><align><pad><width><frac><prec><type> .
All the parts are optional except the required
.Ql <type> .
These parts are: These parts are:
.Bl -column "<exact>" .Bl -column "<exact>"
.It Sy Part Ta Sy Meaning .It Sy Part Ta Sy Meaning
@@ -177,14 +191,17 @@ or
.Ql \ . .Ql \ .
If specified, prints this character in front of non-negative numbers. If specified, prints this character in front of non-negative numbers.
.It Ql <exact> Ta May be .It Ql <exact> Ta May be
.Ql # . .Ql #
If specified, prints the value in an "exact" format: with a base prefix for non-decimal integer types .Pq only allowed for non-decimal types .
.Pq So $ Sc , So & Sc , or So % Sc ; If specified, prints the value in an "exact" format: with a base prefix
.Pq So $ Sc , So & Sc , or So % Sc
for non-decimal integer types
.Pq So x Sc / So X Sc , So o Sc , or So b Sc ;
with a with a
.Ql q .Ql q
precision suffix for fixed-point numbers; or with precision suffix for fixed-point numbers; or with
.Ql \e .Ql \e
escape characters for strings. escape characters (but no enclosing quotes) for strings.
.It Ql <align> Ta May be .It Ql <align> Ta May be
.Ql - . .Ql - .
If specified, aligns left instead of right. If specified, aligns left instead of right.
@@ -210,7 +227,7 @@ followed by zero
.Ql 0 .Ql 0
\[en] \[en]
.Ql 9 .Ql 9
prints zero fractional digits.) prints zero fractional digits and no decimal point.)
.It Ql <prec> Ta May be .It Ql <prec> Ta May be
.Ql q .Ql q
followed by one or more followed by one or more
@@ -224,13 +241,11 @@ option.
.It Ql <type> Ta Specifies the type of value. .It Ql <type> Ta Specifies the type of value.
.El .El
.Pp .Pp
All the format specifier parts are optional except the Valid types are:
.Ql <type> .
Valid print types are:
.Bl -column -offset indent "Type" "Lowercase hexadecimal" "Example" .Bl -column -offset indent "Type" "Lowercase hexadecimal" "Example"
.It Sy Type Ta Sy Format Ta Sy Example .It Sy Type Ta Sy Format Ta Sy Example
.It Ql d Ta Signed decimal Ta -42 .It Ql d Ta Signed decimal Ta -42
.It Ql u Ta Unsigned decimal Ta 42 .It Ql u Ta Unsigned decimal Ta 4294967254
.It Ql x Ta Lowercase hexadecimal Ta 2a .It Ql x Ta Lowercase hexadecimal Ta 2a
.It Ql X Ta Uppercase hexadecimal Ta 2A .It Ql X Ta Uppercase hexadecimal Ta 2A
.It Ql b Ta Binary Ta 101010 .It Ql b Ta Binary Ta 101010
@@ -266,9 +281,10 @@ would be more appropriate; see
.Sx String expressions .Sx String expressions
below. below.
.Sh EXPRESSIONS .Sh EXPRESSIONS
An expression can be composed of many things. There are two types of expressions: numeric and string.
.Pp
Numeric expressions are always evaluated using signed 32-bit math. Numeric expressions are always evaluated using signed 32-bit math.
Zero is considered to be the only "false" number, all non-zero numbers (including negative) are "true". In Boolean logic contexts, zero is considered to be the only "false" number, and all non-zero numbers (including negative) are "true".
.Pp .Pp
An expression is said to be "constant" if An expression is said to be "constant" if
.Nm .Nm
@@ -280,18 +296,21 @@ However, some operators can be constant even with non-constant operands, as expl
.Sx Operators .Sx Operators
below. below.
.Pp .Pp
The instructions in the macro-language generally require constant expressions. Directives generally require constant expressions: for example,
.Ss Numeric formats .Ic REPT
There are a number of numeric formats. requires the number of repetitions to be known at assembly time.
.Bl -column -offset indent "Precise fixed-point" "Possible prefixes" .Ss Numeric literals
.It Sy Format type Ta Sy Possible prefixes Ta Sy Accepted characters .Nm
supports a variety of numeric literals.
.Bl -column -offset indent "Precise fixed-point" "Prefixes" "Accepted characters"
.It Sy Format type Ta Sy Prefixes Ta Sy Accepted characters
.It Decimal Ta none Ta 0123456789 .It Decimal Ta none Ta 0123456789
.It Hexadecimal Ta Li $ , 0x , 0X Ta 0123456789ABCDEF .It Hexadecimal Ta Li $ , 0x , 0X Ta 0123456789ABCDEF
.It Octal Ta Li & , 0o , 0O Ta 01234567 .It Octal Ta Li & , 0o , 0O Ta 01234567
.It Binary Ta Li % , 0b , 0B Ta 01 .It Binary Ta Li % , 0b , 0B Ta 01
.It Fixed-point Ta none Ta 01234.56789 .It Fixed-point Ta none Ta 01234.56789
.It Precise fixed-point Ta none Ta 12.34q8 .It Precise fixed-point Ta none Ta 12.34q8
.It Character constant Ta none Ta 'ABYZ' .It Character constant Ta none Ta 'A'
.It Game Boy graphics Ta Li \` Ta 0123 .It Game Boy graphics Ta Li \` Ta 0123
.El .El
.Pp .Pp
@@ -313,15 +332,14 @@ for information on charmaps, and
.Sx String expressions .Sx String expressions
for information on escape characters allowed in character constants. for information on escape characters allowed in character constants.
.Pp .Pp
The last one, Game Boy graphics, is quite interesting and useful. The last one, Game Boy graphics, expects up to eight digits between 0 and 3, corresponding to pixels' two-bit shade values.
After the backtick, 8 digits between 0 and 3 are expected, corresponding to pixel values. The resulting numeric value is the two bytes of tile data which would produce that row of pixels.
The resulting value is the two bytes of tile data that would produce that row of pixels.
For example, For example,
.Sq \`01012323 .Sq \`01012323
is equivalent to is equivalent to
.Sq $0F55 . .Sq $0F55 .
.Pp .Pp
You can also use symbols, which are implicitly replaced with their value. In place of a numeric literal, you can also use a numeric symbol's name, which is implicitly replaced with its value.
.Ss Operators .Ss Operators
You can use these operators in numeric expressions (listed from highest to lowest precedence): You can use these operators in numeric expressions (listed from highest to lowest precedence):
.Bl -column -offset indent "!= == <= >= < >" .Bl -column -offset indent "!= == <= >= < >"
@@ -329,8 +347,8 @@ You can use these operators in numeric expressions (listed from highest to lowes
.It Li \&( \&) Ta Grouping .It Li \&( \&) Ta Grouping
.It Li FUNC() Ta Built-in function call .It Li FUNC() Ta Built-in function call
.It Li ** Ta Exponentiation .It Li ** Ta Exponentiation
.It Li + - ~ \&! Ta Unary plus, minus (negation), complement (bitwise negation), and Boolean negation .It Li + - ~ \&! Ta Unary plus, unary minus (negation), complement (bitwise negation), and Boolean negation
.It Li * / % Ta Multiplication, division, and modulo (remainder) .It Li * / % Ta Multiplication, division (rounding down), and modulo (remainder)
.It Li << >> >>> Ta Bit shifts (left, sign-extended right, zero-extended right) .It Li << >> >>> Ta Bit shifts (left, sign-extended right, zero-extended right)
.It Li & \&| ^ Ta Bitwise AND/OR/XOR .It Li & \&| ^ Ta Bitwise AND/OR/XOR
.It Li + - Ta Addition and subtraction .It Li + - Ta Addition and subtraction
@@ -398,7 +416,7 @@ with a non-zero constant as either operand will be constant 1, even if the other
returns 1 if the operand was 0, and 0 otherwise. returns 1 if the operand was 0, and 0 otherwise.
Even a non-constant operand with any non-zero bits will return 0. Even a non-constant operand with any non-zero bits will return 0.
.Ss Integer functions .Ss Integer functions
Besides operators, there are also some functions which have more specialized uses. Besides operators, there are also some functions which have more specialized uses:
.Bl -column "BITWIDTH(n)" .Bl -column "BITWIDTH(n)"
.It Sy Name Ta Sy Operation .It Sy Name Ta Sy Operation
.It Fn HIGH n Ta Equivalent to Ql Po Ns Ar n No & $FF00 Pc >> 8 . .It Fn HIGH n Ta Equivalent to Ql Po Ns Ar n No & $FF00 Pc >> 8 .
@@ -410,12 +428,13 @@ delim $$
.Ar n . .Ar n .
Some useful formulas: Some useful formulas:
.Ic BITWIDTH Ns ( Ar n Ns )\ \-\ 1 .Ic BITWIDTH Ns ( Ar n Ns )\ \-\ 1
equals $\[lf] log sub 2 ( n ) \[rf]$, equals $\[lf] log sub 2 ( n ) \[rf]$;
.Ic BITWIDTH Ns Pq Ar n Ns \ \-\ 1 .Ic BITWIDTH Ns Pq Ar n Ns \ \-\ 1
equals $\[lc] log sub 2 ( n ) \[rc]$, and equals $\[lc] log sub 2 ( n ) \[rc]$; and
.No 32\ \-\ Ns Ic BITWIDTH Ns Pq Ar n .No 32\ \-\ Ns Ic BITWIDTH Ns Pq Ar n
equals $roman clz ( n )$. equals $roman clz ( n )$, the count of leading zero bits in the binary representation of
.It Fn TZCOUNT n Ta Returns $roman ctz ( n )$, the count of trailing zero bits at the end of the binary representation of .Ar n .
.It Fn TZCOUNT n Ta Returns $roman ctz ( n )$, the count of trailing zero bits in the binary representation of
.Ar n . .Ar n .
.El .El
.EQ .EQ
@@ -436,21 +455,25 @@ command-line option, and/or by
An individual fixed-point literal can specify its own precision, overriding the current default, by appending a An individual fixed-point literal can specify its own precision, overriding the current default, by appending a
.Dq q .Dq q
followed by the number of fractional bits: for example, followed by the number of fractional bits: for example,
.Ql 1234.5q8 .Ql 789.25q8
is equal to $0004d2_80 is equal to $000315_40
.EQ .EQ
delim $$ delim $$
.EN .EN
($= 1234.5 * 2 sup 8$). ($= 789.25 * 2 sup 8$).
.Pp .Pp
Since fixed-point values are still just integers, you can use them in normal integer expressions. Since fixed-point values are still just integers, you can use them in normal integer expressions.
You can easily truncate a fixed-point number into an integer by shifting it right by the number of fractional bits. You can easily truncate a fixed-point number into an integer by shifting it right by the number of fractional bits, or by dividing it by 1.0.
It follows that you can convert an integer to a fixed-point number by shifting it left that same amount. It follows that you can convert an integer to a fixed-point number by shifting it left that same amount, or by multiplying it by 1.0.
For example,
.Ql 123.0 / 1.0 == 123 ,
and
.Ql 123 * 1.0 == 123.0 .
.Pp .Pp
Note that the current number of fractional bits can be computed as Note that the current number of fractional bits can be computed as
.Ic TZCOUNT Ns Pq 1.0 . .Ic TZCOUNT Ns Pq 1.0 .
.Pp .Pp
The following functions are designed to operate with fixed-point numbers: The following functions are designed to operate with fixed-point numbers (which must be known constant):
.Bl -column -offset indent "ATAN2(y, x)" .Bl -column -offset indent "ATAN2(y, x)"
.It Sy Name Ta Sy Operation .It Sy Name Ta Sy Operation
.It Fn DIV x y Ta Fixed-point division .It Fn DIV x y Ta Fixed-point division
@@ -458,7 +481,7 @@ The following functions are designed to operate with fixed-point numbers:
.It Fn FMOD x y Ta Fixed-point modulo .It Fn FMOD x y Ta Fixed-point modulo
.It Fn POW x y Ta $x sup y$ .It Fn POW x y Ta $x sup y$
.It Fn LOG x y Ta Logarithm of $x$ to the base $y$ .It Fn LOG x y Ta Logarithm of $x$ to the base $y$
.It Fn ROUND x Ta Round $x$ to the nearest integer .It Fn ROUND x Ta Round $x$ half away from zero to the nearest integer
.It Fn CEIL x Ta Round $x$ up to the nearest integer .It Fn CEIL x Ta Round $x$ up to the nearest integer
.It Fn FLOOR x Ta Round $x$ down to the nearest integer .It Fn FLOOR x Ta Round $x$ down to the nearest integer
.It Fn SIN x Ta Sine of $x$ .It Fn SIN x Ta Sine of $x$
@@ -509,9 +532,7 @@ will produce a nonsensical (but technically correct) result:
The The
.Ic FMOD .Ic FMOD
function function
is used to get the remainder of the corresponding fixed-point division, so that is used to get the remainder of the corresponding fixed-point division.
.Ql MUL(DIV(x, y), y) + FMOD(x, y) == x
is always true.
The result has the same sign as the The result has the same sign as the
.Em dividend ; .Em dividend ;
this is the opposite of how the integer modulo operator this is the opposite of how the integer modulo operator
@@ -534,14 +555,15 @@ These functions are useful for automatic generation of various tables.
For example: For example:
.Bd -literal -offset indent .Bd -literal -offset indent
; Generate a table of 128 sine values ; Generate a table of 128 sine values
; from sin(0.0) to sin(0.5) excluded, ; from sin(0.0) included to sin(0.5) excluded,
; with amplitude scaled from [-1.0, 1.0] to [0.0, 128.0]. ; with amplitude scaled from [-1.0, 1.0] to [0.0, 128.0],
; then divided by 1.0 to round down to integer values.
FOR angle, 0.0, 0.5, 0.5 / 128 FOR angle, 0.0, 0.5, 0.5 / 128
db MUL(SIN(angle) + 1.0, 128.0 / 2) >> 16 db MUL(SIN(angle) + 1.0, 128.0 / 2) / 1.0
ENDR ENDR
.Ed .Ed
.Ss String expressions .Ss String expressions
The most basic string expression is any number of characters contained in double quotes The most basic string expression is a string literal: any number of characters contained in double quotes
.Pq Ql \&"for instance" . .Pq Ql \&"for instance" .
The backslash character The backslash character
.Ql \e .Ql \e
@@ -562,14 +584,14 @@ There are a number of escape sequences you can use within a string:
.It Ql \e0 Ta Null Pq ASCII $00 .It Ql \e0 Ta Null Pq ASCII $00
.El .El
.Pp .Pp
Multi-line strings are contained in triple quotes Multi-line string literals are contained in triple quotes
.Pq Ql \&"\&"\&"for instance""" . .Pq Ql \&"\&"\&"for instance""" .
Escape sequences work the same way in multi-line strings; however, literal newline characters will be included as-is, without needing to escape them with Escape sequences work the same way in multi-line strings; however, literal newline characters will be included as-is, without needing to escape them with
.Ql \er .Ql \er
or or
.Ql \en . .Ql \en .
.Pp .Pp
Raw strings are prefixed by a hash Raw string literals are prefixed by a hash
.Sq # . .Sq # .
Inside them, backslashes and braces are treated like regular characters, so they will not be expanded as macro arguments, interpolated symbols, or escape sequences. Inside them, backslashes and braces are treated like regular characters, so they will not be expanded as macro arguments, interpolated symbols, or escape sequences.
For example, the raw string For example, the raw string
@@ -601,7 +623,7 @@ and
is equivalent to is equivalent to
.Ql STRCMP("str", \&"ing") != 0 . .Ql STRCMP("str", \&"ing") != 0 .
.Pp .Pp
The following functions operate on string expressions, and return strings themselves. The following functions operate on string expressions, and return strings themselves:
.Bl -column "STRSLICE(str, start, stop)" .Bl -column "STRSLICE(str, start, stop)"
.It Sy Name Ta Sy Operation .It Sy Name Ta Sy Operation
.It Fn STRCAT strs... Ta Concatenates Ar strs . .It Fn STRCAT strs... Ta Concatenates Ar strs .
@@ -612,7 +634,7 @@ in uppercase.
.Pq Ql A-Z .Pq Ql A-Z
in lowercase. in lowercase.
.It Fn STRSLICE str start stop Ta Returns a substring of Ar str No starting at Ar start No and ending at Ar stop No (exclusive). If Ar stop No is not specified, the substring continues to the end of Ar str . .It Fn STRSLICE str start stop Ta Returns a substring of Ar str No starting at Ar start No and ending at Ar stop No (exclusive). If Ar stop No is not specified, the substring continues to the end of Ar str .
.It Fn STRRPL str old new Ta Returns Ar str No with each non-overlapping occurrence of the substring Ar old No replaced with Ar new . .It Fn STRRPL str old new Ta Returns Ar str No with each occurrence of the substring Ar old No replaced with Ar new .
.It Fn STRFMT fmt args... Ta Returns the string Ar fmt No with each .It Fn STRFMT fmt args... Ta Returns the string Ar fmt No with each
.Ql %spec .Ql %spec
pattern replaced by interpolating the format pattern replaced by interpolating the format
@@ -622,11 +644,15 @@ with its corresponding argument in
.Ar args .Ar args
.Pq So %% Sc is replaced by the So % Sc character . .Pq So %% Sc is replaced by the So % Sc character .
.It Fn STRCHAR str idx Ta Returns the substring of Ar str No for the charmap entry at Ar idx No with the current charmap . Pq Ar idx No counts charmap entries, not characters. .It Fn STRCHAR str idx Ta Returns the substring of Ar str No for the charmap entry at Ar idx No with the current charmap . Pq Ar idx No counts charmap entries, not characters.
.El
.Pp
The following functions take varying operands, and return strings:
.Bl -column "READFILE(name, max)"
.It Fn REVCHAR vals... Ta Returns the string that is mapped to Ar vals No with the current charmap. If there is no unique charmap entry for Ar vals Ns , an error occurs. .It Fn REVCHAR vals... Ta Returns the string that is mapped to Ar vals No with the current charmap. If there is no unique charmap entry for Ar vals Ns , an error occurs.
.It Fn READFILE name max Ta Returns the contents of the file Ar name No as a string. Reads up to Ar max No bytes, or the entire contents if Ar max No is not specified. If the file isn't found in the current directory, the include-path list passed to Xr rgbasm 1 Ap s Fl I No option on the command line will be searched. .It Fn READFILE name max Ta Returns the contents of the file Ar name No as a string. Reads up to Ar max No bytes, or the entire contents if Ar max No is not specified. If the file isn't found in the current directory, the include-path list passed to Xr rgbasm 1 Ap s Fl I No option on the command line will be searched.
.El .El
.Pp .Pp
The following functions operate on string expressions, but return integers. The following functions operate on string expressions, but return integers:
.Bl -column "STRRFIND(str, sub)" .Bl -column "STRRFIND(str, sub)"
.It Sy Name Ta Sy Operation .It Sy Name Ta Sy Operation
.It Fn STRLEN str Ta Returns the number of characters in Ar str . .It Fn STRLEN str Ta Returns the number of characters in Ar str .
@@ -670,7 +696,8 @@ and
being equivalent to being equivalent to
.Ql dw 50, 53, $20ac . .Ql dw 50, 53, $20ac .
.Pp .Pp
Any characters in a string without defined mappings will be copied directly, using the source file's encoding of characters to bytes. Character mappings are matched greedily, so the longest applicable one will be mapped in a string.
Any characters in the string without defined mappings will be copied directly, using the source file's encoding of characters to bytes.
.Pp .Pp
It is possible to create multiple character maps and then switch between them as desired. It is possible to create multiple character maps and then switch between them as desired.
This can be used to encode debug information in ASCII and use a different encoding for other purposes, for example. This can be used to encode debug information in ASCII and use a different encoding for other purposes, for example.
@@ -743,7 +770,7 @@ The result is not constant, since only RGBLINK can compute its value.
.El .El
.Sh SECTIONS .Sh SECTIONS
Before you can start writing code, you must define a section. Before you can start writing code, you must define a section.
This tells the assembler what kind of information follows and, if it is code, where to put it. This tells the assembler what kind of information follows and where to put it.
.Pp .Pp
.Dl SECTION Ar name , type .Dl SECTION Ar name , type
.Dl SECTION Ar name , type , options .Dl SECTION Ar name , type , options
@@ -751,9 +778,9 @@ This tells the assembler what kind of information follows and, if it is code, wh
.Dl SECTION Ar name , type Ns Bo Ar addr Bc , Ar options .Dl SECTION Ar name , type Ns Bo Ar addr Bc , Ar options
.Pp .Pp
.Ar name .Ar name
is a string enclosed in double quotes, and can be a new name or the name of an existing section. is a string enclosed in double quotes, which is the name of the section.
If the type doesn't match, an error occurs. If the type doesn't match, an error occurs.
All other sections must have a unique name, even in different source files, or the linker will treat it as an error. Each section must have a unique name, even across different source files, or the linker will treat it as an error.
.Pp .Pp
Possible section Possible section
.Ar type Ns s .Ar type Ns s
@@ -778,8 +805,6 @@ can range from
.Ad $4000 .Ad $4000
to to
.Ad $7FFF . .Ad $7FFF .
.Ar bank
can range from 1 to 511.
Becomes an alias for Becomes an alias for
.Ic ROM0 .Ic ROM0
if tiny ROM mode is enabled in the linker. if tiny ROM mode is enabled in the linker.
@@ -799,8 +824,6 @@ can range from
.Ad $A000 .Ad $A000
to to
.Ad $BFFF . .Ad $BFFF .
.Ar bank
can range from 0 to 15.
.It Ic WRAM0 .It Ic WRAM0
A general-purpose RAM section. A general-purpose RAM section.
.Ar addr .Ar addr
@@ -841,12 +864,18 @@ to
.Ad $FFFE . .Ad $FFFE .
.El .El
.Pp .Pp
Since RGBDS produces ROMs, code and data can only be placed in RGBDS produces ROMs, which means that code and data can only be placed in
.Ic ROM0 .Ic ROM0
and and
.Ic ROMX .Ic ROMX
sections. sections.
To put some in RAM, have it stored in ROM, and copy it to RAM. The other RAM section types are for statically allocated labels.
If you need code or data in RAM, you will need to copy it from ROM to RAM yourself.
See
.Sx RAM code
for an example of how to conveniently do that with a
.Ic LOAD
block.
.Pp .Pp
.Ar option Ns s are comma-separated and may include: .Ar option Ns s are comma-separated and may include:
.Bl -tag -width Ds .Bl -tag -width Ds
@@ -903,7 +932,7 @@ creating it if it doesn't already exist.
It can end up in any ROM bank. It can end up in any ROM bank.
Code and data may follow. Code and data may follow.
.It .It
If it is needed, the the base address of the section can be specified: If it is needed, the base address of the section can be specified:
.Bd -literal -offset indent .Bd -literal -offset indent
SECTION "Cool Stuff", ROMX[$4567] SECTION "Cool Stuff", ROMX[$4567]
.Ed .Ed
@@ -958,13 +987,12 @@ Function:
ld [wAnswer], a ld [wAnswer], a
.Ed .Ed
.Ss RAM code .Ss RAM code
Sometimes you want to have some code in RAM. Sometimes you want to have some code (or data) in RAM, e.g. for self-modifying code.
But then you can't simply put it in a RAM section, you have to store it in ROM and copy it to RAM at some point. But you can't just put it directly in a RAM section; you have to store it in ROM and copy it to RAM at some point.
.Pp This means that the code will be executed at a different address range than where it's defined, which can be inconvenient for references to labels within that code.
This means the code (or data) will not be stored in the place it gets executed. This situation is what
Luckily,
.Ic LOAD .Ic LOAD
blocks are the perfect solution to that. blocks are designed for.
Here's an example of how to use them: Here's an example of how to use them:
.Bd -literal -offset indent .Bd -literal -offset indent
SECTION "LOAD example", ROMX SECTION "LOAD example", ROMX
@@ -1049,7 +1077,7 @@ However, a
.Ic UNION .Ic UNION
only works within a single file, so it can't be used e.g. to define temporary variables across several files, all of which use the same statically allocated memory. only works within a single file, so it can't be used e.g. to define temporary variables across several files, all of which use the same statically allocated memory.
Unionized sections solve this problem. Unionized sections solve this problem.
To declare an unionized section, add a To declare a unionized section, add a
.Ic UNION .Ic UNION
keyword after the keyword after the
.Ic SECTION .Ic SECTION
@@ -1087,9 +1115,9 @@ Different declarations of the same unionized section are not appended, but inste
.Sx Allocating overlapping spaces in RAM . .Sx Allocating overlapping spaces in RAM .
Similarly, the size of an unionized section is the largest of all its declarations. Similarly, the size of an unionized section is the largest of all its declarations.
.Ss Section fragments .Ss Section fragments
Section fragments are sections with a small twist: when several of the same name are encountered, they are concatenated instead of producing an error. Section fragments are sections with a small twist: when several fragments with the same name are encountered, they are concatenated into one section instead of producing an error, even across multiple object files.
This works within the same file (paralleling the behavior "plain" sections has in previous versions), but also across object files. This works within the same file (paralleling the behavior "plain" sections has in previous versions), but also across object files.
To declare an section fragment, add a To declare a section fragment, add a
.Ic FRAGMENT .Ic FRAGMENT
keyword after the keyword after the
.Ic SECTION .Ic SECTION
@@ -1940,7 +1968,7 @@ and
.Sq wBonus . .Sq wBonus .
Thus, keep in mind that Thus, keep in mind that
.Ql ld [wHealth], a .Ql ld [wHealth], a
assembles to the exact same thing as assembles to the exact same instruction as
.Ql ld [wName], a . .Ql ld [wName], a .
.Pp .Pp
This whole union's total size is 20 bytes, the size of the largest block (the first one, containing This whole union's total size is 20 bytes, the size of the largest block (the first one, containing

View File

@@ -1,18 +1,16 @@
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBDS 5 .Dt RGBDS 5
.Os .Os
.Sh NAME .Sh NAME
.Nm rgbds .Nm rgbds
.Nd object file format documentation .Nd object file format documentation
.Sh DESCRIPTION .Sh DESCRIPTION
This is the description of the object files used by This is the description of the RGB object file format that is output by
.Xr rgbasm 1 .Xr rgbasm 1
and and read by
.Xr rgblink 1 . .Xr rgblink 1 .
.Em Please note that the specification is not stable yet.
RGBDS is still in active development, and some new features require adding more information to the object file, or modifying some fields, both of which break compatibility with older versions.
.Sh FILE STRUCTURE .Sh FILE STRUCTURE
The following types are used: The following types are used:
.Pp .Pp

View File

@@ -1,6 +1,6 @@
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBDS 7 .Dt RGBDS 7
.Os .Os
.Sh NAME .Sh NAME
@@ -74,4 +74,8 @@ organization.
2022-05-17: The 2022-05-17: The
.Lk https://rgbds.gbdev.io rgbds.gbdev.io .Lk https://rgbds.gbdev.io rgbds.gbdev.io
website for RGBDS documentation and downloads is published. website for RGBDS documentation and downloads is published.
.It
2025-10-31: RGBDS reaches version 1.0.0 and starts adhering to
.Lk https://semver.org/ semantic versioning
("semver").
.El .El

View File

@@ -1,6 +1,6 @@
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBFIX 1 .Dt RGBFIX 1
.Os .Os
.Sh NAME .Sh NAME

View File

@@ -2,7 +2,7 @@
.\" .\"
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBGFX 1 .Dt RGBGFX 1
.Os .Os
.Sh NAME .Sh NAME

View File

@@ -1,6 +1,6 @@
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBLINK 1 .Dt RGBLINK 1
.Os .Os
.Sh NAME .Sh NAME

View File

@@ -1,6 +1,6 @@
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd September 30, 2025 .Dd October 31, 2025
.Dt RGBLINK 5 .Dt RGBLINK 5
.Os .Os
.Sh NAME .Sh NAME

View File

@@ -455,12 +455,13 @@ endofline: NEWLINE | EOB | EOL;
// and to avoid causing some grammar conflicts (token reducing is finicky). // and to avoid causing some grammar conflicts (token reducing is finicky).
// This is DEFINITELY one of the more FRAGILE parts of the codebase, handle with care. // This is DEFINITELY one of the more FRAGILE parts of the codebase, handle with care.
line_directive: line_directive:
def_macro macro_def
| rept | rept
| for | for
| break | break
| include | include
| if | if
| endc
// It's important that all of these require being at line start for `skipIfBlock` // It's important that all of these require being at line start for `skipIfBlock`
| elif | elif
| else | else
@@ -489,12 +490,12 @@ else:
plain_directive: plain_directive:
label label
| label data | label data
| label macro | label macro_invocation
| label directive | label directive
; ;
endc: endc:
POP_ENDC { POP_ENDC endofline {
act_Endc(); act_Endc();
} }
; ;
@@ -545,7 +546,7 @@ label:
} }
; ;
macro: macro_invocation:
SYMBOL { SYMBOL {
// Parsing 'macro_args' will restore the lexer's normal mode // Parsing 'macro_args' will restore the lexer's normal mode
lexer_SetMode(LEXER_RAW); lexer_SetMode(LEXER_RAW);
@@ -571,8 +572,7 @@ macro_args:
; ;
directive: directive:
endc print
| print
| println | println
| export | export
| export_def | export_def
@@ -853,7 +853,7 @@ break:
} }
; ;
def_macro: macro_def:
POP_MACRO { POP_MACRO {
lexer_ToggleStringExpansion(false); lexer_ToggleStringExpansion(false);
} maybe_quiet SYMBOL { } maybe_quiet SYMBOL {

View File

@@ -12,4 +12,5 @@ error: syntax error, unexpected PRINTLN, expecting end of line
at code-after-endm-endr-endc.asm(23) at code-after-endm-endr-endc.asm(23)
error: syntax error, unexpected PRINTLN, expecting end of line or end of buffer or end of fragment literal error: syntax error, unexpected PRINTLN, expecting end of line or end of buffer or end of fragment literal
at code-after-endm-endr-endc.asm(25) at code-after-endm-endr-endc.asm(25)
Assembly aborted with 7 errors! FATAL: Ended block with 2 unterminated conditionals (`IF`/`ELIF`/`ELSE` blocks)
at code-after-endm-endr-endc.asm(28)

View File

@@ -0,0 +1,7 @@
section "test", rom0
if 1
println "one"
label0: endc
if 2
println "two"
label1: endc

View File

@@ -0,0 +1,6 @@
error: syntax error, unexpected ENDC
at label-before-endc.asm(4)
error: syntax error, unexpected ENDC
at label-before-endc.asm(7)
FATAL: Ended block with 2 unterminated conditionals (`IF`/`ELIF`/`ELSE` blocks)
at label-before-endc.asm(8)

View File

@@ -0,0 +1,2 @@
one
two

View File

@@ -108,10 +108,10 @@ fi
if "$nonfree"; then if "$nonfree"; then
action github.com pret pokecrystal 2025-09-05 d138ed1bd4db80cf8caa549878600448fedf674e action github.com pret pokecrystal 2025-09-05 d138ed1bd4db80cf8caa549878600448fedf674e
action github.com pret pokered 2025-09-25 628797baffe7ea7dd4b224116d9704c7ae1b9c29 action github.com pret pokered 2025-10-04 e3af20b907fad59bcbee7d36ab4912d0cc5f2935
action github.com zladx LADX-Disassembly 2025-09-20 e09ee3259acbdecb89a0eba6cbc438281c174e85 action github.com zladx LADX-Disassembly 2025-10-11 f6de3516aaea480d2d3beda357fc76460bb8299d
fi fi
action github.com AntonioND ucity 2025-08-07 d1880a2a112d7c26f16c0fc06a15b6c32fdc9137 action github.com AntonioND ucity 2025-08-07 d1880a2a112d7c26f16c0fc06a15b6c32fdc9137
action github.com pinobatch libbet 2025-08-31 e42c0036b18e6e715987b88b4973389b283974c9 action github.com pinobatch libbet 2025-08-31 e42c0036b18e6e715987b88b4973389b283974c9
action github.com LIJI32 SameBoy 2025-09-27 91006369a6510c5db029a440691dd4becaa6208b action github.com LIJI32 SameBoy 2025-10-16 4c57a761517d3d11bb8d2ce31037b17d3a85b745
action codeberg.org ISSOtm gb-starter-kit 2025-09-23 6aeb2508ab75c15724b177a1437b939357bc5d6f action codeberg.org ISSOtm gb-starter-kit 2025-09-23 6aeb2508ab75c15724b177a1437b939357bc5d6f