Reworked the way C/C++ header files are used and installed

Author: intjelic

include/Includes/pysfml/audio.pxd

@@ -8,15 +8,15 @@
 cimport sfml as sf
 from pysfml.system cimport Int16
 
-cdef extern from "pysfml/audio.h":
+cdef extern from "pysfml/audio/audio.h":
 
 cdef class Chunk[type PyChunkType, object PyChunkObject]:
     cdef class sfml.audio.Chunk [object PyChunkObject]:
         cdef Int16* m_samples
         cdef size_t m_sampleCount
         cdef bint   delete_this
 
-cdef extern from "pysfml/audio_api.h":
+cdef extern from "pysfml/audio/audio_api.h":
     cdef void import_sfml__audio()
 
     cdef object create_chunk()

include/Includes/pysfml/graphics.pxd

@@ -9,7 +9,7 @@ cimport sfml as sf
 from pysfml.system cimport Vector2
 from pysfml.system cimport NumericObject
 
-cdef extern from "pysfml/graphics.h":
+cdef extern from "pysfml/graphics/graphics.h":
     cdef class sfml.graphics.Rect [object PyRectObject]:
         cdef sf.Rect[NumericObject] *p_this
 
@@ -49,7 +49,7 @@ cdef extern from "pysfml/graphics.h":
     cdef class sfml.graphics.RenderStates [object PyRenderStatesObject]:
         pass
 
-cdef extern from "pysfml/graphics_api.h":
+cdef extern from "pysfml/graphics/graphics_api.h":
     cdef void import_sfml__graphics()
 
     cdef Color wrap_color(sf.Color *p)

include/Includes/pysfml/network.pxd

@@ -7,5 +7,5 @@
 
 cimport sfml as sf
 
-cdef extern from "pysfml/network_api.h":
+cdef extern from "pysfml/network/network_api.h":
     cdef void import_sfml__network()

include/Includes/pysfml/system.pxd

@@ -7,15 +7,15 @@
 
 cimport sfml as sf
 
-cdef extern from "pysfml/NumericObject.hpp":
+cdef extern from "pysfml/system/NumericObject.hpp":
     cdef cppclass NumericObject:
         NumericObject()
         NumericObject(object)
 
         object get()
         void set(object)
 
-cdef extern from "pysfml/system.h":
+cdef extern from "pysfml/system/system.h":
     cdef class sfml.system.Vector2 [object PyVector2Object]:
         cdef sf.Vector2[NumericObject] *p_this
 
@@ -25,7 +25,7 @@ cdef extern from "pysfml/system.h":
     cdef class sfml.system.Time [object PyTimeObject]:
         cdef sf.Time *p_this
 
-cdef extern from "pysfml/system_api.h":
+cdef extern from "pysfml/system/system_api.h":
     int import_sfml__system()
 
     object popLastErrorMessage()

include/Includes/pysfml/window.pxd

@@ -8,7 +8,7 @@
 cimport sfml as sf
 from sfml cimport Uint8
 
-cdef extern from "pysfml/window.h":
+cdef extern from "pysfml/window/window.h":
     cdef class sfml.window.VideoMode [object PyVideoModeObject]:
         cdef sf.VideoMode *p_this
         cdef bint delete_this
@@ -29,7 +29,7 @@ cdef extern from "pysfml/window.h":
         cdef bint            m_visible
         cdef bint            m_vertical_synchronization
 
-cdef extern from "pysfml/window_api.h":
+cdef extern from "pysfml/window/window_api.h":
     cdef void import_sfml__window()
 
     cdef VideoMode wrap_videomode(sf.VideoMode *p, bint d)

setup.py

@@ -16,37 +16,57 @@
 	arch = "x64"
 
 class CythonBuildExt(build_ext):
