1 /*! \file gtkTraceSet.h
2 * \brief API used by the graphical viewers to interact with their top window.
4 * Main window (gui module) is the place to contain and display viewers.
5 * Viewers (lttv plugins) interacte with main window through this API and
7 * This header file should be included in each graphic module.
8 * This library is used by graphical modules to interact with the
15 #include <lttv/hook.h>
16 #include <lttv/common.h>
17 #include <lttv/stats.h>
20 * Function to register a view constructor so that main window can generate
21 * a toolbar item for the viewer in order to generate a new instance easily.
22 * It will be called by init function of the module.
23 * @param ButtonPixmap image shown on the toolbar item.
24 * @param tooltip tooltip of the toolbar item.
25 * @param view_constructor constructor of the viewer.
28 void toolbar_item_reg(char ** pixmap
, char *tooltip
, lttv_constructor view_constructor
);
32 * Function to unregister the viewer's constructor, release the space
33 * occupied by pixmap, tooltip and constructor of the viewer.
34 * It will be called when a module is unloaded.
35 * @param view_constructor constructor of the viewer which is used as
36 * a reference to find out where the pixmap and tooltip are.
39 void toolbar_item_unreg(lttv_constructor view_constructor
);
43 * Function to register a view constructor so that main window can generate
44 * a menu item for the viewer in order to generate a new instance easily.
45 * It will be called by init function of the module.
46 * @param menu_path path of the menu item.
47 * @param menu_text text of the menu item.
48 * @param view_constructor constructor of the viewer.
51 void menu_item_reg(char *menu_path
, char *menu_text
, lttv_constructor view_constructor
);
55 * Function to unregister the viewer's constructor, release the space
56 * occupied by menu_path, menu_text and constructor of the viewer.
57 * It will be called when a module is unloaded.
58 * @param view_constructor constructor of the viewer which is used as
59 * a reference to find out where the menu_path and menu_text are.
62 void menu_item_unreg(lttv_constructor view_constructor
);
66 * Update the status bar whenever something changed in the viewer.
67 * @param main_win the main window the viewer belongs to.
68 * @param info the message which will be shown in the status bar.
71 void update_status(MainWindow
*main_win
, char *info
);
75 * Function to get the current time window of the current tab.
76 * It will be called by a viewer's hook function to update the
77 * time window of the viewer and also be called by the constructor
79 * @param main_win the main window the viewer belongs to.
80 * @param time_interval a pointer where time interval will be stored.
83 void get_time_window(MainWindow
*main_win
, TimeWindow
*time_window
);
87 * Function to set the time interval of the current tab.
88 * It will be called by a viewer's signal handle associated with
89 * the move_slider signal
90 * @param main_win the main window the viewer belongs to.
91 * @param time_interval a pointer where time interval is stored.
94 void set_time_window(MainWindow
*main_win
, TimeWindow
*time_window
);
97 * Function to get the current time/event of the current tab.
98 * It will be called by a viewer's hook function to update the
99 * current time/event of the viewer.
100 * @param main_win the main window the viewer belongs to.
101 * @param time a pointer where time will be stored.
104 void get_current_time(MainWindow
*main_win
, LttTime
*time
);
108 * Function to set the current time/event of the current tab.
109 * It will be called by a viewer's signal handle associated with
110 * the button-release-event signal
111 * @param main_win the main window the viewer belongs to.
112 * @param time a pointer where time is stored.
115 void set_current_time(MainWindow
*main_win
, LttTime
*time
);
119 * Function to get the traceset from the current tab.
120 * It will be called by the constructor of the viewer and also be
121 * called by a hook funtion of the viewer to update its traceset.
122 * @param main_win the main window the viewer belongs to.
123 * @param traceset a pointer to a traceset.
126 //void get_traceset(MainWindow *main_win, Traceset *traceset);
130 * Function to get the filter of the current tab.
131 * It will be called by the constructor of the viewer and also be
132 * called by a hook funtion of the viewer to update its filter.
133 * @param main_win, the main window the viewer belongs to.
134 * @param filter, a pointer to a filter.
137 //void get_filter(MainWindow *main_win, Filter *filter);
141 * Function to register a hook function for a viewer to set/update its
143 * It will be called by the constructor of the viewer.
144 * @param hook hook function of the viewer. Takes a TimeInterval* as call_data.
145 * @param hook_data hook data associated with the hook function.
146 * @param main_win the main window the viewer belongs to.
149 void reg_update_time_window(LttvHook hook
, gpointer hook_data
,
150 MainWindow
* main_win
);
154 * Function to unregister a viewer's hook function which is used to
155 * set/update the time interval of the viewer.
156 * It will be called by the destructor of the viewer.
157 * @param hook hook function of the viewer. Takes a TimeInterval as call_data.
158 * @param hook_data hook data associated with the hook function.
159 * @param main_win the main window the viewer belongs to.
162 void unreg_update_time_window(LttvHook hook
, gpointer hook_data
,
163 MainWindow
* main_win
);
167 * Function to register a hook function for a viewer to set/update its
169 * It will be called by the constructor of the viewer.
170 * @param hook hook function of the viewer.
171 * @param hook_data hook data associated with the hook function.
172 * @param main_win the main window the viewer belongs to.
175 void reg_update_traceset(LttvHook hook
, gpointer hook_data
,
176 MainWindow
* main_win
);
180 * Function to unregister a viewer's hook function which is used to
181 * set/update the traceset of the viewer.
182 * It will be called by the destructor of the viewer.
183 * @param hook hook function of the viewer.
184 * @param hook_data hook data associated with the hook function.
185 * @param main_win the main window the viewer belongs to.
188 void unreg_update_traceset(LttvHook hook
, gpointer hook_data
,
189 MainWindow
* main_win
);
193 * Function to register a hook function for a viewer to set/update its
195 * It will be called by the constructor of the viewer.
196 * @param hook hook function of the viewer.
197 * @param hook_data hook data associated with the hook function.
198 * @param main_win the main window the viewer belongs to.
201 void reg_update_filter(LttvHook hook
, gpointer hook_data
,
202 MainWindow
*main_win
);
206 * Function to unregister a viewer's hook function which is used to
207 * set/update the filter of the viewer.
208 * It will be called by the destructor of the viewer.
209 * @param hook hook function of the viewer.
210 * @param hook_data hook data associated with the hook function.
211 * @param main_win the main window the viewer belongs to.
214 void unreg_update_filter(LttvHook hook
, gpointer hook_data
,
215 MainWindow
* main_win
);
219 * Function to register a hook function for a viewer to set/update its
221 * It will be called by the constructor of the viewer.
222 * @param hook hook function of the viewer.
223 * @param hook_data hook data associated with the hook function.
224 * @param main_win the main window the viewer belongs to.
227 void reg_update_current_time(LttvHook hook
, gpointer hook_data
,
228 MainWindow
*main_win
);
232 * Function to unregister a viewer's hook function which is used to
233 * set/update the current time of the viewer.
234 * It will be called by the destructor of the viewer.
235 * @param hook hook function of the viewer.
236 * @param hook_data hook data associated with the hook function.
237 * @param main_win the main window the viewer belongs to.
240 void unreg_update_current_time(LttvHook hook
, gpointer hook_data
,
241 MainWindow
* main_win
);
245 * Function to register a hook function for a viewer to show
246 *the content of the viewer.
247 * It will be called by the constructor of the viewer.
248 * @param hook hook function of the viewer.
249 * @param hook_data hook data associated with the hook function.
250 * @param main_win the main window the viewer belongs to.
253 void reg_show_viewer(LttvHook hook
, gpointer hook_data
,
254 MainWindow
*main_win
);
258 * Function to unregister a viewer's hook function which is used to
259 * show the content of the viewer..
260 * It will be called by the destructor of the viewer.
261 * @param hook hook function of the viewer.
262 * @param hook_data hook data associated with the hook function.
263 * @param main_win the main window the viewer belongs to.
266 void unreg_show_viewer(LttvHook hook
, gpointer hook_data
,
267 MainWindow
* main_win
);
271 * Function to show each viewer in the current tab.
272 * It will be called by main window after it called process_traceset
273 * @param main_win the main window the viewer belongs to.
276 void show_viewer(MainWindow
*main_win
);
280 * Function to set the focused pane (viewer).
281 * It will be called by a viewer's signal handle associated with
282 * the grab_focus signal
283 * @param main_win the main window the viewer belongs to.
284 * @param paned a pointer to a pane where the viewer is contained.
287 void set_focused_pane(MainWindow
*main_win
, gpointer paned
);
291 * Function to register a hook function for a viewer to set/update the
292 * dividor of the hpane.
293 * It will be called by the constructor of the viewer.
294 * @param hook hook function of the viewer.
295 * @param hook_data hook data associated with the hook function.
296 * @param main_win the main window the viewer belongs to.
299 void reg_update_dividor(LttvHook hook
, gpointer hook_data
,
300 MainWindow
*main_win
);
304 * Function to unregister a viewer's hook function which is used to
305 * set/update hpane's dividor of the viewer.
306 * It will be called by the destructor of the viewer.
307 * @param hook hook function of the viewer.
308 * @param hook_data hook data associated with the hook function.
309 * @param main_win the main window the viewer belongs to.
312 void unreg_update_dividor(LttvHook hook
, gpointer hook_data
,
313 MainWindow
*main_win
);
317 * Function to set the position of the hpane's dividor (viewer).
318 * It will be called by a viewer's signal handle associated with
319 * the motion_notify_event event/signal
320 * @param main_win the main window the viewer belongs to.
321 * @param position position of the hpane's dividor.
324 void set_hpane_dividor(MainWindow
*main_win
, gint position
);
328 * Function to process traceset. It will call lttv_process_trace,
329 * each view will call this api to get events.
330 * @param main_win the main window the viewer belongs to.
331 * @param start the start time of the first event to be processed.
332 * @param end the end time of the last event to be processed.
335 void process_traceset_api(MainWindow
*main_win
, LttTime start
,
336 LttTime end
, unsigned maxNumEvents
);
340 * Function to add hooks into the context of a traceset,
341 * before reading events from traceset, viewer will call this api to
343 * @param main_win the main window the viewer belongs to.
344 * @param LttvHooks hooks to be registered.
347 void context_add_hooks_api(MainWindow
*main_win
,
348 LttvHooks
*before_traceset
,
349 LttvHooks
*after_traceset
,
350 LttvHooks
*check_trace
,
351 LttvHooks
*before_trace
,
352 LttvHooks
*after_trace
,
353 LttvHooks
*check_tracefile
,
354 LttvHooks
*before_tracefile
,
355 LttvHooks
*after_tracefile
,
356 LttvHooks
*check_event
,
357 LttvHooks
*before_event
,
358 LttvHooks
*after_event
);
362 * Function to remove hooks from the context of a traceset,
363 * before reading events from traceset, viewer will call this api to
365 * @param main_win the main window the viewer belongs to.
366 * @param LttvHooks hooks to be registered.
369 void context_remove_hooks_api(MainWindow
*main_win
,
370 LttvHooks
*before_traceset
,
371 LttvHooks
*after_traceset
,
372 LttvHooks
*check_trace
,
373 LttvHooks
*before_trace
,
374 LttvHooks
*after_trace
,
375 LttvHooks
*check_tracefile
,
376 LttvHooks
*before_tracefile
,
377 LttvHooks
*after_tracefile
,
378 LttvHooks
*check_event
,
379 LttvHooks
*before_event
,
380 LttvHooks
*after_event
);
384 * Function to get the life span of the traceset
385 * @param main_win the main window the viewer belongs to.
386 * @param start start time of the traceset.
387 * @param end end time of the traceset.
390 void get_traceset_time_span(MainWindow
*main_win
, TimeInterval
*time_span
);
394 * Function to add/remove event hooks for state
395 * @param main_win the main window the viewer belongs to.
398 void state_add_event_hooks_api(MainWindow
*main_win
);
399 void state_remove_event_hooks_api(MainWindow
*main_win
);
403 * Function to add/remove event hooks for stats
404 * @param main_win the main window the viewer belongs to.
407 void stats_add_event_hooks_api(MainWindow
*main_win
);
408 void stats_remove_event_hooks_api(MainWindow
*main_win
);
412 * Function to get the stats of the traceset
413 * @param main_win the main window the viewer belongs to.
416 LttvTracesetStats
* get_traceset_stats_api(MainWindow
*main_win
);