<!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.Read.Utils</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-Read-Utils.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Hledger-Read-Utils.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.Read.Utils</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Utilities common to hledger journal readers.
</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:juSequence">juSequence</a> :: [<a href="Hledger-Data-Types.html#t:JournalUpdate">JournalUpdate</a>] -> <a href="Hledger-Data-Types.html#t:JournalUpdate">JournalUpdate</a></li><li class="src short"><a href="#v:parseJournalWith">parseJournalWith</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a> <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> (<a href="Hledger-Data-Types.html#t:JournalUpdate">JournalUpdate</a>, <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a>) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</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/mtl-2.0.1.0/Control-Monad-Error.html#t:ErrorT">ErrorT</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/System-IO.html#t:IO">IO</a> <a href="Hledger-Data-Types.html#t:Journal">Journal</a></li><li class="src short"><a href="#v:setYear">setYear</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Integer">Integer</a> -> <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:getYear">getYear</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Integer">Integer</a>)</li><li class="src short"><a href="#v:setCommodity">setCommodity</a> :: <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:getCommodity">getCommodity</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>)</li><li class="src short"><a href="#v:pushParentAccount">pushParentAccount</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/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:popParentAccount">popParentAccount</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:getParentAccount">getParentAccount</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</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:expandPath">expandPath</a> :: <a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-Pos.html#t:SourcePos">SourcePos</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> m <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><a href="#v:fileSuffix">fileSuffix</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:juSequence" class="def">juSequence</a> :: [<a href="Hledger-Data-Types.html#t:JournalUpdate">JournalUpdate</a>] -> <a href="Hledger-Data-Types.html#t:JournalUpdate">JournalUpdate</a><a href="src/Hledger-Read-Utils.html#juSequence" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:parseJournalWith" class="def">parseJournalWith</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:Char">Char</a> <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> (<a href="Hledger-Data-Types.html#t:JournalUpdate">JournalUpdate</a>, <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a>) -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</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/mtl-2.0.1.0/Control-Monad-Error.html#t:ErrorT">ErrorT</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/System-IO.html#t:IO">IO</a> <a href="Hledger-Data-Types.html#t:Journal">Journal</a><a href="src/Hledger-Read-Utils.html#parseJournalWith" class="link">Source</a></p><div class="doc"><p>Given a JournalUpdate-generating parsec parser, file path and data string,
parse and post-process a Journal so that it's ready to use, or give an error.
</p></div></div><div class="top"><p class="src"><a name="v:setYear" class="def">setYear</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Integer">Integer</a> -> <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Hledger-Read-Utils.html#setYear" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:getYear" class="def">getYear</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Integer">Integer</a>)<a href="src/Hledger-Read-Utils.html#getYear" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:setCommodity" class="def">setCommodity</a> :: <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a> -> <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Hledger-Read-Utils.html#setCommodity" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:getCommodity" class="def">getCommodity</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Hledger-Data-Types.html#t:Commodity">Commodity</a>)<a href="src/Hledger-Read-Utils.html#getCommodity" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:pushParentAccount" class="def">pushParentAccount</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/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Hledger-Read-Utils.html#pushParentAccount" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:popParentAccount" class="def">popParentAccount</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Hledger-Read-Utils.html#popParentAccount" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:getParentAccount" class="def">getParentAccount</a> :: <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-String.html#t:GenParser">GenParser</a> tok <a href="Hledger-Data-Types.html#t:JournalContext">JournalContext</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-Read-Utils.html#getParentAccount" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:expandPath" class="def">expandPath</a> :: <a href="/usr/share/doc/ghc/html/libraries/transformers-0.2.2.0/Control-Monad-IO-Class.html#t:MonadIO">MonadIO</a> m => <a href="/usr/share/doc/ghc/html/libraries/parsec-3.1.1/Text-Parsec-Pos.html#t:SourcePos">SourcePos</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> m <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a><a href="src/Hledger-Read-Utils.html#expandPath" class="link">Source</a></p><div class="doc"><p>Convert a possibly relative, possibly tilde-containing file path to an absolute one.
using the current directory from a parsec source position. ~username is not supported.
</p></div></div><div class="top"><p class="src"><a name="v:fileSuffix" class="def">fileSuffix</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</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-Read-Utils.html#fileSuffix" 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>
