501e4e70 |
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 | |
2d262115 |
25 | A viewer plugin is, before anything, a plugin. As a dynamically loadable |
501e4e70 |
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 |
2d262115 |
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. |
501e4e70 |
33 | |
2d262115 |
34 | The contructor registration to the main windows adds button and menu |
35 | entry to each main window, thus allowing instanciation of viewers. |
501e4e70 |
36 | |
37 | |
38 | Main Window |
39 | |
2d262115 |
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. |
501e4e70 |
44 | |
2d262115 |
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. |
501e4e70 |
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 |
2d262115 |
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. |
501e4e70 |
62 | |
63 | |
64 | |
65 | Viewer Instance Related API |
66 | |
2d262115 |
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. |
501e4e70 |
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 | |
501e4e70 |
105 | Reporting Changes to the Main Window |
106 | |
2d262115 |
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. |
501e4e70 |
115 | |
116 | |
117 | Available report methods are : |
118 | |
501e4e70 |
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_focus : One on the widgets in the viewer has the keyboard's |
123 | focus from GTK. |
124 | |
125 | |
126 | |
127 | Requesting Events to Main Window |
128 | |
2d262115 |
129 | Events can be requested by passing a EventsRequest structure to the main |
130 | window. They will be delivered later when the next g_idle functions |
131 | will be called. Event delivery is done by calling the event hook for |
132 | this event ID, or the main event hooks. A pointer to the EventsRequest |
133 | structure is passed as hook_data to the event hooks of the viewers. |
501e4e70 |
134 | |
135 | EventsRequest consists in |
136 | - a pointer to the viewer specific data structure |
137 | - a start timestamp or position |
138 | - a stop_flag, ending the read process when set to TRUE |
139 | - a end timestamp and/or position and/or number of events to read |
140 | - hook lists to call for traceset/trace/tracefile begin and end, and for each |
141 | event (event hooks and event_by_id hooks). |
142 | |
2d262115 |
143 | The main window will deliver events for every EventRequests it has |
144 | pending through an algorithm that guarantee that all events requested, |
145 | and only them, will be delivered to the viewer between the call of the |
146 | tracefile_begin hooks and the call of the tracefile_end hooks. |
501e4e70 |
147 | |
2d262115 |
148 | If a viewer wants to stop the event request at a certain point inside the |
149 | event hooks, it has to set the stop_flag to TRUE and return TRUE from the |
150 | hook function. Then return value will stop the process traceset. Then, |
151 | the main window will look for the stop_flag and remove the EventRequests |
152 | from its lists, calling the process_traceset_end for this request (it |
153 | removes hooks from the context and calls the after hooks). |
501e4e70 |
154 | |
9232f6fd |
155 | It no stop_flag is risen, the end timestamp, end position or number |
2d262115 |
156 | of events to read has to be reached to determine the end of the |
157 | request. Otherwise, the end of traceset does determine it. |
501e4e70 |
158 | |
159 | |
160 | GTK Events |
161 | |
162 | Events and Signals |
163 | |
2d262115 |
164 | GTK is quite different from the other graphical toolkits around |
165 | there. The main difference resides in that there are many X Windows |
166 | inside one GtkWindow, instead of just one. That means that X events are |
167 | delivered by the glib main loop directly to the widget corresponding to |
168 | the GdkWindow affected by the X event. |
501e4e70 |
169 | |
2d262115 |
170 | Event delivery to a widget emits a signal on that widget. Then, if a |
171 | handler is connected to this widget's signal, it will be executed. There |
172 | are default handlers for signals, connected at class instantiation |
173 | time. There is also the possibility to connect other handlers to these |
174 | signals, which is what should be done in most cases when a viewer needs |
175 | to interact with X in any way. |
501e4e70 |
176 | |
177 | |
178 | |
179 | Signal emission and propagation is described there : |
180 | |
181 | http://www.gtk.org/tutorial/sec-signalemissionandpropagation.html |
182 | |
183 | For further information on the GTK main loop (now a wrapper over glib main loop) |
184 | see : |
185 | |
186 | http://developer.gnome.org/doc/API/2.0/gtk/gtk-General.html |
187 | http://developer.gnome.org/doc/API/2.0/glib/glib-The-Main-Event-Loop.html |
188 | |
189 | |
190 | For documentation on event handling in GTK/GDK, see : |
191 | |
192 | http://developer.gnome.org/doc/API/2.0/gdk/gdk-Events.html |
193 | http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html |
194 | |
195 | |
196 | Signals can be connected to handlers, emitted, propagated, blocked, |
197 | stopped. See : |
198 | |
199 | http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html |
200 | |
201 | |
202 | |
203 | |
204 | The "expose_event" |
205 | |
206 | Provides the exposed region in the GdkEventExpose structure. |
207 | |
2d262115 |
208 | There are two ways of dealing with exposures. The first one is to directly |
209 | draw on the screen and the second one is to draw in a pixmap buffer, |
210 | and then to update the screen when necessary. |
501e4e70 |
211 | |
2d262115 |
212 | In the first case, the expose event will be responsible for registering |
213 | hooks to process_traceset and require time intervals to the main |
214 | window. So, in this scenario, if a part of the screen is damaged, the |
215 | trace has to be read to redraw the screen. |
501e4e70 |
216 | |
2d262115 |
217 | In the second case, with a pixmap buffer, the expose handler is only |
218 | responsible of showing the pixmap buffer on the screen. If the pixmap |
219 | buffer has never been filled with a drawing, the expose handler may ask |
220 | for it to be filled. |
501e4e70 |
221 | |
2d262115 |
222 | The interest of using events request to the main window instead of reading |
223 | the events directly from the trace comes from the fact that the main |
224 | window does merge requests from the different viewers in the same tab so |
225 | that the read loop and the state update is shared. As viewers will, in |
226 | the common scenario, request the same events, only one pass through the |
227 | trace that will call the right hooks for the right intervals will be done. |
501e4e70 |
228 | |
2d262115 |
229 | When the traceset read is over for a events request, the traceset_end |
230 | hook is called. It has the responsibility of finishing the drawing if |
231 | some parts still need to be drawn and to show it on the screen (if the |
232 | viewer uses a pixmap buffer). |
501e4e70 |
233 | |
234 | It can add dotted lines and such visual effects to enhance the user's |
235 | experience. |
236 | |
237 | |
238 | FIXME : explain other important events |
239 | |
240 | */ |
241 | |
242 | |
243 | #ifndef VIEWER_H |
244 | #define VIEWER_H |
245 | |
246 | /*! \file lttvwindow.h |
247 | * \brief API used by the graphical viewers to interact with their top window. |
248 | * |
249 | * Main window (lttvwindow module) is the place to contain and display viewers. |
250 | * Viewers (lttv plugins) interact with main window through this API. |
251 | * This header file should be included in each graphic module. |
252 | * |
253 | */ |
254 | |
255 | #include <gtk/gtk.h> |
256 | #include <ltt/ltt.h> |
257 | #include <ltt/time.h> |
258 | #include <lttv/hook.h> |
259 | #include <lttv/tracecontext.h> |
260 | #include <lttv/stats.h> |
2d262115 |
261 | #include <lttvwindow/mainwindow.h> |
262 | #include <lttvwindow/lttvfilter.h> |
501e4e70 |
263 | //FIXME (not ready yet) #include <lttv/filter.h> |
264 | |
501e4e70 |
265 | /* Module Related API */ |
266 | |
267 | |
268 | /* constructor a the viewer */ |
269 | //FIXME explain LttvTracesetSelector and key |
270 | typedef GtkWidget * (*lttvwindow_viewer_constructor) |
271 | (Tab *tab, LttvTracesetSelector * s, char *key); |
272 | |
273 | |
274 | /** |
275 | * Function to register a view constructor so that main window can generate |
276 | * a menu item and a toolbar item for the viewer in order to generate a new |
277 | * instance easily. A menu entry and toolbar item will be added to each main |
278 | * window. |
279 | * |
280 | * It should be called by init function of the module. |
281 | * |
282 | * @param menu_path path of the menu item. NULL : no menu entry. |
283 | * @param menu_text text of the menu item. |
284 | * @param pixmap Image shown on the toolbar item. NULL : no button. |
285 | * @param tooltip tooltip of the toolbar item. |
286 | * @param view_constructor constructor of the viewer. |
287 | */ |
288 | |
289 | void lttvwindow_register_constructor |
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 | |
9878c8a4 |
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 | |
501e4e70 |
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 register a hook function for a viewer to set/update its |
491 | * current time. |
492 | * |
493 | * @param tab the tab the viewer belongs to. |
494 | * @param hook hook function of the viewer that updates the current time. The |
495 | * call_data is a LttTime* representing the new current time. |
496 | * @param hook_data hook data associated with the hook function. It will |
497 | * be typically a pointer to the viewer's data structure. |
498 | */ |
499 | |
500 | void lttvwindow_register_current_time_notify(Tab *tab, |
501 | LttvHook hook, |
502 | gpointer hook_data); |
503 | |
504 | |
505 | /** |
506 | * Function to unregister a viewer's hook function which is used to |
507 | * set/update the current time of the viewer. |
508 | * @param tab the tab the viewer belongs to. |
509 | * @param hook hook function of the viewer that updates the current time. The |
510 | * call_data is a LttTime* representing the new current time. |
511 | * @param hook_data hook data associated with the hook function. It will |
512 | * be typically a pointer to the viewer's data structure. |
513 | */ |
514 | |
515 | void lttvwindow_unregister_current_time_notify(Tab *tab, |
516 | LttvHook hook, |
517 | gpointer hook_data); |
518 | |
519 | |
520 | /** |
521 | * Function to register a hook function for a viewer to set/update the |
522 | * dividor of the hpane. It provides a way to make the horizontal |
523 | * dividors of all the viewers linked together. |
524 | * |
525 | * @param tab the tab the viewer belongs to. |
526 | * @param hook hook function of the viewer that will be called whenever a |
527 | * dividor changes in another viewer. The call_data of this hook |
528 | * is a gint*. The value of the integer is the new position of the |
529 | * hpane dividor. |
530 | * @param hook_data hook data associated with the hook function. It will |
531 | * be typically a pointer to the viewer's data structure. |
532 | */ |
533 | |
534 | void lttvwindow_register_dividor(Tab *tab, |
535 | LttvHook hook, |
536 | gpointer hook_data); |
537 | |
538 | |
539 | /** |
540 | * Function to unregister a viewer's hook function which is used to |
541 | * set/update hpane's dividor of the viewer. |
542 | * |
543 | * @param tab the tab the viewer belongs to. |
544 | * @param hook hook function of the viewer that will be called whenever a |
545 | * dividor changes in another viewer. The call_data of this hook |
546 | * is a gint*. The value of the integer is the new position of the |
547 | * hpane dividor. |
548 | * @param hook_data hook data associated with the hook function. It will |
549 | * be typically a pointer to the viewer's data structure. |
550 | */ |
551 | |
552 | void lttvwindow_unregister_dividor(Tab *tab, |
553 | LttvHook hook, |
554 | gpointer hook_data); |
555 | |
556 | |
557 | |
501e4e70 |
558 | /** |
559 | * Function to set the time interval of the current tab.a |
560 | * |
561 | * @param tab the tab the viewer belongs to. |
562 | * @param time_interval pointer to the time interval value. |
563 | */ |
564 | |
565 | void lttvwindow_report_time_window(Tab *tab, |
566 | const TimeWindow *time_window); |
567 | |
568 | /** |
569 | * Function to set the current time/event of the current tab. |
570 | * It will be called by a viewer's signal handle associated with |
571 | * the button-release-event signal |
572 | * @param tab the tab the viewer belongs to. |
573 | * @param time a pointer where time is stored. |
574 | */ |
575 | |
576 | void lttvwindow_report_current_time(Tab *tab, |
577 | const LttTime *time); |
578 | |
579 | |
580 | /** |
581 | * Function to set the position of the hpane's dividor (viewer). |
582 | * It will typically be called by a viewer's signal handle associated |
583 | * with the motion_notify_event event/signal. |
584 | * |
585 | * @param tab the tab the viewer belongs to. |
586 | * @param position position of the hpane's dividor. |
587 | */ |
588 | |
589 | void lttvwindow_report_dividor(Tab *tab, gint position); |
590 | |
591 | /** |
592 | * Function to set the focused viewer of the tab. |
593 | * It will be called by a viewer's signal handle associated with |
594 | * the grab_focus signal of all widgets in the viewer. |
595 | * |
596 | * @param tab the tab the viewer belongs to. |
597 | * @param top_widget the top widget containing all the other widgets of the |
598 | * viewer. |
599 | */ |
600 | void lttvwindow_report_focus(Tab *tab, |
601 | GtkWidget *top_widget); |
602 | |
603 | |
604 | /* Structure sent to the events request hook */ |
605 | /* Value considered as empty */ |
606 | typedef struct _EventsRequest { |
2d262115 |
607 | gpointer owner; /* Owner of the request */ |
501e4e70 |
608 | gpointer viewer_data; /* Unset : NULL */ |
609 | gboolean servicing; /* service in progress: TRUE */ |
610 | LttTime start_time;/* Unset : { G_MAXUINT, G_MAXUINT }*/ |
611 | LttvTracesetContextPosition *start_position; /* Unset : NULL */ |
612 | gboolean stop_flag; /* Continue:TRUE Stop:FALSE */ |
613 | LttTime end_time;/* Unset : { G_MAXUINT, G_MAXUINT } */ |
614 | guint num_events; /* Unset : G_MAXUINT */ |
615 | LttvTracesetContextPosition *end_position; /* Unset : NULL */ |
616 | LttvHooks *before_chunk_traceset; /* Unset : NULL */ |
617 | LttvHooks *before_chunk_trace; /* Unset : NULL */ |
618 | LttvHooks *before_chunk_tracefile;/* Unset : NULL */ |
619 | LttvHooks *event; /* Unset : NULL */ |
620 | LttvHooksById *event_by_id; /* Unset : NULL */ |
621 | LttvHooks *after_chunk_tracefile; /* Unset : NULL */ |
622 | LttvHooks *after_chunk_trace; /* Unset : NULL */ |
623 | LttvHooks *after_chunk_traceset; /* Unset : NULL */ |
624 | LttvHooks *before_request; /* Unset : NULL */ |
2d262115 |
625 | LttvHooks *after_request; /* Unset : NULL */ |
501e4e70 |
626 | } EventsRequest; |
627 | |
2d262115 |
628 | /* Maximum number of events to proceed at once in a chunk */ |
313bd6fc |
629 | #define CHUNK_NUM_EVENTS 200 |
2d262115 |
630 | |
501e4e70 |
631 | |
632 | /** |
633 | * Function to request data in a specific time interval to the main window. The |
634 | * event request servicing is differed until the glib idle functions are |
635 | * called. |
636 | * |
637 | * The viewer has to provide hooks that should be associated with the event |
638 | * request. |
639 | * |
640 | * Either start time or start position must be defined in a EventRequest |
641 | * structure for it to be valid. |
642 | * |
643 | * end_time, end_position and num_events can all be defined. The first one |
644 | * to occur will be used as end criterion. |
20fde85f |
645 | * |
646 | * The events_request memory will be managed by the main window once its |
647 | * pointer is passed by this function. |
501e4e70 |
648 | * |
649 | * @param tab the tab the viewer belongs to. |
650 | * @param events_requested Details about the event request. |
651 | */ |
652 | |
653 | void lttvwindow_events_request(Tab *tab, |
20fde85f |
654 | EventsRequest *events_request); |
501e4e70 |
655 | |
656 | /** |
657 | * Function to remove data requests related to a viewer. |
658 | * |
659 | * The existing requests's viewer gpointer is compared to the pointer |
660 | * given in argument to establish which data request should be removed. |
661 | * |
662 | * @param tab the tab the viewer belongs to. |
663 | * @param viewer a pointer to the viewer data structure |
664 | */ |
665 | |
666 | void lttvwindow_events_request_remove_all(Tab *tab, |
667 | gconstpointer viewer); |
668 | |
669 | |
501e4e70 |
670 | /** |
671 | * Function to get the current time window of the current tab. |
672 | * |
673 | * @param tab the tab the viewer belongs to. |
6ea08962 |
674 | * @return the current tab's time interval. |
501e4e70 |
675 | */ |
676 | |
6ea08962 |
677 | TimeWindow lttvwindow_get_time_window(Tab *tab); |
501e4e70 |
678 | |
679 | |
680 | /** |
681 | * Function to get the current time of the current tab. |
682 | * |
683 | * @param tab the tab the viewer belongs to. |
6ea08962 |
684 | * @return the current tab's current time. |
501e4e70 |
685 | */ |
686 | |
6ea08962 |
687 | LttTime lttvwindow_get_current_time(Tab *tab); |
501e4e70 |
688 | |
689 | |
690 | /** |
691 | * Function to get the filter of the current tab. |
692 | * @param main_win, the main window the viewer belongs to. |
693 | * @param filter, a pointer to a filter. |
694 | */ |
695 | |
696 | //FIXME |
697 | typedef void lttv_filter; |
698 | //FIXME |
699 | const lttv_filter *lttvwindow_get_filter(Tab *tab); |
700 | |
701 | |
702 | /** |
703 | * Function to get the stats of the traceset |
704 | * It must be non const so the viewer can modify it. |
705 | * FIXME : a set/get pair of functions would be more appropriate here. |
706 | * @param tab the tab the viewer belongs to. |
707 | * @return A pointer to Traceset statistics. |
708 | */ |
709 | |
710 | LttvTracesetStats* lttvwindow_get_traceset_stats(Tab *tab); |
711 | |
712 | /** |
713 | * Function to get the context of the traceset |
714 | * It must be non const so the viewer can add and remove hooks from it. |
715 | * @param tab the tab the viewer belongs to. |
716 | * @return Context of the current tab. |
717 | */ |
718 | |
719 | |
720 | LttvTracesetContext* lttvwindow_get_traceset_context(Tab *tab); |
721 | |
722 | |
723 | #endif //VIEWER_H |