RPG IV to Free Format Conversion Tool

This Visual Studio Code extension helps developers convert RPG IV fixed-format statements into free-format RPG IV code effortlessly. Whether you’re working with File (F) specs, Definition (D) specs, or Embedded SQL statements, this tool streamlines the conversion to free format process by making a one-click option on your context menu. Just put the cursor on the line(s) you want to convert to free format and select "Convert RPG IV to free format" and bam! it is converted. Download from the Visual Studio CODE Marketplace: ).

For a list of changes and release notes, see the Changelog.

This extension is an RPG IV to Free Format statement converter. You select the RPG IV fixed format statements you want to convert to free format, right-click and select "Convert RPG IV to free format". It is NOT a refactoring tool or code moderization tool. Its only purpose is to get an RPG IV fixed-format statement into free format RPG IV syntax.

Features

• Convert RPG IV Fixed-Format to Free Format: Once installed, right-click on any RPG IV fixed-format statement in your editor and select the “Convert RPG IV to Free Format” option from the context menu. The statement will be converted instantly.

• Multi-Line Support for Compound Statements: If a statement spans multiple lines, such as when a File or Definition spec has additional keywords, or you have a legacy IFEQ/OREQ/ANDEQ/CASxx style conditional Calc spec, you can position the cursor on any line within the statement, and the extension converts the entire statement; no need to select the entire thing.

• Batch Conversion of Multiple Statements: You can select multiple statements within the same file and convert them all in a single operation. The tool processes them efficiently. however is it NOT recommended to select *ALL lines and convert them. I have not tested it on things like program-described arrays, conditioning indicators (these are lost during conversion) and/or other RPGII-style edge-cases.

• Supported Specifications:

  • Header (H) Specs
  • File (F) Specs
  • Definition (D) Specs
  • Calculation (C) Specs (in progress)
  • Embedded SQL Statements
  • Procedure (P) Specs

Extension Settings

This extension provides several settings to customize its behavior. You can configure these in your VS Code settings.json or through the extension settings user interface.

rpgiv2free.RemoveFREEDirective

Automatically comments-out /free compilere directives. These were deprecated by IBM..

• true — Remove/comment-out /free and /end-free statements.
• false — Do not modify /free or /end-free statements.

Default: true

rpgiv2free.ReplaceCOPYwithINCLUDE_RPG

Converts the legacy /copy statement to the more modern and cross-language /include statement for RPGLE source type source memebers.

• true — Any selected /copy is converted to /include.
• false — /copy statements in RPGIV source members are not converted.

Default: true

rpgiv2free.ReplaceCOPYwithINCLUDE_SQLRPG

Converts the legacy /copy statement to the more modern and cross-language /include statement for SQLRPG* source type source memebers.

• true — Any selected /copy is converted to /include.
• false — /copy statements in SQL RPG source members are not converted.

Default: false

rpgiv2free.convertBINTOINT

Controls whether binary (B) data types in RPG IV are converted to integers in free-format RPG.

• 0 — Do not convert B fields to integer (make them BINDEC variables).
• 1 — Always convert B fields to integer (make them INT variables).
• 2 — Convert B fields to integer (make them INT variables) ONLY when decimal positions = 0. (recommended)

Default: 2

rpgiv2free.addINZ

Automatically adds the INZ keyword to data structure fields that do not already have it.

• true — Add INZ keyword to all Data Structures when converted.
• false — Do not add INZ.

Default: true

rpgiv2free.maxFreeFormatLineLength

Max length for converted free format lines (right margin).

Default: 76

rpgiv2free.indentFirstLine

First free format line indent/spaces (in bytes).

Default: 10

rpgiv2free.indentContinuedLines

Secondary free format lines indent/spaces (in bytes).

Default: 12

`rpgiv2free.AddEXTDeviceFlag

Add *EXT to DISK, WORKSTN, etc. when when converting externally described files.

• true — Add *EXT to DISK, WORKSTN, PRINTER keywords. e.g., DISK(*EXT)
• false — Do not add *EXT to externally described device file keywords. e.g., DISK

Default: true

`rpgiv2free.tempVarName1

The name used as a workfield by the convertion extension. This field name is used when converting things like CAT and SUBST to free format. In some scenarios, a length variable is required and this variable name is used. The conversion generates a DCL-S stand-alone field defining this variable name automatically.

• f2f_tempVar1 — The default named used by the extension.
• <your-custom-name — A user-specified variable name to use, must NOT contain special symbols such as @#$

Default: f2f_tempVa1

In Development:

• Calculation (C) Specs The conversion of Calc Specs is in progress and is being updated in each release. Currently some calc specs convert fine, while others may or may not convert. Be ready with your Ctrl+Z (cmd+Z on Mac) to undo the conversion if it does not produce the desired results. . For now, the following features are enabled:
  • Regular "3 factor" opcodes (such as CHAIN, READE, etc.) convert to free format. But verification is recommened.

Limitations

• Conditioning and Level Break Indicators are NOT converted. The opcodes convert but the conditioning and Level-break Indicators are lost. So some manual conversion to RPG IV conditional logic is required before converting them to free format. We will be adding a configuration setting to avoid converting statements with level break or conditioning indicator controlling them.
• RPG Logical Cycle-based File Declarations (i.e. File specs with Primary or Secondary files) are not converted. RPG IV hybrid Free format may included fixed-format code, so they can usually remain in your source code as is. However if your intent is to migrate to fully free format RPG IV, then you must remove any RPG Cycle-related code from your source file member.

Getting Started

1. Install the Extension:

   • Go to the Visual Studio Code Extensions marketplace. ).

   • or search for RPG IV to Free Format Conversion Tool, or from the Extensions explore within VS CODE, and in the "Search Extensions in Marketplace" search box, enter "Bob Cozzi" or "RPG IV" or similar.

2. Using the Tool:

   • Open any RPG IV source member in VS Code. The file extension must be .RPGLE or .SQLRPGLE which is derived from the member's source type.
   • Position the cursor on the fixed-format statement you want to convert.
   • Alternatively, you can select multiple lines of code or multiple statements to convert them at once. (The position of the cursor or selection on the line does not matter).
   • Right-click on the selected code or statement to bring up the context menu.
   • Select “Convert RPG IV to Free Format” from the context menu.
   • The tool converts all selected statements to free format.

3. Multi-Line Statements:

   • For multi-line statements, position the cursor on any line that makes up the statement. The extension automatically converts the full statement.

Known Issues

• Calc Specs (C Specs): Currently under development. Some opcodes are translated fine while others are sketchy. Conditioning Indicators logic is not support currently.

• H Specs:

  • Header specs are converted to one large CTL-OPT line. This is a work in progress and will be enhanced in a future release.
  • It is a future objective to include a Setting to convert each H spec line independently or allow it to work like it does now.

• D Specs:

  • The conversion of D specs is mostly complete, but some edge cases are not handled perfectly. For example, if a data structure is followed by another D spec for a long name variable, it may not correctly convert the code.

Roadmap

• Implementation of Calc Specs: We are working on refining the handling of Calc Specs and expect better support with each release.

License

This project is licensed. See the LICENSE file for details.

Support

If you have any issues or feature requests, please open an issue on the GitHub repository. We will do our best to address it promptly.

Contact

Bob Cozzi Website Email