cmQtAutoGenInitializer.cxx 56.8 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"
24
#include "cmSourceFileLocationKind.h"
Daniel Pfeifer's avatar
Daniel Pfeifer committed
25
#include "cmSourceGroup.h"
26
#include "cmState.h"
27
#include "cmStateTypes.h"
28 29
#include "cmSystemTools.h"
#include "cmTarget.h"
30
#include "cmake.h"
31
#include "cmsys/FStream.hxx"
32
#include "cmsys/SystemInformation.hxx"
33

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

44 45 46 47 48 49 50 51 52 53 54 55 56 57
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;
}

58
static void AddCleanFile(cmMakefile* makefile, std::string const& fileName)
59 60 61 62 63
{
  makefile->AppendProperty("ADDITIONAL_MAKE_CLEAN_FILES", fileName.c_str(),
                           false);
}

64 65 66 67 68 69
static std::string FileProjectRelativePath(cmMakefile* makefile,
                                           std::string const& fileName)
{
  std::string res;
  {
    std::string pSource = cmSystemTools::RelativePath(
70
      makefile->GetCurrentSourceDirectory(), fileName);
71
    std::string pBinary = cmSystemTools::RelativePath(
72
      makefile->GetCurrentBinaryDirectory(), fileName);
73 74 75 76 77 78 79 80 81 82 83
    if (pSource.size() < pBinary.size()) {
      res = std::move(pSource);
    } else if (pBinary.size() < fileName.size()) {
      res = std::move(pBinary);
    } else {
      res = fileName;
    }
  }
  return res;
}

