"

jv:vdb - Visual / VM Debugger

Copyright (C) 2015-now Jan Vrany

This software is licensed under 'Creative Commons Attribution-NonCommercial 4.0 International License'

You may find a full license text in LICENSE.txt or at http://creativecommons.org/licenses/by-nc/4.0/

"

"{ Package: 'jv:vdb' }"

"{ NameSpace: Smalltalk }"

VDBAbstractApplication subclass:#VDBSimpleDebuggerConsoleApplication

	instanceVariableNames:'consoleView consoleInput consoleOutput consoleOutputLock

		consoleProcess consolePrompt consolePromptPrinted

		outstandingCommand outstandingCommandToken

	classVariableNames:''

	poolDictionaries:'GDBCommandStatus'

	category:'VDB-UI-Console'

!

!VDBSimpleDebuggerConsoleApplication class methodsFor:'documentation'!

copyright

"

jv:vdb - Visual / VM Debugger

Copyright (C) 2015-now Jan Vrany

This software is licensed under 'Creative Commons Attribution-NonCommercial 4.0 International License'

You may find a full license text in LICENSE.txt or at http://creativecommons.org/licenses/by-nc/4.0/

"

!

documentation

""

! !

!VDBSimpleDebuggerConsoleApplication class methodsFor:'accessing'!

defaultWindowTitle

    ^ self resources string: 'Debugger Console'

    "Created: / 08-01-2018 / 18:59:02 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 03-10-2018 / 15:39:26 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBSimpleDebuggerConsoleApplication class methodsFor:'interface specs'!

windowSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

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

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

    "

     UIPainter new openOnClass:VDBSimpleDebuggerConsoleApplication andSelector:#windowSpec

     VDBSimpleDebuggerConsoleApplication new openInterface:#windowSpec

     VDBSimpleDebuggerConsoleApplication open

    "

    <resource: #canvas>

    ^ 

    #(FullSpec

       name: windowSpec

       uuid: '28fb22b0-fe61-11e8-90a6-606720e43e2c'

       window: 

      (WindowSpec

         label: 'Debugger Console'

         name: 'Debugger Console'

         uuid: '28fb22b1-fe61-11e8-90a6-606720e43e2c'

         min: (Point 10 10)

         bounds: (Rectangle 0 0 782 332)

       )

       component: 

      (SpecCollection

         collection: (

          (ArbitraryComponentSpec

             name: 'Console'

             layout: (LayoutFrame 0 0 0 0 0 1 0 1)

             uuid: '28fb22b2-fe61-11e8-90a6-606720e43e2c'

             hasHorizontalScrollBar: true

             hasVerticalScrollBar: true

             miniScrollerHorizontal: true

             autoHideScrollBars: true

             hasBorder: false

             component: consoleView

           )

          )

       )

     )

! !

!VDBSimpleDebuggerConsoleApplication class methodsFor:'plugIn spec'!

aspectSelectors

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

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

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

    "Return a description of exported aspects;

     these can be connected to aspects of an embedding application

     (if this app is embedded in a subCanvas)."

    ^ #(

        #debuggerHolder

      ).

! !

!VDBSimpleDebuggerConsoleApplication methodsFor:'actions'!

doComplete: line

    "Called when a user triggers a command completion (usually by pressing

     tab)"

    | command |

    command := GDBMI_complete arguments: (Array with: line).

    debugger send: command andWithResultDo: [ :result |

        consoleView sensor pushUserEvent: #doComplete:with: for: self withArguments: (Array with: line with: result)

    ].

    "Created: / 30-12-2018 / 22:01:42 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (comment): / 31-12-2018 / 11:35:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

