Devtools: [WIP] Implement enhanced devtools extension language APIs

Source/devtools/front_end/source_frame/SourceFrame.js

 /*
  * Copyright (C) 2011 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:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 582 matching lines @@
         var messageBucket = this._rowMessageBuckets[lineNumber];
         if (!messageBucket)
             return;
         messageBucket.removeMessage(message);
         if (!messageBucket.uniqueMessagesCount()) {
             messageBucket.detachFromEditor();
             delete this._rowMessageBuckets[lineNumber];
         }
     },
 
-    populateLineGutterContextMenu: function(contextMenu, lineNumber)
+    /**
+     * @return {!Array<!WebInspector.SourceFrameMessage>}
+     */
+    getMessagesFromSource: function()

[wes, 2015/08/14 00:55:05]

This is marked for removal.

     {
+        var ret = [];
+        for (var line in this._rowMessageBuckets) {
+            if (this._rowMessageBuckets.hasOwnProperty(line)) {
+                var bucket = this._rowMessageBuckets[line];
+                ret.concat(bucket._messages);
+            }
+        }
+        return ret;
     },
 
-    populateTextAreaContextMenu: function(contextMenu, lineNumber, columnNumber)
-    {
+    setMessagesForSource: function(messages) {
+        this.clearMessages();
+        for (var index = 0; index < messages.length; index++) {
+            var message = messages[index];
+            this.addMessageToSource(message);
+        }
     },
 
     /**
+     * @return {!Promise}
+     */
+    populateLineGutterContextMenu: function(contextMenu, lineNumber)
+    {
+        return Promise.resolve();
+    },
+
+    /**
+     * @return {!Promise}
+     */
+    populateTextAreaContextMenu: function(contextMenu, lineNumber, columnNumber)
+    {
+        return Promise.resolve();
+    },
+
+    /**
      * @param {?WebInspector.TextRange} from
      * @param {?WebInspector.TextRange} to
      */
     onJumpToPosition: function(from, to)
     {
         this.dispatchEventToListeners(WebInspector.SourceFrame.Events.JumpHappened, {
             from: from,
             to: to
         });
     },
@@ skipping 55 matching lines @@
             e.consume(true);
     },
 
     __proto__: WebInspector.VBox.prototype
 }
 
 /**
  * @constructor
  * @param {string} messageText
  * @param {!WebInspector.SourceFrameMessage.Level} level
- * @param {number} lineNumber
- * @param {number=} columnNumber
+ * @param {{line: number, column: (number|undefined)}} start
+ * @param {{line: number, column: (number|undefined)}} end
  */
-WebInspector.SourceFrameMessage = function(messageText, level, lineNumber, columnNumber)
+WebInspector.SourceFrameMessage = function(messageText, level, start, end)
 {
     this._messageText = messageText;
     this._level = level;
-    this._lineNumber = lineNumber;
-    this._columnNumber = columnNumber;
+    this._start = {
+        line: start.line,
+        column: start.column
+    };
+    this._end = {
+        line: end.line,
+        column: end.column
+    };
 }
 
 /**
  * @enum {string}
  */
 WebInspector.SourceFrameMessage.Level = {
     Error: "Error",
     Warning: "Warning"
 }
 
 /**
  * @param {!WebInspector.ConsoleMessage} consoleMessage
  * @param {number} lineNumber
  * @param {number} columnNumber
  * @return {!WebInspector.SourceFrameMessage}
  */
 WebInspector.SourceFrameMessage.fromConsoleMessage = function(consoleMessage, lineNumber, columnNumber)
 {
     console.assert(consoleMessage.level === WebInspector.ConsoleMessage.MessageLevel.Error || consoleMessage.level === WebInspector.ConsoleMessage.MessageLevel.Warning);
     var level = consoleMessage.level === WebInspector.ConsoleMessage.MessageLevel.Error ? WebInspector.SourceFrameMessage.Level.Error : WebInspector.SourceFrameMessage.Level.Warning;
-    return new WebInspector.SourceFrameMessage(consoleMessage.messageText, level, lineNumber, columnNumber);
+    var location = {line: lineNumber, column: columnNumber};
+    return new WebInspector.SourceFrameMessage(consoleMessage.messageText, level, location, location);
 }
 
 WebInspector.SourceFrameMessage.prototype = {
     /**
      * @return {string}
      */
     messageText: function()
     {
         return this._messageText;
     },
 
     /**
      * @return {!WebInspector.SourceFrameMessage.Level}
      */
     level: function()
     {
         return this._level;
     },
 
     /**
+     * @return {{line: number, column: (number|undefined)}}
+     */
+    start: function() {
+        return this._start;
+    },
+
+    /**
+     * @return {{line: number, column: (number|undefined)}}
+     */
+    end: function() {
+        return this._end;
+    },
+
+    /**
      * @return {number}
      */
     lineNumber: function()
     {
-        return this._lineNumber;
+        return this._start.line;
     },
 
     /**
      * @return {(number|undefined)}
      */
     columnNumber: function()
     {
-        return this._columnNumber;
+        return this._start.column;
     },
 
     /**
      * @param {!WebInspector.SourceFrameMessage} another
      * @return {boolean}
      */
     isEqual: function(another)
     {
-        return this.messageText() === another.messageText() && this.level() === another.level() && this.lineNumber() === another.lineNumber() && this.columnNumber() === another.columnNumber();
+        return  this.messageText() === another.messageText() &&
+                this.level() === another.level() &&
+                this.lineNumber() === another.lineNumber() &&
+                this.columnNumber() === another.columnNumber() &&
+                this.end().line === another.end().line &&
+                this.end().column === another.end().column;
     }
 }
 
 WebInspector.SourceFrame._iconClassPerLevel = {};
 WebInspector.SourceFrame._iconClassPerLevel[WebInspector.SourceFrameMessage.Level.Error] = "error-icon";
 WebInspector.SourceFrame._iconClassPerLevel[WebInspector.SourceFrameMessage.Level.Warning] = "warning-icon";
 
 WebInspector.SourceFrame._lineClassPerLevel = {};
 WebInspector.SourceFrame._lineClassPerLevel[WebInspector.SourceFrameMessage.Level.Error] = "text-editor-line-with-error";
 WebInspector.SourceFrame._lineClassPerLevel[WebInspector.SourceFrameMessage.Level.Warning] = "text-editor-line-with-warning";
