Land Patch [ 566100 ] Rationalize DL_IMPORT and DL_EXPORT.

Author: mhammond

Doc/ext/extending.tex

@@ -212,7 +212,7 @@ \section{Intermezzo: Errors and Exceptions
 the error checking for now):
 
 \begin{verbatim}
-void
+PyMODINIT_FUNC
 initspam(void)
 {
     PyObject *m;
@@ -240,6 +240,7 @@ \section{Intermezzo: Errors and Exceptions
 Should it become a dangling pointer, C code which raises the exception
 could cause a core dump or other unintended side effects.
 
+We discuss the use of PyMODINIT_FUNC later in this sample.
 
 \section{Back to the Example
          \label{backToExample}}
@@ -339,14 +340,16 @@ \section{The Module's Method Table and Initialization Function
 the module file:
 
 \begin{verbatim}
-void
+PyMODINIT_FUNC
 initspam(void)
 {
     (void) Py_InitModule("spam", SpamMethods);
 }
 \end{verbatim}
 
-Note that for \Cpp, this method must be declared \code{extern "C"}.
+Note that PyMODINIT_FUNC declares the function as \code{void} return type, 
+declares any special linkage declarations required by the platform, and for 
+\Cpp declares the function as \code{extern "C"}.
 
 When the Python program imports module \module{spam} for the first
 time, \cfunction{initspam()} is called. (See below for comments about
@@ -1263,7 +1266,7 @@ \section{Providing a C API for an Extension Module
 the C API pointer array:
 
 \begin{verbatim}
-void
+PyMODINIT_FUNC
 initspam(void)
 {
     PyObject *m;
@@ -1352,7 +1355,7 @@ \section{Providing a C API for an Extension Module
 function:
 
 \begin{verbatim}
-void
+PyMODINIT_FUNC
 initclient(void)
 {
     PyObject *m;

Include/import.h

@@ -7,32 +7,32 @@
 extern "C" {
 #endif
 
-DL_IMPORT(long) PyImport_GetMagicNumber(void);
-DL_IMPORT(PyObject *) PyImport_ExecCodeModule(char *name, PyObject *co);
-DL_IMPORT(PyObject *) PyImport_ExecCodeModuleEx(
+PyAPI_FUNC(long) PyImport_GetMagicNumber(void);
+PyAPI_FUNC(PyObject *) PyImport_ExecCodeModule(char *name, PyObject *co);
+PyAPI_FUNC(PyObject *) PyImport_ExecCodeModuleEx(
 	char *name, PyObject *co, char *pathname);
-DL_IMPORT(PyObject *) PyImport_GetModuleDict(void);
-DL_IMPORT(PyObject *) PyImport_AddModule(char *name);
-DL_IMPORT(PyObject *) PyImport_ImportModule(char *name);
-DL_IMPORT(PyObject *) PyImport_ImportModuleEx(
+PyAPI_FUNC(PyObject *) PyImport_GetModuleDict(void);
+PyAPI_FUNC(PyObject *) PyImport_AddModule(char *name);
+PyAPI_FUNC(PyObject *) PyImport_ImportModule(char *name);
+PyAPI_FUNC(PyObject *) PyImport_ImportModuleEx(
 	char *name, PyObject *globals, PyObject *locals, PyObject *fromlist);
-DL_IMPORT(PyObject *) PyImport_Import(PyObject *name);
-DL_IMPORT(PyObject *) PyImport_ReloadModule(PyObject *m);
-DL_IMPORT(void) PyImport_Cleanup(void);
-DL_IMPORT(int) PyImport_ImportFrozenModule(char *);
+PyAPI_FUNC(PyObject *) PyImport_Import(PyObject *name);
+PyAPI_FUNC(PyObject *) PyImport_ReloadModule(PyObject *m);
+PyAPI_FUNC(void) PyImport_Cleanup(void);
+PyAPI_FUNC(int) PyImport_ImportFrozenModule(char *);
 
-extern DL_IMPORT(PyObject *)_PyImport_FindExtension(char *, char *);
-extern DL_IMPORT(PyObject *)_PyImport_FixupExtension(char *, char *);
+extern PyAPI_FUNC(PyObject *)_PyImport_FindExtension(char *, char *);
+extern PyAPI_FUNC(PyObject *)_PyImport_FixupExtension(char *, char *);
 
 struct _inittab {
     char *name;
     void (*initfunc)(void);
 };
 
-extern DL_IMPORT(struct _inittab *) PyImport_Inittab;
+extern PyAPI_DATA(struct _inittab *) PyImport_Inittab;
 
-extern DL_IMPORT(int) PyImport_AppendInittab(char *name, void (*initfunc)(void));
-extern DL_IMPORT(int) PyImport_ExtendInittab(struct _inittab *newtab);
+extern PyAPI_FUNC(int) PyImport_AppendInittab(char *name, void (*initfunc)(void));
+extern PyAPI_FUNC(int) PyImport_ExtendInittab(struct _inittab *newtab);
 
 struct _frozen {
     char *name;
@@ -43,7 +43,7 @@ struct _frozen {
 /* Embedding apps may change this pointer to point to their favorite
    collection of frozen modules: */
 
-extern DL_IMPORT(struct _frozen *) PyImport_FrozenModules;
+extern PyAPI_DATA(struct _frozen *) PyImport_FrozenModules;
 
 #ifdef __cplusplus
 }

Include/pyport.h

@@ -379,19 +379,82 @@ extern int fsync(int fd);
 extern double hypot(double, double);
 #endif
 
-#ifndef __CYGWIN__
-#ifndef DL_IMPORT       /* declarations for DLL import */
-#define DL_IMPORT(RTYPE) RTYPE
-#endif
-#else /* __CYGWIN__ */
-#ifdef USE_DL_IMPORT
-#define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
-#define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
-#else /* !USE_DL_IMPORT */
-#define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
-#define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
-#endif /* USE_DL_IMPORT */
-#endif /* __CYGWIN__ */
+/* Declarations for symbol visibility.
+
+  PyAPI_FUNC(type): Declares a public Python API function and return type
+  PyAPI_DATA(type): Declares public Python data and its type 
+  PyMODINIT_FUNC:   A Python module init function.  If these functions are
+                    inside the Python core, they are private to the core.  
+                    If in an extension module, it may be declared with 
+                    external linkage depending on the platform.
+
+  As a number of platforms support/require "__declspec(dllimport/dllexport)",
+  we support a HAVE_DECLSPEC_DLL macro to save duplication.
+*/
+
+/* 
+All windows ports, except cygwin, are handled in PC/pyconfig.h
+BeOS is only other autoconf platform requiring special linkage handling
+and both these use __declspec()
+*/
+#if defined(__CYGWIN__) || defined(__BEOS__)
+#	define HAVE_DECLSPEC_DLL
+#endif
+
+#if defined(Py_ENABLE_SHARED) /* only get special linkage if built as shared */
+#	if defined(HAVE_DECLSPEC_DLL)
+#		ifdef Py_BUILD_CORE
+#			define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
+#			define PyAPI_DATA(RTYPE) __declspec(dllexport) RTYPE
+			/* module init functions inside the core need no external linkage */
+#			define PyMODINIT_FUNC void
+#		else /* Py_BUILD_CORE */
+			/* Building an extension module, or an embedded situation */
+			/* public Python functions and data are imported */
+#			define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
+#			define PyAPI_DATA(RTYPE) __declspec(dllimport) RTYPE
+			/* module init functions outside the core must be exported */
+#			if defined(__cplusplus)
+#				define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
+#			else /* __cplusplus */
+#				define PyMODINIT_FUNC __declspec(dllexport) void
+#			endif /* __cplusplus */
+#		endif /* Py_BUILD_CORE */
+#	endif /* HAVE_DECLSPEC */
+#endif /* Py_ENABLE_SHARED */
+
+/* If no external linkage macros defined by now, create defaults */
+#ifndef PyAPI_FUNC
+#	define PyAPI_FUNC(RTYPE) RTYPE
+#endif
+#ifndef PyAPI_DATA
+#	define PyAPI_DATA(RTYPE) RTYPE
+#endif
+#ifndef PyMODINIT_FUNC
+#	if defined(__cplusplus)
+#		define PyMODINIT_FUNC extern "C" void
+#	else /* __cplusplus */
+#		define PyMODINIT_FUNC void
+#	endif /* __cplusplus */
+#endif
+
+/* Deprecated DL_IMPORT and DL_EXPORT macros */
+#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
+#	if defined(Py_BUILD_CORE)
+#		define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
+#		define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
+#	else
+#		define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
+#		define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
+#	endif
+#endif
+#ifndef DL_EXPORT
+#	define DL_EXPORT(RTYPE) RTYPE
+#endif
+#ifndef DL_IMPORT
+#	define DL_IMPORT(RTYPE) RTYPE
+#endif
+/* End of deprecated DL_* macros */
 
 /* If the fd manipulation macros aren't defined,
    here is a set that should do the job */
@@ -458,15 +521,6 @@ typedef	struct fd_set {
 #error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
 #endif
 
-/*
- * Rename some functions for the Borland compiler
- */
-#ifdef __BORLANDC__
-#  include <io.h>
-#  define _chsize chsize
-#  define _setmode setmode
-#endif
-
 #ifdef __cplusplus
 }
 #endif

Makefile.pre.in

@@ -65,7 +65,7 @@ LINKFORSHARED=	@LINKFORSHARED@
 # Extra C flags added for building the interpreter object files.
 CFLAGSFORSHARED=@CFLAGSFORSHARED@
 # C flags used for building the interpreter object files
-PY_CFLAGS=	$(CFLAGS) $(CPPFLAGS) $(CFLAGSFORSHARED)
+PY_CFLAGS=	$(CFLAGS) $(CPPFLAGS) $(CFLAGSFORSHARED) -DPy_BUILD_CORE
 
 
 # Machine-dependent subdirectories
@@ -420,10 +420,10 @@ Parser/metagrammar.o:	$(srcdir)/Parser/metagrammar.c
 Python/compile.o Python/symtable.o: $(GRAMMAR_H)
 
 Python/getplatform.o: $(srcdir)/Python/getplatform.c
-		$(CC) -c $(CFLAGS) $(CPPFLAGS) $(CFLAGSFORSHARED) -DPLATFORM='"$(MACHDEP)"' -o $@ $(srcdir)/Python/getplatform.c
+		$(CC) -c $(PY_CFLAGS) -DPLATFORM='"$(MACHDEP)"' -o $@ $(srcdir)/Python/getplatform.c
 
 Python/importdl.o: $(srcdir)/Python/importdl.c
-		$(CC) -c $(CFLAGS) $(CPPFLAGS) $(CFLAGSFORSHARED) -I$(DLINCLDIR) -o $@ $(srcdir)/Python/importdl.c
+		$(CC) -c $(PY_CFLAGS) -I$(DLINCLDIR) -o $@ $(srcdir)/Python/importdl.c
 
 Objects/unicodectype.o:	$(srcdir)/Objects/unicodectype.c \
 				$(srcdir)/Objects/unicodetype_db.h

Modules/_sre.c

@@ -2979,8 +2979,7 @@ static PyMethodDef _functions[] = {
     {NULL, NULL}
 };
 
-DL_EXPORT(void)
-init_sre(void)
+PyMODINIT_FUNC init_sre(void)
 {
     PyObject* m;
     PyObject* d;

Modules/pyexpat.c

@@ -1583,10 +1583,9 @@ get_version_string(void)
 #define MODULE_INITFUNC initpyexpat
 #endif
 
-void MODULE_INITFUNC(void);  /* avoid compiler warnings */
+PyMODINIT_FUNC MODULE_INITFUNC(void);  /* avoid compiler warnings */
 
-DL_EXPORT(void)
-MODULE_INITFUNC(void)
+PyMODINIT_FUNC MODULE_INITFUNC(void)
 {
     PyObject *m, *d;
     PyObject *errmod_name = PyString_FromString(MODULE_NAME ".errors");

PC/_winreg.c

@@ -1423,7 +1423,7 @@ inskey(PyObject * d, char * name, HKEY key)
 
 #define ADD_KEY(val) inskey(d, #val, val)
 
-__declspec(dllexport) void init_winreg(void)
+PyMODINIT_FUNC init_winreg(void)
 {
 	PyObject *m, *d;
 	m = Py_InitModule3("_winreg", winreg_methods, module_doc);