Base command interface for a shell. More...

#include <bayeux/datatools/ui/shell_command_interface.h>

Inheritance diagram for datatools::ui::shell_command_interface:

Public Member Functions
	shell_command_interface ()
	Default constructor. More...

	shell_command_interface (const std::string &name_, const std::string &description_="", const datatools::version_id &vid_=datatools::version_id::invalid())
	Default constructor. More...

	shell_command_interface (basic_shell &sh_, const std::string &name_, const std::string &description_="", const datatools::version_id &vid_=datatools::version_id::invalid())
	Constructor. More...

virtual	~shell_command_interface ()
	Destructor. More...

virtual bool	is_initialized () const
	Check initialization status. More...

virtual void	initialize (const datatools::properties &config_, const datatools::service_manager &services_)
	Initialization. More...

virtual void	reset ()
	Reset. More...

bool	is_inhibit_load () const
	Check if the load command is inhibited. More...

void	set_inhibit_load (bool)
	Set the load command inhibition flag. More...

bool	is_inhibit_cd () const
	Check if the cd command is inhibited. More...

void	set_inhibit_cd (bool)
	Set the cd command inhibition flag. More...

bool	has_shell () const
	Check if the shell is set. More...

basic_shell &	grab_shell ()
	Return a mutable reference to the shell. More...

const basic_shell &	get_shell () const
	Return a non mutable reference to the shell. More...

Public Member Functions inherited from datatools::ui::target_command_interface< basic_shell >
	target_command_interface ()
	Default constructor. More...

	target_command_interface (const std::string &name_, const std::string &description_="", const version_id &vid_=version_id::invalid())
	Constructor. More...

	target_command_interface (basic_shell &target_, const std::string &name_, const std::string &description_="", const version_id &vid_=version_id::invalid())
	Constructor. More...

virtual	~target_command_interface ()
	Destructor. More...

bool	has_target () const
	Check if the target is set. More...

void	set_target (basic_shell &target_)
	Set the target object. More...

const basic_shell &	get_target () const
	Return the target. More...

basic_shell &	grab_target ()
	Return the target. More...

virtual void	tree_dump (std::ostream &out_=std::clog, const std::string &title_="", const std::string &indent_="", bool inherit_=false) const
	Smart print. More...

Public Member Functions inherited from datatools::ui::base_command_interface
	base_command_interface ()
	Default constructor. More...

	base_command_interface (const std::string &name_, const std::string &description_="", const version_id &vid_=version_id::invalid())
	Constructor. More...

virtual	~base_command_interface ()
	Destructor. More...

bool	has_version () const
	Check if the version is set. More...

void	set_version (const datatools::version_id &version_)
	Set the version. More...

const datatools::version_id &	get_version () const
	Return the version. More...

std::size_t	size () const
	Return the number of commands. More...

bool	has_command (const std::string &command_name_) const
	Check if a command with given name exists. More...

base_command &	grab_command (const std::string &command_name_)
	Return a reference to a mutable command. More...

const base_command &	get_command (const std::string &command_name_) const
	Return a reference to a command. More...

base_command_interface &	add_command (base_command &command_, const std::string &command_name_="")
	Add an external command object. More...

base_command_interface &	add_command (base_command *command_, const std::string &command_name_="")

void	remove_command (const std::string &command_name_)
	Remove a command. More...

void	remove_all_commands ()
	Remove all commands. More...

void	build_command_names (std::vector< std::string > &names_) const
	Build the list of command names. More...

void	initialize_simple ()
	Initialize the parser. More...

void	initialize_standalone (const datatools::properties &)
	Initialize the parser using only a list of properties. More...

bool	is_valid () const
	Check if the command interface is valid. More...

bool	is_disabled () const
	Check if the command interface is disabled. More...

int	operator() (const std::vector< std::string > &argv_, datatools::command::returned_info &cri_, uint32_t flags_=0)
	Main command call operator. More...

datatools::command::returned_info	operator() (const std::vector< std::string > &argv_, uint32_t flags_=0)
	Command call operator. More...

void	call (const std::vector< std::string > &argv_, datatools::command::returned_info &cri_, uint32_t flags_=0)
	Call method. More...

Public Member Functions inherited from datatools::enriched_base
virtual bool	is_name_valid (const std::string &name_) const
	Check if a name is valid. More...

	enriched_base ()
	Default constructor. More...

	enriched_base (const std::string &name_, const std::string &display_name_="", const std::string &terse_description_="", logger::priority lp_=logger::PRIO_FATAL)
	Constructor. More...

virtual	~enriched_base ()
	Destructor. More...

