fix(*): fix some bugs

1. fix the bugs of Makefile
2. update sfn
3. commit the specification of stvc-tac

please refer to the work log for details

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.0.0)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-project(Stamon VERSION 2.4.5)
+project(Stamon VERSION 2.4.6)
 
 set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
 set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)

Makefile

@@ -42,6 +42,7 @@ debug: bin/stamon.exe
 release:
 # 自定义生成可执行文件名（默认为stamon.exe）
 
+	xcopy src\bin-include bin\include /s /e /y /i
 	$(COMPILER) src/Main.cpp \
 	-o bin/stamon.exe \
 	-O2 \
@@ -60,6 +61,8 @@ release:
 	$(UPX) -9 bin/stamon.exe
 
 release_win:
+
+	xcopy src\bin-include bin\include /s /e /y /i
 	$(COMPILER) src/Main.cpp \
 	-o bin/stamon.exe \
 	-O2 \
@@ -79,6 +82,7 @@ release_win:
 
 release_linux:
 #	编译Linux版本
+	cp -r -T src/bin-include bin/include
 	$(COMPILER) src/Main.cpp \
 	-o bin/stamon \
 	-O2 \

README.md

@@ -1,3 +1,10 @@
+<!--
+ * @Name: 
+ * @Copyright: 
+ * @Author: 
+ * @Date: 18/06/24 19:23
+ * @Description: 
+-->
 # Stamon2
 
 ![stamon logo](logo/logo.svg)
