configlet.h

Go to the documentation of this file.

#ifndef CONFIGLET_CLASS
#define CONFIGLET_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : configlet                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2001-$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"

#include <basis/istring.h>
#include <basis/object_base.h>

// forward.
class configurator;


class DATA_STRUCTURE_CLASS_STYLE configlet : public virtual object_base
{
public:
  configlet(const istring &section, const istring &entry);
  configlet(const configlet &to_copy);

  virtual ~configlet();

  IMPLEMENT_CLASS_NAME("configlet");

  configlet &operator =(const configlet &to_copy);

  const istring &section() const;
  const istring &entry() const;

  void section(const istring &new_section) const;
  void entry(const istring &new_entry) const;

  virtual bool load(configurator &config) = 0;

  virtual bool store(configurator &config) const = 0;

  virtual configlet *duplicate() const = 0;

private:
  istring *_section;  
  istring *_entry;  
};



class DATA_STRUCTURE_CLASS_STYLE string_configlet : public configlet
{
public:
  string_configlet(const istring &section, const istring &entry,
          const istring &current_value = istring::empty_string(),
          const istring &default_value = istring::empty_string());
  string_configlet(const string_configlet &to_copy);
  virtual ~string_configlet();

  string_configlet &operator =(const string_configlet &to_copy);

  const istring &current_value() const;
  const istring &default_value() const;

  void current_value(const istring &new_current);
  void default_value(const istring &new_default);
  
  virtual bool load(configurator &config);
  virtual bool store(configurator &config) const;

  configlet *duplicate() const;

private:
  istring *_current;
  istring *_default;
};



class DATA_STRUCTURE_CLASS_STYLE int_configlet : public configlet
{
public:
  int_configlet(const istring &section, const istring &entry,
          int current_value = 0, int default_value = 0);
  virtual ~int_configlet();

  int current_value() const { return _current; }

  virtual void current_value(int new_current);

  int default_value() const { return _default; }
  void default_value(int new_default) { _default = new_default; }

  virtual bool load(configurator &config);
  virtual bool store(configurator &config) const;

  configlet *duplicate() const;

private:
  int _current;
  int _default;
};



class DATA_STRUCTURE_CLASS_STYLE bounded_int_configlet : public int_configlet
{
public:
  bounded_int_configlet(const istring &section, const istring &entry,
          int current_value, int default_value, int minimum, int maximum);
  virtual ~bounded_int_configlet();

  virtual void current_value(int new_current);

  int minimum() const { return _minimum; }
  int maximum() const { return _maximum; }
  
  void minimum(int new_min) { _minimum = new_min; }
  void maximum(int new_max) { _maximum = new_max; }

  configlet *duplicate() const;

private:
  int _minimum;
  int _maximum;
};

#endif

---