1
0
mirror of https://github.com/ksherlock/x65.git synced 2024-12-28 04:31:46 +00:00

Adding a doc for eval functions.

This commit is contained in:
Carl-Henrik Skårstedt 2020-01-11 13:16:34 -08:00
parent 33e7f72d0b
commit b45da90bce
2 changed files with 59 additions and 0 deletions

47
docs/eval_functions.md Normal file
View File

@ -0,0 +1,47 @@
# Eval Functions
Eval Functions are used like symbols in expressions but are always followed by parenthesis with optional arguments.
### DEFINED, DEF
.if .def(symbol)
.endif
Evaluates to 1 if the symbol has been defined or 0 if it has not been encountered to this point in the current assembly.
### REFERENCED
.if .referenced(symbol)
.endif
Evaluates to 1 if the symbol has been referenced in the current assembly, the symbol should be defined at this point.
### BLANK
.if .blank()
.endif
Evaluates to 1 if the contents within the parenthesis is empty, primarily for use within macros.
### CONST
if .const(symbol)
.endif
Evaluates to 1 if the symbol has been declared CONST, the symbol should be defined at this point.
### SIZEOF
STRUCT Module {
word Init
word Update
word Shutdown
}
ds SIZEOF( Module )
Returns the byte size of a given struct.
### TRIGSIN
Not implemented, experimental math feature, currently returns 0

View File

@ -37,12 +37,24 @@ result.
## Command Line Options
Controls the assembler for the entire file
See [Command Line Options](command_line_options.md)
## Directives
Controls the assembler on a line basis
See [Directives](directives.md)
## Eval Functions
Functions that returns values for use in expressions.
See [Eval Functions](eval_functions.md)
## Macro examples
Some info about the included example x65macro.i file.
See [Macro Samples](macro_samples.md)