| /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| /* |
| * The contents of this file are subject to the Mozilla Public |
| * License Version 1.1 (the "License"); you may not use this file |
| * except in compliance with the License. You may obtain a copy of |
| * the License at http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS |
| * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or |
| * implied. See the License for the specific language governing |
| * rights and limitations under the License. |
| * |
| * The Original Code is the Netscape Portable Runtime (NSPR). |
| * |
| * The Initial Developer of the Original Code is Netscape |
| * Communications Corporation. Portions created by Netscape are |
| * Copyright (C) 1998-2000 Netscape Communications Corporation. All |
| * Rights Reserved. |
| * |
| * Contributor(s): |
| * |
| * Alternatively, the contents of this file may be used under the |
| * terms of the GNU General Public License Version 2 or later (the |
| * "GPL"), in which case the provisions of the GPL are applicable |
| * instead of those above. If you wish to allow use of your |
| * version of this file only under the terms of the GPL and not to |
| * allow others to use your version of this file under the MPL, |
| * indicate your decision by deleting the provisions above and |
| * replace them with the notice and other provisions required by |
| * the GPL. If you do not delete the provisions above, a recipient |
| * may use your version of this file under either the MPL or the |
| * GPL. |
| */ |
| |
| /* |
| ** File: prtypes.h |
| ** Description: Definitions of NSPR's basic types |
| ** |
| ** Prototypes and macros used to make up for deficiencies in ANSI environments |
| ** that we have found. |
| ** |
| ** Since we do not wrap <stdlib.h> and all the other standard headers, authors |
| ** of portable code will not know in general that they need these definitions. |
| ** Instead of requiring these authors to find the dependent uses in their code |
| ** and take the following steps only in those C files, we take steps once here |
| ** for all C files. |
| **/ |
| |
| #ifndef prtypes_h___ |
| #define prtypes_h___ |
| |
| #ifdef MDCPUCFG |
| #include MDCPUCFG |
| #else |
| #include "prcpucfg.h" |
| #endif |
| |
| #include <stddef.h> |
| |
| /*********************************************************************** |
| ** MACROS: PR_EXTERN |
| ** PR_IMPLEMENT |
| ** DESCRIPTION: |
| ** These are only for externally visible routines and globals. For |
| ** internal routines, just use "extern" for type checking and that |
| ** will not export internal cross-file or forward-declared symbols. |
| ** Define a macro for declaring procedures return types. We use this to |
| ** deal with windoze specific type hackery for DLL definitions. Use |
| ** PR_EXTERN when the prototype for the method is declared. Use |
| ** PR_IMPLEMENT for the implementation of the method. |
| ** |
| ** Example: |
| ** in dowhim.h |
| ** PR_EXTERN( void ) DoWhatIMean( void ); |
| ** in dowhim.c |
| ** PR_IMPLEMENT( void ) DoWhatIMean( void ) { return; } |
| ** |
| ** |
| ***********************************************************************/ |
| #if defined(WIN32) |
| |
| #define PR_EXPORT(__type) extern __declspec(dllexport) __type |
| #define PR_EXPORT_DATA(__type) extern __declspec(dllexport) __type |
| #define PR_IMPORT(__type) __declspec(dllimport) __type |
| #define PR_IMPORT_DATA(__type) __declspec(dllimport) __type |
| |
| #define PR_EXTERN(__type) extern __declspec(dllexport) __type |
| #define PR_IMPLEMENT(__type) __declspec(dllexport) __type |
| #define PR_EXTERN_DATA(__type) extern __declspec(dllexport) __type |
| #define PR_IMPLEMENT_DATA(__type) __declspec(dllexport) __type |
| |
| #define PR_CALLBACK |
| #define PR_CALLBACK_DECL |
| #define PR_STATIC_CALLBACK(__x) static __x |
| |
| #elif defined(XP_BEOS) |
| |
| #define PR_EXPORT(__type) extern __declspec(dllexport) __type |
| #define PR_EXPORT_DATA(__type) extern __declspec(dllexport) __type |
| #define PR_IMPORT(__type) extern __declspec(dllexport) __type |
| #define PR_IMPORT_DATA(__type) extern __declspec(dllexport) __type |
| |
| #define PR_EXTERN(__type) extern __declspec(dllexport) __type |
| #define PR_IMPLEMENT(__type) __declspec(dllexport) __type |
| #define PR_EXTERN_DATA(__type) extern __declspec(dllexport) __type |
| #define PR_IMPLEMENT_DATA(__type) __declspec(dllexport) __type |
| |
| #define PR_CALLBACK |
| #define PR_CALLBACK_DECL |
| #define PR_STATIC_CALLBACK(__x) static __x |
| |
| #elif defined(WIN16) |
| |
| #define PR_CALLBACK_DECL __cdecl |
| |
| #if defined(_WINDLL) |
| #define PR_EXPORT(__type) extern __type _cdecl _export _loadds |
| #define PR_IMPORT(__type) extern __type _cdecl _export _loadds |
| #define PR_EXPORT_DATA(__type) extern __type _export |
| #define PR_IMPORT_DATA(__type) extern __type _export |
| |
| #define PR_EXTERN(__type) extern __type _cdecl _export _loadds |
| #define PR_IMPLEMENT(__type) __type _cdecl _export _loadds |
| #define PR_EXTERN_DATA(__type) extern __type _export |
| #define PR_IMPLEMENT_DATA(__type) __type _export |
| |
| #define PR_CALLBACK __cdecl __loadds |
| #define PR_STATIC_CALLBACK(__x) static __x PR_CALLBACK |
| |
| #else /* this must be .EXE */ |
| #define PR_EXPORT(__type) extern __type _cdecl _export |
| #define PR_IMPORT(__type) extern __type _cdecl _export |
| #define PR_EXPORT_DATA(__type) extern __type _export |
| #define PR_IMPORT_DATA(__type) extern __type _export |
| |
| #define PR_EXTERN(__type) extern __type _cdecl _export |
| #define PR_IMPLEMENT(__type) __type _cdecl _export |
| #define PR_EXTERN_DATA(__type) extern __type _export |
| #define PR_IMPLEMENT_DATA(__type) __type _export |
| |
| #define PR_CALLBACK __cdecl __loadds |
| #define PR_STATIC_CALLBACK(__x) __x PR_CALLBACK |
| #endif /* _WINDLL */ |
| |
| #elif defined(XP_MAC) |
| |
| #define PR_EXPORT(__type) extern __declspec(export) __type |
| #define PR_EXPORT_DATA(__type) extern __declspec(export) __type |
| #define PR_IMPORT(__type) extern __declspec(export) __type |
| #define PR_IMPORT_DATA(__type) extern __declspec(export) __type |
| |
| #define PR_EXTERN(__type) extern __declspec(export) __type |
| #define PR_IMPLEMENT(__type) __declspec(export) __type |
| #define PR_EXTERN_DATA(__type) extern __declspec(export) __type |
| #define PR_IMPLEMENT_DATA(__type) __declspec(export) __type |
| |
| #define PR_CALLBACK |
| #define PR_CALLBACK_DECL |
| #define PR_STATIC_CALLBACK(__x) static __x |
| |
| #else /* Unix */ |
| |
| #define PR_EXPORT(__type) extern __type |
| #define PR_EXPORT_DATA(__type) extern __type |
| #define PR_IMPORT(__type) extern __type |
| #define PR_IMPORT_DATA(__type) extern __type |
| |
| #define PR_EXTERN(__type) extern __type |
| #define PR_IMPLEMENT(__type) __type |
| #define PR_EXTERN_DATA(__type) extern __type |
| #define PR_IMPLEMENT_DATA(__type) __type |
| #define PR_CALLBACK |
| #define PR_CALLBACK_DECL |
| #define PR_STATIC_CALLBACK(__x) static __x |
| |
| #endif |
| |
| #if defined(_NSPR_BUILD_) |
| #define NSPR_API(__type) PR_EXPORT(__type) |
| #define NSPR_DATA_API(__type) PR_EXPORT_DATA(__type) |
| #else |
| #define NSPR_API(__type) PR_IMPORT(__type) |
| #define NSPR_DATA_API(__type) PR_IMPORT_DATA(__type) |
| #endif |
| |
| /*********************************************************************** |
| ** MACROS: PR_BEGIN_MACRO |
| ** PR_END_MACRO |
| ** DESCRIPTION: |
| ** Macro body brackets so that macros with compound statement definitions |
| ** behave syntactically more like functions when called. |
| ***********************************************************************/ |
| #define PR_BEGIN_MACRO do { |
| #define PR_END_MACRO } while (0) |
| |
| /*********************************************************************** |
| ** MACROS: PR_BEGIN_EXTERN_C |
| ** PR_END_EXTERN_C |
| ** DESCRIPTION: |
| ** Macro shorthands for conditional C++ extern block delimiters. |
| ***********************************************************************/ |
| #ifdef __cplusplus |
| #define PR_BEGIN_EXTERN_C extern "C" { |
| #define PR_END_EXTERN_C } |
| #else |
| #define PR_BEGIN_EXTERN_C |
| #define PR_END_EXTERN_C |
| #endif |
| |
| /*********************************************************************** |
| ** MACROS: PR_BIT |
| ** PR_BITMASK |
| ** DESCRIPTION: |
| ** Bit masking macros. XXX n must be <= 31 to be portable |
| ***********************************************************************/ |
| #define PR_BIT(n) ((PRUint32)1 << (n)) |
| #define PR_BITMASK(n) (PR_BIT(n) - 1) |
| |
| /*********************************************************************** |
| ** MACROS: PR_ROUNDUP |
| ** PR_MIN |
| ** PR_MAX |
| ** PR_ABS |
| ** DESCRIPTION: |
| ** Commonly used macros for operations on compatible types. |
| ***********************************************************************/ |
| #define PR_ROUNDUP(x,y) ((((x)+((y)-1))/(y))*(y)) |
| #define PR_MIN(x,y) ((x)<(y)?(x):(y)) |
| #define PR_MAX(x,y) ((x)>(y)?(x):(y)) |
| #define PR_ABS(x) ((x)<0?-(x):(x)) |
| |
| PR_BEGIN_EXTERN_C |
| |
| /************************************************************************ |
| ** TYPES: PRUint8 |
| ** PRInt8 |
| ** DESCRIPTION: |
| ** The int8 types are known to be 8 bits each. There is no type that |
| ** is equivalent to a plain "char". |
| ************************************************************************/ |
| #if PR_BYTES_PER_BYTE == 1 |
| typedef unsigned char PRUint8; |
| /* |
| ** Some cfront-based C++ compilers do not like 'signed char' and |
| ** issue the warning message: |
| ** warning: "signed" not implemented (ignored) |
| ** For these compilers, we have to define PRInt8 as plain 'char'. |
| ** Make sure that plain 'char' is indeed signed under these compilers. |
| */ |
| #if (defined(HPUX) && defined(__cplusplus) \ |
| && !defined(__GNUC__) && __cplusplus < 199707L) \ |
| || (defined(SCO) && defined(__cplusplus) \ |
| && !defined(__GNUC__) && __cplusplus == 1L) |
| typedef char PRInt8; |
| #else |
| typedef signed char PRInt8; |
| #endif |
| #else |
| #error No suitable type for PRInt8/PRUint8 |
| #endif |
| |
| /************************************************************************ |
| * MACROS: PR_INT8_MAX |
| * PR_INT8_MIN |
| * PR_UINT8_MAX |
| * DESCRIPTION: |
| * The maximum and minimum values of a PRInt8 or PRUint8. |
| ************************************************************************/ |
| |
| #define PR_INT8_MAX 127 |
| #define PR_INT8_MIN (-128) |
| #define PR_UINT8_MAX 255U |
| |
| /************************************************************************ |
| ** TYPES: PRUint16 |
| ** PRInt16 |
| ** DESCRIPTION: |
| ** The int16 types are known to be 16 bits each. |
| ************************************************************************/ |
| #if PR_BYTES_PER_SHORT == 2 |
| typedef unsigned short PRUint16; |
| typedef short PRInt16; |
| #else |
| #error No suitable type for PRInt16/PRUint16 |
| #endif |
| |
| /************************************************************************ |
| * MACROS: PR_INT16_MAX |
| * PR_INT16_MIN |
| * PR_UINT16_MAX |
| * DESCRIPTION: |
| * The maximum and minimum values of a PRInt16 or PRUint16. |
| ************************************************************************/ |
| |
| #define PR_INT16_MAX 32767 |
| #define PR_INT16_MIN (-32768) |
| #define PR_UINT16_MAX 65535U |
| |
| /************************************************************************ |
| ** TYPES: PRUint32 |
| ** PRInt32 |
| ** DESCRIPTION: |
| ** The int32 types are known to be 32 bits each. |
| ************************************************************************/ |
| #if PR_BYTES_PER_INT == 4 |
| typedef unsigned int PRUint32; |
| typedef int PRInt32; |
| #define PR_INT32(x) x |
| #define PR_UINT32(x) x ## U |
| #elif PR_BYTES_PER_LONG == 4 |
| typedef unsigned long PRUint32; |
| typedef long PRInt32; |
| #define PR_INT32(x) x ## L |
| #define PR_UINT32(x) x ## UL |
| #else |
| #error No suitable type for PRInt32/PRUint32 |
| #endif |
| |
| /************************************************************************ |
| * MACROS: PR_INT32_MAX |
| * PR_INT32_MIN |
| * PR_UINT32_MAX |
| * DESCRIPTION: |
| * The maximum and minimum values of a PRInt32 or PRUint32. |
| ************************************************************************/ |
| |
| #define PR_INT32_MAX PR_INT32(2147483647) |
| #define PR_INT32_MIN (-PR_INT32_MAX - 1) |
| #define PR_UINT32_MAX PR_UINT32(4294967295) |
| |
| /************************************************************************ |
| ** TYPES: PRUint64 |
| ** PRInt64 |
| ** DESCRIPTION: |
| ** The int64 types are known to be 64 bits each. Care must be used when |
| ** declaring variables of type PRUint64 or PRInt64. Different hardware |
| ** architectures and even different compilers have varying support for |
| ** 64 bit values. The only guaranteed portability requires the use of |
| ** the LL_ macros (see prlong.h). |
| ************************************************************************/ |
| #ifdef HAVE_LONG_LONG |
| #if PR_BYTES_PER_LONG == 8 |
| typedef long PRInt64; |
| typedef unsigned long PRUint64; |
| #elif defined(WIN16) |
| typedef __int64 PRInt64; |
| typedef unsigned __int64 PRUint64; |
| #elif defined(WIN32) && !defined(__GNUC__) |
| typedef __int64 PRInt64; |
| typedef unsigned __int64 PRUint64; |
| #else |
| typedef long long PRInt64; |
| typedef unsigned long long PRUint64; |
| #endif /* PR_BYTES_PER_LONG == 8 */ |
| #else /* !HAVE_LONG_LONG */ |
| typedef struct { |
| #ifdef IS_LITTLE_ENDIAN |
| PRUint32 lo, hi; |
| #else |
| PRUint32 hi, lo; |
| #endif |
| } PRInt64; |
| typedef PRInt64 PRUint64; |
| #endif /* !HAVE_LONG_LONG */ |
| |
| /************************************************************************ |
| ** TYPES: PRUintn |
| ** PRIntn |
| ** DESCRIPTION: |
| ** The PRIntn types are most appropriate for automatic variables. They are |
| ** guaranteed to be at least 16 bits, though various architectures may |
| ** define them to be wider (e.g., 32 or even 64 bits). These types are |
| ** never valid for fields of a structure. |
| ************************************************************************/ |
| #if PR_BYTES_PER_INT >= 2 |
| typedef int PRIntn; |
| typedef unsigned int PRUintn; |
| #else |
| #error 'sizeof(int)' not sufficient for platform use |
| #endif |
| |
| /************************************************************************ |
| ** TYPES: PRFloat64 |
| ** DESCRIPTION: |
| ** NSPR's floating point type is always 64 bits. |
| ************************************************************************/ |
| typedef double PRFloat64; |
| |
| /************************************************************************ |
| ** TYPES: PRSize |
| ** DESCRIPTION: |
| ** A type for representing the size of objects. |
| ************************************************************************/ |
| typedef size_t PRSize; |
| |
| |
| /************************************************************************ |
| ** TYPES: PROffset32, PROffset64 |
| ** DESCRIPTION: |
| ** A type for representing byte offsets from some location. |
| ************************************************************************/ |
| typedef PRInt32 PROffset32; |
| typedef PRInt64 PROffset64; |
| |
| /************************************************************************ |
| ** TYPES: PRPtrDiff |
| ** DESCRIPTION: |
| ** A type for pointer difference. Variables of this type are suitable |
| ** for storing a pointer or pointer sutraction. |
| ************************************************************************/ |
| typedef ptrdiff_t PRPtrdiff; |
| |
| /************************************************************************ |
| ** TYPES: PRUptrdiff |
| ** DESCRIPTION: |
| ** A type for pointer difference. Variables of this type are suitable |
| ** for storing a pointer or pointer sutraction. |
| ************************************************************************/ |
| typedef unsigned long PRUptrdiff; |
| |
| /************************************************************************ |
| ** TYPES: PRBool |
| ** DESCRIPTION: |
| ** Use PRBool for variables and parameter types. Use PR_FALSE and PR_TRUE |
| ** for clarity of target type in assignments and actual arguments. Use |
| ** 'if (bool)', 'while (!bool)', '(bool) ? x : y' etc., to test booleans |
| ** juast as you would C int-valued conditions. |
| ************************************************************************/ |
| typedef PRIntn PRBool; |
| #define PR_TRUE 1 |
| #define PR_FALSE 0 |
| |
| /************************************************************************ |
| ** TYPES: PRPackedBool |
| ** DESCRIPTION: |
| ** Use PRPackedBOol within structs where bitfields are not desireable |
| ** but minimum and consistant overhead matters. |
| ************************************************************************/ |
| typedef PRUint8 PRPackedBool; |
| |
| /* |
| ** Status code used by some routines that have a single point of failure or |
| ** special status return. |
| */ |
| typedef enum { PR_FAILURE = -1, PR_SUCCESS = 0 } PRStatus; |
| |
| #ifdef MOZ_UNICODE |
| /* |
| * EXPERIMENTAL: This type may be removed in a future release. |
| */ |
| #ifndef __PRUNICHAR__ |
| #define __PRUNICHAR__ |
| #if defined(WIN32) || defined(XP_MAC) |
| typedef wchar_t PRUnichar; |
| #else |
| typedef PRUint16 PRUnichar; |
| #endif |
| #endif |
| #endif /* MOZ_UNICODE */ |
| |
| /* |
| ** WARNING: The undocumented data types PRWord and PRUword are |
| ** only used in the garbage collection and arena code. Do not |
| ** use PRWord and PRUword in new code. |
| ** |
| ** A PRWord is an integer that is the same size as a void*. |
| ** It implements the notion of a "word" in the Java Virtual |
| ** Machine. (See Sec. 3.4 "Words", The Java Virtual Machine |
| ** Specification, Addison-Wesley, September 1996. |
| ** http://java.sun.com/docs/books/vmspec/index.html.) |
| */ |
| typedef long PRWord; |
| typedef unsigned long PRUword; |
| |
| #if defined(NO_NSPR_10_SUPPORT) |
| #else |
| /********* ???????????????? FIX ME ??????????????????????????? *****/ |
| /********************** Some old definitions until pr=>ds transition is done ***/ |
| /********************** Also, we are still using NSPR 1.0. GC ******************/ |
| /* |
| ** Fundamental NSPR macros, used nearly everywhere. |
| */ |
| |
| #define PR_PUBLIC_API PR_IMPLEMENT |
| |
| /* |
| ** Macro body brackets so that macros with compound statement definitions |
| ** behave syntactically more like functions when called. |
| */ |
| #define NSPR_BEGIN_MACRO do { |
| #define NSPR_END_MACRO } while (0) |
| |
| /* |
| ** Macro shorthands for conditional C++ extern block delimiters. |
| */ |
| #ifdef NSPR_BEGIN_EXTERN_C |
| #undef NSPR_BEGIN_EXTERN_C |
| #endif |
| #ifdef NSPR_END_EXTERN_C |
| #undef NSPR_END_EXTERN_C |
| #endif |
| |
| #ifdef __cplusplus |
| #define NSPR_BEGIN_EXTERN_C extern "C" { |
| #define NSPR_END_EXTERN_C } |
| #else |
| #define NSPR_BEGIN_EXTERN_C |
| #define NSPR_END_EXTERN_C |
| #endif |
| |
| #ifdef XP_MAC |
| #include "protypes.h" |
| #else |
| #include "obsolete/protypes.h" |
| #endif |
| |
| /********* ????????????? End Fix me ?????????????????????????????? *****/ |
| #endif /* NO_NSPR_10_SUPPORT */ |
| |
| PR_END_EXTERN_C |
| |
| #endif /* prtypes_h___ */ |
| |