1 //===- LLVMCConfigurationEmitter.cpp - Generate LLVMC config ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open
6 // Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tablegen backend is responsible for emitting LLVMC configuration code.
12 //===----------------------------------------------------------------------===//
14 #include "LLVMCConfigurationEmitter.h"
17 #include "llvm/ADT/IntrusiveRefCntPtr.h"
18 #include "llvm/ADT/StringMap.h"
19 #include "llvm/ADT/StringSet.h"
32 //===----------------------------------------------------------------------===//
35 typedef std::vector<Record*> RecordVector;
36 typedef std::vector<std::string> StrVector;
38 //===----------------------------------------------------------------------===//
42 const unsigned TabWidth = 4;
43 const unsigned Indent1 = TabWidth*1;
44 const unsigned Indent2 = TabWidth*2;
45 const unsigned Indent3 = TabWidth*3;
46 const unsigned Indent4 = TabWidth*4;
48 // Default help string.
49 const char * const DefaultHelpString = "NO HELP MESSAGE PROVIDED";
51 // Name for the "sink" option.
52 const char * const SinkOptionName = "AutoGeneratedSinkOption";
54 //===----------------------------------------------------------------------===//
57 /// Id - An 'identity' function object.
60 void operator()(const T0&) const {
62 template<typename T0, typename T1>
63 void operator()(const T0&, const T1&) const {
65 template<typename T0, typename T1, typename T2>
66 void operator()(const T0&, const T1&, const T2&) const {
70 int InitPtrToInt(const Init* ptr) {
71 const IntInit& val = dynamic_cast<const IntInit&>(*ptr);
72 return val.getValue();
75 const std::string& InitPtrToString(const Init* ptr) {
76 const StringInit& val = dynamic_cast<const StringInit&>(*ptr);
77 return val.getValue();
80 const ListInit& InitPtrToList(const Init* ptr) {
81 const ListInit& val = dynamic_cast<const ListInit&>(*ptr);
85 const DagInit& InitPtrToDag(const Init* ptr) {
86 const DagInit& val = dynamic_cast<const DagInit&>(*ptr);
90 const std::string GetOperatorName(const DagInit& D) {
91 return D.getOperator()->getAsString();
94 /// CheckBooleanConstant - Check that the provided value is a boolean constant.
95 void CheckBooleanConstant(const Init* I) {
96 const DefInit& val = dynamic_cast<const DefInit&>(*I);
97 const std::string& str = val.getAsString();
99 if (str != "true" && str != "false") {
100 throw "Incorrect boolean value: '" + str +
101 "': must be either 'true' or 'false'";
105 // CheckNumberOfArguments - Ensure that the number of args in d is
106 // greater than or equal to min_arguments, otherwise throw an exception.
107 void CheckNumberOfArguments (const DagInit& d, unsigned minArgs) {
108 if (d.getNumArgs() < minArgs)
109 throw GetOperatorName(d) + ": too few arguments!";
112 // IsDagEmpty - is this DAG marked with an empty marker?
113 bool IsDagEmpty (const DagInit& d) {
114 return GetOperatorName(d) == "empty_dag_marker";
117 // EscapeVariableName - Escape commas and other symbols not allowed
118 // in the C++ variable names. Makes it possible to use options named
119 // like "Wa," (useful for prefix options).
120 std::string EscapeVariableName (const std::string& Var) {
122 for (unsigned i = 0; i != Var.size(); ++i) {
123 char cur_char = Var[i];
124 if (cur_char == ',') {
127 else if (cur_char == '+') {
130 else if (cur_char == '-') {
134 ret.push_back(cur_char);
140 /// EscapeQuotes - Replace '"' with '\"'.
141 std::string EscapeQuotes (const std::string& Var) {
143 for (unsigned i = 0; i != Var.size(); ++i) {
144 char cur_char = Var[i];
145 if (cur_char == '"') {
149 ret.push_back(cur_char);
155 /// OneOf - Does the input string contain this character?
156 bool OneOf(const char* lst, char c) {
164 template <class I, class S>
165 void CheckedIncrement(I& P, I E, S ErrorString) {
171 // apply is needed because C++'s syntax doesn't let us construct a function
172 // object and call it in the same statement.
173 template<typename F, typename T0>
174 void apply(F Fun, T0& Arg0) {
178 template<typename F, typename T0, typename T1>
179 void apply(F Fun, T0& Arg0, T1& Arg1) {
180 return Fun(Arg0, Arg1);
183 //===----------------------------------------------------------------------===//
184 /// Back-end specific code
187 /// OptionType - One of six different option types. See the
188 /// documentation for detailed description of differences.
189 namespace OptionType {
191 enum OptionType { Alias, Switch, Parameter, ParameterList,
194 bool IsAlias(OptionType t) {
198 bool IsList (OptionType t) {
199 return (t == ParameterList || t == PrefixList);
202 bool IsSwitch (OptionType t) {
203 return (t == Switch);
206 bool IsParameter (OptionType t) {
207 return (t == Parameter || t == Prefix);
212 OptionType::OptionType stringToOptionType(const std::string& T) {
213 if (T == "alias_option")
214 return OptionType::Alias;
215 else if (T == "switch_option")
216 return OptionType::Switch;
217 else if (T == "parameter_option")
218 return OptionType::Parameter;
219 else if (T == "parameter_list_option")
220 return OptionType::ParameterList;
221 else if (T == "prefix_option")
222 return OptionType::Prefix;
223 else if (T == "prefix_list_option")
224 return OptionType::PrefixList;
226 throw "Unknown option type: " + T + '!';
229 namespace OptionDescriptionFlags {
230 enum OptionDescriptionFlags { Required = 0x1, Hidden = 0x2,
231 ReallyHidden = 0x4, Extern = 0x8,
232 OneOrMore = 0x10, Optional = 0x20,
233 CommaSeparated = 0x40, ForwardNotSplit = 0x80 };
236 /// OptionDescription - Represents data contained in a single
237 /// OptionList entry.
238 struct OptionDescription {
239 OptionType::OptionType Type;
246 OptionDescription(OptionType::OptionType t = OptionType::Switch,
247 const std::string& n = "",
248 const std::string& h = DefaultHelpString)
249 : Type(t), Name(n), Flags(0x0), Help(h), MultiVal(1), InitVal(0)
252 /// GenTypeDeclaration - Returns the C++ variable type of this
254 const char* GenTypeDeclaration() const;
256 /// GenVariableName - Returns the variable name used in the
257 /// generated C++ code.
258 std::string GenVariableName() const;
260 /// Merge - Merge two option descriptions.
261 void Merge (const OptionDescription& other);
263 // Misc convenient getters/setters.
265 bool isAlias() const;
267 bool isMultiVal() const;
269 bool isCommaSeparated() const;
270 void setCommaSeparated();
272 bool isExtern() const;
275 bool isForwardNotSplit() const;
276 void setForwardNotSplit();
278 bool isRequired() const;
281 bool isOneOrMore() const;
284 bool isOptional() const;
287 bool isHidden() const;
290 bool isReallyHidden() const;
291 void setReallyHidden();
293 bool isSwitch() const
294 { return OptionType::IsSwitch(this->Type); }
296 bool isParameter() const
297 { return OptionType::IsParameter(this->Type); }
300 { return OptionType::IsList(this->Type); }
304 void OptionDescription::Merge (const OptionDescription& other)
306 if (other.Type != Type)
307 throw "Conflicting definitions for the option " + Name + "!";
309 if (Help == other.Help || Help == DefaultHelpString)
311 else if (other.Help != DefaultHelpString) {
312 llvm::errs() << "Warning: several different help strings"
313 " defined for option " + Name + "\n";
316 Flags |= other.Flags;
319 bool OptionDescription::isAlias() const {
320 return OptionType::IsAlias(this->Type);
323 bool OptionDescription::isMultiVal() const {
327 bool OptionDescription::isCommaSeparated() const {
328 return Flags & OptionDescriptionFlags::CommaSeparated;
330 void OptionDescription::setCommaSeparated() {
331 Flags |= OptionDescriptionFlags::CommaSeparated;
334 bool OptionDescription::isForwardNotSplit() const {
335 return Flags & OptionDescriptionFlags::ForwardNotSplit;
337 void OptionDescription::setForwardNotSplit() {
338 Flags |= OptionDescriptionFlags::ForwardNotSplit;
341 bool OptionDescription::isExtern() const {
342 return Flags & OptionDescriptionFlags::Extern;
344 void OptionDescription::setExtern() {
345 Flags |= OptionDescriptionFlags::Extern;
348 bool OptionDescription::isRequired() const {
349 return Flags & OptionDescriptionFlags::Required;
351 void OptionDescription::setRequired() {
352 Flags |= OptionDescriptionFlags::Required;
355 bool OptionDescription::isOneOrMore() const {
356 return Flags & OptionDescriptionFlags::OneOrMore;
358 void OptionDescription::setOneOrMore() {
359 Flags |= OptionDescriptionFlags::OneOrMore;
362 bool OptionDescription::isOptional() const {
363 return Flags & OptionDescriptionFlags::Optional;
365 void OptionDescription::setOptional() {
366 Flags |= OptionDescriptionFlags::Optional;
369 bool OptionDescription::isHidden() const {
370 return Flags & OptionDescriptionFlags::Hidden;
372 void OptionDescription::setHidden() {
373 Flags |= OptionDescriptionFlags::Hidden;
376 bool OptionDescription::isReallyHidden() const {
377 return Flags & OptionDescriptionFlags::ReallyHidden;
379 void OptionDescription::setReallyHidden() {
380 Flags |= OptionDescriptionFlags::ReallyHidden;
383 const char* OptionDescription::GenTypeDeclaration() const {
385 case OptionType::Alias:
387 case OptionType::PrefixList:
388 case OptionType::ParameterList:
389 return "cl::list<std::string>";
390 case OptionType::Switch:
391 return "cl::opt<bool>";
392 case OptionType::Parameter:
393 case OptionType::Prefix:
395 return "cl::opt<std::string>";
399 std::string OptionDescription::GenVariableName() const {
400 const std::string& EscapedName = EscapeVariableName(Name);
402 case OptionType::Alias:
403 return "AutoGeneratedAlias_" + EscapedName;
404 case OptionType::PrefixList:
405 case OptionType::ParameterList:
406 return "AutoGeneratedList_" + EscapedName;
407 case OptionType::Switch:
408 return "AutoGeneratedSwitch_" + EscapedName;
409 case OptionType::Prefix:
410 case OptionType::Parameter:
412 return "AutoGeneratedParameter_" + EscapedName;
416 /// OptionDescriptions - An OptionDescription array plus some helper
418 class OptionDescriptions {
419 typedef StringMap<OptionDescription> container_type;
421 /// Descriptions - A list of OptionDescriptions.
422 container_type Descriptions;
425 /// FindOption - exception-throwing wrapper for find().
426 const OptionDescription& FindOption(const std::string& OptName) const;
428 // Wrappers for FindOption that throw an exception in case the option has a
430 const OptionDescription& FindSwitch(const std::string& OptName) const;
431 const OptionDescription& FindParameter(const std::string& OptName) const;
432 const OptionDescription& FindList(const std::string& OptName) const;
433 const OptionDescription&
434 FindListOrParameter(const std::string& OptName) const;
436 /// insertDescription - Insert new OptionDescription into
437 /// OptionDescriptions list
438 void InsertDescription (const OptionDescription& o);
440 // Support for STL-style iteration
441 typedef container_type::const_iterator const_iterator;
442 const_iterator begin() const { return Descriptions.begin(); }
443 const_iterator end() const { return Descriptions.end(); }
446 const OptionDescription&
447 OptionDescriptions::FindOption(const std::string& OptName) const {
448 const_iterator I = Descriptions.find(OptName);
449 if (I != Descriptions.end())
452 throw OptName + ": no such option!";
455 const OptionDescription&
456 OptionDescriptions::FindSwitch(const std::string& OptName) const {
457 const OptionDescription& OptDesc = this->FindOption(OptName);
458 if (!OptDesc.isSwitch())
459 throw OptName + ": incorrect option type - should be a switch!";
463 const OptionDescription&
464 OptionDescriptions::FindList(const std::string& OptName) const {
465 const OptionDescription& OptDesc = this->FindOption(OptName);
466 if (!OptDesc.isList())
467 throw OptName + ": incorrect option type - should be a list!";
471 const OptionDescription&
472 OptionDescriptions::FindParameter(const std::string& OptName) const {
473 const OptionDescription& OptDesc = this->FindOption(OptName);
474 if (!OptDesc.isParameter())
475 throw OptName + ": incorrect option type - should be a parameter!";
479 const OptionDescription&
480 OptionDescriptions::FindListOrParameter(const std::string& OptName) const {
481 const OptionDescription& OptDesc = this->FindOption(OptName);
482 if (!OptDesc.isList() && !OptDesc.isParameter())
484 + ": incorrect option type - should be a list or parameter!";
488 void OptionDescriptions::InsertDescription (const OptionDescription& o) {
489 container_type::iterator I = Descriptions.find(o.Name);
490 if (I != Descriptions.end()) {
491 OptionDescription& D = I->second;
495 Descriptions[o.Name] = o;
499 /// HandlerTable - A base class for function objects implemented as
500 /// 'tables of handlers'.
501 template <typename Handler>
504 // Implementation details.
506 /// HandlerMap - A map from property names to property handlers
507 typedef StringMap<Handler> HandlerMap;
509 static HandlerMap Handlers_;
510 static bool staticMembersInitialized_;
514 Handler GetHandler (const std::string& HandlerName) const {
515 typename HandlerMap::iterator method = Handlers_.find(HandlerName);
517 if (method != Handlers_.end()) {
518 Handler h = method->second;
522 throw "No handler found for property " + HandlerName + "!";
526 void AddHandler(const char* Property, Handler H) {
527 Handlers_[Property] = H;
532 template <class Handler, class FunctionObject>
533 Handler GetHandler(FunctionObject* Obj, const DagInit& Dag) {
534 const std::string& HandlerName = GetOperatorName(Dag);
535 return Obj->GetHandler(HandlerName);
538 template <class FunctionObject>
539 void InvokeDagInitHandler(FunctionObject* Obj, Init* I) {
540 typedef void (FunctionObject::*Handler) (const DagInit&);
542 const DagInit& Dag = InitPtrToDag(I);
543 Handler h = GetHandler<Handler>(Obj, Dag);
548 template <class FunctionObject>
549 void InvokeDagInitHandler(const FunctionObject* const Obj,
550 const Init* I, unsigned IndentLevel, raw_ostream& O)
552 typedef void (FunctionObject::*Handler)
553 (const DagInit&, unsigned IndentLevel, raw_ostream& O) const;
555 const DagInit& Dag = InitPtrToDag(I);
556 Handler h = GetHandler<Handler>(Obj, Dag);
558 ((Obj)->*(h))(Dag, IndentLevel, O);
562 template <typename H>
563 typename HandlerTable<H>::HandlerMap HandlerTable<H>::Handlers_;
565 template <typename H>
566 bool HandlerTable<H>::staticMembersInitialized_ = false;
569 /// CollectOptionProperties - Function object for iterating over an
570 /// option property list.
571 class CollectOptionProperties;
572 typedef void (CollectOptionProperties::* CollectOptionPropertiesHandler)
575 class CollectOptionProperties
576 : public HandlerTable<CollectOptionPropertiesHandler>
580 /// optDescs_ - OptionDescriptions table. This is where the
581 /// information is stored.
582 OptionDescription& optDesc_;
586 explicit CollectOptionProperties(OptionDescription& OD)
589 if (!staticMembersInitialized_) {
590 AddHandler("extern", &CollectOptionProperties::onExtern);
591 AddHandler("help", &CollectOptionProperties::onHelp);
592 AddHandler("hidden", &CollectOptionProperties::onHidden);
593 AddHandler("init", &CollectOptionProperties::onInit);
594 AddHandler("multi_val", &CollectOptionProperties::onMultiVal);
595 AddHandler("one_or_more", &CollectOptionProperties::onOneOrMore);
596 AddHandler("really_hidden", &CollectOptionProperties::onReallyHidden);
597 AddHandler("required", &CollectOptionProperties::onRequired);
598 AddHandler("optional", &CollectOptionProperties::onOptional);
599 AddHandler("comma_separated", &CollectOptionProperties::onCommaSeparated);
600 AddHandler("forward_not_split",
601 &CollectOptionProperties::onForwardNotSplit);
603 staticMembersInitialized_ = true;
607 /// operator() - Just forwards to the corresponding property
609 void operator() (Init* I) {
610 InvokeDagInitHandler(this, I);
615 /// Option property handlers --
616 /// Methods that handle option properties such as (help) or (hidden).
618 void onExtern (const DagInit& d) {
619 CheckNumberOfArguments(d, 0);
620 optDesc_.setExtern();
623 void onHelp (const DagInit& d) {
624 CheckNumberOfArguments(d, 1);
625 optDesc_.Help = EscapeQuotes(InitPtrToString(d.getArg(0)));
628 void onHidden (const DagInit& d) {
629 CheckNumberOfArguments(d, 0);
630 optDesc_.setHidden();
633 void onReallyHidden (const DagInit& d) {
634 CheckNumberOfArguments(d, 0);
635 optDesc_.setReallyHidden();
638 void onCommaSeparated (const DagInit& d) {
639 CheckNumberOfArguments(d, 0);
640 if (!optDesc_.isList())
641 throw "'comma_separated' is valid only on list options!";
642 optDesc_.setCommaSeparated();
645 void onForwardNotSplit (const DagInit& d) {
646 CheckNumberOfArguments(d, 0);
647 if (!optDesc_.isParameter())
648 throw "'forward_not_split' is valid only for parameter options!";
649 optDesc_.setForwardNotSplit();
652 void onRequired (const DagInit& d) {
653 CheckNumberOfArguments(d, 0);
654 if (optDesc_.isOneOrMore() || optDesc_.isOptional())
655 throw "Only one of (required), (optional) or "
656 "(one_or_more) properties is allowed!";
657 optDesc_.setRequired();
660 void onInit (const DagInit& d) {
661 CheckNumberOfArguments(d, 1);
662 Init* i = d.getArg(0);
663 const std::string& str = i->getAsString();
665 bool correct = optDesc_.isParameter() && dynamic_cast<StringInit*>(i);
666 correct |= (optDesc_.isSwitch() && (str == "true" || str == "false"));
669 throw "Incorrect usage of the 'init' option property!";
671 optDesc_.InitVal = i;
674 void onOneOrMore (const DagInit& d) {
675 CheckNumberOfArguments(d, 0);
676 if (optDesc_.isRequired() || optDesc_.isOptional())
677 throw "Only one of (required), (optional) or "
678 "(one_or_more) properties is allowed!";
679 if (!OptionType::IsList(optDesc_.Type))
680 llvm::errs() << "Warning: specifying the 'one_or_more' property "
681 "on a non-list option will have no effect.\n";
682 optDesc_.setOneOrMore();
685 void onOptional (const DagInit& d) {
686 CheckNumberOfArguments(d, 0);
687 if (optDesc_.isRequired() || optDesc_.isOneOrMore())
688 throw "Only one of (required), (optional) or "
689 "(one_or_more) properties is allowed!";
690 if (!OptionType::IsList(optDesc_.Type))
691 llvm::errs() << "Warning: specifying the 'optional' property"
692 "on a non-list option will have no effect.\n";
693 optDesc_.setOptional();
696 void onMultiVal (const DagInit& d) {
697 CheckNumberOfArguments(d, 1);
698 int val = InitPtrToInt(d.getArg(0));
700 throw "Error in the 'multi_val' property: "
701 "the value must be greater than 1!";
702 if (!OptionType::IsList(optDesc_.Type))
703 throw "The multi_val property is valid only on list options!";
704 optDesc_.MultiVal = val;
709 /// AddOption - A function object that is applied to every option
710 /// description. Used by CollectOptionDescriptions.
713 OptionDescriptions& OptDescs_;
716 explicit AddOption(OptionDescriptions& OD) : OptDescs_(OD)
719 void operator()(const Init* i) {
720 const DagInit& d = InitPtrToDag(i);
721 CheckNumberOfArguments(d, 1);
723 const OptionType::OptionType Type =
724 stringToOptionType(GetOperatorName(d));
725 const std::string& Name = InitPtrToString(d.getArg(0));
727 OptionDescription OD(Type, Name);
730 CheckNumberOfArguments(d, 2);
733 // Aliases store the aliased option name in the 'Help' field.
734 OD.Help = InitPtrToString(d.getArg(1));
736 else if (!OD.isExtern()) {
737 processOptionProperties(d, OD);
739 OptDescs_.InsertDescription(OD);
743 /// processOptionProperties - Go through the list of option
744 /// properties and call a corresponding handler for each.
745 static void processOptionProperties (const DagInit& d, OptionDescription& o) {
746 CheckNumberOfArguments(d, 2);
747 DagInit::const_arg_iterator B = d.arg_begin();
748 // Skip the first argument: it's always the option name.
750 std::for_each(B, d.arg_end(), CollectOptionProperties(o));
755 /// CollectOptionDescriptions - Collects option properties from all
757 void CollectOptionDescriptions (RecordVector::const_iterator B,
758 RecordVector::const_iterator E,
759 OptionDescriptions& OptDescs)
761 // For every OptionList:
763 RecordVector::value_type T = *B;
764 // Throws an exception if the value does not exist.
765 ListInit* PropList = T->getValueAsListInit("options");
767 // For every option description in this list:
768 // collect the information and
769 std::for_each(PropList->begin(), PropList->end(), AddOption(OptDescs));
773 // Tool information record
775 namespace ToolFlags {
776 enum ToolFlags { Join = 0x1, Sink = 0x2 };
779 struct ToolDescription : public RefCountedBase<ToolDescription> {
783 StrVector InLanguage;
784 std::string InFileOption;
785 std::string OutFileOption;
786 std::string OutLanguage;
787 std::string OutputSuffix;
791 // Various boolean properties
792 void setSink() { Flags |= ToolFlags::Sink; }
793 bool isSink() const { return Flags & ToolFlags::Sink; }
794 void setJoin() { Flags |= ToolFlags::Join; }
795 bool isJoin() const { return Flags & ToolFlags::Join; }
797 // Default ctor here is needed because StringMap can only store
798 // DefaultConstructible objects
800 : CmdLine(0), Actions(0), OutFileOption("-o"),
803 ToolDescription (const std::string& n)
804 : Name(n), CmdLine(0), Actions(0), OutFileOption("-o"),
809 /// ToolDescriptions - A list of Tool information records.
810 typedef std::vector<IntrusiveRefCntPtr<ToolDescription> > ToolDescriptions;
813 /// CollectToolProperties - Function object for iterating over a list of
814 /// tool property records.
816 class CollectToolProperties;
817 typedef void (CollectToolProperties::* CollectToolPropertiesHandler)
820 class CollectToolProperties : public HandlerTable<CollectToolPropertiesHandler>
824 /// toolDesc_ - Properties of the current Tool. This is where the
825 /// information is stored.
826 ToolDescription& toolDesc_;
830 explicit CollectToolProperties (ToolDescription& d)
833 if (!staticMembersInitialized_) {
835 AddHandler("actions", &CollectToolProperties::onActions);
836 AddHandler("command", &CollectToolProperties::onCommand);
837 AddHandler("in_language", &CollectToolProperties::onInLanguage);
838 AddHandler("join", &CollectToolProperties::onJoin);
839 AddHandler("out_language", &CollectToolProperties::onOutLanguage);
841 AddHandler("out_file_option", &CollectToolProperties::onOutFileOption);
842 AddHandler("in_file_option", &CollectToolProperties::onInFileOption);
844 AddHandler("output_suffix", &CollectToolProperties::onOutputSuffix);
845 AddHandler("sink", &CollectToolProperties::onSink);
846 AddHandler("works_on_empty", &CollectToolProperties::onWorksOnEmpty);
848 staticMembersInitialized_ = true;
852 void operator() (Init* I) {
853 InvokeDagInitHandler(this, I);
858 /// Property handlers --
859 /// Functions that extract information about tool properties from
860 /// DAG representation.
862 void onActions (const DagInit& d) {
863 CheckNumberOfArguments(d, 1);
864 Init* Case = d.getArg(0);
865 if (typeid(*Case) != typeid(DagInit) ||
866 GetOperatorName(static_cast<DagInit&>(*Case)) != "case")
867 throw "The argument to (actions) should be a 'case' construct!";
868 toolDesc_.Actions = Case;
871 void onCommand (const DagInit& d) {
872 CheckNumberOfArguments(d, 1);
873 toolDesc_.CmdLine = d.getArg(0);
876 void onInLanguage (const DagInit& d) {
877 CheckNumberOfArguments(d, 1);
878 Init* arg = d.getArg(0);
880 // Find out the argument's type.
881 if (typeid(*arg) == typeid(StringInit)) {
883 toolDesc_.InLanguage.push_back(InitPtrToString(arg));
887 const ListInit& lst = InitPtrToList(arg);
888 StrVector& out = toolDesc_.InLanguage;
890 // Copy strings to the output vector.
891 for (ListInit::const_iterator B = lst.begin(), E = lst.end();
893 out.push_back(InitPtrToString(*B));
896 // Remove duplicates.
897 std::sort(out.begin(), out.end());
898 StrVector::iterator newE = std::unique(out.begin(), out.end());
899 out.erase(newE, out.end());
903 void onJoin (const DagInit& d) {
904 CheckNumberOfArguments(d, 0);
908 void onOutLanguage (const DagInit& d) {
909 CheckNumberOfArguments(d, 1);
910 toolDesc_.OutLanguage = InitPtrToString(d.getArg(0));
913 void onOutFileOption (const DagInit& d) {
914 CheckNumberOfArguments(d, 1);
915 toolDesc_.OutFileOption = InitPtrToString(d.getArg(0));
918 void onInFileOption (const DagInit& d) {
919 CheckNumberOfArguments(d, 1);
920 toolDesc_.InFileOption = InitPtrToString(d.getArg(0));
923 void onOutputSuffix (const DagInit& d) {
924 CheckNumberOfArguments(d, 1);
925 toolDesc_.OutputSuffix = InitPtrToString(d.getArg(0));
928 void onSink (const DagInit& d) {
929 CheckNumberOfArguments(d, 0);
933 void onWorksOnEmpty (const DagInit& d) {
934 toolDesc_.OnEmpty = d.getArg(0);
939 /// CollectToolDescriptions - Gather information about tool properties
940 /// from the parsed TableGen data (basically a wrapper for the
941 /// CollectToolProperties function object).
942 void CollectToolDescriptions (RecordVector::const_iterator B,
943 RecordVector::const_iterator E,
944 ToolDescriptions& ToolDescs)
946 // Iterate over a properties list of every Tool definition
948 const Record* T = *B;
949 // Throws an exception if the value does not exist.
950 ListInit* PropList = T->getValueAsListInit("properties");
952 IntrusiveRefCntPtr<ToolDescription>
953 ToolDesc(new ToolDescription(T->getName()));
955 std::for_each(PropList->begin(), PropList->end(),
956 CollectToolProperties(*ToolDesc));
957 ToolDescs.push_back(ToolDesc);
961 /// FillInEdgeVector - Merge all compilation graph definitions into
962 /// one single edge list.
963 void FillInEdgeVector(RecordVector::const_iterator B,
964 RecordVector::const_iterator E, RecordVector& Out) {
965 for (; B != E; ++B) {
966 const ListInit* edges = (*B)->getValueAsListInit("edges");
968 for (unsigned i = 0; i < edges->size(); ++i)
969 Out.push_back(edges->getElementAsRecord(i));
973 /// CalculatePriority - Calculate the priority of this plugin.
974 int CalculatePriority(RecordVector::const_iterator B,
975 RecordVector::const_iterator E) {
979 priority = static_cast<int>((*B)->getValueAsInt("priority"));
982 throw "More than one 'PluginPriority' instance found: "
983 "most probably an error!";
989 /// NotInGraph - Helper function object for FilterNotInGraph.
992 const llvm::StringSet<>& ToolsInGraph_;
995 NotInGraph(const llvm::StringSet<>& ToolsInGraph)
996 : ToolsInGraph_(ToolsInGraph)
999 bool operator()(const IntrusiveRefCntPtr<ToolDescription>& x) {
1000 return (ToolsInGraph_.count(x->Name) == 0);
1004 /// FilterNotInGraph - Filter out from ToolDescs all Tools not
1005 /// mentioned in the compilation graph definition.
1006 void FilterNotInGraph (const RecordVector& EdgeVector,
1007 ToolDescriptions& ToolDescs) {
1009 // List all tools mentioned in the graph.
1010 llvm::StringSet<> ToolsInGraph;
1012 for (RecordVector::const_iterator B = EdgeVector.begin(),
1013 E = EdgeVector.end(); B != E; ++B) {
1015 const Record* Edge = *B;
1016 const std::string& NodeA = Edge->getValueAsString("a");
1017 const std::string& NodeB = Edge->getValueAsString("b");
1019 if (NodeA != "root")
1020 ToolsInGraph.insert(NodeA);
1021 ToolsInGraph.insert(NodeB);
1024 // Filter ToolPropertiesList.
1025 ToolDescriptions::iterator new_end =
1026 std::remove_if(ToolDescs.begin(), ToolDescs.end(),
1027 NotInGraph(ToolsInGraph));
1028 ToolDescs.erase(new_end, ToolDescs.end());
1031 /// FillInToolToLang - Fills in two tables that map tool names to
1032 /// (input, output) languages. Helper function used by TypecheckGraph().
1033 void FillInToolToLang (const ToolDescriptions& ToolDescs,
1034 StringMap<StringSet<> >& ToolToInLang,
1035 StringMap<std::string>& ToolToOutLang) {
1036 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1037 E = ToolDescs.end(); B != E; ++B) {
1038 const ToolDescription& D = *(*B);
1039 for (StrVector::const_iterator B = D.InLanguage.begin(),
1040 E = D.InLanguage.end(); B != E; ++B)
1041 ToolToInLang[D.Name].insert(*B);
1042 ToolToOutLang[D.Name] = D.OutLanguage;
1046 /// TypecheckGraph - Check that names for output and input languages
1047 /// on all edges do match. This doesn't do much when the information
1048 /// about the whole graph is not available (i.e. when compiling most
1050 void TypecheckGraph (const RecordVector& EdgeVector,
1051 const ToolDescriptions& ToolDescs) {
1052 StringMap<StringSet<> > ToolToInLang;
1053 StringMap<std::string> ToolToOutLang;
1055 FillInToolToLang(ToolDescs, ToolToInLang, ToolToOutLang);
1056 StringMap<std::string>::iterator IAE = ToolToOutLang.end();
1057 StringMap<StringSet<> >::iterator IBE = ToolToInLang.end();
1059 for (RecordVector::const_iterator B = EdgeVector.begin(),
1060 E = EdgeVector.end(); B != E; ++B) {
1061 const Record* Edge = *B;
1062 const std::string& NodeA = Edge->getValueAsString("a");
1063 const std::string& NodeB = Edge->getValueAsString("b");
1064 StringMap<std::string>::iterator IA = ToolToOutLang.find(NodeA);
1065 StringMap<StringSet<> >::iterator IB = ToolToInLang.find(NodeB);
1067 if (NodeA != "root") {
1068 if (IA != IAE && IB != IBE && IB->second.count(IA->second) == 0)
1069 throw "Edge " + NodeA + "->" + NodeB
1070 + ": output->input language mismatch";
1073 if (NodeB == "root")
1074 throw "Edges back to the root are not allowed!";
1078 /// WalkCase - Walks the 'case' expression DAG and invokes
1079 /// TestCallback on every test, and StatementCallback on every
1080 /// statement. Handles 'case' nesting, but not the 'and' and 'or'
1081 /// combinators (that is, they are passed directly to TestCallback).
1082 /// TestCallback must have type 'void TestCallback(const DagInit*, unsigned
1083 /// IndentLevel, bool FirstTest)'.
1084 /// StatementCallback must have type 'void StatementCallback(const Init*,
1085 /// unsigned IndentLevel)'.
1086 template <typename F1, typename F2>
1087 void WalkCase(const Init* Case, F1 TestCallback, F2 StatementCallback,
1088 unsigned IndentLevel = 0)
1090 const DagInit& d = InitPtrToDag(Case);
1093 if (GetOperatorName(d) != "case")
1094 throw "WalkCase should be invoked only on 'case' expressions!";
1096 if (d.getNumArgs() < 2)
1097 throw "There should be at least one clause in the 'case' expression:\n"
1102 const unsigned numArgs = d.getNumArgs();
1104 for (DagInit::const_arg_iterator B = d.arg_begin(), E = d.arg_end();
1111 const DagInit& Test = InitPtrToDag(arg);
1113 if (GetOperatorName(Test) == "default" && (i+1 != numArgs))
1114 throw "The 'default' clause should be the last in the "
1115 "'case' construct!";
1117 throw "Case construct handler: no corresponding action "
1118 "found for the test " + Test.getAsString() + '!';
1120 TestCallback(Test, IndentLevel, (i == 1));
1124 if (dynamic_cast<DagInit*>(arg)
1125 && GetOperatorName(static_cast<DagInit&>(*arg)) == "case") {
1127 WalkCase(arg, TestCallback, StatementCallback, IndentLevel + Indent1);
1130 // Handle statement.
1131 StatementCallback(arg, IndentLevel);
1139 /// ExtractOptionNames - A helper function object used by
1140 /// CheckForSuperfluousOptions() to walk the 'case' DAG.
1141 class ExtractOptionNames {
1142 llvm::StringSet<>& OptionNames_;
1144 void processDag(const Init* Statement) {
1145 const DagInit& Stmt = InitPtrToDag(Statement);
1146 const std::string& ActionName = GetOperatorName(Stmt);
1147 if (ActionName == "forward" || ActionName == "forward_as" ||
1148 ActionName == "forward_value" ||
1149 ActionName == "forward_transformed_value" ||
1150 ActionName == "switch_on" || ActionName == "any_switch_on" ||
1151 ActionName == "parameter_equals" ||
1152 ActionName == "element_in_list" || ActionName == "not_empty" ||
1153 ActionName == "empty") {
1154 CheckNumberOfArguments(Stmt, 1);
1156 Init* Arg = Stmt.getArg(0);
1157 if (typeid(*Arg) == typeid(StringInit)) {
1158 const std::string& Name = InitPtrToString(Arg);
1159 OptionNames_.insert(Name);
1163 const ListInit& List = InitPtrToList(Arg);
1164 for (ListInit::const_iterator B = List.begin(), E = List.end();
1166 const std::string& Name = InitPtrToString(*B);
1167 OptionNames_.insert(Name);
1171 else if (ActionName == "and" || ActionName == "or" || ActionName == "not") {
1172 for (unsigned i = 0, NumArgs = Stmt.getNumArgs(); i < NumArgs; ++i) {
1173 this->processDag(Stmt.getArg(i));
1179 ExtractOptionNames(llvm::StringSet<>& OptionNames) : OptionNames_(OptionNames)
1182 void operator()(const Init* Statement) {
1183 if (typeid(*Statement) == typeid(ListInit)) {
1184 const ListInit& DagList = *static_cast<const ListInit*>(Statement);
1185 for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
1187 this->processDag(*B);
1190 this->processDag(Statement);
1194 void operator()(const DagInit& Test, unsigned, bool) {
1195 this->operator()(&Test);
1197 void operator()(const Init* Statement, unsigned) {
1198 this->operator()(Statement);
1202 /// CheckForSuperfluousOptions - Check that there are no side
1203 /// effect-free options (specified only in the OptionList). Otherwise,
1204 /// output a warning.
1205 void CheckForSuperfluousOptions (const RecordVector& Edges,
1206 const ToolDescriptions& ToolDescs,
1207 const OptionDescriptions& OptDescs) {
1208 llvm::StringSet<> nonSuperfluousOptions;
1210 // Add all options mentioned in the ToolDesc.Actions to the set of
1211 // non-superfluous options.
1212 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
1213 E = ToolDescs.end(); B != E; ++B) {
1214 const ToolDescription& TD = *(*B);
1215 ExtractOptionNames Callback(nonSuperfluousOptions);
1217 WalkCase(TD.Actions, Callback, Callback);
1220 // Add all options mentioned in the 'case' clauses of the
1221 // OptionalEdges of the compilation graph to the set of
1222 // non-superfluous options.
1223 for (RecordVector::const_iterator B = Edges.begin(), E = Edges.end();
1225 const Record* Edge = *B;
1226 DagInit& Weight = *Edge->getValueAsDag("weight");
1228 if (!IsDagEmpty(Weight))
1229 WalkCase(&Weight, ExtractOptionNames(nonSuperfluousOptions), Id());
1232 // Check that all options in OptDescs belong to the set of
1233 // non-superfluous options.
1234 for (OptionDescriptions::const_iterator B = OptDescs.begin(),
1235 E = OptDescs.end(); B != E; ++B) {
1236 const OptionDescription& Val = B->second;
1237 if (!nonSuperfluousOptions.count(Val.Name)
1238 && Val.Type != OptionType::Alias)
1239 llvm::errs() << "Warning: option '-" << Val.Name << "' has no effect! "
1240 "Probable cause: this option is specified only in the OptionList.\n";
1244 /// EmitCaseTest0Args - Helper function used by EmitCaseConstructHandler().
1245 bool EmitCaseTest0Args(const std::string& TestName, raw_ostream& O) {
1246 if (TestName == "single_input_file") {
1247 O << "InputFilenames.size() == 1";
1250 else if (TestName == "multiple_input_files") {
1251 O << "InputFilenames.size() > 1";
1258 /// EmitListTest - Helper function used by EmitCaseTest1ArgList().
1259 template <typename F>
1260 void EmitListTest(const ListInit& L, const char* LogicOp,
1261 F Callback, raw_ostream& O)
1263 // This is a lot like EmitLogicalOperationTest, but works on ListInits instead
1265 bool isFirst = true;
1266 for (ListInit::const_iterator B = L.begin(), E = L.end(); B != E; ++B) {
1270 O << ' ' << LogicOp << ' ';
1271 Callback(InitPtrToString(*B), O);
1275 // Callbacks for use with EmitListTest.
1277 class EmitSwitchOn {
1278 const OptionDescriptions& OptDescs_;
1280 EmitSwitchOn(const OptionDescriptions& OptDescs) : OptDescs_(OptDescs)
1283 void operator()(const std::string& OptName, raw_ostream& O) const {
1284 const OptionDescription& OptDesc = OptDescs_.FindSwitch(OptName);
1285 O << OptDesc.GenVariableName();
1289 class EmitEmptyTest {
1291 const OptionDescriptions& OptDescs_;
1293 EmitEmptyTest(bool EmitNegate, const OptionDescriptions& OptDescs)
1294 : EmitNegate_(EmitNegate), OptDescs_(OptDescs)
1297 void operator()(const std::string& OptName, raw_ostream& O) const {
1298 const char* Neg = (EmitNegate_ ? "!" : "");
1299 if (OptName == "o") {
1300 O << Neg << "OutputFilename.empty()";
1302 else if (OptName == "save-temps") {
1303 O << Neg << "(SaveTemps == SaveTempsEnum::Unset)";
1306 const OptionDescription& OptDesc = OptDescs_.FindListOrParameter(OptName);
1307 O << Neg << OptDesc.GenVariableName() << ".empty()";
1313 /// EmitCaseTest1ArgList - Helper function used by EmitCaseTest1Arg();
1314 bool EmitCaseTest1ArgList(const std::string& TestName,
1316 const OptionDescriptions& OptDescs,
1318 const ListInit& L = InitPtrToList(d.getArg(0));
1320 if (TestName == "any_switch_on") {
1321 EmitListTest(L, "||", EmitSwitchOn(OptDescs), O);
1324 else if (TestName == "switch_on") {
1325 EmitListTest(L, "&&", EmitSwitchOn(OptDescs), O);
1328 else if (TestName == "any_not_empty") {
1329 EmitListTest(L, "||", EmitEmptyTest(true, OptDescs), O);
1332 else if (TestName == "any_empty") {
1333 EmitListTest(L, "||", EmitEmptyTest(false, OptDescs), O);
1336 else if (TestName == "not_empty") {
1337 EmitListTest(L, "&&", EmitEmptyTest(true, OptDescs), O);
1340 else if (TestName == "empty") {
1341 EmitListTest(L, "&&", EmitEmptyTest(false, OptDescs), O);
1348 /// EmitCaseTest1ArgStr - Helper function used by EmitCaseTest1Arg();
1349 bool EmitCaseTest1ArgStr(const std::string& TestName,
1351 const OptionDescriptions& OptDescs,
1353 const std::string& OptName = InitPtrToString(d.getArg(0));
1355 if (TestName == "switch_on") {
1356 apply(EmitSwitchOn(OptDescs), OptName, O);
1359 else if (TestName == "input_languages_contain") {
1360 O << "InLangs.count(\"" << OptName << "\") != 0";
1363 else if (TestName == "in_language") {
1364 // This works only for single-argument Tool::GenerateAction. Join
1365 // tools can process several files in different languages simultaneously.
1367 // TODO: make this work with Edge::Weight (if possible).
1368 O << "LangMap.GetLanguage(inFile) == \"" << OptName << '\"';
1371 else if (TestName == "not_empty" || TestName == "empty") {
1372 bool EmitNegate = (TestName == "not_empty");
1373 apply(EmitEmptyTest(EmitNegate, OptDescs), OptName, O);
1380 /// EmitCaseTest1Arg - Helper function used by EmitCaseConstructHandler();
1381 bool EmitCaseTest1Arg(const std::string& TestName,
1383 const OptionDescriptions& OptDescs,
1385 CheckNumberOfArguments(d, 1);
1386 if (typeid(*d.getArg(0)) == typeid(ListInit))
1387 return EmitCaseTest1ArgList(TestName, d, OptDescs, O);
1389 return EmitCaseTest1ArgStr(TestName, d, OptDescs, O);
1392 /// EmitCaseTest2Args - Helper function used by EmitCaseConstructHandler().
1393 bool EmitCaseTest2Args(const std::string& TestName,
1395 unsigned IndentLevel,
1396 const OptionDescriptions& OptDescs,
1398 CheckNumberOfArguments(d, 2);
1399 const std::string& OptName = InitPtrToString(d.getArg(0));
1400 const std::string& OptArg = InitPtrToString(d.getArg(1));
1402 if (TestName == "parameter_equals") {
1403 const OptionDescription& OptDesc = OptDescs.FindParameter(OptName);
1404 O << OptDesc.GenVariableName() << " == \"" << OptArg << "\"";
1407 else if (TestName == "element_in_list") {
1408 const OptionDescription& OptDesc = OptDescs.FindList(OptName);
1409 const std::string& VarName = OptDesc.GenVariableName();
1410 O << "std::find(" << VarName << ".begin(),\n";
1411 O.indent(IndentLevel + Indent1)
1412 << VarName << ".end(), \""
1413 << OptArg << "\") != " << VarName << ".end()";
1420 // Forward declaration.
1421 // EmitLogicalOperationTest and EmitCaseTest are mutually recursive.
1422 void EmitCaseTest(const DagInit& d, unsigned IndentLevel,
1423 const OptionDescriptions& OptDescs,
1426 /// EmitLogicalOperationTest - Helper function used by
1427 /// EmitCaseConstructHandler.
1428 void EmitLogicalOperationTest(const DagInit& d, const char* LogicOp,
1429 unsigned IndentLevel,
1430 const OptionDescriptions& OptDescs,
1433 for (unsigned j = 0, NumArgs = d.getNumArgs(); j < NumArgs; ++j) {
1434 const DagInit& InnerTest = InitPtrToDag(d.getArg(j));
1435 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
1436 if (j != NumArgs - 1) {
1438 O.indent(IndentLevel + Indent1) << ' ' << LogicOp << " (";
1446 void EmitLogicalNot(const DagInit& d, unsigned IndentLevel,
1447 const OptionDescriptions& OptDescs, raw_ostream& O)
1449 CheckNumberOfArguments(d, 1);
1450 const DagInit& InnerTest = InitPtrToDag(d.getArg(0));
1452 EmitCaseTest(InnerTest, IndentLevel, OptDescs, O);
1456 /// EmitCaseTest - Helper function used by EmitCaseConstructHandler.
1457 void EmitCaseTest(const DagInit& d, unsigned IndentLevel,
1458 const OptionDescriptions& OptDescs,
1460 const std::string& TestName = GetOperatorName(d);
1462 if (TestName == "and")
1463 EmitLogicalOperationTest(d, "&&", IndentLevel, OptDescs, O);
1464 else if (TestName == "or")
1465 EmitLogicalOperationTest(d, "||", IndentLevel, OptDescs, O);
1466 else if (TestName == "not")
1467 EmitLogicalNot(d, IndentLevel, OptDescs, O);
1468 else if (EmitCaseTest0Args(TestName, O))
1470 else if (EmitCaseTest1Arg(TestName, d, OptDescs, O))
1472 else if (EmitCaseTest2Args(TestName, d, IndentLevel, OptDescs, O))
1475 throw "Unknown test '" + TestName + "' used in the 'case' construct!";
1479 /// EmitCaseTestCallback - Callback used by EmitCaseConstructHandler.
1480 class EmitCaseTestCallback {
1482 const OptionDescriptions& OptDescs_;
1486 EmitCaseTestCallback(bool EmitElseIf,
1487 const OptionDescriptions& OptDescs, raw_ostream& O)
1488 : EmitElseIf_(EmitElseIf), OptDescs_(OptDescs), O_(O)
1491 void operator()(const DagInit& Test, unsigned IndentLevel, bool FirstTest)
1493 if (GetOperatorName(Test) == "default") {
1494 O_.indent(IndentLevel) << "else {\n";
1497 O_.indent(IndentLevel)
1498 << ((!FirstTest && EmitElseIf_) ? "else if (" : "if (");
1499 EmitCaseTest(Test, IndentLevel, OptDescs_, O_);
1505 /// EmitCaseStatementCallback - Callback used by EmitCaseConstructHandler.
1506 template <typename F>
1507 class EmitCaseStatementCallback {
1512 EmitCaseStatementCallback(F Callback, raw_ostream& O)
1513 : Callback_(Callback), O_(O)
1516 void operator() (const Init* Statement, unsigned IndentLevel) {
1518 // Ignore nested 'case' DAG.
1519 if (!(dynamic_cast<const DagInit*>(Statement) &&
1520 GetOperatorName(static_cast<const DagInit&>(*Statement)) == "case")) {
1521 if (typeid(*Statement) == typeid(ListInit)) {
1522 const ListInit& DagList = *static_cast<const ListInit*>(Statement);
1523 for (ListInit::const_iterator B = DagList.begin(), E = DagList.end();
1525 Callback_(*B, (IndentLevel + Indent1), O_);
1528 Callback_(Statement, (IndentLevel + Indent1), O_);
1531 O_.indent(IndentLevel) << "}\n";
1536 /// EmitCaseConstructHandler - Emit code that handles the 'case'
1537 /// construct. Takes a function object that should emit code for every case
1538 /// clause. Implemented on top of WalkCase.
1539 /// Callback's type is void F(const Init* Statement, unsigned IndentLevel,
1540 /// raw_ostream& O).
1541 /// EmitElseIf parameter controls the type of condition that is emitted ('if
1542 /// (..) {..} else if (..) {} .. else {..}' vs. 'if (..) {..} if(..) {..}
1544 template <typename F>
1545 void EmitCaseConstructHandler(const Init* Case, unsigned IndentLevel,
1546 F Callback, bool EmitElseIf,
1547 const OptionDescriptions& OptDescs,
1549 WalkCase(Case, EmitCaseTestCallback(EmitElseIf, OptDescs, O),
1550 EmitCaseStatementCallback<F>(Callback, O), IndentLevel);
1553 /// TokenizeCmdLine - converts from
1554 /// "$CALL(HookName, 'Arg1', 'Arg2')/path -arg1 -arg2" to
1555 /// ["$CALL(", "HookName", "Arg1", "Arg2", ")/path", "-arg1", "-arg2"].
1556 void TokenizeCmdLine(const std::string& CmdLine, StrVector& Out) {
1557 const char* Delimiters = " \t\n\v\f\r";
1559 { Normal, SpecialCommand, InsideSpecialCommand, InsideQuotationMarks }
1562 if (CmdLine.empty())
1566 std::string::size_type B = CmdLine.find_first_not_of(Delimiters),
1569 for (; B != E; ++B) {
1570 char cur_ch = CmdLine[B];
1574 if (cur_ch == '$') {
1575 cur_st = SpecialCommand;
1578 if (OneOf(Delimiters, cur_ch)) {
1580 B = CmdLine.find_first_not_of(Delimiters, B);
1581 if (B == std::string::npos) {
1592 case SpecialCommand:
1593 if (OneOf(Delimiters, cur_ch)) {
1598 if (cur_ch == '(') {
1600 cur_st = InsideSpecialCommand;
1605 case InsideSpecialCommand:
1606 if (OneOf(Delimiters, cur_ch)) {
1609 if (cur_ch == '\'') {
1610 cur_st = InsideQuotationMarks;
1614 if (cur_ch == ')') {
1618 if (cur_ch == ',') {
1624 case InsideQuotationMarks:
1625 if (cur_ch == '\'') {
1626 cur_st = InsideSpecialCommand;
1632 Out.back().push_back(cur_ch);
1636 /// SubstituteCall - Given "$CALL(HookName, [Arg1 [, Arg2 [...]]])", output
1637 /// "hooks::HookName([Arg1 [, Arg2 [, ...]]])". Helper function used by
1638 /// SubstituteSpecialCommands().
1639 StrVector::const_iterator
1640 SubstituteCall (StrVector::const_iterator Pos,
1641 StrVector::const_iterator End,
1642 bool IsJoin, raw_ostream& O)
1644 const char* errorMessage = "Syntax error in $CALL invocation!";
1645 CheckedIncrement(Pos, End, errorMessage);
1646 const std::string& CmdName = *Pos;
1649 throw "$CALL invocation: empty argument list!";
1652 O << CmdName << "(";
1655 bool firstIteration = true;
1657 CheckedIncrement(Pos, End, errorMessage);
1658 const std::string& Arg = *Pos;
1659 assert(Arg.size() != 0);
1665 firstIteration = false;
1669 if (Arg == "$INFILE") {
1671 throw "$CALL(Hook, $INFILE) can't be used with a Join tool!";
1673 O << "inFile.c_str()";
1676 O << '"' << Arg << '"';
1685 /// SubstituteEnv - Given '$ENV(VAR_NAME)', output 'getenv("VAR_NAME")'. Helper
1686 /// function used by SubstituteSpecialCommands().
1687 StrVector::const_iterator
1688 SubstituteEnv (StrVector::const_iterator Pos,
1689 StrVector::const_iterator End, raw_ostream& O)
1691 const char* errorMessage = "Syntax error in $ENV invocation!";
1692 CheckedIncrement(Pos, End, errorMessage);
1693 const std::string& EnvName = *Pos;
1696 throw "$ENV invocation: empty argument list!";
1698 O << "checkCString(std::getenv(\"";
1702 CheckedIncrement(Pos, End, errorMessage);
1707 /// SubstituteSpecialCommands - Given an invocation of $CALL or $ENV, output
1708 /// handler code. Helper function used by EmitCmdLineVecFill().
1709 StrVector::const_iterator
1710 SubstituteSpecialCommands (StrVector::const_iterator Pos,
1711 StrVector::const_iterator End,
1712 bool IsJoin, raw_ostream& O)
1715 const std::string& cmd = *Pos;
1717 // Perform substitution.
1718 if (cmd == "$CALL") {
1719 Pos = SubstituteCall(Pos, End, IsJoin, O);
1721 else if (cmd == "$ENV") {
1722 Pos = SubstituteEnv(Pos, End, O);
1725 throw "Unknown special command: " + cmd;
1728 // Handle '$CMD(ARG)/additional/text'.
1729 const std::string& Leftover = *Pos;
1730 assert(Leftover.at(0) == ')');
1731 if (Leftover.size() != 1)
1732 O << " + std::string(\"" << (Leftover.c_str() + 1) << "\")";
1737 /// EmitCmdLineVecFill - Emit code that fills in the command line
1738 /// vector. Helper function used by EmitGenerateActionMethod().
1739 void EmitCmdLineVecFill(const Init* CmdLine, const std::string& ToolName,
1740 bool IsJoin, unsigned IndentLevel,
1743 TokenizeCmdLine(InitPtrToString(CmdLine), StrVec);
1746 throw "Tool '" + ToolName + "' has empty command line!";
1748 StrVector::const_iterator B = StrVec.begin(), E = StrVec.end();
1750 // Emit the command itself.
1751 assert(!StrVec[0].empty());
1752 O.indent(IndentLevel) << "cmd = ";
1753 if (StrVec[0][0] == '$') {
1754 B = SubstituteSpecialCommands(B, E, IsJoin, O);
1758 O << '"' << StrVec[0] << '"';
1763 // Go through the command arguments.
1765 for (; B != E; ++B) {
1766 const std::string& cmd = *B;
1768 assert(!cmd.empty());
1769 O.indent(IndentLevel);
1771 if (cmd.at(0) == '$') {
1772 O << "vec.push_back(std::make_pair(0, ";
1773 B = SubstituteSpecialCommands(B, E, IsJoin, O);
1777 O << "vec.push_back(std::make_pair(0, \"" << cmd << "\"));\n";
1783 /// EmitForwardOptionPropertyHandlingCode - Helper function used to
1784 /// implement EmitActionHandler. Emits code for
1785 /// handling the (forward) and (forward_as) option properties.
1786 void EmitForwardOptionPropertyHandlingCode (const OptionDescription& D,
1787 unsigned IndentLevel,
1788 const std::string& NewName,
1790 const std::string& Name = NewName.empty()
1793 unsigned IndentLevel1 = IndentLevel + Indent1;
1796 case OptionType::Switch:
1797 O.indent(IndentLevel)
1798 << "vec.push_back(std::make_pair(0, \"" << Name << "\"));\n";
1800 case OptionType::Parameter:
1801 O.indent(IndentLevel) << "vec.push_back(std::make_pair(0, \"" << Name;
1803 if (!D.isForwardNotSplit()) {
1805 O.indent(IndentLevel) << "vec.push_back(std::make_pair(0, "
1806 << D.GenVariableName() << "));\n";
1809 O << "=\" + " << D.GenVariableName() << "));\n";
1812 case OptionType::Prefix:
1813 O.indent(IndentLevel) << "vec.push_back(std::make_pair(0, \""
1815 << D.GenVariableName() << "));\n";
1817 case OptionType::PrefixList:
1818 O.indent(IndentLevel)
1819 << "for (" << D.GenTypeDeclaration()
1820 << "::iterator B = " << D.GenVariableName() << ".begin(),\n";
1821 O.indent(IndentLevel)
1822 << "E = " << D.GenVariableName() << ".end(); B != E;) {\n";
1823 O.indent(IndentLevel1) << "vec.push_back(std::make_pair(0, \""
1824 << Name << "\" + " << "*B));\n";
1825 O.indent(IndentLevel1) << "++B;\n";
1827 for (int i = 1, j = D.MultiVal; i < j; ++i) {
1828 O.indent(IndentLevel1) << "vec.push_back(std::make_pair(0, *B));\n";
1829 O.indent(IndentLevel1) << "++B;\n";
1832 O.indent(IndentLevel) << "}\n";
1834 case OptionType::ParameterList:
1835 O.indent(IndentLevel)
1836 << "for (" << D.GenTypeDeclaration() << "::iterator B = "
1837 << D.GenVariableName() << ".begin(),\n";
1838 O.indent(IndentLevel) << "E = " << D.GenVariableName()
1839 << ".end() ; B != E;) {\n";
1840 O.indent(IndentLevel1) << "vec.push_back(std::make_pair(0, \""
1841 << Name << "\"));\n";
1843 for (int i = 0, j = D.MultiVal; i < j; ++i) {
1844 O.indent(IndentLevel1) << "vec.push_back(std::make_pair(0, *B));\n";
1845 O.indent(IndentLevel1) << "++B;\n";
1848 O.indent(IndentLevel) << "}\n";
1850 case OptionType::Alias:
1852 throw "Aliases are not allowed in tool option descriptions!";
1856 /// ActionHandlingCallbackBase - Base class of EmitActionHandlersCallback and
1857 /// EmitPreprocessOptionsCallback.
1858 struct ActionHandlingCallbackBase
1861 void onErrorDag(const DagInit& d,
1862 unsigned IndentLevel, raw_ostream& O) const
1864 O.indent(IndentLevel)
1865 << "throw std::runtime_error(\"" <<
1866 (d.getNumArgs() >= 1 ? InitPtrToString(d.getArg(0))
1871 void onWarningDag(const DagInit& d,
1872 unsigned IndentLevel, raw_ostream& O) const
1874 CheckNumberOfArguments(d, 1);
1875 O.indent(IndentLevel) << "llvm::errs() << \""
1876 << InitPtrToString(d.getArg(0)) << "\";\n";
1881 /// EmitActionHandlersCallback - Emit code that handles actions. Used by
1882 /// EmitGenerateActionMethod() as an argument to EmitCaseConstructHandler().
1884 class EmitActionHandlersCallback;
1886 typedef void (EmitActionHandlersCallback::* EmitActionHandlersCallbackHandler)
1887 (const DagInit&, unsigned, raw_ostream&) const;
1889 class EmitActionHandlersCallback :
1890 public ActionHandlingCallbackBase,
1891 public HandlerTable<EmitActionHandlersCallbackHandler>
1893 typedef EmitActionHandlersCallbackHandler Handler;
1895 const OptionDescriptions& OptDescs;
1897 /// EmitHookInvocation - Common code for hook invocation from actions. Used by
1898 /// onAppendCmd and onOutputSuffix.
1899 void EmitHookInvocation(const std::string& Str,
1900 const char* BlockOpen, const char* BlockClose,
1901 unsigned IndentLevel, raw_ostream& O) const
1904 TokenizeCmdLine(Str, Out);
1906 for (StrVector::const_iterator B = Out.begin(), E = Out.end();
1908 const std::string& cmd = *B;
1910 O.indent(IndentLevel) << BlockOpen;
1912 if (cmd.at(0) == '$')
1913 B = SubstituteSpecialCommands(B, E, /* IsJoin = */ true, O);
1915 O << '"' << cmd << '"';
1921 void onAppendCmd (const DagInit& Dag,
1922 unsigned IndentLevel, raw_ostream& O) const
1924 CheckNumberOfArguments(Dag, 1);
1925 this->EmitHookInvocation(InitPtrToString(Dag.getArg(0)),
1926 "vec.push_back(std::make_pair(0, ", "));\n",
1930 void onForward (const DagInit& Dag,
1931 unsigned IndentLevel, raw_ostream& O) const
1933 CheckNumberOfArguments(Dag, 1);
1934 const std::string& Name = InitPtrToString(Dag.getArg(0));
1935 EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1936 IndentLevel, "", O);
1939 void onForwardAs (const DagInit& Dag,
1940 unsigned IndentLevel, raw_ostream& O) const
1942 CheckNumberOfArguments(Dag, 2);
1943 const std::string& Name = InitPtrToString(Dag.getArg(0));
1944 const std::string& NewName = InitPtrToString(Dag.getArg(1));
1945 EmitForwardOptionPropertyHandlingCode(OptDescs.FindOption(Name),
1946 IndentLevel, NewName, O);
1949 void onForwardValue (const DagInit& Dag,
1950 unsigned IndentLevel, raw_ostream& O) const
1952 CheckNumberOfArguments(Dag, 1);
1953 const std::string& Name = InitPtrToString(Dag.getArg(0));
1954 const OptionDescription& D = OptDescs.FindListOrParameter(Name);
1956 if (D.isParameter()) {
1957 O.indent(IndentLevel) << "vec.push_back(std::make_pair(0, "
1958 << D.GenVariableName() << "));\n";
1961 O.indent(IndentLevel) << "for (cl::list<std::string>::iterator B = "
1962 << D.GenVariableName() << ".begin(), \n";
1963 O.indent(IndentLevel + Indent1) << " E = " << D.GenVariableName()
1964 << ".end(); B != E; ++B)\n";
1965 O.indent(IndentLevel) << "{\n";
1966 O.indent(IndentLevel + Indent1)
1967 << "vec.push_back(std::make_pair(0, *B));\n";
1968 O.indent(IndentLevel) << "}\n";
1972 void onForwardTransformedValue (const DagInit& Dag,
1973 unsigned IndentLevel, raw_ostream& O) const
1975 CheckNumberOfArguments(Dag, 2);
1976 const std::string& Name = InitPtrToString(Dag.getArg(0));
1977 const std::string& Hook = InitPtrToString(Dag.getArg(1));
1978 const OptionDescription& D = OptDescs.FindListOrParameter(Name);
1980 O.indent(IndentLevel) << "vec.push_back(std::make_pair(0, " << "hooks::"
1981 << Hook << "(" << D.GenVariableName()
1982 << (D.isParameter() ? ".c_str()" : "") << ")));\n";
1985 void onNoOutFile (const DagInit& Dag,
1986 unsigned IndentLevel, raw_ostream& O) const
1988 CheckNumberOfArguments(Dag, 0);
1989 O.indent(IndentLevel) << "no_out_file = true;\n";
1992 void onOutputSuffix (const DagInit& Dag,
1993 unsigned IndentLevel, raw_ostream& O) const
1995 CheckNumberOfArguments(Dag, 1);
1996 this->EmitHookInvocation(InitPtrToString(Dag.getArg(0)),
1997 "output_suffix = ", ";\n", IndentLevel, O);
2000 void onStopCompilation (const DagInit& Dag,
2001 unsigned IndentLevel, raw_ostream& O) const
2003 O.indent(IndentLevel) << "stop_compilation = true;\n";
2007 void onUnpackValues (const DagInit& Dag,
2008 unsigned IndentLevel, raw_ostream& O) const
2010 throw "'unpack_values' is deprecated. "
2011 "Use 'comma_separated' + 'forward_value' instead!";
2016 explicit EmitActionHandlersCallback(const OptionDescriptions& OD)
2019 if (!staticMembersInitialized_) {
2020 AddHandler("error", &EmitActionHandlersCallback::onErrorDag);
2021 AddHandler("warning", &EmitActionHandlersCallback::onWarningDag);
2022 AddHandler("append_cmd", &EmitActionHandlersCallback::onAppendCmd);
2023 AddHandler("forward", &EmitActionHandlersCallback::onForward);
2024 AddHandler("forward_as", &EmitActionHandlersCallback::onForwardAs);
2025 AddHandler("forward_value", &EmitActionHandlersCallback::onForwardValue);
2026 AddHandler("forward_transformed_value",
2027 &EmitActionHandlersCallback::onForwardTransformedValue);
2028 AddHandler("no_out_file",
2029 &EmitActionHandlersCallback::onNoOutFile);
2030 AddHandler("output_suffix", &EmitActionHandlersCallback::onOutputSuffix);
2031 AddHandler("stop_compilation",
2032 &EmitActionHandlersCallback::onStopCompilation);
2033 AddHandler("unpack_values",
2034 &EmitActionHandlersCallback::onUnpackValues);
2037 staticMembersInitialized_ = true;
2041 void operator()(const Init* I,
2042 unsigned IndentLevel, raw_ostream& O) const
2044 InvokeDagInitHandler(this, I, IndentLevel, O);
2048 void EmitGenerateActionMethodHeader(const ToolDescription& D,
2049 bool IsJoin, raw_ostream& O)
2052 O.indent(Indent1) << "Action GenerateAction(const PathVector& inFiles,\n";
2054 O.indent(Indent1) << "Action GenerateAction(const sys::Path& inFile,\n";
2056 O.indent(Indent2) << "bool HasChildren,\n";
2057 O.indent(Indent2) << "const llvm::sys::Path& TempDir,\n";
2058 O.indent(Indent2) << "const InputLanguagesSet& InLangs,\n";
2059 O.indent(Indent2) << "const LanguageMap& LangMap) const\n";
2060 O.indent(Indent1) << "{\n";
2061 O.indent(Indent2) << "std::string cmd;\n";
2062 O.indent(Indent2) << "std::string out_file;\n";
2063 O.indent(Indent2) << "std::vector<std::pair<unsigned, std::string> > vec;\n";
2064 O.indent(Indent2) << "bool stop_compilation = !HasChildren;\n";
2065 O.indent(Indent2) << "bool no_out_file = false;\n";
2066 O.indent(Indent2) << "const char* output_suffix = \""
2067 << D.OutputSuffix << "\";\n";
2070 // EmitGenerateActionMethod - Emit either a normal or a "join" version of the
2071 // Tool::GenerateAction() method.
2072 void EmitGenerateActionMethod (const ToolDescription& D,
2073 const OptionDescriptions& OptDescs,
2074 bool IsJoin, raw_ostream& O) {
2076 EmitGenerateActionMethodHeader(D, IsJoin, O);
2079 throw "Tool " + D.Name + " has no cmd_line property!";
2081 // Process the 'command' property.
2083 EmitCmdLineVecFill(D.CmdLine, D.Name, IsJoin, Indent2, O);
2086 // Process the 'actions' list of this tool.
2088 EmitCaseConstructHandler(D.Actions, Indent2,
2089 EmitActionHandlersCallback(OptDescs),
2090 false, OptDescs, O);
2094 if (!D.InFileOption.empty()) {
2095 O.indent(Indent2) << "vec.push_back(std::make_pair(0, \""
2096 << D.InFileOption << "\");\n";
2101 << "for (PathVector::const_iterator B = inFiles.begin(),\n";
2102 O.indent(Indent3) << "E = inFiles.end(); B != E; ++B)\n";
2103 O.indent(Indent2) << "{\n";
2104 O.indent(Indent3) << "vec.push_back(std::make_pair(0, B->str()));\n";
2105 O.indent(Indent2) << "}\n";
2108 O.indent(Indent2) << "vec.push_back(std::make_pair(0, inFile.str()));\n";
2112 O.indent(Indent2) << "if (!no_out_file) {\n";
2113 if (!D.OutFileOption.empty())
2114 O.indent(Indent3) << "vec.push_back(std::make_pair(0, \""
2115 << D.OutFileOption << "\"));\n";
2117 O.indent(Indent3) << "out_file = this->OutFilename("
2118 << (IsJoin ? "sys::Path(),\n" : "inFile,\n");
2119 O.indent(Indent4) << "TempDir, stop_compilation, output_suffix).str();\n\n";
2120 O.indent(Indent3) << "vec.push_back(std::make_pair(0, out_file));\n";
2122 O.indent(Indent2) << "}\n\n";
2124 // Handle the Sink property.
2126 O.indent(Indent2) << "if (!" << SinkOptionName << ".empty()) {\n";
2127 O.indent(Indent3) << "for (cl::list<std::string>::iterator B = "
2128 << SinkOptionName << ".begin(), E = " << SinkOptionName
2129 << ".end(); B != E; ++B)\n";
2130 O.indent(Indent4) << "vec.push_back(std::make_pair(0, *B));\n";
2131 O.indent(Indent2) << "}\n";
2134 O.indent(Indent2) << "return Action(cmd, this->SortArgs(vec), "
2135 << "stop_compilation, out_file);\n";
2136 O.indent(Indent1) << "}\n\n";
2139 /// EmitGenerateActionMethods - Emit two GenerateAction() methods for
2140 /// a given Tool class.
2141 void EmitGenerateActionMethods (const ToolDescription& ToolDesc,
2142 const OptionDescriptions& OptDescs,
2144 if (!ToolDesc.isJoin()) {
2145 O.indent(Indent1) << "Action GenerateAction(const PathVector& inFiles,\n";
2146 O.indent(Indent2) << "bool HasChildren,\n";
2147 O.indent(Indent2) << "const llvm::sys::Path& TempDir,\n";
2148 O.indent(Indent2) << "const InputLanguagesSet& InLangs,\n";
2149 O.indent(Indent2) << "const LanguageMap& LangMap) const\n";
2150 O.indent(Indent1) << "{\n";
2151 O.indent(Indent2) << "throw std::runtime_error(\"" << ToolDesc.Name
2152 << " is not a Join tool!\");\n";
2153 O.indent(Indent1) << "}\n\n";
2156 EmitGenerateActionMethod(ToolDesc, OptDescs, true, O);
2159 EmitGenerateActionMethod(ToolDesc, OptDescs, false, O);
2162 /// EmitInOutLanguageMethods - Emit the [Input,Output]Language()
2163 /// methods for a given Tool class.
2164 void EmitInOutLanguageMethods (const ToolDescription& D, raw_ostream& O) {
2165 O.indent(Indent1) << "const char** InputLanguages() const {\n";
2166 O.indent(Indent2) << "return InputLanguages_;\n";
2167 O.indent(Indent1) << "}\n\n";
2169 if (D.OutLanguage.empty())
2170 throw "Tool " + D.Name + " has no 'out_language' property!";
2172 O.indent(Indent1) << "const char* OutputLanguage() const {\n";
2173 O.indent(Indent2) << "return \"" << D.OutLanguage << "\";\n";
2174 O.indent(Indent1) << "}\n\n";
2177 /// EmitNameMethod - Emit the Name() method for a given Tool class.
2178 void EmitNameMethod (const ToolDescription& D, raw_ostream& O) {
2179 O.indent(Indent1) << "const char* Name() const {\n";
2180 O.indent(Indent2) << "return \"" << D.Name << "\";\n";
2181 O.indent(Indent1) << "}\n\n";
2184 /// EmitIsJoinMethod - Emit the IsJoin() method for a given Tool
2186 void EmitIsJoinMethod (const ToolDescription& D, raw_ostream& O) {
2187 O.indent(Indent1) << "bool IsJoin() const {\n";
2189 O.indent(Indent2) << "return true;\n";
2191 O.indent(Indent2) << "return false;\n";
2192 O.indent(Indent1) << "}\n\n";
2195 /// EmitWorksOnEmptyCallback - Callback used by EmitWorksOnEmptyMethod in
2196 /// conjunction with EmitCaseConstructHandler.
2197 void EmitWorksOnEmptyCallback (const Init* Value,
2198 unsigned IndentLevel, raw_ostream& O) {
2199 CheckBooleanConstant(Value);
2200 O.indent(IndentLevel) << "return " << Value->getAsString() << ";\n";
2203 /// EmitWorksOnEmptyMethod - Emit the WorksOnEmpty() method for a given Tool
2205 void EmitWorksOnEmptyMethod (const ToolDescription& D,
2206 const OptionDescriptions& OptDescs,
2209 O.indent(Indent1) << "bool WorksOnEmpty() const {\n";
2211 O.indent(Indent2) << "return false;\n";
2213 EmitCaseConstructHandler(D.OnEmpty, Indent2, EmitWorksOnEmptyCallback,
2214 /*EmitElseIf = */ true, OptDescs, O);
2215 O.indent(Indent1) << "}\n\n";
2218 /// EmitStaticMemberDefinitions - Emit static member definitions for a
2219 /// given Tool class.
2220 void EmitStaticMemberDefinitions(const ToolDescription& D, raw_ostream& O) {
2221 if (D.InLanguage.empty())
2222 throw "Tool " + D.Name + " has no 'in_language' property!";
2224 O << "const char* " << D.Name << "::InputLanguages_[] = {";
2225 for (StrVector::const_iterator B = D.InLanguage.begin(),
2226 E = D.InLanguage.end(); B != E; ++B)
2227 O << '\"' << *B << "\", ";
2231 /// EmitToolClassDefinition - Emit a Tool class definition.
2232 void EmitToolClassDefinition (const ToolDescription& D,
2233 const OptionDescriptions& OptDescs,
2235 if (D.Name == "root")
2239 O << "class " << D.Name << " : public ";
2245 O << " {\nprivate:\n";
2246 O.indent(Indent1) << "static const char* InputLanguages_[];\n\n";
2249 EmitNameMethod(D, O);
2250 EmitInOutLanguageMethods(D, O);
2251 EmitIsJoinMethod(D, O);
2252 EmitWorksOnEmptyMethod(D, OptDescs, O);
2253 EmitGenerateActionMethods(D, OptDescs, O);
2255 // Close class definition
2258 EmitStaticMemberDefinitions(D, O);
2262 /// EmitOptionDefinitions - Iterate over a list of option descriptions
2263 /// and emit registration code.
2264 void EmitOptionDefinitions (const OptionDescriptions& descs,
2265 bool HasSink, bool HasExterns,
2268 std::vector<OptionDescription> Aliases;
2270 // Emit static cl::Option variables.
2271 for (OptionDescriptions::const_iterator B = descs.begin(),
2272 E = descs.end(); B!=E; ++B) {
2273 const OptionDescription& val = B->second;
2275 if (val.Type == OptionType::Alias) {
2276 Aliases.push_back(val);
2283 O << val.GenTypeDeclaration() << ' '
2284 << val.GenVariableName();
2286 if (val.isExtern()) {
2291 O << "(\"" << val.Name << "\"\n";
2293 if (val.Type == OptionType::Prefix || val.Type == OptionType::PrefixList)
2294 O << ", cl::Prefix";
2296 if (val.isRequired()) {
2297 if (val.isList() && !val.isMultiVal())
2298 O << ", cl::OneOrMore";
2300 O << ", cl::Required";
2302 else if (val.isOneOrMore() && val.isList()) {
2303 O << ", cl::OneOrMore";
2305 else if (val.isOptional() && val.isList()) {
2306 O << ", cl::Optional";
2309 if (val.isReallyHidden())
2310 O << ", cl::ReallyHidden";
2311 else if (val.isHidden())
2312 O << ", cl::Hidden";
2314 if (val.isCommaSeparated())
2315 O << ", cl::CommaSeparated";
2317 if (val.MultiVal > 1)
2318 O << ", cl::multi_val(" << val.MultiVal << ')';
2321 const std::string& str = val.InitVal->getAsString();
2322 O << ", cl::init(" << str << ')';
2325 if (!val.Help.empty())
2326 O << ", cl::desc(\"" << val.Help << "\")";
2331 // Emit the aliases (they should go after all the 'proper' options).
2332 for (std::vector<OptionDescription>::const_iterator
2333 B = Aliases.begin(), E = Aliases.end(); B != E; ++B) {
2334 const OptionDescription& val = *B;
2336 O << val.GenTypeDeclaration() << ' '
2337 << val.GenVariableName()
2338 << "(\"" << val.Name << '\"';
2340 const OptionDescription& D = descs.FindOption(val.Help);
2341 O << ", cl::aliasopt(" << D.GenVariableName() << ")";
2343 O << ", cl::desc(\"" << "An alias for -" + val.Help << "\"));\n";
2346 // Emit the sink option.
2348 O << (HasExterns ? "extern cl" : "cl")
2349 << "::list<std::string> " << SinkOptionName
2350 << (HasExterns ? ";\n" : "(cl::Sink);\n");
2355 /// EmitPreprocessOptionsCallback - Helper function passed to
2356 /// EmitCaseConstructHandler() by EmitPreprocessOptions().
2358 class EmitPreprocessOptionsCallback;
2361 (EmitPreprocessOptionsCallback::* EmitPreprocessOptionsCallbackHandler)
2362 (const DagInit&, unsigned, raw_ostream&) const;
2364 class EmitPreprocessOptionsCallback :
2365 public ActionHandlingCallbackBase,
2366 public HandlerTable<EmitPreprocessOptionsCallbackHandler>
2368 typedef EmitPreprocessOptionsCallbackHandler Handler;
2370 (EmitPreprocessOptionsCallback::* HandlerImpl)
2371 (const Init*, unsigned, raw_ostream&) const;
2373 const OptionDescriptions& OptDescs_;
2375 void onListOrDag(const DagInit& d, HandlerImpl h,
2376 unsigned IndentLevel, raw_ostream& O) const
2378 CheckNumberOfArguments(d, 1);
2379 const Init* I = d.getArg(0);
2381 // If I is a list, apply h to each element.
2382 if (typeid(*I) == typeid(ListInit)) {
2383 const ListInit& L = *static_cast<const ListInit*>(I);
2384 for (ListInit::const_iterator B = L.begin(), E = L.end(); B != E; ++B)
2385 ((this)->*(h))(*B, IndentLevel, O);
2387 // Otherwise, apply h to I.
2389 ((this)->*(h))(I, IndentLevel, O);
2393 void onUnsetOptionImpl(const Init* I,
2394 unsigned IndentLevel, raw_ostream& O) const
2396 const std::string& OptName = InitPtrToString(I);
2397 const OptionDescription& OptDesc = OptDescs_.FindOption(OptName);
2399 if (OptDesc.isSwitch()) {
2400 O.indent(IndentLevel) << OptDesc.GenVariableName() << " = false;\n";
2402 else if (OptDesc.isParameter()) {
2403 O.indent(IndentLevel) << OptDesc.GenVariableName() << " = \"\";\n";
2405 else if (OptDesc.isList()) {
2406 O.indent(IndentLevel) << OptDesc.GenVariableName() << ".clear();\n";
2409 throw "Can't apply 'unset_option' to alias option '" + OptName + "'!";
2413 void onUnsetOption(const DagInit& d,
2414 unsigned IndentLevel, raw_ostream& O) const
2416 this->onListOrDag(d, &EmitPreprocessOptionsCallback::onUnsetOptionImpl,
2420 void onSetOptionImpl(const DagInit& d,
2421 unsigned IndentLevel, raw_ostream& O) const {
2422 CheckNumberOfArguments(d, 2);
2423 const std::string& OptName = InitPtrToString(d.getArg(0));
2424 const Init* Value = d.getArg(1);
2425 const OptionDescription& OptDesc = OptDescs_.FindOption(OptName);
2427 if (OptDesc.isList()) {
2428 const ListInit& List = InitPtrToList(Value);
2430 O.indent(IndentLevel) << OptDesc.GenVariableName() << ".clear();\n";
2431 for (ListInit::const_iterator B = List.begin(), E = List.end();
2433 O.indent(IndentLevel) << OptDesc.GenVariableName() << ".push_back(\""
2434 << InitPtrToString(*B) << "\");\n";
2437 else if (OptDesc.isSwitch()) {
2438 CheckBooleanConstant(Value);
2439 O.indent(IndentLevel) << OptDesc.GenVariableName()
2440 << " = " << Value->getAsString() << ";\n";
2442 else if (OptDesc.isParameter()) {
2443 const std::string& Str = InitPtrToString(Value);
2444 O.indent(IndentLevel) << OptDesc.GenVariableName()
2445 << " = \"" << Str << "\";\n";
2448 throw "Can't apply 'set_option' to alias option -" + OptName + " !";
2452 void onSetSwitch(const Init* I,
2453 unsigned IndentLevel, raw_ostream& O) const {
2454 const std::string& OptName = InitPtrToString(I);
2455 const OptionDescription& OptDesc = OptDescs_.FindOption(OptName);
2457 if (OptDesc.isSwitch())
2458 O.indent(IndentLevel) << OptDesc.GenVariableName() << " = true;\n";
2460 throw "set_option: -" + OptName + " is not a switch option!";
2463 void onSetOption(const DagInit& d,
2464 unsigned IndentLevel, raw_ostream& O) const
2466 CheckNumberOfArguments(d, 1);
2468 // Two arguments: (set_option "parameter", VALUE), where VALUE can be a
2469 // boolean, a string or a string list.
2470 if (d.getNumArgs() > 1)
2471 this->onSetOptionImpl(d, IndentLevel, O);
2472 // One argument: (set_option "switch")
2473 // or (set_option ["switch1", "switch2", ...])
2475 this->onListOrDag(d, &EmitPreprocessOptionsCallback::onSetSwitch,
2481 EmitPreprocessOptionsCallback(const OptionDescriptions& OptDescs)
2482 : OptDescs_(OptDescs)
2484 if (!staticMembersInitialized_) {
2485 AddHandler("error", &EmitPreprocessOptionsCallback::onErrorDag);
2486 AddHandler("warning", &EmitPreprocessOptionsCallback::onWarningDag);
2487 AddHandler("unset_option", &EmitPreprocessOptionsCallback::onUnsetOption);
2488 AddHandler("set_option", &EmitPreprocessOptionsCallback::onSetOption);
2490 staticMembersInitialized_ = true;
2494 void operator()(const Init* I,
2495 unsigned IndentLevel, raw_ostream& O) const
2497 InvokeDagInitHandler(this, I, IndentLevel, O);
2502 /// EmitPreprocessOptions - Emit the PreprocessOptionsLocal() function.
2503 void EmitPreprocessOptions (const RecordKeeper& Records,
2504 const OptionDescriptions& OptDecs, raw_ostream& O)
2506 O << "void PreprocessOptionsLocal() {\n";
2508 const RecordVector& OptionPreprocessors =
2509 Records.getAllDerivedDefinitions("OptionPreprocessor");
2511 for (RecordVector::const_iterator B = OptionPreprocessors.begin(),
2512 E = OptionPreprocessors.end(); B!=E; ++B) {
2513 DagInit* Case = (*B)->getValueAsDag("preprocessor");
2514 EmitCaseConstructHandler(Case, Indent1,
2515 EmitPreprocessOptionsCallback(OptDecs),
2522 /// EmitPopulateLanguageMap - Emit the PopulateLanguageMapLocal() function.
2523 void EmitPopulateLanguageMap (const RecordKeeper& Records, raw_ostream& O)
2525 O << "void PopulateLanguageMapLocal(LanguageMap& langMap) {\n";
2527 // Get the relevant field out of RecordKeeper
2528 const Record* LangMapRecord = Records.getDef("LanguageMap");
2530 // It is allowed for a plugin to have no language map.
2531 if (LangMapRecord) {
2533 ListInit* LangsToSuffixesList = LangMapRecord->getValueAsListInit("map");
2534 if (!LangsToSuffixesList)
2535 throw "Error in the language map definition!";
2537 for (unsigned i = 0; i < LangsToSuffixesList->size(); ++i) {
2538 const Record* LangToSuffixes = LangsToSuffixesList->getElementAsRecord(i);
2540 const std::string& Lang = LangToSuffixes->getValueAsString("lang");
2541 const ListInit* Suffixes = LangToSuffixes->getValueAsListInit("suffixes");
2543 for (unsigned i = 0; i < Suffixes->size(); ++i)
2544 O.indent(Indent1) << "langMap[\""
2545 << InitPtrToString(Suffixes->getElement(i))
2546 << "\"] = \"" << Lang << "\";\n";
2553 /// IncDecWeight - Helper function passed to EmitCaseConstructHandler()
2554 /// by EmitEdgeClass().
2555 void IncDecWeight (const Init* i, unsigned IndentLevel,
2557 const DagInit& d = InitPtrToDag(i);
2558 const std::string& OpName = GetOperatorName(d);
2560 if (OpName == "inc_weight") {
2561 O.indent(IndentLevel) << "ret += ";
2563 else if (OpName == "dec_weight") {
2564 O.indent(IndentLevel) << "ret -= ";
2566 else if (OpName == "error") {
2567 CheckNumberOfArguments(d, 1);
2568 O.indent(IndentLevel) << "throw std::runtime_error(\""
2569 << InitPtrToString(d.getArg(0))
2574 throw "Unknown operator in edge properties list: '" + OpName + "'!"
2575 "\nOnly 'inc_weight', 'dec_weight' and 'error' are allowed.";
2578 if (d.getNumArgs() > 0)
2579 O << InitPtrToInt(d.getArg(0)) << ";\n";
2585 /// EmitEdgeClass - Emit a single Edge# class.
2586 void EmitEdgeClass (unsigned N, const std::string& Target,
2587 DagInit* Case, const OptionDescriptions& OptDescs,
2590 // Class constructor.
2591 O << "class Edge" << N << ": public Edge {\n"
2593 O.indent(Indent1) << "Edge" << N << "() : Edge(\"" << Target
2596 // Function Weight().
2598 << "unsigned Weight(const InputLanguagesSet& InLangs) const {\n";
2599 O.indent(Indent2) << "unsigned ret = 0;\n";
2601 // Handle the 'case' construct.
2602 EmitCaseConstructHandler(Case, Indent2, IncDecWeight, false, OptDescs, O);
2604 O.indent(Indent2) << "return ret;\n";
2605 O.indent(Indent1) << "}\n\n};\n\n";
2608 /// EmitEdgeClasses - Emit Edge* classes that represent graph edges.
2609 void EmitEdgeClasses (const RecordVector& EdgeVector,
2610 const OptionDescriptions& OptDescs,
2613 for (RecordVector::const_iterator B = EdgeVector.begin(),
2614 E = EdgeVector.end(); B != E; ++B) {
2615 const Record* Edge = *B;
2616 const std::string& NodeB = Edge->getValueAsString("b");
2617 DagInit& Weight = *Edge->getValueAsDag("weight");
2619 if (!IsDagEmpty(Weight))
2620 EmitEdgeClass(i, NodeB, &Weight, OptDescs, O);
2625 /// EmitPopulateCompilationGraph - Emit the PopulateCompilationGraphLocal()
2627 void EmitPopulateCompilationGraph (const RecordVector& EdgeVector,
2628 const ToolDescriptions& ToolDescs,
2631 O << "void PopulateCompilationGraphLocal(CompilationGraph& G) {\n";
2633 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
2634 E = ToolDescs.end(); B != E; ++B)
2635 O.indent(Indent1) << "G.insertNode(new " << (*B)->Name << "());\n";
2642 for (RecordVector::const_iterator B = EdgeVector.begin(),
2643 E = EdgeVector.end(); B != E; ++B) {
2644 const Record* Edge = *B;
2645 const std::string& NodeA = Edge->getValueAsString("a");
2646 const std::string& NodeB = Edge->getValueAsString("b");
2647 DagInit& Weight = *Edge->getValueAsDag("weight");
2649 O.indent(Indent1) << "G.insertEdge(\"" << NodeA << "\", ";
2651 if (IsDagEmpty(Weight))
2652 O << "new SimpleEdge(\"" << NodeB << "\")";
2654 O << "new Edge" << i << "()";
2663 /// HookInfo - Information about the hook type and number of arguments.
2666 // A hook can either have a single parameter of type std::vector<std::string>,
2667 // or NumArgs parameters of type const char*.
2668 enum HookType { ListHook, ArgHook };
2673 HookInfo() : Type(ArgHook), NumArgs(1)
2676 HookInfo(HookType T) : Type(T), NumArgs(1)
2679 HookInfo(unsigned N) : Type(ArgHook), NumArgs(N)
2683 typedef llvm::StringMap<HookInfo> HookInfoMap;
2685 /// ExtractHookNames - Extract the hook names from all instances of
2686 /// $CALL(HookName) in the provided command line string/action. Helper
2687 /// function used by FillInHookNames().
2688 class ExtractHookNames {
2689 HookInfoMap& HookNames_;
2690 const OptionDescriptions& OptDescs_;
2692 ExtractHookNames(HookInfoMap& HookNames, const OptionDescriptions& OptDescs)
2693 : HookNames_(HookNames), OptDescs_(OptDescs)
2696 void onAction (const DagInit& Dag) {
2697 const std::string& Name = GetOperatorName(Dag);
2699 if (Name == "forward_transformed_value") {
2700 CheckNumberOfArguments(Dag, 2);
2701 const std::string& OptName = InitPtrToString(Dag.getArg(0));
2702 const std::string& HookName = InitPtrToString(Dag.getArg(1));
2703 const OptionDescription& D = OptDescs_.FindOption(OptName);
2705 HookNames_[HookName] = HookInfo(D.isList() ? HookInfo::ListHook
2706 : HookInfo::ArgHook);
2708 else if (Name == "append_cmd" || Name == "output_suffix") {
2709 CheckNumberOfArguments(Dag, 1);
2710 this->onCmdLine(InitPtrToString(Dag.getArg(0)));
2714 void onCmdLine(const std::string& Cmd) {
2716 TokenizeCmdLine(Cmd, cmds);
2718 for (StrVector::const_iterator B = cmds.begin(), E = cmds.end();
2720 const std::string& cmd = *B;
2722 if (cmd == "$CALL") {
2723 unsigned NumArgs = 0;
2724 CheckedIncrement(B, E, "Syntax error in $CALL invocation!");
2725 const std::string& HookName = *B;
2727 if (HookName.at(0) == ')')
2728 throw "$CALL invoked with no arguments!";
2730 while (++B != E && B->at(0) != ')') {
2734 HookInfoMap::const_iterator H = HookNames_.find(HookName);
2736 if (H != HookNames_.end() && H->second.NumArgs != NumArgs &&
2737 H->second.Type != HookInfo::ArgHook)
2738 throw "Overloading of hooks is not allowed. Overloaded hook: "
2741 HookNames_[HookName] = HookInfo(NumArgs);
2746 void operator()(const Init* Arg) {
2748 // We're invoked on an action (either a dag or a dag list).
2749 if (typeid(*Arg) == typeid(DagInit)) {
2750 const DagInit& Dag = InitPtrToDag(Arg);
2751 this->onAction(Dag);
2754 else if (typeid(*Arg) == typeid(ListInit)) {
2755 const ListInit& List = InitPtrToList(Arg);
2756 for (ListInit::const_iterator B = List.begin(), E = List.end(); B != E;
2758 const DagInit& Dag = InitPtrToDag(*B);
2759 this->onAction(Dag);
2764 // We're invoked on a command line.
2765 this->onCmdLine(InitPtrToString(Arg));
2768 void operator()(const DagInit* Test, unsigned, bool) {
2769 this->operator()(Test);
2771 void operator()(const Init* Statement, unsigned) {
2772 this->operator()(Statement);
2776 /// FillInHookNames - Actually extract the hook names from all command
2777 /// line strings. Helper function used by EmitHookDeclarations().
2778 void FillInHookNames(const ToolDescriptions& ToolDescs,
2779 const OptionDescriptions& OptDescs,
2780 HookInfoMap& HookNames)
2782 // For all tool descriptions:
2783 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
2784 E = ToolDescs.end(); B != E; ++B) {
2785 const ToolDescription& D = *(*B);
2787 // Look for 'forward_transformed_value' in 'actions'.
2789 WalkCase(D.Actions, Id(), ExtractHookNames(HookNames, OptDescs));
2791 // Look for hook invocations in 'cmd_line'.
2794 if (dynamic_cast<StringInit*>(D.CmdLine))
2795 // This is a string.
2796 ExtractHookNames(HookNames, OptDescs).operator()(D.CmdLine);
2798 // This is a 'case' construct.
2799 WalkCase(D.CmdLine, Id(), ExtractHookNames(HookNames, OptDescs));
2803 /// EmitHookDeclarations - Parse CmdLine fields of all the tool
2804 /// property records and emit hook function declaration for each
2805 /// instance of $CALL(HookName).
2806 void EmitHookDeclarations(const ToolDescriptions& ToolDescs,
2807 const OptionDescriptions& OptDescs, raw_ostream& O) {
2808 HookInfoMap HookNames;
2810 FillInHookNames(ToolDescs, OptDescs, HookNames);
2811 if (HookNames.empty())
2814 O << "namespace hooks {\n";
2815 for (HookInfoMap::const_iterator B = HookNames.begin(),
2816 E = HookNames.end(); B != E; ++B) {
2817 const char* HookName = B->first();
2818 const HookInfo& Info = B->second;
2820 O.indent(Indent1) << "std::string " << HookName << "(";
2822 if (Info.Type == HookInfo::ArgHook) {
2823 for (unsigned i = 0, j = Info.NumArgs; i < j; ++i) {
2824 O << "const char* Arg" << i << (i+1 == j ? "" : ", ");
2828 O << "const std::vector<std::string>& Arg";
2836 /// EmitRegisterPlugin - Emit code to register this plugin.
2837 void EmitRegisterPlugin(int Priority, raw_ostream& O) {
2838 O << "struct Plugin : public llvmc::BasePlugin {\n\n";
2839 O.indent(Indent1) << "int Priority() const { return "
2840 << Priority << "; }\n\n";
2841 O.indent(Indent1) << "void PreprocessOptions() const\n";
2842 O.indent(Indent1) << "{ PreprocessOptionsLocal(); }\n\n";
2843 O.indent(Indent1) << "void PopulateLanguageMap(LanguageMap& langMap) const\n";
2844 O.indent(Indent1) << "{ PopulateLanguageMapLocal(langMap); }\n\n";
2846 << "void PopulateCompilationGraph(CompilationGraph& graph) const\n";
2847 O.indent(Indent1) << "{ PopulateCompilationGraphLocal(graph); }\n"
2849 << "static llvmc::RegisterPlugin<Plugin> RP;\n\n";
2852 /// EmitIncludes - Emit necessary #include directives and some
2853 /// additional declarations.
2854 void EmitIncludes(raw_ostream& O) {
2855 O << "#include \"llvm/CompilerDriver/BuiltinOptions.h\"\n"
2856 << "#include \"llvm/CompilerDriver/CompilationGraph.h\"\n"
2857 << "#include \"llvm/CompilerDriver/ForceLinkageMacros.h\"\n"
2858 << "#include \"llvm/CompilerDriver/Plugin.h\"\n"
2859 << "#include \"llvm/CompilerDriver/Tool.h\"\n\n"
2861 << "#include \"llvm/Support/CommandLine.h\"\n"
2862 << "#include \"llvm/Support/raw_ostream.h\"\n\n"
2864 << "#include <algorithm>\n"
2865 << "#include <cstdlib>\n"
2866 << "#include <iterator>\n"
2867 << "#include <stdexcept>\n\n"
2869 << "using namespace llvm;\n"
2870 << "using namespace llvmc;\n\n"
2872 << "extern cl::opt<std::string> OutputFilename;\n\n"
2874 << "inline const char* checkCString(const char* s)\n"
2875 << "{ return s == NULL ? \"\" : s; }\n\n";
2879 /// PluginData - Holds all information about a plugin.
2881 OptionDescriptions OptDescs;
2884 ToolDescriptions ToolDescs;
2889 /// HasSink - Go through the list of tool descriptions and check if
2890 /// there are any with the 'sink' property set.
2891 bool HasSink(const ToolDescriptions& ToolDescs) {
2892 for (ToolDescriptions::const_iterator B = ToolDescs.begin(),
2893 E = ToolDescs.end(); B != E; ++B)
2900 /// HasExterns - Go through the list of option descriptions and check
2901 /// if there are any external options.
2902 bool HasExterns(const OptionDescriptions& OptDescs) {
2903 for (OptionDescriptions::const_iterator B = OptDescs.begin(),
2904 E = OptDescs.end(); B != E; ++B)
2905 if (B->second.isExtern())
2911 /// CollectPluginData - Collect tool and option properties,
2912 /// compilation graph edges and plugin priority from the parse tree.
2913 void CollectPluginData (const RecordKeeper& Records, PluginData& Data) {
2914 // Collect option properties.
2915 const RecordVector& OptionLists =
2916 Records.getAllDerivedDefinitions("OptionList");
2917 CollectOptionDescriptions(OptionLists.begin(), OptionLists.end(),
2920 // Collect tool properties.
2921 const RecordVector& Tools = Records.getAllDerivedDefinitions("Tool");
2922 CollectToolDescriptions(Tools.begin(), Tools.end(), Data.ToolDescs);
2923 Data.HasSink = HasSink(Data.ToolDescs);
2924 Data.HasExterns = HasExterns(Data.OptDescs);
2926 // Collect compilation graph edges.
2927 const RecordVector& CompilationGraphs =
2928 Records.getAllDerivedDefinitions("CompilationGraph");
2929 FillInEdgeVector(CompilationGraphs.begin(), CompilationGraphs.end(),
2932 // Calculate the priority of this plugin.
2933 const RecordVector& Priorities =
2934 Records.getAllDerivedDefinitions("PluginPriority");
2935 Data.Priority = CalculatePriority(Priorities.begin(), Priorities.end());
2938 /// CheckPluginData - Perform some sanity checks on the collected data.
2939 void CheckPluginData(PluginData& Data) {
2940 // Filter out all tools not mentioned in the compilation graph.
2941 FilterNotInGraph(Data.Edges, Data.ToolDescs);
2943 // Typecheck the compilation graph.
2944 TypecheckGraph(Data.Edges, Data.ToolDescs);
2946 // Check that there are no options without side effects (specified
2947 // only in the OptionList).
2948 CheckForSuperfluousOptions(Data.Edges, Data.ToolDescs, Data.OptDescs);
2951 void EmitPluginCode(const PluginData& Data, raw_ostream& O) {
2952 // Emit file header.
2955 // Emit global option registration code.
2956 EmitOptionDefinitions(Data.OptDescs, Data.HasSink, Data.HasExterns, O);
2958 // Emit hook declarations.
2959 EmitHookDeclarations(Data.ToolDescs, Data.OptDescs, O);
2961 O << "namespace {\n\n";
2963 // Emit PreprocessOptionsLocal() function.
2964 EmitPreprocessOptions(Records, Data.OptDescs, O);
2966 // Emit PopulateLanguageMapLocal() function
2967 // (language map maps from file extensions to language names).
2968 EmitPopulateLanguageMap(Records, O);
2970 // Emit Tool classes.
2971 for (ToolDescriptions::const_iterator B = Data.ToolDescs.begin(),
2972 E = Data.ToolDescs.end(); B!=E; ++B)
2973 EmitToolClassDefinition(*(*B), Data.OptDescs, O);
2975 // Emit Edge# classes.
2976 EmitEdgeClasses(Data.Edges, Data.OptDescs, O);
2978 // Emit PopulateCompilationGraphLocal() function.
2979 EmitPopulateCompilationGraph(Data.Edges, Data.ToolDescs, O);
2981 // Emit code for plugin registration.
2982 EmitRegisterPlugin(Data.Priority, O);
2984 O << "} // End anonymous namespace.\n\n";
2986 // Force linkage magic.
2987 O << "namespace llvmc {\n";
2988 O << "LLVMC_FORCE_LINKAGE_DECL(LLVMC_PLUGIN_NAME) {}\n";
2995 // End of anonymous namespace
2998 /// run - The back-end entry point.
2999 void LLVMCConfigurationEmitter::run (raw_ostream &O) {
3003 CollectPluginData(Records, Data);
3004 CheckPluginData(Data);
3006 this->EmitSourceFileHeader("LLVMC Configuration Library", O);
3007 EmitPluginCode(Data, O);
3009 } catch (std::exception& Error) {
3010 throw Error.what() + std::string(" - usually this means a syntax error.");