Interface LangiumDocumentFactory

Shared service for creating LangiumDocument instances.

Register a custom implementation if special (additional) behavior is required for your language(s). Note: If you specialize fromString or fromTextDocument you probably might want to specialize update, too!

interface LangiumDocumentFactory {
    fromModel<T>(model: T, uri: URI): LangiumDocument<T>;
    fromString<T>(text: string, uri: URI, options?: ParserOptions): LangiumDocument<T>;
    fromString<T>(text: string, uri: URI, cancellationToken: CancellationToken): Promise<LangiumDocument<T>>;
    fromTextDocument<T>(textDocument: TextDocument, uri?: URI, options?: ParserOptions): LangiumDocument<T>;
    fromTextDocument<T>(textDocument: TextDocument, uri: undefined | URI, cancellationToken: CancellationToken): Promise<LangiumDocument<T>>;
    fromUri<T>(uri: URI, cancellationToken?: CancellationToken): Promise<LangiumDocument<T>>;
    update<T>(document: LangiumDocument<T>, cancellationToken: CancellationToken): Promise<LangiumDocument<T>>;
}

Implemented by

DefaultLangiumDocumentFactory

Index

Methods

fromModel fromString fromTextDocument fromUri update

Methods

fromModel

fromModel<T>(model, uri): LangiumDocument<T>
Create an Langium document from a model that has been constructed in memory.
Type Parameters
- T extends AstNode = AstNode
Parameters
- model: T
- uri: URI
Returns LangiumDocument<T>
- Defined in packages/langium/src/workspace/documents.ts:147

fromString

fromString<T>(text, uri, options?): LangiumDocument<T>
Create an Langium document from an in-memory string.
Type Parameters
- T extends AstNode = AstNode
Parameters
- text: string
- uri: URI
- Optionaloptions: ParserOptions
Returns LangiumDocument<T>
- Defined in packages/langium/src/workspace/documents.ts:138
fromString<T>(text, uri, cancellationToken): Promise<LangiumDocument<T>>
Create a Langium document from an in-memory string asynchronously. This action can be cancelled if a cancellable parser implementation has been provided.
Type Parameters
- T extends AstNode = AstNode
Parameters
- text: string
- uri: URI
- cancellationToken: CancellationToken
Returns Promise<LangiumDocument<T>>
- Defined in packages/langium/src/workspace/documents.ts:142

fromTextDocument

fromTextDocument<T>(textDocument, uri?, options?): LangiumDocument<T>
Create a Langium document from a TextDocument (usually associated with a file).
Type Parameters
- T extends AstNode = AstNode
Parameters
- textDocument: TextDocument
- Optionaluri: URI
- Optionaloptions: ParserOptions
Returns LangiumDocument<T>
- Defined in packages/langium/src/workspace/documents.ts:129
fromTextDocument<T>(textDocument, uri, cancellationToken): Promise<LangiumDocument<T>>
Create a Langium document from a TextDocument asynchronously. This action can be cancelled if a cancellable parser implementation has been provided.
Type Parameters
- T extends AstNode = AstNode
Parameters
- textDocument: TextDocument
- uri: undefined | URI
- cancellationToken: CancellationToken
Returns Promise<LangiumDocument<T>>
- Defined in packages/langium/src/workspace/documents.ts:133

fromUri

fromUri<T>(uri, cancellationToken?): Promise<LangiumDocument<T>>
Create an Langium document from a specified URI. The factory will use the FileSystemAccess service to read the file.
Type Parameters
- T extends AstNode = AstNode
Parameters
- uri: URI
- OptionalcancellationToken: CancellationToken
Returns Promise<LangiumDocument<T>>
- Defined in packages/langium/src/workspace/documents.ts:152

update

update<T>(document, cancellationToken): Promise<LangiumDocument<T>>
Update the given document after changes in the corresponding textual representation. Method is called by the document builder after it has been requested to build an existing document and the document's state is DocumentState.Changed. The text parsing is expected to be done the same way as in fromTextDocument and fromString.
Type Parameters
- T extends AstNode = AstNode
Parameters
- document: LangiumDocument<T>
- cancellationToken: CancellationToken
Returns Promise<LangiumDocument<T>>
- Defined in packages/langium/src/workspace/documents.ts:161

Interface LangiumDocumentFactory

Implemented by

Index

Methods

Methods

fromModel

Type Parameters

Parameters

Returns LangiumDocument<T>

fromString

Type Parameters

Parameters

Returns LangiumDocument<T>

Type Parameters

Parameters

Returns Promise<LangiumDocument<T>>

fromTextDocument

Type Parameters

Parameters

Returns LangiumDocument<T>

Type Parameters

Parameters

Returns Promise<LangiumDocument<T>>

fromUri

Type Parameters

Parameters

Returns Promise<LangiumDocument<T>>

update

Type Parameters

Parameters

Returns Promise<LangiumDocument<T>>

Settings

On This Page