#include <VerilogDocument.h>

Collaboration diagram for circt::lsp::VerilogDocument:

[legend]

Public Member Functions
	VerilogDocument (VerilogServerContext &globalContext, const llvm::lsp::URIForFile &uri, llvm::StringRef contents, std::vector< llvm::lsp::Diagnostic > &diagnostics, const slang::driver::Driver *projectDriver=nullptr, const std::vector< std::string > &projectIncludeDirectories={})

	VerilogDocument (const VerilogDocument &)=delete

VerilogDocument &	operator= (const VerilogDocument &)=delete

const llvm::lsp::URIForFile &	getURI () const

const slang::SourceManager &	getSlangSourceManager () const

llvm::lsp::Location	getLspLocation (slang::SourceLocation loc) const

llvm::lsp::Location	getLspLocation (slang::SourceRange range) const

slang::BufferID	getMainBufferID () const

void	getLocationsOf (const llvm::lsp::URIForFile &uri, const llvm::lsp::Position &defPos, std::vector< llvm::lsp::Location > &locations)

void	findReferencesOf (const llvm::lsp::URIForFile &uri, const llvm::lsp::Position &pos, std::vector< llvm::lsp::Location > &references)

std::optional< uint32_t >	lspPositionToOffset (const llvm::lsp::Position &pos)

const char *	getPointerFor (const llvm::lsp::Position &pos)

Private Member Functions
std::optional< std::pair< slang::BufferID, llvm::SmallString< 128 > > >	getOrOpenFile (llvm::StringRef filePath)

void	computeLineOffsets (std::string_view text)
	Build a vector of line start offsets (0-based).

Private Attributes
VerilogServerContext &	globalContext

slang::BufferID	mainBufferId

llvm::StringMap< std::pair< slang::BufferID, llvm::SmallString< 128 > > >	filePathMap

llvm::FailureOr< std::unique_ptr< slang::ast::Compilation > >	compilation

slang::driver::Driver	driver

std::unique_ptr< circt::lsp::VerilogIndex >	index
	The index of the parsed module.

std::vector< uint32_t >	lineOffsets
	The precomputed line offsets for faster lookups.

llvm::lsp::URIForFile	uri

Detailed Description

Definition at line 38 of file VerilogDocument.h.

Constructor & Destructor Documentation

◆ VerilogDocument() [1/2]

circt::lsp::VerilogDocument::VerilogDocument	(	VerilogServerContext &	globalContext,
		const llvm::lsp::URIForFile &	uri,
		llvm::StringRef	contents,
		std::vector< llvm::lsp::Diagnostic > &	diagnostics,
		const slang::driver::Driver *	projectDriver = `nullptr`,
		const std::vector< std::string > &	projectIncludeDirectories = `{}`
	)

◆ VerilogDocument() [2/2]

circt::lsp::VerilogDocument::VerilogDocument ( const VerilogDocument & )

delete

Member Function Documentation

◆ computeLineOffsets()

void VerilogDocument::computeLineOffsets ( std::string_view text )

private

Build a vector of line start offsets (0-based).

Definition at line 297 of file VerilogDocument.cpp.

References lineOffsets.

◆ findReferencesOf()

void VerilogDocument::findReferencesOf	(	const llvm::lsp::URIForFile &	uri,
		const llvm::lsp::Position &	pos,
		std::vector< llvm::lsp::Location > &	references
	)

Definition at line 405 of file VerilogDocument.cpp.

References getLspLocation(), getPointerFor(), and index.

◆ getLocationsOf()

void VerilogDocument::getLocationsOf	(	const llvm::lsp::URIForFile &	uri,
		const llvm::lsp::Position &	defPos,
		std::vector< llvm::lsp::Location > &	locations
	)

Definition at line 358 of file VerilogDocument.cpp.

References circt::lsp::Logger::error(), getLspLocation(), getOrOpenFile(), getPointerFor(), getRange(), index, and uri.

◆ getLspLocation() [1/2]

llvm::lsp::Location VerilogDocument::getLspLocation ( slang::SourceLocation loc ) const

Definition at line 202 of file VerilogDocument.cpp.

References getSlangSourceManager(), mainBufferId, and uri.

Referenced by findReferencesOf(), getLocationsOf(), getLspLocation(), and circt::lsp::LSPDiagnosticClient::report().

◆ getLspLocation() [2/2]

llvm::lsp::Location VerilogDocument::getLspLocation ( slang::SourceRange range ) const

Definition at line 235 of file VerilogDocument.cpp.

References getLspLocation().

◆ getMainBufferID()

slang::BufferID circt::lsp::VerilogDocument::getMainBufferID ( ) const

inline

Definition at line 58 of file VerilogDocument.h.

