Migrate GTK icon handling to GTK 3.10 API

GtkStockItem usage is deprecated with all the GTK_STOCK_.* stock ids.
We keep a stock id based approach but without relying on GTK's
GtkStockItem system.

We create our own internal stock ids for {icon, label} tuples and keep
the original GTK stock id #define-s and values to preserve backward
compatibility.

Change-Id: Ia0b35a5903f079e92c8026e3df21bbf0be2d06b0
Reviewed-on: https://code.wireshark.org/review/302
Reviewed-by: Gerald Combs <gerald@wireshark.org>
Reviewed-by: Anders Broman <a.broman58@gmail.com>

1 files changed, 565 insertions, 0 deletions

diff --git a/ui/gtk/stock_icons.h b/ui/gtk/stock_icons.h
index 417b9884ea..b5fd9d0ec9 100644
--- a/ui/gtk/stock_icons.h
+++ b/ui/gtk/stock_icons.h
@@ -24,6 +24,7 @@
 #ifndef __STOCK_ICONS_H__
 #define __STOCK_ICONS_H__
 
+#include <gtk/gtk.h>
 
 #define WIRESHARK_STOCK_CAPTURE_INTERFACES       "Wireshark_Stock_CaptureInterfaces"
 #define WIRESHARK_STOCK_CAPTURE_OPTIONS          "Wireshark_Stock_CaptureOptionss"
@@ -95,6 +96,570 @@
 #define WIRESHARK_STOCK_ANALYZE                  "Wireshark_Analyze"
 #define WIRESHARK_STOCK_SAVE                     "Wireshark_Save"
 
