section_file.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   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, or (at your option)
   any later version.
 
   This program 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.
***********************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
#include <stdarg.h>
 
/* utility */
#include "mem.h"
#include "registry.h"
 
#include "section_file.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(void)
{
  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 (psection != nullptr ? psection->name : nullptr);
}
 
/**********************************************************************/
struct section_file *secfile_new(bool allow_duplicates)
{
  struct section_file *secfile = fc_malloc(sizeof(struct 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 = section_hash_new();
  /* Maybe allocated later. */
  secfile->hash.entries = nullptr;
 
  return secfile;
}
 
/**********************************************************************/
void secfile_destroy(struct section_file *secfile)
{
  SECFILE_RETURN_IF_FAIL(secfile, nullptr, secfile != nullptr);
 
  section_hash_destroy(secfile->hash.sections);
  /* Mark it nullptr to be sure to don't try to make operations when
   * deleting the entries. */
  secfile->hash.sections = nullptr;
  if (secfile->hash.entries != nullptr) {
    entry_hash_destroy(secfile->hash.entries);
    /* Mark it nullptr to be sure to don't try to make operations when
     * deleting the entries. */
    secfile->hash.entries = nullptr;
  }
 
  section_list_destroy(secfile->sections);
 
  if (secfile->name != nullptr) {
    free(secfile->name);
  }
 
  free(secfile);
}
 
/**********************************************************************/
void secfile_allow_digital_boolean(struct section_file *secfile,
                                   bool allow_digital_boolean)
{
  secfile->allow_digital_boolean = allow_digital_boolean;
}
 
/**********************************************************************/
bool entry_from_token(struct section *psection, const char *name,
                      const char *tok)
{
  if ('*' == tok[0]) {
    char buf[strlen(tok) + 1];
 
    remove_escapes(tok + 1, FALSE, buf, sizeof(buf));
    (void) section_entry_str_new(psection, name, buf, FALSE);
    DEBUG_ENTRIES("entry %s '%s'", name, buf);
    return TRUE;
  }
 
  if ('$' == tok[0] || '"' == tok[0]) {
    char buf[strlen(tok) + 1];
    bool escaped = ('"' == tok[0]);
 
    remove_escapes(tok + 1, escaped, buf, sizeof(buf));
    (void) section_entry_str_new(psection, name, buf, escaped);
    DEBUG_ENTRIES("entry %s '%s'", name, buf);
    return TRUE;
  }
 
  if (fc_isdigit(tok[0]) || (('-' == tok[0] || '+' == tok[0]) && fc_isdigit(tok[1]))) {
    float fvalue;
 
    if (str_to_float(tok, &fvalue)) {
      (void) section_entry_float_new(psection, name, fvalue);
      DEBUG_ENTRIES("entry %s %d", name, fvalue);
 
      return TRUE;
    } else {
      int ivalue;
 
      if (str_to_int(tok, &ivalue)) {
        (void) section_entry_int_new(psection, name, ivalue);
        DEBUG_ENTRIES("entry %s %d", name, ivalue);
 
        return TRUE;
      }
    }
  }
 
  if (0 == fc_strncasecmp(tok, "FALSE", 5)
      || 0 == fc_strncasecmp(tok, "TRUE", 4)) {
    bool value = (0 == fc_strncasecmp(tok, "TRUE", 4));
 
    (void) section_entry_bool_new(psection, name, value);
    DEBUG_ENTRIES("entry %s %s", name, value ? "TRUE" : "FALSE");
    return TRUE;
  }
 
  return FALSE;
}