Tools::Application Class Reference

#include <Application.h>

Inheritance diagram for Tools::Application:

[legend]Collaboration diagram for Tools::Application:

[legend]List of all members.

Public Member Functions
	Application (void)
virtual	~Application (void)
virtual void	initialize (void)
	Here you can setup your application before any other code is executed.
virtual void	initialize (int argc, char **argv)
	Here you can setup your application before any other code is executed.
virtual void	initializeCommandLineParser (CommandLineParser *parser)
	Teach command line parser the arguments.
virtual void	release (void)
	Here you can do some clean up before the application quits.
virtual void	defaultExceptionHandler (GenericException *ex)
	This method is called in case the exception arise inside one of startUp, execute or shutDown method.
virtual void	run (void)
virtual void	startUp (void) abstract
	In this method you can prepare your application to run.
virtual void	shutDown (void) abstract
	In this method you can do application clean up.
virtual void	execute (void) abstract
	This method should contain main application loop.
Static Public Member Functions
static Application *	current (void)
Public Attributes
Stream *	cin
	Standard input stream.
Stream *	cout
	Standard output stream.
Stream *	cerr
	Standard error stream.
Static Protected Attributes
static Application *	_current = nil

---

Constructor & Destructor Documentation

Application::Application (  void   )

Definition at line 39 of file Application.cc. References _current, cerr, cin, and cout. { _current = this; cin = (new FileAccessor(0))->withEncoding("default")->readStream(); cout = (new FileAccessor(1))->withEncoding("default")->writeStream(); dynamic_cast<EncodedStream *>(cout)->replacementCharacter(Character::value('?')); cerr = (new FileAccessor(2))->withEncoding("default")->writeStream(); dynamic_cast<EncodedStream *>(cerr)->replacementCharacter(Character::value('?')); }

Application::~Application (  void   )  [virtual]

Definition at line 49 of file Application.cc. References _current, and nil. { _current = nil; }

---

Member Function Documentation

Application * Application::current (  void   )  [static]

Definition at line 55 of file Application.cc. References _current. Referenced by Tools::Daemon::globalSignalHandler(). { return _current; }

void Application::defaultExceptionHandler (  GenericException *  ex  )  [virtual]

This method is called in case the exception arise inside one of startUp, execute or shutDown method. You can overwrite this to handle any uncatched exception properly. Definition at line 95 of file Application.cc. References cerr, Core::Object::printOn(), and Core::GenericException::printStackOn(). Referenced by run(). { ex->printOn(cerr); ex->printStackOn(cerr); cerr->flush(); }

virtual void Tools::Application::execute (  void   )  [virtual]

This method should contain main application loop. This method is guarded by global exception handler. Referenced by run().

void Application::initialize (  int  argc, char **  argv )  [virtual]

Here you can setup your application before any other code is executed. Command line arguments parsing in done here. This method is not ment to be overwritten by any child class (except some special cases). Overwrite the initialize() method instead. Definition at line 66 of file Application.cc. References cerr, Core::Stream::flush(), initialize(), initializeCommandLineParser(), Core::Stream::print(), and Tools::CommandLineParser::process(). { /* Let the application initialize */ initialize(); /* Parse command line arguments */ CommandLineParser *parser = new CommandLineParser; try { initializeCommandLineParser(parser); parser->process(argc, argv); } catch (CommandLineParserError *ex) { cerr->print(ex); cerr->flush(); exit(1); } }

void Application::initialize (  void   )  [virtual]

Here you can setup your application before any other code is executed. Don't forget to call your parent's method. This method is ment to initialize the Application object. To initialize the whole application use the startUp method. Definition at line 61 of file Application.cc. Referenced by initialize(). { /* Nothing */ }

void Application::initializeCommandLineParser (  CommandLineParser *  parser  )  [virtual]

Teach command line parser the arguments. If you want to parse command line arguments this is the method you want to overwrite. To setup arguments use parser methods: addMandatoryArgument(longArgumentName, [shortArgumentName,] callbackReceiver, callbackMethod [, userData]); addOptionalArgument(londArgumentName, [shortArgumentName,] callbackReceiver, callbackMethod [, userData]); addMandatoryArgumentWithParameter(longArgumentName, [shortArgumentName,] callbackReceiver, callbackMethod); addOptionalArgumentWithParameter(longArgumentName, [shortArgumentName,] callbackReceiver, callbackMethod); Definition at line 83 of file Application.cc. Referenced by initialize(). { /* nothing */ }

void Application::release (  void   )  [virtual]

Here you can do some clean up before the application quits. Don't forget to call your parent's method. This method is invoked even if main application (startUp, execute or shutDown method) raises an exception. This method is ment to clean up the Application object. To clean up the whole application use the shutDown method. Definition at line 88 of file Application.cc. References cerr, cout, and Core::Stream::flush(). { cout->flush(); cerr->flush(); }

void Application::run (  void   )  [virtual]

Reimplemented in Tools::Daemon. Definition at line 103 of file Application.cc. References defaultExceptionHandler(), execute(), shutDown(), and startUp(). Referenced by Tools::Daemon::run(). { try { startUp(); execute(); shutDown(); } catch (GenericException *ex) { defaultExceptionHandler(ex); } }

virtual void Tools::Application::shutDown (  void   )  [virtual]

In this method you can do application clean up. This method is guarded by global exception handler. Referenced by run().

virtual void Tools::Application::startUp (  void   )  [virtual]

In this method you can prepare your application to run. This method is guarded by global exception handler. Referenced by run().

---

Member Data Documentation

Application * Application::_current = nil [static, protected]

Definition at line 37 of file Application.cc. Referenced by Application(), current(), and ~Application().

Stream* Tools::Application::cerr

Standard error stream. Definition at line 43 of file Application.h. Referenced by Application(), defaultExceptionHandler(), initialize(), release(), and Tools::Daemon::run().

Stream* Tools::Application::cin

Standard input stream. Definition at line 41 of file Application.h. Referenced by Application().

Stream* Tools::Application::cout

Standard output stream. Definition at line 42 of file Application.h. Referenced by Application(), and release().

---

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

• Application.h
• Application.cc

---