section_file.cpp

Go to the documentation of this file.

/*__            ___                 ***************************************
/   \          /   \          Copyright (c) 1996-2020 Freeciv21 and Freeciv
\_   \        /  __/          contributors. This file is part of Freeciv21.
 _\   \      /  /__     Freeciv21 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 3 of the  License,
       |                              or (at your option) any later version.
     _/     /\                  You should have received  a copy of the GNU
    /o)  (o/\ \_                General Public License along with Freeciv21.
    \_____/ /                     If not, see https://www.gnu.org/licenses/.
      \____/        ********************************************************/
// utility
#include "registry.h"
 
#include "section_file.h"
 
#include <QMultiHash>
 
#include "log.h"
 
#define MAX_LEN_ERRORBUF 1024
 
static char error_buffer[MAX_LEN_ERRORBUF] = "\0";
 
// Debug function for every new entry.
#define DEBUG_ENTRIES(...) // log_debug(__VA_ARGS__);
 
const char *secfile_error() { return error_buffer; }
 
void secfile_log(const struct section_file *secfile,
                 const struct section *psection, const char *file,
                 const char *function, int line, const char *format, ...)
{
  char message[MAX_LEN_ERRORBUF];
  va_list args;
 
  va_start(args, format);
  fc_vsnprintf(message, sizeof(message), format, args);
  va_end(args);
 
  fc_snprintf(error_buffer, sizeof(error_buffer),
              "In %s() [%s:%d]: secfile '%s' in section '%s': %s", function,
              file, line, secfile_name(secfile),
              psection != nullptr ? section_name(psection) : "nullptr",
              message);
}
 
const char *section_name(const struct section *psection)
{
  return (nullptr != psection ? psection->name : nullptr);
}
 
struct section_file *secfile_new(bool allow_duplicates)
{
  section_file *secfile = new section_file;
 
  secfile->name = nullptr;
  secfile->num_entries = 0;
  secfile->num_includes = 0;
  secfile->num_long_comments = 0;
  secfile->sections = section_list_new_full(section_destroy);
  secfile->allow_duplicates = allow_duplicates;
  secfile->allow_digital_boolean = false; // Default
 
  secfile->hash.sections = new QMultiHash<QString, struct section *>;
  // Maybe allocated later.
  secfile->hash.entries = nullptr;
 
  return secfile;
}
 
void secfile_destroy(struct section_file *secfile)
{
  SECFILE_RETURN_IF_FAIL(secfile, nullptr, secfile != nullptr);
 
  delete secfile->hash.sections;
  /* Mark it nullptr to be sure to don't try to make operations when
   * deleting the entries. */
  secfile->hash.sections = nullptr;
  delete secfile->hash.entries;
  secfile->hash.entries = nullptr;
  section_list_destroy(secfile->sections);
  delete[] secfile->name;
  secfile->name = nullptr;
  delete secfile;
  secfile = nullptr;
}
 
void secfile_allow_digital_boolean(struct section_file *secfile,
                                   bool allow_digital_boolean)
{
  fc_assert_ret(nullptr != secfile);
  secfile->allow_digital_boolean = allow_digital_boolean;
}
 
bool entry_from_token(struct section *psection, const QString &name,
                      const QString &tok)
{
  if ('*' == tok[0]) {
    auto buf = remove_escapes(tok.mid(1), false);
    (void) section_entry_str_new(psection, name, buf, false);
    DEBUG_ENTRIES("entry %s '%s'", name, qUtf8Printable(buf));
    return true;
  }
 
  if ('$' == tok[0] || '"' == tok[0]) {
    bool escaped = ('"' == tok[0]);
    auto buf = remove_escapes(tok.mid(1), escaped);
    (void) section_entry_str_new(psection, name, buf, escaped);
    DEBUG_ENTRIES("entry %s '%s'", name, qUtf8Printable(buf));
    return true;
  }
 
  if (tok[0].isDigit()
      || (('-' == tok[0] || '+' == tok[0]) && tok[1].isDigit())) {
    if (tok.contains('.')) {
      bool ok;
      auto fvalue = tok.toFloat(&ok);
      if (ok) {
        (void) section_entry_float_new(psection, name, fvalue);
        DEBUG_ENTRIES("entry %s %d", name, fvalue);
        return true;
      }
    } else {
      bool ok;
      auto ivalue = tok.toInt(&ok, 0);
      if (ok) {
        (void) section_entry_int_new(psection, name, ivalue);
        DEBUG_ENTRIES("entry %s %d", name, ivalue);
 
        return true;
      }
    }
    return false;
  }
 
  if (tok.compare(QStringLiteral("FALSE"), Qt::CaseInsensitive) == 0
      || tok.compare(QStringLiteral("TRUE"), Qt::CaseInsensitive) == 0) {
    bool value =
        (tok.compare(QStringLiteral("TRUE"), Qt::CaseInsensitive) == 0);
 
    (void) section_entry_bool_new(psection, name, value);
    DEBUG_ENTRIES("entry %s %s", name, value ? "TRUE" : "FALSE");
    return true;
  }
 
  return false;
}