This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1753 from adobe/nj/factor-token-utils
Factor out generic token-navigation routines from HTMLUtils
- Loading branch information
Showing
2 changed files
with
144 additions
and
105 deletions.
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 |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| /* | ||
| * Copyright (c) 2012 Adobe Systems Incorporated. All rights reserved. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a | ||
| * copy of this software and associated documentation files (the "Software"), | ||
| * to deal in the Software without restriction, including without limitation | ||
| * the rights to use, copy, modify, merge, publish, distribute, sublicense, | ||
| * and/or sell copies of the Software, and to permit persons to whom the | ||
| * Software is furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
| * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER | ||
| * DEALINGS IN THE SOFTWARE. | ||
| * | ||
| */ | ||
|
|
||
|
|
||
| /*jslint vars: true, plusplus: true, devel: true, nomen: true, indent: 4, maxerr: 50 */ | ||
| /*global define, $ */ | ||
|
|
||
| /** | ||
| * Functions for iterating through tokens in the current editor buffer. Useful for doing | ||
| * light parsing that can rely purely on information gathered by the code coloring mechanism. | ||
| */ | ||
|
|
||
| define(function (require, exports, module) { | ||
| "use strict"; | ||
|
|
||
| /** | ||
| * Creates a context object for the given editor and position, suitable for passing to the | ||
| * move functions. | ||
| * @param {CodeMirror} editor | ||
| * @param {{ch:{string}, line:{number}} pos | ||
| * @return {editor:{CodeMirror}, pos:{ch:{string}, line:{number}}, token:{object}} | ||
| */ | ||
| function getInitialContext(editor, pos) { | ||
| return { | ||
| "editor": editor, | ||
| "pos": pos, | ||
| "token": editor.getTokenAt(pos) | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Moves the given context backwards by one token. | ||
| * @param {editor:{CodeMirror}, pos:{ch:{string}, line:{number}}, token:{object}} ctx | ||
| * @return {boolean} whether the context changed | ||
| */ | ||
| function movePrevToken(ctx) { | ||
| if (ctx.pos.ch <= 0 || ctx.token.start <= 0) { | ||
| //move up a line | ||
| if (ctx.pos.line <= 0) { | ||
| return false; //at the top already | ||
| } | ||
| ctx.pos.line--; | ||
| ctx.pos.ch = ctx.editor.getLine(ctx.pos.line).length; | ||
| } else { | ||
| ctx.pos.ch = ctx.token.start; | ||
| } | ||
| ctx.token = ctx.editor.getTokenAt(ctx.pos); | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Moves the given context forward by one token. | ||
| * @param {editor:{CodeMirror}, pos:{ch:{string}, line:{number}}, token:{object}} ctx | ||
| * @return {boolean} whether the context changed | ||
| */ | ||
| function moveNextToken(ctx) { | ||
| var eol = ctx.editor.getLine(ctx.pos.line).length; | ||
| if (ctx.pos.ch >= eol || ctx.token.end >= eol) { | ||
| //move down a line | ||
| if (ctx.pos.line >= ctx.editor.lineCount() - 1) { | ||
| return false; //at the bottom | ||
| } | ||
| ctx.pos.line++; | ||
| ctx.pos.ch = 0; | ||
| } else { | ||
| ctx.pos.ch = ctx.token.end + 1; | ||
| } | ||
| ctx.token = ctx.editor.getTokenAt(ctx.pos); | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * Moves the given context in the given direction, skipping any whitespace it hits. | ||
| * @param {function} moveFxn the funciton to move the context | ||
| * @param {editor:{CodeMirror}, pos:{ch:{string}, line:{number}}, token:{object}} ctx | ||
| * @return {boolean} whether the context changed | ||
| */ | ||
| function moveSkippingWhitespace(moveFxn, ctx) { | ||
| if (!moveFxn(ctx)) { | ||
| return false; | ||
| } | ||
| while (!ctx.token.className && ctx.token.string.trim().length === 0) { | ||
| if (!moveFxn(ctx)) { | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * In the given context, get the character offset of pos from the start of the token. | ||
| * @param {editor:{CodeMirror}, pos:{ch:{string}, line:{number}}, token:{object}} context | ||
| * @return {number} | ||
| */ | ||
| function offsetInToken(ctx) { | ||
| var offset = ctx.pos.ch - ctx.token.start; | ||
| if (offset < 0) { | ||
| console.log("CodeHintUtils: _offsetInToken - Invalid context: the pos what not in the current token!"); | ||
| } | ||
| return offset; | ||
| } | ||
|
|
||
| exports.movePrevToken = movePrevToken; | ||
| exports.moveNextToken = moveNextToken; | ||
| exports.moveSkippingWhitespace = moveSkippingWhitespace; | ||
| exports.getInitialContext = getInitialContext; | ||
| exports.offsetInToken = offsetInToken; | ||
| }); |