References mainBufferId.

◆ getOrOpenFile()

std::optional< std::pair< slang::BufferID, SmallString< 128 > > > VerilogDocument::getOrOpenFile ( llvm::StringRef filePath )

private

Definition at line 248 of file VerilogDocument.cpp.

References driver, circt::lsp::VerilogServerOptions::extraSourceLocationDirs, filePathMap, globalContext, and circt::lsp::VerilogServerContext::options.

Referenced by getLocationsOf().

◆ getPointerFor()

const char * VerilogDocument::getPointerFor ( const llvm::lsp::Position & pos )

Definition at line 347 of file VerilogDocument.cpp.

References getSlangSourceManager(), lspPositionToOffset(), and mainBufferId.

Referenced by findReferencesOf(), and getLocationsOf().

◆ getSlangSourceManager()

const slang::SourceManager & circt::lsp::VerilogDocument::getSlangSourceManager ( ) const

inline

Definition at line 50 of file VerilogDocument.h.

References driver.

Referenced by getLspLocation(), getPointerFor(), and lspPositionToOffset().

◆ getURI()

const llvm::lsp::URIForFile & circt::lsp::VerilogDocument::getURI ( ) const

inline

Definition at line 48 of file VerilogDocument.h.

References uri.

Referenced by circt::lsp::LSPDiagnosticClient::report().

◆ lspPositionToOffset()

std::optional< uint32_t > VerilogDocument::lspPositionToOffset ( const llvm::lsp::Position & pos )

Definition at line 310 of file VerilogDocument.cpp.

References getSlangSourceManager(), lineOffsets, and mainBufferId.

Referenced by getPointerFor().

◆ operator=()

VerilogDocument & circt::lsp::VerilogDocument::operator= ( const VerilogDocument & )

delete

Member Data Documentation

◆ compilation

llvm::FailureOr<std::unique_ptr<slang::ast::Compilation> > circt::lsp::VerilogDocument::compilation

private

Definition at line 89 of file VerilogDocument.h.

◆ driver

slang::driver::Driver circt::lsp::VerilogDocument::driver

private

Definition at line 92 of file VerilogDocument.h.

Referenced by getOrOpenFile(), and getSlangSourceManager().

◆ filePathMap

llvm::StringMap<std::pair<slang::BufferID, llvm::SmallString<128> > > circt::lsp::VerilogDocument::filePathMap

private

Definition at line 86 of file VerilogDocument.h.

Referenced by getOrOpenFile().

◆ globalContext

VerilogServerContext& circt::lsp::VerilogDocument::globalContext

private

Definition at line 79 of file VerilogDocument.h.

Referenced by getOrOpenFile().

◆ index

std::unique_ptr<circt::lsp::VerilogIndex> circt::lsp::VerilogDocument::index

private

The index of the parsed module.

Definition at line 95 of file VerilogDocument.h.

Referenced by findReferencesOf(), and getLocationsOf().

◆ lineOffsets

std::vector<uint32_t> circt::lsp::VerilogDocument::lineOffsets

private

The precomputed line offsets for faster lookups.

Definition at line 98 of file VerilogDocument.h.

Referenced by computeLineOffsets(), and lspPositionToOffset().

◆ mainBufferId

slang::BufferID circt::lsp::VerilogDocument::mainBufferId

private

Definition at line 81 of file VerilogDocument.h.

Referenced by getLspLocation(), getMainBufferID(), getPointerFor(), and lspPositionToOffset().

◆ uri

llvm::lsp::URIForFile circt::lsp::VerilogDocument::uri

private

Definition at line 102 of file VerilogDocument.h.

Referenced by getLocationsOf(), getLspLocation(), and getURI().

The documentation for this class was generated from the following files:

/home/runner/work/circt-www/circt-www/circt_src/lib/Tools/circt-verilog-lsp-server/VerilogServerImpl/VerilogDocument.h
/home/runner/work/circt-www/circt-www/circt_src/lib/Tools/circt-verilog-lsp-server/VerilogServerImpl/VerilogDocument.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VerilogDocument() [1/2]

◆ VerilogDocument() [2/2]

Member Function Documentation

◆ computeLineOffsets()

◆ findReferencesOf()

◆ getLocationsOf()

◆ getLspLocation() [1/2]

◆ getLspLocation() [2/2]

◆ getMainBufferID()

◆ getOrOpenFile()

◆ getPointerFor()

◆ getSlangSourceManager()

◆ getURI()

◆ lspPositionToOffset()

◆ operator=()

Member Data Documentation

◆ compilation

◆ driver

◆ filePathMap

◆ globalContext

◆ index

◆ lineOffsets

◆ mainBufferId

◆ uri