BLD: Simplify library linking on Windows

Kojoley · Kojoley · commit 0a8973428a4a · 2017-11-19T22:02:59.000+03:00
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -43,6 +43,7 @@ environment:
       CONDA_NPY: "111"
       CONDA_INSTALL_LOCN: "C:\\Miniconda36-x64"
       TEST_ALL: "no"
+      MPLSTATICBUILD: True
 
 # We always use a 64-bit machine, but can build x86 distributions
 # with the PYTHON_ARCH variable (which is used by CMD_IN_ENV).
@@ -99,17 +100,6 @@ install:
     curl -sL https://github.com/python/cpython/pull/1224.patch |
     patch -fsup 1 -d %CONDA_PREFIX% ) || ( set errorlevel= )
 
-  # Let the install prefer the static builds of the libs
-  - set LIBRARY_LIB=%CONDA_PREFIX%\Library\lib
-  - mkdir lib || cmd /c "exit /b 0"
-  - copy /y %LIBRARY_LIB%\zlibstatic.lib lib\z.lib
-  - copy /y %LIBRARY_LIB%\libpng_static.lib lib\png.lib
-  # These z.lib / png.lib are not static versions but files which end up as
-  # dependencies to the dll file. This is fine for the conda build, but not here
-  # and for the wheels
-  - del %LIBRARY_LIB%\png.lib
-  - del %LIBRARY_LIB%\z.lib
-  - set MPLBASEDIRLIST=%CONDA_PREFIX%\Library\;.
   # enables the local freetype build
   - copy ci\travis\setup.cfg .
   # Show the installed packages + versions
@@ -120,9 +110,9 @@ test_script:
   - '%CMD_IN_ENV% pip install -ve .'
   # these should show no z, png, or freetype dll...
   - set "DUMPBIN=%VS140COMNTOOLS%\..\..\VC\bin\dumpbin.exe"
-  - '"%DUMPBIN%" /DEPENDENTS lib\matplotlib\ft2font*.pyd | findstr freetype.*.dll && exit /b 1 || exit /b 0'
-  - '"%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr z.*.dll && exit /b 1 || exit /b 0'
-  - '"%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr png.*.dll && exit /b 1 || exit /b 0'
+  - 'if x%MPLSTATICBUILD% == xTrue "%DUMPBIN%" /DEPENDENTS lib\matplotlib\ft2font*.pyd | findstr freetype.*.dll && exit /b 1 || exit /b 0'
+  - 'if x%MPLSTATICBUILD% == xTrue "%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr z.*.dll && exit /b 1 || exit /b 0'
+  - 'if x%MPLSTATICBUILD% == xTrue "%DUMPBIN%" /DEPENDENTS lib\matplotlib\_png*.pyd | findstr png.*.dll && exit /b 1 || exit /b 0'
 
   # this are optional dependencies so that we don't skip so many tests...
   - if x%TEST_ALL% == xyes conda install -q ffmpeg inkscape miktex pillow
@@ -144,15 +134,14 @@ after_test:
   # After the tests were a success, build packages (wheels and conda)
 
   # Build the wheel with the static libs
+  - set MPLSTATICBUILD=True
   # Hide the output, the copied files really clutter the build log...
   - '%CMD_IN_ENV% python setup.py bdist_wheel > NUL:'
 
   # And now the conda build after a cleanup...
   # cleanup build files so that they don't pollute the conda build but keep the wheel in dist...
+  - set MPLSTATICBUILD=
   - git clean -xdfq -e dist/
-  # cleanup the environment so that the test-environment does not leak into the conda build...
-  - set MPLBASEDIRLIST=
-  - set LIBRARY_LIB=
   - deactivate
   - path
   - where python
diff --git a/INSTALL.rst b/INSTALL.rst
@@ -332,22 +332,12 @@ without fiddling with environment variables::
   # for Python 2.7
   conda install -c conda-forge backports.functools_lru_cache
 
