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

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

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

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

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

108
static void AddCleanFile(cmMakefile* makefile, std::string const& fileName)
109
110
111
112
113
{
  makefile->AppendProperty("ADDITIONAL_MAKE_CLEAN_FILES", fileName.c_str(),
                           false);
}

114
115
116
117
118
119
static std::string FileProjectRelativePath(cmMakefile* makefile,
                                           std::string const& fileName)
{
  std::string res;
  {
    std::string pSource = cmSystemTools::RelativePath(
120
      makefile->GetCurrentSourceDirectory(), fileName);
121
    std::string pBinary = cmSystemTools::RelativePath(
122
      makefile->GetCurrentBinaryDirectory(), fileName);
123
124
125
126
127
128
129
130
131
132
133
    if (pSource.size() < pBinary.size()) {
      res = std::move(pSource);
    } else if (pBinary.size() < fileName.size()) {
      res = std::move(pBinary);
    } else {
      res = fileName;
    }
  }
  return res;
}

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
/* @brief Tests if targetDepend is a STATIC_LIBRARY and if any of its
 * recursive STATIC_LIBRARY dependencies depends on targetOrigin
 * (STATIC_LIBRARY cycle).
 */
static bool StaticLibraryCycle(cmGeneratorTarget const* targetOrigin,
                               cmGeneratorTarget const* targetDepend,
                               std::string const& config)
{
  bool cycle = false;
  if ((targetOrigin->GetType() == cmStateEnums::STATIC_LIBRARY) &&
      (targetDepend->GetType() == cmStateEnums::STATIC_LIBRARY)) {
    std::set<cmGeneratorTarget const*> knownLibs;
    std::deque<cmGeneratorTarget const*> testLibs;

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

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

178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
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));
};

275
276
277
278
279
280
cmQtAutoGenInitializer::cmQtAutoGenInitializer(
  cmQtAutoGenGlobalInitializer* globalInitializer, cmGeneratorTarget* target,
  IntegerVersion const& qtVersion, bool mocEnabled, bool uicEnabled,
  bool rccEnabled, bool globalAutogenTarget, bool globalAutoRccTarget)
  : GlobalInitializer(globalInitializer)
  , Target(target)
281
  , QtVersion(qtVersion)
282
{
283
  AutogenTarget.GlobalTarget = globalAutogenTarget;
284
285
286
  Moc.Enabled = mocEnabled;
  Uic.Enabled = uicEnabled;
  Rcc.Enabled = rccEnabled;
287
  Rcc.GlobalTarget = globalAutoRccTarget;
288
}
289

290
bool cmQtAutoGenInitializer::InitCustomTargets()
291
292
293
294
{
  cmMakefile* makefile = this->Target->Target->GetMakefile();
  cmLocalGenerator* localGen = this->Target->GetLocalGenerator();
  cmGlobalGenerator* globalGen = localGen->GetGlobalGenerator();
295

296
297
298
299
300
301
302
  // Configurations
  this->MultiConfig = globalGen->IsMultiConfig();
  this->ConfigDefault = makefile->GetConfigurations(this->ConfigsList);
  if (this->ConfigsList.empty()) {
    this->ConfigsList.push_back(this->ConfigDefault);
  }

303
  // Verbosity
304
305
306
307
308
  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
309
      this->Verbosity = cmSystemTools::IsOn(this->Verbosity) ? "1" : "0";
310
311
312
    }
  }

313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
  // 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;
    }
328
329
  }

330
  // Common directories
331
332
333
  {
    // Collapsed current binary directory
    std::string const cbd = cmSystemTools::CollapseFullPath(
334
      std::string(), makefile->GetCurrentBinaryDirectory());
335

336
337
    // Info directory
    this->Dir.Info = cbd;
338
    this->Dir.Info += "/CMakeFiles";
339
340
341
342
343
344
345
346
347
348
349
350
351
    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";
352
    }
353
354
355
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Build);
    // Cleanup build directory
    AddCleanFile(makefile, this->Dir.Build);
356
357

    // Working directory
358
359
    this->Dir.Work = cbd;
    cmSystemTools::ConvertToUnixSlashes(this->Dir.Work);
360
361

    // Include directory
362
363
    this->Dir.Include = this->Dir.Build;
    this->Dir.Include += "/include";
364
    if (this->MultiConfig) {
365
      this->Dir.Include += "_$<CONFIG>";
366
    }
367
    // Per config include directories
368
369
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
370
371
        std::string& dir = this->Dir.ConfigInclude[cfg];
        dir = this->Dir.Build;
372
373
374
375
        dir += "/include_";
        dir += cfg;
      }
    }
