ltt/branches/poly/lttv/modules/gui/lttvwindow/lttvwindow/lttvwindow.h

   1 /* This file is part of the Linux Trace Toolkit Graphic User Interface
   2  * Copyright (C) 2003-2004 Xiangxiu Yang, 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 This file is what every viewer plugin writer should refer to.
  21
  22
  23 Module Related API
  24
  25 A viewer plugin is, before anything, a plugin. As a dynamically loadable
  26 module, it thus has an init and a destroy function called whenever it is
  27 loaded/initialized and unloaded/destroyed. A graphical module depends on
  28 lttvwindow for construction of its viewer instances. In order to achieve
  29 this, it must register its constructor function to the main window along
  30 with button description or text menu entry description. A module keeps
  31 a list of every viewer that currently sits in memory so it can destroy
  32 them before the module gets unloaded/destroyed.
  33
  34 The contructor registration to the main windows adds button and menu
  35 entry to each main window, thus allowing instanciation of viewers.
  36
  37
  38 Main Window
  39
  40 The main window is a container that offers menus, buttons and a
  41 notebook. Some of those menus and buttons are part of the core of the
  42 main window, others are dynamically added and removed when modules are
  43 loaded/unloaded.
  44
  45 The notebook contains as much tabs as wanted. Each tab is linked with
  46 a set of traces (traceset). Each trace contains many tracefiles (one
  47 per cpu).  A trace corresponds to a kernel being traced. A traceset
  48 corresponds to many traces read together. The time span of a traceset
  49 goes from the earliest start of all the traces to the latest end of all
  50 the traces.
  51
  52 Inside each tab are added the viewers. When they interact with the main
  53 window through the lttvwindow API, they affect the other viewers located
  54 in the same tab as they are.
  55
  56 The insertion of many viewers in a tab permits a quick look at all the
  57 information wanted in a glance. The main window does merge the read
  58 requests from all the viewers in the same tab in a way that every viewer
  59 will get exactly the events it asked for, while the event reading loop
  60 and state update are shared. It improves performance of events delivery
  61 to the viewers.
  62
  63
  64
  65 Viewer Instance Related API
  66
  67 The lifetime of a viewer is as follows. The viewer constructor function
  68 is called each time an instance view is created (one subwindow of this
  69 viewer type is created by the user either by clicking on the menu item
  70 or the button corresponding to the viewer). Thereafter, the viewer gets
  71 hooks called for different purposes by the window containing it. These
  72 hooks are detailed below. It also has to deal with GTK Events. Finally,
  73 it can be destructed by having its top level widget unreferenced by the
  74 main window or by any GTK Event causing a "destroy-event" signal on the
  75 its top widget. Another possible way for it do be destroyed is if the
  76 module gets unloaded. The module unload function will have to emit a
  77 "destroy" signal on each top level widget of all instances of its viewers.
  78
  79
  80 Notices from Main Window
  81
  82 time_window : This is the time interval visible on the viewer's tab. Every
  83               viewer that cares about being synchronised by respect to the
  84               time with other viewers should register to this notification.
  85               They should redraw all or part of their display when this occurs.
  86
  87 traceset :    This notification is called whenever a trace is added/removed
  88               from the traceset. As it affects all the data displayed by the
  89               viewer, it sould redraw itself totally.
  90
  91 filter :      FIXME : describe..
  92
  93 current_time: Being able to zoom nearer a specific time or highlight a specific
  94               time on every viewer in synchronicity implies that the viewer
  95               has to shown a visual sign over the drawing or select an event
  96               when it receives this notice. It should also inform the main
  97               window with the appropriate report API function when a user
  98               selects a specific time as being the current time.
  99
 100 dividor :     This notice links the positions of the horizontal dividors
 101               between the graphic display zone of every viewer and their Y axis,
 102               typically showing processes, cpus, ...
 103
 104
 105 Reporting Changes to the Main Window
 106
 107 In most cases, the enclosing window knows about updates such as described
 108 in the Notification section higher. There are a few cases, however, where
 109 updates are caused by actions known by a view instance. For example,
 110 clicking in a view may update the current time; all viewers within
 111 the same window must be told about the new current time to change the
 112 currently highlighted time point. A viewer reports such events by calling
 113 lttvwindow_report_current_time on its lttvwindow.  The lttvwindow will
 114 consequently call current_time_notify for each of its contained viewers.
 115
 116
 117 Available report methods are :
 118
 119 lttvwindow_report_time_window : reports the new time window.
 120 lttvwindow_report_current_time : reports the new current time.
 121 lttvwindow_report_dividor : reports the new horizontal dividor's position.
 122 lttvwindow_report_filter : reports the new filter object
 123
 124
 125
 126 Requesting Events to Main Window
 127
 128 Events can be requested by passing a EventsRequest structure to the main
 129 window.  They will be delivered later when the next g_idle functions
 130 will be called.  Event delivery is done by calling the event hook for
 131 this event ID, or the main event hooks. A pointer to the EventsRequest
 132 structure is passed as hook_data to the event hooks of the viewers.
 133
 134 EventsRequest consists in
 135 - a pointer to the viewer specific data structure
 136 - a start timestamp or position
 137 - a stop_flag, ending the read process when set to TRUE
 138 - a end timestamp and/or position and/or number of events to read
 139 - hook lists to call for traceset/trace/tracefile begin and end, and for each
 140   event (event hooks and event_by_id hooks).
 141
 142 The main window will deliver events for every EventRequests it has
 143 pending through an algorithm that guarantee that all events requested,
 144 and only them, will be delivered to the viewer between the call of the
 145 tracefile_begin hooks and the call of the tracefile_end hooks.
 146
 147 If a viewer wants to stop the event request at a certain point inside the
 148 event hooks, it has to set the stop_flag to TRUE and return TRUE from the
 149 hook function. Then return value will stop the process traceset. Then,
 150 the main window will look for the stop_flag and remove the EventRequests
 151 from its lists, calling the process_traceset_end for this request (it
 152 removes hooks from the context and calls the after hooks).
 153
 154 It no stop_flag is risen, the end timestamp, end position or number
 155 of events to read has to be reached to determine the end of the
 156 request. Otherwise, the end of traceset does determine it.
 157
 158
 159 GTK Events
 160
 161 Events and Signals
 162
 163 GTK is quite different from the other graphical toolkits around
 164 there. The main difference resides in that there are many X Windows
 165 inside one GtkWindow, instead of just one. That means that X events are
 166 delivered by the glib main loop directly to the widget corresponding to
 167 the GdkWindow affected by the X event.
 168
 169 Event delivery to a widget emits a signal on that widget. Then, if a
 170 handler is connected to this widget's signal, it will be executed. There
 171 are default handlers for signals, connected at class instantiation
 172 time. There is also the possibility to connect other handlers to these
 173 signals, which is what should be done in most cases when a viewer needs
 174 to interact with X in any way.
 175
 176
 177
 178 Signal emission and propagation is described there :
 179
 180 http://www.gtk.org/tutorial/sec-signalemissionandpropagation.html
 181
 182 For further information on the GTK main loop (now a wrapper over glib main loop)
 183 see :
 184
 185 http://developer.gnome.org/doc/API/2.0/gtk/gtk-General.html
 186 http://developer.gnome.org/doc/API/2.0/glib/glib-The-Main-Event-Loop.html
 187
 188
 189 For documentation on event handling in GTK/GDK, see :
 190
 191 http://developer.gnome.org/doc/API/2.0/gdk/gdk-Events.html
 192 http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html
 193
 194
 195 Signals can be connected to handlers, emitted, propagated, blocked,
 196 stopped. See :
 197
 198 http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html
 199
 200
 201
 202
 203 The "expose_event"
 204
 205 Provides the exposed region in the GdkEventExpose structure.
 206
 207 There are two ways of dealing with exposures. The first one is to directly
 208 draw on the screen and the second one is to draw in a pixmap buffer,
 209 and then to update the screen when necessary.
 210
 211 In the first case, the expose event will be responsible for registering
 212 hooks to process_traceset and require time intervals to the main
 213 window. So, in this scenario, if a part of the screen is damaged, the
 214 trace has to be read to redraw the screen.
 215
 216 In the second case, with a pixmap buffer, the expose handler is only
 217 responsible of showing the pixmap buffer on the screen. If the pixmap
 218 buffer has never been filled with a drawing, the expose handler may ask
 219 for it to be filled.
 220
 221 The interest of using events request to the main window instead of reading
 222 the events directly from the trace comes from the fact that the main
 223 window does merge requests from the different viewers in the same tab so
 224 that the read loop and the state update is shared. As viewers will, in
 225 the common scenario, request the same events, only one pass through the
 226 trace that will call the right hooks for the right intervals will be done.
 227
 228 When the traceset read is over for a events request, the traceset_end
 229 hook is called. It has the responsibility of finishing the drawing if
 230 some parts still need to be drawn and to show it on the screen (if the
 231 viewer uses a pixmap buffer).
 232
 233 It can add dotted lines and such visual effects to enhance the user's
 234 experience.
 235
 236
 237 FIXME : explain other important events
 238
 239 */
 240
 241
 242 #ifndef LTTVWINDOW_H
 243 #define LTTVWINDOW_H
 244
 245 /*! \file lttvwindow.h
 246  * \brief API used by the graphical viewers to interact with their top window.
 247  *
 248  * Main window (lttvwindow module) is the place to contain and display viewers.
 249  * Viewers (lttv plugins) interact with main window through this API.
 250  * This header file should be included in each graphic module.
 251  *
 252  */
 253
 254 #include <gtk/gtk.h>
 255 #include <ltt/ltt.h>
 256 #include <ltt/time.h>
 257 #include <lttv/hook.h>
 258 #include <lttv/tracecontext.h>
 259 #include <lttv/stats.h>
 260 #include <lttv/filter.h>
 261 #include <lttvwindow/mainwindow.h>
 262
 263 /* Module Related API */
 264
 265 /* GQuark containing constructors of viewers in global attributes */
 266 extern GQuark LTTV_VIEWER_CONSTRUCTORS;
 267
 268 /* constructor a the viewer */
 269 typedef GtkWidget* (*lttvwindow_viewer_constructor)(Tab *tab);
 270
 271
 272 /**
 273  * Function to register a view constructor so that main window can generate
 274  * a menu item and a toolbar item for the viewer in order to generate a new
 275  * instance easily. A menu entry and toolbar item will be added to each main
 276  * window.
 277  *
 278  * It should be called by init function of the module.
 279  *
 280  * @param name name of the viewer : mainly used as tag for constructor
 281  * @param menu_path path of the menu item. NULL : no menu entry.
 282  * @param menu_text text of the menu item.
 283  * @param pixmap Image shown on the toolbar item. NULL : no button.
 284  * @param tooltip tooltip of the toolbar item.
 285  * @param view_constructor constructor of the viewer.
 286  */
 287
 288 void lttvwindow_register_constructor
 289                             (char * name,
 290                              char *  menu_path,
 291                              char *  menu_text,
 292                              char ** pixmap,
 293                              char *  tooltip,
 294                              lttvwindow_viewer_constructor view_constructor);
 295
 296
 297 /**
 298  * Function to unregister the viewer's constructor, release the space
 299  * occupied by menu_path, menu_text, pixmap, tooltip and constructor of the
 300  * viewer.
 301  *
 302  * It will be called when a module is unloaded.
 303  *
 304  * @param view_constructor constructor of the viewer.
 305  */
 306
 307 void lttvwindow_unregister_constructor
 308                             (lttvwindow_viewer_constructor view_constructor);
 309
 310
 311
 312
 313 /* Viewer Instance Related API */
 314
 315 /**
 316  * Structure used as hook_data for the time_window_notify hook.
 317  */
 318 typedef struct _TimeWindowNotifyData {
 319   TimeWindow *new_time_window;
 320   TimeWindow *old_time_window;
 321 } TimeWindowNotifyData;
 322
 323
 324 /**
 325  * Function to register a hook function that will be called by the main window
 326  * when the time interval needs to be updated.
 327  *
 328  * This register function is typically called by the constructor of the viewer.
 329  *
 330  * @param tab the tab the viewer belongs to.
 331  * @param hook hook that sould be called by the main window when the time
 332  *             interval changes. This hook function takes a
 333  *             TimeWindowNotifyData* as call_data.
 334  * @param hook_data hook data associated with the hook function. It will
 335  *                  be typically a pointer to the viewer's data structure.
 336  */
 337
 338 void lttvwindow_register_time_window_notify(Tab *tab,
 339                                             LttvHook    hook,
 340                                             gpointer    hook_data);
 341
 342
 343 /**
 344  * Function to unregister the time_window notification hook.
 345  *
 346  * This unregister function is typically called by the destructor of the viewer.
 347  *
 348  * @param tab the tab the viewer belongs to.
 349  * @param hook hook that sould be called by the main window when the time
 350  *             interval changes. This hook function takes a
 351  *             TimeWindowNotifyData* as call_data.
 352  * @param hook_data hook data associated with the hook function. It will
 353  *                  be typically a pointer to the viewer's data structure.
 354  */
 355
 356 void lttvwindow_unregister_time_window_notify(Tab *tab,
 357                                               LttvHook    hook,
 358                                               gpointer    hook_data);
 359
 360
 361 /**
 362  * Function to register a hook function that will be called by the main window
 363  * when the traceset is changed. That means that the viewer must redraw
 364  * itself completely or check if it's affected by the particular change to the
 365  * traceset.
 366  *
 367  * This register function is typically called by the constructor of the viewer.
 368  *
 369  * @param tab the tab the viewer belongs to.
 370  * @param hook hook that should be called whenever a change to the traceset
 371  *             occurs. The call_data of this hook is a NULL pointer.
 372  * @param hook_data hook data associated with the hook function. It will
 373  *                  be typically a pointer to the viewer's data structure.
 374  */
 375
 376 void lttvwindow_register_traceset_notify(Tab *tab,
 377                                          LttvHook    hook,
 378                                          gpointer    hook_data);
 379
 380
 381 /**
 382  * Function to unregister the traceset_notify hook.
 383  *
 384  * @param tab the tab the viewer belongs to.
 385  * @param hook hook that should be called whenever a change to the traceset
 386  *             occurs. The call_data of this hook is a NULL pointer.
 387  * @param hook_data hook data associated with the hook function. It will
 388  *                  be typically a pointer to the viewer's data structure.
 389  */
 390
 391 void lttvwindow_unregister_traceset_notify(Tab *tab,
 392                                            LttvHook    hook,
 393                                            gpointer    hook_data);
 394
 395
 396 /**
 397  * Function to register a hook function for a viewer be completely redrawn.
 398  *
 399  * @param tab viewer's tab
 400  * @param hook hook function of the viewer.
 401  * @param hook_data hook data associated with the hook function.
 402  */
 403
 404 void lttvwindow_register_redraw_notify(Tab *tab,
 405     LttvHook hook, gpointer hook_data);
 406
 407 /**
 408  * Function to unregister a hook function for a viewer be completely redrawn.
 409  *
 410  * @param tab viewer's tab
 411  * @param hook hook function of the viewer.
 412  * @param hook_data hook data associated with the hook function.
 413  */
 414
 415 void lttvwindow_unregister_redraw_notify(Tab *tab,
 416               LttvHook hook, gpointer hook_data);
 417
 418
 419 /**
 420  * Function to register a hook function for a viewer to re-do the events
 421  * requests for the needed interval.
 422  *
 423  * This action is typically done after a "stop".
 424  *
 425  * The typical hook will remove all current requests for the viewer
 426  * and make requests for missing information.
 427  *
 428  * @param tab viewer's tab
 429  * @param hook hook function of the viewer.
 430  * @param hook_data hook data associated with the hook function.
 431  */
 432
 433 void lttvwindow_register_continue_notify(Tab *tab,
 434     LttvHook hook, gpointer hook_data);
 435
 436
 437 /**
 438  * Function to unregister a hook function for a viewer to re-do the events
 439  * requests for the needed interval.
 440  *
 441  * @param tab viewer's tab
 442  * @param hook hook function of the viewer.
 443  * @param hook_data hook data associated with the hook function.
 444  */
 445
 446 void lttvwindow_unregister_continue_notify(Tab *tab,
 447               LttvHook hook, gpointer hook_data);
 448
 449
 450 /**
 451  * Function to register a hook function for a viewer to set/update its
 452  * filter.
 453  *
 454  * FIXME : Add information about what a filter is as seen from a viewer and how
 455  * to use it.
 456  *
 457  * This register function is typically called by the constructor of the viewer.
 458  *
 459  * @param tab the tab the viewer belongs to.
 460  * @param hook hook function called by the main window when a filter change
 461  *             occurs.
 462  * @param hook_data hook data associated with the hook function. It will
 463  *                  be typically a pointer to the viewer's data structure.
 464  */
 465
 466 void lttvwindow_register_filter_notify(Tab *tab,
 467                                        LttvHook    hook,
 468                                        gpointer    hook_data);
 469
 470
 471 /**
 472  * Function to unregister a viewer's hook function which is used to
 473  * set/update the filter of the viewer.
 474  *
 475  * This unregistration is called by the destructor of the viewer.
 476  *
 477  * @param tab the tab the viewer belongs to.
 478  * @param hook hook function called by the main window when a filter change
 479  *             occurs.
 480  * @param hook_data hook data associated with the hook function. It will
 481  *                  be typically a pointer to the viewer's data structure.
 482  */
 483
 484 void lttvwindow_unregister_filter_notify(Tab *tab,
 485                                          LttvHook     hook,
 486                                          gpointer     hook_data);
 487
 488
 489 /**
 490  * Function to get the current filter of the main window : useful at viewer
 491  * instanciation.
 492  *
 493  * @param tab the tab the viewer belongs to.
 494  *
 495  * returns : the current filter.
 496  */
 497
 498
 499 LttvFilter *lttvwindow_get_filter(Tab *tab);
 500
 501 /**
 502  * Function to register a hook function for a viewer to set/update its
 503  * current time.
 504  *
 505  * @param tab the tab the viewer belongs to.
 506  * @param hook hook function of the viewer that updates the current time. The
 507  *             call_data is a LttTime* representing the new current time.
 508  * @param hook_data hook data associated with the hook function. It will
 509  *                  be typically a pointer to the viewer's data structure.
 510  */
 511
 512 void lttvwindow_register_current_time_notify(Tab *tab,
 513                                              LttvHook    hook,
 514                                              gpointer    hook_data);
 515
 516
 517 /**
 518  * Function to unregister a viewer's hook function which is used to
 519  * set/update the current time of the viewer.
 520  * @param tab the tab the viewer belongs to.
 521  * @param hook hook function of the viewer that updates the current time. The
 522  *             call_data is a LttTime* representing the new current time.
 523  * @param hook_data hook data associated with the hook function. It will
 524  *                  be typically a pointer to the viewer's data structure.
 525  */
 526
 527 void lttvwindow_unregister_current_time_notify(Tab *tab,
 528                                                LttvHook    hook,
 529                                                gpointer    hook_data);
 530
 531 /**
 532  * Function to register a hook function for a viewer to set/update its
 533  * current position.
 534  *
 535  * @param tab the tab the viewer belongs to.
 536  * @param hook hook function of the viewer that updates the current time. The
 537  *             call_data is a LttTime* representing the new current time.
 538  * @param hook_data hook data associated with the hook function. It will
 539  *                  be typically a pointer to the viewer's data structure.
 540  */
 541
 542 void lttvwindow_register_current_position_notify(Tab *tab,
 543                                              LttvHook    hook,
 544                                              gpointer    hook_data);
 545
 546
 547 /**
 548  * Function to unregister a viewer's hook function which is used to
 549  * set/update the current position of the viewer.
 550  * @param tab the tab the viewer belongs to.
 551  * @param hook hook function of the viewer that updates the current time. The
 552  *             call_data is a LttTime* representing the new current time.
 553  * @param hook_data hook data associated with the hook function. It will
 554  *                  be typically a pointer to the viewer's data structure.
 555  */
 556
 557 void lttvwindow_unregister_current_position_notify(Tab *tab,
 558                                                LttvHook    hook,
 559                                                gpointer    hook_data);
 560
 561
 562
 563 /**
 564  * Function to register a hook function for a viewer to set/update the
 565  * dividor of the hpane. It provides a way to make the horizontal
 566  * dividors of all the viewers linked together.
 567  *
 568  * @param tab the tab the viewer belongs to.
 569  * @param hook hook function of the viewer that will be called whenever a
 570  *             dividor changes in another viewer. The call_data of this hook
 571  *             is a gint*. The value of the integer is the new position of the
 572  *             hpane dividor.
 573  * @param hook_data hook data associated with the hook function. It will
 574  *                  be typically a pointer to the viewer's data structure.
 575  */
 576
 577 void lttvwindow_register_dividor(Tab *tab,
 578                                  LttvHook    hook,
 579                                  gpointer    hook_data);
 580
 581
 582 /**
 583  * Function to unregister a viewer's hook function which is used to
 584  * set/update hpane's dividor of the viewer.
 585  *
 586  * @param tab the tab the viewer belongs to.
 587  * @param hook hook function of the viewer that will be called whenever a
 588  *             dividor changes in another viewer. The call_data of this hook
 589  *             is a gint*. The value of the integer is the new position of the
 590  *             hpane dividor.
 591  * @param hook_data hook data associated with the hook function. It will
 592  *                  be typically a pointer to the viewer's data structure.
 593  */
 594
 595 void lttvwindow_unregister_dividor(Tab *tab,
 596                                    LttvHook    hook,
 597                                    gpointer    hook_data);
 598
 599
 600
 601 /**
 602  * Function to set the time interval of the current tab.a
 603  *
 604  * @param tab the tab the viewer belongs to.
 605  * @param time_interval new time window.
 606  */
 607
 608 void lttvwindow_report_time_window(Tab *tab,
 609                                    TimeWindow time_window);
 610
 611 /**
 612  * Function to set the current time of the current tab.
 613  * It will be called by a viewer's signal handle associated with
 614  * the button-release-event signal
 615  * @param tab the tab the viewer belongs to.
 616  * @param time current time.
 617  */
 618
 619 void lttvwindow_report_current_time(Tab *tab,
 620                                     LttTime time);
 621
 622
 623 /**
 624  * Function to set the current event of the current tab.
 625  * It will be called by a viewer's signal handle associated with
 626  * the button-release-event signal
 627  * @param tab the tab the viewer belongs to.
 628  * @param pos the current position.
 629  */
 630
 631 void lttvwindow_report_current_position(Tab *tab,
 632                                         LttvTracesetContextPosition *pos);
 633
 634 /**
 635  * Function to set the position of the hpane's dividor (viewer).
 636  * It will typically be called by a viewer's signal handle associated
 637  * with the motion_notify_event event/signal.
 638  *
 639  * @param tab the tab the viewer belongs to.
 640  * @param position position of the hpane's dividor.
 641  */
 642
 643 void lttvwindow_report_dividor(Tab *tab, gint position);
 644
 645
 646 /* Structure sent to the events request hook */
 647                                                 /* Value considered as empty*/
 648 typedef struct _EventsRequest {
 649   gpointer                     owner;           /* Owner of the request     */
 650   gpointer                     viewer_data;     /* Unset : NULL             */
 651   gboolean                     servicing;       /* service in progress: TRUE*/
 652   LttTime                      start_time;      /* Unset : ltt_time_infinite*/
 653   LttvTracesetContextPosition *start_position;  /* Unset : NULL             */
 654   gboolean                     stop_flag;       /* Continue:TRUE Stop:FALSE */
 655   LttTime                      end_time;        /* Unset : ltt_time_infinite*/
 656   guint                        num_events;      /* Unset : G_MAXUINT        */
 657   LttvTracesetContextPosition *end_position;    /* Unset : NULL             */
 658   gint                         trace;           /* unset : -1               */
 659   GArray                      *hooks;           /* Unset : NULL             */
 660   LttvHooks                   *before_chunk_traceset; /* Unset : NULL       */
 661   LttvHooks                   *before_chunk_trace;    /* Unset : NULL       */
 662   LttvHooks                   *before_chunk_tracefile;/* Unset : NULL       */
 663   LttvHooks                   *event;           /* Unset : NULL             */
 664   LttvHooksById               *event_by_id;     /* Unset : NULL             */
 665   LttvHooks                   *after_chunk_tracefile; /* Unset : NULL       */
 666   LttvHooks                   *after_chunk_trace;     /* Unset : NULL       */
 667   LttvHooks                   *after_chunk_traceset;  /* Unset : NULL       */
 668   LttvHooks                   *before_request;  /* Unset : NULL             */
 669   LttvHooks                   *after_request;   /* Unset : NULL             */
 670 } EventsRequest;
 671
 672 /* Maximum number of events to proceed at once in a chunk */
 673 #define CHUNK_NUM_EVENTS 6000
 674
 675
 676 /**
 677  * Function to request data in a specific time interval to the main window. The
 678  * event request servicing is differed until the glib idle functions are
 679  * called.
 680  *
 681  * The viewer has to provide hooks that should be associated with the event
 682  * request.
 683  *
 684  * Either start time or start position must be defined in a EventRequest
 685  * structure for it to be valid.
 686  *
 687  * end_time, end_position and num_events can all be defined. The first one
 688  * to occur will be used as end criterion.
 689  *
 690  * The events_request memory will be managed by the main window once its
 691  * pointer is passed by this function.
 692  *
 693  * @param tab the tab the viewer belongs to.
 694  * @param events_requested Details about the event request.
 695  */
 696
 697 void lttvwindow_events_request(Tab                  *tab,
 698                                EventsRequest  *events_request);
 699
 700 /**
 701  * Function to remove data requests related to a viewer.
 702  *
 703  * The existing requests's viewer gpointer is compared to the pointer
 704  * given in argument to establish which data request should be removed.
 705  *
 706  * @param tab the tab the viewer belongs to.
 707  * @param viewer a pointer to the viewer data structure
 708  */
 709
 710 void lttvwindow_events_request_remove_all(Tab            *tab,
 711                                           gconstpointer   viewer);
 712
 713
 714 /**
 715  * Function to get the current time interval shown on the current tab.
 716  * It will be called by a viewer's hook function to update the
 717  * shown time interval of the viewer and also be called by the constructor
 718  * of the viewer.
 719  * @param tab viewer's tab
 720  * @return time window.
 721  */
 722
 723 TimeWindow lttvwindow_get_time_window(Tab *tab);
 724
 725
 726 /**
 727  * Function to get the current time of the current tab.
 728  *
 729  * @param tab the tab the viewer belongs to.
 730  * @return the current tab's current time.
 731  */
 732
 733 LttTime lttvwindow_get_current_time(Tab *tab);
 734
 735
 736 /**
 737  * Function to get the filter of the current tab.
 738  * @param main_win, the main window the viewer belongs to.
 739  * @param filter, a pointer to a filter.
 740  */
 741
 742 //LttvFilter *lttvwindow_get_filter(Tab *tab);
 743
 744 /**
 745  * Function to set the filter of the current tab.
 746  * It should be called by the filter GUI to tell the
 747  * main window to update the filter tab's lttv_filter.
 748  *
 749  * Notice : the lttv_filter object will be owned by the
 750  *          main window after the return of this function.
 751  *          Do NOT desallocate it.
 752  *
 753  * @param main_win, the main window the viewer belongs to.
 754  * @param filter, a pointer to a filter.
 755  */
 756
 757 void lttvwindow_report_filter(Tab *tab, LttvFilter *filter);
 758
 759
 760
 761 /**
 762  * Function to get the stats of the traceset
 763  * It must be non const so the viewer can modify it.
 764  * FIXME : a set/get pair of functions would be more appropriate here.
 765  * @param tab the tab the viewer belongs to.
 766  * @return A pointer to Traceset statistics.
 767  */
 768
 769 LttvTracesetStats* lttvwindow_get_traceset_stats(Tab *tab);
 770
 771 /**
 772  * Function to get the context of the traceset
 773  * It must be non const so the viewer can add and remove hooks from it.
 774  * @param tab the tab the viewer belongs to.
 775  * @return Context of the current tab.
 776  */
 777
 778
 779 LttvTracesetContext* lttvwindow_get_traceset_context(Tab *tab);
 780
 781
 782 /* set_time_window
 783  *
 784  * It updates the time window of the tab, then calls the updatetimewindow
 785  * hooks of each viewer.
 786  *
 787  * This is called whenever the scrollbar value changes.
 788  *
 789  * This is mostly an internal function.
 790  */
 791
 792 void set_time_window(Tab *tab, const TimeWindow *time_window);
 793
 794
 795 /* set_current_time
 796  *
 797  * It updates the current time of the tab, then calls the updatetimewindow
 798  * hooks of each viewer.
 799  *
 800  * This is called whenever the current time value changes.
 801  *
 802  * This is mostly an internal function.
 803  */
 804
 805 void set_current_time(Tab *tab, const LttTime *current_time);
 806
 807 void events_request_free(EventsRequest *events_request);
 808
 809 GtkWidget *main_window_get_widget(Tab *tab);
 810
 811 #endif //LTTVWINDOW_H