cleaned up doxygen comments
[libfirm] / ir / ir / irhooks.c
1 /*
2  * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief    Generic hooks for various libFirm functions.
23  * @author   Michael Beck
24  * @version  $Id$
25  */
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
29
30 #include "irhooks.h"
31
32 #ifdef FIRM_ENABLE_HOOKS
33
34 /* the hooks */
35 hook_entry_t *hooks[hook_last];
36
37 /* register a hook */
38 void register_hook(hook_type_t hook, hook_entry_t *entry) {
39   /* check if a hook function is specified. It's a union, so no matter which one */
40   if (! entry->hook._hook_turn_into_id)
41     return;
42
43   entry->next = hooks[hook];
44   hooks[hook] = entry;
45 }
46
47 /* unregister a hook */
48 void unregister_hook(hook_type_t hook, hook_entry_t *entry) {
49   hook_entry_t *p;
50
51   if (hooks[hook] == entry) {
52     hooks[hook] = entry->next;
53     entry->next = NULL;
54     return;
55   }
56
57   for (p = hooks[hook]; p && p->next != entry; p = p->next);
58
59   if (p) {
60     p->next     = entry->next;
61     entry->next = NULL;
62   }
63 }
64
65
66 #else
67
68 void register_hook(hook_type_t hook, hook_entry_t *entry) {}
69 void unregister_hook(hook_type_t hook, hook_entry_t *entry) {}
70
71 #endif /* FIRM_ENABLE_HOOKS */
72
73 int firm_init_hooks(void) {
74   /* this strange code assures that both functions are available
75      in a shared library even if none of them is called.
76      Meanwhile not needed anymore but ... */
77   return (int)register_hook + (int)unregister_hook;
78 }