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 | |
105 | FIXME : Add background computation explanation here |
106 | background_init: prepare for background computation (comes after show_end). |
107 | process_trace for background: done in small chunks in gtk_idle, hooks called. |
108 | background_end: remove the hooks and perhaps update the window. |
109 | |
110 | |
111 | Reporting Changes to the Main Window |
112 | |
2d262115 |
113 | In most cases, the enclosing window knows about updates such as described |
114 | in the Notification section higher. There are a few cases, however, where |
115 | updates are caused by actions known by a view instance. For example, |
116 | clicking in a view may update the current time; all viewers within |
117 | the same window must be told about the new current time to change the |
118 | currently highlighted time point. A viewer reports such events by calling |
119 | lttvwindow_report_current_time on its lttvwindow. The lttvwindow will |
120 | consequently call current_time_notify for each of its contained viewers. |
501e4e70 |
121 | |
122 | |
123 | Available report methods are : |
124 | |
125 | lttvwindow_report_status : reports the text of the status bar. |
126 | lttvwindow_report_time_window : reports the new time window. |
127 | lttvwindow_report_current_time : reports the new current time. |
128 | lttvwindow_report_dividor : reports the new horizontal dividor's position. |
129 | lttvwindow_report_focus : One on the widgets in the viewer has the keyboard's |
130 | focus from GTK. |
131 | |
132 | |
133 | |
134 | Requesting Events to Main Window |
135 | |
2d262115 |
136 | Events can be requested by passing a EventsRequest structure to the main |
137 | window. They will be delivered later when the next g_idle functions |
138 | will be called. Event delivery is done by calling the event hook for |
139 | this event ID, or the main event hooks. A pointer to the EventsRequest |
140 | structure is passed as hook_data to the event hooks of the viewers. |
501e4e70 |
141 | |
142 | EventsRequest consists in |
143 | - a pointer to the viewer specific data structure |
144 | - a start timestamp or position |
145 | - a stop_flag, ending the read process when set to TRUE |
146 | - a end timestamp and/or position and/or number of events to read |
147 | - hook lists to call for traceset/trace/tracefile begin and end, and for each |
148 | event (event hooks and event_by_id hooks). |
149 | |
2d262115 |
150 | The main window will deliver events for every EventRequests it has |
151 | pending through an algorithm that guarantee that all events requested, |
152 | and only them, will be delivered to the viewer between the call of the |
153 | tracefile_begin hooks and the call of the tracefile_end hooks. |
501e4e70 |
154 | |
2d262115 |
155 | If a viewer wants to stop the event request at a certain point inside the |
156 | event hooks, it has to set the stop_flag to TRUE and return TRUE from the |
157 | hook function. Then return value will stop the process traceset. Then, |
158 | the main window will look for the stop_flag and remove the EventRequests |
159 | from its lists, calling the process_traceset_end for this request (it |
160 | removes hooks from the context and calls the after hooks). |
501e4e70 |
161 | |
2d262115 |
162 | It no stop_flag is rose, the end timestamp, end position or number |
163 | of events to read has to be reached to determine the end of the |
164 | request. Otherwise, the end of traceset does determine it. |
501e4e70 |
165 | |
166 | |
167 | GTK Events |
168 | |
169 | Events and Signals |
170 | |
2d262115 |
171 | GTK is quite different from the other graphical toolkits around |
172 | there. The main difference resides in that there are many X Windows |
173 | inside one GtkWindow, instead of just one. That means that X events are |
174 | delivered by the glib main loop directly to the widget corresponding to |
175 | the GdkWindow affected by the X event. |
501e4e70 |
176 | |
2d262115 |
177 | Event delivery to a widget emits a signal on that widget. Then, if a |
178 | handler is connected to this widget's signal, it will be executed. There |
179 | are default handlers for signals, connected at class instantiation |
180 | time. There is also the possibility to connect other handlers to these |
181 | signals, which is what should be done in most cases when a viewer needs |
182 | to interact with X in any way. |
501e4e70 |
183 | |
184 | |
185 | |
186 | Signal emission and propagation is described there : |
187 | |
188 | http://www.gtk.org/tutorial/sec-signalemissionandpropagation.html |
189 | |
190 | For further information on the GTK main loop (now a wrapper over glib main loop) |
191 | see : |
192 | |
193 | http://developer.gnome.org/doc/API/2.0/gtk/gtk-General.html |
194 | http://developer.gnome.org/doc/API/2.0/glib/glib-The-Main-Event-Loop.html |
195 | |
196 | |
197 | For documentation on event handling in GTK/GDK, see : |
198 | |
199 | http://developer.gnome.org/doc/API/2.0/gdk/gdk-Events.html |
200 | http://developer.gnome.org/doc/API/2.0/gdk/gdk-Event-Structures.html |
201 | |
202 | |
203 | Signals can be connected to handlers, emitted, propagated, blocked, |
204 | stopped. See : |
205 | |
206 | http://developer.gnome.org/doc/API/2.0/gobject/gobject-Signals.html |
207 | |
208 | |
209 | |
210 | |
211 | The "expose_event" |
212 | |
213 | Provides the exposed region in the GdkEventExpose structure. |
214 | |
2d262115 |
215 | There are two ways of dealing with exposures. The first one is to directly |
216 | draw on the screen and the second one is to draw in a pixmap buffer, |
217 | and then to update the screen when necessary. |
501e4e70 |
218 | |
2d262115 |
219 | In the first case, the expose event will be responsible for registering |
220 | hooks to process_traceset and require time intervals to the main |
221 | window. So, in this scenario, if a part of the screen is damaged, the |
222 | trace has to be read to redraw the screen. |
501e4e70 |
223 | |
2d262115 |
224 | In the second case, with a pixmap buffer, the expose handler is only |
225 | responsible of showing the pixmap buffer on the screen. If the pixmap |
226 | buffer has never been filled with a drawing, the expose handler may ask |
227 | for it to be filled. |
501e4e70 |
228 | |
2d262115 |
229 | The interest of using events request to the main window instead of reading |
230 | the events directly from the trace comes from the fact that the main |
231 | window does merge requests from the different viewers in the same tab so |
232 | that the read loop and the state update is shared. As viewers will, in |
233 | the common scenario, request the same events, only one pass through the |
234 | trace that will call the right hooks for the right intervals will be done. |
501e4e70 |
235 | |
2d262115 |
236 | When the traceset read is over for a events request, the traceset_end |
237 | hook is called. It has the responsibility of finishing the drawing if |
238 | some parts still need to be drawn and to show it on the screen (if the |
239 | viewer uses a pixmap buffer). |
501e4e70 |
240 | |
241 | It can add dotted lines and such visual effects to enhance the user's |
242 | experience. |
243 | |
244 | |
245 | FIXME : explain other important events |
246 | |
247 | */ |
248 | |
249 | |
250 | #ifndef VIEWER_H |
251 | #define VIEWER_H |
252 | |
253 | /*! \file lttvwindow.h |
254 | * \brief API used by the graphical viewers to interact with their top window. |
255 | * |
256 | * Main window (lttvwindow module) is the place to contain and display viewers. |
257 | * Viewers (lttv plugins) interact with main window through this API. |
258 | * This header file should be included in each graphic module. |
259 | * |
260 | */ |
261 | |
262 | #include <gtk/gtk.h> |
263 | #include <ltt/ltt.h> |
264 | #include <ltt/time.h> |
265 | #include <lttv/hook.h> |
266 | #include <lttv/tracecontext.h> |
267 | #include <lttv/stats.h> |
2d262115 |
268 | #include <lttvwindow/mainwindow.h> |
269 | #include <lttvwindow/lttvfilter.h> |
501e4e70 |
270 | //FIXME (not ready yet) #include <lttv/filter.h> |
271 | |
501e4e70 |
272 | /* Module Related API */ |
273 | |
274 | |
275 | /* constructor a the viewer */ |
276 | //FIXME explain LttvTracesetSelector and key |
277 | typedef GtkWidget * (*lttvwindow_viewer_constructor) |
278 | (Tab *tab, LttvTracesetSelector * s, char *key); |
279 | |
280 | |
281 | /** |
282 | * Function to register a view constructor so that main window can generate |
283 | * a menu item and a toolbar item for the viewer in order to generate a new |
284 | * instance easily. A menu entry and toolbar item will be added to each main |
285 | * window. |
286 | * |
287 | * It should be called by init function of the module. |
288 | * |
289 | * @param menu_path path of the menu item. NULL : no menu entry. |
290 | * @param menu_text text of the menu item. |
291 | * @param pixmap Image shown on the toolbar item. NULL : no button. |
292 | * @param tooltip tooltip of the toolbar item. |
293 | * @param view_constructor constructor of the viewer. |
294 | */ |
295 | |
296 | void lttvwindow_register_constructor |
297 | (char * menu_path, |
298 | char * menu_text, |
299 | char ** pixmap, |
300 | char * tooltip, |
301 | lttvwindow_viewer_constructor view_constructor); |
302 | |
303 | |
304 | /** |
305 | * Function to unregister the viewer's constructor, release the space |
306 | * occupied by menu_path, menu_text, pixmap, tooltip and constructor of the |
307 | * viewer. |
308 | * |
309 | * It will be called when a module is unloaded. |
310 | * |
311 | * @param view_constructor constructor of the viewer. |
312 | */ |
313 | |
314 | void lttvwindow_unregister_constructor |
315 | (lttvwindow_viewer_constructor view_constructor); |
316 | |
317 | |
318 | |
319 | |
320 | /* Viewer Instance Related API */ |
321 | |
322 | /** |
323 | * Structure used as hook_data for the time_window_notify hook. |
324 | */ |
325 | typedef struct _TimeWindowNotifyData { |
326 | TimeWindow *new_time_window; |
327 | TimeWindow *old_time_window; |
328 | } TimeWindowNotifyData; |
329 | |
330 | |
331 | /** |
332 | * Function to register a hook function that will be called by the main window |
333 | * when the time interval needs to be updated. |
334 | * |
335 | * This register function is typically called by the constructor of the viewer. |
336 | * |
337 | * @param tab the tab the viewer belongs to. |
338 | * @param hook hook that sould be called by the main window when the time |
339 | * interval changes. This hook function takes a |
340 | * TimeWindowNotifyData* as call_data. |
341 | * @param hook_data hook data associated with the hook function. It will |
342 | * be typically a pointer to the viewer's data structure. |
343 | */ |
344 | |
345 | void lttvwindow_register_time_window_notify(Tab *tab, |
346 | LttvHook hook, |
347 | gpointer hook_data); |
348 | |
349 | |
350 | /** |
351 | * Function to unregister the time_window notification hook. |
352 | * |
353 | * This unregister function is typically called by the destructor of the viewer. |
354 | * |
355 | * @param tab the tab the viewer belongs to. |
356 | * @param hook hook that sould be called by the main window when the time |
357 | * interval changes. This hook function takes a |
358 | * TimeWindowNotifyData* as call_data. |
359 | * @param hook_data hook data associated with the hook function. It will |
360 | * be typically a pointer to the viewer's data structure. |
361 | */ |
362 | |
363 | void lttvwindow_unregister_time_window_notify(Tab *tab, |
364 | LttvHook hook, |
365 | gpointer hook_data); |
366 | |
367 | |
368 | /** |
369 | * Function to register a hook function that will be called by the main window |
370 | * when the traceset is changed. That means that the viewer must redraw |
371 | * itself completely or check if it's affected by the particular change to the |
372 | * traceset. |
373 | * |
374 | * This register function is typically called by the constructor of the viewer. |
375 | * |
376 | * @param tab the tab the viewer belongs to. |
377 | * @param hook hook that should be called whenever a change to the traceset |
378 | * occurs. The call_data of this hook is a NULL pointer. |
379 | * @param hook_data hook data associated with the hook function. It will |
380 | * be typically a pointer to the viewer's data structure. |
381 | */ |
382 | |
383 | void lttvwindow_register_traceset_notify(Tab *tab, |
384 | LttvHook hook, |
385 | gpointer hook_data); |
386 | |
387 | |
388 | /** |
389 | * Function to unregister the traceset_notify hook. |
390 | * |
391 | * @param tab the tab the viewer belongs to. |
392 | * @param hook hook that should be called whenever a change to the traceset |
393 | * occurs. The call_data of this hook is a NULL pointer. |
394 | * @param hook_data hook data associated with the hook function. It will |
395 | * be typically a pointer to the viewer's data structure. |
396 | */ |
397 | |
398 | void lttvwindow_unregister_traceset_notify(Tab *tab, |
399 | LttvHook hook, |
400 | gpointer hook_data); |
401 | |
402 | |
9878c8a4 |
403 | /** |
404 | * Function to register a hook function for a viewer be completely redrawn. |
405 | * |
406 | * @param tab viewer's tab |
407 | * @param hook hook function of the viewer. |
408 | * @param hook_data hook data associated with the hook function. |
409 | */ |
410 | |
411 | void lttvwindow_register_redraw_notify(Tab *tab, |
412 | LttvHook hook, gpointer hook_data); |
413 | |
414 | /** |
415 | * Function to unregister a hook function for a viewer be completely redrawn. |
416 | * |
417 | * @param tab viewer's tab |
418 | * @param hook hook function of the viewer. |
419 | * @param hook_data hook data associated with the hook function. |
420 | */ |
421 | |
422 | void lttvwindow_unregister_redraw_notify(Tab *tab, |
423 | LttvHook hook, gpointer hook_data); |
424 | |
425 | |
426 | /** |
427 | * Function to register a hook function for a viewer to re-do the events |
428 | * requests for the needed interval. |
429 | * |
430 | * This action is typically done after a "stop". |
431 | * |
432 | * The typical hook will remove all current requests for the viewer |
433 | * and make requests for missing information. |
434 | * |
435 | * @param tab viewer's tab |
436 | * @param hook hook function of the viewer. |
437 | * @param hook_data hook data associated with the hook function. |
438 | */ |
439 | |
440 | void lttvwindow_register_continue_notify(Tab *tab, |
441 | LttvHook hook, gpointer hook_data); |
442 | |
443 | |
444 | /** |
445 | * Function to unregister a hook function for a viewer to re-do the events |
446 | * requests for the needed interval. |
447 | * |
448 | * @param tab viewer's tab |
449 | * @param hook hook function of the viewer. |
450 | * @param hook_data hook data associated with the hook function. |
451 | */ |
452 | |
453 | void lttvwindow_unregister_continue_notify(Tab *tab, |
454 | LttvHook hook, gpointer hook_data); |
455 | |
456 | |
501e4e70 |
457 | /** |
458 | * Function to register a hook function for a viewer to set/update its |
459 | * filter. |
460 | * |
461 | * FIXME : Add information about what a filter is as seen from a viewer and how |
462 | * to use it. |
463 | * |
464 | * This register function is typically called by the constructor of the viewer. |
465 | * |
466 | * @param tab the tab the viewer belongs to. |
467 | * @param hook hook function called by the main window when a filter change |
468 | * occurs. |
469 | * @param hook_data hook data associated with the hook function. It will |
470 | * be typically a pointer to the viewer's data structure. |
471 | */ |
472 | |
473 | void lttvwindow_register_filter_notify(Tab *tab, |
474 | LttvHook hook, |
475 | gpointer hook_data); |
476 | |
477 | |
478 | /** |
479 | * Function to unregister a viewer's hook function which is used to |
480 | * set/update the filter of the viewer. |
481 | * |
482 | * This unregistration is called by the destructor of the viewer. |
483 | * |
484 | * @param tab the tab the viewer belongs to. |
485 | * @param hook hook function called by the main window when a filter change |
486 | * occurs. |
487 | * @param hook_data hook data associated with the hook function. It will |
488 | * be typically a pointer to the viewer's data structure. |
489 | */ |
490 | |
491 | void lttvwindow_unregister_filter_notify(Tab *tab, |
492 | LttvHook hook, |
493 | gpointer hook_data); |
494 | |
495 | |
496 | /** |
497 | * Function to register a hook function for a viewer to set/update its |
498 | * current time. |
499 | * |
500 | * @param tab the tab the viewer belongs to. |
501 | * @param hook hook function of the viewer that updates the current time. The |
502 | * call_data is a LttTime* representing the new current time. |
503 | * @param hook_data hook data associated with the hook function. It will |
504 | * be typically a pointer to the viewer's data structure. |
505 | */ |
506 | |
507 | void lttvwindow_register_current_time_notify(Tab *tab, |
508 | LttvHook hook, |
509 | gpointer hook_data); |
510 | |
511 | |
512 | /** |
513 | * Function to unregister a viewer's hook function which is used to |
514 | * set/update the current time of the viewer. |
515 | * @param tab the tab the viewer belongs to. |
516 | * @param hook hook function of the viewer that updates the current time. The |
517 | * call_data is a LttTime* representing the new current time. |
518 | * @param hook_data hook data associated with the hook function. It will |
519 | * be typically a pointer to the viewer's data structure. |
520 | */ |
521 | |
522 | void lttvwindow_unregister_current_time_notify(Tab *tab, |
523 | LttvHook hook, |
524 | gpointer hook_data); |
525 | |
526 | |
527 | /** |
528 | * Function to register a hook function for a viewer to set/update the |
529 | * dividor of the hpane. It provides a way to make the horizontal |
530 | * dividors of all the viewers linked together. |
531 | * |
532 | * @param tab the tab the viewer belongs to. |
533 | * @param hook hook function of the viewer that will be called whenever a |
534 | * dividor changes in another viewer. The call_data of this hook |
535 | * is a gint*. The value of the integer is the new position of the |
536 | * hpane dividor. |
537 | * @param hook_data hook data associated with the hook function. It will |
538 | * be typically a pointer to the viewer's data structure. |
539 | */ |
540 | |
541 | void lttvwindow_register_dividor(Tab *tab, |
542 | LttvHook hook, |
543 | gpointer hook_data); |
544 | |
545 | |
546 | /** |
547 | * Function to unregister a viewer's hook function which is used to |
548 | * set/update hpane's dividor of the viewer. |
549 | * |
550 | * @param tab the tab the viewer belongs to. |
551 | * @param hook hook function of the viewer that will be called whenever a |
552 | * dividor changes in another viewer. The call_data of this hook |
553 | * is a gint*. The value of the integer is the new position of the |
554 | * hpane dividor. |
555 | * @param hook_data hook data associated with the hook function. It will |
556 | * be typically a pointer to the viewer's data structure. |
557 | */ |
558 | |
559 | void lttvwindow_unregister_dividor(Tab *tab, |
560 | LttvHook hook, |
561 | gpointer hook_data); |
562 | |
563 | |
564 | |
501e4e70 |
565 | /** |
566 | * Function to set the time interval of the current tab.a |
567 | * |
568 | * @param tab the tab the viewer belongs to. |
569 | * @param time_interval pointer to the time interval value. |
570 | */ |
571 | |
572 | void lttvwindow_report_time_window(Tab *tab, |
573 | const TimeWindow *time_window); |
574 | |
575 | /** |
576 | * Function to set the current time/event of the current tab. |
577 | * It will be called by a viewer's signal handle associated with |
578 | * the button-release-event signal |
579 | * @param tab the tab the viewer belongs to. |
580 | * @param time a pointer where time is stored. |
581 | */ |
582 | |
583 | void lttvwindow_report_current_time(Tab *tab, |
584 | const LttTime *time); |
585 | |
586 | |
587 | /** |
588 | * Function to set the position of the hpane's dividor (viewer). |
589 | * It will typically be called by a viewer's signal handle associated |
590 | * with the motion_notify_event event/signal. |
591 | * |
592 | * @param tab the tab the viewer belongs to. |
593 | * @param position position of the hpane's dividor. |
594 | */ |
595 | |
596 | void lttvwindow_report_dividor(Tab *tab, gint position); |
597 | |
598 | /** |
599 | * Function to set the focused viewer of the tab. |
600 | * It will be called by a viewer's signal handle associated with |
601 | * the grab_focus signal of all widgets in the viewer. |
602 | * |
603 | * @param tab the tab the viewer belongs to. |
604 | * @param top_widget the top widget containing all the other widgets of the |
605 | * viewer. |
606 | */ |
607 | void lttvwindow_report_focus(Tab *tab, |
608 | GtkWidget *top_widget); |
609 | |
610 | |
611 | /* Structure sent to the events request hook */ |
612 | /* Value considered as empty */ |
613 | typedef struct _EventsRequest { |
2d262115 |
614 | gpointer owner; /* Owner of the request */ |
501e4e70 |
615 | gpointer viewer_data; /* Unset : NULL */ |
616 | gboolean servicing; /* service in progress: TRUE */ |
617 | LttTime start_time;/* Unset : { G_MAXUINT, G_MAXUINT }*/ |
618 | LttvTracesetContextPosition *start_position; /* Unset : NULL */ |
619 | gboolean stop_flag; /* Continue:TRUE Stop:FALSE */ |
620 | LttTime end_time;/* Unset : { G_MAXUINT, G_MAXUINT } */ |
621 | guint num_events; /* Unset : G_MAXUINT */ |
622 | LttvTracesetContextPosition *end_position; /* Unset : NULL */ |
623 | LttvHooks *before_chunk_traceset; /* Unset : NULL */ |
624 | LttvHooks *before_chunk_trace; /* Unset : NULL */ |
625 | LttvHooks *before_chunk_tracefile;/* Unset : NULL */ |
626 | LttvHooks *event; /* Unset : NULL */ |
627 | LttvHooksById *event_by_id; /* Unset : NULL */ |
628 | LttvHooks *after_chunk_tracefile; /* Unset : NULL */ |
629 | LttvHooks *after_chunk_trace; /* Unset : NULL */ |
630 | LttvHooks *after_chunk_traceset; /* Unset : NULL */ |
631 | LttvHooks *before_request; /* Unset : NULL */ |
2d262115 |
632 | LttvHooks *after_request; /* Unset : NULL */ |
501e4e70 |
633 | } EventsRequest; |
634 | |
2d262115 |
635 | /* Maximum number of events to proceed at once in a chunk */ |
313bd6fc |
636 | #define CHUNK_NUM_EVENTS 200 |
2d262115 |
637 | |
501e4e70 |
638 | |
639 | /** |
640 | * Function to request data in a specific time interval to the main window. The |
641 | * event request servicing is differed until the glib idle functions are |
642 | * called. |
643 | * |
644 | * The viewer has to provide hooks that should be associated with the event |
645 | * request. |
646 | * |
647 | * Either start time or start position must be defined in a EventRequest |
648 | * structure for it to be valid. |
649 | * |
650 | * end_time, end_position and num_events can all be defined. The first one |
651 | * to occur will be used as end criterion. |
20fde85f |
652 | * |
653 | * The events_request memory will be managed by the main window once its |
654 | * pointer is passed by this function. |
501e4e70 |
655 | * |
656 | * @param tab the tab the viewer belongs to. |
657 | * @param events_requested Details about the event request. |
658 | */ |
659 | |
660 | void lttvwindow_events_request(Tab *tab, |
20fde85f |
661 | EventsRequest *events_request); |
501e4e70 |
662 | |
663 | /** |
664 | * Function to remove data requests related to a viewer. |
665 | * |
666 | * The existing requests's viewer gpointer is compared to the pointer |
667 | * given in argument to establish which data request should be removed. |
668 | * |
669 | * @param tab the tab the viewer belongs to. |
670 | * @param viewer a pointer to the viewer data structure |
671 | */ |
672 | |
673 | void lttvwindow_events_request_remove_all(Tab *tab, |
674 | gconstpointer viewer); |
675 | |
676 | |
501e4e70 |
677 | /** |
678 | * Function to get the current time window of the current tab. |
679 | * |
680 | * @param tab the tab the viewer belongs to. |
6ea08962 |
681 | * @return the current tab's time interval. |
501e4e70 |
682 | */ |
683 | |
6ea08962 |
684 | TimeWindow lttvwindow_get_time_window(Tab *tab); |
501e4e70 |
685 | |
686 | |
687 | /** |
688 | * Function to get the current time of the current tab. |
689 | * |
690 | * @param tab the tab the viewer belongs to. |
6ea08962 |
691 | * @return the current tab's current time. |
501e4e70 |
692 | */ |
693 | |
6ea08962 |
694 | LttTime lttvwindow_get_current_time(Tab *tab); |
501e4e70 |
695 | |
696 | |
697 | /** |
698 | * Function to get the filter of the current tab. |
699 | * @param main_win, the main window the viewer belongs to. |
700 | * @param filter, a pointer to a filter. |
701 | */ |
702 | |
703 | //FIXME |
704 | typedef void lttv_filter; |
705 | //FIXME |
706 | const lttv_filter *lttvwindow_get_filter(Tab *tab); |
707 | |
708 | |
709 | /** |
710 | * Function to get the stats of the traceset |
711 | * It must be non const so the viewer can modify it. |
712 | * FIXME : a set/get pair of functions would be more appropriate here. |
713 | * @param tab the tab the viewer belongs to. |
714 | * @return A pointer to Traceset statistics. |
715 | */ |
716 | |
717 | LttvTracesetStats* lttvwindow_get_traceset_stats(Tab *tab); |
718 | |
719 | /** |
720 | * Function to get the context of the traceset |
721 | * It must be non const so the viewer can add and remove hooks from it. |
722 | * @param tab the tab the viewer belongs to. |
723 | * @return Context of the current tab. |
724 | */ |
725 | |
726 | |
727 | LttvTracesetContext* lttvwindow_get_traceset_context(Tab *tab); |
728 | |
729 | |
730 | #endif //VIEWER_H |