BECOM Installation Instruction

What is BECOM

BECOM - BEtter COde Maker - is a group of programs written on P4GL and available in source-codes, which suppose to make your P4GL code looking better, more clear, readable and understandable. It has several different groups of modules - main modules group (common for everyone and everywhere), rules group (actual programs modifying the source code), and setup group (becom.ini file).

BECOM is an open to expand/update its functionality program. You can do it modifying/adding files of the rules group and reconfiguring the becom.ini file.

Any feedback is welcome: ysetko@progress-plus.com

What Can It Do

(and changes history)

v.1.03.04, Nov 12, 2003

Changes to becom.p contributed by Stefan Houtzager: BECOM is made able to handle texts greater than 32K size.
Fixed bug on F12 with no selected text in the editor, and added a message asking to apply BECOM or to not.

v.1.03.03, Oct 02, 2003

Added exceptions for PROMPT and ASC keywords to changeCase.p rule.

v.1.03.02, Jul 21, 2003

addNoUndo.p rule - added to BECOM. The rule adds NO-UNDO to every DEFINE VARIABLE and DEFINE * PARAMETER statement (skips all shared variables definition for purpose). In a case you want it to stay as UNDO you can specify SKIP-NO-UNDO keyword in comments beside the variable/parameter definition:
DEFINE INPUT PARAMETER cMode AS CHARACTER NO-UNDO. /* SKIP-NO-UNDO */
some limitations apply - see comments in rule module source-code.

v.1.03.01, Apr 01, 2003

alignCode.p rule - added QueryAlignType - "one-column" / "multi-column"

v1.03.00, Mar 30, 2003:

Two new rules MergeLine.p and beautyCode.p were contributed by Serguey Klimoff, along with many changes and improvements to the existing rules, procedures and functions.
Visual Diff procedure call is added to show the difference between the original source code and the code modified by BECOM.

v1.02.02, Feb 10, 2003:

becompf.p - procedures getNextLineNum and getPrevLineNum - fixed bugs when searching the very first line of the list.

v1.02.01, Jan 20, 2003:

alignBrackets.p rule has been renamed into alignSpaces.p cause it's not about brackets only anymore, it aligns left and right commas' spaces now as well.

v1.02.00, Jan 16, 2003:

new rule has been added to BECOM: alignBrackets.p, which suppose to aligns the bracket adding/removing spaces where required; works for ( ) and [ ] brackets where the brackets pairs setup can be configured separately.

v1.01.01, Dec 09, 2002:

recognizing IF .. THEN .. ELSE statement in WHERE phrases;
added EXPORT, PUT, FUNCTION, FORM, ENABLE, DISABLE statements to alignCode rule

v1.01.00, Dec 06, 2002:

splits source-code lines containing more than one P4GL statement;

Initial Version v1.00.00, Dec 04, 2002:

applies code formatting to the highlighted in the Procedure editor or the Section editor lines;
replaces leading TABs by spaces;
cuts line ending spaces;
aligns the source code shifting blocks and ASSIGN-like sections;
replaces the P4GL keywords by UPPER or lower case full or the same length keywords;
skips comments and quoted strings;
keeps initial line shift equal to the first highlighted code line shift;

Features

Splits line containing more than one statement:

MESSAGE “a”. RETURN.

will be:
MESSAGE “a”.
RETURN.

changes P4GL statements case to upper-case or to the lower-case:

Define Variable a as int.

will be:
DEFINE VARIABLE a AS INTEGER.

or:
define variable a as integer.

adds/removes spaces before/after brackets ( ) [ ] and commas

cStr = getStr(sourceStr,iParam[i], getNextLineNum(iLineNum)).
      
will be:
cStr = getStr( sourceStr, iParam[ i ], getNextLineNum( iLineNum ) ).

replaces short keywords by its full name:

def var a as int.

will be:
DEFINE VARIABLE a AS INTEGER.

aligns source-code blocks:

DO WHILE i < 10:
   i = i + 1.
    END. 

will be:
DO WHILE i < 10:
    i = i + 1.
END.

