<!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>Language.Haskell.HsColour.ANSI</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_Language-Haskell-HsColour-ANSI.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Language-Haskell-HsColour-ANSI.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">hscolour-1.17: Colourise Haskell code.</p></div><div id="content"><div id="module-header"><p class="caption">Language.Haskell.HsColour.ANSI</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Partially taken from Hugs AnsiScreen.hs library:
</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"><a href="#v:highlightOn">highlightOn</a> :: [<a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a>] -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:highlightOff">highlightOff</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:highlight">highlight</a> :: [<a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:cleareol">cleareol</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:clearbol">clearbol</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:clearline">clearline</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:clearDown">clearDown</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:clearUp">clearUp</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:cls">cls</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:goto">goto</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:cursorUp">cursorUp</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:cursorDown">cursorDown</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:cursorLeft">cursorLeft</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:cursorRight">cursorRight</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:savePosition">savePosition</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:restorePosition">restorePosition</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:Highlight">Highlight</a> <ul class="subs"><li>= <a href="#v:Normal">Normal</a> </li><li>| <a href="#v:Bold">Bold</a> </li><li>| <a href="#v:Dim">Dim</a> </li><li>| <a href="#v:Underscore">Underscore</a> </li><li>| <a href="#v:Blink">Blink</a> </li><li>| <a href="#v:ReverseVideo">ReverseVideo</a> </li><li>| <a href="#v:Concealed">Concealed</a> </li><li>| <a href="#v:Foreground">Foreground</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a> </li><li>| <a href="#v:Background">Background</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a> </li><li>| <a href="#v:Italic">Italic</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Colour">Colour</a> <ul class="subs"><li>= <a href="#v:Black">Black</a> </li><li>| <a href="#v:Red">Red</a> </li><li>| <a href="#v:Green">Green</a> </li><li>| <a href="#v:Yellow">Yellow</a> </li><li>| <a href="#v:Blue">Blue</a> </li><li>| <a href="#v:Magenta">Magenta</a> </li><li>| <a href="#v:Cyan">Cyan</a> </li><li>| <a href="#v:White">White</a> </li></ul></li><li class="src short"><a href="#v:colourCycle">colourCycle</a> :: [<a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a>]</li><li class="src short"><a href="#v:enableScrollRegion">enableScrollRegion</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:scrollUp">scrollUp</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:scrollDown">scrollDown</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li><li class="src short"><a href="#v:lineWrap">lineWrap</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]</li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:highlightOn" class="def">highlightOn</a> :: [<a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a>] -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#highlightOn" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:highlightOff" class="def">highlightOff</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#highlightOff" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:highlight" class="def">highlight</a> :: [<a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Language-Haskell-HsColour-ANSI.html#highlight" class="link">Source</a></p><div class="doc"><p>Make the given string appear with all of the listed highlights
</p></div></div><div class="top"><p class="src"><a name="v:cleareol" class="def">cleareol</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#cleareol" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:clearbol" class="def">clearbol</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#clearbol" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:clearline" class="def">clearline</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#clearline" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:clearDown" class="def">clearDown</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#clearDown" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:clearUp" class="def">clearUp</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#clearUp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:cls" class="def">cls</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Language-Haskell-HsColour-ANSI.html#cls" class="link">Source</a></p><div class="doc"><p>Clear the screen.
</p></div></div><div class="top"><p class="src"><a name="v:goto" class="def">goto</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Language-Haskell-HsColour-ANSI.html#goto" class="link">Source</a></p><div class="doc"><p>Move the screen cursor to the given position.
</p></div></div><div class="top"><p class="src"><a name="v:cursorUp" class="def">cursorUp</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#cursorUp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:cursorDown" class="def">cursorDown</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#cursorDown" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:cursorLeft" class="def">cursorLeft</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#cursorLeft" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:cursorRight" class="def">cursorRight</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#cursorRight" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:savePosition" class="def">savePosition</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#savePosition" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:restorePosition" class="def">restorePosition</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#restorePosition" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Highlight" class="def">Highlight</a> <a href="src/Language-Haskell-HsColour-ColourHighlight.html#Highlight" class="link">Source</a></p><div class="doc"><p>Types of highlighting supported by ANSI codes (and some extra styles).
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Normal" class="def">Normal</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Bold" class="def">Bold</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Dim" class="def">Dim</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Underscore" class="def">Underscore</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Blink" class="def">Blink</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ReverseVideo" class="def">ReverseVideo</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Concealed" class="def">Concealed</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Foreground" class="def">Foreground</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Background" class="def">Background</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Italic" class="def">Italic</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Highlight" class="caption collapser" onclick="toggleSection('i:Highlight')">Instances</p><div id="section.i:Highlight" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Highlight">Highlight</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Colour" class="def">Colour</a> <a href="src/Language-Haskell-HsColour-ColourHighlight.html#Colour" class="link">Source</a></p><div class="doc"><p>Colours supported by ANSI codes.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Black" class="def">Black</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Red" class="def">Red</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Green" class="def">Green</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Yellow" class="def">Yellow</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Blue" class="def">Blue</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Magenta" class="def">Magenta</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Cyan" class="def">Cyan</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:White" class="def">White</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Colour" class="caption collapser" onclick="toggleSection('i:Colour')">Instances</p><div id="section.i:Colour" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Read.html#t:Read">Read</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:colourCycle" class="def">colourCycle</a> :: [<a href="Language-Haskell-HsColour-ANSI.html#t:Colour">Colour</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#colourCycle" class="link">Source</a></p><div class="doc"><p>An infinite supply of colours.
</p></div></div><div class="top"><p class="src"><a name="v:enableScrollRegion" class="def">enableScrollRegion</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Language-Haskell-HsColour-ANSI.html#enableScrollRegion" class="link">Source</a></p><div class="doc"><p>Scrolling
</p></div></div><div class="top"><p class="src"><a name="v:scrollUp" class="def">scrollUp</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#scrollUp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:scrollDown" class="def">scrollDown</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#scrollDown" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:lineWrap" class="def">lineWrap</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a>]<a href="src/Language-Haskell-HsColour-ANSI.html#lineWrap" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
