CLI::COMMAND Class Reference

#include <command.h>

Inheritance diagram for CLI::COMMAND:

Public Member Functions
	COMMAND (const std::string &aName)
	Define a new COMMAND instance. More...
int	Perform (KIWAY &aKiway)
	Entry point to processing commands from args and doing work. More...
virtual	~COMMAND ()=default
argparse::ArgumentParser &	GetArgParser ()
const std::string &	GetName () const
void	PrintHelp ()

Protected Member Functions
virtual int	doPerform (KIWAY &aKiway)
	The internal handler that should be overloaded to implement command specific processing and work. More...

Protected Attributes
std::string	m_name
argparse::ArgumentParser	m_argParser

Detailed Description

Definition at line 37 of file command.h.

Constructor & Destructor Documentation

COMMAND()

CLI::COMMAND::COMMAND

(

const std::string &

aName

)

Define a new COMMAND instance.

Parameters

aName

The name of the command that is to be used in the cli interface

Definition at line 29 of file command.cpp.

 :
 m_name( aName ),
 m_argParser( aName, "", argparse::default_arguments::none )
{
 m_argParser.add_argument( ARG_HELP_SHORT, ARG_HELP )
 .default_value( false )
 .help( UTF8STDSTR( ARG_HELP_DESC ) )
 .implicit_value( true )
 .nargs( 0 );
}

References ARG_HELP, ARG_HELP_DESC, ARG_HELP_SHORT, m_argParser, and UTF8STDSTR.

~COMMAND()

virtual CLI::COMMAND::~COMMAND ( )

virtualdefault

Member Function Documentation

doPerform()

int CLI::COMMAND::doPerform ( KIWAY &  aKiway )

protectedvirtual

The internal handler that should be overloaded to implement command specific processing and work.

If not overloaded, the command will simply emit the help options by default

Reimplemented in CLI::EXPORT_PCB_BASE_COMMAND, CLI::EXPORT_PCB_DRILL_COMMAND, CLI::EXPORT_PCB_DXF_COMMAND, CLI::EXPORT_PCB_GERBER_COMMAND, CLI::EXPORT_PCB_GERBERS_COMMAND, CLI::EXPORT_PCB_PDF_COMMAND, CLI::EXPORT_PCB_POS_COMMAND, CLI::EXPORT_PCB_STEP_COMMAND, CLI::EXPORT_PCB_SVG_COMMAND, CLI::EXPORT_SCH_NETLIST_COMMAND, CLI::EXPORT_SCH_PDF_COMMAND, CLI::EXPORT_SCH_PYTHONBOM_COMMAND, CLI::EXPORT_SCH_SVG_COMMAND, CLI::FP_EXPORT_SVG_COMMAND, CLI::FP_UPGRADE_COMMAND, CLI::SYM_EXPORT_SVG_COMMAND, CLI::SYM_UPGRADE_COMMAND, and CLI::VERSION_COMMAND.

Definition at line 62 of file command.cpp.

{
 // default case if we aren't overloaded, just print the help
 PrintHelp();
 
 return EXIT_CODES::OK;
}

References CLI::EXIT_CODES::OK.

GetArgParser()

argparse::ArgumentParser & CLI::COMMAND::GetArgParser ( )

inline

Definition at line 54 of file command.h.

{ return m_argParser; }

References m_argParser.

Referenced by recurseArgParserBuild(), and recurseArgParserSubCommandUsed().

GetName()

const std::string & CLI::COMMAND::GetName ( void  ) const

inline

Definition at line 55 of file command.h.

{ return m_name; }

References m_name.

Referenced by recurseArgParserSubCommandUsed().

Perform()

int CLI::COMMAND::Perform

(

KIWAY &

aKiway

)

Entry point to processing commands from args and doing work.

Definition at line 49 of file command.cpp.

{
 if( m_argParser[ARG_HELP] == true )
 {
 PrintHelp();
 
 return 0;
 }
 
 return doPerform( aKiway );
}

References ARG_HELP.

PrintHelp()

void CLI::COMMAND::PrintHelp

(

)

Definition at line 41 of file command.cpp.

{
 std::stringstream ss;
 ss << m_argParser;
 wxPrintf( FROM_UTF8( ss.str().c_str() ) );
}

References FROM_UTF8().

Member Data Documentation

m_argParser

argparse::ArgumentParser CLI::COMMAND::m_argParser

protected

Definition at line 68 of file command.h.

Referenced by COMMAND(), CLI::EXPORT_PCB_BASE_COMMAND::EXPORT_PCB_BASE_COMMAND(), CLI::EXPORT_PCB_DRILL_COMMAND::EXPORT_PCB_DRILL_COMMAND(), CLI::EXPORT_PCB_DXF_COMMAND::EXPORT_PCB_DXF_COMMAND(), CLI::EXPORT_PCB_GERBER_COMMAND::EXPORT_PCB_GERBER_COMMAND(), CLI::EXPORT_PCB_GERBERS_COMMAND::EXPORT_PCB_GERBERS_COMMAND(), CLI::EXPORT_PCB_PDF_COMMAND::EXPORT_PCB_PDF_COMMAND(), CLI::EXPORT_PCB_POS_COMMAND::EXPORT_PCB_POS_COMMAND(), CLI::EXPORT_PCB_STEP_COMMAND::EXPORT_PCB_STEP_COMMAND(), CLI::EXPORT_PCB_SVG_COMMAND::EXPORT_PCB_SVG_COMMAND(), CLI::EXPORT_SCH_NETLIST_COMMAND::EXPORT_SCH_NETLIST_COMMAND(), CLI::EXPORT_SCH_PDF_COMMAND::EXPORT_SCH_PDF_COMMAND(), CLI::EXPORT_SCH_SVG_COMMAND::EXPORT_SCH_SVG_COMMAND(), CLI::FP_EXPORT_SVG_COMMAND::FP_EXPORT_SVG_COMMAND(), CLI::FP_UPGRADE_COMMAND::FP_UPGRADE_COMMAND(), GetArgParser(), CLI::SYM_EXPORT_SVG_COMMAND::SYM_EXPORT_SVG_COMMAND(), CLI::SYM_UPGRADE_COMMAND::SYM_UPGRADE_COMMAND(), and CLI::VERSION_COMMAND::VERSION_COMMAND().

m_name

std::string CLI::COMMAND::m_name

protected

Definition at line 67 of file command.h.

Referenced by GetName().

---

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

• command.h
• command.cpp