TextCollector subclass:#TerminalView

	instanceVariableNames:'inStream outStream readerProcess shellPid kbdSequences

		escapeSequenceTree currentSequence kbdMap escapeLeadingChars

		numberOfColumns numberOfLines shellTerminateAction rangeStartLine

		rangeEndLine state savedCursor shellCommand shellDirectory

		filterStream'

	classVariableNames:''

	poolDictionaries:''

	category:'Views-TerminalViews'

!

!TerminalView class methodsFor:'documentation'!

documentation

"

    I provide terminal functionality, by forking a command interpreter

    and comunicating with it via a pty.

    I am abstract - concrete terminal characteristics are defined

    by concrete subclasses (see VT52TerminalView).

    [author:]

        Claus Gittinger

    [instance variables:]

        inStream                stream where keyboard input is

                                sent to (connected to shells or commands input)

        outStream               stream where the output of the

                                shell or command arrives

                                (read here and displayed in the view)

        readerProcess           process which reads commands    

                                output and sends it to the view

    [start with:]

        VT52TerminalView openShell

        VT100TerminalView openShell

"

! !

!TerminalView class methodsFor:'defaults'!

defaultIcon

    ^ Image fromFile:'bitmaps/xpmBitmaps/terminal_images/xterm-icon.xpm'

    "Created: / 4.8.1998 / 17:48:18 / cg"

    "Modified: / 4.8.1998 / 17:48:31 / cg"

!

defaultNumberOfColumns

    ^ 80

    "Created: / 4.8.1998 / 17:48:18 / cg"

    "Modified: / 4.8.1998 / 17:48:31 / cg"

!

defaultNumberOfLines

    ^ 25

    "Created: / 4.8.1998 / 17:48:18 / cg"

    "Modified: / 4.8.1998 / 17:48:31 / cg"

! !

!TerminalView class methodsFor:'opening'!

open

    ^ self openShell

    "

     VT100TerminalView open

    "

    "Created: / 10.6.1998 / 15:47:25 / cg"

    "Modified: / 9.7.1998 / 17:55:37 / cg"

!

openDummy

    "for testing purposes only - opens a dummy tty-view, which simply

     echoes whatever is typed in"

    |in vt52|

    vt52 := self new.

    in := ForwardingStream on:''.

    in fwdStream:vt52.

    vt52 inStream:in.

    vt52 outStream:in.

    vt52 open

    "

     self openDummy

    "

!

openOnCommand:aCommandString

    "start a command on a pseudo-TTY, open a terminalView on it

     (i.e. this is kind of an xterm)"

    ^ self openOnCommand:aCommandString onExit:[]

    "

     VT100TerminalView openOnCommand:'ls -l'

    "

    "Created: / 9.7.1998 / 17:50:53 / cg"

    "Modified: / 9.7.1998 / 17:57:41 / cg"

!

openOnCommand:aCommandString onExit:aBlock

    "start a command on a pseudo-TTY, open a terminalView on its output

     (i.e. this is kind of an xterm).

     When the command finishes, evaluate aBlock."

    |in top scr vt52|

    top := StandardSystemView new.

    scr := ScrollableView for:self in:top.

    scr origin:0.0@0.0 corner:1.0@1.0.

    vt52 := scr scrolledView.

    vt52 startCommand:aCommandString.

    vt52 shellTerminateAction:[

        top label:('finished: "' , aCommandString , '"'). aBlock value

    ].

    top extent:(scr preferredExtent).

    top label:('executing: "' , aCommandString , '"').

    top iconLabel:'command'.

    top icon:(self defaultIcon).

    top open.

    ^ vt52

    "

     VT100TerminalView openOnCommand:'ls -lR'

     VT100TerminalView openOnCommand:'vi /etc/hosts'

    "

    "Created: / 9.7.1998 / 17:54:34 / cg"

    "Modified: / 4.8.1998 / 17:49:02 / cg"

!

openOnInput:inStream output:outStream

    "open a terminalView on the given streams (which are typically some

     kind of socket). Keys pressed are sent to inStream, text appearing

     from outStream are displayed in the terminal view.

     This can be used to implement things like rlogin

     or telnet views (if connected to a modem, a call-unix can also be

     implemented this way)."

    |in top scr vt52|

    top := StandardSystemView new.

    scr := ScrollableView for:self in:top.

    scr origin:0.0@0.0 corner:1.0@1.0.

    vt52 := scr scrolledView.

    vt52 inStream:inStream.

    vt52 outStream:outStream.

    vt52 startReaderProcess.

    top extent:(scr preferredExtent).

    top label:'shell'.

    top iconLabel:'shell'.

    top icon:(self defaultIcon).

    top open.

    ^ top

    "Modified: / 4.8.1998 / 17:48:59 / cg"