84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
/* @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;
}

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 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 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
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));
};

225 226 227 228 229 230
cmQtAutoGenInitializer::cmQtAutoGenInitializer(
  cmQtAutoGenGlobalInitializer* globalInitializer, cmGeneratorTarget* target,
  IntegerVersion const& qtVersion, bool mocEnabled, bool uicEnabled,
  bool rccEnabled, bool globalAutogenTarget, bool globalAutoRccTarget)
  : GlobalInitializer(globalInitializer)
  , Target(target)
231
  , QtVersion(qtVersion)
232
{
233
  AutogenTarget.GlobalTarget = globalAutogenTarget;
234 235 236
  Moc.Enabled = mocEnabled;
  Uic.Enabled = uicEnabled;
  Rcc.Enabled = rccEnabled;
237
  Rcc.GlobalTarget = globalAutoRccTarget;
238
}
239

240
bool cmQtAutoGenInitializer::InitCustomTargets()
241 242 243 244
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
  cmLocalGenerator* localGen = this->Target->GetLocalGenerator();
  cmGlobalGenerator* globalGen = localGen->GetGlobalGenerator();
245

246 247 248 249 250 251 252
  // Configurations
  this->MultiConfig = globalGen->IsMultiConfig();
  this->ConfigDefault = makefile->GetConfigurations(this->ConfigsList);
  if (this->ConfigsList.empty()) {
    this->ConfigsList.push_back(this->ConfigDefault);
  }

253
  // Verbosity
254 255 256 257 258
  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
259
      this->Verbosity = cmSystemTools::IsOn(this->Verbosity) ? "1" : "0";
260 261 262
    }
  }

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
  // 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;
    }
278 279
  }

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
  // Check status of policy CMP0071
  {
    cmPolicies::PolicyStatus const CMP0071_status =
      makefile->GetPolicyStatus(cmPolicies::CMP0071);
    switch (CMP0071_status) {
      case cmPolicies::WARN:
        this->CMP0071Warn = 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
        this->CMP0071Accept = true;
        break;
    }
  }

300
  // Common directories
301 302 303
  {
    // Collapsed current binary directory
    std::string const cbd = cmSystemTools::CollapseFullPath(
304
      std::string(), makefile->GetCurrentBinaryDirectory());
305

306 307
    // Info directory
    this->Dir.Info = cbd;
308
    this->Dir.Info += "/CMakeFiles";
309 310 311 312 313 314 315 316 317 318 319 320 321
    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";
322
    }
323 324 325
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Build);
    // Cleanup build directory
    AddCleanFile(makefile, this->Dir.Build);
326 327

    // Working directory
328 329
    this->Dir.Work = cbd;
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Work);
330 331

    // Include directory
332 333
    this->Dir.Include = this->Dir.Build;
    this->Dir.Include += "/include";
334
    if (this->MultiConfig) {
335
      this->Dir.Include += "_$<CONFIG>";
336
    }
337
    // Per config include directories
338 339
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
340 341
        std::string& dir = this->Dir.ConfigInclude[cfg];
        dir = this->Dir.Build;
342 343 344 345
        dir += "/include_";
        dir += cfg;
      }
    }
346
  }
347

348
  // Moc, Uic and _autogen target settings
349
  if (this->MocOrUicEnabled()) {
350 351 352 353
    // Init moc specific settings
    if (this->Moc.Enabled && !InitMoc()) {
      return false;
    }
354

355
    // Init uic specific settings
356 357
    if (this->Uic.Enabled && !InitUic()) {
      return false;
358 359
    }

360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    // 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);
      }
    }

393 394
    // Autogen target: Compute user defined dependencies
    {
395 396 397
      this->AutogenTarget.DependOrigin =
        this->Target->GetPropertyAsBool("AUTOGEN_ORIGIN_DEPENDS");

398 399 400 401 402 403 404 405 406
      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) {
407
            this->AutogenTarget.DependTargets.insert(depTarget);
408
          } else {
409
            this->AutogenTarget.DependFiles.insert(depName);
410 411 412 413 414
          }
        }
      }
    }
  }
415

416 417 418 419 420 421
  // Init rcc specific settings
  if (this->Rcc.Enabled && !InitRcc()) {
    return false;
  }

  // Add autogen include directory to the origin target INCLUDE_DIRECTORIES
422
  if (this->MocOrUicEnabled() || (this->Rcc.Enabled && this->MultiConfig)) {
423
    this->Target->AddIncludeDirectory(this->Dir.Include, true);
424 425 426 427 428 429 430 431
  }

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

  // Create autogen target
432
  if (this->MocOrUicEnabled() && !this->InitAutogenTarget()) {
433 434
    return false;
  }
435

436 437 438 439 440 441 442 443 444 445 446 447 448 449
  // 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
450
  this->Moc.MocsCompilation = this->Dir.Build;
451 452 453 454
  this->Moc.MocsCompilation += "/mocs_compilation.cpp";

  // Moc predefs command
  if (this->Target->GetPropertyAsBool("AUTOMOC_COMPILER_PREDEFINES") &&
455
      (this->QtVersion >= IntegerVersion(5, 8))) {
456 457 458 459 460
    this->Moc.PredefsCmd =
      makefile->GetSafeDefinition("CMAKE_CXX_COMPILER_PREDEFINES_COMMAND");
  }

  // Moc includes
461
  {
462
    bool const appendImplicit = (this->QtVersion.Major >= 5);
463
    auto GetIncludeDirs =
464 465
      [this, localGen,
       appendImplicit](std::string const& cfg) -> std::vector<std::string> {
466 467 468 469
      // 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;
470 471
      localGen->GetIncludeDirectoriesImplicit(dirs, this->Target, "CXX", cfg,
                                              false, appendImplicit);
472
      return dirs;
473 474 475 476 477
    };

    // Default configuration include directories
    this->Moc.Includes = GetIncludeDirs(this->ConfigDefault);
    // Other configuration settings
478
    if (this->MultiConfig) {
479
      for (std::string const& cfg : this->ConfigsList) {
480
        std::vector<std::string> dirs = GetIncludeDirs(cfg);
481 482 483
        if (dirs != this->Moc.Includes) {
          this->Moc.ConfigIncludes[cfg] = std::move(dirs);
        }
484
      }
485
    }
486 487
  }

488 489 490
  // Moc compile definitions
  {
    auto GetCompileDefinitions =
491
      [this, localGen](std::string const& cfg) -> std::set<std::string> {
492
      std::set<std::string> defines;
493
      localGen->GetTargetDefines(this->Target, cfg, "CXX", defines);
494 495 496 497 498 499
#ifdef _WIN32
      if (this->Moc.PredefsCmd.empty()) {
        // Add WIN32 definition if we don't have a moc_predefs.h
        defines.insert("WIN32");
      }
#endif
500
      return defines;
501 502 503 504 505 506 507
    };

    // Default configuration defines
    this->Moc.Defines = GetCompileDefinitions(this->ConfigDefault);
    // Other configuration defines
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
508
        std::set<std::string> defines = GetCompileDefinitions(cfg);
509 510 511 512 513
        if (defines != this->Moc.Defines) {
          this->Moc.ConfigDefines[cfg] = std::move(defines);
        }
      }
    }
514
  }
515 516

  // Moc executable
517 518 519 520 521 522 523 524 525 526 527 528
  {
    if (!this->GetQtExecutable(this->Moc, "moc", false, nullptr)) {
      return false;
    }
    // Let the _autogen target depend on the moc executable
    if (this->Moc.ExecutableTarget != nullptr) {
      this->AutogenTarget.DependTargets.insert(
        this->Moc.ExecutableTarget->Target);
    }
  }

  return true;
529 530 531 532 533 534 535 536 537 538 539 540
}

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);
541
      std::string const& srcDir = makefile->GetCurrentSourceDirectory();
542 543 544 545
      for (std::string& path : this->Uic.SearchPaths) {
        path = cmSystemTools::CollapseFullPath(path, srcDir);
      }
    }
546
  }
547 548
  // Uic target options
  {
549 550
    auto UicGetOpts =
      [this](std::string const& cfg) -> std::vector<std::string> {
551 552
      std::vector<std::string> opts;
      this->Target->GetAutoUicOptions(opts, cfg);
553
      return opts;
554
    };
555

556 557 558 559 560 561
    // Default settings
    this->Uic.Options = UicGetOpts(this->ConfigDefault);

    // Configuration specific settings
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
562
        std::vector<std::string> options = UicGetOpts(cfg);
563 564 565 566 567 568
        if (options != this->Uic.Options) {
          this->Uic.ConfigOptions[cfg] = std::move(options);
        }
      }
    }
  }
569

570
  // Uic executable
571 572 573 574 575 576 577 578 579 580 581 582
  {
    if (!this->GetQtExecutable(this->Uic, "uic", true, nullptr)) {
      return false;
    }
    // Let the _autogen target depend on the uic executable
    if (this->Uic.ExecutableTarget != nullptr) {
      this->AutogenTarget.DependTargets.insert(
        this->Uic.ExecutableTarget->Target);
    }
  }

  return true;
583 584 585 586
}

bool cmQtAutoGenInitializer::InitRcc()
{
587 588 589 590 591 592 593 594 595 596
  // Rcc executable
  {
    std::string stdOut;
    if (!this->GetQtExecutable(this->Rcc, "rcc", false, &stdOut)) {
      return false;
    }
    // Evaluate test output
    if (this->QtVersion.Major == 5 || this->QtVersion.Major == 6) {
      if (stdOut.find("--list") != std::string::npos) {
        this->Rcc.ListOptions.emplace_back("--list");
597
      } else if (stdOut.find("-list") != std::string::npos) {
598 599 600 601 602 603
        this->Rcc.ListOptions.emplace_back("-list");
      }
    }
  }

  return true;
604 605 606 607 608
}

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

610 611 612 613
  // 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";
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
  std::string const SKIP_AUTORCC_str = "SKIP_AUTORCC";
  std::string const AUTOUIC_OPTIONS_str = "AUTOUIC_OPTIONS";
  std::string const AUTORCC_OPTIONS_str = "AUTORCC_OPTIONS";
  std::string const qrc_str = "qrc";
  std::string const ui_str = "ui";

  auto makeMUFile = [&](cmSourceFile* sf, std::string const& fullPath,
                        bool muIt) -> MUFileHandle {
    MUFileHandle muf = cm::make_unique<MUFile>();
    muf->RealPath = cmSystemTools::GetRealPath(fullPath);
    muf->SF = sf;
    muf->Generated = sf->GetIsGenerated();
    bool const skipAutogen = sf->GetPropertyAsBool(SKIP_AUTOGEN_str);
    muf->SkipMoc = this->Moc.Enabled &&
      (skipAutogen || sf->GetPropertyAsBool(SKIP_AUTOMOC_str));
    muf->SkipUic = this->Uic.Enabled &&
      (skipAutogen || sf->GetPropertyAsBool(SKIP_AUTOUIC_str));
    if (muIt) {
      muf->MocIt = this->Moc.Enabled && !muf->SkipMoc;
      muf->UicIt = this->Uic.Enabled && !muf->SkipUic;
    }
    return muf;
  };

  auto addMUFile = [&](MUFileHandle&& muf, bool isHeader) {
    if ((muf->MocIt || muf->UicIt) && muf->Generated) {
      this->AutogenTarget.FilesGenerated.emplace_back(muf.get());
    }
    if (isHeader) {
      this->AutogenTarget.Headers.emplace(muf->SF, std::move(muf));
    } else {
      this->AutogenTarget.Sources.emplace(muf->SF, std::move(muf));
    }
  };
648

649
  // Scan through target files
650
  {
651
    // Scan through target files
652
    std::vector<cmSourceFile*> srcFiles;
653
    this->Target->GetConfigCommonSourceFiles(srcFiles);
654
    for (cmSourceFile* sf : srcFiles) {
655 656 657 658 659 660
      // 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).
      std::string pathError;
      std::string const& fullPath = sf->GetFullPath(&pathError);
      if (!pathError.empty() || fullPath.empty()) {
661 662
        continue;
      }
663
      std::string const& ext = sf->GetExtension();
664

665 666 667 668 669 670 671 672 673 674 675
      // Register files that will be scanned by moc or uic
      if (this->MocOrUicEnabled()) {
        switch (cmSystemTools::GetFileFormat(ext)) {
          case cmSystemTools::HEADER_FILE_FORMAT:
            addMUFile(makeMUFile(sf, fullPath, true), true);
            break;
          case cmSystemTools::CXX_FILE_FORMAT:
            addMUFile(makeMUFile(sf, fullPath, true), false);
            break;
          default:
            break;
676
        }
677
      }
678

679
      // Register rcc enabled files
680
      if (this->Rcc.Enabled) {
681 682
        if ((ext == qrc_str) && !sf->GetPropertyAsBool(SKIP_AUTOGEN_str) &&
            !sf->GetPropertyAsBool(SKIP_AUTORCC_str)) {
683
          // Register qrc file
684
          Qrc qrc;
685
          qrc.QrcFile = cmSystemTools::GetRealPath(fullPath);
686 687
          qrc.QrcName =
            cmSystemTools::GetFilenameWithoutLastExtension(qrc.QrcFile);
688
          qrc.Generated = sf->GetIsGenerated();
689 690
          // RCC options
          {
691
            std::string const opts = sf->GetSafeProperty(AUTORCC_OPTIONS_str);
692
            if (!opts.empty()) {
693
              cmSystemTools::ExpandListArgument(opts, qrc.Options);
694 695
            }
          }
696
          this->Rcc.Qrcs.push_back(std::move(qrc));
697
        }
698 699
      }
    }
700
  }
701 702 703 704 705 706
  // 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();

707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
  // For source files find additional headers and private headers
  if (this->MocOrUicEnabled()) {
    std::vector<MUFileHandle> extraHeaders;
    extraHeaders.reserve(this->AutogenTarget.Sources.size() * 2);
    // Header search suffixes and extensions
    std::array<std::string, 2> const suffixes{ { "", "_p" } };
    auto const& exts = makefile->GetCMakeInstance()->GetHeaderExtensions();
    // Scan through sources
    for (auto const& pair : this->AutogenTarget.Sources) {
      MUFile const& muf = *pair.second;
      if (muf.MocIt || muf.UicIt) {
        // Search for the default header file and a private header
        std::string const& realPath = muf.RealPath;
        std::string basePath = cmQtAutoGen::SubDirPrefix(realPath);
        basePath += cmSystemTools::GetFilenameWithoutLastExtension(realPath);
        for (auto const& suffix : suffixes) {
          std::string const suffixedPath = basePath + suffix;
          for (auto const& ext : exts) {
            std::string fullPath = suffixedPath;
            fullPath += '.';
            fullPath += ext;

            auto constexpr locationKind = cmSourceFileLocationKind::Known;
            cmSourceFile* sf = makefile->GetSource(fullPath, locationKind);
            if (sf != nullptr) {
              // Check if we know about this header already
              if (this->AutogenTarget.Headers.find(sf) !=
                  this->AutogenTarget.Headers.end()) {
                continue;
              }
              // We only accept not-GENERATED files that do exist.
              if (!sf->GetIsGenerated() &&
                  !cmSystemTools::FileExists(fullPath)) {
                continue;
              }
            } else if (cmSystemTools::FileExists(fullPath)) {
              // Create a new source file for the existing file
              sf = makefile->CreateSource(fullPath, false, locationKind);
            }

            if (sf != nullptr) {
              auto eMuf = makeMUFile(sf, fullPath, true);
              // Ony process moc/uic when the parent is processed as well
              if (!muf.MocIt) {
                eMuf->MocIt = false;
              }
              if (!muf.UicIt) {
                eMuf->UicIt = false;
              }
              extraHeaders.emplace_back(std::move(eMuf));
            }
          }
        }
      }
    }
    // Move generated files to main headers list
    for (auto& eMuf : extraHeaders) {
      addMUFile(std::move(eMuf), true);
    }
  }

768 769 770 771
  // 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.
772
  if (this->MocOrUicEnabled()) {
773 774 775 776
    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).
777
      std::string pathError;
778 779 780 781
      std::string const& fullPath = sf->GetFullPath(&pathError);
      if (!pathError.empty() || fullPath.empty()) {
        continue;
      }
782
      std::string const& ext = sf->GetExtension();
783

784 785 786 787 788 789 790 791
      auto const fileFormat = cmSystemTools::GetFileFormat(ext);
      if (fileFormat == cmSystemTools::HEADER_FILE_FORMAT) {
        if (this->AutogenTarget.Headers.find(sf) ==
            this->AutogenTarget.Headers.end()) {
          auto muf = makeMUFile(sf, fullPath, false);
          if (muf->SkipMoc || muf->SkipUic) {
            this->AutogenTarget.Headers.emplace(sf, std::move(muf));
          }
792
        }
793 794 795 796 797 798 799
      } else if (fileFormat == cmSystemTools::CXX_FILE_FORMAT) {
        if (this->AutogenTarget.Sources.find(sf) ==
            this->AutogenTarget.Sources.end()) {
          auto muf = makeMUFile(sf, fullPath, false);
          if (muf->SkipMoc || muf->SkipUic) {
            this->AutogenTarget.Sources.emplace(sf, std::move(muf));
          }
800
        }
801 802 803 804 805 806 807 808
      } else if (this->Uic.Enabled && (ext == ui_str)) {
        // .ui file
        std::string realPath = cmSystemTools::GetRealPath(fullPath);
        bool const skipAutogen = sf->GetPropertyAsBool(SKIP_AUTOGEN_str);
        bool const skipUic =
          (skipAutogen || sf->GetPropertyAsBool(SKIP_AUTOUIC_str));
        if (!skipUic) {
          // Check if the .ui file has uic options
809 810
          std::string const uicOpts = sf->GetSafeProperty(AUTOUIC_OPTIONS_str);
          if (!uicOpts.empty()) {
811
            this->Uic.FileFiles.push_back(std::move(realPath));
812 813 814
            std::vector<std::string> optsVec;
            cmSystemTools::ExpandListArgument(uicOpts, optsVec);
            this->Uic.FileOptions.push_back(std::move(optsVec));
815
          }
816 817 818
        } else {
          // Register skipped .ui file
          this->Uic.SkipUi.insert(std::move(realPath));
819 820 821
        }
      }
    }
822
  }
823

824
  // Process GENERATED sources and headers
825 826 827 828 829
  if (this->MocOrUicEnabled() && !this->AutogenTarget.FilesGenerated.empty()) {
    if (this->CMP0071Accept) {
      // Let the autogen target depend on the GENERATED files
      for (MUFile* muf : this->AutogenTarget.FilesGenerated) {
        this->AutogenTarget.DependFiles.insert(muf->RealPath);
830
      }
831 832 833 834 835 836 837 838 839 840 841
    } else if (this->CMP0071Warn) {
      std::string msg;
      msg += cmPolicies::GetPolicyWarning(cmPolicies::CMP0071);
      msg += '\n';
      std::string property;
      if (this->Moc.Enabled && this->Uic.Enabled) {
        property = "SKIP_AUTOGEN";
      } else if (this->Moc.Enabled) {
        property = "SKIP_AUTOMOC";
      } else if (this->Uic.Enabled) {
        property = "SKIP_AUTOUIC";
842
      }
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
      msg += "For compatibility, CMake is excluding the GENERATED source "
             "file(s):\n";
      for (MUFile* muf : this->AutogenTarget.FilesGenerated) {
        msg += "  ";
        msg += Quoted(muf->RealPath);
        msg += '\n';
      }
      msg += "from processing by ";
      msg += cmQtAutoGen::Tools(this->Moc.Enabled, this->Uic.Enabled, false);
      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";
      makefile->IssueMessage(MessageType::AUTHOR_WARNING, msg);
860
    }
861 862
  }

863
  // Process qrc files
864
  if (!this->Rcc.Qrcs.empty()) {
Tobias Hunger's avatar
Tobias Hunger committed
865
    const bool modernQt = (this->QtVersion.Major >= 5);
866 867 868
    // Target rcc options
    std::vector<std::string> optionsTarget;
    cmSystemTools::ExpandListArgument(
869
      this->Target->GetSafeProperty("AUTORCC_OPTIONS"), optionsTarget);
870

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

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

906 907
          qrc.InfoFile = base;
          qrc.InfoFile += "Info.cmake";
908

909
          qrc.SettingsFile = base;
910
          qrc.SettingsFile += "Settings.txt";
911 912 913 914 915 916 917

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

955 956
  return true;
}
957

958 959 960 961 962 963 964
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
965
  makefile->AddCMakeOutputFile(this->AutogenTarget.InfoFile);
966 967 968 969

  // Files provided by the autogen target
  std::vector<std::string> autogenProvides;
  if (this->Moc.Enabled) {
970
    this->AddGeneratedSource(this->Moc.MocsCompilation, this->Moc, true);
971
    autogenProvides.push_back(this->Moc.MocsCompilation);
972 973
  }

974 975 976 977 978 979
  // Compose target comment
  std::string autogenComment;
  {
    std::string tools;
    if (this->Moc.Enabled) {
      tools += "MOC";
980
    }
981 982 983
    if (this->Uic.Enabled) {
      if (!tools.empty()) {
        tools += " and ";
984
      }
985
      tools += "UIC";
986
    }
987 988 989 990 991
    autogenComment = "Automatic ";
    autogenComment += tools;
    autogenComment += " for target ";
    autogenComment += this->Target->GetName();
  }
992

993 994 995 996 997 998 999
  // Compose command lines
  cmCustomCommandLines commandLines;
  {
    cmCustomCommandLine currentLine;
    currentLine.push_back(cmSystemTools::GetCMakeCommand());
    currentLine.push_back("-E");
    currentLine.push_back("cmake_autogen");
1000
    currentLine.push_back(this->AutogenTarget.InfoFile);
1001 1002 1003
    currentLine.push_back("$<CONFIGURATION>");
    commandLines.push_back(std::move(currentLine));
  }
1004

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
  // Use PRE_BUILD on demand
  bool usePRE_BUILD = false;
  if (globalGen->GetName().find("Visual Studio") != std::string::npos) {
    // Under VS use a PRE_BUILD event instead of a separate target to
    // reduce the number of targets loaded into the IDE.
    // This also works around a VS 11 bug that may skip updating the target:
    //  https://connect.microsoft.com/VisualStudio/feedback/details/769495
    usePRE_BUILD = true;
  }
  // Disable PRE_BUILD in some cases
  if (usePRE_BUILD) {
    // Cannot use PRE_BUILD with file depends
1017
    if (!this->AutogenTarget.DependFiles.empty()) {
1018
      usePRE_BUILD = false;