debug console: add copy all action

#2163
microsoft · May 16, 2017 · 9afd541 · 9afd541
1 parent cd6ee09
commit 9afd541
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 9 deletions.
diff --git a/src/vs/workbench/parts/debug/common/debug.ts b/src/vs/workbench/parts/debug/common/debug.ts
@@ -69,12 +69,16 @@ export interface ITreeElement {
 	getId(): string;
 }
 
+export interface IReplElement extends ITreeElement {
+	toString(): string;
+}
+
 export interface IExpressionContainer extends ITreeElement {
 	hasChildren: boolean;
 	getChildren(): TPromise<IExpression[]>;
 }
 
-export interface IExpression extends ITreeElement, IExpressionContainer {
+export interface IExpression extends IReplElement, IExpressionContainer {
 	name: string;
 	value: string;
 	valueChanged?: boolean;
@@ -277,7 +281,7 @@ export interface IModel extends ITreeElement {
 	getFunctionBreakpoints(): IFunctionBreakpoint[];
 	getExceptionBreakpoints(): IExceptionBreakpoint[];
 	getWatchExpressions(): IExpression[];
-	getReplElements(): ITreeElement[];
+	getReplElements(): IReplElement[];
 
 	onDidChangeBreakpoints: Event<void>;
 	onDidChangeCallStack: Event<void>;

diff --git a/src/vs/workbench/parts/debug/common/debugModel.ts b/src/vs/workbench/parts/debug/common/debugModel.ts
@@ -18,14 +18,14 @@ import { ISuggestion } from 'vs/editor/common/modes';
 import { Position } from 'vs/editor/common/core/position';
 import {
 	ITreeElement, IExpression, IExpressionContainer, IProcess, IStackFrame, IExceptionBreakpoint, IBreakpoint, IFunctionBreakpoint, IModel,
-	IConfig, ISession, IThread, IRawModelUpdate, IScope, IRawStoppedDetails, IEnablement, IRawBreakpoint, IExceptionInfo
+	IConfig, ISession, IThread, IRawModelUpdate, IScope, IRawStoppedDetails, IEnablement, IRawBreakpoint, IExceptionInfo, IReplElement
 } from 'vs/workbench/parts/debug/common/debug';
 import { Source } from 'vs/workbench/parts/debug/common/debugSource';
 import { IWorkbenchEditorService } from 'vs/workbench/services/editor/common/editorService';
 
 const MAX_REPL_LENGTH = 10000;
 
-export abstract class AbstractOutputElement implements ITreeElement {
+export abstract class AbstractOutputElement implements IReplElement {
 	private static ID_COUNTER = 0;
 
 	constructor(private id = AbstractOutputElement.ID_COUNTER++) {
@@ -35,6 +35,8 @@ export abstract class AbstractOutputElement implements ITreeElement {
 	public getId(): string {
 		return `outputelement:${this.id}`;
 	}
+
+	abstract toString(): string;
 }
 
 export class OutputElement extends AbstractOutputElement {
@@ -48,6 +50,10 @@ export class OutputElement extends AbstractOutputElement {
 		super();
 		this.counter = 1;
 	}
+
+	public toString(): string {
+		return this.value;
+	}
 }
 
 export class OutputNameValueElement extends AbstractOutputElement implements IExpression {
@@ -88,6 +94,10 @@ export class OutputNameValueElement extends AbstractOutputElement implements IEx
 
 		return TPromise.as(result);
 	}
+
+	public toString(): string {
+		return `${this.name}: ${this.value}`;
+	}
 }
 
 export class ExpressionContainer implements IExpressionContainer {
@@ -197,6 +207,10 @@ export class ExpressionContainer implements IExpressionContainer {
 			ExpressionContainer.allValues.get(this.getId()) !== Expression.DEFAULT_VALUE && ExpressionContainer.allValues.get(this.getId()) !== value;
 		ExpressionContainer.allValues.set(this.getId(), value);
 	}
+
+	public toString(): string {
+		return this.value;
+	}
 }
 
 export class Expression extends ExpressionContainer implements IExpression {
@@ -244,6 +258,10 @@ export class Expression extends ExpressionContainer implements IExpression {
 			this.reference = 0;
 		});
 	}
+
+	public toString(): string {
+		return `${this.name}\n${this.value}`;
+	}
 }
 
 export class Variable extends ExpressionContainer implements IExpression {
@@ -285,6 +303,10 @@ export class Variable extends ExpressionContainer implements IExpression {
 			this.errorMessage = err.message;
 		});
 	}
+
+	public toString(): string {
+		return `${this.name}: ${this.value}`;
+	}
 }
 
 export class Scope extends ExpressionContainer implements IScope {
@@ -714,7 +736,7 @@ export class Model implements IModel {
 
 	private processes: Process[];
 	private toDispose: lifecycle.IDisposable[];
-	private replElements: ITreeElement[];
+	private replElements: IReplElement[];
 	private _onDidChangeBreakpoints: Emitter<void>;
 	private _onDidChangeCallStack: Emitter<void>;
 	private _onDidChangeWatchExpressions: Emitter<IExpression>;
@@ -902,7 +924,7 @@ export class Model implements IModel {
 		this._onDidChangeBreakpoints.fire();
 	}
 
-	public getReplElements(): ITreeElement[] {
+	public getReplElements(): IReplElement[] {
 		return this.replElements;
 	}
 
@@ -939,7 +961,7 @@ export class Model implements IModel {
 		this._onDidChangeREPLElements.fire();
 	}
 
-	private addReplElements(newElements: ITreeElement[]): void {
+	private addReplElements(newElements: IReplElement[]): void {
 		this.replElements.push(...newElements);
 		if (this.replElements.length > MAX_REPL_LENGTH) {
 			this.replElements.splice(0, this.replElements.length - MAX_REPL_LENGTH);

diff --git a/src/vs/workbench/parts/debug/electron-browser/electronDebugActions.ts b/src/vs/workbench/parts/debug/electron-browser/electronDebugActions.ts
@@ -6,9 +6,10 @@
 import * as nls from 'vs/nls';
 import { Action } from 'vs/base/common/actions';
 import { TPromise } from 'vs/base/common/winjs.base';
-import { clipboard } from 'electron';
+import { ITree } from 'vs/base/parts/tree/browser/tree';
 import { Variable } from 'vs/workbench/parts/debug/common/debugModel';
 import { IDebugService, IStackFrame } from 'vs/workbench/parts/debug/common/debug';
+import { clipboard } from 'electron';
 
 export class CopyValueAction extends Action {
 	static ID = 'workbench.debug.viewlet.action.copyValue';
@@ -42,6 +43,30 @@ export class CopyAction extends Action {
 	}
 }
 
+export class CopyAllAction extends Action {
+	static ID = 'workbench.debug.action.copyAll';
+	static LABEL = nls.localize('copyAll', "Copy All");
+
+	constructor(id: string, label: string, private tree: ITree) {
+		super(id, label);
+	}
+
+	public run(): TPromise<any> {
+		let text = '';
+		const navigator = this.tree.getNavigator();
+		// skip first navigator element - the root node
+		while (navigator.next()) {
+			if (text) {
+				text += `\n`;
+			}
+			text += navigator.current().toString();
+		}
+
+		clipboard.writeText(text);
+		return TPromise.as(null);
+	}
+}
+
 export class CopyStackTraceAction extends Action {
 	static ID = 'workbench.action.debug.copyStackTrace';
 	static LABEL = nls.localize('copyStackTrace', "Copy Call Stack");

diff --git a/src/vs/workbench/parts/debug/electron-browser/replViewer.ts b/src/vs/workbench/parts/debug/electron-browser/replViewer.ts
@@ -17,7 +17,7 @@ import { IExpressionContainer, IExpression } from 'vs/workbench/parts/debug/comm
 import { Model, OutputNameValueElement, Expression, OutputElement, Variable } from 'vs/workbench/parts/debug/common/debugModel';
 import { renderVariable, renderExpressionValue, IVariableTemplateData, BaseDebugController } from 'vs/workbench/parts/debug/electron-browser/debugViewer';
 import { ClearReplAction } from 'vs/workbench/parts/debug/browser/debugActions';
-import { CopyAction } from 'vs/workbench/parts/debug/electron-browser/electronDebugActions';
+import { CopyAction, CopyAllAction } from 'vs/workbench/parts/debug/electron-browser/electronDebugActions';
 import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
 import { IWorkbenchEditorService } from 'vs/workbench/services/editor/common/editorService';
 import { LinkDetector } from 'vs/workbench/parts/debug/browser/linkDetector';
@@ -408,6 +408,7 @@ export class ReplExpressionsActionProvider implements IActionProvider {
 	public getSecondaryActions(tree: ITree, element: any): TPromise<IAction[]> {
 		const actions: IAction[] = [];
 		actions.push(new CopyAction(CopyAction.ID, CopyAction.LABEL));
+		actions.push(new CopyAllAction(CopyAllAction.ID, CopyAllAction.LABEL, tree));
 		actions.push(this.instantiationService.createInstance(ClearReplAction, ClearReplAction.ID, ClearReplAction.LABEL));
 
 		return TPromise.as(actions);