1 | import { JSONValue } from '@phosphor/coreutils';
|
2 | import URI from '../../common/uri';
|
3 | import { Disposable, DisposableCollection, Emitter, Event } from '../../common';
|
4 | import { Deferred } from '../../common/promise-util';
|
5 | import { PreferenceScope } from './preference-scope';
|
6 | import { PreferenceLanguageOverrideService } from './preference-language-override-service';
|
7 | export interface PreferenceProviderDataChange {
|
8 | |
9 |
|
10 |
|
11 | readonly preferenceName: string;
|
12 | |
13 |
|
14 |
|
15 | readonly newValue?: any;
|
16 | |
17 |
|
18 |
|
19 | readonly oldValue?: any;
|
20 | |
21 |
|
22 |
|
23 | readonly scope: PreferenceScope;
|
24 | |
25 |
|
26 |
|
27 | readonly domain?: string[];
|
28 | }
|
29 | export declare namespace PreferenceProviderDataChange {
|
30 | function affects(change: PreferenceProviderDataChange, resourceUri?: string): boolean;
|
31 | }
|
32 | export interface PreferenceProviderDataChanges {
|
33 | [preferenceName: string]: PreferenceProviderDataChange;
|
34 | }
|
35 | export interface PreferenceResolveResult<T> {
|
36 | configUri?: URI;
|
37 | value?: T;
|
38 | }
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 | export declare abstract class PreferenceProvider implements Disposable {
|
45 | protected readonly preferenceOverrideService: PreferenceLanguageOverrideService;
|
46 | protected readonly onDidPreferencesChangedEmitter: Emitter<PreferenceProviderDataChanges>;
|
47 | readonly onDidPreferencesChanged: Event<PreferenceProviderDataChanges>;
|
48 | protected readonly toDispose: DisposableCollection;
|
49 | protected readonly _ready: Deferred<void>;
|
50 | constructor();
|
51 | dispose(): void;
|
52 | protected deferredChanges: PreferenceProviderDataChanges | undefined;
|
53 | /**
|
54 | * Informs the listeners that one or more preferences of this provider are changed.
|
55 | * The listeners are able to find what was changed from the emitted event.
|
56 | */
|
57 | protected emitPreferencesChangedEvent(changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]): Promise<boolean>;
|
58 | protected mergePreferenceProviderDataChange(change: PreferenceProviderDataChange): void;
|
59 | protected fireDidPreferencesChanged: () => Promise<boolean>;
|
60 | /**
|
61 | * Retrieve the stored value for the given preference and resource URI.
|
62 | *
|
63 | * @param preferenceName the preference identifier.
|
64 | * @param resourceUri the uri of the resource for which the preference is stored. This is used to retrieve
|
65 | * a potentially different value for the same preference for different resources, for example `files.encoding`.
|
66 | *
|
67 | * @returns the value stored for the given preference and resourceUri if it exists, otherwise `undefined`.
|
68 | */
|
69 | get<T>(preferenceName: string, resourceUri?: string): T | undefined;
|
70 | /**
|
71 | * Resolve the value for the given preference and resource URI.
|
72 | *
|
73 | * @param preferenceName the preference identifier.
|
74 | * @param resourceUri the URI of the resource for which this provider should resolve the preference. This is used to retrieve
|
75 | * a potentially different value for the same preference for different resources, for example `files.encoding`.
|
76 | *
|
77 | * @returns an object containing the value stored for the given preference and resourceUri if it exists,
|
78 | * otherwise `undefined`.
|
79 | */
|
80 | resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T>;
|
81 | abstract getPreferences(resourceUri?: string): {
|
82 | [p: string]: any;
|
83 | };
|
84 | |
85 |
|
86 |
|
87 |
|
88 |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 |
|
94 |
|
95 | abstract setPreference(key: string, value: any, resourceUri?: string): Promise<boolean>;
|
96 | |
97 |
|
98 |
|
99 |
|
100 | get ready(): Promise<void>;
|
101 | |
102 |
|
103 |
|
104 |
|
105 |
|
106 | getDomain(): string[] | undefined;
|
107 | |
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 | getConfigUri(resourceUri?: string, sectionName?: string): URI | undefined;
|
115 | |
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 | getContainingConfigUri?(resourceUri?: string, sectionName?: string): URI | undefined;
|
123 | static merge(source: JSONValue | undefined, target: JSONValue): JSONValue;
|
124 | |
125 |
|
126 |
|
127 | static deepEqual(a: JSONValue | undefined, b: JSONValue | undefined): boolean;
|
128 | protected getParsedContent(jsonData: any): {
|
129 | [key: string]: any;
|
130 | };
|
131 | }
|
132 |
|
\ | No newline at end of file |