<?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/TimelogReader.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>A reader for the timelog file format generated by timeclock.el.
<a name="line-5"></a>
<a name="line-6"></a>From timeclock.el 2.6:
<a name="line-7"></a>
<a name="line-8"></a>@
<a name="line-9"></a>A timelog contains data in the form of a single entry per line.
<a name="line-10"></a>Each entry has the form:
<a name="line-11"></a>
<a name="line-12"></a> CODE YYYY/MM/DD HH:MM:SS [COMMENT]
<a name="line-13"></a>
<a name="line-14"></a>CODE is one of: b, h, i, o or O. COMMENT is optional when the code is
<a name="line-15"></a>i, o or O. The meanings of the codes are:
<a name="line-16"></a>
<a name="line-17"></a> b Set the current time balance, or \"time debt\". Useful when
<a name="line-18"></a> archiving old log data, when a debt must be carried forward.
<a name="line-19"></a> The COMMENT here is the number of seconds of debt.
<a name="line-20"></a>
<a name="line-21"></a> h Set the required working time for the given day. This must
<a name="line-22"></a> be the first entry for that day. The COMMENT in this case is
<a name="line-23"></a> the number of hours in this workday. Floating point amounts
<a name="line-24"></a> are allowed.
<a name="line-25"></a>
<a name="line-26"></a> i Clock in. The COMMENT in this case should be the name of the
<a name="line-27"></a> project worked on.
<a name="line-28"></a>
<a name="line-29"></a> o Clock out. COMMENT is unnecessary, but can be used to provide
<a name="line-30"></a> a description of how the period went, for example.
<a name="line-31"></a>
<a name="line-32"></a> O Final clock out. Whatever project was being worked on, it is
<a name="line-33"></a> now finished. Useful for creating summary reports.
<a name="line-34"></a>@
<a name="line-35"></a>
<a name="line-36"></a>Example:
<a name="line-37"></a>
<a name="line-38"></a>@
<a name="line-39"></a>i 2007/03/10 12:26:00 hledger
<a name="line-40"></a>o 2007/03/10 17:26:02
<a name="line-41"></a>@
<a name="line-42"></a>
<a name="line-43"></a>-}</span>
<a name="line-44"></a>
<a name="line-45"></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'>TimelogReader</span> <span class='hs-layout'>(</span>
<a name="line-46"></a> <span class='hs-varid'>reader</span><span class='hs-layout'>,</span>
<a name="line-47"></a> <span class='hs-varid'>tests_Hledger_Read_TimelogReader</span>
<a name="line-48"></a><span class='hs-layout'>)</span>
<a name="line-49"></a><span class='hs-keyword'>where</span>
<a name="line-50"></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> <span class='hs-layout'>(</span><span class='hs-conid'>ErrorT</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-51"></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> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-varid'>parse</span><span class='hs-layout'>)</span>
<a name="line-52"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Hledger</span><span class='hs-varop'>.</span><span class='hs-conid'>Data</span>
<a name="line-53"></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'>Utils</span>
<a name="line-54"></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-layout'>(</span><span class='hs-varid'>ledgerExclamationDirective</span><span class='hs-layout'>,</span> <span class='hs-varid'>ledgerHistoricalPrice</span><span class='hs-layout'>,</span>
<a name="line-55"></a> <span class='hs-varid'>ledgerDefaultYear</span><span class='hs-layout'>,</span> <span class='hs-varid'>emptyLine</span><span class='hs-layout'>,</span> <span class='hs-varid'>ledgerdatetime</span><span class='hs-layout'>)</span>
<a name="line-56"></a>
<a name="line-57"></a>
<a name="line-58"></a><a name="reader"></a><span class='hs-definition'>reader</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Reader</span>
<a name="line-59"></a><span class='hs-definition'>reader</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Reader</span> <span class='hs-varid'>format</span> <span class='hs-varid'>detect</span> <span class='hs-varid'>parse</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="format"></a><span class='hs-definition'>format</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-62"></a><span class='hs-definition'>format</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"timelog"</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="detect"></a><span class='hs-comment'>-- | Does the given file path and data provide timeclock.el's timelog format ?</span>
<a name="line-65"></a><span class='hs-definition'>detect</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'>Bool</span>
<a name="line-66"></a><span class='hs-definition'>detect</span> <span class='hs-varid'>f</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fileSuffix</span> <span class='hs-varid'>f</span> <span class='hs-varop'>==</span> <span class='hs-varid'>format</span>
<a name="line-67"></a>
<a name="line-68"></a><a name="parse"></a><span class='hs-comment'>-- | Parse and post-process a "Journal" from timeclock.el's timelog</span>
<a name="line-69"></a><span class='hs-comment'>-- format, saving the provided file path and the current time, or give an</span>
<a name="line-70"></a><span class='hs-comment'>-- error.</span>
<a name="line-71"></a><span class='hs-definition'>parse</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-72"></a><span class='hs-definition'>parse</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>parseJournalWith</span> <span class='hs-varid'>timelogFile</span>
<a name="line-73"></a>
<a name="line-74"></a><a name="timelogFile"></a><span class='hs-definition'>timelogFile</span> <span class='hs-keyglyph'>::</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>
<a name="line-75"></a><span class='hs-definition'>timelogFile</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>items</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>many</span> <span class='hs-varid'>timelogItem</span>
<a name="line-76"></a> <span class='hs-varid'>eof</span>
<a name="line-77"></a> <span class='hs-varid'>ctx</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getState</span>
<a name="line-78"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</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'>items</span><span class='hs-layout'>,</span> <span class='hs-varid'>ctx</span><span class='hs-layout'>)</span>
<a name="line-79"></a> <span class='hs-keyword'>where</span>
<a name="line-80"></a> <span class='hs-comment'>-- As all ledger line types can be distinguished by the first</span>
<a name="line-81"></a> <span class='hs-comment'>-- character, excepting transactions versus empty (blank or</span>
<a name="line-82"></a> <span class='hs-comment'>-- comment-only) lines, can use choice w/o try</span>
<a name="line-83"></a> <span class='hs-varid'>timelogItem</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>choice</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>ledgerExclamationDirective</span>
<a name="line-84"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-varop'>.</span> <span class='hs-varid'>addHistoricalPrice</span><span class='hs-layout'>)</span> <span class='hs-varid'>ledgerHistoricalPrice</span>
<a name="line-85"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>ledgerDefaultYear</span>
<a name="line-86"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>emptyLine</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span>
<a name="line-87"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-varop'>.</span> <span class='hs-varid'>addTimeLogEntry</span><span class='hs-layout'>)</span> <span class='hs-varid'>timelogentry</span>
<a name="line-88"></a> <span class='hs-keyglyph'>]</span> <span class='hs-varop'><?></span> <span class='hs-str'>"timelog entry, or default year or historical price directive"</span>
<a name="line-89"></a>
<a name="line-90"></a><a name="timelogentry"></a><span class='hs-comment'>-- | Parse a timelog entry.</span>
<a name="line-91"></a><span class='hs-definition'>timelogentry</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>GenParser</span> <span class='hs-conid'>Char</span> <span class='hs-conid'>JournalContext</span> <span class='hs-conid'>TimeLogEntry</span>
<a name="line-92"></a><span class='hs-definition'>timelogentry</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-93"></a> <span class='hs-varid'>code</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>oneOf</span> <span class='hs-str'>"bhioO"</span>
<a name="line-94"></a> <span class='hs-varid'>many1</span> <span class='hs-varid'>spacenonewline</span>
<a name="line-95"></a> <span class='hs-varid'>datetime</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>ledgerdatetime</span>
<a name="line-96"></a> <span class='hs-varid'>comment</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>optionMaybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>many1</span> <span class='hs-varid'>spacenonewline</span> <span class='hs-varop'>>></span> <span class='hs-varid'>liftM2</span> <span class='hs-layout'>(</span><span class='hs-varop'>++</span><span class='hs-layout'>)</span> <span class='hs-varid'>getParentAccount</span> <span class='hs-varid'>restofline</span><span class='hs-layout'>)</span>
<a name="line-97"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>TimeLogEntry</span> <span class='hs-layout'>(</span><span class='hs-varid'>read</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>code</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-varid'>datetime</span> <span class='hs-layout'>(</span><span class='hs-varid'>maybe</span> <span class='hs-str'>""</span> <span class='hs-varid'>rstrip</span> <span class='hs-varid'>comment</span><span class='hs-layout'>)</span>
<a name="line-98"></a>
<a name="line-99"></a><a name="tests_Hledger_Read_TimelogReader"></a><span class='hs-definition'>tests_Hledger_Read_TimelogReader</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestList</span> <span class='hs-keyglyph'>[</span>
<a name="line-100"></a> <span class='hs-keyglyph'>]</span>
<a name="line-101"></a>
</pre></body>
</html>