!

openShell

    "start a shell on a pseudo-TTY, open a terminalView on it

     (i.e. this is kind of an xterm)"

    ^ self openShellIn:nil

    "

     VT100TerminalView openShell

    "

    "Modified: / 21.7.1998 / 18:24:55 / cg"

!

openShellIn:aDirectory

    "start a shell on a pseudo-TTY, open a terminalView on it

     (i.e. this is kind of an xterm)"

    |in top scr vt52|

    top := StandardSystemView new.

    scr := ScrollableView for:self in:top.

    scr origin:0.0@0.0 corner:1.0@1.0.

    vt52 := scr scrolledView.

    vt52 startShellIn:aDirectory.

    vt52 shellTerminateAction:[top destroy].

    top extent:(scr preferredExtent).

    top label:'shell'.

    top iconLabel:'shell'.

    top icon:(self defaultIcon).

    top open.

    ^ vt52

    "

     VT100TerminalView openShellIn:'/etc'

    "

    "Created: / 20.7.1998 / 18:28:15 / cg"

    "Modified: / 4.8.1998 / 17:48:54 / cg"

! !

!TerminalView class methodsFor:'queries'!

isVisualStartable

    "returns whether this application class can be started via #open"

    self == TerminalView ifTrue:[^ false].

    ^ true

    "Created: / 10.6.1998 / 15:48:43 / cg"

! !

!TerminalView methodsFor:'accessing'!

inStream

    "return the value of the instance variable 'inStream' (automatically generated)"

    ^ inStream!

inStream:something

    "set the value of the instance variable 'inStream' (automatically generated)"

    inStream := something.!

outStream

    "return the value of the instance variable 'outStream' (automatically generated)"

    ^ outStream!

outStream:something

    "set the value of the instance variable 'outStream' (automatically generated)"

    outStream := something.!

readerProcess

    "return the value of the instance variable 'readerProcess' (automatically generated)"

    ^ readerProcess

!

shellTerminateAction:aBlock

    "set the block which is evaluated when the shell terminates.

     Can be used to close down the application in this case."

    shellTerminateAction := aBlock.

    "Created: / 12.6.1998 / 17:02:58 / cg"

! !

!TerminalView methodsFor:'cursor handling'!

cursorCol:col

    "check of col is a valid cursor position; return a new col-nr if not.

     Here, the linelength is enforced"

    ^ super cursorCol:(col min:numberOfColumns)

    "Modified: / 10.6.1998 / 15:09:34 / cg"

!

cursorDown:n

    cursorLine + n > list size ifTrue:[

        list := list , (Array new:n).

        self textChanged.

    ].

    super cursorDown:n

    "Modified: / 10.6.1998 / 17:18:41 / cg"

    "Created: / 10.6.1998 / 17:18:50 / cg"

!

cursorLine:l col:col

    "check of col is a valid cursor position; return a new col-nr if not.

     Here, the linelength is enforced"

    ^ super cursorLine:l col:(col min:numberOfColumns)

    "Modified: / 10.6.1998 / 15:09:38 / cg"

!

cursorMovementAllowed

    "return true, if the user may move the cursor around

     (via button-click, or cursor-key with selection).

     Here false is returned - the cursor is only moved by

     cursor positioning escape sequences arriving from the

     stream."

    ^ false

    "Created: / 18.6.1998 / 14:12:02 / cg"

!

numberOfTerminalColumns

    ^ numberOfColumns

    "Created: / 5.5.1999 / 11:46:25 / cg"

!

numberOfTerminalLines

    "/ be careful - this is NOT called numberOfLines,

    "/ since that would interfere with numberOfLines as defined

    "/ in ListView ...

    "/ ... one of the bad sides of subclassing

    ^ numberOfLines

    "Created: / 5.5.1999 / 11:46:18 / cg"

    "Modified: / 5.5.1999 / 11:47:24 / cg"

!

restoreCursor

    |l c|

    l := savedCursor y.

    c := savedCursor x.

    self cursorLine:l col:c.

    "Created: / 14.8.1998 / 13:49:24 / cg"

