chrome-devtools-frontend
Version:
Chrome DevTools UI
244 lines (223 loc) • 8.07 kB
JavaScript
/*
* 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
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
* OWNER OR 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.
*/
import * as Common from '../common/common.js'; // eslint-disable-line no-unused-vars
import * as Platform from '../platform/platform.js';
import {FormatMapping, FormatResult, formatterWorkerPool} from './FormatterWorkerPool.js'; // eslint-disable-line no-unused-vars
/**
* @interface
*/
export class FormatterInterface {}
/**
* @param {!Common.ResourceType.ResourceType} contentType
* @param {string} mimeType
* @param {string} content
* @param {function(string, !FormatterSourceMapping):!Promise<void>} callback
*/
FormatterInterface.format = function(contentType, mimeType, content, callback) {
if (contentType.isDocumentOrScriptOrStyleSheet()) {
new ScriptFormatter(mimeType, content, callback);
} else {
new ScriptIdentityFormatter(mimeType, content, callback);
}
};
/**
* @param {!Array<number>} lineEndings
* @param {number} lineNumber
* @param {number} columnNumber
* @return {number}
*/
FormatterInterface.locationToPosition = function(lineEndings, lineNumber, columnNumber) {
const position = lineNumber ? lineEndings[lineNumber - 1] + 1 : 0;
return position + columnNumber;
};
/**
* @param {!Array<number>} lineEndings
* @param {number} position
* @return {!Array<number>}
*/
FormatterInterface.positionToLocation = function(lineEndings, position) {
const lineNumber =
Platform.ArrayUtilities.upperBound(lineEndings, position - 1, Platform.ArrayUtilities.DEFAULT_COMPARATOR);
let columnNumber;
if (!lineNumber) {
columnNumber = position;
} else {
columnNumber = position - lineEndings[lineNumber - 1] - 1;
}
return [lineNumber, columnNumber];
};
/**
* @implements {FormatterInterface}
*/
export class ScriptFormatter {
/**
* @param {string} mimeType
* @param {string} content
* @param {function(string, !FormatterSourceMapping):!Promise<void>} callback
*/
constructor(mimeType, content, callback) {
this._mimeType = mimeType;
this._originalContent = content.replace(/\r\n?|[\n\u2028\u2029]/g, '\n').replace(/^\uFEFF/, '');
this._callback = callback;
this._initialize();
}
async _initialize() {
const pool = formatterWorkerPool();
const indent = Common.Settings.Settings.instance().moduleSetting('textEditorIndent').get();
const formatResult = await pool.format(this._mimeType, this._originalContent, indent);
if (!formatResult) {
this._callback(this._originalContent, new IdentityFormatterSourceMapping());
} else {
this._didFormatContent(formatResult);
}
}
/**
* @param {!FormatResult} formatResult
*/
_didFormatContent(formatResult) {
const originalContentLineEndings = Platform.StringUtilities.findLineEndingIndexes(this._originalContent);
const formattedContentLineEndings = Platform.StringUtilities.findLineEndingIndexes(formatResult.content);
const sourceMapping =
new FormatterSourceMappingImpl(originalContentLineEndings, formattedContentLineEndings, formatResult.mapping);
this._callback(formatResult.content, sourceMapping);
}
}
/**
* @implements {FormatterInterface}
*/
class ScriptIdentityFormatter {
/**
* @param {string} mimeType
* @param {string} content
* @param {function(string, !FormatterSourceMapping):!Promise<void>} callback
*/
constructor(mimeType, content, callback) {
callback(content, new IdentityFormatterSourceMapping());
}
}
/**
* @interface
*/
export class FormatterSourceMapping {
/**
* @param {number} lineNumber
* @param {number=} columnNumber
* @return {!Array.<number>}
*/
originalToFormatted(lineNumber, columnNumber) {
throw new Error('Not implemented yet.');
}
/**
* @param {number} lineNumber
* @param {number=} columnNumber
* @return {!Array.<number>}
*/
formattedToOriginal(lineNumber, columnNumber) {
throw new Error('Not implemented yet.');
}
}
/**
* @implements {FormatterSourceMapping}
*/
class IdentityFormatterSourceMapping {
/**
* @override
* @param {number} lineNumber
* @param {number=} columnNumber
* @return {!Array.<number>}
*/
originalToFormatted(lineNumber, columnNumber) {
return [lineNumber, columnNumber || 0];
}
/**
* @override
* @param {number} lineNumber
* @param {number=} columnNumber
* @return {!Array.<number>}
*/
formattedToOriginal(lineNumber, columnNumber) {
return [lineNumber, columnNumber || 0];
}
}
/**
* @implements {FormatterSourceMapping}
*/
class FormatterSourceMappingImpl {
/**
* @param {!Array.<number>} originalLineEndings
* @param {!Array.<number>} formattedLineEndings
* @param {!FormatMapping} mapping
*/
constructor(originalLineEndings, formattedLineEndings, mapping) {
this._originalLineEndings = originalLineEndings;
this._formattedLineEndings = formattedLineEndings;
this._mapping = mapping;
}
/**
* @override
* @param {number} lineNumber
* @param {number=} columnNumber
* @return {!Array.<number>}
*/
originalToFormatted(lineNumber, columnNumber) {
const originalPosition =
FormatterInterface.locationToPosition(this._originalLineEndings, lineNumber, columnNumber || 0);
const formattedPosition =
this._convertPosition(this._mapping.original, this._mapping.formatted, originalPosition || 0);
return FormatterInterface.positionToLocation(this._formattedLineEndings, formattedPosition);
}
/**
* @override
* @param {number} lineNumber
* @param {number=} columnNumber
* @return {!Array.<number>}
*/
formattedToOriginal(lineNumber, columnNumber) {
const formattedPosition =
FormatterInterface.locationToPosition(this._formattedLineEndings, lineNumber, columnNumber || 0);
const originalPosition = this._convertPosition(this._mapping.formatted, this._mapping.original, formattedPosition);
return FormatterInterface.positionToLocation(this._originalLineEndings, originalPosition || 0);
}
/**
* @param {!Array.<number>} positions1
* @param {!Array.<number>} positions2
* @param {number} position
* @return {number}
*/
_convertPosition(positions1, positions2, position) {
const index =
Platform.ArrayUtilities.upperBound(positions1, position, Platform.ArrayUtilities.DEFAULT_COMPARATOR) - 1;
let convertedPosition = positions2[index] + position - positions1[index];
if (index < positions2.length - 1 && convertedPosition > positions2[index + 1]) {
convertedPosition = positions2[index + 1];
}
return convertedPosition;
}
}