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