Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
186611753bdad37acdda33b83ae2746327c5415f
[simgrid.git] / include / xbt / misc.h
1 /* $Id$ */
2
3 /* xbt.h - Public interface to the xbt (gras's toolbox)                     */
4
5 /* Copyright (c) 2004 Martin Quinson.                                       */
6 /* Copyright (c) 2004 Arnaud Legrand.                                       */
7 /* All rights reserved.                                                     */
8
9 /* This program is free software; you can redistribute it and/or modify it
10  * under the terms of the license (GNU LGPL) which comes with this package. */
11
12 #ifndef XBT_MISC_H
13 #define XBT_MISC_H
14
15 /* Attributes are only in recent versions of GCC */
16 #if     __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 4)
17 # define _XBT_GNUC_PRINTF( format_idx, arg_idx )    \
18            __attribute__((__format__ (__printf__, format_idx, arg_idx)))
19 # define _XBT_GNUC_SCANF( format_idx, arg_idx )     \
20                __attribute__((__format__ (__scanf__, format_idx, arg_idx)))
21 # define _XBT_GNUC_FORMAT( arg_idx )                \
22                    __attribute__((__format_arg__ (arg_idx)))
23 # define _XBT_GNUC_NORETURN __attribute__((__noreturn__))
24 # define _XBT_GNUC_UNUSED  __attribute__((unused))
25
26 #else   /* !__GNUC__ */
27 # define _XBT_GNUC_PRINTF( format_idx, arg_idx )
28 # define _XBT_GNUC_SCANF( format_idx, arg_idx )
29 # define _XBT_GNUC_FORMAT( arg_idx )
30 # define _XBT_GNUC_NORETURN
31 # define _XBT_GNUC_UNUSED
32
33 #endif  /* !__GNUC__ */
34
35 /* inline and __FUNCTION__ are only in GCC when -ansi is off */
36
37 #if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
38 # define _XBT_FUNCTION __FUNCTION__
39 #elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
40 # define _XBT_FUNC__ __func__      /* ISO-C99 compliant */
41 #else
42 # define _XBT_FUNCTION "function"
43 #endif
44
45 #ifndef __cplusplus
46 #    if defined(__GNUC__) && ! defined(__STRICT_ANSI__)
47 #        define XBT_INLINE inline
48 #    elif (defined(__STDC__) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)
49 #        define XBT_INLINE inline
50 #    elif defined(__BORLANDC__) && !defined(__STRICT_ANSI__)
51 #        define XBT_INLINE __inline
52 #    else
53 #        define XBT_INLINE
54 #    endif
55 # else
56 #    define XBT_INLINE  inline
57 #endif
58
59 /* 
60  * Function calling convention (not used for now) 
61  */
62  
63 #ifdef _WIN32
64 #  ifndef _XBT_CALL
65 #    define _XBT_CALL __cdecl
66 #   endif
67 #else 
68 #  define _XBT_CALL
69 #endif
70
71 /* Handle import/export stuff
72  * 
73  * Rational of XBT_PUBLIC: 
74  *   * If you build the DLL you must pass the right value of XBT_PUBLIC in the project : to do this you must define the DLL_EXPORT macro
75  *   * If you do a static compilation, you must define the macro DLL_STATIC
76  *   * If you link your code against the DLL, this file defines the macro to '__declspec(dllimport)' for you
77  *   * If you compile under unix, this file defines the macro to 'extern', even if it's not mandatory with modern compilers
78  * 
79  * Rational of XBT_PUBLIC_NO_IMPORT:
80  *   * This is for symbols which must be exported in the DLL, but not imported from it. 
81  *     This is obviously useful for initialized globals (which cannot be extern or similar).
82  *     This is also used in the log mecanism where a macro creates the variable automatically.
83  *      When the macro is called from within SimGrid, the symbol must be exported, but when called 
84  *      from within the client code, it must not try to retrieve the symbol from the DLL since it's not in there.
85  */
86
87
88 #ifdef DLL_EXPORT
89 #  define XBT_PUBLIC(type)            __declspec(dllexport) type
90 #  define XBT_PUBLIC_NO_IMPORT(type)  __declspec(dllexport) type
91 #else
92 #  ifdef DLL_STATIC
93 #    define XBT_PUBLIC(type)           type
94 #    define XBT_PUBLIC_NO_IMPORT(type) type
95 #  else
96 #    ifdef _WIN32
97 #      define XBT_PUBLIC(type)           __declspec(dllimport) type 
98 #      define XBT_PUBLIC_NO_IMPORT(type) type
99 #    else
100 #      define XBT_PUBLIC(type)           extern type
101 #      define XBT_PUBLIC_NO_IMPORT(type) type
102 #    endif
103 #  endif
104 #endif 
105    
106
107
108
109 #ifndef max
110 #  define max(a, b) (((a) > (b))?(a):(b))
111 #endif
112 #ifndef min
113 #  define min(a, b) (((a) < (b))?(a):(b))
114 #endif
115
116 #define TRUE  1
117 #define FALSE 0
118
119 #define XBT_MAX_CHANNEL 10 /* FIXME: killme */
120 /*! C++ users need love */
121 #ifndef SG_BEGIN_DECL
122 # ifdef __cplusplus
123 #  define SG_BEGIN_DECL() extern "C" {
124 # else
125 #  define SG_BEGIN_DECL() 
126 # endif
127 #endif
128
129 /*! C++ users need love */
130 #ifndef SG_END_DECL
131 # ifdef __cplusplus
132 #  define SG_END_DECL() }
133 # else
134 #  define SG_END_DECL() 
135 # endif
136 #endif
137 /* End of cruft for C++ */
138
139 SG_BEGIN_DECL()
140
141 XBT_PUBLIC(const char *)xbt_procname(void);
142
143 #define XBT_BACKTRACE_SIZE 10 /* FIXME: better place? Do document */
144    
145 SG_END_DECL()
146
147 #endif /* XBT_MISC_H */
148
149
150
151