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-4.0 */
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
70static int help_dlog_width = 520, help_dlog_height = 350;
83
90static GtkWidget *help_ulabel[5][5];
91static GtkWidget *help_tlabel[2][5];
93
94static bool help_advances[A_LAST];
95
98
100{
102 union {
103 enum help_page_type page;
104 const struct requirement *req;
105 } u;
106};
107
108static const char *help_ilabel_name[6] =
109{ N_("Base Cost:"), NULL, N_("Upkeep:"), NULL, N_("Requirement:"), NULL };
111
112static const char *help_wlabel_name[6] =
113{ N_("Base Cost:"), NULL, N_("Requirement:"), NULL, N_("Obsolete by:"), NULL };
115
117
118static const char *help_ulabel_name[5][5] =
119{
120 { N_("Cost:"), NULL, NULL, N_("Attack:"), NULL },
121 { N_("Defense:"), NULL, NULL, N_("Move:"), NULL },
122 { N_("Firepower:"), NULL, NULL, N_("Hitpoints:"), NULL },
123 { N_("Basic Upkeep:"), NULL, NULL, N_("Vision:"), NULL },
124 { N_("Requirement:"), NULL, NULL, N_("Obsolete by:"), NULL }
125};
126
127static const char *help_tlabel_name[2][5] =
128{
129 { N_("Move/Defense:"), NULL, NULL, N_("Food/Res/Trade:"), NULL },
130 { N_("Resources:"), NULL, NULL, NULL, NULL }
131};
132
133static const char *help_elabel_name[6] =
134/* TRANS: Label for build cost for extras in help. Will be followed by
135 * something like "3 MP" (where MP = Movement Points) */
136{ N_("Build:"), NULL,
137/* TRANS: Extra conflicts in help. Will be followed by a list of extras
138 * that can't be built on the same tile as this one. */
139 N_("Conflicts with:"), NULL,
140/* TRANS: Extra bonus in help. Will be followed by food/production/trade
141 * stats like "0/0/+1", "0/+50%/0" */
142 N_("Bonus (F/P/T):"), NULL };
143
144#define REQ_LABEL_NONE _("?tech:None")
145#define REQ_LABEL_NEVER _("(Never)")
146
147static void create_help_dialog(void);
148static void help_update_dialog(const struct help_item *pitem);
149
150static void select_help_item_string(const char *item,
151 enum help_page_type htype);
152static void help_command_update(void);
154
155/**********************************************************************/
170
171/**********************************************************************/
174static void set_title_topic(char *topic)
175{
176 if (strcmp(topic, _(HELP_ABOUT_ITEM)) == 0) {
178 } else {
180 }
181}
182
183/**********************************************************************/
192
193/**********************************************************************/
205
206/**********************************************************************/
214
215/**********************************************************************/
224static void create_tech_tree(int tech, int levels, GtkTreeIter *parent)
225{
226 const struct research *presearch;
227 int bg;
228 int turns_to_tech;
229 bool original;
231 GValue value = { 0, };
232 enum tech_state state;
233
234 if (advance_required(tech, AR_ONE) == A_LAST
235 && advance_required(tech, AR_TWO) == A_LAST) {
237
239 help_advances[tech] = TRUE;
240
242 g_value_set_static_string(&value, _("Removed"));
243 gtk_tree_store_set_value(tstore, &l, 0, &value);
244 g_value_unset(&value);
245
247 1, -1,
248 2, tech,
249 3, &get_color(tileset, bg)->color
250 -1);
251 return;
252 }
253
255
256 state = research_invention_state(presearch, tech);
257 if (tech_state_is_valid(state)) {
258 switch (state) {
259 case TECH_UNKNOWN:
261 break;
262 case TECH_KNOWN:
264 break;
267 break;
268 }
269 } else {
271 }
273
274 /* l is the original in the tree. */
275 original = !help_advances[tech];
276
278 help_advances[tech] = TRUE;
279
283 tech));
284 gtk_tree_store_set_value(tstore, &l, 0, &value);
285 g_value_unset(&value);
286
288 1, turns_to_tech,
289 2, tech,
290 3, &get_color(tileset, bg)->color,
291 -1);
292
293 if (--levels <= 0) {
294 return;
295 }
296
297 if (original) {
298 /* Only add children to orginals */
299 if (advance_required(tech, AR_ONE) != A_NONE)
300 create_tech_tree(advance_required(tech, AR_ONE), levels, &l);
301 if (advance_required(tech, AR_TWO) != A_NONE)
302 create_tech_tree(advance_required(tech, AR_TWO), levels, &l);
303 }
304}
305
306/**********************************************************************/
322
323/**********************************************************************/
330
331/**********************************************************************/
338
339/**********************************************************************/
343{
344 const char *s;
345 struct help_page_selection *select;
347
349 select = (struct help_page_selection *)(g_object_get_data(G_OBJECT(w),
350 "page_type"));
351
352 switch (select->type) {
353 case HPAGE_SRC_ENUM:
354 type = select->u.page;
355 break;
356 case HPAGE_SRC_REQ:
358 break;
359 }
360
361 if (type == HELP_LAST) {
362 return;
363 }
364
365 /* FIXME: May be able to skip, or may need to modify, advances[A_NONE]
366 below, depending on which i18n is done elsewhere.
367 */
368 if (strcmp(s, REQ_LABEL_NEVER) != 0
372 }
373}
374
375/**********************************************************************/
379 struct help_page_selection *select)
380{
381 GtkWidget *button;
382
383 button = gtk_button_new();
387 gtk_widget_set_name(label, "help_link");
388 gtk_button_set_child(GTK_BUTTON(button), label);
390 g_signal_connect_swapped(button, "clicked",
392 g_object_set_data(G_OBJECT(label), "page_type", select);
393
394 return button;
395}
396
397/**********************************************************************/
401 enum help_page_type page)
402{
403 return help_hyperlink_new(label, &(page_selections[page]));
404}
405
406/**********************************************************************/
410 struct help_page_selection *select)
411{
412 GtkWidget *button, *label;
413
414 label = gtk_label_new(txt);
417 button = help_hyperlink_new(label, select);
418
419 return button;
420}
421
422/**********************************************************************/
426 enum help_page_type page)
427{
429}
430
431/**********************************************************************/
452
453/**********************************************************************/
460
461/**********************************************************************/
464static void help_box_clear(void)
465{
467
468 while (child != NULL) {
471 }
472}
473
474/**********************************************************************/
482
483/**********************************************************************/
487{
488 GtkTreePath *path;
490 GtkTreeModel *model;
491 GtkTreeIter it;
492 struct help_item *pitem;
493
495
496 if (model == NULL) {
497 return;
498 }
499
501 gtk_tree_model_get_iter(model, &it, path);
502 gtk_tree_path_free(path);
503
504 if (path == NULL) {
505 return;
506 }
507
508 gtk_tree_model_get(model, &it, 1, &pitem, -1);
509
510 if (help_history_pos >= 0
512 return;
513 }
514
516
517 /* Add to history. */
520 }
522
525}
526
527/**********************************************************************/
530static void create_help_dialog(void)
531{
533 GtkWidget *button;
535 int i, j;
538 GArray *array;
539 GtkTreeStore *store;
540 GtkTreeSelection *selection;
542
544 help_history_pos = -1;
545
546 help_dialog_shell = gtk_dialog_new_with_buttons(_("Freeciv Help Browser"),
547 NULL,
548 0,
549 _("_Back"),
550 1,
551 _("_Forward"),
552 2,
553 _("_Close"),
555 NULL);
560
568
571 hbox);
573
574 /* Build tree store. */
576
577 array = g_array_new(FALSE, FALSE, sizeof(GtkTreeIter));
579 GtkTreeIter *it, *parent;
580 const char *s;
581 int depth;
582
583 for (s = pitem->topic; *s == ' '; s++) {
584 /* Nothing */
585 }
586 depth = s - pitem->topic;
587
588 array = g_array_set_size(array, depth+1);
589
590 if (depth > 0) {
591 parent = &g_array_index(array, GtkTreeIter, depth-1);
592 } else {
593 parent = NULL;
594 }
595
596 it = &g_array_index(array, GtkTreeIter, depth);
597 gtk_tree_store_append(store, it, parent);
598
599 gtk_tree_store_set(store, it, 0, pitem->topic, 1, pitem, -1);
601
602 /* Create tree view. */
604 g_object_unref(store);
607
608 g_signal_connect(help_view, "cursor-changed",
610
613
617
626
631
634
645
648
649 for (i = 0; i < 6; i++) {
650 help_ilabel[i] =
653
654 if (i == 5) {
656 gtk_grid_attach(GTK_GRID(help_itable), button, i, 0, 1, 1);
657 } else {
659 gtk_widget_set_name(help_ilabel[i], "help_label");
660 }
661
663 }
664
667
668 for (i = 0; i < 6; i++) {
669 help_wlabel[i] =
672
673 if (i == 3 || i == 5) {
675 gtk_grid_attach(GTK_GRID(help_wtable), button, i, 0, 1, 1);
676 } else {
678 gtk_widget_set_name(help_wlabel[i], "help_label");
679 }
680
682 }
683
686
687 for (i = 0; i < 5; i++) {
688 for (j = 0; j < 5; j++) {
689 help_ulabel[j][i] =
692
693 if (j == 4 && (i == 1 || i == 4)) {
694 if (i == 1) {
696 } else {
698 }
699
700 gtk_grid_attach(GTK_GRID(help_utable), button, i, j, 1, 1);
701 } else {
703 i, j, 1, 1);
704 gtk_widget_set_name(help_ulabel[j][i], "help_label");
705 }
706
708 }
709 }
710
713
714 for (j = 0; j < 2; j++) {
715 for (i = 0; i < 5; i++) {
716 help_tlabel[j][i] =
719 gtk_widget_set_name(help_tlabel[j][i], "help_label");
720
721 /* Ugly (but these numbers are hardcoded in help_update_terrain() too) */
722 if (j == 1 && i == 1) {
723 /* Extra wide cell for terrain specials */
725 i, j, 4, 1);
727 break; /* Skip rest of row */
728 } else {
730 i, j, 1, 1);
732 }
733 }
734 }
735
738
739 for (i = 0; i < 6; i++) {
743 gtk_grid_attach(GTK_GRID(help_etable), help_elabel[i], i % 4, i / 4, 1, 1);
744 gtk_widget_set_name(help_elabel[i], "help_label");
746 }
747
754
765 gtk_widget_set_name(text, "help_text");
768
774
775 /* Build tech store. */
777 G_TYPE_STRING, /* Tech name */
778 G_TYPE_INT, /* Turns to tech */
779 G_TYPE_INT, /* Tech id */
780 GDK_TYPE_RGBA); /* Color */
786
787 g_signal_connect(help_tree, "row_activated",
789
790
792
797 "text", 0,
798 "background-rgba", 3,
799 NULL);
801 g_object_set(rend, "weight", PANGO_WEIGHT_BOLD, "xalign", 1.0, NULL);
804 "text", 1,
805 "background-rgba", 3,
806 NULL);
807
809
817
820
825
831}
832
833/**********************************************************************/
837{
838 if (spr == NULL) {
839 return;
840 }
841
844}
845
846/**********************************************************************/
876
877/**********************************************************************/
904
905/**********************************************************************/
908static void help_update_improvement(const struct help_item *pitem,
909 char *title)
910{
911 char buf[8192];
913
914 if (imp != NULL && !is_great_wonder(imp)) {
916 char req_buf[512];
917
920 sprintf(buf, "%d", imp->upkeep);
922
923 /* FIXME: this should show ranges, negated reqs, and all the
924 * MAX_NUM_REQS reqs.
925 * Currently it's limited to 1 req but this code is partially prepared
926 * to be extended. Remember MAX_NUM_REQS is a compile-time
927 * definition. */
930 if (!preq->present) {
931 continue;
932 }
933 req = universal_name_translation(&preq->source, req_buf, sizeof(req_buf));
935 break;
938/* create_tech_tree(help_improvement_tree, 0, imp->tech_req, 3); */
939 } else {
943/* create_tech_tree(help_improvement_tree, 0, advance_count(), 3); */
944 }
945
947
949
950 helptext_building(buf, sizeof(buf), client_player(), pitem->text, imp);
953}
954
955/**********************************************************************/
958static void help_update_wonder(const struct help_item *pitem,
959 char *title)
960{
961 char buf[8192];
963
964 if (imp != NULL && is_great_wonder(imp)) {
965 int i;
966 char req_buf[512];
967
970
971 /* FIXME: this should show ranges, negated reqs, and all the
972 * MAX_NUM_REQS reqs.
973 * Currently it's limited to 1 req but this code is partially prepared
974 * to be extended. Remember MAX_NUM_REQS is a compile-time
975 * definition. */
976 i = 0;
979 if (!preq->present) {
980 continue;
981 }
984 req_buf, sizeof(req_buf)));
986 i++;
987 break;
989
991 requirement_vector_iterate(&imp->obsolete_by, pobs) {
992 if (pobs->source.kind == VUT_ADVANCE && pobs->present) {
995 (pobs->source.value.advance));
996
997 break;
998 }
1000
1001/* create_tech_tree(help_improvement_tree, 0, imp->tech_req, 3); */
1002 } else {
1003 /* Can't find wonder */
1007/* create_tech_tree(help_improvement_tree, 0, advance_count(), 3); */
1008 }
1009
1011
1013
1014 helptext_building(buf, sizeof(buf), client_player(), pitem->text, imp);
1017}
1018
1019/**********************************************************************/
1022static void help_update_unit_type(const struct help_item *pitem,
1023 char *title)
1024{
1025 char buf[8192];
1027
1028 if (utype != NULL) {
1031 sprintf(buf, "%d", utype->attack_strength);
1033 sprintf(buf, "%d", utype->defense_strength);
1035 sprintf(buf, "%s", move_points_text(utype->move_rate, TRUE));
1037 sprintf(buf, "%d", utype->firepower);
1039 sprintf(buf, "%d", utype->hp);
1043 sprintf(buf, "%d", (int)sqrt((double)utype->vision_radius_sq));
1047
1048#if 0
1050 advance_number(utype->require_advance), 3);
1051#endif
1052
1053 if (U_NOT_OBSOLETED == utype->obsoleted_by) {
1056 } else {
1059 }
1060
1061 helptext_unit(buf, sizeof(buf), client_player(), pitem->text, utype,
1062 TRUE);
1063
1066
1070 } else {
1079
1081/* create_tech_tree(help_improvement_tree, 0, A_LAST, 3); */
1084
1087 }
1088
1090}
1091
1092/**********************************************************************/
1095static char *fc_chomp(char *str, size_t len)
1096{
1097 gchar *i;
1098
1099 if (str == NULL || !*str) {
1100 return str;
1101 }
1102
1103 i = str + len;
1104 for (i = g_utf8_find_prev_char(str, i);
1107 *i = '\0';
1108 }
1109
1110 return str;
1111}
1112
1113/**********************************************************************/
1116static void help_update_tech(const struct help_item *pitem, char *title)
1117{
1118 int i, j;
1119 GtkWidget *w, *hbox;
1120 char buf[8192];
1122
1123 if (padvance != NULL
1126 size_t len;
1127
1129
1130 for (j = 0; j < ARRAY_SIZE(help_advances); j++) {
1131 help_advances[j] = FALSE;
1132 }
1133
1138
1139 helptext_advance(buf, sizeof(buf), client.conn.playing, pitem->text, i);
1140 len = strlen(buf);
1141 fc_chomp(buf, len);
1142
1144
1145 w = gtk_text_view_new();
1150 gtk_widget_set_name(w, "help_text");
1156 help_box_add(w);
1158
1160 if (txt != NULL) {
1162 }
1163
1171 help_box_add(w);
1173
1175 /* FIXME: need a more general mechanism for this, since this
1176 * helptext needs to be shown in all possible req source types. */
1178 if (VUT_ADVANCE == preq->source.kind
1179 && preq->source.value.advance == padvance) {
1182 w = gtk_label_new(_("Allows"));
1188 }
1191
1192 improvement_iterate(pimprove) {
1193 if (valid_improvement(pimprove)) {
1194 requirement_vector_iterate(&pimprove->reqs, preq) {
1195 if (VUT_ADVANCE == preq->source.kind
1196 && preq->source.value.advance == padvance) {
1199 w = gtk_label_new(_("Allows"));
1202 is_great_wonder(pimprove)
1203 ? HELP_WONDER
1207 }
1209 requirement_vector_iterate(&pimprove->obsolete_by, pobs) {
1210 if (pobs->source.kind == VUT_ADVANCE
1211 && pobs->source.value.advance == padvance
1212 && pobs->present) {
1215 w = gtk_label_new(_("Obsoletes"));
1218 is_great_wonder(pimprove)
1219 ? HELP_WONDER
1223 }
1225 }
1227
1230 continue;
1231 }
1232
1235 w = gtk_label_new(_("Allows"));
1241
1247 w = gtk_label_new(_("Allows"));
1252 } else {
1255 w = gtk_label_new(_("Allows"));
1259 w = gtk_label_new(_("with"));
1262 AR_TWO)),
1263 HELP_TECH);
1265 w = gtk_label_new(Q_("?techhelp:"));
1268 }
1269 }
1273 w = gtk_label_new(_("Allows"));
1277 w = gtk_label_new(_("with"));
1280 AR_ONE)),
1281 HELP_TECH);
1283 w = gtk_label_new(Q_("?techhelp:"));
1286 }
1288
1290 }
1291}
1292
1293/**********************************************************************/
1315
1316/**********************************************************************/
1320 enum unit_activity act,
1321 char *label)
1322{
1323 enum extra_cause cause = activity_to_extra_cause(act);
1324
1325 extra_type_by_cause_iterate(cause, pextra) {
1326 if (pextra->buildable
1327 && requirement_fulfilled_by_terrain(pterr, &(pextra->reqs))) {
1331 act));
1332 }
1334}
1335
1336/**********************************************************************/
1339static void help_update_terrain(const struct help_item *pitem,
1340 char *title)
1341{
1342 char buf[8192];
1343 struct terrain *pterrain = terrain_by_translated_name(title);
1344
1345 if (pterrain != NULL) {
1346 struct universal for_terr = { .kind = VUT_TERRAIN, .value = { .terrain = pterrain }};
1347
1349
1350 {
1351 /* 25 => "1.25"; 50 => "1.5"; 100 => "2.0" */
1352 int defbonus = pterrain->defense_bonus + 100;
1353 int frac = defbonus % 100;
1354
1355 if ((frac % 10) == 0) {
1356 frac /= 10;
1357 }
1358 sprintf(buf, "%d/%d.%d",
1359 pterrain->movement_cost, defbonus / 100, frac);
1360 }
1362
1363 sprintf(buf, "%d/%d/%d",
1364 pterrain->output[O_FOOD],
1365 pterrain->output[O_SHIELD],
1366 pterrain->output[O_TRADE]);
1368
1369 buf[0] = '\0';
1370 if (*(pterrain->resources)) {
1371 struct extra_type **r;
1372
1373 /* TODO: include resource frequency information */
1374 for (r = pterrain->resources; *r; r++) {
1375 /* TRANS: " Whales (2/1/2)," */
1376 sprintf (buf + strlen (buf), " %s (%d/%d/%d),",
1378 pterrain->output[O_FOOD] + (*r)->data.resource->output[O_FOOD],
1379 pterrain->output[O_SHIELD] + (*r)->data.resource->output[O_SHIELD],
1380 pterrain->output[O_TRADE] + (*r)->data.resource->output[O_TRADE]);
1381 }
1382 buf[strlen (buf) - 1] = '.';
1383 } else {
1384 /* TRANS: "Resources: (none)" */
1385 sprintf (buf + strlen (buf), _("(none)"));
1386 }
1388
1390
1391 if (pterrain->cultivate_result != T_NONE
1393 NULL, &for_terr)) {
1394 fc_snprintf(buf, sizeof(buf),
1395 PL_("%d turn", "%d turns", pterrain->cultivate_time),
1396 pterrain->cultivate_time);
1397 add_act_help_for_terrain(_("Cultivate Rslt/Time"),
1399 HELP_TERRAIN, buf);
1400 }
1401
1402 if (pterrain->plant_result != T_NONE
1404 fc_snprintf(buf, sizeof(buf),
1405 PL_("%d turn", "%d turns", pterrain->plant_time),
1406 pterrain->plant_time);
1407 add_act_help_for_terrain(_("Plant Rslt/Time"),
1409 HELP_TERRAIN, buf);
1410 }
1411
1412 if (pterrain->transform_result != T_NONE
1414 NULL, &for_terr)) {
1415 fc_snprintf(buf, sizeof(buf),
1416 PL_("%d turn", "%d turns", pterrain->transform_time),
1417 pterrain->transform_time);
1418 add_act_help_for_terrain(_("Trans. Rslt/Time"),
1420 HELP_TERRAIN, buf);
1421 }
1422
1425 _("Build as irrigation"));
1426 }
1429 _("Build as mine"));
1430 }
1433 _("Build as road"));
1434 }
1437 _("Build as base"));
1438 }
1440 }
1441
1443 pitem->text, pterrain);
1444
1447
1449}
1450
1451/**********************************************************************/
1454static void help_update_extra(const struct help_item *pitem, char *title)
1455{
1456 char buf[8192];
1458
1459 buf[0] = '\0';
1460 if (pextra == NULL) {
1461 strcat(buf, pitem->text);
1462 } else {
1463 struct road_type *proad = extra_road_get(pextra);
1465
1467
1468 /* Cost to build */
1469 if (pextra->buildable) {
1470 if (pextra->build_time != 0) {
1471 /* TRANS: "MP" = movement points */
1472 sprintf(buf, _("%d MP"), pextra->build_time);
1473 } else {
1474 /* TRANS: Build time depends on terrain. */
1475 sprintf(buf, _("Terrain specific"));
1476 }
1477 } else {
1478 sprintf(buf, "-");
1479 }
1481 /* Conflicting extras */
1482 buf[0] = '\0';
1483 if (is_resource) {
1484 /* TRANS: (Resource extra) Conflicts with: */
1485 strcat(buf, _("Other Resources"));
1486 }
1488 if (!can_extras_coexist(pextra, pextra2)
1490 if (buf[0] != '\0') {
1491 strcat(buf, "/");
1492 }
1494 }
1496 /* TRANS: "Conflicts with: (none)" (extras) */
1497 gtk_label_set_text(GTK_LABEL(help_elabel[3]), buf[0] ? buf : _("(none)"));
1498
1499 /* Bonus */
1500 if (proad != NULL) {
1501 const char *bonus = NULL;
1502
1504 if (proad->tile_incr[o] > 0) {
1505 /* TRANS: Road bonus depends on terrain. */
1506 bonus = _("Terrain specific");
1507 break;
1508 }
1510 if (bonus == NULL) {
1512
1513 if (bonus == NULL) {
1514 /* TRANS: No output bonus from a road */
1515 bonus = Q_("?bonus:None");
1516 }
1517 }
1519 } else {
1520 gtk_label_set_text(GTK_LABEL(help_elabel[5]), Q_("?bonus:None"));
1521 }
1522
1523 helptext_extra(buf, sizeof(buf), client.conn.playing, pitem->text, pextra);
1524 }
1526
1529}
1530
1531/**********************************************************************/
1534static void help_update_goods(const struct help_item *pitem,
1535 char *title)
1536{
1537 char buf[8192];
1539
1540 if (pgood == NULL) {
1541 strcat(buf, pitem->text);
1542 } else {
1543 helptext_goods(buf, sizeof(buf), client.conn.playing, pitem->text,
1544 pgood);
1545 }
1546
1549}
1550
1551/**********************************************************************/
1554static void help_update_specialist(const struct help_item *pitem,
1555 char *title)
1556{
1557 char buf[8192];
1559
1560 if (pspec == NULL) {
1561 strcat(buf, pitem->text);
1562 } else {
1564 pspec);
1565 }
1566
1569}
1570
1571/**********************************************************************/
1574static void help_update_government(const struct help_item *pitem,
1575 char *title)
1576{
1577 char buf[8192];
1579
1580 if (gov == NULL) {
1581 strcat(buf, pitem->text);
1582 } else {
1584 pitem->text, gov);
1585 }
1586
1589}
1590
1591/**********************************************************************/
1594static void help_update_nation(const struct help_item *pitem, char *title,
1595 struct nation_type *pnation)
1596{
1597 char buf[4096];
1598
1599 if (pnation == NULL) {
1600 strcat(buf, pitem->text);
1601 } else {
1602 helptext_nation(buf, sizeof(buf), pnation, pitem->text);
1603
1605 }
1606
1609}
1610
1611/**********************************************************************/
1614static void help_update_dialog(const struct help_item *pitem)
1615{
1616 char *top;
1617
1618 /* Figure out what kind of item is required for pitem ingo */
1619
1620 for (top = pitem->topic; *top == ' '; top++) {
1621 /* Nothing */
1622 }
1623
1624 help_box_hide();
1626
1627 switch (pitem->type) {
1628 case HELP_IMPROVEMENT:
1630 break;
1631 case HELP_WONDER:
1633 break;
1634 case HELP_UNIT:
1636 break;
1637 case HELP_TECH:
1638 help_update_tech(pitem, top);
1639 break;
1640 case HELP_TERRAIN:
1642 break;
1643 case HELP_EXTRA:
1645 break;
1646 case HELP_GOODS:
1648 break;
1649 case HELP_SPECIALIST:
1651 break;
1652 case HELP_GOVERNMENT:
1654 break;
1655 case HELP_NATIONS:
1657 break;
1658 case HELP_TEXT:
1659 default:
1660 /* It was a pure text item */
1663 break;
1664 }
1665 set_title_topic(pitem->topic);
1666
1668}
1669
1670/**********************************************************************/
1673static void help_item_zoom(GtkTreePath *path)
1674{
1675 GtkTreeModel *model;
1676 GtkTreeIter it, child, item;
1677 GtkTreeSelection *selection;
1678
1680 gtk_tree_model_get_iter(model, &item, path);
1681
1682 for (child = item; gtk_tree_model_iter_parent(model, &it, &child); child = it) {
1684
1685 it_path = gtk_tree_model_get_path(model, &it);
1688 }
1689
1693 TRUE, 0.0, 0.0);
1694}
1695
1696/**********************************************************************/
1700{
1701 GtkTreePath *path;
1702 bool next;
1703
1704 path = gtk_tree_path_new_first();
1705 next = FALSE;
1707 const char *s;
1708 int depth;
1709
1710 for (s = pitem2->topic; *s == ' '; s++) {
1711 /* Nothing */
1712 }
1713 depth = s - pitem2->topic + 1;
1714
1715 while (depth < gtk_tree_path_get_depth(path)) {
1716 gtk_tree_path_up(path);
1717 gtk_tree_path_next(path);
1718 next = FALSE;
1719 }
1720 while (depth > gtk_tree_path_get_depth(path)) {
1721 gtk_tree_path_down(path);
1722 next = FALSE;
1723 }
1724
1725 if (next) {
1726 gtk_tree_path_next(path);
1727 }
1728
1729 if (pitem == pitem2) {
1730 break;
1731 }
1732
1733 next = TRUE;
1735
1736 return path;
1737}
1738
1739/**********************************************************************/
1742static void select_help_item_string(const char *item, enum help_page_type htype)
1743{
1744 const struct help_item *pitem;
1745 int idx;
1746 GtkTreePath *path;
1748
1749 if (!(pitem = get_help_item_spec(item, htype, &idx))) {
1750 return;
1751 }
1752
1753 path = help_item_path(pitem);
1754 help_item_zoom(path);
1755
1758 gtk_tree_path_free(path);
1759}
1760
1761/**********************************************************************/
1764static void help_command_update(void)
1765{
1767
1768 if (help_history_pos < 0) {
1771 } else {
1774
1775 if (help_history_pos == 0) {
1777 }
1778 if (help_history_pos >= help_history->len - 1) {
1780 }
1781 }
1782}
1783
1784/**********************************************************************/
1788{
1789 GtkTreePath *path;
1790 const struct help_item *pitem;
1791
1792 if (response_id == 1) {
1793 if (help_history_pos > 0) {
1795
1797 path = help_item_path(pitem);
1798 help_item_zoom(path);
1801 }
1802 } else if (response_id == 2) {
1805
1807 path = help_item_path(pitem);
1808 help_item_zoom(path);
1811 }
1812 } else {
1813 /* Save size of the dialog. */
1818 }
1819}
#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 setup_dialog(GtkWidget *shell, GtkWidget *parent)
Definition gui_stuff.c:287
static GtkWidget * help_tree_sw
Definition helpdlg.c:84
static void set_title_topic(char *topic)
Definition helpdlg.c:174
static void activated_topic(GtkTreeView *view, gpointer data)
Definition helpdlg.c:470
static GtkWidget * help_tree
Definition helpdlg.c:81
static GtkWidget * help_tree_expand
Definition helpdlg.c:85
static GtkWidget * help_ulabel[5][5]
Definition helpdlg.c:90
static void help_update_specialist(const struct help_item *pitem, char *title)
Definition helpdlg.c:1504
static void help_hyperlink_callback(GtkWidget *w)
Definition helpdlg.c:346
static GtkWidget * help_elabel[6]
Definition helpdlg.c:92
static GtkWidget * help_etable
Definition helpdlg.c:80
static void help_destroy_callback(GtkWidget *w, gpointer data)
Definition helpdlg.c:461
static void set_help_tile_from_extra(const struct extra_type *pextra)
Definition helpdlg.c:849
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:313
static void help_update_tech(const struct help_item *pitem, char *title)
Definition helpdlg.c:1076
static void help_item_zoom(GtkTreePath *path)
Definition helpdlg.c:1622
static GtkWidget * help_slink_new_page(const gchar *txt, enum help_page_type page)
Definition helpdlg.c:428
static GtkWidget * help_tlabel[2][5]
Definition helpdlg.c:91
static GtkTreePath * help_item_path(const struct help_item *pitem)
Definition helpdlg.c:1648
static GtkWidget * help_tree_collapse
Definition helpdlg.c:86
static void help_update_nation(const struct help_item *pitem, char *title, struct nation_type *pnation)
Definition helpdlg.c:1543
static void create_help_dialog(void)
Definition helpdlg.c:510
static GtkTextBuffer * help_text
Definition helpdlg.c:71
static void help_update_wonder(const struct help_item *pitem, char *title)
Definition helpdlg.c:927
static GtkWidget * help_hyperlink_new_page(GtkWidget *label, enum help_page_type page)
Definition helpdlg.c:403
static GtkWidget * help_dialog_shell
Definition helpdlg.c:64
static GtkWidget * help_text_sw
Definition helpdlg.c:72
static GPtrArray * help_history
Definition helpdlg.c:96
static const char * help_elabel_name[6]
Definition helpdlg.c:133
static void create_tech_tree(int tech, int levels, GtkTreeIter *parent)
Definition helpdlg.c:227
static void help_update_extra(const struct help_item *pitem, char *title)
Definition helpdlg.c:1405
static GtkWidget * help_ilabel[6]
Definition helpdlg.c:88
static void set_help_tile_from_sprite(struct sprite *spr)
Definition helpdlg.c:805
static const char * help_wlabel_name[6]
Definition helpdlg.c:112
static const char * help_ulabel_name[5][5]
Definition helpdlg.c:118
static void help_tech_tree_collapse_callback(GtkWidget *w, gpointer data)
Definition helpdlg.c:338
static void set_help_tile_from_terrain(struct terrain *pterr)
Definition helpdlg.c:818
static GtkWidget * help_view
Definition helpdlg.c:67
static void help_update_goods(const struct help_item *pitem, char *title)
Definition helpdlg.c:1484
void help_system_init(void)
Definition helpdlg.c:158
static void help_box_hide(void)
Definition helpdlg.c:437
static void help_update_unit_type(const struct help_item *pitem, char *title)
Definition helpdlg.c:991
void popdown_help_dialog(void)
Definition helpdlg.c:187
static void help_update_terrain(const struct help_item *pitem, char *title)
Definition helpdlg.c:1290
static void help_update_dialog(const struct help_item *pitem)
Definition helpdlg.c:1563
static char * fc_chomp(char *str, size_t len)
Definition helpdlg.c:1056
void popup_help_dialog_string(const char *item)
Definition helpdlg.c:213
static int help_history_pos
Definition helpdlg.c:97
static struct help_page_selection help_wndr_req
Definition helpdlg.c:114
static GtkWidget * help_wlabel[6]
Definition helpdlg.c:89
static GtkWidget * help_box
Definition helpdlg.c:75
static void help_extras_of_act_for_terrain(struct terrain *pterr, enum unit_activity act, char *label)
Definition helpdlg.c:1270
void popup_help_dialog_typed(const char *item, enum help_page_type htype)
Definition helpdlg.c:197
#define REQ_LABEL_NEVER
Definition helpdlg.c:145
static void help_command_update(void)
Definition helpdlg.c:1712
static struct help_page_selection page_selections[HELP_LAST]
Definition helpdlg.c:116
#define TECH_TREE_DEPTH
Definition helpdlg.c:59
static const char * help_tlabel_name[2][5]
Definition helpdlg.c:127
static struct help_page_selection help_impr_req
Definition helpdlg.c:110
#define REQ_LABEL_NONE
Definition helpdlg.c:144
static GtkWidget * help_wtable
Definition helpdlg.c:77
static GtkWidget * help_slink_new(const gchar *txt, struct help_page_selection *select)
Definition helpdlg.c:412
static GtkWidget * help_vbox
Definition helpdlg.c:73
static void help_tech_tree_expand_callback(GtkWidget *w, gpointer data)
Definition helpdlg.c:330
static GtkWidget * help_tile
Definition helpdlg.c:74
static GtkWidget * help_hyperlink_new(GtkWidget *label, struct help_page_selection *select)
Definition helpdlg.c:381
static void help_update_government(const struct help_item *pitem, char *title)
Definition helpdlg.c:1524
static GtkWidget * help_ttable
Definition helpdlg.c:79
static void help_update_improvement(const struct help_item *pitem, char *title)
Definition helpdlg.c:877
static const char * help_ilabel_name[6]
Definition helpdlg.c:108
static GtkWidget * help_tree_buttons_hbox
Definition helpdlg.c:87
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:1690
static bool help_advances[A_LAST]
Definition helpdlg.c:94
static GtkWidget * help_utable
Definition helpdlg.c:78
static GtkWidget * help_itable
Definition helpdlg.c:76
static GtkTreeStore * tstore
Definition helpdlg.c:82
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:1247
static void help_command_callback(GtkWidget *w, gint response_id)
Definition helpdlg.c:1735
const char * title
Definition repodlgs.c:1314
GType type
Definition repodlgs.c:1313
static void help_box_add(GtkWidget *wdg)
Definition helpdlg.c:456
static int help_dlog_height
Definition helpdlg.c:70
static void help_box_clear(void)
Definition helpdlg.c:464
static int help_dlog_width
Definition helpdlg.c:70
void picture_set_from_surface(GtkPicture *pic, cairo_surface_t *surf)
Definition sprite.c:544
void helptext_government(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct government *gov)
Definition helpdata.c:4400
void helptext_advance(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, int i)
Definition helpdata.c:3359
enum help_page_type help_type_by_requirement(const struct requirement *req)
Definition helpdata.c:5265
char * helptext_unit(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct unit_type *utype, bool class_help)
Definition helpdata.c:1992
void helptext_extra(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct extra_type *pextra)
Definition helpdata.c:3854
void helptext_goods(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct goods_type *pgood)
Definition helpdata.c:4319
const char * helptext_road_bonus_str(const struct terrain *pterrain, const struct road_type *proad)
Definition helpdata.c:3690
char * helptext_unit_upkeep_str(const struct unit_type *utype)
Definition helpdata.c:5062
const char * helptext_extra_for_terrain_str(struct extra_type *pextra, struct terrain *pterrain, enum unit_activity act)
Definition helpdata.c:3820
void helptext_specialist(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct specialist *pspec)
Definition helpdata.c:4365
const struct help_item * get_help_item_spec(const char *name, enum help_page_type htype, int *pos)
Definition helpdata.c:1346
char * helptext_building(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, const struct impr_type *pimprove)
Definition helpdata.c:1439
void helptext_terrain(char *buf, size_t bufsz, struct player *pplayer, const char *user_text, struct terrain *pterrain)
Definition helpdata.c:3580
void helptext_nation(char *buf, size_t bufsz, struct nation_type *pnation, const char *user_text)
Definition helpdata.c:5099
#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:1047
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:103
const struct requirement * req
Definition helpdlg.c:104
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:6784
int fill_basic_extra_sprite_array(const struct tileset *t, struct drawn_sprite *sprs, const struct extra_type *pextra)
Definition tilespec.c:7201
int fill_basic_terrain_layer_sprite_array(struct tileset *t, struct drawn_sprite *sprs, int layer, struct terrain *pterrain)
Definition tilespec.c:7168
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:6806
struct sprite * get_nation_flag_sprite(const struct tileset *t, const struct nation_type *pnation)
Definition tilespec.c:6757
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:6775
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