Skip to content

Commit 78c2181

Browse files
srawlinsCommit Queue
srawlins
authored and
Commit Queue
committed
analysis_server_plugin: Check-in the current api.txt file
Change-Id: Ia88f755e6b92559ad15aa53ec612d92597fb0dc3 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/428928 Reviewed-by: Paul Berry <[email protected]> Commit-Queue: Samuel Rawlins <[email protected]>
1 parent d5f4b8f commit 78c2181

File tree

6 files changed

+267
-5
lines changed

6 files changed

+267
-5
lines changed

‎pkg/analysis_server_plugin/api.txt‎

Lines changed: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
package:analysis_server_plugin/edit/assist/assist.dart:
2+
Assist (class extends Object):
3+
compareAssists (static method: int Function(Assist, Assist))
4+
new (constructor: Assist Function(AssistKind, SourceChange))
5+
change (getter: SourceChange)
6+
kind (getter: AssistKind)
7+
toString (method: String Function())
8+
package:analysis_server_plugin/edit/assist/dart_assist_context.dart:
9+
DartAssistContext (class extends Object):
10+
new (constructor: DartAssistContext Function(InstrumentationService, ChangeWorkspace, ResolvedLibraryResult, ResolvedUnitResult, int, int))
11+
instrumentationService (getter: InstrumentationService)
12+
libraryResult (getter: ResolvedLibraryResult)
13+
selectionLength (getter: int)
14+
selectionOffset (getter: int)
15+
unitResult (getter: ResolvedUnitResult)
16+
workspace (getter: ChangeWorkspace)
17+
package:analysis_server_plugin/edit/correction_utils.dart:
18+
CorrectionUtils (class extends Object):
19+
new (constructor: CorrectionUtils Function(ParsedUnitResult))
20+
endOfLine (getter: String)
21+
oneIndent (getter: String)
22+
twoIndents (getter: String)
23+
findNode (method: AstNode? Function(int))
24+
getLineContentEnd (method: int Function(int))
25+
getLineContentStart (method: int Function(int))
26+
getLineNext (method: int Function(int))
27+
getLinePrefix (method: String Function(int))
28+
getLineThis (method: int Function(int))
29+
getLinesRange (method: SourceRange Function(SourceRange, {bool skipLeadingEmptyLines}))
30+
getLinesRangeStatements (method: SourceRange Function(List<Statement>))
31+
getNodePrefix (method: String Function(AstNode))
32+
getNodeText (method: String Function(AstNode, {bool withLeadingComments}))
33+
getPrefix (method: String Function(int))
34+
getRangeText (method: String Function(SourceRange))
35+
getText (method: String Function(int, int))
36+
indentSourceLeftRight (method: String Function(String, {bool indentLeft}))
37+
invertCondition (method: String Function(Expression))
38+
replaceSourceIndent (method: String Function(String, String, String, {bool ensureTrailingNewline, bool includeLeading}))
39+
replaceSourceRangeIndent (method: String Function(SourceRange, String, String, {bool ensureTrailingNewline, bool includeLeading}))
40+
TokenUtils (class extends Object):
41+
getTokens (static method: List<Token> Function(String, FeatureSet))
42+
new (constructor: TokenUtils Function())
43+
package:analysis_server_plugin/edit/dart/correction_producer.dart:
44+
CorrectionApplicability (enum):
45+
acrossFiles (static getter: CorrectionApplicability)
46+
acrossSingleFile (static getter: CorrectionApplicability)
47+
automatically (static getter: CorrectionApplicability)
48+
automaticallyButOncePerFile (static getter: CorrectionApplicability)
49+
singleLocation (static getter: CorrectionApplicability)
50+
values (static getter: List<CorrectionApplicability>)
51+
CorrectionProducer (class<T extends ParsedUnitResult> extends _AbstractCorrectionProducer<T>, sealed (immediate subtypes: ParsedCorrectionProducer, ResolvedCorrectionProducer)):
52+
applicability (getter: CorrectionApplicability)
53+
assistArguments (getter: List<String>?)
54+
assistKind (getter: AssistKind?)
55+
canBeAppliedAcrossFiles (getter: bool)
56+
canBeAppliedAcrossSingleFile (getter: bool)
57+
canBeAppliedAutomatically (getter: bool)
58+
coveringNode (getter: AstNode?)
59+
errorLength (getter: int?)
60+
errorOffset (getter: int?)
61+
fixArguments (getter: List<String>?)
62+
fixKind (getter: FixKind?)
63+
multiFixArguments (getter: List<String>?)
64+
multiFixKind (getter: FixKind?)
65+
compute (method: Future<void> Function(ChangeBuilder))
66+
CorrectionProducerContext (class extends Object):
67+
createParsed (static method: CorrectionProducerContext Function({bool applyingBulkFixes, DartFixContext? dartFixContext, Diagnostic? diagnostic, required ParsedLibraryResult libraryResult, int selectionLength, int selectionOffset, required ParsedUnitResult unitResult}))
68+
createResolved (static method: CorrectionProducerContext Function({bool applyingBulkFixes, DartFixContext? dartFixContext, Diagnostic? diagnostic, required ResolvedLibraryResult libraryResult, int selectionLength, int selectionOffset, required ResolvedUnitResult unitResult}))
69+
dartFixContext (getter: DartFixContext?)
70+
node (getter: AstNode)
71+
path (getter: String)
72+
CorrectionProducerWithDiagnostic (class extends ResolvedCorrectionProducer):
73+
new (constructor: CorrectionProducerWithDiagnostic Function({required CorrectionProducerContext context}))
74+
diagnostic (getter: Diagnostic)
75+
MultiCorrectionProducer (class extends _AbstractCorrectionProducer<ResolvedUnitResult>):
76+
new (constructor: MultiCorrectionProducer Function({required CorrectionProducerContext context}))
77+
context (getter: CorrectionProducerContext)
78+
libraryElement2 (getter: LibraryElement)
79+
libraryResult (getter: ResolvedLibraryResult)
80+
producers (getter: Future<List<ResolvedCorrectionProducer>>)
81+
unitResult (getter: ResolvedUnitResult)
82+
ParsedCorrectionProducer (class extends CorrectionProducer<ParsedUnitResult>):
83+
new (constructor: ParsedCorrectionProducer Function({required CorrectionProducerContext context}))
84+
ResolvedCorrectionProducer (class extends CorrectionProducer<ResolvedUnitResult>):
85+
new (constructor: ResolvedCorrectionProducer Function({required CorrectionProducerContext context}))
86+
analysisOptions (getter: AnalysisOptions)
87+
inStaticContext (getter: bool)
88+
inheritanceManager (getter: InheritanceManager3)
89+
libraryElement2 (getter: LibraryElement)
90+
libraryResult (getter: ResolvedLibraryResult)
91+
typeProvider (getter: TypeProvider)
92+
typeSystem (getter: TypeSystem)
93+
unitResult (getter: ResolvedUnitResult)
94+
getClassDeclaration (method: Future<ClassDeclaration?> Function(ClassFragment))
95+
getEnumDeclaration (method: Future<EnumDeclaration?> Function(EnumFragment))
96+
getExtensionDeclaration (method: Future<ExtensionDeclaration?> Function(ExtensionFragment))
97+
getExtensionTypeDeclaration (method: Future<ExtensionTypeDeclaration?> Function(ExtensionTypeFragment))
98+
getMixinDeclaration (method: Future<MixinDeclaration?> Function(MixinFragment))
99+
getTargetInterfaceElement (method: InterfaceElement? Function(Expression))
100+
inferUndefinedExpressionType (method: DartType? Function(Expression))
101+
isEnabled (method: bool Function(Feature))
102+
StubCorrectionProducerContext (class extends Object implements CorrectionProducerContext):
103+
instance (static getter: StubCorrectionProducerContext)
104+
noSuchMethod (method: dynamic Function(Invocation))
105+
_AbstractCorrectionProducer (non-public)
106+
package:analysis_server_plugin/edit/dart/dart_fix_kind_priority.dart:
107+
DartFixKindPriority (class extends Object):
108+
ignore (static getter: int)
109+
inFile (static getter: int)
110+
standard (static getter: int)
111+
package:analysis_server_plugin/edit/fix/dart_fix_context.dart:
112+
DartFixContext (class extends Object implements FixContext):
113+
new (constructor: DartFixContext Function({bool autoTriggered, CorrectionUtils? correctionUtils, required Diagnostic error, required InstrumentationService instrumentationService, required ResolvedLibraryResult libraryResult, required ResolvedUnitResult unitResult, required ChangeWorkspace workspace}))
114+
autoTriggered (getter: bool)
115+
correctionUtils (getter: CorrectionUtils)
116+
error (getter: Diagnostic)
117+
instrumentationService (getter: InstrumentationService)
118+
libraryResult (getter: ResolvedLibraryResult)
119+
unitResult (getter: ResolvedUnitResult)
120+
workspace (getter: ChangeWorkspace)
121+
getTopLevelDeclarations (method: Future<Map<LibraryElement, Element>> Function(String))
122+
librariesWithExtensions (method: Stream<LibraryElement> Function(Name))
123+
package:analysis_server_plugin/edit/fix/fix.dart:
124+
Fix (class extends Object):
125+
compareFixes (static method: int Function(Fix, Fix))
126+
new (constructor: Fix Function({required SourceChange change, required FixKind kind}))
127+
change (getter: SourceChange)
128+
kind (getter: FixKind)
129+
toString (method: String Function())
130+
package:analysis_server_plugin/edit/fix/fix_context.dart:
131+
FixContext (class extends Object):
132+
error (getter: Diagnostic)
133+
package:analysis_server_plugin/plugin.dart:
134+
Plugin (class extends Object):
135+
new (constructor: Plugin Function())
136+
register (method: FutureOr<void> Function(PluginRegistry))
137+
shutDown (method: FutureOr<void> Function())
138+
start (method: FutureOr<void> Function())
139+
package:analysis_server_plugin/registry.dart:
140+
PluginRegistry (class extends Object):
141+
new (constructor: PluginRegistry Function())
142+
registerAssist (method: void Function(CorrectionProducer<ParsedUnitResult> Function({required CorrectionProducerContext context})))
143+
registerFixForRule (method: void Function(LintCode, CorrectionProducer<ParsedUnitResult> Function({required CorrectionProducerContext context})))
144+
registerLintRule (method: void Function(AnalysisRule))
145+
registerWarningRule (method: void Function(AnalysisRule))
146+
dart:async:
147+
Future (referenced)
148+
FutureOr (referenced)
149+
Stream (referenced)
150+
dart:core:
151+
Invocation (referenced)
152+
List (referenced)
153+
Map (referenced)
154+
Object (referenced)
155+
String (referenced)
156+
bool (referenced)
157+
int (referenced)
158+
package:_fe_analyzer_shared/src/scanner/token.dart:
159+
Token (referenced)
160+
package:analyzer/dart/analysis/analysis_options.dart:
161+
AnalysisOptions (referenced)
162+
package:analyzer/dart/analysis/features.dart:
163+
Feature (referenced)
164+
FeatureSet (referenced)
165+
package:analyzer/dart/analysis/results.dart:
166+
ParsedLibraryResult (referenced)
167+
ParsedUnitResult (referenced)
168+
ResolvedLibraryResult (referenced)
169+
ResolvedUnitResult (referenced)
170+
package:analyzer/dart/element/element.dart:
171+
ClassFragment (referenced)
172+
Element (referenced)
173+
EnumFragment (referenced)
174+
ExtensionFragment (referenced)
175+
ExtensionTypeFragment (referenced)
176+
InterfaceElement (referenced)
177+
LibraryElement (referenced)
178+
MixinFragment (referenced)
179+
package:analyzer/dart/element/type.dart:
180+
DartType (referenced)
181+
package:analyzer/dart/element/type_provider.dart:
182+
TypeProvider (referenced)
183+
package:analyzer/dart/element/type_system.dart:
184+
TypeSystem (referenced)
185+
package:analyzer/diagnostic/diagnostic.dart:
186+
Diagnostic (referenced)
187+
package:analyzer/instrumentation/service.dart:
188+
InstrumentationService (referenced)
189+
package:analyzer/source/source_range.dart:
190+
SourceRange (referenced)
191+
package:analyzer/src/dart/ast/ast.dart:
192+
AstNode (referenced)
193+
ClassDeclaration (referenced)
194+
EnumDeclaration (referenced)
195+
Expression (referenced)
196+
ExtensionDeclaration (referenced)
197+
ExtensionTypeDeclaration (referenced)
198+
MixinDeclaration (referenced)
199+
Statement (referenced)
200+
package:analyzer/src/dart/element/inheritance_manager3.dart:
201+
InheritanceManager3 (referenced)
202+
Name (referenced)
203+
package:analyzer/src/dart/error/lint_codes.dart:
204+
LintCode (referenced)
205+
package:analyzer/src/lint/linter.dart:
206+
AnalysisRule (referenced)
207+
package:analyzer_plugin/protocol/protocol_common.dart:
208+
SourceChange (referenced)
209+
package:analyzer_plugin/utilities/assist/assist.dart:
210+
AssistKind (referenced)
211+
package:analyzer_plugin/utilities/change_builder/change_builder_core.dart:
212+
ChangeBuilder (referenced)
213+
package:analyzer_plugin/utilities/change_builder/change_workspace.dart:
214+
ChangeWorkspace (referenced)
215+
package:analyzer_plugin/utilities/fixes/fixes.dart:
216+
FixKind (referenced)

