1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2003-2004 Michel Dagenais
4 * 25/05/2004 Mathieu Desnoyers : Hook priorities
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License Version 2 as
8 * published by the Free Software Foundation;
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
26 /* A hook is a function to call with the supplied hook data, and with
27 call site specific data (e.g., hooks for events are called with a
28 pointer to the current event). */
30 typedef gboolean (*LttvHook
)(void *hook_data
, void *call_data
);
33 /* A list of hooks allows registering hooks to be called later. */
35 typedef GArray LttvHooks
;
37 /* A priority associated with each hook, from -19 (high prio) to 20 (low prio)
38 * 0 being the default priority.
40 * Priority ordering is done in the lttv_hooks_add and lttv_hooks_add_list
41 * functions. Hook removal does not change list order.
44 #define LTTV_PRIO_DEFAULT 50
45 #define LTTV_PRIO_HIGH 0
46 #define LTTV_PRIO_LOW 99
48 typedef gint LttvHookPrio
;
50 /* Create and destroy a list of hooks */
52 LttvHooks
*lttv_hooks_new();
54 void lttv_hooks_destroy(LttvHooks
*h
);
57 /* Add a hook and its hook data to the list */
59 void lttv_hooks_add(LttvHooks
*h
, LttvHook f
, void *hook_data
, LttvHookPrio p
);
62 /* Add a list of hooks to the list h */
64 void lttv_hooks_add_list(LttvHooks
*h
, const LttvHooks
*list
);
67 /* Remove a hook from the list. Return the hook data. */
69 void *lttv_hooks_remove(LttvHooks
*h
, LttvHook f
);
72 /* Remove a hook from the list checking that the hook data match. */
74 void lttv_hooks_remove_data(LttvHooks
*h
, LttvHook f
, void *hook_data
);
77 /* Remove a list of hooks from the hooks list in h. */
79 void lttv_hooks_remove_list(LttvHooks
*h
, LttvHooks
*list
);
82 /* Return the number of hooks in the list */
84 unsigned lttv_hooks_number(LttvHooks
*h
);
87 /* Return the hook at the specified position in the list.
88 * *f and *hook_data are NULL if no hook exists at that position. */
90 void lttv_hooks_get(LttvHooks
*h
, unsigned i
, LttvHook
*f
, void **hook_data
,
94 /* Remove the specified hook. The position of the following hooks may change */
96 void lttv_hooks_remove_by_position(LttvHooks
*h
, unsigned i
);
99 /* Call all the hooks in the list, each with its hook data,
100 with the specified call data, in priority order. Return TRUE if one hook
103 gboolean
lttv_hooks_call(LttvHooks
*h
, void *call_data
);
106 /* Call the hooks in the list in priority order until one returns true,
107 * in which case TRUE is returned. */
109 gboolean
lttv_hooks_call_check(LttvHooks
*h
, void *call_data
);
112 /* Call hooks from two lists in priority order. If priority is the same,
113 * hooks from h1 are called first. */
115 gboolean
lttv_hooks_call_merge(LttvHooks
*h1
, void *call_data1
,
116 LttvHooks
*h2
, void *call_data2
);
118 gboolean
lttv_hooks_call_check_merge(LttvHooks
*h1
, void *call_data1
,
119 LttvHooks
*h2
, void *call_data2
);
121 /* Sometimes different hooks need to be called based on the case. The
122 case is represented by an unsigned integer id */
124 typedef GPtrArray LttvHooksById
;
127 /* Create and destroy a hooks by id list */
129 LttvHooksById
*lttv_hooks_by_id_new();
131 void lttv_hooks_by_id_destroy(LttvHooksById
*h
);
134 /* Obtain the hooks for a given id, creating a list if needed */
136 LttvHooks
*lttv_hooks_by_id_find(LttvHooksById
*h
, unsigned id
);
139 /* Return an id larger than any for which a list exists. */
141 unsigned lttv_hooks_by_id_max_id(LttvHooksById
*h
);
144 /* Get the list of hooks for an id, NULL if none exists */
146 LttvHooks
*lttv_hooks_by_id_get(LttvHooksById
*h
, unsigned id
);
149 /* Remove the list of hooks associated with an id */
151 void lttv_hooks_by_id_remove(LttvHooksById
*h
, unsigned id
);
This page took 0.045419 seconds and 4 git commands to generate.