Merge pull request #296 from uhziel/diagnostic-undefined-field

添加检查"未定义的 field"Diagnostic undefined field

5 files changed, 117 insertions, 1 deletions

diff --git a/script/core/diagnostics/undefined-field.lua b/script/core/diagnostics/undefined-field.lua
new file mode 100644
index 00000000..d01375dd
--- /dev/null
+++ b/script/core/diagnostics/undefined-field.lua
@@ -0,0 +1,106 @@
+local files   = require 'files'
+local vm      = require 'vm'
+local lang    = require 'language'
+local config  = require 'config'
+local guide   = require 'parser.guide'
+local define  = require 'proto.define'
+
+return function (uri, callback)
+    local ast = files.getAst(uri)
+    if not ast then
+        return
+    end
+
+    local function getAllDocClassFromInfer(src)
+        local infers = vm.getInfers(src, 0)
+
+        if not infers then
+            return nil
+        end
+
+        local mark = {}
+        local function addTo(allDocClass, src)
+            if not mark[src] then
+                allDocClass[#allDocClass+1] = src
+                mark[src] = true
+            end
+        end
+
+        local allDocClass = {}
+        for i = 1, #infers do
+            local infer = infers[i]
+            if infer.type ~= '_G' then
+                local inferSource = infer.source
+                if inferSource.type == 'doc.class' then
+                    addTo(allDocClass, inferSource)
+                elseif inferSource.type == 'doc.class.name' then
+                    addTo(allDocClass, inferSource.parent)
+                elseif inferSource.type == 'doc.type.name' then
+                    local docTypes = vm.getDocTypes(inferSource[1])
+                    for _, docType in ipairs(docTypes) do
+                        if docType.type == 'doc.class.name' then
+                            addTo(allDocClass, docType.parent)
+                        end
+                    end
+                end
+            end
+        end
+
+        return allDocClass
+    end
+
+    ---@param allDocClass table int
+    local function getAllFieldsFromAllDocClass(allDocClass)
+        local fields = {}
+        local empty = true
+        for _, docClass in ipairs(allDocClass) do
+            local refs = vm.getFields(docClass)
+
+            for _, ref in ipairs(refs) do
+                if ref.type == 'getfield' or ref.type == 'getmethod' then
+                    goto CONTINUE
+                end
+                local name = vm.getKeyName(ref)
+                if not name or vm.getKeyType(ref) ~= 'string' then
+                    goto CONTINUE
+                end
+                fields[name] = true
+                empty = false
+                ::CONTINUE::
+            end
+        end
+       
+        if empty then
+            return nil
+        else
+            return fields
+        end
+    end
+
+    local function checkUndefinedField(src)
+        local fieldName = guide.getKeyName(src)
+
+        local allDocClass = getAllDocClassFromInfer(src.node)
+        if (not allDocClass) or (#allDocClass == 0) then
+            return
+        end
+
+        local fields = getAllFieldsFromAllDocClass(allDocClass)
+
+        -- 没找到任何 field，跳过检查
+        if not fields then
+            return
+        end
+
+        if not fields[fieldName] then
+            local message = lang.script('DIAG_UNDEF_FIELD', fieldName)
+            callback {
+                start   = src.start,
+                finish  = src.finish,
+                message = message,
+            }
+        end
+    end
+    guide.eachSourceType(ast.ast, 'getfield', checkUndefinedField);
+    guide.eachSourceType(ast.ast, 'getmethod', checkUndefinedField);
+end
diff --git a/script/core/diagnostics/undefined-global.lua b/script/core/diagnostics/undefined-global.lua
index 2efd75f8..5d647993 100644
--- a/script/core/diagnostics/undefined-global.lua
+++ b/script/core/diagnostics/undefined-global.lua
@@ -30,7 +30,7 @@ return function (uri, callback)
         if config.config.runtime.special[key] then
             return
         end
-        if #vm.getGlobalSets(guide.getKeyName(src)) == 0 then
+        if #vm.getGlobalSets(key) == 0 then
             local message = lang.script('DIAG_UNDEF_GLOBAL', key)
             if requireLike[key:lower()] then
                 message = ('%s(%s)'):format(message, lang.script('DIAG_REQUIRE_LIKE', key))
diff --git a/script/parser/guide.lua b/script/parser/guide.lua
index 90d09f7a..5fcfc0f3 100644
--- a/script/parser/guide.lua
+++ b/script/parser/guide.lua
@@ -1242,6 +1242,10 @@ function m.isDoc(source)
     return source.type:sub(1, 4) == 'doc.'
 end
 
+function m.isDocClass(source)
+    return source.type == 'doc.class'
+end
+
 --- 根据函数的调用参数，获取：调用，参数索引
 function m.getCallAndArgIndex(callarg)
     local callargs = callarg.parent
diff --git a/script/proto/define.lua b/script/proto/define.lua
index 082e382a..6ddcd3a7 100644
--- a/script/proto/define.lua
+++ b/script/proto/define.lua
@@ -140,6 +140,7 @@ m.DiagnosticDefaultSeverity = {
     ['unused-local']            = 'Hint',
     ['unused-function']         = 'Hint',
     ['undefined-global']        = 'Warning',
+    ['undefined-field']         = 'Warning',
     ['global-in-nil-env']       = 'Warning',
     ['unused-label']            = 'Hint',
     ['unused-vararg']           = 'Hint',
diff --git a/script/vm/eachField.lua b/script/vm/eachField.lua
index fabb11c7..19ac77e9 100644
--- a/script/vm/eachField.lua
+++ b/script/vm/eachField.lua
@@ -45,6 +45,11 @@ function vm.getFields(source, deep)
                     or getFieldsBySource(source, deep)
         vm.getCache('eachFieldOfGlobal')[name] = cache
         return cache
+    elseif guide.isDocClass(source) then
+        local cache =  vm.getCache('eachFieldOfDocClass')[source]
+                    or getFieldsBySource(source, deep)
+        vm.getCache('eachFieldOfDocClass')[source] = cache
+        return cache
     else
         return getFieldsBySource(source, deep)
     end