doc.enum

sumneko · sumneko · commit 04c671114d1d · 2022-07-16T23:47:40.000+08:00
diff --git a/script/core/completion/completion.lua b/script/core/completion/completion.lua
@@ -1648,6 +1648,7 @@ local function tryluaDocBySource(state, position, source, results)
         for _, doc in ipairs(vm.getDocSets(state.uri)) do
             local name = (doc.type == 'doc.class' and doc.class[1])
                     or   (doc.type == 'doc.alias' and doc.alias[1])
+                    or   (doc.type == 'doc.enum'  and doc.enum[1])
             if  name
             and not used[name]
             and matchKey(source[1], name) then
@@ -1803,6 +1804,14 @@ local function tryluaDocByErr(state, position, err, docState, results)
                     kind        = define.CompletionItemKind.Class,
                 }
             end
+            if  doc.type == 'doc.enum'
+            and not used[doc.enum[1]] then
+                used[doc.enum[1]] = true
+                results[#results+1] = {
+                    label       = doc.enum[1],
+                    kind        = define.CompletionItemKind.Enum,
+                }
+            end
         end
     elseif err.type == 'LUADOC_MISS_PARAM_NAME' then
         local funcs = {}
diff --git a/script/core/definition.lua b/script/core/definition.lua
@@ -55,6 +55,7 @@ local accept = {
     ['doc.see.name']     = true,
     ['doc.see.field']    = true,
     ['doc.cast.name']    = true,
+    ['doc.enum.name']    = true,
 }
 
 local function checkRequire(source, offset)
@@ -170,8 +171,12 @@ return function (uri, offset)
         if src.type == 'doc.alias' then
             src = src.alias
         end
+        if src.type == 'doc.enum' then
+            src = src.enum
+        end
         if src.type == 'doc.class.name'
-        or src.type == 'doc.alias.name' then
+        or src.type == 'doc.alias.name'
+        or src.type == 'doc.enum.name' then
             if  source.type ~= 'doc.type.name'
             and source.type ~= 'doc.extends.name'
             and source.type ~= 'doc.see.name' then
diff --git a/script/core/diagnostics/duplicate-doc-alias.lua b/script/core/diagnostics/duplicate-doc-alias.lua
@@ -17,7 +17,8 @@ return function (uri, callback)
 
     local cache = {}
     for _, doc in ipairs(state.ast.docs) do
-        if doc.type == 'doc.alias' then
+        if doc.type == 'doc.alias'
+        or doc.type == 'doc.enum' then
             local name = guide.getKeyName(doc)
             if not name then
                 return
@@ -28,7 +29,8 @@ return function (uri, callback)
                 cache[name] = {}
                 for _, otherDoc in ipairs(docs) do
                     if otherDoc.type == 'doc.alias'
