"

 COPYRIGHT (c) 1989 by Claus Gittinger

              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.

"

StandardSystemView subclass:#DebugView

	instanceVariableNames:'busy haveControl exitAction canContinue contextView codeView

		receiverInspector contextInspector contextArray selectedContext

		catchBlock grabber mayProceed traceView tracing bigStep

		skipLineNr steppedContextAddress abortButton terminateButton

		continueButton stepButton nextButton nextOverButton nextOutButton

		sendButton returnButton restartButton exclusive inspecting

		nChainShown inspectedProcess updateProcess stopButton

		updateButton monitorToggle stepping steppedContextLineno

		stepForReturn actualContext inWrap stackInspector steppedContext

		wrapperContext verboseBacktrace firstContext stepHow cachable

		currentMethod'

	classVariableNames:'CachedDebugger CachedExclusive OpenDebuggers MoreDebuggingDetail

		DebuggingDebugger VerboseBacktraceDefault DefaultIcon

		InitialNCHAINShown'

	poolDictionaries:''

	category:'Interface-Debugger'

!

!DebugView class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

              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

"

    This class implements a graphical debugger interface.

    The debugger usually sits on top of the faulting process,

    taking over its event processing. 

    (this is different from other Smalltalk debuggers, which control

     the debuggee as a separate process. Consider this an historic

     leftover - the debugger was one of the first applications written for

     ST/X; however, why should we change it without a particular need ...).

    Only the 'stopped' debugged process is affected;

    other processes continue to respond to events.

    The one exception is when an error occurs within the dispatcher process

    or in one of the eventhandler processes - in this case, the debugger

    will sit on an exclusive display connection.

    The whole debugging will be changed, once the required process primitives

    are available, which allow control of another processes execution

    (i.e. single-step, restart & return). The setup will be changed then,

    to have the debugger control the debuggee (i.e. two processes)

    See additional information in 'doc/misc/debugger.doc'.

    Notice: the DebugView class caches the last used debugger in a class

    variable. It may happen, that a malfunctioning debugger (for example,

    a halfway destroyed one) is kept there. You will notice this, if a

    debugger comes up without showing any contents. In this case, close

    (or destroy) the broken debugView, and execute

        Debugger newDebugger

    which removes the cached debugger and forces creation of a new one the

    next time. This is a temporary workaround - the debugger will be fixed to

    avoid this problem.

    [author:]

        Claus Gittinger

    [see also:]

        Exception Signal

        Process

"

! !

!DebugView class methodsFor:'initialization'!

initialize

    InitialNCHAINShown := 20.

    "Created: 20.3.1997 / 16:53:37 / cg"

    "Modified: 20.3.1997 / 16:54:32 / cg"

!

reinitialize

    self newDebugger

! !

!DebugView class methodsFor:'instance creation'!

enter:aContext withMessage:aString 

    "enter a debugger"

    ^ self

        enter:aContext 

        withMessage:aString 

        mayProceed:true

!

