configurator.h

Go to the documentation of this file.

#ifndef CONFIGURATOR_CLASS
#define CONFIGURATOR_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : configurator                                                      *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2000-$now By Author.  This program 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.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/contracts.h>
#include <structures/set.h>
#include <structures/string_array.h>
#include <structures/string_table.h>
 
namespace configuration {
 
 
class configurator : public virtual basis::root_object
{
public:
  enum treatment_of_defaults { AUTO_STORE, RETURN_ONLY };
 
  configurator(treatment_of_defaults behavior = RETURN_ONLY) : _behavior(behavior) {}
  virtual ~configurator();
 
  treatment_of_defaults behavior() const { return _behavior; }
  void behavior(treatment_of_defaults new_behavior) {
    _behavior = (new_behavior == RETURN_ONLY)? RETURN_ONLY : AUTO_STORE;
  }
 
  virtual bool get(const basis::astring &section, const basis::astring &entry,
          basis::astring &found) = 0;
 
  virtual bool put(const basis::astring &section, const basis::astring &entry,
          const basis::astring &to_store) = 0;
 
  bool store(const basis::astring &section, const basis::astring &entry,
          const basis::astring &to_store);
 
 
  basis::astring load(const basis::astring &section, const basis::astring &entry,
          const basis::astring &default_value);
 
  bool store(const basis::astring &section, const basis::astring &entry, int value);
  int load(const basis::astring &section, const basis::astring &entry, int def_value);
 
  // the various methods below that operate on sections and entries might not
  // be provided by all configurators.  that is why there are empty default
  // (or simplistic and slow) implementations provided below.
 
  virtual void sections(structures::string_array &list);
 
  void section_set(structures::string_set &list);
 
  virtual bool delete_entry(const basis::astring & formal(section),
          const basis::astring & formal(entry)) { return false; }
 
  virtual bool delete_section(const basis::astring & formal(section) )
          { return false; }
 
  virtual bool section_exists(const basis::astring &section);
 
  virtual bool get_section(const basis::astring & formal(section),
          structures::string_table & formal(found) ) { return false; }
 
  virtual bool put_section(const basis::astring & formal(section),
          const structures::string_table & formal(to_store) ) { return false; }
 
private:
  treatment_of_defaults _behavior;  
};
 
} //namespace.
 
#endif