InstantView®

InstantView® is the domain-specific language for the business OS CyberEnterprise® developed by ClassiX Software GmbH.

This plugin supports developing apps and modules with the InstantView® language. It has the following features:

• Debugging of InstantView® language applications
• Syntax highlighting for InstantView® language
• Information about errors and warnings from parser
• Help for symbols on hover
• Syntax completion
• Document symbols for outline and breadcrumb
• Folding regions
• Code lenses with information about inheritance
• Finding of references for current cursor position
• Highlighting of occurrences of the symbol under the cursor
• Renaming of a symbol including its references

Configuration

The parser needs information about the structure of a project. This information is defined in IPC files. IPC files can be defined per folder such that a workspace can contain mutliple InstantView® projects.

The IPC file is defined in the settings. If you only have one project, you can define it as a workspace settings, otherwise define it as a settting per folder.

You can select the IPC file to use for the current workspace/folder by opening any file of that workspace/folder, opening the command window (CTRL+SHIFT+P) and enterning "ipc" to select the command InstantView: Select IPC file. A selection window will display the currently used IPC file and all available IPC files for the current workspace. Selecting an IPC file will update the settings and reload the VSCode window.

IPC files are simple text files. Each line in the text file defines a different property of the project. Paths have to be enclosed by quotation marks and are relative to the IPC file. Different paths for one setting are split by semicolons. The lines have the following meaning:

1. Project file (cxp)
2. INI file
3. Root directory
4. System folders
5. AppsWH folders
6. Image folders
7. NUM files
8. External file (ext)

When you change the settings of the IPC file (or other parsing-related settings), you have to restart Visual Studio Code or simply reselect the current IPC file using the InstantView: Select IPC file command.

Debugging

For information on how to debug an application, please read here.

Tipps

The following tipps are especially for people that have not used Visual Studio Code so far. The given keyboard shortcuts in the tipps are the default ones assuming they have not been changed.

Navigating in Project

You can navigate to files in your project by pressing CTRL+P and then entering a part of the file name.

Navigating by Symbols

It is possible to navigate inside a file by symbols. You can use the outline or breadcrumb for this or even easier press CTRL+SHIFT+O and type a part of the symbol name.

Go to or Peek Definition

By pressing F12 while placing the cursor over a symbol, you can go to its definition. Press ALT + F12 will peek the definition of the symbol.

Go to or Peek References

When the cursor is on a symbol, you can press SHIFT+F12 to go to its references or SHIFT+ALT+F12 to show all references in the sidebar. You can also peek all references by choosing the command from the context menu.

When searching for references of globally accessible symbols (GlobalVar, procedures/variables/windows defined in providers) the parser will automatically start parsing all modules (unless already done) to find all references. This global parse can be aborted by clicking on the parse progress and then on Cancel, the reference search will only consider modules parsed so far.

Rename Symbol

When the cursor is on a symbol, you can press F2 to rename the symbol under the cursor.

By pressing SHIFT+ENTER when renaming the symbol the editor will list a preview of all changes to all affected files and one can then choose to Apply or Discard the changes.

When renaming globally accessible symbols (GlobalVar, procedures/variables/windows defined in providers) the parser will automatically start parsing all modules (unless already done) to find all occurrences. This global parse can be aborted by clicking on the parse progress and then on Cancel, the renaming operation will then only be applied to the modules parsed so far.

Code Completion

Visual Studio Code will automatically suggest possible continuations for the text under the cursor. You can also ask for suggestions by pressing CTRL+SPACE. The suggestions are context-aware and include results from parsing.

Code Lenses

Visual Studio Code will show code lenses above symbol definitions containing information about inheritance of the symbol. You can navigate to these symbols by clicking on the code lens. If there are more possibilietes, just the number is shown in the code lens and by clicking on the code lens all possibilities are shown and by clicking on one of these, Visual Studio Code will navigate to related position.