Package: sgt-puzzles / 20170606.272beef-1

202_online-help.diff Patch series | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
Author: Ben Hutchings <ben@decadent.org.uk>
Description: Add HTML-based online help

This works along the same lines as the Windows implementation,
though we have to try a bit harder to find a help browser.

--- a/gtk.c
+++ b/gtk.c
@@ -2,6 +2,10 @@
  * gtk.c: GTK front end for my puzzle collection.
  */
 
+#ifndef _POSIX_C_SOURCE
+#define _POSIX_C_SOURCE 1 /* for PATH_MAX */
+#endif
+
 #include <stdio.h>
 #include <assert.h>
 #include <stdlib.h>
@@ -10,6 +14,9 @@
 #include <string.h>
 #include <errno.h>
 #include <math.h>
+#include <limits.h>
+#include <unistd.h>
+#include <locale.h>
 
 #include <sys/time.h>
 #include <sys/resource.h>
@@ -2317,6 +2324,89 @@ static void menu_config_event(GtkMenuIte
     midend_redraw(fe->me);
 }
 
+#ifndef HELP_BROWSER_PATH
+#define HELP_BROWSER_PATH "xdg-open:sensible-browser"
+#endif
+
+static void show_help(frontend *fe, const char *topic)
+{
+    const char *list = HELP_BROWSER_PATH;
+    char path[PATH_MAX + 1];
+    struct {
+	const char *s;
+	int len;
+    } lang[3];
+    int i;
+
+    /*
+     * Search for help file, trying:
+     * 1. Version for this locale, ignoring encoding (HTML browsers
+     *    must handle multiple encodings)
+     * 2. Version for this locale, ignoring encoding and country
+     * 3. English version
+     */
+    lang[0].s = setlocale(LC_MESSAGES, NULL);
+    lang[0].len = strcspn(lang[0].s, ".@");
+    lang[1].s = lang[0].s;
+    lang[1].len = strcspn(lang[1].s, "_");
+    if (lang[1].len > lang[0].len)
+	lang[1].len = lang[0].len;
+    lang[2].s = "en";
+    lang[2].len = 2;
+    for (i = 0; i < lenof(lang); i++) {
+	sprintf(path, "%s/sgt-puzzles/help/%.*s/%s.html",
+		SHAREDIR, lang[i].len, lang[i].s, topic);
+	if (access(path, R_OK) == 0)
+	    break;
+    }
+    if (i == lenof(lang)) {
+	error_box(fe->window, "Help file is not installed");
+	return;
+    }
+
+    for (;;) {
+	size_t len;
+	char buf[PATH_MAX + 1];
+	const char *command;
+	const char *argv[3];
+
+	len = strcspn(list, ":");
+	if (len <= PATH_MAX) {
+	    memcpy(buf, list, len);
+	    buf[len] = 0;
+	    if (buf[0] == '$')
+		command = getenv(buf + 1);
+	    else
+		command = buf;
+	    if (command) {
+		argv[0] = command;
+		argv[1] = path;
+		argv[2] = NULL;
+		if (g_spawn_async(NULL, (char **)argv, NULL,
+				  G_SPAWN_SEARCH_PATH,
+				  NULL, NULL, NULL, NULL))
+		    return;
+	    }
+	}
+
+	if (!list[len])
+	    break;
+	list += len + 1;
+    }
+
+    error_box(fe->window, "Failed to start a help browser");
+}
+
+static void menu_help_contents_event(GtkMenuItem *menuitem, gpointer data)
+{
+    show_help((frontend *)data, "index");
+}
+
+static void menu_help_specific_event(GtkMenuItem *menuitem, gpointer data)
+{
+    show_help((frontend *)data, thegame.htmlhelp_topic);
+}
+
 static void menu_about_event(GtkMenuItem *menuitem, gpointer data)
 {
     frontend *fe = (frontend *)data;
@@ -2655,6 +2745,25 @@ static frontend *new_window(char *arg, i
     menu = gtk_menu_new();
     gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), menu);
 
+    menuitem = gtk_menu_item_new_with_label("Contents");
+    gtk_container_add(GTK_CONTAINER(menu), menuitem);
+    g_signal_connect(G_OBJECT(menuitem), "activate",
+		     G_CALLBACK(menu_help_contents_event), fe);
+    gtk_widget_show(menuitem);
+
+    if (thegame.htmlhelp_topic) {
+	char *item;
+	assert(thegame.name);
+	item = snewn(9+strlen(thegame.name), char); /*ick*/
+	sprintf(item, "Help on %s", thegame.name);
+	menuitem = gtk_menu_item_new_with_label(item);
+	sfree(item);
+	gtk_container_add(GTK_CONTAINER(menu), menuitem);
+	g_signal_connect(G_OBJECT(menuitem), "activate",
+			 G_CALLBACK(menu_help_specific_event), fe);
+	gtk_widget_show(menuitem);
+    }
+
     menuitem = gtk_menu_item_new_with_label("About");
     gtk_container_add(GTK_CONTAINER(menu), menuitem);
     g_signal_connect(G_OBJECT(menuitem), "activate",
--- a/Recipe
+++ b/Recipe
@@ -95,6 +95,7 @@ Puzzles.dmg: Puzzles
 
 !begin am
 bin_PROGRAMS = $(GAMES)
+GTK_CFLAGS += -DSHAREDIR="\"$(datarootdir)\""
 !end
 !begin am_begin
 GAMES =