summaryrefslogtreecommitdiff
path: root/Source/WebInspectorUI/UserInterface/Models/SourceCode.js
diff options
context:
space:
mode:
Diffstat (limited to 'Source/WebInspectorUI/UserInterface/Models/SourceCode.js')
-rw-r--r--Source/WebInspectorUI/UserInterface/Models/SourceCode.js226
1 files changed, 226 insertions, 0 deletions
diff --git a/Source/WebInspectorUI/UserInterface/Models/SourceCode.js b/Source/WebInspectorUI/UserInterface/Models/SourceCode.js
new file mode 100644
index 000000000..29e8f3231
--- /dev/null
+++ b/Source/WebInspectorUI/UserInterface/Models/SourceCode.js
@@ -0,0 +1,226 @@
+/*
+ * Copyright (C) 2013 Apple 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
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+WebInspector.SourceCode = class SourceCode extends WebInspector.Object
+{
+ constructor()
+ {
+ super();
+
+ this._originalRevision = new WebInspector.SourceCodeRevision(this, null, false);
+ this._currentRevision = this._originalRevision;
+
+ this._sourceMaps = null;
+ this._formatterSourceMap = null;
+ this._requestContentPromise = null;
+ }
+
+ // Public
+
+ get displayName()
+ {
+ // Implemented by subclasses.
+ console.error("Needs to be implemented by a subclass.");
+ return "";
+ }
+
+ get originalRevision()
+ {
+ return this._originalRevision;
+ }
+
+ get currentRevision()
+ {
+ return this._currentRevision;
+ }
+
+ set currentRevision(revision)
+ {
+ console.assert(revision instanceof WebInspector.SourceCodeRevision);
+ if (!(revision instanceof WebInspector.SourceCodeRevision))
+ return;
+
+ console.assert(revision.sourceCode === this);
+ if (revision.sourceCode !== this)
+ return;
+
+ this._currentRevision = revision;
+
+ this.dispatchEventToListeners(WebInspector.SourceCode.Event.ContentDidChange);
+ }
+
+ get content()
+ {
+ return this._currentRevision.content;
+ }
+
+ get url()
+ {
+ // To be overridden by subclasses.
+ }
+
+ get contentIdentifier()
+ {
+ // A contentIdentifier is roughly `url || sourceURL` for cases where
+ // the content is consistent between sessions and not ephemeral.
+
+ // Can be overridden by subclasses if better behavior is possible.
+ return this.url;
+ }
+
+ get sourceMaps()
+ {
+ return this._sourceMaps || [];
+ }
+
+ addSourceMap(sourceMap)
+ {
+ console.assert(sourceMap instanceof WebInspector.SourceMap);
+
+ if (!this._sourceMaps)
+ this._sourceMaps = [];
+
+ this._sourceMaps.push(sourceMap);
+
+ this.dispatchEventToListeners(WebInspector.SourceCode.Event.SourceMapAdded);
+ }
+
+ get formatterSourceMap()
+ {
+ return this._formatterSourceMap;
+ }
+
+ set formatterSourceMap(formatterSourceMap)
+ {
+ console.assert(this._formatterSourceMap === null || formatterSourceMap === null);
+ console.assert(formatterSourceMap === null || formatterSourceMap instanceof WebInspector.FormatterSourceMap);
+
+ this._formatterSourceMap = formatterSourceMap;
+
+ this.dispatchEventToListeners(WebInspector.SourceCode.Event.FormatterDidChange);
+ }
+
+ requestContent()
+ {
+ this._requestContentPromise = this._requestContentPromise || this.requestContentFromBackend().then(this._processContent.bind(this));
+
+ return this._requestContentPromise;
+ }
+
+ createSourceCodeLocation(lineNumber, columnNumber)
+ {
+ return new WebInspector.SourceCodeLocation(this, lineNumber, columnNumber);
+ }
+
+ createLazySourceCodeLocation(lineNumber, columnNumber)
+ {
+ return new WebInspector.LazySourceCodeLocation(this, lineNumber, columnNumber);
+ }
+
+ createSourceCodeTextRange(textRange)
+ {
+ return new WebInspector.SourceCodeTextRange(this, textRange);
+ }
+
+ // Protected
+
+ revisionContentDidChange(revision)
+ {
+ if (this._ignoreRevisionContentDidChangeEvent)
+ return;
+
+ if (revision !== this._currentRevision)
+ return;
+
+ this.handleCurrentRevisionContentChange();
+
+ this.dispatchEventToListeners(WebInspector.SourceCode.Event.ContentDidChange);
+ }
+
+ handleCurrentRevisionContentChange()
+ {
+ // Implemented by subclasses if needed.
+ }
+
+ get revisionForRequestedContent()
+ {
+ // Implemented by subclasses if needed.
+ return this._originalRevision;
+ }
+
+ markContentAsStale()
+ {
+ this._requestContentPromise = null;
+ this._contentReceived = false;
+ }
+
+ requestContentFromBackend()
+ {
+ // Implemented by subclasses.
+ console.error("Needs to be implemented by a subclass.");
+ return Promise.reject(new Error("Needs to be implemented by a subclass."));
+ }
+
+ get mimeType()
+ {
+ // Implemented by subclasses.
+ console.error("Needs to be implemented by a subclass.");
+ }
+
+ // Private
+
+ _processContent(parameters)
+ {
+ // Different backend APIs return one of `content, `body`, `text`, or `scriptSource`.
+ var content = parameters.content || parameters.body || parameters.text || parameters.scriptSource;
+ var error = parameters.error;
+ if (parameters.base64Encoded)
+ content = decodeBase64ToBlob(content, this.mimeType);
+
+ var revision = this.revisionForRequestedContent;
+
+ this._ignoreRevisionContentDidChangeEvent = true;
+ revision.content = content || null;
+ this._ignoreRevisionContentDidChangeEvent = false;
+
+ // FIXME: Returning the content in this promise is misleading. It may not be current content
+ // now, and it may become out-dated later on. We should drop content from this promise
+ // and require clients to ask for the current contents from the sourceCode in the result.
+
+ return Promise.resolve({
+ error,
+ sourceCode: this,
+ content,
+ });
+ }
+};
+
+WebInspector.SourceCode.Event = {
+ ContentDidChange: "source-code-content-did-change",
+ SourceMapAdded: "source-code-source-map-added",
+ FormatterDidChange: "source-code-formatter-did-change",
+ LoadingDidFinish: "source-code-loading-did-finish",
+ LoadingDidFail: "source-code-loading-did-fail"
+};