"

 COPYRIGHT (c) 2010 by Jan Vrany, SWING Research Group. CTU in Prague

	      All Rights Reserved

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the 'Software'), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

"

"{ Package: 'stx:libtool' }"

"{ NameSpace: Tools }"

CodeViewService subclass:#BreakpointService

	instanceVariableNames:'breakpoints currentMethod currentMethodClass methodHolder'

	classVariableNames:'NeedDoubleClickToToggleBreakpoints'

	poolDictionaries:''

	category:'Interface-CodeView'

!

!BreakpointService class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 2010 by Jan Vrany, SWING Research Group. CTU in Prague

	      All Rights Reserved

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the 'Software'), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

"

!

documentation

"

    somewhat badly designed for non-reusability:

       I should not care for recompiling methods here,

       but instead delegate this task to a breakPointInstaller.

       The way it is currently designed makes it hard to reuse this

       component in non-smalltalk setups (i.e. groovy-, node- or C editors).

    Fiddling around here breaks it almost for sure, as this is highly obfuscated code.   

"

! !

!BreakpointService class methodsFor:'accessing'!

label

    "Answers a short label - for UI"

    ^ 'Breakpoints'

! !

!BreakpointService class methodsFor:'testing'!

isUsefulFor:aCodeView

    "this filters useful services.

     Redefined to return true for myself - not for subclasses"

    ^ self == Tools::BreakpointService

    "Created: / 22-07-2013 / 14:01:17 / cg"

! !

!BreakpointService methodsFor:'accessing'!

breakpointAtLine:line

    "return the breakpoint at line (may be disabled) or nil, if there is none"

    |pos|

    breakpoints isEmptyOrNil ifTrue:[^ nil].

    pos := textView characterPositionOfLine:line col:1.

    "/ breakpoints are sorted by line 

    "/ (or even by position within a line, but those are currently not supported by the GUI).

    "/ We can stop searching early

    breakpoints do:[:each |

        |bpLine|

        bpLine := each line.

        bpLine == line ifTrue:[^ each].

        bpLine > line ifTrue:[^ nil].

    ].

    ^ nil.

"/    ^ breakpoints 

"/        detect:[:each | each position = pos ] 

"/        ifNone:[ 

"/            breakpoints 

"/                detect:[:each | each line == line and:[each position isNil ]] 

"/                ifNone:[ 

"/                    self halt.

"/                    nil 

"/                ]

"/        ]

    "Modified: / 17-06-2011 / 13:59:17 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 16-08-2017 / 08:29:51 / cg"

!

breakpoints

    self fixupBreakpointPositions.

    ^ breakpoints

    "Modified: / 08-05-2014 / 14:02:25 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (comment): / 18-02-2019 / 20:11:07 / Claus Gittinger"

!

firstBreakpointAtLine:line

    "return the breakpoint at line (may be disabled) or nil, if there is none"

    breakpoints isEmptyOrNil ifTrue:[^ nil].

    ^ breakpoints 

        detect:[:each | each line == line ] 

        ifNone:[ nil ]

    "Created: / 26-01-2019 / 18:49:33 / Claus Gittinger"

!

removeAllBreakpoints

    breakpoints := OrderedCollection new.

    gutterView invalidate.

!

setBreakpointAtLine:line

    "unconditionally set a breakpoint (called via double click)"

    self setOrToggleBreakpointAtLine:line toggle:false

!

setOrToggleBreakpointAtLine:line

    "toggle a breakpoint (called via single click)"

    self setOrToggleBreakpointAtLine:line toggle:true

!