-                    or otherDoc.type == 'doc.class' then
+                    or otherDoc.type == 'doc.class'
+                    or otherDoc.type == 'doc.enum' then
                         cache[name][#cache[name]+1] = {
                             start  = otherDoc.start,
                             finish = otherDoc.finish,
diff --git a/script/core/folding.lua b/script/core/folding.lua
@@ -152,7 +152,7 @@ local care = {
             hideLastLine = true,
         }
         results[#results+1] = folding
-    end
+    end,
 }
 
 ---@async
diff --git a/script/core/hover/description.lua b/script/core/hover/description.lua
@@ -164,7 +164,8 @@ end
 local function tryDocClassComment(source)
     for _, def in ipairs(vm.getDefs(source)) do
         if def.type == 'doc.class'
-        or def.type == 'doc.alias' then
+        or def.type == 'doc.alias'
+        or def.type == 'doc.enum' then
             local comment = getBindComment(def)
             if comment then
                 return comment
@@ -361,6 +362,10 @@ local function tryDocComment(source)
         local enums = buildEnumChunk(source, source.alias[1], guide.getUri(source))
         md:add('lua', enums)
     end
+    if source.type == 'doc.enum' then
+        local enums = buildEnumChunk(source, source.enum[1], guide.getUri(source))
+        md:add('lua', enums)
+    end
     local result = md:string()
     if result == '' then
         return nil
diff --git a/script/core/hover/label.lua b/script/core/hover/label.lua
@@ -35,6 +35,9 @@ local function asDocTypeName(source)
         if doc.type == 'doc.alias' then
             return '(alias) ' .. doc.alias[1] .. ' ' .. lang.script('HOVER_EXTENDS', vm.getInfer(doc.extends):view(guide.getUri(source)))
         end
+        if doc.type == 'doc.enum' then
+            return '(enum) ' .. doc.enum[1] .. ' ' .. lang.script('HOVER_EXTENDS', vm.getInfer(doc.extends):view(guide.getUri(source)))
+        end
     end
 end
 
diff --git a/script/core/reference.lua b/script/core/reference.lua
@@ -50,6 +50,7 @@ local accept = {
     ['doc.class.name']   = true,
     ['doc.extends.name'] = true,
     ['doc.alias.name']   = true,
+    ['doc.enum.name']    = true,
 }
 
 ---@async
@@ -102,12 +103,17 @@ return function (uri, position)
         if src.type == 'doc.alias' then
             src = src.alias
         end
+        if src.type == 'doc.enum' then
+            src = src.enum
+        end
         if src.type == 'doc.class.name'
         or src.type == 'doc.alias.name'
+        or src.type == 'doc.enum.name'
         or src.type == 'doc.type.name'
         or src.type == 'doc.extends.name' then
             if  source.type ~= 'doc.type.name'
             and source.type ~= 'doc.class.name'
+            and source.type ~= 'doc.enum.name'
             and source.type ~= 'doc.extends.name'
             and source.type ~= 'doc.see.name' then
                 goto CONTINUE
diff --git a/script/core/rename.lua b/script/core/rename.lua
@@ -231,6 +231,9 @@ local function ofDocTypeName(source, newname, callback)
         if doc.type == 'doc.alias' then
             callback(doc, doc.alias.start, doc.alias.finish, newname)
         end
+        if doc.type == 'doc.enum' then
+            callback(doc, doc.enum.start, doc.enum.finish, newname)
+        end
     end
     for _, doc in ipairs(global:getGets(uri)) do
         if doc.type == 'doc.type.name' then
@@ -276,7 +279,8 @@ local function rename(source, newname, callback)
         return ofGlobal(source, newname, callback)
     elseif source.type == 'doc.class.name'
     or     source.type == 'doc.type.name'
-    or     source.type == 'doc.alias.name' then
+    or     source.type == 'doc.alias.name'
+    or     source.type == 'doc.enum.name' then
         return ofDocTypeName(source, newname, callback)
     elseif source.type == 'doc.param.name' then
         return ofDocParamName(source, newname, callback)
@@ -310,6 +314,7 @@ local function prepareRename(source)
     or source.type == 'doc.class.name'
     or source.type == 'doc.type.name'
     or source.type == 'doc.alias.name'
+    or source.type == 'doc.enum.name'
     or source.type == 'doc.param.name' then
         return source, source[1]
     elseif source.type == 'string'
@@ -350,6 +355,7 @@ local accept = {
     ['doc.type.name']  = true,
     ['doc.alias.name'] = true,
     ['doc.param.name'] = true,
+    ['doc.enum.name']  = true,
 }
 
 local m = {}
diff --git a/script/core/semantic-tokens.lua b/script/core/semantic-tokens.lua
@@ -449,6 +449,7 @@ local Care = util.switch()
         end
     end)
     : case 'doc.alias.name'
