Diplomat documentation

Introduction

• Introduction
  • VS Code extension
  • Language server
• Setup Diplomat
  • Getting a working copy of Diplomat
    • Pre-built binaries
    • Build from source
      • VS Code extension
      • Language server
• Configuring Diplomat
  • Setting up the source tree
    • Selecting the top-level
    • Excluding files
    • Saving and loading the configuration
    • Adding include paths
    • Configuration file format

VS Code extension

• Development features
  • Code analysis
  • Completion suggestions
  • Code navigation
  • Symbol renaming
  • Module instanciaton
• Testing features
  • Cocotb tests discovery
• Simulation debug features
  • Open waveform in viewer
  • Hierarchy explorer
  • Inline value display
  • Adding signal to the waveform
• VS Code provided contribution points
  • Context keys
    • diplomat-host:enabled
    • diplomat-host:followWaveSelection
    • diplomat-host:supportedDesignFiles
    • diplomat-host:supportedWavesFiles
    • diplomat-host:viewerEnabled
    • diplomat-host:viewerCanFollowSignal

Language server

• Supported standard LSP commands
  • initialize request
  • initialized notification
  • exit notification
  • shutdown request
  • textDocument/didOpen notification
  • textDocument/didSave notification
  • textDocument/definition request
  • textDocument/references request
  • textDocument/rename request
  • textDocument/formatting request
  • workspace/didChangeWorkspaceFolders notification
  • textDocument/publishDiagnostics notification
  • workspace/executeCommand notification
• Custom Language Server commands

Indices and tables

• Index

• Module Index

• Search Page