Skip to content
DVT SystemVerilog IDE for Eclipse User Guide
25.1.9 (13 May 2025)
⌘ K
DVT SystemVerilog IDE for Eclipse User Guide
25.1.9 (13 May 2025)
  • Installation Checklist
    • Install DVT Using a pre-packed Distribution
    • Install DVT Using the Update Site
    • Set the License
  • Predefined Projects
  • Getting Started
    • What is a Workspace
    • What is a Project
    • Project Natures
    • Workspace and Workbench
    • Refresh
    • Linked Resources
    • Backup and Local History
    • Basic Tutorial
  • Build Configurations
    • Non-top files
    • default.build
    • Auto-config
    • Simulator Log-config
    • Emulating compiler invocations
    • Multiple .build Files
    • Compatibility Modes
    • Paths
    • Strings
    • Comments
    • Environment Variables
    • Including Other Argument Files
    • Build Persistence
    • DVT Auto-Linked
    • Run a Script Before Build
    • All Build Directives
    • e Language Test Files
    • e Language SPECMAN_PATH
    • SystemVerilog OVM or UVM Library Compilation
    • Xilinx Libraries Compilation
    • Intel(Altera) Quartus Libraries Compilation
    • Questa Libraries Compilation
    • Use of External Programs
  • Compile Checks
    • Compile Waivers
    • Semantic Checks
    • Synthesis Checks
    • Performance Checks
    • Dead Code Checks
    • Non Standard Checks
  • Content Assist (Autocomplete)
    • Content assist for CamelCase and Underscore
    • Code Templates
    • Module Automatic Instantiation
    • Override Functions Using Autocomplete
    • Override Constraints Using Autocomplete
    • Implement Extern Functions Using Autocomplete
    • Use Assignment Pattern for Struct Type Variable
  • Quick Fix Proposals
    • Add Parameter to Module
    • Add Port to Module
    • Add Signal to Sensitivity List
    • Add Virtual Qualifier to Interface Type
    • Correct Spelling In Comments and Strings
    • Create Class In New File
    • Create File From Build Config Editor
    • Create Included File
    • Create Interface Class In New File
    • Declare Extern Prototype
    • Declare Method
    • Declare Variable
    • Did You Mean
    • Explicitly Declare
    • Fully Qualify Type
    • Implement Extern Constraint
    • Implement Extern Method
    • Implement Missing Pure Virtual Methods
    • Import Type
    • Remove ‘local’ or ‘protected’ Qualifier
    • Remove Signal from Sensitivity List
    • Remove Signal Never Used
    • Update Extern Prototype/Implementation
    • Update Module Instance
    • Update Virtual Method Signature
    • Waive Compilation Problems
  • Quick Assist Proposals
    • Bind Method Call Arguments by Name
    • Bind Method Call Arguments by Position
    • Connect Instance Ports by Name
    • Connect Instance Ports by Position
    • Collapse Macro
    • Expand Macro
    • Expand .* Port Connections
    • Extract to Variable
    • Extract to Method
    • Extract to Module
    • Move Selection to New File
    • Join Extern and Implementation
    • Split into Extern and Implementation
    • Rename in File
  • AI Assistant
    • Overview
    • Getting Started
    • Key Terms
    • Working in Chat
    • Working in Editor
    • Code Completion
    • Protecting Code
    • Reference
    • Advanced LLM Configuration
    • How to Set-up Local LLMs Using Ollama
    • Troubleshooting
  • Content Filters
    • Content Filters XML syntax
    • Filtering by Element Type
    • Content Filters Examples
    • Predefined Content Filters
  • Code Templates
    • Code Templates in Autocomplete
    • Constraint Code Templates
    • Method Code Templates
    • Global Code Templates
    • Project Level Code Templates
    • Code Templates View
  • File Templates
  • Project Templates
    • What is a project template?
    • How to generate code from a project template
    • Template Configuration
    • Add from Template
  • Code Formatting
    • Whitespace
    • Indentation
    • Vertical Alignment
    • Line Wrapping
    • Disable Format for Code Sections
    • Format Multiple Files
    • External
    • Preferences Keys
    • Automatic Indentation As You Type
  • Override Functions
    • Override Annotation
    • Inspect Overrides in the Quick Type Hierarchy View
    • Inspect Overrides in the Layers View
    • Override Using the Dialog
    • Override Using Autocomplete
    • Override Using the Type Hierarchy View
  • Override Constraints
    • Override Annotation
    • Inspect Overrides in the Quick Type Hierarchy View
    • Inspect Overrides in the Layers View
    • Override Using the Dialog
    • Override Using Autocomplete Proposals
  • Generate Getters and Setters
  • Module Automatic Instantiation
    • Autoinstance Using Autocomplete
    • Autoinstance Using Drag and Drop
  • Semantic Search
  • Show Usages, Readers or Writers
  • Favorite Searches
  • Show Constraints
  • Show Instances
    • Show Instances in the Search View
    • Show Instances in the Design Hierarchy View
  • Quick Search in Views
    • CamelCase
    • Simple Regex
    • Hierarchical Search
    • Search for Members
    • Search Port in Design Hierarchy
    • Search Port in Verification Hierarchy
    • Search all UVM Phase Overrides
    • Search Global API
  • Trace Connections
    • Trace Connections from Design Hierarchy
    • Trace Connections from Editor
    • Trace Connections View
    • Trace Path
  • Breadcrumb Navigation Bar
    • Design Breadcrumb
    • Verification Breadcrumb
    • Scope Breadcrumb
    • Filesystem Breadcrumb
  • Code Factory
  • Refactoring
    • Rename Refactoring
    • Rename Port Across the Design Hierarchy
    • Rename File
    • Bind Method Call Arguments by Name
    • Bind Method Call Arguments by Position
    • Connect Instance Ports by Name
    • Connect Instance Ports by Position
    • Expand .* Port Connections
    • Extract to Variable
    • Extract to Method
    • Extract to Module
    • Move Selection to New File
    • Join Extern and Implementation
    • Split into Extern and Implementation
    • Change Method Signature
    • Connect Instances Across the Design Hierarchy
    • Add Port to Module from Selected Field
    • Add New Port to Module
    • Add New Parameter to Module
    • Refactoring Scripts
  • Diagrams
    • UML Diagrams
    • Architecture UML Diagrams
    • Sequences UML Diagrams
    • Design Diagrams
    • UVM Components Diagrams
    • Diagram Actions
    • Diagram Toolbar
    • Diagram Magnifier
    • WaveDrom Timing Diagrams
    • Bit Field Diagrams
  • Low Power Format Support
    • Supply Network Diagram
  • Export HTML/PDF Documentation
    • Preview HTML Documentation
  • External Tools Integration
    • Run Configurations
    • Smart Log
    • External Builders
    • External Documentation
  • Debugger Integration
    • Simulation Prerequisites
    • Launch a Debug Simulation
    • Connect to an Existing Simulation
    • Breakpoints
    • Threads, Call Stack, Stepping
    • Variables
    • Watch Expressions
    • Debug Specific Configurations
  • Custom Dialogs
    • Quick Steps
    • Customizing the Dialog Output
    • SWT/XML Reference
    • Custom Dialog Snapshots
  • Command Line Interface
    • dvt_cli.sh
    • Syntax
    • Examples
    • Makefile Example
    • Commands
  • Macros Support
    • Inactive Code Highlight
    • Macro Expansion
    • Macros and Quick Macros Views
  • Reminders (TODO Markers)
  • OVM Support
    • OVM Compliance Review
    • OVM Field Editor
    • OVM Smart Log
    • Quick OVM Documentation Access
    • OVM Templates
  • UVM Support
    • Runtime UVM Configuration Queries
    • Static UVM Configuration Queries
    • UVM Browser
    • UVM Compliance Review
    • UVM Content Filters
    • UVM Field Editor
    • UVM Runtime Elaboration
    • UVM Sequence Tree
    • UVM Smart Log
    • UVM Templates
    • UVM Verification Hierarchy
    • OVM to UVM Migration
  • VMM Support
    • VMM Smart Log
    • Quick VMM Documentation Access
    • VMM Templates
  • Settings Management
    • Managed Settings
    • Unmanaged Settings
    • User and Common Settings Location
    • Use Cases
    • Examples
    • Deprecated Settings Management (before DVT 3.5)
  • Reference
    • Comments Formatting
    • Common Shortcuts
    • Custom Pragmas
    • DVT Resource Monitor
    • Editor Notification
    • Editor Right Click Menu
    • Hyperlinks
    • Icons and Decorations
    • Inactive Generates Code Highlight
    • Lazy Bring up Resources
    • Memory Monitor
    • Scripts
    • Syntax Coloring
    • Themes
    • Toolbar Actions
    • Tooltips
    • Views
  • Application Notes
    • C/C++ support
    • Design Elaboration
    • Compilation Speed-up
    • Precompilation Support
    • Encrypted VIP Support
    • FPGA Support
    • Generating External Tool Scripts from the DVT Build Configuration
    • Incremental Compilation
    • Preprocessed Files Support
    • Output and logging
    • Understanding DVT IDE memory usage
    • UVM Library Compilation Troubleshooting
    • Visual Artifacts
  • Tips and Tricks
  • Q & A
    • I am new to Eclipse, where should I start from?
    • Where can I find DVT Help?
    • How do I see and configure the key shortcuts?
    • Are there any backup files in Eclipse?
    • Workspace in use, cannot launch eclipse…
    • Locking is not possible in the directory…
    • How to start DVT Eclipse with a different eclipse.ini
    • Save could not be completed
    • IBM Clearcase Plugin
    • Non existing package mti_fli
    • How to use Working Sets for filtering Problems/Task/Search views?
    • How to handle Simulator and Command Line Macros
    • How do I Access Files Outside Project Dir - Working with Linked Resources
    • Mapping Linux to Windows (/proj/ to Z:\proj\)
    • Subversive vs Subclipse
    • How do I associate a project with both DVT and CDT?
    • Can I use vi/vim along with DVT?
    • Can I perform dos2unix or unix2dos from DVT?
    • How can I configure Eclipse to use a local CVS repository?
    • I am using the Common Desktop Environment via Citrix and experiencing crashes. What can I do?
    • How do I change the background color of the Editor?
    • Some widget colors are not displayed properly. What can I do?
    • How do I change the tooltip colors?
    • How do I change Internet Proxy Settings?
    • Eclipse does not start, there is no Workspace, metadata or log file created
    • Workspace permissions
    • How do I link mylyn with Bugzilla?
    • How do I print source code?
    • How do I disable Eclipse Software Sites?
    • How do I revert to a previous version?
    • What are the most common shortcuts in DVT?
    • How does DVT integrate with emacs?
    • How does DVT integrate with CVS?
    • How to set an environment variable within a Run Configuration?
    • How to run a remote Unix command from DVT Eclipse for Windows?
    • Rebuild shortcut (Ctrl + Alt + R) does not work
    • I want to use an alias in a DVT Generic Run Configuration, but it’s not recognized
    • How to set multiple paths as sources of predefined projects ?
    • Lines are suddenly changing indentation when I edit text or move the cursor through the editor.
    • How to change the directory where the build log file is saved ?
    • How to find the DVT logs on Linux/Unix ?
    • How to create resource filters ?
    • How to create custom shortcut and button for a Run Configuration?
    • I know that file.foo is present in the project location, but I can’t see it in the Navigator View
    • How to copy the full path to the file in the current editor?
    • How to adjust the console logs filters matching parameters?
    • When I switch to Block (Column) Selection mode the font changes
    • In Block (Column) Selection mode I see strange editing artifacts
    • How to modify the font size in the code editors?
    • How to automatically checkout/lock files from the revision control system ?
    • How can I see if a file is read-only?
    • How can I open a file in DVT from the terminal?
    • How can I open a file in DVT from Questa?
    • How do I change the name of the xterm opened by a DVT Generic Run Configuration?
    • I get errors while installing or updating a plugin from an update site
  • What is New?
  • How to Report an Issue?
  • Legal Notices
  • Third Party Licenses
