icinga2/lib/cli/clicommand.hpp

104 lines
4.3 KiB
C++
Raw Normal View History

/******************************************************************************
* Icinga 2 *
2016-01-12 08:29:59 +01:00
* Copyright (C) 2012-2016 Icinga Development Team (https://www.icinga.org/) *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#ifndef CLICOMMAND_H
#define CLICOMMAND_H
2014-10-20 20:04:26 +02:00
#include "cli/i2-cli.hpp"
#include "base/value.hpp"
#include "base/utility.hpp"
2014-11-03 00:44:04 +01:00
#include "base/type.hpp"
#include <vector>
#include <boost/program_options.hpp>
2014-11-11 13:22:16 +01:00
#include <boost/algorithm/string/split.hpp>
#include <boost/algorithm/string/classification.hpp>
namespace icinga
{
2014-10-20 20:04:26 +02:00
std::vector<String> I2_CLI_API GetBashCompletionSuggestions(const String& type, const String& word);
2014-11-03 00:44:04 +01:00
std::vector<String> I2_CLI_API GetFieldCompletionSuggestions(const Type::Ptr& type, const String& word);
enum ImpersonationLevel
{
ImpersonateNone,
ImpersonateRoot,
ImpersonateIcinga
};
/**
* A CLI command.
*
* @ingroup base
*/
2014-10-20 20:04:26 +02:00
class I2_CLI_API CLICommand : public Object
{
public:
2014-11-07 12:32:25 +01:00
DECLARE_PTR_TYPEDEFS(CLICommand);
typedef std::vector<String>(*ArgumentCompletionCallback)(const String&, const String&);
virtual String GetDescription(void) const = 0;
virtual String GetShortDescription(void) const = 0;
virtual int GetMinArguments(void) const;
virtual int GetMaxArguments(void) const;
virtual bool IsHidden(void) const;
virtual void InitParameters(boost::program_options::options_description& visibleDesc,
boost::program_options::options_description& hiddenDesc) const;
virtual ImpersonationLevel GetImpersonationLevel(void) const;
virtual int Run(const boost::program_options::variables_map& vm, const std::vector<std::string>& ap) const = 0;
virtual std::vector<String> GetArgumentSuggestions(const String& argument, const String& word) const;
virtual std::vector<String> GetPositionalSuggestions(const String& word) const;
static CLICommand::Ptr GetByName(const std::vector<String>& name);
static void Register(const std::vector<String>& name, const CLICommand::Ptr& command);
static void Unregister(const std::vector<String>& name);
static bool ParseCommand(int argc, char **argv, boost::program_options::options_description& visibleDesc,
2014-10-15 08:45:58 +02:00
boost::program_options::options_description& hiddenDesc,
boost::program_options::positional_options_description& positionalDesc,
boost::program_options::variables_map& vm, String& cmdname,
CLICommand::Ptr& command, bool autocomplete);
static void ShowCommands(int argc, char **argv,
2014-10-15 08:45:58 +02:00
boost::program_options::options_description *visibleDesc = NULL,
boost::program_options::options_description *hiddenDesc = NULL,
ArgumentCompletionCallback globalArgCompletionCallback = NULL,
bool autocomplete = false, int autoindex = -1);
private:
static boost::mutex& GetRegistryMutex(void);
static std::map<std::vector<String>, CLICommand::Ptr>& GetRegistry(void);
};
#define REGISTER_CLICOMMAND(name, klass) \
namespace { namespace UNIQUE_NAME(cli) { \
2014-11-11 13:22:16 +01:00
void RegisterCommand(void) \
{ \
std::vector<String> vname; \
boost::algorithm::split(vname, name, boost::is_any_of("/")); \
CLICommand::Register(vname, new klass()); \
} \
INITIALIZE_ONCE(RegisterCommand); \
} }
}
#endif /* CLICOMMAND_H */