KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CLI::FP_COMMAND Struct Reference

#include <command_fp.h>

Inheritance diagram for CLI::FP_COMMAND:
CLI::COMMAND

Public Member Functions

 FP_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

void addCommonArgs (bool aInput, bool aOutput, bool aInputIsDir, bool aOutputIsDir)
 Sets up the most common of args used across cli. More...
 
void addDrawingSheetArg ()
 Sets up the drawing sheet arg used by many of the export commands. More...
 
void addDefineArg ()
 Sets up the drawing sheet arg used by many of the export commands. More...
 
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
 Name of this command that is exported and used in the cli. More...
 
argparse::ArgumentParser m_argParser
 
bool m_hasInputArg
 Whether or not the input arg was added for parsing. More...
 
bool m_hasOutputArg
 Whether or not the output arg was added for parsing. More...
 
bool m_hasDrawingSheetArg
 Whether or not the input arg was added for parsing. More...
 
bool m_hasDefineArg
 Whether or not the input arg was added for parsing. More...
 
bool m_outputArgExpectsDir
 Whether or not the output arg is expecting a directory. More...
 
wxString m_argInput
 Value of the common input arg if configured. More...
 
wxString m_argOutput
 Value of the output arg if configured. More...
 
wxString m_argDrawingSheet
 Value of the drawing sheet arg if configured. More...
 
std::map< wxString, wxString > m_argDefineVars
 Value of the drawing sheet arg if configured. More...
 

Detailed Description

Definition at line 28 of file command_fp.h.

Constructor & Destructor Documentation

◆ FP_COMMAND()

CLI::FP_COMMAND::FP_COMMAND ( )
inline

Definition at line 30 of file command_fp.h.

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

Member Function Documentation

◆ addCommonArgs()

void CLI::COMMAND::addCommonArgs ( bool  aInput,
bool  aOutput,
bool  aInputIsDir,
bool  aOutputIsDir 
)
protectedinherited

Sets up the most common of args used across cli.

Parameters
aInputConfigures the input arg
aOutputConfigures the output arg
aInputIsDirConfigures whether the input arg description will be for a file or directory
aOutputIsDirConfigures whether the output arg description will be for a file or directory

Definition at line 115 of file command.cpp.

References _, ARG_INPUT, ARG_OUTPUT, and UTF8STDSTR.

Referenced by CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND(), CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND(), CLI::PCB_EXPORT_BASE_COMMAND::PCB_EXPORT_BASE_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND(), CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND(), CLI::SCH_EXPORT_NETLIST_COMMAND::SCH_EXPORT_NETLIST_COMMAND(), CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND(), CLI::SCH_EXPORT_PYTHONBOM_COMMAND::SCH_EXPORT_PYTHONBOM_COMMAND(), CLI::SYM_EXPORT_SVG_COMMAND::SYM_EXPORT_SVG_COMMAND(), and CLI::SYM_UPGRADE_COMMAND::SYM_UPGRADE_COMMAND().

◆ addDefineArg()

void CLI::COMMAND::addDefineArg ( )
protectedinherited

Sets up the drawing sheet arg used by many of the export commands.

Definition at line 168 of file command.cpp.

References _, ARG_DEFINE_VAR_LONG, ARG_DEFINE_VAR_SHORT, and UTF8STDSTR.

Referenced by CLI::FP_EXPORT_SVG_COMMAND::FP_EXPORT_SVG_COMMAND(), CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND(), CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND(), CLI::PCB_EXPORT_DXF_COMMAND::PCB_EXPORT_DXF_COMMAND(), CLI::PCB_EXPORT_GERBER_COMMAND::PCB_EXPORT_GERBER_COMMAND(), CLI::PCB_EXPORT_GERBERS_COMMAND::PCB_EXPORT_GERBERS_COMMAND(), CLI::PCB_EXPORT_PDF_COMMAND::PCB_EXPORT_PDF_COMMAND(), CLI::PCB_EXPORT_SVG_COMMAND::PCB_EXPORT_SVG_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND(), and CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND().

◆ addDrawingSheetArg()

void CLI::COMMAND::addDrawingSheetArg ( )
protectedinherited

Sets up the drawing sheet arg used by many of the export commands.

Definition at line 157 of file command.cpp.

References _, ARG_DRAWING_SHEET, and UTF8STDSTR.

Referenced by CLI::PCB_EXPORT_DXF_COMMAND::PCB_EXPORT_DXF_COMMAND(), CLI::PCB_EXPORT_GERBER_COMMAND::PCB_EXPORT_GERBER_COMMAND(), CLI::PCB_EXPORT_GERBERS_COMMAND::PCB_EXPORT_GERBERS_COMMAND(), CLI::PCB_EXPORT_PDF_COMMAND::PCB_EXPORT_PDF_COMMAND(), CLI::PCB_EXPORT_SVG_COMMAND::PCB_EXPORT_SVG_COMMAND(), and CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND().

◆ doPerform()

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

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::FP_EXPORT_SVG_COMMAND, CLI::FP_UPGRADE_COMMAND, CLI::PCB_DRC_COMMAND, CLI::PCB_EXPORT_3D_COMMAND, CLI::PCB_EXPORT_BASE_COMMAND, CLI::PCB_EXPORT_DRILL_COMMAND, CLI::PCB_EXPORT_DXF_COMMAND, CLI::PCB_EXPORT_GERBER_COMMAND, CLI::PCB_EXPORT_GERBERS_COMMAND, CLI::PCB_EXPORT_PDF_COMMAND, CLI::PCB_EXPORT_POS_COMMAND, CLI::PCB_EXPORT_SVG_COMMAND, CLI::SCH_ERC_COMMAND, CLI::SCH_EXPORT_BOM_COMMAND, CLI::SCH_EXPORT_NETLIST_COMMAND, CLI::SCH_EXPORT_PLOT_COMMAND, CLI::SCH_EXPORT_PYTHONBOM_COMMAND, CLI::SYM_EXPORT_SVG_COMMAND, CLI::SYM_UPGRADE_COMMAND, and CLI::VERSION_COMMAND.

