Struct SharedContext

pub struct SharedContext {
    pub lifetime: u64,
    pub world: LspWorld,
    pub analysis: Analysis,
    /* private fields */
}

The shared analysis context for analyzers.

Fields

lifetime: u64

The caches lifetime tick for analysis.

world: LspWorld

The world surface for Typst compiler.

analysis: Analysis

The analysis data

Implementations

impl SharedContext

pub fn revision(&self) -> usize

Get revision of current analysis

pub fn to_typst_pos(&self, position: LspPosition, src: &Source) -> Option<usize>

Convert an LSP position to a Typst position.

pub fn to_typst_pos_offset( &self, source: &Source, position: LspPosition, shift: usize, ) -> Option<usize>

Converts an LSP position with some offset.

pub fn to_lsp_pos(&self, typst_offset: usize, src: &Source) -> LspPosition

Convert a Typst offset to an LSP position.

pub fn to_typst_range( &self, position: LspRange, src: &Source, ) -> Option<Range<usize>>

Convert an LSP range to a Typst range.

pub fn to_lsp_range(&self, position: Range<usize>, src: &Source) -> LspRange

Convert a Typst range to an LSP range.

pub fn to_lsp_range_( &self, position: Range<usize>, fid: TypstFileId, ) -> Option<LspRange>

Convert a Typst range to an LSP range.

pub fn path_for_id(&self, id: TypstFileId) -> Result<PathResolution, FileError>

Resolve the real path for a file id.

pub fn uri_for_id(&self, fid: TypstFileId) -> Result<Url, FileError>

Resolve the uri for a file id.

pub fn file_id_by_path(&self, path: &Path) -> FileResult<TypstFileId>

Get file’s id by its path

pub fn file_by_id(&self, fid: TypstFileId) -> FileResult<Bytes>

Get the content of a file by file id.

pub fn source_by_id(&self, fid: TypstFileId) -> FileResult<Source>

Get the source of a file by file id.

pub fn source_by_path(&self, path: &Path) -> FileResult<Source>

Get the source of a file by file path.

pub fn classify_span<'s>( &self, source: &'s Source, span: Span, ) -> Option<SyntaxClass<'s>>

Classifies the syntax under span that can be operated on by IDE functionality.

pub fn classify_for_decl<'s>( &self, source: &'s Source, position: LspPosition, ) -> Option<SyntaxClass<'s>>

Classifies the syntax under position that can be operated on by IDE functionality. It is preferred to select a decl if it is at the starts of some mark.

pub fn font_info(&self, font: Font) -> Option<Arc<DataSource>>

Resolve extra font information.

pub fn local_packages(&self) -> EcoVec<PackageSpec>

Get the local packages and their descriptions.

pub fn module_by_id(&self, fid: TypstFileId) -> SourceResult<Module>

Get a module by file id.

pub fn module_by_str(&self, rr: String) -> Option<Module>

Get a module by string.

pub fn module_by_src(&self, source: Source) -> SourceResult<Module>

Get (Create) a module by source.

pub fn module_by_syntax(&self, source: &SyntaxNode) -> Option<Value>

Try to load a module from the current source file.

pub fn analyze_import( &self, source: &SyntaxNode, ) -> (Option<Value>, Option<Value>)

Try to find imported target from the current source file. This function will try to resolves target statically.

Returns

The first value is the resolved source. The second value is the resolved scope.

pub fn analyze_expr( &self, source: &SyntaxNode, ) -> EcoVec<(Value, Option<Styles>)>

Try to load a module from the current source file.

pub fn analyze_bib(&self, introspector: &Introspector) -> Option<Arc<BibInfo>>

Get bib info of a source file.

pub fn tooltip(&self, source: &Source, cursor: usize) -> Option<Tooltip>

Describe the item under the cursor.

Passing a document (from a previous compilation) is optional, but enhances the autocompletions. Label completions, for instance, are only generated when the document is available.

pub fn get_manifest(&self, toml_id: TypstFileId) -> StrResult<PackageManifest>

Get the manifest of a package by file id.

pub fn compute_signature( self: &Arc<Self>, func: SignatureTarget, compute: impl FnOnce(&Arc<Self>) -> Option<Signature> + Send + Sync + 'static, ) -> Option<Signature>

Compute the signature of a function.

pub fn remove_html(&self, markup: EcoString) -> EcoString

Remove html tags from markup content if necessary.