path: root/src/qtmsbuild/qt_vars.targets

<?xml version="1.0" encoding="utf-8"?>
<!--
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt VS Tools.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
-->
<!--
///////////////////////////////////////////////////////////////////////////////////////////////////
// Read Qt Build Variables
// -->
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

  <PropertyGroup>
    <QtDependsOn>QtVarsPrepare;QtVars;$(QtDependsOn)</QtDependsOn>
  </PropertyGroup>
  <ItemGroup>
    <QtModuleList Include="$(QtModules)"/>
    <QtVariableList Include="$(QtVariables)"/>
    <QMakeCodeLine Include="$(QMakeCodeLines)"/>
    <QtVarProp Include="@(QtVariableList->'Qt_%(Identity)_')"/>
    <QtIncludesList Include="$(QtHeaderSearchPath)"/>
    <QtLibsList Include="$(QtLibrarySearchPath)"/>
  </ItemGroup>

  <PropertyGroup>
    <QtSkipBuildTargets>QtSkipBuild;$(QtSkipBuildTargets)</QtSkipBuildTargets>
    <QtModuleNames>@(QtModuleList->'%(Identity)', ' ')</QtModuleNames>
    <QtVarNames>@(QtVariableList->'%(Identity)', ' ')</QtVarNames>
  </PropertyGroup>

  <!--
  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// TARGET QtVars
  /////////////////////////////////////////////////////////////////////////////////////////////////
  // Call qmake with generated .pro file to export Qt variables into MSBuild .props file
  // -->
  <Target
    Name="QtVars"
    Condition="'$(QtVsProjectSettings)' == 'true'"
    DependsOnTargets="QtMocInit;QtUicInit"
    Inputs="$(MSBuildProjectFile)" Outputs="$(QtVarsFilePath);$(QtVarsDesignTime)">

    <CreateProperty
      Condition="Exists('$(QtInstall)')"
      Value="$(QtInstall)">
      <Output TaskParameter="ValueSetByTask" PropertyName="QtInstallDir" />
    </CreateProperty>
    <CreateProperty
      Condition="!Exists('$(QtInstall)') AND '$(QtInstall)' != ''"
      Value="HKEY_CURRENT_USER\Software\Digia\Versions\$(QtInstall)">
      <Output TaskParameter="ValueSetByTask" PropertyName="QtInstallRegKey" />
    </CreateProperty>
    <CreateProperty
      Condition="!Exists('$(QtInstall)') AND '$(QtInstall)' != ''"
      Value="$([MSBuild]::GetRegistryValue('$(QtInstallRegKey)','InstallDir'))">
      <Output TaskParameter="ValueSetByTask" PropertyName="QtInstallRegDir" />
    </CreateProperty>
    <CreateProperty
      Condition="!Exists('$(QtInstall)') AND '$(QtInstall)' != ''"
      Value="$(QtInstallRegDir)">
      <Output TaskParameter="ValueSetByTask" PropertyName="QtInstallDir" />
    </CreateProperty>
    <CreateProperty
      Condition="!$([System.IO.Path]::IsPathRooted('$(QtPathBinaries)'))"
      Value="$(QtInstallDir)\$(QtPathBinaries)">
      <Output TaskParameter="ValueSetByTask" PropertyName="QtToolsPath" />
    </CreateProperty>
    <CreateProperty
      Condition="$([System.IO.Path]::IsPathRooted('$(QtPathBinaries)'))"
      Value="$(QtPathBinaries)">
      <Output TaskParameter="ValueSetByTask" PropertyName="QtToolsPath" />
    </CreateProperty>

    <!--// Generate INCLUDEPATH value -->
    <ItemGroup>
      <QtIncludes Include=
"$([System.IO.Path]::Combine($(QtInstallDir),$([System.String]::Copy('%(QtIncludesList.Identity)'))))"/>
    </ItemGroup>
    <PropertyGroup>
      <QtIncludes>@(QtIncludes->'&quot;%(Identity)&quot;', ' ')</QtIncludes>
    </PropertyGroup>

    <!--// Generate LIBS value -->
    <ItemGroup>
      <QtLibs Include=
