UNPKG

@theia/core

Version:

Theia is a cloud & desktop IDE framework implemented in TypeScript.

142 lines • 5.66 kB
// ***************************************************************************** // Copyright (C) 2018 Ericsson and others. // // This program and the accompanying materials are made available under the // terms of the Eclipse Public License v. 2.0 which is available at // http://www.eclipse.org/legal/epl-2.0. // // This Source Code may also be made available under the following Secondary // Licenses when the conditions for such availability set forth in the Eclipse // Public License v. 2.0 are satisfied: GNU General Public License, version 2 // with the GNU Classpath Exception which is available at // https://www.gnu.org/software/classpath/license.html. // // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 // ***************************************************************************** import { __decorate } from "tslib"; import debounce from 'p-debounce'; import { injectable } from 'inversify'; import { Emitter } from '../event.js'; import { Deferred } from '../promise-util.js'; import { DisposableCollection } from '../disposable.js'; import { PreferenceLanguageOverrideService } from './preference-language-override-service.js'; import { isObject } from '../types.js'; export class PreferenceProviderBase { constructor() { this.onDidPreferencesChangedEmitter = new Emitter(); this.onDidPreferencesChanged = this.onDidPreferencesChangedEmitter.event; this.toDispose = new DisposableCollection(); this.fireDidPreferencesChanged = debounce(() => { const changes = this.deferredChanges; this.deferredChanges = undefined; if (changes && Object.keys(changes).length) { this.onDidPreferencesChangedEmitter.fire(Object.values(changes)); return true; } return false; }, 0); this.toDispose.push(this.onDidPreferencesChangedEmitter); } /** * Informs the listeners that one or more preferences of this provider are changed. * The listeners are able to find what was changed from the emitted event. */ emitPreferencesChangedEvent(changes) { for (const change of changes) { this.mergePreferenceProviderDataChange(change); } return this.fireDidPreferencesChanged(); } mergePreferenceProviderDataChange(change) { if (!this.deferredChanges) { this.deferredChanges = {}; } const key = `${change.preferenceName}.${change.overrideIdentifier}`; // works for "undefined", as well const current = this.deferredChanges[key]; const { newValue, scope, domain } = change; if (!current) { // new this.deferredChanges[key] = change; } else if (current.oldValue === newValue) { // delete delete this.deferredChanges[key]; } else { // update Object.assign(current, { newValue, scope, domain }); } } dispose() { this.toDispose.dispose(); } } /** * The {@link PreferenceProvider} is used to store and retrieve preference values. A {@link PreferenceProvider} does not operate in a global scope but is * configured for one or more {@link PreferenceScope}s. The (default implementation for the) {@link PreferenceService} aggregates all {@link PreferenceProvider}s and * serves as a common facade for manipulating preference values. */ let PreferenceProviderImpl = class PreferenceProviderImpl extends PreferenceProviderBase { constructor() { super(); this._ready = new Deferred(); } get(preferenceName, resourceUri, overrideIdentifier) { return this.resolve(preferenceName, resourceUri, overrideIdentifier).value; } resolve(preferenceName, resourceUri, overrideIdentifier) { const preferences = this.getPreferences(resourceUri); const key = overrideIdentifier ? `[${overrideIdentifier}].${preferenceName}` : preferenceName; const value = preferences[key]; if (value !== undefined) { return { value: value, configUri: this.getConfigUri(resourceUri) }; } return {}; } /** * Resolved when the preference provider is ready to provide preferences * It should be resolved by subclasses. */ get ready() { return this._ready.promise; } /** * Retrieve the domain for this provider. * * @returns the domain or `undefined` if this provider is suitable for all domains. */ getDomain() { return undefined; } getConfigUri(resourceUri, sectionName) { return undefined; } getParsedContent(jsonData) { const preferences = {}; if (!isObject(jsonData)) { return preferences; } for (const [preferenceName, preferenceValue] of Object.entries(jsonData)) { if (PreferenceLanguageOverrideService.testOverrideValue(preferenceName, preferenceValue)) { for (const [overriddenPreferenceName, overriddenValue] of Object.entries(preferenceValue)) { preferences[`${preferenceName}.${overriddenPreferenceName}`] = overriddenValue; } } else { preferences[preferenceName] = preferenceValue; } } return preferences; } canHandleScope(scope) { return true; } }; PreferenceProviderImpl = __decorate([ injectable() ], PreferenceProviderImpl); export { PreferenceProviderImpl }; //# sourceMappingURL=preference-provider-impl.js.map