bool	has_name () const
	Check if the name is not empty. More...

void	set_name (const std::string &name_)
	Set the name. More...

enriched_base &	set_name_c (const std::string &name_)
	Set the name. More...

const std::string &	get_name () const
	Return the name. More...

void	reset_name ()
	Reset the name. More...

bool	has_display_name () const
	Check if the display name is empty. More...

void	set_display_name (const std::string &display_name_)
	Set the display name. More...

enriched_base &	set_display_name_c (const std::string &display_name_)
	Set the display name. More...

const std::string &	get_display_name () const
	Return the display name. More...

bool	has_terse_description () const
	Check if the description is empty. More...

void	set_terse_description (const std::string &terse_description_)
	Set the description. More...

enriched_base &	set_terse_description_c (const std::string &terse_description_)
	Set the description. More...

const std::string &	get_terse_description () const
	Return the description. More...

bool	has_auxiliaries () const
	Check if the container of auxiliary properties is empty. More...

const datatools::properties &	get_auxiliaries () const
	Return a reference to the non mutable container of auxiliary properties. More...

datatools::properties &	grab_auxiliaries ()
	Return a reference to the mutable container of auxiliary properties. More...

void	reset_auxiliaries ()
	Remove all auxiliary properties. More...

bool	is_debug () const
	Check the debug status. More...

void	set_logging_priority (logger::priority lp_)
	Set the logging priority threshold. More...

enriched_base &	set_logging_priority_c (logger::priority lp_)
	Set the logging priority threshold. More...

void	set_logging (const std::string &label_)
	Set the logging priority threshold from a string. More...

logger::priority	get_logging_priority () const
	Return the logging priority threshold. More...

void	clear ()
	Clear. More...

void	reset ()
	Clear. More...

void	print_tree (std::ostream &out_=std::clog, const boost::property_tree::ptree &options_=empty_options()) const override
	Smart print. More...

void	initialize (const datatools::properties &config_, bool clear_=false)
	Initialization from a container of properties. More...

void	export_to_config (datatools::properties &config_, uint32_t flags_=EXPORT_CONFIG_DEFAULT, const std::string &prefix_="") const
	Export to a container of properties. More...

Public Member Functions inherited from datatools::i_serializable
	i_serializable ()
	Default constructor. More...

virtual	~i_serializable ()
	Destructor. More...

virtual const std::string &	get_serial_tag () const =0
	Return the serialization string identifier of the class. More...

Public Member Functions inherited from datatools::i_tree_dumpable
	i_tree_dumpable ()
	Constructor. More...

virtual	~i_tree_dumpable ()
	Destructor. More...

void	print_tree_json (std::ostream &out_=std::clog, const std::string &json_options_="") const
	Printing with jsonized options. More...

void	print_tree_json (std::ostream &out_=std::clog, const char *json_options_=nullptr) const
	Printing with jsonized options. More...

void	tree_dump_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="", const bool inherit_=false) const

void	tree_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="") const

void	smart_print_id (const int out_type_=OSTREAM_CLOG, const std::string &title_="", const std::string &indent_="") const

Protected Member Functions
virtual void	_add_shell_commands ()
	Add base shell commands. More...

virtual void	_remove_shell_commands ()
	Remove base shell commands. More...

Protected Member Functions inherited from datatools::ui::target_command_interface< basic_shell >
basic_shell &	_grab_target ()
	Return the target. More...

void	_set_target (basic_shell &target_)
	Set the target. More...

Protected Member Functions inherited from datatools::ui::base_command_interface
void	_base_setup (const std::string &name_, const std::string &description_, const version_id &vid_)
	Basic setup. More...

void	_set_version (const datatools::version_id &)
	Set the version. More...

void	_base_initialize (const datatools::properties &config_)
	Base initialization. More...

void	_base_reset ()
	Base reset. More...

virtual bool	_is_valid () const
	Check the validity (this can be overloaded) More...

virtual bool	_is_disabled () const
	Check the active status (default: true, this can be overloaded) More...

Additional Inherited Members
Public Types inherited from datatools::enriched_base
enum	export_config_flags { EXPORT_CONFIG_CLEAR = bit_mask::bit00, EXPORT_CONFIG_NAME = bit_mask::bit01, EXPORT_CONFIG_DISPLAY_NAME = bit_mask::bit02, EXPORT_CONFIG_TERSE_DESCRIPTION = bit_mask::bit03, EXPORT_CONFIG_LOGGING_PRIORITY = bit_mask::bit04, EXPORT_CONFIG_AUXILIARIES = bit_mask::bit05, EXPORT_CONFIG_DEFAULT, EXPORT_CONFIG_LAST = EXPORT_CONFIG_AUXILIARIES }
	Flags for export to a container of properties. More...

