Generic application. More...

#include <Application.h>

Inheritance diagram for Application:

Public Types
enum	Result { Success, NotFound, IOError, InvalidArgument, ShowUsage, TimedOut, OutOfMemory }
	Result codes. More...

Public Member Functions
	Application (int argc, char **argv)
	Class constructor. More...

virtual	~Application ()
	Class destructor. More...

virtual int	run ()
	Run the application. More...

Protected Member Functions
virtual Result	initialize ()
	Initialize the application. More...

virtual Result	exec ()=0
	Execute the application event loop. More...

virtual Result	output (const char *string) const =0
	Print text to output. More...

virtual Result	output (String &string) const
	Print string to output. More...

ArgumentParser &	parser ()
	Get program arguments parser. More...

const ArgumentParser &	parser () const
	Get constant program arguments parser. More...

const ArgumentContainer &	arguments () const
	Get program arguments. More...

void	setVersion (const String &version)
	Set program version. More...

Protected Attributes
int	m_argc
	Input argument count. More...

char **	m_argv
	Input argument values. More...

Private Member Functions
void	usage () const
	Print usage and terminate. More...

Private Attributes
ArgumentParser	m_parser
	Program argument parser object. More...

ArgumentContainer	m_arguments
	Parsed Arguments. More...

String	m_version
	Program version. More...

Static Private Attributes
static const uint	ExitSuccess = 0
	Exit code for successful termination. More...

static const uint	ExitFailure = 1
	Exit code for failure termination. More...

Detailed Description

Generic application.

Definition at line 38 of file Application.h.

Member Enumeration Documentation

◆ Result

enum Application::Result

Result codes.

Enumerator
Success
NotFound
IOError
InvalidArgument
ShowUsage
TimedOut
OutOfMemory

Definition at line 53 of file Application.h.

Constructor & Destructor Documentation

◆ Application()

Application::Application	(	int	argc,
		char **	argv
	)

Class constructor.

Parameters

argc	Argument count
argv	Argument values

Definition at line 20 of file Application.cpp.

References m_argc, m_argv, m_parser, and ArgumentParser::registerFlag().

◆ ~Application()

Application::~Application ( )

virtual

Class destructor.

Definition at line 29 of file Application.cpp.

Member Function Documentation

◆ arguments()

const ArgumentContainer & Application::arguments ( ) const

protected

Get program arguments.

Definition at line 112 of file Application.cpp.

References m_arguments.

Referenced by NetPing::exec(), Decompress::exec(), Init::exec(), Login::exec(), ListFiles::exec(), FileStatus::exec(), SievePrime::exec(), Remove::exec(), Echo::exec(), MakeNode::exec(), Shutdown::exec(), Sleep::exec(), Mount::exec(), CreateFile::exec(), UnixName::exec(), SysControl::exec(), Shell::exec(), NetCat::exec(), Cat::exec(), MpiPrime::exec(), NetSend::exec(), BootImageCreate::exec(), DhcpClient::exec(), NetCat::initialize(), Cat::initialize(), NetSend::initialize(), MpiProxy::initialize(), DhcpClient::initialize(), ListFiles::printFiles(), ListFiles::printSingleFile(), and SievePrime::reportResult().

◆ exec()

virtual Result Application::exec ( )

protectedpure virtual

Execute the application event loop.

Returns: Result code

Implemented in DhcpClient, MpiProxy, BootImageCreate, NetSend, MpiPing, MpiPrime, Cat, NetCat, NetCtl, Shell, SysInfo, SysControl, BenchMark, Decompress, Echo, Hostname, Init, Login, ListFiles, MakeNode, Mount, SievePrime, Remove, Shutdown, Sleep, FileStatus, CreateFile, UnixName, NetPing, and ProcessList.

Referenced by run().

◆ initialize()

Application::Result Application::initialize ( )

protectedvirtual

Initialize the application.

Returns: Result code

Reimplemented in DhcpClient, MpiProxy, NetSend, MpiPing, MpiPrime, Cat, NetCat, and NetCtl.

Definition at line 33 of file Application.cpp.

References Success.

Referenced by run().

◆ output() [1/2]

virtual Result Application::output ( const char * string ) const

protectedpure virtual

Print text to output.

Parameters

string Text to print to program output.

Returns: Result code.

Implemented in BootImageCreate, and POSIXApplication.

