Freeciv-3.3: /fast/freeciv/nightly/main/client/helpdata.c Source File

Freeciv-3.3

Loading...
Searching...
No Matches
helpdata.c
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
14/***********************************************************************
15 This module is for generic handling of help data, independent
16 of gui considerations.
17***********************************************************************/
18
19#ifdef HAVE_CONFIG_H
20#include <fc_config.h>
21#endif
22
23#include <stdio.h>
24#include <string.h>
25
26/* utility */
27#include "astring.h"
28#include "bitvector.h"
29#include "fciconv.h"
30#include "fcintl.h"
31#include "log.h"
32#include "mem.h"
33#include "registry.h"
34#include "string_vector.h"
35#include "support.h"
36
37/* common */
38#include "counters.h"
39#include "effects.h"
40#include "game.h"
41#include "government.h"
42#include "map.h"
43#include "movement.h"
44#include "multipliers.h"
45#include "nation.h"
46#include "reqtext.h"
47#include "research.h"
48#include "server_settings.h"
49#include "specialist.h"
50#include "tilespec.h"
51#include "unit.h"
52#include "version.h"
53
54/* client */
55#include "client_main.h"
56#include "climisc.h"
57#include "gui_main_g.h" /* client_string */
58#include "music.h"
59
60#include "helpdata.h"
61
62/* TRANS: Character appearing in the beginning of each helptext point */
63#define BULLET Q_("?bullet:*")
64/* TRANS: bullet point with trailing space */
65#define BULLET_SPACE Q_("?bullet:* ")
66
67/* helper macro for easy conversion from snprintf and cat_snprintf */
68#define CATLSTR(_b, _s, _t, ...) cat_snprintf(_b, _s, _t, ## __VA_ARGS__)
69
70/* This must be in same order as enum in helpdlg_g.h */
71 static const char * const help_type_names[] = {
72 "(Any)", "(Text)", "Units", "Improvements", "Wonders",
73 "Techs", "Terrain", "Extras", "Goods", "Specialists", "Governments",
74 "Ruleset", "Tileset", "Musicset", "Nations", "Multipliers", "Counters", NULL
75};
76
77#define SPECLIST_TAG help
78#define SPECLIST_TYPE struct help_item
79#include "speclist.h"
80
81#define help_list_iterate(helplist, phelp) \
82 TYPED_LIST_ITERATE(struct help_item, helplist, phelp)
83#define help_list_iterate_end LIST_ITERATE_END
84
85 static const struct help_list_link *help_nodes_iterator;
86 static struct help_list *help_nodes;
87 static bool help_nodes_init = FALSE;
88/* help_nodes_init is not quite the same as booted in boot_help_texts();
89 latter can be FALSE even after call, eg if couldn't find helpdata.txt.
90*/
91
92/************************************************************************/
95 void helpdata_init(void)
96{
97 help_nodes = help_list_new();
98}
99
100/************************************************************************/
103 void helpdata_done(void)
104{
105 help_list_destroy(help_nodes);
106}
107
108/************************************************************************/
114 static void check_help_nodes_init(void)
115{
116 if (!help_nodes_init) {
117 help_nodes_init = TRUE; /* before help_iter_start to avoid recursion! */
118 help_iter_start();
119 }
120}
121
122/************************************************************************/
125 void free_help_texts(void)
126{
127 check_help_nodes_init();
128 help_list_iterate(help_nodes, ptmp) {
129 free(ptmp->topic);
130 free(ptmp->text);
131 free(ptmp);
132 } help_list_iterate_end;
133 help_list_clear(help_nodes);
134}
135
136/************************************************************************/
139 static bool show_help_for_nation(const struct nation_type *pnation)
140{
141 return client_nation_is_in_current_set(pnation);
142}
143
144/************************************************************************/
149 static bool insert_veteran_help(char *outbuf, size_t outlen,
150 const struct veteran_system *veteran,
151 const char *intro, const char *nolevels)
152{
153 /* game.veteran can be NULL in pregame; if so, keep quiet about
154 * veteran levels */
155 if (!veteran) {
156 return FALSE;
157 }
158
159 fc_assert_ret_val(veteran->levels >= 1, FALSE);
160
161 if (veteran->levels == 1) {
162 /* Only a single veteran level. Don't bother to name it. */
163 if (nolevels) {
164 CATLSTR(outbuf, outlen, "%s", nolevels);
165 return TRUE;
166 } else {
167 return FALSE;
168 }
169 } else {
170 int i;
171 fc_assert_ret_val(veteran->definitions != NULL, FALSE);
172 if (intro) {
173 CATLSTR(outbuf, outlen, "%s", intro);
174 CATLSTR(outbuf, outlen, "\n\n");
175 }
176 /* TODO: Report raise_chance and work_raise_chance */
177 CATLSTR(outbuf, outlen,
178 /* TRANS: Header for fixed-width veteran level table.
179 * TRANS: Translators cannot change column widths :(
180 * TRANS: "Level name" left-justified, other two right-justified */
181 _("Veteran level Power factor Move bonus\n"));
182 CATLSTR(outbuf, outlen,
183 /* TRANS: Part of header for veteran level table. */
184 _("--------------------------------------------"));
185 for (i = 0; i < veteran->levels; i++) {
186 const struct veteran_level *level = &veteran->definitions[i];
187 const char *name = name_translation_get(&level->name);
188 int slen;
189
190 /* Use get_internal_string_length() for correct alignment with
191 * multibyte character encodings */
192 slen = 25 - (int)get_internal_string_length(name);
193 cat_snprintf(outbuf, outlen,
194 "\n%s%*s %4d%% %12s",
195 name, MAX(0, slen), "",
196 level->power_fact,
197 /* e.g. "- ", "+ 1/3", "+ 1 ", "+ 2 2/3" */
198 move_points_text_full(level->move_bonus, TRUE, "+ ", "-", TRUE));
199 }
200 return TRUE;
201 }
202}
203
204/************************************************************************/
208 static bool insert_generated_text(char *outbuf, size_t outlen, const char *name)
209{
210 if (!game.client.ruleset_init) {
211 return FALSE;
212 }
213
214 if (0 == strcmp(name, "TerrainAlterations")) {
215 int clean_time = -1, pillage_time = -1;
216 bool terrain_independent_extras = FALSE;
217
218 CATLSTR(outbuf, outlen,
219 /* TRANS: Header for fixed-width terrain alteration table.
220 * TRANS: Translators cannot change column widths :( */
221 _("Terrain Cultivate Plant Transform\n"));
222 CATLSTR(outbuf, outlen,
223 "----------------------------------------------------------------\n");
224 terrain_type_iterate(pterrain) {
225 if (0 != strlen(terrain_rule_name(pterrain))) {
226 char cultivation_time[4], plant_time[4], transform_time[4];
227 const char *terrain, *cultivate_result,
228 *plant_result,*transform_result;
229 struct universal for_terr = { .kind = VUT_TERRAIN, .value = { .terrain = pterrain }};
230 int cslen, pslen, tslen;
231
232 fc_snprintf(cultivation_time, sizeof(cultivation_time),
233 "%d", pterrain->cultivate_time);
234 fc_snprintf(plant_time, sizeof(plant_time),
235 "%d", pterrain->plant_time);
236 fc_snprintf(transform_time, sizeof(transform_time),
237 "%d", pterrain->transform_time);
238 terrain = terrain_name_translation(pterrain);
239 cultivate_result =
240 (pterrain->cultivate_result == T_NONE
241 || !action_id_univs_not_blocking(ACTION_CULTIVATE, NULL, &for_terr))
242 ? ""
243 : terrain_name_translation(pterrain->cultivate_result);
244 plant_result =
245 (pterrain->plant_result == T_NONE
246 || !action_id_univs_not_blocking(ACTION_PLANT, NULL, &for_terr))
247 ? ""
248 : terrain_name_translation(pterrain->plant_result);
249 transform_result =
250 (pterrain->transform_result == pterrain
251 || pterrain->transform_result == T_NONE
252 || !action_id_univs_not_blocking(ACTION_TRANSFORM_TERRAIN,
253 NULL, &for_terr)) ? ""
254 : terrain_name_translation(pterrain->transform_result);
255
256 /* Use get_internal_string_length() for correct alignment with
257 * multibyte character encodings */
258 tslen = 12 - (int)get_internal_string_length(terrain);
259 cslen = 12 - (int)get_internal_string_length(cultivate_result);
260 pslen = 12 - (int)get_internal_string_length(plant_result);
261 cat_snprintf(outbuf, outlen,
262 "%s%*s %3s %s%*s %3s %s%*s %3s %s\n",
263 terrain,
264 MAX(0, tslen), "",
265 (pterrain->cultivate_result == T_NONE) ? "-" : cultivation_time,
266 cultivate_result,
267 MAX(0, cslen), "",
268 (pterrain->plant_result == T_NONE) ? "-" : plant_time,
269 plant_result,
270 MAX(0, pslen), "",
271 (pterrain->transform_result == T_NONE) ? "-" : transform_time,
272 transform_result);
273
274 if (clean_time != 0) {
275 extra_type_by_rmcause_iterate(ERM_CLEAN, pextra) {
276 int rmtime = pterrain->extra_removal_times[extra_index(pextra)];
277
278 if (rmtime != 0) {
279 if (clean_time < 0) {
280 clean_time = rmtime;
281 } else if (clean_time != rmtime) {
282 clean_time = 0; /* Give up */
283 }
284 }
285 } extra_type_by_rmcause_iterate_end;
286 }
287
288 if (pillage_time != 0 && pterrain->pillage_time != 0) {
289 if (pillage_time < 0) {
290 pillage_time = pterrain->pillage_time;
291 } else {
292 if (pillage_time != pterrain->pillage_time) {
293 pillage_time = 0; /* Give up */
294 }
295 }
296 }
297 }
298 } terrain_type_iterate_end;
299
300 /* Examine extras to see if time of removal activities really is
301 * terrain-independent, and take into account removal_time_factor.
302 * XXX: this is rather overwrought to handle cases which the ruleset
303 * author could express much more simply for the same result */
304 {
305 int time = -1, factor = -1;
306
307 extra_type_by_rmcause_iterate(ERM_CLEAN, pextra) {
308 if (pextra->removal_time == 0) {
309 if (factor < 0) {
310 factor = pextra->removal_time_factor;
311 } else if (factor != pextra->removal_time_factor) {
312 factor = 0; /* Give up */
313 }
314 } else {
315 if (time < 0) {
316 time = pextra->removal_time;
317 } else if (time != pextra->removal_time) {
318 time = 0; /* Give up */
319 }
320 }
321 } extra_type_by_rmcause_iterate_end;
322
323 if (factor < 0) {
324 /* No extra has terrain-dependent clean time; use extra's time */
325 if (time >= 0) {
326 clean_time = time;
327 } else {
328 clean_time = 0;
329 }
330 } else if (clean_time != 0) {
331 /* At least one extra's time depends on terrain */
332 fc_assert(clean_time > 0);
333
334 if (time > 0 && factor > 0 && time != clean_time * factor) {
335 clean_time = 0;
336 } else if (time >= 0) {
337 clean_time = time;
338 } else if (factor >= 0) {
339 clean_time *= factor;
340 } else {
341 fc_assert(FALSE);
342 }
343 }
344 }
345
346 {
347 int time = -1, factor = -1;
348
349 extra_type_by_rmcause_iterate(ERM_PILLAGE, pextra) {
350 if (pextra->removal_time == 0) {
351 if (factor < 0) {
352 factor = pextra->removal_time_factor;
353 } else if (factor != pextra->removal_time_factor) {
354 factor = 0; /* Give up */
355 }
356 } else {
357 if (time < 0) {
358 time = pextra->removal_time;
359 } else if (time != pextra->removal_time) {
360 time = 0; /* Give up */
361 }
362 }
363 } extra_type_by_rmcause_iterate_end;
364 if (factor < 0) {
365 /* No extra has terrain-dependent pillage time; use extra's time */
366 if (time >= 0) {
367 pillage_time = time;
368 } else {
369 pillage_time = 0;
370 }
371 } else if (pillage_time != 0) {
372 /* At least one extra's time depends on terrain */
373 fc_assert(pillage_time > 0);
374 if (time > 0 && factor > 0 && time != pillage_time * factor) {
375 pillage_time = 0;
376 } else if (time >= 0) {
377 pillage_time = time;
378 } else if (factor >= 0) {
379 pillage_time = pillage_time * factor;
380 } else {
381 fc_assert(FALSE);
382 }
383 }
384 }
385
386 /* Check whether there are any bases or roads whose build time is
387 * independent of terrain */
388
389 extra_type_by_cause_iterate(EC_BASE, pextra) {
390 if (pextra->buildable && pextra->build_time > 0) {
391 terrain_independent_extras = TRUE;
392 break;
393 }
394 } extra_type_by_cause_iterate_end;
395 if (!terrain_independent_extras) {
396 extra_type_by_cause_iterate(EC_ROAD, pextra) {
397 if (pextra->buildable && pextra->build_time > 0) {
398 terrain_independent_extras = TRUE;
399 break;
400 }
401 } extra_type_by_cause_iterate_end;
402 }
403
404 if (clean_time > 0 || pillage_time > 0
405 || terrain_independent_extras) {
406 CATLSTR(outbuf, outlen, "\n");
407 CATLSTR(outbuf, outlen,
408 _("Time taken for the following activities is independent of "
409 "terrain:\n"));
410 CATLSTR(outbuf, outlen, "\n");
411 CATLSTR(outbuf, outlen,
412 /* TRANS: Header for fixed-width terrain alteration table.
413 * TRANS: Translators cannot change column widths :( */
414 _("Activity Time\n"));
415 CATLSTR(outbuf, outlen,
416 "---------------------------");
417 if (clean_time > 0) {
418 cat_snprintf(outbuf, outlen,
419 _("\nClean %3d"), clean_time);
420 }
421 if (pillage_time > 0) {
422 cat_snprintf(outbuf, outlen,
423 _("\nPillage %3d"), pillage_time);
424 }
425
426 extra_type_by_cause_iterate(EC_ROAD, pextra) {
427 if (pextra->buildable && pextra->build_time > 0) {
428 const char *rname = extra_name_translation(pextra);
429 int slen = 18 - (int)get_internal_string_length(rname);
430
431 cat_snprintf(outbuf, outlen,
432 "\n%s%*s %3d",
433 rname,
434 MAX(0, slen), "",
435 pextra->build_time);
436 }
437 } extra_type_by_cause_iterate_end;
438
439 extra_type_by_cause_iterate(EC_BASE, pextra) {
440 if (pextra->buildable && pextra->build_time > 0) {
441 const char *bname = extra_name_translation(pextra);
442 int slen = 18 - (int)get_internal_string_length(bname);
443
444 cat_snprintf(outbuf, outlen,
445 "\n%s%*s %3d",
446 bname,
447 MAX(0, slen), "",
448 pextra->build_time);
449 }
450 } extra_type_by_cause_iterate_end;
451 }
452
453 return TRUE;
454 } else if (0 == strcmp(name, "VeteranLevels")) {
455 return insert_veteran_help(outbuf, outlen, game.veteran,
456 _("In this ruleset, the following veteran levels are defined:"),
457 _("This ruleset has no default veteran levels defined."));
458 } else if (0 == strcmp(name, "FreecivVersion")) {
459 const char *ver = freeciv_name_version();
460
461 cat_snprintf(outbuf, outlen,
462 /* TRANS: First %s is version string, e.g.,
463 * "Freeciv version 3.2.0-beta1 (beta version)" (translated).
464 * Second %s is client_string, e.g., "gui-gtk-4.0". */
465 _("This is %s, %s client."), ver, client_string);
466 insert_client_build_info(outbuf, outlen);
467
468 return TRUE;
469 } else if (0 == strcmp(name, "DefaultMetaserver")) {
470 cat_snprintf(outbuf, outlen, " %s", FREECIV_META_URL);
471
472 return TRUE;
473 }
474 log_error("Unknown directive '$%s' in help", name);
475 return FALSE;
476}
477
478/************************************************************************/
485 static void insert_allows_single(struct universal *psource,
486 struct requirement_vector *psubjreqs,
487 const char *subjstr,
488 const char *const *strs,
489 char *buf, size_t bufsz,
490 const char *prefix)
491{
492 struct strvec *coreqs = strvec_new();
493 struct strvec *conoreqs = strvec_new();
494 struct astring coreqstr = ASTRING_INIT;
495 struct astring conoreqstr = ASTRING_INIT;
496 char buf2[bufsz];
497
498 /* FIXME: show other data like range and survives. */
499
500 requirement_vector_iterate(psubjreqs, req) {
501 if (!req->quiet && are_universals_equal(psource, &req->source)) {
502 /* We're definitely going to print _something_. */
503 CATLSTR(buf, bufsz, "%s", prefix);
504 if (req->present) {
505 /* psource enables the subject, but other sources may
506 * also be required (or required to be absent). */
507 requirement_vector_iterate(psubjreqs, coreq) {
508 if (!coreq->quiet && !are_universals_equal(psource, &coreq->source)) {
509 universal_name_translation(&coreq->source, buf2, sizeof(buf2));
510 strvec_append(coreq->present ? coreqs : conoreqs, buf2);
511 }
512 } requirement_vector_iterate_end;
513
514 if (0 < strvec_size(coreqs)) {
515 if (0 < strvec_size(conoreqs)) {
516 cat_snprintf(buf, bufsz,
517 Q_(strs[0]), /* "Allows %s (with %s but no %s)." */
518 subjstr,
519 strvec_to_and_list(coreqs, &coreqstr),
520 strvec_to_or_list(conoreqs, &conoreqstr));
521 } else {
522 cat_snprintf(buf, bufsz,
523 Q_(strs[1]), /* "Allows %s (with %s)." */
524 subjstr,
525 strvec_to_and_list(coreqs, &coreqstr));
526 }
527 } else {
528 if (0 < strvec_size(conoreqs)) {
529 cat_snprintf(buf, bufsz,
530 Q_(strs[2]), /* "Allows %s (absent %s)." */
531 subjstr,
532 strvec_to_and_list(conoreqs, &conoreqstr));
533 } else {
534 cat_snprintf(buf, bufsz,
535 Q_(strs[3]), /* "Allows %s." */
536 subjstr);
537 }
538 }
539 } else {
540 /* psource can, on its own, prevent the subject. */
541 cat_snprintf(buf, bufsz,
542 Q_(strs[4]), /* "Prevents %s." */
543 subjstr);
544 }
545 cat_snprintf(buf, bufsz, "\n");
546 }
547 } requirement_vector_iterate_end;
548
549 strvec_destroy(coreqs);
550 strvec_destroy(conoreqs);
551 astr_free(&coreqstr);
552 astr_free(&conoreqstr);
553}
554
555/************************************************************************/
571 static void insert_allows(struct universal *psource,
572 char *buf, size_t bufsz, const char *prefix)
573{
574 buf[0] = '\0';
575
576 governments_iterate(pgov) {
577 static const char *const govstrs[] = {
578 /* TRANS: First %s is a government name. */
579 N_("?gov:Allows %s (with %s but no %s)."),
580 /* TRANS: First %s is a government name. */
581 N_("?gov:Allows %s (with %s)."),
582 /* TRANS: First %s is a government name. */
583 N_("?gov:Allows %s (absent %s)."),
584 /* TRANS: %s is a government name. */
585 N_("?gov:Allows %s."),
586 /* TRANS: %s is a government name. */
587 N_("?gov:Prevents %s.")
588 };
589 insert_allows_single(psource, &pgov->reqs,
590 government_name_translation(pgov), govstrs,
591 buf, bufsz, prefix);
592 } governments_iterate_end;
593
594 improvement_iterate(pimprove) {
595 if (valid_improvement(pimprove)) {
596 static const char *const imprstrs[] = {
597 /* TRANS: First %s is a building name. */
598 N_("?improvement:Allows %s (with %s but no %s)."),
599 /* TRANS: First %s is a building name. */
600 N_("?improvement:Allows %s (with %s)."),
601 /* TRANS: First %s is a building name. */
602 N_("?improvement:Allows %s (absent %s)."),
603 /* TRANS: %s is a building name. */
604 N_("?improvement:Allows %s."),
605 /* TRANS: %s is a building name. */
606 N_("?improvement:Prevents %s.")
607 };
608 insert_allows_single(psource, &pimprove->reqs,
609 improvement_name_translation(pimprove), imprstrs,
610 buf, bufsz, prefix);
611 }
612 } improvement_iterate_end;
613
614 unit_type_iterate(putype) {
615 static const char *const utstrs[] = {
616 /* TRANS: First %s is a unit type name. */
617 N_("?unittype:Allows %s (with %s but no %s)."),
618 /* TRANS: First %s is a unit type name. */
619 N_("?unittype:Allows %s (with %s)."),
620 /* TRANS: First %s is a unit type name. */
621 N_("?unittype:Allows %s (absent %s)."),
622 /* TRANS: %s is a unit type name. */
623 N_("?unittype:Allows %s."),
624 /* TRANS: %s is a unit type name. */
625 N_("?unittype:Prevents %s.")
626 };
627 insert_allows_single(psource, &putype->build_reqs,
628 utype_name_translation(putype), utstrs,
629 buf, bufsz, prefix);
630 } unit_type_iterate_end;
631
632 extra_type_iterate(pextra) {
633 static const char *const estrs[] = {
634 /* TRANS: First %s is an extra name. */
635 N_("?extra:Allows %s (with %s but no %s)."),
636 /* TRANS: First %s is an extra name. */
637 N_("?extra:Allows %s (with %s)."),
638 /* TRANS: First %s is an extra name. */
639 N_("?extra:Allows %s (absent %s)."),
640 /* TRANS: %s is an extra name. */
641 N_("?extra:Allows %s."),
642 /* TRANS: %s is an extra name. */
643 N_("?extra:Prevents %s.")
644 };
645 insert_allows_single(psource, &pextra->reqs,
646 extra_name_translation(pextra), estrs,
647 buf, bufsz, prefix);
648 } extra_type_iterate_end;
649
650 goods_type_iterate(pgood) {
651 static const char *const gstrs[] = {
652 /* TRANS: First %s is a good name. */
653 N_("?good:Allows %s (with %s but no %s)."),
654 /* TRANS: First %s is a good name. */
655 N_("?good:Allows %s (with %s)."),
656 /* TRANS: First %s is a good name. */
657 N_("?good:Allows %s (absent %s)."),
658 /* TRANS: %s is a good name. */
659 N_("?good:Allows %s."),
660 /* TRANS: %s is a good name. */
661 N_("?good:Prevents %s.")
662 };
663 insert_allows_single(psource, &pgood->reqs,
664 goods_name_translation(pgood), gstrs,
665 buf, bufsz, prefix);
666 } goods_type_iterate_end;
667}
668
669/************************************************************************/
672 static struct help_item *new_help_item(int type)
673{
674 struct help_item *pitem;
675
676 pitem = fc_malloc(sizeof(struct help_item));
677 pitem->topic = NULL;
678 pitem->text = NULL;
679 pitem->type = type;
680
681 return pitem;
682}
683
684/************************************************************************/
688 static int help_item_compar(const struct help_item *const *ppa,
689 const struct help_item *const *ppb)
690{
691 const struct help_item *ha, *hb;
692 char *ta, *tb;
693 ha = *ppa;
694 hb = *ppb;
695 for (ta = ha->topic, tb = hb->topic; *ta != '\0' && *tb != '\0'; ta++, tb++) {
696 if (*ta != ' ') {
697 if (*tb == ' ') return -1;
698 break;
699 } else if (*tb != ' ') {
700 if (*ta == ' ') return 1;
701 break;
702 }
703 }
704 return compare_strings(ta, tb);
705}
706
707/************************************************************************/
710 void boot_help_texts(void)
711{
712 static bool booted = FALSE;
713
714 struct section_file *sf;
715 const char *filename;
716 struct help_item *pitem;
717 int i;
718 struct section_list *sec;
719 const char **paras;
720 size_t npara;
721 char long_buffer[64000]; /* HACK: this may be overrun. */
722
723 check_help_nodes_init();
724
725 /* need to do something like this or bad things happen */
726 popdown_help_dialog();
727
728 if (!booted) {
729 log_verbose("Booting help texts");
730 } else {
731 /* free memory allocated last time booted */
732 free_help_texts();
733 log_verbose("Rebooting help texts");
734 }
735
736 filename = fileinfoname(get_data_dirs(), "helpdata.txt");
737 if (!filename) {
738 log_error("Did not read help texts");
739 return;
740 }
741 /* after following call filename may be clobbered; use sf->filename instead */
742 if (!(sf = secfile_load(filename, FALSE))) {
743 /* this is now unlikely to happen */
744 log_error("failed reading help-texts from '%s':\n%s", filename,
745 secfile_error());
746 return;
747 }
748
749 sec = secfile_sections_by_name_prefix(sf, "help_");
750
751 if (NULL != sec) {
752 section_list_iterate(sec, psection) {
753 char help_text_buffer[MAX_LEN_PACKET];
754 const char *sec_name = section_name(psection);
755 const char *gen_str = secfile_lookup_str(sf, "%s.generate", sec_name);
756
757 if (gen_str) {
758 enum help_page_type current_type = HELP_ANY;
759 int level = strspn(gen_str, " ");
760
761 gen_str += level;
762
763 for (i = 2; help_type_names[i]; i++) {
764 if (strcmp(gen_str, help_type_names[i]) == 0) {
765 current_type = i;
766 break;
767 }
768 }
769 if (current_type == HELP_ANY) {
770 log_error("bad help-generate category \"%s\"", gen_str);
771 continue;
772 }
773
774 if (!booted) {
775 if (current_type == HELP_EXTRA) {
776 size_t ncats;
777
778 /* Avoid warnings about entries unused on this round,
779 * when the entries in question are valid once help system has been booted */
780 (void) secfile_lookup_str_vec(sf, &ncats,
781 "%s.categories", sec_name);
782 }
783 continue; /* on initial boot data tables are empty */
784 }
785
786 {
787 /* Note these should really fill in pitem->text from auto-gen
788 data instead of doing it later on the fly, but I don't want
789 to change that now. --dwp
790 */
791 char name[2048];
792 struct help_list *category_nodes = help_list_new();
793
794 switch (current_type) {
795 case HELP_UNIT:
796 unit_type_iterate(punittype) {
797 pitem = new_help_item(current_type);
798 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
799 utype_name_translation(punittype));
800 pitem->topic = fc_strdup(name);
801 pitem->text = fc_strdup("");
802 help_list_append(category_nodes, pitem);
803 } unit_type_iterate_end;
804 break;
805 case HELP_TECH:
806 advance_index_iterate(A_FIRST, advi) {
807 if (valid_advance_by_number(advi)) {
808 pitem = new_help_item(current_type);
809 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
810 advance_name_translation(advance_by_number(advi)));
811 pitem->topic = fc_strdup(name);
812 pitem->text = fc_strdup("");
813 help_list_append(category_nodes, pitem);
814 }
815 } advance_index_iterate_end;
816 break;
817 case HELP_TERRAIN:
818 terrain_type_iterate(pterrain) {
819 if (0 != strlen(terrain_rule_name(pterrain))) {
820 pitem = new_help_item(current_type);
821 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
822 terrain_name_translation(pterrain));
823 pitem->topic = fc_strdup(name);
824 pitem->text = fc_strdup("");
825 help_list_append(category_nodes, pitem);
826 }
827 } terrain_type_iterate_end;
828 break;
829 case HELP_EXTRA:
830 {
831 const char **cats;
832 size_t ncats;
833 cats = secfile_lookup_str_vec(sf, &ncats,
834 "%s.categories", sec_name);
835 extra_type_iterate(pextra) {
836 /* If categories not specified, don't filter */
837 if (cats) {
838 bool include = FALSE;
839 const char *cat = extra_category_name(pextra->category);
840 int ci;
841
842 for (ci = 0; ci < ncats; ci++) {
843 if (fc_strcasecmp(cats[ci], cat) == 0) {
844 include = TRUE;
845 break;
846 }
847 }
848 if (!include) {
849 continue;
850 }
851 }
852 pitem = new_help_item(current_type);
853 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
854 extra_name_translation(pextra));
855 pitem->topic = fc_strdup(name);
856 pitem->text = fc_strdup("");
857 help_list_append(category_nodes, pitem);
858 } extra_type_iterate_end;
859 FC_FREE(cats);
860 }
861 break;
862 case HELP_GOODS:
863 goods_type_iterate(pgood) {
864 pitem = new_help_item(current_type);
865 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
866 goods_name_translation(pgood));
867 pitem->topic = fc_strdup(name);
868 pitem->text = fc_strdup("");
869 help_list_append(category_nodes, pitem);
870 } goods_type_iterate_end;
871 break;
872 case HELP_SPECIALIST:
873 specialist_type_iterate(sp) {
874 struct specialist *pspec = specialist_by_number(sp);
875
876 pitem = new_help_item(current_type);
877 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
878 specialist_plural_translation(pspec));
879 pitem->topic = fc_strdup(name);
880 pitem->text = fc_strdup("");
881 help_list_append(category_nodes, pitem);
882 } specialist_type_iterate_end;
883 break;
884 case HELP_GOVERNMENT:
885 governments_iterate(gov) {
886 pitem = new_help_item(current_type);
887 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
888 government_name_translation(gov));
889 pitem->topic = fc_strdup(name);
890 pitem->text = fc_strdup("");
891 help_list_append(category_nodes, pitem);
892 } governments_iterate_end;
893 break;
894 case HELP_IMPROVEMENT:
895 improvement_iterate(pimprove) {
896 if (valid_improvement(pimprove) && !is_great_wonder(pimprove)) {
897 pitem = new_help_item(current_type);
898 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
899 improvement_name_translation(pimprove));
900 pitem->topic = fc_strdup(name);
901 pitem->text = fc_strdup("");
902 help_list_append(category_nodes, pitem);
903 }
904 } improvement_iterate_end;
905 break;
906 case HELP_WONDER:
907 improvement_iterate(pimprove) {
908 if (valid_improvement(pimprove) && is_great_wonder(pimprove)) {
909 pitem = new_help_item(current_type);
910 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
911 improvement_name_translation(pimprove));
912 pitem->topic = fc_strdup(name);
913 pitem->text = fc_strdup("");
914 help_list_append(category_nodes, pitem);
915 }
916 } improvement_iterate_end;
917 break;
918 case HELP_RULESET:
919 {
920 int desc_len;
921 int len;
922
923 pitem = new_help_item(HELP_RULESET);
924 /* pitem->topic = fc_strdup(_(game.control.name)); */
925 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
926 Q_(HELP_RULESET_ITEM));
927 pitem->topic = fc_strdup(name);
928 if (game.ruleset_description != NULL) {
929 desc_len = strlen("\n\n") + strlen(game.ruleset_description);
930 } else {
931 desc_len = 0;
932 }
933 if (game.ruleset_summary != NULL) {
934 if (game.control.version[0] != '\0') {
935 len = strlen(_(game.control.name))
936 + strlen(" ")
937 + strlen(game.control.version)
938 + strlen("\n\n")
939 + strlen(_(game.ruleset_summary))
940 + 1;
941
942 pitem->text = fc_malloc(len + desc_len);
943 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
944 _(game.control.name), game.control.version,
945 _(game.ruleset_summary));
946 } else {
947 len = strlen(_(game.control.name))
948 + strlen("\n\n")
949 + strlen(_(game.ruleset_summary))
950 + 1;
951
952 pitem->text = fc_malloc(len + desc_len);
953 fc_snprintf(pitem->text, len, "%s\n\n%s",
954 _(game.control.name), _(game.ruleset_summary));
955 }
956 } else {
957 const char *nodesc = _("Current ruleset contains no summary.");
958
959 if (game.control.version[0] != '\0') {
960 len = strlen(_(game.control.name))
961 + strlen(" ")
962 + strlen(game.control.version)
963 + strlen("\n\n")
964 + strlen(nodesc)
965 + 1;
966
967 pitem->text = fc_malloc(len + desc_len);
968 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
969 _(game.control.name), game.control.version,
970 nodesc);
971 } else {
972 len = strlen(_(game.control.name))
973 + strlen("\n\n")
974 + strlen(nodesc)
975 + 1;
976
977 pitem->text = fc_malloc(len + desc_len);
978 fc_snprintf(pitem->text, len, "%s\n\n%s",
979 _(game.control.name),
980 nodesc);
981 }
982 }
983 if (game.ruleset_description != NULL) {
984 fc_strlcat(pitem->text, "\n\n", len + desc_len);
985 fc_strlcat(pitem->text, game.ruleset_description, len + desc_len);
986 }
987 help_list_append(help_nodes, pitem);
988 }
989 break;
990 case HELP_TILESET:
991 {
992 int desc_len;
993 int len;
994 const char *ts_name = tileset_name_get(tileset);
995 const char *version = tileset_version(tileset);
996 const char *summary = tileset_summary(tileset);
997 const char *description = tileset_description(tileset);
998
999 pitem = new_help_item(HELP_TILESET);
1000 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1001 Q_(HELP_TILESET_ITEM));
1002 pitem->topic = fc_strdup(name);
1003 if (description != NULL) {
1004 desc_len = strlen("\n\n") + strlen(description);
1005 } else {
1006 desc_len = 0;
1007 }
1008 if (summary != NULL) {
1009 if (version[0] != '\0') {
1010 len = strlen(_(ts_name))
1011 + strlen(" ")
1012 + strlen(version)
1013 + strlen("\n\n")
1014 + strlen(_(summary))
1015 + 1;
1016
1017 pitem->text = fc_malloc(len + desc_len);
1018 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1019 _(ts_name), version, _(summary));
1020 } else {
1021 len = strlen(_(ts_name))
1022 + strlen("\n\n")
1023 + strlen(_(summary))
1024 + 1;
1025
1026 pitem->text = fc_malloc(len + desc_len);
1027 fc_snprintf(pitem->text, len, "%s\n\n%s",
1028 _(ts_name), _(summary));
1029 }
1030 } else {
1031 const char *nodesc = _("Current tileset contains no summary.");
1032
1033 if (version[0] != '\0') {
1034 len = strlen(_(ts_name))
1035 + strlen(" ")
1036 + strlen(version)
1037 + strlen("\n\n")
1038 + strlen(nodesc)
1039 + 1;
1040
1041 pitem->text = fc_malloc(len + desc_len);
1042 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1043 _(ts_name), version,
1044 nodesc);
1045 } else {
1046 len = strlen(_(ts_name))
1047 + strlen("\n\n")
1048 + strlen(nodesc)
1049 + 1;
1050
1051 pitem->text = fc_malloc(len + desc_len);
1052 fc_snprintf(pitem->text, len, "%s\n\n%s",
1053 _(ts_name),
1054 nodesc);
1055 }
1056 }
1057 if (description != NULL) {
1058 fc_strlcat(pitem->text, "\n\n", len + desc_len);
1059 fc_strlcat(pitem->text, description, len + desc_len);
1060 }
1061 help_list_append(help_nodes, pitem);
1062 }
1063 break;
1064 case HELP_MUSICSET:
1065 {
1066 int desc_len;
1067 int len;
1068 const char *ms_name = current_musicset_name();
1069 const char *version = current_musicset_version();
1070 const char *summary = current_musicset_summary();
1071 const char *description = current_musicset_description();
1072
1073 pitem = new_help_item(HELP_MUSICSET);
1074 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1075 Q_(HELP_MUSICSET_ITEM));
1076 pitem->topic = fc_strdup(name);
1077 if (description != NULL) {
1078 desc_len = strlen("\n\n") + strlen(description);
1079 } else {
1080 desc_len = 0;
1081 }
1082 if (summary != NULL) {
1083 if (version != NULL && version[0] != '\0') {
1084 len = strlen(_(ms_name))
1085 + strlen(" ")
1086 + strlen(version)
1087 + strlen("\n\n")
1088 + strlen(_(summary))
1089 + 1;
1090
1091 pitem->text = fc_malloc(len + desc_len);
1092 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1093 _(ms_name), version, _(summary));
1094 } else {
1095 len = strlen(_(ms_name))
1096 + strlen("\n\n")
1097 + strlen(_(summary))
1098 + 1;
1099
1100 pitem->text = fc_malloc(len + desc_len);
1101 fc_snprintf(pitem->text, len, "%s\n\n%s",
1102 _(ms_name), _(summary));
1103 }
1104 } else {
1105 const char *nodesc = _("Current musicset contains no summary.");
1106
1107 if (version != NULL && version[0] != '\0') {
1108 len = strlen(_(ms_name))
1109 + strlen(" ")
1110 + strlen(version)
1111 + strlen("\n\n")
1112 + strlen(nodesc)
1113 + 1;
1114
1115 pitem->text = fc_malloc(len + desc_len);
1116 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1117 _(ms_name), version,
1118 nodesc);
1119 } else {
1120 len = strlen(_(ms_name))
1121 + strlen("\n\n")
1122 + strlen(nodesc)
1123 + 1;
1124
1125 pitem->text = fc_malloc(len + desc_len);
1126 fc_snprintf(pitem->text, len, "%s\n\n%s",
1127 _(ms_name),
1128 nodesc);
1129 }
1130 }
1131 if (description != NULL) {
1132 fc_strlcat(pitem->text, "\n\n", len + desc_len);
1133 fc_strlcat(pitem->text, description, len + desc_len);
1134 }
1135 help_list_append(help_nodes, pitem);
1136 }
1137 break;
1138 case HELP_NATIONS:
1139 nations_iterate(pnation) {
1140 if (client_state() < C_S_RUNNING
1141 || show_help_for_nation(pnation)) {
1142 pitem = new_help_item(current_type);
1143 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1144 nation_plural_translation(pnation));
1145 pitem->topic = fc_strdup(name);
1146 pitem->text = fc_strdup("");
1147 help_list_append(category_nodes, pitem);
1148 }
1149 } nations_iterate_end;
1150 break;
1151 case HELP_MULTIPLIER:
1152 multipliers_iterate(pmul) {
1153 help_text_buffer[0] = '\0';
1154 pitem = new_help_item(current_type);
1155 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1156 name_translation_get(&pmul->name));
1157 pitem->topic = fc_strdup(name);
1158 if (pmul->helptext) {
1159 const char *sep = "";
1160 strvec_iterate(pmul->helptext, text) {
1161 cat_snprintf(help_text_buffer, sizeof(help_text_buffer),
1162 "%s%s", sep, text);
1163 sep = "\n\n";
1164 } strvec_iterate_end;
1165 }
1166 pitem->text = fc_strdup(help_text_buffer);
1167 help_list_append(help_nodes, pitem);
1168 } multipliers_iterate_end;
1169 break;
1170 case HELP_COUNTER:
1171 {
1172 int j;
1173 for (j = 0; j < game.control.num_counters; j++) {
1174 struct counter *pcount = counter_by_id(j);
1175
1176 help_text_buffer[0] = '\0';
1177 pitem = new_help_item(current_type);
1178 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1179 counter_name_translation(pcount));
1180 pitem->topic = fc_strdup(name);
1181 if (pcount->helptext) {
1182 strvec_iterate(pcount->helptext, text) {
1183 cat_snprintf(help_text_buffer, sizeof(help_text_buffer),
1184 "%s%s", "\n\n", text);
1185 } strvec_iterate_end;
1186 }
1187 pitem->text = fc_strdup(help_text_buffer);
1188 help_list_append(help_nodes, pitem);
1189 }
1190 }
1191 break;
1192 default:
1193 log_error("Bad current_type: %d.", current_type);
1194 break;
1195 }
1196 help_list_sort(category_nodes, help_item_compar);
1197 help_list_iterate(category_nodes, ptmp) {
1198 help_list_append(help_nodes, ptmp);
1199 } help_list_iterate_end;
1200 help_list_destroy(category_nodes);
1201 continue;
1202 }
1203 }
1204
1205 /* It wasn't a "generate" node: */
1206
1207 pitem = new_help_item(HELP_TEXT);
1208 pitem->topic = fc_strdup(Q_(secfile_lookup_str(sf, "%s.name",
1209 sec_name)));
1210
1211 paras = secfile_lookup_str_vec(sf, &npara, "%s.text", sec_name);
1212
1213 long_buffer[0] = '\0';
1214 for (i = 0; i < npara; i++) {
1215 bool inserted;
1216 const char *para = paras[i];
1217
1218 if (!fc_strncmp(para, "$", 1)) {
1219 inserted
1220 = insert_generated_text(long_buffer, sizeof(long_buffer), para+1);
1221 } else {
1222 sz_strlcat(long_buffer, _(para));
1223 inserted = TRUE;
1224 }
1225 if (inserted && i != npara - 1) {
1226 sz_strlcat(long_buffer, "\n\n");
1227 }
1228 }
1229 free(paras);
1230 paras = NULL;
1231 pitem->text = fc_strdup(long_buffer);
1232 help_list_append(help_nodes, pitem);
1233 } section_list_iterate_end;
1234
1235 section_list_destroy(sec);
1236 }
1237
1238 secfile_check_unused(sf);
1239 secfile_destroy(sf);
1240 booted = TRUE;
1241 log_verbose("Booted help texts ok");
1242}
1243
1244/****************************************************************************
1245 The following few functions are essentially wrappers for the
1246 help_nodes help_list. This allows us to avoid exporting the
1247 help_list, and instead only access it through a controlled
1248 interface.
1249****************************************************************************/
1250
1251/************************************************************************/
1254 int num_help_items(void)
1255{
1256 check_help_nodes_init();
1257 return help_list_size(help_nodes);
1258}
1259
1260/************************************************************************/
1265 const struct help_item *get_help_item(int pos)
1266{
1267 int size;
1268
1269 check_help_nodes_init();
1270 size = help_list_size(help_nodes);
1271 if (pos < 0 || pos > size) {
1272 log_error("Bad index %d to get_help_item (size %d)", pos, size);
1273 return NULL;
1274 }
1275 if (pos == size) {
1276 return NULL;
1277 }
1278 return help_list_get(help_nodes, pos);
1279}
1280
1281/************************************************************************/
1287const struct help_item*
1288get_help_item_spec(const char *name, enum help_page_type htype, int *pos)
1289{
1290 int idx;
1291 const struct help_item *pitem = NULL;
1292 static struct help_item vitem; /* v = virtual */
1293 static char vtopic[128];
1294 static char vtext[256];
1295
1296 check_help_nodes_init();
1297 idx = 0;
1298 help_list_iterate(help_nodes, ptmp) {
1299 char *p = ptmp->topic;
1300
1301 while (*p == ' ') {
1302 p++;
1303 }
1304 if (strcmp(name, p) == 0 && (htype == HELP_ANY || htype == ptmp->type)) {
1305 pitem = ptmp;
1306 break;
1307 }
1308 idx++;
1309 }
1310 help_list_iterate_end;
1311
1312 if (!pitem) {
1313 idx = -1;
1314 vitem.topic = vtopic;
1315 sz_strlcpy(vtopic, name);
1316 vitem.text = vtext;
1317 if (htype == HELP_ANY || htype == HELP_TEXT) {
1318 fc_snprintf(vtext, sizeof(vtext),
1319 _("Sorry, no help topic for %s.\n"), vitem.topic);
1320 vitem.type = HELP_TEXT;
1321 } else {
1322 fc_snprintf(vtext, sizeof(vtext),
1323 _("Sorry, no help topic for %s.\n"
1324 "This page was auto-generated.\n\n"),
1325 vitem.topic);
1326 vitem.type = htype;
1327 }
1328 pitem = &vitem;
1329 }
1330 *pos = idx;
1331 return pitem;
1332}
1333
1334/************************************************************************/
1340 void help_iter_start(void)
1341{
1342 check_help_nodes_init();
1343 help_nodes_iterator = help_list_head(help_nodes);
1344}
1345
1346/************************************************************************/
1350 const struct help_item *help_iter_next(void)
1351{
1352 const struct help_item *pitem;
1353
1354 check_help_nodes_init();
1355 pitem = help_list_link_data(help_nodes_iterator);
1356 if (pitem) {
1357 help_nodes_iterator = help_list_link_next(help_nodes_iterator);
1358 }
1359
1360 return pitem;
1361}
1362
1363/****************************************************************************
1364 FIXME:
1365 Also, in principle these could be auto-generated once, inserted
1366 into pitem->text, and then don't need to keep re-generating them.
1367 Only thing to be careful of would be changeable data, but don't
1368 have that here (for ruleset change or spacerace change must
1369 re-boot helptexts anyway). Eg, genuinely dynamic information
1370 which could be useful would be if help system said which wonders
1371 have been built (or are being built and by who/where?)
1372****************************************************************************/
1373
1374/************************************************************************/
1381 char *helptext_building(char *buf, size_t bufsz, struct player *pplayer,
1382 const char *user_text, const struct impr_type *pimprove)
1383{
1384 bool reqs = FALSE;
1385 struct universal source = {
1386 .kind = VUT_IMPROVEMENT,
1387 .value = {.building = pimprove}
1388 };
1389
1390 fc_assert_ret_val(NULL != buf && 0 < bufsz, NULL);
1391 buf[0] = '\0';
1392
1393 if (NULL == pimprove) {
1394 return buf;
1395 }
1396
1397 if (NULL != pimprove->helptext) {
1398 strvec_iterate(pimprove->helptext, text) {
1399 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
1400 } strvec_iterate_end;
1401 }
1402
1403 /* Add requirement text for improvement itself */
1404 requirement_vector_iterate(&pimprove->reqs, preq) {
1405 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
1406 reqs = TRUE;
1407 }
1408 } requirement_vector_iterate_end;
1409 if (reqs) {
1410 fc_strlcat(buf, "\n", bufsz);
1411 }
1412
1413 requirement_vector_iterate(&pimprove->obsolete_by, pobs) {
1414 if (VUT_ADVANCE == pobs->source.kind && pobs->present) {
1415 cat_snprintf(buf, bufsz,
1416 _("%s The discovery of %s will make %s obsolete.\n"),
1417 BULLET,
1418 advance_name_translation(pobs->source.value.advance),
1419 improvement_name_translation(pimprove));
1420 }
1421 if (VUT_IMPROVEMENT == pobs->source.kind && pobs->present) {
1422 cat_snprintf(buf, bufsz,
1423 /* TRANS: both %s are improvement names */
1424 _("%s The presence of %s in the city will make %s "
1425 "obsolete.\n"),
1426 BULLET,
1427 improvement_name_translation(pobs->source.value.building),
1428 improvement_name_translation(pimprove));
1429 }
1430 } requirement_vector_iterate_end;
1431
1432 if (is_small_wonder(pimprove)) {
1433 cat_snprintf(buf, bufsz,
1434 _("%s A 'small wonder': at most one of your cities may "
1435 "possess this improvement.\n"), BULLET);
1436 }
1437 /* (Great wonders are in their own help section explaining their
1438 * uniqueness, so we don't mention it here.) */
1439
1440 if (building_has_effect(pimprove, EFT_ENABLE_NUKE)) {
1441 action_id nuke_actions[MAX_NUM_ACTIONS];
1442 struct unit_type *u = NULL;
1443
1444 {
1445 /* Find Manhattan dependent nuke actions */
1446 int i = 0;
1447
1448 action_array_add_all_by_result(nuke_actions, &i, ACTRES_NUKE);
1449 action_array_add_all_by_result(nuke_actions, &i, ACTRES_NUKE_UNITS);
1450
1451 action_array_end(nuke_actions, i);
1452 }
1453
1454 action_array_iterate(nuke_actions, act_id) {
1455 if (num_role_units(action_id_get_role(act_id)) > 0) {
1456 u = get_role_unit(action_id_get_role(act_id), 0);
1457 break;
1458 }
1459 } action_array_iterate_end;
1460
1461 if (u) {
1462 struct advance *req = NULL;
1463 int count = 0;
1464
1465 unit_tech_reqs_iterate(u, preq) {
1466 req = preq;
1467 count++;
1468 } unit_tech_reqs_iterate_end;
1469
1470 if (req != NULL) {
1471 if (count == 1) {
1472 cat_snprintf(buf, bufsz,
1473 /* TRANS: 'Allows all players with knowledge of atomic
1474 * power to build nuclear units.' */
1475 _("%s Allows all players with knowledge of %s "
1476 "to build %s units.\n"), BULLET,
1477 advance_name_translation(req),
1478 utype_name_translation(u));
1479 } else {
1480 /* Multiple tech requirements */
1481 cat_snprintf(buf, bufsz,
1482 /* TRANS: 'Allows all players with knowledge of required
1483 * techs to build nuclear units.' */
1484 _("%s Allows all players with knowledge of required "
1485 "techs to build %s units.\n"), BULLET,
1486 utype_name_translation(u));
1487 }
1488 } else {
1489 cat_snprintf(buf, bufsz,
1490 /* TRANS: 'Allows all players to build nuclear units.' */
1491 _("%s Allows all players to build %s units.\n"), BULLET,
1492 utype_name_translation(u));
1493 }
1494 }
1495 }
1496
1497 insert_allows(&source, buf + strlen(buf), bufsz - strlen(buf),
1498 BULLET_SPACE);
1499
1500 /* Actions that requires the building to target a city. */
1501 action_iterate(act) {
1502 /* Nothing is found yet. */
1503 bool demanded = FALSE;
1504 enum req_range max_range = REQ_RANGE_LOCAL;
1505
1506 if (action_id_get_target_kind(act) != ATK_CITY) {
1507 /* Not relevant */
1508 continue;
1509 }
1510
1511 if (action_by_number(act)->quiet) {
1512 /* The ruleset it self documents this action. */
1513 continue;
1514 }
1515
1516 action_enabler_list_iterate(action_enablers_for_action(act), enabler) {
1517 if (universal_fulfills_requirements(TRUE, &(enabler->target_reqs),
1518 &source)) {
1519 /* The building is needed by this action enabler. */
1520 demanded = TRUE;
1521
1522 /* See if this enabler gives the building a wider range. */
1523 requirement_vector_iterate(&(enabler->target_reqs), preq) {
1524 if (!universal_is_relevant_to_requirement(preq, &source)) {
1525 /* Not relevant. */
1526 continue;
1527 }
1528
1529 if (!preq->present) {
1530 /* A !present larger range requirement would make the present
1531 * lower range illegal. */
1532 continue;
1533 }
1534
1535 if (preq->range > max_range) {
1536 /* Found a larger range. */
1537 max_range = preq->range;
1538 /* Intentionally not breaking here. The requirement vector may
1539 * contain other requirements with a larger range.
1540 * Example: Building a GreatWonder in a city with a Palace. */
1541 }
1542 } requirement_vector_iterate_end;
1543 }
1544 } action_enabler_list_iterate_end;
1545
1546 if (demanded) {
1547 switch (max_range) {
1548 case REQ_RANGE_LOCAL:
1549 /* At least one action enabler needed the building in its target
1550 * requirements. */
1551 cat_snprintf(buf, bufsz,
1552 /* TRANS: Help build Wonder */
1553 _("%s Makes it possible to target the city building it "
1554 "with the action \'%s\'.\n"), BULLET,
1555 action_id_name_translation(act));
1556 break;
1557 case REQ_RANGE_CITY:
1558 /* At least one action enabler needed the building in its target
1559 * requirements. */
1560 cat_snprintf(buf, bufsz,
1561 /* TRANS: Help build Wonder */
1562 _("%s Makes it possible to target its city with the "
1563 "action \'%s\'.\n"), BULLET,
1564 action_id_name_translation(act));
1565 break;
1566 case REQ_RANGE_TRADE_ROUTE:
1567 /* At least one action enabler needed the building in its target
1568 * requirements. */
1569 cat_snprintf(buf, bufsz,
1570 /* TRANS: Help build Wonder */
1571 _("%s Makes it possible to target its city and its "
1572 "trade partners with the action \'%s\'.\n"),
1573 BULLET,
1574 action_id_name_translation(act));
1575 break;
1576 case REQ_RANGE_CONTINENT:
1577 /* At least one action enabler needed the building in its target
1578 * requirements. */
1579 cat_snprintf(buf, bufsz,
1580 /* TRANS: Help build Wonder */
1581 _("%s Makes it possible to target all cities with its "
1582 "owner on its continent with the action \'%s\'.\n"),
1583 BULLET,
1584 action_id_name_translation(act));
1585 break;
1586 case REQ_RANGE_PLAYER:
1587 /* At least one action enabler needed the building in its target
1588 * requirements. */
1589 cat_snprintf(buf, bufsz,
1590 /* TRANS: Help build Wonder */
1591 _("%s Makes it possible to target all cities with its "
1592 "owner with the action \'%s\'.\n"),
1593 BULLET,
1594 action_id_name_translation(act));
1595 break;
1596 case REQ_RANGE_TEAM:
1597 /* At least one action enabler needed the building in its target
1598 * requirements. */
1599 cat_snprintf(buf, bufsz,
1600 /* TRANS: Help build Wonder */
1601 _("%s Makes it possible to target all cities on the "
1602 "same team with the action \'%s\'.\n"),
1603 BULLET,
1604 action_id_name_translation(act));
1605 break;
1606 case REQ_RANGE_ALLIANCE:
1607 /* At least one action enabler needed the building in its target
1608 * requirements. */
1609 cat_snprintf(buf, bufsz,
1610 /* TRANS: Help build Wonder */
1611 _("%s Makes it possible to target all cities owned by "
1612 "or allied to its owner with the action \'%s\'.\n"),
1613 BULLET,
1614 action_id_name_translation(act));
1615 break;
1616 case REQ_RANGE_WORLD:
1617 /* At least one action enabler needed the building in its target
1618 * requirements. */
1619 cat_snprintf(buf, bufsz,
1620 /* TRANS: Help build Wonder */
1621 _("%s Makes it possible to target all cities with the "
1622 "action \'%s\'.\n"),
1623 BULLET,
1624 action_id_name_translation(act));
1625 break;
1626 case REQ_RANGE_TILE:
1627 case REQ_RANGE_CADJACENT:
1628 case REQ_RANGE_ADJACENT:
1629 case REQ_RANGE_COUNT:
1630 log_error("The range %s is invalid for buildings.",
1631 req_range_name(max_range));
1632 break;
1633 }
1634 }
1635 } action_iterate_end;
1636
1637 /* Building protects against action. */
1638 action_iterate(act) {
1639 struct action *paction = action_by_number(act);
1640 /* Nothing is found yet. */
1641 bool vulnerable = FALSE;
1642 enum req_range min_range = REQ_RANGE_COUNT;
1643
1644 if (action_id_get_target_kind(act) != ATK_CITY) {
1645 /* Not relevant */
1646 continue;
1647 }
1648
1649 if (!action_is_in_use(paction)) {
1650 /* This action isn't enabled at all. */
1651 continue;
1652 }
1653
1654 if (action_by_number(act)->quiet) {
1655 /* The ruleset it self documents this action. */
1656 continue;
1657 }
1658
1659 /* Must be immune in all cases. */
1660 action_enabler_list_iterate(action_enablers_for_action(act), enabler) {
1661 if (requirement_fulfilled_by_improvement(pimprove,
1662 &(enabler->target_reqs))) {
1663 vulnerable = TRUE;
1664 break;
1665 } else {
1666 enum req_range vector_max_range = REQ_RANGE_LOCAL;
1667
1668 requirement_vector_iterate(&(enabler->target_reqs), preq) {
1669 if (!universal_is_relevant_to_requirement(preq, &source)) {
1670 /* Not relevant. */
1671 continue;
1672 }
1673
1674 if (preq->present) {
1675 /* Not what is looked for. */
1676 continue;
1677 }
1678
1679 if (preq->range > vector_max_range) {
1680 /* Found a larger range. */
1681 vector_max_range = preq->range;
1682 }
1683 } requirement_vector_iterate_end;
1684
1685 if (vector_max_range < min_range) {
1686 /* Found a smaller range. */
1687 min_range = vector_max_range;
1688 }
1689 }
1690 } action_enabler_list_iterate_end;
1691
1692 if (!vulnerable) {
1693 switch (min_range) {
1694 case REQ_RANGE_LOCAL:
1695 cat_snprintf(buf, bufsz,
1696 /* TRANS: Incite City */
1697 _("%s Makes it impossible to do the action \'%s\' to "
1698 "the city building it.\n"),
1699 BULLET,
1700 action_id_name_translation(act));
1701 break;
1702 case REQ_RANGE_CITY:
1703 cat_snprintf(buf, bufsz,
1704 /* TRANS: Incite City */
1705 _("%s Makes it impossible to do the action \'%s\' to "
1706 "its city.\n"),
1707 BULLET,
1708 action_id_name_translation(act));
1709 break;
1710 case REQ_RANGE_TRADE_ROUTE:
1711 cat_snprintf(buf, bufsz,
1712 /* TRANS: Incite City */
1713 _("%s Makes it impossible to do the action \'%s\' to "
1714 "its city or to its city's trade partners.\n"),
1715 BULLET,
1716 action_id_name_translation(act));
1717 break;
1718 case REQ_RANGE_CONTINENT:
1719 cat_snprintf(buf, bufsz,
1720 /* TRANS: Incite City */
1721 _("%s Makes it impossible to do the action \'%s\' to "
1722 "any city with its owner on its continent.\n"),
1723 BULLET,
1724 action_id_name_translation(act));
1725 break;
1726 case REQ_RANGE_PLAYER:
1727 cat_snprintf(buf, bufsz,
1728 /* TRANS: Incite City */
1729 _("%s Makes it impossible to do the action \'%s\' to "
1730 "any city with its owner.\n"),
1731 BULLET,
1732 action_id_name_translation(act));
1733 break;
1734 case REQ_RANGE_TEAM:
1735 cat_snprintf(buf, bufsz,
1736 /* TRANS: Incite City */
1737 _("%s Makes it impossible to do the action \'%s\' to "
1738 "any city on the same team.\n"),
1739 BULLET,
1740 action_id_name_translation(act));
1741 break;
1742 case REQ_RANGE_ALLIANCE:
1743 cat_snprintf(buf, bufsz,
1744 /* TRANS: Incite City */
1745 _("%s Makes it impossible to do the action \'%s\' to "
1746 "any city allied to or owned by its owner.\n"),
1747 BULLET,
1748 action_id_name_translation(act));
1749 break;
1750 case REQ_RANGE_WORLD:
1751 cat_snprintf(buf, bufsz,
1752 /* TRANS: Incite City */
1753 _("%s Makes it impossible to do the action \'%s\' to "
1754 "any city in the game.\n"),
1755 BULLET,
1756 action_id_name_translation(act));
1757 break;
1758 case REQ_RANGE_TILE:
1759 case REQ_RANGE_CADJACENT:
1760 case REQ_RANGE_ADJACENT:
1761 case REQ_RANGE_COUNT:
1762 log_error("The range %s is invalid for buildings.",
1763 req_range_name(min_range));
1764 break;
1765 }
1766 }
1767 } action_iterate_end;
1768
1769 {
1770 int i;
1771
1772 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
1773 Impr_type_id n = game.rgame.global_init_buildings[i];
1774 if (n == B_LAST) {
1775 break;
1776 } else if (improvement_by_number(n) == pimprove) {
1777 cat_snprintf(buf, bufsz,
1778 _("%s All players start with this improvement in their "
1779 "first city.\n"), BULLET);
1780 break;
1781 }
1782 }
1783 }
1784
1785 /* Assume no-one will set the same building in both global and nation
1786 * init_buildings... */
1787 nations_iterate(pnation) {
1788 int i;
1789
1790 /* Avoid mentioning nations not in current set. */
1791 if (!show_help_for_nation(pnation)) {
1792 continue;
1793 }
1794 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
1795 Impr_type_id n = pnation->init_buildings[i];
1796 if (n == B_LAST) {
1797 break;
1798 } else if (improvement_by_number(n) == pimprove) {
1799 cat_snprintf(buf, bufsz,
1800 /* TRANS: %s is a nation plural */
1801 _("%s The %s start with this improvement in their "
1802 "first city.\n"), BULLET,
1803 nation_plural_translation(pnation));
1804 break;
1805 }
1806 }
1807 } nations_iterate_end;
1808
1809 if (improvement_has_flag(pimprove, IF_SAVE_SMALL_WONDER)) {
1810 cat_snprintf(buf, bufsz,
1811 /* TRANS: don't translate 'savepalace' */
1812 _("%s If you lose the city containing this improvement, "
1813 "it will be rebuilt for free in another of your cities "
1814 "(if the 'savepalace' server setting is enabled).\n"),
1815 BULLET);
1816 }
1817
1818 if (user_text && user_text[0] != '\0') {
1819 cat_snprintf(buf, bufsz, "\n\n%s", user_text);
1820 }
1821 return buf;
1822}
1823
1824/************************************************************************/
1830 static bool utype_may_do_escape_action(const struct unit_type *utype)
1831{
1832 action_iterate(act_id) {
1833 struct action *paction = action_by_number(act_id);
1834
1835 if (action_get_actor_kind(paction) != AAK_UNIT) {
1836 /* Not relevant. */
1837 continue;
1838 }
1839
1840 if (!utype_can_do_action(utype, paction->id)) {
1841 /* Can't do it. */
1842 continue;
1843 }
1844
1845 if (utype_is_consumed_by_action(paction, utype)) {
1846 /* No escape when dead. */
1847 continue;
1848 }
1849
1850 if (paction->actor.is_unit.moves_actor == MAK_ESCAPE) {
1851 /* Survives and escapes. */
1852 return TRUE;
1853 }
1854 } action_iterate_end;
1855
1856 return FALSE;
1857}
1858
1859/************************************************************************/
1865 char *helptext_unit(char *buf, size_t bufsz, struct player *pplayer,
1866 const char *user_text, const struct unit_type *utype)
1867{
1868 bool has_vet_levels;
1869 int flagid;
1870 struct unit_class *pclass;
1871 int fuel;
1872
1873 fc_assert_ret_val(NULL != buf && 0 < bufsz && NULL != user_text, NULL);
1874
1875 if (!utype) {
1876 log_error("Unknown unit!");
1877 fc_strlcpy(buf, user_text, bufsz);
1878 return buf;
1879 }
1880
1881 has_vet_levels = utype_veteran_levels(utype) > 1;
1882
1883 buf[0] = '\0';
1884
1885 pclass = utype_class(utype);
1886 cat_snprintf(buf, bufsz,
1887 _("%s Belongs to %s unit class."),
1888 BULLET,
1889 uclass_name_translation(pclass));
1890 if (NULL != pclass->helptext) {
1891 strvec_iterate(pclass->helptext, text) {
1892 cat_snprintf(buf, bufsz, "\n%s\n", _(text));
1893 } strvec_iterate_end;
1894 } else {
1895 CATLSTR(buf, bufsz, "\n");
1896 }
1897 if (!uclass_has_flag(pclass, UCF_TERRAIN_SPEED)) {
1898 /* TRANS: indented unit class property, preserve leading spaces */
1899 CATLSTR(buf, bufsz, _(" %s Speed is not affected by terrain.\n"),
1900 BULLET);
1901 }
1902 if (!uclass_has_flag(pclass, UCF_TERRAIN_DEFENSE)) {
1903 /* TRANS: indented unit class property, preserve leading spaces */
1904 CATLSTR(buf, bufsz, _(" %s Does not get defense bonuses from terrain.\n"),
1905 BULLET);
1906 }
1907 if (!uclass_has_flag(pclass, UCF_ZOC)) {
1908 /* TRANS: indented unit class property, preserve leading spaces */
1909 CATLSTR(buf, bufsz, _(" %s Not subject to zones of control.\n"),
1910 BULLET);
1911 } else if (!utype_has_flag(utype, UTYF_IGZOC)) {
1912 /* TRANS: indented unit class property, preserve leading spaces */
1913 CATLSTR(buf, bufsz, _(" %s Subject to zones of control.\n"),
1914 BULLET);
1915 }
1916 if (uclass_has_flag(pclass, UCF_DAMAGE_SLOWS)) {
1917 /* TRANS: indented unit class property, preserve leading spaces */
1918 CATLSTR(buf, bufsz, _(" %s Slowed down while damaged.\n"), BULLET);
1919 }
1920 if (utype->defense_strength > 0) {
1921 struct universal unit_is_in_city[] = {
1922 { .kind = VUT_UTYPE, .value = { .utype = utype }},
1923 { .kind = VUT_CITYTILE, .value = { .citytile = CITYT_CENTER }},
1924 };
1925 int bonus = effect_value_from_universals(
1926 EFT_FORTIFY_DEFENSE_BONUS,
1927 unit_is_in_city, ARRAY_SIZE(unit_is_in_city));
1928
1929 if (bonus > 0) {
1930 cat_snprintf(buf, bufsz,
1931 /* TRANS: indented unit class property, preserve leading
1932 * spaces */
1933 _(" %s Gets a %d%% defensive bonus while in cities.\n"),
1934 BULLET, bonus);
1935 }
1936 }
1937 if (uclass_has_flag(pclass, UCF_UNREACHABLE)) {
1938 CATLSTR(buf, bufsz,
1939 /* TRANS: indented unit class property, preserve leading spaces */
1940 _(" %s Is unreachable. Most units cannot attack this one.\n"),
1941 BULLET);
1942 if (utype_has_flag(utype, UTYF_NEVER_PROTECTS)) {
1943 CATLSTR(buf, bufsz,
1944 /* TRANS: indented twice; preserve leading spaces */
1945 _(" %s Doesn't prevent enemy units from attacking other "
1946 "units on its tile.\n"), BULLET);
1947 }
1948 }
1949 if (uclass_has_flag(pclass, UCF_DOESNT_OCCUPY_TILE)
1950 && !utype_has_flag(utype, UTYF_CIVILIAN)) {
1951 CATLSTR(buf, bufsz,
1952 /* TRANS: indented unit class property, preserve leading spaces */
1953 _(" %s Doesn't prevent enemy cities from working the tile it's on.\n"),
1954 BULLET);
1955 }
1956 if (can_attack_non_native(utype)) {
1957 CATLSTR(buf, bufsz,
1958 /* TRANS: indented unit class property, preserve leading spaces */
1959 _(" %s Can attack units on non-native tiles.\n"), BULLET);
1960 }
1961 for (flagid = UCF_USER_FLAG_1; flagid <= UCF_LAST_USER_FLAG; flagid++) {
1962 if (uclass_has_flag(pclass, flagid)) {
1963 const char *helptxt = unit_class_flag_helptxt(flagid);
1964
1965 if (helptxt != NULL) {
1966 /* TRANS: indented unit class property, preserve leading spaces */
1967 CATLSTR(buf, bufsz, " %s %s\n", BULLET, _(helptxt));
1968 }
1969 }
1970 }
1971
1972 /* The unit's combat bonuses. Won't mention that another unit type has a
1973 * combat bonus against this unit type. Doesn't handle complex cases like
1974 * when a unit type has multiple combat bonuses of the same kind. */
1975 combat_bonus_list_iterate(utype->bonuses, cbonus) {
1976 const char *against[utype_count()];
1977 int targets = 0;
1978
1979 if (cbonus->quiet) {
1980 /* Handled in the help text of the ruleset. */
1981 continue;
1982 }
1983
1984 /* Find the unit types of the bonus targets. */
1985 unit_type_iterate(utype2) {
1986 if (utype_has_flag(utype2, cbonus->flag)) {
1987 against[targets++] = utype_name_translation(utype2);
1988 }
1989 } unit_type_iterate_end;
1990
1991 if (targets > 0) {
1992 struct astring list = ASTRING_INIT;
1993
1994 switch (cbonus->type) {
1995 case CBONUS_DEFENSE_MULTIPLIER:
1996 cat_snprintf(buf, bufsz,
1997 /* TRANS: percentage ... or-list of unit types */
1998 _("%s %d%% defense bonus if attacked by %s.\n"),
1999 BULLET,
2000 cbonus->value * 100,
2001 astr_build_or_list(&list, against, targets));
2002 break;
2003 case CBONUS_DEFENSE_DIVIDER:
2004 cat_snprintf(buf, bufsz,
2005 /* TRANS: defense divider ... or-list of unit types */
2006 _("%s Reduces target's defense to 1 / %d when "
2007 "attacking %s.\n"), BULLET,
2008 cbonus->value + 1,
2009 astr_build_or_list(&list, against, targets));
2010 break;
2011 case CBONUS_LOW_FIREPOWER:
2012 cat_snprintf(buf, bufsz,
2013 /* TRANS: or-list of unit types */
2014 _("%s Reduces target's firepower to 1 when "
2015 "attacking %s.\n"), BULLET,
2016 astr_build_and_list(&list, against, targets));
2017 break;
2018 case CBONUS_DEFENSE_MULTIPLIER_PCT:
2019 cat_snprintf(buf, bufsz,
2020 /* TRANS: percentage ... or-list of unit types */
2021 _("%s %d%% defense bonus if attacked by %s.\n"),
2022 BULLET, cbonus->value,
2023 astr_build_or_list(&list, against, targets));
2024 break;
2025 case CBONUS_DEFENSE_DIVIDER_PCT:
2026 cat_snprintf(buf, bufsz,
2027 /* TRANS: defense divider ... or-list of unit types */
2028 _("%s Reduces target's defense to 1 / %.2f when "
2029 "attacking %s.\n"), BULLET,
2030 ((float) cbonus->value + 100.0f) / 100.0f,
2031 astr_build_or_list(&list, against, targets));
2032 break;
2033 case CBONUS_SCRAMBLES_PCT:
2034 cat_snprintf(buf, bufsz,
2035 /* TRANS: percentage ... or-list of unit types */
2036 _("%s %d%% defense bonus "
2037 "instead of any bonuses from city improvements "
2038 "if attacked by %s in a city.\n"),
2039 BULLET, cbonus->value,
2040 astr_build_or_list(&list, against, targets));
2041 break;
2042 }
2043
2044 astr_free(&list);
2045 }
2046 } combat_bonus_list_iterate_end;
2047
2048 /* Add requirement text for the unit type itself */
2049 requirement_vector_iterate(&utype->build_reqs, preq) {
2050 req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT,
2051 BULLET_SPACE);
2052 } requirement_vector_iterate_end;
2053
2054 if (utype_has_flag(utype, UTYF_CANKILLESCAPING)) {
2055 CATLSTR(buf, bufsz, _("%s Can pursue escaping units and kill them.\n"),
2056 BULLET);
2057 }
2058
2059 if (utype_has_flag(utype, UTYF_NOBUILD)) {
2060 CATLSTR(buf, bufsz, _("%s May not be built in cities.\n"), BULLET);
2061 }
2062 if (utype_has_flag(utype, UTYF_BARBARIAN_ONLY)) {
2063 CATLSTR(buf, bufsz, _("%s Only barbarians may build this.\n"), BULLET);
2064 }
2065 if (utype_has_flag(utype, UTYF_NEWCITY_GAMES_ONLY)) {
2066 CATLSTR(buf, bufsz, _("%s Can only be built in games where new cities "
2067 "are allowed.\n"), BULLET);
2068 if (game.scenario.prevent_new_cities) {
2069 /* TRANS: indented; preserve leading spaces */
2070 CATLSTR(buf, bufsz, _(" %s New cities are not allowed in the current "
2071 "game.\n"), BULLET);
2072 } else {
2073 /* TRANS: indented; preserve leading spaces */
2074 CATLSTR(buf, bufsz, _(" %s New cities are allowed in the current "
2075 "game.\n"), BULLET);
2076 }
2077 }
2078 nations_iterate(pnation) {
2079 int i, count = 0;
2080
2081 /* Avoid mentioning nations not in current set. */
2082 if (!show_help_for_nation(pnation)) {
2083 continue;
2084 }
2085 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
2086 if (!pnation->init_units[i]) {
2087 break;
2088 } else if (pnation->init_units[i] == utype) {
2089 count++;
2090 }
2091 }
2092 if (count > 0) {
2093 cat_snprintf(buf, bufsz,
2094 /* TRANS: %s is a nation plural */
2095 PL_("%s The %s start the game with %d of these units.\n",
2096 "%s The %s start the game with %d of these units.\n",
2097 count), BULLET,
2098 nation_plural_translation(pnation), count);
2099 }
2100 } nations_iterate_end;
2101 {
2102 const char *types[utype_count()];
2103 int i = 0;
2104
2105 unit_type_iterate(utype2) {
2106 if (utype2->converted_to == utype
2107 && utype_can_do_action_result(utype2, ACTRES_CONVERT)) {
2108 types[i++] = utype_name_translation(utype2);
2109 }
2110 } unit_type_iterate_end;
2111 if (i > 0) {
2112 struct astring list = ASTRING_INIT;
2113
2114 astr_build_or_list(&list, types, i);
2115 cat_snprintf(buf, bufsz,
2116 /* TRANS: %s is a list of unit types separated by "or". */
2117 _("%s May be obtained by conversion of %s.\n"),
2118 BULLET, astr_str(&list));
2119 astr_free(&list);
2120 }
2121 }
2122 if (utype_has_flag(utype, UTYF_NOHOME)) {
2123 if (utype_can_do_action_result(utype, ACTRES_HOME_CITY)) {
2124 CATLSTR(buf, bufsz, _("%s Built without a home city.\n"), BULLET);
2125 } else {
2126 CATLSTR(buf, bufsz, _("%s Never has a home city.\n"), BULLET);
2127 }
2128 }
2129 if (utype_has_flag(utype, UTYF_GAMELOSS)) {
2130 CATLSTR(buf, bufsz, _("%s Losing this unit will lose you the game!\n"),
2131 BULLET);
2132 }
2133 if (utype_has_flag(utype, UTYF_UNIQUE)) {
2134 CATLSTR(buf, bufsz,
2135 _("%s Each player may only have one of this type of unit.\n"),
2136 BULLET);
2137 }
2138 for (flagid = UTYF_USER_FLAG_1 ; flagid <= UTYF_LAST_USER_FLAG; flagid++) {
2139 if (utype_has_flag(utype, flagid)) {
2140 const char *helptxt = unit_type_flag_helptxt(flagid);
2141
2142 if (helptxt != NULL) {
2143 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
2144 }
2145 }
2146 }
2147 if (utype->pop_cost > 0) {
2148 cat_snprintf(buf, bufsz,
2149 PL_("%s Costs %d population to build.\n",
2150 "%s Costs %d population to build.\n", utype->pop_cost),
2151 BULLET, utype->pop_cost);
2152 }
2153 if (0 < utype->transport_capacity) {
2154 const char *classes[uclass_count()];
2155 int i = 0;
2156 struct astring list = ASTRING_INIT;
2157
2158 unit_class_iterate(uclass) {
2159 if (can_unit_type_transport(utype, uclass)) {
2160 classes[i++] = uclass_name_translation(uclass);
2161 }
2162 } unit_class_iterate_end;
2163 astr_build_or_list(&list, classes, i);
2164
2165 cat_snprintf(buf, bufsz,
2166 /* TRANS: %s is a list of unit classes separated by "or". */
2167 PL_("%s Can carry and refuel %d %s unit.\n",
2168 "%s Can carry and refuel up to %d %s units.\n",
2169 utype->transport_capacity),
2170 BULLET, utype->transport_capacity, astr_str(&list));
2171 astr_free(&list);
2172 if (uclass_has_flag(utype_class(utype), UCF_UNREACHABLE)) {
2173 /* Document restrictions on when units can load/unload */
2174 bool has_restricted_load = FALSE, has_unrestricted_load = FALSE,
2175 has_restricted_unload = FALSE, has_unrestricted_unload = FALSE;
2176 unit_type_iterate(pcargo) {
2177 if (can_unit_type_transport(utype, utype_class(pcargo))) {
2178 if (utype_can_freely_load(pcargo, utype)) {
2179 has_unrestricted_load = TRUE;
2180 } else {
2181 has_restricted_load = TRUE;
2182 }
2183 if (utype_can_freely_unload(pcargo, utype)) {
2184 has_unrestricted_unload = TRUE;
2185 } else {
2186 has_restricted_unload = TRUE;
2187 }
2188 }
2189 } unit_type_iterate_end;
2190 if (has_restricted_load) {
2191 if (has_unrestricted_load) {
2192 /* At least one type of cargo can load onto us freely.
2193 * The specific exceptions will be documented in cargo help. */
2194 CATLSTR(buf, bufsz,
2195 /* TRANS: indented; preserve leading spaces */
2196 _(" %s Some cargo cannot be loaded except in a city or a "
2197 "base native to this transport.\n"), BULLET);
2198 } else {
2199 /* No exceptions */
2200 CATLSTR(buf, bufsz,
2201 /* TRANS: indented; preserve leading spaces */
2202 _(" %s Cargo cannot be loaded except in a city or a "
2203 "base native to this transport.\n"), BULLET);
2204 }
2205 } /* else, no restricted cargo exists; keep quiet */
2206 if (has_restricted_unload) {
2207 if (has_unrestricted_unload) {
2208 /* At least one type of cargo can unload from us freely. */
2209 CATLSTR(buf, bufsz,
2210 /* TRANS: indented; preserve leading spaces */
2211 _(" %s Some cargo cannot be unloaded except in a city or a "
2212 "base native to this transport.\n"), BULLET);
2213 } else {
2214 /* No exceptions */
2215 CATLSTR(buf, bufsz,
2216 /* TRANS: indented; preserve leading spaces */
2217 _(" %s Cargo cannot be unloaded except in a city or a "
2218 "base native to this transport.\n"), BULLET);
2219 }
2220 } /* else, no restricted cargo exists; keep quiet */
2221 }
2222 }
2223 if (utype_has_flag(utype, UTYF_COAST_STRICT)) {
2224 CATLSTR(buf, bufsz, _("%s Must stay next to safe coast.\n"), BULLET);
2225 }
2226 {
2227 /* Document exceptions to embark/disembark restrictions that we
2228 * have as cargo. */
2229 bv_unit_classes embarks, disembarks;
2230 BV_CLR_ALL(embarks);
2231 BV_CLR_ALL(disembarks);
2232 /* Determine which of our transport classes have restrictions in the first
2233 * place (that is, contain at least one transport which carries at least
2234 * one type of cargo which is restricted).
2235 * We'll suppress output for classes not in this set, since this cargo
2236 * type is not behaving exceptionally in such cases. */
2237 unit_type_iterate(utrans) {
2238 const Unit_Class_id trans_class = uclass_index(utype_class(utrans));
2239 /* Don't waste time repeating checks on classes we've already checked,
2240 * or weren't under consideration in the first place */
2241 if (!BV_ISSET(embarks, trans_class)
2242 && BV_ISSET(utype->embarks, trans_class)) {
2243 unit_type_iterate(other_cargo) {
2244 if (can_unit_type_transport(utrans, utype_class(other_cargo))
2245 && !utype_can_freely_load(other_cargo, utrans)) {
2246 /* At least one load restriction in transport class, which
2247 * we aren't subject to */
2248 BV_SET(embarks, trans_class);
2249 }
2250 } unit_type_iterate_end; /* cargo */
2251 }
2252 if (!BV_ISSET(disembarks, trans_class)
2253 && BV_ISSET(utype->disembarks, trans_class)) {
2254 unit_type_iterate(other_cargo) {
2255 if (can_unit_type_transport(utrans, utype_class(other_cargo))
2256 && !utype_can_freely_unload(other_cargo, utrans)) {
2257 /* At least one load restriction in transport class, which
2258 * we aren't subject to */
2259 BV_SET(disembarks, trans_class);
2260 }
2261 } unit_type_iterate_end; /* cargo */
2262 }
2263 } unit_class_iterate_end; /* transports */
2264
2265 if (BV_ISSET_ANY(embarks)) {
2266 /* Build list of embark exceptions */
2267 const char *eclasses[uclass_count()];
2268 int i = 0;
2269 struct astring elist = ASTRING_INIT;
2270
2271 unit_class_iterate(uclass) {
2272 if (BV_ISSET(embarks, uclass_index(uclass))) {
2273 eclasses[i++] = uclass_name_translation(uclass);
2274 }
2275 } unit_class_iterate_end;
2276 astr_build_or_list(&elist, eclasses, i);
2277 if (BV_ARE_EQUAL(embarks, disembarks)) {
2278 /* A common case: the list of disembark exceptions is identical */
2279 cat_snprintf(buf, bufsz,
2280 /* TRANS: %s is a list of unit classes separated
2281 * by "or". */
2282 _("%s May load onto and unload from %s transports even "
2283 "when underway.\n"),
2284 BULLET, astr_str(&elist));
2285 } else {
2286 cat_snprintf(buf, bufsz,
2287 /* TRANS: %s is a list of unit classes separated
2288 * by "or". */
2289 _("%s May load onto %s transports even when underway.\n"),
2290 BULLET, astr_str(&elist));
2291 }
2292 astr_free(&elist);
2293 }
2294 if (BV_ISSET_ANY(disembarks) && !BV_ARE_EQUAL(embarks, disembarks)) {
2295 /* Build list of disembark exceptions (if different from embarking) */
2296 const char *dclasses[uclass_count()];
2297 int i = 0;
2298 struct astring dlist = ASTRING_INIT;
2299
2300 unit_class_iterate(uclass) {
2301 if (BV_ISSET(disembarks, uclass_index(uclass))) {
2302 dclasses[i++] = uclass_name_translation(uclass);
2303 }
2304 } unit_class_iterate_end;
2305 astr_build_or_list(&dlist, dclasses, i);
2306 cat_snprintf(buf, bufsz,
2307 /* TRANS: %s is a list of unit classes separated
2308 * by "or". */
2309 _("%s May unload from %s transports even when underway.\n"),
2310 BULLET, astr_str(&dlist));
2311 astr_free(&dlist);
2312 }
2313 }
2314
2315 if (utype_has_flag(utype, UTYF_SPY)) {
2316 CATLSTR(buf, bufsz, _("%s Strong in diplomatic battles.\n"), BULLET);
2317 }
2318 if (utype_has_flag(utype, UTYF_DIPLOMAT)
2319 || utype_has_flag(utype, UTYF_SUPERSPY)) {
2320 CATLSTR(buf, bufsz, _("%s Defends cities against diplomatic actions.\n"),
2321 BULLET);
2322 }
2323 if (utype_has_flag(utype, UTYF_SUPERSPY)) {
2324 CATLSTR(buf, bufsz, _("%s Will never lose a diplomat-versus-diplomat fight.\n"),
2325 BULLET);
2326 }
2327 if (utype_may_do_escape_action(utype)
2328 && utype_has_flag(utype, UTYF_SUPERSPY)) {
2329 CATLSTR(buf, bufsz, _("%s Will always survive a spy mission.\n"), BULLET);
2330 }
2331 if (utype->vlayer == V_INVIS) {
2332 CATLSTR(buf, bufsz,
2333 _("%s Is invisible except when next to an enemy unit or city.\n"),
2334 BULLET);
2335 }
2336 if (utype_has_flag(utype, UTYF_ONLY_NATIVE_ATTACK)) {
2337 CATLSTR(buf, bufsz,
2338 _("%s Can only attack units on native tiles.\n"), BULLET);
2339 }
2340 if (utype_has_flag(utype, UTYF_CITYBUSTER)) {
2341 CATLSTR(buf, bufsz,
2342 _("%s Gets double firepower when attacking cities.\n"), BULLET);
2343 }
2344 if (utype_has_flag(utype, UTYF_IGTER)) {
2345 cat_snprintf(buf, bufsz,
2346 /* TRANS: "MP" = movement points. %s may have a
2347 * fractional part. */
2348 _("%s Ignores terrain effects (moving costs at most %s MP "
2349 "per tile).\n"), BULLET,
2350 move_points_text(terrain_control.igter_cost, TRUE));
2351 }
2352 if (utype_has_flag(utype, UTYF_NOZOC)) {
2353 CATLSTR(buf, bufsz, _("%s Never imposes a zone of control.\n"), BULLET);
2354 } else {
2355 CATLSTR(buf, bufsz, _("%s May impose a zone of control on its adjacent "
2356 "tiles.\n"), BULLET);
2357 }
2358 if (utype_has_flag(utype, UTYF_IGZOC)) {
2359 CATLSTR(buf, bufsz, _("%s Not subject to zones of control imposed "
2360 "by other units.\n"), BULLET);
2361 }
2362 if (utype_has_flag(utype, UTYF_CIVILIAN)) {
2363 CATLSTR(buf, bufsz,
2364 _("%s A non-military unit:\n"), BULLET);
2365 CATLSTR(buf, bufsz,
2366 /* TRANS: indented; preserve leading spaces */
2367 _(" %s Cannot attack.\n"), BULLET);
2368 CATLSTR(buf, bufsz,
2369 /* TRANS: indented; preserve leading spaces */
2370 _(" %s Doesn't impose martial law.\n"), BULLET);
2371 CATLSTR(buf, bufsz,
2372 /* TRANS: indented; preserve leading spaces */
2373 _(" %s Can enter foreign territory regardless of peace treaty.\n"),
2374 BULLET);
2375 CATLSTR(buf, bufsz,
2376 /* TRANS: indented; preserve leading spaces */
2377 _(" %s Doesn't prevent enemy cities from working the tile it's on.\n"),
2378 BULLET);
2379 }
2380 if (utype_has_flag(utype, UTYF_FIELDUNIT)) {
2381 CATLSTR(buf, bufsz,
2382 _("%s A field unit: one unhappiness applies even when non-aggressive.\n"),
2383 BULLET);
2384 }
2385 if (utype_has_flag(utype, UTYF_PROVOKING)
2386 && server_setting_value_bool_get(
2387 server_setting_by_name("autoattack"))) {
2388 CATLSTR(buf, bufsz,
2389 _("%s An enemy unit considering to auto attack this unit will "
2390 "choose to do so even if it has better odds when defending "
2391 "against it than when attacking it.\n"), BULLET);
2392 }
2393 if (utype_has_flag(utype, UTYF_SHIELD2GOLD)) {
2394 /* FIXME: the conversion shield => gold is activated if
2395 * EFT_SHIELD2GOLD_FACTOR is not equal null; how to determine
2396 * possible sources? */
2397 CATLSTR(buf, bufsz,
2398 _("%s Under certain conditions the shield upkeep of this unit can "
2399 "be converted to gold upkeep.\n"), BULLET);
2400 }
2401
2402 unit_class_iterate(target) {
2403 if (uclass_has_flag(target, UCF_UNREACHABLE)
2404 && BV_ISSET(utype->targets, uclass_index(target))) {
2405 cat_snprintf(buf, bufsz,
2406 _("%s Can attack against %s units, which are usually not "
2407 "reachable.\n"), BULLET,
2408 uclass_name_translation(target));
2409 }
2410 } unit_class_iterate_end;
2411
2412 fuel = utype_fuel(utype);
2413 if (fuel > 0) {
2414 const char *types[utype_count()];
2415 int i = 0;
2416
2417 unit_type_iterate(transport) {
2418 if (can_unit_type_transport(transport, utype_class(utype))) {
2419 types[i++] = utype_name_translation(transport);
2420 }
2421 } unit_type_iterate_end;
2422
2423 if (0 == i) {
2424 if (utype_has_flag(utype, UTYF_COAST)) {
2425 if (fuel == 1) {
2426 cat_snprintf(buf, bufsz,
2427 _("%s Unit has to end each turn next to safe coast or"
2428 " in a city or a base.\n"), BULLET);
2429 } else {
2430 cat_snprintf(buf, bufsz,
2431 /* Pluralization for the benefit of languages with
2432 * duals etc */
2433 /* TRANS: Never called for 'turns = 1' case */
2434 PL_("%s Unit has to be next to safe coast, in a city or a base"
2435 " after %d turn.\n",
2436 "%s Unit has to be next to safe coast, in a city or a base"
2437 " after %d turns.\n",
2438 fuel),
2439 BULLET, fuel);
2440 }
2441 } else {
2442 cat_snprintf(buf, bufsz,
2443 PL_("%s Unit has to be in a city or a base"
2444 " after %d turn.\n",
2445 "%s Unit has to be in a city or a base"
2446 " after %d turns.\n",
2447 fuel),
2448 BULLET, fuel);
2449 }
2450 } else {
2451 struct astring list = ASTRING_INIT;
2452
2453 if (utype_has_flag(utype, UTYF_COAST)) {
2454 cat_snprintf(buf, bufsz,
2455 /* TRANS: %s is a list of unit types separated by "or" */
2456 PL_("%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2457 " after %d turn.\n",
2458 "%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2459 " after %d turns.\n",
2460 fuel),
2461 BULLET, astr_build_or_list(&list, types, i), fuel);
2462 } else {
2463 cat_snprintf(buf, bufsz,
2464 /* TRANS: %s is a list of unit types separated by "or" */
2465 PL_("%s Unit has to be in a city, a base, or on a %s"
2466 " after %d turn.\n",
2467 "%s Unit has to be in a city, a base, or on a %s"
2468 " after %d turns.\n",
2469 fuel),
2470 BULLET, astr_build_or_list(&list, types, i), fuel);
2471 }
2472 astr_free(&list);
2473 }
2474 }
2475
2476 /* Auto attack immunity. (auto_attack.if_attacker ruleset setting) */
2477 if (server_setting_value_bool_get(
2478 server_setting_by_name("autoattack"))) {
2479 bool not_an_auto_attacker = TRUE;
2480
2481 action_auto_perf_iterate(auto_action) {
2482 if (auto_action->cause != AAPC_UNIT_MOVED_ADJ) {
2483 /* Not relevant for auto attack. */
2484 continue;
2485 }
2486
2487 if (requirement_fulfilled_by_unit_type(utype, &auto_action->reqs)) {
2488 /* Can be forced to auto attack. */
2489 not_an_auto_attacker = FALSE;
2490 break;
2491 }
2492 } action_auto_perf_iterate_end;
2493
2494 if (not_an_auto_attacker) {
2495 CATLSTR(buf, bufsz,
2496 _("%s Will never be forced (by the autoattack server setting)"
2497 " to attack units moving to an adjacent tile.\n"), BULLET);
2498 }
2499 }
2500
2501 action_iterate(act) {
2502 struct action *paction = action_by_number(act);
2503
2504 if (action_by_number(act)->quiet) {
2505 /* The ruleset documents this action it self. */
2506 continue;
2507 }
2508
2509 if (utype_can_do_action(utype, act)) {
2510 const char *target_adjective;
2511 char sub_target_text[100];
2512 const char *blockers[MAX_NUM_ACTIONS];
2513 int i = 0;
2514
2515 /* Generic action information. */
2516 cat_snprintf(buf, bufsz,
2517 /* TRANS: %s is the action's ruleset defined ui name */
2518 _("%s Can do the action \'%s\'.\n"),
2519 BULLET, action_id_name_translation(act));
2520
2521 switch (action_id_get_target_kind(act)) {
2522 case ATK_SELF:
2523 /* No target. */
2524 break;
2525 default:
2526 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2527 DRO_FOREIGN, TRUE)) {
2528 /* TRANS: describes the target of an action. */
2529 target_adjective = _("domestic ");
2530 } else if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2531 DRO_FOREIGN, FALSE)) {
2532 /* TRANS: describes the target of an action. */
2533 target_adjective = _("foreign ");
2534 } else {
2535 /* Both foreign and domestic targets are acceptable. */
2536 target_adjective = "";
2537 }
2538
2539 sub_target_text[0] = '\0';
2540 if (action_get_sub_target_kind(paction) != ASTK_NONE) {
2541 if (action_get_target_kind(paction) == ATK_EXTRAS
2542 && action_get_sub_target_kind(paction) == ASTK_EXTRA) {
2543 cat_snprintf(sub_target_text, sizeof(sub_target_text),
2544 /* TRANS: action sub target extras with tile
2545 * extras target. */
2546 _("extras among "));
2547 } else {
2548 cat_snprintf(sub_target_text, sizeof(sub_target_text),
2549 /* TRANS: action sub target kind. */
2550 _("%s "),
2551 _(action_sub_target_kind_name(
2552 action_get_sub_target_kind(paction))));
2553 }
2554 }
2555
2556 cat_snprintf(buf, bufsz,
2557 /* TRANS: First %s in %s%s%s is the sub target kind.
2558 * The next may be an adjective (that includes a space).
2559 * The next is the name of the target kind.
2560 * Example: "* is done to extras on foreign tiles." */
2561 _(" %s is done to %s%s%s.\n"), BULLET,
2562 sub_target_text,
2563 target_adjective,
2564 action_target_kind_help(action_id_get_target_kind(act)));
2565 }
2566
2567 if (utype_is_consumed_by_action(paction, utype)) {
2568 cat_snprintf(buf, bufsz,
2569 /* TRANS: said about an action. %s is a unit type
2570 * name. */
2571 _(" %s uses up the %s.\n"), BULLET,
2572 utype_name_translation(utype));
2573 }
2574
2575 if (actres_get_battle_kind(paction->result) != ABK_NONE) {
2576 cat_snprintf(buf, bufsz,
2577 /* TRANS: The %s is a kind of battle defined in
2578 * actions.h. Example: "diplomatic battle". */
2579 _(" %s can lead to a %s against a defender.\n"),
2580 BULLET,
2581 action_battle_kind_translated_name(
2582 actres_get_battle_kind(paction->result)));
2583 }
2584
2585 {
2586 struct universal req_pattern[] = {
2587 { .kind = VUT_ACTION, .value.action = paction },
2588 { .kind = VUT_UTYPE, .value.utype = utype },
2589 };
2590 int odds = action_dice_roll_initial_odds(paction);
2591
2592 if (odds != ACTION_ODDS_PCT_DICE_ROLL_NA
2593 && !effect_universals_value_never_below(EFT_ACTION_ODDS_PCT,
2594 req_pattern,
2595 ARRAY_SIZE(req_pattern),
2596 ((100 - odds) * 100
2597 / odds))) {
2598 cat_snprintf(buf, bufsz,
2599 _(" %s may fail because of a dice throw.\n"),
2600 BULLET);
2601 }
2602 }
2603
2604 if (!utype_is_consumed_by_action(paction, utype)
2605 && paction->actor.is_unit.moves_actor == MAK_ESCAPE) {
2606 cat_snprintf(buf, bufsz,
2607 /* TRANS: said about an action. %s is a unit type
2608 * name. */
2609 _(" %s the %s may be captured while trying to"
2610 " escape after completing the mission.\n"),
2611 BULLET,
2612 utype_name_translation(utype));
2613 }
2614
2615 if (utype_is_consumed_by_action(paction, utype)) {
2616 /* The dead don't care about movement loss. */
2617 } else if (utype_action_takes_all_mp(utype, paction)) {
2618 cat_snprintf(buf, bufsz,
2619 /* TRANS: Indented unit action property, preserve
2620 * leading spaces. */
2621 _(" %s ends this unit's turn.\n"),
2622 BULLET);
2623 } else if (utype_action_takes_all_mp_if_ustate_is(utype, paction,
2624 USP_NATIVE_TILE)) {
2625 /* Used in the implementation of slow_invasion in many of the
2626 * bundled rulesets and in rulesets upgraded with rscompat from 3.0
2627 * to 3.1. */
2628 cat_snprintf(buf, bufsz,
2629 /* TRANS: Indented unit action property, preserve
2630 * leading spaces. */
2631 _(" %s ending up on a native tile"
2632 " after this action has been performed"
2633 " ends this unit's turn.\n"), BULLET);
2634 }
2635
2636 if (action_id_get_target_kind(act) != ATK_SELF) {
2637 /* Distance to target is relevant. */
2638
2639 /* FIXME: move paratroopers_range to the action and remove this
2640 * variable once actions are generalized. */
2641 int relative_max = (action_has_result(paction, ACTRES_PARADROP)
2642 || action_has_result(paction,
2643 ACTRES_PARADROP_CONQUER)) ?
2644 MIN(paction->max_distance, utype->paratroopers_range) :
2645 paction->max_distance;
2646
2647 if (paction->min_distance == relative_max) {
2648 /* Only one distance to target is acceptable */
2649
2650 if (paction->min_distance == 0) {
2651 cat_snprintf(buf, bufsz,
2652 /* TRANS: distance between an actor unit and its
2653 * target when performing a specific action. */
2654 _(" %s target must be at the same tile.\n"),
2655 BULLET);
2656 } else {
2657 cat_snprintf(buf, bufsz,
2658 /* TRANS: distance between an actor unit and its
2659 * target when performing a specific action. */
2660 PL_(" %s target must be exactly %d tile away.\n",
2661 " %s target must be exactly %d tiles away.\n",
2662 paction->min_distance),
2663 BULLET, paction->min_distance);
2664 }
2665 } else if (relative_max == ACTION_DISTANCE_UNLIMITED) {
2666 /* No max distance */
2667
2668 if (paction->min_distance == 0) {
2669 cat_snprintf(buf, bufsz,
2670 /* TRANS: distance between an actor unit and its
2671 * target when performing a specific action. */
2672 _(" %s target can be anywhere.\n"), BULLET);
2673 } else {
2674 cat_snprintf(buf, bufsz,
2675 /* TRANS: distance between an actor unit and its
2676 * target when performing a specific action. */
2677 PL_(" %s target must be at least %d tile away.\n",
2678 " %s target must be at least %d tiles away.\n",
2679 paction->min_distance),
2680 BULLET, paction->min_distance);
2681 }
2682 } else if (paction->min_distance == 0) {
2683 /* No min distance */
2684
2685 cat_snprintf(buf, bufsz,
2686 /* TRANS: distance between an actor unit and its
2687 * target when performing a specific action. */
2688 PL_(" %s target can be max %d tile away.\n",
2689 " %s target can be max %d tiles away.\n",
2690 relative_max),
2691 BULLET, relative_max);
2692 } else {
2693 /* Full range. */
2694
2695 cat_snprintf(buf, bufsz,
2696 /* TRANS: distance between an actor unit and its
2697 * target when performing a specific action. */
2698 PL_(" %s target must be between %d and %d tile away.\n",
2699 " %s target must be between %d and %d tiles away.\n",
2700 relative_max),
2701 BULLET, paction->min_distance, relative_max);
2702 }
2703 }
2704
2705 /* The action may be a Casus Belli. */
2706 {
2707 const struct {
2708 const enum effect_type eft;
2709 const char *hlp_text;
2710 } casus_belli[] = {
2711 /* TRANS: ...performing this action ... Casus Belli */
2712 { EFT_CASUS_BELLI_SUCCESS, N_("successfully") },
2713 /* TRANS: ...performing this action ... Casus Belli */
2714 { EFT_CASUS_BELLI_CAUGHT, N_("getting caught before") },
2715 };
2716
2717 struct universal req_pattern[] = {
2718 { .kind = VUT_ACTION, .value.action = paction },
2719 { .kind = VUT_DIPLREL, /* value filled in later */ },
2720 };
2721
2722 /* First group by effect (currently getting caught and successfully
2723 * performing the action) */
2724 for (i = 0; i < ARRAY_SIZE(casus_belli); i++) {
2725 int diplrel;
2726
2727 /* DiplRel list of each Casus Belli size. */
2728 const char *victim_diplrel_names[DRO_LAST];
2729 const char *outrage_diplrel_names[DRO_LAST];
2730 int victim_diplrel_count = 0;
2731 int outrage_diplrel_count = 0;
2732
2733 /* Ignore Team and everything in diplrel_other. */
2734 for (diplrel = 0; diplrel < DS_NO_CONTACT; diplrel++) {
2735 int casus_belli_amount;
2736
2737 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2738 diplrel, TRUE)) {
2739 /* Can't do the action. Can't give Casus Belli. */
2740 continue;
2741 }
2742
2743 req_pattern[1].value.diplrel = diplrel;
2744 casus_belli_amount = effect_value_from_universals(
2745 casus_belli[i].eft,
2746 req_pattern, ARRAY_SIZE(req_pattern));
2747
2748 if (CASUS_BELLI_OUTRAGE <= casus_belli_amount) {
2749 outrage_diplrel_names[outrage_diplrel_count++] =
2750 diplrel_name_translation(diplrel);
2751 } else if (CASUS_BELLI_VICTIM <= casus_belli_amount) {
2752 victim_diplrel_names[victim_diplrel_count++] =
2753 diplrel_name_translation(diplrel);
2754 }
2755 }
2756
2757 /* Then group by Casus Belli size (currently victim and
2758 * international outrage) */
2759 if (outrage_diplrel_count > 0) {
2760 struct astring list = ASTRING_INIT;
2761 cat_snprintf(buf, bufsz,
2762 /* TRANS: successfully ... Peace, or Alliance */
2763 _(" %s %s performing this action during %s causes"
2764 " international outrage: the whole world gets "
2765 "Casus Belli against you.\n"), BULLET,
2766 _(casus_belli[i].hlp_text),
2767 astr_build_or_list(&list, outrage_diplrel_names,
2768 outrage_diplrel_count));
2769 astr_free(&list);
2770 }
2771 if (victim_diplrel_count > 0) {
2772 struct astring list = ASTRING_INIT;
2773 cat_snprintf(buf, bufsz,
2774 /* TRANS: successfully ... Peace, or Alliance */
2775 _(" %s %s performing this action during %s gives"
2776 " the victim Casus Belli against you.\n"),
2777 BULLET,
2778 _(casus_belli[i].hlp_text),
2779 astr_build_or_list(&list, victim_diplrel_names,
2780 victim_diplrel_count));
2781 astr_free(&list);
2782 }
2783 }
2784 }
2785
2786 /* Custom action result specific information. */
2787 switch (paction->result) {
2788 case ACTRES_HELP_WONDER:
2789 cat_snprintf(buf, bufsz,
2790 /* TRANS: the %d is the number of shields the unit can
2791 * contribute. */
2792 _(" %s adds %d production.\n"), BULLET,
2793 utype_build_shield_cost_base(utype));
2794 break;
2795 case ACTRES_HEAL_UNIT:
2796 {
2797 struct universal req_pattern[] = {
2798 { .kind = VUT_ACTION, .value.action = paction },
2799 { .kind = VUT_UTYPE, .value.utype = utype },
2800 };
2801
2802 cat_snprintf(buf, bufsz,
2803 _(" %s restores up to %d%% of the target unit's"
2804 " hit points.\n"), BULLET,
2805 effect_value_from_universals(
2806 EFT_HEAL_UNIT_PCT,
2807 req_pattern, ARRAY_SIZE(req_pattern))
2808 + 100);
2809 }
2810 break;
2811 case ACTRES_FOUND_CITY:
2812 if (game.scenario.prevent_new_cities) {
2813 cat_snprintf(buf, bufsz,
2814 /* TRANS: is talking about an action. */
2815 _(" %s is disabled in the current game.\n"),
2816 BULLET);
2817 }
2818 cat_snprintf(buf, bufsz,
2819 /* TRANS: the %d is initial population. */
2820 PL_(" %s initial population: %d.\n",
2821 " %s initial population: %d.\n",
2822 utype->city_size),
2823 BULLET, utype->city_size);
2824 break;
2825 case ACTRES_JOIN_CITY:
2826 cat_snprintf(buf, bufsz,
2827 /* TRANS: the %d is population. */
2828 PL_(" %s max target size: %d.\n",
2829 " %s max target size: %d.\n",
2830 game.info.add_to_size_limit - utype->pop_cost),
2831 BULLET, game.info.add_to_size_limit - utype->pop_cost);
2832 cat_snprintf(buf, bufsz,
2833 /* TRANS: the %d is the population added. */
2834 PL_(" %s adds %d population.\n",
2835 " %s adds %d population.\n",
2836 utype->pop_cost),
2837 BULLET, utype->pop_cost);
2838 break;
2839 case ACTRES_BOMBARD:
2840 cat_snprintf(buf, bufsz,
2841 /* TRANS: %d is bombard rate. */
2842 _(" %s %d per turn.\n"), BULLET,
2843 utype->bombard_rate);
2844 cat_snprintf(buf, bufsz,
2845 /* TRANS: talking about bombard */
2846 _(" %s Will damage all"
2847 " defenders on a tile, and have no risk for the"
2848 " attacker.\n"), BULLET);
2849 break;
2850 case ACTRES_UPGRADE_UNIT:
2851 cat_snprintf(buf, bufsz,
2852 /* TRANS: %s is a unit type. */
2853 _(" %s upgraded to %s or, when possible, to the unit "
2854 "type it upgrades to.\n"), BULLET,
2855 utype_name_translation(utype->obsoleted_by));
2856 break;
2857 case ACTRES_ATTACK:
2858 if (game.info.tired_attack) {
2859 cat_snprintf(buf, bufsz,
2860 _(" %s weaker when tired. If performed with less "
2861 "than a single move point left the attack power "
2862 "is reduced accordingly.\n"), BULLET);
2863 }
2864 break;
2865 case ACTRES_WIPE_UNITS:
2866 cat_snprintf(buf, bufsz,
2867 _(" %s can wipe stack of units with zero defense.\n"),
2868 BULLET);
2869 break;
2870 case ACTRES_CONVERT:
2871 cat_snprintf(buf, bufsz,
2872 /* TRANS: %s is a unit type. "MP" = movement points. */
2873 PL_(" %s is converted into %s (takes %d MP).\n",
2874 " %s is converted into %s (takes %d MP).\n",
2875 utype->convert_time),
2876 BULLET,
2877 utype_name_translation(utype->converted_to),
2878 utype->convert_time);
2879 break;
2880 case ACTRES_SPY_NUKE:
2881 case ACTRES_NUKE:
2882 case ACTRES_NUKE_UNITS:
2883 if (game.info.nuke_pop_loss_pct > 0) {
2884 cat_snprintf(buf, bufsz,
2885 /* TRANS: percentage */
2886 _(" %s %d%% of the population of each city inside"
2887 " the nuclear blast dies.\n"), BULLET,
2888 game.info.nuke_pop_loss_pct);
2889 if (game.info.nuke_pop_loss_pct < 50) {
2890 cat_snprintf(buf, bufsz,
2891 _(" %s can never destroy city completely "
2892 "(%d%% of size 1 rounds down to 0).\n"), BULLET,
2893 game.info.nuke_pop_loss_pct);
2894 } else {
2895 cat_snprintf(buf, bufsz,
2896 _(" %s can even destroy city completely "
2897 "(%d%% of size 1 rounds up to 1).\n"), BULLET,
2898 game.info.nuke_pop_loss_pct);
2899 }
2900 }
2901 if (game.info.nuke_defender_survival_chance_pct > 0) {
2902 cat_snprintf(buf, bufsz,
2903 _(" %s all units caught in the open by the nuclear"
2904 " blast die.\n"), BULLET);
2905 cat_snprintf(buf, bufsz,
2906 /* TRANS: percentage */
2907 _(" %s a unit caught in the nuclear blast while"
2908 " inside a city has a %d%% chance of survival.\n"),
2909 BULLET,
2910 game.info.nuke_defender_survival_chance_pct);
2911 } else {
2912 cat_snprintf(buf, bufsz,
2913 _(" %s all units caught in the nuclear blast"
2914 " die.\n"), BULLET);
2915 }
2916 {
2917 struct universal req_pattern[] = {
2918 { .kind = VUT_ACTION, .value.action = paction },
2919 { .kind = VUT_UTYPE, .value.utype = utype },
2920 };
2921
2922 int blast_radius_1 =
2923 effect_value_from_universals(EFT_NUKE_BLAST_RADIUS_1_SQ,
2924 req_pattern,
2925 ARRAY_SIZE(req_pattern));
2926
2927 cat_snprintf(buf, bufsz,
2928 _(" %s has a squared blast radius of %d.\n"),
2929 BULLET, blast_radius_1);
2930 }
2931
2932 break;
2933 case ACTRES_PLANT:
2934 case ACTRES_CULTIVATE:
2935 case ACTRES_TRANSFORM_TERRAIN:
2936 cat_snprintf(buf, bufsz,
2937 _(" %s converts target tile terrain to another"
2938 " type.\n"), BULLET);
2939 break;
2940 case ACTRES_ROAD:
2941 case ACTRES_MINE:
2942 case ACTRES_IRRIGATE:
2943 case ACTRES_BASE:
2944 {
2945 struct astring extras_and = ASTRING_INIT;
2946 struct strvec *extras_vec = strvec_new();
2947
2948 extra_type_iterate(pextra) {
2949 if (actres_creates_extra(paction->result, pextra)) {
2950 strvec_append(extras_vec, extra_name_translation(pextra));
2951 }
2952 } extra_type_iterate_end;
2953
2954 if (strvec_size(extras_vec) > 0) {
2955 strvec_to_and_list(extras_vec, &extras_and);
2956 /* TRANS: %s is list of extra types separated by ',' and 'and' */
2957 cat_snprintf(buf, bufsz, _(" %s builds %s on tiles.\n"),
2958 BULLET, astr_str(&extras_and));
2959 strvec_clear(extras_vec);
2960 }
2961
2962 strvec_destroy(extras_vec);
2963 }
2964 break;
2965 case ACTRES_CLEAN:
2966 {
2967 struct astring extras_and = ASTRING_INIT;
2968 struct strvec *extras_vec = strvec_new();
2969
2970 extra_type_iterate(pextra) {
2971 if (actres_removes_extra(paction->result, pextra)) {
2972 strvec_append(extras_vec, extra_name_translation(pextra));
2973 }
2974 } extra_type_iterate_end;
2975
2976 if (strvec_size(extras_vec) > 0) {
2977 strvec_to_and_list(extras_vec, &extras_and);
2978 /* TRANS: list of extras separated by "and" */
2979 cat_snprintf(buf, bufsz, _(" %s cleans %s from tiles.\n"),
2980 BULLET, astr_str(&extras_and));
2981 strvec_clear(extras_vec);
2982 }
2983
2984 strvec_destroy(extras_vec);
2985 }
2986 break;
2987 case ACTRES_PILLAGE:
2988 {
2989 struct astring extras_and = ASTRING_INIT;
2990 struct strvec *extras_vec = strvec_new();
2991
2992 extra_type_iterate(pextra) {
2993 if (actres_removes_extra(paction->result, pextra)) {
2994 strvec_append(extras_vec, extra_name_translation(pextra));
2995 }
2996 } extra_type_iterate_end;
2997
2998 if (strvec_size(extras_vec) > 0) {
2999 strvec_to_and_list(extras_vec, &extras_and);
3000 /* TRANS: list of extras separated by "and" */
3001 cat_snprintf(buf, bufsz, _(" %s pillages %s from tiles.\n"),
3002 BULLET, astr_str(&extras_and));
3003 strvec_clear(extras_vec);
3004 }
3005
3006 strvec_destroy(extras_vec);
3007 }
3008 break;
3009 case ACTRES_FORTIFY:
3010 {
3011 struct universal unit_is_fortified[] = {
3012 { .kind = VUT_ACTIVITY,
3013 .value = { .activity = ACTIVITY_FORTIFIED }},
3014 { .kind = VUT_UTYPE, .value = { .utype = utype }},
3015 };
3016 int bonus = effect_value_from_universals(
3017 EFT_FORTIFY_DEFENSE_BONUS,
3018 unit_is_fortified, ARRAY_SIZE(unit_is_fortified));
3019
3020 if (utype->defense_strength <= 0
3021 || (effect_cumulative_max(EFT_FORTIFY_DEFENSE_BONUS,
3022 &(struct universal){
3023 .kind = VUT_UTYPE,
3024 .value = { .utype = utype }},
3025 1)
3026 <= 0)) {
3027 cat_snprintf(buf, bufsz,
3028 /* TRANS: indented unit action property, preserve
3029 * leading spaces */
3030 _(" %s to stay put. No defensive bonus.\n"),
3031 BULLET);
3032 } else if (bonus > 0) {
3033 cat_snprintf(buf, bufsz,
3034 /* TRANS: indented unit action property, preserve
3035 * leading spaces */
3036 _(" %s granting a %d%% defensive bonus.\n"),
3037 BULLET, bonus);
3038 }
3039 }
3040 break;
3041 case ACTRES_CONQUER_EXTRAS:
3042 {
3043 const char *targets[extra_count()];
3044 int j = 0;
3045
3046 /* Extra being native one is a hard requirement
3047 * Not using unit class native_bases cache here.
3048 * Sometimes it's not initialized when we run this,
3049 * and as this is not performance critical, no point
3050 * in using it conditionally and having this only as
3051 * fallback implementation. */
3052 extra_type_by_cause_iterate(EC_BASE, pextra) {
3053 if (!is_native_extra_to_uclass(pextra, pclass)) {
3054 continue;
3055 }
3056
3057 if (!territory_claiming_base(pextra->data.base)) {
3058 continue;
3059 }
3060
3061 targets[j++] = extra_name_translation(pextra);
3062 } extra_type_by_cause_iterate_end;
3063
3064 if (j > 0) {
3065 struct astring list = ASTRING_INIT;
3066 /* TRANS: indented unit action property, preserve
3067 * leading spaces.
3068 * %s is a list of extra types separated by "and". */
3069 cat_snprintf(buf, bufsz, _(" %s done to %s.\n"),
3070 BULLET,
3071 astr_build_and_list(&list, targets, j));
3072 astr_free(&list);
3073 }
3074 }
3075 break;
3076 default:
3077 /* No action specific details. */
3078 break;
3079 }
3080
3081 /* Custom action sub result specific information. */
3082 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_ENTER)) {
3083 cat_snprintf(buf, bufsz,
3084 /* TRANS: indented unit action property, preserve
3085 * leading spaces. */
3086 _(" %s if a suitable hut is at the targetet tile it"
3087 " will be entered.\n"), BULLET);
3088 }
3089 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_FRIGHTEN)) {
3090 cat_snprintf(buf, bufsz,
3091 /* TRANS: indented unit action property, preserve
3092 * leading spaces. */
3093 _(" %s if a suitable hut is at the targetet tile it"
3094 " will be frightened.\n"), BULLET);
3095 }
3096 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_MAY_EMBARK)) {
3097 cat_snprintf(buf, bufsz,
3098 /* TRANS: indented unit action property, preserve
3099 * leading spaces.
3100 * The %s is the unit type name */
3101 _(" %s the %s may end up loaded into a transport if it"
3102 " can't survive on its own at the target tile.\n"),
3103 BULLET, utype_name_translation(utype));
3104 }
3105 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_NON_LETHAL)) {
3106 cat_snprintf(buf, bufsz,
3107 /* TRANS: talking about non lethal attacks */
3108 _(" %s These attacks will only damage (never kill)"
3109 " defenders.\n"), BULLET);
3110 }
3111
3112 i = 0;
3113 action_iterate(blocker_id) {
3114 const struct action *blocker = action_by_number(blocker_id);
3115
3116 if (!utype_can_do_action(utype, blocker->id)) {
3117 /* Can't block since never legal. */
3118 continue;
3119 }
3120
3121 if (action_would_be_blocked_by(paction, blocker)) {
3122 /* action name alone can be MAX_LEN_NAME, leave space for extra
3123 * characters */
3124 int maxlen = MAX_LEN_NAME + 16;
3125 char *quoted = fc_malloc(maxlen);
3126
3127 fc_snprintf(quoted, maxlen,
3128 /* TRANS: %s is an action that can block another. */
3129 _("\'%s\'"), action_name_translation(blocker));
3130 blockers[i] = quoted;
3131
3132 i++;
3133 }
3134 } action_iterate_end;
3135
3136 if (i > 0) {
3137 struct astring blist = ASTRING_INIT;
3138
3139 cat_snprintf(buf, bufsz,
3140 /* TRANS: %s is a list of actions separated by "or". */
3141 _(" %s can't be done if %s is legal.\n"), BULLET,
3142 astr_build_or_list(&blist, blockers, i));
3143
3144 astr_free(&blist);
3145
3146 for (; i > 0; i--) {
3147 /* The text was copied above. */
3148 free((char *)(blockers[i - 1]));
3149 }
3150 }
3151 }
3152 } action_iterate_end;
3153 action_iterate(act) {
3154 struct action *paction = action_by_number(act);
3155 bool vulnerable;
3156
3157 if (action_by_number(act)->quiet) {
3158 /* The ruleset documents this action it self. */
3159 continue;
3160 }
3161
3162 /* Not relevant */
3163 if (action_id_get_target_kind(act) != ATK_UNIT
3164 && action_id_get_target_kind(act) != ATK_UNITS
3165 && action_id_get_target_kind(act) != ATK_SELF) {
3166 continue;
3167 }
3168
3169 /* All units are immune to this since its not enabled */
3170 if (!action_is_in_use(paction)) {
3171 continue;
3172 }
3173
3174 /* Must be immune in all cases */
3175 vulnerable = FALSE;
3176 action_enabler_list_iterate(action_enablers_for_action(act), enabler) {
3177 if (requirement_fulfilled_by_unit_type(utype,
3178 &(enabler->target_reqs))) {
3179 vulnerable = TRUE;
3180 break;
3181 }
3182 } action_enabler_list_iterate_end;
3183
3184 if (!vulnerable) {
3185 cat_snprintf(buf, bufsz,
3186 _("%s Doing the action \'%s\' to this unit"
3187 " is impossible.\n"), BULLET,
3188 action_id_name_translation(act));
3189 }
3190 } action_iterate_end;
3191 if (!has_vet_levels) {
3192 /* Only mention this if the game generally does have veteran levels. */
3193 if (game.veteran->levels > 1) {
3194 CATLSTR(buf, bufsz, _("%s Will never achieve veteran status.\n"), BULLET);
3195 }
3196 } else {
3197 /* Not useful currently: */
3198#if 0
3199 /* Some units can never become veteran through combat in practice. */
3200 bool veteran_through_combat =
3201 !(!utype_can_do_action(utype, ACTION_ATTACK)
3202 && utype->defense_strength == 0);
3203#endif
3204 /* FIXME: if we knew the raise chances on the client, we could be
3205 * more specific here about whether veteran status can be acquired
3206 * through combat/missions/work. */
3207 CATLSTR(buf, bufsz, _("%s May acquire veteran status.\n"), BULLET);
3208 if (utype_veteran_has_power_bonus(utype)) {
3209 if (utype_can_do_action(utype, ACTION_ATTACK)
3210 || utype->defense_strength > 0) {
3211 CATLSTR(buf, bufsz,
3212 /* TRANS: indented; preserve leading spaces */
3213 _(" %s Veterans have increased strength in combat.\n"),
3214 BULLET);
3215 }
3216 /* SUPERSPY always wins/escapes */
3217 if (utype_has_flag(utype, UTYF_DIPLOMAT)
3218 && !utype_has_flag(utype, UTYF_SUPERSPY)) {
3219 CATLSTR(buf, bufsz,
3220 /* TRANS: indented; preserve leading spaces */
3221 _(" %s Veterans have improved chances in diplomatic "
3222 "contests.\n"), BULLET);
3223 if (utype_may_do_escape_action(utype)) {
3224 CATLSTR(buf, bufsz,
3225 /* TRANS: indented; preserve leading spaces */
3226 _(" %s Veterans are more likely to survive missions.\n"),
3227 BULLET);
3228 }
3229 }
3230 if (utype_has_flag(utype, UTYF_WORKERS)) {
3231 CATLSTR(buf, bufsz,
3232 /* TRANS: indented; preserve leading spaces */
3233 _(" %s Veterans work faster.\n"), BULLET);
3234 }
3235 }
3236 }
3237 if (strlen(buf) > 0) {
3238 CATLSTR(buf, bufsz, "\n");
3239 }
3240 if (has_vet_levels && utype->veteran) {
3241 /* The case where the unit has only a single veteran level has already
3242 * been handled above, so keep quiet here if that happens */
3243 if (insert_veteran_help(buf, bufsz, utype->veteran,
3244 _("This type of unit has its own veteran levels:"), NULL)) {
3245 CATLSTR(buf, bufsz, "\n\n");
3246 }
3247 }
3248 if (NULL != utype->helptext) {
3249 strvec_iterate(utype->helptext, text) {
3250 CATLSTR(buf, bufsz, "%s\n\n", _(text));
3251 } strvec_iterate_end;
3252 }
3253 CATLSTR(buf, bufsz, "%s", user_text);
3254
3255 return buf;
3256}
3257
3258/************************************************************************/
3263 void helptext_advance(char *buf, size_t bufsz, struct player *pplayer,
3264 const char *user_text, int i)
3265{
3266 struct astring astr = ASTRING_INIT;
3267 struct advance *vap = valid_advance_by_number(i);
3268 struct universal source = {
3269 .kind = VUT_ADVANCE,
3270 .value = {.advance = vap}
3271 };
3272 int flagid;
3273
3274 fc_assert_ret(NULL != buf && 0 < bufsz && NULL != user_text);
3275 fc_strlcpy(buf, user_text, bufsz);
3276
3277 if (NULL == vap) {
3278 log_error("Unknown tech %d.", i);
3279 return;
3280 }
3281
3282 if (game.control.num_tech_classes > 0) {
3283 if (vap->tclass == NULL) {
3284 cat_snprintf(buf, bufsz, _("Belongs to the default tech class.\n\n"));
3285 } else {
3286 cat_snprintf(buf, bufsz, _("Belongs to tech class %s.\n\n"),
3287 tech_class_name_translation(vap->tclass));
3288 }
3289 }
3290
3291 if (NULL != pplayer) {
3292 const struct research *presearch = research_get(pplayer);
3293
3294 if (research_invention_state(presearch, i) != TECH_KNOWN) {
3295 if (research_invention_state(presearch, i) == TECH_PREREQS_KNOWN) {
3296 int bulbs = research_total_bulbs_required(presearch, i, FALSE);
3297
3298 cat_snprintf(buf, bufsz,
3299 PL_("Starting now, researching %s would need %d bulb.",
3300 "Starting now, researching %s would need %d bulbs.",
3301 bulbs),
3302 advance_name_translation(vap), bulbs);
3303 } else if (research_invention_reachable(presearch, i)) {
3304 /* Split string into two to allow localization of two pluralizations. */
3305 char buf2[MAX_LEN_MSG];
3306 int bulbs = research_goal_bulbs_required(presearch, i);
3307
3308 fc_snprintf(buf2, ARRAY_SIZE(buf2),
3309 /* TRANS: appended to another sentence. Preserve the
3310 * leading space. */
3311 PL_(" The whole project will require %d bulb to complete.",
3312 " The whole project will require %d bulbs to complete.",
3313 bulbs),
3314 bulbs);
3315 cat_snprintf(buf, bufsz,
3316 /* TRANS: last %s is a sentence pluralized separately. */
3317 PL_("To research %s you need to research %d other"
3318 " technology first.%s",
3319 "To research %s you need to research %d other"
3320 " technologies first.%s",
3321 research_goal_unknown_techs(presearch, i) - 1),
3322 advance_name_translation(vap),
3323 research_goal_unknown_techs(presearch, i) - 1, buf2);
3324 } else {
3325 CATLSTR(buf, bufsz,
3326 _("You cannot research this technology."));
3327 }
3328 if (!techs_have_fixed_costs()
3329 && research_invention_reachable(presearch, i)) {
3330 CATLSTR(buf, bufsz,
3331 /* TRANS: preserve leading space */
3332 _(" This number may vary depending on what "
3333 "other players research.\n"));
3334 } else {
3335 CATLSTR(buf, bufsz, "\n");
3336 }
3337 }
3338
3339 CATLSTR(buf, bufsz, "\n");
3340 }
3341
3342 if (requirement_vector_size(&vap->research_reqs) > 0) {
3343 CATLSTR(buf, bufsz, _("Requirements to research:\n"));
3344 requirement_vector_iterate(&vap->research_reqs, preq) {
3345 (void) req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "");
3346 } requirement_vector_iterate_end;
3347 CATLSTR(buf, bufsz, "\n");
3348 }
3349
3350 insert_allows(&source, buf + strlen(buf), bufsz - strlen(buf),
3351 BULLET_SPACE);
3352
3353 {
3354 int j;
3355
3356 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3357 if (game.rgame.global_init_techs[j] == A_LAST) {
3358 break;
3359 } else if (game.rgame.global_init_techs[j] == i) {
3360 CATLSTR(buf, bufsz,
3361 _("%s All players start the game with knowledge of this "
3362 "technology.\n"), BULLET);
3363 break;
3364 }
3365 }
3366 }
3367
3368 /* Assume no-one will set the same tech in both global and nation
3369 * init_tech... */
3370 nations_iterate(pnation) {
3371 int j;
3372
3373 /* Avoid mentioning nations not in current set. */
3374 if (!show_help_for_nation(pnation)) {
3375 continue;
3376 }
3377 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3378 if (pnation->init_techs[j] == A_LAST) {
3379 break;
3380 } else if (pnation->init_techs[j] == i) {
3381 cat_snprintf(buf, bufsz,
3382 /* TRANS: %s is a nation plural */
3383 _("%s The %s start the game with knowledge of this "
3384 "technology.\n"), BULLET,
3385 nation_plural_translation(pnation));
3386 break;
3387 }
3388 }
3389 } nations_iterate_end;
3390
3391 /* Explain the effects of root_reqs. */
3392 {
3393 bv_techs roots, rootsofroots;
3394
3395 BV_CLR_ALL(roots);
3396 BV_CLR_ALL(rootsofroots);
3397 advance_root_req_iterate(vap, proot) {
3398 if (proot == vap) {
3399 /* Don't say anything at all if this tech is a self-root-req one;
3400 * assume that the ruleset help will explain how to get it. */
3401 BV_CLR_ALL(roots);
3402 break;
3403 }
3404 BV_SET(roots, advance_number(proot));
3405 if (advance_requires(proot, AR_ROOT) != proot) {
3406 /* Now find out what roots each of this tech's root_req has, so that
3407 * we can suppress them. If tech A has roots B/C, and B has root C,
3408 * it's not worth saying that A needs C, and can lead to overwhelming
3409 * lists. */
3410 /* (Special case: don't do this if the root is a self-root-req tech,
3411 * since it would appear in its own root iteration; in the scenario
3412 * where S is a self-root tech that is root for T, this would prevent
3413 * S appearing in T's help.) */
3414 /* FIXME this is quite inefficient */
3415 advance_root_req_iterate(proot, prootroot) {
3416 BV_SET(rootsofroots, advance_number(prootroot));
3417 } advance_root_req_iterate_end;
3418 }
3419 } advance_root_req_iterate_end;
3420
3421 /* Filter out all but the direct root reqs. */
3422 BV_CLR_ALL_FROM(roots, rootsofroots);
3423
3424 if (BV_ISSET_ANY(roots)) {
3425 const char *root_techs[A_LAST];
3426 size_t n_roots = 0;
3427 struct astring root_list = ASTRING_INIT;
3428
3429 advance_index_iterate(A_FIRST, root) {
3430 if (BV_ISSET(roots, root)) {
3431 root_techs[n_roots++]
3432 = advance_name_translation(advance_by_number(root));
3433 }
3434 } advance_index_iterate_end;
3435 fc_assert(n_roots > 0);
3436 cat_snprintf(buf, bufsz,
3437 /* TRANS: 'and'-separated list of techs */
3438 _("%s Only those who know %s can acquire this "
3439 "technology (by any means).\n"),
3440 BULLET,
3441 astr_build_and_list(&root_list, root_techs, n_roots));
3442 astr_free(&root_list);
3443 }
3444 }
3445
3446 if (advance_has_flag(i, TF_BONUS_TECH)) {
3447 cat_snprintf(buf, bufsz,
3448 _("%s The first player to learn %s gets"
3449 " an immediate advance.\n"), BULLET,
3450 advance_name_translation(vap));
3451 }
3452
3453 for (flagid = TECH_USER_1 ; flagid <= TECH_USER_LAST; flagid++) {
3454 if (advance_has_flag(i, flagid)) {
3455 const char *helptxt = tech_flag_helptxt(flagid);
3456
3457 if (helptxt != NULL) {
3458 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3459 }
3460 }
3461 }
3462
3463 if (game.info.tech_upkeep_style != TECH_UPKEEP_NONE) {
3464 CATLSTR(buf, bufsz,
3465 _("%s To preserve this technology for our nation some bulbs "
3466 "are needed each turn.\n"), BULLET);
3467 }
3468
3469 if (NULL != vap->helptext) {
3470 if (strlen(buf) > 0) {
3471 CATLSTR(buf, bufsz, "\n");
3472 }
3473 strvec_iterate(vap->helptext, text) {
3474 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3475 } strvec_iterate_end;
3476 }
3477
3478 astr_free(&astr);
3479}
3480
3481/************************************************************************/
3484 void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer,
3485 const char *user_text, struct terrain *pterrain)
3486{
3487 struct universal source = {
3488 .kind = VUT_TERRAIN,
3489 .value = {.terrain = pterrain}
3490 };
3491 int flagid;
3492
3493 fc_assert_ret(NULL != buf && 0 < bufsz);
3494 buf[0] = '\0';
3495
3496 if (!pterrain) {
3497 log_error("Unknown terrain!");
3498 return;
3499 }
3500
3501 insert_allows(&source, buf + strlen(buf), bufsz - strlen(buf),
3502 BULLET_SPACE);
3503 if (terrain_has_flag(pterrain, TER_NO_CITIES)) {
3504 CATLSTR(buf, bufsz,
3505 _("%s You cannot build cities on this terrain.\n"),
3506 BULLET);
3507 }
3508 if (!action_id_univs_not_blocking(ACTION_ROAD, NULL, &source)) {
3509 /* Can't build roads; only mention if ruleset has buildable roads */
3510 extra_type_by_cause_iterate(EC_ROAD, pextra) {
3511 if (pextra->buildable) {
3512 CATLSTR(buf, bufsz,
3513 _("%s Paths cannot be built on this terrain.\n"),
3514 BULLET);
3515 break;
3516 }
3517 } extra_type_by_cause_iterate_end;
3518 }
3519 if (!action_id_univs_not_blocking(ACTION_BASE, NULL, &source)) {
3520 /* Can't build bases; only mention if ruleset has buildable bases */
3521 extra_type_by_cause_iterate(EC_BASE, pextra) {
3522 if (pextra->buildable) {
3523 CATLSTR(buf, bufsz,
3524 _("%s Bases cannot be built on this terrain.\n"),
3525 BULLET);
3526 break;
3527 }
3528 } extra_type_by_cause_iterate_end;
3529 }
3530 if (terrain_has_flag(pterrain, TER_UNSAFE_COAST)
3531 && terrain_type_terrain_class(pterrain) != TC_OCEAN) {
3532 CATLSTR(buf, bufsz,
3533 _("%s The coastline of this terrain is unsafe.\n"),
3534 BULLET);
3535 }
3536 {
3537 const char *classes[uclass_count()];
3538 int i = 0;
3539
3540 unit_class_iterate(uclass) {
3541 if (is_native_to_class(uclass, pterrain, NULL)) {
3542 classes[i++] = uclass_name_translation(uclass);
3543 }
3544 } unit_class_iterate_end;
3545
3546 if (0 < i) {
3547 struct astring list = ASTRING_INIT;
3548
3549 /* TRANS: %s is a list of unit classes separated by "and". */
3550 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
3551 BULLET, astr_build_and_list(&list, classes, i));
3552 astr_free(&list);
3553 }
3554 }
3555 if (terrain_has_flag(pterrain, TER_NO_ZOC)) {
3556 CATLSTR(buf, bufsz,
3557 _("%s Units on this terrain neither impose zones of control "
3558 "nor are restricted by them.\n"), BULLET);
3559 } else {
3560 CATLSTR(buf, bufsz,
3561 _("%s Units on this terrain may impose a zone of control, or "
3562 "be restricted by one.\n"), BULLET);
3563 }
3564 for (flagid = TER_USER_1 ; flagid <= TER_USER_LAST; flagid++) {
3565 if (terrain_has_flag(pterrain, flagid)) {
3566 const char *helptxt = terrain_flag_helptxt(flagid);
3567
3568 if (helptxt != NULL) {
3569 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3570 }
3571 }
3572 }
3573
3574 if (NULL != pterrain->helptext) {
3575 if (buf[0] != '\0') {
3576 CATLSTR(buf, bufsz, "\n");
3577 }
3578 strvec_iterate(pterrain->helptext, text) {
3579 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3580 } strvec_iterate_end;
3581 }
3582 if (user_text && user_text[0] != '\0') {
3583 CATLSTR(buf, bufsz, "\n\n%s", user_text);
3584 }
3585}
3586
3587/************************************************************************/
3594 const char *helptext_road_bonus_str(const struct terrain *pterrain,
3595 const struct road_type *proad)
3596{
3597 static char str[64];
3598 bool has_effect = FALSE;
3599
3600 str[0] = '\0';
3601 output_type_iterate(o) {
3602 switch (o) {
3603 case O_FOOD:
3604 case O_SHIELD:
3605 case O_TRADE:
3606 {
3607 int bonus = proad->tile_bonus[o];
3608 int incr = proad->tile_incr_const[o];
3609
3610 if (pterrain) {
3611 incr +=
3612 proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3613 }
3614 if (str[0] != '\0') {
3615 CATLSTR(str, sizeof(str), "/");
3616 }
3617 if (incr == 0 && bonus == 0) {
3618 cat_snprintf(str, sizeof(str), "%d", incr);
3619 } else {
3620 has_effect = TRUE;
3621 if (incr != 0) {
3622 cat_snprintf(str, sizeof(str), "%+d", incr);
3623 }
3624 if (bonus != 0) {
3625 cat_snprintf(str, sizeof(str), "%+d%%", bonus);
3626 }
3627 }
3628 }
3629 break;
3630 default:
3631 /* FIXME: there's nothing actually stopping roads having gold, etc
3632 * bonuses */
3633 fc_assert(proad->tile_incr_const[o] == 0
3634 && proad->tile_incr[o] == 0
3635 && proad->tile_bonus[o] == 0);
3636 break;
3637 }
3638 } output_type_iterate_end;
3639
3640 return has_effect ? str : NULL;
3641}
3642
3643/**********************************************************************/
3649 static void extra_bonus_for_terrain(struct extra_type *pextra,
3650 struct terrain *pterrain,
3651 int *bonus)
3652{
3653 struct universal req_pattern[] = {
3654 { .kind = VUT_EXTRA, .value.extra = pextra },
3655 { .kind = VUT_TERRAIN, .value.terrain = pterrain },
3656 { .kind = VUT_OTYPE /* value filled in later */ }
3657 };
3658
3659 fc_assert_ret(bonus != NULL);
3660
3661 /* Irrigation-like food bonuses */
3662 bonus[0] = (pterrain->irrigation_food_incr
3663 * effect_value_from_universals(EFT_IRRIGATION_PCT, req_pattern,
3664 2 /* just extra+terrain */)) / 100;
3665
3666 /* Mining-like shield bonuses */
3667 bonus[1] = (pterrain->mining_shield_incr
3668 * effect_value_from_universals(EFT_MINING_PCT, req_pattern,
3669 2 /* just extra+terrain */)) / 100;
3670
3671 bonus[2] = 0; /* no trade bonuses so far */
3672
3673 /* Now add fixed bonuses from roads (but not percentage bonus) */
3674 if (extra_road_get(pextra)) {
3675 const struct road_type *proad = extra_road_get(pextra);
3676
3677 output_type_iterate(o) {
3678 switch (o) {
3679 case O_FOOD:
3680 case O_SHIELD:
3681 case O_TRADE:
3682 bonus[o] += proad->tile_incr_const[o]
3683 + proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3684 break;
3685 default:
3686 /* not dealing with other output types here */
3687 break;
3688 }
3689 } output_type_iterate_end;
3690 }
3691
3692 /* Fixed bonuses for extra, possibly unrelated to terrain type */
3693
3694 output_type_iterate(o) {
3695 /* Fill in rest of requirement template */
3696 req_pattern[2].value.outputtype = o;
3697 switch (o) {
3698 case O_FOOD:
3699 case O_SHIELD:
3700 case O_TRADE:
3701 bonus[o] += effect_value_from_universals(EFT_OUTPUT_ADD_TILE,
3702 req_pattern,
3703 ARRAY_SIZE(req_pattern));
3704 /* Any of the above bonuses is sufficient to trigger
3705 * Output_Inc_Tile, if underlying terrain does not */
3706 if (bonus[o] > 0 || pterrain->output[o] > 0) {
3707 bonus[o] += effect_value_from_universals(EFT_OUTPUT_INC_TILE,
3708 req_pattern,
3709 ARRAY_SIZE(req_pattern));
3710 }
3711 break;
3712 default:
3713 break;
3714 }
3715 } output_type_iterate_end;
3716}
3717
3718/**********************************************************************/
3724 const char *helptext_extra_for_terrain_str(struct extra_type *pextra,
3725 struct terrain *pterrain,
3726 enum unit_activity act)
3727{
3728 static char buffer[256];
3729 int btime;
3730 int bonus[3];
3731
3732 btime = terrain_extra_build_time(pterrain, act, pextra);
3733 fc_snprintf(buffer, sizeof(buffer), PL_("%d turn", "%d turns", btime),
3734 btime);
3735 extra_bonus_for_terrain(pextra, pterrain, bonus);
3736 if (bonus[0] > 0) {
3737 cat_snprintf(buffer, sizeof(buffer),
3738 PL_(", +%d food", ", +%d food", bonus[0]), bonus[0]);
3739 }
3740 if (bonus[1] > 0) {
3741 cat_snprintf(buffer, sizeof(buffer),
3742 PL_(", +%d shield", ", +%d shields", bonus[1]), bonus[1]);
3743 }
3744 if (bonus[2] > 0) {
3745 cat_snprintf(buffer, sizeof(buffer),
3746 PL_(", +%d trade", ", +%d trade", bonus[2]), bonus[2]);
3747 }
3748
3749 return buffer;
3750}
3751
3752/************************************************************************/
3758 void helptext_extra(char *buf, size_t bufsz, struct player *pplayer,
3759 const char *user_text, struct extra_type *pextra)
3760{
3761 size_t group_start;
3762 struct base_type *pbase;
3763 struct road_type *proad;
3764 struct universal source = {
3765 .kind = VUT_EXTRA,
3766 .value = {.extra = pextra}
3767 };
3768
3769 int flagid;
3770
3771 fc_assert_ret(NULL != buf && 0 < bufsz);
3772 buf[0] = '\0';
3773
3774 if (!pextra) {
3775 log_error("Unknown extra!");
3776 return;
3777 }
3778
3779 if (is_extra_caused_by(pextra, EC_BASE)) {
3780 pbase = pextra->data.base;
3781 } else {
3782 pbase = NULL;
3783 }
3784
3785 if (is_extra_caused_by(pextra, EC_ROAD)) {
3786 proad = pextra->data.road;
3787 } else {
3788 proad = NULL;
3789 }
3790
3791 if (pextra->helptext != NULL) {
3792 strvec_iterate(pextra->helptext, text) {
3793 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3794 } strvec_iterate_end;
3795 }
3796
3797 /* Describe how extra is created and destroyed */
3798
3799 group_start = strlen(buf);
3800
3801 if (pextra->buildable) {
3802 if (is_extra_caused_by(pextra, EC_IRRIGATION)) {
3803 CATLSTR(buf, bufsz,
3804 _("Build by issuing an \"irrigate\" order.\n"));
3805 }
3806 if (is_extra_caused_by(pextra, EC_MINE)) {
3807 CATLSTR(buf, bufsz,
3808 _("Build by issuing a \"mine\" order.\n"));
3809 }
3810 if (is_extra_caused_by(pextra, EC_ROAD)) {
3811 CATLSTR(buf, bufsz,
3812 _("Build by issuing a \"road\" order.\n"));
3813 }
3814 if (is_extra_caused_by(pextra, EC_BASE)) {
3815 fc_assert(pbase != NULL);
3816
3817 if (pbase->gui_type == BASE_GUI_OTHER) {
3818 cat_snprintf(buf, bufsz,
3819 _("Build by issuing a \"build base\" order.\n"));
3820 } else {
3821 const char *order = "";
3822
3823 switch (pbase->gui_type) {
3824 case BASE_GUI_FORTRESS:
3825 order = Q_(terrain_control.gui_type_base0);
3826 break;
3827 case BASE_GUI_AIRBASE:
3828 order = Q_(terrain_control.gui_type_base1);
3829 break;
3830 default:
3831 fc_assert(FALSE);
3832 break;
3833 }
3834 cat_snprintf(buf, bufsz,
3835 /* TRANS: %s is a gui_type base string from a ruleset */
3836 _("Build by issuing a \"%s\" order.\n"), order);
3837 }
3838 }
3839 }
3840
3841 if (is_extra_caused_by(pextra, EC_POLLUTION)) {
3842 CATLSTR(buf, bufsz,
3843 _("May randomly appear around polluting city.\n"));
3844 }
3845
3846 if (is_extra_caused_by(pextra, EC_FALLOUT)) {
3847 CATLSTR(buf, bufsz,
3848 _("May randomly appear around nuclear blast.\n"));
3849 }
3850
3851 if (pextra->generated
3852 && (is_extra_caused_by(pextra, EC_HUT)
3853 || is_extra_caused_by(pextra, EC_RESOURCE)
3854 || (proad != NULL && road_has_flag(proad, RF_RIVER)))) {
3855 CATLSTR(buf, bufsz,
3856 _("Placed by map generator.\n"));
3857 }
3858
3859 if (is_extra_removed_by(pextra, ERM_ENTER)) {
3860 CATLSTR(buf, bufsz,
3861 _("Can be explored by certain units.\n"));
3862 }
3863
3864 if (is_extra_caused_by(pextra, EC_APPEARANCE)) {
3865 CATLSTR(buf, bufsz,
3866 _("May appear spontaneously.\n"));
3867 }
3868
3869 if (requirement_vector_size(&pextra->reqs) > 0) {
3870 char reqsbuf[8192] = "";
3871 bool buildable = pextra->buildable
3872 && is_extra_caused_by_worker_action(pextra);
3873
3874 requirement_vector_iterate(&pextra->reqs, preq) {
3875 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
3876 VERB_DEFAULT,
3877 buildable ? BULLET_SPACE : "");
3878 } requirement_vector_iterate_end;
3879 if (reqsbuf[0] != '\0') {
3880 if (buildable) {
3881 CATLSTR(buf, bufsz, _("Requirements to build:\n"));
3882 }
3883 CATLSTR(buf, bufsz, "%s", reqsbuf);
3884 }
3885 }
3886
3887 if (pextra->infracost > 0) {
3888 cat_snprintf(buf, bufsz, _("Cost: %d\n"), pextra->infracost);
3889 }
3890
3891 if (buf[group_start] != '\0') {
3892 CATLSTR(buf, bufsz, "\n"); /* group separator */
3893 }
3894
3895 group_start = strlen(buf);
3896
3897 if (is_extra_removed_by(pextra, ERM_PILLAGE)) {
3898 int pillage_time = -1;
3899
3900 if (pextra->removal_time != 0) {
3901 pillage_time = pextra->removal_time;
3902 } else {
3903 terrain_type_iterate(pterrain) {
3904 int terr_pillage_time = pterrain->pillage_time
3905 * pextra->removal_time_factor;
3906
3907 if (terr_pillage_time != 0) {
3908 if (pillage_time < 0) {
3909 pillage_time = terr_pillage_time;
3910 } else if (pillage_time != terr_pillage_time) {
3911 /* Give up */
3912 pillage_time = -1;
3913 break;
3914 }
3915 }
3916 } terrain_type_iterate_end;
3917 }
3918 if (pillage_time < 0) {
3919 CATLSTR(buf, bufsz,
3920 _("Can be pillaged by units (time is terrain-dependent).\n"));
3921 } else if (pillage_time > 0) {
3922 cat_snprintf(buf, bufsz,
3923 PL_("Can be pillaged by units (takes %d turn).\n",
3924 "Can be pillaged by units (takes %d turns).\n",
3925 pillage_time), pillage_time);
3926 }
3927 }
3928 if (is_extra_removed_by(pextra, ERM_CLEAN)) {
3929 int clean_time = -1;
3930
3931 if (pextra->removal_time != 0) {
3932 clean_time = pextra->removal_time;
3933 } else {
3934 terrain_type_iterate(pterrain) {
3935 int terr_clean_time = -1;
3936 int rmtime = pterrain->extra_removal_times[extra_index(pextra)];
3937
3938 if (rmtime != 0) {
3939 terr_clean_time = rmtime * pextra->removal_time_factor;
3940 }
3941
3942 if (clean_time < 0) {
3943 clean_time = terr_clean_time;
3944 } else if (clean_time != terr_clean_time) {
3945 /* Give up */
3946 clean_time = -1;
3947 break;
3948 }
3949 } terrain_type_iterate_end;
3950 }
3951
3952 if (clean_time < 0) {
3953 CATLSTR(buf, bufsz,
3954 _("Can be cleaned by units (time is terrain-dependent).\n"));
3955 } else if (clean_time > 0) {
3956 cat_snprintf(buf, bufsz,
3957 PL_("Can be cleaned by units (takes %d turn).\n",
3958 "Can be cleaned by units (takes %d turns).\n",
3959 clean_time), clean_time);
3960 }
3961 }
3962
3963 if (requirement_vector_size(&pextra->rmreqs) > 0) {
3964 char reqsbuf[8192] = "";
3965
3966 requirement_vector_iterate(&pextra->rmreqs, preq) {
3967 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
3968 VERB_DEFAULT, BULLET_SPACE);
3969 } requirement_vector_iterate_end;
3970 if (reqsbuf[0] != '\0') {
3971 CATLSTR(buf, bufsz, _("Requirements to remove:\n"));
3972 CATLSTR(buf, bufsz, "%s", reqsbuf);
3973 }
3974 }
3975
3976 if (buf[group_start] != '\0') {
3977 CATLSTR(buf, bufsz, "\n"); /* group separator */
3978 }
3979
3980 /* Describe what other elements are enabled by extra */
3981
3982 group_start = strlen(buf);
3983
3984 insert_allows(&source, buf + strlen(buf), bufsz - strlen(buf), "");
3985
3986 if (buf[group_start] != '\0') {
3987 CATLSTR(buf, bufsz, "\n"); /* group separator */
3988 }
3989
3990 /* Describe other properties of extras */
3991
3992 if (pextra->visibility_req != A_NONE) {
3993 char vrbuf[1024];
3994
3995 fc_snprintf(vrbuf, sizeof(vrbuf),
3996 _("%s Visible only if %s known.\n"), BULLET,
3997 advance_name_translation(advance_by_number(pextra->visibility_req)));
3998 CATLSTR(buf, bufsz, "%s", vrbuf);
3999 }
4000
4001 if (pextra->eus == EUS_HIDDEN) {
4002 CATLSTR(buf, bufsz,
4003 _("%s Units inside are hidden from non-allied players.\n"),
4004 BULLET);
4005 }
4006
4007 {
4008 const char *classes[uclass_count()];
4009 int i = 0;
4010
4011 unit_class_iterate(uclass) {
4012 if (is_native_extra_to_uclass(pextra, uclass)) {
4013 classes[i++] = uclass_name_translation(uclass);
4014 }
4015 } unit_class_iterate_end;
4016
4017 if (0 < i) {
4018 struct astring list = ASTRING_INIT;
4019
4020 if (proad != NULL) {
4021 /* TRANS: %s is a list of unit classes separated by "and". */
4022 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
4023 BULLET,
4024 astr_build_and_list(&list, classes, i));
4025 } else {
4026 /* TRANS: %s is a list of unit classes separated by "and". */
4027 cat_snprintf(buf, bufsz, _("%s Native to %s units.\n"),
4028 BULLET,
4029 astr_build_and_list(&list, classes, i));
4030 }
4031 astr_free(&list);
4032
4033 if (extra_has_flag(pextra, EF_NATIVE_TILE)) {
4034 CATLSTR(buf, bufsz,
4035 /* TRANS: indented; preserve leading spaces */
4036 _(" %s Such units can move onto this tile even if it would "
4037 "not normally be suitable terrain.\n"), BULLET);
4038 }
4039
4040 if (pextra->no_aggr_near_city >= 0) {
4041 CATLSTR(buf, bufsz,
4042 /* TRANS: indented; preserve leading spaces */
4043 PL_(" %s Such units situated here are not considered aggressive "
4044 "if this tile is within %d tile of a friendly city.\n",
4045 " %s Such units situated here are not considered aggressive "
4046 "if this tile is within %d tiles of a friendly city.\n",
4047 pextra->no_aggr_near_city),
4048 BULLET, pextra->no_aggr_near_city);
4049 }
4050
4051 if (pextra->defense_bonus) {
4052 cat_snprintf(buf, bufsz,
4053 /* TRANS: indented; preserve leading spaces */
4054 _(" %s Such units get a %d%% defense bonus on this "
4055 "tile.\n"), BULLET,
4056 pextra->defense_bonus);
4057 }
4058 }
4059 }
4060
4061 if (pbase != NULL && territory_claiming_base(pbase)) {
4062 const char *conquerors[utype_count()];
4063 int i = 0;
4064
4065 unit_type_iterate(ut) {
4066 if (utype_can_do_action_result(ut, ACTRES_CONQUER_EXTRAS)
4067 && is_native_extra_to_uclass(pextra, utype_class(ut))) {
4068 conquerors[i++] = utype_name_translation(ut);
4069 }
4070 } unit_type_iterate_end;
4071
4072 if (i > 0) {
4073 struct astring list = ASTRING_INIT;
4074 cat_snprintf(buf, bufsz,
4075 /* TRANS: %s is a list of unit types separated by "and". */
4076 _("%s Can be conquered by %s.\n"), BULLET,
4077 astr_build_and_list(&list, conquerors, i));
4078 astr_free(&list);
4079 }
4080 }
4081
4082 if (proad != NULL && road_provides_move_bonus(proad)) {
4083 if (proad->move_cost == 0) {
4084 CATLSTR(buf, bufsz, _("%s Allows infinite movement.\n"), BULLET);
4085 } else {
4086 cat_snprintf(buf, bufsz,
4087 /* TRANS: "MP" = movement points. Second %s may have a
4088 * fractional part. */
4089 _("%s Movement cost along %s is %s MP.\n"),
4090 BULLET,
4091 extra_name_translation(pextra),
4092 move_points_text(proad->move_cost, TRUE));
4093 }
4094 }
4095
4096 if (game.info.killstack
4097 && extra_has_flag(pextra, EF_NO_STACK_DEATH)) {
4098 CATLSTR(buf, bufsz,
4099 _("%s Defeat of one unit does not cause death of all other units "
4100 "on this tile.\n"), BULLET);
4101 }
4102 if (pbase != NULL) {
4103 if (territory_claiming_base(pbase)) {
4104 CATLSTR(buf, bufsz,
4105 _("%s Extends national borders of the building nation.\n"),
4106 BULLET);
4107 }
4108 if (pbase->vision_main_sq >= 0) {
4109 CATLSTR(buf, bufsz,
4110 _("%s Grants permanent vision of an area around the tile to "
4111 "its owner.\n"), BULLET);
4112 }
4113 if (pbase->vision_invis_sq >= 0) {
4114 CATLSTR(buf, bufsz,
4115 _("%s Allows the owner to see normally invisible stealth units "
4116 "in an area around the tile.\n"), BULLET);
4117 }
4118 if (pbase->vision_subs_sq >= 0) {
4119 CATLSTR(buf, bufsz,
4120 _("%s Allows the owner to see normally invisible subsurface units "
4121 "in an area around the tile.\n"), BULLET);
4122 }
4123 }
4124 for (flagid = EF_USER_FLAG_1; flagid <= EF_LAST_USER_FLAG; flagid++) {
4125 if (extra_has_flag(pextra, flagid)) {
4126 const char *helptxt = extra_flag_helptxt(flagid);
4127
4128 if (helptxt != NULL) {
4129 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
4130 }
4131 }
4132 }
4133
4134 /* Table of terrain-specific attributes, if needed */
4135 if (proad != NULL || pbase != NULL) {
4136 bool road, do_time, do_bonus;
4137
4138 road = (proad != NULL);
4139 /* Terrain-dependent build time? */
4140 do_time = pextra->buildable && pextra->build_time == 0;
4141 if (road) {
4142 /* Terrain-dependent output bonus? */
4143 do_bonus = FALSE;
4144 output_type_iterate(o) {
4145 if (proad->tile_incr[o] > 0) {
4146 do_bonus = TRUE;
4147 fc_assert(o == O_FOOD || o == O_SHIELD || o == O_TRADE);
4148 }
4149 } output_type_iterate_end;
4150 } else {
4151 /* Bases don't have output bonuses */
4152 do_bonus = FALSE;
4153 }
4154
4155 if (do_time || do_bonus) {
4156 if (do_time && do_bonus) {
4157 CATLSTR(buf, bufsz,
4158 _("\nTime to build and output bonus depends on terrain:\n\n"));
4159 CATLSTR(buf, bufsz,
4160 /* TRANS: Header for fixed-width road properties table.
4161 * TRANS: Translators cannot change column widths :( */
4162 _("Terrain Time Bonus F/P/T\n"
4163 "----------------------------------\n"));
4164 } else if (do_time) {
4165 CATLSTR(buf, bufsz,
4166 _("\nTime to build depends on terrain:\n\n"));
4167 CATLSTR(buf, bufsz,
4168 /* TRANS: Header for fixed-width extra properties table.
4169 * TRANS: Translators cannot change column widths :( */
4170 _("Terrain Time\n"
4171 "------------------\n"));
4172 } else {
4173 fc_assert(do_bonus);
4174 CATLSTR(buf, bufsz,
4175 /* TRANS: Header for fixed-width road properties table.
4176 * TRANS: Translators cannot change column widths :( */
4177 _("\nYields an output bonus with some terrains:\n\n"));
4178 CATLSTR(buf, bufsz,
4179 _("Terrain Bonus F/P/T\n"
4180 "-------------------------\n"));
4181 }
4182 terrain_type_iterate(t) {
4183 int turns = road ? terrain_extra_build_time(t, ACTIVITY_GEN_ROAD, pextra)
4184 : terrain_extra_build_time(t, ACTIVITY_BASE, pextra);
4185 const char *bonus_text
4186 = road ? helptext_road_bonus_str(t, proad) : NULL;
4187 if (turns > 0 || bonus_text) {
4188 const char *terrain = terrain_name_translation(t);
4189 int slen = 12 - (int)get_internal_string_length(terrain);
4190
4191 cat_snprintf(buf, bufsz,
4192 "%s%*s ", terrain,
4193 MAX(0, slen),
4194 "");
4195 if (do_time) {
4196 if (turns > 0) {
4197 cat_snprintf(buf, bufsz, "%3d ", turns);
4198 } else {
4199 CATLSTR(buf, bufsz, " - ");
4200 }
4201 }
4202 if (do_bonus) {
4203 fc_assert(proad != NULL);
4204 cat_snprintf(buf, bufsz, " %s", bonus_text ? bonus_text : "-");
4205 }
4206 CATLSTR(buf, bufsz, "\n");
4207 }
4208 } terrain_type_iterate_end;
4209 } /* else rely on client-specific display */
4210 }
4211
4212 if (user_text && user_text[0] != '\0') {
4213 CATLSTR(buf, bufsz, "\n\n%s", user_text);
4214 }
4215}
4216
4217/************************************************************************/
4223 void helptext_goods(char *buf, size_t bufsz, struct player *pplayer,
4224 const char *user_text, struct goods_type *pgood)
4225{
4226 bool reqs = FALSE;
4227
4228 fc_assert_ret(NULL != buf && 0 < bufsz);
4229 buf[0] = '\0';
4230
4231 if (NULL != pgood->helptext) {
4232 strvec_iterate(pgood->helptext, text) {
4233 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4234 } strvec_iterate_end;
4235 }
4236
4237 if (pgood->onetime_pct == 0) {
4238 cat_snprintf(buf, bufsz,
4239 _("There's no bonuses paid when trade route gets established.\n\n"));
4240 } else if (pgood->onetime_pct != 100) {
4241 cat_snprintf(buf, bufsz,
4242 _("When trade route gets established, %d%% of the normal bonus is paid.\n"),
4243 pgood->onetime_pct);
4244 }
4245 cat_snprintf(buf, bufsz, _("Sending city enjoys %d%% income from the route.\n"),
4246 pgood->from_pct);
4247 cat_snprintf(buf, bufsz, _("Receiving city enjoys %d%% income from the route.\n\n"),
4248 pgood->to_pct);
4249
4250 /* Requirements for this good. */
4251 requirement_vector_iterate(&pgood->reqs, preq) {
4252 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4253 reqs = TRUE;
4254 }
4255 } requirement_vector_iterate_end;
4256 if (reqs) {
4257 fc_strlcat(buf, "\n", bufsz);
4258 }
4259
4260 CATLSTR(buf, bufsz, "%s", user_text);
4261}
4262
4263/************************************************************************/
4269 void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer,
4270 const char *user_text, struct specialist *pspec)
4271{
4272 bool reqs = FALSE;
4273
4274 fc_assert_ret(NULL != buf && 0 < bufsz);
4275 buf[0] = '\0';
4276
4277 if (NULL != pspec->helptext) {
4278 strvec_iterate(pspec->helptext, text) {
4279 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4280 } strvec_iterate_end;
4281 }
4282
4283 /* Requirements for this specialist. */
4284 requirement_vector_iterate(&pspec->reqs, preq) {
4285 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4286 reqs = TRUE;
4287 }
4288 } requirement_vector_iterate_end;
4289 if (reqs) {
4290 fc_strlcat(buf, "\n", bufsz);
4291 }
4292
4293 CATLSTR(buf, bufsz, "%s", user_text);
4294}
4295
4296/************************************************************************/
4304 void helptext_government(char *buf, size_t bufsz, struct player *pplayer,
4305 const char *user_text, struct government *gov)
4306{
4307 bool reqs = FALSE;
4308 struct universal source = {
4309 .kind = VUT_GOVERNMENT,
4310 .value = {.govern = gov}
4311 };
4312
4313 fc_assert_ret(NULL != buf && 0 < bufsz);
4314 buf[0] = '\0';
4315
4316 if (NULL != gov->helptext) {
4317 strvec_iterate(gov->helptext, text) {
4318 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4319 } strvec_iterate_end;
4320 }
4321
4322 /* Add requirement text for government itself */
4323 requirement_vector_iterate(&gov->reqs, preq) {
4324 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4325 reqs = TRUE;
4326 }
4327 } requirement_vector_iterate_end;
4328 if (reqs) {
4329 fc_strlcat(buf, "\n", bufsz);
4330 }
4331
4332 /* Effects */
4333 CATLSTR(buf, bufsz, _("Features:\n"));
4334 insert_allows(&source, buf + strlen(buf), bufsz - strlen(buf),
4335 BULLET_SPACE);
4336 effect_list_iterate(get_req_source_effects(&source), peffect) {
4337 Output_type_id output_type = O_LAST;
4338 struct unit_class *unitclass = NULL;
4339 const struct unit_type *unittype = NULL;
4340 enum unit_type_flag_id unitflag = unit_type_flag_id_invalid();
4341 struct strvec *outputs = strvec_new();
4342 struct astring outputs_or = ASTRING_INIT;
4343 struct astring outputs_and = ASTRING_INIT;
4344 bool too_complex = FALSE;
4345 bool world_value_valid = TRUE;
4346
4347 /* Grab output type, if there is one */
4348 requirement_vector_iterate(&peffect->reqs, preq) {
4349 /* Treat an effect with any negated requirements as too complex for
4350 * us to explain here.
4351 * Also don't try to explain an effect with any requirements explicitly
4352 * marked as 'quiet' by ruleset author. */
4353 if (!preq->present || preq->quiet) {
4354 too_complex = TRUE;
4355 continue;
4356 }
4357 switch (preq->source.kind) {
4358 case VUT_OTYPE:
4359 /* We should never have multiple outputtype requirements
4360 * in one list in the first place (it simply makes no sense,
4361 * output cannot be of multiple types)
4362 * Ruleset loading code should check against that. */
4363 fc_assert(output_type == O_LAST);
4364 output_type = preq->source.value.outputtype;
4365 strvec_append(outputs, get_output_name(output_type));
4366 break;
4367 case VUT_UCLASS:
4368 fc_assert(unitclass == NULL);
4369 unitclass = preq->source.value.uclass;
4370 /* FIXME: can't easily get world bonus for unit class */
4371 world_value_valid = FALSE;
4372 break;
4373 case VUT_UTYPE:
4374 fc_assert(unittype == NULL);
4375 unittype = preq->source.value.utype;
4376 break;
4377 case VUT_UTFLAG:
4378 if (!unit_type_flag_id_is_valid(unitflag)) {
4379 unitflag = preq->source.value.unitflag;
4380 /* FIXME: can't easily get world bonus for unit type flag */
4381 world_value_valid = FALSE;
4382 } else {
4383 /* Already have a unit flag requirement. More than one is too
4384 * complex for us to explain, so say nothing. */
4385 /* FIXME: we could handle this */
4386 too_complex = TRUE;
4387 }
4388 break;
4389 case VUT_GOVERNMENT:
4390 /* This is government we are generating helptext for.
4391 * ...or if not, it's ruleset bug that should never make it
4392 * this far. Fix ruleset loading code. */
4393 fc_assert(preq->source.value.govern == gov);
4394 break;
4395 default:
4396 too_complex = TRUE;
4397 world_value_valid = FALSE;
4398 break;
4399 };
4400 } requirement_vector_iterate_end;
4401
4402 if (!too_complex) {
4403 /* Only list effects that don't have extra requirements too complex
4404 * for us to handle.
4405 * Anything more complicated will have to be documented by hand by the
4406 * ruleset author. */
4407
4408 /* Guard condition for simple player-wide effects descriptions.
4409 * (FIXME: in many cases, e.g. EFT_MAKE_CONTENT, additional requirements
4410 * like unittype will be ignored for gameplay, but will affect our
4411 * help here.) */
4412 const bool playerwide
4413 = world_value_valid && !unittype && (output_type == O_LAST);
4414 /* In some cases we give absolute values (world bonus + gov bonus).
4415 * We assume the fact that there's an effect with a gov requirement
4416 * is sufficient reason to list it in that gov's help.
4417 * Guard accesses to these with 'playerwide' or 'world_value_valid'. */
4418 int world_value = -999, net_value = -999;
4419 if (world_value_valid) {
4420 /* Get government-independent world value of effect if the extra
4421 * requirements were simple enough. */
4422 struct output_type *potype =
4423 output_type != O_LAST ? get_output_type(output_type) : NULL;
4424
4425 world_value =
4426 get_target_bonus_effects(NULL,
4427 &(const struct req_context) {
4428 .unittype = unittype,
4429 .output = potype,
4430 },
4431 NULL,
4432 peffect->type);
4433 net_value = peffect->value + world_value;
4434 }
4435
4436 if (output_type == O_LAST) {
4437 /* There was no outputtype requirement. Effect is active for all
4438 * output types. Generate lists for that. */
4439 bool harvested_only = TRUE; /* Consider only output types from fields */
4440
4441 if (peffect->type == EFT_UPKEEP_FACTOR
4442 || peffect->type == EFT_UNIT_UPKEEP_FREE_PER_CITY
4443 || peffect->type == EFT_OUTPUT_BONUS
4444 || peffect->type == EFT_OUTPUT_BONUS_2) {
4445 /* Effect can use or require any kind of output */
4446 harvested_only = FALSE;
4447 }
4448
4449 output_type_iterate(ot) {
4450 struct output_type *pot = get_output_type(ot);
4451
4452 if (!harvested_only || pot->harvested) {
4453 strvec_append(outputs, _(pot->name));
4454 }
4455 } output_type_iterate_end;
4456 }
4457
4458 if (0 == strvec_size(outputs)) {
4459 /* TRANS: Empty output type list, should never happen. */
4460 astr_set(&outputs_or, "%s", Q_("?outputlist: Nothing "));
4461 astr_set(&outputs_and, "%s", Q_("?outputlist: Nothing "));
4462 } else {
4463 strvec_to_or_list(outputs, &outputs_or);
4464 strvec_to_and_list(outputs, &outputs_and);
4465 }
4466
4467 switch (peffect->type) {
4468 case EFT_UNHAPPY_FACTOR:
4469 if (playerwide) {
4470 /* FIXME: EFT_MAKE_CONTENT_MIL_PER would cancel this out. We assume
4471 * no-one will set both, so we don't bother handling it. */
4472 cat_snprintf(buf, bufsz,
4473 PL_("%s Military units away from home and field units"
4474 " will each cause %d citizen to become unhappy.\n",
4475 "%s Military units away from home and field units"
4476 " will each cause %d citizens to become unhappy.\n",
4477 net_value),
4478 BULLET, net_value);
4479 } /* else too complicated or silly ruleset */
4480 break;
4481 case EFT_ENEMY_CITIZEN_UNHAPPY_PCT:
4482 if (playerwide && net_value != world_value) {
4483 if (world_value > 0) {
4484 if (net_value > 0) {
4485 cat_snprintf(buf, bufsz,
4486 _("%s Unhappiness from foreign citizens due to "
4487 "war with their home state is %d%% the usual "
4488 "value.\n"), BULLET,
4489 (net_value * 100) / world_value);
4490 } else {
4491 CATLSTR(buf, bufsz,
4492 _("%s No unhappiness from foreign citizens even when "
4493 "at war with their home state.\n"), BULLET);
4494 }
4495 } else {
4496 cat_snprintf(buf, bufsz,
4497 /* TRANS: not pluralised as gettext doesn't support
4498 * fractional numbers, which this might be */
4499 _("%s Each foreign citizen causes %.2g unhappiness "
4500 "in their city while you are at war with their "
4501 "home state.\n"), BULLET,
4502 (double)net_value / 100);
4503 }
4504 }
4505 break;
4506 case EFT_MAKE_CONTENT_MIL:
4507 if (playerwide) {
4508 cat_snprintf(buf, bufsz,
4509 PL_("%s Each of your cities will avoid %d unhappiness"
4510 " caused by units.\n",
4511 "%s Each of your cities will avoid %d unhappiness"
4512 " caused by units.\n",
4513 peffect->value),
4514 BULLET, peffect->value);
4515 }
4516 break;
4517 case EFT_MAKE_CONTENT:
4518 if (playerwide) {
4519 cat_snprintf(buf, bufsz,
4520 PL_("%s Each of your cities will avoid %d unhappiness,"
4521 " not including that caused by aggression.\n",
4522 "%s Each of your cities will avoid %d unhappiness,"
4523 " not including that caused by aggression.\n",
4524 peffect->value),
4525 BULLET, peffect->value);
4526 }
4527 break;
4528 case EFT_FORCE_CONTENT:
4529 if (playerwide) {
4530 cat_snprintf(buf, bufsz,
4531 PL_("%s Each of your cities will avoid %d unhappiness,"
4532 " including that caused by aggression.\n",
4533 "%s Each of your cities will avoid %d unhappiness,"
4534 " including that caused by aggression.\n",
4535 peffect->value),
4536 BULLET, peffect->value);
4537 }
4538 break;
4539 case EFT_UPKEEP_FACTOR:
4540 if (world_value_valid && !unittype) {
4541 if (net_value == 0) {
4542 if (output_type != O_LAST) {
4543 cat_snprintf(buf, bufsz,
4544 /* TRANS: %s is the output type, like 'shield'
4545 * or 'gold'. */
4546 _("%s You pay no %s upkeep for your units.\n"),
4547 BULLET, astr_str(&outputs_or));
4548 } else {
4549 CATLSTR(buf, bufsz,
4550 _("%s You pay no upkeep for your units.\n"),
4551 BULLET);
4552 }
4553 } else if (net_value != world_value) {
4554 double ratio = (double)net_value / world_value;
4555 if (output_type != O_LAST) {
4556 cat_snprintf(buf, bufsz,
4557 /* TRANS: %s is the output type, like 'shield'
4558 * or 'gold'. */
4559 _("%s You pay %.2g times normal %s upkeep for your "
4560 "units.\n"), BULLET,
4561 ratio, astr_str(&outputs_and));
4562 } else {
4563 cat_snprintf(buf, bufsz,
4564 _("%s You pay %.2g times normal upkeep for your "
4565 "units.\n"), BULLET,
4566 ratio);
4567 }
4568 } /* else this effect somehow has no effect; keep quiet */
4569 } /* else there was some extra condition making it complicated */
4570 break;
4571 case EFT_UNIT_UPKEEP_FREE_PER_CITY:
4572 if (!unittype) {
4573 if (output_type != O_LAST) {
4574 cat_snprintf(buf, bufsz,
4575 /* TRANS: %s is the output type, like 'shield' or
4576 * 'gold'; pluralised in %d but there is currently
4577 * no way to control the singular/plural name of the
4578 * output type; sorry */
4579 PL_("%s Each of your cities will avoid paying %d %s"
4580 " upkeep for your units.\n",
4581 "%s Each of your cities will avoid paying %d %s"
4582 " upkeep for your units.\n", peffect->value),
4583 BULLET,
4584 peffect->value, astr_str(&outputs_and));
4585 } else {
4586 cat_snprintf(buf, bufsz,
4587 /* TRANS: Amount is subtracted from upkeep cost
4588 * for each upkeep type. */
4589 PL_("%s Each of your cities will avoid paying %d"
4590 " upkeep for your units.\n",
4591 "%s Each of your cities will avoid paying %d"
4592 " upkeep for your units.\n", peffect->value),
4593 BULLET, peffect->value);
4594 }
4595 } /* else too complicated */
4596 break;
4597 case EFT_CIVIL_WAR_CHANCE:
4598 if (playerwide) {
4599 cat_snprintf(buf, bufsz,
4600 _("%s If you lose your capital,"
4601 " the base chance of civil war is %d%%.\n"),
4602 BULLET, net_value);
4603 }
4604 break;
4605 case EFT_EMPIRE_SIZE_BASE:
4606 if (playerwide) {
4607 cat_snprintf(buf, bufsz,
4608 PL_("%s You can have %d city before an "
4609 "additional unhappy citizen appears in each city "
4610 "due to civilization size.\n",
4611 "%s You can have up to %d cities before an "
4612 "additional unhappy citizen appears in each city "
4613 "due to civilization size.\n", net_value),
4614 BULLET, net_value);
4615 }
4616 break;
4617 case EFT_EMPIRE_SIZE_STEP:
4618 if (playerwide) {
4619 cat_snprintf(buf, bufsz,
4620 PL_("%s After the first unhappy citizen due to"
4621 " civilization size, for each %d additional city"
4622 " another unhappy citizen will appear.\n",
4623 "%s After the first unhappy citizen due to"
4624 " civilization size, for each %d additional cities"
4625 " another unhappy citizen will appear.\n",
4626 net_value),
4627 BULLET, net_value);
4628 }
4629 break;
4630 case EFT_MAX_RATES:
4631 if (playerwide && game.info.changable_tax) {
4632 if (net_value < 100) {
4633 cat_snprintf(buf, bufsz,
4634 _("%s The maximum rate you can set for science,"
4635 " gold, or luxuries is %d%%.\n"),
4636 BULLET, net_value);
4637 } else {
4638 CATLSTR(buf, bufsz,
4639 _("%s Has unlimited science/gold/luxuries rates.\n"),
4640 BULLET);
4641 }
4642 }
4643 break;
4644 case EFT_MARTIAL_LAW_EACH:
4645 if (playerwide) {
4646 cat_snprintf(buf, bufsz,
4647 PL_("%s Your units may impose martial law."
4648 " Each military unit inside a city will force %d"
4649 " unhappy citizen to become content.\n",
4650 "%s Your units may impose martial law."
4651 " Each military unit inside a city will force %d"
4652 " unhappy citizens to become content.\n",
4653 peffect->value),
4654 BULLET, peffect->value);
4655 }
4656 break;
4657 case EFT_MARTIAL_LAW_MAX:
4658 if (playerwide && net_value < 100) {
4659 cat_snprintf(buf, bufsz,
4660 PL_("%s A maximum of %d unit in each city can enforce"
4661 " martial law.\n",
4662 "%s A maximum of %d units in each city can enforce"
4663 " martial law.\n",
4664 net_value),
4665 BULLET, net_value);
4666 }
4667 break;
4668 case EFT_RAPTURE_GROW:
4669 if (playerwide && net_value > 0) {
4670 cat_snprintf(buf, bufsz,
4671 _("%s You may grow your cities by means of "
4672 "celebrations."), BULLET);
4673 if (game.info.celebratesize > 1) {
4674 cat_snprintf(buf, bufsz,
4675 /* TRANS: Preserve leading space. %d should always be
4676 * 2 or greater. */
4677 _(" (Cities below size %d cannot grow in this way.)"),
4678 game.info.celebratesize);
4679 }
4680 cat_snprintf(buf, bufsz, "\n");
4681 }
4682 break;
4683 case EFT_REVOLUTION_UNHAPPINESS:
4684 if (playerwide) {
4685 cat_snprintf(buf, bufsz,
4686 PL_("%s If a city is in disorder for more than %d turn "
4687 "in a row, government will fall into anarchy.\n",
4688 "%s If a city is in disorder for more than %d turns "
4689 "in a row, government will fall into anarchy.\n",
4690 net_value),
4691 BULLET, net_value);
4692 }
4693 break;
4694 case EFT_HAS_SENATE:
4695 if (playerwide && net_value > 0) {
4696 CATLSTR(buf, bufsz,
4697 _("%s Has a senate that may prevent declaration of war.\n"),
4698 BULLET);
4699 }
4700 break;
4701 case EFT_INSPIRE_PARTISANS:
4702 if (playerwide && net_value > 0) {
4703 CATLSTR(buf, bufsz,
4704 _("%s Allows partisans when cities are taken by the "
4705 "enemy.\n"), BULLET);
4706 }
4707 break;
4708 case EFT_HAPPINESS_TO_GOLD:
4709 if (playerwide && net_value > 0) {
4710 CATLSTR(buf, bufsz,
4711 _("%s Buildings that normally confer bonuses against"
4712 " unhappiness will instead give gold.\n"), BULLET);
4713 }
4714 break;
4715 case EFT_FANATICS:
4716 if (playerwide && net_value > 0) {
4717 struct strvec *fanatics = strvec_new();
4718 struct astring fanaticstr = ASTRING_INIT;
4719
4720 unit_type_iterate(putype) {
4721 if (utype_has_flag(putype, UTYF_FANATIC)) {
4722 strvec_append(fanatics, utype_name_translation(putype));
4723 }
4724 } unit_type_iterate_end;
4725 cat_snprintf(buf, bufsz,
4726 /* TRANS: %s is list of unit types separated by 'or' */
4727 _("%s Pays no upkeep for %s.\n"), BULLET,
4728 strvec_to_or_list(fanatics, &fanaticstr));
4729 strvec_destroy(fanatics);
4730 astr_free(&fanaticstr);
4731 }
4732 break;
4733 case EFT_NO_UNHAPPY:
4734 if (playerwide && net_value > 0) {
4735 CATLSTR(buf, bufsz, _("%s Has no unhappy citizens.\n"), BULLET);
4736 }
4737 break;
4738 case EFT_VETERAN_BUILD:
4739 {
4740 int conditions = 0;
4741 if (unitclass) {
4742 conditions++;
4743 }
4744 if (unittype) {
4745 conditions++;
4746 }
4747 if (unit_type_flag_id_is_valid(unitflag)) {
4748 conditions++;
4749 }
4750 if (conditions > 1) {
4751 /* More than one requirement on units, too complicated for us
4752 * to describe. */
4753 break;
4754 }
4755 if (unitclass) {
4756 /* FIXME: account for multiple veteran levels, or negative
4757 * values. This might lie for complicated rulesets! */
4758 cat_snprintf(buf, bufsz,
4759 /* TRANS: %s is a unit class */
4760 Q_("?unitclass:* New %s units will be veteran.\n"),
4761 uclass_name_translation(unitclass));
4762 } else if (unit_type_flag_id_is_valid(unitflag)) {
4763 /* FIXME: same problems as unitclass */
4764 cat_snprintf(buf, bufsz,
4765 /* TRANS: %s is a (translatable) unit type flag */
4766 Q_("?unitflag:* New %s units will be veteran.\n"),
4767 unit_type_flag_id_translated_name(unitflag));
4768 } else if (unittype != NULL) {
4769 if (world_value_valid && net_value > 0) {
4770 /* Here we can be specific about veteran level, and get
4771 * net value correct. */
4772 int maxlvl = utype_veteran_system(unittype)->levels - 1;
4773 const struct veteran_level *vlevel =
4774 utype_veteran_level(unittype, MIN(net_value, maxlvl));
4775 cat_snprintf(buf, bufsz,
4776 /* TRANS: "* New Partisan units will have the rank
4777 * of elite." */
4778 Q_("?unittype:%s New %s units will have the rank "
4779 "of %s.\n"), BULLET,
4780 utype_name_translation(unittype),
4781 name_translation_get(&vlevel->name));
4782 } /* else complicated */
4783 } else {
4784 /* No extra criteria. */
4785 /* FIXME: same problems as above */
4786 cat_snprintf(buf, bufsz,
4787 _("%s New units will be veteran.\n"), BULLET);
4788 }
4789 }
4790 break;
4791 case EFT_OUTPUT_PENALTY_TILE:
4792 if (world_value_valid) {
4793 cat_snprintf(buf, bufsz,
4794 /* TRANS: %s is list of output types, with 'or';
4795 * pluralised in %d but of course the output types
4796 * can't be pluralised; sorry */
4797 PL_("%s Each worked tile that gives more than %d %s will"
4798 " suffer a -1 penalty, unless the city working it"
4799 " is celebrating.",
4800 "%s Each worked tile that gives more than %d %s will"
4801 " suffer a -1 penalty, unless the city working it"
4802 " is celebrating.", net_value),
4803 BULLET, net_value, astr_str(&outputs_or));
4804 if (game.info.celebratesize > 1) {
4805 cat_snprintf(buf, bufsz,
4806 /* TRANS: Preserve leading space. %d should always be
4807 * 2 or greater. */
4808 _(" (Cities below size %d will not celebrate.)"),
4809 game.info.celebratesize);
4810 }
4811 cat_snprintf(buf, bufsz, "\n");
4812 }
4813 break;
4814 case EFT_OUTPUT_INC_TILE_CELEBRATE:
4815 cat_snprintf(buf, bufsz,
4816 /* TRANS: %s is list of output types, with 'or' */
4817 PL_("%s Each worked tile with at least 1 %s will yield"
4818 " %d more of it while the city working it is"
4819 " celebrating.",
4820 "%s Each worked tile with at least 1 %s will yield"
4821 " %d more of it while the city working it is"
4822 " celebrating.", peffect->value),
4823 BULLET, astr_str(&outputs_or), peffect->value);
4824 if (game.info.celebratesize > 1) {
4825 cat_snprintf(buf, bufsz,
4826 /* TRANS: Preserve leading space. %d should always be
4827 * 2 or greater. */
4828 _(" (Cities below size %d will not celebrate.)"),
4829 game.info.celebratesize);
4830 }
4831 cat_snprintf(buf, bufsz, "\n");
4832 break;
4833 case EFT_OUTPUT_INC_TILE:
4834 cat_snprintf(buf, bufsz,
4835 /* TRANS: %s is list of output types, with 'or' */
4836 PL_("%s Each worked tile with at least 1 %s will yield"
4837 " %d more of it.\n",
4838 "%s Each worked tile with at least 1 %s will yield"
4839 " %d more of it.\n", peffect->value),
4840 BULLET, astr_str(&outputs_or), peffect->value);
4841 break;
4842 case EFT_OUTPUT_BONUS:
4843 case EFT_OUTPUT_BONUS_2:
4844 /* FIXME: makes most sense iff world_value == 0 */
4845 cat_snprintf(buf, bufsz,
4846 /* TRANS: %s is list of output types, with 'and' */
4847 _("%s %s production is increased %d%%.\n"),
4848 BULLET, astr_str(&outputs_and), peffect->value);
4849 break;
4850 case EFT_OUTPUT_WASTE:
4851 if (world_value_valid) {
4852 if (net_value > 30) {
4853 cat_snprintf(buf, bufsz,
4854 /* TRANS: %s is list of output types, with 'and' */
4855 _("%s %s production will suffer massive losses.\n"),
4856 BULLET, astr_str(&outputs_and));
4857 } else if (net_value >= 15) {
4858 cat_snprintf(buf, bufsz,
4859 /* TRANS: %s is list of output types, with 'and' */
4860 _("%s %s production will suffer some losses.\n"),
4861 BULLET, astr_str(&outputs_and));
4862 } else if (net_value > 0) {
4863 cat_snprintf(buf, bufsz,
4864 /* TRANS: %s is list of output types, with 'and' */
4865 _("%s %s production will suffer a small amount "
4866 "of losses.\n"),
4867 BULLET, astr_str(&outputs_and));
4868 }
4869 }
4870 break;
4871 case EFT_HEALTH_PCT:
4872 if (playerwide) {
4873 if (peffect->value > 0) {
4874 CATLSTR(buf, bufsz, _("%s Increases the chance of plague"
4875 " within your cities.\n"), BULLET);
4876 } else if (peffect->value < 0) {
4877 CATLSTR(buf, bufsz, _("%s Decreases the chance of plague"
4878 " within your cities.\n"), BULLET);
4879 }
4880 }
4881 break;
4882 case EFT_OUTPUT_WASTE_BY_REL_DISTANCE:
4883 /* Semi-arbitrary scaling to get likely ruleset values in roughly
4884 * the same range as WASTE_BY_DISTANCE */
4885 /* FIXME: use different wording? */
4886 net_value = (net_value + 39) / 40; /* round up */
4887 fc__fallthrough; /* fall through to: */
4888 case EFT_OUTPUT_WASTE_BY_DISTANCE:
4889 if (world_value_valid) {
4890 if (net_value >= 300) {
4891 cat_snprintf(buf, bufsz,
4892 /* TRANS: %s is list of output types, with 'and' */
4893 _("%s %s losses will increase quickly"
4894 " with distance from capital.\n"),
4895 BULLET, astr_str(&outputs_and));
4896 } else if (net_value >= 200) {
4897 cat_snprintf(buf, bufsz,
4898 /* TRANS: %s is list of output types, with 'and' */
4899 _("%s %s losses will increase"
4900 " with distance from capital.\n"),
4901 BULLET, astr_str(&outputs_and));
4902 } else if (net_value > 0) {
4903 cat_snprintf(buf, bufsz,
4904 /* TRANS: %s is list of output types, with 'and' */
4905 _("%s %s losses will increase slowly"
4906 " with distance from capital.\n"),
4907 BULLET, astr_str(&outputs_and));
4908 }
4909 }
4910 break;
4911 case EFT_MIGRATION_PCT:
4912 if (playerwide) {
4913 if (peffect->value > 0) {
4914 CATLSTR(buf, bufsz, _("%s Increases the chance of migration"
4915 " into your cities.\n"), BULLET);
4916 } else if (peffect->value < 0) {
4917 CATLSTR(buf, bufsz, _("%s Decreases the chance of migration"
4918 " into your cities.\n"), BULLET);
4919 }
4920 }
4921 break;
4922 case EFT_BORDER_VISION:
4923 if (game.info.borders == BORDERS_ENABLED
4924 && playerwide && net_value > 0) {
4925 CATLSTR(buf, bufsz, _("%s All tiles inside your borders are"
4926 " monitored.\n"), BULLET);
4927 }
4928 break;
4929 default:
4930 break;
4931 };
4932 }
4933
4934 strvec_destroy(outputs);
4935 astr_free(&outputs_or);
4936 astr_free(&outputs_and);
4937
4938 } effect_list_iterate_end;
4939
4940 /* Action immunity */
4941 action_iterate(act) {
4942 if (action_by_number(act)->quiet) {
4943 /* The ruleset documents this action it self. */
4944 continue;
4945 }
4946
4947 if (action_immune_government(gov, act)) {
4948 cat_snprintf(buf, bufsz,
4949 /* TRANS: action name ... action target
4950 * ("individual units", etc) */
4951 _("%s Makes it impossible to do the action \'%s\'"
4952 " to your %s.\n"), BULLET,
4953 action_id_name_translation(act),
4954 action_target_kind_help(action_id_get_target_kind(act)));
4955 }
4956 } action_iterate_end;
4957
4958 if (user_text && user_text[0] != '\0') {
4959 cat_snprintf(buf, bufsz, "\n%s", user_text);
4960 }
4961}
4962
4963/************************************************************************/
4966 char *helptext_unit_upkeep_str(const struct unit_type *utype)
4967{
4968 static char buf[128];
4969 int any = 0;
4970
4971 if (!utype) {
4972 log_error("Unknown unit!");
4973 return "";
4974 }
4975
4976 buf[0] = '\0';
4977 output_type_iterate(o) {
4978 if (utype->upkeep[o] > 0) {
4979 /* TRANS: "2 Food" or ", 1 Shield" */
4980 cat_snprintf(buf, sizeof(buf), _("%s%d %s"),
4981 (any > 0 ? Q_("?blistmore:, ") : ""), utype->upkeep[o],
4982 get_output_name(o));
4983 any++;
4984 }
4985 } output_type_iterate_end;
4986 if (utype->happy_cost > 0) {
4987 /* TRANS: "2 Unhappy" or ", 1 Unhappy" */
4988 cat_snprintf(buf, sizeof(buf), _("%s%d Unhappy"),
4989 (any > 0 ? Q_("?blistmore:, ") : ""), utype->happy_cost);
4990 any++;
4991 }
4992
4993 if (any == 0) {
4994 /* strcpy(buf, _("None")); */
4995 fc_snprintf(buf, sizeof(buf), "%d", 0);
4996 }
4997 return buf;
4998}
4999
5000/************************************************************************/
5003 void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation,
5004 const char *user_text)
5005{
5006 struct universal source = {
5007 .kind = VUT_NATION,
5008 .value = {.nation = pnation}
5009 };
5010 bool print_break = TRUE;
5011
5012#define PRINT_BREAK() do { \
5013 if (print_break) { \
5014 if (buf[0] != '\0') { \
5015 CATLSTR(buf, bufsz, "\n\n"); \
5016 } \
5017 print_break = FALSE; \
5018 } \
5019 } while (FALSE)
5020
5021 fc_assert_ret(NULL != buf && 0 < bufsz);
5022 buf[0] = '\0';
5023
5024 if (pnation->legend[0] != '\0') {
5025 /* Client side legend is stored already translated */
5026 cat_snprintf(buf, bufsz, "%s", pnation->legend);
5027 }
5028
5029 if (pnation->init_government) {
5030 PRINT_BREAK();
5031 cat_snprintf(buf, bufsz,
5032 _("Initial government is %s.\n"),
5033 government_name_translation(pnation->init_government));
5034 }
5035 if (pnation->init_techs[0] != A_LAST) {
5036 const char *tech_names[MAX_NUM_TECH_LIST];
5037 int i;
5038 struct astring list = ASTRING_INIT;
5039
5040 for (i = 0; i < MAX_NUM_TECH_LIST; i++) {
5041 if (pnation->init_techs[i] == A_LAST) {
5042 break;
5043 }
5044 tech_names[i] =
5045 advance_name_translation(advance_by_number(pnation->init_techs[i]));
5046 }
5047 astr_build_and_list(&list, tech_names, i);
5048 PRINT_BREAK();
5049 if (game.rgame.global_init_techs[0] != A_LAST) {
5050 cat_snprintf(buf, bufsz,
5051 /* TRANS: %s is an and-separated list of techs */
5052 _("Starts with knowledge of %s in addition to the standard "
5053 "starting technologies.\n"), astr_str(&list));
5054 } else {
5055 cat_snprintf(buf, bufsz,
5056 /* TRANS: %s is an and-separated list of techs */
5057 _("Starts with knowledge of %s.\n"), astr_str(&list));
5058 }
5059 astr_free(&list);
5060 }
5061 if (pnation->init_units[0]) {
5062 const struct unit_type *utypes[MAX_NUM_UNIT_LIST];
5063 int count[MAX_NUM_UNIT_LIST];
5064 int i, j, n = 0, total = 0;
5065
5066 /* Count how many of each type there is. */
5067 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
5068 if (!pnation->init_units[i]) {
5069 break;
5070 }
5071 for (j = 0; j < n; j++) {
5072 if (pnation->init_units[i] == utypes[j]) {
5073 count[j]++;
5074 total++;
5075 break;
5076 }
5077 }
5078 if (j == n) {
5079 utypes[n] = pnation->init_units[i];
5080 count[n] = 1;
5081 total++;
5082 n++;
5083 }
5084 }
5085 {
5086 /* Construct the list of unit types and counts. */
5087 struct astring utype_names[MAX_NUM_UNIT_LIST];
5088 struct astring list = ASTRING_INIT;
5089
5090 for (i = 0; i < n; i++) {
5091 astr_init(&utype_names[i]);
5092 if (count[i] > 1) {
5093 /* TRANS: a unit type followed by a count. For instance,
5094 * "Fighter (2)" means two Fighters. Count is never 1.
5095 * Used in a list. */
5096 astr_set(&utype_names[i], _("%s (%d)"),
5097 utype_name_translation(utypes[i]), count[i]);
5098 } else {
5099 astr_set(&utype_names[i], "%s", utype_name_translation(utypes[i]));
5100 }
5101 }
5102 {
5103 const char *utype_name_strs[MAX_NUM_UNIT_LIST];
5104
5105 for (i = 0; i < n; i++) {
5106 utype_name_strs[i] = astr_str(&utype_names[i]);
5107 }
5108 astr_build_and_list(&list, utype_name_strs, n);
5109 }
5110 for (i = 0; i < n; i++) {
5111 astr_free(&utype_names[i]);
5112 }
5113 PRINT_BREAK();
5114 cat_snprintf(buf, bufsz,
5115 /* TRANS: %s is an and-separated list of unit types
5116 * possibly with counts. Plurality is in total number of
5117 * units represented. */
5118 PL_("Starts with the following additional unit: %s.\n",
5119 "Starts with the following additional units: %s.\n",
5120 total), astr_str(&list));
5121 astr_free(&list);
5122 }
5123 }
5124 if (pnation->init_buildings[0] != B_LAST) {
5125 const char *impr_names[MAX_NUM_BUILDING_LIST];
5126 int i;
5127 struct astring list = ASTRING_INIT;
5128
5129 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
5130 if (pnation->init_buildings[i] == B_LAST) {
5131 break;
5132 }
5133 impr_names[i] =
5134 improvement_name_translation(
5135 improvement_by_number(pnation->init_buildings[i]));
5136 }
5137 astr_build_and_list(&list, impr_names, i);
5138 PRINT_BREAK();
5139 if (game.rgame.global_init_buildings[0] != B_LAST) {
5140 cat_snprintf(buf, bufsz,
5141 /* TRANS: %s is an and-separated list of improvements */
5142 _("First city will get %s for free in addition to the "
5143 "standard improvements.\n"), astr_str(&list));
5144 } else {
5145 cat_snprintf(buf, bufsz,
5146 /* TRANS: %s is an and-separated list of improvements */
5147 _("First city will get %s for free.\n"), astr_str(&list));
5148 }
5149 astr_free(&list);
5150 }
5151
5152 if (buf[0] != '\0') {
5153 CATLSTR(buf, bufsz, "\n");
5154 }
5155 insert_allows(&source, buf + strlen(buf), bufsz - strlen(buf), "");
5156
5157 if (user_text && user_text[0] != '\0') {
5158 if (buf[0] != '\0') {
5159 CATLSTR(buf, bufsz, "\n");
5160 }
5161 CATLSTR(buf, bufsz, "%s", user_text);
5162 }
5163#undef PRINT_BREAK
5164}
5165
5166/************************************************************************/
5169 enum help_page_type help_type_by_requirement(const struct requirement *req)
5170{
5171 if (req == NULL) {
5172 return HELP_LAST;
5173 }
5174
5175 if (req->source.kind == VUT_UTYPE) {
5176 return HELP_UNIT;
5177 }
5178 if (req->source.kind == VUT_IMPROVEMENT) {
5179 if (is_great_wonder(req->source.value.building)) {
5180 return HELP_WONDER;
5181 }
5182 return HELP_IMPROVEMENT;
5183 }
5184 if (req->source.kind == VUT_ADVANCE) {
5185 return HELP_TECH;
5186 }
5187 if (req->source.kind == VUT_TERRAIN) {
5188 return HELP_TERRAIN;
5189 }
5190 if (req->source.kind == VUT_EXTRA) {
5191 return HELP_EXTRA;
5192 }
5193 if (req->source.kind == VUT_GOOD) {
5194 return HELP_GOODS;
5195 }
5196 if (req->source.kind == VUT_SPECIALIST) {
5197 return HELP_SPECIALIST;
5198 }
5199 if (req->source.kind == VUT_GOVERNMENT) {
5200 return HELP_GOVERNMENT;
5201 }
5202
5203 if (req->source.kind == VUT_NATION) {
5204 return HELP_NATIONS;
5205 }
5206
5207 return HELP_LAST;
5208}
action_get_actor_kind
enum action_actor_kind action_get_actor_kind(const struct action *paction)
Definition actions.c:1063
action_id_name_translation
const char * action_id_name_translation(action_id act_id)
Definition actions.c:1215
action_array_add_all_by_result
void action_array_add_all_by_result(action_id *act_array, int *position, enum action_result result)
Definition actions.c:5723
action_name_translation
const char * action_name_translation(const struct action *paction)
Definition actions.c:1195
action_array_end
void action_array_end(action_id *act_array, int size)
Definition actions.c:5706
action_is_in_use
bool action_is_in_use(struct action *paction)
Definition actions.c:5612
action_get_sub_target_kind
enum action_sub_target_kind action_get_sub_target_kind(const struct action *paction)
Definition actions.c:1084
action_would_be_blocked_by
bool action_would_be_blocked_by(const struct action *blocked, const struct action *blocker)
Definition actions.c:1161
action_immune_government
bool action_immune_government(struct government *gov, action_id act)
Definition actions.c:5386
action_dice_roll_initial_odds
int action_dice_roll_initial_odds(const struct action *paction)
Definition actions.c:5310
action_target_kind_help
const char * action_target_kind_help(enum action_target_kind kind)
Definition actions.c:7485
action_get_target_kind
enum action_target_kind action_get_target_kind(const struct action *paction)
Definition actions.c:1073
action_enablers_for_action
struct action_enabler_list * action_enablers_for_action(action_id action)
Definition actions.c:1519
action_id_univs_not_blocking
#define action_id_univs_not_blocking(act_id, act_uni, tgt_uni)
Definition actions.h:685
action_auto_perf_iterate_end
#define action_auto_perf_iterate_end
Definition actions.h:341
action_by_number
static struct action * action_by_number(action_id act_id)
Definition actions.h:390
action_array_iterate
#define action_array_iterate(_act_array_, _act_id_)
Definition actions.h:252
action_has_result
#define action_has_result(_act_, _res_)
Definition actions.h:175
action_enabler_list_iterate_end
#define action_enabler_list_iterate_end
Definition actions.h:185
action_id_get_role
#define action_id_get_role(act_id)
Definition actions.h:451
ACTION_DISTANCE_UNLIMITED
#define ACTION_DISTANCE_UNLIMITED
Definition actions.h:101
action_array_iterate_end
#define action_array_iterate_end
Definition actions.h:264
action_iterate_end
#define action_iterate_end
Definition actions.h:209
MAX_NUM_ACTIONS
#define MAX_NUM_ACTIONS
Definition actions.h:58
action_enabler_list_iterate
#define action_enabler_list_iterate(action_enabler_list, aenabler)
Definition actions.h:183
action_iterate
#define action_iterate(_act_)
Definition actions.h:205
action_id_get_target_kind
#define action_id_get_target_kind(act_id)
Definition actions.h:407
action_auto_perf_iterate
#define action_auto_perf_iterate(_act_perf_)
Definition actions.h:329
ACTION_ODDS_PCT_DICE_ROLL_NA
#define ACTION_ODDS_PCT_DICE_ROLL_NA
Definition actions.h:669
actres_removes_extra
bool actres_removes_extra(enum action_result result, const struct extra_type *pextra)
Definition actres.c:806
actres_creates_extra
bool actres_creates_extra(enum action_result result, const struct extra_type *pextra)
Definition actres.c:785
actres_get_battle_kind
enum action_battle_kind actres_get_battle_kind(enum action_result result)
Definition actres.c:272
astr_free
void astr_free(struct astring *astr)
Definition astring.c:148
astr_build_or_list
const char * astr_build_or_list(struct astring *astr, const char *const *items, size_t number)
Definition astring.c:313
astr_set
void astr_set(struct astring *astr, const char *format,...)
Definition astring.c:251
astr_build_and_list
const char * astr_build_and_list(struct astring *astr, const char *const *items, size_t number)
Definition astring.c:351
astr_init
void astr_init(struct astring *astr)
Definition astring.c:139
str
#define str
Definition astring.c:76
n
#define n
Definition astring.c:77
astring.h
astr_str
static const char * astr_str(const struct astring *astr) fc__attribute((nonnull(1)))
Definition astring.h:93
ASTRING_INIT
#define ASTRING_INIT
Definition astring.h:44
territory_claiming_base
bool territory_claiming_base(const struct base_type *pbase)
Definition base.c:158
bitvector.h
BV_CLR_ALL_FROM
#define BV_CLR_ALL_FROM(vec_to, vec_from)
Definition bitvector.h:127
BV_CLR_ALL
#define BV_CLR_ALL(bv)
Definition bitvector.h:95
BV_SET
#define BV_SET(bv, bit)
Definition bitvector.h:81
BV_ARE_EQUAL
#define BV_ARE_EQUAL(vec1, vec2)
Definition bitvector.h:113
BV_ISSET
#define BV_ISSET(bv, bit)
Definition bitvector.h:78
BV_ISSET_ANY
#define BV_ISSET_ANY(vec)
Definition bitvector.h:109
get_output_type
struct output_type * get_output_type(Output_type_id output)
Definition city.c:637
get_output_name
const char * get_output_name(Output_type_id output)
Definition city.c:628
output_type_iterate
#define output_type_iterate(output)
Definition city.h:833
output_type_iterate_end
#define output_type_iterate_end
Definition city.h:839
client_state
enum client_states client_state(void)
Definition client_main.c:1026
client_main.h
C_S_RUNNING
@ C_S_RUNNING
Definition client_main.h:47
client_nation_is_in_current_set
bool client_nation_is_in_current_set(const struct nation_type *pnation)
Definition climisc.c:1498
climisc.h
list
static struct fc_sockaddr_list * list
Definition clinet.c:102
utypes
char * utypes
Definition comments.c:34
incite_cost
char * incite_cost
Definition comments.c:74
MAX_LEN_PACKET
#define MAX_LEN_PACKET
Definition conn_types.h:29
MAX_LEN_MSG
#define MAX_LEN_MSG
Definition conn_types.h:37
counter_name_translation
const char * counter_name_translation(const struct counter *counter)
Definition counters.c:157
counter_by_id
struct counter * counter_by_id(int id)
Definition counters.c:82
counters.h
road
static void road(QVariant data1, QVariant data2)
Definition dialogs.cpp:2916
effect_universals_value_never_below
bool effect_universals_value_never_below(enum effect_type type, struct universal *unis, size_t n_unis, int min_value)
Definition effects.c:545
reqs
struct @21::@22 reqs
get_target_bonus_effects
int get_target_bonus_effects(struct effect_list *plist, const struct req_context *context, const struct player *other_player, enum effect_type effect_type)
Definition effects.c:748
effect_value_from_universals
int effect_value_from_universals(enum effect_type type, struct universal *unis, size_t n_unis)
Definition effects.c:459
effect_cumulative_max
int effect_cumulative_max(enum effect_type type, struct universal *unis, size_t n_unis)
Definition effects.c:388
get_req_source_effects
struct effect_list * get_req_source_effects(const struct universal *psource)
Definition effects.c:153
building_has_effect
bool building_has_effect(const struct impr_type *pimprove, enum effect_type effect_type)
Definition effects.c:644
effects.h
effect_list_iterate_end
#define effect_list_iterate_end
Definition effects.h:81
effect_list_iterate
#define effect_list_iterate(effect_list, peffect)
Definition effects.h:79
extra_flag_helptxt
const char * extra_flag_helptxt(enum extra_flag_id id)
Definition extras.c:974
is_extra_caused_by_worker_action
bool is_extra_caused_by_worker_action(const struct extra_type *pextra)
Definition extras.c:1032
extra_has_flag
bool extra_has_flag(const struct extra_type *pextra, enum extra_flag_id flag)
Definition extras.c:861
is_extra_removed_by
bool is_extra_removed_by(const struct extra_type *pextra, enum extra_rmcause rmcause)
Definition extras.c:353
extra_count
int extra_count(void)
Definition extras.c:153
is_native_extra_to_uclass
bool is_native_extra_to_uclass(const struct extra_type *pextra, const struct unit_class *pclass)
Definition extras.c:843
extra_name_translation
const char * extra_name_translation(const struct extra_type *pextra)
Definition extras.c:194
extra_type_iterate
#define extra_type_iterate(_p)
Definition extras.h:315
extra_type_iterate_end
#define extra_type_iterate_end
Definition extras.h:321
extra_type_by_rmcause_iterate_end
#define extra_type_by_rmcause_iterate_end
Definition extras.h:358
is_extra_caused_by
#define is_extra_caused_by(e, c)
Definition extras.h:203
extra_index
#define extra_index(_e_)
Definition extras.h:183
extra_type_by_rmcause_iterate
#define extra_type_by_rmcause_iterate(_rmcause, _extra)
Definition extras.h:353
extra_road_get
#define extra_road_get(_e_)
Definition extras.h:191
extra_type_by_cause_iterate_end
#define extra_type_by_cause_iterate_end
Definition extras.h:339
EF_LAST_USER_FLAG
#define EF_LAST_USER_FLAG
Definition extras.h:82
extra_type_by_cause_iterate
#define extra_type_by_cause_iterate(_cause, _extra)
Definition extras.h:333
MAX_NUM_BUILDING_LIST
#define MAX_NUM_BUILDING_LIST
Definition fc_types.h:46
Impr_type_id
int Impr_type_id
Definition fc_types.h:380
Unit_Class_id
int Unit_Class_id
Definition fc_types.h:422
action_id
int action_id
Definition fc_types.h:393
CASUS_BELLI_OUTRAGE
#define CASUS_BELLI_OUTRAGE
Definition fc_types.h:488
CASUS_BELLI_VICTIM
#define CASUS_BELLI_VICTIM
Definition fc_types.h:482
MAX_NUM_UNIT_LIST
#define MAX_NUM_UNIT_LIST
Definition fc_types.h:45
MAX_LEN_NAME
#define MAX_LEN_NAME
Definition fc_types.h:66
MAX_NUM_TECH_LIST
#define MAX_NUM_TECH_LIST
Definition fc_types.h:44
O_SHIELD
@ O_SHIELD
Definition fc_types.h:101
O_FOOD
@ O_FOOD
Definition fc_types.h:101
O_TRADE
@ O_TRADE
Definition fc_types.h:101
O_LAST
@ O_LAST
Definition fc_types.h:101
BORDERS_ENABLED
@ BORDERS_ENABLED
Definition fc_types.h:1048
Output_type_id
enum output_type_id Output_type_id
Definition fc_types.h:382
get_internal_string_length
size_t get_internal_string_length(const char *text)
Definition fciconv.c:396
fciconv.h
fcintl.h
Q_
#define Q_(String)
Definition fcintl.h:70
PL_
#define PL_(String1, String2, n)
Definition fcintl.h:71
_
#define _(String)
Definition fcintl.h:67
N_
#define N_(String)
Definition fcintl.h:69
game
struct civ_game game
Definition game.c:62
game.h
government_name_translation
const char * government_name_translation(const struct government *pgovern)
Definition government.c:143
government.h
governments_iterate
#define governments_iterate(NAME_pgov)
Definition government.h:120
governments_iterate_end
#define governments_iterate_end
Definition government.h:123
pos
static struct tile * pos
Definition finddlg.c:53
source
static GtkWidget * source
Definition gotodlg.c:58
client_string
const char * client_string
Definition gui_main.c:105
insert_client_build_info
void insert_client_build_info(char *outbuf, size_t outlen)
Definition gui_main.c:2561
popdown_help_dialog
void popdown_help_dialog(void)
Definition helpdlg.c:186
type
GType type
Definition repodlgs.c:1313
bufsz
static const int bufsz
Definition helpdlg.c:70
gui_main_g.h
extra_bonus_for_terrain
static void extra_bonus_for_terrain(struct extra_type *pextra, struct terrain *pterrain, int *bonus)
Definition helpdata.c:3649
help_iter_start
void help_iter_start(void)
Definition helpdata.c:1340
help_item_compar
static int help_item_compar(const struct help_item *const *ppa, const struct help_item *const *ppb)
Definition helpdata.c:688
help_nodes_init
static bool help_nodes_init
Definition helpdata.c:87
free_help_texts
void free_help_texts(void)
Definition helpdata.c:125
boot_help_texts
void boot_help_texts(void)
Definition helpdata.c:710
insert_allows
static void insert_allows(struct universal *psource, char *buf, size_t bufsz, const char *prefix)
Definition helpdata.c:571
CATLSTR
#define CATLSTR(_b, _s, _t,...)
Definition helpdata.c:68
insert_generated_text
static bool insert_generated_text(char *outbuf, size_t outlen, const char *name)
Definition helpdata.c:208
help_nodes
static struct help_list * help_nodes
Definition helpdata.c:86
help_type_names
static const char *const help_type_names[]
Definition helpdata.c:71
helptext_government
void helptext_government(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct government *gov)
Definition helpdata.c:4304
helptext_advance
void helptext_advance(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, int i)
Definition helpdata.c:3263
help_type_by_requirement
enum help_page_type help_type_by_requirement(const struct requirement *req)
Definition helpdata.c:5169
helptext_extra
void helptext_extra(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct extra_type *pextra)
Definition helpdata.c:3758
helpdata_init
void helpdata_init(void)
Definition helpdata.c:95
check_help_nodes_init
static void check_help_nodes_init(void)
Definition helpdata.c:114
get_help_item
const struct help_item * get_help_item(int pos)
Definition helpdata.c:1265
num_help_items
int num_help_items(void)
Definition helpdata.c:1254
insert_veteran_help
static bool insert_veteran_help(char *outbuf, size_t outlen, const struct veteran_system *veteran, const char *intro, const char *nolevels)
Definition helpdata.c:149
helptext_goods
void helptext_goods(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct goods_type *pgood)
Definition helpdata.c:4223
BULLET_SPACE
#define BULLET_SPACE
Definition helpdata.c:65
show_help_for_nation
static bool show_help_for_nation(const struct nation_type *pnation)
Definition helpdata.c:139
PRINT_BREAK
#define PRINT_BREAK()
helptext_road_bonus_str
const char * helptext_road_bonus_str(const struct terrain *pterrain, const struct road_type *proad)
Definition helpdata.c:3594
help_nodes_iterator
static const struct help_list_link * help_nodes_iterator
Definition helpdata.c:85
helptext_unit_upkeep_str
char * helptext_unit_upkeep_str(const struct unit_type *utype)
Definition helpdata.c:4966
BULLET
#define BULLET
Definition helpdata.c:63
helptext_extra_for_terrain_str
const char * helptext_extra_for_terrain_str(struct extra_type *pextra, struct terrain *pterrain, enum unit_activity act)
Definition helpdata.c:3724
insert_allows_single
static void insert_allows_single(struct universal *psource, struct requirement_vector *psubjreqs, const char *subjstr, const char *const *strs, char *buf, size_t bufsz, const char *prefix)
Definition helpdata.c:485
help_list_iterate_end
#define help_list_iterate_end
Definition helpdata.c:83
utype_may_do_escape_action
static bool utype_may_do_escape_action(const struct unit_type *utype)
Definition helpdata.c:1830
helpdata_done
void helpdata_done(void)
Definition helpdata.c:103
helptext_specialist
void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct specialist *pspec)
Definition helpdata.c:4269
get_help_item_spec
const struct help_item * get_help_item_spec(const char *name, enum help_page_type htype, int *pos)
Definition helpdata.c:1288
help_list_iterate
#define help_list_iterate(helplist, phelp)
Definition helpdata.c:81
help_iter_next
const struct help_item * help_iter_next(void)
Definition helpdata.c:1350
helptext_building
char * helptext_building(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct impr_type *pimprove)
Definition helpdata.c:1381
helptext_terrain
void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct terrain *pterrain)
Definition helpdata.c:3484
helptext_unit
char * helptext_unit(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct unit_type *utype)
Definition helpdata.c:1865
helptext_nation
void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation, const char *user_text)
Definition helpdata.c:5003
new_help_item
static struct help_item * new_help_item(int type)
Definition helpdata.c:672
helpdata.h
HELP_MUSICSET_ITEM
#define HELP_MUSICSET_ITEM
HELP_TILESET_ITEM
#define HELP_TILESET_ITEM
HELP_RULESET_ITEM
#define HELP_RULESET_ITEM
help_page_type
help_page_type
Definition helpdlg_g.h:20
HELP_ANY
@ HELP_ANY
Definition helpdlg_g.h:20
HELP_MUSICSET
@ HELP_MUSICSET
Definition helpdlg_g.h:23
HELP_MULTIPLIER
@ HELP_MULTIPLIER
Definition helpdlg_g.h:24
HELP_TERRAIN
@ HELP_TERRAIN
Definition helpdlg_g.h:21
HELP_EXTRA
@ HELP_EXTRA
Definition helpdlg_g.h:21
HELP_NATIONS
@ HELP_NATIONS
Definition helpdlg_g.h:24
HELP_LAST
@ HELP_LAST
Definition helpdlg_g.h:25
HELP_IMPROVEMENT
@ HELP_IMPROVEMENT
Definition helpdlg_g.h:20
HELP_UNIT
@ HELP_UNIT
Definition helpdlg_g.h:20
HELP_COUNTER
@ HELP_COUNTER
Definition helpdlg_g.h:24
HELP_SPECIALIST
@ HELP_SPECIALIST
Definition helpdlg_g.h:22
HELP_GOVERNMENT
@ HELP_GOVERNMENT
Definition helpdlg_g.h:22
HELP_GOODS
@ HELP_GOODS
Definition helpdlg_g.h:22
HELP_WONDER
@ HELP_WONDER
Definition helpdlg_g.h:21
HELP_TECH
@ HELP_TECH
Definition helpdlg_g.h:21
HELP_RULESET
@ HELP_RULESET
Definition helpdlg_g.h:23
HELP_TEXT
@ HELP_TEXT
Definition helpdlg_g.h:20
HELP_TILESET
@ HELP_TILESET
Definition helpdlg_g.h:23
valid_improvement
const struct impr_type * valid_improvement(const struct impr_type *pimprove)
Definition improvement.c:211
improvement_by_number
struct impr_type * improvement_by_number(const Impr_type_id id)
Definition improvement.c:194
is_great_wonder
bool is_great_wonder(const struct impr_type *pimprove)
Definition improvement.c:772
improvement_has_flag
bool improvement_has_flag(const struct impr_type *pimprove, enum impr_flag_id flag)
Definition improvement.c:383
improvement_name_translation
const char * improvement_name_translation(const struct impr_type *pimprove)
Definition improvement.c:243
is_small_wonder
bool is_small_wonder(const struct impr_type *pimprove)
Definition improvement.c:780
improvement_iterate_end
#define improvement_iterate_end
Definition improvement.h:205
improvement_iterate
#define improvement_iterate(_p)
Definition improvement.h:199
B_LAST
#define B_LAST
Definition improvement.h:42
name
const char * name
Definition inputfile.c:127
log.h
fc_assert_ret
#define fc_assert_ret(condition)
Definition log.h:191
log_verbose
#define log_verbose(message,...)
Definition log.h:109
fc_assert
#define fc_assert(condition)
Definition log.h:176
fc_assert_ret_val
#define fc_assert_ret_val(condition, val)
Definition log.h:194
log_error
#define log_error(message,...)
Definition log.h:103
terrain_control
struct terrain_misc terrain_control
Definition map.c:68
map.h
mem.h
FC_FREE
#define FC_FREE(ptr)
Definition mem.h:41
fc_strdup
#define fc_strdup(str)
Definition mem.h:43
fc_malloc
#define fc_malloc(sz)
Definition mem.h:34
move_points_text
const char * move_points_text(int mp, bool reduce)
Definition movement.c:1016
move_points_text_full
const char * move_points_text_full(int mp, bool reduce, const char *prefix, const char *none, bool align)
Definition movement.c:949
is_native_to_class
bool is_native_to_class(const struct unit_class *punitclass, const struct terrain *pterrain, const bv_extras *extras)
Definition movement.c:341
can_unit_type_transport
bool can_unit_type_transport(const struct unit_type *transporter, const struct unit_class *transported)
Definition movement.c:869
can_attack_non_native
bool can_attack_non_native(const struct unit_type *utype)
Definition movement.c:213
movement.h
multipliers.h
multipliers_iterate
#define multipliers_iterate(_mul_)
Definition multipliers.h:61
multipliers_iterate_end
#define multipliers_iterate_end
Definition multipliers.h:67
current_musicset_version
const char * current_musicset_version(void)
Definition music.c:242
current_musicset_name
const char * current_musicset_name(void)
Definition music.c:234
current_musicset_summary
const char * current_musicset_summary(void)
Definition music.c:254
current_musicset_description
const char * current_musicset_description(void)
Definition music.c:262
music.h
name_translation_get
static const char * name_translation_get(const struct name_translation *ptrans)
Definition name_translation.h:121
nation_plural_translation
const char * nation_plural_translation(const struct nation_type *pnation)
Definition nation.c:159
nation.h
nations_iterate_end
#define nations_iterate_end
Definition nation.h:336
nations_iterate
#define nations_iterate(NAME_pnation)
Definition nation.h:333
len
int len
Definition packhand.c:127
diplrel_name_translation
const char * diplrel_name_translation(int value)
Definition player.c:1631
secfile_load
struct section_file * secfile_load(const char *filename, bool allow_duplicates)
Definition registry.c:50
registry.h
secfile_error
const char * secfile_error(void)
Definition section_file.c:36
section_name
const char * section_name(const struct section *psection)
Definition section_file.c:65
secfile_destroy
void secfile_destroy(struct section_file *secfile)
Definition section_file.c:95
secfile_check_unused
void secfile_check_unused(const struct section_file *secfile)
Definition registry_ini.c:907
secfile_sections_by_name_prefix
struct section_list * secfile_sections_by_name_prefix(const struct section_file *secfile, const char *prefix)
Definition registry_ini.c:2871
secfile_lookup_str_vec
const char ** secfile_lookup_str_vec(const struct section_file *secfile, size_t *dim, const char *path,...)
Definition registry_ini.c:2239
secfile_lookup_str
const char * secfile_lookup_str(const struct section_file *secfile, const char *path,...)
Definition registry_ini.c:2175
section_list_iterate
#define section_list_iterate(seclist, psection)
Definition registry_ini.h:45
section_list_iterate_end
#define section_list_iterate_end
Definition registry_ini.h:47
req_text_insert_nl
bool req_text_insert_nl(char *buf, size_t bufsz, struct player *pplayer, const struct requirement *preq, enum rt_verbosity verb, const char *prefix)
Definition reqtext.c:3314
reqtext.h
VERB_DEFAULT
@ VERB_DEFAULT
Definition reqtext.h:20
universal_is_relevant_to_requirement
bool universal_is_relevant_to_requirement(const struct requirement *req, const struct universal *source)
Definition requirements.c:7510
universal_fulfills_requirements
bool universal_fulfills_requirements(bool check_necessary, const struct requirement_vector *reqs, const struct universal *source)
Definition requirements.c:7473
are_universals_equal
bool are_universals_equal(const struct universal *psource1, const struct universal *psource2)
Definition requirements.c:6667
universal_name_translation
const char * universal_name_translation(const struct universal *psource, char *buf, size_t bufsz)
Definition requirements.c:6962
requirement_fulfilled_by_unit_type
#define requirement_fulfilled_by_unit_type(_ut_, _rqs_)
Definition requirements.h:426
requirement_fulfilled_by_improvement
#define requirement_fulfilled_by_improvement(_imp_, _rqs_)
Definition requirements.h:415
requirement_vector_iterate_end
#define requirement_vector_iterate_end
Definition requirements.h:94
requirement_vector_iterate
#define requirement_vector_iterate(req_vec, preq)
Definition requirements.h:92
research_goal_unknown_techs
int research_goal_unknown_techs(const struct research *presearch, Tech_type_id goal)
Definition research.c:750
research_invention_reachable
bool research_invention_reachable(const struct research *presearch, const Tech_type_id tech)
Definition research.c:668
research_goal_bulbs_required
int research_goal_bulbs_required(const struct research *presearch, Tech_type_id goal)
Definition research.c:772
research_total_bulbs_required
int research_total_bulbs_required(const struct research *presearch, Tech_type_id tech, bool loss_value)
Definition research.c:868
research_get
struct research * research_get(const struct player *pplayer)
Definition research.c:128
research_invention_state
enum tech_state research_invention_state(const struct research *presearch, Tech_type_id tech)
Definition research.c:619
research.h
road_has_flag
bool road_has_flag(const struct road_type *proad, enum road_flag_id flag)
Definition road.c:410
road_provides_move_bonus
bool road_provides_move_bonus(const struct road_type *proad)
Definition road.c:499
server_setting_by_name
server_setting_id server_setting_by_name(const char *name)
Definition server_settings.c:29
server_setting_value_bool_get
bool server_setting_value_bool_get(server_setting_id id)
Definition server_settings.c:70
server_settings.h
level
struct setting_list * level[OLEVELS_NUM]
Definition settings.c:190
compare_strings
int compare_strings(const void *first, const void *second)
Definition shared.c:359
fileinfoname
const char * fileinfoname(const struct strvec *dirs, const char *filename)
Definition shared.c:1101
get_data_dirs
const struct strvec * get_data_dirs(void)
Definition shared.c:893
ARRAY_SIZE
#define ARRAY_SIZE(x)
Definition shared.h:85
MIN
#define MIN(x, y)
Definition shared.h:55
MAX
#define MAX(x, y)
Definition shared.h:54
specialist_by_number
struct specialist * specialist_by_number(const Specialist_type_id id)
Definition specialist.c:100
specialist_plural_translation
const char * specialist_plural_translation(const struct specialist *sp)
Definition specialist.c:155
specialist.h
specialist_type_iterate_end
#define specialist_type_iterate_end
Definition specialist.h:79
specialist_type_iterate
#define specialist_type_iterate(sp)
Definition specialist.h:73
speclist.h
size
size_t size
Definition specvec.h:72
strvec_destroy
void strvec_destroy(struct strvec *psv)
Definition string_vector.c:72
strvec_append
void strvec_append(struct strvec *psv, const char *string)
Definition string_vector.c:279
strvec_to_or_list
const char * strvec_to_or_list(const struct strvec *psv, struct astring *astr)
Definition string_vector.c:429
strvec_new
struct strvec * strvec_new(void)
Definition string_vector.c:59
strvec_clear
void strvec_clear(struct strvec *psv)
Definition string_vector.c:160
strvec_size
size_t strvec_size(const struct strvec *psv)
Definition string_vector.c:344
strvec_to_and_list
const char * strvec_to_and_list(const struct strvec *psv, struct astring *astr)
Definition string_vector.c:443
string_vector.h
strvec_iterate
#define strvec_iterate(psv, str)
Definition string_vector.h:61
strvec_iterate_end
#define strvec_iterate_end
Definition string_vector.h:68
action
Definition actions.h:106
action::id
action_id id
Definition actions.h:107
action::quiet
bool quiet
Definition actions.h:129
advance
Definition tech.h:124
astring
Definition astring.h:36
base_type
Definition base.h:41
civ_game::control
struct packet_ruleset_control control
Definition game.h:83
civ_game::ruleset_summary
char * ruleset_summary
Definition game.h:84
civ_game::global_init_techs
int global_init_techs[MAX_NUM_TECH_LIST]
Definition game.h:108
civ_game::info
struct packet_game_info info
Definition game.h:89
civ_game::global_init_buildings
int global_init_buildings[MAX_NUM_BUILDING_LIST]
Definition game.h:109
civ_game::scenario
struct packet_scenario_info scenario
Definition game.h:87
civ_game::ruleset_description
char * ruleset_description
Definition game.h:85
civ_game::ruleset_init
bool ruleset_init
Definition game.h:116
civ_game::rgame
struct civ_game::@30 rgame
civ_game::veteran
struct veteran_system * veteran
Definition game.h:101
civ_game::client
struct civ_game::@31::@34 client
counter
Definition counters.h:27
extra_type
Definition extras.h:88
extra_type::helptext
struct strvec * helptext
Definition extras.h:149
extra_type::road
struct road_type * road
Definition extras.h:155
extra_type::data
struct extra_type::@25 data
extra_type::removal_time
int removal_time
Definition extras.h:120
extra_type::generated
bool generated
Definition extras.h:117
extra_type::rmreqs
struct requirement_vector rmreqs
Definition extras.h:107
extra_type::visibility_req
Tech_type_id visibility_req
Definition extras.h:139
extra_type::removal_time_factor
int removal_time_factor
Definition extras.h:121
extra_type::reqs
struct requirement_vector reqs
Definition extras.h:106
extra_type::buildable
bool buildable
Definition extras.h:116
extra_type::eus
enum extra_unit_seen_type eus
Definition extras.h:128
extra_type::defense_bonus
int defense_bonus
Definition extras.h:124
extra_type::build_time
int build_time
Definition extras.h:118
extra_type::infracost
int infracost
Definition extras.h:122
extra_type::no_aggr_near_city
int no_aggr_near_city
Definition extras.h:137
extra_type::base
struct base_type * base
Definition extras.h:154
goods_type
Definition traderoutes.h:187
government
Definition government.h:52
government::helptext
struct strvec * helptext
Definition government.h:61
government::reqs
struct requirement_vector reqs
Definition government.h:58
help_item
Definition helpdata.h:25
impr_type
Definition improvement.h:50
impr_type::obsolete_by
struct requirement_vector obsolete_by
Definition improvement.h:59
impr_type::reqs
struct requirement_vector reqs
Definition improvement.h:58
impr_type::helptext
struct strvec * helptext
Definition improvement.h:65
nation_type
Definition nation.h:98
nation_type::init_buildings
int init_buildings[MAX_NUM_BUILDING_LIST]
Definition nation.h:123
nation_type::init_government
struct government * init_government
Definition nation.h:124
nation_type::init_units
struct unit_type * init_units[MAX_NUM_UNIT_LIST]
Definition nation.h:125
nation_type::legend
char * legend
Definition nation.h:107
nation_type::init_techs
int init_techs[MAX_NUM_TECH_LIST]
Definition nation.h:122
output_type
Definition city.h:259
packet_game_info::celebratesize
int celebratesize
Definition packets_gen.h:143
packet_game_info::borders
enum borders_mode borders
Definition packets_gen.h:135
packet_game_info::add_to_size_limit
int add_to_size_limit
Definition packets_gen.h:121
packet_game_info::killstack
bool killstack
Definition packets_gen.h:194
packet_game_info::nuke_pop_loss_pct
int nuke_pop_loss_pct
Definition packets_gen.h:203
packet_game_info::nuke_defender_survival_chance_pct
int nuke_defender_survival_chance_pct
Definition packets_gen.h:204
packet_game_info::tech_upkeep_style
enum tech_upkeep_style tech_upkeep_style
Definition packets_gen.h:235
packet_game_info::changable_tax
bool changable_tax
Definition packets_gen.h:144
packet_game_info::tired_attack
bool tired_attack
Definition packets_gen.h:241
packet_ruleset_control::version
char version[MAX_LEN_NAME]
Definition packets_gen.h:1485
packet_ruleset_control::num_counters
int num_counters
Definition packets_gen.h:1488
packet_ruleset_control::num_tech_classes
int num_tech_classes
Definition packets_gen.h:1461
packet_ruleset_control::name
char name[MAX_LEN_NAME]
Definition packets_gen.h:1484
packet_scenario_info::prevent_new_cities
bool prevent_new_cities
Definition packets_gen.h:1619
player
Definition player.h:249
req_context
Definition requirements.h:100
requirement
Definition requirements.h:81
requirement::source
struct universal source
Definition requirements.h:82
research
Definition research.h:39
road_type
Definition road.h:71
section_file
Definition section_file.h:36
specialist
Definition specialist.h:29
strvec
Definition string_vector.c:29
terrain
Definition terrain.h:75
terrain::helptext
struct strvec * helptext
Definition terrain.h:156
terrain::irrigation_food_incr
int irrigation_food_incr
Definition terrain.h:114
terrain::output
int output[O_LAST]
Definition terrain.h:95
terrain::road_output_incr_pct
int road_output_incr_pct[O_LAST]
Definition terrain.h:104
terrain::mining_shield_incr
int mining_shield_incr
Definition terrain.h:117
tileset
Definition tilespec.c:481
unit_class
Definition unittype.h:149
unit_type
Definition unittype.h:507
unit_type::transport_capacity
int transport_capacity
Definition unittype.h:530
unit_type::pop_cost
int pop_cost
Definition unittype.h:520
unit_type::build_reqs
struct requirement_vector build_reqs
Definition unittype.h:527
unit_type::defense_strength
int defense_strength
Definition unittype.h:523
unit_type::paratroopers_range
int paratroopers_range
Definition unittype.h:548
unit_type::convert_time
int convert_time
Definition unittype.h:538
unit_type::city_size
int city_size
Definition unittype.h:557
unit_type::veteran
struct veteran_system * veteran
Definition unittype.h:551
unit_type::obsoleted_by
const struct unit_type * obsoleted_by
Definition unittype.h:536
unit_type::targets
bv_unit_classes targets
Definition unittype.h:568
unit_type::vlayer
enum vision_layer vlayer
Definition unittype.h:576
unit_type::helptext
struct strvec * helptext
Definition unittype.h:578
unit_type::bombard_rate
int bombard_rate
Definition unittype.h:554
unit_type::upkeep
int upkeep[O_LAST]
Definition unittype.h:545
unit_type::disembarks
bv_unit_classes disembarks
Definition unittype.h:574
unit_type::converted_to
const struct unit_type * converted_to
Definition unittype.h:537
unit_type::embarks
bv_unit_classes embarks
Definition unittype.h:571
unit_type::happy_cost
int happy_cost
Definition unittype.h:544
unit_type::bonuses
struct combat_bonus_list * bonuses
Definition unittype.h:533
universal
Definition fc_types.h:908
universal::kind
enum universals_n kind
Definition fc_types.h:910
universal::value
universals_u value
Definition fc_types.h:909
veteran_level
Definition unittype.h:493
veteran_system
Definition unittype.h:501
veteran_system::definitions
struct veteran_level * definitions
Definition unittype.h:504
veteran_system::levels
int levels
Definition unittype.h:502
fc_snprintf
int fc_snprintf(char *str, size_t n, const char *format,...)
Definition support.c:960
fc_strlcpy
size_t fc_strlcpy(char *dest, const char *src, size_t n)
Definition support.c:777
fc_strcasecmp
int fc_strcasecmp(const char *str0, const char *str1)
Definition support.c:186
fc_strlcat
size_t fc_strlcat(char *dest, const char *src, size_t n)
Definition support.c:822
cat_snprintf
int cat_snprintf(char *str, size_t n, const char *format,...)
Definition support.c:986
support.h
sz_strlcpy
#define sz_strlcpy(dest, src)
Definition support.h:189
TRUE
#define TRUE
Definition support.h:46
FALSE
#define FALSE
Definition support.h:47
sz_strlcat
#define sz_strlcat(dest, src)
Definition support.h:190
fc_strncmp
#define fc_strncmp(_s1_, _s2_, _len_)
Definition support.h:154
fc__fallthrough
#define fc__fallthrough
Definition support.h:119
advance_by_number
struct advance * advance_by_number(const Tech_type_id atype)
Definition tech.c:107
advance_has_flag
bool advance_has_flag(Tech_type_id tech, enum tech_flag_id flag)
Definition tech.c:216
tech_class_name_translation
const char * tech_class_name_translation(const struct tech_class *ptclass)
Definition tech.c:343
advance_requires
struct advance * advance_requires(const struct advance *padvance, enum tech_req require)
Definition tech.c:136
advance_name_translation
const char * advance_name_translation(const struct advance *padvance)
Definition tech.c:300
valid_advance_by_number
struct advance * valid_advance_by_number(const Tech_type_id id)
Definition tech.c:176
techs_have_fixed_costs
bool techs_have_fixed_costs(void)
Definition tech.c:460
tech_flag_helptxt
const char * tech_flag_helptxt(enum tech_flag_id id)
Definition tech.c:445
advance_number
Tech_type_id advance_number(const struct advance *padvance)
Definition tech.c:98
advance_index_iterate_end
#define advance_index_iterate_end
Definition tech.h:249
AR_ROOT
@ AR_ROOT
Definition tech.h:113
A_FIRST
#define A_FIRST
Definition tech.h:44
A_NONE
#define A_NONE
Definition tech.h:43
advance_root_req_iterate_end
#define advance_root_req_iterate_end
Definition tech.h:320
A_LAST
#define A_LAST
Definition tech.h:45
advance_index_iterate
#define advance_index_iterate(_start, _index)
Definition tech.h:245
advance_root_req_iterate
#define advance_root_req_iterate(_goal, _padvance)
Definition tech.h:315
terrain_name_translation
const char * terrain_name_translation(const struct terrain *pterrain)
Definition terrain.c:238
terrain_rule_name
const char * terrain_rule_name(const struct terrain *pterrain)
Definition terrain.c:247
terrain_type_terrain_class
enum terrain_class terrain_type_terrain_class(const struct terrain *pterrain)
Definition terrain.c:582
terrain_flag_helptxt
const char * terrain_flag_helptxt(enum terrain_flag_id id)
Definition terrain.c:829
terrain_extra_build_time
int terrain_extra_build_time(const struct terrain *pterrain, enum unit_activity activity, const struct extra_type *tgt)
Definition terrain.c:699
terrain_type_iterate
#define terrain_type_iterate(_p)
Definition terrain.h:266
T_NONE
#define T_NONE
Definition terrain.h:61
terrain_type_iterate_end
#define terrain_type_iterate_end
Definition terrain.h:272
terrain_has_flag
#define terrain_has_flag(terr, flag)
Definition terrain.h:176
tileset_description
const char * tileset_description(struct tileset *t)
Definition tilespec.c:7568
tileset_summary
const char * tileset_summary(struct tileset *t)
Definition tilespec.c:7560
tileset_name_get
const char * tileset_name_get(struct tileset *t)
Definition tilespec.c:7544
tileset_version
const char * tileset_version(struct tileset *t)
Definition tilespec.c:7552
tilespec.h
goods_name_translation
const char * goods_name_translation(struct goods_type *pgood)
Definition traderoutes.c:625
goods_type_iterate_end
#define goods_type_iterate_end
Definition traderoutes.h:236
goods_type_iterate
#define goods_type_iterate(_p)
Definition traderoutes.h:230
universals_u::building
const struct impr_type * building
Definition fc_types.h:721
unit.h
uclass_name_translation
const char * uclass_name_translation(const struct unit_class *pclass)
Definition unittype.c:1632
utype_action_takes_all_mp
bool utype_action_takes_all_mp(const struct unit_type *putype, struct action *paction)
Definition unittype.c:1191
utype_can_freely_unload
bool utype_can_freely_unload(const struct unit_type *pcargotype, const struct unit_type *ptranstype)
Definition unittype.c:300
unit_class_flag_helptxt
const char * unit_class_flag_helptxt(enum unit_class_flag_id id)
Definition unittype.c:1854
uclass_count
Unit_Class_id uclass_count(void)
Definition unittype.c:2445
get_role_unit
struct unit_type * get_role_unit(int role, int role_index)
Definition unittype.c:2253
utype_build_shield_cost_base
int utype_build_shield_cost_base(const struct unit_type *punittype)
Definition unittype.c:1468
utype_veteran_system
const struct veteran_system * utype_veteran_system(const struct unit_type *punittype)
Definition unittype.c:2567
num_role_units
int num_role_units(int role)
Definition unittype.c:2203
utype_can_freely_load
bool utype_can_freely_load(const struct unit_type *pcargotype, const struct unit_type *ptranstype)
Definition unittype.c:288
utype_count
Unit_type_id utype_count(void)
Definition unittype.c:80
utype_veteran_levels
int utype_veteran_levels(const struct unit_type *punittype)
Definition unittype.c:2613
utype_can_do_action_result
bool utype_can_do_action_result(const struct unit_type *putype, enum action_result result)
Definition unittype.c:387
utype_action_takes_all_mp_if_ustate_is
bool utype_action_takes_all_mp_if_ustate_is(const struct unit_type *putype, struct action *paction, const enum ustate_prop prop)
Definition unittype.c:1207
utype_veteran_level
const struct veteran_level * utype_veteran_level(const struct unit_type *punittype, int level)
Definition unittype.c:2583
utype_is_consumed_by_action
bool utype_is_consumed_by_action(const struct action *paction, const struct unit_type *utype)
Definition unittype.c:1219
utype_veteran_has_power_bonus
bool utype_veteran_has_power_bonus(const struct unit_type *punittype)
Definition unittype.c:2626
unit_type_flag_helptxt
const char * unit_type_flag_helptxt(enum unit_type_flag_id id)
Definition unittype.c:1917
utype_name_translation
const char * utype_name_translation(const struct unit_type *punittype)
Definition unittype.c:1560
can_utype_do_act_if_tgt_diplrel
bool can_utype_do_act_if_tgt_diplrel(const struct unit_type *punit_type, const action_id act_id, const int prop, const bool is_there)
Definition unittype.c:1017
utype_can_do_action
bool utype_can_do_action(const struct unit_type *putype, const action_id act_id)
Definition unittype.c:371
UCF_LAST_USER_FLAG
#define UCF_LAST_USER_FLAG
Definition unittype.h:127
uclass_has_flag
static bool uclass_has_flag(const struct unit_class *punitclass, enum unit_class_flag_id flag)
Definition unittype.h:773
utype_class
#define utype_class(_t_)
Definition unittype.h:756
utype_fuel
#define utype_fuel(ptype)
Definition unittype.h:843
combat_bonus_list_iterate_end
#define combat_bonus_list_iterate_end
Definition unittype.h:489
combat_bonus_list_iterate
#define combat_bonus_list_iterate(bonuslist, pbonus)
Definition unittype.h:487
unit_tech_reqs_iterate_end
#define unit_tech_reqs_iterate_end
Definition unittype.h:885
unit_class_iterate
#define unit_class_iterate(_p)
Definition unittype.h:912
unit_tech_reqs_iterate
#define unit_tech_reqs_iterate(_utype_, _p)
Definition unittype.h:879
utype_has_flag
static bool utype_has_flag(const struct unit_type *punittype, int flag)
Definition unittype.h:624
UTYF_LAST_USER_FLAG
#define UTYF_LAST_USER_FLAG
Definition unittype.h:337
unit_type_iterate
#define unit_type_iterate(_p)
Definition unittype.h:859
uclass_index
#define uclass_index(_c_)
Definition unittype.h:749
unit_class_iterate_end
#define unit_class_iterate_end
Definition unittype.h:919
unit_type_iterate_end
#define unit_type_iterate_end
Definition unittype.h:866
freeciv_name_version
const char * freeciv_name_version(void)
Definition version.c:35
version.h