Skip to content

Commit 111e84b

Browse files
stereotype441Commit Queue
authored andcommitted
Rename CFE DiagnosticMessage class.
The analyzer already has a class with the same name, but a slightly different purpose. (The analyzer's class represents a single message associated with a source location, whereas the CFE's class represents a message along with related context messages). I'm currently embarking on an arc of work that I hope will eventually culminate in unifying the analyzer and CFE diagnostic message representations into a single set of classes. Until that unification is complete, both representations will have to co-exist in the `_fe_analyzer_shared` package. To reduce confusion during that time period, I would like the classes to have distinct names. Since the analyzer's `DiagnosticMessage` class is exposed through the analyzer public API, analyzer clients may depend on the name. So it makes sense to rename the CFE's `DiagnosticMessage` class. Tested: standard trybots Change-Id: I6b6948fe9da18c7b6688333fa12ffeea8e81436f Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/441831 Reviewed-by: Alexander Markov <[email protected]> Reviewed-by: Ömer Ağacan <[email protected]> Reviewed-by: Nicholas Shahan <[email protected]> Commit-Queue: Paul Berry <[email protected]> Reviewed-by: Johnni Winther <[email protected]>
1 parent c237ac8 commit 111e84b

File tree

67 files changed

+193
-185
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+193
-185
lines changed

pkg/_fe_analyzer_shared/lib/src/messages/codes.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ library _fe_analyzer_shared.messages.codes;
66

77
import 'dart:convert' show JsonEncoder, json;
88

9-
import 'diagnostic_message.dart' show DiagnosticMessage;
9+
import 'diagnostic_message.dart' show CfeDiagnosticMessage;
1010

1111
import '../scanner/token.dart' show Token;
1212

@@ -215,7 +215,7 @@ class PlainAndColorizedString {
215215
const PlainAndColorizedString.plainOnly(this.plain) : this.colorized = plain;
216216
}
217217

