Updated reserved comments function.

Author: pigpigyyy

doc/docs/doc/README.md

@@ -4729,7 +4729,7 @@ Converts the code to the AST.
 
 **Signature:**
 ```lua
-to_ast: function(code: string, flattenLevel?: number, astName?: string):
+to_ast: function(code: string, flattenLevel?: number, astName?: string, reserveComment?: boolean):
 		--[[AST]] AST | nil,
 		--[[error]] nil | string
 ```
@@ -4741,6 +4741,7 @@ to_ast: function(code: string, flattenLevel?: number, astName?: string):
 | code | string | The code. |
 | flattenLevel | integer | [Optional] The flatten level. Higher level means more flattening. Default is 0. Maximum is 2. |
 | astName | string | [Optional] The AST name. Default is "File". |
+| reserveComment | boolean | [Optional] Whether to reserve the original comments. Default is false. |
 
 **Returns:**
 
@@ -4749,6 +4750,33 @@ to_ast: function(code: string, flattenLevel?: number, astName?: string):
 | AST \| nil | The AST, or nil if the conversion failed. |
 | string \| nil | The error message, or nil if the conversion succeeded. |
 
+#### format
+
+**Type:** Function.
+
+**Description:**
+
+Formats the YueScript code.
+
+**Signature:**
+```lua
+format: function(code: string, tabSize?: number, reserveComment?: boolean): string
+```
+
+**Parameters:**
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| code | string | The code. |
+| tabSize | integer | [Optional] The tab size. Default is 4. |
+| reserveComment | boolean | [Optional] Whether to reserve the original comments. Default is true. |
+
+**Returns:**
+
+| Return Type | Description |
+| --- | --- |
+| string | The formatted code. |
+
 #### __call
 
 **Type:** Metamethod.
@@ -4820,6 +4848,19 @@ Whether the compiler should reserve the original line number in the compiled cod
 reserve_line_number: boolean
 ```
 
+#### reserve_comment
+
+**Type:** Field.
+
+**Description:**
+
+Whether the compiler should reserve the original comments in the compiled code.
+
+**Signature:**
+```lua
+reserve_comment: boolean
+```
+
 #### space_over_tab
 
 **Type:** Field.

doc/docs/zh/doc/README.md

@@ -4686,7 +4686,7 @@ type AST = {string, integer, integer, any}
 
 **签名：**
 ```lua
-to_ast: function(code: string, flattenLevel?: number, astName?: string):
+to_ast: function(code: string, flattenLevel?: number, astName?: string, reserveComment?: boolean):
 		--[[AST]] AST | nil,
 		--[[error]] nil | string
 ```
@@ -4697,6 +4697,42 @@ to_ast: function(code: string, flattenLevel?: number, astName?: string):
 | --- | --- | --- |
 | code | string | 代码。 |
 | flattenLevel | integer | [可选] 扁平化级别。级别越高，会消除更多的 AST 结构的嵌套。默认为 0。最大为 2。 |
+| astName | string | [可选] AST 名称。默认为 "File"。 |
+| reserveComment | boolean | [可选] 是否保留原始注释。默认为 false。 |
+
+**返回值：**
+
+| 返回类型 | 描述 |
+| --- | --- |
+| AST \| nil | AST，如果转换失败则为 nil。 |
+| string \| nil | 错误消息，如果转换成功则为 nil。 |
+
+#### format
+
+**类型：** 函数。
+
+**描述：**
+
+格式化 YueScript 代码。
+
+**签名：**
+```lua
+format: function(code: string, tabSize?: number, reserveComment?: boolean): string
+```
+
+**参数：**
+
+| 参数名 | 类型 | 描述 |
+| --- | --- | --- |
+| code | string | 代码。 |
+| tabSize | integer | [可选] 制表符大小。默认为 4。 |
+| reserveComment | boolean | [可选] 是否保留原始注释。默认为 true。 |
+
+**返回值：**
+
+| 返回类型 | 描述 |
+| --- | --- |
+| string | 格式化后的代码。 |
 
 #### __call
 
@@ -4769,6 +4805,19 @@ implicit_return_root: boolean
 reserve_line_number: boolean
 ```
 
