Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > efafe5a5d64b2849702c902ce5eec18b > files > 53

ghc-hscolour-devel-1.17-1.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Language.Haskell.HsColour</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Language-Haskell-HsColour.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>hscolour-1.17: Colourise Haskell code.</TD
><TD CLASS="topbut"
><A HREF="src/Language-Haskell-HsColour.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Language.Haskell.HsColour</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>This is a library which colourises Haskell code.
   It currently has six output formats:
</P
><UL
><LI
> ANSI terminal codes
</LI
><LI
> LaTeX macros
</LI
><LI
> HTML 3.2 with font tags
</LI
><LI
> HTML 4.01 with external CSS.
</LI
><LI
> XHTML 1.0 with internal CSS.
</LI
><LI
> mIRC chat client colour codes.
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AOutput"
>Output</A
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ATTY"
>TTY</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ALaTeX"
>LaTeX</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AHTML"
>HTML</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ACSS"
>CSS</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AICSS"
>ICSS</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AMIRC"
>MIRC</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AColourPrefs"
>ColourPrefs</A
>  = <A HREF="#v%3AColourPrefs"
>ColourPrefs</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3Akeyword"
>keyword</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Akeyglyph"
>keyglyph</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Alayout"
>layout</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Acomment"
>comment</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Aconid"
>conid</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Avarid"
>varid</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Aconop"
>conop</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Avarop"
>varop</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Astring"
>string</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Achar"
>char</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Anumber"
>number</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Acpp"
>cpp</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Aselection"
>selection</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Avariantselection"
>variantselection</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3Adefinition"
>definition</A
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Ahscolour"
>hscolour</A
> :: <A HREF="Language-Haskell-HsColour.html#t%3AOutput"
>Output</A
> -&gt; <A HREF="Language-Haskell-HsColour.html#t%3AColourPrefs"
>ColourPrefs</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Output"
><A NAME="t%3AOutput"
></A
></A
><B
>Output</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Language-Haskell-HsColour-Output.html#Output"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>The supported output formats.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:TTY"
><A NAME="v%3ATTY"
></A
></A
><B
>TTY</B
></TD
><TD CLASS="rdoc"
>ANSI terminal codes
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:LaTeX"
><A NAME="v%3ALaTeX"
></A
></A
><B
>LaTeX</B
></TD
><TD CLASS="rdoc"
>TeX macros
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:HTML"
><A NAME="v%3AHTML"
></A
></A
><B
>HTML</B
></TD
><TD CLASS="rdoc"
>HTML with font tags
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:CSS"
><A NAME="v%3ACSS"
></A
></A
><B
>CSS</B
></TD
><TD CLASS="rdoc"
>HTML with CSS.
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:ICSS"
><A NAME="v%3AICSS"
></A
></A
><B
>ICSS</B
></TD
><TD CLASS="rdoc"
>HTML with inline CSS.
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:MIRC"
><A NAME="v%3AMIRC"
></A
></A
><B
>MIRC</B
></TD
><TD CLASS="rdoc"
>mIRC chat clients
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Output')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Output" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Language-Haskell-HsColour.html#t%3AOutput"
>Output</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Language-Haskell-HsColour.html#t%3AOutput"
>Output</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ColourPrefs"
><A NAME="t%3AColourPrefs"
></A
></A
><B
>ColourPrefs</B
>  </TD
><TD CLASS="declbut"
><A HREF="src/Language-Haskell-HsColour-Colourise.html#ColourPrefs"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Colour preferences.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:ColourPrefs"
><A NAME="v%3AColourPrefs"
></A
></A
><B
>ColourPrefs</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:keyword"
><A NAME="v%3Akeyword"
></A
></A
><B
>keyword</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:keyglyph"
><A NAME="v%3Akeyglyph"
></A
></A
><B
>keyglyph</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:layout"
><A NAME="v%3Alayout"
></A
></A
><B
>layout</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:comment"
><A NAME="v%3Acomment"
></A
></A
><B
>comment</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:conid"
><A NAME="v%3Aconid"
></A
></A
><B
>conid</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:varid"
><A NAME="v%3Avarid"
></A
></A
><B
>varid</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:conop"
><A NAME="v%3Aconop"
></A
></A
><B
>conop</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:varop"
><A NAME="v%3Avarop"
></A
></A
><B
>varop</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:string"
><A NAME="v%3Astring"
></A
></A
><B
>string</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:char"
><A NAME="v%3Achar"
></A
></A
><B
>char</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:number"
><A NAME="v%3Anumber"
></A
></A
><B
>number</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:cpp"
><A NAME="v%3Acpp"
></A
></A
><B
>cpp</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:selection"
><A NAME="v%3Aselection"
></A
></A
><B
>selection</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:variantselection"
><A NAME="v%3Avariantselection"
></A
></A
><B
>variantselection</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:definition"
><A NAME="v%3Adefinition"
></A
></A
><B
>definition</B
> :: [<A HREF="Language-Haskell-HsColour-ColourHighlight.html#t%3AHighlight"
>Highlight</A
>]</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ColourPrefs')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ColourPrefs" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Language-Haskell-HsColour.html#t%3AColourPrefs"
>ColourPrefs</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Read.html#t%3ARead"
>Read</A
> <A HREF="Language-Haskell-HsColour.html#t%3AColourPrefs"
>ColourPrefs</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Language-Haskell-HsColour.html#t%3AColourPrefs"
>ColourPrefs</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:hscolour"
><A NAME="v%3Ahscolour"
></A
></A
><B
>hscolour</B
></TD
><TD CLASS="declbut"
><A HREF="src/Language-Haskell-HsColour.html#hscolour"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Language-Haskell-HsColour.html#t%3AOutput"
>Output</A
></TD
><TD CLASS="rdoc"
>Output format.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Language-Haskell-HsColour.html#t%3AColourPrefs"
>ColourPrefs</A
></TD
><TD CLASS="rdoc"
>Colour preferences (for formats that support them).
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="rdoc"
>Whether to include anchors.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="rdoc"
>Whether output document is partial or complete.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Title for output.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Bool.html#t%3ABool"
>Bool</A
></TD
><TD CLASS="rdoc"
>Whether input document is literate haskell or not
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Haskell source code.
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Coloured Haskell source code.
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Colourise Haskell source code with the given output format.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>