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

Source/devtools/front_end/sources/SourcesPanel.js

 /*
  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
  * 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:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
@@ skipping 1338 matching lines @@
      * @param {!Object} object
      * @return {!Promise}
      */
     reveal: function(object)
     {
         WebInspector.inspectorView.setCurrentPanel(WebInspector.SourcesPanel.instance());
         return Promise.resolve();
     }
 }
 
+
+/**
+ * @constructor
+ * @implements {WebInspector.Revealer}
+ */
+WebInspector.SourcesPanel.LineMessageRevealer = function()
+{
+}
+
+WebInspector.SourcesPanel.LineMessageRevealer.prototype = {
+    /**
+     * @override
+     * @param {!Object} object
+     * @return {!Promise}
+     */
+    reveal: function(object)
+    {
+        var container = /** @type {!WebInspector.UISourceCodeMessages} */ (object);
+        if (!(container.messages() instanceof Array))

[pfeldman, 2015/10/21 23:47:53]

There is a compile-time check for this.

[wes, 2015/10/23 20:35:30]

How so? container is cast from Object to the data structure on the line before -
and other Revealers do type assertions, such as
WebInspector.LayersPanel.LayerTreeRevealer,
WebInspector.NetworkPanel.RequestRevealer,
WebInspector.ResourcesPanel.ResourceRevealer, and so on. Though I should
probably be asserting is that it's a WebInspector.UISourceCodeMessages, rather
than checking its members' return types.

+            return Promise.reject(new Error("Internal error: messages member not an array of line message definition objects"));
+        if (!(container.source() instanceof WebInspector.UISourceCode))
+            return Promise.reject(new Error("Internal error: code member not a UISourceCode objects"));
+
+        var frame = WebInspector.SourcesPanel.instance().sourcesView().viewForFile(container.source());
+        frame.setMessagesForSource(container.messages().map(function(m){

[pfeldman, 2015/10/21 23:47:53]

Revealers are for revealing things, not for populating messages. You should also
not replace the messages, but rather add them. It seems like what you need is an
addMessage on the UISourceCode that would store message in the internal list and
dispatch corresponding message that SourceFrame would hear.

[wes, 2015/10/23 04:51:01]

I'd actually wavered on if squiggles should be stateful myself... initially I
had them event based and stateful, but it resulted in a lot of state management
(and a lot more API surface) just to say "clear out all the old ones and then
display this set of messages". Which is all it turns out I ever wanted to do.

But yeah, I could see it better propagated as an event - though I don't think
it's completely inappropriate to call it something reveal-able - the messages
are a lot like an overlay on the given file.

+            return new WebInspector.SourceFrameMessage(m.text(), WebInspector.SourceFrameMessage.Level[m.kind()], {
+                line: m.location().startLine,
+                column: m.location().startColumn
+            }, {
+                line: m.location().endLine,
+                column: m.location().endColumn
+            });
+        }));
+
+        return Promise.resolve();
+    }
+}
+
 /**
  * @constructor
  * @implements {WebInspector.ActionDelegate}
  */
 WebInspector.SourcesPanel.RevealingActionDelegate = function() {}
 
 WebInspector.SourcesPanel.RevealingActionDelegate.prototype = {
     /**
      * @override
      * @param {!WebInspector.Context} context
@@ skipping 80 matching lines @@
 WebInspector.SourcesPanelFactory.prototype = {
     /**
      * @override
      * @return {!WebInspector.Panel}
      */
     createPanel: function()
     {
         return WebInspector.SourcesPanel.instance();
     }
 }