Freeciv-3.2
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
218 /* Special handling for transform.
219 * Transforming from a land to ocean, or from ocean to land, may require
220 * a number of adjacent tiles of the right terrain class. If so,
221 * we provide that bit of info.
222 * The terrain.ruleset file may include a transform from a land to
223 * ocean, or from ocean to land, which then is not possible because
224 * the value of land_channel_requirement or ocean_reclaim_requirement
225 * prevents it. 101 is the value that prevents it. */
227 (terrain_control.ocean_reclaim_requirement_pct < 101);
229 (terrain_control.land_channel_requirement_pct < 101);
232 ceil((terrain_control.ocean_reclaim_requirement_pct/100.0) *
235 ceil((terrain_control.land_channel_requirement_pct/100.0) *
237
240 PL_("To transform a water tile to a land tile, the water tile "
241 "must have %d adjacent land tile.\n",
242 "To transform a water tile to a land tile, the water tile "
243 "must have %d adjacent land tiles.\n",
246 }
249 PL_("To transform a land tile to a water tile, the land tile "
250 "must have %d adjacent water tile.\n",
251 "To transform a land tile to a water tile, the land tile "
252 "must have %d adjacent water tiles.\n",
255 }
256 CATLSTR(outbuf, outlen, "\n");
257
259 /* TRANS: Header for fixed-width terrain alteration table.
260 * TRANS: Translators cannot change column widths :( */
261 _("Terrain Cultivate Plant Transform\n"));
263 "----------------------------------------------------------------\n");
264 terrain_type_iterate(pterrain) {
265 if (0 != strlen(terrain_rule_name(pterrain))) {
266 char cultivation_time[4], plant_time[4], transform_time[4];
267 const char *terrain, *cultivate_result,
268 *plant_result,*transform_result;
269 struct universal for_terr = { .kind = VUT_TERRAIN, .value = { .terrain = pterrain }};
270 int cslen, pslen, tslen;
271
273 "%d", pterrain->cultivate_time);
274 fc_snprintf(plant_time, sizeof(plant_time),
275 "%d", pterrain->plant_time);
276 fc_snprintf(transform_time, sizeof(transform_time),
277 "%d", pterrain->transform_time);
279 cultivate_result =
280 (pterrain->cultivate_result == T_NONE
282 ? ""
283 : terrain_name_translation(pterrain->cultivate_result);
284 plant_result =
285 (pterrain->plant_result == T_NONE
287 ? ""
288 : terrain_name_translation(pterrain->plant_result);
289 transform_result =
290 (pterrain->transform_result == pterrain
291 || pterrain->transform_result == T_NONE
293 NULL, &for_terr)) ? ""
294 : terrain_name_translation(pterrain->transform_result);
295
296 /* More special handling for transform.
297 * Check if it is really possible. */
298 if (strcmp(transform_result, "") != 0
299 && pterrain->transform_result != T_NONE) {
303 terrain_type_terrain_class(pterrain->transform_result);
306 transform_result = "";
307 }
310 transform_result = "";
311 }
312 }
313
314 /* Use get_internal_string_length() for correct alignment with
315 * multibyte character encodings */
317 cslen = 12 - (int)get_internal_string_length(cultivate_result);
318 pslen = 12 - (int)get_internal_string_length(plant_result);
320 "%s%*s %3s %s%*s %3s %s%*s %3s %s\n",
321 terrain,
322 MAX(0, tslen), "",
323 (pterrain->cultivate_result == T_NONE) ? "-" : cultivation_time,
324 cultivate_result,
325 MAX(0, cslen), "",
326 (pterrain->plant_result == T_NONE) ? "-" : plant_time,
327 plant_result,
328 MAX(0, pslen), "",
329 (!strcmp(transform_result, "")) ? "-" : transform_time,
330 transform_result);
331
332 if (clean_time != 0) {
334 int rmtime = pterrain->extra_removal_times[extra_index(pextra)];
335
336 if (rmtime != 0) {
337 if (clean_time < 0) {
339 } else if (clean_time != rmtime) {
340 clean_time = 0; /* Give up */
341 }
342 }
344 }
345
346 if (pillage_time != 0 && pterrain->pillage_time != 0) {
347 if (pillage_time < 0) {
348 pillage_time = pterrain->pillage_time;
349 } else {
350 if (pillage_time != pterrain->pillage_time) {
351 pillage_time = 0; /* Give up */
352 }
353 }
354 }
355 }
357
358 /* Examine extras to see if time of removal activities really is
359 * terrain-independent, and take into account removal_time_factor.
360 * XXX: this is rather overwrought to handle cases which the ruleset
361 * author could express much more simply for the same result */
362 {
363 int time = -1, factor = -1;
364
366 if (pextra->removal_time == 0) {
367 if (factor < 0) {
368 factor = pextra->removal_time_factor;
369 } else if (factor != pextra->removal_time_factor) {
370 factor = 0; /* Give up */
371 }
372 } else {
373 if (time < 0) {
374 time = pextra->removal_time;
375 } else if (time != pextra->removal_time) {
376 time = 0; /* Give up */
377 }
378 }
380
381 if (factor < 0) {
382 /* No extra has terrain-dependent clean time; use extra's time */
383 if (time >= 0) {
385 } else {
386 clean_time = 0;
387 }
388 } else if (clean_time != 0) {
389 /* At least one extra's time depends on terrain */
391
392 if (time > 0 && factor > 0 && time != clean_time * factor) {
393 clean_time = 0;
394 } else if (time >= 0) {
396 } else if (factor >= 0) {
397 clean_time *= factor;
398 } else {
400 }
401 }
402 }
403
404 {
405 int time = -1, factor = -1;
406
408 if (pextra->removal_time == 0) {
409 if (factor < 0) {
410 factor = pextra->removal_time_factor;
411 } else if (factor != pextra->removal_time_factor) {
412 factor = 0; /* Give up */
413 }
414 } else {
415 if (time < 0) {
416 time = pextra->removal_time;
417 } else if (time != pextra->removal_time) {
418 time = 0; /* Give up */
419 }
420 }
422 if (factor < 0) {
423 /* No extra has terrain-dependent pillage time; use extra's time */
424 if (time >= 0) {
425 pillage_time = time;
426 } else {
427 pillage_time = 0;
428 }
429 } else if (pillage_time != 0) {
430 /* At least one extra's time depends on terrain */
431 fc_assert(pillage_time > 0);
432 if (time > 0 && factor > 0 && time != pillage_time * factor) {
433 pillage_time = 0;
434 } else if (time >= 0) {
435 pillage_time = time;
436 } else if (factor >= 0) {
437 pillage_time = pillage_time * factor;
438 } else {
440 }
441 }
442 }
443
444 /* Check whether there are any bases or roads whose build time is
445 * independent of terrain */
446
448 if (pextra->buildable && pextra->build_time > 0) {
450 break;
451 }
455 if (pextra->buildable && pextra->build_time > 0) {
457 break;
458 }
460 }
461
462 if (clean_time > 0 || pillage_time > 0
464 CATLSTR(outbuf, outlen, "\n");
466 _("Time taken for the following activities is independent of "
467 "terrain:\n"));
468 CATLSTR(outbuf, outlen, "\n");
470 /* TRANS: Header for fixed-width terrain alteration table.
471 * TRANS: Translators cannot change column widths :( */
472 _("Activity Time\n"));
474 "---------------------------");
475 if (clean_time > 0) {
477 _("\nClean %3d"), clean_time);
478 }
479 if (pillage_time > 0) {
481 _("\nPillage %3d"), pillage_time);
482 }
483
485 if (pextra->buildable && pextra->build_time > 0) {
486 const char *rname = extra_name_translation(pextra);
487 int slen = 18 - (int)get_internal_string_length(rname);
488
490 "\n%s%*s %3d",
491 rname,
492 MAX(0, slen), "",
493 pextra->build_time);
494 }
496
498 if (pextra->buildable && pextra->build_time > 0) {
499 const char *bname = extra_name_translation(pextra);
501
503 "\n%s%*s %3d",
504 bname,
505 MAX(0, slen), "",
506 pextra->build_time);
507 }
509 }
510
511 return TRUE;
512 } else if (0 == strcmp(name, "VeteranLevels")) {
514 _("In this ruleset, the following veteran levels are defined:"),
515 _("This ruleset has no default veteran levels defined."));
516 } else if (0 == strcmp(name, "FreecivVersion")) {
517 const char *ver = freeciv_name_version();
518
520 /* TRANS: First %s is version string, e.g.,
521 * "Freeciv version 3.2.0-beta1 (beta version)" (translated).
522 * Second %s is client_string, e.g., "gui-gtk-4.0". */
523 _("This is %s, %s client."), ver, client_string);
525
526 return TRUE;
527 } else if (0 == strcmp(name, "DefaultMetaserver")) {
529
530 return TRUE;
531 }
532 log_error("Unknown directive '$%s' in help", name);
533 return FALSE;
534}
535
536/************************************************************************/
545 const char *subjstr,
546 const char *const *strs,
547 char *buf, size_t bufsz,
548 const char *prefix)
549{
550 struct strvec *coreqs = strvec_new();
551 struct strvec *conoreqs = strvec_new();
554 char buf2[bufsz];
555
556 /* FIXME: show other data like range and survives. */
557
559 if (!req->quiet && are_universals_equal(psource, &req->source)) {
560 /* We're definitely going to print _something_. */
561 CATLSTR(buf, bufsz, "%s", prefix);
562 if (req->present) {
563 /* psource enables the subject, but other sources may
564 * also be required (or required to be absent). */
566 if (!coreq->quiet && !are_universals_equal(psource, &coreq->source)) {
567 universal_name_translation(&coreq->source, buf2, sizeof(buf2));
568 strvec_append(coreq->present ? coreqs : conoreqs, buf2);
569 }
571
572 if (0 < strvec_size(coreqs)) {
573 if (0 < strvec_size(conoreqs)) {
575 Q_(strs[0]), /* "Allows %s (with %s but no %s)." */
576 subjstr,
579 } else {
581 Q_(strs[1]), /* "Allows %s (with %s)." */
582 subjstr,
584 }
585 } else {
586 if (0 < strvec_size(conoreqs)) {
588 Q_(strs[2]), /* "Allows %s (absent %s)." */
589 subjstr,
591 } else {
593 Q_(strs[3]), /* "Allows %s." */
594 subjstr);
595 }
596 }
597 } else {
598 /* psource can, on its own, prevent the subject. */
600 Q_(strs[4]), /* "Prevents %s." */
601 subjstr);
602 }
603 cat_snprintf(buf, bufsz, "\n");
604 }
606
611}
612
613/************************************************************************/
629static void insert_allows(struct universal *psource,
630 char *buf, size_t bufsz, const char *prefix)
631{
632 buf[0] = '\0';
633
635 static const char *const govstrs[] = {
636 /* TRANS: First %s is a government name. */
637 N_("?gov:Allows %s (with %s but no %s)."),
638 /* TRANS: First %s is a government name. */
639 N_("?gov:Allows %s (with %s)."),
640 /* TRANS: First %s is a government name. */
641 N_("?gov:Allows %s (absent %s)."),
642 /* TRANS: %s is a government name. */
643 N_("?gov:Allows %s."),
644 /* TRANS: %s is a government name. */
645 N_("?gov:Prevents %s.")
646 };
649 buf, bufsz, prefix);
651
652 improvement_iterate(pimprove) {
653 if (valid_improvement(pimprove)) {
654 static const char *const imprstrs[] = {
655 /* TRANS: First %s is a building name. */
656 N_("?improvement:Allows %s (with %s but no %s)."),
657 /* TRANS: First %s is a building name. */
658 N_("?improvement:Allows %s (with %s)."),
659 /* TRANS: First %s is a building name. */
660 N_("?improvement:Allows %s (absent %s)."),
661 /* TRANS: %s is a building name. */
662 N_("?improvement:Allows %s."),
663 /* TRANS: %s is a building name. */
664 N_("?improvement:Prevents %s.")
665 };
666 insert_allows_single(psource, &pimprove->reqs,
668 buf, bufsz, prefix);
669 }
671
673 static const char *const utstrs[] = {
674 /* TRANS: First %s is a unit type name. */
675 N_("?unittype:Allows %s (with %s but no %s)."),
676 /* TRANS: First %s is a unit type name. */
677 N_("?unittype:Allows %s (with %s)."),
678 /* TRANS: First %s is a unit type name. */
679 N_("?unittype:Allows %s (absent %s)."),
680 /* TRANS: %s is a unit type name. */
681 N_("?unittype:Allows %s."),
682 /* TRANS: %s is a unit type name. */
683 N_("?unittype:Prevents %s.")
684 };
685 insert_allows_single(psource, &putype->build_reqs,
687 buf, bufsz, prefix);
689
690 extra_type_iterate(pextra) {
691 static const char *const estrs[] = {
692 /* TRANS: First %s is an extra name. */
693 N_("?extra:Allows %s (with %s but no %s)."),
694 /* TRANS: First %s is an extra name. */
695 N_("?extra:Allows %s (with %s)."),
696 /* TRANS: First %s is an extra name. */
697 N_("?extra:Allows %s (absent %s)."),
698 /* TRANS: %s is an extra name. */
699 N_("?extra:Allows %s."),
700 /* TRANS: %s is an extra name. */
701 N_("?extra:Prevents %s.")
702 };
703 insert_allows_single(psource, &pextra->reqs,
705 buf, bufsz, prefix);
707
709 static const char *const gstrs[] = {
710 /* TRANS: First %s is a good name. */
711 N_("?good:Allows %s (with %s but no %s)."),
712 /* TRANS: First %s is a good name. */
713 N_("?good:Allows %s (with %s)."),
714 /* TRANS: First %s is a good name. */
715 N_("?good:Allows %s (absent %s)."),
716 /* TRANS: %s is a good name. */
717 N_("?good:Allows %s."),
718 /* TRANS: %s is a good name. */
719 N_("?good:Prevents %s.")
720 };
723 buf, bufsz, prefix);
725}
726
727/************************************************************************/
730static struct help_item *new_help_item(int type)
731{
732 struct help_item *pitem;
733
734 pitem = fc_malloc(sizeof(struct help_item));
735 pitem->topic = NULL;
736 pitem->text = NULL;
737 pitem->type = type;
738
739 return pitem;
740}
741
742/************************************************************************/
746static int help_item_compar(const struct help_item *const *ppa,
747 const struct help_item *const *ppb)
748{
749 const struct help_item *ha, *hb;
750 char *ta, *tb;
751 ha = *ppa;
752 hb = *ppb;
753 for (ta = ha->topic, tb = hb->topic; *ta != '\0' && *tb != '\0'; ta++, tb++) {
754 if (*ta != ' ') {
755 if (*tb == ' ') return -1;
756 break;
757 } else if (*tb != ' ') {
758 if (*ta == ' ') return 1;
759 break;
760 }
761 }
762 return compare_strings(ta, tb);
763}
764
765/************************************************************************/
769{
770 static bool booted = FALSE;
771
772 struct section_file *sf;
773 const char *filename;
774 struct help_item *pitem;
775 int i;
776 struct section_list *sec;
777 const char **paras;
778 size_t npara;
779 char long_buffer[64000]; /* HACK: this may be overrun. */
780
782
783 /* need to do something like this or bad things happen */
785
786 if (!booted) {
787 log_verbose("Booting help texts");
788 } else {
789 /* free memory allocated last time booted */
791 log_verbose("Rebooting help texts");
792 }
793
794 filename = fileinfoname(get_data_dirs(), "helpdata.txt");
795 if (!filename) {
796 log_error("Did not read help texts");
797 return;
798 }
799 /* after following call filename may be clobbered; use sf->filename instead */
800 if (!(sf = secfile_load(filename, FALSE))) {
801 /* this is now unlikely to happen */
802 log_error("failed reading help-texts from '%s':\n%s", filename,
803 secfile_error());
804 return;
805 }
806
807 sec = secfile_sections_by_name_prefix(sf, "help_");
808
809 if (NULL != sec) {
810 section_list_iterate(sec, psection) {
812 const char *sec_name = section_name(psection);
813 const char *gen_str = secfile_lookup_str(sf, "%s.generate", sec_name);
814
815 if (gen_str) {
817 int level = strspn(gen_str, " ");
818
819 gen_str += level;
820
821 for (i = 2; help_type_names[i]; i++) {
822 if (strcmp(gen_str, help_type_names[i]) == 0) {
823 current_type = i;
824 break;
825 }
826 }
827 if (current_type == HELP_ANY) {
828 log_error("bad help-generate category \"%s\"", gen_str);
829 continue;
830 }
831
832 if (!booted) {
833 if (current_type == HELP_EXTRA) {
834 size_t ncats;
835
836 /* Avoid warnings about entries unused on this round,
837 * when the entries in question are valid once help system has been booted */
839 "%s.categories", sec_name);
840 }
841 continue; /* on initial boot data tables are empty */
842 }
843
844 {
845 /* Note these should really fill in pitem->text from auto-gen
846 data instead of doing it later on the fly, but I don't want
847 to change that now. --dwp
848 */
849 char name[2048];
851
852 switch (current_type) {
853 case HELP_UNIT:
856 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
858 pitem->topic = fc_strdup(name);
859 pitem->text = fc_strdup("");
862 break;
863 case HELP_TECH:
867 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
869 pitem->topic = fc_strdup(name);
870 pitem->text = fc_strdup("");
872 }
874 break;
875 case HELP_TERRAIN:
876 terrain_type_iterate(pterrain) {
877 if (0 != strlen(terrain_rule_name(pterrain))) {
879 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
880 terrain_name_translation(pterrain));
881 pitem->topic = fc_strdup(name);
882 pitem->text = fc_strdup("");
884 }
886 break;
887 case HELP_EXTRA:
888 {
889 const char **cats;
890 size_t ncats;
892 "%s.categories", sec_name);
893 extra_type_iterate(pextra) {
894 /* If categories not specified, don't filter */
895 if (cats) {
896 bool include = FALSE;
897 const char *cat = extra_category_name(pextra->category);
898 int ci;
899
900 for (ci = 0; ci < ncats; ci++) {
901 if (fc_strcasecmp(cats[ci], cat) == 0) {
902 include = TRUE;
903 break;
904 }
905 }
906 if (!include) {
907 continue;
908 }
909 }
911 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
912 extra_name_translation(pextra));
913 pitem->topic = fc_strdup(name);
914 pitem->text = fc_strdup("");
917 FC_FREE(cats);
918 }
919 break;
920 case HELP_GOODS:
923 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
925 pitem->topic = fc_strdup(name);
926 pitem->text = fc_strdup("");
929 break;
930 case HELP_SPECIALIST:
933
935 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
937 pitem->topic = fc_strdup(name);
938 pitem->text = fc_strdup("");
941 break;
942 case HELP_GOVERNMENT:
945 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
947 pitem->topic = fc_strdup(name);
948 pitem->text = fc_strdup("");
951 break;
952 case HELP_IMPROVEMENT:
953 improvement_iterate(pimprove) {
954 if (valid_improvement(pimprove) && !is_great_wonder(pimprove)) {
956 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
958 pitem->topic = fc_strdup(name);
959 pitem->text = fc_strdup("");
961 }
963 break;
964 case HELP_WONDER:
965 improvement_iterate(pimprove) {
966 if (valid_improvement(pimprove) && is_great_wonder(pimprove)) {
968 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
970 pitem->topic = fc_strdup(name);
971 pitem->text = fc_strdup("");
973 }
975 break;
976 case HELP_RULESET:
977 {
978 int desc_len;
979 int len;
980
982 /* pitem->topic = fc_strdup(_(game.control.name)); */
983 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
985 pitem->topic = fc_strdup(name);
988 } else {
989 desc_len = 0;
990 }
991 if (game.ruleset_summary != NULL) {
992 if (game.control.version[0] != '\0') {
994 + strlen(" ")
996 + strlen("\n\n")
998 + 1;
999
1000 pitem->text = fc_malloc(len + desc_len);
1001 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1004 } else {
1006 + strlen("\n\n")
1008 + 1;
1009
1010 pitem->text = fc_malloc(len + desc_len);
1011 fc_snprintf(pitem->text, len, "%s\n\n%s",
1013 }
1014 } else {
1015 const char *nodesc = _("Current ruleset contains no summary.");
1016
1017 if (game.control.version[0] != '\0') {
1019 + strlen(" ")
1021 + strlen("\n\n")
1022 + strlen(nodesc)
1023 + 1;
1024
1025 pitem->text = fc_malloc(len + desc_len);
1026 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1028 nodesc);
1029 } else {
1031 + strlen("\n\n")
1032 + strlen(nodesc)
1033 + 1;
1034
1035 pitem->text = fc_malloc(len + desc_len);
1036 fc_snprintf(pitem->text, len, "%s\n\n%s",
1037 _(game.control.name),
1038 nodesc);
1039 }
1040 }
1041 if (game.ruleset_description != NULL) {
1042 fc_strlcat(pitem->text, "\n\n", len + desc_len);
1044 }
1046 }
1047 break;
1048 case HELP_TILESET:
1049 {
1050 int desc_len;
1051 int len;
1052 const char *ts_name = tileset_name_get(tileset);
1053 const char *version = tileset_version(tileset);
1054 const char *summary = tileset_summary(tileset);
1055 const char *description = tileset_description(tileset);
1056
1058 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1060 pitem->topic = fc_strdup(name);
1061 if (description != NULL) {
1062 desc_len = strlen("\n\n") + strlen(description);
1063 } else {
1064 desc_len = 0;
1065 }
1066 if (summary != NULL) {
1067 if (version[0] != '\0') {
1068 len = strlen(_(ts_name))
1069 + strlen(" ")
1070 + strlen(version)
1071 + strlen("\n\n")
1072 + strlen(_(summary))
1073 + 1;
1074
1075 pitem->text = fc_malloc(len + desc_len);
1076 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1077 _(ts_name), version, _(summary));
1078 } else {
1079 len = strlen(_(ts_name))
1080 + strlen("\n\n")
1081 + strlen(_(summary))
1082 + 1;
1083
1084 pitem->text = fc_malloc(len + desc_len);
1085 fc_snprintf(pitem->text, len, "%s\n\n%s",
1086 _(ts_name), _(summary));
1087 }
1088 } else {
1089 const char *nodesc = _("Current tileset contains no summary.");
1090
1091 if (version[0] != '\0') {
1092 len = strlen(_(ts_name))
1093 + strlen(" ")
1094 + strlen(version)
1095 + strlen("\n\n")
1096 + strlen(nodesc)
1097 + 1;
1098
1099 pitem->text = fc_malloc(len + desc_len);
1100 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1101 _(ts_name), version,
1102 nodesc);
1103 } else {
1104 len = strlen(_(ts_name))
1105 + strlen("\n\n")
1106 + strlen(nodesc)
1107 + 1;
1108
1109 pitem->text = fc_malloc(len + desc_len);
1110 fc_snprintf(pitem->text, len, "%s\n\n%s",
1111 _(ts_name),
1112 nodesc);
1113 }
1114 }
1115 if (description != NULL) {
1116 fc_strlcat(pitem->text, "\n\n", len + desc_len);
1117 fc_strlcat(pitem->text, description, len + desc_len);
1118 }
1120 }
1121 break;
1122 case HELP_MUSICSET:
1123 {
1124 int desc_len;
1125 int len;
1126 const char *ms_name = current_musicset_name();
1127 const char *version = current_musicset_version();
1128 const char *summary = current_musicset_summary();
1129 const char *description = current_musicset_description();
1130
1132 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1134 pitem->topic = fc_strdup(name);
1135 if (description != NULL) {
1136 desc_len = strlen("\n\n") + strlen(description);
1137 } else {
1138 desc_len = 0;
1139 }
1140 if (summary != NULL) {
1141 if (version != NULL && version[0] != '\0') {
1142 len = strlen(_(ms_name))
1143 + strlen(" ")
1144 + strlen(version)
1145 + strlen("\n\n")
1146 + strlen(_(summary))
1147 + 1;
1148
1149 pitem->text = fc_malloc(len + desc_len);
1150 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1151 _(ms_name), version, _(summary));
1152 } else {
1153 len = strlen(_(ms_name))
1154 + strlen("\n\n")
1155 + strlen(_(summary))
1156 + 1;
1157
1158 pitem->text = fc_malloc(len + desc_len);
1159 fc_snprintf(pitem->text, len, "%s\n\n%s",
1160 _(ms_name), _(summary));
1161 }
1162 } else {
1163 const char *nodesc = _("Current musicset contains no summary.");
1164
1165 if (version != NULL && version[0] != '\0') {
1166 len = strlen(_(ms_name))
1167 + strlen(" ")
1168 + strlen(version)
1169 + strlen("\n\n")
1170 + strlen(nodesc)
1171 + 1;
1172
1173 pitem->text = fc_malloc(len + desc_len);
1174 fc_snprintf(pitem->text, len, "%s %s\n\n%s",
1175 _(ms_name), version,
1176 nodesc);
1177 } else {
1178 len = strlen(_(ms_name))
1179 + strlen("\n\n")
1180 + strlen(nodesc)
1181 + 1;
1182
1183 pitem->text = fc_malloc(len + desc_len);
1184 fc_snprintf(pitem->text, len, "%s\n\n%s",
1185 _(ms_name),
1186 nodesc);
1187 }
1188 }
1189 if (description != NULL) {
1190 fc_strlcat(pitem->text, "\n\n", len + desc_len);
1191 fc_strlcat(pitem->text, description, len + desc_len);
1192 }
1194 }
1195 break;
1196 case HELP_NATIONS:
1197 nations_iterate(pnation) {
1199 || show_help_for_nation(pnation)) {
1201 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1202 nation_plural_translation(pnation));
1203 pitem->topic = fc_strdup(name);
1204 pitem->text = fc_strdup("");
1206 }
1208 break;
1209 case HELP_MULTIPLIER:
1210 multipliers_iterate(pmul) {
1211 help_text_buffer[0] = '\0';
1213 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1214 name_translation_get(&pmul->name));
1215 pitem->topic = fc_strdup(name);
1216 if (pmul->helptext) {
1217 const char *sep = "";
1218 strvec_iterate(pmul->helptext, text) {
1220 "%s%s", sep, text);
1221 sep = "\n\n";
1223 }
1227 break;
1228 case HELP_COUNTER:
1229 {
1230 int j;
1231 for (j = 0; j < game.control.num_counters; j++) {
1232 struct counter *pcount = counter_by_id(j);
1233
1234 help_text_buffer[0] = '\0';
1236 fc_snprintf(name, sizeof(name), "%*s%s", level, "",
1238 pitem->topic = fc_strdup(name);
1239 if (pcount->helptext) {
1240 strvec_iterate(pcount->helptext, text) {
1242 "%s%s", "\n\n", text);
1244 }
1247 }
1248 }
1249 break;
1250 default:
1251 log_error("Bad current_type: %d.", current_type);
1252 break;
1253 }
1259 continue;
1260 }
1261 }
1262
1263 /* It wasn't a "generate" node: */
1264
1266 pitem->topic = fc_strdup(Q_(secfile_lookup_str(sf, "%s.name",
1267 sec_name)));
1268
1269 paras = secfile_lookup_str_vec(sf, &npara, "%s.text", sec_name);
1270
1271 long_buffer[0] = '\0';
1272 for (i = 0; i < npara; i++) {
1273 bool inserted;
1274 const char *para = paras[i];
1275
1276 if (!fc_strncmp(para, "$", 1)) {
1277 inserted
1279 } else {
1281 inserted = TRUE;
1282 }
1283 if (inserted && i != npara - 1) {
1284 sz_strlcat(long_buffer, "\n\n");
1285 }
1286 }
1287 free(paras);
1288 paras = NULL;
1289 pitem->text = fc_strdup(long_buffer);
1292
1294 }
1295
1297 secfile_destroy(sf);
1298 booted = TRUE;
1299 log_verbose("Booted help texts ok");
1300}
1301
1302/****************************************************************************
1303 The following few functions are essentially wrappers for the
1304 help_nodes help_list. This allows us to avoid exporting the
1305 help_list, and instead only access it through a controlled
1306 interface.
1307****************************************************************************/
1308
1309/************************************************************************/
1313{
1315 return help_list_size(help_nodes);
1316}
1317
1318/************************************************************************/
1323const struct help_item *get_help_item(int pos)
1324{
1325 int size;
1326
1329 if (pos < 0 || pos > size) {
1330 log_error("Bad index %d to get_help_item (size %d)", pos, size);
1331 return NULL;
1332 }
1333 if (pos == size) {
1334 return NULL;
1335 }
1336 return help_list_get(help_nodes, pos);
1337}
1338
1339/************************************************************************/
1345const struct help_item*
1347{
1348 int idx;
1349 const struct help_item *pitem = NULL;
1350 static struct help_item vitem; /* v = virtual */
1351 static char vtopic[128];
1352 static char vtext[256];
1353
1355 idx = 0;
1357 char *p = ptmp->topic;
1358
1359 while (*p == ' ') {
1360 p++;
1361 }
1362 if (strcmp(name, p) == 0 && (htype == HELP_ANY || htype == ptmp->type)) {
1363 pitem = ptmp;
1364 break;
1365 }
1366 idx++;
1367 }
1369
1370 if (!pitem) {
1371 idx = -1;
1372 vitem.topic = vtopic;
1374 vitem.text = vtext;
1375 if (htype == HELP_ANY || htype == HELP_TEXT) {
1376 fc_snprintf(vtext, sizeof(vtext),
1377 _("Sorry, no help topic for %s.\n"), vitem.topic);
1378 vitem.type = HELP_TEXT;
1379 } else {
1380 fc_snprintf(vtext, sizeof(vtext),
1381 _("Sorry, no help topic for %s.\n"
1382 "This page was auto-generated.\n\n"),
1383 vitem.topic);
1384 vitem.type = htype;
1385 }
1386 pitem = &vitem;
1387 }
1388 *pos = idx;
1389 return pitem;
1390}
1391
1392/************************************************************************/
1403
1404/************************************************************************/
1408const struct help_item *help_iter_next(void)
1409{
1410 const struct help_item *pitem;
1411
1414 if (pitem) {
1416 }
1417
1418 return pitem;
1419}
1420
1421/****************************************************************************
1422 FIXME:
1423 Also, in principle these could be auto-generated once, inserted
1424 into pitem->text, and then don't need to keep re-generating them.
1425 Only thing to be careful of would be changeable data, but don't
1426 have that here (for ruleset change or spacerace change must
1427 re-boot helptexts anyway). Eg, genuinely dynamic information
1428 which could be useful would be if help system said which wonders
1429 have been built (or are being built and by who/where?)
1430****************************************************************************/
1431
1432/************************************************************************/
1439char *helptext_building(char *buf, size_t bufsz, struct player *pplayer,
1440 const char *user_text, const struct impr_type *pimprove)
1441{
1442 bool reqs = FALSE;
1443 struct universal source = {
1445 .value = {.building = pimprove}
1446 };
1447
1448 fc_assert_ret_val(NULL != buf && 0 < bufsz, NULL);
1449 buf[0] = '\0';
1450
1451 if (NULL == pimprove) {
1452 return buf;
1453 }
1454
1455 if (NULL != pimprove->helptext) {
1456 strvec_iterate(pimprove->helptext, text) {
1457 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
1459 }
1460
1461 /* Add requirement text for improvement itself */
1462 requirement_vector_iterate(&pimprove->reqs, preq) {
1463 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
1464 reqs = TRUE;
1465 }
1467 if (reqs) {
1468 fc_strlcat(buf, "\n", bufsz);
1469 }
1470
1472 if (VUT_ADVANCE == pobs->source.kind
1473 && pobs->present && !pobs->quiet) {
1475 _("%s The discovery of %s will make %s obsolete.\n"),
1476 BULLET,
1477 advance_name_translation(pobs->source.value.advance),
1479 }
1480 if (VUT_IMPROVEMENT == pobs->source.kind
1481 && pobs->present && !pobs->quiet) {
1483 /* TRANS: both %s are improvement names */
1484 _("%s The presence of %s in the city will make %s "
1485 "obsolete.\n"),
1486 BULLET,
1487 improvement_name_translation(pobs->source.value.building),
1489 }
1491
1492 if (is_small_wonder(pimprove)) {
1494 _("%s A 'small wonder': at most one of your cities may "
1495 "possess this improvement.\n"), BULLET);
1496 }
1497 /* (Great wonders are in their own help section explaining their
1498 * uniqueness, so we don't mention it here.) */
1499
1500 if (building_has_effect(pimprove, EFT_ENABLE_NUKE)) {
1502 struct unit_type *u = NULL;
1503
1504 {
1505 /* Find Manhattan dependent nuke actions */
1506 int i = 0;
1507
1510
1512 }
1513
1515 if (num_role_units(action_id_get_role(act_id)) > 0) {
1516 u = get_role_unit(action_id_get_role(act_id), 0);
1517 break;
1518 }
1520
1521 if (u) {
1522 struct advance *req = NULL;
1523 int count = 0;
1524
1526 req = preq;
1527 count++;
1529
1530 if (req != NULL) {
1531 if (count == 1) {
1533 /* TRANS: 'Allows all players with knowledge of atomic
1534 * power to build nuclear units.' */
1535 _("%s Allows all players with knowledge of %s "
1536 "to build %s units.\n"), BULLET,
1539 } else {
1540 /* Multiple tech requirements */
1542 /* TRANS: 'Allows all players with knowledge of required
1543 * techs to build nuclear units.' */
1544 _("%s Allows all players with knowledge of required "
1545 "techs to build %s units.\n"), BULLET,
1547 }
1548 } else {
1550 /* TRANS: 'Allows all players to build nuclear units.' */
1551 _("%s Allows all players to build %s units.\n"), BULLET,
1553 }
1554 }
1555 }
1556
1558 BULLET_SPACE);
1559
1560 /* Actions that requires the building to target a city. */
1561 action_iterate(act) {
1562 /* Nothing is found yet. */
1563 bool demanded = FALSE;
1565
1566 if (action_id_get_target_kind(act) != ATK_CITY) {
1567 /* Not relevant */
1568 continue;
1569 }
1570
1571 if (action_by_number(act)->quiet) {
1572 /* The ruleset it self documents this action. */
1573 continue;
1574 }
1575
1577 if (universal_fulfills_requirements(TRUE, &(enabler->target_reqs),
1578 &source)) {
1579 /* The building is needed by this action enabler. */
1580 demanded = TRUE;
1581
1582 /* See if this enabler gives the building a wider range. */
1583 requirement_vector_iterate(&(enabler->target_reqs), preq) {
1585 /* Not relevant. */
1586 continue;
1587 }
1588
1589 if (!preq->present) {
1590 /* A !present larger range requirement would make the present
1591 * lower range illegal. */
1592 continue;
1593 }
1594
1595 if (preq->range > max_range) {
1596 /* Found a larger range. */
1597 max_range = preq->range;
1598 /* Intentionally not breaking here. The requirement vector may
1599 * contain other requirements with a larger range.
1600 * Example: Building a GreatWonder in a city with a Palace. */
1601 }
1603 }
1605
1606 if (demanded) {
1607 switch (max_range) {
1608 case REQ_RANGE_LOCAL:
1609 /* At least one action enabler needed the building in its target
1610 * requirements. */
1612 /* TRANS: Help build Wonder */
1613 _("%s Makes it possible to target the city building it "
1614 "with the action \'%s\'.\n"), BULLET,
1616 break;
1617 case REQ_RANGE_CITY:
1618 /* At least one action enabler needed the building in its target
1619 * requirements. */
1621 /* TRANS: Help build Wonder */
1622 _("%s Makes it possible to target its city with the "
1623 "action \'%s\'.\n"), BULLET,
1625 break;
1627 /* At least one action enabler needed the building in its target
1628 * requirements. */
1630 /* TRANS: Help build Wonder */
1631 _("%s Makes it possible to target its city and its "
1632 "trade partners with the action \'%s\'.\n"),
1633 BULLET,
1635 break;
1637 /* At least one action enabler needed the building in its target
1638 * requirements. */
1640 /* TRANS: Help build Wonder */
1641 _("%s Makes it possible to target all cities with its "
1642 "owner on its continent with the action \'%s\'.\n"),
1643 BULLET,
1645 break;
1646 case REQ_RANGE_PLAYER:
1647 /* At least one action enabler needed the building in its target
1648 * requirements. */
1650 /* TRANS: Help build Wonder */
1651 _("%s Makes it possible to target all cities with its "
1652 "owner with the action \'%s\'.\n"),
1653 BULLET,
1655 break;
1656 case REQ_RANGE_TEAM:
1657 /* At least one action enabler needed the building in its target
1658 * requirements. */
1660 /* TRANS: Help build Wonder */
1661 _("%s Makes it possible to target all cities on the "
1662 "same team with the action \'%s\'.\n"),
1663 BULLET,
1665 break;
1666 case REQ_RANGE_ALLIANCE:
1667 /* At least one action enabler needed the building in its target
1668 * requirements. */
1670 /* TRANS: Help build Wonder */
1671 _("%s Makes it possible to target all cities owned by "
1672 "or allied to its owner with the action \'%s\'.\n"),
1673 BULLET,
1675 break;
1676 case REQ_RANGE_WORLD:
1677 /* At least one action enabler needed the building in its target
1678 * requirements. */
1680 /* TRANS: Help build Wonder */
1681 _("%s Makes it possible to target all cities with the "
1682 "action \'%s\'.\n"),
1683 BULLET,
1685 break;
1686 case REQ_RANGE_TILE:
1688 case REQ_RANGE_ADJACENT:
1689 case REQ_RANGE_COUNT:
1690 log_error("The range %s is invalid for buildings.",
1692 break;
1693 }
1694 }
1696
1697 /* Building protects against action. */
1698 action_iterate(act) {
1699 struct action *paction = action_by_number(act);
1700 /* Nothing is found yet. */
1701 bool vulnerable = FALSE;
1703
1704 if (action_id_get_target_kind(act) != ATK_CITY) {
1705 /* Not relevant */
1706 continue;
1707 }
1708
1709 if (!action_is_in_use(paction)) {
1710 /* This action isn't enabled at all. */
1711 continue;
1712 }
1713
1714 if (action_by_number(act)->quiet) {
1715 /* The ruleset it self documents this action. */
1716 continue;
1717 }
1718
1719 /* Must be immune in all cases. */
1722 &(enabler->target_reqs))) {
1723 vulnerable = TRUE;
1724 break;
1725 } else {
1727
1728 requirement_vector_iterate(&(enabler->target_reqs), preq) {
1730 /* Not relevant. */
1731 continue;
1732 }
1733
1734 if (preq->present) {
1735 /* Not what is looked for. */
1736 continue;
1737 }
1738
1739 if (preq->range > vector_max_range) {
1740 /* Found a larger range. */
1741 vector_max_range = preq->range;
1742 }
1744
1746 /* Found a smaller range. */
1748 }
1749 }
1751
1752 if (!vulnerable) {
1753 switch (min_range) {
1754 case REQ_RANGE_LOCAL:
1756 /* TRANS: Incite City */
1757 _("%s Makes it impossible to do the action \'%s\' to "
1758 "the city building it.\n"),
1759 BULLET,
1761 break;
1762 case REQ_RANGE_CITY:
1764 /* TRANS: Incite City */
1765 _("%s Makes it impossible to do the action \'%s\' to "
1766 "its city.\n"),
1767 BULLET,
1769 break;
1772 /* TRANS: Incite City */
1773 _("%s Makes it impossible to do the action \'%s\' to "
1774 "its city or to its city's trade partners.\n"),
1775 BULLET,
1777 break;
1780 /* TRANS: Incite City */
1781 _("%s Makes it impossible to do the action \'%s\' to "
1782 "any city with its owner on its continent.\n"),
1783 BULLET,
1785 break;
1786 case REQ_RANGE_PLAYER:
1788 /* TRANS: Incite City */
1789 _("%s Makes it impossible to do the action \'%s\' to "
1790 "any city with its owner.\n"),
1791 BULLET,
1793 break;
1794 case REQ_RANGE_TEAM:
1796 /* TRANS: Incite City */
1797 _("%s Makes it impossible to do the action \'%s\' to "
1798 "any city on the same team.\n"),
1799 BULLET,
1801 break;
1802 case REQ_RANGE_ALLIANCE:
1804 /* TRANS: Incite City */
1805 _("%s Makes it impossible to do the action \'%s\' to "
1806 "any city allied to or owned by its owner.\n"),
1807 BULLET,
1809 break;
1810 case REQ_RANGE_WORLD:
1812 /* TRANS: Incite City */
1813 _("%s Makes it impossible to do the action \'%s\' to "
1814 "any city in the game.\n"),
1815 BULLET,
1817 break;
1818 case REQ_RANGE_TILE:
1820 case REQ_RANGE_ADJACENT:
1821 case REQ_RANGE_COUNT:
1822 log_error("The range %s is invalid for buildings.",
1824 break;
1825 }
1826 }
1828
1829 {
1830 int i;
1831
1832 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
1834 if (n == B_LAST) {
1835 break;
1836 } else if (improvement_by_number(n) == pimprove) {
1838 _("%s All players start with this improvement in their "
1839 "first city.\n"), BULLET);
1840 break;
1841 }
1842 }
1843 }
1844
1845 /* Assume no-one will set the same building in both global and nation
1846 * init_buildings... */
1847 nations_iterate(pnation) {
1848 int i;
1849
1850 /* Avoid mentioning nations not in current set. */
1851 if (!show_help_for_nation(pnation)) {
1852 continue;
1853 }
1854 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
1855 Impr_type_id n = pnation->init_buildings[i];
1856 if (n == B_LAST) {
1857 break;
1858 } else if (improvement_by_number(n) == pimprove) {
1860 /* TRANS: %s is a nation plural */
1861 _("%s The %s start with this improvement in their "
1862 "first city.\n"), BULLET,
1863 nation_plural_translation(pnation));
1864 break;
1865 }
1866 }
1868
1871 /* TRANS: don't translate 'savepalace' */
1872 _("%s If you lose the city containing this improvement, "
1873 "it will be rebuilt for free in another of your cities "
1874 "(if the 'savepalace' server setting is enabled).\n"),
1875 BULLET);
1876 }
1877
1878 if (user_text && user_text[0] != '\0') {
1879 cat_snprintf(buf, bufsz, "\n\n%s", user_text);
1880 }
1881 return buf;
1882}
1883
1884/************************************************************************/
1890static bool utype_may_do_escape_action(const struct unit_type *utype)
1891{
1892 action_iterate(act_id) {
1893 struct action *paction = action_by_number(act_id);
1894
1896 /* Not relevant. */
1897 continue;
1898 }
1899
1900 if (!utype_can_do_action(utype, paction->id)) {
1901 /* Can't do it. */
1902 continue;
1903 }
1904
1906 /* No escape when dead. */
1907 continue;
1908 }
1909
1910 if (paction->actor.is_unit.moves_actor == MAK_ESCAPE) {
1911 /* Survives and escapes. */
1912 return TRUE;
1913 }
1915
1916 return FALSE;
1917}
1918
1919/************************************************************************/
1926void helptext_unitclass(struct unit_class *pclass, char *buf, size_t bufsz)
1927{
1928 int flagid;
1929
1930 if (pclass->helptext != NULL) {
1931 strvec_iterate(pclass->helptext, text) {
1932 cat_snprintf(buf, bufsz, "\n%s\n", _(text));
1934 } else {
1935 CATLSTR(buf, bufsz, "\n");
1936 }
1937
1939 /* TRANS: indented unit class property, preserve leading spaces */
1940 CATLSTR(buf, bufsz, _(" %s Speed is not affected by terrain.\n"),
1941 BULLET);
1942 }
1944 /* TRANS: indented unit class property, preserve leading spaces */
1945 CATLSTR(buf, bufsz, _(" %s Does not get defense bonuses from terrain.\n"),
1946 BULLET);
1947 }
1948
1950 /* TRANS: indented unit class property, preserve leading spaces */
1951 CATLSTR(buf, bufsz, _(" %s Not subject to zones of control.\n"),
1952 BULLET);
1953 }
1954
1956 /* TRANS: indented unit class property, preserve leading spaces */
1957 CATLSTR(buf, bufsz, _(" %s Slowed down while damaged.\n"), BULLET);
1958 }
1959
1961 CATLSTR(buf, bufsz,
1962 /* TRANS: indented unit class property, preserve leading spaces */
1963 _(" %s Is unreachable. Most units cannot attack this one.\n"),
1964 BULLET);
1965 }
1966
1968 CATLSTR(buf, bufsz,
1969 /* TRANS: Indented unit class property, preserve leading spaces */
1970 _(" %s Doesn't prevent enemy cities from working the tile it's on.\n"),
1971 BULLET);
1972 }
1973
1976 const char *helptxt = unit_class_flag_helptxt(flagid);
1977
1978 if (helptxt != NULL) {
1979 /* TRANS: Indented unit class property, preserve leading spaces */
1980 CATLSTR(buf, bufsz, " %s %s\n", BULLET, _(helptxt));
1981 }
1982 }
1983 }
1984}
1985
1986/************************************************************************/
1992char *helptext_unit(char *buf, size_t bufsz, struct player *pplayer,
1993 const char *user_text, const struct unit_type *utype,
1994 bool class_help)
1995{
1996 bool has_vet_levels;
1997 int flagid;
1998 struct unit_class *pclass;
1999 int fuel;
2000
2001 fc_assert_ret_val(NULL != buf && 0 < bufsz && NULL != user_text, NULL);
2002
2003 if (!utype) {
2004 log_error("Unknown unit!");
2006 return buf;
2007 }
2008
2010
2011 buf[0] = '\0';
2012
2013 pclass = utype_class(utype);
2015 _("%s Belongs to %s unit class."),
2016 BULLET,
2018
2019 if (class_help) {
2021 } else {
2022 cat_snprintf(buf, bufsz, "\n");
2023 }
2024
2026 && !utype_has_flag(utype, UTYF_IGZOC)) {
2027 /* TRANS: Indented unit class property, preserve leading spaces */
2028 CATLSTR(buf, bufsz, _(" %s Subject to zones of control.\n"),
2029 BULLET);
2030 }
2031
2032 if (utype->defense_strength > 0) {
2033 struct universal unit_is_in_city[] = {
2034 { .kind = VUT_UTYPE, .value = { .utype = utype }},
2035 { .kind = VUT_CITYTILE, .value = { .citytile = CITYT_CENTER }},
2036 };
2037 int bonus = effect_value_from_universals(
2040
2041 if (bonus > 0) {
2043 /* TRANS: Indented unit class property, preserve leading
2044 * spaces */
2045 _(" %s Gets a %d%% defensive bonus while in cities.\n"),
2046 BULLET, bonus);
2047 }
2048 }
2051 CATLSTR(buf, bufsz,
2052 /* TRANS: Indented twice; preserve leading spaces */
2053 _(" %s Doesn't prevent enemy units from attacking other "
2054 "units on its tile.\n"), BULLET);
2055 }
2056
2057 if (can_attack_non_native(utype)) {
2058 CATLSTR(buf, bufsz,
2059 /* TRANS: Indented unit class property, preserve leading spaces */
2060 _(" %s Can attack units on non-native tiles.\n"), BULLET);
2061 }
2062
2063 /* The unit's combat bonuses. Won't mention that another unit type has a
2064 * combat bonus against this unit type. Doesn't handle complex cases like
2065 * when a unit type has multiple combat bonuses of the same kind. */
2067 const char *against[utype_count()];
2068 int targets = 0;
2069
2070 if (cbonus->quiet) {
2071 /* Handled in the help text of the ruleset. */
2072 continue;
2073 }
2074
2075 /* Find the unit types of the bonus targets. */
2077 if (utype_has_flag(utype2, cbonus->flag)) {
2079 }
2081
2082 if (targets > 0) {
2083 struct astring list = ASTRING_INIT;
2084
2085 switch (cbonus->type) {
2088 /* TRANS: percentage ... or-list of unit types */
2089 _("%s %d%% defense bonus if attacked by %s.\n"),
2090 BULLET,
2091 cbonus->value * 100,
2092 astr_build_or_list(&list, against, targets));
2093 break;
2096 /* TRANS: defense divider ... or-list of unit types */
2097 _("%s Reduces target's defense to 1 / %d when "
2098 "attacking %s.\n"), BULLET,
2099 cbonus->value + 1,
2100 astr_build_or_list(&list, against, targets));
2101 break;
2104 /* TRANS: or-list of unit types */
2105 _("%s Reduces target's firepower to 1 when "
2106 "attacking %s.\n"), BULLET,
2107 astr_build_and_list(&list, against, targets));
2108 break;
2111 /* TRANS: percentage ... or-list of unit types */
2112 _("%s %d%% defense bonus if attacked by %s.\n"),
2113 BULLET, cbonus->value,
2114 astr_build_or_list(&list, against, targets));
2115 break;
2118 /* TRANS: defense divider ... or-list of unit types */
2119 _("%s Reduces target's defense to 1 / %.2f when "
2120 "attacking %s.\n"), BULLET,
2121 ((float) cbonus->value + 100.0f) / 100.0f,
2122 astr_build_or_list(&list, against, targets));
2123 break;
2126 /* TRANS: percentage ... or-list of unit types */
2127 _("%s %d%% defense bonus "
2128 "instead of any bonuses from city improvements "
2129 "if attacked by %s in a city.\n"),
2130 BULLET, cbonus->value,
2131 astr_build_or_list(&list, against, targets));
2132 break;
2133 }
2134
2135 astr_free(&list);
2136 }
2138
2139 /* Add requirement text for the unit type itself */
2142 BULLET_SPACE);
2144
2145 if (utype_has_flag(utype, UTYF_CANESCAPE)) {
2146 CATLSTR(buf, bufsz, _("%s Can escape once stack defender is lost.\n"),
2147 BULLET);
2148 }
2150 CATLSTR(buf, bufsz, _("%s Can pursue escaping units and kill them.\n"),
2151 BULLET);
2152 }
2153
2154 if (utype_has_flag(utype, UTYF_NOBUILD)) {
2155 CATLSTR(buf, bufsz, _("%s May not be built in cities.\n"), BULLET);
2156 }
2157 if (utype_has_flag(utype, UTYF_BARBARIAN_ONLY)) {
2158 CATLSTR(buf, bufsz, _("%s Only barbarians may build this.\n"), BULLET);
2159 }
2161 CATLSTR(buf, bufsz, _("%s Can only be built in games where new cities "
2162 "are allowed.\n"), BULLET);
2164 /* TRANS: indented; preserve leading spaces */
2165 CATLSTR(buf, bufsz, _(" %s New cities are not allowed in the current "
2166 "game.\n"), BULLET);
2167 } else {
2168 /* TRANS: indented; preserve leading spaces */
2169 CATLSTR(buf, bufsz, _(" %s New cities are allowed in the current "
2170 "game.\n"), BULLET);
2171 }
2172 }
2173 nations_iterate(pnation) {
2174 int i, count = 0;
2175
2176 /* Avoid mentioning nations not in current set. */
2177 if (!show_help_for_nation(pnation)) {
2178 continue;
2179 }
2180 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
2181 if (!pnation->init_units[i]) {
2182 break;
2183 } else if (pnation->init_units[i] == utype) {
2184 count++;
2185 }
2186 }
2187 if (count > 0) {
2189 /* TRANS: %s is a nation plural */
2190 PL_("%s The %s start the game with %d of these units.\n",
2191 "%s The %s start the game with %d of these units.\n",
2192 count), BULLET,
2193 nation_plural_translation(pnation), count);
2194 }
2196 {
2197 const char *types[utype_count()];
2198 int i = 0;
2199
2201 if (utype2->converted_to == utype
2203 types[i++] = utype_name_translation(utype2);
2204 }
2206 if (i > 0) {
2207 struct astring list = ASTRING_INIT;
2208
2209 astr_build_or_list(&list, types, i);
2211 /* TRANS: %s is a list of unit types separated by "or". */
2212 _("%s May be obtained by conversion of %s.\n"),
2213 BULLET, astr_str(&list));
2214 astr_free(&list);
2215 }
2216 }
2217 if (utype_has_flag(utype, UTYF_NOHOME)) {
2219 CATLSTR(buf, bufsz, _("%s Built without a home city.\n"), BULLET);
2220 } else {
2221 CATLSTR(buf, bufsz, _("%s Never has a home city.\n"), BULLET);
2222 }
2223 }
2224 if (utype_has_flag(utype, UTYF_GAMELOSS)) {
2225 CATLSTR(buf, bufsz, _("%s Losing this unit will lose you the game!\n"),
2226 BULLET);
2227 }
2228 if (utype_has_flag(utype, UTYF_UNIQUE)) {
2229 CATLSTR(buf, bufsz,
2230 _("%s Each player may only have one of this type of unit.\n"),
2231 BULLET);
2232 }
2234 if (utype_has_flag(utype, flagid)) {
2235 const char *helptxt = unit_type_flag_helptxt(flagid);
2236
2237 if (helptxt != NULL) {
2238 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
2239 }
2240 }
2241 }
2242 if (utype->pop_cost > 0) {
2244 PL_("%s Costs %d population to build.\n",
2245 "%s Costs %d population to build.\n", utype->pop_cost),
2246 BULLET, utype->pop_cost);
2247 }
2248 if (0 < utype->transport_capacity) {
2249 const char *classes[uclass_count()];
2250 int i = 0;
2251 struct astring list = ASTRING_INIT;
2252
2253 unit_class_iterate(uclass) {
2254 if (can_unit_type_transport(utype, uclass)) {
2255 classes[i++] = uclass_name_translation(uclass);
2256 }
2259
2261 /* TRANS: %s is a list of unit classes separated by "or". */
2262 PL_("%s Can carry and refuel %d %s unit.\n",
2263 "%s Can carry and refuel up to %d %s units.\n",
2264 utype->transport_capacity),
2266 astr_free(&list);
2268 /* Document restrictions on when units can load/unload */
2273 if (utype_can_freely_load(pcargo, utype)) {
2275 } else {
2277 }
2278 if (utype_can_freely_unload(pcargo, utype)) {
2280 } else {
2282 }
2283 }
2285 if (has_restricted_load) {
2287 /* At least one type of cargo can load onto us freely.
2288 * The specific exceptions will be documented in cargo help. */
2289 CATLSTR(buf, bufsz,
2290 /* TRANS: indented; preserve leading spaces */
2291 _(" %s Some cargo cannot be loaded except in a city or a "
2292 "base native to this transport.\n"), BULLET);
2293 } else {
2294 /* No exceptions */
2295 CATLSTR(buf, bufsz,
2296 /* TRANS: indented; preserve leading spaces */
2297 _(" %s Cargo cannot be loaded except in a city or a "
2298 "base native to this transport.\n"), BULLET);
2299 }
2300 } /* else, no restricted cargo exists; keep quiet */
2303 /* At least one type of cargo can unload from us freely. */
2304 CATLSTR(buf, bufsz,
2305 /* TRANS: indented; preserve leading spaces */
2306 _(" %s Some cargo cannot be unloaded except in a city or a "
2307 "base native to this transport.\n"), BULLET);
2308 } else {
2309 /* No exceptions */
2310 CATLSTR(buf, bufsz,
2311 /* TRANS: indented; preserve leading spaces */
2312 _(" %s Cargo cannot be unloaded except in a city or a "
2313 "base native to this transport.\n"), BULLET);
2314 }
2315 } /* else, no restricted cargo exists; keep quiet */
2316 }
2317 }
2318 if (utype_has_flag(utype, UTYF_COAST_STRICT)) {
2319 CATLSTR(buf, bufsz, _("%s Must stay next to safe coast.\n"), BULLET);
2320 }
2321 {
2322 /* Document exceptions to embark/disembark restrictions that we
2323 * have as cargo. */
2324 bv_unit_classes embarks, disembarks;
2325 BV_CLR_ALL(embarks);
2326 BV_CLR_ALL(disembarks);
2327 /* Determine which of our transport classes have restrictions in the first
2328 * place (that is, contain at least one transport which carries at least
2329 * one type of cargo which is restricted).
2330 * We'll suppress output for classes not in this set, since this cargo
2331 * type is not behaving exceptionally in such cases. */
2334 /* Don't waste time repeating checks on classes we've already checked,
2335 * or weren't under consideration in the first place */
2336 if (!BV_ISSET(embarks, trans_class)
2337 && BV_ISSET(utype->embarks, trans_class)) {
2341 /* At least one load restriction in transport class, which
2342 * we aren't subject to */
2343 BV_SET(embarks, trans_class);
2344 }
2345 } unit_type_iterate_end; /* cargo */
2346 }
2347 if (!BV_ISSET(disembarks, trans_class)
2348 && BV_ISSET(utype->disembarks, trans_class)) {
2352 /* At least one load restriction in transport class, which
2353 * we aren't subject to */
2354 BV_SET(disembarks, trans_class);
2355 }
2356 } unit_type_iterate_end; /* cargo */
2357 }
2358 } unit_class_iterate_end; /* transports */
2359
2360 if (BV_ISSET_ANY(embarks)) {
2361 /* Build list of embark exceptions */
2362 const char *eclasses[uclass_count()];
2363 int i = 0;
2364 struct astring elist = ASTRING_INIT;
2365
2366 unit_class_iterate(uclass) {
2367 if (BV_ISSET(embarks, uclass_index(uclass))) {
2368 eclasses[i++] = uclass_name_translation(uclass);
2369 }
2372 if (BV_ARE_EQUAL(embarks, disembarks)) {
2373 /* A common case: the list of disembark exceptions is identical */
2375 /* TRANS: %s is a list of unit classes separated
2376 * by "or". */
2377 _("%s May load onto and unload from %s transports even "
2378 "when underway.\n"),
2379 BULLET, astr_str(&elist));
2380 } else {
2382 /* TRANS: %s is a list of unit classes separated
2383 * by "or". */
2384 _("%s May load onto %s transports even when underway.\n"),
2385 BULLET, astr_str(&elist));
2386 }
2387 astr_free(&elist);
2388 }
2389 if (BV_ISSET_ANY(disembarks) && !BV_ARE_EQUAL(embarks, disembarks)) {
2390 /* Build list of disembark exceptions (if different from embarking) */
2391 const char *dclasses[uclass_count()];
2392 int i = 0;
2393 struct astring dlist = ASTRING_INIT;
2394
2395 unit_class_iterate(uclass) {
2396 if (BV_ISSET(disembarks, uclass_index(uclass))) {
2397 dclasses[i++] = uclass_name_translation(uclass);
2398 }
2402 /* TRANS: %s is a list of unit classes separated
2403 * by "or". */
2404 _("%s May unload from %s transports even when underway.\n"),
2405 BULLET, astr_str(&dlist));
2406 astr_free(&dlist);
2407 }
2408 }
2409
2410 if (utype_has_flag(utype, UTYF_SPY)) {
2411 CATLSTR(buf, bufsz, _("%s Strong in diplomatic battles.\n"), BULLET);
2412 }
2413 if (utype_has_flag(utype, UTYF_DIPLOMAT)
2414 || utype_has_flag(utype, UTYF_SUPERSPY)) {
2415 CATLSTR(buf, bufsz, _("%s Defends cities against diplomatic actions.\n"),
2416 BULLET);
2417 }
2418 if (utype_has_flag(utype, UTYF_SUPERSPY)) {
2419 CATLSTR(buf, bufsz, _("%s Will never lose a diplomat-versus-diplomat fight.\n"),
2420 BULLET);
2421 }
2423 && utype_has_flag(utype, UTYF_SUPERSPY)) {
2424 CATLSTR(buf, bufsz, _("%s Will always survive a spy mission.\n"), BULLET);
2425 }
2426 if (utype->vlayer == V_INVIS) {
2427 CATLSTR(buf, bufsz,
2428 _("%s Is invisible except when next to an enemy unit or city.\n"),
2429 BULLET);
2430 }
2432 CATLSTR(buf, bufsz,
2433 _("%s Can only attack units on native tiles.\n"), BULLET);
2434 }
2435 if (utype_has_flag(utype, UTYF_CITYBUSTER)) {
2436 CATLSTR(buf, bufsz,
2437 _("%s Gets double firepower when attacking cities.\n"), BULLET);
2438 }
2439 if (utype_has_flag(utype, UTYF_IGTER)) {
2441 /* TRANS: "MP" = movement points. %s may have a
2442 * fractional part. */
2443 _("%s Ignores terrain effects (moving costs at most %s MP "
2444 "per tile).\n"), BULLET,
2446 }
2447 if (utype_has_flag(utype, UTYF_NOZOC)) {
2448 CATLSTR(buf, bufsz, _("%s Never imposes a zone of control.\n"), BULLET);
2449 } else {
2450 CATLSTR(buf, bufsz, _("%s May impose a zone of control on its adjacent "
2451 "tiles.\n"), BULLET);
2452 }
2453 if (utype_has_flag(utype, UTYF_IGZOC)) {
2454 CATLSTR(buf, bufsz, _("%s Not subject to zones of control imposed "
2455 "by other units.\n"), BULLET);
2456 }
2457 if (utype_has_flag(utype, UTYF_CIVILIAN)) {
2458 CATLSTR(buf, bufsz,
2459 _("%s A non-military unit:\n"), BULLET);
2460 CATLSTR(buf, bufsz,
2461 /* TRANS: indented; preserve leading spaces */
2462 _(" %s Cannot attack.\n"), BULLET);
2463 CATLSTR(buf, bufsz,
2464 /* TRANS: indented; preserve leading spaces */
2465 _(" %s Doesn't impose martial law.\n"), BULLET);
2466 CATLSTR(buf, bufsz,
2467 /* TRANS: indented; preserve leading spaces */
2468 _(" %s Can enter foreign territory regardless of peace treaty.\n"),
2469 BULLET);
2470 CATLSTR(buf, bufsz,
2471 /* TRANS: indented; preserve leading spaces */
2472 _(" %s Doesn't prevent enemy cities from working the tile it's on.\n"),
2473 BULLET);
2474 }
2475 if (utype_has_flag(utype, UTYF_FIELDUNIT)) {
2476 CATLSTR(buf, bufsz,
2477 _("%s A field unit: one unhappiness applies even when non-aggressive.\n"),
2478 BULLET);
2479 }
2480 if (utype_has_flag(utype, UTYF_PROVOKING)
2482 server_setting_by_name("autoattack"))) {
2483 CATLSTR(buf, bufsz,
2484 _("%s An enemy unit considering to auto attack this unit will "
2485 "choose to do so even if it has better odds when defending "
2486 "against it than when attacking it.\n"), BULLET);
2487 }
2488 if (utype_has_flag(utype, UTYF_SHIELD2GOLD)) {
2489 /* FIXME: the conversion shield => gold is activated if
2490 * EFT_SHIELD2GOLD_FACTOR is not equal null; how to determine
2491 * possible sources? */
2492 CATLSTR(buf, bufsz,
2493 _("%s Under certain conditions the shield upkeep of this unit can "
2494 "be converted to gold upkeep.\n"), BULLET);
2495 }
2496
2497 unit_class_iterate(target) {
2498 if (uclass_has_flag(target, UCF_UNREACHABLE)
2499 && BV_ISSET(utype->targets, uclass_index(target))) {
2501 _("%s Can attack against %s units, which are usually not "
2502 "reachable.\n"), BULLET,
2503 uclass_name_translation(target));
2504 }
2506
2507 fuel = utype_fuel(utype);
2508 if (fuel > 0) {
2509 const char *types[utype_count()];
2510 int i = 0;
2511
2515 }
2517
2518 if (0 == i) {
2519 if (utype_has_flag(utype, UTYF_COAST)) {
2520 if (fuel == 1) {
2522 _("%s Unit has to end each turn next to safe coast or"
2523 " in a city or a base.\n"), BULLET);
2524 } else {
2526 /* Pluralization for the benefit of languages with
2527 * duals etc */
2528 /* TRANS: Never called for 'turns = 1' case */
2529 PL_("%s Unit has to be next to safe coast, in a city or a base"
2530 " after %d turn.\n",
2531 "%s Unit has to be next to safe coast, in a city or a base"
2532 " after %d turns.\n",
2533 fuel),
2534 BULLET, fuel);
2535 }
2536 } else {
2538 PL_("%s Unit has to be in a city or a base"
2539 " after %d turn.\n",
2540 "%s Unit has to be in a city or a base"
2541 " after %d turns.\n",
2542 fuel),
2543 BULLET, fuel);
2544 }
2545 } else {
2546 struct astring list = ASTRING_INIT;
2547
2548 if (utype_has_flag(utype, UTYF_COAST)) {
2550 /* TRANS: %s is a list of unit types separated by "or" */
2551 PL_("%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2552 " after %d turn.\n",
2553 "%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2554 " after %d turns.\n",
2555 fuel),
2556 BULLET, astr_build_or_list(&list, types, i), fuel);
2557 } else {
2559 /* TRANS: %s is a list of unit types separated by "or" */
2560 PL_("%s Unit has to be in a city, a base, or on a %s"
2561 " after %d turn.\n",
2562 "%s Unit has to be in a city, a base, or on a %s"
2563 " after %d turns.\n",
2564 fuel),
2565 BULLET, astr_build_or_list(&list, types, i), fuel);
2566 }
2567 astr_free(&list);
2568 }
2569 }
2570
2571 /* Auto attack immunity. (auto_attack.if_attacker ruleset setting) */
2573 server_setting_by_name("autoattack"))) {
2575
2577 if (auto_action->cause != AAPC_UNIT_MOVED_ADJ) {
2578 /* Not relevant for auto attack. */
2579 continue;
2580 }
2581
2583 /* Can be forced to auto attack. */
2585 break;
2586 }
2588
2590 CATLSTR(buf, bufsz,
2591 _("%s Will never be forced (by the autoattack server setting)"
2592 " to attack units moving to an adjacent tile.\n"), BULLET);
2593 }
2594 }
2595
2596 action_iterate(act) {
2597 struct action *paction = action_by_number(act);
2598
2599 if (action_by_number(act)->quiet) {
2600 /* The ruleset documents this action it self. */
2601 continue;
2602 }
2603
2604 if (utype_can_do_action(utype, act)) {
2605 const char *target_adjective;
2606 char sub_target_text[100];
2607 const char *blockers[MAX_NUM_ACTIONS];
2608 int i = 0;
2609
2610 /* Generic action information. */
2612 /* TRANS: %s is the action's ruleset defined ui name */
2613 _("%s Can do the action \'%s\'.\n"),
2615
2616 switch (action_id_get_target_kind(act)) {
2617 case ATK_SELF:
2618 /* No target. */
2619 break;
2620 default:
2621 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2622 DRO_FOREIGN, TRUE)) {
2623 /* TRANS: describes the target of an action. */
2624 target_adjective = _("domestic ");
2625 } else if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2626 DRO_FOREIGN, FALSE)) {
2627 /* TRANS: describes the target of an action. */
2628 target_adjective = _("foreign ");
2629 } else {
2630 /* Both foreign and domestic targets are acceptable. */
2631 target_adjective = "";
2632 }
2633
2634 sub_target_text[0] = '\0';
2639 /* TRANS: action sub target extras with tile
2640 * extras target. */
2641 _("extras among "));
2642 } else {
2644 /* TRANS: action sub target kind. */
2645 _("%s "),
2648 }
2649 }
2650
2652 /* TRANS: First %s in %s%s%s is the sub target kind.
2653 * The next may be an adjective (that includes a space).
2654 * The next is the name of the target kind.
2655 * Example: "* is done to extras on foreign tiles." */
2656 _(" %s is done to %s%s%s.\n"), BULLET,
2660 }
2661
2664 /* TRANS: said about an action. %s is a unit type
2665 * name. */
2666 _(" %s uses up the %s.\n"), BULLET,
2667 utype_name_translation(utype));
2668 }
2669
2670 if (actres_get_battle_kind(paction->result) != ABK_NONE) {
2672 /* TRANS: The %s is a kind of battle defined in
2673 * actions.h. Example: "diplomatic battle". */
2674 _(" %s can lead to a %s against a defender.\n"),
2675 BULLET,
2678 }
2679
2680 {
2681 struct universal req_pattern[] = {
2682 { .kind = VUT_ACTION, .value.action = paction },
2683 { .kind = VUT_UTYPE, .value.utype = utype },
2684 };
2686
2691 ((100 - odds) * 100
2692 / odds))) {
2694 _(" %s may fail because of a dice throw.\n"),
2695 BULLET);
2696 }
2697 }
2698
2700 && paction->actor.is_unit.moves_actor == MAK_ESCAPE) {
2702 /* TRANS: said about an action. %s is a unit type
2703 * name. */
2704 _(" %s the %s may be captured while trying to"
2705 " escape after completing the mission.\n"),
2706 BULLET,
2707 utype_name_translation(utype));
2708 }
2709
2711 /* The dead don't care about movement loss. */
2712 } else if (utype_action_takes_all_mp(utype, paction)) {
2714 /* TRANS: Indented unit action property, preserve
2715 * leading spaces. */
2716 _(" %s ends this unit's turn.\n"),
2717 BULLET);
2719 USP_NATIVE_TILE)) {
2720 /* Used in the implementation of slow_invasion in many of the
2721 * bundled rulesets and in rulesets upgraded with rscompat from 3.0
2722 * to 3.1. */
2724 /* TRANS: Indented unit action property, preserve
2725 * leading spaces. */
2726 _(" %s ending up on a native tile"
2727 " after this action has been performed"
2728 " ends this unit's turn.\n"), BULLET);
2729 }
2730
2731 if (action_id_get_target_kind(act) != ATK_SELF) {
2732 /* Distance to target is relevant. */
2733
2734 /* FIXME: move paratroopers_range to the action and remove this
2735 * variable once actions are generalized. */
2739 MIN(paction->max_distance, utype->paratroopers_range) :
2740 paction->max_distance;
2741
2742 if (paction->min_distance == relative_max) {
2743 /* Only one distance to target is acceptable */
2744
2745 if (paction->min_distance == 0) {
2747 /* TRANS: distance between an actor unit and its
2748 * target when performing a specific action. */
2749 _(" %s target must be at the same tile.\n"),
2750 BULLET);
2751 } else {
2753 /* TRANS: distance between an actor unit and its
2754 * target when performing a specific action. */
2755 PL_(" %s target must be exactly %d tile away.\n",
2756 " %s target must be exactly %d tiles away.\n",
2757 paction->min_distance),
2758 BULLET, paction->min_distance);
2759 }
2761 /* No max distance */
2762
2763 if (paction->min_distance == 0) {
2765 /* TRANS: distance between an actor unit and its
2766 * target when performing a specific action. */
2767 _(" %s target can be anywhere.\n"), BULLET);
2768 } else {
2770 /* TRANS: distance between an actor unit and its
2771 * target when performing a specific action. */
2772 PL_(" %s target must be at least %d tile away.\n",
2773 " %s target must be at least %d tiles away.\n",
2774 paction->min_distance),
2775 BULLET, paction->min_distance);
2776 }
2777 } else if (paction->min_distance == 0) {
2778 /* No min distance */
2779
2781 /* TRANS: distance between an actor unit and its
2782 * target when performing a specific action. */
2783 PL_(" %s target can be max %d tile away.\n",
2784 " %s target can be max %d tiles away.\n",
2785 relative_max),
2787 } else {
2788 /* Full range. */
2789
2791 /* TRANS: distance between an actor unit and its
2792 * target when performing a specific action. */
2793 PL_(" %s target must be between %d and %d tile away.\n",
2794 " %s target must be between %d and %d tiles away.\n",
2795 relative_max),
2796 BULLET, paction->min_distance, relative_max);
2797 }
2798 }
2799
2800 /* The action may be a Casus Belli. */
2801 {
2802 const struct {
2803 const enum effect_type eft;
2804 const char *hlp_text;
2805 } casus_belli[] = {
2806 /* TRANS: ...performing this action ... Casus Belli */
2807 { EFT_CASUS_BELLI_SUCCESS, N_("successfully") },
2808 /* TRANS: ...performing this action ... Casus Belli */
2809 { EFT_CASUS_BELLI_CAUGHT, N_("getting caught before") },
2810 };
2811
2812 struct universal req_pattern[] = {
2813 { .kind = VUT_ACTION, .value.action = paction },
2814 { .kind = VUT_DIPLREL, /* value filled in later */ },
2815 };
2816
2817 /* First group by effect (currently getting caught and successfully
2818 * performing the action) */
2819 for (i = 0; i < ARRAY_SIZE(casus_belli); i++) {
2820 int diplrel;
2821
2822 /* DiplRel list of each Casus Belli size. */
2823 const char *victim_diplrel_names[DRO_LAST];
2824 const char *outrage_diplrel_names[DRO_LAST];
2825 int victim_diplrel_count = 0;
2826 int outrage_diplrel_count = 0;
2827
2828 /* Ignore Team and everything in diplrel_other. */
2829 for (diplrel = 0; diplrel < DS_NO_CONTACT; diplrel++) {
2831
2832 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2833 diplrel, TRUE)) {
2834 /* Can't do the action. Can't give Casus Belli. */
2835 continue;
2836 }
2837
2838 req_pattern[1].value.diplrel = diplrel;
2840 casus_belli[i].eft,
2842
2845 diplrel_name_translation(diplrel);
2846 } else if (CASUS_BELLI_VICTIM <= casus_belli_amount) {
2848 diplrel_name_translation(diplrel);
2849 }
2850 }
2851
2852 /* Then group by Casus Belli size (currently victim and
2853 * international outrage) */
2854 if (outrage_diplrel_count > 0) {
2855 struct astring list = ASTRING_INIT;
2857 /* TRANS: successfully ... Peace, or Alliance */
2858 _(" %s %s performing this action during %s causes"
2859 " international outrage: the whole world gets "
2860 "Casus Belli against you.\n"), BULLET,
2864 astr_free(&list);
2865 }
2866 if (victim_diplrel_count > 0) {
2867 struct astring list = ASTRING_INIT;
2869 /* TRANS: successfully ... Peace, or Alliance */
2870 _(" %s %s performing this action during %s gives"
2871 " the victim Casus Belli against you.\n"),
2872 BULLET,
2876 astr_free(&list);
2877 }
2878 }
2879 }
2880
2881 /* Custom action result specific information. */
2882 switch (paction->result) {
2883 case ACTRES_HELP_WONDER:
2885 /* TRANS: the %d is the number of shields the unit can
2886 * contribute. */
2887 _(" %s adds %d production.\n"), BULLET,
2889 break;
2890 case ACTRES_HEAL_UNIT:
2891 {
2892 struct universal req_pattern[] = {
2893 { .kind = VUT_ACTION, .value.action = paction },
2894 { .kind = VUT_UTYPE, .value.utype = utype },
2895 };
2896
2898 _(" %s restores up to %d%% of the target unit's"
2899 " hit points.\n"), BULLET,
2903 + 100);
2904 }
2905 break;
2906 case ACTRES_FOUND_CITY:
2909 /* TRANS: is talking about an action. */
2910 _(" %s is disabled in the current game.\n"),
2911 BULLET);
2912 }
2914 /* TRANS: the %d is initial population. */
2915 PL_(" %s initial population: %d.\n",
2916 " %s initial population: %d.\n",
2917 utype->city_size),
2918 BULLET, utype->city_size);
2919 break;
2920 case ACTRES_JOIN_CITY:
2922 /* TRANS: the %d is population. */
2923 PL_(" %s max target size: %d.\n",
2924 " %s max target size: %d.\n",
2928 /* TRANS: the %d is the population added. */
2929 PL_(" %s adds %d population.\n",
2930 " %s adds %d population.\n",
2931 utype->pop_cost),
2932 BULLET, utype->pop_cost);
2933 break;
2934 case ACTRES_BOMBARD:
2936 /* TRANS: %d is bombard rate. */
2937 _(" %s %d per turn.\n"), BULLET,
2938 utype->bombard_rate);
2940 /* TRANS: talking about bombard */
2941 _(" %s Will damage all"
2942 " defenders on a tile, and have no risk for the"
2943 " attacker.\n"), BULLET);
2944 break;
2947 /* TRANS: %s is a unit type. */
2948 _(" %s upgraded to %s or, when possible, to the unit "
2949 "type it upgrades to.\n"), BULLET,
2951 break;
2952 case ACTRES_ATTACK:
2953 if (game.info.tired_attack) {
2955 _(" %s weaker when tired. If performed with less "
2956 "than a single move point left the attack power "
2957 "is reduced accordingly.\n"), BULLET);
2958 }
2959 break;
2960 case ACTRES_WIPE_UNITS:
2962 _(" %s can wipe stack of units with zero defense.\n"),
2963 BULLET);
2964 break;
2965 case ACTRES_CONVERT:
2967 /* TRANS: %s is a unit type. "MP" = movement points. */
2968 PL_(" %s is converted into %s (takes %d MP).\n",
2969 " %s is converted into %s (takes %d MP).\n",
2970 utype->convert_time),
2971 BULLET,
2973 utype->convert_time);
2974 break;
2975 case ACTRES_SPY_NUKE:
2976 case ACTRES_NUKE:
2977 case ACTRES_NUKE_UNITS:
2978 if (game.info.nuke_pop_loss_pct > 0) {
2980 /* TRANS: percentage */
2981 _(" %s %d%% of the population of each city inside"
2982 " the nuclear blast dies.\n"), BULLET,
2984 if (game.info.nuke_pop_loss_pct < 50) {
2986 _(" %s can never destroy city completely "
2987 "(%d%% of size 1 rounds down to 0).\n"), BULLET,
2989 } else {
2991 _(" %s can even destroy city completely "
2992 "(%d%% of size 1 rounds up to 1).\n"), BULLET,
2994 }
2995 }
2998 _(" %s all units caught in the open by the nuclear"
2999 " blast die.\n"), BULLET);
3001 /* TRANS: percentage */
3002 _(" %s a unit caught in the nuclear blast while"
3003 " inside a city has a %d%% chance of survival.\n"),
3004 BULLET,
3006 } else {
3008 _(" %s all units caught in the nuclear blast"
3009 " die.\n"), BULLET);
3010 }
3011 {
3012 struct universal req_pattern[] = {
3013 { .kind = VUT_ACTION, .value.action = paction },
3014 { .kind = VUT_UTYPE, .value.utype = utype },
3015 };
3016
3017 int blast_radius_1 =
3021
3023 _(" %s has a squared blast radius of %d.\n"),
3025 }
3026
3027 break;
3028 case ACTRES_PLANT:
3029 case ACTRES_CULTIVATE:
3032 _(" %s converts target tile terrain to another"
3033 " type.\n"), BULLET);
3034 break;
3035 case ACTRES_ROAD:
3036 case ACTRES_MINE:
3037 case ACTRES_IRRIGATE:
3038 case ACTRES_BASE:
3039 {
3041 struct strvec *extras_vec = strvec_new();
3042
3043 extra_type_iterate(pextra) {
3044 if (actres_creates_extra(paction->result, pextra)) {
3046 }
3048
3049 if (strvec_size(extras_vec) > 0) {
3051 /* TRANS: %s is list of extra types separated by ',' and 'and' */
3052 cat_snprintf(buf, bufsz, _(" %s builds %s on tiles.\n"),
3055 }
3056
3058 }
3059 break;
3060 case ACTRES_CLEAN:
3061 {
3063 struct strvec *extras_vec = strvec_new();
3064
3065 extra_type_iterate(pextra) {
3066 if (actres_removes_extra(paction->result, pextra)) {
3068 }
3070
3071 if (strvec_size(extras_vec) > 0) {
3073 /* TRANS: list of extras separated by "and" */
3074 cat_snprintf(buf, bufsz, _(" %s cleans %s from tiles.\n"),
3077 }
3078
3080 }
3081 break;
3082 case ACTRES_PILLAGE:
3083 {
3085 struct strvec *extras_vec = strvec_new();
3086
3087 extra_type_iterate(pextra) {
3088 if (actres_removes_extra(paction->result, pextra)) {
3090 }
3092
3093 if (strvec_size(extras_vec) > 0) {
3095 /* TRANS: list of extras separated by "and" */
3096 cat_snprintf(buf, bufsz, _(" %s pillages %s from tiles.\n"),
3099 }
3100
3102 }
3103 break;
3104 case ACTRES_FORTIFY:
3105 {
3106 struct universal unit_is_fortified[] = {
3107 { .kind = VUT_ACTIVITY,
3108 .value = { .activity = ACTIVITY_FORTIFIED }},
3109 { .kind = VUT_UTYPE, .value = { .utype = utype }},
3110 };
3111 int bonus = effect_value_from_universals(
3114
3115 if (utype->defense_strength <= 0
3117 &(struct universal){
3118 .kind = VUT_UTYPE,
3119 .value = { .utype = utype }},
3120 1)
3121 <= 0)) {
3123 /* TRANS: indented unit action property, preserve
3124 * leading spaces */
3125 _(" %s to stay put. No defensive bonus.\n"),
3126 BULLET);
3127 } else if (bonus > 0) {
3129 /* TRANS: indented unit action property, preserve
3130 * leading spaces */
3131 _(" %s granting a %d%% defensive bonus.\n"),
3132 BULLET, bonus);
3133 }
3134 }
3135 break;
3137 {
3138 const char *targets[extra_count()];
3139 int j = 0;
3140
3141 /* Extra being native one is a hard requirement
3142 * Not using unit class native_bases cache here.
3143 * Sometimes it's not initialized when we run this,
3144 * and as this is not performance critical, no point
3145 * in using it conditionally and having this only as
3146 * fallback implementation. */
3148 if (!is_native_extra_to_uclass(pextra, pclass)) {
3149 continue;
3150 }
3151
3152 if (!territory_claiming_base(pextra->data.base)) {
3153 continue;
3154 }
3155
3156 targets[j++] = extra_name_translation(pextra);
3158
3159 if (j > 0) {
3160 struct astring list = ASTRING_INIT;
3161 /* TRANS: indented unit action property, preserve
3162 * leading spaces.
3163 * %s is a list of extra types separated by "and". */
3164 cat_snprintf(buf, bufsz, _(" %s done to %s.\n"),
3165 BULLET,
3166 astr_build_and_list(&list, targets, j));
3167 astr_free(&list);
3168 }
3169 }
3170 break;
3171 default:
3172 /* No action specific details. */
3173 break;
3174 }
3175
3176 /* Custom action sub result specific information. */
3177 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_ENTER)) {
3179 /* TRANS: indented unit action property, preserve
3180 * leading spaces. */
3181 _(" %s if a suitable hut is at the targetet tile it"
3182 " will be entered.\n"), BULLET);
3183 }
3184 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_FRIGHTEN)) {
3186 /* TRANS: indented unit action property, preserve
3187 * leading spaces. */
3188 _(" %s if a suitable hut is at the targetet tile it"
3189 " will be frightened.\n"), BULLET);
3190 }
3191 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_MAY_EMBARK)) {
3193 /* TRANS: indented unit action property, preserve
3194 * leading spaces.
3195 * The %s is the unit type name */
3196 _(" %s the %s may end up loaded into a transport if it"
3197 " can't survive on its own at the target tile.\n"),
3199 }
3200 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_NON_LETHAL)) {
3202 /* TRANS: talking about non lethal attacks */
3203 _(" %s These attacks will only damage (never kill)"
3204 " defenders.\n"), BULLET);
3205 }
3206
3207 i = 0;
3209 const struct action *blocker = action_by_number(blocker_id);
3210
3211 if (!utype_can_do_action(utype, blocker->id)) {
3212 /* Can't block since never legal. */
3213 continue;
3214 }
3215
3216 if (action_would_be_blocked_by(paction, blocker)) {
3217 /* action name alone can be MAX_LEN_NAME, leave space for extra
3218 * characters */
3219 int maxlen = MAX_LEN_NAME + 16;
3220 char *quoted = fc_malloc(maxlen);
3221
3223 /* TRANS: %s is an action that can block another. */
3224 _("\'%s\'"), action_name_translation(blocker));
3225 blockers[i] = quoted;
3226
3227 i++;
3228 }
3230
3231 if (i > 0) {
3232 struct astring blist = ASTRING_INIT;
3233
3235 /* TRANS: %s is a list of actions separated by "or". */
3236 _(" %s can't be done if %s is legal.\n"), BULLET,
3238
3239 astr_free(&blist);
3240
3241 for (; i > 0; i--) {
3242 /* The text was copied above. */
3243 free((char *)(blockers[i - 1]));
3244 }
3245 }
3246 }
3248 action_iterate(act) {
3249 struct action *paction = action_by_number(act);
3250 bool vulnerable;
3251
3252 if (action_by_number(act)->quiet) {
3253 /* The ruleset documents this action it self. */
3254 continue;
3255 }
3256
3257 /* Not relevant */
3261 continue;
3262 }
3263
3264 /* All units are immune to this since its not enabled */
3265 if (!action_is_in_use(paction)) {
3266 continue;
3267 }
3268
3269 /* Must be immune in all cases */
3270 vulnerable = FALSE;
3273 &(enabler->target_reqs))) {
3274 vulnerable = TRUE;
3275 break;
3276 }
3278
3279 if (!vulnerable) {
3281 _("%s Doing the action \'%s\' to this unit"
3282 " is impossible.\n"), BULLET,
3284 }
3286 if (!has_vet_levels) {
3287 /* Only mention this if the game generally does have veteran levels. */
3288 if (game.veteran->levels > 1) {
3289 CATLSTR(buf, bufsz, _("%s Will never achieve veteran status.\n"), BULLET);
3290 }
3291 } else {
3292 /* Not useful currently: */
3293#if 0
3294 /* Some units can never become veteran through combat in practice. */
3297 && utype->defense_strength == 0);
3298#endif
3299 /* FIXME: if we knew the raise chances on the client, we could be
3300 * more specific here about whether veteran status can be acquired
3301 * through combat/missions/work. Should also take into account
3302 * UTYF_NO_VETERAN when writing this text. (Gna patch #4794) */
3303 CATLSTR(buf, bufsz, _("%s May acquire veteran status.\n"), BULLET);
3304 if (utype_veteran_has_power_bonus(utype)) {
3306 || utype->defense_strength > 0) {
3307 CATLSTR(buf, bufsz,
3308 /* TRANS: indented; preserve leading spaces */
3309 _(" %s Veterans have increased strength in combat.\n"),
3310 BULLET);
3311 }
3312 /* SUPERSPY always wins/escapes */
3313 if (utype_has_flag(utype, UTYF_DIPLOMAT)
3314 && !utype_has_flag(utype, UTYF_SUPERSPY)) {
3315 CATLSTR(buf, bufsz,
3316 /* TRANS: indented; preserve leading spaces */
3317 _(" %s Veterans have improved chances in diplomatic "
3318 "contests.\n"), BULLET);
3319 if (utype_may_do_escape_action(utype)) {
3320 CATLSTR(buf, bufsz,
3321 /* TRANS: indented; preserve leading spaces */
3322 _(" %s Veterans are more likely to survive missions.\n"),
3323 BULLET);
3324 }
3325 }
3326 if (utype_has_flag(utype, UTYF_SETTLERS)) {
3327 CATLSTR(buf, bufsz,
3328 /* TRANS: indented; preserve leading spaces */
3329 _(" %s Veterans work faster.\n"), BULLET);
3330 }
3331 }
3332 }
3333 if (strlen(buf) > 0) {
3334 CATLSTR(buf, bufsz, "\n");
3335 }
3336 if (has_vet_levels && utype->veteran) {
3337 /* The case where the unit has only a single veteran level has already
3338 * been handled above, so keep quiet here if that happens */
3339 if (insert_veteran_help(buf, bufsz, utype->veteran,
3340 _("This type of unit has its own veteran levels:"), NULL)) {
3341 CATLSTR(buf, bufsz, "\n\n");
3342 }
3343 }
3344 if (NULL != utype->helptext) {
3345 strvec_iterate(utype->helptext, text) {
3346 CATLSTR(buf, bufsz, "%s\n\n", _(text));
3348 }
3349 CATLSTR(buf, bufsz, "%s", user_text);
3350
3351 return buf;
3352}
3353
3354/************************************************************************/
3359void helptext_advance(char *buf, size_t bufsz, struct player *pplayer,
3360 const char *user_text, int i)
3361{
3362 struct astring astr = ASTRING_INIT;
3364 struct universal source = {
3365 .kind = VUT_ADVANCE,
3366 .value = {.advance = vap}
3367 };
3368 int flagid;
3369
3370 fc_assert_ret(NULL != buf && 0 < bufsz && NULL != user_text);
3372
3373 if (NULL == vap) {
3374 log_error("Unknown tech %d.", i);
3375 return;
3376 }
3377
3378 if (game.control.num_tech_classes > 0) {
3379 if (vap->tclass == NULL) {
3380 cat_snprintf(buf, bufsz, _("Belongs to the default tech class.\n\n"));
3381 } else {
3382 cat_snprintf(buf, bufsz, _("Belongs to tech class %s.\n\n"),
3384 }
3385 }
3386
3387 if (NULL != pplayer) {
3388 const struct research *presearch = research_get(pplayer);
3389
3393
3395 PL_("Starting now, researching %s would need %d bulb.",
3396 "Starting now, researching %s would need %d bulbs.",
3397 bulbs),
3400 /* Split string into two to allow localization of two pluralizations. */
3401 char buf2[MAX_LEN_MSG];
3403
3405 /* TRANS: appended to another sentence. Preserve the
3406 * leading space. */
3407 PL_(" The whole project will require %d bulb to complete.",
3408 " The whole project will require %d bulbs to complete.",
3409 bulbs),
3410 bulbs);
3412 /* TRANS: last %s is a sentence pluralized separately. */
3413 PL_("To research %s you need to research %d other"
3414 " technology first.%s",
3415 "To research %s you need to research %d other"
3416 " technologies first.%s",
3420 } else {
3421 CATLSTR(buf, bufsz,
3422 _("You cannot research this technology."));
3423 }
3426 CATLSTR(buf, bufsz,
3427 /* TRANS: preserve leading space */
3428 _(" This number may vary depending on what "
3429 "other players research.\n"));
3430 } else {
3431 CATLSTR(buf, bufsz, "\n");
3432 }
3433 }
3434
3435 CATLSTR(buf, bufsz, "\n");
3436 }
3437
3438 if (requirement_vector_size(&vap->research_reqs) > 0) {
3439 CATLSTR(buf, bufsz, _("Requirements to research:\n"));
3440 requirement_vector_iterate(&vap->research_reqs, preq) {
3441 (void) req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "");
3443 CATLSTR(buf, bufsz, "\n");
3444 }
3445
3447 BULLET_SPACE);
3448
3449 {
3450 int j;
3451
3452 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3453 if (game.rgame.global_init_techs[j] == A_LAST) {
3454 break;
3455 } else if (game.rgame.global_init_techs[j] == i) {
3456 CATLSTR(buf, bufsz,
3457 _("%s All players start the game with knowledge of this "
3458 "technology.\n"), BULLET);
3459 break;
3460 }
3461 }
3462 }
3463
3464 /* Assume no-one will set the same tech in both global and nation
3465 * init_tech... */
3466 nations_iterate(pnation) {
3467 int j;
3468
3469 /* Avoid mentioning nations not in current set. */
3470 if (!show_help_for_nation(pnation)) {
3471 continue;
3472 }
3473 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3474 if (pnation->init_techs[j] == A_LAST) {
3475 break;
3476 } else if (pnation->init_techs[j] == i) {
3478 /* TRANS: %s is a nation plural */
3479 _("%s The %s start the game with knowledge of this "
3480 "technology.\n"), BULLET,
3481 nation_plural_translation(pnation));
3482 break;
3483 }
3484 }
3486
3487 /* Explain the effects of root_reqs. */
3488 {
3490
3494 if (proot == vap) {
3495 /* Don't say anything at all if this tech is a self-root-req one;
3496 * assume that the ruleset help will explain how to get it. */
3498 break;
3499 }
3502 /* Now find out what roots each of this tech's root_req has, so that
3503 * we can suppress them. If tech A has roots B/C, and B has root C,
3504 * it's not worth saying that A needs C, and can lead to overwhelming
3505 * lists. */
3506 /* (Special case: don't do this if the root is a self-root-req tech,
3507 * since it would appear in its own root iteration; in the scenario
3508 * where S is a self-root tech that is root for T, this would prevent
3509 * S appearing in T's help.) */
3510 /* FIXME this is quite inefficient */
3514 }
3516
3517 /* Filter out all but the direct root reqs. */
3519
3520 if (BV_ISSET_ANY(roots)) {
3521 const char *root_techs[A_LAST];
3522 size_t n_roots = 0;
3524
3526 if (BV_ISSET(roots, root)) {
3529 }
3531 fc_assert(n_roots > 0);
3533 /* TRANS: 'and'-separated list of techs */
3534 _("%s Only those who know %s can acquire this "
3535 "technology (by any means).\n"),
3536 BULLET,
3539 }
3540 }
3541
3544 _("%s The first player to learn %s gets"
3545 " an immediate advance.\n"), BULLET,
3547 }
3548
3550 if (advance_has_flag(i, flagid)) {
3551 const char *helptxt = tech_flag_helptxt(flagid);
3552
3553 if (helptxt != NULL) {
3554 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3555 }
3556 }
3557 }
3558
3560 CATLSTR(buf, bufsz,
3561 _("%s To preserve this technology for our nation some bulbs "
3562 "are needed each turn.\n"), BULLET);
3563 }
3564
3565 if (NULL != vap->helptext) {
3566 if (strlen(buf) > 0) {
3567 CATLSTR(buf, bufsz, "\n");
3568 }
3569 strvec_iterate(vap->helptext, text) {
3570 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3572 }
3573
3574 astr_free(&astr);
3575}
3576
3577/************************************************************************/
3580void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer,
3581 const char *user_text, struct terrain *pterrain)
3582{
3583 struct universal source = {
3584 .kind = VUT_TERRAIN,
3585 .value = {.terrain = pterrain}
3586 };
3587 int flagid;
3588
3589 fc_assert_ret(NULL != buf && 0 < bufsz);
3590 buf[0] = '\0';
3591
3592 if (!pterrain) {
3593 log_error("Unknown terrain!");
3594 return;
3595 }
3596
3598 BULLET_SPACE);
3599 if (terrain_has_flag(pterrain, TER_NO_CITIES)) {
3600 CATLSTR(buf, bufsz,
3601 _("%s You cannot build cities on this terrain.\n"),
3602 BULLET);
3603 }
3605 /* Can't build roads; only mention if ruleset has buildable roads */
3607 if (pextra->buildable) {
3608 CATLSTR(buf, bufsz,
3609 _("%s Paths cannot be built on this terrain.\n"),
3610 BULLET);
3611 break;
3612 }
3614 }
3616 /* Can't build bases; only mention if ruleset has buildable bases */
3618 if (pextra->buildable) {
3619 CATLSTR(buf, bufsz,
3620 _("%s Bases cannot be built on this terrain.\n"),
3621 BULLET);
3622 break;
3623 }
3625 }
3626 if (terrain_has_flag(pterrain, TER_UNSAFE_COAST)
3627 && terrain_type_terrain_class(pterrain) != TC_OCEAN) {
3628 CATLSTR(buf, bufsz,
3629 _("%s The coastline of this terrain is unsafe.\n"),
3630 BULLET);
3631 }
3632 {
3633 const char *classes[uclass_count()];
3634 int i = 0;
3635
3636 unit_class_iterate(uclass) {
3637 if (is_native_to_class(uclass, pterrain, NULL)) {
3638 classes[i++] = uclass_name_translation(uclass);
3639 }
3641
3642 if (0 < i) {
3643 struct astring list = ASTRING_INIT;
3644
3645 /* TRANS: %s is a list of unit classes separated by "and". */
3646 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
3648 astr_free(&list);
3649 }
3650 }
3651 if (terrain_has_flag(pterrain, TER_NO_ZOC)) {
3652 CATLSTR(buf, bufsz,
3653 _("%s Units on this terrain neither impose zones of control "
3654 "nor are restricted by them.\n"), BULLET);
3655 } else {
3656 CATLSTR(buf, bufsz,
3657 _("%s Units on this terrain may impose a zone of control, or "
3658 "be restricted by one.\n"), BULLET);
3659 }
3660 for (flagid = TER_USER_1 ; flagid <= TER_USER_LAST; flagid++) {
3661 if (terrain_has_flag(pterrain, flagid)) {
3662 const char *helptxt = terrain_flag_helptxt(flagid);
3663
3664 if (helptxt != NULL) {
3665 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3666 }
3667 }
3668 }
3669
3670 if (NULL != pterrain->helptext) {
3671 if (buf[0] != '\0') {
3672 CATLSTR(buf, bufsz, "\n");
3673 }
3674 strvec_iterate(pterrain->helptext, text) {
3675 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3677 }
3678 if (user_text && user_text[0] != '\0') {
3679 CATLSTR(buf, bufsz, "\n\n%s", user_text);
3680 }
3681}
3682
3683/************************************************************************/
3690const char *helptext_road_bonus_str(const struct terrain *pterrain,
3691 const struct road_type *proad)
3692{
3693 static char str[64];
3694 bool has_effect = FALSE;
3695
3696 str[0] = '\0';
3698 switch (o) {
3699 case O_FOOD:
3700 case O_SHIELD:
3701 case O_TRADE:
3702 {
3703 int bonus = proad->tile_bonus[o];
3704 int incr = proad->tile_incr_const[o];
3705
3706 if (pterrain) {
3707 incr +=
3708 proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3709 }
3710 if (str[0] != '\0') {
3711 CATLSTR(str, sizeof(str), "/");
3712 }
3713 if (incr == 0 && bonus == 0) {
3714 cat_snprintf(str, sizeof(str), "%d", incr);
3715 } else {
3716 has_effect = TRUE;
3717 if (incr != 0) {
3718 cat_snprintf(str, sizeof(str), "%+d", incr);
3719 }
3720 if (bonus != 0) {
3721 cat_snprintf(str, sizeof(str), "%+d%%", bonus);
3722 }
3723 }
3724 }
3725 break;
3726 default:
3727 /* FIXME: there's nothing actually stopping roads having gold, etc
3728 * bonuses */
3729 fc_assert(proad->tile_incr_const[o] == 0
3730 && proad->tile_incr[o] == 0
3731 && proad->tile_bonus[o] == 0);
3732 break;
3733 }
3735
3736 return has_effect ? str : NULL;
3737}
3738
3739/**********************************************************************/
3745static void extra_bonus_for_terrain(struct extra_type *pextra,
3746 struct terrain *pterrain,
3747 int *bonus)
3748{
3749 struct universal req_pattern[] = {
3750 { .kind = VUT_EXTRA, .value.extra = pextra },
3751 { .kind = VUT_TERRAIN, .value.terrain = pterrain },
3752 { .kind = VUT_OTYPE /* value filled in later */ }
3753 };
3754
3755 fc_assert_ret(bonus != NULL);
3756
3757 /* Irrigation-like food bonuses */
3758 bonus[0] = (pterrain->irrigation_food_incr
3760 2 /* just extra+terrain */)) / 100;
3761
3762 /* Mining-like shield bonuses */
3763 bonus[1] = (pterrain->mining_shield_incr
3765 2 /* just extra+terrain */)) / 100;
3766
3767 bonus[2] = 0; /* no trade bonuses so far */
3768
3769 /* Now add fixed bonuses from roads (but not percentage bonus) */
3770 if (extra_road_get(pextra)) {
3771 const struct road_type *proad = extra_road_get(pextra);
3772
3774 switch (o) {
3775 case O_FOOD:
3776 case O_SHIELD:
3777 case O_TRADE:
3778 bonus[o] += proad->tile_incr_const[o]
3779 + proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3780 break;
3781 default:
3782 /* not dealing with other output types here */
3783 break;
3784 }
3786 }
3787
3788 /* Fixed bonuses for extra, possibly unrelated to terrain type */
3789
3791 /* Fill in rest of requirement template */
3792 req_pattern[2].value.outputtype = o;
3793 switch (o) {
3794 case O_FOOD:
3795 case O_SHIELD:
3796 case O_TRADE:
3800 /* Any of the above bonuses is sufficient to trigger
3801 * Output_Inc_Tile, if underlying terrain does not */
3802 if (bonus[o] > 0 || pterrain->output[o] > 0) {
3806 }
3807 break;
3808 default:
3809 break;
3810 }
3812}
3813
3814/**********************************************************************/
3821 struct terrain *pterrain,
3822 enum unit_activity act)
3823{
3824 static char buffer[256];
3825 int btime;
3826 int bonus[3];
3827
3828 btime = terrain_extra_build_time(pterrain, act, pextra);
3829 fc_snprintf(buffer, sizeof(buffer), PL_("%d turn", "%d turns", btime),
3830 btime);
3831 extra_bonus_for_terrain(pextra, pterrain, bonus);
3832 if (bonus[0] > 0) {
3833 cat_snprintf(buffer, sizeof(buffer),
3834 PL_(", +%d food", ", +%d food", bonus[0]), bonus[0]);
3835 }
3836 if (bonus[1] > 0) {
3837 cat_snprintf(buffer, sizeof(buffer),
3838 PL_(", +%d shield", ", +%d shields", bonus[1]), bonus[1]);
3839 }
3840 if (bonus[2] > 0) {
3841 cat_snprintf(buffer, sizeof(buffer),
3842 PL_(", +%d trade", ", +%d trade", bonus[2]), bonus[2]);
3843 }
3844
3845 return buffer;
3846}
3847
3848/************************************************************************/
3854void helptext_extra(char *buf, size_t bufsz, struct player *pplayer,
3855 const char *user_text, struct extra_type *pextra)
3856{
3857 size_t group_start;
3858 struct base_type *pbase;
3859 struct road_type *proad;
3860 struct universal source = {
3861 .kind = VUT_EXTRA,
3862 .value = {.extra = pextra}
3863 };
3864
3865 int flagid;
3866
3867 fc_assert_ret(NULL != buf && 0 < bufsz);
3868 buf[0] = '\0';
3869
3870 if (!pextra) {
3871 log_error("Unknown extra!");
3872 return;
3873 }
3874
3875 if (is_extra_caused_by(pextra, EC_BASE)) {
3876 pbase = pextra->data.base;
3877 } else {
3878 pbase = NULL;
3879 }
3880
3881 if (is_extra_caused_by(pextra, EC_ROAD)) {
3882 proad = pextra->data.road;
3883 } else {
3884 proad = NULL;
3885 }
3886
3887 if (pextra->helptext != NULL) {
3888 strvec_iterate(pextra->helptext, text) {
3889 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3891 }
3892
3893 /* Describe how extra is created and destroyed */
3894
3896
3897 if (pextra->buildable) {
3898 if (is_extra_caused_by(pextra, EC_IRRIGATION)) {
3899 CATLSTR(buf, bufsz,
3900 _("Build by issuing an \"irrigate\" order.\n"));
3901 }
3902 if (is_extra_caused_by(pextra, EC_MINE)) {
3903 CATLSTR(buf, bufsz,
3904 _("Build by issuing a \"mine\" order.\n"));
3905 }
3906 if (is_extra_caused_by(pextra, EC_ROAD)) {
3907 CATLSTR(buf, bufsz,
3908 _("Build by issuing a \"road\" order.\n"));
3909 }
3910 if (is_extra_caused_by(pextra, EC_BASE)) {
3911 fc_assert(pbase != NULL);
3912
3913 if (pbase->gui_type == BASE_GUI_OTHER) {
3915 _("Build by issuing a \"build base\" order.\n"));
3916 } else {
3917 const char *order = "";
3918
3919 switch (pbase->gui_type) {
3920 case BASE_GUI_FORTRESS:
3921 order = Q_(terrain_control.gui_type_base0);
3922 break;
3923 case BASE_GUI_AIRBASE:
3924 order = Q_(terrain_control.gui_type_base1);
3925 break;
3926 default:
3928 break;
3929 }
3931 /* TRANS: %s is a gui_type base string from a ruleset */
3932 _("Build by issuing a \"%s\" order.\n"), order);
3933 }
3934 }
3935 }
3936
3937 if (is_extra_caused_by(pextra, EC_POLLUTION)) {
3938 CATLSTR(buf, bufsz,
3939 _("May randomly appear around polluting city.\n"));
3940 }
3941
3942 if (is_extra_caused_by(pextra, EC_FALLOUT)) {
3943 CATLSTR(buf, bufsz,
3944 _("May randomly appear around nuclear blast.\n"));
3945 }
3946
3947 if (pextra->generated
3948 && (is_extra_caused_by(pextra, EC_HUT)
3950 || (proad != NULL && road_has_flag(proad, RF_RIVER)))) {
3951 CATLSTR(buf, bufsz,
3952 _("Placed by map generator.\n"));
3953 }
3954
3955 if (is_extra_removed_by(pextra, ERM_ENTER)) {
3956 CATLSTR(buf, bufsz,
3957 _("Can be explored by certain units.\n"));
3958 }
3959
3960 if (is_extra_caused_by(pextra, EC_APPEARANCE)) {
3961 CATLSTR(buf, bufsz,
3962 _("May appear spontaneously.\n"));
3963 }
3964
3965 if (requirement_vector_size(&pextra->reqs) > 0) {
3966 char reqsbuf[8192] = "";
3967 bool buildable = pextra->buildable
3969
3971 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
3973 buildable ? BULLET_SPACE : "");
3975 if (reqsbuf[0] != '\0') {
3976 if (buildable) {
3977 CATLSTR(buf, bufsz, _("Requirements to build:\n"));
3978 }
3979 CATLSTR(buf, bufsz, "%s", reqsbuf);
3980 }
3981 }
3982
3983 if (pextra->infracost > 0) {
3984 cat_snprintf(buf, bufsz, _("Cost: %d\n"), pextra->infracost);
3985 }
3986
3987 if (buf[group_start] != '\0') {
3988 CATLSTR(buf, bufsz, "\n"); /* group separator */
3989 }
3990
3992
3993 if (is_extra_removed_by(pextra, ERM_PILLAGE)) {
3994 int pillage_time = -1;
3995
3996 if (pextra->removal_time != 0) {
3997 pillage_time = pextra->removal_time;
3998 } else {
3999 terrain_type_iterate(pterrain) {
4000 int terr_pillage_time = pterrain->pillage_time
4001 * pextra->removal_time_factor;
4002
4003 if (terr_pillage_time != 0) {
4004 if (pillage_time < 0) {
4005 pillage_time = terr_pillage_time;
4006 } else if (pillage_time != terr_pillage_time) {
4007 /* Give up */
4008 pillage_time = -1;
4009 break;
4010 }
4011 }
4013 }
4014 if (pillage_time < 0) {
4015 CATLSTR(buf, bufsz,
4016 _("Can be pillaged by units (time is terrain-dependent).\n"));
4017 } else if (pillage_time > 0) {
4019 PL_("Can be pillaged by units (takes %d turn).\n",
4020 "Can be pillaged by units (takes %d turns).\n",
4021 pillage_time), pillage_time);
4022 }
4023 }
4024 if (is_extra_removed_by(pextra, ERM_CLEAN)) {
4025 int clean_time = -1;
4026
4027 if (pextra->removal_time != 0) {
4028 clean_time = pextra->removal_time;
4029 } else {
4030 terrain_type_iterate(pterrain) {
4031 int terr_clean_time = -1;
4032 int rmtime = pterrain->extra_removal_times[extra_index(pextra)];
4033
4034 if (rmtime != 0) {
4036 }
4037
4038 if (clean_time < 0) {
4040 } else if (clean_time != terr_clean_time) {
4041 /* Give up */
4042 clean_time = -1;
4043 break;
4044 }
4046 }
4047
4048 if (clean_time < 0) {
4049 CATLSTR(buf, bufsz,
4050 _("Can be cleaned by units (time is terrain-dependent).\n"));
4051 } else if (clean_time > 0) {
4053 PL_("Can be cleaned by units (takes %d turn).\n",
4054 "Can be cleaned by units (takes %d turns).\n",
4056 }
4057 }
4058
4059 if (requirement_vector_size(&pextra->rmreqs) > 0) {
4060 char reqsbuf[8192] = "";
4061
4063 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
4066 if (reqsbuf[0] != '\0') {
4067 CATLSTR(buf, bufsz, _("Requirements to remove:\n"));
4068 CATLSTR(buf, bufsz, "%s", reqsbuf);
4069 }
4070 }
4071
4072 if (buf[group_start] != '\0') {
4073 CATLSTR(buf, bufsz, "\n"); /* group separator */
4074 }
4075
4076 /* Describe what other elements are enabled by extra */
4077
4079
4081
4082 if (buf[group_start] != '\0') {
4083 CATLSTR(buf, bufsz, "\n"); /* group separator */
4084 }
4085
4086 /* Describe other properties of extras */
4087
4088 if (pextra->visibility_req != A_NONE) {
4089 char vrbuf[1024];
4090
4091 fc_snprintf(vrbuf, sizeof(vrbuf),
4092 _("%s Visible only if %s known.\n"), BULLET,
4094 CATLSTR(buf, bufsz, "%s", vrbuf);
4095 }
4096
4097 if (pextra->eus == EUS_HIDDEN) {
4098 CATLSTR(buf, bufsz,
4099 _("%s Units inside are hidden from non-allied players.\n"),
4100 BULLET);
4101 }
4102
4103 {
4104 const char *classes[uclass_count()];
4105 int i = 0;
4106
4107 unit_class_iterate(uclass) {
4108 if (is_native_extra_to_uclass(pextra, uclass)) {
4109 classes[i++] = uclass_name_translation(uclass);
4110 }
4112
4113 if (0 < i) {
4114 struct astring list = ASTRING_INIT;
4115
4116 if (proad != NULL) {
4117 /* TRANS: %s is a list of unit classes separated by "and". */
4118 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
4119 BULLET,
4121 } else {
4122 /* TRANS: %s is a list of unit classes separated by "and". */
4123 cat_snprintf(buf, bufsz, _("%s Native to %s units.\n"),
4124 BULLET,
4126 }
4127 astr_free(&list);
4128
4129 if (extra_has_flag(pextra, EF_NATIVE_TILE)) {
4130 CATLSTR(buf, bufsz,
4131 /* TRANS: indented; preserve leading spaces */
4132 _(" %s Such units can move onto this tile even if it would "
4133 "not normally be suitable terrain.\n"), BULLET);
4134 }
4135
4136 if (pextra->no_aggr_near_city >= 0) {
4137 CATLSTR(buf, bufsz,
4138 /* TRANS: indented; preserve leading spaces */
4139 PL_(" %s Such units situated here are not considered aggressive "
4140 "if this tile is within %d tile of a friendly city.\n",
4141 " %s Such units situated here are not considered aggressive "
4142 "if this tile is within %d tiles of a friendly city.\n",
4143 pextra->no_aggr_near_city),
4144 BULLET, pextra->no_aggr_near_city);
4145 }
4146
4147 if (pextra->defense_bonus) {
4149 /* TRANS: indented; preserve leading spaces */
4150 _(" %s Such units get a %d%% defense bonus on this "
4151 "tile.\n"), BULLET,
4152 pextra->defense_bonus);
4153 }
4154 }
4155 }
4156
4158 const char *conquerors[utype_count()];
4159 int i = 0;
4160
4165 }
4167
4168 if (i > 0) {
4169 struct astring list = ASTRING_INIT;
4171 /* TRANS: %s is a list of unit types separated by "and". */
4172 _("%s Can be conquered by %s.\n"), BULLET,
4174 astr_free(&list);
4175 }
4176 }
4177
4179 if (proad->move_cost == 0) {
4180 CATLSTR(buf, bufsz, _("%s Allows infinite movement.\n"), BULLET);
4181 } else {
4183 /* TRANS: "MP" = movement points. Second %s may have a
4184 * fractional part. */
4185 _("%s Movement cost along %s is %s MP.\n"),
4186 BULLET,
4187 extra_name_translation(pextra),
4188 move_points_text(proad->move_cost, TRUE));
4189 }
4190 }
4191
4192 if (game.info.killstack
4193 && extra_has_flag(pextra, EF_NO_STACK_DEATH)) {
4194 CATLSTR(buf, bufsz,
4195 _("%s Defeat of one unit does not cause death of all other units "
4196 "on this tile.\n"), BULLET);
4197 }
4198 if (pbase != NULL) {
4200 CATLSTR(buf, bufsz,
4201 _("%s Extends national borders of the building nation.\n"),
4202 BULLET);
4203 }
4204 if (pbase->vision_main_sq >= 0) {
4205 CATLSTR(buf, bufsz,
4206 _("%s Grants permanent vision of an area around the tile to "
4207 "its owner.\n"), BULLET);
4208 }
4209 if (pbase->vision_invis_sq >= 0) {
4210 CATLSTR(buf, bufsz,
4211 _("%s Allows the owner to see normally invisible stealth units "
4212 "in an area around the tile.\n"), BULLET);
4213 }
4214 if (pbase->vision_subs_sq >= 0) {
4215 CATLSTR(buf, bufsz,
4216 _("%s Allows the owner to see normally invisible subsurface units "
4217 "in an area around the tile.\n"), BULLET);
4218 }
4219 }
4221 if (extra_has_flag(pextra, flagid)) {
4222 const char *helptxt = extra_flag_helptxt(flagid);
4223
4224 if (helptxt != NULL) {
4225 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
4226 }
4227 }
4228 }
4229
4230 /* Table of terrain-specific attributes, if needed */
4231 if (proad != NULL || pbase != NULL) {
4232 bool road, do_time, do_bonus;
4233
4234 road = (proad != NULL);
4235 /* Terrain-dependent build time? */
4236 do_time = pextra->buildable && pextra->build_time == 0;
4237 if (road) {
4238 /* Terrain-dependent output bonus? */
4239 do_bonus = FALSE;
4241 if (proad->tile_incr[o] > 0) {
4242 do_bonus = TRUE;
4243 fc_assert(o == O_FOOD || o == O_SHIELD || o == O_TRADE);
4244 }
4246 } else {
4247 /* Bases don't have output bonuses */
4248 do_bonus = FALSE;
4249 }
4250
4251 if (do_time || do_bonus) {
4252 if (do_time && do_bonus) {
4253 CATLSTR(buf, bufsz,
4254 _("\nTime to build and output bonus depends on terrain:\n\n"));
4255 CATLSTR(buf, bufsz,
4256 /* TRANS: Header for fixed-width road properties table.
4257 * TRANS: Translators cannot change column widths :( */
4258 _("Terrain Time Bonus F/P/T\n"
4259 "----------------------------------\n"));
4260 } else if (do_time) {
4261 CATLSTR(buf, bufsz,
4262 _("\nTime to build depends on terrain:\n\n"));
4263 CATLSTR(buf, bufsz,
4264 /* TRANS: Header for fixed-width extra properties table.
4265 * TRANS: Translators cannot change column widths :( */
4266 _("Terrain Time\n"
4267 "------------------\n"));
4268 } else {
4270 CATLSTR(buf, bufsz,
4271 /* TRANS: Header for fixed-width road properties table.
4272 * TRANS: Translators cannot change column widths :( */
4273 _("\nYields an output bonus with some terrains:\n\n"));
4274 CATLSTR(buf, bufsz,
4275 _("Terrain Bonus F/P/T\n"
4276 "-------------------------\n"));;
4277 }
4279 int turns = road ? terrain_extra_build_time(t, ACTIVITY_GEN_ROAD, pextra)
4281 const char *bonus_text
4283 if (turns > 0 || bonus_text) {
4284 const char *terrain = terrain_name_translation(t);
4286
4288 "%s%*s ", terrain,
4289 MAX(0, slen),
4290 "");
4291 if (do_time) {
4292 if (turns > 0) {
4293 cat_snprintf(buf, bufsz, "%3d ", turns);
4294 } else {
4295 CATLSTR(buf, bufsz, " - ");
4296 }
4297 }
4298 if (do_bonus) {
4299 fc_assert(proad != NULL);
4300 cat_snprintf(buf, bufsz, " %s", bonus_text ? bonus_text : "-");
4301 }
4302 CATLSTR(buf, bufsz, "\n");
4303 }
4305 } /* else rely on client-specific display */
4306 }
4307
4308 if (user_text && user_text[0] != '\0') {
4309 CATLSTR(buf, bufsz, "\n\n%s", user_text);
4310 }
4311}
4312
4313/************************************************************************/
4319void helptext_goods(char *buf, size_t bufsz, struct player *pplayer,
4320 const char *user_text, struct goods_type *pgood)
4321{
4322 bool reqs = FALSE;
4323
4324 fc_assert_ret(NULL != buf && 0 < bufsz);
4325 buf[0] = '\0';
4326
4327 if (NULL != pgood->helptext) {
4328 strvec_iterate(pgood->helptext, text) {
4329 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4331 }
4332
4333 if (pgood->onetime_pct == 0) {
4335 _("There's no bonuses paid when trade route gets established.\n\n"));
4336 } else if (pgood->onetime_pct != 100) {
4338 _("When trade route gets established, %d%% of the normal bonus is paid.\n"),
4339 pgood->onetime_pct);
4340 }
4341 cat_snprintf(buf, bufsz, _("Sending city enjoys %d%% income from the route.\n"),
4342 pgood->from_pct);
4343 cat_snprintf(buf, bufsz, _("Receiving city enjoys %d%% income from the route.\n\n"),
4344 pgood->to_pct);
4345
4346 /* Requirements for this good. */
4348 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4349 reqs = TRUE;
4350 }
4352 if (reqs) {
4353 fc_strlcat(buf, "\n", bufsz);
4354 }
4355
4356 CATLSTR(buf, bufsz, "%s", user_text);
4357}
4358
4359/************************************************************************/
4365void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer,
4366 const char *user_text, struct specialist *pspec)
4367{
4368 bool reqs = FALSE;
4369
4370 fc_assert_ret(NULL != buf && 0 < bufsz);
4371 buf[0] = '\0';
4372
4373 if (NULL != pspec->helptext) {
4374 strvec_iterate(pspec->helptext, text) {
4375 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4377 }
4378
4379 /* Requirements for this specialist. */
4381 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4382 reqs = TRUE;
4383 }
4385 if (reqs) {
4386 fc_strlcat(buf, "\n", bufsz);
4387 }
4388
4389 CATLSTR(buf, bufsz, "%s", user_text);
4390}
4391
4392/************************************************************************/
4400void helptext_government(char *buf, size_t bufsz, struct player *pplayer,
4401 const char *user_text, struct government *gov)
4402{
4403 bool reqs = FALSE;
4404 struct universal source = {
4406 .value = {.govern = gov}
4407 };
4408
4409 fc_assert_ret(NULL != buf && 0 < bufsz);
4410 buf[0] = '\0';
4411
4412 if (NULL != gov->helptext) {
4413 strvec_iterate(gov->helptext, text) {
4414 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4416 }
4417
4418 /* Add requirement text for government itself */
4420 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4421 reqs = TRUE;
4422 }
4424 if (reqs) {
4425 fc_strlcat(buf, "\n", bufsz);
4426 }
4427
4428 /* Effects */
4429 CATLSTR(buf, bufsz, _("Features:\n"));
4431 BULLET_SPACE);
4434 struct unit_class *unitclass = NULL;
4435 const struct unit_type *unittype = NULL;
4437 struct strvec *outputs = strvec_new();
4440 bool too_complex = FALSE;
4441 bool world_value_valid = TRUE;
4442
4443 /* Grab output type, if there is one */
4445 /* Treat an effect with any negated requirements as too complex for
4446 * us to explain here.
4447 * Also don't try to explain an effect with any requirements explicitly
4448 * marked as 'quiet' by ruleset author. */
4449 if (!preq->present || preq->quiet) {
4450 too_complex = TRUE;
4451 continue;
4452 }
4453 switch (preq->source.kind) {
4454 case VUT_OTYPE:
4455 /* We should never have multiple outputtype requirements
4456 * in one list in the first place (it simply makes no sense,
4457 * output cannot be of multiple types)
4458 * Ruleset loading code should check against that. */
4460 output_type = preq->source.value.outputtype;
4462 break;
4463 case VUT_UCLASS:
4465 unitclass = preq->source.value.uclass;
4466 /* FIXME: can't easily get world bonus for unit class */
4468 break;
4469 case VUT_UTYPE:
4470 fc_assert(unittype == NULL);
4471 unittype = preq->source.value.utype;
4472 break;
4473 case VUT_UTFLAG:
4474 if (!unit_type_flag_id_is_valid(unitflag)) {
4475 unitflag = preq->source.value.unitflag;
4476 /* FIXME: can't easily get world bonus for unit type flag */
4478 } else {
4479 /* Already have a unit flag requirement. More than one is too
4480 * complex for us to explain, so say nothing. */
4481 /* FIXME: we could handle this */
4482 too_complex = TRUE;
4483 }
4484 break;
4485 case VUT_GOVERNMENT:
4486 /* This is government we are generating helptext for.
4487 * ...or if not, it's ruleset bug that should never make it
4488 * this far. Fix ruleset loading code. */
4489 fc_assert(preq->source.value.govern == gov);
4490 break;
4491 default:
4492 too_complex = TRUE;
4494 break;
4495 };
4497
4498 if (!too_complex) {
4499 /* Only list effects that don't have extra requirements too complex
4500 * for us to handle.
4501 * Anything more complicated will have to be documented by hand by the
4502 * ruleset author. */
4503
4504 /* Guard condition for simple player-wide effects descriptions.
4505 * (FIXME: in many cases, e.g. EFT_MAKE_CONTENT, additional requirements
4506 * like unittype will be ignored for gameplay, but will affect our
4507 * help here.) */
4508 const bool playerwide
4509 = world_value_valid && !unittype && (output_type == O_LAST);
4510 /* In some cases we give absolute values (world bonus + gov bonus).
4511 * We assume the fact that there's an effect with a gov requirement
4512 * is sufficient reason to list it in that gov's help.
4513 * Guard accesses to these with 'playerwide' or 'world_value_valid'. */
4514 int world_value = -999, net_value = -999;
4515 if (world_value_valid) {
4516 /* Get government-independent world value of effect if the extra
4517 * requirements were simple enough. */
4518 struct output_type *potype =
4520
4521 world_value =
4523 &(const struct req_context) {
4524 .unittype = unittype,
4525 .output = potype,
4526 },
4527 NULL,
4528 peffect->type);
4529 net_value = peffect->value + world_value;
4530 }
4531
4532 if (output_type == O_LAST) {
4533 /* There was no outputtype requirement. Effect is active for all
4534 * output types. Generate lists for that. */
4535 bool harvested_only = TRUE; /* Consider only output types from fields */
4536
4537 if (peffect->type == EFT_UPKEEP_FACTOR
4539 || peffect->type == EFT_OUTPUT_BONUS
4540 || peffect->type == EFT_OUTPUT_BONUS_2) {
4541 /* Effect can use or require any kind of output */
4543 }
4544
4546 struct output_type *pot = get_output_type(ot);
4547
4548 if (!harvested_only || pot->harvested) {
4549 strvec_append(outputs, _(pot->name));
4550 }
4552 }
4553
4554 if (0 == strvec_size(outputs)) {
4555 /* TRANS: Empty output type list, should never happen. */
4556 astr_set(&outputs_or, "%s", Q_("?outputlist: Nothing "));
4557 astr_set(&outputs_and, "%s", Q_("?outputlist: Nothing "));
4558 } else {
4561 }
4562
4563 switch (peffect->type) {
4564 case EFT_UNHAPPY_FACTOR:
4565 if (playerwide) {
4566 /* FIXME: EFT_MAKE_CONTENT_MIL_PER would cancel this out. We assume
4567 * no-one will set both, so we don't bother handling it. */
4569 PL_("%s Military units away from home and field units"
4570 " will each cause %d citizen to become unhappy.\n",
4571 "%s Military units away from home and field units"
4572 " will each cause %d citizens to become unhappy.\n",
4573 net_value),
4574 BULLET, net_value);
4575 } /* else too complicated or silly ruleset */
4576 break;
4578 if (playerwide && net_value != world_value) {
4579 if (world_value > 0) {
4580 if (net_value > 0) {
4582 _("%s Unhappiness from foreign citizens due to "
4583 "war with their home state is %d%% the usual "
4584 "value.\n"), BULLET,
4585 (net_value * 100) / world_value);
4586 } else {
4587 CATLSTR(buf, bufsz,
4588 _("%s No unhappiness from foreign citizens even when "
4589 "at war with their home state.\n"), BULLET);
4590 }
4591 } else {
4593 /* TRANS: not pluralised as gettext doesn't support
4594 * fractional numbers, which this might be */
4595 _("%s Each foreign citizen causes %.2g unhappiness "
4596 "in their city while you are at war with their "
4597 "home state.\n"), BULLET,
4598 (double)net_value / 100);
4599 }
4600 }
4601 break;
4603 if (playerwide) {
4605 PL_("%s Each of your cities will avoid %d unhappiness"
4606 " caused by units.\n",
4607 "%s Each of your cities will avoid %d unhappiness"
4608 " caused by units.\n",
4609 peffect->value),
4610 BULLET, peffect->value);
4611 }
4612 break;
4613 case EFT_MAKE_CONTENT:
4614 if (playerwide) {
4616 PL_("%s Each of your cities will avoid %d unhappiness,"
4617 " not including that caused by aggression.\n",
4618 "%s Each of your cities will avoid %d unhappiness,"
4619 " not including that caused by aggression.\n",
4620 peffect->value),
4621 BULLET, peffect->value);
4622 }
4623 break;
4624 case EFT_FORCE_CONTENT:
4625 if (playerwide) {
4627 PL_("%s Each of your cities will avoid %d unhappiness,"
4628 " including that caused by aggression.\n",
4629 "%s Each of your cities will avoid %d unhappiness,"
4630 " including that caused by aggression.\n",
4631 peffect->value),
4632 BULLET, peffect->value);
4633 }
4634 break;
4635 case EFT_UPKEEP_FACTOR:
4636 if (world_value_valid && !unittype) {
4637 if (net_value == 0) {
4638 if (output_type != O_LAST) {
4640 /* TRANS: %s is the output type, like 'shield'
4641 * or 'gold'. */
4642 _("%s You pay no %s upkeep for your units.\n"),
4644 } else {
4645 CATLSTR(buf, bufsz,
4646 _("%s You pay no upkeep for your units.\n"),
4647 BULLET);
4648 }
4649 } else if (net_value != world_value) {
4650 double ratio = (double)net_value / world_value;
4651 if (output_type != O_LAST) {
4653 /* TRANS: %s is the output type, like 'shield'
4654 * or 'gold'. */
4655 _("%s You pay %.2g times normal %s upkeep for your "
4656 "units.\n"), BULLET,
4658 } else {
4660 _("%s You pay %.2g times normal upkeep for your "
4661 "units.\n"), BULLET,
4662 ratio);
4663 }
4664 } /* else this effect somehow has no effect; keep quiet */
4665 } /* else there was some extra condition making it complicated */
4666 break;
4668 if (!unittype) {
4669 if (output_type != O_LAST) {
4671 /* TRANS: %s is the output type, like 'shield' or
4672 * 'gold'; pluralised in %d but there is currently
4673 * no way to control the singular/plural name of the
4674 * output type; sorry */
4675 PL_("%s Each of your cities will avoid paying %d %s"
4676 " upkeep for your units.\n",
4677 "%s Each of your cities will avoid paying %d %s"
4678 " upkeep for your units.\n", peffect->value),
4679 BULLET,
4680 peffect->value, astr_str(&outputs_and));
4681 } else {
4683 /* TRANS: Amount is subtracted from upkeep cost
4684 * for each upkeep type. */
4685 PL_("%s Each of your cities will avoid paying %d"
4686 " upkeep for your units.\n",
4687 "%s Each of your cities will avoid paying %d"
4688 " upkeep for your units.\n", peffect->value),
4689 BULLET, peffect->value);
4690 }
4691 } /* else too complicated */
4692 break;
4694 if (playerwide) {
4696 _("%s If you lose your capital,"
4697 " the base chance of civil war is %d%%.\n"),
4698 BULLET, net_value);
4699 }
4700 break;
4702 if (playerwide) {
4704 PL_("%s You can have %d city before an "
4705 "additional unhappy citizen appears in each city "
4706 "due to civilization size.\n",
4707 "%s You can have up to %d cities before an "
4708 "additional unhappy citizen appears in each city "
4709 "due to civilization size.\n", net_value),
4710 BULLET, net_value);
4711 }
4712 break;
4714 if (playerwide) {
4716 PL_("%s After the first unhappy citizen due to"
4717 " civilization size, for each %d additional city"
4718 " another unhappy citizen will appear.\n",
4719 "%s After the first unhappy citizen due to"
4720 " civilization size, for each %d additional cities"
4721 " another unhappy citizen will appear.\n",
4722 net_value),
4723 BULLET, net_value);
4724 }
4725 break;
4726 case EFT_MAX_RATES:
4728 if (net_value < 100) {
4730 _("%s The maximum rate you can set for science,"
4731 " gold, or luxuries is %d%%.\n"),
4732 BULLET, net_value);
4733 } else {
4734 CATLSTR(buf, bufsz,
4735 _("%s Has unlimited science/gold/luxuries rates.\n"),
4736 BULLET);
4737 }
4738 }
4739 break;
4741 if (playerwide) {
4743 PL_("%s Your units may impose martial law."
4744 " Each military unit inside a city will force %d"
4745 " unhappy citizen to become content.\n",
4746 "%s Your units may impose martial law."
4747 " Each military unit inside a city will force %d"
4748 " unhappy citizens to become content.\n",
4749 peffect->value),
4750 BULLET, peffect->value);
4751 }
4752 break;
4754 if (playerwide && net_value < 100) {
4756 PL_("%s A maximum of %d unit in each city can enforce"
4757 " martial law.\n",
4758 "%s A maximum of %d units in each city can enforce"
4759 " martial law.\n",
4760 net_value),
4761 BULLET, net_value);
4762 }
4763 break;
4764 case EFT_RAPTURE_GROW:
4765 if (playerwide && net_value > 0) {
4767 _("%s You may grow your cities by means of "
4768 "celebrations."), BULLET);
4769 if (game.info.celebratesize > 1) {
4771 /* TRANS: Preserve leading space. %d should always be
4772 * 2 or greater. */
4773 _(" (Cities below size %d cannot grow in this way.)"),
4775 }
4776 cat_snprintf(buf, bufsz, "\n");
4777 }
4778 break;
4780 if (playerwide) {
4782 PL_("%s If a city is in disorder for more than %d turn "
4783 "in a row, government will fall into anarchy.\n",
4784 "%s If a city is in disorder for more than %d turns "
4785 "in a row, government will fall into anarchy.\n",
4786 net_value),
4787 BULLET, net_value);
4788 }
4789 break;
4790 case EFT_HAS_SENATE:
4791 if (playerwide && net_value > 0) {
4792 CATLSTR(buf, bufsz,
4793 _("%s Has a senate that may prevent declaration of war.\n"),
4794 BULLET);
4795 }
4796 break;
4798 if (playerwide && net_value > 0) {
4799 CATLSTR(buf, bufsz,
4800 _("%s Allows partisans when cities are taken by the "
4801 "enemy.\n"), BULLET);
4802 }
4803 break;
4805 if (playerwide && net_value > 0) {
4806 CATLSTR(buf, bufsz,
4807 _("%s Buildings that normally confer bonuses against"
4808 " unhappiness will instead give gold.\n"), BULLET);
4809 }
4810 break;
4811 case EFT_FANATICS:
4812 if (playerwide && net_value > 0) {
4813 struct strvec *fanatics = strvec_new();
4815
4819 }
4822 /* TRANS: %s is list of unit types separated by 'or' */
4823 _("%s Pays no upkeep for %s.\n"), BULLET,
4827 }
4828 break;
4829 case EFT_NO_UNHAPPY:
4830 if (playerwide && net_value > 0) {
4831 CATLSTR(buf, bufsz, _("%s Has no unhappy citizens.\n"), BULLET);
4832 }
4833 break;
4834 case EFT_VETERAN_BUILD:
4835 {
4836 int conditions = 0;
4837 if (unitclass) {
4838 conditions++;
4839 }
4840 if (unittype) {
4841 conditions++;
4842 }
4843 if (unit_type_flag_id_is_valid(unitflag)) {
4844 conditions++;
4845 }
4846 if (conditions > 1) {
4847 /* More than one requirement on units, too complicated for us
4848 * to describe. */
4849 break;
4850 }
4851 if (unitclass) {
4852 /* FIXME: account for multiple veteran levels, or negative
4853 * values. This might lie for complicated rulesets! */
4855 /* TRANS: %s is a unit class */
4856 Q_("?unitclass:* New %s units will be veteran.\n"),
4858 } else if (unit_type_flag_id_is_valid(unitflag)) {
4859 /* FIXME: same problems as unitclass */
4861 /* TRANS: %s is a (translatable) unit type flag */
4862 Q_("?unitflag:* New %s units will be veteran.\n"),
4864 } else if (unittype != NULL) {
4865 if (world_value_valid && net_value > 0) {
4866 /* Here we can be specific about veteran level, and get
4867 * net value correct. */
4868 int maxlvl = utype_veteran_system(unittype)->levels - 1;
4869 const struct veteran_level *vlevel =
4872 /* TRANS: "* New Partisan units will have the rank
4873 * of elite." */
4874 Q_("?unittype:%s New %s units will have the rank "
4875 "of %s.\n"), BULLET,
4876 utype_name_translation(unittype),
4878 } /* else complicated */
4879 } else {
4880 /* No extra criteria. */
4881 /* FIXME: same problems as above */
4883 _("%s New units will be veteran.\n"), BULLET);
4884 }
4885 }
4886 break;
4888 if (world_value_valid) {
4890 /* TRANS: %s is list of output types, with 'or';
4891 * pluralised in %d but of course the output types
4892 * can't be pluralised; sorry */
4893 PL_("%s Each worked tile that gives more than %d %s will"
4894 " suffer a -1 penalty, unless the city working it"
4895 " is celebrating.",
4896 "%s Each worked tile that gives more than %d %s will"
4897 " suffer a -1 penalty, unless the city working it"
4898 " is celebrating.", net_value),
4900 if (game.info.celebratesize > 1) {
4902 /* TRANS: Preserve leading space. %d should always be
4903 * 2 or greater. */
4904 _(" (Cities below size %d will not celebrate.)"),
4906 }
4907 cat_snprintf(buf, bufsz, "\n");
4908 }
4909 break;
4912 /* TRANS: %s is list of output types, with 'or' */
4913 PL_("%s Each worked tile with at least 1 %s will yield"
4914 " %d more of it while the city working it is"
4915 " celebrating.",
4916 "%s Each worked tile with at least 1 %s will yield"
4917 " %d more of it while the city working it is"
4918 " celebrating.", peffect->value),
4919 BULLET, astr_str(&outputs_or), peffect->value);
4920 if (game.info.celebratesize > 1) {
4922 /* TRANS: Preserve leading space. %d should always be
4923 * 2 or greater. */
4924 _(" (Cities below size %d will not celebrate.)"),
4926 }
4927 cat_snprintf(buf, bufsz, "\n");
4928 break;
4931 /* TRANS: %s is list of output types, with 'or' */
4932 PL_("%s Each worked tile with at least 1 %s will yield"
4933 " %d more of it.\n",
4934 "%s Each worked tile with at least 1 %s will yield"
4935 " %d more of it.\n", peffect->value),
4936 BULLET, astr_str(&outputs_or), peffect->value);
4937 break;
4938 case EFT_OUTPUT_BONUS:
4939 case EFT_OUTPUT_BONUS_2:
4940 /* FIXME: makes most sense iff world_value == 0 */
4942 /* TRANS: %s is list of output types, with 'and' */
4943 _("%s %s production is increased %d%%.\n"),
4944 BULLET, astr_str(&outputs_and), peffect->value);
4945 break;
4946 case EFT_OUTPUT_WASTE:
4947 if (world_value_valid) {
4948 if (net_value > 30) {
4950 /* TRANS: %s is list of output types, with 'and' */
4951 _("%s %s production will suffer massive losses.\n"),
4953 } else if (net_value >= 15) {
4955 /* TRANS: %s is list of output types, with 'and' */
4956 _("%s %s production will suffer some losses.\n"),
4958 } else if (net_value > 0) {
4960 /* TRANS: %s is list of output types, with 'and' */
4961 _("%s %s production will suffer a small amount "
4962 "of losses.\n"),
4964 }
4965 }
4966 break;
4967 case EFT_HEALTH_PCT:
4968 if (playerwide) {
4969 if (peffect->value > 0) {
4970 CATLSTR(buf, bufsz, _("%s Increases the chance of plague"
4971 " within your cities.\n"), BULLET);
4972 } else if (peffect->value < 0) {
4973 CATLSTR(buf, bufsz, _("%s Decreases the chance of plague"
4974 " within your cities.\n"), BULLET);
4975 }
4976 }
4977 break;
4979 /* Semi-arbitrary scaling to get likely ruleset values in roughly
4980 * the same range as WASTE_BY_DISTANCE */
4981 /* FIXME: use different wording? */
4982 net_value = (net_value + 39) / 40; /* round up */
4983 fc__fallthrough; /* fall through to: */
4985 if (world_value_valid) {
4986 if (net_value >= 300) {
4988 /* TRANS: %s is list of output types, with 'and' */
4989 _("%s %s losses will increase quickly"
4990 " with distance from capital.\n"),
4992 } else if (net_value >= 200) {
4994 /* TRANS: %s is list of output types, with 'and' */
4995 _("%s %s losses will increase"
4996 " with distance from capital.\n"),
4998 } else if (net_value > 0) {
5000 /* TRANS: %s is list of output types, with 'and' */
5001 _("%s %s losses will increase slowly"
5002 " with distance from capital.\n"),
5004 }
5005 }
5006 break;
5007 case EFT_MIGRATION_PCT:
5008 if (playerwide) {
5009 if (peffect->value > 0) {
5010 CATLSTR(buf, bufsz, _("%s Increases the chance of migration"
5011 " into your cities.\n"), BULLET);
5012 } else if (peffect->value < 0) {
5013 CATLSTR(buf, bufsz, _("%s Decreases the chance of migration"
5014 " into your cities.\n"), BULLET);
5015 }
5016 }
5017 break;
5018 case EFT_BORDER_VISION:
5020 && playerwide && net_value > 0) {
5021 CATLSTR(buf, bufsz, _("%s All tiles inside your borders are"
5022 " monitored.\n"), BULLET);
5023 }
5024 break;
5025 default:
5026 break;
5027 };
5028 }
5029
5033
5035
5036 /* Action immunity */
5037 action_iterate(act) {
5038 if (action_by_number(act)->quiet) {
5039 /* The ruleset documents this action it self. */
5040 continue;
5041 }
5042
5043 if (action_immune_government(gov, act)) {
5045 /* TRANS: action name ... action target
5046 * ("individual units", etc) */
5047 _("%s Makes it impossible to do the action \'%s\'"
5048 " to your %s.\n"), BULLET,
5051 }
5053
5054 if (user_text && user_text[0] != '\0') {
5055 cat_snprintf(buf, bufsz, "\n%s", user_text);
5056 }
5057}
5058
5059/************************************************************************/
5062char *helptext_unit_upkeep_str(const struct unit_type *utype)
5063{
5064 static char buf[128];
5065 int any = 0;
5066
5067 if (!utype) {
5068 log_error("Unknown unit!");
5069 return "";
5070 }
5071
5072 buf[0] = '\0';
5074 if (utype->upkeep[o] > 0) {
5075 /* TRANS: "2 Food" or ", 1 Shield" */
5076 cat_snprintf(buf, sizeof(buf), _("%s%d %s"),
5077 (any > 0 ? Q_("?blistmore:, ") : ""), utype->upkeep[o],
5079 any++;
5080 }
5082 if (utype->happy_cost > 0) {
5083 /* TRANS: "2 Unhappy" or ", 1 Unhappy" */
5084 cat_snprintf(buf, sizeof(buf), _("%s%d Unhappy"),
5085 (any > 0 ? Q_("?blistmore:, ") : ""), utype->happy_cost);
5086 any++;
5087 }
5088
5089 if (any == 0) {
5090 /* strcpy(buf, _("None")); */
5091 fc_snprintf(buf, sizeof(buf), "%d", 0);
5092 }
5093 return buf;
5094}
5095
5096/************************************************************************/
5099void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation,
5100 const char *user_text)
5101{
5102 struct universal source = {
5103 .kind = VUT_NATION,
5104 .value = {.nation = pnation}
5105 };
5106 bool print_break = TRUE;
5107
5108#define PRINT_BREAK() do { \
5109 if (print_break) { \
5110 if (buf[0] != '\0') { \
5111 CATLSTR(buf, bufsz, "\n\n"); \
5112 } \
5113 print_break = FALSE; \
5114 } \
5115 } while (FALSE)
5116
5117 fc_assert_ret(NULL != buf && 0 < bufsz);
5118 buf[0] = '\0';
5119
5120 if (pnation->legend[0] != '\0') {
5121 /* Client side legend is stored already translated */
5122 cat_snprintf(buf, bufsz, "%s", pnation->legend);
5123 }
5124
5125 if (pnation->init_government) {
5126 PRINT_BREAK();
5128 _("Initial government is %s.\n"),
5130 }
5131 if (pnation->init_techs[0] != A_LAST) {
5132 const char *tech_names[MAX_NUM_TECH_LIST];
5133 int i;
5134 struct astring list = ASTRING_INIT;
5135
5136 for (i = 0; i < MAX_NUM_TECH_LIST; i++) {
5137 if (pnation->init_techs[i] == A_LAST) {
5138 break;
5139 }
5140 tech_names[i] =
5142 }
5144 PRINT_BREAK();
5145 if (game.rgame.global_init_techs[0] != A_LAST) {
5147 /* TRANS: %s is an and-separated list of techs */
5148 _("Starts with knowledge of %s in addition to the standard "
5149 "starting technologies.\n"), astr_str(&list));
5150 } else {
5152 /* TRANS: %s is an and-separated list of techs */
5153 _("Starts with knowledge of %s.\n"), astr_str(&list));
5154 }
5155 astr_free(&list);
5156 }
5157 if (pnation->init_units[0]) {
5158 const struct unit_type *utypes[MAX_NUM_UNIT_LIST];
5159 int count[MAX_NUM_UNIT_LIST];
5160 int i, j, n = 0, total = 0;
5161
5162 /* Count how many of each type there is. */
5163 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
5164 if (!pnation->init_units[i]) {
5165 break;
5166 }
5167 for (j = 0; j < n; j++) {
5168 if (pnation->init_units[i] == utypes[j]) {
5169 count[j]++;
5170 total++;
5171 break;
5172 }
5173 }
5174 if (j == n) {
5175 utypes[n] = pnation->init_units[i];
5176 count[n] = 1;
5177 total++;
5178 n++;
5179 }
5180 }
5181 {
5182 /* Construct the list of unit types and counts. */
5184 struct astring list = ASTRING_INIT;
5185
5186 for (i = 0; i < n; i++) {
5188 if (count[i] > 1) {
5189 /* TRANS: a unit type followed by a count. For instance,
5190 * "Fighter (2)" means two Fighters. Count is never 1.
5191 * Used in a list. */
5192 astr_set(&utype_names[i], _("%s (%d)"),
5193 utype_name_translation(utypes[i]), count[i]);
5194 } else {
5196 }
5197 }
5198 {
5200
5201 for (i = 0; i < n; i++) {
5203 }
5205 }
5206 for (i = 0; i < n; i++) {
5208 }
5209 PRINT_BREAK();
5211 /* TRANS: %s is an and-separated list of unit types
5212 * possibly with counts. Plurality is in total number of
5213 * units represented. */
5214 PL_("Starts with the following additional unit: %s.\n",
5215 "Starts with the following additional units: %s.\n",
5216 total), astr_str(&list));
5217 astr_free(&list);
5218 }
5219 }
5220 if (pnation->init_buildings[0] != B_LAST) {
5221 const char *impr_names[MAX_NUM_BUILDING_LIST];
5222 int i;
5223 struct astring list = ASTRING_INIT;
5224
5225 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
5226 if (pnation->init_buildings[i] == B_LAST) {
5227 break;
5228 }
5229 impr_names[i] =
5232 }
5234 PRINT_BREAK();
5237 /* TRANS: %s is an and-separated list of improvements */
5238 _("First city will get %s for free in addition to the "
5239 "standard improvements.\n"), astr_str(&list));
5240 } else {
5242 /* TRANS: %s is an and-separated list of improvements */
5243 _("First city will get %s for free.\n"), astr_str(&list));
5244 }
5245 astr_free(&list);
5246 }
5247
5248 if (buf[0] != '\0') {
5249 CATLSTR(buf, bufsz, "\n");
5250 }
5252
5253 if (user_text && user_text[0] != '\0') {
5254 if (buf[0] != '\0') {
5255 CATLSTR(buf, bufsz, "\n");
5256 }
5257 CATLSTR(buf, bufsz, "%s", user_text);
5258 }
5259#undef PRINT_BREAK
5260}
5261
5262/************************************************************************/
5266{
5267 if (req == NULL) {
5268 return HELP_LAST;
5269 }
5270
5271 if (req->source.kind == VUT_UTYPE) {
5272 return HELP_UNIT;
5273 }
5274 if (req->source.kind == VUT_IMPROVEMENT) {
5276 return HELP_WONDER;
5277 }
5278 return HELP_IMPROVEMENT;
5279 }
5280 if (req->source.kind == VUT_ADVANCE) {
5281 return HELP_TECH;
5282 }
5283 if (req->source.kind == VUT_TERRAIN) {
5284 return HELP_TERRAIN;
5285 }
5286 if (req->source.kind == VUT_EXTRA) {
5287 return HELP_EXTRA;
5288 }
5289 if (req->source.kind == VUT_GOOD) {
5290 return HELP_GOODS;
5291 }
5292 if (req->source.kind == VUT_SPECIALIST) {
5293 return HELP_SPECIALIST;
5294 }
5295 if (req->source.kind == VUT_GOVERNMENT) {
5296 return HELP_GOVERNMENT;
5297 }
5298
5299 if (req->source.kind == VUT_NATION) {
5300 return HELP_NATIONS;
5301 }
5302
5303 return HELP_LAST;
5304}
const char * action_name_translation(const struct action *action)
Definition actions.c:1991
enum action_actor_kind action_get_actor_kind(const struct action *paction)
Definition actions.c:1859
const char * action_id_name_translation(action_id act_id)
Definition actions.c:2011
void action_array_add_all_by_result(action_id *act_array, int *position, enum action_result result)
Definition actions.c:6486
void action_array_end(action_id *act_array, int size)
Definition actions.c:6469
bool action_is_in_use(struct action *paction)
Definition actions.c:6398
enum action_sub_target_kind action_get_sub_target_kind(const struct action *paction)
Definition actions.c:1880
bool action_would_be_blocked_by(const struct action *blocked, const struct action *blocker)
Definition actions.c:1957
bool action_immune_government(struct government *gov, action_id act)
Definition actions.c:6173
int action_dice_roll_initial_odds(const struct action *paction)
Definition actions.c:6097
const char * action_target_kind_help(enum action_target_kind kind)
Definition actions.c:8125
enum action_target_kind action_get_target_kind(const struct action *paction)
Definition actions.c:1869
struct action_enabler_list * action_enablers_for_action(action_id action)
Definition actions.c:2315
#define action_id_univs_not_blocking(act_id, act_uni, tgt_uni)
Definition actions.h:945
#define action_auto_perf_iterate_end
Definition actions.h:586
static struct action * action_by_number(action_id act_id)
Definition actions.h:635
#define action_array_iterate(_act_array_, _act_id_)
Definition actions.h:497
#define action_has_result(_act_, _res_)
Definition actions.h:431
#define action_enabler_list_iterate_end
Definition actions.h:441
#define action_id_get_role(act_id)
Definition actions.h:696
#define ACTION_DISTANCE_UNLIMITED
Definition actions.h:357
#define action_array_iterate_end
Definition actions.h:509
#define action_iterate_end
Definition actions.h:465
#define MAX_NUM_ACTIONS
Definition actions.h:314
#define action_enabler_list_iterate(action_enabler_list, aenabler)
Definition actions.h:439
#define action_iterate(_act_)
Definition actions.h:461
#define action_id_get_target_kind(act_id)
Definition actions.h:652
#define action_auto_perf_iterate(_act_perf_)
Definition actions.h:574
#define ACTION_ODDS_PCT_DICE_ROLL_NA
Definition actions.h:929
bool actres_removes_extra(enum action_result result, const struct extra_type *pextra)
Definition actres.c:803
bool actres_creates_extra(enum action_result result, const struct extra_type *pextra)
Definition actres.c:782
enum action_battle_kind actres_get_battle_kind(enum action_result result)
Definition actres.c:269
void astr_free(struct astring *astr)
Definition astring.c:153
const char * astr_build_or_list(struct astring *astr, const char *const *items, size_t number)
Definition astring.c:329
void astr_set(struct astring *astr, const char *format,...)
Definition astring.c:267
const char * astr_build_and_list(struct astring *astr, const char *const *items, size_t number)
Definition astring.c:367
void astr_init(struct astring *astr)
Definition astring.c:144
#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:158
#define BV_CLR_ALL_FROM(vec_to, vec_from)
Definition bitvector.h:127
#define BV_CLR_ALL(bv)
Definition bitvector.h:95
#define BV_SET(bv, bit)
Definition bitvector.h:81
#define BV_ARE_EQUAL(vec1, vec2)
Definition bitvector.h:113
#define BV_ISSET(bv, bit)
Definition bitvector.h:78
#define BV_ISSET_ANY(vec)
Definition bitvector.h:109
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:845
#define output_type_iterate_end
Definition city.h:851
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:1508
static struct fc_sockaddr_list * list
Definition clinet.c:102
char * utypes
Definition comments.c:35
char * incite_cost
Definition comments.c:75
#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:2919
bool effect_universals_value_never_below(enum effect_type type, struct universal *unis, size_t n_unis, int min_value)
Definition effects.c:545
struct @21::@22 reqs
int get_target_bonus_effects(struct effect_list *plist, const struct req_context *context, const struct player *other_player, enum effect_type effect_type)
Definition effects.c:748
int effect_value_from_universals(enum effect_type type, struct universal *unis, size_t n_unis)
Definition effects.c:459
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:644
#define effect_list_iterate_end
Definition effects.h:406
#define effect_list_iterate(effect_list, peffect)
Definition effects.h:404
const char * extra_flag_helptxt(enum extra_flag_id id)
Definition extras.c:974
bool is_extra_caused_by_worker_action(const struct extra_type *pextra)
Definition extras.c:1032
bool extra_has_flag(const struct extra_type *pextra, enum extra_flag_id flag)
Definition extras.c:861
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:843
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:376
int Unit_Class_id
Definition fc_types.h:418
int action_id
Definition fc_types.h:389
#define CASUS_BELLI_OUTRAGE
Definition fc_types.h:484
#define CASUS_BELLI_VICTIM
Definition fc_types.h:478
#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:1038
enum output_type_id Output_type_id
Definition fc_types.h:378
size_t get_internal_string_length(const char *text)
Definition fciconv.c:395
#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:62
struct world wld
Definition game.c:63
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:105
void insert_client_build_info(char *outbuf, size_t outlen)
Definition gui_main.c:2539
void popdown_help_dialog(void)
Definition helpdlg.c:187
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:3745
void help_iter_start(void)
Definition helpdata.c:1398
static int help_item_compar(const struct help_item *const *ppa, const struct help_item *const *ppb)
Definition helpdata.c:746
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:768
static void insert_allows(struct universal *psource, char *buf, size_t bufsz, const char *prefix)
Definition helpdata.c:629
#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:4400
void helptext_advance(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, int i)
Definition helpdata.c:3359
enum help_page_type help_type_by_requirement(const struct requirement *req)
Definition helpdata.c:5265
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:1992
void helptext_extra(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct extra_type *pextra)
Definition helpdata.c:3854
void helptext_unitclass(struct unit_class *pclass, char *buf, size_t bufsz)
Definition helpdata.c:1926
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:1323
int num_help_items(void)
Definition helpdata.c:1312
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:4319
#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:3690
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:5062
#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:3820
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:543
#define help_list_iterate_end
Definition helpdata.c:83
static bool utype_may_do_escape_action(const struct unit_type *utype)
Definition helpdata.c:1890
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:4365
const struct help_item * get_help_item_spec(const char *name, enum help_page_type htype, int *pos)
Definition helpdata.c:1346
#define help_list_iterate(helplist, phelp)
Definition helpdata.c:81
const struct help_item * help_iter_next(void)
Definition helpdata.c:1408
char * helptext_building(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct impr_type *pimprove)
Definition helpdata.c:1439
void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct terrain *pterrain)
Definition helpdata.c:3580
void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation, const char *user_text)
Definition helpdata.c:5099
static struct help_item * new_help_item(int type)
Definition helpdata.c:730
#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:191
#define log_verbose(message,...)
Definition log.h:109
#define fc_assert(condition)
Definition log.h:176
#define fc_assert_ret_val(condition, val)
Definition log.h:194
#define log_error(message,...)
Definition log.h:103
struct terrain_misc terrain_control
Definition map.c:69
#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:1047
const char * move_points_text_full(int mp, bool reduce, const char *prefix, const char *none, bool align)
Definition movement.c:980
bool is_native_to_class(const struct unit_class *punitclass, const struct terrain *pterrain, const bv_extras *extras)
Definition movement.c:374
bool can_unit_type_transport(const struct unit_type *transporter, const struct unit_class *transported)
Definition movement.c:900
bool can_attack_non_native(const struct unit_type *utype)
Definition movement.c:214
#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:1627
struct section_file * secfile_load(const char *filename, bool allow_duplicates)
Definition registry.c:50
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:3307
@ 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:410
bool road_provides_move_bonus(const struct road_type *proad)
Definition road.c:499
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:359
const char * fileinfoname(const struct strvec *dirs, const char *filename)
Definition shared.c:1101
const struct strvec * get_data_dirs(void)
Definition shared.c:893
#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:363
bool quiet
Definition actions.h:385
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
bool ruleset_init
Definition game.h:118
struct civ_game::@30 rgame
struct veteran_system * veteran
Definition game.h:101
struct civ_game::@31::@34 client
int num_valid_dirs
Definition map_types.h:75
struct strvec * helptext
Definition extras.h:149
struct road_type * road
Definition extras.h:155
struct extra_type::@25 data
int removal_time
Definition extras.h:120
bool generated
Definition extras.h:117
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:263
int irrigation_food_incr
Definition terrain.h:221
int output[O_LAST]
Definition terrain.h:202
int road_output_incr_pct[O_LAST]
Definition terrain.h:211
int mining_shield_incr
Definition terrain.h:224
int transport_capacity
Definition unittype.h:523
int pop_cost
Definition unittype.h:513
struct requirement_vector build_reqs
Definition unittype.h:520
int defense_strength
Definition unittype.h:516
int paratroopers_range
Definition unittype.h:541
int convert_time
Definition unittype.h:531
int city_size
Definition unittype.h:550
struct veteran_system * veteran
Definition unittype.h:544
const struct unit_type * obsoleted_by
Definition unittype.h:529
bv_unit_classes targets
Definition unittype.h:561
enum vision_layer vlayer
Definition unittype.h:569
struct strvec * helptext
Definition unittype.h:571
int bombard_rate
Definition unittype.h:547
int upkeep[O_LAST]
Definition unittype.h:538
bv_unit_classes disembarks
Definition unittype.h:567
const struct unit_type * converted_to
Definition unittype.h:530
bv_unit_classes embarks
Definition unittype.h:564
int happy_cost
Definition unittype.h:537
struct combat_bonus_list * bonuses
Definition unittype.h:526
enum universals_n kind
Definition fc_types.h:902
universals_u value
Definition fc_types.h:901
struct veteran_level * definitions
Definition unittype.h:497
struct civ_map map
int fc_snprintf(char *str, size_t n, const char *format,...)
Definition support.c:974
size_t fc_strlcpy(char *dest, const char *src, size_t n)
Definition support.c:791
int fc_strcasecmp(const char *str0, const char *str1)
Definition support.c:189
size_t fc_strlcat(char *dest, const char *src, size_t n)
Definition support.c:836
int cat_snprintf(char *str, size_t n, const char *format,...)
Definition support.c:1000
#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:333
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:290
struct advance * valid_advance_by_number(const Tech_type_id id)
Definition tech.c:176
bool techs_have_fixed_costs(void)
Definition tech.c:450
const char * tech_flag_helptxt(enum tech_flag_id id)
Definition tech.c:435
Tech_type_id advance_number(const struct advance *padvance)
Definition tech.c:98
#define advance_index_iterate_end
Definition tech.h:248
@ AR_ROOT
Definition tech.h:113
#define A_FIRST
Definition tech.h:44
#define A_NONE
Definition tech.h:43
#define advance_root_req_iterate_end
Definition tech.h:319
#define A_LAST
Definition tech.h:45
#define advance_index_iterate(_start, _index)
Definition tech.h:244
#define advance_root_req_iterate(_goal, _padvance)
Definition tech.h:314
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:373
#define T_NONE
Definition terrain.h:56
#define terrain_type_iterate_end
Definition terrain.h:379
#define terrain_has_flag(terr, flag)
Definition terrain.h:283
const char * tileset_description(struct tileset *t)
Definition tilespec.c:7547
const char * tileset_summary(struct tileset *t)
Definition tilespec.c:7539
const char * tileset_name_get(struct tileset *t)
Definition tilespec.c:7523
const char * tileset_version(struct tileset *t)
Definition tilespec.c:7531
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:714
const char * uclass_name_translation(const struct unit_class *pclass)
Definition unittype.c:1632
bool utype_action_takes_all_mp(const struct unit_type *putype, struct action *paction)
Definition unittype.c:1191
bool utype_can_freely_unload(const struct unit_type *pcargotype, const struct unit_type *ptranstype)
Definition unittype.c:300
const char * unit_class_flag_helptxt(enum unit_class_flag_id id)
Definition unittype.c:1854
Unit_Class_id uclass_count(void)
Definition unittype.c:2446
struct unit_type * get_role_unit(int role, int role_index)
Definition unittype.c:2253
int utype_build_shield_cost_base(const struct unit_type *punittype)
Definition unittype.c:1468
const struct veteran_system * utype_veteran_system(const struct unit_type *punittype)
Definition unittype.c:2568
int num_role_units(int role)
Definition unittype.c:2203
bool utype_can_freely_load(const struct unit_type *pcargotype, const struct unit_type *ptranstype)
Definition unittype.c:288
Unit_type_id utype_count(void)
Definition unittype.c:80
int utype_veteran_levels(const struct unit_type *punittype)
Definition unittype.c:2625
bool utype_can_do_action_result(const struct unit_type *putype, enum action_result result)
Definition unittype.c:387
bool utype_action_takes_all_mp_if_ustate_is(const struct unit_type *putype, struct action *paction, const enum ustate_prop prop)
Definition unittype.c:1207
const struct veteran_level * utype_veteran_level(const struct unit_type *punittype, int level)
Definition unittype.c:2597
bool utype_is_consumed_by_action(const struct action *paction, const struct unit_type *utype)
Definition unittype.c:1219
bool utype_veteran_has_power_bonus(const struct unit_type *punittype)
Definition unittype.c:2638
const char * unit_type_flag_helptxt(enum unit_type_flag_id id)
Definition unittype.c:1917
const char * utype_name_translation(const struct unit_type *punittype)
Definition unittype.c:1560
bool can_utype_do_act_if_tgt_diplrel(const struct unit_type *punit_type, const action_id act_id, const int prop, const bool is_there)
Definition unittype.c:1017
bool utype_can_do_action(const struct unit_type *putype, const action_id act_id)
Definition unittype.c:371
#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:766
#define utype_class(_t_)
Definition unittype.h:749
#define utype_fuel(ptype)
Definition unittype.h:839
#define combat_bonus_list_iterate_end
Definition unittype.h:482
#define combat_bonus_list_iterate(bonuslist, pbonus)
Definition unittype.h:480
#define unit_tech_reqs_iterate_end
Definition unittype.h:881
#define unit_class_iterate(_p)
Definition unittype.h:908
#define unit_tech_reqs_iterate(_utype_, _p)
Definition unittype.h:875
static bool utype_has_flag(const struct unit_type *punittype, int flag)
Definition unittype.h:617
#define UTYF_LAST_USER_FLAG
Definition unittype.h:331
#define unit_type_iterate(_p)
Definition unittype.h:855
#define uclass_index(_c_)
Definition unittype.h:742
#define unit_class_iterate_end
Definition unittype.h:915
#define unit_type_iterate_end
Definition unittype.h:862
const char * freeciv_name_version(void)
Definition version.c:35