Files
2026-09-20 09:19:07 +08:00

150 lines
4.5 KiB
Markdown

# R8ASM Specification
## 词法规范
### 特殊符号
#### 注释符号
';'是r8asm的单行注释符号,从';'出现处到该行行末均会被视为注释内容
#### 位于token开头的指示符
r8asm用一些指示符区分具有特殊身份的token,它们通常位于token的首字符:
|符号|用途|
|---|---|
|.|标示内建指令|
|%|标示形参或汇编器指令|
|"|标示文件名|
> "与其他指示符不同,会被划分为[单独的token](#token类型) \
> 其出现在文件名左侧时为LPAREN,出现在右侧则为RPAREN
#### 空白符号
在r8asm中,以下符号将被视为空白符号,参与token的切割:
|名称|符号|
|---|---|
|空格|' '|
|制表符|\t|
|换行|\n|
|回车|\r|
|换页|\f|
|垂直制表符|\v|
### 运算符与运算符优先级
r8asm采用部分nasm运算符,且优先级与nasm基本一致,具体来讲:
|运算符|含义|优先级|
|---|---|---|
|~|按位取反|0|
|*|乘|1|
|/|除|1|
|+|加|2|
|-|减|2|
|&|按位与|3|
|^|按位异或|4|
|\||按位或|5|
### token类型
r8asm将切割源码产生的token分类为:
|类型|形式|说明|
|---|---|---|
|STRING|一般标识符或数字|宏名(声明宏时),变量名,数字等|
|OPERATOR|~ * / + - & ^ \||见[运算符与运算符优先级](#运算符与运算符优先级)|
|MACROCALL|位于行首的一般标识符|宏调用|
|ROT8|stp btp ror flb biz rnz inp out|rot-8指令|
|DIRECTIVE|行首的,开头为'%'的token|汇编器指令|
|PARAMETER|非行首的,开头为'%'的token|形式参数|
|BUILTIN|开头为'.'的token|内建指令|
|LPAREN/RPAREN|( )|表达式中的括号|
|LQUOTE/RQUOTE|"|文件名标识|
|ENDL|行末|这玩意好像没怎么用过啊|
## 语法规范
### 程序结构
一份r8asm程序由若干行组成 \
每行(若不为空行)由宏调用,指令,内建指令或rot-8指令开始,其后是$\geq0$个参数 \
参数可以是形式参数,数字,表达式,字符串,变量名或文件
> 仅含注释的行同样视为空行
### 指令
|形式|含义|
|---|---|
|%macro \<macroname>|开始宏声明|
|%endmacro|结束宏声明|
|%rep \<count>|开始重复声明|
|%endrep|结束重复声明|
|%include "\<filename>"|包含另一份r8asm文件|
> r8asm也支持以和nasm相同的,%macro \<macroname> \<count>的形式声明宏 \
> 但\<count>在这里没有任何实际影响,哪怕其值为🐸也不影响宏的正常声明和使用
### 内建指令
|形式|含义|
|---|---|
|.tp \<addr>|将dataptr移动至指定cell|
|.anchor \<var_name>|在本作用域内,标记dataptr指向的cell|
|.xor \<val>|对dataptr指向的cell进行xor \<val>运算|
|.loop/.endloop|通过消耗dataptr所指cell的下一个cell中,从LSB开始的,连续的'1'进行循环|
|.var \<var_name> \<val>|在本作用域内,创建一个值为\<val>,变量名为\<var_name>的变量,或将变量\<var_name>的值改为\<val>|
### 表达式
和运算符有关的内容见[运算符与运算符优先级](#运算符与运算符优先级) \
支持括号 \
支持常量,变量或形参
### ROT-8
与原始rot-8指令相同,r8asm中的rot-8指令不接受参数
### 语义规范
#### dataptr的守恒
rot-8并没有提供对随机读写的支持,因此r8asm汇编器需要自行维护dataptr以随时在编译期计算跳转偏移量 \
仅当每个macro与每段biz/rnz中的stp与btp数目相匹配时,这样的计算才是可行的
> 在宏入口处.anchor,在出口处.tp是一种简单有效的办法,虽然有时候可能不太高效
#### Unit与Cell
在r8asm中,cell的地址从0开始 \
地址为 $ n+1 $ 的cell是地址为 $ n $ 的cell的辅助cell,二者合称为一个Unit
#### 作用域与局部变量
调用宏时,宏体内会被视为新的子作用域 \
子作用域可以读取父作用域的变量,反之则不行 \
创建同名变量时,若之前存在的变量位于同作用域,则其值会被更改;若位于父作用域,则新变量会独立地存在于子作用域,并在作用域内遮蔽旧同名变量 \
> 这意味着父作用域变量的值本身不会因子作用域中的行为而更改
#### 宏展开
宏展开时,实参发生值传递,将其值传递给对应位置的形参 \
形参以局部变量的形式存在于新创建的作用域内
### 标准宏规范
#### 标准宏命名前缀
r8asm标准宏通常具有以下前缀:
|缩写|全称|含义|
|---|---|---|
|clb|clobber|破坏性宏,会破坏其原始输入(多数情况下是清零)|
|bit|bit|对cell的LSB进行操作的宏|
|raw|raw|未经封装的宏,通常需要手动传入tmp cell作为实参|
#### 标准宏介绍
TODO