common/government.h

   1 /**********************************************************************
   2  Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
   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 #ifndef FC__GOVERNMENT_H
  14 #define FC__GOVERNMENT_H
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif /* __cplusplus */
  19
  20 /* utility */
  21 #include "shared.h"
  22
  23 /* common */
  24 #include "fc_types.h"
  25 #include "name_translation.h"
  26 #include "requirements.h"
  27
  28
  29 struct strvec;          /* Actually defined in "utility/string_vector.h". */
  30
  31 struct ruler_title;     /* Opaque type. */
  32
  33 /* 'struct ruler_title_hash' and related functions. */
  34 #define SPECHASH_TAG ruler_title
  35 #define SPECHASH_IKEY_TYPE struct nation_type *
  36 #define SPECHASH_IDATA_TYPE struct ruler_title *
  37 #include "spechash.h"
  38 #define ruler_titles_iterate(ARG_hash, NAME_rule_title)                     \
  39   TYPED_HASH_DATA_ITERATE(const struct ruler_title *, ARG_hash,             \
  40                           NAME_rule_title)
  41 #define ruler_titles_iterate_end HASH_DATA_ITERATE_END
  42
  43 /* G_LAST is a value guaranteed to be larger than any valid
  44  * Government_type_id. It defines the maximum number of governments
  45  * (so can also be used to size static arrays indexed by governments);
  46  * it is sometimes used as a sentinel value (but not in the network
  47  * protocol, which generally uses government_count()). */
  48 #define G_LAST (127)
  49
  50 /* This is struct government itself.  All information about a form of
  51  * government is contained inhere. -- SKi */
  52 struct government {
  53   Government_type_id item_number;
  54   struct name_translation name;
  55   char graphic_str[MAX_LEN_NAME];
  56   char graphic_alt[MAX_LEN_NAME];
  57   struct requirement_vector reqs;
  58   struct ruler_title_hash *ruler_titles;
  59   int changed_to_times;
  60   struct strvec *helptext;
  61
  62   /* AI cached data for this government. */
  63   struct {
  64     struct government *better; /* hint: a better government (or NULL) */
  65   } ai;
  66 };
  67
  68
  69 /* General government accessor functions. */
  70 Government_type_id government_count(void);
  71 Government_type_id government_index(const struct government *pgovern);
  72 Government_type_id government_number(const struct government *pgovern);
  73
  74 struct government *government_by_number(const Government_type_id gov);
  75 struct government *government_of_player(const struct player *pplayer);
  76 struct government *government_of_city(const struct city *pcity);
  77
  78 struct government *government_by_rule_name(const char *name);
  79 struct government *government_by_translated_name(const char *name);
  80
  81 const char *government_rule_name(const struct government *pgovern);
  82 const char *government_name_translation(const struct government *pgovern);
  83 const char *government_name_for_player(const struct player *pplayer);
  84
  85 /* Ruler titles. */
  86 const struct ruler_title_hash *
  87 government_ruler_titles(const struct government *pgovern);
  88 struct ruler_title *
  89 government_ruler_title_new(struct government *pgovern,
  90                            const struct nation_type *pnation,
  91                            const char *ruler_male_title,
  92                            const char *ruler_female_title);
  93
  94 const struct nation_type *
  95 ruler_title_nation(const struct ruler_title *pruler_title);
  96 const char *
  97 ruler_title_male_untranslated_name(const struct ruler_title *pruler_title);
  98 const char *
  99 ruler_title_female_untranslated_name(const struct ruler_title *pruler_title);
 100
 101 const char *ruler_title_for_player(const struct player *pplayer,
 102                                    char *buf, size_t buf_len);
 103
 104 /* Ancillary routines */
 105 bool can_change_to_government(struct player *pplayer,
 106                               const struct government *pgovern);
 107
 108 /* Initialization and iteration */
 109 void governments_alloc(int num);
 110 void governments_free(void);
 111
 112 struct government_iter;
 113 size_t government_iter_sizeof(void);
 114 struct iterator *government_iter_init(struct government_iter *it);
 115
 116 /* Iterate over government types. */
 117 #define governments_iterate(NAME_pgov)                                      \
 118   generic_iterate(struct government_iter, struct government *,              \
 119                   NAME_pgov, government_iter_sizeof, government_iter_init)
 120 #define governments_iterate_end generic_iterate_end
 121
 122 #ifdef __cplusplus
 123 }
 124 #endif /* __cplusplus */
 125
 126 bool untargeted_revolution_allowed(void);
 127
 128 #endif  /* FC__GOVERNMENT_H */