Brian Wilkerson
298d22f4ab
Change-Id: I7a2e633b43283221790fb88a12065fed3dcdabb7 Reviewed-on: https://dart-review.googlesource.com/c/82120 Reviewed-by: Konstantin Shcheglov <scheglov@google.com> Reviewed-by: Paul Berry <paulberry@google.com> Commit-Queue: Brian Wilkerson <brianwilkerson@google.com>
76 lines
3.1 KiB
Dart
76 lines
3.1 KiB
Dart
// Copyright (c) 2017, 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 'dart:async';
|
|
|
|
import 'package:analyzer/dart/analysis/results.dart';
|
|
import 'package:analyzer/src/dart/analysis/driver.dart';
|
|
import 'package:analyzer_plugin/plugin/plugin.dart';
|
|
import 'package:analyzer_plugin/protocol/protocol.dart';
|
|
import 'package:analyzer_plugin/protocol/protocol_generated.dart';
|
|
import 'package:analyzer_plugin/src/utilities/completion/completion_core.dart';
|
|
import 'package:analyzer_plugin/utilities/completion/completion_core.dart';
|
|
import 'package:analyzer_plugin/utilities/generator.dart';
|
|
|
|
/**
|
|
* A mixin that can be used when creating a subclass of [ServerPlugin] to
|
|
* provide most of the implementation for handling code completion requests.
|
|
*
|
|
* Clients may not implement this mixin, but are allowed to use it as a mix-in
|
|
* when creating a subclass of [ServerPlugin].
|
|
*/
|
|
mixin CompletionMixin implements ServerPlugin {
|
|
/**
|
|
* Return a list containing the completion contributors that should be used to
|
|
* create completion suggestions for the file with the given [path].
|
|
*/
|
|
List<CompletionContributor> getCompletionContributors(String path);
|
|
|
|
/**
|
|
* Return the completion request that should be passes to the contributors
|
|
* returned from [getCompletionContributors].
|
|
*
|
|
* Throw a [RequestFailure] if the request could not be created.
|
|
*/
|
|
Future<CompletionRequest> getCompletionRequest(
|
|
CompletionGetSuggestionsParams parameters);
|
|
|
|
@override
|
|
Future<CompletionGetSuggestionsResult> handleCompletionGetSuggestions(
|
|
CompletionGetSuggestionsParams parameters) async {
|
|
// TODO(brianwilkerson) Determine whether this await is necessary.
|
|
await null;
|
|
String path = parameters.file;
|
|
CompletionRequest request = await getCompletionRequest(parameters);
|
|
CompletionGenerator generator =
|
|
new CompletionGenerator(getCompletionContributors(path));
|
|
GeneratorResult<CompletionGetSuggestionsResult> result =
|
|
await generator.generateCompletionResponse(request);
|
|
result.sendNotifications(channel);
|
|
return result.result;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A mixin that can be used when creating a subclass of [ServerPlugin] and
|
|
* mixing in [CompletionMixin]. This implements the creation of the completion
|
|
* request based on the assumption that the driver being created is an
|
|
* [AnalysisDriver].
|
|
*
|
|
* Clients may not extend or implement this class, but are allowed to use it as
|
|
* a mix-in when creating a subclass of [ServerPlugin] that also uses
|
|
* [CompletionMixin] as a mix-in.
|
|
*/
|
|
abstract class DartCompletionMixin implements CompletionMixin {
|
|
@override
|
|
Future<CompletionRequest> getCompletionRequest(
|
|
CompletionGetSuggestionsParams parameters) async {
|
|
// TODO(brianwilkerson) Determine whether this await is necessary.
|
|
await null;
|
|
ResolvedUnitResult result = await getResolvedUnitResult(parameters.file);
|
|
return new DartCompletionRequestImpl(
|
|
resourceProvider, parameters.offset, result);
|
|
}
|
|
}
|