<!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>Agda.Utils.String</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_Agda-Utils-String.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Agda-Utils-String.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">Agda-2.3.2.1: A dependently typed functional programming language and proof assistant</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Agda.Utils.String</p></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:quote">quote</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:showIndex">showIndex</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Text-Show.html#t:Show">Show</a> i, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Prelude.html#t:Integral">Integral</a> i) => i -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:addFinalNewLine">addFinalNewLine</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:indent">indent</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Prelude.html#t:Integral">Integral</a> i => i -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:quote" class="def">quote</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a><a href="src/Agda-Utils-String.html#quote" class="link">Source</a></p><div class="doc"><p><code><a href="Agda-Utils-String.html#v:quote">quote</a></code> adds double quotes around the string, replaces newline
characters with <code>n</code>, and escapes double quotes and backslashes
within the string. This is different from the behaviour of <code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Text-Show.html#v:show">show</a></code>:
</p><pre>
> <code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#v:putStrLn">putStrLn</a></code> $ <code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Text-Show.html#v:show">show</a></code> "\x2200"
"\8704"
> <code><a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#v:putStrLn">putStrLn</a></code> $ <code><a href="Agda-Utils-String.html#v:quote">quote</a></code> "\x2200"
"∀"
</pre><p>(The code examples above have been tested using version 4.2.0.0 of
the base library.)
</p></div></div><div class="top"><p class="src"><a name="v:showIndex" class="def">showIndex</a> :: (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Text-Show.html#t:Show">Show</a> i, <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Prelude.html#t:Integral">Integral</a> i) => i -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a><a href="src/Agda-Utils-String.html#showIndex" class="link">Source</a></p><div class="doc"><p>Shows a non-negative integer using the characters ₀-₉ instead of
0-9.
</p></div></div><div class="top"><p class="src"><a name="v:addFinalNewLine" class="def">addFinalNewLine</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a><a href="src/Agda-Utils-String.html#addFinalNewLine" class="link">Source</a></p><div class="doc"><p>Adds a final newline if there is not already one.
</p></div></div><div class="top"><p class="src"><a name="v:indent" class="def">indent</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Prelude.html#t:Integral">Integral</a> i => i -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a><a href="src/Agda-Utils-String.html#indent" class="link">Source</a></p><div class="doc"><p>Indents every line the given number of steps.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
