Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
CommandLineOptions Class Reference
Collaboration diagram for CommandLineOptions:

Public Member Functions

 CommandLineOptions (int argc, char *argv[])
bool isValid () const
const std::string & moduleName () const
const std::string & moduleVersion () const
int moduleVersionMajor () const
int moduleVersionMinor () const
int moduleVersionPatch () const
const std::string & sourceDir () const
const std::string & binaryDir () const
const std::string & includeDir () const
const std::string & installIncludeDir () const
const std::string & privateIncludeDir () const
const std::string & qpaIncludeDir () const
const std::string & rhiIncludeDir () const
const std::string & ssgIncludeDir () const
const std::string & spiIncludeDir () const
const std::string & stagingDir () const
const std::string & versionScriptFile () const
const std::string & moduleMapFile () const
const std::set< std::string > & knownModules () const
const std::regex & qpaHeadersRegex () const
const std::regex & rhiHeadersRegex () const
const std::regex & ssgHeadersRegex () const
const std::regex & spiHeadersRegex () const
const std::regex & privateHeadersRegex () const
const std::regex & publicNamespaceRegex () const
const std::set< std::string > & headers () const
const std::set< std::string > & generatedHeaders () const
bool scanAllMode () const
bool isInternal () const
bool isNonQtModule () const
bool printHelpOnly () const
bool debug () const
bool copy () const
bool minimal () const
bool showOnly () const
bool isFramework () const
bool warningsAreErrors () const
void printHelp () const
 CommandLineOptions (int argc, char *argv[])
bool isValid () const
const std::string & moduleName () const
const std::string & moduleVersion () const
int moduleVersionMajor () const
int moduleVersionMinor () const
int moduleVersionPatch () const
const std::string & sourceDir () const
const std::string & binaryDir () const
const std::string & includeDir () const
const std::string & installIncludeDir () const
const std::string & privateIncludeDir () const
const std::string & qpaIncludeDir () const
const std::string & rhiIncludeDir () const
const std::string & ssgIncludeDir () const
const std::string & spiIncludeDir () const
const std::string & stagingDir () const
const std::string & versionScriptFile () const
const std::string & moduleMapFile () const
const std::set< std::string > & knownModules () const
const std::regex & qpaHeadersRegex () const
const std::regex & rhiHeadersRegex () const
const std::regex & ssgHeadersRegex () const
const std::regex & spiHeadersRegex () const
const std::regex & privateHeadersRegex () const
const std::regex & publicNamespaceRegex () const
const std::set< std::string > & headers () const
const std::set< std::string > & generatedHeaders () const
bool scanAllMode () const
bool isInternal () const
bool isNonQtModule () const
bool printHelpOnly () const
bool debug () const
bool copy () const
bool minimal () const
bool showOnly () const
bool isFramework () const
bool warningsAreErrors () const
void printHelp () const

Detailed Description

Definition at line 195 of file main.cpp.

Constructor & Destructor Documentation

◆ CommandLineOptions() [1/2]

CommandLineOptions::CommandLineOptions ( int argc,
char * argv[] )
inline

Definition at line 210 of file main.cpp.

Referenced by main().

Here is the caller graph for this function:

◆ CommandLineOptions() [2/2]

CommandLineOptions::CommandLineOptions ( int argc,
char * argv[] )
inline

Definition at line 210 of file main.cpp.

Member Function Documentation

◆ binaryDir() [1/2]

const std::string & CommandLineOptions::binaryDir ( ) const
inline

Definition at line 223 of file main.cpp.

Referenced by SyncScanner::generateHeaderCheckExceptions(), SyncScanner::generateModuleMapFile(), SyncScanner::parseVersionScriptContent(), and SyncScanner::processHeader().

Here is the caller graph for this function:

◆ binaryDir() [2/2]

const std::string & CommandLineOptions::binaryDir ( ) const
inline

Definition at line 223 of file main.cpp.

