|
| 1 | +/*************************************************************************************** |
| 2 | + * Copyright (c) 2024 BlackBerry Limited and others. |
| 3 | + * |
| 4 | + * Licensed under the MIT license. See LICENSE file in the project root for details. |
| 5 | + ***************************************************************************************/ |
| 6 | +import * as vscode from 'vscode'; |
| 7 | + |
| 8 | +export type ResourceType = 'File' | 'Folder'; |
| 9 | +export type ResourceTypeQuickPickItem = vscode.QuickPickItem & { type: ResourceType }; |
| 10 | + |
| 11 | +export class TraceExplorerResourceTypeHandler { |
| 12 | + private static instance: TraceExplorerResourceTypeHandler; |
| 13 | + private doHandleFiles = true; |
| 14 | + private doHandleFolders = true; |
| 15 | + private quickpickItems: ResourceTypeQuickPickItem[] = [ |
| 16 | + { label: 'File', type: 'File' }, |
| 17 | + { label: 'Folder', type: 'Folder' } |
| 18 | + ]; |
| 19 | + |
| 20 | + private constructor() { |
| 21 | + /** Empty constructor */ |
| 22 | + } |
| 23 | + |
| 24 | + public static getInstance(): TraceExplorerResourceTypeHandler { |
| 25 | + if (!TraceExplorerResourceTypeHandler.instance) { |
| 26 | + TraceExplorerResourceTypeHandler.instance = new TraceExplorerResourceTypeHandler(); |
| 27 | + } |
| 28 | + return TraceExplorerResourceTypeHandler.instance; |
| 29 | + } |
| 30 | + |
| 31 | + /** |
| 32 | + * Updates the stored value of whether files and/or folders should be handled by the extension |
| 33 | + * |
| 34 | + * @param handleFiles trace files to be handled |
| 35 | + * @param handleFolders trace folders to be handled |
| 36 | + */ |
| 37 | + setHandleResourceTypes(handleFiles: boolean | undefined, handleFolders: boolean | undefined): void { |
| 38 | + if (handleFiles !== undefined) { |
| 39 | + this.doHandleFiles = handleFiles; |
| 40 | + } |
| 41 | + if (handleFolders !== undefined) { |
| 42 | + this.doHandleFolders = handleFolders; |
| 43 | + } |
| 44 | + } |
| 45 | + |
| 46 | + /** |
| 47 | + * Checks if trace folders are handled to by the extension |
| 48 | + * |
| 49 | + * @returns true if folders are handled |
| 50 | + */ |
| 51 | + handleFolders(): boolean { |
| 52 | + return this.doHandleFolders; |
| 53 | + } |
| 54 | + |
| 55 | + /** |
| 56 | + * Checks if trace files are handled to by the extension |
| 57 | + * @returns true if files are handled |
| 58 | + */ |
| 59 | + handleFiles(): boolean { |
| 60 | + return this.doHandleFiles; |
| 61 | + } |
| 62 | + |
| 63 | + /** |
| 64 | + * Detects what resource type should be handled by the extension based on the set values. |
| 65 | + * If both file and folder resource types are to be handled, a quick pick is prompted to let the user |
| 66 | + * decide which type should be handled. |
| 67 | + * |
| 68 | + * @returns TraceResourceType to be handled |
| 69 | + */ |
| 70 | + async detectOrPromptForTraceResouceType(): Promise<ResourceType | undefined> { |
| 71 | + // Try to figure out from context set |
| 72 | + if (this.handleFiles() && !this.handleFolders()) { |
| 73 | + return 'File'; |
| 74 | + } else if (!this.handleFiles() && this.handleFolders()) { |
| 75 | + return 'Folder'; |
| 76 | + } else { |
| 77 | + const selection = await vscode.window.showQuickPick(this.quickpickItems, { |
| 78 | + title: 'Select the trace resource type to open' |
| 79 | + }); |
| 80 | + if (!selection) return undefined; |
| 81 | + return selection.type; |
| 82 | + } |
| 83 | + } |
| 84 | +} |
0 commit comments