<?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.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-|
<a name="line-3"></a>
<a name="line-4"></a>Read hledger data from various data formats, and related utilities.
<a name="line-5"></a>
<a name="line-6"></a>-}</span>
<a name="line-7"></a>
<a name="line-8"></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-layout'>(</span>
<a name="line-9"></a> <span class='hs-varid'>tests_Hledger_Read</span><span class='hs-layout'>,</span>
<a name="line-10"></a> <span class='hs-varid'>readJournalFile</span><span class='hs-layout'>,</span>
<a name="line-11"></a> <span class='hs-varid'>readJournal</span><span class='hs-layout'>,</span>
<a name="line-12"></a> <span class='hs-varid'>journalFromPathAndString</span><span class='hs-layout'>,</span>
<a name="line-13"></a> <span class='hs-varid'>myJournalPath</span><span class='hs-layout'>,</span>
<a name="line-14"></a> <span class='hs-varid'>myTimelogPath</span><span class='hs-layout'>,</span>
<a name="line-15"></a> <span class='hs-varid'>myJournal</span><span class='hs-layout'>,</span>
<a name="line-16"></a> <span class='hs-varid'>myTimelog</span><span class='hs-layout'>,</span>
<a name="line-17"></a><span class='hs-layout'>)</span>
<a name="line-18"></a><span class='hs-keyword'>where</span>
<a name="line-19"></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-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Either</span> <span class='hs-layout'>(</span><span class='hs-varid'>partitionEithers</span><span class='hs-layout'>)</span>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Safe</span> <span class='hs-layout'>(</span><span class='hs-varid'>headDef</span><span class='hs-layout'>)</span>
<a name="line-22"></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'>doesFileExist</span><span class='hs-layout'>,</span> <span class='hs-varid'>getHomeDirectory</span><span class='hs-layout'>)</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Environment</span> <span class='hs-layout'>(</span><span class='hs-varid'>getEnv</span><span class='hs-layout'>)</span>
<a name="line-24"></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-layout'>(</span><span class='hs-varop'></></span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>IOMode</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>withFile</span><span class='hs-layout'>,</span> <span class='hs-varid'>stderr</span><span class='hs-layout'>)</span>
<a name="line-26"></a>
<a name="line-27"></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'>getCurrentDay</span><span class='hs-layout'>)</span>
<a name="line-28"></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-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Reader</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-29"></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>
<a name="line-30"></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-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Prelude</span> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-varid'>getContents</span><span class='hs-layout'>)</span>
<a name="line-32"></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'>UTF8</span> <span class='hs-layout'>(</span><span class='hs-varid'>getContents</span><span class='hs-layout'>,</span> <span class='hs-varid'>hGetContents</span><span class='hs-layout'>)</span>
<a name="line-33"></a><span class='hs-keyword'>import</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'>JournalReader</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>JournalReader</span>
<a name="line-34"></a><span class='hs-keyword'>import</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'>TimelogReader</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>TimelogReader</span>
<a name="line-35"></a>
<a name="line-36"></a>
<a name="line-37"></a><a name="journalenvvar"></a><span class='hs-definition'>journalenvvar</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"LEDGER_FILE"</span>
<a name="line-38"></a><a name="journalenvvar2"></a><span class='hs-definition'>journalenvvar2</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"LEDGER"</span>
<a name="line-39"></a><a name="timelogenvvar"></a><span class='hs-definition'>timelogenvvar</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"TIMELOG"</span>
<a name="line-40"></a><a name="journaldefaultfilename"></a><span class='hs-definition'>journaldefaultfilename</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>".hledger.journal"</span>
<a name="line-41"></a><a name="timelogdefaultfilename"></a><span class='hs-definition'>timelogdefaultfilename</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>".hledger.timelog"</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="readers"></a><span class='hs-comment'>-- Here are the available readers. The first is the default, used for unknown data formats.</span>
<a name="line-44"></a><span class='hs-definition'>readers</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Reader</span><span class='hs-keyglyph'>]</span>
<a name="line-45"></a><span class='hs-definition'>readers</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span>
<a name="line-46"></a> <span class='hs-conid'>JournalReader</span><span class='hs-varop'>.</span><span class='hs-varid'>reader</span>
<a name="line-47"></a> <span class='hs-layout'>,</span><span class='hs-conid'>TimelogReader</span><span class='hs-varop'>.</span><span class='hs-varid'>reader</span>
<a name="line-48"></a> <span class='hs-keyglyph'>]</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="formats"></a><span class='hs-definition'>formats</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>rFormat</span> <span class='hs-varid'>readers</span>
<a name="line-51"></a>
<a name="line-52"></a><a name="readerForFormat"></a><span class='hs-definition'>readerForFormat</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Reader</span>
<a name="line-53"></a><span class='hs-definition'>readerForFormat</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>null</span> <span class='hs-varid'>rs</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Nothing</span>
<a name="line-54"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-varid'>head</span> <span class='hs-varid'>rs</span>
<a name="line-55"></a> <span class='hs-keyword'>where</span>
<a name="line-56"></a> <span class='hs-varid'>rs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>s</span><span class='hs-varop'>==</span><span class='hs-layout'>)</span><span class='hs-varop'>.</span><span class='hs-varid'>rFormat</span><span class='hs-layout'>)</span> <span class='hs-varid'>readers</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Reader</span><span class='hs-keyglyph'>]</span>
<a name="line-57"></a>
<a name="line-58"></a><a name="journalFromPathAndString"></a><span class='hs-comment'>-- | Read a Journal from this string (and file path), auto-detecting the</span>
<a name="line-59"></a><span class='hs-comment'>-- data format, or give a useful error string. Tries to parse each known</span>
<a name="line-60"></a><span class='hs-comment'>-- data format in turn. If none succeed, gives the error message specific</span>
<a name="line-61"></a><span class='hs-comment'>-- to the intended data format, which if not specified is guessed from the</span>
<a name="line-62"></a><span class='hs-comment'>-- file suffix and possibly the data.</span>
<a name="line-63"></a><span class='hs-definition'>journalFromPathAndString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</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'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Either</span> <span class='hs-conid'>String</span> <span class='hs-conid'>Journal</span><span class='hs-layout'>)</span>
<a name="line-64"></a><span class='hs-definition'>journalFromPathAndString</span> <span class='hs-varid'>format</span> <span class='hs-varid'>fp</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-65"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>readers'</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>format</span> <span class='hs-keyword'>of</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>case</span> <span class='hs-varid'>readerForFormat</span> <span class='hs-varid'>f</span> <span class='hs-keyword'>of</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>r</span><span class='hs-keyglyph'>]</span>
<a name="line-66"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>[]</span>
<a name="line-67"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>readers</span>
<a name="line-68"></a> <span class='hs-layout'>(</span><span class='hs-varid'>errors</span><span class='hs-layout'>,</span> <span class='hs-varid'>journals</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>partitionEithers</span> <span class='hs-varop'>`fmap`</span> <span class='hs-varid'>mapM</span> <span class='hs-varid'>tryReader</span> <span class='hs-varid'>readers'</span>
<a name="line-69"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>journals</span> <span class='hs-keyword'>of</span> <span class='hs-varid'>j</span><span class='hs-conop'>:</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Right</span> <span class='hs-varid'>j</span>
<a name="line-70"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Left</span> <span class='hs-varop'>$</span> <span class='hs-varid'>errMsg</span> <span class='hs-varid'>errors</span>
<a name="line-71"></a> <span class='hs-keyword'>where</span>
<a name="line-72"></a> <span class='hs-varid'>tryReader</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>runErrorT</span> <span class='hs-varop'>.</span> <span class='hs-layout'>(</span><span class='hs-varid'>rParser</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span> <span class='hs-varid'>fp</span><span class='hs-layout'>)</span> <span class='hs-varid'>s</span>
<a name="line-73"></a> <span class='hs-varid'>errMsg</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unknownFormatMsg</span>
<a name="line-74"></a> <span class='hs-varid'>errMsg</span> <span class='hs-varid'>es</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>printf</span> <span class='hs-str'>"could not parse %s data in %s\n%s"</span> <span class='hs-layout'>(</span><span class='hs-varid'>rFormat</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span> <span class='hs-varid'>fp</span> <span class='hs-varid'>e</span>
<a name="line-75"></a> <span class='hs-keyword'>where</span> <span class='hs-layout'>(</span><span class='hs-varid'>r</span><span class='hs-layout'>,</span><span class='hs-varid'>e</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>headDef</span> <span class='hs-layout'>(</span><span class='hs-varid'>head</span> <span class='hs-varid'>readers</span><span class='hs-layout'>,</span> <span class='hs-varid'>head</span> <span class='hs-varid'>es</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>filter</span> <span class='hs-varid'>detects</span> <span class='hs-varop'>$</span> <span class='hs-varid'>zip</span> <span class='hs-varid'>readers</span> <span class='hs-varid'>es</span>
<a name="line-76"></a> <span class='hs-varid'>detects</span> <span class='hs-layout'>(</span><span class='hs-varid'>r</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>rDetector</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span> <span class='hs-varid'>fp</span> <span class='hs-varid'>s</span>
<a name="line-77"></a> <span class='hs-varid'>unknownFormatMsg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>printf</span> <span class='hs-str'>"could not parse %sdata in %s"</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmt</span> <span class='hs-varid'>formats</span><span class='hs-layout'>)</span> <span class='hs-varid'>fp</span>
<a name="line-78"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>fmt</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>""</span>
<a name="line-79"></a> <span class='hs-varid'>fmt</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>f</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>f</span> <span class='hs-varop'>++</span> <span class='hs-str'>" "</span>
<a name="line-80"></a> <span class='hs-varid'>fmt</span> <span class='hs-varid'>fs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>intercalate</span> <span class='hs-str'>", "</span> <span class='hs-layout'>(</span><span class='hs-varid'>init</span> <span class='hs-varid'>fs</span><span class='hs-layout'>)</span> <span class='hs-varop'>++</span> <span class='hs-str'>" or "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>last</span> <span class='hs-varid'>fs</span> <span class='hs-varop'>++</span> <span class='hs-str'>" "</span>
<a name="line-81"></a>
<a name="line-82"></a><a name="readJournalFile"></a><span class='hs-comment'>-- | Read a journal from this file, using the specified data format or</span>
<a name="line-83"></a><span class='hs-comment'>-- trying all known formats, or give an error string; also create the file</span>
<a name="line-84"></a><span class='hs-comment'>-- if it doesn't exist.</span>
<a name="line-85"></a><span class='hs-definition'>readJournalFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Either</span> <span class='hs-conid'>String</span> <span class='hs-conid'>Journal</span><span class='hs-layout'>)</span>
<a name="line-86"></a><span class='hs-definition'>readJournalFile</span> <span class='hs-varid'>format</span> <span class='hs-str'>"-"</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getContents</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>journalFromPathAndString</span> <span class='hs-varid'>format</span> <span class='hs-str'>"(stdin)"</span>
<a name="line-87"></a><span class='hs-definition'>readJournalFile</span> <span class='hs-varid'>format</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-88"></a> <span class='hs-varid'>ensureJournalFile</span> <span class='hs-varid'>f</span>
<a name="line-89"></a> <span class='hs-varid'>withFile</span> <span class='hs-varid'>f</span> <span class='hs-conid'>ReadMode</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>h</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>hGetContents</span> <span class='hs-varid'>h</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>journalFromPathAndString</span> <span class='hs-varid'>format</span> <span class='hs-varid'>f</span>
<a name="line-90"></a>
<a name="line-91"></a><a name="ensureJournalFile"></a><span class='hs-comment'>-- | Ensure there is a journal at the given file path, creating an empty one if needed.</span>
<a name="line-92"></a><span class='hs-definition'>ensureJournalFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-93"></a><span class='hs-definition'>ensureJournalFile</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-94"></a> <span class='hs-varid'>exists</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>doesFileExist</span> <span class='hs-varid'>f</span>
<a name="line-95"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>not</span> <span class='hs-varid'>exists</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-96"></a> <span class='hs-varid'>hPrintf</span> <span class='hs-varid'>stderr</span> <span class='hs-str'>"No journal file \"%s\", creating it.\n"</span> <span class='hs-varid'>f</span>
<a name="line-97"></a> <span class='hs-varid'>hPrintf</span> <span class='hs-varid'>stderr</span> <span class='hs-str'>"Edit this file or use \"hledger add\" or \"hledger web\" to add transactions.\n"</span>
<a name="line-98"></a> <span class='hs-varid'>emptyJournal</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>writeFile</span> <span class='hs-varid'>f</span>
<a name="line-99"></a>
<a name="line-100"></a><a name="emptyJournal"></a><span class='hs-comment'>-- | Give the content for a new auto-created journal file.</span>
<a name="line-101"></a><span class='hs-definition'>emptyJournal</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>String</span>
<a name="line-102"></a><span class='hs-definition'>emptyJournal</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-103"></a> <span class='hs-varid'>d</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getCurrentDay</span>
<a name="line-104"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>printf</span> <span class='hs-str'>"; journal created %s by hledger\n\n"</span> <span class='hs-layout'>(</span><span class='hs-varid'>show</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span>
<a name="line-105"></a>
<a name="line-106"></a><a name="readJournal"></a><span class='hs-comment'>-- | Read a Journal from this string, using the specified data format or</span>
<a name="line-107"></a><span class='hs-comment'>-- trying all known formats, or give an error string.</span>
<a name="line-108"></a><span class='hs-definition'>readJournal</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Either</span> <span class='hs-conid'>String</span> <span class='hs-conid'>Journal</span><span class='hs-layout'>)</span>
<a name="line-109"></a><span class='hs-definition'>readJournal</span> <span class='hs-varid'>format</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>journalFromPathAndString</span> <span class='hs-varid'>format</span> <span class='hs-str'>"(string)"</span> <span class='hs-varid'>s</span>
<a name="line-110"></a>
<a name="line-111"></a><a name="myJournalPath"></a><span class='hs-comment'>-- | Get the user's journal file path. Like ledger, we look first for the</span>
<a name="line-112"></a><span class='hs-comment'>-- LEDGER_FILE environment variable, and if that does not exist, for the</span>
<a name="line-113"></a><span class='hs-comment'>-- legacy LEDGER environment variable. If neither is set, or the value is</span>
<a name="line-114"></a><span class='hs-comment'>-- blank, return the default journal file path, which is</span>
<a name="line-115"></a><span class='hs-comment'>-- ".hledger.journal" in the users's home directory, or if we cannot</span>
<a name="line-116"></a><span class='hs-comment'>-- determine that, in the current directory.</span>
<a name="line-117"></a><span class='hs-definition'>myJournalPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>String</span>
<a name="line-118"></a><span class='hs-definition'>myJournalPath</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-119"></a> <span class='hs-varid'>s</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>envJournalPath</span>
<a name="line-120"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>s</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>defaultJournalPath</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-varid'>s</span>
<a name="line-121"></a> <span class='hs-keyword'>where</span>
<a name="line-122"></a> <span class='hs-varid'>envJournalPath</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getEnv</span> <span class='hs-varid'>journalenvvar</span> <span class='hs-varop'>`catch`</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>getEnv</span> <span class='hs-varid'>journalenvvar2</span> <span class='hs-varop'>`catch`</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-123"></a> <span class='hs-varid'>defaultJournalPath</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-124"></a> <span class='hs-varid'>home</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getHomeDirectory</span> <span class='hs-varop'>`catch`</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span>
<a name="line-125"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>home</span> <span class='hs-varop'></></span> <span class='hs-varid'>journaldefaultfilename</span>
<a name="line-126"></a>
<a name="line-127"></a><a name="myTimelogPath"></a><span class='hs-comment'>-- | Get the user's default timelog file path.</span>
<a name="line-128"></a><span class='hs-definition'>myTimelogPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>String</span>
<a name="line-129"></a><span class='hs-definition'>myTimelogPath</span> <span class='hs-keyglyph'>=</span>
<a name="line-130"></a> <span class='hs-varid'>getEnv</span> <span class='hs-varid'>timelogenvvar</span> <span class='hs-varop'>`catch`</span>
<a name="line-131"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-132"></a> <span class='hs-varid'>home</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getHomeDirectory</span>
<a name="line-133"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>home</span> <span class='hs-varop'></></span> <span class='hs-varid'>timelogdefaultfilename</span><span class='hs-layout'>)</span>
<a name="line-134"></a>
<a name="line-135"></a><a name="myJournal"></a><span class='hs-comment'>-- | Read the user's default journal file, or give an error.</span>
<a name="line-136"></a><span class='hs-definition'>myJournal</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Journal</span>
<a name="line-137"></a><span class='hs-definition'>myJournal</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>myJournalPath</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>readJournalFile</span> <span class='hs-conid'>Nothing</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>either</span> <span class='hs-varid'>error'</span> <span class='hs-varid'>return</span>
<a name="line-138"></a>
<a name="line-139"></a><a name="myTimelog"></a><span class='hs-comment'>-- | Read the user's default timelog file, or give an error.</span>
<a name="line-140"></a><span class='hs-definition'>myTimelog</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Journal</span>
<a name="line-141"></a><span class='hs-definition'>myTimelog</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>myTimelogPath</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>readJournalFile</span> <span class='hs-conid'>Nothing</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>either</span> <span class='hs-varid'>error'</span> <span class='hs-varid'>return</span>
<a name="line-142"></a>
<a name="line-143"></a><a name="tests_Hledger_Read"></a><span class='hs-definition'>tests_Hledger_Read</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestList</span>
<a name="line-144"></a> <span class='hs-keyglyph'>[</span>
<a name="line-145"></a> <span class='hs-varid'>tests_Hledger_Read_JournalReader</span><span class='hs-layout'>,</span>
<a name="line-146"></a> <span class='hs-varid'>tests_Hledger_Read_TimelogReader</span><span class='hs-layout'>,</span>
<a name="line-147"></a>
<a name="line-148"></a> <span class='hs-str'>"journalFile"</span> <span class='hs-varop'>~:</span> <span class='hs-keyword'>do</span>
<a name="line-149"></a> <span class='hs-varid'>assertBool</span> <span class='hs-str'>"journalFile should parse an empty file"</span> <span class='hs-layout'>(</span><span class='hs-varid'>isRight</span> <span class='hs-varop'>$</span> <span class='hs-varid'>parseWithCtx</span> <span class='hs-varid'>nullctx</span> <span class='hs-conid'>JournalReader</span><span class='hs-varop'>.</span><span class='hs-varid'>journalFile</span> <span class='hs-str'>""</span><span class='hs-layout'>)</span>
<a name="line-150"></a> <span class='hs-varid'>jE</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readJournal</span> <span class='hs-conid'>Nothing</span> <span class='hs-str'>""</span> <span class='hs-comment'>-- don't know how to get it from journalFile</span>
<a name="line-151"></a> <span class='hs-varid'>either</span> <span class='hs-varid'>error'</span> <span class='hs-layout'>(</span><span class='hs-varid'>assertBool</span> <span class='hs-str'>"journalFile parsing an empty file should give an empty journal"</span> <span class='hs-varop'>.</span> <span class='hs-varid'>null</span> <span class='hs-varop'>.</span> <span class='hs-varid'>jtxns</span><span class='hs-layout'>)</span> <span class='hs-varid'>jE</span>
<a name="line-152"></a>
<a name="line-153"></a> <span class='hs-keyglyph'>]</span>
</pre></body>
</html>
