doxygen comments added
[libfirm] / ir / common / firm_common.h
1 /* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
2 * All rights reserved.
3 */
4
5 /**
6  * @file firm_common.h
7  *
8  * common firm declarations
9  *
10  * @author Martin Trapp, Christian Schaefer & Goetz Lindenmaier
11  */
12
13 /* $Id$ */
14
15 # ifndef _FIRM_COMMON_H_
16 # define _FIRM_COMMON_H_
17
18 #ifndef INLINE
19 #ifdef USE_GCC_INLINE
20 #define INLINE inline
21 #else
22 #define INLINE
23 #endif
24 #endif
25
26 /** a list of firm kinds */
27 typedef enum {
28   k_entity,     /**< an entity */
29   k_type,       /**< a type */
30   k_ir_node,    /**< an ir node */
31   k_ir_loop
32 } firm_kind;
33
34 /**
35  * Returns the kind of a thing.
36  *
37  * @param firm_thing  pointer repraesenting a firm object
38  */
39 firm_kind get_kind(void *firm_thing);
40
41 /** Returns the kind of a thing as a string. */
42 const char* print_firm_kind(void *firm_thing);
43
44 # endif /*_FIRM_COMMON_H_ */