diff --git a/CHANGES b/CHANGES new file mode 100644 --- /dev/null +++ b/CHANGES @@ -0,0 +1,27 @@ +User-visible changes in hledger-ui. +See also hledger's change log. + +0.27 (unreleased) + +- hledger-ui is a new curses-style UI, intended to be a standard part + of the hledger toolset for all users (except on native MS Windows, + where the vty lib is not yet supported). + + The UI is quite simple, allowing just browsing of accounts and + transactions, but it has a number of improvements over the old + hledger-vty, which it replaces: + + - adapts to screen size + - handles wide characters + - shows multi-commodity amounts on one line + - manages cursor and scroll position better + - allows depth adjustment + - allows --flat toggle + - allows --cleared toggle + - allows journal reloading + - shows a more useful transaction register, like hledger-web + - offers multiple color themes + - includes some built-in help + + hledger-ui is built with brick, a new higher-level UI library based + on vty, making it relatively easy to grow and maintain. diff --git a/Hledger/UI.hs b/Hledger/UI.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI.hs @@ -0,0 +1,23 @@ +{-| +Re-export the modules of the hledger-ui program. +-} + +module Hledger.UI ( + module Hledger.UI.Main, + module Hledger.UI.UIOptions, + module Hledger.UI.Theme, + tests_Hledger_UI + ) +where +import Test.HUnit + +import Hledger.UI.Main +import Hledger.UI.UIOptions +import Hledger.UI.Theme + +tests_Hledger_UI :: Test +tests_Hledger_UI = TestList + [ + -- tests_Hledger_UI_Main + -- tests_Hledger_UI_UIOptions + ] diff --git a/Hledger/UI/AccountsScreen.hs b/Hledger/UI/AccountsScreen.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/AccountsScreen.hs @@ -0,0 +1,309 @@ +-- The accounts screen, showing accounts and balances like the CLI balance command. + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} + +module Hledger.UI.AccountsScreen + (screen + ,initAccountsScreen + ,asSetSelectedAccount + ) +where + +import Control.Lens ((^.)) +-- import Control.Monad +import Control.Monad.IO.Class (liftIO) +-- import Data.Default +import Data.List +import Data.Maybe +import Data.Monoid +import Data.Time.Calendar (Day) +import System.FilePath (takeFileName) +import qualified Data.Vector as V +import Graphics.Vty as Vty +import Brick +import Brick.Widgets.List +import Brick.Widgets.Border (borderAttr) +-- import Brick.Widgets.Center + +import Hledger +import Hledger.Cli hiding (progname,prognameandversion,green) +-- import Hledger.Cli.CliOptions (defaultBalanceLineFormat) +import Hledger.UI.UIOptions +-- import Hledger.UI.Theme +import Hledger.UI.UITypes +import Hledger.UI.UIUtils +import qualified Hledger.UI.RegisterScreen as RS (screen, rsSetCurrentAccount) +import qualified Hledger.UI.ErrorScreen as ES (screen) + +screen = AccountsScreen{ + asState = (list "accounts" V.empty 1, "") + ,sInitFn = initAccountsScreen + ,sDrawFn = drawAccountsScreen + ,sHandleFn = handleAccountsScreen + } + +asSetSelectedAccount a scr@AccountsScreen{asState=(l,_)} = scr{asState=(l,a)} +asSetSelectedAccount _ scr = scr + +initAccountsScreen :: Day -> AppState -> AppState +initAccountsScreen d st@AppState{ + aopts=uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts}}, + ajournal=j, + aScreen=s@AccountsScreen{asState=(_,selacct)} + } = + st{aopts=uopts', aScreen=s{asState=(l',selacct)}} + where + l = list (Name "accounts") (V.fromList displayitems) 1 + + -- keep the selection near the last known selected account if possible + l' | null selacct = l + | otherwise = maybe l (flip listMoveTo l) midx + where + midx = findIndex (\((a,_,_),_) -> a==selacctclipped) items + selacctclipped = case depth_ ropts of + Nothing -> selacct + Just d -> clipAccountName d selacct + + uopts' = uopts{cliopts_=copts{reportopts_=ropts'}} + ropts' = ropts { + -- XXX balanceReport doesn't respect this yet + balancetype_=HistoricalBalance + } + + q = queryFromOpts d ropts + + -- maybe convert balances to market value + convert | value_ ropts' = balanceReportValue j valuedate + | otherwise = id + where + valuedate = fromMaybe d $ queryEndDate False q + + -- run the report + (items,_total) = convert $ balanceReport ropts' q j + + -- pre-render the list items + displayitem ((fullacct, shortacct, indent), bal) = + (indent + ,fullacct + ,if flat_ ropts' then fullacct else shortacct + ,map showAmountWithoutPrice amts -- like showMixedAmountOneLineWithoutPrice + ) + where + Mixed amts = normaliseMixedAmountSquashPricesForDisplay $ stripPrices bal + stripPrices (Mixed as) = Mixed $ map stripprice as where stripprice a = a{aprice=NoPrice} + displayitems = map displayitem items + + +initAccountsScreen _ _ = error "init function called with wrong screen type, should not happen" + +drawAccountsScreen :: AppState -> [Widget] +drawAccountsScreen _st@AppState{aopts=uopts, ajournal=j, aScreen=AccountsScreen{asState=(l,_)}} = + [ui] + where + toplabel = files + <+> str " accounts" + <+> borderQueryStr querystr + <+> cleared + <+> borderDepthStr mdepth + <+> str " (" + <+> cur + <+> str "/" + <+> total + <+> str ")" + files = case journalFilePaths j of + [] -> str "" + f:_ -> withAttr ("border" <> "bold") $ str $ takeFileName f + -- [f,_:[]] -> (withAttr ("border" <> "bold") $ str $ takeFileName f) <+> str " (& 1 included file)" + -- f:fs -> (withAttr ("border" <> "bold") $ str $ takeFileName f) <+> str (" (& " ++ show (length fs) ++ " included files)") + querystr = query_ $ reportopts_ $ cliopts_ uopts + mdepth = depth_ $ reportopts_ $ cliopts_ uopts + cleared = if (cleared_ $ reportopts_ $ cliopts_ uopts) + then str " with " <+> withAttr (borderAttr <> "query") (str "cleared") <+> str " txns" + else str "" + cur = str (case l^.listSelectedL of + Nothing -> "-" + Just i -> show (i + 1)) + total = str $ show $ V.length $ l^.listElementsL + + bottomlabel = borderKeysStr [ + -- ("up/down/pgup/pgdown/home/end", "move") + ("-=1234567890", "depth") + ,("F", "flat?") + ,("C", "cleared?") + ,("right/enter", "register") + ,("g", "reload") + ,("q", "quit") + ] + + ui = Widget Greedy Greedy $ do + c <- getContext + let + availwidth = + -- ltrace "availwidth" $ + c^.availWidthL + - 2 -- XXX due to margin ? shouldn't be necessary (cf UIUtils) + displayitems = listElements l + maxacctwidthseen = + -- ltrace "maxacctwidthseen" $ + V.maximum $ + V.map (\(indent,_,displayacct,_) -> indent*2 + strWidth displayacct) $ + -- V.filter (\(indent,_,_,_) -> (indent-1) <= fromMaybe 99999 mdepth) $ + displayitems + maxbalwidthseen = + -- ltrace "maxbalwidthseen" $ + V.maximum $ V.map (\(_,_,_,amts) -> sum (map strWidth amts) + 2 * (length amts-1)) displayitems + maxbalwidth = + -- ltrace "maxbalwidth" $ + max 0 (availwidth - 2 - 4) -- leave 2 whitespace plus least 4 for accts + balwidth = + -- ltrace "balwidth" $ + min maxbalwidth maxbalwidthseen + maxacctwidth = + -- ltrace "maxacctwidth" $ + availwidth - 2 - balwidth + acctwidth = + -- ltrace "acctwidth" $ + min maxacctwidth maxacctwidthseen + + -- XXX how to minimise the balance column's jumping around + -- as you change the depth limit ? + + colwidths = (acctwidth, balwidth) + + render $ defaultLayout toplabel bottomlabel $ renderList l (drawAccountsItem colwidths) + +drawAccountsScreen _ = error "draw function called with wrong screen type, should not happen" + +drawAccountsItem :: (Int,Int) -> Bool -> (Int, String, String, [String]) -> Widget +drawAccountsItem (acctwidth, balwidth) selected (indent, _fullacct, displayacct, balamts) = + Widget Greedy Fixed $ do + -- c <- getContext + -- let showitem = intercalate "\n" . balanceReportItemAsText defreportopts fmt + render $ + addamts balamts $ + str (fitString (Just acctwidth) (Just acctwidth) True True $ replicate (2*indent) ' ' ++ displayacct) <+> + str " " <+> + str (balspace balamts) + where + balspace as = replicate n ' ' + where n = max 0 (balwidth - (sum (map strWidth as) + 2 * (length as - 1))) + addamts :: [String] -> Widget -> Widget + addamts [] w = w + addamts [a] w = (<+> renderamt a) w + -- foldl' :: (b -> a -> b) -> b -> t a -> b + -- foldl' (Widget -> String -> Widget) -> Widget -> [String] -> Widget + addamts (a:as) w = foldl' addamt (addamts [a] w) as + addamt :: Widget -> String -> Widget + addamt w a = ((<+> renderamt a) . (<+> str ", ")) w + renderamt :: String -> Widget + renderamt a | '-' `elem` a = withAttr (sel $ "list" <> "balance" <> "negative") $ str a + | otherwise = withAttr (sel $ "list" <> "balance" <> "positive") $ str a + sel | selected = (<> "selected") + | otherwise = id + +handleAccountsScreen :: AppState -> Vty.Event -> EventM (Next AppState) +handleAccountsScreen st@AppState{ + aScreen=scr@AccountsScreen{asState=(l,selacct)} + ,ajournal=j + } e = do + d <- liftIO getCurrentDay + -- c <- getContext + -- let h = c^.availHeightL + -- moveSel n l = listMoveBy n l + + -- before we go anywhere, remember the currently selected account. + -- (This is preserved across screen changes, unlike List's selection state) + let + selacct' = case listSelectedElement l of + Just (_, (_, fullacct, _, _)) -> fullacct + Nothing -> selacct + st' = st{aScreen=scr{asState=(l,selacct')}} + + case e of + Vty.EvKey Vty.KEsc [] -> halt st' + Vty.EvKey (Vty.KChar 'q') [] -> halt st' + -- Vty.EvKey (Vty.KChar 'l') [Vty.MCtrl] -> do + + Vty.EvKey (Vty.KChar 'g') [] -> do + ej <- liftIO $ journalReload j -- (ej, changed) <- liftIO $ journalReloadIfChanged copts j + case ej of + Right j' -> continue $ reload j' d st' + Left err -> continue $ screenEnter d ES.screen{esState=err} st' + + Vty.EvKey (Vty.KChar '-') [] -> continue $ reload j d $ decDepth st' + Vty.EvKey (Vty.KChar '+') [] -> continue $ reload j d $ incDepth st' + Vty.EvKey (Vty.KChar '=') [] -> continue $ reload j d $ incDepth st' + Vty.EvKey (Vty.KChar '1') [] -> continue $ reload j d $ setDepth 1 st' + Vty.EvKey (Vty.KChar '2') [] -> continue $ reload j d $ setDepth 2 st' + Vty.EvKey (Vty.KChar '3') [] -> continue $ reload j d $ setDepth 3 st' + Vty.EvKey (Vty.KChar '4') [] -> continue $ reload j d $ setDepth 4 st' + Vty.EvKey (Vty.KChar '5') [] -> continue $ reload j d $ setDepth 5 st' + Vty.EvKey (Vty.KChar '6') [] -> continue $ reload j d $ setDepth 6 st' + Vty.EvKey (Vty.KChar '7') [] -> continue $ reload j d $ setDepth 7 st' + Vty.EvKey (Vty.KChar '8') [] -> continue $ reload j d $ setDepth 8 st' + Vty.EvKey (Vty.KChar '9') [] -> continue $ reload j d $ setDepth 9 st' + Vty.EvKey (Vty.KChar '0') [] -> continue $ reload j d $ setDepth 0 st' + Vty.EvKey (Vty.KChar 'F') [] -> continue $ reload j d $ stToggleFlat st' + Vty.EvKey (Vty.KChar 'C') [] -> continue $ reload j d $ stToggleCleared st' + Vty.EvKey (Vty.KLeft) [] -> continue $ popScreen st' + Vty.EvKey (k) [] | k `elem` [Vty.KRight, Vty.KEnter] -> do + let + scr = RS.rsSetCurrentAccount selacct' RS.screen + st'' = screenEnter d scr st' + vScrollToBeginning $ viewportScroll "register" + continue st'' + + -- fall through to the list's event handler (handles up/down) + ev -> do + l' <- handleEvent ev l + continue $ st'{aScreen=scr{asState=(l',selacct')}} + -- continue =<< handleEventLensed st' someLens ev +handleAccountsScreen _ _ = error "event handler called with wrong screen type, should not happen" + +stToggleFlat :: AppState -> AppState +stToggleFlat st@AppState{aopts=uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts}}} = + st{aopts=uopts{cliopts_=copts{reportopts_=toggleFlatMode ropts}}} + +-- | Toggle between flat and tree mode. If in the third "default" mode, go to flat mode. +toggleFlatMode :: ReportOpts -> ReportOpts +toggleFlatMode ropts@ReportOpts{accountlistmode_=ALFlat} = ropts{accountlistmode_=ALTree} +toggleFlatMode ropts = ropts{accountlistmode_=ALFlat} + +-- | Get the maximum account depth in the current journal. +maxDepth :: AppState -> Int +maxDepth AppState{ajournal=j} = maximum $ map accountNameLevel $ journalAccountNames j + +-- | Decrement the current depth limit towards 0. If there was no depth limit, +-- set it to one less than the maximum account depth. +decDepth :: AppState -> AppState +decDepth st@AppState{aopts=uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts@ReportOpts{..}}}} + = st{aopts=uopts{cliopts_=copts{reportopts_=ropts{depth_=dec depth_}}}} + where + dec (Just d) = Just $ max 0 (d-1) + dec Nothing = Just $ maxDepth st - 1 + +-- | Increment the current depth limit. If this makes it equal to the +-- the maximum account depth, remove the depth limit. +incDepth :: AppState -> AppState +incDepth st@AppState{aopts=uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts@ReportOpts{..}}}} + = st{aopts=uopts{cliopts_=copts{reportopts_=ropts{depth_=inc depth_}}}} + where + inc (Just d) | d < (maxDepth st - 1) = Just $ d+1 + inc _ = Nothing + +-- | Set the current depth limit to the specified depth, which should +-- be a positive number. If it is zero, or equal to or greater than the +-- current maximum account depth, the depth limit will be removed. +-- (Slight inconsistency here: zero is currently a valid display depth +-- which can be reached using the - key. But we need a key to remove +-- the depth limit, and 0 is it.) +setDepth :: Int -> AppState -> AppState +setDepth depth st@AppState{aopts=uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts}}} + = st{aopts=uopts{cliopts_=copts{reportopts_=ropts{depth_=mdepth'}}}} + where + mdepth' | depth < 0 = depth_ ropts + | depth == 0 = Nothing + | depth >= maxDepth st = Nothing + | otherwise = Just depth + diff --git a/Hledger/UI/ErrorScreen.hs b/Hledger/UI/ErrorScreen.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/ErrorScreen.hs @@ -0,0 +1,125 @@ +-- The error screen, showing a current error condition (such as a parse error after reloading the journal) + +{-# LANGUAGE OverloadedStrings, FlexibleContexts #-} + +module Hledger.UI.ErrorScreen + (screen) +where + +-- import Control.Lens ((^.)) +import Control.Monad.IO.Class (liftIO) +import Data.Monoid +-- import Data.Maybe +import Data.Time.Calendar (Day) +import Graphics.Vty as Vty +import Brick +-- import Brick.Widgets.List +-- import Brick.Widgets.Border +-- import Brick.Widgets.Border.Style +-- import Brick.Widgets.Center +-- import Text.Printf + +-- import Hledger +import Hledger.Cli hiding (progname,prognameandversion,green) +import Hledger.UI.UIOptions +-- import Hledger.UI.Theme +import Hledger.UI.UITypes +import Hledger.UI.UIUtils + +screen = ErrorScreen{ + esState = "" + ,sInitFn = initErrorScreen + ,sDrawFn = drawErrorScreen + ,sHandleFn = handleErrorScreen + } + +initErrorScreen :: Day -> AppState -> AppState +initErrorScreen _ st@AppState{aScreen=ErrorScreen{}} = st +initErrorScreen _ _ = error "init function called with wrong screen type, should not happen" + +drawErrorScreen :: AppState -> [Widget] +drawErrorScreen AppState{ -- aopts=_uopts@UIOpts{cliopts_=_copts@CliOpts{reportopts_=_ropts@ReportOpts{query_=querystr}}}, + aScreen=ErrorScreen{esState=err}} = [ui] + where + toplabel = withAttr ("border" <> "bold") (str "Oops. Please fix this problem then press g to reload") + -- <+> str " transactions" + -- <+> borderQueryStr querystr -- no, account transactions report shows all transactions in the acct ? + -- <+> str " and subs" + -- <+> str " (" + -- <+> cur + -- <+> str "/" + -- <+> total + -- <+> str ")" + -- cur = str $ case l^.listSelectedL of + -- Nothing -> "-" + -- Just i -> show (i + 1) + -- total = str $ show $ length displayitems + -- displayitems = V.toList $ l^.listElementsL + bottomlabel = borderKeysStr [ + -- ("up/down/pgup/pgdown/home/end", "move") + ("g", "reload") + -- ,("left", "return to accounts") + ] + + + -- query = query_ $ reportopts_ $ cliopts_ opts + + ui = Widget Greedy Greedy $ do + + -- calculate column widths, based on current available width + -- c <- getContext + -- let + -- totalwidth = c^.availWidthL + -- - 2 -- XXX due to margin ? shouldn't be necessary (cf UIUtils) + + render $ defaultLayout toplabel bottomlabel $ withAttr "error" $ str err + +drawErrorScreen _ = error "draw function called with wrong screen type, should not happen" + +-- drawErrorItem :: (Int,Int,Int,Int,Int) -> Bool -> (String,String,String,String,String) -> Widget +-- drawErrorItem (datewidth,descwidth,acctswidth,changewidth,balwidth) selected (date,desc,accts,change,bal) = +-- Widget Greedy Fixed $ do +-- render $ +-- str (fitString (Just datewidth) (Just datewidth) True True date) <+> +-- str " " <+> +-- str (fitString (Just descwidth) (Just descwidth) True True desc) <+> +-- str " " <+> +-- str (fitString (Just acctswidth) (Just acctswidth) True True accts) <+> +-- str " " <+> +-- withAttr changeattr (str (fitString (Just changewidth) (Just changewidth) True False change)) <+> +-- str " " <+> +-- withAttr balattr (str (fitString (Just balwidth) (Just balwidth) True False bal)) +-- where +-- changeattr | '-' `elem` change = sel $ "list" <> "amount" <> "decrease" +-- | otherwise = sel $ "list" <> "amount" <> "increase" +-- balattr | '-' `elem` bal = sel $ "list" <> "balance" <> "negative" +-- | otherwise = sel $ "list" <> "balance" <> "positive" +-- sel | selected = (<> "selected") +-- | otherwise = id + +handleErrorScreen :: AppState -> Vty.Event -> EventM (Next AppState) +handleErrorScreen st@AppState{ + aScreen=s@ErrorScreen{esState=_err} + ,aopts=UIOpts{cliopts_=_copts} + ,ajournal=j + } e = do + case e of + Vty.EvKey Vty.KEsc [] -> halt st + Vty.EvKey (Vty.KChar 'q') [] -> halt st + + Vty.EvKey (Vty.KChar 'g') [] -> do + d <- liftIO getCurrentDay + ej <- liftIO $ journalReload j -- (ej, changed) <- liftIO $ journalReloadIfChanged copts j + case ej of + Left err -> continue st{aScreen=s{esState=err}} -- show latest parse error + Right j' -> continue $ reload j' d $ popScreen st -- return to previous screen, and reload it + + -- Vty.EvKey (Vty.KLeft) [] -> continue $ popScreen st + -- Vty.EvKey (Vty.KRight) [] -> error (show curItem) where curItem = listSelectedElement is + -- fall through to the list's event handler (handles [pg]up/down) + _ -> do continue st + -- is' <- handleEvent ev is + -- continue st{aScreen=s{rsState=is'}} + -- continue =<< handleEventLensed st someLens e +handleErrorScreen _ _ = error "event handler called with wrong screen type, should not happen" + diff --git a/Hledger/UI/Main.hs b/Hledger/UI/Main.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/Main.hs @@ -0,0 +1,137 @@ +{-| +hledger-ui - a hledger add-on providing a curses-style interface. +Copyright (c) 2007-2015 Simon Michael +Released under GPL version 3 or later. +-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE TemplateHaskell #-} +{-# LANGUAGE MultiParamTypeClasses #-} + +module Hledger.UI.Main where + +-- import Control.Applicative +-- import Control.Lens ((^.)) +import Control.Monad +-- import Control.Monad.IO.Class (liftIO) +-- import Data.Default +-- import Data.Monoid -- +import Data.List +import Data.Maybe +-- import Data.Time.Calendar +import Safe +import System.Exit + +import qualified Graphics.Vty as V +import Brick + +import Hledger +import Hledger.Cli hiding (progname,prognameandversion,green) +import Hledger.UI.UIOptions +import Hledger.UI.UITypes +-- import Hledger.UI.UIUtils +import Hledger.UI.Theme +import Hledger.UI.AccountsScreen as AS +import Hledger.UI.RegisterScreen as RS + +---------------------------------------------------------------------- + +main :: IO () +main = do + opts <- getHledgerUIOpts + -- when (debug_ $ cliopts_ opts) $ printf "%s\n" prognameandversion >> printf "opts: %s\n" (show opts) + run opts + where + run opts + | "help" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStr (showModeHelp uimode) >> exitSuccess + | "version" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn prognameandversion >> exitSuccess + | "binary-filename" `inRawOpts` (rawopts_ $ cliopts_ opts) = putStrLn (binaryfilename progname) + | otherwise = withJournalDoUICommand opts runBrickUi + +-- XXX withJournalDo specialised for UIOpts +withJournalDoUICommand :: UIOpts -> (UIOpts -> Journal -> IO ()) -> IO () +withJournalDoUICommand uopts@UIOpts{cliopts_=copts} cmd = do + rulespath <- rulesFilePathFromOpts copts + journalpath <- journalFilePathFromOpts copts + ej <- readJournalFiles Nothing rulespath (not $ ignore_assertions_ copts) journalpath + either error' (cmd uopts . journalApplyAliases (aliasesFromOpts copts)) ej + +runBrickUi :: UIOpts -> Journal -> IO () +runBrickUi uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts}} j = do + d <- getCurrentDay + + let + + -- depth: is a bit different from other queries. In hledger cli, + -- - reportopts{depth_} indicates --depth options + -- - reportopts{query_} is the query arguments as a string + -- - the report query is based on both of these. + -- For hledger-ui, for now, move depth: arguments out of reportopts{query_} + -- and into reportopts{depth_}, so that depth and other kinds of filter query + -- can be displayed independently. + uopts' = uopts{ + cliopts_=copts{ + reportopts_= ropts{ + -- ensure depth_ also reflects depth: args + depth_=depthfromoptsandargs, + -- remove depth: args from query_ + query_=unwords $ -- as in ReportOptions, with same limitations + [v | (k,v) <- rawopts_ copts, k=="args", not $ "depth" `isPrefixOf` v] + } + } + } + where + q = queryFromOpts d ropts + depthfromoptsandargs = case queryDepth q of 99999 -> Nothing + d -> Just d + + -- XXX move this stuff into Options, UIOpts + theme = maybe defaultTheme (fromMaybe defaultTheme . getTheme) $ + maybestringopt "theme" $ rawopts_ copts + mregister = maybestringopt "register" $ rawopts_ copts + + (scr, prevscrs) = case mregister of + Nothing -> (AS.screen, []) + -- with --register, start on the register screen, and also put + -- the accounts screen on the prev screens stack so you can exit + -- to that as usual. + Just apat -> (rsSetCurrentAccount acct RS.screen, [ascr']) + where + acct = headDef + (error' $ "--register "++apat++" did not match any account") + $ filter (regexMatches apat) $ journalAccountNames j + -- Initialising the accounts screen is awkward, requiring + -- another temporary AppState value.. + ascr' = aScreen $ + AS.initAccountsScreen d $ + AppState{ + aopts=uopts' + ,ajournal=j + ,aScreen=asSetSelectedAccount acct AS.screen + ,aPrevScreens=[] + } + + st = (sInitFn scr) d + AppState{ + aopts=uopts' + ,ajournal=j + ,aScreen=scr + ,aPrevScreens=prevscrs + } + + app :: App (AppState) V.Event + app = App { + appLiftVtyEvent = id + , appStartEvent = return + , appAttrMap = const theme + , appChooseCursor = showFirstCursor + , appHandleEvent = \st ev -> sHandleFn (aScreen st) st ev + , appDraw = \st -> sDrawFn (aScreen st) st + -- XXX bizarro. removing the st arg and parameter above, + -- which according to GHCI does not change the type, + -- causes "Exception: draw function called with wrong screen type" + -- on entering a register. Likewise, removing the st ev args and parameters + -- causes an exception on exiting a register. + } + + void $ defaultMain app st + diff --git a/Hledger/UI/RegisterScreen.hs b/Hledger/UI/RegisterScreen.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/RegisterScreen.hs @@ -0,0 +1,233 @@ +-- The account register screen, showing transactions in an account, like hledger-web's register. + +{-# LANGUAGE OverloadedStrings, FlexibleContexts #-} + +module Hledger.UI.RegisterScreen + (screen + ,rsSetCurrentAccount + ) +where + +import Control.Lens ((^.)) +import Control.Monad.IO.Class (liftIO) +import Data.List +import Data.List.Split (splitOn) +import Data.Monoid +-- import Data.Maybe +import Data.Time.Calendar (Day) +import qualified Data.Vector as V +import Graphics.Vty as Vty +import Brick +import Brick.Widgets.List +import Brick.Widgets.Border (borderAttr) +-- import Brick.Widgets.Center +-- import Text.Printf + +import Hledger +import Hledger.Cli hiding (progname,prognameandversion,green) +import Hledger.UI.UIOptions +-- import Hledger.UI.Theme +import Hledger.UI.UITypes +import Hledger.UI.UIUtils +import qualified Hledger.UI.TransactionScreen as TS (screen) +import qualified Hledger.UI.ErrorScreen as ES (screen) + +screen = RegisterScreen{ + rsState = (list "register" V.empty 1, "") + ,sInitFn = initRegisterScreen + ,sDrawFn = drawRegisterScreen + ,sHandleFn = handleRegisterScreen + } + +rsSetCurrentAccount a scr@RegisterScreen{rsState=(l,_)} = scr{rsState=(l,a)} +rsSetCurrentAccount _ scr = scr + +initRegisterScreen :: Day -> AppState -> AppState +initRegisterScreen d st@AppState{aopts=opts, ajournal=j, aScreen=s@RegisterScreen{rsState=(_,acct)}} = + st{aScreen=s{rsState=(l,acct)}} + where + -- gather arguments and queries + ropts = (reportopts_ $ cliopts_ opts) + { + depth_=Nothing, + balancetype_=HistoricalBalance + } + -- XXX temp + thisacctq = Acct $ accountNameToAccountRegex acct -- includes subs + q = filterQuery (not . queryIsDepth) $ queryFromOpts d ropts + + -- run a transactions report, most recent last + q' = + -- ltrace "q" + q + thisacctq' = + -- ltrace "thisacctq" + thisacctq + (_label,items') = accountTransactionsReport ropts j q' thisacctq' + items = reverse items' + + -- pre-render all items; these will be the List elements. This helps calculate column widths. + displayitem (t, _, _issplit, otheracctsstr, change, bal) = + (showDate $ tdate t + ,tdescription t + ,case splitOn ", " otheracctsstr of + [s] -> s + ss -> intercalate ", " ss + -- _ -> "" -- should do this if accounts field width < 30 + ,showMixedAmountOneLineWithoutPrice change + ,showMixedAmountOneLineWithoutPrice bal + ,t + ) + displayitems = map displayitem items + + -- build the List, moving the selection to the end + l = listMoveTo (length items) $ + list (Name "register") (V.fromList displayitems) 1 + + -- (listName someList) + +initRegisterScreen _ _ = error "init function called with wrong screen type, should not happen" + +drawRegisterScreen :: AppState -> [Widget] +drawRegisterScreen AppState{aopts=uopts -- @UIOpts{cliopts_=_copts@CliOpts{reportopts_=_ropts@ReportOpts{query_=querystr}} + ,aScreen=RegisterScreen{rsState=(l,acct)}} = [ui] + where + toplabel = withAttr ("border" <> "bold") (str acct) + <+> cleared + <+> str " transactions" + -- <+> borderQueryStr querystr -- no, account transactions report shows all transactions in the acct ? + -- <+> str " and subs" + <+> str " (" + <+> cur + <+> str "/" + <+> total + <+> str ")" + cleared = if (cleared_ $ reportopts_ $ cliopts_ uopts) + then withAttr (borderAttr <> "query") (str " cleared") + else str "" + cur = str $ case l^.listSelectedL of + Nothing -> "-" + Just i -> show (i + 1) + total = str $ show $ length displayitems + displayitems = V.toList $ l^.listElementsL + + -- query = query_ $ reportopts_ $ cliopts_ opts + + ui = Widget Greedy Greedy $ do + + -- calculate column widths, based on current available width + c <- getContext + let + totalwidth = c^.availWidthL + - 2 -- XXX due to margin ? shouldn't be necessary (cf UIUtils) + + -- the date column is fixed width + datewidth = 10 + + -- multi-commodity amounts rendered on one line can be + -- arbitrarily wide. Give the two amounts as much space as + -- they need, while reserving a minimum of space for other + -- columns and whitespace. If they don't get all they need, + -- allocate it to them proportionally to their maximum widths. + whitespacewidth = 10 -- inter-column whitespace, fixed width + minnonamtcolswidth = datewidth + 2 + 2 -- date column plus at least 2 for desc and accts + maxamtswidth = max 0 (totalwidth - minnonamtcolswidth - whitespacewidth) + maxchangewidthseen = maximum' $ map (strWidth . fourth6) displayitems + maxbalwidthseen = maximum' $ map (strWidth . fifth6) displayitems + changewidthproportion = fromIntegral maxchangewidthseen / fromIntegral (maxchangewidthseen + maxbalwidthseen) + maxchangewidth = round $ changewidthproportion * fromIntegral maxamtswidth + maxbalwidth = maxamtswidth - maxchangewidth + changewidth = min maxchangewidth maxchangewidthseen + balwidth = min maxbalwidth maxbalwidthseen + + -- assign the remaining space to the description and accounts columns + -- maxdescacctswidth = totalwidth - (whitespacewidth - 4) - changewidth - balwidth + maxdescacctswidth = + -- trace (show (totalwidth, datewidth, changewidth, balwidth, whitespacewidth)) $ + max 0 (totalwidth - datewidth - changewidth - balwidth - whitespacewidth) + -- allocating proportionally. + -- descwidth' = maximum' $ map (strWidth . second6) displayitems + -- acctswidth' = maximum' $ map (strWidth . third6) displayitems + -- descwidthproportion = (descwidth' + acctswidth') / descwidth' + -- maxdescwidth = min (maxdescacctswidth - 7) (maxdescacctswidth / descwidthproportion) + -- maxacctswidth = maxdescacctswidth - maxdescwidth + -- descwidth = min maxdescwidth descwidth' + -- acctswidth = min maxacctswidth acctswidth' + -- allocating equally. + descwidth = maxdescacctswidth `div` 2 + acctswidth = maxdescacctswidth - descwidth + colwidths = (datewidth,descwidth,acctswidth,changewidth,balwidth) + + bottomlabel = borderKeysStr [ + -- ("up/down/pgup/pgdown/home/end", "move") + ("left", "back") + ,("C", "cleared?") + ,("right/enter", "transaction") + ,("g", "reload") + ,("q", "quit") + ] + + render $ defaultLayout toplabel bottomlabel $ renderList l (drawRegisterItem colwidths) + +drawRegisterScreen _ = error "draw function called with wrong screen type, should not happen" + +drawRegisterItem :: (Int,Int,Int,Int,Int) -> Bool -> (String,String,String,String,String,Transaction) -> Widget +drawRegisterItem (datewidth,descwidth,acctswidth,changewidth,balwidth) selected (date,desc,accts,change,bal,_) = + Widget Greedy Fixed $ do + render $ + str (fitString (Just datewidth) (Just datewidth) True True date) <+> + str " " <+> + str (fitString (Just descwidth) (Just descwidth) True True desc) <+> + str " " <+> + str (fitString (Just acctswidth) (Just acctswidth) True True accts) <+> + str " " <+> + withAttr changeattr (str (fitString (Just changewidth) (Just changewidth) True False change)) <+> + str " " <+> + withAttr balattr (str (fitString (Just balwidth) (Just balwidth) True False bal)) + where + changeattr | '-' `elem` change = sel $ "list" <> "amount" <> "decrease" + | otherwise = sel $ "list" <> "amount" <> "increase" + balattr | '-' `elem` bal = sel $ "list" <> "balance" <> "negative" + | otherwise = sel $ "list" <> "balance" <> "positive" + sel | selected = (<> "selected") + | otherwise = id + +handleRegisterScreen :: AppState -> Vty.Event -> EventM (Next AppState) +handleRegisterScreen st@AppState{ + aScreen=s@RegisterScreen{rsState=(l,acct)} + ,aopts=UIOpts{cliopts_=_copts} + ,ajournal=j + } e = do + d <- liftIO getCurrentDay + case e of + Vty.EvKey Vty.KEsc [] -> halt st + Vty.EvKey (Vty.KChar 'q') [] -> halt st + + Vty.EvKey (Vty.KChar 'g') [] -> do + ej <- liftIO $ journalReload j -- (ej, changed) <- liftIO $ journalReloadIfChanged copts j + case ej of + Right j' -> continue $ reload j' d st + Left err -> continue $ screenEnter d ES.screen{esState=err} st + + Vty.EvKey (Vty.KChar 'C') [] -> continue $ reload j d $ stToggleCleared st + + Vty.EvKey (Vty.KLeft) [] -> continue $ popScreen st + + Vty.EvKey (k) [] | k `elem` [Vty.KRight, Vty.KEnter] -> do + case listSelectedElement l of + Just (_, (_, _, _, _, _, t)) -> + let + ts = map sixth6 $ V.toList $ listElements l + numberedts = zip [1..] ts + i = fromIntegral $ maybe 0 (+1) $ elemIndex t ts -- XXX + in + continue $ screenEnter d TS.screen{tsState=((i,t),numberedts,acct)} st + Nothing -> continue st + + -- fall through to the list's event handler (handles [pg]up/down) + ev -> do + l' <- handleEvent ev l + continue st{aScreen=s{rsState=(l',acct)}} + -- continue =<< handleEventLensed st someLens ev + +handleRegisterScreen _ _ = error "event handler called with wrong screen type, should not happen" diff --git a/Hledger/UI/Theme.hs b/Hledger/UI/Theme.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/Theme.hs @@ -0,0 +1,119 @@ +-- | The all-important theming engine! +-- +-- Cf +-- https://hackage.haskell.org/package/vty/docs/Graphics-Vty-Attributes.html +-- http://hackage.haskell.org/package/brick/docs/Brick-AttrMap.html +-- http://hackage.haskell.org/package/brick-0.1/docs/Brick-Util.html +-- http://hackage.haskell.org/package/brick-0.1/docs/Brick-Widgets-Core.html#g:5 +-- http://hackage.haskell.org/package/brick-0.1/docs/Brick-Widgets-Border.html + + +{-# LANGUAGE OverloadedStrings #-} + +module Hledger.UI.Theme ( + defaultTheme + ,getTheme + ,themes + ,themeNames + ) where + +import qualified Data.Map as M +import Data.Maybe +import Data.Monoid +import Graphics.Vty +import Brick +import Brick.Widgets.Border +import Brick.Widgets.List + +defaultTheme :: AttrMap +defaultTheme = fromMaybe (snd $ head themesList) $ getTheme "white" + -- the theme named here should exist; + -- otherwise it will take the first one from the list, + -- which must be non-empty. + +-- | Look up the named theme, if it exists. +getTheme :: String -> Maybe AttrMap +getTheme name = M.lookup name themes + +-- | A selection of named themes specifying terminal colours and styles. +-- One of these is active at a time. +-- +-- A hledger-ui theme is a vty/brick AttrMap. Each theme specifies a +-- default style (Attr), plus extra styles which are applied when +-- their (hierarchical) name matches the widget rendering context. +-- "More specific styles, if present, are used and only fall back to +-- more general ones when the more specific ones are absent, but also +-- these styles get merged, so that if a more specific style only +-- provides the foreground color, its more general parent style can +-- set the background color, too." +-- For example: rendering a widget named "b" inside a widget named "a", +-- - if a style named "a" <> "b" exists, it will be used. Anything it +-- does not specify will be taken from a style named "a" if that +-- exists, otherwise from the default style. +-- - otherwise if a style named "a" exists, it will be used, and +-- anything it does not specify will be taken from the default style. +-- - otherwise (you guessed it) the default style is used. +-- +themes :: M.Map String AttrMap +themes = M.fromList themesList + +themeNames :: [String] +themeNames = map fst themesList + +(&) = withStyle + +themesList :: [(String, AttrMap)] +themesList = [ + ("default", attrMap + (black `on` white & bold) [ -- default style for this theme + ("error", currentAttr `withForeColor` red), + (borderAttr , white `on` black & dim), + (borderAttr <> "bold", white `on` black & bold), + (borderAttr <> "query", cyan `on` black & bold), + (borderAttr <> "depth", yellow `on` black & bold), + (borderAttr <> "keys", white `on` black & bold), + -- ("normal" , black `on` white), + ("list" , black `on` white), -- regular list items + ("list" <> "selected" , white `on` blue & bold), -- selected list items + -- ("list" <> "selected" , black `on` brightYellow), + -- ("list" <> "accounts" , white `on` brightGreen), + ("list" <> "amount" <> "increase", currentAttr `withForeColor` green), + ("list" <> "amount" <> "decrease", currentAttr `withForeColor` red), + ("list" <> "balance" <> "positive", currentAttr `withForeColor` black), + ("list" <> "balance" <> "negative", currentAttr `withForeColor` red), + ("list" <> "amount" <> "increase" <> "selected", brightGreen `on` blue & bold), + ("list" <> "amount" <> "decrease" <> "selected", brightRed `on` blue & bold), + ("list" <> "balance" <> "positive" <> "selected", white `on` blue & bold), + ("list" <> "balance" <> "negative" <> "selected", brightRed `on` blue & bold) + ]), + + ("terminal", attrMap + defAttr [ -- use the current terminal's default style + (borderAttr , white `on` black), + -- ("normal" , defAttr), + (listAttr , defAttr), + (listSelectedAttr , defAttr & reverseVideo & bold) + -- ("status" , defAttr & reverseVideo) + ]), + + ("greenterm", attrMap + (green `on` black) [ + -- (listAttr , green `on` black), + (listSelectedAttr , black `on` green & bold) + ]) + -- ("colorful", attrMap + -- defAttr [ + -- (listAttr , defAttr & reverseVideo), + -- (listSelectedAttr , defAttr `withForeColor` white `withBackColor` red) + -- -- ("status" , defAttr `withForeColor` black `withBackColor` green) + -- ]) + + ] + +-- halfbrightattr = defAttr & dim +-- reverseattr = defAttr & reverseVideo +-- redattr = defAttr `withForeColor` red +-- greenattr = defAttr `withForeColor` green +-- reverseredattr = defAttr & reverseVideo `withForeColor` red +-- reversegreenattr= defAttr & reverseVideo `withForeColor` green + diff --git a/Hledger/UI/TransactionScreen.hs b/Hledger/UI/TransactionScreen.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/TransactionScreen.hs @@ -0,0 +1,109 @@ +-- The transaction screen, showing a single transaction's general journal entry. + +{-# LANGUAGE OverloadedStrings, TupleSections #-} -- , FlexibleContexts + +module Hledger.UI.TransactionScreen + (screen + ) +where + +-- import Control.Lens ((^.)) +import Control.Monad.IO.Class (liftIO) +-- import Data.List +-- import Data.List.Split (splitOn) +-- import Data.Ord +import Data.Monoid +-- import Data.Maybe +import Data.Time.Calendar (Day) +-- import qualified Data.Vector as V +import Graphics.Vty as Vty +-- import Safe (headDef, lastDef) +import Brick +import Brick.Widgets.List (listMoveTo) +-- import Brick.Widgets.Border +-- import Brick.Widgets.Border.Style +-- import Brick.Widgets.Center +-- import Text.Printf + +import Hledger +import Hledger.Cli hiding (progname,prognameandversion,green) +import Hledger.UI.UIOptions +-- import Hledger.UI.Theme +import Hledger.UI.UITypes +import Hledger.UI.UIUtils +import qualified Hledger.UI.ErrorScreen as ES (screen) + +screen = TransactionScreen{ + tsState = ((1,nulltransaction),[(1,nulltransaction)],"") + ,sInitFn = initTransactionScreen + ,sDrawFn = drawTransactionScreen + ,sHandleFn = handleTransactionScreen + } + +initTransactionScreen :: Day -> AppState -> AppState +initTransactionScreen _d st@AppState{aopts=_opts, ajournal=_j, aScreen=_s@TransactionScreen{tsState=_}} = st +initTransactionScreen _ _ = error "init function called with wrong screen type, should not happen" + +drawTransactionScreen :: AppState -> [Widget] +drawTransactionScreen AppState{ -- aopts=_uopts@UIOpts{cliopts_=_copts@CliOpts{reportopts_=_ropts@ReportOpts{query_=querystr}}}, + aScreen=TransactionScreen{tsState=((i,t),nts,acct)}} = [ui] + where + -- datedesc = show (tdate t) ++ " " ++ tdescription t + toplabel = + str "Transaction " + -- <+> withAttr ("border" <> "bold") (str $ "#" ++ show (tindex t)) + -- <+> str (" ("++show i++" of "++show (length nts)++" in "++acct++")") + <+> (str $ "#" ++ show (tindex t)) + <+> str " (" + <+> withAttr ("border" <> "bold") (str $ show i) + <+> str (" of "++show (length nts)++" in "++acct++")") + bottomlabel = borderKeysStr [ + ("left", "back") + ,("up/down", "prev/next") + ,("g", "reload") + ,("q", "quit") + ] + ui = Widget Greedy Greedy $ do + render $ defaultLayout toplabel bottomlabel $ str $ showTransactionUnelidedOneLineAmounts t + +drawTransactionScreen _ = error "draw function called with wrong screen type, should not happen" + +handleTransactionScreen :: AppState -> Vty.Event -> EventM (Next AppState) +handleTransactionScreen st@AppState{ + aScreen=s@TransactionScreen{tsState=((i,t),nts,acct)} + ,aopts=UIOpts{cliopts_=_copts} + ,ajournal=j + } e = do + d <- liftIO getCurrentDay + let + (iprev,tprev) = maybe (i,t) ((i-1),) $ lookup (i-1) nts + (inext,tnext) = maybe (i,t) ((i+1),) $ lookup (i+1) nts + case e of + Vty.EvKey Vty.KEsc [] -> halt st + Vty.EvKey (Vty.KChar 'q') [] -> halt st + + Vty.EvKey (Vty.KChar 'g') [] -> do + d <- liftIO getCurrentDay + ej <- liftIO $ journalReload j -- (ej, changed) <- liftIO $ journalReloadIfChanged copts j + case ej of + Right j' -> continue $ reload j' d st + Left err -> continue $ screenEnter d ES.screen{esState=err} st + + -- Vty.EvKey (Vty.KChar 'C') [] -> continue $ reload j d $ stToggleCleared st + + Vty.EvKey (Vty.KUp) [] -> continue $ reload j d st{aScreen=s{tsState=((iprev,tprev),nts,acct)}} + Vty.EvKey (Vty.KDown) [] -> continue $ reload j d st{aScreen=s{tsState=((inext,tnext),nts,acct)}} + + Vty.EvKey (Vty.KLeft) [] -> continue st'' + where + st'@AppState{aScreen=scr} = popScreen st + st'' = st'{aScreen=rsSetSelectedTransaction (fromIntegral i) scr} + + _ev -> continue st + +handleTransactionScreen _ _ = error "event handler called with wrong screen type, should not happen" + +rsSetSelectedTransaction i scr@RegisterScreen{rsState=(l,a)} = scr{rsState=(l',a)} + where l' = listMoveTo (i-1) l +rsSetSelectedTransaction _ scr = scr + diff --git a/Hledger/UI/UIOptions.hs b/Hledger/UI/UIOptions.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/UIOptions.hs @@ -0,0 +1,82 @@ +{-# LANGUAGE CPP #-} +{-| + +-} + +module Hledger.UI.UIOptions +where +#if !MIN_VERSION_base(4,8,0) +import Data.Functor.Compat ((<$>)) +#endif +import Data.List (intercalate) +import System.Console.CmdArgs +import System.Console.CmdArgs.Explicit + +import Hledger.Cli hiding (progname,version,prognameandversion) +import Hledger.UI.Theme (themeNames) + +progname, version :: String +progname = "hledger-ui" +#ifdef VERSION +version = VERSION +#else +version = "" +#endif +prognameandversion :: String +prognameandversion = progname ++ " " ++ version :: String + +uiflags = [ + -- flagNone ["debug-ui"] (\opts -> setboolopt "rules-file" opts) "run with no terminal output, showing console" + flagReq ["theme"] (\s opts -> Right $ setopt "theme" s opts) "THEME" ("use this custom display theme ("++intercalate ", " themeNames++")") + ,flagReq ["register"] (\s opts -> Right $ setopt "register" s opts) "ACCTREGEX" "start in the (first) matched account's register" + ,flagNone ["flat"] (\opts -> setboolopt "flat" opts) "show full account names, unindented" + -- ,flagReq ["drop"] (\s opts -> Right $ setopt "drop" s opts) "N" "with --flat, omit this many leading account name components" + -- ,flagReq ["format"] (\s opts -> Right $ setopt "format" s opts) "FORMATSTR" "use this custom line format" + ,flagNone ["no-elide"] (\opts -> setboolopt "no-elide" opts) "don't compress empty parent accounts on one line" + ,flagNone ["value","V"] (setboolopt "value") "show amounts as their market value in their default valuation commodity (accounts screen)" + ] + +--uimode :: Mode [([Char], [Char])] +uimode = (mode "hledger-ui" [("command","ui")] + "browse accounts, postings and entries in a full-window curses interface" + (argsFlag "[PATTERNS]") []){ + modeGroupFlags = Group { + groupUnnamed = uiflags + ,groupHidden = [] + ,groupNamed = [(generalflagsgroup1)] + } + ,modeHelpSuffix=[ + -- "Reads your ~/.hledger.journal file, or another specified by $LEDGER_FILE or -f, and starts the full-window curses ui." + ] + } + +-- hledger-ui options, used in hledger-ui and above +data UIOpts = UIOpts { + debug_ui_ :: Bool + ,cliopts_ :: CliOpts + } deriving (Show) + +defuiopts = UIOpts + def + def + +-- instance Default CliOpts where def = defcliopts + +rawOptsToUIOpts :: RawOpts -> IO UIOpts +rawOptsToUIOpts rawopts = checkUIOpts <$> do + cliopts <- rawOptsToCliOpts rawopts + return defuiopts { + debug_ui_ = boolopt "debug-ui" rawopts + ,cliopts_ = cliopts + } + +checkUIOpts :: UIOpts -> UIOpts +checkUIOpts opts = + either optserror (const opts) $ do + case maybestringopt "theme" $ rawopts_ $ cliopts_ opts of + Just t | not $ elem t themeNames -> Left $ "invalid theme name: "++t + _ -> Right () + +getHledgerUIOpts :: IO UIOpts +getHledgerUIOpts = processArgs uimode >>= return . decodeRawOpts >>= rawOptsToUIOpts + diff --git a/Hledger/UI/UITypes.hs b/Hledger/UI/UITypes.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/UITypes.hs @@ -0,0 +1,57 @@ +module Hledger.UI.UITypes where + +import Data.Time.Calendar (Day) +import qualified Graphics.Vty as V +import Brick +import Brick.Widgets.List (List) + +import Hledger +import Hledger.UI.UIOptions + +---------------------------------------------------------------------- + +-- | hledger-ui's application state. This is part of, but distinct +-- from, brick's App. +data AppState = AppState { + aopts :: UIOpts -- ^ the command-line options and query currently in effect + ,ajournal :: Journal -- ^ the journal being viewed + ,aScreen :: Screen -- ^ the currently active screen + ,aPrevScreens :: [Screen] -- ^ previously visited screens, most recent first + } deriving (Show) + +-- | Types of screen available within the app, along with their state. +-- Screen types are distinguished by their constructor and their state +-- field, which must have unique names. +-- +-- This type causes partial functions, so take care. +data Screen = + AccountsScreen { + asState :: (List (Int,String,String,[String]), AccountName) -- ^ list widget holding (indent level, full account name, full or short account name to display, rendered amounts); + -- the full name of the currently selected account (or "") + ,sInitFn :: Day -> AppState -> AppState -- ^ function to initialise the screen's state on entry + ,sHandleFn :: AppState -> V.Event -> EventM (Next AppState) -- ^ brick event handler to use for this screen + ,sDrawFn :: AppState -> [Widget] -- ^ brick renderer to use for this screen + } + | RegisterScreen { + rsState :: (List (String,String,String,String,String,Transaction), AccountName) + -- ^ list widget holding (date, description, other accts, change amt, balance amt, and the full transaction); + -- the full name of the account we are showing a register for + ,sInitFn :: Day -> AppState -> AppState + ,sHandleFn :: AppState -> V.Event -> EventM (Next AppState) + ,sDrawFn :: AppState -> [Widget] + } + | TransactionScreen { + tsState :: ((Integer,Transaction), [(Integer,Transaction)], AccountName) -- ^ the (numbered) transaction we are viewing, a numbered list of transactions we can step through, and the account whose register we entered this screen from + ,sInitFn :: Day -> AppState -> AppState + ,sHandleFn :: AppState -> V.Event -> EventM (Next AppState) + ,sDrawFn :: AppState -> [Widget] + } + | ErrorScreen { + esState :: String -- ^ error message to display + ,sInitFn :: Day -> AppState -> AppState + ,sHandleFn :: AppState -> V.Event -> EventM (Next AppState) + ,sDrawFn :: AppState -> [Widget] + } + deriving (Show) + +instance Show (List a) where show _ = "" diff --git a/Hledger/UI/UIUtils.hs b/Hledger/UI/UIUtils.hs new file mode 100644 --- /dev/null +++ b/Hledger/UI/UIUtils.hs @@ -0,0 +1,191 @@ +{-# LANGUAGE OverloadedStrings #-} + +module Hledger.UI.UIUtils ( + pushScreen + ,popScreen + ,screenEnter + ,reload + ,getViewportSize + -- ,margin + ,withBorderAttr + ,topBottomBorderWithLabel + ,topBottomBorderWithLabels + ,defaultLayout + ,borderQueryStr + ,borderDepthStr + ,borderKeysStr + -- + ,stToggleCleared + ) where + +import Control.Lens ((^.)) +-- import Control.Monad +-- import Control.Monad.IO.Class +-- import Data.Default +import Data.List +import Data.Monoid +import Data.Time.Calendar (Day) +import Brick +-- import Brick.Widgets.List +import Brick.Widgets.Border +import Brick.Widgets.Border.Style +import Graphics.Vty as Vty + +import Hledger.UI.UITypes +import Hledger.Data.Types (Journal) +import Hledger.UI.UIOptions +import Hledger.Cli.CliOptions +import Hledger.Reports.ReportOptions +import Hledger.Utils (applyN) +-- import Hledger.Utils.Debug + +stToggleCleared :: AppState -> AppState +stToggleCleared st@AppState{aopts=uopts@UIOpts{cliopts_=copts@CliOpts{reportopts_=ropts}}} = + st{aopts=uopts{cliopts_=copts{reportopts_=toggleCleared ropts}}} + +-- | Toggle between showing all and showing only cleared items. +toggleCleared :: ReportOpts -> ReportOpts +toggleCleared ropts = ropts{cleared_=not $ cleared_ ropts} + +-- | Regenerate the content for the current and previous screens, from a new journal and current date. +reload :: Journal -> Day -> AppState -> AppState +reload j d st@AppState{aScreen=s,aPrevScreens=ss} = + -- clumsy due to entanglement of AppState and Screen. + -- sInitFn operates only on an appstate's current screen, so + -- remove all the screens from the appstate and then add them back + -- one at a time, regenerating as we go. + let + first:rest = reverse $ s:ss + st0 = st{ajournal=j, aScreen=first, aPrevScreens=[]} + st1 = (sInitFn first) d st0 + st2 = foldl' (\st s -> (sInitFn s) d $ pushScreen s st) st1 rest + in + st2 + +pushScreen :: Screen -> AppState -> AppState +pushScreen scr st = st{aPrevScreens=(aScreen st:aPrevScreens st) + ,aScreen=scr + } + +popScreen :: AppState -> AppState +popScreen st@AppState{aPrevScreens=s:ss} = st{aScreen=s, aPrevScreens=ss} +popScreen st = st + +-- clearScreens :: AppState -> AppState +-- clearScreens st = st{aPrevScreens=[]} + +-- | Enter a new screen, saving the old screen & state in the +-- navigation history and initialising the new screen's state. +screenEnter :: Day -> Screen -> AppState -> AppState +screenEnter d scr st = (sInitFn scr) d $ + pushScreen scr + st + +-- | In the EventM monad, get the named current viewport's width and height, +-- or (0,0) if the named viewport is not found. +getViewportSize :: Name -> EventM (Int,Int) +getViewportSize name = do + mvp <- lookupViewport name + let (w,h) = case mvp of + Just vp -> vp ^. vpSize + Nothing -> (0,0) + -- liftIO $ putStrLn $ show (w,h) + return (w,h) + +defaultLayout toplabel bottomlabel = + topBottomBorderWithLabels (str " "<+>toplabel<+>str " ") (str " "<+>bottomlabel<+>str " ") . + margin 1 0 Nothing + -- topBottomBorderWithLabel2 label . + -- padLeftRight 1 -- XXX should reduce inner widget's width by 2, but doesn't + -- "the layout adjusts... if you use the core combinators" + +topBottomBorderWithLabel label = \wrapped -> + Widget Greedy Greedy $ do + c <- getContext + let (_w,h) = (c^.availWidthL, c^.availHeightL) + h' = h - 2 + wrapped' = vLimit (h') wrapped + debugmsg = + "" + -- " debug: "++show (_w,h') + render $ + hBorderWithLabel (label <+> str debugmsg) + <=> + wrapped' + <=> + hBorder + +topBottomBorderWithLabels toplabel bottomlabel = \wrapped -> + Widget Greedy Greedy $ do + c <- getContext + let (_w,h) = (c^.availWidthL, c^.availHeightL) + h' = h - 2 + wrapped' = vLimit (h') wrapped + debugmsg = + "" + -- " debug: "++show (_w,h') + render $ + hBorderWithLabel (toplabel <+> str debugmsg) + <=> + wrapped' + <=> + hBorderWithLabel bottomlabel + +-- XXX should be equivalent to the above, but isn't (page down goes offscreen) +_topBottomBorderWithLabel2 label = \wrapped -> + let debugmsg = "" + in hBorderWithLabel (label <+> str debugmsg) + <=> + wrapped + <=> + hBorder + +-- XXX superseded by pad, in theory +-- | Wrap a widget in a margin with the given horizontal and vertical +-- thickness, using the current background colour or the specified +-- colour. +-- XXX May disrupt border style of inner widgets. +-- XXX Should reduce the available size visible to inner widget, but doesn't seem to (cf drawRegisterScreen2). +margin :: Int -> Int -> Maybe Color -> Widget -> Widget +margin h v mcolour = \w -> + Widget Greedy Greedy $ do + c <- getContext + let w' = vLimit (c^.availHeightL - v*2) $ hLimit (c^.availWidthL - h*2) w + attr = maybe currentAttr (\c -> c `on` c) mcolour + render $ + withBorderAttr attr $ + withBorderStyle (borderStyleFromChar ' ') $ + applyN v (hBorder <=>) $ + applyN h (vBorder <+>) $ + applyN v (<=> hBorder) $ + applyN h (<+> vBorder) $ + w' + + -- withBorderAttr attr . + -- withBorderStyle (borderStyleFromChar ' ') . + -- applyN n border + +withBorderAttr attr = updateAttrMap (applyAttrMappings [(borderAttr, attr)]) + +-- _ui = vCenter $ vBox [ hCenter box +-- , str " " +-- , hCenter $ str "Press Esc to exit." +-- ] + +borderQueryStr :: String -> Widget +borderQueryStr "" = str "" +borderQueryStr qry = str " matching " <+> withAttr (borderAttr <> "query") (str qry) + +borderDepthStr :: Maybe Int -> Widget +borderDepthStr Nothing = str "" +borderDepthStr (Just d) = str " to " <+> withAttr (borderAttr <> "depth") (str $ "depth "++show d) + +borderKeysStr :: [(String,String)] -> Widget +borderKeysStr keydescs = + hBox $ + intersperse sep $ + [withAttr (borderAttr <> "keys") (str keys) <+> str ":" <+> str desc | (keys, desc) <- keydescs] + where + -- sep = str " | " + sep = str " " + diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,45 @@ +A curses-style text user interface for the hledger accounting tool. + +hledger-ui is the new name for hledger-vty. Revived in 2015, this +package is intended to be installed as standard by all hledger users, +except those on (native) Windows, where it is not supported. + +hledger-ui currently allows browsing the balance, register and print +reports, with drill-down and scrolling. + + +# HACKING + +## Backlog: +``` +reg: show historical running balance +acc: fix -H, show historical balances + switch to multibalance report ? +adjust filter + accounts screen + register screen +reg: improve other account names + test showing only real postings when there are reals and virtuals +journal entry view dialog +blog +reg: support -V +redraw on ctrl-l/cmd-r + reload on redraw + reload on screen change + reload on file change +acc: show total +fix --drop +show "modified account names" with --drop or --alias +journal screen +bs/is/cf-ish reports +persistent custom reports +persistent config +search in page +adjust other options +add +edit +custom screens +plugin screens + + +``` diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/hledger-ui.cabal b/hledger-ui.cabal new file mode 100644 --- /dev/null +++ b/hledger-ui.cabal @@ -0,0 +1,92 @@ +-- This file has been generated from package.yaml by hpack version 0.5.4. +-- +-- see: https://github.com/sol/hpack + +name: hledger-ui +version: 0.27 +stability: beta +category: Finance, Console +synopsis: Curses-style user interface for the hledger accounting tool +description: + This is hledger's curses-style interface. + It is simpler and more convenient for browsing data than the command-line interface, + but lighter and faster than hledger-web. + hledger is a cross-platform program for tracking money, time, or + any other commodity, using double-entry accounting and a simple, + editable file format. It is inspired by and largely compatible + with ledger(1). hledger provides command-line, curses and web + interfaces, and aims to be a reliable, practical tool for daily + use. +license: GPL +license-file: LICENSE +author: Simon Michael +maintainer: Simon Michael +homepage: http://hledger.org +bug-reports: http://bugs.hledger.org +cabal-version: >= 1.10 +build-type: Simple +tested-with: GHC==7.4.2, GHC==7.6.3, GHC==7.8.4, GHC==7.10.2 + +extra-source-files: + CHANGES + README + +source-repository head + type: git + location: https://github.com/simonmichael/hledger + +flag threaded + default: True + description: + Build with support for multithreaded execution + +flag old-locale + default: False + description: + A compatibility flag, set automatically by cabal. + If false then depend on time >= 1.5, + if true then depend on time < 1.5 together with old-locale. + +executable hledger-ui + main-is: hledger-ui.hs + hs-source-dirs: + . + ghc-options: -Wall -fno-warn-unused-do-bind -fno-warn-name-shadowing -fno-warn-missing-signatures -fno-warn-type-defaults -fno-warn-orphans + if flag(threaded) + ghc-options: -threaded + cpp-options: -DVERSION="0.27" + build-depends: + hledger == 0.27 + , hledger-lib == 0.27 + , base >= 3 && < 5 + , base-compat >= 0.8.1 + , brick >= 0.2 && < 0.3 + , cmdargs >= 0.8 + , containers + , data-default + , filepath + , HUnit + , lens >= 4.12.3 && < 4.13 + , safe >= 0.2 + , split >= 0.1 && < 0.3 + , transformers + , vector + , vty >= 5.2 && < 5.5 + if impl(ghc >= 7.4) + build-depends: pretty-show >= 1.6.4 + if flag(old-locale) + build-depends: time < 1.5, old-locale + else + build-depends: time >= 1.5 + other-modules: + Hledger.UI + Hledger.UI.Main + Hledger.UI.UIOptions + Hledger.UI.Theme + Hledger.UI.UITypes + Hledger.UI.UIUtils + Hledger.UI.AccountsScreen + Hledger.UI.ErrorScreen + Hledger.UI.RegisterScreen + Hledger.UI.TransactionScreen + default-language: Haskell2010 diff --git a/hledger-ui.hs b/hledger-ui.hs new file mode 100644 --- /dev/null +++ b/hledger-ui.hs @@ -0,0 +1,2 @@ +#!/usr/bin/env runhaskell +import Hledger.UI (main)