cmQtAutoGenInitializer.cxx 52.7 KB
Newer Older
1 2
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file Copyright.txt or https://cmake.org/licensing for details.  */
3
#include "cmQtAutoGenInitializer.h"
4
#include "cmQtAutoGen.h"
5
#include "cmQtAutoGenGlobalInitializer.h"
6

7
#include "cmAlgorithms.h"
8
#include "cmCustomCommand.h"
9
#include "cmCustomCommandLines.h"
10
#include "cmDuration.h"
11
#include "cmFilePathChecksum.h"
12
#include "cmGeneratorExpression.h"
13
#include "cmGeneratorTarget.h"
14
#include "cmGlobalGenerator.h"
15
#include "cmLinkItem.h"
16
#include "cmListFileCache.h"
17 18
#include "cmLocalGenerator.h"
#include "cmMakefile.h"
19
#include "cmMessageType.h"
20
#include "cmOutputConverter.h"
21
#include "cmPolicies.h"
22
#include "cmProcessOutput.h"
23
#include "cmSourceFile.h"
Daniel Pfeifer's avatar
Daniel Pfeifer committed
24
#include "cmSourceGroup.h"
25
#include "cmState.h"
26
#include "cmStateTypes.h"
27 28
#include "cmSystemTools.h"
#include "cmTarget.h"
29
#include "cmsys/FStream.hxx"
30
#include "cmsys/SystemInformation.hxx"
31

32
#include <algorithm>
33
#include <array>
34
#include <deque>
35 36
#include <map>
#include <set>
37
#include <sstream>
38
#include <string>
39
#include <type_traits>
40 41 42
#include <utility>
#include <vector>

43 44 45
std::string GetQtExecutableTargetName(
  const cmQtAutoGen::IntegerVersion& qtVersion, std::string const& executable)
{
Tobias Hunger's avatar
Tobias Hunger committed
46 47 48
  if (qtVersion.Major == 6) {
    return ("Qt6::" + executable);
  }
49 50 51 52 53 54 55 56 57
  if (qtVersion.Major == 5) {
    return ("Qt5::" + executable);
  }
  if (qtVersion.Major == 4) {
    return ("Qt4::" + executable);
  }
  return ("");
}

58 59 60 61 62 63 64 65 66 67 68 69 70 71
static std::size_t GetParallelCPUCount()
{
  static std::size_t count = 0;
  // Detect only on the first call
  if (count == 0) {
    cmsys::SystemInformation info;
    info.RunCPUCheck();
    count = info.GetNumberOfPhysicalCPU();
    count = std::max<std::size_t>(count, 1);
    count = std::min<std::size_t>(count, cmQtAutoGen::ParallelMax);
  }
  return count;
}

72
static bool AddToSourceGroup(cmMakefile* makefile, std::string const& fileName,
73
                             cmQtAutoGen::GenT genType)
74
{
Daniel Pfeifer's avatar
Daniel Pfeifer committed
75
  cmSourceGroup* sourceGroup = nullptr;
76 77
  // Acquire source group
  {
78 79 80 81 82 83
    std::string property;
    std::string groupName;
    {
      std::array<std::string, 2> props;
      // Use generator specific group name
      switch (genType) {
84
        case cmQtAutoGen::GenT::MOC:
85 86
          props[0] = "AUTOMOC_SOURCE_GROUP";
          break;
87
        case cmQtAutoGen::GenT::RCC:
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
          props[0] = "AUTORCC_SOURCE_GROUP";
          break;
        default:
          props[0] = "AUTOGEN_SOURCE_GROUP";
          break;
      }
      props[1] = "AUTOGEN_SOURCE_GROUP";
      for (std::string& prop : props) {
        const char* propName = makefile->GetState()->GetGlobalProperty(prop);
        if ((propName != nullptr) && (*propName != '\0')) {
          groupName = propName;
          property = std::move(prop);
          break;
        }
      }
103 104
    }
    // Generate a source group on demand
105
    if (!groupName.empty()) {
106
      sourceGroup = makefile->GetOrCreateSourceGroup(groupName);
Daniel Pfeifer's avatar
Daniel Pfeifer committed
107
      if (sourceGroup == nullptr) {
108 109 110 111 112
        std::ostringstream ost;
        ost << cmQtAutoGen::GeneratorNameUpper(genType);
        ost << ": " << property;
        ost << ": Could not find or create the source group ";
        ost << cmQtAutoGen::Quoted(groupName);
113
        cmSystemTools::Error(ost.str());
114 115 116 117
        return false;
      }
    }
  }
Daniel Pfeifer's avatar
Daniel Pfeifer committed
118
  if (sourceGroup != nullptr) {
119 120 121 122 123
    sourceGroup->AddGroupFile(fileName);
  }
  return true;
}

