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