Skip to content
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

Revamp the PieceWriter API some. #1298

Merged
merged 4 commits into from
Oct 31, 2023
Merged

Revamp the PieceWriter API some. #1298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ac113e
Revamp the PieceWriter API some.
munificent Oct 27, 2023
0cf1e54
Update lib/src/front_end/piece_writer.dart
munificent Oct 27, 2023
d8870cf
Change push()/pop() to give()/take().
munificent Oct 30, 2023
406402f
Merge branch 'main' into revamp-piece-api
munificent Oct 30, 2023
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
116 changes: 53 additions & 63 deletions lib/src/front_end/ast_node_visitor.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,11 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
final LineInfo lineInfo;

@override
final PieceWriter writer;
final PieceWriter pieces;

/// Initialize a newly created visitor to write source code representing
/// the visited nodes to the given [writer].
/// Create a new visitor that will be called to visit the code in [source].
AstNodeVisitor(DartFormatter formatter, this.lineInfo, SourceCode source)
: writer = PieceWriter(formatter, source);
: pieces = PieceWriter(formatter, source);

/// Visits [node] and returns the formatted result.
///
Expand Down Expand Up @@ -86,10 +85,10 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
// Write any comments at the end of the code.
sequence.addCommentsBefore(node.endToken.next!);

writer.push(sequence.build());
pieces.give(sequence.build());

// Finish writing and return the complete result.
return writer.finish();
return pieces.finish();
}

@override
Expand Down Expand Up @@ -130,7 +129,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
@override
void visitAssignmentExpression(AssignmentExpression node) {
visit(node.leftHandSide);
writer.space();
space();
finishAssignment(node.operator, node.rightHandSide);
}

Expand Down Expand Up @@ -219,19 +218,17 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
@override
void visitConditionalExpression(ConditionalExpression node) {
visit(node.condition);
var condition = writer.pop();
writer.split();
var condition = pieces.split();

token(node.question);
writer.space();
space();
visit(node.thenExpression);
var thenBranch = writer.pop();
writer.split();
var thenBranch = pieces.split();

token(node.colon);
writer.space();
space();
visit(node.elseExpression);
var elseBranch = writer.pop();
var elseBranch = pieces.take();

var piece = InfixPiece([condition, thenBranch, elseBranch]);

Expand All @@ -243,13 +240,13 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
piece.pin(State.split);
}

writer.push(piece);
pieces.give(piece);
}

@override
void visitConfiguration(Configuration node) {
token(node.ifKeyword);
writer.space();
space();
token(node.leftParenthesis);

if (node.equalToken case var equals?) {
Expand All @@ -259,7 +256,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
}

token(node.rightParenthesis);
writer.space();
space();
visit(node.uri);
}

Expand Down Expand Up @@ -311,20 +308,19 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
@override
void visitDoStatement(DoStatement node) {
token(node.doKeyword);
writer.space();
space();
visit(node.body);
writer.space();
space();
token(node.whileKeyword);
var body = writer.pop();
writer.split();
var body = pieces.split();

token(node.leftParenthesis);
visit(node.condition);
token(node.rightParenthesis);
token(node.semicolon);
var condition = writer.pop();
var condition = pieces.take();

writer.push(DoWhilePiece(body, condition));
pieces.give(DoWhilePiece(body, condition));
}

@override
Expand Down Expand Up @@ -417,7 +413,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
}

builder.rightBracket(node.rightParenthesis, delimiter: node.rightDelimiter);
writer.push(builder.build());
pieces.give(builder.build());
}

@override
Expand All @@ -428,8 +424,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
@override
void visitForStatement(ForStatement node) {
token(node.forKeyword);
writer.split();
var forKeyword = writer.pop();
var forKeyword = pieces.split();

// Treat the for loop parts sort of as an argument list where each clause
// is a separate argument. This means that when they split, they split like:
Expand Down Expand Up @@ -485,13 +480,13 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
}

partsList.rightBracket(node.rightParenthesis);
writer.split();
var forPartsPiece = partsList.build();

pieces.split();
visit(node.body);
var body = writer.pop();
var body = pieces.take();

writer.push(ForPiece(forKeyword, forPartsPiece, body,
pieces.give(ForPiece(forKeyword, forPartsPiece, body,
hasBlockBody: node.body is Block));
}

Expand Down Expand Up @@ -649,14 +644,14 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
}

sequence.visit(node.statement);
writer.push(sequence.build());
pieces.give(sequence.build());
}

@override
void visitLibraryDirective(LibraryDirective node) {
createDirectiveMetadata(node);
token(node.libraryKeyword);
visit(node.name2, before: writer.space);
visit(node.name2, before: space);
token(node.semicolon);
}

Expand Down Expand Up @@ -794,7 +789,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
void visitPartDirective(PartDirective node) {
createDirectiveMetadata(node);
token(node.partKeyword);
writer.space();
space();
visit(node.uri);
token(node.semicolon);
}
Expand All @@ -803,9 +798,9 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
void visitPartOfDirective(PartOfDirective node) {
createDirectiveMetadata(node);
token(node.partKeyword);
writer.space();
space();
token(node.ofKeyword);
writer.space();
space();

// Part-of may have either a name or a URI. Only one of these will be
// non-null. We visit both since visit() ignores null.
Expand Down Expand Up @@ -908,7 +903,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
token(node.returnKeyword);

if (node.expression case var expression) {
writer.space();
space();
visit(expression);
}

Expand All @@ -922,7 +917,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
// come at the top of the file, we don't have to worry about preceding
// comments or whitespace.
// TODO(new-ir): Update selection if inside the script tag.
writer.write(node.scriptTag.lexeme.trim());
pieces.write(node.scriptTag.lexeme.trim());
}

