Portability	non-portable
Stability	experimental
Maintainer	ekmett@gmail.com
Safe Haskell	Safe-Infered

Text.Parser.Char

Contents

Character parsers
- Internal parsers

Description

Parsers for character streams

Synopsis

Documentation

class Parsing m => CharParsing m whereSource

Methods

satisfy :: (Char -> Bool) -> m Char Source

Parse a single character of the input, with UTF-8 decoding

char :: CharParsing m => Char -> m Char Source

char c parses a single character c. Returns the parsed character (i.e. c).

  semiColon  = char ';'

notChar :: CharParsing m => Char -> m Char Source

notChar c parses any single character other than c. Returns the parsed character.

  semiColon  = char ';'

anyChar :: CharParsing m => m Char Source

This parser succeeds for any character. Returns the parsed character.

string :: CharParsing m => String -> m String Source

string s parses a sequence of characters given by s. Returns the parsed string (i.e. s).

  divOrMod    =   string "div"
              <|> string "mod"

Instances

CharParsing m => CharParsing (IdentityT m)
(CharParsing m, Monoid w) => CharParsing (WriterT w m)
(CharParsing m, Monoid w) => CharParsing (WriterT w m)
CharParsing m => CharParsing (StateT s m)
CharParsing m => CharParsing (StateT s m)
CharParsing m => CharParsing (ReaderT e m)
(CharParsing m, Monoid w) => CharParsing (RWST r w s m)
(CharParsing m, Monoid w) => CharParsing (RWST r w s m)

Character parsers

oneOf :: CharParsing m => [Char] -> m Char Source

oneOf cs succeeds if the current character is in the supplied list of characters cs. Returns the parsed character. See also satisfy.

   vowel  = oneOf "aeiou"

noneOf :: CharParsing m => [Char] -> m Char Source

As the dual of oneOf, noneOf cs succeeds if the current character not in the supplied list of characters cs. Returns the parsed character.

  consonant = noneOf "aeiou"

oneOfSet :: CharParsing m => CharSet -> m Char Source

oneOfSet cs succeeds if the current character is in the supplied set of characters cs. Returns the parsed character. See also satisfy.

   vowel  = oneOf "aeiou"

noneOfSet :: CharParsing m => CharSet -> m Char Source

As the dual of oneOf, noneOf cs succeeds if the current character not in the supplied list of characters cs. Returns the parsed character.

  consonant = noneOf "aeiou"

spaces :: CharParsing m => m ()Source

Skips zero or more white space characters. See also skipMany and whiteSpace.

space :: CharParsing m => m Char Source

Parses a white space character (any character which satisfies isSpace) Returns the parsed character.

newline :: CharParsing m => m Char Source

Parses a newline character ('\n'). Returns a newline character.

tab :: CharParsing m => m Char Source

Parses a tab character ('\t'). Returns a tab character.

upper :: CharParsing m => m Char Source

Parses an upper case letter (a character between 'A' and 'Z'). Returns the parsed character.

lower :: CharParsing m => m Char Source

Parses a lower case character (a character between 'a' and 'z'). Returns the parsed character.

alphaNum :: CharParsing m => m Char Source

Parses a letter or digit (a character between '0' and '9'). Returns the parsed character.

letter :: CharParsing m => m Char Source

Parses a letter (an upper case or lower case character). Returns the parsed character.

digit :: CharParsing m => m Char Source

Parses a digit. Returns the parsed character.

hexDigit :: CharParsing m => m Char Source

Parses a hexadecimal digit (a digit or a letter between 'a' and 'f' or 'A' and 'F'). Returns the parsed character.

octDigit :: CharParsing m => m Char Source

Parses an octal digit (a character between '0' and '7'). Returns the parsed character.

decimal :: CharParsing m => m Integer Source

Parses a positive whole number in the decimal system. Returns the value of the number.

hexadecimal :: CharParsing m => m Integer Source

Parses a positive whole number in the hexadecimal system. The number should be prefixed with "x" or "X". Returns the value of the number.

octal :: CharParsing m => m Integer Source

Parses a positive whole number in the octal system. The number should be prefixed with "o" or "O". Returns the value of the number.

Internal parsers

charLiteral' :: CharParsing m => m Char Source

This parser parses a single literal character. Returns the literal character value. This parsers deals correctly with escape sequences. The literal character is parsed according to the grammar rules defined in the Haskell report (which matches most programming languages quite closely).

This parser does NOT swallow trailing whitespace.

characterChar :: CharParsing m => m Char Source

stringLiteral' :: CharParsing m => m String Source

This parser parses a literal string. Returns the literal string value. This parsers deals correctly with escape sequences and gaps. The literal string is parsed according to the grammar rules defined in the Haskell report (which matches most programming languages quite closely).

This parser does NOT swallow trailing whitespace

natural' :: CharParsing m => m Integer Source

This parser parses a natural number (a positive whole number). Returns the value of the number. The number can be specified in decimal, hexadecimal or octal. The number is parsed according to the grammar rules in the Haskell report.

This parser does NOT swallow trailing whitespace.

integer' :: CharParsing m => m Integer Source

This parser parses an integer (a whole number). This parser is like natural except that it can be prefixed with sign (i.e. '-' or '+'). Returns the value of the number. The number can be specified in decimal, hexadecimal or octal. The number is parsed according to the grammar rules in the Haskell report.

This parser does NOT swallow trailing whitespace.

Also, unlike the integer parser, this parser does not admit spaces between the sign and the number.

double' :: CharParsing m => m Double Source

This parser parses a floating point value. Returns the value of the number. The number is parsed according to the grammar rules defined in the Haskell report.

This parser does NOT swallow trailing whitespace.

naturalOrDouble' :: CharParsing m => m (Either Integer Double)Source

This parser parses either natural or a double. Returns the value of the number. This parsers deals with any overlap in the grammar rules for naturals and floats. The number is parsed according to the grammar rules defined in the Haskell report.

This parser does NOT swallow trailing whitespace.