protocol.semanticHighlighting.proposed.ts

/* --------------------------------------------------------------------------------------------
 * Copyright (c) TypeFox. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for license information.
 * ------------------------------------------------------------------------------------------ */
'use strict';

import { NotificationType } from 'vscode-jsonrpc';

/**
 * Parameters for the semantic highlighting (server-side) push notification.
 */
export interface SemanticHighlightingParams {

	/**
	 * The URI for which semantic highlighting information is reported to.
	 */
	uri: string;

	/**
	 * An array of semantic highlighting information.
	 */
	lines: SemanticHighlightingInformation[];

}

/**
 * Represents a semantic highlighting information that has to be applied on a specific line of the text document.
 */
export interface SemanticHighlightingInformation {

	/**
	 * The zero-based line position in the text document.
	 */
	line: number;

	/**
	 * An array of highlighting tokens for the current line in the text document.
	 */
	tokens: SemanticHighlightingToken[];

}

/**
 * Representation of a single semantic highlighting token that has to be applied on a line of the text document.
 */
export interface SemanticHighlightingToken {

	/**
	 * The zero-based character offset on the line in a text document where this token applies. If negative, defaults to `0`.
	 * If greater than the length of the current line, defaults to the end of the line.
	 */
	character: number;

	/**
	 * The length of the token. If negative, defaults to `0`. If the sum of the `character` and the `length` exceeds the length of the line,
	 * it defaults back to the end of the line.
	 */
	length: number;

	/**
	 * An array of semantic highlighting [TextMate scopes](https://manual.macromates.com/en/language_grammars) for the current token.
	 */
	scopes: string[];

}

/**
 * Language server push notification providing the semantic highlighting information for a text document.
 */
export namespace SemanticHighlightingNotification {
	export const type = new NotificationType<SemanticHighlightingParams, void>('textDocument/semanticHighlighting');
}

/**
 * Capability that has to be set by the language client if that supports the semantic highlighting feature for the text documents.
 */
export interface SemanticHighlightingClientCapabilities {

	/**
	 * The text document client capabilities.
	 */
	textDocument?: {

		/**
		 * `true` if the client supports semantic highlighting support text documents. Otherwise, `false`. It is `false` by default.
		 */
		semanticHighlighting?: boolean;

	}
}