eda45c7a7b7386188e9f8d0b3fc83450a9a9e1cb
[oota-llvm.git] / utils / TableGen / LLVMCConfigurationEmitter.cpp
1 //===- LLVMCConfigurationEmitter.cpp - Generate LLVMC config ----*- C++ -*-===//
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/ADT/StringSet.h"
22 #include "llvm/Support/Streams.h"
23
24 #include <algorithm>
25 #include <cassert>
26 #include <functional>
27 #include <stdexcept>
28 #include <string>
29 #include <typeinfo>
30
31 using namespace llvm;
32
33 namespace {
34
35 //===----------------------------------------------------------------------===//
36 /// Typedefs
37
38 typedef std::vector<Record*> RecordVector;
39 typedef std::vector<std::string> StrVector;
40
41 //===----------------------------------------------------------------------===//
42 /// Constants
43
44 // Indentation strings.
45 const char * Indent1 = "    ";
46 const char * Indent2 = "        ";
47 const char * Indent3 = "            ";
48
49 // Default help string.
50 const char * DefaultHelpString = "NO HELP MESSAGE PROVIDED";
51
52 // Name for the "sink" option.
53 const char * SinkOptionName = "AutoGeneratedSinkOption";
54
55 //===----------------------------------------------------------------------===//
56 /// Helper functions
57
58 /// Id - An 'identity' function object.
59 struct Id {
60   template<typename T>
61   void operator()(const T&) const {
62   }
63 };
64
65 int InitPtrToInt(const Init* ptr) {
66   const IntInit& val = dynamic_cast<const IntInit&>(*ptr);
67   return val.getValue();
68 }
69
70 const std::string& InitPtrToString(const Init* ptr) {
71   const StringInit& val = dynamic_cast<const StringInit&>(*ptr);
72   return val.getValue();
73 }
74
75 const ListInit& InitPtrToList(const Init* ptr) {
76   const ListInit& val = dynamic_cast<const ListInit&>(*ptr);
77   return val;
78 }
79
80 const DagInit& InitPtrToDag(const Init* ptr) {
81   const DagInit& val = dynamic_cast<const DagInit&>(*ptr);
82   return val;
83 }
84
85 // checkNumberOfArguments - Ensure that the number of args in d is
86 // less than or equal to min_arguments, otherwise throw an exception.
87 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
88   if (d->getNumArgs() < min_arguments)
89     throw "Property " + d->getOperator()->getAsString()
90       + " has too few arguments!";
91 }
92
93 // isDagEmpty - is this DAG marked with an empty marker?
94 bool isDagEmpty (const DagInit* d) {
95   return d->getOperator()->getAsString() == "empty";
96 }
97
98 // EscapeVariableName - Escape commas and other symbols not allowed
99 // in the C++ variable names. Makes it possible to use options named
100 // like "Wa," (useful for prefix options).
101 std::string EscapeVariableName(const std::string& Var) {
102   std::string ret;
103   for (unsigned i = 0; i != Var.size(); ++i) {
104     char cur_char = Var[i];
105     if (cur_char == ',') {
106       ret += "_comma_";
107     }
108     else if (cur_char == '+') {
109       ret += "_plus_";
110     }
111     else if (cur_char == '-') {
112       ret += "_dash_";
113     }
114     else {
115       ret.push_back(cur_char);
116     }
117   }
118   return ret;
119 }
120
121 //===----------------------------------------------------------------------===//
122 /// Back-end specific code
123
124
125 /// OptionType - One of six different option types. See the
126 /// documentation for detailed description of differences.
127 /// Extern* options are those that are defined in some other plugin.
128 namespace OptionType {
129   enum OptionType { Alias, Switch, Parameter, ParameterList,
130                     Prefix, PrefixList,
131                     ExternSwitch, ExternParameter, ExternList };
132
133 bool IsList (OptionType t) {
134   return (t == ParameterList || t == PrefixList || t == ExternList);
135 }
136
137 bool IsSwitch (OptionType t) {
138   return (t == Switch || t == ExternSwitch);
139 }
140
141 bool IsParameter (OptionType t) {
142   return (t == Parameter || t == Prefix || t == ExternParameter);
143 }
144
145 }
146
147 OptionType::OptionType stringToOptionType(const std::string& T) {
148   if (T == "alias_option")
149     return OptionType::Alias;
150   else if (T == "switch_option")
151     return OptionType::Switch;
152   else if (T == "parameter_option")
153     return OptionType::Parameter;
154   else if (T == "parameter_list_option")
155     return OptionType::ParameterList;
156   else if (T == "prefix_option")
157     return OptionType::Prefix;
158   else if (T == "prefix_list_option")
159     return OptionType::PrefixList;
160   else if (T == "extern_switch")
161     return OptionType::ExternSwitch;
162   else if (T == "extern_parameter")
163     return OptionType::ExternParameter;
164   else if (T == "extern_list")
165     return OptionType::ExternList;
166   else
167     throw "Unknown option type: " + T + '!';
168 }
169
170 namespace OptionDescriptionFlags {
171   enum OptionDescriptionFlags { Required = 0x1, Hidden = 0x2,
172                                 ReallyHidden = 0x4 };
173 }
174
175 /// OptionDescription - Represents data contained in a single
176 /// OptionList entry.
177 struct OptionDescription {
178   OptionType::OptionType Type;
179   std::string Name;
180   unsigned Flags;
181   std::string Help;
182
183   OptionDescription(OptionType::OptionType t = OptionType::Switch,
184                     const std::string& n = "",
185                     const std::string& h = DefaultHelpString)
186     : Type(t), Name(n), Flags(0x0), Help(h)
187   {}
188
189   /// GenTypeDeclaration - Returns the C++ variable type of this
190   /// option.
191   const char* GenTypeDeclaration() const;
192
193   /// GenVariableName - Returns the variable name used in the
194   /// generated C++ code.
195   std::string GenVariableName() const;
196
197   /// Merge - Merge two option descriptions.
198   void Merge (const OptionDescription& other);
199
200   // Misc convenient getters/setters.
201
202   bool isAlias() const;
203   bool isExtern() const;
204
205   bool isRequired() const;
206   void setRequired();
207
208   bool isHidden() const;
209   void setHidden();
210
211   bool isReallyHidden() const;
212   void setReallyHidden();
213 };
214
215 void OptionDescription::Merge (const OptionDescription& other)
216 {
217   if (other.Type != Type)
218     throw "Conflicting definitions for the option " + Name + "!";
219
220   if (Help == other.Help || Help == DefaultHelpString)
221     Help = other.Help;
222   else if (other.Help != DefaultHelpString) {
223     llvm::cerr << "Warning: several different help strings"
224       " defined for option " + Name + "\n";
225   }
226
227   Flags |= other.Flags;
228 }
229
230 bool OptionDescription::isAlias() const {
231   return Type == OptionType::Alias;
232 }
233
234 bool OptionDescription::isExtern() const {
235   return (Type == OptionType::ExternList || Type == OptionType::ExternParameter
236           || Type == OptionType::ExternSwitch);
237 }
238
239 bool OptionDescription::isRequired() const {
240   return Flags & OptionDescriptionFlags::Required;
241 }
242 void OptionDescription::setRequired() {
243   Flags |= OptionDescriptionFlags::Required;
244 }
245
246 bool OptionDescription::isHidden() const {
247   return Flags & OptionDescriptionFlags::Hidden;
248 }
249 void OptionDescription::setHidden() {
250   Flags |= OptionDescriptionFlags::Hidden;
251 }
252
253 bool OptionDescription::isReallyHidden() const {
254   return Flags & OptionDescriptionFlags::ReallyHidden;
255 }
256 void OptionDescription::setReallyHidden() {
257   Flags |= OptionDescriptionFlags::ReallyHidden;
258 }
259
260 const char* OptionDescription::GenTypeDeclaration() const {
261   switch (Type) {
262   case OptionType::Alias:
263     return "cl::alias";
264   case OptionType::ExternList:
265   case OptionType::PrefixList:
266   case OptionType::ParameterList:
267     return "cl::list<std::string>";
268   case OptionType::Switch:
269   case OptionType::ExternSwitch:
270     return "cl::opt<bool>";
271   case OptionType::ExternParameter:
272   case OptionType::Parameter:
273   case OptionType::Prefix:
274   default:
275     return "cl::opt<std::string>";
276   }
277 }
278
279 std::string OptionDescription::GenVariableName() const {
280   const std::string& EscapedName = EscapeVariableName(Name);
281   switch (Type) {
282   case OptionType::Alias:
283     return "AutoGeneratedAlias_" + EscapedName;
284   case OptionType::PrefixList:
285   case OptionType::ParameterList:
286   case OptionType::ExternList:
287     return "AutoGeneratedList_" + EscapedName;
288   case OptionType::ExternSwitch:
289   case OptionType::Switch:
290     return "AutoGeneratedSwitch_" + EscapedName;
291   case OptionType::ExternParameter:
292   case OptionType::Prefix:
293   case OptionType::Parameter:
294   default:
295     return "AutoGeneratedParameter_" + EscapedName;
296   }
297 }
298
299 /// OptionDescriptions - An OptionDescription array plus some helper
300 /// functions.
301 class OptionDescriptions {
302   typedef StringMap<OptionDescription> container_type;
303
304   /// Descriptions - A list of OptionDescriptions.
305   container_type Descriptions;
306
307 public:
308   /// FindOption - exception-throwing wrapper for find().
309   const OptionDescription& FindOption(const std::string& OptName) const;
310
311   /// insertDescription - Insert new OptionDescription into
312   /// OptionDescriptions list
313   void InsertDescription (const OptionDescription& o);
314
315   // Support for STL-style iteration
316   typedef container_type::const_iterator const_iterator;
317   const_iterator begin() const { return Descriptions.begin(); }
318   const_iterator end() const { return Descriptions.end(); }
319 };
320
321 const OptionDescription&
322 OptionDescriptions::FindOption(const std::string& OptName) const
323 {
324   const_iterator I = Descriptions.find(OptName);
325   if (I != Descriptions.end())
326     return I->second;
327   else
328     throw OptName + ": no such option!";
329 }
330
331 void OptionDescriptions::InsertDescription (const OptionDescription& o)
332 {
333   container_type::iterator I = Descriptions.find(o.Name);
334   if (I != Descriptions.end()) {
335     OptionDescription& D = I->second;
336     D.Merge(o);
337   }
338   else {
339     Descriptions[o.Name] = o;
340   }
341 }
342
343 /// HandlerTable - A base class for function objects implemented as
344 /// 'tables of handlers'.
345 template <class T>
346 class HandlerTable {
347 protected:
348   // Implementation details.
349
350   /// Handler -
351   typedef void (T::* Handler) (const DagInit*);
352   /// HandlerMap - A map from property names to property handlers
353   typedef StringMap<Handler> HandlerMap;
354
355   static HandlerMap Handlers_;
356   static bool staticMembersInitialized_;
357
358   T* childPtr;
359 public:
360
361   HandlerTable(T* cp) : childPtr(cp)
362   {}
363
364   /// operator() - Just forwards to the corresponding property
365   /// handler.
366   void operator() (Init* i) {
367     const DagInit& property = InitPtrToDag(i);
368     const std::string& property_name = property.getOperator()->getAsString();
369     typename HandlerMap::iterator method = Handlers_.find(property_name);
370
371     if (method != Handlers_.end()) {
372       Handler h = method->second;
373       (childPtr->*h)(&property);
374     }
375     else {
376       throw "No handler found for property " + property_name + "!";
377     }
378   }
379
380   void AddHandler(const char* Property, Handler Handl) {
381     Handlers_[Property] = Handl;
382   }
383 };
384
385 template <class T> typename HandlerTable<T>::HandlerMap
386 HandlerTable<T>::Handlers_;
387 template <class T> bool HandlerTable<T>::staticMembersInitialized_ = false;
388
389
390 /// CollectOptionProperties - Function object for iterating over an
391 /// option property list.
392 class CollectOptionProperties : public HandlerTable<CollectOptionProperties> {
393 private:
394
395   /// optDescs_ - OptionDescriptions table. This is where the
396   /// information is stored.
397   OptionDescription& optDesc_;
398
399 public:
400
401   explicit CollectOptionProperties(OptionDescription& OD)
402     : HandlerTable<CollectOptionProperties>(this), optDesc_(OD)
403   {
404     if (!staticMembersInitialized_) {
405       AddHandler("help", &CollectOptionProperties::onHelp);
406       AddHandler("hidden", &CollectOptionProperties::onHidden);
407       AddHandler("really_hidden", &CollectOptionProperties::onReallyHidden);
408       AddHandler("required", &CollectOptionProperties::onRequired);
409
410       staticMembersInitialized_ = true;
411     }
412   }
413
414 private:
415
416   /// Option property handlers --
417   /// Methods that handle option properties such as (help) or (hidden).
418
419   void onHelp (const DagInit* d) {
420     checkNumberOfArguments(d, 1);
421     const std::string& help_message = InitPtrToString(d->getArg(0));
422     optDesc_.Help = help_message;
423   }
424
425   void onHidden (const DagInit* d) {
426     checkNumberOfArguments(d, 0);
427     checkToolProps(d);
428     optDesc_.setHidden();
429   }
430
431   void onReallyHidden (const DagInit* d) {
432     checkNumberOfArguments(d, 0);
433     checkToolProps(d);
434     optDesc_.setReallyHidden();
435   }
436
437   void onRequired (const DagInit* d) {
438     checkNumberOfArguments(d, 0);
439     checkToolProps(d);
440     optDesc_.setRequired();
441   }
442
443   // Helper functions
444
445   /// checkToolProps - Throw an error if toolProps_ == 0.
446   void checkToolProps(const DagInit* d) {
447     if (!d)
448       throw "Option property " + d->getOperator()->getAsString()
449         + " can't be used in this context";
450   }
451
452 };
453
454 /// AddOption - A function object that is applied to every option
455 /// description. Used by CollectOptionDescriptions.
456 class AddOption {
457 private:
458   OptionDescriptions& OptDescs_;
459
460 public:
461   explicit AddOption(OptionDescriptions& OD) : OptDescs_(OD)
462   {}
463
464   void operator()(const Init* i) {
465     const DagInit& d = InitPtrToDag(i);
466     checkNumberOfArguments(&d, 1);
467
468     const OptionType::OptionType Type =
469       stringToOptionType(d.getOperator()->getAsString());
470     const std::string& Name = InitPtrToString(d.getArg(0));
471
472     OptionDescription OD(Type, Name);
473
474     if (!OD.isExtern())
475       checkNumberOfArguments(&d, 2);
476
477     if (OD.isAlias()) {
478       // Aliases store the aliased option name in the 'Help' field.
479       OD.Help = InitPtrToString(d.getArg(1));
480     }
481     else if (!OD.isExtern()) {
482       processOptionProperties(&d, OD);
483     }
484     OptDescs_.InsertDescription(OD);
485   }
486
487 private:
488   /// processOptionProperties - Go through the list of option
489   /// properties and call a corresponding handler for each.
490   static void processOptionProperties (const DagInit* d, OptionDescription& o) {
491     checkNumberOfArguments(d, 2);
492     DagInit::const_arg_iterator B = d->arg_begin();
493     // Skip the first argument: it's always the option name.
494     ++B;
495     std::for_each(B, d->arg_end(), CollectOptionProperties(o));
496   }
497
498 };
499
500 /// CollectOptionDescriptions - Collects option properties from all
501 /// OptionLists.
502 void CollectOptionDescriptions (RecordVector::const_iterator B,
503                                 RecordVector::const_iterator E,
504                                 OptionDescriptions& OptDescs)
505 {
506   // For every OptionList:
507   for (; B!=E; ++B) {
508     RecordVector::value_type T = *B;
509     // Throws an exception if the value does not exist.
510     ListInit* PropList = T->getValueAsListInit("options");
511
512     // For every option description in this list:
513     // collect the information and
514     std::for_each(PropList->begin(), PropList->end(), AddOption(OptDescs));
515   }
516 }
517
518 // Tool information record
519
520 namespace ToolFlags {
521   enum ToolFlags { Join = 0x1, Sink = 0x2 };
522 }
523
524 struct ToolDescription : public RefCountedBase<ToolDescription> {
525   std::string Name;
526   Init* CmdLine;
527   Init* Actions;
528   StrVector InLanguage;
529   std::string OutLanguage;
530   std::string OutputSuffix;
531   unsigned Flags;
532
533   // Various boolean properties
534   void setSink()      { Flags |= ToolFlags::Sink; }
535   bool isSink() const { return Flags & ToolFlags::Sink; }
536   void setJoin()      { Flags |= ToolFlags::Join; }
537   bool isJoin() const { return Flags & ToolFlags::Join; }
538
539   // Default ctor here is needed because StringMap can only store
540   // DefaultConstructible objects
541   ToolDescription() : CmdLine(0), Actions(0), Flags(0) {}
542   ToolDescription (const std::string& n)
543   : Name(n), CmdLine(0), Actions(0), Flags(0)
544   {}
545 };
546
547 /// ToolDescriptions - A list of Tool information records.
548 typedef std::vector<IntrusiveRefCntPtr<ToolDescription> > ToolDescriptions;
549
550
551 /// CollectToolProperties - Function object for iterating over a list of
552 /// tool property records.
553 class CollectToolProperties : public HandlerTable<CollectToolProperties> {
554 private:
555
556   /// toolDesc_ - Properties of the current Tool. This is where the
557   /// information is stored.
558   ToolDescription& toolDesc_;
559
560 public:
561
562   explicit CollectToolProperties (ToolDescription& d)
563     : HandlerTable<CollectToolProperties>(this) , toolDesc_(d)
564   {
565     if (!staticMembersInitialized_) {
566
567       AddHandler("actions", &CollectToolProperties::onActions);
568       AddHandler("cmd_line", &CollectToolProperties::onCmdLine);
569       AddHandler("in_language", &CollectToolProperties::onInLanguage);
570       AddHandler("join", &CollectToolProperties::onJoin);
571       AddHandler("out_language", &CollectToolProperties::onOutLanguage);
572       AddHandler("output_suffix", &CollectToolProperties::onOutputSuffix);
573       AddHandler("sink", &CollectToolProperties::onSink);
574
575       staticMembersInitialized_ = true;
576     }
577   }
578
579 private:
580
581   /// Property handlers --
582   /// Functions that extract information about tool properties from
583   /// DAG representation.
584
585   void onActions (const DagInit* d) {
586     checkNumberOfArguments(d, 1);
587     Init* Case = d->getArg(0);
588     if (typeid(*Case) != typeid(DagInit) ||
589         static_cast<DagInit*>(Case)->getOperator()->getAsString() != "case")
590       throw
591         std::string("The argument to (actions) should be a 'case' construct!");
592     toolDesc_.Actions = Case;
593   }
594
595   void onCmdLine (const DagInit* d) {
596     checkNumberOfArguments(d, 1);
597     toolDesc_.CmdLine = d->getArg(0);
598   }
599
600   void onInLanguage (const DagInit* d) {
601     checkNumberOfArguments(d, 1);
602     Init* arg = d->getArg(0);
603
604     // Find out the argument's type.
605     if (typeid(*arg) == typeid(StringInit)) {
606       // It's a string.
607       toolDesc_.InLanguage.push_back(InitPtrToString(arg));
608     }
609     else {
610       // It's a list.
611       const ListInit& lst = InitPtrToList(arg);
612       StrVector& out = toolDesc_.InLanguage;
613
614       // Copy strings to the output vector.
615       for (ListInit::const_iterator B = lst.begin(), E = lst.end();
616            B != E; ++B) {
617         out.push_back(InitPtrToString(*B));
618       }
619
620       // Remove duplicates.
621       std::sort(out.begin(), out.end());
622       StrVector::iterator newE = std::unique(out.begin(), out.end());
623       out.erase(newE, out.end());
624     }
625   }
626
627   void onJoin (const DagInit* d) {
628     checkNumberOfArguments(d, 0);
629     toolDesc_.setJoin();
630   }
631
632   void onOutLanguage (const DagInit* d) {
633     checkNumberOfArguments(d, 1);
634     toolDesc_.OutLanguage = InitPtrToString(d->getArg(0));
635   }
636
637   void onOutputSuffix (const DagInit* d) {
638     checkNumberOfArguments(d, 1);
639     toolDesc_.OutputSuffix = InitPtrToString(d->getArg(0));
640   }
641
642   void onSink (const DagInit* d) {
643     checkNumberOfArguments(d, 0);
644     toolDesc_.setSink();
645   }
646
647 };
648
649
650 /// CollectToolDescriptions - Gather information about tool properties
651 /// from the parsed TableGen data (basically a wrapper for the
652 /// CollectToolProperties function object).
653 void CollectToolDescriptions (RecordVector::const_iterator B,
654                               RecordVector::const_iterator E,
655                               ToolDescriptions& ToolDescs)
656 {
657   // Iterate over a properties list of every Tool definition
658   for (;B!=E;++B) {
659     const Record* T = *B;
660     // Throws an exception if the value does not exist.
661     ListInit* PropList = T->getValueAsListInit("properties");
662
663     IntrusiveRefCntPtr<ToolDescription>
664       ToolDesc(new ToolDescription(T->getName()));
665
666     std::for_each(PropList->begin(), PropList->end(),
667                   CollectToolProperties(*ToolDesc));
668     ToolDescs.push_back(ToolDesc);
669   }
670 }
671
672 /// FillInEdgeVector - Merge all compilation graph definitions into
673 /// one single edge list.
674 void FillInEdgeVector(RecordVector::const_iterator B,
675                       RecordVector::const_iterator E, RecordVector& Out) {
676   for (; B != E; ++B) {
677     const ListInit* edges = (*B)->getValueAsListInit("edges");
678
679     for (unsigned i = 0; i < edges->size(); ++i)
680       Out.push_back(edges->getElementAsRecord(i));
681   }
682 }
683
684 /// CalculatePriority - Calculate the priority of this plugin.
685 int CalculatePriority(RecordVector::const_iterator B,
686                       RecordVector::const_iterator E) {
687   int total = 0;
688   for (; B!=E; ++B) {
689     total += static_cast<int>((*B)->getValueAsInt("priority"));
690   }
691   return total;
692 }
693
694 /// NotInGraph - Helper function object for FilterNotInGraph.
695 struct NotInGraph {
696 private:
697   const llvm::StringSet<>& ToolsInGraph_;
698
699 public:
700   NotInGraph(const llvm::StringSet<>& ToolsInGraph)
701   : ToolsInGraph_(ToolsInGraph)
702   {}
703
704   bool operator()(const IntrusiveRefCntPtr<ToolDescription>& x) {
705     return (ToolsInGraph_.count(x->Name) == 0);
706   }
707 };
708
709 /// FilterNotInGraph - Filter out from ToolDescs all Tools not
710 /// mentioned in the compilation graph definition.
711 void FilterNotInGraph (const RecordVector& EdgeVector,
712                        ToolDescriptions& ToolDescs) {
713
714   // List all tools mentioned in the graph.
715   llvm::StringSet<> ToolsInGraph;
716
717   for (RecordVector::const_iterator B = EdgeVector.begin(),
718          E = EdgeVector.end(); B != E; ++B) {
719
720     const Record* Edge = *B;
721     const std::string& NodeA = Edge->getValueAsString("a");
722     const std::string& NodeB = Edge->getValueAsString("b");
723
724     if (NodeA != "root")
725       ToolsInGraph.insert(NodeA);
726     ToolsInGraph.insert(NodeB);
727   }
728
729   // Filter ToolPropertiesList.
730   ToolDescriptions::iterator new_end =
731     std::remove_if(ToolDescs.begin(), ToolDescs.end(),
732                    NotInGraph(ToolsInGraph));
733   ToolDescs.erase(new_end, ToolDescs.end());
734 }
735
736 /// FillInToolToLang - Fills in two tables that map tool names to
737 /// (input, output) languages.  Helper function used by TypecheckGraph().
738 void FillInToolToLang (const ToolDescriptions& ToolDescs,
739                        StringMap<StringSet<> >& ToolToInLang,
740                        StringMap<std::string>& ToolToOutLang) {
741   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
742          E = ToolDescs.end(); B != E; ++B) {
743     const ToolDescription& D = *(*B);
744     for (StrVector::const_iterator B = D.InLanguage.begin(),
745            E = D.InLanguage.end(); B != E; ++B)
746       ToolToInLang[D.Name].insert(*B);
747     ToolToOutLang[D.Name] = D.OutLanguage;
748   }
749 }
750
751 /// TypecheckGraph - Check that names for output and input languages
752 /// on all edges do match. This doesn't do much when the information
753 /// about the whole graph is not available (i.e. when compiling most
754 /// plugins).
755 void TypecheckGraph (const RecordVector& EdgeVector,
756                      const ToolDescriptions& ToolDescs) {
757   StringMap<StringSet<> > ToolToInLang;
758   StringMap<std::string> ToolToOutLang;
759
760   FillInToolToLang(ToolDescs, ToolToInLang, ToolToOutLang);
761   StringMap<std::string>::iterator IAE = ToolToOutLang.end();
762   StringMap<StringSet<> >::iterator IBE = ToolToInLang.end();
763
764   for (RecordVector::const_iterator B = EdgeVector.begin(),
765          E = EdgeVector.end(); B != E; ++B) {
766     const Record* Edge = *B;
767     const std::string& NodeA = Edge->getValueAsString("a");
768     const std::string& NodeB = Edge->getValueAsString("b");
769     StringMap<std::string>::iterator IA = ToolToOutLang.find(NodeA);
770     StringMap<StringSet<> >::iterator IB = ToolToInLang.find(NodeB);
771
772     if (NodeA != "root") {
773       if (IA != IAE && IB != IBE && IB->second.count(IA->second) == 0)
774         throw "Edge " + NodeA + "->" + NodeB
775           + ": output->input language mismatch";
776     }
777
778     if (NodeB == "root")
779       throw std::string("Edges back to the root are not allowed!");
780   }
781 }
782
783 /// WalkCase - Walks the 'case' expression DAG and invokes
784 /// TestCallback on every test, and StatementCallback on every
785 /// statement. Handles 'case' nesting, but not the 'and' and 'or'
786 /// combinators.
787 // TODO: Re-implement EmitCaseConstructHandler on top of this function?
788 template <typename F1, typename F2>
789 void WalkCase(Init* Case, F1 TestCallback, F2 StatementCallback) {
790   const DagInit& d = InitPtrToDag(Case);
791   bool even = false;
792   for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
793        B != E; ++B) {
794     Init* arg = *B;
795     if (even && dynamic_cast<DagInit*>(arg)
796         && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case")
797       WalkCase(arg, TestCallback, StatementCallback);
798     else if (!even)
799       TestCallback(arg);
800     else
801       StatementCallback(arg);
802     even = !even;
803   }
804 }
805
806 /// ExtractOptionNames - A helper function object used by
807 /// CheckForSuperfluousOptions() to walk the 'case' DAG.
808 class ExtractOptionNames {
809   llvm::StringSet<>& OptionNames_;
810
811   void processDag(const Init* Statement) {
812     const DagInit& Stmt = InitPtrToDag(Statement);
813     const std::string& ActionName = Stmt.getOperator()->getAsString();
814     if (ActionName == "forward" || ActionName == "forward_as" ||
815         ActionName == "unpack_values" || ActionName == "switch_on" ||
816         ActionName == "parameter_equals" || ActionName == "element_in_list" ||
817         ActionName == "not_empty") {
818       checkNumberOfArguments(&Stmt, 1);
819       const std::string& Name = InitPtrToString(Stmt.getArg(0));
820       OptionNames_.insert(Name);
821     }
822     else if (ActionName == "and" || ActionName == "or") {
823       for (unsigned i = 0, NumArgs = Stmt.getNumArgs(); i < NumArgs; ++i) {
824         this->processDag(Stmt.getArg(i));
825       }
826     }
827   }
828
829 public:
830   ExtractOptionNames(llvm::StringSet<>& OptionNames) : OptionNames_(OptionNames)
831   {}
832
833   void operator()(const Init* Statement) {
834     if (typeid(*Statement) == typeid(ListInit)) {
835       const ListInit& DagList = *static_cast<const ListInit*>(Statement);
836       for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
837            B != E; ++B)
838         this->processDag(*B);
839     }
840     else {
841       this->processDag(Statement);
842     }
843   }
844 };
845
846 /// CheckForSuperfluousOptions - Check that there are no side
847 /// effect-free options (specified only in the OptionList). Otherwise,
848 /// output a warning.
849 void CheckForSuperfluousOptions (const RecordVector& Edges,
850                                  const ToolDescriptions& ToolDescs,
851                                  const OptionDescriptions& OptDescs) {
852   llvm::StringSet<> nonSuperfluousOptions;
853
854   // Add all options mentioned in the ToolDesc.Actions to the set of
855   // non-superfluous options.
856   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
857          E = ToolDescs.end(); B != E; ++B) {
858     const ToolDescription& TD = *(*B);
859     ExtractOptionNames Callback(nonSuperfluousOptions);
860     if (TD.Actions)
861       WalkCase(TD.Actions, Callback, Callback);
862   }
863
864   // Add all options mentioned in the 'case' clauses of the
865   // OptionalEdges of the compilation graph to the set of
866   // non-superfluous options.
867   for (RecordVector::const_iterator B = Edges.begin(), E = Edges.end();
868        B != E; ++B) {
869     const Record* Edge = *B;
870     DagInit* Weight = Edge->getValueAsDag("weight");
871
872     if (!isDagEmpty(Weight))
873       WalkCase(Weight, ExtractOptionNames(nonSuperfluousOptions), Id());
874   }
875
876   // Check that all options in OptDescs belong to the set of
877   // non-superfluous options.
878   for (OptionDescriptions::const_iterator B = OptDescs.begin(),
879          E = OptDescs.end(); B != E; ++B) {
880     const OptionDescription& Val = B->second;
881     if (!nonSuperfluousOptions.count(Val.Name)
882         && Val.Type != OptionType::Alias)
883       llvm::cerr << "Warning: option '-" << Val.Name << "' has no effect! "
884         "Probable cause: this option is specified only in the OptionList.\n";
885   }
886 }
887
888 /// EmitCaseTest1Arg - Helper function used by
889 /// EmitCaseConstructHandler.
890 bool EmitCaseTest1Arg(const std::string& TestName,
891                       const DagInit& d,
892                       const OptionDescriptions& OptDescs,
893                       std::ostream& O) {
894   checkNumberOfArguments(&d, 1);
895   const std::string& OptName = InitPtrToString(d.getArg(0));
896   if (TestName == "switch_on") {
897     const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
898     if (!OptionType::IsSwitch(OptDesc.Type))
899       throw OptName + ": incorrect option type - should be a switch!";
900     O << OptDesc.GenVariableName();
901     return true;
902   } else if (TestName == "input_languages_contain") {
903     O << "InLangs.count(\"" << OptName << "\") != 0";
904     return true;
905   } else if (TestName == "in_language") {
906     // This works only for single-argument Tool::GenerateAction. Join
907     // tools can process several files in different languages simultaneously.
908
909     // TODO: make this work with Edge::Weight (if possible).
910     O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"';
911     return true;
912   } else if (TestName == "not_empty") {
913     if (OptName == "o") {
914       O << "!OutputFilename.empty()";
915       return true;
916     }
917     else {
918       const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
919       if (OptionType::IsSwitch(OptDesc.Type))
920         throw OptName
921           + ": incorrect option type - should be a list or parameter!";
922       O << '!' << OptDesc.GenVariableName() << ".empty()";
923       return true;
924     }
925   }
926
927   return false;
928 }
929
930 /// EmitCaseTest2Args - Helper function used by
931 /// EmitCaseConstructHandler.
932 bool EmitCaseTest2Args(const std::string& TestName,
933                        const DagInit& d,
934                        const char* IndentLevel,
935                        const OptionDescriptions& OptDescs,
936                        std::ostream& O) {
937   checkNumberOfArguments(&d, 2);
938   const std::string& OptName = InitPtrToString(d.getArg(0));
939   const std::string& OptArg = InitPtrToString(d.getArg(1));
940   const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
941
942   if (TestName == "parameter_equals") {
943     if (!OptionType::IsParameter(OptDesc.Type))
944       throw OptName + ": incorrect option type - should be a parameter!";
945     O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
946     return true;
947   }
948   else if (TestName == "element_in_list") {
949     if (!OptionType::IsList(OptDesc.Type))
950       throw OptName + ": incorrect option type - should be a list!";
951     const std::string& VarName = OptDesc.GenVariableName();
952     O << "std::find(" << VarName << ".begin(),\n"
953       << IndentLevel << Indent1 << VarName << ".end(), \""
954       << OptArg << "\") != " << VarName << ".end()";
955     return true;
956   }
957
958   return false;
959 }
960
961 // Forward declaration.
962 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
963 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
964                   const OptionDescriptions& OptDescs,
965                   std::ostream& O);
966
967 /// EmitLogicalOperationTest - Helper function used by
968 /// EmitCaseConstructHandler.
969 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
970                               const char* IndentLevel,
971                               const OptionDescriptions& OptDescs,
972                               std::ostream& O) {
973   O << '(';
974   for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
975     const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
976     EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
977     if (j != NumArgs - 1)
978       O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
979     else
980       O << ')';
981   }
982 }
983
984 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
985 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
986                   const OptionDescriptions& OptDescs,
987                   std::ostream& O) {
988   const std::string& TestName = d.getOperator()->getAsString();
989
990   if (TestName == "and")
991     EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
992   else if (TestName == "or")
993     EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
994   else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
995     return;
996   else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
997     return;
998   else
999     throw TestName + ": unknown edge property!";
1000 }
1001
1002 // Emit code that handles the 'case' construct.
1003 // Takes a function object that should emit code for every case clause.
1004 // Callback's type is
1005 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
1006 template <typename F>
1007 void EmitCaseConstructHandler(const Init* Dag, const char* IndentLevel,
1008                               F Callback, bool EmitElseIf,
1009                               const OptionDescriptions& OptDescs,
1010                               std::ostream& O) {
1011   const DagInit* d = &InitPtrToDag(Dag);
1012   if (d->getOperator()->getAsString() != "case")
1013     throw std::string("EmitCaseConstructHandler should be invoked"
1014                       " only on 'case' expressions!");
1015
1016   unsigned numArgs = d->getNumArgs();
1017   if (d->getNumArgs() < 2)
1018     throw "There should be at least one clause in the 'case' expression:\n"
1019       + d->getAsString();
1020
1021   for (unsigned i = 0; i != numArgs; ++i) {
1022     const DagInit& Test = InitPtrToDag(d->getArg(i));
1023
1024     // Emit the test.
1025     if (Test.getOperator()->getAsString() == "default") {
1026       if (i+2 != numArgs)
1027         throw std::string("The 'default' clause should be the last in the"
1028                           "'case' construct!");
1029       O << IndentLevel << "else {\n";
1030     }
1031     else {
1032       O << IndentLevel << ((i != 0 && EmitElseIf) ? "else if (" : "if (");
1033       EmitCaseTest(Test, IndentLevel, OptDescs, O);
1034       O << ") {\n";
1035     }
1036
1037     // Emit the corresponding statement.
1038     ++i;
1039     if (i == numArgs)
1040       throw "Case construct handler: no corresponding action "
1041         "found for the test " + Test.getAsString() + '!';
1042
1043     Init* arg = d->getArg(i);
1044     const DagInit* nd = dynamic_cast<DagInit*>(arg);
1045     if (nd && (nd->getOperator()->getAsString() == "case")) {
1046       // Handle the nested 'case'.
1047       EmitCaseConstructHandler(nd, (std::string(IndentLevel) + Indent1).c_str(),
1048                                Callback, EmitElseIf, OptDescs, O);
1049     }
1050     else {
1051       Callback(arg, (std::string(IndentLevel) + Indent1).c_str(), O);
1052     }
1053     O << IndentLevel << "}\n";
1054   }
1055 }
1056
1057 /// SubstituteSpecialCommands - Perform string substitution for $CALL
1058 /// and $ENV. Helper function used by EmitCmdLineVecFill().
1059 std::string SubstituteSpecialCommands(const std::string& cmd) {
1060   size_t cparen = cmd.find(")");
1061   std::string ret;
1062
1063   if (cmd.find("$CALL(") == 0) {
1064     if (cmd.size() == 6)
1065       throw std::string("$CALL invocation: empty argument list!");
1066
1067     ret += "hooks::";
1068     ret += std::string(cmd.begin() + 6, cmd.begin() + cparen);
1069     ret += "()";
1070   }
1071   else if (cmd.find("$ENV(") == 0) {
1072     if (cmd.size() == 5)
1073       throw std::string("$ENV invocation: empty argument list!");
1074
1075     ret += "checkCString(std::getenv(\"";
1076     ret += std::string(cmd.begin() + 5, cmd.begin() + cparen);
1077     ret += "\"))";
1078   }
1079   else {
1080     throw "Unknown special command: " + cmd;
1081   }
1082
1083   if (cmd.begin() + cparen + 1 != cmd.end()) {
1084     ret += " + std::string(\"";
1085     ret += (cmd.c_str() + cparen + 1);
1086     ret += "\")";
1087   }
1088
1089   return ret;
1090 }
1091
1092 /// EmitCmdLineVecFill - Emit code that fills in the command line
1093 /// vector. Helper function used by EmitGenerateActionMethod().
1094 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
1095                         bool IsJoin, const char* IndentLevel,
1096                         std::ostream& O) {
1097   StrVector StrVec;
1098   SplitString(InitPtrToString(CmdLine), StrVec);
1099   if (StrVec.empty())
1100     throw "Tool " + ToolName + " has empty command line!";
1101
1102   StrVector::const_iterator I = StrVec.begin();
1103   ++I;
1104   for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
1105     const std::string& cmd = *I;
1106     O << IndentLevel;
1107     if (cmd.at(0) == '$') {
1108       if (cmd == "$INFILE") {
1109         if (IsJoin)
1110           O << "for (PathVector::const_iterator B = inFiles.begin()"
1111             << ", E = inFiles.end();\n"
1112             << IndentLevel << "B != E; ++B)\n"
1113             << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
1114         else
1115           O << "vec.push_back(inFile.toString());\n";
1116       }
1117       else if (cmd == "$OUTFILE") {
1118         O << "vec.push_back(out_file);\n";
1119       }
1120       else {
1121         O << "vec.push_back(" << SubstituteSpecialCommands(cmd);
1122         O << ");\n";
1123       }
1124     }
1125     else {
1126       O << "vec.push_back(\"" << cmd << "\");\n";
1127     }
1128   }
1129   O << IndentLevel << "cmd = "
1130     << ((StrVec[0][0] == '$') ? SubstituteSpecialCommands(StrVec[0])
1131         : "\"" + StrVec[0] + "\"")
1132     << ";\n";
1133 }
1134
1135 /// EmitCmdLineVecFillCallback - A function object wrapper around
1136 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
1137 /// argument to EmitCaseConstructHandler().
1138 class EmitCmdLineVecFillCallback {
1139   bool IsJoin;
1140   const std::string& ToolName;
1141  public:
1142   EmitCmdLineVecFillCallback(bool J, const std::string& TN)
1143     : IsJoin(J), ToolName(TN) {}
1144
1145   void operator()(const Init* Statement, const char* IndentLevel,
1146                   std::ostream& O) const
1147   {
1148     EmitCmdLineVecFill(Statement, ToolName, IsJoin,
1149                        IndentLevel, O);
1150   }
1151 };
1152
1153 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
1154 /// implement EmitActionHandler. Emits code for
1155 /// handling the (forward) and (forward_as) option properties.
1156 void EmitForwardOptionPropertyHandlingCode (const OptionDescription& D,
1157                                             const char* Indent,
1158                                             const std::string& NewName,
1159                                             std::ostream& O) {
1160   const std::string& Name = NewName.empty()
1161     ? ("-" + D.Name)
1162     : NewName;
1163
1164   switch (D.Type) {
1165   case OptionType::Switch:
1166   case OptionType::ExternSwitch:
1167     O << Indent << "vec.push_back(\"" << Name << "\");\n";
1168     break;
1169   case OptionType::Parameter:
1170   case OptionType::ExternParameter:
1171     O << Indent << "vec.push_back(\"" << Name << "\");\n";
1172     O << Indent << "vec.push_back(" << D.GenVariableName() << ");\n";
1173     break;
1174   case OptionType::Prefix:
1175     O << Indent << "vec.push_back(\"" << Name << "\" + "
1176       << D.GenVariableName() << ");\n";
1177     break;
1178   case OptionType::PrefixList:
1179     O << Indent << "for (" << D.GenTypeDeclaration()
1180       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1181       << Indent << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
1182       << Indent << Indent1 << "vec.push_back(\"" << Name << "\" + "
1183       << "*B);\n";
1184     break;
1185   case OptionType::ParameterList:
1186   case OptionType::ExternList:
1187     O << Indent << "for (" << D.GenTypeDeclaration()
1188       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1189       << Indent << "E = " << D.GenVariableName()
1190       << ".end() ; B != E; ++B) {\n"
1191       << Indent << Indent1 << "vec.push_back(\"" << Name << "\");\n"
1192       << Indent << Indent1 << "vec.push_back(*B);\n"
1193       << Indent << "}\n";
1194     break;
1195   case OptionType::Alias:
1196   default:
1197     throw std::string("Aliases are not allowed in tool option descriptions!");
1198   }
1199 }
1200
1201 /// EmitActionHandler - Emit code that handles actions. Used by
1202 /// EmitGenerateActionMethod() as an argument to
1203 /// EmitCaseConstructHandler().
1204 class EmitActionHandler {
1205   const OptionDescriptions& OptDescs;
1206
1207   void processActionDag(const Init* Statement, const char* IndentLevel,
1208                         std::ostream& O) const
1209   {
1210     const DagInit& Dag = InitPtrToDag(Statement);
1211     const std::string& ActionName = Dag.getOperator()->getAsString();
1212
1213     if (ActionName == "append_cmd") {
1214       checkNumberOfArguments(&Dag, 1);
1215       const std::string& Cmd = InitPtrToString(Dag.getArg(0));
1216       O << IndentLevel << "vec.push_back(\"" << Cmd << "\");\n";
1217     }
1218     else if (ActionName == "forward") {
1219       checkNumberOfArguments(&Dag, 1);
1220       const std::string& Name = InitPtrToString(Dag.getArg(0));
1221       EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1222                                             IndentLevel, "", O);
1223     }
1224     else if (ActionName == "forward_as") {
1225       checkNumberOfArguments(&Dag, 2);
1226       const std::string& Name = InitPtrToString(Dag.getArg(0));
1227       const std::string& NewName = InitPtrToString(Dag.getArg(0));
1228       EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1229                                             IndentLevel, NewName, O);
1230     }
1231     else if (ActionName == "output_suffix") {
1232       checkNumberOfArguments(&Dag, 1);
1233       const std::string& OutSuf = InitPtrToString(Dag.getArg(0));
1234       O << IndentLevel << "output_suffix = \"" << OutSuf << "\";\n";
1235     }
1236     else if (ActionName == "stop_compilation") {
1237       O << IndentLevel << "stop_compilation = true;\n";
1238     }
1239     else if (ActionName == "unpack_values") {
1240       checkNumberOfArguments(&Dag, 1);
1241       const std::string& Name = InitPtrToString(Dag.getArg(0));
1242       const OptionDescription& D = OptDescs.FindOption(Name);
1243
1244       if (OptionType::IsList(D.Type)) {
1245         O << IndentLevel << "for (" << D.GenTypeDeclaration()
1246           << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1247           << IndentLevel << "E = " << D.GenVariableName()
1248           << ".end(); B != E; ++B)\n"
1249           << IndentLevel << Indent1 << "llvm::SplitString(*B, vec, \",\");\n";
1250       }
1251       else if (OptionType::IsParameter(D.Type)){
1252         O << Indent3 << "llvm::SplitString("
1253           << D.GenVariableName() << ", vec, \",\");\n";
1254       }
1255       else {
1256         throw "Option '" + D.Name +
1257           "': switches can't have the 'unpack_values' property!";
1258       }
1259     }
1260     else {
1261       throw "Unknown action name: " + ActionName + "!";
1262     }
1263   }
1264  public:
1265   EmitActionHandler(const OptionDescriptions& OD)
1266     : OptDescs(OD) {}
1267
1268   void operator()(const Init* Statement, const char* IndentLevel,
1269                   std::ostream& O) const
1270   {
1271     if (typeid(*Statement) == typeid(ListInit)) {
1272       const ListInit& DagList = *static_cast<const ListInit*>(Statement);
1273       for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
1274            B != E; ++B)
1275         this->processActionDag(*B, IndentLevel, O);
1276     }
1277     else {
1278       this->processActionDag(Statement, IndentLevel, O);
1279     }
1280   }
1281 };
1282
1283 // EmitGenerateActionMethod - Emit one of two versions of the
1284 // Tool::GenerateAction() method.
1285 void EmitGenerateActionMethod (const ToolDescription& D,
1286                                const OptionDescriptions& OptDescs,
1287                                bool IsJoin, std::ostream& O) {
1288   if (IsJoin)
1289     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
1290   else
1291     O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
1292
1293   O << Indent2 << "bool HasChildren,\n"
1294     << Indent2 << "const llvm::sys::Path& TempDir,\n"
1295     << Indent2 << "const InputLanguagesSet& InLangs,\n"
1296     << Indent2 << "const LanguageMap& LangMap) const\n"
1297     << Indent1 << "{\n"
1298     << Indent2 << "std::string cmd;\n"
1299     << Indent2 << "std::vector<std::string> vec;\n"
1300     << Indent2 << "bool stop_compilation = !HasChildren;\n"
1301     << Indent2 << "const char* output_suffix = \"" << D.OutputSuffix << "\";\n"
1302     << Indent2 << "std::string out_file;\n\n";
1303
1304   // For every understood option, emit handling code.
1305   if (D.Actions)
1306     EmitCaseConstructHandler(D.Actions, Indent2, EmitActionHandler(OptDescs),
1307                              false, OptDescs, O);
1308
1309   O << '\n' << Indent2
1310     << "out_file = OutFilename(" << (IsJoin ? "sys::Path(),\n" : "inFile,\n")
1311     << Indent3 << "TempDir, stop_compilation, output_suffix).toString();\n\n";
1312
1313   // cmd_line is either a string or a 'case' construct.
1314   if (!D.CmdLine)
1315     throw "Tool " + D.Name + " has no cmd_line property!";
1316   else if (typeid(*D.CmdLine) == typeid(StringInit))
1317     EmitCmdLineVecFill(D.CmdLine, D.Name, IsJoin, Indent2, O);
1318   else
1319     EmitCaseConstructHandler(D.CmdLine, Indent2,
1320                              EmitCmdLineVecFillCallback(IsJoin, D.Name),
1321                              true, OptDescs, O);
1322
1323   // Handle the Sink property.
1324   if (D.isSink()) {
1325     O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
1326       << Indent3 << "vec.insert(vec.end(), "
1327       << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
1328       << Indent2 << "}\n";
1329   }
1330
1331   O << Indent2 << "return Action(cmd, vec, stop_compilation, out_file);\n"
1332     << Indent1 << "}\n\n";
1333 }
1334
1335 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
1336 /// a given Tool class.
1337 void EmitGenerateActionMethods (const ToolDescription& ToolDesc,
1338                                 const OptionDescriptions& OptDescs,
1339                                 std::ostream& O) {
1340   if (!ToolDesc.isJoin())
1341     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
1342       << Indent2 << "bool HasChildren,\n"
1343       << Indent2 << "const llvm::sys::Path& TempDir,\n"
1344       << Indent2 << "const InputLanguagesSet& InLangs,\n"
1345       << Indent2 << "const LanguageMap& LangMap) const\n"
1346       << Indent1 << "{\n"
1347       << Indent2 << "throw std::runtime_error(\"" << ToolDesc.Name
1348       << " is not a Join tool!\");\n"
1349       << Indent1 << "}\n\n";
1350   else
1351     EmitGenerateActionMethod(ToolDesc, OptDescs, true, O);
1352
1353   EmitGenerateActionMethod(ToolDesc, OptDescs, false, O);
1354 }
1355
1356 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1357 /// methods for a given Tool class.
1358 void EmitInOutLanguageMethods (const ToolDescription& D, std::ostream& O) {
1359   O << Indent1 << "const char** InputLanguages() const {\n"
1360     << Indent2 << "return InputLanguages_;\n"
1361     << Indent1 << "}\n\n";
1362
1363   if (D.OutLanguage.empty())
1364     throw "Tool " + D.Name + " has no 'out_language' property!";
1365
1366   O << Indent1 << "const char* OutputLanguage() const {\n"
1367     << Indent2 << "return \"" << D.OutLanguage << "\";\n"
1368     << Indent1 << "}\n\n";
1369 }
1370
1371 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1372 void EmitNameMethod (const ToolDescription& D, std::ostream& O) {
1373   O << Indent1 << "const char* Name() const {\n"
1374     << Indent2 << "return \"" << D.Name << "\";\n"
1375     << Indent1 << "}\n\n";
1376 }
1377
1378 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1379 /// class.
1380 void EmitIsJoinMethod (const ToolDescription& D, std::ostream& O) {
1381   O << Indent1 << "bool IsJoin() const {\n";
1382   if (D.isJoin())
1383     O << Indent2 << "return true;\n";
1384   else
1385     O << Indent2 << "return false;\n";
1386   O << Indent1 << "}\n\n";
1387 }
1388
1389 /// EmitStaticMemberDefinitions - Emit static member definitions for a
1390 /// given Tool class.
1391 void EmitStaticMemberDefinitions(const ToolDescription& D, std::ostream& O) {
1392   if (D.InLanguage.empty())
1393     throw "Tool " + D.Name + " has no 'in_language' property!";
1394
1395   O << "const char* " << D.Name << "::InputLanguages_[] = {";
1396   for (StrVector::const_iterator B = D.InLanguage.begin(),
1397          E = D.InLanguage.end(); B != E; ++B)
1398     O << '\"' << *B << "\", ";
1399   O << "0};\n\n";
1400 }
1401
1402 /// EmitToolClassDefinition - Emit a Tool class definition.
1403 void EmitToolClassDefinition (const ToolDescription& D,
1404                               const OptionDescriptions& OptDescs,
1405                               std::ostream& O) {
1406   if (D.Name == "root")
1407     return;
1408
1409   // Header
1410   O << "class " << D.Name << " : public ";
1411   if (D.isJoin())
1412     O << "JoinTool";
1413   else
1414     O << "Tool";
1415
1416   O << "{\nprivate:\n"
1417     << Indent1 << "static const char* InputLanguages_[];\n\n";
1418
1419   O << "public:\n";
1420   EmitNameMethod(D, O);
1421   EmitInOutLanguageMethods(D, O);
1422   EmitIsJoinMethod(D, O);
1423   EmitGenerateActionMethods(D, OptDescs, O);
1424
1425   // Close class definition
1426   O << "};\n";
1427
1428   EmitStaticMemberDefinitions(D, O);
1429
1430 }
1431
1432 /// EmitOptionDefintions - Iterate over a list of option descriptions
1433 /// and emit registration code.
1434 void EmitOptionDefintions (const OptionDescriptions& descs,
1435                            bool HasSink, bool HasExterns,
1436                            std::ostream& O)
1437 {
1438   std::vector<OptionDescription> Aliases;
1439
1440   // Emit static cl::Option variables.
1441   for (OptionDescriptions::const_iterator B = descs.begin(),
1442          E = descs.end(); B!=E; ++B) {
1443     const OptionDescription& val = B->second;
1444
1445     if (val.Type == OptionType::Alias) {
1446       Aliases.push_back(val);
1447       continue;
1448     }
1449
1450     if (val.isExtern())
1451       O << "extern ";
1452
1453     O << val.GenTypeDeclaration() << ' '
1454       << val.GenVariableName();
1455
1456     if (val.isExtern()) {
1457       O << ";\n";
1458       continue;
1459     }
1460
1461     O << "(\"" << val.Name << '\"';
1462
1463     if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1464       O << ", cl::Prefix";
1465
1466     if (val.isRequired()) {
1467       switch (val.Type) {
1468       case OptionType::PrefixList:
1469       case OptionType::ParameterList:
1470         O << ", cl::OneOrMore";
1471         break;
1472       default:
1473         O << ", cl::Required";
1474       }
1475     }
1476
1477     if (val.isReallyHidden() || val.isHidden()) {
1478       if (val.isRequired())
1479         O << " |";
1480       else
1481         O << ",";
1482       if (val.isReallyHidden())
1483         O << " cl::ReallyHidden";
1484       else
1485         O << " cl::Hidden";
1486     }
1487
1488     if (!val.Help.empty())
1489       O << ", cl::desc(\"" << val.Help << "\")";
1490
1491     O << ");\n";
1492   }
1493
1494   // Emit the aliases (they should go after all the 'proper' options).
1495   for (std::vector<OptionDescription>::const_iterator
1496          B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
1497     const OptionDescription& val = *B;
1498
1499     O << val.GenTypeDeclaration() << ' '
1500       << val.GenVariableName()
1501       << "(\"" << val.Name << '\"';
1502
1503     const OptionDescription& D = descs.FindOption(val.Help);
1504     O << ", cl::aliasopt(" << D.GenVariableName() << ")";
1505
1506     O << ", cl::desc(\"" << "An alias for -" + val.Help  << "\"));\n";
1507   }
1508
1509   // Emit the sink option.
1510   if (HasSink)
1511     O << (HasExterns ? "extern cl" : "cl")
1512       << "::list<std::string> " << SinkOptionName
1513       << (HasExterns ? ";\n" : "(cl::Sink);\n");
1514
1515   O << '\n';
1516 }
1517
1518 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1519 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1520 {
1521   // Generate code
1522   O << "namespace {\n\n";
1523   O << "void PopulateLanguageMapLocal(LanguageMap& langMap) {\n";
1524
1525   // Get the relevant field out of RecordKeeper
1526   const Record* LangMapRecord = Records.getDef("LanguageMap");
1527
1528   // It is allowed for a plugin to have no language map.
1529   if (LangMapRecord) {
1530
1531     ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1532     if (!LangsToSuffixesList)
1533       throw std::string("Error in the language map definition!");
1534
1535     for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1536       const Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1537
1538       const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1539       const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1540
1541       for (unsigned i = 0; i < Suffixes->size(); ++i)
1542         O << Indent1 << "langMap[\""
1543           << InitPtrToString(Suffixes->getElement(i))
1544           << "\"] = \"" << Lang << "\";\n";
1545     }
1546   }
1547
1548   O << "}\n\n}\n\n";
1549 }
1550
1551 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1552 /// by EmitEdgeClass().
1553 void IncDecWeight (const Init* i, const char* IndentLevel,
1554                    std::ostream& O) {
1555   const DagInit& d = InitPtrToDag(i);
1556   const std::string& OpName = d.getOperator()->getAsString();
1557
1558   if (OpName == "inc_weight")
1559     O << IndentLevel << "ret += ";
1560   else if (OpName == "dec_weight")
1561     O << IndentLevel << "ret -= ";
1562   else
1563     throw "Unknown operator in edge properties list: " + OpName + '!';
1564
1565   if (d.getNumArgs() > 0)
1566     O << InitPtrToInt(d.getArg(0)) << ";\n";
1567   else
1568     O << "2;\n";
1569
1570 }
1571
1572 /// EmitEdgeClass - Emit a single Edge# class.
1573 void EmitEdgeClass (unsigned N, const std::string& Target,
1574                     DagInit* Case, const OptionDescriptions& OptDescs,
1575                     std::ostream& O) {
1576
1577   // Class constructor.
1578   O << "class Edge" << N << ": public Edge {\n"
1579     << "public:\n"
1580     << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1581     << "\") {}\n\n"
1582
1583   // Function Weight().
1584     << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1585     << Indent2 << "unsigned ret = 0;\n";
1586
1587   // Handle the 'case' construct.
1588   EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
1589
1590   O << Indent2 << "return ret;\n"
1591     << Indent1 << "};\n\n};\n\n";
1592 }
1593
1594 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1595 void EmitEdgeClasses (const RecordVector& EdgeVector,
1596                       const OptionDescriptions& OptDescs,
1597                       std::ostream& O) {
1598   int i = 0;
1599   for (RecordVector::const_iterator B = EdgeVector.begin(),
1600          E = EdgeVector.end(); B != E; ++B) {
1601     const Record* Edge = *B;
1602     const std::string& NodeB = Edge->getValueAsString("b");
1603     DagInit* Weight = Edge->getValueAsDag("weight");
1604
1605     if (!isDagEmpty(Weight))
1606       EmitEdgeClass(i, NodeB, Weight, OptDescs, O);
1607     ++i;
1608   }
1609 }
1610
1611 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1612 /// function.
1613 void EmitPopulateCompilationGraph (const RecordVector& EdgeVector,
1614                                    const ToolDescriptions& ToolDescs,
1615                                    std::ostream& O)
1616 {
1617   O << "namespace {\n\n";
1618   O << "void PopulateCompilationGraphLocal(CompilationGraph& G) {\n";
1619
1620   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1621          E = ToolDescs.end(); B != E; ++B)
1622     O << Indent1 << "G.insertNode(new " << (*B)->Name << "());\n";
1623
1624   O << '\n';
1625
1626   // Insert edges.
1627
1628   int i = 0;
1629   for (RecordVector::const_iterator B = EdgeVector.begin(),
1630          E = EdgeVector.end(); B != E; ++B) {
1631     const Record* Edge = *B;
1632     const std::string& NodeA = Edge->getValueAsString("a");
1633     const std::string& NodeB = Edge->getValueAsString("b");
1634     DagInit* Weight = Edge->getValueAsDag("weight");
1635
1636     O << Indent1 << "G.insertEdge(\"" << NodeA << "\", ";
1637
1638     if (isDagEmpty(Weight))
1639       O << "new SimpleEdge(\"" << NodeB << "\")";
1640     else
1641       O << "new Edge" << i << "()";
1642
1643     O << ");\n";
1644     ++i;
1645   }
1646
1647   O << "}\n\n}\n\n";
1648 }
1649
1650 /// ExtractHookNames - Extract the hook names from all instances of
1651 /// $CALL(HookName) in the provided command line string. Helper
1652 /// function used by FillInHookNames().
1653 class ExtractHookNames {
1654   llvm::StringSet<>& HookNames_;
1655 public:
1656   ExtractHookNames(llvm::StringSet<>& HookNames)
1657   : HookNames_(HookNames_) {}
1658
1659   void operator()(const Init* CmdLine) {
1660     StrVector cmds;
1661     llvm::SplitString(InitPtrToString(CmdLine), cmds);
1662     for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1663          B != E; ++B) {
1664       const std::string& cmd = *B;
1665       if (cmd.find("$CALL(") == 0) {
1666         if (cmd.size() == 6)
1667           throw std::string("$CALL invocation: empty argument list!");
1668         HookNames_.insert(std::string(cmd.begin() + 6,
1669                                      cmd.begin() + cmd.find(")")));
1670       }
1671     }
1672   }
1673 };
1674
1675 /// FillInHookNames - Actually extract the hook names from all command
1676 /// line strings. Helper function used by EmitHookDeclarations().
1677 void FillInHookNames(const ToolDescriptions& ToolDescs,
1678                      llvm::StringSet<>& HookNames)
1679 {
1680   // For all command lines:
1681   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1682          E = ToolDescs.end(); B != E; ++B) {
1683     const ToolDescription& D = *(*B);
1684     if (!D.CmdLine)
1685       continue;
1686     if (dynamic_cast<StringInit*>(D.CmdLine))
1687       // This is a string.
1688       ExtractHookNames(HookNames).operator()(D.CmdLine);
1689     else
1690       // This is a 'case' construct.
1691       WalkCase(D.CmdLine, Id(), ExtractHookNames(HookNames));
1692   }
1693 }
1694
1695 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1696 /// property records and emit hook function declaration for each
1697 /// instance of $CALL(HookName).
1698 void EmitHookDeclarations(const ToolDescriptions& ToolDescs, std::ostream& O) {
1699   llvm::StringSet<> HookNames;
1700   FillInHookNames(ToolDescs, HookNames);
1701   if (HookNames.empty())
1702     return;
1703
1704   O << "namespace hooks {\n";
1705   for (StringSet<>::const_iterator B = HookNames.begin(), E = HookNames.end();
1706        B != E; ++B)
1707     O << Indent1 << "std::string " << B->first() << "();\n";
1708
1709   O << "}\n\n";
1710 }
1711
1712 /// EmitRegisterPlugin - Emit code to register this plugin.
1713 void EmitRegisterPlugin(int Priority, std::ostream& O) {
1714   O << "namespace {\n\n"
1715     << "struct Plugin : public llvmc::BasePlugin {\n\n"
1716     << Indent1 << "int Priority() const { return " << Priority << "; }\n\n"
1717     << Indent1 << "void PopulateLanguageMap(LanguageMap& langMap) const\n"
1718     << Indent1 << "{ PopulateLanguageMapLocal(langMap); }\n\n"
1719     << Indent1
1720     << "void PopulateCompilationGraph(CompilationGraph& graph) const\n"
1721     << Indent1 << "{ PopulateCompilationGraphLocal(graph); }\n"
1722     << "};\n\n"
1723
1724     << "static llvmc::RegisterPlugin<Plugin> RP;\n\n}\n\n";
1725 }
1726
1727 /// EmitIncludes - Emit necessary #include directives and some
1728 /// additional declarations.
1729 void EmitIncludes(std::ostream& O) {
1730   O << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n"
1731     << "#include \"llvm/CompilerDriver/Plugin.h\"\n"
1732     << "#include \"llvm/CompilerDriver/Tool.h\"\n\n"
1733
1734     << "#include \"llvm/ADT/StringExtras.h\"\n"
1735     << "#include \"llvm/Support/CommandLine.h\"\n\n"
1736
1737     << "#include <cstdlib>\n"
1738     << "#include <stdexcept>\n\n"
1739
1740     << "using namespace llvm;\n"
1741     << "using namespace llvmc;\n\n"
1742
1743     << "extern cl::opt<std::string> OutputFilename;\n\n"
1744
1745     << "inline const char* checkCString(const char* s)\n"
1746     << "{ return s == NULL ? \"\" : s; }\n\n";
1747 }
1748
1749
1750 /// PluginData - Holds all information about a plugin.
1751 struct PluginData {
1752   OptionDescriptions OptDescs;
1753   bool HasSink;
1754   bool HasExterns;
1755   ToolDescriptions ToolDescs;
1756   RecordVector Edges;
1757   int Priority;
1758 };
1759
1760 /// HasSink - Go through the list of tool descriptions and check if
1761 /// there are any with the 'sink' property set.
1762 bool HasSink(const ToolDescriptions& ToolDescs) {
1763   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1764          E = ToolDescs.end(); B != E; ++B)
1765     if ((*B)->isSink())
1766       return true;
1767
1768   return false;
1769 }
1770
1771 /// HasExterns - Go through the list of option descriptions and check
1772 /// if there are any external options.
1773 bool HasExterns(const OptionDescriptions& OptDescs) {
1774  for (OptionDescriptions::const_iterator B = OptDescs.begin(),
1775          E = OptDescs.end(); B != E; ++B)
1776     if (B->second.isExtern())
1777       return true;
1778
1779   return false;
1780 }
1781
1782 /// CollectPluginData - Collect tool and option properties,
1783 /// compilation graph edges and plugin priority from the parse tree.
1784 void CollectPluginData (const RecordKeeper& Records, PluginData& Data) {
1785   // Collect option properties.
1786   const RecordVector& OptionLists =
1787     Records.getAllDerivedDefinitions("OptionList");
1788   CollectOptionDescriptions(OptionLists.begin(), OptionLists.end(),
1789                             Data.OptDescs);
1790
1791   // Collect tool properties.
1792   const RecordVector& Tools = Records.getAllDerivedDefinitions("Tool");
1793   CollectToolDescriptions(Tools.begin(), Tools.end(), Data.ToolDescs);
1794   Data.HasSink = HasSink(Data.ToolDescs);
1795   Data.HasExterns = HasExterns(Data.OptDescs);
1796
1797   // Collect compilation graph edges.
1798   const RecordVector& CompilationGraphs =
1799     Records.getAllDerivedDefinitions("CompilationGraph");
1800   FillInEdgeVector(CompilationGraphs.begin(), CompilationGraphs.end(),
1801                    Data.Edges);
1802
1803   // Calculate the priority of this plugin.
1804   const RecordVector& Priorities =
1805     Records.getAllDerivedDefinitions("PluginPriority");
1806   Data.Priority = CalculatePriority(Priorities.begin(), Priorities.end());
1807 }
1808
1809 /// CheckPluginData - Perform some sanity checks on the collected data.
1810 void CheckPluginData(PluginData& Data) {
1811   // Filter out all tools not mentioned in the compilation graph.
1812   FilterNotInGraph(Data.Edges, Data.ToolDescs);
1813
1814   // Typecheck the compilation graph.
1815   TypecheckGraph(Data.Edges, Data.ToolDescs);
1816
1817   // Check that there are no options without side effects (specified
1818   // only in the OptionList).
1819   CheckForSuperfluousOptions(Data.Edges, Data.ToolDescs, Data.OptDescs);
1820
1821 }
1822
1823 void EmitPluginCode(const PluginData& Data, std::ostream& O) {
1824   // Emit file header.
1825   EmitIncludes(O);
1826
1827   // Emit global option registration code.
1828   EmitOptionDefintions(Data.OptDescs, Data.HasSink, Data.HasExterns, O);
1829
1830   // Emit hook declarations.
1831   EmitHookDeclarations(Data.ToolDescs, O);
1832
1833   // Emit PopulateLanguageMap() function
1834   // (a language map maps from file extensions to language names).
1835   EmitPopulateLanguageMap(Records, O);
1836
1837   // Emit Tool classes.
1838   for (ToolDescriptions::const_iterator B = Data.ToolDescs.begin(),
1839          E = Data.ToolDescs.end(); B!=E; ++B)
1840     EmitToolClassDefinition(*(*B), Data.OptDescs, O);
1841
1842   // Emit Edge# classes.
1843   EmitEdgeClasses(Data.Edges, Data.OptDescs, O);
1844
1845   // Emit PopulateCompilationGraph() function.
1846   EmitPopulateCompilationGraph(Data.Edges, Data.ToolDescs, O);
1847
1848   // Emit code for plugin registration.
1849   EmitRegisterPlugin(Data.Priority, O);
1850
1851   // EOF
1852 }
1853
1854
1855 // End of anonymous namespace
1856 }
1857
1858 /// run - The back-end entry point.
1859 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1860   try {
1861   PluginData Data;
1862
1863   CollectPluginData(Records, Data);
1864   CheckPluginData(Data);
1865
1866   EmitSourceFileHeader("LLVMC Configuration Library", O);
1867   EmitPluginCode(Data, O);
1868
1869   } catch (std::exception& Error) {
1870     throw Error.what() + std::string(" - usually this means a syntax error.");
1871   }
1872 }