124
static void AddCleanFile(cmMakefile* makefile, std::string const& fileName)
125 126 127 128 129
{
  makefile->AppendProperty("ADDITIONAL_MAKE_CLEAN_FILES", fileName.c_str(),
                           false);
}

130 131 132 133 134 135
static std::string FileProjectRelativePath(cmMakefile* makefile,
                                           std::string const& fileName)
{
  std::string res;
  {
    std::string pSource = cmSystemTools::RelativePath(
136
      makefile->GetCurrentSourceDirectory(), fileName);
137
    std::string pBinary = cmSystemTools::RelativePath(
138
      makefile->GetCurrentBinaryDirectory(), fileName);
139 140 141 142 143 144 145 146 147 148 149
    if (pSource.size() < pBinary.size()) {
      res = std::move(pSource);
    } else if (pBinary.size() < fileName.size()) {
      res = std::move(pBinary);
    } else {
      res = fileName;
    }
  }
  return res;
}

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
/* @brief Tests if targetDepend is a STATIC_LIBRARY and if any of its
 * recursive STATIC_LIBRARY dependencies depends on targetOrigin
 * (STATIC_LIBRARY cycle).
 */
static bool StaticLibraryCycle(cmGeneratorTarget const* targetOrigin,
                               cmGeneratorTarget const* targetDepend,
                               std::string const& config)
{
  bool cycle = false;
  if ((targetOrigin->GetType() == cmStateEnums::STATIC_LIBRARY) &&
      (targetDepend->GetType() == cmStateEnums::STATIC_LIBRARY)) {
    std::set<cmGeneratorTarget const*> knownLibs;
    std::deque<cmGeneratorTarget const*> testLibs;

    // Insert initial static_library dependency
    knownLibs.insert(targetDepend);
    testLibs.push_back(targetDepend);

    while (!testLibs.empty()) {
      cmGeneratorTarget const* testTarget = testLibs.front();
      testLibs.pop_front();
      // Check if the test target is the origin target (cycle)
      if (testTarget == targetOrigin) {
        cycle = true;
        break;
      }
      // Collect all static_library dependencies from the test target
      cmLinkImplementationLibraries const* libs =
        testTarget->GetLinkImplementationLibraries(config);
      if (libs != nullptr) {
        for (cmLinkItem const& item : libs->Libraries) {
          cmGeneratorTarget const* depTarget = item.Target;
          if ((depTarget != nullptr) &&
              (depTarget->GetType() == cmStateEnums::STATIC_LIBRARY) &&
              knownLibs.insert(depTarget).second) {
            testLibs.push_back(depTarget);
          }
        }
      }
    }
  }
  return cycle;
}

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
cmQtAutoGenInitializer::InfoWriter::InfoWriter(std::string const& filename)
{
  Ofs_.SetCopyIfDifferent(true);
  Ofs_.Open(filename, false, true);
}

template <class IT>
std::string cmQtAutoGenInitializer::InfoWriter::ListJoin(IT it_begin,
                                                         IT it_end)
{
  std::string res;
  for (IT it = it_begin; it != it_end; ++it) {
    if (it != it_begin) {
      res += ';';
    }
    for (const char* c = it->c_str(); *c; ++c) {
      if (*c == '"') {
        // Escape the double quote to avoid ending the argument.
        res += "\\\"";
      } else if (*c == '$') {
        // Escape the dollar to avoid expanding variables.
        res += "\\$";
      } else if (*c == '\\') {
        // Escape the backslash to avoid other escapes.
        res += "\\\\";
      } else if (*c == ';') {
        // Escape the semicolon to avoid list expansion.
        res += "\\;";
      } else {
        // Other characters will be parsed correctly.
        res += *c;
      }
    }
  }
  return res;
}

std::string cmQtAutoGenInitializer::InfoWriter::ConfigKey(
  const char* key, std::string const& config)
{
  std::string ckey = key;
  ckey += '_';
  ckey += config;
  return ckey;
}

void cmQtAutoGenInitializer::InfoWriter::Write(const char* key,
                                               std::string const& value)
{
  Ofs_ << "set(" << key << " " << cmOutputConverter::EscapeForCMake(value)
       << ")\n";
};

void cmQtAutoGenInitializer::InfoWriter::WriteUInt(const char* key,
                                                   unsigned int value)
{
  Ofs_ << "set(" << key << " " << value << ")\n";
};

template <class C>
void cmQtAutoGenInitializer::InfoWriter::WriteStrings(const char* key,
                                                      C const& container)
{
  Ofs_ << "set(" << key << " \""
       << ListJoin(container.begin(), container.end()) << "\")\n";
}

