diff options
| author | sethg <sethg@geographika.co.uk> | 2021-02-23 00:34:55 +0100 |
|---|---|---|
| committer | sethg <sethg@geographika.co.uk> | 2021-02-23 00:34:55 +0100 |
| commit | 896e8d8654694f6e6225fd9a9757652484775ada (patch) | |
| tree | c198e1eb9a9a1a5cb2c51b9ee8e2f55c81a1f629 /Doc/Manual | |
| parent | ac8de714af1d7fbd755597b0f51792212f552ef7 (diff) | |
| download | swig-896e8d8654694f6e6225fd9a9757652484775ada.tar.gz | |
Add CMake build steps on Windows
Diffstat (limited to 'Doc/Manual')
| -rw-r--r-- | Doc/Manual/Windows.html | 86 |
1 files changed, 85 insertions, 1 deletions
diff --git a/Doc/Manual/Windows.html b/Doc/Manual/Windows.html index f6f0d16df..1991e7fab 100644 --- a/Doc/Manual/Windows.html +++ b/Doc/Manual/Windows.html @@ -1,4 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>Getting started on Windows</title> @@ -36,6 +36,7 @@ <li><a href="#Windows_mingw_msys">Building swig.exe using MinGW and MSYS</a> <li><a href="#Windows_cygwin">Building swig.exe using Cygwin</a> <li><a href="#Windows_building_alternatives">Building swig.exe alternatives</a> +<li><a href="#Windows_cmake">Building swig.exe using CMake</a> </ul> <li><a href="#Windows_examples_cygwin">Running the examples on Windows using Cygwin</a> </ul> @@ -364,6 +365,89 @@ SWIG. For example, all the source code files can be added to a Visual C++ projec file in order to build swig.exe from the Visual C++ IDE. </p> +<H4><a name="Windows_cygwin">3.3.1.2 Building swig.exe using Cygwin</a></H4> + + +<p> +Note that SWIG can also be built using Cygwin. +However, SWIG will then require the Cygwin DLL when executing. +Follow the Unix instructions in the README file in the SWIG root directory. +Note that the Cygwin environment will also allow one to regenerate the autotool generated files which are supplied with the release distribution. +These files are generated using the <tt>autogen.sh</tt> script and will only need regenerating in circumstances such as changing the build system. +</p> + +<H4><a name="Windows_building_alternatives">3.3.1.3 Building swig.exe alternatives</a></H4> + + +<p> +If you don't want to install Cygwin or MinGW, use a different compiler to build +SWIG. For example, all the source code files can be added to a Visual C++ project +file in order to build swig.exe from the Visual C++ IDE. +</p> + +<H4><a name="Windows_cmake">3.3.1.4 Building swig.exe using CMake</a></H4> + + +<p> +SWIG can also be built using <a href="https://cmake.org/">CMake</a> and Visual Studio rather than autotools. As with the other approaches to +building SWIG the dependencies need to be installed. The steps below are one of a number of ways of installing the dependencies without requiring Cygwin or MinGW. +For fully working build steps always check the Continuous Integration setups currently detailed in the <a href="https://github.com/swig/swig/blob/master/appveyor.yml">Appveyor YAML file</a>. +</p> + +<ol> + <li> + Download CMake from <a href="https://cmake.org/download/">https://cmake.org/download/</a>. In this example we are using 3.19 and unzipping it + to C:\Tools\cmake-3.19.4-win64-x64 + </li> + <li> + Download Bison from <a href="https://sourceforge.net/projects/gnuwin32/files/bison/">https://sourceforge.net/projects/gnuwin32/files/bison/</a> (2.4.1 is used in this example) + and save to a folder e.g. C:\Tools\Bison + </li> + <li> + Install Nuget from <a href="https://www.nuget.org/downloads">https://www.nuget.org/downloads</a> (v5.8.1 is used in this example). Nuget is the package manager + for .NET, but allows us to easily install <a href="https://www.pcre.org/">PCRE</a> required by SWIG. + </li> + <li> + Install PCRE using Nuget using the following command: <pre>C:\Tools\nuget install pcre -Verbosity quiet -Version 8.33.0.1 -OutputDirectory C:\pcre</pre> + </li> + <li> + We will also need the SWIG source code. Either download a zipped archive from GitHub, or if git is installed clone the latest codebase + using <pre>git clone https://github.com/swig/swig.git</pre> + In this example we are assuming the source code is available at C:\swig + </li> +</ol> + +<p> +Now we have all the required dependencies we can build SWIG using the commands below. We add the required build tools to the system PATH, and then +build a Release version of SWIG. +</p> + +<div class="shell"> +<pre> +cd C:\swig +SET PATH=C:\Tools\cmake-3.19.4-win64-x64\bin;C:\Tools\Bison\bin;%PATH% +PCRE_ROOT=C:/pcre/pcre.8.33.0.1/build/native +SET PCRE_PLATFORM=x64 +cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_INSTALL_PREFIX="%CD:\=/%/install2" -DCMAKE_C_FLAGS="/DPCRE_STATIC" -DPCRE_INCLUDE_DIR=%PCRE_ROOT%/include +-DPCRE_LIBRARY=%PCRE_ROOT%/lib/v110/%PCRE_PLATFORM%/Release/static/utf8/pcre8.lib -DBISON_EXECUTABLE=C:/Tools/Bison/bin/bison.exe . +cmake --build . --config Release +</pre> +</div> + +<p> + If all runs successfully a new swig.exe should be generated in a /Release folder. + In addition to Release builds you can create a Debug build using: +</p> +<div class="shell"> + <pre>cmake --build . --config Debug</pre> +</div> +<p> + A Visual Studio solution file should be generated - swig.sln. This can be opened and debugged by running the swig project and setting the + Debugging Command Arguments. For example to step through one of the sample .i files included with the SWIG source use the following: +</p> +<div class="shell"> + <pre>-python -py3 -shadow -o C:\Temp\doxygen_parsing.c C:\swig\Examples\test-suite\doxygen_parsing.i</pre> +</div> <H3><a name="Windows_examples_cygwin">3.3.2 Running the examples on Windows using Cygwin</a></H3> |