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 /// IsOptionalEdge - Validate that the 'optional_edge' has proper structure.
1247 bool IsOptionalEdge (const DagInit& Edg) {
1248   return (GetOperatorName(Edg) == "optional_edge") && (Edg.getNumArgs() > 2);
1249 }
1250
1251 /// CheckForSuperfluousOptions - Check that there are no side
1252 /// effect-free options (specified only in the OptionList). Otherwise,
1253 /// output a warning.
1254 void CheckForSuperfluousOptions (const DagVector& EdgeVector,
1255                                  const ToolDescriptions& ToolDescs,
1256                                  const OptionDescriptions& OptDescs) {
1257   llvm::StringSet<> nonSuperfluousOptions;
1258
1259   // Add all options mentioned in the ToolDesc.Actions to the set of
1260   // non-superfluous options.
1261   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1262          E = ToolDescs.end(); B != E; ++B) {
1263     const ToolDescription& TD = *(*B);
1264     ExtractOptionNames Callback(nonSuperfluousOptions);
1265     if (TD.Actions)
1266       WalkCase(TD.Actions, Callback, Callback);
1267   }
1268
1269   // Add all options mentioned in the 'case' clauses of the
1270   // OptionalEdges of the compilation graph to the set of
1271   // non-superfluous options.
1272   for (DagVector::const_iterator B = EdgeVector.begin(),
1273          E = EdgeVector.end(); B != E; ++B) {
1274     const DagInit& Edge = **B;
1275     if (IsOptionalEdge(Edge)) {
1276       const DagInit& Weight = InitPtrToDag(Edge.getArg(2));
1277       WalkCase(&Weight, ExtractOptionNames(nonSuperfluousOptions), Id());
1278     }
1279   }
1280
1281   // Check that all options in OptDescs belong to the set of
1282   // non-superfluous options.
1283   for (OptionDescriptions::const_iterator B = OptDescs.begin(),
1284          E = OptDescs.end(); B != E; ++B) {
1285     const OptionDescription& Val = B->second;
1286     if (!nonSuperfluousOptions.count(Val.Name)
1287         && Val.Type != OptionType::Alias)
1288       llvm::errs() << "Warning: option '-" << Val.Name << "' has no effect! "
1289         "Probable cause: this option is specified only in the OptionList.\n";
1290   }
1291 }
1292
1293 /// EmitCaseTest0Args - Helper function used by EmitCaseConstructHandler().
1294 bool EmitCaseTest0Args(const std::string& TestName, raw_ostream& O) {
1295   if (TestName == "single_input_file") {
1296     O << "InputFilenames.size() == 1";
1297     return true;
1298   }
1299   else if (TestName == "multiple_input_files") {
1300     O << "InputFilenames.size() > 1";
1301     return true;
1302   }
1303
1304   return false;
1305 }
1306
1307 /// EmitListTest - Helper function used by EmitCaseTest1ArgList().
1308 template <typename F>
1309 void EmitListTest(const ListInit& L, const char* LogicOp,
1310                   F Callback, raw_ostream& O)
1311 {
1312   // This is a lot like EmitLogicalOperationTest, but works on ListInits instead
1313   // of Dags...
1314   bool isFirst = true;
1315   for (ListInit::const_iterator B = L.begin(), E = L.end(); B != E; ++B) {
1316     if (isFirst)
1317       isFirst = false;
1318     else
1319       O << ' ' << LogicOp << ' ';
1320     Callback(InitPtrToString(*B), O);
1321   }
1322 }
1323
1324 // Callbacks for use with EmitListTest.
1325
1326 class EmitSwitchOn {
1327   const OptionDescriptions& OptDescs_;
1328 public:
1329   EmitSwitchOn(const OptionDescriptions& OptDescs) : OptDescs_(OptDescs)
1330   {}
1331
1332   void operator()(const std::string& OptName, raw_ostream& O) const {
1333     const OptionDescription& OptDesc = OptDescs_.FindSwitch(OptName);
1334     O << OptDesc.GenVariableName();
1335   }
1336 };
1337
1338 class EmitEmptyTest {
1339   bool EmitNegate_;
1340   const OptionDescriptions& OptDescs_;
1341 public:
1342   EmitEmptyTest(bool EmitNegate, const OptionDescriptions& OptDescs)
1343     : EmitNegate_(EmitNegate), OptDescs_(OptDescs)
1344   {}
1345
1346   void operator()(const std::string& OptName, raw_ostream& O) const {
1347     const char* Neg = (EmitNegate_ ? "!" : "");
1348     if (OptName == "o") {
1349       O << Neg << "OutputFilename.empty()";
1350     }
1351     else if (OptName == "save-temps") {
1352       O << Neg << "(SaveTemps == SaveTempsEnum::Unset)";
1353     }
1354     else {
1355       const OptionDescription& OptDesc = OptDescs_.FindListOrParameter(OptName);
1356       O << Neg << OptDesc.GenVariableName() << ".empty()";
1357     }
1358   }
1359 };
1360
1361
1362 /// EmitCaseTest1ArgList - Helper function used by EmitCaseTest1Arg();
1363 bool EmitCaseTest1ArgList(const std::string& TestName,
1364                           const DagInit& d,
1365                           const OptionDescriptions& OptDescs,
1366                           raw_ostream& O) {
1367   const ListInit& L = InitPtrToList(d.getArg(0));
1368
1369   if (TestName == "any_switch_on") {
1370     EmitListTest(L, "||", EmitSwitchOn(OptDescs), O);
1371     return true;
1372   }
1373   else if (TestName == "switch_on") {
1374     EmitListTest(L, "&&", EmitSwitchOn(OptDescs), O);
1375     return true;
1376   }
1377   else if (TestName == "any_not_empty") {
1378     EmitListTest(L, "||", EmitEmptyTest(true, OptDescs), O);
1379     return true;
1380   }
1381   else if (TestName == "any_empty") {
1382     EmitListTest(L, "||", EmitEmptyTest(false, OptDescs), O);
1383     return true;
1384   }
1385   else if (TestName == "not_empty") {
1386     EmitListTest(L, "&&", EmitEmptyTest(true, OptDescs), O);
1387     return true;
1388   }
1389   else if (TestName == "empty") {
1390     EmitListTest(L, "&&", EmitEmptyTest(false, OptDescs), O);
1391     return true;
1392   }
1393
1394   return false;
1395 }
1396
1397 /// EmitCaseTest1ArgStr - Helper function used by EmitCaseTest1Arg();
1398 bool EmitCaseTest1ArgStr(const std::string& TestName,
1399                          const DagInit& d,
1400                          const OptionDescriptions& OptDescs,
1401                          raw_ostream& O) {
1402   const std::string& OptName = InitPtrToString(d.getArg(0));
1403
1404   if (TestName == "switch_on") {
1405     apply(EmitSwitchOn(OptDescs), OptName, O);
1406     return true;
1407   }
1408   else if (TestName == "input_languages_contain") {
1409     O << "InLangs.count(\"" << OptName << "\") != 0";
1410     return true;
1411   }
1412   else if (TestName == "in_language") {
1413     // This works only for single-argument Tool::GenerateAction. Join
1414     // tools can process several files in different languages simultaneously.
1415
1416     // TODO: make this work with Edge::Weight (if possible).
1417     O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"';
1418     return true;
1419   }
1420   else if (TestName == "not_empty" || TestName == "empty") {
1421     bool EmitNegate = (TestName == "not_empty");
1422     apply(EmitEmptyTest(EmitNegate, OptDescs), OptName, O);
1423     return true;
1424   }
1425
1426   return false;
1427 }
1428
1429 /// EmitCaseTest1Arg - Helper function used by EmitCaseConstructHandler();
1430 bool EmitCaseTest1Arg(const std::string& TestName,
1431                       const DagInit& d,
1432                       const OptionDescriptions& OptDescs,
1433                       raw_ostream& O) {
1434   CheckNumberOfArguments(d, 1);
1435   if (typeid(*d.getArg(0)) == typeid(ListInit))
1436     return EmitCaseTest1ArgList(TestName, d, OptDescs, O);
1437   else
1438     return EmitCaseTest1ArgStr(TestName, d, OptDescs, O);
1439 }
1440
1441 /// EmitCaseTest2Args - Helper function used by EmitCaseConstructHandler().
1442 bool EmitCaseTest2Args(const std::string& TestName,
1443                        const DagInit& d,
1444                        unsigned IndentLevel,
1445                        const OptionDescriptions& OptDescs,
1446                        raw_ostream& O) {
1447   CheckNumberOfArguments(d, 2);
1448   const std::string& OptName = InitPtrToString(d.getArg(0));
1449   const std::string& OptArg = InitPtrToString(d.getArg(1));
1450
1451   if (TestName == "parameter_equals") {
1452     const OptionDescription& OptDesc = OptDescs.FindParameter(OptName);
1453     O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
1454     return true;
1455   }
1456   else if (TestName == "element_in_list") {
1457     const OptionDescription& OptDesc = OptDescs.FindParameterList(OptName);
1458     const std::string& VarName = OptDesc.GenVariableName();
1459     O << "std::find(" << VarName << ".begin(),\n";
1460     O.indent(IndentLevel + Indent1)
1461       << VarName << ".end(), \""
1462       << OptArg << "\") != " << VarName << ".end()";
1463     return true;
1464   }
1465
1466   return false;
1467 }
1468
1469 // Forward declaration.
1470 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
1471 void EmitCaseTest(const DagInit& d, unsigned IndentLevel,
1472                   const OptionDescriptions& OptDescs,
1473                   raw_ostream& O);
1474
1475 /// EmitLogicalOperationTest - Helper function used by
1476 /// EmitCaseConstructHandler.
1477 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
1478                               unsigned IndentLevel,
1479                               const OptionDescriptions& OptDescs,
1480                               raw_ostream& O) {
1481   O << '(';
1482   for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
1483     const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
1484     EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
1485     if (j != NumArgs - 1) {
1486       O << ")\n";
1487       O.indent(IndentLevel + Indent1) << ' ' << LogicOp << " (";
1488     }
1489     else {
1490       O << ')';
1491     }
1492   }
1493 }
1494
1495 void EmitLogicalNot(const DagInit& d, unsigned IndentLevel,
1496                     const OptionDescriptions& OptDescs, raw_ostream& O)
1497 {
1498   CheckNumberOfArguments(d, 1);
1499   const DagInit& InnerTest = InitPtrToDag(d.getArg(0));
1500   O << "! (";
1501   EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
1502   O << ")";
1503 }
1504
1505 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
1506 void EmitCaseTest(const DagInit& d, unsigned IndentLevel,
1507                   const OptionDescriptions& OptDescs,
1508                   raw_ostream& O) {
1509   const std::string& TestName = GetOperatorName(d);
1510
1511   if (TestName == "and")
1512     EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
1513   else if (TestName == "or")
1514     EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
1515   else if (TestName == "not")
1516     EmitLogicalNot(d, IndentLevel, OptDescs, O);
1517   else if (EmitCaseTest0Args(TestName, O))
1518     return;
1519   else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
1520     return;
1521   else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
1522     return;
1523   else
1524     throw "Unknown test '" + TestName + "' used in the 'case' construct!";
1525 }
1526
1527
1528 /// EmitCaseTestCallback - Callback used by EmitCaseConstructHandler.
1529 class EmitCaseTestCallback {
1530   bool EmitElseIf_;
1531   const OptionDescriptions& OptDescs_;
1532   raw_ostream& O_;
1533 public:
1534
1535   EmitCaseTestCallback(bool EmitElseIf,
1536                        const OptionDescriptions& OptDescs, raw_ostream& O)
1537     : EmitElseIf_(EmitElseIf), OptDescs_(OptDescs), O_(O)
1538   {}
1539
1540   void operator()(const DagInit& Test, unsigned IndentLevel, bool FirstTest)
1541   {
1542     if (GetOperatorName(Test) == "default") {
1543       O_.indent(IndentLevel) << "else {\n";
1544     }
1545     else {
1546       O_.indent(IndentLevel)
1547         << ((!FirstTest && EmitElseIf_) ? "else if (" : "if (");
1548       EmitCaseTest(Test, IndentLevel, OptDescs_, O_);
1549       O_ << ") {\n";
1550     }
1551   }
1552 };
1553
1554 /// EmitCaseStatementCallback - Callback used by EmitCaseConstructHandler.
1555 template <typename F>
1556 class EmitCaseStatementCallback {
1557   F Callback_;
1558   raw_ostream& O_;
1559 public:
1560
1561   EmitCaseStatementCallback(F Callback, raw_ostream& O)
1562     : Callback_(Callback), O_(O)
1563   {}
1564
1565   void operator() (const Init* Statement, unsigned IndentLevel) {
1566
1567     // Ignore nested 'case' DAG.
1568     if (!(dynamic_cast<const DagInit*>(Statement) &&
1569           GetOperatorName(static_cast<const DagInit&>(*Statement)) == "case")) {
1570       if (typeid(*Statement) == typeid(ListInit)) {
1571         const ListInit& DagList = *static_cast<const ListInit*>(Statement);
1572         for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
1573              B != E; ++B)
1574           Callback_(*B, (IndentLevel + Indent1), O_);
1575       }
1576       else {
1577         Callback_(Statement, (IndentLevel + Indent1), O_);
1578       }
1579     }
1580     O_.indent(IndentLevel) << "}\n";
1581   }
1582
1583 };
1584
1585 /// EmitCaseConstructHandler - Emit code that handles the 'case'
1586 /// construct. Takes a function object that should emit code for every case
1587 /// clause. Implemented on top of WalkCase.
1588 /// Callback's type is void F(const Init* Statement, unsigned IndentLevel,
1589 /// raw_ostream& O).
1590 /// EmitElseIf parameter controls the type of condition that is emitted ('if
1591 /// (..) {..} else if (..) {} .. else {..}' vs. 'if (..) {..} if(..)  {..}
1592 /// .. else {..}').
1593 template <typename F>
1594 void EmitCaseConstructHandler(const Init* Case, unsigned IndentLevel,
1595                               F Callback, bool EmitElseIf,
1596                               const OptionDescriptions& OptDescs,
1597                               raw_ostream& O) {
1598   WalkCase(Case, EmitCaseTestCallback(EmitElseIf, OptDescs, O),
1599            EmitCaseStatementCallback<F>(Callback, O), IndentLevel);
1600 }
1601
1602 /// TokenizeCmdLine - converts from
1603 /// "$CALL(HookName, 'Arg1', 'Arg2')/path -arg1 -arg2" to
1604 /// ["$CALL(", "HookName", "Arg1", "Arg2", ")/path", "-arg1", "-arg2"].
1605 void TokenizeCmdLine(const std::string& CmdLine, StrVector& Out) {
1606   const char* Delimiters = " \t\n\v\f\r";
1607   enum TokenizerState
1608   { Normal, SpecialCommand, InsideSpecialCommand, InsideQuotationMarks }
1609   cur_st  = Normal;
1610
1611   if (CmdLine.empty())
1612     return;
1613   Out.push_back("");
1614
1615   std::string::size_type B = CmdLine.find_first_not_of(Delimiters),
1616     E = CmdLine.size();
1617
1618   for (; B != E; ++B) {
1619     char cur_ch = CmdLine[B];
1620
1621     switch (cur_st) {
1622     case Normal:
1623       if (cur_ch == '$') {
1624         cur_st = SpecialCommand;
1625         break;
1626       }
1627       if (OneOf(Delimiters, cur_ch)) {
1628         // Skip whitespace
1629         B = CmdLine.find_first_not_of(Delimiters, B);
1630         if (B == std::string::npos) {
1631           B = E-1;
1632           continue;
1633         }
1634         --B;
1635         Out.push_back("");
1636         continue;
1637       }
1638       break;
1639
1640
1641     case SpecialCommand:
1642       if (OneOf(Delimiters, cur_ch)) {
1643         cur_st = Normal;
1644         Out.push_back("");
1645         continue;
1646       }
1647       if (cur_ch == '(') {
1648         Out.push_back("");
1649         cur_st = InsideSpecialCommand;
1650         continue;
1651       }
1652       break;
1653
1654     case InsideSpecialCommand:
1655       if (OneOf(Delimiters, cur_ch)) {
1656         continue;
1657       }
1658       if (cur_ch == '\'') {
1659         cur_st = InsideQuotationMarks;
1660         Out.push_back("");
1661         continue;
1662       }
1663       if (cur_ch == ')') {
1664         cur_st = Normal;
1665         Out.push_back("");
1666       }
1667       if (cur_ch == ',') {
1668         continue;
1669       }
1670
1671       break;
1672
1673     case InsideQuotationMarks:
1674       if (cur_ch == '\'') {
1675         cur_st = InsideSpecialCommand;
1676         continue;
1677       }
1678       break;
1679     }
1680
1681     Out.back().push_back(cur_ch);
1682   }
1683 }
1684
1685 /// SubstituteCall - Given "$CALL(HookName, [Arg1 [, Arg2 [...]]])", output
1686 /// "hooks::HookName([Arg1 [, Arg2 [, ...]]])". Helper function used by
1687 /// SubstituteSpecialCommands().
1688 StrVector::const_iterator
1689 SubstituteCall (StrVector::const_iterator Pos,
1690                 StrVector::const_iterator End,
1691                 bool IsJoin, raw_ostream& O)
1692 {
1693   const char* errorMessage = "Syntax error in $CALL invocation!";
1694   CheckedIncrement(Pos, End, errorMessage);
1695   const std::string& CmdName = *Pos;
1696
1697   if (CmdName == ")")
1698     throw "$CALL invocation: empty argument list!";
1699
1700   O << "hooks::";
1701   O << CmdName << "(";
1702
1703
1704   bool firstIteration = true;
1705   while (true) {
1706     CheckedIncrement(Pos, End, errorMessage);
1707     const std::string& Arg = *Pos;
1708     assert(Arg.size() != 0);
1709
1710     if (Arg[0] == ')')
1711       break;
1712
1713     if (firstIteration)
1714       firstIteration = false;
1715     else
1716       O << ", ";
1717
1718     if (Arg == "$INFILE") {
1719       if (IsJoin)
1720         throw "$CALL(Hook, $INFILE) can't be used with a Join tool!";
1721       else
1722         O << "inFile.c_str()";
1723     }
1724     else {
1725       O << '"' << Arg << '"';
1726     }
1727   }
1728
1729   O << ')';
1730
1731   return Pos;
1732 }
1733
1734 /// SubstituteEnv - Given '$ENV(VAR_NAME)', output 'getenv("VAR_NAME")'. Helper
1735 /// function used by SubstituteSpecialCommands().
1736 StrVector::const_iterator
1737 SubstituteEnv (StrVector::const_iterator Pos,
1738                StrVector::const_iterator End, raw_ostream& O)
1739 {
1740   const char* errorMessage = "Syntax error in $ENV invocation!";
1741   CheckedIncrement(Pos, End, errorMessage);
1742   const std::string& EnvName = *Pos;
1743
1744   if (EnvName == ")")
1745     throw "$ENV invocation: empty argument list!";
1746
1747   O << "checkCString(std::getenv(\"";
1748   O << EnvName;
1749   O << "\"))";
1750
1751   CheckedIncrement(Pos, End, errorMessage);
1752
1753   return Pos;
1754 }
1755
1756 /// SubstituteSpecialCommands - Given an invocation of $CALL or $ENV, output
1757 /// handler code. Helper function used by EmitCmdLineVecFill().
1758 StrVector::const_iterator
1759 SubstituteSpecialCommands (StrVector::const_iterator Pos,
1760                            StrVector::const_iterator End,
1761                            bool IsJoin, raw_ostream& O)
1762 {
1763
1764   const std::string& cmd = *Pos;
1765
1766   // Perform substitution.
1767   if (cmd == "$CALL") {
1768     Pos = SubstituteCall(Pos, End, IsJoin, O);
1769   }
1770   else if (cmd == "$ENV") {
1771     Pos = SubstituteEnv(Pos, End, O);
1772   }
1773   else {
1774     throw "Unknown special command: " + cmd;
1775   }
1776
1777   // Handle '$CMD(ARG)/additional/text'.
1778   const std::string& Leftover = *Pos;
1779   assert(Leftover.at(0) == ')');
1780   if (Leftover.size() != 1)
1781     O << " + std::string(\"" << (Leftover.c_str() + 1) << "\")";
1782
1783   return Pos;
1784 }
1785
1786 /// EmitCmdLineVecFill - Emit code that fills in the command line
1787 /// vector. Helper function used by EmitGenerateActionMethod().
1788 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
1789                         bool IsJoin, unsigned IndentLevel,
1790                         raw_ostream& O) {
1791   StrVector StrVec;
1792   TokenizeCmdLine(InitPtrToString(CmdLine), StrVec);
1793
1794   if (StrVec.empty())
1795     throw "Tool '" + ToolName + "' has empty command line!";
1796
1797   StrVector::const_iterator B = StrVec.begin(), E = StrVec.end();
1798
1799   // Emit the command itself.
1800   assert(!StrVec[0].empty());
1801   O.indent(IndentLevel) << "cmd = ";
1802   if (StrVec[0][0] == '$') {
1803     B = SubstituteSpecialCommands(B, E, IsJoin, O);
1804     ++B;
1805   }
1806   else {
1807     O << '"' << StrVec[0] << '"';
1808     ++B;
1809   }
1810   O << ";\n";
1811
1812   // Go through the command arguments.
1813   assert(B <= E);
1814   for (; B != E; ++B) {
1815     const std::string& cmd = *B;
1816
1817     assert(!cmd.empty());
1818     O.indent(IndentLevel);
1819
1820     if (cmd.at(0) == '$') {
1821       O << "vec.push_back(std::make_pair(0, ";
1822       B = SubstituteSpecialCommands(B, E, IsJoin, O);
1823       O << "));\n";
1824     }
1825     else {
1826       O << "vec.push_back(std::make_pair(0, \"" << cmd << "\"));\n";
1827     }
1828   }
1829
1830 }
1831
1832 /// EmitForEachListElementCycleHeader - Emit common code for iterating through
1833 /// all elements of a list. Helper function used by
1834 /// EmitForwardOptionPropertyHandlingCode.
1835 void EmitForEachListElementCycleHeader (const OptionDescription& D,
1836                                         unsigned IndentLevel,
1837                                         raw_ostream& O) {
1838   unsigned IndentLevel1 = IndentLevel + Indent1;
1839
1840   O.indent(IndentLevel)
1841     << "for (" << D.GenTypeDeclaration()
1842     << "::iterator B = " << D.GenVariableName() << ".begin(),\n";
1843   O.indent(IndentLevel)
1844     << "E = " << D.GenVariableName() << ".end(); B != E;) {\n";
1845   O.indent(IndentLevel1) << "unsigned pos = " << D.GenVariableName()
1846                          << ".getPosition(B - " << D.GenVariableName()
1847                          << ".begin());\n";
1848 }
1849
1850 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
1851 /// implement EmitActionHandler. Emits code for
1852 /// handling the (forward) and (forward_as) option properties.
1853 void EmitForwardOptionPropertyHandlingCode (const OptionDescription& D,
1854                                             unsigned IndentLevel,
1855                                             const std::string& NewName,
1856                                             raw_ostream& O) {
1857   const std::string& Name = NewName.empty()
1858     ? ("-" + D.Name)
1859     : NewName;
1860   unsigned IndentLevel1 = IndentLevel + Indent1;
1861
1862   switch (D.Type) {
1863   case OptionType::Switch:
1864     O.indent(IndentLevel)
1865       << "vec.push_back(std::make_pair(" << D.GenVariableName()
1866       << ".getPosition(), \"" << Name << "\"));\n";
1867     break;
1868   case OptionType::Parameter:
1869     O.indent(IndentLevel) << "vec.push_back(std::make_pair("
1870                           << D.GenVariableName()
1871                           <<".getPosition(), \"" << Name;
1872
1873     if (!D.isForwardNotSplit()) {
1874       O << "\"));\n";
1875       O.indent(IndentLevel) << "vec.push_back(std::make_pair("
1876                             << D.GenVariableName() << ".getPosition(), "
1877                             << D.GenVariableName() << "));\n";
1878     }
1879     else {
1880       O << "=\" + " << D.GenVariableName() << "));\n";
1881     }
1882     break;
1883   case OptionType::Prefix:
1884     O.indent(IndentLevel) << "vec.push_back(std::make_pair("
1885                           << D.GenVariableName() << ".getPosition(), \""
1886                           << Name << "\" + "
1887                           << D.GenVariableName() << "));\n";
1888     break;
1889   case OptionType::PrefixList:
1890     EmitForEachListElementCycleHeader(D, IndentLevel, O);
1891     O.indent(IndentLevel1) << "vec.push_back(std::make_pair(pos, \""
1892                            << Name << "\" + " << "*B));\n";
1893     O.indent(IndentLevel1) << "++B;\n";
1894
1895     for (int i = 1, j = D.MultiVal; i < j; ++i) {
1896       O.indent(IndentLevel1) << "vec.push_back(std::make_pair(pos, *B));\n";
1897       O.indent(IndentLevel1) << "++B;\n";
1898     }
1899
1900     O.indent(IndentLevel) << "}\n";
1901     break;
1902   case OptionType::ParameterList:
1903     EmitForEachListElementCycleHeader(D, IndentLevel, O);
1904     O.indent(IndentLevel1) << "vec.push_back(std::make_pair(pos, \""
1905                            << Name << "\"));\n";
1906
1907     for (int i = 0, j = D.MultiVal; i < j; ++i) {
1908       O.indent(IndentLevel1) << "vec.push_back(std::make_pair(pos, *B));\n";
1909       O.indent(IndentLevel1) << "++B;\n";
1910     }
1911
1912     O.indent(IndentLevel) << "}\n";
1913     break;
1914   case OptionType::SwitchList:
1915     EmitForEachListElementCycleHeader(D, IndentLevel, O);
1916     O.indent(IndentLevel1) << "vec.push_back(std::make_pair(pos, \""
1917                            << Name << "\"));\n";
1918     O.indent(IndentLevel1) << "++B;\n";
1919     O.indent(IndentLevel) << "}\n";
1920     break;
1921   case OptionType::Alias:
1922   default:
1923     throw "Aliases are not allowed in tool option descriptions!";
1924   }
1925 }
1926
1927 /// ActionHandlingCallbackBase - Base class of EmitActionHandlersCallback and
1928 /// EmitPreprocessOptionsCallback.
1929 struct ActionHandlingCallbackBase
1930 {
1931
1932   void onErrorDag(const DagInit& d,
1933                   unsigned IndentLevel, raw_ostream& O) const
1934   {
1935     O.indent(IndentLevel)
1936       << "PrintError(\""
1937       << (d.getNumArgs() >= 1 ? InitPtrToString(d.getArg(0)) : "Unknown error!")
1938       << "\");\n";
1939     O.indent(IndentLevel) << "return 1;\n";
1940   }
1941
1942   void onWarningDag(const DagInit& d,
1943                     unsigned IndentLevel, raw_ostream& O) const
1944   {
1945     CheckNumberOfArguments(d, 1);
1946     O.indent(IndentLevel) << "llvm::errs() << \""
1947                           << InitPtrToString(d.getArg(0)) << "\";\n";
1948   }
1949
1950 };
1951
1952 /// EmitActionHandlersCallback - Emit code that handles actions. Used by
1953 /// EmitGenerateActionMethod() as an argument to EmitCaseConstructHandler().
1954 class EmitActionHandlersCallback;
1955
1956 typedef void (EmitActionHandlersCallback::* EmitActionHandlersCallbackHandler)
1957 (const DagInit&, unsigned, raw_ostream&) const;
1958
1959 class EmitActionHandlersCallback :
1960   public ActionHandlingCallbackBase,
1961   public HandlerTable<EmitActionHandlersCallbackHandler>
1962 {
1963   typedef EmitActionHandlersCallbackHandler Handler;
1964
1965   const OptionDescriptions& OptDescs;
1966
1967   /// EmitHookInvocation - Common code for hook invocation from actions. Used by
1968   /// onAppendCmd and onOutputSuffix.
1969   void EmitHookInvocation(const std::string& Str,
1970                           const char* BlockOpen, const char* BlockClose,
1971                           unsigned IndentLevel, raw_ostream& O) const
1972   {
1973     StrVector Out;
1974     TokenizeCmdLine(Str, Out);
1975
1976     for (StrVector::const_iterator B = Out.begin(), E = Out.end();
1977          B != E; ++B) {
1978       const std::string& cmd = *B;
1979
1980       O.indent(IndentLevel) << BlockOpen;
1981
1982       if (cmd.at(0) == '$')
1983         B = SubstituteSpecialCommands(B, E,  /* IsJoin = */ true, O);
1984       else
1985         O << '"' << cmd << '"';
1986
1987       O << BlockClose;
1988     }
1989   }
1990
1991   void onAppendCmd (const DagInit& Dag,
1992                     unsigned IndentLevel, raw_ostream& O) const
1993   {
1994     CheckNumberOfArguments(Dag, 1);
1995     this->EmitHookInvocation(InitPtrToString(Dag.getArg(0)),
1996                              "vec.push_back(std::make_pair(65536, ", "));\n",
1997                              IndentLevel, O);
1998   }
1999
2000   void onForward (const DagInit& Dag,
2001                   unsigned IndentLevel, raw_ostream& O) const
2002   {
2003     CheckNumberOfArguments(Dag, 1);
2004     const std::string& Name = InitPtrToString(Dag.getArg(0));
2005     EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
2006                                           IndentLevel, "", O);
2007   }
2008
2009   void onForwardAs (const DagInit& Dag,
2010                     unsigned IndentLevel, raw_ostream& O) const
2011   {
2012     CheckNumberOfArguments(Dag, 2);
2013     const std::string& Name = InitPtrToString(Dag.getArg(0));
2014     const std::string& NewName = InitPtrToString(Dag.getArg(1));
2015     EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
2016                                           IndentLevel, NewName, O);
2017   }
2018
2019   void onForwardValue (const DagInit& Dag,
2020                        unsigned IndentLevel, raw_ostream& O) const
2021   {
2022     CheckNumberOfArguments(Dag, 1);
2023     const std::string& Name = InitPtrToString(Dag.getArg(0));
2024     const OptionDescription& D = OptDescs.FindParameterListOrParameter(Name);
2025
2026     if (D.isSwitchList()) {
2027       throw std::runtime_error
2028         ("forward_value is not allowed with switch_list");
2029     }
2030
2031     if (D.isParameter()) {
2032       O.indent(IndentLevel) << "vec.push_back(std::make_pair("
2033                             << D.GenVariableName() << ".getPosition(), "
2034                             << D.GenVariableName() << "));\n";
2035     }
2036     else {
2037       O.indent(IndentLevel) << "for (" << D.GenTypeDeclaration()
2038                             << "::iterator B = " << D.GenVariableName()
2039                             << ".begin(), \n";
2040       O.indent(IndentLevel + Indent1) << " E = " << D.GenVariableName()
2041                                       << ".end(); B != E; ++B)\n";
2042       O.indent(IndentLevel) << "{\n";
2043       O.indent(IndentLevel + Indent1)
2044         << "unsigned pos = " << D.GenVariableName()
2045         << ".getPosition(B - " << D.GenVariableName()
2046         << ".begin());\n";
2047       O.indent(IndentLevel + Indent1)
2048         << "vec.push_back(std::make_pair(pos, *B));\n";
2049       O.indent(IndentLevel) << "}\n";
2050     }
2051   }
2052
2053   void onForwardTransformedValue (const DagInit& Dag,
2054                                   unsigned IndentLevel, raw_ostream& O) const
2055   {
2056     CheckNumberOfArguments(Dag, 2);
2057     const std::string& Name = InitPtrToString(Dag.getArg(0));
2058     const std::string& Hook = InitPtrToString(Dag.getArg(1));
2059     const OptionDescription& D = OptDescs.FindParameterListOrParameter(Name);
2060
2061     O.indent(IndentLevel) << "vec.push_back(std::make_pair("
2062                           << D.GenVariableName() << ".getPosition("
2063                           << (D.isList() ? "0" : "") << "), "
2064                           << "hooks::" << Hook << "(" << D.GenVariableName()
2065                           << (D.isParameter() ? ".c_str()" : "") << ")));\n";
2066   }
2067
2068   void onNoOutFile (const DagInit& Dag,
2069                     unsigned IndentLevel, raw_ostream& O) const
2070   {
2071     CheckNumberOfArguments(Dag, 0);
2072     O.indent(IndentLevel) << "no_out_file = true;\n";
2073   }
2074
2075   void onOutputSuffix (const DagInit& Dag,
2076                        unsigned IndentLevel, raw_ostream& O) const
2077   {
2078     CheckNumberOfArguments(Dag, 1);
2079     this->EmitHookInvocation(InitPtrToString(Dag.getArg(0)),
2080                              "output_suffix = ", ";\n", IndentLevel, O);
2081   }
2082
2083   void onStopCompilation (const DagInit& Dag,
2084                           unsigned IndentLevel, raw_ostream& O) const
2085   {
2086     O.indent(IndentLevel) << "stop_compilation = true;\n";
2087   }
2088
2089
2090   void onUnpackValues (const DagInit& Dag,
2091                        unsigned IndentLevel, raw_ostream& O) const
2092   {
2093     throw "'unpack_values' is deprecated. "
2094       "Use 'comma_separated' + 'forward_value' instead!";
2095   }
2096
2097  public:
2098
2099   explicit EmitActionHandlersCallback(const OptionDescriptions& OD)
2100     : OptDescs(OD)
2101   {
2102     if (!staticMembersInitialized_) {
2103       AddHandler("error", &EmitActionHandlersCallback::onErrorDag);
2104       AddHandler("warning", &EmitActionHandlersCallback::onWarningDag);
2105       AddHandler("append_cmd", &EmitActionHandlersCallback::onAppendCmd);
2106       AddHandler("forward", &EmitActionHandlersCallback::onForward);
2107       AddHandler("forward_as", &EmitActionHandlersCallback::onForwardAs);
2108       AddHandler("forward_value", &EmitActionHandlersCallback::onForwardValue);
2109       AddHandler("forward_transformed_value",
2110                  &EmitActionHandlersCallback::onForwardTransformedValue);
2111       AddHandler("no_out_file",
2112                  &EmitActionHandlersCallback::onNoOutFile);
2113       AddHandler("output_suffix", &EmitActionHandlersCallback::onOutputSuffix);
2114       AddHandler("stop_compilation",
2115                  &EmitActionHandlersCallback::onStopCompilation);
2116       AddHandler("unpack_values",
2117                  &EmitActionHandlersCallback::onUnpackValues);
2118
2119
2120       staticMembersInitialized_ = true;
2121     }
2122   }
2123
2124   void operator()(const Init* I,
2125                   unsigned IndentLevel, raw_ostream& O) const
2126   {
2127     InvokeDagInitHandler(this, I, IndentLevel, O);
2128   }
2129 };
2130
2131 void EmitGenerateActionMethodHeader(const ToolDescription& D,
2132                                     bool IsJoin, bool Naked,
2133                                     raw_ostream& O)
2134 {
2135   O.indent(Indent1) << "int GenerateAction(Action& Out,\n";
2136
2137   if (IsJoin)
2138     O.indent(Indent2) << "const PathVector& inFiles,\n";
2139   else
2140     O.indent(Indent2) << "const sys::Path& inFile,\n";
2141
2142   O.indent(Indent2) << "const bool HasChildren,\n";
2143   O.indent(Indent2) << "const llvm::sys::Path& TempDir,\n";
2144   O.indent(Indent2) << "const InputLanguagesSet& InLangs,\n";
2145   O.indent(Indent2) << "const LanguageMap& LangMap) const\n";
2146   O.indent(Indent1) << "{\n";
2147
2148   if (!Naked) {
2149     O.indent(Indent2) << "std::string cmd;\n";
2150     O.indent(Indent2) << "std::string out_file;\n";
2151     O.indent(Indent2)
2152       << "std::vector<std::pair<unsigned, std::string> > vec;\n";
2153     O.indent(Indent2) << "bool stop_compilation = !HasChildren;\n";
2154     O.indent(Indent2) << "bool no_out_file = false;\n";
2155     O.indent(Indent2) << "std::string output_suffix(\""
2156                       << D.OutputSuffix << "\");\n";
2157   }
2158 }
2159
2160 // EmitGenerateActionMethod - Emit either a normal or a "join" version of the
2161 // Tool::GenerateAction() method.
2162 void EmitGenerateActionMethod (const ToolDescription& D,
2163                                const OptionDescriptions& OptDescs,
2164                                bool IsJoin, raw_ostream& O) {
2165
2166   EmitGenerateActionMethodHeader(D, IsJoin, /* Naked = */ false, O);
2167
2168   if (!D.CmdLine)
2169     throw "Tool " + D.Name + " has no cmd_line property!";
2170
2171   // Process the 'command' property.
2172   O << '\n';
2173   EmitCmdLineVecFill(D.CmdLine, D.Name, IsJoin, Indent2, O);
2174   O << '\n';
2175
2176   // Process the 'actions' list of this tool.
2177   if (D.Actions)
2178     EmitCaseConstructHandler(D.Actions, Indent2,
2179                              EmitActionHandlersCallback(OptDescs),
2180                              false, OptDescs, O);
2181   O << '\n';
2182
2183   // Input file (s)
2184   if (!D.InFileOption.empty()) {
2185     O.indent(Indent2)
2186       << "vec.push_back(std::make_pair(InputFilenames.getPosition(0), \""
2187       << D.InFileOption << "\");\n";
2188   }
2189
2190   if (IsJoin) {
2191     O.indent(Indent2)
2192       << "for (PathVector::const_iterator B = inFiles.begin(),\n";
2193     O.indent(Indent3) << "E = inFiles.end(); B != E; ++B)\n";
2194     O.indent(Indent2) << "{\n";
2195     O.indent(Indent3) << "vec.push_back(std::make_pair("
2196                       << "InputFilenames.getPosition(B - inFiles.begin()), "
2197                       << "B->str()));\n";
2198     O.indent(Indent2) << "}\n";
2199   }
2200   else {
2201     O.indent(Indent2) << "vec.push_back(std::make_pair("
2202                       << "InputFilenames.getPosition(0), inFile.str()));\n";
2203   }
2204
2205   // Output file
2206   O.indent(Indent2) << "if (!no_out_file) {\n";
2207   if (!D.OutFileOption.empty())
2208     O.indent(Indent3) << "vec.push_back(std::make_pair(65536, \""
2209                       << D.OutFileOption << "\"));\n";
2210
2211   O.indent(Indent3) << "out_file = this->OutFilename("
2212                     << (IsJoin ? "sys::Path(),\n" : "inFile,\n");
2213   O.indent(Indent4) <<
2214     "TempDir, stop_compilation, output_suffix.c_str()).str();\n\n";
2215   O.indent(Indent3) << "vec.push_back(std::make_pair(65536, out_file));\n";
2216
2217   O.indent(Indent2) << "}\n\n";
2218
2219   // Handle the Sink property.
2220   std::string SinkOption("autogenerated::");
2221   SinkOption += SinkOptionName;
2222   if (D.isSink()) {
2223     O.indent(Indent2) << "if (!" << SinkOption << ".empty()) {\n";
2224     O.indent(Indent3) << "for (cl::list<std::string>::iterator B = "
2225                       << SinkOption << ".begin(), E = " << SinkOption
2226                       << ".end(); B != E; ++B)\n";
2227     O.indent(Indent4) << "vec.push_back(std::make_pair(" << SinkOption
2228                       << ".getPosition(B - " << SinkOption
2229                       <<  ".begin()), *B));\n";
2230     O.indent(Indent2) << "}\n";
2231   }
2232
2233   O.indent(Indent2) << "Out.Construct(cmd, this->SortArgs(vec), "
2234                     << "stop_compilation, out_file);\n";
2235   O.indent(Indent2) << "return 0;\n";
2236   O.indent(Indent1) << "}\n\n";
2237 }
2238
2239 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
2240 /// a given Tool class.
2241 void EmitGenerateActionMethods (const ToolDescription& ToolDesc,
2242                                 const OptionDescriptions& OptDescs,
2243                                 raw_ostream& O) {
2244   if (!ToolDesc.isJoin()) {
2245     EmitGenerateActionMethodHeader(ToolDesc, /* IsJoin = */ true,
2246                                    /* Naked = */ true, O);
2247     O.indent(Indent2) << "PrintError(\"" << ToolDesc.Name
2248                       << " is not a Join tool!\");\n";
2249     O.indent(Indent2) << "return -1;\n";
2250     O.indent(Indent1) << "}\n\n";
2251   }
2252   else {
2253     EmitGenerateActionMethod(ToolDesc, OptDescs, true, O);
2254   }
2255
2256   EmitGenerateActionMethod(ToolDesc, OptDescs, false, O);
2257 }
2258
2259 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
2260 /// methods for a given Tool class.
2261 void EmitInOutLanguageMethods (const ToolDescription& D, raw_ostream& O) {
2262   O.indent(Indent1) << "const char** InputLanguages() const {\n";
2263   O.indent(Indent2) << "return InputLanguages_;\n";
2264   O.indent(Indent1) << "}\n\n";
2265
2266   if (D.OutLanguage.empty())
2267     throw "Tool " + D.Name + " has no 'out_language' property!";
2268
2269   O.indent(Indent1) << "const char* OutputLanguage() const {\n";
2270   O.indent(Indent2) << "return \"" << D.OutLanguage << "\";\n";
2271   O.indent(Indent1) << "}\n\n";
2272 }
2273
2274 /// EmitNameMethod - Emit the Name() method for a given Tool class.
2275 void EmitNameMethod (const ToolDescription& D, raw_ostream& O) {
2276   O.indent(Indent1) << "const char* Name() const {\n";
2277   O.indent(Indent2) << "return \"" << D.Name << "\";\n";
2278   O.indent(Indent1) << "}\n\n";
2279 }
2280
2281 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
2282 /// class.
2283 void EmitIsJoinMethod (const ToolDescription& D, raw_ostream& O) {
2284   O.indent(Indent1) << "bool IsJoin() const {\n";
2285   if (D.isJoin())
2286     O.indent(Indent2) << "return true;\n";
2287   else
2288     O.indent(Indent2) << "return false;\n";
2289   O.indent(Indent1) << "}\n\n";
2290 }
2291
2292 /// EmitWorksOnEmptyCallback - Callback used by EmitWorksOnEmptyMethod in
2293 /// conjunction with EmitCaseConstructHandler.
2294 void EmitWorksOnEmptyCallback (const Init* Value,
2295                                unsigned IndentLevel, raw_ostream& O) {
2296   CheckBooleanConstant(Value);
2297   O.indent(IndentLevel) << "return " << Value->getAsString() << ";\n";
2298 }
2299
2300 /// EmitWorksOnEmptyMethod - Emit the WorksOnEmpty() method for a given Tool
2301 /// class.
2302 void EmitWorksOnEmptyMethod (const ToolDescription& D,
2303                              const OptionDescriptions& OptDescs,
2304                              raw_ostream& O)
2305 {
2306   O.indent(Indent1) << "bool WorksOnEmpty() const {\n";
2307   if (D.OnEmpty == 0)
2308     O.indent(Indent2) << "return false;\n";
2309   else
2310     EmitCaseConstructHandler(D.OnEmpty, Indent2, EmitWorksOnEmptyCallback,
2311                              /*EmitElseIf = */ true, OptDescs, O);
2312   O.indent(Indent1) << "}\n\n";
2313 }
2314
2315 /// EmitStaticMemberDefinitions - Emit static member definitions for a
2316 /// given Tool class.
2317 void EmitStaticMemberDefinitions(const ToolDescription& D, raw_ostream& O) {
2318   if (D.InLanguage.empty())
2319     throw "Tool " + D.Name + " has no 'in_language' property!";
2320
2321   O << "const char* " << D.Name << "::InputLanguages_[] = {";
2322   for (StrVector::const_iterator B = D.InLanguage.begin(),
2323          E = D.InLanguage.end(); B != E; ++B)
2324     O << '\"' << *B << "\", ";
2325   O << "0};\n\n";
2326 }
2327
2328 /// EmitToolClassDefinition - Emit a Tool class definition.
2329 void EmitToolClassDefinition (const ToolDescription& D,
2330                               const OptionDescriptions& OptDescs,
2331                               raw_ostream& O) {
2332   if (D.Name == "root")
2333     return;
2334
2335   // Header
2336   O << "class " << D.Name << " : public ";
2337   if (D.isJoin())
2338     O << "JoinTool";
2339   else
2340     O << "Tool";
2341
2342   O << " {\nprivate:\n";
2343   O.indent(Indent1) << "static const char* InputLanguages_[];\n\n";
2344
2345   O << "public:\n";
2346   EmitNameMethod(D, O);
2347   EmitInOutLanguageMethods(D, O);
2348   EmitIsJoinMethod(D, O);
2349   EmitWorksOnEmptyMethod(D, OptDescs, O);
2350   EmitGenerateActionMethods(D, OptDescs, O);
2351
2352   // Close class definition
2353   O << "};\n";
2354
2355   EmitStaticMemberDefinitions(D, O);
2356
2357 }
2358
2359 /// EmitOptionDefinitions - Iterate over a list of option descriptions
2360 /// and emit registration code.
2361 void EmitOptionDefinitions (const OptionDescriptions& descs,
2362                             bool HasSink, raw_ostream& O)
2363 {
2364   std::vector<OptionDescription> Aliases;
2365
2366   // Emit static cl::Option variables.
2367   for (OptionDescriptions::const_iterator B = descs.begin(),
2368          E = descs.end(); B!=E; ++B) {
2369     const OptionDescription& val = B->second;
2370
2371     if (val.Type == OptionType::Alias) {
2372       Aliases.push_back(val);
2373       continue;
2374     }
2375
2376     O << val.GenTypeDeclaration() << ' '
2377       << val.GenPlainVariableName();
2378
2379     O << "(\"" << val.Name << "\"\n";
2380
2381     if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
2382       O << ", cl::Prefix";
2383
2384     if (val.isRequired()) {
2385       if (val.isList() && !val.isMultiVal())
2386         O << ", cl::OneOrMore";
2387       else
2388         O << ", cl::Required";
2389     }
2390
2391     if (val.isOptional())
2392         O << ", cl::Optional";
2393
2394     if (val.isOneOrMore())
2395         O << ", cl::OneOrMore";
2396
2397     if (val.isZeroOrMore())
2398         O << ", cl::ZeroOrMore";
2399
2400     if (val.isReallyHidden())
2401       O << ", cl::ReallyHidden";
2402     else if (val.isHidden())
2403       O << ", cl::Hidden";
2404
2405     if (val.isCommaSeparated())
2406       O << ", cl::CommaSeparated";
2407
2408     if (val.MultiVal > 1)
2409       O << ", cl::multi_val(" << val.MultiVal << ')';
2410
2411     if (val.InitVal) {
2412       const std::string& str = val.InitVal->getAsString();
2413       O << ", cl::init(" << str << ')';
2414     }
2415
2416     if (!val.Help.empty())
2417       O << ", cl::desc(\"" << val.Help << "\")";
2418
2419     O << ");\n\n";
2420   }
2421
2422   // Emit the aliases (they should go after all the 'proper' options).
2423   for (std::vector<OptionDescription>::const_iterator
2424          B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
2425     const OptionDescription& val = *B;
2426
2427     O << val.GenTypeDeclaration() << ' '
2428       << val.GenPlainVariableName()
2429       << "(\"" << val.Name << '\"';
2430
2431     const OptionDescription& D = descs.FindOption(val.Help);
2432     O << ", cl::aliasopt(" << D.GenVariableName() << ")";
2433
2434     O << ", cl::desc(\"" << "An alias for -" + val.Help  << "\"));\n";
2435   }
2436
2437   // Emit the sink option.
2438   if (HasSink)
2439     O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
2440
2441   O << '\n';
2442 }
2443
2444 /// EmitPreprocessOptionsCallback - Helper function passed to
2445 /// EmitCaseConstructHandler() by EmitPreprocessOptions().
2446
2447 class EmitPreprocessOptionsCallback;
2448
2449 typedef void
2450 (EmitPreprocessOptionsCallback::* EmitPreprocessOptionsCallbackHandler)
2451 (const DagInit&, unsigned, raw_ostream&) const;
2452
2453 class EmitPreprocessOptionsCallback :
2454   public ActionHandlingCallbackBase,
2455   public HandlerTable<EmitPreprocessOptionsCallbackHandler>
2456 {
2457   typedef EmitPreprocessOptionsCallbackHandler Handler;
2458   typedef void
2459   (EmitPreprocessOptionsCallback::* HandlerImpl)
2460   (const Init*, unsigned, raw_ostream&) const;
2461
2462   const OptionDescriptions& OptDescs_;
2463
2464   void onListOrDag(const DagInit& d, HandlerImpl h,
2465                    unsigned IndentLevel, raw_ostream& O) const
2466   {
2467     CheckNumberOfArguments(d, 1);
2468     const Init* I = d.getArg(0);
2469
2470     // If I is a list, apply h to each element.
2471     if (typeid(*I) == typeid(ListInit)) {
2472       const ListInit& L = *static_cast<const ListInit*>(I);
2473       for (ListInit::const_iterator B = L.begin(), E = L.end(); B != E; ++B)
2474         ((this)->*(h))(*B, IndentLevel, O);
2475     }
2476     // Otherwise, apply h to I.
2477     else {
2478       ((this)->*(h))(I, IndentLevel, O);
2479     }
2480   }
2481
2482   void onUnsetOptionImpl(const Init* I,
2483                          unsigned IndentLevel, raw_ostream& O) const
2484   {
2485     const std::string& OptName = InitPtrToString(I);
2486     const OptionDescription& OptDesc = OptDescs_.FindOption(OptName);
2487
2488     if (OptDesc.isSwitch()) {
2489       O.indent(IndentLevel) << OptDesc.GenVariableName() << " = false;\n";
2490     }
2491     else if (OptDesc.isParameter()) {
2492       O.indent(IndentLevel) << OptDesc.GenVariableName() << " = \"\";\n";
2493     }
2494     else if (OptDesc.isList()) {
2495       O.indent(IndentLevel) << OptDesc.GenVariableName() << ".clear();\n";
2496     }
2497     else {
2498       throw "Can't apply 'unset_option' to alias option '" + OptName + "'!";
2499     }
2500   }
2501
2502   void onUnsetOption(const DagInit& d,
2503                      unsigned IndentLevel, raw_ostream& O) const
2504   {
2505     this->onListOrDag(d, &EmitPreprocessOptionsCallback::onUnsetOptionImpl,
2506                       IndentLevel, O);
2507   }
2508
2509   void onSetOptionImpl(const DagInit& d,
2510                        unsigned IndentLevel, raw_ostream& O) const {
2511     CheckNumberOfArguments(d, 2);
2512     const std::string& OptName = InitPtrToString(d.getArg(0));
2513     const Init* Value = d.getArg(1);
2514     const OptionDescription& OptDesc = OptDescs_.FindOption(OptName);
2515
2516     if (OptDesc.isList()) {
2517       const ListInit& List = InitPtrToList(Value);
2518
2519       O.indent(IndentLevel) << OptDesc.GenVariableName() << ".clear();\n";
2520       for (ListInit::const_iterator B = List.begin(), E = List.end();
2521            B != E; ++B) {
2522         const Init* CurElem = *B;
2523         if (OptDesc.isSwitchList())
2524           CheckBooleanConstant(CurElem);
2525
2526         O.indent(IndentLevel)
2527           << OptDesc.GenVariableName() << ".push_back(\""
2528           << (OptDesc.isSwitchList() ? CurElem->getAsString()
2529               : InitPtrToString(CurElem))
2530           << "\");\n";
2531       }
2532     }
2533     else if (OptDesc.isSwitch()) {
2534       CheckBooleanConstant(Value);
2535       O.indent(IndentLevel) << OptDesc.GenVariableName()
2536                             << " = " << Value->getAsString() << ";\n";
2537     }
2538     else if (OptDesc.isParameter()) {
2539       const std::string& Str = InitPtrToString(Value);
2540       O.indent(IndentLevel) << OptDesc.GenVariableName()
2541                             << " = \"" << Str << "\";\n";
2542     }
2543     else {
2544       throw "Can't apply 'set_option' to alias option -" + OptName + " !";
2545     }
2546   }
2547
2548   void onSetSwitch(const Init* I,
2549                    unsigned IndentLevel, raw_ostream& O) const {
2550     const std::string& OptName = InitPtrToString(I);
2551     const OptionDescription& OptDesc = OptDescs_.FindOption(OptName);
2552
2553     if (OptDesc.isSwitch())
2554       O.indent(IndentLevel) << OptDesc.GenVariableName() << " = true;\n";
2555     else
2556       throw "set_option: -" + OptName + " is not a switch option!";
2557   }
2558
2559   void onSetOption(const DagInit& d,
2560                    unsigned IndentLevel, raw_ostream& O) const
2561   {
2562     CheckNumberOfArguments(d, 1);
2563
2564     // Two arguments: (set_option "parameter", VALUE), where VALUE can be a
2565     // boolean, a string or a string list.
2566     if (d.getNumArgs() > 1)
2567       this->onSetOptionImpl(d, IndentLevel, O);
2568     // One argument: (set_option "switch")
2569     // or (set_option ["switch1", "switch2", ...])
2570     else
2571       this->onListOrDag(d, &EmitPreprocessOptionsCallback::onSetSwitch,
2572                         IndentLevel, O);
2573   }
2574
2575 public:
2576
2577   EmitPreprocessOptionsCallback(const OptionDescriptions& OptDescs)
2578   : OptDescs_(OptDescs)
2579   {
2580     if (!staticMembersInitialized_) {
2581       AddHandler("error", &EmitPreprocessOptionsCallback::onErrorDag);
2582       AddHandler("warning", &EmitPreprocessOptionsCallback::onWarningDag);
2583       AddHandler("unset_option", &EmitPreprocessOptionsCallback::onUnsetOption);
2584       AddHandler("set_option", &EmitPreprocessOptionsCallback::onSetOption);
2585
2586       staticMembersInitialized_ = true;
2587     }
2588   }
2589
2590   void operator()(const Init* I,
2591                   unsigned IndentLevel, raw_ostream& O) const
2592   {
2593     InvokeDagInitHandler(this, I, IndentLevel, O);
2594   }
2595
2596 };
2597
2598 /// EmitPreprocessOptions - Emit the PreprocessOptions() function.
2599 void EmitPreprocessOptions (const RecordKeeper& Records,
2600                             const OptionDescriptions& OptDecs, raw_ostream& O)
2601 {
2602   O << "int PreprocessOptions () {\n";
2603
2604   const RecordVector& OptionPreprocessors =
2605     Records.getAllDerivedDefinitions("OptionPreprocessor");
2606
2607   for (RecordVector::const_iterator B = OptionPreprocessors.begin(),
2608          E = OptionPreprocessors.end(); B!=E; ++B) {
2609     DagInit* Case = (*B)->getValueAsDag("preprocessor");
2610     EmitCaseConstructHandler(Case, Indent1,
2611                              EmitPreprocessOptionsCallback(OptDecs),
2612                              false, OptDecs, O);
2613   }
2614
2615   O << '\n';
2616   O.indent(Indent1) << "return 0;\n";
2617   O << "}\n\n";
2618 }
2619
2620 class DoEmitPopulateLanguageMap;
2621 typedef void (DoEmitPopulateLanguageMap::* DoEmitPopulateLanguageMapHandler)
2622 (const DagInit& D);
2623
2624 class DoEmitPopulateLanguageMap
2625 : public HandlerTable<DoEmitPopulateLanguageMapHandler>
2626 {
2627 private:
2628   raw_ostream& O_;
2629
2630 public:
2631
2632   explicit DoEmitPopulateLanguageMap (raw_ostream& O) : O_(O) {
2633     if (!staticMembersInitialized_) {
2634       AddHandler("lang_to_suffixes",
2635                  &DoEmitPopulateLanguageMap::onLangToSuffixes);
2636
2637       staticMembersInitialized_ = true;
2638     }
2639   }
2640
2641   void operator() (Init* I) {
2642     InvokeDagInitHandler(this, I);
2643   }
2644
2645 private:
2646
2647   void onLangToSuffixes (const DagInit& d) {
2648     CheckNumberOfArguments(d, 2);
2649
2650     const std::string& Lang = InitPtrToString(d.getArg(0));
2651     Init* Suffixes = d.getArg(1);
2652
2653     // Second argument to lang_to_suffixes is either a single string...
2654     if (typeid(*Suffixes) == typeid(StringInit)) {
2655       O_.indent(Indent1) << "langMap[\"" << InitPtrToString(Suffixes)
2656                          << "\"] = \"" << Lang << "\";\n";
2657     }
2658     // ...or a list of strings.
2659     else {
2660       const ListInit& Lst = InitPtrToList(Suffixes);
2661       assert(Lst.size() != 0);
2662       for (ListInit::const_iterator B = Lst.begin(), E = Lst.end();
2663            B != E; ++B) {
2664         O_.indent(Indent1) << "langMap[\"" << InitPtrToString(*B)
2665                            << "\"] = \"" << Lang << "\";\n";
2666       }
2667     }
2668   }
2669
2670 };
2671
2672 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
2673 void EmitPopulateLanguageMap (const RecordKeeper& Records, raw_ostream& O)
2674 {
2675   O << "int PopulateLanguageMap (LanguageMap& langMap) {\n";
2676
2677   // For each LangMap:
2678   const RecordVector& LangMaps =
2679     Records.getAllDerivedDefinitions("LanguageMap");
2680
2681   for (RecordVector::const_iterator B = LangMaps.begin(),
2682          E = LangMaps.end(); B!=E; ++B) {
2683     ListInit* LangMap = (*B)->getValueAsListInit("map");
2684     std::for_each(LangMap->begin(), LangMap->end(),
2685                   DoEmitPopulateLanguageMap(O));
2686   }
2687
2688   O << '\n';
2689   O.indent(Indent1) << "return 0;\n";
2690   O << "}\n\n";
2691 }
2692
2693 /// EmitEdgePropertyHandlerCallback - Emits code that handles edge
2694 /// properties. Helper function passed to EmitCaseConstructHandler() by
2695 /// EmitEdgeClass().
2696 void EmitEdgePropertyHandlerCallback (const Init* i, unsigned IndentLevel,
2697                                       raw_ostream& O) {
2698   const DagInit& d = InitPtrToDag(i);
2699   const std::string& OpName = GetOperatorName(d);
2700
2701   if (OpName == "inc_weight") {
2702     O.indent(IndentLevel) << "ret += ";
2703   }
2704   else if (OpName == "error") {
2705     CheckNumberOfArguments(d, 1);
2706     O.indent(IndentLevel) << "PrintError(\""
2707                           << InitPtrToString(d.getArg(0))
2708                           << "\");\n";
2709     O.indent(IndentLevel) << "return -1;\n";
2710     return;
2711   }
2712   else {
2713     throw "Unknown operator in edge properties list: '" + OpName + "'!"
2714       "\nOnly 'inc_weight', 'dec_weight' and 'error' are allowed.";
2715   }
2716
2717   if (d.getNumArgs() > 0)
2718     O << InitPtrToInt(d.getArg(0)) << ";\n";
2719   else
2720     O << "2;\n";
2721
2722 }
2723
2724 /// EmitEdgeClass - Emit a single Edge# class.
2725 void EmitEdgeClass (unsigned N, const std::string& Target,
2726                     const DagInit& Case, const OptionDescriptions& OptDescs,
2727                     raw_ostream& O) {
2728
2729   // Class constructor.
2730   O << "class Edge" << N << ": public Edge {\n"
2731     << "public:\n";
2732   O.indent(Indent1) << "Edge" << N << "() : Edge(\"" << Target
2733                     << "\") {}\n\n";
2734
2735   // Function Weight().
2736   O.indent(Indent1)
2737     << "int Weight(const InputLanguagesSet& InLangs) const {\n";
2738   O.indent(Indent2) << "unsigned ret = 0;\n";
2739
2740   // Handle the 'case' construct.
2741   EmitCaseConstructHandler(&Case, Indent2, EmitEdgePropertyHandlerCallback,
2742                            false, OptDescs, O);
2743
2744   O.indent(Indent2) << "return ret;\n";
2745   O.indent(Indent1) << "}\n\n};\n\n";
2746 }
2747
2748 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
2749 void EmitEdgeClasses (const DagVector& EdgeVector,
2750                       const OptionDescriptions& OptDescs,
2751                       raw_ostream& O) {
2752   int i = 0;
2753   for (DagVector::const_iterator B = EdgeVector.begin(),
2754          E = EdgeVector.end(); B != E; ++B) {
2755     const DagInit& Edge = **B;
2756     const std::string& Name = GetOperatorName(Edge);
2757
2758     if (Name == "optional_edge") {
2759       assert(IsOptionalEdge(Edge));
2760       const std::string& NodeB = InitPtrToString(Edge.getArg(1));
2761
2762       const DagInit& Weight = InitPtrToDag(Edge.getArg(2));
2763       EmitEdgeClass(i, NodeB, Weight, OptDescs, O);
2764     }
2765     else if (Name != "edge") {
2766       throw "Unknown edge class: '" + Name + "'!";
2767     }
2768
2769     ++i;
2770   }
2771 }
2772
2773 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph() function.
2774 void EmitPopulateCompilationGraph (const DagVector& EdgeVector,
2775                                    const ToolDescriptions& ToolDescs,
2776                                    raw_ostream& O)
2777 {
2778   O << "int PopulateCompilationGraph (CompilationGraph& G) {\n";
2779
2780   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
2781          E = ToolDescs.end(); B != E; ++B)
2782     O.indent(Indent1) << "G.insertNode(new " << (*B)->Name << "());\n";
2783
2784   O << '\n';
2785
2786   // Insert edges.
2787
2788   int i = 0;
2789   for (DagVector::const_iterator B = EdgeVector.begin(),
2790          E = EdgeVector.end(); B != E; ++B) {
2791     const DagInit& Edge = **B;
2792     const std::string& NodeA = InitPtrToString(Edge.getArg(0));
2793     const std::string& NodeB = InitPtrToString(Edge.getArg(1));
2794
2795     O.indent(Indent1) << "if (int ret = G.insertEdge(\"" << NodeA << "\", ";
2796
2797     if (IsOptionalEdge(Edge))
2798       O << "new Edge" << i << "()";
2799     else
2800       O << "new SimpleEdge(\"" << NodeB << "\")";
2801
2802     O << "))\n";
2803     O.indent(Indent2) << "return ret;\n";
2804
2805     ++i;
2806   }
2807
2808   O << '\n';
2809   O.indent(Indent1) << "return 0;\n";
2810   O << "}\n\n";
2811 }
2812
2813 /// HookInfo - Information about the hook type and number of arguments.
2814 struct HookInfo {
2815
2816   // A hook can either have a single parameter of type std::vector<std::string>,
2817   // or NumArgs parameters of type const char*.
2818   enum HookType { ListHook, ArgHook };
2819
2820   HookType Type;
2821   unsigned NumArgs;
2822
2823   HookInfo() : Type(ArgHook), NumArgs(1)
2824   {}
2825
2826   HookInfo(HookType T) : Type(T), NumArgs(1)
2827   {}
2828
2829   HookInfo(unsigned N) : Type(ArgHook), NumArgs(N)
2830   {}
2831 };
2832
2833 typedef llvm::StringMap<HookInfo> HookInfoMap;
2834
2835 /// ExtractHookNames - Extract the hook names from all instances of
2836 /// $CALL(HookName) in the provided command line string/action. Helper
2837 /// function used by FillInHookNames().
2838 class ExtractHookNames {
2839   HookInfoMap& HookNames_;
2840   const OptionDescriptions& OptDescs_;
2841 public:
2842   ExtractHookNames(HookInfoMap& HookNames, const OptionDescriptions& OptDescs)
2843     : HookNames_(HookNames), OptDescs_(OptDescs)
2844   {}
2845
2846   void onAction (const DagInit& Dag) {
2847     const std::string& Name = GetOperatorName(Dag);
2848
2849     if (Name == "forward_transformed_value") {
2850       CheckNumberOfArguments(Dag, 2);
2851       const std::string& OptName = InitPtrToString(Dag.getArg(0));
2852       const std::string& HookName = InitPtrToString(Dag.getArg(1));
2853       const OptionDescription& D =
2854         OptDescs_.FindParameterListOrParameter(OptName);
2855
2856       HookNames_[HookName] = HookInfo(D.isList() ? HookInfo::ListHook
2857                                       : HookInfo::ArgHook);
2858     }
2859     else if (Name == "append_cmd" || Name == "output_suffix") {
2860       CheckNumberOfArguments(Dag, 1);
2861       this->onCmdLine(InitPtrToString(Dag.getArg(0)));
2862     }
2863   }
2864
2865   void onCmdLine(const std::string& Cmd) {
2866     StrVector cmds;
2867     TokenizeCmdLine(Cmd, cmds);
2868
2869     for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
2870          B != E; ++B) {
2871       const std::string& cmd = *B;
2872
2873       if (cmd == "$CALL") {
2874         unsigned NumArgs = 0;
2875         CheckedIncrement(B, E, "Syntax error in $CALL invocation!");
2876         const std::string& HookName = *B;
2877
2878         if (HookName.at(0) == ')')
2879           throw "$CALL invoked with no arguments!";
2880
2881         while (++B != E && B->at(0) != ')') {
2882           ++NumArgs;
2883         }
2884
2885         HookInfoMap::const_iterator H = HookNames_.find(HookName);
2886
2887         if (H != HookNames_.end() && H->second.NumArgs != NumArgs &&
2888             H->second.Type != HookInfo::ArgHook)
2889           throw "Overloading of hooks is not allowed. Overloaded hook: "
2890             + HookName;
2891         else
2892           HookNames_[HookName] = HookInfo(NumArgs);
2893       }
2894     }
2895   }
2896
2897   void operator()(const Init* Arg) {
2898
2899     // We're invoked on an action (either a dag or a dag list).
2900     if (typeid(*Arg) == typeid(DagInit)) {
2901       const DagInit& Dag = InitPtrToDag(Arg);
2902       this->onAction(Dag);
2903       return;
2904     }
2905     else if (typeid(*Arg) == typeid(ListInit)) {
2906       const ListInit& List = InitPtrToList(Arg);
2907       for (ListInit::const_iterator B = List.begin(), E = List.end(); B != E;
2908            ++B) {
2909         const DagInit& Dag = InitPtrToDag(*B);
2910         this->onAction(Dag);
2911       }
2912       return;
2913     }
2914
2915     // We're invoked on a command line.
2916     this->onCmdLine(InitPtrToString(Arg));
2917   }
2918
2919   void operator()(const DagInit* Test, unsigned, bool) {
2920     this->operator()(Test);
2921   }
2922   void operator()(const Init* Statement, unsigned) {
2923     this->operator()(Statement);
2924   }
2925 };
2926
2927 /// FillInHookNames - Actually extract the hook names from all command
2928 /// line strings. Helper function used by EmitHookDeclarations().
2929 void FillInHookNames(const ToolDescriptions& ToolDescs,
2930                      const OptionDescriptions& OptDescs,
2931                      HookInfoMap& HookNames)
2932 {
2933   // For all tool descriptions:
2934   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
2935          E = ToolDescs.end(); B != E; ++B) {
2936     const ToolDescription& D = *(*B);
2937
2938     // Look for 'forward_transformed_value' in 'actions'.
2939     if (D.Actions)
2940       WalkCase(D.Actions, Id(), ExtractHookNames(HookNames, OptDescs));
2941
2942     // Look for hook invocations in 'cmd_line'.
2943     if (!D.CmdLine)
2944       continue;
2945     if (dynamic_cast<StringInit*>(D.CmdLine))
2946       // This is a string.
2947       ExtractHookNames(HookNames, OptDescs).operator()(D.CmdLine);
2948     else
2949       // This is a 'case' construct.
2950       WalkCase(D.CmdLine, Id(), ExtractHookNames(HookNames, OptDescs));
2951   }
2952 }
2953
2954 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
2955 /// property records and emit hook function declaration for each
2956 /// instance of $CALL(HookName).
2957 void EmitHookDeclarations(const ToolDescriptions& ToolDescs,
2958                           const OptionDescriptions& OptDescs, raw_ostream& O) {
2959   HookInfoMap HookNames;
2960
2961   FillInHookNames(ToolDescs, OptDescs, HookNames);
2962   if (HookNames.empty())
2963     return;
2964
2965   for (HookInfoMap::const_iterator B = HookNames.begin(),
2966          E = HookNames.end(); B != E; ++B) {
2967     const char* HookName = B->first();
2968     const HookInfo& Info = B->second;
2969
2970     O.indent(Indent1) << "std::string " << HookName << "(";
2971
2972     if (Info.Type == HookInfo::ArgHook) {
2973       for (unsigned i = 0, j = Info.NumArgs; i < j; ++i) {
2974         O << "const char* Arg" << i << (i+1 == j ? "" : ", ");
2975       }
2976     }
2977     else {
2978       O << "const std::vector<std::string>& Arg";
2979     }
2980
2981     O <<");\n";
2982   }
2983 }
2984
2985 /// EmitIncludes - Emit necessary #include directives and some
2986 /// additional declarations.
2987 void EmitIncludes(raw_ostream& O) {
2988   O << "#include \"llvm/CompilerDriver/BuiltinOptions.h\"\n"
2989     << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n"
2990     << "#include \"llvm/CompilerDriver/Error.h\"\n"
2991     << "#include \"llvm/CompilerDriver/Tool.h\"\n\n"
2992
2993     << "#include \"llvm/Support/CommandLine.h\"\n"
2994     << "#include \"llvm/Support/raw_ostream.h\"\n\n"
2995
2996     << "#include <algorithm>\n"
2997     << "#include <cstdlib>\n"
2998     << "#include <iterator>\n"
2999     << "#include <stdexcept>\n\n"
3000
3001     << "using namespace llvm;\n"
3002     << "using namespace llvmc;\n\n"
3003
3004     << "inline const char* checkCString(const char* s)\n"
3005     << "{ return s == NULL ? \"\" : s; }\n\n";
3006 }
3007
3008
3009 /// DriverData - Holds all information about the driver.
3010 struct DriverData {
3011   OptionDescriptions OptDescs;
3012   ToolDescriptions ToolDescs;
3013   DagVector Edges;
3014   bool HasSink;
3015 };
3016
3017 /// HasSink - Go through the list of tool descriptions and check if
3018 /// there are any with the 'sink' property set.
3019 bool HasSink(const ToolDescriptions& ToolDescs) {
3020   for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
3021          E = ToolDescs.end(); B != E; ++B)
3022     if ((*B)->isSink())
3023       return true;
3024
3025   return false;
3026 }
3027
3028 /// CollectDriverData - Collect compilation graph edges, tool properties and
3029 /// option properties from the parse tree.
3030 void CollectDriverData (const RecordKeeper& Records, DriverData& Data) {
3031   // Collect option properties.
3032   const RecordVector& OptionLists =
3033     Records.getAllDerivedDefinitions("OptionList");
3034   CollectOptionDescriptions(OptionLists, Data.OptDescs);
3035
3036   // Collect tool properties.
3037   const RecordVector& Tools = Records.getAllDerivedDefinitions("Tool");
3038   CollectToolDescriptions(Tools, Data.ToolDescs);
3039   Data.HasSink = HasSink(Data.ToolDescs);
3040
3041   // Collect compilation graph edges.
3042   const RecordVector& CompilationGraphs =
3043     Records.getAllDerivedDefinitions("CompilationGraph");
3044   FillInEdgeVector(CompilationGraphs, Data.Edges);
3045 }
3046
3047 /// CheckDriverData - Perform some sanity checks on the collected data.
3048 void CheckDriverData(DriverData& Data) {
3049   // Filter out all tools not mentioned in the compilation graph.
3050   FilterNotInGraph(Data.Edges, Data.ToolDescs);
3051
3052   // Typecheck the compilation graph.
3053   TypecheckGraph(Data.Edges, Data.ToolDescs);
3054
3055   // Check that there are no options without side effects (specified
3056   // only in the OptionList).
3057   CheckForSuperfluousOptions(Data.Edges, Data.ToolDescs, Data.OptDescs);
3058 }
3059
3060 void EmitDriverCode(const DriverData& Data, raw_ostream& O) {
3061   // Emit file header.
3062   EmitIncludes(O);
3063
3064   // Emit global option registration code.
3065   O << "namespace llvmc {\n"
3066     << "namespace autogenerated {\n\n";
3067   EmitOptionDefinitions(Data.OptDescs, Data.HasSink, O);
3068   O << "} // End namespace autogenerated.\n"
3069     << "} // End namespace llvmc.\n\n";
3070
3071   // Emit hook declarations.
3072   O << "namespace hooks {\n";
3073   EmitHookDeclarations(Data.ToolDescs, Data.OptDescs, O);
3074   O << "} // End namespace hooks.\n\n";
3075
3076   O << "namespace {\n\n";
3077   O << "using namespace llvmc::autogenerated;\n\n";
3078
3079   // Emit Tool classes.
3080   for (ToolDescriptions::const_iterator B = Data.ToolDescs.begin(),
3081          E = Data.ToolDescs.end(); B!=E; ++B)
3082     EmitToolClassDefinition(*(*B), Data.OptDescs, O);
3083
3084   // Emit Edge# classes.
3085   EmitEdgeClasses(Data.Edges, Data.OptDescs, O);
3086
3087   O << "} // End anonymous namespace.\n\n";
3088
3089   O << "namespace llvmc {\n";
3090   O << "namespace autogenerated {\n\n";
3091
3092   // Emit PreprocessOptions() function.
3093   EmitPreprocessOptions(Records, Data.OptDescs, O);
3094
3095   // Emit PopulateLanguageMap() function
3096   // (language map maps from file extensions to language names).
3097   EmitPopulateLanguageMap(Records, O);
3098
3099   // Emit PopulateCompilationGraph() function.
3100   EmitPopulateCompilationGraph(Data.Edges, Data.ToolDescs, O);
3101
3102   O << "} // End namespace autogenerated.\n";
3103   O << "} // End namespace llvmc.\n\n";
3104
3105   // EOF
3106 }
3107
3108
3109 // End of anonymous namespace
3110 }
3111
3112 /// run - The back-end entry point.
3113 void LLVMCConfigurationEmitter::run (raw_ostream &O) {
3114   try {
3115     DriverData Data;
3116
3117     CollectDriverData(Records, Data);
3118     CheckDriverData(Data);
3119
3120     this->EmitSourceFileHeader("llvmc-based driver: auto-generated code", O);
3121     EmitDriverCode(Data, O);
3122
3123   } catch (std::exception& Error) {
3124     throw Error.what() + std::string(" - usually this means a syntax error.");
3125   }
3126 }