51 lines
2.4 KiB
TypeScript
51 lines
2.4 KiB
TypeScript
/******************************************************************************
|
|
* Copyright 2023 TypeFox GmbH
|
|
* This program and the accompanying materials are made available under the
|
|
* terms of the MIT License, which is available in the project root.
|
|
******************************************************************************/
|
|
import type { AstNodeDescription } from '../syntax-tree.js';
|
|
import type { Stream } from '../utils/stream.js';
|
|
/**
|
|
* A scope describes what target elements are visible from a specific cross-reference context.
|
|
*/
|
|
export interface Scope {
|
|
/**
|
|
* Find a target element matching the given name. If no element is found, `undefined` is returned.
|
|
* If multiple matching elements are present, the selection of the returned element should be done
|
|
* according to the semantics of your language. Usually it is the element that is most closely defined.
|
|
*
|
|
* @param name Name of the cross-reference target as it appears in the source text.
|
|
*/
|
|
getElement(name: string): AstNodeDescription | undefined;
|
|
/**
|
|
* Create a stream of all elements in the scope. This is used to compute completion proposals to be
|
|
* shown in the editor.
|
|
*/
|
|
getAllElements(): Stream<AstNodeDescription>;
|
|
}
|
|
export interface ScopeOptions {
|
|
caseInsensitive?: boolean;
|
|
}
|
|
/**
|
|
* The default scope implementation is based on a `Stream`. It has an optional _outer scope_ describing
|
|
* the next level of elements, which are queried when a target element is not found in the stream provided
|
|
* to this scope.
|
|
*/
|
|
export declare class StreamScope implements Scope {
|
|
readonly elements: Stream<AstNodeDescription>;
|
|
readonly outerScope?: Scope;
|
|
readonly caseInsensitive: boolean;
|
|
constructor(elements: Stream<AstNodeDescription>, outerScope?: Scope, options?: ScopeOptions);
|
|
getAllElements(): Stream<AstNodeDescription>;
|
|
getElement(name: string): AstNodeDescription | undefined;
|
|
}
|
|
export declare class MapScope implements Scope {
|
|
readonly elements: Map<string, AstNodeDescription>;
|
|
readonly outerScope?: Scope;
|
|
readonly caseInsensitive: boolean;
|
|
constructor(elements: Iterable<AstNodeDescription>, outerScope?: Scope, options?: ScopeOptions);
|
|
getElement(name: string): AstNodeDescription | undefined;
|
|
getAllElements(): Stream<AstNodeDescription>;
|
|
}
|
|
export declare const EMPTY_SCOPE: Scope;
|
|
//# sourceMappingURL=scope.d.ts.map
|