90b2c5d4 |
1 | /* -*-c-*- |
2 | * |
3adf144a |
3 | * $Id: xgetline.c,v 1.12 2002/01/13 14:43:41 mdw Exp $ |
90b2c5d4 |
4 | * |
5 | * Fetch a line of text from the user |
6 | * |
7 | * (c) 1998 Straylight/Edgeware |
8 | */ |
9 | |
10 | /*----- Licensing notice --------------------------------------------------* |
11 | * |
12 | * This file is part of the Edgeware X tools collection. |
13 | * |
14 | * X tools is free software; you can redistribute it and/or modify |
15 | * it under the terms of the GNU General Public License as published by |
16 | * the Free Software Foundation; either version 2 of the License, or |
17 | * (at your option) any later version. |
18 | * |
19 | * X tools is distributed in the hope that it will be useful, |
20 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
22 | * GNU General Public License for more details. |
23 | * |
24 | * You should have received a copy of the GNU General Public License |
25 | * along with X tools; if not, write to the Free Software Foundation, |
26 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
27 | */ |
28 | |
29 | /*----- Revision history --------------------------------------------------* |
30 | * |
31 | * $Log: xgetline.c,v $ |
3adf144a |
32 | * Revision 1.12 2002/01/13 14:43:41 mdw |
33 | * Kill some spurious warnings. |
34 | * |
d0639ab5 |
35 | * Revision 1.11 1999/08/20 07:30:33 mdw |
36 | * Miscellaneous changes, mostly concerning options parsing. |
37 | * |
e34817d8 |
38 | * Revision 1.10 1999/05/21 22:09:19 mdw |
39 | * Take advantage of new dynamic string macros. |
40 | * |
b907fbe4 |
41 | * Revision 1.9 1999/05/05 18:54:37 mdw |
42 | * Keep blank lines out of the history list. |
43 | * |
cb171cd0 |
44 | * Revision 1.8 1998/12/16 19:58:53 mdw |
45 | * Stop the dropdown list from dropping down when you press enter. |
46 | * |
715c9c39 |
47 | * Revision 1.7 1998/12/11 09:53:02 mdw |
48 | * Updates for mLib/mgLib. Support history files for recalling past |
49 | * entries, using a drop-down list. |
50 | * |
208b901e |
51 | * Revision 1.6 1998/12/03 00:56:29 mdw |
52 | * Set focus on the entry field, rather than leaving things to luck. |
53 | * |
7347b0d9 |
54 | * Revision 1.5 1998/12/03 00:39:44 mdw |
55 | * Force focus when starting up. |
56 | * |
d6130abd |
57 | * Revision 1.4 1998/11/30 22:36:47 mdw |
58 | * Tidy up tabbing in help texts very slightly. |
59 | * |
f3b35b6b |
60 | * Revision 1.3 1998/11/21 22:30:20 mdw |
61 | * Support GNU-style long options throughout, and introduce proper help |
62 | * text to all programs. Update manual pages to match. |
63 | * |
881bb211 |
64 | * Revision 1.2 1998/11/18 21:25:30 mdw |
65 | * Remove bogus `-h' option from the options list. |
66 | * |
90b2c5d4 |
67 | * Revision 1.1 1998/11/16 23:00:49 mdw |
68 | * Initial versions. |
69 | * |
70 | */ |
71 | |
72 | /*----- Header files ------------------------------------------------------*/ |
73 | |
74 | #include <stdio.h> |
75 | #include <stdlib.h> |
76 | #include <string.h> |
77 | |
715c9c39 |
78 | #include <fcntl.h> |
79 | #include <unistd.h> |
80 | |
90b2c5d4 |
81 | #include <gtk/gtk.h> |
82 | #include <gdk/gdkkeysyms.h> |
83 | |
715c9c39 |
84 | #include <mLib/alloc.h> |
85 | #include <mLib/dstr.h> |
86 | #include <mLib/mdwopt.h> |
87 | #include <mLib/report.h> |
88 | #include <mLib/quis.h> |
89 | |
90 | #include <mgLib/cancel.h> |
91 | #include <mgLib/mdwfocus.h> |
90b2c5d4 |
92 | |
93 | /*----- Main code ---------------------------------------------------------*/ |
94 | |
715c9c39 |
95 | /* --- @quit@ --- * |
90b2c5d4 |
96 | * |
97 | * Arguments: @GtkWidget *w@ = widget raising the signal |
98 | * @gpointer *p@ = pointer to integer result code |
99 | * |
100 | * Returns: --- |
101 | * |
102 | * Use: Sets the result code to zero (failure) and ends the loop. |
103 | */ |
104 | |
715c9c39 |
105 | static void quit(GtkWidget *w, gpointer *p) |
90b2c5d4 |
106 | { |
107 | int *ip = (int *)p; |
108 | *ip = 0; |
109 | gtk_main_quit(); |
110 | } |
111 | |
112 | /* --- @done@ --- * |
113 | * |
114 | * Arguments: @GtkWidget *w@ = widget raising the signal |
115 | * @gpointer *p@ = pointer to integer result code |
116 | * |
117 | * Returns: --- |
118 | * |
119 | * Use: Sets the result code nonzero (success) and ends the loop. |
120 | */ |
121 | |
122 | static void done(GtkWidget *w, gpointer *p) |
123 | { |
124 | int *ip = (int *)p; |
125 | *ip = 1; |
126 | gtk_main_quit(); |
127 | } |
128 | |
f3b35b6b |
129 | /* --- @version@ --- * |
130 | * |
131 | * Arguments: @FILE *fp@ = output stream to print the message on |
132 | * |
133 | * Returns: --- |
134 | * |
135 | * Use: Spits out a version message. |
136 | */ |
137 | |
138 | static void version(FILE *fp) |
139 | { |
140 | fprintf(fp, "%s (xtoys version " VERSION ")\n", QUIS); |
141 | } |
142 | |
143 | /* --- @usage@ --- * |
144 | * |
145 | * Arguments: @FILE *fp@ = output stream to print the message on |
146 | * |
147 | * Returns: --- |
148 | * |
149 | * Use: Spits out a usage message. |
150 | */ |
151 | |
152 | static void usage(FILE *fp) |
153 | { |
715c9c39 |
154 | fprintf(fp, |
155 | "Usage: %s [-in] [-t title] [-p prompt] [-d default]\n" |
156 | "\t[-l|-H file] [-m max]\n", |
157 | QUIS); |
f3b35b6b |
158 | } |
159 | |
90b2c5d4 |
160 | /* --- @main@ --- * |
161 | * |
162 | * Arguments: @int argc@ = number of command line arguments |
163 | * @char *argv[]@ = addresses of arguments |
164 | * |
165 | * Returns: Zero if OK, and we read a string; nonzero if the user |
166 | * cancelled. |
167 | * |
168 | * Use: Reads a string from the user, and returns it on standard |
169 | * output. |
170 | */ |
171 | |
172 | int main(int argc, char *argv[]) |
173 | { |
174 | /* --- Configuration variables --- */ |
175 | |
176 | char *prompt = 0; |
177 | char *dfl = ""; |
178 | char *title = "Input request"; |
179 | int left; |
180 | unsigned f = 0; |
181 | int ok = 0; |
182 | |
715c9c39 |
183 | const char *list = 0; |
184 | int histmax = 20; |
3adf144a |
185 | GList *hist = 0; |
715c9c39 |
186 | |
3adf144a |
187 | #define f_invis 1u |
188 | #define f_duff 2u |
189 | #define f_history 4u |
190 | #define f_nochoice 8u |
90b2c5d4 |
191 | |
192 | /* --- User interface bits --- */ |
193 | |
194 | GtkWidget *win; |
195 | GtkWidget *box; |
196 | GtkWidget *entry; |
197 | GtkWidget *btn; |
198 | |
199 | /* --- Crank up the toolkit --- * |
200 | * |
201 | * Have to do this here: GTK snarfs some command line options which my |
202 | * parser would barf about. |
203 | */ |
204 | |
f3b35b6b |
205 | ego(argv[0]); |
90b2c5d4 |
206 | gtk_init(&argc, &argv); |
207 | |
208 | /* --- Parse options from command line --- */ |
209 | |
210 | for (;;) { |
211 | |
212 | /* --- Long options structure --- */ |
213 | |
214 | static struct option opt[] = { |
d0639ab5 |
215 | { "help", 0, 0, 'h' }, |
216 | { "usage", 0, 0, 'u' }, |
217 | { "version", 0, 0, 'v' }, |
218 | { "title", OPTF_ARGREQ, 0, 't' }, |
219 | { "prompt", OPTF_ARGREQ, 0, 'p' }, |
220 | { "default", OPTF_ARGREQ, 0, 'd' }, |
221 | { "password", 0, 0, 'i' }, |
222 | { "invisible", 0, 0, 'i' }, |
223 | { "history", OPTF_ARGREQ, 0, 'H' }, |
224 | { "list", OPTF_ARGREQ, 0, 'l' }, |
225 | { "histmax", OPTF_ARGREQ, 0, 'm' }, |
226 | { "no-choice", 0, 0, 'n' }, |
227 | { 0, 0, 0, 0 } |
90b2c5d4 |
228 | }; |
229 | int i; |
230 | |
231 | /* --- Fetch an option --- */ |
232 | |
715c9c39 |
233 | i = getopt_long(argc, argv, "huv t:p:d:i H:l:m:n", opt, 0); |
90b2c5d4 |
234 | if (i < 0) |
235 | break; |
236 | |
237 | /* --- Work out what to do with it --- */ |
238 | |
239 | switch (i) { |
f3b35b6b |
240 | case 'h': |
241 | version(stdout); |
242 | fputs("\n", stdout); |
243 | usage(stdout); |
d0639ab5 |
244 | fputs("\ |
245 | \n\ |
246 | Pops up a small window requesting input from a user, and echoes the\n\ |
247 | response to stdout, where it can be collected by a shell script.\n\ |
248 | \n\ |
249 | Options available are:\n\ |
250 | \n\ |
251 | -h, --help Display this help text\n\ |
252 | -u, --usage Display a short usage summary\n\ |
253 | -v, --version Display the program's version number\n\ |
254 | \n\ |
255 | -i, --invisible Don't show the user's string as it's typed\n\ |
256 | -t, --title=TITLE Set the window's title string\n\ |
257 | -p, --prompt=PROMPT Set the window's prompt string\n\ |
258 | -d, --default=DEFAULT Set the default string already in the window\n\ |
259 | \n\ |
260 | -l, --list=FILE Read FILE into a drop-down list\n\ |
261 | -n, --no-choice No free text input: must choose item from list\n\ |
262 | -H, --history=FILE As for `--list', but update with new string\n\ |
263 | -m, --histmax=MAX Maximum number of items written back to file\n", |
f3b35b6b |
264 | stdout); |
265 | exit(0); |
266 | break; |
267 | case 'u': |
268 | usage(stdout); |
269 | exit(0); |
270 | break; |
271 | case 'v': |
272 | version(stdout); |
273 | exit(0); |
274 | break; |
715c9c39 |
275 | |
90b2c5d4 |
276 | case 't': |
277 | title = optarg; |
278 | break; |
279 | case 'p': |
280 | prompt = optarg; |
281 | break; |
282 | case 'd': |
283 | dfl = optarg; |
284 | break; |
285 | case 'i': |
286 | f |= f_invis; |
287 | break; |
715c9c39 |
288 | |
289 | case 'l': |
290 | list = optarg; |
291 | break; |
292 | case 'n': |
293 | f |= f_nochoice; |
294 | break; |
295 | case 'H': |
296 | f |= f_history; |
297 | list = optarg; |
298 | break; |
299 | case 'm': |
300 | histmax = atoi(optarg); |
301 | break; |
302 | |
90b2c5d4 |
303 | default: |
304 | f |= f_duff; |
305 | break; |
306 | } |
307 | } |
308 | |
309 | if (f & f_duff) { |
f3b35b6b |
310 | usage(stderr); |
90b2c5d4 |
311 | exit(EXIT_FAILURE); |
312 | } |
313 | |
715c9c39 |
314 | if ((f & f_invis) && list) { |
315 | die(EXIT_FAILURE, |
316 | "invisible entry is dumb if you provide a list of alternatives!"); |
317 | } |
318 | |
319 | if ((f & f_nochoice) && !list) |
320 | die(EXIT_FAILURE, "nothing to restrict choice to!"); |
321 | |
90b2c5d4 |
322 | /* --- Create the main window --- */ |
323 | |
324 | win = gtk_window_new(GTK_WINDOW_TOPLEVEL); |
325 | gtk_window_set_title(GTK_WINDOW(win), title); |
326 | gtk_window_position(GTK_WINDOW(win), GTK_WIN_POS_MOUSE); |
327 | gtk_signal_connect(GTK_OBJECT(win), "destroy", |
715c9c39 |
328 | GTK_SIGNAL_FUNC(quit), &ok); |
90b2c5d4 |
329 | |
330 | /* --- Create the box for laying out the widgets inside --- */ |
331 | |
332 | left = (prompt ? 1 : 0); |
333 | box = gtk_table_new(left + 2, 1, 0); |
334 | |
335 | /* --- Maybe create a prompt widget --- */ |
336 | |
337 | if (prompt) { |
338 | GtkWidget *w = gtk_label_new(prompt); |
339 | gtk_table_attach(GTK_TABLE(box), w, |
340 | 0, 1, 0, 1, 0, GTK_EXPAND, 4, 2); |
341 | gtk_widget_show(w); |
342 | } |
343 | |
344 | /* --- Create the entry widget --- */ |
345 | |
715c9c39 |
346 | if (list) { |
347 | FILE *fp = fopen(list, "r"); |
348 | GtkWidget *combo; |
349 | |
350 | /* --- Read the items in from the file --- * |
351 | * |
352 | * Inability to open the file is not a disaster. |
353 | */ |
354 | |
715c9c39 |
355 | if (fp) { |
e34817d8 |
356 | dstr d = DSTR_INIT; |
715c9c39 |
357 | |
715c9c39 |
358 | while (dstr_putline(&d, fp) != EOF) { |
359 | hist = g_list_append(hist, xstrdup(d.buf)); |
d0639ab5 |
360 | DRESET(&d); |
715c9c39 |
361 | } |
d0639ab5 |
362 | dstr_destroy(&d); |
715c9c39 |
363 | fclose(fp); |
364 | } |
365 | |
366 | /* --- Now create a combo box --- */ |
367 | |
368 | combo = gtk_combo_new(); |
369 | entry = GTK_COMBO(combo)->entry; |
370 | if (hist) |
371 | gtk_combo_set_popdown_strings(GTK_COMBO(combo), hist); |
372 | |
373 | /* --- Do other configuring --- */ |
374 | |
375 | if (f & f_nochoice) { |
376 | gtk_combo_set_value_in_list(GTK_COMBO(combo), 1, 0); |
377 | gtk_entry_set_editable(GTK_ENTRY(entry), 0); |
378 | } |
379 | gtk_combo_set_case_sensitive(GTK_COMBO(combo), 1); |
380 | gtk_combo_set_use_arrows_always(GTK_COMBO(combo), 1); |
cb171cd0 |
381 | gtk_combo_disable_activate(GTK_COMBO(combo)); |
715c9c39 |
382 | if (strcmp(dfl, "@") == 0) |
383 | gtk_entry_set_text(GTK_ENTRY(entry), hist ? (char *)hist->data : ""); |
384 | else |
385 | gtk_entry_set_text(GTK_ENTRY(entry), dfl); |
386 | |
387 | /* --- Set the widget in the right place and show it --- */ |
388 | |
389 | gtk_table_attach(GTK_TABLE(box), combo, |
390 | left, left + 1, 0, 1, |
391 | GTK_EXPAND | GTK_FILL, GTK_EXPAND, 4, 2); |
392 | gtk_widget_show(combo); |
393 | } else { |
394 | entry = gtk_entry_new(); |
395 | gtk_entry_set_text(GTK_ENTRY(entry), dfl); |
396 | if (f & f_invis) |
397 | gtk_entry_set_visibility(GTK_ENTRY(entry), FALSE); |
398 | gtk_table_attach(GTK_TABLE(box), entry, |
399 | left, left + 1, 0, 1, |
400 | GTK_EXPAND | GTK_FILL, GTK_EXPAND, 4, 2); |
401 | gtk_widget_show(entry); |
402 | } |
90b2c5d4 |
403 | |
404 | /* --- Create the default action widget --- */ |
405 | |
406 | btn = gtk_button_new_with_label("OK"); |
407 | gtk_table_attach(GTK_TABLE(box), btn, |
408 | left + 1, left + 2, 0, 1, 0, GTK_EXPAND, 2, 2); |
409 | GTK_WIDGET_SET_FLAGS(btn, GTK_CAN_DEFAULT); |
410 | gtk_widget_show(btn); |
411 | |
412 | /* --- Add the box into the main window --- */ |
413 | |
414 | gtk_container_add(GTK_CONTAINER(win), box); |
415 | gtk_widget_show(box); |
416 | |
417 | /* --- Last minute configuration things --- */ |
418 | |
419 | gtk_widget_grab_default(btn); |
420 | gtk_signal_connect(GTK_OBJECT(btn), "clicked", |
421 | GTK_SIGNAL_FUNC(done), &ok); |
422 | gtk_signal_connect_object(GTK_OBJECT(entry), "activate", |
423 | GTK_SIGNAL_FUNC(gtk_widget_activate), |
424 | GTK_OBJECT(btn)); |
715c9c39 |
425 | cancel(GTK_WINDOW(win), 0); |
90b2c5d4 |
426 | |
427 | /* --- Go go go --- */ |
428 | |
7347b0d9 |
429 | gtk_widget_realize(win); |
430 | mdwfocus(win); |
208b901e |
431 | gtk_widget_grab_focus(entry); |
90b2c5d4 |
432 | gtk_widget_show(win); |
433 | gtk_main(); |
434 | |
435 | /* --- Output the result --- */ |
436 | |
437 | if (ok) { |
438 | char *p = gtk_entry_get_text(GTK_ENTRY(entry)); |
715c9c39 |
439 | |
440 | /* --- If history is enabled, output a new history file --- * |
441 | * |
b907fbe4 |
442 | * If the first entry was accepted verbatim, or if the entry is a blank |
443 | * line, don't bother. |
715c9c39 |
444 | */ |
445 | |
b907fbe4 |
446 | if (f & f_history && *p && !(hist && strcmp(p, hist->data) == 0)) { |
715c9c39 |
447 | int fd; |
448 | FILE *fp; |
449 | int i; |
450 | GList *g; |
451 | |
452 | if ((fd = open(list, O_WRONLY | O_CREAT | O_TRUNC, 0600)) < 0) |
453 | goto fail; |
454 | if ((fp = fdopen(fd, "w")) == 0) { |
455 | close(fd); |
456 | goto fail; |
457 | } |
458 | |
459 | fputs(p, fp); |
460 | fputc('\n', fp); |
461 | |
462 | for (i = 1, g = hist; (histmax < 1 || i < histmax) && g; g = g->next) { |
b907fbe4 |
463 | if (*(char *)g->data && strcmp(g->data, p) != 0) { |
715c9c39 |
464 | fputs(g->data, fp); |
465 | fputc('\n', fp); |
466 | i++; |
467 | } |
468 | } |
469 | fclose(fp); |
470 | fail:; |
471 | } |
472 | |
473 | /* --- Print the result and go away --- */ |
474 | |
90b2c5d4 |
475 | puts(p); |
476 | } |
477 | |
478 | return (ok ? EXIT_SUCCESS : EXIT_FAILURE); |
479 | } |
480 | |
481 | /*----- That's all, folks -------------------------------------------------*/ |