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

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

75 76
/**
 * Tests if targetDepend is a STATIC_LIBRARY and if any of its
77 78 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
 * 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;
}

120 121 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
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));
};

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

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

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

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

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

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

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

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

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

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

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

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

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
    // 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);
378
          this->AddCleanFile(filename);
379 380
        }
      } else {
381
        this->AddCleanFile(this->AutogenTarget.SettingsFile);
382
      }
383 384 385

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

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

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

412 413 414 415 416 417
  // Init rcc specific settings
  if (this->Rcc.Enabled && !InitRcc()) {
    return false;
  }

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

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

  // Create autogen target
428
  if (this->MocOrUicEnabled() && !this->InitAutogenTarget()) {
429 430
    return false;
  }
431

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

  // Moc predefs command
  if (this->Target->GetPropertyAsBool("AUTOMOC_COMPILER_PREDEFINES") &&
451
      (this->QtVersion >= IntegerVersion(5, 8))) {
452 453 454 455 456
    this->Moc.PredefsCmd =
      makefile->GetSafeDefinition("CMAKE_CXX_COMPILER_PREDEFINES_COMMAND");
  }

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

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

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

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

  // Moc executable
513 514 515 516 517 518 519 520 521 522 523 524
  {
    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;
525 526 527 528 529 530 531 532 533 534 535 536
}

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

552 553 554 555 556 557
    // Default settings
    this->Uic.Options = UicGetOpts(this->ConfigDefault);

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

566
  // Uic executable
567 568 569 570 571 572 573 574 575 576 577 578
  {
    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;
579 580 581 582
}

bool cmQtAutoGenInitializer::InitRcc()
{
583 584 585 586 587 588 589 590 591 592
  // 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");
593
      } else if (stdOut.find("-list") != std::string::npos) {
594 595 596 597 598 599
        this->Rcc.ListOptions.emplace_back("-list");
      }
    }
  }

  return true;
600 601 602 603 604
}

bool cmQtAutoGenInitializer::InitScanFiles()
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
605
  auto const& kw = this->GlobalInitializer->kw();
606

607 608
  auto makeMUFile = [this, &kw](cmSourceFile* sf, std::string const& fullPath,
                                bool muIt) -> MUFileHandle {
609 610 611 612
    MUFileHandle muf = cm::make_unique<MUFile>();
    muf->RealPath = cmSystemTools::GetRealPath(fullPath);
    muf->SF = sf;
    muf->Generated = sf->GetIsGenerated();
613
    bool const skipAutogen = sf->GetPropertyAsBool(kw.SKIP_AUTOGEN);
614
    muf->SkipMoc = this->Moc.Enabled &&
615
      (skipAutogen || sf->GetPropertyAsBool(kw.SKIP_AUTOMOC));
616
    muf->SkipUic = this->Uic.Enabled &&
617
      (skipAutogen || sf->GetPropertyAsBool(kw.SKIP_AUTOUIC));
618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
    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));
    }
  };
635

636
  // Scan through target files
637
  {
638
    // Scan through target files
639
    std::vector<cmSourceFile*> srcFiles;
640
    this->Target->GetConfigCommonSourceFiles(srcFiles);
641
    for (cmSourceFile* sf : srcFiles) {
642 643 644 645 646 647
      // 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()) {
648 649
        continue;
      }
650
      std::string const& ext = sf->GetExtension();
651

652 653 654 655 656 657 658 659 660 661 662
      // 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;
663
        }
664
      }
665

666
      // Register rcc enabled files
667
      if (this->Rcc.Enabled) {
668 669
        if ((ext == kw.qrc) && !sf->GetPropertyAsBool(kw.SKIP_AUTOGEN) &&
            !sf->GetPropertyAsBool(kw.SKIP_AUTORCC)) {
670
          // Register qrc file
671
          Qrc qrc;
672
          qrc.QrcFile = cmSystemTools::GetRealPath(fullPath);
673 674
          qrc.QrcName =
            cmSystemTools::GetFilenameWithoutLastExtension(qrc.QrcFile);
675
          qrc.Generated = sf->GetIsGenerated();
676 677
          // RCC options
          {
678
            std::string const opts = sf->GetSafeProperty(kw.AUTORCC_OPTIONS);
679
            if (!opts.empty()) {
680
              cmSystemTools::ExpandListArgument(opts, qrc.Options);
681 682
            }
          }
683
          this->Rcc.Qrcs.push_back(std::move(qrc));
684
        }
685 686
      }
    }
687
  }
688 689 690 691 692 693
  // 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();

694 695 696 697 698 699 700 701 702 703 704 705 706 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
  // 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);
    }
  }

755 756 757 758
  // 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.
759
  if (this->MocOrUicEnabled()) {
760 761 762 763
    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).
764
      std::string pathError;
765 766 767 768
      std::string const& fullPath = sf->GetFullPath(&pathError);
      if (!pathError.empty() || fullPath.empty()) {
        continue;
      }
769
      std::string const& ext = sf->GetExtension();
770

771 772 773 774 775 776 777 778
      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));
          }
779
        }
780 781 782 783 784 785 786
      } 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));
          }
787
        }
788
      } else if (this->Uic.Enabled && (ext == kw.ui)) {
789 790
        // .ui file
        std::string realPath = cmSystemTools::GetRealPath(fullPath);
791
        bool const skipAutogen = sf->GetPropertyAsBool(kw.SKIP_AUTOGEN);
792
        bool const skipUic =
793
          (skipAutogen || sf->GetPropertyAsBool(kw.SKIP_AUTOUIC));
794 795
        if (!skipUic) {
          // Check if the .ui file has uic options
796
          std::string const uicOpts = sf->GetSafeProperty(kw.AUTOUIC_OPTIONS);
797
          if (!uicOpts.empty()) {
798
            this->Uic.FileFiles.push_back(std::move(realPath));
799 800 801
            std::vector<std::string> optsVec;
            cmSystemTools::ExpandListArgument(uicOpts, optsVec);
            this->Uic.FileOptions.push_back(std::move(optsVec));
802
          }
803 804 805
        } else {
          // Register skipped .ui file
          this->Uic.SkipUi.insert(std::move(realPath));
806 807 808
        }
      }
    }
809
  }
810

811
  // Process GENERATED sources and headers
812 813 814 815 816
  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);
817
      }
818 819 820 821 822 823
    } else if (this->CMP0071Warn) {
      std::string msg;
      msg += cmPolicies::GetPolicyWarning(cmPolicies::CMP0071);
      msg += '\n';
      std::string property;
      if (this->Moc.Enabled && this->Uic.Enabled) {
824
        property = kw.SKIP_AUTOGEN;
825
      } else if (this->Moc.Enabled) {
826
        property = kw.SKIP_AUTOMOC;
827
      } else if (this->Uic.Enabled) {
828
        property = kw.SKIP_AUTOUIC;
829
      }
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
      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);
847
    }
848 849
  }

850
  // Process qrc files
851
  if (!this->Rcc.Qrcs.empty()) {
Tobias Hunger's avatar
Tobias Hunger committed
852
    const bool modernQt = (this->QtVersion.Major >= 5);
853 854 855
    // Target rcc options
    std::vector<std::string> optionsTarget;
    cmSystemTools::ExpandListArgument(
856
      this->Target->GetSafeProperty(kw.AUTORCC_OPTIONS), optionsTarget);
857

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

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

893 894
          qrc.InfoFile = base;
          qrc.InfoFile += "Info.cmake";
895

896
          qrc.SettingsFile = base;
897
          qrc.SettingsFile += "Settings.txt";
898 899 900 901 902 903 904

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

943 944
  return true;
}
945

946 947 948 949 950 951 952
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
953
  makefile->AddCMakeOutputFile(this->AutogenTarget.InfoFile);
954 955 956 957

  // Files provided by the autogen target
  std::vector<std::string> autogenProvides;
  if (this->Moc.Enabled) {
958
    this->AddGeneratedSource(this->Moc.MocsCompilation, this->Moc, true);
959
    autogenProvides.push_back(this->Moc.MocsCompilation);
960 961
  }

962 963 964 965 966 967
  // Compose target comment
  std::string autogenComment;
  {
    std::string tools;
    if (this->Moc.Enabled) {
      tools += "MOC";
968
    }
969 970 971
    if (this->Uic.Enabled) {
      if (!tools.empty()) {
        tools += " and ";
972
      }
973
      tools += "UIC";