Use #defines for vtype values, rather than numbers.
[obnox/wireshark/wip.git] / prefs.c
diff --git a/prefs.c b/prefs.c
index 648df882d45ee0cb5eb208c82d1b8ed2ac48ddd1..0d31bfd077b7f922bb1f45bcedad69a83f74109d 100644 (file)
--- a/prefs.c
+++ b/prefs.c
@@ -1,22 +1,22 @@
 /* prefs.c
  * Routines for handling preferences
  *
- * $Id: prefs.c,v 1.78 2002/01/15 10:01:21 guy Exp $
+ * $Id: prefs.c,v 1.91 2002/09/28 15:23:13 gerald Exp $
  *
  * Ethereal - Network traffic analyzer
  * By Gerald Combs <gerald@ethereal.com>
  * Copyright 1998 Gerald Combs
- * 
+ *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  * of the License, or (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 # include "config.h"
 #endif
 
-#ifdef HAVE_SYS_TYPES_H
-#include <sys/types.h>
-#endif
-
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h>
 
 #include <glib.h>
 
-#include <filesystem.h>
-#include <resolv.h>
+#include <epan/filesystem.h>
 #include "globals.h"
-#include "packet.h"
+#include <epan/resolv.h>
+#include <epan/packet.h>
 #include "file.h"
 #include "prefs.h"
-#include "proto.h"
+#include <epan/proto.h>
 #include "column.h"
 #include "print.h"
 
@@ -122,6 +118,7 @@ prefs_register_module(const char *name, const char *title,
        module->prefs = NULL;   /* no preferences, to start */
        module->numprefs = 0;
        module->prefs_changed = FALSE;
+       module->obsolete = FALSE;
 
        /*
         * Make sure that only lower-case ASCII letters, numbers,
@@ -161,6 +158,22 @@ prefs_register_protocol(int id, void (*apply_cb)(void))
                                     apply_cb);
 }
 
+/*
+ * Register that a protocol used to have preferences but no longer does,
+ * by creating an "obsolete" module for it.
+ */
+module_t *
+prefs_register_protocol_obsolete(int id)
+{
+       module_t *module;
+
+       module = prefs_register_module(proto_get_protocol_filter_name(id),
+                                      proto_get_protocol_short_name(id),
+                                      NULL);
+       module->obsolete = TRUE;
+       return module;
+}
+
 /*
  * Find a module, given its name.
  */
@@ -195,11 +208,15 @@ do_module_callback(gpointer data, gpointer user_data)
        module_t *module = data;
        module_cb_arg_t *arg = user_data;
 
-       (*arg->callback)(module, arg->user_data);
+       if (!module->obsolete)
+               (*arg->callback)(module, arg->user_data);
 }
 
 /*
  * Call a callback function, with a specified argument, for each module.
+ * Ignores "obsolete" modules; their sole purpose is to allow old
+ * preferences for dissectors that no longer have preferences to be
+ * silently ignored in preference files.
  */
 void
 prefs_module_foreach(module_cb callback, gpointer user_data)
@@ -212,10 +229,12 @@ prefs_module_foreach(module_cb callback, gpointer user_data)
 }
 
 static void
