Add annotation statements and expand annotation tests

Author: pigpigyyy

CMakeLists.txt

@@ -28,6 +28,11 @@ if (LUA_EXEC_NAME MATCHES "luajit")
 		NAMES luajit libluajit
 		PATHS ${LUA_LIBDIR}
 		NO_DEFAULT_PATH)
+elseif (LUA_VERSION_STRING MATCHES "Lua 5.5")
+	find_library(LUA_LIBRARIES
+		NAMES lua55 lua5.5 liblua55 liblua5.5 lua liblua
+		PATHS ${LUA_LIBDIR}
+		NO_DEFAULT_PATH)
 elseif (LUA_VERSION_STRING MATCHES "Lua 5.4")
 	find_library(LUA_LIBRARIES
 		NAMES lua54 lua5.4 liblua54 liblua5.4 lua liblua

spec/inputs/annotation.yue

@@ -0,0 +1,27 @@
+macro ClsDef = (code`ClassDecl) ->
+	className = code\match "^class%s+(%w+)"
+	lines = table.concat [item\gsub "%-%-%-", "---@" for item in code\gmatch "(%-%-%-.-)\n"], "\n"
+	return
+		type: "text"
+		before: false
+		code: |
+			---@class #{className}
+			#{lines}
+			---@class #{className}Class
+			---@operator call:#{className}
+			---@cast #{className} #{className}Class
+
+$[ClsDef]
+class A
+	---field x number
+	---field y number
+	new: (@x = 0, @y = 0) =>
+	---field setAdd fun(self: A, x: number, y: number): number Set fields and add number values.
+	setAdd: (@x, @y) => @x + @y
+
+a = A!
+res = a::setAdd 1, 2
+print(a.x, a.y, a.y, res)
+
+return
+

spec/inputs/annotation_before.yue

@@ -0,0 +1,16 @@
+macro Tag = (tag, code`ClassDecl) ->
+	className = code\match "^class%s+(%w+)"
+	return
+		type: "text"
+		before: tag == "before"
+		code: "-- #{tag}:#{className}"
+
+$[Tag("before")]
+class B
+	getTag: => "before"
+
+$[Tag("after")]
+class C
+	getTag: => "after"
+
+return B!\getTag!, C!\getTag!

spec/inputs/test/annotation_spec.yue

@@ -0,0 +1,160 @@
+import to_lua from require "yue"
+
+compile_and_run = (code, config = {}) ->
+	lua_code, err = to_lua code, config
+	assert.is_nil err
+	assert.is_not_nil lua_code
+	chunk, load_err = load lua_code
+	assert.is_nil load_err
+	assert.is_not_nil chunk
+	chunk!
+
+describe "annotation", ->
+	it "should append generated text after annotated class by default", ->
+		code = [[
+macro ClsDef = (code`ClassDecl) ->
+	className = code\match "^class%s+(%w+)"
+	return
+		type: "text"
+		before: false
+		code: "-- after:" .. className
+
+$[ClsDef]
+class A
+	getName: => "A"
+
+return
+]]
+		result, err = to_lua code
+		assert.is_nil err
+		assert.is_not_nil result
+		assert.is_true result\find("__name = \"A\"") != nil
+		assert.is_true result\find("%-%- after:A") != nil
+		assert.is_true result\find("__name = \"A\"") < result\find("%-%- after:A")
+
+	it "should place generated text before the annotated statement when before is true", ->
+		code = [[
+macro Before = (code`ClassDecl) ->
+	className = code\match "^class%s+(%w+)"
+	return
+		type: "text"
+		before: true
+		code: "-- before:" .. className
+
+$[Before]
+class B
+	getName: => "B"
+
+return
+]]
+		result, err = to_lua code
+		assert.is_nil err
+		assert.is_not_nil result
+		assert.is_true result\find("%-%- before:B") != nil
+		assert.is_true result\find("local B") != nil
+		assert.is_true result\find("%-%- before:B") < result\find("local B")
+
+	it "should support annotation invocation arguments", ->
+		code = [[
+macro Tag = (tag, code`ClassDecl) ->
+	className = code\match "^class%s+(%w+)"
+	return
+		type: "text"
+		before: false
+		code: "-- " .. tag .. ":" .. className
+
+$[Tag("entity")]
+class C
+	getName: => "C"
+
+return
+]]
+		result, err = to_lua code
+		assert.is_nil err
+		assert.is_not_nil result
+		assert.is_true result\find("%-%- \"entity\":C") != nil
+
+	it "should report an error when annotation is not followed by a statement", ->
+		code = [[
+macro Invalid = (code) -> ""
+$[Invalid]
+]]
+		result, err = to_lua code
+		assert.is_nil result
+		assert.is_true err\match("annotation must be followed by a statement") != nil
+
+	it "should wrap annotated function to validate numeric arguments", ->
+		code = [[
+macro ValidateNumberArgs = (code) ->
+	funcName = code\match "^(%w+)%s*="
+	return
+		type: "text"
+		before: false
+		code: table.concat {
+			"local __orig_#{funcName} = #{funcName}"
+			"#{funcName} = function(a, b)"
+			"\tassert(type(a) == \"number\", \"expected number for a\")"
+			"\tassert(type(b) == \"number\", \"expected number for b\")"
+			"\treturn __orig_#{funcName}(a, b)"
+			"end"
+		}, "\n"
+
+$[ValidateNumberArgs]
+add = (a, b) -> a + b
+
+ok, value = pcall -> add 3, 4
+bad_ok, bad_err = pcall -> add "3", 4
+return ok, value, bad_ok, bad_err
+]]
+		ok, value, bad_ok, bad_err = compile_and_run code
+		assert.is_true ok
+		assert.same value, 7
+		assert.is_false bad_ok
+		assert.is_true bad_err\match("expected number for a") != nil
+
+	it "should wrap annotated function to validate return value", ->
+		code = [[
+macro ValidateNumberReturn = (code) ->
+	funcName = code\match "^(%w+)%s*="
+	return
+		type: "text"
+		before: false
+		code: table.concat {
+			"local __orig_#{funcName} = #{funcName}"
+			"#{funcName} = function(...)"
+			"\tlocal result = __orig_#{funcName}(...)"
+			"\tassert(type(result) == \"number\", \"expected numeric return\")"
+			"\treturn result"
+			"end"
+		}, "\n"
+
+$[ValidateNumberReturn]
+toText = (value) -> tostring value
+
+ok, err = pcall -> toText 42
+return ok, err
+]]
+		ok, err = compile_and_run code
+		assert.is_false ok
+		assert.is_true err\match("expected numeric return") != nil
+
+	it "should use annotation arguments to register annotated classes", ->
+		code = [[
+macro Register = (registry, code`ClassDecl) ->
+	className = code\match "^class%s+(%w+)"
+	return
+		type: "text"
+		before: false
+		code: "#{registry}[\"#{className}\"] = #{className}"
+
+registry = {}
+
+$[Register(registry)]
+class Worker
+	run: => "ok"
+
+return registry.Worker != nil, registry.Worker!\run!
+]]
+		exists, result = compile_and_run code
+		assert.is_true exists
+		assert.same result, "ok"

spec/inputs/test/format_spec.yue

@@ -26,6 +26,8 @@ files = [
 	"spec/inputs/export_default.yue"
 	"spec/inputs/with_scope_shadow.yue"
 	"spec/inputs/assign.yue"
+	"spec/inputs/annotation.yue"
+	"spec/inputs/annotation_before.yue"
 	"spec/inputs/literals.yue"
 	"spec/inputs/luarocks_upload.yue"
 	"spec/inputs/comprehension_nested.yue"
@@ -64,6 +66,7 @@ files = [
 	"spec/inputs/test/continue_spec.yue"
 	"spec/inputs/test/varargs_assignment_spec.yue"
 	"spec/inputs/test/advanced_macro_spec.yue"
+	"spec/inputs/test/annotation_spec.yue"
 	"spec/inputs/test/pipe_spec.yue"
 	"spec/inputs/test/export_spec.yue"
 	"spec/inputs/test/existential_spec.yue"
@@ -192,4 +195,3 @@ for file in *files
 	assert.is_not_nil ast
 	rewriteLineCol ast
 	assert.same original_ast, ast
-

spec/outputs/annotation.lua

@@ -0,0 +1,48 @@
+local A
+do
+	local _class_0
+	local _base_0 = {
+		setAdd = function(self, x, y)
+			self.x = x
+			self.y = y
+			return self.x + self.y
+		end
+	}
+	if _base_0.__index == nil then
+		_base_0.__index = _base_0
+	end
+	_class_0 = setmetatable({
+		__init = function(self, x, y)
+			if x == nil then
+				x = 0
+			end
+			if y == nil then
+				y = 0
+			end
+			self.x = x
+			self.y = y
+		end,
+		__base = _base_0,
+		__name = "A"
+	}, {
+		__index = _base_0,
+		__call = function(cls, ...)
+			local _self_0 = setmetatable({ }, _base_0)
+			cls.__init(_self_0, ...)
+			return _self_0
+		end
+	})
+	_base_0.__class = _class_0
+	A = _class_0
+end
+---@class A
+---@field x number
+---@field y number
+---@field setAdd fun(self: A, x: number, y: number): number Set fields and add number values.
+---@class AClass
+---@operator call:A
+---@cast A AClass
+local a = A()
+local res = a:setAdd(1, 2)
+print(a.x, a.y, a.y, res)
+return

spec/outputs/annotation_before.lua

@@ -0,0 +1,55 @@
+local B
+do
+	local _class_0
+	local _base_0 = {
+		getTag = function(self)
+			return "before"
+		end
+	}
+	if _base_0.__index == nil then
+		_base_0.__index = _base_0
+	end
+	_class_0 = setmetatable({
+		__init = function() end,
+		__base = _base_0,
+		__name = "B"
+	}, {
+		__index = _base_0,
+		__call = function(cls, ...)
+			local _self_0 = setmetatable({ }, _base_0)
+			cls.__init(_self_0, ...)
+			return _self_0
+		end
+	})
+	_base_0.__class = _class_0
+	B = _class_0
+end
+-- "before":B
+local C
+do
+	local _class_0
+	local _base_0 = {
+		getTag = function(self)
+			return "after"
+		end
+	}
+	if _base_0.__index == nil then
+		_base_0.__index = _base_0
+	end
+	_class_0 = setmetatable({
+		__init = function() end,
+		__base = _base_0,
+		__name = "C"
+	}, {
+		__index = _base_0,
+		__call = function(cls, ...)
+			local _self_0 = setmetatable({ }, _base_0)
+			cls.__init(_self_0, ...)
+			return _self_0
+		end
+	})
+	_base_0.__class = _class_0
+	C = _class_0
+end
+-- "after":C
+return B():getTag(), C():getTag()