support unambiguous_remove_string_only

Author: CppCXY

CodeService/src/AstUtil.cpp

@@ -84,6 +84,37 @@ bool ast_util::IsSingleStringArg(std::shared_ptr<LuaAstNode> callArgList)
 	return false;
 }
 
+
+bool ast_util::IsSingleStringArgUnambiguous(std::shared_ptr<LuaAstNode> callArgList)
+{
+	bool isSingleStringArg = IsSingleStringArg(callArgList);
+	if (!isSingleStringArg)
+	{
+		return false;
+	}
+
+	auto callExpression = callArgList->GetParent();
+	if (!callExpression)
+	{
+		return false;
+	}
+	if (callExpression->GetType() != LuaAstNodeType::CallExpression)
+	{
+		return false;
+	}
+
+	auto indexExpression = callExpression->GetParent();
+	if (indexExpression && indexExpression->GetType() == LuaAstNodeType::IndexExpression)
+	{
+		if (!indexExpression->GetChildren().empty() && callExpression == indexExpression->GetChildren().front())
+		{
+			return false;
+		}
+	}
+
+	return true;
+}
+
 bool ast_util::IsSingleTableArg(std::shared_ptr<LuaAstNode> callArgList)
 {
 	if (!callArgList)
@@ -130,29 +161,50 @@ bool ast_util::WillCallArgHaveParentheses(std::shared_ptr<LuaAstNode> callArgLis
 {
 	if (ast_util::IsSingleStringOrTableArg(callArgList))
 	{
-		if (IsSingleStringArg(callArgList) && callArgParentheses == CallArgParentheses::RemoveStringLiteralOnly)
+		switch (callArgParentheses)
 		{
-			return false;
-		}
-		else if (IsSingleTableArg(callArgList) && callArgParentheses == CallArgParentheses::RemoveTableOnly)
-		{
-			return false;
+		case CallArgParentheses::Remove:
+			{
+				return false;
+			}
+		case CallArgParentheses::RemoveStringOnly:
+			{
+				if(IsSingleStringArg(callArgList))
+				{
+					return false;
+				}
+				break;
+			}
+		case CallArgParentheses::RemoveTableOnly:
+			{
+				if(IsSingleTableArg(callArgList))
+				{
+					return false;
+				}
+				break;
+			}
+		case CallArgParentheses::UnambiguousRemoveStringOnly:
+			{
+				if(IsSingleStringArgUnambiguous(callArgList))
+				{
+					return false;
+				}
+				break;
+			}
+		default:
+			{
+				break;
+			}
 		}
-		else if (callArgParentheses == CallArgParentheses::Remove)
+
+		auto leftParentheses = callArgList->FindFirstOf(LuaAstNodeType::GeneralOperator);
+		if (leftParentheses && leftParentheses->GetText() == "(")
 		{
-			return false;
+			return true;
 		}
 		else
 		{
-			auto leftParentheses = callArgList->FindFirstOf(LuaAstNodeType::GeneralOperator);
-			if (leftParentheses && leftParentheses->GetText() == "(")
-			{
-				return true;
-			}
-			else
-			{
-				return false;
-			}
+			return false;
 		}
 	}
 

CodeService/src/LuaEditorConfig.cpp

@@ -211,22 +211,26 @@ void LuaEditorConfig::ParseFromSection(std::shared_ptr<LuaCodeStyleOptions> opti
 
 	if(configMap.count("call_arg_parentheses"))
 	{
-		if(configMap.at("call_arg_parentheses") == "keep")
+		if (configMap.at("call_arg_parentheses") == "keep")
 		{
 			options->call_arg_parentheses = CallArgParentheses::Keep;
 		}
-		else if(configMap.at("call_arg_parentheses") == "remove")
+		else if (configMap.at("call_arg_parentheses") == "remove")
 		{
 			options->call_arg_parentheses = CallArgParentheses::Remove;
 		}
-		else if(configMap.at("call_arg_parentheses") == "remove_string_only")
+		else if (configMap.at("call_arg_parentheses") == "remove_string_only")
 		{
-			options->call_arg_parentheses = CallArgParentheses::RemoveStringLiteralOnly;
+			options->call_arg_parentheses = CallArgParentheses::RemoveStringOnly;
 		}
-		else if(configMap.at("call_arg_parentheses") == "remove_table_only")
+		else if (configMap.at("call_arg_parentheses") == "remove_table_only")
 		{
 			options->call_arg_parentheses = CallArgParentheses::RemoveTableOnly;
 		}
+		else if (configMap.at("call_arg_parentheses") == "unambiguous_remove_string_only")
+		{
+			options->call_arg_parentheses = CallArgParentheses::UnambiguousRemoveStringOnly;
+		}
 	}
 
 	if (configMap.count("continuation_indent_size")

CodeService/src/LuaFormatter.cpp

@@ -1150,8 +1150,10 @@ std::shared_ptr<FormatElement> LuaFormatter::FormatCallArgList(std::shared_ptr<L
 			&& _options.call_arg_parentheses == CallArgParentheses::Remove)
 		|| (_options.call_arg_parentheses == CallArgParentheses::RemoveTableOnly
 			&& ast_util::IsSingleTableArg(callArgList))
-		|| (_options.call_arg_parentheses == CallArgParentheses::RemoveStringLiteralOnly
-			&& ast_util::IsSingleStringArg(callArgList)))
+		|| (_options.call_arg_parentheses == CallArgParentheses::RemoveStringOnly
+			&& ast_util::IsSingleStringArg(callArgList))
+		|| (_options.call_arg_parentheses == CallArgParentheses::UnambiguousRemoveStringOnly
+			&& ast_util::IsSingleStringArgUnambiguous(callArgList)))
 	{
 		for (auto child : children)
 		{

Test/test_script/format_text/wait_format_by_option/.editorconfig

@@ -153,6 +153,8 @@ call_arg_parentheses = keep
 call_arg_parentheses = remove_table_only
 [{call_arg_parentheses-eq-remove_string_only.lua}]
 call_arg_parentheses = remove_string_only
+[{call_arg_parentheses-eq-unambiguous_remove_string_only.lua}]
+call_arg_parentheses = unambiguous_remove_string_only
 [{minLine-eq-1.lua}]
 keep_line_after_if_statement = minLine:1
 keep_line_after_do_statement = minLine:1

Test/test_script/format_text/wait_format_by_option/call_arg_parentheses-eq-unambiguous_remove_string_only.lua

@@ -0,0 +1,4 @@
+local t = require("aaaaa").mod
+local b = require("bbbbb")
+local c = require "ddddd"
+p("okwjgfiowjiofw").aa = 13

Test/test_script/format_text/wait_format_by_option_should_be/.editorconfig

@@ -151,6 +151,8 @@ call_arg_parentheses = keep
 call_arg_parentheses = remove_table_only
 [{call_arg_parentheses-eq-remove_string_only.lua}]
 call_arg_parentheses = remove_string_only
+[{call_arg_parentheses-eq-unambiguous_remove_string_only.lua}]
+call_arg_parentheses = unambiguous_remove_string_only
 [{minLine-eq-1.lua}]
 keep_line_after_if_statement = minLine:1
 keep_line_after_do_statement = minLine:1

Test/test_script/format_text/wait_format_by_option_should_be/call_arg_parentheses-eq-unambiguous_remove_string_only.lua

@@ -0,0 +1,4 @@
+local t = require("aaaaa").mod
+local b = require "bbbbb"
+local c = require "ddddd"
+p("okwjgfiowjiofw").aa = 13

docs/format_config.md

@@ -70,7 +70,7 @@ end
 ## call_arg_parentheses
 
 该选项表示，调用表达式中如果参数仅有单字符串字面值常量或者表表达式，则可以考虑保持或者移除括号。
-该选项可选值是 keep/remove/remove_table_only/remove_string_only 默认值是keep。
+该选项可选值是 keep/remove/remove_table_only/remove_string_only/unambiguous_remove_string_only 默认值是keep。
 
 ```lua
 f("wfwefw")({ e1231313 })("1e1231313131")
@@ -91,6 +91,19 @@ f("wfwefw") { e1231313 } ("1e1231313131")
 f "wfwefw" ({ e1231313 }) "1e1231313131"
 ```
 
+如果值为unambiguous_remove_string_only则不存在歧义的时候会移除调用表达式中字符串的括号,例如:
+```lua
+local t = require("aaaa").bbb
+local d = require("cccc")
+```
+会被格式化为:
+```lua
+local t = require("aaaa").bbb
+local d = require "cccc"
+```
+
+
+
 ## continuation_indent_size
 
 该选项表示长表达式或者表达式列表在换行表达时的后续缩进列数，该选项默认值是4，常见的还有8

docs/format_config_EN.md

@@ -90,6 +90,18 @@ f("wfwefw") { e1231313 } ("1e1231313131")
 f "wfwefw" ({ e1231313 }) "1e1231313131"
 ```
 
+If the value is unambiguous_remove_string_only, the parentheses of the string in the call expression will be removed when there is no ambiguity, for example:
+```lua
+local t = require("aaaa").bbb
+local d = require("cccc")
+```
+will be formatted as:
+```lua
+local t = require("aaaa").bbb
+local d = require "cccc"
+```
+
+
 ## continuation_indent_size
 
 This option indicates the number of subsequent indented columns when a long expression or expression list is expressed in a new line. The default value of this option is 4, and 8 is common

include/CodeService/AstUtil.h

@@ -9,6 +9,8 @@ namespace ast_util
 
 	bool IsSingleStringArg(std::shared_ptr<LuaAstNode> callArgList);
 
+	bool IsSingleStringArgUnambiguous(std::shared_ptr<LuaAstNode> callArgList);
+
 	bool IsSingleTableArg(std::shared_ptr<LuaAstNode> callArgList);
 
 	bool WillCallArgHaveParentheses(std::shared_ptr<LuaAstNode> callArgList, CallArgParentheses callArgParentheses);