+/*
+ * Use of GTK_STOCK_.* is deprecated from 3.10
+ * https://developer.gnome.org/gtk3/stable/gtk3-Stock-Items.html
+ * We keep the defined names in the code and provide mapping for them
+ * to labels and standard icons based on
+ * https://docs.google.com/spreadsheet/pub?key=0AsPAM3pPwxagdGF4THNMMUpjUW5xMXZfdUNzMXhEa2c&output=html
+ */
+#if GTK_CHECK_VERSION(3, 10, 0)
+
+#ifdef GTK_STOCK_ABOUT
+#undef GTK_STOCK_ABOUT
+#endif
+#define GTK_STOCK_ABOUT "gtk-about"
+
+#ifdef GTK_STOCK_ADD
+#undef GTK_STOCK_ADD
+#endif
+#define GTK_STOCK_ADD "gtk-add"
+
+#ifdef GTK_STOCK_APPLY
+#undef GTK_STOCK_APPLY
+#endif
+#define GTK_STOCK_APPLY "gtk-apply"
+
+#ifdef GTK_STOCK_BOLD
+#undef GTK_STOCK_BOLD
+#endif
+#define GTK_STOCK_BOLD "gtk-bold"
+
+#ifdef GTK_STOCK_CANCEL
+#undef GTK_STOCK_CANCEL
+#endif
+#define GTK_STOCK_CANCEL "gtk-cancel"
+
+#ifdef GTK_STOCK_CAPS_LOCK_WARNING
+#undef GTK_STOCK_CAPS_LOCK_WARNING
+#endif
+#define GTK_STOCK_CAPS_LOCK_WARNING "gtk-caps-lock-warning"
+
+#ifdef GTK_STOCK_CDROM
+#undef GTK_STOCK_CDROM
+#endif
+#define GTK_STOCK_CDROM "gtk-cdrom"
+
+#ifdef GTK_STOCK_CLEAR
+#undef GTK_STOCK_CLEAR
+#endif
+#define GTK_STOCK_CLEAR "gtk-clear"
+
+#ifdef GTK_STOCK_CLOSE
+#undef GTK_STOCK_CLOSE
+#endif
+#define GTK_STOCK_CLOSE "gtk-close"
+
+#ifdef GTK_STOCK_COLOR_PICKER
+#undef GTK_STOCK_COLOR_PICKER
+#endif
+#define GTK_STOCK_COLOR_PICKER "gtk-color-picker"
+
+#ifdef GTK_STOCK_CONNECT
+#undef GTK_STOCK_CONNECT
+#endif
+#define GTK_STOCK_CONNECT "gtk-connect"
+
+#ifdef GTK_STOCK_CONVERT
+#undef GTK_STOCK_CONVERT
+#endif
+#define GTK_STOCK_CONVERT "gtk-convert"
+
+#ifdef GTK_STOCK_COPY
+#undef GTK_STOCK_COPY
+#endif
+#define GTK_STOCK_COPY "gtk-copy"
+
+#ifdef GTK_STOCK_CUT
+#undef GTK_STOCK_CUT
+#endif
+#define GTK_STOCK_CUT "gtk-cut"
+
+#ifdef GTK_STOCK_DELETE
+#undef GTK_STOCK_DELETE
+#endif
+#define GTK_STOCK_DELETE "gtk-delete"
+
+#ifdef GTK_STOCK_DIALOG_AUTHENTICATION
+#undef GTK_STOCK_DIALOG_AUTHENTICATION
+#endif
+#define GTK_STOCK_DIALOG_AUTHENTICATION "gtk-dialog-authentication"
+
+#ifdef GTK_STOCK_DIALOG_INFO
+#undef GTK_STOCK_DIALOG_INFO
+#endif
+#define GTK_STOCK_DIALOG_INFO "gtk-dialog-info"
+
+#ifdef GTK_STOCK_DIALOG_WARNING
+#undef GTK_STOCK_DIALOG_WARNING
+#endif
+#define GTK_STOCK_DIALOG_WARNING "gtk-dialog-warning"
+
+#ifdef GTK_STOCK_DIALOG_ERROR
+#undef GTK_STOCK_DIALOG_ERROR
+#endif
+#define GTK_STOCK_DIALOG_ERROR "gtk-dialog-error"
+
+#ifdef GTK_STOCK_DIALOG_QUESTION
+#undef GTK_STOCK_DIALOG_QUESTION
+#endif
+#define GTK_STOCK_DIALOG_QUESTION "gtk-dialog-question"
+
+#ifdef GTK_STOCK_DIRECTORY
+#undef GTK_STOCK_DIRECTORY
+#endif
+#define GTK_STOCK_DIRECTORY "gtk-directory"
+
+#ifdef GTK_STOCK_DISCARD
+#undef GTK_STOCK_DISCARD
+#endif
+#define GTK_STOCK_DISCARD "gtk-discard"
+
+#ifdef GTK_STOCK_DISCONNECT
+#undef GTK_STOCK_DISCONNECT
+#endif
+#define GTK_STOCK_DISCONNECT "gtk-disconnect"
+
+#ifdef GTK_STOCK_DND
+#undef GTK_STOCK_DND
+#endif
+#define GTK_STOCK_DND "gtk-dnd"
+
+#ifdef GTK_STOCK_DND_MULTIPLE
+#undef GTK_STOCK_DND_MULTIPLE
+#endif
+#define GTK_STOCK_DND_MULTIPLE "gtk-dnd-multiple"
+
+#ifdef GTK_STOCK_EDIT
+#undef GTK_STOCK_EDIT
+#endif
+#define GTK_STOCK_EDIT "gtk-edit"
+
+#ifdef GTK_STOCK_EXECUTE
+#undef GTK_STOCK_EXECUTE
+#endif
+#define GTK_STOCK_EXECUTE "gtk-execute"
+
+#ifdef GTK_STOCK_FILE
+#undef GTK_STOCK_FILE
+#endif
+#define GTK_STOCK_FILE "gtk-file"
+
+#ifdef GTK_STOCK_FIND
+#undef GTK_STOCK_FIND
+#endif
+#define GTK_STOCK_FIND "gtk-find"
+
+#ifdef GTK_STOCK_FIND_AND_REPLACE
+#undef GTK_STOCK_FIND_AND_REPLACE
+#endif
+#define GTK_STOCK_FIND_AND_REPLACE "gtk-find-and-replace"
+
+#ifdef GTK_STOCK_FLOPPY
+#undef GTK_STOCK_FLOPPY
+#endif
+#define GTK_STOCK_FLOPPY "gtk-floppy"
+
+#ifdef GTK_STOCK_FULLSCREEN
+#undef GTK_STOCK_FULLSCREEN
+#endif
+#define GTK_STOCK_FULLSCREEN "gtk-fullscreen"
+
+#ifdef GTK_STOCK_GOTO_BOTTOM
+#undef GTK_STOCK_GOTO_BOTTOM
+#endif
+#define GTK_STOCK_GOTO_BOTTOM "gtk-goto-bottom"
+
+#ifdef GTK_STOCK_GOTO_FIRST
+#undef GTK_STOCK_GOTO_FIRST
+#endif
+#define GTK_STOCK_GOTO_FIRST "gtk-goto-first"
+
+#ifdef GTK_STOCK_GOTO_LAST
+#undef GTK_STOCK_GOTO_LAST
+#endif
+#define GTK_STOCK_GOTO_LAST "gtk-goto-last"
+
+#ifdef GTK_STOCK_GOTO_TOP
+#undef GTK_STOCK_GOTO_TOP
+#endif
+#define GTK_STOCK_GOTO_TOP "gtk-goto-top"
+
+#ifdef GTK_STOCK_GO_BACK
+#undef GTK_STOCK_GO_BACK
+#endif
+#define GTK_STOCK_GO_BACK "gtk-go-back"
+
+#ifdef GTK_STOCK_GO_DOWN
+#undef GTK_STOCK_GO_DOWN
+#endif
+#define GTK_STOCK_GO_DOWN "gtk-go-down"
+
+#ifdef GTK_STOCK_GO_FORWARD
+#undef GTK_STOCK_GO_FORWARD
+#endif
+#define GTK_STOCK_GO_FORWARD "gtk-go-forward"
+
+#ifdef GTK_STOCK_GO_UP
+#undef GTK_STOCK_GO_UP
+#endif
+#define GTK_STOCK_GO_UP "gtk-go-up"
+
+#ifdef GTK_STOCK_HARDDISK
+#undef GTK_STOCK_HARDDISK
+#endif
+#define GTK_STOCK_HARDDISK "gtk-harddisk"
+
+#ifdef GTK_STOCK_HELP
+#undef GTK_STOCK_HELP
+#endif
+#define GTK_STOCK_HELP "gtk-help"
+
+#ifdef GTK_STOCK_HOME
+#undef GTK_STOCK_HOME
+#endif
+#define GTK_STOCK_HOME "gtk-home"
+
+#ifdef GTK_STOCK_INDEX
+#undef GTK_STOCK_INDEX
+#endif
+#define GTK_STOCK_INDEX "gtk-index"
+
+#ifdef GTK_STOCK_INDENT
+#undef GTK_STOCK_INDENT
+#endif
+#define GTK_STOCK_INDENT "gtk-indent"
+
+#ifdef GTK_STOCK_INFO
+#undef GTK_STOCK_INFO
+#endif
+#define GTK_STOCK_INFO "gtk-info"
+
+#ifdef GTK_STOCK_ITALIC
+#undef GTK_STOCK_ITALIC
+#endif
+#define GTK_STOCK_ITALIC "gtk-italic"
+
+#ifdef GTK_STOCK_JUMP_TO
+#undef GTK_STOCK_JUMP_TO
+#endif
+#define GTK_STOCK_JUMP_TO "gtk-jump-to"
+
+#ifdef GTK_STOCK_JUSTIFY_CENTER
+#undef GTK_STOCK_JUSTIFY_CENTER
+#endif
+#define GTK_STOCK_JUSTIFY_CENTER "gtk-justify-center"
+
+#ifdef GTK_STOCK_JUSTIFY_FILL
+#undef GTK_STOCK_JUSTIFY_FILL
+#endif
+#define GTK_STOCK_JUSTIFY_FILL "gtk-justify-fill"
+
+#ifdef GTK_STOCK_JUSTIFY_LEFT
+#undef GTK_STOCK_JUSTIFY_LEFT
+#endif
+#define GTK_STOCK_JUSTIFY_LEFT "gtk-justify-left"
+
+#ifdef GTK_STOCK_JUSTIFY_RIGHT
+#undef GTK_STOCK_JUSTIFY_RIGHT
+#endif
+#define GTK_STOCK_JUSTIFY_RIGHT "gtk-justify-right"
+
+#ifdef GTK_STOCK_LEAVE_FULLSCREEN
+#undef GTK_STOCK_LEAVE_FULLSCREEN
+#endif
+#define GTK_STOCK_LEAVE_FULLSCREEN "gtk-leave-fullscreen"
+
+#ifdef GTK_STOCK_MISSING_IMAGE
+#undef GTK_STOCK_MISSING_IMAGE
+#endif
+#define GTK_STOCK_MISSING_IMAGE "gtk-missing-image"
+
+#ifdef GTK_STOCK_MEDIA_FORWARD
+#undef GTK_STOCK_MEDIA_FORWARD
+#endif
+#define GTK_STOCK_MEDIA_FORWARD "gtk-media-forward"
+
+#ifdef GTK_STOCK_MEDIA_NEXT
+#undef GTK_STOCK_MEDIA_NEXT
+#endif
+#define GTK_STOCK_MEDIA_NEXT "gtk-media-next"
+
+#ifdef GTK_STOCK_MEDIA_PAUSE
+#undef GTK_STOCK_MEDIA_PAUSE
+#endif
+#define GTK_STOCK_MEDIA_PAUSE "gtk-media-pause"
+
+#ifdef GTK_STOCK_MEDIA_PLAY
+#undef GTK_STOCK_MEDIA_PLAY
+#endif
+#define GTK_STOCK_MEDIA_PLAY "gtk-media-play"
+
+#ifdef GTK_STOCK_MEDIA_PREVIOUS
+#undef GTK_STOCK_MEDIA_PREVIOUS
+#endif
+#define GTK_STOCK_MEDIA_PREVIOUS "gtk-media-previous"
+
+#ifdef GTK_STOCK_MEDIA_RECORD
+#undef GTK_STOCK_MEDIA_RECORD
+#endif
+#define GTK_STOCK_MEDIA_RECORD "gtk-media-record"
+
+#ifdef GTK_STOCK_MEDIA_REWIND
+#undef GTK_STOCK_MEDIA_REWIND
+#endif
+#define GTK_STOCK_MEDIA_REWIND "gtk-media-rewind"
+
+#ifdef GTK_STOCK_MEDIA_STOP
+#undef GTK_STOCK_MEDIA_STOP
+#endif
+#define GTK_STOCK_MEDIA_STOP "gtk-media-stop"
+
+#ifdef GTK_STOCK_NETWORK
+#undef GTK_STOCK_NETWORK
+#endif
+#define GTK_STOCK_NETWORK "gtk-network"
+
+#ifdef GTK_STOCK_NEW
+#undef GTK_STOCK_NEW
+#endif
+#define GTK_STOCK_NEW "gtk-new"
+
+#ifdef GTK_STOCK_NO
+#undef GTK_STOCK_NO
+#endif
+#define GTK_STOCK_NO "gtk-no"
+
+#ifdef GTK_STOCK_OK
+#undef GTK_STOCK_OK
+#endif
+#define GTK_STOCK_OK "gtk-ok"
+
+#ifdef GTK_STOCK_OPEN
+#undef GTK_STOCK_OPEN
+#endif
+#define GTK_STOCK_OPEN "gtk-open"
+
+#ifdef GTK_STOCK_ORIENTATION_PORTRAIT
+#undef GTK_STOCK_ORIENTATION_PORTRAIT
+#endif
+#define GTK_STOCK_ORIENTATION_PORTRAIT "gtk-orientation-portrait"
+
+#ifdef GTK_STOCK_ORIENTATION_LANDSCAPE
+#undef GTK_STOCK_ORIENTATION_LANDSCAPE
+#endif
+#define GTK_STOCK_ORIENTATION_LANDSCAPE "gtk-orientation-landscape"
+
+#ifdef GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE
+#undef GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE
+#endif
+#define GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE "gtk-orientation-reverse-landscape"
+
+#ifdef GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT
+#undef GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT
+#endif
+#define GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT "gtk-orientation-reverse-portrait"
+
+#ifdef GTK_STOCK_PAGE_SETUP
+#undef GTK_STOCK_PAGE_SETUP
+#endif
+#define GTK_STOCK_PAGE_SETUP "gtk-page-setup"
+
+#ifdef GTK_STOCK_PASTE
+#undef GTK_STOCK_PASTE
+#endif
+#define GTK_STOCK_PASTE "gtk-paste"
+
+#ifdef GTK_STOCK_PREFERENCES
+#undef GTK_STOCK_PREFERENCES
+#endif
+#define GTK_STOCK_PREFERENCES "gtk-preferences"
+
+#ifdef GTK_STOCK_PRINT
+#undef GTK_STOCK_PRINT
+#endif
+#define GTK_STOCK_PRINT "gtk-print"
+
+#ifdef GTK_STOCK_PRINT_ERROR
+#undef GTK_STOCK_PRINT_ERROR
+#endif
+#define GTK_STOCK_PRINT_ERROR "gtk-print-error"
+
+#ifdef GTK_STOCK_PRINT_PAUSED
+#undef GTK_STOCK_PRINT_PAUSED
+#endif
+#define GTK_STOCK_PRINT_PAUSED "gtk-print-paused"
+
+#ifdef GTK_STOCK_PRINT_PREVIEW
+#undef GTK_STOCK_PRINT_PREVIEW
+#endif
+#define GTK_STOCK_PRINT_PREVIEW "gtk-print-preview"
+
+#ifdef GTK_STOCK_PRINT_REPORT
+#undef GTK_STOCK_PRINT_REPORT
+#endif
+#define GTK_STOCK_PRINT_REPORT "gtk-print-report"
+
+#ifdef GTK_STOCK_PRINT_WARNING
+#undef GTK_STOCK_PRINT_WARNING
+#endif
+#define GTK_STOCK_PRINT_WARNING "gtk-print-warning"
+
+#ifdef GTK_STOCK_PROPERTIES
+#undef GTK_STOCK_PROPERTIES
+#endif
+#define GTK_STOCK_PROPERTIES "gtk-properties"
+
+#ifdef GTK_STOCK_QUIT
+#undef GTK_STOCK_QUIT
+#endif
+#define GTK_STOCK_QUIT "gtk-quit"
+
+#ifdef GTK_STOCK_REDO
+#undef GTK_STOCK_REDO
+#endif
+#define GTK_STOCK_REDO "gtk-redo"
+
+#ifdef GTK_STOCK_REFRESH
+#undef GTK_STOCK_REFRESH
+#endif
+#define GTK_STOCK_REFRESH "gtk-refresh"
+
+#ifdef GTK_STOCK_REMOVE
+#undef GTK_STOCK_REMOVE
+#endif
+#define GTK_STOCK_REMOVE "gtk-remove"
+
+#ifdef GTK_STOCK_REVERT_TO_SAVED
+#undef GTK_STOCK_REVERT_TO_SAVED
+#endif
+#define GTK_STOCK_REVERT_TO_SAVED "gtk-revert-to-saved"
+
+#ifdef GTK_STOCK_SAVE
+#undef GTK_STOCK_SAVE
+#endif
+#define GTK_STOCK_SAVE "gtk-save"
+
+#ifdef GTK_STOCK_SAVE_AS
+#undef GTK_STOCK_SAVE_AS
+#endif
+#define GTK_STOCK_SAVE_AS "gtk-save-as"
+
+#ifdef GTK_STOCK_SELECT_ALL
+#undef GTK_STOCK_SELECT_ALL
+#endif
+#define GTK_STOCK_SELECT_ALL "gtk-select-all"
+
+#ifdef GTK_STOCK_SELECT_COLOR
+#undef GTK_STOCK_SELECT_COLOR
+#endif
+#define GTK_STOCK_SELECT_COLOR "gtk-select-color"
+
+#ifdef GTK_STOCK_SELECT_FONT
+#undef GTK_STOCK_SELECT_FONT
+#endif
+#define GTK_STOCK_SELECT_FONT "gtk-select-font"
+
+#ifdef GTK_STOCK_SORT_ASCENDING
+#undef GTK_STOCK_SORT_ASCENDING
+#endif
+#define GTK_STOCK_SORT_ASCENDING "gtk-sort-ascending"
+
+#ifdef GTK_STOCK_SORT_DESCENDING
+#undef GTK_STOCK_SORT_DESCENDING
+#endif
+#define GTK_STOCK_SORT_DESCENDING "gtk-sort-descending"
+
+#ifdef GTK_STOCK_SPELL_CHECK
+#undef GTK_STOCK_SPELL_CHECK
+#endif
+#define GTK_STOCK_SPELL_CHECK "gtk-spell-check"
+
+#ifdef GTK_STOCK_STOP
+#undef GTK_STOCK_STOP
+#endif
+#define GTK_STOCK_STOP "gtk-stop"
+
+#ifdef GTK_STOCK_STRIKETHROUGH
+#undef GTK_STOCK_STRIKETHROUGH
+#endif
+#define GTK_STOCK_STRIKETHROUGH "gtk-strikethrough"
+
+#ifdef GTK_STOCK_UNDELETE
+#undef GTK_STOCK_UNDELETE
+#endif
+#define GTK_STOCK_UNDELETE "gtk-undelete"
+
+#ifdef GTK_STOCK_UNDERLINE
+#undef GTK_STOCK_UNDERLINE
+#endif
+#define GTK_STOCK_UNDERLINE "gtk-underline"
+
+#ifdef GTK_STOCK_UNDO
+#undef GTK_STOCK_UNDO
+#endif
+#define GTK_STOCK_UNDO "gtk-undo"
+
+#ifdef GTK_STOCK_UNINDENT
+#undef GTK_STOCK_UNINDENT
+#endif
+#define GTK_STOCK_UNINDENT "gtk-unindent"
+
+#ifdef GTK_STOCK_YES
+#undef GTK_STOCK_YES
+#endif
+#define GTK_STOCK_YES "gtk-yes"
+
+#ifdef GTK_STOCK_ZOOM_100
+#undef GTK_STOCK_ZOOM_100
+#endif
+#define GTK_STOCK_ZOOM_100 "gtk-zoom-100"
+
+#ifdef GTK_STOCK_ZOOM_FIT
+#undef GTK_STOCK_ZOOM_FIT
+#endif
+#define GTK_STOCK_ZOOM_FIT "gtk-zoom-fit"
+
+#ifdef GTK_STOCK_ZOOM_IN
+#undef GTK_STOCK_ZOOM_IN
+#endif
+#define GTK_STOCK_ZOOM_IN "gtk-zoom-in"
+
+#ifdef GTK_STOCK_ZOOM_OUT
+#undef GTK_STOCK_ZOOM_OUT
+#endif
+#define GTK_STOCK_ZOOM_OUT "gtk-zoom-out"
+
+#endif /* GTK_CHECK_VERSION(3, 10, 0) */
+
 void stock_icons_init(void);
 
+/**
+ * Creates a GtkButton with a preset icon and label.
+ * @param stock_id Id of the icon and label pair
+ * @return The newly created GtkButton widget.
+ */
+GtkWidget * ws_gtk_button_new_from_stock(const gchar *stock_id);
+
+/**
+ * Creates a GtkToolButton with a preset icon and label.
+ * @param stock_id Id of the icon and label pair
+ * @return The newly created GtkButton widget.
+ */
+GtkToolItem * ws_gtk_tool_button_new_from_stock(const gchar *stock_id);
+
+/**
+ * Creates a GtkToggleToolButton with a preset icon and label.
+ * @param stock_id Id of the icon and label pair
+ * @return The newly created GtkButton widget.
+ */
+GtkToolItem * ws_gtk_toggle_tool_button_new_from_stock(const gchar *stock_id);
+
+/**
+ * Creates a GtkImage displaying a stock icon.
+ * @param stock_id a stock icon name
+ * @param size a stock icon size of GtkIconSize type
+ */
+GtkWidget * ws_gtk_image_new_from_stock(const gchar *stock_id, GtkIconSize size);
+
 #endif /* __STOCK_ICONS_H__ */