"$([System.IO.Path]::Combine($(QtInstallDir),$([System.String]::Copy('%(QtLibsList.Identity)'))))"/>
    </ItemGroup>
    <PropertyGroup>
      <QtLibs>@(QtLibs->'&quot;-L%(Identity)&quot;', ' ')</QtLibs>
    </PropertyGroup>

    <Message
      Importance="high"
      Text="Reading Qt configuration ($(QtToolsPath)\qmake.exe)"/>

    <PropertyGroup>

      <!--// .pro file configuration -->
      <QtVarsProFileConfig
        Condition="'$(Configuration)' == 'Debug'">
        CONFIG -= debug release debug_and_release
        CONFIG += debug
      </QtVarsProFileConfig>
      <QtVarsProFileConfig
        Condition="'$(Configuration)' != 'Debug'">
        CONFIG -= debug release debug_and_release
        CONFIG += release
      </QtVarsProFileConfig>

      <!--// .pro file input parameters -->
      <QtVarsProFileInput>
        <!--
# Qt vars data file name -->
        fileName = "qtvars_$(PlatformEscaped)_$(ConfigurationEscaped).props"
        <!--
# Selected Qt modules -->
        modules = $(QtModuleNames)
        <!--
# Selected Qt variables -->
        varNames = $(QtVarNames)
        <!--
# Custom additional .pro file code (from property page) -->
        @(QMakeCodeLine->'%(Identity)','%0D%0A')
      </QtVarsProFileInput>
      <!--
# Custom additional header search paths (from property page) -->
      <QtVarsProFileInput Condition="'$(QtHeaderSearchPath)' != ''">
        $(QtVarsProFileInput)
        INCLUDEPATH += $(QtIncludes)
      </QtVarsProFileInput>
      <!--
# Custom additional library search paths (from property page) -->
      <QtVarsProFileInput Condition="'$(QtLibrarySearchPath)' != ''">
        $(QtVarsProFileInput)
        LIBS += $(QtLibs)
      </QtVarsProFileInput>
      <!--
# Undef UNICODE macro if project is configured with multi-byte char set -->
      <QtVarsProFileInput Condition="'$(CharacterSet)' == 'MultiByte'">
        $(QtVarsProFileInput)
        DEFINES -= UNICODE _UNICODE
      </QtVarsProFileInput>

      <!--// Generate .pro file -->
      <!--
######## BEGIN generated qmake project #############################################################
##    -->
      <QtVarsProFileText>
        <![CDATA[
## Escape string for use by MSBuild
#
defineReplace(formatMsBuildString) {
    exprValue = $$1
    exprText = ""
    sep = ""
    for (value, exprValue) {
        value = $$replace(value, "%",    "%2525")
        value = $$replace(value, "%3B",  "%253B")
        value = $$replace(value, "\x24", "%2524")
        value = $$replace(value, "@",    "%2540")
        exprText = "$$exprText$$sep$$value"
        sep = "%3B"
    }
    return($$exprText)
}

## Fetch information from required modules through dependency relation
#
defined(modules, var) {
    INCLUDEPATH += $$[INCLUDEPATH]
    QT = $$resolve_depends(modules, "QT.")
    for (module, $$list($${QT})) {
        INCLUDEPATH *= $$eval($$"QT.$${module}.includes")
        DEFINES *= $$eval($$"QT.$${module}.DEFINES")
    }
}

## Add "qtvars" make target: append "late-bound" variables (e.g. LIBS) to .props (XML) file.
#
contains(varNames, LIBS) {
    varNames -= LIBS
    nop = "(ECHO>NUL)"
    qtvars.target = qtvars
    qtvars.commands = CMD /V:ON /C \
        \"@ECHO OFF &\
        SET VALUE= &\
        (FOR %%x IN (%24(LIBS)) DO (\
            SET y=%%x&\
            IF NOT \"!y:~0,9!\"==\"/LIBPATH:\"\
                SET VALUE=!y!%3B!VALUE!& $$nop \
        ))&\
        SET PROP=^<Qt_LIBS_^>!VALUE:~0,-2!^</Qt_LIBS_^>&\
        ECHO !PROP!>>$$fileName&\"
    QMAKE_EXTRA_TARGETS += qtvars
}

## Append Qt variables to .props (XML) file
#
for (varName, $$list($$sorted(varNames))) {
    propName = "Qt_$${varName}_"
    text = "<$${propName}>"$$formatMsBuildString($$eval($$varName))"</$${propName}>"
    write_file($$fileName, text, append)
}
        ]]>
      </QtVarsProFileText>
      <!--
