rnr::cmd::CmdExec Struct Reference

Helper class to hold a command line execution function. More...

#include <CommandLine.h>

Classes
union	FnVar
	Union of all variant execution functions. More...

Public Member Functions
	CmdExec ()
	Default constructor.
	CmdExec (int uid, CmdExec1Func fn)
	Variant 1 constructor. More...
	CmdExec (int uid, CmdExec2Func fn)
	Variant 2 constructor. More...
	CmdExec (int uid, CmdExec3Func fn)
	Variant 3 constructor. More...
	CmdExec (const CmdExec &src)
	Copy constructor. More...
int	execute (const str::StringVec &argv)
	Execute a comamnd with the given arguments. More...
int	execute (CommandLine &cli, const CmdExtArgVec &argv)
	Execute a comamnd with the given arguments. More...
int	getUid () const
	Get associated command's unique id. More...

Protected Types
enum	Variant {   VariantUndef,   Variant1,   Variant2,   Variant3 }
	Execution function variant enumeration. More...

Protected Attributes
int	m_uid
	command unique id associated with this execution
Variant	m_variant
	function variant enum
FnVar	m_exec
	function execution variant

Friends
std::ostream &	operator<< (std::ostream &os, const CmdExec &obj)
	Insert object into output stream. More...

Detailed Description

Helper class to hold a command line execution function.

Definition at line 164 of file CommandLine.h.

Member Enumeration Documentation

enum rnr::cmd::CmdExec::Variant

protected

Execution function variant enumeration.

Enumerator
VariantUndef	undefined variant
Variant1	variant 1
Variant2	variant 2
Variant3	variant 3

Definition at line 277 of file CommandLine.h.

      {
        VariantUndef,   ///< undefined variant
        Variant1,       ///< variant 1
        Variant2,       ///< variant 2
        Variant3        ///< variant 3
      };

Constructor & Destructor Documentation

rnr::cmd::CmdExec::CmdExec ( int  uid, CmdExec1Func  fn  )

inline

Variant 1 constructor.

Parameters

uid	Associated command's unique id.
fn	Variant 1 execution function.

Definition at line 183 of file CommandLine.h.

References rnr::cmd::CmdExec::FnVar::fn1, m_exec, m_uid, m_variant, and Variant1.

      {
        m_uid       = uid;
        m_variant   = Variant1;
        m_exec.fn1  = fn;
      }

rnr::cmd::CmdExec::CmdExec ( int  uid, CmdExec2Func  fn  )

inline

Variant 2 constructor.

Parameters

uid	Associated command's unique id.
fn	Variant 2 execution function.

Definition at line 196 of file CommandLine.h.

References rnr::cmd::CmdExec::FnVar::fn2, m_exec, m_uid, m_variant, and Variant2.

      {
        m_uid       = uid;
        m_variant   = Variant2;
        m_exec.fn2  = fn;
      }

rnr::cmd::CmdExec::CmdExec ( int  uid, CmdExec3Func  fn  )

inline

Variant 3 constructor.

Parameters

uid	Associated command's unique id.
fn	Variant 3 execution function.

Definition at line 209 of file CommandLine.h.

References rnr::cmd::CmdExec::FnVar::fn3, m_exec, m_uid, m_variant, and Variant3.

      {
        m_uid       = uid;
        m_variant   = Variant3;
        m_exec.fn3  = fn;
      }

rnr::cmd::CmdExec::CmdExec ( const CmdExec &  src )

inline

Copy constructor.

Parameters

src	Source object.

Definition at line 221 of file CommandLine.h.

References execute(), m_exec, m_uid, and m_variant.

      {
        m_uid     = src.m_uid;
        m_variant = src.m_variant;
        m_exec    = src.m_exec;
      }

Member Function Documentation

int CmdExec::execute

(

const str::StringVec &

argv

)

Execute a comamnd with the given arguments.

Parameters

argv	The list of string arguments.

Returns

Returns a Command Error Codes on failure to find the associated command or its execution function. Otherwise, returns the user-define execution function return value.

Definition at line 268 of file CommandLine.cxx.

References rnr::cmd::ENoExec.

Referenced by CmdExec(), and rnr::cmd::CommandLine::readCommand().

{
  switch( m_variant )
  {
    case Variant1:
      return m_exec.fn1 != NULL? m_exec.fn1(argv): ENoExec;
    case Variant2:
    case Variant3:
    default:
      return ENoExec;
  }
}

int CmdExec::execute	(	CommandLine &	cli,
		const CmdExtArgVec &	argv
	)

Execute a comamnd with the given arguments.

Parameters

cli	Reference to the command-line interface.
argv	The list of extended arguments.

Returns

Returns a Command Error Codes on failure to find the associated command or its execution function. Otherwise, returns the user-define execution function return value.

Definition at line 281 of file CommandLine.cxx.

References rnr::cmd::ENoExec, rnr::io::indent(), m_exec, m_uid, m_variant, operator<<(), and rnr::cmd::CmdExec::FnVar::p.

{
  switch( m_variant )
  {
    case Variant2:
      return m_exec.fn2 != NULL? m_exec.fn2(argv): ENoExec;
    case Variant3:
      return m_exec.fn3 != NULL? m_exec.fn3(cli, argv): ENoExec;
    case Variant1:
    default:
      return ENoExec;
  }
}

int rnr::cmd::CmdExec::getUid ( ) const

inline

Get associated command's unique id.

Returns

Unique id.

Definition at line 258 of file CommandLine.h.

References m_uid, and operator<<.

      {
        return m_uid;
      }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CmdExec &  obj  )

friend

Insert object into output stream.

Parameters

os	Output stream.
obj	Object to insert.

Returns

Reference to output stream.

Referenced by rnr::cmd::DataSect::deallocator(), rnr::cmd::CommandLine::end(), and getUid().

---

The documentation for this struct was generated from the following files:

• include/rnr/appkit/CommandLine.h
• sw/librnr_appkit/CommandLine.cxx