void cmQtAutoGenInitializer::InfoWriter::WriteConfig(
  const char* key, std::map<std::string, std::string> const& map)
{
  for (auto const& item : map) {
    Write(ConfigKey(key, item.first).c_str(), item.second);
  }
};

template <class C>
void cmQtAutoGenInitializer::InfoWriter::WriteConfigStrings(
  const char* key, std::map<std::string, C> const& map)
{
  for (auto const& item : map) {
    WriteStrings(ConfigKey(key, item.first).c_str(), item.second);
  }
}

void cmQtAutoGenInitializer::InfoWriter::WriteNestedLists(
  const char* key, std::vector<std::vector<std::string>> const& lists)
{
  std::vector<std::string> seplist;
  for (const std::vector<std::string>& list : lists) {
    std::string blist = "{";
    blist += ListJoin(list.begin(), list.end());
    blist += "}";
    seplist.push_back(std::move(blist));
  }
  Write(key, cmJoin(seplist, cmQtAutoGen::ListSep));
};

291 292 293 294 295 296
cmQtAutoGenInitializer::cmQtAutoGenInitializer(
  cmQtAutoGenGlobalInitializer* globalInitializer, cmGeneratorTarget* target,
  IntegerVersion const& qtVersion, bool mocEnabled, bool uicEnabled,
  bool rccEnabled, bool globalAutogenTarget, bool globalAutoRccTarget)
  : GlobalInitializer(globalInitializer)
  , Target(target)
297
  , QtVersion(qtVersion)
298
{
299
  AutogenTarget.GlobalTarget = globalAutogenTarget;
300 301 302
  Moc.Enabled = mocEnabled;
  Uic.Enabled = uicEnabled;
  Rcc.Enabled = rccEnabled;
303
  Rcc.GlobalTarget = globalAutoRccTarget;
304
}
305

306
bool cmQtAutoGenInitializer::InitCustomTargets()
307 308 309 310
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
  cmLocalGenerator* localGen = this->Target->GetLocalGenerator();
  cmGlobalGenerator* globalGen = localGen->GetGlobalGenerator();
311

312 313 314 315 316 317 318
  // Configurations
  this->MultiConfig = globalGen->IsMultiConfig();
  this->ConfigDefault = makefile->GetConfigurations(this->ConfigsList);
  if (this->ConfigsList.empty()) {
    this->ConfigsList.push_back(this->ConfigDefault);
  }

319
  // Verbosity
320 321 322 323 324
  this->Verbosity = makefile->GetSafeDefinition("CMAKE_AUTOGEN_VERBOSE");
  if (!this->Verbosity.empty()) {
    unsigned long iVerb = 0;
    if (!cmSystemTools::StringToULong(this->Verbosity.c_str(), &iVerb)) {
      // Non numeric verbosity
325
      this->Verbosity = cmSystemTools::IsOn(this->Verbosity) ? "1" : "0";
326 327 328
    }
  }

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
  // Targets FOLDER
  {
    const char* folder =
      makefile->GetState()->GetGlobalProperty("AUTOMOC_TARGETS_FOLDER");
    if (folder == nullptr) {
      folder =
        makefile->GetState()->GetGlobalProperty("AUTOGEN_TARGETS_FOLDER");
    }
    // Inherit FOLDER property from target (#13688)
    if (folder == nullptr) {
      folder = this->Target->GetProperty("FOLDER");
    }
    if (folder != nullptr) {
      this->TargetsFolder = folder;
    }
344 345
  }

346
  // Common directories
347 348 349
  {
    // Collapsed current binary directory
    std::string const cbd = cmSystemTools::CollapseFullPath(
350
      std::string(), makefile->GetCurrentBinaryDirectory());
351

352 353
    // Info directory
    this->Dir.Info = cbd;
354
    this->Dir.Info += "/CMakeFiles";
355 356 357 358 359 360 361 362 363 364 365 366 367
    this->Dir.Info += '/';
    this->Dir.Info += this->Target->GetName();
    this->Dir.Info += "_autogen";
    this->Dir.Info += ".dir";
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Info);

    // Build directory
    this->Dir.Build = this->Target->GetSafeProperty("AUTOGEN_BUILD_DIR");
    if (this->Dir.Build.empty()) {
      this->Dir.Build = cbd;
      this->Dir.Build += '/';
      this->Dir.Build += this->Target->GetName();
      this->Dir.Build += "_autogen";
368
    }
369 370 371
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Build);
    // Cleanup build directory
    AddCleanFile(makefile, this->Dir.Build);
372 373

    // Working directory
374 375
    this->Dir.Work = cbd;
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Work);
376 377

    // Include directory
378 379
    this->Dir.Include = this->Dir.Build;
    this->Dir.Include += "/include";
380
    if (this->MultiConfig) {
381
      this->Dir.Include += "_$<CONFIG>";
382
    }