◆ copy() [1/2]

bool CommandLineOptions::copy ( ) const
inline

Definition at line 273 of file main.cpp.

Referenced by SyncScanner::processHeader().

Here is the caller graph for this function:

◆ copy() [2/2]

bool CommandLineOptions::copy ( ) const
inline

Definition at line 273 of file main.cpp.

◆ debug() [1/2]

bool CommandLineOptions::debug ( ) const
inline

Definition at line 271 of file main.cpp.

Referenced by SyncScanner::updateSymbolDescriptor().

Here is the caller graph for this function:

◆ debug() [2/2]

bool CommandLineOptions::debug ( ) const
inline

Definition at line 271 of file main.cpp.

◆ generatedHeaders() [1/2]

const std::set< std::string > & CommandLineOptions::generatedHeaders ( ) const
inline

Definition at line 261 of file main.cpp.

◆ generatedHeaders() [2/2]

const std::set< std::string > & CommandLineOptions::generatedHeaders ( ) const
inline

Definition at line 261 of file main.cpp.

◆ headers() [1/2]

const std::set< std::string > & CommandLineOptions::headers ( ) const
inline

Definition at line 259 of file main.cpp.

◆ headers() [2/2]

const std::set< std::string > & CommandLineOptions::headers ( ) const
inline

Definition at line 259 of file main.cpp.

◆ includeDir() [1/2]

const std::string & CommandLineOptions::includeDir ( ) const
inline

Definition at line 225 of file main.cpp.

Referenced by SyncScanner::currentFileIncludePath(), SyncScanner::currentFileOutputDir(), SyncScanner::generateAliasedHeaderFileIfTimestampChanged(), SyncScanner::generateDeprecatedHeaders(), SyncScanner::generateMasterHeader(), SyncScanner::processHeader(), and SyncScanner::sync().

Here is the caller graph for this function:

◆ includeDir() [2/2]

const std::string & CommandLineOptions::includeDir ( ) const
inline

Definition at line 225 of file main.cpp.

◆ installIncludeDir() [1/2]

const std::string & CommandLineOptions::installIncludeDir ( ) const
inline

Definition at line 227 of file main.cpp.

◆ installIncludeDir() [2/2]

const std::string & CommandLineOptions::installIncludeDir ( ) const
inline

Definition at line 227 of file main.cpp.

◆ isFramework() [1/2]

bool CommandLineOptions::isFramework ( ) const
inline

Definition at line 279 of file main.cpp.

Referenced by SyncScanner::sync().

Here is the caller graph for this function:

◆ isFramework() [2/2]

bool CommandLineOptions::isFramework ( ) const
inline

Definition at line 279 of file main.cpp.

◆ isInternal() [1/2]

bool CommandLineOptions::isInternal ( ) const
inline

Definition at line 265 of file main.cpp.

◆ isInternal() [2/2]

bool CommandLineOptions::isInternal ( ) const
inline

Definition at line 265 of file main.cpp.

◆ isNonQtModule() [1/2]

bool CommandLineOptions::isNonQtModule ( ) const
inline

Definition at line 267 of file main.cpp.

Referenced by SyncScanner::processHeader(), and SyncScanner::sync().

Here is the caller graph for this function:

◆ isNonQtModule() [2/2]

bool CommandLineOptions::isNonQtModule ( ) const
inline

Definition at line 267 of file main.cpp.

◆ isValid() [1/2]

bool CommandLineOptions::isValid ( ) const
inline

Definition at line 212 of file main.cpp.

Referenced by main().

Here is the caller graph for this function:

◆ isValid() [2/2]

bool CommandLineOptions::isValid ( ) const
inline

Definition at line 212 of file main.cpp.

◆ knownModules() [1/2]

const std::set< std::string > & CommandLineOptions::knownModules ( ) const
inline

Definition at line 245 of file main.cpp.

◆ knownModules() [2/2]

