From a94c554a7bd9c290b6ba19f65e95c3dd62f65ce0 Mon Sep 17 00:00:00 2001
From: Maxime Coste <frrrwww@gmail.com>
Date: Sun, 8 Feb 2015 19:04:20 +0000
Subject: Add optional helper for commands, to get parameter dependent help

Use for the set command to document options.
---
 src/command_manager.hh | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'src/command_manager.hh')

diff --git a/src/command_manager.hh b/src/command_manager.hh
index 75b15567..3226449e 100644
--- a/src/command_manager.hh
+++ b/src/command_manager.hh
@@ -24,6 +24,8 @@ using CommandCompleter = std::function<Completions (const Context& context,
                                                     CompletionFlags,
                                                     CommandParameters,
                                                     size_t, ByteCount)>;
+using CommandHelper = std::function<String (const Context& context, CommandParameters)>;
+
 enum class CommandFlags
 {
     None   = 0,
@@ -74,6 +76,7 @@ public:
                           String docstring,
                           ParameterDesc param_desc,
                           CommandFlags flags = CommandFlags::None,
+                          CommandHelper helper = CommandHelper(),
                           CommandCompleter completer = CommandCompleter());
 
 private:
@@ -86,6 +89,7 @@ private:
         String docstring;
         ParameterDesc param_desc;
         CommandFlags flags;
+        CommandHelper helper;
         CommandCompleter completer;
     };
     using CommandMap = UnorderedMap<String, CommandDescriptor, MemoryDomain::Commands>;
-- 
cgit v1.2.3