Windows compatibility

Author: Kijewski

.github/workflows/build_wheels.yml

@@ -37,37 +37,34 @@ jobs:
         with:
           submodules: true
 
-      - name: Cache pip
-        uses: actions/cache@v2
-        with:
-          key: cache--${{ github.event.inputs.os }}--${{ github.event.inputs.python }}--${{ hashFiles('./requirements.txt') }}
-          path: ~/.cache/pip
-
       - name: Setup python
         uses: actions/setup-python@v2
         with:
           python-version: ${{ github.event.inputs.python }}
 
       - name: Update pip
-        run: python -m pip install -U pip wheel setuptools
+        run: python3 -m pip install -U pip wheel setuptools
 
       - name: Install requirements
-        run: python -m pip install -Ur requirements.txt
+        run: python3 -m pip install -Ur requirements.txt
 
       - name: Cythonize
         run: make _pytidyhtml5.cpp
 
       - name: Build wheels
-        run: python -m cibuildwheel --output-dir wheelhouse
+        run: python3 -m cibuildwheel --output-dir wheelhouse-${{ github.event.inputs.manylinux }}-${{ github.event.inputs.os }}
         env:
           CIBW_SKIP: "cp27-* cp34-* cp35-* pp27-*"
           CIBW_MANYLINUX_X86_64_IMAGE: ${{ github.event.inputs.manylinux }}
           CIBW_MANYLINUX_I686_IMAGE: ${{ github.event.inputs.manylinux }}
           CIBW_ARCHS: ${{ github.event.inputs.archs }}
+          CIBW_ARCHS_WINDOWS: auto64
           CIBW_BEFORE_BUILD: make clean-artifacts && make tidy-html5/build/cmake/libtidy.a
+          CIBW_BUILD_FRONTEND: pip
+          CIBW_TEST_COMMAND: "{project}/basic-sanity-test.py"
 
       - name: Store artifacts
         uses: actions/upload-artifact@v2
         with:
-          name: Wheelhouse
-          path: ./wheelhouse/*.whl
+          name: Wheelhouse-${{ github.event.inputs.manylinux }}-${{ github.event.inputs.os }}
+          path: ./wheelhouse-${{ github.event.inputs.manylinux }}-${{ github.event.inputs.os }}/*.whl

Makefile

@@ -4,7 +4,7 @@ all: sdist bdist_wheel docs
 
 NAME := pytidyhtml5
 
-.PHONY: all sdist bdist_wheel clean docs prepare clean-generated clean-artifacts
+.PHONY: all sdist bdist_wheel clean docs prepare clean-generated clean-artifacts export-environ
 
 FILES := Makefile MANIFEST.in _${NAME}.pyx README.rst setup.py \
          lib/native.hpp lib/VERSION.txt lib/DESCRIPTION.txt \
@@ -17,25 +17,43 @@ TIDY_CFLAGS += -fstack-protector-strong --param=ssp-buffer-size=8
 TIDY_CFLAGS += -fvisibility=internal -fmerge-all-constants
 TIDY_CFLAGS += -std=c11 -D_ISOC11_SOURCE -D_FORTIFY_SOURCE=2 -D_GNU_SOURCE
 
-export CC = $(shell which gcc clang g++ clang++ | head -n1)
-export CXX = $(shell which g++ clang++ gcc clang | head -n1)
-export AR = $(shell which gcc-ar llvm-ar ar | head -n1)
-export RANLIB = $(shell which gcc-ranlib llvm-ranlib ranlib | head -n1)
 
-$(info CC=${CC})
-$(info CXX=${CXX})
-$(info AR=${AR})
-$(info RANLIB=${RANLIB})
+CC:=$(shell which gcc clang g++ clang++ | head -n1 2> /dev/null)
+CXX:=$(shell which g++ clang++ gcc clang | head -n1 2> /dev/null)
+AR:=$(shell which gcc-ar llvm-ar ar | head -n1 2> /dev/null)
+RANLIB:=$(shell which gcc-ranlib llvm-ranlib ranlib | head -n1 2> /dev/null)
+
+ifeq ($(findstring */c/,*${CC}),*/c/)
+  CC:=$(patsubst /c/%,c:/%,${CC}).exe
+endif
+
+ifeq ($(findstring */c/,*${CXX}),*/c/)
+  CXX:=$(patsubst /c/%,c:/%,${CXX}).exe
+endif
+
+ifeq ($(findstring */c/,*${AR}),*/c/)
+  AR:=$(patsubst /c/%,c:/%,${AR}).exe
+endif
+
+ifeq ($(findstring */c/,*${RANLIB}),*/c/)
+  RANLIB:=$(patsubst /c/%,c:/%,${RANLIB}).exe
+endif
+
+export CC
+export CXX
+export AR
+export ARFLAGS
+export RANLIB
+
 
 tidy-html5/.git:
 	git submodule init
 	git submodule update
 
 tidy-html5/build/cmake/libtidy.a: | tidy-html5/.git
-	mkdir -p tidy-html5/build/
-
 	cd tidy-html5/build/cmake && \
 		cmake ../.. \
+			"-GUnix Makefiles" \
 			-DCMAKE_BUILD_TYPE=Release \
 			-DBUILD_SHARED_LIBS=OFF \
 			-DCMAKE_C_FLAGS="${TIDY_CFLAGS}" \
@@ -45,35 +63,44 @@ tidy-html5/build/cmake/libtidy.a: | tidy-html5/.git
 			-DCMAKE_RANLIB="${RANLIB}"
 
 	cd tidy-html5/build/cmake/ && \
-		$(MAKE) VERBOSE=1 -B
+		$(MAKE) VERBOSE=1 -B tidy-static
 
+	-mv tidy-html5/build/cmake/libtidy_static.a tidy-html5/build/cmake/libtidy.a
 	$(RANLIB) $@
 
-	-rm tidy-html5/build/cmake/libtidy.so
+	-rm tidy-html5/build/cmake/libtidy.so*
 
 lib/_import_tidy_enum.pyx:
 	./generate_imports.py
 
 _${NAME}.cpp: _${NAME}.pyx $(wildcard lib/*.pyx) | lib/_import_tidy_enum.pyx
 	-rm -- dist/*.so
 	-rm ./_${NAME}.cpp
-	python -m Cython.Build.Cythonize -f $<
+
+	python3 -m Cython.Build.Cythonize -f $<
+
+	sed -i -e '1s;^;#ifdef _WIN64\
+static void hypot() {}\
+namespace std { static void _hypot() {} }\
+#include <cmath>\
+#endif\
+;' -e 's/%z/%" PY_FORMAT_SIZE_T "/g' $@
 
 prepare: _${NAME}.cpp ${FILES}
 
 sdist: _${NAME}.cpp ${FILES}
 	-rm -- dist/${NAME}-*.tar.gz
-	python setup.py sdist --format=gztar
-	python setup.py sdist --format=xztar
+	python3 setup.py sdist --format=gztar
+	python3 setup.py sdist --format=xztar
 
 bdist_wheel: _${NAME}.cpp ${FILES} | sdist
 	-rm -- dist/${NAME}-*.whl
-	python setup.py bdist_wheel
+	python3 setup.py bdist_wheel
 
 docs: bdist_wheel $(wildcard docs/* docs/*/*)
 	-rm -r -- dist/html/
 	pip install --force dist/${NAME}-*.whl
-	python -m sphinx -M html docs/ dist/
+	python3 -m sphinx -M html docs/ dist/
 
 clean: clean-generated clean-artifacts
 
@@ -88,3 +115,10 @@ clean-artifacts:
 	-rm -r -- ./dist/
 	-rm -r -- ./"${NAME}.egg-info/"
 	-pip uninstall pytidyhtml5 -y
+
+export-environ:
+	@echo CC=${CC}
+	@echo CXX=${CXX}
+	@echo AR=${AR}
+	@echo ARFLAGS=${ARFLAGS}
+	@echo RANLIB=${RANLIB}

