Moduleparsers-0.12.12Haskell2010

Text.Parser.Token.Style

A toolbox for specifying comment and identifier styles

This must be imported directly as it is not re-exported elsewhere

1 type
15 values

Packageparsers-0.12.12
Exports16
LanguageHaskell2010
LicenceBSD-3-Clause
SourceStyle.hs

Comment and white space styles

1 declaration

datadata CommentStyle

How to deal with comments.

Constructors

CommentStyle
- _commentStart :: String
  String that starts a multiline comment
- _commentEnd :: String
  String that ends a multiline comment
- _commentLine :: String
  String that starts a single line comment
- _commentNesting :: Bool
  Can we nest multiline comments?

Instances5Eq, Data, Ord, Read, Show

Eq CommentStyleDefined in parsers-0.12.12 · Text.Parser.Token.Style
Data CommentStyleDefined in parsers-0.12.12 · Text.Parser.Token.Style
Ord CommentStyleDefined in parsers-0.12.12 · Text.Parser.Token.Style
Read CommentStyleDefined in parsers-0.12.12 · Text.Parser.Token.Style
Show CommentStyleDefined in parsers-0.12.12 · Text.Parser.Token.Style

Lenses

valuecommentStart

:: Functor f
=> String -> f String
-> CommentStyle
-> f CommentStyle

This is a lens that can edit the string that starts a multiline comment.

commentStart :: Lens' CommentStyle String

valuecommentEnd

:: Functor f
=> String -> f String
-> CommentStyle
-> f CommentStyle

This is a lens that can edit the string that ends a multiline comment.

commentEnd :: Lens' CommentStyle String

valuecommentLine

:: Functor f
=> String -> f String
-> CommentStyle
-> f CommentStyle

This is a lens that can edit the string that starts a single line comment.

commentLine :: Lens' CommentStyle String

valuecommentNesting

:: Functor f
=> Bool -> f Bool
-> CommentStyle
-> f CommentStyle

This is a lens that can edit whether we can nest multiline comments.

commentNesting :: Lens' CommentStyle Bool

Common Comment Styles

valueemptyCommentStyle :: CommentStyle

No comments at all

valuejavaCommentStyle :: CommentStyle

Use java-style comments

valuescalaCommentStyle :: CommentStyle

Use scala-style comments

valuehaskellCommentStyle :: CommentStyle

Use haskell-style comments

valuebuildSomeSpaceParser :: CharParsing m => m () -> CommentStyle -> m ()

Use this to easily build the definition of whiteSpace for your MonadParser given a comment style and an underlying someWhiteSpace parser

Identifier Styles

3 declarations

valueemptyIdents :: TokenParsing m => IdentifierStyle m

A simple identifier style based on haskell with no reserve words

valuehaskellIdents :: TokenParsing m => IdentifierStyle m

A simple identifier style based on haskell with the reserved words from Haskell 98 and some common extensions.

valuehaskell98Idents :: TokenParsing m => IdentifierStyle m

A simple identifier style based on haskell with only the reserved words from Haskell 98.

Operator Styles

3 declarations

valueemptyOps :: TokenParsing m => IdentifierStyle m

A simple operator style based on haskell with no reserved operators

valuehaskellOps :: TokenParsing m => IdentifierStyle m

A simple operator style based on haskell with the operators from Haskell 98.

valuehaskell98Ops :: TokenParsing m => IdentifierStyle m

A simple operator style based on haskell with the operators from Haskell 98.