| Portability | non-portable (uses Text.ParserCombinators.ReadP) |
|---|---|
| Stability | provisional |
| Maintainer | libraries@haskell.org |
Text.Read
Description
Converting strings to values.
TheText.Read library is the canonical library to import forRead-class facilities. For GHC only, it offers an extended and much improvedRead class, which constitutes a proposed alternative to the Haskell 98Read. In particular, writing parsers is easier, and the parsers are much more efficient.
Synopsis
Read classParsing ofStrings, producing values.
Minimal complete definition:readsPrec (or, for GHC only,readPrec)
Derived instances ofRead make the following assumptions, which derived instances ofText.Show.Show obey:
Read instance will parse only infix applications of the constructor (not the prefix form).Read will parse only the record-syntax form, and furthermore, the fields must be given in the same order as the original declaration.Read instance allows arbitrary Haskell whitespace between tokens of the input string. Extra parentheses are also allowed.For example, given the declarations
infixr 5 :^: data Tree a = Leaf a | Tree a :^: Tree a
the derived instance ofRead in Haskell 98 is equivalent to
instance (Read a) => Read (Tree a) where readsPrec d r = readParen (d > app_prec) (\r -> [(Leaf m,t) | ("Leaf",s) <- lex r, (m,t) <- readsPrec (app_prec+1) s]) r ++ readParen (d > up_prec) (\r -> [(u:^:v,w) | (u,s) <- readsPrec (up_prec+1) r, (":^:",t) <- lex s, (v,w) <- readsPrec (up_prec+1) t]) r where app_prec = 10 up_prec = 5Note that right-associativity of:^: is unused.
The derived instance in GHC is equivalent to
instance (Read a) => Read (Tree a) where readPrec = parens $ (prec app_prec $ do Ident "Leaf" <- lexP m <- step readPrec return (Leaf m)) +++ (prec up_prec $ do u <- step readPrec Symbol ":^:" <- lexP v <- step readPrec return (u :^: v)) where app_prec = 10 up_prec = 5 readListPrec = readListPrecDefault
Methods
Arguments
| ::Int | the operator precedence of the enclosing context (a number from |
| ->ReadS a |
attempts to parse a value from the front of the string, returning a list of (parsed value, remaining string) pairs. If there is no successful parse, the returned list is empty.
Derived instances ofRead andText.Show.Show satisfy the following:
(x,"") is an element of(readsPrec d (Text.Show.showsPrec d x "")).That is,readsPrec parses the string produced byText.Show.showsPrec, and delivers the value thatText.Show.showsPrec started with.
The methodreadList is provided to allow the programmer to give a specialised way of parsing lists of values. For example, this is used by the predefinedRead instance of theChar type, where values of typeString should be are expected to use double quotes, rather than square brackets.
Proposed replacement forreadsPrec using new-style parsers (GHC only).
readListPrec ::ReadPrec [a]Source
Proposed replacement forreadList using new-style parsers (GHC only). The default definition usesreadList. Instances that definereadPrec should also definereadListPrec asreadListPrecDefault.
Instances
read ::Read a =>String -> aSource
Theread function reads input from a string, which must be completely consumed by the input process.
Thelex function reads a single lexeme from the input, discarding initial white space, and returning the characters that constitute the lexeme. If the input string contains only white space,lex returns a single successful `lexeme' consisting of the empty string. (Thus.) If there is no legal lexeme at the beginning of the input string,lex "" = [("","")]lex fails (i.e. returns[]).
This lexer is not completely faithful to the Haskell lexical syntax in the following respects:
Haskell lexemes.
parens ::ReadPrec a ->ReadPrec aSource
(parens p) parses "P", "(P0)", "((P0))", etc, wherep parses "P" in the current precedence context and parses "P0" in precedence context zero
readListDefault ::Read a =>ReadS [a]Source
A possible replacement definition for thereadList method (GHC only). This is only needed for GHC, and even then only forRead instances wherereadListPrec isn't defined asreadListPrecDefault.
readListPrecDefault ::Read a =>ReadPrec [a]Source
A possible replacement definition for thereadListPrec method, defined usingreadPrec (GHC only).
Produced byHaddock version 2.9.2