ini_configurator.h

Go to the documentation of this file.

#ifndef INI_CONFIGURATOR_CLASS
#define INI_CONFIGURATOR_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : ini_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 "configurator.h"
#if defined(__UNIX__) || defined(__GNU_WINDOWS__)
  #include "ini_parser.h"
  #include <basis/utf_conversion.h>
#endif
 
#include <basis/contracts.h>
#include <filesystem/byte_filer.h>
#include <filesystem/filename.h>
 
namespace configuration {
 
 
class ini_configurator : public configurator
{
public:
 
  enum file_location_default {
    APPLICATION_DIRECTORY,  
    OS_DIRECTORY,  
    ALL_USERS_DIRECTORY  
  };
 
  ini_configurator(const basis::astring &ini_filename,
          treatment_of_defaults behavior = RETURN_ONLY,
          file_location_default where = ALL_USERS_DIRECTORY);
 
  virtual ~ini_configurator();
 
  DEFINE_CLASS_NAME("ini_configurator");
 
  void refresh();
 
//hmmm: where are:
//  save_to_file()
//  is_modified()
//?
 
  basis::astring name() const;
  void name(const basis::astring &name);
 
  virtual bool get(const basis::astring &section, const basis::astring &entry,
          basis::astring &found);
 
  virtual void sections(structures::string_array &list);
 
  virtual bool section_exists(const basis::astring &section);
 
  virtual bool put(const basis::astring &section, const basis::astring &entry,
          const basis::astring &to_store);
 
  virtual bool delete_section(const basis::astring &section);
 
  virtual bool delete_entry(const basis::astring &section, const basis::astring &entry);
 
  virtual bool get_section(const basis::astring &section, structures::string_table &info);
 
  virtual bool put_section(const basis::astring &section, const structures::string_table &info);
 
  // dictates whether the stored entries will have spaces between '='
  // and the key name and value.  only applicable on linux.
  bool add_spaces() const { return _add_spaces; }
  void add_spaces(bool add_them) { _add_spaces = add_them; }
 
private:
  filesystem::filename *_ini_name;  
#if defined(__UNIX__) || defined(__GNU_WINDOWS__)
  ini_parser *_parser;  
#endif
  file_location_default _where;  
  bool _add_spaces;  
 
/*
#ifdef _MSC_VER
  bool put_profile_string(const basis::astring &section, const basis::astring &entry,
          const basis::astring &to_store);
  void get_profile_string(const basis::astring &section, const basis::astring &entry,
          const basis::astring &default_value, basis::flexichar *return_buffer,
          int buffer_size);
#else
*/
  void read_ini_file();
  void write_ini_file();
//#endif
 
  // not to be called.
  ini_configurator(const ini_configurator &);
  ini_configurator &operator =(const ini_configurator &);
 
  static const basis::astring &ini_str_fake_default();
};
 
} //namespace.
 
#endif