DVT e Language IDE User Guide
Rev. 23.1.12, 23 May 2023

DVT e Language IDE User Guide

Table of Contents

1. Installation Checklist
1.1. Install DVT Using a pre-packed Distribution
1.2. Install DVT Using the Update Site
1.3. Set the License
2. Predefined Projects
3. Getting Started
3.1. What is a Workspace
3.2. What is a Project
3.3. Project Natures
3.4. Workspace and Workbench
3.5. Refresh
3.6. Linked Resources
3.7. Backup and Local History
3.8. Basic Tutorial
3.8.1. Switch to the DVT Perspective
3.8.2. Open a Project
3.8.3. Configure the Build
3.8.4. Build the Project
3.8.5. Inspect the Compilation Errors
3.8.6. See Comments in Tooltips
3.8.7. Use Hyperlinks to Move Around in the Code
3.8.8. Quickly Open a Type (Struct, Unit)
3.8.9. Quickly Open a File
3.8.10. Quickly Move Inside the Editor
3.8.11. Browse Through All the Available Types (Structs, Units, Enumerations)
3.8.12. Browse the AOP Extensions
3.8.13. Inspect the Struct Hierarchy and Struct Members
3.8.14. Inspect the Verification Hierarchy
3.8.15. Search for Entities
3.8.16. Use Content Assist (Autocomplete)
3.8.17. Use Code Templates
3.8.18. Track Tasks using TODO Markers
3.8.19. Format the Source Code
3.8.20. Quickly See the Current Scope in the Status Bar
3.8.21. Locate the Matching Bracket
3.8.22. Fold Code Regions in Order to Improve Readability
3.8.23. Load in Specman
4. Build Configurations
4.1. Non-top files
4.2. default.build
4.3. Auto-config
4.4. Simulator Log-config
4.5. Emulating compiler invocations
4.6. Multiple .build Files
4.7. Compatibility Modes
4.7.1. Default DVT Compatibility Mode
4.7.2. gcc Compatibility Mode
4.7.3. ius.irun Compatibility Mode
4.7.4. ius.perspec Compatibility Mode
4.7.5. questa.vcom Compatibility Mode
4.7.6. questa.vlog Compatibility Mode
4.7.7. vcs.vhdlan Compatibility Mode
4.7.8. vcs.vlogan Compatibility Mode
4.7.9. xcelium.xrun Compatibility Mode
4.8. Paths
4.9. Strings
4.10. Comments
4.11. Environment Variables
4.12. Including Other Argument Files
4.13. Build Persistence
4.14. DVT Auto-Linked
4.15. Run a Script Before Build
4.16. All Build Directives
4.17. e Language Test Files
4.18. e Language SPECMAN_PATH
4.19. SystemVerilog OVM or UVM Library Compilation
4.20. Xilinx Libraries Compilation
4.21. Intel(Altera) Quartus Libraries Compilation
4.22. Questa Libraries Compilation
4.23. Use of External Programs
5. Breadcrumb Navigation Bar
5.1. Verification Breadcrumb
5.2. Scope Breadcrumb
5.3. Filesystem Breadcrumb
6. Compile Checks
6.1. Compile Waivers
6.2. Semantic Checks
6.3. Naming Conventions Checking
7. Content Assist (Autocomplete)
7.1. Content assist for CamelCase and Underscore
7.2. Code Templates
8. Quick Fix Proposals
8.1. Correct Spelling In Comments and Strings
8.2. Create File From Build Config Editor
8.3. Create Imported File
8.4. Declare Enum Constant
8.5. Declare Event
8.6. Declare Variable
8.7. Did You Mean
8.8. Waive Compilation Problems
9. Content Filters
9.1. Content Filters XML syntax
9.2. Filtering by element type
9.3. Content Filters Examples
9.4. Predefined Content Filters
10. Code Templates
10.1. Code Templates in Autocomplete
10.2. Global Code Templates
10.3. Project Level Code Templates
10.4. Code Templates View
11. File Templates
12. Project Templates
12.1. What is a project template?
12.2. How to generate code from a project template
12.2.1. Step 1. Specify Directories
12.2.2. Step 2. Specify Parameters
12.3. Template Configuration
12.3.1. template-config.xml
12.3.2. template.config
12.4. Add from Template
13. Code Formatting
13.1. Whitespace
13.2. Indentation
13.3. Vertical Alignment
13.4. Line Wrapping
13.5. Disable Format for Code Sections
13.6. Format Multiple Files
13.7. External
14. Inspect Extensions (Layers)
15. Override Methods
15.1. Override Annotation
15.2. Override using the Dialog
15.3. Override Using the Type Hierarchy View
16. Extend Annotation
17. Semantic Search
18. Search for References (Usages)
19. Show Instances
20. Show Constraints
21. Quick Search in Views
21.1. CamelCase
21.2. Simple Regex
21.3. Hierarchical Search
21.4. Search for Members
21.5. Search Port in Verification Hierarchy
21.6. Search all Method Extensions
22. Refactoring
22.1. Rename Refactoring
23. Diagrams
23.1. UML Diagrams
23.1.1. UML Diagrams - Select Types
23.1.2. UML Diagrams - Preferences
23.1.3. UML Diagrams - Legend
23.2. Architecture UML Diagrams
23.3. Sequences UML Diagrams
23.4. UVM Components Diagrams
23.4.1. Diagram Filters
23.5. Diagram Actions
23.6. Diagram Toolbar
23.7. Diagram Magnifier
23.8. WaveDrom Timing Diagrams
24. Export HTML Documentation
25. External Tools Integration
25.1. Run Configurations
25.1.1. Run Configuration Session Type
25.1.2. Custom Shortcut and Button for a Run Configuration
25.1.3. Using environment variables in DVT Generic Run Configurations
25.1.4. Using an alias in a DVT Generic Run Configuration
25.1.5. DVT Generic Run Configuration Variables
25.2. Smart Log
25.2.1. Smart Log - Filters
25.2.2. Smart Log - Hyperlinks
25.2.3. Smart Log - Styles
25.3. External Builders
25.3.1. How to define a new external builder?
25.3.2. How to configure a filter?
25.3.3. How to invoke external builders?
25.3.4. External Builder Output
25.3.5. Source Code Markers - errors warnings
25.4. External Documentation
25.4.1. Configure External Documentation
25.4.2. Browse External Documentation
25.4.3. Search External Documentation
26. Debugger Integration
26.1. Simulation Prerequisites
26.2. Launch a Debug Simulation
26.3. Connect to an Existing Simulation
26.4. Breakpoints
26.5. Threads, Call Stack, Stepping
26.6. Variables
26.7. Watch Expressions
26.8. Debug Specific Configurations
27. Custom Dialogs
27.1. Quick Steps
27.2. Customizing the Dialog Output
27.3. SWT/XML Reference
27.3.1. Layouts
27.3.2. Widgets
27.4. Custom Dialog Snapshots
27.4.1. Custom Dialog Snapshots File Syntax (XML)
28. Command Line Interface
28.1. dvt_cli.sh
28.2. Syntax
28.3. Examples
28.4. Makefile Example
28.5. Commands
28.5.1. Create a Project (Mixed-Language Capable)
28.5.2. Create a Project From an Existing Template
28.5.3. Import an Existing Project
28.5.4. List Compiled Files
28.5.5. Compare Files
28.5.6. Launch a Run Configuration
28.5.7. Open a File
28.5.8. Close a File
28.5.9. Open a Custom Dialog
28.5.10. Open a Perspective
28.5.11. Refresh a Project
28.5.12. Rebuild a Project
28.5.13. Print Edited File
28.5.14. Quit
28.5.15. Query the running status
28.5.16. Print version
29. Macros Support
29.1. Inactive Code Highlight
29.1.1. Overview
29.1.2. Settings
29.2. Macro Expansion
29.2.1. Overview
29.2.2. Triggering
29.2.3. Tips
29.2.4. IMPORTANT NOTE
29.3. Macros and Quick Macros Views
29.4. Trace Macro Errors
30. Reminders (TODO Markers)
31. UVM Support
31.1. UVM Browser
31.2. OVM UVM Compliance Review
31.2.1. OVM UVM Compliance Review - Architecture Tab
31.2.2. OVM UVM Compliance Review - Checks Tab
31.2.3. OVM UVM Compliance Review - Statistics Tab
31.2.4. OVM UVM Compliance Review - HTML Report
31.3. UVM Content Filters
31.4. UVM Sequence Tree
31.5. UVM Verification Hierarchy
32. Settings Management
32.1. Managed Settings
32.2. Unmanaged Settings
32.3. User and Common Settings Location
32.4. Use Cases
32.4.1. Memory Allocation Thresholds
32.4.2. Workspace Preferences
32.4.3. Run Configurations
32.4.4. Compile Waivers
32.4.5. Content Filters
32.4.6. External Builders
32.4.7. Export HTML Documentation
32.4.8. Custom Pragmas
32.5. Examples
32.6. Deprecated Settings Management (before DVT 3.5)
32.6.1. Workspace Settings
32.6.2. Project Settings
32.6.3. Other Settings
32.6.4. Importing Preferences From a Different Workspace
32.6.5. Customizing Default Settings Using dvt.ini
33. Reference
33.1. Comments Formatting
33.1.1. Javadoc
33.1.2. Natural Docs
33.2. Common Shortcuts
33.3. Custom Pragmas
33.4. DVT Resource Monitor
33.5. Editor Right Click Menu
33.5.1. Folding
33.5.2. Macros
33.5.3. Source
33.5.4. Show
33.5.5. References
33.5.6. Refactor
33.6. Hyperlinks
33.6.1. Hyperlinks in Comments
33.7. Icons and Decorations
33.7.1. Icons
33.7.2. Decorations
33.7.3. Changing Icon Colors
33.7.4. Project Colors
33.8. Lazy Bring up Resources
33.9. Memory Monitor
33.10. Scripts
33.10.1. dvt.sh
33.10.2. dvt_cli.sh
33.10.3. dvt_kit_installer.sh
33.10.4. dvt_plugin_installer.sh
33.10.5. dvt_build.sh
33.10.6. evip2dvt.sh
33.11. Syntax Coloring
33.12. Themes
33.13. Tooltips
33.14. Toolbar Actions
33.15. Views
33.15.1. Checks View
33.15.2. Code Templates View
33.15.3. Compile Order View
33.15.4. Console View
33.15.5. Coverage View
33.15.6. Call Hierarchy View
33.15.7. Inspect View
33.15.8. Layers View
33.15.9. Macros View
33.15.10. Outline View
33.15.11. Problems View
33.15.12. Tasks View
33.15.13. Types View
33.15.14. Type Hierarchy View
33.15.15. UVM Browser View
33.15.16. UVM Sequence Tree View
33.15.17. Verification Hierarchy View
34. Application Notes
34.1. C/C++ support
34.2. Encrypted VIP Support
34.3. Output and logging
35. Tips and Tricks
36. Q & A
36.1. I am new to Eclipse, where should I start from?
36.2. Where can I find DVT Help?
36.3. How do I see and configure the key shortcuts?
36.4. Are there any backup files in Eclipse?
36.5. Workspace in use, cannot launch eclipse...
36.6. Locking is not possible in the directory...
36.7. How to start DVT Eclipse with a different eclipse.ini
36.8. Save could not be completed
36.9. IBM Clearcase Plugin
36.10. DVT is crashing with "Problematic frame ld-linux-x86-64.so.2 _dl_rtld_di_serinfo
36.11. libxul.so undefined symbol
36.12. How do I Access Files Outside Project Dir - Working with Linked Resources
36.13. Handling UNRECOGNIZED Macros
36.14. Mapping Linux to Windows (/proj/ to Z:\proj\)
36.15. How to use Working Sets for filtering Problems/Task/Search views?
36.16. Whitespace in macro definition
36.17. Subversive vs Subclipse
36.18. How do I associate a project with both DVT and CDT?
36.19. Can I use vi/vim along with DVT?
36.20. Can I perform dos2unix or unix2dos from DVT?
36.21. How can I configure Eclipse to use a local CVS repository?
36.22. I am using the Common Desktop Environment via Citrix and experiencing crashes. What can I do?
36.23. How do I change the background color of the Editor?
36.24. Some widget colors are not displayed properly. What can I do?
36.25. How do I change the tooltip colors?
36.26. How do I change Internet Proxy Settings?
36.27. Eclipse does not start, there is no Workspace, metadata or log file created
36.28. Workspace permissions
36.29. How do I link mylyn with Bugzilla?
36.30. How do I print source code?
36.31. How do I disable Eclipse Software Sites?
36.32. How do I revert to a previous version?
36.33. What are the most common shortcuts in DVT?
36.34. How do I run Specman using IntelliGen?
36.35. How does DVT integrate with emacs?
36.36. How does DVT integrate with CVS?
36.37. How to set an environment variable within a Run Configuration?
36.38. How to run a remote Unix command from DVT Eclipse for Windows?
36.39. How do I tell DVT to skip some files from compilation?
36.40. Rebuild shortcut (Ctrl + Alt + R) does not work
36.41. I want to use an alias in a DVT Generic Run Configuration, but it's not recognized
36.42. Some files are missing from the VIPs transformed with evip2dvt.sh
36.43. How to set multiple paths as sources of predefined projects ?
36.44. Lines are suddenly changing indentation when I edit text or move the cursor through the editor.
36.45. How to change the directory where the build log file is saved ?
36.46. How to find the DVT logs on Linux/Unix ?
36.47. How to create resource filters ?
36.48. How to create custom shortcut and button for a Run Configuration?
36.49. I know that file.foo is present in the project location, but I can't see it in the Navigator View
36.50. How to copy the full path to the file in the current editor?
36.51. How to adjust the console logs filters matching parameters?
36.52. When I switch to Block (Column) Selection mode the font changes
36.53. In Block (Column) Selection mode I see strange editng artifacts
36.54. How to modify the font size in the code editors?
36.55. How to automatically checkout/lock files from the revision control system ?
36.56. How can I see if a file is read-only?
36.57. How can I open a file in DVT from the terminal?
36.58. How can I open a file in DVT from Questa?
36.59. How do I change the name of the xterm opened by a DVT Generic Run Configuration?
36.60. I get errors while installing or updating a plugin from an update site
37. What is New?
38. How to Report an Issue?
39. Legal Notices
40. Third Party Licenses