add ContextsChangedEvent

pkg/analysis_server/lib/src/analysis_server.dart

Index: pkg/analysis_server/lib/src/analysis_server.dart
diff --git a/pkg/analysis_server/lib/src/analysis_server.dart b/pkg/analysis_server/lib/src/analysis_server.dart
index 7abc951841b17b8b61b080c0397280c77ff0e8da..7a1a281439adc33d9f8f92d4352c1d89d11164e7 100644
--- a/pkg/analysis_server/lib/src/analysis_server.dart
+++ b/pkg/analysis_server/lib/src/analysis_server.dart
@@ -36,9 +36,22 @@ class ServerContextManager extends ContextManager {
    */
   AnalysisOptionsImpl defaultOptions = new AnalysisOptionsImpl();
 
+  /**
+   * The controller for sending [ContextsChangedEvent]s.
+   */
+  StreamController<ContextsChangedEvent> _onContextsChangedController;
+
   ServerContextManager(this.analysisServer, ResourceProvider resourceProvider,
       PackageMapProvider packageMapProvider)
-      : super(resourceProvider, packageMapProvider);
+      : super(resourceProvider, packageMapProvider) {
+    _onContextsChangedController = new StreamController<ContextsChangedEvent>();
+  }
+
+  /**
+   * The stream that is notified when contexts are added or removed.
+   */
+  Stream<ContextsChangedEvent> get onContextsChanged =>
+      _onContextsChangedController.stream;
 
   @override
   void addContext(Folder folder, UriResolver packageUriResolver) {
@@ -46,6 +59,8 @@ class ServerContextManager extends ContextManager {
     analysisServer.folderMap[folder] = context;
     context.sourceFactory = _createSourceFactory(packageUriResolver);
     context.analysisOptions = new AnalysisOptionsImpl.con1(defaultOptions);
+    _onContextsChangedController.add(
+        new ContextsChangedEvent(added: [context]));
     analysisServer.schedulePerformAnalysisOperation(context);
   }
 
@@ -64,6 +79,8 @@ class ServerContextManager extends ContextManager {
     if (analysisServer.index != null) {
       analysisServer.index.removeContext(context);
     }
+    _onContextsChangedController.add(
+        new ContextsChangedEvent(removed: [context]));
     analysisServer.sendContextAnalysisDoneNotifications(
         context,
         AnalysisDoneReason.CONTEXT_REMOVED);
@@ -71,9 +88,11 @@ class ServerContextManager extends ContextManager {
 
   @override
   void updateContextPackageUriResolver(Folder contextFolder,
-                                       UriResolver packageUriResolver) {
+      UriResolver packageUriResolver) {
     AnalysisContext context = analysisServer.folderMap[contextFolder];
     context.sourceFactory = _createSourceFactory(packageUriResolver);
+    _onContextsChangedController.add(
+        new ContextsChangedEvent(changed: [context]));
     analysisServer.schedulePerformAnalysisOperation(context);
   }
 
@@ -92,6 +111,38 @@ class ServerContextManager extends ContextManager {
 
 
 /**
+ * A [ContextsChangedEvent] indicate what contexts were added or removed.
+ *
+ * No context should be added to the event more than once. It does not make
+ * sense, for example, for a context to be both added and removed.
+ */
+class ContextsChangedEvent {
+
+  /**
+   * [addedContexts] lists contexts that were added to the server.

[Brian Wilkerson, 2014/11/17 15:58:34]

These comments don't follow the form you used elsewhere. How about "The contexts
that were added to the server.", etc.

[danrubel, 2014/11/17 17:10:14]

Done.

+   */
+  List<AnalysisContext> addedContexts;
+
+  /**
+   * [changedContexts] lists contexts that were changed.
+   */
+  List<AnalysisContext> changedContexts;
+
+  /**
+   * [removedContexts] lists contexts that were removed from the server.
+   */
+  List<AnalysisContext> removedContexts;
+
+  ContextsChangedEvent({List<AnalysisContext> added: null,
+      List<AnalysisContext> changed: null, List<AnalysisContext> removed: null}) {

[Brian Wilkerson, 2014/11/17 15:58:34]

How about something like:

ContextsChangedEvent({this.added: AnalysisContext.EMPTY_LIST, ...});

That has the advantage that we could share the same empty list for all events,
hence creating fewer temporary objects.

[danrubel, 2014/11/17 17:10:14]

Good point. Done.

+    addedContexts = added != null ? added : [];
+    changedContexts = changed != null ? changed : [];
+    removedContexts = removed != null ? removed : [];
+  }
+}
+
+
+/**
  * Enum representing reasons why analysis might be done for a given file.
  */
 class AnalysisDoneReason {
@@ -229,6 +280,11 @@ class AnalysisServer {
   bool rethrowExceptions;
 
   /**
+   * The stream that is notified when contexts are added or removed.
+   */
+  Stream<ContextsChangedEvent> onContextsChanged;
+
+  /**
    * Initialize a newly created server to receive requests from and send
    * responses to the given [channel].
    *
@@ -244,6 +300,8 @@ class AnalysisServer {
     operationQueue = new ServerOperationQueue(this);
     contextDirectoryManager =
         new ServerContextManager(this, resourceProvider, packageMapProvider);
+    onContextsChanged =
+        contextDirectoryManager.onContextsChanged.asBroadcastStream();
     AnalysisEngine.instance.logger = new AnalysisLogger();
     _onAnalysisStartedController = new StreamController.broadcast();
     _onAnalysisCompleteController = new StreamController.broadcast();
@@ -435,9 +493,8 @@ class AnalysisServer {
           channel.sendResponse(exception.response);
           return;
         } catch (exception, stackTrace) {
-          RequestError error = new RequestError(
-              RequestErrorCode.SERVER_ERROR,
-              exception.toString());
+          RequestError error =
+              new RequestError(RequestErrorCode.SERVER_ERROR, exception.toString());
           if (stackTrace != null) {
             error.stackTrace = stackTrace.toString();
           }
@@ -920,7 +977,7 @@ class AnalysisServer {
    * Schedules [performOperation] exection.
    */
   void _schedulePerformOperation() {
-    assert (!performOperationPending);
+    assert(!performOperationPending);
     new Future(performOperation);
     performOperationPending = true;
   }