<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Hledger/Read/Utils.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-|
<a name="line-2"></a>Utilities common to hledger journal readers.
<a name="line-3"></a>-}</span>
<a name="line-4"></a>
<a name="line-5"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Hledger</span><span class='hs-varop'>.</span><span class='hs-conid'>Read</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span>
<a name="line-6"></a><span class='hs-keyword'>where</span>
<a name="line-7"></a>
<a name="line-8"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Error</span>
<a name="line-9"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Directory</span> <span class='hs-layout'>(</span><span class='hs-varid'>getHomeDirectory</span><span class='hs-layout'>)</span>
<a name="line-10"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span><span class='hs-layout'>(</span><span class='hs-varid'>takeDirectory</span><span class='hs-layout'>,</span><span class='hs-varid'>combine</span><span class='hs-layout'>)</span>
<a name="line-11"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Time</span> <span class='hs-layout'>(</span><span class='hs-varid'>getClockTime</span><span class='hs-layout'>)</span>
<a name="line-12"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>ParserCombinators</span><span class='hs-varop'>.</span><span class='hs-conid'>Parsec</span>
<a name="line-13"></a>
<a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Hledger</span><span class='hs-varop'>.</span><span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span><span class='hs-conid'>Journal</span><span class='hs-layout'>,</span> <span class='hs-conid'>JournalContext</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Commodity</span><span class='hs-layout'>,</span> <span class='hs-conid'>JournalUpdate</span><span class='hs-layout'>)</span>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Hledger</span><span class='hs-varop'>.</span><span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Hledger</span><span class='hs-varop'>.</span><span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Dates</span> <span class='hs-layout'>(</span><span class='hs-varid'>getCurrentYear</span><span class='hs-layout'>)</span>
<a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Hledger</span><span class='hs-varop'>.</span><span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Journal</span> <span class='hs-layout'>(</span><span class='hs-varid'>nullctx</span><span class='hs-layout'>,</span> <span class='hs-varid'>nulljournal</span><span class='hs-layout'>,</span> <span class='hs-varid'>journalFinalise</span><span class='hs-layout'>)</span>
<a name="line-18"></a>
<a name="line-19"></a>
<a name="line-20"></a><a name="juSequence"></a><span class='hs-definition'>juSequence</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>JournalUpdate</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>JournalUpdate</span>
<a name="line-21"></a><span class='hs-definition'>juSequence</span> <span class='hs-varid'>us</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>foldr</span> <span class='hs-layout'>(</span><span class='hs-varop'>.</span><span class='hs-layout'>)</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>sequence</span> <span class='hs-varid'>us</span>
<a name="line-22"></a>
<a name="line-23"></a><a name="parseJournalWith"></a><span class='hs-comment'>-- | Given a JournalUpdate-generating parsec parser, file path and data string,</span>
<a name="line-24"></a><span class='hs-comment'>-- parse and post-process a Journal so that it's ready to use, or give an error.</span>
<a name="line-25"></a><span class='hs-definition'>parseJournalWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenParser</span> <span class='hs-conid'>Char</span> <span class='hs-conid'>JournalContext</span> <span class='hs-layout'>(</span><span class='hs-conid'>JournalUpdate</span><span class='hs-layout'>,</span><span class='hs-conid'>JournalContext</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ErrorT</span> <span class='hs-conid'>String</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Journal</span>
<a name="line-26"></a><span class='hs-definition'>parseJournalWith</span> <span class='hs-varid'>p</span> <span class='hs-varid'>f</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-27"></a> <span class='hs-varid'>tc</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varid'>getClockTime</span>
<a name="line-28"></a> <span class='hs-varid'>tl</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varid'>getCurrentLocalTime</span>
<a name="line-29"></a> <span class='hs-varid'>y</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varid'>getCurrentYear</span>
<a name="line-30"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>runParser</span> <span class='hs-varid'>p</span> <span class='hs-varid'>nullctx</span><span class='hs-layout'>{</span><span class='hs-varid'>ctxYear</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>Just</span> <span class='hs-varid'>y</span><span class='hs-layout'>}</span> <span class='hs-varid'>f</span> <span class='hs-varid'>s</span> <span class='hs-keyword'>of</span>
<a name="line-31"></a> <span class='hs-conid'>Right</span> <span class='hs-layout'>(</span><span class='hs-varid'>updates</span><span class='hs-layout'>,</span><span class='hs-varid'>ctx</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-32"></a> <span class='hs-varid'>j</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>updates</span> <span class='hs-varop'>`ap`</span> <span class='hs-varid'>return</span> <span class='hs-varid'>nulljournal</span>
<a name="line-33"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>journalFinalise</span> <span class='hs-varid'>tc</span> <span class='hs-varid'>tl</span> <span class='hs-varid'>f</span> <span class='hs-varid'>s</span> <span class='hs-varid'>ctx</span> <span class='hs-varid'>j</span> <span class='hs-keyword'>of</span>
<a name="line-34"></a> <span class='hs-conid'>Right</span> <span class='hs-varid'>j'</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varid'>j'</span>
<a name="line-35"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>estr</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>throwError</span> <span class='hs-varid'>estr</span>
<a name="line-36"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>throwError</span> <span class='hs-varop'>$</span> <span class='hs-varid'>show</span> <span class='hs-varid'>e</span>
<a name="line-37"></a>
<a name="line-38"></a><a name="setYear"></a><span class='hs-definition'>setYear</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Integer</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GenParser</span> <span class='hs-varid'>tok</span> <span class='hs-conid'>JournalContext</span> <span class='hs-conid'>()</span>
<a name="line-39"></a><span class='hs-definition'>setYear</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>updateState</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>ctx</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>ctx</span><span class='hs-layout'>{</span><span class='hs-varid'>ctxYear</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>Just</span> <span class='hs-varid'>y</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-40"></a>
<a name="line-41"></a><a name="getYear"></a><span class='hs-definition'>getYear</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GenParser</span> <span class='hs-varid'>tok</span> <span class='hs-conid'>JournalContext</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>Integer</span><span class='hs-layout'>)</span>
<a name="line-42"></a><span class='hs-definition'>getYear</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>ctxYear</span> <span class='hs-varid'>getState</span>
<a name="line-43"></a>
<a name="line-44"></a><a name="setCommodity"></a><span class='hs-definition'>setCommodity</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Commodity</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GenParser</span> <span class='hs-varid'>tok</span> <span class='hs-conid'>JournalContext</span> <span class='hs-conid'>()</span>
<a name="line-45"></a><span class='hs-definition'>setCommodity</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>updateState</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>ctx</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>ctx</span><span class='hs-layout'>{</span><span class='hs-varid'>ctxCommodity</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>Just</span> <span class='hs-varid'>c</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-46"></a>
<a name="line-47"></a><a name="getCommodity"></a><span class='hs-definition'>getCommodity</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GenParser</span> <span class='hs-varid'>tok</span> <span class='hs-conid'>JournalContext</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>Commodity</span><span class='hs-layout'>)</span>
<a name="line-48"></a><span class='hs-definition'>getCommodity</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>ctxCommodity</span> <span class='hs-varid'>getState</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="pushParentAccount"></a><span class='hs-definition'>pushParentAccount</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>GenParser</span> <span class='hs-varid'>tok</span> <span class='hs-conid'>JournalContext</span> <span class='hs-conid'>()</span>
<a name="line-51"></a><span class='hs-definition'>pushParentAccount</span> <span class='hs-varid'>parent</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>updateState</span> <span class='hs-varid'>addParentAccount</span>
<a name="line-52"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>addParentAccount</span> <span class='hs-varid'>ctx0</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ctx0</span> <span class='hs-layout'>{</span> <span class='hs-varid'>ctxAccount</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>normalize</span> <span class='hs-varid'>parent</span> <span class='hs-conop'>:</span> <span class='hs-varid'>ctxAccount</span> <span class='hs-varid'>ctx0</span> <span class='hs-layout'>}</span>
<a name="line-53"></a> <span class='hs-varid'>normalize</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>++</span> <span class='hs-str'>":"</span><span class='hs-layout'>)</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="popParentAccount"></a><span class='hs-definition'>popParentAccount</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GenParser</span> <span class='hs-varid'>tok</span> <span class='hs-conid'>JournalContext</span> <span class='hs-conid'>()</span>
<a name="line-56"></a><span class='hs-definition'>popParentAccount</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>ctx0</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getState</span>
<a name="line-57"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>ctxAccount</span> <span class='hs-varid'>ctx0</span> <span class='hs-keyword'>of</span>
<a name="line-58"></a> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>unexpected</span> <span class='hs-str'>"End of account block with no beginning"</span>
<a name="line-59"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-conop'>:</span><span class='hs-varid'>rest</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>setState</span> <span class='hs-varop'>$</span> <span class='hs-varid'>ctx0</span> <span class='hs-layout'>{</span> <span class='hs-varid'>ctxAccount</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rest</span> <span class='hs-layout'>}</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="getParentAccount"></a><span class='hs-definition'>getParentAccount</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GenParser</span> <span class='hs-varid'>tok</span> <span class='hs-conid'>JournalContext</span> <span class='hs-conid'>String</span>
<a name="line-62"></a><span class='hs-definition'>getParentAccount</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>concat</span> <span class='hs-varop'>.</span> <span class='hs-varid'>reverse</span> <span class='hs-varop'>.</span> <span class='hs-varid'>ctxAccount</span><span class='hs-layout'>)</span> <span class='hs-varid'>getState</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="expandPath"></a><span class='hs-comment'>-- | Convert a possibly relative, possibly tilde-containing file path to an absolute one.</span>
<a name="line-65"></a><span class='hs-comment'>-- using the current directory from a parsec source position. ~username is not supported.</span>
<a name="line-66"></a><span class='hs-definition'>expandPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>SourcePos</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>FilePath</span>
<a name="line-67"></a><span class='hs-definition'>expandPath</span> <span class='hs-varid'>pos</span> <span class='hs-varid'>fp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>mkAbsolute</span> <span class='hs-layout'>(</span><span class='hs-varid'>expandHome</span> <span class='hs-varid'>fp</span><span class='hs-layout'>)</span>
<a name="line-68"></a> <span class='hs-keyword'>where</span>
<a name="line-69"></a> <span class='hs-varid'>mkAbsolute</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>combine</span> <span class='hs-layout'>(</span><span class='hs-varid'>takeDirectory</span> <span class='hs-layout'>(</span><span class='hs-varid'>sourceName</span> <span class='hs-varid'>pos</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-70"></a> <span class='hs-varid'>expandHome</span> <span class='hs-varid'>inname</span> <span class='hs-keyglyph'>|</span> <span class='hs-str'>"~/"</span> <span class='hs-varop'>`isPrefixOf`</span> <span class='hs-varid'>inname</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>homedir</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftIO</span> <span class='hs-varid'>getHomeDirectory</span>
<a name="line-71"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>homedir</span> <span class='hs-varop'>++</span> <span class='hs-varid'>drop</span> <span class='hs-num'>1</span> <span class='hs-varid'>inname</span>
<a name="line-72"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-varid'>inname</span>
<a name="line-73"></a>
<a name="line-74"></a><a name="fileSuffix"></a><span class='hs-definition'>fileSuffix</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-75"></a><span class='hs-definition'>fileSuffix</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>reverse</span> <span class='hs-varop'>.</span> <span class='hs-varid'>takeWhile</span> <span class='hs-layout'>(</span><span class='hs-varop'>/=</span><span class='hs-chr'>'.'</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>reverse</span> <span class='hs-varop'>.</span> <span class='hs-varid'>dropWhile</span> <span class='hs-layout'>(</span><span class='hs-varop'>/=</span><span class='hs-chr'>'.'</span><span class='hs-layout'>)</span>
</pre></body>
</html>