DVT SystemVerilog IDE for Eclipse User Guide
/
Reference
/
Hyperlinks

Hyperlinks

Place the mouse cursor over an identifier in the editor while holding down the Ctrl key. The identifier becomes a hyperlink, and a list of navigation options is displayed.

The first option is Open Declaration. This is the default action when you click directly on the identifier.

Hyperlinks are available for all classes, modules, methods, fields, signals, macros, etc. in the source code files that DVT analyzes in your project.

Open Declaration

Tip

Keyboard alternative: place editor cursor on an identifier and press F3.

../../_images/vlogdt-open-declaration.png
../../_images/vlogdt-open-declaration-target.png

Open Extern Method Implementation

../../_images/vlogdt-open-extern-implementation.png
../../_images/vlogdt-open-extern-implementation-target.png

Open Super Implementation

Available only if the method under cursor overrides a virtual method inherited from a superclass. Opens the implementation of the overridden method:

../../_images/vlogdt-open-super-implementation.png
../../_images/vlogdt-open-super-implementation-target.png

Open Child Implementation

Available only if the method under cursor is overridden in a subclass. If there is only one override, it is opened. Otherwise the Quick Type Hierarchy View is opened.

../../_images/vlogdt-open-child-implementation.png
../../_images/vlogdt-open-child-implementation-target.png

