OLD | NEW |
1 // Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 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. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 /** | 5 /** |
6 * Support for client code that interacts with the analysis domain of an | 6 * Support for client code that interacts with the analysis domain of an |
7 * analysis server. | 7 * analysis server. |
8 * | 8 * |
9 * Plugins can gain access to the request handler that implements the analysis | 9 * Plugins can gain access to the request handler that implements the analysis |
10 * domain in order to extend the functionality of that domain. The class | 10 * domain in order to extend the functionality of that domain. The class |
11 * [AnalysisDomain] defines the API of the analysis domain that plugins can use. | 11 * [AnalysisDomain] defines the API of the analysis domain that plugins can use. |
12 * | 12 * |
13 * If a plugin is interested in gaining access to the analysis domain, it should | 13 * If a plugin is interested in gaining access to the analysis domain, it should |
14 * register a function by including code like the following in the plugin's | 14 * register a function by including code like the following in the plugin's |
15 * registerExtensions method: | 15 * registerExtensions method: |
16 * | 16 * |
17 * AnalysisDomain analysisDomain; | 17 * AnalysisDomain analysisDomain; |
18 * | 18 * |
19 * @override | 19 * @override |
20 * void registerExtensions(RegisterExtension registerExtension) { | 20 * void registerExtensions(RegisterExtension registerExtension) { |
21 * ... | 21 * ... |
22 * registerExtension( | 22 * registerExtension( |
23 * SET_ANALYSIS_DOMAIN_EXTENSION_POINT_ID, | 23 * SET_ANALYSIS_DOMAIN_EXTENSION_POINT_ID, |
24 * (AnalysisDomain domain) => analysisDomain = domain); | 24 * (AnalysisDomain domain) => analysisDomain = domain); |
25 * ... | 25 * ... |
26 * } | 26 * } |
27 */ | 27 */ |
28 import 'package:analysis_server/protocol/protocol_generated.dart' | |
29 show AnalysisService; | |
30 import 'package:analysis_server/src/plugin/server_plugin.dart'; | 28 import 'package:analysis_server/src/plugin/server_plugin.dart'; |
31 import 'package:analyzer/src/generated/engine.dart' show AnalysisContext; | |
32 import 'package:analyzer/src/generated/source.dart' show Source; | |
33 import 'package:plugin/plugin.dart'; | 29 import 'package:plugin/plugin.dart'; |
34 | 30 |
35 /** | 31 /** |
36 * The identifier of the extension point that allows plugins to get access to an | 32 * The identifier of the extension point that allows plugins to get access to an |
37 * [AnalysisDomain]. The object used as an extension must be a | 33 * [AnalysisDomain]. The object used as an extension must be a |
38 * [SetAnalysisDomain]. | 34 * [SetAnalysisDomain]. |
39 */ | 35 */ |
40 final String SET_ANALYSIS_DOMAIN_EXTENSION_POINT_ID = Plugin.join( | 36 final String SET_ANALYSIS_DOMAIN_EXTENSION_POINT_ID = Plugin.join( |
41 ServerPlugin.UNIQUE_IDENTIFIER, | 37 ServerPlugin.UNIQUE_IDENTIFIER, |
42 ServerPlugin.SET_ANALISYS_DOMAIN_EXTENSION_POINT); | 38 ServerPlugin.SET_ANALISYS_DOMAIN_EXTENSION_POINT); |
43 | 39 |
44 /** | 40 /** |
45 * A function that is invoked after the analysis domain has been created and is | 41 * A function that is invoked after the analysis domain has been created and is |
46 * initialized. | 42 * initialized. |
47 */ | 43 */ |
48 typedef void SetAnalysisDomain(AnalysisDomain domain); | 44 typedef void SetAnalysisDomain(AnalysisDomain domain); |
49 | 45 |
50 /** | 46 /** |
51 * An object that gives plugins access to the analysis domain of the analysis | 47 * An object that gives plugins access to the analysis domain of the analysis |
52 * server. | 48 * server. |
53 * | 49 * |
54 * Clients may not extend, implement or mix-in this class. | 50 * Clients may not extend, implement or mix-in this class. |
55 */ | 51 */ |
56 abstract class AnalysisDomain { | 52 abstract class AnalysisDomain {} |
57 /** | |
58 * Schedule sending the given [service] notifications for the given [source] | |
59 * in the given [context]. | |
60 */ | |
61 void scheduleNotification( | |
62 AnalysisContext context, Source source, AnalysisService service); | |
63 } | |
OLD | NEW |