Referenced by output(), run(), and usage().

◆ output() [2/2]

Application::Result Application::output ( String & string ) const

protectedvirtual

Print string to output.

Parameters

string Reference to string to output.

Returns: Result code.

Definition at line 97 of file Application.cpp.

References output().

◆ parser() [1/2]

const ArgumentParser & Application::parser ( )

protected

Get program arguments parser.

Returns: Program arguments parser.

Definition at line 102 of file Application.cpp.

References m_parser.

Referenced by BenchMark::BenchMark(), BootImageCreate::BootImageCreate(), Cat::Cat(), Cat::cat(), CreateFile::CreateFile(), Decompress::Decompress(), DhcpClient::DhcpClient(), Echo::Echo(), BootImageCreate::exec(), FileStatus::FileStatus(), Hostname::Hostname(), Init::Init(), ListFiles::ListFiles(), Login::Login(), MakeNode::MakeNode(), Mount::Mount(), MpiPing::MpiPing(), MpiPrime::MpiPrime(), MpiProxy::MpiProxy(), NetCat::NetCat(), NetCtl::NetCtl(), NetPing::NetPing(), NetSend::NetSend(), ProcessList::ProcessList(), BootImageCreate::readBootSymbols(), Remove::Remove(), Shell::Shell(), Shutdown::Shutdown(), SievePrime::SievePrime(), Sleep::Sleep(), SysControl::SysControl(), SysInfo::SysInfo(), and UnixName::UnixName().

◆ parser() [2/2]

const ArgumentParser& Application::parser ( ) const

protected

Get constant program arguments parser.

Returns: Program arguments parser.

◆ run()

int Application::run ( )

virtual

Run the application.

Returns: Exit code

Definition at line 38 of file Application.cpp.

References Log::Debug, exec(), ExitFailure, ExitSuccess, ArgumentContainer::get(), initialize(), WeakSingleton< Log >::instance(), m_argc, m_arguments, m_argv, m_parser, m_version, output(), ArgumentParser::parse(), Log::setMinimumLogLevel(), ArgumentParser::setName(), ShowUsage, ArgumentParser::Success, Success, and usage().

Referenced by main().

◆ setVersion()

void Application::setVersion ( const String & version )

protected

Set program version.

Parameters

version Program version string

Definition at line 117 of file Application.cpp.

References m_version.

Referenced by POSIXApplication::POSIXApplication().

◆ usage()

void Application::usage ( ) const

private

Print usage and terminate.

Definition at line 91 of file Application.cpp.

References ArgumentParser::getUsage(), m_parser, and output().

Referenced by run().

Field Documentation

◆ ExitFailure

const uint Application::ExitFailure = 1

staticprivate

Exit code for failure termination.

Definition at line 46 of file Application.h.

Referenced by run().

◆ ExitSuccess

const uint Application::ExitSuccess = 0

staticprivate

Exit code for successful termination.

Definition at line 43 of file Application.h.

Referenced by run().

◆ m_argc

int Application::m_argc

protected

Input argument count.

Definition at line 157 of file Application.h.

Referenced by Application(), and run().

◆ m_arguments

ArgumentContainer Application::m_arguments

private

Parsed Arguments.

Definition at line 168 of file Application.h.

Referenced by arguments(), and run().

◆ m_argv

char** Application::m_argv

protected

Input argument values.

Definition at line 160 of file Application.h.

Referenced by Application(), and run().

◆ m_parser

ArgumentParser Application::m_parser

private

Program argument parser object.

Definition at line 165 of file Application.h.

Referenced by Application(), parser(), run(), and usage().

◆ m_version

String Application::m_version

private

Program version.

Definition at line 171 of file Application.h.

Referenced by run(), and setVersion().

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

lib/libapp/Application.h
lib/libapp/Application.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Result

Constructor & Destructor Documentation

◆ Application()

◆ ~Application()

Member Function Documentation

◆ arguments()

◆ exec()

◆ initialize()

◆ output() [1/2]

◆ output() [2/2]

◆ parser() [1/2]

◆ parser() [2/2]

◆ run()

◆ setVersion()

◆ usage()

Field Documentation

◆ ExitFailure

◆ ExitSuccess

◆ m_argc

◆ m_arguments

◆ m_argv

◆ m_parser

◆ m_version