Difference between revisions of "Documentation/Nightly/Developers/Build Instructions/Prerequisites/Qt"

From Slicer Wiki
Jump to: navigation, search
(Replaced content with "{{documentation/banner | text = [https://slicer.readthedocs.io/en/latest/developer_guide/build_instructions/index.html This page has been moved to read-the-docs.] | bac...")
Tags: 2017 source edit, Replaced
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<noinclude>{{documentation/versioncheck}}</noinclude>
+
{{documentation/banner
= Binary vs build-from-source ? =
+
| text = [https://slicer.readthedocs.io/en/latest/developer_guide/build_instructions/index.html This page has been moved to read-the-docs.]
 
+
| background-color = 8FBC8F }}
If you build Slicer on ...
 
 
 
== Linux  ==
 
 
 
* Using [[#Download_links|binary]] works great for both '''Debug''' and '''Release''' build of Slicer. See [[#Download_links]] and [[#Installation_instruction]]
 
 
 
== Mac ==
 
 
 
* Using [[#Download_links|binary]] works great for both '''Debug''' and '''Release''' build of Slicer. See [[#Download_links]] and [[#Installation_instruction]]
 
 
 
* To use QtCreator and the Slicer designer plugins, a possible option is to build QtCreator against the installed Qt libraries. See [http://slicer-devel.65872.n3.nabble.com/Using-Qt-Creator-with-Slicer4-On-Mac-OS-X-Multiple-Qt-libs-loaded-tp4026660p4026690.html discussion on the mailing list].
 
 
 
== Windows  ==
 
 
 
=== Debug (32 and 64-bit) or Release (64-bit) ===
 
 
 
* Normally you should plan to build Qt from source to have complete control over the process. See [https://github.com/jcfr/qt-easy-build one-liner build command] or more detailed [[#Build_instructions]]
 
 
 
* You may find that the '''unsigned''' binary downloads from this site are usable: http://sourceforge.net/projects/qtx64/files/qt-x64/4.8.5/msvc2008/
 
 
 
* '''Details''': Using the Qt Designer on Windows requires that the Slicer plugins are [http://doc.trolltech.com/4.6/deployment-plugins.html#debugging-plugins|compiled in the same mode as Qt]. If Qt was compiled in Release mode (default), Slicer would have to be compiled in Release mode as well. However if Qt is compiled in Debug mode only, Slicer has to be compiled in Debug too. When Qt is in "Release and Debug" mode only the Release version of Designer.exe is generated, Slicer would have to be compiled in Release. So for developers, the <b>Debug mode is recommended</b>, this is why we detail the compilation of Qt below.
 
 
 
=== Release (32-bit) ===
 
 
 
* Using [[#Download_links|binary]] works great for 32-bit Release build of Slicer. See [[#Download_links]] and [[#Installation_instruction]]
 
 
 
 
 
<br><br><br><br>
 
 
 
= Download Qt: Source and Binaries =
 
 
 
== Download links ==
 
 
 
The following table list the link allowing to download either the '''recommended''' source code or binary of Qt.
 
 
 
{| border="1" style="margin-left: 20px;"
 
|- bgcolor="#FFFFCC"
 
!rowspan="3"|
 
!colspan="1" rowspan="2"|Linux
 
!colspan="2"|Mac
 
!colspan="2"|Windows
 
|- bgcolor="#FFFFCC"
 
!colspan="1"|SnowLeopard
 
!colspan="1"|Lion, Mountain Lion
 
!colspan="1"|VS2008
 
!colspan="1"|VS2010
 
|- bgcolor="#FFFFCC"
 
!|64bits
 
!|64bits
 
!|64bits
 
!|64bits
 
!|64bits
 
|-
 
! bgcolor="#FFFFCC" | Qt source link
 
|align="center" colspan="1"| [http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-everywhere-opensource-src-4.8.6.tar.gz 4.8.6]
 
|align="center" colspan="1"| [http://download.qt-project.org/archive/qt/4.7/qt-everywhere-opensource-src-4.7.4.tar.gz  4.7.4]
 
|align="center" colspan="1"| [http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-everywhere-opensource-src-4.8.6.tar.gz 4.8.6]
 
|align="center" colspan="1"| [http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-everywhere-opensource-src-4.8.6.zip 4.8.6]
 
|align="center" colspan="1"| [http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-everywhere-opensource-src-4.8.6.zip 4.8.6]
 
|-
 
! bgcolor="#FFFFCC" | Qt binary link
 
|align="center" colspan="1"| (src or apt-get package) <!-- [http://packages.kitware.com/download/item/3733/QtSdk-offline-linux-x86_64-v1.2.1.run SDK-1.2] -->
 
|align="center" colspan="1"| [http://packages.kitware.com/download/item/3736/qt-mac-opensource-4.7.4.dmg 4.7.4] <br> [http://packages.kitware.com/download/item/3739/qt-mac-opensource-4.7.4-debug-libs.dmg 4.7.4 (optional: debug libs)]
 
|align="center" colspan="1"| [http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-opensource-mac-4.8.6-1.dmg 4.8.6] <br> [http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-opensource-mac-4.8.6-1-debug-libs.dmg 4.8.6 (optional: debug libs)]
 
 
 
|align="center" colspan="1"| [http://sourceforge.net/projects/qt64ng/files/qt/x86-64/4.8.6/msvc2008/qt-4.8.6-x64-msvc2008.exe/download 4.8.6 (unsigned installer)]
 
|align="center" colspan="1"| [http://sourceforge.net/projects/qt64ng/files/qt/x86-64/4.8.6/msvc2010/qt-4.8.6-x64-msvc2010.exe/download 4.8.6 (unsigned installer)]
 
|}
 
 
 
<!--
 
== Installation instruction ==
 
 
 
=== Linux ===
 
 
 
See [[Documentation/{{documentation/version}}/Developers/Build_Instructions/Prerequisites/Qt/Instal_QtSDK1.2_Offline_Linux_64|Qt installation guide (4.7.4, Linux, 64-bit, Offline)]]
 
 
 
=== Mac ===
 
 
 
TBD
 
 
 
=== Windows ===
 
 
 
TBD
 
-->
 
 
 
== Qt version specific issues ==
 
 
 
* Issues for Qt < 4.7.4 are not reported
 
 
 
=== All ===
 
* NA
 
<!--
 
* '''Qt 4.6.x''' on windows (and possibly in linux/mac): No image base64 support in QLabel/QTooltips (work around exists though)
 
* '''Qt 4.8''' does not work with PythonQt in slicer4 - suggested version is 4.7.4
 
-->
 
=== Linux ===
 
 
 
* NA
 
 
 
=== Mac ===
 
* Problem building Qt on MacOSX 10.9. See https://bugreports.qt-project.org/browse/QTBUG-32237
 
<!--
 
* '''Qt 4.6''': hard to compile - TBD: Be more specific
 
* '''Qt 4.7''': click outside of popup (http://na-mic.org/Mantis/view.php?id=1241) - Is it fixed in Qt 4.8 ?
 
* '''Qt 4.7.3''': http://na-mic.org/Mantis/view.php?id=1388 - Fixed in Qt 4.7.4
 
-->
 
 
 
=== Windows ===
 
 
 
* NA
 
 
 
== How to change the minimum required version ? ==
 
 
 
* This applied only for Slicer < [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=22466 r22466].
 
 
 
* It's indeed possible to use a different version, just be aware that moving forward in time, things may not work as expected. Even worse Slicer may simply fail to compile.
 
 
 
* By configuring Slicer using <code>-DSlicer_REQUIRED_QT_VERSION:STRING=4.7.0</code>, you will be able to change the minimum required version.
 
 
 
* See [https://github.com/Slicer/Slicer/commit/898bb14e 898bb14e], [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision=19698 r19698], [http://massmail.spl.harvard.edu/public-archives/slicer-devel/2012/008130.html Mailing list]
 
 
 
 
 
<br><br><br><br>
 
 
 
= Build instructions =
 
<br>
 
{{mbox
 
| text = Please, make sure that your IDE/compiler is '''properly installed''' and that all associated '''ServicePack''' are also installed. See [[Documentation/{{documentation/version}}/Developers/Build_Instructions/Prerequisites|Prerequisites]].
 
}}
 
<br>
 
 
 
== Linux ==
 
 
 
See [[Documentation/Nightly/Developers/Build_Instructions#Linux]]
 
<!--
 
TODO: Add a section specific to debian based platform.
 
*Downloading the binaries of Qt works fine with Linux, you do not have to compile Qt manually.
 
** Note: You need to install the libQtWebkit-devel package too.
 
-->
 
 
 
<!--
 
* Consider installing the following optional packages (<code>libxt-dev libxrender-dev libxrandr-dev libxinerama-dev libxcursor-dev libfontconfig-dev libglib2.0-dev</code>)
 
 
 
{{pre2|scroll|
 
mkdir qt-everywhere-opensource-build-4.7.4
 
tar xvfz qt-everywhere-opensource-src-4.7.4.tar.gz
 
cd qt-everywhere-opensource-src-4.7.4
 
./configure -prefix ../qt-everywhere-opensource-build-4.7.4 -debug -opensource -confirm-license -no-qt3support -webkit -nomake examples -nomake demos
 
make -j8
 
make install
 
}}
 
-->
 
<!-- Note: On a 64 bit system, you may have to add <code>-arch x86_64</code> to the Qt configure command line (?) -->
 
<!--
 
Note: Adapt <code>-j8</code> with the number of core on your machine, a dual core should probably not do more than <code>-j3</code>, an 8 core machine can resonably go as much as <code>-j12</code>.
 
-->
 
 
 
== Mac  ==
 
 
 
Similar to Linux configuration. Note that <code>-arch x86_64</code> has been added.
 
 
 
For earlier versions of Xcode and Mac OS X
 
{{pre2|scroll|
 
mkdir qt-everywhere-opensource-build-4.7.4
 
tar xvfz qt-everywhere-opensource-src-4.7.4.tar.gz
 
cd qt-everywhere-opensource-src-4.7.4
 
./configure -prefix ../qt-everywhere-opensource-build-4.7.4 -debug-and-release -opensource -confirm-license -no-qt3support -webkit -arch x86_64 -nomake examples -nomake demos -sdk /Developer/SDKs/MacOSX10.5.sdk
 
make -j8
 
make install
 
}}
 
 
 
On the latest Xcode versions (4.3) and Lion (10.7) the Developer directories have moved.  The command is now:
 
 
 
{{pre2|scroll|
 
./configure -prefix ../qt-everywhere-opensource-build-4.7.4 -debug-and-release -opensource -confirm-license -no-qt3support -arch x86_64 -nomake examples -nomake demos -webkit -sdk /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.7.sdk
 
}}
 
 
 
* Consider reading: http://doc.qt.nokia.com/4.7/developing-on-mac.html)
 
 
 
* Note:
 
** If building against SDK 10.6 or 10.7, you will probably get link errors similar to what's described in [https://trac.macports.org/ticket/30346] and [http://qt-project.org/forums/viewthread/15933]. Solution is provided here [https://bugreports.qt-project.org/browse/QTBUG-24361 here].
 
 
 
== Windows ==
 
 
 
* Use a windows extracter to unzip the [[Documentation/{{documentation/version}}/Developers/Build_Instructions/Prerequisites/Qt#Download_links|Qt archive]], don't use cygwin unzip it.
 
 
 
=== Qt 4.7.4 / VS2008 ===
 
 
 
* Rename the folder into for example <code>qt-4.7.4-64-vs2008-rel</code>.
 
** Note: Each build of Qt should be done it its own folder !
 
** Note: A 32 bit debug build would be done in a folder named <code>qt-4.7.4-32-vs2008-deb</code>
 
 
 
 
 
* Launch the msvc2008 command prompt <!-- (MSVC08->Tools->Visual Studio 2008 CommandPrompt) (or: launch cmd.exe and run <code>vcvars32.bat</code>) -->
 
** 32-bit build: Start menu -> MSVC08->Tools -> "Visual Studio 2008 Command Prompt"
 
** 64-bit build: Start menu -> MSVC08->Tools -> "Visual Studio 2008 x64 Win64 Command Prompt"
 
<!--
 
** Note: Don't start prompt from inside visual studio or it will be an x86 32 bit shell.
 
-->
 
 
 
 
 
* Configure
 
** For debug: <code>configure.exe -platform win32-msvc2008 -opensource -confirm-license -debug -webkit -nomake examples -nomake demos</code>
 
** For release: <code>configure.exe -platform win32-msvc2008 -opensource -confirm-license -release -webkit -nomake examples -nomake demos</code>
 
** Note: <code>win32-msvc2008</code> is used for both 32 and 64-bit.
 
** Note: The option <code>-prefix</code> doesn't work on Windows.
 
** Note: According to [http://qt.nokia.com/doc/4.7/supported-platforms.html] Qt does not support msvc2008 on windows xp.  However, running <code>configure.exe</code> with no <code>-platform</code> argument seems to work. If you run configure with the <code>-platform</code> argument first by mistake, and if <code>configure -clean</code> doesn't work, then you may need to start from a fresh extraction from the .zip archive before running <code>configure.exe</code> again with no <code>-platform</code>, unless you can run <code>nmake</code> with the config clean target.
 
 
 
 
 
* Build using <code>nmake</code>
 
** Note: building with webkit support requires that <i>src/3rdparty/webkit/WebCore/tmp/moc/{debug,release}_shared/mocinclude.tmp</i> be removed. else you will get linker errors like <code>QNetworkReplyHandler.obj : error LNK2001: unresolved external symbol "public: virtual struct QMetaObject const * __thiscall WebCore::FormDataIODevice::metaObject(void)const (?metaObject@FormDataIODevice@WebCore@@UBEPBUQMetaObject@@XZ)</code>
 
** Note: If you encounter the following error <code>api\qscriptextensionplugin.h(43): Error: Undefined interface,</code>, delete the files <i>\src\script\tmp\moc\debug_shared\mocinclude.tmp</i> and <i>\src\script\tmp\moc\release_shared\mocinclude.tmp</i> and restart nmake. For more info, please see [http://bugreports.qt.nokia.com/browse/QTBUG-6470 QTBug 6470]].
 
 
 
=== Qt 4.8.5 / VS2010 ===
 
 
 
* Rename the folder into for example <code>qt-4.8.5-64-vs2010-rel</code>.
 
** Note: Each build of Qt should be done it its own folder !
 
** Note: A 32 bit debug build would be done in a folder named <code>qt-4.8.5-32-vs2010-deb</code>
 
 
 
 
 
* Launch the msvc2010 command prompt <!-- (MSVC10->Tools->Visual Studio 2010 CommandPrompt) (or: launch cmd.exe and run <code>vcvars32.bat</code>) -->
 
** 32-bit build: Start menu -> MSVC10->Tools -> "Visual Studio 2010 Command Prompt"
 
** 64-bit build: Start menu -> MSVC10->Tools -> "Visual Studio 2010 x64 Win64 Command Prompt"
 
<!--
 
** Note: Don't start prompt from inside visual studio or it will be an x86 32 bit shell.
 
-->
 
 
 
 
 
*Download pearl http://strawberryperl.com/ and create a new folder into for example <code>strawberry</code>.
 
 
 
 
 
*Download jom and create a new folder into for example <code>jom</code>.
 
**Add this new folder into the path (system properties)
 
 
 
 
 
* Configure
 
** For debug: <code>configure.exe -platform win32-msvc2010 -debug -opensource -confirm-license -webkit -nomake examples -nomake demos</code>
 
** For release: <code>configure.exe -platform win32-msvc2010 -release -opensource -confirm-license -webkit -nomake examples -nomake demos</code>
 
** Note: <code>win32-msvc2010</code> is used for both 32 and 64-bit.
 
** Note: The option <code>-prefix</code> doesn't work on Windows.
 
 
 
 
 
* Build using <code>jom -jn</code>
 
**Note: n is the number of cores of your CPU, so adapt it.
 
** Note: building with webkit support requires that <i>src/3rdparty/webkit/WebCore/tmp/moc/{debug,release}_shared/mocinclude.tmp</i> be removed. else you will get linker errors like <code>QNetworkReplyHandler.obj : error LNK2001: unresolved external symbol "public: virtual struct QMetaObject const * __thiscall WebCore::FormDataIODevice::metaObject(void)const (?metaObject@FormDataIODevice@WebCore@@UBEPBUQMetaObject@@XZ)</code>
 
** Note: If you encounter the following error <code>api\qscriptextensionplugin.h(43): Error: Undefined interface,</code>, delete the files <i>\src\script\tmp\moc\debug_shared\mocinclude.tmp</i> and <i>\src\script\tmp\moc\release_shared\mocinclude.tmp</i> and restart jom. For more info, please see [http://bugreports.qt.nokia.com/browse/QTBUG-6470 QTBug 6470]].
 
 
 
=== Qt 4.8.6 / VS2012 ===
 
 
 
* Make sure your Visual Studio 2012 is patched with the latest patch (e.g. [http://www.microsoft.com/en-us/download/confirmation.aspx?id=39305 patch 4]).
 
 
 
 
 
* Download the [http://download.qt-project.org/official_releases/qt/4.8/4.8.6/qt-everywhere-opensource-src-4.8.6.zip source archive], extract and rename the folder into for example <code>qt-4.8.6-64-vs2012-rel</code>.
 
** Note: Each build of Qt should be done it its own folder !
 
** Note: A 32 bit debug build would be done in a folder named <code>qt-4.8.6-32-vs2010-deb</code>
 
 
 
* Replace the webkit <i>src\3rdparty\webkit\Source\JavaScriptCore\wtf\hashset.h</i> file with this [https://bitbucket.org/Vertexwahn/bluego/src/56dbe84212222ec6954d8d327a5e443106bcc447/deploy/BlueGo0.0.4/qt4.8.3vs2012patch/HashSet.h?at=default file]
 
* For VS2013, replace the MathExtras.h file [http://code.qt.io/cgit/qt/qt.git/commit/src/3rdparty/webkit/Source/JavaScriptCore/wtf/MathExtras.h?id=b05d05fd9ce2aeedfaf805a7ed9007a93c902bc9]
 
* For VS2015, apply the patch https://fami.codefreak.ru/mirrors/qt/unofficial_builds/qt4.8.7-msvc2015/02-fix_build_with_msvc2015-45e8f4ee.diff
 
* Launch the msvc2012 command prompt <!-- (MSVC12->Tools->Visual Studio 2012 CommandPrompt) (or: launch cmd.exe and run <code>vcvars32.bat</code>) -->
 
** 32-bit build: Start menu -> MSVC12->Visual Studio Tools -> "VS2012 x86 Command Prompt"
 
** 64-bit build: Start menu -> MSVC12->Visual Studio Tools -> "VS2012 x64 Win64 Command Prompt"
 
<!--
 
** Note: Don't start prompt from inside visual studio or it will be an x86 32 bit shell.
 
-->
 
 
 
 
 
* If you want openssl support (optional):
 
** Download perl http://strawberryperl.com/ and create a new folder into for example <code>strawberry</code>.
 
 
 
* Configure
 
** For debug: <code>configure.exe -platform win32-msvc2012 -debug -opensource -confirm-license -webkit -nomake examples -nomake demos</code>
 
** For release: <code>configure.exe -platform win32-msvc2012 -release -opensource -confirm-license -webkit -nomake examples -nomake demos</code>
 
** Note: <code>win32-msvc2012</code> is used for both 32 and 64-bit.
 
** Note: The option <code>-prefix</code> doesn't work on Windows.
 
 
 
 
 
* Build using <code>nmake</code>
 
** Alternatively you can use jom (much faster)
 
*** Download jom and create a new folder into for example <code>jom</code>.
 
*** Add this new folder into the path (system properties)
 
*** Build using <code>jom -jn</code>
 
**** Note: n is the number of cores of your CPU, so adapt it.
 

Latest revision as of 03:02, 22 November 2025

Home < Documentation < Nightly < Developers < Build Instructions < Prerequisites < Qt