Definition at line 106 of file command.cpp.

References CLI::EXIT_CODES::OK.

◆ GetArgParser()

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

Definition at line 59 of file command.h.

References CLI::COMMAND::m_argParser.

Referenced by recurseArgParserBuild(), and recurseArgParserSubCommandUsed().

◆ GetName()

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

Definition at line 60 of file command.h.

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 56 of file command.cpp.

References ARG_DEFINE_VAR_LONG, ARG_DRAWING_SHEET, ARG_HELP, ARG_INPUT, ARG_OUTPUT, CLI::EXIT_CODES::ERR_ARGS, From_UTF8(), and wxStringSplit().

◆ PrintHelp()

void CLI::COMMAND::PrintHelp ( )
inherited

Definition at line 48 of file command.cpp.

References From_UTF8().

Member Data Documentation

◆ m_argDefineVars

std::map<wxString, wxString> CLI::COMMAND::m_argDefineVars
protectedinherited

Value of the drawing sheet arg if configured.

Definition at line 143 of file command.h.

◆ m_argDrawingSheet

wxString CLI::COMMAND::m_argDrawingSheet
protectedinherited

Value of the drawing sheet arg if configured.

Definition at line 138 of file command.h.

◆ m_argInput

wxString CLI::COMMAND::m_argInput
protectedinherited

Value of the common input arg if configured.

Definition at line 128 of file command.h.

◆ m_argOutput

wxString CLI::COMMAND::m_argOutput
protectedinherited

Value of the output arg if configured.

Definition at line 133 of file command.h.

◆ m_argParser

argparse::ArgumentParser CLI::COMMAND::m_argParser
protectedinherited

Definition at line 98 of file command.h.

Referenced by CLI::COMMAND::COMMAND(), FP_COMMAND(), CLI::FP_EXPORT_COMMAND::FP_EXPORT_COMMAND(), CLI::FP_EXPORT_SVG_COMMAND::FP_EXPORT_SVG_COMMAND(), CLI::FP_UPGRADE_COMMAND::FP_UPGRADE_COMMAND(), CLI::COMMAND::GetArgParser(), CLI::PCB_COMMAND::PCB_COMMAND(), CLI::PCB_DRC_COMMAND::PCB_DRC_COMMAND(), CLI::PCB_EXPORT_3D_COMMAND::PCB_EXPORT_3D_COMMAND(), CLI::PCB_EXPORT_COMMAND::PCB_EXPORT_COMMAND(), CLI::PCB_EXPORT_DRILL_COMMAND::PCB_EXPORT_DRILL_COMMAND(), CLI::PCB_EXPORT_DXF_COMMAND::PCB_EXPORT_DXF_COMMAND(), CLI::PCB_EXPORT_GERBER_COMMAND::PCB_EXPORT_GERBER_COMMAND(), CLI::PCB_EXPORT_GERBERS_COMMAND::PCB_EXPORT_GERBERS_COMMAND(), CLI::PCB_EXPORT_PDF_COMMAND::PCB_EXPORT_PDF_COMMAND(), CLI::PCB_EXPORT_POS_COMMAND::PCB_EXPORT_POS_COMMAND(), CLI::PCB_EXPORT_SVG_COMMAND::PCB_EXPORT_SVG_COMMAND(), CLI::SCH_COMMAND::SCH_COMMAND(), CLI::SCH_ERC_COMMAND::SCH_ERC_COMMAND(), CLI::SCH_EXPORT_BOM_COMMAND::SCH_EXPORT_BOM_COMMAND(), CLI::SCH_EXPORT_COMMAND::SCH_EXPORT_COMMAND(), CLI::SCH_EXPORT_NETLIST_COMMAND::SCH_EXPORT_NETLIST_COMMAND(), CLI::SCH_EXPORT_PLOT_COMMAND::SCH_EXPORT_PLOT_COMMAND(), CLI::SCH_EXPORT_PYTHONBOM_COMMAND::SCH_EXPORT_PYTHONBOM_COMMAND(), CLI::SYM_COMMAND::SYM_COMMAND(), CLI::SYM_EXPORT_COMMAND::SYM_EXPORT_COMMAND(), CLI::SYM_EXPORT_SVG_COMMAND::SYM_EXPORT_SVG_COMMAND(), CLI::SYM_UPGRADE_COMMAND::SYM_UPGRADE_COMMAND(), and CLI::VERSION_COMMAND::VERSION_COMMAND().

◆ m_hasDefineArg

bool CLI::COMMAND::m_hasDefineArg
protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 118 of file command.h.

◆ m_hasDrawingSheetArg

bool CLI::COMMAND::m_hasDrawingSheetArg
protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 113 of file command.h.

◆ m_hasInputArg

bool CLI::COMMAND::m_hasInputArg
protectedinherited

Whether or not the input arg was added for parsing.

Definition at line 103 of file command.h.

◆ m_hasOutputArg

bool CLI::COMMAND::m_hasOutputArg
protectedinherited

Whether or not the output arg was added for parsing.

Definition at line 108 of file command.h.

◆ m_name

std::string CLI::COMMAND::m_name
protectedinherited

Name of this command that is exported and used in the cli.

Definition at line 96 of file command.h.

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

◆ m_outputArgExpectsDir

bool CLI::COMMAND::m_outputArgExpectsDir
protectedinherited

Whether or not the output arg is expecting a directory.

Definition at line 123 of file command.h.

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