383
    // Per config include directories
384 385
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
386 387
        std::string& dir = this->Dir.ConfigInclude[cfg];
        dir = this->Dir.Build;
388 389 390 391
        dir += "/include_";
        dir += cfg;
      }
    }
392
  }
393

394
  // Moc, Uic and _autogen target settings
395 396 397 398 399
  if (this->Moc.Enabled || this->Uic.Enabled) {
    // Init moc specific settings
    if (this->Moc.Enabled && !InitMoc()) {
      return false;
    }
400

401
    // Init uic specific settings
402 403 404 405 406 407 408 409 410 411
    if (this->Uic.Enabled) {
      if (InitUic()) {
        auto* uicTarget = makefile->FindTargetToUse(
          GetQtExecutableTargetName(this->QtVersion, "uic"));
        if (uicTarget != nullptr) {
          this->AutogenTarget.DependTargets.insert(uicTarget);
        }
      } else {
        return false;
      }
412 413
    }

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
    // Autogen target name
    this->AutogenTarget.Name = this->Target->GetName();
    this->AutogenTarget.Name += "_autogen";

    // Autogen target parallel processing
    this->AutogenTarget.Parallel =
      this->Target->GetSafeProperty("AUTOGEN_PARALLEL");
    if (this->AutogenTarget.Parallel.empty() ||
        (this->AutogenTarget.Parallel == "AUTO")) {
      // Autodetect number of CPUs
      this->AutogenTarget.Parallel = std::to_string(GetParallelCPUCount());
    }

    // Autogen target info and settings files
    {
      this->AutogenTarget.InfoFile = this->Dir.Info;
      this->AutogenTarget.InfoFile += "/AutogenInfo.cmake";

      this->AutogenTarget.SettingsFile = this->Dir.Info;
      this->AutogenTarget.SettingsFile += "/AutogenOldSettings.txt";

      if (this->MultiConfig) {
        for (std::string const& cfg : this->ConfigsList) {
          std::string& filename = this->AutogenTarget.ConfigSettingsFile[cfg];
          filename =
            AppendFilenameSuffix(this->AutogenTarget.SettingsFile, "_" + cfg);
          AddCleanFile(makefile, filename);
        }
      } else {
        AddCleanFile(makefile, this->AutogenTarget.SettingsFile);
      }
    }

447 448
    // Autogen target: Compute user defined dependencies
    {
449 450 451
      this->AutogenTarget.DependOrigin =
        this->Target->GetPropertyAsBool("AUTOGEN_ORIGIN_DEPENDS");

452 453 454 455 456 457
      auto* mocTarget = makefile->FindTargetToUse(
        GetQtExecutableTargetName(this->QtVersion, "moc"));
      if (mocTarget != nullptr) {
        this->AutogenTarget.DependTargets.insert(mocTarget);
      }

458 459 460 461 462 463 464 465 466
      std::string const deps =
        this->Target->GetSafeProperty("AUTOGEN_TARGET_DEPENDS");
      if (!deps.empty()) {
        std::vector<std::string> extraDeps;
        cmSystemTools::ExpandListArgument(deps, extraDeps);
        for (std::string const& depName : extraDeps) {
          // Allow target and file dependencies
          auto* depTarget = makefile->FindTargetToUse(depName);
          if (depTarget != nullptr) {
467
            this->AutogenTarget.DependTargets.insert(depTarget);
468
          } else {
469
            this->AutogenTarget.DependFiles.insert(depName);
470 471 472 473 474
          }
        }
      }
    }
  }
475

476 477 478 479 480 481 482 483
  // Init rcc specific settings
  if (this->Rcc.Enabled && !InitRcc()) {
    return false;
  }

  // Add autogen include directory to the origin target INCLUDE_DIRECTORIES
  if (this->Moc.Enabled || this->Uic.Enabled ||
      (this->Rcc.Enabled && this->MultiConfig)) {
484
    this->Target->AddIncludeDirectory(this->Dir.Include, true);
485 486 487 488 489 490 491 492 493 494 495
  }

  // Scan files
  if (!this->InitScanFiles()) {
    return false;
  }

  // Create autogen target
  if ((this->Moc.Enabled || this->Uic.Enabled) && !this->InitAutogenTarget()) {
    return false;
  }
496

497 498 499 500 501 502 503 504 505 506 507 508 509 510
  // Create rcc targets
  if (this->Rcc.Enabled && !this->InitRccTargets()) {
    return false;
  }

  return true;
}

bool cmQtAutoGenInitializer::InitMoc()
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
  cmLocalGenerator* localGen = this->Target->GetLocalGenerator();

  // Mocs compilation file
511
  this->Moc.MocsCompilation = this->Dir.Build;