‎pkg/analysis_server_plugin/pubspec.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ dependencies:
1818
# Use 'any' constraints here; we get our versions from the DEPS file.
1919
dev_dependencies:
2020
analyzer_testing: any
21+
analyzer_utilities: any
2122
async: any
2223
lints: any
24+
path: any
2325
test_reflective_loader: any
2426
test: any
2527

‎pkg/analysis_server_plugin/tool/api/generate.dart‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
/// Generates the file `api.txt`, which describes this package's public API.
6+
library;
7+
8+
import 'package:analyzer_testing/package_root.dart' as pkg_root;
9+
import 'package:analyzer_utilities/tool/api.dart';
10+
import 'package:analyzer_utilities/tools.dart';
11+
import 'package:path/path.dart';
12+
13+
Future<void> main() async {
14+
await GeneratedContent.generateAll(analyzerTestingPkgPath, allTargets);
15+
}
16+
17+
/// The path to the `analyzer_testing` package.
18+
final String analyzerTestingPkgPath = normalize(
19+
join(pkg_root.packageRoot, 'analysis_server_plugin'),
20+
);

‎pkg/analysis_server_plugin/tool/api/generate_test.dart‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
2+
// for details. All rights reserved. Use of this source code is governed by a
3+
// BSD-style license that can be found in the LICENSE file.
4+
5+
// This test verifies that all files generated by `generate.dart` are up to
6+
// date.
7+
8+
import 'package:analyzer_utilities/tool/api.dart';
9+
import 'package:analyzer_utilities/tools.dart';
10+
import 'package:path/path.dart';
11+
12+
import 'generate.dart';
13+
14+
Future<void> main() async {
15+
await GeneratedContent.checkAll(
16+
analyzerTestingPkgPath,
17+
join(analyzerTestingPkgPath, 'tool', 'api', 'generate.dart'),
18+
allTargets,
19+
);
20+
}