Open Instance

Available only for a design element under cursor which is instantiable. It jumps to the corresponding instance from design (which is also available in the Design Breadcrumb Navigation Bar).

../../_images/vlogdt-open-instance.png
../../_images/vlogdt-open-instance-target.png

Open … Type

../../_images/vlogdt-open-field-type.png
../../_images/vlogdt-open-field-type-target.png

Jump to Assignment

Jumps to the next assignment of the signal under cursor in the current editor.

../../_images/vlogdt-jump-to-assignment.png
../../_images/vlogdt-jump-to-assignment-target.png

Jump to Case Branch

Available only on enum constants and parameters. Jumps directly to the case branch where element under cursor is used.

../../_images/vlogdt-jump-to-case.png
../../_images/vlogdt-jump-to-case-target.png

Jump to an Imported File

../../_images/vlogdt-hyperlink-to-imported-file.png
../../_images/vlogdt-hyperlink-to-imported-file-target.png

Jump to a Macro Definition

../../_images/vlogdt-hyperlink-to-macro.png
../../_images/vlogdt-hyperlink-to-macro-target.png

Jump to Connected TLM Port

Jumps to the next connected TLM port of the TLM port under cursor in the current editor.

../../_images/vlogdt-hyperlink-jump-to-tlm.png
../../_images/vlogdt-hyperlink-jump-to-tlm-target.png

