cmQtAutoGenInitializer.cxx 55.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 "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
static void AddCleanFile(cmMakefile* makefile, std::string const& fileName)
56 57 58 59 60
{
  makefile->AppendProperty("ADDITIONAL_MAKE_CLEAN_FILES", fileName.c_str(),
                           false);
}

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

81 82
/**
 * Tests if targetDepend is a STATIC_LIBRARY and if any of its
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 122 123 124 125
 * 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;
}

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 219 220 221 222
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));
};

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

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

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

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

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

278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  // 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;
    }
  }

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

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

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

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

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

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

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
    // 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);
      }
389 390 391 392

      this->AutogenTarget.ParseCacheFile = this->Dir.Info;
      this->AutogenTarget.ParseCacheFile += "/ParseCache.txt";
      AddCleanFile(makefile, this->AutogenTarget.ParseCacheFile);
393 394
    }

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

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

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

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

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

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

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

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

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

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

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

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

  // Moc executable
519 520 521 522 523 524 525 526 527 528 529 530
  {
    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;
531 532 533 534 535 536 537 538 539 540 541 542
}

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

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

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

572
  // Uic executable
573 574 575 576 577 578 579 580 581 582 583 584
  {
    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;
585 586 587 588
}

bool cmQtAutoGenInitializer::InitRcc()
{
589 590 591 592 593 594 595 596 597 598
  // 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");
599
      } else if (stdOut.find("-list") != std::string::npos) {
600 601 602 603 604 605
        this->Rcc.ListOptions.emplace_back("-list");
      }
    }
  }

  return true;
606 607 608 609 610
}

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

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

642
  // Scan through target files
643
  {
644
    // Scan through target files
645
    std::vector<cmSourceFile*> srcFiles;
646
    this->Target->GetConfigCommonSourceFiles(srcFiles);
647
    for (cmSourceFile* sf : srcFiles) {
648 649 650 651 652 653
      // 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()) {
654 655
        continue;
      }
656
      std::string const& ext = sf->GetExtension();
657

658 659 660 661 662 663 664 665 666 667 668
      // 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;
669
        }
670
      }
671

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

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 755 756 757 758 759 760
  // 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);
    }
  }

761 762 763 764
  // 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.
765
  if (this->MocOrUicEnabled()) {
766 767 768 769
    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).
770
      std::string pathError;
771 772 773 774
      std::string const& fullPath = sf->GetFullPath(&pathError);
      if (!pathError.empty() || fullPath.empty()) {
        continue;
      }
775
      std::string const& ext = sf->GetExtension();
776

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

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

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

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

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

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

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

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

949 950
  return true;
}
951

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

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

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

968 969 970 971 972 973
  // Compose target comment
  std::string autogenComment;
  {
    std::string tools;
    if (this->Moc.Enabled) {
      tools += "MOC";
974
    }
975 976 977
    if (this->Uic.Enabled) {
      if (!tools.empty()) {
        tools += " and ";
978
      }
979
      tools += "UIC";
980
    }
981 982 983