376
  }
377

378
  // Moc, Uic and _autogen target settings
379
380
381
382
383
  if (this->Moc.Enabled || this->Uic.Enabled) {
    // Init moc specific settings
    if (this->Moc.Enabled && !InitMoc()) {
      return false;
    }
384

385
    // Init uic specific settings
386
387
    if (this->Uic.Enabled && !InitUic()) {
      return false;
388
389
    }

390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
    // 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);
      }
    }

423
424
    // Autogen target: Compute user defined dependencies
    {
425
426
427
      this->AutogenTarget.DependOrigin =
        this->Target->GetPropertyAsBool("AUTOGEN_ORIGIN_DEPENDS");

428
429
430
431
432
433
434
435
436
      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) {
437
            this->AutogenTarget.DependTargets.insert(depTarget);
438
          } else {
439
            this->AutogenTarget.DependFiles.insert(depName);
440
441
442
443
444
          }
        }
      }
    }
  }
445

446
447
448
449
450
451
452
453
  // Init rcc specific settings
  if (this->Rcc.Enabled && !InitRcc()) {
    return false;
  }

  // Add autogen include directory to the origin target INCLUDE_DIRECTORIES
  if (this->Moc.Enabled || this->Uic.Enabled ||
      (this->Rcc.Enabled && this->MultiConfig)) {
454
    this->Target->AddIncludeDirectory(this->Dir.Include, true);
455
456
457
458
459
460
461
462
463
464
465
  }

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

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

467
468
469
470
471
472
473
474
475
476
477
478
479
480
  // 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
481
  this->Moc.MocsCompilation = this->Dir.Build;
482
483
484
485
  this->Moc.MocsCompilation += "/mocs_compilation.cpp";

  // Moc predefs command
  if (this->Target->GetPropertyAsBool("AUTOMOC_COMPILER_PREDEFINES") &&
486
      (this->QtVersion >= IntegerVersion(5, 8))) {
487
488
489
490
491
    this->Moc.PredefsCmd =
      makefile->GetSafeDefinition("CMAKE_CXX_COMPILER_PREDEFINES_COMMAND");
  }

  // Moc includes
492
  {
493
    bool const appendImplicit = (this->QtVersion.Major >= 5);
494
    auto GetIncludeDirs =
495
496
      [this, localGen,
       appendImplicit](std::string const& cfg) -> std::vector<std::string> {
497
498
499
500
      // 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;
501
502
      localGen->GetIncludeDirectoriesImplicit(dirs, this->Target, "CXX", cfg,
                                              false, appendImplicit);
503
      return dirs;
504
505
506
507
508
    };

    // Default configuration include directories
    this->Moc.Includes = GetIncludeDirs(this->ConfigDefault);
    // Other configuration settings
509
    if (this->MultiConfig) {
510
      for (std::string const& cfg : this->ConfigsList) {
511
        std::vector<std::string> dirs = GetIncludeDirs(cfg);
512
513
514
        if (dirs != this->Moc.Includes) {
          this->Moc.ConfigIncludes[cfg] = std::move(dirs);
        }
515
      }
516
    }
517
518
  }

519
520
521
  // Moc compile definitions
  {
    auto GetCompileDefinitions =
522
      [this, localGen](std::string const& cfg) -> std::set<std::string> {
523
      std::set<std::string> defines;
524
      localGen->GetTargetDefines(this->Target, cfg, "CXX", defines);
525
526
527
528
529
530
#ifdef _WIN32
      if (this->Moc.PredefsCmd.empty()) {
        // Add WIN32 definition if we don't have a moc_predefs.h
        defines.insert("WIN32");
      }
#endif
531
      return defines;
532
533
534
535
536
537
538
    };

    // Default configuration defines
    this->Moc.Defines = GetCompileDefinitions(this->ConfigDefault);
    // Other configuration defines
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
539
        std::set<std::string> defines = GetCompileDefinitions(cfg);
540
541
542
543
544
        if (defines != this->Moc.Defines) {
          this->Moc.ConfigDefines[cfg] = std::move(defines);
        }
      }
    }
545
  }
546
547

  // Moc executable
548
549
550
551
552
553
554
555
556
557
558
559
  {
    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;
560
561
562
563
564
565
566
567
568
569
570
571
}

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);
572
      std::string const& srcDir = makefile->GetCurrentSourceDirectory();
573
574
575
576
      for (std::string& path : this->Uic.SearchPaths) {
        path = cmSystemTools::CollapseFullPath(path, srcDir);
      }
    }
577
  }
