In cycle main programs, the compiler automatically includes the RPG cycle to provide program initialization and termination as well as ordered processing steps for file input and output (I/O).
Editor’s note: This article is excerpted from Programming in ILE RPG, Fifth Edition, chapter 14, “Building Modular Programs with Procedures.”
Up to now, all the RPG programs we’ve discussed [in this chapter] have been cycle main programs. A cycle main program has a main procedure implicitly specified in the main section of the program. In a cycle main program, the main procedure does not have a name; it is the main procedure by virtue of its location in the program code. A cycle main program includes a main source section (the main procedure), followed by zero or more subprocedure sections. The main procedure is everything before the first Dcl-proc instruction. You need not code anything special to define the main procedure. It does not begin with a Dcl-proc instruction or end with an End-proc instruction. The cycle main program is so called because the compiler automatically includes the RPG cycle to provide program initialization and termination as well as ordered processing steps for file input and output (I/O). Most traditional RPG programs are cycle main programs.
To understand the basic coding requirements for a cycle main program, let’s look at an example. The following program demonstrates how to code a main procedure and include the example Celsius subprocedure within the same source, an architecture sometimes called a local procedure. Although the program is complete as shown, we have abbreviated it to concentrate those lines that relate to procedures.
// ----------------------------------------------------
//
// Program – THISPGM – Displays Celsius temperature and
// corresponding water state
//
// ----------------------------------------------------
// ------------------------- Cycle main procedure PR/PI
Dcl-pr Thispgm Extpgm;
*N Int(5);
End-pr;
Dcl-pi Thispgm;
Englishtemp Int(5);
End-pi;
// ----------------------------------------- Prototypes
Dcl-pr Celsius Int(5);
*N Int(5);
End-pr;
// ----------------------------------- Global variables
Dcl-s Message Char(50);
Dcl-s Metrictemp Int(5);
Dcl-s State Varchar(8);
// ------------------------------------- Main procedure
Metrictemp = Celsius(Englishtemp);
Select;
When Metrictemp < 0;
State = 'solid';
When Metrictemp = 0;
State = 'freezing';
When Metrictemp = 100;
State = 'boiling';
When Metrictemp > 100;
State = 'gaseous';
Other;
State = 'liquid';
Endsl;
Message = 'At ' + %Char(Englishtemp) + ' degrees (' +
%Char(Metrictemp) + ' Celsius), water is ' +
State + '.';
Dsply Message;
*Inlr = *On;
Return;
// ----------------------------------------------------
//
// Procedure – Celsius – Converts Fahrenheit to Celsius
//
Dcl-proc Celsius;
// ------------------------------ Procedure interface
Dcl-pi *N Int(5);
Fahrenheit Int(5);
End-pi;
// ---------------------------------- Local variables
Dcl-s Temperature Int(5);
Eval(H) Temperature = (5/9) * (Fahrenheit - 32);
Return Temperature;
End-proc Celsius;
Notice the declarations in this program under the Global variables comment for Message, Metrictemp, and State. Those variables, which you define before the main procedure, have a global scope and can be accessed from anywhere in the compile unit. If you have a need to do so, the Celsius subprocedure can also process any of those variables as well as the Englishtemp parameter, which is also global. The main procedure in a cycle main program cannot declare local variables or access a subprocedure’s local variables.
Tip: Generally, you should define variables with the narrowest scope that will accomplish your program’s goal. Instead of accessing global variables in a subprocedure, you should pass parameters to share information between the main procedure and any subprocedures. In a large program consisting of many modules, this practice helps avoid confusion and errors and makes your programs easier to maintain.
The main procedure of this program accepts one parameter, Fahrenheit, and then executes the Celsius subprocedure to convert that value to Celsius. It then assigns a (sea level) state based on the temperature and builds a message along the lines of “At 20 degrees (-7 Celsius), water is solid.” Finally, the Dsply (Display Message) operation shows the message on the workstation that is running the program (or sends the message to the job log).
The Celsius subprocedure is coded following the main procedure. In a cycle main program, the main procedure code ends once it encounters the first subprocedure. The main procedure code should end with *Inlr set to *On to ensure proper cleanup after the program has completed. The cycle then automatically closes files, unlocks data areas, and frees memory used by the program.
Jim Buck's career in IT has spanned more than 35 years, primarily in the college education, manufacturing, and healthcare industries. Past president (13 years) of the Wisconsin Midrange Computer Professional Association, he has served on several teams developing IBM and COMMON certification tests. Jim has co-authored several IBM i textbooks with Bryan Meyers that are used by many companies and in colleges worldwide. Other accomplishments include: recipient of the 2007 IBM System i Innovation - Education Excellence Award, 2014 COMMON President's Award, and 2013/2016/2017 IBM Champion - Power Systems.
Jim is the president and founder of imPower Technologies, where he provides professional IBM i training and consulting services. He is active in the IBM i community, working to help companies train their employees in the latest IBM technologies and develop the next generation of IBM i professionals.
MC Press books written by Jim Buck available now on the MC Press Bookstore.
 |
||
 |
|
Control Language Programming for IBM i Master the A-Z of CL, including features such as structured programming, file processing enhancements, and ILE. List Price $79.95 Now On Sale
|
|
||
 |
|
Mastering IBM i Get the must-have guide to the tools and concepts needed to work with today's IBM i. List Price $85.95
Now On Sale
|
|
||
 |
|
Programming in ILE RPG Get the definitive guide to the RPG programming language. List Price $95.95
Now On Sale
|
|
||
 |
|
Programming in RPG IV Understand the essentials of business programming using RPG IV. List Price $79.95
Now On Sale
|
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.
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:
LATEST COMMENTS
MC Press Online