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 Doesn't prevent enemy cities from working the tile it's on.\n"),
1964 BULLET);
1965 }
1966
1969 const char *helptxt = unit_class_flag_helptxt(flagid);
1970
1971 if (helptxt != NULL) {
1972 /* TRANS: Indented unit class property, preserve leading spaces */
1973 CATLSTR(buf, bufsz, " %s %s\n", BULLET, _(helptxt));
1974 }
1975 }
1976 }
1977}
1978
1979/************************************************************************/
1985char *helptext_unit(char *buf, size_t bufsz, struct player *pplayer,
1986 const char *user_text, const struct unit_type *utype,
1987 bool class_help)
1988{
1989 bool has_vet_levels;
1990 int flagid;
1991 struct unit_class *pclass;
1992 int fuel;
1993
1994 fc_assert_ret_val(NULL != buf && 0 < bufsz && NULL != user_text, NULL);
1995
1996 if (!utype) {
1997 log_error("Unknown unit!");
1999 return buf;
2000 }
2001
2003
2004 buf[0] = '\0';
2005
2006 pclass = utype_class(utype);
2008 _("%s Belongs to %s unit class."),
2009 BULLET,
2011
2012 if (class_help) {
2014 } else {
2015 cat_snprintf(buf, bufsz, "\n");
2016 }
2017
2019 && !utype_has_flag(utype, UTYF_IGZOC)) {
2020 /* TRANS: Indented unit class property, preserve leading spaces */
2021 CATLSTR(buf, bufsz, _(" %s Subject to zones of control.\n"),
2022 BULLET);
2023 }
2024
2025 if (utype->defense_strength > 0) {
2026 struct universal unit_is_in_city[] = {
2027 { .kind = VUT_UTYPE, .value = { .utype = utype }},
2028 { .kind = VUT_CITYTILE, .value = { .citytile = CITYT_CENTER }},
2029 };
2030 int bonus = effect_value_from_universals(
2033
2034 if (bonus > 0) {
2036 /* TRANS: Indented unit class property, preserve leading
2037 * spaces */
2038 _(" %s Gets a %d%% defensive bonus while in cities.\n"),
2039 BULLET, bonus);
2040 }
2041 }
2043 CATLSTR(buf, bufsz,
2044 /* TRANS: indented unit class property, preserve leading spaces */
2045 _(" %s Is unreachable. Most units cannot attack this one.\n"),
2046 BULLET);
2047 if (utype_has_flag(utype, UTYF_NEVER_PROTECTS)) {
2048 CATLSTR(buf, bufsz,
2049 /* TRANS: Indented twice; preserve leading spaces */
2050 _(" %s Doesn't prevent enemy units from attacking other "
2051 "units on its tile.\n"), BULLET);
2052 }
2053 }
2054
2055 if (can_attack_non_native(utype)) {
2056 CATLSTR(buf, bufsz,
2057 /* TRANS: Indented unit class property, preserve leading spaces */
2058 _(" %s Can attack units on non-native tiles.\n"), BULLET);
2059 }
2060
2061 /* The unit's combat bonuses. Won't mention that another unit type has a
2062 * combat bonus against this unit type. Doesn't handle complex cases like
2063 * when a unit type has multiple combat bonuses of the same kind. */
2065 const char *against[utype_count()];
2066 int targets = 0;
2067
2068 if (cbonus->quiet) {
2069 /* Handled in the help text of the ruleset. */
2070 continue;
2071 }
2072
2073 /* Find the unit types of the bonus targets. */
2075 if (utype_has_flag(utype2, cbonus->flag)) {
2077 }
2079
2080 if (targets > 0) {
2081 struct astring list = ASTRING_INIT;
2082
2083 switch (cbonus->type) {
2086 /* TRANS: percentage ... or-list of unit types */
2087 _("%s %d%% defense bonus if attacked by %s.\n"),
2088 BULLET,
2089 cbonus->value * 100,
2090 astr_build_or_list(&list, against, targets));
2091 break;
2094 /* TRANS: defense divider ... or-list of unit types */
2095 _("%s Reduces target's defense to 1 / %d when "
2096 "attacking %s.\n"), BULLET,
2097 cbonus->value + 1,
2098 astr_build_or_list(&list, against, targets));
2099 break;
2102 /* TRANS: or-list of unit types */
2103 _("%s Reduces target's firepower to 1 when "
2104 "attacking %s.\n"), BULLET,
2105 astr_build_and_list(&list, against, targets));
2106 break;
2109 /* TRANS: percentage ... or-list of unit types */
2110 _("%s %d%% defense bonus if attacked by %s.\n"),
2111 BULLET, cbonus->value,
2112 astr_build_or_list(&list, against, targets));
2113 break;
2116 /* TRANS: defense divider ... or-list of unit types */
2117 _("%s Reduces target's defense to 1 / %.2f when "
2118 "attacking %s.\n"), BULLET,
2119 ((float) cbonus->value + 100.0f) / 100.0f,
2120 astr_build_or_list(&list, against, targets));
2121 break;
2124 /* TRANS: percentage ... or-list of unit types */
2125 _("%s %d%% defense bonus "
2126 "instead of any bonuses from city improvements "
2127 "if attacked by %s in a city.\n"),
2128 BULLET, cbonus->value,
2129 astr_build_or_list(&list, against, targets));
2130 break;
2131 }
2132
2133 astr_free(&list);
2134 }
2136
2137 /* Add requirement text for the unit type itself */
2140 BULLET_SPACE);
2142
2143 if (utype_has_flag(utype, UTYF_CANESCAPE)) {
2144 CATLSTR(buf, bufsz, _("%s Can escape once stack defender is lost.\n"),
2145 BULLET);
2146 }
2148 CATLSTR(buf, bufsz, _("%s Can pursue escaping units and kill them.\n"),
2149 BULLET);
2150 }
2151
2152 if (utype_has_flag(utype, UTYF_NOBUILD)) {
2153 CATLSTR(buf, bufsz, _("%s May not be built in cities.\n"), BULLET);
2154 }
2155 if (utype_has_flag(utype, UTYF_BARBARIAN_ONLY)) {
2156 CATLSTR(buf, bufsz, _("%s Only barbarians may build this.\n"), BULLET);
2157 }
2159 CATLSTR(buf, bufsz, _("%s Can only be built in games where new cities "
2160 "are allowed.\n"), BULLET);
2162 /* TRANS: indented; preserve leading spaces */
2163 CATLSTR(buf, bufsz, _(" %s New cities are not allowed in the current "
2164 "game.\n"), BULLET);
2165 } else {
2166 /* TRANS: indented; preserve leading spaces */
2167 CATLSTR(buf, bufsz, _(" %s New cities are allowed in the current "
2168 "game.\n"), BULLET);
2169 }
2170 }
2171 nations_iterate(pnation) {
2172 int i, count = 0;
2173
2174 /* Avoid mentioning nations not in current set. */
2175 if (!show_help_for_nation(pnation)) {
2176 continue;
2177 }
2178 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
2179 if (!pnation->init_units[i]) {
2180 break;
2181 } else if (pnation->init_units[i] == utype) {
2182 count++;
2183 }
2184 }
2185 if (count > 0) {
2187 /* TRANS: %s is a nation plural */
2188 PL_("%s The %s start the game with %d of these units.\n",
2189 "%s The %s start the game with %d of these units.\n",
2190 count), BULLET,
2191 nation_plural_translation(pnation), count);
2192 }
2194 {
2195 const char *types[utype_count()];
2196 int i = 0;
2197
2199 if (utype2->converted_to == utype
2201 types[i++] = utype_name_translation(utype2);
2202 }
2204 if (i > 0) {
2205 struct astring list = ASTRING_INIT;
2206
2207 astr_build_or_list(&list, types, i);
2209 /* TRANS: %s is a list of unit types separated by "or". */
2210 _("%s May be obtained by conversion of %s.\n"),
2211 BULLET, astr_str(&list));
2212 astr_free(&list);
2213 }
2214 }
2215 if (utype_has_flag(utype, UTYF_NOHOME)) {
2217 CATLSTR(buf, bufsz, _("%s Built without a home city.\n"), BULLET);
2218 } else {
2219 CATLSTR(buf, bufsz, _("%s Never has a home city.\n"), BULLET);
2220 }
2221 }
2222 if (utype_has_flag(utype, UTYF_GAMELOSS)) {
2223 CATLSTR(buf, bufsz, _("%s Losing this unit will lose you the game!\n"),
2224 BULLET);
2225 }
2226 if (utype_has_flag(utype, UTYF_UNIQUE)) {
2227 CATLSTR(buf, bufsz,
2228 _("%s Each player may only have one of this type of unit.\n"),
2229 BULLET);
2230 }
2232 if (utype_has_flag(utype, flagid)) {
2233 const char *helptxt = unit_type_flag_helptxt(flagid);
2234
2235 if (helptxt != NULL) {
2236 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
2237 }
2238 }
2239 }
2240 if (utype->pop_cost > 0) {
2242 PL_("%s Costs %d population to build.\n",
2243 "%s Costs %d population to build.\n", utype->pop_cost),
2244 BULLET, utype->pop_cost);
2245 }
2246 if (0 < utype->transport_capacity) {
2247 const char *classes[uclass_count()];
2248 int i = 0;
2249 struct astring list = ASTRING_INIT;
2250
2251 unit_class_iterate(uclass) {
2252 if (can_unit_type_transport(utype, uclass)) {
2253 classes[i++] = uclass_name_translation(uclass);
2254 }
2257
2259 /* TRANS: %s is a list of unit classes separated by "or". */
2260 PL_("%s Can carry and refuel %d %s unit.\n",
2261 "%s Can carry and refuel up to %d %s units.\n",
2262 utype->transport_capacity),
2264 astr_free(&list);
2266 /* Document restrictions on when units can load/unload */
2271 if (utype_can_freely_load(pcargo, utype)) {
2273 } else {
2275 }
2276 if (utype_can_freely_unload(pcargo, utype)) {
2278 } else {
2280 }
2281 }
2283 if (has_restricted_load) {
2285 /* At least one type of cargo can load onto us freely.
2286 * The specific exceptions will be documented in cargo help. */
2287 CATLSTR(buf, bufsz,
2288 /* TRANS: indented; preserve leading spaces */
2289 _(" %s Some cargo cannot be loaded except in a city or a "
2290 "base native to this transport.\n"), BULLET);
2291 } else {
2292 /* No exceptions */
2293 CATLSTR(buf, bufsz,
2294 /* TRANS: indented; preserve leading spaces */
2295 _(" %s Cargo cannot be loaded except in a city or a "
2296 "base native to this transport.\n"), BULLET);
2297 }
2298 } /* else, no restricted cargo exists; keep quiet */
2301 /* At least one type of cargo can unload from us freely. */
2302 CATLSTR(buf, bufsz,
2303 /* TRANS: indented; preserve leading spaces */
2304 _(" %s Some cargo cannot be unloaded except in a city or a "
2305 "base native to this transport.\n"), BULLET);
2306 } else {
2307 /* No exceptions */
2308 CATLSTR(buf, bufsz,
2309 /* TRANS: indented; preserve leading spaces */
2310 _(" %s Cargo cannot be unloaded except in a city or a "
2311 "base native to this transport.\n"), BULLET);
2312 }
2313 } /* else, no restricted cargo exists; keep quiet */
2314 }
2315 }
2316 if (utype_has_flag(utype, UTYF_COAST_STRICT)) {
2317 CATLSTR(buf, bufsz, _("%s Must stay next to safe coast.\n"), BULLET);
2318 }
2319 {
2320 /* Document exceptions to embark/disembark restrictions that we
2321 * have as cargo. */
2322 bv_unit_classes embarks, disembarks;
2323 BV_CLR_ALL(embarks);
2324 BV_CLR_ALL(disembarks);
2325 /* Determine which of our transport classes have restrictions in the first
2326 * place (that is, contain at least one transport which carries at least
2327 * one type of cargo which is restricted).
2328 * We'll suppress output for classes not in this set, since this cargo
2329 * type is not behaving exceptionally in such cases. */
2332 /* Don't waste time repeating checks on classes we've already checked,
2333 * or weren't under consideration in the first place */
2334 if (!BV_ISSET(embarks, trans_class)
2335 && BV_ISSET(utype->embarks, trans_class)) {
2339 /* At least one load restriction in transport class, which
2340 * we aren't subject to */
2341 BV_SET(embarks, trans_class);
2342 }
2343 } unit_type_iterate_end; /* cargo */
2344 }
2345 if (!BV_ISSET(disembarks, trans_class)
2346 && BV_ISSET(utype->disembarks, trans_class)) {
2350 /* At least one load restriction in transport class, which
2351 * we aren't subject to */
2352 BV_SET(disembarks, trans_class);
2353 }
2354 } unit_type_iterate_end; /* cargo */
2355 }
2356 } unit_class_iterate_end; /* transports */
2357
2358 if (BV_ISSET_ANY(embarks)) {
2359 /* Build list of embark exceptions */
2360 const char *eclasses[uclass_count()];
2361 int i = 0;
2362 struct astring elist = ASTRING_INIT;
2363
2364 unit_class_iterate(uclass) {
2365 if (BV_ISSET(embarks, uclass_index(uclass))) {
2366 eclasses[i++] = uclass_name_translation(uclass);
2367 }
2370 if (BV_ARE_EQUAL(embarks, disembarks)) {
2371 /* A common case: the list of disembark exceptions is identical */
2373 /* TRANS: %s is a list of unit classes separated
2374 * by "or". */
2375 _("%s May load onto and unload from %s transports even "
2376 "when underway.\n"),
2377 BULLET, astr_str(&elist));
2378 } else {
2380 /* TRANS: %s is a list of unit classes separated
2381 * by "or". */
2382 _("%s May load onto %s transports even when underway.\n"),
2383 BULLET, astr_str(&elist));
2384 }
2385 astr_free(&elist);
2386 }
2387 if (BV_ISSET_ANY(disembarks) && !BV_ARE_EQUAL(embarks, disembarks)) {
2388 /* Build list of disembark exceptions (if different from embarking) */
2389 const char *dclasses[uclass_count()];
2390 int i = 0;
2391 struct astring dlist = ASTRING_INIT;
2392
2393 unit_class_iterate(uclass) {
2394 if (BV_ISSET(disembarks, uclass_index(uclass))) {
2395 dclasses[i++] = uclass_name_translation(uclass);
2396 }
2400 /* TRANS: %s is a list of unit classes separated
2401 * by "or". */
2402 _("%s May unload from %s transports even when underway.\n"),
2403 BULLET, astr_str(&dlist));
2404 astr_free(&dlist);
2405 }
2406 }
2407
2408 if (utype_has_flag(utype, UTYF_SPY)) {
2409 CATLSTR(buf, bufsz, _("%s Strong in diplomatic battles.\n"), BULLET);
2410 }
2411 if (utype_has_flag(utype, UTYF_DIPLOMAT)
2412 || utype_has_flag(utype, UTYF_SUPERSPY)) {
2413 CATLSTR(buf, bufsz, _("%s Defends cities against diplomatic actions.\n"),
2414 BULLET);
2415 }
2416 if (utype_has_flag(utype, UTYF_SUPERSPY)) {
2417 CATLSTR(buf, bufsz, _("%s Will never lose a diplomat-versus-diplomat fight.\n"),
2418 BULLET);
2419 }
2421 && utype_has_flag(utype, UTYF_SUPERSPY)) {
2422 CATLSTR(buf, bufsz, _("%s Will always survive a spy mission.\n"), BULLET);
2423 }
2424 if (utype->vlayer == V_INVIS) {
2425 CATLSTR(buf, bufsz,
2426 _("%s Is invisible except when next to an enemy unit or city.\n"),
2427 BULLET);
2428 }
2430 CATLSTR(buf, bufsz,
2431 _("%s Can only attack units on native tiles.\n"), BULLET);
2432 }
2433 if (utype_has_flag(utype, UTYF_CITYBUSTER)) {
2434 CATLSTR(buf, bufsz,
2435 _("%s Gets double firepower when attacking cities.\n"), BULLET);
2436 }
2437 if (utype_has_flag(utype, UTYF_IGTER)) {
2439 /* TRANS: "MP" = movement points. %s may have a
2440 * fractional part. */
2441 _("%s Ignores terrain effects (moving costs at most %s MP "
2442 "per tile).\n"), BULLET,
2444 }
2445 if (utype_has_flag(utype, UTYF_NOZOC)) {
2446 CATLSTR(buf, bufsz, _("%s Never imposes a zone of control.\n"), BULLET);
2447 } else {
2448 CATLSTR(buf, bufsz, _("%s May impose a zone of control on its adjacent "
2449 "tiles.\n"), BULLET);
2450 }
2451 if (utype_has_flag(utype, UTYF_IGZOC)) {
2452 CATLSTR(buf, bufsz, _("%s Not subject to zones of control imposed "
2453 "by other units.\n"), BULLET);
2454 }
2455 if (utype_has_flag(utype, UTYF_CIVILIAN)) {
2456 CATLSTR(buf, bufsz,
2457 _("%s A non-military unit:\n"), BULLET);
2458 CATLSTR(buf, bufsz,
2459 /* TRANS: indented; preserve leading spaces */
2460 _(" %s Cannot attack.\n"), BULLET);
2461 CATLSTR(buf, bufsz,
2462 /* TRANS: indented; preserve leading spaces */
2463 _(" %s Doesn't impose martial law.\n"), BULLET);
2464 CATLSTR(buf, bufsz,
2465 /* TRANS: indented; preserve leading spaces */
2466 _(" %s Can enter foreign territory regardless of peace treaty.\n"),
2467 BULLET);
2468 CATLSTR(buf, bufsz,
2469 /* TRANS: indented; preserve leading spaces */
2470 _(" %s Doesn't prevent enemy cities from working the tile it's on.\n"),
2471 BULLET);
2472 }
2473 if (utype_has_flag(utype, UTYF_FIELDUNIT)) {
2474 CATLSTR(buf, bufsz,
2475 _("%s A field unit: one unhappiness applies even when non-aggressive.\n"),
2476 BULLET);
2477 }
2478 if (utype_has_flag(utype, UTYF_PROVOKING)
2480 server_setting_by_name("autoattack"))) {
2481 CATLSTR(buf, bufsz,
2482 _("%s An enemy unit considering to auto attack this unit will "
2483 "choose to do so even if it has better odds when defending "
2484 "against it than when attacking it.\n"), BULLET);
2485 }
2486 if (utype_has_flag(utype, UTYF_SHIELD2GOLD)) {
2487 /* FIXME: the conversion shield => gold is activated if
2488 * EFT_SHIELD2GOLD_FACTOR is not equal null; how to determine
2489 * possible sources? */
2490 CATLSTR(buf, bufsz,
2491 _("%s Under certain conditions the shield upkeep of this unit can "
2492 "be converted to gold upkeep.\n"), BULLET);
2493 }
2494
2495 unit_class_iterate(target) {
2496 if (uclass_has_flag(target, UCF_UNREACHABLE)
2497 && BV_ISSET(utype->targets, uclass_index(target))) {
2499 _("%s Can attack against %s units, which are usually not "
2500 "reachable.\n"), BULLET,
2501 uclass_name_translation(target));
2502 }
2504
2505 fuel = utype_fuel(utype);
2506 if (fuel > 0) {
2507 const char *types[utype_count()];
2508 int i = 0;
2509
2513 }
2515
2516 if (0 == i) {
2517 if (utype_has_flag(utype, UTYF_COAST)) {
2518 if (fuel == 1) {
2520 _("%s Unit has to end each turn next to safe coast or"
2521 " in a city or a base.\n"), BULLET);
2522 } else {
2524 /* Pluralization for the benefit of languages with
2525 * duals etc */
2526 /* TRANS: Never called for 'turns = 1' case */
2527 PL_("%s Unit has to be next to safe coast, in a city or a base"
2528 " after %d turn.\n",
2529 "%s Unit has to be next to safe coast, in a city or a base"
2530 " after %d turns.\n",
2531 fuel),
2532 BULLET, fuel);
2533 }
2534 } else {
2536 PL_("%s Unit has to be in a city or a base"
2537 " after %d turn.\n",
2538 "%s Unit has to be in a city or a base"
2539 " after %d turns.\n",
2540 fuel),
2541 BULLET, fuel);
2542 }
2543 } else {
2544 struct astring list = ASTRING_INIT;
2545
2546 if (utype_has_flag(utype, UTYF_COAST)) {
2548 /* TRANS: %s is a list of unit types separated by "or" */
2549 PL_("%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2550 " after %d turn.\n",
2551 "%s Unit has to be next to safe coast, in a city, a base, or on a %s"
2552 " after %d turns.\n",
2553 fuel),
2554 BULLET, astr_build_or_list(&list, types, i), fuel);
2555 } else {
2557 /* TRANS: %s is a list of unit types separated by "or" */
2558 PL_("%s Unit has to be in a city, a base, or on a %s"
2559 " after %d turn.\n",
2560 "%s Unit has to be in a city, a base, or on a %s"
2561 " after %d turns.\n",
2562 fuel),
2563 BULLET, astr_build_or_list(&list, types, i), fuel);
2564 }
2565 astr_free(&list);
2566 }
2567 }
2568
2569 /* Auto attack immunity. (auto_attack.if_attacker ruleset setting) */
2571 server_setting_by_name("autoattack"))) {
2573
2575 if (auto_action->cause != AAPC_UNIT_MOVED_ADJ) {
2576 /* Not relevant for auto attack. */
2577 continue;
2578 }
2579
2581 /* Can be forced to auto attack. */
2583 break;
2584 }
2586
2588 CATLSTR(buf, bufsz,
2589 _("%s Will never be forced (by the autoattack server setting)"
2590 " to attack units moving to an adjacent tile.\n"), BULLET);
2591 }
2592 }
2593
2594 action_iterate(act) {
2595 struct action *paction = action_by_number(act);
2596
2597 if (action_by_number(act)->quiet) {
2598 /* The ruleset documents this action it self. */
2599 continue;
2600 }
2601
2602 if (utype_can_do_action(utype, act)) {
2603 const char *target_adjective;
2604 char sub_target_text[100];
2605 const char *blockers[MAX_NUM_ACTIONS];
2606 int i = 0;
2607
2608 /* Generic action information. */
2610 /* TRANS: %s is the action's ruleset defined ui name */
2611 _("%s Can do the action \'%s\'.\n"),
2613
2614 switch (action_id_get_target_kind(act)) {
2615 case ATK_SELF:
2616 /* No target. */
2617 break;
2618 default:
2619 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2620 DRO_FOREIGN, TRUE)) {
2621 /* TRANS: describes the target of an action. */
2622 target_adjective = _("domestic ");
2623 } else if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2624 DRO_FOREIGN, FALSE)) {
2625 /* TRANS: describes the target of an action. */
2626 target_adjective = _("foreign ");
2627 } else {
2628 /* Both foreign and domestic targets are acceptable. */
2629 target_adjective = "";
2630 }
2631
2632 sub_target_text[0] = '\0';
2637 /* TRANS: action sub target extras with tile
2638 * extras target. */
2639 _("extras among "));
2640 } else {
2642 /* TRANS: action sub target kind. */
2643 _("%s "),
2646 }
2647 }
2648
2650 /* TRANS: First %s in %s%s%s is the sub target kind.
2651 * The next may be an adjective (that includes a space).
2652 * The next is the name of the target kind.
2653 * Example: "* is done to extras on foreign tiles." */
2654 _(" %s is done to %s%s%s.\n"), BULLET,
2658 }
2659
2662 /* TRANS: said about an action. %s is a unit type
2663 * name. */
2664 _(" %s uses up the %s.\n"), BULLET,
2665 utype_name_translation(utype));
2666 }
2667
2668 if (actres_get_battle_kind(paction->result) != ABK_NONE) {
2670 /* TRANS: The %s is a kind of battle defined in
2671 * actions.h. Example: "diplomatic battle". */
2672 _(" %s can lead to a %s against a defender.\n"),
2673 BULLET,
2676 }
2677
2678 {
2679 struct universal req_pattern[] = {
2680 { .kind = VUT_ACTION, .value.action = paction },
2681 { .kind = VUT_UTYPE, .value.utype = utype },
2682 };
2684
2689 ((100 - odds) * 100
2690 / odds))) {
2692 _(" %s may fail because of a dice throw.\n"),
2693 BULLET);
2694 }
2695 }
2696
2698 && paction->actor.is_unit.moves_actor == MAK_ESCAPE) {
2700 /* TRANS: said about an action. %s is a unit type
2701 * name. */
2702 _(" %s the %s may be captured while trying to"
2703 " escape after completing the mission.\n"),
2704 BULLET,
2705 utype_name_translation(utype));
2706 }
2707
2709 /* The dead don't care about movement loss. */
2710 } else if (utype_action_takes_all_mp(utype, paction)) {
2712 /* TRANS: Indented unit action property, preserve
2713 * leading spaces. */
2714 _(" %s ends this unit's turn.\n"),
2715 BULLET);
2717 USP_NATIVE_TILE)) {
2718 /* Used in the implementation of slow_invasion in many of the
2719 * bundled rulesets and in rulesets upgraded with rscompat from 3.0
2720 * to 3.1. */
2722 /* TRANS: Indented unit action property, preserve
2723 * leading spaces. */
2724 _(" %s ending up on a native tile"
2725 " after this action has been performed"
2726 " ends this unit's turn.\n"), BULLET);
2727 }
2728
2729 if (action_id_get_target_kind(act) != ATK_SELF) {
2730 /* Distance to target is relevant. */
2731
2732 /* FIXME: move paratroopers_range to the action and remove this
2733 * variable once actions are generalized. */
2737 MIN(paction->max_distance, utype->paratroopers_range) :
2738 paction->max_distance;
2739
2740 if (paction->min_distance == relative_max) {
2741 /* Only one distance to target is acceptable */
2742
2743 if (paction->min_distance == 0) {
2745 /* TRANS: distance between an actor unit and its
2746 * target when performing a specific action. */
2747 _(" %s target must be at the same tile.\n"),
2748 BULLET);
2749 } else {
2751 /* TRANS: distance between an actor unit and its
2752 * target when performing a specific action. */
2753 PL_(" %s target must be exactly %d tile away.\n",
2754 " %s target must be exactly %d tiles away.\n",
2755 paction->min_distance),
2756 BULLET, paction->min_distance);
2757 }
2759 /* No max distance */
2760
2761 if (paction->min_distance == 0) {
2763 /* TRANS: distance between an actor unit and its
2764 * target when performing a specific action. */
2765 _(" %s target can be anywhere.\n"), BULLET);
2766 } else {
2768 /* TRANS: distance between an actor unit and its
2769 * target when performing a specific action. */
2770 PL_(" %s target must be at least %d tile away.\n",
2771 " %s target must be at least %d tiles away.\n",
2772 paction->min_distance),
2773 BULLET, paction->min_distance);
2774 }
2775 } else if (paction->min_distance == 0) {
2776 /* No min distance */
2777
2779 /* TRANS: distance between an actor unit and its
2780 * target when performing a specific action. */
2781 PL_(" %s target can be max %d tile away.\n",
2782 " %s target can be max %d tiles away.\n",
2783 relative_max),
2785 } else {
2786 /* Full range. */
2787
2789 /* TRANS: distance between an actor unit and its
2790 * target when performing a specific action. */
2791 PL_(" %s target must be between %d and %d tile away.\n",
2792 " %s target must be between %d and %d tiles away.\n",
2793 relative_max),
2794 BULLET, paction->min_distance, relative_max);
2795 }
2796 }
2797
2798 /* The action may be a Casus Belli. */
2799 {
2800 const struct {
2801 const enum effect_type eft;
2802 const char *hlp_text;
2803 } casus_belli[] = {
2804 /* TRANS: ...performing this action ... Casus Belli */
2805 { EFT_CASUS_BELLI_SUCCESS, N_("successfully") },
2806 /* TRANS: ...performing this action ... Casus Belli */
2807 { EFT_CASUS_BELLI_CAUGHT, N_("getting caught before") },
2808 };
2809
2810 struct universal req_pattern[] = {
2811 { .kind = VUT_ACTION, .value.action = paction },
2812 { .kind = VUT_DIPLREL, /* value filled in later */ },
2813 };
2814
2815 /* First group by effect (currently getting caught and successfully
2816 * performing the action) */
2817 for (i = 0; i < ARRAY_SIZE(casus_belli); i++) {
2818 int diplrel;
2819
2820 /* DiplRel list of each Casus Belli size. */
2821 const char *victim_diplrel_names[DRO_LAST];
2822 const char *outrage_diplrel_names[DRO_LAST];
2823 int victim_diplrel_count = 0;
2824 int outrage_diplrel_count = 0;
2825
2826 /* Ignore Team and everything in diplrel_other. */
2827 for (diplrel = 0; diplrel < DS_NO_CONTACT; diplrel++) {
2829
2830 if (!can_utype_do_act_if_tgt_diplrel(utype, act,
2831 diplrel, TRUE)) {
2832 /* Can't do the action. Can't give Casus Belli. */
2833 continue;
2834 }
2835
2836 req_pattern[1].value.diplrel = diplrel;
2838 casus_belli[i].eft,
2840
2843 diplrel_name_translation(diplrel);
2844 } else if (CASUS_BELLI_VICTIM <= casus_belli_amount) {
2846 diplrel_name_translation(diplrel);
2847 }
2848 }
2849
2850 /* Then group by Casus Belli size (currently victim and
2851 * international outrage) */
2852 if (outrage_diplrel_count > 0) {
2853 struct astring list = ASTRING_INIT;
2855 /* TRANS: successfully ... Peace, or Alliance */
2856 _(" %s %s performing this action during %s causes"
2857 " international outrage: the whole world gets "
2858 "Casus Belli against you.\n"), BULLET,
2862 astr_free(&list);
2863 }
2864 if (victim_diplrel_count > 0) {
2865 struct astring list = ASTRING_INIT;
2867 /* TRANS: successfully ... Peace, or Alliance */
2868 _(" %s %s performing this action during %s gives"
2869 " the victim Casus Belli against you.\n"),
2870 BULLET,
2874 astr_free(&list);
2875 }
2876 }
2877 }
2878
2879 /* Custom action result specific information. */
2880 switch (paction->result) {
2881 case ACTRES_HELP_WONDER:
2883 /* TRANS: the %d is the number of shields the unit can
2884 * contribute. */
2885 _(" %s adds %d production.\n"), BULLET,
2887 break;
2888 case ACTRES_HEAL_UNIT:
2889 {
2890 struct universal req_pattern[] = {
2891 { .kind = VUT_ACTION, .value.action = paction },
2892 { .kind = VUT_UTYPE, .value.utype = utype },
2893 };
2894
2896 _(" %s restores up to %d%% of the target unit's"
2897 " hit points.\n"), BULLET,
2901 + 100);
2902 }
2903 break;
2904 case ACTRES_FOUND_CITY:
2907 /* TRANS: is talking about an action. */
2908 _(" %s is disabled in the current game.\n"),
2909 BULLET);
2910 }
2912 /* TRANS: the %d is initial population. */
2913 PL_(" %s initial population: %d.\n",
2914 " %s initial population: %d.\n",
2915 utype->city_size),
2916 BULLET, utype->city_size);
2917 break;
2918 case ACTRES_JOIN_CITY:
2920 /* TRANS: the %d is population. */
2921 PL_(" %s max target size: %d.\n",
2922 " %s max target size: %d.\n",
2926 /* TRANS: the %d is the population added. */
2927 PL_(" %s adds %d population.\n",
2928 " %s adds %d population.\n",
2929 utype->pop_cost),
2930 BULLET, utype->pop_cost);
2931 break;
2932 case ACTRES_BOMBARD:
2934 /* TRANS: %d is bombard rate. */
2935 _(" %s %d per turn.\n"), BULLET,
2936 utype->bombard_rate);
2938 /* TRANS: talking about bombard */
2939 _(" %s Will damage all"
2940 " defenders on a tile, and have no risk for the"
2941 " attacker.\n"), BULLET);
2942 break;
2945 /* TRANS: %s is a unit type. */
2946 _(" %s upgraded to %s or, when possible, to the unit "
2947 "type it upgrades to.\n"), BULLET,
2949 break;
2950 case ACTRES_ATTACK:
2951 if (game.info.tired_attack) {
2953 _(" %s weaker when tired. If performed with less "
2954 "than a single move point left the attack power "
2955 "is reduced accordingly.\n"), BULLET);
2956 }
2957 break;
2958 case ACTRES_WIPE_UNITS:
2960 _(" %s can wipe stack of units with zero defense.\n"),
2961 BULLET);
2962 break;
2963 case ACTRES_CONVERT:
2965 /* TRANS: %s is a unit type. "MP" = movement points. */
2966 PL_(" %s is converted into %s (takes %d MP).\n",
2967 " %s is converted into %s (takes %d MP).\n",
2968 utype->convert_time),
2969 BULLET,
2971 utype->convert_time);
2972 break;
2973 case ACTRES_SPY_NUKE:
2974 case ACTRES_NUKE:
2975 case ACTRES_NUKE_UNITS:
2976 if (game.info.nuke_pop_loss_pct > 0) {
2978 /* TRANS: percentage */
2979 _(" %s %d%% of the population of each city inside"
2980 " the nuclear blast dies.\n"), BULLET,
2982 if (game.info.nuke_pop_loss_pct < 50) {
2984 _(" %s can never destroy city completely "
2985 "(%d%% of size 1 rounds down to 0).\n"), BULLET,
2987 } else {
2989 _(" %s can even destroy city completely "
2990 "(%d%% of size 1 rounds up to 1).\n"), BULLET,
2992 }
2993 }
2996 _(" %s all units caught in the open by the nuclear"
2997 " blast die.\n"), BULLET);
2999 /* TRANS: percentage */
3000 _(" %s a unit caught in the nuclear blast while"
3001 " inside a city has a %d%% chance of survival.\n"),
3002 BULLET,
3004 } else {
3006 _(" %s all units caught in the nuclear blast"
3007 " die.\n"), BULLET);
3008 }
3009 {
3010 struct universal req_pattern[] = {
3011 { .kind = VUT_ACTION, .value.action = paction },
3012 { .kind = VUT_UTYPE, .value.utype = utype },
3013 };
3014
3015 int blast_radius_1 =
3019
3021 _(" %s has a squared blast radius of %d.\n"),
3023 }
3024
3025 break;
3026 case ACTRES_PLANT:
3027 case ACTRES_CULTIVATE:
3030 _(" %s converts target tile terrain to another"
3031 " type.\n"), BULLET);
3032 break;
3033 case ACTRES_ROAD:
3034 case ACTRES_MINE:
3035 case ACTRES_IRRIGATE:
3036 case ACTRES_BASE:
3037 {
3039 struct strvec *extras_vec = strvec_new();
3040
3041 extra_type_iterate(pextra) {
3042 if (actres_creates_extra(paction->result, pextra)) {
3044 }
3046
3047 if (strvec_size(extras_vec) > 0) {
3049 /* TRANS: %s is list of extra types separated by ',' and 'and' */
3050 cat_snprintf(buf, bufsz, _(" %s builds %s on tiles.\n"),
3053 }
3054
3056 }
3057 break;
3058 case ACTRES_CLEAN:
3059 {
3061 struct strvec *extras_vec = strvec_new();
3062
3063 extra_type_iterate(pextra) {
3064 if (actres_removes_extra(paction->result, pextra)) {
3066 }
3068
3069 if (strvec_size(extras_vec) > 0) {
3071 /* TRANS: list of extras separated by "and" */
3072 cat_snprintf(buf, bufsz, _(" %s cleans %s from tiles.\n"),
3075 }
3076
3078 }
3079 break;
3080 case ACTRES_PILLAGE:
3081 {
3083 struct strvec *extras_vec = strvec_new();
3084
3085 extra_type_iterate(pextra) {
3086 if (actres_removes_extra(paction->result, pextra)) {
3088 }
3090
3091 if (strvec_size(extras_vec) > 0) {
3093 /* TRANS: list of extras separated by "and" */
3094 cat_snprintf(buf, bufsz, _(" %s pillages %s from tiles.\n"),
3097 }
3098
3100 }
3101 break;
3102 case ACTRES_FORTIFY:
3103 {
3104 struct universal unit_is_fortified[] = {
3105 { .kind = VUT_ACTIVITY,
3106 .value = { .activity = ACTIVITY_FORTIFIED }},
3107 { .kind = VUT_UTYPE, .value = { .utype = utype }},
3108 };
3109 int bonus = effect_value_from_universals(
3112
3113 if (utype->defense_strength <= 0
3115 &(struct universal){
3116 .kind = VUT_UTYPE,
3117 .value = { .utype = utype }},
3118 1)
3119 <= 0)) {
3121 /* TRANS: indented unit action property, preserve
3122 * leading spaces */
3123 _(" %s to stay put. No defensive bonus.\n"),
3124 BULLET);
3125 } else if (bonus > 0) {
3127 /* TRANS: indented unit action property, preserve
3128 * leading spaces */
3129 _(" %s granting a %d%% defensive bonus.\n"),
3130 BULLET, bonus);
3131 }
3132 }
3133 break;
3135 {
3136 const char *targets[extra_count()];
3137 int j = 0;
3138
3139 /* Extra being native one is a hard requirement
3140 * Not using unit class native_bases cache here.
3141 * Sometimes it's not initialized when we run this,
3142 * and as this is not performance critical, no point
3143 * in using it conditionally and having this only as
3144 * fallback implementation. */
3146 if (!is_native_extra_to_uclass(pextra, pclass)) {
3147 continue;
3148 }
3149
3150 if (!territory_claiming_base(pextra->data.base)) {
3151 continue;
3152 }
3153
3154 targets[j++] = extra_name_translation(pextra);
3156
3157 if (j > 0) {
3158 struct astring list = ASTRING_INIT;
3159 /* TRANS: indented unit action property, preserve
3160 * leading spaces.
3161 * %s is a list of extra types separated by "and". */
3162 cat_snprintf(buf, bufsz, _(" %s done to %s.\n"),
3163 BULLET,
3164 astr_build_and_list(&list, targets, j));
3165 astr_free(&list);
3166 }
3167 }
3168 break;
3169 default:
3170 /* No action specific details. */
3171 break;
3172 }
3173
3174 /* Custom action sub result specific information. */
3175 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_ENTER)) {
3177 /* TRANS: indented unit action property, preserve
3178 * leading spaces. */
3179 _(" %s if a suitable hut is at the targetet tile it"
3180 " will be entered.\n"), BULLET);
3181 }
3182 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_HUT_FRIGHTEN)) {
3184 /* TRANS: indented unit action property, preserve
3185 * leading spaces. */
3186 _(" %s if a suitable hut is at the targetet tile it"
3187 " will be frightened.\n"), BULLET);
3188 }
3189 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_MAY_EMBARK)) {
3191 /* TRANS: indented unit action property, preserve
3192 * leading spaces.
3193 * The %s is the unit type name */
3194 _(" %s the %s may end up loaded into a transport if it"
3195 " can't survive on its own at the target tile.\n"),
3197 }
3198 if (BV_ISSET(paction->sub_results, ACT_SUB_RES_NON_LETHAL)) {
3200 /* TRANS: talking about non lethal attacks */
3201 _(" %s These attacks will only damage (never kill)"
3202 " defenders.\n"), BULLET);
3203 }
3204
3205 i = 0;
3207 const struct action *blocker = action_by_number(blocker_id);
3208
3209 if (!utype_can_do_action(utype, blocker->id)) {
3210 /* Can't block since never legal. */
3211 continue;
3212 }
3213
3214 if (action_would_be_blocked_by(paction, blocker)) {
3215 /* action name alone can be MAX_LEN_NAME, leave space for extra
3216 * characters */
3217 int maxlen = MAX_LEN_NAME + 16;
3218 char *quoted = fc_malloc(maxlen);
3219
3221 /* TRANS: %s is an action that can block another. */
3222 _("\'%s\'"), action_name_translation(blocker));
3223 blockers[i] = quoted;
3224
3225 i++;
3226 }
3228
3229 if (i > 0) {
3230 struct astring blist = ASTRING_INIT;
3231
3233 /* TRANS: %s is a list of actions separated by "or". */
3234 _(" %s can't be done if %s is legal.\n"), BULLET,
3236
3237 astr_free(&blist);
3238
3239 for (; i > 0; i--) {
3240 /* The text was copied above. */
3241 free((char *)(blockers[i - 1]));
3242 }
3243 }
3244 }
3246 action_iterate(act) {
3247 struct action *paction = action_by_number(act);
3248 bool vulnerable;
3249
3250 if (action_by_number(act)->quiet) {
3251 /* The ruleset documents this action it self. */
3252 continue;
3253 }
3254
3255 /* Not relevant */
3259 continue;
3260 }
3261
3262 /* All units are immune to this since its not enabled */
3263 if (!action_is_in_use(paction)) {
3264 continue;
3265 }
3266
3267 /* Must be immune in all cases */
3268 vulnerable = FALSE;
3271 &(enabler->target_reqs))) {
3272 vulnerable = TRUE;
3273 break;
3274 }
3276
3277 if (!vulnerable) {
3279 _("%s Doing the action \'%s\' to this unit"
3280 " is impossible.\n"), BULLET,
3282 }
3284 if (!has_vet_levels) {
3285 /* Only mention this if the game generally does have veteran levels. */
3286 if (game.veteran->levels > 1) {
3287 CATLSTR(buf, bufsz, _("%s Will never achieve veteran status.\n"), BULLET);
3288 }
3289 } else {
3290 /* Not useful currently: */
3291#if 0
3292 /* Some units can never become veteran through combat in practice. */
3295 && utype->defense_strength == 0);
3296#endif
3297 /* FIXME: if we knew the raise chances on the client, we could be
3298 * more specific here about whether veteran status can be acquired
3299 * through combat/missions/work. Should also take into account
3300 * UTYF_NO_VETERAN when writing this text. (Gna patch #4794) */
3301 CATLSTR(buf, bufsz, _("%s May acquire veteran status.\n"), BULLET);
3302 if (utype_veteran_has_power_bonus(utype)) {
3304 || utype->defense_strength > 0) {
3305 CATLSTR(buf, bufsz,
3306 /* TRANS: indented; preserve leading spaces */
3307 _(" %s Veterans have increased strength in combat.\n"),
3308 BULLET);
3309 }
3310 /* SUPERSPY always wins/escapes */
3311 if (utype_has_flag(utype, UTYF_DIPLOMAT)
3312 && !utype_has_flag(utype, UTYF_SUPERSPY)) {
3313 CATLSTR(buf, bufsz,
3314 /* TRANS: indented; preserve leading spaces */
3315 _(" %s Veterans have improved chances in diplomatic "
3316 "contests.\n"), BULLET);
3317 if (utype_may_do_escape_action(utype)) {
3318 CATLSTR(buf, bufsz,
3319 /* TRANS: indented; preserve leading spaces */
3320 _(" %s Veterans are more likely to survive missions.\n"),
3321 BULLET);
3322 }
3323 }
3324 if (utype_has_flag(utype, UTYF_SETTLERS)) {
3325 CATLSTR(buf, bufsz,
3326 /* TRANS: indented; preserve leading spaces */
3327 _(" %s Veterans work faster.\n"), BULLET);
3328 }
3329 }
3330 }
3331 if (strlen(buf) > 0) {
3332 CATLSTR(buf, bufsz, "\n");
3333 }
3334 if (has_vet_levels && utype->veteran) {
3335 /* The case where the unit has only a single veteran level has already
3336 * been handled above, so keep quiet here if that happens */
3337 if (insert_veteran_help(buf, bufsz, utype->veteran,
3338 _("This type of unit has its own veteran levels:"), NULL)) {
3339 CATLSTR(buf, bufsz, "\n\n");
3340 }
3341 }
3342 if (NULL != utype->helptext) {
3343 strvec_iterate(utype->helptext, text) {
3344 CATLSTR(buf, bufsz, "%s\n\n", _(text));
3346 }
3347 CATLSTR(buf, bufsz, "%s", user_text);
3348
3349 return buf;
3350}
3351
3352/************************************************************************/
3357void helptext_advance(char *buf, size_t bufsz, struct player *pplayer,
3358 const char *user_text, int i)
3359{
3360 struct astring astr = ASTRING_INIT;
3362 struct universal source = {
3363 .kind = VUT_ADVANCE,
3364 .value = {.advance = vap}
3365 };
3366 int flagid;
3367
3368 fc_assert_ret(NULL != buf && 0 < bufsz && NULL != user_text);
3370
3371 if (NULL == vap) {
3372 log_error("Unknown tech %d.", i);
3373 return;
3374 }
3375
3376 if (game.control.num_tech_classes > 0) {
3377 if (vap->tclass == NULL) {
3378 cat_snprintf(buf, bufsz, _("Belongs to the default tech class.\n\n"));
3379 } else {
3380 cat_snprintf(buf, bufsz, _("Belongs to tech class %s.\n\n"),
3382 }
3383 }
3384
3385 if (NULL != pplayer) {
3386 const struct research *presearch = research_get(pplayer);
3387
3391
3393 PL_("Starting now, researching %s would need %d bulb.",
3394 "Starting now, researching %s would need %d bulbs.",
3395 bulbs),
3398 /* Split string into two to allow localization of two pluralizations. */
3399 char buf2[MAX_LEN_MSG];
3401
3403 /* TRANS: appended to another sentence. Preserve the
3404 * leading space. */
3405 PL_(" The whole project will require %d bulb to complete.",
3406 " The whole project will require %d bulbs to complete.",
3407 bulbs),
3408 bulbs);
3410 /* TRANS: last %s is a sentence pluralized separately. */
3411 PL_("To research %s you need to research %d other"
3412 " technology first.%s",
3413 "To research %s you need to research %d other"
3414 " technologies first.%s",
3418 } else {
3419 CATLSTR(buf, bufsz,
3420 _("You cannot research this technology."));
3421 }
3424 CATLSTR(buf, bufsz,
3425 /* TRANS: preserve leading space */
3426 _(" This number may vary depending on what "
3427 "other players research.\n"));
3428 } else {
3429 CATLSTR(buf, bufsz, "\n");
3430 }
3431 }
3432
3433 CATLSTR(buf, bufsz, "\n");
3434 }
3435
3436 if (requirement_vector_size(&vap->research_reqs) > 0) {
3437 CATLSTR(buf, bufsz, _("Requirements to research:\n"));
3438 requirement_vector_iterate(&vap->research_reqs, preq) {
3439 (void) req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "");
3441 CATLSTR(buf, bufsz, "\n");
3442 }
3443
3445 BULLET_SPACE);
3446
3447 {
3448 int j;
3449
3450 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3451 if (game.rgame.global_init_techs[j] == A_LAST) {
3452 break;
3453 } else if (game.rgame.global_init_techs[j] == i) {
3454 CATLSTR(buf, bufsz,
3455 _("%s All players start the game with knowledge of this "
3456 "technology.\n"), BULLET);
3457 break;
3458 }
3459 }
3460 }
3461
3462 /* Assume no-one will set the same tech in both global and nation
3463 * init_tech... */
3464 nations_iterate(pnation) {
3465 int j;
3466
3467 /* Avoid mentioning nations not in current set. */
3468 if (!show_help_for_nation(pnation)) {
3469 continue;
3470 }
3471 for (j = 0; j < MAX_NUM_TECH_LIST; j++) {
3472 if (pnation->init_techs[j] == A_LAST) {
3473 break;
3474 } else if (pnation->init_techs[j] == i) {
3476 /* TRANS: %s is a nation plural */
3477 _("%s The %s start the game with knowledge of this "
3478 "technology.\n"), BULLET,
3479 nation_plural_translation(pnation));
3480 break;
3481 }
3482 }
3484
3485 /* Explain the effects of root_reqs. */
3486 {
3488
3492 if (proot == vap) {
3493 /* Don't say anything at all if this tech is a self-root-req one;
3494 * assume that the ruleset help will explain how to get it. */
3496 break;
3497 }
3500 /* Now find out what roots each of this tech's root_req has, so that
3501 * we can suppress them. If tech A has roots B/C, and B has root C,
3502 * it's not worth saying that A needs C, and can lead to overwhelming
3503 * lists. */
3504 /* (Special case: don't do this if the root is a self-root-req tech,
3505 * since it would appear in its own root iteration; in the scenario
3506 * where S is a self-root tech that is root for T, this would prevent
3507 * S appearing in T's help.) */
3508 /* FIXME this is quite inefficient */
3512 }
3514
3515 /* Filter out all but the direct root reqs. */
3517
3518 if (BV_ISSET_ANY(roots)) {
3519 const char *root_techs[A_LAST];
3520 size_t n_roots = 0;
3522
3524 if (BV_ISSET(roots, root)) {
3527 }
3529 fc_assert(n_roots > 0);
3531 /* TRANS: 'and'-separated list of techs */
3532 _("%s Only those who know %s can acquire this "
3533 "technology (by any means).\n"),
3534 BULLET,
3537 }
3538 }
3539
3542 _("%s The first player to learn %s gets"
3543 " an immediate advance.\n"), BULLET,
3545 }
3546
3548 if (advance_has_flag(i, flagid)) {
3549 const char *helptxt = tech_flag_helptxt(flagid);
3550
3551 if (helptxt != NULL) {
3552 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3553 }
3554 }
3555 }
3556
3558 CATLSTR(buf, bufsz,
3559 _("%s To preserve this technology for our nation some bulbs "
3560 "are needed each turn.\n"), BULLET);
3561 }
3562
3563 if (NULL != vap->helptext) {
3564 if (strlen(buf) > 0) {
3565 CATLSTR(buf, bufsz, "\n");
3566 }
3567 strvec_iterate(vap->helptext, text) {
3568 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3570 }
3571
3572 astr_free(&astr);
3573}
3574
3575/************************************************************************/
3578void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer,
3579 const char *user_text, struct terrain *pterrain)
3580{
3581 struct universal source = {
3582 .kind = VUT_TERRAIN,
3583 .value = {.terrain = pterrain}
3584 };
3585 int flagid;
3586
3587 fc_assert_ret(NULL != buf && 0 < bufsz);
3588 buf[0] = '\0';
3589
3590 if (!pterrain) {
3591 log_error("Unknown terrain!");
3592 return;
3593 }
3594
3596 BULLET_SPACE);
3597 if (terrain_has_flag(pterrain, TER_NO_CITIES)) {
3598 CATLSTR(buf, bufsz,
3599 _("%s You cannot build cities on this terrain.\n"),
3600 BULLET);
3601 }
3603 /* Can't build roads; only mention if ruleset has buildable roads */
3605 if (pextra->buildable) {
3606 CATLSTR(buf, bufsz,
3607 _("%s Paths cannot be built on this terrain.\n"),
3608 BULLET);
3609 break;
3610 }
3612 }
3614 /* Can't build bases; only mention if ruleset has buildable bases */
3616 if (pextra->buildable) {
3617 CATLSTR(buf, bufsz,
3618 _("%s Bases cannot be built on this terrain.\n"),
3619 BULLET);
3620 break;
3621 }
3623 }
3624 if (terrain_has_flag(pterrain, TER_UNSAFE_COAST)
3625 && terrain_type_terrain_class(pterrain) != TC_OCEAN) {
3626 CATLSTR(buf, bufsz,
3627 _("%s The coastline of this terrain is unsafe.\n"),
3628 BULLET);
3629 }
3630 {
3631 const char *classes[uclass_count()];
3632 int i = 0;
3633
3634 unit_class_iterate(uclass) {
3635 if (is_native_to_class(uclass, pterrain, NULL)) {
3636 classes[i++] = uclass_name_translation(uclass);
3637 }
3639
3640 if (0 < i) {
3641 struct astring list = ASTRING_INIT;
3642
3643 /* TRANS: %s is a list of unit classes separated by "and". */
3644 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
3646 astr_free(&list);
3647 }
3648 }
3649 if (terrain_has_flag(pterrain, TER_NO_ZOC)) {
3650 CATLSTR(buf, bufsz,
3651 _("%s Units on this terrain neither impose zones of control "
3652 "nor are restricted by them.\n"), BULLET);
3653 } else {
3654 CATLSTR(buf, bufsz,
3655 _("%s Units on this terrain may impose a zone of control, or "
3656 "be restricted by one.\n"), BULLET);
3657 }
3658 for (flagid = TER_USER_1 ; flagid <= TER_USER_LAST; flagid++) {
3659 if (terrain_has_flag(pterrain, flagid)) {
3660 const char *helptxt = terrain_flag_helptxt(flagid);
3661
3662 if (helptxt != NULL) {
3663 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
3664 }
3665 }
3666 }
3667
3668 if (NULL != pterrain->helptext) {
3669 if (buf[0] != '\0') {
3670 CATLSTR(buf, bufsz, "\n");
3671 }
3672 strvec_iterate(pterrain->helptext, text) {
3673 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3675 }
3676 if (user_text && user_text[0] != '\0') {
3677 CATLSTR(buf, bufsz, "\n\n%s", user_text);
3678 }
3679}
3680
3681/************************************************************************/
3688const char *helptext_road_bonus_str(const struct terrain *pterrain,
3689 const struct road_type *proad)
3690{
3691 static char str[64];
3692 bool has_effect = FALSE;
3693
3694 str[0] = '\0';
3696 switch (o) {
3697 case O_FOOD:
3698 case O_SHIELD:
3699 case O_TRADE:
3700 {
3701 int bonus = proad->tile_bonus[o];
3702 int incr = proad->tile_incr_const[o];
3703
3704 if (pterrain) {
3705 incr +=
3706 proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3707 }
3708 if (str[0] != '\0') {
3709 CATLSTR(str, sizeof(str), "/");
3710 }
3711 if (incr == 0 && bonus == 0) {
3712 cat_snprintf(str, sizeof(str), "%d", incr);
3713 } else {
3714 has_effect = TRUE;
3715 if (incr != 0) {
3716 cat_snprintf(str, sizeof(str), "%+d", incr);
3717 }
3718 if (bonus != 0) {
3719 cat_snprintf(str, sizeof(str), "%+d%%", bonus);
3720 }
3721 }
3722 }
3723 break;
3724 default:
3725 /* FIXME: there's nothing actually stopping roads having gold, etc
3726 * bonuses */
3727 fc_assert(proad->tile_incr_const[o] == 0
3728 && proad->tile_incr[o] == 0
3729 && proad->tile_bonus[o] == 0);
3730 break;
3731 }
3733
3734 return has_effect ? str : NULL;
3735}
3736
3737/**********************************************************************/
3743static void extra_bonus_for_terrain(struct extra_type *pextra,
3744 struct terrain *pterrain,
3745 int *bonus)
3746{
3747 struct universal req_pattern[] = {
3748 { .kind = VUT_EXTRA, .value.extra = pextra },
3749 { .kind = VUT_TERRAIN, .value.terrain = pterrain },
3750 { .kind = VUT_OTYPE /* value filled in later */ }
3751 };
3752
3753 fc_assert_ret(bonus != NULL);
3754
3755 /* Irrigation-like food bonuses */
3756 bonus[0] = (pterrain->irrigation_food_incr
3758 2 /* just extra+terrain */)) / 100;
3759
3760 /* Mining-like shield bonuses */
3761 bonus[1] = (pterrain->mining_shield_incr
3763 2 /* just extra+terrain */)) / 100;
3764
3765 bonus[2] = 0; /* no trade bonuses so far */
3766
3767 /* Now add fixed bonuses from roads (but not percentage bonus) */
3768 if (extra_road_get(pextra)) {
3769 const struct road_type *proad = extra_road_get(pextra);
3770
3772 switch (o) {
3773 case O_FOOD:
3774 case O_SHIELD:
3775 case O_TRADE:
3776 bonus[o] += proad->tile_incr_const[o]
3777 + proad->tile_incr[o] * pterrain->road_output_incr_pct[o] / 100;
3778 break;
3779 default:
3780 /* not dealing with other output types here */
3781 break;
3782 }
3784 }
3785
3786 /* Fixed bonuses for extra, possibly unrelated to terrain type */
3787
3789 /* Fill in rest of requirement template */
3790 req_pattern[2].value.outputtype = o;
3791 switch (o) {
3792 case O_FOOD:
3793 case O_SHIELD:
3794 case O_TRADE:
3798 /* Any of the above bonuses is sufficient to trigger
3799 * Output_Inc_Tile, if underlying terrain does not */
3800 if (bonus[o] > 0 || pterrain->output[o] > 0) {
3804 }
3805 break;
3806 default:
3807 break;
3808 }
3810}
3811
3812/**********************************************************************/
3819 struct terrain *pterrain,
3820 enum unit_activity act)
3821{
3822 static char buffer[256];
3823 int btime;
3824 int bonus[3];
3825
3826 btime = terrain_extra_build_time(pterrain, act, pextra);
3827 fc_snprintf(buffer, sizeof(buffer), PL_("%d turn", "%d turns", btime),
3828 btime);
3829 extra_bonus_for_terrain(pextra, pterrain, bonus);
3830 if (bonus[0] > 0) {
3831 cat_snprintf(buffer, sizeof(buffer),
3832 PL_(", +%d food", ", +%d food", bonus[0]), bonus[0]);
3833 }
3834 if (bonus[1] > 0) {
3835 cat_snprintf(buffer, sizeof(buffer),
3836 PL_(", +%d shield", ", +%d shields", bonus[1]), bonus[1]);
3837 }
3838 if (bonus[2] > 0) {
3839 cat_snprintf(buffer, sizeof(buffer),
3840 PL_(", +%d trade", ", +%d trade", bonus[2]), bonus[2]);
3841 }
3842
3843 return buffer;
3844}
3845
3846/************************************************************************/
3852void helptext_extra(char *buf, size_t bufsz, struct player *pplayer,
3853 const char *user_text, struct extra_type *pextra)
3854{
3855 size_t group_start;
3856 struct base_type *pbase;
3857 struct road_type *proad;
3858 struct universal source = {
3859 .kind = VUT_EXTRA,
3860 .value = {.extra = pextra}
3861 };
3862
3863 int flagid;
3864
3865 fc_assert_ret(NULL != buf && 0 < bufsz);
3866 buf[0] = '\0';
3867
3868 if (!pextra) {
3869 log_error("Unknown extra!");
3870 return;
3871 }
3872
3873 if (is_extra_caused_by(pextra, EC_BASE)) {
3874 pbase = pextra->data.base;
3875 } else {
3876 pbase = NULL;
3877 }
3878
3879 if (is_extra_caused_by(pextra, EC_ROAD)) {
3880 proad = pextra->data.road;
3881 } else {
3882 proad = NULL;
3883 }
3884
3885 if (pextra->helptext != NULL) {
3886 strvec_iterate(pextra->helptext, text) {
3887 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
3889 }
3890
3891 /* Describe how extra is created and destroyed */
3892
3894
3895 if (pextra->buildable) {
3896 if (is_extra_caused_by(pextra, EC_IRRIGATION)) {
3897 CATLSTR(buf, bufsz,
3898 _("Build by issuing an \"irrigate\" order.\n"));
3899 }
3900 if (is_extra_caused_by(pextra, EC_MINE)) {
3901 CATLSTR(buf, bufsz,
3902 _("Build by issuing a \"mine\" order.\n"));
3903 }
3904 if (is_extra_caused_by(pextra, EC_ROAD)) {
3905 CATLSTR(buf, bufsz,
3906 _("Build by issuing a \"road\" order.\n"));
3907 }
3908 if (is_extra_caused_by(pextra, EC_BASE)) {
3909 fc_assert(pbase != NULL);
3910
3911 if (pbase->gui_type == BASE_GUI_OTHER) {
3913 _("Build by issuing a \"build base\" order.\n"));
3914 } else {
3915 const char *order = "";
3916
3917 switch (pbase->gui_type) {
3918 case BASE_GUI_FORTRESS:
3919 order = Q_(terrain_control.gui_type_base0);
3920 break;
3921 case BASE_GUI_AIRBASE:
3922 order = Q_(terrain_control.gui_type_base1);
3923 break;
3924 default:
3926 break;
3927 }
3929 /* TRANS: %s is a gui_type base string from a ruleset */
3930 _("Build by issuing a \"%s\" order.\n"), order);
3931 }
3932 }
3933 }
3934
3935 if (is_extra_caused_by(pextra, EC_POLLUTION)) {
3936 CATLSTR(buf, bufsz,
3937 _("May randomly appear around polluting city.\n"));
3938 }
3939
3940 if (is_extra_caused_by(pextra, EC_FALLOUT)) {
3941 CATLSTR(buf, bufsz,
3942 _("May randomly appear around nuclear blast.\n"));
3943 }
3944
3945 if (pextra->generated
3946 && (is_extra_caused_by(pextra, EC_HUT)
3948 || (proad != NULL && road_has_flag(proad, RF_RIVER)))) {
3949 CATLSTR(buf, bufsz,
3950 _("Placed by map generator.\n"));
3951 }
3952
3953 if (is_extra_removed_by(pextra, ERM_ENTER)) {
3954 CATLSTR(buf, bufsz,
3955 _("Can be explored by certain units.\n"));
3956 }
3957
3958 if (is_extra_caused_by(pextra, EC_APPEARANCE)) {
3959 CATLSTR(buf, bufsz,
3960 _("May appear spontaneously.\n"));
3961 }
3962
3963 if (requirement_vector_size(&pextra->reqs) > 0) {
3964 char reqsbuf[8192] = "";
3965 bool buildable = pextra->buildable
3967
3969 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
3971 buildable ? BULLET_SPACE : "");
3973 if (reqsbuf[0] != '\0') {
3974 if (buildable) {
3975 CATLSTR(buf, bufsz, _("Requirements to build:\n"));
3976 }
3977 CATLSTR(buf, bufsz, "%s", reqsbuf);
3978 }
3979 }
3980
3981 if (pextra->infracost > 0) {
3982 cat_snprintf(buf, bufsz, _("Cost: %d\n"), pextra->infracost);
3983 }
3984
3985 if (buf[group_start] != '\0') {
3986 CATLSTR(buf, bufsz, "\n"); /* group separator */
3987 }
3988
3990
3991 if (is_extra_removed_by(pextra, ERM_PILLAGE)) {
3992 int pillage_time = -1;
3993
3994 if (pextra->removal_time != 0) {
3995 pillage_time = pextra->removal_time;
3996 } else {
3997 terrain_type_iterate(pterrain) {
3998 int terr_pillage_time = pterrain->pillage_time
3999 * pextra->removal_time_factor;
4000
4001 if (terr_pillage_time != 0) {
4002 if (pillage_time < 0) {
4003 pillage_time = terr_pillage_time;
4004 } else if (pillage_time != terr_pillage_time) {
4005 /* Give up */
4006 pillage_time = -1;
4007 break;
4008 }
4009 }
4011 }
4012 if (pillage_time < 0) {
4013 CATLSTR(buf, bufsz,
4014 _("Can be pillaged by units (time is terrain-dependent).\n"));
4015 } else if (pillage_time > 0) {
4017 PL_("Can be pillaged by units (takes %d turn).\n",
4018 "Can be pillaged by units (takes %d turns).\n",
4019 pillage_time), pillage_time);
4020 }
4021 }
4022 if (is_extra_removed_by(pextra, ERM_CLEAN)) {
4023 int clean_time = -1;
4024
4025 if (pextra->removal_time != 0) {
4026 clean_time = pextra->removal_time;
4027 } else {
4028 terrain_type_iterate(pterrain) {
4029 int terr_clean_time = -1;
4030 int rmtime = pterrain->extra_removal_times[extra_index(pextra)];
4031
4032 if (rmtime != 0) {
4034 }
4035
4036 if (clean_time < 0) {
4038 } else if (clean_time != terr_clean_time) {
4039 /* Give up */
4040 clean_time = -1;
4041 break;
4042 }
4044 }
4045
4046 if (clean_time < 0) {
4047 CATLSTR(buf, bufsz,
4048 _("Can be cleaned by units (time is terrain-dependent).\n"));
4049 } else if (clean_time > 0) {
4051 PL_("Can be cleaned by units (takes %d turn).\n",
4052 "Can be cleaned by units (takes %d turns).\n",
4054 }
4055 }
4056
4057 if (requirement_vector_size(&pextra->rmreqs) > 0) {
4058 char reqsbuf[8192] = "";
4059
4061 (void) req_text_insert_nl(reqsbuf, sizeof(reqsbuf), pplayer, preq,
4064 if (reqsbuf[0] != '\0') {
4065 CATLSTR(buf, bufsz, _("Requirements to remove:\n"));
4066 CATLSTR(buf, bufsz, "%s", reqsbuf);
4067 }
4068 }
4069
4070 if (buf[group_start] != '\0') {
4071 CATLSTR(buf, bufsz, "\n"); /* group separator */
4072 }
4073
4074 /* Describe what other elements are enabled by extra */
4075
4077
4079
4080 if (buf[group_start] != '\0') {
4081 CATLSTR(buf, bufsz, "\n"); /* group separator */
4082 }
4083
4084 /* Describe other properties of extras */
4085
4086 if (pextra->visibility_req != A_NONE) {
4087 char vrbuf[1024];
4088
4089 fc_snprintf(vrbuf, sizeof(vrbuf),
4090 _("%s Visible only if %s known.\n"), BULLET,
4092 CATLSTR(buf, bufsz, "%s", vrbuf);
4093 }
4094
4095 if (pextra->eus == EUS_HIDDEN) {
4096 CATLSTR(buf, bufsz,
4097 _("%s Units inside are hidden from non-allied players.\n"),
4098 BULLET);
4099 }
4100
4101 {
4102 const char *classes[uclass_count()];
4103 int i = 0;
4104
4105 unit_class_iterate(uclass) {
4106 if (is_native_extra_to_uclass(pextra, uclass)) {
4107 classes[i++] = uclass_name_translation(uclass);
4108 }
4110
4111 if (0 < i) {
4112 struct astring list = ASTRING_INIT;
4113
4114 if (proad != NULL) {
4115 /* TRANS: %s is a list of unit classes separated by "and". */
4116 cat_snprintf(buf, bufsz, _("%s Can be traveled by %s units.\n"),
4117 BULLET,
4119 } else {
4120 /* TRANS: %s is a list of unit classes separated by "and". */
4121 cat_snprintf(buf, bufsz, _("%s Native to %s units.\n"),
4122 BULLET,
4124 }
4125 astr_free(&list);
4126
4127 if (extra_has_flag(pextra, EF_NATIVE_TILE)) {
4128 CATLSTR(buf, bufsz,
4129 /* TRANS: indented; preserve leading spaces */
4130 _(" %s Such units can move onto this tile even if it would "
4131 "not normally be suitable terrain.\n"), BULLET);
4132 }
4133
4134 if (pextra->no_aggr_near_city >= 0) {
4135 CATLSTR(buf, bufsz,
4136 /* TRANS: indented; preserve leading spaces */
4137 PL_(" %s Such units situated here are not considered aggressive "
4138 "if this tile is within %d tile of a friendly city.\n",
4139 " %s Such units situated here are not considered aggressive "
4140 "if this tile is within %d tiles of a friendly city.\n",
4141 pextra->no_aggr_near_city),
4142 BULLET, pextra->no_aggr_near_city);
4143 }
4144
4145 if (pextra->defense_bonus) {
4147 /* TRANS: indented; preserve leading spaces */
4148 _(" %s Such units get a %d%% defense bonus on this "
4149 "tile.\n"), BULLET,
4150 pextra->defense_bonus);
4151 }
4152 }
4153 }
4154
4156 const char *conquerors[utype_count()];
4157 int i = 0;
4158
4163 }
4165
4166 if (i > 0) {
4167 struct astring list = ASTRING_INIT;
4169 /* TRANS: %s is a list of unit types separated by "and". */
4170 _("%s Can be conquered by %s.\n"), BULLET,
4172 astr_free(&list);
4173 }
4174 }
4175
4177 if (proad->move_cost == 0) {
4178 CATLSTR(buf, bufsz, _("%s Allows infinite movement.\n"), BULLET);
4179 } else {
4181 /* TRANS: "MP" = movement points. Second %s may have a
4182 * fractional part. */
4183 _("%s Movement cost along %s is %s MP.\n"),
4184 BULLET,
4185 extra_name_translation(pextra),
4186 move_points_text(proad->move_cost, TRUE));
4187 }
4188 }
4189
4190 if (game.info.killstack
4191 && extra_has_flag(pextra, EF_NO_STACK_DEATH)) {
4192 CATLSTR(buf, bufsz,
4193 _("%s Defeat of one unit does not cause death of all other units "
4194 "on this tile.\n"), BULLET);
4195 }
4196 if (pbase != NULL) {
4198 CATLSTR(buf, bufsz,
4199 _("%s Extends national borders of the building nation.\n"),
4200 BULLET);
4201 }
4202 if (pbase->vision_main_sq >= 0) {
4203 CATLSTR(buf, bufsz,
4204 _("%s Grants permanent vision of an area around the tile to "
4205 "its owner.\n"), BULLET);
4206 }
4207 if (pbase->vision_invis_sq >= 0) {
4208 CATLSTR(buf, bufsz,
4209 _("%s Allows the owner to see normally invisible stealth units "
4210 "in an area around the tile.\n"), BULLET);
4211 }
4212 if (pbase->vision_subs_sq >= 0) {
4213 CATLSTR(buf, bufsz,
4214 _("%s Allows the owner to see normally invisible subsurface units "
4215 "in an area around the tile.\n"), BULLET);
4216 }
4217 }
4219 if (extra_has_flag(pextra, flagid)) {
4220 const char *helptxt = extra_flag_helptxt(flagid);
4221
4222 if (helptxt != NULL) {
4223 CATLSTR(buf, bufsz, "%s %s\n", BULLET, _(helptxt));
4224 }
4225 }
4226 }
4227
4228 /* Table of terrain-specific attributes, if needed */
4229 if (proad != NULL || pbase != NULL) {
4230 bool road, do_time, do_bonus;
4231
4232 road = (proad != NULL);
4233 /* Terrain-dependent build time? */
4234 do_time = pextra->buildable && pextra->build_time == 0;
4235 if (road) {
4236 /* Terrain-dependent output bonus? */
4237 do_bonus = FALSE;
4239 if (proad->tile_incr[o] > 0) {
4240 do_bonus = TRUE;
4241 fc_assert(o == O_FOOD || o == O_SHIELD || o == O_TRADE);
4242 }
4244 } else {
4245 /* Bases don't have output bonuses */
4246 do_bonus = FALSE;
4247 }
4248
4249 if (do_time || do_bonus) {
4250 if (do_time && do_bonus) {
4251 CATLSTR(buf, bufsz,
4252 _("\nTime to build and output bonus depends on terrain:\n\n"));
4253 CATLSTR(buf, bufsz,
4254 /* TRANS: Header for fixed-width road properties table.
4255 * TRANS: Translators cannot change column widths :( */
4256 _("Terrain Time Bonus F/P/T\n"
4257 "----------------------------------\n"));
4258 } else if (do_time) {
4259 CATLSTR(buf, bufsz,
4260 _("\nTime to build depends on terrain:\n\n"));
4261 CATLSTR(buf, bufsz,
4262 /* TRANS: Header for fixed-width extra properties table.
4263 * TRANS: Translators cannot change column widths :( */
4264 _("Terrain Time\n"
4265 "------------------\n"));
4266 } else {
4268 CATLSTR(buf, bufsz,
4269 /* TRANS: Header for fixed-width road properties table.
4270 * TRANS: Translators cannot change column widths :( */
4271 _("\nYields an output bonus with some terrains:\n\n"));
4272 CATLSTR(buf, bufsz,
4273 _("Terrain Bonus F/P/T\n"
4274 "-------------------------\n"));;
4275 }
4277 int turns = road ? terrain_extra_build_time(t, ACTIVITY_GEN_ROAD, pextra)
4279 const char *bonus_text
4281 if (turns > 0 || bonus_text) {
4282 const char *terrain = terrain_name_translation(t);
4284
4286 "%s%*s ", terrain,
4287 MAX(0, slen),
4288 "");
4289 if (do_time) {
4290 if (turns > 0) {
4291 cat_snprintf(buf, bufsz, "%3d ", turns);
4292 } else {
4293 CATLSTR(buf, bufsz, " - ");
4294 }
4295 }
4296 if (do_bonus) {
4297 fc_assert(proad != NULL);
4298 cat_snprintf(buf, bufsz, " %s", bonus_text ? bonus_text : "-");
4299 }
4300 CATLSTR(buf, bufsz, "\n");
4301 }
4303 } /* else rely on client-specific display */
4304 }
4305
4306 if (user_text && user_text[0] != '\0') {
4307 CATLSTR(buf, bufsz, "\n\n%s", user_text);
4308 }
4309}
4310
4311/************************************************************************/
4317void helptext_goods(char *buf, size_t bufsz, struct player *pplayer,
4318 const char *user_text, struct goods_type *pgood)
4319{
4320 bool reqs = FALSE;
4321
4322 fc_assert_ret(NULL != buf && 0 < bufsz);
4323 buf[0] = '\0';
4324
4325 if (NULL != pgood->helptext) {
4326 strvec_iterate(pgood->helptext, text) {
4327 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4329 }
4330
4331 if (pgood->onetime_pct == 0) {
4333 _("There's no bonuses paid when trade route gets established.\n\n"));
4334 } else if (pgood->onetime_pct != 100) {
4336 _("When trade route gets established, %d%% of the normal bonus is paid.\n"),
4337 pgood->onetime_pct);
4338 }
4339 cat_snprintf(buf, bufsz, _("Sending city enjoys %d%% income from the route.\n"),
4340 pgood->from_pct);
4341 cat_snprintf(buf, bufsz, _("Receiving city enjoys %d%% income from the route.\n\n"),
4342 pgood->to_pct);
4343
4344 /* Requirements for this good. */
4346 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4347 reqs = TRUE;
4348 }
4350 if (reqs) {
4351 fc_strlcat(buf, "\n", bufsz);
4352 }
4353
4354 CATLSTR(buf, bufsz, "%s", user_text);
4355}
4356
4357/************************************************************************/
4363void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer,
4364 const char *user_text, struct specialist *pspec)
4365{
4366 bool reqs = FALSE;
4367
4368 fc_assert_ret(NULL != buf && 0 < bufsz);
4369 buf[0] = '\0';
4370
4371 if (NULL != pspec->helptext) {
4372 strvec_iterate(pspec->helptext, text) {
4373 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4375 }
4376
4377 /* Requirements for this specialist. */
4379 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4380 reqs = TRUE;
4381 }
4383 if (reqs) {
4384 fc_strlcat(buf, "\n", bufsz);
4385 }
4386
4387 CATLSTR(buf, bufsz, "%s", user_text);
4388}
4389
4390/************************************************************************/
4398void helptext_government(char *buf, size_t bufsz, struct player *pplayer,
4399 const char *user_text, struct government *gov)
4400{
4401 bool reqs = FALSE;
4402 struct universal source = {
4404 .value = {.govern = gov}
4405 };
4406
4407 fc_assert_ret(NULL != buf && 0 < bufsz);
4408 buf[0] = '\0';
4409
4410 if (NULL != gov->helptext) {
4411 strvec_iterate(gov->helptext, text) {
4412 cat_snprintf(buf, bufsz, "%s\n\n", _(text));
4414 }
4415
4416 /* Add requirement text for government itself */
4418 if (req_text_insert_nl(buf, bufsz, pplayer, preq, VERB_DEFAULT, "")) {
4419 reqs = TRUE;
4420 }
4422 if (reqs) {
4423 fc_strlcat(buf, "\n", bufsz);
4424 }
4425
4426 /* Effects */
4427 CATLSTR(buf, bufsz, _("Features:\n"));
4429 BULLET_SPACE);
4432 struct unit_class *unitclass = NULL;
4433 const struct unit_type *unittype = NULL;
4435 struct strvec *outputs = strvec_new();
4438 bool too_complex = FALSE;
4439 bool world_value_valid = TRUE;
4440
4441 /* Grab output type, if there is one */
4443 /* Treat an effect with any negated requirements as too complex for
4444 * us to explain here.
4445 * Also don't try to explain an effect with any requirements explicitly
4446 * marked as 'quiet' by ruleset author. */
4447 if (!preq->present || preq->quiet) {
4448 too_complex = TRUE;
4449 continue;
4450 }
4451 switch (preq->source.kind) {
4452 case VUT_OTYPE:
4453 /* We should never have multiple outputtype requirements
4454 * in one list in the first place (it simply makes no sense,
4455 * output cannot be of multiple types)
4456 * Ruleset loading code should check against that. */
4458 output_type = preq->source.value.outputtype;
4460 break;
4461 case VUT_UCLASS:
4463 unitclass = preq->source.value.uclass;
4464 /* FIXME: can't easily get world bonus for unit class */
4466 break;
4467 case VUT_UTYPE:
4468 fc_assert(unittype == NULL);
4469 unittype = preq->source.value.utype;
4470 break;
4471 case VUT_UTFLAG:
4472 if (!unit_type_flag_id_is_valid(unitflag)) {
4473 unitflag = preq->source.value.unitflag;
4474 /* FIXME: can't easily get world bonus for unit type flag */
4476 } else {
4477 /* Already have a unit flag requirement. More than one is too
4478 * complex for us to explain, so say nothing. */
4479 /* FIXME: we could handle this */
4480 too_complex = TRUE;
4481 }
4482 break;
4483 case VUT_GOVERNMENT:
4484 /* This is government we are generating helptext for.
4485 * ...or if not, it's ruleset bug that should never make it
4486 * this far. Fix ruleset loading code. */
4487 fc_assert(preq->source.value.govern == gov);
4488 break;
4489 default:
4490 too_complex = TRUE;
4492 break;
4493 };
4495
4496 if (!too_complex) {
4497 /* Only list effects that don't have extra requirements too complex
4498 * for us to handle.
4499 * Anything more complicated will have to be documented by hand by the
4500 * ruleset author. */
4501
4502 /* Guard condition for simple player-wide effects descriptions.
4503 * (FIXME: in many cases, e.g. EFT_MAKE_CONTENT, additional requirements
4504 * like unittype will be ignored for gameplay, but will affect our
4505 * help here.) */
4506 const bool playerwide
4507 = world_value_valid && !unittype && (output_type == O_LAST);
4508 /* In some cases we give absolute values (world bonus + gov bonus).
4509 * We assume the fact that there's an effect with a gov requirement
4510 * is sufficient reason to list it in that gov's help.
4511 * Guard accesses to these with 'playerwide' or 'world_value_valid'. */
4512 int world_value = -999, net_value = -999;
4513 if (world_value_valid) {
4514 /* Get government-independent world value of effect if the extra
4515 * requirements were simple enough. */
4516 struct output_type *potype =
4518
4519 world_value =
4521 &(const struct req_context) {
4522 .unittype = unittype,
4523 .output = potype,
4524 },
4525 NULL,
4526 peffect->type);
4527 net_value = peffect->value + world_value;
4528 }
4529
4530 if (output_type == O_LAST) {
4531 /* There was no outputtype requirement. Effect is active for all
4532 * output types. Generate lists for that. */
4533 bool harvested_only = TRUE; /* Consider only output types from fields */
4534
4535 if (peffect->type == EFT_UPKEEP_FACTOR
4537 || peffect->type == EFT_OUTPUT_BONUS
4538 || peffect->type == EFT_OUTPUT_BONUS_2) {
4539 /* Effect can use or require any kind of output */
4541 }
4542
4544 struct output_type *pot = get_output_type(ot);
4545
4546 if (!harvested_only || pot->harvested) {
4547 strvec_append(outputs, _(pot->name));
4548 }
4550 }
4551
4552 if (0 == strvec_size(outputs)) {
4553 /* TRANS: Empty output type list, should never happen. */
4554 astr_set(&outputs_or, "%s", Q_("?outputlist: Nothing "));
4555 astr_set(&outputs_and, "%s", Q_("?outputlist: Nothing "));
4556 } else {
4559 }
4560
4561 switch (peffect->type) {
4562 case EFT_UNHAPPY_FACTOR:
4563 if (playerwide) {
4564 /* FIXME: EFT_MAKE_CONTENT_MIL_PER would cancel this out. We assume
4565 * no-one will set both, so we don't bother handling it. */
4567 PL_("%s Military units away from home and field units"
4568 " will each cause %d citizen to become unhappy.\n",
4569 "%s Military units away from home and field units"
4570 " will each cause %d citizens to become unhappy.\n",
4571 net_value),
4572 BULLET, net_value);
4573 } /* else too complicated or silly ruleset */
4574 break;
4576 if (playerwide && net_value != world_value) {
4577 if (world_value > 0) {
4578 if (net_value > 0) {
4580 _("%s Unhappiness from foreign citizens due to "
4581 "war with their home state is %d%% the usual "
4582 "value.\n"), BULLET,
4583 (net_value * 100) / world_value);
4584 } else {
4585 CATLSTR(buf, bufsz,
4586 _("%s No unhappiness from foreign citizens even when "
4587 "at war with their home state.\n"), BULLET);
4588 }
4589 } else {
4591 /* TRANS: not pluralised as gettext doesn't support
4592 * fractional numbers, which this might be */
4593 _("%s Each foreign citizen causes %.2g unhappiness "
4594 "in their city while you are at war with their "
4595 "home state.\n"), BULLET,
4596 (double)net_value / 100);
4597 }
4598 }
4599 break;
4601 if (playerwide) {
4603 PL_("%s Each of your cities will avoid %d unhappiness"
4604 " caused by units.\n",
4605 "%s Each of your cities will avoid %d unhappiness"
4606 " caused by units.\n",
4607 peffect->value),
4608 BULLET, peffect->value);
4609 }
4610 break;
4611 case EFT_MAKE_CONTENT:
4612 if (playerwide) {
4614 PL_("%s Each of your cities will avoid %d unhappiness,"
4615 " not including that caused by aggression.\n",
4616 "%s Each of your cities will avoid %d unhappiness,"
4617 " not including that caused by aggression.\n",
4618 peffect->value),
4619 BULLET, peffect->value);
4620 }
4621 break;
4622 case EFT_FORCE_CONTENT:
4623 if (playerwide) {
4625 PL_("%s Each of your cities will avoid %d unhappiness,"
4626 " including that caused by aggression.\n",
4627 "%s Each of your cities will avoid %d unhappiness,"
4628 " including that caused by aggression.\n",
4629 peffect->value),
4630 BULLET, peffect->value);
4631 }
4632 break;
4633 case EFT_UPKEEP_FACTOR:
4634 if (world_value_valid && !unittype) {
4635 if (net_value == 0) {
4636 if (output_type != O_LAST) {
4638 /* TRANS: %s is the output type, like 'shield'
4639 * or 'gold'. */
4640 _("%s You pay no %s upkeep for your units.\n"),
4642 } else {
4643 CATLSTR(buf, bufsz,
4644 _("%s You pay no upkeep for your units.\n"),
4645 BULLET);
4646 }
4647 } else if (net_value != world_value) {
4648 double ratio = (double)net_value / world_value;
4649 if (output_type != O_LAST) {
4651 /* TRANS: %s is the output type, like 'shield'
4652 * or 'gold'. */
4653 _("%s You pay %.2g times normal %s upkeep for your "
4654 "units.\n"), BULLET,
4656 } else {
4658 _("%s You pay %.2g times normal upkeep for your "
4659 "units.\n"), BULLET,
4660 ratio);
4661 }
4662 } /* else this effect somehow has no effect; keep quiet */
4663 } /* else there was some extra condition making it complicated */
4664 break;
4666 if (!unittype) {
4667 if (output_type != O_LAST) {
4669 /* TRANS: %s is the output type, like 'shield' or
4670 * 'gold'; pluralised in %d but there is currently
4671 * no way to control the singular/plural name of the
4672 * output type; sorry */
4673 PL_("%s Each of your cities will avoid paying %d %s"
4674 " upkeep for your units.\n",
4675 "%s Each of your cities will avoid paying %d %s"
4676 " upkeep for your units.\n", peffect->value),
4677 BULLET,
4678 peffect->value, astr_str(&outputs_and));
4679 } else {
4681 /* TRANS: Amount is subtracted from upkeep cost
4682 * for each upkeep type. */
4683 PL_("%s Each of your cities will avoid paying %d"
4684 " upkeep for your units.\n",
4685 "%s Each of your cities will avoid paying %d"
4686 " upkeep for your units.\n", peffect->value),
4687 BULLET, peffect->value);
4688 }
4689 } /* else too complicated */
4690 break;
4692 if (playerwide) {
4694 _("%s If you lose your capital,"
4695 " the base chance of civil war is %d%%.\n"),
4696 BULLET, net_value);
4697 }
4698 break;
4700 if (playerwide) {
4702 PL_("%s You can have %d city before an "
4703 "additional unhappy citizen appears in each city "
4704 "due to civilization size.\n",
4705 "%s You can have up to %d cities before an "
4706 "additional unhappy citizen appears in each city "
4707 "due to civilization size.\n", net_value),
4708 BULLET, net_value);
4709 }
4710 break;
4712 if (playerwide) {
4714 PL_("%s After the first unhappy citizen due to"
4715 " civilization size, for each %d additional city"
4716 " another unhappy citizen will appear.\n",
4717 "%s After the first unhappy citizen due to"
4718 " civilization size, for each %d additional cities"
4719 " another unhappy citizen will appear.\n",
4720 net_value),
4721 BULLET, net_value);
4722 }
4723 break;
4724 case EFT_MAX_RATES:
4726 if (net_value < 100) {
4728 _("%s The maximum rate you can set for science,"
4729 " gold, or luxuries is %d%%.\n"),
4730 BULLET, net_value);
4731 } else {
4732 CATLSTR(buf, bufsz,
4733 _("%s Has unlimited science/gold/luxuries rates.\n"),
4734 BULLET);
4735 }
4736 }
4737 break;
4739 if (playerwide) {
4741 PL_("%s Your units may impose martial law."
4742 " Each military unit inside a city will force %d"
4743 " unhappy citizen to become content.\n",
4744 "%s Your units may impose martial law."
4745 " Each military unit inside a city will force %d"
4746 " unhappy citizens to become content.\n",
4747 peffect->value),
4748 BULLET, peffect->value);
4749 }
4750 break;
4752 if (playerwide && net_value < 100) {
4754 PL_("%s A maximum of %d unit in each city can enforce"
4755 " martial law.\n",
4756 "%s A maximum of %d units in each city can enforce"
4757 " martial law.\n",
4758 net_value),
4759 BULLET, net_value);
4760 }
4761 break;
4762 case EFT_RAPTURE_GROW:
4763 if (playerwide && net_value > 0) {
4765 _("%s You may grow your cities by means of "
4766 "celebrations."), BULLET);
4767 if (game.info.celebratesize > 1) {
4769 /* TRANS: Preserve leading space. %d should always be
4770 * 2 or greater. */
4771 _(" (Cities below size %d cannot grow in this way.)"),
4773 }
4774 cat_snprintf(buf, bufsz, "\n");
4775 }
4776 break;
4778 if (playerwide) {
4780 PL_("%s If a city is in disorder for more than %d turn "
4781 "in a row, government will fall into anarchy.\n",
4782 "%s If a city is in disorder for more than %d turns "
4783 "in a row, government will fall into anarchy.\n",
4784 net_value),
4785 BULLET, net_value);
4786 }
4787 break;
4788 case EFT_HAS_SENATE:
4789 if (playerwide && net_value > 0) {
4790 CATLSTR(buf, bufsz,
4791 _("%s Has a senate that may prevent declaration of war.\n"),
4792 BULLET);
4793 }
4794 break;
4796 if (playerwide && net_value > 0) {
4797 CATLSTR(buf, bufsz,
4798 _("%s Allows partisans when cities are taken by the "
4799 "enemy.\n"), BULLET);
4800 }
4801 break;
4803 if (playerwide && net_value > 0) {
4804 CATLSTR(buf, bufsz,
4805 _("%s Buildings that normally confer bonuses against"
4806 " unhappiness will instead give gold.\n"), BULLET);
4807 }
4808 break;
4809 case EFT_FANATICS:
4810 if (playerwide && net_value > 0) {
4811 struct strvec *fanatics = strvec_new();
4813
4817 }
4820 /* TRANS: %s is list of unit types separated by 'or' */
4821 _("%s Pays no upkeep for %s.\n"), BULLET,
4825 }
4826 break;
4827 case EFT_NO_UNHAPPY:
4828 if (playerwide && net_value > 0) {
4829 CATLSTR(buf, bufsz, _("%s Has no unhappy citizens.\n"), BULLET);
4830 }
4831 break;
4832 case EFT_VETERAN_BUILD:
4833 {
4834 int conditions = 0;
4835 if (unitclass) {
4836 conditions++;
4837 }
4838 if (unittype) {
4839 conditions++;
4840 }
4841 if (unit_type_flag_id_is_valid(unitflag)) {
4842 conditions++;
4843 }
4844 if (conditions > 1) {
4845 /* More than one requirement on units, too complicated for us
4846 * to describe. */
4847 break;
4848 }
4849 if (unitclass) {
4850 /* FIXME: account for multiple veteran levels, or negative
4851 * values. This might lie for complicated rulesets! */
4853 /* TRANS: %s is a unit class */
4854 Q_("?unitclass:* New %s units will be veteran.\n"),
4856 } else if (unit_type_flag_id_is_valid(unitflag)) {
4857 /* FIXME: same problems as unitclass */
4859 /* TRANS: %s is a (translatable) unit type flag */
4860 Q_("?unitflag:* New %s units will be veteran.\n"),
4862 } else if (unittype != NULL) {
4863 if (world_value_valid && net_value > 0) {
4864 /* Here we can be specific about veteran level, and get
4865 * net value correct. */
4866 int maxlvl = utype_veteran_system(unittype)->levels - 1;
4867 const struct veteran_level *vlevel =
4870 /* TRANS: "* New Partisan units will have the rank
4871 * of elite." */
4872 Q_("?unittype:%s New %s units will have the rank "
4873 "of %s.\n"), BULLET,
4874 utype_name_translation(unittype),
4876 } /* else complicated */
4877 } else {
4878 /* No extra criteria. */
4879 /* FIXME: same problems as above */
4881 _("%s New units will be veteran.\n"), BULLET);
4882 }
4883 }
4884 break;
4886 if (world_value_valid) {
4888 /* TRANS: %s is list of output types, with 'or';
4889 * pluralised in %d but of course the output types
4890 * can't be pluralised; sorry */
4891 PL_("%s Each worked tile that gives more than %d %s will"
4892 " suffer a -1 penalty, unless the city working it"
4893 " is celebrating.",
4894 "%s Each worked tile that gives more than %d %s will"
4895 " suffer a -1 penalty, unless the city working it"
4896 " is celebrating.", net_value),
4898 if (game.info.celebratesize > 1) {
4900 /* TRANS: Preserve leading space. %d should always be
4901 * 2 or greater. */
4902 _(" (Cities below size %d will not celebrate.)"),
4904 }
4905 cat_snprintf(buf, bufsz, "\n");
4906 }
4907 break;
4910 /* TRANS: %s is list of output types, with 'or' */
4911 PL_("%s Each worked tile with at least 1 %s will yield"
4912 " %d more of it while the city working it is"
4913 " celebrating.",
4914 "%s Each worked tile with at least 1 %s will yield"
4915 " %d more of it while the city working it is"
4916 " celebrating.", peffect->value),
4917 BULLET, astr_str(&outputs_or), peffect->value);
4918 if (game.info.celebratesize > 1) {
4920 /* TRANS: Preserve leading space. %d should always be
4921 * 2 or greater. */
4922 _(" (Cities below size %d will not celebrate.)"),
4924 }
4925 cat_snprintf(buf, bufsz, "\n");
4926 break;
4929 /* TRANS: %s is list of output types, with 'or' */
4930 PL_("%s Each worked tile with at least 1 %s will yield"
4931 " %d more of it.\n",
4932 "%s Each worked tile with at least 1 %s will yield"
4933 " %d more of it.\n", peffect->value),
4934 BULLET, astr_str(&outputs_or), peffect->value);
4935 break;
4936 case EFT_OUTPUT_BONUS:
4937 case EFT_OUTPUT_BONUS_2:
4938 /* FIXME: makes most sense iff world_value == 0 */
4940 /* TRANS: %s is list of output types, with 'and' */
4941 _("%s %s production is increased %d%%.\n"),
4942 BULLET, astr_str(&outputs_and), peffect->value);
4943 break;
4944 case EFT_OUTPUT_WASTE:
4945 if (world_value_valid) {
4946 if (net_value > 30) {
4948 /* TRANS: %s is list of output types, with 'and' */
4949 _("%s %s production will suffer massive losses.\n"),
4951 } else if (net_value >= 15) {
4953 /* TRANS: %s is list of output types, with 'and' */
4954 _("%s %s production will suffer some losses.\n"),
4956 } else if (net_value > 0) {
4958 /* TRANS: %s is list of output types, with 'and' */
4959 _("%s %s production will suffer a small amount "
4960 "of losses.\n"),
4962 }
4963 }
4964 break;
4965 case EFT_HEALTH_PCT:
4966 if (playerwide) {
4967 if (peffect->value > 0) {
4968 CATLSTR(buf, bufsz, _("%s Increases the chance of plague"
4969 " within your cities.\n"), BULLET);
4970 } else if (peffect->value < 0) {
4971 CATLSTR(buf, bufsz, _("%s Decreases the chance of plague"
4972 " within your cities.\n"), BULLET);
4973 }
4974 }
4975 break;
4977 /* Semi-arbitrary scaling to get likely ruleset values in roughly
4978 * the same range as WASTE_BY_DISTANCE */
4979 /* FIXME: use different wording? */
4980 net_value = (net_value + 39) / 40; /* round up */
4981 fc__fallthrough; /* fall through to: */
4983 if (world_value_valid) {
4984 if (net_value >= 300) {
4986 /* TRANS: %s is list of output types, with 'and' */
4987 _("%s %s losses will increase quickly"
4988 " with distance from capital.\n"),
4990 } else if (net_value >= 200) {
4992 /* TRANS: %s is list of output types, with 'and' */
4993 _("%s %s losses will increase"
4994 " with distance from capital.\n"),
4996 } else if (net_value > 0) {
4998 /* TRANS: %s is list of output types, with 'and' */
4999 _("%s %s losses will increase slowly"
5000 " with distance from capital.\n"),
5002 }
5003 }
5004 break;
5005 case EFT_MIGRATION_PCT:
5006 if (playerwide) {
5007 if (peffect->value > 0) {
5008 CATLSTR(buf, bufsz, _("%s Increases the chance of migration"
5009 " into your cities.\n"), BULLET);
5010 } else if (peffect->value < 0) {
5011 CATLSTR(buf, bufsz, _("%s Decreases the chance of migration"
5012 " into your cities.\n"), BULLET);
5013 }
5014 }
5015 break;
5016 case EFT_BORDER_VISION:
5018 && playerwide && net_value > 0) {
5019 CATLSTR(buf, bufsz, _("%s All tiles inside your borders are"
5020 " monitored.\n"), BULLET);
5021 }
5022 break;
5023 default:
5024 break;
5025 };
5026 }
5027
5031
5033
5034 /* Action immunity */
5035 action_iterate(act) {
5036 if (action_by_number(act)->quiet) {
5037 /* The ruleset documents this action it self. */
5038 continue;
5039 }
5040
5041 if (action_immune_government(gov, act)) {
5043 /* TRANS: action name ... action target
5044 * ("individual units", etc) */
5045 _("%s Makes it impossible to do the action \'%s\'"
5046 " to your %s.\n"), BULLET,
5049 }
5051
5052 if (user_text && user_text[0] != '\0') {
5053 cat_snprintf(buf, bufsz, "\n%s", user_text);
5054 }
5055}
5056
5057/************************************************************************/
5060char *helptext_unit_upkeep_str(const struct unit_type *utype)
5061{
5062 static char buf[128];
5063 int any = 0;
5064
5065 if (!utype) {
5066 log_error("Unknown unit!");
5067 return "";
5068 }
5069
5070 buf[0] = '\0';
5072 if (utype->upkeep[o] > 0) {
5073 /* TRANS: "2 Food" or ", 1 Shield" */
5074 cat_snprintf(buf, sizeof(buf), _("%s%d %s"),
5075 (any > 0 ? Q_("?blistmore:, ") : ""), utype->upkeep[o],
5077 any++;
5078 }
5080 if (utype->happy_cost > 0) {
5081 /* TRANS: "2 Unhappy" or ", 1 Unhappy" */
5082 cat_snprintf(buf, sizeof(buf), _("%s%d Unhappy"),
5083 (any > 0 ? Q_("?blistmore:, ") : ""), utype->happy_cost);
5084 any++;
5085 }
5086
5087 if (any == 0) {
5088 /* strcpy(buf, _("None")); */
5089 fc_snprintf(buf, sizeof(buf), "%d", 0);
5090 }
5091 return buf;
5092}
5093
5094/************************************************************************/
5097void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation,
5098 const char *user_text)
5099{
5100 struct universal source = {
5101 .kind = VUT_NATION,
5102 .value = {.nation = pnation}
5103 };
5104 bool print_break = TRUE;
5105
5106#define PRINT_BREAK() do { \
5107 if (print_break) { \
5108 if (buf[0] != '\0') { \
5109 CATLSTR(buf, bufsz, "\n\n"); \
5110 } \
5111 print_break = FALSE; \
5112 } \
5113 } while (FALSE)
5114
5115 fc_assert_ret(NULL != buf && 0 < bufsz);
5116 buf[0] = '\0';
5117
5118 if (pnation->legend[0] != '\0') {
5119 /* Client side legend is stored already translated */
5120 cat_snprintf(buf, bufsz, "%s", pnation->legend);
5121 }
5122
5123 if (pnation->init_government) {
5124 PRINT_BREAK();
5126 _("Initial government is %s.\n"),
5128 }
5129 if (pnation->init_techs[0] != A_LAST) {
5130 const char *tech_names[MAX_NUM_TECH_LIST];
5131 int i;
5132 struct astring list = ASTRING_INIT;
5133
5134 for (i = 0; i < MAX_NUM_TECH_LIST; i++) {
5135 if (pnation->init_techs[i] == A_LAST) {
5136 break;
5137 }
5138 tech_names[i] =
5140 }
5142 PRINT_BREAK();
5143 if (game.rgame.global_init_techs[0] != A_LAST) {
5145 /* TRANS: %s is an and-separated list of techs */
5146 _("Starts with knowledge of %s in addition to the standard "
5147 "starting technologies.\n"), astr_str(&list));
5148 } else {
5150 /* TRANS: %s is an and-separated list of techs */
5151 _("Starts with knowledge of %s.\n"), astr_str(&list));
5152 }
5153 astr_free(&list);
5154 }
5155 if (pnation->init_units[0]) {
5156 const struct unit_type *utypes[MAX_NUM_UNIT_LIST];
5157 int count[MAX_NUM_UNIT_LIST];
5158 int i, j, n = 0, total = 0;
5159
5160 /* Count how many of each type there is. */
5161 for (i = 0; i < MAX_NUM_UNIT_LIST; i++) {
5162 if (!pnation->init_units[i]) {
5163 break;
5164 }
5165 for (j = 0; j < n; j++) {
5166 if (pnation->init_units[i] == utypes[j]) {
5167 count[j]++;
5168 total++;
5169 break;
5170 }
5171 }
5172 if (j == n) {
5173 utypes[n] = pnation->init_units[i];
5174 count[n] = 1;
5175 total++;
5176 n++;
5177 }
5178 }
5179 {
5180 /* Construct the list of unit types and counts. */
5182 struct astring list = ASTRING_INIT;
5183
5184 for (i = 0; i < n; i++) {
5186 if (count[i] > 1) {
5187 /* TRANS: a unit type followed by a count. For instance,
5188 * "Fighter (2)" means two Fighters. Count is never 1.
5189 * Used in a list. */
5190 astr_set(&utype_names[i], _("%s (%d)"),
5191 utype_name_translation(utypes[i]), count[i]);
5192 } else {
5194 }
5195 }
5196 {
5198
5199 for (i = 0; i < n; i++) {
5201 }
5203 }
5204 for (i = 0; i < n; i++) {
5206 }
5207 PRINT_BREAK();
5209 /* TRANS: %s is an and-separated list of unit types
5210 * possibly with counts. Plurality is in total number of
5211 * units represented. */
5212 PL_("Starts with the following additional unit: %s.\n",
5213 "Starts with the following additional units: %s.\n",
5214 total), astr_str(&list));
5215 astr_free(&list);
5216 }
5217 }
5218 if (pnation->init_buildings[0] != B_LAST) {
5219 const char *impr_names[MAX_NUM_BUILDING_LIST];
5220 int i;
5221 struct astring list = ASTRING_INIT;
5222
5223 for (i = 0; i < MAX_NUM_BUILDING_LIST; i++) {
5224 if (pnation->init_buildings[i] == B_LAST) {
5225 break;
5226 }
5227 impr_names[i] =
5230 }
5232 PRINT_BREAK();
5235 /* TRANS: %s is an and-separated list of improvements */
5236 _("First city will get %s for free in addition to the "
5237 "standard improvements.\n"), astr_str(&list));
5238 } else {
5240 /* TRANS: %s is an and-separated list of improvements */
5241 _("First city will get %s for free.\n"), astr_str(&list));
5242 }
5243 astr_free(&list);
5244 }
5245
5246 if (buf[0] != '\0') {
5247 CATLSTR(buf, bufsz, "\n");
5248 }
5250
5251 if (user_text && user_text[0] != '\0') {
5252 if (buf[0] != '\0') {
5253 CATLSTR(buf, bufsz, "\n");
5254 }
5255 CATLSTR(buf, bufsz, "%s", user_text);
5256 }
5257#undef PRINT_BREAK
5258}
5259
5260/************************************************************************/
5264{
5265 if (req == NULL) {
5266 return HELP_LAST;
5267 }
5268
5269 if (req->source.kind == VUT_UTYPE) {
5270 return HELP_UNIT;
5271 }
5272 if (req->source.kind == VUT_IMPROVEMENT) {
5274 return HELP_WONDER;
5275 }
5276 return HELP_IMPROVEMENT;
5277 }
5278 if (req->source.kind == VUT_ADVANCE) {
5279 return HELP_TECH;
5280 }
5281 if (req->source.kind == VUT_TERRAIN) {
5282 return HELP_TERRAIN;
5283 }
5284 if (req->source.kind == VUT_EXTRA) {
5285 return HELP_EXTRA;
5286 }
5287 if (req->source.kind == VUT_GOOD) {
5288 return HELP_GOODS;
5289 }
5290 if (req->source.kind == VUT_SPECIALIST) {
5291 return HELP_SPECIALIST;
5292 }
5293 if (req->source.kind == VUT_GOVERNMENT) {
5294 return HELP_GOVERNMENT;
5295 }
5296
5297 if (req->source.kind == VUT_NATION) {
5298 return HELP_NATIONS;
5299 }
5300
5301 return HELP_LAST;
5302}
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:2538
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:3743
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:4398
void helptext_advance(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, int i)
Definition helpdata.c:3357
enum help_page_type help_type_by_requirement(const struct requirement *req)
Definition helpdata.c:5263
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:1985
void helptext_extra(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct extra_type *pextra)
Definition helpdata.c:3852
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:4317
#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:3688
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:5060
#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:3818
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:4363
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:3578
void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation, const char *user_text)
Definition helpdata.c:5097
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:7557
const char * tileset_summary(struct tileset *t)
Definition tilespec.c:7549
const char * tileset_name_get(struct tileset *t)
Definition tilespec.c:7533
const char * tileset_version(struct tileset *t)
Definition tilespec.c:7541
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