ParserT monad transformer and Parser type

ParsecT s u m a is a parser with stream type s , user state type u , underlying monad m and return type a . Parsec is strict in the user state. If this is undesirable, simply use a data type like data Box a = Box a and the state type Box YourStateType to add a level of indirection.

The parser token showTok posFromTok testTok accepts a token t with result x when the function testTok t returns Just x . The source position of the t should be returned by posFromTok t and the token can be shown using showTok t .

This combinator is expressed in terms of tokenPrim . It is used to accept user defined token streams. For example, suppose that we have a stream of basic tokens tupled with source positions. We can then define a parser that accepts single tokens as:

 mytoken x
   = token showTok posFromTok testTok
   where
     showTok (pos,t)     = show t
     posFromTok (pos,t)  = pos
     testTok (pos,t)     = if x == t then Just t else Nothing

The most general way to run a parser. runParserT p state filePath input runs parser p on the input list of tokens input , obtained from source filePath with the initial user state st . The filePath is only used in error messages and may be the empty string. Returns a computation in the underlying monad m that return either a ParseError ( Left ) or a value of type a ( Right ).

The most general way to run a parser over the Identity monad. runParser p state filePath input runs parser p on the input list of tokens input , obtained from source filePath with the initial user state st . The filePath is only used in error messages and may be the empty string. Returns either a ParseError ( Left ) or a value of type a ( Right ).

 parseFromFile p fname
   = do{ input <- readFile fname
       ; return (runParser p () fname input)
       }

parse p filePath input runs a parser p over Identity without user state. The filePath is only used in error messages and may be the empty string. Returns either a ParseError ( Left ) or a value of type a ( Right ).

 main    = case (parse numbers "" "11, 2, 43") of
            Left err  -> print err
            Right xs  -> print (sum xs)

 numbers = commaSep integer

The expression parseTest p input applies a parser p against input input and prints the result to stdout. Used for testing parsers.

Returns the current source position. See also SourcePos .

Returns the current input

Returns the current user state.

putState st set the user state to st .

modifyState f applies function f to the user state. Suppose that we want to count identifiers in a source, we could use the user state as:

 expr  = do{ x <- identifier
           ; modifyState (+1)
           ; return (Id x)
           }

This combinator implements choice. The parser p <|> q first applies p . If it succeeds, the value of p is returned. If p fails without consuming any input , parser q is tried. This combinator is defined equal to the mplus member of the MonadPlus class and the ( <|> ) member of Alternative .

The parser is called predictive since q is only tried when parser p didn't consume any input (i.e.. the look ahead is 1). This non-backtracking behaviour allows for both an efficient implementation of the parser combinators and the generation of good error messages.

The parser p <?> msg behaves as parser p , but whenever the parser p fails without consuming any input , it replaces expect error messages with the expect error message msg .

This is normally used at the end of a set alternatives where we want to return an error message in terms of a higher level construct rather than returning all possible characters. For example, if the expr parser from the try example would fail, the error message is: '...: expecting expression'. Without the (<?>) combinator, the message would be like '...: expecting "let" or letter', which is less friendly.

A synonym for <?> , but as a function instead of an operator.

The parser try p behaves like parser p , except that it pretends that it hasn't consumed any input when an error occurs.

This combinator is used whenever arbitrary look ahead is needed. Since it pretends that it hasn't consumed any input when p fails, the ( <|> ) combinator will try its second alternative even when the first parser failed while consuming input.

The try combinator can for example be used to distinguish identifiers and reserved words. Both reserved words and identifiers are a sequence of letters. Whenever we expect a certain reserved word where we can also expect an identifier we have to use the try combinator. Suppose we write:

 expr        = letExpr <|> identifier <?> "expression"

 letExpr     = do{ string "let"; ... }
 identifier  = many1 letter

If the user writes "lexical", the parser fails with: unexpected 'x', expecting 't' in "let" . Indeed, since the ( <|> ) combinator only tries alternatives when the first alternative hasn't consumed input, the identifier parser is never tried (because the prefix "le" of the string "let" parser is already consumed). The right behaviour can be obtained by adding the try combinator:

 expr        = letExpr <|> identifier <?> "expression"

 letExpr     = do{ try (string "let"); ... }
 identifier  = many1 letter

