1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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
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
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file LICENSE.rst or https://cmake.org/licensing for details. */
#pragma once
#include "cmConfigure.h" // IWYU pragma: keep
#include <iosfwd>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <vector>
#include <cm/optional>
#include <cm/string_view>
#include "cmDocumentationEntry.h"
#include "cmGlobalGenerator.h"
#include "cmTransformDepfile.h"
#include "cmValue.h"
#include "cmXCodeObject.h"
class cmCustomCommand;
class cmCustomCommandGenerator;
class cmGeneratorTarget;
class cmGlobalGeneratorFactory;
class cmLocalGenerator;
class cmMakefile;
class cmSourceFile;
class cmSourceGroup;
class cmake;
/** \class cmGlobalXCodeGenerator
* \brief Write a Unix makefiles.
*
* cmGlobalXCodeGenerator manages Xcode build process for a tree
*/
class cmGlobalXCodeGenerator : public cmGlobalGenerator
{
public:
cmGlobalXCodeGenerator(cmake* cm, std::string const& version_string,
unsigned int version_number);
static std::unique_ptr<cmGlobalGeneratorFactory> NewFactory();
cmGlobalXCodeGenerator(cmGlobalXCodeGenerator const&) = delete;
cmGlobalXCodeGenerator const& operator=(cmGlobalXCodeGenerator const&) =
delete;
//! Get the name for the generator.
std::string GetName() const override
{
return cmGlobalXCodeGenerator::GetActualName();
}
static std::string GetActualName() { return "Xcode"; }
/** Get the documentation entry for this generator. */
static cmDocumentationEntry GetDocumentation();
//! Create a local generator appropriate to this Global Generator
std::unique_ptr<cmLocalGenerator> CreateLocalGenerator(
cmMakefile* mf) override;
/**
* Try to determine system information such as shared library
* extension, pthreads, byte order etc.
*/
void EnableLanguage(std::vector<std::string> const& languages, cmMakefile*,
bool optional) override;
/**
* Open a generated IDE project given the following information.
*/
bool Open(std::string const& bindir, std::string const& projectName,
bool dryRun) override;
/**
* Try running cmake and building a file. This is used for dynalically
* loaded commands, not as part of the usual build process.
*/
std::vector<GeneratedMakeCommand> GenerateBuildCommand(
std::string const& makeProgram, std::string const& projectName,
std::string const& projectDir, std::vector<std::string> const& targetNames,
std::string const& config, int jobs, bool verbose,
cmBuildOptions const& buildOptions = cmBuildOptions(),
std::vector<std::string> const& makeOptions =
std::vector<std::string>()) override;
/** Append the subdirectory for the given configuration. */
void AppendDirectoryForConfig(std::string const& prefix,
std::string const& config,
std::string const& suffix,
std::string& dir) override;
bool FindMakeProgram(cmMakefile*) override;
//! What is the configurations directory variable called?
char const* GetCMakeCFGIntDir() const override;
//! expand CFGIntDir
std::string ExpandCFGIntDir(std::string const& str,
std::string const& config) const override;
void SetCurrentLocalGenerator(cmLocalGenerator*);
/** Return true if the generated build tree may contain multiple builds.
i.e. "Can I build Debug and Release in the same tree?" */
bool IsMultiConfig() const override;
bool IsXcode() const override { return true; }
bool HasKnownObjectFileLocation(cmTarget const&,
std::string* reason) const override;
bool IsIPOSupported() const override { return true; }
bool UseEffectivePlatformName(cmMakefile* mf) const override;
bool ShouldStripResourcePath(cmMakefile*) const override;
/**
* Used to determine if this generator supports DEPFILE option.
*/
bool SupportsCustomCommandDepfile() const override { return true; }
cm::optional<cmDepfileFormat> DepfileFormat() const override
{
return this->XcodeBuildSystem == BuildSystem::One
? cmDepfileFormat::MakeDepfile
: cmDepfileFormat::GccDepfile;
}
bool SetSystemName(std::string const& s, cmMakefile* mf) override;
bool SetGeneratorToolset(std::string const& ts, bool build,
cmMakefile* mf) override;
void AppendFlag(std::string& flags, std::string const& flag) const;
cmValue GetDebuggerWorkingDirectory(cmGeneratorTarget* gt) const override;
enum class BuildSystem
{
One = 1,
Twelve = 12,
};
protected:
void AddExtraIDETargets() override;
void Generate() override;
private:
enum EmbedActionFlags
{
NoActionOnCopyByDefault = 0,
CodeSignOnCopyByDefault = 1,
RemoveHeadersOnCopyByDefault = 2,
};
bool ParseGeneratorToolset(std::string const& ts, cmMakefile* mf);
bool ProcessGeneratorToolsetField(std::string const& key,
std::string const& value, cmMakefile* mf);
cmXCodeObject* CreateOrGetPBXGroup(cmGeneratorTarget* gtgt,
cmSourceGroup* sg);
cmXCodeObject* CreatePBXGroup(cmXCodeObject* parent,
std::string const& name);
bool CreateGroups(std::vector<cmLocalGenerator*>& generators);
std::string XCodeEscapePath(std::string const& p);
std::string RelativeToSource(std::string const& p);
std::string RelativeToRootBinary(std::string const& p);
std::string RelativeToBinary(std::string const& p);
void CreateCustomCommands(
cmXCodeObject* buildPhases, cmXCodeObject* sourceBuildPhase,
cmXCodeObject* headerBuildPhase, cmXCodeObject* resourceBuildPhase,
std::vector<cmXCodeObject*> const& contentBuildPhases,
cmXCodeObject* frameworkBuildPhase, cmGeneratorTarget* gtgt);
std::string ComputeInfoPListLocation(cmGeneratorTarget* target);
void AddCommandsToBuildPhase(cmXCodeObject* buildphase,
cmGeneratorTarget* target,
std::vector<cmCustomCommand> const& commands,
char const* commandFileName);
void CreateCustomRulesMakefile(char const* makefileBasename,
cmGeneratorTarget* target,
std::vector<cmCustomCommand> const& commands,
std::string const& configName);
cmXCodeObject* FindXCodeTarget(cmGeneratorTarget const*);
std::string GetObjectId(cmXCodeObject::PBXType ptype, cm::string_view key);
std::string GetOrCreateId(std::string const& name, std::string const& id);
// create cmXCodeObject from these functions so that memory can be managed
// correctly. All objects created are stored in this->XCodeObjects.
cmXCodeObject* CreateObject(cmXCodeObject::PBXType ptype,
cm::string_view key = {});
cmXCodeObject* CreateObject(cmXCodeObject::Type type);
cmXCodeObject* CreateString(cm::string_view s);
cmXCodeObject* CreateObjectReference(cmXCodeObject*);
cmXCodeObject* CreateFlatClone(cmXCodeObject*);
cmXCodeObject* CreateXCodeTarget(cmGeneratorTarget* gtgt,
cmXCodeObject* buildPhases);
void ForceLinkerLanguages() override;
void ForceLinkerLanguage(cmGeneratorTarget* gtgt);
char const* GetTargetLinkFlagsVar(cmGeneratorTarget const* target) const;
char const* GetTargetFileType(cmGeneratorTarget* target);
cm::string_view GetTargetProductType(cmGeneratorTarget* target);
std::string AddConfigurations(cmXCodeObject* target,
cmGeneratorTarget* gtgt);
void AppendOrAddBuildSetting(cmXCodeObject* settings, char const* attr,
cmXCodeObject* value);
void AppendBuildSettingAttribute(cmXCodeObject* settings,
char const* attribute, cmXCodeObject* attr,
cmXCodeObject* value);
void AppendBuildSettingAttribute(cmXCodeObject* target, char const* attr,
cmXCodeObject* value,
std::string const& configName);
void InheritBuildSettingAttribute(cmXCodeObject* target,
char const* attribute);
cmXCodeObject* CreateUtilityTarget(cmGeneratorTarget* gtgt);
void AddDependAndLinkInformation(cmXCodeObject* target);
void AddEmbeddedObjects(cmXCodeObject* target,
std::string const& copyFilesBuildPhaseName,
std::string const& embedPropertyName,
std::string const& dstSubfolderSpec,
int actionsOnByDefault,
std::string const& defaultDstPath = "");
void AddEmbeddedFrameworks(cmXCodeObject* target);
void AddEmbeddedPlugIns(cmXCodeObject* target);
void AddEmbeddedAppExtensions(cmXCodeObject* target);
void AddEmbeddedExtensionKitExtensions(cmXCodeObject* target);
void AddEmbeddedResources(cmXCodeObject* target);
void AddEmbeddedXPCServices(cmXCodeObject* target);
void AddPositionIndependentLinkAttribute(cmGeneratorTarget* target,
cmXCodeObject* buildSettings,
std::string const& configName);
void CreateGlobalXCConfigSettings(cmLocalGenerator* root,
cmXCodeObject* config,
std::string const& configName);
void CreateTargetXCConfigSettings(cmGeneratorTarget* target,
cmXCodeObject* config,
std::string const& configName);
void CreateBuildSettings(cmGeneratorTarget* gtgt,
cmXCodeObject* buildSettings,
std::string const& buildType);
std::string ExtractFlag(char const* flag, std::string& flags);
std::string ExtractFlagRegex(char const* exp, int matchIndex,
std::string& flags);
void FilterConfigurationAttribute(std::string const& configName,
std::string& attribute);
void SortXCodeObjects();
// delete all objects in the this->XCodeObjects vector.
void ClearXCodeObjects();
bool CreateXCodeObjects(cmLocalGenerator* root,
std::vector<cmLocalGenerator*>& generators);
void OutputXCodeProject(cmLocalGenerator* root,
std::vector<cmLocalGenerator*>& generators);
// Write shared scheme files for all the native targets
// return true if any were written
bool OutputXCodeSharedSchemes(std::string const& xcProjDir,
cmLocalGenerator* root);
void OutputXCodeWorkspaceSettings(std::string const& xcProjDir,
bool hasGeneratedSchemes);
void WriteXCodePBXProj(std::ostream& fout, cmLocalGenerator* root,
std::vector<cmLocalGenerator*>& generators);
cmXCodeObject* CreateXCodeFileReferenceFromPath(std::string const& fullpath,
cmGeneratorTarget* target,
std::string const& lang,
cmSourceFile* sf);
cmXCodeObject* CreateXCodeBuildFileFromPath(std::string const& fullpath,
cmGeneratorTarget* target,
std::string const& lang,
cmSourceFile* sf);
cmXCodeObject* CreateXCodeFileReference(cmSourceFile* sf,
cmGeneratorTarget* target);
cmXCodeObject* CreateXCodeSourceFile(cmLocalGenerator* gen, cmSourceFile* sf,
cmGeneratorTarget* gtgt);
void AddXCodeProjBuildRule(cmGeneratorTarget* target,
std::vector<cmSourceFile*>& sources) const;
bool CreateXCodeTargets(cmLocalGenerator* gen, std::vector<cmXCodeObject*>&);
bool CreateXCodeTarget(cmGeneratorTarget* gtgt,
std::vector<cmXCodeObject*>&);
bool IsHeaderFile(cmSourceFile*);
void AddDependTarget(cmXCodeObject* target, cmXCodeObject* dependTarget);
void CreateXCodeDependHackMakefile(std::vector<cmXCodeObject*>& targets);
bool SpecialTargetEmitted(std::string const& tname);
void SetGenerationRoot(cmLocalGenerator* root);
void AddExtraTargets(cmLocalGenerator* root,
std::vector<cmLocalGenerator*>& gens);
cmXCodeObject* CreateLegacyRunScriptBuildPhase(
char const* name, char const* name2, cmGeneratorTarget* target,
std::vector<cmCustomCommand> const&);
void CreateRunScriptBuildPhases(cmXCodeObject* buildPhases,
cmGeneratorTarget const* gt);
void CreateRunScriptBuildPhases(cmXCodeObject* buildPhases,
cmSourceFile const* sf,
cmGeneratorTarget const* gt,
std::set<cmSourceFile const*>& visited);
cmXCodeObject* CreateRunScriptBuildPhase(cmSourceFile const* sf,
cmGeneratorTarget const* gt,
cmCustomCommand const& cc);
cmXCodeObject* CreateRunScriptBuildPhase(
std::string const& name, cmGeneratorTarget const* gt,
std::vector<cmCustomCommand> const& commands,
std::vector<std::string> const& depends = {});
std::string ConstructScript(cmCustomCommandGenerator const& ccg);
void CreateReRunCMakeFile(cmLocalGenerator* root,
std::vector<cmLocalGenerator*> const& gens);
std::string LookupFlags(std::string const& varNamePrefix,
std::string const& varNameLang,
std::string const& varNameSuffix,
cmGeneratorTarget const* gt);
class Factory;
class BuildObjectListOrString;
friend class BuildObjectListOrString;
void AppendDefines(BuildObjectListOrString& defs, char const* defines_list,
bool dflag = false);
void AppendDefines(BuildObjectListOrString& defs,
std::vector<std::string> const& defines,
bool dflag = false);
void ComputeTargetObjectDirectory(cmGeneratorTarget* gt) const override;
protected:
char const* GetInstallTargetName() const override { return "install"; }
char const* GetPackageTargetName() const override { return "package"; }
unsigned int XcodeVersion;
std::string VersionString;
std::set<std::string> XCodeObjectIDs;
std::vector<std::unique_ptr<cmXCodeObject>> XCodeObjects;
cmXCodeObject* RootObject;
BuildSystem XcodeBuildSystem = BuildSystem::One;
private:
std::string GetAppleSpecificPlatformName();
std::string const& GetXcodeBuildCommand();
std::string FindXcodeBuildCommand();
std::string XcodeBuildCommand;
bool XcodeBuildCommandInitialized;
void PrintCompilerAdvice(std::ostream&, std::string const&,
cmValue) const override
{
}
std::string GetLibraryOrFrameworkPath(std::string const& path) const;
std::string GetSymrootDir() const;
std::string GetTargetTempDir(cmGeneratorTarget const* gt,
std::string const& configName) const;
static std::string GetDeploymentPlatform(cmMakefile const* mf);
void ComputeArchitectures(cmMakefile* mf);
void ComputeObjectDirArch(cmMakefile* mf);
void addObject(std::unique_ptr<cmXCodeObject> obj);
std::string PostBuildMakeTarget(std::string const& tName,
std::string const& configName);
cmXCodeObject* MainGroupChildren;
cmXCodeObject* FrameworkGroup;
cmXCodeObject* ResourcesGroup;
cmMakefile* CurrentMakefile;
cmLocalGenerator* CurrentLocalGenerator;
cmLocalGenerator* CurrentRootGenerator = nullptr;
std::vector<std::string> CurrentConfigurationTypes;
std::string CurrentReRunCMakeMakefile;
std::string CurrentXCodeHackMakefile;
std::string CurrentProject;
std::set<std::string> TargetDoneSet;
std::map<std::string, cmXCodeObject*> GroupMap;
std::map<std::string, cmXCodeObject*> GroupNameMap;
std::map<std::string, cmXCodeObject*> TargetGroup;
std::map<std::string, cmXCodeObject*> FileRefs;
std::map<std::string, cmXCodeObject*> ExternalLibRefs;
std::map<cmGeneratorTarget const*, cmXCodeObject*> XCodeObjectMap;
std::map<cmXCodeObject*, cmXCodeObject*> FileRefToBuildFileMap;
std::map<cmXCodeObject*, cmXCodeObject*> FileRefToEmbedBuildFileMap;
std::vector<std::string> Architectures;
std::string ObjectDirArchDefault;
std::string ObjectDirArch;
std::string SystemName;
std::string GeneratorToolset;
std::vector<std::string> EnabledLangs;
std::map<cmGeneratorTarget const*, std::set<cmSourceFile const*>>
CommandsVisited;
std::map<cmSourceFile const*, std::set<cmGeneratorTarget const*>>
CustomCommandRoots;
};
|
