ltt/branches/poly/lttv/modules/gui/controlflow/module.c

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2003-2004 Mathieu Desnoyers
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License Version 2 as
   6  * published by the Free Software Foundation;
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16  * MA 02111-1307, USA.
  17  */
  18
  19
  20
  21 /*! \defgroup guiEvents libguiControlFlow: The GUI ControlFlow display plugin */
  22 /*\@{*/
  23
  24 /*! \file guiControlFlow.c
  25  * \brief Graphical plugin for showing control flow of a trace.
  26  *
  27  * This plugin adds a Control Flow Viewer functionnality to Linux TraceToolkit
  28  * GUI when this plugin is loaded. The init and destroy functions add the
  29  * viewer's insertion menu item and toolbar icon by calling viewer.h's
  30  * API functions. Then, when a viewer's object is created, the constructor
  31  * creates ans register through API functions what is needed to interact
  32  * with the TraceSet window.
  33  *
  34  * This plugin uses the gdk library to draw the events and gtk to interact
  35  * with the user.
  36  *
  37  * Author : Mathieu Desnoyers, June 2003
  38  */
  39
  40 #ifdef HAVE_CONFIG_H
  41 #include <config.h>
  42 #endif
  43
  44 #include <glib.h>
  45 #include <lttv/lttv.h>
  46 #include <lttv/module.h>
  47 #include <lttvwindow/lttvwindow.h>
  48
  49 #include "cfv.h"
  50 #include "eventhooks.h"
  51
  52 #include "hGuiControlFlowInsert.xpm"
  53
  54 /** Array containing instanced objects. Used when module is unloaded */
  55 GSList *g_control_flow_data_list = NULL ;
  56
  57
  58 /*****************************************************************************
  59  *                 Functions for module loading/unloading                    *
  60  *****************************************************************************/
  61 /**
  62  * plugin's init function
  63  *
  64  * This function initializes the Control Flow Viewer functionnality through the
  65  * gtkTraceSet API.
  66  */
  67 static void init() {
  68
  69   g_info("GUI ControlFlow Viewer init()");
  70
  71   /* Register the toolbar insert button and menu entry*/
  72   lttvwindow_register_constructor("guicontrolflow",
  73                                   "/",
  74                                   "Insert Control Flow Viewer",
  75                                   hGuiControlFlowInsert_xpm,
  76                                   "Insert Control Flow Viewer",
  77                                   h_guicontrolflow);
  78 }
  79
  80 void destroy_walk(gpointer data, gpointer user_data)
  81 {
  82   g_info("Walk destroy GUI Control Flow Viewer");
  83   guicontrolflow_destructor_full((ControlFlowData*)data);
  84 }
  85
  86
  87
  88 /**
  89  * plugin's destroy function
  90  *
  91  * This function releases the memory reserved by the module and unregisters
  92  * everything that has been registered in the gtkTraceSet API.
  93  */
  94 static void destroy() {
  95   g_info("GUI Control Flow Viewer destroy()");
  96
  97   g_slist_foreach(g_control_flow_data_list, destroy_walk, NULL );
  98
  99   g_slist_free(g_control_flow_data_list);
 100
 101   /* Unregister the toolbar insert button and menu entry */
 102   lttvwindow_unregister_constructor(h_guicontrolflow);
 103 }
 104
 105
 106 LTTV_MODULE("guicontrolflow", "Control flow viewer", \
 107     "Graphical module to view processes state and control flow", \
 108     init, destroy, "lttvwindow")