| Portability | non-portable |
|---|---|
| Stability | provisional |
| Maintainer | ekmett@gmail.com |
| Safe Haskell | Trustworthy |
Text.Parser.Token.Style
Contents
Description
A toolbox for specifying comment and identifier styles
This must be imported directly as it is not re-exported elsewhere
- data CommentStyle = CommentStyle {}
- commentStart :: Functor f => (String -> f String) -> CommentStyle -> f CommentStyle
- commentEnd :: Functor f => (String -> f String) -> CommentStyle -> f CommentStyle
- commentLine :: Functor f => (String -> f String) -> CommentStyle -> f CommentStyle
- commentNesting :: Functor f => (Bool -> f Bool) -> CommentStyle -> f CommentStyle
- emptyCommentStyle :: CommentStyle
- javaCommentStyle :: CommentStyle
- scalaCommentStyle :: CommentStyle
- haskellCommentStyle :: CommentStyle
- buildSomeSpaceParser :: CharParsing m => m () -> CommentStyle -> m ()
- emptyIdents :: TokenParsing m => IdentifierStyle m
- haskellIdents :: TokenParsing m => IdentifierStyle m
- haskell98Idents :: TokenParsing m => IdentifierStyle m
- emptyOps :: TokenParsing m => IdentifierStyle m
- haskellOps :: TokenParsing m => IdentifierStyle m
- haskell98Ops :: TokenParsing m => IdentifierStyle m
Comment and white space styles
data CommentStyle Source
How to deal with comments.
Constructors
| CommentStyle | |
Fields
| |
Lenses
commentStart :: Functor f => (String -> f String) -> CommentStyle -> f CommentStyleSource
This is a lens that can edit the string that starts a multiline comment.
commentStart:: Lens'CommentStyleString
commentEnd :: Functor f => (String -> f String) -> CommentStyle -> f CommentStyleSource
This is a lens that can edit the string that ends a multiline comment.
commentEnd:: Lens'CommentStyleString
commentLine :: Functor f => (String -> f String) -> CommentStyle -> f CommentStyleSource
This is a lens that can edit the string that starts a single line comment.
commentLine:: Lens'CommentStyleString
commentNesting :: Functor f => (Bool -> f Bool) -> CommentStyle -> f CommentStyleSource
This is a lens that can edit whether we can nest multiline comments.
commentNesting:: Lens'CommentStyleBool
Common Comment Styles
emptyCommentStyle :: CommentStyleSource
No comments at all
javaCommentStyle :: CommentStyleSource
Use java-style comments
scalaCommentStyle :: CommentStyleSource
Use scala-style comments
haskellCommentStyle :: CommentStyleSource
Use haskell-style comments
buildSomeSpaceParser :: CharParsing m => m () -> CommentStyle -> m ()Source
Use this to easily build the definition of whiteSpace for your MonadParser given a comment style and an underlying someWhiteSpace parser
Identifier Styles
emptyIdents :: TokenParsing m => IdentifierStyle mSource
A simple identifier style based on haskell with no reserve words
haskellIdents :: TokenParsing m => IdentifierStyle mSource
A simple identifier style based on haskell with the reserved words from Haskell 98 and some common extensions.
haskell98Idents :: TokenParsing m => IdentifierStyle mSource
A simple identifier style based on haskell with only the reserved words from Haskell 98.
Operator Styles
emptyOps :: TokenParsing m => IdentifierStyle mSource
A simple operator style based on haskell with no reserved operators
haskellOps :: TokenParsing m => IdentifierStyle mSource
A simple operator style based on haskell with the operators from Haskell 98.
haskell98Ops :: TokenParsing m => IdentifierStyle mSource
A simple operator style based on haskell with the operators from Haskell 98.