diff options
Diffstat (limited to 'include/netsite.h')
| -rw-r--r-- | include/netsite.h | 312 |
1 files changed, 312 insertions, 0 deletions
diff --git a/include/netsite.h b/include/netsite.h new file mode 100644 index 00000000..278b1d14 --- /dev/null +++ b/include/netsite.h @@ -0,0 +1,312 @@ +/** BEGIN COPYRIGHT BLOCK + * Copyright 2001 Sun Microsystems, Inc. + * Portions copyright 1999, 2001-2003 Netscape Communications Corporation. + * All rights reserved. + * END COPYRIGHT BLOCK **/ +#ifndef NETSITE_H +#define NETSITE_H + +#ifndef NOINTNSAPI +#define INTNSAPI +#endif /* !NOINTNSAPI */ + +/* + * Standard defs for NetSite servers. + */ + +/* +** Macro shorthands for conditional C++ extern block delimiters. +** Don't redefine for compatability with NSPR. +*/ +#ifndef NSPR_BEGIN_EXTERN_C +#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 +#endif /* NSPR_BEGIN_EXTERN_C */ +#ifdef __cplusplus +#define EXTERNC extern "C" +#else +#define EXTERNC +#endif + +#ifndef VERSION_H +#include "version.h" +#endif /* !VERSION_H */ + +#ifndef BASE_SYSTEMS_H +#include "base/systems.h" +#endif /* !BASE_SYSTEMS_H */ + +#undef MAGNUS_VERSION_STRING + +#ifdef MCC_PROXY +#define MAGNUS_VERSION PROXY_VERSION_DEF +#define MAGNUS_VERSION_STRING PROXY_VERSION_STRING + +#elif defined(NS_CMS) +#define MAGNUS_VERSION CMS_VERSION_DEF +#define MAGNUS_VERSION_STRING CMS_VERSION_STRING + +#elif defined(NS_DS) +#define MAGNUS_VERSION DS_VERSION_DEF +#define MAGNUS_VERSION_STRING DS_VERSION_STRING + +#elif defined(MCC_ADMSERV) +#define MAGNUS_VERSION ADMSERV_VERSION_DEF +#define MAGNUS_VERSION_STRING ADMSERV_VERSION_STRING + +#elif defined(NS_CATALOG) +#define MAGNUS_VERSION CATALOG_VERSION_DEF +#define MAGNUS_VERSION_STRING CATALOG_VERSION_STRING + +#elif defined(NS_RDS) +#define MAGNUS_VERSION RDS_VERSION_DEF +#define MAGNUS_VERSION_STRING RDS_VERSION_STRING + +#elif defined(MCC_HTTPD) + +#ifdef NS_PERSONAL +#define MAGNUS_VERSION PERSONAL_VERSION_DEF +#else +#define MAGNUS_VERSION ENTERPRISE_VERSION_DEF +#endif + +#if defined(XP_UNIX) || defined(USE_ADMSERV) +#if defined(NS_DS) +#define MAGNUS_VERSION_STRING DS_VERSION_STRING +#elif defined(NS_PERSONAL) +#define MAGNUS_VERSION_STRING PERSONAL_VERSION_STRING +#elif defined(NS_CATALOG) +#define MAGNUS_VERSION_STRING CATALOG_VERSION_STRING +#elif defined(NS_RDS) +#define MAGNUS_VERSION_STRING RDS_VERSION_STRING +#elif defined(NS_CMS) +#define MAGNUS_VERSION_STRING CMS_VERSION_STRING +#else +#define MAGNUS_VERSION_STRING ENTERPRISE_VERSION_STRING +#endif +#endif /* XP_UNIX */ + +#elif defined(MCC_NEWS) +#define MAGNUS_VERSION_STRING NEWS_VERSION_STRING + +#elif defined(NS_MAIL) +#define MAGNUS_VERSION MAIL_VERSION_DEF +#define MAGNUS_VERSION_STRING MAIL_VERSION_STRING + +#elif defined(MCC_BATMAN) +#define MAGNUS_VERSION BATMAN_VERSION_DEF +#define MAGNUS_VERSION_STRING BATMAN_VERSION_STRING + +#endif + +#ifndef VOID +#define VOID void +#endif + +#ifdef XP_UNIX +/* + * Provide some typedefs that are commonly used on windows + * + * DO NOT USE THESE! They will be deleted later! + * + */ +#define CONST const +typedef unsigned long DWORD; +typedef int BOOL; +typedef unsigned char BYTE; +typedef unsigned short WORD; +typedef float FLOAT; +typedef FLOAT *PFLOAT; +typedef BOOL *PBOOL; +typedef BOOL *LPBOOL; +typedef BYTE *PBYTE; +typedef BYTE *LPBYTE; +typedef int *PINT; +typedef int *LPINT; +typedef WORD *PWORD; +typedef WORD *LPWORD; +typedef long *LPLONG; +typedef DWORD *PDWORD; +typedef DWORD *LPDWORD; +typedef void *LPVOID; + +#ifndef SNI +#if !defined (boolean) && !defined (__GNUC__) +typedef int boolean; +#endif +#endif + +#endif +#define NS_TRUE 1 +#define NS_FALSE 0 + +NSPR_BEGIN_EXTERN_C + +/* -------------------------- System version on NT------------------------- */ + +/* Encode the server version as a number to be able to provide inexpensive + * dynamic checks on server version - this isn't added in yet. */ + +#define ENTERPRISE_VERSION 1 +#define PERSONAL_VERSION 2 +#define CATALOG_VERSION 3 +#define RDS_VERSION 4 +#define CMS_VERSION 5 +#undef DS_VERSION +#define DS_VERSION 6 + +#define server_fasttrack (!strcmp(MAGNUS_VERSION_STRING, PERSONAL_VERSION_STRING)) +#define server_enterprise (!strcmp(MAGNUS_VERSION_STRING, ENTERPRISE_VERSION_STRING)) + +/* This definition of MAGNUS_VERSION_STRING on NT should be used + * only when building the ns-http DLL */ + +#if defined(MCC_HTTPD) && defined(XP_WIN32) && !defined(USE_ADMSERV) && !defined(MCC_ADMSERV) +#undef MAGNUS_VERSION_STRING +#define MAGNUS_VERSION_STRING INTsystem_version() +#endif /* XP_WIN32 */ + +/* Set server's version dynamically */ +NSAPI_PUBLIC void INTsystem_version_set(char *ptr); + +#ifndef APSTUDIO_READONLY_SYMBOLS + +/* Include the public netsite.h definitions */ +#ifndef PUBLIC_NETSITE_H +#ifdef MALLOC_DEBUG +#define NS_MALLOC_DEBUG +#endif /* MALLOC_DEBUG */ +#include "public/netsite.h" +#endif /* PUBLIC_NETSITE_H */ + +#endif /* !APSTUDIO_READONLY_SYMBOLS */ + +/* + * If NS_MALLOC_DEBUG is defined, declare the debug version of the memory + * allocation API. + */ +#ifdef NS_MALLOC_DEBUG +#define PERM_MALLOC(size) INTsystem_malloc_perm(size, __LINE__, __FILE__) +NSAPI_PUBLIC void *INTsystem_malloc_perm(int size, int line, char *file); + +#define PERM_CALLOC(size) INTsystem_calloc_perm(size, __LINE__, __FILE__) +NSAPI_PUBLIC void *INTsystem_calloc_perm(int size, int line, char *file); + +#define PERM_REALLOC(ptr, size) INTsystem_realloc_perm(ptr, size, __LINE__, __FILE__) +NSAPI_PUBLIC void *INTsystem_realloc_perm(void *ptr, int size, int line, char *file); + +#define PERM_FREE(ptr) INTsystem_free_perm((void *) ptr, __LINE__, __FILE__) +NSAPI_PUBLIC void INTsystem_free_perm(void *ptr, int line, char *file); + +#define PERM_STRDUP(ptr) INTsystem_strdup_perm(ptr, __LINE__, __FILE__) +NSAPI_PUBLIC char *INTsystem_strdup_perm(const char *ptr, int line, char *file); +#endif /* NS_MALLOC_DEBUG */ + +/* + * Only the mainline needs to set the malloc key. + */ + +void setThreadMallocKey(int key); + +/* This probably belongs somewhere else, perhaps with a different name */ +NSAPI_PUBLIC char *INTdns_guess_domain(char * hname); + +/* --- Begin public functions --- */ + +#ifdef INTNSAPI + +NSAPI_PUBLIC char *INTsystem_version(); + +/* + Depending on the system, memory allocated via these macros may come from + an arena. If these functions are called from within an Init function, they + will be allocated from permanent storage. Otherwise, they will be freed + when the current request is finished. + */ + +#define MALLOC(size) INTsystem_malloc(size) +NSAPI_PUBLIC void *INTsystem_malloc(int size); + +#define CALLOC(size) INTsystem_calloc(size) +NSAPI_PUBLIC void *INTsystem_calloc(int size); + +#define REALLOC(ptr, size) INTsystem_realloc(ptr, size) +NSAPI_PUBLIC void *INTsystem_realloc(void *ptr, int size); + +#define FREE(ptr) INTsystem_free((void *) ptr) +NSAPI_PUBLIC void INTsystem_free(void *ptr); + +#define STRDUP(ptr) INTsystem_strdup(ptr) +NSAPI_PUBLIC char *INTsystem_strdup(const char *ptr); + +/* + These macros always provide permanent storage, for use in global variables + and such. They are checked at runtime to prevent them from returning NULL. + */ + +#ifndef NS_MALLOC_DEBUG + +#define PERM_MALLOC(size) INTsystem_malloc_perm(size) +NSAPI_PUBLIC void *INTsystem_malloc_perm(int size); + +#define PERM_CALLOC(size) INTsystem_calloc_perm(size) +NSAPI_PUBLIC void *INTsystem_calloc_perm(int size); + +#define PERM_REALLOC(ptr, size) INTsystem_realloc_perm(ptr, size) +NSAPI_PUBLIC void *INTsystem_realloc_perm(void *ptr, int size); + +#define PERM_FREE(ptr) INTsystem_free_perm((void *) ptr) +NSAPI_PUBLIC void INTsystem_free_perm(void *ptr); + +#define PERM_STRDUP(ptr) INTsystem_strdup_perm(ptr) +NSAPI_PUBLIC char *INTsystem_strdup_perm(const char *ptr); + +#endif /* !NS_MALLOC_DEBUG */ + +/* Thread-Private data key index for accessing the thread-private memory pool. + * Each thread creates its own pool for allocating data. The MALLOC/FREE/etc + * macros have been defined to check the thread private data area with the + * thread_malloc_key index to find the address for the pool currently in use. + * + * If a thread wants to use a different pool, it must change the thread-local- + * storage[thread_malloc_key]. + */ + +NSAPI_PUBLIC int INTgetThreadMallocKey(void); + +/* Not sure where to put this. */ +NSAPI_PUBLIC void INTmagnus_atrestart(void (*fn)(void *), void *data); + +#endif /* INTNSAPI */ + +/* --- End public functions --- */ + +NSPR_END_EXTERN_C + +#define system_version_set INTsystem_version_set +#define dns_guess_domain INTdns_guess_domain + +#ifdef INTNSAPI + +#define system_version INTsystem_version +#define system_malloc INTsystem_malloc +#define system_calloc INTsystem_calloc +#define system_realloc INTsystem_realloc +#define system_free INTsystem_free +#define system_strdup INTsystem_strdup +#define system_malloc_perm INTsystem_malloc_perm +#define system_calloc_perm INTsystem_calloc_perm +#define system_realloc_perm INTsystem_realloc_perm +#define system_free_perm INTsystem_free_perm +#define system_strdup_perm INTsystem_strdup_perm +#define getThreadMallocKey INTgetThreadMallocKey +#define magnus_atrestart INTmagnus_atrestart + +#endif /* INTNSAPI */ + +#endif /* NETSITE_H */ |