CommandLineInterface Class Reference

The CommandLineInterface class. More...

#include <commandlineinterface.h>

Collaboration diagram for CommandLineInterface:

Classes
struct	CheckResult

Public Member Functions
	CommandLineInterface () noexcept
	~CommandLineInterface () noexcept=default
int	execute (const QStringList &args) noexcept

Private Member Functions
bool	openProject (const QString &projectFile, bool runErc, bool runDrc, const QString &drcSettingsPath, const QStringList &runJobs, bool runAllJobs, const QString &customJobsPath, const QString &customOutDir, const QStringList &exportSchematicsFiles, const QStringList &exportBomFiles, const QStringList &exportBoardBomFiles, const QString &bomAttributes, bool exportPcbFabricationData, const QString &pcbFabricationSettingsPath, const QStringList &exportPnpTopFiles, const QStringList &exportPnpBottomFiles, const QStringList &exportNetlistFiles, const QStringList &boardNames, const QStringList &boardIndices, bool removeOtherBoards, const QStringList &avNames, const QStringList &avIndices, const QString &setDefaultAv, bool save, bool strict) const noexcept
bool	openLibrary (const QString &libDir, bool all, bool runCheck, bool minifyStepFiles, bool save, bool strict) const noexcept
CheckResult	gatherElementCheckMessages (const LibraryBaseElement &element) const
	Gather validation check messages for a library element.
QStringList	formatLibraryElementCheckSummary (const CheckResult &checkResult) const
QStringList	formatCheckSummary (int approvedCount, int nonApprovedCount, const QString &indent="") const
void	processLibraryElement (const QString &libDir, TransactionalFileSystem &fs, LibraryBaseElement &element, bool runCheck, bool minifyStepFiles, bool save, bool strict, bool &success) const
bool	openSymbol (const QString &symbolFile, bool runCheck, const QString &exportFile) const noexcept
bool	openPackage (const QString &packageFile, bool runCheck, const QString &exportFile) const noexcept
bool	openStep (const QString &filePath, bool minify, bool tesselate, const QString &saveTo) const noexcept

Static Private Member Functions
static QStringList	prepareRuleCheckMessages (RuleCheckMessageList messages, const QSet< SExpression > &approvals, int &approvedMsgCount) noexcept
static QString	prettyPath (const FilePath &path, const QString &style) noexcept
static bool	failIfFileFormatUnstable () noexcept
static void	print (const QString &str) noexcept
static void	printErr (const QString &str) noexcept

Detailed Description

The CommandLineInterface class.

Constructor & Destructor Documentation

CommandLineInterface()

CommandLineInterface ( )

noexcept

~CommandLineInterface()

~CommandLineInterface ( )

defaultnoexcept

Member Function Documentation

execute()

int execute ( const QStringList &  args )

noexcept

Here is the call graph for this function:

Here is the caller graph for this function:

openProject()

bool openProject ( const QString &  projectFile, bool  runErc, bool  runDrc, const QString &  drcSettingsPath, const QStringList &  runJobs, bool  runAllJobs, const QString &  customJobsPath, const QString &  customOutDir, const QStringList &  exportSchematicsFiles, const QStringList &  exportBomFiles, const QStringList &  exportBoardBomFiles, const QString &  bomAttributes, bool  exportPcbFabricationData, const QString &  pcbFabricationSettingsPath, const QStringList &  exportPnpTopFiles, const QStringList &  exportPnpBottomFiles, const QStringList &  exportNetlistFiles, const QStringList &  boardNames, const QStringList &  boardIndices, bool  removeOtherBoards, const QStringList &  avNames, const QStringList &  avIndices, const QString &  setDefaultAv, bool  save, bool  strict  ) const

privatenoexcept

Here is the call graph for this function:

openLibrary()

bool openLibrary ( const QString &  libDir, bool  all, bool  runCheck, bool  minifyStepFiles, bool  save, bool  strict  ) const

privatenoexcept

Here is the call graph for this function:

gatherElementCheckMessages()

CommandLineInterface::CheckResult gatherElementCheckMessages ( const LibraryBaseElement &  element ) const

private

Gather validation check messages for a library element.

This function runs validation checks on a library element and separates the results into approved and non-approved messages.

Parameters

element

The library element to check

Returns

CheckResult containing the count of approved messages and a list of non-approved messages

Here is the call graph for this function:

Here is the caller graph for this function:

formatLibraryElementCheckSummary()

QStringList formatLibraryElementCheckSummary ( const CheckResult &  checkResult ) const

private

Here is the call graph for this function:

formatCheckSummary()

QStringList formatCheckSummary ( int  approvedCount, int  nonApprovedCount, const QString &  indent = ""  ) const

private

Here is the caller graph for this function:

processLibraryElement()

void processLibraryElement ( const QString &  libDir, TransactionalFileSystem &  fs, LibraryBaseElement &  element, bool  runCheck, bool  minifyStepFiles, bool  save, bool  strict, bool &  success  ) const

private

Here is the call graph for this function:

openSymbol()

bool openSymbol ( const QString &  symbolFile, bool  runCheck, const QString &  exportFile  ) const

privatenoexcept

Here is the call graph for this function:

openPackage()

bool openPackage ( const QString &  packageFile, bool  runCheck, const QString &  exportFile  ) const

privatenoexcept

Here is the call graph for this function:

openStep()

bool openStep ( const QString &  filePath, bool  minify, bool  tesselate, const QString &  saveTo  ) const

privatenoexcept

Here is the call graph for this function:

prepareRuleCheckMessages()

QStringList prepareRuleCheckMessages ( RuleCheckMessageList  messages, const QSet< SExpression > &  approvals, int &  approvedMsgCount  )

staticprivatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

prettyPath()

QString prettyPath ( const FilePath &  path, const QString &  style  )

staticprivatenoexcept

Here is the caller graph for this function:

failIfFileFormatUnstable()

bool failIfFileFormatUnstable ( )

staticprivatenoexcept

Here is the call graph for this function:

Here is the caller graph for this function:

print()

void print ( const QString &  str )

staticprivatenoexcept

Here is the caller graph for this function:

printErr()

void printErr ( const QString &  str )

staticprivatenoexcept

Here is the caller graph for this function:

---

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

• /__w/1/s/apps/librepcb-cli/commandlineinterface.h
• /__w/1/s/apps/librepcb-cli/commandlineinterface.cpp