{-|
Module      : Hoyo.CLI.Parse
Copyright   : (c) Frederick Pringle, 2023
License     : BSD-3-Clause
Maintainer  : freddyjepringle@gmail.com

Parse CLI arguments.
-}

module Hoyo.CLI.Parse (
  -- * Parsing CLI arguments and options
    options
  , parseOptions
  , parseCommand
  , globalOptions
  , overrideOptions

  -- * Parsing specific CLI commands
  , addCommand
  , moveCommand
  , listCommand
  , clearCommand
  , deleteCommand
  , checkCommand
  , defaultCommand

  -- ** Parsing sub-commands for hoyo config
  , configCommand
  , configPrintCommand
  , configResetCommand
  , configSetCommand
  , configAddDefaultCommand

  -- * Misc/Utility
  , splitArgs
  , showHelp
  ) where

import           Data.Char                       (isSpace)
import           Data.List
import qualified Data.Text                       as T

import           Hoyo.CLI.Complete
import           Hoyo.Command
import           Hoyo.Internal.Types
import           Hoyo.Internal.Version

import           Options.Applicative
import           Options.Applicative.Help.Chunk
import           Options.Applicative.Help.Pretty

import           System.Environment
import           System.Exit
import           System.Pager

import           Text.Read

-- | Parse global options: options that can be set on the command line
-- no matter what sub-command is being run.
--
-- For a complete list of the global options, see 'GlobalOptions' or
-- run @hoyo --help@.
globalOptions :: Parser GlobalOptions
globalOptions :: Parser GlobalOptions
globalOptions = Maybe FilePath
-> Maybe FilePath -> OverrideOptions -> GlobalOptions
GlobalOptions
                  (Maybe FilePath
 -> Maybe FilePath -> OverrideOptions -> GlobalOptions)
-> Parser (Maybe FilePath)
-> Parser (Maybe FilePath -> OverrideOptions -> GlobalOptions)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parser FilePath -> Parser (Maybe FilePath)
forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Mod OptionFields FilePath -> Parser FilePath
forall s. IsString s => Mod OptionFields s -> Parser s
strOption (FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"config-file"
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> Char -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'C'
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<file>"
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Override the default config file"
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> Mod OptionFields FilePath
forall a (f :: * -> *). Show a => Mod f a
showDefault
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasCompleter f => FilePath -> Mod f a
action FilePath
"file"))
                  Parser (Maybe FilePath -> OverrideOptions -> GlobalOptions)
-> Parser (Maybe FilePath)
-> Parser (OverrideOptions -> GlobalOptions)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser FilePath -> Parser (Maybe FilePath)
forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Mod OptionFields FilePath -> Parser FilePath
forall s. IsString s => Mod OptionFields s -> Parser s
strOption (FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"bookmarks-file"
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> Char -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'B'
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<file>"
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Override the default bookmarks file"
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> Mod OptionFields FilePath
forall a (f :: * -> *). Show a => Mod f a
showDefault
                                Mod OptionFields FilePath
-> Mod OptionFields FilePath -> Mod OptionFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields FilePath
forall (f :: * -> *) a. HasCompleter f => FilePath -> Mod f a
action FilePath
"file"))
                  Parser (OverrideOptions -> GlobalOptions)
-> Parser OverrideOptions -> Parser GlobalOptions
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser OverrideOptions
overrideOptions

-- | Parse override options: options that override config settings.
-- This can be useful when you want to temporarily enable functionality
-- for one CLI run, but don't want to change it in the config file.
overrideOptions :: Parser OverrideOptions
overrideOptions :: Parser OverrideOptions
overrideOptions = MaybeOverride
-> MaybeOverride
-> MaybeOverride
-> MaybeOverride
-> MaybeOverride
-> OverrideOptions
OverrideOptions
                    (MaybeOverride
 -> MaybeOverride
 -> MaybeOverride
 -> MaybeOverride
 -> MaybeOverride
 -> OverrideOptions)
-> Parser MaybeOverride
-> Parser
     (MaybeOverride
      -> MaybeOverride
      -> MaybeOverride
      -> MaybeOverride
      -> OverrideOptions)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parser MaybeOverride
parseOverrideFailOnError
                    Parser
  (MaybeOverride
   -> MaybeOverride
   -> MaybeOverride
   -> MaybeOverride
   -> OverrideOptions)
-> Parser MaybeOverride
-> Parser
     (MaybeOverride
      -> MaybeOverride -> MaybeOverride -> OverrideOptions)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser MaybeOverride
parseOverrideDisplayCreationTime
                    Parser
  (MaybeOverride
   -> MaybeOverride -> MaybeOverride -> OverrideOptions)
