/* -*- 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"

/**
 * This exception is thrown by Configuration when reload fails.
 */
class ConfigurationException: public Exception {
public:
  ConfigurationException(std::string reason) : 
    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 config variable.
 * @param config The value of the Configuration pointer.
 */
void initConfig(Configuration *config);

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


#endif/*__ARTEFACT_CONFIGURATION_H__*/