##
######## END generated qmake project ###############################################################
      -->
    </PropertyGroup>

    <!--// Write .pro file to temp path -->
    <RemoveDir
      Directories="$(QtVarsWorkDir)"/>
    <MakeDir
      Directories="$(QtVarsWorkDir)"/>
    <WriteLinesToFile
      File="$(QtVarsWorkDir)\qtvars.pro"
      Lines="$(QtVarsProFileConfig)
            ;$(QtVarsProFileInput)
            ;$(QtVarsProFileText)"/>

    <!--// Write start of Qt vars data file:
        //  * Open property group tag -->
    <PropertyGroup>
      <!--
######## BEGIN generated XML (.props) ##############################################################
##    -->
      <QtVarsDataFileText>
        <![CDATA[
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
        ]]>
      </QtVarsDataFileText>
      <!--
##
######## END generated XML (.props) ################################################################
      -->
    </PropertyGroup>
    <WriteLinesToFile File="$(QtVarsWorkPath)" Lines="$(QtVarsDataFileText)" Overwrite="true"/>

    <!--// Run qmake && nmake: append output to .props (XML) file -->
    <SetEnv Name="PATH" Prefix="true" Value="$(ExecutablePath)"/>
    <PropertyGroup>
      <Cmd><![CDATA[("$(QtToolsPath)\qmake.exe" && nmake qtvars) 1> qtvars.log 2>&1]]></Cmd>
    </PropertyGroup>
    <Exec WorkingDirectory="$(QtVarsWorkDir)" IgnoreExitCode="true" Command="$(Cmd)">
      <Output TaskParameter="ExitCode" PropertyName="ErrorLevel"/>
    </Exec>

    <!--// If error, show qmake/nmake console output and stop build -->
    <ReadLinesFromFile
        File="$(QtVarsWorkDir)\qtvars.log">
      <Output TaskParameter="Lines" ItemName="QMakeError"/>
    </ReadLinesFromFile>
    <ItemGroup Condition="'$(ErrorLevel)' != '0'">
      <QMakeError
        Condition="$([System.String]::Copy('%(Identity)').StartsWith('Info: creating stash file'))"
        Remove="@(QMakeError)"/>
    </ItemGroup>
    <Message
      Importance="high"
      Condition="'$(QtVarsDebug)' == 'true'"
      Text="@(QMakeError->'%(Identity)','%0D%0A')"/>
    <Error
      Condition="'$(ErrorLevel)' != '0' AND '$(DesignTimeBuild)' != 'true'"
      File="$(MSBuildProjectFile)"
      Text="@(QMakeError->'%(Identity)','%0D%0A')"/>

    <!--// Qt settings list for backup -->
    <ItemGroup>
      <QtInstall Include="$(QtInstall)"/>
      <QtModules Include="$(QtModules)"/>
      <QtPathBinaries Include="$(QtPathBinaries)"/>
      <QtPathLibraryExecutables Include="$(QtPathLibraryExecutables)"/>
      <QtHeaderSearchPath Include="$(QtHeaderSearchPath)"/>
      <QtLibrarySearchPath Include="$(QtLibrarySearchPath)"/>
      <QtVariables Include="$(QtVariables)"/>
      <QMakeCodeLines Include="$(QMakeCodeLines)"/>
    </ItemGroup>

    <!--// Write end of .props (XML) file
        //  * Close property group tag
        //  * Create QtVar items to export Qt variables to the calling instance of MSBuild
        //  * Close project tag -->
    <PropertyGroup>
      <!--
