dxl::DXLApp Class Reference

Description:

class DXLApp

Definition at line 37 of file dxlapp.hpp.

#include <dxlapp.hpp>

Inheritance diagram for dxl::DXLApp:

Public Method Index:
	DXLApp ()
	Constructor.
alib::lox::Lox *	GetRLox () final
Public Method Index: inherited from alib::app::App
virtual void	exceptionDisplay (Exception &exception, AString &target)
virtual Enum	exceptionToExitCode (Exception &exception)
virtual void	exitWithHelpOutput (Enum exitCode, const String &helpTopic=NULL_STRING, Box formatParam1=EMPTY_STRING, Box formatParam2=EMPTY_STRING)
virtual void	getConfigFilePaths (StdVectorMA< ConfigFileDescriptor > &files)
virtual void	getConfigFilePathsFromCLIParam (StdVectorMA< ConfigFileDescriptor > &files)
virtual void	getConfigFilePathsFromResources (StdVectorMA< ConfigFileDescriptor > &files)
virtual void	getConfigFilePathsMakeAbsolutePaths (StdVectorMA< ConfigFileDescriptor > &files)
String	GetInfo ()
String	GetName ()
virtual lox::textlogger::TextLogger *	GetRLogger ()
String	GetVersion ()
virtual int	Main (int argc, const char **argv, const wchar_t **argvw=nullptr)
virtual void	onBsCLIReadOptions ()
virtual void	onBsConfigureCLI ()
virtual void	onBsFinalizeBootstrap ()
virtual void	onBsImportConfig ()
virtual void	onBsPreloadVariables ()
virtual void	onBsReadDryRunOption ()
virtual void	onBsSetCamps ()
virtual void	onBsSetupALox ()
virtual void	onRun ()
virtual void	onRunStart ()
virtual void	onSdAnnounceShutdown ()
virtual void	onSdCleanALox ()
virtual void	onSdExportConfig ()
virtual void	onSdFinalizeShutdown ()
virtual void	onSdOutput ()
virtual void	printConfigFileInfo (Paragraphs &target)

Protected Type Index:
enum class	CustomStates { CLIDefine , ReadDryRunOption , ConfigureCLI }
	Custom States of this App application. More...
Protected Type Index: inherited from alib::app::App
enum	Commands
enum	ExitCodes
enum	Flags
enum	Options
enum	Parameters
enum	States

Protected Field Index:
alib::String	DoxyfilePath =nullptr
	The file path of the Doxyfile as given on the command line.
DoxygenXLinks *	dxl =nullptr
	The instance of the main class. todox.
alib::Path	PWD
Protected Field Index: inherited from alib::app::App
String	appInfo
String	appName
String	appVersion
Paragraphs *	cErr
CommandLine	cli
bool	cliStop
Paragraphs *	cOut
bool	dryrun
Flags	flags
StateMachine	machine
lox::textlogger::TextLogger *	releaseLogger
NString	releaseLoggerName
lox::Lox *	releaseLox
NString	releaseLoxName
StopWatch	stopWatch

Protected Method Index:
void	onBsCLIDefine () override
	Defines CLI entities specific to DoxygenXLinks.
void	onBsPrepareConfig () override
	Bootstraps enum records.
void	onBsPrepareResources () override
	Bulk-loads DoxygenXLinks specific resource strings into module APP.
void	onBsSetNameVersionAndInfo () override
void	onRunEnd () override
	Waits for our thread-pool to become idle, shuts it down, and deletes it.
bool	processCLICmd (alib::app::Command *cmd) override

Additional Inherited Members
Public Type Index: inherited from alib::app::App
enum	Exceptions

Friends And Related Entity Details:

DoxygenINIFile

friend struct DoxygenINIFile

friend

Definition at line 38 of file dxlapp.hpp.

DoxygenXLinks

friend class DoxygenXLinks

friend

Definition at line 39 of file dxlapp.hpp.

HTMLReplacer

friend struct HTMLReplacer

friend

Definition at line 42 of file dxlapp.hpp.

Index

friend class Index

friend

Definition at line 40 of file dxlapp.hpp.

SourceLocationFinder

friend struct SourceLocationFinder

friend

Definition at line 43 of file dxlapp.hpp.

SourceReplacer

friend struct SourceReplacer

friend

Definition at line 44 of file dxlapp.hpp.

XLink

friend class XLink

friend

Definition at line 41 of file dxlapp.hpp.

Enumeration Details:

CustomStates

enum class dxl::DXLApp::CustomStates

strongprotected

Custom States of this App application.

Enumerator
CLIDefine	Inserted before App::PrepareConfig.
ReadDryRunOption	Inserted before SetupALox.
ConfigureCLI	Inserted after ImportConfig.

Definition at line 80 of file dxlapp.hpp.

Field Details:

DoxyfilePath

alib::String dxl::DXLApp::DoxyfilePath =nullptr

protected

The file path of the Doxyfile as given on the command line.

Definition at line 56 of file dxlapp.hpp.

dxl

DoxygenXLinks* dxl::DXLApp::dxl =nullptr

protected

The instance of the main class. todox.

Definition at line 49 of file dxlapp.hpp.

PWD

alib::Path dxl::DXLApp::PWD

protected

The working directory. Either given with –PWD or detected as the current execution directory.

Definition at line 53 of file dxlapp.hpp.

Constructor(s) / Destructor Details:

DXLApp()

dxl::DXLApp::DXLApp

(

)

Constructor.

Definition at line 27 of file dxlapp.cpp.

Method Details:

GetRLox()

alib::lox::Lox * dxl::DXLApp::GetRLox ( )

inlinefinalvirtual

Returns

The release lox of this application. This component of ALib Module ALox is used to generate verbose output accross this project.

Reimplemented from alib::app::App.

Definition at line 96 of file dxlapp.hpp.

onBsCLIDefine()

void dxl::DXLApp::onBsCLIDefine ( )

overrideprotectedvirtual

Defines CLI entities specific to DoxygenXLinks.

Reimplemented from alib::app::App.

Definition at line 416 of file dxlapp.cpp.

onBsPrepareConfig()

void dxl::DXLApp::onBsPrepareConfig ( )

overrideprotectedvirtual

Bootstraps enum records.

Reimplemented from alib::app::App.

Definition at line 372 of file dxlapp.cpp.

onBsPrepareResources()

void dxl::DXLApp::onBsPrepareResources ( )

overrideprotectedvirtual

Bulk-loads DoxygenXLinks specific resource strings into module APP.

Reimplemented from alib::app::App.

Definition at line 34 of file dxlapp.cpp.

onBsSetNameVersionAndInfo()

void dxl::DXLApp::onBsSetNameVersionAndInfo ( )

overrideprotectedvirtual

Sets the field appVersion and then invokes the parent implementation onBsSetNameVersionAndInfo.

Reimplemented from alib::app::App.

Definition at line 406 of file dxlapp.cpp.

onRunEnd()

void dxl::DXLApp::onRunEnd ( )

overrideprotectedvirtual

Waits for our thread-pool to become idle, shuts it down, and deletes it.

Reimplemented from alib::app::App.

Definition at line 443 of file dxlapp.cpp.

processCLICmd()

bool dxl::DXLApp::processCLICmd ( alib::app::Command * cmd )

overrideprotectedvirtual

Processes DoxygenXLinks commands.

Parameters

cmd	The command to process or nullptr for default execution.

Returns

true if the command was processed. false otherwise.

Reimplemented from alib::app::App.

Definition at line 425 of file dxlapp.cpp.

---

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

• dxlapp.hpp
• dxlapp.cpp