ini_load.cpp

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/>.
 */
 
#include "stdafx.h"
#include "core/mem_func.hpp"
#include "ini_type.h"
#include "string_func.h"
 
#include "safeguards.h"
 
IniItem::IniItem(std::string_view name)
{
  this->name = StrMakeValid(name);
}
 
void IniItem::SetValue(std::string_view value)
{
  this->value.emplace(value);
}
 
IniGroup::IniGroup(std::string_view name, IniGroupType type) : type(type), comment("\n")
{
  this->name = StrMakeValid(name);
}
 
const IniItem *IniGroup::GetItem(std::string_view name) const
{
  for (const IniItem &item : this->items) {
    if (item.name == name) return &item;
  }
 
  return nullptr;
}
 
IniItem &IniGroup::GetOrCreateItem(std::string_view name)
{
  for (IniItem &item : this->items) {
    if (item.name == name) return item;
  }
 
  /* Item doesn't exist, make a new one. */
  return this->CreateItem(name);
}
 
IniItem &IniGroup::CreateItem(std::string_view name)
{
  return this->items.emplace_back(name);
}
 
void IniGroup::RemoveItem(std::string_view name)
{
  this->items.remove_if([&name](const IniItem &item) { return item.name == name; });
}
 
void IniGroup::Clear()
{
  this->items.clear();
}
 
IniLoadFile::IniLoadFile(const IniGroupNameList &list_group_names, const IniGroupNameList &seq_group_names) :
    list_group_names(list_group_names),
    seq_group_names(seq_group_names)
{
}
 
const IniGroup *IniLoadFile::GetGroup(std::string_view name) const
{
  for (const IniGroup &group : this->groups) {
    if (group.name == name) return &group;
  }
 
  return nullptr;
}
 
IniGroup *IniLoadFile::GetGroup(std::string_view name)
{
  for (IniGroup &group : this->groups) {
    if (group.name == name) return &group;
  }
 
  return nullptr;
}
 
IniGroup &IniLoadFile::GetOrCreateGroup(std::string_view name)
{
  for (IniGroup &group : this->groups) {
    if (group.name == name) return group;
  }
 
  /* Group doesn't exist, make a new one. */
  return this->CreateGroup(name);
}
 
IniGroup &IniLoadFile::CreateGroup(std::string_view name)
{
  IniGroupType type = IGT_VARIABLES;
  if (std::ranges::find(this->list_group_names, name) != this->list_group_names.end()) type = IGT_LIST;
  if (std::ranges::find(this->seq_group_names, name) != this->seq_group_names.end()) type = IGT_SEQUENCE;
 
  return this->groups.emplace_back(name, type);
}
 
void IniLoadFile::RemoveGroup(std::string_view name)
{
  size_t len = name.length();
  this->groups.remove_if([&name, &len](const IniGroup &group) { return group.name.compare(0, len, name) == 0; });
}
 
void IniLoadFile::LoadFromDisk(const std::string &filename, Subdirectory subdir)
{
  assert(this->groups.empty());
 
  char buffer[1024];
  IniGroup *group = nullptr;
 
  std::string comment;
 
  size_t end;
  auto in = this->OpenFile(filename, subdir, &end);
  if (!in.has_value()) return;
 
  end += ftell(*in);
 
  /* for each line in the file */
  while (static_cast<size_t>(ftell(*in)) < end && fgets(buffer, sizeof(buffer), *in)) {
    char c, *s;
    /* trim whitespace from the left side */
    for (s = buffer; *s == ' ' || *s == '\t'; s++) {}
 
    /* trim whitespace from right side. */
    char *e = s + strlen(s);
    while (e > s && ((c = e[-1]) == '\n' || c == '\r' || c == ' ' || c == '\t')) e--;
    *e = '\0';
 
    /* Skip comments and empty lines outside IGT_SEQUENCE groups. */
    if ((group == nullptr || group->type != IGT_SEQUENCE) && (*s == '#' || *s == ';' || *s == '\0')) {
      comment += std::string_view(s, e - s);
      comment += '\n'; // comment newline
      continue;
    }
 
    /* it's a group? */
    if (s[0] == '[') {
      if (e[-1] != ']') {
        this->ReportFileError("ini: invalid group name '", buffer, "'");
      } else {
        e--;
      }
      s++; // skip [
      group = &this->CreateGroup(std::string_view(s, e - s));
      group->comment = std::move(comment);
      comment.clear(); // std::move leaves comment in a "valid but unspecified state" according to the specification.
    } else if (group != nullptr) {
      if (group->type == IGT_SEQUENCE) {
        /* A sequence group, use the line as item name without further interpretation. */
        IniItem &item = group->CreateItem(std::string_view(buffer, e - buffer));
        item.comment = std::move(comment);
        comment.clear(); // std::move leaves comment in a "valid but unspecified state" according to the specification.
        continue;
      }
      char *t;
      /* find end of keyname */
      if (*s == '\"') {
        s++;
        for (t = s; *t != '\0' && *t != '\"'; t++) {}
        if (*t == '\"') *t = ' ';
      } else {
        for (t = s; *t != '\0' && *t != '=' && *t != '\t' && *t != ' '; t++) {}
      }
 
      /* it's an item in an existing group */
      IniItem &item = group->CreateItem(std::string_view(s, t - s));
      item.comment = std::move(comment);
      comment.clear(); // std::move leaves comment in a "valid but unspecified state" according to the specification.
 
      /* find start of parameter */
      while (*t == '=' || *t == ' ' || *t == '\t') t++;
 
      bool quoted = (*t == '\"');
      /* remove starting quotation marks */
      if (*t == '\"') t++;
      /* remove ending quotation marks */
      e = t + strlen(t);
      if (e > t && e[-1] == '\"') e--;
      *e = '\0';
 
      /* If the value was not quoted and empty, it must be nullptr */
      if (!quoted && e == t) {
        item.value.reset();
      } else {
        item.value = StrMakeValid(std::string_view(t));
      }
    } else {
      /* it's an orphan item */
      this->ReportFileError("ini: '", buffer, "' outside of group");
    }
  }
 
  this->comment = std::move(comment);
}