Skip to content

Added help for individual commands #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ritikasa wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added help for individual commands #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 164 additions & 6 deletions include/cli/cli.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
#include "volatilehistorystorage.h"
#include <iostream>
#include <utility>
#include <numeric>

namespace cli
{
Expand Down Expand Up @@ -262,6 +263,7 @@ namespace cli
virtual void Disable() { enabled = false; }
virtual bool Exec(const std::vector<std::string>& cmdLine, CliSession& session) = 0;
virtual void Help(std::ostream& out) const = 0;
virtual void FunctionHelp(std::ostream& out) const = 0;
// Returns the collection of completions relatives to this command.
// For simple commands, provides a base implementation that use the name of the command
// for aggregate commands (i.e., Menu), the function is redefined to give the menu command
Expand Down Expand Up @@ -323,10 +325,16 @@ namespace cli

void Current(Menu* menu) { current = menu; }

Menu* Current() {return current;}

std::ostream& OutStream() { return out; }

void Help() const;

void FunctionHelp(const std::string& arg);

void WrongCommandHandler(std::ostream& out, const std::string& cmd);

void Enter()
{
cli.EnterAction(out);
Expand Down Expand Up @@ -443,6 +451,15 @@ namespace cli

// ********************************************************************

auto getName = [](const Command& cmd) -> const std::string& {
class Accessor : public Command {
public:
using Command::Name; // Expose the protected method
};
return static_cast<const Accessor&>(cmd).Name();
};


class Menu : public Command
{
public:
Expand All @@ -460,7 +477,8 @@ namespace cli
description(std::move(desc)),
prompt(_prompt.empty() ? _name : _prompt),
cmds(std::make_shared<Cmds>())
{}
{
}

template <typename R, typename ... Args>
CmdHandler Insert(const std::string& cmdName, R (*f)(std::ostream&, Args...), const std::string& help, const std::vector<std::string>& parDesc={});
Expand Down Expand Up @@ -531,12 +549,103 @@ namespace cli
parent->Help(out);
}


void MainFunctionHelp(std::ostream& out, const std::string& arg, CliSession& session) {
if (!IsEnabled()) return;
bool added = false;
if (parent && (parent->parent == nullptr)) {
Insert(
parent->Prompt(),
[this](std::ostream&){},
"(menu)"
);
added = true;
}

for (auto& cmd: *cmds) {
std::string cmdName = getName(*cmd);
auto originalMenu = session.Current();
if (HandleCommand({cmdName}, {arg}, session)) {
cmd->FunctionHelp(out);
session.Current(originalMenu);
if (added == true) {
cmds->pop_back();
}

return;
}
session.Current(originalMenu);
}
if (parent != nullptr) {
if (added == true) {
cmds->pop_back();
}
parent->MainFunctionHelp(out, arg, session);
}
else {
session.WrongCommandHandler(out, arg);
if (added == true) {
cmds->pop_back();
}

}
}


void Help(std::ostream& out) const override
{
if (!IsEnabled()) return;
out << " - " << Name() << "\n\t" << description << "\n";
}

void FunctionHelp(std::ostream& out) const override
{
if (!IsEnabled()) return;
out << "\t" << description << "\n";
}

bool CheckCommand(const std::string& arg, CliSession& session)
{
bool added = false;
std::vector<std::string> cmdNames;
if (parent && (parent->parent == nullptr)) {
Insert(
parent->Prompt(),
[this](std::ostream&){},
"(menu)"
);
added = true;
}

for (auto& cmd: *cmds) {
std::string cmdName = getName(*cmd);
cmdNames.push_back(cmdName);
}


auto originalMenu = session.Current();
if (HandleCommand(cmdNames, {arg}, session)) {
session.Current(originalMenu);
if (added == true) {
cmds->pop_back();
}
return true;
}
session.Current(originalMenu);

if (parent != nullptr) {
if (added == true) {
cmds->pop_back();
}
return parent->CheckCommand(arg, session);
}

if (added == true) {
cmds->pop_back();
}
return false;
}

// returns:
// - the completions of this menu command
// - the recursive completions of subcommands
Expand Down Expand Up @@ -577,6 +686,8 @@ namespace cli
return Command::GetCompletionRecursive(line);
}



private:

/**
Expand Down Expand Up @@ -799,12 +910,19 @@ namespace cli
{
if (!IsEnabled()) return;
out << " - " << Name();
if (parameterDesc.empty())
if (parameterDesc.empty() && std::strcmp(TypeDesc<std::vector<std::string>>::Name(), "<list of strings>"))
PrintDesc<Args...>::Dump(out);
for (auto& s: parameterDesc)
out << " <" << s << '>';
out << "\n\t" << description << "\n";
}
void FunctionHelp(std::ostream& out) const override
{
if (!IsEnabled()) return;
if (parameterDesc.empty() && std::strcmp(TypeDesc<std::vector<std::string>>::Name(), "<list of strings>"))
PrintDesc<std::vector<std::string>>::Dump(out);
out << "\t" << description << "\n";
}

private:

Expand Down Expand Up @@ -847,12 +965,20 @@ namespace cli
{
if (!IsEnabled()) return;
out << " - " << Name();
if (parameterDesc.empty())
PrintDesc<std::vector<std::string>>::Dump(out);
if (parameterDesc.empty() && std::strcmp(TypeDesc<std::vector<std::string>>::Name(), "<list of strings>"))
PrintDesc<std::vector<std::string>>::Dump(out);
for (auto& s: parameterDesc)
out << " <" << s << '>';
out << "\n\t" << description << "\n";
}
void FunctionHelp(std::ostream& out) const override
{
if (!IsEnabled()) return;
if (parameterDesc.empty() && std::strcmp(TypeDesc<std::vector<std::string>>::Name(), "<list of strings>"))
PrintDesc<std::vector<std::string>>::Dump(out);
out << "\t" << description << "\n";
}


private:

Expand Down Expand Up @@ -889,8 +1015,22 @@ namespace cli
coutPtr->Register(out);
globalScopeMenu->Insert(
"help",
[this](std::ostream&){ Help(); },
"This help message"
[this](std::ostream&, const std::vector<std::string>& args) {
if (args.empty()) {
Help();
}
else if (args.size() > 1) {
std::string result = std::accumulate(args.begin(), args.end(), std::string(),
[](const std::string& a, const std::string& b) {
return a.empty() ? b : a + " " + b; // Add a space between strings
});
this->cli.WrongCommandHandler(out, result);
}
else {
FunctionHelp(args[0]);
}
},
"This help message"
);
globalScopeMenu->Insert(
"exit",
Expand Down Expand Up @@ -957,6 +1097,24 @@ namespace cli
current -> MainHelp( out );
}

inline void CliSession::FunctionHelp(const std::string& arg)
{
if (globalScopeMenu->CheckCommand(arg, *this)) {
globalScopeMenu->MainFunctionHelp(out, arg, *this);
} else if (current->CheckCommand(arg, *this)) {
current->MainFunctionHelp(out, arg, *this);
} else {
WrongCommandHandler(out, arg); // Command not found in either scope
}
}

inline void CliSession::WrongCommandHandler(std::ostream& out, const std::string& cmd)
{
cli.WrongCommandHandler(out, cmd);
}



inline std::vector<std::string> CliSession::GetCompletions(std::string currentLine) const
{
// trim_left(currentLine);
Expand Down