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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "core/string_consumer.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)
{
  this->groups.remove_if([&name](const IniGroup &group) { return group.name.starts_with(name); });
}

void IniLoadFile::LoadFromDisk(std::string_view 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);
 
  size_t line = 0;
  /* for each line in the file */
  while (static_cast<size_t>(ftell(*in)) < end && fgets(buffer, sizeof(buffer), *in)) {
    ++line;
    StringConsumer consumer{StrTrimView(buffer, StringConsumer::WHITESPACE_OR_NEWLINE)};
 
    /* Skip comments and empty lines outside IGT_SEQUENCE groups. */
    if ((group == nullptr || group->type != IGT_SEQUENCE) && (!consumer.AnyBytesLeft() || consumer.PeekCharIfIn("#;"))) {
      comment += consumer.GetOrigData();
      comment += "\n";
      continue;
    }
 
    /* it's a group? */
    if (consumer.ReadCharIf('[')) {
      std::string_view group_name = consumer.ReadUntilChar(']', StringConsumer::KEEP_SEPARATOR);
      if (!consumer.ReadCharIf(']') || consumer.AnyBytesLeft()) {
        this->ReportFileError(fmt::format("ini [{}]: invalid group name '{}'", line, consumer.GetOrigData()));
      }
      group = &this->CreateGroup(group_name);
      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(consumer.GetOrigData());
        item.comment = std::move(comment);
        comment.clear(); // std::move leaves comment in a "valid but unspecified state" according to the specification.
        continue;
      }
 
      static const std::string_view key_parameter_separators = "=\t ";
      std::string_view key;
      /* find end of keyname */
      if (consumer.ReadCharIf('\"')) {
        key = consumer.ReadUntilChar('\"', StringConsumer::SKIP_ONE_SEPARATOR);
      } else {
        key = consumer.ReadUntilCharIn(key_parameter_separators);
      }
 
      /* it's an item in an existing group */
      IniItem &item = group->CreateItem(key);
      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 */
      consumer.SkipUntilCharNotIn(key_parameter_separators);
 
      if (consumer.ReadCharIf('\"')) {
        /* There is no escaping in our loader, so we just remove the first and last quote. */
        std::string_view value = consumer.GetLeftData();
        if (value.ends_with("\"")) value.remove_suffix(1);
        item.value = StrMakeValid(value);
      } else if (!consumer.AnyBytesLeft()) {
        /* If the value was not quoted and empty, it must be nullptr */
        item.value.reset();
      } else {
        item.value = StrMakeValid(consumer.GetLeftData());
      }
    } else {
      /* it's an orphan item */
      this->ReportFileError(fmt::format("ini [{}]: '{}' is outside of group", line, consumer.GetOrigData()));
    }
  }
 
  this->comment = std::move(comment);
}