/* REXX AMORT Amortization of a loan. |**-***-***-***-***-***-***-***-***-***-***-***-***-***-***-***-**| | | | WARNING: EMBEDDED COMPONENTS. | | See text following TOOLKIT_INIT | | | |**-***-***-***-***-***-***-***-***-***-***-***-***-***-***-***-**| Use '(routine name) ?' for HELP-text. Written by Frank Clarke rexxhead@yahoo.com 20240623 Impact Analysis . SYSEXEC TRAPOUT Modification History 20240618 fxc adjusted HELP text; */ arg argline address TSO /* REXXSKEL ver.20240618 */ arg parms "((" opts signal on syntax signal on novalue call TOOLKIT_INIT /* conventional start-up -*/ rc = Trace("O"); rc = Trace(tv) info = parms /* to enable parsing */ call A_INIT /* -*/ call I_ISPF_OPS /* -*/ if \sw.0nested then call DUMP_QUEUE 'quiet' /* -*/ exit /*@ AMORT */ /* . ----------------------------------------------------------------- */ A_INIT: /*@ */ if branch then call BRANCH address TSO varnames = 'NETAMT PMNT NETPMNT CURRINT NEWNET TOTINT ' parse value '' with, errmsg prin pmnt pct start zerrlm return /*@ A_INIT */ /* . ----------------------------------------------------------------- */ I_ISPF_OPS: /*@ */ if branch then call BRANCH address ISPEXEC "CONTROL ERRORS RETURN" /* I'll handle my own */ call IA_PROLOG /* -*/ call IC_CALCULATE /* -*/ call IZ_EPILOG /* -*/ return /*@ I_ISPF_OPS */ /* Extract ISPF assets. Build results table. . ----------------------------------------------------------------- */ IA_PROLOG: /*@ */ if branch then call BRANCH address ISPEXEC call DEIMBED /* -*/ dd = "" do Words(ddnlist) /* each LIBDEF DD */ parse value ddnlist dd with dd ddnlist @ddn = @ddn.dd /* PLIB322 <- PLIB */ "LIBDEF ISP"dd "LIBRARY ID("@ddn") STACK" end ddnlist = ddnlist dd return /*@ IA_PROLOG */ /* PRIN START PCT PMNT . ----------------------------------------------------------------- */ IC_CALCULATE: /*@ */ if branch then call BRANCH address ISPEXEC rc = Trace("O") ; rc = trace( tv ) call ICA_GET_PARMS /* -*/ if sw.0Error_Found then do zerrlm = exec_name "errored out" zerrsm = '' "SETMSG MSG( ISRZ002 )" return end /* error */ /* PRIN START PCT PMNT have been set */ RECYCLE: "TBCREATE" @tn@ "KEYS( SEQ ) NAMES(" varnames ") ", "NOWRITE REPLACE " eff_pct = ( pct / 1200 ) netamt = prin totint = 0 parse var start yyyy 5 mm . do until netamt < pmnt /* last pmnt is usu partial */ currint = netamt * eff_pct /* monthly interest */ currint = Format(currint,,2) newnet = netamt + currint - pmnt totint = totint + currint netpmnt = pmnt - currint seq = yyyy'-'Right( mm,2,0 ) "TBADD" @tn@ netamt = newnet /* set for next cycle */ mm = mm + 1 /* bump month */ if mm > 12 then do mm = mm // 12 yyyy = yyyy + 1 /* next year */ end end /* until worn down */ currint = netamt * eff_pct /* interest for last pmnt */ currint = Format(currint,,2) pmnt = netamt + currint /* calc short payment */ newnet = netamt + currint - pmnt /* must be zero */ totint = totint + currint netpmnt = pmnt - currint /* =netamt */ seq = yyyy'-'Right( mm,2,0 ) "TBADD" @tn@ netamt = newnet /* must be zero */ rc = Trace("O") ; rc = trace( tv ) startpos = Space( prin start pct opmnt,1 ) "TBTOP" @tn@ "TBDISPL" @tn@ "PANEL( AMORT )" if rc > 8 then do say "AMORT RC="rc "SM="zerrsm "LM="zerrlm rc = Trace("O") ; rc = trace( tv ) end endpos = Space( prin start pct opmnt,1 ) if startpos <> endpos then do pmnt = opmnt /* from the screen */ signal RECYCLE end return /*@ IC_CALCULATE */ /* . ----------------------------------------------------------------- */ ICA_GET_PARMS: /*@ */ if branch then call BRANCH address ISPEXEC do forever "DISPLAY PANEL( PARMS ) " if rc > 0 then leave parse value '0' with, sw.0Error_Found errmsg if DataType( prin,'N' ) = 0 then, errmsg = errmsg "Principal must be numeric. " else prin = Format( prin,9,2 ) if DataType( start,'N' ) = 0 then, errmsg = errmsg "Start Month must be numeric. " if Length( start ) <> 6 then, errmsg = errmsg "Start Month incorrect length. " else do parse var start 5 mm if mm < 1 | mm > 12 then, errmsg = errmsg "Invalid month-value. " end if DataType( pct ,'N' ) = 0 then, errmsg = errmsg "Annual Percentage Rate must be numeric. " else pct = Format( pct ,5,3 ) if DataType( pmnt ,'N' ) = 0 then, errmsg = errmsg "Periodic Payment Amount must be numeric. " else pmnt = Format( pmnt,7,2 ) if errmsg <> '' then do zerrlm = errmsg zerrsm = '' "SETMSG MSG( ISRZ002 )" sw.0Error_Found = 1 iterate end /* errmsg */ end /* forever */ sw.0Error_Found = Words( prin start pct pmnt ) <> 4 opmnt = pmnt /* save original payment */ return /*@ ICA_GET_PARMS */ /* Flush ISPF assets. TBEND the results table. . ----------------------------------------------------------------- */ IZ_EPILOG: /*@ */ if branch then call BRANCH address ISPEXEC dd = "" do Words(ddnlist) /* each LIBDEF DD */ parse value ddnlist dd with dd ddnlist @ddn = @ddn.dd /* PLIB322 <- PLIB */ "LIBDEF ISP"dd address TSO "FREE FI("@ddn")" end ddnlist = ddnlist dd return /*@ IZ_EPILOG */ /* . ----------------------------------------------------------------- */ LOCAL_PREINIT: /*@ customize opts */ address TSO parse value KEYWD(" USETBL ") "AMORT" with, @tn@ . parse value KEYWD(" ISPTLIB ") DFLTTLIB( @tn@ ) with, isptlib . parse value KEYWD(" ISPTABL ") isptlib with, isptabl . return /*@ LOCAL_PREINIT */ /* subroutines below LOCAL_PREINIT are not selected by SHOWFLOW */ /* Parse out the embedded components at the back of the source code. . ----------------------------------------------------------------- */ DEIMBED: Procedure expose, /*@ */ (tk_globalvars) ddnlist @ddn. daid. address TSO fb80po.0 = "NEW DELETE REU UNIT(SYSDA) SPACE(1 5) TRACKS DIR(40)", "RECFM(F B) LRECL(80) BLKSIZE(0)" fb80po.1 = "SHR REU" parse value "" with ddnlist @ddn. daid. lastln = sourceline() currln = lastln /* */ if Left(sourceline(currln),2) <> "*/" then return currln = currln - 1 /* previous line */ "NEWSTACK" address ISPEXEC do while sourceline(currln) <> "/*" text = sourceline(currln) /* save with a short name ! */ if Left(text,3) = ")))" then do /* package the queue */ parse var text ")))" ddn mbr . /* PLIB PANL001 maybe */ if length(ddn) > 4 then do /* data, not ISPF */ call DESPOOL /* -*/ currln = currln - 1 /* previous line */ iterate end if Pos(ddn,ddnlist) = 0 then do /* doesn't exist */ ddnlist = ddnlist ddn /* keep track */ @ddn = ddn || Random(999) /* PLIB322 maybe */ @ddn.ddn = @ddn /* @ddn.PLIB = PLIB322 */ address TSO "ALLOC FI("@ddn")" fb80po.0 "LMINIT DATAID(DAID) DDNAME("@ddn")" daid.ddn = daid end daid = daid.ddn "LMOPEN DATAID("daid") OPTION(OUTPUT)" do queued() parse pull line "LMPUT DATAID("daid") MODE(INVAR) DATALOC(LINE) DATALEN(80)" end "LMMADD DATAID("daid") MEMBER("mbr")" "LMCLOSE DATAID("daid")" end /* package the queue */ else push text /* onto the top of the stack */ currln = currln - 1 /* previous line */ end /* while */ address TSO "DELSTACK" return /* Subroutine of DEIMBED for non-ISPF data. Given: the stack, ddn, and mbr . ----------------------------------------------------------------- */ DESPOOL: /*@ */ if branch then call BRANCH address TSO if WordPos( ddn,ddnlist ) = 0 then, ddnlist = Space( ddnlist ddn,1 ) if Sysdsn(ddn".DATA") <> "OK" then, "ALLOC FI("ddn") DA("ddn".DATA)" fb80po.0 "ALLOC FI("ddn") DA("ddn".DATA("mbr")) SHR REU" "EXECIO" queued() "DISKW" ddn "(FINIS" "DELSTACK" "NEWSTACK" /* re-establish */ return /*@ DESPOOL */ return /*@ DEIMBED */ /* . ----------------------------------------------------------------- */ HELP: /*@ */ address TSO;"CLEAR" if helpmsg <> "" then say helpmsg ex_nam = Left(exec_name,8) /* predictable size */ say " " say " "ex_nam" ........ " say " ........ " say " " say " Syntax: "ex_nam" .......... " say " .......... " say " " say " .... .......... " say " .......... " say " " "NEWSTACK"; pull ; "CLEAR" ; "DELSTACK" say " Debugging tools provided include: " say " " say " MONITOR: can be used by the programmer to display key information" say " throughout processing. Monitor is not used in the " say " canonical REXXSKEL. " say " " say " NOUPDT: by-pass all update logic. " say " " say " BRANCH: show all paragraph entries. " say " " say " TRACE tv: will use value following TRACE to place the execution " say " into REXX TRACE Mode. " say " " say " " say " Debugging tools can be accessed in the following manner: " say " " say " TSO "ex_nam" parameters (( debug-options " say " " say " For example: " say " " say " TSO "ex_nam" (( MONITOR TRACE ?R " if sysvar("SYSISPF") = "ACTIVE" then, address ISPEXEC "CONTROL DISPLAY REFRESH" exit /*@ HELP */ /* . ----------------------------------------------------------------- */ BRANCH: Procedure expose, /*@ */ sigl exec_name rc = trace("O") /* we do not want to see this */ arg brparm . origin = sigl /* where was I called from ? */ do currln = origin to 1 by -1 /* inch backward to label */ if Right(Word(Sourceline(currln),1),1) = ":" then do parse value sourceline(currln) with pgfname ":" . /* Label */ leave ; end /* name */ end /* currln */ select when brparm = "NAME" then return(pgfname) /* Return full name */ when brparm = "ID" then do /* wants the prefix */ parse var pgfname pgfpref "_" . /* get the prefix */ return(pgfpref) end /* brparm = "ID" */ otherwise say left(sigl,6) left(pgfname,40) exec_name "Time:" time("L") end /* select */ return /*@ BRANCH */ /* . ----------------------------------------------------------------- */ DUMP_QUEUE: /*@ Take whatever is in stack */ rc = trace("O") /* and write to the screen */ address TSO arg mode . "QSTACK" /* how many stacks? */ stk2dump = rc - tk_init_stacks /* remaining stacks */ if stk2dump = 0 & queued() = 0 then return if mode <> "QUIET" then, say "Total Stacks" rc , /* rc = #of stacks */ " Begin Stacks" tk_init_stacks , /* Stacks present at start */ " Excess Stacks to dump" stk2dump do dd = rc to tk_init_stacks by -1 /* empty each one. */ if mode <> "QUIET" then, say "Processing Stack #" dd " Total Lines:" queued() do queued();parse pull line;say line;end /* pump to the screen */ "DELSTACK" /* remove stack */ end /* dd = 1 to rc */ return /*@ DUMP_QUEUE */ /* Handle CLIST-form keywords added 20020513 . ----------------------------------------------------------------- */ CLKWD: Procedure expose info /*@ hide all except info */ arg kw kw = kw"(" /* form is 'KEY(DATA)' */ kw_pos = Pos(kw,info) /* find where it is, maybe */ if kw_pos = 0 then return "" /* send back a null, not found*/ rtpt = Pos(") ",info" ",kw_pos) /* locate end-paren */ slug = Substr(info,kw_pos,rtpt-kw_pos+1) /* isolate */ info = Delstr(info,kw_pos,rtpt-kw_pos+1) /* excise */ parse var slug (kw) slug /* drop kw */ slug = Reverse(Substr(Reverse(Strip(slug)),2)) return slug /*@CLKWD */ /* Handle multi-word keys 20020513 . ----------------------------------------------------------------- */ KEYWD: Procedure expose info /*@ hide all vars, except info*/ arg kw kw_pos = wordpos(kw,info) /* find where it is, maybe */ if kw_pos = 0 then return "" /* send back a null, not found*/ kw_val = word(info,kw_pos+Words(kw))/* get the next word */ info = Delword(info,kw_pos,2) /* remove both */ return kw_val /*@ KEYWD */ /* . ----------------------------------------------------------------- */ KEYPHRS: Procedure expose, /*@ */ info helpmsg exec_name /* except these three */ arg kp wp = wordpos(kp,info) /* where is it? */ if wp = 0 then return "" /* not found */ front = subword(info,1,wp-1) /* everything before kp */ back = subword(info,wp+1) /* everything after kp */ parse var back dlm back /* 1st token must be 2 bytes */ if length(dlm) <> 2 then /* Must be two bytes */ helpmsg = helpmsg, "Invalid length for delimiter("dlm") with KEYPHRS("kp")", info if wordpos(dlm,back) = 0 then /* search for ending delimiter*/ helpmsg = helpmsg, "No matching second delimiter("dlm") with KEYPHRS("kp")", info if helpmsg <> "" then call HELP /* Something is wrong */ parse var back kpval (dlm) back /* get everything b/w delim */ info = front back /* restore remainder */ return Strip(kpval) /*@ KEYPHRS */ /* . ----------------------------------------------------------------- */ NOVALUE: /*@ */ say exec_name "raised NOVALUE at line" sigl say " " say "The referenced variable is" condition("D") say " " zsigl = sigl signal SHOW_SOURCE /*@ NOVALUE */ /* . ----------------------------------------------------------------- */ SHOW_SOURCE: /*@ */ call DUMP_QUEUE /* Spill contents of stacks -*/ if sourceline() <> "0" then /* to screen */ say sourceline(zsigl) rc = trace("?R") nop exit /*@ SHOW_SOURCE */ /* . ----------------------------------------------------------------- */ SS: Procedure /*@ Show Source */ arg ssbeg ssend . if ssend = "" then ssend = 10 if \datatype(ssbeg,"W") | \datatype(ssend,"W") then return ssend = ssbeg + ssend do ssii = ssbeg to ssend ; say Strip(sourceline(ssii),'T') ; end return /*@ SS */ /* . ----------------------------------------------------------------- */ SWITCH: Procedure expose info /*@ */ arg kw sw_val = Wordpos(kw,info) > 0 /* exists = 1; not found = 0 */ if sw_val then /* exists */ info = Delword(info,Wordpos(kw,info),1) /* remove it */ return sw_val /*@ SWITCH */ /* . ----------------------------------------------------------------- */ SYNTAX: /*@ */ errormsg = exec_name "encountered REXX error" rc "in line" sigl":", errortext(rc) say errormsg zsigl = sigl signal SHOW_SOURCE /*@ SYNTAX */ /* Can call TRAPOUT. . ----------------------------------------------------------------- */ TOOLKIT_INIT: /*@ */ address TSO info = Strip(opts,"T",")") /* clip trailing paren */ parse source sys_id how_invokt exec_name DD_nm DS_nm, as_invokt cmd_env addr_spc usr_tokn parse value "" with tv helpmsg . parse value 0 "ISR00000 YES" "Error-Press PF1" with, sw. zerrhm zerralrm zerrsm if SWITCH("TRAPOUT") then do "TRAPOUT" exec_name parms "(( TRACE R" info exit end /* trapout */ sw.0nested = sysvar("SYSNEST") = "YES" sw.0batch = sysvar("SYSENV") = "BACK" sw.0inispf = sysvar("SYSISPF") = "ACTIVE" parse value KEYWD("TRACE") "N" with tv . if Word(parms,1) = "?" then call HELP /* I won't be back */ "QSTACK" ; tk_init_stacks = rc /* How many stacks? */ parse value SWITCH("BRANCH") SWITCH("MONITOR") SWITCH("NOUPDT") with, branch monitor noupdt . parse value mvsvar("SYSNAME") sysvar("SYSNODE") with, #tk_cpu node . tk_globalvars = "exec_name tv helpmsg sw. zerrhm zerralrm ", "zerrsm zerrlm tk_init_stacks branch monitor ", "noupdt" call LOCAL_PREINIT /* for more opts -*/ return /*@ TOOLKIT_INIT */ /* ))) PLIB PARMS Get start-up numbers )ATTR % TYPE( TEXT ) INTENS( HIGH ) SKIP( ON ) + TYPE( TEXT ) INTENS( LOW ) SKIP( ON ) @ TYPE( TEXT ) INTENS( HIGH ) COLOR( YELLOW ) _ TYPE( INPUT ) INTENS( HIGH ) CAPS( ON ) ! TYPE( INPUT ) INTENS( HIGH ) JUST( RIGHT ) )BODY EXPAND(||) @|-|% Starting Values @|-| %COMMAND ===>_ZCMD %SCROLL ===>_ZAMT+ + + Principal Amount ===>!prin + ( nnnnnnn.nn ) + Start Month ===> !start + ( yyyymm ) + Annual Int Rate ===> !pct + ( nn.nnn ) + Periodic Payment ===> !pmnt + ( nnnnn.nn ) + )INIT .HELP = PARMSH )PROC VER( &PRIN, NB, ENUM ) VER( &START, NB, ENUM ) VER( &PCT, NB, ENUM ) VER( &PMNT, NB, ENUM ) )END ))) PLIB PARMSH Get starting values )ATTR % TYPE( TEXT ) INTENS( HIGH ) SKIP( ON ) + TYPE( TEXT ) INTENS( LOW ) SKIP( ON ) _ TYPE( INPUT ) INTENS( HIGH ) ! TYPE( OUTPUT ) INTENS( HIGH ) SKIP( ON ) @ TYPE( OUTPUT ) INTENS( LOW ) SKIP( ON ) } AREA( SCRL ) EXTEND( ON ) )BODY EXPAND(||) %TUTORIAL |-| Get Starting values |-| TUTORIAL %Next Selection ===>_ZCMD + }hlptxt } )AREA HLPTXT + + Enter values for Principal Amount%(9,2),+the Start-Month%(4-digit year, + %2-digit month),+the Annual Percentage Rate%(5,3),+and the Periodic + Payment%(7,2). + + Values received will be formatted as described here even if (for example) + decimal points and decimal values are omitted. + + When complete,%PF3+to set the values. + )PROC &ZUP = PARMSH &ZCONT = PARMSH )END ))) PLIB AMORT Amortization Schedule )ATTR % TYPE( TEXT ) INTENS( HIGH ) SKIP( ON ) + TYPE( TEXT ) INTENS( LOW ) SKIP( ON ) _ TYPE( INPUT ) INTENS( HIGH ) } TYPE( INPUT ) INTENS( HIGH ) JUST( RIGHT ) ! TYPE( OUTPUT ) INTENS( HIGH ) SKIP( ON ) JUST( RIGHT ) @ TYPE( OUTPUT ) INTENS( LOW ) SKIP( ON ) )BODY EXPAND(||) %|-| Amortization Schedule +|-| %Command ===>_ZCMD %Scroll ===>_ZAMT+ %PF1 for HELP + Prin=}prin + Start=}start + Pct=}pct + Pmnt=}opmnt + + Month Payment NetPmnt CurrInt NewNet TotInt )MODEL !seq !pmnt !netpmnt !currint !newnet !totint + )INIT .HELP = AMORTH )REINIT &endpos = '&prin. &start. &pct. &opmnt.' )PROC *rexx(* prin start pct opmnt endpos,tsoenv ) endpos = Space( prin start pct opmnt,1 ) if startpos <> endpos then exit *endrexx )END ))) PLIB AMORTH Amortization Schedule )ATTR % TYPE( TEXT ) INTENS( HIGH ) SKIP( ON ) + TYPE( TEXT ) INTENS( LOW ) SKIP( ON ) _ TYPE( INPUT ) INTENS( HIGH ) ! TYPE( OUTPUT ) INTENS( HIGH ) SKIP( ON ) @ TYPE( OUTPUT ) INTENS( LOW ) SKIP( ON ) } AREA( SCRL ) EXTEND( ON ) )BODY EXPAND(||) %TUTORIAL |-| Amortization Schedule |-| TUTORIAL %Next Selection ===>_ZCMD }hlptxt } )AREA HLPTXT + + The payment is the same month-to-month except, occasionally, for the last + month, in which the payment is the final payoff amount. This is split on + each line into Net Payment and Current Interest. The New Net Payment is + the prior New Net minus the Net Payment. + + Total Interest paid to date is also shown. + + For reference, the Principal Amount, the Start Month, the Interest + Rate, and the Payment Amount are shown. If any of these are + changed, the schedule will be recalculated with the new values. + )PROC &ZUP = AMORTH &ZCONT = AMORTH )END */