X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;ds=sidebyside;f=ltt%2Fbranches%2Fpoly%2Flttv%2Fmodules%2Fgui%2Ffilter%2Ffilter.c;h=a73f14669db7c119849c0d7a88ce9601fcb9fde3;hb=7e7af7f21b42d02e74f52576a8ac163b65e021b4;hp=bc2c68c8bb3989c1d6343c80642f70b4da453cd5;hpb=1f7f7fe2f8c66458113daf17f77d3c31596621b4;p=lttv.git diff --git a/ltt/branches/poly/lttv/modules/gui/filter/filter.c b/ltt/branches/poly/lttv/modules/gui/filter/filter.c index bc2c68c8..a73f1466 100644 --- a/ltt/branches/poly/lttv/modules/gui/filter/filter.c +++ b/ltt/branches/poly/lttv/modules/gui/filter/filter.c @@ -1,5 +1,5 @@ /* This file is part of the Linux Trace Toolkit viewer - * Copyright (C) 2003-2004 Simon Bouvier-Zappa + * Copyright (C) 2005 Simon Bouvier-Zappa * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License Version 2 as @@ -31,19 +31,22 @@ #include "hGuiFilterInsert.xpm" -/* - * TODO - * - connect the gui filter to the core filter - */ - -/* - * NOTE - * The version of gtk-2.0 currently installed on - * my desktop misses some function of the newer - * gtk+ api. +/*! \file lttv/modules/gui/filter/filter.c + * \brief Graphic filter interface. + * + * The gui filter facility gives the user an easy to use + * basic interface to construct and modify at will a filter + * expression. User may either decide to write it himself in + * expression text entry or add simple expressions using the + * many choices boxes. + * + * NOTE: + * The version of gtk-2.0 currently installed on + * my desktop misses some function of the newer + * gtk+ api. * - * For the time being, I'll use the older api - * to keep compatibility with most systems. + * For the time being, I'll use the older api + * to keep compatibility with most systems. */ typedef struct _FilterViewerData FilterViewerData; @@ -71,65 +74,72 @@ void callback_add_button(GtkWidget *widget, gpointer data); void callback_logical_op_box(GtkWidget *widget, gpointer data); void callback_expression_field(GtkWidget *widget, gpointer data); +/** + * @struct _FilterViewerDataLine + * + * @brief Defines a simple expression + * This structures defines a simple + * expression whithin the main filter + * viewer data + */ struct _FilterViewerDataLine { - int row; - gboolean visible; - GtkWidget *f_not_op_box; - GtkWidget *f_logical_op_box; - GtkWidget *f_field_box; - GtkWidget *f_math_op_box; - GtkWidget *f_value_field; + int row; /**< row number */ + gboolean visible; /**< visible state */ + GtkWidget *f_not_op_box; /**< '!' operator (GtkComboBox) */ + GtkWidget *f_logical_op_box; /**< '&,|,^' operators (GtkComboBox) */ + GtkWidget *f_field_box; /**< field types (GtkComboBox) */ + GtkWidget *f_math_op_box; /**< '>,>=,<,<=,=,!=' operators (GtkComboBox) */ + GtkWidget *f_value_field; /**< expression's value (GtkComboBox) */ }; /** - * @struct _FilterViewerData - * Main struct for the filter gui module + * @struct _FilterViewerData + * + * @brief Main structure of gui filter + * Main struct for the filter gui module */ struct _FilterViewerData { - Tab *tab; + Tab *tab; /**< current tab of module */ - GtkWidget *f_main_box; + GtkWidget *f_main_box; /**< main container */ - GtkWidget *f_hbox1; - GtkWidget *f_hbox2; - - GtkWidget *f_expression_field; - GtkWidget *f_process_button; + GtkWidget *f_expression_field; /**< entire expression (GtkEntry) */ + GtkWidget *f_process_button; /**< process expression button (GtkButton) */ - GtkWidget *f_logical_op_junction_box; + GtkWidget *f_logical_op_junction_box; /**< linking operator box (GtkComboBox) */ - int rows; - GPtrArray *f_lines; + int rows; /**< number of rows */ + GPtrArray *f_lines; /**< array of FilterViewerDataLine */ - GPtrArray *f_not_op_options; - GPtrArray *f_logical_op_options; - GPtrArray *f_field_options; - GPtrArray *f_math_op_options; + GPtrArray *f_not_op_options; /**< array of operators types for not_op box */ + GPtrArray *f_logical_op_options; /**< array of operators types for logical_op box */ + GPtrArray *f_field_options; /**< array of field types for field box */ + GPtrArray *f_math_op_options; /**< array of operators types for math_op box */ - GtkWidget *f_add_button; - - GtkWidget *f_textwnd; - GtkWidget *f_selectwnd; - GtkWidget *f_treewnd; + GtkWidget *f_add_button; /**< add expression to current expression (GtkButton) */ }; /** + * @fn GtkWidget* guifilter_get_widget(FilterViewerData*) + * * This function returns the current main widget * used by this module * @param fvd the module struct * @return The main widget */ -GtkWidget -*guifilter_get_widget(FilterViewerData *fvd) +GtkWidget* +guifilter_get_widget(FilterViewerData *fvd) { return fvd->f_main_box; } /** - * Constructor is used to create FilterViewerData data structure. - * @param the tab structure used by the widget - * @return The Filter viewer data created. + * @fn FilterViewerData* gui_filter(Tab*) + * + * Constructor is used to create FilterViewerData data structure. + * @param tab The tab structure used by the widget + * @return The Filter viewer data created. */ FilterViewerData* gui_filter(Tab *tab) @@ -272,6 +282,8 @@ gui_filter(Tab *tab) } /** + * @fn FilterViewerDataLine* gui_filter_add_line(FilterViewerData*) + * * Adds a filter option line on the module tab * @param fvd The filter module structure * @return The line structure @@ -285,33 +297,6 @@ gui_filter_add_line(FilterViewerData* fvd) { fvdl->row = fvd->rows; fvdl->visible = TRUE; - /* - fvdl->f_struct_box = gtk_combo_box_new_text(); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_struct_box), ""); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_struct_box), "event"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_struct_box), "tracefile"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_struct_box), "trace"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_struct_box), "state"); - gtk_widget_show(fvdl->f_struct_box); - - fvdl->f_subfield_box = gtk_combo_box_new_text(); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), ""); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "name"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "category"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "time"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "tsc"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "pid"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "ppid"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "creation time"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "insertion time"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "process name"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "execution mode"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "execution submode"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "process status"); - gtk_combo_box_append_text (GTK_COMBO_BOX (fvdl->f_subfield_box), "cpu"); - gtk_widget_show(fvdl->f_subfield_box); - */ - fvdl->f_not_op_box = gtk_combo_box_new_text(); for(i=0;if_not_op_options->len;i++) { GString* s = g_ptr_array_index(fvd->f_not_op_options,i); @@ -349,8 +334,6 @@ gui_filter_add_line(FilterViewerData* fvd) { gui_filter_line_reset(fvdl); gui_filter_line_set_visible(fvdl,TRUE); -// gtk_table_attach( GTK_TABLE(fvd->f_main_box),fvdl->f_struct_box,0,1,fvd->rows+1,fvd->rows+2,GTK_SHRINK,GTK_FILL,0,0); -// gtk_table_attach( GTK_TABLE(fvd->f_main_box),fvdl->f_subfield_box,1,2,fvd->rows+1,fvd->rows+2,GTK_SHRINK,GTK_FILL,0,0); gtk_table_attach( GTK_TABLE(fvd->f_main_box),fvdl->f_not_op_box,0,1,fvd->rows+1,fvd->rows+2,GTK_SHRINK,GTK_FILL,0,0); gtk_table_attach( GTK_TABLE(fvd->f_main_box),fvdl->f_field_box,1,3,fvd->rows+1,fvd->rows+2,GTK_SHRINK,GTK_FILL,0,0); gtk_table_attach( GTK_TABLE(fvd->f_main_box),fvdl->f_math_op_box,3,4,fvd->rows+1,fvd->rows+2,GTK_SHRINK,GTK_FILL,0,0); @@ -360,20 +343,24 @@ gui_filter_add_line(FilterViewerData* fvd) { return fvdl; } -void gui_filter_line_set_visible(FilterViewerDataLine *fvdl, gboolean v) { +/** + * @fn void gui_filter_line_set_visible(FilterViewerDataLine*,gboolean) + * + * Change visible state of current FilterViewerDataLine + * @param fvdl pointer to the current FilterViewerDataLine + * @param v TRUE: sets visible, FALSE: sets invisible + */ +void +gui_filter_line_set_visible(FilterViewerDataLine *fvdl, gboolean v) { fvdl->visible = v; if(v) { -// gtk_widget_show(fvdl->f_struct_box); -// gtk_widget_show(fvdl->f_subfield_box); gtk_widget_show(fvdl->f_not_op_box); gtk_widget_show(fvdl->f_field_box); gtk_widget_show(fvdl->f_math_op_box); gtk_widget_show(fvdl->f_value_field); gtk_widget_show(fvdl->f_logical_op_box); } else { -// gtk_widget_hide(fvdl->f_struct_box); -// gtk_widget_hide(fvdl->f_subfield_box); gtk_widget_hide(fvdl->f_not_op_box); gtk_widget_hide(fvdl->f_field_box); gtk_widget_hide(fvdl->f_math_op_box); @@ -383,10 +370,16 @@ void gui_filter_line_set_visible(FilterViewerDataLine *fvdl, gboolean v) { } -void gui_filter_line_reset(FilterViewerDataLine *fvdl) { +/** + * @fn void gui_filter_line_reset(FilterViewerDataLine*) + * + * Sets selections of all boxes in current FilterViewerDataLine + * to default value (0) + * @param fvdl pointer to current FilterViewerDataLine + */ +void +gui_filter_line_reset(FilterViewerDataLine *fvdl) { -// gtk_combo_box_set_active(GTK_COMBO_BOX(fvdl->f_struct_box),0); -// gtk_combo_box_set_active(GTK_COMBO_BOX(fvdl->f_subfield_box),0); gtk_combo_box_set_active(GTK_COMBO_BOX(fvdl->f_not_op_box),0); gtk_combo_box_set_active(GTK_COMBO_BOX(fvdl->f_field_box),0); gtk_combo_box_set_active(GTK_COMBO_BOX(fvdl->f_math_op_box),0); @@ -395,6 +388,8 @@ void gui_filter_line_reset(FilterViewerDataLine *fvdl) { } /** + * @fn void gui_filter_destructor(FilterViewerData*) + * * Destructor for the filter gui module * @param fvd The module structure */ @@ -418,6 +413,8 @@ gui_filter_destructor(FilterViewerData *fvd) } /** + * @fn gboolean filter_traceset_changed(void*,void*) + * * Hook function * @param hook_data The hook data * @param call_data The call data @@ -430,6 +427,8 @@ filter_traceset_changed(void * hook_data, void * call_data) { } /** + * @fn gboolean filter_viewer_data(void*,void*) + * * Hook function * @param hook_data The hook data * @param call_data The call data @@ -442,12 +441,14 @@ filter_viewer_data(void * hook_data, void * call_data) { } /** - * Filter Module's constructor hook + * @fn GtkWidget* h_guifilter(Tab*) + * + * Filter Module's constructor hook * - * This constructor is given as a parameter to the menuitem and toolbar button - * registration. It creates the list. - * @param tab A pointer to the parent window. - * @return The widget created. + * This constructor is given as a parameter to the menuitem and toolbar button + * registration. It creates the list. + * @param tab A pointer to the parent window. + * @return The widget created. */ GtkWidget * h_guifilter(Tab *tab) @@ -462,8 +463,10 @@ h_guifilter(Tab *tab) } /** - * This function initializes the Filter Viewer functionnality through the - * gtkTraceSet API. + * @fn static void init() + * + * This function initializes the Filter Viewer functionnality through the + * gtkTraceSet API. */ static void init() { @@ -476,10 +479,13 @@ static void init() { } /** + * @fn void filter_destroy_walk(gpointer,gpointer) + * * Initiate the destruction of the current gui module * on the GTK Interface */ -void filter_destroy_walk(gpointer data, gpointer user_data) +void +filter_destroy_walk(gpointer data, gpointer user_data) { FilterViewerData *fvd = (FilterViewerData*)data; @@ -490,10 +496,11 @@ void filter_destroy_walk(gpointer data, gpointer user_data) } /** - * plugin's destroy function + * @fn static void destroy() + * @brief plugin's destroy function * - * This function releases the memory reserved by the module and unregisters - * everything that has been registered in the gtkTraceSet API. + * This function releases the memory reserved by the module and unregisters + * everything that has been registered in the gtkTraceSet API. */ static void destroy() { @@ -502,26 +509,33 @@ static void destroy() { } /** + * @fn void callback_process_button(GtkWidget*,gpointer) + * * The Process Button callback function * @param widget The Button widget passed to the callback function * @param data Data sent along with the callback function */ -void callback_process_button(GtkWidget *widget, gpointer data) { +void +callback_process_button(GtkWidget *widget, gpointer data) { FilterViewerData *fvd = (FilterViewerData*)data; if(strlen(gtk_entry_get_text(GTK_ENTRY(fvd->f_expression_field))) !=0) { LttvFilter* filter = lttv_filter_new(); lttv_filter_append_expression(filter,gtk_entry_get_text(GTK_ENTRY(fvd->f_expression_field))); + SetFilter(fvd->tab,filter); } } /** + * @fn void callback_expression_field(GtkWidget*,gpointer) + * * The Add Button callback function * @param widget The Button widget passed to the callback function * @param data Data sent along with the callback function */ -void callback_expression_field(GtkWidget *widget, gpointer data) { +void +callback_expression_field(GtkWidget *widget, gpointer data) { FilterViewerData *fvd = (FilterViewerData*)data; @@ -534,11 +548,14 @@ void callback_expression_field(GtkWidget *widget, gpointer data) { /** + * @fn void callback_add_button(GtkWidget*,gpointer) + * * The Add Button callback function * @param widget The Button widget passed to the callback function * @param data Data sent along with the callback function */ -void callback_add_button(GtkWidget *widget, gpointer data) { +void +callback_add_button(GtkWidget *widget, gpointer data) { g_print("filter::callback_add_button()\n"); @@ -587,11 +604,14 @@ void callback_add_button(GtkWidget *widget, gpointer data) { } /** + * @fn void callback_logical_op_box(GtkWidget*,gpointer) + * * The logical op box callback function * @param widget The Button widget passed to the callback function * @param data Data sent along with the callback function */ -void callback_logical_op_box(GtkWidget *widget, gpointer data) { +void +callback_logical_op_box(GtkWidget *widget, gpointer data) { g_print("filter::callback_logical_op_box()\n");