cmQtAutoGenInitializer.cxx 56.5 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 "cmFilePathChecksum.h"
11
#include "cmGeneratorExpression.h"
12
#include "cmGeneratorTarget.h"
13
#include "cmGlobalGenerator.h"
14
#include "cmLinkItem.h"
15
#include "cmListFileCache.h"
16 17
#include "cmLocalGenerator.h"
#include "cmMakefile.h"
18
#include "cmMessageType.h"
19
#include "cmOutputConverter.h"
20
#include "cmPolicies.h"
21
#include "cmSourceFile.h"
22
#include "cmSourceFileLocationKind.h"
Daniel Pfeifer's avatar
Daniel Pfeifer committed
23
#include "cmSourceGroup.h"
24
#include "cmState.h"
25
#include "cmStateTypes.h"
26 27
#include "cmSystemTools.h"
#include "cmTarget.h"
28
#include "cmake.h"
29
#include "cmsys/SystemInformation.hxx"
30

31
#include <algorithm>
32
#include <array>
33
#include <deque>
34 35 36
#include <map>
#include <set>
#include <string>
37
#include <unordered_set>
38 39 40
#include <utility>
#include <vector>

41 42
#include "cm_memory.hxx"

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

57 58 59 60 61 62
static std::string FileProjectRelativePath(cmMakefile* makefile,
                                           std::string const& fileName)
{
  std::string res;
  {
    std::string pSource = cmSystemTools::RelativePath(
63
      makefile->GetCurrentSourceDirectory(), fileName);
64
    std::string pBinary = cmSystemTools::RelativePath(
65
      makefile->GetCurrentBinaryDirectory(), fileName);
66 67 68 69 70 71 72 73 74 75 76
    if (pSource.size() < pBinary.size()) {
      res = std::move(pSource);
    } else if (pBinary.size() < fileName.size()) {
      res = std::move(pBinary);
    } else {
      res = fileName;
    }
  }
  return res;
}

