Freeciv-3.3
Loading...
Searching...
No Matches
government.h
Go to the documentation of this file.
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
17extern "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
29struct strvec; /* Actually defined in "utility/string_vector.h". */
30
31struct 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 */
52struct government {
66
67 /* AI cached data for this government. */
68 struct {
69 struct government *better; /* hint: a better government (or NULL) */
70 } ai;
71};
72
73
74/* General government accessor functions. */
78
80struct government *government_of_player(const struct player *pplayer);
81struct government *government_of_city(const struct city *pcity);
82
83struct government *government_by_rule_name(const char *name);
85
86const char *government_rule_name(const struct government *pgovern);
87const char *government_name_translation(const struct government *pgovern);
88const char *government_name_for_player(const struct player *pplayer);
89
90/* Ruler titles. */
91const struct ruler_title_hash *
93struct ruler_title *
95 const struct nation_type *pnation,
96 const char *ruler_male_title,
97 const char *ruler_female_title);
98
99const struct nation_type *
101const char *
103const char *
105
106const char *ruler_title_for_player(const struct player *pplayer,
107 char *buf, size_t buf_len);
108const char *default_title_for_player(const struct player *pplayer,
109 char *buf, size_t buf_len);
110
111/* Ancillary routines */
112bool can_change_to_government(struct player *pplayer,
113 const struct government *pgovern);
114
115/* Initialization and iteration */
116void governments_alloc(int num);
117void governments_free(void);
118
119struct government_iter;
120size_t government_iter_sizeof(void);
122
123/* Iterate over government types. */
124#define governments_iterate(NAME_pgov) \
125 generic_iterate(struct government_iter, struct government *, \
126 NAME_pgov, government_iter_sizeof, government_iter_init)
127#define governments_iterate_end generic_iterate_end
128
129#define governments_re_active_iterate(_p) \
130 governments_iterate(_p) { \
131 if (!_p->ruledit_disabled) {
132
133#define governments_re_active_iterate_end \
134 } \
135 } governments_iterate_end;
136
138
139#ifdef __cplusplus
140}
141#endif /* __cplusplus */
142
143#endif /* FC__GOVERNMENT_H */
char * incite_cost
Definition comments.c:76
struct unit struct city struct unit struct tile struct extra_type const struct act_prob *act_probs int actor_unit_id struct unit struct unit int const struct action *paction struct unit struct city * pcity
Definition dialogs_g.h:78
int Government_type_id
Definition fc_types.h:240
#define MAX_LEN_NAME
Definition fc_types.h:66
const char * government_name_translation(const struct government *pgovern)
Definition government.c:143
const char * default_title_for_player(const struct player *pplayer, char *buf, size_t buf_len)
Definition government.c:426
void governments_free(void)
Definition government.c:545
const struct nation_type * ruler_title_nation(const struct ruler_title *pruler_title)
Definition government.c:365
bool untargeted_revolution_allowed(void)
Definition government.c:566
struct ruler_title * government_ruler_title_new(struct government *pgovern, const struct nation_type *pnation, const char *ruler_male_title, const char *ruler_female_title)
Definition government.c:325
const char * ruler_title_for_player(const struct player *pplayer, char *buf, size_t buf_len)
Definition government.c:391
struct iterator * government_iter_init(struct government_iter *it)
Definition government.c:483
const char * ruler_title_female_untranslated_name(const struct ruler_title *pruler_title)
Definition government.c:383
Government_type_id government_count(void)
Definition government.c:71
struct government * government_by_number(const Government_type_id gov)
Definition government.c:103
struct government * government_of_player(const struct player *pplayer)
Definition government.c:114
const char * government_name_for_player(const struct player *pplayer)
Definition government.c:154
const char * ruler_title_male_untranslated_name(const struct ruler_title *pruler_title)
Definition government.c:374
struct government * government_of_city(const struct city *pcity)
Definition government.c:123
void governments_alloc(int num)
Definition government.c:529
Government_type_id government_number(const struct government *pgovern)
Definition government.c:91
const struct ruler_title_hash * government_ruler_titles(const struct government *pgovern)
Definition government.c:314
Government_type_id government_index(const struct government *pgovern)
Definition government.c:82
size_t government_iter_sizeof(void)
Definition government.c:450
const char * government_rule_name(const struct government *pgovern)
Definition government.c:133
struct government * government_by_translated_name(const char *name)
Definition government.c:40
bool can_change_to_government(struct player *pplayer, const struct government *pgovern)
Definition government.c:166
struct government * government_by_rule_name(const char *name)
Definition government.c:55
const char * name
Definition inputfile.c:127
Definition city.h:317
struct strvec * helptext
Definition government.h:65
struct requirement_vector reqs
Definition government.h:62
void * ruledit_dlg
Definition government.h:56
char graphic_alt[MAX_LEN_NAME]
Definition government.h:58
bool ruledit_disabled
Definition government.h:55
struct government * better
Definition government.h:69
Government_type_id item_number
Definition government.h:53
int changed_to_times
Definition government.h:64
char sound_alt2[MAX_LEN_NAME]
Definition government.h:61
struct government::@43 ai
struct name_translation name
Definition government.h:54
char sound_str[MAX_LEN_NAME]
Definition government.h:59
char graphic_str[MAX_LEN_NAME]
Definition government.h:57
struct ruler_title_hash * ruler_titles
Definition government.h:63
char sound_alt[MAX_LEN_NAME]
Definition government.h:60
const struct nation_type * pnation
Definition government.c:189