---@enum supports runtime values

resolve #1619

Author: sumneko

changelog.md

@@ -146,6 +146,7 @@ server will generate `doc.json` and `doc.md` in `LOGPATH`.
   ---@type boolean[]
   local t = { 1, 2, 3 } --> Warning: Cannot assign `integer` to `boolean`
   ```
+* `CHG` `---@enum` supports runtime values
 * `FIX` [#1479]
 * `FIX` [#1480]
 * `FIX` [#1567]

locale/zh-cn/script.lua

@@ -117,17 +117,17 @@ DIAG_UNDEFINED_DOC_PARAM              =
 DIAG_UNKNOWN_DIAG_CODE                =
 '未知的诊断代号 `{}`。'
 DIAG_CAST_LOCAL_TYPE                  =
-'已显式定义变量的类型为 `{def}` ，不能再将其类型转换为 `{ref}`。'
+'已显式定义变量的类型为 `{def}` ，不能再将其类型转换为 `{ref}`。\n{err}'
 DIAG_CAST_FIELD_TYPE                  =
-'已显式定义字段的类型为 `{def}` ，不能再将其类型转换为 `{ref}`。'
+'已显式定义字段的类型为 `{def}` ，不能再将其类型转换为 `{ref}`。\n{err}'
 DIAG_ASSIGN_TYPE_MISMATCH             =
-'不能将 `{ref}` 赋值给 `{def}`。'
+'不能将 `{ref}` 赋值给 `{def}`。\n{err}'
 DIAG_PARAM_TYPE_MISMATCH              =
-'不能将 `{ref}` 赋给参数 `{def}`。'
+'不能将 `{ref}` 赋给参数 `{def}`。\n{err}'
 DIAG_UNKNOWN_CAST_VARIABLE            =
 '未知的类型转换变量 `{}`。'
 DIAG_CAST_TYPE_MISMATCH               =
-'不能将 `{def}` 转换为 `{ref}`。'
+'不能将 `{def}` 转换为 `{ref}`。\n{err}'
 DIAG_MISSING_RETURN_VALUE             =
 '至少需要 {min} 个返回值，但此处只返回 {rmax} 个值。'
 DIAG_MISSING_RETURN_VALUE_RANGE       =
@@ -589,6 +589,40 @@ CLI_CHECK_SUCCESS =
 CLI_CHECK_RESULTS =
 '诊断完成，共有 {} 个问题，请查看 {}'
 
+TYPE_ERROR_ENUM_GLOBAL_DISMATCH =
+'类型 `{child}` 无法匹配 `{parent}` 的枚举类型'
+TYPE_ERROR_ENUM_GENERIC_UNSUPPORTED =
+'无法在枚举中使用泛型 `{child}`'
+TYPE_ERROR_ENUM_LITERAL_DISMATCH =
+'字面量 `{child}` 无法匹配 `{parent}` 的枚举值'
+TYPE_ERROR_ENUM_OBJECT_DISMATCH =
+'对象 `{child}` 无法匹配 `{parent}` 的枚举值，它们必须是同一个对象'
+TYPE_ERROR_ENUM_NO_OBJECT =
+'无法识别传入的枚举值 `{child}`'
+TYPE_ERROR_INTEGER_DISMATCH =
+'字面量 `{child}` 无法匹配整数 `{parent}`'
+TYPE_ERROR_STRING_DISMATCH =
+'字面量 `{child}` 无法匹配字符串 `{parent}`'
+TYPE_ERROR_BOOLEAN_DISMATCH =
+'字面量 `{child}` 无法匹配布尔值 `{parent}`'
+TYPE_ERROR_TABLE_NO_FIELD =
+'表中不存在字段 `{key}`'
+TYPE_ERROR_TABLE_FIELD_DISMATCH =
+'字段 `{key}` 的类型为 `{child}`，无法匹配 `{parent}`'
+TYPE_ERROR_UNION_ALL_DISMATCH =
+'`{child}` 中的所有子类型均无法匹配 `{parent}`'
+TYPE_ERROR_UNION_DISMATCH =
+'联合类型中的 `{child}` 无法匹配 `{parent}`'
+TYPE_ERROR_OPTIONAL_DISMATCH =
+'可选类型无法匹配 `{parent}`'
+TYPE_ERROR_NUMBER_LITERAL_TO_INTEGER =
+'无法将数字 `{child}` 转换为整数'
+TYPE_ERROR_NUMBER_TYPE_TO_INTEGER =
+'无法将数字类型转换为整数类型'
+TYPE_ERROR_DISMATCH =
+'类型 `{child}` 无法匹配 `{parent}`'
+
+
 LUADOC_DESC_CLASS = -- TODO: need translate!
 [=[
 Defines a class/table structure

script/core/diagnostics/assign-type-mismatch.lua

@@ -96,7 +96,8 @@ return function (uri, callback)
         end
 
         local varNode = vm.compileNode(source)
-        if vm.canCastType(uri, varNode, valueNode) then
+        local suc, errs = vm.canCastType(uri, varNode, valueNode)
+        if suc then
             return
         end
 
@@ -107,12 +108,15 @@ return function (uri, callback)
             end
         end
 
+        assert(errs)
+
         callback {
             start   = source.start,
             finish  = source.finish,
             message = lang.script('DIAG_ASSIGN_TYPE_MISMATCH', {
                 def = vm.getInfer(varNode):view(uri),
                 ref = vm.getInfer(valueNode):view(uri),
+                err = vm.viewTypeErrorMessage(uri, errs),
             }),
         }
     end)

script/core/diagnostics/cast-local-type.lua

@@ -34,13 +34,17 @@ return function (uri, callback)
                     refNode = refNode:copy():setTruthy()
                 end
 
-                if not vm.canCastType(uri, locNode, refNode) then
+                local suc, errs = vm.canCastType(uri, locNode, refNode)
+
+                if not suc then
+                    assert(errs)
                     callback {
                         start   = ref.start,
                         finish  = ref.finish,
                         message = lang.script('DIAG_CAST_LOCAL_TYPE', {
                             def = vm.getInfer(locNode):view(uri),
                             ref = vm.getInfer(refNode):view(uri),
+                            err = vm.viewTypeErrorMessage(uri, errs),
                         }),
                     }
                 end

script/core/diagnostics/cast-type-mismatch.lua

@@ -26,13 +26,16 @@ return function (uri, callback)
                     for _, cast in ipairs(doc.casts) do
                         if not cast.mode and cast.extends then
                             local refNode = vm.compileNode(cast.extends)
-                            if not vm.canCastType(uri, defNode, refNode) then
+                            local suc, errs = vm.canCastType(uri, defNode, refNode)
+                            if not suc then
+                                assert(errs)
                                 callback {
                                     start   = cast.extends.start,
                                     finish  = cast.extends.finish,
                                     message = lang.script('DIAG_CAST_TYPE_MISMATCH', {
                                         def = vm.getInfer(defNode):view(uri),
                                         ref = vm.getInfer(refNode):view(uri),
+                                        err = vm.viewTypeErrorMessage(uri, errs),
                                     })
                                 }
                             end

script/core/diagnostics/param-type-mismatch.lua

@@ -100,14 +100,17 @@ return function (uri, callback)
                 -- 因此将假值移除再进行检查
                 refNode = refNode:copy():setTruthy()
             end
-            if not vm.canCastType(uri, defNode, refNode) then
+            local suc, errs = vm.canCastType(uri, defNode, refNode)
+            if not suc then
                 local rawDefNode = getRawDefNode(funcNode, i)
+                assert(errs)
                 callback {
                     start   = arg.start,
                     finish  = arg.finish,
                     message = lang.script('DIAG_PARAM_TYPE_MISMATCH', {
                         def = vm.getInfer(rawDefNode):view(uri),
                         ref = vm.getInfer(refNode):view(uri),
+                        err = vm.viewTypeErrorMessage(uri, errs),
                     })
                 }
             end

script/vm/infer.lua

@@ -234,6 +234,10 @@ local viewNodeSwitch;viewNodeSwitch = util.switch()
         end
         return ('fun(%s)%s'):format(argView, regView)
     end)
+    : case 'doc.field.name'
+    : call(function (source, infer, uri)
+        return vm.viewKey(source, uri)
+    end)
 
 ---@class vm.node
 ---@field lastInfer? vm.infer