VerilogServer.h

Go to the documentation of this file.

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// VerilogServer.h
//
// This header declares VerilogServer, the top-level coordinator of the CIRCT
// Verilog LSP server. It manages all open files and acts as the entry point for
// language server operations such as “didOpen”, “didChange”, “didClose”,
// “definition”, and “references”.
//
//===----------------------------------------------------------------------===//
 
#ifndef LIB_CIRCT_TOOLS_CIRCT_VERILOG_LSP_SERVER_VERILOGSERVER_H_
#define LIB_CIRCT_TOOLS_CIRCT_VERILOG_LSP_SERVER_VERILOGSERVER_H_
 
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/LSP/Protocol.h"
 
#include <memory>
#include <optional>
#include <vector>
 
namespace mlir {
namespace lsp {
struct Diagnostic;
struct Position;
struct Location;
struct TextDocumentContentChangeEvent;
class URIForFile;
} // namespace lsp
} // namespace mlir
 
namespace circt {
namespace lsp {
struct VerilogServerOptions;
using TextDocumentContentChangeEvent =
    llvm::lsp::TextDocumentContentChangeEvent;
using URIForFile = llvm::lsp::URIForFile;
using Diagnostic = llvm::lsp::Diagnostic;
 
/// This class implements all of the Verilog related functionality necessary for
/// a language server. This class allows for keeping the Verilog specific logic
/// separate from the logic that involves LSP server/client communication.
class VerilogServer {
public:
  VerilogServer(const circt::lsp::VerilogServerOptions &options);
  ~VerilogServer();
 
  /// Add the document, with the provided `version`, at the given URI. Any
  /// diagnostics emitted for this document should be added to `diagnostics`.
  void addDocument(const URIForFile &uri, llvm::StringRef contents,
                   int64_t version, std::vector<Diagnostic> &diagnostics);
 
  /// Update the document, with the provided `version`, at the given URI. Any
  /// diagnostics emitted for this document should be added to `diagnostics`.
  void updateDocument(const URIForFile &uri,
                      llvm::ArrayRef<TextDocumentContentChangeEvent> changes,
                      int64_t version, std::vector<Diagnostic> &diagnostics);
 
  /// Remove the document with the given uri. Returns the version of the removed
  /// document, or std::nullopt if the uri did not have a corresponding document
  /// within the server.
  std::optional<int64_t> removeDocument(const URIForFile &uri);
 
  /// Return the locations of the object pointed at by the given position.
  void getLocationsOf(const URIForFile &uri, const llvm::lsp::Position &defPos,
                      std::vector<llvm::lsp::Location> &locations);
 
  /// Find all references of the object pointed at by the given position.
  void findReferencesOf(const URIForFile &uri, const llvm::lsp::Position &pos,
                        std::vector<llvm::lsp::Location> &references);
 
private:
  struct Impl;
  std::unique_ptr<Impl> impl;
};
 
} // namespace lsp
} // namespace circt
 
#endif