/usr/share/doc/libghc-parsers-doc/html/Text-Parser-Token-Style.html is in libghc-parsers-doc 0.12.3-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Text.Parser.Token.Style</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Text-Parser-Token-Style.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Text-Parser-Token-Style.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">parsers-0.12.3: Parsing combinators</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) Edward Kmett 2011-2012</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Maintainer</th><td>ekmett@gmail.com</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Portability</th><td>non-portable</td></tr><tr><th>Safe Haskell</th><td>Trustworthy</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Text.Parser.Token.Style</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Comment and white space styles</a><ul><li><a href="#g:2">Lenses</a></li><li><a href="#g:3">Common Comment Styles</a></li></ul></li><li><a href="#g:4">Identifier Styles</a></li><li><a href="#g:5">Operator Styles</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A toolbox for specifying comment and identifier styles</p><p>This must be imported directly as it is not re-exported elsewhere</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:CommentStyle">CommentStyle</a> = <a href="#v:CommentStyle">CommentStyle</a> {<ul class="subs"><li><a href="#v:_commentStart">_commentStart</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></li><li><a href="#v:_commentEnd">_commentEnd</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></li><li><a href="#v:_commentLine">_commentLine</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></li><li><a href="#v:_commentNesting">_commentNesting</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a></li></ul>}</li><li class="src short"><a href="#v:commentStart">commentStart</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:commentEnd">commentEnd</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:commentLine">commentLine</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:commentNesting">commentNesting</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:emptyCommentStyle">emptyCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:javaCommentStyle">javaCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:scalaCommentStyle">scalaCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:haskellCommentStyle">haskellCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></li><li class="src short"><a href="#v:buildSomeSpaceParser">buildSomeSpaceParser</a> :: <a href="Text-Parser-Char.html#t:CharParsing">CharParsing</a> m => m () -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> m ()</li><li class="src short"><a href="#v:emptyIdents">emptyIdents</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m</li><li class="src short"><a href="#v:haskellIdents">haskellIdents</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m</li><li class="src short"><a href="#v:haskell98Idents">haskell98Idents</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m</li><li class="src short"><a href="#v:emptyOps">emptyOps</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m</li><li class="src short"><a href="#v:haskellOps">haskellOps</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m</li><li class="src short"><a href="#v:haskell98Ops">haskell98Ops</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m</li></ul></div><div id="interface"><h1 id="g:1">Comment and white space styles</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CommentStyle" class="def">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#CommentStyle" class="link">Source</a></p><div class="doc"><p>How to deal with comments.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CommentStyle" class="def">CommentStyle</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:_commentStart" class="def">_commentStart</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>String that starts a multiline comment</p></dd><dt class="src"><a name="v:_commentEnd" class="def">_commentEnd</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>String that ends a multiline comment</p></dd><dt class="src"><a name="v:_commentLine" class="def">_commentLine</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>String that starts a single line comment</p></dd><dt class="src"><a name="v:_commentNesting" class="def">_commentNesting</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a></dt><dd class="doc"><p>Can we nest multiline comments?</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:CommentStyle" class="caption collapser" onclick="toggleSection('i:CommentStyle')">Instances</p><div id="section.i:CommentStyle" class="show"><table><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Eq.html#t:Eq">Eq</a> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></span> <a href="src/Text-Parser-Token-Style.html#line-61" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Data.html#t:Data">Data</a> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></span> <a href="src/Text-Parser-Token-Style.html#line-61" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Ord.html#t:Ord">Ord</a> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></span> <a href="src/Text-Parser-Token-Style.html#line-61" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Read.html#t:Read">Read</a> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></span> <a href="src/Text-Parser-Token-Style.html#line-61" class="link">Source</a></td><td class="doc empty"> </td></tr><tr><td class="src clearfix"><span class="inst-left"><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Text-Show.html#t:Show">Show</a> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></span> <a href="src/Text-Parser-Token-Style.html#line-61" class="link">Source</a></td><td class="doc empty"> </td></tr></table></div></div></div><h2 id="g:2">Lenses</h2><div class="top"><p class="src"><a name="v:commentStart" class="def">commentStart</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#commentStart" class="link">Source</a></p><div class="doc"><p>This is a lens that can edit the string that starts a multiline comment.</p><pre><code><a href="Text-Parser-Token-Style.html#v:commentStart">commentStart</a></code> :: Lens' <code><a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></code> <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></code></pre></div></div><div class="top"><p class="src"><a name="v:commentEnd" class="def">commentEnd</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#commentEnd" class="link">Source</a></p><div class="doc"><p>This is a lens that can edit the string that ends a multiline comment.</p><pre><code><a href="Text-Parser-Token-Style.html#v:commentEnd">commentEnd</a></code> :: Lens' <code><a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></code> <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></code></pre></div></div><div class="top"><p class="src"><a name="v:commentLine" class="def">commentLine</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#commentLine" class="link">Source</a></p><div class="doc"><p>This is a lens that can edit the string that starts a single line comment.</p><pre><code><a href="Text-Parser-Token-Style.html#v:commentLine">commentLine</a></code> :: Lens' <code><a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></code> <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-String.html#t:String">String</a></code></pre></div></div><div class="top"><p class="src"><a name="v:commentNesting" class="def">commentNesting</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Functor.html#t:Functor">Functor</a> f => (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a> -> f <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a>) -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> f <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#commentNesting" class="link">Source</a></p><div class="doc"><p>This is a lens that can edit whether we can nest multiline comments.</p><pre><code><a href="Text-Parser-Token-Style.html#v:commentNesting">commentNesting</a></code> :: Lens' <code><a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a></code> <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Bool.html#t:Bool">Bool</a></code></pre></div></div><h2 id="g:3">Common Comment Styles</h2><div class="top"><p class="src"><a name="v:emptyCommentStyle" class="def">emptyCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#emptyCommentStyle" class="link">Source</a></p><div class="doc"><p>No comments at all</p></div></div><div class="top"><p class="src"><a name="v:javaCommentStyle" class="def">javaCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#javaCommentStyle" class="link">Source</a></p><div class="doc"><p>Use java-style comments</p></div></div><div class="top"><p class="src"><a name="v:scalaCommentStyle" class="def">scalaCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#scalaCommentStyle" class="link">Source</a></p><div class="doc"><p>Use scala-style comments</p></div></div><div class="top"><p class="src"><a name="v:haskellCommentStyle" class="def">haskellCommentStyle</a> :: <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> <a href="src/Text-Parser-Token-Style.html#haskellCommentStyle" class="link">Source</a></p><div class="doc"><p>Use haskell-style comments</p></div></div><div class="top"><p class="src"><a name="v:buildSomeSpaceParser" class="def">buildSomeSpaceParser</a> :: <a href="Text-Parser-Char.html#t:CharParsing">CharParsing</a> m => m () -> <a href="Text-Parser-Token-Style.html#t:CommentStyle">CommentStyle</a> -> m () <a href="src/Text-Parser-Token-Style.html#buildSomeSpaceParser" class="link">Source</a></p><div class="doc"><p>Use this to easily build the definition of whiteSpace for your MonadParser
given a comment style and an underlying someWhiteSpace parser</p></div></div><h1 id="g:4">Identifier Styles</h1><div class="top"><p class="src"><a name="v:emptyIdents" class="def">emptyIdents</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m <a href="src/Text-Parser-Token-Style.html#emptyIdents" class="link">Source</a></p><div class="doc"><p>A simple identifier style based on haskell with no reserve words</p></div></div><div class="top"><p class="src"><a name="v:haskellIdents" class="def">haskellIdents</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m <a href="src/Text-Parser-Token-Style.html#haskellIdents" class="link">Source</a></p><div class="doc"><p>A simple identifier style based on haskell with the reserved words from Haskell 98 and some common extensions.</p></div></div><div class="top"><p class="src"><a name="v:haskell98Idents" class="def">haskell98Idents</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m <a href="src/Text-Parser-Token-Style.html#haskell98Idents" class="link">Source</a></p><div class="doc"><p>A simple identifier style based on haskell with only the reserved words from Haskell 98.</p></div></div><h1 id="g:5">Operator Styles</h1><div class="top"><p class="src"><a name="v:emptyOps" class="def">emptyOps</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m <a href="src/Text-Parser-Token-Style.html#emptyOps" class="link">Source</a></p><div class="doc"><p>A simple operator style based on haskell with no reserved operators</p></div></div><div class="top"><p class="src"><a name="v:haskellOps" class="def">haskellOps</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m <a href="src/Text-Parser-Token-Style.html#haskellOps" class="link">Source</a></p><div class="doc"><p>A simple operator style based on haskell with the operators from Haskell 98.</p></div></div><div class="top"><p class="src"><a name="v:haskell98Ops" class="def">haskell98Ops</a> :: <a href="Text-Parser-Token.html#t:TokenParsing">TokenParsing</a> m => <a href="Text-Parser-Token.html#t:IdentifierStyle">IdentifierStyle</a> m <a href="src/Text-Parser-Token-Style.html#haskell98Ops" class="link">Source</a></p><div class="doc"><p>A simple operator style based on haskell with the operators from Haskell 98.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>
|