21
Sat, Dec
3 New Articles

RPG Academy: BIF Up Your Code! Building Excel's PROPER Case Function and Testing Chg_Case

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

The previous TechTip focused on two of Excel's text conversion functions, UPPER and LOWER. This time around, I'll cover PROPER, also known as Title Case. Read on!

 

PROPER Case is a bit complex to implement, because it completely modifies the input string, changing the first letter of each word to uppercase and all of the others to lowercase. It's a perfect opportunity to show how a fairly complex problem can be solved in a simple way, using BIFs.

 

PROPER Case is a bit trickier to code than the functions presented in the previous TechTip, but if you think for a bit about the definition, you'll see that the answer is right there. We just need to find a way to pinpoint the beginning of each word of the string. This TechTip is a follow-up from the previous one in this series, so if you haven't read it, now it would be a good time to do so.

 

We're going to modify the Chg_Case function in order to increase its functionality. The first change is quite simple: we want to add a new case, so the validation of P_Case must be changed accordingly (I've added the line in bold):

 

* P_Case                                    

C                  IF       P_Case = ''    

C                             AND P_Case <> 'U'

C                             AND P_Case <> 'L'

C                             AND P_Case <> 'S'

C                             AND P_Case <> 'P'

C                   RETURN    P_String        

C                   ENDIF                    

 

The next step is adding a new WHEN statement to the SELECT that processes the input string. But before I do that, let's take a moment to analyze our problem: how to know which characters to capitalize. Just find the beginning of every word, right? One way to find out where each word begins is by looking for the blank space that separates it from the previous word. However, this approach doesn't work with the first word because we're trimming the leading blanks, so we need to treat it separately. The first word can be processed using the Sentence case approach from the previous TechTip. The following words of the string, however, require a little more processing:

 

* Proper Case (First Letter Of Every Word In Upper Case,                

*             The Rest In Lower Case) aka Title Case                    

C                   WHEN     P_Case = 'P'                                

* Process the first word                                                

C                   EVAL     W_TempStr = %XLATE(lc : UC :              

C                                               %SUBST(W_String : 1 : 1))

C                                         +                              

C                                         %XLATE(UC : lc :              

C                                               %SUBST(W_String : 2))  

C                   EVAL     W_Pos = %SCAN(' ' : W_TempStr)            

C                   DOW       W_Pos <> *Zeros                  

* Process the following words                                            

C                   EVAL     W_TempStr = %SUBST(W_TempStr : 1 :          

C                                                W_Pos) +                

C                                         %XLATE(lc : UC :              

C                                                 %SUBST(W_TempStr :      

C                                                       W_Pos + 1 : 1))  

C                                         +                              

C                                         %SUBST(W_TempStr : W_Pos + 2)  

C                   EVAL     W_OldPos = W_Pos                            

C                   EVAL     W_Pos = %SCAN(' ' : W_TempStr : W_OldPos + 1)

C                   ENDDO

C                   EVAL     W_Return = %Trim(W_TempStr)                                            

 

We're going to use %SCAN to distinguish between words. In this case, we're going to store the result of the %SCAN in the W_Pos variable. So what we're going to do is a three-step operation: first, we need to keep what was already convertedin other words, a substring starting with the first character of our string and ending with the blank space we've just found: %SUBST(W_TempStr : 1 : W_Pos); then we' re going to convert the first character after the blank space to uppercase: %XLATE(lc : UC : %SUBST(W_TempStr : W_Pos + 1 : 1)); for the third and final step, we're going to concatenate the rest of the string without making changes: %SUBST(W_TempStr : W_Pos + 2).

 

Next, we need to save the position of the last blank space found in W_OldPos and look for the next blank space, using the third parameter of %SCAN to start after that last blank space, thus making sure that we're not finding the same character twice. Since %SCAN returns zero when it can't find what it's looking for, we're using that to do the loop. Finally, we just have to pass our work variable to the one that's going to be returned (W_Return), and that's it.

 

Now, let's test our function! I've written a simple test program that tests the different Chg_Case variations:

 

*------------------------------------------------------------------------*

*   Variables                                                           *

*------------------------------------------------------------------------*            

D W_MyString2   S           250A   VARYING INZ(*Blanks)                          

D W_TestStr2     S           250A   VARYING INZ(*Blanks)                

                                                                          

*------------------------------------------------------------------------*

*   Copy Statements                                                     *

*------------------------------------------------------------------------*

* String Operations                                                      

/Copy QCPYLESRC,STR_OPS_PR                                              

  

C                   EVAL     W_MyString2 = 'THIS is A Test'              

* Test the Chg_Case function (UPPER CASE)                          

C                   EVAL     W_TestStr2 = Chg_Case(W_MyString2 : 'U')

* "W_TestStr2" is now 'THIS IS A TEST'                            

* Test the Chg_Case function (lower case)                          

C                 EVAL     W_TestStr2 = Chg_Case(W_MyString2 : 'L')

* "W_TestStr2" is now 'this is a test'                            

* Test the Chg_Case function (Sentence case)                        

C                   EVAL     W_TestStr2 = Chg_Case(W_MyString2 : 'S')

* "W_TestStr2" is now 'This is a test'                            

* Test the Chg_Case function (Proper Case)                          

C                   EVAL     W_TestStr2 = Chg_Case(W_MyString2 : 'P')

* "W_TestStr2" is now 'This Is A Test'                            

                                                                    

C                   EVAL     *INLR = *On                            

 

I've created a service program called STR_OPS (String Operations) to make the Chg_Case function available to the outside world. The /Copy QCPYLESRC,STR_OPS_PR line that you see near the top of the code is providing my test program (TST_STROPS) with the function's prototype. Then I'm using all the different P_Case choices to produce different results.

 

You can play around with it a bit by downloading and running the source code for the Chg_Case function. As a bonus, the STR_OPS and TST_STROPS source members also include the code for the LEFT and RIGHT functions I explained a few TechTips ago.

 

These are just a few examples of Excel functions that you convert to RPG. You can argue that there's not much to gain from that. Well, at least you get to practice the whole process of creating a function! Many readers reacted to the use of %XLATE, saying that there are other ways to provide the same functionality. The purpose of these two TechTips was not promoting the use of %XLATE. It was simply using this BIF as a way to create functions in an easily understandable fashion. The SQL 101 TechTip series will present, in a few articles, SQL embedded functions that replace %XLATE with more reliable and functional SQL functions.

 

I'll continue to explore RPG's BIFs in the next TechTip. I'll be talking about data and time operations. Until then, share your thoughts, questions, and doubts with your fellow RPGers via the Comments section below or in the usual LinkedIn groups where these TechTips usually end up.

 

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: