Updates for newer Windows toolchain

README-windows.txt

@@ -4,47 +4,51 @@ Common Setup
 You may need to disable antivirus software to run qpdf's test suite.
 
 To be able to build qpdf and run its test suite, you must have MSYS
-from MinGW installed, and you must have ActiveState Perl.  Here's what
+from MinGW installed, and you must have ActiveState Perl. The Perl
-I did on my system:
+provided by MSYS won't work reliably. It partially works, but some
+tests will fail with it because it doesn't support all the
+capabilities required by the test driver. Here's what I did on my
+system:
 
-Install ActiveState perl.
+Install ActiveState perl. The versions of perl included with git bash
+and mingw are not able to run the test suite.
 
-Grab the latest mingw-get-inst.  From the installation wizard, choose
+Install MinGW-w64. From MinGW-w64 download page, grab the installer
-to install developer kit, C, and C++ support.  Once installed, you
+and run it. First install the i686 compiler to C:\mingw-w64, and then
-will have an icon to start an msys shell.  From the msys shell, run
+install x86_64 compiler to the same location. The installer will
+automatically created mingw32 and mingw64 directories under mingw-w64.
 
-mingw-get install msys-unzip msys-zip mingw32-make
+Grab the latest mingw-get-inst from the MinGW project. We are using
+this for shell and build utilties but not for the compiler. Run the
+installer.
 
-Then replace perl and make with the appropriate versions:
+Install under basic:
+  mingw-developer-toolkit
+  msys-base
 
-mv /bin/perl.exe /bin/msys-perl.exe
+Use C:\mingw32\msys\1.0\msys.bat to start a shell. In the shell, run
-mv /bin/make.exe /bin/msys-make.exe
-mv /mingw/bin/mingw32-make.exe /mingw/bin/make.exe
 
-Make sure perl --version shows ActiveState perl.
+mingw32-get install msys-zip
 
-To install MinGW-w64, first install msys and mingw32 as above.
+Add to path in this order:
+  C:\mingw32\msys\1.0\bin
+  C:\mingw-w64\mingw64\bin
+  C:\mingw-w64\mingw32\bin
 
-From MinGW-w64 download page, go to "Toolchains targeting
+ensuring that they are after ActiveState perl.
-Win64/Automated Builds" and find the latest mingw-w64 that runs under
-i686-mingw.  It will be called something like
-mingw-w64-bin_i686-mingw_yyyymmdd.zip.  The compiler binaries are
-32-bit, which (of course) runs on 64-bit Windows.  Extract this under
-C:\MinGW-w64, and add C:\MinGW-w64\bin and C:\MinGW-w64\lib\mingw to
-the path.
 
-Starting in version 4.1.0, qpdf uses std::setprecision and std::fixed
+Check to make sure zip and unzip are in your path, make --version
-to format floating point numbers, and using one or both of those
+shows at least 3.81, perl --version shows the perl from ActiveState,
-causes a crash with the version of libstdc++-6 that is included with
+and gcc --version is the 64-bit gcc. (zip is not actually needed
-mingw-w64-bin_i686-mingw_20111220.zip, which appears to be the latest
+unless you are running the tools to create the releases.)
-mingw-hosted version of mingw that targets w64 that includes the full
+
-toolchain including all the DLL creation tools.  To work around this,
+Install suitable Microsoft Visual Studio edition. In early 2016, 2015
-for my personal build, I have grabbed
+community edition with C++ support is fine. It may crash a few times
-x86_64-w64-mingw32-gcc-4.7.2-release-win64_rubenvb.7z from the
+during installation, but repeating the installation will allow it to
-personal builds and just extracted libstdc++-6.dll from there and used
+finish, and the resulting software is stable.
-that to replace the one in the 20111220 version, which is based on
+
-4.7.0.  That particular workaround results in a Windows-hosted 64-bit
+To build qpdf, start the msys shell from a command window started from
-targetted mingw that can build a qpdf that passes its test suite.
+one of the Visual Studio shell windows.
 
 Image comparison tests are disabled by default, but it is possible to
 run them on Windows. To do so, add --enable-test-compare-images from
@@ -76,12 +80,6 @@ installers are provided, they might do that already by default.
    binaries. Using "mklink" with "gswin32c.exe" is probably the best
    choice.
 
-Jian Ma <stronghorse@tom.com> has generously provided a port of QPDF
-that works with Microsoft VC6.  Several changes are required, but they
-are well documented in his port.  You can find the VC6 port in the
-contrib area of the qpdf download area.  It may not always be
-up-to-date with the latest official qpdf release.
-
 
 External Libraries
 ==================
@@ -129,13 +127,13 @@ autofiles.zip that you can extract on top of a fresh checkout.
 Building with MinGW
 ===================
 
-QPDF is known to build and pass its test suite with mingw (latest
+QPDF is known to build and pass its test suite with mingw-w64 using
-version tested: gcc 4.6.2), mingw64 (latest version tested: 4.7.0) and
+the 32-bit and 64-bit compilers from that project (latest version
-Microsoft Visual C++ 2010, both 32-bit and 64-bit versions.  MSYS plus
+tested: 5.3.0) and Microsoft Visual C++ 2015, both 32-bit and 64-bit
-ActiveState Perl is required to build as well in order to get make
+versions. MSYS plus ActiveState Perl is required to build as well in
-and other related tools.  While it is possible that Cygwin could be
+order to get make and other related tools. While it is possible that
-used to build native Windows versions of qpdf, this configuration has
+Cygwin could be used to build native Windows versions of qpdf, this
-not been tested recently.
+configuration has not been tested recently.
 
 From your MSYS prompt, run
 
@@ -151,13 +149,7 @@ and then
 
 Note that ./config-mingw32 and ./configure-mingw64 just run
 ./configure with specific arguments, so you can look at it, make
-adjustments, and manually run configure instead.  Note also that
+adjustments, and manually run configure instead.
-config-mingw32 appends definition of _FILE_OFFSET_BITS=64 to
-qpdf-config.h since, as of the qpdf 3.0 release, the current versions
-of the autoconf tools did not correctly detect that mingw requires
-this to get large file support.  This workaround is only required for
-mingw32.  The 64-bit version of mingw works "out of the box" with
-large file support, as do both the 32-bit and 64-bit versions of MSVC.
 
 Add the absolute path to the libqpdf/build directory to your PATH.
 Make sure you can run the qpdf command by typing qpdf/build/qpdf and
@@ -177,13 +169,11 @@ You can also take a look at make_windows_releases for reference.  This
 is how the distributed Windows executables are created.
 
 
-Building with MSVC 2010
+Building with MSVC 2015
 =======================
 
-These instructions would likely work with newer version of MSVC or
+These instructions would likely work with newer versions of MSVC and
-with full version of MSVC.  They may also work with .NET 2005.  They
+are known to have worked with versions as old as 2008 Express.
-have only been tested with Visual C++ 2010.  Earlier version of qpdf
-were built with MSVC 2008 Express.
 
 You should first set up your environment to be able to run MSVC from
 the command line.  There is usually a batch file included with MSVC
@@ -192,7 +182,8 @@ configured for whichever of 32-bit or 64-bit output that you intend to
 build for.
 
 From that cmd prompt, you can start your msys shell by just running
-manually whatever command is associated with your msys shell icon.
+manually whatever command is associated with your msys shell icon
+(such as C:\MinGW\msys\1.0\msys.bat).
 
 Configure as follows:
 
@@ -266,4 +257,6 @@ across the DLL to EXE boundary.  Since qpdf uses exception handling
 extensively for error handling, we have no choice but to redistribute
 the C++ runtime DLLs.  Maybe this will be addressed in a future
 version of the compilers.  This has not been retested with the
-toolchain versions used to create qpdf 3.0 distributions.
+toolchain versions used to create qpdf 3.0 distributions. (This has
+not been revisited since MSVC 2008, but redistrbuting runtime DLLs is
+extremely common and should not be a problem.)

config-mingw32

@@ -1,13 +1,11 @@
 #!/bin/sh
-./configure --disable-test-compare-images --enable-external-libs --enable-werror --with-windows-wordsize=32 --with-buildrules=mingw ${1+"$@"}
+./configure --disable-test-compare-images --enable-external-libs --enable-werror --with-windows-wordsize=32 --with-buildrules=mingw \
-# As of autoconf 2.69 and gcc 4.6, autoconf's configure fails to
+    CC=i686-w64-mingw32-gcc \
-# recognize that defining _FILE_OFFSET_BITS works with mingw32.
+    CXX=i686-w64-mingw32-g++ \
-# Append to qpdf-config.h rather than passing CPPFLAGS on the
+    LD=i686-w64-mingw32-ld \
-# commandline.  This way we don't defeat the fact that test_large_file
+    AR=i686-w64-mingw32-ar \
-# and other things that only use the public interface can be built
+    RANLIB=i686-w64-mingw32-ranlib \
-# without any special flags.
+    DLLTOOL=$(dirname $(type -p i686-w64-mingw32-gcc))/dlltool \
-cat >> libqpdf/qpdf/qpdf-config.h <<EOF
+    STRIP=i686-w64-mingw32-strip \
-#ifndef _FILE_OFFSET_BITS
+    OBJDUMP=$(dirname $(type -p i686-w64-mingw32-gcc))/objdump \
-# define _FILE_OFFSET_BITS 64
+    ${1+"$@"}
-#endif
-EOF

config-mingw64

@@ -5,7 +5,7 @@
     LD=x86_64-w64-mingw32-ld \
     AR=x86_64-w64-mingw32-ar \
     RANLIB=x86_64-w64-mingw32-ranlib \
-    DLLTOOL=x86_64-w64-mingw32-dlltool \
+    DLLTOOL=$(dirname $(type -p x86_64-w64-mingw32-gcc))/dlltool \
     STRIP=x86_64-w64-mingw32-strip \
-    OBJDUMP=x86_64-w64-mingw32-objdump \
+    OBJDUMP=$(dirname $(type -p x86_64-w64-mingw32-gcc))/objdump \
     ${1+"$@"}

config-msvc

@@ -7,6 +7,8 @@ fi
 shift
 objdump=
 if test "$wordsize" = "64"; then
-    objdump=OBJDUMP=x86_64-w64-mingw32-objdump
+    objdump=$(dirname $(type -p x86_64-w64-mingw32-gcc))/objdump
+else
+    objdump=$(dirname $(type -p i686-w64-mingw32-gcc))/objdump
 fi
-CC=cl CXX="cl -TP -GR" ./configure --disable-test-compare-images --enable-external-libs --enable-werror --with-windows-wordsize=$wordsize --with-buildrules=msvc $objdump ${1+"$@"}
+CC=cl CXX="cl -TP -GR" ./configure --disable-test-compare-images --enable-external-libs --enable-werror --with-windows-wordsize=$wordsize --with-buildrules=msvc OBJDUMP=$objdump ${1+"$@"}

copy_dlls

@@ -7,8 +7,8 @@ use File::Basename;
 
 my $whoami = basename($0);
 
-usage() unless @ARGV == 3;
+usage() unless @ARGV == 4;
-my ($file, $destdir, $objdump) = @ARGV;
+my ($file, $destdir, $objdump, $windows_wordsize) = @ARGV;
 my $filedir = dirname($file);
 
 my %dlls = ();
@@ -40,10 +40,39 @@ if (! defined $format)
 # DLLs.
 my $sep = ($^O eq 'MSWin32' ? ';' : ':');
 my @path = ($filedir, '.', split($sep, $ENV{'PATH'}));
+foreach my $var (qw(LIB))
+{
+    if (exists $ENV{$var})
+    {
+        push(@path, split($sep, $ENV{$var}));
+    }
+}
 if (-f "$file.manifest")
 {
     unshift(@path, get_manifest_dirs("$file.manifest"));
 }
+my $redist_suffix = (($windows_wordsize eq '64') ? "x64" : "x86");
+if (exists $ENV{'VCINSTALLDIR'})
+{
+    my $redist = $ENV{'VCINSTALLDIR'} . "/Redist/$redist_suffix";
+    if (opendir(D, $redist))
+    {
+        my @entries = readdir(D);
+        closedir(D);
+        foreach my $e (@entries)
+        {
+            if ($e =~ m/\.CRT$/i)
+            {
+                unshift(@path, "$redist/$e");
+            }
+        }
+    }
+}
+if (exists $ENV{'UNIVERSALCRTSDKDIR'})
+{
+    my $redist = $ENV{'UNIVERSALCRTSDKDIR'} . "/Redist/ucrt/DLLs/$redist_suffix";
+    unshift(@path, $redist);
+}
 my @final = ();
 my @notfound = ();
 dll_loop:
@@ -75,7 +104,7 @@ foreach my $f (@final)
 {
     $f =~ s,\\,/,g;
     print "Copying $f to $destdir\n";
-    system("cp -p $f $destdir") == 0 or
+    system("cp -p '$f' '$destdir'") == 0 or
 	die "$whoami: copy $f to $destdir failed\n";
 }
 
@@ -92,7 +121,7 @@ sub is_format
         return 1;
     }
     my $result = 0;