enter:aContext withMessage:aString mayProceed:mayProceed

    "enter a debugger; if this is a recursive invocation, enter

     a MiniDebugger instead.

     This is the standard way of entering the debugger;

     sent from error- and halt messages."

    |active foundNoByteCodeContext c|

    StepInterruptPending := nil.

    thisContext isRecursive ifTrue:[

        "/ care for the special case, were the Debugger was autoloaded.

        "/ in this case, thisContext IS recursive, but thats no error

        "/ condition.

        foundNoByteCodeContext := false.

        c := thisContext findNextContextWithSelector:#enter:withMessage:mayProceed: or:#noByteCode or:nil.

        [foundNoByteCodeContext not

         and:[c notNil 

         and:[c selector ~~ #enter:withMessage:mayProceed:]]] whileTrue:[

            c selector == #noByteCode ifTrue:[

                foundNoByteCodeContext := true

            ].

            c := c findNextContextWithSelector:#enter:withMessage:mayProceed: or:#noByteCode or:nil.

        ].

        foundNoByteCodeContext ifFalse:[

            ('DebugView [warning]: reentered with: ', aString) errorPrintCR.

            ^ MiniDebugger 

                enter:aContext

                withMessage:'DebugView [error]: recursive error (in debugger)'

                mayProceed:mayProceed.

        ]

    ].

    "

     well, it could be a stepping or sending debugger up there;

     in this case, return to it. This happens, when a stepping process

     runs into an error (for example, a halt). In this case, we want the

     stepping debugger to come up again instead of a new one.

    "

    OpenDebuggers notNil ifTrue:[

        active := Processor activeProcess.

        OpenDebuggers do:[:aDebugger |

            (aDebugger notNil and:[aDebugger ~~ 0]) ifTrue:[

                (aDebugger inspectedProcess == active) ifTrue:[

"/ 'entering stepping debugger again' printNL.

                    aDebugger unstep.

                    aDebugger setLabelFor:aString in:active.

                    aDebugger mayProceed:mayProceed.

                    ^ aDebugger enter:aContext select:nil.

                ]

            ]

        ]

    ].

    ^ self enterUnconditional:aContext withMessage:aString mayProceed:mayProceed

    "Modified: / 30.10.1997 / 21:09:12 / cg"

!

enterUnconditional:aContext withMessage:aString mayProceed:mayProceed

    "enter a debugger - do not check for recursive invocation"

    |aDebugger breakpointSignal proc|

    StepInterruptPending := nil.

    proc := Processor activeProcess.

    (MessageTracer notNil and:[MessageTracer isLoaded]) ifTrue:[

        breakpointSignal := MessageTracer breakpointSignal.

    ].

    breakpointSignal notNil ifTrue:[

        breakpointSignal handle:[:ex |

            'DebugView [info]: breakpoint in debugger ignored' infoPrintCR.

            ex proceed

        ] do:[

            aDebugger := self new.

            aDebugger isNil ifTrue:[^ nil].

            aDebugger mayProceed:mayProceed.

            aDebugger setLabelFor:aString in:proc.

            aDebugger enter:aContext select:nil.

        ]

    ] ifFalse:[

        aDebugger := self new.

        aDebugger isNil ifTrue:[^ nil].

        aDebugger mayProceed:mayProceed.

        aDebugger setLabelFor:aString in:proc.

        aDebugger enter:aContext select:nil.

    ].

    ^ nil

    "nil halt"

    "Modified: / 30.10.1997 / 21:10:55 / cg"

!

new

    "return a new DebugView. 

     - return a cached debugger if it already exists.

     Also, care for remote displays on which no debugger is wanted

     (ask with mayOpenDebugger) - if so, open on the default screen."

    |debugger currentScreen debuggerDevice|

    currentScreen := Screen current.

    "

     need a blocking debugger if no processes or 

     or if its a timing/interrupt process 

     (because otherwise we would not get any events here ...

    "

    Processor activeProcessIsSystemProcess ifTrue:[

        ((debugger := CachedExclusive) isNil 

        or:[debugger device ~~ currentScreen]) ifTrue:[

            debugger := self newExclusive

        ] ifFalse:[

            CachedExclusive := nil.

        ].

    ] ifFalse:[

        CachedDebugger notNil ifTrue:[

            (CachedDebugger device ~~ currentScreen 

            or:[currentScreen isOpen not]) ifTrue:[

                CachedDebugger := nil

            ]

        ].

        (debugger := CachedDebugger) notNil ifTrue:[

            CachedDebugger := nil.

        ] ifFalse:[

            debuggerDevice := currentScreen.

            (currentScreen suppressDebugger) ifTrue:[

                "/ no debuggers on that device - show an alertBox

                "/ which aborts ...

                self information:'Error cought - press OK to abort the operation.'.

                AbortSignal raise.

                ^ nil.

            ].

            (currentScreen isOpen not

            or:[currentScreen mayOpenDebugger not]) ifTrue:[

                "/ use the default display

                debuggerDevice := Display

            ].

            Screen currentScreenQuerySignal answer:debuggerDevice

            do:[

                debugger := super new.

            ].

            debugger label:'Debugger'.

            debugger icon:self defaultIcon.

        ]

    ].

    ^ debugger

    "Modified: 31.7.1997 / 21:20:27 / cg"

!

newExclusive

    "return a debugger for exclusive display access"

    |debugger|

    debugger := super new.

    debugger label:'Debugger'.

    debugger icon:self defaultIcon.

    debugger exclusive:true.

    ^ debugger

    "Modified: 1.1.1970 / 23:27:06 / cg"

!

openOn:aProcess

    "start a  debugger on aProcess

     (actually not more than a good-looking inspector)"

    |aDebugger label nm|

    aDebugger := super new.

    aDebugger icon:self defaultIcon.

    aProcess notNil ifTrue:[

        nm := aProcess name.

        nm notNil ifTrue:[

            nm := (nm contractTo:17) , '-' , aProcess id printString

        ] ifFalse:[

            nm := aProcess id printString

        ].

        label := 'Debugger [' , nm , ']'.

    ] ifFalse:[

        label := 'no process'

    ].

    aDebugger label:label iconLabel:'Debugger'.

    aDebugger openOn:aProcess.

    ^ nil

    "Modified: 4.4.1997 / 16:22:36 / cg"

! !

!DebugView class methodsFor:'cleanup'!

lowSpaceCleanup 

    "in low memory situations, give up cached debuggers"

    CachedDebugger := nil.

    CachedExclusive := nil.

    OpenDebuggers := nil.

    "

     DebugView lowSpaceCleanup

    "

    "Modified: 18.4.1996 / 16:48:03 / cg"

!

newDebugger

    "force creation of a new debugger (give up cached debuggers)"

    CachedDebugger := nil.

    CachedExclusive := nil.

    OpenDebuggers := nil.

    "

     DebugView newDebugger

    "

! !

!DebugView class methodsFor:'defaults'!

defaultIcon

    "return the debuggers default window icon"

    <resource: #style (#ICON #ICON_FILE)>

    |nm i|

    (i := DefaultIcon) isNil ifTrue:[

        i := self classResources at:'ICON' default:nil.

        i isNil ifTrue:[

            nm := ClassResources at:'ICON_FILE' default:'Debugger.xbm'.

            i := Image fromFile:nm resolution:100.

            i isNil ifTrue:[

                i := Image fromFile:('bitmaps/' , nm) resolution:100.

                i isNil ifTrue:[

                    i := StandardSystemView defaultIcon

                ]

            ]

        ].

        i notNil ifTrue:[

            DefaultIcon := i := i onDevice:Display

        ]

    ].

    ^ i

    "Modified: 19.3.1997 / 20:48:34 / ca"

    "Modified: 18.4.1997 / 15:16:27 / cg"

!

defaultVerboseBacktrace

    ^ VerboseBacktraceDefault

    "Created: 11.1.1997 / 12:14:35 / cg"

!

defaultVerboseBacktrace:aBoolean

    VerboseBacktraceDefault := aBoolean

    "Created: 11.1.1997 / 12:14:44 / cg"

! !

!DebugView class methodsFor:'misc'!

interestingContextFrom:aContext

    "return an interesting contexts offset, or nil.

     This is the context initially shown in the walkback.

     We move up the calling chain, skipping all intermediate Signal

     and Exception contexts, to present the context in which the error

     actually occured.

     Just for your convenience :-)"

    |delta con|

    delta := self interestingContextIndexFrom:aContext.

    con := aContext.

    [con notNil and:[delta > 1]] whileTrue:[

        con := con sender.

        delta := delta - 1.

    ].

    con isNil ifTrue:[

        ^ aContext

    ].

    ^ con

    "Modified: 11.1.1997 / 17:58:44 / cg"

!

interestingContextIndexFrom:aContext

    "return an interesting contexts offset, or nil.

     This is the context initially shown in the walkback.

     We move up the calling chain, skipping all intermediate Signal

     and Exception contexts, to present the context in which the error

     actually occured.

     Just for your convenience :-)"

    |con found offset sel prev ex rcvr|

    aContext isNil ifTrue:[^ 1].

    aContext isBlockContext ifTrue:[^ 1].

    VerboseBacktraceDefault == true ifTrue:[^ 1].

    "/ somewhere, at the bottom, there must be a raise ...

    "/ find the exception

    con := aContext.

    1 to:5 do:[:i |

        con isNil ifTrue:[^ 1].

        sel := con selector.

        ((sel == #raise) or:[sel == #raiseRequest]) ifTrue:[

            rcvr := con receiver.

            (rcvr isKindOf:Exception) ifTrue:[

                ex := rcvr.

                offset := i.

                found := con

            ] ifFalse:[

                rcvr isSignal ifTrue:[

                    offset := i.

                    found := con

                ]

            ]

        ].

        con := con sender.

    ].

    "

     if this is a noHandler exception, skip forward

     to the erronous context

    "

    ex notNil ifTrue:[

        ex signal == Signal noHandlerSignal ifTrue:[

            found := ex suspendedContext

        ]

    ].

    found isNil ifTrue:[

        "/ this is a kludge, but convenient.

        "/ show the place where the divisionByZero happend,

        "/ not where the signal was raised.

        sel := aContext selector.

        (sel == #//      

        or:[sel == #/

        or:[sel == #\\]]) ifTrue:[

            ^ 2

        ].

        "/ show the place of the bad message; not where the Signal

        "/ was raised...

        (sel == #doesNotUnderstand:) ifTrue:[

            ^ 3

        ].

        "/ show the bad method; not where the Signal was raised...

        (sel == #noByteCode) ifTrue:[

            ^ 2

        ].

        "/ show the place of the halt; not where the HaltSignal

        "/ was raised...

        (sel == #halt) ifTrue:[