VSI OpenVMS Wiki - User contributions [en]

VMS IDE for Java (Kotlin, Scala)

2019-09-11T08:02:12Z

Sergey.vorfolomeev:

== Working on a Java, Kotlin or Scala project ==

=== Prerequirements ===

* Java (Scala, Kotlin) must be installed on VMS host
* Add '''set process/parse_style=extended''' to your LOGIN.COM

=== Creating and building a project ===
The general development process includes the following steps:
# Change project settings:
#* '''project type''' - specify ''java'', ''scala'' or ''kotlin''
#* '''project name'''
#* '''root folder'''
#* '''source''', '''headers''', '''resource''', and '''listing''' masks
# Write code
# Create MMS
# Upload source files
# Build the project
# Collect Java classes. This step is required for debugging.
# Run the project

=== Restrictions ===
Because the project target is compiled by one command for all source files, do not mix Kotlin, Scala, and Java source files in one project.

=== Abilities ===
A Java, Scala or Kotlin project may depend on other Java, Scala or Kotlin projects.

== Debugging ==

=== Before starting debug ===
To be able to use breakpoints during debugging, run '''Collect Java classes''' after editing and building the project.

=== Running VMS JVM Debugger ===
<ol>
<li> To start Debugger, press <code>F5</code>. If no debug configuration is selected, the ''Select environment'' dropdown will be shown. [[File:Jvm-dbg-select.png|dbg-select]]</li>
<li> Choose '''VMS JVM Debugger'''. If all java classes are collected successfully, the ''entry class'' QuickPick popup will be shown. [[File:Jvm-dbg-select-main.png|select-main]]</li>
<li> Select one and debugging will start. </li>
</ol>

=== Creating Debug Configurations ===
You can configure 'launch.json' to start predefined debug configuration. To do this,
<ol>
<li> Click 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] </li>
<li> The next step depends on whether the '''launch.json''' file exists or not:
<ul>
<li> If there is no '''launch.json''' file, the '''Select environment''' dropdown is displayed. Choose '''VMS JVM Debugger'''.</li>
<li> If the '''launch.json''' file exist, click '''Add Configuration''' button in the bottom-right corner of the VS Code and select '''VMS IDE: Launch JVM'''.</li>
</ul>
<li> Edit the ''launch.json'' file
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Specify the '''name'''
* Set the class path - ''A colon-separated list of directories, JAR archives, and ZIP archives where to search for class files in''. In case of "${command:FillClassPath}" class path will be taken from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' QuickPick will be displayed when debugging is started.
* '''port''' is range of ports for JDB.
* '''arguments''' is a string with arguments passed to the program.
* '''stopOnEntry''' indicates whether do stop or not on the program entry.
</li>
</ol>

=== Breakpoints ===
Breakpoints are shown grayed until the corresponding class is loaded into memory. Also, they are grayed if no Java class information collected.

==== Function breakpoints ====
To add a function breakpoint:
# Click '+' in the Breakpoints view.
# Enter the function name using ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)'' format. You can omit any part of the function name. QuickPick popup with available functions will appear. Then select the required one.
# If no dialog appears, click '''Activate Breakpoints'''.

==== Data breakpoints ====
There is no specific UI for data breakpoints.

To create a data breakpoint, type '''watch all <class>.<field>''' in the debugging console input while the program is paused.
To remove data breakpoints, type '''unwatch all <class>.<field>'''.

'''Note:''' This feature does not catch the changing of particular variables. It catches all changes to the <field> of all instances of <class>. Also, it does not work for local variables.

=== Displaying/Setting variables ===
A string variable is displayed ''as is'', without escaping. 
Char variable is escaped if its value is less than 0x20 or greater than 0x7f. 
To set the value of a string or char variable, you can write an escaped string (using Java rules). Enclosing quotes are not required.

=== Debugging console ===
When a program is running, anything that you type to the debugging console is sent to the program.
When a program is paused, anything that you type to the debugging console is sent to the debugger.

Note this to avoid issues with breaking the debugger. For example, 'eval a=100' will change the value of variable ''a'' and this will not be caught by the extension.

[[Category: VMS IDE]]

VMS IDE for Java (Kotlin, Scala)

2019-09-05T07:56:36Z

Sergey.vorfolomeev:

== Working on a Java, Kotlin or Scala project ==

=== Creating and building a project ===
The general development process includes the following steps:
# Change project settings:
#* '''project type''' - specify ''java'', ''scala'' or ''kotlin''
#* '''project name'''
#* '''root folder'''
#* '''source''', '''headers''', '''resource''', and '''listing''' masks
# Write code
# Create MMS
# Upload source files
# Build the project
# Collect Java classes. This step is required for debugging.
# Run the project

=== Restrictions ===
Because the project target is compiled by one command for all source files, do not mix Kotlin, Scala, and Java source files in one project.

=== Abilities ===
A Java, Scala or Kotlin project may depend on other Java, Scala or Kotlin projects.

== Debugging ==

=== Before starting debug ===
To be able to use breakpoints during debugging, run '''Collect Java classes''' after editing and building the project.

=== Running VMS JVM Debugger ===
<ol>
<li> To start Debugger, press <code>F5</code>. If no debug configuration is selected, the ''Select environment'' dropdown will be shown. [[File:Jvm-dbg-select.png|dbg-select]]</li>
<li> Choose '''VMS JVM Debugger'''. If all java classes are collected successfully, the ''entry class'' QuickPick popup will be shown. [[File:Jvm-dbg-select-main.png|select-main]]</li>
<li> Select one and debugging will start. </li>
</ol>

=== Creating Debug Configurations ===
You can configure 'launch.json' to start predefined debug configuration. To do this,
<ol>
<li> Click 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] </li>
<li> The next step depends on whether the '''launch.json''' file exists or not:
<ul>
<li> If there is no '''launch.json''' file, the '''Select environment''' dropdown is displayed. Choose '''VMS JVM Debugger'''.</li>
<li> If the '''launch.json''' file exist, click '''Add Configuration''' button in the bottom-right corner of the VS Code and select '''VMS IDE: Launch JVM'''.</li>
</ul>
<li> Edit the ''launch.json'' file
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Specify the '''name'''
* Set the class path - ''A colon-separated list of directories, JAR archives, and ZIP archives where to search for class files in''. In case of "${command:FillClassPath}" class path will be taken from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' QuickPick will be displayed when debugging is started.
* '''port''' is range of ports for JDB.
* '''arguments''' is a string with arguments passed to the program.
* '''stopOnEntry''' indicates whether do stop or not on the program entry.
</li>
</ol>

=== Breakpoints ===
Breakpoints are shown grayed until the corresponding class is loaded into memory. Also, they are grayed if no Java class information collected.

==== Function breakpoints ====
To add a function breakpoint:
# Click '+' in the Breakpoints view.
# Enter the function name using ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)'' format. You can omit any part of the function name. QuickPick popup with available functions will appear. Then select the required one.
# If no dialog appears, click '''Activate Breakpoints'''.

==== Data breakpoints ====
There is no specific UI for data breakpoints.

To create a data breakpoint, type '''watch all <class>.<field>''' in the debugging console input while the program is paused.
To remove data breakpoints, type '''unwatch all <class>.<field>'''.

'''Note:''' This feature does not catch the changing of particular variables. It catches all changes to the <field> of all instances of <class>. Also, it does not work for local variables.

=== Displaying/Setting variables ===
A string variable is displayed ''as is'', without escaping. 
Char variable is escaped if its value is less than 0x20 or greater than 0x7f. 
To set the value of a string or char variable, you can write an escaped string (using Java rules). Enclosing quotes are not required.

=== Debugging console ===
When a program is running, anything that you type to the debugging console is sent to the program.
When a program is paused, anything that you type to the debugging console is sent to the debugger.

Note this to avoid issues with breaking the debugger. For example, 'eval a=100' will change the value of variable ''a'' and this will not be caught by the extension.

[[Category: VMS IDE]]

VMS IDE Change Log

2019-09-05T07:26:38Z

Sergey.vorfolomeev:

=== 1.2.6 ===
* Fixed issue when extension is crashed while opening C project.
* Fixed duplicating algorithms in SSH settings.

=== 1.2.3 - 1.2.5 ===
* Function breakpoints.
* Data breakpoints without UI.

=== 1.2.2 ===
* Fix for display/set unicode string in '''Java''' debugger.
* Ability to collect fields of Java classes.

=== 1.2.1 ===
* Fix issues with templates in '''Java'''.

=== 1.2.0 ===
* Support for '''Java''', '''Kotlin''' and '''Scala''' languages.
* One output channel for all extension messages.

=== 1.1.0 ===
* '''Pascal''' syntax highlighting.
* OpenVMS specific '''COBOL''' grammar support.

=== 1.0.2 ===
* Allow users to skip signature verification in SSH (cause: Visual Studio Code 1.36.1 issue).

=== 1.0.1 ===
* Fix: parsing compiler errors that occurred on the same line of source code.
* OpenVMS specific '''Pascal''' grammar basic support.
* Debugger: skip querying symbols with invalid names.

[[Category:VMS IDE]]

VMS IDE Commands

2019-09-03T03:56:41Z

Sergey.vorfolomeev:

To invoke the commands, press <code>F1</code> in the Visual Studio Code editor and start typing the command.
[[File:Vms-ide-commands.png|800px|thumb|none|VMS IDE Commands]]

=Commands=
* <code>'''VMS-IDE: Edit VMS project settings'''</code> - Edit project settings. [[Project Settings]]
* <code>'''VMS-IDE: Build on VMS'''</code> - Build project on VMS with its dependencies.
* <code>'''VMS-IDE: Build only this project'''</code> - Build only the selected project on VMS (Ctrl+Alt+F7).
* <code>'''VMS-IDE: Change CR/LF for all source files'''</code> - Change CRLF to LF for all source files.
* <code>'''VMS-IDE: Clean project'''</code> - Clean project, delete files from output folder.
* <code>'''VMS-IDE: Create MMS'''</code> - Create default MMS. [[Auto-generating MMS]]
* <code>'''VMS-IDE: Collect JAVA classes'''</code> - Collect debug information for JVM project. [[VMS IDE for Java (Kotlin, Scala)]]
* <code>'''VMS-IDE: Download system headers'''</code> - Download system headers from VMS.
* <code>'''VMS-IDE: Edit ssh-helper settings'''</code> - Edit connection settings. [[SSH Settings]]
* <code>'''VMS-IDE: Force built status'''</code> - Force built status.
* <code>'''VMS-IDE: Force synchronized status'''</code> - Force synchronized status.
* <code>'''VMS-IDE: Quick uploading'''</code> - Upload the changes made to the source code on the the local machine since the last upload/synchronization to the remote machine.
* <code>'''VMS-IDE: Re-build on VMS'''</code> - Re-build project on VMS with its dependencies.
* <code>'''VMS-IDE: Re-build only this project'''</code> - Re-build only the selected project on VMS.
* <code>'''VMS-IDE: Synchronize project file with VMS'''</code> - Synchronize project files with VMS.
* <code>'''VMS-IDE: Terminal'''</code> - OpenVMS terminal (<code>Ctrl+F6</code>)
* <code>'''VMS-IDE: Upload all'''</code> - Upload all new and updated files from local machine to VMS. '''NOTE''': If '''preferZip''' is set to true, the ''whole'' project will be uploaded as a ZIP file.
* <code>'''VMS-IDE: Upload all via Zip'''</code> - Upload project files using Zip

[[Category:VMS IDE]]

VMS IDE for Java (Kotlin, Scala)

2019-09-03T03:42:01Z

Sergey.vorfolomeev: /* Creating Debug Configurations */

'''Note: support for JVM based languages (Java, Kotlin, Scala) will be available soon'''

== Working on a Java, Kotlin or Scala project ==

=== Creating and building a project ===
The general development process includes the following steps:
# Change project settings:
#* '''project type''' - specify ''java'', ''scala'' or ''kotlin''
#* '''project name'''
#* '''root folder'''
#* '''source''', '''headers''', '''resource''', and '''listing''' masks
# Write code
# Create MMS
# Upload source files
# Build the project
# Collect Java classes. This step is required for debugging.
# Run the project

=== Restrictions ===
Because the project target is compiled by one command for all source files, do not mix Kotlin, Scala, and Java source files in one project.

=== Abilities ===
A Java, Scala or Kotlin project may depend on other Java, Scala or Kotlin projects.

== Debugging ==

=== Before starting debug ===
To be able to use breakpoints during debugging, run '''Collect Java classes''' after editing and building the project.

=== Running VMS JVM Debugger ===
<ol>
<li> To start Debugger, press <code>F5</code>. If no debug configuration is selected, the ''Select environment'' dropdown will be shown. [[File:Jvm-dbg-select.png|dbg-select]]</li>
<li> Choose '''VMS JVM Debugger'''. If all java classes are collected successfully, the ''entry class'' QuickPick popup will be shown. [[File:Jvm-dbg-select-main.png|select-main]]</li>
<li> Select one and debugging will start. </li>
</ol>