doComplete: line with: result

    "Called asynchronously from #doComplete: when possible completions

     are computed.

     Private, this is for private use by #doComplete: 

    "

    self consoleView completeCommandWith: (result propertyAt: #completions).

    "Created: / 30-12-2018 / 22:04:05 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 16-01-2019 / 14:24:46 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBSimpleDebuggerConsoleApplication methodsFor:'aspects'!

consoleView

    consoleView isNil ifTrue:[

        consoleView := VDBSimpleDebuggerConsoleView new.

        consoleView

            font:self textFont;

            foregroundColor:Color white backgroundColor:Color black;

            cursorForegroundColor:Color white backgroundColor:Color white.

        consoleView localEcho:true.

        consoleView inputTranslateCRToNL:true.

        consoleView lineEditMode:true.

        consoleView inStream:consoleInput.

        consoleView outStream:consoleOutput.

        consoleView startReaderProcessWhenVisible.

        self initializeCompletion

    ].

    ^ consoleView

    "Created: / 09-06-2014 / 10:11:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 04-04-2018 / 22:40:59 / jv"

    "Modified: / 16-01-2019 / 14:43:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBSimpleDebuggerConsoleApplication methodsFor:'event handling'!

onCmdParamChanged: event

    event name = 'prompt' ifTrue:[

        consolePrompt := event value

    ].

    "Created: / 19-01-2019 / 22:13:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

onCommandEvent: event

    event command == outstandingCommand ifTrue:[ 

        outstandingCommandToken := event token.

        ignoreNextLogStreamEvent := true.

    ].

    "Created: / 06-06-2014 / 22:43:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 11-06-2014 / 12:35:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

onCommandResultEvent: event

    outstandingCommandToken notNil ifTrue:[ 

        event token == outstandingCommandToken ifTrue:[ 

            "/ Check if command ended up with an error. If so,

            "/ print the error message.

            event result status == CommandStatusError ifTrue:[ 

                self showCR: ('Error: %1 ' bindWith: (event result propertyAt: #msg)).

            ] ifFalse:[

                "/ Check if the command issues is actually a MI command,

                "/ if so, print "Done" to the console since MI command don't

                "/ provide user feedback.

                outstandingCommand isMICommand ifTrue:[ 

                    self showCR: ('Done ( %1 , see even log for result value)' bindWith: outstandingCommand value)

                ].

            ].

            outstandingCommand := outstandingCommandToken := nil. 

            outstandingCommandBlocker signalForAll.     

        ].

    ].

    "Created: / 06-06-2014 / 22:44:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 27-02-2015 / 13:01:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

onEventSetProcessingFinished: event

    self showPrompt.

    "Created: / 18-09-2014 / 23:11:41 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

onLogOutputEvent: event

    ignoreNextLogStreamEvent ifTrue:[ 

        ignoreNextLogStreamEvent := false.

    ] ifFalse:[

        self onStreamOutputEvent: event  

    ]

    "Created: / 11-06-2014 / 12:37:02 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 04-04-2018 / 22:50:14 / jv"

    "Modified: / 30-12-2018 / 22:03:04 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

onStreamOutputEvent: event

    consolePromptPrinted ifTrue:[ self showCR:'' ].

    consolePromptPrinted := false.

    event value asStringCollection do:[:line |  

        line notEmptyOrNil ifTrue:[ 

            self showCR: line.  

        ].

    ].

    "Created: / 11-06-2014 / 12:00:42 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 30-12-2018 / 22:02:26 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBSimpleDebuggerConsoleApplication methodsFor:'hooks'!

commonPostOpen

    consoleProcess isNil ifTrue:[

        consoleProcess := 

            [

            ] newProcess.

        consoleProcess name: 'VDB Debugger Console REPL loop'.

        consoleProcess resume.

    ].

    "Created: / 10-06-2014 / 01:25:34 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

postBuildConsoleView: aTextCollector

    consoleView := aTextCollector scrolledView.

    consoleView readOnly: true;       

                font: CodeView defaultFont;

                foregroundColor: Color white

                backgroundColor: Color black;

                cursorForegroundColor: Color white

                      backgroundColor: Color white.

    "Modified: / 08-01-2018 / 19:16:41 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBSimpleDebuggerConsoleApplication methodsFor:'initialization & release'!

initialize

    super initialize.

    consoleInput := GDBInternalPipeStream new.

    consoleOutput := GDBInternalPipeStream new.

    consoleOutputLock := RecursionLock new.

    consolePrompt := '(vdb) '.

    consolePromptPrinted := false.

    outstandingCommandBlocker := Semaphore new.

    ignoreNextLogStreamEvent := false.

    "Created: / 10-06-2014 / 01:23:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 07-04-2018 / 23:13:27 / jv"

!

initializeCompletion

    consoleView isNil ifTrue:[ ^ self ].

    (debugger notNil and:[debugger hasCommand:'-complete']) ifTrue:[ 

        consoleView completionBlock: [ :prefix | self doComplete: prefix ]

    ] ifFalse:[ 

        consoleView completionBlock: nil

    ].

    "Created: / 16-01-2019 / 14:42:47 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

release

    super release.

    consoleProcess terminate.

    "Created: / 10-06-2014 / 01:34:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

subscribe   

    "Register for debugger events. To be overrided by subclasses"

    debugger announcer 

        when: GDBCommandEvent           send: #onCommandEvent:          to: self;

        when: GDBCommandResultEvent     send: #onCommandResultEvent:    to: self;

        when: GDBConsoleOutputEvent      send: #onStreamOutputEvent:     to: self;

        when: GDBTargetOutputEvent       send: #onStreamOutputEvent:     to: self;

        when: GDBLogOutputEvent          send: #onLogOutputEvent:        to: self;

        when: GDBEventSetProcessingFinished send: #onEventSetProcessingFinished: to: self;

        when: GDBCmdParamChangedEvent send: #onCmdParamChanged: to: self.

    consolePrompt := debugger getParameter: 'prompt'.

    self initializeCompletion.

    "Created: / 06-06-2014 / 21:26:48 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!VDBSimpleDebuggerConsoleApplication methodsFor:'private - writing'!

show: aString

    consoleOutputLock critical:[ 

        consoleOutput nextPutAll: aString.

    ].

    "Created: / 11-06-2014 / 08:02:20 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 11-06-2014 / 11:53:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

showCR: aString

    consoleOutputLock critical:[ 

        consoleOutput nextPutAll: aString; crlf.

    ].

    "Created: / 11-06-2014 / 08:02:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 16-01-2019 / 10:52:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

showPrompt

        self show: consolePrompt.

        consolePromptPrinted := true.

    ].

    "Created: / 18-09-2014 / 23:18:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 04-04-2018 / 23:01:24 / jv"

! !

!VDBSimpleDebuggerConsoleApplication class methodsFor:'documentation'!

version_HG

    ^ '$Changeset: <not expanded> $'

! !