-> Parser MaybeOverride
-> Parser (MaybeOverride -> MaybeOverride -> OverrideOptions)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser MaybeOverride
parseOverrideEnableClearing
                    Parser (MaybeOverride -> MaybeOverride -> OverrideOptions)
-> Parser MaybeOverride
-> Parser (MaybeOverride -> OverrideOptions)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser MaybeOverride
parseOverrideEnableReset
                    Parser (MaybeOverride -> OverrideOptions)
-> Parser MaybeOverride -> Parser OverrideOptions
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser MaybeOverride
parseOverrideBackupBeforeClear

-- | Parse a single override option as a pair of switches.
-- For example 'parseOverrideFailOnError' is defined as
--
-- @
-- parseOverrideFailOnError :: 'Parser' 'MaybeOverride'
-- parseOverrideFailOnError = parseOverride
--                               (long "fail" <> help "Fail on error")
--                               (long "nofail" <> help "Disable fail on error")
-- @
--
-- and results in the pair of switches:
--
-- @
--  --fail                   Fail on error
--  --nofail                 Disable fail on error
-- @
parseOverride :: Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
parseOverride :: Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
parseOverride Mod FlagFields Bool
posMod Mod FlagFields Bool
negMod = Bool -> Bool -> MaybeOverride
combOverride
                                (Bool -> Bool -> MaybeOverride)
-> Parser Bool -> Parser (Bool -> MaybeOverride)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mod FlagFields Bool -> Parser Bool
switch Mod FlagFields Bool
posMod
                                Parser (Bool -> MaybeOverride)
-> Parser Bool -> Parser MaybeOverride
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Mod FlagFields Bool -> Parser Bool
switch Mod FlagFields Bool
negMod