The parser unexpected msg always fails with an unexpected error message msg without consuming any input.

The parsers fail , ( <?> ) and unexpected are the three parsers used to generate error messages. Of these, only ( <?> ) is commonly used. For an example of the use of unexpected , see the definition of notFollowedBy .

choice ps tries to apply the parsers in the list ps in order, until one of them succeeds. Returns the value of the succeeding parser.

many p applies the parser p zero or more times. Returns a list of the returned values of p .

 identifier  = do{ c  <- letter
                 ; cs <- many (alphaNum <|> char '_')
                 ; return (c:cs)
                 }

many1 p applies the parser p one or more times. Returns a list of the returned values of p .

 word  = many1 letter

skipMany p applies the parser p zero or more times, skipping its result.

 spaces  = skipMany space

skipMany1 p applies the parser p one or more times, skipping its result.

count n p parses n occurrences of p . If n is smaller or equal to zero, the parser equals to return [] . Returns a list of n values returned by p .

between open close p parses open , followed by p and close . Returns the value returned by p .

 braces  = between (symbol "{") (symbol "}")

option x p tries to apply parser p . If p fails without consuming input, it returns the value x , otherwise the value returned by p .

 priority  = option 0 (do{ d <- digit
                         ; return (digitToInt d)
                         })

optionMaybe p tries to apply parser p . If p fails without consuming input, it return Nothing , otherwise it returns Just the value returned by p .

optional p tries to apply parser p . It will parse p or nothing. It only fails if p fails after consuming input. It discards the result of p .

sepBy p sep parses zero or more occurrences of p , separated by sep . Returns a list of values returned by p .

 commaSep p  = p `sepBy` (symbol ",")

sepBy1 p sep parses one or more occurrences of p , separated by sep . Returns a list of values returned by p .

endBy p sep parses zero or more occurrences of p , separated and ended by sep . Returns a list of values returned by p .

  cStatements  = cStatement `endBy` semi

endBy1 p sep parses one or more occurrences of p , separated and ended by sep . Returns a list of values returned by p .

sepEndBy p sep parses zero or more occurrences of p , separated and optionally ended by sep , ie. haskell style statements. Returns a list of values returned by p .

 haskellStatements  = haskellStatement `sepEndBy` semi

sepEndBy1 p sep parses one or more occurrences of p , separated and optionally ended by sep . Returns a list of values returned by p .

chainl p op x parses zero or more occurrences of p , separated by op . Returns a value obtained by a left associative application of all functions returned by op to the values returned by p . If there are zero occurrences of p , the value x is returned.

chainl1 p op parses one or more occurrences of p , separated by op Returns a value obtained by a left associative application of all functions returned by op to the values returned by p . This parser can for example be used to eliminate left recursion which typically occurs in expression grammars.

 expr    = term   `chainl1` addop
 term    = factor `chainl1` mulop
 factor  = parens expr <|> integer

 mulop   =   do{ symbol "*"; return (*)   }
         <|> do{ symbol "/"; return (div) }

 addop   =   do{ symbol "+"; return (+) }
         <|> do{ symbol "-"; return (-) }

chainr p op x parses zero or more occurrences of p , separated by op Returns a value obtained by a right associative application of all functions returned by op to the values returned by p . If there are no occurrences of p , the value x is returned.

chainr1 p op x parses one or more occurrences of |p|, separated by op Returns a value obtained by a right associative application of all functions returned by op to the values returned by p .

This parser only succeeds at the end of the input. This is not a primitive parser but it is defined using notFollowedBy .

 eof  = notFollowedBy anyToken <?> "end of input"

