← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/libclaw/oneiric

« back to all changes in this revision

Viewing changes to claw/application.hpp

  • Committer: Bazaar Package Importer
  • Author(s): Julien Jorge
  • Date: 2008-05-17 15:36:57 UTC
  • Revision ID: james.westby@ubuntu.com-20080517153657-0b1204j754ykoz48
Tags: upstream-1.5.2b
Import upstream version 1.5.2b

Show diffs side-by-side

added added

removed removed

Lines of Context:
claw/application.hpp
 
1
/*
 
2
  CLAW - a C++ Library Absolutely Wonderful
 
3
 
 
4
  CLAW is a free library without any particular aim but being useful to 
 
5
  anyone.
 
6
 
 
7
  Copyright (C) 2005-2008 Julien Jorge
 
8
 
 
9
  This library is free software; you can redistribute it and/or
 
10
  modify it under the terms of the GNU Lesser General Public
 
11
  License as published by the Free Software Foundation; either
 
12
  version 2.1 of the License, or (at your option) any later version.
 
13
 
 
14
  This library is distributed in the hope that it will be useful,
 
15
  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
17
  Lesser General Public License for more details.
 
18
 
 
19
  You should have received a copy of the GNU Lesser General Public
 
20
  License along with this library; if not, write to the Free Software
 
21
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
22
 
 
23
  contact: julien_jorge@yahoo.fr
 
24
*/
 
25
/**
 
26
 * \file application.hpp
 
27
 * \brief A class to represent the application.
 
28
 * \author Julien Jorge
 
29
 */
 
30
#ifndef __CLAW_APPLICATION_HPP__
 
31
#define __CLAW_APPLICATION_HPP__
 
32
 
 
33
#include <claw/arguments_table.hpp>
 
34
 
 
35
/**
 
36
 * \brief Use this macro to implement your application's class. If you want to
 
37
 * implement your application class named my_app, write somewhere in your
 
38
 * code (no semi column at the end of the line) :
 
39
 * <tt> CLAW_APPLICATION_IMPLEMENT(my_app) </tt>
 
40
 * \pre App must inerhit from claw::application.
 
41
 */
 
42
#define CLAW_APPLICATION_IMPLEMENT(App)         \
 
43
  int main(int argc, char** argv)               \
 
44
  {                                             \
 
45
    App app(argc, argv);                        \
 
46
    return app.run();                           \
 
47
  }                                             \
 
48
 
 
49
namespace claw
 
50
{
 
51
  /**
 
52
   * \brief A class to represent the application.
 
53
   *
 
54
   * The claw::application understand the following command line arguments :
 
55
   * - --log-file=string Sets the file in which the logs are written,
 
56
   * - --log-level=integer Sets the log level.
 
57
   * 
 
58
   * \author Julien Jorge
 
59
   */
 
60
  class application
 
61
  {
 
62
  public:
 
63
    application( int& argc, char** &argv );
 
64
    virtual ~application();
 
65
 
 
66
    virtual int run() = 0;
 
67
 
 
68
  protected:
 
69
    /** \brief The arguments passed by the system. */
 
70
    arguments_table m_arguments;
 
71
  }; // class application
 
72
} // namespace claw
 
73
 
 
74
#endif // __CLAW_APPLICATION_HPP__