-call_apply_cb(gpointer data, gpointer user_data)
+call_apply_cb(gpointer data, gpointer user_data _U_)
 {
        module_t *module = data;
 
+       if (module->obsolete)
+               return;
        if (module->prefs_changed) {
                if (module->apply_cb != NULL)
                        (*module->apply_cb)();
@@ -237,6 +256,10 @@ prefs_apply_all(void)
 
 /*
  * Register a preference in a module's list of preferences.
+ * If it has a title, give it an ordinal number; otherwise, it's a
+ * preference that won't show up in the UI, so it shouldn't get an
+ * ordinal number (the ordinal should be the ordinal in the set of
+ * *visible* preferences).
  */
 static pref_t *
 register_preference(module_t *module, const char *name, const char *title,
@@ -249,7 +272,10 @@ register_preference(module_t *module, const char *name, const char *title,
        preference->name = name;
        preference->title = title;
        preference->description = description;
-       preference->ordinal = module->numprefs;
+       if (title != NULL)
+               preference->ordinal = module->numprefs;
+       else
+               preference->ordinal = -1;       /* no ordinal for you */
 
        /*
         * Make sure that only lower-case ASCII letters, numbers,
@@ -278,7 +304,8 @@ register_preference(module_t *module, const char *name, const char *title,
         * preference.
         */
        module->prefs = g_list_append(module->prefs, preference);
-       module->numprefs++;
+       if (title != NULL)
+               module->numprefs++;
 
        return preference;
 }
@@ -314,7 +341,9 @@ find_preference(module_t *module, const char *name)
 gboolean
 prefs_is_registered_protocol(char *name)
 {
-       return (find_module(name) != NULL);
+       module_t *m = find_module(name);
+
+       return (m != NULL && !m->obsolete);
 }
 
 /*
@@ -324,7 +353,8 @@ const char *
 prefs_get_title_by_name(char *name)
 {
        module_t *m = find_module(name);
-       return  (m) ? m->title : NULL;
+
+       return (m != NULL && !m->obsolete) ? m->title : NULL;
 }
 
 /*
@@ -353,7 +383,7 @@ prefs_register_bool_preference(module_t *module, const char *name,
 
        preference = register_preference(module, name, title, description);
        preference->type = PREF_BOOL;
-       preference->varp.bool = var;
+       preference->varp.boolp = var;
 }
 
 /*
@@ -597,13 +627,13 @@ put_string_list(GList *sl)
     pref_str[cur_len - 2] = '\0';
 
   return(pref_str);
-}    
+}
 
 static void
 clear_string_list(GList *sl)
 {
   GList *l = sl;
-  
+
   while (l) {
     g_free(l->data);
     l = g_list_remove_link(l, l);
@@ -628,7 +658,7 @@ find_val_for_string(const char *needle, const enum_val_t *haystack,
                if (strcasecmp(needle, haystack[i].name) == 0) {
                        return haystack[i].value;
                }
-               i++;    
+               i++;
        }
        return default_value;
 }
@@ -647,13 +677,13 @@ find_index_from_string_array(char *needle, char **haystack, int default_value)
                if (strcmp(needle, haystack[i]) == 0) {
                        return i;
                }
-               i++;    
+               i++;
        }
        return default_value;
 }
 
 /* Preferences file format:
- * - Configuration directives start at the beginning of the line, and 
+ * - Configuration directives start at the beginning of the line, and
  *   are terminated with a colon.
  * - Directives can be continued on the next line by preceding them with
  *   whitespace.
@@ -687,10 +717,10 @@ static void read_prefs_file(const char *pf_path, FILE *pf);
    return NULL. */
 e_prefs *
 read_prefs(int *gpf_errno_return, char **gpf_path_return,
-          int *pf_errno_return, const char **pf_path_return)
+          int *pf_errno_return, char **pf_path_return)
 {
   int         i;
-  const char *pf_path;
+  char       *pf_path;
   FILE       *pf;
   fmt_data   *cfmt;
   gchar      *col_fmt[] = {"No.",      "%m", "Time",        "%t",
@@ -733,6 +763,7 @@ read_prefs(int *gpf_errno_return, char **gpf_path_return,
     prefs.gui_scrollbar_on_right = TRUE;
     prefs.gui_plist_sel_browse = FALSE;
     prefs.gui_ptree_sel_browse = FALSE;
+    prefs.gui_altern_colors = FALSE;
     prefs.gui_ptree_line_style = 0;
     prefs.gui_ptree_expander_style = 1;
     prefs.gui_hex_dump_highlight_style = 1;
@@ -806,7 +837,7 @@ read_prefs(int *gpf_errno_return, char **gpf_path_return,
     prefs.capture_prom_mode   = TRUE;
     prefs.capture_real_time   = FALSE;
     prefs.capture_auto_scroll = FALSE;
-    prefs.name_resolve        = RESOLV_ALL;
+    prefs.name_resolve        = RESOLV_ALL ^ RESOLV_NETWORK;
   }
 
   /* Construct the pathname of the global preferences file. */
@@ -835,13 +866,15 @@ read_prefs(int *gpf_errno_return, char **gpf_path_return,
 
   /* Construct the pathname of the user's preferences file. */
   pf_path = get_persconffile_path(PF_NAME, FALSE);
-    
+
   /* Read the user's preferences file, if it exists. */
   *pf_path_return = NULL;
   if ((pf = fopen(pf_path, "r")) != NULL) {
     /* We succeeded in opening it; read it. */
     read_prefs_file(pf_path, pf);
     fclose(pf);
+    g_free(pf_path);
+    pf_path = NULL;
   } else {
     /* We failed to open it.  If we failed for some reason other than
        "it doesn't exist", return the errno and the pathname, so our
@@ -851,7 +884,7 @@ read_prefs(int *gpf_errno_return, char **gpf_path_return,
       *pf_path_return = pf_path;
     }
   }
-  
+
   return &prefs;
 }
 
@@ -889,7 +922,7 @@ read_prefs_file(const char *pf_path, FILE *pf)
       var_len = 0;
       continue;
     }
-    
+
     switch (state) {
       case START:
         if (isalnum(got_c)) {
@@ -997,7 +1030,7 @@ read_prefs_file(const char *pf_path, FILE *pf)
 int
 prefs_set_pref(char *prefarg)
 {
-       u_char *p, *colonp;
+       guchar *p, *colonp;
        int ret;
 
        /*
@@ -1051,6 +1084,7 @@ prefs_set_pref(char *prefarg)
 #define PRS_GUI_SCROLLBAR_ON_RIGHT "gui.scrollbar_on_right"
 #define PRS_GUI_PLIST_SEL_BROWSE "gui.packet_list_sel_browse"
 #define PRS_GUI_PTREE_SEL_BROWSE "gui.protocol_tree_sel_browse"
+#define PRS_GUI_ALTERN_COLORS "gui.tree_view_altern_colors"
 #define PRS_GUI_PTREE_LINE_STYLE "gui.protocol_tree_line_style"
 #define PRS_GUI_PTREE_EXPANDER_STYLE "gui.protocol_tree_expander_style"
 #define PRS_GUI_HEX_DUMP_HIGHLIGHT_STYLE "gui.hex_dump_highlight_style"
@@ -1276,6 +1310,13 @@ set_pref(gchar *pref_name, gchar *value)
     else {
            prefs.gui_ptree_sel_browse = FALSE;
     }
+  } else if (strcmp(pref_name, PRS_GUI_ALTERN_COLORS) == 0) {
+    if (strcasecmp(value, "true") == 0) {
+            prefs.gui_altern_colors = TRUE;
+    }
+    else {
+            prefs.gui_altern_colors = FALSE;
+    }
   } else if (strcmp(pref_name, PRS_GUI_PTREE_LINE_STYLE) == 0) {
          prefs.gui_ptree_line_style =
                  find_index_from_string_array(value, gui_ptree_line_style_text, 0);
@@ -1324,18 +1365,18 @@ set_pref(gchar *pref_name, gchar *value)
   } else if (strcmp(pref_name, PRS_GUI_GEOMETRY_MAIN_HEIGHT) == 0) {
     prefs.gui_geometry_main_height = strtol(value, NULL, 10);
 
-/* handle the capture options */ 
+/* handle the capture options */
   } else if (strcmp(pref_name, PRS_CAP_DEVICE) == 0) {
     if (prefs.capture_device != NULL)
       g_free(prefs.capture_device);
     prefs.capture_device = g_strdup(value);
   } else if (strcmp(pref_name, PRS_CAP_PROM_MODE) == 0) {
-    prefs.capture_prom_mode = ((strcasecmp(value, "true") == 0)?TRUE:FALSE); 
+    prefs.capture_prom_mode = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
   } else if (strcmp(pref_name, PRS_CAP_REAL_TIME) == 0) {
-    prefs.capture_real_time = ((strcasecmp(value, "true") == 0)?TRUE:FALSE); 
+    prefs.capture_real_time = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
   } else if (strcmp(pref_name, PRS_CAP_AUTO_SCROLL) == 0) {
-    prefs.capture_auto_scroll = ((strcasecmp(value, "true") == 0)?TRUE:FALSE); 
+    prefs.capture_auto_scroll = ((strcasecmp(value, "true") == 0)?TRUE:FALSE);
+
 /* handle the global options */
   } else if (strcmp(pref_name, PRS_NAME_RESOLVE) == 0 ||
             strcmp(pref_name, PRS_CAP_NAME_RESOLVE) == 0) {
@@ -1385,12 +1426,18 @@ set_pref(gchar *pref_name, gchar *value)
          * In addition, the BEEP protocol used to be the BXXP protocol,
          * so if we didn't find the module, and its name was "bxxp",
          * look for "beep" instead.
+         *
+         * Also, the preferences for GTP v0 and v1 were combined under
+         * a single "gtp" heading.
          */
         if (module == NULL) {
           if (strcmp(pref_name, "Diameter") == 0)
             module = find_module("diameter");
           else if (strcmp(pref_name, "bxxp") == 0)
             module = find_module("beep");
+          else if (strcmp(pref_name, "gtpv0") == 0 ||
+                   strcmp(pref_name, "gtpv1") == 0)
+            module = find_module("gtp");
         }
         *dotp = '.';           /* put the preference string back */
         dotp++;                        /* skip past separator to preference name */
@@ -1484,9 +1531,9 @@ set_pref(gchar *pref_name, gchar *value)
         bval = TRUE;
       else
         bval = FALSE;
-      if (*pref->varp.bool != bval) {
+      if (*pref->varp.boolp != bval) {
        module->prefs_changed = TRUE;
-       *pref->varp.bool = bval;
+       *pref->varp.boolp = bval;
       }
       break;
 
@@ -1513,7 +1560,7 @@ set_pref(gchar *pref_name, gchar *value)
       return PREFS_SET_OBSOLETE;       /* no such preference any more */
     }
   }
-  
+
   return PREFS_SET_OK;
 }
 
@@ -1573,7 +1620,7 @@ write_pref(gpointer data, gpointer user_data)
        case PREF_BOOL:
                fprintf(arg->pf, "# TRUE or FALSE (case-insensitive).\n");
                fprintf(arg->pf, "%s.%s: %s\n", arg->module->name, pref->name,
-                   *pref->varp.bool ? "TRUE" : "FALSE");
+                   *pref->varp.boolp ? "TRUE" : "FALSE");
                break;
 
        case PREF_ENUM:
@@ -1622,9 +1669,9 @@ write_module_prefs(gpointer data, gpointer user_data)
    If we got an error, stuff a pointer to the path of the preferences file
    into "*pf_path_return", and return the errno. */
 int
-write_prefs(const char **pf_path_return)
+write_prefs(char **pf_path_return)
 {
-  const char  *pf_path;
+  char        *pf_path;
   FILE        *pf;
   GList       *clp, *col_l;
   fmt_data    *cfmt;
@@ -1640,7 +1687,7 @@ write_prefs(const char **pf_path_return)
     *pf_path_return = pf_path;
     return errno;
   }
-    
+
   fputs("# Configuration file for Ethereal " VERSION ".\n"
     "#\n"
     "# This file is regenerated each time preferences are saved within\n"
@@ -1710,9 +1757,13 @@ write_prefs(const char **pf_path_return)
   fprintf(pf, PRS_GUI_PTREE_SEL_BROWSE ": %s\n",
                  prefs.gui_ptree_sel_browse == TRUE ? "TRUE" : "FALSE");
 
+  fprintf(pf, "\n# Alternating colors in TreeViews\n");
+  fprintf(pf, PRS_GUI_ALTERN_COLORS ": %s\n",
+                 prefs.gui_altern_colors == TRUE ? "TRUE" : "FALSE");
+
   fprintf(pf, "\n# Protocol-tree line style. One of: NONE, SOLID, DOTTED, TABBED\n");
   fprintf(pf, PRS_GUI_PTREE_LINE_STYLE ": %s\n",
-                 gui_ptree_line_style_text[prefs.gui_ptree_line_style]);
+          gui_ptree_line_style_text[prefs.gui_ptree_line_style]);
 
   fprintf(pf, "\n# Protocol-tree expander style. One of: NONE, SQUARE, TRIANGLE, CIRCULAR\n");
   fprintf(pf, PRS_GUI_PTREE_EXPANDER_STYLE ": %s\n",
@@ -1812,6 +1863,7 @@ copy_prefs(e_prefs *dest, e_prefs *src)
   dest->gui_scrollbar_on_right = src->gui_scrollbar_on_right;
   dest->gui_plist_sel_browse = src->gui_plist_sel_browse;
   dest->gui_ptree_sel_browse = src->gui_ptree_sel_browse;
+  dest->gui_altern_colors = src->gui_altern_colors;
   dest->gui_ptree_line_style = src->gui_ptree_line_style;
   dest->gui_ptree_expander_style = src->gui_ptree_expander_style;
   dest->gui_hex_dump_highlight_style = src->gui_hex_dump_highlight_style;