+#### reserve_comment
+
+**类型：** 成员变量。
+
+**描述：**
+
+编译器是否应该在编译后的代码中保留原始注释。
+
+**签名：**
+```lua
+reserve_comment: boolean
+```
+
 #### space_over_tab
 
 **类型：** 成员变量。

spec/inputs/test/format_spec.yue

@@ -119,7 +119,7 @@ for file in *files
 	original_ast = yue.to_ast code
 	assert.is_not_nil original_ast
 	rewriteLineCol original_ast
-	formated = yue.format code
+	formated = yue.format code, 0, false
 	ast = yue.to_ast formated
 	assert.is_not_nil ast
 	rewriteLineCol ast

spec/outputs/test/format_spec.lua

@@ -122,7 +122,7 @@ return describe("format", function()
 			local original_ast = yue.to_ast(code)
 			assert.is_not_nil(original_ast)
 			rewriteLineCol(original_ast)
-			local formated = yue.format(code)
+			local formated = yue.format(code, 0, false)
 			local ast = yue.to_ast(formated)
 			assert.is_not_nil(ast)
 			rewriteLineCol(ast)

src/yuescript/yue_ast.cpp

@@ -203,9 +203,16 @@ std::string YueLineComment_t::to_string(void* ud) const {
 	auto info = reinterpret_cast<YueFormat*>(ud);
 	return "--"s + info->convert(this);
 }
-std::string MultilineCommentInner_t::to_string(void* ud) const {
+std::string YueMultilineComment_t::to_string(void* ud) const {
 	auto info = reinterpret_cast<YueFormat*>(ud);
-	return info->convert(this);
+	return "--[["s + info->convert(this) + "]]"s;
+}
+std::string YueComment_t::to_string(void* ud) const {
+	if (comment) {
+		return comment->to_string(ud);
+	} else {
+		return {};
+	}
 }
 std::string Variable_t::to_string(void* ud) const {
 	return name->to_string(ud);
@@ -1596,38 +1603,15 @@ std::string StatementAppendix_t::to_string(void* ud) const {
 	return item->to_string(ud);
 }
 std::string Statement_t::to_string(void* ud) const {
-	std::string line;
-	if (!comments.empty()) {
-		auto info = reinterpret_cast<YueFormat*>(ud);
-		str_list temp;
-		for (ast_node* comment : comments.objects()) {
-			if (comment == comments.front()) {
-				temp.push_back(comment->to_string(ud));
-			} else {
-				temp.push_back(info->ind() + comment->to_string(ud));
-			}
-		}
-		if (appendix) {
-			temp.push_back(info->ind() + content->to_string(ud) + ' ' + appendix->to_string(ud));
-			return join(temp, "\n"sv);
-		} else {
-			temp.push_back(info->ind() + content->to_string(ud));
-			return join(temp, "\n"sv);
-		}
+	if (appendix) {
+		return content->to_string(ud) + ' ' + appendix->to_string(ud);
 	} else {
-		if (appendix) {
-			return content->to_string(ud) + ' ' + appendix->to_string(ud);
-		} else {
-			return content->to_string(ud);
-		}
+		return content->to_string(ud);
 	}
 }
 std::string StatementSep_t::to_string(void*) const {
 	return {};
 }
-std::string YueMultilineComment_t::to_string(void* ud) const {
-	return "--[["s + inner->to_string(ud) + "]]"s;
-}
 std::string ChainAssign_t::to_string(void* ud) const {
 	str_list temp;
 	for (auto exp : exprs.objects()) {
@@ -1641,14 +1625,22 @@ std::string Body_t::to_string(void* ud) const {
 std::string Block_t::to_string(void* ud) const {
 	auto info = reinterpret_cast<YueFormat*>(ud);
 	str_list temp;
-	for (auto stmt_ : statements.objects()) {
-		auto stmt = static_cast<Statement_t*>(stmt_);
-		if (stmt->content.is<PipeBody_t>()) {
-			info->pushScope();
-			temp.emplace_back(stmt->to_string(ud));
-			info->popScope();
-		} else {
-			temp.emplace_back(info->ind() + stmt->to_string(ud));
+	for (auto stmt_ : statementOrComments.objects()) {
+		if (auto stmt = ast_cast<Statement_t>(stmt_)) {
+			if (stmt->content.is<PipeBody_t>()) {
+				info->pushScope();
+				temp.emplace_back(stmt->to_string(ud));
+				info->popScope();
+			} else {
+				temp.emplace_back(info->ind() + stmt->to_string(ud));
+			}
+		} else if (info->reserveComment) {
+			auto comment = ast_to<YueComment_t>(stmt_);
+			if (comment->comment) {
+				temp.emplace_back(info->ind() + comment->to_string(ud));
+			} else {
+				temp.emplace_back(comment->to_string(ud));
+			}
 		}
 	}
 	return join(temp, "\n"sv);

src/yuescript/yue_ast.h

@@ -929,14 +929,14 @@ AST_END(StatementSep)
 AST_LEAF(YueLineComment)
 AST_END(YueLineComment)
 
-AST_LEAF(MultilineCommentInner)
-AST_END(MultilineCommentInner)
-
-AST_NODE(YueMultilineComment)
-	ast_ptr<true, MultilineCommentInner_t> inner;
-	AST_MEMBER(YueMultilineComment, &inner)
+AST_LEAF(YueMultilineComment)
 AST_END(YueMultilineComment)
 
+AST_NODE(YueComment)
+	ast_sel<false, YueLineComment_t, YueMultilineComment_t> comment;
+	AST_MEMBER(YueComment, &comment)
+AST_END(YueComment)
+
 AST_NODE(ChainAssign)
 	ast_ptr<true, Seperator_t> sep;
 	ast_list<true, Exp_t> exprs;
@@ -945,16 +945,14 @@ AST_NODE(ChainAssign)
 AST_END(ChainAssign)
 
 AST_NODE(Statement)
-	ast_ptr<true, Seperator_t> sep;
-	ast_sel_list<false, YueLineComment_t, YueMultilineComment_t> comments;
 	ast_sel<true,
 		Import_t, While_t, Repeat_t, For_t, ForEach_t,
 		Return_t, Local_t, Global_t, Export_t, Macro_t, MacroInPlace_t,
 		BreakLoop_t, Label_t, Goto_t, ShortTabAppending_t,
 		Backcall_t, LocalAttrib_t, PipeBody_t, ExpListAssign_t, ChainAssign_t
 	> content;
 	ast_ptr<false, StatementAppendix_t> appendix;
-	AST_MEMBER(Statement, &sep, &comments, &content, &appendix)
+	AST_MEMBER(Statement, &content, &appendix)
 AST_END(Statement)
 
 AST_NODE(Body)
@@ -964,8 +962,8 @@ AST_END(Body)
 
 AST_NODE(Block)
 	ast_ptr<true, Seperator_t> sep;
-	ast_list<false, Statement_t> statements;
-	AST_MEMBER(Block, &sep, &statements)
+	ast_sel_list<false, Statement_t, YueComment_t> statementOrComments;
+	AST_MEMBER(Block, &sep, &statementOrComments)
 AST_END(Block)
 
 AST_NODE(BlockEnd)
@@ -984,6 +982,7 @@ struct YueFormat {
 	int indent = 0;
 	bool spaceOverTab = false;
 	int tabSpaces = 4;
+	bool reserveComment = true;
 	std::string toString(ast_node* node);
 
 	void pushScope();