Customizing the Vitis HLS IDE Behavior - 2022.1 English

Vitis High-Level Synthesis User Guide (UG1399)

Document ID
Release Date
2022.1 English

The behavior of the Vitis HLS IDE can be customized using settings available from the Windows > Preferences menu, and user-defined preferences saved.

Reviewing the different sub-menus in the Preferences dialog box allows most elements of the Vitis HLS environment to be customized.

Customizing the Console View

The Console view displays the messages issued during tool operations such as synthesize and verification. The default buffer size for this windows is 80,000 characters and can be changed, or the limit can be removed, to ensure all messages can be reviewed.

Change the Console settings using Window > Preferences > Run/Debug > Console. You can change the Console buffer size in characters, or disable the Limit console output checkbox to remove the limit. There are additional settings that can be modified as well.

Customizing Keyboard Shortcuts

The Vitis HLS tool comes with default keyboard shortcuts for the various editors and windows. These can be viewed and modified from the Window > Preferences > General > Keys menu.

Figure 1. Keyboard Shortcuts

For instance, as shown in the figure above, to change the size of the font in the text editor window you can use the keyboard shortcut Ctrl + = to zoom in and make the text larger, or use Ctrl + - to zoom out, and make the text smaller.

You can use the Binding field as shown above to change the keyboard shortcut for specific commands or activities. If you define a keyboard shortcut that conflicts with another command it will be reported in the Conflicts window. You can save any custom keyboard shortcuts by using the Apply button. You can restore the tool defaults by using the Restore Defaults button.

The window has a search bar that displays the phrase type filter text when not in use, as shown above. You can type a phrase or keyword to locate a specific keyboard shortcut.

Unbind Command will remove the keyboard shortcut for a specific command. Restore Command will restore the original binding.

For example, the key combination Ctrl + Tab toggles between the source code and the header file in the text editor. You can change this keyboard shortcut to make each tab active using the following steps:
  1. In Window > Preferences > General > Keys search for and select Toggle Source/Headerand remove the binding by using the Unbind Command button.
  2. Search for and select Next Tab, place the cursor in the Binding field and press backspace to clear the current binding, and then press the Ctrl and Tab keys together to define the new keyboard binding for the command.
  3. Click Apply, or Apply and Close.

You can change the key-binding scheme from the tool default to make it more like a familiar tool. The two supported schemes are Microsoft Visual Studio and Emacs. Changing the scheme will change the keyboard shortcuts accordingly.