Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 1 | /* $Id$ */ |
| 2 | /* |
Benny Prijono | 844653c | 2008-12-23 17:27:53 +0000 | [diff] [blame] | 3 | * Copyright (C) 2008-2009 Teluu Inc. (http://www.teluu.com) |
| 4 | * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org> |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 19 | */ |
| 20 | #ifndef __PJ_CONFIG_H__ |
| 21 | #define __PJ_CONFIG_H__ |
| 22 | |
| 23 | /** |
| 24 | * @file config.h |
| 25 | * @brief PJLIB Main configuration settings. |
| 26 | */ |
| 27 | |
| 28 | /******************************************************************** |
| 29 | * Include compiler specific configuration. |
| 30 | */ |
| 31 | #if defined(_MSC_VER) |
| 32 | # include <pj/compat/cc_msvc.h> |
| 33 | #elif defined(__GNUC__) |
| 34 | # include <pj/compat/cc_gcc.h> |
Benny Prijono | f260e46 | 2007-04-30 21:03:32 +0000 | [diff] [blame] | 35 | #elif defined(__CW32__) |
| 36 | # include <pj/compat/cc_mwcc.h> |
| 37 | #elif defined(__MWERKS__) |
| 38 | # include <pj/compat/cc_codew.h> |
Benny Prijono | b2c9682 | 2007-05-03 13:31:21 +0000 | [diff] [blame] | 39 | #elif defined(__GCCE__) |
| 40 | # include <pj/compat/cc_gcce.h> |
| 41 | #elif defined(__ARMCC__) |
| 42 | # include <pj/compat/cc_armcc.h> |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 43 | #else |
| 44 | # error "Unknown compiler." |
| 45 | #endif |
| 46 | |
| 47 | |
| 48 | /******************************************************************** |
| 49 | * Include target OS specific configuration. |
| 50 | */ |
Benny Prijono | c4c61d0 | 2006-08-20 20:47:34 +0000 | [diff] [blame] | 51 | #if defined(PJ_AUTOCONF) |
| 52 | /* |
| 53 | * Autoconf |
| 54 | */ |
| 55 | # include <pj/compat/os_auto.h> |
| 56 | |
Benny Prijono | f260e46 | 2007-04-30 21:03:32 +0000 | [diff] [blame] | 57 | #elif defined(PJ_SYMBIAN) && PJ_SYMBIAN!=0 |
| 58 | /* |
| 59 | * SymbianOS |
| 60 | */ |
| 61 | # include <pj/compat/os_symbian.h> |
| 62 | |
Benny Prijono | c4c61d0 | 2006-08-20 20:47:34 +0000 | [diff] [blame] | 63 | #elif defined(PJ_WIN32_WINCE) || defined(_WIN32_WCE) || defined(UNDER_CE) |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 64 | /* |
| 65 | * Windows CE |
| 66 | */ |
| 67 | # undef PJ_WIN32_WINCE |
| 68 | # define PJ_WIN32_WINCE 1 |
| 69 | # include <pj/compat/os_win32_wince.h> |
| 70 | |
| 71 | /* Also define Win32 */ |
| 72 | # define PJ_WIN32 1 |
| 73 | |
| 74 | #elif defined(PJ_WIN32) || defined(_WIN32) || defined(__WIN32__) || \ |
| 75 | defined(_WIN64) || defined(WIN32) || defined(__TOS_WIN__) |
| 76 | /* |
| 77 | * Win32 |
| 78 | */ |
| 79 | # undef PJ_WIN32 |
| 80 | # define PJ_WIN32 1 |
| 81 | # include <pj/compat/os_win32.h> |
| 82 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 83 | #elif defined(PJ_LINUX_KERNEL) && PJ_LINUX_KERNEL!=0 |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 84 | /* |
| 85 | * Linux kernel |
| 86 | */ |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 87 | # include <pj/compat/os_linux_kernel.h> |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 88 | |
| 89 | #elif defined(PJ_LINUX) || defined(linux) || defined(__linux) |
| 90 | /* |
| 91 | * Linux |
| 92 | */ |
| 93 | # undef PJ_LINUX |
| 94 | # define PJ_LINUX 1 |
| 95 | # include <pj/compat/os_linux.h> |
| 96 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 97 | #elif defined(PJ_PALMOS) && PJ_PALMOS!=0 |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 98 | /* |
| 99 | * Palm |
| 100 | */ |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 101 | # include <pj/compat/os_palmos.h> |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 102 | |
| 103 | #elif defined(PJ_SUNOS) || defined(sun) || defined(__sun) |
| 104 | /* |
| 105 | * SunOS |
| 106 | */ |
| 107 | # undef PJ_SUNOS |
| 108 | # define PJ_SUNOS 1 |
| 109 | # include <pj/compat/os_sunos.h> |
| 110 | |
Benny Prijono | 5b2b445 | 2009-01-22 20:30:32 +0000 | [diff] [blame] | 111 | #elif defined(PJ_DARWINOS) || defined(__MACOSX__) || \ |
| 112 | defined (__APPLE__) || defined (__MACH__) |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 113 | /* |
| 114 | * MacOS X |
| 115 | */ |
| 116 | # undef PJ_DARWINOS |
| 117 | # define PJ_DARWINOS 1 |
| 118 | # include <pj/compat/os_darwinos.h> |
| 119 | |
Benny Prijono | 42c5b9e | 2006-05-10 19:24:40 +0000 | [diff] [blame] | 120 | #elif defined(PJ_RTEMS) && PJ_RTEMS!=0 |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 121 | /* |
| 122 | * RTEMS |
| 123 | */ |
Benny Prijono | 42c5b9e | 2006-05-10 19:24:40 +0000 | [diff] [blame] | 124 | # include <pj/compat/os_rtems.h> |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 125 | #else |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 126 | # error "Please specify target os." |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 127 | #endif |
| 128 | |
| 129 | |
| 130 | /******************************************************************** |
| 131 | * Target machine specific configuration. |
| 132 | */ |
Benny Prijono | c4c61d0 | 2006-08-20 20:47:34 +0000 | [diff] [blame] | 133 | #if defined(PJ_AUTOCONF) |
| 134 | /* |
| 135 | * Autoconf configured |
| 136 | */ |
| 137 | #include <pj/compat/m_auto.h> |
| 138 | |
| 139 | #elif defined (PJ_M_I386) || defined(_i386_) || defined(i_386_) || \ |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 140 | defined(_X86_) || defined(x86) || defined(__i386__) || \ |
| 141 | defined(__i386) || defined(_M_IX86) || defined(__I86__) |
| 142 | /* |
| 143 | * Generic i386 processor family, little-endian |
| 144 | */ |
| 145 | # undef PJ_M_I386 |
| 146 | # define PJ_M_I386 1 |
| 147 | # define PJ_M_NAME "i386" |
| 148 | # define PJ_HAS_PENTIUM 1 |
| 149 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 150 | # define PJ_IS_BIG_ENDIAN 0 |
| 151 | |
| 152 | |
| 153 | #elif defined (PJ_M_X86_64) || defined(__amd64__) || defined(__amd64) || \ |
| 154 | defined(__x86_64__) || defined(__x86_64) |
| 155 | /* |
| 156 | * AMD 64bit processor, little endian |
| 157 | */ |
| 158 | # undef PJ_M_X86_64 |
| 159 | # define PJ_M_X86_64 1 |
| 160 | # define PJ_M_NAME "x86_64" |
| 161 | # define PJ_HAS_PENTIUM 1 |
| 162 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 163 | # define PJ_IS_BIG_ENDIAN 0 |
| 164 | |
| 165 | #elif defined(PJ_M_IA64) || defined(__ia64__) || defined(_IA64) || \ |
| 166 | defined(__IA64__) || defined( _M_IA64) |
| 167 | /* |
| 168 | * Intel IA64 processor, little endian |
| 169 | */ |
| 170 | # undef PJ_M_IA64 |
| 171 | # define PJ_M_IA64 1 |
| 172 | # define PJ_M_NAME "ia64" |
| 173 | # define PJ_HAS_PENTIUM 1 |
| 174 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 175 | # define PJ_IS_BIG_ENDIAN 0 |
| 176 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 177 | #elif defined (PJ_M_M68K) && PJ_M_M68K != 0 |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 178 | |
| 179 | /* |
| 180 | * Motorola m64k processor, little endian |
| 181 | */ |
| 182 | # undef PJ_M_M68K |
| 183 | # define PJ_M_M68K 1 |
| 184 | # define PJ_M_NAME "m68k" |
| 185 | # define PJ_HAS_PENTIUM 0 |
| 186 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 187 | # define PJ_IS_BIG_ENDIAN 0 |
| 188 | |
| 189 | |
| 190 | #elif defined (PJ_M_ALPHA) || defined (__alpha__) || defined (__alpha) || \ |
| 191 | defined (_M_ALPHA) |
| 192 | /* |
| 193 | * DEC Alpha processor, little endian |
| 194 | */ |
| 195 | # undef PJ_M_ALPHA |
| 196 | # define PJ_M_ALPHA 1 |
| 197 | # define PJ_M_NAME "alpha" |
| 198 | # define PJ_HAS_PENTIUM 0 |
| 199 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 200 | # define PJ_IS_BIG_ENDIAN 0 |
| 201 | |
| 202 | |
Benny Prijono | d79f25c | 2006-08-02 19:41:37 +0000 | [diff] [blame] | 203 | #elif defined(PJ_M_MIPS) || defined(__mips__) || defined(__mips) || \ |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 204 | defined(__MIPS__) || defined(MIPS) || defined(_MIPS_) |
| 205 | /* |
Benny Prijono | d79f25c | 2006-08-02 19:41:37 +0000 | [diff] [blame] | 206 | * MIPS, default to little endian |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 207 | */ |
| 208 | # undef PJ_M_MIPS |
| 209 | # define PJ_M_MIPS 1 |
| 210 | # define PJ_M_NAME "mips" |
| 211 | # define PJ_HAS_PENTIUM 0 |
Benny Prijono | d79f25c | 2006-08-02 19:41:37 +0000 | [diff] [blame] | 212 | # if !defined(PJ_IS_LITTLE_ENDIAN) && !defined(PJ_IS_BIG_ENDIAN) |
| 213 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 214 | # define PJ_IS_BIG_ENDIAN 0 |
| 215 | # endif |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 216 | |
| 217 | |
| 218 | #elif defined (PJ_M_SPARC) || defined( __sparc__) || defined(__sparc) |
| 219 | /* |
| 220 | * Sun Sparc, big endian |
| 221 | */ |
| 222 | # undef PJ_M_SPARC |
| 223 | # define PJ_M_SPARC 1 |
| 224 | # define PJ_M_NAME "sparc" |
| 225 | # define PJ_HAS_PENTIUM 0 |
| 226 | # define PJ_IS_LITTLE_ENDIAN 0 |
| 227 | # define PJ_IS_BIG_ENDIAN 1 |
| 228 | |
| 229 | #elif defined (PJ_M_ARMV4) || defined(ARM) || defined(_ARM_) || \ |
| 230 | defined(ARMV4) || defined(__arm__) |
| 231 | /* |
Benny Prijono | 8f9faae | 2006-08-04 17:18:37 +0000 | [diff] [blame] | 232 | * ARM, default to little endian |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 233 | */ |
| 234 | # undef PJ_M_ARMV4 |
| 235 | # define PJ_M_ARMV4 1 |
| 236 | # define PJ_M_NAME "armv4" |
| 237 | # define PJ_HAS_PENTIUM 0 |
| 238 | # if !defined(PJ_IS_LITTLE_ENDIAN) && !defined(PJ_IS_BIG_ENDIAN) |
| 239 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 240 | # define PJ_IS_BIG_ENDIAN 0 |
| 241 | # endif |
| 242 | |
| 243 | #elif defined (PJ_M_POWERPC) || defined(__powerpc) || defined(__powerpc__) || \ |
| 244 | defined(__POWERPC__) || defined(__ppc__) || defined(_M_PPC) || \ |
| 245 | defined(_ARCH_PPC) |
| 246 | /* |
| 247 | * PowerPC, big endian |
| 248 | */ |
| 249 | # undef PJ_M_POWERPC |
| 250 | # define PJ_M_POWERPC 1 |
| 251 | # define PJ_M_NAME "powerpc" |
| 252 | # define PJ_HAS_PENTIUM 0 |
Benny Prijono | d79f25c | 2006-08-02 19:41:37 +0000 | [diff] [blame] | 253 | # define PJ_IS_LITTLE_ENDIAN 0 |
| 254 | # define PJ_IS_BIG_ENDIAN 1 |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 255 | |
Benny Prijono | 93713fb | 2008-05-07 13:28:06 +0000 | [diff] [blame] | 256 | #elif defined (PJ_M_NIOS2) || defined(__nios2) || defined(__nios2__) || \ |
| 257 | defined(__NIOS2__) || defined(__M_NIOS2) || defined(_ARCH_NIOS2) |
| 258 | /* |
| 259 | * Nios2, little endian |
| 260 | */ |
| 261 | # undef PJ_M_NIOS2 |
| 262 | # define PJ_M_NIOS2 1 |
| 263 | # define PJ_M_NAME "nios2" |
| 264 | # define PJ_HAS_PENTIUM 0 |
| 265 | # define PJ_IS_LITTLE_ENDIAN 1 |
| 266 | # define PJ_IS_BIG_ENDIAN 0 |
| 267 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 268 | #else |
Benny Prijono | c4c8f24 | 2006-08-01 23:01:55 +0000 | [diff] [blame] | 269 | # error "Please specify target machine." |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 270 | #endif |
| 271 | |
| 272 | /* Include size_t definition. */ |
| 273 | #include <pj/compat/size_t.h> |
| 274 | |
| 275 | /* Include site/user specific configuration to control PJLIB features. |
| 276 | * YOU MUST CREATE THIS FILE YOURSELF!! |
| 277 | */ |
| 278 | #include <pj/config_site.h> |
| 279 | |
| 280 | /******************************************************************** |
| 281 | * PJLIB Features. |
| 282 | */ |
| 283 | |
| 284 | /* Overrides for DOXYGEN */ |
| 285 | #ifdef DOXYGEN |
| 286 | # undef PJ_FUNCTIONS_ARE_INLINED |
| 287 | # undef PJ_HAS_FLOATING_POINT |
| 288 | # undef PJ_LOG_MAX_LEVEL |
| 289 | # undef PJ_LOG_MAX_SIZE |
| 290 | # undef PJ_LOG_USE_STACK_BUFFER |
| 291 | # undef PJ_TERM_HAS_COLOR |
| 292 | # undef PJ_POOL_DEBUG |
| 293 | # undef PJ_HAS_TCP |
| 294 | # undef PJ_MAX_HOSTNAME |
| 295 | # undef PJ_IOQUEUE_MAX_HANDLES |
| 296 | # undef FD_SETSIZE |
| 297 | # undef PJ_HAS_SEMAPHORE |
| 298 | # undef PJ_HAS_EVENT_OBJ |
| 299 | # undef PJ_ENABLE_EXTRA_CHECK |
Benny Prijono | 99683ae | 2005-11-21 16:59:47 +0000 | [diff] [blame] | 300 | # undef PJ_EXCEPTION_USE_WIN32_SEH |
Benny Prijono | 1185299 | 2006-03-18 12:28:03 +0000 | [diff] [blame] | 301 | # undef PJ_HAS_ERROR_STRING |
Benny Prijono | e3f79fd | 2008-02-13 15:17:28 +0000 | [diff] [blame] | 302 | |
| 303 | # define PJ_HAS_IPV6 1 |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 304 | #endif |
| 305 | |
| 306 | /** |
| 307 | * @defgroup pj_config Build Configuration |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 308 | * @{ |
| 309 | * |
| 310 | * This section contains macros that can set during PJLIB build process |
| 311 | * to controll various aspects of the library. |
| 312 | * |
| 313 | * <b>Note</b>: the values in this page does NOT necessarily reflect to the |
| 314 | * macro values during the build process. |
| 315 | */ |
| 316 | |
| 317 | /** |
| 318 | * If this macro is set to 1, it will enable some debugging checking |
| 319 | * in the library. |
| 320 | * |
| 321 | * Default: equal to (NOT NDEBUG). |
| 322 | */ |
| 323 | #ifndef PJ_DEBUG |
| 324 | # ifndef NDEBUG |
| 325 | # define PJ_DEBUG 1 |
| 326 | # else |
| 327 | # define PJ_DEBUG 0 |
| 328 | # endif |
| 329 | #endif |
| 330 | |
| 331 | /** |
Benny Prijono | be6d5db | 2009-07-22 11:12:35 +0000 | [diff] [blame] | 332 | * Enable this macro to activate logging to mutex/semaphore related events. |
| 333 | * This is useful to troubleshoot concurrency problems such as deadlocks. |
| 334 | * In addition, you should also add PJ_LOG_HAS_THREAD_ID flag to the |
| 335 | * log decoration to assist the troubleshooting. |
| 336 | * |
| 337 | * Default: 0 |
| 338 | */ |
| 339 | #ifndef PJ_DEBUG_MUTEX |
| 340 | # define PJ_DEBUG_MUTEX 0 |
| 341 | #endif |
| 342 | |
| 343 | /** |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 344 | * Expand functions in *_i.h header files as inline. |
| 345 | * |
| 346 | * Default: 0. |
| 347 | */ |
| 348 | #ifndef PJ_FUNCTIONS_ARE_INLINED |
| 349 | # define PJ_FUNCTIONS_ARE_INLINED 0 |
| 350 | #endif |
| 351 | |
| 352 | /** |
| 353 | * Use floating point computations in the library. |
| 354 | * |
| 355 | * Default: 1. |
| 356 | */ |
| 357 | #ifndef PJ_HAS_FLOATING_POINT |
| 358 | # define PJ_HAS_FLOATING_POINT 1 |
| 359 | #endif |
| 360 | |
| 361 | /** |
| 362 | * Declare maximum logging level/verbosity. Lower number indicates higher |
| 363 | * importance, with the highest importance has level zero. The least |
| 364 | * important level is five in this implementation, but this can be extended |
| 365 | * by supplying the appropriate implementation. |
| 366 | * |
| 367 | * The level conventions: |
| 368 | * - 0: fatal error |
| 369 | * - 1: error |
| 370 | * - 2: warning |
| 371 | * - 3: info |
| 372 | * - 4: debug |
| 373 | * - 5: trace |
| 374 | * - 6: more detailed trace |
| 375 | * |
| 376 | * Default: 4 |
| 377 | */ |
| 378 | #ifndef PJ_LOG_MAX_LEVEL |
| 379 | # define PJ_LOG_MAX_LEVEL 5 |
| 380 | #endif |
| 381 | |
| 382 | /** |
| 383 | * Maximum message size that can be sent to output device for each call |
| 384 | * to PJ_LOG(). If the message size is longer than this value, it will be cut. |
| 385 | * This may affect the stack usage, depending whether PJ_LOG_USE_STACK_BUFFER |
| 386 | * flag is set. |
| 387 | * |
Benny Prijono | dc752ca | 2006-09-22 16:55:42 +0000 | [diff] [blame] | 388 | * Default: 2000 |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 389 | */ |
| 390 | #ifndef PJ_LOG_MAX_SIZE |
Benny Prijono | dc752ca | 2006-09-22 16:55:42 +0000 | [diff] [blame] | 391 | # define PJ_LOG_MAX_SIZE 2000 |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 392 | #endif |
| 393 | |
| 394 | /** |
| 395 | * Log buffer. |
| 396 | * Does the log get the buffer from the stack? (default is yes). |
| 397 | * If the value is set to NO, then the buffer will be taken from static |
| 398 | * buffer, which in this case will make the log function non-reentrant. |
| 399 | * |
| 400 | * Default: 1 |
| 401 | */ |
| 402 | #ifndef PJ_LOG_USE_STACK_BUFFER |
| 403 | # define PJ_LOG_USE_STACK_BUFFER 1 |
| 404 | #endif |
| 405 | |
| 406 | |
| 407 | /** |
| 408 | * Colorfull terminal (for logging etc). |
| 409 | * |
| 410 | * Default: 1 |
| 411 | */ |
| 412 | #ifndef PJ_TERM_HAS_COLOR |
| 413 | # define PJ_TERM_HAS_COLOR 1 |
| 414 | #endif |
| 415 | |
Benny Prijono | 8508aa0 | 2006-03-30 15:56:01 +0000 | [diff] [blame] | 416 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 417 | /** |
Benny Prijono | ba4abc9 | 2007-06-01 07:26:21 +0000 | [diff] [blame] | 418 | * Set this flag to non-zero to enable various checking for pool |
| 419 | * operations. When this flag is set, assertion must be enabled |
| 420 | * in the application. |
| 421 | * |
| 422 | * This will slow down pool creation and destruction and will add |
| 423 | * few bytes of overhead, so application would normally want to |
| 424 | * disable this feature on release build. |
| 425 | * |
| 426 | * Default: 0 |
| 427 | */ |
| 428 | #ifndef PJ_SAFE_POOL |
| 429 | # define PJ_SAFE_POOL 0 |
| 430 | #endif |
| 431 | |
| 432 | |
| 433 | /** |
Benny Prijono | 8508aa0 | 2006-03-30 15:56:01 +0000 | [diff] [blame] | 434 | * If pool debugging is used, then each memory allocation from the pool |
| 435 | * will call malloc(), and pool will release all memory chunks when it |
| 436 | * is destroyed. This works better when memory verification programs |
| 437 | * such as Rational Purify is used. |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 438 | * |
| 439 | * Default: 0 |
| 440 | */ |
| 441 | #ifndef PJ_POOL_DEBUG |
| 442 | # define PJ_POOL_DEBUG 0 |
| 443 | #endif |
| 444 | |
Benny Prijono | 8508aa0 | 2006-03-30 15:56:01 +0000 | [diff] [blame] | 445 | |
| 446 | /** |
Benny Prijono | 42c5b9e | 2006-05-10 19:24:40 +0000 | [diff] [blame] | 447 | * Specify this as \a stack_size argument in #pj_thread_create() to specify |
| 448 | * that thread should use default stack size for the current platform. |
| 449 | * |
| 450 | * Default: 8192 |
| 451 | */ |
| 452 | #ifndef PJ_THREAD_DEFAULT_STACK_SIZE |
| 453 | # define PJ_THREAD_DEFAULT_STACK_SIZE 8192 |
| 454 | #endif |
| 455 | |
| 456 | |
| 457 | /** |
Benny Prijono | 467edf0 | 2008-01-02 07:56:38 +0000 | [diff] [blame] | 458 | * Specify if PJ_CHECK_STACK() macro is enabled to check the sanity of |
| 459 | * the stack. The OS implementation may check that no stack overflow |
| 460 | * occurs, and it also may collect statistic about stack usage. Note |
| 461 | * that this will increase the footprint of the libraries since it |
| 462 | * tracks the filename and line number of each functions. |
| 463 | */ |
| 464 | #ifndef PJ_OS_HAS_CHECK_STACK |
| 465 | # define PJ_OS_HAS_CHECK_STACK 0 |
| 466 | #endif |
| 467 | |
| 468 | /** |
Benny Prijono | 8508aa0 | 2006-03-30 15:56:01 +0000 | [diff] [blame] | 469 | * Do we have alternate pool implementation? |
| 470 | * |
| 471 | * Default: 0 |
| 472 | */ |
| 473 | #ifndef PJ_HAS_POOL_ALT_API |
| 474 | # define PJ_HAS_POOL_ALT_API PJ_POOL_DEBUG |
| 475 | #endif |
| 476 | |
| 477 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 478 | /** |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 479 | * Support TCP in the library. |
| 480 | * Disabling TCP will reduce the footprint slightly (about 6KB). |
| 481 | * |
| 482 | * Default: 1 |
| 483 | */ |
| 484 | #ifndef PJ_HAS_TCP |
| 485 | # define PJ_HAS_TCP 1 |
| 486 | #endif |
| 487 | |
| 488 | /** |
Benny Prijono | c16c6e3 | 2007-11-18 14:53:47 +0000 | [diff] [blame] | 489 | * Support IPv6 in the library. If this support is disabled, some IPv6 |
| 490 | * related functions will return PJ_EIPV6NOTSUP. |
| 491 | * |
| 492 | * Default: 0 (disabled, for now) |
| 493 | */ |
| 494 | #ifndef PJ_HAS_IPV6 |
| 495 | # define PJ_HAS_IPV6 0 |
| 496 | #endif |
| 497 | |
| 498 | /** |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 499 | * Maximum hostname length. |
| 500 | * Libraries sometimes needs to make copy of an address to stack buffer; |
| 501 | * the value here affects the stack usage. |
| 502 | * |
| 503 | * Default: 128 |
| 504 | */ |
| 505 | #ifndef PJ_MAX_HOSTNAME |
| 506 | # define PJ_MAX_HOSTNAME (128) |
| 507 | #endif |
| 508 | |
| 509 | /** |
| 510 | * Constants for declaring the maximum handles that can be supported by |
| 511 | * a single IOQ framework. This constant might not be relevant to the |
| 512 | * underlying I/O queue impelementation, but still, developers should be |
| 513 | * aware of this constant, to make sure that the program will not break when |
| 514 | * the underlying implementation changes. |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 515 | */ |
| 516 | #ifndef PJ_IOQUEUE_MAX_HANDLES |
Benny Prijono | 40fe908 | 2008-02-08 15:21:41 +0000 | [diff] [blame] | 517 | # define PJ_IOQUEUE_MAX_HANDLES (64) |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 518 | #endif |
| 519 | |
Benny Prijono | 8508aa0 | 2006-03-30 15:56:01 +0000 | [diff] [blame] | 520 | |
| 521 | /** |
| 522 | * If PJ_IOQUEUE_HAS_SAFE_UNREG macro is defined, then ioqueue will do more |
| 523 | * things to ensure thread safety of handle unregistration operation by |
| 524 | * employing reference counter to each handle. |
| 525 | * |
| 526 | * In addition, the ioqueue will preallocate memory for the handles, |
| 527 | * according to the maximum number of handles that is specified during |
| 528 | * ioqueue creation. |
| 529 | * |
| 530 | * All applications would normally want this enabled, but you may disable |
| 531 | * this if: |
| 532 | * - there is no dynamic unregistration to all ioqueues. |
| 533 | * - there is no threading, or there is no preemptive multitasking. |
| 534 | * |
| 535 | * Default: 1 |
| 536 | */ |
| 537 | #ifndef PJ_IOQUEUE_HAS_SAFE_UNREG |
| 538 | # define PJ_IOQUEUE_HAS_SAFE_UNREG 1 |
| 539 | #endif |
| 540 | |
| 541 | |
| 542 | /** |
Benny Prijono | e3f79fd | 2008-02-13 15:17:28 +0000 | [diff] [blame] | 543 | * Default concurrency setting for sockets/handles registered to ioqueue. |
| 544 | * This controls whether the ioqueue is allowed to call the key's callback |
| 545 | * concurrently/in parallel. The default is yes, which means that if there |
| 546 | * are more than one pending operations complete simultaneously, more |
| 547 | * than one threads may call the key's callback at the same time. This |
| 548 | * generally would promote good scalability for application, at the |
| 549 | * expense of more complexity to manage the concurrent accesses. |
| 550 | * |
| 551 | * Please see the ioqueue documentation for more info. |
| 552 | */ |
| 553 | #ifndef PJ_IOQUEUE_DEFAULT_ALLOW_CONCURRENCY |
| 554 | # define PJ_IOQUEUE_DEFAULT_ALLOW_CONCURRENCY 1 |
| 555 | #endif |
| 556 | |
| 557 | |
| 558 | /* Sanity check: |
| 559 | * if ioqueue concurrency is disallowed, PJ_IOQUEUE_HAS_SAFE_UNREG |
| 560 | * must be enabled. |
| 561 | */ |
| 562 | #if (PJ_IOQUEUE_DEFAULT_ALLOW_CONCURRENCY==0) && (PJ_IOQUEUE_HAS_SAFE_UNREG==0) |
| 563 | # error PJ_IOQUEUE_HAS_SAFE_UNREG must be enabled if ioqueue concurrency \ |
| 564 | is disabled |
| 565 | #endif |
| 566 | |
| 567 | |
| 568 | /** |
Benny Prijono | 8508aa0 | 2006-03-30 15:56:01 +0000 | [diff] [blame] | 569 | * When safe unregistration (PJ_IOQUEUE_HAS_SAFE_UNREG) is configured in |
| 570 | * ioqueue, the PJ_IOQUEUE_KEY_FREE_DELAY macro specifies how long the |
| 571 | * ioqueue key is kept in closing state before it can be reused. |
| 572 | * |
| 573 | * The value is in miliseconds. |
| 574 | * |
| 575 | * Default: 500 msec. |
| 576 | */ |
| 577 | #ifndef PJ_IOQUEUE_KEY_FREE_DELAY |
| 578 | # define PJ_IOQUEUE_KEY_FREE_DELAY 500 |
| 579 | #endif |
| 580 | |
| 581 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 582 | /** |
Benny Prijono | 1c5f4e4 | 2008-02-07 13:11:39 +0000 | [diff] [blame] | 583 | * Determine if FD_SETSIZE is changeable/set-able. If so, then we will |
Benny Prijono | 40fe908 | 2008-02-08 15:21:41 +0000 | [diff] [blame] | 584 | * set it to PJ_IOQUEUE_MAX_HANDLES. Currently we detect this by checking |
| 585 | * for Winsock. |
Benny Prijono | 1c5f4e4 | 2008-02-07 13:11:39 +0000 | [diff] [blame] | 586 | */ |
Benny Prijono | 40fe908 | 2008-02-08 15:21:41 +0000 | [diff] [blame] | 587 | #ifndef PJ_FD_SETSIZE_SETABLE |
Benny Prijono | 57affd0 | 2008-02-18 12:22:15 +0000 | [diff] [blame] | 588 | # if (defined(PJ_HAS_WINSOCK_H) && PJ_HAS_WINSOCK_H!=0) || \ |
| 589 | (defined(PJ_HAS_WINSOCK2_H) && PJ_HAS_WINSOCK2_H!=0) |
Benny Prijono | 40fe908 | 2008-02-08 15:21:41 +0000 | [diff] [blame] | 590 | # define PJ_FD_SETSIZE_SETABLE 1 |
| 591 | # else |
| 592 | # define PJ_FD_SETSIZE_SETABLE 0 |
| 593 | # endif |
Benny Prijono | 1c5f4e4 | 2008-02-07 13:11:39 +0000 | [diff] [blame] | 594 | #endif |
| 595 | |
| 596 | /** |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 597 | * Overrides FD_SETSIZE so it is consistent throughout the library. |
Benny Prijono | 40fe908 | 2008-02-08 15:21:41 +0000 | [diff] [blame] | 598 | * We only do this if we detected that FD_SETSIZE is changeable. If |
| 599 | * FD_SETSIZE is not set-able, then PJ_IOQUEUE_MAX_HANDLES must be |
| 600 | * set to value lower than FD_SETSIZE. |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 601 | */ |
Benny Prijono | 1c5f4e4 | 2008-02-07 13:11:39 +0000 | [diff] [blame] | 602 | #if PJ_FD_SETSIZE_SETABLE |
| 603 | /* Only override FD_SETSIZE if the value has not been set */ |
| 604 | # ifndef FD_SETSIZE |
| 605 | # define FD_SETSIZE PJ_IOQUEUE_MAX_HANDLES |
| 606 | # endif |
| 607 | #else |
| 608 | /* When FD_SETSIZE is not changeable, check if PJ_IOQUEUE_MAX_HANDLES |
| 609 | * is lower than FD_SETSIZE value. |
| 610 | */ |
| 611 | # ifdef FD_SETSIZE |
| 612 | # if PJ_IOQUEUE_MAX_HANDLES > FD_SETSIZE |
| 613 | # error "PJ_IOQUEUE_MAX_HANDLES is greater than FD_SETSIZE" |
| 614 | # endif |
| 615 | # endif |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 616 | #endif |
| 617 | |
Benny Prijono | 1c5f4e4 | 2008-02-07 13:11:39 +0000 | [diff] [blame] | 618 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 619 | /** |
Benny Prijono | 1d6b895 | 2008-07-07 21:31:02 +0000 | [diff] [blame] | 620 | * Specify whether #pj_enum_ip_interface() function should exclude |
| 621 | * loopback interfaces. |
| 622 | * |
| 623 | * Default: 1 |
| 624 | */ |
| 625 | #ifndef PJ_IP_HELPER_IGNORE_LOOPBACK_IF |
| 626 | # define PJ_IP_HELPER_IGNORE_LOOPBACK_IF 1 |
| 627 | #endif |
| 628 | |
| 629 | |
| 630 | /** |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 631 | * Has semaphore functionality? |
| 632 | * |
| 633 | * Default: 1 |
| 634 | */ |
| 635 | #ifndef PJ_HAS_SEMAPHORE |
| 636 | # define PJ_HAS_SEMAPHORE 1 |
| 637 | #endif |
| 638 | |
| 639 | |
| 640 | /** |
| 641 | * Event object (for synchronization, e.g. in Win32) |
| 642 | * |
| 643 | * Default: 1 |
| 644 | */ |
| 645 | #ifndef PJ_HAS_EVENT_OBJ |
| 646 | # define PJ_HAS_EVENT_OBJ 1 |
| 647 | #endif |
| 648 | |
| 649 | |
| 650 | /** |
Benny Prijono | a66c331 | 2007-01-21 23:12:40 +0000 | [diff] [blame] | 651 | * Maximum file name length. |
| 652 | */ |
| 653 | #ifndef PJ_MAXPATH |
| 654 | # define PJ_MAXPATH 260 |
| 655 | #endif |
| 656 | |
| 657 | |
| 658 | /** |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 659 | * Enable library's extra check. |
| 660 | * If this macro is enabled, #PJ_ASSERT_RETURN macro will expand to |
| 661 | * run-time checking. If this macro is disabled, #PJ_ASSERT_RETURN |
| 662 | * will simply evaluate to #pj_assert(). |
| 663 | * |
| 664 | * You can disable this macro to reduce size, at the risk of crashes |
| 665 | * if invalid value (e.g. NULL) is passed to the library. |
| 666 | * |
| 667 | * Default: 1 |
| 668 | */ |
| 669 | #ifndef PJ_ENABLE_EXTRA_CHECK |
| 670 | # define PJ_ENABLE_EXTRA_CHECK 1 |
| 671 | #endif |
| 672 | |
| 673 | |
| 674 | /** |
| 675 | * Enable name registration for exceptions with #pj_exception_id_alloc(). |
| 676 | * If this feature is enabled, then the library will keep track of |
| 677 | * names associated with each exception ID requested by application via |
| 678 | * #pj_exception_id_alloc(). |
| 679 | * |
| 680 | * Disabling this macro will reduce the code and .bss size by a tad bit. |
| 681 | * See also #PJ_MAX_EXCEPTION_ID. |
| 682 | * |
| 683 | * Default: 1 |
| 684 | */ |
| 685 | #ifndef PJ_HAS_EXCEPTION_NAMES |
| 686 | # define PJ_HAS_EXCEPTION_NAMES 1 |
| 687 | #endif |
| 688 | |
| 689 | /** |
| 690 | * Maximum number of unique exception IDs that can be requested |
| 691 | * with #pj_exception_id_alloc(). For each entry, a small record will |
| 692 | * be allocated in the .bss segment. |
| 693 | * |
| 694 | * Default: 16 |
| 695 | */ |
| 696 | #ifndef PJ_MAX_EXCEPTION_ID |
| 697 | # define PJ_MAX_EXCEPTION_ID 16 |
| 698 | #endif |
| 699 | |
Benny Prijono | 99683ae | 2005-11-21 16:59:47 +0000 | [diff] [blame] | 700 | /** |
| 701 | * Should we use Windows Structured Exception Handling (SEH) for the |
| 702 | * PJLIB exceptions. |
| 703 | * |
| 704 | * Default: 0 |
| 705 | */ |
| 706 | #ifndef PJ_EXCEPTION_USE_WIN32_SEH |
| 707 | # define PJ_EXCEPTION_USE_WIN32_SEH 0 |
| 708 | #endif |
| 709 | |
| 710 | /** |
| 711 | * Should we attempt to use Pentium's rdtsc for high resolution |
| 712 | * timestamp. |
| 713 | * |
| 714 | * Default: 0 |
| 715 | */ |
| 716 | #ifndef PJ_TIMESTAMP_USE_RDTSC |
| 717 | # define PJ_TIMESTAMP_USE_RDTSC 0 |
| 718 | #endif |
| 719 | |
Benny Prijono | 1185299 | 2006-03-18 12:28:03 +0000 | [diff] [blame] | 720 | /** |
Benny Prijono | 5d54264 | 2007-05-02 18:54:19 +0000 | [diff] [blame] | 721 | * Is native platform error positive number? |
| 722 | * Default: 1 (yes) |
| 723 | */ |
| 724 | #ifndef PJ_NATIVE_ERR_POSITIVE |
| 725 | # define PJ_NATIVE_ERR_POSITIVE 1 |
| 726 | #endif |
| 727 | |
| 728 | /** |
Benny Prijono | 1185299 | 2006-03-18 12:28:03 +0000 | [diff] [blame] | 729 | * Include error message string in the library (pj_strerror()). |
| 730 | * This is very much desirable! |
| 731 | * |
| 732 | * Default: 1 |
| 733 | */ |
| 734 | #ifndef PJ_HAS_ERROR_STRING |
| 735 | # define PJ_HAS_ERROR_STRING 1 |
| 736 | #endif |
| 737 | |
Benny Prijono | 99683ae | 2005-11-21 16:59:47 +0000 | [diff] [blame] | 738 | |
Benny Prijono | dcf2996 | 2006-03-23 18:03:40 +0000 | [diff] [blame] | 739 | /** |
| 740 | * Include pj_stricmp_alnum() and pj_strnicmp_alnum(), i.e. custom |
| 741 | * functions to compare alnum strings. On some systems, they're faster |
| 742 | * then stricmp/strcasecmp, but they can be slower on other systems. |
| 743 | * When disabled, pjlib will fallback to stricmp/strnicmp. |
| 744 | * |
| 745 | * Default: 0 |
| 746 | */ |
| 747 | #ifndef PJ_HAS_STRICMP_ALNUM |
| 748 | # define PJ_HAS_STRICMP_ALNUM 0 |
| 749 | #endif |
| 750 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 751 | /** @} */ |
| 752 | |
| 753 | /******************************************************************** |
| 754 | * General macros. |
| 755 | */ |
| 756 | |
| 757 | /** |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 758 | * @defgroup pj_dll_target Building Dynamic Link Libraries (DLL/DSO) |
| 759 | * @ingroup pj_config |
| 760 | * @{ |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 761 | * |
| 762 | * The libraries support generation of dynamic link libraries for |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 763 | * Symbian ABIv2 target (.dso/Dynamic Shared Object files, in Symbian |
| 764 | * terms). Similar procedures may be applied for Win32 DLL with some |
| 765 | * modification. |
| 766 | * |
| 767 | * Depending on the platforms, these steps may be necessary in order to |
| 768 | * produce the dynamic libraries: |
| 769 | * - Create the (Visual Studio) projects to produce DLL output. PJLIB |
| 770 | * does not provide ready to use project files to produce DLL, so |
| 771 | * you need to create these projects yourself. For Symbian, the MMP |
| 772 | * files have been setup to produce DSO files for targets that |
| 773 | * require them. |
| 774 | * - In the (Visual Studio) projects, some macros need to be declared |
| 775 | * so that appropriate modifiers are added to symbol declarations |
| 776 | * and definitions. Please see the macro section below for information |
| 777 | * regarding these macros. For Symbian, these have been taken care by the |
| 778 | * MMP files. |
| 779 | * - Some build systems require .DEF file to be specified when creating |
| 780 | * the DLL. For Symbian, .DEF files are included in pjlib distribution, |
| 781 | * in <tt>pjlib/build.symbian</tt> directory. These DEF files are |
| 782 | * created by running <tt>./makedef.sh all</tt> from this directory, |
| 783 | * inside Mingw. |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 784 | * |
| 785 | * Macros related for building DLL/DSO files: |
| 786 | * - For platforms that supports dynamic link libraries generation, |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 787 | * it must declare <tt>PJ_EXPORT_SPECIFIER</tt> macro which value contains |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 788 | * the prefix to be added to symbol definition, to export this |
| 789 | * symbol in the DLL/DSO. For example, on Win32/Visual Studio, the |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 790 | * value of this macro is \a __declspec(dllexport), and for ARM |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 791 | * ABIv2/Symbian, the value is \a EXPORT_C. |
| 792 | * - For platforms that supports linking with dynamic link libraries, |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 793 | * it must declare <tt>PJ_IMPORT_SPECIFIER</tt> macro which value contains |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 794 | * the prefix to be added to symbol declaration, to import this |
| 795 | * symbol from a DLL/DSO. For example, on Win32/Visual Studio, the |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 796 | * value of this macro is \a __declspec(dllimport), and for ARM |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 797 | * ABIv2/Symbian, the value is \a IMPORT_C. |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 798 | * - Both <tt>PJ_EXPORT_SPECIFIER</tt> and <tt>PJ_IMPORT_SPECIFIER</tt> |
| 799 | * macros above can be declared in your \a config_site.h if they are not |
| 800 | * declared by pjlib. |
| 801 | * - When PJLIB is built as DLL/DSO, both <tt>PJ_DLL</tt> and |
| 802 | * <tt>PJ_EXPORTING</tt> macros must be declared, so that |
| 803 | * <tt>PJ_EXPORT_SPECIFIER</tt> modifier will be added into function |
| 804 | * definition. |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 805 | * - When application wants to link dynamically with PJLIB, then it |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 806 | * must declare <tt>PJ_DLL</tt> macro when using/including PJLIB header, |
| 807 | * so that <tt>PJ_IMPORT_SPECIFIER</tt> modifier is properly added into |
| 808 | * symbol declarations. |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 809 | * |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 810 | * When <b>PJ_DLL</b> macro is not declared, static linking is assumed. |
| 811 | * |
| 812 | * For example, here are some settings to produce DLLs with Visual Studio |
| 813 | * on Windows/Win32: |
| 814 | * - Create Visual Studio projects to produce DLL. Add the appropriate |
| 815 | * project dependencies to avoid link errors. |
| 816 | * - In the projects, declare <tt>PJ_DLL</tt> and <tt>PJ_EXPORTING</tt> |
| 817 | * macros. |
| 818 | * - Declare these macros in your <tt>config_site.h</tt>: |
| 819 | \verbatim |
| 820 | #define PJ_EXPORT_SPECIFIER __declspec(dllexport) |
| 821 | #define PJ_IMPORT_SPECIFIER __declspec(dllimport) |
| 822 | \endverbatim |
| 823 | * - And in the application (that links with the DLL) project, add |
| 824 | * <tt>PJ_DLL</tt> in the macro declarations. |
| 825 | */ |
| 826 | |
| 827 | /** @} */ |
| 828 | |
| 829 | /** |
| 830 | * @defgroup pj_config Build Configuration |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 831 | * @{ |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 832 | */ |
| 833 | |
| 834 | /** |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 835 | * @def PJ_INLINE(type) |
| 836 | * @param type The return type of the function. |
| 837 | * Expand the function as inline. |
| 838 | */ |
| 839 | #define PJ_INLINE(type) PJ_INLINE_SPECIFIER type |
| 840 | |
| 841 | /** |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 842 | * This macro declares platform/compiler specific specifier prefix |
| 843 | * to be added to symbol declaration to export the symbol when PJLIB |
| 844 | * is built as dynamic library. |
| 845 | * |
| 846 | * This macro should have been added by platform specific headers, |
| 847 | * if the platform supports building dynamic library target. |
| 848 | */ |
| 849 | #ifndef PJ_EXPORT_DECL_SPECIFIER |
| 850 | # define PJ_EXPORT_DECL_SPECIFIER |
| 851 | #endif |
| 852 | |
| 853 | |
| 854 | /** |
| 855 | * This macro declares platform/compiler specific specifier prefix |
| 856 | * to be added to symbol definition to export the symbol when PJLIB |
| 857 | * is built as dynamic library. |
| 858 | * |
| 859 | * This macro should have been added by platform specific headers, |
| 860 | * if the platform supports building dynamic library target. |
| 861 | */ |
| 862 | #ifndef PJ_EXPORT_DEF_SPECIFIER |
| 863 | # define PJ_EXPORT_DEF_SPECIFIER |
| 864 | #endif |
| 865 | |
| 866 | |
| 867 | /** |
| 868 | * This macro declares platform/compiler specific specifier prefix |
| 869 | * to be added to symbol declaration to import the symbol. |
| 870 | * |
| 871 | * This macro should have been added by platform specific headers, |
| 872 | * if the platform supports building dynamic library target. |
| 873 | */ |
| 874 | #ifndef PJ_IMPORT_DECL_SPECIFIER |
| 875 | # define PJ_IMPORT_DECL_SPECIFIER |
| 876 | #endif |
| 877 | |
| 878 | |
| 879 | /** |
| 880 | * This macro has been deprecated. It will evaluate to nothing. |
| 881 | */ |
| 882 | #ifndef PJ_EXPORT_SYMBOL |
| 883 | # define PJ_EXPORT_SYMBOL(x) |
| 884 | #endif |
| 885 | |
| 886 | |
| 887 | /** |
| 888 | * @def PJ_DECL(type) |
| 889 | * @param type The return type of the function. |
| 890 | * Declare a function. |
| 891 | */ |
| 892 | #if defined(PJ_DLL) |
| 893 | # if defined(PJ_EXPORTING) |
| 894 | # define PJ_DECL(type) PJ_EXPORT_DECL_SPECIFIER type |
| 895 | # else |
| 896 | # define PJ_DECL(type) PJ_IMPORT_DECL_SPECIFIER type |
| 897 | # endif |
| 898 | #elif !defined(PJ_DECL) |
| 899 | # if defined(__cplusplus) |
| 900 | # define PJ_DECL(type) type |
| 901 | # else |
| 902 | # define PJ_DECL(type) extern type |
| 903 | # endif |
| 904 | #endif |
| 905 | |
| 906 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 907 | /** |
| 908 | * @def PJ_DEF(type) |
| 909 | * @param type The return type of the function. |
| 910 | * Define a function. |
| 911 | */ |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 912 | #if defined(PJ_DLL) && defined(PJ_EXPORTING) |
| 913 | # define PJ_DEF(type) PJ_EXPORT_DEF_SPECIFIER type |
| 914 | #elif !defined(PJ_DEF) |
| 915 | # define PJ_DEF(type) type |
| 916 | #endif |
| 917 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 918 | |
| 919 | /** |
Benny Prijono | 225b222 | 2007-11-16 03:49:01 +0000 | [diff] [blame] | 920 | * @def PJ_DECL_NO_RETURN(type) |
| 921 | * @param type The return type of the function. |
| 922 | * Declare a function that will not return. |
| 923 | */ |
| 924 | /** |
Benny Prijono | a7b376b | 2008-01-25 16:06:33 +0000 | [diff] [blame] | 925 | * @def PJ_IDECL_NO_RETURN(type) |
| 926 | * @param type The return type of the function. |
| 927 | * Declare an inline function that will not return. |
| 928 | */ |
| 929 | /** |
Benny Prijono | 225b222 | 2007-11-16 03:49:01 +0000 | [diff] [blame] | 930 | * @def PJ_BEGIN_DECL |
| 931 | * Mark beginning of declaration section in a header file. |
| 932 | */ |
| 933 | /** |
| 934 | * @def PJ_END_DECL |
| 935 | * Mark end of declaration section in a header file. |
| 936 | */ |
| 937 | #ifdef __cplusplus |
| 938 | # define PJ_DECL_NO_RETURN(type) PJ_DECL(type) PJ_NORETURN |
| 939 | # define PJ_IDECL_NO_RETURN(type) PJ_INLINE(type) PJ_NORETURN |
| 940 | # define PJ_BEGIN_DECL extern "C" { |
| 941 | # define PJ_END_DECL } |
| 942 | #else |
| 943 | # define PJ_DECL_NO_RETURN(type) PJ_NORETURN PJ_DECL(type) |
| 944 | # define PJ_IDECL_NO_RETURN(type) PJ_NORETURN PJ_INLINE(type) |
| 945 | # define PJ_BEGIN_DECL |
| 946 | # define PJ_END_DECL |
| 947 | #endif |
| 948 | |
| 949 | |
| 950 | |
| 951 | /** |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 952 | * @def PJ_DECL_DATA(type) |
| 953 | * @param type The data type. |
| 954 | * Declare a global data. |
| 955 | */ |
| 956 | #if defined(PJ_DLL) |
| 957 | # if defined(PJ_EXPORTING) |
| 958 | # define PJ_DECL_DATA(type) PJ_EXPORT_DECL_SPECIFIER extern type |
| 959 | # else |
| 960 | # define PJ_DECL_DATA(type) PJ_IMPORT_DECL_SPECIFIER extern type |
| 961 | # endif |
| 962 | #elif !defined(PJ_DECL_DATA) |
| 963 | # define PJ_DECL_DATA(type) extern type |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 964 | #endif |
| 965 | |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 966 | |
| 967 | /** |
| 968 | * @def PJ_DEF_DATA(type) |
| 969 | * @param type The data type. |
| 970 | * Define a global data. |
| 971 | */ |
| 972 | #if defined(PJ_DLL) && defined(PJ_EXPORTING) |
| 973 | # define PJ_DEF_DATA(type) PJ_EXPORT_DEF_SPECIFIER type |
| 974 | #elif !defined(PJ_DEF_DATA) |
| 975 | # define PJ_DEF_DATA(type) type |
| 976 | #endif |
| 977 | |
| 978 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 979 | /** |
| 980 | * @def PJ_IDECL(type) |
| 981 | * @param type The function's return type. |
| 982 | * Declare a function that may be expanded as inline. |
| 983 | */ |
| 984 | /** |
| 985 | * @def PJ_IDEF(type) |
| 986 | * @param type The function's return type. |
| 987 | * Define a function that may be expanded as inline. |
| 988 | */ |
| 989 | |
| 990 | #if PJ_FUNCTIONS_ARE_INLINED |
| 991 | # define PJ_IDECL(type) PJ_INLINE(type) |
| 992 | # define PJ_IDEF(type) PJ_INLINE(type) |
| 993 | #else |
| 994 | # define PJ_IDECL(type) PJ_DECL(type) |
| 995 | # define PJ_IDEF(type) PJ_DEF(type) |
| 996 | #endif |
| 997 | |
Benny Prijono | 8ab968f | 2007-07-20 08:08:30 +0000 | [diff] [blame] | 998 | |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 999 | /** |
| 1000 | * @def PJ_UNUSED_ARG(arg) |
| 1001 | * @param arg The argument name. |
| 1002 | * PJ_UNUSED_ARG prevents warning about unused argument in a function. |
| 1003 | */ |
| 1004 | #define PJ_UNUSED_ARG(arg) (void)arg |
| 1005 | |
| 1006 | /** |
| 1007 | * @def PJ_TODO(id) |
| 1008 | * @param id Any identifier that will be printed as TODO message. |
| 1009 | * PJ_TODO macro will display TODO message as warning during compilation. |
| 1010 | * Example: PJ_TODO(CLEAN_UP_ERROR); |
| 1011 | */ |
| 1012 | #ifndef PJ_TODO |
| 1013 | # define PJ_TODO(id) TODO___##id: |
| 1014 | #endif |
| 1015 | |
| 1016 | /** |
| 1017 | * Function attributes to inform that the function may throw exception. |
| 1018 | * |
| 1019 | * @param x The exception list, enclosed in parenthesis. |
| 1020 | */ |
| 1021 | #define __pj_throw__(x) |
| 1022 | |
Benny Prijono | 31ff4d3 | 2007-11-23 03:49:20 +0000 | [diff] [blame] | 1023 | /** @} */ |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 1024 | |
| 1025 | /******************************************************************** |
| 1026 | * Sanity Checks |
| 1027 | */ |
| 1028 | #ifndef PJ_HAS_HIGH_RES_TIMER |
| 1029 | # error "PJ_HAS_HIGH_RES_TIMER is not defined!" |
| 1030 | #endif |
| 1031 | |
| 1032 | #if !defined(PJ_HAS_PENTIUM) |
| 1033 | # error "PJ_HAS_PENTIUM is not defined!" |
| 1034 | #endif |
| 1035 | |
| 1036 | #if !defined(PJ_IS_LITTLE_ENDIAN) |
| 1037 | # error "PJ_IS_LITTLE_ENDIAN is not defined!" |
| 1038 | #endif |
| 1039 | |
| 1040 | #if !defined(PJ_IS_BIG_ENDIAN) |
| 1041 | # error "PJ_IS_BIG_ENDIAN is not defined!" |
| 1042 | #endif |
| 1043 | |
Benny Prijono | 42c5b9e | 2006-05-10 19:24:40 +0000 | [diff] [blame] | 1044 | #if !defined(PJ_EMULATE_RWMUTEX) |
| 1045 | # error "PJ_EMULATE_RWMUTEX should be defined in compat/os_xx.h" |
| 1046 | #endif |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 1047 | |
Benny Prijono | 42c5b9e | 2006-05-10 19:24:40 +0000 | [diff] [blame] | 1048 | #if !defined(PJ_THREAD_SET_STACK_SIZE) |
| 1049 | # error "PJ_THREAD_SET_STACK_SIZE should be defined in compat/os_xx.h" |
| 1050 | #endif |
| 1051 | |
| 1052 | #if !defined(PJ_THREAD_ALLOCATE_STACK) |
| 1053 | # error "PJ_THREAD_ALLOCATE_STACK should be defined in compat/os_xx.h" |
| 1054 | #endif |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 1055 | |
| 1056 | PJ_BEGIN_DECL |
| 1057 | |
| 1058 | /** |
Benny Prijono | d51a37a | 2007-07-28 02:44:55 +0000 | [diff] [blame] | 1059 | * PJLIB version string constant. @see pj_get_version() |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 1060 | */ |
Benny Prijono | d51a37a | 2007-07-28 02:44:55 +0000 | [diff] [blame] | 1061 | PJ_DECL_DATA(const char*) PJ_VERSION; |
| 1062 | |
| 1063 | /** |
| 1064 | * Get PJLIB version string. |
| 1065 | * |
| 1066 | * @return #PJ_VERSION constant. |
| 1067 | */ |
| 1068 | PJ_DECL(const char*) pj_get_version(void); |
Benny Prijono | 9033e31 | 2005-11-21 02:08:39 +0000 | [diff] [blame] | 1069 | |
| 1070 | /** |
| 1071 | * Dump configuration to log with verbosity equal to info(3). |
| 1072 | */ |
| 1073 | PJ_DECL(void) pj_dump_config(void); |
| 1074 | |
| 1075 | PJ_END_DECL |
| 1076 | |
| 1077 | |
| 1078 | #endif /* __PJ_CONFIG_H__ */ |
| 1079 | |