summaryrefslogtreecommitdiff
path: root/server/src/configuration.h
blob: 38dd2332ac22211b3b5832e8d7973ec9cb48bcf1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/***************************************************************************
 *            configuration.h
 *
 *  Tue Aug 15 23:57:12 CEST 2006
 *  Copyright  2006 Bent Bisballe Nyeng
 *  deva@aasimon.org
 ****************************************************************************/

/*
 *  This file is part of Artefact.
 *
 *  Artefact is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  Artefact is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Artefact; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
 */
#ifndef __ARTEFACT_CONFIGURATION_H__
#define __ARTEFACT_CONFIGURATION_H__

#include <libconfig.h++>
#include <string>

#include "exception.h"

namespace Pentominos {

  /**
   * This exception is thrown by Configuration when reload fails.
   */
  class ConfigurationException: public Pentominos::Exception {
  public:
    ConfigurationException(std::string reason) : 
      Pentominos::Exception(reason) {}
  };

  /**
   * This is the pentominos configuration class.\n
   * It simply wraps the libconfig c++ interface. It can be found at 
   * http://www.hyperrealm.com/libconfig/libconfig.html\n
   * To find out how the interface works, see
   * http://www.hyperrealm.com/libconfig/libconfig_manual.html#The-C_002b_002b-API
   */
  class Configuration : public libconfig::Config {
  public:
    /**
     * Constructor.\n
     * @param filename The filename to be loaded.
     */
    Configuration(std::string filename);

    /**
     * reload, simply reloads the configuration file attached to the configuration
     * object.
     */
    void reload() throw(ConfigurationException);

  private:
    std::string filename;
  };

  /**
   * Initialize the global configuration.\n
   * This function sets the Configuration global pointer, that can be reaced through
   * the Pentominos::config variable.
   * @param config The value of the Configuration pointer.
   */
  void initConfig(Configuration *config);

  /**
   * This function returns the global configuration object pointer.\n
   * Use Pentominos::initConfig to set it.\n
   * @return The pointer to the global configuration.
   */
  Configuration *config()
    throw(ConfigurationException);
};

#endif/*__ARTEFACT_CONFIGURATION_H__*/