ini_type.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD 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, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef INI_TYPE_H
#define INI_TYPE_H
 
#include "fileio_type.h"
 
enum IniGroupType {
  IGT_VARIABLES = 0, 
  IGT_LIST      = 1, 
  IGT_SEQUENCE  = 2, 
};
 
struct IniItem {
  std::string name;                 
  std::optional<std::string> value; 
  std::string comment;              
 
  IniItem(std::string_view name);
 
  void SetValue(std::string_view value);
};
 
struct IniGroup {
  std::list<IniItem> items; 
  IniGroupType type;   
  std::string name;    
  std::string comment; 
 
  IniGroup(std::string_view name, IniGroupType type);
 
  const IniItem *GetItem(std::string_view name) const;
  IniItem &GetOrCreateItem(std::string_view name);
  IniItem &CreateItem(std::string_view name);
  void RemoveItem(std::string_view name);
  void Clear();
};
 
struct IniLoadFile {
  using IniGroupNameList = std::initializer_list<std::string_view>;
 
  std::list<IniGroup> groups; 
  std::string comment;                  
  const IniGroupNameList list_group_names; 
  const IniGroupNameList seq_group_names;  
 
  IniLoadFile(const IniGroupNameList &list_group_names = {}, const IniGroupNameList &seq_group_names = {});
  virtual ~IniLoadFile() = default;
 
  const IniGroup *GetGroup(std::string_view name) const;
  IniGroup *GetGroup(std::string_view name);
  IniGroup &GetOrCreateGroup(std::string_view name);
  IniGroup &CreateGroup(std::string_view name);
  void RemoveGroup(std::string_view name);
 
  void LoadFromDisk(const std::string &filename, Subdirectory subdir);
 
  virtual std::optional<FileHandle> OpenFile(const std::string &filename, Subdirectory subdir, size_t *size) = 0;
 
  virtual void ReportFileError(const char * const pre, const char * const buffer, const char * const post) = 0;
};
 
struct IniFile : IniLoadFile {
  IniFile(const IniGroupNameList &list_group_names = {});
 
  bool SaveToDisk(const std::string &filename);
 
  std::optional<FileHandle> OpenFile(const std::string &filename, Subdirectory subdir, size_t *size) override;
  void ReportFileError(const char * const pre, const char * const buffer, const char * const post) override;
};
 
#endif /* INI_TYPE_H */