vscode/src/vs/editor/node/textMate/vscode-textmate.d.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

declare module "vscode-textmate" {

/**
 * A registry helper that can locate grammar file paths given scope names.
 */
export interface IGrammarLocator {
	getFilePath(scopeName:string): string;
}

/**
 * The registry that will hold all grammars.
 */
export class Registry {

	public static readGrammarInfo(path:string, callback:(err:any, grammarInfo:IGrammarInfo)=>void): void;
	public static readGrammarInfoSync(path:string): IGrammarInfo;

	constructor(locator?:IGrammarLocator);

	/**
	 * Load the grammar for `scopeName` and all referenced included grammars asynchronously.
	 */
	public loadGrammar(scopeName:string, callback:(err:any, grammar:IGrammar)=>void): void;

	/**
	 * Load the grammar at `path` synchronously.
	 */
	public loadGrammarFromPathSync(path:string): IGrammar;

	/**
	 * Get the grammar for `scopeName`. The grammar must first be created via `loadGrammar` or `loadGrammarFromPathSync`.
	 */
	public grammarForScopeName(scopeName:string): IGrammar;
}

export interface IGrammarInfo {
	fileTypes: string[];
	name: string;
	scopeName: string;
	firstLineMatch: string;
}

/**
 * A grammar
 */
export interface IGrammar {
	/**
	 * Tokenize `lineText` using previous line state `prevState`.
	 */
	tokenizeLine(lineText: string, prevState: StackElement[]): ITokenizeLineResult;
}

export interface ITokenizeLineResult {
	tokens: ITMToken[];
	/**
	 * The `prevState` to be passed on to the next line tokenization.
	 */
	ruleStack: StackElement[];
}

export interface ITMToken {
	startIndex: number;
	endIndex: number;
	scopes: string[];
}

/**
 * Should not be used by consumers, as its shape might change at any time.
 */
export interface StackElement {
	ruleId: number;
	enterPos: number;
	endRule: string;
	scopeName: string;
	contentName: string;

	clone(): StackElement;
}


}