SQL Operations Studio Public Preview 1 (0.23) release source code

src/vs/platform/workspace/common/workspace.ts

@@ -0,0 +1,200 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+'use strict';
+
+import URI from 'vs/base/common/uri';
+import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
+import * as paths from 'vs/base/common/paths';
+import { TrieMap } from 'vs/base/common/map';
+import Event from 'vs/base/common/event';
+import { isLinux } from 'vs/base/common/platform';
+import { distinct } from 'vs/base/common/arrays';
+
+export const IWorkspaceContextService = createDecorator<IWorkspaceContextService>('contextService');
+
+export interface IWorkspaceContextService {
+	_serviceBrand: any;
+
+	/**
+	 * Returns if the application was opened with a workspace or not.
+	 */
+	hasWorkspace(): boolean;
+
+	/**
+	 * Returns if the application was opened with a folder.
+	 */
+	hasFolderWorkspace(): boolean;
+
+	/**
+	 * Returns if the application was opened with a workspace that can have one or more folders.
+	 */
+	hasMultiFolderWorkspace(): boolean;
+
+	/**
+	 * Provides access to the workspace object the platform is running with. This may be null if the workbench was opened
+	 * without workspace (empty);
+	 */
+	getLegacyWorkspace(): ILegacyWorkspace;
+
+	/**
+	 * Provides access to the workspace object the platform is running with. This may be null if the workbench was opened
+	 * without workspace (empty);
+	 */
+	getWorkspace(): IWorkspace;
+
+	/**
+	 * An event which fires on workspace name changes.
+	 */
+	onDidChangeWorkspaceName: Event<void>;
+
+	/**
+	 * An event which fires on workspace roots change.
+	 */
+	onDidChangeWorkspaceRoots: Event<void>;
+
+	/**
+	 * Returns the root for the given resource from the workspace.
+	 * Can be null if there is no workspace or the resource is not inside the workspace.
+	 */
+	getRoot(resource: URI): URI;
+
+	/**
+	 * Returns if the provided resource is inside the workspace or not.
+	 */
+	isInsideWorkspace(resource: URI): boolean;
+
+	/**
+	 * Given a workspace relative path, returns the resource with the absolute path.
+	 */
+	toResource: (workspaceRelativePath: string) => URI;
+}
+
+export interface ILegacyWorkspace {
+
+	/**
+	 * the full uri of the workspace. this is a file:// URL to the location
+	 * of the workspace on disk.
+	 */
+	resource: URI;
+
+	/**
+	 * creation time of the workspace folder if known
+	 */
+	ctime?: number;
+}
+
+export interface IWorkspace {
+
+	/**
+	 * the unique identifier of the workspace.
+	 */
+	readonly id: string;
+
+	/**
+	 * the name of the workspace.
+	 */
+	readonly name: string;
+
+	/**
+	 * Roots in the workspace.
+	 */
+	readonly roots: URI[];
+
+	/**
+	 * the location of the workspace configuration
+	 */
+	readonly configuration?: URI;
+}
+
+export class LegacyWorkspace implements ILegacyWorkspace {
+	private _name: string;
+
+	constructor(private _resource: URI, private _ctime?: number) {
+		this._name = paths.basename(this._resource.fsPath) || this._resource.fsPath;
+	}
+
+	public get resource(): URI {
+		return this._resource;
+	}
+
+	public get name(): string {
+		return this._name;
+	}
+
+	public get ctime(): number {
+		return this._ctime;
+	}
+
+	public toResource(workspaceRelativePath: string, root?: URI): URI {
+		if (typeof workspaceRelativePath === 'string') {
+			return URI.file(paths.join(root ? root.fsPath : this._resource.fsPath, workspaceRelativePath));
+		}
+
+		return null;
+	}
+}
+
+export class Workspace implements IWorkspace {
+
+	private _rootsMap: TrieMap<URI> = new TrieMap<URI>();
+	private _roots: URI[];
+
+	constructor(
+		public readonly id: string,
+		private _name: string,
+		roots: URI[],
+		private _configuration: URI = null
+	) {
+		this.roots = roots;
+	}
+
+	private ensureUnique(roots: URI[]): URI[] {
+		return distinct(roots, root => isLinux ? root.fsPath : root.fsPath.toLowerCase());
+	}
+
+	public get roots(): URI[] {
+		return this._roots;
+	}
+
+	public set roots(roots: URI[]) {
+		this._roots = this.ensureUnique(roots);
+		this.updateRootsMap();
+	}
+
+	public get name(): string {
+		return this._name;
+	}
+
+	public set name(name: string) {
+		this._name = name;
+	}
+
+	public get configuration(): URI {
+		return this._configuration;
+	}
+
+	public set configuration(configuration: URI) {
+		this._configuration = configuration;
+	}
+
+	public getRoot(resource: URI): URI {
+		if (!resource) {
+			return null;
+		}
+
+		return this._rootsMap.findSubstr(resource.fsPath);
+	}
+
+	private updateRootsMap(): void {
+		this._rootsMap = new TrieMap<URI>();
+		for (const root of this.roots) {
+			this._rootsMap.insert(root.fsPath, root);
+		}
+	}
+
+	public toJSON(): IWorkspace {
+		return { id: this.id, roots: this.roots, name: this.name };
+	}
+}

src/vs/platform/workspace/test/common/testWorkspace.ts

@@ -0,0 +1,18 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import URI from 'vs/base/common/uri';
+import { Workspace } from 'vs/platform/workspace/common/workspace';
+
+const wsUri = URI.file('C:\\testWorkspace');
+export const TestWorkspace = testWorkspace(wsUri);
+
+export function testWorkspace(resource: URI): Workspace {
+	return new Workspace(
+		resource.toString(),
+		resource.fsPath,
+		[resource]
+	);
+}

src/vs/platform/workspace/test/common/workspace.test.ts

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+'use strict';
+
+import * as assert from 'assert';
+import { Workspace } from 'vs/platform/workspace/common/workspace';
+import URI from 'vs/base/common/uri';
+
+suite('Workspace', () => {
+
+	test('Workspace ensures unique roots', () => {
+
+		// Unique
+		let roots = [URI.file('/some/path'), URI.file('/some/path')];
+		let ws = new Workspace('id', 'name', roots, URI.file('/config'));
+
+		assert.equal(ws.roots.length, 1);
+	});
+});