@cleanslate/sdk 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +22 -0
- package/NOTICE +48 -0
- package/README.md +103 -0
- package/VENDOR.md +60 -0
- package/dist/agent/cleanSlateAgentExecutionPhase.d.ts +55 -0
- package/dist/agent/cleanSlateAgentExecutionPhase.d.ts.map +1 -0
- package/dist/agent/cleanSlateAgentExecutionPhase.js +474 -0
- package/dist/agent/cleanSlateAgentExecutionPhase.js.map +1 -0
- package/dist/agent/cleanSlateAgentExecutionSupport.d.ts +22 -0
- package/dist/agent/cleanSlateAgentExecutionSupport.d.ts.map +1 -0
- package/dist/agent/cleanSlateAgentExecutionSupport.js +205 -0
- package/dist/agent/cleanSlateAgentExecutionSupport.js.map +1 -0
- package/dist/agent/cleanSlateAgentParsing.d.ts +21 -0
- package/dist/agent/cleanSlateAgentParsing.d.ts.map +1 -0
- package/dist/agent/cleanSlateAgentParsing.js +106 -0
- package/dist/agent/cleanSlateAgentParsing.js.map +1 -0
- package/dist/agent/cleanSlateAgentSession.d.ts +44 -0
- package/dist/agent/cleanSlateAgentSession.d.ts.map +1 -0
- package/dist/agent/cleanSlateAgentSession.js +205 -0
- package/dist/agent/cleanSlateAgentSession.js.map +1 -0
- package/dist/agent/cleanSlateAgentTypes.d.ts +91 -0
- package/dist/agent/cleanSlateAgentTypes.d.ts.map +1 -0
- package/dist/agent/cleanSlateAgentTypes.js +27 -0
- package/dist/agent/cleanSlateAgentTypes.js.map +1 -0
- package/dist/agent/cleanSlateCommandPolicy.d.ts +12 -0
- package/dist/agent/cleanSlateCommandPolicy.d.ts.map +1 -0
- package/dist/agent/cleanSlateCommandPolicy.js +30 -0
- package/dist/agent/cleanSlateCommandPolicy.js.map +1 -0
- package/dist/agent/cleanSlateContextBudgetManager.d.ts +82 -0
- package/dist/agent/cleanSlateContextBudgetManager.d.ts.map +1 -0
- package/dist/agent/cleanSlateContextBudgetManager.js +419 -0
- package/dist/agent/cleanSlateContextBudgetManager.js.map +1 -0
- package/dist/agent/cleanSlateDomainProfile.d.ts +71 -0
- package/dist/agent/cleanSlateDomainProfile.d.ts.map +1 -0
- package/dist/agent/cleanSlateDomainProfile.js +124 -0
- package/dist/agent/cleanSlateDomainProfile.js.map +1 -0
- package/dist/agent/cleanSlateExecutionBudget.d.ts +19 -0
- package/dist/agent/cleanSlateExecutionBudget.d.ts.map +1 -0
- package/dist/agent/cleanSlateExecutionBudget.js +28 -0
- package/dist/agent/cleanSlateExecutionBudget.js.map +1 -0
- package/dist/agent/cleanSlateExecutionEditPolicy.d.ts +15 -0
- package/dist/agent/cleanSlateExecutionEditPolicy.d.ts.map +1 -0
- package/dist/agent/cleanSlateExecutionEditPolicy.js +148 -0
- package/dist/agent/cleanSlateExecutionEditPolicy.js.map +1 -0
- package/dist/agent/cleanSlateExecutionEvidenceLedger.d.ts +23 -0
- package/dist/agent/cleanSlateExecutionEvidenceLedger.d.ts.map +1 -0
- package/dist/agent/cleanSlateExecutionEvidenceLedger.js +121 -0
- package/dist/agent/cleanSlateExecutionEvidenceLedger.js.map +1 -0
- package/dist/agent/cleanSlateExecutionLoopPrompts.d.ts +5 -0
- package/dist/agent/cleanSlateExecutionLoopPrompts.d.ts.map +1 -0
- package/dist/agent/cleanSlateExecutionLoopPrompts.js +41 -0
- package/dist/agent/cleanSlateExecutionLoopPrompts.js.map +1 -0
- package/dist/agent/cleanSlateExecutionQuery.d.ts +162 -0
- package/dist/agent/cleanSlateExecutionQuery.d.ts.map +1 -0
- package/dist/agent/cleanSlateExecutionQuery.js +1448 -0
- package/dist/agent/cleanSlateExecutionQuery.js.map +1 -0
- package/dist/agent/cleanSlateFilesModifiedService.d.ts +96 -0
- package/dist/agent/cleanSlateFilesModifiedService.d.ts.map +1 -0
- package/dist/agent/cleanSlateFilesModifiedService.js +581 -0
- package/dist/agent/cleanSlateFilesModifiedService.js.map +1 -0
- package/dist/agent/cleanSlateNativeToolTranscript.d.ts +22 -0
- package/dist/agent/cleanSlateNativeToolTranscript.d.ts.map +1 -0
- package/dist/agent/cleanSlateNativeToolTranscript.js +77 -0
- package/dist/agent/cleanSlateNativeToolTranscript.js.map +1 -0
- package/dist/agent/cleanSlatePrompts.d.ts +30 -0
- package/dist/agent/cleanSlatePrompts.d.ts.map +1 -0
- package/dist/agent/cleanSlatePrompts.js +65 -0
- package/dist/agent/cleanSlatePrompts.js.map +1 -0
- package/dist/agent/cleanSlateQueryRunner.d.ts +56 -0
- package/dist/agent/cleanSlateQueryRunner.d.ts.map +1 -0
- package/dist/agent/cleanSlateQueryRunner.js +69 -0
- package/dist/agent/cleanSlateQueryRunner.js.map +1 -0
- package/dist/agent/cleanSlateRuntimePromptBuilder.d.ts +30 -0
- package/dist/agent/cleanSlateRuntimePromptBuilder.d.ts.map +1 -0
- package/dist/agent/cleanSlateRuntimePromptBuilder.js +99 -0
- package/dist/agent/cleanSlateRuntimePromptBuilder.js.map +1 -0
- package/dist/agent/cleanSlateStreamingToolExecutor.d.ts +55 -0
- package/dist/agent/cleanSlateStreamingToolExecutor.d.ts.map +1 -0
- package/dist/agent/cleanSlateStreamingToolExecutor.js +214 -0
- package/dist/agent/cleanSlateStreamingToolExecutor.js.map +1 -0
- package/dist/agent/cleanSlateToolCallLedger.d.ts +32 -0
- package/dist/agent/cleanSlateToolCallLedger.d.ts.map +1 -0
- package/dist/agent/cleanSlateToolCallLedger.js +164 -0
- package/dist/agent/cleanSlateToolCallLedger.js.map +1 -0
- package/dist/agent/cleanSlateToolResultPromptSerializer.d.ts +9 -0
- package/dist/agent/cleanSlateToolResultPromptSerializer.d.ts.map +1 -0
- package/dist/agent/cleanSlateToolResultPromptSerializer.js +184 -0
- package/dist/agent/cleanSlateToolResultPromptSerializer.js.map +1 -0
- package/dist/composer/commands/slashCommands.d.ts +8 -0
- package/dist/composer/commands/slashCommands.d.ts.map +1 -0
- package/dist/composer/commands/slashCommands.js +46 -0
- package/dist/composer/commands/slashCommands.js.map +1 -0
- package/dist/composer/instructions/baseInstructions.d.ts +3 -0
- package/dist/composer/instructions/baseInstructions.d.ts.map +1 -0
- package/dist/composer/instructions/baseInstructions.js +35 -0
- package/dist/composer/instructions/baseInstructions.js.map +1 -0
- package/dist/composer/instructions/runtimeInstructions.d.ts +11 -0
- package/dist/composer/instructions/runtimeInstructions.d.ts.map +1 -0
- package/dist/composer/instructions/runtimeInstructions.js +31 -0
- package/dist/composer/instructions/runtimeInstructions.js.map +1 -0
- package/dist/composer/kernel/coreKernel.d.ts +3 -0
- package/dist/composer/kernel/coreKernel.d.ts.map +1 -0
- package/dist/composer/kernel/coreKernel.js +11 -0
- package/dist/composer/kernel/coreKernel.js.map +1 -0
- package/dist/composer/kernel/editingRules.d.ts +3 -0
- package/dist/composer/kernel/editingRules.d.ts.map +1 -0
- package/dist/composer/kernel/editingRules.js +24 -0
- package/dist/composer/kernel/editingRules.js.map +1 -0
- package/dist/composer/kernel/toolProtocols.d.ts +2 -0
- package/dist/composer/kernel/toolProtocols.d.ts.map +1 -0
- package/dist/composer/kernel/toolProtocols.js +32 -0
- package/dist/composer/kernel/toolProtocols.js.map +1 -0
- package/dist/composer/modes/execution.mode.d.ts +2 -0
- package/dist/composer/modes/execution.mode.d.ts.map +1 -0
- package/dist/composer/modes/execution.mode.js +21 -0
- package/dist/composer/modes/execution.mode.js.map +1 -0
- package/dist/composer/modes/planning.mode.d.ts +2 -0
- package/dist/composer/modes/planning.mode.d.ts.map +1 -0
- package/dist/composer/modes/planning.mode.js +23 -0
- package/dist/composer/modes/planning.mode.js.map +1 -0
- package/dist/composer/promptComposer.d.ts +22 -0
- package/dist/composer/promptComposer.d.ts.map +1 -0
- package/dist/composer/promptComposer.js +62 -0
- package/dist/composer/promptComposer.js.map +1 -0
- package/dist/composer/registry/agentSchema.d.ts +16 -0
- package/dist/composer/registry/agentSchema.d.ts.map +1 -0
- package/dist/composer/registry/agentSchema.js +6 -0
- package/dist/composer/registry/agentSchema.js.map +1 -0
- package/dist/core/arrays.d.ts +311 -0
- package/dist/core/arrays.d.ts.map +1 -0
- package/dist/core/arrays.js +811 -0
- package/dist/core/arrays.js.map +1 -0
- package/dist/core/arraysFind.d.ts +72 -0
- package/dist/core/arraysFind.d.ts.map +1 -0
- package/dist/core/arraysFind.js +200 -0
- package/dist/core/arraysFind.js.map +1 -0
- package/dist/core/assert.d.ts +36 -0
- package/dist/core/assert.d.ts.map +1 -0
- package/dist/core/assert.js +84 -0
- package/dist/core/assert.js.map +1 -0
- package/dist/core/async.d.ts +11 -0
- package/dist/core/async.d.ts.map +1 -0
- package/dist/core/async.js +6 -0
- package/dist/core/async.js.map +1 -0
- package/dist/core/buffer.d.ts +23 -0
- package/dist/core/buffer.d.ts.map +1 -0
- package/dist/core/buffer.js +40 -0
- package/dist/core/buffer.js.map +1 -0
- package/dist/core/cancellation.d.ts +52 -0
- package/dist/core/cancellation.d.ts.map +1 -0
- package/dist/core/cancellation.js +169 -0
- package/dist/core/cancellation.js.map +1 -0
- package/dist/core/charCode.d.ts +428 -0
- package/dist/core/charCode.d.ts.map +1 -0
- package/dist/core/charCode.js +439 -0
- package/dist/core/charCode.js.map +1 -0
- package/dist/core/collections.d.ts +49 -0
- package/dist/core/collections.d.ts.map +1 -0
- package/dist/core/collections.js +132 -0
- package/dist/core/collections.js.map +1 -0
- package/dist/core/diff/diff.d.ts +151 -0
- package/dist/core/diff/diff.d.ts.map +1 -0
- package/dist/core/diff/diff.js +1076 -0
- package/dist/core/diff/diff.js.map +1 -0
- package/dist/core/diff/diffChange.d.ts +39 -0
- package/dist/core/diff/diffChange.d.ts.map +1 -0
- package/dist/core/diff/diffChange.js +37 -0
- package/dist/core/diff/diffChange.js.map +1 -0
- package/dist/core/errors.d.ts +114 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/errors.js +258 -0
- package/dist/core/errors.js.map +1 -0
- package/dist/core/event.d.ts +595 -0
- package/dist/core/event.d.ts.map +1 -0
- package/dist/core/event.js +1479 -0
- package/dist/core/event.js.map +1 -0
- package/dist/core/functional.d.ts +5 -0
- package/dist/core/functional.d.ts.map +1 -0
- package/dist/core/functional.js +35 -0
- package/dist/core/functional.js.map +1 -0
- package/dist/core/hash.d.ts +15 -0
- package/dist/core/hash.d.ts.map +1 -0
- package/dist/core/hash.js +27 -0
- package/dist/core/hash.js.map +1 -0
- package/dist/core/iterator.d.ts +33 -0
- package/dist/core/iterator.d.ts.map +1 -0
- package/dist/core/iterator.js +188 -0
- package/dist/core/iterator.js.map +1 -0
- package/dist/core/lifecycle.d.ts +313 -0
- package/dist/core/lifecycle.d.ts.map +1 -0
- package/dist/core/lifecycle.js +789 -0
- package/dist/core/lifecycle.js.map +1 -0
- package/dist/core/linkedList.d.ts +17 -0
- package/dist/core/linkedList.d.ts.map +1 -0
- package/dist/core/linkedList.js +138 -0
- package/dist/core/linkedList.js.map +1 -0
- package/dist/core/map.d.ts +175 -0
- package/dist/core/map.d.ts.map +1 -0
- package/dist/core/map.js +796 -0
- package/dist/core/map.js.map +1 -0
- package/dist/core/marshallingIds.d.ts +29 -0
- package/dist/core/marshallingIds.d.ts.map +1 -0
- package/dist/core/marshallingIds.js +38 -0
- package/dist/core/marshallingIds.js.map +1 -0
- package/dist/core/observable.d.ts +28 -0
- package/dist/core/observable.d.ts.map +1 -0
- package/dist/core/observable.js +6 -0
- package/dist/core/observable.js.map +1 -0
- package/dist/core/platform.d.ts +4 -0
- package/dist/core/platform.d.ts.map +1 -0
- package/dist/core/platform.js +17 -0
- package/dist/core/platform.js.map +1 -0
- package/dist/core/position.d.ts +91 -0
- package/dist/core/position.d.ts.map +1 -0
- package/dist/core/position.js +145 -0
- package/dist/core/position.js.map +1 -0
- package/dist/core/range.d.ts +198 -0
- package/dist/core/range.d.ts.map +1 -0
- package/dist/core/range.js +426 -0
- package/dist/core/range.js.map +1 -0
- package/dist/core/resources.d.ts +10 -0
- package/dist/core/resources.d.ts.map +1 -0
- package/dist/core/resources.js +126 -0
- package/dist/core/resources.js.map +1 -0
- package/dist/core/sequence.d.ts +20 -0
- package/dist/core/sequence.d.ts.map +1 -0
- package/dist/core/sequence.js +21 -0
- package/dist/core/sequence.js.map +1 -0
- package/dist/core/stopwatch.d.ts +11 -0
- package/dist/core/stopwatch.d.ts.map +1 -0
- package/dist/core/stopwatch.js +33 -0
- package/dist/core/stopwatch.js.map +1 -0
- package/dist/core/symbols.d.ts +5 -0
- package/dist/core/symbols.d.ts.map +1 -0
- package/dist/core/symbols.js +13 -0
- package/dist/core/symbols.js.map +1 -0
- package/dist/core/types.d.ts +229 -0
- package/dist/core/types.d.ts.map +1 -0
- package/dist/core/types.js +278 -0
- package/dist/core/types.js.map +1 -0
- package/dist/core/uint.d.ts +32 -0
- package/dist/core/uint.d.ts.map +1 -0
- package/dist/core/uint.js +57 -0
- package/dist/core/uint.js.map +1 -0
- package/dist/core/uri.d.ts +172 -0
- package/dist/core/uri.d.ts.map +1 -0
- package/dist/core/uri.js +623 -0
- package/dist/core/uri.js.map +1 -0
- package/dist/host/browserAutomation.d.ts +276 -0
- package/dist/host/browserAutomation.d.ts.map +1 -0
- package/dist/host/browserAutomation.js +6 -0
- package/dist/host/browserAutomation.js.map +1 -0
- package/dist/host/diagnostics.d.ts +68 -0
- package/dist/host/diagnostics.d.ts.map +1 -0
- package/dist/host/diagnostics.js +41 -0
- package/dist/host/diagnostics.js.map +1 -0
- package/dist/host/files.d.ts +70 -0
- package/dist/host/files.d.ts.map +1 -0
- package/dist/host/files.js +54 -0
- package/dist/host/files.js.map +1 -0
- package/dist/host/services.d.ts +106 -0
- package/dist/host/services.d.ts.map +1 -0
- package/dist/host/services.js +6 -0
- package/dist/host/services.js.map +1 -0
- package/dist/host/symbols.d.ts +45 -0
- package/dist/host/symbols.d.ts.map +1 -0
- package/dist/host/symbols.js +43 -0
- package/dist/host/symbols.js.map +1 -0
- package/dist/host/textModel.d.ts +83 -0
- package/dist/host/textModel.d.ts.map +1 -0
- package/dist/host/textModel.js +6 -0
- package/dist/host/textModel.js.map +1 -0
- package/dist/host/workspace.d.ts +123 -0
- package/dist/host/workspace.d.ts.map +1 -0
- package/dist/host/workspace.js +32 -0
- package/dist/host/workspace.js.map +1 -0
- package/dist/index.d.ts +40 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +26 -0
- package/dist/index.js.map +1 -0
- package/dist/node/cleanSlateAnthropicMessageAdapter.d.ts +12 -0
- package/dist/node/cleanSlateAnthropicMessageAdapter.d.ts.map +1 -0
- package/dist/node/cleanSlateAnthropicMessageAdapter.js +130 -0
- package/dist/node/cleanSlateAnthropicMessageAdapter.js.map +1 -0
- package/dist/node/cleanSlateHeadlessRunner.d.ts +63 -0
- package/dist/node/cleanSlateHeadlessRunner.d.ts.map +1 -0
- package/dist/node/cleanSlateHeadlessRunner.js +84 -0
- package/dist/node/cleanSlateHeadlessRunner.js.map +1 -0
- package/dist/node/cleanSlateNodeAgentRuntime.d.ts +94 -0
- package/dist/node/cleanSlateNodeAgentRuntime.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeAgentRuntime.js +339 -0
- package/dist/node/cleanSlateNodeAgentRuntime.js.map +1 -0
- package/dist/node/cleanSlateNodeBrowserAutomation.d.ts +279 -0
- package/dist/node/cleanSlateNodeBrowserAutomation.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeBrowserAutomation.js +470 -0
- package/dist/node/cleanSlateNodeBrowserAutomation.js.map +1 -0
- package/dist/node/cleanSlateNodeCommandService.d.ts +40 -0
- package/dist/node/cleanSlateNodeCommandService.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeCommandService.js +435 -0
- package/dist/node/cleanSlateNodeCommandService.js.map +1 -0
- package/dist/node/cleanSlateNodeFileServices.d.ts +68 -0
- package/dist/node/cleanSlateNodeFileServices.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeFileServices.js +138 -0
- package/dist/node/cleanSlateNodeFileServices.js.map +1 -0
- package/dist/node/cleanSlateNodeIndexService.d.ts +17 -0
- package/dist/node/cleanSlateNodeIndexService.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeIndexService.js +128 -0
- package/dist/node/cleanSlateNodeIndexService.js.map +1 -0
- package/dist/node/cleanSlateNodeLanguageCommands.d.ts +11 -0
- package/dist/node/cleanSlateNodeLanguageCommands.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeLanguageCommands.js +146 -0
- package/dist/node/cleanSlateNodeLanguageCommands.js.map +1 -0
- package/dist/node/cleanSlateNodeMainService.d.ts +87 -0
- package/dist/node/cleanSlateNodeMainService.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeMainService.js +1304 -0
- package/dist/node/cleanSlateNodeMainService.js.map +1 -0
- package/dist/node/cleanSlateNodeMcpClient.d.ts +20 -0
- package/dist/node/cleanSlateNodeMcpClient.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeMcpClient.js +184 -0
- package/dist/node/cleanSlateNodeMcpClient.js.map +1 -0
- package/dist/node/cleanSlateNodeSearchService.d.ts +14 -0
- package/dist/node/cleanSlateNodeSearchService.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeSearchService.js +180 -0
- package/dist/node/cleanSlateNodeSearchService.js.map +1 -0
- package/dist/node/cleanSlateNodeTextModel.d.ts +56 -0
- package/dist/node/cleanSlateNodeTextModel.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeTextModel.js +127 -0
- package/dist/node/cleanSlateNodeTextModel.js.map +1 -0
- package/dist/node/cleanSlateNodeToolContext.d.ts +50 -0
- package/dist/node/cleanSlateNodeToolContext.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeToolContext.js +134 -0
- package/dist/node/cleanSlateNodeToolContext.js.map +1 -0
- package/dist/node/cleanSlateNodeWebRetrieval.d.ts +20 -0
- package/dist/node/cleanSlateNodeWebRetrieval.d.ts.map +1 -0
- package/dist/node/cleanSlateNodeWebRetrieval.js +379 -0
- package/dist/node/cleanSlateNodeWebRetrieval.js.map +1 -0
- package/dist/node/cleanSlateOpenAIMessageAdapter.d.ts +8 -0
- package/dist/node/cleanSlateOpenAIMessageAdapter.d.ts.map +1 -0
- package/dist/node/cleanSlateOpenAIMessageAdapter.js +111 -0
- package/dist/node/cleanSlateOpenAIMessageAdapter.js.map +1 -0
- package/dist/node/cleanSlateProviderSchemaNormalizer.d.ts +18 -0
- package/dist/node/cleanSlateProviderSchemaNormalizer.d.ts.map +1 -0
- package/dist/node/cleanSlateProviderSchemaNormalizer.js +175 -0
- package/dist/node/cleanSlateProviderSchemaNormalizer.js.map +1 -0
- package/dist/node/index.d.ts +25 -0
- package/dist/node/index.d.ts.map +1 -0
- package/dist/node/index.js +28 -0
- package/dist/node/index.js.map +1 -0
- package/dist/protocol/cleanSlateAI.d.ts +964 -0
- package/dist/protocol/cleanSlateAI.d.ts.map +1 -0
- package/dist/protocol/cleanSlateAI.js +35 -0
- package/dist/protocol/cleanSlateAI.js.map +1 -0
- package/dist/protocol/cleanSlateModelCapabilities.d.ts +86 -0
- package/dist/protocol/cleanSlateModelCapabilities.d.ts.map +1 -0
- package/dist/protocol/cleanSlateModelCapabilities.js +1104 -0
- package/dist/protocol/cleanSlateModelCapabilities.js.map +1 -0
- package/dist/protocol/cleanSlateProviderMessageTransforms.d.ts +11 -0
- package/dist/protocol/cleanSlateProviderMessageTransforms.d.ts.map +1 -0
- package/dist/protocol/cleanSlateProviderMessageTransforms.js +178 -0
- package/dist/protocol/cleanSlateProviderMessageTransforms.js.map +1 -0
- package/dist/protocol/cleanSlateService.d.ts +68 -0
- package/dist/protocol/cleanSlateService.d.ts.map +1 -0
- package/dist/protocol/cleanSlateService.js +1149 -0
- package/dist/protocol/cleanSlateService.js.map +1 -0
- package/dist/services/cleanSlateCancellation.d.ts +7 -0
- package/dist/services/cleanSlateCancellation.d.ts.map +1 -0
- package/dist/services/cleanSlateCancellation.js +56 -0
- package/dist/services/cleanSlateCancellation.js.map +1 -0
- package/dist/services/cleanSlateCommandExecutionService.d.ts +25 -0
- package/dist/services/cleanSlateCommandExecutionService.d.ts.map +1 -0
- package/dist/services/cleanSlateCommandExecutionService.js +31 -0
- package/dist/services/cleanSlateCommandExecutionService.js.map +1 -0
- package/dist/services/cleanSlateDiffService.d.ts +62 -0
- package/dist/services/cleanSlateDiffService.d.ts.map +1 -0
- package/dist/services/cleanSlateDiffService.js +428 -0
- package/dist/services/cleanSlateDiffService.js.map +1 -0
- package/dist/services/cleanSlateEditMatchValidator.d.ts +63 -0
- package/dist/services/cleanSlateEditMatchValidator.d.ts.map +1 -0
- package/dist/services/cleanSlateEditMatchValidator.js +341 -0
- package/dist/services/cleanSlateEditMatchValidator.js.map +1 -0
- package/dist/services/cleanSlateEditService.d.ts +155 -0
- package/dist/services/cleanSlateEditService.d.ts.map +1 -0
- package/dist/services/cleanSlateEditService.js +848 -0
- package/dist/services/cleanSlateEditService.js.map +1 -0
- package/dist/services/cleanSlateFileHistory.d.ts +56 -0
- package/dist/services/cleanSlateFileHistory.d.ts.map +1 -0
- package/dist/services/cleanSlateFileHistory.js +157 -0
- package/dist/services/cleanSlateFileHistory.js.map +1 -0
- package/dist/services/cleanSlateTaskEvidenceCodec.d.ts +15 -0
- package/dist/services/cleanSlateTaskEvidenceCodec.d.ts.map +1 -0
- package/dist/services/cleanSlateTaskEvidenceCodec.js +151 -0
- package/dist/services/cleanSlateTaskEvidenceCodec.js.map +1 -0
- package/dist/services/cleanSlateTaskSessionService.d.ts +258 -0
- package/dist/services/cleanSlateTaskSessionService.d.ts.map +1 -0
- package/dist/services/cleanSlateTaskSessionService.js +1079 -0
- package/dist/services/cleanSlateTaskSessionService.js.map +1 -0
- package/dist/services/cleanSlateTaskState.d.ts +32 -0
- package/dist/services/cleanSlateTaskState.d.ts.map +1 -0
- package/dist/services/cleanSlateTaskState.js +40 -0
- package/dist/services/cleanSlateTaskState.js.map +1 -0
- package/dist/services/cleanSlateThreadService.d.ts +64 -0
- package/dist/services/cleanSlateThreadService.d.ts.map +1 -0
- package/dist/services/cleanSlateThreadService.js +188 -0
- package/dist/services/cleanSlateThreadService.js.map +1 -0
- package/dist/services/cleanSlateTools.d.ts +29 -0
- package/dist/services/cleanSlateTools.d.ts.map +1 -0
- package/dist/services/cleanSlateTools.js +38 -0
- package/dist/services/cleanSlateTools.js.map +1 -0
- package/dist/services/cleanSlateVerificationTargetTracker.d.ts +23 -0
- package/dist/services/cleanSlateVerificationTargetTracker.d.ts.map +1 -0
- package/dist/services/cleanSlateVerificationTargetTracker.js +214 -0
- package/dist/services/cleanSlateVerificationTargetTracker.js.map +1 -0
- package/dist/skills/cleanSlateSkillCatalog.d.ts +29 -0
- package/dist/skills/cleanSlateSkillCatalog.d.ts.map +1 -0
- package/dist/skills/cleanSlateSkillCatalog.js +225 -0
- package/dist/skills/cleanSlateSkillCatalog.js.map +1 -0
- package/dist/tools/ApplyEditTool.d.ts +73 -0
- package/dist/tools/ApplyEditTool.d.ts.map +1 -0
- package/dist/tools/ApplyEditTool.js +741 -0
- package/dist/tools/ApplyEditTool.js.map +1 -0
- package/dist/tools/AskQuestionTool.d.ts +3 -0
- package/dist/tools/AskQuestionTool.d.ts.map +1 -0
- package/dist/tools/AskQuestionTool.js +113 -0
- package/dist/tools/AskQuestionTool.js.map +1 -0
- package/dist/tools/BrowserAutomationTools.d.ts +28 -0
- package/dist/tools/BrowserAutomationTools.d.ts.map +1 -0
- package/dist/tools/BrowserAutomationTools.js +639 -0
- package/dist/tools/BrowserAutomationTools.js.map +1 -0
- package/dist/tools/CreateMultipleFilesTool.d.ts +6 -0
- package/dist/tools/CreateMultipleFilesTool.d.ts.map +1 -0
- package/dist/tools/CreateMultipleFilesTool.js +115 -0
- package/dist/tools/CreateMultipleFilesTool.js.map +1 -0
- package/dist/tools/ExecuteCommandTool.d.ts +12 -0
- package/dist/tools/ExecuteCommandTool.d.ts.map +1 -0
- package/dist/tools/ExecuteCommandTool.js +378 -0
- package/dist/tools/ExecuteCommandTool.js.map +1 -0
- package/dist/tools/FileHistoryRewindTool.d.ts +3 -0
- package/dist/tools/FileHistoryRewindTool.d.ts.map +1 -0
- package/dist/tools/FileHistoryRewindTool.js +45 -0
- package/dist/tools/FileHistoryRewindTool.js.map +1 -0
- package/dist/tools/FindByNameTool.d.ts +6 -0
- package/dist/tools/FindByNameTool.d.ts.map +1 -0
- package/dist/tools/FindByNameTool.js +80 -0
- package/dist/tools/FindByNameTool.js.map +1 -0
- package/dist/tools/FindReferencesTool.d.ts +3 -0
- package/dist/tools/FindReferencesTool.d.ts.map +1 -0
- package/dist/tools/FindReferencesTool.js +128 -0
- package/dist/tools/FindReferencesTool.js.map +1 -0
- package/dist/tools/GetDefinitionsTool.d.ts +3 -0
- package/dist/tools/GetDefinitionsTool.d.ts.map +1 -0
- package/dist/tools/GetDefinitionsTool.js +136 -0
- package/dist/tools/GetDefinitionsTool.js.map +1 -0
- package/dist/tools/GetOpenFilesTool.d.ts +6 -0
- package/dist/tools/GetOpenFilesTool.d.ts.map +1 -0
- package/dist/tools/GetOpenFilesTool.js +21 -0
- package/dist/tools/GetOpenFilesTool.js.map +1 -0
- package/dist/tools/GrepSearchTool.d.ts +7 -0
- package/dist/tools/GrepSearchTool.d.ts.map +1 -0
- package/dist/tools/GrepSearchTool.js +95 -0
- package/dist/tools/GrepSearchTool.js.map +1 -0
- package/dist/tools/ListDirTool.d.ts +6 -0
- package/dist/tools/ListDirTool.d.ts.map +1 -0
- package/dist/tools/ListDirTool.js +39 -0
- package/dist/tools/ListDirTool.js.map +1 -0
- package/dist/tools/MCPTools.d.ts +6 -0
- package/dist/tools/MCPTools.d.ts.map +1 -0
- package/dist/tools/MCPTools.js +103 -0
- package/dist/tools/MCPTools.js.map +1 -0
- package/dist/tools/MultiFileReplaceTool.d.ts +6 -0
- package/dist/tools/MultiFileReplaceTool.d.ts.map +1 -0
- package/dist/tools/MultiFileReplaceTool.js +345 -0
- package/dist/tools/MultiFileReplaceTool.js.map +1 -0
- package/dist/tools/ReadFileRangeTool.d.ts +6 -0
- package/dist/tools/ReadFileRangeTool.d.ts.map +1 -0
- package/dist/tools/ReadFileRangeTool.js +150 -0
- package/dist/tools/ReadFileRangeTool.js.map +1 -0
- package/dist/tools/ReadFileTool.d.ts +6 -0
- package/dist/tools/ReadFileTool.d.ts.map +1 -0
- package/dist/tools/ReadFileTool.js +183 -0
- package/dist/tools/ReadFileTool.js.map +1 -0
- package/dist/tools/ReadLintsTool.d.ts +6 -0
- package/dist/tools/ReadLintsTool.d.ts.map +1 -0
- package/dist/tools/ReadLintsTool.js +83 -0
- package/dist/tools/ReadLintsTool.js.map +1 -0
- package/dist/tools/ReadReferenceTool.d.ts +6 -0
- package/dist/tools/ReadReferenceTool.d.ts.map +1 -0
- package/dist/tools/ReadReferenceTool.js +24 -0
- package/dist/tools/ReadReferenceTool.js.map +1 -0
- package/dist/tools/ReadSymbolsTool.d.ts +3 -0
- package/dist/tools/ReadSymbolsTool.d.ts.map +1 -0
- package/dist/tools/ReadSymbolsTool.js +100 -0
- package/dist/tools/ReadSymbolsTool.js.map +1 -0
- package/dist/tools/SearchCodebaseTool.d.ts +6 -0
- package/dist/tools/SearchCodebaseTool.d.ts.map +1 -0
- package/dist/tools/SearchCodebaseTool.js +30 -0
- package/dist/tools/SearchCodebaseTool.js.map +1 -0
- package/dist/tools/SearchWorkspaceTool.d.ts +7 -0
- package/dist/tools/SearchWorkspaceTool.d.ts.map +1 -0
- package/dist/tools/SearchWorkspaceTool.js +21 -0
- package/dist/tools/SearchWorkspaceTool.js.map +1 -0
- package/dist/tools/SemanticSearchTool.d.ts +12 -0
- package/dist/tools/SemanticSearchTool.d.ts.map +1 -0
- package/dist/tools/SemanticSearchTool.js +46 -0
- package/dist/tools/SemanticSearchTool.js.map +1 -0
- package/dist/tools/SkillTools.d.ts +3 -0
- package/dist/tools/SkillTools.d.ts.map +1 -0
- package/dist/tools/SkillTools.js +108 -0
- package/dist/tools/SkillTools.js.map +1 -0
- package/dist/tools/SpawnWorkerTool.d.ts +6 -0
- package/dist/tools/SpawnWorkerTool.d.ts.map +1 -0
- package/dist/tools/SpawnWorkerTool.js +28 -0
- package/dist/tools/SpawnWorkerTool.js.map +1 -0
- package/dist/tools/SubmitArtifactTool.d.ts +3 -0
- package/dist/tools/SubmitArtifactTool.d.ts.map +1 -0
- package/dist/tools/SubmitArtifactTool.js +121 -0
- package/dist/tools/SubmitArtifactTool.js.map +1 -0
- package/dist/tools/UndoEditTool.d.ts +3 -0
- package/dist/tools/UndoEditTool.d.ts.map +1 -0
- package/dist/tools/UndoEditTool.js +66 -0
- package/dist/tools/UndoEditTool.js.map +1 -0
- package/dist/tools/UpdateTodoTool.d.ts +6 -0
- package/dist/tools/UpdateTodoTool.d.ts.map +1 -0
- package/dist/tools/UpdateTodoTool.js +116 -0
- package/dist/tools/UpdateTodoTool.js.map +1 -0
- package/dist/tools/WebRetrievalTools.d.ts +4 -0
- package/dist/tools/WebRetrievalTools.d.ts.map +1 -0
- package/dist/tools/WebRetrievalTools.js +169 -0
- package/dist/tools/WebRetrievalTools.js.map +1 -0
- package/dist/tools/WriteFileTool.d.ts +6 -0
- package/dist/tools/WriteFileTool.d.ts.map +1 -0
- package/dist/tools/WriteFileTool.js +145 -0
- package/dist/tools/WriteFileTool.js.map +1 -0
- package/dist/tools/cleanSlateFileReadPolicy.d.ts +33 -0
- package/dist/tools/cleanSlateFileReadPolicy.d.ts.map +1 -0
- package/dist/tools/cleanSlateFileReadPolicy.js +84 -0
- package/dist/tools/cleanSlateFileReadPolicy.js.map +1 -0
- package/dist/tools/cleanSlateHostTypes.d.ts +100 -0
- package/dist/tools/cleanSlateHostTypes.d.ts.map +1 -0
- package/dist/tools/cleanSlateHostTypes.js +6 -0
- package/dist/tools/cleanSlateHostTypes.js.map +1 -0
- package/dist/tools/cleanSlatePlanArtifactPolicy.d.ts +47 -0
- package/dist/tools/cleanSlatePlanArtifactPolicy.d.ts.map +1 -0
- package/dist/tools/cleanSlatePlanArtifactPolicy.js +126 -0
- package/dist/tools/cleanSlatePlanArtifactPolicy.js.map +1 -0
- package/dist/tools/cleanSlateStaleDiagnosticPolicy.d.ts +3 -0
- package/dist/tools/cleanSlateStaleDiagnosticPolicy.d.ts.map +1 -0
- package/dist/tools/cleanSlateStaleDiagnosticPolicy.js +13 -0
- package/dist/tools/cleanSlateStaleDiagnosticPolicy.js.map +1 -0
- package/dist/tools/languageFeatureActivation.d.ts +13 -0
- package/dist/tools/languageFeatureActivation.d.ts.map +1 -0
- package/dist/tools/languageFeatureActivation.js +95 -0
- package/dist/tools/languageFeatureActivation.js.map +1 -0
- package/dist/tools/registry.d.ts +5 -0
- package/dist/tools/registry.d.ts.map +1 -0
- package/dist/tools/registry.js +104 -0
- package/dist/tools/registry.js.map +1 -0
- package/dist/tools/structuredEditCanonicalizer.d.ts +11 -0
- package/dist/tools/structuredEditCanonicalizer.d.ts.map +1 -0
- package/dist/tools/structuredEditCanonicalizer.js +44 -0
- package/dist/tools/structuredEditCanonicalizer.js.map +1 -0
- package/dist/tools/symbolContext.d.ts +36 -0
- package/dist/tools/symbolContext.d.ts.map +1 -0
- package/dist/tools/symbolContext.js +146 -0
- package/dist/tools/symbolContext.js.map +1 -0
- package/dist/tools/symbolEditResolver.d.ts +11 -0
- package/dist/tools/symbolEditResolver.d.ts.map +1 -0
- package/dist/tools/symbolEditResolver.js +259 -0
- package/dist/tools/symbolEditResolver.js.map +1 -0
- package/dist/tools/symbolIndex.d.ts +18 -0
- package/dist/tools/symbolIndex.d.ts.map +1 -0
- package/dist/tools/symbolIndex.js +235 -0
- package/dist/tools/symbolIndex.js.map +1 -0
- package/dist/tools/types.d.ts +108 -0
- package/dist/tools/types.d.ts.map +1 -0
- package/dist/tools/types.js +6 -0
- package/dist/tools/types.js.map +1 -0
- package/dist/tools/utils.d.ts +56 -0
- package/dist/tools/utils.d.ts.map +1 -0
- package/dist/tools/utils.js +205 -0
- package/dist/tools/utils.js.map +1 -0
- package/package.json +71 -0
|
@@ -0,0 +1,1479 @@
|
|
|
1
|
+
/*---------------------------------------------------------------------------------------------
|
|
2
|
+
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
3
|
+
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
4
|
+
*--------------------------------------------------------------------------------------------*/
|
|
5
|
+
/*
|
|
6
|
+
* Vendored from microsoft/vscode (vs/base/common/event.ts) for @cleanslate/sdk.
|
|
7
|
+
* Changes: see packages/cleanslate-sdk/VENDOR.md.
|
|
8
|
+
*/
|
|
9
|
+
import { diffSets } from './collections.js';
|
|
10
|
+
import { onUnexpectedError } from './errors.js';
|
|
11
|
+
import { createSingleCallFunction } from './functional.js';
|
|
12
|
+
import { combinedDisposable, Disposable, DisposableMap, DisposableStore, toDisposable } from './lifecycle.js';
|
|
13
|
+
import { LinkedList } from './linkedList.js';
|
|
14
|
+
import { StopWatch } from './stopwatch.js';
|
|
15
|
+
// -----------------------------------------------------------------------------------------------------------------------
|
|
16
|
+
// Uncomment the next line to print warnings whenever an emitter with listeners is disposed. That is a sign of code smell.
|
|
17
|
+
// -----------------------------------------------------------------------------------------------------------------------
|
|
18
|
+
const _enableDisposeWithListenerWarning = false;
|
|
19
|
+
// -----------------------------------------------------------------------------------------------------------------------
|
|
20
|
+
// Uncomment the next line to print warnings whenever a snapshotted event is used repeatedly without cleanup.
|
|
21
|
+
// See https://github.com/microsoft/vscode/issues/142851
|
|
22
|
+
// -----------------------------------------------------------------------------------------------------------------------
|
|
23
|
+
const _enableSnapshotPotentialLeakWarning = false;
|
|
24
|
+
export var Event;
|
|
25
|
+
(function (Event) {
|
|
26
|
+
Event.None = () => Disposable.None;
|
|
27
|
+
function _addLeakageTraceLogic(options) {
|
|
28
|
+
if (_enableSnapshotPotentialLeakWarning) {
|
|
29
|
+
const { onDidAddListener: origListenerDidAdd } = options;
|
|
30
|
+
const stack = Stacktrace.create();
|
|
31
|
+
let count = 0;
|
|
32
|
+
options.onDidAddListener = () => {
|
|
33
|
+
if (++count === 2) {
|
|
34
|
+
console.warn('snapshotted emitter LIKELY used public and SHOULD HAVE BEEN created with DisposableStore. snapshotted here');
|
|
35
|
+
stack.print();
|
|
36
|
+
}
|
|
37
|
+
origListenerDidAdd?.();
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Given an event, returns another event which debounces calls and defers the listeners to a later task via a shared
|
|
43
|
+
* `setTimeout`. The event is converted into a signal (`Event<void>`) to avoid additional object creation as a
|
|
44
|
+
* result of merging events and to try prevent race conditions that could arise when using related deferred and
|
|
45
|
+
* non-deferred events.
|
|
46
|
+
*
|
|
47
|
+
* This is useful for deferring non-critical work (eg. general UI updates) to ensure it does not block critical work
|
|
48
|
+
* (eg. latency of keypress to text rendered).
|
|
49
|
+
*
|
|
50
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
51
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
52
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
53
|
+
*
|
|
54
|
+
* @param event The event source for the new event.
|
|
55
|
+
* @param flushOnListenerRemove Whether to fire all debounced events when a listener is removed. If this is not
|
|
56
|
+
* specified, some events could go missing. Use this if it's important that all events are processed, even if the
|
|
57
|
+
* listener gets disposed before the debounced event fires.
|
|
58
|
+
* @param disposable A disposable store to add the new EventEmitter to.
|
|
59
|
+
*/
|
|
60
|
+
function defer(event, flushOnListenerRemove, disposable) {
|
|
61
|
+
return debounce(event, () => void 0, 0, undefined, flushOnListenerRemove ?? true, undefined, disposable);
|
|
62
|
+
}
|
|
63
|
+
Event.defer = defer;
|
|
64
|
+
/**
|
|
65
|
+
* Given an event, returns another event which only fires once.
|
|
66
|
+
*
|
|
67
|
+
* @param event The event source for the new event.
|
|
68
|
+
*/
|
|
69
|
+
function once(event) {
|
|
70
|
+
return (listener, thisArgs = null, disposables) => {
|
|
71
|
+
// we need this, in case the event fires during the listener call
|
|
72
|
+
let didFire = false;
|
|
73
|
+
let result = undefined;
|
|
74
|
+
result = event(e => {
|
|
75
|
+
if (didFire) {
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
else if (result) {
|
|
79
|
+
result.dispose();
|
|
80
|
+
}
|
|
81
|
+
else {
|
|
82
|
+
didFire = true;
|
|
83
|
+
}
|
|
84
|
+
return listener.call(thisArgs, e);
|
|
85
|
+
}, null, disposables);
|
|
86
|
+
if (didFire) {
|
|
87
|
+
result.dispose();
|
|
88
|
+
}
|
|
89
|
+
return result;
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
Event.once = once;
|
|
93
|
+
/**
|
|
94
|
+
* Given an event, returns another event which only fires once, and only when the condition is met.
|
|
95
|
+
*
|
|
96
|
+
* @param event The event source for the new event.
|
|
97
|
+
*/
|
|
98
|
+
function onceIf(event, condition) {
|
|
99
|
+
return Event.once(Event.filter(event, condition));
|
|
100
|
+
}
|
|
101
|
+
Event.onceIf = onceIf;
|
|
102
|
+
/**
|
|
103
|
+
* Maps an event of one type into an event of another type using a mapping function, similar to how
|
|
104
|
+
* `Array.prototype.map` works.
|
|
105
|
+
*
|
|
106
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
107
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
108
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
109
|
+
*
|
|
110
|
+
* @param event The event source for the new event.
|
|
111
|
+
* @param map The mapping function.
|
|
112
|
+
* @param disposable A disposable store to add the new EventEmitter to.
|
|
113
|
+
*/
|
|
114
|
+
function map(event, map, disposable) {
|
|
115
|
+
return snapshot((listener, thisArgs = null, disposables) => event(i => listener.call(thisArgs, map(i)), null, disposables), disposable);
|
|
116
|
+
}
|
|
117
|
+
Event.map = map;
|
|
118
|
+
/**
|
|
119
|
+
* Wraps an event in another event that performs some function on the event object before firing.
|
|
120
|
+
*
|
|
121
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
122
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
123
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
124
|
+
*
|
|
125
|
+
* @param event The event source for the new event.
|
|
126
|
+
* @param each The function to perform on the event object.
|
|
127
|
+
* @param disposable A disposable store to add the new EventEmitter to.
|
|
128
|
+
*/
|
|
129
|
+
function forEach(event, each, disposable) {
|
|
130
|
+
return snapshot((listener, thisArgs = null, disposables) => event(i => { each(i); listener.call(thisArgs, i); }, null, disposables), disposable);
|
|
131
|
+
}
|
|
132
|
+
Event.forEach = forEach;
|
|
133
|
+
function filter(event, filter, disposable) {
|
|
134
|
+
return snapshot((listener, thisArgs = null, disposables) => event(e => filter(e) && listener.call(thisArgs, e), null, disposables), disposable);
|
|
135
|
+
}
|
|
136
|
+
Event.filter = filter;
|
|
137
|
+
/**
|
|
138
|
+
* Given an event, returns the same event but typed as `Event<void>`.
|
|
139
|
+
*/
|
|
140
|
+
function signal(event) {
|
|
141
|
+
return event;
|
|
142
|
+
}
|
|
143
|
+
Event.signal = signal;
|
|
144
|
+
function any(...events) {
|
|
145
|
+
return (listener, thisArgs = null, disposables) => {
|
|
146
|
+
const disposable = combinedDisposable(...events.map(event => event(e => listener.call(thisArgs, e))));
|
|
147
|
+
return addAndReturnDisposable(disposable, disposables);
|
|
148
|
+
};
|
|
149
|
+
}
|
|
150
|
+
Event.any = any;
|
|
151
|
+
/**
|
|
152
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
153
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
154
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
155
|
+
*/
|
|
156
|
+
function reduce(event, merge, initial, disposable) {
|
|
157
|
+
let output = initial;
|
|
158
|
+
return map(event, e => {
|
|
159
|
+
output = merge(output, e);
|
|
160
|
+
return output;
|
|
161
|
+
}, disposable);
|
|
162
|
+
}
|
|
163
|
+
Event.reduce = reduce;
|
|
164
|
+
function snapshot(event, disposable) {
|
|
165
|
+
let listener;
|
|
166
|
+
const options = {
|
|
167
|
+
onWillAddFirstListener() {
|
|
168
|
+
listener = event(emitter.fire, emitter);
|
|
169
|
+
},
|
|
170
|
+
onDidRemoveLastListener() {
|
|
171
|
+
listener?.dispose();
|
|
172
|
+
}
|
|
173
|
+
};
|
|
174
|
+
if (!disposable) {
|
|
175
|
+
_addLeakageTraceLogic(options);
|
|
176
|
+
}
|
|
177
|
+
const emitter = new Emitter(options);
|
|
178
|
+
disposable?.add(emitter);
|
|
179
|
+
return emitter.event;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Adds the IDisposable to the store if it's set, and returns it. Useful to
|
|
183
|
+
* Event function implementation.
|
|
184
|
+
*/
|
|
185
|
+
function addAndReturnDisposable(d, store) {
|
|
186
|
+
if (store instanceof Array) {
|
|
187
|
+
store.push(d);
|
|
188
|
+
}
|
|
189
|
+
else if (store) {
|
|
190
|
+
store.add(d);
|
|
191
|
+
}
|
|
192
|
+
return d;
|
|
193
|
+
}
|
|
194
|
+
function debounce(event, merge, delay = 100, leading = false, flushOnListenerRemove = false, leakWarningThreshold, disposable) {
|
|
195
|
+
let subscription;
|
|
196
|
+
let output = undefined;
|
|
197
|
+
let handle = undefined;
|
|
198
|
+
let numDebouncedCalls = 0;
|
|
199
|
+
let doFire;
|
|
200
|
+
const options = {
|
|
201
|
+
leakWarningThreshold,
|
|
202
|
+
onWillAddFirstListener() {
|
|
203
|
+
subscription = event(cur => {
|
|
204
|
+
numDebouncedCalls++;
|
|
205
|
+
output = merge(output, cur);
|
|
206
|
+
if (leading && !handle) {
|
|
207
|
+
emitter.fire(output);
|
|
208
|
+
output = undefined;
|
|
209
|
+
}
|
|
210
|
+
doFire = () => {
|
|
211
|
+
const _output = output;
|
|
212
|
+
output = undefined;
|
|
213
|
+
handle = undefined;
|
|
214
|
+
if (!leading || numDebouncedCalls > 1) {
|
|
215
|
+
emitter.fire(_output);
|
|
216
|
+
}
|
|
217
|
+
numDebouncedCalls = 0;
|
|
218
|
+
};
|
|
219
|
+
if (typeof delay === 'number') {
|
|
220
|
+
if (handle) {
|
|
221
|
+
clearTimeout(handle);
|
|
222
|
+
}
|
|
223
|
+
handle = setTimeout(doFire, delay);
|
|
224
|
+
}
|
|
225
|
+
else {
|
|
226
|
+
if (handle === undefined) {
|
|
227
|
+
handle = null;
|
|
228
|
+
queueMicrotask(doFire);
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
});
|
|
232
|
+
},
|
|
233
|
+
onWillRemoveListener() {
|
|
234
|
+
if (flushOnListenerRemove && numDebouncedCalls > 0) {
|
|
235
|
+
doFire?.();
|
|
236
|
+
}
|
|
237
|
+
},
|
|
238
|
+
onDidRemoveLastListener() {
|
|
239
|
+
doFire = undefined;
|
|
240
|
+
subscription.dispose();
|
|
241
|
+
}
|
|
242
|
+
};
|
|
243
|
+
if (!disposable) {
|
|
244
|
+
_addLeakageTraceLogic(options);
|
|
245
|
+
}
|
|
246
|
+
const emitter = new Emitter(options);
|
|
247
|
+
disposable?.add(emitter);
|
|
248
|
+
return emitter.event;
|
|
249
|
+
}
|
|
250
|
+
Event.debounce = debounce;
|
|
251
|
+
/**
|
|
252
|
+
* Debounces an event, firing after some delay (default=0) with an array of all event original objects.
|
|
253
|
+
*
|
|
254
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
255
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
256
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
257
|
+
*
|
|
258
|
+
* @param event The event source for the new event.
|
|
259
|
+
* @param delay The number of milliseconds to debounce.
|
|
260
|
+
* @param flushOnListenerRemove Whether to fire all debounced events when a listener is removed. If this is not
|
|
261
|
+
* specified, some events could go missing. Use this if it's important that all events are processed, even if the
|
|
262
|
+
* listener gets disposed before the debounced event fires.
|
|
263
|
+
* @param disposable A disposable store to add the new EventEmitter to.
|
|
264
|
+
*/
|
|
265
|
+
function accumulate(event, delay = 0, flushOnListenerRemove, disposable) {
|
|
266
|
+
return Event.debounce(event, (last, e) => {
|
|
267
|
+
if (!last) {
|
|
268
|
+
return [e];
|
|
269
|
+
}
|
|
270
|
+
last.push(e);
|
|
271
|
+
return last;
|
|
272
|
+
}, delay, undefined, flushOnListenerRemove ?? true, undefined, disposable);
|
|
273
|
+
}
|
|
274
|
+
Event.accumulate = accumulate;
|
|
275
|
+
function throttle(event, merge, delay = 100, leading = true, trailing = true, leakWarningThreshold, disposable) {
|
|
276
|
+
let subscription;
|
|
277
|
+
let output = undefined;
|
|
278
|
+
let handle = undefined;
|
|
279
|
+
let numThrottledCalls = 0;
|
|
280
|
+
const options = {
|
|
281
|
+
leakWarningThreshold,
|
|
282
|
+
onWillAddFirstListener() {
|
|
283
|
+
subscription = event(cur => {
|
|
284
|
+
numThrottledCalls++;
|
|
285
|
+
output = merge(output, cur);
|
|
286
|
+
// If not currently throttling, fire immediately if leading is enabled
|
|
287
|
+
if (handle === undefined) {
|
|
288
|
+
if (leading) {
|
|
289
|
+
emitter.fire(output);
|
|
290
|
+
output = undefined;
|
|
291
|
+
numThrottledCalls = 0;
|
|
292
|
+
}
|
|
293
|
+
// Set up the throttle period
|
|
294
|
+
if (typeof delay === 'number') {
|
|
295
|
+
handle = setTimeout(() => {
|
|
296
|
+
// Fire on trailing edge if there were calls during throttle period
|
|
297
|
+
if (trailing && numThrottledCalls > 0) {
|
|
298
|
+
emitter.fire(output);
|
|
299
|
+
}
|
|
300
|
+
output = undefined;
|
|
301
|
+
handle = undefined;
|
|
302
|
+
numThrottledCalls = 0;
|
|
303
|
+
}, delay);
|
|
304
|
+
}
|
|
305
|
+
else {
|
|
306
|
+
// Use a special marker to indicate microtask is pending
|
|
307
|
+
handle = 0;
|
|
308
|
+
queueMicrotask(() => {
|
|
309
|
+
// Fire on trailing edge if there were calls during throttle period
|
|
310
|
+
if (trailing && numThrottledCalls > 0) {
|
|
311
|
+
emitter.fire(output);
|
|
312
|
+
}
|
|
313
|
+
output = undefined;
|
|
314
|
+
handle = undefined;
|
|
315
|
+
numThrottledCalls = 0;
|
|
316
|
+
});
|
|
317
|
+
}
|
|
318
|
+
}
|
|
319
|
+
// If already throttling, just accumulate the value for trailing edge
|
|
320
|
+
});
|
|
321
|
+
},
|
|
322
|
+
onDidRemoveLastListener() {
|
|
323
|
+
subscription.dispose();
|
|
324
|
+
}
|
|
325
|
+
};
|
|
326
|
+
if (!disposable) {
|
|
327
|
+
_addLeakageTraceLogic(options);
|
|
328
|
+
}
|
|
329
|
+
const emitter = new Emitter(options);
|
|
330
|
+
disposable?.add(emitter);
|
|
331
|
+
return emitter.event;
|
|
332
|
+
}
|
|
333
|
+
Event.throttle = throttle;
|
|
334
|
+
/**
|
|
335
|
+
* Filters an event such that some condition is _not_ met more than once in a row, effectively ensuring duplicate
|
|
336
|
+
* event objects from different sources do not fire the same event object.
|
|
337
|
+
*
|
|
338
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
339
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
340
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
341
|
+
*
|
|
342
|
+
* @param event The event source for the new event.
|
|
343
|
+
* @param equals The equality condition.
|
|
344
|
+
* @param disposable A disposable store to add the new EventEmitter to.
|
|
345
|
+
*
|
|
346
|
+
* @example
|
|
347
|
+
* ```
|
|
348
|
+
* // Fire only one time when a single window is opened or focused
|
|
349
|
+
* Event.latch(Event.any(onDidOpenWindow, onDidFocusWindow))
|
|
350
|
+
* ```
|
|
351
|
+
*/
|
|
352
|
+
function latch(event, equals = (a, b) => a === b, disposable) {
|
|
353
|
+
let firstCall = true;
|
|
354
|
+
let cache;
|
|
355
|
+
return filter(event, value => {
|
|
356
|
+
const shouldEmit = firstCall || !equals(value, cache);
|
|
357
|
+
firstCall = false;
|
|
358
|
+
cache = value;
|
|
359
|
+
return shouldEmit;
|
|
360
|
+
}, disposable);
|
|
361
|
+
}
|
|
362
|
+
Event.latch = latch;
|
|
363
|
+
/**
|
|
364
|
+
* Splits an event whose parameter is a union type into 2 separate events for each type in the union.
|
|
365
|
+
*
|
|
366
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
367
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
368
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
369
|
+
*
|
|
370
|
+
* @example
|
|
371
|
+
* ```
|
|
372
|
+
* const event = new EventEmitter<number | undefined>().event;
|
|
373
|
+
* const [numberEvent, undefinedEvent] = Event.split(event, isUndefined);
|
|
374
|
+
* ```
|
|
375
|
+
*
|
|
376
|
+
* @param event The event source for the new event.
|
|
377
|
+
* @param isT A function that determines what event is of the first type.
|
|
378
|
+
* @param disposable A disposable store to add the new EventEmitter to.
|
|
379
|
+
*/
|
|
380
|
+
function split(event, isT, disposable) {
|
|
381
|
+
return [
|
|
382
|
+
Event.filter(event, isT, disposable),
|
|
383
|
+
Event.filter(event, e => !isT(e), disposable),
|
|
384
|
+
];
|
|
385
|
+
}
|
|
386
|
+
Event.split = split;
|
|
387
|
+
/**
|
|
388
|
+
* Buffers an event until it has a listener attached.
|
|
389
|
+
*
|
|
390
|
+
* *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
|
|
391
|
+
* event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
|
|
392
|
+
* returned event causes this utility to leak a listener on the original event.
|
|
393
|
+
*
|
|
394
|
+
* @param event The event source for the new event.
|
|
395
|
+
* @param flushAfterTimeout Determines whether to flush the buffer after a timeout immediately or after a
|
|
396
|
+
* `setTimeout` when the first event listener is added.
|
|
397
|
+
* @param _buffer Internal: A source event array used for tests.
|
|
398
|
+
*
|
|
399
|
+
* @example
|
|
400
|
+
* ```
|
|
401
|
+
* // Start accumulating events, when the first listener is attached, flush
|
|
402
|
+
* // the event after a timeout such that multiple listeners attached before
|
|
403
|
+
* // the timeout would receive the event
|
|
404
|
+
* this.onInstallExtension = Event.buffer(service.onInstallExtension, true);
|
|
405
|
+
* ```
|
|
406
|
+
*/
|
|
407
|
+
function buffer(event, flushAfterTimeout = false, _buffer = [], disposable) {
|
|
408
|
+
let buffer = _buffer.slice();
|
|
409
|
+
let listener = event(e => {
|
|
410
|
+
if (buffer) {
|
|
411
|
+
buffer.push(e);
|
|
412
|
+
}
|
|
413
|
+
else {
|
|
414
|
+
emitter.fire(e);
|
|
415
|
+
}
|
|
416
|
+
});
|
|
417
|
+
if (disposable) {
|
|
418
|
+
disposable.add(listener);
|
|
419
|
+
}
|
|
420
|
+
const flush = () => {
|
|
421
|
+
buffer?.forEach(e => emitter.fire(e));
|
|
422
|
+
buffer = null;
|
|
423
|
+
};
|
|
424
|
+
const emitter = new Emitter({
|
|
425
|
+
onWillAddFirstListener() {
|
|
426
|
+
if (!listener) {
|
|
427
|
+
listener = event(e => emitter.fire(e));
|
|
428
|
+
if (disposable) {
|
|
429
|
+
disposable.add(listener);
|
|
430
|
+
}
|
|
431
|
+
}
|
|
432
|
+
},
|
|
433
|
+
onDidAddFirstListener() {
|
|
434
|
+
if (buffer) {
|
|
435
|
+
if (flushAfterTimeout) {
|
|
436
|
+
setTimeout(flush);
|
|
437
|
+
}
|
|
438
|
+
else {
|
|
439
|
+
flush();
|
|
440
|
+
}
|
|
441
|
+
}
|
|
442
|
+
},
|
|
443
|
+
onDidRemoveLastListener() {
|
|
444
|
+
if (listener) {
|
|
445
|
+
listener.dispose();
|
|
446
|
+
}
|
|
447
|
+
listener = null;
|
|
448
|
+
}
|
|
449
|
+
});
|
|
450
|
+
if (disposable) {
|
|
451
|
+
disposable.add(emitter);
|
|
452
|
+
}
|
|
453
|
+
return emitter.event;
|
|
454
|
+
}
|
|
455
|
+
Event.buffer = buffer;
|
|
456
|
+
/**
|
|
457
|
+
* Wraps the event in an {@link IChainableEvent}, allowing a more functional programming style.
|
|
458
|
+
*
|
|
459
|
+
* @example
|
|
460
|
+
* ```
|
|
461
|
+
* // Normal
|
|
462
|
+
* const onEnterPressNormal = Event.filter(
|
|
463
|
+
* Event.map(onKeyPress.event, e => new StandardKeyboardEvent(e)),
|
|
464
|
+
* e.keyCode === KeyCode.Enter
|
|
465
|
+
* ).event;
|
|
466
|
+
*
|
|
467
|
+
* // Using chain
|
|
468
|
+
* const onEnterPressChain = Event.chain(onKeyPress.event, $ => $
|
|
469
|
+
* .map(e => new StandardKeyboardEvent(e))
|
|
470
|
+
* .filter(e => e.keyCode === KeyCode.Enter)
|
|
471
|
+
* );
|
|
472
|
+
* ```
|
|
473
|
+
*/
|
|
474
|
+
function chain(event, sythensize) {
|
|
475
|
+
const fn = (listener, thisArgs, disposables) => {
|
|
476
|
+
const cs = sythensize(new ChainableSynthesis());
|
|
477
|
+
return event(function (value) {
|
|
478
|
+
const result = cs.evaluate(value);
|
|
479
|
+
if (result !== HaltChainable) {
|
|
480
|
+
listener.call(thisArgs, result);
|
|
481
|
+
}
|
|
482
|
+
}, undefined, disposables);
|
|
483
|
+
};
|
|
484
|
+
return fn;
|
|
485
|
+
}
|
|
486
|
+
Event.chain = chain;
|
|
487
|
+
const HaltChainable = Symbol('HaltChainable');
|
|
488
|
+
class ChainableSynthesis {
|
|
489
|
+
constructor() {
|
|
490
|
+
this.steps = [];
|
|
491
|
+
}
|
|
492
|
+
map(fn) {
|
|
493
|
+
this.steps.push(fn);
|
|
494
|
+
return this;
|
|
495
|
+
}
|
|
496
|
+
forEach(fn) {
|
|
497
|
+
this.steps.push(v => {
|
|
498
|
+
fn(v);
|
|
499
|
+
return v;
|
|
500
|
+
});
|
|
501
|
+
return this;
|
|
502
|
+
}
|
|
503
|
+
filter(fn) {
|
|
504
|
+
this.steps.push(v => fn(v) ? v : HaltChainable);
|
|
505
|
+
return this;
|
|
506
|
+
}
|
|
507
|
+
reduce(merge, initial) {
|
|
508
|
+
let last = initial;
|
|
509
|
+
this.steps.push(v => {
|
|
510
|
+
last = merge(last, v);
|
|
511
|
+
return last;
|
|
512
|
+
});
|
|
513
|
+
return this;
|
|
514
|
+
}
|
|
515
|
+
latch(equals = (a, b) => a === b) {
|
|
516
|
+
let firstCall = true;
|
|
517
|
+
let cache;
|
|
518
|
+
this.steps.push(value => {
|
|
519
|
+
const shouldEmit = firstCall || !equals(value, cache);
|
|
520
|
+
firstCall = false;
|
|
521
|
+
cache = value;
|
|
522
|
+
return shouldEmit ? value : HaltChainable;
|
|
523
|
+
});
|
|
524
|
+
return this;
|
|
525
|
+
}
|
|
526
|
+
evaluate(value) {
|
|
527
|
+
for (const step of this.steps) {
|
|
528
|
+
value = step(value);
|
|
529
|
+
if (value === HaltChainable) {
|
|
530
|
+
break;
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
return value;
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
/**
|
|
537
|
+
* Creates an {@link Event} from a node event emitter.
|
|
538
|
+
*/
|
|
539
|
+
function fromNodeEventEmitter(emitter, eventName, map = id => id) {
|
|
540
|
+
const fn = (...args) => result.fire(map(...args));
|
|
541
|
+
const onFirstListenerAdd = () => emitter.on(eventName, fn);
|
|
542
|
+
const onLastListenerRemove = () => emitter.removeListener(eventName, fn);
|
|
543
|
+
const result = new Emitter({ onWillAddFirstListener: onFirstListenerAdd, onDidRemoveLastListener: onLastListenerRemove });
|
|
544
|
+
return result.event;
|
|
545
|
+
}
|
|
546
|
+
Event.fromNodeEventEmitter = fromNodeEventEmitter;
|
|
547
|
+
/**
|
|
548
|
+
* Creates an {@link Event} from a DOM event emitter.
|
|
549
|
+
*/
|
|
550
|
+
function fromDOMEventEmitter(emitter, eventName, map = id => id) {
|
|
551
|
+
const fn = (...args) => result.fire(map(...args));
|
|
552
|
+
const onFirstListenerAdd = () => emitter.addEventListener(eventName, fn);
|
|
553
|
+
const onLastListenerRemove = () => emitter.removeEventListener(eventName, fn);
|
|
554
|
+
const result = new Emitter({ onWillAddFirstListener: onFirstListenerAdd, onDidRemoveLastListener: onLastListenerRemove });
|
|
555
|
+
return result.event;
|
|
556
|
+
}
|
|
557
|
+
Event.fromDOMEventEmitter = fromDOMEventEmitter;
|
|
558
|
+
/**
|
|
559
|
+
* Creates a promise out of an event, using the {@link Event.once} helper.
|
|
560
|
+
*/
|
|
561
|
+
function toPromise(event, disposables) {
|
|
562
|
+
let cancelRef;
|
|
563
|
+
let listener;
|
|
564
|
+
const promise = new Promise((resolve) => {
|
|
565
|
+
listener = once(event)(resolve);
|
|
566
|
+
addToDisposables(listener, disposables);
|
|
567
|
+
// not resolved, matching the behavior of a normal disposal
|
|
568
|
+
cancelRef = () => {
|
|
569
|
+
disposeAndRemove(listener, disposables);
|
|
570
|
+
};
|
|
571
|
+
});
|
|
572
|
+
promise.cancel = cancelRef;
|
|
573
|
+
if (disposables) {
|
|
574
|
+
promise.finally(() => disposeAndRemove(listener, disposables));
|
|
575
|
+
}
|
|
576
|
+
return promise;
|
|
577
|
+
}
|
|
578
|
+
Event.toPromise = toPromise;
|
|
579
|
+
/**
|
|
580
|
+
* A convenience function for forwarding an event to another emitter which
|
|
581
|
+
* improves readability.
|
|
582
|
+
*
|
|
583
|
+
* This is similar to {@link Relay} but allows instantiating and forwarding
|
|
584
|
+
* on a single line and also allows for multiple source events.
|
|
585
|
+
* @param from The event to forward.
|
|
586
|
+
* @param to The emitter to forward the event to.
|
|
587
|
+
* @example
|
|
588
|
+
* Event.forward(event, emitter);
|
|
589
|
+
* // equivalent to
|
|
590
|
+
* event(e => emitter.fire(e));
|
|
591
|
+
* // equivalent to
|
|
592
|
+
* event(emitter.fire, emitter);
|
|
593
|
+
*/
|
|
594
|
+
function forward(from, to) {
|
|
595
|
+
return from(e => to.fire(e));
|
|
596
|
+
}
|
|
597
|
+
Event.forward = forward;
|
|
598
|
+
function runAndSubscribe(event, handler, initial) {
|
|
599
|
+
handler(initial);
|
|
600
|
+
return event(e => handler(e));
|
|
601
|
+
}
|
|
602
|
+
Event.runAndSubscribe = runAndSubscribe;
|
|
603
|
+
class EmitterObserver {
|
|
604
|
+
constructor(_observable, store) {
|
|
605
|
+
this._observable = _observable;
|
|
606
|
+
this._counter = 0;
|
|
607
|
+
this._hasChanged = false;
|
|
608
|
+
const options = {
|
|
609
|
+
onWillAddFirstListener: () => {
|
|
610
|
+
_observable.addObserver(this);
|
|
611
|
+
// Communicate to the observable that we received its current value and would like to be notified about future changes.
|
|
612
|
+
this._observable.reportChanges();
|
|
613
|
+
},
|
|
614
|
+
onDidRemoveLastListener: () => {
|
|
615
|
+
_observable.removeObserver(this);
|
|
616
|
+
}
|
|
617
|
+
};
|
|
618
|
+
if (!store) {
|
|
619
|
+
_addLeakageTraceLogic(options);
|
|
620
|
+
}
|
|
621
|
+
this.emitter = new Emitter(options);
|
|
622
|
+
if (store) {
|
|
623
|
+
store.add(this.emitter);
|
|
624
|
+
}
|
|
625
|
+
}
|
|
626
|
+
beginUpdate(_observable) {
|
|
627
|
+
// assert(_observable === this.obs);
|
|
628
|
+
this._counter++;
|
|
629
|
+
}
|
|
630
|
+
handlePossibleChange(_observable) {
|
|
631
|
+
// assert(_observable === this.obs);
|
|
632
|
+
}
|
|
633
|
+
handleChange(_observable, _change) {
|
|
634
|
+
// assert(_observable === this.obs);
|
|
635
|
+
this._hasChanged = true;
|
|
636
|
+
}
|
|
637
|
+
endUpdate(_observable) {
|
|
638
|
+
// assert(_observable === this.obs);
|
|
639
|
+
this._counter--;
|
|
640
|
+
if (this._counter === 0) {
|
|
641
|
+
this._observable.reportChanges();
|
|
642
|
+
if (this._hasChanged) {
|
|
643
|
+
this._hasChanged = false;
|
|
644
|
+
this.emitter.fire(this._observable.get());
|
|
645
|
+
}
|
|
646
|
+
}
|
|
647
|
+
}
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* Creates an event emitter that is fired when the observable changes.
|
|
651
|
+
* Each listeners subscribes to the emitter.
|
|
652
|
+
*/
|
|
653
|
+
function fromObservable(obs, store) {
|
|
654
|
+
const observer = new EmitterObserver(obs, store);
|
|
655
|
+
return observer.emitter.event;
|
|
656
|
+
}
|
|
657
|
+
Event.fromObservable = fromObservable;
|
|
658
|
+
/**
|
|
659
|
+
* Each listener is attached to the observable directly.
|
|
660
|
+
*/
|
|
661
|
+
function fromObservableLight(observable) {
|
|
662
|
+
return (listener, thisArgs, disposables) => {
|
|
663
|
+
let count = 0;
|
|
664
|
+
let didChange = false;
|
|
665
|
+
const observer = {
|
|
666
|
+
beginUpdate() {
|
|
667
|
+
count++;
|
|
668
|
+
},
|
|
669
|
+
endUpdate() {
|
|
670
|
+
count--;
|
|
671
|
+
if (count === 0) {
|
|
672
|
+
observable.reportChanges();
|
|
673
|
+
if (didChange) {
|
|
674
|
+
didChange = false;
|
|
675
|
+
listener.call(thisArgs);
|
|
676
|
+
}
|
|
677
|
+
}
|
|
678
|
+
},
|
|
679
|
+
handlePossibleChange() {
|
|
680
|
+
// noop
|
|
681
|
+
},
|
|
682
|
+
handleChange() {
|
|
683
|
+
didChange = true;
|
|
684
|
+
}
|
|
685
|
+
};
|
|
686
|
+
observable.addObserver(observer);
|
|
687
|
+
observable.reportChanges();
|
|
688
|
+
const disposable = {
|
|
689
|
+
dispose() {
|
|
690
|
+
observable.removeObserver(observer);
|
|
691
|
+
}
|
|
692
|
+
};
|
|
693
|
+
addToDisposables(disposable, disposables);
|
|
694
|
+
return disposable;
|
|
695
|
+
};
|
|
696
|
+
}
|
|
697
|
+
Event.fromObservableLight = fromObservableLight;
|
|
698
|
+
})(Event || (Event = {}));
|
|
699
|
+
export class EventProfiling {
|
|
700
|
+
static { this.all = new Set(); }
|
|
701
|
+
static { this._idPool = 0; }
|
|
702
|
+
constructor(name) {
|
|
703
|
+
this.listenerCount = 0;
|
|
704
|
+
this.invocationCount = 0;
|
|
705
|
+
this.elapsedOverall = 0;
|
|
706
|
+
this.durations = [];
|
|
707
|
+
this.name = `${name}_${EventProfiling._idPool++}`;
|
|
708
|
+
EventProfiling.all.add(this);
|
|
709
|
+
}
|
|
710
|
+
start(listenerCount) {
|
|
711
|
+
this._stopWatch = new StopWatch();
|
|
712
|
+
this.listenerCount = listenerCount;
|
|
713
|
+
}
|
|
714
|
+
stop() {
|
|
715
|
+
if (this._stopWatch) {
|
|
716
|
+
const elapsed = this._stopWatch.elapsed();
|
|
717
|
+
this.durations.push(elapsed);
|
|
718
|
+
this.elapsedOverall += elapsed;
|
|
719
|
+
this.invocationCount += 1;
|
|
720
|
+
this._stopWatch = undefined;
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
}
|
|
724
|
+
let _globalLeakWarningThreshold = -1;
|
|
725
|
+
export function setGlobalLeakWarningThreshold(n) {
|
|
726
|
+
const oldValue = _globalLeakWarningThreshold;
|
|
727
|
+
_globalLeakWarningThreshold = n;
|
|
728
|
+
return {
|
|
729
|
+
dispose() {
|
|
730
|
+
_globalLeakWarningThreshold = oldValue;
|
|
731
|
+
}
|
|
732
|
+
};
|
|
733
|
+
}
|
|
734
|
+
class LeakageMonitor {
|
|
735
|
+
static { this._idPool = 1; }
|
|
736
|
+
constructor(_errorHandler, threshold, name = (LeakageMonitor._idPool++).toString(16).padStart(3, '0')) {
|
|
737
|
+
this._errorHandler = _errorHandler;
|
|
738
|
+
this.threshold = threshold;
|
|
739
|
+
this.name = name;
|
|
740
|
+
this._warnCountdown = 0;
|
|
741
|
+
}
|
|
742
|
+
dispose() {
|
|
743
|
+
this._stacks?.clear();
|
|
744
|
+
}
|
|
745
|
+
check(stack, listenerCount) {
|
|
746
|
+
const threshold = this.threshold;
|
|
747
|
+
if (threshold <= 0 || listenerCount < threshold) {
|
|
748
|
+
return undefined;
|
|
749
|
+
}
|
|
750
|
+
if (!this._stacks) {
|
|
751
|
+
this._stacks = new Map();
|
|
752
|
+
}
|
|
753
|
+
const count = (this._stacks.get(stack.value) || 0);
|
|
754
|
+
this._stacks.set(stack.value, count + 1);
|
|
755
|
+
this._warnCountdown -= 1;
|
|
756
|
+
if (this._warnCountdown <= 0) {
|
|
757
|
+
// only warn on first exceed and then every time the limit
|
|
758
|
+
// is exceeded by 50% again
|
|
759
|
+
this._warnCountdown = threshold * 0.5;
|
|
760
|
+
const [topStack, topCount] = this.getMostFrequentStack();
|
|
761
|
+
const message = `[${this.name}] potential listener LEAK detected, having ${listenerCount} listeners already. MOST frequent listener (${topCount}):`;
|
|
762
|
+
console.warn(message);
|
|
763
|
+
console.warn(topStack);
|
|
764
|
+
const error = new ListenerLeakError(message, topStack);
|
|
765
|
+
this._errorHandler(error);
|
|
766
|
+
}
|
|
767
|
+
return () => {
|
|
768
|
+
const count = (this._stacks.get(stack.value) || 0);
|
|
769
|
+
this._stacks.set(stack.value, count - 1);
|
|
770
|
+
};
|
|
771
|
+
}
|
|
772
|
+
getMostFrequentStack() {
|
|
773
|
+
if (!this._stacks) {
|
|
774
|
+
return undefined;
|
|
775
|
+
}
|
|
776
|
+
let topStack;
|
|
777
|
+
let topCount = 0;
|
|
778
|
+
for (const [stack, count] of this._stacks) {
|
|
779
|
+
if (!topStack || topCount < count) {
|
|
780
|
+
topStack = [stack, count];
|
|
781
|
+
topCount = count;
|
|
782
|
+
}
|
|
783
|
+
}
|
|
784
|
+
return topStack;
|
|
785
|
+
}
|
|
786
|
+
}
|
|
787
|
+
class Stacktrace {
|
|
788
|
+
static create() {
|
|
789
|
+
const err = new Error();
|
|
790
|
+
return new Stacktrace(err.stack ?? '');
|
|
791
|
+
}
|
|
792
|
+
constructor(value) {
|
|
793
|
+
this.value = value;
|
|
794
|
+
}
|
|
795
|
+
print() {
|
|
796
|
+
console.warn(this.value.split('\n').slice(2).join('\n'));
|
|
797
|
+
}
|
|
798
|
+
}
|
|
799
|
+
// error that is logged when going over the configured listener threshold
|
|
800
|
+
export class ListenerLeakError extends Error {
|
|
801
|
+
constructor(message, stack) {
|
|
802
|
+
super(message);
|
|
803
|
+
this.name = 'ListenerLeakError';
|
|
804
|
+
this.stack = stack;
|
|
805
|
+
}
|
|
806
|
+
}
|
|
807
|
+
// SEVERE error that is logged when having gone way over the configured listener
|
|
808
|
+
// threshold so that the emitter refuses to accept more listeners
|
|
809
|
+
export class ListenerRefusalError extends Error {
|
|
810
|
+
constructor(message, stack) {
|
|
811
|
+
super(message);
|
|
812
|
+
this.name = 'ListenerRefusalError';
|
|
813
|
+
this.stack = stack;
|
|
814
|
+
}
|
|
815
|
+
}
|
|
816
|
+
let id = 0;
|
|
817
|
+
class UniqueContainer {
|
|
818
|
+
constructor(value) {
|
|
819
|
+
this.value = value;
|
|
820
|
+
this.id = id++;
|
|
821
|
+
}
|
|
822
|
+
}
|
|
823
|
+
const compactionThreshold = 2;
|
|
824
|
+
const forEachListener = (listeners, fn) => {
|
|
825
|
+
if (listeners instanceof UniqueContainer) {
|
|
826
|
+
fn(listeners);
|
|
827
|
+
}
|
|
828
|
+
else {
|
|
829
|
+
for (let i = 0; i < listeners.length; i++) {
|
|
830
|
+
const l = listeners[i];
|
|
831
|
+
if (l) {
|
|
832
|
+
fn(l);
|
|
833
|
+
}
|
|
834
|
+
}
|
|
835
|
+
}
|
|
836
|
+
};
|
|
837
|
+
/**
|
|
838
|
+
* The Emitter can be used to expose an Event to the public
|
|
839
|
+
* to fire it from the insides.
|
|
840
|
+
* Sample:
|
|
841
|
+
class Document {
|
|
842
|
+
|
|
843
|
+
private readonly _onDidChange = new Emitter<(value:string)=>any>();
|
|
844
|
+
|
|
845
|
+
public onDidChange = this._onDidChange.event;
|
|
846
|
+
|
|
847
|
+
// getter-style
|
|
848
|
+
// get onDidChange(): Event<(value:string)=>any> {
|
|
849
|
+
// return this._onDidChange.event;
|
|
850
|
+
// }
|
|
851
|
+
|
|
852
|
+
private _doIt() {
|
|
853
|
+
//...
|
|
854
|
+
this._onDidChange.fire(value);
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
*/
|
|
858
|
+
export class Emitter {
|
|
859
|
+
constructor(options) {
|
|
860
|
+
this._size = 0;
|
|
861
|
+
this._options = options;
|
|
862
|
+
this._leakageMon = (_globalLeakWarningThreshold > 0 || this._options?.leakWarningThreshold)
|
|
863
|
+
? new LeakageMonitor(options?.onListenerError ?? onUnexpectedError, this._options?.leakWarningThreshold ?? _globalLeakWarningThreshold) :
|
|
864
|
+
undefined;
|
|
865
|
+
this._perfMon = this._options?._profName ? new EventProfiling(this._options._profName) : undefined;
|
|
866
|
+
this._deliveryQueue = this._options?.deliveryQueue;
|
|
867
|
+
}
|
|
868
|
+
dispose() {
|
|
869
|
+
if (!this._disposed) {
|
|
870
|
+
this._disposed = true;
|
|
871
|
+
// It is bad to have listeners at the time of disposing an emitter, it is worst to have listeners keep the emitter
|
|
872
|
+
// alive via the reference that's embedded in their disposables. Therefore we loop over all remaining listeners and
|
|
873
|
+
// unset their subscriptions/disposables. Looping and blaming remaining listeners is done on next tick because the
|
|
874
|
+
// the following programming pattern is very popular:
|
|
875
|
+
//
|
|
876
|
+
// const someModel = this._disposables.add(new ModelObject()); // (1) create and register model
|
|
877
|
+
// this._disposables.add(someModel.onDidChange(() => { ... }); // (2) subscribe and register model-event listener
|
|
878
|
+
// ...later...
|
|
879
|
+
// this._disposables.dispose(); disposes (1) then (2): don't warn after (1) but after the "overall dispose" is done
|
|
880
|
+
if (this._deliveryQueue?.current === this) {
|
|
881
|
+
this._deliveryQueue.reset();
|
|
882
|
+
}
|
|
883
|
+
if (this._listeners) {
|
|
884
|
+
if (_enableDisposeWithListenerWarning) {
|
|
885
|
+
const listeners = this._listeners;
|
|
886
|
+
queueMicrotask(() => {
|
|
887
|
+
forEachListener(listeners, l => l.stack?.print());
|
|
888
|
+
});
|
|
889
|
+
}
|
|
890
|
+
this._listeners = undefined;
|
|
891
|
+
this._size = 0;
|
|
892
|
+
}
|
|
893
|
+
this._options?.onDidRemoveLastListener?.();
|
|
894
|
+
this._leakageMon?.dispose();
|
|
895
|
+
}
|
|
896
|
+
}
|
|
897
|
+
/**
|
|
898
|
+
* For the public to allow to subscribe
|
|
899
|
+
* to events from this Emitter
|
|
900
|
+
*/
|
|
901
|
+
get event() {
|
|
902
|
+
this._event ??= (callback, thisArgs, disposables) => {
|
|
903
|
+
if (this._leakageMon && this._size > this._leakageMon.threshold ** 2) {
|
|
904
|
+
const message = `[${this._leakageMon.name}] REFUSES to accept new listeners because it exceeded its threshold by far (${this._size} vs ${this._leakageMon.threshold})`;
|
|
905
|
+
console.warn(message);
|
|
906
|
+
const tuple = this._leakageMon.getMostFrequentStack() ?? ['UNKNOWN stack', -1];
|
|
907
|
+
const error = new ListenerRefusalError(`${message}. HINT: Stack shows most frequent listener (${tuple[1]}-times)`, tuple[0]);
|
|
908
|
+
const errorHandler = this._options?.onListenerError || onUnexpectedError;
|
|
909
|
+
errorHandler(error);
|
|
910
|
+
return Disposable.None;
|
|
911
|
+
}
|
|
912
|
+
if (this._disposed) {
|
|
913
|
+
// todo: should we warn if a listener is added to a disposed emitter? This happens often
|
|
914
|
+
return Disposable.None;
|
|
915
|
+
}
|
|
916
|
+
if (thisArgs) {
|
|
917
|
+
callback = callback.bind(thisArgs);
|
|
918
|
+
}
|
|
919
|
+
const contained = new UniqueContainer(callback);
|
|
920
|
+
let removeMonitor;
|
|
921
|
+
let stack;
|
|
922
|
+
if (this._leakageMon && this._size >= Math.ceil(this._leakageMon.threshold * 0.2)) {
|
|
923
|
+
// check and record this emitter for potential leakage
|
|
924
|
+
contained.stack = Stacktrace.create();
|
|
925
|
+
removeMonitor = this._leakageMon.check(contained.stack, this._size + 1);
|
|
926
|
+
}
|
|
927
|
+
if (_enableDisposeWithListenerWarning) {
|
|
928
|
+
contained.stack = stack ?? Stacktrace.create();
|
|
929
|
+
}
|
|
930
|
+
if (!this._listeners) {
|
|
931
|
+
this._options?.onWillAddFirstListener?.(this);
|
|
932
|
+
this._listeners = contained;
|
|
933
|
+
this._options?.onDidAddFirstListener?.(this);
|
|
934
|
+
}
|
|
935
|
+
else if (this._listeners instanceof UniqueContainer) {
|
|
936
|
+
this._deliveryQueue ??= new EventDeliveryQueuePrivate();
|
|
937
|
+
this._listeners = [this._listeners, contained];
|
|
938
|
+
}
|
|
939
|
+
else {
|
|
940
|
+
this._listeners.push(contained);
|
|
941
|
+
}
|
|
942
|
+
this._options?.onDidAddListener?.(this);
|
|
943
|
+
this._size++;
|
|
944
|
+
const result = toDisposable(() => {
|
|
945
|
+
removeMonitor?.();
|
|
946
|
+
this._removeListener(contained);
|
|
947
|
+
});
|
|
948
|
+
addToDisposables(result, disposables);
|
|
949
|
+
return result;
|
|
950
|
+
};
|
|
951
|
+
return this._event;
|
|
952
|
+
}
|
|
953
|
+
_removeListener(listener) {
|
|
954
|
+
this._options?.onWillRemoveListener?.(this);
|
|
955
|
+
if (!this._listeners) {
|
|
956
|
+
return; // expected if a listener gets disposed
|
|
957
|
+
}
|
|
958
|
+
if (this._size === 1) {
|
|
959
|
+
this._listeners = undefined;
|
|
960
|
+
this._options?.onDidRemoveLastListener?.(this);
|
|
961
|
+
this._size = 0;
|
|
962
|
+
return;
|
|
963
|
+
}
|
|
964
|
+
// size > 1 which requires that listeners be a list:
|
|
965
|
+
const listeners = this._listeners;
|
|
966
|
+
const index = listeners.indexOf(listener);
|
|
967
|
+
if (index === -1) {
|
|
968
|
+
console.log('disposed?', this._disposed);
|
|
969
|
+
console.log('size?', this._size);
|
|
970
|
+
console.log('arr?', JSON.stringify(this._listeners));
|
|
971
|
+
throw new Error('Attempted to dispose unknown listener');
|
|
972
|
+
}
|
|
973
|
+
this._size--;
|
|
974
|
+
listeners[index] = undefined;
|
|
975
|
+
const adjustDeliveryQueue = this._deliveryQueue.current === this;
|
|
976
|
+
if (this._size * compactionThreshold <= listeners.length) {
|
|
977
|
+
let n = 0;
|
|
978
|
+
for (let i = 0; i < listeners.length; i++) {
|
|
979
|
+
if (listeners[i]) {
|
|
980
|
+
listeners[n++] = listeners[i];
|
|
981
|
+
}
|
|
982
|
+
else if (adjustDeliveryQueue && n < this._deliveryQueue.end) {
|
|
983
|
+
this._deliveryQueue.end--;
|
|
984
|
+
if (n < this._deliveryQueue.i) {
|
|
985
|
+
this._deliveryQueue.i--;
|
|
986
|
+
}
|
|
987
|
+
}
|
|
988
|
+
}
|
|
989
|
+
listeners.length = n;
|
|
990
|
+
}
|
|
991
|
+
}
|
|
992
|
+
_deliver(listener, value) {
|
|
993
|
+
if (!listener) {
|
|
994
|
+
return;
|
|
995
|
+
}
|
|
996
|
+
const errorHandler = this._options?.onListenerError || onUnexpectedError;
|
|
997
|
+
if (!errorHandler) {
|
|
998
|
+
listener.value(value);
|
|
999
|
+
return;
|
|
1000
|
+
}
|
|
1001
|
+
try {
|
|
1002
|
+
listener.value(value);
|
|
1003
|
+
}
|
|
1004
|
+
catch (e) {
|
|
1005
|
+
errorHandler(e);
|
|
1006
|
+
}
|
|
1007
|
+
}
|
|
1008
|
+
/** Delivers items in the queue. Assumes the queue is ready to go. */
|
|
1009
|
+
_deliverQueue(dq) {
|
|
1010
|
+
const listeners = dq.current._listeners;
|
|
1011
|
+
while (dq.i < dq.end) {
|
|
1012
|
+
// important: dq.i is incremented before calling deliver() because it might reenter deliverQueue()
|
|
1013
|
+
this._deliver(listeners[dq.i++], dq.value);
|
|
1014
|
+
}
|
|
1015
|
+
dq.reset();
|
|
1016
|
+
}
|
|
1017
|
+
/**
|
|
1018
|
+
* To be kept private to fire an event to
|
|
1019
|
+
* subscribers
|
|
1020
|
+
*/
|
|
1021
|
+
fire(event) {
|
|
1022
|
+
if (this._deliveryQueue?.current) {
|
|
1023
|
+
this._deliverQueue(this._deliveryQueue);
|
|
1024
|
+
this._perfMon?.stop(); // last fire() will have starting perfmon, stop it before starting the next dispatch
|
|
1025
|
+
}
|
|
1026
|
+
this._perfMon?.start(this._size);
|
|
1027
|
+
if (!this._listeners) {
|
|
1028
|
+
// no-op
|
|
1029
|
+
}
|
|
1030
|
+
else if (this._listeners instanceof UniqueContainer) {
|
|
1031
|
+
this._deliver(this._listeners, event);
|
|
1032
|
+
}
|
|
1033
|
+
else {
|
|
1034
|
+
const dq = this._deliveryQueue;
|
|
1035
|
+
dq.enqueue(this, event, this._listeners.length);
|
|
1036
|
+
this._deliverQueue(dq);
|
|
1037
|
+
}
|
|
1038
|
+
this._perfMon?.stop();
|
|
1039
|
+
}
|
|
1040
|
+
hasListeners() {
|
|
1041
|
+
return this._size > 0;
|
|
1042
|
+
}
|
|
1043
|
+
}
|
|
1044
|
+
export const createEventDeliveryQueue = () => new EventDeliveryQueuePrivate();
|
|
1045
|
+
class EventDeliveryQueuePrivate {
|
|
1046
|
+
constructor() {
|
|
1047
|
+
/**
|
|
1048
|
+
* Index in current's listener list.
|
|
1049
|
+
*/
|
|
1050
|
+
this.i = -1;
|
|
1051
|
+
/**
|
|
1052
|
+
* The last index in the listener's list to deliver.
|
|
1053
|
+
*/
|
|
1054
|
+
this.end = 0;
|
|
1055
|
+
}
|
|
1056
|
+
enqueue(emitter, value, end) {
|
|
1057
|
+
this.i = 0;
|
|
1058
|
+
this.end = end;
|
|
1059
|
+
this.current = emitter;
|
|
1060
|
+
this.value = value;
|
|
1061
|
+
}
|
|
1062
|
+
reset() {
|
|
1063
|
+
this.i = this.end; // force any current emission loop to stop, mainly for during dispose
|
|
1064
|
+
this.current = undefined;
|
|
1065
|
+
this.value = undefined;
|
|
1066
|
+
}
|
|
1067
|
+
}
|
|
1068
|
+
export class AsyncEmitter extends Emitter {
|
|
1069
|
+
async fireAsync(data, token, promiseJoin) {
|
|
1070
|
+
if (!this._listeners) {
|
|
1071
|
+
return;
|
|
1072
|
+
}
|
|
1073
|
+
if (!this._asyncDeliveryQueue) {
|
|
1074
|
+
this._asyncDeliveryQueue = new LinkedList();
|
|
1075
|
+
}
|
|
1076
|
+
forEachListener(this._listeners, listener => this._asyncDeliveryQueue.push([listener.value, data]));
|
|
1077
|
+
while (this._asyncDeliveryQueue.size > 0 && !token.isCancellationRequested) {
|
|
1078
|
+
const [listener, data] = this._asyncDeliveryQueue.shift();
|
|
1079
|
+
const thenables = [];
|
|
1080
|
+
// eslint-disable-next-line local/code-no-dangerous-type-assertions
|
|
1081
|
+
const event = {
|
|
1082
|
+
...data,
|
|
1083
|
+
token,
|
|
1084
|
+
waitUntil: (p) => {
|
|
1085
|
+
if (Object.isFrozen(thenables)) {
|
|
1086
|
+
throw new Error('waitUntil can NOT be called asynchronous');
|
|
1087
|
+
}
|
|
1088
|
+
if (promiseJoin) {
|
|
1089
|
+
p = promiseJoin(p, listener);
|
|
1090
|
+
}
|
|
1091
|
+
thenables.push(p);
|
|
1092
|
+
}
|
|
1093
|
+
};
|
|
1094
|
+
try {
|
|
1095
|
+
listener(event);
|
|
1096
|
+
}
|
|
1097
|
+
catch (e) {
|
|
1098
|
+
onUnexpectedError(e);
|
|
1099
|
+
continue;
|
|
1100
|
+
}
|
|
1101
|
+
// freeze thenables-collection to enforce sync-calls to
|
|
1102
|
+
// wait until and then wait for all thenables to resolve
|
|
1103
|
+
Object.freeze(thenables);
|
|
1104
|
+
await Promise.allSettled(thenables).then(values => {
|
|
1105
|
+
for (const value of values) {
|
|
1106
|
+
if (value.status === 'rejected') {
|
|
1107
|
+
onUnexpectedError(value.reason);
|
|
1108
|
+
}
|
|
1109
|
+
}
|
|
1110
|
+
});
|
|
1111
|
+
}
|
|
1112
|
+
}
|
|
1113
|
+
}
|
|
1114
|
+
export class PauseableEmitter extends Emitter {
|
|
1115
|
+
get isPaused() {
|
|
1116
|
+
return this._isPaused !== 0;
|
|
1117
|
+
}
|
|
1118
|
+
constructor(options) {
|
|
1119
|
+
super(options);
|
|
1120
|
+
this._isPaused = 0;
|
|
1121
|
+
this._eventQueue = new LinkedList();
|
|
1122
|
+
this._mergeFn = options?.merge;
|
|
1123
|
+
}
|
|
1124
|
+
pause() {
|
|
1125
|
+
this._isPaused++;
|
|
1126
|
+
}
|
|
1127
|
+
resume() {
|
|
1128
|
+
if (this._isPaused !== 0 && --this._isPaused === 0) {
|
|
1129
|
+
if (this._mergeFn) {
|
|
1130
|
+
// use the merge function to create a single composite
|
|
1131
|
+
// event. make a copy in case firing pauses this emitter
|
|
1132
|
+
if (this._eventQueue.size > 0) {
|
|
1133
|
+
const events = Array.from(this._eventQueue);
|
|
1134
|
+
this._eventQueue.clear();
|
|
1135
|
+
super.fire(this._mergeFn(events));
|
|
1136
|
+
}
|
|
1137
|
+
}
|
|
1138
|
+
else {
|
|
1139
|
+
// no merging, fire each event individually and test
|
|
1140
|
+
// that this emitter isn't paused halfway through
|
|
1141
|
+
while (!this._isPaused && this._eventQueue.size !== 0) {
|
|
1142
|
+
super.fire(this._eventQueue.shift());
|
|
1143
|
+
}
|
|
1144
|
+
}
|
|
1145
|
+
}
|
|
1146
|
+
}
|
|
1147
|
+
fire(event) {
|
|
1148
|
+
if (this._size) {
|
|
1149
|
+
if (this._isPaused !== 0) {
|
|
1150
|
+
this._eventQueue.push(event);
|
|
1151
|
+
}
|
|
1152
|
+
else {
|
|
1153
|
+
super.fire(event);
|
|
1154
|
+
}
|
|
1155
|
+
}
|
|
1156
|
+
}
|
|
1157
|
+
}
|
|
1158
|
+
export class DebounceEmitter extends PauseableEmitter {
|
|
1159
|
+
constructor(options) {
|
|
1160
|
+
super(options);
|
|
1161
|
+
this._delay = options.delay ?? 100;
|
|
1162
|
+
}
|
|
1163
|
+
fire(event) {
|
|
1164
|
+
if (!this._handle) {
|
|
1165
|
+
this.pause();
|
|
1166
|
+
this._handle = setTimeout(() => {
|
|
1167
|
+
this._handle = undefined;
|
|
1168
|
+
this.resume();
|
|
1169
|
+
}, this._delay);
|
|
1170
|
+
}
|
|
1171
|
+
super.fire(event);
|
|
1172
|
+
}
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* An emitter which queue all events and then process them at the
|
|
1176
|
+
* end of the event loop.
|
|
1177
|
+
*/
|
|
1178
|
+
export class MicrotaskEmitter extends Emitter {
|
|
1179
|
+
constructor(options) {
|
|
1180
|
+
super(options);
|
|
1181
|
+
this._queuedEvents = [];
|
|
1182
|
+
this._mergeFn = options?.merge;
|
|
1183
|
+
}
|
|
1184
|
+
fire(event) {
|
|
1185
|
+
if (!this.hasListeners()) {
|
|
1186
|
+
return;
|
|
1187
|
+
}
|
|
1188
|
+
this._queuedEvents.push(event);
|
|
1189
|
+
if (this._queuedEvents.length === 1) {
|
|
1190
|
+
queueMicrotask(() => {
|
|
1191
|
+
if (this._mergeFn) {
|
|
1192
|
+
super.fire(this._mergeFn(this._queuedEvents));
|
|
1193
|
+
}
|
|
1194
|
+
else {
|
|
1195
|
+
this._queuedEvents.forEach(e => super.fire(e));
|
|
1196
|
+
}
|
|
1197
|
+
this._queuedEvents = [];
|
|
1198
|
+
});
|
|
1199
|
+
}
|
|
1200
|
+
}
|
|
1201
|
+
}
|
|
1202
|
+
/**
|
|
1203
|
+
* An event emitter that multiplexes many events into a single event.
|
|
1204
|
+
*
|
|
1205
|
+
* @example Listen to the `onData` event of all `Thing`s, dynamically adding and removing `Thing`s
|
|
1206
|
+
* to the multiplexer as needed.
|
|
1207
|
+
*
|
|
1208
|
+
* ```typescript
|
|
1209
|
+
* const anythingDataMultiplexer = new EventMultiplexer<{ data: string }>();
|
|
1210
|
+
*
|
|
1211
|
+
* const thingListeners = DisposableMap<Thing, IDisposable>();
|
|
1212
|
+
*
|
|
1213
|
+
* thingService.onDidAddThing(thing => {
|
|
1214
|
+
* thingListeners.set(thing, anythingDataMultiplexer.add(thing.onData);
|
|
1215
|
+
* });
|
|
1216
|
+
* thingService.onDidRemoveThing(thing => {
|
|
1217
|
+
* thingListeners.deleteAndDispose(thing);
|
|
1218
|
+
* });
|
|
1219
|
+
*
|
|
1220
|
+
* anythingDataMultiplexer.event(e => {
|
|
1221
|
+
* console.log('Something fired data ' + e.data)
|
|
1222
|
+
* });
|
|
1223
|
+
* ```
|
|
1224
|
+
*/
|
|
1225
|
+
export class EventMultiplexer {
|
|
1226
|
+
constructor() {
|
|
1227
|
+
this.hasListeners = false;
|
|
1228
|
+
this.events = [];
|
|
1229
|
+
this.emitter = new Emitter({
|
|
1230
|
+
onWillAddFirstListener: () => this.onFirstListenerAdd(),
|
|
1231
|
+
onDidRemoveLastListener: () => this.onLastListenerRemove()
|
|
1232
|
+
});
|
|
1233
|
+
}
|
|
1234
|
+
get event() {
|
|
1235
|
+
return this.emitter.event;
|
|
1236
|
+
}
|
|
1237
|
+
add(event) {
|
|
1238
|
+
const e = { event: event, listener: null };
|
|
1239
|
+
this.events.push(e);
|
|
1240
|
+
if (this.hasListeners) {
|
|
1241
|
+
this.hook(e);
|
|
1242
|
+
}
|
|
1243
|
+
const dispose = () => {
|
|
1244
|
+
if (this.hasListeners) {
|
|
1245
|
+
this.unhook(e);
|
|
1246
|
+
}
|
|
1247
|
+
const idx = this.events.indexOf(e);
|
|
1248
|
+
this.events.splice(idx, 1);
|
|
1249
|
+
};
|
|
1250
|
+
return toDisposable(createSingleCallFunction(dispose));
|
|
1251
|
+
}
|
|
1252
|
+
onFirstListenerAdd() {
|
|
1253
|
+
this.hasListeners = true;
|
|
1254
|
+
this.events.forEach(e => this.hook(e));
|
|
1255
|
+
}
|
|
1256
|
+
onLastListenerRemove() {
|
|
1257
|
+
this.hasListeners = false;
|
|
1258
|
+
this.events.forEach(e => this.unhook(e));
|
|
1259
|
+
}
|
|
1260
|
+
hook(e) {
|
|
1261
|
+
e.listener = e.event(r => this.emitter.fire(r));
|
|
1262
|
+
}
|
|
1263
|
+
unhook(e) {
|
|
1264
|
+
e.listener?.dispose();
|
|
1265
|
+
e.listener = null;
|
|
1266
|
+
}
|
|
1267
|
+
dispose() {
|
|
1268
|
+
this.emitter.dispose();
|
|
1269
|
+
for (const e of this.events) {
|
|
1270
|
+
e.listener?.dispose();
|
|
1271
|
+
}
|
|
1272
|
+
this.events = [];
|
|
1273
|
+
}
|
|
1274
|
+
}
|
|
1275
|
+
export class DynamicListEventMultiplexer {
|
|
1276
|
+
constructor(items, onAddItem, onRemoveItem, getEvent) {
|
|
1277
|
+
this._store = new DisposableStore();
|
|
1278
|
+
const multiplexer = this._store.add(new EventMultiplexer());
|
|
1279
|
+
const itemListeners = this._store.add(new DisposableMap());
|
|
1280
|
+
function addItem(instance) {
|
|
1281
|
+
itemListeners.set(instance, multiplexer.add(getEvent(instance)));
|
|
1282
|
+
}
|
|
1283
|
+
// Existing items
|
|
1284
|
+
for (const instance of items) {
|
|
1285
|
+
addItem(instance);
|
|
1286
|
+
}
|
|
1287
|
+
// Added items
|
|
1288
|
+
this._store.add(onAddItem(instance => {
|
|
1289
|
+
addItem(instance);
|
|
1290
|
+
}));
|
|
1291
|
+
// Removed items
|
|
1292
|
+
this._store.add(onRemoveItem(instance => {
|
|
1293
|
+
itemListeners.deleteAndDispose(instance);
|
|
1294
|
+
}));
|
|
1295
|
+
this.event = multiplexer.event;
|
|
1296
|
+
}
|
|
1297
|
+
dispose() {
|
|
1298
|
+
this._store.dispose();
|
|
1299
|
+
}
|
|
1300
|
+
}
|
|
1301
|
+
/**
|
|
1302
|
+
* The EventBufferer is useful in situations in which you want
|
|
1303
|
+
* to delay firing your events during some code.
|
|
1304
|
+
* You can wrap that code and be sure that the event will not
|
|
1305
|
+
* be fired during that wrap.
|
|
1306
|
+
*
|
|
1307
|
+
* ```
|
|
1308
|
+
* const emitter: Emitter;
|
|
1309
|
+
* const delayer = new EventDelayer();
|
|
1310
|
+
* const delayedEvent = delayer.wrapEvent(emitter.event);
|
|
1311
|
+
*
|
|
1312
|
+
* delayedEvent(console.log);
|
|
1313
|
+
*
|
|
1314
|
+
* delayer.bufferEvents(() => {
|
|
1315
|
+
* emitter.fire(); // event will not be fired yet
|
|
1316
|
+
* });
|
|
1317
|
+
*
|
|
1318
|
+
* // event will only be fired at this point
|
|
1319
|
+
* ```
|
|
1320
|
+
*/
|
|
1321
|
+
export class EventBufferer {
|
|
1322
|
+
constructor() {
|
|
1323
|
+
this.data = [];
|
|
1324
|
+
}
|
|
1325
|
+
wrapEvent(event, reduce, initial) {
|
|
1326
|
+
return (listener, thisArgs, disposables) => {
|
|
1327
|
+
return event(i => {
|
|
1328
|
+
const data = this.data[this.data.length - 1];
|
|
1329
|
+
// Non-reduce scenario
|
|
1330
|
+
if (!reduce) {
|
|
1331
|
+
// Buffering case
|
|
1332
|
+
if (data) {
|
|
1333
|
+
data.buffers.push(() => listener.call(thisArgs, i));
|
|
1334
|
+
}
|
|
1335
|
+
else {
|
|
1336
|
+
// Not buffering case
|
|
1337
|
+
listener.call(thisArgs, i);
|
|
1338
|
+
}
|
|
1339
|
+
return;
|
|
1340
|
+
}
|
|
1341
|
+
// Reduce scenario
|
|
1342
|
+
const reduceData = data;
|
|
1343
|
+
// Not buffering case
|
|
1344
|
+
if (!reduceData) {
|
|
1345
|
+
// TODO: Is there a way to cache this reduce call for all listeners?
|
|
1346
|
+
listener.call(thisArgs, reduce(initial, i));
|
|
1347
|
+
return;
|
|
1348
|
+
}
|
|
1349
|
+
// Buffering case
|
|
1350
|
+
reduceData.items ??= [];
|
|
1351
|
+
reduceData.items.push(i);
|
|
1352
|
+
if (reduceData.buffers.length === 0) {
|
|
1353
|
+
// Include a single buffered function that will reduce all events when we're done buffering events
|
|
1354
|
+
data.buffers.push(() => {
|
|
1355
|
+
// cache the reduced result so that the value can be shared across all listeners
|
|
1356
|
+
reduceData.reducedResult ??= initial
|
|
1357
|
+
? reduceData.items.reduce(reduce, initial)
|
|
1358
|
+
: reduceData.items.reduce(reduce);
|
|
1359
|
+
listener.call(thisArgs, reduceData.reducedResult);
|
|
1360
|
+
});
|
|
1361
|
+
}
|
|
1362
|
+
}, undefined, disposables);
|
|
1363
|
+
};
|
|
1364
|
+
}
|
|
1365
|
+
bufferEvents(fn) {
|
|
1366
|
+
const data = { buffers: new Array() };
|
|
1367
|
+
this.data.push(data);
|
|
1368
|
+
const r = fn();
|
|
1369
|
+
this.data.pop();
|
|
1370
|
+
data.buffers.forEach(flush => flush());
|
|
1371
|
+
return r;
|
|
1372
|
+
}
|
|
1373
|
+
}
|
|
1374
|
+
/**
|
|
1375
|
+
* A Relay is an event forwarder which functions as a replugabble event pipe.
|
|
1376
|
+
* Once created, you can connect an input event to it and it will simply forward
|
|
1377
|
+
* events from that input event through its own `event` property. The `input`
|
|
1378
|
+
* can be changed at any point in time.
|
|
1379
|
+
*/
|
|
1380
|
+
export class Relay {
|
|
1381
|
+
constructor() {
|
|
1382
|
+
this.listening = false;
|
|
1383
|
+
this.inputEvent = Event.None;
|
|
1384
|
+
this.inputEventListener = Disposable.None;
|
|
1385
|
+
this.emitter = new Emitter({
|
|
1386
|
+
onDidAddFirstListener: () => {
|
|
1387
|
+
this.listening = true;
|
|
1388
|
+
this.inputEventListener = this.inputEvent(this.emitter.fire, this.emitter);
|
|
1389
|
+
},
|
|
1390
|
+
onDidRemoveLastListener: () => {
|
|
1391
|
+
this.listening = false;
|
|
1392
|
+
this.inputEventListener.dispose();
|
|
1393
|
+
}
|
|
1394
|
+
});
|
|
1395
|
+
this.event = this.emitter.event;
|
|
1396
|
+
}
|
|
1397
|
+
set input(event) {
|
|
1398
|
+
this.inputEvent = event;
|
|
1399
|
+
if (this.listening) {
|
|
1400
|
+
this.inputEventListener.dispose();
|
|
1401
|
+
this.inputEventListener = event(this.emitter.fire, this.emitter);
|
|
1402
|
+
}
|
|
1403
|
+
}
|
|
1404
|
+
dispose() {
|
|
1405
|
+
this.inputEventListener.dispose();
|
|
1406
|
+
this.emitter.dispose();
|
|
1407
|
+
}
|
|
1408
|
+
}
|
|
1409
|
+
export class ValueWithChangeEvent {
|
|
1410
|
+
static const(value) {
|
|
1411
|
+
return new ConstValueWithChangeEvent(value);
|
|
1412
|
+
}
|
|
1413
|
+
constructor(_value) {
|
|
1414
|
+
this._value = _value;
|
|
1415
|
+
this._onDidChange = new Emitter();
|
|
1416
|
+
this.onDidChange = this._onDidChange.event;
|
|
1417
|
+
}
|
|
1418
|
+
get value() {
|
|
1419
|
+
return this._value;
|
|
1420
|
+
}
|
|
1421
|
+
set value(value) {
|
|
1422
|
+
if (value !== this._value) {
|
|
1423
|
+
this._value = value;
|
|
1424
|
+
this._onDidChange.fire(undefined);
|
|
1425
|
+
}
|
|
1426
|
+
}
|
|
1427
|
+
}
|
|
1428
|
+
class ConstValueWithChangeEvent {
|
|
1429
|
+
constructor(value) {
|
|
1430
|
+
this.value = value;
|
|
1431
|
+
this.onDidChange = Event.None;
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
/**
|
|
1435
|
+
* @param handleItem Is called for each item in the set (but only the first time the item is seen in the set).
|
|
1436
|
+
* The returned disposable is disposed if the item is no longer in the set.
|
|
1437
|
+
*/
|
|
1438
|
+
export function trackSetChanges(getData, onDidChangeData, handleItem) {
|
|
1439
|
+
const map = new DisposableMap();
|
|
1440
|
+
let oldData = new Set(getData());
|
|
1441
|
+
for (const d of oldData) {
|
|
1442
|
+
map.set(d, handleItem(d));
|
|
1443
|
+
}
|
|
1444
|
+
const store = new DisposableStore();
|
|
1445
|
+
store.add(onDidChangeData(() => {
|
|
1446
|
+
const newData = getData();
|
|
1447
|
+
const diff = diffSets(oldData, newData);
|
|
1448
|
+
for (const r of diff.removed) {
|
|
1449
|
+
map.deleteAndDispose(r);
|
|
1450
|
+
}
|
|
1451
|
+
for (const a of diff.added) {
|
|
1452
|
+
map.set(a, handleItem(a));
|
|
1453
|
+
}
|
|
1454
|
+
oldData = new Set(newData);
|
|
1455
|
+
}));
|
|
1456
|
+
store.add(map);
|
|
1457
|
+
return store;
|
|
1458
|
+
}
|
|
1459
|
+
function addToDisposables(result, disposables) {
|
|
1460
|
+
if (disposables instanceof DisposableStore) {
|
|
1461
|
+
disposables.add(result);
|
|
1462
|
+
}
|
|
1463
|
+
else if (Array.isArray(disposables)) {
|
|
1464
|
+
disposables.push(result);
|
|
1465
|
+
}
|
|
1466
|
+
}
|
|
1467
|
+
function disposeAndRemove(result, disposables) {
|
|
1468
|
+
if (disposables instanceof DisposableStore) {
|
|
1469
|
+
disposables.delete(result);
|
|
1470
|
+
}
|
|
1471
|
+
else if (Array.isArray(disposables)) {
|
|
1472
|
+
const index = disposables.indexOf(result);
|
|
1473
|
+
if (index !== -1) {
|
|
1474
|
+
disposables.splice(index, 1);
|
|
1475
|
+
}
|
|
1476
|
+
}
|
|
1477
|
+
result.dispose();
|
|
1478
|
+
}
|
|
1479
|
+
//# sourceMappingURL=event.js.map
|