setOrToggleBreakpointAtLine:line toggle:doToggleBoolean

    "set (via double click) or toggle (via single click) a breakpoint"

    |pos bpnt prepareFullBreakSupport mClass ok|

    "/ if prepareFullBreakSupport is true, setting a single breakpoint in a method will create

    "/ a whole set of invisible (and disabled) breakpoints in that method, one for each line.

    "/ These can later be enabled in the debugger

    "/ (otherwise, the debugger's behavior is stupid, as it cannot recompile a method

    "/ to set additional breakpoints).

    "/ We accept the additional overhead, as we are in debug mode anyway.

    "/ prepareFullBreakSupport := false.

    prepareFullBreakSupport := true.

    codeView method isNil ifTrue:[

        ^ nil

    ].

    currentMethod isNil ifTrue:[

        ^ nil

    ].

    bpnt := self breakpointAtLine:line.

    bpnt isNil ifTrue:[

        "/ no breakpoint there - create a new one as required (i.e. recompile)

        ok := self canCreateOrToggleBreakpointAtLine:line.

        ok ifFalse:[

            (currentMethod isMethodWithBreakpoints and:[ prepareFullBreakSupport ]) ifFalse:[

                (codeView topView notNil and:[codeView topView isDebugView]) ifTrue:[

                    (Dialog 

                        confirm:'Sorry, in an active method, I can only add new breakpoints in an already breakpointed method.

(i.e. a method stopped at a method breakpoint or one which already has statement breakpoints)

The reason is that the method needs to be recompiled for the breakpoint, which would not affect the method being currently executed.

You can proceed to set the breakpoint, but it will only affect the next call into this method, not the current invocation.'

                        yesLabel:'Set Breakpoint for Next Call' noLabel:'OK') ifTrue:[

"/ self halt.

                            ok := true.

                        ]

                ] ifFalse:[

                    Dialog warn:'Sorry, cannot add a new breakpoint here.'.

                ].

            ]

        ].

        ok ifTrue:[

            prepareFullBreakSupport ifTrue:[

                "/ add a (disabled) breakpoint for every source line. This

                "/ allows for breakpoints to be enabled/disabled in the debugger...

                breakpoints notNil ifTrue:[ self sortBreakpoints ].

                1 to:textView numberOfLines do:[:eachLine |

                    |oldBPnt eachPos otherBpnt|

                    oldBPnt := self breakpointAtLine:eachLine.

                    oldBPnt isNil ifTrue:[

                        eachPos := textView characterPositionOfLine:eachLine col:1.

                        breakpoints isNil ifTrue:[ breakpoints := OrderedCollection new].

                        breakpoints add:((otherBpnt := Breakpoint new method:codeView method) position:eachPos line:eachLine).

                        eachLine == line ifTrue:[

                            bpnt := otherBpnt.

                        ] ifFalse:[

                            otherBpnt beInvisible.

                        ]

                    ].

                ].

            ] ifFalse:[

                pos := textView characterPositionOfLine:line col:1.

                breakpoints add:((bpnt := Breakpoint new method:codeView method) position:pos line:line).

            ].

            Screen current shiftDown ifTrue:[

                "/ trace

                bpnt beTracepoint

            ].

            self assert: breakpoints notEmptyOrNil.

            self sortBreakpoints.

            "/ recompile the method with breakpoints

            self recompile.

        ]

    ] ifFalse:[

        (doToggleBoolean or:[bpnt isEnabled not]) ifTrue:[

            "/ breakpoint already there - just enable/disable

            Screen current shiftDown ifTrue:[

                bpnt toggleTracing

            ] ifFalse:[

                bpnt toggle.

            ].

            (currentMethod isNil or:[(mClass := currentMethod mclass) isNil]) ifTrue:[

                "/ hack: ouch - was wrapped in the meantime;

                "/ hurry up and update. Should be done elsewhere (in codeView)

                self updateCurrentMethod.

                currentMethod notNil ifTrue:[ mClass := currentMethod mclass ].

            ].

            bpnt method:currentMethod.

            mClass notNil ifTrue:[

                Smalltalk changed:#methodTrap with:(MethodTrapChangeNotificationParameter changeClass:mClass changeSelector:currentMethod selector).

            ].

        ].

    ].

    bpnt notNil ifTrue:[

        "/ if it was ignored in the debugger, reenable

        Debugger notNil ifTrue:[

            Debugger stopIgnoringHaltsFor:currentMethod atLineNr:bpnt line

        ].    

    ].

    gutterView redrawLine:line.

    ^ bpnt

    "Created: / 17-06-2011 / 13:45:22 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 21-02-2014 / 17:36:11 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 13-04-2017 / 09:59:36 / cg"

    "Modified: / 02-03-2019 / 11:32:07 / Claus Gittinger"

    "Modified (format): / 30-01-2020 / 14:46:27 / Stefan Vogel"