578
579
  // Uic target options
  {
580
581
    auto UicGetOpts =
      [this](std::string const& cfg) -> std::vector<std::string> {
582
583
      std::vector<std::string> opts;
      this->Target->GetAutoUicOptions(opts, cfg);
584
      return opts;
585
    };
586

587
588
589
590
591
592
    // Default settings
    this->Uic.Options = UicGetOpts(this->ConfigDefault);

    // Configuration specific settings
    if (this->MultiConfig) {
      for (std::string const& cfg : this->ConfigsList) {
593
        std::vector<std::string> options = UicGetOpts(cfg);
594
595
596
597
598
599
        if (options != this->Uic.Options) {
          this->Uic.ConfigOptions[cfg] = std::move(options);
        }
      }
    }
  }
600

601
  // Uic executable
602
603
604
605
606
607
608
609
610
611
612
613
  {
    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;
614
615
616
617
}

bool cmQtAutoGenInitializer::InitRcc()
{
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
  // 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");
      } else {
        this->Rcc.ListOptions.emplace_back("-list");
      }
    }
  }

  return true;
635
636
637
638
639
}

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

641
642
643
644
645
  // String constants
  std::string const SKIP_AUTOGEN_str = "SKIP_AUTOGEN";
  std::string const SKIP_AUTOMOC_str = "SKIP_AUTOMOC";
  std::string const SKIP_AUTOUIC_str = "SKIP_AUTOUIC";

646
  // Scan through target files
647
  {
648
649
650
651
652
653
    // String constants
    std::string const qrc_str = "qrc";
    std::string const SKIP_AUTORCC_str = "SKIP_AUTORCC";
    std::string const AUTORCC_OPTIONS_str = "AUTORCC_OPTIONS";

    // Scan through target files
654
    std::vector<cmSourceFile*> srcFiles;
655
    this->Target->GetConfigCommonSourceFiles(srcFiles);
656
    for (cmSourceFile* sf : srcFiles) {
657
      if (sf->GetPropertyAsBool(SKIP_AUTOGEN_str)) {
658
659
        continue;
      }
660

661
      // sf->GetExtension() is only valid after sf->GetFullPath() ...
662
663
      std::string const& fPath = sf->GetFullPath();
      std::string const& ext = sf->GetExtension();
664

665
      // Register generated files that will be scanned by moc or uic
666
      if (this->Moc.Enabled || this->Uic.Enabled) {
667
        cmSystemTools::FileFormat const fileType =
668
          cmSystemTools::GetFileFormat(ext);
669
670
        if ((fileType == cmSystemTools::CXX_FILE_FORMAT) ||
            (fileType == cmSystemTools::HEADER_FILE_FORMAT)) {
671
          std::string const absPath = cmSystemTools::GetRealPath(fPath);
672
673
674
675
          if ((this->Moc.Enabled &&
               !sf->GetPropertyAsBool(SKIP_AUTOMOC_str)) ||
              (this->Uic.Enabled &&
               !sf->GetPropertyAsBool(SKIP_AUTOUIC_str))) {
676
            // Register source
677
            const bool generated = sf->GetIsGenerated();
678
679
            if (fileType == cmSystemTools::HEADER_FILE_FORMAT) {
              if (generated) {
680
                this->AutogenTarget.HeadersGenerated.push_back(absPath);
681
              } else {
682
                this->AutogenTarget.Headers.push_back(absPath);
683
684
685
              }
            } else {
              if (generated) {
686
                this->AutogenTarget.SourcesGenerated.push_back(absPath);
687
              } else {
688
                this->AutogenTarget.Sources.push_back(absPath);
689
              }
690
691
692
            }
          }
        }
693
694
      }
      // Register rcc enabled files
695
696
697
      if (this->Rcc.Enabled) {
        if ((ext == qrc_str) && !sf->GetPropertyAsBool(SKIP_AUTORCC_str)) {
          // Register qrc file
698
699
700
701
          Qrc qrc;
          qrc.QrcFile = cmSystemTools::GetRealPath(fPath);
          qrc.QrcName =
            cmSystemTools::GetFilenameWithoutLastExtension(qrc.QrcFile);
702
          qrc.Generated = sf->GetIsGenerated();
703
704
          // RCC options
          {
705
            std::string const opts = sf->GetSafeProperty(AUTORCC_OPTIONS_str);
706
            if (!opts.empty()) {
707
              cmSystemTools::ExpandListArgument(opts, qrc.Options);
708
709
            }
          }
710
          this->Rcc.Qrcs.push_back(std::move(qrc));
711
        }
712
713
      }
    }
714
  }
715
716
717
718
719
720
  // 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();

721
722
723
724
  // 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.
