actions.ts ×25

Frontier kind: Code frontier

unlabeled · c_69ce8899bcad

1350 tests · 5554 LOC · 30 files · introduces 0 tests · 151 LOC · 1 file

Introduces — evidence that enters the hierarchy at this concept

Code
25 ranges151 lines · 1 files
Tests
0 tests

Contains — complete concept membership

All code (extent)
771 ranges5554 lines · 30 files · Browse complete extent
All tests (intent)
1350 testsBrowse complete intent

Neighbourhood graph

The orange circle is the focus. Violet and green circles are every ancestor and descendant, broader and narrower, at any distance; blue squares and pink diamonds are the introduced files and exact introduced tests of every visible concept, not only the focus's. Arrows point from broader to narrower concepts and bridge only concepts omitted from this view. Undirected links show source or test introduction. Concept and file size follows LOC; exact test nodes use test-count units.

Introduced files, introduced tests, and structurally relevant concept specialization

In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the native relationship evidence on this page.

Graph controls are ready.

Interactive rendering requires JavaScript and WebGL. Use the native relationship evidence on this page while the interactive map is unavailable.

Native relationship evidence

Every exact file and test below is linked only from the concept that introduces it.

Introduced tests

Every collected test enters the hierarchy at exactly one concept.

No tests are introduced at this concept. Its intent tests are introduced by other concepts.

Introduced code

Every collected source range enters the hierarchy at exactly one concept.

1 file ranked by introduced lines: 151 introduced LOC across 25 ranges. Expand a file to inspect source; the > gutter marks introduced lines.

src/vs/base/common/actions.ts 151 introduced LOC · 25 ranges

Open complete file

