Merge pull request #80378 from DougGregor/remove-educational-note-markdown-rendering

[Diagnostics] Remove rendering of educational notes to the terminal

Author: DougGregor

include/swift/Basic/DiagnosticOptions.h

@@ -69,10 +69,6 @@ class DiagnosticOptions {
   PrintDiagnosticNamesMode PrintDiagnosticNames =
       PrintDiagnosticNamesMode::None;
 
-  /// If set to true, include educational notes in printed output if available.
-  /// Educational notes are documentation which supplement diagnostics.
-  bool PrintEducationalNotes = false;
-
   /// Whether to emit diagnostics in the terse LLVM style or in a more
   /// descriptive style that's specific to Swift.
   FormattingStyle PrintedFormattingStyle = FormattingStyle::Swift;

include/swift/Frontend/PrintingDiagnosticConsumer.h

@@ -32,14 +32,10 @@ namespace swift {
 class PrintingDiagnosticConsumer : public DiagnosticConsumer {
   llvm::raw_ostream &Stream;
   bool ForceColors = false;
-  bool PrintEducationalNotes = false;
   bool EmitMacroExpansionFiles = false;
   bool DidErrorOccur = false;
   DiagnosticOptions::FormattingStyle FormattingStyle =
       DiagnosticOptions::FormattingStyle::LLVM;
-  // Educational notes which are buffered until the consumer is finished
-  // constructing a snippet.
-  SmallVector<std::string, 1> BufferedEducationalNotes;
   bool SuppressOutput = false;
 
 #if SWIFT_BUILD_SWIFT_SYNTAX
@@ -65,10 +61,6 @@ class PrintingDiagnosticConsumer : public DiagnosticConsumer {
     llvm::sys::Process::UseANSIEscapeCodes(true);
   }
 
-  void setPrintEducationalNotes(bool ShouldPrint) {
-    PrintEducationalNotes = ShouldPrint;
-  }
-
   void setFormattingStyle(DiagnosticOptions::FormattingStyle style) {
     FormattingStyle = style;
   }

lib/Frontend/CompilerInvocation.cpp

@@ -2562,7 +2562,6 @@ static bool ParseDiagnosticArgs(DiagnosticOptions &Opts, ArgList &Args,
   } else if (Args.hasArg(OPT_print_diagnostic_groups)) {
     Opts.PrintDiagnosticNames = PrintDiagnosticNamesMode::Group;
   }
-  Opts.PrintEducationalNotes |= Args.hasArg(OPT_print_educational_notes);
   if (Arg *A = Args.getLastArg(OPT_diagnostic_documentation_path)) {
     Opts.DiagnosticDocumentationPath = A->getValue();
   }

lib/Frontend/DiagnosticHelper.cpp

@@ -377,9 +377,6 @@ void DiagnosticHelper::Implementation::beginMessage() {
   if (invocation.getDiagnosticOptions().UseColor)
     PDC.forceColors();
 
-  PDC.setPrintEducationalNotes(
-      invocation.getDiagnosticOptions().PrintEducationalNotes);
-
   PDC.setFormattingStyle(
       invocation.getDiagnosticOptions().PrintedFormattingStyle);
 

lib/Frontend/PrintingDiagnosticConsumer.cpp

@@ -22,210 +22,13 @@
 #include "swift/Basic/LLVM.h"
 #include "swift/Basic/SourceManager.h"
 #include "swift/Bridging/ASTGen.h"
-#include "swift/Markup/Markup.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/Twine.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/raw_ostream.h"
 
 using namespace swift;
-using namespace swift::markup;
-
-namespace {
-// MARK: Markdown Printing
-    class TerminalMarkupPrinter : public MarkupASTVisitor<TerminalMarkupPrinter> {
-      llvm::raw_ostream &OS;
-      unsigned Indent;
-      unsigned ShouldBold;
-
-      void indent(unsigned Amount = 2) { Indent += Amount; }
-
-      void dedent(unsigned Amount = 2) {
-        assert(Indent >= Amount && "dedent without matching indent");
-        Indent -= Amount;
-      }
-
-      void bold() {
-        ++ShouldBold;
-        updateFormatting();
-      }
-
-      void unbold() {
-        assert(ShouldBold > 0 && "unbolded without matching bold");
-        --ShouldBold;
-        updateFormatting();
-      }
-
-      void updateFormatting() {
-        OS.resetColor();
-        if (ShouldBold > 0)
-          OS.changeColor(raw_ostream::Colors::SAVEDCOLOR, true);
-      }
-
-      void print(StringRef Str) {
-        for (auto c : Str) {
-          OS << c;
-          if (c == '\n')
-            for (unsigned i = 0; i < Indent; ++i)
-              OS << ' ';
-        }
-      }
-
-    public:
-      TerminalMarkupPrinter(llvm::raw_ostream &OS)
-          : OS(OS), Indent(0), ShouldBold(0) {}
-
-      void printNewline() { print("\n"); }
-
-      void visitDocument(const Document *D) {
-        for (const auto *Child : D->getChildren()) {
-          if (Child->getKind() == markup::ASTNodeKind::Paragraph) {
-            // Add a newline before top-level paragraphs
-            printNewline();
-          }
-          visit(Child);
-        }
-      }
-
-      void visitInlineAttributes(const InlineAttributes *A) {
-        print("^[");
-        for (const auto *Child : A->getChildren())
-          visit(Child);
-        print("](");
-        print(A->getAttributes());
-        print(")");
-      }
-
-      void visitBlockQuote(const BlockQuote *BQ) {
-        indent();
-        printNewline();
-        for (const auto *Child : BQ->getChildren())
-          visit(Child);
-        dedent();
-      }
-
-      void visitList(const List *BL) {
-        indent();
-        printNewline();
-        for (const auto *Child : BL->getChildren())
-          visit(Child);
-        dedent();
-      }
-
-      void visitItem(const Item *I) {
-        print("- ");
-        for (const auto *N : I->getChildren())
-          visit(N);
-      }
-
-      void visitCodeBlock(const CodeBlock *CB) {
-        indent();
-        printNewline();
-        print(CB->getLiteralContent());
-        dedent();
-      }
-
-      void visitCode(const Code *C) {
-        print("'");
-        print(C->getLiteralContent());
-        print("'");
-      }
-
-      void visitHTML(const HTML *H) { print(H->getLiteralContent()); }
-
-      void visitInlineHTML(const InlineHTML *IH) {
-        print(IH->getLiteralContent());
-      }
-
-      void visitSoftBreak(const SoftBreak *SB) { printNewline(); }
-
-      void visitLineBreak(const LineBreak *LB) {
-        printNewline();
-        printNewline();
-      }
-
-      void visitLink(const Link *L) {
-        print("[");
-        for (const auto *Child : L->getChildren())
-          visit(Child);
-        print("](");
-        print(L->getDestination());
-        print(")");
-      }
-
-      void visitImage(const Image *I) { llvm_unreachable("unsupported"); }
-
-      void visitParagraph(const Paragraph *P) {
-        for (const auto *Child : P->getChildren())
-          visit(Child);
-        printNewline();
-      }
-
-      // TODO: add raw_ostream support for italics ANSI codes in LLVM.
-      void visitEmphasis(const Emphasis *E) {
-        for (const auto *Child : E->getChildren())
-          visit(Child);
-      }
-
-      void visitStrong(const Strong *E) {
-        bold();
-        for (const auto *Child : E->getChildren())
-          visit(Child);
-        unbold();
-      }
-
-      void visitHRule(const HRule *HR) {
-        print("--------------");
-        printNewline();
-      }
-
-      void visitHeader(const Header *H) {
-        bold();
-        for (const auto *Child : H->getChildren())
-          visit(Child);
-        unbold();
-        printNewline();
-      }
-
-      void visitText(const Text *T) { print(T->getLiteralContent()); }
-
-      void visitPrivateExtension(const PrivateExtension *PE) {
-        llvm_unreachable("unsupported");
-      }
-
-      void visitParamField(const ParamField *PF) {
-        llvm_unreachable("unsupported");
-      }
-
-      void visitReturnField(const ReturnsField *RF) {
-        llvm_unreachable("unsupported");
-      }
-
-      void visitThrowField(const ThrowsField *TF) {
-        llvm_unreachable("unsupported");
-      }
-
-  #define MARKUP_SIMPLE_FIELD(Id, Keyword, XMLKind)                              \
-    void visit##Id(const Id *Field) { llvm_unreachable("unsupported"); }
-  #include "swift/Markup/SimpleFields.def"
-    };
-
-    static void printMarkdown(StringRef Content, raw_ostream &Out,
-                              bool UseColor) {
-      markup::MarkupContext ctx;
-      auto document = markup::parseDocument(ctx, Content);
-      if (UseColor) {
-        ColoredStream stream{Out};
-        TerminalMarkupPrinter printer(stream);
-        printer.visit(document);
-      } else {
-        NoColorStream stream{Out};
-        TerminalMarkupPrinter printer(stream);
-        printer.visit(document);
-      }
-    }
-} // end anonymous namespace
 
 // MARK: Main DiagnosticConsumer entrypoint.
 void PrintingDiagnosticConsumer::handleDiagnostic(SourceManager &SM,
@@ -261,16 +64,6 @@ void PrintingDiagnosticConsumer::handleDiagnostic(SourceManager &SM,
 
   case DiagnosticOptions::FormattingStyle::LLVM:
     printDiagnostic(SM, Info);
-
-    if (PrintEducationalNotes) {
-      for (auto path : Info.EducationalNotePaths) {
-        if (auto buffer = SM.getFileSystem()->getBufferForFile(path)) {
-          printMarkdown(buffer->get()->getBuffer(), Stream, ForceColors);
-          Stream << "\n";
-        }
-      }
-    }
-
     for (auto ChildInfo : Info.ChildDiagnosticInfo) {
       printDiagnostic(SM, *ChildInfo);
     }
@@ -283,13 +76,6 @@ void PrintingDiagnosticConsumer::flush(bool includeTrailingBreak) {
   DiagBridge.flush(Stream, includeTrailingBreak,
                    /*forceColors=*/ForceColors);
 #endif
-
-  for (auto note : BufferedEducationalNotes) {
-    printMarkdown(note, Stream, ForceColors);
-    Stream << "\n";
-  }
-
-  BufferedEducationalNotes.clear();
 }
 
 bool PrintingDiagnosticConsumer::finishProcessing() {