+    : case 'doc.enum.name'
     : call(function (source, options, results)
         if not options.annotation then
             return
diff --git a/script/core/type-definition.lua b/script/core/type-definition.lua
@@ -52,6 +52,7 @@ local accept = {
     ['doc.class.name']   = true,
     ['doc.extends.name'] = true,
     ['doc.alias.name']   = true,
+    ['doc.enum.name']    = true,
     ['doc.see.name']     = true,
     ['doc.see.field']    = true,
 }
@@ -145,6 +146,9 @@ return function (uri, offset)
         if src.type == 'doc.alias' then
             src = src.alias
         end
+        if src.type == 'doc.enum' then
+            src = src.enum
+        end
         if src.type == 'doc.class.name'
         or src.type == 'doc.alias.name'
         or src.type == 'doc.type.function'
diff --git a/script/parser/guide.lua b/script/parser/guide.lua
@@ -45,6 +45,7 @@ local type         = type
 ---@field exp                   parser.object
 ---@field alias                 parser.object
 ---@field class                 parser.object
+---@field enum                  parser.object
 ---@field vararg                parser.object
 ---@field param                 parser.object
 ---@field overload              parser.object
@@ -141,6 +142,7 @@ local childMap = {
     ['doc.class']          = {'class', '#extends', '#signs', 'comment'},
     ['doc.type']           = {'#types', 'name', 'comment'},
     ['doc.alias']          = {'alias', 'extends', 'comment'},
+    ['doc.enum']           = {'enum', 'extends', 'comment'},
     ['doc.param']          = {'param', 'extends', 'comment'},
     ['doc.return']         = {'#returns', 'comment'},
     ['doc.field']          = {'field', 'extends', 'comment'},
@@ -884,9 +886,11 @@ local isSetMap = {
     ['label']             = true,
     ['doc.class']         = true,
     ['doc.alias']         = true,
+    ['doc.enum']          = true,
     ['doc.field']         = true,
     ['doc.class.name']    = true,
     ['doc.alias.name']    = true,
+    ['doc.enum.name']     = true,
     ['doc.field.name']    = true,
     ['doc.type.field']    = true,
     ['doc.type.array']    = true,
@@ -1003,6 +1007,8 @@ function m.getKeyName(obj)
         return obj.class[1]
     elseif tp == 'doc.alias' then
         return obj.alias[1]
+    elseif tp == 'doc.enum' then
+        return obj.enum[1]
     elseif tp == 'doc.field' then
         return obj.field[1]
     elseif tp == 'doc.field.name' then
@@ -1066,6 +1072,8 @@ function m.getKeyType(obj)
         return 'string'
     elseif tp == 'doc.alias' then
         return 'string'
+    elseif tp == 'doc.enum' then
+        return 'string'
     elseif tp == 'doc.field' then
         return type(obj.field[1])
     elseif tp == 'doc.type.field' then
diff --git a/script/parser/luadoc.lua b/script/parser/luadoc.lua
@@ -1427,14 +1427,29 @@ local docSwitch = util.switch()
         end
         local result = {
             type   = 'doc.source',
-            start  = getFinish(),
+            start  = getStart(),
             finish = getFinish(),
             source = uri,
             line   = line,
             char   = char,
         }
         return result
     end)
+    : case 'enum'
+    : call(function ()
+        local name = parseName('doc.enum.name')
+        if not name then
+            return nil
+        end
+        local result = {
+            type   = 'doc.enum',
+            start  = name.start,
+            finish = name.finish,
+            enum   = name,
+        }
+        name.parent = result
+        return result
+    end)
 
 local function convertTokens(doc)
     local tp, text = nextToken()
@@ -1548,7 +1563,8 @@ local function isContinuedDoc(lastDoc, nextDoc)
         return true
     end
     if lastDoc.type == 'doc.type'
-    or lastDoc.type == 'doc.module' then
+    or lastDoc.type == 'doc.module'
+    or lastDoc.type == 'doc.enum' then
         if nextDoc.type ~= 'doc.comment' then
             return false
         end
@@ -1637,6 +1653,7 @@ local function bindDoc(source, binded)
         or doc.type == 'doc.deprecated'
         or doc.type == 'doc.version'
         or doc.type == 'doc.module'
+        or doc.type == 'doc.enum'
         or doc.type == 'doc.source' then
             if source.type == 'function'
             or isParam then
diff --git a/script/vm/compiler.lua b/script/vm/compiler.lua
@@ -32,6 +32,10 @@ local function bindDocs(source)
             vm.setNode(source, vm.compileNode(doc))
             return true
         end
+        if doc.type == 'doc.enum' then
+            vm.setNode(source, vm.compileNode(doc))
+            return true
+        end
         if doc.type == 'doc.param' then
             local node = vm.compileNode(doc)
             if doc.optional then
diff --git a/script/vm/global.lua b/script/vm/global.lua
@@ -319,6 +319,17 @@ local compilerGlobalSwitch = util.switch()
             source.extends._generic = vm.createGeneric(source.extends, source._sign)
         end
     end)
+    : case 'doc.enum'
+    : call(function (source)
+        local uri  = guide.getUri(source)
+        local name = guide.getKeyName(source)
+        if not name then
+            return
+        end
+        local enum = vm.declareGlobal('type', name, uri)
+        enum:addSet(uri, source)
+        source._globalNode = enum
+    end)
     : case 'doc.type.name'
     : call(function (source)
         local uri  = guide.getUri(source)
@@ -508,6 +519,7 @@ local function compileAst(source)
         'doc.alias',
         'doc.type.name',
         'doc.extends.name',
+        'doc.enum',
     }, function (src)
         compileObject(src)
     end)
diff --git a/script/vm/type.lua b/script/vm/type.lua
@@ -168,7 +168,8 @@ function vm.isSubType(uri, child, parent, mark)
                         end
                     end
                 end
-                if set.type == 'doc.alias' then
+                if set.type == 'doc.alias'
+                or set.type == 'doc.enum' then
                     return true
                 end
             end
diff --git a/test/type_inference/init.lua b/test/type_inference/init.lua
@@ -3719,3 +3719,10 @@ TEST '-2|-3|1' [[
 ---@type 1|-2|-3
 local <?n?>
 ]]
+
+TEST 'A' [[
+---@enum A
+local m = {}
+
+print(<?m?>)
+]]

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ local care = {`
`152`	`152`	`hideLastLine = true,`
`153`	`153`	`}`
`154`	`154`	`results[#results+1] = folding`
`155`		`- end`
	`155`	`+ end,`
`156`	`156`	`}`
`157`	`157`
`158`	`158`	`---@async`