@eclipse-glsp/protocol
Version:
The protocol definition for client-server communication in GLSP
100 lines • 4.57 kB
TypeScript
/********************************************************************************
* Copyright (c) 2021-2023 STMicroelectronics and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
import { Operation, RequestAction, ResponseAction } from './base-protocol';
import { Args, EditorContext } from './types';
/**
* Requests the clipboard data for the current editor context, i.e., the selected elements, in a clipboard-compatible format.
* The corresponding namespace declares the action kind as constant and offers helper functions for type guard checks
* and creating new `RequestClipboardDataActions`.
*/
export interface RequestClipboardDataAction extends RequestAction<SetClipboardDataAction> {
kind: typeof RequestClipboardDataAction.KIND;
editorContext: EditorContext;
}
export declare namespace RequestClipboardDataAction {
const KIND = "requestClipboardData";
function is(object: unknown): object is RequestClipboardDataAction;
function create(editorContext: EditorContext, options?: {
requestId?: string;
}): RequestClipboardDataAction;
}
/**
* Server response to a {@link RequestClipboardDataAction} containing the selected elements as clipboard-compatible format.
* The corresponding namespace declares the action kind as constant and offers helper functions for type guard checks
* and creating new `SetClipboardDataActions`.
*/
export interface SetClipboardDataAction extends ResponseAction {
kind: typeof SetClipboardDataAction.KIND;
/**
* The data to be added into the clipboard. This data will be sent back to the server on paste.
*/
clipboardData: ClipboardData;
}
export declare namespace SetClipboardDataAction {
const KIND = "setClipboardData";
function is(object: unknown): object is SetClipboardDataAction;
function create(clipboardData: ClipboardData, options?: {
responseId?: string;
}): SetClipboardDataAction;
}
/**
* Requests a cut operation from the server, i.e., deleting the selected elements from the model. Before submitting a `CutOperation`
* a client should ensure that the cut elements are put into the clipboard.
* The corresponding namespace declares the action kind as constant and offers helper functions for type guard checks
* and creating new `CutOperations`.
*/
export interface CutOperation extends Operation {
kind: typeof CutOperation.KIND;
editorContext: EditorContext;
}
export declare namespace CutOperation {
const KIND = "cut";
function is(object: unknown): object is CutOperation;
function create(editorContext: EditorContext, options?: {
args?: Args;
}): CutOperation;
}
/**
* Requests a paste operation from the server by providing the current clipboard data. Typically this means that elements should be created
* based on the data in the clipboard.
* The corresponding namespace declares the action kind as constant and offers helper functions for type guard checks
* and creating new `PasteOperations`.
*/
export interface PasteOperation extends Operation {
kind: typeof PasteOperation.KIND;
editorContext: EditorContext;
/**
* The clipboard data that should be pasted to the editor's last recorded mouse position (see `editorContext`).
*/
clipboardData: ClipboardData;
}
export declare namespace PasteOperation {
const KIND = "paste";
function is(object: unknown): object is PasteOperation;
function create(options: {
editorContext: EditorContext;
clipboardData: ClipboardData;
args?: Args;
}): PasteOperation;
}
/**
* In GLSP the clipboard needs to be managed by the client but the conversion from the selection to be copied into a
* clipboard-compatible format is handled by the server. By default, GLSP use application/json as exchange format.
*/
export interface ClipboardData {
[format: string]: string;
}
//# sourceMappingURL=clipboard.d.ts.map