Devtools: API To set the red/yellow squiggles for a file via DI

third_party/WebKit/Source/devtools/front_end/workspace/UISourceCode.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 34 matching lines @@
     this._parentPath = parentPath;
     this._name = name;
     this._originURL = originURL;
     this._contentType = contentType;
     /** @type {!Array.<function(?string)>} */
     this._requestContentCallbacks = [];
 
     /** @type {!Array.<!WebInspector.Revision>} */
     this.history = [];
     this._hasUnsavedCommittedChanges = false;
+
+    /** @type {!Array<!WebInspector.UISourceCodeMessage>} */
+    this._messages = [];
 }
 
 /**
  * @enum {string}
  */
 WebInspector.UISourceCode.Events = {
     WorkingCopyChanged: "WorkingCopyChanged",
     WorkingCopyCommitted: "WorkingCopyCommitted",
     TitleChanged: "TitleChanged",
     SourceMappingChanged: "SourceMappingChanged",
+    LineMessageAdded: "LineMessageAdded",

[pfeldman, 2015/10/27 17:37:34]

These are not exactly line messages, MessageAdded? SourceMessageAdded?

[wes, 2015/10/27 21:59:16]

MessageAdded is more succinct, so if its meaning is still clear, I think I'd at
least prefer it.

+    LineMessageRemoved: "LineMessageRemoved"
 }
 
 WebInspector.UISourceCode.prototype = {
     /**
      * @return {string}
      */
     name: function()
     {
         return this._name;
     },
@@ skipping 484 matching lines @@
      * @param {number=} columnNumber
      * @return {!WebInspector.UILocation}
      */
     uiLocation: function(lineNumber, columnNumber)
     {
         if (typeof columnNumber === "undefined")
             columnNumber = 0;
         return new WebInspector.UILocation(this, lineNumber, columnNumber);
     },
 
+    /**
+     * @param {!WebInspector.UISourceCodeMessage} message
+     */
+    addLineMessage: function(message) {

[pfeldman, 2015/10/27 17:37:34]

addLineMessage: function(level, text, location)
{
    // construct object
    return message;
}

[wes, 2015/10/27 21:59:16]

Seems fine.

+        for (var i = 0; i < this._messages.length; i++) {
+            var m = this._messages[i];
+            if (m.equal(message)) {

[pfeldman, 2015/10/27 17:44:04]

There is no reason to dedupe them here.

[wes, 2015/10/27 21:59:16]

Alright - we do still dedupe them in the display part, I believe.

+                return;
+            }
+        }
+        this._messages.push(message);
+        this.dispatchEventToListeners(WebInspector.UISourceCode.Events.LineMessageAdded, message);
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCodeMessage} message
+     */
+    removeLineMessage: function(message) {

[pfeldman, 2015/10/27 17:37:34]

Should we remove messages by identity objects?

[wes, 2015/10/27 21:59:16]

If we don't dedupe them on entry, then we should probably only remove based on
reference equality, rather than deep equality. It just means that consumers have
to keep around the messages they care about.

+        for (var i = 0; i < this._messages.length; i++) {
+            var m = this._messages[i];
+            if (m.equal(message)) {
+                this._messages.splice(i, 1);
+                this.dispatchEventToListeners(WebInspector.UISourceCode.Events.LineMessageRemoved, message);
+                break;
+            }
+        }
+    },
+
     __proto__: WebInspector.Object.prototype

[pfeldman, 2015/10/27 17:37:34]

messages() accessor and clearMessages() would come handy for the clients that
are created post-message addition.

[wes, 2015/10/27 21:59:16]

For sure. clearMessages() is going to fire many menu removed events, though (or
need to have its own event).

 }
 
 /**
  * @constructor
  * @param {!WebInspector.UISourceCode} uiSourceCode
  * @param {number} lineNumber
  * @param {number} columnNumber
  */
 WebInspector.UILocation = function(uiSourceCode, lineNumber, columnNumber)
 {
@@ skipping 117 matching lines @@
      * @param {string} query
      * @param {boolean} caseSensitive
      * @param {boolean} isRegex
      * @param {function(!Array.<!WebInspector.ContentProvider.SearchMatch>)} callback
      */
     searchInContent: function(query, caseSensitive, isRegex, callback)
     {
         callback([]);
     }
 }
+
+/**
+ * @constructor
+ * @param {string} text
+ * @param {string} kind
+ * @param {!WebInspector.TextRange} location
+ */
+WebInspector.UISourceCodeMessage = function(text, kind, location) {
+    this._text = text;
+    this._kind = kind;
+    this._location = location;
+}
+
+WebInspector.UISourceCodeMessage.prototype = {
+    /**
+     * @return {string}
+     */
+    text: function()
+    {
+        return this._text;
+    },
+
+    /**
+     * @return {string}
+     */
+    kind: function()
+    {
+        return this._kind;
+    },
+
+    /**
+     * @return {!WebInspector.TextRange}
+     */
+    location: function()
+    {
+        return this._location;
+    },
+
+    /**
+     * @param {!WebInspector.UISourceCodeMessage} another
+     * @return {boolean}
+     */
+    equal: function(another) {
+        return this.kind() === another.kind() &&
+               this.text() === another.text() &&
+               this.location().equal(another.location());
+    }
+}