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 "data_structure_dll.h"

// forward.
class string_array;
class string_set;
class string_table;


class DATA_STRUCTURE_CLASS_STYLE configurator
{
public:
  enum treatment_of_defaults { AUTO_STORE, RETURN_ONLY };

  inline configurator(treatment_of_defaults behavior) : _behavior(behavior) {}
  virtual ~configurator();

  inline treatment_of_defaults behavior() const { return _behavior; }
  inline void behavior(treatment_of_defaults new_behavior) {
    _behavior = (new_behavior == RETURN_ONLY)? RETURN_ONLY : AUTO_STORE;
  }

  virtual bool get(const istring &section, const istring &entry,
          istring &found) = 0;

  virtual bool put(const istring &section, const istring &entry,
          const istring &to_store) = 0;

  bool store(const istring &section, const istring &entry,
          const istring &to_store);


  istring load(const istring &section, const istring &entry,
          const istring &default_value);

  bool store(const istring &section, const istring &entry, int value);
  int load(const istring &section, const istring &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(string_array &list);

  void section_set(string_set &list);

  virtual bool delete_entry(const istring & formal(section),
          const istring & formal(entry)) { return false; }

  virtual bool delete_section(const istring & formal(section) )
          { return false; }

  virtual bool section_exists(const istring &section);

  virtual bool get_section(const istring & formal(section),
          string_table & formal(found) ) { return false; }

  virtual bool put_section(const istring & formal(section),
          const string_table & formal(to_store) ) { return false; }

private:
  treatment_of_defaults _behavior;  
};

#endif

---