|
1 | | -/* -------------------------------------------------------------------------------------------- |
2 | | - * Copyright (c) Microsoft Corporation. All Rights Reserved. |
3 | | - * See 'LICENSE' in the project root for license information. |
4 | | - * ------------------------------------------------------------------------------------------ */ |
5 | | -'use strict'; |
6 | | - |
7 | | -import { CustomConfigurationProvider, Version } from 'vscode-cpptools'; |
8 | | -import { CppToolsTestApi, CppToolsTestHook } from 'vscode-cpptools/out/testApi'; |
9 | | -import * as nls from 'vscode-nls'; |
10 | | -import { CustomConfigurationProvider1, CustomConfigurationProviderCollection, getCustomConfigProviders } from './LanguageServer/customProviders'; |
11 | | -import * as LanguageServer from './LanguageServer/extension'; |
12 | | -import { getOutputChannelLogger } from './logger'; |
13 | | -import * as test from './testHook'; |
14 | | - |
15 | | -nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })(); |
16 | | -const localize: nls.LocalizeFunc = nls.loadMessageBundle(); |
17 | | - |
18 | | -export class CppTools implements CppToolsTestApi { |
19 | | - private version: Version; |
20 | | - private providers: CustomConfigurationProvider1[] = []; |
21 | | - private failedRegistrations: CustomConfigurationProvider[] = []; |
22 | | - private timers = new Map<string, NodeJS.Timeout>(); |
23 | | - |
24 | | - constructor(version: Version) { |
25 | | - if (version > Version.latest) { |
26 | | - console.warn(`version ${version} is not supported by this version of cpptools`); |
27 | | - console.warn(` using ${Version.latest} instead`); |
28 | | - version = Version.latest; |
29 | | - } |
30 | | - this.version = version; |
31 | | - } |
32 | | - |
33 | | - private addNotifyReadyTimer(provider: CustomConfigurationProvider1): void { |
34 | | - if (this.version >= Version.v2) { |
35 | | - const timeout: number = 30; |
36 | | - const timer: NodeJS.Timeout = global.setTimeout(() => { |
37 | | - console.warn(`registered provider ${provider.extensionId} did not call 'notifyReady' within ${timeout} seconds`); |
38 | | - }, timeout * 1000); |
39 | | - this.timers.set(provider.extensionId, timer); |
40 | | - } |
41 | | - } |
42 | | - |
43 | | - private removeNotifyReadyTimer(provider: CustomConfigurationProvider1): void { |
44 | | - if (this.version >= Version.v2) { |
45 | | - const timer: NodeJS.Timeout | undefined = this.timers.get(provider.extensionId); |
46 | | - if (timer) { |
47 | | - this.timers.delete(provider.extensionId); |
48 | | - clearTimeout(timer); |
49 | | - } |
50 | | - } |
51 | | - } |
52 | | - |
53 | | - public getVersion(): Version { |
54 | | - return this.version; |
55 | | - } |
56 | | - |
57 | | - public registerCustomConfigurationProvider(provider: CustomConfigurationProvider): void { |
58 | | - const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
59 | | - if (providers.add(provider, this.version)) { |
60 | | - const added: CustomConfigurationProvider1 | undefined = providers.get(provider); |
61 | | - if (added) { |
62 | | - getOutputChannelLogger().appendLineAtLevel(5, localize("provider.registered", "Custom configuration provider '{0}' registered", added.name)); |
63 | | - this.providers.push(added); |
64 | | - LanguageServer.getClients().forEach(client => void client.onRegisterCustomConfigurationProvider(added)); |
65 | | - this.addNotifyReadyTimer(added); |
66 | | - } |
67 | | - } else { |
68 | | - this.failedRegistrations.push(provider); |
69 | | - } |
70 | | - } |
71 | | - |
72 | | - public notifyReady(provider: CustomConfigurationProvider): void { |
73 | | - const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
74 | | - const p: CustomConfigurationProvider1 | undefined = providers.get(provider); |
75 | | - |
76 | | - if (p) { |
77 | | - this.removeNotifyReadyTimer(p); |
78 | | - p.isReady = true; |
79 | | - LanguageServer.getClients().forEach(client => { |
80 | | - void client.updateCustomBrowseConfiguration(p); |
81 | | - void client.updateCustomConfigurations(p); |
82 | | - }); |
83 | | - } else if (this.failedRegistrations.find(p => p === provider)) { |
84 | | - console.warn("provider not successfully registered; 'notifyReady' ignored"); |
85 | | - } else { |
86 | | - console.warn("provider should be registered before signaling it's ready to provide configurations"); |
87 | | - } |
88 | | - } |
89 | | - |
90 | | - public didChangeCustomConfiguration(provider: CustomConfigurationProvider): void { |
91 | | - const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
92 | | - const p: CustomConfigurationProvider1 | undefined = providers.get(provider); |
93 | | - |
94 | | - if (p) { |
95 | | - if (!p.isReady) { |
96 | | - console.warn("didChangeCustomConfiguration was invoked before notifyReady"); |
97 | | - } |
98 | | - LanguageServer.getClients().forEach(client => void client.updateCustomConfigurations(p)); |
99 | | - } else if (this.failedRegistrations.find(p => p === provider)) { |
100 | | - console.warn("provider not successfully registered, 'didChangeCustomConfiguration' ignored"); |
101 | | - } else { |
102 | | - console.warn("provider should be registered before sending config change messages"); |
103 | | - } |
104 | | - } |
105 | | - |
106 | | - public didChangeCustomBrowseConfiguration(provider: CustomConfigurationProvider): void { |
107 | | - const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
108 | | - const p: CustomConfigurationProvider1 | undefined = providers.get(provider); |
109 | | - |
110 | | - if (p) { |
111 | | - LanguageServer.getClients().forEach(client => void client.updateCustomBrowseConfiguration(p)); |
112 | | - } else if (this.failedRegistrations.find(p => p === provider)) { |
113 | | - console.warn("provider not successfully registered, 'didChangeCustomBrowseConfiguration' ignored"); |
114 | | - } else { |
115 | | - console.warn("provider should be registered before sending config change messages"); |
116 | | - } |
117 | | - } |
118 | | - |
119 | | - public dispose(): void { |
120 | | - this.providers.forEach(provider => { |
121 | | - getCustomConfigProviders().remove(provider); |
122 | | - provider.dispose(); |
123 | | - }); |
124 | | - this.providers = []; |
125 | | - } |
126 | | - |
127 | | - public getTestHook(): CppToolsTestHook { |
128 | | - return test.getTestHook(); |
129 | | - } |
130 | | -} |
| 1 | +/* -------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) Microsoft Corporation. All Rights Reserved. |
| 3 | + * See 'LICENSE' in the project root for license information. |
| 4 | + * ------------------------------------------------------------------------------------------ */ |
| 5 | +'use strict'; |
| 6 | + |
| 7 | +import { CustomConfigurationProvider, Version } from 'vscode-cpptools'; |
| 8 | +import { CppToolsTestApi, CppToolsTestHook } from 'vscode-cpptools/out/testApi'; |
| 9 | +import * as nls from 'vscode-nls'; |
| 10 | +import { CustomConfigurationProvider1, CustomConfigurationProviderCollection, getCustomConfigProviders } from './LanguageServer/customProviders'; |
| 11 | +import * as LanguageServer from './LanguageServer/extension'; |
| 12 | +import { getOutputChannelLogger } from './logger'; |
| 13 | +import * as test from './testHook'; |
| 14 | + |
| 15 | +nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })(); |
| 16 | +const localize: nls.LocalizeFunc = nls.loadMessageBundle(); |
| 17 | + |
| 18 | +export class CppTools implements CppToolsTestApi { |
| 19 | + private version: Version; |
| 20 | + private providers: CustomConfigurationProvider1[] = []; |
| 21 | + private failedRegistrations: CustomConfigurationProvider[] = []; |
| 22 | + private timers = new Map<string, NodeJS.Timeout>(); |
| 23 | + |
| 24 | + constructor(version: Version) { |
| 25 | + if (version > Version.latest) { |
| 26 | + console.warn(`version ${version} is not supported by this version of cpptools`); |
| 27 | + console.warn(` using ${Version.latest} instead`); |
| 28 | + version = Version.latest; |
| 29 | + } |
| 30 | + this.version = version; |
| 31 | + } |
| 32 | + |
| 33 | + private addNotifyReadyTimer(provider: CustomConfigurationProvider1): void { |
| 34 | + if (this.version >= Version.v2) { |
| 35 | + const timeout: number = 30; |
| 36 | + const timer: NodeJS.Timeout = global.setTimeout(() => { |
| 37 | + console.warn(`registered provider ${provider.extensionId} did not call 'notifyReady' within ${timeout} seconds`); |
| 38 | + }, timeout * 1000); |
| 39 | + this.timers.set(provider.extensionId, timer); |
| 40 | + } |
| 41 | + } |
| 42 | + |
| 43 | + private removeNotifyReadyTimer(provider: CustomConfigurationProvider1): void { |
| 44 | + if (this.version >= Version.v2) { |
| 45 | + const timer: NodeJS.Timeout | undefined = this.timers.get(provider.extensionId); |
| 46 | + if (timer) { |
| 47 | + this.timers.delete(provider.extensionId); |
| 48 | + clearTimeout(timer); |
| 49 | + } |
| 50 | + } |
| 51 | + } |
| 52 | + |
| 53 | + public getVersion(): Version { |
| 54 | + return this.version; |
| 55 | + } |
| 56 | + |
| 57 | + public registerCustomConfigurationProvider(provider: CustomConfigurationProvider): void { |
| 58 | + const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
| 59 | + if (providers.add(provider, this.version)) { |
| 60 | + const added: CustomConfigurationProvider1 | undefined = providers.get(provider); |
| 61 | + if (added) { |
| 62 | + getOutputChannelLogger().appendLineAtLevel(5, localize("provider.registered", "Custom configuration provider '{0}' registered", added.name)); |
| 63 | + this.providers.push(added); |
| 64 | + LanguageServer.getClients().forEach(client => void client.onRegisterCustomConfigurationProvider(added)); |
| 65 | + this.addNotifyReadyTimer(added); |
| 66 | + } |
| 67 | + } else { |
| 68 | + this.failedRegistrations.push(provider); |
| 69 | + } |
| 70 | + } |
| 71 | + |
| 72 | + public notifyReady(provider: CustomConfigurationProvider): void { |
| 73 | + const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
| 74 | + const p: CustomConfigurationProvider1 | undefined = providers.get(provider); |
| 75 | + |
| 76 | + if (p) { |
| 77 | + this.removeNotifyReadyTimer(p); |
| 78 | + p.isReady = true; |
| 79 | + LanguageServer.getClients().forEach(client => { |
| 80 | + void client.updateCustomBrowseConfiguration(p); |
| 81 | + void client.updateCustomConfigurations(p); |
| 82 | + }); |
| 83 | + } else if (this.failedRegistrations.find(p => p === provider)) { |
| 84 | + console.warn("provider not successfully registered; 'notifyReady' ignored"); |
| 85 | + } else { |
| 86 | + console.warn("provider should be registered before signaling it's ready to provide configurations"); |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + public didChangeCustomConfiguration(provider: CustomConfigurationProvider): void { |
| 91 | + const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
| 92 | + const p: CustomConfigurationProvider1 | undefined = providers.get(provider); |
| 93 | + |
| 94 | + if (p) { |
| 95 | + if (!p.isReady) { |
| 96 | + console.warn("didChangeCustomConfiguration was invoked before notifyReady"); |
| 97 | + } |
| 98 | + LanguageServer.getClients().forEach(client => void client.updateCustomConfigurations(p)); |
| 99 | + } else if (this.failedRegistrations.find(p => p === provider)) { |
| 100 | + console.warn("provider not successfully registered, 'didChangeCustomConfiguration' ignored"); |
| 101 | + } else { |
| 102 | + console.warn("provider should be registered before sending config change messages"); |
| 103 | + } |
| 104 | + } |
| 105 | + |
| 106 | + public didChangeCustomBrowseConfiguration(provider: CustomConfigurationProvider): void { |
| 107 | + const providers: CustomConfigurationProviderCollection = getCustomConfigProviders(); |
| 108 | + const p: CustomConfigurationProvider1 | undefined = providers.get(provider); |
| 109 | + |
| 110 | + if (p) { |
| 111 | + LanguageServer.getClients().forEach(client => void client.updateCustomBrowseConfiguration(p)); |
| 112 | + } else if (this.failedRegistrations.find(p => p === provider)) { |
| 113 | + console.warn("provider not successfully registered, 'didChangeCustomBrowseConfiguration' ignored"); |
| 114 | + } else { |
| 115 | + console.warn("provider should be registered before sending config change messages"); |
| 116 | + } |
| 117 | + } |
| 118 | + |
| 119 | + public dispose(): void { |
| 120 | + this.providers.forEach(provider => { |
| 121 | + getCustomConfigProviders().remove(provider); |
| 122 | + provider.dispose(); |
| 123 | + }); |
| 124 | + this.providers = []; |
| 125 | + } |
| 126 | + |
| 127 | + public getTestHook(): CppToolsTestHook { |
| 128 | + return test.getTestHook(); |
| 129 | + } |
| 130 | +} |
0 commit comments