const std::set< std::string > & CommandLineOptions::knownModules ( ) const
inline

Definition at line 245 of file main.cpp.

◆ minimal() [1/2]

bool CommandLineOptions::minimal ( ) const
inline

Definition at line 275 of file main.cpp.

Referenced by SyncScanner::processHeader(), and SyncScanner::sync().

Here is the caller graph for this function:

◆ minimal() [2/2]

bool CommandLineOptions::minimal ( ) const
inline

Definition at line 275 of file main.cpp.

◆ moduleMapFile() [1/2]

const std::string & CommandLineOptions::moduleMapFile ( ) const
inline

Definition at line 243 of file main.cpp.

Referenced by SyncScanner::generateModuleMapFile(), and SyncScanner::sync().

Here is the caller graph for this function:

◆ moduleMapFile() [2/2]

const std::string & CommandLineOptions::moduleMapFile ( ) const
inline

Definition at line 243 of file main.cpp.

◆ moduleName() [1/2]

const std::string & CommandLineOptions::moduleName ( ) const
inline

Definition at line 214 of file main.cpp.

Referenced by SyncScanner::currentFileIncludePath(), SyncScanner::generateAliasedHeaderFileIfTimestampChanged(), SyncScanner::generateDeprecatedHeaders(), SyncScanner::generateForwardingHeader(), SyncScanner::generateHeaderCheckExceptions(), SyncScanner::generateMasterHeader(), SyncScanner::generateModuleMapFile(), SyncScanner::generateVersionHeader(), SyncScanner::parseHeader(), and SyncScanner::sync().

Here is the caller graph for this function:

◆ moduleName() [2/2]

const std::string & CommandLineOptions::moduleName ( ) const
inline

Definition at line 214 of file main.cpp.

◆ moduleVersion() [1/2]

const std::string & CommandLineOptions::moduleVersion ( ) const
inline

Definition at line 216 of file main.cpp.

Referenced by SyncScanner::generateVersionHeader().

Here is the caller graph for this function:

◆ moduleVersion() [2/2]

const std::string & CommandLineOptions::moduleVersion ( ) const
inline

Definition at line 216 of file main.cpp.

◆ moduleVersionMajor() [1/2]

int CommandLineOptions::moduleVersionMajor ( ) const
inline

Definition at line 217 of file main.cpp.

Referenced by SyncScanner::generateVersionHeader().

Here is the caller graph for this function:

◆ moduleVersionMajor() [2/2]

int CommandLineOptions::moduleVersionMajor ( ) const
inline

Definition at line 217 of file main.cpp.

◆ moduleVersionMinor() [1/2]

int CommandLineOptions::moduleVersionMinor ( ) const
inline

Definition at line 218 of file main.cpp.

Referenced by SyncScanner::generateVersionHeader().

Here is the caller graph for this function:

◆ moduleVersionMinor() [2/2]

int CommandLineOptions::moduleVersionMinor ( ) const
inline

Definition at line 218 of file main.cpp.

◆ moduleVersionPatch() [1/2]

int CommandLineOptions::moduleVersionPatch ( ) const
inline

Definition at line 219 of file main.cpp.

Referenced by SyncScanner::generateVersionHeader().

Here is the caller graph for this function:

◆ moduleVersionPatch() [2/2]

int CommandLineOptions::moduleVersionPatch ( ) const
inline

Definition at line 219 of file main.cpp.

◆ printHelp() [1/2]

void CommandLineOptions::printHelp ( ) const
inline

Definition at line 283 of file main.cpp.

Referenced by main().

Here is the caller graph for this function:

◆ printHelp() [2/2]

void CommandLineOptions::printHelp ( ) const
inline

Definition at line 283 of file main.cpp.

◆ printHelpOnly() [1/2]

bool CommandLineOptions::printHelpOnly ( ) const
inline

Definition at line 269 of file main.cpp.

Referenced by main().