77 78
/**
 * Tests if targetDepend is a STATIC_LIBRARY and if any of its
79 80 81 82 83 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
 * 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;
}

122 123 124 125 126 127 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
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));
};

219 220 221 222 223 224
cmQtAutoGenInitializer::cmQtAutoGenInitializer(
  cmQtAutoGenGlobalInitializer* globalInitializer, cmGeneratorTarget* target,
  IntegerVersion const& qtVersion, bool mocEnabled, bool uicEnabled,
  bool rccEnabled, bool globalAutogenTarget, bool globalAutoRccTarget)
  : GlobalInitializer(globalInitializer)
  , Target(target)
225
  , QtVersion(qtVersion)
226
{
227
  AutogenTarget.GlobalTarget = globalAutogenTarget;
228 229 230
  Moc.Enabled = mocEnabled;
  Uic.Enabled = uicEnabled;
  Rcc.Enabled = rccEnabled;
231
  Rcc.GlobalTarget = globalAutoRccTarget;
232
}
233

234
bool cmQtAutoGenInitializer::InitCustomTargets()
235 236 237 238
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
  cmLocalGenerator* localGen = this->Target->GetLocalGenerator();
  cmGlobalGenerator* globalGen = localGen->GetGlobalGenerator();
239

240 241 242 243 244 245 246
  // Configurations
  this->MultiConfig = globalGen->IsMultiConfig();
  this->ConfigDefault = makefile->GetConfigurations(this->ConfigsList);
  if (this->ConfigsList.empty()) {
    this->ConfigsList.push_back(this->ConfigDefault);
  }

247
  // Verbosity
248 249 250 251 252
  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
253
      this->Verbosity = cmSystemTools::IsOn(this->Verbosity) ? "1" : "0";
254 255 256
    }
  }

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
  // 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;
    }
272 273
  }

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  // 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;
    }
  }

294
  // Common directories
295 296 297
  {
    // Collapsed current binary directory
    std::string const cbd = cmSystemTools::CollapseFullPath(
298
      std::string(), makefile->GetCurrentBinaryDirectory());
299

300 301
    // Info directory
    this->Dir.Info = cbd;
302
    this->Dir.Info += "/CMakeFiles";
303 304 305 306 307 308 309 310 311 312 313 314 315
    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";
316
    }
317 318
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Build);
    // Cleanup build directory
319
    this->AddCleanFile(this->Dir.Build);
320 321

    // Working directory
322 323
    this->Dir.Work = cbd;
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Work);
324 325

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

342
  // Moc, Uic and _autogen target settings
343
  if (this->MocOrUicEnabled()) {
344 345 346 347
    // Init moc specific settings
    if (this->Moc.Enabled && !InitMoc()) {
      return false;
    }
348

349
    // Init uic specific settings
350 351
    if (this->Uic.Enabled && !InitUic()) {
      return false;
352 353
    }

354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    // 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);
380
          this->AddCleanFile(filename);
381 382
        }
      } else {
383
        this->AddCleanFile(this->AutogenTarget.SettingsFile);
384
      }
385 386 387

      this->AutogenTarget.ParseCacheFile = this->Dir.Info;
      this->AutogenTarget.ParseCacheFile += "/ParseCache.txt";
388
      this->AddCleanFile(this->AutogenTarget.ParseCacheFile);
389 390
    }

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

396 397 398 399 400 401 402 403 404
      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) {
405
            this->AutogenTarget.DependTargets.insert(depTarget);
406
          } else {
407
            this->AutogenTarget.DependFiles.insert(depName);
408 409 410 411
          }
        }
      }
    }
412 413 414 415 416 417 418 419 420 421 422 423 424

    // CMAKE_AUTOMOC_RELAXED_MODE deprecation warning
    if (this->Moc.Enabled) {
      if (cmSystemTools::IsOn(
            makefile->GetDefinition("CMAKE_AUTOMOC_RELAXED_MODE"))) {
        std::string msg = "AUTOMOC: CMAKE_AUTOMOC_RELAXED_MODE is "
                          "deprecated an will be removed in the future.  ";
        msg += "Consider disabling it and converting the target ";
        msg += this->Target->GetName();
        msg += " to regular mode.";
        makefile->IssueMessage(MessageType::AUTHOR_WARNING, msg);
      }
    }
425
  }
426

427 428 429 430 431 432
  // Init rcc specific settings
  if (this->Rcc.Enabled && !InitRcc()) {
    return false;
  }

  // Add autogen include directory to the origin target INCLUDE_DIRECTORIES
433
  if (this->MocOrUicEnabled() || (this->Rcc.Enabled && this->MultiConfig)) {
434
    this->Target->AddIncludeDirectory(this->Dir.Include, true);
435 436 437 438 439 440 441 442
  }

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

  // Create autogen target
443
  if (this->MocOrUicEnabled() && !this->InitAutogenTarget()) {
444 445
    return false;
  }
446

447 448 449 450 451 452 453 454 455 456 457 458 459 460
  // 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
461
  this->Moc.MocsCompilation = this->Dir.Build;
462 463 464 465
  this->Moc.MocsCompilation += "/mocs_compilation.cpp";

  // Moc predefs command
  if (this->Target->GetPropertyAsBool("AUTOMOC_COMPILER_PREDEFINES") &&
466
      (this->QtVersion >= IntegerVersion(5, 8))) {
467 468 469 470 471
    this->Moc.PredefsCmd =
      makefile->GetSafeDefinition("CMAKE_CXX_COMPILER_PREDEFINES_COMMAND");
  }

  // Moc includes
472
  {
473
    bool const appendImplicit = (this->QtVersion.Major >= 5);
474
    auto GetIncludeDirs =
475 476
      [this, localGen,
       appendImplicit](std::string const& cfg) -> std::vector<std::string> {
477 478 479 480
      // 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;
481 482
      localGen->GetIncludeDirectoriesImplicit(dirs, this->Target, "CXX", cfg,
                                              false, appendImplicit);
483
      return dirs;
484 485 486 487 488
    };

    // Default configuration include directories
    this->Moc.Includes = GetIncludeDirs(this->ConfigDefault);
    // Other configuration settings
489
    if (this->MultiConfig) {
490
      for (std::string const& cfg : this->ConfigsList) {
491
        std::vector<std::string> dirs = GetIncludeDirs(cfg);
492 493 494
        if (dirs != this->Moc.Includes) {
          this->Moc.ConfigIncludes[cfg] = std::move(dirs);
        }
495
      }
496
    }
497 498
  }

499 500 501
  // Moc compile definitions
  {
    auto GetCompileDefinitions =
502
      [this, localGen](std::string const& cfg) -> std::set<std::string> {
503
      std::set<std::string> defines;
504
      localGen->GetTargetDefines(this->Target, cfg, "CXX", defines);
505 506 507 508 509 510
#ifdef _WIN32
      if (this->Moc.PredefsCmd.empty()) {
        // Add WIN32 definition if we don't have a moc_predefs.h
        defines.insert("WIN32");
      }
#endif
511
      return defines;
512 513 514 515 516 517 518
    };

    // Default configuration defines
    this->Moc.Defines = GetCompileDefinitions(this->ConfigDefault);
    // Other configuration defines
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
519
        std::set<std::string> defines = GetCompileDefinitions(cfg);
520 521 522 523 524
        if (defines != this->Moc.Defines) {
          this->Moc.ConfigDefines[cfg] = std::move(defines);
        }
      }
    }
525
  }
526 527

  // Moc executable
528
  {
529
    if (!this->GetQtExecutable(this->Moc, "moc", false)) {
530 531 532 533 534 535 536 537 538 539
      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;
540 541 542 543 544 545 546 547 548 549 550 551
}

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);
552
      std::string const& srcDir = makefile->GetCurrentSourceDirectory();
553 554 555 556
      for (std::string& path : this->Uic.SearchPaths) {
        path = cmSystemTools::CollapseFullPath(path, srcDir);
      }
    }
557
  }
558 559
  // Uic target options
  {
560 561
    auto UicGetOpts =
      [this](std::string const& cfg) -> std::vector<std::string> {
562 563
      std::vector<std::string> opts;
      this->Target->GetAutoUicOptions(opts, cfg);
564
      return opts;
565
    };
566

567 568 569 570 571 572
    // Default settings
    this->Uic.Options = UicGetOpts(this->ConfigDefault);

    // Configuration specific settings
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
573
        std::vector<std::string> options = UicGetOpts(cfg);
574 575 576 577 578 579
        if (options != this->Uic.Options) {
          this->Uic.ConfigOptions[cfg] = std::move(options);
        }
      }
    }
  }
580

581
  // Uic executable
582
  {
583
    if (!this->GetQtExecutable(this->Uic, "uic", true)) {
584 585 586 587 588 589 590 591 592 593
      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;
594 595 596 597
}

bool cmQtAutoGenInitializer::InitRcc()
{
598 599
  // Rcc executable
  {
600
    if (!this->GetQtExecutable(this->Rcc, "rcc", false)) {
601 602
      return false;
    }
603 604 605 606 607 608 609 610 611 612
    // Evaluate test output on demand
    CompilerFeatures& features = *this->Rcc.ExecutableFeatures;
    if (!features.Evaluated) {
      // Look for list options
      if (this->QtVersion.Major == 5 || this->QtVersion.Major == 6) {
        if (features.HelpOutput.find("--list") != std::string::npos) {
          features.ListOptions.emplace_back("--list");
        } else if (features.HelpOutput.find("-list") != std::string::npos) {
          features.ListOptions.emplace_back("-list");
        }
613
      }
614 615
      // Evaluation finished
      features.Evaluated = true;
616 617 618 619
    }
  }

  return true;
620 621 622 623 624
}

bool cmQtAutoGenInitializer::InitScanFiles()
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
625
  cmake const* cm = makefile->GetCMakeInstance();
626
  auto const& kw = this->GlobalInitializer->kw();
627

628 629
  auto makeMUFile = [this, &kw](cmSourceFile* sf, std::string const& fullPath,
                                bool muIt) -> MUFileHandle {
630 631 632 633
    MUFileHandle muf = cm::make_unique<MUFile>();
    muf->RealPath = cmSystemTools::GetRealPath(fullPath);
    muf->SF = sf;
    muf->Generated = sf->GetIsGenerated();
634
    bool const skipAutogen = sf->GetPropertyAsBool(kw.SKIP_AUTOGEN);
635
    muf->SkipMoc = this->Moc.Enabled &&
636
      (skipAutogen || sf->GetPropertyAsBool(kw.SKIP_AUTOMOC));
637
    muf->SkipUic = this->Uic.Enabled &&
638
      (skipAutogen || sf->GetPropertyAsBool(kw.SKIP_AUTOUIC));
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
    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));
    }
  };
656

657
  // Scan through target files
658
  {
659
    // Scan through target files
660
    std::vector<cmSourceFile*> srcFiles;
661
    this->Target->GetConfigCommonSourceFiles(srcFiles);
662
    for (cmSourceFile* sf : srcFiles) {
663 664 665 666 667 668
      // 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()) {
669 670
        continue;
      }
671 672
      std::string const& extLower =
        cmSystemTools::LowerCase(sf->GetExtension());
673

674 675
      // Register files that will be scanned by moc or uic
      if (this->MocOrUicEnabled()) {
676 677 678 679
        if (cm->IsHeaderExtension(extLower)) {
          addMUFile(makeMUFile(sf, fullPath, true), true);
        } else if (cm->IsSourceExtension(extLower)) {
          addMUFile(makeMUFile(sf, fullPath, true), false);
680
        }
681
      }
682

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

711 712 713 714 715 716
  // 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" } };
717
    auto const& exts = cm->GetHeaderExtensions();
718 719 720 721 722
    // 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
723 724 725
        std::string const& srcPath = muf.SF->GetFullPath();
        std::string basePath = cmQtAutoGen::SubDirPrefix(srcPath);
        basePath += cmSystemTools::GetFilenameWithoutLastExtension(srcPath);
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 768 769 770 771
        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);
    }
  }

772 773 774 775
  // 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.
776
  if (this->MocOrUicEnabled()) {
777 778 779 780
    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).
781
      std::string pathError;
782 783 784 785
      std::string const& fullPath = sf->GetFullPath(&pathError);
      if (!pathError.empty() || fullPath.empty()) {
        continue;
      }
786 787
      std::string const& extLower =
        cmSystemTools::LowerCase(sf->GetExtension());
788

789
      if (cm->IsHeaderExtension(extLower)) {
790 791 792 793 794 795
        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));
          }
796
        }
797
      } else if (cm->IsSourceExtension(extLower)) {
798 799 800 801 802 803
        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));
          }
804
        }
805
      } else if (this->Uic.Enabled && (extLower == kw.ui)) {
806 807
        // .ui file
        std::string realPath = cmSystemTools::GetRealPath(fullPath);
808
        bool const skipAutogen = sf->GetPropertyAsBool(kw.SKIP_AUTOGEN);
809
        bool const skipUic =
810
          (skipAutogen || sf->GetPropertyAsBool(kw.SKIP_AUTOUIC));
811 812
        if (!skipUic) {
          // Check if the .ui file has uic options
813
          std::string const uicOpts = sf->GetSafeProperty(kw.AUTOUIC_OPTIONS);
814
          if (!uicOpts.empty()) {
815
            this->Uic.FileFiles.push_back(std::move(realPath));
816 817 818
            std::vector<std::string> optsVec;
            cmSystemTools::ExpandListArgument(uicOpts, optsVec);
            this->Uic.FileOptions.push_back(std::move(optsVec));
819
          }
820 821 822
        } else {
          // Register skipped .ui file
          this->Uic.SkipUi.insert(std::move(realPath));
823 824 825
        }
      }
    }
826
  }
827

828
  // Process GENERATED sources and headers
829 830 831 832 833
  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);
834
      }
835 836 837 838 839 840
    } else if (this->CMP0071Warn) {
      std::string msg;
      msg += cmPolicies::GetPolicyWarning(cmPolicies::CMP0071);
      msg += '\n';
      std::string property;
      if (this->Moc.Enabled && this->Uic.Enabled) {
841
        property = kw.SKIP_AUTOGEN;
842
      } else if (this->Moc.Enabled) {
843
        property = kw.SKIP_AUTOMOC;
844
      } else if (this->Uic.Enabled) {
845
        property = kw.SKIP_AUTOUIC;
846
      }
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
      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);
864
    }
865 866
  }

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

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

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

910 911
          qrc.InfoFile = base;
          qrc.InfoFile += "Info.cmake";
912

913
          qrc.SettingsFile = base;
914
          qrc.SettingsFile += "Settings.txt";
915 916 917 918 919 920 921

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