@theia/core/src/common/preferences/defaults-preference-provider.ts

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

// *****************************************************************************
// Copyright (C) 2025 STMicroelectronics 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 { JSONObject, JSONValue } from '@lumino/coreutils';
import { PreferenceScope } from './preference-scope';
import { PreferenceProvider, PreferenceProviderDataChange, PreferenceProviderDataChanges, PreferenceResolveResult } from './preference-provider';
import { inject, injectable, postConstruct } from 'inversify';
import { PreferenceSchemaService } from './preference-schema';
import { Deferred } from '../promise-util';
import { PreferenceLanguageOverrideService } from './preference-language-override-service';
import { PreferenceProviderBase } from './preference-provider-impl';

// *****************************************************************************

@injectable()
export class DefaultsPreferenceProvider extends PreferenceProviderBase implements PreferenceProvider {

    @inject(PreferenceSchemaService)
    protected readonly preferenceSchemaService: PreferenceSchemaService;

    @inject(PreferenceLanguageOverrideService)
    protected readonly preferenceOverrideService: PreferenceLanguageOverrideService;

    protected readonly _ready = new Deferred<void>();
    ready: Promise<void> = this._ready.promise;

    @postConstruct()
    init(): void {
        this.toDispose.push(this.preferenceSchemaService.onDidChangeDefaultValue(e => {
            const changes: PreferenceProviderDataChanges = {};
            if (e.overrideIdentifier) {
                changes[e.key] = this.changeFor(e.key, e.overrideIdentifier, e.oldValue, e.newValue);
            } else {
                changes[e.key] = this.changeFor(e.key, undefined, e.oldValue, e.newValue);
                for (const override of e.otherAffectedOverrides) {
                    const change = this.changeFor(e.key, override, e.oldValue, e.newValue);
                    changes[change.preferenceName] = change;
                }
            }
            this.emitPreferencesChangedEvent(changes);
        }));
        this._ready.resolve();
    }

    protected changeFor(key: string, overrideIdentifier: string | undefined, oldValue: JSONValue | undefined, newValue: JSONValue | undefined): PreferenceProviderDataChange {
        const preferenceName = overrideIdentifier ? this.preferenceOverrideService.overridePreferenceName({ preferenceName: key, overrideIdentifier }) : key;

        return {
            preferenceName: preferenceName,
            newValue: newValue,
            oldValue: oldValue,
            scope: PreferenceScope.Default
        };
    }

    canHandleScope(scope: PreferenceScope): boolean {
        return scope === PreferenceScope.Default;
    }
    get<T>(preferenceName: string, resourceUri?: string): T | undefined {
        const overrideInfo = this.preferenceOverrideService.overriddenPreferenceName(preferenceName);
        return this.preferenceSchemaService.getDefaultValue(overrideInfo?.preferenceName ?? preferenceName, overrideInfo?.overrideIdentifier) as T;
    }

    setPreference(key: string, value: JSONValue, resourceUri?: string): Promise<boolean> {
        return Promise.resolve(false);
    }

    resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T> {
        const overrideInfo = this.preferenceOverrideService.overriddenPreferenceName(preferenceName);
        return {
            value: this.preferenceSchemaService.inspectDefaultValue(overrideInfo?.preferenceName ?? preferenceName, overrideInfo?.overrideIdentifier) as T,
            configUri: undefined
        };
    }

    getPreferences(): JSONObject {
        return this.preferenceSchemaService.getDefaultValues();
    }
}