utils/TableGen/LLVMCConfigurationEmitter.cpp

   1 //===- LLVMCConfigurationEmitter.cpp - Generate LLVMC config ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open
   6 // Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This tablegen backend is responsible for emitting LLVMC configuration code.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "LLVMCConfigurationEmitter.h"
  15 #include "Record.h"
  16
  17 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  18 #include "llvm/ADT/SmallVector.h"
  19 #include "llvm/ADT/StringExtras.h"
  20 #include "llvm/ADT/StringMap.h"
  21 #include "llvm/ADT/StringSet.h"
  22 #include "llvm/Support/Streams.h"
  23
  24 #include <algorithm>
  25 #include <cassert>
  26 #include <functional>
  27 #include <stdexcept>
  28 #include <string>
  29
  30 using namespace llvm;
  31
  32 namespace {
  33
  34 //===----------------------------------------------------------------------===//
  35 /// Typedefs
  36
  37 typedef std::vector<Record*> RecordVector;
  38 typedef std::vector<std::string> StrVector;
  39
  40 //===----------------------------------------------------------------------===//
  41 /// Constants
  42
  43 // Indentation strings.
  44 const char * Indent1 = "    ";
  45 const char * Indent2 = "        ";
  46 const char * Indent3 = "            ";
  47 const char * Indent4 = "                ";
  48
  49 // Default help string.
  50 const char * DefaultHelpString = "NO HELP MESSAGE PROVIDED";
  51
  52 // Name for the "sink" option.
  53 const char * SinkOptionName = "AutoGeneratedSinkOption";
  54
  55 //===----------------------------------------------------------------------===//
  56 /// Helper functions
  57
  58 int InitPtrToInt(const Init* ptr) {
  59   const IntInit& val = dynamic_cast<const IntInit&>(*ptr);
  60   return val.getValue();
  61 }
  62
  63 const std::string& InitPtrToString(const Init* ptr) {
  64   const StringInit& val = dynamic_cast<const StringInit&>(*ptr);
  65   return val.getValue();
  66 }
  67
  68 const ListInit& InitPtrToList(const Init* ptr) {
  69   const ListInit& val = dynamic_cast<const ListInit&>(*ptr);
  70   return val;
  71 }
  72
  73 const DagInit& InitPtrToDag(const Init* ptr) {
  74   const DagInit& val = dynamic_cast<const DagInit&>(*ptr);
  75   return val;
  76 }
  77
  78 // checkNumberOfArguments - Ensure that the number of args in d is
  79 // less than or equal to min_arguments, otherwise throw an exception.
  80 void checkNumberOfArguments (const DagInit* d, unsigned min_arguments) {
  81   if (d->getNumArgs() < min_arguments)
  82     throw "Property " + d->getOperator()->getAsString()
  83       + " has too few arguments!";
  84 }
  85
  86 // isDagEmpty - is this DAG marked with an empty marker?
  87 bool isDagEmpty (const DagInit* d) {
  88   return d->getOperator()->getAsString() == "empty";
  89 }
  90
  91 //===----------------------------------------------------------------------===//
  92 /// Back-end specific code
  93
  94 // A command-line option can have one of the following types:
  95 //
  96 // Alias - an alias for another option.
  97 //
  98 // Switch - a simple switch without arguments, e.g. -O2
  99 //
 100 // Parameter - an option that takes one(and only one) argument, e.g. -o file,
 101 // --output=file
 102 //
 103 // ParameterList - same as Parameter, but more than one occurence
 104 // of the option is allowed, e.g. -lm -lpthread
 105 //
 106 // Prefix - argument is everything after the prefix,
 107 // e.g. -Wa,-foo,-bar, -DNAME=VALUE
 108 //
 109 // PrefixList - same as Prefix, but more than one option occurence is
 110 // allowed.
 111
 112 namespace OptionType {
 113   enum OptionType { Alias, Switch,
 114                     Parameter, ParameterList, Prefix, PrefixList};
 115 }
 116
 117 bool IsListOptionType (OptionType::OptionType t) {
 118   return (t == OptionType::ParameterList || t == OptionType::PrefixList);
 119 }
 120
 121 // Code duplication here is necessary because one option can affect
 122 // several tools and those tools may have different actions associated
 123 // with this option. GlobalOptionDescriptions are used to generate
 124 // the option registration code, while ToolOptionDescriptions are used
 125 // to generate tool-specific code.
 126
 127 /// OptionDescription - Base class for option descriptions.
 128 struct OptionDescription {
 129   OptionType::OptionType Type;
 130   std::string Name;
 131
 132   OptionDescription(OptionType::OptionType t = OptionType::Switch,
 133                     const std::string& n = "")
 134   : Type(t), Name(n)
 135   {}
 136
 137   const char* GenTypeDeclaration() const {
 138     switch (Type) {
 139     case OptionType::Alias:
 140       return "cl::alias";
 141     case OptionType::PrefixList:
 142     case OptionType::ParameterList:
 143       return "cl::list<std::string>";
 144     case OptionType::Switch:
 145       return "cl::opt<bool>";
 146     case OptionType::Parameter:
 147     case OptionType::Prefix:
 148     default:
 149       return "cl::opt<std::string>";
 150     }
 151   }
 152
 153   // Escape commas and other symbols not allowed in the C++ variable
 154   // names. Makes it possible to use options with names like "Wa,"
 155   // (useful for prefix options).
 156   std::string EscapeVariableName(const std::string& Var) const {
 157     std::string ret;
 158     for (unsigned i = 0; i != Var.size(); ++i) {
 159       if (Var[i] == ',') {
 160         ret += "_comma_";
 161       }
 162       else {
 163         ret.push_back(Var[i]);
 164       }
 165     }
 166     return ret;
 167   }
 168
 169   std::string GenVariableName() const {
 170     const std::string& EscapedName = EscapeVariableName(Name);
 171     switch (Type) {
 172     case OptionType::Alias:
 173      return "AutoGeneratedAlias" + EscapedName;
 174     case OptionType::Switch:
 175       return "AutoGeneratedSwitch" + EscapedName;
 176     case OptionType::Prefix:
 177       return "AutoGeneratedPrefix" + EscapedName;
 178     case OptionType::PrefixList:
 179       return "AutoGeneratedPrefixList" + EscapedName;
 180     case OptionType::Parameter:
 181       return "AutoGeneratedParameter" + EscapedName;
 182     case OptionType::ParameterList:
 183     default:
 184       return "AutoGeneratedParameterList" + EscapedName;
 185     }
 186   }
 187
 188 };
 189
 190 // Global option description.
 191
 192 namespace GlobalOptionDescriptionFlags {
 193   enum GlobalOptionDescriptionFlags { Required = 0x1 };
 194 }
 195
 196 struct GlobalOptionDescription : public OptionDescription {
 197   std::string Help;
 198   unsigned Flags;
 199
 200   // We need to provide a default constructor because
 201   // StringMap can only store DefaultConstructible objects.
 202   GlobalOptionDescription() : OptionDescription(), Flags(0)
 203   {}
 204
 205   GlobalOptionDescription (OptionType::OptionType t, const std::string& n,
 206                            const std::string& h = DefaultHelpString)
 207     : OptionDescription(t, n), Help(h), Flags(0)
 208   {}
 209
 210   bool isRequired() const {
 211     return Flags & GlobalOptionDescriptionFlags::Required;
 212   }
 213   void setRequired() {
 214     Flags |= GlobalOptionDescriptionFlags::Required;
 215   }
 216
 217   /// Merge - Merge two option descriptions.
 218   void Merge (const GlobalOptionDescription& other)
 219   {
 220     if (other.Type != Type)
 221       throw "Conflicting definitions for the option " + Name + "!";
 222
 223     if (Help == DefaultHelpString)
 224       Help = other.Help;
 225     else if (other.Help != DefaultHelpString) {
 226       llvm::cerr << "Warning: more than one help string defined for option "
 227         + Name + "\n";
 228     }
 229
 230     Flags |= other.Flags;
 231   }
 232 };
 233
 234 /// GlobalOptionDescriptions - A GlobalOptionDescription array
 235 /// together with some flags affecting generation of option
 236 /// declarations.
 237 struct GlobalOptionDescriptions {
 238   typedef StringMap<GlobalOptionDescription> container_type;
 239   typedef container_type::const_iterator const_iterator;
 240
 241   /// Descriptions - A list of GlobalOptionDescriptions.
 242   container_type Descriptions;
 243   /// HasSink - Should the emitter generate a "cl::sink" option?
 244   bool HasSink;
 245
 246   const GlobalOptionDescription& FindOption(const std::string& OptName) const {
 247     const_iterator I = Descriptions.find(OptName);
 248     if (I != Descriptions.end())
 249       return I->second;
 250     else
 251       throw OptName + ": no such option!";
 252   }
 253
 254   // Support for STL-style iteration
 255   const_iterator begin() const { return Descriptions.begin(); }
 256   const_iterator end() const { return Descriptions.end(); }
 257 };
 258
 259
 260 // Tool-local option description.
 261
 262 // Properties without arguments are implemented as flags.
 263 namespace ToolOptionDescriptionFlags {
 264   enum ToolOptionDescriptionFlags { StopCompilation = 0x1,
 265                                     Forward = 0x2, UnpackValues = 0x4};
 266 }
 267 namespace OptionPropertyType {
 268   enum OptionPropertyType { AppendCmd, OutputSuffix };
 269 }
 270
 271 typedef std::pair<OptionPropertyType::OptionPropertyType, std::string>
 272 OptionProperty;
 273 typedef SmallVector<OptionProperty, 4> OptionPropertyList;
 274
 275 struct ToolOptionDescription : public OptionDescription {
 276   unsigned Flags;
 277   OptionPropertyList Props;
 278
 279   // StringMap can only store DefaultConstructible objects
 280   ToolOptionDescription() : OptionDescription(), Flags(0) {}
 281
 282   ToolOptionDescription (OptionType::OptionType t, const std::string& n)
 283     : OptionDescription(t, n)
 284   {}
 285
 286   // Various boolean properties
 287   bool isStopCompilation() const {
 288     return Flags & ToolOptionDescriptionFlags::StopCompilation;
 289   }
 290   void setStopCompilation() {
 291     Flags |= ToolOptionDescriptionFlags::StopCompilation;
 292   }
 293
 294   bool isForward() const {
 295     return Flags & ToolOptionDescriptionFlags::Forward;
 296   }
 297   void setForward() {
 298     Flags |= ToolOptionDescriptionFlags::Forward;
 299   }
 300
 301   bool isUnpackValues() const {
 302     return Flags & ToolOptionDescriptionFlags::UnpackValues;
 303   }
 304   void setUnpackValues() {
 305     Flags |= ToolOptionDescriptionFlags::UnpackValues;
 306   }
 307
 308   void AddProperty (OptionPropertyType::OptionPropertyType t,
 309                     const std::string& val)
 310   {
 311     Props.push_back(std::make_pair(t, val));
 312   }
 313 };
 314
 315 typedef StringMap<ToolOptionDescription> ToolOptionDescriptions;
 316
 317 // Tool information record
 318
 319 namespace ToolFlags {
 320   enum ToolFlags { Join = 0x1, Sink = 0x2 };
 321 }
 322
 323 struct ToolProperties : public RefCountedBase<ToolProperties> {
 324   std::string Name;
 325   Init* CmdLine;
 326   StrVector InLanguage;
 327   std::string OutLanguage;
 328   std::string OutputSuffix;
 329   unsigned Flags;
 330   ToolOptionDescriptions OptDescs;
 331
 332   // Various boolean properties
 333   void setSink()      { Flags |= ToolFlags::Sink; }
 334   bool isSink() const { return Flags & ToolFlags::Sink; }
 335   void setJoin()      { Flags |= ToolFlags::Join; }
 336   bool isJoin() const { return Flags & ToolFlags::Join; }
 337
 338   // Default ctor here is needed because StringMap can only store
 339   // DefaultConstructible objects
 340   ToolProperties() : Flags(0) {}
 341   ToolProperties (const std::string& n) : Name(n), Flags(0) {}
 342 };
 343
 344
 345 /// ToolPropertiesList - A list of Tool information records
 346 /// IntrusiveRefCntPtrs are used here because StringMap has no copy
 347 /// constructor (and we want to avoid copying ToolProperties anyway).
 348 typedef std::vector<IntrusiveRefCntPtr<ToolProperties> > ToolPropertiesList;
 349
 350
 351 /// CollectProperties - Function object for iterating over a list of
 352 /// tool property records.
 353 class CollectProperties {
 354 private:
 355
 356   /// Implementation details
 357
 358   /// PropertyHandler - a function that extracts information
 359   /// about a given tool property from its DAG representation
 360   typedef void (CollectProperties::*PropertyHandler)(const DagInit*);
 361
 362   /// PropertyHandlerMap - A map from property names to property
 363   /// handlers.
 364   typedef StringMap<PropertyHandler> PropertyHandlerMap;
 365
 366   /// OptionPropertyHandler - a function that extracts information
 367   /// about a given option property from its DAG representation.
 368   typedef void (CollectProperties::* OptionPropertyHandler)
 369   (const DagInit*, GlobalOptionDescription &);
 370
 371   /// OptionPropertyHandlerMap - A map from option property names to
 372   /// option property handlers
 373   typedef StringMap<OptionPropertyHandler> OptionPropertyHandlerMap;
 374
 375   // Static maps from strings to CollectProperties methods("handlers")
 376   static PropertyHandlerMap propertyHandlers_;
 377   static OptionPropertyHandlerMap optionPropertyHandlers_;
 378   static bool staticMembersInitialized_;
 379
 380
 381   /// This is where the information is stored
 382
 383   /// toolProps_ -  Properties of the current Tool.
 384   ToolProperties& toolProps_;
 385   /// optDescs_ - OptionDescriptions table (used to register options
 386   /// globally).
 387   GlobalOptionDescriptions& optDescs_;
 388
 389 public:
 390
 391   explicit CollectProperties (ToolProperties& p, GlobalOptionDescriptions& d)
 392     : toolProps_(p), optDescs_(d)
 393   {
 394     if (!staticMembersInitialized_) {
 395       // Init tool property handlers
 396       propertyHandlers_["cmd_line"] = &CollectProperties::onCmdLine;
 397       propertyHandlers_["in_language"] = &CollectProperties::onInLanguage;
 398       propertyHandlers_["join"] = &CollectProperties::onJoin;
 399       propertyHandlers_["out_language"] = &CollectProperties::onOutLanguage;
 400       propertyHandlers_["output_suffix"] = &CollectProperties::onOutputSuffix;
 401       propertyHandlers_["parameter_option"]
 402         = &CollectProperties::onParameter;
 403       propertyHandlers_["parameter_list_option"] =
 404         &CollectProperties::onParameterList;
 405       propertyHandlers_["prefix_option"] = &CollectProperties::onPrefix;
 406       propertyHandlers_["prefix_list_option"] =
 407         &CollectProperties::onPrefixList;
 408       propertyHandlers_["sink"] = &CollectProperties::onSink;
 409       propertyHandlers_["switch_option"] = &CollectProperties::onSwitch;
 410       propertyHandlers_["alias_option"] = &CollectProperties::onAlias;
 411
 412       // Init option property handlers
 413       optionPropertyHandlers_["append_cmd"] = &CollectProperties::onAppendCmd;
 414       optionPropertyHandlers_["forward"] = &CollectProperties::onForward;
 415       optionPropertyHandlers_["help"] = &CollectProperties::onHelp;
 416       optionPropertyHandlers_["output_suffix"] =
 417         &CollectProperties::onOutputSuffixOptionProp;
 418       optionPropertyHandlers_["required"] = &CollectProperties::onRequired;
 419       optionPropertyHandlers_["stop_compilation"] =
 420         &CollectProperties::onStopCompilation;
 421       optionPropertyHandlers_["unpack_values"] =
 422         &CollectProperties::onUnpackValues;
 423
 424       staticMembersInitialized_ = true;
 425     }
 426   }
 427
 428   /// operator() - Gets called for every tool property; Just forwards
 429   /// to the corresponding property handler.
 430   void operator() (Init* i) {
 431     const DagInit& d = InitPtrToDag(i);
 432     const std::string& property_name = d.getOperator()->getAsString();
 433     PropertyHandlerMap::iterator method
 434       = propertyHandlers_.find(property_name);
 435
 436     if (method != propertyHandlers_.end()) {
 437       PropertyHandler h = method->second;
 438       (this->*h)(&d);
 439     }
 440     else {
 441       throw "Unknown tool property: " + property_name + "!";
 442     }
 443   }
 444
 445 private:
 446
 447   /// Property handlers --
 448   /// Functions that extract information about tool properties from
 449   /// DAG representation.
 450
 451   void onCmdLine (const DagInit* d) {
 452     checkNumberOfArguments(d, 1);
 453     toolProps_.CmdLine = d->getArg(0);
 454   }
 455
 456   void onInLanguage (const DagInit* d) {
 457     checkNumberOfArguments(d, 1);
 458     Init* arg = d->getArg(0);
 459
 460     // Find out the argument's type.
 461     if (typeid(*arg) == typeid(StringInit)) {
 462       // It's a string.
 463       toolProps_.InLanguage.push_back(InitPtrToString(arg));
 464     }
 465     else {
 466       // It's a list.
 467       const ListInit& lst = InitPtrToList(arg);
 468       StrVector& out = toolProps_.InLanguage;
 469
 470       // Copy strings to the output vector.
 471       for (ListInit::const_iterator B = lst.begin(), E = lst.end();
 472            B != E; ++B) {
 473         out.push_back(InitPtrToString(*B));
 474       }
 475
 476       // Remove duplicates.
 477       std::sort(out.begin(), out.end());
 478       StrVector::iterator newE = std::unique(out.begin(), out.end());
 479       out.erase(newE, out.end());
 480     }
 481   }
 482
 483   void onJoin (const DagInit* d) {
 484     checkNumberOfArguments(d, 0);
 485     toolProps_.setJoin();
 486   }
 487
 488   void onOutLanguage (const DagInit* d) {
 489     checkNumberOfArguments(d, 1);
 490     toolProps_.OutLanguage = InitPtrToString(d->getArg(0));
 491   }
 492
 493   void onOutputSuffix (const DagInit* d) {
 494     checkNumberOfArguments(d, 1);
 495     toolProps_.OutputSuffix = InitPtrToString(d->getArg(0));
 496   }
 497
 498   void onSink (const DagInit* d) {
 499     checkNumberOfArguments(d, 0);
 500     optDescs_.HasSink = true;
 501     toolProps_.setSink();
 502   }
 503
 504   void onAlias (const DagInit* d) {
 505     checkNumberOfArguments(d, 2);
 506     // We just need a GlobalOptionDescription for the aliases.
 507     insertDescription
 508       (GlobalOptionDescription(OptionType::Alias,
 509                                InitPtrToString(d->getArg(0)),
 510                                InitPtrToString(d->getArg(1))));
 511   }
 512
 513   void onSwitch (const DagInit* d) {
 514     addOption(d, OptionType::Switch);
 515   }
 516
 517   void onParameter (const DagInit* d) {
 518     addOption(d, OptionType::Parameter);
 519   }
 520
 521   void onParameterList (const DagInit* d) {
 522     addOption(d, OptionType::ParameterList);
 523   }
 524
 525   void onPrefix (const DagInit* d) {
 526     addOption(d, OptionType::Prefix);
 527   }
 528
 529   void onPrefixList (const DagInit* d) {
 530     addOption(d, OptionType::PrefixList);
 531   }
 532
 533   /// Option property handlers --
 534   /// Methods that handle properties that are common for all types of
 535   /// options (like append_cmd, stop_compilation)
 536
 537   void onAppendCmd (const DagInit* d, GlobalOptionDescription& o) {
 538     checkNumberOfArguments(d, 1);
 539     const std::string& cmd = InitPtrToString(d->getArg(0));
 540
 541     toolProps_.OptDescs[o.Name].AddProperty(OptionPropertyType::AppendCmd, cmd);
 542   }
 543
 544   void onOutputSuffixOptionProp (const DagInit* d, GlobalOptionDescription& o) {
 545     checkNumberOfArguments(d, 1);
 546     const std::string& suf = InitPtrToString(d->getArg(0));
 547
 548     if (toolProps_.OptDescs[o.Name].Type != OptionType::Switch)
 549       throw "Option " + o.Name
 550         + " can't have 'output_suffix' property since it isn't a switch!";
 551
 552     toolProps_.OptDescs[o.Name].AddProperty
 553       (OptionPropertyType::OutputSuffix, suf);
 554   }
 555
 556   void onForward (const DagInit* d, GlobalOptionDescription& o) {
 557     checkNumberOfArguments(d, 0);
 558     toolProps_.OptDescs[o.Name].setForward();
 559   }
 560
 561   void onHelp (const DagInit* d, GlobalOptionDescription& o) {
 562     checkNumberOfArguments(d, 1);
 563     const std::string& help_message = InitPtrToString(d->getArg(0));
 564
 565     o.Help = help_message;
 566   }
 567
 568   void onRequired (const DagInit* d, GlobalOptionDescription& o) {
 569     checkNumberOfArguments(d, 0);
 570     o.setRequired();
 571   }
 572
 573   void onStopCompilation (const DagInit* d, GlobalOptionDescription& o) {
 574     checkNumberOfArguments(d, 0);
 575     if (o.Type != OptionType::Switch)
 576       throw std::string("Only options of type Switch can stop compilation!");
 577     toolProps_.OptDescs[o.Name].setStopCompilation();
 578   }
 579
 580   void onUnpackValues (const DagInit* d, GlobalOptionDescription& o) {
 581     checkNumberOfArguments(d, 0);
 582     toolProps_.OptDescs[o.Name].setUnpackValues();
 583   }
 584
 585   /// Helper functions
 586
 587   // Add an option of type t
 588   void addOption (const DagInit* d, OptionType::OptionType t) {
 589     checkNumberOfArguments(d, 2);
 590     const std::string& name = InitPtrToString(d->getArg(0));
 591
 592     GlobalOptionDescription o(t, name);
 593     toolProps_.OptDescs[name].Type = t;
 594     toolProps_.OptDescs[name].Name = name;
 595     processOptionProperties(d, o);
 596     insertDescription(o);
 597   }
 598
 599   // Insert new GlobalOptionDescription into GlobalOptionDescriptions list
 600   void insertDescription (const GlobalOptionDescription& o)
 601   {
 602     if (optDescs_.Descriptions.count(o.Name)) {
 603       GlobalOptionDescription& D = optDescs_.Descriptions[o.Name];
 604       D.Merge(o);
 605     }
 606     else {
 607       optDescs_.Descriptions[o.Name] = o;
 608     }
 609   }
 610
 611   /// processOptionProperties - Go through the list of option
 612   /// properties and call a corresponding handler for each.
 613   ///
 614   /// Parameters:
 615   /// name - option name
 616   /// d - option property list
 617   void processOptionProperties (const DagInit* d, GlobalOptionDescription& o) {
 618     // First argument is option name
 619     checkNumberOfArguments(d, 2);
 620
 621     for (unsigned B = 1, E = d->getNumArgs(); B!=E; ++B) {
 622       const DagInit& option_property
 623         = InitPtrToDag(d->getArg(B));
 624       const std::string& option_property_name
 625         = option_property.getOperator()->getAsString();
 626       OptionPropertyHandlerMap::iterator method
 627         = optionPropertyHandlers_.find(option_property_name);
 628
 629       if (method != optionPropertyHandlers_.end()) {
 630         OptionPropertyHandler h = method->second;
 631         (this->*h)(&option_property, o);
 632       }
 633       else {
 634         throw "Unknown option property: " + option_property_name + "!";
 635       }
 636     }
 637   }
 638 };
 639
 640 // Static members of CollectProperties
 641 CollectProperties::PropertyHandlerMap
 642 CollectProperties::propertyHandlers_;
 643
 644 CollectProperties::OptionPropertyHandlerMap
 645 CollectProperties::optionPropertyHandlers_;
 646
 647 bool CollectProperties::staticMembersInitialized_ = false;
 648
 649
 650 /// CollectToolProperties - Gather information from the parsed
 651 /// TableGen data (basically a wrapper for the CollectProperties
 652 /// function object).
 653 void CollectToolProperties (RecordVector::const_iterator B,
 654                             RecordVector::const_iterator E,
 655                             ToolPropertiesList& TPList,
 656                             GlobalOptionDescriptions& OptDescs)
 657 {
 658   // Iterate over a properties list of every Tool definition
 659   for (;B!=E;++B) {
 660     RecordVector::value_type T = *B;
 661     ListInit* PropList = T->getValueAsListInit("properties");
 662
 663     IntrusiveRefCntPtr<ToolProperties>
 664       ToolProps(new ToolProperties(T->getName()));
 665
 666     std::for_each(PropList->begin(), PropList->end(),
 667                   CollectProperties(*ToolProps, OptDescs));
 668     TPList.push_back(ToolProps);
 669   }
 670 }
 671
 672 /// EmitCaseTest1Arg - Helper function used by
 673 /// EmitCaseConstructHandler.
 674 bool EmitCaseTest1Arg(const std::string& TestName,
 675                       const DagInit& d,
 676                       const GlobalOptionDescriptions& OptDescs,
 677                       std::ostream& O) {
 678   checkNumberOfArguments(&d, 1);
 679   const std::string& OptName = InitPtrToString(d.getArg(0));
 680   if (TestName == "switch_on") {
 681     const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
 682     if (OptDesc.Type != OptionType::Switch)
 683       throw OptName + ": incorrect option type!";
 684     O << OptDesc.GenVariableName();
 685     return true;
 686   } else if (TestName == "input_languages_contain") {
 687     O << "InLangs.count(\"" << OptName << "\") != 0";
 688     return true;
 689   } else if (TestName == "in_language") {
 690     // Works only for cmd_line!
 691     O << "GetLanguage(inFile) == \"" << OptName << '\"';
 692     return true;
 693   } else if (TestName == "not_empty") {
 694     if (OptName == "o") {
 695       O << "!OutputFilename.empty()";
 696       return true;
 697     }
 698     else {
 699       const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
 700       if (OptDesc.Type == OptionType::Switch)
 701         throw OptName + ": incorrect option type!";
 702       O << '!' << OptDesc.GenVariableName() << ".empty()";
 703       return true;
 704     }
 705   }
 706
 707   return false;
 708 }
 709
 710 /// EmitCaseTest2Args - Helper function used by
 711 /// EmitCaseConstructHandler.
 712 bool EmitCaseTest2Args(const std::string& TestName,
 713                        const DagInit& d,
 714                        const char* IndentLevel,
 715                        const GlobalOptionDescriptions& OptDescs,
 716                        std::ostream& O) {
 717   checkNumberOfArguments(&d, 2);
 718   const std::string& OptName = InitPtrToString(d.getArg(0));
 719   const std::string& OptArg = InitPtrToString(d.getArg(1));
 720   const GlobalOptionDescription& OptDesc = OptDescs.FindOption(OptName);
 721
 722   if (TestName == "parameter_equals") {
 723     if (OptDesc.Type != OptionType::Parameter
 724         && OptDesc.Type != OptionType::Prefix)
 725       throw OptName + ": incorrect option type!";
 726     O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
 727     return true;
 728   }
 729   else if (TestName == "element_in_list") {
 730     if (OptDesc.Type != OptionType::ParameterList
 731         && OptDesc.Type != OptionType::PrefixList)
 732       throw OptName + ": incorrect option type!";
 733     const std::string& VarName = OptDesc.GenVariableName();
 734     O << "std::find(" << VarName << ".begin(),\n"
 735       << IndentLevel << Indent1 << VarName << ".end(), \""
 736       << OptArg << "\") != " << VarName << ".end()";
 737     return true;
 738   }
 739
 740   return false;
 741 }
 742
 743 // Forward declaration.
 744 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
 745 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
 746                   const GlobalOptionDescriptions& OptDescs,
 747                   std::ostream& O);
 748
 749 /// EmitLogicalOperationTest - Helper function used by
 750 /// EmitCaseConstructHandler.
 751 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
 752                               const char* IndentLevel,
 753                               const GlobalOptionDescriptions& OptDescs,
 754                               std::ostream& O) {
 755   O << '(';
 756   for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
 757     const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
 758     EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
 759     if (j != NumArgs - 1)
 760       O << ")\n" << IndentLevel << Indent1 << ' ' << LogicOp << " (";
 761     else
 762       O << ')';
 763   }
 764 }
 765
 766 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
 767 void EmitCaseTest(const DagInit& d, const char* IndentLevel,
 768                   const GlobalOptionDescriptions& OptDescs,
 769                   std::ostream& O) {
 770   const std::string& TestName = d.getOperator()->getAsString();
 771
 772   if (TestName == "and")
 773     EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
 774   else if (TestName == "or")
 775     EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
 776   else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
 777     return;
 778   else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
 779     return;
 780   else
 781     throw TestName + ": unknown edge property!";
 782 }
 783
 784 // Emit code that handles the 'case' construct.
 785 // Takes a function object that should emit code for every case clause.
 786 // Callback's type is
 787 // void F(Init* Statement, const char* IndentLevel, std::ostream& O).
 788 template <typename F>
 789 void EmitCaseConstructHandler(const DagInit* d, const char* IndentLevel,
 790                               const F& Callback, bool EmitElseIf,
 791                               const GlobalOptionDescriptions& OptDescs,
 792                               std::ostream& O) {
 793   assert(d->getOperator()->getAsString() == "case");
 794
 795   unsigned numArgs = d->getNumArgs();
 796   if (d->getNumArgs() < 2)
 797     throw "There should be at least one clause in the 'case' expression:\n"
 798       + d->getAsString();
 799
 800   for (unsigned i = 0; i != numArgs; ++i) {
 801     const DagInit& Test = InitPtrToDag(d->getArg(i));
 802
 803     // Emit the test.
 804     if (Test.getOperator()->getAsString() == "default") {
 805       if (i+2 != numArgs)
 806         throw std::string("The 'default' clause should be the last in the"
 807                           "'case' construct!");
 808       O << IndentLevel << "else {\n";
 809     }
 810     else {
 811       O << IndentLevel << ((i != 0 && EmitElseIf) ? "else if (" : "if (");
 812       EmitCaseTest(Test, IndentLevel, OptDescs, O);
 813       O << ") {\n";
 814     }
 815
 816     // Emit the corresponding statement.
 817     ++i;
 818     if (i == numArgs)
 819       throw "Case construct handler: no corresponding action "
 820         "found for the test " + Test.getAsString() + '!';
 821
 822     Init* arg = d->getArg(i);
 823     if (dynamic_cast<DagInit*>(arg)
 824         && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case") {
 825       EmitCaseConstructHandler(static_cast<DagInit*>(arg),
 826                                (std::string(IndentLevel) + Indent1).c_str(),
 827                                Callback, EmitElseIf, OptDescs, O);
 828     }
 829     else {
 830       Callback(arg, IndentLevel, O);
 831     }
 832     O << IndentLevel << "}\n";
 833   }
 834 }
 835
 836 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
 837 /// implement EmitOptionPropertyHandlingCode(). Emits code for
 838 /// handling the (forward) option property.
 839 void EmitForwardOptionPropertyHandlingCode (const ToolOptionDescription& D,
 840                                             std::ostream& O) {
 841   switch (D.Type) {
 842   case OptionType::Switch:
 843     O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
 844     break;
 845   case OptionType::Parameter:
 846     O << Indent3 << "vec.push_back(\"-" << D.Name << "\");\n";
 847     O << Indent3 << "vec.push_back(" << D.GenVariableName() << ");\n";
 848     break;
 849   case OptionType::Prefix:
 850     O << Indent3 << "vec.push_back(\"-" << D.Name << "\" + "
 851       << D.GenVariableName() << ");\n";
 852     break;
 853   case OptionType::PrefixList:
 854     O << Indent3 << "for (" << D.GenTypeDeclaration()
 855       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
 856       << Indent3 << "E = " << D.GenVariableName() << ".end(); B != E; ++B)\n"
 857       << Indent4 << "vec.push_back(\"-" << D.Name << "\" + "
 858       << "*B);\n";
 859     break;
 860   case OptionType::ParameterList:
 861     O << Indent3 << "for (" << D.GenTypeDeclaration()
 862       << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
 863       << Indent3 << "E = " << D.GenVariableName()
 864       << ".end() ; B != E; ++B) {\n"
 865       << Indent4 << "vec.push_back(\"-" << D.Name << "\");\n"
 866       << Indent4 << "vec.push_back(*B);\n"
 867       << Indent3 << "}\n";
 868     break;
 869   case OptionType::Alias:
 870   default:
 871     throw std::string("Aliases are not allowed in tool option descriptions!");
 872   }
 873 }
 874
 875 // ToolOptionHasInterestingProperties - A helper function used by
 876 // EmitOptionPropertyHandlingCode() that tells us whether we should
 877 // emit any property handling code at all.
 878 bool ToolOptionHasInterestingProperties(const ToolOptionDescription& D) {
 879   bool ret = false;
 880   for (OptionPropertyList::const_iterator B = D.Props.begin(),
 881          E = D.Props.end(); B != E; ++B) {
 882       const OptionProperty& OptProp = *B;
 883       if (OptProp.first == OptionPropertyType::AppendCmd)
 884         ret = true;
 885     }
 886   if (D.isForward() || D.isUnpackValues())
 887     ret = true;
 888   return ret;
 889 }
 890
 891 /// EmitOptionPropertyHandlingCode - Helper function used by
 892 /// EmitGenerateActionMethod(). Emits code that handles option
 893 /// properties.
 894 void EmitOptionPropertyHandlingCode (const ToolOptionDescription& D,
 895                                      std::ostream& O)
 896 {
 897   if (!ToolOptionHasInterestingProperties(D))
 898     return;
 899   // Start of the if-clause.
 900   O << Indent2 << "if (";
 901   if (D.Type == OptionType::Switch)
 902     O << D.GenVariableName();
 903   else
 904     O << '!' << D.GenVariableName() << ".empty()";
 905
 906   O <<") {\n";
 907
 908   // Handle option properties that take an argument.
 909   for (OptionPropertyList::const_iterator B = D.Props.begin(),
 910         E = D.Props.end(); B!=E; ++B) {
 911     const OptionProperty& val = *B;
 912
 913     switch (val.first) {
 914       // (append_cmd cmd) property
 915     case OptionPropertyType::AppendCmd:
 916       O << Indent3 << "vec.push_back(\"" << val.second << "\");\n";
 917       break;
 918       // Other properties with argument
 919     default:
 920       break;
 921     }
 922   }
 923
 924   // Handle flags
 925
 926   // (forward) property
 927   if (D.isForward())
 928     EmitForwardOptionPropertyHandlingCode(D, O);
 929
 930   // (unpack_values) property
 931   if (D.isUnpackValues()) {
 932     if (IsListOptionType(D.Type)) {
 933       O << Indent3 << "for (" << D.GenTypeDeclaration()
 934         << "::iterator B = " << D.GenVariableName() << ".begin(),\n"
 935         << Indent3 << "E = " << D.GenVariableName()
 936         << ".end(); B != E; ++B)\n"
 937         << Indent4 << "llvm::SplitString(*B, vec, \",\");\n";
 938     }
 939     else if (D.Type == OptionType::Prefix || D.Type == OptionType::Parameter){
 940       O << Indent3 << "llvm::SplitString("
 941         << D.GenVariableName() << ", vec, \",\");\n";
 942     }
 943     else {
 944       throw std::string("Switches can't have unpack_values property!");
 945     }
 946   }
 947
 948   // End of the if-clause.
 949   O << Indent2 << "}\n";
 950 }
 951
 952 /// SubstituteSpecialCommands - Perform string substitution for $CALL
 953 /// and $ENV. Helper function used by EmitCmdLineVecFill().
 954 std::string SubstituteSpecialCommands(const std::string& cmd) {
 955   size_t cparen = cmd.find(")");
 956   std::string ret;
 957
 958   if (cmd.find("$CALL(") == 0) {
 959     if (cmd.size() == 6)
 960       throw std::string("$CALL invocation: empty argument list!");
 961
 962     ret += "hooks::";
 963     ret += std::string(cmd.begin() + 6, cmd.begin() + cparen);
 964     ret += "()";
 965   }
 966   else if (cmd.find("$ENV(") == 0) {
 967     if (cmd.size() == 5)
 968       throw std::string("$ENV invocation: empty argument list!");
 969
 970     ret += "std::getenv(\"";
 971     ret += std::string(cmd.begin() + 5, cmd.begin() + cparen);
 972     ret += "\")";
 973   }
 974   else {
 975     throw "Unknown special command: " + cmd;
 976   }
 977
 978   if (cmd.begin() + cparen + 1 != cmd.end()) {
 979     ret += " + std::string(\"";
 980     ret += (cmd.c_str() + cparen + 1);
 981     ret += "\")";
 982   }
 983
 984   return ret;
 985 }
 986
 987 /// EmitCmdLineVecFill - Emit code that fills in the command line
 988 /// vector. Helper function used by EmitGenerateActionMethod().
 989 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
 990                         bool Version, const char* IndentLevel,
 991                         std::ostream& O) {
 992   StrVector StrVec;
 993   SplitString(InitPtrToString(CmdLine), StrVec);
 994   if (StrVec.empty())
 995     throw "Tool " + ToolName + " has empty command line!";
 996
 997   StrVector::const_iterator I = StrVec.begin();
 998   ++I;
 999   for (StrVector::const_iterator E = StrVec.end(); I != E; ++I) {
1000     const std::string& cmd = *I;
1001     O << IndentLevel;
1002     if (cmd.at(0) == '$') {
1003       if (cmd == "$INFILE") {
1004         if (Version)
1005           O << "for (PathVector::const_iterator B = inFiles.begin()"
1006             << ", E = inFiles.end();\n"
1007             << IndentLevel << "B != E; ++B)\n"
1008             << IndentLevel << Indent1 << "vec.push_back(B->toString());\n";
1009         else
1010           O << "vec.push_back(inFile.toString());\n";
1011       }
1012       else if (cmd == "$OUTFILE") {
1013         O << "vec.push_back(outFile.toString());\n";
1014       }
1015       else {
1016         O << "vec.push_back(" << SubstituteSpecialCommands(cmd);
1017         O << ");\n";
1018       }
1019     }
1020     else {
1021       O << "vec.push_back(\"" << cmd << "\");\n";
1022     }
1023   }
1024   O << IndentLevel << "cmd = "
1025     << ((StrVec[0][0] == '$') ? SubstituteSpecialCommands(StrVec[0])
1026         : "\"" + StrVec[0] + "\"")
1027     << ";\n";
1028 }
1029
1030 /// EmitCmdLineVecFillCallback - A function object wrapper around
1031 /// EmitCmdLineVecFill(). Used by EmitGenerateActionMethod() as an
1032 /// argument to EmitCaseConstructHandler().
1033 class EmitCmdLineVecFillCallback {
1034   bool Version;
1035   const std::string& ToolName;
1036  public:
1037   EmitCmdLineVecFillCallback(bool Ver, const std::string& TN)
1038     : Version(Ver), ToolName(TN) {}
1039
1040   void operator()(const Init* Statement, const char* IndentLevel,
1041                   std::ostream& O) const
1042   {
1043     EmitCmdLineVecFill(Statement, ToolName, Version,
1044                        (std::string(IndentLevel) + Indent1).c_str(), O);
1045   }
1046 };
1047
1048 // EmitGenerateActionMethod - Emit one of two versions of the
1049 // Tool::GenerateAction() method.
1050 void EmitGenerateActionMethod (const ToolProperties& P,
1051                                const GlobalOptionDescriptions& OptDescs,
1052                                bool Version, std::ostream& O) {
1053   if (Version)
1054     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n";
1055   else
1056     O << Indent1 << "Action GenerateAction(const sys::Path& inFile,\n";
1057
1058   O << Indent2 << "const sys::Path& outFile,\n"
1059     << Indent2 << "const InputLanguagesSet& InLangs) const\n"
1060     << Indent1 << "{\n"
1061     << Indent2 << "const char* cmd;\n"
1062     << Indent2 << "std::vector<std::string> vec;\n";
1063
1064   // cmd_line is either a string or a 'case' construct.
1065   if (typeid(*P.CmdLine) == typeid(StringInit))
1066     EmitCmdLineVecFill(P.CmdLine, P.Name, Version, Indent2, O);
1067   else
1068     EmitCaseConstructHandler(&InitPtrToDag(P.CmdLine), Indent2,
1069                              EmitCmdLineVecFillCallback(Version, P.Name),
1070                              true, OptDescs, O);
1071
1072   // For every understood option, emit handling code.
1073   for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1074         E = P.OptDescs.end(); B != E; ++B) {
1075     const ToolOptionDescription& val = B->second;
1076     EmitOptionPropertyHandlingCode(val, O);
1077   }
1078
1079   // Handle the Sink property.
1080   if (P.isSink()) {
1081     O << Indent2 << "if (!" << SinkOptionName << ".empty()) {\n"
1082       << Indent3 << "vec.insert(vec.end(), "
1083       << SinkOptionName << ".begin(), " << SinkOptionName << ".end());\n"
1084       << Indent2 << "}\n";
1085   }
1086
1087   O << Indent2 << "return Action(cmd, vec);\n"
1088     << Indent1 << "}\n\n";
1089 }
1090
1091 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
1092 /// a given Tool class.
1093 void EmitGenerateActionMethods (const ToolProperties& P,
1094                                 const GlobalOptionDescriptions& OptDescs,
1095                                 std::ostream& O) {
1096   if (!P.isJoin())
1097     O << Indent1 << "Action GenerateAction(const PathVector& inFiles,\n"
1098       << Indent2 << "const llvm::sys::Path& outFile,\n"
1099       << Indent2 << "const InputLanguagesSet& InLangs) const\n"
1100       << Indent1 << "{\n"
1101       << Indent2 << "throw std::runtime_error(\"" << P.Name
1102       << " is not a Join tool!\");\n"
1103       << Indent1 << "}\n\n";
1104   else
1105     EmitGenerateActionMethod(P, OptDescs, true, O);
1106
1107   EmitGenerateActionMethod(P, OptDescs, false, O);
1108 }
1109
1110 /// EmitIsLastMethod - Emit the IsLast() method for a given Tool
1111 /// class.
1112 void EmitIsLastMethod (const ToolProperties& P, std::ostream& O) {
1113   O << Indent1 << "bool IsLast() const {\n"
1114     << Indent2 << "bool last = false;\n";
1115
1116   for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1117         E = P.OptDescs.end(); B != E; ++B) {
1118     const ToolOptionDescription& val = B->second;
1119
1120     if (val.isStopCompilation())
1121       O << Indent2
1122         << "if (" << val.GenVariableName()
1123         << ")\n" << Indent3 << "last = true;\n";
1124   }
1125
1126   O << Indent2 << "return last;\n"
1127     << Indent1 <<  "}\n\n";
1128 }
1129
1130 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
1131 /// methods for a given Tool class.
1132 void EmitInOutLanguageMethods (const ToolProperties& P, std::ostream& O) {
1133   O << Indent1 << "const char** InputLanguages() const {\n"
1134     << Indent2 << "return InputLanguages_;\n"
1135     << Indent1 << "}\n\n";
1136
1137   O << Indent1 << "const char* OutputLanguage() const {\n"
1138     << Indent2 << "return \"" << P.OutLanguage << "\";\n"
1139     << Indent1 << "}\n\n";
1140 }
1141
1142 /// EmitOutputSuffixMethod - Emit the OutputSuffix() method for a
1143 /// given Tool class.
1144 void EmitOutputSuffixMethod (const ToolProperties& P, std::ostream& O) {
1145   O << Indent1 << "const char* OutputSuffix() const {\n"
1146     << Indent2 << "const char* ret = \"" << P.OutputSuffix << "\";\n";
1147
1148   for (ToolOptionDescriptions::const_iterator B = P.OptDescs.begin(),
1149          E = P.OptDescs.end(); B != E; ++B) {
1150     const ToolOptionDescription& OptDesc = B->second;
1151     for (OptionPropertyList::const_iterator B = OptDesc.Props.begin(),
1152            E = OptDesc.Props.end(); B != E; ++B) {
1153       const OptionProperty& OptProp = *B;
1154       if (OptProp.first == OptionPropertyType::OutputSuffix) {
1155         O << Indent2 << "if (" << OptDesc.GenVariableName() << ")\n"
1156           << Indent3 << "ret = \"" << OptProp.second << "\";\n";
1157       }
1158     }
1159   }
1160
1161   O << Indent2 << "return ret;\n"
1162     << Indent1 << "}\n\n";
1163 }
1164
1165 /// EmitNameMethod - Emit the Name() method for a given Tool class.
1166 void EmitNameMethod (const ToolProperties& P, std::ostream& O) {
1167   O << Indent1 << "const char* Name() const {\n"
1168     << Indent2 << "return \"" << P.Name << "\";\n"
1169     << Indent1 << "}\n\n";
1170 }
1171
1172 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
1173 /// class.
1174 void EmitIsJoinMethod (const ToolProperties& P, std::ostream& O) {
1175   O << Indent1 << "bool IsJoin() const {\n";
1176   if (P.isJoin())
1177     O << Indent2 << "return true;\n";
1178   else
1179     O << Indent2 << "return false;\n";
1180   O << Indent1 << "}\n\n";
1181 }
1182
1183 /// EmitStaticMemberDefinitions - Emit static member definitions for a
1184 /// given Tool class.
1185 void EmitStaticMemberDefinitions(const ToolProperties& P, std::ostream& O) {
1186   O << "const char* " << P.Name << "::InputLanguages_[] = {";
1187   for (StrVector::const_iterator B = P.InLanguage.begin(),
1188          E = P.InLanguage.end(); B != E; ++B)
1189     O << '\"' << *B << "\", ";
1190   O << "0};\n\n";
1191 }
1192
1193 /// EmitToolClassDefinition - Emit a Tool class definition.
1194 void EmitToolClassDefinition (const ToolProperties& P,
1195                               const GlobalOptionDescriptions& OptDescs,
1196                               std::ostream& O) {
1197   if (P.Name == "root")
1198     return;
1199
1200   // Header
1201   O << "class " << P.Name << " : public ";
1202   if (P.isJoin())
1203     O << "JoinTool";
1204   else
1205     O << "Tool";
1206
1207   O << "{\nprivate:\n"
1208     << Indent1 << "static const char* InputLanguages_[];\n\n";
1209
1210   O << "public:\n";
1211   EmitNameMethod(P, O);
1212   EmitInOutLanguageMethods(P, O);
1213   EmitOutputSuffixMethod(P, O);
1214   EmitIsJoinMethod(P, O);
1215   EmitGenerateActionMethods(P, OptDescs, O);
1216   EmitIsLastMethod(P, O);
1217
1218   // Close class definition
1219   O << "};\n";
1220
1221   EmitStaticMemberDefinitions(P, O);
1222
1223 }
1224
1225 /// EmitOptionDescriptions - Iterate over a list of option
1226 /// descriptions and emit registration code.
1227 void EmitOptionDescriptions (const GlobalOptionDescriptions& descs,
1228                              std::ostream& O)
1229 {
1230   std::vector<GlobalOptionDescription> Aliases;
1231
1232   // Emit static cl::Option variables.
1233   for (GlobalOptionDescriptions::const_iterator B = descs.begin(),
1234          E = descs.end(); B!=E; ++B) {
1235     const GlobalOptionDescription& val = B->second;
1236
1237     if (val.Type == OptionType::Alias) {
1238       Aliases.push_back(val);
1239       continue;
1240     }
1241
1242     O << val.GenTypeDeclaration() << ' '
1243       << val.GenVariableName()
1244       << "(\"" << val.Name << '\"';
1245
1246     if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
1247       O << ", cl::Prefix";
1248
1249     if (val.isRequired()) {
1250       switch (val.Type) {
1251       case OptionType::PrefixList:
1252       case OptionType::ParameterList:
1253         O << ", cl::OneOrMore";
1254         break;
1255       default:
1256         O << ", cl::Required";
1257       }
1258     }
1259
1260     if (!val.Help.empty())
1261       O << ", cl::desc(\"" << val.Help << "\")";
1262
1263     O << ");\n";
1264   }
1265
1266   // Emit the aliases (they should go after all the 'proper' options).
1267   for (std::vector<GlobalOptionDescription>::const_iterator
1268          B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
1269     const GlobalOptionDescription& val = *B;
1270
1271     O << val.GenTypeDeclaration() << ' '
1272       << val.GenVariableName()
1273       << "(\"" << val.Name << '\"';
1274
1275     GlobalOptionDescriptions::container_type
1276       ::const_iterator F = descs.Descriptions.find(val.Help);
1277     if (F != descs.Descriptions.end())
1278       O << ", cl::aliasopt(" << F->second.GenVariableName() << ")";
1279     else
1280       throw val.Name + ": alias to an unknown option!";
1281
1282     O << ", cl::desc(\"" << "An alias for -" + val.Help  << "\"));\n";
1283   }
1284
1285   // Emit the sink option.
1286   if (descs.HasSink)
1287     O << "cl::list<std::string> " << SinkOptionName << "(cl::Sink);\n";
1288
1289   O << '\n';
1290 }
1291
1292 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMap() function.
1293 void EmitPopulateLanguageMap (const RecordKeeper& Records, std::ostream& O)
1294 {
1295   // Get the relevant field out of RecordKeeper
1296   Record* LangMapRecord = Records.getDef("LanguageMap");
1297   if (!LangMapRecord)
1298     throw std::string("Language map definition not found!");
1299
1300   ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
1301   if (!LangsToSuffixesList)
1302     throw std::string("Error in the language map definition!");
1303
1304   // Generate code
1305   O << "void llvmc::PopulateLanguageMap() {\n";
1306
1307   for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
1308     Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
1309
1310     const std::string& Lang = LangToSuffixes->getValueAsString("lang");
1311     const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
1312
1313     for (unsigned i = 0; i < Suffixes->size(); ++i)
1314       O << Indent1 << "GlobalLanguageMap[\""
1315         << InitPtrToString(Suffixes->getElement(i))
1316         << "\"] = \"" << Lang << "\";\n";
1317   }
1318
1319   O << "}\n\n";
1320 }
1321
1322 /// FillInToolToLang - Fills in two tables that map tool names to
1323 /// (input, output) languages.  Used by the typechecker.
1324 void FillInToolToLang (const ToolPropertiesList& TPList,
1325                        StringMap<StringSet<> >& ToolToInLang,
1326                        StringMap<std::string>& ToolToOutLang) {
1327   for (ToolPropertiesList::const_iterator B = TPList.begin(), E = TPList.end();
1328        B != E; ++B) {
1329     const ToolProperties& P = *(*B);
1330     for (StrVector::const_iterator B = P.InLanguage.begin(),
1331            E = P.InLanguage.end(); B != E; ++B)
1332       ToolToInLang[P.Name].insert(*B);
1333     ToolToOutLang[P.Name] = P.OutLanguage;
1334   }
1335 }
1336
1337 /// TypecheckGraph - Check that names for output and input languages
1338 /// on all edges do match.
1339 // TOFIX: It would be nice if this function also checked for cycles
1340 // and multiple default edges in the graph (better error
1341 // reporting). Unfortunately, it is awkward to do right now because
1342 // our intermediate representation is not sufficiently
1343 // sofisticated. Algorithms like these should be run on a real graph
1344 // instead of AST.
1345 void TypecheckGraph (Record* CompilationGraph,
1346                      const ToolPropertiesList& TPList) {
1347   StringMap<StringSet<> > ToolToInLang;
1348   StringMap<std::string> ToolToOutLang;
1349
1350   FillInToolToLang(TPList, ToolToInLang, ToolToOutLang);
1351   ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1352   StringMap<std::string>::iterator IAE = ToolToOutLang.end();
1353   StringMap<StringSet<> >::iterator IBE = ToolToInLang.end();
1354
1355   for (unsigned i = 0; i < edges->size(); ++i) {
1356     Record* Edge = edges->getElementAsRecord(i);
1357     Record* A = Edge->getValueAsDef("a");
1358     Record* B = Edge->getValueAsDef("b");
1359     StringMap<std::string>::iterator IA = ToolToOutLang.find(A->getName());
1360     StringMap<StringSet<> >::iterator IB = ToolToInLang.find(B->getName());
1361     if (IA == IAE)
1362       throw A->getName() + ": no such tool!";
1363     if (IB == IBE)
1364       throw B->getName() + ": no such tool!";
1365     if (A->getName() != "root" && IB->second.count(IA->second) == 0)
1366       throw "Edge " + A->getName() + "->" + B->getName()
1367         + ": output->input language mismatch";
1368     if (B->getName() == "root")
1369       throw std::string("Edges back to the root are not allowed!");
1370   }
1371 }
1372
1373 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
1374 /// by EmitEdgeClass().
1375 void IncDecWeight (const Init* i, const char* IndentLevel,
1376                    std::ostream& O) {
1377   const DagInit& d = InitPtrToDag(i);
1378   const std::string& OpName = d.getOperator()->getAsString();
1379
1380   if (OpName == "inc_weight")
1381     O << IndentLevel << Indent1 << "ret += ";
1382   else if (OpName == "dec_weight")
1383     O << IndentLevel << Indent1 << "ret -= ";
1384   else
1385     throw "Unknown operator in edge properties list: " + OpName + '!';
1386
1387   if (d.getNumArgs() > 0)
1388     O << InitPtrToInt(d.getArg(0)) << ";\n";
1389   else
1390     O << "2;\n";
1391
1392 }
1393
1394 /// EmitEdgeClass - Emit a single Edge# class.
1395 void EmitEdgeClass (unsigned N, const std::string& Target,
1396                     DagInit* Case, const GlobalOptionDescriptions& OptDescs,
1397                     std::ostream& O) {
1398
1399   // Class constructor.
1400   O << "class Edge" << N << ": public Edge {\n"
1401     << "public:\n"
1402     << Indent1 << "Edge" << N << "() : Edge(\"" << Target
1403     << "\") {}\n\n"
1404
1405   // Function Weight().
1406     << Indent1 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n"
1407     << Indent2 << "unsigned ret = 0;\n";
1408
1409   // Handle the 'case' construct.
1410   EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
1411
1412   O << Indent2 << "return ret;\n"
1413     << Indent1 << "};\n\n};\n\n";
1414 }
1415
1416 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
1417 void EmitEdgeClasses (Record* CompilationGraph,
1418                       const GlobalOptionDescriptions& OptDescs,
1419                       std::ostream& O) {
1420   ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1421
1422   for (unsigned i = 0; i < edges->size(); ++i) {
1423     Record* Edge = edges->getElementAsRecord(i);
1424     Record* B = Edge->getValueAsDef("b");
1425     DagInit* Weight = Edge->getValueAsDag("weight");
1426
1427     if (isDagEmpty(Weight))
1428       continue;
1429
1430     EmitEdgeClass(i, B->getName(), Weight, OptDescs, O);
1431   }
1432 }
1433
1434 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraph()
1435 /// function.
1436 void EmitPopulateCompilationGraph (Record* CompilationGraph,
1437                                    std::ostream& O)
1438 {
1439   ListInit* edges = CompilationGraph->getValueAsListInit("edges");
1440
1441   // Generate code
1442   O << "void llvmc::PopulateCompilationGraph(CompilationGraph& G) {\n"
1443     << Indent1 << "PopulateLanguageMap();\n\n";
1444
1445   // Insert vertices
1446
1447   RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1448   if (Tools.empty())
1449     throw std::string("No tool definitions found!");
1450
1451   for (RecordVector::iterator B = Tools.begin(), E = Tools.end(); B != E; ++B) {
1452     const std::string& Name = (*B)->getName();
1453     if (Name != "root")
1454       O << Indent1 << "G.insertNode(new "
1455         << Name << "());\n";
1456   }
1457
1458   O << '\n';
1459
1460   // Insert edges
1461   for (unsigned i = 0; i < edges->size(); ++i) {
1462     Record* Edge = edges->getElementAsRecord(i);
1463     Record* A = Edge->getValueAsDef("a");
1464     Record* B = Edge->getValueAsDef("b");
1465     DagInit* Weight = Edge->getValueAsDag("weight");
1466
1467     O << Indent1 << "G.insertEdge(\"" << A->getName() << "\", ";
1468
1469     if (isDagEmpty(Weight))
1470       O << "new SimpleEdge(\"" << B->getName() << "\")";
1471     else
1472       O << "new Edge" << i << "()";
1473
1474     O << ");\n";
1475   }
1476
1477   O << "}\n\n";
1478 }
1479
1480 /// ExtractHookNames - Extract the hook names from all instances of
1481 /// $CALL(HookName) in the provided command line string. Helper
1482 /// function used by FillInHookNames().
1483 void ExtractHookNames(const Init* CmdLine, StrVector& HookNames) {
1484   StrVector cmds;
1485   llvm::SplitString(InitPtrToString(CmdLine), cmds);
1486   for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
1487        B != E; ++B) {
1488     const std::string& cmd = *B;
1489     if (cmd.find("$CALL(") == 0) {
1490       if (cmd.size() == 6)
1491         throw std::string("$CALL invocation: empty argument list!");
1492       HookNames.push_back(std::string(cmd.begin() + 6,
1493                                       cmd.begin() + cmd.find(")")));
1494     }
1495   }
1496 }
1497
1498 /// ExtractHookNamesFromCaseConstruct - Extract hook names from the
1499 /// 'case' expression, handle nesting. Helper function used by
1500 /// FillInHookNames().
1501 void ExtractHookNamesFromCaseConstruct(Init* Case, StrVector& HookNames) {
1502   const DagInit& d = InitPtrToDag(Case);
1503   bool even = false;
1504   for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
1505        B != E; ++B) {
1506     Init* arg = *B;
1507     if (even && dynamic_cast<DagInit*>(arg)
1508         && static_cast<DagInit*>(arg)->getOperator()->getAsString() == "case")
1509       ExtractHookNamesFromCaseConstruct(arg, HookNames);
1510     else if (even)
1511       ExtractHookNames(arg, HookNames);
1512     even = !even;
1513   }
1514 }
1515
1516 /// FillInHookNames - Actually extract the hook names from all command
1517 /// line strings. Helper function used by EmitHookDeclarations().
1518 void FillInHookNames(const ToolPropertiesList& TPList,
1519                      StrVector& HookNames) {
1520   // For all command lines:
1521   for (ToolPropertiesList::const_iterator B = TPList.begin(),
1522          E = TPList.end(); B != E; ++B) {
1523     const ToolProperties& P = *(*B);
1524     if (!P.CmdLine)
1525       continue;
1526     if (dynamic_cast<StringInit*>(P.CmdLine))
1527       // This is a string.
1528       ExtractHookNames(P.CmdLine, HookNames);
1529     else
1530       // This is a 'case' construct.
1531       ExtractHookNamesFromCaseConstruct(P.CmdLine, HookNames);
1532   }
1533 }
1534
1535 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
1536 /// property records and emit hook function declaration for each
1537 /// instance of $CALL(HookName).
1538 void EmitHookDeclarations(const ToolPropertiesList& ToolProps,
1539                           std::ostream& O) {
1540   StrVector HookNames;
1541   FillInHookNames(ToolProps, HookNames);
1542   if (HookNames.empty())
1543     return;
1544   std::sort(HookNames.begin(), HookNames.end());
1545   StrVector::const_iterator E = std::unique(HookNames.begin(), HookNames.end());
1546
1547   O << "namespace hooks {\n";
1548   for (StrVector::const_iterator B = HookNames.begin(); B != E; ++B)
1549     O << Indent1 << "std::string " << *B << "();\n";
1550
1551   O << "}\n\n";
1552 }
1553
1554 // End of anonymous namespace
1555 }
1556
1557 /// run - The back-end entry point.
1558 void LLVMCConfigurationEmitter::run (std::ostream &O) {
1559   try {
1560
1561   // Emit file header.
1562   EmitSourceFileHeader("LLVMC Configuration Library", O);
1563
1564   // Get a list of all defined Tools.
1565   RecordVector Tools = Records.getAllDerivedDefinitions("Tool");
1566   if (Tools.empty())
1567     throw std::string("No tool definitions found!");
1568
1569   // Gather information from the Tool description dags.
1570   ToolPropertiesList tool_props;
1571   GlobalOptionDescriptions opt_descs;
1572   CollectToolProperties(Tools.begin(), Tools.end(), tool_props, opt_descs);
1573
1574   // Emit global option registration code.
1575   EmitOptionDescriptions(opt_descs, O);
1576
1577   // Emit hook declarations.
1578   EmitHookDeclarations(tool_props, O);
1579
1580   // Emit PopulateLanguageMap() function
1581   // (a language map maps from file extensions to language names).
1582   EmitPopulateLanguageMap(Records, O);
1583
1584   // Emit Tool classes.
1585   for (ToolPropertiesList::const_iterator B = tool_props.begin(),
1586          E = tool_props.end(); B!=E; ++B)
1587     EmitToolClassDefinition(*(*B), opt_descs, O);
1588
1589   Record* CompilationGraphRecord = Records.getDef("CompilationGraph");
1590   if (!CompilationGraphRecord)
1591     throw std::string("Compilation graph description not found!");
1592
1593   // Typecheck the compilation graph.
1594   TypecheckGraph(CompilationGraphRecord, tool_props);
1595
1596   // Emit Edge# classes.
1597   EmitEdgeClasses(CompilationGraphRecord, opt_descs, O);
1598
1599   // Emit PopulateCompilationGraph() function.
1600   EmitPopulateCompilationGraph(CompilationGraphRecord, O);
1601
1602   // EOF
1603   } catch (std::exception& Error) {
1604     throw Error.what() + std::string(" - usually this means a syntax error.");
1605   }
1606 }