notFollowedBy p only succeeds when parser p fails. This parser does not consume any input. This parser can be used to implement the 'longest match' rule. For example, when recognizing keywords (for example let ), we want to make sure that a keyword is not followed by a legal identifier character, in which case the keyword is actually an identifier (for example lets ). We can program this behaviour as follows:

 keywordLet  = try (do{ string "let"
                      ; notFollowedBy alphaNum
                      })

NOTE : Currently, notFollowedBy exhibits surprising behaviour when applied to a parser p that doesn't consume any input; specifically

• notFollowedBy . notFollowedBy is not equivalent to lookAhead , and
• notFollowedBy eof never fails.

See haskell/parsec#8 for more details.

manyTill p end applies parser p zero or more times until parser end succeeds. Returns the list of values returned by p . This parser can be used to scan comments:

 simpleComment   = do{ string "<!--"
                     ; manyTill anyChar (try (string "-->"))
                     }

Note the overlapping parsers anyChar and string "-->" , and therefore the use of the try combinator.

lookAhead p parses p without consuming any input.

If p fails and consumes some input, so does lookAhead . Combine with try if this is undesirable.

The parser anyToken accepts any kind of token. It is for example used to implement eof . Returns the accepted token.

The abstract data type ParseError represents parse errors. It provides the source position ( SourcePos ) of the error and a list of error messages ( Message ). A ParseError can be returned by the function parse . ParseError is an instance of the Show and Eq classes.

Extracts the source position from the parse error

The abstract data type SourcePos represents source positions. It contains the name of the source (i.e. file name), a line number and a column number. SourcePos is an instance of the Show , Eq and Ord class.

Extracts the name of the source from a source position.

Extracts the line number from a source position.

Extracts the column number from a source position.

Increments the line number of a source position.

Increments the column number of a source position.

Set the line number of a source position.

Set the column number of a source position.

Set the name of the source.

parserTrace label is an impure function, implemented with Debug.Trace that prints to the console the remaining parser state at the time it is invoked. It is intended to be used for debugging parsers by inspecting their intermediate states.

*> parseTest (oneOf "aeiou"  >> parserTrace "label") "atest"
label: "test"
...

Since: 3.1.12.0

parserTraced label p is an impure function, implemented with Debug.Trace that prints to the console the remaining parser state at the time it is invoked. It then continues to apply parser p , and if p fails will indicate that the label has been backtracked. It is intended to be used for debugging parsers by inspecting their intermediate states.

*>  parseTest (oneOf "aeiou"  >> parserTraced "label" (oneOf "nope")) "atest"
label: "test"
label backtracked
parse error at (line 1, column 2):
...

Since: 3.1.12.0

The parser tokenPrim showTok nextPos testTok accepts a token t with result x when the function testTok t returns Just x . The token can be shown using showTok t . The position of the next token should be returned when nextPos is called with the current source position pos , the current token t and the rest of the tokens toks , nextPos pos t toks .

This is the most primitive combinator for accepting tokens. For example, the char parser could be implemented as:

 char c
   = tokenPrim showChar nextPos testChar
   where
     showChar x        = "'" ++ x ++ "'"
     testChar x        = if x == c then Just x else Nothing
     nextPos pos x xs  = updatePosChar pos x

Returns the full parser state as a State record.

setParserState st set the full parser state to st .

updateParserState f applies function f to the parser state.

An instance of Stream has stream type s , underlying monad m and token type t determined by the stream

Some rough guidelines for a "correct" instance of Stream:

• unfoldM uncons gives the [t] corresponding to the stream
• A Stream instance is responsible for maintaining the "position within the stream" in the stream state s . This is trivial unless you are using the monad in a non-trivial way.

Low-level unpacking of the ParsecT type. To run your parser, please look to runPT, runP, runParserT, runParser and other such functions.

Low-level creation of the ParsecT type. You really shouldn't have to do this.

setPosition pos sets the current source position to pos .

setInput input continues parsing with input . The getInput and setInput functions can for example be used to deal with #include files.

An alias for putState for backwards compatibility.

An alias for modifyState for backwards compatibility.

parserZero always fails without consuming any input. parserZero is defined equal to the mzero member of the MonadPlus class and to the empty member of the Alternative class.