!

saveCursor

    savedCursor := cursorCol @ cursorLine

    "Created: / 14.8.1998 / 13:48:45 / cg"

    "Modified: / 14.8.1998 / 13:49:32 / cg"

!

validateCursorCol:col inLine:line

    "check of col is a valid cursor position; return a new col-nr if not.

     Here, the linelength is enforced"

    ^ col min:numberOfColumns

    "Modified: / 10.6.1998 / 15:09:41 / cg"

! !

!TerminalView methodsFor:'defaults'!

anyKeyCodes

    ^ IdentityDictionary withKeysAndValues:

        #(

             #Escape      '\e'

             #BackSpace   '\b'

             #Return      '\r'

             #Delete      '\0177'

             #Tab         '\t'

         )

    "Created: / 5.5.1999 / 15:00:37 / cg"

! !

!TerminalView methodsFor:'event handling'!

computeNumberOfLinesShown

    |prevNLines prevNCols|

    prevNCols := (innerWidth // font width).

    prevNLines := nFullLinesShown.

    super computeNumberOfLinesShown.

    ((innerWidth // font width) ~~ prevNCols

    or:[prevNLines ~~ nFullLinesShown]) ifTrue:[

        self defineWindowSize.

    ]

    "Created: / 12.6.1998 / 22:34:39 / cg"

    "Modified: / 20.6.1998 / 19:45:28 / cg"

!

defineWindowSize

    numberOfColumns := (innerWidth // font width).

    delta := numberOfLines - rangeEndLine.

    numberOfLines := nFullLinesShown.

    rangeEndLine notNil ifTrue:[

        rangeEndLine := numberOfLines - delta.

    ].

    OperatingSystem isUNIXlike ifTrue:[

        "/

        "/ tell the pty;

        "/ tell the shell;

        "/

        (inStream notNil 

        and:[inStream isExternalStream

        and:[inStream isOpen]]) ifTrue:[

"/        Transcript showCR:'VT100: changed len to ', numberOfLines printString.

            (OperatingSystem 

                setWindowSizeOnFileDescriptor:inStream fileDescriptor

                width:numberOfColumns

                height:numberOfLines) ifFalse:[

"/            Transcript showCR:'VT100: cannot change windowSize'.

            ].

        ].

        shellPid notNil ifTrue:[

            OperatingSystem sendSignal:OperatingSystem sigWINCH to:shellPid

        ]

    ].

    "Created: / 11.6.1998 / 22:51:39 / cg"

!

keyPress:aKey x:x y:y

    |rest event rawKey seq|

    "/ somewhat complicated, since some characters

    "/ should go untranslated (CTRL-key),

    "/ even if defined as function keys.

    inStream isNil ifTrue:[^ self].

"/ Transcript showCR:'----'; show:'key:' ; showCR:aKey printString.

    aKey isCharacter ifTrue:[

        "/ send it down to inStream ...

        inStream nextPut:aKey.

        ^ self

    ].

    "/

    "/ common translations (Tab, Backspace, F-keys etc.)

    "/

    seq := kbdSequences at:aKey ifAbsent:nil.

    seq notNil ifTrue:[

"/ Transcript show:'->' ; showCR:seq storeString.

        inStream nextPutAll:(seq withEscapes).

        ^ self

    ].

    self sensor ctrlDown ifTrue:[

        event := WindowGroup lastEventQuerySignal query.

        rawKey := 'Ctrl' , event rawKey.

    ] ifFalse:[

        rawKey := self keyboardMap keyAtValue:aKey ifAbsent:aKey.

    ].

    "/

    "/ care for function-keys, which are mapped to Ctrl-x;

    "/

"/ Transcript show:'raw ->' ; showCR:rawKey storeString.

    seq := kbdSequences at:rawKey ifAbsent:nil.

    seq notNil ifTrue:[

"/ Transcript show:'->' ; showCR:seq storeString.

        inStream nextPutAll:(seq withEscapes).

        ^ self

    ].

    (rawKey startsWith:'Ctrl') ifTrue:[

        rest := rawKey copyFrom:5.

        rest size == 1 ifTrue:[

            rest := rest at:1.

            (rest >= $a and:[rest <= $z]) ifTrue:[

"/ Transcript show:'->' ; showCR:(Character value:(rest - $a + 1)) storeString.

                inStream nextPut:(Character value:(rest - $a + 1)).

                ^ self

            ].