725
  if (this->Moc.Enabled || this->Uic.Enabled) {
726
727
728
729
730
731
732
733
    // String constants
    std::string const ui_str = "ui";
    std::string const AUTOUIC_OPTIONS_str = "AUTOUIC_OPTIONS";

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

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

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

        // Register moc and uic skipped file
        if (skipMoc) {
          this->Moc.Skip.insert(absFile);
759
        }
760
761
        if (skipUic) {
          this->Uic.Skip.insert(absFile);
762
        }
763
764
765
766
767
768
769
770
771

        // Check if the .ui file has uic options
        if (isUi && !skipUic) {
          std::string const uicOpts = sf->GetSafeProperty(AUTOUIC_OPTIONS_str);
          if (!uicOpts.empty()) {
            this->Uic.FileFiles.push_back(absFile);
            std::vector<std::string> optsVec;
            cmSystemTools::ExpandListArgument(uicOpts, optsVec);
            this->Uic.FileOptions.push_back(std::move(optsVec));
772
          }
773
774
775
        }
      }
    }
776
  }
777

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

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

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

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

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

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

908
909
          qrc.InfoFile = base;
          qrc.InfoFile += "Info.cmake";
910

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

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

957
958
  return true;
}
959

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

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

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

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

1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
  // Use PRE_BUILD on demand
  bool usePRE_BUILD = false;
  if (globalGen->GetName().find("Visual Studio") != std::string::npos) {
    // Under VS use a PRE_BUILD event instead of a separate target to
    // reduce the number of targets loaded into the IDE.
    // This also works around a VS 11 bug that may skip updating the target:
    //  https://connect.microsoft.com/VisualStudio/feedback/details/769495
    usePRE_BUILD = true;
  }
  // Disable PRE_BUILD in some cases
  if (usePRE_BUILD) {
    // Cannot use PRE_BUILD with file depends
1019
    if (!this->AutogenTarget.DependFiles.empty()) {
1020
      usePRE_BUILD = false;
1021
    }
1022
1023
1024
1025
    // Cannot use PRE_BUILD when a global autogen target is in place
    if (AutogenTarget.GlobalTarget) {
      usePRE_BUILD = false;
    }
1026
1027
1028
1029
  }
  // Create the autogen target/command
  if (usePRE_BUILD) {
    // Add additional autogen target dependencies to origin target
1030
    for (cmTarget* depTarget : this->AutogenTarget.DependTargets) {
1031
      this->Target->Target->AddUtility(depTarget->GetName(), makefile);
1032
    }
1033

1034
1035
1036
1037
1038
1039
1040
1041
1042
    // Add the pre-build command directly to bypass the OBJECT_LIBRARY
    // rejection in cmMakefile::AddCustomCommandToTarget because we know
    // PRE_BUILD will work for an OBJECT_LIBRARY in this specific case.
    //
    // PRE_BUILD does not support file dependencies!
    const std::vector<std::string> no_output;
    const std::vector<std::string> no_deps;
    cmCustomCommand cc(makefile, no_output, autogenProvides, no_deps,
                       commandLines, autogenComment.c_str(),
1043
                       this->Dir.Work.c_str());
1044
1045
1046
1047
    cc.SetEscapeOldStyle(false);
    cc.SetEscapeAllowMakeVars(true);
    this->Target->Target->AddPreBuildCommand(cc);
  } else {
1048

1049
1050
    // Add link library target dependencies to the autogen target
    // dependencies
1051
    if (this->AutogenTarget.DependOrigin) {
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
      // add_dependencies/addUtility do not support generator expressions.
      // We depend only on the libraries found in all configs therefore.
      std::map<cmGeneratorTarget const*, std::size_t> commonTargets;
      for (std::string const& config : this->ConfigsList) {
        cmLinkImplementationLibraries const* libs =
          this->Target->GetLinkImplementationLibraries(config);
        if (libs != nullptr) {
          for (cmLinkItem const& item : libs->Libraries) {
            cmGeneratorTarget const* libTarget = item.Target;
            if ((libTarget != nullptr) &&
                !StaticLibraryCycle(this->Target, libTarget, config)) {
              // Increment target config count
              commonTargets[libTarget]++;
1065
1066
1067
            }
          }
        }
1068
      }
1069
1070
      for (auto const& item : commonTargets) {
        if (item.second == this->ConfigsList.size()) {
1071
          this->AutogenTarget.DependTargets.insert(item.first->Target);
1072
        }
1073
      }
1074
    }
1075

1076
1077
    // Create autogen target
    cmTarget* autogenTarget = makefile->AddUtilityCommand(