=== Creating Debug Configurations ===
You can configure 'launch.json' to start predefined debug configuration. To do this,
<ol>
<li> Click 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] </li>
<li> The next step depends on whether the '''launch.json''' file exists or not:
<ul>
<li> If there is no '''launch.json''' file, the '''Select environment''' dropdown is displayed. Choose '''VMS JVM Debugger'''.</li>
<li> If the '''launch.json''' file exist, click '''Add Configuration''' button in the bottom-right corner of the VS Code and select '''VMS IDE: Launch JVM'''.</li>
</ul>
<li> Edit the ''launch.json'' file
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Specify the '''name'''
* Set the class path - ''A colon-separated list of directories, JAR archives, and ZIP archives where to search for class files in''. In case of "${command:FillClassPath}" class path will be taken from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' QuickPick will be displayed when debugging is started.
* '''port''' is range of ports for JDB.
* '''arguments''' is a string with arguments passed to the program.
* '''stopOnEntry''' indicates whether do stop or not on the program entry.
</li>
</ol>

=== Breakpoints ===
Breakpoints are shown grayed until the corresponding class is loaded into memory. Also, they are grayed if no Java class information collected.

==== Function breakpoints ====
To add a function breakpoint:
# Click '+' in the Breakpoints view.
# Enter the function name using ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)'' format. You can omit any part of the function name. QuickPick popup with available functions will appear. Then select the required one.
# If no dialog appears, click '''Activate Breakpoints'''.

==== Data breakpoints ====
There is no specific UI for data breakpoints.

To create a data breakpoint, type '''watch all <class>.<field>''' in the debugging console input while the program is paused.
To remove data breakpoints, type '''unwatch all <class>.<field>'''.

'''Note:''' This feature does not catch the changing of particular variables. It catches all changes to the <field> of all instances of <class>. Also, it does not work for local variables.

=== Displaying/Setting variables ===
A string variable is displayed ''as is'', without escaping. 
Char variable is escaped if its value is less than 0x20 or greater than 0x7f. 
To set the value of a string or char variable, you can write an escaped string (using Java rules). Enclosing quotes are not required.

=== Debugging console ===
When a program is running, anything that you type to the debugging console is sent to the program.
When a program is paused, anything that you type to the debugging console is sent to the debugger.

Note this to avoid issues with breaking the debugger. For example, 'eval a=100' will change the value of variable ''a'' and this will not be caught by the extension.

[[Category: VMS IDE]]

SSH Settings

2019-09-02T07:33:25Z

Sergey.vorfolomeev: /* Connection */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running, and debugging projects. 
Depending on the type of configuration, SSH connection settings can be edited either in the '''vmssoftware.ssh-helper-settings.json''' file located in ''/.vscode'' directory or via '''Visual Studio Code''' settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
"algorithms": {
"kex": [],
"cipher": [],
"serverHostKey": [],
"hmac": [],
"compress": []
}
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The '''connection''' section sets the current connection details.
* <code>'''host'''</code> - IP-address or name of an OpenVMS machine or the label of a predefined connection from the '''host collection''' section
case, all other fields are ignored.
* <code>'''port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''username'''</code> - User account that will be used for the SSH connection.
* <code>'''password'''</code> - User password that will be used for the SSH connection. If it is omitted a password input box will be shown on connection attempt.
* <code>'''keyFile'''</code> - Path to SSH private key file. For details on how to configure connection using SSH key, see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.
* <code>'''algorithms'''</code> - Optional. This allows you to explicitly override the default transport layer algorithms used for the connection. See https://www.npmjs.com/package/ssh2#client-methods and https://www.npmjs.com/package/ssh2-streams#ssh2stream-methods

Required fields are:
* <code>'''host'''</code>
* <code>'''username'''</code>

You may use either password or key file to establish connection:
* <code>'''keyFile'''</code>
* <code>'''password'''</code>

If '''keyFile''' is not set, '''password''' is used. If neither '''password''' nor '''keyFile''' is specified, you will be prompted to enter your password during the connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to create a list of required connections to be able to quickly connect to any of them.
You can do this by adding all the required connections to the '''Host Collection''' list.

=== Adding a new host to collection ===
To add a new host to the collection:
<ol>
<li>Copy the ssh connection template to '''host-collection.hosts''' array:</li>
<pre>"host-collection": {
"hosts": [
{
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
"algorithms": {
"kex": [],
"cipher": [],
"serverHostKey": [],
"hmac": [],
"compress": []
}
}
]
}</pre>
<li>Specify connection parameters</li>
<li>Make sure that '''label''' parameter is set.</li>
</ol>

===Selecting which connection to use===
To use one of connections from the '''host collection''' section, copy the value of ''label'' and paste it in angle brackets ('''<label>''') to the '''host''' field in the '''connection''' section.

=== Example ===
<pre>
{
"connection": {
"host": "<MySSHConnection>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "10.10.6.1",
"keyFile": "",
"password": "myPassword",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "MySSHConnection"
}
]
}
}
</pre>

'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

=Timeouts=
You can define SSH connection timeouts in this section.
* <code>'''cmdTimeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''feedbackTimeout'''</code> - If the SSH connection does not send feedback for the specified interval, the password will be considered as invalid.
* <code>'''welcomeTimeout'''</code> - If the SSH shell prompt is not received within this interval, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

===Example===
<pre>
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
}
</pre>

=Terminal=
Specifies command to start the shell in the VS Code integrated terminal.
* <code>'''Command'''</code> - command to start the shell.

