"main_menu.[ch]" -> "menus.[ch]"; it handles not only the main menu, but
[obnox/wireshark/wip.git] / gtk / main_toolbar.c
1 /* toolbar.c
2  * The main toolbar
3  * Copyright 2003, Ulf Lamping <ulf.lamping@web.de>
4  *
5  * $Id$
6  *
7  * Wireshark - Network traffic analyzer
8  * By Gerald Combs <gerald@wireshark.org>
9  * Copyright 1998 Gerald Combs
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  */
25
26 /*
27  * This file implements the "main" toolbar for Wireshark.
28  */
29
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33
34 #include <gtk/gtk.h>
35
36 #include <epan/prefs.h>
37 #include <epan/dfilter/dfilter.h>
38
39 #include "../color.h"
40 #include "../color_filters.h"
41
42 #ifdef HAVE_LIBPCAP
43 #include "gtk/capture_dlg.h"
44 #include "gtk/capture_if_dlg.h"
45 #endif /* HAVE_LIBPCAP */
46 #include "gtk/filter_dlg.h"
47 #include "gtk/capture_file_dlg.h"
48 #include "gtk/find_dlg.h"
49 #include "gtk/goto_dlg.h"
50 #include "gtk/color_dlg.h"
51 #include "gtk/prefs_dlg.h"
52 #include "gtk/main.h"
53 #include "gtk/menus.h"
54 #include "gtk/main_packet_list.h"
55 #include "gtk/main_toolbar.h"
56 #include "gtk/help_dlg.h"
57 #include "gtk/gtkglobals.h"
58 #include "gtk/stock_icons.h"
59 #include "gtk/keys.h"
60 #include "gtk/recent.h"
61 #include "gtk/packet_history.h"
62
63
64
65 /* XXX: add this key to some .h file, as it adds a key to the top level Widget? */
66 #define E_TB_MAIN_KEY             "toolbar_main"
67
68
69 static gboolean toolbar_init = FALSE;
70
71 #ifdef HAVE_LIBPCAP
72 static GtkToolItem *capture_options_button, *new_button, *stop_button, *clear_button, *if_button;
73 static GtkToolItem *capture_filter_button, *autoscroll_button;
74 #endif /* HAVE_LIBPCAP */
75 static GtkToolItem *open_button, *save_button, *close_button, *reload_button;
76 static GtkToolItem *print_button, *find_button, *history_forward_button, *history_back_button;
77 static GtkToolItem *go_to_button, *go_to_top_button, *go_to_bottom_button;
78 static GtkToolItem *display_filter_button;
79 static GtkToolItem *zoom_in_button, *zoom_out_button, *zoom_100_button, *colorize_button, *resize_columns_button;
80 static GtkToolItem *color_display_button, *prefs_button, *help_button;
81
82 #define SAVE_BUTTON_TOOLTIP_TEXT "Save this capture file..."
83 #define SAVE_AS_BUTTON_TOOLTIP_TEXT "Save this capture file as..."
84
85
86 /*
87  * Redraw all toolbars (currently only the main toolbar)
88  */
89 void
90 toolbar_redraw_all(void)
91 {
92     GtkWidget     *main_tb;
93
94     main_tb = g_object_get_data(G_OBJECT(top_level), E_TB_MAIN_KEY);
95
96     gtk_toolbar_set_style(GTK_TOOLBAR(main_tb),
97                           prefs.gui_toolbar_main_style);
98 }
99
100 /* Enable or disable toolbar items based on whether you have a capture file
101    you've finished reading. */
102 void set_toolbar_for_capture_file(gboolean have_capture_file) {
103     if (toolbar_init) {
104         gtk_widget_set_sensitive(GTK_WIDGET(save_button), have_capture_file);
105         gtk_widget_set_sensitive(GTK_WIDGET(close_button), have_capture_file);
106         gtk_widget_set_sensitive(GTK_WIDGET(reload_button), have_capture_file);
107     }
108 }
109
110 /* Enable or disable menu items based on whether you have an unsaved
111    capture file you've finished reading. */
112 void set_toolbar_for_unsaved_capture_file(gboolean have_unsaved_capture_file) {
113     GtkTooltips *tooltips;
114
115     tooltips = gtk_tooltips_new();
116
117     if (toolbar_init) {
118         if(have_unsaved_capture_file) {
119         gtk_tool_button_set_stock_id(GTK_TOOL_BUTTON(save_button),
120             GTK_STOCK_SAVE);
121         gtk_tool_item_set_tooltip(save_button, tooltips,
122             SAVE_BUTTON_TOOLTIP_TEXT, NULL);
123         g_object_set_data(G_OBJECT(save_button), "save", GINT_TO_POINTER(1));
124         } else {
125         gtk_tool_button_set_stock_id(GTK_TOOL_BUTTON(save_button),
126             GTK_STOCK_SAVE_AS);
127         gtk_tool_item_set_tooltip(save_button, tooltips,
128             SAVE_AS_BUTTON_TOOLTIP_TEXT, NULL);
129         g_object_set_data(G_OBJECT(save_button), "save", GINT_TO_POINTER(0));
130         }
131         /*gtk_widget_set_sensitive((GTK_WIDGET(save_button), have_unsaved_capture_file);
132         gtk_widget_set_sensitive(GTK_WIDGET(save_as_button), !have_unsaved_capture_file);*/
133     }
134 }
135
136 /* fudge to call correct file_save or file_save_as fcn based upon the
137    value of the "save" key associated with the save button
138 */
139
140 static void file_save_or_save_as_cmd_cb(GtkWidget *w, gpointer data) {
141     if (GPOINTER_TO_INT(g_object_get_data(G_OBJECT(save_button),"save")) == 1) {
142         file_save_cmd_cb(w, data);
143     }
144     else {
145         file_save_as_cmd_cb(w, data);
146     }
147 }
148
149 /** The packet history has changed, we need to update the menu.
150  *
151  * @param back_history some back history entries available
152  * @param forward_history some forward history entries available
153  */
154 void set_toolbar_for_packet_history(gboolean back_history, gboolean forward_history) {
155     gtk_widget_set_sensitive(GTK_WIDGET(history_back_button), back_history);
156     gtk_widget_set_sensitive(GTK_WIDGET(history_forward_button), forward_history);
157 }
158
159
160 /* set toolbar state "have a capture in progress" */
161 void set_toolbar_for_capture_in_progress(gboolean capture_in_progress) {
162
163     if (toolbar_init) {
164 #ifdef HAVE_LIBPCAP
165         gtk_widget_set_sensitive(GTK_WIDGET(capture_options_button), !capture_in_progress);
166         gtk_widget_set_sensitive(GTK_WIDGET(new_button), !capture_in_progress);
167         gtk_widget_set_sensitive(GTK_WIDGET(stop_button), capture_in_progress);
168         gtk_widget_set_sensitive(GTK_WIDGET(clear_button), capture_in_progress);
169         /*if (capture_in_progress) {
170             gtk_widget_hide(GTK_WIDGET(new_button));
171             gtk_widget_show(GTK_WIDGET(stop_button));
172         } else {
173             gtk_widget_show(GTK_WIDGET(new_button));
174             gtk_widget_hide(GTK_WIDGET(stop_button));
175         }*/
176 #endif /* HAVE_LIBPCAP */
177         gtk_widget_set_sensitive(GTK_WIDGET(open_button), !capture_in_progress);
178     }
179 }
180
181 /* set toolbar state "have packets captured" */
182 void set_toolbar_for_captured_packets(gboolean have_captured_packets) {
183
184     if (toolbar_init) {
185         gtk_widget_set_sensitive(GTK_WIDGET(print_button),
186                                  have_captured_packets);
187         gtk_widget_set_sensitive(GTK_WIDGET(find_button),
188                                  have_captured_packets);
189         gtk_widget_set_sensitive(GTK_WIDGET(history_back_button),
190                                  have_captured_packets);
191         gtk_widget_set_sensitive(GTK_WIDGET(history_forward_button),
192                                  have_captured_packets);
193         gtk_widget_set_sensitive(GTK_WIDGET(go_to_button),
194                                  have_captured_packets);
195         gtk_widget_set_sensitive(GTK_WIDGET(go_to_top_button),
196                                  have_captured_packets);
197         gtk_widget_set_sensitive(GTK_WIDGET(go_to_bottom_button),
198                                  have_captured_packets);
199         gtk_widget_set_sensitive(GTK_WIDGET(zoom_in_button),
200                                  have_captured_packets);
201         gtk_widget_set_sensitive(GTK_WIDGET(zoom_out_button),
202                                  have_captured_packets);
203         gtk_widget_set_sensitive(GTK_WIDGET(zoom_100_button),
204                                  have_captured_packets);        
205         gtk_widget_set_sensitive(GTK_WIDGET(resize_columns_button),
206                                  have_captured_packets);
207         /* XXX - I don't see a reason why this should be done (as it is in the
208          * menus) */
209         /* gtk_widget_set_sensitive(GTK_WIDGET(color_display_button),
210            have_captured_packets);*/
211     }
212 }
213
214
215 /* helper function: add a separator to the toolbar */
216 static void toolbar_append_separator(GtkWidget *toolbar) {
217     GtkToolItem *tool_item = gtk_separator_tool_item_new();
218     gtk_toolbar_insert(GTK_TOOLBAR(toolbar), tool_item, -1);
219     gtk_widget_show(GTK_WIDGET(tool_item));
220 }
221
222
223
224 #define toolbar_item(new_item, toolbar, stock, tooltips, tooltip_text, callback, user_data) { \
225     new_item = gtk_tool_button_new_from_stock(stock); \
226     gtk_tool_item_set_tooltip(new_item, tooltips,  tooltip_text, NULL); \
227     g_signal_connect(new_item, "clicked", G_CALLBACK(callback), user_data); \
228     gtk_toolbar_insert(GTK_TOOLBAR(toolbar), new_item, -1); \
229     gtk_widget_show(GTK_WIDGET(new_item)); \
230     }
231
232 #define toolbar_toggle_button(new_item, window, toolbar, stock, tooltips, tooltip_text, callback, user_data) { \
233     new_item = gtk_toggle_tool_button_new_from_stock(stock); \
234     gtk_tool_item_set_tooltip(new_item, tooltips,  tooltip_text, NULL); \
235     g_signal_connect(new_item, "toggled", G_CALLBACK(callback), user_data); \
236     gtk_toolbar_insert(GTK_TOOLBAR(toolbar), new_item, -1); \
237     gtk_widget_show_all(GTK_WIDGET(new_item)); \
238     }
239
240 #define TOGGLE_BUTTON               GTK_TOGGLE_TOOL_BUTTON
241 #define TOGGLE_BUTTON_GET_ACTIVE    gtk_toggle_tool_button_get_active
242 #define TOGGLE_BUTTON_SET_ACTIVE    gtk_toggle_tool_button_set_active
243
244 static void
245 colorize_toggle_cb(GtkWidget *toggle_button, gpointer user_data _U_)  {
246     menu_colorize_changed(TOGGLE_BUTTON_GET_ACTIVE(TOGGLE_BUTTON(toggle_button)));
247 }
248
249 void
250 toolbar_colorize_changed(gboolean packet_list_colorize) {
251     if(TOGGLE_BUTTON_GET_ACTIVE(TOGGLE_BUTTON(colorize_button)) != packet_list_colorize) {
252         TOGGLE_BUTTON_SET_ACTIVE(TOGGLE_BUTTON(colorize_button), packet_list_colorize);
253     }
254 }
255
256 #ifdef HAVE_LIBPCAP
257 static void
258 auto_scroll_live_toggle_cb(GtkWidget *autoscroll_button, gpointer user_data _U_) {
259     menu_auto_scroll_live_changed(TOGGLE_BUTTON_GET_ACTIVE(TOGGLE_BUTTON(autoscroll_button)));
260 }
261
262 void
263 toolbar_auto_scroll_live_changed(gboolean auto_scroll_live) {
264     if(TOGGLE_BUTTON_GET_ACTIVE(TOGGLE_BUTTON(autoscroll_button)) != auto_scroll_live) {
265         TOGGLE_BUTTON_SET_ACTIVE(TOGGLE_BUTTON(autoscroll_button), auto_scroll_live);
266     }
267 }
268 #endif
269
270
271 /*
272  * Create all toolbars (currently only the main toolbar)
273  */
274 GtkWidget *
275 toolbar_new(void)
276 {
277     GtkWidget *main_tb;
278     GtkWidget *window = top_level;
279     GtkTooltips *tooltips;
280
281     tooltips = gtk_tooltips_new();
282     
283     /* this function should be only called once! */
284     g_assert(!toolbar_init);
285
286     /* we need to realize the window because we use pixmaps for 
287      * items on the toolbar in the context of it */
288     /* (coming from the gtk example, please don't ask me why ;-) */
289     gtk_widget_realize(window);
290
291     /* toolbar will be horizontal, with both icons and text (as default here) */
292     /* (this will usually be overwritten by the preferences setting) */
293     main_tb = gtk_toolbar_new();
294     gtk_toolbar_set_orientation(GTK_TOOLBAR(main_tb),
295                                 GTK_ORIENTATION_HORIZONTAL);
296
297     g_object_set_data(G_OBJECT(top_level), E_TB_MAIN_KEY, main_tb);
298
299
300 #ifdef HAVE_LIBPCAP
301     toolbar_item(if_button, main_tb, 
302         WIRESHARK_STOCK_CAPTURE_INTERFACES, tooltips, "List the available capture interfaces...", capture_if_cb, NULL);
303
304     toolbar_item(capture_options_button, main_tb, 
305         WIRESHARK_STOCK_CAPTURE_OPTIONS, tooltips, "Show the capture options...", capture_prep_cb, NULL);
306
307     toolbar_item(new_button, main_tb, 
308         WIRESHARK_STOCK_CAPTURE_START, tooltips, "Start a new live capture", capture_start_cb, NULL);
309
310     toolbar_item(stop_button, main_tb, 
311         WIRESHARK_STOCK_CAPTURE_STOP, tooltips, "Stop the running live capture", capture_stop_cb, NULL);
312
313     toolbar_item(clear_button, main_tb, 
314         WIRESHARK_STOCK_CAPTURE_RESTART, tooltips, "Restart the running live capture", capture_restart_cb, NULL);
315
316     toolbar_append_separator(main_tb);
317 #endif /* HAVE_LIBPCAP */
318
319     toolbar_item(open_button, main_tb, 
320         GTK_STOCK_OPEN, tooltips, "Open a capture file...", file_open_cmd_cb, NULL);
321
322     /* Only create a separate button in GTK < 2.4.  With GTK 2.4+, we will
323      * just modify the save_button to read/show save or save as as needed.
324      * We'll also fudge in an object key ("save") for the save button with data which  specifies 
325      * whether the button is currently "save" (1)or "save as" (0).
326      * The fcn file_save_or_save_as_cmd_cb
327      * will then call the appropriate file_save_cmd_cb or file_save_as_cmd_cb
328      */
329
330     toolbar_item(save_button, main_tb, 
331         GTK_STOCK_SAVE, tooltips, SAVE_BUTTON_TOOLTIP_TEXT, file_save_or_save_as_cmd_cb, NULL);
332     g_object_set_data(G_OBJECT(save_button), "save", GINT_TO_POINTER(1));
333
334     toolbar_item(close_button, main_tb, 
335         GTK_STOCK_CLOSE, tooltips, "Close this capture file", file_close_cmd_cb, NULL);
336
337     toolbar_item(reload_button, main_tb, 
338         GTK_STOCK_REFRESH, tooltips, "Reload this capture file", file_reload_cmd_cb, NULL);
339
340     toolbar_item(print_button, main_tb, 
341         GTK_STOCK_PRINT, tooltips, "Print packet(s)...", file_print_cmd_cb, NULL);
342
343     toolbar_append_separator(main_tb);
344
345     toolbar_item(find_button, main_tb, 
346         GTK_STOCK_FIND, tooltips, "Find a packet...", find_frame_cb, NULL);
347
348     toolbar_item(history_back_button, main_tb, 
349         GTK_STOCK_GO_BACK, tooltips, "Go back in packet history", history_back_cb, NULL);
350
351     toolbar_item(history_forward_button, main_tb, 
352         GTK_STOCK_GO_FORWARD, tooltips, "Go forward in packet history", history_forward_cb, NULL);
353
354     toolbar_item(go_to_button, main_tb, 
355         GTK_STOCK_JUMP_TO, tooltips, "Go to the packet with number...", goto_frame_cb, NULL);
356
357     toolbar_item(go_to_top_button, main_tb, 
358         GTK_STOCK_GOTO_TOP, tooltips, "Go to the first packet", goto_top_frame_cb, NULL);
359
360     toolbar_item(go_to_bottom_button, main_tb, 
361         GTK_STOCK_GOTO_BOTTOM, tooltips, "Go to the last packet", goto_bottom_frame_cb, NULL);
362
363     toolbar_append_separator(main_tb);
364
365     toolbar_toggle_button(colorize_button, window, main_tb, 
366         WIRESHARK_STOCK_COLORIZE, tooltips, "Colorize Packet List", colorize_toggle_cb, NULL);
367
368 #ifdef HAVE_LIBPCAP
369     toolbar_toggle_button(autoscroll_button, window, main_tb, 
370         WIRESHARK_STOCK_AUTOSCROLL, tooltips, "Auto Scroll Packet List in Live Capture", auto_scroll_live_toggle_cb, NULL);
371 #endif
372
373     toolbar_append_separator(main_tb);
374
375     toolbar_item(zoom_in_button, main_tb, 
376         GTK_STOCK_ZOOM_IN, tooltips, "Zoom in", view_zoom_in_cb, NULL);
377
378     toolbar_item(zoom_out_button, main_tb, 
379         GTK_STOCK_ZOOM_OUT, tooltips, "Zoom out", view_zoom_out_cb, NULL);
380
381     toolbar_item(zoom_100_button, main_tb, 
382         GTK_STOCK_ZOOM_100, tooltips, "Zoom 100%", view_zoom_100_cb, NULL);
383
384     toolbar_item(resize_columns_button, main_tb, 
385         WIRESHARK_STOCK_RESIZE_COLUMNS, tooltips, "Resize All Columns", packet_list_resize_columns_cb, NULL);
386
387     toolbar_append_separator(main_tb);
388     
389 #ifdef HAVE_LIBPCAP
390     toolbar_item(capture_filter_button, main_tb, 
391         WIRESHARK_STOCK_CAPTURE_FILTER, tooltips, "Edit capture filter...", cfilter_dialog_cb, NULL);
392 #endif /* HAVE_LIBPCAP */
393
394     toolbar_item(display_filter_button, main_tb, 
395         WIRESHARK_STOCK_DISPLAY_FILTER, tooltips, "Edit/apply display filter...", dfilter_dialog_cb, NULL);
396
397     toolbar_item(color_display_button, main_tb, 
398         GTK_STOCK_SELECT_COLOR, tooltips, "Edit coloring rules...", color_display_cb, NULL);
399
400     /* the preference button uses it's own Stock icon label "Prefs", as "Preferences" is too long */
401     toolbar_item(prefs_button, main_tb, 
402         GTK_STOCK_PREFERENCES, tooltips, "Edit preferences...", prefs_cb, NULL);
403
404     toolbar_append_separator(main_tb);
405
406     toolbar_item(help_button, main_tb, 
407         GTK_STOCK_HELP, tooltips, "Show some help...", topic_cb, GINT_TO_POINTER(HELP_CONTENT));
408
409     /* disable all "sensitive" items by default */
410     toolbar_init = TRUE;
411     set_toolbar_for_unsaved_capture_file(FALSE);
412     set_toolbar_for_captured_packets(FALSE);
413     set_toolbar_for_capture_file(FALSE);
414 #ifdef HAVE_LIBPCAP
415     set_toolbar_for_capture_in_progress(FALSE);
416 #endif /* HAVE_LIBPCAP */
417
418     /* make current preferences effective */
419     toolbar_redraw_all();
420
421     return main_tb;
422 }
423
424 void
425 set_toolbar_object_data(gchar *key, gpointer data)
426 {
427     g_object_set_data(G_OBJECT(open_button), key, data);
428     g_object_set_data(G_OBJECT(reload_button), key, data);
429 }