GLua.PSParser

Documentation

type AParser = Parsec [MToken] LineColPos

execAParser :: SourceName -> AParser a -> [MToken] -> Either ParseError a

Execute a parser

parseFromString :: AParser a -> String -> Either ParseError a

Parse a string directly

parseGLua :: [MToken] -> Either ParseError AST

Parse Garry's mod Lua tokens to an abstract syntax tree. Also returns parse errors

parseGLuaFromString :: String -> Either ParseError AST

rgStart2sp :: Region -> SourcePos

Region start to SourcePos

rgEnd2sp :: Region -> SourcePos

Region end to SourcePos

sp2Rg :: SourcePos -> Region

SourcePos to region

lcp2sp :: LineColPos -> SourcePos

LineColPos to SourcePos

sp2lcp :: SourcePos -> LineColPos

SourcePos to LineColPos

updatePosMToken :: SourcePos -> MToken -> [MToken] -> SourcePos

Update a SourcePos with an MToken

pMTok :: Token -> AParser MToken

Match a token

pMSatisfy :: (MToken -> Bool) -> AParser MToken

pMToken :: forall a. (MToken -> Maybe a) -> AParser a

pPos :: AParser LineColPos

Get the source position Simply gets the position of the next token Falls back on the collected position when there is no token left

pEndPos :: AParser LineColPos

Get the source position Simply gets the end position of the last parsed token

annotated :: (Region -> a -> b) -> AParser a -> AParser b

A thing of which the region is to be parsed

parseChunk :: [MToken] -> AParser AST

Parses the full AST Its first parameter contains all comments Assumes the mtokens fed to the AParser have no comments

parseBlock :: AParser Block

Parse a block with an optional return value

parseMStat :: AParser MStat

pInterleaved :: AParser a -> AParser b -> AParser [b]

Parser that is interleaved with 0 or more of the other parser

parseReturn :: AParser AReturn

Parse a return value

parseLabel :: AParser MToken

Label

parseStat :: AParser Stat

Parse a single statement

parseDefinition :: AParser Stat

Global definition Note: Uses try to avoid conflicts with function calls

parseLocalDefinition :: AParser Stat

Local definition

parseFunction :: AParser Stat

Global function definition

parseLocalFunction :: AParser Stat

Local function definition

parseIf :: AParser Stat

Parse if then elseif then else end expressions

parseFor :: AParser Stat

parseNFor :: AParser Stat

Parse numeric for loop

parseGFor :: AParser Stat

Generic for loop

parseFuncName :: AParser FuncName

Function name (includes dot indices and meta indices)

parseLocFuncName :: AParser FuncName

Local function name: cannot be a meta function nor indexed

parseNumber :: AParser Expr

Parse a number into an expression

parseString :: AParser MToken

Parse any kind of string

pName :: AParser MToken

Parse an identifier

parseNameList :: AParser [MToken]

Parse a list of identifiers

parseVarList :: AParser [PrefixExp]

Parse variable list (var1, var2, var3)

parseLocalVarList :: AParser [PrefixExp]

Parse local variable list (var1, var2, var3)

parseParList :: AParser [MToken]

Parse list of function parameters

parseExpressionList :: AParser [MExpr]

list of expressions

parseSubExpression :: AParser Expr

Subexpressions, i.e. without operators

parseAnonymFunc :: AParser Expr

Separate parser for anonymous function subexpression

samePrioL :: [(Token, BinOp)] -> AParser MExpr -> AParser MExpr

Parse operators of the same precedence in a chain

samePrioR :: [(Token, BinOp)] -> AParser MExpr -> AParser MExpr

parseUnOp :: AParser UnOp

Parse unary operator (-, not, #)

parseBinOp :: AParser BinOp

Parses a binary operator

lvl1 :: [(Token, BinOp)]

Operators, sorted by priority Priority from: http://www.lua.org/manual/5.2/manual.html#3.4.7

lvl2 :: [(Token, BinOp)]

Operators, sorted by priority Priority from: http://www.lua.org/manual/5.2/manual.html#3.4.7

lvl3 :: [(Token, BinOp)]

Operators, sorted by priority Priority from: http://www.lua.org/manual/5.2/manual.html#3.4.7

lvl4 :: [(Token, BinOp)]

Operators, sorted by priority Priority from: http://www.lua.org/manual/5.2/manual.html#3.4.7

lvl5 :: [(Token, BinOp)]

Operators, sorted by priority Priority from: http://www.lua.org/manual/5.2/manual.html#3.4.7

lvl6 :: [(Token, BinOp)]

Operators, sorted by priority Priority from: http://www.lua.org/manual/5.2/manual.html#3.4.7

lvl8 :: [(Token, BinOp)]

Operators, sorted by priority Priority from: http://www.lua.org/manual/5.2/manual.html#3.4.7

parseExpression :: AParser MExpr

Parse chains of binary and unary operators

parsePrefixExp :: AParser PrefixExp

Prefix expressions can have any arbitrary list of expression suffixes

pPrefixExp :: AParser [PFExprSuffix] -> AParser PrefixExp

Prefix expressions The suffixes define rules on the allowed suffixes

pPFExprSuffix :: AParser PFExprSuffix

Parse any expression suffix

pPFExprCallSuffix :: AParser PFExprSuffix

Parse an indexing expression suffix

pPFExprIndexSuffix :: AParser PFExprSuffix

Parse an indexing expression suffix

pFunctionCall :: AParser PrefixExp

Function calls are prefix expressions, but the last suffix MUST be either a function call or a metafunction call

parseVar :: AParser PrefixExp

single variable. Note: definition differs from reference to circumvent the left recursion var ::= Name [{PFExprSuffix}* indexation] | '(' exp ')' {PFExprSuffix}* indexation where "{PFExprSuffix}* indexation" is any arbitrary sequence of prefix expression suffixes that end with an indexation

parseArgs :: AParser Args

Arguments of a function call (including brackets)

parseTableConstructor :: AParser [Field]

Table constructor

parseFieldList :: AParser [Field]

A list of table entries Grammar: field {separator field} [separator]

parseNamedField :: AParser (FieldSep -> Field)

Parse a named field (e.g. {named = field}) Contains try to avoid conflict with unnamed fields

parseField :: AParser (FieldSep -> Field)

A field in a table

parseFieldSep :: AParser FieldSep

Field separator, either comma or semicolon

parseOptionalFieldSep :: AParser FieldSep

Optional field separator, returns NoSep when no separator is found Used at the end of a field list