Difference between revisions of "Project Settings"

From VSI OpenVMS Wiki
Jump to: navigation, search
Line 27: Line 27:
 
* <code>'''Listing'''</code> - Listing files that will be downloaded after the project is built for debugging purpose.
 
* <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>'''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 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'''. The building method depends on the type of the project and its dependencies.
 
* <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>'''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>'''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>'''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 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.
 
* <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]]
 
[[Category:VMS IDE]]

Revision as of 18:34, 13 August 2019

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

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. Available types: executable, library or shareable. The building method depends on the type of the project and its dependencies.
  • 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.