diff --git a/Building/Windows/BUILD-WIN.md b/Building/Windows/BUILD-WIN.md index 764287a8..09804ca3 100644 --- a/Building/Windows/BUILD-WIN.md +++ b/Building/Windows/BUILD-WIN.md @@ -5,16 +5,25 @@ This document is intended to be a brief description of how to install the necess On my computers, I have QT installed in E:\\QT and the OSCAR code base in E:\\oscar\\oscar-code. On another computer, they are on the F: drive. All references in the deploy.bat file are relative, so it should run with Oscar-code installed at any location. -**Required Programs** +The deploy.bat file is required to build release and install versions of Oscar using QtCreator or with buildall.bat. The buildall.bat compiles , builds Oscar and calls deploy.bat to create release and install version of Oscar. + +There are three sections to this documentation. + +1) Required Programs +2) Start Developing using batch files +3) Start Developing using QtCreator + +## Required Programs The following programs and files are required to create Windows installers: - -- Inno Setup 6.0.3 from . Download and install innosetup-qsp-6.0.3.exe. - -- GIT for windows, from . GIT for Windows adds itself to your path. - -- QT Open Source edition from . I use the latest patch version in the 5.12 LTS series -- version 5.12.8 at the date this was last updated. More recent versions in the 5.12 series should also work. - +- Inno Setup 6.0.3 from . + Download and install innosetup-qsp-6.0.3.exe. +- GIT for windows, from . + GIT for Windows adds itself to your path. + - Gawk is required. + You can use the version included with Git for Windows or install Gawk for Windows from . The deployment batch file will use the Git for Windows version if gawk.exe is not in your PATH. +- QT Open Source edition from . + I use the latest patch version in the 5.12 LTS series -- version 5.12.8 at the date this was last updated. More recent versions in the 5.12 series should also work. **Installing Inno Setup 6** @@ -29,7 +38,7 @@ Run the installer, accepting options to install inno script studio (for possible Go to and click on the Download button. Run the installer, which presents lots of options: - Select whichever editor you desire. -- Select “Use Git from the command line and also from 3rd-party software.” +- Select “Use Git from the command line and also from 3rd-party software.” - Select “Use the OpenSSL library.” - Select “Checkout Windows-style, commit Unix-style line endings.” - Select “Use Windows’ default console window.” I find the Windows default console to be satisfactory on Windows 10. @@ -40,6 +49,10 @@ GIT for Windows adds itself to your path. Create SSH key and upload to GitLab--See https://docs.gitlab.com/ce/ssh/README.html. +**Installing Gawk (if Git for Windows’ gawk is not used)** + +From , download setup for “Complete package, except sources”. When downloaded, run the setup program. Accept default options and location. The deployment batch file assumes that gawk.exe is in your PATH, so either add c:\\Program Files (x86)\\gnuwin32\\bin to your PATH or copy the executables to some other directory already in your PATH. + **Installing QT** Go to QT at and download the Open Source edition of the Windows online installer, qt-unified-windows-x86-3.1.1-online.exe. Run the installer: @@ -49,26 +62,124 @@ Go to QT at and download the Open Source edition of - Click Next to download meta information (this takes a while). - Choose your installation directory (I picked E:\\Qt, but there are no dependencies on where QT is located) - + - Select components: - - In QT 5.12.*x*: + - In QT 5.12.*x*: - - MinGW 7.3.0 32-bit + - MinGW 7.3.0 32-bit - MinGW 7.3.0 64-bit - - Sources - - QT Debug Information Files - + - Sources + - QT Debug Information Files + - In Developer and Designer Tools: - - - QT Creator 4.11.2 CDB Debug - - Debugging Tools for Windows - - MinGW 7.3.0 32-bit - - MinGW 7.3.0 64-bit + + - QT Creator 4.11.2 CDB Debug + - Debugging Tools for Windows + - MinGW 7.3.0 32-bit + - MinGW 7.3.0 64-bit And complete the installation (this also takes a while). -**Getting Started Developing Oscar in QT Creator** +## Start Developing using batch files + +- Requires Qt , Git and Inno setup described in above section. +- Batch files buildall.bat and deploy.bat are used. +- buildall.bat creates a build folder, compiles and executes deploy.bat +- Supports both 32 and 64 bit version with an option to build brokenGl +- Supports Qt 5.9.x 5.12.x 5.15.x +- Auto detection for which compiler to use. +- buildall.bat supports command Line options +- deploy.bat creates a release version and an install version. +- deploy.bat is also used by QtCreator +- The release folder contains OSCAR.exe and all other files necessary to run OSCAR +- The install folder contains the installable version of OSCAR...exe +- Lists the release and install versions of OSCAR in the build folder. + +#### Validate the installed software. + +- Verify Qt + - \ will be in the form N.N.N example 5.15.2 + - For example: if Qt is installed at D:\\Qt then + - The \ must contain the following folders: \ Tools + - - \ is D:\\Qt +- Verify Git and Inno are installed + - Note: Inno is used to create the Install version of OSCAR + - Git for windows provides GAWK. + +#### Examples use the following assumptions + +Except for Inno, Git, Qt, and OSCAR may be located in different locations. + +- Inno installed: + - "C:\\Program Files (x86)\\Inno Setup 6" +- Git installed: + - "C:\\Program Files\\Git" +- Qtinstalled: + - "D:\\Qt" +- OSCAR installed: + - "D:\\OSCAR" + +#### Building Commands + +- Build install version for OSCAR for 32 and 64 bit versions + - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt +- Build install version for OSCAR for 64 bit version + - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt 64 +- Build Just release version for OSCAR for 64 bit version + - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt 64 skipInstall +- Build release version for OSCAR for 64 bit version - without deleting build folder first + - D:\\OSCAR\OSCAR-code\\Building\\Windows\buildall.bat D:\\Qt 64 skipInstall remake +- The current folder is not used by the buildall.bat +- There is a pause when the build completes. +- This insure that the user has a chance to read the build results. +- Allows using windows shortcuts to build OSCAR and see results. + +Note: The default folder of Qt is C:\\Qt +If the Qt is located at the default folder then the \ is not required as a command line option. + +#### Windows Shortcuts +- Windows shortcuts can be used to execute the build commands or run OSCAR. +- Create shortcut to buildall.bat +- rename shortcut to indicate its function +- edit the short cut property and add options to the Target +- Create a shortcut to release version of OSCAR.exe +- For offical OSCAR release should not use remake or skipInsall options +- Should add skipInstall options for developement, testing, verification +- Suggestion is to create the following shortcut example. + - use options \ 64 skipInstall + - - shortcut name: "OSCAR Fresh build" + - use options \ 64 skipInstall remake + - - shortcut name: "OSCAR quick rebuild" + - Create Shortcut to release version of OSCAR.exe (not the install version) + - - shortcut name: "RUN OSCAR" + + +#### Buildall.bat options. +- A full list of options can be displayed using the help option. + **32** Build 32 bit versions + + **64** Build 64 bit versions + + 32 and 64 bit version are built if both 32 and 64 are used or both not used + **brokenGL** (special option) to build brokenGL version + + **make** The default option. removes and re-creates the build folder. + + **remake** Execute Make in the existing build folder. Does not re-create the Makefile. Should not be used for Offical OSCAR release + + **skipInstall** skips creating the Install version saving both time and disk space + + **skipDeploy** skips executing the deploy.bat script. just compiles oscar. + +There is a pause when the build completes. This insure that the user has a chance to read the build results. +This also allows building using windows shortcuts. +1) create a shortcut to buildall.bat + edit shortcut's property add the necessary options: D:\\Qt 64 remake skipInstall +2) create and shortcut for the make option. +3) create a shortcut to the **release** version of OSCAR.exe + +## Start Developing Oscar in Qt Creator In browser, log into your account at gitlab.com. Select the Oscar project at https://gitlab.com/pholy/OSCAR-code. Clone a copy of the repository to a location on your computer. diff --git a/Building/Windows/buildall-515.bat b/Building/Windows/buildall-515.bat new file mode 100644 index 00000000..bb6443dc --- /dev/null +++ b/Building/Windows/buildall-515.bat @@ -0,0 +1,66 @@ +setlocal +:::@echo off +::: You must set these paths to your QT configuration +set qtpath=C:\Qt +set qtVersion=5.15.2 + +::: This file has been updated to work with Qt 5.15.2 and mingw 8.1.0 +::: +::: Build 32- and 64-bit versions of OSCAR for Windows. +::: Includes code to build BrokenGL (LegacyGFX) versions, but that option is not currently used +::: Uses Timer 4.0 - Command Line Timer - www.Gammadyne.com - to show time it takes to compile. This could be removed. +::: timer /nologo + +:::call :buildone 32 brokengl + +call :buildone 64 + +call :buildone 32 + +:::call :buildone 64 brokengl +::: timer /s /nologo +goto :eof + +::: Subroutine to build one version +:buildone +setlocal +::: timer /nologo + +set QTDIR=%qtpath%\%qtversion%\mingw81_%1 +echo QTDIR is %qtdir% + +set PATH=%qtpath%\Tools\mingw810_%1\bin;%qtpath%\%qtVersion%\mingw81_%1\bin;%PATH% +::: echo %PATH% + +set savedir=%cd% + +: Construct name of our build directory +set dirname=build-oscar-win_%1_bit +if "%2"=="brokengl" ( + set dirname=%dirname%-LegacyGFX + set extraparams=DEFINES+=BrokenGL +) +echo Build directory is %dirname% + +set basedir=..\.. +if exist %basedir%\%dirname%\nul rmdir /s /q %basedir%\%dirname% +mkdir %basedir%\%dirname% +cd %basedir%\%dirname% + +%qtpath%\%qtVersion%\mingw81_%1\bin\qmake.exe ..\oscar\oscar.pro -spec win32-g++ %extraparams% >qmake.log 2>&1 && %qtpath%\Tools\mingw810_%1\bin\mingw32-make.exe qmake_all >>qmake.log 2>&1 +%qtpath%\Tools\mingw810_%1\bin\mingw32-make.exe -j8 >make.log 2>&1 || goto :makefail + +call ..\Building\Windows\deploy.bat + +::: timer /s /nologo +echo === MAKE %1 %2 SUCCESSFUL === +cd %savedir% +endlocal +exit /b + +:makefail +endlocal +::: timer /s /nologo +echo *** MAKE %1 %2 FAILED *** +pause +exit /b \ No newline at end of file diff --git a/Building/Windows/buildall.bat b/Building/Windows/buildall.bat index 2dcf6715..306cdefd 100644 --- a/Building/Windows/buildall.bat +++ b/Building/Windows/buildall.bat @@ -1,60 +1,392 @@ +@echo off setlocal -:::@echo off -::: You must set these paths to your QT configuration -set qtpath=E:\Qt -set qtVersion=5.12.12 +:: todo add help / descriptions +::: This script assumes that it resides OSCAR-data/Building/Windows +::: You must defined the path to QT configuration or passit as a parameter +::: The version is detected based on the path +::: The compiler to use is based on the qt verson. +::: @echo off +::: CONFIGURATION SECTION + +set QtPath=C:\Qt + +::: END CONFIGURATION SECTION +:::============================================ ::: -::: Build 32- and 64-bit versions of OSCAR for Windows. -::: Includes code to build BrokenGL (LegacyGFX) versions, but that option is not currently used -::: Uses Timer 4.0 - Command Line Timer - www.Gammadyne.com - to show time it takes to compile. This could be removed. -timer /nologo +::: START INITIALIZATIO SECTION +echo Command line: %0 %* +call :parse %* +if NOT %ERRORLEVEL%==0 goto :endProgram -:::call :buildone 32 brokengl +set buildErrorLevel=0 -call :buildone 64 +::: basedir is OSCAR-code folder - contains folders Building , oscar , ... +::: parentdir is the folder that contains OSCAR-code. +::: change relative paths into absolute paths +::: Get path to this script. then cd parent folder. %cd% retunrs absolute pathname. +cd %~dp0 & cd ../../../ +set parentdir=%cd% +set basedir=%parentdir%\OSCAR-code +IF NOT "%basedir%"=="%basedir: =%" ( + call :configError absolute path of OSCAR-code contains a space - not handled by Qt. + echo %basedir% + goto :endProgram) +IF NOT exist "%basedir%\Building" ( + call :notfound2 OSCAR-code: "%basedir%" + goto :endProgram) +set baseBuildName=%basedir%\build-oscar-win +set OSCARPRO=%basedir%\oscar\oscar.pro +set requiredOutSideOscar= +IF %doOutSide%==1 ( + set baseBuildName=%parentdir%\build-oscar-win + set OSCARPRO=%basedir%\OSCAR_QT.pro + set requiredOutSideOscar=oscar\ + ) +::: Construct name of our build directory +::: Build Directory can be based on the directories the QtCreator uses for either OSCAR_QT.pro or oscar.pro +::: For OSCAR_QT.pro is at parentDir\OSCAR-code\OCASR_QT.pro the build will be at parentDir\BuildDir +::: For oscar.pro is at OSCAR-code\oscar\oscar.pro the build will be at OSCAR-code\BuildDir -call :buildone 32 +:: check if QtPath from parameters list +set defaultQtPath=%QtPath% +if NOT "%requestQtPath%"=="" (set QtPath=%requestQtPath%) -:::call :buildone 64 brokengl -timer /s /nologo +:: check valid qt folder to find version and tool folders +IF NOT exist %QtPath%\nul ( + call :configError InvalidPath to Qt. QtPath:%QtPath% + echo The QtPath can be added as a parameter to %~nx0 + call :helpInfo + goto :endProgram + ) + +set foundQtVersion= +set foundQtToolsDir= +set foundQtVersionDir= + +for /d %%i in (%QtPath%\*) do (call :parseQtVersion %%i) +if "%foundQtVersion%"=="" ( + echo :configError %QtPath% is not a valid Qt folder. Must contain version 5.xx.xx or 6.xx.xx folder + echo Please enter a valid Qt Path as a parameter + call :helpInfo + goto :endProgram + ) +if "%foundQtToolsDir%"=="" ( +. echo :configError %QtPath% is not a valid Qt folder. Must contain a Tools folder + echo Please enter a valid Qt Path as a parameter + call :helpInfo + goto :endProgram + ) +echo Using QtVersion %foundQtVersion% +set qtVersion=%foundQtVersion% +set QtVersionDir=%QtPath%\%qtVersion% +set QtToolsDir=%QtPath%\Tools + +::: Compiler Tools for creating Makefile (linux qmake features) +if "5.15."=="%qtVersion:~0,5%" ( + :: For qt release 5.15 + set mingwQmakeVersion=mingw81 + set mingwQmakeTools=mingw810 +) else ( + :: For qt previous releases + set mingwQmakeVersion=mingw73 + set mingwQmakeTools=mingw730 +) +::: END INITIALIZATIO SECTION + + +:::============================================ +:main +::: Start BUILDING ON WINDOWS + +call :startTimer "Start Time is" + +if %do32%==1 ( + call :buildone 32 || goto :finished + if %doBrokenGl%==1 ( + call :elapseTime "Elapse Time is" + call :buildone 32 brokengl || goto :finished + ) +) + + +if %do64%==1 ( + if %do32%==1 (call :elapseTime "Elapse Time is") + call :buildone 64 || goto :finished + if %doBrokenGl%==1 ( + call :elapseTime "Elapse Time is" + call :buildone 64 brokengl || goto :finished + ) +) + + +:finished + +:: this does work. dir %baseBuildName%*_bit\Installer\OSCAR*.exe +echo Start Time is %saveStartTime% +call :endTimer "End Time is" + +FOR /D %%j in ("%baseBuildName%*") do (call :sub1 %%j) +goto :endProgram +::: return to caller +:endProgram +pause +exit /b + + + +:::============================================ +:sub1 + FOR /F %%i in ("%1\%requiredOutSideOscar%Installer\") do (call :sub2 %%i ) + FOR /F %%i in ("%1\%requiredOutSideOscar%Release\") do (call :sub2 %%i ) +goto :eof +:sub2 +:: echo PLACE 2 %1 + FOR %%k in ("%1*.exe") do (call :sub3 %%k ) +goto :eof +:sub3 + echo %~t1 %1 +goto :eof + +:parseQtVersion + set tmpf=%~nx1 + if "5."=="%tmpf:~0,2%" call :gotVersion %1 %tmpf% & goto :eof + if "6."=="%tmpf:~0,2%" call :gotVersion %1 %tmpf% & goto :eof + if "Tools"=="%tmpf%" call :gotTools %1 %tmpf% & goto :eof + goto :eof +:gotTools +:: if NOT "%foundQtToolsDir%"=="" (echo Duplicate Qt Versions %1 and %foundQtToolsDir% Error & exit /b 101) + set foundQtToolsDir=%1 +:: echo Found QtTools %1 + goto :eof +:gotVersion +:: if NOT "%foundQtVersion%"=="" (echo Duplicate Qt Versions %1 and %foundQtVersion% Error & exit /b 101) + set foundQtVersion=%2 + set foundQtVersionDir=%1 +:: echo Found QtVersion %foundQtVersion% + goto :eof + +:::============================================ +:parse +set do32=0 +set do64=0 +set doBrokenGl=0 +set doOutSide=1 +set useExistingBuild=0 +set skipCompile=0 +set skipDeploy=0 +set requestQtPath= +set toggleEcho="off" +set skipInstallCommand= +:parseLoop +IF "%1"=="" GOTO :exitParseLoop +set arg=%1 +::: echo ^<%arg%^> +IF "%arg%"=="32" (set do32=1 & GOTO :endLoop ) +IF "%arg%"=="64" (set do64=1 & GOTO :endLoop ) +IF /I "%arg:~0,2%"=="br" (set doBrokenGl=1 & GOTO :endLoop ) +IF /I "%arg:~0,5%"=="SKIPD" (set skipDeploy=1 & GOTO :endLoop ) +IF /I "%arg:~0,5%"=="SKIPC" ( + set useExistingBuild=1 + set skipCompile=1 + GOTO :endLoop ) +IF /I "%arg:~0,2%"=="OU" (set doOutSide=1 & GOTO :endLoop ) +echo windows cmd.exe workaround 1>nul +IF /I "%arg:~0,5%"=="SKIPI" ( + set skipInstallCommand=skipInstall + GOTO :endLoop ) +IF /I "%arg:~0,2%"=="re" (set useExistingBuild=1 & GOTO :endLoop ) +IF /I "%arg:~0,2%"=="ve" ( echo on & GOTO :endLoop ) +IF exist %arg%\Tools\nul IF exist %arg%\Licenses\nul ( + set requestQtPath=%arg% + GOTO :endLoop) +IF NOT "%arg:~0,2%"=="he" ( + echo _ + echo Invalid argument '%arg%' + ) else ( + echo _ + ) +call :helpInfo +exit /b 123 +:endLoop +SHIFT +GOTO :parseLoop +:exitParseLoop +:: echo requestQtPath ^<%requestQtPath%^> +set /a sum=%do32%+%do64% +if %sum% == 0 (set do32=1 & set do64=1 ) goto :eof -::: Subroutine to build one version -:buildone -setlocal -timer /nologo -set QTDIR=%qtpath%\%qtversion%\mingw73_%1 -echo QTDIR is %qtdir% -set path=%qtpath%\Tools\mingw730_%1\bin;%qtpath%\%qtversion%\mingw73_%1\bin;%qtpath%\Tools\mingw730_%1\bin;%PATH% + +:::============================================ +::: Timer functions +::: Allows personalization of timer functions. +::: defaults displaying the curr ent time +::: Could Use Timer 4.0 - Command Line Timer - www.Gammadyne.com - to show time it takes to compile. +:startTimer + set saveStartTime=%TIME% + :: timer.exe /nologo + echo %~1 %saveStartTime% + goto :eof +:elapseTime + :: timer.exe /r /nologo + echo %~1 %TIME% + goto :eof +:endTimer + :: timer.exe /s /et /nologo + echo %~1 %TIME% + goto :eof + +:::=============================================================================== + +:configError +set buildErrorLevel=24 +echo *** CONFIGURATION ERROR *** +echo %* +goto :eof + +:notfound +echo *** CONFIGURATION ERROR *** +set buildErrorLevel=25 +echo NotFound %* +goto :eof + + + +:::=============================================================================== +:: Subroutine to "build one" version +:buildOne +setLocal +set bitSize=%1 +set brokenGL=%2 +echo Building %1 %2 +::: echo do not remove this line - batch bug? 1>nul::: + +set QtVersionCompilerDir=%qtVersionDir%\%mingwQmakeVersion%_%bitSize% +if NOT exist %QtVersionCompilerDir%\nul ( + call :buildOneError 21 notfound QtCompiler: %QtVersionCompilerDir% + goto :endBuildOne + ) + +set QtToolsCompilerDir=%QtToolsDir%\%mingwQmakeTools%_%bitSize% +if NOT exist %QtToolsCompilerDir% ( + call :buildOneError 22 notfound QTToolCompiler: %QtToolsCompilerDir% + goto :endBuildOne + ) + +set path=%QtToolsCompilerDir%\bin;%QtVersionCompilerDir%\bin;%PATH% +:: echo =================================== +:: echo %path% +:: echo =================================== +:::goto :eof + +::: Verify all configuration parameters set savedir=%cd% -: Construct name of our build directory -set dirname=build-oscar-win_%1_bit -if "%2"=="brokengl" ( + +set dirname=%baseBuildName% +if "%brokenGL%"=="brokengl" ( set dirname=%dirname%-LegacyGFX set extraparams=DEFINES+=BrokenGL ) -echo Build directory is %dirname% +set buildDir=%dirname%_%bitSize%_bit -set basedir=..\.. -if exist %basedir%\%dirname%\nul rmdir /s /q %basedir%\%dirname% -mkdir %basedir%\%dirname% -cd %basedir%\%dirname% -%qtpath%\%qtversion%\mingw73_%1\bin\qmake.exe ..\oscar\OSCAR.pro -spec win32-g++ %extraparams% >qmake.log 2>&1 && %qtpath%/Tools/mingw730_%1/bin/mingw32-make.exe qmake_all >>qmake.log 2>&1 -mingw32-make.exe -j8 >make.log 2>&1 || goto :makefail +:: allow rebuild without removing build when a parameter is "SKIP" +if NOT exist %buildDir%\nul goto :makeBuildDir +if %useExistingBuild%==1 goto :skipBuildDir +rmdir /s /q %buildDir% +IF NOT %ERRORLEVEL%==0 ( + call :buildOneError %ERRORLEVEL% error removing Build Folder: %buildDir% + GOTO :endBuildOne ) + +:makeBuildDir +mkdir %buildDir% || ( + call :buildOneError 23 mkdir %buildDir% failed %ERRORLEVEL% + goto :endBuildOne ) +echo created %buildDir% +:skipBuildDir +cd %buildDir% +if %skipCompile%==1 goto :doDeploy + + + +if NOT exist %buildDir%\Makefile goto :createMakefile +if %useExistingBuild%==1 goto :skipMakefile +if NOT exist %OSCARPRO% { + call :buildOneError 24 notfound oscar.pro is not found. + goto :endBuildOne) + +:createMakefile +echo Creating Oscar's Makefile +%QtVersionCompilerDir%\bin\qmake.exe %OSCARPRO% -spec win32-g++ %extraparams% >qmake.log 2>&1 || ( + call :buildOneError 25 Failed to create Makefile part1 + type qmake.log + goto :endBuildOne) +%QtToolsCompilerDir%/bin/mingw32-make.exe qmake_all >>qmake.log 2>&1 || ( + call :buildOneError 26 Failed to create Makefile part2 + type qmake.log + goto :endBuildOne) +:skipMakefile + +:: Always compile build +echo Compiling Oscar +mingw32-make.exe -j8 >make.log 2>&1 || ( + call :buildOneError 27 Make Failed + type qmake.log + goto :endbuildOne + ) + + +::: echo skipDeploy: %skipDeploy% +:doDeploy +if %skipDeploy%==1 goto :endBuildOne + +echo Deploying and Creating Installation Exec in %cd% +call "%~dp0\deploy.bat" %skipInstallCommand% +set buildErrorLevel=%ERRORLEVEL% + + +if %buildErrorLevel% == 0 ( + echo === MAKE %bitSize% %brokenGL% SUCCESSFUL === + goto :endBuildOne +) else ( + call :buildOneError %buildErrorLevel% DEPLOY FAILED + goto :endBuildOne +) +:buildOneError +echo *** MAKE %bitSize% %brokenGL% FAILED *** +echo %* +exit /b %1 +:endBuildOne +cd %savedir% 1>nul 2>nul +endLocal +exit /b %buildErrorLevel% +:::============================================ +:helpInfo +echo _ +echo The %~nx0 script file creates Release and Install 32 and 64 bit versions of Oscar. +echo The %~nx0 has parameters to configure the default options. +echo %~nx0 can be executed from the File Manager +echo Parameter can be added using a short cut and adding parameters to the shortcut's target. +echo _ +echo OPTIONS DESCRIPTION +echo br[okenGl] Builds the brokenGL versions of OSCAR +echo 32 Builds just 32 bit versions +echo 64 Builds just 64 bit versions +echo ^ Overrides the default path (C:\Qt) to QT's installation - contains Tools, License, ... folders +echo ou[tside] Default: Build is located outside of git repository. Same as building with OSCAR_QT.pro +echo in[side] Build is located inside of git repository. Same as building with oscar.pro +echo he[lp] Display this help message +echo _ +echo The offical builds of OSCAR should not use the following options. These facilate development and testing +echo re[make] Skips recreating Makefile, but executes make in existing build folder +echo skipC[ompile] Skips all compiling. Leaves build folder untouched. +echo skipD[eploy] Skip calling deploy.bat. Does not create Release or install versions. +echo ve[rbose] Start verbose logging +echo _ +echo ^ Displays invalid parameter message and help message then exits. +goto :eof + -call ..\Building\Windows\deploy.bat -timer /s /nologo -echo === MAKE %1 %2 SUCCESSFUL === -cd %savedir% -endlocal -exit /b -:makefail -endlocal -timer /s /nologo -echo *** MAKE %1 %2 FAILED *** -pause -exit /b \ No newline at end of file diff --git a/Building/Windows/deploy-515.bat b/Building/Windows/deploy-515.bat new file mode 100644 index 00000000..ce079c57 --- /dev/null +++ b/Building/Windows/deploy-515.bat @@ -0,0 +1,100 @@ +::: +::: Build Release and Installer subdirectories of the current shadow build directory. +::: The Release directory contains everything needed to run OSCAR. +::: The Installer directory contains a single executable -- the OSCAR installer. +::: +::: DEPLOY.BAT should be run as the last step of a QT Build Release kit. +::: QT Shadow build should be specified (this is the QT default). +::: A command line parameter is optional. Any text on the command line will be appended +::: to the file name of the installer. +::: +::: Requirements: +::: Inno Setup 6 - http://www.jrsoftware.org/isinfo.php, installed to default Program Files (x86) location +::: gawk - somewhere in the PATH or in Git for Windows installed in its default lolcation +::: +::: Deploy.bat resides in .../OSCAR-code/Nuilding/Windows, along with +::: buildinstall.iss -- script for Inno Setup to create installer +::: getBuildInfo.awk -- gawk script for extracting version fields from various files +::: setup.ico -- Icon to be used for the installer. +::: +::: When building a release version in QT, QT will start this batch file which will prepare +::: additional files, run WinDeployQt, and create an installer. +::: +@echo off +setlocal + +::: toolDir is where the Windows install/deploy tools are located +set toolDir=%~dp0 +:::echo tooldir is %toolDir% + +::: Set shadowBuildDir and sourceDir for oscar_qt.pro vs oscar\oscar.pro projects +if exist ..\oscar-code\oscar\oscar.pro ( + ::: oscar_QT.pro + set sourceDir=..\oscar-code\oscar + set shadowBuildDir=%cd%\oscar +) else ( + ::: oscar\oscar.pro + set sourceDir=..\oscar + set shadowBuildDir=%cd% +) +echo sourceDir is %sourceDir% +echo shadowBuildDir is %shadowBuildDir% + +::: Now copy the base installation control file + +copy %toolDir%buildInstall.iss %shadowBuildDir% || exit 45 +copy %toolDir%setup.ico %shadowBuildDir% || exit 46 +:::copy %toolDir%use*.reg %shadowBuildDir% || exit 47 + +::: +::: If gawk.exe is in the PATH, use it. If not, add Git mingw tools (awk) to path. They cannot +::: be added to global path as they break CMD.exe (find etc.) +where /q gawk.exe || set PATH=%PATH%;%ProgramW6432%\Git\usr\bin + +::: Create and copy installer control files +::: Create file with all version numbers etc. ready for use by buildinstall.iss +::: Extract the version info from various header files using gawk and +::: #define fields for each data item in buildinfo.iss which will be +::: used by the installer script. +where /q gawk.exe || set PATH=%PATH%;%ProgramW6432%\Git\usr\bin +echo ; This script auto-generated by DEPLOY.BAT >%shadowBuildDir%\buildinfo.iss +gawk -f %toolDir%getBuildInfo.awk %sourcedir%\VERSION >>%shadowBuildDir%\buildInfo.iss || exit 60 +gawk -f %toolDir%getBuildInfo.awk %sourcedir%\git_info.h >>%shadowBuildDir%\buildInfo.iss || exit 62 +echo %shadowBuildDir% | gawk -f %toolDir%getBuildInfo.awk >>%shadowBuildDir%\buildInfo.iss || exit 63 +echo #define MySuffix "%1" >>%shadowBuildDir%\buildinfo.iss || exit 64 +:::echo #define MySourceDir "%sourcedir%" >>%shadowBuildDir%\buildinfo.iss + +::: Create Release directory and subdirectories +if exist %shadowBuildDir%\Release\*.* rmdir /s /q %shadowBuildDir%\Release +mkdir %shadowBuildDir%\Release +cd %shadowBuildDir%\Release +copy %shadowBuildDir%\oscar.exe . || exit 71 +:::copy %shadowBuildDir%\use*.reg . || exit 72 + +::: Now in Release subdirectory +::: If QT created a help directory, copy it. But it might not have if "helpless" option was set +if exist Help\*.* rmdir /s /q Help +mkdir Help +if exist ..\help\*.qch copy ..\help Help + +if exist Html\*.* rmdir /s /q Html +mkdir Html +copy ..\html html || exit 80 + +if exist Translations\*.* rmdir /s /q Translations +mkdir Translations +copy ..\translations Translations || exit 84 + +::: Run deployment tool +windeployqt.exe --force --compiler-runtime --no-translations --verbose 1 OSCAR.exe || exit 87 + +::: Clean up unwanted translation files +:::For unknown reasons, Win64 build copies the .ts files into the release directory, while Win32 does not +if exist Translations\*.ts del /q Translations\*.ts + +::: Create installer +cd .. +:::"%ProgramFiles(x86)%\Inno Setup 6\compil32" /cc BuildInstall.iss +"%ProgramFiles(x86)%\Inno Setup 6\iscc" /Q BuildInstall.iss + +endlocal \ No newline at end of file diff --git a/Building/Windows/deploy.bat b/Building/Windows/deploy.bat index 28d8c9de..f85841e3 100644 --- a/Building/Windows/deploy.bat +++ b/Building/Windows/deploy.bat @@ -1,98 +1,225 @@ -::: -::: Build Release and Installer subdirectories of the current shadow build directory. -::: The Release directory contains everything needed to run OSCAR. -::: The Installer directory contains a single executable -- the OSCAR installer. -::: -::: DEPLOY.BAT should be run as the last step of a QT Build Release kit. -::: QT Shadow build should be specified (this is the QT default). -::: A command line parameter is optional. Any text on the command line will be appended -::: to the file name of the installer. -::: -::: Requirements: -::: Inno Setup 6 - http://www.jrsoftware.org/isinfo.php, installed to default Program Files (x86) location -::: gawk - somewhere in the PATH or in Git for Windows installed in its default lolcation -::: -::: Deploy.bat resides in .../OSCAR-code/Nuilding/Windows, along with -::: buildinstall.iss -- script for Inno Setup to create installer -::: getBuildInfo.awk -- gawk script for extracting version fields from various files -::: setup.ico -- Icon to be used for the installer. -::: -::: When building a release version in QT, QT will start this batch file which will prepare -::: additional files, run WinDeployQt, and create an installer. -::: -@echo off -setlocal - -::: toolDir is where the Windows install/deploy tools are located -set toolDir=%~dp0 -:::echo tooldir is %toolDir% - -::: Set shadowBuildDir and sourceDir for oscar_qt.pro vs oscar\oscar.pro projects -if exist ..\oscar-code\oscar\oscar.pro ( - ::: oscar_QT.pro - set sourceDir=..\oscar-code\oscar - set shadowBuildDir=%cd%\oscar -) else ( - ::: oscar\oscar.pro - set sourceDir=..\oscar - set shadowBuildDir=%cd% -) -echo sourceDir is %sourceDir% -echo shadowBuildDir is %shadowBuildDir% - -::: Now copy the base installation control file - -copy %toolDir%buildInstall.iss %shadowBuildDir% || exit 45 -copy %toolDir%setup.ico %shadowBuildDir% || exit 46 -:::copy %toolDir%use*.reg %shadowBuildDir% || exit 47 - -::: -::: If gawk.exe is in the PATH, use it. If not, add Git mingw tools (awk) to path. They cannot -::: be added to global path as they break CMD.exe (find etc.) -where /q gawk.exe || set PATH=%PATH%;%ProgramW6432%\Git\usr\bin - -::: Create and copy installer control files -::: Create file with all version numbers etc. ready for use by buildinstall.iss -::: Extract the version info from various header files using gawk and -::: #define fields for each data item in buildinfo.iss which will be -::: used by the installer script. -where /q gawk.exe || set PATH=%PATH%;%ProgramW6432%\Git\usr\bin -echo ; This script auto-generated by DEPLOY.BAT >%shadowBuildDir%\buildinfo.iss -gawk -f %toolDir%getBuildInfo.awk %sourcedir%\VERSION >>%shadowBuildDir%\buildInfo.iss || exit 60 -gawk -f %toolDir%getBuildInfo.awk %sourcedir%\git_info.h >>%shadowBuildDir%\buildInfo.iss || exit 62 -echo %shadowBuildDir% | gawk -f %toolDir%getBuildInfo.awk >>%shadowBuildDir%\buildInfo.iss || exit 63 -echo #define MySuffix "%1" >>%shadowBuildDir%\buildinfo.iss || exit 64 -:::echo #define MySourceDir "%sourcedir%" >>%shadowBuildDir%\buildinfo.iss - -::: Create Release directory and subdirectories -if exist %shadowBuildDir%\Release\*.* rmdir /s /q %shadowBuildDir%\Release -mkdir %shadowBuildDir%\Release -cd %shadowBuildDir%\Release -copy %shadowBuildDir%\oscar.exe . || exit 71 -:::copy %shadowBuildDir%\use*.reg . || exit 72 - -::: Now in Release subdirectory -::: If QT created a help directory, copy it. But it might not have if "helpless" option was set -if exist Help\*.* rmdir /s /q Help -mkdir Help -if exist ..\help\*.qch copy ..\help Help - -if exist Html\*.* rmdir /s /q Html -mkdir Html -copy ..\html html || exit 80 - -if exist Translations\*.* rmdir /s /q Translations -mkdir Translations -copy ..\translations Translations || exit 84 - -::: Run deployment tool -windeployqt.exe --release --force --compiler-runtime --no-translations --verbose 1 OSCAR.exe || exit 87 - -::: Clean up unwanted translation files -:::For unknown reasons, Win64 build copies the .ts files into the release directory, while Win32 does not -if exist Translations\*.ts del /q Translations\*.ts - -::: Create installer -cd .. -:::"%ProgramFiles(x86)%\Inno Setup 6\compil32" /cc BuildInstall.iss -"%ProgramFiles(x86)%\Inno Setup 6\iscc" /Q BuildInstall.iss +::: +::: Build Release and Installer subdirectories of the current shadow build directory. +::: The Release directory contains everything needed to run OSCAR. +::: The Installer directory contains a single executable -- the OSCAR installer. +::: +::: DEPLOY.BAT should be run as the last step of a QT Build Release kit. +::: QT Shadow build should be specified (this is the QT default). +::: A command line parameter is optional. Any text on the command line will be appended +::: to the file name of the installer. +::: +::: Requirements: +::: Inno Setup 6 - http://www.jrsoftware.org/isinfo.php, installed to default Program Files (x86) location:%ProgramFiles(x86)% +::: gawk - somewhere in the PATH or in Git for Windows installed with Git\cmd in the path +::: +::: Deploy.bat resides in ...\OSCAR-code\Building\Windows, along with +::: buildinstall.iss -- script for Inno Setup to create installer +::: getBuildInfo.awk -- gawk script for extracting version fields from various files +::: setup.ico -- Icon to be used for the installer. +::: +::: When building a release version in QT, QT will start this batch file which will prepare +::: additional files, run WinDeployQt, and create an installer. +::: +@echo off +echo Executing %~nx0 %* +setlocal +set doSkipInstall=0 +set suffixParam=%1 +if "%1"=="skipInstall" ( + set doSkipInstall=1 + set suffixParam=%2 + ) else ( + if "%2"=="skipInstall" set doSkipInstall=1 + ) + +echo doSkipInstall = %doSkipInstall% +set errDescription= +set errvalue=0 +::: Current Directory is the shadowBuildDir +set shadowBuildDir=%cd% +::: toolDir is where the Window install\deploy tools are located +cd %~dp0 && cd ..\..\.. +set parentDir=%cd% +if exist %shadowBuildDir%\oscar\nul set shadowBuildDir=%shadowBuildDir%\oscar +cd %shadowBuildDir% +set toolDir=%parentDir%\OSCAR-code\Building\Windows +::: Calculate directory where OSCAR-code is located. +set sourceDir=%parentDir%\OSCAR-code\oscar + +echo tooldir is %toolDir% +::echo parentDir is %parentDir% +:: echo sourceDir is %sourceDir% +echo shadowBuildDir is %shadowBuildDir% +if NOT exist %shadowBuildDir%\OSCAR.exe ( + call :err 41 %shadowBuildDir%\OSCAR.exe does not exist + goto :endProgram + ) + +call :cleanFolder +if exist %shadowBuildDir%\buildInfo.iss del /q %shadowBuildDir%\buildInfo.iss || (call :err 42 & goto :endProgram) +if exist %shadowBuildDir%\buildInstall.iss del /q %shadowBuildDir%\buildInstall.iss || (call :err 43 & goto :endProgram) +if exist %shadowBuildDir%\setup.ico del /q %shadowBuildDir%\setup.ico || (call :err 44 & goto :endProgram) + +where gawk > temp.txt 2>nul +set er=%errorlevel% +set gawk= temp.txt 2>nul +set er=%errorlevel% +set /p git=nul +if NOT %ERRORLEVEL%==0 ( + call :err 45 %ERRORLEVEL% failure to copy %toolDir%\buildInstall.iss to %shadowBuildDir% + goto :endProgram + ) +copy %toolDir%\setup.ico %shadowBuildDir% 1>nul +if NOT %ERRORLEVEL%==0 ( + call :err failure to copy %toolDir%\setup.ico to %shadowBuildDir% + goto :endProgram + ) +:::copy %toolDir%\use*.reg %shadowBuildDir% || call :err 47 & goto :endProgram + +::: Create and copy installer control files +::: Create file with all version numbers etc. ready for use by buildinstall.iss +::: Extract the version info from various header files using gawk and +::: #define fields for each data item in buildinfo.iss which will be +::: used by the installer script. +echo ; This script auto-generated by DEPLOY.BAT >%shadowBuildDir%\buildinfo.iss +gawk -f %toolDir%\getBuildInfo.awk %sourcedir%\VERSION >>%shadowBuildDir%\buildInfo.iss +if NOT %ERRORLEVEL%==0 ( + call :err 60 & goto :endProgram) +gawk -f %toolDir%\getBuildInfo.awk %sourcedir%\git_info.h >>%shadowBuildDir%\buildInfo.iss +if NOT %ERRORLEVEL%==0 ( + call :err 62 & goto :endProgram) +echo %shadowBuildDir% | gawk -f %toolDir%\getBuildInfo.awk >>%shadowBuildDir%\buildInfo.iss +if NOT %ERRORLEVEL%==0 ( + call :err 63 & goto :endProgram) +echo #define MySuffix "%suffixParam%" >>%shadowBuildDir%\buildinfo.iss +if NOT %ERRORLEVEL%==0 ( + call :err 64 & goto :endProgram) +:::echo #define MySourceDir "%sourcedir%" >>%shadowBuildDir%\buildinfo.iss + +set releaseDir=%shadowBuildDir%\Release + +::: Create Release directory and subdirectories +::: if exist %shadowBuildDir%\Release\*.* rmdir /s /q %shadowBuildDir%\Release +mkdir %releaseDir% +cd %shadowBuildDir%\Release +copy %shadowBuildDir%\oscar.exe . 1>nul +if NOT %ERRORLEVEL%==0 ( + call :err 71 & goto :endProgram) +:::copy %shadowBuildDir%\use*.reg . || call :err 72 & goto :endProgram +::: if exist %shadowBuildDir%\Installer\*.* rmdir /s /q %shadowBuildDir%\Installer (call :err 73 & goto :endProgram) + +::: starting to copy files +::: Now in Release subdirectory +::: If QT created a help directory, copy it. But it might not have if "helpless" option was set + +::: if exist Help\*.* rmdir /s /q Help +mkdir Help +if exist %shadowBuildDir%\help\*.qch copy %shadowBuildDir%\help %releaseDir%\Help 1>nul || (call :err 80 & goto :endProgram) + +::: if exist Html\*.* rmdir /s /q Html +mkdir Html +copy %shadowBuildDir%\html %releaseDir%\html 1>nul || (call :err 81 & goto :endProgram) + +::: if exist Translations\*.* rmdir /s /q Translations +mkdir Translations +copy %shadowBuildDir%\translations %releaseDir%\Translations 1>nul || (call :err 84 & goto :endProgram) + +::: Run deployment tool +echo Running Qt Deployment tool +windeployqt.exe --release --force --compiler-runtime --no-translations --verbose 1 OSCAR.exe 1>nul 2>nul +if %errorlevel% == 0 goto :cleanup +::: echo windeployqt error = %errorlevel% executing next version +::: Post mingw 8.0 --release Must not be used. +windeployqt.exe --force --compiler-runtime --no-translations --verbose 1 OSCAR.exe 1>nul || (call :err 87 & goto :endProgram) + + +:cleanup +::: Clean up unwanted translation files +::::For unknown reasons, Win64 build copies the .ts files into the release dir/ectory, while Win32 does not +if exist Translations\*.ts del /q Translations\*.ts + + +::: Create installer +cd .. +IF %doSkipInstall%==1 goto :endProgram +echo Creating OSCAR Installation Exec +"%ProgramFiles(x86)%\Inno Setup 6\iscc" /Q BuildInstall.iss || (call :err 88 & goto :endProgram) +if NOT exist %shadowBuildDir%\Installer\OSCAR*.exe (call :err 89 & goto :endProgram) +:endProgram +echo Finished %~nx0 %errDescription% +exit /b %errvalue% +:::: ======================= + +:err +set errvalue=%1 +set errDescription=%* +echo %~nx0 detected error: %* + +exit /b %errvalue% + + +::: ===================================================================================== + +:getGawk +:: check if gawk is already available. +where gawk > temp.txt 2>nul +set er=%errorlevel% +set gawk= temp.txt 2>nul +set er=%errorlevel% +set /p git=