Freeciv-3.2
Loading...
Searching...
No Matches
helpdlg.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#ifdef HAVE_CONFIG_H
15#include <fc_config.h>
16#endif
17
18#include <stdio.h>
19#include <stdlib.h>
20#include <string.h>
21#include <math.h> /* sqrt */
22
23#include <gtk/gtk.h>
24
25/* utility */
26#include "fcintl.h"
27#include "mem.h"
28#include "shared.h"
29#include "support.h"
30
31/* common */
32#include "city.h"
33#include "game.h"
34#include "government.h"
35#include "movement.h"
36#include "nation.h"
37#include "specialist.h"
38#include "tech.h"
39#include "unit.h"
40#include "map.h"
41#include "research.h"
42#include "version.h"
43
44/* client */
45#include "client_main.h"
46#include "climisc.h"
47#include "helpdata.h"
48#include "options.h"
49#include "tilespec.h"
50
51/* client/gui-gtk-3.22 */
52#include "colors.h"
53#include "graphics.h"
54#include "gui_main.h"
55#include "gui_stuff.h"
56
57#include "helpdlg.h"
58
59#define TECH_TREE_DEPTH 20
60
61/*
62 * Globals.
63 */
66
68
82
89static GtkWidget *help_ulabel[5][5];
90static GtkWidget *help_tlabel[2][5];
92
93static bool help_advances[A_LAST];
94
97
99{
101 union {
103 const struct requirement *req;
104 } u;
105};
106
107static const char *help_ilabel_name[6] =
108{ N_("Base Cost:"), NULL, N_("Upkeep:"), NULL, N_("Requirement:"), NULL };
110
111static const char *help_wlabel_name[6] =
112{ N_("Base Cost:"), NULL, N_("Requirement:"), NULL, N_("Obsolete by:"), NULL };
114
116
117static const char *help_ulabel_name[5][5] =
118{
119 { N_("Cost:"), NULL, NULL, N_("Attack:"), NULL },
120 { N_("Defense:"), NULL, NULL, N_("Move:"), NULL },
121 { N_("Firepower:"), NULL, NULL, N_("Hitpoints:"), NULL },
122 { N_("Basic Upkeep:"), NULL, NULL, N_("Vision:"), NULL },
123 { N_("Requirement:"), NULL, NULL, N_("Obsolete by:"), NULL }
124};
125
126static const char *help_tlabel_name[2][5] =
127{
128 { N_("Move/Defense:"), NULL, NULL, N_("Food/Res/Trade:"), NULL },
129 { N_("Resources:"), NULL, NULL, NULL, NULL }
130};
131
132static const char *help_elabel_name[6] =
133/* TRANS: Label for build cost for extras in help. Will be followed by
134 * something like "3 MP" (where MP = Movement Points) */
135{ N_("Build:"), NULL,
136/* TRANS: Extra conflicts in help. Will be followed by a list of extras
137 * that can't be built on the same tile as this one. */
138 N_("Conflicts with:"), NULL,
139/* TRANS: Extra bonus in help. Will be followed by food/production/trade
140 * stats like "0/0/+1", "0/+50%/0" */
141 N_("Bonus (F/P/T):"), NULL };
142
143#define REQ_LABEL_NONE _("?tech:None")
144#define REQ_LABEL_NEVER _("(Never)")
145
146static void create_help_dialog(void);
147static void help_update_dialog(const struct help_item *pitem);
148
149static void select_help_item_string(const char *item,
150 enum help_page_type htype);
151static void help_command_update(void);
153
154/**********************************************************************/
169
170/**********************************************************************/
173static void set_title_topic(char *topic)
174{
175 if (strcmp(topic, _(HELP_ABOUT_ITEM)) == 0) {
177 } else {
179 }
180 return;
181}
182
183/**********************************************************************/
192
193/**********************************************************************/
207
208/**********************************************************************/
216
217/**********************************************************************/
226static void create_tech_tree(int tech, int levels, GtkTreeIter *parent)
227{
228 const struct research *presearch;
229 int bg;
230 int turns_to_tech;
231 bool original;
233 GValue value = { 0, };
234 enum tech_state state;
235
236 if (advance_required(tech, AR_ONE) == A_LAST
237 && advance_required(tech, AR_TWO) == A_LAST) {
239
241 help_advances[tech] = TRUE;
242
244 g_value_set_static_string(&value, _("Removed"));
245 gtk_tree_store_set_value(tstore, &l, 0, &value);
246 g_value_unset(&value);
247
249 1, -1,
250 2, tech,
251 3, &get_color(tileset, bg)->color
252 -1);
253 return;
254 }
255
257
258 state = research_invention_state(presearch, tech);
259 if (tech_state_is_valid(state)) {
260 switch (state) {
261 case TECH_UNKNOWN:
263 break;
264 case TECH_KNOWN:
266 break;
269 break;
270 }
271 } else {
273 }
275
276 /* l is the original in the tree. */
277 original = !help_advances[tech];
278
280 help_advances[tech] = TRUE;
281
285 tech));
286 gtk_tree_store_set_value(tstore, &l, 0, &value);
287 g_value_unset(&value);
288
290 1, turns_to_tech,
291 2, tech,
292 3, &get_color(tileset, bg)->color,
293 -1);
294
295 if (--levels <= 0) {
296 return;
297 }
298
299 if (original) {
300 /* only add children to orginals */
301 if (advance_required(tech, AR_ONE) != A_NONE)
302 create_tech_tree(advance_required(tech, AR_ONE), levels, &l);
303 if (advance_required(tech, AR_TWO) != A_NONE)
304 create_tech_tree(advance_required(tech, AR_TWO), levels, &l);
305 }
306 return;
307}
308
309/**********************************************************************/
325
326/**********************************************************************/
333
334/**********************************************************************/
341
342/**********************************************************************/
346{
347 const char *s;
348 struct help_page_selection *select;
350
352 select = (struct help_page_selection *)(g_object_get_data(G_OBJECT(w), "page_type"));
353
354 switch (select->type) {
355 case HPAGE_SRC_ENUM:
356 type = select->u.page;
357 break;
358 case HPAGE_SRC_REQ:
360 break;
361 }
362
363 if (type == HELP_LAST) {
364 return;
365 }
366
367 /* FIXME: May be able to skip, or may need to modify, advances[A_NONE]
368 below, depending on which i18n is done elsewhere.
369 */
370 if (strcmp(s, REQ_LABEL_NEVER) != 0
374 }
375}
376
377/**********************************************************************/
381 struct help_page_selection *select)
382{
383 GtkWidget *button;
384
385 button = gtk_button_new();
389 gtk_widget_set_name(label, "help_link");
390 gtk_container_add(GTK_CONTAINER(button), label);
391 gtk_widget_show(button);
392 g_signal_connect_swapped(button, "clicked",
394 g_object_set_data(G_OBJECT(label), "page_type", select);
395
396 return button;
397}
398
399/**********************************************************************/
403 enum help_page_type page)
404{
405 return help_hyperlink_new(label, &(page_selections[page]));
406}
407
408/**********************************************************************/
412 struct help_page_selection *select)
413{
414 GtkWidget *button, *label;
415
416 label = gtk_label_new(txt);
419 button = help_hyperlink_new(label, select);
420
421 return button;
422}
423
424/**********************************************************************/
428 enum help_page_type page)
429{
431}
432
433/**********************************************************************/
456
457/**********************************************************************/
465
466/**********************************************************************/
470{
471 GtkTreePath *path;
473 GtkTreeModel *model;
474 GtkTreeIter it;
475 struct help_item *pitem;
476
478
480 gtk_tree_model_get_iter(model, &it, path);
481 gtk_tree_path_free(path);
482
483 if (!path) {
484 return;
485 }
486
487 gtk_tree_model_get(model, &it, 1, &pitem, -1);
488
489 if (help_history_pos >= 0
491 return;
492 }
493
495
496 /* add to history. */
499 }
501
504}
505
506/**********************************************************************/
509static void create_help_dialog(void)
510{
512 GtkWidget *button;
514 int i, j;
517 GArray *array;
518 GtkTreeStore *store;
519 GtkTreeSelection *selection;
520
522 help_history_pos = -1;
523
524 help_dialog_shell = gtk_dialog_new_with_buttons(_("Freeciv Help Browser"),
525 NULL,
526 0,
527 _("_Back"),
528 1,
529 _("_Forward"),
530 2,
531 _("_Close"),
533 NULL);
538
543
544 hbox = gtk_grid_new();
548
549 /* build tree store. */
551
552 array = g_array_new(FALSE, FALSE, sizeof(GtkTreeIter));
554 GtkTreeIter *it, *parent;
555 const char *s;
556 int depth;
557
558 for (s = pitem->topic; *s == ' '; s++) {
559 /* nothing */
560 }
561 depth = s - pitem->topic;
562
563 array = g_array_set_size(array, depth+1);
564
565 if (depth > 0) {
566 parent = &g_array_index(array, GtkTreeIter, depth-1);
567 } else {
568 parent = NULL;
569 }
570
571 it = &g_array_index(array, GtkTreeIter, depth);
572 gtk_tree_store_append(store, it, parent);
573
574 gtk_tree_store_set(store, it, 0, pitem->topic, 1, pitem, -1);
576
577
578 /* create tree view. */
580 g_object_unref(store);
583
584 g_signal_connect(help_view, "cursor-changed",
586
589
593
602
607
613
616
619
620 for (i = 0; i < 6; i++) {
621 help_ilabel[i] =
624
625 if (i == 5) {
627 gtk_grid_attach(GTK_GRID(help_itable), button, i, 0, 1, 1);
628 } else {
630 gtk_widget_set_name(help_ilabel[i], "help_label");
631 }
632
634 }
635
638
639 for (i = 0; i < 6; i++) {
640 help_wlabel[i] =
643
644 if (i == 3 || i == 5) {
646 gtk_grid_attach(GTK_GRID(help_wtable), button, i, 0, 1, 1);
647 } else {
649 gtk_widget_set_name(help_wlabel[i], "help_label");
650 }
651
653 }
654
657
658 for (i = 0; i < 5; i++) {
659 for (j = 0; j < 5; j++) {
660 help_ulabel[j][i] =
663
664 if (j == 4 && (i == 1 || i == 4)) {
665 if (i == 1) {
667 } else {
669 }
670
671 gtk_grid_attach(GTK_GRID(help_utable), button, i, j, 1, 1);
672 } else {
674 i, j, 1, 1);
675 gtk_widget_set_name(help_ulabel[j][i], "help_label");
676 }
678 }
679 }
680
683
684 for (j = 0; j < 2; j++) {
685 for (i = 0; i < 5; i++) {
686 help_tlabel[j][i] =
689 gtk_widget_set_name(help_tlabel[j][i], "help_label");
690
691 /* Ugly (but these numbers are hardcoded in help_update_terrain() too) */
692 if (j == 1 && i == 1) {
693 /* Extra wide cell for terrain specials */
695 i, j, 4, 1);
697 break; /* skip rest of row */
698 } else {
700 i, j, 1, 1);
702 }
703 }
704 }
705
708
709 for (i = 0; i < 6; i++) {
710 help_elabel[i] =
713 gtk_grid_attach(GTK_GRID(help_etable), help_elabel[i], i % 4, i / 4, 1, 1);
714 gtk_widget_set_name(help_elabel[i], "help_label");
716 }
717
724
732 gtk_widget_set_name(text, "help_text");
735
741
742 /* build tech store. */
744 G_TYPE_STRING, /* tech name */
745 G_TYPE_INT, /* turns to tech */
746 G_TYPE_INT, /* tech id */
747 GDK_TYPE_RGBA); /* color */
753
754 g_signal_connect(help_tree, "row_activated",
756
757
759
764 "text", 0,
765 "background-rgba", 3,
766 NULL);
768 g_object_set(rend, "weight", PANGO_WEIGHT_BOLD, "xalign", 1.0, NULL);
771 "text", 1,
772 "background-rgba", 3,
773 NULL);
774
776
777
784
786 = gtk_button_new_with_label(_("Expand All"));
788
793
799}
800
801/**********************************************************************/
805{
806 if (spr == NULL) {
807 return;
808 }
809
812}
813
814/**********************************************************************/
844
845/**********************************************************************/
872
873/**********************************************************************/
876static void help_update_improvement(const struct help_item *pitem,
877 char *title)
878{
879 char buf[8192];
881
882 if (imp && !is_great_wonder(imp)) {
884 char req_buf[512];
885
888 sprintf(buf, "%d", imp->upkeep);
890
891 /* FIXME: this should show ranges, negated reqs, and all the
892 * MAX_NUM_REQS reqs.
893 * Currently it's limited to 1 req but this code is partially prepared
894 * to be extended. Remember MAX_NUM_REQS is a compile-time
895 * definition. */
898 if (!preq->present) {
899 continue;
900 }
901 req = universal_name_translation(&preq->source, req_buf, sizeof(req_buf));
903 break;
906/* create_tech_tree(help_improvement_tree, 0, imp->tech_req, 3);*/
907 } else {
911/* create_tech_tree(help_improvement_tree, 0, advance_count(), 3);*/
912 }
913
915
917
918 helptext_building(buf, sizeof(buf), client.conn.playing, pitem->text, imp);
921}
922
923/**********************************************************************/
926static void help_update_wonder(const struct help_item *pitem,
927 char *title)
928{
929 char buf[8192];
931
932 if (imp && is_great_wonder(imp)) {
933 int i;
934 char req_buf[512];
935
938
939 /* FIXME: this should show ranges, negated reqs, and all the
940 * MAX_NUM_REQS reqs.
941 * Currently it's limited to 1 req but this code is partially prepared
942 * to be extended. Remember MAX_NUM_REQS is a compile-time
943 * definition. */
944 i = 0;
947 if (!preq->present) {
948 continue;
949 }
952 req_buf, sizeof(req_buf)));
954 i++;
955 break;
957
959 requirement_vector_iterate(&imp->obsolete_by, pobs) {
960 if (pobs->source.kind == VUT_ADVANCE && pobs->present) {
963 (pobs->source.value.advance));
964
965 break;
966 }
968
969/* create_tech_tree(help_improvement_tree, 0, imp->tech_req, 3);*/
970 } else {
971 /* can't find wonder */
975/* create_tech_tree(help_improvement_tree, 0, advance_count(), 3); */
976 }
977
979
981
982 helptext_building(buf, sizeof(buf), client.conn.playing, pitem->text, imp);
985}
986
987/**********************************************************************/
990static void help_update_unit_type(const struct help_item *pitem,
991 char *title)
992{
993 char buf[8192];
995
996 if (utype) {
999 sprintf(buf, "%d", utype->attack_strength);
1001 sprintf(buf, "%d", utype->defense_strength);
1003 sprintf(buf, "%s", move_points_text(utype->move_rate, TRUE));
1005 sprintf(buf, "%d", utype->firepower);
1007 sprintf(buf, "%d", utype->hp);
1011 sprintf(buf, "%d", (int)sqrt((double)utype->vision_radius_sq));
1015/* create_tech_tree(help_improvement_tree, 0, advance_number(utype->require_advance), 3);*/
1016 if (U_NOT_OBSOLETED == utype->obsoleted_by) {
1018 } else {
1021 }
1022
1023 helptext_unit(buf, sizeof(buf), client.conn.playing, pitem->text, utype,
1024 TRUE);
1025
1028
1032 } else {
1041
1043/* create_tech_tree(help_improvement_tree, 0, A_LAST, 3);*/
1045
1048 }
1050}
1051
1052/**********************************************************************/
1055static char *fc_chomp(char *str, size_t len)
1056{
1057 gchar *i;
1058
1059 if (!str || !*str) {
1060 return str;
1061 }
1062
1063 i = str + len;
1064 for (i = g_utf8_find_prev_char(str, i);
1067 *i = '\0';
1068 }
1069 return str;
1070}
1071
1072/**********************************************************************/
1075static void help_update_tech(const struct help_item *pitem, char *title)
1076{
1077 int i, j;
1078 GtkWidget *w, *hbox;
1079 char buf[8192];
1081
1084 size_t len;
1085
1087
1088 for (j = 0; j < ARRAY_SIZE(help_advances); j++) {
1089 help_advances[j] = FALSE;
1090 }
1095
1096 helptext_advance(buf, sizeof(buf), client.conn.playing, pitem->text, i);
1097 len = strlen(buf);
1098 fc_chomp(buf, len);
1099
1101
1102 w = gtk_text_view_new();
1107 gtk_widget_set_name(w, "help_text");
1111 gtk_widget_show(w);
1112
1114 if (txt) {
1116 }
1117
1119 g_object_set(w, "margin", 5, NULL);
1123 gtk_widget_show(w);
1124
1126 /* FIXME: need a more general mechanism for this, since this
1127 * helptext needs to be shown in all possible req source types. */
1129 if (VUT_ADVANCE == preq->source.kind
1130 && preq->source.value.advance == padvance) {
1131 hbox = gtk_grid_new();
1133 w = gtk_label_new(_("Allows"));
1139 }
1142
1143 improvement_iterate(pimprove) {
1144 if (valid_improvement(pimprove)) {
1145 requirement_vector_iterate(&pimprove->reqs, preq) {
1146 if (VUT_ADVANCE == preq->source.kind
1147 && preq->source.value.advance == padvance) {
1148 hbox = gtk_grid_new();
1150 w = gtk_label_new(_("Allows"));
1153 is_great_wonder(pimprove)
1154 ? HELP_WONDER
1158 }
1160 requirement_vector_iterate(&pimprove->obsolete_by, pobs) {
1161 if (pobs->source.kind == VUT_ADVANCE
1162 && pobs->source.value.advance == padvance
1163 && pobs->present) {
1164 hbox = gtk_grid_new();
1166 w = gtk_label_new(_("Obsoletes"));
1169 is_great_wonder(pimprove)
1170 ? HELP_WONDER
1174 }
1176 }
1178
1180
1182 continue;
1183 }
1184
1185 hbox = gtk_grid_new();
1187 w = gtk_label_new(_("Allows"));
1193
1197 hbox = gtk_grid_new();
1199 w = gtk_label_new(_("Allows"));
1204 } else {
1205 hbox = gtk_grid_new();
1207 w = gtk_label_new(_("Allows"));
1211 w = gtk_label_new(_("with"));
1214 AR_TWO)),
1215 HELP_TECH);
1217 w = gtk_label_new(Q_("?techhelp:"));
1220 }
1221 }
1223 hbox = gtk_grid_new();
1225 w = gtk_label_new(_("Allows"));
1229 w = gtk_label_new(_("with"));
1232 HELP_TECH);
1234 w = gtk_label_new(Q_("?techhelp:"));
1237 }
1240 }
1241}
1242
1243/**********************************************************************/
1265
1266/**********************************************************************/
1270 enum unit_activity act,
1271 char *label)
1272{
1273 enum extra_cause cause = activity_to_extra_cause(act);
1274
1275 extra_type_by_cause_iterate(cause, pextra) {
1276 if (pextra->buildable
1277 && requirement_fulfilled_by_terrain(pterr, &(pextra->reqs))) {
1281 act));
1282 }
1284}
1285
1286/**********************************************************************/
1289static void help_update_terrain(const struct help_item *pitem,
1290 char *title)
1291{
1292 char buf[8192];
1293 struct terrain *pterrain = terrain_by_translated_name(title);
1294
1295 if (pterrain) {
1296 struct universal for_terr = { .kind = VUT_TERRAIN, .value = { .terrain = pterrain }};
1297
1299
1300 {
1301 /* 25 => "1.25"; 50 => "1.5"; 100 => "2.0" */
1302 int defbonus = pterrain->defense_bonus + 100;
1303 int frac = defbonus % 100;
1304
1305 if ((frac % 10) == 0) {
1306 frac /= 10;
1307 }
1308 sprintf(buf, "%d/%d.%d",
1309 pterrain->movement_cost, defbonus / 100, frac);
1310 }
1312
1313 sprintf(buf, "%d/%d/%d",
1314 pterrain->output[O_FOOD],
1315 pterrain->output[O_SHIELD],
1316 pterrain->output[O_TRADE]);
1318
1319 buf[0] = '\0';
1320 if (*(pterrain->resources)) {
1321 struct extra_type **r;
1322
1323 /* TODO: include resource frequency information */
1324 for (r = pterrain->resources; *r; r++) {
1325 /* TRANS: " Whales (2/1/2)," */
1326 sprintf (buf + strlen (buf), " %s (%d/%d/%d),",
1328 pterrain->output[O_FOOD] + (*r)->data.resource->output[O_FOOD],
1329 pterrain->output[O_SHIELD] + (*r)->data.resource->output[O_SHIELD],
1330 pterrain->output[O_TRADE] + (*r)->data.resource->output[O_TRADE]);
1331 }
1332 buf[strlen (buf) - 1] = '.';
1333 } else {
1334 /* TRANS: "Resources: (none)" */
1335 sprintf (buf + strlen (buf), _("(none)"));
1336 }
1338
1340
1341 if (pterrain->cultivate_result != T_NONE
1343 NULL, &for_terr)) {
1344 fc_snprintf(buf, sizeof(buf),
1345 PL_("%d turn", "%d turns", pterrain->cultivate_time),
1346 pterrain->cultivate_time);
1347 add_act_help_for_terrain(_("Cultivate Rslt/Time"),
1349 HELP_TERRAIN, buf);
1350 }
1351
1352 if (pterrain->plant_result != T_NONE
1354 fc_snprintf(buf, sizeof(buf),
1355 PL_("%d turn", "%d turns", pterrain->plant_time),
1356 pterrain->plant_time);
1357 add_act_help_for_terrain(_("Plant Rslt/Time"),
1359 HELP_TERRAIN, buf);
1360 }
1361
1362 if (pterrain->transform_result != T_NONE
1364 NULL, &for_terr)) {
1365 fc_snprintf(buf, sizeof(buf),
1366 PL_("%d turn", "%d turns", pterrain->transform_time),
1367 pterrain->transform_time);
1368 add_act_help_for_terrain(_("Trans. Rslt/Time"),
1370 HELP_TERRAIN, buf);
1371 }
1372
1375 _("Build as irrigation"));
1376 }
1379 _("Build as mine"));
1380 }
1383 _("Build as road"));
1384 }
1387 _("Build as base"));
1388 }
1389
1391 }
1392
1393 helptext_terrain(buf, sizeof(buf), client.conn.playing, pitem->text, pterrain);
1394
1397
1399}
1400
1401/**********************************************************************/
1404static void help_update_extra(const struct help_item *pitem, char *title)
1405{
1406 char buf[8192];
1408
1409 buf[0] = '\0';
1410 if (pextra == NULL) {
1411 strcat(buf, pitem->text);
1412 } else {
1413 struct road_type *proad = extra_road_get(pextra);
1415
1417
1418 /* Cost to build */
1419 if (pextra->buildable) {
1420 if (pextra->build_time != 0) {
1421 /* TRANS: "MP" = movement points */
1422 sprintf(buf, _("%d MP"), pextra->build_time);
1423 } else {
1424 /* TRANS: Build time depends on terrain. */
1425 sprintf(buf, _("Terrain specific"));
1426 }
1427 } else {
1428 sprintf(buf, "-");
1429 }
1431 /* Conflicting extras */
1432 buf[0] = '\0';
1433 if (is_resource) {
1434 /* TRANS: (Resource extra) Conflicts with: */
1435 strcat(buf, _("Other Resources"));
1436 }
1438 if (!can_extras_coexist(pextra, pextra2)
1440 if (buf[0] != '\0') {
1441 strcat(buf, "/");
1442 }
1444 }
1446 /* TRANS: "Conflicts with: (none)" (extras) */
1447 gtk_label_set_text(GTK_LABEL(help_elabel[3]), buf[0] ? buf : _("(none)"));
1448
1449 /* Bonus */
1450 if (proad != NULL) {
1451 const char *bonus = NULL;
1452
1454 if (proad->tile_incr[o] > 0) {
1455 /* TRANS: Road bonus depends on terrain. */
1456 bonus = _("Terrain specific");
1457 break;
1458 }
1460 if (!bonus) {
1462 }
1463 if (!bonus) {
1464 /* TRANS: No output bonus from a road */
1465 bonus = Q_("?bonus:None");
1466 }
1468 } else {
1469 gtk_label_set_text(GTK_LABEL(help_elabel[5]), Q_("?bonus:None"));
1470 }
1471
1472 helptext_extra(buf, sizeof(buf), client.conn.playing, pitem->text, pextra);
1473 }
1475
1478}
1479
1480/**********************************************************************/
1483static void help_update_goods(const struct help_item *pitem,
1484 char *title)
1485{
1486 char buf[8192];
1488
1489 if (!pgood) {
1490 strcat(buf, pitem->text);
1491 } else {
1492 helptext_goods(buf, sizeof(buf), client.conn.playing, pitem->text,
1493 pgood);
1494 }
1495
1498}
1499
1500/**********************************************************************/
1503static void help_update_specialist(const struct help_item *pitem,
1504 char *title)
1505{
1506 char buf[8192];
1508
1509 if (!pspec) {
1510 strcat(buf, pitem->text);
1511 } else {
1513 pspec);
1514 }
1515
1518}
1519
1520/**********************************************************************/
1523static void help_update_government(const struct help_item *pitem,
1524 char *title)
1525{
1526 char buf[8192];
1528
1529 if (!gov) {
1530 strcat(buf, pitem->text);
1531 } else {
1532 helptext_government(buf, sizeof(buf), client.conn.playing, pitem->text, gov);
1533 }
1534
1537}
1538
1539/**********************************************************************/
1542static void help_update_nation(const struct help_item *pitem, char *title,
1543 struct nation_type *pnation)
1544{
1545 char buf[4096];
1546
1547 if (!pnation) {
1548 strcat(buf, pitem->text);
1549 } else {
1550 helptext_nation(buf, sizeof(buf), pnation, pitem->text);
1551
1553 }
1554
1557}
1558
1559/**********************************************************************/
1562static void help_update_dialog(const struct help_item *pitem)
1563{
1564 char *top;
1565
1566 /* figure out what kind of item is required for pitem ingo */
1567
1568 for (top = pitem->topic; *top == ' '; top++) {
1569 /* nothing */
1570 }
1571
1572 help_box_hide();
1574
1575 switch (pitem->type) {
1576 case HELP_IMPROVEMENT:
1578 break;
1579 case HELP_WONDER:
1581 break;
1582 case HELP_UNIT:
1584 break;
1585 case HELP_TECH:
1586 help_update_tech(pitem, top);
1587 break;
1588 case HELP_TERRAIN:
1590 break;
1591 case HELP_EXTRA:
1593 break;
1594 case HELP_GOODS:
1596 break;
1597 case HELP_SPECIALIST:
1599 break;
1600 case HELP_GOVERNMENT:
1602 break;
1603 case HELP_NATIONS:
1605 break;
1606 case HELP_TEXT:
1607 default:
1608 /* it was a pure text item */
1611 break;
1612 }
1613 set_title_topic(pitem->topic);
1614
1616}
1617
1618/**********************************************************************/
1621static void help_item_zoom(GtkTreePath *path)
1622{
1623 GtkTreeModel *model;
1624 GtkTreeIter it, child, item;
1625 GtkTreeSelection *selection;
1626
1628 gtk_tree_model_get_iter(model, &item, path);
1629
1630 for (child = item; gtk_tree_model_iter_parent(model, &it, &child); child=it) {
1632
1633 it_path = gtk_tree_model_get_path(model, &it);
1636 }
1637
1641 TRUE, 0.0, 0.0);
1642}
1643
1644/**********************************************************************/
1648{
1649 GtkTreePath *path;
1650 bool next;
1651
1652 path = gtk_tree_path_new_first();
1653 next = FALSE;
1655 const char *s;
1656 int depth;
1657
1658 for (s = pitem2->topic; *s == ' '; s++) {
1659 /* nothing */
1660 }
1661 depth = s - pitem2->topic + 1;
1662
1663 while (depth < gtk_tree_path_get_depth(path)) {
1664 gtk_tree_path_up(path);
1665 gtk_tree_path_next(path);
1666 next = FALSE;
1667 }
1668 while (depth > gtk_tree_path_get_depth(path)) {
1669 gtk_tree_path_down(path);
1670 next = FALSE;
1671 }
1672
1673 if (next) {
1674 gtk_tree_path_next(path);
1675 }
1676
1677 if (pitem == pitem2)
1678 break;
1679
1680 next = TRUE;
1682
1683 return path;
1684}
1685
1686/**********************************************************************/
1689static void select_help_item_string(const char *item, enum help_page_type htype)
1690{
1691 const struct help_item *pitem;
1692 int idx;
1693 GtkTreePath *path;
1695
1696 if (!(pitem = get_help_item_spec(item, htype, &idx))) {
1697 return;
1698 }
1699
1700 path = help_item_path(pitem);
1701 help_item_zoom(path);
1702
1705 gtk_tree_path_free(path);
1706}
1707
1708/**********************************************************************/
1711static void help_command_update(void)
1712{
1714
1715 if (help_history_pos < 0) {
1718 } else {
1721
1722 if (help_history_pos == 0) {
1724 }
1725 if (help_history_pos >= help_history->len - 1) {
1727 }
1728 }
1729}
1730
1731/**********************************************************************/
1735{
1736 GtkTreePath *path;
1737 const struct help_item *pitem;
1738
1739 if (response_id == 1) {
1740 if (help_history_pos > 0) {
1742
1744 path = help_item_path(pitem);
1745 help_item_zoom(path);
1748 }
1749 } else if (response_id == 2) {
1752
1754 path = help_item_path(pitem);
1755 help_item_zoom(path);
1758 }
1759 } else {
1761 }
1762}
#define action_id_univs_not_blocking(act_id, act_uni, tgt_uni)
Definition actions.h:945
#define str
Definition astring.c:76
#define output_type_iterate(output)
Definition city.h:845
#define output_type_iterate_end
Definition city.h:851
struct civclient client
#define client_player()
struct color * get_color(const struct tileset *t, enum color_std stdcolor)
char * incite_cost
Definition comments.c:75
struct extra_type * extra_type_by_translated_name(const char *name)
Definition extras.c:235
enum extra_cause activity_to_extra_cause(enum unit_activity act)
Definition extras.c:1076
bool can_extras_coexist(const struct extra_type *pextra1, const struct extra_type *pextra2)
Definition extras.c:1003
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 is_extra_caused_by(e, c)
Definition extras.h:203
#define extra_road_get(_e_)
Definition extras.h:191
#define extra_type_by_cause_iterate_end
Definition extras.h:339
#define extra_type_by_cause_iterate(_cause, _extra)
Definition extras.h:333
@ O_SHIELD
Definition fc_types.h:101
@ O_FOOD
Definition fc_types.h:101
@ O_TRADE
Definition fc_types.h:101
const char * skip_intl_qualifier_prefix(const char *str)
Definition fcintl.c:48
#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
const char * government_name_translation(const struct government *pgovern)
Definition government.c:143
struct government * government_by_translated_name(const char *name)
Definition government.c:40
#define governments_iterate(NAME_pgov)
Definition government.h:124
#define governments_iterate_end
Definition government.h:127
#define FC_STATIC_CANVAS_INIT
Definition canvas.h:28
GtkWidget * toplevel
Definition gui_main.c:125
void set_relative_window_position(GtkWindow *ref, GtkWindow *w, int px, int py)
Definition gui_stuff.c:60
void setup_dialog(GtkWidget *shell, GtkWidget *parent)
Definition gui_stuff.c:287
static GtkWidget * help_tree_sw
Definition helpdlg.c:83
static void set_title_topic(char *topic)
Definition helpdlg.c:173
static void activated_topic(GtkTreeView *view, gpointer data)
Definition helpdlg.c:469
static GtkWidget * help_tree
Definition helpdlg.c:80
static GtkWidget * help_tree_expand
Definition helpdlg.c:84
static GtkWidget * help_ulabel[5][5]
Definition helpdlg.c:89
static void help_update_specialist(const struct help_item *pitem, char *title)
Definition helpdlg.c:1503
static void help_hyperlink_callback(GtkWidget *w)
Definition helpdlg.c:345
static GtkWidget * help_elabel[6]
Definition helpdlg.c:91
static GtkWidget * help_etable
Definition helpdlg.c:79
static void help_destroy_callback(GtkWidget *w, gpointer data)
Definition helpdlg.c:460
static void set_help_tile_from_extra(const struct extra_type *pextra)
Definition helpdlg.c:848
static GtkWidget * help_frame
Definition helpdlg.c:69
static void help_tech_tree_activated_callback(GtkTreeView *view, GtkTreePath *path, GtkTreeViewColumn *col, gpointer data)
Definition helpdlg.c:312
static void help_update_tech(const struct help_item *pitem, char *title)
Definition helpdlg.c:1075
static void help_item_zoom(GtkTreePath *path)
Definition helpdlg.c:1621
static GtkWidget * help_slink_new_page(const gchar *txt, enum help_page_type page)
Definition helpdlg.c:427
static GtkWidget * help_tlabel[2][5]
Definition helpdlg.c:90
static GtkTreePath * help_item_path(const struct help_item *pitem)
Definition helpdlg.c:1647
static GtkWidget * help_tree_collapse
Definition helpdlg.c:85
static void help_update_nation(const struct help_item *pitem, char *title, struct nation_type *pnation)
Definition helpdlg.c:1542
static void create_help_dialog(void)
Definition helpdlg.c:509
static GtkTextBuffer * help_text
Definition helpdlg.c:70
static void help_update_wonder(const struct help_item *pitem, char *title)
Definition helpdlg.c:926
static GtkWidget * help_hyperlink_new_page(GtkWidget *label, enum help_page_type page)
Definition helpdlg.c:402
static GtkWidget * help_dialog_shell
Definition helpdlg.c:64
static GtkWidget * help_text_sw
Definition helpdlg.c:71
static GPtrArray * help_history
Definition helpdlg.c:95
static const char * help_elabel_name[6]
Definition helpdlg.c:132
static void create_tech_tree(int tech, int levels, GtkTreeIter *parent)
Definition helpdlg.c:226
static void help_update_extra(const struct help_item *pitem, char *title)
Definition helpdlg.c:1404
static GtkWidget * help_ilabel[6]
Definition helpdlg.c:87
static void set_help_tile_from_sprite(struct sprite *spr)
Definition helpdlg.c:804
static const char * help_wlabel_name[6]
Definition helpdlg.c:111
static const char * help_ulabel_name[5][5]
Definition helpdlg.c:117
static void help_tech_tree_collapse_callback(GtkWidget *w, gpointer data)
Definition helpdlg.c:337
static void set_help_tile_from_terrain(struct terrain *pterr)
Definition helpdlg.c:817
static GtkWidget * help_view
Definition helpdlg.c:67
static void help_update_goods(const struct help_item *pitem, char *title)
Definition helpdlg.c:1483
void help_system_init(void)
Definition helpdlg.c:157
static void help_box_hide(void)
Definition helpdlg.c:436
static void help_update_unit_type(const struct help_item *pitem, char *title)
Definition helpdlg.c:990
void popdown_help_dialog(void)
Definition helpdlg.c:186
static void help_update_terrain(const struct help_item *pitem, char *title)
Definition helpdlg.c:1289
static void help_update_dialog(const struct help_item *pitem)
Definition helpdlg.c:1562
static char * fc_chomp(char *str, size_t len)
Definition helpdlg.c:1055
void popup_help_dialog_string(const char *item)
Definition helpdlg.c:212
static int help_history_pos
Definition helpdlg.c:96
static struct help_page_selection help_wndr_req
Definition helpdlg.c:113
static GtkWidget * help_wlabel[6]
Definition helpdlg.c:88
static GtkWidget * help_box
Definition helpdlg.c:74
static void help_extras_of_act_for_terrain(struct terrain *pterr, enum unit_activity act, char *label)
Definition helpdlg.c:1269
void popup_help_dialog_typed(const char *item, enum help_page_type htype)
Definition helpdlg.c:196
#define REQ_LABEL_NEVER
Definition helpdlg.c:144
static void help_command_update(void)
Definition helpdlg.c:1711
static struct help_page_selection page_selections[HELP_LAST]
Definition helpdlg.c:115
#define TECH_TREE_DEPTH
Definition helpdlg.c:59
static const char * help_tlabel_name[2][5]
Definition helpdlg.c:126
static struct help_page_selection help_impr_req
Definition helpdlg.c:109
#define REQ_LABEL_NONE
Definition helpdlg.c:143
static GtkWidget * help_wtable
Definition helpdlg.c:76
static GtkWidget * help_slink_new(const gchar *txt, struct help_page_selection *select)
Definition helpdlg.c:411
static GtkWidget * help_vbox
Definition helpdlg.c:72
static void help_tech_tree_expand_callback(GtkWidget *w, gpointer data)
Definition helpdlg.c:329
static GtkWidget * help_tile
Definition helpdlg.c:73
static GtkWidget * help_hyperlink_new(GtkWidget *label, struct help_page_selection *select)
Definition helpdlg.c:380
static void help_update_government(const struct help_item *pitem, char *title)
Definition helpdlg.c:1523
static GtkWidget * help_ttable
Definition helpdlg.c:78
static void help_update_improvement(const struct help_item *pitem, char *title)
Definition helpdlg.c:876
static const char * help_ilabel_name[6]
Definition helpdlg.c:107
static GtkWidget * help_tree_buttons_hbox
Definition helpdlg.c:86
static GtkWidget * help_view_sw
Definition helpdlg.c:65
static void select_help_item_string(const char *item, enum help_page_type htype)
Definition helpdlg.c:1689
static bool help_advances[A_LAST]
Definition helpdlg.c:93
static GtkWidget * help_utable
Definition helpdlg.c:77
static GtkWidget * help_itable
Definition helpdlg.c:75
static GtkTreeStore * tstore
Definition helpdlg.c:81
static void add_act_help_for_terrain(const char *act_label, const char *result_link_label, enum help_page_type result_link_type, const char *descr_label)
Definition helpdlg.c:1246
static void help_command_callback(GtkWidget *w, gint response_id)
Definition helpdlg.c:1734
const char * title
Definition repodlgs.c:1314
GType type
Definition repodlgs.c:1313
void helptext_government(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct government *gov)
Definition helpdata.c:4340
void helptext_advance(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, int i)
Definition helpdata.c:3299
enum help_page_type help_type_by_requirement(const struct requirement *req)
Definition helpdata.c:5205
char * helptext_unit(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct unit_type *utype, bool class_help)
Definition helpdata.c:1932
void helptext_extra(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct extra_type *pextra)
Definition helpdata.c:3794
void helptext_goods(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct goods_type *pgood)
Definition helpdata.c:4259
const char * helptext_road_bonus_str(const struct terrain *pterrain, const struct road_type *proad)
Definition helpdata.c:3630
char * helptext_unit_upkeep_str(const struct unit_type *utype)
Definition helpdata.c:5002
const char * helptext_extra_for_terrain_str(struct extra_type *pextra, struct terrain *pterrain, enum unit_activity act)
Definition helpdata.c:3760
void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct specialist *pspec)
Definition helpdata.c:4305
const struct help_item * get_help_item_spec(const char *name, enum help_page_type htype, int *pos)
Definition helpdata.c:1288
char * helptext_building(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct impr_type *pimprove)
Definition helpdata.c:1381
void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct terrain *pterrain)
Definition helpdata.c:3520
void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation, const char *user_text)
Definition helpdata.c:5039
#define help_items_iterate(pitem)
Definition helpdata.h:72
#define help_items_iterate_end
Definition helpdata.h:76
#define HELP_ABOUT_ITEM
help_page_type
Definition helpdlg_g.h:20
@ HELP_ANY
Definition helpdlg_g.h:20
@ 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_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_TEXT
Definition helpdlg_g.h:20
const struct impr_type * valid_improvement(const struct impr_type *pimprove)
int impr_base_build_shield_cost(const struct impr_type *pimprove)
bool is_great_wonder(const struct impr_type *pimprove)
struct impr_type * improvement_by_translated_name(const char *name)
const char * improvement_name_translation(const struct impr_type *pimprove)
#define improvement_iterate_end
#define improvement_iterate(_p)
void put_drawn_sprites(struct canvas *pcanvas, float zoom, int canvas_x, int canvas_y, int count, struct drawn_sprite *pdrawn, bool fog)
const char * move_points_text(int mp, bool reduce)
Definition movement.c:1015
struct nation_type * nation_by_translated_plural(const char *name)
Definition nation.c:106
int len
Definition packhand.c:127
const char * universal_name_translation(const struct universal *psource, char *buf, size_t bufsz)
#define requirement_fulfilled_by_terrain(_ter_, _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
const char * research_advance_name_translation(const struct research *presearch, Tech_type_id tech)
Definition research.c:273
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
#define ARRAY_SIZE(x)
Definition shared.h:85
struct specialist * specialist_by_translated_name(const char *name)
Definition specialist.c:130
cairo_surface_t * surface
Definition canvas.h:23
struct connection conn
Definition client_main.h:96
Definition colors.h:21
struct player * playing
Definition connection.h:151
bool buildable
Definition extras.h:116
int build_time
Definition extras.h:118
char * text
Definition helpdata.h:26
enum help_page_type page
Definition helpdlg.c:102
const struct requirement * req
Definition helpdlg.c:103
enum help_page_selection::@155 type
union help_page_selection::@156 u
Definition climisc.h:82
struct terrain * cultivate_result
Definition terrain.h:215
struct extra_type ** resources
Definition terrain.h:204
int plant_time
Definition terrain.h:219
struct terrain * plant_result
Definition terrain.h:218
int defense_bonus
Definition terrain.h:200
int cultivate_time
Definition terrain.h:216
int movement_cost
Definition terrain.h:199
int output[O_LAST]
Definition terrain.h:202
int transform_time
Definition terrain.h:231
struct terrain * transform_result
Definition terrain.h:229
int defense_strength
Definition unittype.h:516
int firepower
Definition unittype.h:525
const struct unit_type * obsoleted_by
Definition unittype.h:529
int vision_radius_sq
Definition unittype.h:522
int move_rate
Definition unittype.h:517
int attack_strength
Definition unittype.h:515
enum universals_n kind
Definition fc_types.h:902
int fc_snprintf(char *str, size_t n, const char *format,...)
Definition support.c:974
#define TRUE
Definition support.h:46
#define FALSE
Definition support.h:47
struct advance * advance_by_number(const Tech_type_id atype)
Definition tech.c:107
bool is_future_tech(Tech_type_id tech)
Definition tech.c:281
struct advance * advance_by_translated_name(const char *name)
Definition tech.c:185
struct advance * advance_requires(const struct advance *padvance, enum tech_req require)
Definition tech.c:136
const char * advance_name_translation(const struct advance *padvance)
Definition tech.c:290
Tech_type_id advance_required(const Tech_type_id tech, enum tech_req require)
Definition tech.c:121
Tech_type_id advance_number(const struct advance *padvance)
Definition tech.c:98
#define advance_iterate_all_end
Definition tech.h:279
@ AR_TWO
Definition tech.h:112
@ AR_ONE
Definition tech.h:111
#define advance_iterate_all(_p)
Definition tech.h:278
#define A_NONE
Definition tech.h:43
#define A_LAST
Definition tech.h:45
struct terrain * terrain_by_translated_name(const char *name)
Definition terrain.c:202
const char * terrain_name_translation(const struct terrain *pterrain)
Definition terrain.c:238
#define T_NONE
Definition terrain.h:56
struct sprite * get_building_sprite(const struct tileset *t, const struct impr_type *pimprove)
Definition tilespec.c:6783
int fill_basic_extra_sprite_array(const struct tileset *t, struct drawn_sprite *sprs, const struct extra_type *pextra)
Definition tilespec.c:7200
int fill_basic_terrain_layer_sprite_array(struct tileset *t, struct drawn_sprite *sprs, int layer, struct terrain *pterrain)
Definition tilespec.c:7167
int tileset_tile_height(const struct tileset *t)
Definition tilespec.c:765
struct sprite * get_unittype_sprite(const struct tileset *t, const struct unit_type *punittype, enum unit_activity activity, enum direction8 facing)
Definition tilespec.c:6805
struct sprite * get_nation_flag_sprite(const struct tileset *t, const struct nation_type *pnation)
Definition tilespec.c:6756
int tileset_tile_width(const struct tileset *t)
Definition tilespec.c:753
struct sprite * get_tech_sprite(const struct tileset *t, Tech_type_id tech)
Definition tilespec.c:6774
struct goods_type * goods_by_translated_name(const char *name)
bool is_tech_req_for_utype(const struct unit_type *ptype, struct advance *padv)
Definition unittype.c:2724
int utype_build_shield_cost_base(const struct unit_type *punittype)
Definition unittype.c:1468
struct advance * utype_primary_tech_req(const struct unit_type *ptype)
Definition unittype.c:2710
struct unit_type * unit_type_by_translated_name(const char *name)
Definition unittype.c:1752
const char * utype_name_translation(const struct unit_type *punittype)
Definition unittype.c:1560
#define unit_type_iterate(_p)
Definition unittype.h:855
#define unit_type_iterate_end
Definition unittype.h:862
#define U_NOT_OBSOLETED
Definition unittype.h:528
const char * freeciv_name_version(void)
Definition version.c:35