TechTip: RPG IV--What's Different About Programming Structures in Free-Format?

RPG
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times
The arrival of free-format RPG IV in V5R1 was announced with little fanfare. I suppose IBM assumed it was just another alternative for RPG programmers. But I think IBM should have renamed the language or at least called it RPG V! With free-format, the era of "Goto" in RPG is ended. This is significant, since it forces programmers to use good procedural structures for the logic in their programs rather than the happenstance logic (sometimes called "spaghetti code") often found in programs. True, good structural code does not require free-format, but nonstructural options still abound. Free-format coding requires some thinking because many of the old, fixed-format ways of coding logic are just not available.

The fact that the Goto operation is not supported in free-format should not be a problem for most programmers, since good programming practice should have precluded its use long ago. But we all have coded--or at least seen--Goto loops, such as the following:

C         Loop          Tag
C                       Exfmt   Scrnfmt
C                       If      *In03 = *Off and *In12 = *Off
C*   Not exit and not cancel, so process data from the screen   
C                       If      Error_1
C                       Eval    *In20 = *on
C                       Goto    Loop
C                       Endif
C                       If      Error_2
C                       Eval    *In21 = *On
C                       Goto    Loop
C                       Endif
C
C* More error checking and looping back...
C*   Error messages on the screen are conditioned by *In20, *In21, etc.
   

How could the above be coded without Goto? The following is a fixed-format scheme:

C                       Dou     *In03 or *In12
C                       Exfmt   Scrnfmt
C                       If      *In03 = *Off and *In12 = *Off
C*   Not exit and not cancel, so process data from the screen  
C                       If      Error_1
C                       Eval    *In20 = *on
C                       Iter
C                       Endif
C                       If      Error_2
C                       *In21 = *On
C                       Iter
C                       Endif


Here's the free-format alternative:

/free
  Dou Exit or Cancel;             // Begin screen display and edit
    Exfmt Scrnfmt;                //   Display the screen
    If Not Exit and Not Cancel;   //   Check for F3 or F12 keys
      If Error_1;                 //   Checking for error 1 
        Scrnfield1_error = *On;   //   Set error flag indicator
        Iter;                     //   Exit remaining check section
     Endif;
      If Error_2;                 //   Checking for Error 2
        Scrnfield2_error = *On;   //   Set error flag indicator
        Iter;                     //   Exit remaining check section
      Endif;
  //
  //  More error checking here
  //
 Enddo;   
/end-free      


The free-format alternative is very much the same as a good fixed-format alternative. The only difference is that I have chosen to use named indicators from the display file instead of numbered ones. This is not required, but it sure adds a lot of clarity to the code. Don't forget to use the file-level keyword INDARA in the DDS of the display file if you choose to use a named indicator data structure. Also, when doing this, the numbered indicators in the RPG program no longer reference the display file indicators. They can only be referenced by their name. (For more information on named file indicators, check for indicator data structures in the RPG Reference manual. Look at page 133 for information and page 142 for an example.)

Other logical flow operators that are missing in free-format are DO and case (CASxx). The DO operation is easily replaced by the FOR operation. The following shows a DO group with a starting value other than one, an increment other than one, and the index option:

C         2             Do      20                  Index
C                       Eval    Array(Index) = Index;
C         Index         Chain   SubfileRec
C                       If      %found
C                       Eval    SF_Field_1 = 44
C                       Endif
C                       Enddo   2


Here's the free-format equivalent:

 /free
  For Index = 2 to 20 by 2;            // Set up a controlled loop
    Array(Index) = Index;              // Set Array element
    Chain Index SubfileRec;            // Get subfile record
    If %found;                         // If found
      SF_Field_1 = 44;                 //   Set subfile field
    Endif;
  Endfor;
 /End-free 



Case groups can easily be modified to use the Select, When, and Other operations.

The If, DOW (Do While), and DOU (Do Until) operations are still available in free-format. And the logic interrupters Iter (Iteration), Leave (leave Do or For group), and LeaveSR (leave subroutine) are an essential part of your logical structures. Also, the new operation ElseIf could be a very nice option in a program, eliminating a long string of Endifs.

Coding in free-format RPG IV is not a panacea for programmers, but it does force us into using better program structures. By using indenting, named indicators, indicator data structures for files, and line comments, program maintenance productivity and overall readability is greatly improved.

Jim Martin is the corporate technical instructor at Jack Henry & Associates in Monett, Missouri. He is a veteran of RPG programming, beginning in 1967 with a position at IBM as a systems engineer. Later, he was a staff programmer at the Rochester systems programming lab. For eight years, he was at Lakeview Technology as an AS/400 and RPG instructor and a speaker at various local midrange user group meetings and conferences. He can be reached by email at This email address is being protected from spambots. You need JavaScript enabled to view it..

JIM MARTIN

Jim Martin holds a BS degree in mathematics and an MS in computer science. For 26 years, he was employed by IBM, where he wrote RPG applications for customers and worked in the programming laboratory as a programmer on portions of CPF and the OS/400 operating system. After leaving IBM, Jim took post-graduate work in computer science and performed RPG training. He is an IBM-certified RPG IV developer and author of multiple bestselling editions of Free-Format RPG IV, which, since the book's initial publication in 2005, have taught thousands of RPG IV programmers how to be successful with the free-format coding style.


MC Press books written by Jim Martin available now on the MC Press Bookstore.

Free-Format RPG IV: Third Edition Free-Format RPG IV: Third Edition
Improve productivity, readability, and program maintenance with the free-format style of programming in RPG IV.
List Price $59.95

Now On Sale

Free-Format RPG IV: Second Edition Free-Format RPG IV: Second Edition
>Make the transition from coding in fixed-format RPG to free format.
List Price $59.95

Now On Sale

Functions in Free-Format RPG IV Functions in Free-Format RPG IV
Here’s the ultimate guide to writing RPG IV programs with functions in the free-format style.
List Price $59.95

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  •  

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: