README.txt

DESCRIPTION

  lua_parser_loose

  Does loose parsing of Lua code.
  If the code has syntax errors, the parse does not abort; rather,
  some information (e.g. local and global variable scopes) is still inferred.
  This may be useful for code interactively typed into a text editor.
  
  Characteristics of this code:
  - Parsing does not construct any AST but rather streams tokens.
    It should be memory efficient on large files.
    It is also pretty fast.
  - Very loose parsing.
    Does not abort on broken code.
    Scopes of local variables are still resolved even if the code is
    not syntactically valid.
  - Above characteristics make it suitable for use in a text editor,
    where code may be interactively typed.
  - Loose parsing makes this code somewhat hard to validate its correctness,
    but tests are performed to verify robustness.
  - The parsing code is designed so that parts of it may be reused for other
    purposes in other projects.

  Language notes:
  
  - The deprecated Lua 5.0 "arg" variable representing variable
    arguments (...) in a function is not specially recognized.
  - Some Lua 5.2 syntax features are not yet implemented.

STABILITY

  This is fairly well tested, but the code is new and might still have errors.
  Standard tests are performed in "test/test.lua".
  More extensive tests are in "test/test_luac.lua", which validates the
  parser's local/global variable detection against the luac bytecode
  output listings.  test_luac.lua has been performed against the entire
  LuaDist source code repository (about 2700 .lua files), or at least the
  Lua files in it having no syntax errors.

EXAMPLES

  This includes as an example of expanding Lua 5.2
  code to Lua 5.1 code with explicit _ENV variables.  Example:
 
    "function f(_ENV, x) print(x, y)" -->
    "function _ENV.f(_ENV, x) _ENV.print(x, _ENV.y) end"
    
  See example/env.lua and example/lib/compat_envvar.lua.
  Also see https://github.com/davidm/lua-compat-env .

DEPENDENCIES/INSTALLATION

  Copy lua_parser_loose.lua and lua_lexer_loose.lua into your Lua path.
  To test, just run "lua test.lua" in the "test" folder.
  
  There are no dependencies.

COPYRIGHT

  See COPYRIGHT.
  (c) 2013 David Manura.  MIT License (same as Lua 5.1).  2013-04