######## BEGIN generated XML (.props) ##############################################################
##    -->
      <QtVarsDataFileText>
        <![CDATA[
    <Qt_INCLUDEPATH_
      >%24(Qt_INCLUDEPATH_)%3B@(QtIncludePath->Distinct(),'%3B')</Qt_INCLUDEPATH_>
    <QtBkup_QtInstall
      >@(QtInstall,'%3B')</QtBkup_QtInstall>
    <QtBkup_QtModules
      >@(QtModules,'%3B')</QtBkup_QtModules>
    <QtBkup_QtPathBinaries
      >@(QtPathBinaries,'%3B')</QtBkup_QtPathBinaries>
    <QtBkup_QtPathLibraryExecutables
      >@(QtPathLibraryExecutables,'%3B')</QtBkup_QtPathLibraryExecutables>
    <QtBkup_QtHeaderSearchPath
      >@(QtHeaderSearchPath,'%3B')</QtBkup_QtHeaderSearchPath>
    <QtBkup_QtLibrarySearchPath
      >@(QtLibrarySearchPath,'%3B')</QtBkup_QtLibrarySearchPath>
    <QtBkup_QtVariables
      >@(QtVariables,'%3B')</QtBkup_QtVariables>
    <QtBkup_QMakeCodeLines
      >@(QMakeCodeLines,'%3B')</QtBkup_QMakeCodeLines>
  </PropertyGroup>
  <ItemGroup>
    @(QtVarProp->'<QtVar Include="%(Identity)"><Value>%24(%(Identity))</Value></QtVar>', '%0D%0A')
  </ItemGroup>
</Project>
        ]]>
      </QtVarsDataFileText>
      <!--
