Sophie: ghc-hledger-lib-devel-0.14-2.fc14 x86

ghc-hledger-lib-devel-0.14-2.fc14.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Hledger.Read.Utils</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Hledger-Read-Utils.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>hledger-lib-0.14: Reusable types and utilities for the hledger accounting tool and financial apps in general.</TD
><TD CLASS="topbut"
><A HREF="src/Hledger-Read-Utils.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Hledger.Read.Utils</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>Utilities common to hledger journal readers.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3AjuSequence"
>juSequence</A
> :: [<A HREF="Hledger-Data-Types.html#t%3AJournalUpdate"
>JournalUpdate</A
>] -&gt; <A HREF="Hledger-Data-Types.html#t%3AJournalUpdate"
>JournalUpdate</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AparseJournalWith"
>parseJournalWith</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar"
>Char</A
> <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> (<A HREF="Hledger-Data-Types.html#t%3AJournalUpdate"
>JournalUpdate</A
>, <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
>) -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-Error.html#t%3AErrorT"
>ErrorT</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Hledger-Data-Types.html#t%3AJournal"
>Journal</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsetYear"
>setYear</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetYear"
>getYear</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsetCommodity"
>setCommodity</A
> ::  <A HREF="Hledger-Data-Types.html#t%3ACommodity"
>Commodity</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetCommodity"
>getCommodity</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Hledger-Data-Types.html#t%3ACommodity"
>Commodity</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ApushParentAccount"
>pushParentAccount</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ApopParentAccount"
>popParentAccount</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetParentAccount"
>getParentAccount</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AexpandPath"
>expandPath</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-Trans.html#t%3AMonadIO"
>MonadIO</A
> m =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Pos.html#t%3ASourcePos"
>SourcePos</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; m <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfileSuffix"
>fileSuffix</A
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:juSequence"
><A NAME="v%3AjuSequence"
></A
></A
><B
>juSequence</B
> :: [<A HREF="Hledger-Data-Types.html#t%3AJournalUpdate"
>JournalUpdate</A
>] -&gt; <A HREF="Hledger-Data-Types.html#t%3AJournalUpdate"
>JournalUpdate</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#juSequence"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:parseJournalWith"
><A NAME="v%3AparseJournalWith"
></A
></A
><B
>parseJournalWith</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar"
>Char</A
> <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> (<A HREF="Hledger-Data-Types.html#t%3AJournalUpdate"
>JournalUpdate</A
>, <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
>) -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-Error.html#t%3AErrorT"
>ErrorT</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Hledger-Data-Types.html#t%3AJournal"
>Journal</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#parseJournalWith"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>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.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:setYear"
><A NAME="v%3AsetYear"
></A
></A
><B
>setYear</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#setYear"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:getYear"
><A NAME="v%3AgetYear"
></A
></A
><B
>getYear</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Prelude.html#t%3AInteger"
>Integer</A
>)</TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#getYear"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:setCommodity"
><A NAME="v%3AsetCommodity"
></A
></A
><B
>setCommodity</B
> ::  <A HREF="Hledger-Data-Types.html#t%3ACommodity"
>Commodity</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#setCommodity"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:getCommodity"
><A NAME="v%3AgetCommodity"
></A
></A
><B
>getCommodity</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Hledger-Data-Types.html#t%3ACommodity"
>Commodity</A
>)</TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#getCommodity"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:pushParentAccount"
><A NAME="v%3ApushParentAccount"
></A
></A
><B
>pushParentAccount</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#pushParentAccount"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:popParentAccount"
><A NAME="v%3ApopParentAccount"
></A
></A
><B
>popParentAccount</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#popParentAccount"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:getParentAccount"
><A NAME="v%3AgetParentAccount"
></A
></A
><B
>getParentAccount</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Prim.html#t%3AGenParser"
>GenParser</A
> tok <A HREF="Hledger-Data-Types.html#t%3AJournalContext"
>JournalContext</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#getParentAccount"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:expandPath"
><A NAME="v%3AexpandPath"
></A
></A
><B
>expandPath</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/mtl-1.1.0.2/Control-Monad-Trans.html#t%3AMonadIO"
>MonadIO</A
> m =&gt; <A HREF="/usr/share/doc/ghc/html/libraries/parsec-2.1.0.1/Text-ParserCombinators-Parsec-Pos.html#t%3ASourcePos"
>SourcePos</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; m <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#expandPath"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>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.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:fileSuffix"
><A NAME="v%3AfileSuffix"
></A
></A
><B
>fileSuffix</B
> :: <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="declbut"
><A HREF="src/Hledger-Read-Utils.html#fileSuffix"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>