-    """ Updated version of cython build_ext command to move
-    the generated API headers to include/pysfml directory
+    """ Updated version of cython build_ext command to deal with the
+        generated API headers. C/C++ header files are all moved to the
+        temporary build directory before being properly installed on
+        the system.
     """
 
     def cython_sources(self, sources, extension):
+
+        # cythonize .pxd source files
         ret = build_ext.cython_sources(self, sources, extension)
 
         # should result the module name; e.g, graphics[.pyx]
         module = os.path.basename(sources[0])[:-4]
 
-        # move its headers (foo.h and foo_api.h) to include/pysfml
-        destination = os.path.join('include', 'pysfml')
-
-        filename = module + '.h'
-        source = os.path.join('src', 'sfml', module, filename)
-        if os.path.isfile(source):
-            try:
-                shutil.move(source, destination)
-            except shutil.Error:
-                pass
-
-        filename = module + '_api.h'
-        source = os.path.join('src', 'sfml', module, filename)
-        if os.path.isfile(source):
-            try:
-                shutil.move(source, destination)
-            except shutil.Error:
-                pass
+        # prepare a list with all header files related to the module (*.hpp, *_api.h, *.h)
+        header_files = glob(os.path.join('src', 'sfml', module, '*.hpp'))
 
-        return ret
+        header_files.append(os.path.join('src', 'sfml', module, module + '.h'))
+        header_files.append(os.path.join('src', 'sfml', module, module + '_api.h'))
+
+        # deal with exceptions
+        if module == "network":
+            header_files.remove(os.path.join('src', 'sfml', module, module + '.h'))
+            header_files.remove(os.path.join('src', 'sfml', module, module + '_api.h'))
+
+        # create the temporary destination in the build directory
+        destination = os.path.join(self.build_temp, 'include', 'pysfml', module)
+
+        if not os.path.exists(destination):
+            os.makedirs(destination)
+
+        # move all header files to the build directory
+        for header_file in header_files:
+            if os.path.isfile(header_file):
+                try:
+                    shutil.copy(header_file, destination)
+                except shutil.Error:
+                    pass
+
+        # add the temporary header directory to compilation options
+        self.compiler.include_dirs.append(os.path.join(self.build_temp, 'include'))
+
+        # update data_files to install the files on the system
 
+        # On Windows: C:\Python27\include\pysfml\*_api.h
+        # On Unix: /usr/local/include/pysfml/*_api.h
+        install_directory = os.path.join(sys.exec_prefix, 'include', 'pysfml', module)
+        files_to_install = [os.path.join(self.build_temp, 'include', 'pysfml', module, os.path.basename(header_file)) for header_file in header_files]
+        data_files.append((install_directory, files_to_install))
+
+        return ret
 
 modules = ['system', 'window', 'graphics', 'audio', 'network']
 
@@ -57,7 +77,6 @@ def cython_sources(self, sources, extension):
 include_path = os.path.join('include', 'pysfml')
 source_path = os.path.join('src', 'sfml')
 
-
 # clean the directory (remove generated C++ files by Cython)
 def remove_if_exist(filename):
     if os.path.isfile(filename):
@@ -86,7 +105,7 @@ def remove_if_exist(filename):
     extension = lambda name, files, libs: Extension(
         name='sfml.' + name,
         sources= [os.path.join('src', 'sfml', name, filename) for filename in files],
-        include_dirs=['include', 'include/Includes'],
+        include_dirs=['include/Includes'],
         language='c++',
         libraries=libs,
         extra_compile_args=['-fpermissive']
@@ -119,29 +138,10 @@ def remove_if_exist(filename):
 
 major, minor, _, _ , _ = sys.version_info
 
-files = []
-
-# Install C headers
-c_api_headers = []
-c_api_headers.append(os.path.join(include_path, 'system.h'))
-c_api_headers.append(os.path.join(include_path, 'system_api.h'))
-c_api_headers.append(os.path.join(include_path, 'NumericObject.hpp'))
-c_api_headers.append(os.path.join(include_path, 'window.h'))
-c_api_headers.append(os.path.join(include_path, 'window_api.h'))
-c_api_headers.append(os.path.join(include_path, 'graphics.h'))
-c_api_headers.append(os.path.join(include_path, 'graphics_api.h'))
-c_api_headers.append(os.path.join(include_path, 'audio_api.h'))
-
-if platform.system() == 'Windows':
-    # On Windows: C:\Python27\include\pysfml\*_api.h
-    files = [(sys.exec_prefix +'\\include\\pysfml', c_api_headers)]
-else:
-    # On Unix: /usr/local/include/pysfml/*_api.h
-    files = [(sys.exec_prefix + '/include/pysfml', c_api_headers)]
-
+data_files = []
 if platform.system() == 'Windows':
     dlls = [("Lib\\site-packages\\sfml", glob('extlibs/sfml/bin/' + arch + '/*.dll'))]
-    files += dlls
+    data_files += dlls
 
 with open('README.rst', 'r') as f:
     long_description = f.read()
@@ -153,7 +153,7 @@ def remove_if_exist(filename):
             ext_modules=ext_modules,
             package_dir={'': 'src'},
             packages=['sfml'],
-            data_files=files,
+            data_files=data_files,
             version='2.2.0',
             description='Python bindings for SFML',
             long_description=long_description,

src/sfml/audio/DerivableSoundRecorder.cpp

@@ -7,7 +7,7 @@
 * license.
 */
 
-#include "DerivableSoundRecorder.hpp"
+#include <pysfml/audio/DerivableSoundRecorder.hpp>
 #include <iostream>
 
 DerivableSoundRecorder::DerivableSoundRecorder(void* pyobj):

src/sfml/audio/DerivableSoundRecorder.hpp

@@ -12,8 +12,7 @@
 
 #include "Python.h"
 #include <SFML/Audio.hpp>
-#include "pysfml/audio_api.h"
-
+#include <pysfml/audio/audio_api.h>
 
 class DerivableSoundRecorder : public sf::SoundRecorder
 {

src/sfml/audio/DerivableSoundStream.cpp

@@ -7,7 +7,7 @@
 * license.
 */
 
-#include "DerivableSoundStream.hpp"
+#include <pysfml/audio/DerivableSoundStream.hpp>
 
 DerivableSoundStream::DerivableSoundStream(void* pyobj):
 sf::SoundStream (),

src/sfml/audio/DerivableSoundStream.hpp

@@ -12,9 +12,9 @@
 
 #include "Python.h"
 #include <SFML/Audio.hpp>
-#include "pysfml/NumericObject.hpp"
-#include "pysfml/audio_api.h"
-#include "pysfml/system_api.h"
+#include <pysfml/audio/audio_api.h>
+#include <pysfml/system/NumericObject.hpp>
+#include <pysfml/system/system_api.h>
 
 class DerivableSoundStream : public sf::SoundStream
 {