218-
class FormattedMessage implements DiagnosticMessage {
218+
class FormattedMessage implements CfeDiagnosticMessage {
219219
final LocatedMessage locatedMessage;
220220

221221
final String formattedPlain;
@@ -300,7 +300,7 @@ class FormattedMessage implements DiagnosticMessage {
300300
}
301301
}
302302

303-
class DiagnosticMessageFromJson implements DiagnosticMessage {
303+
class DiagnosticMessageFromJson implements CfeDiagnosticMessage {
304304
@override
305305
final Iterable<String> ansiFormatted;
306306

pkg/_fe_analyzer_shared/lib/src/messages/diagnostic_message.dart

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import 'severity.dart' show Severity;
1717
/// message.plainTextFormatted.forEach(stderr.writeln);
1818
/// }
1919
/// }
20-
typedef DiagnosticMessageHandler = void Function(DiagnosticMessage);
20+
typedef DiagnosticMessageHandler = void Function(CfeDiagnosticMessage);
2121

2222
/// Represents a diagnostic message that can be reported from a tool, for
2323
/// example, a compiler.
@@ -26,8 +26,8 @@ typedef DiagnosticMessageHandler = void Function(DiagnosticMessage);
2626
/// reporting any kind of message, including non-diagnostic messages such as
2727
/// licensing, informal, or logging information. This allows a well-behaved
2828
/// tool to never directly write to stdout or stderr.
29-
abstract class DiagnosticMessage {
30-
DiagnosticMessage._(); // Prevent subclassing.
29+
abstract class CfeDiagnosticMessage {
30+
CfeDiagnosticMessage._(); // Prevent subclassing.
3131

3232
Iterable<String> get ansiFormatted;
3333

@@ -41,7 +41,7 @@ abstract class DiagnosticMessage {
4141
}
4242

4343
/// This method is subject to change.
44-
Uri? getMessageUri(DiagnosticMessage message) {
44+
Uri? getMessageUri(CfeDiagnosticMessage message) {
4545
return message is FormattedMessage
4646
? message.uri
4747
: message is DiagnosticMessageFromJson
@@ -50,38 +50,38 @@ Uri? getMessageUri(DiagnosticMessage message) {
5050
}
5151

5252
/// This method is subject to change.
53-
int? getMessageCharOffset(DiagnosticMessage message) {
53+
int? getMessageCharOffset(CfeDiagnosticMessage message) {
5454
return message is FormattedMessage ? message.charOffset : null;
5555
}
5656

5757
/// This method is subject to change.
58-
int? getMessageLength(DiagnosticMessage message) {
58+
int? getMessageLength(CfeDiagnosticMessage message) {
5959
return message is FormattedMessage ? message.length : null;
6060
}
6161

6262
/// This method is subject to change.
63-
Code? getMessageCodeObject(DiagnosticMessage message) {
63+
Code? getMessageCodeObject(CfeDiagnosticMessage message) {
6464
return message is FormattedMessage ? message.code : null;
6565
}
6666

6767
/// This method is subject to change.
68-
String? getMessageHeaderText(DiagnosticMessage message) {
68+
String? getMessageHeaderText(CfeDiagnosticMessage message) {
6969
return message is FormattedMessage ? message.problemMessage : null;
7070
}
7171

7272
/// This method is subject to change.
73-
int getMessageCode(DiagnosticMessage message) {
73+
int getMessageCode(CfeDiagnosticMessage message) {
7474
return message is FormattedMessage ? message.code.index : -1;
7575
}
7676

7777
/// This method is subject to change.
78-
Map<String, dynamic>? getMessageArguments(DiagnosticMessage message) {
78+
Map<String, dynamic>? getMessageArguments(CfeDiagnosticMessage message) {
7979
return message is FormattedMessage ? message.arguments : null;
8080
}
8181

8282
/// This method is subject to change.
83-
Iterable<DiagnosticMessage>? getMessageRelatedInformation(
84-
DiagnosticMessage message,
83+
Iterable<CfeDiagnosticMessage>? getMessageRelatedInformation(
84+
CfeDiagnosticMessage message,
8585
) {
8686
return message is FormattedMessage ? message.relatedInformation : null;
8787
}

pkg/compiler/lib/src/kernel/front_end_adapter.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ class _CompilerFileSystemEntity implements fe.FileSystemEntity {
9393
/// [DiagnosticReporter].
9494
void reportFrontEndMessage(
9595
DiagnosticReporter reporter,
96-
fe.DiagnosticMessage message,
96+
fe.CfeDiagnosticMessage message,
9797
) {
98-
Spannable getSpannable(fe.DiagnosticMessage message) {
98+
Spannable getSpannable(fe.CfeDiagnosticMessage message) {
9999
Uri? uri = fe.getMessageUri(message);
100100
int offset = fe.getMessageCharOffset(message)!;
101101
int length = fe.getMessageLength(message)!;
@@ -106,15 +106,15 @@ void reportFrontEndMessage(
106106
}
107107
}
108108

109-
DiagnosticMessage convertMessage(fe.DiagnosticMessage message) {
109+
DiagnosticMessage convertMessage(fe.CfeDiagnosticMessage message) {
110110
Spannable span = getSpannable(message);
111111
String? text = fe.getMessageHeaderText(message);
112112
return reporter.createMessage(span, MessageKind.generic, {
113113
'text': text ?? '',
114114
});
115115
}
116116

117-
Iterable<fe.DiagnosticMessage>? relatedInformation = fe
117+
Iterable<fe.CfeDiagnosticMessage>? relatedInformation = fe
118118
.getMessageRelatedInformation(message);
119119
DiagnosticMessage mainMessage = convertMessage(message);
120120
List<DiagnosticMessage> infos = relatedInformation != null

pkg/compiler/lib/src/phase/load_kernel.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ Future<_LoadFromSourceResult> _loadFromSource(
275275
);
276276
fe.FileSystem fileSystem = CompilerFileSystem(compilerInput);
277277
fe.Verbosity verbosity = options.verbosity;
278-
void onDiagnostic(fe.DiagnosticMessage message) {
278+
void onDiagnostic(fe.CfeDiagnosticMessage message) {
279279
if (fe.Verbosity.shouldPrint(verbosity, message)) {
280280
reportFrontEndMessage(reporter, message);
281281
}

pkg/compiler/test/end_to_end/no_platform_test.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ main() {
2828
initializedCompilerState,
2929
false,
3030
fe.StandardFileSystem.instance,
31-
(fe.DiagnosticMessage message) {
31+
(fe.CfeDiagnosticMessage message) {
3232
message.plainTextFormatted.forEach(print);
3333
Expect.notEquals(fe.Severity.error, message.severity);
3434
},

pkg/dart2bytecode/lib/dart2bytecode.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import 'package:front_end/src/api_unstable/vm.dart'
1010
show
1111
CompilerOptions,
1212
InvocationMode,
13-
DiagnosticMessage,
13+
CfeDiagnosticMessage,
1414
Verbosity,
1515
parseExperimentalArguments,
1616
parseExperimentalFlags,
@@ -219,7 +219,7 @@ Future<int> runCompilerWithOptions({
219219
..explicitExperimentalFlags = parseExperimentalFlags(
220220
parseExperimentalArguments(experimentalFlags),
221221
onError: printMessage)
222-
..onDiagnostic = (DiagnosticMessage m) {
222+
..onDiagnostic = (CfeDiagnosticMessage m) {
223223
errorDetector(m);
224224
}
225225
..embedSourceText = false

pkg/dart2bytecode/test/bytecode_generator_test.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import 'package:front_end/src/api_unstable/vm.dart'
1515
show
1616
CompilerOptions,
1717
computePlatformBinariesLocation,
18-
DiagnosticMessage,
18+
CfeDiagnosticMessage,
1919
kernelForProgram;
2020
import 'package:kernel/ast.dart';
2121
import 'package:kernel/core_types.dart';
@@ -65,7 +65,7 @@ Future<Component> compileTestCaseToKernelProgram(Uri sourceUri,
6565
..target = target
6666
..additionalDills = <Uri>[platformKernel]
6767
..environmentDefines = {}
68-
..onDiagnostic = (DiagnosticMessage message) {
68+
..onDiagnostic = (CfeDiagnosticMessage message) {
6969
fail("Compilation error: ${message.plainTextFormatted.join('\n')}");
7070
};
7171

pkg/dart2wasm/lib/compile.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import 'package:front_end/src/api_unstable/vm.dart'
1212
show
1313
CompilerOptions,
1414
CompilerResult,
15-
DiagnosticMessage,
15+
CfeDiagnosticMessage,
1616
kernelForProgram,
1717
Severity;
1818
import 'package:kernel/ast.dart';
@@ -128,10 +128,10 @@ Future<CompilationResult> compileToModule(
128128
compiler.WasmCompilerOptions options,
129129
FileSystem fileSystem,
130130
Uri Function(String moduleName)? sourceMapUrlGenerator,
131-
void Function(DiagnosticMessage) handleDiagnosticMessage,
131+
void Function(CfeDiagnosticMessage) handleDiagnosticMessage,
132132
{void Function(String, String)? writeFile}) async {
133133
var hadCompileTimeError = false;
134-
void diagnosticMessageHandler(DiagnosticMessage message) {
134+
void diagnosticMessageHandler(CfeDiagnosticMessage message) {
135135
if (message.severity == Severity.error) {
136136
hadCompileTimeError = true;
137137
}

pkg/dev_compiler/lib/src/command/command.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Future<CompilerResult> _compile(
255255
argResults['packages'] as String? ?? _findPackagesFilePath();
256256

257257
var succeeded = true;
258-
void diagnosticMessageHandler(fe.DiagnosticMessage message) {
258+
void diagnosticMessageHandler(fe.CfeDiagnosticMessage message) {
259259
if (message.severity == fe.Severity.error) {
260260
succeeded = false;
261261
}

pkg/dev_compiler/lib/src/kernel/expression_compiler.dart

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import 'dart:async';
77
import 'package:_fe_analyzer_shared/src/messages/codes.dart'
88
show Code, Message, PlainAndColorizedString;
99
import 'package:_fe_analyzer_shared/src/messages/diagnostic_message.dart'
10-
show DiagnosticMessage, DiagnosticMessageHandler;
10+
show CfeDiagnosticMessage, DiagnosticMessageHandler;
1111
import 'package:front_end/src/api_unstable/ddc.dart';
1212
import 'package:kernel/ast.dart' show Component, Library;
1313
import 'package:kernel/dart_scope_calculator.dart';
@@ -17,7 +17,12 @@ import '../compiler/module_builder.dart';
1717
import '../js_ast/js_ast.dart' as js_ast;
1818
import 'compiler.dart' show Compiler;
1919

20-
DiagnosticMessage _createInternalError(Uri uri, int line, int col, String msg) {
20+
CfeDiagnosticMessage _createInternalError(
21+
Uri uri,
22+
int line,
23+
int col,
24+
String msg,
25+
) {
2126
return Message(
2227
Code('Expression Compiler Internal error'),
2328
problemMessage: msg,

0 commit comments

Comments
 (0)