512 513 514 515
  this->Moc.MocsCompilation += "/mocs_compilation.cpp";

  // Moc predefs command
  if (this->Target->GetPropertyAsBool("AUTOMOC_COMPILER_PREDEFINES") &&
516
      (this->QtVersion >= IntegerVersion(5, 8))) {
517 518 519 520 521
    this->Moc.PredefsCmd =
      makefile->GetSafeDefinition("CMAKE_CXX_COMPILER_PREDEFINES_COMMAND");
  }

  // Moc includes
522
  {
523
    bool const appendImplicit = (this->QtVersion.Major >= 5);
524
    auto GetIncludeDirs =
525 526
      [this, localGen,
       appendImplicit](std::string const& cfg) -> std::vector<std::string> {
527 528 529 530
      // Get the include dirs for this target, without stripping the implicit
      // include dirs off, see
      // https://gitlab.kitware.com/cmake/cmake/issues/13667
      std::vector<std::string> dirs;
531 532
      localGen->GetIncludeDirectoriesImplicit(dirs, this->Target, "CXX", cfg,
                                              false, appendImplicit);
533
      return dirs;
534 535 536 537 538
    };

    // Default configuration include directories
    this->Moc.Includes = GetIncludeDirs(this->ConfigDefault);
    // Other configuration settings
539
    if (this->MultiConfig) {
540
      for (std::string const& cfg : this->ConfigsList) {
541
        std::vector<std::string> dirs = GetIncludeDirs(cfg);
542 543 544
        if (dirs != this->Moc.Includes) {
          this->Moc.ConfigIncludes[cfg] = std::move(dirs);
        }
545
      }
546
    }
547 548
  }

549 550 551
  // Moc compile definitions
  {
    auto GetCompileDefinitions =
552
      [this, localGen](std::string const& cfg) -> std::set<std::string> {
553
      std::set<std::string> defines;
554
      localGen->GetTargetDefines(this->Target, cfg, "CXX", defines);
555 556 557 558 559 560
#ifdef _WIN32
      if (this->Moc.PredefsCmd.empty()) {
        // Add WIN32 definition if we don't have a moc_predefs.h
        defines.insert("WIN32");
      }
#endif
561
      return defines;
562 563 564 565 566 567 568
    };

    // Default configuration defines
    this->Moc.Defines = GetCompileDefinitions(this->ConfigDefault);
    // Other configuration defines
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
569
        std::set<std::string> defines = GetCompileDefinitions(cfg);
570 571 572 573 574
        if (defines != this->Moc.Defines) {
          this->Moc.ConfigDefines[cfg] = std::move(defines);
        }
      }
    }
575
  }
576 577

  // Moc executable
578
  return GetMocExecutable();
579 580 581 582 583 584 585 586 587 588 589 590
}

bool cmQtAutoGenInitializer::InitUic()
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();

  // Uic search paths
  {
    std::string const usp =
      this->Target->GetSafeProperty("AUTOUIC_SEARCH_PATHS");
    if (!usp.empty()) {
      cmSystemTools::ExpandListArgument(usp, this->Uic.SearchPaths);
591
      std::string const& srcDir = makefile->GetCurrentSourceDirectory();
592 593 594 595
      for (std::string& path : this->Uic.SearchPaths) {
        path = cmSystemTools::CollapseFullPath(path, srcDir);
      }
    }
596
  }
597 598
  // Uic target options
  {
599 600
    auto UicGetOpts =
      [this](std::string const& cfg) -> std::vector<std::string> {
601 602
      std::vector<std::string> opts;
      this->Target->GetAutoUicOptions(opts, cfg);
603
      return opts;
604
    };
605

606 607 608 609 610 611
    // Default settings
    this->Uic.Options = UicGetOpts(this->ConfigDefault);

    // Configuration specific settings
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
612
        std::vector<std::string> options = UicGetOpts(cfg);
613 614 615 616 617 618
        if (options != this->Uic.Options) {
          this->Uic.ConfigOptions[cfg] = std::move(options);
        }
      }
    }
  }
619

620
  // Uic executable
621
  return GetUicExecutable();
622 623 624 625
}

bool cmQtAutoGenInitializer::InitRcc()
{
626
  return GetRccExecutable();
627 628 629 630 631
}

bool cmQtAutoGenInitializer::InitScanFiles()
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
632

633 634 635 636 637
  // String constants
  std::string const SKIP_AUTOGEN_str = "SKIP_AUTOGEN";
  std::string const SKIP_AUTOMOC_str = "SKIP_AUTOMOC";
  std::string const SKIP_AUTOUIC_str = "SKIP_AUTOUIC";

638
  // Scan through target files