@@ skipping 82 matching lines @@
      * @param {number} lineNumber
      * @param {number} columnNumber
      */
     _updateWavePosition: function(lineNumber, columnNumber)
     {
         var lineText = this._textEditor.line(lineNumber);
         var lineIndent = WebInspector.TextUtils.lineIndent(lineText).length;
         var base = this._textEditor.cursorPositionToCoordinates(lineNumber, 0);
 
         var start = this._textEditor.cursorPositionToCoordinates(lineNumber, Math.max(columnNumber - 1, lineIndent));
+        if (!start) {
+            return; //stale data - columnNumber is already gone, wait for future update and for UI to settle
+        }
         var end = this._textEditor.cursorPositionToCoordinates(lineNumber, lineText.length);
         /** @const */
         var codeMirrorLinesLeftPadding = 4;
         this._wave.style.left = (start.x - base.x + codeMirrorLinesLeftPadding) + "px";
         this._wave.style.width = (end.x - start.x) + "px";
     },
 
     /**
      * @return {!Element}
      */
@@ skipping 132 matching lines @@
     /**
      * @override
      */
     editorFocused: function()
     {
         this._sourceFrame._editorFocused();
     },
 
     /**
      * @override
+     * @param {!WebInspector.ContextMenu} contextMenu
+     * @param {number} lineNumber
+     * @return {!Promise}
      */
     populateLineGutterContextMenu: function(contextMenu, lineNumber)

[pfeldman, 2015/08/13 21:15:47]

This is worth a separate patch.

[wes, 2015/08/14 00:55:05]

Making the context menu flow async in general, or the gutter menu? Both
originate from the same function in the CM wrapper, so the expectations on both
seem the same.

     {
-        this._sourceFrame.populateLineGutterContextMenu(contextMenu, lineNumber);
+        return this._sourceFrame.populateLineGutterContextMenu(contextMenu, lineNumber);
     },
 
     /**
      * @override
+     * @param {!WebInspector.ContextMenu} contextMenu
+     * @param {number} lineNumber
+     * @param {number} columnNumber
+     * @return {!Promise}
      */
     populateTextAreaContextMenu: function(contextMenu, lineNumber, columnNumber)
     {
-        this._sourceFrame.populateTextAreaContextMenu(contextMenu, lineNumber, columnNumber);
+        return this._sourceFrame.populateTextAreaContextMenu(contextMenu, lineNumber, columnNumber);
     },
 
     /**
      * @override
      * @param {?WebInspector.TextRange} from
      * @param {?WebInspector.TextRange} to
      */
     onJumpToPosition: function(from, to)
     {
         this._sourceFrame.onJumpToPosition(from, to);
     }
 }
 
 WebInspector.SourceFrameMessage._messageLevelPriority = {
     "Warning": 3,
     "Error": 4
 };
 
 /**
  * @param {!WebInspector.SourceFrameMessage} a
  * @param {!WebInspector.SourceFrameMessage} b
  * @return {number}
  */
 WebInspector.SourceFrameMessage.messageLevelComparator = function(a, b)
 {
     return WebInspector.SourceFrameMessage._messageLevelPriority[a.level()] - WebInspector.SourceFrameMessage._messageLevelPriority[b.level()];
 }