Make it possible to use the generalised 'case' construct in the cmd_line property.
[oota-llvm.git] / utils / TableGen / LLVMCConfigurationEmitter.cpp
1 //===- LLVMCConfigurationEmitter.cpp - Generate LLVMC config --------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open
6 // Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This tablegen backend is responsible for emitting LLVMC configuration code.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "LLVMCConfigurationEmitter.h"
15 #include "Record.h"
16
17 #include "llvm/ADT/IntrusiveRefCntPtr.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/ADT/StringExtras.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/Support/Streams.h"
22
23 #include <algorithm>
24 #include <cassert>
25 #include <functional>
26 #include <string>
27
28 using namespace llvm;
29
30 namespace {
31
32 //===----------------------------------------------------------------------===//
33 /// Typedefs
34
35 typedef std::vector<Record*> RecordVector;
36 typedef std::vector<std::string> StrVector;
37
38 //===----------------------------------------------------------------------===//
39 /// Constants
40
41 // Indentation strings.
42 const char * Indent1 = "    ";
43 const char * Indent2 = "        ";
44 const char * Indent3 = "            ";
45 const char * Indent4 = "                ";
46
47 // Default help string.
48 const char * DefaultHelpString = "NO HELP MESSAGE PROVIDED";
49
50 // Name for the "sink" option.
51 const char * SinkOptionName = "AutoGeneratedSinkOption";
52
53 //===----------------------------------------------------------------------===//
54 /// Helper functions
55
56 const std::string& InitPtrToString(const Init* ptr) {
57   const StringInit& val = dynamic_cast<const StringInit&>(*ptr);
58   return val.getValue();
59 }
60
61 int InitPtrToInt(const Init* ptr) {
62   const IntInit& val = dynamic_cast<const IntInit&>(*ptr);
63   return val.getValue();
64 }
65
66 const DagInit& InitPtrToDagInitRef(const Init* ptr) {
67   const DagInit& val = dynamic_cast<const DagInit&>(*ptr);
68   return val;
69 }
70
71 // checkNumberOfArguments - Ensure that the number of args in d is
72 // less than or equal to min_arguments, otherwise throw an exception.
73 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
74   if (d->getNumArgs() < min_arguments)
75     throw "Property " + d->getOperator()->getAsString()
76       + " has too few arguments!";
77 }
78
79 // isDagEmpty - is this DAG marked with an empty marker?
80 bool isDagEmpty (const DagInit* d) {
81   return d->getOperator()->getAsString() == "empty";
82 }
83
84 //===----------------------------------------------------------------------===//
85 /// Back-end specific code
86
87 // A command-line option can have one of the following types:
88 //
89 // Switch - a simple switch w/o arguments, e.g. -O2
90 //
91 // Parameter - an option that takes one(and only one) argument, e.g. -o file,
92 // --output=file
93 //
94 // ParameterList - same as Parameter, but more than one occurence
95 // of the option is allowed, e.g. -lm -lpthread
96 //
97 // Prefix - argument is everything after the prefix,
98 // e.g. -Wa,-foo,-bar, -DNAME=VALUE
99 //
100 // PrefixList - same as Prefix, but more than one option occurence is
101 // allowed
102
103 namespace OptionType {
104   enum OptionType { Switch, Parameter, ParameterList, Prefix, PrefixList};
105 }
106
107 bool IsListOptionType (OptionType::OptionType t) {
108   return (t == OptionType::ParameterList || t == OptionType::PrefixList);
109 }
110
111 // Code duplication here is necessary because one option can affect
112 // several tools and those tools may have different actions associated
113 // with this option. GlobalOptionDescriptions are used to generate
114 // the option registration code, while ToolOptionDescriptions are used
115 // to generate tool-specific code.
116
117 /// OptionDescription - Base class for option descriptions.
118 struct OptionDescription {
119   OptionType::OptionType Type;
120   std::string Name;
121
122   OptionDescription(OptionType::OptionType t = OptionType::Switch,
123                     const std::string& n = "")
124   : Type(t), Name(n)
125   {}
126
127   const char* GenTypeDeclaration() const {
128     switch (Type) {
129     case OptionType::PrefixList:
130     case OptionType::ParameterList:
131       return "cl::list<std::string>";
132     case OptionType::Switch:
133       return "cl::opt<bool>";
134     case OptionType::Parameter:
135     case OptionType::Prefix:
136     default:
137       return "cl::opt<std::string>";
138     }
139   }
140
141   // Escape commas and other symbols not allowed in the C++ variable
142   // names. Makes it possible to use options with names like "Wa,"
143   // (useful for prefix options).
144   std::string EscapeVariableName(const std::string& Var) const {
145     std::string ret;
146     for (unsigned i = 0; i != Var.size(); ++i) {
147       if (Var[i] == ',') {
148         ret += "_comma_";
149       }
150       else {
151         ret.push_back(Var[i]);
152       }
153     }
154     return ret;
155   }
156
157   std::string GenVariableName() const {
158     const std::string& EscapedName = EscapeVariableName(Name);
159     switch (Type) {
160     case OptionType::Switch:
161      return "AutoGeneratedSwitch" + EscapedName;
162    case OptionType::Prefix:
163      return "AutoGeneratedPrefix" + EscapedName;
164    case OptionType::PrefixList:
165      return "AutoGeneratedPrefixList" + EscapedName;
166    case OptionType::Parameter:
167      return "AutoGeneratedParameter" + EscapedName;
168    case OptionType::ParameterList:
169    default:
170      return "AutoGeneratedParameterList" + EscapedName;
171    }
172   }
173
174 };
175
176 // Global option description.
177
178 namespace GlobalOptionDescriptionFlags {
179   enum GlobalOptionDescriptionFlags { Required = 0x1 };
180 }
181
182 struct GlobalOptionDescription : public OptionDescription {
183   std::string Help;
184   unsigned Flags;
185
186   // We need to provide a default constructor because
187   // StringMap can only store DefaultConstructible objects.
188   GlobalOptionDescription() : OptionDescription(), Flags(0)
189   {}
190
191   GlobalOptionDescription (OptionType::OptionType t, const std::string& n)
192     : OptionDescription(t, n), Help(DefaultHelpString), Flags(0)
193   {}
194
195   bool isRequired() const {
196     return Flags & GlobalOptionDescriptionFlags::Required;
197   }
198   void setRequired() {
199     Flags |= GlobalOptionDescriptionFlags::Required;
200   }
201
202   /// Merge - Merge two option descriptions.
203   void Merge (const GlobalOptionDescription& other)
204   {
205     if (other.Type != Type)
206       throw "Conflicting definitions for the option " + Name + "!";
207
208     if (Help == DefaultHelpString)
209       Help = other.Help;
210     else if (other.Help != DefaultHelpString) {
211       llvm::cerr << "Warning: more than one help string defined for option "
212         + Name + "\n";
213     }
214
215     Flags |= other.Flags;
216   }
217 };
218
219 /// GlobalOptionDescriptions - A GlobalOptionDescription array
220 /// together with some flags affecting generation of option
221 /// declarations.
222 struct GlobalOptionDescriptions {
223   typedef StringMap<GlobalOptionDescription> container_type;
224   typedef container_type::const_iterator const_iterator;
225
226   /// Descriptions - A list of GlobalOptionDescriptions.
227   container_type Descriptions;
228   /// HasSink - Should the emitter generate a "cl::sink" option?
229   bool HasSink;
230
231   const GlobalOptionDescription& FindOption(const std::string& OptName) const {
232     const_iterator I = Descriptions.find(OptName);
233     if (I != Descriptions.end())
234       return I->second;
235     else
236       throw OptName + ": no such option!";
237   }
238
239   // Support for STL-style iteration
240   const_iterator begin() const { return Descriptions.begin(); }
241   const_iterator end() const { return Descriptions.end(); }
242 };
243
244
245 // Tool-local option description.
246
247 // Properties without arguments are implemented as flags.
248 namespace ToolOptionDescriptionFlags {
249   enum ToolOptionDescriptionFlags { StopCompilation = 0x1,
250                                     Forward = 0x2, UnpackValues = 0x4};
251 }
252 namespace OptionPropertyType {
253   enum OptionPropertyType { AppendCmd };
254 }
255
256 typedef std::pair<OptionPropertyType::OptionPropertyType, std::string>
257 OptionProperty;
258 typedef SmallVector<OptionProperty, 4> OptionPropertyList;
259
260 struct ToolOptionDescription : public OptionDescription {
261   unsigned Flags;
262   OptionPropertyList Props;
263
264   // StringMap can only store DefaultConstructible objects
265   ToolOptionDescription() : OptionDescription(), Flags(0) {}
266
267   ToolOptionDescription (OptionType::OptionType t, const std::string& n)
268     : OptionDescription(t, n)
269   {}
270
271   // Various boolean properties
272   bool isStopCompilation() const {
273     return Flags & ToolOptionDescriptionFlags::StopCompilation;
274   }
275   void setStopCompilation() {
276     Flags |= ToolOptionDescriptionFlags::StopCompilation;
277   }
278
279   bool isForward() const {
280     return Flags & ToolOptionDescriptionFlags::Forward;
281   }
282   void setForward() {
283     Flags |= ToolOptionDescriptionFlags::Forward;
284   }
285
286   bool isUnpackValues() const {
287     return Flags & ToolOptionDescriptionFlags::UnpackValues;
288   }
289   void setUnpackValues() {
290     Flags |= ToolOptionDescriptionFlags::UnpackValues;
291   }
292
293   void AddProperty (OptionPropertyType::OptionPropertyType t,
294                     const std::string& val)
295   {
296     Props.push_back(std::make_pair(t, val));
297   }
298 };
299
300 typedef StringMap<ToolOptionDescription> ToolOptionDescriptions;
301
302 // Tool information record
303
304 namespace ToolFlags {
305   enum ToolFlags { Join = 0x1, Sink = 0x2 };
306 }
307
308 struct ToolProperties : public RefCountedBase<ToolProperties> {
309   std::string Name;
310   Init* CmdLine;
311   std::string InLanguage;
312   std::string OutLanguage;
313   std::string OutputSuffix;
314   unsigned Flags;
315   ToolOptionDescriptions OptDescs;
316
317   // Various boolean properties
318   void setSink()      { Flags |= ToolFlags::Sink; }
319   bool isSink() const { return Flags & ToolFlags::Sink; }
320   void setJoin()      { Flags |= ToolFlags::Join; }
321   bool isJoin() const { return Flags & ToolFlags::Join; }
322
323   // Default ctor here is needed because StringMap can only store
324   // DefaultConstructible objects
325   ToolProperties() : Flags(0) {}
326   ToolProperties (const std::string& n) : Name(n), Flags(0) {}
327 };
328
329
330 /// ToolPropertiesList - A list of Tool information records
331 /// IntrusiveRefCntPtrs are used here because StringMap has no copy
332 /// constructor (and we want to avoid copying ToolProperties anyway).
333 typedef std::vector<IntrusiveRefCntPtr<ToolProperties> > ToolPropertiesList;
334
335
336 /// CollectProperties - Function object for iterating over a list of
337 /// tool property records.
338 class CollectProperties {
339 private:
340
341   /// Implementation details
342
343   /// PropertyHandler - a function that extracts information
344   /// about a given tool property from its DAG representation
345   typedef void (CollectProperties::*PropertyHandler)(const DagInit*);
346
347   /// PropertyHandlerMap - A map from property names to property
348   /// handlers.
349   typedef StringMap<PropertyHandler> PropertyHandlerMap;
350
351   /// OptionPropertyHandler - a function that extracts information
352   /// about a given option property from its DAG representation.
353   typedef void (CollectProperties::* OptionPropertyHandler)
354   (const DagInit*, GlobalOptionDescription &);
355
356   /// OptionPropertyHandlerMap - A map from option property names to
357   /// option property handlers
358   typedef StringMap<OptionPropertyHandler> OptionPropertyHandlerMap;
359
360   // Static maps from strings to CollectProperties methods("handlers")
361   static PropertyHandlerMap propertyHandlers_;
362   static OptionPropertyHandlerMap optionPropertyHandlers_;
363   static bool staticMembersInitialized_;
364
365
366   /// This is where the information is stored
367
368   /// toolProps_ -  Properties of the current Tool.
369   ToolProperties& toolProps_;
370   /// optDescs_ - OptionDescriptions table (used to register options
371   /// globally).
372   GlobalOptionDescriptions& optDescs_;
373
374 public:
375
376   explicit CollectProperties (ToolProperties& p, GlobalOptionDescriptions& d)
377     : toolProps_(p), optDescs_(d)
378   {
379     if (!staticMembersInitialized_) {
380       // Init tool property handlers
381       propertyHandlers_["cmd_line"] = &CollectProperties::onCmdLine;
382       propertyHandlers_["in_language"] = &CollectProperties::onInLanguage;
383       propertyHandlers_["join"] = &CollectProperties::onJoin;
384       propertyHandlers_["out_language"] = &CollectProperties::onOutLanguage;
385       propertyHandlers_["output_suffix"] = &CollectProperties::onOutputSuffix;
386       propertyHandlers_["parameter_option"]
387         = &CollectProperties::onParameter;
388       propertyHandlers_["parameter_list_option"] =
389         &CollectProperties::onParameterList;
390       propertyHandlers_["prefix_option"] = &CollectProperties::onPrefix;
391       propertyHandlers_["prefix_list_option"] =
392         &CollectProperties::onPrefixList;
393       propertyHandlers_["sink"] = &CollectProperties::onSink;
394       propertyHandlers_["switch_option"] = &CollectProperties::onSwitch;
395
396       // Init option property handlers
397       optionPropertyHandlers_["append_cmd"] = &CollectProperties::onAppendCmd;
398       optionPropertyHandlers_["forward"] = &CollectProperties::onForward;
399       optionPropertyHandlers_["help"] = &CollectProperties::onHelp;
400       optionPropertyHandlers_["required"] = &CollectProperties::onRequired;
401       optionPropertyHandlers_["stop_compilation"] =
402         &CollectProperties::onStopCompilation;
403       optionPropertyHandlers_["unpack_values"] =
404         &CollectProperties::onUnpackValues;
405
406       staticMembersInitialized_ = true;
407     }
408   }
409
410   /// operator() - Gets called for every tool property; Just forwards
411   /// to the corresponding property handler.
412   void operator() (Init* i) {
413     const DagInit& d = InitPtrToDagInitRef(i);
414     const std::string& property_name = d.getOperator()->getAsString();
415     PropertyHandlerMap::iterator method
416       = propertyHandlers_.find(property_name);
417
418     if (method != propertyHandlers_.end()) {
419       PropertyHandler h = method->second;
420       (this->*h)(&d);
421     }
422     else {
423       throw "Unknown tool property: " + property_name + "!";
424     }
425   }
426
427 private:
428
429   /// Property handlers --
430   /// Functions that extract information about tool properties from
431   /// DAG representation.
432
433   void onCmdLine (const DagInit* d) {
434     checkNumberOfArguments(d, 1);
435     toolProps_.CmdLine = d->getArg(0);
436   }
437
438   void onInLanguage (const DagInit* d) {
439     checkNumberOfArguments(d, 1);
440     toolProps_.InLanguage = InitPtrToString(d->getArg(0));
441   }
442
443   void onJoin (const DagInit* d) {
444     checkNumberOfArguments(d, 0);
445     toolProps_.setJoin();
446   }
447
448   void onOutLanguage (const DagInit* d) {
449     checkNumberOfArguments(d, 1);
450     toolProps_.OutLanguage = InitPtrToString(d->getArg(0));
451   }
452
453   void onOutputSuffix (const DagInit* d) {
454     checkNumberOfArguments(d, 1);
455     toolProps_.OutputSuffix = InitPtrToString(d->getArg(0));
456   }
457
458   void onSink (const DagInit* d) {
459     checkNumberOfArguments(d, 0);
460     optDescs_.HasSink = true;
461     toolProps_.setSink();
462   }
463
464   void onSwitch (const DagInit* d) {
465     addOption(d, OptionType::Switch);
466   }
467
468   void onParameter (const DagInit* d) {
469     addOption(d, OptionType::Parameter);
470   }
471
472   void onParameterList (const DagInit* d) {
473     addOption(d, OptionType::ParameterList);
474   }
475
476   void onPrefix (const DagInit* d) {
477     addOption(d, OptionType::Prefix);
478   }
479
480   void onPrefixList (const DagInit* d) {
481     addOption(d, OptionType::PrefixList);
482   }
483
484   /// Option property handlers --
485   /// Methods that handle properties that are common for all types of
486   /// options (like append_cmd, stop_compilation)
487
488   void onAppendCmd (const DagInit* d, GlobalOptionDescription& o) {
489     checkNumberOfArguments(d, 1);
490     std::string const& cmd = InitPtrToString(d->getArg(0));
491
492     toolProps_.OptDescs[o.Name].AddProperty(OptionPropertyType::AppendCmd, cmd);
493   }
494
495   void onForward (const DagInit* d, GlobalOptionDescription& o) {
496     checkNumberOfArguments(d, 0);
497     toolProps_.OptDescs[o.Name].setForward();
498   }
499
500   void onHelp (const DagInit* d, GlobalOptionDescription& o) {
501     checkNumberOfArguments(d, 1);
502     const std::string& help_message = InitPtrToString(d->getArg(0));
503
504     o.Help = help_message;
505   }
506
507   void onRequired (const DagInit* d, GlobalOptionDescription& o) {
508     checkNumberOfArguments(d, 0);
509     o.setRequired();
510   }
511
512   void onStopCompilation (const DagInit* d, GlobalOptionDescription& o) {
513     checkNumberOfArguments(d, 0);
514     if (o.Type != OptionType::Switch)
515       throw std::string("Only options of type Switch can stop compilation!");
516     toolProps_.OptDescs[o.Name].setStopCompilation();
517   }
518
519   void onUnpackValues (const DagInit* d, GlobalOptionDescription& o) {
520     checkNumberOfArguments(d, 0);
521     toolProps_.OptDescs[o.Name].setUnpackValues();
522   }
523
524   /// Helper functions
525
526   // Add an option of type t
527   void addOption (const DagInit* d, OptionType::OptionType t) {
528     checkNumberOfArguments(d, 2);
529     const std::string& name = InitPtrToString(d->getArg(0));
530
531     GlobalOptionDescription o(t, name);
532     toolProps_.OptDescs[name].Type = t;
533     toolProps_.OptDescs[name].Name = name;
534     processOptionProperties(d, o);
535     insertDescription(o);
536   }
537
538   // Insert new GlobalOptionDescription into GlobalOptionDescriptions list
539   void insertDescription (const GlobalOptionDescription& o)
540   {
541     if (optDescs_.Descriptions.count(o.Name)) {
542       GlobalOptionDescription& D = optDescs_.Descriptions[o.Name];
543       D.Merge(o);
544     }
545     else {
546       optDescs_.Descriptions[o.Name] = o;
547     }
548   }
549
550   /// processOptionProperties - Go through the list of option
551   /// properties and call a corresponding handler for each.
552   ///
553   /// Parameters:
554   /// name - option name
555   /// d - option property list
556   void processOptionProperties (const DagInit* d, GlobalOptionDescription& o) {
557     // First argument is option name
558     checkNumberOfArguments(d, 2);
559
560     for (unsigned B = 1, E = d->getNumArgs(); B!=E; ++B) {
561       const DagInit& option_property
562         = InitPtrToDagInitRef(d->getArg(B));
563       const std::string& option_property_name
564         = option_property.getOperator()->getAsString();
565       OptionPropertyHandlerMap::iterator method
566         = optionPropertyHandlers_.find(option_property_name);
567
568       if (method != optionPropertyHandlers_.end()) {
569         OptionPropertyHandler h = method->second;
570         (this->*h)(&option_property, o);
571       }
572       else {
573         throw "Unknown option property: " + option_property_name + "!";
574       }
575     }
576   }
577 };
578
579 // Static members of CollectProperties
580 CollectProperties::PropertyHandlerMap
581 CollectProperties::propertyHandlers_;
582
583 CollectProperties::OptionPropertyHandlerMap
584 CollectProperties::optionPropertyHandlers_;
585
586 bool CollectProperties::staticMembersInitialized_ = false;
587
588
589 /// CollectToolProperties - Gather information from the parsed
590 /// TableGen data (basically a wrapper for the CollectProperties
591 /// function object).
592 void CollectToolProperties (RecordVector::const_iterator B,
593                             RecordVector::const_iterator E,
594                             ToolPropertiesList& TPList,
595                             GlobalOptionDescriptions& OptDescs)
596 {
597   // Iterate over a properties list of every Tool definition
598   for (;B!=E;++B) {
599     RecordVector::value_type T = *B;
600     ListInit* PropList = T->getValueAsListInit("properties");
601
602     IntrusiveRefCntPtr<ToolProperties>
603       ToolProps(new ToolProperties(T->getName()));
604
605     std::for_each(PropList->begin(), PropList->end(),
606                   CollectProperties(*ToolProps, OptDescs));
607     TPList.push_back(ToolProps);
608   }
609 }
610
611 /// EmitCaseTest1Arg - Helper function used by
612 /// EmitCaseConstructHandler.
613 bool EmitCaseTest1Arg(const std::string& TestName,
614                       const DagInit& d,
615                       const GlobalOptionDescriptions& OptDescs,
616                       std::ostream& O) {
617   checkNumberOfArguments(&d, 1);
618   const std::string& OptName = InitPtrToString(d.getArg(0));
619   if (TestName == "switch_on") {
620     const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
621     if (OptDesc.Type != OptionType::Switch)
622       throw OptName + ": incorrect option type!";
623     O << OptDesc.GenVariableName();
624     return true;
625   } else if (TestName == "input_languages_contain") {
626     O << "InLangs.count(\"" << OptName << "\") != 0";
627     return true;
628   }
629
630   return false;
631 }
632
633 /// EmitCaseTest2Args - Helper function used by
634 /// EmitCaseConstructHandler.
635 bool EmitCaseTest2Args(const std::string& TestName,
636                        const DagInit& d,
637                        const char* IndentLevel,
638                        const GlobalOptionDescriptions& OptDescs,
639                        std::ostream& O) {
640   checkNumberOfArguments(&d, 2);
641   const std::string& OptName = InitPtrToString(d.getArg(0));
642   const std::string& OptArg = InitPtrToString(d.getArg(1));
643   const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
644
645   if (TestName == "parameter_equals") {
646     if (OptDesc.Type != OptionType::Parameter
647         && OptDesc.Type != OptionType::Prefix)
648       throw OptName + ": incorrect option type!";
649     O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
650     return true;
651   }
652   else if (TestName == "element_in_list") {
653     if (OptDesc.Type != OptionType::ParameterList
654         && OptDesc.Type != OptionType::PrefixList)
655       throw OptName + ": incorrect option type!";
656     const std::string& VarName = OptDesc.GenVariableName();
657     O << "std::find(" << VarName << ".begin(),\n"
658       << IndentLevel << Indent1 << VarName << ".end(), \""
659       << OptArg << "\") != " << VarName << ".end()";
660     return true;
661   }
662
663   return false;
664 }
665
666 // Forward declaration.
667 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
668 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
669                   const GlobalOptionDescriptions& OptDescs,
670                   std::ostream& O);
671
672 /// EmitLogicalOperationTest - Helper function used by
673 /// EmitCaseConstructHandler.
674 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
675                               const char* IndentLevel,
676                               const GlobalOptionDescriptions& OptDescs,
677                               std::ostream& O) {
678   O << '(';
679   for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
680     const DagInit& InnerTest = InitPtrToDagInitRef(d.getArg(j));
681     EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
682     if (j != NumArgs - 1)
683       O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
684     else
685       O << ')';
686   }
687 }
688
689 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
690 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
691                   const GlobalOptionDescriptions& OptDescs,
692                   std::ostream& O) {
693   const std::string& TestName = d.getOperator()->getAsString();
694
695   if (TestName == "and")
696     EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
697   else if (TestName == "or")
698     EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
699   else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
700     return;
701   else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
702     return;
703   else
704     throw TestName + ": unknown edge property!";
705 }
706
707 // Emit code that handles the 'case' construct.
708 // Takes a function object that should emit code for every case clause.
709 // Callback's type is
710 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
711 template <typename F>
712 void EmitCaseConstructHandler(const DagInit* d, const char* IndentLevel,
713                               const F& Callback,
714                               const GlobalOptionDescriptions& OptDescs,
715                               std::ostream& O) {
716   assert(d->getOperator()->getAsString() == "case");
717
718   for (unsigned i = 0, numArgs = d->getNumArgs(); i != numArgs; ++i) {
719     const DagInit& Test = InitPtrToDagInitRef(d->getArg(i));
720
721     if (Test.getOperator()->getAsString() == "default") {
722       if (i+2 != numArgs)
723         throw std::string("The 'default' clause should be the last in the"
724                           "'case' construct!");
725       O << IndentLevel << "else {\n";
726     }
727     else {
728       O << IndentLevel << "if (";
729       EmitCaseTest(Test, IndentLevel, OptDescs, O);
730       O << ") {\n";
731     }
732
733     ++i;
734     if (i == numArgs)
735       throw "Case construct handler: no corresponding action "
736         "found for the test " + Test.getAsString() + '!';
737
738     Callback(d->getArg(i), IndentLevel, O);
739     O << IndentLevel << "}\n";
740   }
741 }
742
743 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
744 /// implement EmitOptionPropertyHandlingCode(). Emits code for
745 /// handling the (forward) option property.
746 void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D,
747                                             std::ostream& O) {
748   switch (D.Type) {
749   case OptionType::Switch:
750     O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
751     break;
752   case OptionType::Parameter:
753     O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
754     O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n";
755     break;
756   case OptionType::Prefix:
757     O << Indent3 << "vec.push_back(\"-" << D.Name << "\" + "
758       << D.GenVariableName() << ");\n";
759     break;
760   case OptionType::PrefixList:
761     O << Indent3 << "for (" << D.GenTypeDeclaration()
762       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
763       << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
764       << Indent4 << "vec.push_back(\"-" << D.Name << "\" + "
765       << "*B);\n";
766     break;
767   case OptionType::ParameterList:
768     O << Indent3 << "for (" << D.GenTypeDeclaration()
769       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
770       << Indent3 << "E = " << D.GenVariableName()
771       << ".end() ; B != E; ++B) {\n"
772       << Indent4 << "vec.push_back(\"-" << D.Name << "\");\n"
773       << Indent4 << "vec.push_back(*B);\n"
774       << Indent3 << "}\n";
775     break;
776   }
777 }
778
779 /// EmitOptionPropertyHandlingCode - Helper function used by
780 /// EmitGenerateActionMethod(). Emits code that handles option
781 /// properties.
782 void EmitOptionPropertyHandlingCode (const ToolProperties& P,
783                                      const ToolOptionDescription& D,
784                                      std::ostream& O)
785 {
786   // Start of the if-clause.
787   O << Indent2 << "if (";
788   if (D.Type == OptionType::Switch)
789     O << D.GenVariableName();
790   else
791     O << '!' << D.GenVariableName() << ".empty()";
792
793   O <<") {\n";
794
795   // Handle option properties that take an argument.
796   for (OptionPropertyList::const_iterator B = D.Props.begin(),
797         E = D.Props.end(); B!=E; ++B) {
798     const OptionProperty& val = *B;
799
800     switch (val.first) {
801       // (append_cmd cmd) property
802     case OptionPropertyType::AppendCmd:
803       O << Indent3 << "vec.push_back(\"" << val.second << "\");\n";
804       break;
805       // Other properties with argument
806     default:
807       break;
808     }
809   }
810
811   // Handle flags
812
813   // (forward) property
814   if (D.isForward())
815     EmitForwardOptionPropertyHandlingCode(D, O);
816
817   // (unpack_values) property
818   if (D.isUnpackValues()) {
819     if (IsListOptionType(D.Type)) {
820       O << Indent3 << "for (" << D.GenTypeDeclaration()
821         << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
822         << Indent3 << "E = " << D.GenVariableName()
823         << ".end(); B != E; ++B)\n"
824         << Indent4 << "llvm::SplitString(*B, vec, \",\");\n";
825     }
826     else if (D.Type == OptionType::Prefix || D.Type == OptionType::Parameter){
827       O << Indent3 << "llvm::SplitString("
828         << D.GenVariableName() << ", vec, \",\");\n";
829     }
830     else {
831       throw std::string("Switches can't have unpack_values property!");
832     }
833   }
834
835   // End of the if-clause.
836   O << Indent2 << "}\n";
837 }
838
839 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
840                         bool Version, const char* IndentLevel,
841                         std::ostream& O) {
842   StrVector StrVec;
843   SplitString(InitPtrToString(CmdLine), StrVec);
844   if (InitPtrToString(CmdLine).empty())
845     throw "Tool " + ToolName + " has empty command line!";
846
847   StrVector::const_iterator I = StrVec.begin();
848   ++I;
849   for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
850     const std::string& cmd = *I;
851     O << IndentLevel;
852     if (cmd == "$INFILE") {
853       if (Version)
854         O << "for (PathVector::const_iterator B = inFiles.begin()"
855           << ", E = inFiles.end();\n"
856           << IndentLevel << "B != E; ++B)\n"
857           << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
858       else
859         O << "vec.push_back(inFile.toString());\n";
860     }
861     else if (cmd == "$OUTFILE") {
862       O << "vec.push_back(outFile.toString());\n";
863     }
864     else {
865       O << "vec.push_back(\"" << cmd << "\");\n";
866     }
867   }
868   O << IndentLevel << "ret = Action(\"" << StrVec.at(0) << "\", vec);\n";
869 }
870
871 class EmitCmdLineVecFillCallback {
872   bool Version;
873   const std::string& ToolName;
874  public:
875   EmitCmdLineVecFillCallback(bool Ver, const std::string& TN)
876     : Version(Ver), ToolName(TN) {}
877
878   void operator()(const Init* Statement, const char* IndentLevel,
879                   std::ostream& O) const
880   {
881     EmitCmdLineVecFill(Statement, ToolName, Version, IndentLevel, O);
882   }
883 };
884
885 // EmitGenerateActionMethod - Emit one of two versions of the
886 // Tool::GenerateAction() method.
887 void EmitGenerateActionMethod (const ToolProperties& P,
888                                const GlobalOptionDescriptions& OptDescs,
889                                bool Version, std::ostream& O) {
890   if (Version)
891     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
892   else
893     O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
894
895   O << Indent2 << "const sys::Path& outFile,\n"
896     << Indent2 << "const InputLanguagesSet& InLangs) const\n"
897     << Indent1 << "{\n"
898     << Indent2 << "Action ret;\n"
899     << Indent2 << "std::vector<std::string> vec;\n";
900
901   // cmd_line is either a string or a 'case' construct.
902   if (typeid(*P.CmdLine) == typeid(StringInit))
903     EmitCmdLineVecFill(P.CmdLine, P.Name, Version, Indent2, O);
904   else
905     EmitCaseConstructHandler(&InitPtrToDagInitRef(P.CmdLine), Indent2,
906                              EmitCmdLineVecFillCallback(Version, P.Name),
907                              OptDescs, O);
908
909   // For every understood option, emit handling code.
910   for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
911         E = P.OptDescs.end(); B != E; ++B) {
912     const ToolOptionDescription& val = B->second;
913     EmitOptionPropertyHandlingCode(P, val, O);
914   }
915
916   // Handle the Sink property.
917   if (P.isSink()) {
918     O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
919       << Indent3 << "vec.insert(vec.end(), "
920       << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
921       << Indent2 << "}\n";
922   }
923
924   O << Indent2 << "return ret;\n"
925     << Indent1 << "}\n\n";
926 }
927
928 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
929 /// a given Tool class.
930 void EmitGenerateActionMethods (const ToolProperties& P,
931                                 const GlobalOptionDescriptions& OptDescs,
932                                 std::ostream& O) {
933   if (!P.isJoin())
934     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
935       << Indent2 << "const llvm::sys::Path& outFile,\n"
936       << Indent2 << "const InputLanguagesSet& InLangs) const\n"
937       << Indent1 << "{\n"
938       << Indent2 << "throw std::runtime_error(\"" << P.Name
939       << " is not a Join tool!\");\n"
940       << Indent1 << "}\n\n";
941   else
942     EmitGenerateActionMethod(P, OptDescs, true, O);
943
944   EmitGenerateActionMethod(P, OptDescs, false, O);
945 }
946
947 /// EmitIsLastMethod - Emit the IsLast() method for a given Tool
948 /// class.
949 void EmitIsLastMethod (const ToolProperties& P, std::ostream& O) {
950   O << Indent1 << "bool IsLast() const {\n"
951     << Indent2 << "bool last = false;\n";
952
953   for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
954         E = P.OptDescs.end(); B != E; ++B) {
955     const ToolOptionDescription& val = B->second;
956
957     if (val.isStopCompilation())
958       O << Indent2
959         << "if (" << val.GenVariableName()
960         << ")\n" << Indent3 << "last = true;\n";
961   }
962
963   O << Indent2 << "return last;\n"
964     << Indent1 <<  "}\n\n";
965 }
966
967 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
968 /// methods for a given Tool class.
969 void EmitInOutLanguageMethods (const ToolProperties& P, std::ostream& O) {
970   O << Indent1 << "const char* InputLanguage() const {\n"
971     << Indent2 << "return \"" << P.InLanguage << "\";\n"
972     << Indent1 << "}\n\n";
973
974   O << Indent1 << "const char* OutputLanguage() const {\n"
975     << Indent2 << "return \"" << P.OutLanguage << "\";\n"
976     << Indent1 << "}\n\n";
977 }
978
979 /// EmitOutputSuffixMethod - Emit the OutputSuffix() method for a
980 /// given Tool class.
981 void EmitOutputSuffixMethod (const ToolProperties& P, std::ostream& O) {
982   O << Indent1 << "const char* OutputSuffix() const {\n"
983     << Indent2 << "return \"" << P.OutputSuffix << "\";\n"
984     << Indent1 << "}\n\n";
985 }
986
987 /// EmitNameMethod - Emit the Name() method for a given Tool class.
988 void EmitNameMethod (const ToolProperties& P, std::ostream& O) {
989   O << Indent1 << "const char* Name() const {\n"
990     << Indent2 << "return \"" << P.Name << "\";\n"
991     << Indent1 << "}\n\n";
992 }
993
994 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
995 /// class.
996 void EmitIsJoinMethod (const ToolProperties& P, std::ostream& O) {
997   O << Indent1 << "bool IsJoin() const {\n";
998   if (P.isJoin())
999     O << Indent2 << "return true;\n";
1000   else
1001     O << Indent2 << "return false;\n";
1002   O << Indent1 << "}\n\n";
1003 }
1004
1005 /// EmitToolClassDefinition - Emit a Tool class definition.
1006 void EmitToolClassDefinition (const ToolProperties& P,
1007                               const GlobalOptionDescriptions& OptDescs,
1008                               std::ostream& O) {
1009   if (P.Name == "root")
1010     return;
1011
1012   // Header
1013   O << "class " << P.Name << " : public ";
1014   if (P.isJoin())
1015     O << "JoinTool";
1016   else
1017     O << "Tool";
1018   O << " {\npublic:\n";
1019
1020   EmitNameMethod(P, O);
1021   EmitInOutLanguageMethods(P, O);
1022   EmitOutputSuffixMethod(P, O);
1023   EmitIsJoinMethod(P, O);
1024   EmitGenerateActionMethods(P, OptDescs, O);
1025   EmitIsLastMethod(P, O);
1026
1027   // Close class definition
1028   O << "};\n\n";
1029 }
1030
1031 /// EmitOptionDescriptions - Iterate over a list of option
1032 /// descriptions and emit registration code.
1033 void EmitOptionDescriptions (const GlobalOptionDescriptions& descs,
1034                              std::ostream& O)
1035 {
1036   // Emit static cl::Option variables
1037   for (GlobalOptionDescriptions::const_iterator B = descs.begin(),
1038          E = descs.end(); B!=E; ++B) {
1039     const GlobalOptionDescription& val = B->second;
1040
1041     O << val.GenTypeDeclaration() << ' '
1042       << val.GenVariableName()
1043       << "(\"" << val.Name << '\"';
1044
1045     if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1046       O << ", cl::Prefix";
1047
1048     if (val.isRequired()) {
1049       switch (val.Type) {
1050       case OptionType::PrefixList:
1051       case OptionType::ParameterList:
1052         O << ", cl::OneOrMore";
1053         break;
1054       default:
1055         O << ", cl::Required";
1056       }
1057     }
1058
1059     O << ", cl::desc(\"" << val.Help << "\"));\n";
1060   }
1061
1062   if (descs.HasSink)
1063     O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
1064
1065   O << '\n';
1066 }
1067
1068 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1069 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1070 {
1071   // Get the relevant field out of RecordKeeper
1072   Record* LangMapRecord = Records.getDef("LanguageMap");
1073   if (!LangMapRecord)
1074     throw std::string("Language map definition not found!");
1075
1076   ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1077   if (!LangsToSuffixesList)
1078     throw std::string("Error in the language map definition!");
1079
1080   // Generate code
1081   O << "void llvmc::PopulateLanguageMap(LanguageMap& language_map) {\n";
1082
1083   for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1084     Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1085
1086     const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1087     const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1088
1089     for (unsigned i = 0; i < Suffixes->size(); ++i)
1090       O << Indent1 << "language_map[\""
1091         << InitPtrToString(Suffixes->getElement(i))
1092         << "\"] = \"" << Lang << "\";\n";
1093   }
1094
1095   O << "}\n\n";
1096 }
1097
1098 /// FillInToolToLang - Fills in two tables that map tool names to
1099 /// (input, output) languages.  Used by the typechecker.
1100 void FillInToolToLang (const ToolPropertiesList& TPList,
1101                        StringMap<std::string>& ToolToInLang,
1102                        StringMap<std::string>& ToolToOutLang) {
1103   for (ToolPropertiesList::const_iterator B = TPList.begin(), E = TPList.end();
1104        B != E; ++B) {
1105     const ToolProperties& P = *(*B);
1106     ToolToInLang[P.Name] = P.InLanguage;
1107     ToolToOutLang[P.Name] = P.OutLanguage;
1108   }
1109 }
1110
1111 /// TypecheckGraph - Check that names for output and input languages
1112 /// on all edges do match.
1113 // TOFIX: check for cycles.
1114 // TOFIX: check for multiple default edges.
1115 void TypecheckGraph (Record* CompilationGraph,
1116                      const ToolPropertiesList& TPList) {
1117   StringMap<std::string> ToolToInLang;
1118   StringMap<std::string> ToolToOutLang;
1119
1120   FillInToolToLang(TPList, ToolToInLang, ToolToOutLang);
1121   ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1122   StringMap<std::string>::iterator IAE = ToolToInLang.end();
1123   StringMap<std::string>::iterator IBE = ToolToOutLang.end();
1124
1125   for (unsigned i = 0; i < edges->size(); ++i) {
1126     Record* Edge = edges->getElementAsRecord(i);
1127     Record* A = Edge->getValueAsDef("a");
1128     Record* B = Edge->getValueAsDef("b");
1129     StringMap<std::string>::iterator IA = ToolToOutLang.find(A->getName());
1130     StringMap<std::string>::iterator IB = ToolToInLang.find(B->getName());
1131     if (IA == IAE)
1132       throw A->getName() + ": no such tool!";
1133     if (IB == IBE)
1134       throw B->getName() + ": no such tool!";
1135     if (A->getName() != "root" && IA->second != IB->second)
1136       throw "Edge " + A->getName() + "->" + B->getName()
1137         + ": output->input language mismatch";
1138     if (B->getName() == "root")
1139       throw std::string("Edges back to the root are not allowed!");
1140   }
1141 }
1142
1143 // Helper function passed to EmitCaseConstructHandler by EmitEdgeClass.
1144 void IncDecWeight (const Init* i, const char* IndentLevel,
1145                    std::ostream& O) {
1146   const DagInit& d = InitPtrToDagInitRef(i);
1147   const std::string& OpName = d.getOperator()->getAsString();
1148
1149   if (OpName == "inc_weight")
1150     O << IndentLevel << Indent1 << "ret += ";
1151   else if (OpName == "dec_weight")
1152     O << IndentLevel << Indent1 << "ret -= ";
1153   else
1154     throw "Unknown operator in edge properties list: " + OpName + '!';
1155
1156   if (d.getNumArgs() > 0)
1157     O << InitPtrToInt(d.getArg(0)) << ";\n";
1158   else
1159     O << "2;\n";
1160
1161 }
1162
1163 /// EmitEdgeClass - Emit a single Edge# class.
1164 void EmitEdgeClass (unsigned N, const std::string& Target,
1165                     DagInit* Case, const GlobalOptionDescriptions& OptDescs,
1166                     std::ostream& O) {
1167
1168   // Class constructor.
1169   O << "class Edge" << N << ": public Edge {\n"
1170     << "public:\n"
1171     << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1172     << "\") {}\n\n"
1173
1174   // Function Weight().
1175     << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1176     << Indent2 << "unsigned ret = 0;\n";
1177
1178   // Handle the 'case' construct.
1179   EmitCaseConstructHandler(Case, Indent2, IncDecWeight, OptDescs, O);
1180
1181   O << Indent2 << "return ret;\n"
1182     << Indent1 << "};\n\n};\n\n";
1183 }
1184
1185 // Emit Edge* classes that represent graph edges.
1186 void EmitEdgeClasses (Record* CompilationGraph,
1187                       const GlobalOptionDescriptions& OptDescs,
1188                       std::ostream& O) {
1189   ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1190
1191   for (unsigned i = 0; i < edges->size(); ++i) {
1192     Record* Edge = edges->getElementAsRecord(i);
1193     Record* B = Edge->getValueAsDef("b");
1194     DagInit* Weight = Edge->getValueAsDag("weight");
1195
1196     if (isDagEmpty(Weight))
1197       continue;
1198
1199     EmitEdgeClass(i, B->getName(), Weight, OptDescs, O);
1200   }
1201 }
1202
1203 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1204 /// function.
1205 void EmitPopulateCompilationGraph (Record* CompilationGraph,
1206                                    std::ostream& O)
1207 {
1208   ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1209
1210   // Generate code
1211   O << "void llvmc::PopulateCompilationGraph(CompilationGraph& G) {\n"
1212     << Indent1 << "PopulateLanguageMap(G.ExtsToLangs);\n\n";
1213
1214   // Insert vertices
1215
1216   RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1217   if (Tools.empty())
1218     throw std::string("No tool definitions found!");
1219
1220   for (RecordVector::iterator B = Tools.begin(), E = Tools.end(); B != E; ++B) {
1221     const std::string& Name = (*B)->getName();
1222     if (Name != "root")
1223       O << Indent1 << "G.insertNode(new "
1224         << Name << "());\n";
1225   }
1226
1227   O << '\n';
1228
1229   // Insert edges
1230   for (unsigned i = 0; i < edges->size(); ++i) {
1231     Record* Edge = edges->getElementAsRecord(i);
1232     Record* A = Edge->getValueAsDef("a");
1233     Record* B = Edge->getValueAsDef("b");
1234     DagInit* Weight = Edge->getValueAsDag("weight");
1235
1236     O << Indent1 << "G.insertEdge(\"" << A->getName() << "\", ";
1237
1238     if (isDagEmpty(Weight))
1239       O << "new SimpleEdge(\"" << B->getName() << "\")";
1240     else
1241       O << "new Edge" << i << "()";
1242
1243     O << ");\n";
1244   }
1245
1246   O << "}\n\n";
1247 }
1248
1249
1250 // End of anonymous namespace
1251 }
1252
1253 /// run - The back-end entry point.
1254 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1255
1256   // Emit file header.
1257   EmitSourceFileHeader("LLVMC Configuration Library", O);
1258
1259   // Get a list of all defined Tools.
1260   RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1261   if (Tools.empty())
1262     throw std::string("No tool definitions found!");
1263
1264   // Gather information from the Tool description dags.
1265   ToolPropertiesList tool_props;
1266   GlobalOptionDescriptions opt_descs;
1267   CollectToolProperties(Tools.begin(), Tools.end(), tool_props, opt_descs);
1268
1269   // Emit global option registration code.
1270   EmitOptionDescriptions(opt_descs, O);
1271
1272   // Emit PopulateLanguageMap() function
1273   // (a language map maps from file extensions to language names).
1274   EmitPopulateLanguageMap(Records, O);
1275
1276   // Emit Tool classes.
1277   for (ToolPropertiesList::const_iterator B = tool_props.begin(),
1278          E = tool_props.end(); B!=E; ++B)
1279     EmitToolClassDefinition(*(*B), opt_descs, O);
1280
1281   Record* CompilationGraphRecord = Records.getDef("CompilationGraph");
1282   if (!CompilationGraphRecord)
1283     throw std::string("Compilation graph description not found!");
1284
1285   // Typecheck the compilation graph.
1286   TypecheckGraph(CompilationGraphRecord, tool_props);
1287
1288   // Emit Edge# classes.
1289   EmitEdgeClasses(CompilationGraphRecord, opt_descs, O);
1290
1291   // Emit PopulateCompilationGraph() function.
1292   EmitPopulateCompilationGraph(CompilationGraphRecord, O);
1293
1294   // EOF
1295 }