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 */
71static 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
86static struct help_list *help_nodes;
87static 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/************************************************************************/
95void helpdata_init(void)
96{
98}
99
100/************************************************************************/
104{
106}
107
108/************************************************************************/
114static void check_help_nodes_init(void)
115{
116 if (!help_nodes_init) {
117 help_nodes_init = TRUE; /* before help_iter_start to avoid recursion! */
119 }
120}
121
122/************************************************************************/
126{
129 free(ptmp->topic);
130 free(ptmp->text);
131 free(ptmp);
134}
135
136/************************************************************************/
139static bool show_help_for_nation(const struct nation_type *pnation)
140{
141 return client_nation_is_in_current_set(pnation);
142}
143
144/************************************************************************/
149static 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;
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 */
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"));
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 */
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/************************************************************************/
208static 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;
217
219 /* TRANS: Header for fixed-width terrain alteration table.
220 * TRANS: Translators cannot change column widths :( */
221 _("Terrain Cultivate Plant Transform\n"));
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
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);
239 cultivate_result =
240 (pterrain->cultivate_result == T_NONE
242 ? ""
243 : terrain_name_translation(pterrain->cultivate_result);
244 plant_result =
245 (pterrain->plant_result == T_NONE
247 ? ""
248 : terrain_name_translation(pterrain->plant_result);
249 transform_result =
250 (pterrain->transform_result == pterrain
251 || pterrain->transform_result == T_NONE
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 */
259 cslen = 12 - (int)get_internal_string_length(cultivate_result);
260 pslen = 12 - (int)get_internal_string_length(plant_result);
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) {
276 int rmtime = pterrain->extra_removal_times[extra_index(pextra)];
277
278 if (rmtime != 0) {
279 if (clean_time < 0) {
281 } else if (clean_time != rmtime) {
282 clean_time = 0; /* Give up */
283 }
284 }
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 }
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
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 }
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 */
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 {
342 }
343 }
344 }
345
346 {
347 int time = -1, factor = -1;
348
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 }
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 {
382 }
383 }
384 }
385
386 /* Check whether there are any bases or roads whose build time is
387 * independent of terrain */
388
390 if (pextra->buildable && pextra->build_time > 0) {
392 break;
393 }
397 if (pextra->buildable && pextra->build_time > 0) {
399 break;
400 }
402 }
403
404 if (clean_time > 0 || pillage_time > 0
406 CATLSTR(outbuf, outlen, "\n");
408 _("Time taken for the following activities is independent of "
409 "terrain:\n"));
410 CATLSTR(outbuf, outlen, "\n");
412 /* TRANS: Header for fixed-width terrain alteration table.
413 * TRANS: Translators cannot change column widths :( */
414 _("Activity Time\n"));
416 "---------------------------");
417 if (clean_time > 0) {
419 _("\nClean %3d"), clean_time);
420 }
421 if (pillage_time > 0) {
423 _("\nPillage %3d"), pillage_time);
424 }
425
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
432 "\n%s%*s %3d",
433 rname,
434 MAX(0, slen), "",
435 pextra->build_time);
436 }
438
440 if (pextra->buildable && pextra->build_time > 0) {
441 const char *bname = extra_name_translation(pextra);
443
445 "\n%s%*s %3d",
446 bname,
447 MAX(0, slen), "",
448 pextra->build_time);
449 }
451 }
452
453 return TRUE;
454 } else if (0 == strcmp(name, "VeteranLevels")) {
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
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);
467
468 return TRUE;
469 } else if (0 == strcmp(name, "DefaultMetaserver")) {
471
472 return TRUE;
473 }
474 log_error("Unknown directive '$%s' in help", name);
475 return FALSE;
476}
477
478/************************************************************************/
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();
496 char buf2[bufsz];
497
498 /* FIXME: show other data like range and survives. */
499
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). */
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 }
513
514 if (0 < strvec_size(coreqs)) {
515 if (0 < strvec_size(conoreqs)) {
517 Q_(strs[0]), /* "Allows %s (with %s but no %s)." */
518 subjstr,
521 } else {
523 Q_(strs[1]), /* "Allows %s (with %s)." */
524 subjstr,
526 }
527 } else {
528 if (0 < strvec_size(conoreqs)) {
530 Q_(strs[2]), /* "Allows %s (absent %s)." */
531 subjstr,
533 } else {
535 Q_(strs[3]), /* "Allows %s." */
536 subjstr);
537 }
538 }
539 } else {
540 /* psource can, on its own, prevent the subject. */
542 Q_(strs[4]), /* "Prevents %s." */
543 subjstr);
544 }
545 cat_snprintf(buf, bufsz, "\n");
546 }
548
553}
554
555/************************************************************************/
571static void insert_allows(struct universal *psource,
572 char *buf, size_t bufsz, const char *prefix)
573{
574 buf[0] = '\0';
575
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 };
591 buf, bufsz, prefix);
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,
610 buf, bufsz, prefix);
611 }
613
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,
629 buf, bufsz, prefix);
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,
647 buf, bufsz, prefix);
649
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 };
665 buf, bufsz, prefix);
667}
668
669/************************************************************************/
672static 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/************************************************************************/
688static 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/************************************************************************/
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
724
725 /* need to do something like this or bad things happen */
727
728 if (!booted) {
729 log_verbose("Booting help texts");
730 } else {
731 /* free memory allocated last time booted */
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) {
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) {
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 */
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];
793
794 switch (current_type) {
795 case HELP_UNIT:
798 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
800 pitem->topic = fc_strdup(name);
801 pitem->text = fc_strdup("");
804 break;
805 case HELP_TECH:
809 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
811 pitem->topic = fc_strdup(name);
812 pitem->text = fc_strdup("");
814 }
816 break;
817 case HELP_TERRAIN:
818 terrain_type_iterate(pterrain) {
819 if (0 != strlen(terrain_rule_name(pterrain))) {
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("");
826 }
828 break;
829 case HELP_EXTRA:
830 {
831 const char **cats;
832 size_t 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 }
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("");
859 FC_FREE(cats);
860 }
861 break;
862 case HELP_GOODS:
865 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
867 pitem->topic = fc_strdup(name);
868 pitem->text = fc_strdup("");
871 break;
872 case HELP_SPECIALIST:
875
877 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
879 pitem->topic = fc_strdup(name);
880 pitem->text = fc_strdup("");
883 break;
884 case HELP_GOVERNMENT:
887 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
889 pitem->topic = fc_strdup(name);
890 pitem->text = fc_strdup("");
893 break;
894 case HELP_IMPROVEMENT:
895 improvement_iterate(pimprove) {
896 if (valid_improvement(pimprove) && !is_great_wonder(pimprove)) {
898 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
900 pitem->topic = fc_strdup(name);
901 pitem->text = fc_strdup("");
903 }
905 break;
906 case HELP_WONDER:
907 improvement_iterate(pimprove) {
908 if (valid_improvement(pimprove) && is_great_wonder(pimprove)) {
910 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
912 pitem->topic = fc_strdup(name);
913 pitem->text = fc_strdup("");
915 }
917 break;
918 case HELP_RULESET:
919 {
920 int desc_len;
921 int len;
922
924 /* pitem->topic = fc_strdup(_(game.control.name)); */
925 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
927 pitem->topic = fc_strdup(name);
930 } else {
931 desc_len = 0;
932 }
933 if (game.ruleset_summary != NULL) {
934 if (game.control.version[0] != '\0') {
936 + strlen(" ")
938 + strlen("\n\n")
940 + 1;
941
942 pitem->text = fc_malloc(len + desc_len);
943 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
946 } else {
948 + strlen("\n\n")
950 + 1;
951
952 pitem->text = fc_malloc(len + desc_len);
953 fc_snprintf(pitem->text, len, "%s\n\n%s",
955 }
956 } else {
957 const char *nodesc = _("Current ruleset contains no summary.");
958
959 if (game.control.version[0] != '\0') {
961 + strlen(" ")
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",
970 nodesc);
971 } else {
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",
980 nodesc);
981 }
982 }
984 fc_strlcat(pitem->text, "\n\n", len + desc_len);
986 }
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
1000 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
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 }
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
1074 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
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 }
1136 }
1137 break;
1138 case HELP_NATIONS:
1139 nations_iterate(pnation) {
1141 || show_help_for_nation(pnation)) {
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("");
1148 }
1150 break;
1151 case HELP_MULTIPLIER:
1152 multipliers_iterate(pmul) {
1153 help_text_buffer[0] = '\0';
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) {
1162 "%s%s", sep, text);
1163 sep = "\n\n";
1165 }
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';
1178 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1180 pitem->topic = fc_strdup(name);
1181 if (pcount->helptext) {
1182 strvec_iterate(pcount->helptext, text) {
1184 "%s%s", "\n\n", text);
1186 }
1189 }
1190 }
1191 break;
1192 default:
1193 log_error("Bad current_type: %d.", current_type);
1194 break;
1195 }
1201 continue;
1202 }
1203 }
1204
1205 /* It wasn't a "generate" node: */
1206
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
1221 } else {
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);
1234
1236 }
1237
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/************************************************************************/
1255{
1257 return help_list_size(help_nodes);
1258}
1259
1260/************************************************************************/
1265const struct help_item *get_help_item(int pos)
1266{
1267 int size;
1268
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*
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
1297 idx = 0;
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 }
1311
1312 if (!pitem) {
1313 idx = -1;
1314 vitem.topic = vtopic;
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/************************************************************************/
1345
1346/************************************************************************/
1350const struct help_item *help_iter_next(void)
1351{
1352 const struct help_item *pitem;
1353
1356 if (pitem) {
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/************************************************************************/
1381char *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 = {
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));
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 }
1409 if (reqs) {
1410 fc_strlcat(buf, "\n", bufsz);
1411 }
1412
1414 if (VUT_ADVANCE == pobs->source.kind && pobs->present) {
1416 _("%s The discovery of %s will make %s obsolete.\n"),
1417 BULLET,
1418 advance_name_translation(pobs->source.value.advance),
1420 }
1421 if (VUT_IMPROVEMENT == pobs->source.kind && pobs->present) {
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),
1429 }
1431
1432 if (is_small_wonder(pimprove)) {
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)) {
1442 struct unit_type *u = NULL;
1443
1444 {
1445 /* Find Manhattan dependent nuke actions */
1446 int i = 0;
1447
1450
1452 }
1453
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 }
1460
1461 if (u) {
1462 struct advance *req = NULL;
1463 int count = 0;
1464
1466 req = preq;
1467 count++;
1469
1470 if (req != NULL) {
1471 if (count == 1) {
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,
1479 } else {
1480 /* Multiple tech requirements */
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,
1487 }
1488 } else {
1490 /* TRANS: 'Allows all players to build nuclear units.' */
1491 _("%s Allows all players to build %s units.\n"), BULLET,
1493 }
1494 }
1495 }
1496
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;
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
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) {
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 }
1543 }
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. */
1552 /* TRANS: Help build Wonder */
1553 _("%s Makes it possible to target the city building it "
1554 "with the action \'%s\'.\n"), BULLET,
1556 break;
1557 case REQ_RANGE_CITY:
1558 /* At least one action enabler needed the building in its target
1559 * requirements. */
1561 /* TRANS: Help build Wonder */
1562 _("%s Makes it possible to target its city with the "
1563 "action \'%s\'.\n"), BULLET,
1565 break;
1567 /* At least one action enabler needed the building in its target
1568 * requirements. */
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,
1575 break;
1577 /* At least one action enabler needed the building in its target
1578 * requirements. */
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,
1585 break;
1586 case REQ_RANGE_PLAYER:
1587 /* At least one action enabler needed the building in its target
1588 * requirements. */
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,
1595 break;
1596 case REQ_RANGE_TEAM:
1597 /* At least one action enabler needed the building in its target
1598 * requirements. */
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,
1605 break;
1606 case REQ_RANGE_ALLIANCE:
1607 /* At least one action enabler needed the building in its target
1608 * requirements. */
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,
1615 break;
1616 case REQ_RANGE_WORLD:
1617 /* At least one action enabler needed the building in its target
1618 * requirements. */
1620 /* TRANS: Help build Wonder */
1621 _("%s Makes it possible to target all cities with the "
1622 "action \'%s\'.\n"),
1623 BULLET,
1625 break;
1626 case REQ_RANGE_TILE:
1628 case REQ_RANGE_ADJACENT:
1629 case REQ_RANGE_COUNT:
1630 log_error("The range %s is invalid for buildings.",
1632 break;
1633 }
1634 }
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;
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. */
1662 &(enabler->target_reqs))) {
1663 vulnerable = TRUE;
1664 break;
1665 } else {
1667
1668 requirement_vector_iterate(&(enabler->target_reqs), preq) {
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 }
1684
1686 /* Found a smaller range. */
1688 }
1689 }
1691
1692 if (!vulnerable) {
1693 switch (min_range) {
1694 case REQ_RANGE_LOCAL:
1696 /* TRANS: Incite City */
1697 _("%s Makes it impossible to do the action \'%s\' to "
1698 "the city building it.\n"),
1699 BULLET,
1701 break;
1702 case REQ_RANGE_CITY:
1704 /* TRANS: Incite City */
1705 _("%s Makes it impossible to do the action \'%s\' to "
1706 "its city.\n"),
1707 BULLET,
1709 break;
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,
1717 break;
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,
1725 break;
1726 case REQ_RANGE_PLAYER:
1728 /* TRANS: Incite City */
1729 _("%s Makes it impossible to do the action \'%s\' to "
1730 "any city with its owner.\n"),
1731 BULLET,
1733 break;
1734 case REQ_RANGE_TEAM:
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,
1741 break;
1742 case REQ_RANGE_ALLIANCE:
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,
1749 break;
1750 case REQ_RANGE_WORLD:
1752 /* TRANS: Incite City */
1753 _("%s Makes it impossible to do the action \'%s\' to "
1754 "any city in the game.\n"),
1755 BULLET,
1757 break;
1758 case REQ_RANGE_TILE:
1760 case REQ_RANGE_ADJACENT:
1761 case REQ_RANGE_COUNT:
1762 log_error("The range %s is invalid for buildings.",
1764 break;
1765 }
1766 }
1768
1769 {
1770 int i;
1771
1772 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
1774 if (n == B_LAST) {
1775 break;
1776 } else if (improvement_by_number(n) == pimprove) {
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) {
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 }
1808
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/************************************************************************/
1830static 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
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
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 }
1855
1856 return FALSE;
1857}
1858
1859/************************************************************************/
1866void helptext_unitclass(struct unit_class *pclass, char *buf, size_t bufsz)
1867{
1868 int flagid;
1869
1870 if (pclass->helptext != NULL) {
1871 strvec_iterate(pclass->helptext, text) {
1872 cat_snprintf(buf, bufsz, "\n%s\n", _(text));
1874 } else {
1875 CATLSTR(buf, bufsz, "\n");
1876 }
1877
1879 /* TRANS: indented unit class property, preserve leading spaces */
1880 CATLSTR(buf, bufsz, _(" %s Speed is not affected by terrain.\n"),
1881 BULLET);
1882 }
1884 /* TRANS: indented unit class property, preserve leading spaces */
1885 CATLSTR(buf, bufsz, _(" %s Does not get defense bonuses from terrain.\n"),
1886 BULLET);
1887 }
1888
1890 /* TRANS: indented unit class property, preserve leading spaces */
1891 CATLSTR(buf, bufsz, _(" %s Not subject to zones of control.\n"),
1892 BULLET);
1893 }
1894
1896 /* TRANS: indented unit class property, preserve leading spaces */
1897 CATLSTR(buf, bufsz, _(" %s Slowed down while damaged.\n"), BULLET);
1898 }
1899
1901 CATLSTR(buf, bufsz,
1902 /* TRANS: indented unit class property, preserve leading spaces */
1903 _(" %s Is unreachable. Most units cannot attack this one.\n"),
1904 BULLET);
1905 }
1906
1908 CATLSTR(buf, bufsz,
1909 /* TRANS: Indented unit class property, preserve leading spaces */
1910 _(" %s Doesn't prevent enemy cities from working the tile it's on.\n"),
1911 BULLET);
1912 }
1913
1916 const char *helptxt = unit_class_flag_helptxt(flagid);
1917
1918 if (helptxt != NULL) {
1919 /* TRANS: Indented unit class property, preserve leading spaces */
1920 CATLSTR(buf, bufsz, " %s %s\n", BULLET, _(helptxt));
1921 }
1922 }
1923 }
1924}
1925
1926/************************************************************************/
1932char *helptext_unit(char *buf, size_t bufsz, struct player *pplayer,
1933 const char *user_text, const struct unit_type *utype,
1934 bool class_help)
1935{
1936 bool has_vet_levels;
1937 int flagid;
1938 struct unit_class *pclass;
1939 int fuel;
1940
1941 fc_assert_ret_val(NULL != buf && 0 < bufsz && NULL != user_text, NULL);
1942
1943 if (!utype) {
1944 log_error("Unknown unit!");
1946 return buf;
1947 }
1948
1950
1951 buf[0] = '\0';
1952
1953 pclass = utype_class(utype);
1955 _("%s Belongs to %s unit class."),
1956 BULLET,
1958
1959 if (class_help) {
1961 } else {
1962 cat_snprintf(buf, bufsz, "\n");
1963 }
1964
1966 && !utype_has_flag(utype, UTYF_IGZOC)) {
1967 /* TRANS: Indented unit class property, preserve leading spaces */
1968 CATLSTR(buf, bufsz, _(" %s Subject to zones of control.\n"),
1969 BULLET);
1970 }
1971
1972 if (utype->defense_strength > 0) {
1973 struct universal unit_is_in_city[] = {
1974 { .kind = VUT_UTYPE, .value = { .utype = utype }},
1975 { .kind = VUT_CITYTILE, .value = { .citytile = CITYT_CENTER }},
1976 };
1977 int bonus = effect_value_from_universals(
1980
1981 if (bonus > 0) {
1983 /* TRANS: Indented unit class property, preserve leading
1984 * spaces */
1985 _(" %s Gets a %d%% defensive bonus while in cities.\n"),
1986 BULLET, bonus);
1987 }
1988 }
1991 CATLSTR(buf, bufsz,
1992 /* TRANS: Indented twice; preserve leading spaces */
1993 _(" %s Doesn't prevent enemy units from attacking other "
1994 "units on its tile.\n"), BULLET);
1995 }
1996
1997 if (can_attack_non_native(utype)) {
1998 CATLSTR(buf, bufsz,
1999 /* TRANS: Indented unit class property, preserve leading spaces */
2000 _(" %s Can attack units on non-native tiles.\n"), BULLET);
2001 }
2002
2003 /* The unit's combat bonuses. Won't mention that another unit type has a
2004 * combat bonus against this unit type. Doesn't handle complex cases like
2005 * when a unit type has multiple combat bonuses of the same kind. */
2007 const char *against[utype_count()];
2008 int targets = 0;
2009
2010 if (cbonus->quiet) {
2011 /* Handled in the help text of the ruleset. */
2012 continue;
2013 }
2014
2015 /* Find the unit types of the bonus targets. */
2017 if (utype_has_flag(utype2, cbonus->flag)) {
2019 }
2021
2022 if (targets > 0) {
2023 struct astring list = ASTRING_INIT;
2024
2025 switch (cbonus->type) {
2028 /* TRANS: percentage ... or-list of unit types */
2029 _("%s %d%% defense bonus if attacked by %s.\n"),
2030 BULLET,
2031 cbonus->value * 100,
2032 astr_build_or_list(&list, against, targets));
2033 break;
2036 /* TRANS: defense divider ... or-list of unit types */
2037 _("%s Reduces target's defense to 1 / %d when "
2038 "attacking %s.\n"), BULLET,
2039 cbonus->value + 1,
2040 astr_build_or_list(&list, against, targets));
2041 break;
2044 /* TRANS: or-list of unit types */
2045 _("%s Reduces target's firepower to 1 when "
2046 "attacking %s.\n"), BULLET,
2047 astr_build_and_list(&list, against, targets));
2048 break;
2051 /* TRANS: percentage ... or-list of unit types */
2052 _("%s %d%% defense bonus if attacked by %s.\n"),
2053 BULLET, cbonus->value,
2054 astr_build_or_list(&list, against, targets));
2055 break;
2058 /* TRANS: defense divider ... or-list of unit types */
2059 _("%s Reduces target's defense to 1 / %.2f when "
2060 "attacking %s.\n"), BULLET,
2061 ((float) cbonus->value + 100.0f) / 100.0f,
2062 astr_build_or_list(&list, against, targets));
2063 break;
2066 /* TRANS: percentage ... or-list of unit types */
2067 _("%s %d%% defense bonus "
2068 "instead of any bonuses from city improvements "
2069 "if attacked by %s in a city.\n"),
2070 BULLET, cbonus->value,
2071 astr_build_or_list(&list, against, targets));
2072 break;
2073 }
2074
2075 astr_free(&list);
2076 }
2078
2079 /* Add requirement text for the unit type itself */
2082 BULLET_SPACE);
2084
2086 CATLSTR(buf, bufsz, _("%s Can pursue escaping units and kill them.\n"),
2087 BULLET);
2088 }
2089
2090 if (utype_has_flag(utype, UTYF_NOBUILD)) {
2091 CATLSTR(buf, bufsz, _("%s May not be built in cities.\n"), BULLET);
2092 }
2093 if (utype_has_flag(utype, UTYF_BARBARIAN_ONLY)) {
2094 CATLSTR(buf, bufsz, _("%s Only barbarians may build this.\n"), BULLET);
2095 }
2097 CATLSTR(buf, bufsz, _("%s Can only be built in games where new cities "
2098 "are allowed.\n"), BULLET);
2100 /* TRANS: indented; preserve leading spaces */
2101 CATLSTR(buf, bufsz, _(" %s New cities are not allowed in the current "
2102 "game.\n"), BULLET);
2103 } else {
2104 /* TRANS: indented; preserve leading spaces */
2105 CATLSTR(buf, bufsz, _(" %s New cities are allowed in the current "
2106 "game.\n"), BULLET);
2107 }
2108 }
2109 nations_iterate(pnation) {
2110 int i, count = 0;
2111
2112 /* Avoid mentioning nations not in current set. */
2113 if (!show_help_for_nation(pnation)) {
2114 continue;
2115 }
2116 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
2117 if (!pnation->init_units[i]) {
2118 break;
2119 } else if (pnation->init_units[i] == utype) {
2120 count++;
2121 }
2122 }
2123 if (count > 0) {
2125 /* TRANS: %s is a nation plural */
2126 PL_("%s The %s start the game with %d of these units.\n",
2127 "%s The %s start the game with %d of these units.\n",
2128 count), BULLET,
2129 nation_plural_translation(pnation), count);
2130 }
2132 {
2133 const char *types[utype_count()];
2134 int i = 0;
2135
2137 if (utype2->converted_to == utype
2139 types[i++] = utype_name_translation(utype2);
2140 }
2142 if (i > 0) {
2143 struct astring list = ASTRING_INIT;
2144
2145 astr_build_or_list(&list, types, i);
2147 /* TRANS: %s is a list of unit types separated by "or". */
2148 _("%s May be obtained by conversion of %s.\n"),
2149 BULLET, astr_str(&list));
2150 astr_free(&list);
2151 }
2152 }
2153 if (utype_has_flag(utype, UTYF_NOHOME)) {
2155 CATLSTR(buf, bufsz, _("%s Built without a home city.\n"), BULLET);
2156 } else {
2157 CATLSTR(buf, bufsz, _("%s Never has a home city.\n"), BULLET);
2158 }
2159 }
2160 if (utype_has_flag(utype, UTYF_GAMELOSS)) {
2161 CATLSTR(buf, bufsz, _("%s Losing this unit will lose you the game!\n"),
2162 BULLET);
2163 }
2164 if (utype_has_flag(utype, UTYF_UNIQUE)) {
2165 CATLSTR(buf, bufsz,
2166 _("%s Each player may only have one of this type of unit.\n"),
2167 BULLET);
2168 }
2170 if (utype_has_flag(utype, flagid)) {
2171 const char *helptxt = unit_type_flag_helptxt(flagid);
2172
2173 if (helptxt != NULL) {
2174 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
2175 }
2176 }
2177 }
2178 if (utype->pop_cost > 0) {
2180 PL_("%s Costs %d population to build.\n",
2181 "%s Costs %d population to build.\n", utype->pop_cost),
2182 BULLET, utype->pop_cost);
2183 }
2184 if (0 < utype->transport_capacity) {
2185 const char *classes[uclass_count()];
2186 int i = 0;
2187 struct astring list = ASTRING_INIT;
2188
2189 unit_class_iterate(uclass) {
2190 if (can_unit_type_transport(utype, uclass)) {
2191 classes[i++] = uclass_name_translation(uclass);
2192 }
2195
2197 /* TRANS: %s is a list of unit classes separated by "or". */
2198 PL_("%s Can carry and refuel %d %s unit.\n",
2199 "%s Can carry and refuel up to %d %s units.\n",
2200 utype->transport_capacity),
2202 astr_free(&list);
2204 /* Document restrictions on when units can load/unload */
2209 if (utype_can_freely_load(pcargo, utype)) {
2211 } else {
2213 }
2214 if (utype_can_freely_unload(pcargo, utype)) {
2216 } else {
2218 }
2219 }
2221 if (has_restricted_load) {
2223 /* At least one type of cargo can load onto us freely.
2224 * The specific exceptions will be documented in cargo help. */
2225 CATLSTR(buf, bufsz,
2226 /* TRANS: indented; preserve leading spaces */
2227 _(" %s Some cargo cannot be loaded except in a city or a "
2228 "base native to this transport.\n"), BULLET);
2229 } else {
2230 /* No exceptions */
2231 CATLSTR(buf, bufsz,
2232 /* TRANS: indented; preserve leading spaces */
2233 _(" %s Cargo cannot be loaded except in a city or a "
2234 "base native to this transport.\n"), BULLET);
2235 }
2236 } /* else, no restricted cargo exists; keep quiet */
2239 /* At least one type of cargo can unload from us freely. */
2240 CATLSTR(buf, bufsz,
2241 /* TRANS: indented; preserve leading spaces */
2242 _(" %s Some cargo cannot be unloaded except in a city or a "
2243 "base native to this transport.\n"), BULLET);
2244 } else {
2245 /* No exceptions */
2246 CATLSTR(buf, bufsz,
2247 /* TRANS: indented; preserve leading spaces */
2248 _(" %s Cargo cannot be unloaded except in a city or a "
2249 "base native to this transport.\n"), BULLET);
2250 }
2251 } /* else, no restricted cargo exists; keep quiet */
2252 }
2253 }
2254 if (utype_has_flag(utype, UTYF_COAST_STRICT)) {
2255 CATLSTR(buf, bufsz, _("%s Must stay next to safe coast.\n"), BULLET);
2256 }
2257 {
2258 /* Document exceptions to embark/disembark restrictions that we
2259 * have as cargo. */
2260 bv_unit_classes embarks, disembarks;
2261 BV_CLR_ALL(embarks);
2262 BV_CLR_ALL(disembarks);
2263 /* Determine which of our transport classes have restrictions in the first
2264 * place (that is, contain at least one transport which carries at least
2265 * one type of cargo which is restricted).
2266 * We'll suppress output for classes not in this set, since this cargo
2267 * type is not behaving exceptionally in such cases. */
2270 /* Don't waste time repeating checks on classes we've already checked,
2271 * or weren't under consideration in the first place */
2272 if (!BV_ISSET(embarks, trans_class)
2273 && BV_ISSET(utype->embarks, trans_class)) {
2277 /* At least one load restriction in transport class, which
2278 * we aren't subject to */
2279 BV_SET(embarks, trans_class);
2280 }
2281 } unit_type_iterate_end; /* cargo */
2282 }
2283 if (!BV_ISSET(disembarks, trans_class)
2284 && BV_ISSET(utype->disembarks, trans_class)) {
2288 /* At least one load restriction in transport class, which
2289 * we aren't subject to */
2290 BV_SET(disembarks, trans_class);
2291 }
2292 } unit_type_iterate_end; /* cargo */
2293 }
2294 } unit_class_iterate_end; /* transports */
2295
2296 if (BV_ISSET_ANY(embarks)) {
2297 /* Build list of embark exceptions */
2298 const char *eclasses[uclass_count()];
2299 int i = 0;
2300 struct astring elist = ASTRING_INIT;
2301
2302 unit_class_iterate(uclass) {
2303 if (BV_ISSET(embarks, uclass_index(uclass))) {
2304 eclasses[i++] = uclass_name_translation(uclass);
2305 }
2308 if (BV_ARE_EQUAL(embarks, disembarks)) {
2309 /* A common case: the list of disembark exceptions is identical */
2311 /* TRANS: %s is a list of unit classes separated
2312 * by "or". */
2313 _("%s May load onto and unload from %s transports even "
2314 "when underway.\n"),
2315 BULLET, astr_str(&elist));
2316 } else {
2318 /* TRANS: %s is a list of unit classes separated
2319 * by "or". */
2320 _("%s May load onto %s transports even when underway.\n"),
2321 BULLET, astr_str(&elist));
2322 }
2323 astr_free(&elist);
2324 }
2325 if (BV_ISSET_ANY(disembarks) && !BV_ARE_EQUAL(embarks, disembarks)) {
2326 /* Build list of disembark exceptions (if different from embarking) */
2327 const char *dclasses[uclass_count()];
2328 int i = 0;
2329 struct astring dlist = ASTRING_INIT;
2330
2331 unit_class_iterate(uclass) {
2332 if (BV_ISSET(disembarks, uclass_index(uclass))) {
2333 dclasses[i++] = uclass_name_translation(uclass);
2334 }
2338 /* TRANS: %s is a list of unit classes separated
2339 * by "or". */
2340 _("%s May unload from %s transports even when underway.\n"),
2341 BULLET, astr_str(&dlist));
2342 astr_free(&dlist);
2343 }
2344 }
2345
2346 if (utype_has_flag(utype, UTYF_SPY)) {
2347 CATLSTR(buf, bufsz, _("%s Strong in diplomatic battles.\n"), BULLET);
2348 }
2349 if (utype_has_flag(utype, UTYF_DIPLOMAT)
2350 || utype_has_flag(utype, UTYF_SUPERSPY)) {
2351 CATLSTR(buf, bufsz, _("%s Defends cities against diplomatic actions.\n"),
2352 BULLET);
2353 }
2354 if (utype_has_flag(utype, UTYF_SUPERSPY)) {
2355 CATLSTR(buf, bufsz, _("%s Will never lose a diplomat-versus-diplomat fight.\n"),
2356 BULLET);
2357 }
2359 && utype_has_flag(utype, UTYF_SUPERSPY)) {
2360 CATLSTR(buf, bufsz, _("%s Will always survive a spy mission.\n"), BULLET);
2361 }
2362 if (utype->vlayer == V_INVIS) {
2363 CATLSTR(buf, bufsz,
2364 _("%s Is invisible except when next to an enemy unit or city.\n"),
2365 BULLET);
2366 }
2368 CATLSTR(buf, bufsz,
2369 _("%s Can only attack units on native tiles.\n"), BULLET);
2370 }
2371 if (utype_has_flag(utype, UTYF_CITYBUSTER)) {
2372 CATLSTR(buf, bufsz,
2373 _("%s Gets double firepower when attacking cities.\n"), BULLET);
2374 }
2375 if (utype_has_flag(utype, UTYF_IGTER)) {
2377 /* TRANS: "MP" = movement points. %s may have a
2378 * fractional part. */
2379 _("%s Ignores terrain effects (moving costs at most %s MP "
2380 "per tile).\n"), BULLET,
2382 }
2383 if (utype_has_flag(utype, UTYF_NOZOC)) {
2384 CATLSTR(buf, bufsz, _("%s Never imposes a zone of control.\n"), BULLET);
2385 } else {
2386 CATLSTR(buf, bufsz, _("%s May impose a zone of control on its adjacent "
2387 "tiles.\n"), BULLET);
2388 }
2389 if (utype_has_flag(utype, UTYF_IGZOC)) {
2390 CATLSTR(buf, bufsz, _("%s Not subject to zones of control imposed "
2391 "by other units.\n"), BULLET);
2392 }
2393 if (utype_has_flag(utype, UTYF_CIVILIAN)) {
2394 CATLSTR(buf, bufsz,
2395 _("%s A non-military unit:\n"), BULLET);
2396 CATLSTR(buf, bufsz,
2397 /* TRANS: indented; preserve leading spaces */
2398 _(" %s Cannot attack.\n"), BULLET);
2399 CATLSTR(buf, bufsz,
2400 /* TRANS: indented; preserve leading spaces */
2401 _(" %s Doesn't impose martial law.\n"), BULLET);
2402 CATLSTR(buf, bufsz,
2403 /* TRANS: indented; preserve leading spaces */
2404 _(" %s Can enter foreign territory regardless of peace treaty.\n"),
2405 BULLET);
2406 CATLSTR(buf, bufsz,
2407 /* TRANS: indented; preserve leading spaces */
2408 _(" %s Doesn't prevent enemy cities from working the tile it's on.\n"),
2409 BULLET);
2410 }
2411 if (utype_has_flag(utype, UTYF_FIELDUNIT)) {
2412 CATLSTR(buf, bufsz,
2413 _("%s A field unit: one unhappiness applies even when non-aggressive.\n"),
2414 BULLET);
2415 }
2416 if (utype_has_flag(utype, UTYF_PROVOKING)
2418 server_setting_by_name("autoattack"))) {
2419 CATLSTR(buf, bufsz,
2420 _("%s An enemy unit considering to auto attack this unit will "
2421 "choose to do so even if it has better odds when defending "
2422 "against it than when attacking it.\n"), BULLET);
2423 }
2424 if (utype_has_flag(utype, UTYF_SHIELD2GOLD)) {
2425 /* FIXME: the conversion shield => gold is activated if
2426 * EFT_SHIELD2GOLD_FACTOR is not equal null; how to determine
2427 * possible sources? */
2428 CATLSTR(buf, bufsz,
2429 _("%s Under certain conditions the shield upkeep of this unit can "
2430 "be converted to gold upkeep.\n"), BULLET);
2431 }
2432
2433 unit_class_iterate(target) {
2434 if (uclass_has_flag(target, UCF_UNREACHABLE)
2435 && BV_ISSET(utype->targets, uclass_index(target))) {
2437 _("%s Can attack against %s units, which are usually not "
2438 "reachable.\n"), BULLET,
2439 uclass_name_translation(target));
2440 }
2442
2443 fuel = utype_fuel(utype);
2444 if (fuel > 0) {
2445 const char *types[utype_count()];
2446 int i = 0;
2447
2451 }
2453
2454 if (0 == i) {
2455 if (utype_has_flag(utype, UTYF_COAST)) {
2456 if (fuel == 1) {
2458 _("%s Unit has to end each turn next to safe coast or"
2459 " in a city or a base.\n"), BULLET);
2460 } else {
2462 /* Pluralization for the benefit of languages with
2463 * duals etc */
2464 /* TRANS: Never called for 'turns = 1' case */
2465 PL_("%s Unit has to be next to safe coast, in a city or a base"
2466 " after %d turn.\n",
2467 "%s Unit has to be next to safe coast, in a city or a base"
2468 " after %d turns.\n",
2469 fuel),
2470 BULLET, fuel);
2471 }
2472 } else {
2474 PL_("%s Unit has to be in a city or a base"
2475 " after %d turn.\n",
2476 "%s Unit has to be in a city or a base"
2477 " after %d turns.\n",
2478 fuel),
2479 BULLET, fuel);
2480 }
2481 } else {
2482 struct astring list = ASTRING_INIT;
2483
2484 if (utype_has_flag(utype, UTYF_COAST)) {
2486 /* TRANS: %s is a list of unit types separated by "or" */
2487 PL_("%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2488 " after %d turn.\n",
2489 "%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2490 " after %d turns.\n",
2491 fuel),
2492 BULLET, astr_build_or_list(&list, types, i), fuel);
2493 } else {
2495 /* TRANS: %s is a list of unit types separated by "or" */
2496 PL_("%s Unit has to be in a city, a base, or on a %s"
2497 " after %d turn.\n",
2498 "%s Unit has to be in a city, a base, or on a %s"
2499 " after %d turns.\n",
2500 fuel),
2501 BULLET, astr_build_or_list(&list, types, i), fuel);
2502 }
2503 astr_free(&list);
2504 }
2505 }
2506
2507 /* Auto attack immunity. (auto_attack.if_attacker ruleset setting) */
2509 server_setting_by_name("autoattack"))) {
2511
2513 if (auto_action->cause != AAPC_UNIT_MOVED_ADJ) {
2514 /* Not relevant for auto attack. */
2515 continue;
2516 }
2517
2519 /* Can be forced to auto attack. */
2521 break;
2522 }
2524
2526 CATLSTR(buf, bufsz,
2527 _("%s Will never be forced (by the autoattack server setting)"
2528 " to attack units moving to an adjacent tile.\n"), BULLET);
2529 }
2530 }
2531
2532 action_iterate(act) {
2533 struct action *paction = action_by_number(act);
2534
2535 if (action_by_number(act)->quiet) {
2536 /* The ruleset documents this action it self. */
2537 continue;
2538 }
2539
2540 if (utype_can_do_action(utype, act)) {
2541 const char *target_adjective;
2542 char sub_target_text[100];
2543 const char *blockers[MAX_NUM_ACTIONS];
2544 int i = 0;
2545
2546 /* Generic action information. */
2548 /* TRANS: %s is the action's ruleset defined ui name */
2549 _("%s Can do the action \'%s\'.\n"),
2551
2552 switch (action_id_get_target_kind(act)) {
2553 case ATK_SELF:
2554 /* No target. */
2555 break;
2556 default:
2557 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2558 DRO_FOREIGN, TRUE)) {
2559 /* TRANS: describes the target of an action. */
2560 target_adjective = _("domestic ");
2561 } else if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2562 DRO_FOREIGN, FALSE)) {
2563 /* TRANS: describes the target of an action. */
2564 target_adjective = _("foreign ");
2565 } else {
2566 /* Both foreign and domestic targets are acceptable. */
2567 target_adjective = "";
2568 }
2569
2570 sub_target_text[0] = '\0';
2575 /* TRANS: action sub target extras with tile
2576 * extras target. */
2577 _("extras among "));
2578 } else {
2580 /* TRANS: action sub target kind. */
2581 _("%s "),
2584 }
2585 }
2586
2588 /* TRANS: First %s in %s%s%s is the sub target kind.
2589 * The next may be an adjective (that includes a space).
2590 * The next is the name of the target kind.
2591 * Example: "* is done to extras on foreign tiles." */
2592 _(" %s is done to %s%s%s.\n"), BULLET,
2596 }
2597
2600 /* TRANS: said about an action. %s is a unit type
2601 * name. */
2602 _(" %s uses up the %s.\n"), BULLET,
2603 utype_name_translation(utype));
2604 }
2605
2606 if (actres_get_battle_kind(paction->result) != ABK_NONE) {
2608 /* TRANS: The %s is a kind of battle defined in
2609 * actions.h. Example: "diplomatic battle". */
2610 _(" %s can lead to a %s against a defender.\n"),
2611 BULLET,
2614 }
2615
2616 {
2617 struct universal req_pattern[] = {
2618 { .kind = VUT_ACTION, .value.action = paction },
2619 { .kind = VUT_UTYPE, .value.utype = utype },
2620 };
2622
2627 ((100 - odds) * 100
2628 / odds))) {
2630 _(" %s may fail because of a dice throw.\n"),
2631 BULLET);
2632 }
2633 }
2634
2636 && paction->actor.is_unit.moves_actor == MAK_ESCAPE) {
2638 /* TRANS: said about an action. %s is a unit type
2639 * name. */
2640 _(" %s the %s may be captured while trying to"
2641 " escape after completing the mission.\n"),
2642 BULLET,
2643 utype_name_translation(utype));
2644 }
2645
2647 /* The dead don't care about movement loss. */
2648 } else if (utype_action_takes_all_mp(utype, paction)) {
2650 /* TRANS: Indented unit action property, preserve
2651 * leading spaces. */
2652 _(" %s ends this unit's turn.\n"),
2653 BULLET);
2655 USP_NATIVE_TILE)) {
2656 /* Used in the implementation of slow_invasion in many of the
2657 * bundled rulesets and in rulesets upgraded with rscompat from 3.0
2658 * to 3.1. */
2660 /* TRANS: Indented unit action property, preserve
2661 * leading spaces. */
2662 _(" %s ending up on a native tile"
2663 " after this action has been performed"
2664 " ends this unit's turn.\n"), BULLET);
2665 }
2666
2667 if (action_id_get_target_kind(act) != ATK_SELF) {
2668 /* Distance to target is relevant. */
2669
2670 /* FIXME: move paratroopers_range to the action and remove this
2671 * variable once actions are generalized. */
2675 MIN(paction->max_distance, utype->paratroopers_range) :
2676 paction->max_distance;
2677
2678 if (paction->min_distance == relative_max) {
2679 /* Only one distance to target is acceptable */
2680
2681 if (paction->min_distance == 0) {
2683 /* TRANS: distance between an actor unit and its
2684 * target when performing a specific action. */
2685 _(" %s target must be at the same tile.\n"),
2686 BULLET);
2687 } else {
2689 /* TRANS: distance between an actor unit and its
2690 * target when performing a specific action. */
2691 PL_(" %s target must be exactly %d tile away.\n",
2692 " %s target must be exactly %d tiles away.\n",
2693 paction->min_distance),
2694 BULLET, paction->min_distance);
2695 }
2697 /* No max distance */
2698
2699 if (paction->min_distance == 0) {
2701 /* TRANS: distance between an actor unit and its
2702 * target when performing a specific action. */
2703 _(" %s target can be anywhere.\n"), BULLET);
2704 } else {
2706 /* TRANS: distance between an actor unit and its
2707 * target when performing a specific action. */
2708 PL_(" %s target must be at least %d tile away.\n",
2709 " %s target must be at least %d tiles away.\n",
2710 paction->min_distance),
2711 BULLET, paction->min_distance);
2712 }
2713 } else if (paction->min_distance == 0) {
2714 /* No min distance */
2715
2717 /* TRANS: distance between an actor unit and its
2718 * target when performing a specific action. */
2719 PL_(" %s target can be max %d tile away.\n",
2720 " %s target can be max %d tiles away.\n",
2721 relative_max),
2723 } else {
2724 /* Full range. */
2725
2727 /* TRANS: distance between an actor unit and its
2728 * target when performing a specific action. */
2729 PL_(" %s target must be between %d and %d tile away.\n",
2730 " %s target must be between %d and %d tiles away.\n",
2731 relative_max),
2732 BULLET, paction->min_distance, relative_max);
2733 }
2734 }
2735
2736 /* The action may be a Casus Belli. */
2737 {
2738 const struct {
2739 const enum effect_type eft;
2740 const char *hlp_text;
2741 } casus_belli[] = {
2742 /* TRANS: ...performing this action ... Casus Belli */
2743 { EFT_CASUS_BELLI_SUCCESS, N_("successfully") },
2744 /* TRANS: ...performing this action ... Casus Belli */
2745 { EFT_CASUS_BELLI_CAUGHT, N_("getting caught before") },
2746 };
2747
2748 struct universal req_pattern[] = {
2749 { .kind = VUT_ACTION, .value.action = paction },
2750 { .kind = VUT_DIPLREL, /* value filled in later */ },
2751 };
2752
2753 /* First group by effect (currently getting caught and successfully
2754 * performing the action) */
2755 for (i = 0; i < ARRAY_SIZE(casus_belli); i++) {
2756 int diplrel;
2757
2758 /* DiplRel list of each Casus Belli size. */
2759 const char *victim_diplrel_names[DRO_LAST];
2760 const char *outrage_diplrel_names[DRO_LAST];
2761 int victim_diplrel_count = 0;
2762 int outrage_diplrel_count = 0;
2763
2764 /* Ignore Team and everything in diplrel_other. */
2765 for (diplrel = 0; diplrel < DS_NO_CONTACT; diplrel++) {
2767
2768 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2769 diplrel, TRUE)) {
2770 /* Can't do the action. Can't give Casus Belli. */
2771 continue;
2772 }
2773
2774 req_pattern[1].value.diplrel = diplrel;
2776 casus_belli[i].eft,
2778
2781 diplrel_name_translation(diplrel);
2782 } else if (CASUS_BELLI_VICTIM <= casus_belli_amount) {
2784 diplrel_name_translation(diplrel);
2785 }
2786 }
2787
2788 /* Then group by Casus Belli size (currently victim and
2789 * international outrage) */
2790 if (outrage_diplrel_count > 0) {
2791 struct astring list = ASTRING_INIT;
2793 /* TRANS: successfully ... Peace, or Alliance */
2794 _(" %s %s performing this action during %s causes"
2795 " international outrage: the whole world gets "
2796 "Casus Belli against you.\n"), BULLET,
2800 astr_free(&list);
2801 }
2802 if (victim_diplrel_count > 0) {
2803 struct astring list = ASTRING_INIT;
2805 /* TRANS: successfully ... Peace, or Alliance */
2806 _(" %s %s performing this action during %s gives"
2807 " the victim Casus Belli against you.\n"),
2808 BULLET,
2812 astr_free(&list);
2813 }
2814 }
2815 }
2816
2817 /* Custom action result specific information. */
2818 switch (paction->result) {
2819 case ACTRES_HELP_WONDER:
2821 /* TRANS: the %d is the number of shields the unit can
2822 * contribute. */
2823 _(" %s adds %d production.\n"), BULLET,
2825 break;
2826 case ACTRES_HEAL_UNIT:
2827 {
2828 struct universal req_pattern[] = {
2829 { .kind = VUT_ACTION, .value.action = paction },
2830 { .kind = VUT_UTYPE, .value.utype = utype },
2831 };
2832
2834 _(" %s restores up to %d%% of the target unit's"
2835 " hit points.\n"), BULLET,
2839 + 100);
2840 }
2841 break;
2842 case ACTRES_FOUND_CITY:
2845 /* TRANS: is talking about an action. */
2846 _(" %s is disabled in the current game.\n"),
2847 BULLET);
2848 }
2850 /* TRANS: the %d is initial population. */
2851 PL_(" %s initial population: %d.\n",
2852 " %s initial population: %d.\n",
2853 utype->city_size),
2854 BULLET, utype->city_size);
2855 break;
2856 case ACTRES_JOIN_CITY:
2858 /* TRANS: the %d is population. */
2859 PL_(" %s max target size: %d.\n",
2860 " %s max target size: %d.\n",
2864 /* TRANS: the %d is the population added. */
2865 PL_(" %s adds %d population.\n",
2866 " %s adds %d population.\n",
2867 utype->pop_cost),
2868 BULLET, utype->pop_cost);
2869 break;
2870 case ACTRES_BOMBARD:
2872 /* TRANS: %d is bombard rate. */
2873 _(" %s %d per turn.\n"), BULLET,
2874 utype->bombard_rate);
2876 /* TRANS: talking about bombard */
2877 _(" %s Will damage all"
2878 " defenders on a tile, and have no risk for the"
2879 " attacker.\n"), BULLET);
2880 break;
2883 /* TRANS: %s is a unit type. */
2884 _(" %s upgraded to %s or, when possible, to the unit "
2885 "type it upgrades to.\n"), BULLET,
2887 break;
2888 case ACTRES_ATTACK:
2889 if (game.info.tired_attack) {
2891 _(" %s weaker when tired. If performed with less "
2892 "than a single move point left the attack power "
2893 "is reduced accordingly.\n"), BULLET);
2894 }
2895 break;
2896 case ACTRES_WIPE_UNITS:
2898 _(" %s can wipe stack of units with zero defense.\n"),
2899 BULLET);
2900 break;
2901 case ACTRES_CONVERT:
2903 /* TRANS: %s is a unit type. "MP" = movement points. */
2904 PL_(" %s is converted into %s (takes %d MP).\n",
2905 " %s is converted into %s (takes %d MP).\n",
2906 utype->convert_time),
2907 BULLET,
2909 utype->convert_time);
2910 break;
2911 case ACTRES_SPY_NUKE:
2912 case ACTRES_NUKE:
2913 case ACTRES_NUKE_UNITS:
2914 if (game.info.nuke_pop_loss_pct > 0) {
2916 /* TRANS: percentage */
2917 _(" %s %d%% of the population of each city inside"
2918 " the nuclear blast dies.\n"), BULLET,
2920 if (game.info.nuke_pop_loss_pct < 50) {
2922 _(" %s can never destroy city completely "
2923 "(%d%% of size 1 rounds down to 0).\n"), BULLET,
2925 } else {
2927 _(" %s can even destroy city completely "
2928 "(%d%% of size 1 rounds up to 1).\n"), BULLET,
2930 }
2931 }
2934 _(" %s all units caught in the open by the nuclear"
2935 " blast die.\n"), BULLET);
2937 /* TRANS: percentage */
2938 _(" %s a unit caught in the nuclear blast while"
2939 " inside a city has a %d%% chance of survival.\n"),
2940 BULLET,
2942 } else {
2944 _(" %s all units caught in the nuclear blast"
2945 " die.\n"), BULLET);
2946 }
2947 {
2948 struct universal req_pattern[] = {
2949 { .kind = VUT_ACTION, .value.action = paction },
2950 { .kind = VUT_UTYPE, .value.utype = utype },
2951 };
2952
2953 int blast_radius_1 =
2957
2959 _(" %s has a squared blast radius of %d.\n"),
2961 }
2962
2963 break;
2964 case ACTRES_PLANT:
2965 case ACTRES_CULTIVATE:
2968 _(" %s converts target tile terrain to another"
2969 " type.\n"), BULLET);
2970 break;
2971 case ACTRES_ROAD:
2972 case ACTRES_MINE:
2973 case ACTRES_IRRIGATE:
2974 case ACTRES_BASE:
2975 {
2977 struct strvec *extras_vec = strvec_new();
2978
2979 extra_type_iterate(pextra) {
2980 if (actres_creates_extra(paction->result, pextra)) {
2982 }
2984
2985 if (strvec_size(extras_vec) > 0) {
2987 /* TRANS: %s is list of extra types separated by ',' and 'and' */
2988 cat_snprintf(buf, bufsz, _(" %s builds %s on tiles.\n"),
2991 }
2992
2994 }
2995 break;
2996 case ACTRES_CLEAN:
2997 {
2999 struct strvec *extras_vec = strvec_new();
3000
3001 extra_type_iterate(pextra) {
3002 if (actres_removes_extra(paction->result, pextra)) {
3004 }
3006
3007 if (strvec_size(extras_vec) > 0) {
3009 /* TRANS: list of extras separated by "and" */
3010 cat_snprintf(buf, bufsz, _(" %s cleans %s from tiles.\n"),
3013 }
3014
3016 }
3017 break;
3018 case ACTRES_PILLAGE:
3019 {
3021 struct strvec *extras_vec = strvec_new();
3022
3023 extra_type_iterate(pextra) {
3024 if (actres_removes_extra(paction->result, pextra)) {
3026 }
3028
3029 if (strvec_size(extras_vec) > 0) {
3031 /* TRANS: list of extras separated by "and" */
3032 cat_snprintf(buf, bufsz, _(" %s pillages %s from tiles.\n"),
3035 }
3036
3038 }
3039 break;
3040 case ACTRES_FORTIFY:
3041 {
3042 struct universal unit_is_fortified[] = {
3043 { .kind = VUT_ACTIVITY,
3044 .value = { .activity = ACTIVITY_FORTIFIED }},
3045 { .kind = VUT_UTYPE, .value = { .utype = utype }},
3046 };
3047 int bonus = effect_value_from_universals(
3050
3051 if (utype->defense_strength <= 0
3053 &(struct universal){
3054 .kind = VUT_UTYPE,
3055 .value = { .utype = utype }},
3056 1)
3057 <= 0)) {
3059 /* TRANS: indented unit action property, preserve
3060 * leading spaces */
3061 _(" %s to stay put. No defensive bonus.\n"),
3062 BULLET);
3063 } else if (bonus > 0) {
3065 /* TRANS: indented unit action property, preserve
3066 * leading spaces */
3067 _(" %s granting a %d%% defensive bonus.\n"),
3068 BULLET, bonus);
3069 }
3070 }
3071 break;
3073 {
3074 const char *targets[extra_count()];
3075 int j = 0;
3076
3077 /* Extra being native one is a hard requirement
3078 * Not using unit class native_bases cache here.
3079 * Sometimes it's not initialized when we run this,
3080 * and as this is not performance critical, no point
3081 * in using it conditionally and having this only as
3082 * fallback implementation. */
3084 if (!is_native_extra_to_uclass(pextra, pclass)) {
3085 continue;
3086 }
3087
3088 if (!territory_claiming_base(pextra->data.base)) {
3089 continue;
3090 }
3091
3092 targets[j++] = extra_name_translation(pextra);
3094
3095 if (j > 0) {
3096 struct astring list = ASTRING_INIT;
3097 /* TRANS: indented unit action property, preserve
3098 * leading spaces.
3099 * %s is a list of extra types separated by "and". */
3100 cat_snprintf(buf, bufsz, _(" %s done to %s.\n"),
3101 BULLET,
3102 astr_build_and_list(&list, targets, j));
3103 astr_free(&list);
3104 }
3105 }
3106 break;
3107 default:
3108 /* No action specific details. */
3109 break;
3110 }
3111
3112 /* Custom action sub result specific information. */
3113 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_ENTER)) {
3115 /* TRANS: indented unit action property, preserve
3116 * leading spaces. */
3117 _(" %s if a suitable hut is at the targetet tile it"
3118 " will be entered.\n"), BULLET);
3119 }
3120 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_FRIGHTEN)) {
3122 /* TRANS: indented unit action property, preserve
3123 * leading spaces. */
3124 _(" %s if a suitable hut is at the targetet tile it"
3125 " will be frightened.\n"), BULLET);
3126 }
3127 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_MAY_EMBARK)) {
3129 /* TRANS: indented unit action property, preserve
3130 * leading spaces.
3131 * The %s is the unit type name */
3132 _(" %s the %s may end up loaded into a transport if it"
3133 " can't survive on its own at the target tile.\n"),
3135 }
3136 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_NON_LETHAL)) {
3138 /* TRANS: talking about non lethal attacks */
3139 _(" %s These attacks will only damage (never kill)"
3140 " defenders.\n"), BULLET);
3141 }
3142
3143 i = 0;
3145 const struct action *blocker = action_by_number(blocker_id);
3146
3147 if (!utype_can_do_action(utype, blocker->id)) {
3148 /* Can't block since never legal. */
3149 continue;
3150 }
3151
3152 if (action_would_be_blocked_by(paction, blocker)) {
3153 /* action name alone can be MAX_LEN_NAME, leave space for extra
3154 * characters */
3155 int maxlen = MAX_LEN_NAME + 16;
3156 char *quoted = fc_malloc(maxlen);
3157
3159 /* TRANS: %s is an action that can block another. */
3160 _("\'%s\'"), action_name_translation(blocker));
3161 blockers[i] = quoted;
3162
3163 i++;
3164 }
3166
3167 if (i > 0) {
3168 struct astring blist = ASTRING_INIT;
3169
3171 /* TRANS: %s is a list of actions separated by "or". */
3172 _(" %s can't be done if %s is legal.\n"), BULLET,
3174
3175 astr_free(&blist);
3176
3177 for (; i > 0; i--) {
3178 /* The text was copied above. */
3179 free((char *)(blockers[i - 1]));
3180 }
3181 }
3182 }
3184 action_iterate(act) {
3185 struct action *paction = action_by_number(act);
3186 bool vulnerable;
3187
3188 if (action_by_number(act)->quiet) {
3189 /* The ruleset documents this action it self. */
3190 continue;
3191 }
3192
3193 /* Not relevant */
3197 continue;
3198 }
3199
3200 /* All units are immune to this since its not enabled */
3201 if (!action_is_in_use(paction)) {
3202 continue;
3203 }
3204
3205 /* Must be immune in all cases */
3206 vulnerable = FALSE;
3209 &(enabler->target_reqs))) {
3210 vulnerable = TRUE;
3211 break;
3212 }
3214
3215 if (!vulnerable) {
3217 _("%s Doing the action \'%s\' to this unit"
3218 " is impossible.\n"), BULLET,
3220 }
3222 if (!has_vet_levels) {
3223 /* Only mention this if the game generally does have veteran levels. */
3224 if (game.veteran->levels > 1) {
3225 CATLSTR(buf, bufsz, _("%s Will never achieve veteran status.\n"), BULLET);
3226 }
3227 } else {
3228 /* Not useful currently: */
3229#if 0
3230 /* Some units can never become veteran through combat in practice. */
3233 && utype->defense_strength == 0);
3234#endif
3235 /* FIXME: if we knew the raise chances on the client, we could be
3236 * more specific here about whether veteran status can be acquired
3237 * through combat/missions/work. */
3238 CATLSTR(buf, bufsz, _("%s May acquire veteran status.\n"), BULLET);
3239 if (utype_veteran_has_power_bonus(utype)) {
3241 || utype->defense_strength > 0) {
3242 CATLSTR(buf, bufsz,
3243 /* TRANS: indented; preserve leading spaces */
3244 _(" %s Veterans have increased strength in combat.\n"),
3245 BULLET);
3246 }
3247 /* SUPERSPY always wins/escapes */
3248 if (utype_has_flag(utype, UTYF_DIPLOMAT)
3249 && !utype_has_flag(utype, UTYF_SUPERSPY)) {
3250 CATLSTR(buf, bufsz,
3251 /* TRANS: indented; preserve leading spaces */
3252 _(" %s Veterans have improved chances in diplomatic "
3253 "contests.\n"), BULLET);
3254 if (utype_may_do_escape_action(utype)) {
3255 CATLSTR(buf, bufsz,
3256 /* TRANS: indented; preserve leading spaces */
3257 _(" %s Veterans are more likely to survive missions.\n"),
3258 BULLET);
3259 }
3260 }
3261 if (utype_has_flag(utype, UTYF_WORKERS)) {
3262 CATLSTR(buf, bufsz,
3263 /* TRANS: indented; preserve leading spaces */
3264 _(" %s Veterans work faster.\n"), BULLET);
3265 }
3266 }
3267 }
3268 if (strlen(buf) > 0) {
3269 CATLSTR(buf, bufsz, "\n");
3270 }
3271 if (has_vet_levels && utype->veteran) {
3272 /* The case where the unit has only a single veteran level has already
3273 * been handled above, so keep quiet here if that happens */
3274 if (insert_veteran_help(buf, bufsz, utype->veteran,
3275 _("This type of unit has its own veteran levels:"), NULL)) {
3276 CATLSTR(buf, bufsz, "\n\n");
3277 }
3278 }
3279 if (NULL != utype->helptext) {
3280 strvec_iterate(utype->helptext, text) {
3281 CATLSTR(buf, bufsz, "%s\n\n", _(text));
3283 }
3284 CATLSTR(buf, bufsz, "%s", user_text);
3285
3286 return buf;
3287}
3288
3289/************************************************************************/
3294void helptext_advance(char *buf, size_t bufsz, struct player *pplayer,
3295 const char *user_text, int i)
3296{
3297 struct astring astr = ASTRING_INIT;
3299 struct universal source = {
3300 .kind = VUT_ADVANCE,
3301 .value = {.advance = vap}
3302 };
3303 int flagid;
3304
3305 fc_assert_ret(NULL != buf && 0 < bufsz && NULL != user_text);
3307
3308 if (NULL == vap) {
3309 log_error("Unknown tech %d.", i);
3310 return;
3311 }
3312
3313 if (game.control.num_tech_classes > 0) {
3314 if (vap->tclass == NULL) {
3315 cat_snprintf(buf, bufsz, _("Belongs to the default tech class.\n\n"));
3316 } else {
3317 cat_snprintf(buf, bufsz, _("Belongs to tech class %s.\n\n"),
3319 }
3320 }
3321
3322 if (NULL != pplayer) {
3323 const struct research *presearch = research_get(pplayer);
3324
3328
3330 PL_("Starting now, researching %s would need %d bulb.",
3331 "Starting now, researching %s would need %d bulbs.",
3332 bulbs),
3335 /* Split string into two to allow localization of two pluralizations. */
3336 char buf2[MAX_LEN_MSG];
3338
3340 /* TRANS: appended to another sentence. Preserve the
3341 * leading space. */
3342 PL_(" The whole project will require %d bulb to complete.",
3343 " The whole project will require %d bulbs to complete.",
3344 bulbs),
3345 bulbs);
3347 /* TRANS: last %s is a sentence pluralized separately. */
3348 PL_("To research %s you need to research %d other"
3349 " technology first.%s",
3350 "To research %s you need to research %d other"
3351 " technologies first.%s",
3355 } else {
3356 CATLSTR(buf, bufsz,
3357 _("You cannot research this technology."));
3358 }
3361 CATLSTR(buf, bufsz,
3362 /* TRANS: preserve leading space */
3363 _(" This number may vary depending on what "
3364 "other players research.\n"));
3365 } else {
3366 CATLSTR(buf, bufsz, "\n");
3367 }
3368 }
3369
3370 CATLSTR(buf, bufsz, "\n");
3371 }
3372
3373 if (requirement_vector_size(&vap->research_reqs) > 0) {
3374 CATLSTR(buf, bufsz, _("Requirements to research:\n"));
3375 requirement_vector_iterate(&vap->research_reqs, preq) {
3376 (void) req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "");
3378 CATLSTR(buf, bufsz, "\n");
3379 }
3380
3382 BULLET_SPACE);
3383
3384 {
3385 int j;
3386
3387 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3388 if (game.rgame.global_init_techs[j] == A_LAST) {
3389 break;
3390 } else if (game.rgame.global_init_techs[j] == i) {
3391 CATLSTR(buf, bufsz,
3392 _("%s All players start the game with knowledge of this "
3393 "technology.\n"), BULLET);
3394 break;
3395 }
3396 }
3397 }
3398
3399 /* Assume no-one will set the same tech in both global and nation
3400 * init_tech... */
3401 nations_iterate(pnation) {
3402 int j;
3403
3404 /* Avoid mentioning nations not in current set. */
3405 if (!show_help_for_nation(pnation)) {
3406 continue;
3407 }
3408 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3409 if (pnation->init_techs[j] == A_LAST) {
3410 break;
3411 } else if (pnation->init_techs[j] == i) {
3413 /* TRANS: %s is a nation plural */
3414 _("%s The %s start the game with knowledge of this "
3415 "technology.\n"), BULLET,
3416 nation_plural_translation(pnation));
3417 break;
3418 }
3419 }
3421
3422 /* Explain the effects of root_reqs. */
3423 {
3425
3429 if (proot == vap) {
3430 /* Don't say anything at all if this tech is a self-root-req one;
3431 * assume that the ruleset help will explain how to get it. */
3433 break;
3434 }
3437 /* Now find out what roots each of this tech's root_req has, so that
3438 * we can suppress them. If tech A has roots B/C, and B has root C,
3439 * it's not worth saying that A needs C, and can lead to overwhelming
3440 * lists. */
3441 /* (Special case: don't do this if the root is a self-root-req tech,
3442 * since it would appear in its own root iteration; in the scenario
3443 * where S is a self-root tech that is root for T, this would prevent
3444 * S appearing in T's help.) */
3445 /* FIXME this is quite inefficient */
3449 }
3451
3452 /* Filter out all but the direct root reqs. */
3454
3455 if (BV_ISSET_ANY(roots)) {
3456 const char *root_techs[A_LAST];
3457 size_t n_roots = 0;
3459
3461 if (BV_ISSET(roots, root)) {
3464 }
3466 fc_assert(n_roots > 0);
3468 /* TRANS: 'and'-separated list of techs */
3469 _("%s Only those who know %s can acquire this "
3470 "technology (by any means).\n"),
3471 BULLET,
3474 }
3475 }
3476
3479 _("%s The first player to learn %s gets"
3480 " an immediate advance.\n"), BULLET,
3482 }
3483
3485 if (advance_has_flag(i, flagid)) {
3486 const char *helptxt = tech_flag_helptxt(flagid);
3487
3488 if (helptxt != NULL) {
3489 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3490 }
3491 }
3492 }
3493
3495 CATLSTR(buf, bufsz,
3496 _("%s To preserve this technology for our nation some bulbs "
3497 "are needed each turn.\n"), BULLET);
3498 }
3499
3500 if (NULL != vap->helptext) {
3501 if (strlen(buf) > 0) {
3502 CATLSTR(buf, bufsz, "\n");
3503 }
3504 strvec_iterate(vap->helptext, text) {
3505 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3507 }
3508
3509 astr_free(&astr);
3510}
3511
3512/************************************************************************/
3515void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer,
3516 const char *user_text, struct terrain *pterrain)
3517{
3518 struct universal source = {
3519 .kind = VUT_TERRAIN,
3520 .value = {.terrain = pterrain}
3521 };
3522 int flagid;
3523
3524 fc_assert_ret(NULL != buf && 0 < bufsz);
3525 buf[0] = '\0';
3526
3527 if (!pterrain) {
3528 log_error("Unknown terrain!");
3529 return;
3530 }
3531
3533 BULLET_SPACE);
3534 if (terrain_has_flag(pterrain, TER_NO_CITIES)) {
3535 CATLSTR(buf, bufsz,
3536 _("%s You cannot build cities on this terrain.\n"),
3537 BULLET);
3538 }
3540 /* Can't build roads; only mention if ruleset has buildable roads */
3542 if (pextra->buildable) {
3543 CATLSTR(buf, bufsz,
3544 _("%s Paths cannot be built on this terrain.\n"),
3545 BULLET);
3546 break;
3547 }
3549 }
3551 /* Can't build bases; only mention if ruleset has buildable bases */
3553 if (pextra->buildable) {
3554 CATLSTR(buf, bufsz,
3555 _("%s Bases cannot be built on this terrain.\n"),
3556 BULLET);
3557 break;
3558 }
3560 }
3561 if (terrain_has_flag(pterrain, TER_UNSAFE_COAST)
3562 && terrain_type_terrain_class(pterrain) != TC_OCEAN) {
3563 CATLSTR(buf, bufsz,
3564 _("%s The coastline of this terrain is unsafe.\n"),
3565 BULLET);
3566 }
3567 {
3568 const char *classes[uclass_count()];
3569 int i = 0;
3570
3571 unit_class_iterate(uclass) {
3572 if (is_native_to_class(uclass, pterrain, NULL)) {
3573 classes[i++] = uclass_name_translation(uclass);
3574 }
3576
3577 if (0 < i) {
3578 struct astring list = ASTRING_INIT;
3579
3580 /* TRANS: %s is a list of unit classes separated by "and". */
3581 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
3583 astr_free(&list);
3584 }
3585 }
3586 if (terrain_has_flag(pterrain, TER_NO_ZOC)) {
3587 CATLSTR(buf, bufsz,
3588 _("%s Units on this terrain neither impose zones of control "
3589 "nor are restricted by them.\n"), BULLET);
3590 } else {
3591 CATLSTR(buf, bufsz,
3592 _("%s Units on this terrain may impose a zone of control, or "
3593 "be restricted by one.\n"), BULLET);
3594 }
3595 for (flagid = TER_USER_1 ; flagid <= TER_USER_LAST; flagid++) {
3596 if (terrain_has_flag(pterrain, flagid)) {
3597 const char *helptxt = terrain_flag_helptxt(flagid);
3598
3599 if (helptxt != NULL) {
3600 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3601 }
3602 }
3603 }
3604
3605 if (NULL != pterrain->helptext) {
3606 if (buf[0] != '\0') {
3607 CATLSTR(buf, bufsz, "\n");
3608 }
3609 strvec_iterate(pterrain->helptext, text) {
3610 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3612 }
3613 if (user_text && user_text[0] != '\0') {
3614 CATLSTR(buf, bufsz, "\n\n%s", user_text);
3615 }
3616}
3617
3618/************************************************************************/
3625const char *helptext_road_bonus_str(const struct terrain *pterrain,
3626 const struct road_type *proad)
3627{
3628 static char str[64];
3629 bool has_effect = FALSE;
3630
3631 str[0] = '\0';
3633 switch (o) {
3634 case O_FOOD:
3635 case O_SHIELD:
3636 case O_TRADE:
3637 {
3638 int bonus = proad->tile_bonus[o];
3639 int incr = proad->tile_incr_const[o];
3640
3641 if (pterrain) {
3642 incr +=
3643 proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3644 }
3645 if (str[0] != '\0') {
3646 CATLSTR(str, sizeof(str), "/");
3647 }
3648 if (incr == 0 && bonus == 0) {
3649 cat_snprintf(str, sizeof(str), "%d", incr);
3650 } else {
3651 has_effect = TRUE;
3652 if (incr != 0) {
3653 cat_snprintf(str, sizeof(str), "%+d", incr);
3654 }
3655 if (bonus != 0) {
3656 cat_snprintf(str, sizeof(str), "%+d%%", bonus);
3657 }
3658 }
3659 }
3660 break;
3661 default:
3662 /* FIXME: there's nothing actually stopping roads having gold, etc
3663 * bonuses */
3664 fc_assert(proad->tile_incr_const[o] == 0
3665 && proad->tile_incr[o] == 0
3666 && proad->tile_bonus[o] == 0);
3667 break;
3668 }
3670
3671 return has_effect ? str : NULL;
3672}
3673
3674/**********************************************************************/
3680static void extra_bonus_for_terrain(struct extra_type *pextra,
3681 struct terrain *pterrain,
3682 int *bonus)
3683{
3684 struct universal req_pattern[] = {
3685 { .kind = VUT_EXTRA, .value.extra = pextra },
3686 { .kind = VUT_TERRAIN, .value.terrain = pterrain },
3687 { .kind = VUT_OTYPE /* value filled in later */ }
3688 };
3689
3690 fc_assert_ret(bonus != NULL);
3691
3692 /* Irrigation-like food bonuses */
3693 bonus[0] = (pterrain->irrigation_food_incr
3695 2 /* just extra+terrain */)) / 100;
3696
3697 /* Mining-like shield bonuses */
3698 bonus[1] = (pterrain->mining_shield_incr
3700 2 /* just extra+terrain */)) / 100;
3701
3702 bonus[2] = 0; /* no trade bonuses so far */
3703
3704 /* Now add fixed bonuses from roads (but not percentage bonus) */
3705 if (extra_road_get(pextra)) {
3706 const struct road_type *proad = extra_road_get(pextra);
3707
3709 switch (o) {
3710 case O_FOOD:
3711 case O_SHIELD:
3712 case O_TRADE:
3713 bonus[o] += proad->tile_incr_const[o]
3714 + proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3715 break;
3716 default:
3717 /* not dealing with other output types here */
3718 break;
3719 }
3721 }
3722
3723 /* Fixed bonuses for extra, possibly unrelated to terrain type */
3724
3726 /* Fill in rest of requirement template */
3727 req_pattern[2].value.outputtype = o;
3728 switch (o) {
3729 case O_FOOD:
3730 case O_SHIELD:
3731 case O_TRADE:
3735 /* Any of the above bonuses is sufficient to trigger
3736 * Output_Inc_Tile, if underlying terrain does not */
3737 if (bonus[o] > 0 || pterrain->output[o] > 0) {
3741 }
3742 break;
3743 default:
3744 break;
3745 }
3747}
3748
3749/**********************************************************************/
3756 struct terrain *pterrain,
3757 enum unit_activity act)
3758{
3759 static char buffer[256];
3760 int btime;
3761 int bonus[3];
3762
3763 btime = terrain_extra_build_time(pterrain, act, pextra);
3764 fc_snprintf(buffer, sizeof(buffer), PL_("%d turn", "%d turns", btime),
3765 btime);
3766 extra_bonus_for_terrain(pextra, pterrain, bonus);
3767 if (bonus[0] > 0) {
3768 cat_snprintf(buffer, sizeof(buffer),
3769 PL_(", +%d food", ", +%d food", bonus[0]), bonus[0]);
3770 }
3771 if (bonus[1] > 0) {
3772 cat_snprintf(buffer, sizeof(buffer),
3773 PL_(", +%d shield", ", +%d shields", bonus[1]), bonus[1]);
3774 }
3775 if (bonus[2] > 0) {
3776 cat_snprintf(buffer, sizeof(buffer),
3777 PL_(", +%d trade", ", +%d trade", bonus[2]), bonus[2]);
3778 }
3779
3780 return buffer;
3781}
3782
3783/************************************************************************/
3789void helptext_extra(char *buf, size_t bufsz, struct player *pplayer,
3790 const char *user_text, struct extra_type *pextra)
3791{
3792 size_t group_start;
3793 struct base_type *pbase;
3794 struct road_type *proad;
3795 struct universal source = {
3796 .kind = VUT_EXTRA,
3797 .value = {.extra = pextra}
3798 };
3799
3800 int flagid;
3801
3802 fc_assert_ret(NULL != buf && 0 < bufsz);
3803 buf[0] = '\0';
3804
3805 if (!pextra) {
3806 log_error("Unknown extra!");
3807 return;
3808 }
3809
3810 if (is_extra_caused_by(pextra, EC_BASE)) {
3811 pbase = pextra->data.base;
3812 } else {
3813 pbase = NULL;
3814 }
3815
3816 if (is_extra_caused_by(pextra, EC_ROAD)) {
3817 proad = pextra->data.road;
3818 } else {
3819 proad = NULL;
3820 }
3821
3822 if (pextra->helptext != NULL) {
3823 strvec_iterate(pextra->helptext, text) {
3824 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3826 }
3827
3828 /* Describe how extra is created and destroyed */
3829
3831
3832 if (pextra->buildable) {
3833 if (is_extra_caused_by(pextra, EC_IRRIGATION)) {
3834 CATLSTR(buf, bufsz,
3835 _("Build by issuing an \"irrigate\" order.\n"));
3836 }
3837 if (is_extra_caused_by(pextra, EC_MINE)) {
3838 CATLSTR(buf, bufsz,
3839 _("Build by issuing a \"mine\" order.\n"));
3840 }
3841 if (is_extra_caused_by(pextra, EC_ROAD)) {
3842 CATLSTR(buf, bufsz,
3843 _("Build by issuing a \"road\" order.\n"));
3844 }
3845 if (is_extra_caused_by(pextra, EC_BASE)) {
3846 fc_assert(pbase != NULL);
3847
3848 if (pbase->gui_type == BASE_GUI_OTHER) {
3850 _("Build by issuing a \"build base\" order.\n"));
3851 } else {
3852 const char *order = "";
3853
3854 switch (pbase->gui_type) {
3855 case BASE_GUI_FORTRESS:
3856 order = Q_(terrain_control.gui_type_base0);
3857 break;
3858 case BASE_GUI_AIRBASE:
3859 order = Q_(terrain_control.gui_type_base1);
3860 break;
3861 default:
3863 break;
3864 }
3866 /* TRANS: %s is a gui_type base string from a ruleset */
3867 _("Build by issuing a \"%s\" order.\n"), order);
3868 }
3869 }
3870 }
3871
3872 if (is_extra_caused_by(pextra, EC_POLLUTION)) {
3873 CATLSTR(buf, bufsz,
3874 _("May randomly appear around polluting city.\n"));
3875 }
3876
3877 if (is_extra_caused_by(pextra, EC_FALLOUT)) {
3878 CATLSTR(buf, bufsz,
3879 _("May randomly appear around nuclear blast.\n"));
3880 }
3881
3882 if (pextra->generated
3883 && (is_extra_caused_by(pextra, EC_HUT)
3885 || (proad != NULL && road_has_flag(proad, RF_RIVER)))) {
3886 CATLSTR(buf, bufsz,
3887 _("Placed by map generator.\n"));
3888 }
3889
3890 if (is_extra_removed_by(pextra, ERM_ENTER)) {
3891 CATLSTR(buf, bufsz,
3892 _("Can be explored by certain units.\n"));
3893 }
3894
3895 if (is_extra_caused_by(pextra, EC_APPEARANCE)) {
3896 CATLSTR(buf, bufsz,
3897 _("May appear spontaneously.\n"));
3898 }
3899
3900 if (requirement_vector_size(&pextra->reqs) > 0) {
3901 char reqsbuf[8192] = "";
3902 bool buildable = pextra->buildable
3904
3906 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
3908 buildable ? BULLET_SPACE : "");
3910 if (reqsbuf[0] != '\0') {
3911 if (buildable) {
3912 CATLSTR(buf, bufsz, _("Requirements to build:\n"));
3913 }
3914 CATLSTR(buf, bufsz, "%s", reqsbuf);
3915 }
3916 }
3917
3918 if (pextra->infracost > 0) {
3919 cat_snprintf(buf, bufsz, _("Cost: %d\n"), pextra->infracost);
3920 }
3921
3922 if (buf[group_start] != '\0') {
3923 CATLSTR(buf, bufsz, "\n"); /* group separator */
3924 }
3925
3927
3928 if (is_extra_removed_by(pextra, ERM_PILLAGE)) {
3929 int pillage_time = -1;
3930
3931 if (pextra->removal_time != 0) {
3932 pillage_time = pextra->removal_time;
3933 } else {
3934 terrain_type_iterate(pterrain) {
3935 int terr_pillage_time = pterrain->pillage_time
3936 * pextra->removal_time_factor;
3937
3938 if (terr_pillage_time != 0) {
3939 if (pillage_time < 0) {
3940 pillage_time = terr_pillage_time;
3941 } else if (pillage_time != terr_pillage_time) {
3942 /* Give up */
3943 pillage_time = -1;
3944 break;
3945 }
3946 }
3948 }
3949 if (pillage_time < 0) {
3950 CATLSTR(buf, bufsz,
3951 _("Can be pillaged by units (time is terrain-dependent).\n"));
3952 } else if (pillage_time > 0) {
3954 PL_("Can be pillaged by units (takes %d turn).\n",
3955 "Can be pillaged by units (takes %d turns).\n",
3956 pillage_time), pillage_time);
3957 }
3958 }
3959 if (is_extra_removed_by(pextra, ERM_CLEAN)) {
3960 int clean_time = -1;
3961
3962 if (pextra->removal_time != 0) {
3963 clean_time = pextra->removal_time;
3964 } else {
3965 terrain_type_iterate(pterrain) {
3966 int terr_clean_time = -1;
3967 int rmtime = pterrain->extra_removal_times[extra_index(pextra)];
3968
3969 if (rmtime != 0) {
3971 }
3972
3973 if (clean_time < 0) {
3975 } else if (clean_time != terr_clean_time) {
3976 /* Give up */
3977 clean_time = -1;
3978 break;
3979 }
3981 }
3982
3983 if (clean_time < 0) {
3984 CATLSTR(buf, bufsz,
3985 _("Can be cleaned by units (time is terrain-dependent).\n"));
3986 } else if (clean_time > 0) {
3988 PL_("Can be cleaned by units (takes %d turn).\n",
3989 "Can be cleaned by units (takes %d turns).\n",
3991 }
3992 }
3993
3994 if (requirement_vector_size(&pextra->rmreqs) > 0) {
3995 char reqsbuf[8192] = "";
3996
3998 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
4001 if (reqsbuf[0] != '\0') {
4002 CATLSTR(buf, bufsz, _("Requirements to remove:\n"));
4003 CATLSTR(buf, bufsz, "%s", reqsbuf);
4004 }
4005 }
4006
4007 if (buf[group_start] != '\0') {
4008 CATLSTR(buf, bufsz, "\n"); /* group separator */
4009 }
4010
4011 /* Describe what other elements are enabled by extra */
4012
4014
4016
4017 if (buf[group_start] != '\0') {
4018 CATLSTR(buf, bufsz, "\n"); /* group separator */
4019 }
4020
4021 /* Describe other properties of extras */
4022
4023 if (pextra->visibility_req != A_NONE) {
4024 char vrbuf[1024];
4025
4026 fc_snprintf(vrbuf, sizeof(vrbuf),
4027 _("%s Visible only if %s known.\n"), BULLET,
4029 CATLSTR(buf, bufsz, "%s", vrbuf);
4030 }
4031
4032 if (pextra->eus == EUS_HIDDEN) {
4033 CATLSTR(buf, bufsz,
4034 _("%s Units inside are hidden from non-allied players.\n"),
4035 BULLET);
4036 }
4037
4038 {
4039 const char *classes[uclass_count()];
4040 int i = 0;
4041
4042 unit_class_iterate(uclass) {
4043 if (is_native_extra_to_uclass(pextra, uclass)) {
4044 classes[i++] = uclass_name_translation(uclass);
4045 }
4047
4048 if (0 < i) {
4049 struct astring list = ASTRING_INIT;
4050
4051 if (proad != NULL) {
4052 /* TRANS: %s is a list of unit classes separated by "and". */
4053 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
4054 BULLET,
4056 } else {
4057 /* TRANS: %s is a list of unit classes separated by "and". */
4058 cat_snprintf(buf, bufsz, _("%s Native to %s units.\n"),
4059 BULLET,
4061 }
4062 astr_free(&list);
4063
4064 if (extra_has_flag(pextra, EF_NATIVE_TILE)) {
4065 CATLSTR(buf, bufsz,
4066 /* TRANS: indented; preserve leading spaces */
4067 _(" %s Such units can move onto this tile even if it would "
4068 "not normally be suitable terrain.\n"), BULLET);
4069 }
4070
4071 if (pextra->no_aggr_near_city >= 0) {
4072 CATLSTR(buf, bufsz,
4073 /* TRANS: indented; preserve leading spaces */
4074 PL_(" %s Such units situated here are not considered aggressive "
4075 "if this tile is within %d tile of a friendly city.\n",
4076 " %s Such units situated here are not considered aggressive "
4077 "if this tile is within %d tiles of a friendly city.\n",
4078 pextra->no_aggr_near_city),
4079 BULLET, pextra->no_aggr_near_city);
4080 }
4081
4082 if (pextra->defense_bonus) {
4084 /* TRANS: indented; preserve leading spaces */
4085 _(" %s Such units get a %d%% defense bonus on this "
4086 "tile.\n"), BULLET,
4087 pextra->defense_bonus);
4088 }
4089 }
4090 }
4091
4093 const char *conquerors[utype_count()];
4094 int i = 0;
4095
4100 }
4102
4103 if (i > 0) {
4104 struct astring list = ASTRING_INIT;
4106 /* TRANS: %s is a list of unit types separated by "and". */
4107 _("%s Can be conquered by %s.\n"), BULLET,
4109 astr_free(&list);
4110 }
4111 }
4112
4114 if (proad->move_cost == 0) {
4115 CATLSTR(buf, bufsz, _("%s Allows infinite movement.\n"), BULLET);
4116 } else {
4118 /* TRANS: "MP" = movement points. Second %s may have a
4119 * fractional part. */
4120 _("%s Movement cost along %s is %s MP.\n"),
4121 BULLET,
4122 extra_name_translation(pextra),
4123 move_points_text(proad->move_cost, TRUE));
4124 }
4125 }
4126
4127 if (game.info.killstack
4128 && extra_has_flag(pextra, EF_NO_STACK_DEATH)) {
4129 CATLSTR(buf, bufsz,
4130 _("%s Defeat of one unit does not cause death of all other units "
4131 "on this tile.\n"), BULLET);
4132 }
4133 if (pbase != NULL) {
4135 CATLSTR(buf, bufsz,
4136 _("%s Extends national borders of the building nation.\n"),
4137 BULLET);
4138 }
4139 if (pbase->vision_main_sq >= 0) {
4140 CATLSTR(buf, bufsz,
4141 _("%s Grants permanent vision of an area around the tile to "
4142 "its owner.\n"), BULLET);
4143 }
4144 if (pbase->vision_invis_sq >= 0) {
4145 CATLSTR(buf, bufsz,
4146 _("%s Allows the owner to see normally invisible stealth units "
4147 "in an area around the tile.\n"), BULLET);
4148 }
4149 if (pbase->vision_subs_sq >= 0) {
4150 CATLSTR(buf, bufsz,
4151 _("%s Allows the owner to see normally invisible subsurface units "
4152 "in an area around the tile.\n"), BULLET);
4153 }
4154 }
4156 if (extra_has_flag(pextra, flagid)) {
4157 const char *helptxt = extra_flag_helptxt(flagid);
4158
4159 if (helptxt != NULL) {
4160 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
4161 }
4162 }
4163 }
4164
4165 /* Table of terrain-specific attributes, if needed */
4166 if (proad != NULL || pbase != NULL) {
4167 bool road, do_time, do_bonus;
4168
4169 road = (proad != NULL);
4170 /* Terrain-dependent build time? */
4171 do_time = pextra->buildable && pextra->build_time == 0;
4172 if (road) {
4173 /* Terrain-dependent output bonus? */
4174 do_bonus = FALSE;
4176 if (proad->tile_incr[o] > 0) {
4177 do_bonus = TRUE;
4178 fc_assert(o == O_FOOD || o == O_SHIELD || o == O_TRADE);
4179 }
4181 } else {
4182 /* Bases don't have output bonuses */
4183 do_bonus = FALSE;
4184 }
4185
4186 if (do_time || do_bonus) {
4187 if (do_time && do_bonus) {
4188 CATLSTR(buf, bufsz,
4189 _("\nTime to build and output bonus depends on terrain:\n\n"));
4190 CATLSTR(buf, bufsz,
4191 /* TRANS: Header for fixed-width road properties table.
4192 * TRANS: Translators cannot change column widths :( */
4193 _("Terrain Time Bonus F/P/T\n"
4194 "----------------------------------\n"));
4195 } else if (do_time) {
4196 CATLSTR(buf, bufsz,
4197 _("\nTime to build depends on terrain:\n\n"));
4198 CATLSTR(buf, bufsz,
4199 /* TRANS: Header for fixed-width extra properties table.
4200 * TRANS: Translators cannot change column widths :( */
4201 _("Terrain Time\n"
4202 "------------------\n"));
4203 } else {
4205 CATLSTR(buf, bufsz,
4206 /* TRANS: Header for fixed-width road properties table.
4207 * TRANS: Translators cannot change column widths :( */
4208 _("\nYields an output bonus with some terrains:\n\n"));
4209 CATLSTR(buf, bufsz,
4210 _("Terrain Bonus F/P/T\n"
4211 "-------------------------\n"));
4212 }
4214 int turns = road ? terrain_extra_build_time(t, ACTIVITY_GEN_ROAD, pextra)
4216 const char *bonus_text
4218 if (turns > 0 || bonus_text) {
4219 const char *terrain = terrain_name_translation(t);
4221
4223 "%s%*s ", terrain,
4224 MAX(0, slen),
4225 "");
4226 if (do_time) {
4227 if (turns > 0) {
4228 cat_snprintf(buf, bufsz, "%3d ", turns);
4229 } else {
4230 CATLSTR(buf, bufsz, " - ");
4231 }
4232 }
4233 if (do_bonus) {
4234 fc_assert(proad != NULL);
4235 cat_snprintf(buf, bufsz, " %s", bonus_text ? bonus_text : "-");
4236 }
4237 CATLSTR(buf, bufsz, "\n");
4238 }
4240 } /* else rely on client-specific display */
4241 }
4242
4243 if (user_text && user_text[0] != '\0') {
4244 CATLSTR(buf, bufsz, "\n\n%s", user_text);
4245 }
4246}
4247
4248/************************************************************************/
4254void helptext_goods(char *buf, size_t bufsz, struct player *pplayer,
4255 const char *user_text, struct goods_type *pgood)
4256{
4257 bool reqs = FALSE;
4258
4259 fc_assert_ret(NULL != buf && 0 < bufsz);
4260 buf[0] = '\0';
4261
4262 if (NULL != pgood->helptext) {
4263 strvec_iterate(pgood->helptext, text) {
4264 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4266 }
4267
4268 if (pgood->onetime_pct == 0) {
4270 _("There's no bonuses paid when trade route gets established.\n\n"));
4271 } else if (pgood->onetime_pct != 100) {
4273 _("When trade route gets established, %d%% of the normal bonus is paid.\n"),
4274 pgood->onetime_pct);
4275 }
4276 cat_snprintf(buf, bufsz, _("Sending city enjoys %d%% income from the route.\n"),
4277 pgood->from_pct);
4278 cat_snprintf(buf, bufsz, _("Receiving city enjoys %d%% income from the route.\n\n"),
4279 pgood->to_pct);
4280
4281 /* Requirements for this good. */
4283 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4284 reqs = TRUE;
4285 }
4287 if (reqs) {
4288 fc_strlcat(buf, "\n", bufsz);
4289 }
4290
4291 CATLSTR(buf, bufsz, "%s", user_text);
4292}
4293
4294/************************************************************************/
4300void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer,
4301 const char *user_text, struct specialist *pspec)
4302{
4303 bool reqs = FALSE;
4304
4305 fc_assert_ret(NULL != buf && 0 < bufsz);
4306 buf[0] = '\0';
4307
4308 if (NULL != pspec->helptext) {
4309 strvec_iterate(pspec->helptext, text) {
4310 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4312 }
4313
4314 /* Requirements for this specialist. */
4316 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4317 reqs = TRUE;
4318 }
4320 if (reqs) {
4321 fc_strlcat(buf, "\n", bufsz);
4322 }
4323
4324 CATLSTR(buf, bufsz, "%s", user_text);
4325}
4326
4327/************************************************************************/
4335void helptext_government(char *buf, size_t bufsz, struct player *pplayer,
4336 const char *user_text, struct government *gov)
4337{
4338 bool reqs = FALSE;
4339 struct universal source = {
4341 .value = {.govern = gov}
4342 };
4343
4344 fc_assert_ret(NULL != buf && 0 < bufsz);
4345 buf[0] = '\0';
4346
4347 if (NULL != gov->helptext) {
4348 strvec_iterate(gov->helptext, text) {
4349 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4351 }
4352
4353 /* Add requirement text for government itself */
4355 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4356 reqs = TRUE;
4357 }
4359 if (reqs) {
4360 fc_strlcat(buf, "\n", bufsz);
4361 }
4362
4363 /* Effects */
4364 CATLSTR(buf, bufsz, _("Features:\n"));
4366 BULLET_SPACE);
4369 struct unit_class *unitclass = NULL;
4370 const struct unit_type *unittype = NULL;
4372 struct strvec *outputs = strvec_new();
4375 bool too_complex = FALSE;
4376 bool world_value_valid = TRUE;
4377
4378 /* Grab output type, if there is one */
4380 /* Treat an effect with any negated requirements as too complex for
4381 * us to explain here.
4382 * Also don't try to explain an effect with any requirements explicitly
4383 * marked as 'quiet' by ruleset author. */
4384 if (!preq->present || preq->quiet) {
4385 too_complex = TRUE;
4386 continue;
4387 }
4388 switch (preq->source.kind) {
4389 case VUT_OTYPE:
4390 /* We should never have multiple outputtype requirements
4391 * in one list in the first place (it simply makes no sense,
4392 * output cannot be of multiple types)
4393 * Ruleset loading code should check against that. */
4395 output_type = preq->source.value.outputtype;
4397 break;
4398 case VUT_UCLASS:
4400 unitclass = preq->source.value.uclass;
4401 /* FIXME: can't easily get world bonus for unit class */
4403 break;
4404 case VUT_UTYPE:
4405 fc_assert(unittype == NULL);
4406 unittype = preq->source.value.utype;
4407 break;
4408 case VUT_UTFLAG:
4409 if (!unit_type_flag_id_is_valid(unitflag)) {
4410 unitflag = preq->source.value.unitflag;
4411 /* FIXME: can't easily get world bonus for unit type flag */
4413 } else {
4414 /* Already have a unit flag requirement. More than one is too
4415 * complex for us to explain, so say nothing. */
4416 /* FIXME: we could handle this */
4417 too_complex = TRUE;
4418 }
4419 break;
4420 case VUT_GOVERNMENT:
4421 /* This is government we are generating helptext for.
4422 * ...or if not, it's ruleset bug that should never make it
4423 * this far. Fix ruleset loading code. */
4424 fc_assert(preq->source.value.govern == gov);
4425 break;
4426 default:
4427 too_complex = TRUE;
4429 break;
4430 };
4432
4433 if (!too_complex) {
4434 /* Only list effects that don't have extra requirements too complex
4435 * for us to handle.
4436 * Anything more complicated will have to be documented by hand by the
4437 * ruleset author. */
4438
4439 /* Guard condition for simple player-wide effects descriptions.
4440 * (FIXME: in many cases, e.g. EFT_MAKE_CONTENT, additional requirements
4441 * like unittype will be ignored for gameplay, but will affect our
4442 * help here.) */
4443 const bool playerwide
4444 = world_value_valid && !unittype && (output_type == O_LAST);
4445 /* In some cases we give absolute values (world bonus + gov bonus).
4446 * We assume the fact that there's an effect with a gov requirement
4447 * is sufficient reason to list it in that gov's help.
4448 * Guard accesses to these with 'playerwide' or 'world_value_valid'. */
4449 int world_value = -999, net_value = -999;
4450 if (world_value_valid) {
4451 /* Get government-independent world value of effect if the extra
4452 * requirements were simple enough. */
4453 struct output_type *potype =
4455
4456 world_value =
4458 &(const struct req_context) {
4459 .unittype = unittype,
4460 .output = potype,
4461 },
4462 NULL,
4463 peffect->type);
4464 net_value = peffect->value + world_value;
4465 }
4466
4467 if (output_type == O_LAST) {
4468 /* There was no outputtype requirement. Effect is active for all
4469 * output types. Generate lists for that. */
4470 bool harvested_only = TRUE; /* Consider only output types from fields */
4471
4472 if (peffect->type == EFT_UPKEEP_FACTOR
4474 || peffect->type == EFT_OUTPUT_BONUS
4475 || peffect->type == EFT_OUTPUT_BONUS_2) {
4476 /* Effect can use or require any kind of output */
4478 }
4479
4481 struct output_type *pot = get_output_type(ot);
4482
4483 if (!harvested_only || pot->harvested) {
4484 strvec_append(outputs, _(pot->name));
4485 }
4487 }
4488
4489 if (0 == strvec_size(outputs)) {
4490 /* TRANS: Empty output type list, should never happen. */
4491 astr_set(&outputs_or, "%s", Q_("?outputlist: Nothing "));
4492 astr_set(&outputs_and, "%s", Q_("?outputlist: Nothing "));
4493 } else {
4496 }
4497
4498 switch (peffect->type) {
4499 case EFT_UNHAPPY_FACTOR:
4500 if (playerwide) {
4501 /* FIXME: EFT_MAKE_CONTENT_MIL_PER would cancel this out. We assume
4502 * no-one will set both, so we don't bother handling it. */
4504 PL_("%s Military units away from home and field units"
4505 " will each cause %d citizen to become unhappy.\n",
4506 "%s Military units away from home and field units"
4507 " will each cause %d citizens to become unhappy.\n",
4508 net_value),
4509 BULLET, net_value);
4510 } /* else too complicated or silly ruleset */
4511 break;
4513 if (playerwide && net_value != world_value) {
4514 if (world_value > 0) {
4515 if (net_value > 0) {
4517 _("%s Unhappiness from foreign citizens due to "
4518 "war with their home state is %d%% the usual "
4519 "value.\n"), BULLET,
4520 (net_value * 100) / world_value);
4521 } else {
4522 CATLSTR(buf, bufsz,
4523 _("%s No unhappiness from foreign citizens even when "
4524 "at war with their home state.\n"), BULLET);
4525 }
4526 } else {
4528 /* TRANS: not pluralised as gettext doesn't support
4529 * fractional numbers, which this might be */
4530 _("%s Each foreign citizen causes %.2g unhappiness "
4531 "in their city while you are at war with their "
4532 "home state.\n"), BULLET,
4533 (double)net_value / 100);
4534 }
4535 }
4536 break;
4538 if (playerwide) {
4540 PL_("%s Each of your cities will avoid %d unhappiness"
4541 " caused by units.\n",
4542 "%s Each of your cities will avoid %d unhappiness"
4543 " caused by units.\n",
4544 peffect->value),
4545 BULLET, peffect->value);
4546 }
4547 break;
4548 case EFT_MAKE_CONTENT:
4549 if (playerwide) {
4551 PL_("%s Each of your cities will avoid %d unhappiness,"
4552 " not including that caused by aggression.\n",
4553 "%s Each of your cities will avoid %d unhappiness,"
4554 " not including that caused by aggression.\n",
4555 peffect->value),
4556 BULLET, peffect->value);
4557 }
4558 break;
4559 case EFT_FORCE_CONTENT:
4560 if (playerwide) {
4562 PL_("%s Each of your cities will avoid %d unhappiness,"
4563 " including that caused by aggression.\n",
4564 "%s Each of your cities will avoid %d unhappiness,"
4565 " including that caused by aggression.\n",
4566 peffect->value),
4567 BULLET, peffect->value);
4568 }
4569 break;
4570 case EFT_UPKEEP_FACTOR:
4571 if (world_value_valid && !unittype) {
4572 if (net_value == 0) {
4573 if (output_type != O_LAST) {
4575 /* TRANS: %s is the output type, like 'shield'
4576 * or 'gold'. */
4577 _("%s You pay no %s upkeep for your units.\n"),
4579 } else {
4580 CATLSTR(buf, bufsz,
4581 _("%s You pay no upkeep for your units.\n"),
4582 BULLET);
4583 }
4584 } else if (net_value != world_value) {
4585 double ratio = (double)net_value / world_value;
4586 if (output_type != O_LAST) {
4588 /* TRANS: %s is the output type, like 'shield'
4589 * or 'gold'. */
4590 _("%s You pay %.2g times normal %s upkeep for your "
4591 "units.\n"), BULLET,
4593 } else {
4595 _("%s You pay %.2g times normal upkeep for your "
4596 "units.\n"), BULLET,
4597 ratio);
4598 }
4599 } /* else this effect somehow has no effect; keep quiet */
4600 } /* else there was some extra condition making it complicated */
4601 break;
4603 if (!unittype) {
4604 if (output_type != O_LAST) {
4606 /* TRANS: %s is the output type, like 'shield' or
4607 * 'gold'; pluralised in %d but there is currently
4608 * no way to control the singular/plural name of the
4609 * output type; sorry */
4610 PL_("%s Each of your cities will avoid paying %d %s"
4611 " upkeep for your units.\n",
4612 "%s Each of your cities will avoid paying %d %s"
4613 " upkeep for your units.\n", peffect->value),
4614 BULLET,
4615 peffect->value, astr_str(&outputs_and));
4616 } else {
4618 /* TRANS: Amount is subtracted from upkeep cost
4619 * for each upkeep type. */
4620 PL_("%s Each of your cities will avoid paying %d"
4621 " upkeep for your units.\n",
4622 "%s Each of your cities will avoid paying %d"
4623 " upkeep for your units.\n", peffect->value),
4624 BULLET, peffect->value);
4625 }
4626 } /* else too complicated */
4627 break;
4629 if (playerwide) {
4631 _("%s If you lose your capital,"
4632 " the base chance of civil war is %d%%.\n"),
4633 BULLET, net_value);
4634 }
4635 break;
4637 if (playerwide) {
4639 PL_("%s You can have %d city before an "
4640 "additional unhappy citizen appears in each city "
4641 "due to civilization size.\n",
4642 "%s You can have up to %d cities before an "
4643 "additional unhappy citizen appears in each city "
4644 "due to civilization size.\n", net_value),
4645 BULLET, net_value);
4646 }
4647 break;
4649 if (playerwide) {
4651 PL_("%s After the first unhappy citizen due to"
4652 " civilization size, for each %d additional city"
4653 " another unhappy citizen will appear.\n",
4654 "%s After the first unhappy citizen due to"
4655 " civilization size, for each %d additional cities"
4656 " another unhappy citizen will appear.\n",
4657 net_value),
4658 BULLET, net_value);
4659 }
4660 break;
4661 case EFT_MAX_RATES:
4663 if (net_value < 100) {
4665 _("%s The maximum rate you can set for science,"
4666 " gold, or luxuries is %d%%.\n"),
4667 BULLET, net_value);
4668 } else {
4669 CATLSTR(buf, bufsz,
4670 _("%s Has unlimited science/gold/luxuries rates.\n"),
4671 BULLET);
4672 }
4673 }
4674 break;
4676 if (playerwide) {
4678 PL_("%s Your units may impose martial law."
4679 " Each military unit inside a city will force %d"
4680 " unhappy citizen to become content.\n",
4681 "%s Your units may impose martial law."
4682 " Each military unit inside a city will force %d"
4683 " unhappy citizens to become content.\n",
4684 peffect->value),
4685 BULLET, peffect->value);
4686 }
4687 break;
4689 if (playerwide && net_value < 100) {
4691 PL_("%s A maximum of %d unit in each city can enforce"
4692 " martial law.\n",
4693 "%s A maximum of %d units in each city can enforce"
4694 " martial law.\n",
4695 net_value),
4696 BULLET, net_value);
4697 }
4698 break;
4699 case EFT_RAPTURE_GROW:
4700 if (playerwide && net_value > 0) {
4702 _("%s You may grow your cities by means of "
4703 "celebrations."), BULLET);
4704 if (game.info.celebratesize > 1) {
4706 /* TRANS: Preserve leading space. %d should always be
4707 * 2 or greater. */
4708 _(" (Cities below size %d cannot grow in this way.)"),
4710 }
4711 cat_snprintf(buf, bufsz, "\n");
4712 }
4713 break;
4715 if (playerwide) {
4717 PL_("%s If a city is in disorder for more than %d turn "
4718 "in a row, government will fall into anarchy.\n",
4719 "%s If a city is in disorder for more than %d turns "
4720 "in a row, government will fall into anarchy.\n",
4721 net_value),
4722 BULLET, net_value);
4723 }
4724 break;
4725 case EFT_HAS_SENATE:
4726 if (playerwide && net_value > 0) {
4727 CATLSTR(buf, bufsz,
4728 _("%s Has a senate that may prevent declaration of war.\n"),
4729 BULLET);
4730 }
4731 break;
4733 if (playerwide && net_value > 0) {
4734 CATLSTR(buf, bufsz,
4735 _("%s Allows partisans when cities are taken by the "
4736 "enemy.\n"), BULLET);
4737 }
4738 break;
4740 if (playerwide && net_value > 0) {
4741 CATLSTR(buf, bufsz,
4742 _("%s Buildings that normally confer bonuses against"
4743 " unhappiness will instead give gold.\n"), BULLET);
4744 }
4745 break;
4746 case EFT_FANATICS:
4747 if (playerwide && net_value > 0) {
4748 struct strvec *fanatics = strvec_new();
4750
4754 }
4757 /* TRANS: %s is list of unit types separated by 'or' */
4758 _("%s Pays no upkeep for %s.\n"), BULLET,
4762 }
4763 break;
4764 case EFT_NO_UNHAPPY:
4765 if (playerwide && net_value > 0) {
4766 CATLSTR(buf, bufsz, _("%s Has no unhappy citizens.\n"), BULLET);
4767 }
4768 break;
4769 case EFT_VETERAN_BUILD:
4770 {
4771 int conditions = 0;
4772 if (unitclass) {
4773 conditions++;
4774 }
4775 if (unittype) {
4776 conditions++;
4777 }
4778 if (unit_type_flag_id_is_valid(unitflag)) {
4779 conditions++;
4780 }
4781 if (conditions > 1) {
4782 /* More than one requirement on units, too complicated for us
4783 * to describe. */
4784 break;
4785 }
4786 if (unitclass) {
4787 /* FIXME: account for multiple veteran levels, or negative
4788 * values. This might lie for complicated rulesets! */
4790 /* TRANS: %s is a unit class */
4791 Q_("?unitclass:* New %s units will be veteran.\n"),
4793 } else if (unit_type_flag_id_is_valid(unitflag)) {
4794 /* FIXME: same problems as unitclass */
4796 /* TRANS: %s is a (translatable) unit type flag */
4797 Q_("?unitflag:* New %s units will be veteran.\n"),
4799 } else if (unittype != NULL) {
4800 if (world_value_valid && net_value > 0) {
4801 /* Here we can be specific about veteran level, and get
4802 * net value correct. */
4803 int maxlvl = utype_veteran_system(unittype)->levels - 1;
4804 const struct veteran_level *vlevel =
4807 /* TRANS: "* New Partisan units will have the rank
4808 * of elite." */
4809 Q_("?unittype:%s New %s units will have the rank "
4810 "of %s.\n"), BULLET,
4811 utype_name_translation(unittype),
4813 } /* else complicated */
4814 } else {
4815 /* No extra criteria. */
4816 /* FIXME: same problems as above */
4818 _("%s New units will be veteran.\n"), BULLET);
4819 }
4820 }
4821 break;
4823 if (world_value_valid) {
4825 /* TRANS: %s is list of output types, with 'or';
4826 * pluralised in %d but of course the output types
4827 * can't be pluralised; sorry */
4828 PL_("%s Each worked tile that gives more than %d %s will"
4829 " suffer a -1 penalty, unless the city working it"
4830 " is celebrating.",
4831 "%s Each worked tile that gives more than %d %s will"
4832 " suffer a -1 penalty, unless the city working it"
4833 " is celebrating.", net_value),
4835 if (game.info.celebratesize > 1) {
4837 /* TRANS: Preserve leading space. %d should always be
4838 * 2 or greater. */
4839 _(" (Cities below size %d will not celebrate.)"),
4841 }
4842 cat_snprintf(buf, bufsz, "\n");
4843 }
4844 break;
4847 /* TRANS: %s is list of output types, with 'or' */
4848 PL_("%s Each worked tile with at least 1 %s will yield"
4849 " %d more of it while the city working it is"
4850 " celebrating.",
4851 "%s Each worked tile with at least 1 %s will yield"
4852 " %d more of it while the city working it is"
4853 " celebrating.", peffect->value),
4854 BULLET, astr_str(&outputs_or), peffect->value);
4855 if (game.info.celebratesize > 1) {
4857 /* TRANS: Preserve leading space. %d should always be
4858 * 2 or greater. */
4859 _(" (Cities below size %d will not celebrate.)"),
4861 }
4862 cat_snprintf(buf, bufsz, "\n");
4863 break;
4866 /* TRANS: %s is list of output types, with 'or' */
4867 PL_("%s Each worked tile with at least 1 %s will yield"
4868 " %d more of it.\n",
4869 "%s Each worked tile with at least 1 %s will yield"
4870 " %d more of it.\n", peffect->value),
4871 BULLET, astr_str(&outputs_or), peffect->value);
4872 break;
4873 case EFT_OUTPUT_BONUS:
4874 case EFT_OUTPUT_BONUS_2:
4875 /* FIXME: makes most sense iff world_value == 0 */
4877 /* TRANS: %s is list of output types, with 'and' */
4878 _("%s %s production is increased %d%%.\n"),
4879 BULLET, astr_str(&outputs_and), peffect->value);
4880 break;
4881 case EFT_OUTPUT_WASTE:
4882 if (world_value_valid) {
4883 if (net_value > 30) {
4885 /* TRANS: %s is list of output types, with 'and' */
4886 _("%s %s production will suffer massive losses.\n"),
4888 } else if (net_value >= 15) {
4890 /* TRANS: %s is list of output types, with 'and' */
4891 _("%s %s production will suffer some losses.\n"),
4893 } else if (net_value > 0) {
4895 /* TRANS: %s is list of output types, with 'and' */
4896 _("%s %s production will suffer a small amount "
4897 "of losses.\n"),
4899 }
4900 }
4901 break;
4902 case EFT_HEALTH_PCT:
4903 if (playerwide) {
4904 if (peffect->value > 0) {
4905 CATLSTR(buf, bufsz, _("%s Increases the chance of plague"
4906 " within your cities.\n"), BULLET);
4907 } else if (peffect->value < 0) {
4908 CATLSTR(buf, bufsz, _("%s Decreases the chance of plague"
4909 " within your cities.\n"), BULLET);
4910 }
4911 }
4912 break;
4914 /* Semi-arbitrary scaling to get likely ruleset values in roughly
4915 * the same range as WASTE_BY_DISTANCE */
4916 /* FIXME: use different wording? */
4917 net_value = (net_value + 39) / 40; /* round up */
4918 fc__fallthrough; /* fall through to: */
4920 if (world_value_valid) {
4921 if (net_value >= 300) {
4923 /* TRANS: %s is list of output types, with 'and' */
4924 _("%s %s losses will increase quickly"
4925 " with distance from capital.\n"),
4927 } else if (net_value >= 200) {
4929 /* TRANS: %s is list of output types, with 'and' */
4930 _("%s %s losses will increase"
4931 " with distance from capital.\n"),
4933 } else if (net_value > 0) {
4935 /* TRANS: %s is list of output types, with 'and' */
4936 _("%s %s losses will increase slowly"
4937 " with distance from capital.\n"),
4939 }
4940 }
4941 break;
4942 case EFT_MIGRATION_PCT:
4943 if (playerwide) {
4944 if (peffect->value > 0) {
4945 CATLSTR(buf, bufsz, _("%s Increases the chance of migration"
4946 " into your cities.\n"), BULLET);
4947 } else if (peffect->value < 0) {
4948 CATLSTR(buf, bufsz, _("%s Decreases the chance of migration"
4949 " into your cities.\n"), BULLET);
4950 }
4951 }
4952 break;
4953 case EFT_BORDER_VISION:
4955 && playerwide && net_value > 0) {
4956 CATLSTR(buf, bufsz, _("%s All tiles inside your borders are"
4957 " monitored.\n"), BULLET);
4958 }
4959 break;
4960 default:
4961 break;
4962 };
4963 }
4964
4968
4970
4971 /* Action immunity */
4972 action_iterate(act) {
4973 if (action_by_number(act)->quiet) {
4974 /* The ruleset documents this action it self. */
4975 continue;
4976 }
4977
4978 if (action_immune_government(gov, act)) {
4980 /* TRANS: action name ... action target
4981 * ("individual units", etc) */
4982 _("%s Makes it impossible to do the action \'%s\'"
4983 " to your %s.\n"), BULLET,
4986 }
4988
4989 if (user_text && user_text[0] != '\0') {
4990 cat_snprintf(buf, bufsz, "\n%s", user_text);
4991 }
4992}
4993
4994/************************************************************************/
4997char *helptext_unit_upkeep_str(const struct unit_type *utype)
4998{
4999 static char buf[128];
5000 int any = 0;
5001
5002 if (!utype) {
5003 log_error("Unknown unit!");
5004 return "";
5005 }
5006
5007 buf[0] = '\0';
5009 if (utype->upkeep[o] > 0) {
5010 /* TRANS: "2 Food" or ", 1 Shield" */
5011 cat_snprintf(buf, sizeof(buf), _("%s%d %s"),
5012 (any > 0 ? Q_("?blistmore:, ") : ""), utype->upkeep[o],
5014 any++;
5015 }
5017 if (utype->happy_cost > 0) {
5018 /* TRANS: "2 Unhappy" or ", 1 Unhappy" */
5019 cat_snprintf(buf, sizeof(buf), _("%s%d Unhappy"),
5020 (any > 0 ? Q_("?blistmore:, ") : ""), utype->happy_cost);
5021 any++;
5022 }
5023
5024 if (any == 0) {
5025 /* strcpy(buf, _("None")); */
5026 fc_snprintf(buf, sizeof(buf), "%d", 0);
5027 }
5028 return buf;
5029}
5030
5031/************************************************************************/
5034void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation,
5035 const char *user_text)
5036{
5037 struct universal source = {
5038 .kind = VUT_NATION,
5039 .value = {.nation = pnation}
5040 };
5041 bool print_break = TRUE;
5042
5043#define PRINT_BREAK() do { \
5044 if (print_break) { \
5045 if (buf[0] != '\0') { \
5046 CATLSTR(buf, bufsz, "\n\n"); \
5047 } \
5048 print_break = FALSE; \
5049 } \
5050 } while (FALSE)
5051
5052 fc_assert_ret(NULL != buf && 0 < bufsz);
5053 buf[0] = '\0';
5054
5055 if (pnation->legend[0] != '\0') {
5056 /* Client side legend is stored already translated */
5057 cat_snprintf(buf, bufsz, "%s", pnation->legend);
5058 }
5059
5060 if (pnation->init_government) {
5061 PRINT_BREAK();
5063 _("Initial government is %s.\n"),
5065 }
5066 if (pnation->init_techs[0] != A_LAST) {
5067 const char *tech_names[MAX_NUM_TECH_LIST];
5068 int i;
5069 struct astring list = ASTRING_INIT;
5070
5071 for (i = 0; i < MAX_NUM_TECH_LIST; i++) {
5072 if (pnation->init_techs[i] == A_LAST) {
5073 break;
5074 }
5075 tech_names[i] =
5077 }
5079 PRINT_BREAK();
5080 if (game.rgame.global_init_techs[0] != A_LAST) {
5082 /* TRANS: %s is an and-separated list of techs */
5083 _("Starts with knowledge of %s in addition to the standard "
5084 "starting technologies.\n"), astr_str(&list));
5085 } else {
5087 /* TRANS: %s is an and-separated list of techs */
5088 _("Starts with knowledge of %s.\n"), astr_str(&list));
5089 }
5090 astr_free(&list);
5091 }
5092 if (pnation->init_units[0]) {
5093 const struct unit_type *utypes[MAX_NUM_UNIT_LIST];
5094 int count[MAX_NUM_UNIT_LIST];
5095 int i, j, n = 0, total = 0;
5096
5097 /* Count how many of each type there is. */
5098 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
5099 if (!pnation->init_units[i]) {
5100 break;
5101 }
5102 for (j = 0; j < n; j++) {
5103 if (pnation->init_units[i] == utypes[j]) {
5104 count[j]++;
5105 total++;
5106 break;
5107 }
5108 }
5109 if (j == n) {
5110 utypes[n] = pnation->init_units[i];
5111 count[n] = 1;
5112 total++;
5113 n++;
5114 }
5115 }
5116 {
5117 /* Construct the list of unit types and counts. */
5119 struct astring list = ASTRING_INIT;
5120
5121 for (i = 0; i < n; i++) {
5123 if (count[i] > 1) {
5124 /* TRANS: a unit type followed by a count. For instance,
5125 * "Fighter (2)" means two Fighters. Count is never 1.
5126 * Used in a list. */
5127 astr_set(&utype_names[i], _("%s (%d)"),
5128 utype_name_translation(utypes[i]), count[i]);
5129 } else {
5131 }
5132 }
5133 {
5135
5136 for (i = 0; i < n; i++) {
5138 }
5140 }
5141 for (i = 0; i < n; i++) {
5143 }
5144 PRINT_BREAK();
5146 /* TRANS: %s is an and-separated list of unit types
5147 * possibly with counts. Plurality is in total number of
5148 * units represented. */
5149 PL_("Starts with the following additional unit: %s.\n",
5150 "Starts with the following additional units: %s.\n",
5151 total), astr_str(&list));
5152 astr_free(&list);
5153 }
5154 }
5155 if (pnation->init_buildings[0] != B_LAST) {
5156 const char *impr_names[MAX_NUM_BUILDING_LIST];
5157 int i;
5158 struct astring list = ASTRING_INIT;
5159
5160 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
5161 if (pnation->init_buildings[i] == B_LAST) {
5162 break;
5163 }
5164 impr_names[i] =
5167 }
5169 PRINT_BREAK();
5172 /* TRANS: %s is an and-separated list of improvements */
5173 _("First city will get %s for free in addition to the "
5174 "standard improvements.\n"), astr_str(&list));
5175 } else {
5177 /* TRANS: %s is an and-separated list of improvements */
5178 _("First city will get %s for free.\n"), astr_str(&list));
5179 }
5180 astr_free(&list);
5181 }
5182
5183 if (buf[0] != '\0') {
5184 CATLSTR(buf, bufsz, "\n");
5185 }
5187
5188 if (user_text && user_text[0] != '\0') {
5189 if (buf[0] != '\0') {
5190 CATLSTR(buf, bufsz, "\n");
5191 }
5192 CATLSTR(buf, bufsz, "%s", user_text);
5193 }
5194#undef PRINT_BREAK
5195}
5196
5197/************************************************************************/
5201{
5202 if (req == NULL) {
5203 return HELP_LAST;
5204 }
5205
5206 if (req->source.kind == VUT_UTYPE) {
5207 return HELP_UNIT;
5208 }
5209 if (req->source.kind == VUT_IMPROVEMENT) {
5211 return HELP_WONDER;
5212 }
5213 return HELP_IMPROVEMENT;
5214 }
5215 if (req->source.kind == VUT_ADVANCE) {
5216 return HELP_TECH;
5217 }
5218 if (req->source.kind == VUT_TERRAIN) {
5219 return HELP_TERRAIN;
5220 }
5221 if (req->source.kind == VUT_EXTRA) {
5222 return HELP_EXTRA;
5223 }
5224 if (req->source.kind == VUT_GOOD) {
5225 return HELP_GOODS;
5226 }
5227 if (req->source.kind == VUT_SPECIALIST) {
5228 return HELP_SPECIALIST;
5229 }
5230 if (req->source.kind == VUT_GOVERNMENT) {
5231 return HELP_GOVERNMENT;
5232 }
5233
5234 if (req->source.kind == VUT_NATION) {
5235 return HELP_NATIONS;
5236 }
5237
5238 return HELP_LAST;
5239}
enum action_actor_kind action_get_actor_kind(const struct action *paction)
Definition actions.c:1098
const char * action_id_name_translation(action_id act_id)
Definition actions.c:1250
void action_array_add_all_by_result(action_id *act_array, int *position, enum action_result result)
Definition actions.c:5787
const char * action_name_translation(const struct action *paction)
Definition actions.c:1230
void action_array_end(action_id *act_array, int size)
Definition actions.c:5770
bool action_is_in_use(struct action *paction)
Definition actions.c:5676
enum action_sub_target_kind action_get_sub_target_kind(const struct action *paction)
Definition actions.c:1119
bool action_would_be_blocked_by(const struct action *blocked, const struct action *blocker)
Definition actions.c:1196
bool action_immune_government(struct government *gov, action_id act)
Definition actions.c:5447
int action_dice_roll_initial_odds(const struct action *paction)
Definition actions.c:5367
const char * action_target_kind_help(enum action_target_kind kind)
Definition actions.c:7592
enum action_target_kind action_get_target_kind(const struct action *paction)
Definition actions.c:1108
struct action_enabler_list * action_enablers_for_action(action_id action)
Definition actions.c:1559
#define action_id_univs_not_blocking(act_id, act_uni, tgt_uni)
Definition actions.h:710
#define action_auto_perf_iterate_end
Definition actions.h:346
static struct action * action_by_number(action_id act_id)
Definition actions.h:396
#define action_array_iterate(_act_array_, _act_id_)
Definition actions.h:257
#define action_has_result(_act_, _res_)
Definition actions.h:180
#define action_enabler_list_iterate_end
Definition actions.h:190
#define action_id_get_role(act_id)
Definition actions.h:457
#define ACTION_DISTANCE_UNLIMITED
Definition actions.h:101
#define action_array_iterate_end
Definition actions.h:269
#define action_iterate_end
Definition actions.h:214
#define MAX_NUM_ACTIONS
Definition actions.h:58
#define action_enabler_list_iterate(action_enabler_list, aenabler)
Definition actions.h:188
#define action_iterate(_act_)
Definition actions.h:210
#define action_id_get_target_kind(act_id)
Definition actions.h:413
#define action_auto_perf_iterate(_act_perf_)
Definition actions.h:334
#define ACTION_ODDS_PCT_DICE_ROLL_NA
Definition actions.h:694
bool actres_removes_extra(enum action_result result, const struct extra_type *pextra)
Definition actres.c:810
bool actres_creates_extra(enum action_result result, const struct extra_type *pextra)
Definition actres.c:789
enum action_battle_kind actres_get_battle_kind(enum action_result result)
Definition actres.c:272
void astr_free(struct astring *astr)
Definition astring.c:148
const char * astr_build_or_list(struct astring *astr, const char *const *items, size_t number)
Definition astring.c:313
void astr_set(struct astring *astr, const char *format,...)
Definition astring.c:251
const char * astr_build_and_list(struct astring *astr, const char *const *items, size_t number)
Definition astring.c:351
void astr_init(struct astring *astr)
Definition astring.c:139
#define str
Definition astring.c:76
#define n
Definition astring.c:77
static const char * astr_str(const struct astring *astr) fc__attribute((nonnull(1)))
Definition astring.h:93
#define ASTRING_INIT
Definition astring.h:44
bool territory_claiming_base(const struct base_type *pbase)
Definition base.c:162
#define BV_CLR_ALL_FROM(vec_to, vec_from)
Definition bitvector.h:135
#define BV_CLR_ALL(bv)
Definition bitvector.h:103
#define BV_SET(bv, bit)
Definition bitvector.h:89
#define BV_ARE_EQUAL(vec1, vec2)
Definition bitvector.h:121
#define BV_ISSET(bv, bit)
Definition bitvector.h:86
#define BV_ISSET_ANY(vec)
Definition bitvector.h:117
struct output_type * get_output_type(Output_type_id output)
Definition city.c:638
const char * get_output_name(Output_type_id output)
Definition city.c:629
#define output_type_iterate(output)
Definition city.h:842
#define output_type_iterate_end
Definition city.h:848
enum client_states client_state(void)
@ C_S_RUNNING
Definition client_main.h:47
bool client_nation_is_in_current_set(const struct nation_type *pnation)
Definition climisc.c:1509
static struct fc_sockaddr_list * list
Definition clinet.c:102
char * utypes
Definition comments.c:35
char * incite_cost
Definition comments.c:76
#define MAX_LEN_PACKET
Definition conn_types.h:29
#define MAX_LEN_MSG
Definition conn_types.h:37
const char * counter_name_translation(const struct counter *counter)
Definition counters.c:157
struct counter * counter_by_id(int id)
Definition counters.c:82
static void road(QVariant data1, QVariant data2)
Definition dialogs.cpp:2935
struct @22::@23 reqs
bool effect_universals_value_never_below(enum effect_type type, struct universal *unis, size_t n_unis, int min_value)
Definition effects.c:545
int effect_value_from_universals(enum effect_type type, struct universal *unis, size_t n_unis)
Definition effects.c:459
int get_target_bonus_effects(struct effect_list *plist, const struct req_context *context, const struct req_context *other_context, enum effect_type effect_type)
Definition effects.c:744
int effect_cumulative_max(enum effect_type type, struct universal *unis, size_t n_unis)
Definition effects.c:388
struct effect_list * get_req_source_effects(const struct universal *psource)
Definition effects.c:153
bool building_has_effect(const struct impr_type *pimprove, enum effect_type effect_type)
Definition effects.c:639
#define effect_list_iterate_end
Definition effects.h:81
#define effect_list_iterate(effect_list, peffect)
Definition effects.h:79
const char * extra_flag_helptxt(enum extra_flag_id id)
Definition extras.c:988
bool is_extra_caused_by_worker_action(const struct extra_type *pextra)
Definition extras.c:1046
bool extra_has_flag(const struct extra_type *pextra, enum extra_flag_id flag)
Definition extras.c:875
bool is_extra_removed_by(const struct extra_type *pextra, enum extra_rmcause rmcause)
Definition extras.c:353
int extra_count(void)
Definition extras.c:153
bool is_native_extra_to_uclass(const struct extra_type *pextra, const struct unit_class *pclass)
Definition extras.c:857
const char * extra_name_translation(const struct extra_type *pextra)
Definition extras.c:194
#define extra_type_iterate(_p)
Definition extras.h:315
#define extra_type_iterate_end
Definition extras.h:321
#define extra_type_by_rmcause_iterate_end
Definition extras.h:358
#define is_extra_caused_by(e, c)
Definition extras.h:203
#define extra_index(_e_)
Definition extras.h:183
#define extra_type_by_rmcause_iterate(_rmcause, _extra)
Definition extras.h:353
#define extra_road_get(_e_)
Definition extras.h:191
#define extra_type_by_cause_iterate_end
Definition extras.h:339
#define EF_LAST_USER_FLAG
Definition extras.h:82
#define extra_type_by_cause_iterate(_cause, _extra)
Definition extras.h:333
#define MAX_NUM_BUILDING_LIST
Definition fc_types.h:46
int Impr_type_id
Definition fc_types.h:235
int Unit_Class_id
Definition fc_types.h:275
int action_id
Definition fc_types.h:248
#define CASUS_BELLI_OUTRAGE
Definition fc_types.h:341
#define CASUS_BELLI_VICTIM
Definition fc_types.h:335
#define MAX_NUM_UNIT_LIST
Definition fc_types.h:45
#define MAX_LEN_NAME
Definition fc_types.h:66
#define MAX_NUM_TECH_LIST
Definition fc_types.h:44
@ O_SHIELD
Definition fc_types.h:101
@ O_FOOD
Definition fc_types.h:101
@ O_TRADE
Definition fc_types.h:101
@ O_LAST
Definition fc_types.h:101
@ BORDERS_ENABLED
Definition fc_types.h:746
enum output_type_id Output_type_id
Definition fc_types.h:237
size_t get_internal_string_length(const char *text)
Definition fciconv.c:396
#define Q_(String)
Definition fcintl.h:70
#define PL_(String1, String2, n)
Definition fcintl.h:71
#define _(String)
Definition fcintl.h:67
#define N_(String)
Definition fcintl.h:69
struct civ_game game
Definition game.c:61
const char * government_name_translation(const struct government *pgovern)
Definition government.c:143
#define governments_iterate(NAME_pgov)
Definition government.h:124
#define governments_iterate_end
Definition government.h:127
static struct tile * pos
Definition finddlg.c:53
static GtkWidget * source
Definition gotodlg.c:58
const char * client_string
Definition gui_main.c:106
void insert_client_build_info(char *outbuf, size_t outlen)
Definition gui_main.c:2540
void popdown_help_dialog(void)
Definition helpdlg.c:186
GType type
Definition repodlgs.c:1313
static const int bufsz
Definition helpdlg.c:70
static void extra_bonus_for_terrain(struct extra_type *pextra, struct terrain *pterrain, int *bonus)
Definition helpdata.c:3680
void help_iter_start(void)
Definition helpdata.c:1340
static int help_item_compar(const struct help_item *const *ppa, const struct help_item *const *ppb)
Definition helpdata.c:688
static bool help_nodes_init
Definition helpdata.c:87
void free_help_texts(void)
Definition helpdata.c:125
void boot_help_texts(void)
Definition helpdata.c:710
static void insert_allows(struct universal *psource, char *buf, size_t bufsz, const char *prefix)
Definition helpdata.c:571
#define CATLSTR(_b, _s, _t,...)
Definition helpdata.c:68
static bool insert_generated_text(char *outbuf, size_t outlen, const char *name)
Definition helpdata.c:208
static struct help_list * help_nodes
Definition helpdata.c:86
static const char *const help_type_names[]
Definition helpdata.c:71
void helptext_government(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct government *gov)
Definition helpdata.c:4335
void helptext_advance(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, int i)
Definition helpdata.c:3294
enum help_page_type help_type_by_requirement(const struct requirement *req)
Definition helpdata.c:5200
char * helptext_unit(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct unit_type *utype, bool class_help)
Definition helpdata.c:1932
void helptext_extra(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct extra_type *pextra)
Definition helpdata.c:3789
void helptext_unitclass(struct unit_class *pclass, char *buf, size_t bufsz)
Definition helpdata.c:1866
void helpdata_init(void)
Definition helpdata.c:95
static void check_help_nodes_init(void)
Definition helpdata.c:114
const struct help_item * get_help_item(int pos)
Definition helpdata.c:1265
int num_help_items(void)
Definition helpdata.c:1254
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
void helptext_goods(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct goods_type *pgood)
Definition helpdata.c:4254
#define BULLET_SPACE
Definition helpdata.c:65
static bool show_help_for_nation(const struct nation_type *pnation)
Definition helpdata.c:139
#define PRINT_BREAK()
const char * helptext_road_bonus_str(const struct terrain *pterrain, const struct road_type *proad)
Definition helpdata.c:3625
static const struct help_list_link * help_nodes_iterator
Definition helpdata.c:85
char * helptext_unit_upkeep_str(const struct unit_type *utype)
Definition helpdata.c:4997
#define BULLET
Definition helpdata.c:63
const char * helptext_extra_for_terrain_str(struct extra_type *pextra, struct terrain *pterrain, enum unit_activity act)
Definition helpdata.c:3755
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
#define help_list_iterate_end
Definition helpdata.c:83
static bool utype_may_do_escape_action(const struct unit_type *utype)
Definition helpdata.c:1830
void helpdata_done(void)
Definition helpdata.c:103
void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct specialist *pspec)
Definition helpdata.c:4300
const struct help_item * get_help_item_spec(const char *name, enum help_page_type htype, int *pos)
Definition helpdata.c:1288
#define help_list_iterate(helplist, phelp)
Definition helpdata.c:81
const struct help_item * help_iter_next(void)
Definition helpdata.c:1350
char * helptext_building(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct impr_type *pimprove)
Definition helpdata.c:1381
void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct terrain *pterrain)
Definition helpdata.c:3515
void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation, const char *user_text)
Definition helpdata.c:5034
static struct help_item * new_help_item(int type)
Definition helpdata.c:672
#define HELP_MUSICSET_ITEM
#define HELP_TILESET_ITEM
#define HELP_RULESET_ITEM
help_page_type
Definition helpdlg_g.h:20
@ HELP_ANY
Definition helpdlg_g.h:20
@ HELP_MUSICSET
Definition helpdlg_g.h:23
@ HELP_MULTIPLIER
Definition helpdlg_g.h:24
@ HELP_TERRAIN
Definition helpdlg_g.h:21
@ HELP_EXTRA
Definition helpdlg_g.h:21
@ HELP_NATIONS
Definition helpdlg_g.h:24
@ HELP_LAST
Definition helpdlg_g.h:25
@ HELP_IMPROVEMENT
Definition helpdlg_g.h:20
@ HELP_UNIT
Definition helpdlg_g.h:20
@ HELP_COUNTER
Definition helpdlg_g.h:24
@ HELP_SPECIALIST
Definition helpdlg_g.h:22
@ HELP_GOVERNMENT
Definition helpdlg_g.h:22
@ HELP_GOODS
Definition helpdlg_g.h:22
@ HELP_WONDER
Definition helpdlg_g.h:21
@ HELP_TECH
Definition helpdlg_g.h:21
@ HELP_RULESET
Definition helpdlg_g.h:23
@ HELP_TEXT
Definition helpdlg_g.h:20
@ HELP_TILESET
Definition helpdlg_g.h:23
const struct impr_type * valid_improvement(const struct impr_type *pimprove)
struct impr_type * improvement_by_number(const Impr_type_id id)
bool is_great_wonder(const struct impr_type *pimprove)
bool improvement_has_flag(const struct impr_type *pimprove, enum impr_flag_id flag)
const char * improvement_name_translation(const struct impr_type *pimprove)
bool is_small_wonder(const struct impr_type *pimprove)
#define improvement_iterate_end
#define improvement_iterate(_p)
#define B_LAST
Definition improvement.h:42
const char * name
Definition inputfile.c:127
#define fc_assert_ret(condition)
Definition log.h:192
#define log_verbose(message,...)
Definition log.h:110
#define fc_assert(condition)
Definition log.h:177
#define fc_assert_ret_val(condition, val)
Definition log.h:195
#define log_error(message,...)
Definition log.h:104
struct terrain_misc terrain_control
Definition map.c:68
#define FC_FREE(ptr)
Definition mem.h:41
#define fc_strdup(str)
Definition mem.h:43
#define fc_malloc(sz)
Definition mem.h:34
const char * move_points_text(int mp, bool reduce)
Definition movement.c:1016
const char * move_points_text_full(int mp, bool reduce, const char *prefix, const char *none, bool align)
Definition movement.c:949
bool is_native_to_class(const struct unit_class *punitclass, const struct terrain *pterrain, const bv_extras *extras)
Definition movement.c:341
bool can_unit_type_transport(const struct unit_type *transporter, const struct unit_class *transported)
Definition movement.c:869
bool can_attack_non_native(const struct unit_type *utype)
Definition movement.c:213
#define multipliers_iterate(_mul_)
Definition multipliers.h:61
#define multipliers_iterate_end
Definition multipliers.h:67
const char * current_musicset_version(void)
Definition music.c:242
const char * current_musicset_name(void)
Definition music.c:234
const char * current_musicset_summary(void)
Definition music.c:254
const char * current_musicset_description(void)
Definition music.c:262
static const char * name_translation_get(const struct name_translation *ptrans)
const char * nation_plural_translation(const struct nation_type *pnation)
Definition nation.c:159
#define nations_iterate_end
Definition nation.h:336
#define nations_iterate(NAME_pnation)
Definition nation.h:333
int len
Definition packhand.c:127
const char * diplrel_name_translation(int value)
Definition player.c:1631
struct section_file * secfile_load(const char *filename, bool allow_duplicates)
Definition registry.c:51
const char * secfile_error(void)
const char * section_name(const struct section *psection)
void secfile_destroy(struct section_file *secfile)
void secfile_check_unused(const struct section_file *secfile)
struct section_list * secfile_sections_by_name_prefix(const struct section_file *secfile, const char *prefix)
const char ** secfile_lookup_str_vec(const struct section_file *secfile, size_t *dim, const char *path,...)
const char * secfile_lookup_str(const struct section_file *secfile, const char *path,...)
#define section_list_iterate(seclist, psection)
#define section_list_iterate_end
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:3689
@ VERB_DEFAULT
Definition reqtext.h:20
bool universal_is_relevant_to_requirement(const struct requirement *req, const struct universal *source)
bool universal_fulfills_requirements(bool check_necessary, const struct requirement_vector *reqs, const struct universal *source)
bool are_universals_equal(const struct universal *psource1, const struct universal *psource2)
const char * universal_name_translation(const struct universal *psource, char *buf, size_t bufsz)
#define requirement_fulfilled_by_unit_type(_ut_, _rqs_)
#define requirement_fulfilled_by_improvement(_imp_, _rqs_)
#define requirement_vector_iterate_end
#define requirement_vector_iterate(req_vec, preq)
int research_goal_unknown_techs(const struct research *presearch, Tech_type_id goal)
Definition research.c:750
bool research_invention_reachable(const struct research *presearch, const Tech_type_id tech)
Definition research.c:668
int research_goal_bulbs_required(const struct research *presearch, Tech_type_id goal)
Definition research.c:772
int research_total_bulbs_required(const struct research *presearch, Tech_type_id tech, bool loss_value)
Definition research.c:868
struct research * research_get(const struct player *pplayer)
Definition research.c:128
enum tech_state research_invention_state(const struct research *presearch, Tech_type_id tech)
Definition research.c:619
bool road_has_flag(const struct road_type *proad, enum road_flag_id flag)
Definition road.c:416
bool road_provides_move_bonus(const struct road_type *proad)
Definition road.c:505
server_setting_id server_setting_by_name(const char *name)
bool server_setting_value_bool_get(server_setting_id id)
struct setting_list * level[OLEVELS_NUM]
Definition settings.c:190
int compare_strings(const void *first, const void *second)
Definition shared.c:363
const char * fileinfoname(const struct strvec *dirs, const char *filename)
Definition shared.c:1094
const struct strvec * get_data_dirs(void)
Definition shared.c:886
#define ARRAY_SIZE(x)
Definition shared.h:85
#define MIN(x, y)
Definition shared.h:55
#define MAX(x, y)
Definition shared.h:54
struct specialist * specialist_by_number(const Specialist_type_id id)
Definition specialist.c:100
const char * specialist_plural_translation(const struct specialist *sp)
Definition specialist.c:155
#define specialist_type_iterate_end
Definition specialist.h:79
#define specialist_type_iterate(sp)
Definition specialist.h:73
size_t size
Definition specvec.h:72
void strvec_destroy(struct strvec *psv)
void strvec_append(struct strvec *psv, const char *string)
const char * strvec_to_or_list(const struct strvec *psv, struct astring *astr)
struct strvec * strvec_new(void)
void strvec_clear(struct strvec *psv)
size_t strvec_size(const struct strvec *psv)
const char * strvec_to_and_list(const struct strvec *psv, struct astring *astr)
#define strvec_iterate(psv, str)
#define strvec_iterate_end
action_id id
Definition actions.h:107
bool quiet
Definition actions.h:130
struct civ_game::@32::@35 client
struct packet_ruleset_control control
Definition game.h:83
char * ruleset_summary
Definition game.h:84
int global_init_techs[MAX_NUM_TECH_LIST]
Definition game.h:110
struct packet_game_info info
Definition game.h:89
int global_init_buildings[MAX_NUM_BUILDING_LIST]
Definition game.h:111
struct packet_scenario_info scenario
Definition game.h:87
char * ruleset_description
Definition game.h:85
struct civ_game::@31 rgame
bool ruleset_init
Definition game.h:118
struct veteran_system * veteran
Definition game.h:101
struct strvec * helptext
Definition extras.h:149
struct road_type * road
Definition extras.h:155
int removal_time
Definition extras.h:120
bool generated
Definition extras.h:117
struct extra_type::@26 data
struct requirement_vector rmreqs
Definition extras.h:107
Tech_type_id visibility_req
Definition extras.h:139
int removal_time_factor
Definition extras.h:121
struct requirement_vector reqs
Definition extras.h:106
bool buildable
Definition extras.h:116
enum extra_unit_seen_type eus
Definition extras.h:128
int defense_bonus
Definition extras.h:124
int build_time
Definition extras.h:118
int infracost
Definition extras.h:122
int no_aggr_near_city
Definition extras.h:137
struct base_type * base
Definition extras.h:154
struct strvec * helptext
Definition government.h:65
struct requirement_vector reqs
Definition government.h:62
struct requirement_vector obsolete_by
Definition improvement.h:59
struct requirement_vector reqs
Definition improvement.h:58
struct strvec * helptext
Definition improvement.h:65
int init_buildings[MAX_NUM_BUILDING_LIST]
Definition nation.h:123
struct government * init_government
Definition nation.h:124
struct unit_type * init_units[MAX_NUM_UNIT_LIST]
Definition nation.h:125
char * legend
Definition nation.h:107
int init_techs[MAX_NUM_TECH_LIST]
Definition nation.h:122
enum borders_mode borders
int nuke_defender_survival_chance_pct
enum tech_upkeep_style tech_upkeep_style
char version[MAX_LEN_NAME]
char name[MAX_LEN_NAME]
struct universal source
struct strvec * helptext
Definition terrain.h:156
int irrigation_food_incr
Definition terrain.h:114
int output[O_LAST]
Definition terrain.h:95
int road_output_incr_pct[O_LAST]
Definition terrain.h:104
int mining_shield_incr
Definition terrain.h:117
int transport_capacity
Definition unittype.h:530
int pop_cost
Definition unittype.h:520
struct requirement_vector build_reqs
Definition unittype.h:527
int defense_strength
Definition unittype.h:523
int paratroopers_range
Definition unittype.h:548
int convert_time
Definition unittype.h:538
int city_size
Definition unittype.h:557
struct veteran_system * veteran
Definition unittype.h:551
const struct unit_type * obsoleted_by
Definition unittype.h:536
bv_unit_classes targets
Definition unittype.h:568
enum vision_layer vlayer
Definition unittype.h:576
struct strvec * helptext
Definition unittype.h:578
int bombard_rate
Definition unittype.h:554
int upkeep[O_LAST]
Definition unittype.h:545
bv_unit_classes disembarks
Definition unittype.h:574
const struct unit_type * converted_to
Definition unittype.h:537
bv_unit_classes embarks
Definition unittype.h:571
int happy_cost
Definition unittype.h:544
struct combat_bonus_list * bonuses
Definition unittype.h:533
enum universals_n kind
Definition fc_types.h:608
universals_u value
Definition fc_types.h:607
struct veteran_level * definitions
Definition unittype.h:504
int fc_snprintf(char *str, size_t n, const char *format,...)
Definition support.c:960
size_t fc_strlcpy(char *dest, const char *src, size_t n)
Definition support.c:777
int fc_strcasecmp(const char *str0, const char *str1)
Definition support.c:186
size_t fc_strlcat(char *dest, const char *src, size_t n)
Definition support.c:822
int cat_snprintf(char *str, size_t n, const char *format,...)
Definition support.c:986
#define sz_strlcpy(dest, src)
Definition support.h:195
#define TRUE
Definition support.h:46
#define FALSE
Definition support.h:47
#define sz_strlcat(dest, src)
Definition support.h:196
#define fc_strncmp(_s1_, _s2_, _len_)
Definition support.h:160
#define fc__fallthrough
Definition support.h:119
struct advance * advance_by_number(const Tech_type_id atype)
Definition tech.c:107
bool advance_has_flag(Tech_type_id tech, enum tech_flag_id flag)
Definition tech.c:216
const char * tech_class_name_translation(const struct tech_class *ptclass)
Definition tech.c:343
struct advance * advance_requires(const struct advance *padvance, enum tech_req require)
Definition tech.c:136
const char * advance_name_translation(const struct advance *padvance)
Definition tech.c:300
struct advance * valid_advance_by_number(const Tech_type_id id)
Definition tech.c:176
bool techs_have_fixed_costs(void)
Definition tech.c:460
const char * tech_flag_helptxt(enum tech_flag_id id)
Definition tech.c:445
Tech_type_id advance_number(const struct advance *padvance)
Definition tech.c:98
#define advance_index_iterate_end
Definition tech.h:244
@ AR_ROOT
Definition tech.h:108
#define A_FIRST
Definition tech.h:44
#define A_NONE
Definition tech.h:43
#define advance_root_req_iterate_end
Definition tech.h:315
#define A_LAST
Definition tech.h:45
#define advance_index_iterate(_start, _index)
Definition tech.h:240
#define advance_root_req_iterate(_goal, _padvance)
Definition tech.h:310
const char * terrain_name_translation(const struct terrain *pterrain)
Definition terrain.c:238
const char * terrain_rule_name(const struct terrain *pterrain)
Definition terrain.c:247
enum terrain_class terrain_type_terrain_class(const struct terrain *pterrain)
Definition terrain.c:582
const char * terrain_flag_helptxt(enum terrain_flag_id id)
Definition terrain.c:829
int terrain_extra_build_time(const struct terrain *pterrain, enum unit_activity activity, const struct extra_type *tgt)
Definition terrain.c:699
#define terrain_type_iterate(_p)
Definition terrain.h:266
#define T_NONE
Definition terrain.h:61
#define terrain_type_iterate_end
Definition terrain.h:272
#define terrain_has_flag(terr, flag)
Definition terrain.h:176
const char * tileset_description(struct tileset *t)
Definition tilespec.c:7775
const char * tileset_summary(struct tileset *t)
Definition tilespec.c:7767
const char * tileset_name_get(struct tileset *t)
Definition tilespec.c:7751
const char * tileset_version(struct tileset *t)
Definition tilespec.c:7759
const char * goods_name_translation(struct goods_type *pgood)
#define goods_type_iterate_end
#define goods_type_iterate(_p)
const struct impr_type * building
Definition fc_types.h:546
const char * uclass_name_translation(const struct unit_class *pclass)
Definition unittype.c:1638
bool utype_action_takes_all_mp(const struct unit_type *putype, struct action *paction)
Definition unittype.c:1197
bool utype_can_freely_unload(const struct unit_type *pcargotype, const struct unit_type *ptranstype)
Definition unittype.c:306
const char * unit_class_flag_helptxt(enum unit_class_flag_id id)
Definition unittype.c:1860
Unit_Class_id uclass_count(void)
Definition unittype.c:2452
struct unit_type * get_role_unit(int role, int role_index)
Definition unittype.c:2259
int utype_build_shield_cost_base(const struct unit_type *punittype)
Definition unittype.c:1474
const struct veteran_system * utype_veteran_system(const struct unit_type *punittype)
Definition unittype.c:2574
int num_role_units(int role)
Definition unittype.c:2209
bool utype_can_freely_load(const struct unit_type *pcargotype, const struct unit_type *ptranstype)
Definition unittype.c:294
Unit_type_id utype_count(void)
Definition unittype.c:80
int utype_veteran_levels(const struct unit_type *punittype)
Definition unittype.c:2631
bool utype_can_do_action_result(const struct unit_type *putype, enum action_result result)
Definition unittype.c:393
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:1213
const struct veteran_level * utype_veteran_level(const struct unit_type *punittype, int level)
Definition unittype.c:2603
bool utype_is_consumed_by_action(const struct action *paction, const struct unit_type *utype)
Definition unittype.c:1225
bool utype_veteran_has_power_bonus(const struct unit_type *punittype)
Definition unittype.c:2644
const char * unit_type_flag_helptxt(enum unit_type_flag_id id)
Definition unittype.c:1923
const char * utype_name_translation(const struct unit_type *punittype)
Definition unittype.c:1566
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:1023
bool utype_can_do_action(const struct unit_type *putype, const action_id act_id)
Definition unittype.c:377
#define UCF_LAST_USER_FLAG
Definition unittype.h:127
static bool uclass_has_flag(const struct unit_class *punitclass, enum unit_class_flag_id flag)
Definition unittype.h:773
#define utype_class(_t_)
Definition unittype.h:756
#define utype_fuel(ptype)
Definition unittype.h:846
#define combat_bonus_list_iterate_end
Definition unittype.h:489
#define combat_bonus_list_iterate(bonuslist, pbonus)
Definition unittype.h:487
#define unit_tech_reqs_iterate_end
Definition unittype.h:888
#define unit_class_iterate(_p)
Definition unittype.h:915
#define unit_tech_reqs_iterate(_utype_, _p)
Definition unittype.h:882
static bool utype_has_flag(const struct unit_type *punittype, int flag)
Definition unittype.h:624
#define UTYF_LAST_USER_FLAG
Definition unittype.h:337
#define unit_type_iterate(_p)
Definition unittype.h:862
#define uclass_index(_c_)
Definition unittype.h:749
#define unit_class_iterate_end
Definition unittype.h:922
#define unit_type_iterate_end
Definition unittype.h:869
const char * freeciv_name_version(void)
Definition version.c:35