! !

!BreakpointService methodsFor:'change & update'!

update: aspect with: param from: sender

    aspect == #visibility ifTrue:[^ self].

    aspect == #sizeOfView ifTrue:[^ self].

    aspect == #classHolder ifTrue:[^ self].

    aspect == #languageHolder ifTrue:[^ self].

    (codeView notNil and:[sender == codeView modifiedChannel]) ifTrue:[^ self].

    "/ ATTENTION: I thought that fetching the methodHolder once in initialize would

    "/ be ok. However, it seems not (codeView gives me something which it does not use/change later).

    "/ so this fetch is called in update as well.

    "/ maybe s.o. (ie. Jan) fixes CodeView2

    (aspect == #methodHolder or:[sender == self fetchMethodHolder]) ifTrue:[

        self updateCurrentMethod.

    ].

    super update: aspect with: param from: sender

    "Created: / 06-07-2011 / 15:21:08 / cg"

    "Modified: / 26-02-2019 / 18:06:23 / Claus Gittinger"

!

updateBreakPointsFor:aMethod

    |methodsBreakPoints|

    "/ Transcript show:'update breakpoints for method: '; showCR:aMethod.

    aMethod notNil ifTrue:[

        aMethod breakpointsDo:[:eachLiteral |

            methodsBreakPoints isNil ifTrue:[

                methodsBreakPoints := OrderedCollection new.

            ].

            methodsBreakPoints add:eachLiteral copy.

        ].

        currentMethodClass := aMethod mclass.

    ] ifFalse:[

        currentMethodClass := nil

    ].

    breakpoints := methodsBreakPoints.

    breakpoints notEmptyOrNil ifTrue:[ 

        "/ Nil out breakpoint's position. It's invalid as soon as

        "/ user edits the code. Instead, depend on line information.

        "/ Breakpoint character positions are fixed up just before

        "/ passing a breakpoints to the compiler, see

        "/ #fixupBreakpointPositions

        breakpoints do:[:each | each method:aMethod. each position: nil ].

    ].

    currentMethod := aMethod.

    "Created: / 06-07-2011 / 15:24:09 / cg"

    "Modified: / 06-07-2011 / 17:32:54 / jv"

    "Modified: / 23-02-2015 / 14:48:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 16-08-2017 / 08:31:18 / cg"

!

updateCurrentMethod

    |method realMethod oldBreakPoints|

    "/ codeView methodHolder class == BlockValue ifTrue:[self breakPoint:#cg].

    method := realMethod := codeView method.

    (method notNil and:[method mclass isNil]) ifTrue:[

        "/ hack: ouch - was wrapped in the meantime;

        "/ hurry up and update. Should be done elsewhere (in codeView)

        realMethod := MethodWithBreakpoints allBreakpointedMethods detect:[:m | m originalMethod == method and:[m mclass notNil]] ifNone:nil.

        realMethod isNil ifTrue:[

            realMethod := WrappedMethod allWrappedMethods detect:[:m | m originalMethod == method and:[m mclass notNil]] ifNone:nil.

        ].

    ].

    realMethod ~~ currentMethod ifTrue:[

        "/ self fetchMethodHolder setValue:realMethod.

        oldBreakPoints := breakpoints.

        self updateBreakPointsFor:realMethod.

        oldBreakPoints ~= breakpoints ifTrue:[

            gutterView invalidate.

        ]

    ].

    "Modified: / 22-07-2013 / 13:33:28 / cg"