-  # copy the libs which have "wrong" names
-  set LIBRARY_LIB=%CONDA_DEFAULT_ENV%\Library\lib
-  mkdir lib || cmd /c "exit /b 0"
-  copy %LIBRARY_LIB%\zlibstatic.lib lib\z.lib
-  copy %LIBRARY_LIB%\libpng_static.lib lib\png.lib
-
-  # Make the header files and the rest of the static libs available during the build
-  # CONDA_DEFAULT_ENV is a env variable which is set to the currently active environment path
-  set MPLBASEDIRLIST=%CONDA_DEFAULT_ENV%\Library\;.
+  # force the build against static libpng and zlib libraries
+  set MPLSTATICBUILD=True
 
   # build the wheel
   python setup.py bdist_wheel
 
-The `build_alllocal.cmd` script in the root folder automates these steps if
-you have already created and activated the conda environment.
-
 
 Conda packages
 ^^^^^^^^^^^^^^
diff --git a/build_alllocal.cmd b/build_alllocal.cmd
diff --git a/ci/conda_recipe/bld.bat b/ci/conda_recipe/bld.bat
@@ -1,16 +1,9 @@
-set LIBPATH=%LIBRARY_LIB%;
-set INCLUDE=%INCLUDE%;%PREFIX%\Library\include\freetype2
-
 ECHO [directories] > setup.cfg
 ECHO basedirlist = %LIBRARY_PREFIX% >> setup.cfg
 ECHO [packages] >> setup.cfg
 ECHO tests = False >> setup.cfg
 ECHO sample_data = False >> setup.cfg
 ECHO toolkits_tests = False >> setup.cfg
 
-@rem workaround for https://github.com/matplotlib/matplotlib/issues/6460
-@rem see also https://github.com/conda-forge/libpng-feedstock/pull/4
-copy /y %LIBRARY_LIB%\libpng16.lib %LIBRARY_LIB%\png.lib
-
 %PYTHON% setup.py install --single-version-externally-managed --record=record.txt
 if errorlevel 1 exit 1
diff --git a/setupext.py b/setupext.py
@@ -88,7 +88,8 @@ def _get_xdg_cache_dir():
     'display_status': True,
     'verbose': False,
     'backend': None,
-    'basedirlist': None
+    'basedirlist': None,
+    'staticbuild': False,
     }
 
 
@@ -119,6 +120,9 @@ def _get_xdg_cache_dir():
 lft = bool(os.environ.get('MPLLOCALFREETYPE', False))
 options['local_freetype'] = lft or options.get('local_freetype', False)
 
+staticbuild = bool(os.environ.get('MPLSTATICBUILD', True))
+options['staticbuild'] = staticbuild or options.get('staticbuild', False)
+
 
 def get_win32_compiler():
     """
@@ -307,6 +311,23 @@ def get_file_hash(filename):
     return hasher.hexdigest()
 
 
+def deplib(libname):
+    if sys.platform != 'win32':
+        return libname
+
+    known_libs = {
+        # TODO: support versioned libpng on build system revrite
+        'png': ('libpng', '_static'),
+        'z': ('zlib', 'static'),
+    }
+
+    libname, static_postfix = known_libs[libname]
+    if options['staticbuild']:
+        libname += static_postfix
+
+    return libname
+
+
 class PkgConfig(object):
     """
     This is a class for communicating with pkg-config.
@@ -1122,7 +1143,7 @@ def add_flags(self, ext):
                     'lib/freetype2/include/freetype2'],
                 default_library_dirs=[
                     'freetype2/lib'],
-                default_libraries=['freetype', 'z'])
+                default_libraries=['freetype', deplib('z')])
             ext.define_macros.append(('FREETYPE_BUILD_TYPE', 'system'))
 
     def do_custom_build(self):
@@ -1320,7 +1341,7 @@ def get_extension(self):
             ]
         ext = make_extension('matplotlib._png', sources)
         pkg_config.setup_extension(
-            ext, 'libpng', default_libraries=['png', 'z'],
+            ext, 'libpng', default_libraries=map(deplib, ['png', 'z']),
             alt_exec='libpng-config --ldflags')
         Numpy().add_flags(ext)
         return ext
