common/multipliers.c

   1 /***********************************************************************
   2  Freeciv - Copyright (C) 2014 Lach Sławomir
   3    This program is free software; you can redistribute it and/or modify
   4    it under the terms of the GNU General Public License as published by
   5    the Free Software Foundation; either version 2, or (at your option)
   6    any later version.
   7
   8    This program is distributed in the hope that it will be useful,
   9    but WITHOUT ANY WARRANTY; without even the implied warranty of
  10    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11    GNU General Public License for more details.
  12 ***********************************************************************/
  13
  14 #ifdef HAVE_CONFIG_H
  15 #include <fc_config.h>
  16 #endif
  17
  18 /* common */
  19 #include "game.h"
  20
  21 #include "multipliers.h"
  22
  23 static struct multiplier multipliers[MAX_NUM_MULTIPLIERS];
  24
  25 /****************************************************************************
  26   Initialize all multipliers
  27 ****************************************************************************/
  28 void multipliers_init(void)
  29 {
  30   int i;
  31
  32   for (i = 0; i < ARRAY_SIZE(multipliers); i++) {
  33     name_init(&multipliers[i].name);
  34     multipliers[i].helptext = NULL;
  35   }
  36 }
  37
  38 /****************************************************************************
  39   Free all multipliers
  40 ****************************************************************************/
  41 void multipliers_free(void)
  42 {
  43   multipliers_iterate(pmul) {
  44     if (pmul->helptext) {
  45       strvec_destroy(pmul->helptext);
  46       pmul->helptext = NULL;
  47     }
  48   } multipliers_iterate_end;
  49 }
  50
  51 /****************************************************************************
  52   Returns multiplier associated to given number
  53 ****************************************************************************/
  54 struct multiplier *multiplier_by_number(Multiplier_type_id id)
  55 {
  56   fc_assert_ret_val(id >= 0 && id < game.control.num_multipliers, NULL);
  57
  58   return &multipliers[id];
  59 }
  60
  61 /****************************************************************************
  62   Returns multiplier number.
  63 ****************************************************************************/
  64 Multiplier_type_id multiplier_number(const struct multiplier *pmul)
  65 {
  66   fc_assert_ret_val(NULL != pmul, -1);
  67
  68   return pmul - multipliers;
  69 }
  70
  71 /****************************************************************************
  72   Returns multiplier index.
  73
  74   Currently same as multiplier_number(), paired with multiplier_count()
  75   indicates use as an array index.
  76 ****************************************************************************/
  77 Multiplier_type_id multiplier_index(const struct multiplier *pmul)
  78 {
  79   return multiplier_number(pmul);
  80 }
  81
  82 /****************************************************************************
  83   Return number of loaded multipliers in the ruleset.
  84 ****************************************************************************/
  85 Multiplier_type_id multiplier_count(void)
  86 {
  87   return game.control.num_multipliers;
  88 }
  89
  90 /**************************************************************************
  91   Return the (translated) name of the multiplier.
  92   You don't have to free the return pointer.
  93 **************************************************************************/
  94 const char *multiplier_name_translation(const struct multiplier *pmul)
  95 {
  96   return name_translation_get(&pmul->name);
  97 }
  98
  99 /**************************************************************************
 100   Return the (untranslated) rule name of the multiplier.
 101   You don't have to free the return pointer.
 102 **************************************************************************/
 103 const char *multiplier_rule_name(const struct multiplier *pmul)
 104 {
 105   return rule_name_get(&pmul->name);
 106 }
 107
 108 /**************************************************************************
 109   Returns multiplier matching rule name, or NULL if there is no multiplier
 110   with such a name.
 111 **************************************************************************/
 112 struct multiplier *multiplier_by_rule_name(const char *name)
 113 {
 114   const char *qs;
 115
 116   if (name == NULL) {
 117     return NULL;
 118   }
 119
 120   qs = Qn_(name);
 121
 122   multipliers_iterate(pmul) {
 123     if (!fc_strcasecmp(multiplier_rule_name(pmul), qs)) {
 124       return pmul;
 125     }
 126   } multipliers_iterate_end;
 127
 128   return NULL;
 129 }