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