"

 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' }"

"{ NameSpace: Smalltalk }"

TextCollector subclass:#TerminalView

	instanceVariableNames:'inStream outStream readerProcess shellPid kbdSequences

		escapeSequenceTree currentSequence kbdMap escapeLeadingChars

		numberOfColumns numberOfLines shellTerminateAction rangeStartLine

		rangeEndLine state savedCursor shellCommand shellDirectory

		filterStream recorderStream localEcho translateNLToCRNL

		inputTranslateCRToNL inputTranslateCRToCRNL

		inputTranslateBackspaceToDelete autoWrapFlag masterWindow

		alternateKeypadMode noColors sizeOfOutstandingInputToBeProcessed

		lineEditMode lineBuffer lineBufferCursorPosition

		lineBufferHistory lineBufferHistoryPosition maxHistorySize doUTF

		ignoreOutput sendControlKeys

		lastSelectedLineBufferHistoryPosition'

	classVariableNames:'Debug DebugKeyboard DefaultMaxHistorySize'

	poolDictionaries:''

	category:'Views-TerminalViews'

!

!TerminalView class methodsFor:'documentation'!

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

"

    I provide terminal functionality, by interpreting data

    arriving from some stream (typically connected to a command interpreter 

    via a pty, or another system via a modem) and sending my keyboard data to it.

    I am abstract providing general functionality -

    concrete terminal characteristics (i.e. escape sequences) are defined 

    by concrete subclasses (see VT52TerminalView, VT100TerminalView).

    Concrete applications are: 

        consoles (VT100TerminalView),

        telnet-views (see TelnetTool)

        editor wrappers (if you like emacs/vi)

        gdb terminal subviews (see GDBApplication)

    Although my class protocol includes common startup protocol

    (to open a terminalView with a shell or on the output of a command),

    I can be used as a widget within an application (modem software).

    Notice, some of my pty functionality and handling ex beeing extracted to

    the separate TerminalSession class (which allows communicating with a

    program without having its output displayed .   

    So currently, some ugly code duplication is present.

    Once stable, code will be refactored.   

    For now, as terminalView is being used in

    some of our critical applications, this refactoring has not yet been done.

    [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

        lineEditMode            if on, do readLine-alike input history and editong

    [class variables]:

        Debug := true           trace incoming characters

    [start with:]

        VT52TerminalView open

        VT100TerminalView open

        VT52TerminalView openShell

        VT100TerminalView openShell

        VT100TerminalView openOnCommand:'ls -l'

        VT100TerminalView openOnCommand:'dir'

    [see also:]

        TelNetTool

"

!

example

"

    |terminal in out inputLine|

    in := InternalPipeStream new.

    out := InternalPipeStream new.

    terminal := TerminalView openOnInput:in output:out.

    terminal localEcho:true.

    terminal inputTranslateCRToNL:true.

    out nextPutLine:'Hello world - please type at me:'.

    [

        inputLine := in nextLine asString.

        inputLine ~= '#exit' ifTrue:[

            out nextPutLine:(Compiler evaluate:inputLine) printString.

        ].

        inputLine = '#exit'

    ] whileFalse.

    terminal topView destroy.

"

! !

!TerminalView class methodsFor:'initialization'!

initialize

    Debug := DebugKeyboard := false.

    DefaultMaxHistorySize := 1000.

    "

     self initialize

    "

! !

!TerminalView class methodsFor:'defaults'!

defaultIcon

    "This resource specification was automatically generated

     by the ImageEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the ImageEditor may not be able to read the specification."

    "

     self defaultIcon inspect

     ImageEditor openOnClass:self andSelector:#defaultIcon

     Icon flushCachedIcons

    "

    <resource: #image>

    ^Icon

        constantNamed:'TerminalView defaultIcon'

        ifAbsentPut:[(Depth4Image new) width:48; height:36; bits:(ByteArray fromPackedString:'

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@CL3L3L3L3L3L3L3L3L0@@@@@@@@@@@@@5UUUUUUUUUUUUUUUUUS@@@@@@@@@@@@MUUUUUUUUUUUUUUUUUUU

DP@@@@@@@@@@MUQDQDQDQDQDQDQDQEUUDP@@@@@@@@@@MUQDQDQDQDQDQDQDQDUUDQ@@@@@@@@@@MUQBIBQBP"H$P$QDQDUUDQ@@@@@@@@@@MUQDQDQDQDQD

QDQDQDUUDQD@@@@@@@@@MUQBH"P"P"IDQDQDQDUUDQD@@@@@@@@@MUQDQDQDQDQDQDQDQDUUDQDP@@@@@@@@MUQBH"H"H"P"H"QDQDUUDQDP@@@@@@@@MUQD

QDQDQDQDQDQDQDUUDQDP@@@@@@@@MUQBH$H"IBIDH"QDQDUUDQDP@@@@@@@@MUQDQDQDQDQDQDQDQDUUDQDP@@@@@@@@MUQBQDQDQDQDQDQDQDUUDQDP@@@@

@@@@MUQDQDQDQDQDQDQDQDUUDQDP@@@@@@@@MUQBH"P$H"P$QDQDQDUUDQDP@@@@@@@@MUQDQDQDQDQDQDQDQDUUDQDP@@@@@@@@MUQBP"H$QDQDQDQDQDUU

DQDP@@@@@@@@MUUDQDQDQDQDQDQDQEUUDQD@@@@@@@@@MUUUUUUUUUUUUUUUUUUUDQ@@@@@@@@@@@5UUUUUUUUUUUUUUUUUQDP@@@@@@@@@@@@@QDQDQDQDQ

DQDQDQDSL1D@@@@@@@@@@@@CL3L3L3L3L3L3L3L3LQD@@@@@@@@@@@@QDQDQDQDQDQDQDQDQDQD@@@@@@@@@@AUUUUUUUUUUUUUUUUUUDQD3@3@@@@@@@AUU

UUUUUUUUUU@@@@AUDQD@L@L@@@@@DQDQDQDQDQDQDQDQDQUUDQ@@@C@@@@@AUUUUUUUUUUUUUUUUUQDQD@@@@0@@@@@UUUUUUUUUUUUUUUUUTQ@@@@DQDQ@@

@@@UT"H"H"H"H"H"H%UUTQ@@DQDSL1@@@@EUUUUUUUUUUUUUUUUUDP@AEUTQL1@@@AURH"H"H"H"H"H"IUUQD@@AUUUSLP@@@UUUUUUUUUUUUUUUUUTQ@@@A

L3L1D@@@@QDQDQDQDQDQDQDQDQDP@@@ADQDQ@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@') ; colorMapFromArray:#[0 0 0 80 78 80 255 255 255 140 140 140 40 58 10 196 194 190]; mask:((ImageMask new) width:48; height:36; bits:(ByteArray fromPackedString:'

@@@@@@@@@O???>@@@_????@@@?????0@@?????0@@?????8@@?????8@@?????<@@?????<@@?????>@@?????>@@?????>@@?????>@@?????>@@?????>@

@?????>@@?????>@@?????>@@?????>@@?????<@@?????8@@_????0@@C????<@@A????<@@C????<@@O?????X@O????<$@?????8HA????? PC????8G8

C????8?8G????1?8O????!!?0_????A? _???>A?@@@@@@@@@') ; yourself); yourself]

!

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

     VT52TerminalView open

     TerminalView 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."

    |top scr vt|

    top := StandardSystemView new.

    scr := ScrollableView for:self in:top.

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

    vt := scr scrolledView.

    vt masterWindow: top.

    vt startCommand:aCommandString.

    vt shellTerminateAction:[

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

    ].

    top extent:(scr preferredExtent).

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

    top iconLabel:'command'.

    top icon:(self defaultIcon).

    top open.

    ^ vt

    "

     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 or pty). 

     Keys pressed are sent to inStream, text appearing

     from outStream is displayed in the terminal view.

     This can be used to implement things like rlogin

     or telnet views (if connected to a modem, a com-program can also be

     implemented this way)."

    |top vt|

    top := StandardSystemView new.

    vt := self openOnInput:inStream output:outStream in:top.

    vt masterWindow:top.

    top extent:(vt preferredExtent).

    top label:'shell'.

    top iconLabel:'shell'.

    top icon:(self defaultIcon).

    top open.

    ^ vt

    "Modified: / 5.5.1999 / 17:25:59 / cg"

!

openOnInput:inStream output:outStream in:aView

    "open a terminalView on the given streams 

     (which are typically some kind of socket or pty). 

     Keys pressed are sent to inStream, text appearing

     from outStream is displayed in the terminal view.

     This can be used to implement things like rlogin

     or telnet views (if connected to a modem, a com-program can also be

     implemented this way)."

    |scr vt|

    scr := ScrollableView for:self in:aView.

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

    vt := scr scrolledView.

    vt inStream:inStream.

    vt outStream:outStream.

    vt startReaderProcessWhenVisible.

    ^ scr

    "Modified: / 5.5.1999 / 17:25: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)"

    | top scr vt lbl|

    top := StandardSystemView new.

    scr := HVScrollableView for:self in:top.

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

    vt := scr scrolledView.

    vt startShellIn:aDirectory.

    vt shellTerminateAction:[top destroy].

    vt masterWindow: top.

    lbl := OperatingSystem isUNIXlike ifTrue:['shell'] ifFalse:['dos'].

    top extent:(scr preferredExtent).

    top label:lbl.

    top iconLabel:lbl.

    top icon:(self defaultIcon).

    top open.

    ^ vt

    "

     TerminalView openShellIn:'/etc'

     VT52TerminalView openShellIn:'/etc'

     VT100TerminalView openShellIn:'/etc'

    "

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

    "Modified: / 5.5.1999 / 17:27:10 / 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'!

filterStream:something

    "set a filter stream; if not nil, it gets all incoming data via nextPutAll:.

     Added to allow saving incoming data to a file, but can also be used to catch/filter/lookAt

     incoming data by some other program"

    filterStream := something.

    "Created: / 28.1.2002 / 20:56:04 / micha"

    "Modified: / 28.1.2002 / 20:56:11 / micha"

!

inStream

    "set the stream, which gets all input data (i.e. keyboard input)"

    ^ inStream

!

inStream:something

    "return the stream, which gets all input data (i.e. keyboard input)"

    inStream := something.

!

lineBufferHistory

    ^ lineBufferHistory

!

lineBufferHistory:aCollection

    aCollection isNil ifTrue:[

        lineBufferHistory := OrderedCollection new.

    ] ifFalse:[

        lineBufferHistory := OrderedCollection withAll:aCollection.

    ].

    lineBufferHistoryPosition := lineBufferHistory size + 1.

!

masterWindow:aTopView

    "if set, and a corresponding osCommand escape sequence is received,

     that topView's title, icon or other attribute is changed.

     Needed to support xterm's 'set window title' escape sequence"

    masterWindow := aTopView.

!

outStream

    "return the stream, which is used to present data in the view (i.e. shell output)"

    ^ outStream

!

outStream:something

    "set the stream, which is used to present data in the view (i.e. shell output)"

    outStream := something.

!

readerProcess

    ^ readerProcess

!

recorderStream:aWriteStream

    "set a recorder stream; if not nil, it gets all user input (keyboard) data via nextPut:.

     Allows saving of user input to a file, for later replay of a session"

    recorderStream := aWriteStream.

!

shellDirectory:aPathname

    "the directory, in which the shell/command should be executed.

     By default, the 'current' directory is used"

    shellDirectory := aPathname.

!

shellTerminateAction:aBlock

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

     Can be used to close down the application or perform any other cleanup action."

    shellTerminateAction := aBlock.

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

! !

!TerminalView methodsFor:'accessing - behavior'!

inputTranslateBackspaceToDelete

    ^ inputTranslateBackspaceToDelete

!

inputTranslateBackspaceToDelete:aBoolean

    inputTranslateBackspaceToDelete := aBoolean.

!

inputTranslateCRToNL

    ^ inputTranslateCRToNL

!

inputTranslateCRToNL:aBoolean

    inputTranslateCRToNL := aBoolean.

!