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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
|
--[[ Copyright (c) 2010 Peter "Corsix" Cawley
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. --]]
local function ParseComments(tokens, i, object)
-- Collect the comments prior to the given token
local comment_parts = {}
local was_short = false
local decl_i = i
while i > 1 do
i = i - 1
local tok = tokens[i]
if tok[2] ~= "comment" then
if tok[2] ~= "whitespace" then
break
end
-- Ignore Unix Shebang and License comments
elseif tok[1]:sub(1, 1) ~= "#" and not tok[1]:find[[THE SOFTWARE IS PROVIDED "AS IS"]] then
local part = tok[1]:sub(3, -1)
local mkr = part:match"^%[(=*)%["
if mkr then
part = part:sub(3 + #mkr, -3 - #mkr)
end
part = part:trim()
if (not mkr) and was_short and comment_parts[1]:sub(1, 1) ~= "!" then
-- Merge multiple short comments into a single comment part
comment_parts[1] = part .. "\n" .. comment_parts[1]
else
table.insert(comment_parts, 1, part)
end
was_short = not mkr
decl_i = i
end
end
-- Set filename and line
object:setFile(tokens.__file, decl_i == 1 and 1 or tokens[decl_i - 1].line)
-- Parse each command
for _, part in ipairs(comment_parts) do
for command in (" "..part):gmatch"([^!]+)" do
local operation = command:match"(%S*)"
local operand = command:sub(1 + #operation, -1):trim()
if operation == "" then
if operand ~= "" then
if object:getShortDesc() then
if object:getLongDesc() then
object:setShortDesc(object:getLongDesc())
end
object:setLongDesc(operand)
else
object:setShortDesc(operand)
end
end
elseif operation == "dummy" then
object:setIsDummy(true)
elseif operation == "param" then
local pname, pdesc = operand:match"^%s*([a-zA-Z_.]%.?%.?[a-zA-Z0-9_]*)%s*(.*)$"
local param = object:getParameter(pname)
if not param then
if pname == nil then pname = "??" end -- Don't crash if first part of RE failed as well.
error("Unknown parameter: ".. pname .." (".. tokens.__file
.." near line ".. tokens[decl_i - 1].line ..")")
end
local options, extra = pdesc:match"^%(([^)]*)%)%w*(.*)$"
if extra then
pdesc = extra
local types = {}
for opt in options:gmatch"([a-zA-Z0-9_]+)" do
types[#types + 1] = opt
end
param.type = types
end
param:setShortDesc(pdesc)
elseif operation == "return" then
-- TODO
elseif operation == "example" then
-- TODO
else
error("Unknown documentation command: " .. operation .." ("..
tokens.__file .." near line ".. tokens[decl_i - 1].line ..")")
end
end
end
end
local function IdentifyClasses(tokens, globals)
for tokens, j, i in tokens_gfind(tokens,
"class", {"string", ".*"}
)do
local name = loadstring("return " .. tokens[i][1])()
local class = LuaClass():setName(name):setParent(globals)
ParseComments(tokens, j, class)
local ib1, b1 = tokens_next(tokens, i)
if b1 and b1[1] == "{" then
local i2, t = tokens_next(tokens, ib1)
if t and t[1] == "}" then
-- TODO: Mark as adopting
ib1, b1 = tokens_next(tokens, i2)
end
end
if b1 and b1[1] == "(" then
local is, s = tokens_next(tokens, ib1)
if s and s[2] == "identifier" then
class:setSuperClass(s[1])
end
end
end
end
local function ResolveSuperclassNames(globals)
for _, var in globals:pairs() do
if class.is(var, LuaClass) and type(var:getSuperClass()) == "string" then
var:setSuperClass(globals:get(var:getSuperClass()))
end
end
end
local function GetFunctionName(tokens, i)
local name_parts, is_method, is_local = {}, false, false
for j = i - 1, 1, -1 do
local token = tokens[j]
if token[2] ~= "whitespace" and token[2] ~= "comment" then
is_local = (token[2] == "keyword" and token[1] == "local")
break
end
end
while true do
i = tokens_next(tokens, i)
local token = tokens[i]
if token[2] == "(" then
break
end
if token[2] == ":" then
is_method = true
elseif token[2] == "identifier" then
name_parts[#name_parts + 1] = token[1]
end
end
return name_parts, is_method
end
local function ScanToEndToken(tokens, i)
local level = 1
while i <= #tokens do
local tok = tokens[i]
if tok[2] == "keyword" then
local k = tok[1]
if k == "end" then
level = level - 1
if level == 0 then
break
end
elseif k == "do" or k == "if" or k == "function" then
level = level + 1
end
end
i = i + 1
end
return i
end
local function IdentifyMethods(tokens, globals)
local i = 1
while i <= #tokens do
if tokens[i][1] == "function" and tokens[i][2] == "keyword" then
local name_parts, is_method, is_local = GetFunctionName(tokens, i)
local method, class, starting_i
if not is_local and (#name_parts == 2 or #name_parts == 1) then
if #name_parts == 1 then
method = LuaFunction():setParent(globals)
else
class = globals:get(name_parts[1])
if not class then
class = LuaTable():setName(name_parts[1]):setParent(globals)
end
method = LuaFunction():setParent(class)
local existing = class:get(name_parts[#name_parts])
if existing and existing:getParent() == class then
class:removeMember(existing)
end
end
method:setName(name_parts[#name_parts]):setIsMethod(is_method)
starting_i = i
end
local endi = ScanToEndToken(tokens, i + 1)
local param_state = method and "before" --> "in" --> "after"
while i < endi do
if param_state == "before" and tokens[i][2] == "(" then
param_state = "in"
elseif param_state == "in" and tokens[i][2] == "identifier" then
method:addParameter(LuaVariable():setName(tokens[i][1]))
elseif param_state == "in" and tokens[i][2] == "vararg" then
method:setIsVararg(true)
elseif param_state == "in" and tokens[i][2] == ")" then
param_state = "after"
end
if is_method and tokens[i][1] == "self" and tokens[i][2] == "identifier" then
i = tokens_next(tokens, i)
if tokens[i][2] == "." or tokens[i][2] == ":" then
i = tokens_next(tokens, i)
if tokens[i][2] == "identifier" then
local field = class:get(tokens[i][1])
if not field or (field.type ~= "function" and field:getParent() ~= class) then
LuaVariable():setName(tokens[i][1]):setParent(class)
end
end
end
end
i = i + 1
end
if starting_i then
ParseComments(tokens, starting_i, method)
end
end
i = i + 1
end
end
local function FixClassTree(class)
local super = class:getSuperClass()
if super then
local to_remove = {}
for key, val in class:pairs() do
if val:getParent() == class and val.type == nil then
local existing = super:get(key)
if existing and existing.type == "function" then
to_remove[val] = true
end
end
end
for val in pairs(to_remove) do
class:removeMember(val)
end
end
for _, class in class:subclassPairs() do
FixClassTree(class)
end
end
local function IdentifyFile(tokens, project)
local dir = project.files
local name_parts = {}
for part in tokens.__file:gmatch"[^/]+" do
name_parts[#name_parts + 1] = part
end
for i = 1, #name_parts - 1 do
local part = name_parts[i]
local next_dir = dir:get(part)
if not next_dir then
next_dir = LuaDirectory():setName(part):setParent(dir)
end
dir = next_dir
end
local part = name_parts[#name_parts]
local file = dir:get(part)
if not file then
file = LuaFile():setName(part):setParent(dir)
end
end
function MakeLuaCodeModel(lua_file_names)
local project = LuaProject()
tokens_gfind_mode "Lua"
local lua_file_tokens = {}
for _, filename in ipairs(lua_file_names) do
local f = assert(io.open(filename))
lua_file_tokens[filename] = TokeniseLua(f:read "*a")
lua_file_tokens[filename].__file = filename:match"^%.%./CorsixTH/(.*)$"
f:close()
IdentifyFile(lua_file_tokens[filename], project)
end
local globals = project.globals
for filename, tokens in pairs(lua_file_tokens) do
IdentifyClasses(tokens, globals)
end
ResolveSuperclassNames(globals)
for filename, tokens in pairs(lua_file_tokens) do
IdentifyMethods(tokens, globals)
end
for _, var in globals:pairs() do
if class.is(var, LuaClass) and not var:getSuperClass() then
FixClassTree(var)
end
end
return project
end
|