639
  {
640 641 642 643 644 645
    // String constants
    std::string const qrc_str = "qrc";
    std::string const SKIP_AUTORCC_str = "SKIP_AUTORCC";
    std::string const AUTORCC_OPTIONS_str = "AUTORCC_OPTIONS";

    // Scan through target files
646
    std::vector<cmSourceFile*> srcFiles;
647
    this->Target->GetConfigCommonSourceFiles(srcFiles);
648
    for (cmSourceFile* sf : srcFiles) {
649
      if (sf->GetPropertyAsBool(SKIP_AUTOGEN_str)) {
650 651
        continue;
      }
652

653
      // sf->GetExtension() is only valid after sf->GetFullPath() ...
654 655
      std::string const& fPath = sf->GetFullPath();
      std::string const& ext = sf->GetExtension();
656

657
      // Register generated files that will be scanned by moc or uic
658
      if (this->Moc.Enabled || this->Uic.Enabled) {
659
        cmSystemTools::FileFormat const fileType =
660
          cmSystemTools::GetFileFormat(ext);
661 662
        if ((fileType == cmSystemTools::CXX_FILE_FORMAT) ||
            (fileType == cmSystemTools::HEADER_FILE_FORMAT)) {
663
          std::string const absPath = cmSystemTools::GetRealPath(fPath);
664 665 666 667
          if ((this->Moc.Enabled &&
               !sf->GetPropertyAsBool(SKIP_AUTOMOC_str)) ||
              (this->Uic.Enabled &&
               !sf->GetPropertyAsBool(SKIP_AUTOUIC_str))) {
668
            // Register source
669
            const bool generated = sf->GetIsGenerated();
670 671
            if (fileType == cmSystemTools::HEADER_FILE_FORMAT) {
              if (generated) {
672
                this->AutogenTarget.HeadersGenerated.push_back(absPath);
673
              } else {
674
                this->AutogenTarget.Headers.push_back(absPath);
675 676 677
              }
            } else {
              if (generated) {
678
                this->AutogenTarget.SourcesGenerated.push_back(absPath);
679
              } else {
680
                this->AutogenTarget.Sources.push_back(absPath);
681
              }
682 683 684
            }
          }
        }
685 686
      }
      // Register rcc enabled files
687 688 689
      if (this->Rcc.Enabled) {
        if ((ext == qrc_str) && !sf->GetPropertyAsBool(SKIP_AUTORCC_str)) {
          // Register qrc file
690 691 692 693
          Qrc qrc;
          qrc.QrcFile = cmSystemTools::GetRealPath(fPath);
          qrc.QrcName =
            cmSystemTools::GetFilenameWithoutLastExtension(qrc.QrcFile);
694
          qrc.Generated = sf->GetIsGenerated();
695 696
          // RCC options
          {
697
            std::string const opts = sf->GetSafeProperty(AUTORCC_OPTIONS_str);
698
            if (!opts.empty()) {
699
              cmSystemTools::ExpandListArgument(opts, qrc.Options);
700 701
            }
          }
702
          this->Rcc.Qrcs.push_back(std::move(qrc));
703
        }
704 705
      }
    }
706
  }
707 708 709 710 711 712
  // cmGeneratorTarget::GetConfigCommonSourceFiles computes the target's
  // sources meta data cache. Clear it so that OBJECT library targets that
  // are AUTOGEN initialized after this target get their added
  // mocs_compilation.cpp source acknowledged by this target.
  this->Target->ClearSourcesCache();

713 714 715 716
  // Scan through all source files in the makefile to extract moc and uic
  // parameters.  Historically we support non target source file parameters.
  // The reason is that their file names might be discovered from source files
  // at generation time.
