04
Mon, Nov
1 New Articles

Practical RPG: Refactoring in RDi

RPG
Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

Rational snuck a feature in under the radar that might signal a sea change for the product.

What is refactoring, and why do you care?

Refactoring in the broadest sense refers to an intelligent, comprehensive change to your program source. The least complicated example is a simple rename, while a more complex case might involve pulling out all occurrences of a common piece of code and putting that into a callable routine.

Refactoring is important because it allows you to more easily make systemic changes to a program that might otherwise just be too much to manage. This helps you to overcome what I like to think of as “architectural inertia,” the natural tendency to not want to implement new technological approaches for fear of breaking existing code, even if those new approaches can bring significant advantages to your programs.

The New Refactoring in RDi

So with very little fanfare, in the 9.5.1.1 fixpack of RDi, IBM introduced the concept of refactoring for ILE RPG. That's right, it's not even a point release; it's a fixpack of a point release. The implementation is quite straightforward: highlight the field or procedure you wish to rename, right-click, and select Refactor > Rename. The name you selected will pop up in a dialog, and you can choose a new name for it. Let's take a quick spin. Here's my program:

     ctl-opt actgrp(*new) option(*srcstmt:*nodebugio);

     dcl-s myVariable char(1);

     dcl-s myVariable2 char(1);

     dcl-ds myDS qualified;

      allDone ind;

     end-ds;

     init();

      dou myDS.allDone;

      doSomething();

      enddo;

     *inlr = *on;

      return;

      dcl-proc init;

     clear myVariable;

     clear myVariable2;

      end-proc;

      dcl-proc doSomething;

      myVariable += 1;

      myDS.allDone = myVariable > 100;

      end-proc;

It's a very simple program that doesn't do anything useful, but it allows me to illustrate a couple of points. First, let's just look at the basic mechanics of the refactor. As noted above, we start by highlighting something and then use the context menu (right-click) to select the option:

 Practical RPG: Refactoring in RDi

Figure 1: Use the context menu to select the Refactor option.

Alternatively, you could use the keyboard shortcut Alt+Shift+R to trigger the same action. One thing to remember: While on this program, the pop-up shows up almost instantaneously; on any program of more than trivial complexity, you will see an additional pop-up. It looks like this:

Practical RPG: Refactoring in RDi

Figure 2: Before performing the action, the IDE must first parse your source code.

As far as I can tell, the IDE is going through your entire source program and looking for all the actual references to what you are renaming, as opposed to finding something similar or something in a comment. Since this is roughly akin to actually syntax-checking the program, this is not a trivial task. Depending on the size of your program, this could take a while. Once done, however, you end up with a simple pop-up:

Practical RPG: Refactoring in RDi

Figure 3: You simply key the new name into this pop-up and hit OK.

Once you hit OK, the source code is changed. In our example, you end up with the following code:

  

     ctl-opt actgrp(*new) option(*srcstmt:*nodebugio);

     dcl-s myField char(1);

     dcl-s myVariable2 char(1);

     dcl-ds myDS qualified;

      allDone ind;

     end-ds;

     init();

      dou myDS.allDone;

      doSomething();

      enddo;

     *inlr = *on;

      return;

      dcl-proc init;

     clear myField;

     clear myVariable2;

      end-proc;

      dcl-proc doSomething;

      myField += 1;

      myDS.allDone = myField > 100;

      end-proc;

 

Notice that every instance of myVariable is now myField. The really important thing to notice, though, is that while myVariable has changed, myVariable2 has not. This is by design. Even though the fields are similar in name, they are not identical, so unlike a simple mass find and replace, the refactor action doesn't change myVariable2.

Preview Mode

There are cases where a blanket change just isn't a good idea. A really good example is copying a procedure, especially one where you've labeled not only the dcl-proc statement, but also the end-proc and perhaps even the dcl-pi. Let's say I have the following procedure:

    dcl-proc returnTrue;

     dcl-pi returnTrue ind end-pi;

     return *on;

      end-proc returnTrue;

Let's say further that I want to clone it into a procedure called returnFalse. I copy the lines, and then I highlight returnTrue and start going through the Refactor > Rename action. However, in Figure 3, rather than hitting OK, I instead hit Preview. Here's what I see:

Practical RPG: Refactoring in RDi

Figure 4: The first panel of the Rename preview shows a summary of references.

This summary telling me how many references were found is nice, but the real meat of the preview comes in when I hit Continue:

Practical RPG: Refactoring in RDi

Figure 5: The detail panel of preview mode allows you to selectively apply the rename.

This may be the most useful version of the new action. Here, I can apply the change to only the cloned version of the procedure by simply unchecking a few boxes. This might even convince me to put labels on my procedure interfaces again. Nah, not likely. But still, it's a very nice feature.

The Future

This is really just the first sally into the new (to RPG, anyway) world of refactoring. There are already requests out there for other forms of refactoring, from extracting constants to creating procedures. You can see more about the 9.5.1.1 release on the IBM website. You can also drill into more detail on the the whole refactoring concept. I said at the beginning that this might signal a sea change; if IBM gets serious about implementing more of these features, then I definitely see a possibility of the RDi tool becoming a way to facilitate fundamental system redesign. We'll see what the future brings.

Caveats

Refactoring isn’t a silver bullet. Perhaps the biggest problem is the entire idea of mod-marking, the technique of tagging every line of changed code with some sort of code that indicates the project that changed that line of code. A common practice is to use the first five characters of your RPG source line to contain the mod-mark. This technique is so ingrained into the fabric of RPG development that even the first incarnation of free-format RPG supported those first five characters. The refactoring option doesn’t currently support that technique, and I don’t expect that it ever will. Instead, I see the trend moving toward the UNIX “diff” style of version control, in which you run a command to show the differences between two versions. I don’t think that’s a reason to eschew the refactor tool, but be advised that the issue is there.

Also, there are times when a good old mass find-and-replace will work best. Whether it's changing the prefix for all fields in a file or changing a word that is part of a whole set of routines, sometimes the brute force method works best. Also, if you have procedure or variable names in your comments, those references will not be updated. But given what we're seeing in RDi, the future of RPG looks like it's moving ever more toward the rest of the world of programming languages, and we might be well advised to learn to work in that environment. Embracing the new refactor option is one way to start moving in that direction.

Joe Pluta

Joe Pluta is the founder and chief architect of Pluta Brothers Design, Inc. He has been extending the IBM midrange since the days of the IBM System/3. Joe uses WebSphere extensively, especially as the base for PSC/400, the only product that can move your legacy systems to the Web using simple green-screen commands. He has written several books, including Developing Web 2.0 Applications with EGL for IBM i, E-Deployment: The Fastest Path to the Web, Eclipse: Step by Step, and WDSC: Step by Step. Joe performs onsite mentoring and speaks at user groups around the country. You can reach him at This email address is being protected from spambots. You need JavaScript enabled to view it..


MC Press books written by Joe Pluta available now on the MC Press Bookstore.

Developing Web 2.0 Applications with EGL for IBM i Developing Web 2.0 Applications with EGL for IBM i
Joe Pluta introduces you to EGL Rich UI and IBM’s Rational Developer for the IBM i platform.
List Price $39.95

Now On Sale

WDSC: Step by Step WDSC: Step by Step
Discover incredibly powerful WDSC with this easy-to-understand yet thorough introduction.
List Price $74.95

Now On Sale

Eclipse: Step by Step Eclipse: Step by Step
Quickly get up to speed and productivity using Eclipse.
List Price $59.00

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • 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.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • 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

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • 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: