04
Wed, Dec
6 New Articles

RPG Academy: BIF Up Your Code! Part 4, Simplifying String Operations with BIFs

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

You can simplify your code with the set of string-related BIFs presented in this TechTip. Master them and you'll be the one pulling the strings of your code and not the other way around.

 

Working with strings in RPG can be a real pain: all of those MOVE and CAT op codes and work variables with different lengths just to "stitch" the appropriate string together!

 

Don't take this the wrong way, but using MOVE and CAT to handle strings is so System/36! Over the years, IBM introduced several time-saving BIFs to handle almost every situation when it comes to string operations. In the previous TechTip, I introduced %CHAR and you probably already know %TRIM, but there's still a lot more to discover.

 

"Old" vs. "New" Ways

The code below depicts the old, "traditional" and the new, "BIF-esque" ways of performing a few string operations. Both scenarios perform the same task: splitting a string in two, adding some text in the middle, and stitching them back together. Let's start with the "traditional" approach:

 

D base_str       S            100A   INZ('THIS IS A TEST, 1, 2, 3')

D result         S           100A   INZ(*BLANKS)      

D temp_str1       S             15A   INZ(*BLANKS)

D temp_str2       S             84A   INZ(*BLANKS)    

D temp_str3       S             19A   INZ(*BLANKS)    

                                                              

C                   MOVEL     base_str     temp_str1    

* "temp_str1" is now 'THIS IS A TEST,'                      

C                   MOVE     base_str     temp_str2      

* "temp_str2" is now '1, 2, 3'

* plus a lot of trailing blanks that I'm omitting

C     temp_str1     CAT       ' 0,'         temp_str3      

* "temp_str3" is now 'THIS IS A TEST, 0,'              

C     temp_str3     CAT       temp_str2     result        

* "result" is now 'THIS IS A TEST, 0, 1, 2, 3'

* plus a lot of trailing blanks that I'm omitting

 

 

Now for the new, "BIF-esque" approach:

 

D base_str       S           100A   INZ('THIS IS A TEST, 1, 2, 3')

D result         S           100A   INZ(*BLANKS)                  

D temp_str1       S             15A   INZ(*BLANKS)                  

D temp_str2       S             84A   INZ(*BLANKS)                  

D temp_str3       S             19A   INZ(*BLANKS)                  

                                                                      

C                   EVAL     temp_str1 = %SUBST(base_str : 1 : 15)  

* "temp_str1" is now 'THIS IS A TEST,'                              

C                   EVAL     temp_str2 = %TRIM(%SUBST(base_str : 16))

* "temp_str2" is now '1, 2, 3'                                      

* without the %TRIM, it would be ' 1, 2, 3'                        

C                   EVAL     temp_str3 = temp_str1 + ' 0, '        

* "temp_str3" is now 'THIS IS A TEST, 0, '                          

C                   EVAL     result = temp_str3 + temp_str2        

* "result" is now 'THIS IS A TEST, 0, 1, 2, 3'                      

 

 

However, thanks to the EVAL op code and the BIFs, this could be much shorter.

 

In fact, it can be written in only one statement:

                                        

(…)

C                   EVAL     result = %SUBST(base_str : 1 : 15)

C                                         + ' 0, '        

C                                        + %TRIM(%SUBST(base_str :

16))  

 

 

This is an "over the top" example, but surely you see the difference in readability and maintainability between the two scenarios: while the variable sizes are critical to the success of the MOVE and MOVEL operations, in the "BIF-esque" approach they are irrelevant, as long as they're big enough to hold the substrings they need to hold. Even if you're familiar with the BIFs used here, keep reading. You might find something that you didn't know about these BIFs.

 

 

 

Out with the Old, in with the New

 

Let's begin with %SUBST. This BIF is similar to the SUBST op code (which I could have used in the "traditional" approach instead of the MOVE op code, but chose not to), with the same three parameters: base string, start position, and length to extract. Actually, the SUBST op code has a fourth parameter (the target string), which doesn't exist in its BIF counterpart due to its function nature. Anyway, if the third parameter is not specified, the length is the length of the string parameter less the start value plus one. In other words, the start position and everything to its right will be extracted, as you can see from the temp_str2 assignment in the code above. If you're still a bit confused, here are a few simple examples to make things clearer:

 

  • The value of %SUBST('Hello World' : 7) is 'World'
  • The value of %SUBST('Hello World' : 5+2 : 10-7) is 'Wor'
  • The value of % SUBST('abcd' + 'efgh' : 4 : 3) is 'def'

The first example, which omits the length parameter, returns everything to the right of position 7, including that character (see temp_str2's assignment above); the second one uses all three parameters and also illustrates the use of arithmetic operations in the start position and length parameters; you'll see how useful this can be later (see temp_str1's assignment above); finally, the third example shows a concatenation operation in the base string parameter; even though this might not be very common, its purpose here is to remind you that the CAT op code can be replaced by the '+' operator and used to simplify string concatenation (see temp_str3's and result's assignment above).

 

Do You %TRIM?

If you already knew %SUBST, it's possible that you also know %TRIM and its siblings, %TRIMR and %TRIML. What you might not know is that you can also use %TRIM to…well, trim characters other than the blank space. To do that, you just need to specify the characters to trim in the BIF's second (and optional) parameter:

 

 

D edited         S             20A   INZ('£******1.23***      ')

 

D trimmed         S             20A   Varying

 

 

 

C                   EVAL     trimmed = %TRIM(edited : '$£*')

 

 * Trims '£' and '*' from the edited numeric value     

 

 * "trimmed" is now '1.23***     '     

 

However, note that blanks will not be trimmed, since a blank is not specified in the 'characters to trim' parameter. To do that, you need to add a blank space to the second parameter of the BIF, like so:

 

D edited         S             20A   INZ('£******1.23***     ')
D trimmed         S            20A   Varying
 
C                   EVAL     trimmed = %TRIM(edited : '$£* ')
 * Trims '£', '*' and ' ' from the edited numeric value     
 * "trimmed" is now '1.23'

It's possible to do the same with the aforementioned %TRIML (Trim leading characters) and %TRIMR (Trim trailing characters), but it will 
only affect the characters to the left and right of the edited number from the example above, like this:

D edited         S             20A   INZ('£******1.23***     ')
D Ltrimmed       S             20A   Varying
D Rtrimmed       S             20A   Varying
 
C                   EVAL     Ltrimmed = %TRIML(edited : '$£* ')
 * "Ltrimmed" is now '1.23***       '
C                   EVAL     Rtrimmed = %TRIMR(edited : '$£* ')

* "Rtrimmed" is now '£******1.23'

 

By using BIFs as parameters to other BIFs, it gets easy to shorten the number of lines of code, but don't get carried away! It's crucial that you keep a sane balance between number of lines and readability.

 

Finally, you could argue that there are ways to determine the exact position of a substring within a string; finding the 'TEST, ' substring in the example above can be performed with the SCAN op code. That's correct, and it will be discussed in the next TechTip. Meanwhile, comment away in the Comments section below!

 

Rafael Victoria-Pereira

Rafael Victória-Pereira has more than 20 years of IBM i experience as a programmer, analyst, and manager. Over that period, he has been an active voice in the IBM i community, encouraging and helping programmers transition to ILE and free-format RPG. Rafael has written more than 100 technical articles about topics ranging from interfaces (the topic for his first book, Flexible Input, Dazzling Output with IBM i) to modern RPG and SQL in his popular RPG Academy and SQL 101 series on mcpressonline.com and in his books Evolve Your RPG Coding and SQL for IBM i: A Database Modernization Guide. Rafael writes in an easy-to-read, practical style that is highly popular with his audience of IBM technology professionals.

Rafael is the Deputy IT Director - Infrastructures and Services at the Luis Simões Group in Portugal. His areas of expertise include programming in the IBM i native languages (RPG, CL, and DB2 SQL) and in "modern" programming languages, such as Java, C#, and Python, as well as project management and consultancy.


MC Press books written by Rafael Victória-Pereira available now on the MC Press Bookstore.

Evolve Your RPG Coding: Move from OPM to ILE...and Beyond Evolve Your RPG Coding: Move from OPM to ILE...and Beyond
Transition to modern RPG programming with this step-by-step guide through ILE and free-format RPG, SQL, and modernization techniques.
List Price $79.95

Now On Sale

Flexible Input, Dazzling Output with IBM i Flexible Input, Dazzling Output with IBM i
Uncover easier, more flexible ways to get data into your system, plus some methods for exporting and presenting the vital business data it contains.
List Price $79.95

Now On Sale

SQL for IBM i: A Database Modernization Guide SQL for IBM i: A Database Modernization Guide
Learn how to use SQL’s capabilities to modernize and enhance your IBM i database.
List Price $79.95

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: