common/style.c

   1 /***********************************************************************
   2  Freeciv - Copyright (C) 2005 - The Freeciv Project
   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 /* utility */
  19 #include "mem.h"
  20
  21 /* common */
  22 #include "fc_types.h"
  23 #include "game.h"
  24 #include "name_translation.h"
  25
  26
  27 #include "style.h"
  28
  29 static struct nation_style *styles = NULL;
  30
  31 static struct music_style *music_styles = NULL;
  32
  33 /****************************************************************************
  34   Initialise styles structures.
  35 ****************************************************************************/
  36 void styles_alloc(int count)
  37 {
  38   int i;
  39
  40   styles = fc_malloc(count * sizeof(struct nation_style));
  41
  42   for (i = 0; i < count; i++) {
  43     styles[i].id = i;
  44     styles[i].disabled = FALSE;
  45   }
  46 }
  47
  48 /****************************************************************************
  49   Free the memory associated with styles
  50 ****************************************************************************/
  51 void styles_free(void)
  52 {
  53   FC_FREE(styles);
  54   styles = NULL;
  55 }
  56
  57 /**************************************************************************
  58   Return the number of styles.
  59 **************************************************************************/
  60 int style_count(void)
  61 {
  62   return game.control.num_styles;
  63 }
  64
  65 /**************************************************************************
  66   Return the style id.
  67 **************************************************************************/
  68 int style_number(const struct nation_style *pstyle)
  69 {
  70   fc_assert_ret_val(NULL != pstyle, -1);
  71
  72   return pstyle->id;
  73 }
  74
  75 /**************************************************************************
  76   Return the style index.
  77 **************************************************************************/
  78 int style_index(const struct nation_style *pstyle)
  79 {
  80   fc_assert_ret_val(NULL != pstyle, -1);
  81
  82   return pstyle - styles;
  83 }
  84
  85 /****************************************************************************
  86   Return style of given id.
  87 ****************************************************************************/
  88 struct nation_style *style_by_number(int id)
  89 {
  90   fc_assert_ret_val(id >= 0 && id < game.control.num_styles, NULL);
  91
  92   return &styles[id];
  93 }
  94
  95 /**************************************************************************
  96   Return the (translated) name of the style.
  97   You don't have to free the return pointer.
  98 **************************************************************************/
  99 const char *style_name_translation(const struct nation_style *pstyle)
 100 {
 101   return name_translation_get(&pstyle->name);
 102 }
 103
 104 /**************************************************************************
 105   Return the (untranslated) rule name of the style.
 106   You don't have to free the return pointer.
 107 **************************************************************************/
 108 const char *style_rule_name(const struct nation_style *pstyle)
 109 {
 110   return rule_name_get(&pstyle->name);
 111 }
 112
 113 /**************************************************************************
 114   Returns style matching rule name or NULL if there is no style
 115   with such name.
 116 **************************************************************************/
 117 struct nation_style *style_by_rule_name(const char *name)
 118 {
 119   const char *qs = Qn_(name);
 120
 121   styles_iterate(pstyle) {
 122     if (!fc_strcasecmp(style_rule_name(pstyle), qs)) {
 123       return pstyle;
 124     }
 125   } styles_iterate_end;
 126
 127   return NULL;
 128 }
 129
 130 /****************************************************************************
 131   Initialise music styles structures.
 132 ****************************************************************************/
 133 void music_styles_alloc(int count)
 134 {
 135   int i;
 136
 137   music_styles = fc_malloc(count * sizeof(struct music_style));
 138
 139   for (i = 0; i < count; i++) {
 140     music_styles[i].id = i;
 141     requirement_vector_init(&(music_styles[i].reqs));
 142   }
 143 }
 144
 145 /****************************************************************************
 146   Free the memory associated with music styles
 147 ****************************************************************************/
 148 void music_styles_free(void)
 149 {
 150   music_styles_iterate(pmus) {
 151     requirement_vector_free(&(pmus->reqs));
 152   } music_styles_iterate_end;
 153
 154   FC_FREE(music_styles);
 155   music_styles = NULL;
 156 }
 157
 158 /**************************************************************************
 159   Return the music style id.
 160 **************************************************************************/
 161 int music_style_number(const struct music_style *pms)
 162 {
 163   fc_assert_ret_val(NULL != pms, -1);
 164
 165   return pms->id;
 166 }
 167
 168 /****************************************************************************
 169   Return music style of given id.
 170 ****************************************************************************/
 171 struct music_style *music_style_by_number(int id)
 172 {
 173   fc_assert_ret_val(id >= 0 && id < game.control.num_music_styles, NULL);
 174
 175   if (music_styles == NULL) {
 176     return NULL;
 177   }
 178
 179   return &music_styles[id];
 180 }
 181
 182 /****************************************************************************
 183   Return music style for player
 184 ****************************************************************************/
 185 struct music_style *player_music_style(struct player *plr)
 186 {
 187   struct music_style *best = NULL;
 188
 189   music_styles_iterate(pms) {
 190     if (are_reqs_active(plr, NULL, NULL, NULL, NULL,
 191                         NULL, NULL, NULL, NULL, NULL, &pms->reqs,
 192                         RPT_CERTAIN)) {
 193       best = pms;
 194     }
 195   } music_styles_iterate_end;
 196
 197   return best;
 198 }
 199
 200 /**************************************************************************
 201   Evaluate which style should be used to draw a city.
 202 **************************************************************************/
 203 int style_of_city(const struct city *pcity)
 204 {
 205   return pcity->style;
 206 }
 207
 208 /**************************************************************************
 209   Return basic city style representing nation style.
 210 **************************************************************************/
 211 int basic_city_style_for_style(struct nation_style *pstyle)
 212 {
 213   enum fc_tristate style_style;
 214   int i;
 215
 216   for (i = game.control.styles_count - 1; i >= 0; i--) {
 217     style_style = TRI_MAYBE;
 218
 219     requirement_vector_iterate(&city_styles[i].reqs, preq) {
 220       if (preq->source.kind == VUT_STYLE
 221           && preq->source.value.style == pstyle
 222           && style_style != TRI_NO) {
 223         style_style = TRI_YES;
 224       } else {
 225         /* No any other requirements allowed at the moment.
 226          * TODO: Allow some other reqs */
 227         style_style = TRI_NO;
 228         break;
 229       }
 230     } requirement_vector_iterate_end;
 231
 232     if (style_style == TRI_YES) {
 233       break;
 234     }
 235   }
 236
 237   if (style_style == TRI_YES) {
 238     return i;
 239   }
 240
 241   return -1;
 242 }
 243
 244 /**************************************************************************
 245   Return citystyle of the city.
 246 **************************************************************************/
 247 int city_style(struct city *pcity)
 248 {
 249   int i;
 250   struct player *plr = city_owner(pcity);
 251
 252   for (i = game.control.styles_count - 1; i >= 0; i--) {
 253     if (are_reqs_active(plr, NULL, pcity, NULL, city_tile(pcity),
 254                         NULL, NULL, NULL, NULL, NULL,
 255                         &city_styles[i].reqs, RPT_CERTAIN)) {
 256       return i;
 257     }
 258   }
 259
 260   return 0;
 261 }