<!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>Hledger.Data.AccountName</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_Hledger-Data-AccountName.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Hledger-Data-AccountName.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">hledger-lib-0.14: Reusable types and utilities for the hledger accounting tool and financial apps in general.</p></div><div id="content"><div id="module-header"><p class="caption">Hledger.Data.AccountName</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p><code><a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></code>s are strings like <code>assets:cash:petty</code>, with multiple
components separated by <code>:</code>. From a set of these we derive the account
hierarchy.
</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:accountNameComponents">accountNameComponents</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</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:accountNameFromComponents">accountNameFromComponents</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><a href="#v:accountLeafName">accountLeafName</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</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:accountNameLevel">accountNameLevel</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:accountNameDrop">accountNameDrop</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><a href="#v:expandAccountNames">expandAccountNames</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:topAccountNames">topAccountNames</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:parentAccountName">parentAccountName</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><a href="#v:parentAccountNames">parentAccountNames</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:isAccountNamePrefixOf">isAccountNamePrefixOf</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isSubAccountNameOf">isSubAccountNameOf</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:subAccountNamesFrom">subAccountNamesFrom</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:accountNameTreeFrom">accountNameTreeFrom</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><span class="keyword">newtype</span> <a href="#t:Tree-39-">Tree'</a> a = <a href="#v:T">T</a> (<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> a (<a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a))</li><li class="src short"><a href="#v:mergeTrees">mergeTrees</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> a => <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a</li><li class="src short"><a href="#v:pathtree">pathtree</a> :: [a] -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a</li><li class="src short"><a href="#v:fromPaths">fromPaths</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> a => [[a]] -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a</li><li class="src short"><a href="#v:converttree">converttree</a> :: <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]</li><li class="src short"><a href="#v:expandTreeNames">expandTreeNames</a> :: <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><a href="#v:accountNameTreeFrom4">accountNameTreeFrom4</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><a href="#v:elideAccountName">elideAccountName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li><li class="src short"><a href="#v:clipAccountName">clipAccountName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:accountNameComponents" class="def">accountNameComponents</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]<a href="src/Hledger-Data-AccountName.html#accountNameComponents" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accountNameFromComponents" class="def">accountNameFromComponents</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#accountNameFromComponents" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accountLeafName" class="def">accountLeafName</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Hledger-Data-AccountName.html#accountLeafName" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accountNameLevel" class="def">accountNameLevel</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Hledger-Data-AccountName.html#accountNameLevel" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accountNameDrop" class="def">accountNameDrop</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#accountNameDrop" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:expandAccountNames" class="def">expandAccountNames</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-AccountName.html#expandAccountNames" class="link">Source</a></p><div class="doc"><dl><dt><a href="a:b:c.html">a:b:c</a>,<a href="d:e.html">d:e</a></dt><dd> -> [<a href="a.html">a</a>,<a href="a:b.html">a:b</a>,<a href="a:b:c.html">a:b:c</a>,<a href="d.html">d</a>,<a href="d:e.html">d:e</a>]
</dd></dl></div></div><div class="top"><p class="src"><a name="v:topAccountNames" class="def">topAccountNames</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-AccountName.html#topAccountNames" class="link">Source</a></p><div class="doc"><dl><dt><a href="a:b:c.html">a:b:c</a>,<a href="d:e.html">d:e</a></dt><dd> -> [<a href="a.html">a</a>,<a href="d.html">d</a>]
</dd></dl></div></div><div class="top"><p class="src"><a name="v:parentAccountName" class="def">parentAccountName</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#parentAccountName" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:parentAccountNames" class="def">parentAccountNames</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-AccountName.html#parentAccountNames" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:isAccountNamePrefixOf" class="def">isAccountNamePrefixOf</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Hledger-Data-AccountName.html#isAccountNamePrefixOf" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:isSubAccountNameOf" class="def">isSubAccountNameOf</a> :: <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Hledger-Data-AccountName.html#isSubAccountNameOf" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:subAccountNamesFrom" class="def">subAccountNamesFrom</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-AccountName.html#subAccountNamesFrom" class="link">Source</a></p><div class="doc"><p>From a list of account names, select those which are direct
subaccounts of the given account name.
</p></div></div><div class="top"><p class="src"><a name="v:accountNameTreeFrom" class="def">accountNameTreeFrom</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#accountNameTreeFrom" class="link">Source</a></p><div class="doc"><p>Convert a list of account names to a tree.
</p></div></div><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:Tree-39-" class="def">Tree'</a> a <a href="src/Hledger-Data-AccountName.html#Tree%27" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:T" class="def">T</a> (<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Map.html#t:Map">Map</a> a (<a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a))</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Tree-39-" class="caption collapser" onclick="toggleSection('i:Tree-39-')">Instances</p><div id="section.i:Tree-39-" class="show"><table><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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> (<a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> 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-Ord.html#t:Ord">Ord</a> a => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> (<a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> 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 => <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> (<a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a)</td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:mergeTrees" class="def">mergeTrees</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> a => <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a<a href="src/Hledger-Data-AccountName.html#mergeTrees" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:pathtree" class="def">pathtree</a> :: [a] -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a<a href="src/Hledger-Data-AccountName.html#pathtree" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:fromPaths" class="def">fromPaths</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> a => [[a]] -> <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> a<a href="src/Hledger-Data-AccountName.html#fromPaths" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:converttree" class="def">converttree</a> :: <a href="Hledger-Data-AccountName.html#t:Tree-39-">Tree'</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> [<a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>]<a href="src/Hledger-Data-AccountName.html#converttree" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:expandTreeNames" class="def">expandTreeNames</a> :: <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#expandTreeNames" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:accountNameTreeFrom4" class="def">accountNameTreeFrom4</a> :: [<a href="Hledger-Data-Types.html#t:AccountName">AccountName</a>] -> <a href="/usr/share/doc/ghc/html/libraries/containers-0.4.0.0/Data-Tree.html#t:Tree">Tree</a> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#accountNameTreeFrom4" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:elideAccountName" class="def">elideAccountName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#elideAccountName" class="link">Source</a></p><div class="doc"><p>Elide an account name to fit in the specified width.
From the ledger 2.6 news:
</p><pre>
What Ledger now does is that if an account name is too long, it will
start abbreviating the first parts of the account name down to two
letters in length. If this results in a string that is still too
long, the front will be elided -- not the end. For example:
Expenses:Cash ; OK, not too long
Ex:Wednesday:Cash ; <a href="Expenses.html">Expenses</a> was abbreviated to fit
Ex:We:Afternoon:Cash ; <a href="Expenses.html">Expenses</a> and <a href="Wednesday.html">Wednesday</a> abbreviated
; Expenses:Wednesday:Afternoon:Lunch:Snack:Candy:Chocolate:Cash
..:Af:Lu:Sn:Ca:Ch:Cash ; Abbreviated and elided!
</pre></div></div><div class="top"><p class="src"><a name="v:clipAccountName" class="def">clipAccountName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a> -> <a href="Hledger-Data-Types.html#t:AccountName">AccountName</a><a href="src/Hledger-Data-AccountName.html#clipAccountName" 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>