717
  if (this->Moc.Enabled || this->Uic.Enabled) {
718 719 720 721 722 723 724 725
    // String constants
    std::string const ui_str = "ui";
    std::string const AUTOUIC_OPTIONS_str = "AUTOUIC_OPTIONS";

    for (cmSourceFile* sf : makefile->GetSourceFiles()) {
      // sf->GetExtension() is only valid after sf->GetFullPath() ...
      // Since we're iterating over source files that might be not in the
      // target we need to check for path errors (not existing files).
726
      std::string pathError;
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750
      std::string const& fullPath = sf->GetFullPath(&pathError);
      if (!pathError.empty() || fullPath.empty()) {
        continue;
      }

      // Check file type
      auto const fileType = cmSystemTools::GetFileFormat(sf->GetExtension());
      bool const isSource = (fileType == cmSystemTools::CXX_FILE_FORMAT) ||
        (fileType == cmSystemTools::HEADER_FILE_FORMAT);
      bool const isUi = (this->Moc.Enabled && sf->GetExtension() == ui_str);

      // Process only certain file types
      if (isSource || isUi) {
        std::string const absFile = cmSystemTools::GetRealPath(fullPath);
        // Acquire file properties
        bool const skipAUTOGEN = sf->GetPropertyAsBool(SKIP_AUTOGEN_str);
        bool const skipMoc = (this->Moc.Enabled && isSource) &&
          (skipAUTOGEN || sf->GetPropertyAsBool(SKIP_AUTOMOC_str));
        bool const skipUic = this->Uic.Enabled &&
          (skipAUTOGEN || sf->GetPropertyAsBool(SKIP_AUTOUIC_str));

        // Register moc and uic skipped file
        if (skipMoc) {
          this->Moc.Skip.insert(absFile);
751
        }
752 753
        if (skipUic) {
          this->Uic.Skip.insert(absFile);
754
        }
755 756 757 758 759 760 761 762 763

        // Check if the .ui file has uic options
        if (isUi && !skipUic) {
          std::string const uicOpts = sf->GetSafeProperty(AUTOUIC_OPTIONS_str);
          if (!uicOpts.empty()) {
            this->Uic.FileFiles.push_back(absFile);
            std::vector<std::string> optsVec;
            cmSystemTools::ExpandListArgument(uicOpts, optsVec);
            this->Uic.FileOptions.push_back(std::move(optsVec));
764
          }
765 766 767
        }
      }
    }
768
  }
769

770 771
  // Process GENERATED sources and headers
  if (this->Moc.Enabled || this->Uic.Enabled) {
772 773
    if (!this->AutogenTarget.SourcesGenerated.empty() ||
        !this->AutogenTarget.HeadersGenerated.empty()) {
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
      // Check status of policy CMP0071
      bool policyAccept = false;
      bool policyWarn = false;
      cmPolicies::PolicyStatus const CMP0071_status =
        makefile->GetPolicyStatus(cmPolicies::CMP0071);
      switch (CMP0071_status) {
        case cmPolicies::WARN:
          policyWarn = true;
          CM_FALLTHROUGH;
        case cmPolicies::OLD:
          // Ignore GENERATED file
          break;
        case cmPolicies::REQUIRED_IF_USED:
        case cmPolicies::REQUIRED_ALWAYS:
        case cmPolicies::NEW:
          // Process GENERATED file
          policyAccept = true;
          break;
792
      }
793 794 795

      if (policyAccept) {
        // Accept GENERATED sources
796 797 798 799
        for (std::string const& absFile :
             this->AutogenTarget.HeadersGenerated) {
          this->AutogenTarget.Headers.push_back(absFile);
          this->AutogenTarget.DependFiles.insert(absFile);
800
        }
801 802 803 804
        for (std::string const& absFile :
             this->AutogenTarget.SourcesGenerated) {
          this->AutogenTarget.Sources.push_back(absFile);
          this->AutogenTarget.DependFiles.insert(absFile);
805
        }
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
      } else {
        if (policyWarn) {
          std::string msg;
          msg += cmPolicies::GetPolicyWarning(cmPolicies::CMP0071);
          msg += "\n";
          std::string tools;
          std::string property;
          if (this->Moc.Enabled && this->Uic.Enabled) {
            tools = "AUTOMOC and AUTOUIC";
            property = "SKIP_AUTOGEN";
          } else if (this->Moc.Enabled) {
            tools = "AUTOMOC";
            property = "SKIP_AUTOMOC";
          } else if (this->Uic.Enabled) {
            tools = "AUTOUIC";
            property = "SKIP_AUTOUIC";
          }
          msg += "For compatibility, CMake is excluding the GENERATED source "
                 "file(s):\n";
825 826
          for (const std::string& absFile :
               this->AutogenTarget.HeadersGenerated) {
827 828
            msg.append("  ").append(Quoted(absFile)).append("\n");
          }
829 830
          for (const std::string& absFile :
               this->AutogenTarget.SourcesGenerated) {
831 832 833 834 835 836 837 838 839 840 841 842
            msg.append("  ").append(Quoted(absFile)).append("\n");
          }
          msg += "from processing by ";
          msg += tools;
          msg +=
            ". If any of the files should be processed, set CMP0071 to NEW. "
            "If any of the files should not be processed, "
            "explicitly exclude them by setting the source file property ";
          msg += property;
          msg += ":\n  set_property(SOURCE file.h PROPERTY ";
          msg += property;
          msg += " ON)\n";
843
          makefile->IssueMessage(MessageType::AUTHOR_WARNING, msg);
844
        }
845
      }
846
    }
847 848 849 850 851 852 853 854
  }

  // Sort headers and sources
  if (this->Moc.Enabled || this->Uic.Enabled) {
    std::sort(this->AutogenTarget.Headers.begin(),
              this->AutogenTarget.Headers.end());
    std::sort(this->AutogenTarget.Sources.begin(),
              this->AutogenTarget.Sources.end());
855
  }
