META-INF.dirigible.dev-tools.text_utils.ContentProvider.js Maven / Gradle / Ivy
/*
* Copyright (C) 2012 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
/**
* @interface
*/
export class ContentProvider {
/**
* @return {string}
*/
contentURL() {
throw new Error('not implemented');
}
/**
* @return {!Common.ResourceType.ResourceType}
*/
contentType() {
throw new Error('not implemented');
}
/**
* @return {!Promise}
*/
contentEncoded() {
throw new Error('not implemented');
}
/**
* @return {!Promise}
*/
requestContent() {
throw new Error('not implemented');
}
/**
* @param {string} query
* @param {boolean} caseSensitive
* @param {boolean} isRegex
* @return {!Promise>}
*/
searchInContent(query, caseSensitive, isRegex) {
throw new Error('not implemented');
}
}
/**
* @unrestricted
*/
export class SearchMatch {
/**
* @param {number} lineNumber
* @param {string} lineContent
*/
constructor(lineNumber, lineContent) {
this.lineNumber = lineNumber;
this.lineContent = lineContent;
}
}
/**
* @param {?string} content
* @param {string} mimeType
* @param {boolean} contentEncoded
* @param {?string=} charset
* @return {?string}
*/
export const contentAsDataURL = function(content, mimeType, contentEncoded, charset) {
const maxDataUrlSize = 1024 * 1024;
if (content === undefined || content === null || content.length > maxDataUrlSize) {
return null;
}
return 'data:' + mimeType + (charset ? ';charset=' + charset : '') + (contentEncoded ? ';base64' : '') + ',' +
content;
};
/**
* @typedef {{
* content: string,
* isEncoded: boolean,
* }|{
* error: string,
* isEncoded: boolean,
* }}
*/
// @ts-ignore typedef
export let DeferredContent;