'''NOTE:''' It is possible to use variables in the command. The syntax is: <code>${variable}</code> or <code>${varable?<text if variable isn't empty>}</code>. Supported variables: '''host''', '''port''', '''username''', '''password''', and '''keyFile'''.
'''NOTE:''' password may come from settings or UI prompt that is shown if the password is not specified in settings. Passwords entered in the terminal are not saved.

===Example===
<pre>
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
</pre>

[[Category:VMS IDE]]

SSH Settings

2019-09-02T04:01:11Z

Sergey.vorfolomeev: /* Connection */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running, and debugging projects. 
Depending on the type of configuration, SSH connection settings can be edited either in the '''vmssoftware.ssh-helper-settings.json''' file located in ''/.vscode'' directory or via '''Visual Studio Code''' settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
"algorithms": {
"kex": [],
"cipher": [],
"serverHostKey": [],
"hmac": [],
"compress": []
}
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The '''connection''' section sets the current connection details.
* <code>'''host'''</code> - IP-address or name of an OpenVMS machine or the label of a predefined connection from the '''host collection''' section
case, all other fields are ignored.
* <code>'''port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''username'''</code> - User account that will be used for the SSH connection.
* <code>'''password'''</code> - User password that will be used for the SSH connection. If it is omitted a password input box will be shown on connection attempt.
* <code>'''keyFile'''</code> - Path to SSH private key file. For details on how to configure connection using SSH key, see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.
* <code>'''algorithms'''</code> - Optional. This allows you to explicitly override the default transport layer algorithms used for the connection. See https://www.npmjs.com/package/ssh2#client-methods

Required fields are:
* <code>'''host'''</code>
* <code>'''username'''</code>

You may use either password or key file to establish connection:
* <code>'''keyFile'''</code>
* <code>'''password'''</code>

If '''keyFile''' is not set, '''password''' is used. If neither '''password''' nor '''keyFile''' is specified, you will be prompted to enter your password during the connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to create a list of required connections to be able to quickly connect to any of them.
You can do this by adding all the required connections to the '''Host Collection''' list.

=== Adding a new host to collection ===
To add a new host to the collection:
<ol>
<li>Copy the ssh connection template to '''host-collection.hosts''' array:</li>
<pre>"host-collection": {
"hosts": [
{
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
"algorithms": {
"kex": [],
"cipher": [],
"serverHostKey": [],
"hmac": [],
"compress": []
}
}
]
}</pre>
<li>Specify connection parameters</li>
<li>Make sure that '''label''' parameter is set.</li>
</ol>

===Selecting which connection to use===
To use one of connections from the '''host collection''' section, copy the value of ''label'' and paste it in angle brackets ('''<label>''') to the '''host''' field in the '''connection''' section.

=== Example ===
<pre>
{
"connection": {
"host": "<MySSHConnection>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "10.10.6.1",
"keyFile": "",
"password": "myPassword",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "MySSHConnection"
}
]
}
}
</pre>

'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

=Timeouts=
You can define SSH connection timeouts in this section.
* <code>'''cmdTimeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''feedbackTimeout'''</code> - If the SSH connection does not send feedback for the specified interval, the password will be considered as invalid.
* <code>'''welcomeTimeout'''</code> - If the SSH shell prompt is not received within this interval, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

===Example===
<pre>
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
}
</pre>

=Terminal=
Specifies command to start the shell in the VS Code integrated terminal.
* <code>'''Command'''</code> - command to start the shell.

'''NOTE:''' It is possible to use variables in the command. The syntax is: <code>${variable}</code> or <code>${varable?<text if variable isn't empty>}</code>. Supported variables: '''host''', '''port''', '''username''', '''password''', and '''keyFile'''.
'''NOTE:''' password may come from settings or UI prompt that is shown if the password is not specified in settings. Passwords entered in the terminal are not saved.

===Example===
<pre>
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
</pre>

[[Category:VMS IDE]]

SSH Settings

2019-09-02T03:59:53Z

Sergey.vorfolomeev: /* Adding a new host to collection */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running, and debugging projects. 
Depending on the type of configuration, SSH connection settings can be edited either in the '''vmssoftware.ssh-helper-settings.json''' file located in ''/.vscode'' directory or via '''Visual Studio Code''' settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
"algorithms": {
"kex": [],
"cipher": [],
"serverHostKey": [],
"hmac": [],
"compress": []
}
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The '''connection''' section sets the current connection details.
* <code>'''host'''</code> - IP-address or name of an OpenVMS machine or the label of a predefined connection from the '''host collection''' section
case, all other fields are ignored.
* <code>'''port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''username'''</code> - User account that will be used for the SSH connection.
* <code>'''password'''</code> - User password that will be used for the SSH connection. If it is omitted a password input box will be shown on connection attempt.
* <code>'''keyFile'''</code> - Path to SSH private key file. For details on how to configure connection using SSH key, see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.
* <code>'''algorithms'''</code> - This option allows you to explicitly override the default transport layer algorithms used for the connection. See https://www.npmjs.com/package/ssh2#client-methods

Required fields are:
* <code>'''host'''</code>
* <code>'''username'''</code>

You may use either password or key file to establish connection:
* <code>'''keyFile'''</code>
* <code>'''password'''</code>

If '''keyFile''' is not set, '''password''' is used. If neither '''password''' nor '''keyFile''' is specified, you will be prompted to enter your password during the connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to create a list of required connections to be able to quickly connect to any of them.
You can do this by adding all the required connections to the '''Host Collection''' list.

=== Adding a new host to collection ===
To add a new host to the collection:
<ol>
<li>Copy the ssh connection template to '''host-collection.hosts''' array:</li>
<pre>"host-collection": {
"hosts": [
{
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
"algorithms": {
"kex": [],
"cipher": [],
"serverHostKey": [],
"hmac": [],
"compress": []
}
}
]
}</pre>
<li>Specify connection parameters</li>
<li>Make sure that '''label''' parameter is set.</li>
</ol>

===Selecting which connection to use===
To use one of connections from the '''host collection''' section, copy the value of ''label'' and paste it in angle brackets ('''<label>''') to the '''host''' field in the '''connection''' section.

=== Example ===
<pre>
{
"connection": {
"host": "<MySSHConnection>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "10.10.6.1",
"keyFile": "",
"password": "myPassword",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "MySSHConnection"
}
]
}
}
</pre>

'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

=Timeouts=
You can define SSH connection timeouts in this section.
* <code>'''cmdTimeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''feedbackTimeout'''</code> - If the SSH connection does not send feedback for the specified interval, the password will be considered as invalid.
* <code>'''welcomeTimeout'''</code> - If the SSH shell prompt is not received within this interval, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

===Example===
<pre>
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
}
</pre>

=Terminal=
Specifies command to start the shell in the VS Code integrated terminal.
* <code>'''Command'''</code> - command to start the shell.

'''NOTE:''' It is possible to use variables in the command. The syntax is: <code>${variable}</code> or <code>${varable?<text if variable isn't empty>}</code>. Supported variables: '''host''', '''port''', '''username''', '''password''', and '''keyFile'''.
'''NOTE:''' password may come from settings or UI prompt that is shown if the password is not specified in settings. Passwords entered in the terminal are not saved.

===Example===
<pre>
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
</pre>

[[Category:VMS IDE]]

SSH Settings

2019-09-02T03:59:05Z

Sergey.vorfolomeev: /* SSH Settings Template */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running, and debugging projects. 
Depending on the type of configuration, SSH connection settings can be edited either in the '''vmssoftware.ssh-helper-settings.json''' file located in ''/.vscode'' directory or via '''Visual Studio Code''' settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
"algorithms": {
"kex": [],
"cipher": [],
"serverHostKey": [],
"hmac": [],
"compress": []
}
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The '''connection''' section sets the current connection details.
* <code>'''host'''</code> - IP-address or name of an OpenVMS machine or the label of a predefined connection from the '''host collection''' section
case, all other fields are ignored.
* <code>'''port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''username'''</code> - User account that will be used for the SSH connection.
* <code>'''password'''</code> - User password that will be used for the SSH connection. If it is omitted a password input box will be shown on connection attempt.
* <code>'''keyFile'''</code> - Path to SSH private key file. For details on how to configure connection using SSH key, see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.
* <code>'''algorithms'''</code> - This option allows you to explicitly override the default transport layer algorithms used for the connection. See https://www.npmjs.com/package/ssh2#client-methods

Required fields are:
* <code>'''host'''</code>
* <code>'''username'''</code>

You may use either password or key file to establish connection:
* <code>'''keyFile'''</code>
* <code>'''password'''</code>

If '''keyFile''' is not set, '''password''' is used. If neither '''password''' nor '''keyFile''' is specified, you will be prompted to enter your password during the connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to create a list of required connections to be able to quickly connect to any of them.
You can do this by adding all the required connections to the '''Host Collection''' list.

=== Adding a new host to collection ===
To add a new host to the collection:
<ol>
<li>Copy the ssh connection template to '''host-collection.hosts''' array:</li>
<pre>"host-collection": {
"hosts": [
{
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
}
]
}</pre>
<li>Specify connection parameters</li>
<li>Make sure that '''label''' parameter is set.</li>
</ol>

===Selecting which connection to use===
To use one of connections from the '''host collection''' section, copy the value of ''label'' and paste it in angle brackets ('''<label>''') to the '''host''' field in the '''connection''' section.

=== Example ===
<pre>
{
"connection": {
"host": "<MySSHConnection>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "10.10.6.1",
"keyFile": "",
"password": "myPassword",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "MySSHConnection"
}
]
}
}
</pre>

'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

=Timeouts=
You can define SSH connection timeouts in this section.
* <code>'''cmdTimeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''feedbackTimeout'''</code> - If the SSH connection does not send feedback for the specified interval, the password will be considered as invalid.
* <code>'''welcomeTimeout'''</code> - If the SSH shell prompt is not received within this interval, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

===Example===
<pre>
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
}
</pre>

=Terminal=
Specifies command to start the shell in the VS Code integrated terminal.
* <code>'''Command'''</code> - command to start the shell.

'''NOTE:''' It is possible to use variables in the command. The syntax is: <code>${variable}</code> or <code>${varable?<text if variable isn't empty>}</code>. Supported variables: '''host''', '''port''', '''username''', '''password''', and '''keyFile'''.
'''NOTE:''' password may come from settings or UI prompt that is shown if the password is not specified in settings. Passwords entered in the terminal are not saved.

===Example===
<pre>
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
</pre>

[[Category:VMS IDE]]

SSH Settings

2019-09-02T03:55:30Z

Sergey.vorfolomeev: /* Connection */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running, and debugging projects. 
Depending on the type of configuration, SSH connection settings can be edited either in the '''vmssoftware.ssh-helper-settings.json''' file located in ''/.vscode'' directory or via '''Visual Studio Code''' settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The '''connection''' section sets the current connection details.
* <code>'''host'''</code> - IP-address or name of an OpenVMS machine or the label of a predefined connection from the '''host collection''' section
case, all other fields are ignored.
* <code>'''port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''username'''</code> - User account that will be used for the SSH connection.
* <code>'''password'''</code> - User password that will be used for the SSH connection. If it is omitted a password input box will be shown on connection attempt.
* <code>'''keyFile'''</code> - Path to SSH private key file. For details on how to configure connection using SSH key, see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.
* <code>'''algorithms'''</code> - This option allows you to explicitly override the default transport layer algorithms used for the connection. See https://www.npmjs.com/package/ssh2#client-methods

Required fields are:
* <code>'''host'''</code>
* <code>'''username'''</code>

You may use either password or key file to establish connection:
* <code>'''keyFile'''</code>
* <code>'''password'''</code>

If '''keyFile''' is not set, '''password''' is used. If neither '''password''' nor '''keyFile''' is specified, you will be prompted to enter your password during the connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to create a list of required connections to be able to quickly connect to any of them.
You can do this by adding all the required connections to the '''Host Collection''' list.

=== Adding a new host to collection ===
To add a new host to the collection:
<ol>
<li>Copy the ssh connection template to '''host-collection.hosts''' array:</li>
<pre>"host-collection": {
"hosts": [
{
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
}
]
}</pre>
<li>Specify connection parameters</li>
<li>Make sure that '''label''' parameter is set.</li>
</ol>

===Selecting which connection to use===
To use one of connections from the '''host collection''' section, copy the value of ''label'' and paste it in angle brackets ('''<label>''') to the '''host''' field in the '''connection''' section.

=== Example ===
<pre>
{
"connection": {
"host": "<MySSHConnection>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "10.10.6.1",
"keyFile": "",
"password": "myPassword",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "MySSHConnection"
}
]
}
}
</pre>

'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

=Timeouts=
You can define SSH connection timeouts in this section.
* <code>'''cmdTimeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''feedbackTimeout'''</code> - If the SSH connection does not send feedback for the specified interval, the password will be considered as invalid.
* <code>'''welcomeTimeout'''</code> - If the SSH shell prompt is not received within this interval, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

===Example===
<pre>
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
}
</pre>

=Terminal=
Specifies command to start the shell in the VS Code integrated terminal.
* <code>'''Command'''</code> - command to start the shell.

'''NOTE:''' It is possible to use variables in the command. The syntax is: <code>${variable}</code> or <code>${varable?<text if variable isn't empty>}</code>. Supported variables: '''host''', '''port''', '''username''', '''password''', and '''keyFile'''.
'''NOTE:''' password may come from settings or UI prompt that is shown if the password is not specified in settings. Passwords entered in the terminal are not saved.

===Example===
<pre>
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
</pre>

[[Category:VMS IDE]]

VMS IDE for Java (Kotlin, Scala)

2019-08-29T06:48:56Z

Sergey.vorfolomeev: /* Start */

'''Note: coming soon'''

== Steps to run java project ==

# Change project settings: '''project type''' (java, scala or kotlin), '''project name''', '''root folder''', '''source''', '''headers''', '''resource''' and '''listing''' masks
# Write code
# Create MMS
# Upload
# Build
# Collect Java classes. This step is required for debugging.
# Run

Because project target will be compiled by one command for all source files please do not mix Kotlin, Scala and Java source files in one project.

== Abilities ==

* Java, Scala or Kotlin project can depend on other Java, Scala or Kotlin projects.

== Debugging ==

In order to use breakpoints one should execute '''Collect Java classes''' before debugging if project is changed and built.

=== Start ===

To start debugging press F5 button. If no debug configuration selected 
[[File:Jvm-dbg-no-config-selected.png|no-config]] 
the 'Select environment' dropdown window will be displayed. 
[[File:Jvm-dbg-select.png|dbg-select]] 
Choose 'VMS JVM Debugger'. If all java classes collected successfully the 'entry class' quickpick window will be displayed. 
[[File:Jvm-dbg-select-main.png|select-main]] 
Select one and debugging will start.

You can configure 'launch.json' to start predefined debug configuration. To do this press 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] 
If there is no 'launch.json' file the 'Select environment' dropdown window will be displayed. Choose 'VMS JVM Debugger'.
If 'launch.json' file exists press 'Add Configuration' button in the right bottom side and select 'VMS IDE: Launch JVM'. 
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Edit '''name'''
* Enter class path - ''A ':' separated list of directories, JAR archives, and ZIP archives to search for class files.'' In case of "${command:FillClassPath}" class path will be given from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' quickpick window will be displayed when debugging is started.
* '''port''' is range of ports for JDB.
* '''arguments''' is argumets string passed to the program.
* '''stopOnEntry''' whether do stop or not on the entry of the program.

=== Breakpoints ===

Breakpoints are shown grayed until corresponding class is loaded into memory. Also they are grayed if no java class information collected.

==== Function breakpoints ====

Press '+' at the breakpoints view. Enter the function name in format ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)''. You can omit any part of function name. QuickPick window with corresponding functions will appear. Select required one.
If no dialog appears press 'Activate Breakpoints'.

==== Data breakpoints ====

The UI for data breakpoints doesn't exist. To create data breakpoint enter 'watch all <class>.<field>' in the input debugging console while program is paused, to remove enter 'unwatch all <class>.<field>'.
This feature doesn't allow to catch changing of concrete variable, it will catch all changing of <field> for all instances of <class>. Also it doesn't work for local variables.

=== Displaying/Setting variables ===

String variable is displayed 'as is', without escaping. Char variable is escaped if its value is less than 0x20 or greater than 0x7f.
To set the value of a string or char variable, you can write an escaped string (in java rules). No enclosing quotes required.

=== Debugging console ===

If the program is running, everything written in the input debugging console will be sent to the program.
If the program is paused, everything written in the input debugging console will be sent to the debugger. So be careful not to break the debugger. For example 'eval a=100' will change the value of variable and this won't be caught by extension.

[[Category: VMS IDE]]

VMS IDE for Java (Kotlin, Scala)

2019-08-29T06:48:20Z

Sergey.vorfolomeev: /* Displaying/Setting variables */

'''Note: coming soon'''

== Steps to run java project ==

# Change project settings: '''project type''' (java, scala or kotlin), '''project name''', '''root folder''', '''source''', '''headers''', '''resource''' and '''listing''' masks
# Write code
# Create MMS
# Upload
# Build
# Collect Java classes. This step is required for debugging.
# Run

Because project target will be compiled by one command for all source files please do not mix Kotlin, Scala and Java source files in one project.

== Abilities ==

* Java, Scala or Kotlin project can depend on other Java, Scala or Kotlin projects.

== Debugging ==

In order to use breakpoints one should execute '''Collect Java classes''' before debugging if project is changed and built.

=== Start ===

To start debugging press F5 button. If no debug configuration selected 
[[File:Jvm-dbg-no-config-selected.png|no-config]] 
the 'Select environment' dropdown window will be displayed. 
[[File:Jvm-dbg-select.png|dbg-select]] 
Choose 'VMS JVM Debugger'. If all java classes collected successfully the 'entry class' quickpick window will be displayed. 
[[File:Jvm-dbg-select-main.png|select-main]] 
Select one and debugging will start.

You can configure 'launch.json' to start predefined debug configuration. To do this press 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] 
If there is no 'launch.json' file the 'Select environment' dropdown window will be displayed. Choose 'VMS JVM Debugger'.
If 'launch.json' file exists press 'Add Configuration' button in the right bottom side and select 'VMS IDE: Launch JVM'. 
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Edit '''name'''
* Enter class path - ''A ':' separated list of directories, JAR archives, and ZIP archives to search for class files.'' In case of "${command:FillClassPath}" class path will be given from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' quickpick window will be displayed when debugging is started.
* '''port''' is diapason of ports for JDB.
* '''arguments''' is argumets string passed to the program.
* '''stopOnEntry''' whether do stop or not on the entry of the program.

=== Breakpoints ===

Breakpoints are shown grayed until corresponding class is loaded into memory. Also they are grayed if no java class information collected.

==== Function breakpoints ====

Press '+' at the breakpoints view. Enter the function name in format ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)''. You can omit any part of function name. QuickPick window with corresponding functions will appear. Select required one.
If no dialog appears press 'Activate Breakpoints'.

==== Data breakpoints ====

The UI for data breakpoints doesn't exist. To create data breakpoint enter 'watch all <class>.<field>' in the input debugging console while program is paused, to remove enter 'unwatch all <class>.<field>'.
This feature doesn't allow to catch changing of concrete variable, it will catch all changing of <field> for all instances of <class>. Also it doesn't work for local variables.

=== Displaying/Setting variables ===

String variable is displayed 'as is', without escaping. Char variable is escaped if its value is less than 0x20 or greater than 0x7f.
To set the value of a string or char variable, you can write an escaped string (in java rules). No enclosing quotes required.

=== Debugging console ===

If the program is running, everything written in the input debugging console will be sent to the program.
If the program is paused, everything written in the input debugging console will be sent to the debugger. So be careful not to break the debugger. For example 'eval a=100' will change the value of variable and this won't be caught by extension.

[[Category: VMS IDE]]

VMS IDE for Java (Kotlin, Scala)

2019-08-29T06:47:47Z

Sergey.vorfolomeev: /* Data breakpoints */

'''Note: coming soon'''

== Steps to run java project ==

# Change project settings: '''project type''' (java, scala or kotlin), '''project name''', '''root folder''', '''source''', '''headers''', '''resource''' and '''listing''' masks
# Write code
# Create MMS
# Upload
# Build
# Collect Java classes. This step is required for debugging.
# Run

Because project target will be compiled by one command for all source files please do not mix Kotlin, Scala and Java source files in one project.

== Abilities ==

* Java, Scala or Kotlin project can depend on other Java, Scala or Kotlin projects.

== Debugging ==

In order to use breakpoints one should execute '''Collect Java classes''' before debugging if project is changed and built.

=== Start ===

To start debugging press F5 button. If no debug configuration selected 
[[File:Jvm-dbg-no-config-selected.png|no-config]] 
the 'Select environment' dropdown window will be displayed. 
[[File:Jvm-dbg-select.png|dbg-select]] 
Choose 'VMS JVM Debugger'. If all java classes collected successfully the 'entry class' quickpick window will be displayed. 
[[File:Jvm-dbg-select-main.png|select-main]] 
Select one and debugging will start.

You can configure 'launch.json' to start predefined debug configuration. To do this press 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] 
If there is no 'launch.json' file the 'Select environment' dropdown window will be displayed. Choose 'VMS JVM Debugger'.
If 'launch.json' file exists press 'Add Configuration' button in the right bottom side and select 'VMS IDE: Launch JVM'. 
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Edit '''name'''
* Enter class path - ''A ':' separated list of directories, JAR archives, and ZIP archives to search for class files.'' In case of "${command:FillClassPath}" class path will be given from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' quickpick window will be displayed when debugging is started.
* '''port''' is diapason of ports for JDB.
* '''arguments''' is argumets string passed to the program.
* '''stopOnEntry''' whether do stop or not on the entry of the program.

=== Breakpoints ===

Breakpoints are shown grayed until corresponding class is loaded into memory. Also they are grayed if no java class information collected.

==== Function breakpoints ====

Press '+' at the breakpoints view. Enter the function name in format ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)''. You can omit any part of function name. QuickPick window with corresponding functions will appear. Select required one.
If no dialog appears press 'Activate Breakpoints'.

==== Data breakpoints ====

The UI for data breakpoints doesn't exist. To create data breakpoint enter 'watch all <class>.<field>' in the input debugging console while program is paused, to remove enter 'unwatch all <class>.<field>'.
This feature doesn't allow to catch changing of concrete variable, it will catch all changing of <field> for all instances of <class>. Also it doesn't work for local variables.

=== Displaying/Setting variables ===

String variable is displayed 'as is', without escaping. Char variable is escaped if its value is less than 0x20 or greater than 0x7f.
To set the value of a string or char variable, you can write an escaped string (in java rules). No enclosing quotes required!

=== Debugging console ===

If the program is running, everything written in the input debugging console will be sent to the program.
If the program is paused, everything written in the input debugging console will be sent to the debugger. So be careful not to break the debugger. For example 'eval a=100' will change the value of variable and this won't be caught by extension.

[[Category: VMS IDE]]

VMS IDE

2019-08-28T09:23:29Z

Sergey.vorfolomeev: /* Features */

'''VMS IDE''' is an integrated development environment that enables you to quickly and easily develop comprehensive applications for OpenVMS system. It provides a set of tools for developing, building, and debugging OpenVMS projects.

=Features=
[[File:Vms ide.png|800px|thumb|none|VMS IDE]]
* Source code '''synchronization''' between the local machine and OpenVMS system.
* '''SSH connection''' setup to the remote OpenVMS system.
* '''Projects Explorer''' as a simple and convenient way to manage OpenVMS projects.
* '''Debugger''' for OpenVMS and JVM projects.
* '''Syntax highlighting''' for '''MMS''', '''CLD''', '''MSG''' and '''Pascal''' source.
* '''Code auto-completion''' for '''MSG''' and '''CLD''' files.
* Supported languages: '''C''', '''C++''', '''Fortran''', '''Cobol''', '''Pascal''', '''Basic''', '''Bliss''', '''Java''', '''Kotlin''', '''Scala'''.

=Restrictions=
* The '''VMS IDE''' extension can only be used in conjunction with ODS-5 OpenVMS file systems; it cannot be used with ODS-2 file systems.
* Do not use the minus sign ("-") in file names. This may prevent the debugger from finding the source file.

=Getting Started=
This guide will help you install the VMS IDE extension and start working on your projects.

===Quick Start===
* [[VMS_IDE_Installation|Installing VMS IDE]]
* [[VMS_IDE_Project_Configuration|Setting up a VMS Project]]
* [[VMS_IDE_Developing|Working on a VMS Project]]

===Settings===
* [[Project Settings]]
* [[SSH Settings]]
* [[Synchronize Configuration|Synchronize Settings]]
* [[Build Configurations]]

===Commands===
* [[VMS_IDE_Commands|VMS IDE Commands]]

===Components===
* [[VMS_IDE_Project_Explorer|Project Explorer]]
* [[VMS_IDE_Debugger|Debugger]]

=Changelog=
[[VMS IDE Change Log]]

[[Category:VMS IDE]]

VMS IDE for Java (Kotlin, Scala)

2019-08-28T09:17:48Z

Sergey.vorfolomeev: /* Steps to run java project */

'''Note: coming soon'''

== Steps to run java project ==

# Change project settings: '''project type''' (java, scala or kotlin), '''project name''', '''root folder''', '''source''', '''headers''', '''resource''' and '''listing''' masks
# Write code
# Create MMS
# Upload
# Build
# Collect Java classes. This step is required for debugging.
# Run

Because project target will be compiled by one command for all source files please do not mix Kotlin, Scala and Java source files in one project.

== Abilities ==

* Java, Scala or Kotlin project can depend on other Java, Scala or Kotlin projects.

== Debugging ==

In order to use breakpoints one should execute '''Collect Java classes''' before debugging if project is changed and built.

=== Start ===

To start debugging press F5 button. If no debug configuration selected 
[[File:Jvm-dbg-no-config-selected.png|no-config]] 
the 'Select environment' dropdown window will be displayed. 
[[File:Jvm-dbg-select.png|dbg-select]] 
Choose 'VMS JVM Debugger'. If all java classes collected successfully the 'entry class' quickpick window will be displayed. 
[[File:Jvm-dbg-select-main.png|select-main]] 
Select one and debugging will start.

You can configure 'launch.json' to start predefined debug configuration. To do this press 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] 
If there is no 'launch.json' file the 'Select environment' dropdown window will be displayed. Choose 'VMS JVM Debugger'.
If 'launch.json' file exists press 'Add Configuration' button in the right bottom side and select 'VMS IDE: Launch JVM'. 
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Edit '''name'''
* Enter class path - ''A ':' separated list of directories, JAR archives, and ZIP archives to search for class files.'' In case of "${command:FillClassPath}" class path will be given from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' quickpick window will be displayed when debugging is started.
* '''port''' is diapason of ports for JDB.
* '''arguments''' is argumets string passed to the program.
* '''stopOnEntry''' whether do stop or not on the entry of the program.

=== Breakpoints ===

Breakpoints are shown grayed until corresponding class is loaded into memory. Also they are grayed if no java class information collected.

==== Function breakpoints ====

Press '+' at the breakpoints view. Enter the function name in format ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)''. You can omit any part of function name. QuickPick window with corresponding functions will appear. Select required one.
If no dialog appears press 'Activate Breakpoints'.

==== Data breakpoints ====

The UI for data breakpoints doesn't exist. To create data breakpoint enter 'watch all <class>.<field>' in the input debugging console while program is paused, to remove enter 'unwatch all <class>.<field>'.

=== Displaying/Setting variables ===

String variable is displayed 'as is', without escaping. Char variable is escaped if its value is less than 0x20 or greater than 0x7f.
To set the value of a string or char variable, you can write an escaped string (in java rules). No enclosing quotes required!

=== Debugging console ===

If the program is running, everything written in the input debugging console will be sent to the program.
If the program is paused, everything written in the input debugging console will be sent to the debugger. So be careful not to break the debugger. For example 'eval a=100' will change the value of variable and this won't be caught by extension.

[[Category: VMS IDE]]

VMS IDE Project Explorer

2019-08-28T09:13:41Z

Sergey.vorfolomeev: /* Project types */

The '''Project Explorer''' view helps to manage OpenVMS projects, their dependencies, and settings. It is also possible to build, rebuild, and clean the project using the '''Project Explorer''' context menu.

=Description=
{| style="border-style: none;"
|-
|rowspan="2"| [[File:Project-explorer.PNG|frame|left|Project Explorer]]
|style="vertical-align:top; padding-left: 20px;" |
==Project Dependencies==

====Project types====
* ''executable'' - executable image is created
* ''library'' - object library (OLB) is created
* ''shareable'' - shareable image is created
* ''java'' - project contains only java files
* ''kotlin'' - project contains only kotlin files
* ''scala'' - project contains only scala files

====Context Menu====
* '''Add to dependencies of selected''' - add the project you right-clicked to the previously selected project as a dependency
* '''Remove project from dependencies''' - remove the selected project from dependencies of the main project
* '''Build only this project''' - build the current project
* '''Build with dependencies''' - build the current project and all its dependencies
* '''Clean this only''' - clean current project only
* '''Rebuild only this project''' - rebuild the current project
* '''Rebuild with dependencies''' - rebuild the current project and all its dependencies

====Creating MMS Files====
'''VMS IDE''' can create '''MMS''' files automatically based on the project type and the types of its dependencies. 
For ''shareable'' images, an options ('''OPT''') file is created, but the universal symbol vector must be edited manually. 
If the project depends on some shareable images, a '''COM''' file is created with ''logicals'' required for running the project.

==Project Description==
When a project is selected in the Project Dependencies panel, its description is shown.
* '''Local'''
** ''folder'' - [[VMS IDE Project Configuration|Workspace folder name]]
** ''buildName'' - currently selected [[Build Configurations|build configuration]] (right-click and select '''Change''' to choose another one)
** ''sourceState'' - current state of source files
*** ''unknown'' - no synchronization or upload was performed or there were changes to the Project or SSH settings
*** ''modified'' - there are changes that need to be synchronized
*** ''synchronized'' - project files on the local machine and OpenVMS are synchronized
** ''buildState'' - current state of the build (''Built'' or ''Not built''). State is linked to the build configuration.
** ''masters'' - projects which depend on the currently selected project
* '''SSH'''
** ''host'' - OpenVMS host to synchronize and build with
* '''Project'''
** ''projectName'' - the name of the project
** ''projectType'' - [[#Project types|the type of the project]]
** ''root'' - project root on OpenVMS
|}

[[Category:VMS IDE]]

VMS IDE Debugger

2019-08-28T09:11:02Z

Sergey.vorfolomeev: /* Supported Languages */

'''VMS IDE''' uses Visual Studio Code built-in debugger and supports all of its features.

=Features=
[[File:Vms-ide-debugger.png|900px|none|none|VMS IDE Debugger]]

; [1] VARIABLES : Shows local variables. If the panel is collapsed, variables are not requested. When debugging, you can set variable values by double-clicking them and typing a new value.
; [2] WATCH: You can add variable names (expressions) to set watchpoints:
: * Expression without braces "()" - request variable value (local or global);
: * Expression with empty braces "()" - enable watchpoint, for example <code>x()</code>;
: * Expression with conditional expression in braces "(when ...)" - enable watchpoint with condition, for example <code>x(when (x<5))</code>.
; [3] CALL STACK : Shows stack frames. Variables and expressions listed in VARIABLES and WATCH sections are relative to the selected stack frame.
; [4] BREAKPOINTS : Shows breakpoints set for the current project.
; [5] DEBUG TOOLBAR : Provides standard debugging actions. Edit field '''stopOnEntry''' in the launch.json file:
:* Set field "stopOnEntry" = true to enable stop on entry.
:* Set field "stopOnEntry" = false to disable stop on entry.
; [6] EDITOR :
: * Breakpoints can be toggled by clicking on the '''Editor''' margin or using <code>F9</code> on the current line.
: * Variable values can be seen by hovering over variables in the code.
; [7] DEBUG CONSOLE : Shows debugging output. Opens automatically as soon as debugging session starts. All program output will be on this screen. If the program requires data input, enter it in the Debug Console REPL.

=Important Notes=
If you cannot set breakpoints in the source file please check the language mode of the source file (see image).
[[File:Lang-mode.png|200px|thumb|none|Language mode]]

== Supported Languages ==
Only the following languages are supported (case sensitive):
* c
* cpp
* cobol
* fortran
* pascal
* bliss
* vms-basic
* java
* kotlin
* scala

According to the '''breakpoints''' section in the 'package.json' file:
<pre>
"breakpoints": [
{
"language": "c"
},
{
"language": "cpp"
},
{
"language": "bliss"
},
{
"language": "vms-basic"
},
{
"language": "cobol"
},
{
"language": "pascal"
},
{
"language": "fortran"
},
{
"language": "kotlin"
},
{
"language": "scala"
},
{
"language": "java"
}
]
</pre>

=Additional Information=
Please view [https://code.visualstudio.com/docs/editor/debugging Visual Studio Code documentation] to learn more about Debbuger view and debugging process in Visual Studio Code. 

[[Category:VMS IDE]]

VMS IDE Developing

2019-08-28T09:08:43Z

Sergey.vorfolomeev: /* Debugging */

==Loading Existing Project==
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.

==Managing Project Source Files==
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.

The OpenVMS project structure may look like shown below:
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]

==Managing the Project==
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.

===Managing Dependencies===
If you work on a complex project and you need to add dependencies, use the '''PROJECT DEPENDENCIES''' section. 
Assuming that you want to add "Project B" to "Project A" dependencies, 
# Select "Project A" in the '''PROJECT DEPENDENCIES''' panel.
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.
 
To remove a project from dependencies
# Open the '''PROJECT DEPENDENCIES''' section.
# Right-click the project, then select ''Remove from dependencies''.

=Building=

===Build Configurations===
To build your projects you can use a default build configuration or create a custom one. See [[Build Configurations]] for details.

===Build MMS===
Before building your project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>. See [[Auto-generated MMS]] for more information.

===Building VMS Project===
To build a project in VMS IDE:
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.
# Select the project you want to build in the '''PROJECT DEPENDENCIES''' section.
# In the '''PROJECT DESCRIPTION''' section, choose the required [[Build Configurations|build configuration]] by right-clicking the '''buildName''' parameter and selecting '''Change'''.
# Right-click the project and select ''Build with dependencies'' from the context menu.

If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.

'''NOTE''': you can manually upload all new and updated files by using the [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.

=Debugging=
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.

To debug JVM based projects see [[VMS IDE for Java (Kotlin, Scala)]]

'''NOTE''': Before running the debugger, make sure that you have actual DEBUG builds on the OpenVMS system.

To start a debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.
<pre>"configurations": [
{
"type": "vms_dbg",
"request": "launch",
"name": "Debug",
"program": "",
"arguments": "",
"stopOnEntry": true,
"typeRun": "DEBUG"
}
]
</pre>
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>.
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.

To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.
Press <code>F5</code> again to run debugger.

[[Category:VMS IDE]]

VMS IDE Developing

2019-08-28T09:06:23Z

Sergey.vorfolomeev: /* Managing Dependencies */

==Loading Existing Project==
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.

==Managing Project Source Files==
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.

The OpenVMS project structure may look like shown below:
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]

==Managing the Project==
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.

===Managing Dependencies===
If you work on a complex project and you need to add dependencies, use the '''PROJECT DEPENDENCIES''' section. 
Assuming that you want to add "Project B" to "Project A" dependencies, 
# Select "Project A" in the '''PROJECT DEPENDENCIES''' panel.
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.
 
To remove a project from dependencies
# Open the '''PROJECT DEPENDENCIES''' section.
# Right-click the project, then select ''Remove from dependencies''.

=Building=

===Build Configurations===
To build your projects you can use a default build configuration or create a custom one. See [[Build Configurations]] for details.

===Build MMS===
Before building your project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>. See [[Auto-generated MMS]] for more information.

===Building VMS Project===
To build a project in VMS IDE:
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.
# Select the project you want to build in the '''PROJECT DEPENDENCIES''' section.
# In the '''PROJECT DESCRIPTION''' section, choose the required [[Build Configurations|build configuration]] by right-clicking the '''buildName''' parameter and selecting '''Change'''.
# Right-click the project and select ''Build with dependencies'' from the context menu.

If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.

'''NOTE''': you can manually upload all new and updated files by using the [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.

=Debugging=
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.

'''NOTE''': Before running the debugger, make sure that you have actual DEBUG builds on the OpenVMS system.

To start a debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.
<pre>"configurations": [
{
"type": "vms_dbg",
"request": "launch",
"name": "Debug",
"program": "",
"arguments": "",
"stopOnEntry": true,
"typeRun": "DEBUG"
}
]
</pre>
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>.
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.

To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.
Press <code>F5</code> again to run debugger.

[[Category:VMS IDE]]

VMS IDE Change Log

2019-08-28T09:03:30Z

Sergey.vorfolomeev:

=== 1.2.3 ===
* Function breakpoints. Data breakpoints without UI.

=== 1.2.2 ===
* Fix display/set unicode string in '''Java''' debugger, collecting fields of java classes.

=== 1.2.1 ===
* Fix working with templates in '''Java'''.

=== 1.2.0 ===
* Support '''Java''', '''Kotlin''' and '''Scala'''.
* One output channel "VMS-IDE" for all extension messages.

=== 1.1.0 ===
* '''Pascal''' syntax highlighting.
* OpenVMS specific '''COBOL''' grammar support.

=== 1.0.2 ===
* Allow to skip verifying the signature in SSH (because of VS Code 1.36.1 issue).

=== 1.0.1 ===
* Fix: parsing compiler errors that occurred on the same line of source code.
* OpenVMS specific '''Pascal''' grammar basic support.
* Debugger: skip querying symbols with invalid names.

[[Category:VMS IDE]]

Project Settings

2019-08-28T08:59:37Z

Sergey.vorfolomeev: /* Project Settings Description */

=Project Configuration Example=
<pre>
{
"project": {
"break": "C",
"builders": "*.{mms,com}",
"exclude": "**/{node_modules,.vscode}/**",
"headers": "*.h",
"listing": "*.lis",
"outdir": "out",
"projectName": "project",
"projectType": "executable",
"resource": "**/resource/**",
"root": "project",
"source": "*.{cpp,c}",
"addLibraries": "sys$library:IMAGELIB.OLB,sys$library:RDBMSGS.OLB",
"addIncludes": "sys$library"
}
}
</pre>

=Project Settings Description=
* <code>'''Break'''</code> - Keyboard key to pause debugging in VMS IDE debugger. The extension uses combination <code>CTRL+Key</code> to pause debugging when user press '''Pause''' or <code>F6</code>.
* <code>'''Builders'''</code> - Mask for files used for building the project. Default is "*.{mms,com}".
* <code>'''Exclude'''</code> - Folders excluded from synchronization with OpenVMS system.
* <code>'''Headers'''</code> - Header files. Default is "*.{h,hpp}".
* <code>'''Listing'''</code> - Listing files that will be downloaded after the project is built for debugging purpose.
* <code>'''Outdir'''</code> - Output directory where object, listing and executable files will be stored when built. Is also used for temporary files. '''NOTE''': Should be only the name of the folder, not a full or relative path.
* <code>'''Project Name'''</code> - Name for the executable file, auto-generated '''MMS''' file for builder, OPT file for linker, and COM file for defining logical names. '''NOTE''': Use one word only; do not use spaces or special characters.
* <code>'''Project Type'''</code> - Type of the project. Available types: '''executable''', '''library''' or '''shareable''' for classic languages; '''java''', '''kotlin''' or '''scala''' for JVM based projects. The building method depends on the type of the project and its dependencies.
* <code>'''Resource'''</code> - Files required for the project, but are not involved in the build process.
* <code>'''Root'''</code> - Directory of the project on the remote OpenVMS machine in UNIX format relative to the home folder.
* <code>'''Source'''</code> - Mask for the source files, e.g. "*.{c,cpp}".
* <code>'''Additional libraries'''</code> - list of libraries in ODS-5 format, separated by commas.
* <code>'''Additional include folders'''</code> - list of folders in ODS-5 format, separated by commas.

=Adjusting Project Settings=
# Set the <code>'''Root'''</code> directory. For example, if the project is located in '''WORK:[USER.DEMOS.SIMPLE]''' and the home directory is '''WORK:[USER]''', set the parameter value to '''demos/simple'''.
# Select the <code>'''Project Type'''</code> that you need.
# Specify the <code>'''Project Name'''</code>. '''NOTE''': do not use spaces or special characters.
# Check <code>'''Builders'''</code>. These files will be synchronized.
# Check <code>'''Headers'''</code>. These files will be synchronized and included into the [[Auto-generating MMS|auto-generated MMS]] file as header files. Changing any of them will result in full project rebuild.
# Check <code>'''Source'''</code>. These files will be synchronized and included into the [[Auto-generating MMS|auto-generated MMS]] file as source files.
# Check <code>'''Resource'''</code>. These files will be synchronized but not included into the [[Auto-generating MMS|auto-generated MMS]] file.
# Adjust the <code>'''Exclude'''</code> field value to list the files similar to the described above but not to be synchronized and compiled.
# Check <code>'''Listing'''</code>. These files will be downloaded after building the project. Files "*.lis,*.map" are required for debugger.
# If the project depends on already installed libraries, specify the in the <code>'''Additional libraries'''</code> and <code>'''Additional include folders'''</code>

[[Category:VMS IDE]]

Pascal syntax highlighting

2019-08-28T08:57:58Z

Sergey.vorfolomeev:

== Syntax highlighting for Pascal ==
[[File:Pascal-syntax-1.png|Pascal-syntax-example|frame|left]]

=== Features ===
* Displaying symbol source in tooltip
* Go to symbol definition (F12)
* Peek definition (Alt-F12)
* Find all references (Shift-Alt-F12)
* Rename symbol (F2)
* Dynamic syntax checking
[[File:Pascal-syntax-2.png|thumb|left|syntax check]]

[[Category: VMS IDE]]

Pascal syntax highlighting

2019-08-28T08:57:35Z

Sergey.vorfolomeev: Created page with " == Syntax highlighting for Pascal == left === Features === * Displaying symbol source in tooltip * Go to symbol defi..."

File:Pascal-syntax-2.png

2019-08-28T08:55:27Z

Sergey.vorfolomeev:

Pascal-syntax-2

File:Pascal-syntax-1.png

2019-08-28T08:43:30Z

Sergey.vorfolomeev:

Pascal-syntax-1

VMS IDE for Java (Kotlin, Scala)

2019-08-28T06:57:19Z

Sergey.vorfolomeev:

'''Note: coming soon'''

== Steps to run java project ==

# Change project settings: '''project type''' (java, scala or kotlin), '''project name''', '''root folder''', '''source''', '''headers''', '''resource''' and '''listing''' masks
# Write code
# Create MMS
# Upload
# Build
# Collect Java classes. This step is required for debugging.
# Run

== Abilities ==

* Java, Scala or Kotlin project can depend on other Java, Scala or Kotlin projects.

== Debugging ==

In order to use breakpoints one should execute '''Collect Java classes''' before debugging if project is changed and built.

=== Start ===

To start debugging press F5 button. If no debug configuration selected 
[[File:Jvm-dbg-no-config-selected.png|no-config]] 
the 'Select environment' dropdown window will be displayed. 
[[File:Jvm-dbg-select.png|dbg-select]] 
Choose 'VMS JVM Debugger'. If all java classes collected successfully the 'entry class' quickpick window will be displayed. 
[[File:Jvm-dbg-select-main.png|select-main]] 
Select one and debugging will start.

You can configure 'launch.json' to start predefined debug configuration. To do this press 'Configure or Fix...' button on the DEBUG panel. 
[[File:Jvm-dbg-configure-or-fix.png|dbg-configure-or-fix]] 
If there is no 'launch.json' file the 'Select environment' dropdown window will be displayed. Choose 'VMS JVM Debugger'.
If 'launch.json' file exists press 'Add Configuration' button in the right bottom side and select 'VMS IDE: Launch JVM'. 
<pre>
{
"type": "vms jvm debugger",
"request": "launch",
"name": "Launch JVM",
"classpath": "${command:FillClassPath}",
"class": "${command:FillClassName}",
"port": "5005-5105",
"arguments": "",
"stopOnEntry": true
}
</pre>
* Do not change '''type''' and '''request'''
* Edit '''name'''
* Enter class path - ''A ':' separated list of directories, JAR archives, and ZIP archives to search for class files.'' In case of "${command:FillClassPath}" class path will be given from project settings.
* Enter full class name with the static '''main''' method. In case of "${command:FillClassName}" the 'select executable class' quickpick window will be displayed when debugging is started.
* '''port''' is diapason of ports for JDB.
* '''arguments''' is argumets string passed to the program.
* '''stopOnEntry''' whether do stop or not on the entry of the program.

=== Breakpoints ===

Breakpoints are shown grayed until corresponding class is loaded into memory. Also they are grayed if no java class information collected.

==== Function breakpoints ====

Press '+' at the breakpoints view. Enter the function name in format ''<full_class_path>.<method>(<arg_type1>, <arg_type2>...)''. You can omit any part of function name. QuickPick window with corresponding functions will appear. Select required one.
If no dialog appears press 'Activate Breakpoints'.

==== Data breakpoints ====

The UI for data breakpoints doesn't exist. To create data breakpoint enter 'watch all <class>.<field>' in the input debugging console while program is paused, to remove enter 'unwatch all <class>.<field>'.

=== Displaying/Setting variables ===

String variable is displayed 'as is', without escaping. Char variable is escaped if its value is less than 0x20 or greater than 0x7f.
To set the value of a string or char variable, you can write an escaped string (in java rules). No enclosing quotes required!

=== Debugging console ===

If the program is running, everything written in the input debugging console will be sent to the program.
If the program is paused, everything written in the input debugging console will be sent to the debugger. So be careful not to break the debugger. For example 'eval a=100' will change the value of variable and this won't be caught by extension.

[[Category: VMS IDE]]

File:Jvm-dbg-configure-or-fix.png

2019-08-28T06:29:04Z

Sergey.vorfolomeev:

dbg-configure-or-fix

File:Jvm-dbg-select-main.png

2019-08-28T06:24:59Z

Sergey.vorfolomeev:

select-main

File:Jvm-dbg-select.png

2019-08-28T06:20:54Z

Sergey.vorfolomeev:

Jvm-dbg-select

File:Jvm-dbg-no-config-selected.png

2019-08-28T06:18:01Z

Sergey.vorfolomeev:

Jvm-dbg-no-config-selected

VMS IDE for Java (Kotlin, Scala)

2019-08-27T09:10:11Z

Sergey.vorfolomeev:

VMS IDE for Java (Kotlin, Scala)

2019-08-23T09:27:59Z

Sergey.vorfolomeev: /* Debugging */

VMS IDE for Java (Kotlin, Scala)

2019-08-23T09:25:06Z

Sergey.vorfolomeev: /* Steps to run java project */

VMS IDE for Java (Kotlin, Scala)

2019-08-22T04:41:16Z

Sergey.vorfolomeev:

== Steps to run java project ==

# Change project settings: '''project type''' (java, scala or kotlin), '''project name''', '''root folder''', '''source''', '''headers''', '''resource''' and '''listing''' masks
# Write code
# Create MMS
# Upload
# Build
# Collect Java classes
# Run

'''Note: coming soon'''
[[Category: VMS IDE]]

VMS IDE Commands

2019-08-22T04:34:12Z

Sergey.vorfolomeev: /* Commands */

To invoke the commands, press <code>F1</code> in the Visual Studio Code editor and start typing the command.
[[File:Vms-ide-commands.png|800px|thumb|none|VMS IDE Commands]]

=Commands=
* <code>'''VMS-IDE: Edit VMS project settings'''</code> - Edit project settings. [[Project Settings]]
* <code>'''VMS-IDE: Build on VMS'''</code> - Build project on VMS with its dependencies.
* <code>'''VMS-IDE: Build only this project'''</code> - Build only the selected project on VMS (Ctrl+Alt+F7).
* <code>'''VMS-IDE: Change CR/LF for all source files'''</code> - Change CRLF to LF for all source files.
* <code>'''VMS-IDE: Clean project'''</code> - Clean project, delete files from output folder.
* <code>'''VMS-IDE: Create MMS'''</code> - Create default MMS. [[Auto-generating MMS]]
* <code>'''VMS-IDE: Download system headers'''</code> - Download system headers from VMS.
* <code>'''VMS-IDE: Edit ssh-helper settings'''</code> - Edit connection settings. [[SSH Settings]]
* <code>'''VMS-IDE: Force built status'''</code> - Force built status.
* <code>'''VMS-IDE: Force synchronized status'''</code> - Force synchronized status.
* <code>'''VMS-IDE: Quick uploading'''</code> - Upload the changes made to the source code on the the local machine since the last upload/synchronization to the remote machine.
* <code>'''VMS-IDE: Re-build on VMS'''</code> - Re-build project on VMS with its dependencies.
* <code>'''VMS-IDE: Re-build only this project'''</code> - Re-build only the selected project on VMS.
* <code>'''VMS-IDE: Synchronize project file with VMS'''</code> - Synchronize project files with VMS.
* <code>'''VMS-IDE: Terminal'''</code> - OpenVMS terminal (<code>Ctrl+F6</code>)
* <code>'''VMS-IDE: Upload all'''</code> - Upload all new and updated files from local machine to VMS. '''NOTE''': If '''preferZip''' is set to true, the ''whole'' project will be uploaded as a ZIP file.
* <code>'''VMS-IDE: Upload all via Zip'''</code> - Upload project files using Zip

[[Category:VMS IDE]]

SSH Settings

2019-08-22T04:27:33Z

Sergey.vorfolomeev: /* Connection */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running, and debugging projects. 
Depending on the type of configuration, SSH connection settings can be edited either in the '''vmssoftware.ssh-helper-settings.json''' file located in ''/.vscode'' directory or via '''Visual Studio Code''' settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The '''connection''' section sets the current connection details.
* <code>'''host'''</code> - IP-address or name of an OpenVMS machine or the label of a predefined connection from the '''host collection''' section
case, all other fields are ignored.
* <code>'''port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''username'''</code> - User account that will be used for the SSH connection.
* <code>'''password'''</code> - User password that will be used for the SSH connection. If it is omitted a password input box will be shown on connection attempt.
* <code>'''keyFile'''</code> - Path to SSH private key file. For details on how to configure connection using SSH key, see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.

Required fields are:
* <code>'''host'''</code>
* <code>'''username'''</code>

You may use either password or key file to establish connection:
* <code>'''keyFile'''</code>
* <code>'''password'''</code>

If '''keyFile''' is not set, '''password''' is used. If neither '''password''' nor '''keyFile''' is specified, you will be prompted to enter your password during the connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to create a list of required connections to be able to quickly connect to any of them.
You can do this by adding all the required connections to the '''Host Collection''' list.

=== Adding a new host to collection ===
To add a new host to the collection:
<ol>
<li>Copy the ssh connection template to '''host-collection.hosts''' array:</li>
<pre>"host-collection": {
"hosts": [
{
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
}
]
}</pre>
<li>Specify connection parameters</li>
<li>Make sure that '''label''' parameter is set.</li>
</ol>

===Selecting which connection to use===
To use one of connections from the '''host collection''' section, copy the value of ''label'' and paste it in angle brackets ('''<label>''') to the '''host''' field in the '''connection''' section.

=== Example ===
<pre>
{
"connection": {
"host": "<MySSHConnection>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "10.10.6.1",
"keyFile": "",
"password": "myPassword",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "MySSHConnection"
}
]
}
}
</pre>

'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

=Timeouts=
You can define SSH connection timeouts in this section.
* <code>'''cmdTimeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''feedbackTimeout'''</code> - If the SSH connection does not send feedback for the specified interval, the password will be considered as invalid.
* <code>'''welcomeTimeout'''</code> - If the SSH shell prompt is not received within this interval, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

===Example===
<pre>
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
}
</pre>

=Terminal=
Specifies command to start the shell in the VS Code integrated terminal.
* <code>'''Command'''</code> - command to start the shell.

'''NOTE:''' It is possible to use variables in the command. The syntax is: <code>${variable}</code> or <code>${varable?<text if variable isn't empty>}</code>. Supported variables: '''host''', '''port''', '''username''', '''password''', and '''keyFile'''.
'''NOTE:''' password may come from settings or UI prompt that is shown if the password is not specified in settings. Passwords entered in the terminal are not saved.

===Example===
<pre>
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
</pre>

[[Category:VMS IDE]]

VMS IDE for Java (Kotlin, Scala)

2019-08-21T12:13:20Z

Sergey.vorfolomeev: Created page with " * Change project type: java, scala or kotlin * Change project name, root folder * Change source, headers, resource and listing mask * Write code * Create MMS * Upload * Build..."

* Change project type: java, scala or kotlin
* Change project name, root folder
* Change source, headers, resource and listing mask
* Write code
* Create MMS
* Upload
* Build
* Collect Java classes
* Run

[[Category: VMS IDE]]

SSH Settings

2019-08-21T11:30:07Z

Sergey.vorfolomeev: /* Terminal */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the ''vmssoftware.ssh-helper-settings.json'' file located in ''/.vscode'' directory or via Visual Studio Code settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The connection section sets the current connection details.
* <code>'''Host'''</code> - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets <code>(<hostname>)</code>. In that
case, all other fields are ignored.
* <code>'''Port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''Username'''</code> - User account that will be used for the SSH connection.
* <code>'''Password'''</code> - User password that will be used for the SSH connection.. If it is omitted a password input box will be shown on connection attempt.
* <code>'''Key File'''</code> - Path to SSH private key file. How to configure connection using SSH key see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.

Required fields to connect:
# <code>'''Host'''</code>
# <code>'''Username'''</code>

To provide security user may use one of two ways:
# <code>'''Key File'''</code>
# <code>'''Password'''</code>

If '''Key File''' is empty, '''Password''' will be used. If '''Password''' is empty too a password input box will be shown on connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the '''host''' name in the '''connection''' section.
'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

To add new host into collection do the following:
* Copy whole content of {...} from '''connection''' into '''host-collection'''->'''hosts'''
* Add field '''label'''
* Adjust fields for this new host in collection
* Write <''label''> into '''host''' field in '''connection''' to use this new host as default

For example:
<pre>
{
"connection": {
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "1.1.1.1",
"keyFile": "",
"password": "pass",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "First"
}
]
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Timeouts=
Specifies SSH connection timesouts.
* <code>'''Cmd Timeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''Feedback Timeout'''</code> - If the SSH connection does not send feedback for this period, the specified password will be considered as invalid.
* <code>'''Welcome Timeout'''</code> - If the SSH shell prompt is not received within this period of time, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

=Terminal=

Specifies command to start SSH shell in VS Code integrated terminal.
* <code>'''Command'''</code> - command to start SSH shell. It is possible to insert variables into command. The syntax is: ${variable} or ${varable?<text if variable isn't empty>}. Where variable can be following: '''host''', '''port''', '''username''', '''password''' and '''keyFile'''.

'''NOTE''': password may come from settings or if user entered it in UI prompt. Passwords entered in terminal aren't saved.

[[Category:VMS IDE]]

Build Configurations

2019-08-08T04:06:44Z

Sergey.vorfolomeev:

== Named build configurations ==

The build process depends on this configuration. Each label describes one way of building.

<pre>
"builds": {
"configurations": [
{
"label": "DEBUG",
"description": "DEBUG",
"command": "",
"parameter": "DEBUG"
},
{
"label": "RELEASE",
"description": "RELEASE",
"command": "",
"parameter": "RELEASE"
},
{
"label": "myOwnRelease",
"description": "My own build release",
"command": "executable.mms",
"parameter": ""
},
{
"label": "myOwnDebug",
"description": "My own build debug",
"command": "build.com",
"parameter": "DEBUG"
}
]
}
</pre>

* '''label''' - unique label, name of build configuration. Also this value is used as output folder.
* '''description''' - description
* '''command''' - command to build, clean project
* '''parameter''' - parameter to pass into command

In case of command is empty the default auto-created MMS file is used to build project. Parameter is used to distinguish DEBUG and RELEASE. 

If the user defined command is MMS file, it is processed via command "MMS/EXTENDED_SYNTAX/DESCR=<MMS file> '''parameter'''", so the parameter is treated as a target. 

If the user defined command is COM file, it is executed like "@<COM file> '''parameter'''". 

'''Note:''' it is recommended that user-defined build procedure creates resulting files in '''<project root>/<output folder>/<build label>''' directory. So does default procedure.

In the '''CLEAN''' operation '''parameter''' will be just "CLEAN" string. 

Editing of '''builds''' is the same as editing of '''project settings'''. 

To change current build configuration click "Change" on the '''buildName:''' line. 

To debug a project, there must be a build configuration named '''DEBUG'''. 

Changes in '''task2cmd''': parameter for any build and clean command must be named build configuration label. 

[[Category:VMS IDE]]

VMS IDE Developing

2019-08-08T04:02:46Z

Sergey.vorfolomeev: /* Building */

==Loading Existing Project==
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.

==Managing Project Source Files==
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.

The OpenVMS project structure may look like shown below:
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]

==Managing the Project==
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.

===Managing Dependencies===
If you work on a complex project and you need to add dependencies, use the '''PROJET DEPENDENCIES''' section. 
Assuming that you want to add "Project B" to "Project A" dependencies, 
# Select "Project A" in the '''PROJET DEPENDENCIES''' panel.
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.
 
To remove a project from dependencies
# Open the '''PROJET DEPENDENCIES''' section.
# Right-click the project, then select ''Remove from dependencies''.

=Building=

To figure out the way of building see [[Build Configurations]].

===Build MMS===
Before building the project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>. [[Auto-generating MMS]]

===Building VMS Project===
To build a project in VMS IDE:
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.
# Select the project you want to build in the '''PROJECT DEPENDENCIES''' section.
# In the '''PROJECT DESCRIPTION''' section, choose the required build configuration by right-clicking the '''buildName''' parameter and selecting '''Change'''.
# Right-click the project and select ''Build with dependencies'' from the context menu.

If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.

'''NOTE''': you can manually upload all new and updated files by using the [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.

===Building with Custom Procedure===
To build a project using a custom build procedure, edit the ''task.json'' file
<pre>{
"type": "task2cmd",
"command": "vmssoftware.synchronizer.buildProject",
"extension": "vmssoftware.synchronizer",
"parameter": "myDebug",
"label": "Build Procedure",
"problemMatcher": []
}</pre>
where:
* '''parameter''' is the name of predefined build configuration.
* '''label''' meaningful task name
All other parameters must be as shown in example.

'''NOTE''': see Visual Studio Code [https://code.visualstudio.com/docs/editor/tasks documentation] for more information on '''tasks'''.

=Debugging=
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.

'''NOTE''': Before running the debugger, make sure that you have actual DEBUG builds on the OpenVMS system.

To start a debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.
<pre>"configurations": [
{
"type": "vms_dbg",
"request": "launch",
"name": "Debug",
"program": "",
"arguments": "",
"stopOnEntry": true,
"typeRun": "DEBUG"
}
]
</pre>
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>.
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.

To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.
Press <code>F5</code> again to run debugger.

[[Category:VMS IDE]]

VMS IDE Developing

2019-08-08T04:00:34Z

Sergey.vorfolomeev: /* Build MMS */

==Loading Existing Project==
If you start working on an existing project that resides on your OpenVMS machine, you need to download the source files to your local machine. Use the '''Synchronizer''' tool as described below to download the source files.
# Change the [[Synchronize Configuration#Settings Description|'''downloadNewFiles''']] option to ''overwrite''.
# Run the <code>VMS-IDE: Synchronize project files with VMS</code> command.
# After all project files are downloaded, change the '''downloadNewFiles''' option to ''skip'' or ''edit'' to prevent silent overwriting of local files.

==Managing Project Source Files==
You can view and edit all project files from the Visual Studio Code '''Explorer'''. Refer to Visual Studio Code [https://code.visualstudio.com/docs/getstarted/userinterface documentation] to learn more about '''Explorer''' view features.

The OpenVMS project structure may look like shown below:
[[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]

==Managing the Project==
You can manage your OpenVMS project from the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view. To open the view, click ''Project Explorer'' icon on the Activity Bar.

===Managing Dependencies===
If you work on a complex project and you need to add dependencies, use the '''PROJET DEPENDENCIES''' section. 
Assuming that you want to add "Project B" to "Project A" dependencies, 
# Select "Project A" in the '''PROJET DEPENDENCIES''' panel.
# Right-click "Project B", and select ''Add to dependencies of selected'' item from the context menu.
 
To remove a project from dependencies
# Open the '''PROJET DEPENDENCIES''' section.
# Right-click the project, then select ''Remove from dependencies''.

=Building=

===Build MMS===
Before building the project, create the '''MMS''' file by pressing <code>F1</code> and running <code>VMS-IDE: Create MMS</code>. [[Auto-generating MMS]]

===Building VMS Project===
To build a project in VMS IDE:
# Open the [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.
# Select the project you want to build in the '''PROJECT DEPENDENCIES''' section.
# In the '''PROJECT DESCRIPTION''' section, choose the required build configuration by right-clicking the '''buildName''' parameter and selecting '''Change'''.
# Right-click the project and select ''Build with dependencies'' from the context menu.

If there are any changes to the project, the updated files will be uploaded to the OpenVMS system. Previously created object and listing files (.OBJ, .LIS) will be removed from the OpenVMS system. This guarantees that up-to-date files are uploaded to the OpenVMS system.

'''NOTE''': you can manually upload all new and updated files by using the [[VMS_IDE_Commands|'''VMS-IDE: Upload all''']] command.

===Building with Custom Procedure===
To build a project using a custom build procedure, edit the ''task.json'' file
<pre>{
"type": "task2cmd",
"command": "vmssoftware.synchronizer.buildProject",
"extension": "vmssoftware.synchronizer",
"parameter": "myDebug",
"label": "Build Procedure",
"problemMatcher": []
}</pre>
where:
* '''parameter''' is the name of predefined build configuration.
* '''label''' meaningful task name
All other parameters must be as shown in example.

'''NOTE''': see Visual Studio Code [https://code.visualstudio.com/docs/editor/tasks documentation] for more information on '''tasks'''.

=Debugging=
Use [[VMS_IDE_Debugger|'''Debugger''']] view to debug OpenVMS projects.

'''NOTE''': Before running the debugger, make sure that you have actual DEBUG builds on the OpenVMS system.

To start a debugging session, press <code>F5</code>. If there is no "launch.json" file in the project directory, you will be asked to select the environment. Select <code>VMS Debugger</code> from the popup list.
The '''launch.json''' file will be created and filled with the required information. There are two types of launch configuration - '''DEBUG''' and '''RUN'''.
<pre>"configurations": [
{
"type": "vms_dbg",
"request": "launch",
"name": "Debug",
"program": "",
"arguments": "",
"stopOnEntry": true,
"typeRun": "DEBUG"
}
]
</pre>
For the '''program''' field, specify the relative path to the executable, for example <code>[.project.bin.release]hello.exe</code>.
If the field is empty, '''VMS IDE''' will try to fill it with data from the project settings.

To choose which configuration to use, go to "Debug" (<code>Ctrl-Shift-D</code>) and select the appropriate configuration from the drop-down list.
Press <code>F5</code> again to run debugger.

[[Category:VMS IDE]]

VMS IDE Commands

2019-08-08T03:58:21Z

Sergey.vorfolomeev: /* Commands */

To invoke the commands, press <code>F1</code> in the Visual Studio Code editor and start typing the command.
[[File:Vms-ide-commands.png|800px|thumb|none|VMS IDE Commands]]

=Commands=
* <code>'''VMS-IDE: Terminal'''</code> - OpenVMS terminal (<code>Ctrl+F6</code>)
* <code>'''VMS-IDE: Edit ssh-helper settings'''</code> - Edit connection settings. [[SSH Settings]]
* <code>'''VMS-IDE: Edit OpenVMS project settings'''</code> - Edit project settings. [[Project Settings]]
* <code>'''VMS-IDE: Change CR/LF for all source files'''</code> - Change CRLF to LF for all source files
* <code>'''VMS-IDE: Create MMS'''</code> - Create default MMS. [[Auto-generating MMS]]
* <code>'''VMS-IDE: Build on VMS'''</code> - Build project on VMS with its dependencies
* <code>'''VMS-IDE: Re-build on VMS'''</code> - Rebuild project on VMS with its dependencies
* <code>'''VMS-IDE: Build only this project'''</code> - Build only the selected project on VMS (Ctrl+Alt+F7)
* <code>'''VMS-IDE: Re-build only this project'''</code> - Rebuild only the selected project on VMS
* <code>'''VMS-IDE: Clean project'''</code> - Clean project, delete files from output folder
* <code>'''VMS-IDE: Upload all'''</code> - Upload all new and updated files from local machine to VMS. '''NOTE''': If '''preferZip''' is set to true, the ''whole'' project will be uploaded as a ZIP file.
* <code>'''VMS-IDE: Synchronize project file with VMS'''</code> - Synchronize project files with VMS
* <code>'''VMS-IDE: Force synchronized status'''</code> - Force synchronized status
* <code>'''VMS-IDE: Force built status'''</code> - Force built status
* <code>'''VMS-IDE: Upload all via Zip'''</code> - Upload project files using Zip
* <code>'''VMS-IDE: Download system headers'''</code> - Download system headers from VMS
* <code>'''VMS-IDE: Quick uploading'''</code> - Perform changes on the remote machine made on the local machine since the extension started or last uploading/synchronization.

[[Category:VMS IDE]]

Auto-generated MMS

2019-08-08T03:56:17Z

Sergey.vorfolomeev: Created page with " The order of default MMS creation: # Collect header files list # Collect source files list # Put header files list as '''INCLUDES''' into default MMS content # Put source fil..."

The order of default MMS creation:
# Collect header files list
# Collect source files list
# Put header files list as '''INCLUDES''' into default MMS content
# Put source files list as '''SOURCES''' into default MMS content
# Define main target depending on type of project
# Define object dependencies

'''Note''': For some languages the order of compilation is important. To do this just reorder object files in main target definition.

Variables '''DEBUG''', '''OUTDIR''' and '''CONFIG''' will be defined by extension at the moment of compilation.

==Example==
<pre>
! header !auto
! Do not modify this file. It may be overwritten automatically. !auto
! includes !auto
INCLUDES= !auto
! sources !auto
SOURCES= - !auto
myprog.cob !auto
! dependencies !auto
.FIRST !auto
!auto
! compiler/linker options !auto
.IF DEBUG !auto
COMPILEFLAGS = /DEBUG/NOOP/LIST=$(MMS$TARGET_NAME)/OBJECT=$(MMS$TARGET) !auto
LINKFLAGS = /DEBUG/MAP=$(MMS$TARGET_NAME)/EXECUTABLE=$(MMS$TARGET) !auto
.ELSE !auto
COMPILEFLAGS = /OBJECT=$(MMS$TARGET) !auto
LINKFLAGS = /EXECUTABLE=$(MMS$TARGET) !auto
.ENDIF !auto
! directives !auto
.SILENT !auto
OUT_DIR = .$(OUTDIR).$(CONFIG) !auto
OBJ_DIR = $(OUT_DIR).obj !auto
.SUFFIXES !auto
.SUFFIXES .OBJ .CPP .C .CLD .MSG .BLI .COB .PAS .BAS .F77 .F90 .FOR .B32 .CBL !auto
.CPP.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
$(CXX) $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.C.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
$(CC) $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.CLD.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
SET COMMAND/OBJECT=$(MMS$TARGET) $(MMS$SOURCE) !auto
!auto
.MSG.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
MESSAGE /OBJECT=$(MMS$TARGET) $(MMS$SOURCE) !auto
!auto
.BLI.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
BLISS $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.B32.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
BLISS $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.COB.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
COBOL $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.CBL.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
COBOL $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.PAS.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
PASCAL $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.BAS.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
BASIC $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.F77.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
FORTRAN $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.F90.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
FORTRAN $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.FOR.OBJ !auto
pipe create/dir $(DIR $(MMS$TARGET)) | copy SYS$INPUT nl: !auto
FORTRAN $(COMPILEFLAGS) $(MMS$SOURCE) !auto
!auto
.DEFAULT !auto
! Source $(MMS$TARGET) not yet added !auto
!auto
! main target !auto
[$(OUT_DIR)]$(NAME).EXE : - !auto
[$(OBJ_DIR)]myprog.obj !auto
CXXLINK $(LINKFLAGS) $(MMS$SOURCE_LIST) !auto
!auto
! objects !auto
[$(OBJ_DIR)]myprog.obj : myprog.cob $(INCLUDES) !auto

</pre>

[[Category: VMS IDE]]

VMS IDE Project Configuration

2019-08-07T10:59:05Z

Sergey.vorfolomeev: /* Settings description */

=Workspace=
When starting working on an OpenVMS project in the '''VMS IDE''', you need to configure your workspace, set project folders, and select the type of configuration that will be used.

==Project folder==
Use '''Explorer''' view to manage source code, resources, and settings files for your projects.
{| style="border-style: none;"
|-
|rowspan="2"| [[File:Vms ide explorer.png|200px|thumb|none|VMS IDE Explorer]]
|style="vertical-align:top; padding-left: 20px;" | The project folder will store project settings and source files. To add a project folder
# Create a folder on your local machine.
# In Visual Studio Code, click the ''Explorer'' icon (<code>Ctrl+Shift+E</code>) in the Activity Bar
# Click ''Open Folder'' and select the previously created folder.
 
If you are working on a complex project with dependencies, you will likely need to add other projects to the current workspace. 
For this, just add another project folder as shown below.
# Create another folder that will store files of the second project
# In Visual Studio Code, select ''File > Add folder to workspace'' and select the folder you created.
|}

==End of line==
Specify the End of Line character that will be used across all source files. '''You must use <code>LF</code>'''.
# Open Visual Studio Code settings (<code>Ctrl+,</code>)
# Navigate to ''Text Editor > Files > Eol'' (the default end of line character) and set it to ''\n''.

==Type of configuration==
Select the type of configuration for your project. The recommended type is '''FS'''.
# Open Visual Studio Code settings (<code>Ctrl+,</code>)
# Navigate to ''Extensions > VMS-IDE > Config-helper › Settings: Using'', and select one of the options:
#* '''FS''' - save settings in local JSON files.
#* '''VFS''' - save setting in VS Code virtual file system.
#* '''VCS''' - manage settings using VS Code provided API.
# Press <code>F1</code> and run the ''Reload window'' command or close Visual Studio Code and open it again.

{| style="border-style: none;"
! FS and VFS
! VCS
|-
|style="padding-right: 20px;" | [[File:Syncronizer-settings-fs.png|600px|none|thumb|]]
|style="padding-left: 20px;" | [[File:Syncronizer-settings-vsc.png|600px|thumb|none|]]
|-
|style="padding-right: 20px; text-align: center" | Settings are stored in a JSON file that can be easily modified in the editor.
|style="padding-left: 20px; text-align: center" | Settings can be adjusted using Visual Studio Code settings page.
|}

'''NOTE''': Changing the type of configuration does not copy existing settings from one location to another.

=SSH Configuration=
The SSH connection to an OpenVMS machine is required for syncing source files, building, and debugging projects. There are two ways of managing SSH connection settings.

; Command : Press <code>F1</code> and run the <code>VMS-IDE: Edit ssh-helper settings</code> command.

; Project Explorer :
:# Open [[VMS_IDE_Project_Explorer|'''Project Explorer''']]
:# Select your project from the list
:# In the ''PROJECT DESCRIPTION'' section, right-click ''SSH > host'' and select ''Edit''.

==SSH Settings description==
See [[SSH_Settings|''SSH settings'']] for more details.

=Project Configuration=
To open the project settings, press <code>F1</code> and run the <code>VMS-IDE: Edit OpenVMS project settings</code> command or use [[VMS_IDE_Project_Explorer|'''Project Explorer''']] view.

==Adjusting Settings==
The project configuration procedure varies depending on the selected type of configuration.

; FS or VFS : The Edit command loads current settings from memory and saves them to '''vmssoftware.synchronizer-settings.json''', then opens the file for editing.
; VCS : The Edit command opens Workspace settings. Navigate to '''Synchronizer''' section and adjust the settings.

==Settings description==
The settings are split into three sections:
* [[Project_Settings|''Project'']] - general project settings
* [[Synchronize_Configuration|''Synchronize'']] - synchronizer specific settings
* [[Build_Configurations|''Builds'']] - settings for build project

[[Category:VMS IDE]]

Synchronize Configuration

2019-08-07T10:58:37Z

Sergey.vorfolomeev:

=Synchronize Configuration Example=
<pre>
{
"synchronize": {
"downloadNewFiles": "edit",
"keepAlive": false,
"preferZip": false,
"forceLocalTime": true,
"purge": false,
"setTimeAttempts": 3,
"setTimeByShell": true,
"unzipCmd": ""
}
}
</pre>

=Settings Description=
* <code>'''downloadNewFiles'''</code> - Strategy for downloading remote files which are newer than local copies.
** '''overwrite''' - remote files will overwrite local files.
** '''skip''' - remote files will not be downloaded but an appropriate warning message will be shown.
** '''edit''' - remote files will be downloaded into memory and the edit-merge window will be opened to allow the user decide what changes to save.
* <code>'''keepAlive'''</code> - Shell and SFTP connections will not be closed after synchronization is done and will be reused for the next synchronization.
* <code>'''preferZip'''</code> - Prefer ZIP for uploading source files.
* <code>'''forceLocalTime'''</code> - Set local time instead of UTC for archived files. Used when synchronizing via ZIP.
* <code>'''purge'''</code> - Execute <code>PURGE</code> command after uploading source.
* <code>'''setTimeAttempts'''</code> - The maximum number of attempts to set file time. '''NOTE''': the first attempt to set file time may be rejected because the file is busy. VMS IDE will re-try to set time again.
* <code>'''setTimeByShell'''</code> - If the SFTP server on the OpenVMS host did not set the file time, VMS IDE can use DCL commands to do this.
* <code>'''unzipCmd'''</code> - Is used to run a user-defined command to unzip archive on the remote side; default is <code>unzip -oo "-D"</code> and file name added at the end of the command.

If you have full project on OpenVMS and want to download it to PC, set <code>'''downloadNewFiles'''</code> to '''overwrite'''. 
If you have full project on PC and use OpenVMS only for compiling and debugging, set <code>'''downloadNewFiles'''</code> to '''skip'''. 
If project on OpenVMS may be changed outside and may be more recent, set <code>'''downloadNewFiles'''</code> to '''edit'''. 

[[Category:VMS IDE]]

SSH Settings

2019-08-07T10:51:38Z

Sergey.vorfolomeev: /* Terminal */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the ''vmssoftware.ssh-helper-settings.json'' file located in ''/.vscode'' directory or via Visual Studio Code settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The connection section sets the current connection details.
* <code>'''Host'''</code> - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets <code>(<hostname>)</code>. In that
case, all other fields are ignored.
* <code>'''Port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''Username'''</code> - User account that will be used for the SSH connection.
* <code>'''Password'''</code> - User password that will be used for the SSH connection.. If it is omitted a password input box will be shown on connection attempt.
* <code>'''Key File'''</code> - Path to SSH private key file. How to configure connection using SSH key see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.

Required fields to connect:
# <code>'''Host'''</code>
# <code>'''Username'''</code>

To provide security user may use one of two ways:
# <code>'''Key File'''</code>
# <code>'''Password'''</code>

If '''Key File''' is empty, '''Password''' will be used. If '''Password''' is empty too a password input box will be shown on connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the '''host''' name in the '''connection''' section.
'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

To add new host into collection do the following:
* Copy whole content of {...} from '''connection''' into '''host-collection'''->'''hosts'''
* Add field '''label'''
* Adjust fields for this new host in collection
* Write <''label''> into '''host''' field in '''connection''' to use this new host as default

For example:
<pre>
{
"connection": {
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "1.1.1.1",
"keyFile": "",
"password": "pass",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "First"
}
]
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Timeouts=
Specifies SSH connection timesouts.
* <code>'''Cmd Timeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''Feedback Timeout'''</code> - If the SSH connection does not send feedback for this period, the specified password will be considered as invalid.
* <code>'''Welcome Timeout'''</code> - If the SSH shell prompt is not received within this period of time, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

=Terminal=

Specifies command to start SSH terminal.
* <code>'''Command'''</code> - command to start SSH terminal. It is possible to insert variables into command. The syntax is: ${variable} or ${varable?<text if variable isn't empty>}. Where variable can be following: '''host''', '''port''', '''username''', '''password''' and '''keyFile'''.

'''NOTE''': password may come from settings or if user entered it in UI prompt. Passwords entered in SSH terminal aren't saved.

[[Category:VMS IDE]]

Build Configurations

2019-08-07T10:50:52Z

Sergey.vorfolomeev:

== Named build configurations ==

"builds": {
"configurations": [
{
"label": "DEBUG",
"description": "DEBUG",
"command": "",
"parameter": "DEBUG"
},
{
"label": "RELEASE",
"description": "RELEASE",
"command": "",
"parameter": "RELEASE"
},
{
"label": "myOwnRelease",
"description": "My own build release",
"command": "executable.mms",
"parameter": ""
},
{
"label": "myOwnDebug",
"description": "My own build debug",
"command": "build.com",
"parameter": "DEBUG"
}
]
}

* '''label''' - unique label, name of build configuration. Also this value is used as output folder.
* '''description''' - description
* '''command''' - command to build, clean project
* '''parameter''' - parameter to pass into command

In case of command is empty the default auto-created MMS file is used to build project. Parameter is used to distinguish DEBUG and RELEASE. 

If the user defined command is MMS file, it is processed via command "MMS/EXTENDED_SYNTAX/DESCR=<MMS file> '''parameter'''", so the parameter is treated as a target. 

If the user defined command is COM file, it is executed like "@<COM file> '''parameter'''". 

'''Note:''' it is recommended that user-defined build procedure creates resulting files in <project root>/<output folder>/<build label> directory. So does default procedure.

In the '''CLEAN''' operation '''parameter''' will be just "CLEAN" string. 

Editing of '''builds''' is the same as editing of '''project settings'''. 

To change current build configuration click "Change" on the '''buildName:''' line. 

To debug a project, there must be a build configuration named '''DEBUG'''. 

Changes in '''task2cmd''': parameter for any build and clean command must be named build configuration label. 

[[Category:VMS IDE]]

Project Settings

2019-08-07T10:49:53Z

Sergey.vorfolomeev:

=Project Configuration Example=
<pre>
{
"project": {
"break": "C",
"builders": "*.{mms,com}",
"exclude": "**/{node_modules,.vscode}/**",
"headers": "*.h",
"listing": "*.lis",
"outdir": "out",
"projectName": "project",
"projectType": "executable",
"resource": "**/resource/**",
"root": "project",
"source": "*.{cpp,c}",
"addLibraries": "sys$library:IMAGELIB.OLB,sys$library:RDBMSGS.OLB",
"addIncludes": "sys$library"
}
}
</pre>

=Settings Description=
* <code>'''Break'''</code> - Keyboard key to pause debugging in VMS IDE debugger. The extension uses combination <code>CTRL+Key</code> to pause debugging when user press '''Pause''' or <code>F6</code>.
* <code>'''Builders'''</code> - Mask for files used for building the project. Default is "*.{mms,com}".
* <code>'''Exclude'''</code> - Folders excluded from synchronization with OpenVMS system.
* <code>'''Headers'''</code> - Header files. Default is "*.{h,hpp}".
* <code>'''Listing'''</code> - Listing files that will be downloaded after the project is built for debugging purpose.
* <code>'''Outdir'''</code> - Output directory where object, listing and executable files will be stored when built. Is also used for temporary files. '''NOTE''': Should be only the name of the folder, not a full or relative path.
* <code>'''Project Name'''</code> - Name for the executable file, auto-generated '''MMS''' file for builder, OPT file for linker, and COM file for defining logical names. '''NOTE''': Should be only one word.
* <code>'''Project Type'''</code> - Type of the project. Available types: '''executable''', '''library''' or '''shareable'''. The building method depends on the type of the project and its dependencies.
* <code>'''Resource'''</code> - Files required for the project, but are not involved in the build process.
* <code>'''Root'''</code> - Directory of the project on remote OpenVMS machine in UNIX format relative the home folder.
* <code>'''Source'''</code> - Mask for the source files, e.g. "*.{c,cpp}".
* <code>'''Additional libraries'''</code> - list of libraries in ODS-5 format, separated by commas.
* <code>'''Additional include folders'''</code> - list of folders in ODS-5 format, separated by commas.

==Adjusting setting==
# Change <code>'''Root'''</code> field. For example, if project is (or should be) in '''WORK:[USER.DEMOS.SIMPLE]''' and home directory is '''WORK:[USER]''', write '''demos/simple'''.
# Select appropriate <code>'''Project Type'''</code>
# Adjust <code>'''Project Name'''</code>.
# Check <code>'''Builders'''</code>. These files will be synchronized.
# Check <code>'''Headers'''</code>. These files will be synchronized and included into auto-generated MMS file as header files. The changing of one of them will result full rebuild of project.
# Check <code>'''Source'''</code>. These files will be synchronized and included into auto-generated MMS file as source files.
# Check <code>'''Resource'''</code>. These files will be synchronized but not included into auto-generated MMS file.
# Adjust <code>'''Exclude'''</code>. If you have some files similar to described above which are not need to be synchronized and compiled.
# Check <code>'''Listing'''</code>. These files will be downloaded after building. Files "*.lis,*.map" are required for debugger.
# If project depends on already installed in OpenVMS libraries, adjust <code>'''Additional libraries'''</code> and <code>'''Additional include folders'''</code>

[[Category:VMS IDE]]

SSH Settings

2019-08-07T10:14:39Z

Sergey.vorfolomeev:

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the ''vmssoftware.ssh-helper-settings.json'' file located in ''/.vscode'' directory or via Visual Studio Code settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The connection section sets the current connection details.
* <code>'''Host'''</code> - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets <code>(<hostname>)</code>. In that
case, all other fields are ignored.
* <code>'''Port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''Username'''</code> - User account that will be used for the SSH connection.
* <code>'''Password'''</code> - User password that will be used for the SSH connection.. If it is omitted a password input box will be shown on connection attempt.
* <code>'''Key File'''</code> - Path to SSH private key file. How to configure connection using SSH key see [https://raymii.org/s/blog/SSH_public_key_authentication_on_OpenVMS.html SSH public key authentication on OpenVMS]
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.

Required fields to connect:
# <code>'''Host'''</code>
# <code>'''Username'''</code>

To provide security user may use one of two ways:
# <code>'''Key File'''</code>
# <code>'''Password'''</code>

If '''Key File''' is empty, '''Password''' will be used. If '''Password''' is empty too a password input box will be shown on connection attempt.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the '''host''' name in the '''connection''' section.
'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

To add new host into collection do the following:
* Copy whole content of {...} from '''connection''' into '''host-collection'''->'''hosts'''
* Add field '''label'''
* Adjust fields for this new host in collection
* Write <''label''> into '''host''' field in '''connection''' to use this new host as default

For example:
<pre>
{
"connection": {
"host": "<First>",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false
},
"host-collection": {
"hosts": [
{
"host": "1.1.1.1",
"keyFile": "",
"password": "pass",
"port": 22,
"username": "user",
"skipSignatureVerification": true,
"label": "First"
}
]
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Timeouts=
Specifies SSH connection timesouts.
* <code>'''Cmd Timeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''Feedback Timeout'''</code> - If the SSH connection does not send feedback for this period, the specified password will be considered as invalid.
* <code>'''Welcome Timeout'''</code> - If the SSH shell prompt is not received within this period of time, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

=Terminal=
'''New in version 0.0.22'''
Specifies command to start SSH terminal.
* <code>'''Command'''</code> - command to start SSH terminal. It is possible to insert variables into command. The syntax is: ${variable} or ${varable?<text if variable isn't empty>}. Where variable can be following: '''host''', '''port''', '''username''', '''password''' and '''keyFile'''.

'''NOTE''': password may come from settings or if user entered it in UI prompt. Passwords entered in SSH terminal aren't saved.

[[Category:VMS IDE]]

SSH Settings

2019-08-07T09:50:01Z

Sergey.vorfolomeev: /* Host Collection */

An SSH connection to an OpenVMS machine is required for syncing source code files, building, running and debugging projects. Depending on the type of configuration, SSH connection settings can be edited either in the ''vmssoftware.ssh-helper-settings.json'' file located in ''/.vscode'' directory or via Visual Studio Code settings page.

=SSH Settings Template=
<pre>
{
"connection": {
"host": "",
"keyFile": "",
"password": "",
"port": 22,
"username": "",
"skipSignatureVerification": false,
},
"host-collection": {
"hosts": []
},
"timeouts": {
"cmdTimeout": 0,
"feedbackTimeout": 0,
"welcomeTimeout": 0
},
"terminal": {
"command": "ssh -oHostKeyAlgorithms=+ssh-dss ${keyFile?-i ${keyFile}} ${username?${username}@}${host}"
}
}
</pre>

=Connection=
The connection section sets the current connection details.
* <code>'''Host'''</code> - IP-address or name of OpenVMS machine. It also can refer to the label of a connection specified in host-collection section - should be enclosed in angle brackets <code>(<hostname>)</code>. In that
case, all other fields are ignored.
* <code>'''Port'''</code> - The port number to use for the SSH connection. Default is 22.
* <code>'''Username'''</code> - User account that will be used for the SSH connection.
* <code>'''Password'''</code> - User password that will be used for the SSH connection.. If it is omitted a password input box will be shown on connection attempt.
* <code>'''Key File'''</code> - Path to SSH private key file.
* <code>'''skipSignatureVerification'''</code> - Skip signature verification. Set it to 'true' if an error 'Handshake failed: signature verification failed' occurs.

=Host Collection=
If you need to connect to different servers when working on your project, it makes sense to list all the required connections and then just pick the one that you need by using its label as the '''host''' name in the '''connection''' section.
'''NOTE''': If you use VSC type of configuration, you will not be able to specify host collection in UI. Instead, you need to click "Edit in settings.json" and specify them in the '''settings.json''' file.

[[File:Ssh collection hosts.png|Ssh collection hosts.png]]

To add host to collection do the following:
* Copy whole {...} from Host
* Add field '''label'''
* Adjust fields

Result:

=Timeouts=
Specifies SSH connection timesouts.
* <code>'''Cmd Timeout'''</code> - Timeout for command response. If a command is sent to the OpenVMS system and the OpenVMS system does not a send response for the specified period of time, it will be considered as rejected.
* <code>'''Feedback Timeout'''</code> - If the SSH connection does not send feedback for this period, the specified password will be considered as invalid.
* <code>'''Welcome Timeout'''</code> - If the SSH shell prompt is not received within this period of time, the shell will be closed.

'''NOTE''': Value "0" means, that timeout is not used.

'''WARN''': Do not change timeout settings unless necessary.

=Terminal=
'''New in version 0.0.22'''
Specifies command to start SSH terminal.
* <code>'''Command'''</code> - command to start SSH terminal. It is possible to insert variables into command. The syntax is: ${variable} or ${varable?<text if variable isn't empty>}. Where variable can be following: '''host''', '''port''', '''username''', '''password''' and '''keyFile'''.

'''NOTE''': password may come from settings or if user entered it in UI prompt. Passwords entered in SSH terminal aren't saved.

[[Category:VMS IDE]]