update the generator to emit formatted files #1020
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ | |
|
|
||
| import 'dart:collection'; | ||
|
|
||
| import 'src/formatter.dart' as formatter; | ||
| import 'src/gen/google/protobuf/descriptor.pb.dart'; | ||
|
|
||
| /// Specifies code locations where metadata annotations should be attached and | ||
|
|
@@ -13,14 +14,18 @@ class NamedLocation { | |
| final List<int> fieldPathSegment; | ||
| final int start; | ||
|
|
||
| NamedLocation({ | ||
| required this.name, | ||
| required this.fieldPathSegment, | ||
| required this.start, | ||
| }); | ||
| } | ||
|
|
||
| /// A buffer for writing indented source code. | ||
| class IndentingWriter { | ||
| final String? fileName; | ||
| final bool generateMetadata; | ||
|
|
||
| final StringBuffer _buffer = StringBuffer(); | ||
| final GeneratedCodeInfo sourceLocationInfo = GeneratedCodeInfo(); | ||
|
|
||
|
|
@@ -29,12 +34,14 @@ class IndentingWriter { | |
| // After writing any chunk, _previousOffset is the size of everything that was | ||
| // written to the buffer before the latest call to print or addBlock. | ||
| int _previousOffset = 0; | ||
|
|
||
| // Named text sections to write at the end of the file. | ||
| final Map<String, String> _suffixes = SplayTreeMap(); | ||
|
|
||
| IndentingWriter({ | ||
| this.fileName, | ||
| this.generateMetadata = false, | ||
| }); | ||
|
|
||
| /// Appends a string indented to the current level. | ||
| /// (Indentation will be added after newline characters where needed.) | ||
|
|
@@ -118,18 +125,27 @@ class IndentingWriter { | |
| _suffixes[suffixKey] = text; | ||
| } | ||
|
|
||
| /// Emit the generated source. | ||
| /// | ||
| /// This is safe to call multiple times. | ||
| String emitSource({required bool format}) { | ||
| if (_suffixes.isNotEmpty) { | ||
| println(''); | ||
| for (final key in _suffixes.keys) { | ||
| println(_suffixes[key]!); | ||
| } | ||
| _suffixes.clear(); | ||
| } | ||
|
|
||
| var source = _buffer.toString(); | ||
|
|
||
| // We don't always want to format the source (for example, we don't want to | ||
|
Collaborator
There was a problem hiding this comment. This is an interesting problem. It would be cool if we had some way of "anchoring" the annotated locations in the source. Something like https://gcc.gnu.org/onlinedocs/cpp/Line-Control.html#Line-Control-1 ... @lrhn wdyt?
Contributor
Author
There was a problem hiding this comment. Hmm, I think that would be interesting. I have in the past (when absolutely necessary) 'recovered' locations post format by:
Separately, I think this location annotation code only exists for generating files used by kythe. I don't know if those are used anymore? Kythe has a dart parser, so not sure why we need to generate separate symbol location files for it. 🤷
Collaborator
There was a problem hiding this comment. I believe these are for references from .proto files to the generated code. Not sure a dart parser works directly here. (but perhaps via symbol names...) |
||
| // format if we're creating annotated locations of source elements). | ||
| if (format) { | ||
| source = formatter.format(source); | ||
| } | ||
|
|
||
| return source; | ||
| } | ||
|
|
||
| /// Writes part of a line of text. | ||
|
|
@@ -155,15 +171,14 @@ class IndentingWriter { | |
| /// string that was passed to the previous [print]. Name should be the string | ||
| /// that was written to file. | ||
| void _addAnnotation(List<int> fieldPath, String name, int start) { | ||
| if (generateMetadata) { | ||
| final annotation = GeneratedCodeInfo_Annotation() | ||
| ..path.addAll(fieldPath) | ||
| ..sourceFile = fileName! | ||
| ..begin = _previousOffset + start | ||
| ..end = _previousOffset + start + name.length; | ||
| sourceLocationInfo.annotation.add(annotation); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| // Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file | ||
| // for details. All rights reserved. Use of this source code is governed by a | ||
| // BSD-style license that can be found in the LICENSE file. | ||
|
|
||
| import 'package:dart_style/dart_style.dart'; | ||
| import 'package:pub_semver/pub_semver.dart'; | ||
|
|
||
| // Note: keep this in sync with the SDK constraint in pubspec.yaml. | ||
| final Version formatUsingVersion = Version(3, 6, 0); | ||
|
|
||
| final DartFormatter _formatter = | ||
| DartFormatter(languageVersion: formatUsingVersion); | ||
|
|
||
| /// Return the Dart formatted version of the given source. | ||
| String format(String source) => _formatter.format(source); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.