DevTools: Support line markers in UISourceCode and Code Mirror

third_party/WebKit/Source/devtools/front_end/sources/UISourceCodeFrame.js

 /*
  * Copyright (C) 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  * 1. Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *
@@ skipping 19 matching lines @@
  * @constructor
  * @extends {WebInspector.SourceFrame}
  * @param {!WebInspector.UISourceCode} uiSourceCode
  */
 WebInspector.UISourceCodeFrame = function(uiSourceCode)
 {
     this._uiSourceCode = uiSourceCode;
     WebInspector.SourceFrame.call(this, this._uiSourceCode);
     this.textEditor.setAutocompleteDelegate(new WebInspector.SimpleAutocompleteDelegate());
     this._rowMessageBuckets = {};
+    /** @type {!Map<string, !Array<!WebInspector.UISourceCode.LineMarker>>} */
+    this._markersToDecorate = new Map();
     this._uiSourceCode.addEventListener(WebInspector.UISourceCode.Events.WorkingCopyChanged, this._onWorkingCopyChanged, this);
     this._uiSourceCode.addEventListener(WebInspector.UISourceCode.Events.WorkingCopyCommitted, this._onWorkingCopyCommitted, this);
     this._uiSourceCode.addEventListener(WebInspector.UISourceCode.Events.MessageAdded, this._onMessageAdded, this);
     this._uiSourceCode.addEventListener(WebInspector.UISourceCode.Events.MessageRemoved, this._onMessageRemoved, this);
+    this._uiSourceCode.addEventListener(WebInspector.UISourceCode.Events.LineMarkerAdded, this._onLineMarkerAdded, this);
+    this._uiSourceCode.addEventListener(WebInspector.UISourceCode.Events.LineMarkerRemoved, this._onLineMarkerRemoved, this);
     this._updateStyle();
 
     this._errorPopoverHelper = new WebInspector.PopoverHelper(this.element, this._getErrorAnchor.bind(this), this._showErrorPopover.bind(this));
     this._errorPopoverHelper.setTimeout(100, 100);
 }
 
 WebInspector.UISourceCodeFrame.prototype = {
     /**
      * @return {!WebInspector.UISourceCode}
      */
@@ skipping 57 matching lines @@
     },
 
     /**
      * @override
      */
     onTextEditorContentLoaded: function()
     {
         WebInspector.SourceFrame.prototype.onTextEditorContentLoaded.call(this);
         for (var message of this._uiSourceCode.messages())
             this._addMessageToSource(message);
+        this._decorateLineMarkers();
     },
 
     /**
      * @override
      * @param {!WebInspector.TextRange} oldRange
      * @param {!WebInspector.TextRange} newRange
      */
     onTextChanged: function(oldRange, newRange)
     {
         WebInspector.SourceFrame.prototype.onTextChanged.call(this, oldRange, newRange);
@@ skipping 192 matching lines @@
     },
 
     _updateBucketDecorations: function()
     {
         for (var line in this._rowMessageBuckets) {
             var bucket = this._rowMessageBuckets[line];
             bucket._updateDecoration();
         }
     },
 
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onLineMarkerAdded: function(event)
+    {
+        var marker = /** @type {!WebInspector.UISourceCode.LineMarker} */ (event.data);
+        this._decorateLineMarker(marker);

[pfeldman, 2016/03/09 02:14:20]

runtime.extensions(decorator,
event.type).instance().then(decorate(this.uiSourceCode, this.editor);

[alph, 2016/03/09 22:42:18]

Done.

+    },
+
+    /**
+     * @param {!WebInspector.Event} event
+     */
+    _onLineMarkerRemoved: function(event)
+    {
+        var marker = /** @type {!WebInspector.UISourceCode.LineMarker} */ (event.data);

[pfeldman, 2016/03/09 02:14:20]

ditto

[alph, 2016/03/09 22:42:18]

Done.

+        this._textEditor.setGutterMarker(marker.line(), marker.type(), null);

[pfeldman, 2016/03/09 02:14:20]

How do you know what the decorator is doing? CodeMirrorTextEditor should not be
aware of markers - it is layering violation.

[alph, 2016/03/09 22:42:18]

Done.

+    },
+
+    _decorateLineMarkers: function()
+    {
+        for (var markers of this.uiSourceCode().lineMarkers().values())
+            markers.forEach(this._decorateLineMarker.bind(this));
+    },
+
+    /**
+     * @param  {!WebInspector.UISourceCode.LineMarker} marker
+     */
+    _decorateLineMarker: function(marker)
+    {
+        var type = marker.type();
+        var markers = this._markersToDecorate.get(type);
+        if (markers) {
+            markers.push(marker);
+            return;
+        }
+        markers = [];
+        this._markersToDecorate.set(type, markers);
+        lineMarkerDecorator(marker.type()).then(decorateLineMarkers.bind(this, type, markers));
+
+        /**
+         * @param {string} type
+         * @param {!Array<!WebInspector.UISourceCode.LineMarker>} markers
+         * @param {!WebInspector.EditorLineMarkerDecorator} decorator
+         * @this {WebInspector.UISourceCodeFrame}
+         */
+        function decorateLineMarkers(type, markers, decorator)
+        {
+            for (var marker of markers)
+                this._textEditor.setGutterMarker(marker.line(), marker.type(), decorator.decorate(marker.data()));
+            this._markersToDecorate.delete(type);
+        }
+
+        /**
+         * @param  {string} type
+         * @return {!Promise<!WebInspector.EditorLineMarkerDecorator>}
+         */
+        function lineMarkerDecorator(type)
+        {
+            var descriptor = self.runtime.extensions("@WebInspector.EditorLineMarkerDecorator").find(extension => extension.descriptor().marker === type);
+            console.assert(descriptor, "Unknown decorator type.");
+            return descriptor.instancePromise();
+        }
+    },
+
     __proto__: WebInspector.SourceFrame.prototype
 }
 
 WebInspector.UISourceCodeFrame._iconClassPerLevel = {};
 WebInspector.UISourceCodeFrame._iconClassPerLevel[WebInspector.UISourceCode.Message.Level.Error] = "error-icon";
 WebInspector.UISourceCodeFrame._iconClassPerLevel[WebInspector.UISourceCode.Message.Level.Warning] = "warning-icon";
 
 WebInspector.UISourceCodeFrame._lineClassPerLevel = {};
 WebInspector.UISourceCodeFrame._lineClassPerLevel[WebInspector.UISourceCode.Message.Level.Error] = "text-editor-line-with-error";
 WebInspector.UISourceCodeFrame._lineClassPerLevel[WebInspector.UISourceCode.Message.Level.Warning] = "text-editor-line-with-warning";
@@ skipping 204 matching lines @@
 
 /**
  * @param {!WebInspector.UISourceCode.Message} a
  * @param {!WebInspector.UISourceCode.Message} b
  * @return {number}
  */
 WebInspector.UISourceCode.Message.messageLevelComparator = function(a, b)
 {
     return WebInspector.UISourceCode.Message._messageLevelPriority[a.level()] - WebInspector.UISourceCode.Message._messageLevelPriority[b.level()];
 }