/* help_dlg.c
*
- * $Id: help_dlg.c,v 1.44 2004/01/31 02:25:45 ulfl Exp $
+ * $Id$
*
* Laurent Deniel <laurent.deniel@free.fr>
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
* Copyright 2000 Gerald Combs
*
* This program is free software; you can redistribute it and/or
#include "epan/filesystem.h"
#include "help_dlg.h"
-#include "prefs.h"
+#include "text_page.h"
+#include <epan/prefs.h>
#include "gtkglobals.h"
-#include "ui_util.h"
+#include "gui_utils.h"
#include "compat_macros.h"
#include "dlg_utils.h"
#include "simple_dialog.h"
+#include "webbrowser.h"
+#include "file_util.h"
+
+#ifdef HHC_DIR
+#include <windows.h>
+#include <htmlhelp.h>
+#include "epan/unicode-utils.h"
+#endif
+
#define HELP_DIR "help"
#define NOTEBOOK_KEY "notebook_key"
-static void help_close_cb(GtkWidget *w, gpointer data);
-static void help_destroy_cb(GtkWidget *w, gpointer data);
-static void insert_text(GtkWidget *w, const char *buffer, int nchars);
-static void set_help_text(GtkWidget *w, const char *help_file_path);
-
/*
* Keep a static pointer to the current "Help" window, if any, so that
* if somebody tries to do "Help->Help" while there's already a
typedef struct {
char *topic;
char *pathname;
- GtkWidget *txt;
+ GtkWidget *page;
} help_page_t;
static GSList *help_text_pages = NULL;
+
+
+gboolean topic_available(topic_action_e action) {
+
+#if (GLIB_MAJOR_VERSION >= 2)
+ if(action == HELP_CAPTURE_INTERFACES_DETAILS_DIALOG) {
+ /* XXX - add the page HELP_CAPTURE_INTERFACES_DETAILS_DIALOG and remove this if */
+ /* page currently not existing in user's guide */
+ return FALSE;
+ }
+ /* online: we have almost all possible pages available */
+ return TRUE;
+#else
+ /* offline: we have only some pages available */
+ switch(action) {
+ case(HELP_CONTENT):
+ return TRUE;
+ break;
+ case(HELP_GETTING_STARTED):
+ return TRUE;
+ break;
+ case(HELP_CAPTURE_OPTIONS_DIALOG):
+ return TRUE;
+ break;
+ case(HELP_CAPTURE_FILTERS_DIALOG):
+ return TRUE;
+ break;
+ case(HELP_DISPLAY_FILTERS_DIALOG):
+ return TRUE;
+ break;
+ default:
+ return FALSE;
+ }
+#endif
+}
+
+
+#if (GLIB_MAJOR_VERSION >= 2)
+/*
+ * Open the help dialog and show a specific HTML help page.
+ */
+void help_topic_html(const gchar *topic) {
+ GString *url;
+
+
+ /* try to open local .chm file */
+#ifdef HHC_DIR
+ HWND hw;
+
+ url = g_string_new("");
+
+ g_string_append_printf(url, "%s\\user-guide.chm::/wsug_chm/%s>Wireshark Help",
+ get_datafile_dir(), topic);
+
+ hw = HtmlHelpW(NULL,
+ utf_8to16(url->str),
+ HH_DISPLAY_TOPIC, 0);
+
+ g_string_free(url, TRUE /* free_segment */);
+
+ /* if the .chm file could be opened, stop here */
+ if(hw != NULL) {
+ return;
+ }
+#endif /* HHC_DIR */
+
+ url = g_string_new("");
+
+ /* try to open the HTML page from wireshark.org instead */
+ g_string_append_printf(url, "http://www.wireshark.org/docs/wsug_html_chunked/%s", topic);
+
+ browser_open_url(url->str);
+
+ g_string_free(url, TRUE /* free_segment */);
+}
+#endif
+
+
+#if (GLIB_MAJOR_VERSION < 2)
/*
* Helper function to show a simple help text page.
*/
static GtkWidget * help_page(const char *topic, const char *filename)
{
- GtkWidget *page_vb, *txt_scrollw, *txt;
+ GtkWidget *text_page;
char *relative_path, *absolute_path;
help_page_t *page;
- page_vb = gtk_vbox_new(FALSE, 0);
- gtk_container_border_width(GTK_CONTAINER(page_vb), 1);
- txt_scrollw = scrolled_window_new(NULL, NULL);
- gtk_box_pack_start(GTK_BOX(page_vb), txt_scrollw, TRUE, TRUE, 0);
-#if GTK_MAJOR_VERSION < 2
- gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(txt_scrollw),
- GTK_POLICY_NEVER, GTK_POLICY_ALWAYS);
- txt = gtk_text_new(NULL, NULL);
- gtk_text_set_editable(GTK_TEXT(txt), FALSE);
- gtk_text_set_word_wrap(GTK_TEXT(txt), TRUE);
- gtk_text_set_line_wrap(GTK_TEXT(txt), TRUE);
-#else
- gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(txt_scrollw),
- GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
- txt = gtk_text_view_new();
- gtk_text_view_set_editable(GTK_TEXT_VIEW(txt), FALSE);
- gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(txt), GTK_WRAP_WORD);
-#endif
-
relative_path = g_strconcat(HELP_DIR, G_DIR_SEPARATOR_S, filename, NULL);
absolute_path = get_datafile_path(relative_path);
+ text_page = text_page_new(absolute_path);
g_free(relative_path);
- set_help_text(txt, absolute_path);
- gtk_container_add(GTK_CONTAINER(txt_scrollw), txt);
- gtk_widget_show(txt_scrollw);
- gtk_widget_show(txt);
- gtk_widget_show(page_vb);
+ gtk_widget_show(text_page);
page = g_malloc(sizeof (help_page_t));
page->topic = g_strdup(topic);
page->pathname = absolute_path;
- page->txt = txt;
+ page->page = text_page;
help_text_pages = g_slist_append(help_text_pages, page);
- return page_vb;
+ return text_page;
+}
+
+
+/*
+ * Help dialog is closed now.
+ */
+static void help_destroy_cb(GtkWidget *w _U_, gpointer data _U_)
+{
+ GSList *help_page_ent;
+ help_page_t *page;
+
+ /* Free up the list of help pages. */
+ for (help_page_ent = help_text_pages; help_page_ent != NULL;
+ help_page_ent = g_slist_next(help_page_ent)) {
+ page = (help_page_t *)help_page_ent->data;
+ g_free(page->topic);
+ g_free(page->pathname);
+ g_free(page);
+ }
+ g_slist_free(help_text_pages);
+ help_text_pages = NULL;
+
+ /* Note that we no longer have a Help window. */
+ help_w = NULL;
}
/*
* Create and show help dialog.
*/
-void help_cb(GtkWidget *w _U_, gpointer data _U_)
+static
+void help_dialog(void)
{
GtkWidget *main_vb, *bbox, *help_nb, *close_bt, *label, *topic_vb;
char line[4096+1]; /* XXX - size? */
}
help_toc_file_path = get_datafile_path(HELP_DIR G_DIR_SEPARATOR_S "toc");
- help_toc_file = fopen(help_toc_file_path, "r");
+ help_toc_file = eth_fopen(help_toc_file_path, "r");
if (help_toc_file == NULL) {
simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "Could not open file \"%s\": %s",
help_toc_file_path, strerror(errno));
return;
}
- help_w = dlg_window_new("Ethereal: Help");
- SIGNAL_CONNECT(help_w, "destroy", help_destroy_cb, NULL);
- /* XXX: improve this, e.g. remember the last window size in a file */
- WIDGET_SET_SIZE(help_w, DEF_WIDTH * 2/3, DEF_HEIGHT * 2/3);
+ help_w = window_new_with_geom(GTK_WINDOW_TOPLEVEL, "Wireshark: Help", "help");
+ gtk_window_set_default_size(GTK_WINDOW(help_w), DEF_WIDTH, DEF_HEIGHT);
gtk_container_border_width(GTK_CONTAINER(help_w), 2);
/* Container for each row of widgets */
main_vb = gtk_vbox_new(FALSE, 1);
gtk_container_border_width(GTK_CONTAINER(main_vb), 1);
gtk_container_add(GTK_CONTAINER(help_w), main_vb);
- gtk_widget_show(main_vb);
/* help topics container */
help_nb = gtk_notebook_new();
}
}
if(ferror(help_toc_file)) {
- simple_dialog(ESD_TYPE_WARN, ESD_BTN_OK, "Error reading file \"%s\": %s",
+ simple_dialog(ESD_TYPE_ERROR, ESD_BTN_OK, "Error reading file \"%s\": %s",
help_toc_file_path, strerror(errno));
}
fclose(help_toc_file);
- gtk_widget_show(help_nb);
- /* Buttons (only "Ok" for now) */
+ /* Button row */
bbox = dlg_button_row_new(GTK_STOCK_OK, NULL);
-
gtk_box_pack_end(GTK_BOX(main_vb), bbox, FALSE, FALSE, 5);
- gtk_widget_show(bbox);
close_bt = OBJECT_GET_DATA(bbox, GTK_STOCK_OK);
- SIGNAL_CONNECT(close_bt, "clicked", help_close_cb, help_w);
- gtk_widget_grab_default(close_bt);
-
- gtk_quit_add_destroy(gtk_main_level(), GTK_OBJECT(help_w));
+ window_set_cancel_button(help_w, close_bt, window_cancel_button_cb);
- /* Catch the "key_press_event" signal in the window, so that we can catch
- the ESC key being pressed and act as if the "Cancel" button had
- been selected. */
- dlg_set_cancel(help_w, close_bt);
+ SIGNAL_CONNECT(help_w, "delete_event", window_delete_event_cb, NULL);
+ SIGNAL_CONNECT(help_w, "destroy", help_destroy_cb, NULL);
- gtk_widget_show(help_w);
+ gtk_quit_add_destroy(gtk_main_level(), GTK_OBJECT(help_w));
-} /* help_cb */
+ gtk_widget_show_all(help_w);
+ window_present(help_w);
+} /* help_dialog */
/*
- * Open the help dialog and show a specific help page.
+ * Open the help dialog and show a specific GTK help page.
*/
-
-void help_topic_cb(GtkWidget *w _U_, gpointer data _U_) {
- gchar *topic = data;
+static void help_topic_gtk(const gchar *topic) {
gchar *page_topic;
GtkWidget *help_nb;
GSList *help_page_ent;
gint page_num = 0;
help_page_t *page;
+
/* show help dialog, if not already opened */
- help_cb(NULL, NULL);
+ help_dialog();
help_nb = OBJECT_GET_DATA(help_w, NOTEBOOK_KEY);
/* topic page not found, default (first page) will be shown */
}
+#endif /* GLIB_MAJOR_VERSION < 2 */
-/*
- * Close help dialog.
- */
-static void help_close_cb(GtkWidget *w _U_, gpointer data)
-{
- gtk_widget_destroy(GTK_WIDGET(data));
-}
-
-
-/*
- * Help dialog is closed now.
+/**
+ * Redraw all help pages, to use a new font.
*/
-static void help_destroy_cb(GtkWidget *w _U_, gpointer data _U_)
+void help_redraw(void)
{
GSList *help_page_ent;
- help_page_t *page;
+ help_page_t *help_page;
- /* Free up the list of help pages. */
- for (help_page_ent = help_text_pages; help_page_ent != NULL;
- help_page_ent = g_slist_next(help_page_ent)) {
- page = (help_page_t *)help_page_ent->data;
- g_free(page->topic);
- g_free(page->pathname);
- g_free(page);
+ if (help_w != NULL) {
+ for (help_page_ent = help_text_pages; help_page_ent != NULL;
+ help_page_ent = g_slist_next(help_page_ent))
+ {
+ help_page = (help_page_t *)help_page_ent->data;
+ text_page_redraw(help_page->page, help_page->pathname);
+ }
}
- g_slist_free(help_text_pages);
- help_text_pages = NULL;
-
- /* Note that we no longer have a Help window. */
- help_w = NULL;
}
-/*
- * Insert some text to a help page.
- */
-static void insert_text(GtkWidget *w, const char *buffer, int nchars)
+static void
+topic_action(topic_action_e action)
{
-#if GTK_MAJOR_VERSION < 2
- gtk_text_insert(GTK_TEXT(w), m_r_font, NULL, NULL, buffer, nchars);
+ /* pages online at www.wireshark.org */
+ switch(action) {
+ case(ONLINEPAGE_HOME):
+ browser_open_url ("http://www.wireshark.org");
+ break;
+ case(ONLINEPAGE_WIKI):
+ browser_open_url ("http://wiki.wireshark.org");
+ break;
+ case(ONLINEPAGE_DOWNLOAD):
+ browser_open_url ("http://www.wireshark.org/download/");
+ break;
+ case(ONLINEPAGE_USERGUIDE):
+ browser_open_url ("http://www.wireshark.org/docs/wsug_html_chunked/");
+ break;
+ case(ONLINEPAGE_FAQ):
+ browser_open_url ("http://www.wireshark.org/faq.html");
+ break;
+ case(ONLINEPAGE_SAMPLE_FILES):
+ browser_open_url ("http://wiki.wireshark.org/SampleCaptures");
+ break;
+
+ /* local manual pages */
+ case(LOCALPAGE_MAN_WIRESHARK):
+ browser_open_data_file("wireshark.html");
+ break;
+ case(LOCALPAGE_MAN_WIRESHARK_FILTER):
+ browser_open_data_file("wireshark-filter.html");
+ break;
+ case(LOCALPAGE_MAN_TSHARK):
+ browser_open_data_file("tshark.html");
+ break;
+ case(LOCALPAGE_MAN_RAWSHARK):
+ browser_open_data_file("rawshark.html");
+ break;
+ case(LOCALPAGE_MAN_DUMPCAP):
+ browser_open_data_file("dumpcap.html");
+ break;
+ case(LOCALPAGE_MAN_MERGECAP):
+ browser_open_data_file("mergecap.html");
+ break;
+ case(LOCALPAGE_MAN_EDITCAP):
+ browser_open_data_file("editcap.html");
+ break;
+ case(LOCALPAGE_MAN_TEXT2PCAP):
+ browser_open_data_file("text2pcap.html");
+ break;
+
+#if (GLIB_MAJOR_VERSION >= 2)
+ /* local help pages (User's Guide) */
+ case(HELP_CONTENT):
+ help_topic_html( "index.html");
+ break;
+ case(HELP_CAPTURE_OPTIONS_DIALOG):
+ help_topic_html("ChCapCaptureOptions.html");
+ break;
+ case(HELP_CAPTURE_FILTERS_DIALOG):
+ help_topic_html("ChWorkDefineFilterSection.html");
+ break;
+ case(HELP_DISPLAY_FILTERS_DIALOG):
+ help_topic_html("ChWorkDefineFilterSection.html");
+ break;
+ case(HELP_COLORING_RULES_DIALOG):
+ help_topic_html("ChCustColorizationSection.html");
+ break;
+ case(HELP_CONFIG_PROFILES_DIALOG):
+ help_topic_html("ChCustConfigProfilesSection.html");
+ break;
+ case(HELP_PRINT_DIALOG):
+ help_topic_html("ChIOPrintSection.html");
+ break;
+ case(HELP_FIND_DIALOG):
+ help_topic_html("ChWorkFindPacketSection.html");
+ break;
+ case(HELP_GOTO_DIALOG):
+ help_topic_html("ChWorkGoToPacketSection.html");
+ break;
+ case(HELP_CAPTURE_INTERFACES_DIALOG):
+ help_topic_html("ChCapInterfaceSection.html");
+ break;
+ case(HELP_CAPTURE_INFO_DIALOG):
+ help_topic_html("ChCapRunningSection.html");
+ break;
+ case(HELP_ENABLED_PROTOCOLS_DIALOG):
+ help_topic_html("ChCustProtocolDissectionSection.html");
+ break;
+ case(HELP_DECODE_AS_DIALOG):
+ help_topic_html("ChCustProtocolDissectionSection.html");
+ break;
+ case(HELP_DECODE_AS_SHOW_DIALOG):
+ help_topic_html("ChCustProtocolDissectionSection.html");
+ break;
+ case(HELP_FOLLOW_TCP_STREAM_DIALOG):
+ help_topic_html("ChAdvFollowTCPSection.html");
+ break;
+ case(HELP_EXPERT_INFO_DIALOG):
+ help_topic_html("ChAdvExpert.html");
+ break;
+ case(HELP_STATS_SUMMARY_DIALOG):
+ help_topic_html("ChStatSummary.html");
+ break;
+ case(HELP_STATS_PROTO_HIERARCHY_DIALOG):
+ help_topic_html("ChStatHierarchy.html");
+ break;
+ case(HELP_STATS_ENDPOINTS_DIALOG):
+ help_topic_html("ChStatEndpoints.html");
+ break;
+ case(HELP_STATS_CONVERSATIONS_DIALOG):
+ help_topic_html("ChStatConversations.html");
+ break;
+ case(HELP_STATS_IO_GRAPH_DIALOG):
+ help_topic_html("ChStatIOGraphs.html");
+ break;
+ case(HELP_STATS_WLAN_TRAFFIC_DIALOG):
+ help_topic_html("ChStatWLANTraffic.html");
+ break;
+ case(HELP_FILESET_DIALOG):
+ help_topic_html("ChIOFileSetSection.html");
+ break;
+ case(HELP_CAPTURE_INTERFACES_DETAILS_DIALOG):
+ help_topic_html("ChCapInterfaceDetailsSection.html");
+ break;
+ case(HELP_PREFERENCES_DIALOG):
+ help_topic_html("ChCustPreferencesSection.html");
+ break;
+ case(HELP_EXPORT_FILE_DIALOG):
+ case(HELP_EXPORT_FILE_WIN32_DIALOG):
+ help_topic_html("ChIOExportSection.html");
+ break;
+ case(HELP_EXPORT_BYTES_DIALOG):
+ case(HELP_EXPORT_BYTES_WIN32_DIALOG):
+ help_topic_html("ChIOExportSection.html#ChIOExportSelectedDialog");
+ break;
+ case(HELP_EXPORT_OBJECT_LIST):
+ help_topic_html("ChIOExportSection.html#ChIOExportObjectsDialog");
+ break;
+ case(HELP_OPEN_DIALOG):
+ case(HELP_OPEN_WIN32_DIALOG):
+ help_topic_html("ChIOOpenSection.html");
+ break;
+ case(HELP_MERGE_DIALOG):
+ case(HELP_MERGE_WIN32_DIALOG):
+ help_topic_html("ChIOMergeSection.html");
+ break;
+ case(HELP_SAVE_DIALOG):
+ case(HELP_SAVE_WIN32_DIALOG):
+ help_topic_html("ChIOSaveSection.html");
+ break;
#else
- GtkTextBuffer *buf= gtk_text_view_get_buffer(GTK_TEXT_VIEW(w));
- GtkTextIter iter;
-
- gtk_text_buffer_get_end_iter(buf, &iter);
- gtk_widget_modify_font(w, m_r_font);
- if (!g_utf8_validate(buffer, -1, NULL))
- printf(buffer);
- gtk_text_buffer_insert(buf, &iter, buffer, nchars);
-#endif
-}
-
-
-/*
- * Put the complete help text into a help page.
- */
-static void set_help_text(GtkWidget *w, const char *help_file_path)
-{
- FILE *help_file;
- char line[4096+1]; /* XXX - size? */
-
-#if GTK_MAJOR_VERSION < 2
- gtk_text_freeze(GTK_TEXT(w));
-#endif
-
- help_file = fopen(help_file_path, "r");
- if (help_file != NULL) {
- while (fgets(line, sizeof line, help_file) != NULL) {
- insert_text(w, line, strlen(line));
- }
- if(ferror(help_file)) {
- simple_dialog(ESD_TYPE_WARN, ESD_BTN_OK, "Error reading file \"%s\": %s",
- help_file_path, strerror(errno));
+ /* only some help pages are available for offline reading */
+ case(HELP_CONTENT):
+ help_topic_gtk("Overview");
+ break;
+ case(HELP_GETTING_STARTED):
+ help_topic_gtk("Getting Started");
+ break;
+ case(HELP_CAPTURE_OPTIONS_DIALOG):
+ help_topic_gtk("Capturing");
+ break;
+ case(HELP_CAPTURE_FILTERS_DIALOG):
+ help_topic_gtk("Capture Filters");
+ break;
+ case(HELP_DISPLAY_FILTERS_DIALOG):
+ help_topic_gtk("Display Filters");
+ break;
+#endif /* GLIB_MAJOR_VERSION */
+
+ default:
+ g_assert_not_reached();
}
- fclose(help_file);
- } else {
- simple_dialog(ESD_TYPE_WARN, ESD_BTN_OK, "Could not open file \"%s\": %s",
- help_file_path, strerror(errno));
- }
-#if GTK_MAJOR_VERSION < 2
- gtk_text_thaw(GTK_TEXT(w));
-#endif
-} /* set_help_text */
-
-
-/*
- * Clear the help text from the help page.
- */
-static void clear_help_text(GtkWidget *w)
-{
-#if GTK_MAJOR_VERSION < 2
- GtkText *txt = GTK_TEXT(w);
-
- gtk_text_set_point(txt, 0);
- /* Keep GTK+ 1.2.3 through 1.2.6 from dumping core - see
- http://www.ethereal.com/lists/ethereal-dev/199912/msg00312.html and
- http://www.gnome.org/mailing-lists/archives/gtk-devel-list/1999-October/0051.shtml
- for more information */
- gtk_adjustment_set_value(txt->vadj, 0.0);
- gtk_text_forward_delete(txt, gtk_text_get_length(txt));
-#else
- GtkTextBuffer *buf = gtk_text_view_get_buffer(GTK_TEXT_VIEW(w));
-
- gtk_text_buffer_set_text(buf, "", 0);
-#endif
}
-/*
- * Redraw a single help page.
- */
-void help_redraw_page(const help_page_t *page)
+void
+topic_cb(GtkWidget *w _U_, topic_action_e action)
{
-#if GTK_MAJOR_VERSION < 2
- gtk_text_freeze(GTK_TEXT(page->txt));
-#endif
- clear_help_text(page->txt);
- set_help_text(page->txt, page->pathname);
-#if GTK_MAJOR_VERSION < 2
- gtk_text_thaw(GTK_TEXT(page->txt));
-#endif
+ topic_action(action);
}
-/*
- * Redraw all help pages, to use a new font.
- */
-void help_redraw(void)
-{
- GSList *help_page_ent;
-
- if (help_w != NULL) {
- for (help_page_ent = help_text_pages; help_page_ent != NULL;
- help_page_ent = g_slist_next(help_page_ent))
- help_redraw_page((help_page_t *)help_page_ent->data);
- }
+void
+topic_menu_cb(GtkWidget *w _U_, gpointer data _U_, topic_action_e action) {
+ topic_action(action);
}
+
git.samba.org / obnox / wireshark / wip.git / blobdiff