CLI::VERSION_COMMAND Class Reference

#include <command_version.h>

Inheritance diagram for CLI::VERSION_COMMAND:

Public Member Functions
	VERSION_COMMAND ()
int	Perform (KIWAY &aKiway)
	Entry point to processing commands from args and doing work. More...
argparse::ArgumentParser &	GetArgParser ()
const std::string &	GetName () const
void	PrintHelp ()

Protected Member Functions
int	doPerform (KIWAY &aKiway) override
	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 28 of file command_version.h.

Constructor & Destructor Documentation

VERSION_COMMAND()

CLI::VERSION_COMMAND::VERSION_COMMAND

(

)

Definition at line 31 of file command_version.cpp.

 : COMMAND( "version" )
{
 m_argParser.add_argument( ARG_FORMAT )
 .default_value( std::string( "plain" ) )
 .help( UTF8STDSTR( _( "version info format (plain, commit, about)" ) ) );
}

References _, ARG_FORMAT, CLI::COMMAND::m_argParser, and UTF8STDSTR.

Member Function Documentation

doPerform()

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

overrideprotectedvirtual

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 from CLI::COMMAND.

Definition at line 39 of file command_version.cpp.

{
 if( !m_argParser )
 {
 // were we redirected from the --version?
 // m_argParser override for bool() returns false if we didnt parse any args normally
 // we need to exit here early because it'll exception in the later arg handling code if we dont
 // no arg provided also ends up here on the version command
 wxPrintf( "%s\n", GetMajorMinorPatchVersion() );
 return EXIT_CODES::OK;
 }
 
 wxString format = FROM_UTF8( m_argParser.get<std::string>( ARG_FORMAT ).c_str() );
 if( format == wxS( "plain" ) )
 {
 wxPrintf( "%s\n", GetMajorMinorPatchVersion() );
 }
 else if( format == wxS( "commit" ) )
 {
 wxPrintf( "%s\n", GetCommitHash() );
 }
 else if( format == wxS( "about" ) )
 {
 wxString msg_version = GetVersionInfoData( wxS( "kicad-cli" ) );
 wxPrintf( "%s\n", msg_version );
 }
 else
 {
 wxFprintf( stderr, _( "Invalid format\n" ) );
 return EXIT_CODES::ERR_ARGS;
 }
 
 return EXIT_CODES::OK;
}

References _, ARG_FORMAT, CLI::EXIT_CODES::ERR_ARGS, FROM_UTF8(), GetCommitHash(), GetMajorMinorPatchVersion(), GetVersionInfoData(), and CLI::EXIT_CODES::OK.

GetArgParser()

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

inlineinherited

Definition at line 54 of file command.h.

{ return m_argParser; }

References CLI::COMMAND::m_argParser.

Referenced by recurseArgParserBuild(), and recurseArgParserSubCommandUsed().

GetName()

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

inlineinherited

Definition at line 55 of file command.h.

{ return m_name; }

References CLI::COMMAND::m_name.

Referenced by recurseArgParserSubCommandUsed().

Perform()

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

inherited

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 ( )

inherited

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

protectedinherited

Definition at line 68 of file command.h.

Referenced by CLI::COMMAND::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(), CLI::COMMAND::GetArgParser(), CLI::SYM_EXPORT_SVG_COMMAND::SYM_EXPORT_SVG_COMMAND(), CLI::SYM_UPGRADE_COMMAND::SYM_UPGRADE_COMMAND(), and VERSION_COMMAND().

m_name

std::string CLI::COMMAND::m_name

protectedinherited

Definition at line 67 of file command.h.

Referenced by CLI::COMMAND::GetName().

---

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

• command_version.h
• command_version.cpp