' PROGRES(2.1)  Display File Proc Progress Indicator   06/27/1994-03/26/2003
' --------------------------------------------------------------------------
' Copyright (C) 1994-2003 by Vladimir Veytsel                  www.davar.net

' Type ---------------------------------------------------------------------

'    Routine

' Declaration --------------------------------------------------------------

'    DECLARE SUB PROGRES(File%,Nam$,Title$,Record$,Mode$,Appear$)

' Parameters ---------------------------------------------------------------

'    File%    - File number (as it was opened in calling program)
'    Name$    - Program name and version (E.g.: "CONVERT(0.0)")
'    Title$   - Process title string (truncated to 64 chars if longer)
'    Record$  - Current input record
'    Mode$    - Progress indicator display mode:
'               S  - Start
'               P  - Progress
'               F  - Finish (any value different from "S" or "P" is equivalent to "F")
'    Appear$  - Appearance control string (fixed structure 6-character):
'               ÚÄÄÄÄÄÄÄ Incomplete symbol          (Default: "")
'               ³ÚÄÄÄÄÄÄ Complete   symbol          (Default: "þ")
'               ³³ÚÄÄÄÄÄ Incomplete color attribute (Default: "E"  - Yellow)
'               ³³³ÚÄÄÄÄ Complete   color attribute (Default: "B"  - Bright Cayan)
'               ³³³³ÚÄÄÄ Running    color attribute (Default: "A"  - Bright Green)
'               ³³³³³ÚÄÄ Background color attribute (Default: "0"  - Black)
'               123456
'               þEBA0 - Default appearance control string (padded with blanks)
'                        Individual blanks default to corresponding symbols
'                 Note:  This parameter is processed only in "Start" mode
'                        (in "Progres" and "Finish" mode it is ignored)

' Notes --------------------------------------------------------------------

'  - Routine is intended for use in file processing/conversion procedures
'    running from DOS prompt and showing processing progress on DOS screen.
'  - Use it with short running (about 1 minute) procedures.
'  - For long procedures see routine PROGRTM (with elapsed/left time display).
'  - Rotating indicator wheel is synchronized with completeness % display.

' Examples -----------------------------------------------------------------

'    Start: CALL PROGRES(1,"CONVERT(0.0)","File...","","S","þEBA0")  - After OPEN

'    CONVERT(0.0)  File SOURCE.TXT is converted to TARGET.TXT
'         0% [Ä]   

'    Progress: CALL PROGRES(1,"","",Input.Record$,"P","")  - After every LINE INPUT

'    CONVERT(0.0)  File SOURCE.TXT is converted to TARGET.TXT
'        50% [|]   þþþþþþþþþþþþþþþþþþþþþ

'    Finish: CALL PROGRES(1,"","","","F","")  - After encountering EOF

'    CONVERT(0.0)  File SOURCE.TXT is converted to TARGET.TXT
'       100% [*]   þþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþþ

' Start Routine ------------------------------------------------------------

     DEFINT A-Z     ' All defaulted variables are integer
     OPTION BASE 1  ' Default array indexation starts from "1"

     SUB PROGRES(File%,Nam$,Title$,Record$,Mode$,Appear$) STATIC PUBLIC

     DIM Wheel$(4)

' Initialize Routine Constants (Start) -------------------------------------

     SELECT CASE (UCASE$(Mode$))
            CASE ("S")
                 Wheel$(1)="Ä"
                 Wheel$(2)="\"
                 Wheel$(3)="|"
                 Wheel$(4)="/"
                 IF (LEN(Appear$)=0) THEN
                    App$="þEBA0"
                 ELSE
                    App$=Appear$+"      "
                 END IF
                 Incompl.Symb$    =MID$(App$,1,1)
                 Complete.Symb$   =MID$(App$,2,1)
                 Incompl.Color$   =MID$(App$,3,1)
                 Complete.Color$  =MID$(App$,4,1)
                 Running.Color$   =MID$(App$,5,1)
                 Background.Color$=MID$(App$,6,1)
                 IF (Incompl.Symb$    =" ") THEN Incompl.Symb$    =""
                 IF (Complete.Symb$   =" ") THEN Complete.Symb$   ="þ"
                 IF (Incompl.Color$   =" ") THEN Incompl.Color$   ="E"
                 IF (Complete.Color$  =" ") THEN Complete.Color$  ="B"
                 IF (Running.Color$   =" ") THEN Running.Color$   ="A"
                 IF (Background.Color$=" ") THEN Background.Color$="0"
                 Incompl.Color   =VAL("&H"+Incompl.Color$)
                 Complete.Color  =VAL("&H"+Complete.Color$)
                 Running.Color   =VAL("&H"+Running.Color$)
                 Background.Color=VAL("&H"+Background.Color$)

' Display Initial Processing Progress Message ------------------------------

     File.Size!=LOF(File%)   ' Get input file size
     IF (LEN(Title$)>57) THEN Title$=LEFT$(Title$,57)
     Title.Len=LEN(Title$)
     Percent.Pos=LEN(Nam$)-8
     Time.Pos=LEN(Nam$)+LEN(Title$)+5
     Share!=File.Size!/Title.Len
     IF (Share!=0) THEN Share!=1
     Limit!=Share!
     COLOR Complete.Color,Background.Color
     PRINT Nam$;"  ";Title$
     PRINT TAB(Percent.Pos);"  0% [";Wheel$(1);"]   ";
     COLOR Incompl.Color,Background.Color
     PRINT STRING$(Title.Len,Incompl.Symb$);
     Length.Ratio!=Title.Len/File.Size!
     Curs.Line=CSRLIN

' Redisplay Processing Progress Message ------------------------------------

     CASE ("P")
          Curr.Size!=Curr.Size!+LEN(Record$)+2
          Percent.Compl=Curr.Size!/File.Size!*100
          LOCATE ,Percent.Pos
          COLOR Running.Color,Background.Color
          PRINT USING "###";Percent.Compl;
          PRINT "% [";Wheel$((Percent.Compl MOD 4)+1);"]   ";
          IF (Curr.Size!>Limit!) THEN
             COLOR Complete.Color,Background.Color
             PRINT STRING$(Curr.Size!*Length.Ratio!,Complete.Symb$);
             Counter=Counter+1
             Limit!=Counter*Share!
          END IF

' Redisplay Process Finish Message -----------------------------------------

     CASE ELSE
          COLOR Complete.Color,Background.Color
          LOCATE Curs.Line,Percent.Pos
          PRINT "100% [*]   ";STRING$(Title.Len,Complete.Symb$)

     END SELECT

' Finish Routine -----------------------------------------------------------

     END SUB