<?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/Data/Commodity.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-|
<a name="line-2"></a>
<a name="line-3"></a>A 'Commodity' is a symbol representing a currency or some other kind of
<a name="line-4"></a>thing we are tracking, and some display preferences that tell how to
<a name="line-5"></a>display 'Amount's of the commodity - is the symbol on the left or right,
<a name="line-6"></a>are thousands separated by comma, significant decimal places and so on.
<a name="line-7"></a>
<a name="line-8"></a>-}</span>
<a name="line-9"></a><span class='hs-keyword'>module</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'>Commodity</span>
<a name="line-10"></a><span class='hs-keyword'>where</span>
<a name="line-11"></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-12"></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>
<a name="line-13"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Map</span>
<a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</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-15"></a>
<a name="line-16"></a>
<a name="line-17"></a><a name="nonsimplecommoditychars"></a><span class='hs-definition'>nonsimplecommoditychars</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"0123456789-.@;\n \""</span>
<a name="line-18"></a>
<a name="line-19"></a><a name="quoteCommoditySymbolIfNeeded"></a><span class='hs-definition'>quoteCommoditySymbolIfNeeded</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>any</span> <span class='hs-layout'>(</span><span class='hs-varop'>`elem`</span> <span class='hs-varid'>nonsimplecommoditychars</span><span class='hs-layout'>)</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"\""</span> <span class='hs-varop'>++</span> <span class='hs-varid'>s</span> <span class='hs-varop'>++</span> <span class='hs-str'>"\""</span>
<a name="line-20"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>s</span>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-comment'>-- convenient amount and commodity constructors, for tests etc.</span>
<a name="line-23"></a>
<a name="line-24"></a><a name="unknown"></a><span class='hs-definition'>unknown</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Commodity</span> <span class='hs-layout'>{</span><span class='hs-varid'>symbol</span><span class='hs-keyglyph'>=</span><span class='hs-str'>""</span><span class='hs-layout'>,</span> <span class='hs-varid'>side</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>L</span><span class='hs-layout'>,</span><span class='hs-varid'>spaced</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>False</span><span class='hs-layout'>,</span><span class='hs-varid'>decimalpoint</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>'.'</span><span class='hs-layout'>,</span><span class='hs-varid'>precision</span><span class='hs-keyglyph'>=</span><span class='hs-num'>0</span><span class='hs-layout'>,</span><span class='hs-varid'>separator</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>','</span><span class='hs-layout'>,</span><span class='hs-varid'>separatorpositions</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>[]</span><span class='hs-layout'>}</span>
<a name="line-25"></a><a name="dollar"></a><span class='hs-definition'>dollar</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Commodity</span> <span class='hs-layout'>{</span><span class='hs-varid'>symbol</span><span class='hs-keyglyph'>=</span><span class='hs-str'>"$"</span><span class='hs-layout'>,</span><span class='hs-varid'>side</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>L</span><span class='hs-layout'>,</span><span class='hs-varid'>spaced</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>False</span><span class='hs-layout'>,</span><span class='hs-varid'>decimalpoint</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>'.'</span><span class='hs-layout'>,</span><span class='hs-varid'>precision</span><span class='hs-keyglyph'>=</span><span class='hs-num'>2</span><span class='hs-layout'>,</span><span class='hs-varid'>separator</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>','</span><span class='hs-layout'>,</span><span class='hs-varid'>separatorpositions</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>[]</span><span class='hs-layout'>}</span>
<a name="line-26"></a><a name="euro"></a><span class='hs-definition'>euro</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Commodity</span> <span class='hs-layout'>{</span><span class='hs-varid'>symbol</span><span class='hs-keyglyph'>=</span><span class='hs-str'>"€"</span><span class='hs-layout'>,</span><span class='hs-varid'>side</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>L</span><span class='hs-layout'>,</span><span class='hs-varid'>spaced</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>False</span><span class='hs-layout'>,</span><span class='hs-varid'>decimalpoint</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>'.'</span><span class='hs-layout'>,</span><span class='hs-varid'>precision</span><span class='hs-keyglyph'>=</span><span class='hs-num'>2</span><span class='hs-layout'>,</span><span class='hs-varid'>separator</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>','</span><span class='hs-layout'>,</span><span class='hs-varid'>separatorpositions</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>[]</span><span class='hs-layout'>}</span>
<a name="line-27"></a><a name="pound"></a><span class='hs-definition'>pound</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Commodity</span> <span class='hs-layout'>{</span><span class='hs-varid'>symbol</span><span class='hs-keyglyph'>=</span><span class='hs-str'>"£"</span><span class='hs-layout'>,</span><span class='hs-varid'>side</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>L</span><span class='hs-layout'>,</span><span class='hs-varid'>spaced</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>False</span><span class='hs-layout'>,</span><span class='hs-varid'>decimalpoint</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>'.'</span><span class='hs-layout'>,</span><span class='hs-varid'>precision</span><span class='hs-keyglyph'>=</span><span class='hs-num'>2</span><span class='hs-layout'>,</span><span class='hs-varid'>separator</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>','</span><span class='hs-layout'>,</span><span class='hs-varid'>separatorpositions</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>[]</span><span class='hs-layout'>}</span>
<a name="line-28"></a><a name="hour"></a><span class='hs-definition'>hour</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Commodity</span> <span class='hs-layout'>{</span><span class='hs-varid'>symbol</span><span class='hs-keyglyph'>=</span><span class='hs-str'>"h"</span><span class='hs-layout'>,</span><span class='hs-varid'>side</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>R</span><span class='hs-layout'>,</span><span class='hs-varid'>spaced</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>False</span><span class='hs-layout'>,</span><span class='hs-varid'>decimalpoint</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>'.'</span><span class='hs-layout'>,</span><span class='hs-varid'>precision</span><span class='hs-keyglyph'>=</span><span class='hs-num'>1</span><span class='hs-layout'>,</span><span class='hs-varid'>separator</span><span class='hs-keyglyph'>=</span><span class='hs-chr'>','</span><span class='hs-layout'>,</span><span class='hs-varid'>separatorpositions</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>[]</span><span class='hs-layout'>}</span>
<a name="line-29"></a>
<a name="line-30"></a><a name="dollars"></a><span class='hs-definition'>dollars</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Amount</span> <span class='hs-varid'>dollar</span> <span class='hs-varid'>n</span> <span class='hs-conid'>Nothing</span>
<a name="line-31"></a><a name="euros"></a><span class='hs-definition'>euros</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Amount</span> <span class='hs-varid'>euro</span> <span class='hs-varid'>n</span> <span class='hs-conid'>Nothing</span>
<a name="line-32"></a><a name="pounds"></a><span class='hs-definition'>pounds</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Amount</span> <span class='hs-varid'>pound</span> <span class='hs-varid'>n</span> <span class='hs-conid'>Nothing</span>
<a name="line-33"></a><a name="hours"></a><span class='hs-definition'>hours</span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Amount</span> <span class='hs-varid'>hour</span> <span class='hs-varid'>n</span> <span class='hs-conid'>Nothing</span>
<a name="line-34"></a>
<a name="line-35"></a><a name="defaultcommodities"></a><span class='hs-definition'>defaultcommodities</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>dollar</span><span class='hs-layout'>,</span> <span class='hs-varid'>euro</span><span class='hs-layout'>,</span> <span class='hs-varid'>pound</span><span class='hs-layout'>,</span> <span class='hs-varid'>hour</span><span class='hs-layout'>,</span> <span class='hs-varid'>unknown</span><span class='hs-keyglyph'>]</span>
<a name="line-36"></a>
<a name="line-37"></a><a name="comm"></a><span class='hs-comment'>-- | Look up one of the hard-coded default commodities. For use in tests.</span>
<a name="line-38"></a><span class='hs-definition'>comm</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Commodity</span>
<a name="line-39"></a><span class='hs-definition'>comm</span> <span class='hs-varid'>sym</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromMaybe</span>
<a name="line-40"></a> <span class='hs-layout'>(</span><span class='hs-varid'>error'</span> <span class='hs-str'>"commodity lookup failed"</span><span class='hs-layout'>)</span>
<a name="line-41"></a> <span class='hs-varop'>$</span> <span class='hs-varid'>find</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Commodity</span><span class='hs-layout'>{</span><span class='hs-varid'>symbol</span><span class='hs-keyglyph'>=</span><span class='hs-varid'>s</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>s</span><span class='hs-varop'>==</span><span class='hs-varid'>sym</span><span class='hs-layout'>)</span> <span class='hs-varid'>defaultcommodities</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="conversionRate"></a><span class='hs-comment'>-- | Find the conversion rate between two commodities. Currently returns 1.</span>
<a name="line-44"></a><span class='hs-definition'>conversionRate</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Commodity</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Commodity</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Double</span>
<a name="line-45"></a><span class='hs-definition'>conversionRate</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>1</span>
<a name="line-46"></a>
<a name="line-47"></a><a name="canonicaliseCommodities"></a><span class='hs-comment'>-- | Convert a list of commodities to a map from commodity symbols to</span>
<a name="line-48"></a><span class='hs-comment'>-- unique, display-preference-canonicalised commodities.</span>
<a name="line-49"></a><span class='hs-definition'>canonicaliseCommodities</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Commodity</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-conid'>String</span> <span class='hs-conid'>Commodity</span>
<a name="line-50"></a><span class='hs-definition'>canonicaliseCommodities</span> <span class='hs-varid'>cs</span> <span class='hs-keyglyph'>=</span>
<a name="line-51"></a> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>s</span><span class='hs-layout'>,</span><span class='hs-varid'>firstc</span><span class='hs-layout'>{</span><span class='hs-varid'>precision</span><span class='hs-keyglyph'>=</span><span class='hs-varid'>maxp</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>symbols</span><span class='hs-layout'>,</span>
<a name="line-52"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>cs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>commoditymap</span> <span class='hs-varop'>!</span> <span class='hs-varid'>s</span><span class='hs-layout'>,</span>
<a name="line-53"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>firstc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>head</span> <span class='hs-varid'>cs</span><span class='hs-layout'>,</span>
<a name="line-54"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>maxp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maximum</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-varid'>precision</span> <span class='hs-varid'>cs</span>
<a name="line-55"></a> <span class='hs-keyglyph'>]</span>
<a name="line-56"></a> <span class='hs-keyword'>where</span>
<a name="line-57"></a> <span class='hs-varid'>commoditymap</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Map</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>s</span><span class='hs-layout'>,</span> <span class='hs-varid'>commoditieswithsymbol</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>symbols</span><span class='hs-keyglyph'>]</span>
<a name="line-58"></a> <span class='hs-varid'>commoditieswithsymbol</span> <span class='hs-varid'>s</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'>symbol</span><span class='hs-layout'>)</span> <span class='hs-varid'>cs</span>
<a name="line-59"></a> <span class='hs-varid'>symbols</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nub</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-varid'>symbol</span> <span class='hs-varid'>cs</span>
<a name="line-60"></a>
<a name="line-61"></a><a name="tests_Hledger_Data_Commodity"></a><span class='hs-definition'>tests_Hledger_Data_Commodity</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestList</span> <span class='hs-keyglyph'>[</span>
<a name="line-62"></a> <span class='hs-keyglyph'>]</span>
<a name="line-63"></a>
</pre></body>
</html>
