<!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</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.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Hledger-Read.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</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Read hledger data from various data formats, and related utilities.
</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:tests_Hledger_Read">tests_Hledger_Read</a> :: <a href="/usr/share/doc/ghc/html/libraries/HUnit-1.2.2.3/Test-HUnit-Base.html#t:Test">Test</a></li><li class="src short"><a href="#v:readJournalFile">readJournalFile</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/Data-Char.html#t:String">String</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/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</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:Journal">Journal</a>)</li><li class="src short"><a href="#v:readJournal">readJournal</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/Data-Char.html#t:String">String</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="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</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:Journal">Journal</a>)</li><li class="src short"><a href="#v:journalFromPathAndString">journalFromPathAndString</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/Data-Char.html#t:String">String</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/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</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:Journal">Journal</a>)</li><li class="src short"><a href="#v:myJournalPath">myJournalPath</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</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:myTimelogPath">myTimelogPath</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</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:myJournal">myJournal</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:myTimelog">myTimelog</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></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:tests_Hledger_Read" class="def">tests_Hledger_Read</a> :: <a href="/usr/share/doc/ghc/html/libraries/HUnit-1.2.2.3/Test-HUnit-Base.html#t:Test">Test</a><a href="src/Hledger-Read.html#tests_Hledger_Read" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:readJournalFile" class="def">readJournalFile</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/Data-Char.html#t:String">String</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/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</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:Journal">Journal</a>)<a href="src/Hledger-Read.html#readJournalFile" class="link">Source</a></p><div class="doc"><p>Read a journal from this file, using the specified data format or
trying all known formats, or give an error string; also create the file
if it doesn't exist.
</p></div></div><div class="top"><p class="src"><a name="v:readJournal" class="def">readJournal</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/Data-Char.html#t:String">String</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="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</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:Journal">Journal</a>)<a href="src/Hledger-Read.html#readJournal" class="link">Source</a></p><div class="doc"><p>Read a Journal from this string, using the specified data format or
trying all known formats, or give an error string.
</p></div></div><div class="top"><p class="src"><a name="v:journalFromPathAndString" class="def">journalFromPathAndString</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/Data-Char.html#t:String">String</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/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</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:Journal">Journal</a>)<a href="src/Hledger-Read.html#journalFromPathAndString" class="link">Source</a></p><div class="doc"><p>Read a Journal from this string (and file path), auto-detecting the
data format, or give a useful error string. Tries to parse each known
data format in turn. If none succeed, gives the error message specific
to the intended data format, which if not specified is guessed from the
file suffix and possibly the data.
</p></div></div><div class="top"><p class="src"><a name="v:myJournalPath" class="def">myJournalPath</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</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.html#myJournalPath" class="link">Source</a></p><div class="doc"><p>Get the user's journal file path. Like ledger, we look first for the
LEDGER_FILE environment variable, and if that does not exist, for the
legacy LEDGER environment variable. If neither is set, or the value is
blank, return the default journal file path, which is
<a href="-hledger-journal.html">.hledger.journal</a> in the users's home directory, or if we cannot
determine that, in the current directory.
</p></div></div><div class="top"><p class="src"><a name="v:myTimelogPath" class="def">myTimelogPath</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</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.html#myTimelogPath" class="link">Source</a></p><div class="doc"><p>Get the user's default timelog file path.
</p></div></div><div class="top"><p class="src"><a name="v:myJournal" class="def">myJournal</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.html#myJournal" class="link">Source</a></p><div class="doc"><p>Read the user's default journal file, or give an error.
</p></div></div><div class="top"><p class="src"><a name="v:myTimelog" class="def">myTimelog</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.html#myTimelog" class="link">Source</a></p><div class="doc"><p>Read the user's default timelog file, or give an error.
</p></div></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>