‎pkg/analyzer_testing/tool/api/generate.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// for details. All rights reserved. Use of this source code is governed by a
33
// BSD-style license that can be found in the LICENSE file.
44

5-
/// Generates the file `api.txt`, which describes the analyzer public API.
5+
/// Generates the file `api.txt`, which describes this package's public API.
66
library;
77

88
import 'package:analyzer_testing/package_root.dart' as pkg_root;

‎pkg/analyzer_utilities/lib/tool/api.dart‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -657,10 +657,14 @@ extension on Element {
657657
) when variable3.isInPublicApiOf(packageName)) {
658658
return true;
659659
}
660-
if (this case Annotatable(
661-
metadata2: Metadata(:var annotations),
662-
) when annotations.any(_isPublicApiAnnotation)) {
663-
return true;
660+
if (packageName == 'analyzer') {
661+
// Any element annotated with `@analyzerPublicApi` is considered to be
662+
// part of the public API of the analyzer package.
663+
if (this case Annotatable(
664+
metadata2: Metadata(:var annotations),
665+
) when annotations.any(_isPublicApiAnnotation)) {
666+
return true;
667+
}
664668
}
665669
if (name3 case var name? when !name.isPublic) return false;
666670
if (library2!.uri.isInPublicLibOf(packageName)) return true;

0 commit comments

Comments
 (0)