{-# LANGUAGE PackageImports #-}
{-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE TemplateHaskell #-}
module Hledger.Cli.Commands.Help (
helpmode
,help'
) where
import Prelude ()
import "base-compat-batteries" Prelude.Compat
import Data.Char
import Data.List
import Data.Maybe
import Safe
import System.Console.CmdArgs.Explicit
import System.Environment
import System.IO
import Hledger.Utils (embedFileRelative)
import Hledger.Data.RawOptions
import Hledger.Data.Types
import Hledger.Cli.CliOptions
import Hledger.Cli.DocFiles
helpmode :: Mode RawOpts
helpmode = CommandDoc
-> [Flag RawOpts]
-> [(CommandDoc, [Flag RawOpts])]
-> [Flag RawOpts]
-> ([Arg RawOpts], Maybe (Arg RawOpts))
-> Mode RawOpts
hledgerCommandMode
$(embedFileRelative "Hledger/Cli/Commands/Help.txt")
[[CommandDoc] -> (RawOpts -> RawOpts) -> CommandDoc -> Flag RawOpts
forall a. [CommandDoc] -> (a -> a) -> CommandDoc -> Flag a
flagNone ["info"] (CommandDoc -> RawOpts -> RawOpts
setboolopt "info") "show the manual with info"
,[CommandDoc] -> (RawOpts -> RawOpts) -> CommandDoc -> Flag RawOpts
forall a. [CommandDoc] -> (a -> a) -> CommandDoc -> Flag a
flagNone ["man"] (CommandDoc -> RawOpts -> RawOpts
setboolopt "man") "show the manual with man"
,[CommandDoc] -> (RawOpts -> RawOpts) -> CommandDoc -> Flag RawOpts
forall a. [CommandDoc] -> (a -> a) -> CommandDoc -> Flag a
flagNone ["pager"] (CommandDoc -> RawOpts -> RawOpts
setboolopt "pager") "show the manual with $PAGER or less"
,[CommandDoc] -> (RawOpts -> RawOpts) -> CommandDoc -> Flag RawOpts
forall a. [CommandDoc] -> (a -> a) -> CommandDoc -> Flag a
flagNone ["cat"] (CommandDoc -> RawOpts -> RawOpts
setboolopt "cat") "show the manual on stdout"
,[CommandDoc] -> (RawOpts -> RawOpts) -> CommandDoc -> Flag RawOpts
forall a. [CommandDoc] -> (a -> a) -> CommandDoc -> Flag a
flagNone ["help","h"] (CommandDoc -> RawOpts -> RawOpts
setboolopt "help") "show this help"
]
[]
[]
([], Arg RawOpts -> Maybe (Arg RawOpts)
forall a. a -> Maybe a
Just (Arg RawOpts -> Maybe (Arg RawOpts))
-> Arg RawOpts -> Maybe (Arg RawOpts)
forall a b. (a -> b) -> a -> b
$ CommandDoc -> Arg RawOpts
argsFlag "[MANUAL]")
help' :: CliOpts -> Journal -> IO ()
help' :: CliOpts -> Journal -> IO ()
help' opts :: CliOpts
opts _ = do
[CommandDoc]
exes <- IO [CommandDoc]
likelyExecutablesInPath
CommandDoc
pagerprog <- CommandDoc -> Maybe CommandDoc -> CommandDoc
forall a. a -> Maybe a -> a
fromMaybe "less" (Maybe CommandDoc -> CommandDoc)
-> IO (Maybe CommandDoc) -> IO CommandDoc
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> CommandDoc -> IO (Maybe CommandDoc)
lookupEnv "PAGER"
Bool
interactive <- Handle -> IO Bool
hIsTerminalDevice Handle
stdout
let
args :: [CommandDoc]
args = Int -> [CommandDoc] -> [CommandDoc]
forall a. Int -> [a] -> [a]
take 1 ([CommandDoc] -> [CommandDoc]) -> [CommandDoc] -> [CommandDoc]
forall a b. (a -> b) -> a -> b
$ CommandDoc -> RawOpts -> [CommandDoc]
listofstringopt "args" (RawOpts -> [CommandDoc]) -> RawOpts -> [CommandDoc]
forall a b. (a -> b) -> a -> b
$ CliOpts -> RawOpts
rawopts_ CliOpts
opts
topic :: Maybe CommandDoc
topic = case [CommandDoc]
args of
[pat :: CommandDoc
pat] -> [CommandDoc] -> Maybe CommandDoc
forall a. [a] -> Maybe a
headMay [CommandDoc
t | CommandDoc
t <- [CommandDoc]
docTopics, (Char -> Char) -> CommandDoc -> CommandDoc
forall a b. (a -> b) -> [a] -> [b]
map Char -> Char
toLower CommandDoc
pat CommandDoc -> CommandDoc -> Bool
forall a. Eq a => [a] -> [a] -> Bool
`isInfixOf` CommandDoc
t]
_ -> Maybe CommandDoc
forall a. Maybe a
Nothing
[info :: CommandDoc -> IO ()
info, man :: CommandDoc -> IO ()
man, pager :: CommandDoc -> IO ()
pager, cat :: CommandDoc -> IO ()
cat] =
[CommandDoc -> IO ()
runInfoForTopic, CommandDoc -> IO ()
runManForTopic, CommandDoc -> CommandDoc -> IO ()
runPagerForTopic CommandDoc
pagerprog, CommandDoc -> IO ()
printHelpForTopic]
viewer :: CommandDoc -> IO ()
viewer
| CommandDoc -> RawOpts -> Bool
boolopt "info" (RawOpts -> Bool) -> RawOpts -> Bool
forall a b. (a -> b) -> a -> b
$ CliOpts -> RawOpts
rawopts_ CliOpts
opts = CommandDoc -> IO ()
info
| CommandDoc -> RawOpts -> Bool
boolopt "man" (RawOpts -> Bool) -> RawOpts -> Bool
forall a b. (a -> b) -> a -> b
$ CliOpts -> RawOpts
rawopts_ CliOpts
opts = CommandDoc -> IO ()
man
| CommandDoc -> RawOpts -> Bool
boolopt "pager" (RawOpts -> Bool) -> RawOpts -> Bool
forall a b. (a -> b) -> a -> b
$ CliOpts -> RawOpts
rawopts_ CliOpts
opts = CommandDoc -> IO ()
pager
| CommandDoc -> RawOpts -> Bool
boolopt "cat" (RawOpts -> Bool) -> RawOpts -> Bool
forall a b. (a -> b) -> a -> b
$ CliOpts -> RawOpts
rawopts_ CliOpts
opts = CommandDoc -> IO ()
cat
| Bool -> Bool
not Bool
interactive = CommandDoc -> IO ()
cat
| "info" CommandDoc -> [CommandDoc] -> Bool
forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [CommandDoc]
exes = CommandDoc -> IO ()
info
| "man" CommandDoc -> [CommandDoc] -> Bool
forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [CommandDoc]
exes = CommandDoc -> IO ()
man
| CommandDoc
pagerprog CommandDoc -> [CommandDoc] -> Bool
forall (t :: * -> *) a. (Foldable t, Eq a) => a -> t a -> Bool
`elem` [CommandDoc]
exes = CommandDoc -> IO ()
pager
| Bool
otherwise = CommandDoc -> IO ()
cat
case Maybe CommandDoc
topic of
Nothing -> CommandDoc -> IO ()
putStrLn (CommandDoc -> IO ()) -> CommandDoc -> IO ()
forall a b. (a -> b) -> a -> b
$ [CommandDoc] -> CommandDoc
unlines [
"Please choose a manual by typing \"hledger help MANUAL\" (any substring is ok)."
,"A viewer (info, man, a pager, or stdout) will be auto-selected,"
,"or type \"hledger help -h\" to see options. Manuals available:"
]
CommandDoc -> CommandDoc -> CommandDoc
forall a. [a] -> [a] -> [a]
++ "\n " CommandDoc -> CommandDoc -> CommandDoc
forall a. [a] -> [a] -> [a]
++ [CommandDoc] -> CommandDoc
unwords [CommandDoc]
docTopics
Just t :: CommandDoc
t -> CommandDoc -> IO ()
viewer CommandDoc
t