-- | Parse a 'MaybeOverride' corresponding to the "fail_on_error" config option.
parseOverrideFailOnError :: Parser MaybeOverride
parseOverrideFailOnError :: Parser MaybeOverride
parseOverrideFailOnError = Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
parseOverride
                              (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"fail" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Fail on error")
                              (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"nofail" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Disable fail on error")

-- | Parse a 'MaybeOverride' corresponding to the "display_creation_time" config option.
parseOverrideDisplayCreationTime :: Parser MaybeOverride
parseOverrideDisplayCreationTime :: Parser MaybeOverride
parseOverrideDisplayCreationTime = Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
parseOverride
                                    (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"time" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Display bookmark creation times")
                                    (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"notime" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Hide bookmark creation times")

-- | Parse a 'MaybeOverride' corresponding to the "enable_clear" config option.
parseOverrideEnableClearing :: Parser MaybeOverride
parseOverrideEnableClearing :: Parser MaybeOverride
parseOverrideEnableClearing = Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
parseOverride
                                (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"enable-clear" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Enable the 'clear' command")
                                (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"disable-clear" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Disable the 'clear' command")

-- | Parse a 'MaybeOverride' corresponding to the "enable_reset" config option.
parseOverrideEnableReset :: Parser MaybeOverride
parseOverrideEnableReset :: Parser MaybeOverride
parseOverrideEnableReset = Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
parseOverride
                              (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"enable-reset" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Enable the 'config reset' command")
                              (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"disable-reset" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Disable the 'config reset' command")

-- | Parse a 'MaybeOverride' corresponding to the "backup_before_clear" config option.
parseOverrideBackupBeforeClear :: Parser MaybeOverride
parseOverrideBackupBeforeClear :: Parser MaybeOverride
parseOverrideBackupBeforeClear = Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
parseOverride
                              (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"backup-before-clear" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Backup the bookmarks file before running `hoyo clear`")
                              (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"no-backup-before-clear" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Don't backup the bookmarks file before running `hoyo clear`")

-- | Parse options for the @hoyo add@ command.
addCommand :: Parser Command
addCommand :: Parser Command
addCommand = AddOptions -> Command
Add (AddOptions -> Command) -> Parser AddOptions -> Parser Command
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (
              FilePath -> Maybe Text -> AddOptions
AddOptions
                (FilePath -> Maybe Text -> AddOptions)
-> Parser FilePath -> Parser (Maybe Text -> AddOptions)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mod ArgumentFields FilePath -> Parser FilePath
forall s. IsString s => Mod ArgumentFields s -> Parser s
strArgument (FilePath -> Mod ArgumentFields FilePath
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<dir>" Mod ArgumentFields FilePath
-> Mod ArgumentFields FilePath -> Mod ArgumentFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields FilePath
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Directory to bookmark" Mod ArgumentFields FilePath
-> Mod ArgumentFields FilePath -> Mod ArgumentFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields FilePath
forall (f :: * -> *) a. HasCompleter f => FilePath -> Mod f a
action FilePath
"directory")
                Parser (Maybe Text -> AddOptions)
-> Parser (Maybe Text) -> Parser AddOptions
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser Text -> Parser (Maybe Text)
forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Mod ArgumentFields Text -> Parser Text
forall s. IsString s => Mod ArgumentFields s -> Parser s
strArgument (FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<name>" Mod ArgumentFields Text
-> Mod ArgumentFields Text -> Mod ArgumentFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Optionally give a name to your bookmark"))
              )

-- | Parse a 'BookmarkSearchTerm'. First tries to interpret the search term as a number
-- corresponding to a bookmark index; if that fails, treat the term as a name.
bookmarkSearchTerm :: ReadM BookmarkSearchTerm
bookmarkSearchTerm :: ReadM BookmarkSearchTerm
bookmarkSearchTerm = (FilePath -> Either FilePath BookmarkSearchTerm)
-> ReadM BookmarkSearchTerm
forall a. (FilePath -> Either FilePath a) -> ReadM a
eitherReader ((FilePath -> Either FilePath BookmarkSearchTerm)
 -> ReadM BookmarkSearchTerm)
-> (FilePath -> Either FilePath BookmarkSearchTerm)
-> ReadM BookmarkSearchTerm
forall a b. (a -> b) -> a -> b
$ \FilePath
s ->
  Int -> BookmarkSearchTerm
SearchIndex (Int -> BookmarkSearchTerm)
-> Either FilePath Int -> Either FilePath BookmarkSearchTerm
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> FilePath -> Either FilePath Int
forall a. Read a => FilePath -> Either FilePath a
readEither FilePath
s
  Either FilePath BookmarkSearchTerm
-> Either FilePath BookmarkSearchTerm
-> Either FilePath BookmarkSearchTerm
forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> BookmarkSearchTerm -> Either FilePath BookmarkSearchTerm
forall a b. b -> Either a b
Right (Text -> BookmarkSearchTerm
SearchName (FilePath -> Text
T.pack FilePath
s))

-- | Parse options for the @hoyo move@ command.
moveCommand :: Parser Command
moveCommand :: Parser Command
moveCommand = MoveOptions -> Command
Move (MoveOptions -> Command)
-> (BookmarkSearchTerm -> MoveOptions)
-> BookmarkSearchTerm
-> Command
forall b c a. (b -> c) -> (a -> b) -> a -> c
. BookmarkSearchTerm -> MoveOptions
MoveOptions
                (BookmarkSearchTerm -> Command)
-> Parser BookmarkSearchTerm -> Parser Command
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ReadM BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
-> Parser BookmarkSearchTerm
forall a. ReadM a -> Mod ArgumentFields a -> Parser a
argument ReadM BookmarkSearchTerm
bookmarkSearchTerm (
                      FilePath -> Mod ArgumentFields BookmarkSearchTerm
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<bookmark>"
                      Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields BookmarkSearchTerm
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Index or name of the bookmark to move to"
                      Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
forall a. Semigroup a => a -> a -> a
<> Completer -> Mod ArgumentFields BookmarkSearchTerm
forall (f :: * -> *) a. HasCompleter f => Completer -> Mod f a
completer Completer
bookmarkCompleter
                      )

-- | Parse options for the @hoyo list@ command.
listCommand :: Parser Command
listCommand :: Parser Command
listCommand = ListOptions -> Command
List (ListOptions -> Command) -> Parser ListOptions -> Parser Command
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (
                  Maybe Text -> Maybe Text -> Bool -> ListOptions
ListOptions
                    (Maybe Text -> Maybe Text -> Bool -> ListOptions)
-> Parser (Maybe Text)
-> Parser (Maybe Text -> Bool -> ListOptions)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parser Text -> Parser (Maybe Text)
forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Mod OptionFields Text -> Parser Text
forall s. IsString s => Mod OptionFields s -> Parser s
strOption (
                          FilePath -> Mod OptionFields Text
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"name"
                          Mod OptionFields Text
-> Mod OptionFields Text -> Mod OptionFields Text
forall a. Semigroup a => a -> a -> a
<> Char -> Mod OptionFields Text
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'n'
                          Mod OptionFields Text
-> Mod OptionFields Text -> Mod OptionFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields Text
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<name>"
                          Mod OptionFields Text
-> Mod OptionFields Text -> Mod OptionFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields Text
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Search bookmarks by name"
                        ))
                    Parser (Maybe Text -> Bool -> ListOptions)
-> Parser (Maybe Text) -> Parser (Bool -> ListOptions)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser Text -> Parser (Maybe Text)
forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Mod OptionFields Text -> Parser Text
forall s. IsString s => Mod OptionFields s -> Parser s
strOption (
                          FilePath -> Mod OptionFields Text
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"dir"
                          Mod OptionFields Text
-> Mod OptionFields Text -> Mod OptionFields Text
forall a. Semigroup a => a -> a -> a
<> Char -> Mod OptionFields Text
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'd'
                          Mod OptionFields Text
-> Mod OptionFields Text -> Mod OptionFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields Text
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<directory>"
                          Mod OptionFields Text
-> Mod OptionFields Text -> Mod OptionFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields Text
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Search bookmarks by directory"
                        ))
                    Parser (Bool -> ListOptions) -> Parser Bool -> Parser ListOptions
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Mod FlagFields Bool -> Parser Bool
switch (
                          FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"json"
                          Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> Char -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'j'
                          Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"List bookmarks in JSON format"
                        )
                  )

-- | Parse options for the @hoyo clear@ command.
clearCommand :: Parser Command
clearCommand :: Parser Command
clearCommand = Command -> Parser Command
forall (f :: * -> *) a. Applicative f => a -> f a
pure (ClearOptions -> Command
Clear ClearOptions
ClearOptions)

-- | Parse options for the @hoyo delete@ command.
deleteCommand :: Parser Command
deleteCommand :: Parser Command
deleteCommand =  DeleteOptions -> Command
Delete (DeleteOptions -> Command)
-> (BookmarkSearchTerm -> DeleteOptions)
-> BookmarkSearchTerm
-> Command
forall b c a. (b -> c) -> (a -> b) -> a -> c
. BookmarkSearchTerm -> DeleteOptions
DeleteOptions
                    (BookmarkSearchTerm -> Command)
-> Parser BookmarkSearchTerm -> Parser Command
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ReadM BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
-> Parser BookmarkSearchTerm
forall a. ReadM a -> Mod ArgumentFields a -> Parser a
argument ReadM BookmarkSearchTerm
bookmarkSearchTerm (
                          FilePath -> Mod ArgumentFields BookmarkSearchTerm
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<bookmark>"
                          Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields BookmarkSearchTerm
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Index or name of the bookmark to delete"
                          Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
-> Mod ArgumentFields BookmarkSearchTerm
forall a. Semigroup a => a -> a -> a
<> Completer -> Mod ArgumentFields BookmarkSearchTerm
forall (f :: * -> *) a. HasCompleter f => Completer -> Mod f a
completer Completer
bookmarkCompleter
                        )

-- | Parse options for the @hoyo refresh@ command.
refreshCommand :: Parser Command
refreshCommand :: Parser Command
refreshCommand = Command -> Parser Command
forall (f :: * -> *) a. Applicative f => a -> f a
pure (RefreshOptions -> Command
Refresh RefreshOptions
RefreshOptions)

-- | Parse options for the @hoyo config@ command.
configCommand :: Parser Command
configCommand :: Parser Command
configCommand = ConfigCommand -> Command
ConfigCmd (ConfigCommand -> Command)
-> Parser ConfigCommand -> Parser Command
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mod CommandFields ConfigCommand -> Parser ConfigCommand
forall a. Mod CommandFields a -> Parser a
hsubparser (
  FilePath
-> ParserInfo ConfigCommand -> Mod CommandFields ConfigCommand
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"print" (Parser ConfigCommand
-> InfoMod ConfigCommand -> ParserInfo ConfigCommand
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser ConfigCommand
configPrintCommand (FilePath -> InfoMod ConfigCommand
forall a. FilePath -> InfoMod a
progDesc FilePath
"Print hoyo config"))
  Mod CommandFields ConfigCommand
-> Mod CommandFields ConfigCommand
-> Mod CommandFields ConfigCommand
forall a. Semigroup a => a -> a -> a
<> FilePath
-> ParserInfo ConfigCommand -> Mod CommandFields ConfigCommand
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"reset" (Parser ConfigCommand
-> InfoMod ConfigCommand -> ParserInfo ConfigCommand
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser ConfigCommand
configResetCommand (FilePath -> InfoMod ConfigCommand
forall a. FilePath -> InfoMod a
progDesc FilePath
"Reset hoyo config"))
  Mod CommandFields ConfigCommand
-> Mod CommandFields ConfigCommand
-> Mod CommandFields ConfigCommand
forall a. Semigroup a => a -> a -> a
<> FilePath
-> ParserInfo ConfigCommand -> Mod CommandFields ConfigCommand
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"set" (Parser ConfigCommand
-> InfoMod ConfigCommand -> ParserInfo ConfigCommand
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser ConfigCommand
configSetCommand (FilePath -> InfoMod ConfigCommand
forall a. FilePath -> InfoMod a
progDesc FilePath
"Modify hoyo config"))
  Mod CommandFields ConfigCommand
-> Mod CommandFields ConfigCommand
-> Mod CommandFields ConfigCommand
forall a. Semigroup a => a -> a -> a
<> FilePath
-> ParserInfo ConfigCommand -> Mod CommandFields ConfigCommand
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"add-default" (Parser ConfigCommand
-> InfoMod ConfigCommand -> ParserInfo ConfigCommand
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser ConfigCommand
configAddDefaultCommand (FilePath -> InfoMod ConfigCommand
forall a. FilePath -> InfoMod a
progDesc FilePath
"Add a default bookmark"))
  )

-- | Parse options for the @hoyo config print@ sub-command.
configPrintCommand :: Parser ConfigCommand
configPrintCommand :: Parser ConfigCommand
configPrintCommand = ConfigPrintOptions -> ConfigCommand
Print (ConfigPrintOptions -> ConfigCommand)
-> (Bool -> ConfigPrintOptions) -> Bool -> ConfigCommand
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Bool -> ConfigPrintOptions
ConfigPrintOptions
                        (Bool -> ConfigCommand) -> Parser Bool -> Parser ConfigCommand
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mod FlagFields Bool -> Parser Bool
switch (
                              FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"json"
                              Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> Char -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'j'
                              Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Print config in JSON format"
                            )

-- | Parse options for the @hoyo config reset@ sub-command.
configResetCommand :: Parser ConfigCommand
configResetCommand :: Parser ConfigCommand
configResetCommand = ConfigCommand -> Parser ConfigCommand
forall (f :: * -> *) a. Applicative f => a -> f a
pure (ConfigResetOptions -> ConfigCommand
Reset ConfigResetOptions
ConfigResetOptions)

-- | Parse options for the @hoyo config set@ sub-command.
configSetCommand :: Parser ConfigCommand
configSetCommand :: Parser ConfigCommand
configSetCommand = ConfigSetOptions -> ConfigCommand
Set (ConfigSetOptions -> ConfigCommand)
-> Parser ConfigSetOptions -> Parser ConfigCommand
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (
                    Text -> Text -> ConfigSetOptions
ConfigSetOptions
                      (Text -> Text -> ConfigSetOptions)
-> Parser Text -> Parser (Text -> ConfigSetOptions)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mod ArgumentFields Text -> Parser Text
forall s. IsString s => Mod ArgumentFields s -> Parser s
strArgument (
                            FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<key>"
                            Mod ArgumentFields Text
-> Mod ArgumentFields Text -> Mod ArgumentFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Option to modify"
                            Mod ArgumentFields Text
-> Mod ArgumentFields Text -> Mod ArgumentFields Text
forall a. Semigroup a => a -> a -> a
<> Completer -> Mod ArgumentFields Text
forall (f :: * -> *) a. HasCompleter f => Completer -> Mod f a
completer Completer
configKeyCompleter
                          )
                      Parser (Text -> ConfigSetOptions)
-> Parser Text -> Parser ConfigSetOptions
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Mod ArgumentFields Text -> Parser Text
forall s. IsString s => Mod ArgumentFields s -> Parser s
strArgument (
                            FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<value>"
                            Mod ArgumentFields Text
-> Mod ArgumentFields Text -> Mod ArgumentFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Option value"
                            Mod ArgumentFields Text
-> Mod ArgumentFields Text -> Mod ArgumentFields Text
forall a. Semigroup a => a -> a -> a
<> Completer -> Mod ArgumentFields Text
forall (f :: * -> *) a. HasCompleter f => Completer -> Mod f a
completer Completer
configValueCompleter
                          )
                    )

-- | Parse options for the @hoyo config add-default@ sub-command.
configAddDefaultCommand :: Parser ConfigCommand
configAddDefaultCommand :: Parser ConfigCommand
configAddDefaultCommand = ConfigAddDefaultOptions -> ConfigCommand
AddDefaultBookmark (ConfigAddDefaultOptions -> ConfigCommand)
-> Parser ConfigAddDefaultOptions -> Parser ConfigCommand
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (
                            FilePath -> Maybe Text -> ConfigAddDefaultOptions
ConfigAddDefaultOptions
                              (FilePath -> Maybe Text -> ConfigAddDefaultOptions)
-> Parser FilePath
-> Parser (Maybe Text -> ConfigAddDefaultOptions)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mod ArgumentFields FilePath -> Parser FilePath
forall s. IsString s => Mod ArgumentFields s -> Parser s
strArgument (
                                    FilePath -> Mod ArgumentFields FilePath
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<dir>"
                                    Mod ArgumentFields FilePath
-> Mod ArgumentFields FilePath -> Mod ArgumentFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields FilePath
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Directory to bookmark"
                                    Mod ArgumentFields FilePath
-> Mod ArgumentFields FilePath -> Mod ArgumentFields FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields FilePath
forall (f :: * -> *) a. HasCompleter f => FilePath -> Mod f a
action FilePath
"directory"
                                  )
                              Parser (Maybe Text -> ConfigAddDefaultOptions)
-> Parser (Maybe Text) -> Parser ConfigAddDefaultOptions
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser Text -> Parser (Maybe Text)
forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Mod ArgumentFields Text -> Parser Text
forall s. IsString s => Mod ArgumentFields s -> Parser s
strArgument (
                                    FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<name>"
                                    Mod ArgumentFields Text
-> Mod ArgumentFields Text -> Mod ArgumentFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Optionally give a name to your bookmark"
                                  ))
                          )

-- | `hoyo check` should be considered equivalent to `hoyo check --config --bookmarks`
noArgs :: CheckOptions -> CheckOptions
noArgs :: CheckOptions -> CheckOptions
noArgs (CheckOptions Bool
False Bool
False) = Bool -> Bool -> CheckOptions
CheckOptions Bool
True Bool
True
noArgs CheckOptions
opts                       = CheckOptions
opts

-- | Parse options for the @hoyo check@ command.
checkCommand :: Parser Command
checkCommand :: Parser Command
checkCommand = CheckOptions -> Command
Check (CheckOptions -> Command)
-> (CheckOptions -> CheckOptions) -> CheckOptions -> Command
forall b c a. (b -> c) -> (a -> b) -> a -> c
. CheckOptions -> CheckOptions
noArgs (CheckOptions -> Command) -> Parser CheckOptions -> Parser Command
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (
                Bool -> Bool -> CheckOptions
CheckOptions
                  (Bool -> Bool -> CheckOptions)
-> Parser Bool -> Parser (Bool -> CheckOptions)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Mod FlagFields Bool -> Parser Bool
switch (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"config" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> Char -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'c' Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Check the config file")
                  Parser (Bool -> CheckOptions) -> Parser Bool -> Parser CheckOptions
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Mod FlagFields Bool -> Parser Bool
switch (FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"bookmarks" Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> Char -> Mod FlagFields Bool
forall (f :: * -> *) a. HasName f => Char -> Mod f a
short Char
'b' Mod FlagFields Bool -> Mod FlagFields Bool -> Mod FlagFields Bool
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod FlagFields Bool
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Check the bookmarks file")
                )

-- | Parse options for the @hoyo help@ command.
helpCommand :: Parser Command
helpCommand :: Parser Command
helpCommand = HelpOptions -> Command
Help (HelpOptions -> Command)
-> (Maybe Text -> HelpOptions) -> Maybe Text -> Command
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe Text -> HelpOptions
HelpOptions
                (Maybe Text -> Command) -> Parser (Maybe Text) -> Parser Command
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parser Text -> Parser (Maybe Text)
forall (f :: * -> *) a. Alternative f => f a -> f (Maybe a)
optional (Mod ArgumentFields Text -> Parser Text
forall s. IsString s => Mod ArgumentFields s -> Parser s
strArgument (
                                FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. HasMetavar f => FilePath -> Mod f a
metavar FilePath
"<command>"
                                Mod ArgumentFields Text
-> Mod ArgumentFields Text -> Mod ArgumentFields Text
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod ArgumentFields Text
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Command to get help with"
                              )
                            )

-- | If hoyo is run with no arguments, we run the "default command" if it's set.
defaultCommand :: Parser Command
defaultCommand :: Parser Command
defaultCommand = Command -> Parser Command
forall (f :: * -> *) a. Applicative f => a -> f a
pure Command
DefaultCommand

-- | Parse a command and the arguments/options for that
-- command from the command-line arguments.
parseCommand :: Parser Command
parseCommand :: Parser Command
parseCommand = (Parser (Command -> Command)
forall a. Parser (a -> a)
versionOption Parser (Command -> Command) -> Parser Command -> Parser Command
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Mod CommandFields Command -> Parser Command
forall a. Mod CommandFields a -> Parser a
hsubparser (
  FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"add" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
addCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"Add a bookmark"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"move" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
moveCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"Change directory using a bookmark"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"list" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
listCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"List existing bookmarks"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"clear" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
clearCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"Clear all bookmarks"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"delete" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
deleteCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"Delete a bookmark"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"refresh" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
refreshCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"Re-calculate bookmark indices"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"config" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
configCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"View/manage hoyo config"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"check" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
checkCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"Verify validity of config and bookmarks"))
  Mod CommandFields Command
-> Mod CommandFields Command -> Mod CommandFields Command
forall a. Semigroup a => a -> a -> a
<> FilePath -> ParserInfo Command -> Mod CommandFields Command
forall a. FilePath -> ParserInfo a -> Mod CommandFields a
command FilePath
"help" (Parser Command -> InfoMod Command -> ParserInfo Command
forall a. Parser a -> InfoMod a -> ParserInfo a
info Parser Command
helpCommand (FilePath -> InfoMod Command
forall a. FilePath -> InfoMod a
progDesc FilePath
"Print a help message for the entire program or a specific command"))
  )) Parser Command -> Parser Command -> Parser Command
forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Parser Command
defaultCommand

-- | Parse an 'Options' argument, which includes the command
-- to run and any global options.
parseOptions :: Parser Options
parseOptions :: Parser Options
parseOptions = Command -> GlobalOptions -> Options
Options (Command -> GlobalOptions -> Options)
-> Parser Command -> Parser (GlobalOptions -> Options)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Parser Command
parseCommand Parser (GlobalOptions -> Options)
-> Parser GlobalOptions -> Parser Options
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Parser GlobalOptions
globalOptions

-- | Version information printed by `hoyo --version`.
versionInfo :: String
versionInfo :: FilePath
versionInfo =
  FilePath
"hoyo "
  FilePath -> FilePath -> FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath
versionString
  FilePath -> FilePath -> FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath
"\n\nCopyright (c) 2023, Frederick Pringle\n\nAll rights reserved."

-- | Add a hidden --version flag to the end of a parser.
versionOption :: Parser (a -> a)
versionOption :: Parser (a -> a)
versionOption = FilePath -> Mod OptionFields (a -> a) -> Parser (a -> a)
forall a. FilePath -> Mod OptionFields (a -> a) -> Parser (a -> a)
infoOption FilePath
versionInfo (
                  FilePath -> Mod OptionFields (a -> a)
forall (f :: * -> *) a. HasName f => FilePath -> Mod f a
long FilePath
"version"
                  Mod OptionFields (a -> a)
-> Mod OptionFields (a -> a) -> Mod OptionFields (a -> a)
forall a. Semigroup a => a -> a -> a
<> Mod OptionFields (a -> a)
forall (f :: * -> *) a. Mod f a
hidden
                  Mod OptionFields (a -> a)
-> Mod OptionFields (a -> a) -> Mod OptionFields (a -> a)
forall a. Semigroup a => a -> a -> a
<> FilePath -> Mod OptionFields (a -> a)
forall (f :: * -> *) a. FilePath -> Mod f a
help FilePath
"Display version information and exit"
                )

-- | A footer to display at the end of the long help message.
hoyoFooter :: Chunk Doc
hoyoFooter :: Chunk Doc
hoyoFooter =
  let
    withTitle :: FilePath -> f Doc -> f Doc
withTitle FilePath
title = (Doc -> Doc) -> f Doc -> f Doc
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap ((FilePath -> Doc
string FilePath
title Doc -> Doc -> Doc
.$.) (Doc -> Doc) -> (Doc -> Doc) -> Doc -> Doc
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Int -> Doc -> Doc
indent Int
2)
    bugText :: Chunk Doc
bugText = FilePath -> Chunk Doc
paragraph FilePath
"If something went wrong unexpectedly or you think there's a problem with hoyo, let me know! To report an issue, create a bug report at https://github.com/fpringle/hoyo/issues"
    docText :: Chunk Doc
docText = FilePath -> Chunk Doc
paragraph FilePath
"To read the web documentation, visit https://github.com/fpringle/hoyo#readme"
  in [Chunk Doc] -> Chunk Doc
vsepChunks [
        FilePath -> Chunk Doc -> Chunk Doc
forall (f :: * -> *). Functor f => FilePath -> f Doc -> f Doc
withTitle FilePath
"Bugs:" Chunk Doc
bugText
      , FilePath -> Chunk Doc -> Chunk Doc
forall (f :: * -> *). Functor f => FilePath -> f Doc -> f Doc
withTitle FilePath
"Online documentation:" Chunk Doc
docText
      ]

-- | A 'ParserInfo' object containing the necessary information for parsing
-- CLI commands and arguments, and displaying useful help text.
options :: ParserInfo Options
options :: ParserInfo Options
options = Parser Options -> InfoMod Options -> ParserInfo Options
forall a. Parser a -> InfoMod a -> ParserInfo a
info (Parser Options
parseOptions Parser Options -> Parser (Options -> Options) -> Parser Options
forall (f :: * -> *) a b. Applicative f => f a -> f (a -> b) -> f b
<**> Parser (Options -> Options)
forall a. Parser (a -> a)
helper) (
          InfoMod Options
forall a. InfoMod a
fullDesc
          InfoMod Options -> InfoMod Options -> InfoMod Options
forall a. Semigroup a => a -> a -> a
<> FilePath -> InfoMod Options
forall a. FilePath -> InfoMod a
header FilePath
"Set directory bookmarks for quick \"cd\" behaviour"
          InfoMod Options -> InfoMod Options -> InfoMod Options
forall a. Semigroup a => a -> a -> a
<> FilePath -> InfoMod Options
forall a. FilePath -> InfoMod a
progDesc FilePath
"For more help on a particular sub-command, run `hoyo <cmd> --help`."
          InfoMod Options -> InfoMod Options -> InfoMod Options
forall a. Semigroup a => a -> a -> a
<> FilePath -> InfoMod Options
forall a. FilePath -> InfoMod a
footer FilePath
"for full documentation go to github"
          InfoMod Options -> InfoMod Options -> InfoMod Options
forall a. Semigroup a => a -> a -> a
<> Maybe Doc -> InfoMod Options
forall a. Maybe Doc -> InfoMod a
footerDoc (Chunk Doc -> Maybe Doc
forall a. Chunk a -> Maybe a
unChunk Chunk Doc
hoyoFooter)
          )

-- | Show the help message. Pass a non-'Nothing' argument to specify a command.
-- If the help message is longer than a page, pass it through the system's pager.
showHelp :: Maybe String -> IO ()
showHelp :: Maybe FilePath -> IO ()
showHelp Maybe FilePath
cmd = do
  let failure :: ParserFailure ParserHelp
failure = ParserPrefs
-> ParserInfo Options
-> ParseError
-> [Context]
-> ParserFailure ParserHelp
forall a.
ParserPrefs
-> ParserInfo a
-> ParseError
-> [Context]
-> ParserFailure ParserHelp
parserFailure ParserPrefs
defaultPrefs ParserInfo Options
options (Maybe FilePath -> ParseError
ShowHelpText Maybe FilePath
cmd) []
  FilePath
progn <- IO FilePath
getProgName
  let (FilePath
msg, ExitCode
exit) = ParserFailure ParserHelp -> FilePath -> (FilePath, ExitCode)
renderFailure ParserFailure ParserHelp
failure FilePath
progn
  let msg' :: FilePath
msg' = (Char -> Bool) -> FilePath -> FilePath
forall a. (a -> Bool) -> [a] -> [a]
dropWhileEnd Char -> Bool
isSpace FilePath
msg FilePath -> FilePath -> FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath
"\n"
  Text -> IO ()
printOrPage (Text -> IO ()) -> Text -> IO ()
forall a b. (a -> b) -> a -> b
$ FilePath -> Text
T.pack FilePath
msg'
  ExitCode -> IO ()
forall a. ExitCode -> IO a
exitWith ExitCode
exit

-- | Split a string into arguments as they would be interpreted on the command line.
--
-- Adapted from [this StackOverflow comment](https://stackoverflow.com/a/64236441).
splitArgs :: T.Text -> [String]
splitArgs :: Text -> [FilePath]
splitArgs = Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' Bool
False Bool
False Bool
False FilePath
"" (FilePath -> [FilePath])
-> (Text -> FilePath) -> Text -> [FilePath]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> FilePath
T.unpack
  where
    splitArgs' :: Bool -> Bool -> Bool -> String -> String -> [String]
    splitArgs' :: Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' Bool
_ Bool
_ Bool
True FilePath
res [] = [FilePath
res]
    splitArgs' Bool
_ Bool
_ Bool
False FilePath
_ [] = []

    splitArgs' Bool
False Bool
_ Bool
_ FilePath
res (Char
'^':FilePath
rest) = Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' Bool
False Bool
False Bool
True (FilePath
res FilePath -> FilePath -> FilePath
forall a. Semigroup a => a -> a -> a
<> FilePath
"^") FilePath
rest

    splitArgs' Bool
quoted Bool
True Bool
_ FilePath
res (Char
chr:FilePath
rest) = Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' Bool
quoted Bool
False Bool
True (FilePath
res FilePath -> FilePath -> FilePath
forall a. Semigroup a => a -> a -> a
<> [Char
chr]) FilePath
rest

    splitArgs' Bool
quoted Bool
escaped Bool
_ FilePath
res (Char
'"':FilePath
rest) = Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' (Bool -> Bool
not Bool
quoted) Bool
escaped Bool
True FilePath
res FilePath
rest

    splitArgs' Bool
quoted Bool
False Bool
started FilePath
res (Char
'\\':Char
'"':FilePath
rest) = Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' Bool
quoted Bool
True Bool
started FilePath
res (Char
'"'Char -> FilePath -> FilePath
forall a. a -> [a] -> [a]
:FilePath
rest)

    splitArgs' Bool
False Bool
escaped Bool
started FilePath
res (Char
' ':FilePath
rest) = [FilePath
res | Bool
started] [FilePath] -> [FilePath] -> [FilePath]
forall a. Semigroup a => a -> a -> a
<> Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' Bool
False Bool
escaped Bool
False FilePath
"" FilePath
rest

    splitArgs' Bool
quoted Bool
escaped Bool
_ FilePath
res (Char
chr:FilePath
rest) = Bool -> Bool -> Bool -> FilePath -> FilePath -> [FilePath]
splitArgs' Bool
quoted Bool
escaped Bool
True (FilePath
res FilePath -> FilePath -> FilePath
forall a. Semigroup a => a -> a -> a
<> [Char
chr]) FilePath
rest