Show Connected TLM Ports

../../_images/vlogdt-hyperlink-show-tlm.png
../../_images/vlogdt-hyperlink-show-tlm-target.png

Show in Config DB View

Shows the selected set or get call in the Config DB View.

Note

You need to perform UVM Runtime Elaboration in order to populate the Config DB View.

../../_images/vlogdt-hyperlink-show-in-config-menu.png
../../_images/vlogdt-hyperlink-show-in-config.png

Show Associated Getters in Config DB View

Shows the associated get calls in the Config DB View for the selected set call.

Note

You need to perform UVM Runtime Elaboration in order to populate the Config DB View.

../../_images/vlogdt-hyperlink-show-getter-in-config-menu.png
../../_images/vlogdt-hyperlink-show-getter-in-config.png

Show Associated Setters in Config DB View

Shows the associated set calls in the Config DB View for the selected get call.

Note

You need to perform UVM Runtime Elaboration in order to populate the Config DB View.

../../_images/vlogdt-hyperlink-show-setter-in-config-menu.png
../../_images/vlogdt-hyperlink-show-setter-in-config.png

Show in Factory Overrides View

Shows the selected UVM factory override call in the Factory Overrides View.

Note

You need to perform UVM Runtime Elaboration in order to populate the Factory Overrides View.

../../_images/vlogdt-hyperlink-show-in-factory-overrides-menu.png
../../_images/vlogdt-hyperlink-show-in-factory-overrides.png

Show in Registers View

Shows the selected UVM register in the Registers View.

Note

You need to perform UVM Runtime Elaboration in order to populate the Registers View.

../../_images/vlogdt-hyperlink-show-in-registers-menu.png
../../_images/vlogdt-hyperlink-show-in-registers.png

When the identifier under the cursor is a macro that expands to a single identifier, you can also see all the hyperlinks available for the macro replacement.

For example you can open the declaration or show the usages of a macro replacement, which is a class, as seen below:

Open Declaration of a Macro Replacement

../../_images/vlogdt-hyperlink-to-open-declaration-macro-value.png
../../_images/vlogdt-target-of-open-declaration-macro-value2.png

Hyperlinks in Comments

You can define hyperlinks in comments using the @link or @see pragmas, for example:

// @link uvm_pkg::run_test
// For more details @see spi_if.miso and @see spi_if.mosi

Hover the hierarchical id specified after the pragma with the mouse cursor while holding down the Ctrl key, and click to go to the element’s declaration. Alternatively, place the editor cursor on the hierarchical id and press F3

../../_images/vlogdt-hyperlink-in-comment.png

The hierarchical identifier following @link or @see is of the form:

[<package_name>::<type_name>.<inner_type_name>.]<element_name>

where <element_name> must be a type (class, struct, module, entity, interface, etc.) or a type member (method, field, event, signal, port etc.).

Examples

  • @link <element_name>

../../_images/vlogdt-hyperlink-in-comment-identifier.png
  • @link <type_name>.<element_name>

../../_images/vlogdt-hyperlink-in-comment-type-identifier.png
  • @link <type_name>.<inner_type_name>.<element_name>

../../_images/vlogdt-hyperlink-in-comment-type-innertype-identifier.png
  • @link <package_name>::<type_name>.<element_name> :

../../_images/vlogdt-hyperlink-in-comment-absolute-path.png

Note

If <path.to.element> does not solve to a unique element in code, a list of navigation options is displayed.

../../_images/vlogdt-hyperlink-in-comment-ambiguity.png
Editor Right Click Menu
Icons and Decorations

On this page

  • Hyperlinks in Comments

© 2005-2025 AMIQ EDA s.r.l. (AMIQ). All rights reserved. DVT 25.1.9 (13 May 2025). Built with Sphinx 8.1.3