basic-sanity-test.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+
+import pytidyhtml5
+
+pytidyhtml5.set_language('de')
+expected = (
+    '<!DOCTYPE html>\n<html>\n<head>\n<meta name="generator" content="HTML Tidy for HTML5 for Linux version 5.8.0">\n<title></title>\n</head>\n<body>\nHall&ouml;chen\n</body>\n</html>\n',
+    "Zeile 1 Spalte 1 - Warnung: fehlende <!DOCTYPE> Deklaration\nZeile 1 Spalte 1 - Warnung: Klartext ist im Element <head> nicht erlaubt\nZeile 1 Spalte 1 - Info: <head> bereits vermerkt\nZeile 1 Spalte 1 - Warnung: füge implizites <body> ein\nZeile 1 Spalte 1 - Warnung: füge fehlendes 'title' Element ein\n"
+)
+actual = pytidyhtml5.tidy_document('Hallöchen')
+if expected != actual:
+    print('actual=' + repr(actual))
+    raise SystemExit(1)
+
+print('OK')

setup.py

@@ -1,8 +1,12 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 from os.path import dirname, join, abspath
+from os import environ
 from platform import system
 from setuptools import setup, Extension
+from subprocess import check_output
+from sys import argv
+from traceback import print_last
 
 
 def get_text(name):
@@ -25,6 +29,7 @@ def get_text(name):
         '-Wl,-zrelro,-znow,-zcombreloc,-znocommon,-znoexecstack',
     ]
 else:
+    # OSX or Windows
     extra_compile_args = [
         '-std=c++11', '-flto',
         '-O2', '-fomit-frame-pointer', '-fPIC', '-ggdb1', '-pipe',
@@ -37,8 +42,49 @@ def get_text(name):
         '-fPIC',
     ]
 
-name = 'pytidyhtml5'
+if system() == 'Windows':
+    # I cannot get cibuildwheel to accept my CC + CXX overrides. :(
+    # So monkey patching it is ...
+
+    for line in check_output(['make', 'export-environ']).decode('UTF-8').splitlines():
+        (key, value) = line.split('=', 1)
+        environ[key] = value
+
+    import distutils.command.build_ext
+
+    def customize_compiler(compiler):
+        compiler_settings = [
+            environ['CXX'], '-m64',
+            '-Wall', '-Wno-unused-result', '-Wformat', '-Werror=format-security', '-Wdate-time',
+            '-O2', '-g', '-fwrapv', '-fstack-protector-strong',
+            '-DNDEBUG', '-D_FORTIFY_SOURCE=2',
+
+            '-DMS_WIN64', # https://github.com/cython/cython/issues/3405#issuecomment-596975159
+        ]
+
+        compiler.preprocessor = [environ['CXX'], '-m64', '-E', '-Wdate-time', '-D_FORTIFY_SOURCE=2']
+        compiler.compiler = [*compiler_settings]
+        compiler.compiler_cxx = [*compiler_settings]
+        compiler.compiler_so = [*compiler_settings, '-fPIC']
+        compiler.linker_so = [*compiler_settings, '-shared']
+        compiler.linker_exe = [*compiler_settings, '-fPIC']
+        compiler.archiver = [environ['AR'], environ['ARFLAGS']]
+        compiler.ranlib = [environ['RANLIB']]
 
+    class build_ext(distutils.command.build_ext.build_ext):
+        def run(self):
+            self.compiler = 'unix'
+            return super().run()
+
+        def build_extensions(self):
+            print('self.compiler', repr(vars(self.compiler)))
+            return super().build_extensions()
+
+    distutils.command.build_ext.customize_compiler = customize_compiler
+    distutils.command.build_ext.build_ext = build_ext
+
+
+name = 'pytidyhtml5'
 setup(
     name=name,
     version=get_text('VERSION.txt'),
@@ -63,11 +109,13 @@ def get_text(name):
     platforms=['any'],
     license='ISC',
     classifiers=[
-        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
         'Intended Audience :: System Administrators',
         'License :: OSI Approved :: ISC License (ISCL)',
-        'Operating System :: OS Independent',
+        'Operating System :: POSIX :: Linux',
+        'Operating System :: MacOS :: MacOS X',
+        'Operating System :: Microsoft :: Windows',
         'Programming Language :: Cython',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3.6',