summaryrefslogtreecommitdiff
path: root/server/src/matcher/diagnostics.lua
blob: 814beaa2456927c898f548518c63151823847a97 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
local findLib = require 'matcher.find_lib'

local function searchUnusedLocals(results, callback)
    for _, var in ipairs(results.vars) do
        if var.type ~= 'local' then
            goto NEXT_VAR
        end
        if var.key == 'self'
        or var.key == '_'
        or var.key == '_ENV'
        then
            goto NEXT_VAR
        end
        for _, info in ipairs(var) do
            if info.type == 'get' then
                goto NEXT_VAR
            end
        end
        callback(var.source.start, var.source.finish, var.key)
        ::NEXT_VAR::
    end
end

local function searchUndefinedGlobal(results, callback)
    for _, var in ipairs(results.vars) do
        if var.type ~= 'field' then
            goto NEXT_VAR
        end
        if  var.parent.key ~= '_ENV'
        and var.parent.key ~= '_G'
        then
            goto NEXT_VAR
        end
        if var.key:lower() == 'log' then
            goto NEXT_VAR
        end
        if not var.key:find '%l' then
            goto NEXT_VAR
        end
        local lib = findLib(var)
        if lib then
            goto NEXT_VAR
        end
        for _, info in ipairs(var) do
            if info.type == 'set' then
                goto NEXT_VAR
            end
        end
        for _, info in ipairs(var) do
            if info.type == 'get' then
                callback(info.source.start, info.source.finish, var.key)
            end
        end
        ::NEXT_VAR::
    end
end

local function searchUnusedLabel(results, callback)
    for _, label in ipairs(results.labels) do
        for _, info in ipairs(label) do
            if info.type == 'goto' then
                goto NEXT_LABEL
            end
        end
        for _, info in ipairs(label) do
            if info.type == 'set' then
                callback(info.source.start, info.source.finish, label.key)
            end
        end
        ::NEXT_LABEL::
    end
end

local function serachSpaces(lines, callback)
    for i = 1, #lines do
        local line = lines:line(i)

        if line:find '^[ \t]+$' then
            local start, finish = lines:range(i)
            callback(start, finish, 'Line with spaces only') -- LOCALE
            goto NEXT_LINE
        end

        local pos = line:find '[ \t]+$'
        if pos then
            local start, finish = lines:range(i)
            callback(start + pos - 1, finish, 'Line with postspace') -- LOCALE
            goto NEXT_LINE
        end
        ::NEXT_LINE::
    end
end

local function searchRedefinition(results, uri, callback)
    for _, var in ipairs(results.vars) do
        if var.type ~= 'local' then
            goto NEXT_VAR
        end
        if var.key == '_'
        or var.key == '_ENV'
        then
            goto NEXT_VAR
        end
        local shadow = var.shadow
        if not shadow then
            goto NEXT_VAR
        end
        -- 如果多次重定义,则不再警告
        if #shadow >= 3 then
            goto NEXT_VAR
        end
        local related = {}
        for i = 1, #shadow do
            related[i] = {
                start  = shadow[i].source.start,
                finish = shadow[i].source.finish,
                uri    = uri,
            }
        end
        callback(var.source.start, var.source.finish, var.key, related)
        ::NEXT_VAR::
    end
end

local function searchNewLineCall(results, lines, callback)
    for _, call in ipairs(results.calls) do
        if not call.lastobj.start then
            goto NEXT_CALL
        end
        local callline = lines:rowcol(call.call.start)
        local lastline = lines:rowcol(call.lastobj.start)
        if callline > lastline then
            callback(call.call.start, call.call.finish)
        end
        ::NEXT_CALL::
    end
end

return function (vm, lines, uri)
    local datas = {}
    local results = vm.results
    -- 未使用的局部变量
    searchUnusedLocals(results, function (start, finish, key)
        datas[#datas+1] = {
            start   = start,
            finish  = finish,
            level   = 'Information',
            message = ('Unused local `%s`'):format(key), -- LOCALE
        }
    end)
    -- 读取未定义全局变量
    searchUndefinedGlobal(results, function (start, finish, key)
        datas[#datas+1] = {
            start   = start,
            finish  = finish,
            level   = 'Warning',
            message = ('Undefined global `%s`'):format(key), -- LOCALE
        }
    end)
    -- 未使用的Label
    searchUnusedLabel(results, function (start, finish, key)
        datas[#datas+1] = {
            start   = start,
            finish  = finish,
            level   = 'Information',
            message = ('Unused label `%s`'):format(key), -- LOCALE
        }
    end)
    -- 只有空格与制表符的行,以及后置空格
    serachSpaces(lines, function (start, finish, message)
        datas[#datas+1] = {
            start   = start,
            finish  = finish,
            level   = 'Information',
            message = message,
        }
    end)
    -- 重定义局部变量
    searchRedefinition(results, uri, function (start, finish, key, related)
        datas[#datas+1] = {
            start   = start,
            finish  = finish,
            level   = 'Information',
            message = ('Redefined local `%s`'):format(key), -- LOCALE
            related = related,
        }
    end)
    -- 以括号开始的一行(可能被误解析为了上一行的call)
    searchNewLineCall(results, lines, function (start, finish)
        datas[#datas+1] = {
            start   = start,
            finish  = finish,
            level   = 'Warning',
            message = 'Parsed as function call for the previous line. It may be necessary to add a `;` before.', -- LOCALE
        }
    end)
    return datas
end