aligns IF/THEN/ELSE statements:

IF YES THEN DO:
  MESSAGE "a".
END. ELSE
  IF YES THEN MESSAGE "b". ELSE MESSAGE "c".
  IF NOT YES AND NOT NO THEN MESSAGE "d". ELSE MESSAGE "e".

will be:
IF YES THEN
DO:
    MESSAGE "a".
END.
ELSE
  IF YES THEN
  MESSAGE "b".
ELSE
  MESSAGE "c".
IF NOT YES AND NOT NO THEN
  MESSAGE "d".
ELSE
  MESSAGE "e".

aligns data definition code sections:

def input param s-value as char no-undo.
def input-output param err-msg as char no-undo.
def output param ferr as log. 

will be:
DEFINE INPUT        PARAMETER s-value AS CHARACTER NO-UNDO.
DEFINE INPUT-OUTPUT PARAMETER err-msg AS CHARACTER NO-UNDO.
DEFINE OUTPUT       PARAMETER ferr    AS LOG.

splits long source-code lines into the several short lines:

run CheckField(buffer xattr,if wh:screen-value = "?" then "" else wh:screen-value,input-output err-msg,output ferr).
      
will be:
RUN CheckField( BUFFER xattr, IF wh:SCREEN-VALUE = "?" THEN "" ELSE
      wh:SCREEN-VALUE, INPUT-OUTPUT err-msg, OUTPUT ferr ).

removes pseudocomments from the source-code:

{{&postfind}{&*} &norepaint=/*}

will be:
{{&postfind}{&*} &norepaint=”/*”}

adds NO-UNDO to DEFINE VARIABLE and DEFINE PARAMETER statements:

This code:
DEFINE INPUT PARAMETER cMode AS CHARACTER. 
DEFINE VARIABLE lAddNO-UNDO AS LOGICAL INIT TRUE.
DEFINE VARIABLE cCodeCase AS CHARACTER.
DEFINE VARIABLE cmyUndoVariable AS CHARACTER. /* SKIP-NO-UNDO */


will be replaced by:      


DEFINE INPUT PARAMETER cMode    AS CHARACTER NO-UNDO.
DEFINE VARIABLE lAddNO-UNDO     AS LOGICAL   NO-UNDO INITIAL TRUE.
DEFINE VARIABLE cCodeCase       AS CHARACTER NO-UNDO.
DEFINE VARIABLE cmyUndoVariable AS CHARACTER. /* SKIP-NO-UNDO */

BECOM Installation Instruction

Unzip the BECOM.zip into any directory included into your PROPATH.
Open BECOM directory and copy file _ADEEVNT.P into your $DLC\gui\adecomm. Compile it there.
Restart your Progress AB or Procedure editor session. It's ready to use now.

How to use

Open a file in Procedure editor, or AB (open the section editor) , or even Data Dictionary Table Trigger editor;
Highlight the code you want to apply BECOM to:

Press F12;
Choose Yes or No to replace the highlighted code by the showed modified one:

Press CTRL-F12 anywhere in Progress session to open the BECOM Configuration Setup window:

Environment

Tested so far on Win NT, Win 2000, Progress v9.1.

Where to download BECOM

You can always download the latest available BECOM version from here :

http://www.progress-plus.com/dnld.htm

Subscribe also to BECOM e-mail list about the new releases, bugs reports, users' opinions etc. :

http://www.progress-plus.com/emaillists.htm

Third Parties

Since June 11, 2003 BECOM is integrated into KSV Editor and can be installed as one single pre configured package from http://www.bulklodd.ru/ksvedit/ .

Miscellaneous

Most of the BECOM source-code is formatted by BECOM.

If you have a bug fixed or a new rule written, please send me a copy of what you have done. I'll include it into the BECOM distributive along with your name as the author of the changes done.

Other Tools and Utilities from PROGRESS PLUS SOLUTIONS

PRO4m - Progress Applications/Databases Analysis and Reengeneering

ProAppmon - Progress Applications Monitoring

KTEST - Progress 4GL, Database design and many more online tests

- all available on http://www.progress-plus.com