-    my $file_format = `file $file`;
+    my $file_format = `file "$file"`;
     print "$file $format $file_format\n";
     if ($? == 0)
     {

make/installwin.mk

@@ -10,7 +10,7 @@ installwin: all
 	mkdir $(DEST)/doc
 	cp libqpdf/$(OUTPUT_DIR)/$(STATIC_LIB_NAME) $(DEST)/lib
 	cp libqpdf/$(OUTPUT_DIR)/qpdf*.dll $(DEST)/bin
-	perl copy_dlls libqpdf/$(OUTPUT_DIR)/qpdf*.dll $(DEST)/bin $(OBJDUMP)
+	perl copy_dlls libqpdf/$(OUTPUT_DIR)/qpdf*.dll $(DEST)/bin $(OBJDUMP) $(WINDOWS_WORDSIZE)
 	cp qpdf/$(OUTPUT_DIR)/qpdf.exe $(DEST)/bin
 	cp zlib-flate/$(OUTPUT_DIR)/zlib-flate.exe $(DEST)/bin
 	cp qpdf/fix-qdf $(DEST)/bin

make/msvc.mk

@@ -27,47 +27,47 @@ clean::
 #                       1   2
 # Usage: $(call compile,src,includes)
 define compile
-	cl /nologo /O2 /Zi /Gy /EHsc /MD /TP /GR $(CPPFLAGS) $(CXXFLAGS) \
+	cl -nologo -O2 -Zi -Gy -EHsc -MD -TP -GR $(CPPFLAGS) $(CXXFLAGS) \
 		$(foreach I,$(2),-I$(I)) \
-		/c $(1) /Fo$(call src_to_obj,$(1))
+		-c $(1) -Fo$(call src_to_obj,$(1))
 endef
 
 #                       1   2
 # Usage: $(call c_compile,src,includes)
 define c_compile
-	cl /nologo /O2 /Zi /Gy /EHsc /MD $(CPPFLAGS) $(CFLAGS) \
+	cl -nologo -O2 -Zi -Gy -EHsc -MD $(CPPFLAGS) $(CFLAGS) \
 		$(foreach I,$(2),-I$(I)) \
-		/c $(1) /Fo$(call c_src_to_obj,$(1))
+		-c $(1) -Fo$(call c_src_to_obj,$(1))
 endef
 
 #                       1   2
 # Usage: $(call libcompile,src,includes)
 define libcompile
-	cl /nologo /O2 /Zi /Gy /EHsc /MD /TP /GR $(CPPFLAGS) $(CXXFLAGS) \
+	cl -nologo -O2 -Zi -Gy -EHsc -MD -TP -GR $(CPPFLAGS) $(CXXFLAGS) \
 		-DDLL_EXPORT $(foreach I,$(2),-I$(I)) \
-		/c $(1) /Fo$(call src_to_obj,$(1))
+		-c $(1) -Fo$(call src_to_obj,$(1))
 endef
 
 #                       1   2
 # Usage: $(call c_libcompile,src,includes)
 define c_libcompile
-	cl /nologo /O2 /Zi /Gy /EHsc /MD $(CPPFLAGS) $(CXXFLAGS) \
+	cl -nologo -O2 -Zi -Gy -EHsc -MD $(CPPFLAGS) $(CXXFLAGS) \
 		-DDLL_EXPORT $(foreach I,$(2),-I$(I)) \
-		/c $(1) /Fo$(call c_src_to_obj,$(1))
+		-c $(1) -Fo$(call c_src_to_obj,$(1))
 endef
 
 #                        1    2
 # Usage: $(call makeslib,objs,library)
 define makeslib
-	lib /nologo /OUT:$(2) $(1)
+	lib -nologo -OUT:$(2) $(1)
 endef
 
 #                       1    2       3       4    5       6        7
 # Usage: $(call makelib,objs,library,ldflags,libs,current,revision,age)
 define makelib
-	cl /nologo /O2 /Zi /Gy /EHsc /MD /LD /Fe$(basename $(2))$(shell expr $(5) - $(7)).dll $(1) \
+	cl -nologo -O2 -Zi -Gy -EHsc -MD -LD -Fe$(basename $(2))$(shell expr $(5) - $(7)).dll $(1) \
-		/link /SUBSYSTEM:CONSOLE,5.01 /incremental:no \
+		-link -SUBSYSTEM:CONSOLE,5.01 -incremental:no \
-		$(foreach L,$(subst -L,,$(3)),/LIBPATH:$(L)) \
+		$(foreach L,$(subst -L,,$(3)),-LIBPATH:$(L)) \
 		$(foreach L,$(subst -l,,$(4)),$(L).lib)
 	if [ -f $(basename $(2))$(shell expr $(5) - $(7)).dll.manifest ]; then \
 		mt.exe -nologo -manifest $(basename $(2))$(shell expr $(5) - $(7)).dll.manifest \
@@ -79,9 +79,9 @@ endef
 #                       1    2      3       4
 # Usage: $(call makebin,objs,binary,ldflags,libs)
 define makebin
-	cl /nologo /O2 /Zi /Gy /EHsc /MD $(1) \
+	cl -nologo -O2 -Zi -Gy -EHsc -MD $(1) \
-		/link /SUBSYSTEM:CONSOLE,5.01 /incremental:no /OUT:$(2) \
+		-link -SUBSYSTEM:CONSOLE,5.01 -incremental:no -OUT:$(2) \
-		$(foreach L,$(subst -L,,$(3)),/LIBPATH:$(L)) \
+		$(foreach L,$(subst -L,,$(3)),-LIBPATH:$(L)) \
 		$(foreach L,$(subst -l,,$(4)),$(L).lib)
 	if [ -f $(2).manifest ]; then \
 		mt.exe -nologo -manifest $(2).manifest \

make_windows_releases

@@ -12,11 +12,11 @@ PATH=$cwd/libqpdf/build:$PATH
 rm -rf install-mingw* install-msvc*
 
 ./config-mingw64
-make -j8
+make
 make check install
 make distclean
 ./config-mingw32
-make -j8
+make
 make check install
 make distclean
 

make_windows_releases-msvc

@@ -17,6 +17,6 @@ cwd=`pwd`
 PATH=$cwd/libqpdf/build:$PATH
 
 ./config-msvc $w
-make -j8
+make
 make check install
 make distclean