"

 COPYRIGHT (c) 1998 by eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libwidg2' }"

TerminalView subclass:#VT100TerminalView

	instanceVariableNames:'currentParam parameters lastCursorLine'

	classVariableNames:'TraceCSI'

	poolDictionaries:''

	category:'Views-TerminalViews'

!

!VT100TerminalView class methodsFor:'documentation'!

ansiEscapes

"

   see also: http://www.vt100.net/docs/vt100-ug/chapter3.html

                              ANSI ESCAPE SEQUENCES

===============================================================================

Wherever you see '#', that should be replaced by the appropriate number.

        ESC code sequence                       Function

       -------------------              ---------------------------

Cursor Controls:

         ESC[#;#H or ESC[#;#f           Moves cusor to line #, column #

         ESC[#A                         Moves cursor up # lines

         ESC[#B                         Moves cursor down # lines

         ESC[#C                         Moves cursor forward # spaces

         ESC[#D                         Moves cursor back # spaces

         ESC[#;#R                       Reports current cursor line & column

         ESC[s                          Saves cursor position for recall later

         ESC[u                          Return to saved cursor position

Erase Functions:

         ESC[2J                         Clear screen and home cursor

         ESC[K                          Clear to end of line

Set Graphics Rendition:

         ESC[#;#;....;#m                Set display attributes where # is

                                            0 for normal display

                                            1 for bold on

                                            4 underline (mono only)

                                            5 blink on

                                            7 reverse video on

                                            8 nondisplayed (invisible)

                                            30 black foreground 

                                            31 red foreground 

                                            32 green foreground 

                                            33 yellow foreground 

                                            34 blue foreground 

                                            35 magenta foreground 

                                            36 cyan foreground 

                                            37 white foreground

                                            40 black background

                                            41 red background

                                            42 green background

                                            43 yellow background

                                            44 blue background

                                            45 magenta background

                                            46 cyan background

                                            47 white background

         ESC[=#;7h or                   Put screen in indicated mode where # is

         ESC[=h or                          0 for 40 x 25 black & white

         ESC[=0h or                         1 for 40 x 25 color

         ESC[?7h                            2 for 80 x 25 b&w

                                            3 for 80 x 25 color

                                            4 for 320 x 200 color graphics

                                            5 for 320 x 200 b & w graphics

                                            6 for 640 x 200 b & w graphics

                                            7 to wrap at end of line 

         ESC[=#;7l or ESC[=l or         Resets mode # set with above command

         ESC[=0l or ESC[?7l

Keyboard Reassignments:

         ESC[#;#;...p                   Keyboard reassignment. The first ASCII

         or ESC[""string""p               code defines which code is to be 

         or ESC[#;""string"";#;           changed. The remaining codes define

            #;""string"";#p               what it is to be changed to.

         E.g. Reassign the Q and q keys to the A and a keys (and vice versa).

         ESC [65;81p                    A becomes Q

         ESC [97;113p                   a becomes q

         ESC [81;65p                    Q becomes A

         ESC [113;97p                   q becomes a

         E.g. Reassign the F10 key to a DIR command.

         ESC [0;68;""dir"";13p            The 0;68 is the extended ASCII code 

                                        for the F10 key and 13 is the ASCII

                                        code for a carriage return.

         Other function key codes       F1=59,F2=60,F3=61,F4=62,F5=63

                                        F6=64,F7=65,F8=66,F9=67,F10=68

"

!

copyright

"

 COPYRIGHT (c) 1998 by eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    A VT100 terminal emulator.

    Most of the functionality is inherited from my superclass,

    I redefine/specialize certain methods for VT100 escape sequences

    and vt100 keyboard codes

    BUGS:

        VT100 wrapMode (at right margin) is not supported

        this may lead to wrong display when a vi is started in a small window.

    [start with:]

        VT100TerminalView openShell

    [see also:]

        VT52TerminalView

        TelnetTool

"

! !

!VT100TerminalView methodsFor:'defaults'!

colorAtIndex:idx

    |colorName colorModifier clr|

    colorName := #(black red green yellow blue magenta cyan white) at:idx.

    self backgroundColor brightness < 0.5 ifTrue:[

        "/ dark backgrounds

        colorModifier := #(nil nil nil nil lightened nil nil nil) at:idx.

    ] ifFalse:[

        "/ bright backgrounds

        colorModifier := #(nil nil darkened darkened nil darkened darkened nil) at:idx.

    ].

    clr := Color perform:colorName.

    colorModifier notNil ifTrue:[

        clr := clr perform:colorModifier

    ].

    ^ clr

!

vt100AlternativeKeyCodes

    "return the alternative vt100 keyCode table"

    ^ IdentityDictionary withKeysAndValues:

        #(

             #CursorUp    '\eOA'

             #CursorDown  '\eOB'

             #CursorRight '\eOC'

             #CursorLeft  '\eOD'

             #Home        '\eOH'

             #Escape      '\e'

             #BackSpace   '\b'

             #Return      '\r'

             #Delete      '\0177'

             #Tab         '\t'

             #F1          '\eOP'

             #F2          '\eOQ'

             #F3          '\eOR'

             #F4          '\eOS'

             #F5          '\eOt'

             #F6          '\eOu'

             #F7          '\eOv'

             #F8          '\eOl'

             #F9          '\eOw'

         )

!

vt100KeyCodes

    "return a vt100 keyCode table"

    ^ IdentityDictionary withKeysAndValues:

        #(

             #CursorUp    '\e[A'

             #CursorDown  '\e[B'

             #CursorRight '\e[C'

             #CursorLeft  '\e[D'

             #Home        '\e[H'

             #Escape      '\e'

             #BackSpace   '\b'

             #Return      '\r'

             #Delete      '\0177'

             #Tab         '\t'

             #F1          '\eOP'

             #F2          '\eOQ'

             #F3          '\eOR'

             #F4          '\eOS'

             #F5          '\eOt'

             #F6          '\eOu'

             #F7          '\eOv'

             #F8          '\eOl'

             #F9          '\eOw'

         )

    "Created: / 10.6.1998 / 15:13:01 / cg"

    "Modified: / 5.5.1999 / 15:01:32 / cg"

! !

!VT100TerminalView methodsFor:'functions'!

addLines

    "Add the appropriate number of blank lines (param 1) 

     at the cursor position."

    self addLines:((parameters at:1) max:1).

    self endOfSequence

    "Created: / 10.6.1998 / 14:48:03 / cg"

!

addLines:aNumber

    "Add aNumber blank lines at the position indicated by the cursor."

    aNumber timesRepeat:[

        self insertLine:'' before:cursorLine

    ]

    "Created: / 10.6.1998 / 14:49:30 / cg"

!

autoMargin:aBoolean

    "set/clear autowrap at end of line (not yet implemented)"

    autoWrapFlag := aBoolean

!

clearLines:arg

    "Clear some part of the current line, as indicated by the first parameter:

     0 - clear to EOL

     1 - clear from beginning to cursorCol

     2 - clear entire line

    "

    arg = 0 ifTrue: [^self doClearToEndOfLine].

    arg = 1 ifTrue: [^self doClearFromBeginningOfLine].

    arg = 2 ifTrue: [^self doClearEntireLine]

    "Created: / 10.6.1998 / 14:44:22 / cg"

    "Modified: / 21.7.1998 / 20:07:42 / cg"

!

deleteCharacters

    "Delete the appropriate number of characters (param 1)

     at the cursor position."

    |n|

    n := ((parameters at: 1) max: 1).

    self deleteFromLine:cursorLine col:cursorCol toLine:cursorLine col:cursorCol+n-1.

    "Created: / 12.6.1998 / 21:19:02 / cg"

    "Modified: / 12.6.1998 / 21:19:15 / cg"

!

deleteLines

    "Delete the appropriate number of lines (param 1)

     at the cursor position."

    |n|

    n := ((parameters at: 1) max: 1).

self halt:'untested code'.

    self deleteFromLine:cursorLine toLine:cursorLine+n-1.

!

displayMode:p1

    "Set the current display mode (emphasis) as specified by param 1."

"/    self endEntry.    -- not needed (does not affect characters on screen or buffered or cursor position

    p1 == 0 ifTrue:[

        self normal.

        ^ self.

    ].

    p1 == 1 ifTrue:[

        "/ ESC-[-1-m  -> bold

        "/ workaround: windows bold fonts are

        "/ wider, leading to ugly looking output

        "/ Therefore, use red color instead of bold

        device platformName = 'WIN32' ifTrue:[

        ] ifFalse:[

            self bold.

        ].

        ^ self.

    ].

    p1 == 4 ifTrue:[

        "/ ESC-[-4-m  -> underline

        self underline.

        ^ self.

    ].

    p1 == 5 ifTrue:[

        "/ ESC-[-5-m  -> blink

        self color:Color blue.

        ^ self.

    ].

    p1 == 7 ifTrue:[

        "/ ESC-[-7-m  -> reverse

        self reverse.

        ^ self.

    ].

    p1 == 8 ifTrue:[

        "/ ESC-[-8-m  -> invisible

        ^ self.

    ].

    (p1 between:30 and:37) ifTrue:[

        "/ ESC-[-30-m  -> black fg color

        "/ ESC-[-31-m  -> red   fg color

        "/ ...

        "/ ESC-[-37-m  -> white fg color

        ^ self.

    ].

    p1 == 39 ifTrue:[

        "/ normal fg color

        self color:nil.

        ^ self

    ].

    (p1 between:40 and:47) ifTrue:[

        "/ ESC-[-40-m  -> black bg color

        "/ ...

        "/ ESC-[-47-m  -> white bg color

        ^ self.

    ].

    p1 == 49 ifTrue:[

        "/ normal fg color

        self bgColor:nil.

        ^ self

    ].

    (p1 between:90 and:97) ifTrue:[

        ^ self.

    ].

    (p1 between:100 and:107) ifTrue:[

        ^ self.

    ].

    "/ ESC-[-any-m  -> normal

    self normal.

    "Created: / 10.6.1998 / 15:01:16 / cg"

    "Modified: / 5.5.1999 / 00:53:15 / cg"

!

doClearDisplay:arg

    "Clear some part of the current screen, as indicated by the first parameter.

     0 - clear to endOfScreen

     1 - clear from beginning of screen to cursorCol

     2 - clear entire screen

    "

    arg = 0 ifTrue: [^self doClearToEndOfScreen].

    arg = 1 ifTrue: [^self doClearFromBeginningOfScreen].

    arg = 2 ifTrue: [^self doClearEntireScreen]

    "Created: / 21.7.1998 / 20:05:07 / cg"

    "Modified: / 21.7.1998 / 20:07:36 / cg"

!

doCursorNextLine:n

    self halt:'unimplemented function'.

!

doCursorPreviousLine:n

    self halt:'unimplemented function'.

!

insertCharacters

    "Insert the appropriate number of spaces (param 1) at the cursor position."

    |s|

    s := String new:((parameters at: 1) max: 1).

    self insertStringWithoutCRs:s atLine:cursorLine col:cursorCol.

    "Modified: / 12.6.1998 / 21:14:25 / cg"

    "Created: / 28.7.1998 / 00:53:51 / cg"

!

insertLines

    "Insert the appropriate number of lines (param 1) at the cursor position."

    |n|

    n := (parameters at: 1) max: 1.

    self halt:'untested code'.

    self insertLines:(Array new:n) before:cursorLine

!

move

    "Move to the locations indicated by the first and second parameters."

    | row column |

    row := (self getParameter:1 withDefault:1).

    column := (self getParameter:2 withDefault:1).

    Debug ifTrue:[

        Transcript show:'move to column/row:'; show:column; show:'/'; showCR:row.

    ].    

    self moveToX:column y:row.

    "Created: / 10.6.1998 / 14:40:01 / cg"

    "Modified: / 20.6.1998 / 18:49:12 / cg"

!

moveToColumn

    "Move to the column indicated by the first."

    | column |

    column := (self getParameter:1 withDefault:1).

    Debug ifTrue:[

        Transcript show:'move to column:'; showCR:column.

    ].    

    self cursorVisibleLine:cursorLine col:column.

!

moveToLine

    "Move to the line indicated by the first param."

    | row |

    row := (self getParameter:1 withDefault:1).

    Debug ifTrue:[

        Transcript show:'move to row:'; showCR:row.

    ].    

    self cursorVisibleLine:row col:cursorCol.

!

moveToX: xLocation y: yLocation

    "Position the cursor at the location given by xLocation and yLocation.

     Ignore the command if the parameters are outside the allowable range."

    Debug ifTrue:[

        Transcript show:'numberOfColumns '; showCR:numberOfColumns.

        Transcript show:'numberOfLines '; showCR:numberOfLines.

    ].

"/    (xLocation < 1 or: [xLocation > numberOfColumns]) ifTrue: [^self].

"/    (yLocation < 1 or: [yLocation > numberOfLines]) ifTrue: [^self].

    self cursorVisibleLine:yLocation col:xLocation.

    "Created: / 10.6.1998 / 14:40:49 / cg"

    "Modified: / 20.6.1998 / 20:27:11 / cg"

!

report