KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Variables
CLI::EXIT_CODES Namespace Reference

Variables

static const int AVOID_CLOSING = -1
 
static const int SUCCESS = 0
 
static const int OK = 0
 
static const int ERR_ARGS = 1
 
static const int ERR_UNKNOWN = 2
 
static const int ERR_INVALID_INPUT_FILE = 3
 
static const int ERR_INVALID_OUTPUT_CONFLICT = 4
 
static const int ERR_RC_VIOLATIONS = 5
 Rules check violation count was greater than 0.
 
static const int ERR_JOBS_RUN_FAILED = 6
 
static const int ERR_UNKNOWN_FILE_FORMAT = 7
 No plugin for the requested face recognized the input file format.
 

Variable Documentation

◆ AVOID_CLOSING

const int CLI::EXIT_CODES::AVOID_CLOSING = -1
static

Definition at line 28 of file exit_codes.h.

◆ ERR_ARGS

const int CLI::EXIT_CODES::ERR_ARGS = 1
static

Definition at line 31 of file exit_codes.h.

Referenced by CLI::DIFF_COMMAND< JOB_FP_DIFF >::addDefineArg(), CLI::API_SERVER_COMMAND::doPerform(), CLI::DIFF_COMMAND< JOB_T >::doPerform(), CLI::GERBER_CONVERT_PNG_COMMAND::doPerform(), CLI::GERBER_DIFF_COMMAND::doPerform(), CLI::GERBER_INFO_COMMAND::doPerform(), CLI::GIT_MERGEDRIVER_COMMAND::doPerform(), CLI::IMPORT_COMMAND::doPerform(), CLI::MERGETOOL_COMMAND::doPerform(), CLI::PCB_DRC_COMMAND::doPerform(), CLI::PCB_EXPORT_3D_COMMAND::doPerform(), CLI::PCB_EXPORT_DRILL_COMMAND::doPerform(), CLI::PCB_EXPORT_DXF_COMMAND::doPerform(), CLI::PCB_EXPORT_HPGL_COMMAND::doPerform(), CLI::PCB_EXPORT_PDF_COMMAND::doPerform(), CLI::PCB_EXPORT_PNG_COMMAND::doPerform(), CLI::PCB_EXPORT_POS_COMMAND::doPerform(), CLI::PCB_EXPORT_STATS_COMMAND::doPerform(), CLI::PCB_IMPORT_COMMAND::doPerform(), CLI::PCB_RENDER_COMMAND::doPerform(), CLI::SCH_ERC_COMMAND::doPerform(), CLI::SCH_EXPORT_NETLIST_COMMAND::doPerform(), CLI::SCH_EXPORT_PLOT_COMMAND::doPerform(), CLI::SCH_IMPORT_COMMAND::doPerform(), CLI::VERSION_COMMAND::doPerform(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPng(), PCBNEW_JOBS_HANDLER::JobExportPs(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::PCBNEW_JOBS_HANDLER(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), MERGETOOL_FRAME::RunMerge(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), JOBS_RUNNER::runSpecialCopyFiles(), and EESCHEMA_JOBS_HANDLER::runSymLibMerge().

◆ ERR_INVALID_INPUT_FILE

const int CLI::EXIT_CODES::ERR_INVALID_INPUT_FILE = 3
static

Definition at line 33 of file exit_codes.h.

Referenced by CLI::FP_EXPORT_SVG_COMMAND::doPerform(), CLI::GIT_MERGEDRIVER_COMMAND::doPerform(), CLI::IMPORT_COMMAND::doPerform(), CLI::JOBSET_RUN_COMMAND::doPerform(), CLI::MERGETOOL_COMMAND::doPerform(), CLI::PCB_EXPORT_DXF_COMMAND::doPerform(), CLI::PCB_EXPORT_GENCAD_COMMAND::doPerform(), CLI::PCB_EXPORT_IPC2581_COMMAND::doPerform(), CLI::PCB_EXPORT_IPCD356_COMMAND::doPerform(), CLI::PCB_EXPORT_ODB_COMMAND::doPerform(), CLI::PCB_EXPORT_PDF_COMMAND::doPerform(), CLI::PCB_EXPORT_PNG_COMMAND::doPerform(), CLI::PCB_EXPORT_POS_COMMAND::doPerform(), CLI::PCB_EXPORT_PS_COMMAND::doPerform(), CLI::PCB_EXPORT_STATS_COMMAND::doPerform(), CLI::PCB_EXPORT_SVG_COMMAND::doPerform(), CLI::PCB_IMPORT_COMMAND::doPerform(), CLI::PCB_UPGRADE_COMMAND::doPerform(), CLI::SCH_EXPORT_BOM_COMMAND::doPerform(), CLI::SCH_EXPORT_NETLIST_COMMAND::doPerform(), CLI::SCH_EXPORT_PLOT_COMMAND::doPerform(), CLI::SCH_EXPORT_PYTHONBOM_COMMAND::doPerform(), CLI::SCH_IMPORT_COMMAND::doPerform(), CLI::SCH_UPGRADE_COMMAND::doPerform(), CLI::SYM_EXPORT_SVG_COMMAND::doPerform(), CLI::SYM_UPGRADE_COMMAND::doPerform(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), PCBNEW_JOBS_HANDLER::JobDiff(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPng(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), GERBVIEW_JOBS_HANDLER::JobGerberExportPng(), GERBVIEW_JOBS_HANDLER::JobGerberInfo(), EESCHEMA_JOBS_HANDLER::JobImport(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchDiff(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobUpgrade(), loadFootprintLibrarySide(), loadSymbolLibrarySide(), EESCHEMA_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::OpenDiffDialog(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), and translateExitCode().

◆ ERR_INVALID_OUTPUT_CONFLICT

const int CLI::EXIT_CODES::ERR_INVALID_OUTPUT_CONFLICT = 4
static

Definition at line 34 of file exit_codes.h.

Referenced by CLI::GIT_MERGEDRIVER_COMMAND::doPerform(), CLI::IMPORT_COMMAND::doPerform(), KICAD_DIFF::EmitDiffResult(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPng(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), JOBS_RUNNER::runSpecialExecute(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), and translateExitCode().

◆ ERR_JOBS_RUN_FAILED

const int CLI::EXIT_CODES::ERR_JOBS_RUN_FAILED = 6
static

Definition at line 38 of file exit_codes.h.

Referenced by CLI::JOBSET_RUN_COMMAND::doPerform().

◆ ERR_RC_VIOLATIONS

const int CLI::EXIT_CODES::ERR_RC_VIOLATIONS = 5
static

Rules check violation count was greater than 0.

Definition at line 37 of file exit_codes.h.

Referenced by KICAD_DIFF::DiffExitCode(), CLI::GIT_MERGEDRIVER_COMMAND::doPerform(), PCBNEW_JOBS_HANDLER::JobExportDrc(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), EESCHEMA_JOBS_HANDLER::JobSchErc(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), JOBS_RUNNER::RunJobsForDestination(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), and translateExitCode().

◆ ERR_UNKNOWN

const int CLI::EXIT_CODES::ERR_UNKNOWN = 2
static

Definition at line 32 of file exit_codes.h.

Referenced by KICAD_DIFF::DispatchMerge(), KICAD_DIFF::DispatchOpenDiffDialog(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), CLI::API_SERVER_COMMAND::doPerform(), CLI::IMPORT_COMMAND::doPerform(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), PCBNEW_JOBS_HANDLER::JobDiff(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPng(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), PCBNEW_JOBS_HANDLER::JobFpDiff(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), GERBVIEW_JOBS_HANDLER::JobGerberExportPng(), GERBVIEW_JOBS_HANDLER::JobGerberInfo(), EESCHEMA_JOBS_HANDLER::JobImport(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchDiff(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymDiff(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), EESCHEMA_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::JobUpgrade(), JOB_DISPATCHER::RunJob(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), and JOBS_RUNNER::runSpecialCopyFiles().

◆ ERR_UNKNOWN_FILE_FORMAT

const int CLI::EXIT_CODES::ERR_UNKNOWN_FILE_FORMAT = 7
static

No plugin for the requested face recognized the input file format.

Used quietly by the import jobs so the top-level import command can probe the other face before failing.

Definition at line 42 of file exit_codes.h.

Referenced by CLI::IMPORT_COMMAND::doPerform(), CLI::PCB_IMPORT_COMMAND::doPerform(), CLI::SCH_IMPORT_COMMAND::doPerform(), EESCHEMA_JOBS_HANDLER::JobImport(), and PCBNEW_JOBS_HANDLER::JobImport().

◆ OK

const int CLI::EXIT_CODES::OK = 0
static

Definition at line 30 of file exit_codes.h.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), CLI::API_SERVER_COMMAND::doPerform(), CLI::COMMAND::doPerform(), CLI::PCB_EXPORT_GERBERS_COMMAND::doPerform(), CLI::VERSION_COMMAND::doPerform(), EESCHEMA_JOBS_HANDLER::doSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportDrill(), PCBNEW_JOBS_HANDLER::JobExportDxf(), PCBNEW_JOBS_HANDLER::JobExportFpSvg(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), PCBNEW_JOBS_HANDLER::JobExportGencad(), PCBNEW_JOBS_HANDLER::JobExportGerber(), PCBNEW_JOBS_HANDLER::JobExportGerbers(), EESCHEMA_JOBS_HANDLER::JobExportNetlist(), PCBNEW_JOBS_HANDLER::JobExportPdf(), EESCHEMA_JOBS_HANDLER::JobExportPlot(), PCBNEW_JOBS_HANDLER::JobExportPng(), PCBNEW_JOBS_HANDLER::JobExportPos(), PCBNEW_JOBS_HANDLER::JobExportPs(), EESCHEMA_JOBS_HANDLER::JobExportPythonBom(), PCBNEW_JOBS_HANDLER::JobExportRender(), PCBNEW_JOBS_HANDLER::JobExportStats(), PCBNEW_JOBS_HANDLER::JobExportStep(), PCBNEW_JOBS_HANDLER::JobExportSvg(), GERBVIEW_JOBS_HANDLER::JobGerberDiff(), GERBVIEW_JOBS_HANDLER::JobGerberExportPng(), GERBVIEW_JOBS_HANDLER::JobGerberInfo(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), CLI::PCB_EXPORT_GERBER_COMMAND::populateJob(), JOBS_RUNNER::runSpecialCopyFiles(), and JOBS_RUNNER::runSpecialExecute().

◆ SUCCESS

const int CLI::EXIT_CODES::SUCCESS = 0
static

Definition at line 29 of file exit_codes.h.

Referenced by KICAD_DIFF::DiffExitCode(), CLI::GIT_MERGEDRIVER_COMMAND::doPerform(), CLI::IMPORT_COMMAND::doPerform(), CLI::JOBSET_RUN_COMMAND::doPerform(), PCBNEW_JOBS_HANDLER::JobExportDrc(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), PCBNEW_JOBS_HANDLER::JobExportIpcD356(), PCBNEW_JOBS_HANDLER::JobExportOdb(), PCBNEW_JOBS_HANDLER::JobFpDiff(), EESCHEMA_JOBS_HANDLER::JobImport(), PCBNEW_JOBS_HANDLER::JobImport(), EESCHEMA_JOBS_HANDLER::JobSchErc(), EESCHEMA_JOBS_HANDLER::JobSymDiff(), EESCHEMA_JOBS_HANDLER::JobUpgrade(), PCBNEW_JOBS_HANDLER::JobUpgrade(), loadFootprintLibrarySide(), loadSymbolLibrarySide(), EESCHEMA_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::OpenDiffDialog(), PCBNEW_JOBS_HANDLER::runFpLibMerge(), JOBS_RUNNER::RunJobsForDestination(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), EESCHEMA_JOBS_HANDLER::runSymLibMerge(), and translateExitCode().