From a6cdfdccfd07556527352ea5c46e82b7467e307f Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Fri, 5 Oct 2012 21:31:21 +0200
Subject: [PATCH] Add support for arguments in --help-completion
This extends the current option-only support with support for
arguments too. They are serialised without a without the prefix (so
just with the type) and the min/max ranges (max="none" for unlimited).
A few new option types have been added as well.
Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>
---
htools/Ganeti/Common.hs | 27 ++++++++++++++++++++++-----
1 file changed, 22 insertions(+), 5 deletions(-)
diff --git a/htools/Ganeti/Common.hs b/htools/Ganeti/Common.hs
index 2d4111811..e7e7a1e18 100644
--- a/htools/Ganeti/Common.hs
+++ b/htools/Ganeti/Common.hs
@@ -30,6 +30,7 @@ module Ganeti.Common
( GenericOptType
, StandardOptions(..)
, OptCompletion(..)
+ , ArgCompletion(..)
, optComplYesNo
, oShowHelp
, oShowVer
@@ -71,10 +72,19 @@ data OptCompletion = OptComplNone -- ^ No parameter to this option
| OptComplInstAddNodes -- ^ Either one or two nodes
| OptComplOneGroup -- ^ One group
| OptComplNumeric -- ^ Float values
+ | OptComplJobId -- ^ Job Id
+ | OptComplCommand -- ^ Command (executable)
| OptComplString -- ^ Arbitrary string
| OptComplChoices [String] -- ^ List of string choices
+ | OptComplSuggest [String] -- ^ Suggested choices
deriving (Show, Read, Eq)
+-- | Argument type. This differs from (and wraps) an Option by the
+-- fact that it can (and usually does) support multiple repetitions of
+-- the same argument, via a min and max limit.
+data ArgCompletion = ArgCompletion OptCompletion Int (Maybe Int)
+ deriving (Show, Read, Eq)
+
-- | Yes\/no choices completion.
optComplYesNo :: OptCompletion
optComplYesNo = OptComplChoices ["yes", "no"]
@@ -82,11 +92,17 @@ optComplYesNo = OptComplChoices ["yes", "no"]
-- | Text serialisation for 'OptCompletion', used on the Python side.
complToText :: OptCompletion -> String
complToText (OptComplChoices choices) = "choices " ++ intercalate "," choices
+complToText (OptComplSuggest choices) = "suggest " ++ intercalate "," choices
complToText compl =
let show_compl = show compl
stripped = stripPrefix "OptCompl" show_compl
in map toLower $ fromMaybe show_compl stripped
+-- | Tex serialisation for 'ArgCompletion'.
+argComplToText :: ArgCompletion -> String
+argComplToText (ArgCompletion optc min_cnt max_cnt) =
+ complToText optc ++ " " ++ show min_cnt ++ " " ++ maybe "none" show max_cnt
+
-- | Abrreviation for the option type.
type GenericOptType a = (OptDescr (a -> Result a), OptCompletion)
@@ -131,13 +147,14 @@ versionInfo progname =
os arch
-- | Show completion info.
-completionInfo :: String -> [GenericOptType a] -> String
-completionInfo _ =
- unlines .
+completionInfo :: String -> [GenericOptType a] -> [ArgCompletion] -> String
+completionInfo _ opts args =
+ unlines $
map (\(Option shorts longs _ _, compinfo) ->
let all_opts = map (\c -> ['-', c]) shorts ++ map ("--" ++) longs
in intercalate "," all_opts ++ " " ++ complToText compinfo
- )
+ ) opts ++
+ map argComplToText args
-- | Helper for parsing a yes\/no command line flag.
parseYesNo :: Bool -- ^ Default value (when we get a @Nothing@)
@@ -199,7 +216,7 @@ parseOptsInner defaults argv progname options =
, (verRequested parsed,
Left (ExitSuccess, versionInfo progname))
, (compRequested parsed,
- Left (ExitSuccess, completionInfo progname options))
+ Left (ExitSuccess, completionInfo progname options []))
]
(_, _, errs) ->
Left (ExitFailure 2, "Command line error: " ++ concat errs ++ "\n" ++
--
GitLab