Project Settings

From VSI OpenVMS Wiki
Revision as of 19:13, 1 September 2019 by Andrey.logachev (talk | contribs)
Jump to: navigation, search

Project Configuration Example

    "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"

Project Settings Description

  • Break - Keyboard key to pause debugging in VMS IDE debugger. The extension uses combination CTRL+Key to pause debugging when user press Pause or F6.
  • Builders - Mask for files used for building the project. Default is "*.{mms,com}".
  • Exclude - Folders excluded from synchronization with OpenVMS system.
  • Headers - Header files. Default is "*.{h,hpp}".
  • Listing - Listing files that will be downloaded after the project is built for debugging purpose.
  • Outdir - 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.
  • Project Name - 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.
  • Project Type - Type of the project. Note: the building method depends on the type of the project and its dependencies. Available types:
    • executable, library or shareable for classic languages;
    • java, kotlin or scala for JVM based projects.
  • Resource - Files required for the project, but are not involved in the build process.
  • Root - Directory of the project on the remote OpenVMS machine in UNIX format relative to the home folder.
  • Source - Mask for the source files, e.g. "*.{c,cpp}".
  • Additional libraries - list of libraries in ODS-5 format, separated by commas.
  • Additional include folders - list of folders in ODS-5 format, separated by commas.

Adjusting Project Settings

  1. Set the Root 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.
  2. Select the Project Type that you need.
  3. Specify the Project Name. NOTE: do not use spaces or special characters.
  4. Check Builders. These files will be synchronized.
  5. Check Headers. These files will be synchronized and included into the auto-generated MMS file as header files. Changing any of them will result in full project rebuild.
  6. Check Source. These files will be synchronized and included into the auto-generated MMS file as source files.
  7. Check Resource. These files will be synchronized but not included into the auto-generated MMS file.
  8. Adjust the Exclude field value to list the files similar to the described above but not to be synchronized and compiled.
  9. Check Listing. These files will be downloaded after building the project. Files "*.lis,*.map" are required for debugger.
  10. If the project depends on already installed libraries, specify the in the Additional libraries and Additional include folders