Here is the caller graph for this function:

◆ printHelpOnly() [2/2]

bool CommandLineOptions::printHelpOnly ( ) const
inline

Definition at line 269 of file main.cpp.

◆ privateHeadersRegex() [1/2]

const std::regex & CommandLineOptions::privateHeadersRegex ( ) const
inline

Definition at line 255 of file main.cpp.

Referenced by SyncScanner::isHeaderPrivate().

Here is the caller graph for this function:

◆ privateHeadersRegex() [2/2]

const std::regex & CommandLineOptions::privateHeadersRegex ( ) const
inline

Definition at line 255 of file main.cpp.

◆ privateIncludeDir() [1/2]

const std::string & CommandLineOptions::privateIncludeDir ( ) const
inline

Definition at line 229 of file main.cpp.

Referenced by SyncScanner::currentFileOutputDir().

Here is the caller graph for this function:

◆ privateIncludeDir() [2/2]

const std::string & CommandLineOptions::privateIncludeDir ( ) const
inline

Definition at line 229 of file main.cpp.

◆ publicNamespaceRegex() [1/2]

const std::regex & CommandLineOptions::publicNamespaceRegex ( ) const
inline

Definition at line 257 of file main.cpp.

Referenced by SyncScanner::parseHeader().

Here is the caller graph for this function:

◆ publicNamespaceRegex() [2/2]

const std::regex & CommandLineOptions::publicNamespaceRegex ( ) const
inline

Definition at line 257 of file main.cpp.

◆ qpaHeadersRegex() [1/2]

const std::regex & CommandLineOptions::qpaHeadersRegex ( ) const
inline

Definition at line 247 of file main.cpp.

Referenced by SyncScanner::isHeaderQpa().

Here is the caller graph for this function:

◆ qpaHeadersRegex() [2/2]

const std::regex & CommandLineOptions::qpaHeadersRegex ( ) const
inline

Definition at line 247 of file main.cpp.

◆ qpaIncludeDir() [1/2]

const std::string & CommandLineOptions::qpaIncludeDir ( ) const
inline

Definition at line 231 of file main.cpp.

Referenced by SyncScanner::currentFileOutputDir().

Here is the caller graph for this function:

◆ qpaIncludeDir() [2/2]

const std::string & CommandLineOptions::qpaIncludeDir ( ) const
inline

Definition at line 231 of file main.cpp.

◆ rhiHeadersRegex() [1/2]

const std::regex & CommandLineOptions::rhiHeadersRegex ( ) const
inline

Definition at line 249 of file main.cpp.

Referenced by SyncScanner::isHeaderRhi().

Here is the caller graph for this function:

◆ rhiHeadersRegex() [2/2]

const std::regex & CommandLineOptions::rhiHeadersRegex ( ) const
inline

Definition at line 249 of file main.cpp.

◆ rhiIncludeDir() [1/2]

const std::string & CommandLineOptions::rhiIncludeDir ( ) const
inline

Definition at line 233 of file main.cpp.

Referenced by SyncScanner::currentFileOutputDir().

Here is the caller graph for this function:

◆ rhiIncludeDir() [2/2]

const std::string & CommandLineOptions::rhiIncludeDir ( ) const
inline

Definition at line 233 of file main.cpp.

◆ scanAllMode() [1/2]

bool CommandLineOptions::scanAllMode ( ) const
inline

Definition at line 263 of file main.cpp.

Referenced by SyncScanner::processHeader(), and SyncScanner::sync().

Here is the caller graph for this function:

◆ scanAllMode() [2/2]

bool CommandLineOptions::scanAllMode ( ) const
inline

Definition at line 263 of file main.cpp.

◆ showOnly() [1/2]

bool CommandLineOptions::showOnly ( ) const
inline

Definition at line 277 of file main.cpp.

