contrib/llvm/tools/clang/utils/TableGen/ClangCommentHTMLTagsEmitter.cpp

   1 //===--- ClangCommentHTMLTagsEmitter.cpp - Generate HTML tag list for Clang -=//
   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 efficient matchers for HTML tags that are used
  11 // in documentation comments.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "TableGenBackends.h"
  16 #include "llvm/TableGen/Record.h"
  17 #include "llvm/TableGen/StringMatcher.h"
  18 #include "llvm/TableGen/TableGenBackend.h"
  19 #include <vector>
  20
  21 using namespace llvm;
  22
  23 void clang::EmitClangCommentHTMLTags(RecordKeeper &Records, raw_ostream &OS) {
  24   std::vector<Record *> Tags = Records.getAllDerivedDefinitions("Tag");
  25   std::vector<StringMatcher::StringPair> Matches;
  26   for (Record *Tag : Tags) {
  27     std::string Spelling = Tag->getValueAsString("Spelling");
  28     Matches.push_back(StringMatcher::StringPair(Spelling, "return true;"));
  29   }
  30
  31   emitSourceFileHeader("HTML tag name matcher", OS);
  32
  33   OS << "bool isHTMLTagName(StringRef Name) {\n";
  34   StringMatcher("Name", Matches, OS).Emit();
  35   OS << "  return false;\n"
  36      << "}\n\n";
  37 }
  38
  39 void clang::EmitClangCommentHTMLTagsProperties(RecordKeeper &Records,
  40                                                raw_ostream &OS) {
  41   std::vector<Record *> Tags = Records.getAllDerivedDefinitions("Tag");
  42   std::vector<StringMatcher::StringPair> MatchesEndTagOptional;
  43   std::vector<StringMatcher::StringPair> MatchesEndTagForbidden;
  44   for (Record *Tag : Tags) {
  45     std::string Spelling = Tag->getValueAsString("Spelling");
  46     StringMatcher::StringPair Match(Spelling, "return true;");
  47     if (Tag->getValueAsBit("EndTagOptional"))
  48       MatchesEndTagOptional.push_back(Match);
  49     if (Tag->getValueAsBit("EndTagForbidden"))
  50       MatchesEndTagForbidden.push_back(Match);
  51   }
  52
  53   emitSourceFileHeader("HTML tag properties", OS);
  54
  55   OS << "bool isHTMLEndTagOptional(StringRef Name) {\n";
  56   StringMatcher("Name", MatchesEndTagOptional, OS).Emit();
  57   OS << "  return false;\n"
  58      << "}\n\n";
  59
  60   OS << "bool isHTMLEndTagForbidden(StringRef Name) {\n";
  61   StringMatcher("Name", MatchesEndTagForbidden, OS).Emit();
  62   OS << "  return false;\n"
  63      << "}\n\n";
  64 }
  65