@override
Expand All @@ -948,14 +943,12 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
if ((node.type, node.name) case (var type?, var name?)) {
// Have both a type and name, so allow splitting between them.
visit(type);
var typePiece = writer.pop();
writer.split();
var typePiece = pieces.split();

token(name);
var namePiece = writer.pop();
writer.split();
var namePiece = pieces.take();

writer.push(VariablePiece(typePiece, [namePiece], hasType: true));
pieces.give(VariablePiece(typePiece, [namePiece], hasType: true));
} else {
// Only one of name or type so just write whichever there is.
visit(node.type);
Expand Down Expand Up @@ -1005,23 +998,23 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>

createSwitchValue(node.switchKeyword, node.leftParenthesis, node.expression,
node.rightParenthesis);
writer.space();
space();
list.leftBracket(node.leftBracket);

for (var member in node.cases) {
list.visit(member);
}

list.rightBracket(node.rightBracket);
writer.push(list.build());
pieces.give(list.build());
}

@override
void visitSwitchExpressionCase(SwitchExpressionCase node) {
if (node.guardedPattern.whenClause != null) throw UnimplementedError();

visit(node.guardedPattern.pattern);
writer.space();
space();
finishAssignment(node.arrow, node.expression);
}

Expand All @@ -1032,10 +1025,9 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>

// Attach the ` {` after the `)` in the [ListPiece] created by
// [createSwitchValue()].
writer.space();
space();
token(node.leftBracket);
writer.split();
var switchPiece = writer.pop();
var switchPiece = pieces.split();

var sequence = SequenceBuilder(this);
for (var member in node.members) {
Expand All @@ -1047,10 +1039,10 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
token(member.keyword);

if (member is SwitchCase) {
writer.space();
space();
visit(member.expression);
} else if (member is SwitchPatternCase) {
writer.space();
space();

if (member.guardedPattern.whenClause != null) {
throw UnimplementedError();
Expand All @@ -1063,8 +1055,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
}

token(member.colon);
var casePiece = writer.pop();
writer.split();
var casePiece = pieces.split();

// Don't allow any blank lines between the `case` line and the first
// statement in the case (or the next case if this case has no body).
Expand All @@ -1079,9 +1070,9 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
sequence.addCommentsBefore(node.rightBracket);

token(node.rightBracket);
var rightBracketPiece = writer.pop();
var rightBracketPiece = pieces.take();

writer.push(BlockPiece(switchPiece, sequence.build(), rightBracketPiece,
pieces.give(BlockPiece(switchPiece, sequence.build(), rightBracketPiece,
alwaysSplit: node.members.isNotEmpty));
}

Expand Down Expand Up @@ -1126,7 +1117,7 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
void visitTypeParameter(TypeParameter node) {
token(node.name);
if (node.bound case var bound?) {
writer.space();
space();
modifier(node.extendsKeyword);
visit(bound);
}
Expand Down Expand Up @@ -1157,17 +1148,17 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
// argument list or a function type's parameter list) affect the indentation
// and splitting of the surrounding variable declaration.
visit(node.type);
var header = writer.pop();
var header = pieces.take();

var variables = <Piece>[];
for (var variable in node.variables) {
writer.split();
pieces.split();
visit(variable);
commaAfter(variable);
variables.add(writer.pop());
variables.add(pieces.take());
}

writer.push(VariablePiece(header, variables, hasType: node.type != null));
pieces.give(VariablePiece(header, variables, hasType: node.type != null));
}

@override
Expand All @@ -1179,19 +1170,18 @@ class AstNodeVisitor extends ThrowingAstVisitor<void>
@override
void visitWhileStatement(WhileStatement node) {
token(node.whileKeyword);
writer.space();
space();
token(node.leftParenthesis);
visit(node.condition);
token(node.rightParenthesis);
var condition = writer.pop();
writer.split();
var condition = pieces.split();

visit(node.body);
var body = writer.pop();
var body = pieces.take();

var piece = IfPiece();
piece.add(condition, body, isBlock: node.body is Block);
writer.push(piece);
pieces.give(piece);
}

@override
Expand Down
14 changes: 7 additions & 7 deletions lib/src/front_end/comment_writer.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ import 'piece_writer.dart';
// TODO(tall): When argument lists and their comment handling is supported,
// mention that here.
mixin CommentWriter {
PieceWriter get writer;
PieceWriter get pieces;

LineInfo get lineInfo;

Expand Down Expand Up @@ -78,20 +78,20 @@ mixin CommentWriter {

if (comments.isHanging(i)) {
// Attach the comment to the previous token.
writer.space();
writer.writeComment(comment, hanging: true);
pieces.writeSpace();
pieces.writeComment(comment, hanging: true);
} else {
writer.writeNewline();
writer.writeComment(comment);
pieces.writeNewline();
pieces.writeComment(comment);
}

if (comment.type == CommentType.line || comment.type == CommentType.doc) {
writer.writeNewline();
pieces.writeNewline();
}
}

if (comments.isNotEmpty && _needsSpaceAfterComment(token.lexeme)) {
writer.space();
pieces.writeSpace();
}
}

Expand Down
Loading