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     toolDesc_.Actions = d->getArg(0);
 588   }
 589
 590   void onCmdLine (const DagInit* d) {
 591     checkNumberOfArguments(d, 1);
 592     toolDesc_.CmdLine = d->getArg(0);
 593   }
 594
 595   void onInLanguage (const DagInit* d) {
 596     checkNumberOfArguments(d, 1);
 597     Init* arg = d->getArg(0);
 598
 599     // Find out the argument's type.
 600     if (typeid(*arg) == typeid(StringInit)) {
 601       // It's a string.
 602       toolDesc_.InLanguage.push_back(InitPtrToString(arg));
 603     }
 604     else {
 605       // It's a list.
 606       const ListInit& lst = InitPtrToList(arg);
 607       StrVector& out = toolDesc_.InLanguage;
 608
 609       // Copy strings to the output vector.
 610       for (ListInit::const_iterator B = lst.begin(), E = lst.end();
 611            B != E; ++B) {
 612         out.push_back(InitPtrToString(*B));
 613       }
 614
 615       // Remove duplicates.
 616       std::sort(out.begin(), out.end());
 617       StrVector::iterator newE = std::unique(out.begin(), out.end());
 618       out.erase(newE, out.end());
 619     }
 620   }
 621
 622   void onJoin (const DagInit* d) {
 623     checkNumberOfArguments(d, 0);
 624     toolDesc_.setJoin();
 625   }
 626
 627   void onOutLanguage (const DagInit* d) {
 628     checkNumberOfArguments(d, 1);
 629     toolDesc_.OutLanguage = InitPtrToString(d->getArg(0));
 630   }
 631
 632   void onOutputSuffix (const DagInit* d) {
 633     checkNumberOfArguments(d, 1);
 634     toolDesc_.OutputSuffix = InitPtrToString(d->getArg(0));
 635   }
 636
 637   void onSink (const DagInit* d) {
 638     checkNumberOfArguments(d, 0);
 639     toolDesc_.setSink();
 640   }
 641
 642 };
 643
 644
 645 /// CollectToolDescriptions - Gather information about tool properties
 646 /// from the parsed TableGen data (basically a wrapper for the
 647 /// CollectToolProperties function object).
 648 void CollectToolDescriptions (RecordVector::const_iterator B,
 649                               RecordVector::const_iterator E,
 650                               ToolDescriptions& ToolDescs)
 651 {
 652   // Iterate over a properties list of every Tool definition
 653   for (;B!=E;++B) {
 654     const Record* T = *B;
 655     // Throws an exception if the value does not exist.
 656     ListInit* PropList = T->getValueAsListInit("properties");
 657
 658     IntrusiveRefCntPtr<ToolDescription>
 659       ToolDesc(new ToolDescription(T->getName()));
 660
 661     std::for_each(PropList->begin(), PropList->end(),
 662                   CollectToolProperties(*ToolDesc));
 663     ToolDescs.push_back(ToolDesc);
 664   }
 665 }
 666
 667 /// FillInEdgeVector - Merge all compilation graph definitions into
 668 /// one single edge list.
 669 void FillInEdgeVector(RecordVector::const_iterator B,
 670                       RecordVector::const_iterator E, RecordVector& Out) {
 671   for (; B != E; ++B) {
 672     const ListInit* edges = (*B)->getValueAsListInit("edges");
 673
 674     for (unsigned i = 0; i < edges->size(); ++i)
 675       Out.push_back(edges->getElementAsRecord(i));
 676   }
 677 }
 678
 679 /// CalculatePriority - Calculate the priority of this plugin.
 680 int CalculatePriority(RecordVector::const_iterator B,
 681                       RecordVector::const_iterator E) {
 682   int total = 0;
 683   for (; B!=E; ++B) {
 684     total += static_cast<int>((*B)->getValueAsInt("priority"));
 685   }
 686   return total;
 687 }
 688
 689 /// NotInGraph - Helper function object for FilterNotInGraph.
 690 struct NotInGraph {
 691 private:
 692   const llvm::StringSet<>& ToolsInGraph_;
 693
 694 public:
 695   NotInGraph(const llvm::StringSet<>& ToolsInGraph)
 696   : ToolsInGraph_(ToolsInGraph)
 697   {}
 698
 699   bool operator()(const IntrusiveRefCntPtr<ToolDescription>& x) {
 700     return (ToolsInGraph_.count(x->Name) == 0);
 701   }
 702 };
 703
 704 /// FilterNotInGraph - Filter out from ToolDescs all Tools not
 705 /// mentioned in the compilation graph definition.
 706 void FilterNotInGraph (const RecordVector& EdgeVector,
 707                        ToolDescriptions& ToolDescs) {
 708
 709   // List all tools mentioned in the graph.
 710   llvm::StringSet<> ToolsInGraph;
 711
 712   for (RecordVector::const_iterator B = EdgeVector.begin(),
 713          E = EdgeVector.end(); B != E; ++B) {
 714
 715     const Record* Edge = *B;
 716     const std::string& A = Edge->getValueAsString("a");
 717     const std::string& B = Edge->getValueAsString("b");
 718
 719     if (A != "root")
 720       ToolsInGraph.insert(A);
 721     ToolsInGraph.insert(B);
 722   }
 723
 724   // Filter ToolPropertiesList.
 725   ToolDescriptions::iterator new_end =
 726     std::remove_if(ToolDescs.begin(), ToolDescs.end(),
 727                    NotInGraph(ToolsInGraph));
 728   ToolDescs.erase(new_end, ToolDescs.end());
 729 }
 730
 731 /// FillInToolToLang - Fills in two tables that map tool names to
 732 /// (input, output) languages.  Helper function used by TypecheckGraph().
 733 void FillInToolToLang (const ToolDescriptions& ToolDescs,
 734                        StringMap<StringSet<> >& ToolToInLang,
 735                        StringMap<std::string>& ToolToOutLang) {
 736   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
 737          E = ToolDescs.end(); B != E; ++B) {
 738     const ToolDescription& D = *(*B);
 739     for (StrVector::const_iterator B = D.InLanguage.begin(),
 740            E = D.InLanguage.end(); B != E; ++B)
 741       ToolToInLang[D.Name].insert(*B);
 742     ToolToOutLang[D.Name] = D.OutLanguage;
 743   }
 744 }
 745
 746 /// TypecheckGraph - Check that names for output and input languages
 747 /// on all edges do match. This doesn't do much when the information
 748 /// about the whole graph is not available (i.e. when compiling most
 749 /// plugins).
 750 void TypecheckGraph (const RecordVector& EdgeVector,
 751                      const ToolDescriptions& ToolDescs) {
 752   StringMap<StringSet<> > ToolToInLang;
 753   StringMap<std::string> ToolToOutLang;
 754
 755   FillInToolToLang(ToolDescs, ToolToInLang, ToolToOutLang);
 756   StringMap<std::string>::iterator IAE = ToolToOutLang.end();
 757   StringMap<StringSet<> >::iterator IBE = ToolToInLang.end();
 758
 759   for (RecordVector::const_iterator B = EdgeVector.begin(),
 760          E = EdgeVector.end(); B != E; ++B) {
 761     const Record* Edge = *B;
 762     const std::string& A = Edge->getValueAsString("a");
 763     const std::string& B = Edge->getValueAsString("b");
 764     StringMap<std::string>::iterator IA = ToolToOutLang.find(A);
 765     StringMap<StringSet<> >::iterator IB = ToolToInLang.find(B);
 766
 767     if (A != "root") {
 768       if (IA != IAE && IB != IBE && IB->second.count(IA->second) == 0)
 769         throw "Edge " + A + "->" + B
 770           + ": output->input language mismatch";
 771     }
 772
 773     if (B == "root")
 774       throw std::string("Edges back to the root are not allowed!");
 775   }
 776 }
 777
 778 /// WalkCase - Walks the 'case' expression DAG and invokes
 779 /// TestCallback on every test, and StatementCallback on every
 780 /// statement. Handles 'case' nesting, but not the 'and' and 'or'
 781 /// combinators.
 782 // TODO: Re-implement EmitCaseConstructHandler on top of this function?
 783 template <typename F1, typename F2>
 784 void WalkCase(Init* Case, F1 TestCallback, F2 StatementCallback) {
 785   const DagInit& d = InitPtrToDag(Case);
 786   bool even = false;
 787   for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
 788        B != E; ++B) {
 789     Init* arg = *B;
 790     if (even && dynamic_cast<DagInit*>(arg)
 791         && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case")
 792       WalkCase(arg, TestCallback, StatementCallback);
 793     else if (!even)
 794       TestCallback(arg);
 795     else
 796       StatementCallback(arg);
 797     even = !even;
 798   }
 799 }
 800
 801 /// ExtractOptionNames - A helper function object used by
 802 /// CheckForSuperfluousOptions() to walk the 'case' DAG.
 803 class ExtractOptionNames {
 804   llvm::StringSet<>& OptionNames_;
 805 public:
 806   ExtractOptionNames(llvm::StringSet<>& OptionNames) : OptionNames_(OptionNames)
 807   {}
 808
 809   void operator()(const Init* Statement) {
 810     const DagInit& Stmt = InitPtrToDag(Statement);
 811     const std::string& ActionName = Stmt.getOperator()->getAsString();
 812     if (ActionName == "forward" || ActionName == "forward_as" ||
 813         ActionName == "unpack_values" || ActionName == "switch_on" ||
 814         ActionName == "parameter_equals" || ActionName == "element_in_list" ||
 815         ActionName == "not_empty") {
 816       checkNumberOfArguments(&Stmt, 1);
 817       const std::string& Name = InitPtrToString(Stmt.getArg(0));
 818       OptionNames_.insert(Name);
 819     }
 820     else if (ActionName == "and" || ActionName == "or") {
 821       for (unsigned i = 0, NumArgs = Stmt.getNumArgs(); i < NumArgs; ++i) {
 822         this->operator()(Stmt.getArg(i));
 823       }
 824     }
 825   }
 826 };
 827
 828 /// CheckForSuperfluousOptions - Check that there are no side
 829 /// effect-free options (specified only in the OptionList). Otherwise,
 830 /// output a warning.
 831 void CheckForSuperfluousOptions (const RecordVector& Edges,
 832                                  const ToolDescriptions& ToolDescs,
 833                                  const OptionDescriptions& OptDescs) {
 834   llvm::StringSet<> nonSuperfluousOptions;
 835
 836   // Add all options mentioned in the ToolDesc.Actions to the set of
 837   // non-superfluous options.
 838   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
 839          E = ToolDescs.end(); B != E; ++B) {
 840     const ToolDescription& TD = *(*B);
 841     ExtractOptionNames Callback(nonSuperfluousOptions);
 842     if (TD.Actions)
 843       WalkCase(TD.Actions, Callback, Callback);
 844   }
 845
 846   // Add all options mentioned in the 'case' clauses of the
 847   // OptionalEdges of the compilation graph to the set of
 848   // non-superfluous options.
 849   for (RecordVector::const_iterator B = Edges.begin(), E = Edges.end();
 850        B != E; ++B) {
 851     const Record* Edge = *B;
 852     DagInit* Weight = Edge->getValueAsDag("weight");
 853
 854     if (!isDagEmpty(Weight))
 855       WalkCase(Weight, ExtractOptionNames(nonSuperfluousOptions), Id());
 856   }
 857
 858   // Check that all options in OptDescs belong to the set of
 859   // non-superfluous options.
 860   for (OptionDescriptions::const_iterator B = OptDescs.begin(),
 861          E = OptDescs.end(); B != E; ++B) {
 862     const OptionDescription& Val = B->second;
 863     if (!nonSuperfluousOptions.count(Val.Name)
 864         && Val.Type != OptionType::Alias)
 865       llvm::cerr << "Warning: option '-" << Val.Name << "' has no effect! "
 866         "Probable cause: this option is specified only in the OptionList.\n";
 867   }
 868 }
 869
 870 /// EmitCaseTest1Arg - Helper function used by
 871 /// EmitCaseConstructHandler.
 872 bool EmitCaseTest1Arg(const std::string& TestName,
 873                       const DagInit& d,
 874                       const OptionDescriptions& OptDescs,
 875                       std::ostream& O) {
 876   checkNumberOfArguments(&d, 1);
 877   const std::string& OptName = InitPtrToString(d.getArg(0));
 878   if (TestName == "switch_on") {
 879     const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
 880     if (!OptionType::IsSwitch(OptDesc.Type))
 881       throw OptName + ": incorrect option type - should be a switch!";
 882     O << OptDesc.GenVariableName();
 883     return true;
 884   } else if (TestName == "input_languages_contain") {
 885     O << "InLangs.count(\"" << OptName << "\") != 0";
 886     return true;
 887   } else if (TestName == "in_language") {
 888     // This works only for single-argument Tool::GenerateAction. Join
 889     // tools can process several files in different languages simultaneously.
 890
 891     // TODO: make this work with Edge::Weight (if possible).
 892     O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"';
 893     return true;
 894   } else if (TestName == "not_empty") {
 895     if (OptName == "o") {
 896       O << "!OutputFilename.empty()";
 897       return true;
 898     }
 899     else {
 900       const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
 901       if (OptionType::IsSwitch(OptDesc.Type))
 902         throw OptName
 903           + ": incorrect option type - should be a list or parameter!";
 904       O << '!' << OptDesc.GenVariableName() << ".empty()";
 905       return true;
 906     }
 907   }
 908
 909   return false;
 910 }
 911
 912 /// EmitCaseTest2Args - Helper function used by
 913 /// EmitCaseConstructHandler.
 914 bool EmitCaseTest2Args(const std::string& TestName,
 915                        const DagInit& d,
 916                        const char* IndentLevel,
 917                        const OptionDescriptions& OptDescs,
 918                        std::ostream& O) {
 919   checkNumberOfArguments(&d, 2);
 920   const std::string& OptName = InitPtrToString(d.getArg(0));
 921   const std::string& OptArg = InitPtrToString(d.getArg(1));
 922   const OptionDescription& OptDesc = OptDescs.FindOption(OptName);
 923
 924   if (TestName == "parameter_equals") {
 925     if (!OptionType::IsParameter(OptDesc.Type))
 926       throw OptName + ": incorrect option type - should be a parameter!";
 927     O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
 928     return true;
 929   }
 930   else if (TestName == "element_in_list") {
 931     if (!OptionType::IsList(OptDesc.Type))
 932       throw OptName + ": incorrect option type - should be a list!";
 933     const std::string& VarName = OptDesc.GenVariableName();
 934     O << "std::find(" << VarName << ".begin(),\n"
 935       << IndentLevel << Indent1 << VarName << ".end(), \""
 936       << OptArg << "\") != " << VarName << ".end()";
 937     return true;
 938   }
 939
 940   return false;
 941 }
 942
 943 // Forward declaration.
 944 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
 945 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
 946                   const OptionDescriptions& OptDescs,
 947                   std::ostream& O);
 948
 949 /// EmitLogicalOperationTest - Helper function used by
 950 /// EmitCaseConstructHandler.
 951 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
 952                               const char* IndentLevel,
 953                               const OptionDescriptions& OptDescs,
 954                               std::ostream& O) {
 955   O << '(';
 956   for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
 957     const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
 958     EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
 959     if (j != NumArgs - 1)
 960       O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
 961     else
 962       O << ')';
 963   }
 964 }
 965
 966 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
 967 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
 968                   const OptionDescriptions& OptDescs,
 969                   std::ostream& O) {
 970   const std::string& TestName = d.getOperator()->getAsString();
 971
 972   if (TestName == "and")
 973     EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
 974   else if (TestName == "or")
 975     EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
 976   else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
 977     return;
 978   else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
 979     return;
 980   else
 981     throw TestName + ": unknown edge property!";
 982 }
 983
 984 // Emit code that handles the 'case' construct.
 985 // Takes a function object that should emit code for every case clause.
 986 // Callback's type is
 987 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
 988 template <typename F>
 989 void EmitCaseConstructHandler(const Init* Dag, const char* IndentLevel,
 990                               F Callback, bool EmitElseIf,
 991                               const OptionDescriptions& OptDescs,
 992                               std::ostream& O) {
 993   const DagInit* d = &InitPtrToDag(Dag);
 994   if (d->getOperator()->getAsString() != "case")
 995     throw std::string("EmitCaseConstructHandler should be invoked"
 996                       " only on 'case' expressions!");
 997
 998   unsigned numArgs = d->getNumArgs();
 999   if (d->getNumArgs() < 2)
1000     throw "There should be at least one clause in the 'case' expression:\n"
1001       + d->getAsString();
1002
1003   for (unsigned i = 0; i != numArgs; ++i) {
1004     const DagInit& Test = InitPtrToDag(d->getArg(i));
1005
1006     // Emit the test.
1007     if (Test.getOperator()->getAsString() == "default") {
1008       if (i+2 != numArgs)
1009         throw std::string("The 'default' clause should be the last in the"
1010                           "'case' construct!");
1011       O << IndentLevel << "else {\n";
1012     }
1013     else {
1014       O << IndentLevel << ((i != 0 && EmitElseIf) ? "else if (" : "if (");
1015       EmitCaseTest(Test, IndentLevel, OptDescs, O);
1016       O << ") {\n";
1017     }
1018
1019     // Emit the corresponding statement.
1020     ++i;
1021     if (i == numArgs)
1022       throw "Case construct handler: no corresponding action "
1023         "found for the test " + Test.getAsString() + '!';
1024
1025     Init* arg = d->getArg(i);
1026     const DagInit* nd = dynamic_cast<DagInit*>(arg);
1027     if (nd && (nd->getOperator()->getAsString() == "case")) {
1028       // Handle the nested 'case'.
1029       EmitCaseConstructHandler(nd, (std::string(IndentLevel) + Indent1).c_str(),
1030                                Callback, EmitElseIf, OptDescs, O);
1031     }
1032     else {
1033       Callback(arg, (std::string(IndentLevel) + Indent1).c_str(), O);
1034     }
1035     O << IndentLevel << "}\n";
1036   }
1037 }
1038
1039 /// SubstituteSpecialCommands - Perform string substitution for $CALL
1040 /// and $ENV. Helper function used by EmitCmdLineVecFill().
1041 std::string SubstituteSpecialCommands(const std::string& cmd) {
1042   size_t cparen = cmd.find(")");
1043   std::string ret;
1044
1045   if (cmd.find("$CALL(") == 0) {
1046     if (cmd.size() == 6)
1047       throw std::string("$CALL invocation: empty argument list!");
1048
1049     ret += "hooks::";
1050     ret += std::string(cmd.begin() + 6, cmd.begin() + cparen);
1051     ret += "()";
1052   }
1053   else if (cmd.find("$ENV(") == 0) {
1054     if (cmd.size() == 5)
1055       throw std::string("$ENV invocation: empty argument list!");
1056
1057     ret += "checkCString(std::getenv(\"";
1058     ret += std::string(cmd.begin() + 5, cmd.begin() + cparen);
1059     ret += "\"))";
1060   }
1061   else {
1062     throw "Unknown special command: " + cmd;
1063   }
1064
1065   if (cmd.begin() + cparen + 1 != cmd.end()) {
1066     ret += " + std::string(\"";
1067     ret += (cmd.c_str() + cparen + 1);
1068     ret += "\")";
1069   }
1070
1071   return ret;
1072 }
1073
1074 /// EmitCmdLineVecFill - Emit code that fills in the command line
1075 /// vector. Helper function used by EmitGenerateActionMethod().
1076 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
1077                         bool IsJoin, const char* IndentLevel,
1078                         std::ostream& O) {
1079   StrVector StrVec;
1080   SplitString(InitPtrToString(CmdLine), StrVec);
1081   if (StrVec.empty())
1082     throw "Tool " + ToolName + " has empty command line!";
1083
1084   StrVector::const_iterator I = StrVec.begin();
1085   ++I;
1086   for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
1087     const std::string& cmd = *I;
1088     O << IndentLevel;
1089     if (cmd.at(0) == '$') {
1090       if (cmd == "$INFILE") {
1091         if (IsJoin)
1092           O << "for (PathVector::const_iterator B = inFiles.begin()"
1093             << ", E = inFiles.end();\n"
1094             << IndentLevel << "B != E; ++B)\n"
1095             << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
1096         else
1097           O << "vec.push_back(inFile.toString());\n";
1098       }
1099       else if (cmd == "$OUTFILE") {
1100         O << "vec.push_back(out_file);\n";
1101       }
1102       else {
1103         O << "vec.push_back(" << SubstituteSpecialCommands(cmd);
1104         O << ");\n";
1105       }
1106     }
1107     else {
1108       O << "vec.push_back(\"" << cmd << "\");\n";
1109     }
1110   }
1111   O << IndentLevel << "cmd = "
1112     << ((StrVec[0][0] == '$') ? SubstituteSpecialCommands(StrVec[0])
1113         : "\"" + StrVec[0] + "\"")
1114     << ";\n";
1115 }
1116
1117 /// EmitCmdLineVecFillCallback - A function object wrapper around
1118 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
1119 /// argument to EmitCaseConstructHandler().
1120 class EmitCmdLineVecFillCallback {
1121   bool IsJoin;
1122   const std::string& ToolName;
1123  public:
1124   EmitCmdLineVecFillCallback(bool J, const std::string& TN)
1125     : IsJoin(J), ToolName(TN) {}
1126
1127   void operator()(const Init* Statement, const char* IndentLevel,
1128                   std::ostream& O) const
1129   {
1130     EmitCmdLineVecFill(Statement, ToolName, IsJoin,
1131                        IndentLevel, O);
1132   }
1133 };
1134
1135 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
1136 /// implement EmitActionHandler. Emits code for
1137 /// handling the (forward) and (forward_as) option properties.
1138 void EmitForwardOptionPropertyHandlingCode (const OptionDescription& D,
1139                                             const char* Indent,
1140                                             const std::string& NewName,
1141                                             std::ostream& O) {
1142   const std::string& Name = NewName.empty()
1143     ? ("-" + D.Name)
1144     : NewName;
1145
1146   switch (D.Type) {
1147   case OptionType::Switch:
1148   case OptionType::ExternSwitch:
1149     O << Indent << "vec.push_back(\"" << Name << "\");\n";
1150     break;
1151   case OptionType::Parameter:
1152   case OptionType::ExternParameter:
1153     O << Indent << "vec.push_back(\"" << Name << "\");\n";
1154     O << Indent << "vec.push_back(" << D.GenVariableName() << ");\n";
1155     break;
1156   case OptionType::Prefix:
1157     O << Indent << "vec.push_back(\"" << Name << "\" + "
1158       << D.GenVariableName() << ");\n";
1159     break;
1160   case OptionType::PrefixList:
1161     O << Indent << "for (" << D.GenTypeDeclaration()
1162       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1163       << Indent << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
1164       << Indent << Indent1 << "vec.push_back(\"" << Name << "\" + "
1165       << "*B);\n";
1166     break;
1167   case OptionType::ParameterList:
1168   case OptionType::ExternList:
1169     O << Indent << "for (" << D.GenTypeDeclaration()
1170       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1171       << Indent << "E = " << D.GenVariableName()
1172       << ".end() ; B != E; ++B) {\n"
1173       << Indent << Indent1 << "vec.push_back(\"" << Name << "\");\n"
1174       << Indent << Indent1 << "vec.push_back(*B);\n"
1175       << Indent << "}\n";
1176     break;
1177   case OptionType::Alias:
1178   default:
1179     throw std::string("Aliases are not allowed in tool option descriptions!");
1180   }
1181 }
1182
1183 /// EmitActionHandler - Emit code that handles actions. Used by
1184 /// EmitGenerateActionMethod() as an argument to
1185 /// EmitCaseConstructHandler().
1186 class EmitActionHandler {
1187   const OptionDescriptions& OptDescs;
1188  public:
1189   EmitActionHandler(const OptionDescriptions& OD)
1190     : OptDescs(OD) {}
1191
1192   void operator()(const Init* Statement, const char* IndentLevel,
1193                   std::ostream& O) const
1194   {
1195     const DagInit& Dag = InitPtrToDag(Statement);
1196     const std::string& ActionName = Dag.getOperator()->getAsString();
1197
1198     if (ActionName == "append_cmd") {
1199       checkNumberOfArguments(&Dag, 1);
1200       const std::string& Cmd = InitPtrToString(Dag.getArg(0));
1201       O << IndentLevel << "vec.push_back(\"" << Cmd << "\");\n";
1202     }
1203     else if (ActionName == "forward") {
1204       checkNumberOfArguments(&Dag, 1);
1205       const std::string& Name = InitPtrToString(Dag.getArg(0));
1206       EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1207                                             IndentLevel, "", O);
1208     }
1209     else if (ActionName == "forward_as") {
1210       checkNumberOfArguments(&Dag, 2);
1211       const std::string& Name = InitPtrToString(Dag.getArg(0));
1212       const std::string& NewName = InitPtrToString(Dag.getArg(0));
1213       EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1214                                             IndentLevel, NewName, O);
1215     }
1216     else if (ActionName == "output_suffix") {
1217       checkNumberOfArguments(&Dag, 1);
1218       const std::string& OutSuf = InitPtrToString(Dag.getArg(0));
1219       O << IndentLevel << "output_suffix = \"" << OutSuf << "\";\n";
1220     }
1221     else if (ActionName == "stop_compilation") {
1222       O << IndentLevel << "stop_compilation = true;\n";
1223     }
1224     else if (ActionName == "unpack_values") {
1225       checkNumberOfArguments(&Dag, 1);
1226       const std::string& Name = InitPtrToString(Dag.getArg(0));
1227       const OptionDescription& D = OptDescs.FindOption(Name);
1228
1229       if (OptionType::IsList(D.Type)) {
1230         O << IndentLevel << "for (" << D.GenTypeDeclaration()
1231           << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
1232           << IndentLevel << "E = " << D.GenVariableName()
1233           << ".end(); B != E; ++B)\n"
1234           << IndentLevel << Indent1 << "llvm::SplitString(*B, vec, \",\");\n";
1235       }
1236       else if (OptionType::IsParameter(D.Type)){
1237         O << Indent3 << "llvm::SplitString("
1238           << D.GenVariableName() << ", vec, \",\");\n";
1239       }
1240       else {
1241         throw "Option '" + D.Name +
1242           "': switches can't have the 'unpack_values' property!";
1243       }
1244     }
1245     else {
1246       throw "Unknown action name: " + ActionName + "!";
1247     }
1248   }
1249 };
1250
1251 // EmitGenerateActionMethod - Emit one of two versions of the
1252 // Tool::GenerateAction() method.
1253 void EmitGenerateActionMethod (const ToolDescription& D,
1254                                const OptionDescriptions& OptDescs,
1255                                bool IsJoin, std::ostream& O) {
1256   if (IsJoin)
1257     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
1258   else
1259     O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
1260
1261   O << Indent2 << "bool HasChildren,\n"
1262     << Indent2 << "const llvm::sys::Path& TempDir,\n"
1263     << Indent2 << "const InputLanguagesSet& InLangs,\n"
1264     << Indent2 << "const LanguageMap& LangMap) const\n"
1265     << Indent1 << "{\n"
1266     << Indent2 << "std::string cmd;\n"
1267     << Indent2 << "std::vector<std::string> vec;\n"
1268     << Indent2 << "bool stop_compilation = !HasChildren;\n"
1269     << Indent2 << "const char* output_suffix = \"" << D.OutputSuffix << "\";\n"
1270     << Indent2 << "std::string out_file;\n\n";
1271
1272   // For every understood option, emit handling code.
1273   if (D.Actions)
1274     EmitCaseConstructHandler(D.Actions, Indent2, EmitActionHandler(OptDescs),
1275                              false, OptDescs, O);
1276
1277   O << '\n' << Indent2
1278     << "out_file = OutFilename(" << (IsJoin ? "sys::Path(),\n" : "inFile,\n")
1279     << Indent3 << "TempDir, stop_compilation, output_suffix).toString();\n\n";
1280
1281   // cmd_line is either a string or a 'case' construct.
1282   if (!D.CmdLine)
1283     throw "Tool " + D.Name + " has no cmd_line property!";
1284   else if (typeid(*D.CmdLine) == typeid(StringInit))
1285     EmitCmdLineVecFill(D.CmdLine, D.Name, IsJoin, Indent2, O);
1286   else
1287     EmitCaseConstructHandler(D.CmdLine, Indent2,
1288                              EmitCmdLineVecFillCallback(IsJoin, D.Name),
1289                              true, OptDescs, O);
1290
1291   // Handle the Sink property.
1292   if (D.isSink()) {
1293     O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
1294       << Indent3 << "vec.insert(vec.end(), "
1295       << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
1296       << Indent2 << "}\n";
1297   }
1298
1299   O << Indent2 << "return Action(cmd, vec, stop_compilation, out_file);\n"
1300     << Indent1 << "}\n\n";
1301 }
1302
1303 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
1304 /// a given Tool class.
1305 void EmitGenerateActionMethods (const ToolDescription& ToolDesc,
1306                                 const OptionDescriptions& OptDescs,
1307                                 std::ostream& O) {
1308   if (!ToolDesc.isJoin())
1309     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
1310       << Indent2 << "bool HasChildren,\n"
1311       << Indent2 << "const llvm::sys::Path& TempDir,\n"
1312       << Indent2 << "const InputLanguagesSet& InLangs,\n"
1313       << Indent2 << "const LanguageMap& LangMap) const\n"
1314       << Indent1 << "{\n"
1315       << Indent2 << "throw std::runtime_error(\"" << ToolDesc.Name
1316       << " is not a Join tool!\");\n"
1317       << Indent1 << "}\n\n";
1318   else
1319     EmitGenerateActionMethod(ToolDesc, OptDescs, true, O);
1320
1321   EmitGenerateActionMethod(ToolDesc, OptDescs, false, O);
1322 }
1323
1324 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1325 /// methods for a given Tool class.
1326 void EmitInOutLanguageMethods (const ToolDescription& D, std::ostream& O) {
1327   O << Indent1 << "const char** InputLanguages() const {\n"
1328     << Indent2 << "return InputLanguages_;\n"
1329     << Indent1 << "}\n\n";
1330
1331   if (D.OutLanguage.empty())
1332     throw "Tool " + D.Name + " has no 'out_language' property!";
1333
1334   O << Indent1 << "const char* OutputLanguage() const {\n"
1335     << Indent2 << "return \"" << D.OutLanguage << "\";\n"
1336     << Indent1 << "}\n\n";
1337 }
1338
1339 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1340 void EmitNameMethod (const ToolDescription& D, std::ostream& O) {
1341   O << Indent1 << "const char* Name() const {\n"
1342     << Indent2 << "return \"" << D.Name << "\";\n"
1343     << Indent1 << "}\n\n";
1344 }
1345
1346 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1347 /// class.
1348 void EmitIsJoinMethod (const ToolDescription& D, std::ostream& O) {
1349   O << Indent1 << "bool IsJoin() const {\n";
1350   if (D.isJoin())
1351     O << Indent2 << "return true;\n";
1352   else
1353     O << Indent2 << "return false;\n";
1354   O << Indent1 << "}\n\n";
1355 }
1356
1357 /// EmitStaticMemberDefinitions - Emit static member definitions for a
1358 /// given Tool class.
1359 void EmitStaticMemberDefinitions(const ToolDescription& D, std::ostream& O) {
1360   if (D.InLanguage.empty())
1361     throw "Tool " + D.Name + " has no 'in_language' property!";
1362
1363   O << "const char* " << D.Name << "::InputLanguages_[] = {";
1364   for (StrVector::const_iterator B = D.InLanguage.begin(),
1365          E = D.InLanguage.end(); B != E; ++B)
1366     O << '\"' << *B << "\", ";
1367   O << "0};\n\n";
1368 }
1369
1370 /// EmitToolClassDefinition - Emit a Tool class definition.
1371 void EmitToolClassDefinition (const ToolDescription& D,
1372                               const OptionDescriptions& OptDescs,
1373                               std::ostream& O) {
1374   if (D.Name == "root")
1375     return;
1376
1377   // Header
1378   O << "class " << D.Name << " : public ";
1379   if (D.isJoin())
1380     O << "JoinTool";
1381   else
1382     O << "Tool";
1383
1384   O << "{\nprivate:\n"
1385     << Indent1 << "static const char* InputLanguages_[];\n\n";
1386
1387   O << "public:\n";
1388   EmitNameMethod(D, O);
1389   EmitInOutLanguageMethods(D, O);
1390   EmitIsJoinMethod(D, O);
1391   EmitGenerateActionMethods(D, OptDescs, O);
1392
1393   // Close class definition
1394   O << "};\n";
1395
1396   EmitStaticMemberDefinitions(D, O);
1397
1398 }
1399
1400 /// EmitOptionDefintions - Iterate over a list of option descriptions
1401 /// and emit registration code.
1402 void EmitOptionDefintions (const OptionDescriptions& descs,
1403                            bool HasSink,
1404                            std::ostream& O)
1405 {
1406   std::vector<OptionDescription> Aliases;
1407
1408   // Emit static cl::Option variables.
1409   for (OptionDescriptions::const_iterator B = descs.begin(),
1410          E = descs.end(); B!=E; ++B) {
1411     const OptionDescription& val = B->second;
1412
1413     if (val.Type == OptionType::Alias) {
1414       Aliases.push_back(val);
1415       continue;
1416     }
1417
1418     if (val.isExtern())
1419       O << "extern ";
1420
1421     O << val.GenTypeDeclaration() << ' '
1422       << val.GenVariableName();
1423
1424     if (val.isExtern()) {
1425       O << ";\n";
1426       continue;
1427     }
1428
1429     O << "(\"" << val.Name << '\"';
1430
1431     if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1432       O << ", cl::Prefix";
1433
1434     if (val.isRequired()) {
1435       switch (val.Type) {
1436       case OptionType::PrefixList:
1437       case OptionType::ParameterList:
1438         O << ", cl::OneOrMore";
1439         break;
1440       default:
1441         O << ", cl::Required";
1442       }
1443     }
1444
1445     if (val.isReallyHidden() || val.isHidden()) {
1446       if (val.isRequired())
1447         O << " |";
1448       else
1449         O << ",";
1450       if (val.isReallyHidden())
1451         O << " cl::ReallyHidden";
1452       else
1453         O << " cl::Hidden";
1454     }
1455
1456     if (!val.Help.empty())
1457       O << ", cl::desc(\"" << val.Help << "\")";
1458
1459     O << ");\n";
1460   }
1461
1462   // Emit the aliases (they should go after all the 'proper' options).
1463   for (std::vector<OptionDescription>::const_iterator
1464          B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
1465     const OptionDescription& val = *B;
1466
1467     O << val.GenTypeDeclaration() << ' '
1468       << val.GenVariableName()
1469       << "(\"" << val.Name << '\"';
1470
1471     const OptionDescription& D = descs.FindOption(val.Help);
1472     O << ", cl::aliasopt(" << D.GenVariableName() << ")";
1473
1474     O << ", cl::desc(\"" << "An alias for -" + val.Help  << "\"));\n";
1475   }
1476
1477   // Emit the sink option.
1478   if (HasSink)
1479     O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
1480
1481   O << '\n';
1482 }
1483
1484 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1485 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1486 {
1487   // Generate code
1488   O << "namespace {\n\n";
1489   O << "void PopulateLanguageMapLocal(LanguageMap& langMap) {\n";
1490
1491   // Get the relevant field out of RecordKeeper
1492   const Record* LangMapRecord = Records.getDef("LanguageMap");
1493
1494   // It is allowed for a plugin to have no language map.
1495   if (LangMapRecord) {
1496
1497     ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1498     if (!LangsToSuffixesList)
1499       throw std::string("Error in the language map definition!");
1500
1501     for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1502       const Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1503
1504       const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1505       const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1506
1507       for (unsigned i = 0; i < Suffixes->size(); ++i)
1508         O << Indent1 << "langMap[\""
1509           << InitPtrToString(Suffixes->getElement(i))
1510           << "\"] = \"" << Lang << "\";\n";
1511     }
1512   }
1513
1514   O << "}\n\n}\n\n";
1515 }
1516
1517 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1518 /// by EmitEdgeClass().
1519 void IncDecWeight (const Init* i, const char* IndentLevel,
1520                    std::ostream& O) {
1521   const DagInit& d = InitPtrToDag(i);
1522   const std::string& OpName = d.getOperator()->getAsString();
1523
1524   if (OpName == "inc_weight")
1525     O << IndentLevel << "ret += ";
1526   else if (OpName == "dec_weight")
1527     O << IndentLevel << "ret -= ";
1528   else
1529     throw "Unknown operator in edge properties list: " + OpName + '!';
1530
1531   if (d.getNumArgs() > 0)
1532     O << InitPtrToInt(d.getArg(0)) << ";\n";
1533   else
1534     O << "2;\n";
1535
1536 }
1537
1538 /// EmitEdgeClass - Emit a single Edge# class.
1539 void EmitEdgeClass (unsigned N, const std::string& Target,
1540                     DagInit* Case, const OptionDescriptions& OptDescs,
1541                     std::ostream& O) {
1542
1543   // Class constructor.
1544   O << "class Edge" << N << ": public Edge {\n"
1545     << "public:\n"
1546     << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1547     << "\") {}\n\n"
1548
1549   // Function Weight().
1550     << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1551     << Indent2 << "unsigned ret = 0;\n";
1552
1553   // Handle the 'case' construct.
1554   EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
1555
1556   O << Indent2 << "return ret;\n"
1557     << Indent1 << "};\n\n};\n\n";
1558 }
1559
1560 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1561 void EmitEdgeClasses (const RecordVector& EdgeVector,
1562                       const OptionDescriptions& OptDescs,
1563                       std::ostream& O) {
1564   int i = 0;
1565   for (RecordVector::const_iterator Beg = EdgeVector.begin(),
1566          E = EdgeVector.end(); Beg != E; ++Beg) {
1567     const Record* Edge = *Beg;
1568     const std::string& B = Edge->getValueAsString("b");
1569     DagInit* Weight = Edge->getValueAsDag("weight");
1570
1571     if (!isDagEmpty(Weight))
1572       EmitEdgeClass(i, B, Weight, OptDescs, O);
1573     ++i;
1574   }
1575 }
1576
1577 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1578 /// function.
1579 void EmitPopulateCompilationGraph (const RecordVector& EdgeVector,
1580                                    const ToolDescriptions& ToolDescs,
1581                                    std::ostream& O)
1582 {
1583   O << "namespace {\n\n";
1584   O << "void PopulateCompilationGraphLocal(CompilationGraph& G) {\n";
1585
1586   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1587          E = ToolDescs.end(); B != E; ++B)
1588     O << Indent1 << "G.insertNode(new " << (*B)->Name << "());\n";
1589
1590   O << '\n';
1591
1592   // Insert edges.
1593
1594   int i = 0;
1595   for (RecordVector::const_iterator Beg = EdgeVector.begin(),
1596          E = EdgeVector.end(); Beg != E; ++Beg) {
1597     const Record* Edge = *Beg;
1598     const std::string& A = Edge->getValueAsString("a");
1599     const std::string& B = Edge->getValueAsString("b");
1600     DagInit* Weight = Edge->getValueAsDag("weight");
1601
1602     O << Indent1 << "G.insertEdge(\"" << A << "\", ";
1603
1604     if (isDagEmpty(Weight))
1605       O << "new SimpleEdge(\"" << B << "\")";
1606     else
1607       O << "new Edge" << i << "()";
1608
1609     O << ");\n";
1610     ++i;
1611   }
1612
1613   O << "}\n\n}\n\n";
1614 }
1615
1616 /// ExtractHookNames - Extract the hook names from all instances of
1617 /// $CALL(HookName) in the provided command line string. Helper
1618 /// function used by FillInHookNames().
1619 class ExtractHookNames {
1620   llvm::StringSet<>& HookNames_;
1621 public:
1622   ExtractHookNames(llvm::StringSet<>& HookNames)
1623   : HookNames_(HookNames_) {}
1624
1625   void operator()(const Init* CmdLine) {
1626     StrVector cmds;
1627     llvm::SplitString(InitPtrToString(CmdLine), cmds);
1628     for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1629          B != E; ++B) {
1630       const std::string& cmd = *B;
1631       if (cmd.find("$CALL(") == 0) {
1632         if (cmd.size() == 6)
1633           throw std::string("$CALL invocation: empty argument list!");
1634         HookNames_.insert(std::string(cmd.begin() + 6,
1635                                      cmd.begin() + cmd.find(")")));
1636       }
1637     }
1638   }
1639 };
1640
1641 /// FillInHookNames - Actually extract the hook names from all command
1642 /// line strings. Helper function used by EmitHookDeclarations().
1643 void FillInHookNames(const ToolDescriptions& ToolDescs,
1644                      llvm::StringSet<>& HookNames)
1645 {
1646   // For all command lines:
1647   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1648          E = ToolDescs.end(); B != E; ++B) {
1649     const ToolDescription& D = *(*B);
1650     if (!D.CmdLine)
1651       continue;
1652     if (dynamic_cast<StringInit*>(D.CmdLine))
1653       // This is a string.
1654       ExtractHookNames(HookNames).operator()(D.CmdLine);
1655     else
1656       // This is a 'case' construct.
1657       WalkCase(D.CmdLine, Id(), ExtractHookNames(HookNames));
1658   }
1659 }
1660
1661 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1662 /// property records and emit hook function declaration for each
1663 /// instance of $CALL(HookName).
1664 void EmitHookDeclarations(const ToolDescriptions& ToolDescs, std::ostream& O) {
1665   llvm::StringSet<> HookNames;
1666   FillInHookNames(ToolDescs, HookNames);
1667   if (HookNames.empty())
1668     return;
1669
1670   O << "namespace hooks {\n";
1671   for (StringSet<>::const_iterator B = HookNames.begin(), E = HookNames.end();
1672        B != E; ++B)
1673     O << Indent1 << "std::string " << B->first() << "();\n";
1674
1675   O << "}\n\n";
1676 }
1677
1678 /// EmitRegisterPlugin - Emit code to register this plugin.
1679 void EmitRegisterPlugin(int Priority, std::ostream& O) {
1680   O << "namespace {\n\n"
1681     << "struct Plugin : public llvmc::BasePlugin {\n\n"
1682     << Indent1 << "int Priority() const { return " << Priority << "; }\n\n"
1683     << Indent1 << "void PopulateLanguageMap(LanguageMap& langMap) const\n"
1684     << Indent1 << "{ PopulateLanguageMapLocal(langMap); }\n\n"
1685     << Indent1
1686     << "void PopulateCompilationGraph(CompilationGraph& graph) const\n"
1687     << Indent1 << "{ PopulateCompilationGraphLocal(graph); }\n"
1688     << "};\n\n"
1689
1690     << "static llvmc::RegisterPlugin<Plugin> RP;\n\n}\n\n";
1691 }
1692
1693 /// EmitIncludes - Emit necessary #include directives and some
1694 /// additional declarations.
1695 void EmitIncludes(std::ostream& O) {
1696   O << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n"
1697     << "#include \"llvm/CompilerDriver/Plugin.h\"\n"
1698     << "#include \"llvm/CompilerDriver/Tool.h\"\n\n"
1699
1700     << "#include \"llvm/ADT/StringExtras.h\"\n"
1701     << "#include \"llvm/Support/CommandLine.h\"\n\n"
1702
1703     << "#include <cstdlib>\n"
1704     << "#include <stdexcept>\n\n"
1705
1706     << "using namespace llvm;\n"
1707     << "using namespace llvmc;\n\n"
1708
1709     << "extern cl::opt<std::string> OutputFilename;\n\n"
1710
1711     << "inline const char* checkCString(const char* s)\n"
1712     << "{ return s == NULL ? \"\" : s; }\n\n";
1713 }
1714
1715
1716 /// PluginData - Holds all information about a plugin.
1717 struct PluginData {
1718   OptionDescriptions OptDescs;
1719   bool HasSink;
1720   ToolDescriptions ToolDescs;
1721   RecordVector Edges;
1722   int Priority;
1723 };
1724
1725 /// HasSink - Go through the list of tool descriptions and check if
1726 /// there is one with the 'sink' property set.
1727 bool HasSink(const ToolDescriptions& ToolDescs) {
1728   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1729          E = ToolDescs.end(); B != E; ++B)
1730     if ((*B)->isSink())
1731       return true;
1732
1733     return false;
1734 }
1735
1736 /// CollectPluginData - Collect tool and option properties,
1737 /// compilation graph edges and plugin priority from the parse tree.
1738 void CollectPluginData (const RecordKeeper& Records, PluginData& Data) {
1739   // Collect option properties.
1740   const RecordVector& OptionLists =
1741     Records.getAllDerivedDefinitions("OptionList");
1742   CollectOptionDescriptions(OptionLists.begin(), OptionLists.end(),
1743                             Data.OptDescs);
1744
1745   // Collect tool properties.
1746   const RecordVector& Tools = Records.getAllDerivedDefinitions("Tool");
1747   CollectToolDescriptions(Tools.begin(), Tools.end(), Data.ToolDescs);
1748   Data.HasSink = HasSink(Data.ToolDescs);
1749
1750   // Collect compilation graph edges.
1751   const RecordVector& CompilationGraphs =
1752     Records.getAllDerivedDefinitions("CompilationGraph");
1753   FillInEdgeVector(CompilationGraphs.begin(), CompilationGraphs.end(),
1754                    Data.Edges);
1755
1756   // Calculate the priority of this plugin.
1757   const RecordVector& Priorities =
1758     Records.getAllDerivedDefinitions("PluginPriority");
1759   Data.Priority = CalculatePriority(Priorities.begin(), Priorities.end());
1760 }
1761
1762 /// CheckPluginData - Perform some sanity checks on the collected data.
1763 void CheckPluginData(PluginData& Data) {
1764   // Filter out all tools not mentioned in the compilation graph.
1765   FilterNotInGraph(Data.Edges, Data.ToolDescs);
1766
1767   // Typecheck the compilation graph.
1768   TypecheckGraph(Data.Edges, Data.ToolDescs);
1769
1770   // Check that there are no options without side effects (specified
1771   // only in the OptionList).
1772   CheckForSuperfluousOptions(Data.Edges, Data.ToolDescs, Data.OptDescs);
1773
1774 }
1775
1776 void EmitPluginCode(const PluginData& Data, std::ostream& O) {
1777   // Emit file header.
1778   EmitIncludes(O);
1779
1780   // Emit global option registration code.
1781   EmitOptionDefintions(Data.OptDescs, Data.HasSink, O);
1782
1783   // Emit hook declarations.
1784   EmitHookDeclarations(Data.ToolDescs, O);
1785
1786   // Emit PopulateLanguageMap() function
1787   // (a language map maps from file extensions to language names).
1788   EmitPopulateLanguageMap(Records, O);
1789
1790   // Emit Tool classes.
1791   for (ToolDescriptions::const_iterator B = Data.ToolDescs.begin(),
1792          E = Data.ToolDescs.end(); B!=E; ++B)
1793     EmitToolClassDefinition(*(*B), Data.OptDescs, O);
1794
1795   // Emit Edge# classes.
1796   EmitEdgeClasses(Data.Edges, Data.OptDescs, O);
1797
1798   // Emit PopulateCompilationGraph() function.
1799   EmitPopulateCompilationGraph(Data.Edges, Data.ToolDescs, O);
1800
1801   // Emit code for plugin registration.
1802   EmitRegisterPlugin(Data.Priority, O);
1803
1804   // EOF
1805 }
1806
1807
1808 // End of anonymous namespace
1809 }
1810
1811 /// run - The back-end entry point.
1812 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1813   try {
1814   PluginData Data;
1815
1816   CollectPluginData(Records, Data);
1817   CheckPluginData(Data);
1818
1819   EmitSourceFileHeader("LLVMC Configuration Library", O);
1820   EmitPluginCode(Data, O);
1821
1822   } catch (std::exception& Error) {
1823     throw Error.what() + std::string(" - usually this means a syntax error.");
1824   }
1825 }