|
| 1 | +import * as path from "path"; |
| 2 | +import { TextDocument, window, workspace, WorkspaceFolder } from "vscode"; |
| 3 | +import { XMLFileAssociation } from "./extension"; |
| 4 | + |
| 5 | +/** |
| 6 | + * Represents a variable that refers to a value that can be resolved |
| 7 | + */ |
| 8 | +class VariableSubstitution { |
| 9 | + |
| 10 | + private varName: string; |
| 11 | + private varKind: VariableSubstitutionKind; |
| 12 | + private getValue: (currentFileUri: string, currentWorkspaceUri: string) => string; |
| 13 | + private replaceRegExp: RegExp | undefined; |
| 14 | + |
| 15 | + /** |
| 16 | + * |
| 17 | + * @param name the name of this variable |
| 18 | + * @param kind the kind of this variable |
| 19 | + * @param getValue a function that resolves the value of the variable |
| 20 | + */ |
| 21 | + constructor(name: string, kind: VariableSubstitutionKind, getValue: (currentFileUri: string, currentWorkspaceUri: string) => string) { |
| 22 | + this.varName = name; |
| 23 | + this.varKind = kind; |
| 24 | + this.getValue = getValue; |
| 25 | + } |
| 26 | + |
| 27 | + public get name(): string { |
| 28 | + return this.varName; |
| 29 | + } |
| 30 | + |
| 31 | + public get kind(): VariableSubstitutionKind { |
| 32 | + return this.varKind; |
| 33 | + } |
| 34 | + |
| 35 | + /** |
| 36 | + * Returns the string with the references to this variable replaced with the value, or the original string if the value cannot be resolved |
| 37 | + * |
| 38 | + * @param original the string to substitute variable value |
| 39 | + * @param currentFileUri the uri of the currently focused file, as a string |
| 40 | + * @param currentWorkspaceUri the uri of the root of the currently open workspace, as a string |
| 41 | + * @returns the string with the references to this variable replaced with the value, or the original string if the value cannot be resolved |
| 42 | + */ |
| 43 | + public substituteString(original: string, currentFileUri: string, currentWorkspaceUri: string): string { |
| 44 | + const value: string = this.getValue(currentFileUri, currentWorkspaceUri); |
| 45 | + return value ? original.replace(this.getReplaceRegExp(), value) : original; |
| 46 | + } |
| 47 | + |
| 48 | + /** |
| 49 | + * Returns a regex that matches all references to the variable |
| 50 | + * |
| 51 | + * Lazily initialized |
| 52 | + * |
| 53 | + * @returns a regex that matches all references to the variable |
| 54 | + */ |
| 55 | + public getReplaceRegExp(): RegExp { |
| 56 | + if (!this.replaceRegExp) { |
| 57 | + this.replaceRegExp = new RegExp('\\$\\{' + `${this.name}` + '\\}', 'g'); |
| 58 | + } |
| 59 | + return this.replaceRegExp; |
| 60 | + } |
| 61 | +} |
| 62 | + |
| 63 | +enum VariableSubstitutionKind { |
| 64 | + Workspace, |
| 65 | + File |
| 66 | +} |
| 67 | + |
| 68 | +// A list of all variable substitutions. To add a new variable substitution, add an entry to this list |
| 69 | +const VARIABLE_SUBSTITUTIONS: VariableSubstitution[] = [ |
| 70 | + new VariableSubstitution( |
| 71 | + "workspaceFolder", |
| 72 | + VariableSubstitutionKind.Workspace, |
| 73 | + (currentFileUri: string, currentWorkspaceUri: string): string => { |
| 74 | + return currentWorkspaceUri; |
| 75 | + } |
| 76 | + ), |
| 77 | + new VariableSubstitution( |
| 78 | + "fileDirname", |
| 79 | + VariableSubstitutionKind.File, |
| 80 | + (currentFileUri: string, currentWorkspaceUri: string): string => { |
| 81 | + return path.dirname(currentFileUri); |
| 82 | + } |
| 83 | + ), |
| 84 | + new VariableSubstitution( |
| 85 | + "fileBasenameNoExtension", |
| 86 | + VariableSubstitutionKind.File, |
| 87 | + (currentFileUri: string, currentWorkspaceUri: string): string => { |
| 88 | + return path.basename(currentFileUri, path.extname(currentFileUri)); |
| 89 | + } |
| 90 | + ) |
| 91 | +]; |
| 92 | + |
| 93 | +/** |
| 94 | + * Returns the file associations with as many variable references resolved as possible |
| 95 | + * |
| 96 | + * @param associations the file associations to resolve the variable references in |
| 97 | + * @returns the file associations with as many variable references resolved as possible |
| 98 | + */ |
| 99 | +export function getVariableSubstitutedAssociations(associations: XMLFileAssociation[]): XMLFileAssociation[] { |
| 100 | + |
| 101 | + // Collect properties needed to resolve variables |
| 102 | + const currentFile: TextDocument = window.activeTextEditor.document; |
| 103 | + const currentFileUri: string = currentFile && currentFile.uri.fsPath; |
| 104 | + const currentWorkspace: WorkspaceFolder = workspace.getWorkspaceFolder(currentFile && currentFile.uri); |
| 105 | + const currentWorkspaceUri: string = (currentWorkspace && currentWorkspace.uri.fsPath) |
| 106 | + || (workspace.workspaceFolders && workspace.workspaceFolders[0].uri.fsPath); |
| 107 | + |
| 108 | + // Remove variables that can't be resolved |
| 109 | + let variablesToSubstitute = VARIABLE_SUBSTITUTIONS; |
| 110 | + if (!currentWorkspaceUri) { |
| 111 | + variablesToSubstitute = variablesToSubstitute.filter(variable => { variable.kind !== VariableSubstitutionKind.Workspace }); |
| 112 | + } |
| 113 | + if (!currentFileUri) { |
| 114 | + variablesToSubstitute = variablesToSubstitute.filter(variable => { variable.kind !== VariableSubstitutionKind.File }); |
| 115 | + } |
| 116 | + |
| 117 | + /** |
| 118 | + * Returns the string with the values for all the variables that can be resolved substituted in the string |
| 119 | + * |
| 120 | + * @param val the value to substitute the variables into |
| 121 | + * @return the string with the values for all the variables that can be resolved substituted in the string |
| 122 | + */ |
| 123 | + const subVars = (val: string): string => { |
| 124 | + let newVal = val; |
| 125 | + for (const settingVariable of variablesToSubstitute) { |
| 126 | + newVal = settingVariable.substituteString(newVal, currentFileUri, currentWorkspaceUri); |
| 127 | + } |
| 128 | + return newVal; |
| 129 | + } |
| 130 | + |
| 131 | + return associations.map((association: XMLFileAssociation) => { |
| 132 | + return { |
| 133 | + pattern: subVars(association.pattern), |
| 134 | + systemId: subVars(association.systemId) |
| 135 | + }; |
| 136 | + }); |
| 137 | +} |
| 138 | + |
| 139 | +/** |
| 140 | + * Returns true if any of the file associations contain references to variables that refer to current file, and false otherwise |
| 141 | + * |
| 142 | + * @param associations A list of file associations to check |
| 143 | + * @returns true if any of the file associations contain references to variables that refer to current file, and false otherwise |
| 144 | + */ |
| 145 | +export function containsVariableReferenceToCurrentFile(associations: XMLFileAssociation[]): boolean { |
| 146 | + const fileVariables: VariableSubstitution[] = VARIABLE_SUBSTITUTIONS.filter(variable => variable.kind === VariableSubstitutionKind.File); |
| 147 | + for (const association of associations) { |
| 148 | + for (const variable of fileVariables) { |
| 149 | + if (variable.getReplaceRegExp().test(association.pattern) || variable.getReplaceRegExp().test(association.systemId)) { |
| 150 | + return true; |
| 151 | + } |
| 152 | + } |
| 153 | + } |
| 154 | + return false; |
| 155 | +} |
0 commit comments