ini_config.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 "opsysdll.h"

#include <basis/object_base.h>
#ifdef __WIN32__
  #include <data_struct/configurator.h>
#else
  #include "ini_parser.h"
#endif

// forward.
class byte_filer;
class filename;

class OPSYSTEM_CLASS_STYLE ini_configurator : public configurator
{
public:

  enum file_location_default {
    APPLICATION_DIRECTORY,  
    OS_DIRECTORY,  
    ALL_USERS_DIRECTORY  
  };

  ini_configurator(const istring &ini_filename,
          treatment_of_defaults behavior = RETURN_ONLY,
          file_location_default where = ALL_USERS_DIRECTORY);

  virtual ~ini_configurator();

  IMPLEMENT_CLASS_NAME("ini_configurator");

  istring name() const;
  void name(const istring &name);

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

  virtual void sections(string_array &list);

  virtual bool section_exists(const istring &section);

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

  virtual bool delete_section(const istring &section);

  virtual bool delete_entry(const istring &section, const istring &entry);

  virtual bool get_section(const istring &section, string_table &info);

  virtual bool put_section(const istring &section, const 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:
  filename *_ini_name;  
#ifdef __UNIX__
  ini_parser *_parser;  
#endif
  file_location_default _where;  
  bool _add_spaces;  

#ifdef __WIN32__
  bool put_profile_string(const istring &section, const istring &entry,
          const istring &to_store);
  void get_profile_string(const istring &section, const istring &entry,
          const istring &default_value, flexichar *return_buffer,
          int buffer_size);
#endif
#ifdef __UNIX__
  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 istring_object &ini_str_fake_default();
};

#endif

---