Public Types inherited from datatools::i_tree_dumpable
enum	ostream_type { OSTREAM_COUT = 1, OSTREAM_CERR = 2, OSTREAM_CLOG = 3 }
	Enumeration for standard output streams. More...

Static Public Member Functions inherited from datatools::enriched_base
static bool	validate_name (const std::string &candidate_name_)
	Validate a name. More...

static logger::priority	default_logging_priority ()
	Return the default logging priority threshold. More...

static void	init_ocd (datatools::object_configuration_description &)
	OCD support. More...

Static Public Member Functions inherited from datatools::i_tree_dumpable
static const boost::property_tree::ptree &	empty_options ()

static boost::property_tree::ptree	make_base_print_options (const std::string &title_, const std::string &indent_="", const bool inherit_=false)

static std::ostream &	last_skip_tag (std::ostream &out_)

static std::ostream &	skip_tag (std::ostream &out_)

static std::ostream &	last_tag (std::ostream &out_)

static std::ostream &	tag (std::ostream &out_)

Detailed Description

Base command interface for a shell.

Constructor & Destructor Documentation

◆ shell_command_interface() [1/3]

datatools::ui::shell_command_interface::shell_command_interface ( )

Default constructor.

◆ shell_command_interface() [2/3]

datatools::ui::shell_command_interface::shell_command_interface	(	const std::string &	name_,
		const std::string &	description_ = `""`,
		const datatools::version_id &	vid_ = `datatools::version_id::invalid()`
	)

Default constructor.

◆ shell_command_interface() [3/3]

datatools::ui::shell_command_interface::shell_command_interface	(	basic_shell &	sh_,
		const std::string &	name_,
		const std::string &	description_ = `""`,
		const datatools::version_id &	vid_ = `datatools::version_id::invalid()`
	)

Constructor.

◆ ~shell_command_interface()

virtual datatools::ui::shell_command_interface::~shell_command_interface ( )

virtual

Destructor.

Member Function Documentation

◆ _add_shell_commands()

virtual void datatools::ui::shell_command_interface::_add_shell_commands ( )

protectedvirtual

Add base shell commands.

◆ _remove_shell_commands()

virtual void datatools::ui::shell_command_interface::_remove_shell_commands ( )

protectedvirtual

Remove base shell commands.

◆ get_shell()

const basic_shell& datatools::ui::shell_command_interface::get_shell ( ) const

Return a non mutable reference to the shell.

◆ grab_shell()

basic_shell& datatools::ui::shell_command_interface::grab_shell ( )

Return a mutable reference to the shell.

◆ has_shell()

bool datatools::ui::shell_command_interface::has_shell ( ) const

Check if the shell is set.

◆ initialize()

virtual void datatools::ui::shell_command_interface::initialize	(	const datatools::properties &	config_,
		const datatools::service_manager &	services_
	)

virtual

Initialization.

Implements datatools::ui::base_command_interface.

◆ is_inhibit_cd()

bool datatools::ui::shell_command_interface::is_inhibit_cd ( ) const

Check if the cd command is inhibited.

◆ is_inhibit_load()

bool datatools::ui::shell_command_interface::is_inhibit_load ( ) const

Check if the load command is inhibited.

◆ is_initialized()

virtual bool datatools::ui::shell_command_interface::is_initialized ( ) const

virtual

Check initialization status.

Implements datatools::ui::base_command_interface.

◆ reset()

virtual void datatools::ui::shell_command_interface::reset ( )

virtual

Reset.

Implements datatools::ui::base_command_interface.

◆ set_inhibit_cd()

void datatools::ui::shell_command_interface::set_inhibit_cd ( bool )

Set the cd command inhibition flag.

◆ set_inhibit_load()

void datatools::ui::shell_command_interface::set_inhibit_load ( bool )

Set the load command inhibition flag.

The documentation for this class was generated from the following file:

bayeux/datatools/ui/shell_command_interface.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ shell_command_interface() [1/3]

◆ shell_command_interface() [2/3]

◆ shell_command_interface() [3/3]

◆ ~shell_command_interface()

Member Function Documentation

◆ _add_shell_commands()

◆ _remove_shell_commands()

◆ get_shell()

◆ grab_shell()

◆ has_shell()

◆ initialize()

◆ is_inhibit_cd()

◆ is_inhibit_load()

◆ is_initialized()

◆ reset()

◆ set_inhibit_cd()

◆ set_inhibit_load()