Referenced by SyncScanner::generateAliasedHeaderFileIfTimestampChanged(), SyncScanner::generateForwardingHeader(), SyncScanner::parseHeader(), SyncScanner::updateOrCopy(), SyncScanner::updateSymbolDescriptor(), and SyncScanner::writeIfDifferent().

Here is the caller graph for this function:

◆ showOnly() [2/2]

bool CommandLineOptions::showOnly ( ) const
inline

Definition at line 277 of file main.cpp.

◆ sourceDir() [1/2]

const std::string & CommandLineOptions::sourceDir ( ) const
inline

Definition at line 221 of file main.cpp.

Referenced by SyncScanner::makeHeaderAbsolute(), SyncScanner::parseVersionScriptContent(), SyncScanner::processHeader(), and SyncScanner::resetCurrentFileInfoData().

Here is the caller graph for this function:

◆ sourceDir() [2/2]

const std::string & CommandLineOptions::sourceDir ( ) const
inline

Definition at line 221 of file main.cpp.

◆ spiHeadersRegex() [1/2]

const std::regex & CommandLineOptions::spiHeadersRegex ( ) const
inline

Definition at line 253 of file main.cpp.

Referenced by SyncScanner::isHeaderSpi().

Here is the caller graph for this function:

◆ spiHeadersRegex() [2/2]

const std::regex & CommandLineOptions::spiHeadersRegex ( ) const
inline

Definition at line 253 of file main.cpp.

◆ spiIncludeDir() [1/2]

const std::string & CommandLineOptions::spiIncludeDir ( ) const
inline

Definition at line 237 of file main.cpp.

Referenced by SyncScanner::currentFileOutputDir().

Here is the caller graph for this function:

◆ spiIncludeDir() [2/2]

const std::string & CommandLineOptions::spiIncludeDir ( ) const
inline

Definition at line 237 of file main.cpp.

◆ ssgHeadersRegex() [1/2]

const std::regex & CommandLineOptions::ssgHeadersRegex ( ) const
inline

Definition at line 251 of file main.cpp.

Referenced by SyncScanner::isHeaderSsg().

Here is the caller graph for this function:

◆ ssgHeadersRegex() [2/2]

const std::regex & CommandLineOptions::ssgHeadersRegex ( ) const
inline

Definition at line 251 of file main.cpp.

◆ ssgIncludeDir() [1/2]

const std::string & CommandLineOptions::ssgIncludeDir ( ) const
inline

Definition at line 235 of file main.cpp.

Referenced by SyncScanner::currentFileOutputDir().

Here is the caller graph for this function:

◆ ssgIncludeDir() [2/2]

const std::string & CommandLineOptions::ssgIncludeDir ( ) const
inline

Definition at line 235 of file main.cpp.

◆ stagingDir() [1/2]

const std::string & CommandLineOptions::stagingDir ( ) const
inline

Definition at line 239 of file main.cpp.

Referenced by SyncScanner::sync().

Here is the caller graph for this function:

◆ stagingDir() [2/2]

const std::string & CommandLineOptions::stagingDir ( ) const
inline

Definition at line 239 of file main.cpp.

◆ versionScriptFile() [1/2]

const std::string & CommandLineOptions::versionScriptFile ( ) const
inline

Definition at line 241 of file main.cpp.

Referenced by SyncScanner::generateLinkerVersionScript(), SyncScanner::processHeader(), and SyncScanner::sync().

Here is the caller graph for this function:

◆ versionScriptFile() [2/2]

const std::string & CommandLineOptions::versionScriptFile ( ) const
inline

Definition at line 241 of file main.cpp.

◆ warningsAreErrors() [1/2]

bool CommandLineOptions::warningsAreErrors ( ) const
inline

Definition at line 281 of file main.cpp.

Referenced by SyncScanner::sync().

Here is the caller graph for this function:

◆ warningsAreErrors() [2/2]

bool CommandLineOptions::warningsAreErrors ( ) const
inline

Definition at line 281 of file main.cpp.

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