refactor(stvcio): move stvcio to astirio

CLimber-Rong · CLimber-Rong · commit 2b18a2b4beee · 2025-03-03T22:55:54.000+08:00
1. rename STVCReader.cpp and STVCWriter.cpp to AstIrReader.cpp and AstIrWriter.cpp
2. move AstIrReader.cpp and AstIrWriter.cpp to action directory
3. fix a not-fatal bug
please refer to the work log for details
diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json
@@ -10,6 +10,7 @@
                 "${workspaceFolder}/src/ir/",
                 "${workspaceFolder}/src/compiler/",
                 "${workspaceFolder}/src/sfn/",
+                "${workspaceFolder}/src/action/",
                 "${workspaceFolder}/src/"
             ],
             "defines": [],
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.22.0)
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-project(Stamon VERSION 2.4.8)
+project(Stamon VERSION 2)
 
 set(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
 set(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
@@ -39,6 +39,7 @@ include_directories(${PROJECT_SOURCE_DIR}/src/ir)
 include_directories(${PROJECT_SOURCE_DIR}/src/compiler)
 include_directories(${PROJECT_SOURCE_DIR}/src/sfn)
 include_directories(${PROJECT_SOURCE_DIR}/src/tac)
+include_directories(${PROJECT_SOURCE_DIR}/src/action)
 
 set(CMAKE_C_FLAGS_DEBUG "-g -Og -DDEBUG")
 set(CMAKE_CXX_FLAGS_DEBUG "-g -Og -DDEBUG")
diff --git a/Makefile b/Makefile
@@ -13,6 +13,7 @@ LINK = 	-I include/stdc_implemented \
 		-I src/compiler \
 		-I src/sfn  \
 		-I src/tac \
+		-I src/action \
 		-I src \
 		-lm
 
diff --git a/demos/demo.stvc b/demos/demo.stvc
diff --git a/demos/demo1.stvc b/demos/demo1.stvc
diff --git a/demos/demo2.stvc b/demos/demo2.stvc
diff --git a/doc/AstRunner开发文档.md b/doc/AstRunner开发文档.md
@@ -1,18 +1,20 @@
-# 虚拟机开发文档
+# AstRunner开发文档
+
+> 注意：此文档旨在说明``AstRunner``（以下简称“虚拟机”）的工作原理
 
 虚拟机的运行原理为：将二进制文件读取为AstIR，交给AstIRGenerator类解析为Running-Ast，最后交给``vm/AstRunner.cpp``递归运行。
 
 我们规定：Stamon编译后的二进制文件为**STVC文件**，文件后缀为``.stvc``
 
 我们来逐步讲解。
 
-首先是二进制文件读取为AstIR，这部分的实现位于``src/vm/STVCReader.cpp``，STVCReader类的主要接口有：
+首先是二进制文件读取为AstIR，这部分的实现位于``src/vm/AstIrReader.cpp``，AstIrReader类的主要接口有：
 
-* ``STVCReader(char* vmcode, int code_size, STMException* e)``：构造函数，vmcode为字节码在内存中的地址，code_size指字节码的大小，e为异常类
+* ``AstIrReader(char* vmcode, int code_size, STMException* e)``：构造函数，vmcode为字节码在内存中的地址，code_size指字节码的大小，e为异常类
 * ``bool ReadHeader()``：读取字节码头，读取失败则抛出异常并返回false，否则返回true
 * ``ArrayList<AstIR> ReadIR()``：读取AstIR，返回由AstIR组成的ArrayList
 
-想要完整的读取一个STVC文件，应该要先创建一个STVCReader对象，然后先调用``ReadHeader``读取文件头信息，接着调用``ReadIR``来读取AstIR。调用这两个函数之后要分别检查是否有异常抛出。
+想要完整的读取一个STVC文件，应该要先创建一个AstIrReader对象，然后先调用``ReadHeader``读取文件头信息，接着调用``ReadIR``来读取AstIR。调用这两个函数之后要分别检查是否有异常抛出。
 
 接着是让AstIRGenerator类解析为Running-Ast，这一部分在**写了Ast与AstIR之间的互转工具**部分里已经详细提及过了，故不再赘述。
 
diff --git a/doc/STVC-TAC中间代码规范.md b/doc/STVC-TAC中间代码规范.md
@@ -4,7 +4,7 @@
 
 ##### 什么是STVC-TAC？
 
-``STVC-TAC``（以下简称``STVC``）是一种以三地址码为基础的平面字节码规范。
+``STVC-TAC``（又称``TAC-IR``，以下简称``STVC``）是一种以三地址码为基础的平面字节码规范。
 
 > ``STVC-TAC``区别于``AST-IR``，前者的字节码是线性且平面的，而后者则是递归且树状的。
 
diff --git a/doc/分步行动机制文档.md b/doc/分步行动机制文档.md
@@ -1,6 +1,6 @@
 # 分步行动机制文档
 
-为了让项目更接近于“高内聚，低耦合”的状况，我提出了分步行动机制（Substep-Action）。
+为了让项目更接近于“高内聚，低耦合”的状况，我提出了分步行动机制（Substep-Action，又称分步动作机制）。
 
 ### 前言
 
@@ -36,7 +36,7 @@
 
 我们以编译过程为例，传统的编译过程可以被分解为以下行动工具：
 
-文本文件读取器（用户给定文件名作为行动物品，生成一个行读取器）->词法分析器（接受到文本文件读取器传来的行阅读器，生成一个词法单元读取器）->语法分析器（接受到词法分析器传来的词法单元读取器，生成语法树）->ASTIR生成器（接收到语法分析器传来的语法树，生成Ast-IR）->STVCWriter（接收到ASTIR生成器的Ast-IR，同时接受到用户指定的行动物品——目标文件名，将其以二进制形式写入用户给定的目标文件名）
+文本文件读取器（用户给定文件名作为行动物品，生成一个行读取器）->词法分析器（接受到文本文件读取器传来的行阅读器，生成一个词法单元读取器）->语法分析器（接受到词法分析器传来的词法单元读取器，生成语法树）->ASTIR生成器（接收到语法分析器传来的语法树，生成Ast-IR）->AstIrWriter（接收到ASTIR生成器的Ast-IR，同时接受到用户指定的行动物品——目标文件名，将其以二进制形式写入用户给定的目标文件名）
 
 行动工具生成的行动物品交给下一个行动工具处理，环环相扣。但是你不能让以下行动工具按顺序执行：
 
@@ -83,9 +83,9 @@
 * **AstWriterTool**：写入语法树文件，接受AstItem和用户提供的物品（文件名），不生成物品。
 * **ParserTool**：语法分析，接受TokenReaderItem以及用户加入的物品，生成AstItem
 * **AstIRTool**：将Ast转为Ast-IR，接受AstItem以及用户加入的物品，生成AstIRItem
-* **STVCWriterTool**：将Ast-IR写入二进制文件，接受AstIRItem和用户加入的物品（文件名），不生成行动物品
+* **AstIrWriterTool**：将Ast-IR写入二进制文件，接受AstIRItem和用户加入的物品（文件名），不生成行动物品
 * **STVCBufferWriterTool**：将Ast-IR以二进制格式写入内存，接受AstIRItem以及用户加入的物品，生成BufferItem
-* **STVCReaderTool**：打开Ast-IR的STVC文件，只接受用户提供的物品（文件名），生成AstRunnerItem
+* **AstIrReaderTool**：打开Ast-IR的STVC文件，只接受用户提供的物品（文件名），生成AstRunnerItem
 * **STVCBufferReaderTool**：将指定的内存按照Ast-IR的二进制格式读取，接受BufferItem以及用户加入的物品，生成AstRunnerItem
 * **AstRunnerTool**：运行Running-Ast，接受AstRunnerItem以及用户加入的物品，不生成行动物品
 
diff --git a/doc/工作日志/20240510.md b/doc/工作日志/20240510.md
@@ -217,13 +217,13 @@ SFN类的主要接口有：
 
 我们来逐步讲解。
 
-首先是二进制文件读取为AstIR，这部分的实现位于``src/vm/STVCReader.cpp``，STVCReader类的主要接口有：
+首先是二进制文件读取为AstIR，这部分的实现位于``src/vm/AstIrReader.cpp``，AstIrReader类的主要接口有：
 
-* ``STVCReader(char* vmcode, int code_size, STMException* e)``：构造函数，vmcode为字节码在内存中的地址，code_size指字节码的大小，e为异常类
+* ``AstIrReader(char* vmcode, int code_size, STMException* e)``：构造函数，vmcode为字节码在内存中的地址，code_size指字节码的大小，e为异常类
 * ``bool ReadHeader()``：读取字节码头，读取失败则抛出异常并返回false，否则返回true
 * ``ArrayList<AstIR> ReadIR()``：读取AstIR，返回由AstIR组成的ArrayList
 
-想要完整的读取一个STVC文件，应该要先创建一个STVCReader对象，然后先调用``ReadHeader``读取文件头信息，接着调用``ReadIR``来读取AstIR。调用这两个函数之后要分别检查是否有异常抛出。
+想要完整的读取一个STVC文件，应该要先创建一个AstIrReader对象，然后先调用``ReadHeader``读取文件头信息，接着调用``ReadIR``来读取AstIR。调用这两个函数之后要分别检查是否有异常抛出。
 
 接着是让AstIRGenerator类解析为Running-Ast，这一部分在**写了Ast与AstIR之间的互转工具**部分里已经详细提及过了，故不再赘述。
 
diff --git a/doc/工作日志/20241029.md b/doc/工作日志/20241029.md
@@ -8,8 +8,8 @@
 
 ### 封装了Stamon.hpp
 
-在以前，读取STVC文件使用的是``STVCReader``，而写入STVC文件是在``Stamon.hpp``当中直接实现的，这种现象带来的大量的代码冗余。
-我将写入STVC文件的代码逻辑封装到了``STVCWriter.cpp``中，现在，源码逻辑更加对称和简洁了。
+在以前，读取STVC文件使用的是``AstIrReader``，而写入STVC文件是在``Stamon.hpp``当中直接实现的，这种现象带来的大量的代码冗余。
+我将写入STVC文件的代码逻辑封装到了``AstIrWriter.cpp``中，现在，源码逻辑更加对称和简洁了。
 
 接下来，我将会进一步封装``Stamon.hpp``，使得Stamon的编译过程可以更加细化（甚至做到分布编译）。
 
diff --git a/doc/工作日志/20250302.md b/doc/工作日志/20250302.md
@@ -1,4 +1,4 @@
-# 2025/02/28 工作日志
+# 2025/03/02 工作日志
 
 本次更新不改变内部版本。
 本次更新整合了Makefile，删去了已经过时的预处理器代码。
diff --git a/doc/工作日志/20250303.md b/doc/工作日志/20250303.md
@@ -0,0 +1,36 @@
+# 2025/03/03 工作日志
+
+本次更新的内部版本为``2.4.38``。
+本次更新并不会发行``2.4.38``。
+本次更新迁移了部分文件，修复了一个不致命的错误。
+
+### 迁移了AstIR的读入写入源码
+
+将``STVCReader.cpp``改名为``AstIrReader.cpp``，并迁移至``src/action``目录下。
+将``STVCWriter.cpp``改名为``AstIrWriter.cpp``，并迁移至``src/action``目录下。
+
+相应文档对``STVCReader``和``STVCWriter``的称呼也被调整。
+
+此举动旨在为后续的STVC-TAC读入写入源码留足命名的空间。
+
+### 修复了一个不致命的错误
+
+错误位于``Stamon.hpp``。
+在初始化AST的头节点时，忘记初始化其文件名和对应行号，导致每次生成的字节码都不相同。
+尽管头节点不会报错，不影响使用，但是我还是修复了他。
+
+### 接下来要做的事
+
+1. 将``TokenFileWriter``和``TokenFileReader``进行调试
+2. 为重构虚拟机做准备工作
+3. 实现分步行动机制
+4. 开发Stamon的安装工具
+5. 推进Stamon包管理器的开发
+6. 推进斯塔蒙的开发
+7. 支持文件处理库
+
+### 后记
+
+更新可能会变得更加频繁。
+我重构虚拟机的意向从未如此强烈。
+我认为是时候付诸行动了，让一些带有错误认知的人重新认识这个项目。
diff --git a/src/Stamon.hpp b/src/Stamon.hpp
@@ -11,7 +11,7 @@
 namespace stamon {
 	constexpr int STAMON_VER_X = 2;
 	constexpr int STAMON_VER_Y = 4;
-	constexpr int STAMON_VER_Z = 37;
+	constexpr int STAMON_VER_Z = 38;
 }
 
 #include"ArrayList.hpp"
@@ -20,8 +20,8 @@ namespace stamon {
 #include"AstRunner.cpp"
 #include"ObjectManager.cpp"
 #include"Ast.hpp"
-#include"STVCReader.cpp"
-#include"STVCWriter.cpp"
+#include"AstIrReader.cpp"
+#include"AstIrWriter.cpp"
 #include"AstIR.cpp"
 #include"Compiler.hpp"
 #include"Exception.hpp"
@@ -84,6 +84,10 @@ namespace stamon {
 				}
 
 				ast::AstNode* node = new ast::AstProgram(&program);
+				
+				//初始化node
+				node->filename = String();
+				node->lineNo = -1;
 
 				//编译为IR
 
@@ -96,7 +100,7 @@ namespace stamon {
 				ArrayList<datatype::DataType*>
 				ir_tableconst = generator.tableConst;
 
-				ir::STVCWriter writer(ex);
+				ir::AstIrWriter writer(ex);
 
 				writer.write(
 					ir_list, ir_tableconst, dst, isStrip,
@@ -124,7 +128,7 @@ namespace stamon {
 					return;
 				}
 
-				ir::STVCReader ir_reader(reader.read(), reader.size, ex);
+				ir::AstIrReader ir_reader(reader.read(), reader.size, ex);
 				//初始化字节码读取器
 
 				CATCH {
@@ -189,7 +193,7 @@ namespace stamon {
 					return;
 				}
 
-				ir::STVCReader ir_reader(reader.read(), reader.size, ex);
+				ir::AstIrReader ir_reader(reader.read(), reader.size, ex);
 				//初始化字节码读取器
 
 				CATCH {
@@ -217,7 +221,7 @@ namespace stamon {
 
 				//写入魔数
 				
-				ir::STVCWriter writer(ex);
+				ir::AstIrWriter writer(ex);
 
 				writer.write(
 					ir_list, ir_tableconst, src, true,
diff --git a/src/action/AstIrReader.cpp b/src/action/AstIrReader.cpp
@@ -1,5 +1,5 @@
 /*
-	Name: STVCReader.cpp
+	Name: AstIrReader.cpp
 	Copyright: Apache 2.0
 	Author: CLimber-Rong
 	Date: 09/12/23 17:34
@@ -15,7 +15,7 @@
 #include"AstIR.cpp"
 
 namespace stamon::ir {
-	class STVCReader {
+	class AstIrReader {
 			char* stvc;		//代码
 			int stvc_size;	//代码大小
 			int pos;		//设当前需要读取的字节为stvc[pos]
@@ -25,7 +25,7 @@ namespace stamon::ir {
 
 			STMException* ex;
 
-			STVCReader(char* vmcode, int code_size, STMException* e) {
+			AstIrReader(char* vmcode, int code_size, STMException* e) {
 				ex = e;
 				//传入字节码和字节码大小
 				stvc_size = code_size;
diff --git a/src/action/AstIrWriter.cpp b/src/action/AstIrWriter.cpp
@@ -1,5 +1,5 @@
 /*
-	Name: STVCwriter.cpp
+	Name: AstIrWriter.cpp
 	Copyright: Apache 2.0
 	Author: CLimber-Rong
 	Date: 09/12/23 17:34
@@ -32,14 +32,14 @@
 	}
 
 namespace stamon::ir {
-	class STVCWriter {
+	class AstIrWriter {
 
 		public:
 
 			STMException* ex;
 
-			STVCWriter() {}
-			STVCWriter(STMException* e) {
+			AstIrWriter() {}
+			AstIrWriter(STMException* e) {
 				ex = e;
 			}
 
diff --git a/test/lexer/test.cpp b/test/lexer/test.cpp
@@ -10,7 +10,7 @@
 #include"DataType.hpp"
 #include"ObjectManager.cpp"
 #include"Ast.hpp"
-#include"STVCReader.cpp"
+#include"AstIrReader.cpp"
 #include"Lexer.cpp"
 
 using namespace stamon::ir;
diff --git a/test/parser/test.cpp b/test/parser/test.cpp
@@ -19,7 +19,7 @@
 #include"DataType.hpp"
 #include"ObjectManager.cpp"
 #include"Ast.hpp"
-#include"STVCReader.cpp"
+#include"AstIrReader.cpp"
 #include"Lexer.cpp"
 #include"Parser.cpp"
 
diff --git a/xmake.lua b/xmake.lua
@@ -17,6 +17,7 @@ target("stamon")
     add_includedirs("src/ir")
     add_includedirs("src/compiler")
     add_includedirs("src/sfn")
+    add_includedirs("src/action")
     add_includedirs("include/stdc_implemented")
 
     set_optimize("faster")
