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