cf3d21afef
- The CSV reader no longer writes a "(stdin).rules" file when reading from stdin. - Selection of reader(s) is now smarter when input is coming from stdin. Previously, all readers were considered applicable for stdin. This meant that when reading a CSV file from stdin, the journal and timelog readers were always tried first, and if the CSV file was unparseable, you'd see the first (journal) reader's error instead of the CSV reader's. Now, the readers do some basic content sniffing when reading stdin, so it generally tries only the one right reader and we'll see the right errors. - The read system now has more debug output.
112 lines
3.6 KiB
Haskell
112 lines
3.6 KiB
Haskell
{-|
|
|
|
|
A reader for the timelog file format generated by timeclock.el
|
|
(<http://www.emacswiki.org/emacs/TimeClock>). Example:
|
|
|
|
@
|
|
i 2007\/03\/10 12:26:00 hledger
|
|
o 2007\/03\/10 17:26:02
|
|
@
|
|
|
|
From timeclock.el 2.6:
|
|
|
|
@
|
|
A timelog contains data in the form of a single entry per line.
|
|
Each entry has the form:
|
|
|
|
CODE YYYY/MM/DD HH:MM:SS [COMMENT]
|
|
|
|
CODE is one of: b, h, i, o or O. COMMENT is optional when the code is
|
|
i, o or O. The meanings of the codes are:
|
|
|
|
b Set the current time balance, or \"time debt\". Useful when
|
|
archiving old log data, when a debt must be carried forward.
|
|
The COMMENT here is the number of seconds of debt.
|
|
|
|
h Set the required working time for the given day. This must
|
|
be the first entry for that day. The COMMENT in this case is
|
|
the number of hours in this workday. Floating point amounts
|
|
are allowed.
|
|
|
|
i Clock in. The COMMENT in this case should be the name of the
|
|
project worked on.
|
|
|
|
o Clock out. COMMENT is unnecessary, but can be used to provide
|
|
a description of how the period went, for example.
|
|
|
|
O Final clock out. Whatever project was being worked on, it is
|
|
now finished. Useful for creating summary reports.
|
|
@
|
|
|
|
-}
|
|
|
|
module Hledger.Read.TimelogReader (
|
|
-- * Reader
|
|
reader,
|
|
-- * Tests
|
|
tests_Hledger_Read_TimelogReader
|
|
)
|
|
where
|
|
import Control.Monad
|
|
import Control.Monad.Error
|
|
import Data.List (isPrefixOf)
|
|
import Test.HUnit
|
|
import Text.ParserCombinators.Parsec hiding (parse)
|
|
import System.FilePath
|
|
|
|
import Hledger.Data
|
|
-- XXX too much reuse ?
|
|
import Hledger.Read.JournalReader (
|
|
directive, historicalpricedirective, defaultyeardirective, emptyorcommentlinep, datetimep,
|
|
parseJournalWith, getParentAccount
|
|
)
|
|
import Hledger.Utils
|
|
|
|
|
|
reader :: Reader
|
|
reader = Reader format detect parse
|
|
|
|
format :: String
|
|
format = "timelog"
|
|
|
|
-- | Does the given file path and data look like it might be timeclock.el's timelog format ?
|
|
detect :: FilePath -> String -> Bool
|
|
detect f s
|
|
| f /= "-" = takeExtension f == '.':format -- from a file: yes if the extension is .timelog
|
|
| otherwise = "i " `isPrefixOf` s || "o " `isPrefixOf` s -- from stdin: yes if it starts with "i " or "o "
|
|
|
|
-- | Parse and post-process a "Journal" from timeclock.el's timelog
|
|
-- format, saving the provided file path and the current time, or give an
|
|
-- error.
|
|
parse :: Maybe FilePath -> FilePath -> String -> ErrorT String IO Journal
|
|
parse _ = parseJournalWith timelogFile
|
|
|
|
timelogFile :: GenParser Char JournalContext (JournalUpdate,JournalContext)
|
|
timelogFile = do items <- many timelogItem
|
|
eof
|
|
ctx <- getState
|
|
return (liftM (foldr (.) id) $ sequence items, ctx)
|
|
where
|
|
-- As all ledger line types can be distinguished by the first
|
|
-- character, excepting transactions versus empty (blank or
|
|
-- comment-only) lines, can use choice w/o try
|
|
timelogItem = choice [ directive
|
|
, liftM (return . addHistoricalPrice) historicalpricedirective
|
|
, defaultyeardirective
|
|
, emptyorcommentlinep >> return (return id)
|
|
, liftM (return . addTimeLogEntry) timelogentry
|
|
] <?> "timelog entry, or default year or historical price directive"
|
|
|
|
-- | Parse a timelog entry.
|
|
timelogentry :: GenParser Char JournalContext TimeLogEntry
|
|
timelogentry = do
|
|
code <- oneOf "bhioO"
|
|
many1 spacenonewline
|
|
datetime <- datetimep
|
|
comment <- optionMaybe (many1 spacenonewline >> liftM2 (++) getParentAccount restofline)
|
|
return $ TimeLogEntry (read [code]) datetime (maybe "" rstrip comment)
|
|
|
|
tests_Hledger_Read_TimelogReader = TestList [
|
|
]
|
|
|