CirctVerilogLspServerMain.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
//
//===----------------------------------------------------------------------===//
//
// Main entry function for circt-verilog-lsp-server for when built as standalone
// binary.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_TOOLS_CIRCT_VERILOG_LSP_SERVER_CIRCTVERILOGLSPSERVERMAIN_H
#define CIRCT_TOOLS_CIRCT_VERILOG_LSP_SERVER_CIRCTVERILOGLSPSERVERMAIN_H
#include "mlir/Support/LLVM.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/LSP/Transport.h"
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace llvm {
struct LogicalResult;
} // namespace llvm
 
namespace mlir {
namespace lsp {
class JSONTransport;
} // namespace lsp
} // namespace mlir
 
namespace circt {
namespace lsp {
struct VerilogServerOptions {
  VerilogServerOptions(const std::vector<std::string> &libDirs,
                       const std::vector<std::string> &extraSourceLocationDirs,
                       const std::vector<std::string> &commandFiles)
      : libDirs(libDirs), extraSourceLocationDirs(extraSourceLocationDirs),
        commandFiles(commandFiles) {}
  /// Additional list of RTL directories to search.
  const std::vector<std::string> &libDirs;
  /// Additional list of external source directories to search.
  const std::vector<std::string> &extraSourceLocationDirs;
  /// Additional list of command files that reference dependencies of the
  /// project.
  const std::vector<std::string> &commandFiles;
};
// namespace lsp
 
struct LSPServerOptions {
  LSPServerOptions(bool disableDebounce = false, unsigned debounceMinMs = 200,
                   unsigned debounceMaxMs = 1500)
      : disableDebounce(disableDebounce), debounceMinMs(debounceMinMs),
        debounceMaxMs(debounceMaxMs) {}
 
  /// Disable debouncing entirely (updates applied synchronously).
  const bool disableDebounce;
 
  /// Minimum debounce delay in milliseconds.
  const unsigned debounceMinMs;
 
  /// Maximum debounce delay in milliseconds.
  /// A value of 0 means "no cap".
  const unsigned debounceMaxMs;
};
 
/// Implementation for tools like `circt-verilog-lsp-server`.
llvm::LogicalResult
CirctVerilogLspServerMain(const LSPServerOptions &lspOptions,
                          const VerilogServerOptions &options,
                          llvm::lsp::JSONTransport &transport);
 
} // namespace lsp
} // namespace circt
 
#endif // CIRCT_TOOLS_CIRCT_VERILOG_LSP_SERVER_CIRCTVERILOGLSPSERVERMAIN_H