Skip to content

libSyntax: when printing syntax tree with kind, optionally give syntax kind a visual highlight. #12552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 21, 2017
Merged

libSyntax: when printing syntax tree with kind, optionally give syntax kind a visual highlight. #12552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions include/swift/Syntax/RawSyntax.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ enum class SourcePresence {

/// The print option to specify when printing a raw syntax node.
struct SyntaxPrintOptions {
bool Visual = false;
bool PrintSyntaxKind = false;
};

Expand Down
23 changes: 17 additions & 6 deletions lib/Syntax/RawSyntax.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
//
//===----------------------------------------------------------------------===//

#include "swift/Basic/ColorUtils.h"
#include "swift/Syntax/RawSyntax.h"
#include "swift/Syntax/TokenSyntax.h"
#include "llvm/Support/Casting.h"
Expand All @@ -33,14 +34,26 @@ static bool isTrivialSyntaxKind(SyntaxKind Kind) {
return false;
}
}

static void printSyntaxKind(SyntaxKind Kind, llvm::raw_ostream &OS,
SyntaxPrintOptions Opts, bool Open) {
std::unique_ptr<swift::OSColor> Color;
if (Opts.Visual) {
Color.reset(new swift::OSColor(OS, llvm::raw_ostream::GREEN));
}
OS << "<";
if (!Open)
OS << "/";
dumpSyntaxKind(OS, Kind);
OS << ">";
}

} // end of anonymous namespace
void RawSyntax::print(llvm::raw_ostream &OS, SyntaxPrintOptions Opts) const {
const bool PrintKind = Opts.PrintSyntaxKind && !isToken() &&
!isTrivialSyntaxKind(Kind);
if (PrintKind) {
OS << "<";
dumpSyntaxKind(OS, Kind);
OS << ">";
printSyntaxKind(Kind, OS, Opts, true);
}

if (const auto Tok = dyn_cast<RawTokenSyntax>(this)) {
Expand All @@ -51,9 +64,7 @@ void RawSyntax::print(llvm::raw_ostream &OS, SyntaxPrintOptions Opts) const {
LE->print(OS, Opts);
}
if (PrintKind) {
OS << "</";
dumpSyntaxKind(OS, Kind);
OS << ">";
printSyntaxKind(Kind, OS, Opts, false);
}
}

Expand Down
6 changes: 6 additions & 0 deletions tools/swift-syntax-test/swift-syntax-test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ PrintNodeKind("print-node-kind",
llvm::cl::desc("To print syntax node kind"),
llvm::cl::cat(Category),
llvm::cl::init(false));
static llvm::cl::opt<bool>
Visual("v",
llvm::cl::desc("Print visually"),
llvm::cl::cat(Category),
llvm::cl::init(false));
} // end namespace options

namespace {
Expand Down Expand Up @@ -283,6 +288,7 @@ int dumpParserGen(const char *MainExecutablePath,
SourceFile *SF = getSourceFile(Instance, InputFileName, MainExecutablePath);
SyntaxPrintOptions Opts;
Opts.PrintSyntaxKind = options::PrintNodeKind;
Opts.Visual = options::Visual;
SF->getSyntaxRoot().print(llvm::outs(), Opts);
return 0;
}
Expand Down