This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
LESS Refactoring - add LanguageManager #2844
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -284,15 +284,11 @@ define(function (require, exports, module) { | |
| * @param {!boolean} makeMasterEditor If true, this Editor will set itself as the (secret) "master" | ||
| * Editor for the Document. If false, this Editor will attach to the Document as a "slave"/ | ||
| * secondary editor. | ||
| * @param {!jQueryObject} container Container to add the editor to. | ||
| * @param {{startLine: number, endLine: number}=} range If specified, range of lines within the document | ||
| * to display in this editor. Inclusive. | ||
| */ | ||
| function Editor(document, makeMasterEditor, container, range) { | ||
|
There was a problem hiding this comment. I don't believe that existing extensions will call this constructor, but we should address this API change. There was a problem hiding this comment. Good question. :) @peterflynn maybe you can also chime in. Since we can't overload the constructor, maybe we can just leave the argument in and change line 312 to: Not the cleanest idea but at the moment I'm drawing a blank. There was a problem hiding this comment. In this case, I suggest we just make the change and document it as a breaking API change in the release notes. It's not really that supported to create Editors without going through EditorManager anyway, and I suspect there aren't any extensions doing so... |
||
| var self = this; | ||
|
|
||
| _instances.push(this); | ||
|
|
@@ -308,8 +304,12 @@ define(function (require, exports, module) { | |
| // store this-bound version of listeners so we can remove them later | ||
| this._handleDocumentChange = this._handleDocumentChange.bind(this); | ||
| this._handleDocumentDeleted = this._handleDocumentDeleted.bind(this); | ||
| this._handleDocumentLanguageChanged = this._handleDocumentLanguageChanged.bind(this); | ||
| $(document).on("change", this._handleDocumentChange); | ||
| $(document).on("deleted", this._handleDocumentDeleted); | ||
| $(document).on("languageChanged", this._handleDocumentLanguageChanged); | ||
|
|
||
| var mode = this._getModeFromDocument(); | ||
|
|
||
| // (if makeMasterEditor, we attach the Doc back to ourselves below once we're fully initialized) | ||
|
|
||
|
|
@@ -346,13 +346,6 @@ define(function (require, exports, module) { | |
| "Cmd-Left": "goLineStartSmart" | ||
| }; | ||
|
|
||
| // Create the CodeMirror instance | ||
| // (note: CodeMirror doesn't actually require using 'new', but jslint complains without it) | ||
| this._codeMirror = new CodeMirror(container, { | ||
|
|
@@ -436,6 +429,7 @@ define(function (require, exports, module) { | |
| this.document.releaseRef(); | ||
| $(this.document).off("change", this._handleDocumentChange); | ||
| $(this.document).off("deleted", this._handleDocumentDeleted); | ||
| $(this.document).off("languageChanged", this._handleDocumentLanguageChanged); | ||
|
|
||
| if (this._visibleRange) { // TextRange also refs the Document | ||
| this._visibleRange.dispose(); | ||
|
|
@@ -453,6 +447,18 @@ define(function (require, exports, module) { | |
| }); | ||
| }; | ||
|
|
||
| /** | ||
| * Determine the mode to use from the document's language | ||
| * Uses "text/plain" if the language does not define a mode | ||
| * @return string The mode to use | ||
| */ | ||
| Editor.prototype._getModeFromDocument = function () { | ||
| // We'd like undefined/null/"" to mean plain text mode. CodeMirror defaults to plaintext for any | ||
| // unrecognized mode, but it complains on the console in that fallback case: so, convert | ||
| // here so we're always explicit, avoiding console noise. | ||
| return this.document.getLanguage().mode || "text/plain"; | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * Selects all text and maintains the current scroll position. | ||
|
|
@@ -598,6 +604,13 @@ define(function (require, exports, module) { | |
| $(this).triggerHandler("lostContent", [event]); | ||
| }; | ||
|
|
||
| /** | ||
| * Responds to language changes, for instance when the file extension is changed. | ||
| */ | ||
| Editor.prototype._handleDocumentLanguageChanged = function (event) { | ||
| this._codeMirror.setOption("mode", this._getModeFromDocument()); | ||
| }; | ||
|
|
||
|
|
||
| /** | ||
| * Install event handlers on the CodeMirror instance, translating them into | ||
|
|
@@ -1195,7 +1208,7 @@ define(function (require, exports, module) { | |
| * | ||
| * @return {?(Object|string)} Name of syntax-highlighting mode, or object containing a "name" property | ||
| * naming the mode along with configuration options required by the mode. | ||
| * See {@link Languages#getLanguageForFileExtension()} and {@link Language#mode}. | ||
| */ | ||
| Editor.prototype.getModeForSelection = function () { | ||
| // Check for mixed mode info | ||
|
|
@@ -1221,25 +1234,19 @@ define(function (require, exports, module) { | |
| } | ||
| }; | ||
|
|
||
| Editor.prototype.getLanguageForSelection = function () { | ||
| return this.document.getLanguage().getLanguageForMode(this.getModeForSelection()); | ||
| }; | ||
|
|
||
| /** | ||
| * Gets the syntax-highlighting mode for the document. | ||
| * | ||
| * @return {Object|String} Object or Name of syntax-highlighting mode; see {@link Languages#getLanguageForFileExtension()} and {@link Language#mode}. | ||
| */ | ||
| Editor.prototype.getModeForDocument = function () { | ||
| return this._codeMirror.getOption("mode"); | ||
| }; | ||
|
|
||
| /** | ||
| * The Document we're bound to | ||
| * @type {!Document} | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, yes this is a little tricky given the lack of weak references (/ weak listeners) in JS... The FileEntry will probably be a lot less permanent than the DocumentManager singleton this code used to listen to, but nonetheless we probably still do need to clean up the listener.
How about this -- on the first addRef() we add this listener, and on the last releaseRef() we clean it up. Anyone keeping a Document around for an asynchronous length of time is required to addRef() it, so the listener only matters when the refcount is non-zero.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spun off as #2961