##
######## END generated XML (.props) ################################################################
      -->
    </PropertyGroup>
    <WriteLinesToFile File="$(QtVarsWorkPath)" Lines="$(QtVarsDataFileText)"/>

    <!--// Copy generated .props to $(IntDir) -->
    <Delete
      Condition="'$(ErrorLevel)' == '0'"
      Files="$(IntDir)qtvars_$(PlatformEscaped)_$(ConfigurationEscaped).props"/>
    <Copy
      Condition="'$(ErrorLevel)' == '0'"
      SourceFiles="$(QtVarsWorkPath)" DestinationFiles="$(QtVarsFilePath)"/>

    <!--// Copy generated qtvars_plugin_import.cpp to $(IntDir)\qmake -->
    <Delete
      Condition="'$(ErrorLevel)' == '0'"
      Files="$(IntDir)qmake\qtvars_plugin_import.cpp"/>
    <Copy
      Condition="'$(ErrorLevel)' == '0' AND Exists('$(QtVarsWorkDir)\qtvars_plugin_import.cpp')"
      SourceFiles="$(QtVarsWorkDir)\qtvars_plugin_import.cpp"
      DestinationFiles="$(IntDir)qmake\qtvars_plugin_import.cpp"/>

    <!--// Remove work dir -->
    <RemoveDir
      Condition="'$(QtVarsDebug)' != 'true'"
      Directories="$(QtVarsWorkDir)"/>

    <!--// In design-time, copy generated .props to randomly named file -->
    <PropertyGroup>
      <QtVarsDesignTimeNew
        Condition="'$(ErrorLevel)' == '0'"
        >$([System.IO.Path]::Combine('$(QtVarsOutputDir)',
          'qtvars_$([System.IO.Path]::GetRandomFileName()).designtime.props'))</QtVarsDesignTimeNew>
    </PropertyGroup>
    <Delete
      Condition="'$(ErrorLevel)' == '0'"
      Files="$([System.IO.Directory]::GetFiles('$(QtVarsOutputDir)', '*.designtime.props'))"/>
    <Copy
      Condition="'$(ErrorLevel)' == '0'"
      SourceFiles="$(QtVarsFilePath)" DestinationFiles="$(QtVarsDesignTimeNew)"/>
    <WriteLinesToFile
      Condition="'$(ErrorLevel)' == '0'"
      File="$(QtVarsIndexPathDesignTime)" Overwrite="true" Lines="$(QtVarsDesignTimeNew)"/>

    <!--// Skip remaining build -->
    <CreateProperty Value="true">
      <Output TaskParameter="ValueSetByTask" PropertyName="QtSkipWork" />
    </CreateProperty>
    <CallTarget
      Condition="'$(QtSkipBuildTargets)' != ''"
      Targets="$(QtSkipBuildTargets)"/>

    <!--// Restart build in second MSBuild instance with updated Qt variables -->
    <MSBuild
      Condition="'$(DesignTimeBuild)' != 'true'"
      Projects="$(MSBuildProjectFullPath)"
      Targets="Build"
      Properties="RandomFileName=$([System.IO.Path]::GetRandomFileName())">
    </MSBuild>

    <!--// Clean-up -->
    <ItemGroup>
      <ProjectItem Remove="@(ProjectItem)"/>
      <QtModuleList Remove="@(QtModuleList)"/>
      <QtVariableList Remove="@(QtVariableList)"/>
      <QMakeCodeLine Remove="@(QMakeCodeLine)"/>
    </ItemGroup>
    <PropertyGroup>
      <QMakeProjTempDir/>
      <QtVarsTempPath/>
      <QtModuleNames/>
      <QMakeVarNames/>
      <QMakeAdditionalCode/>
      <QtVarsProFileText/>
      <Cmd/>
    </PropertyGroup>
  </Target>

  <!--
  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// TARGET QtVarsPrepare
  /////////////////////////////////////////////////////////////////////////////////////////////////
  // Force QtVars target to run when Qt settings have changed
  // -->
  <Target Name="QtVarsPrepare" BeforeTargets="QtVars" Condition="Exists('$(QtVarsFilePath)')">
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QtInstall)' != '$(QtInstall)'" />
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QtModules)' != '$(QtModules)'" />
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QtPathBinaries)' != '$(QtPathBinaries)'" />
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QtPathLibraryExecutables)' != '$(QtPathLibraryExecutables)'" />
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QtHeaderSearchPath)' != '$(QtHeaderSearchPath)'" />
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QtLibrarySearchPath)' != '$(QtLibrarySearchPath)'" />
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QtVariables)' != '$(QtVariables)'" />
    <Delete Files="$(QtVarsFilePath)" Condition="Exists('$(QtVarsFilePath)')
        AND '$(QtBkup_QMakeCodeLines)' != '$(QMakeCodeLines)'" />
  </Target>

  <!--
  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// TARGET QtVarsDesignTime
  /////////////////////////////////////////////////////////////////////////////////////////////////
  // Force QtVars target to run (called when project properties change)
  // -->
  <Target Name="QtVarsDesignTime">
    <Delete Files="$(QtVarsFilePath)"/>
    <CallTarget Targets="QtVars"/>
  </Target>

  <!--
  /////////////////////////////////////////////////////////////////////////////////////////////////
  /// TARGET QtSkipBuild
  /////////////////////////////////////////////////////////////////////////////////////////////////
  // Remove source file items in order to skip remaining build process
  // -->
  <Target Name="QtSkipBuild">
    <ItemGroup>
      <QtMoc Remove="@(QtMoc)"/>
      <QtRcc Remove="@(QtRcc)"/>
      <QtRepc Remove="@(QtRepc)"/>
      <QtUic Remove="@(QtUic)"/>
      <ClCompile Remove="@(ClCompile)"/>
      <Link Remove="@(Link)"/>
    </ItemGroup>
  </Target>

</Project>