@@ -23,10 +30,11 @@
 ## 开发者
 
 * Climber-Rong [Github主页](https://github.com/CLimber-Rong) [Gitee主页](https://gitee.com/QuXiangrong)
+* copi143 [Github主页](https://github.com/copi143)
 
 ## 致谢
 
 * TheFlySong [Github主页](https://github.com/TheFlySong)
 * XIAOYI12 [Github主页](https://github.com/XIAOYI1212)
 * min0911_ [Github主页](https://github.com/min0911Y)
-* copi143 [Github主页](https://github.com/copi143)
+* 冻橘 [Github主页](https://github.com/MikanAffine)

doc/STVC-TAC规范.md

@@ -0,0 +1,224 @@
+<!--
+ * @Name: 
+ * @Copyright: 
+ * @Author: 
+ * @Date: 25/06/24 12:18
+ * @Description: 
+-->
+# STVC-TAC规范
+
+### 前言
+
+##### 什么是STVC-TAC？
+
+``STVC-TAC``（以下简称``STVC``）是一种以三地址码为基础的平面字节码规范。
+
+> ``STVC-TAC``区别于``AST-IR``，前者的字节码是线性且平面的，而后者则是递归且树状的。
+
+##### 为什么要设计STVC-TAC？
+
+比起形似AST的``AST-IR``，``STVC``更容易优化，且执行速度相对更快。
+
+### STVC文件结构
+
+与AST-IR相似的，AST-IR具有：
+
+1. 魔数（0xABDB）
+2. 常量表
+3. 代码
+
+之前似乎未曾说明常量表的格式，故接下来详述。
+
+### 常量表格式
+
+一个常量表由常量表长度（占4字节）和若干个常量组成，其中常量又由常量类型（占1字节）和常量值组成：
+
+其中常量值有以下类型：
+
+* 整数类型：占4字节，即数值
+* 单精度浮点类型：占4字节，即数值
+* 双精度浮点类型：占8字节，即数值
+* 字符串类型：占4+l字节，其中前4字节记录字符串长度（即l，长度按字节计），后l字节为字符串值
+* 标识符类型：占4+l字节，其中前4字节记录标识符长度（即l，长度按字节计），后l字节为标识符名
+
+将所有涉及到的数据和标识符存入常量表，这样在字节码代码中，若涉及到某数值或标识符，只需指定一个下标，虚拟机就能通过下标在常量表中查找出对应的数值或标识符。这么做极大的减少了冗余数据的存储，减小了程序体积。
+
+**注意：按照规定，常量表的第一条常量必须是一个名为``__init__``的标识符**
+
+### 代码格式
+
+##### 标识符
+
+标识符有三个种类：用户标识符，临时标识符和内部标识符。
+
+用户标识符一般为用户自定义的标识符，其格式与C标识符格式相同。
+
+临时标识符则是表达式计算过程当中会用到的标识符，此类标识符的格式为``.XXX``，其中“XXX”通常为数字。
+
+内部标识符则是用于匿名类、匿名函数的声明，此类标识符的格式为``#XXX``，其中“XXX”通常为数字
+
+##### 声明函数
+
+```
+function identifier: arg1 arg2 arg3 ...
+...some codes...
+end
+```
+
+其中identifier为函数名。arg1、arg2、arg3等为函数的参数名。“...some codes...”为函数体代码
+
+函数内部不能嵌套声明函数或类。
+
+##### 声明类
+
+```
+class identifier: member1 member2 member3 ...
+...some codes...
+end
+```
+
+其中identifier为类名。member1、member2、member3等为类成员名。“...some codes...”为类初始化赋值代码。
+
+在初始化类对象时，会先执行初始化赋值代码，再调用构造函数。
+
+类内部不能嵌套声明函数或类。
+
+##### 三地址语句
+
+1. ``x = y op z``
+
+将y和z进行运算（运算符为op）之后的值存入x
+
+2. ``x = y op``
+
+将y进行单目运算（运算符为op）之后的值存入x。如果op为``=``，则不做任何运算，这样做能达成“将y直接赋值于x”的效果
+
+##### 流程控制语句
+
+1. ``goto addr``
+
+无条件跳转至相对addr行指令所在处。若addr<0，向上跳转，否则向下跳转。
+
+2. ``if condition => addr``
+
+如果condition不为``null``或``0``则跳转至第addr行指令所在处。若addr<0，向上跳转，否则向下跳转。
+
+3. ``call result function: arg1 arg2 ...``
+
+调用function值。参数为arg1、arg2等标识符或值。返回值存入result当中。
+
+4. ``return value``
+
+返回value值
+
+##### 特别的...
+
+1. ``new object source arg1 arg2 ...``
+
+将source标识符作为类，新建对象，构造参数为arg1、arg2等，新建后的对象值存入object标识符
+
+1. ``sfn port arg``
+
+设置SFN，port为端口号标识符。arg参数标识符。
+
+SFN的介绍见``编译器开发文档.md``
+
+1. ``list identifier element1 element2...``
+
+将element1、element2...作为元素，组合成数列，并存入identifier标识符中s
+
+4. ``pushscope``
+
+压入一个作用域，用于跳转指令
+
+5. ``popscope``
+
+弹出一个作用域，用于跳转指令
+
+6. ``free identifier``
+
+如果identifier所存储的是字面量值（如整型），则释放。该指令和C语言的register关键字类似，**是否释放取决于虚拟机状态。**该指令通常用于释放临时标识符。
+
+##### 附表
+
+双目运算符有以下种类：
+
+* add：加
+* sub：减
+* mul：乘
+* div：除
+* mod：取余
+* lsh：左移
+* rsh：右移
+* less：小于
+* lequ：小等于
+* big：大于
+* bequ：大等于
+* equ：判等
+* iequ：判不等
+* band：按位与
+* bxor：按位异或
+* bor：按位或
+* land：逻辑与
+* lor：逻辑或
+* member：取成员
+* index：取下标
+
+而单目运算符有以下种类：
+
+* pos：正
+* neg：负
+* cpl：按位取反
+* not：逻辑非
+* arr：组成为数列
+
+##### 示例
+
+假设有如下代码：
+
+```
+class c {
+    def a = func {
+        return 114;
+    };
+    func f(x) {
+        return { 2*x+1, 3*x+2 };
+    }
+}
+
+
+obj = c.new;
+
+rst = obj.f(obj.a())[0];
+```
+
+那么其对应的STVC应为：
+
+```
+function #1:
+return 114
+end
+
+function #2: x
+.1 = 2 mul x
+.2 = .1 add 1
+.3 = 3 mul x
+.4 = .3 add 2
+list .5 .2 .4
+return .5
+end
+
+class c: a f
+a = #1
+f = #2
+end
+
+new obj c
+
+.1 = obj member a
+call .2 .1
+.3 = obj member f
+call .4 .3: .2
+.5 = .4 index 0
+rst = .5
+```

doc/工作日志/20240626.md

@@ -0,0 +1,34 @@
+<!--
+ * @Name: 
+ * @Copyright: 
+ * @Author: 
+ * @Date: 26/06/24 23:00
+ * @Description: 
+-->
+# 2024/06/24 工作日志
+
+本次主要修复了Makefile，更新了SFN，并且编写了平面字节码的规范。
+
+### 修复Makefile
+
+考虑到用户可能在编译前不会提前创建``bin``文件夹，并且新建``bin/include``目录。故在Makefile里编写了相应的实现。
+
+### 更新了SFN
+
+本更新来源于[冻橘](https://github.com/MikanAffine)的提议，感谢！
+
+本次更新将端口号从整型改为了字符串型。这样调用起来更直观，方便。在后续我也可能重构SFN。
+
+**注意：本次更新之后的虚拟机可能会和之前的版本所编译出的程序产生不兼容的问题。**
+
+### 编写了平面字节码的规范
+
+见``STVC-TAC规范.md``。
+
+### 接下来要做的事
+
+1. 支持编译为平面字节码
+2. 编写词法分析的保存功能
+3. 编写AST的O1优化器
+4. 完善标准库
+5. 编写AST的解释器

doc/编译器开发文档.md

@@ -99,6 +99,7 @@ SFN中的本地库可以由用户自定义，可扩展性高，不过我认为
 SFN类的主要接口有：
 
 * ``SFN(STMException* e, vm::ObjectManager* objman)``：构造函数，e为异常类，objman为当前运行时的ObjectManager对象。你可以在构造函数里绑定自己的本地库。详细请参见源码。
-* ``void call(int port, datatype::Variable* arg)``：根据端口号调用本地库。
+~~* ``void call(int port, datatype::Variable* arg)``：根据端口号调用本地库。~~
+* ``void call(String port, datatype::Variable* arg)``：根据端口号调用本地库。
 
 > ——摘自``工作日志/20240512.md``

src/Stamon.hpp

@@ -55,7 +55,7 @@ namespace stamon {
 
 	constexpr int STAMON_VER_X = 2;
 	constexpr int STAMON_VER_Y = 4;
-	constexpr int STAMON_VER_Z = 5;
+	constexpr int STAMON_VER_Z = 6;
 
 	class Stamon {
 			template<typename T>

src/bin-include/math.st

@@ -35,14 +35,14 @@ func range_ab(a, b) {
 }
 
 func int(s) {
-    def port = 2;
+    def port = "int";
     def arg = s;
     sfn port, arg;
     return arg;
 }
 
 func len(n) {
-    def port = 4;
+    def port = "len";
     def arg = n;
     sfn port, arg;
     return arg;

src/bin-include/stdio.st

@@ -5,7 +5,7 @@ import math;
 import string;
 
 func puts(s) {
-    def port = 0;
+    def port = "puts";
     sfn port, s;
 }
 
@@ -20,7 +20,7 @@ func println(n) {
 
 func input() {
 
-    def port = 5;
+    def port = "input";
     def arg;
 
     sfn port, arg;

src/bin-include/string.st

@@ -1,7 +1,7 @@
 import stddef;
 
 func str(s) {
-    def port = 3;
+    def port = "str";
     def arg = s;
     sfn port, arg;
     return arg;