1 > /*--------------------------------------------------------------------------------------------- actions.ts
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 > import { Emitter, Event } from './event.js';
7 > import { Disposable, IDisposable } from './lifecycle.js';
8 > import * as nls from '../../nls.js';
9 >
10 > export interface ITelemetryData {
11 > readonly from?: string;
12 > readonly target?: string;
13 > [key: string]: unknown;
14 > }
15 >
16 > export type WorkbenchActionExecutedClassification = {
17 > id: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The identifier of the action that was run.' };
18 > from: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The name of the component the action was run from.' };
19 > detail?: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'Optional details about how the action was run, e.g which keybinding was used.' };
20 > owner: 'isidorn';
21 > comment: 'Provides insight into actions that are executed within the workbench.';
22 > };
23 >
24 > export type WorkbenchActionExecutedEvent = {
25 > id: string;
26 > from: string;
27 > detail?: string;
28 > };
29 >
30 > export interface IAction {
31 > readonly id: string;
32 > label: string;
33 > tooltip: string;
34 > class: string | undefined;
35 > enabled: boolean;
36 > checked?: boolean;
37 > run(...args: unknown[]): unknown;
38 > }
39 >
40 > export interface IActionRunner extends IDisposable {
41 > readonly onDidRun: Event<IRunEvent>;
42 > readonly onWillRun: Event<IRunEvent>;
43 >
44 > run(action: IAction, context?: unknown): unknown;
45 > }
46 >
47 > export interface IActionChangeEvent {
48 > readonly label?: string;
49 > readonly tooltip?: string;
50 > readonly class?: string;
51 > readonly enabled?: boolean;
52 > readonly checked?: boolean;
53 > }
54 >
55 > /**
56 > * A concrete implementation of {@link IAction}.
57 > *
58 > * Note that in most cases you should use the lighter-weight {@linkcode toAction} function instead.
59 > */
60 > export class Action extends Disposable implements IAction {
61 >
62 > protected _onDidChange = this._register(new Emitter<IActionChangeEvent>());
63 > get onDidChange() { return this._onDidChange.event; }
64 >
65 > protected readonly _id: string;
66 > protected _label: string;
67 > protected _tooltip: string | undefined;
68 > protected _cssClass: string | undefined;
69 > protected _enabled: boolean = true;
70 > protected _checked?: boolean;
71 > protected readonly _actionCallback?: (event?: unknown) => unknown;
72 >
73 > constructor(id: string, label: string = '', cssClass: string = '', enabled: boolean = true, actionCallback?: (event?: unknown) => unknown) {
74 super();
75 this._id = id;
79 this._actionCallback = actionCallback;
80 }
81 > actions.ts
82 > get id(): string {
83 return this._id;
84 }
85 > actions.ts
86 > get label(): string {
87 return this._label;
88 }
89 > actions.ts
90 > set label(value: string) {
91 this._setLabel(value);
92 }
93 > actions.ts
94 > private _setLabel(value: string): void {
95 if (this._label !== value) {
96 this._label = value;
98 }
99 }
100 > actions.ts
101 > get tooltip(): string {
102 return this._tooltip || '';
103 }
104 > actions.ts
105 > set tooltip(value: string) {
106 this._setTooltip(value);
107 }
108 > actions.ts
109 > protected _setTooltip(value: string): void {
110 if (this._tooltip !== value) {
111 this._tooltip = value;
113 }
114 }
115 > actions.ts
116 > get class(): string | undefined {
117 return this._cssClass;
118 }
119 > actions.ts
120 > set class(value: string | undefined) {
121 this._setClass(value);
122 }
123 > actions.ts
124 > protected _setClass(value: string | undefined): void {
125 if (this._cssClass !== value) {
126 this._cssClass = value;
128 }
129 }
130 > actions.ts
131 > get enabled(): boolean {
132 return this._enabled;
133 }
134 > actions.ts
135 > set enabled(value: boolean) {
136 this._setEnabled(value);
137 }
138 > actions.ts
139 > protected _setEnabled(value: boolean): void {
140 if (this._enabled !== value) {
141 this._enabled = value;
143 }
144 }
145 > actions.ts
146 > get checked(): boolean | undefined {
147 return this._checked;
148 }
149 > actions.ts
150 > set checked(value: boolean | undefined) {
151 this._setChecked(value);
152 }
153 > actions.ts
154 > protected _setChecked(value: boolean | undefined): void {
155 if (this._checked !== value) {
156 this._checked = value;
158 }
159 }
160 > actions.ts
161 > async run(event?: unknown, data?: ITelemetryData): Promise<void> {
162 if (this._actionCallback) {
163 await this._actionCallback(event);
164 }
165 }
166 > } actions.ts
167 >
168 > export interface IRunEvent {
169 > readonly action: IAction;
170 > readonly error?: Error;
171 > }
172 >
173 > export class ActionRunner extends Disposable implements IActionRunner {
174
175 private readonly _onWillRun = this._register(new Emitter<IRunEvent>());
177
178 private readonly _onDidRun = this._register(new Emitter<IRunEvent>());
179 > get onDidRun() { return this._onDidRun.event; } actions.ts
180 >
181 > async run(action: IAction, context?: unknown): Promise<void> {
182 if (!action.enabled) {
183 return;
195 this._onDidRun.fire({ action, error });
196 }
197 > actions.ts
198 > protected async runAction(action: IAction, context?: unknown): Promise<void> {
199 await action.run(context);
200 }
201 > } actions.ts
202 >
203 > export class Separator implements IAction {
204
205 /**
248 readonly enabled: boolean = false;
249 readonly checked: undefined = undefined;
250 > async run() { } actions.ts
251 > }
252 >
253 > export class SubmenuAction implements IAction {
254 >
255 > readonly id: string;
256 > readonly label: string;
257 > readonly class: string | undefined;
258 > readonly tooltip: string = '';
259 > readonly enabled: boolean = true;
260 > readonly checked: undefined = undefined;
261 >
262 > private readonly _actions: readonly IAction[];
263 > get actions(): readonly IAction[] { return this._actions; }
264 >
265 > constructor(id: string, label: string, actions: readonly IAction[], cssClass?: string) {
266 this.id = id;
267 this.label = label;
269 this._actions = actions;
270 }
271 > actions.ts
272 > async run(): Promise<void> { }
273 > }
274 >
275 > export class EmptySubmenuAction extends Action {
276 >
277 > static readonly ID = 'vs.actions.empty';
278 >
279 > constructor() {
280 super(EmptySubmenuAction.ID, nls.localize('submenu.empty', '(empty)'), undefined, false);
281 }
282 > } actions.ts
283 >
284 > export function toAction(props: { id: string; label: string; tooltip?: string; enabled?: boolean; checked?: boolean; class?: string; run: Function }): IAction {
285 return {
286 id: props.id,