1 //===--- ClangCommentCommandInfoEmitter.cpp - Generate command lists -----====// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This tablegen backend emits command lists and efficient matchers for command 11 // names that are used in documentation comments. 12 // 13 //===----------------------------------------------------------------------===// 14 15 #include "llvm/TableGen/Record.h" 16 #include "llvm/TableGen/StringMatcher.h" 17 #include "llvm/TableGen/TableGenBackend.h" 18 #include <vector> 19 20 using namespace llvm; 21 22 namespace clang { 23 void EmitClangCommentCommandInfo(RecordKeeper &Records, raw_ostream &OS) { 24 emitSourceFileHeader("A list of commands useable in documentation " 25 "comments", OS); 26 27 OS << "namespace {\n" 28 "const CommandInfo Commands[] = {\n"; 29 std::vector<Record *> Tags = Records.getAllDerivedDefinitions("Command"); 30 for (size_t i = 0, e = Tags.size(); i != e; ++i) { 31 Record &Tag = *Tags[i]; 32 OS << " { " 33 << "\"" << Tag.getValueAsString("Name") << "\", " 34 << "\"" << Tag.getValueAsString("EndCommandName") << "\", " 35 << i << ", " 36 << Tag.getValueAsInt("NumArgs") << ", " 37 << Tag.getValueAsBit("IsInlineCommand") << ", " 38 << Tag.getValueAsBit("IsBlockCommand") << ", " 39 << Tag.getValueAsBit("IsBriefCommand") << ", " 40 << Tag.getValueAsBit("IsReturnsCommand") << ", " 41 << Tag.getValueAsBit("IsParamCommand") << ", " 42 << Tag.getValueAsBit("IsTParamCommand") << ", " 43 << Tag.getValueAsBit("IsDeprecatedCommand") << ", " 44 << Tag.getValueAsBit("IsHeaderfileCommand") << ", " 45 << Tag.getValueAsBit("IsEmptyParagraphAllowed") << ", " 46 << Tag.getValueAsBit("IsVerbatimBlockCommand") << ", " 47 << Tag.getValueAsBit("IsVerbatimBlockEndCommand") << ", " 48 << Tag.getValueAsBit("IsVerbatimLineCommand") << ", " 49 << Tag.getValueAsBit("IsDeclarationCommand") << ", " 50 << Tag.getValueAsBit("IsFunctionDeclarationCommand") << ", " 51 << Tag.getValueAsBit("IsRecordLikeDetailCommand") << ", " 52 << Tag.getValueAsBit("IsRecordLikeDeclarationCommand") << ", " 53 << /* IsUnknownCommand = */ "0" 54 << " }"; 55 if (i + 1 != e) 56 OS << ","; 57 OS << "\n"; 58 } 59 OS << "};\n" 60 "} // unnamed namespace\n\n"; 61 62 std::vector<StringMatcher::StringPair> Matches; 63 for (size_t i = 0, e = Tags.size(); i != e; ++i) { 64 Record &Tag = *Tags[i]; 65 std::string Name = Tag.getValueAsString("Name"); 66 std::string Return; 67 raw_string_ostream(Return) << "return &Commands[" << i << "];"; 68 Matches.push_back(StringMatcher::StringPair(Name, Return)); 69 } 70 71 OS << "const CommandInfo *CommandTraits::getBuiltinCommandInfo(\n" 72 << " StringRef Name) {\n"; 73 StringMatcher("Name", Matches, OS).Emit(); 74 OS << " return NULL;\n" 75 << "}\n\n"; 76 } 77 78 static std::string MangleName(StringRef Str) { 79 std::string Mangled; 80 for (unsigned i = 0, e = Str.size(); i != e; ++i) { 81 switch (Str[i]) { 82 default: 83 Mangled += Str[i]; 84 break; 85 case '[': 86 Mangled += "lsquare"; 87 break; 88 case ']': 89 Mangled += "rsquare"; 90 break; 91 case '{': 92 Mangled += "lbrace"; 93 break; 94 case '}': 95 Mangled += "rbrace"; 96 break; 97 case '$': 98 Mangled += "dollar"; 99 break; 100 } 101 } 102 return Mangled; 103 } 104 105 void EmitClangCommentCommandList(RecordKeeper &Records, raw_ostream &OS) { 106 emitSourceFileHeader("A list of commands useable in documentation " 107 "comments", OS); 108 109 OS << "#ifndef COMMENT_COMMAND\n" 110 << "# define COMMENT_COMMAND(NAME)\n" 111 << "#endif\n"; 112 113 std::vector<Record *> Tags = Records.getAllDerivedDefinitions("Command"); 114 for (size_t i = 0, e = Tags.size(); i != e; ++i) { 115 Record &Tag = *Tags[i]; 116 std::string MangledName = MangleName(Tag.getValueAsString("Name")); 117 118 OS << "COMMENT_COMMAND(" << MangledName << ")\n"; 119 } 120 } 121 } // end namespace clang 122 123