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 #include <glib.h>
  41 #include <lttv/lttv.h>
  42 #include <lttv/module.h>
  43 #include <lttvwindow/lttvwindow.h>
  44
  45 #include "cfv.h"
  46 #include "eventhooks.h"
  47
  48 #include "hGuiControlFlowInsert.xpm"
  49
  50 /** Array containing instanced objects. Used when module is unloaded */
  51 GSList *g_control_flow_data_list = NULL ;
  52
  53
  54 /*****************************************************************************
  55  *                 Functions for module loading/unloading                    *
  56  *****************************************************************************/
  57 /**
  58  * plugin's init function
  59  *
  60  * This function initializes the Control Flow Viewer functionnality through the
  61  * gtkTraceSet API.
  62  */
  63 static void init() {
  64
  65   g_info("GUI ControlFlow Viewer init()");
  66
  67   /* Register the toolbar insert button and menu entry*/
  68   lttvwindow_register_constructor("guicontrolflow",
  69                                   "/",
  70                                   "Insert Control Flow Viewer",
  71                                   hGuiControlFlowInsert_xpm,
  72                                   "Insert Control Flow Viewer",
  73                                   h_guicontrolflow);
  74 }
  75
  76 void destroy_walk(gpointer data, gpointer user_data)
  77 {
  78   g_info("Walk destroy GUI Control Flow Viewer");
  79   guicontrolflow_destructor_full((ControlFlowData*)data);
  80 }
  81
  82
  83
  84 /**
  85  * plugin's destroy function
  86  *
  87  * This function releases the memory reserved by the module and unregisters
  88  * everything that has been registered in the gtkTraceSet API.
  89  */
  90 static void destroy() {
  91   g_info("GUI Control Flow Viewer destroy()");
  92
  93   g_slist_foreach(g_control_flow_data_list, destroy_walk, NULL );
  94
  95   g_slist_free(g_control_flow_data_list);
  96
  97   /* Unregister the toolbar insert button and menu entry */
  98   lttvwindow_unregister_constructor(h_guicontrolflow);
  99 }
 100
 101
 102 LTTV_MODULE("guicontrolflow", "Control flow viewer", \
 103     "Graphical module to view processes state and control flow", \
 104     init, destroy, "lttvwindow")