server_settings.c

Go to the documentation of this file.

/***********************************************************************
 Freeciv - Copyright (C) 2017 - Freeciv Development Team
   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
 
/* utility */
#include "astring.h"
 
/* common */
#include "fc_interface.h"
 
#include "server_settings.h"
 
/***********************************************************************/
server_setting_id server_setting_by_name(const char *name)
{
  fc_assert_ret_val(fc_funcs, SERVER_SETTING_NONE);
  fc_assert_ret_val(fc_funcs->server_setting_by_name, SERVER_SETTING_NONE);
 
  return fc_funcs->server_setting_by_name(name);
}
 
/***********************************************************************/
const char *server_setting_name_get(server_setting_id id)
{
  fc_assert_ret_val(fc_funcs, NULL);
  fc_assert_ret_val(fc_funcs->server_setting_name_get, NULL);
 
  return fc_funcs->server_setting_name_get(id);
}
 
/***********************************************************************/
enum sset_type server_setting_type_get(server_setting_id id)
{
  fc_assert_ret_val(fc_funcs, sset_type_invalid());
  fc_assert_ret_val(fc_funcs->server_setting_type_get, sset_type_invalid());
 
  return fc_funcs->server_setting_type_get(id);
}
 
/***********************************************************************/
bool server_setting_exists(server_setting_id id)
{
  return sset_type_is_valid(server_setting_type_get(id));
}
 
/***********************************************************************/
bool server_setting_value_bool_get(server_setting_id id)
{
  fc_assert_ret_val(fc_funcs, FALSE);
  fc_assert_ret_val(fc_funcs->server_setting_val_bool_get, FALSE);
  fc_assert_ret_val(server_setting_type_get(id) == SST_BOOL, FALSE);
 
  return fc_funcs->server_setting_val_bool_get(id);
}
 
/***********************************************************************/
int server_setting_value_int_get(server_setting_id id)
{
  fc_assert_ret_val(fc_funcs, FALSE);
  fc_assert_ret_val(fc_funcs->server_setting_val_int_get, FALSE);
  fc_assert_ret_val(server_setting_type_get(id) == SST_INT, FALSE);
 
  return fc_funcs->server_setting_val_int_get(id);
}
 
/***********************************************************************/
unsigned int server_setting_value_bitwise_get(server_setting_id id)
{
  fc_assert_ret_val(fc_funcs, FALSE);
  fc_assert_ret_val(fc_funcs->server_setting_val_bitwise_get, FALSE);
  fc_assert_ret_val(server_setting_type_get(id) == SST_BITWISE, FALSE);
 
  return fc_funcs->server_setting_val_bitwise_get(id);
}
 
/***********************************************************************/
ssetv ssetv_from_values(server_setting_id setting, int value)
{
  /* Only Boolean and TRUE can be supported unless setting value encoding
   * is implemented. */
  if (!value) {
    fc_assert(value);
    return SSETV_NONE;
  }
 
  /* Only Boolean settings can be supported unless the setting value is
   * encoded with the setting id. */
  if (server_setting_type_get((server_setting_id)setting) != SST_BOOL) {
    fc_assert(server_setting_type_get((server_setting_id)setting)
              == SST_BOOL);
    return SSETV_NONE;
  }
 
  return (ssetv)setting;
}
 
/***********************************************************************/
server_setting_id ssetv_setting_get(ssetv enc)
{
  /* Only Boolean settings can be supported unless the setting value is
   * encoded with the setting id. */
  fc_assert(server_setting_type_get((server_setting_id)enc) == SST_BOOL);
 
  return (server_setting_id)enc;
}
 
/***********************************************************************/
int ssetv_value_get(ssetv enc)
{
  /* Only Boolean settings can be supported unless the setting value is
   * encoded with the setting id. */
  fc_assert(server_setting_type_get((server_setting_id)enc) == SST_BOOL);
 
  return TRUE;
}
 
/***********************************************************************/
ssetv ssetv_by_rule_name(const char *name)
{
  ssetv val = (ssetv)server_setting_by_name(name);
 
  /* Only Boolean settings can be supported unless the setting value is
   * encoded with the setting id. */
  if (server_setting_type_get((server_setting_id)val) != SST_BOOL) {
    return SSETV_NONE;
  }
 
  return val;
}
 
/***********************************************************************/
const char *ssetv_rule_name(ssetv val)
{
  /* Only Boolean settings can be supported unless the setting value is
   * encoded with the setting id. */
  fc_assert(server_setting_type_get((server_setting_id)val) == SST_BOOL);
 
  return server_setting_name_get((server_setting_id)val);
}
 
/***********************************************************************/
const char *ssetv_human_readable(ssetv val, bool present)
{
  static struct astring out = ASTRING_INIT;
 
  /* Only Boolean settings can be supported unless the setting value is
   * encoded with the setting id. */
  fc_assert(server_setting_type_get((server_setting_id)val) == SST_BOOL);
 
  /* TRANS: the first %s is a server setting, the second %s is it's value.
   * Example: killstack is enabled */
  astr_set(&out, _("%s is %s"),
           server_setting_name_get((server_setting_id)val),
           present ? _("enabled") : _("disabled"));
 
  return astr_str(&out);
}
 
/***********************************************************************/
bool ssetv_setting_has_value(ssetv val)
{
  /* Only boolean settings can be supported unless the setting value is
   * encoded with the setting id. */
  fc_assert_ret_val(
      server_setting_type_get((server_setting_id)val) == SST_BOOL, FALSE);
 
  return server_setting_value_bool_get((server_setting_id)val);
}