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