! !

!BreakpointService methodsFor:'event handling'!

buttonMultiPress:button x:x y:y in:view

    view == gutterView ifTrue:[

        button == 1 ifTrue:[

            self setBreakpointAtX:x y:y.

            "/ self setOrToggleBreakpointAtX:x y:y.

            ^ true.

        ].

        button == 3 ifTrue:[

            "/ cg:huch - why that?

            ^ true.

        ]

    ].

    ^ false

    "Created: / 17-06-2011 / 13:05:22 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 28-06-2011 / 08:31:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 19-09-2011 / 14:41:00 / cg"

!

buttonPress:button x:x y:y in:view

    "Handles an event in given view (a subview of codeView).

     If the method returns true, it has eaten the event and it will not be processed

     by the view or other services.

     Notice, that this is called both for events in the gutter AND for events in the text."

    |lineNr currentHelpListener|

    "now disabled: need a double click (like in other editors);

     also this allows toggling breakpoints even if there are service-annotations"

    view == gutterView ifTrue:[

        button == 1 ifTrue:[

            "/ see hack in CodeView2 >> buttonPress:x:y:in:

            ^ false.

"/            lineNr := textView yVisibleToLineNr:y.

"/            (self singleClickToToggle) ifFalse:[

"/                (currentHelpListener := FlyByHelp currentHelpListener) notNil ifTrue:[

"/                    "/ show a message that a double click is now needed    

"/                    currentHelpListener initiateHelpFor:view at:x@y now:true

"/                ].

"/                ^ false.

"/            ].

"/            lineNr notNil ifTrue:[ self setOrToggleBreakpointAtLine:lineNr ].

"/            ^ true.

        ].

    ].

    ^ false

    "Created: / 17-06-2011 / 13:05:22 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 19-09-2011 / 14:41:00 / cg"

    "Modified: / 03-12-2014 / 10:22:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 12-03-2019 / 13:01:22 / Claus Gittinger"

!

keyPress:key x:x y:y in: view

    "Handles an event in given view (a subview of codeView).

     If the method returns true, it has eaten the event and it will not be processed

     by the view."

    key == #Accept ifTrue:[ 

        textView undoableDo:[

            BreakpointQuery answer: self breakpoints do:[

                textView accept.

            ].

        ].

        ^ true

    ].

    ^ false

    "Created: / 08-05-2014 / 10:42:56 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 08-05-2014 / 13:52:38 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

linesDeletedFrom: start to: end

    | breakpointsToRemove |

    breakpoints isEmptyOrNil ifTrue:[^self].

    breakpointsToRemove := Set new.

    start to: end do:[:line | 

        | breakpointToRemove |

        breakpointToRemove := self breakpointAtLine: line.

        breakpointToRemove notNil ifTrue:[ breakpointsToRemove add: breakpointToRemove ].

    ].

    breakpoints removeAll: breakpointsToRemove.

    self moveBreakpointsAfterLine: end by: (end - start + 1) negated

    "Created: / 06-07-2011 / 17:16:27 / jv"

    "Modified: / 04-06-2014 / 17:56:56 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

linesInsertedFrom: start to: end

    breakpoints isEmptyOrNil ifTrue:[^self].

    self moveBreakpointsAfterLine: start - 1 by: (end - start + 1)

    "Created: / 06-07-2011 / 17:16:36 / jv"

!

setBreakpointAtX:x y:y

    |lineNr|

    lineNr := textView yVisibleToLineNr:y.

    lineNr notNil ifTrue:[ self setBreakpointAtLine:lineNr ].

!

setOrToggleBreakpointAtX:x y:y

    |lineNr|

    lineNr := textView yVisibleToLineNr:y.

    lineNr notNil ifTrue:[ self setOrToggleBreakpointAtLine:lineNr ].

! !

!BreakpointService methodsFor:'help'!

basicHelpTextAtLine:ignoredLineNr

    |topView|