856

857
  // Process qrc files
858
  if (!this->Rcc.Qrcs.empty()) {
Tobias Hunger's avatar
Tobias Hunger committed
859
    const bool modernQt = (this->QtVersion.Major >= 5);
860 861 862
    // Target rcc options
    std::vector<std::string> optionsTarget;
    cmSystemTools::ExpandListArgument(
863
      this->Target->GetSafeProperty("AUTORCC_OPTIONS"), optionsTarget);
864

865
    // Check if file name is unique
866
    for (Qrc& qrc : this->Rcc.Qrcs) {
867
      qrc.Unique = true;
868
      for (Qrc const& qrc2 : this->Rcc.Qrcs) {
869 870
        if ((&qrc != &qrc2) && (qrc.QrcName == qrc2.QrcName)) {
          qrc.Unique = false;
871 872
          break;
        }
873
      }
874
    }
875
    // Path checksum and file names
876
    {
877
      cmFilePathChecksum const fpathCheckSum(makefile);
878
      for (Qrc& qrc : this->Rcc.Qrcs) {
879
        qrc.PathChecksum = fpathCheckSum.getPart(qrc.QrcFile);
880
        // RCC output file name
881
        {
882
          std::string rccFile = this->Dir.Build + "/";
883
          rccFile += qrc.PathChecksum;
884
          rccFile += "/qrc_";
885
          rccFile += qrc.QrcName;
886
          rccFile += ".cpp";
887
          qrc.RccFile = std::move(rccFile);
888 889
        }
        {
890
          std::string base = this->Dir.Info;
891
          base += "/RCC";
892 893 894
          base += qrc.QrcName;
          if (!qrc.Unique) {
            base += qrc.PathChecksum;
895
          }
896 897 898 899

          qrc.LockFile = base;
          qrc.LockFile += ".lock";

900 901
          qrc.InfoFile = base;
          qrc.InfoFile += "Info.cmake";
902

903
          qrc.SettingsFile = base;
904
          qrc.SettingsFile += "Settings.txt";
905 906 907 908 909 910 911

          if (this->MultiConfig) {
            for (std::string const& cfg : this->ConfigsList) {
              qrc.ConfigSettingsFile[cfg] =
                AppendFilenameSuffix(qrc.SettingsFile, "_" + cfg);
            }
          }
912
        }
913 914 915
      }
    }
    // RCC options
916
    for (Qrc& qrc : this->Rcc.Qrcs) {
917 918 919
      // Target options
      std::vector<std::string> opts = optionsTarget;
      // Merge computed "-name XYZ" option
920
      {
921
        std::string name = qrc.QrcName;
922 923
        // Replace '-' with '_'. The former is not valid for symbol names.
        std::replace(name.begin(), name.end(), '-', '_');
924
        if (!qrc.Unique) {
925
          name += "_";
926
          name += qrc.PathChecksum;
927
        }
928 929 930
        std::vector<std::string> nameOpts;
        nameOpts.emplace_back("-name");
        nameOpts.emplace_back(std::move(name));
Tobias Hunger's avatar
Tobias Hunger committed
931
        RccMergeOptions(opts, nameOpts, modernQt);
932
      }
933
      // Merge file option
Tobias Hunger's avatar
Tobias Hunger committed
934
      RccMergeOptions(opts, qrc.Options, modernQt);
935
      qrc.Options = std::move(opts);
936
    }
937
    // RCC resources
938
    for (Qrc& qrc : this->Rcc.Qrcs) {
939 940 941
      if (!qrc.Generated) {
        std::string error;
        if (!RccListInputs(qrc.QrcFile, qrc.Resources, error)) {
942
          cmSystemTools::Error(error);
943
          return false;
944
        }
945
      }
946 947
    }
  }
948

949 950
  return true;
}
951

952 953 954 955 956 957 958
bool cmQtAutoGenInitializer::InitAutogenTarget()
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
  cmLocalGenerator* localGen = this->Target->GetLocalGenerator();
  cmGlobalGenerator* globalGen = localGen->GetGlobalGenerator();

  // Register info file as generated by CMake
959
  makefile->AddCMakeOutputFile(this->AutogenTarget.InfoFile);
960 961 962 963

  // Files provided by the autogen target
  std::vector<std::string> autogenProvides;
  if (this->Moc.Enabled) {
964
    this->AddGeneratedSource(this->Moc.MocsCompilation, GenT::MOC, true);
965
    autogenProvides.push_back(this->Moc.MocsCompilation);
966 967
  }

968 969 970 971 972 973
  // Compose target comment
  std::string autogenComment;
  {
    std::string tools;
    if (this->Moc