diff options
author | Bill Meier <wmeier@newsguy.com> | 2009-03-15 20:09:25 +0000 |
---|---|---|
committer | Bill Meier <wmeier@newsguy.com> | 2009-03-15 20:09:25 +0000 |
commit | 34515ab429337db9fbf80b11ef476367172fb460 (patch) | |
tree | d0a9a7883d9997275664bcfa863d4cdcb6f2b47e /tools | |
parent | 0258be0b0544d4ccb08f2b01ef2b59f7c7afd6fd (diff) |
Add complete list of deprecated GTK API's (as of GTK 2.14.7).
Group 'deprecated-gtk' lists all deprecated GTK APIs which
are not currently used in Wireshark.
-g deprecated-gtk will 'Error';
Group 'deprecated-gtk-todo' lists the deprecated GTK APIs
which are still used in Wireshark (ie: not yet fixed).
-g deprecated-gtk-todo will 'Warn'.
Also: two new options added:
-M: -g output is one line per function per file;
-s summary-group: gives a count of the usage of each function in that group
[currently: any group used in -s must also be specified with -g option].
svn path=/trunk/; revision=27729
Diffstat (limited to 'tools')
-rwxr-xr-x | tools/checkAPIs.pl | 808 |
1 files changed, 736 insertions, 72 deletions
diff --git a/tools/checkAPIs.pl b/tools/checkAPIs.pl index 8d587e8d18..2e9e9cf936 100755 --- a/tools/checkAPIs.pl +++ b/tools/checkAPIs.pl @@ -7,7 +7,7 @@ # be called by Wireshark code and to perform certain other checks. # # Usage: -# checkAPIs.pl [-g group1] [-g group2] [--nocheck-value-string-array-null-termination] file1 file2 ... +# checkAPIs.pl [-M] [-g group1] [-g group2] [-s summary-group1] [-s summary-group2] [--nocheck-value-string-array-null-termination] file1 file2 ... # # $Id$ # @@ -37,11 +37,11 @@ my %APIs = ( # API groups. # # Group name, e.g. 'prohibited' # '<name>' => { - # # 1 if these are errors, 0 if warnings - # 'count_errors' => 1, - # # Function list - # 'functions' => [ 'f1', f2', ... ] }, - + # 'count_errors' => 1, # 1 if these are errors, 0 if warnings + # 'functions' => [ 'f1', 'f2', ...], # Function array + # 'function-counts' => {'f1',0, 'f2',0, ...}, # Function Counts hash (initialized in the code) + # } + # # APIs that MUST NOT be used in Wireshark 'prohibited' => { 'count_errors' => 1, 'functions' => [ # Memory-unsafe APIs @@ -103,10 +103,13 @@ my %APIs = ( 'freopen', # Misc 'tmpnam' # use mkstemp - ]}, + ] }, # APIs that SHOULD NOT be used in Wireshark (any more) 'deprecated' => { 'count_errors' => 0, 'functions' => [ + # Use strerror() and report messages in whatever + # fashion is appropriate for the code in question. + 'perror', ### Depreciated glib functions # use g_string_printf() instead of: 'g_string_sprintf', @@ -131,30 +134,7 @@ my %APIs = ( 'g_scanner_foreach_symbol', 'g_scanner_freeze_symbol_table', 'g_scanner_thaw_symbol_table', - #'gtk_clist_new', - # GtkCList has been deprecated since GTK+ 2.0 and should not be used - # in newly written code. Use GtkTreeView instead. - 'gtk_file_selection_new', - # Use gtk_file_chooser_dialog_new() instead - 'gtk_combo_new', - # GtkCombo has been deprecated since version 2.4 and should not be used in newly-written code. Use GtkComboBox instead. - 'gtk_entry_append_text', - 'gtk_label_set', - # Aliases gtk_label_set_text(). Probably used for backward compatibility with GTK+ 1.0.x. - 'gtk_menu_append', - 'gtk_menu_prepend', - #gtk_menu_append is deprecated and should not be used in newly-written code. Use gtk_menu_shell_append() instead. - #'gtk_progress_bar_update', - # gtk_progress_bar_set_fraction ? - # gtk_progress_bar_update is deprecated and should not be used in newly-written code. - # This function is deprecated. Please use gtk_progress_set_value() or gtk_progress_set_percentage() instead. - 'gtk_widget_draw', - # in general gtk_widget_queue_draw_area() is a better choice if you want to draw a region of a widget. - 'gtk_window_position', - # Use strerror() and report messages in whatever - # fashion is appropriate for the code in question. - 'perror', - ]}, + ] }, # APIs that make the program exit. Dissectors shouldn't call these 'abort' => { 'count_errors' => 1, 'functions' => [ @@ -162,29 +142,678 @@ my %APIs = ( 'exit', 'g_assert', 'g_error', - ]}, + ] }, # APIs that print to the terminal. Dissectors shouldn't call these 'termoutput' => { 'count_errors' => 0, 'functions' => [ - 'printf', - ]}, + 'printf', + ] }, + + # Deprecated GTK APIs + # which SHOULD NOT be used in Wireshark (any more). + # (Filled in from 'E' entries in %deprecatedGtkFunctions below) + 'deprecated-gtk' => { 'count_errors' => 1, 'functions' => [ + ] }, + + # Deprecated GTK APIs yet to be replaced + # (Filled in from 'W' entries in %deprecatedGtkFunctions below) + 'deprecated-gtk-todo' => { 'count_errors' => 0, 'functions' => [ + ] }, ); +# Deprecated GTK functions with (E)rror or (W)arning flag: +# (The list is based upon the GTK 2.14.7 documentation). +# E: There should be no current Wireshark usage so Error if seen; +# W: Not all usages yet fixed so Warn if seen; (Change to E as fixed) +my %deprecatedGtkFunctions = ( + 'gtk_about_dialog_get_name', 'E', + 'gtk_about_dialog_set_name', 'E', + 'gtk_accel_group_ref', 'E', + 'gtk_accel_group_unref', 'E', + 'gtk_binding_entry_add', 'E', + 'gtk_binding_entry_add_signall', 'E', + 'gtk_binding_entry_clear', 'E', + 'gtk_binding_parse_binding', 'E', + 'gtk_box_pack_end_defaults', 'E', + 'gtk_box_pack_start_defaults', 'E', + 'gtk_button_box_get_child_ipadding', 'E', + 'gtk_button_box_get_child_size', 'E', + 'gtk_button_box_get_spacing', 'E', + 'gtk_button_box_set_child_ipadding', 'W', # >> style properties child-internal-pad-x/-y + 'gtk_button_box_set_child_size', 'W', # >> style properties child-min-width/-height + 'gtk_button_box_set_spacing', 'E', # gtk_box_set_spacing [==] + 'gtk_calendar_display_options', 'E', + 'gtk_calendar_freeze', 'E', + 'gtk_calendar_thaw', 'E', + 'GTK_CELL_PIXMAP', 'E', # GtkTreeView (& related) ... + 'GTK_CELL_PIXTEXT', 'E', + 'gtk_cell_renderer_editing_canceled', 'E', + 'GTK_CELL_TEXT', 'W', + 'GTK_CELL_WIDGET', 'E', + 'GTK_CHECK_CAST', 'W', # >>> G_TYPE_CHECK_INSTANCE_CAST [==] + 'GTK_CHECK_CLASS_CAST', 'W', # >>> G_TYPE_CHECK_CLASS_CAST [==] + 'GTK_CHECK_CLASS_TYPE', 'W', # >>> G_TYPE_CHECK_CLASS_TYPE [==] + 'GTK_CHECK_GET_CLASS', 'W', # >>> G_TYPE_INSTANCE_GET_CLASS [==] + 'gtk_check_menu_item_set_show_toggle', 'W', # ?? + 'gtk_check_menu_item_set_state', 'E', + 'GTK_CHECK_TYPE', 'W', # >>> G_TYPE_CHECK_INSTANCE_TYPE [==] + 'GTK_CLASS_NAME', 'E', + 'GTK_CLASS_TYPE', 'E', + 'GTK_CLIST_ADD_MODE', 'E', # GtkTreeView (& related) ... + 'gtk_clist_append', 'W', + 'GTK_CLIST_AUTO_RESIZE_BLOCKED', 'E', + 'GTK_CLIST_AUTO_SORT', 'E', + 'gtk_clist_clear', 'W', + 'gtk_clist_column_title_active', 'E', + 'gtk_clist_column_title_passive', 'E', + 'gtk_clist_column_titles_active', 'E', + 'gtk_clist_column_titles_hide', 'E', + 'gtk_clist_column_titles_passive', 'W', + 'gtk_clist_column_titles_show', 'W', + 'gtk_clist_columns_autosize', 'W', + 'GTK_CLIST_DRAW_DRAG_LINE', 'E', + 'GTK_CLIST_DRAW_DRAG_RECT', 'E', + 'gtk_clist_find_row_from_data', 'W', + 'GTK_CLIST_FLAGS', 'E', + 'gtk_clist_freeze', 'W', + 'gtk_clist_get_cell_style', 'E', + 'gtk_clist_get_cell_type', 'E', + 'gtk_clist_get_column_title', 'E', + 'gtk_clist_get_column_widget', 'E', + 'gtk_clist_get_hadjustment', 'E', + 'gtk_clist_get_pixmap', 'E', + 'gtk_clist_get_pixtext', 'E', + 'gtk_clist_get_row_data', 'W', + 'gtk_clist_get_row_style', 'E', + 'gtk_clist_get_selectable', 'E', + 'gtk_clist_get_selection_info', 'W', + 'gtk_clist_get_text', 'W', + 'gtk_clist_get_vadjustment', 'W', + 'GTK_CLIST_IN_DRAG', 'E', + 'gtk_clist_insert', 'W', + 'gtk_clist_moveto', 'W', + 'gtk_clist_new', 'W', + 'gtk_clist_new_with_titles', 'W', + 'gtk_clist_optimal_column_width', 'E', + 'gtk_clist_prepend', 'E', + 'gtk_clist_remove', 'W', + 'GTK_CLIST_REORDERABLE', 'E', + 'GTK_CLIST_ROW', 'E', + 'GTK_CLIST_ROW_HEIGHT_SET', 'E', + 'gtk_clist_row_is_visible', 'W', + 'gtk_clist_row_move', 'E', + 'gtk_clist_select_all', 'W', + 'gtk_clist_select_row', 'W', + 'gtk_clist_set_auto_sort', 'E', + 'gtk_clist_set_background', 'W', + 'gtk_clist_set_button_actions', 'E', + 'gtk_clist_set_cell_style', 'E', + 'gtk_clist_set_column_auto_resize', 'W', + 'gtk_clist_set_column_justification', 'W', + 'gtk_clist_set_column_max_width', 'E', + 'gtk_clist_set_column_min_width', 'E', + 'gtk_clist_set_column_resizeable', 'W', + 'gtk_clist_set_column_title', 'W', + 'gtk_clist_set_column_visibility', 'W', + 'gtk_clist_set_column_widget', 'W', + 'gtk_clist_set_column_width', 'W', + 'gtk_clist_set_compare_func', 'W', + 'GTK_CLIST_SET_FLAG', 'E', + 'gtk_clist_set_foreground', 'W', + 'gtk_clist_set_hadjustment', 'E', + 'gtk_clist_set_pixmap', 'E', + 'gtk_clist_set_pixtext', 'E', + 'gtk_clist_set_reorderable', 'E', + 'gtk_clist_set_row_data', 'W', + 'gtk_clist_set_row_data_full', 'E', + 'gtk_clist_set_row_height', 'E', + 'gtk_clist_set_row_style', 'E', + 'gtk_clist_set_selectable', 'W', + 'gtk_clist_set_selection_mode', 'W', + 'gtk_clist_set_shadow_type', 'W', + 'gtk_clist_set_shift', 'E', + 'gtk_clist_set_sort_column', 'W', + 'gtk_clist_set_sort_type', 'W', + 'gtk_clist_set_text', 'W', + 'gtk_clist_set_use_drag_icons', 'E', + 'gtk_clist_set_vadjustment', 'E', + 'GTK_CLIST_SHOW_TITLES', 'E', + 'gtk_clist_sort', 'W', + 'gtk_clist_swap_rows', 'W', + 'gtk_clist_thaw', 'W', + 'gtk_clist_undo_selection', 'E', + 'gtk_clist_unselect_all', 'W', + 'gtk_clist_unselect_row', 'E', + 'GTK_CLIST_UNSET_FLAG', 'E', + 'GTK_CLIST_USE_DRAG_ICONS', 'E', + 'gtk_color_selection_get_color', 'E', + 'gtk_color_selection_set_change_palette_hook', 'E', + 'gtk_color_selection_set_color', 'E', + 'gtk_color_selection_set_update_policy', 'E', + 'gtk_combo_disable_activate', 'W', # GtkComboBox ... (avail since 2.4/2.6/2.10/2.14) + 'gtk_combo_new', 'W', + 'gtk_combo_set_case_sensitive', 'W', + 'gtk_combo_set_item_string', 'E', + 'gtk_combo_set_popdown_strings', 'W', + 'gtk_combo_set_use_arrows', 'E', + 'gtk_combo_set_use_arrows_always', 'E', + 'gtk_combo_set_value_in_list', 'E', + 'gtk_container_border_width', 'E', # gtk_container_set_border_width [==] + 'gtk_container_children', 'E', # gtk_container_get_children [==] + 'gtk_container_foreach_full', 'E', + 'gtk_ctree_collapse', 'E', + 'gtk_ctree_collapse_recursive', 'E', + 'gtk_ctree_collapse_to_depth', 'E', + 'gtk_ctree_expand', 'E', + 'gtk_ctree_expand_recursive', 'E', + 'gtk_ctree_expand_to_depth', 'E', + 'gtk_ctree_export_to_gnode', 'E', + 'gtk_ctree_find', 'E', + 'gtk_ctree_find_all_by_row_data', 'E', + 'gtk_ctree_find_all_by_row_data_custom', 'E', + 'gtk_ctree_find_by_row_data', 'E', + 'gtk_ctree_find_by_row_data_custom', 'E', + 'gtk_ctree_find_node_ptr', 'E', + 'GTK_CTREE_FUNC', 'E', + 'gtk_ctree_get_node_info', 'E', + 'gtk_ctree_insert_gnode', 'E', + 'gtk_ctree_insert_node', 'E', + 'gtk_ctree_is_ancestor', 'E', + 'gtk_ctree_is_hot_spot', 'E', + 'gtk_ctree_is_viewable', 'E', + 'gtk_ctree_last', 'E', + 'gtk_ctree_move', 'E', + 'gtk_ctree_new', 'E', + 'gtk_ctree_new_with_titles', 'E', + 'GTK_CTREE_NODE', 'E', + 'gtk_ctree_node_get_cell_style', 'E', + 'gtk_ctree_node_get_cell_type', 'E', + 'gtk_ctree_node_get_pixmap', 'E', + 'gtk_ctree_node_get_pixtext', 'E', + 'gtk_ctree_node_get_row_data', 'E', + 'gtk_ctree_node_get_row_style', 'E', + 'gtk_ctree_node_get_selectable', 'E', + 'gtk_ctree_node_get_text', 'E', + 'gtk_ctree_node_is_visible', 'E', + 'gtk_ctree_node_moveto', 'E', + 'GTK_CTREE_NODE_NEXT', 'E', + 'gtk_ctree_node_nth', 'E', + 'GTK_CTREE_NODE_PREV', 'E', + 'gtk_ctree_node_set_background', 'E', + 'gtk_ctree_node_set_cell_style', 'E', + 'gtk_ctree_node_set_foreground', 'E', + 'gtk_ctree_node_set_pixmap', 'E', + 'gtk_ctree_node_set_pixtext', 'E', + 'gtk_ctree_node_set_row_data', 'E', + 'gtk_ctree_node_set_row_data_full', 'E', + 'gtk_ctree_node_set_row_style', 'E', + 'gtk_ctree_node_set_selectable', 'E', + 'gtk_ctree_node_set_shift', 'E', + 'gtk_ctree_node_set_text', 'E', + 'gtk_ctree_post_recursive', 'E', + 'gtk_ctree_post_recursive_to_depth', 'E', + 'gtk_ctree_pre_recursive', 'E', + 'gtk_ctree_pre_recursive_to_depth', 'E', + 'gtk_ctree_real_select_recursive', 'E', + 'gtk_ctree_remove_node', 'E', + 'GTK_CTREE_ROW', 'E', + 'gtk_ctree_select', 'E', + 'gtk_ctree_select_recursive', 'E', + 'gtk_ctree_set_drag_compare_func', 'E', + 'gtk_ctree_set_expander_style', 'E', + 'gtk_ctree_set_indent', 'E', + 'gtk_ctree_set_line_style', 'E', + 'gtk_ctree_set_node_info', 'E', + 'gtk_ctree_set_reorderable', 'E', + 'gtk_ctree_set_show_stub', 'E', + 'gtk_ctree_set_spacing', 'E', + 'gtk_ctree_sort_node', 'E', + 'gtk_ctree_sort_recursive', 'E', + 'gtk_ctree_toggle_expansion', 'E', + 'gtk_ctree_toggle_expansion_recursive', 'E', + 'gtk_ctree_unselect', 'E', + 'gtk_ctree_unselect_recursive', 'E', + 'gtk_drag_set_default_icon', 'E', + 'gtk_draw_arrow', 'E', + 'gtk_draw_box', 'E', + 'gtk_draw_box_gap', 'E', + 'gtk_draw_check', 'E', + 'gtk_draw_diamond', 'E', + 'gtk_draw_expander', 'E', + 'gtk_draw_extension', 'E', + 'gtk_draw_flat_box', 'E', + 'gtk_draw_focus', 'E', + 'gtk_draw_handle', 'E', + 'gtk_draw_hline', 'E', + 'gtk_draw_layout', 'E', + 'gtk_draw_option', 'E', + 'gtk_draw_polygon', 'E', + 'gtk_draw_resize_grip', 'E', + 'gtk_draw_shadow', 'E', + 'gtk_draw_shadow_gap', 'E', + 'gtk_draw_slider', 'E', + 'gtk_draw_string', 'E', + 'gtk_draw_tab', 'E', + 'gtk_draw_vline', 'E', + 'gtk_drawing_area_size', 'W', # >> g_object_set() [==] ? + # gtk_widget_set_size_request() (==?] + 'gtk_entry_append_text', 'W', # >> gtk_editable_insert_text() [==?] + 'gtk_entry_new_with_max_length', 'E', # gtk_entry_new(); gtk_entry_set_max_length() + 'gtk_entry_prepend_text', 'E', + 'gtk_entry_select_region', 'E', + 'gtk_entry_set_editable', 'W', # >> gtk_editable_set_editable() [==?] + 'gtk_entry_set_position', 'E', + 'gtk_exit', 'W', # exit() [==?] + 'gtk_file_chooser_button_new_with_backend', 'E', + 'gtk_file_chooser_dialog_new_with_backend', 'E', + 'gtk_file_chooser_widget_new_with_backend', 'E', + 'gtk_file_selection_complete', 'E', + 'gtk_file_selection_get_filename', 'W', # GtkFileChooser ... + 'gtk_file_selection_get_select_multiple', 'E', + 'gtk_file_selection_get_selections', 'E', + 'gtk_file_selection_hide_fileop_buttons', 'E', + 'gtk_file_selection_new', 'W', + 'gtk_file_selection_set_filename', 'E', + 'gtk_file_selection_set_select_multiple', 'E', + 'gtk_file_selection_show_fileop_buttons', 'E', + 'gtk_font_selection_dialog_get_font', 'E', + 'gtk_font_selection_get_font', 'E', # gtk_font_selection_get_font_name [!=] + 'GTK_FUNDAMENTAL_TYPE', 'E', + 'gtk_hbutton_box_get_layout_default', 'E', + 'gtk_hbutton_box_get_spacing_default', 'E', + 'gtk_hbutton_box_set_layout_default', 'E', + 'gtk_hbutton_box_set_spacing_default', 'E', + 'gtk_idle_add', 'E', + 'gtk_idle_add_full', 'E', + 'gtk_idle_add_priority', 'E', + 'gtk_idle_remove', 'E', + 'gtk_idle_remove_by_data', 'E', + 'gtk_image_get', 'E', + 'gtk_image_set', 'E', + 'gtk_input_add_full', 'W', # >>> g_io_add_watch_full() + 'gtk_input_remove', 'W', # >>> g_source_remove() + 'GTK_IS_ROOT_TREE', 'E', + 'gtk_item_factories_path_delete', 'E', # GtkUIManager (avail since 2.4) ... + 'gtk_item_factory_add_foreign', 'E', + 'gtk_item_factory_construct', 'E', + 'gtk_item_factory_create_item', 'W', + 'gtk_item_factory_create_items', 'E', + 'gtk_item_factory_create_items_ac', 'W', + 'gtk_item_factory_create_menu_entries', 'E', + 'gtk_item_factory_delete_entries', 'E', + 'gtk_item_factory_delete_entry', 'E', + 'gtk_item_factory_delete_item', 'E', + 'gtk_item_factory_from_path', 'E', + 'gtk_item_factory_from_widget', 'E', + 'gtk_item_factory_get_item', 'E', + 'gtk_item_factory_get_item_by_action', 'E', + 'gtk_item_factory_get_widget', 'W', + 'gtk_item_factory_get_widget_by_action', 'E', + 'gtk_item_factory_new', 'W', + 'gtk_item_factory_path_from_widget', 'E', + 'gtk_item_factory_popup', 'E', + 'gtk_item_factory_popup_data', 'E', + 'gtk_item_factory_popup_data_from_widget', 'E', + 'gtk_item_factory_popup_with_data', 'E', + 'gtk_item_factory_set_translate_func', 'E', + 'gtk_label_get', 'W', # >>> gtk_label_get_text() [!=] + 'gtk_label_parse_uline', 'E', + 'gtk_label_set', 'E', # >>> gtk_label_set_text() [==] + 'gtk_layout_freeze', 'E', + 'gtk_layout_thaw', 'E', + 'gtk_list_append_items', 'E', + 'gtk_list_child_position', 'E', + 'gtk_list_clear_items', 'E', + 'gtk_list_end_drag_selection', 'E', + 'gtk_list_end_selection', 'E', + 'gtk_list_extend_selection', 'E', + 'gtk_list_insert_items', 'E', + 'gtk_list_item_deselect', 'E', + 'gtk_list_item_new', 'E', + 'gtk_list_item_new_with_label', 'E', + 'gtk_list_item_select', 'E', + 'gtk_list_new', 'E', + 'gtk_list_prepend_items', 'E', + 'gtk_list_remove_items', 'E', + 'gtk_list_remove_items_no_unref', 'E', + 'gtk_list_scroll_horizontal', 'E', + 'gtk_list_scroll_vertical', 'E', + 'gtk_list_select_all', 'E', + 'gtk_list_select_child', 'E', + 'gtk_list_select_item', 'E', # Fix/remove in expert_dlg.c + 'gtk_list_set_selection_mode', 'E', # remove in comment ? + 'gtk_list_start_selection', 'E', + 'gtk_list_toggle_add_mode', 'E', + 'gtk_list_toggle_focus_row', 'E', + 'gtk_list_toggle_row', 'E', + 'gtk_list_undo_selection', 'E', + 'gtk_list_unselect_all', 'E', + 'gtk_list_unselect_child', 'E', + 'gtk_list_unselect_item', 'E', + 'gtk_menu_append', 'E', # gtk_menu_shell_append() [==?] + 'gtk_menu_bar_append', 'E', + 'gtk_menu_bar_insert', 'E', + 'gtk_menu_bar_prepend', 'E', + 'gtk_menu_insert', 'E', + 'gtk_menu_item_remove_submenu', 'E', + 'gtk_menu_item_right_justify', 'E', + 'gtk_menu_prepend', 'E', # gtk_menu_shell_prepend() [==?] + 'gtk_menu_tool_button_set_arrow_tooltip', 'E', + 'gtk_notebook_current_page', 'E', + 'gtk_notebook_get_group_id', 'E', + 'gtk_notebook_set_group_id', 'E', + 'gtk_notebook_set_homogeneous_tabs', 'E', + 'gtk_notebook_set_page', 'E', # gtk_notebook_set_current_page() [==] + 'gtk_notebook_set_tab_border', 'E', + 'gtk_notebook_set_tab_hborder', 'E', + 'gtk_notebook_set_tab_vborder', 'E', + 'gtk_object_add_arg_type', 'E', + 'gtk_object_data_force_id', 'E', + 'gtk_object_data_try_key', 'E', + 'GTK_OBJECT_FLOATING', 'E', + 'gtk_object_get', 'E', + 'gtk_object_get_data', 'E', + 'gtk_object_get_data_by_id', 'E', + 'gtk_object_get_user_data', 'E', + 'gtk_object_new', 'E', + 'gtk_object_ref', 'E', + 'gtk_object_remove_data', 'E', + 'gtk_object_remove_data_by_id', 'E', + 'gtk_object_remove_no_notify', 'E', + 'gtk_object_remove_no_notify_by_id', 'E', + 'gtk_object_set', 'E', + 'gtk_object_set_data', 'E', + 'gtk_object_set_data_by_id', 'E', + 'gtk_object_set_data_by_id_full', 'E', + 'gtk_object_set_data_full', 'E', + 'gtk_object_set_user_data', 'E', + 'gtk_object_sink', 'E', + 'gtk_object_unref', 'E', + 'gtk_object_weakref', 'E', + 'gtk_object_weakunref', 'E', + 'gtk_old_editable_changed', 'E', + 'gtk_old_editable_claim_selection', 'E', + 'gtk_option_menu_get_history', 'E', # GtkComboBox ... (avail since 2.4/2.6/2.10/2.14) + 'gtk_option_menu_get_menu', 'W', + 'gtk_option_menu_new', 'W', + 'gtk_option_menu_remove_menu', 'W', + 'gtk_option_menu_set_history', 'W', + 'gtk_option_menu_set_menu', 'W', + 'gtk_paint_string', 'E', + 'gtk_paned_gutter_size', 'E', # gtk_paned_set_gutter_size() + 'gtk_paned_set_gutter_size', 'E', # "does nothing" + 'gtk_pixmap_get', 'E', # GtkImage ... + 'gtk_pixmap_new', 'W', + 'gtk_pixmap_set', 'E', + 'gtk_pixmap_set_build_insensitive', 'E', + 'gtk_preview_draw_row', 'E', + 'gtk_preview_get_cmap', 'E', + 'gtk_preview_get_info', 'E', + 'gtk_preview_get_visual', 'E', + 'gtk_preview_new', 'E', + 'gtk_preview_put', 'E', + 'gtk_preview_reset', 'E', + 'gtk_preview_set_color_cube', 'E', + 'gtk_preview_set_dither', 'E', + 'gtk_preview_set_expand', 'E', + 'gtk_preview_set_gamma', 'E', + 'gtk_preview_set_install_cmap', 'E', + 'gtk_preview_set_reserved', 'E', + 'gtk_preview_size', 'E', + 'gtk_preview_uninit', 'E', + 'gtk_progress_bar_new_with_adjustment', 'E', + 'gtk_progress_bar_set_activity_blocks', 'E', + 'gtk_progress_bar_set_activity_step', 'E', + 'gtk_progress_bar_set_bar_style', 'E', + 'gtk_progress_bar_set_discrete_blocks', 'E', + 'gtk_progress_bar_update', 'W', # >>> "gtk_progress_set_value() or + # gtk_progress_set_percentage()" + ## Actually: GtkProgrss is deprecated so the + ## right answer appears to be to use + ## gtk_progress_bar_set_fraction() + 'gtk_progress_configure', 'E', + 'gtk_progress_get_current_percentage', 'E', + 'gtk_progress_get_current_text', 'E', + 'gtk_progress_get_percentage_from_value', 'E', + 'gtk_progress_get_text_from_value', 'E', + 'gtk_progress_get_value', 'E', + 'gtk_progress_set_activity_mode', 'E', + 'gtk_progress_set_adjustment', 'E', + 'gtk_progress_set_format_string', 'E', + 'gtk_progress_set_percentage', 'E', + 'gtk_progress_set_show_text', 'E', + 'gtk_progress_set_text_alignment', 'E', + 'gtk_progress_set_value', 'E', + 'gtk_radio_button_group', 'E', # gtk_radio_button_get_group() [==] + 'gtk_radio_menu_item_group', 'E', + 'gtk_rc_add_class_style', 'E', + 'gtk_rc_add_widget_class_style', 'E', + 'gtk_rc_add_widget_name_style', 'E', + 'gtk_rc_style_ref', 'E', + 'gtk_rc_style_unref', 'E', + 'gtk_recent_chooser_get_show_numbers', 'E', + 'gtk_recent_chooser_set_show_numbers', 'E', + 'gtk_recent_manager_get_for_screen', 'E', + 'gtk_recent_manager_set_screen', 'E', + 'GTK_RETLOC_BOOL', 'E', + 'GTK_RETLOC_BOXED', 'E', + 'GTK_RETLOC_CHAR', 'E', + 'GTK_RETLOC_DOUBLE', 'E', + 'GTK_RETLOC_ENUM', 'E', + 'GTK_RETLOC_FLAGS', 'E', + 'GTK_RETLOC_FLOAT', 'E', + 'GTK_RETLOC_INT', 'E', + 'GTK_RETLOC_LONG', 'E', + 'GTK_RETLOC_OBJECT', 'E', + 'GTK_RETLOC_POINTER', 'E', + 'GTK_RETLOC_STRING', 'E', + 'GTK_RETLOC_UCHAR', 'E', + 'GTK_RETLOC_UINT', 'E', + 'GTK_RETLOC_ULONG', 'E', + 'gtk_selection_clear', 'E', + 'gtk_signal_connect', 'E', # GSignal ... + 'gtk_signal_connect_after', 'E', + 'gtk_signal_connect_full', 'E', + 'gtk_signal_connect_object', 'E', + 'gtk_signal_connect_object_after', 'E', + 'gtk_signal_connect_object_while_alive', 'E', + 'gtk_signal_connect_while_alive', 'E', + 'gtk_signal_default_marshaller', 'E', + 'gtk_signal_disconnect', 'E', + 'gtk_signal_disconnect_by_data', 'E', + 'gtk_signal_disconnect_by_func', 'E', + 'gtk_signal_emit', 'E', + 'gtk_signal_emit_by_name', 'E', + 'gtk_signal_emit_stop', 'E', + 'gtk_signal_emit_stop_by_name', 'E', + 'gtk_signal_emitv', 'E', + 'gtk_signal_emitv_by_name', 'E', + 'GTK_SIGNAL_FUNC', 'W', + 'gtk_signal_handler_block', 'E', + 'gtk_signal_handler_block_by_data', 'E', + 'gtk_signal_handler_block_by_func', 'E', + 'gtk_signal_handler_pending', 'E', + 'gtk_signal_handler_pending_by_func', 'E', + 'gtk_signal_handler_unblock', 'E', + 'gtk_signal_handler_unblock_by_data', 'E', + 'gtk_signal_handler_unblock_by_func', 'E', + 'gtk_signal_lookup', 'E', + 'gtk_signal_name', 'E', + 'gtk_signal_new', 'E', + 'gtk_signal_newv', 'E', + 'GTK_SIGNAL_OFFSET', 'E', + 'gtk_socket_steal', 'E', + 'gtk_spin_button_get_value_as_float', 'E', # gtk_spin_button_get_value() [==] + 'GTK_STRUCT_OFFSET', 'E', + 'gtk_style_apply_default_pixmap', 'E', + 'gtk_style_get_font', 'E', + 'gtk_style_ref', 'E', + 'gtk_style_set_font', 'E', + 'gtk_style_unref', 'E', # g_object_unref() [==?] + 'gtk_text_backward_delete', 'E', + 'gtk_text_forward_delete', 'E', + 'gtk_text_freeze', 'E', + 'gtk_text_get_length', 'E', + 'gtk_text_get_point', 'E', + 'GTK_TEXT_INDEX', 'E', + 'gtk_text_insert', 'W', # GtkTextView (GtkText "known to be buggy" !) + 'gtk_text_new', 'E', + 'gtk_text_set_adjustments', 'E', + 'gtk_text_set_editable', 'E', + 'gtk_text_set_line_wrap', 'E', + 'gtk_text_set_point', 'E', + 'gtk_text_set_word_wrap', 'E', + 'gtk_text_thaw', 'E', + 'gtk_timeout_add', 'E', # g_timeout_add() + 'gtk_timeout_add_full', 'E', + 'gtk_timeout_remove', 'E', # g_source_remove() + 'gtk_tips_query_new', 'E', + 'gtk_tips_query_set_caller', 'E', + 'gtk_tips_query_set_labels', 'E', + 'gtk_tips_query_start_query', 'E', + 'gtk_tips_query_stop_query', 'E', + 'gtk_toggle_button_set_state', 'E', # gtk_toggle_button_set_active [==] + 'gtk_toolbar_append_element', 'E', + 'gtk_toolbar_append_item', 'E', + 'gtk_toolbar_append_space', 'W', # ?? + 'gtk_toolbar_append_widget', 'W', # ?? + 'gtk_toolbar_get_tooltips', 'E', + 'gtk_toolbar_insert_element', 'E', + 'gtk_toolbar_insert_item', 'E', + 'gtk_toolbar_insert_space', 'E', + 'gtk_toolbar_insert_stock', 'E', + 'gtk_toolbar_insert_widget', 'E', + 'gtk_toolbar_prepend_element', 'E', + 'gtk_toolbar_prepend_item', 'E', + 'gtk_toolbar_prepend_space', 'E', + 'gtk_toolbar_prepend_widget', 'E', + 'gtk_toolbar_remove_space', 'E', + 'gtk_toolbar_set_tooltips', 'E', + 'gtk_tree_append', 'E', + 'gtk_tree_child_position', 'E', + 'gtk_tree_clear_items', 'E', + 'gtk_tree_insert', 'E', + 'gtk_tree_item_collapse', 'E', + 'gtk_tree_item_deselect', 'E', + 'gtk_tree_item_expand', 'E', + 'gtk_tree_item_new', 'E', + 'gtk_tree_item_new_with_label', 'E', + 'gtk_tree_item_remove_subtree', 'E', + 'gtk_tree_item_select', 'E', + 'gtk_tree_item_set_subtree', 'E', + 'GTK_TREE_ITEM_SUBTREE', 'E', + 'gtk_tree_model_get_iter_root', 'E', + 'gtk_tree_new', 'E', + 'gtk_tree_path_new_root', 'E', + 'gtk_tree_prepend', 'E', + 'gtk_tree_remove_item', 'E', + 'gtk_tree_remove_items', 'E', + 'GTK_TREE_ROOT_TREE', 'E', + 'gtk_tree_select_child', 'E', + 'gtk_tree_select_item', 'E', + 'GTK_TREE_SELECTION_OLD', 'E', + 'gtk_tree_set_selection_mode', 'E', + 'gtk_tree_set_view_lines', 'E', + 'gtk_tree_set_view_mode', 'E', + 'gtk_tree_unselect_child', 'E', + 'gtk_tree_unselect_item', 'E', + 'gtk_tree_view_tree_to_widget_coords', 'E', + 'gtk_tree_view_widget_to_tree_coords', 'E', + 'gtk_type_class', 'W', # g_type_class_peek() or g_type_class_ref() + 'GTK_TYPE_CTREE_NODE', 'E', + 'gtk_type_enum_find_value', 'E', + 'gtk_type_enum_get_values', 'E', + 'gtk_type_flags_find_value', 'E', + 'gtk_type_flags_get_values', 'E', + 'gtk_type_from_name', 'E', + 'gtk_type_init', 'E', + 'gtk_type_is_a', 'E', + 'GTK_TYPE_IS_OBJECT', 'E', + 'gtk_type_name', 'E', + 'gtk_type_new', 'E', + 'gtk_type_parent', 'E', + 'gtk_type_unique', 'E', + 'GTK_VALUE_BOOL', 'E', + 'GTK_VALUE_BOXED', 'E', + 'GTK_VALUE_CHAR', 'E', + 'GTK_VALUE_DOUBLE', 'E', + 'GTK_VALUE_ENUM', 'E', + 'GTK_VALUE_FLAGS', 'E', + 'GTK_VALUE_FLOAT', 'E', + 'GTK_VALUE_INT', 'E', + 'GTK_VALUE_LONG', 'E', + 'GTK_VALUE_OBJECT', 'E', + 'GTK_VALUE_POINTER', 'E', + 'GTK_VALUE_SIGNAL', 'E', + 'GTK_VALUE_STRING', 'E', + 'GTK_VALUE_UCHAR', 'E', + 'GTK_VALUE_UINT', 'E', + 'GTK_VALUE_ULONG', 'E', + 'gtk_vbutton_box_get_layout_default', 'E', + 'gtk_vbutton_box_get_spacing_default', 'E', + 'gtk_vbutton_box_set_layout_default', 'E', + 'gtk_vbutton_box_set_spacing_default', 'E', + 'gtk_widget_draw', 'W', # gtk_widget_queue_draw_area(): + # "in general a better choice if you want + # to draw a region of a widget." + 'gtk_widget_pop_visual', 'E', + 'gtk_widget_push_visual', 'E', + 'gtk_widget_queue_clear', 'E', + 'gtk_widget_queue_clear_area', 'E', + 'gtk_widget_ref', 'W', # >>> g_object_ref() [==] + 'gtk_widget_restore_default_style', 'E', + 'gtk_widget_set', 'E', # g_object_set() [==] + 'gtk_widget_set_default_visual', 'E', + 'gtk_widget_set_rc_style', 'E', + 'gtk_widget_set_uposition', 'W', # ?? (see GTK documentation) + 'gtk_widget_set_usize', 'W', # >>? gtk_widget_set_size_request() + 'gtk_widget_set_visual', 'E', + 'gtk_widget_unref', 'E', + 'gtk_window_position', 'E', + 'gtk_window_set_policy', 'W', # >>? gtk_window_set_resizable() +## +## Deprecated but to be replaced only when Wireshark requires GTK+ 2.12 or later +## 2.12 'gtk_tooltips_data_get', '?', # new API: GtkToolTip (avail since 2.12) ... +## 'gtk_tooltips_disable', '?', +## 'gtk_tooltips_enable', '?', +## 'gtk_tooltips_force_window', '?', +## 'gtk_tooltips_get_info_from_tip_window', '?', +## 'gtk_tooltips_new', '?', +## 'gtk_tooltips_set_delay', '?', +## 'gtk_tooltips_set_tip', '?', +## 2.12 'gtk_tool_item_set_tooltip', '?', # gtk_tool_item_set_tooltip_text() (avail since 2.12) +); + +@{$APIs{'deprecated-gtk'}->{'functions'}} = grep {$deprecatedGtkFunctions{$_} eq 'E'} keys %deprecatedGtkFunctions; +@{$APIs{'deprecated-gtk-todo'}->{'functions'}} = grep {$deprecatedGtkFunctions{$_} eq 'W'} keys %deprecatedGtkFunctions; + + -# Given a list of APIs and the contents of a file, see if the API appears -# in the file. If so, push the API onto the provided list. -sub findAPIinList($$$) +# Given a ref to a hash containing "functions" and "functions_count" entries: +# Determine if the any of the list of APIs contained in the array referenced by "functions" +# exists in the file. +# For each API which appears in the file: +# Push the API onto the provided list; +# Add the number of times the API appears in the file to the total count +# for the API (stored as the value of the API key in the hash referenced by "function_counts"). + +sub findAPIinFile($$$) { - my ($apiList, $fileContentsRef, $foundAPIsRef)=@_; + my ($groupHashRef, $fileContentsRef, $foundAPIsRef) = @_; - for my $api (@{$apiList}) - { - if ($$fileContentsRef =~ m/\W$api\W*\(/) - { - push @{$foundAPIsRef},$api; - } - } + for my $api ( @{$groupHashRef->{functions}} ) + { + my $cnt = 0; + while (${$fileContentsRef} =~ m/ \W $api \W* \( /gx) + { + $cnt += 1; + } + if ($cnt > 0) { + push @{$foundAPIsRef}, $api; + $groupHashRef->{function_counts}->{$api} += 1; + } + } } # The below Regexp are based on those from: @@ -192,18 +821,18 @@ sub findAPIinList($$$) # They are in the public domain. # 1. A complicated regex which matches C-style comments. -my $CComment = qr{/\*[^*]*\*+([^/*][^*]*\*+)*/}; +my $CComment = qr{ / [*] [^*]* [*]+ (?: [^/*] [^*]* [*]+ )* / }x; # 1.a A regex that matches C++-style comments. -#my $CppComment = qr{//(.*?)\n}; +#my $CppComment = qr{ // (.*?) \n }x; # 2. A regex which matches double-quoted strings. # ?s added so that strings containing a 'line continuation' # ( \ followed by a new-line) will match. -my $DoubleQuotedStr = qr{(?:\"(?s:\\.|[^\"\\])*\")}; +my $DoubleQuotedStr = qr{ (?: ["] (?s: \\. | [^\"\\])* ["]) }x; # 3. A regex which matches single-quoted strings. -my $SingleQuotedStr = qr{(?:\'(?:\\.|[^\'\\])*\')}; +my $SingleQuotedStr = qr{ (?: \' (?: \\. | [^\'\\])* [']) }x; # 4. Now combine 1 through 3 to produce a regex which # matches _either_ double or single quoted strings @@ -215,31 +844,47 @@ my $SingleQuotedStr = qr{(?:\'(?:\\.|[^\'\\])*\')}; # 4. Wireshark is strictly a C program so don't take out C++ style comments # since they shouldn't be there anyway... # Also: capturing the comment isn't necessary. -my $commentAndStringRegex = qr{(?:$DoubleQuotedStr|$SingleQuotedStr|$CComment)}; +my $commentAndStringRegex = qr{ (?: $DoubleQuotedStr | $SingleQuotedStr | $CComment) }x; #### Regex for use when searching for value-string definitions -my $StaticRegex = qr{static\s+}; -my $ConstRegex = qr{const\s+}; -my $Static_andor_ConstRegex = qr{(?:$StaticRegex$ConstRegex|$StaticRegex|$ConstRegex)}; +my $StaticRegex = qr/ static \s+ /xs; +my $ConstRegex = qr/ const \s+ /xs; +my $Static_andor_ConstRegex = qr/ (?: $StaticRegex $ConstRegex | $StaticRegex | $ConstRegex) /xs; +my $ValueStringRegex = qr/ $Static_andor_ConstRegex value_string [^;*]+ = [^;]+ [{] [^;]+ ; /xs; + # # MAIN # my $errorCount = 0; # The default list, which can be expanded. my @apiGroups = qw(prohibited deprecated); +my @apiSummaryGroups = (); my $check_value_string_array_null_termination = 1; # default: enabled +my $machine_readable_output = 0; # default: disabled my $debug_flag = 0; my $result = GetOptions( - 'g=s' => \@apiGroups, + 'group=s' => \@apiGroups, + 'summary-group=s' => \@apiSummaryGroups, 'check-value-string-array-null-termination!' => \$check_value_string_array_null_termination, + 'Machine-readable' => \$machine_readable_output, 'debug' => \$debug_flag ); if (!$result) { - print "Usage: checkAPIs.pl [-g group1] [-g group2] [--nocheck-value-string-array-null-termination] file1 file2 ..\n"; - exit(1); + print "Usage: checkAPIs.pl [-M] [-g group1] [-g group2] [-s group1] [-s group2] [--nocheck-value-string-array-null-termination] file1 file2 ..\n"; + exit(1); } +# Add a 'function_count' anonymous hash to each of the 'apiGroup' entries in the %APIs hash. +for my $apiGroup (keys %APIs) { + my @functions = @{$APIs{$apiGroup}{functions}}; + + $APIs{$apiGroup}->{function_counts} = {}; + @{$APIs{$apiGroup}->{function_counts}}{@functions} = (); # Add fcn names as keys to the anonymous hash +} + + +# Read through the files; do various checks while ($_ = $ARGV[0]) { shift; @@ -250,36 +895,36 @@ while ($_ = $ARGV[0]) die "No such file: \"$filename\"" if (! -e $filename); # delete leading './' - $filename =~ s@^\./@@; + $filename =~ s{ ^ \. / } {}xo; # Read in the file (ouch, but it's easier that way) open(FC, $filename) || die("Couldn't open $filename"); while (<FC>) { $fileContents .= $_; } close(FC); - if ($fileContents =~ m{[\x80-\xFF]}) + if ($fileContents =~ m{ [\x80-\xFF] }xo) { print STDERR "Warning: Found non-ASCII characters in " .$filename."\n"; # Treat as warning # $errorCount++; } - if ($fileContents =~ m{%ll}) + if ($fileContents =~ m{ %ll }xo) { # use G_GINT64_MODIFIER instead of ll print STDERR "Error: Found %ll in " .$filename."\n"; $errorCount++; } - if (! ($fileContents =~ m{\$Id.*\$})) + if (! ($fileContents =~ m{ \$Id .* \$ }xo)) { print STDERR "Warning: ".$filename." does not have an SVN Id tag.\n"; } # Remove all the C-comments and strings - $fileContents =~ s {$commentAndStringRegex} []g; + $fileContents =~ s {$commentAndStringRegex} []xog; - if ($fileContents =~ m{//}) + if ($fileContents =~ m{ // }xo) { print STDERR "Error: Found C++ style comments in " .$filename."\n"; $errorCount++; @@ -289,42 +934,61 @@ while ($_ = $ARGV[0]) if ($check_value_string_array_null_termination) { # Assumption: definition is of form (pseudo-Regex): # " (static const|static|const) value_string .+ = { .+ ;" (possibly over multiple lines) - while ($fileContents =~ /( $Static_andor_ConstRegex value_string [^;*]+ = [^;]+ \{ [^;]+ ; )/xsg) { + while ($fileContents =~ / ( $ValueStringRegex ) /xsog) { # value_string array definition found; check if NULL terminated my $vs = my $vsx = $1; if ($debug_flag) { - $vsx =~ /(.+ value_string [^=]+ ) = /x; + $vsx =~ / ( .+ value_string [^=]+ ) = /xo; printf STDERR "==> %-35.35s: %s\n", $filename, $1; printf STDERR "%s\n", $vs; } - $vs =~ s/\s//g; + $vs =~ s{ \s } {}xg; # README.developer says # "Don't put a comma after the last tuple of an initializer of an array" # However: since this usage is present in some number of cases, we'll allow for now - if ($vs !~ / , NULL \} ,? \} ; $/x) { - $vsx =~ /( value_string [^=]+ ) = /x; + if ($vs !~ / , NULL [}] ,? [}] ; $/xo) { + $vsx =~ /( value_string [^=]+ ) = /xo; printf STDERR "Error: %-35.35s: Not terminated: %s\n", $filename, $1; $errorCount++; } } } - # Check APIs - for my $apiName (@apiGroups) { + # Check and count APIs + for my $apiGroup (@apiGroups) { my $pfx = "Warning"; @foundAPIs = (); - findAPIinList($APIs{$apiName}->{functions}, \$fileContents, \@foundAPIs); + findAPIinFile($APIs{$apiGroup}, \$fileContents, \@foundAPIs); - if ($APIs{$apiName}->{count_errors}) { + if ($APIs{$apiGroup}->{count_errors}) { # the use of "prohibited" APIs is an error, increment the error count $errorCount += @foundAPIs; $pfx = "Error"; } - print STDERR $pfx . ": Found " . $apiName . " APIs in ".$filename.": ".join(',', @foundAPIs)."\n" if @foundAPIs; + if (@foundAPIs && ! $machine_readable_output) { + print STDERR $pfx . ": Found " . $apiGroup . " APIs in ".$filename.": ".join(',', @foundAPIs)."\n" + } + if (@foundAPIs && $machine_readable_output) { + for my $api (@foundAPIs) { + printf STDERR "%-8.8s %-20.20s %-30.30s %-45.45s\n", $pfx, $apiGroup, $filename, $api; + } + } } +} +# Summary: Print Usage Counts of each API in each requested summary group + +for my $apiGroup (@apiSummaryGroups) +{ + printf "\n\nUsage Counts\n"; + for my $api (sort {"\L$a" cmp "\L$b"} (keys %{$APIs{$apiGroup}->{function_counts}} )) { + printf "%-20.20s %5d %-40.40s\n", $apiGroup . ':', $APIs{$apiGroup}{function_counts}{$api}, $api; + } } exit($errorCount); + + + |