"{ Encoding: utf8 }"

"

 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:#CodeNavigationService

	instanceVariableNames:'lastHighlightedElement selectorEmphasis variableEmphasis

		currentEmphasis currentEmphasisForAssign linesToRedraw menuShown

		assignmentEmphasis'

	classVariableNames:'DefaultVariableEmphasis DefaultSelectorEmphasis

		DefaultAssignmentEmphasis'

	poolDictionaries:''

	category:'Interface-CodeView'

!

!CodeNavigationService 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.

"

! !

!CodeNavigationService class methodsFor:'accessing'!

label

    "Answers a short label - for UI"

    ^'Semi-modal Code Navigation'

    "Created: / 07-03-2010 / 14:00:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

requiredServices

    ^#(#'Tools::CodeHighlightingService')

    "Created: / 27-07-2011 / 11:40:56 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!CodeNavigationService class methodsFor:'accessing - defaults'!

defaultAssignmentEmphasis

    "must only define a background - otherwise, syntax highlight fg is lost"

    DefaultAssignmentEmphasis isNil ifTrue:[

        ^ Array with:(#backgroundColor -> (UserPreferences current assignmentBackgroundColorForNavigationService))

    ].

    ^ DefaultAssignmentEmphasis

!

defaultSelectorEmphasis

    "must only define a background - otherwise, syntax highlight fg is lost"

    DefaultSelectorEmphasis isNil ifTrue:[

        ^ Array with:(#backgroundColor -> (UserPreferences current selectorBackgroundColorForNavigationService))

    ].

    ^ DefaultSelectorEmphasis

    "Modified: / 21-08-2011 / 09:58:18 / cg"

!

defaultVariableEmphasis

    "must only define a background - otherwise, syntax highlight fg is lost"

    DefaultVariableEmphasis isNil ifTrue:[

        ^ Array with:(#backgroundColor -> (UserPreferences current variableBackgroundColorForNavigationService))

    ].

    ^ DefaultVariableEmphasis

    "Created: / 25-06-2010 / 13:56:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 21-08-2011 / 11:04:20 / cg"

! !

!CodeNavigationService class methodsFor:'testing'!

isUsefulFor:aCodeView

    "this filters useful services.

     Redefined to return true for myself - not for subclasses"

    ^ self == Tools::CodeNavigationService

    "Created: / 22-07-2013 / 13:59:20 / cg"

! !

!CodeNavigationService methodsFor:'change & update'!

update: aspect with: param from: sender

    sender == textView modifiedChannel ifTrue:[

        codeView reallyModified ifTrue:[

            "/ no longer highlight - the info is wrong anyway !!

            self highlightClear.

        ].

    ].

    "JV: I changed 'halt' to 'breakPoint: #cg'"

    "Created: / 22-08-2011 / 16:22:19 / cg"

    "Modified: / 25-08-2011 / 15:10:28 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 05-09-2011 / 05:15:42 / cg"

! !

!CodeNavigationService methodsFor:'code services'!

browseClass:class

    |browser|

    (browser := self browser) isNil ifTrue:[ ^ NewSystemBrowser browseClass:class ].

    (UserPreferences current alwaysOpenNewTabWhenCtrlClick 

      or:[ browser navigationState modified ]

    ) ifTrue:[

        browser

            spawnFullBrowserInClass:class

            selector:nil

            in:#newBuffer

    ] ifFalse:[ 

        browser switchToClass:class 

    ]

    "Created: / 15-02-2010 / 09:36:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 25-07-2010 / 11:00:26 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 21-08-2011 / 10:07:30 / cg"

!

browser

    ^codeView browserHolder value

    "Created: / 06-03-2010 / 21:14:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!CodeNavigationService methodsFor:'event handling'!

button1Press

    | node |

    node := codeView currentParseNode.

    node isNil ifTrue:[ 

        ^ self 

    ].

    node isSelector ifTrue:[

        self button1PressForMessageNode: node.

        ^self.

    ].

    node isVariable ifTrue:[

        self button1PressForVariableNode: node.

        ^self.

    ].

    ^self.

    "Created: / 14-02-2010 / 18:43:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 18-11-2011 / 14:58:02 / cg"

    "Modified: / 21-02-2012 / 14:30:14 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

button1PressForMessageNode: node

    ^self button1PressForSelector: node selector.

    "Created: / 21-02-2012 / 14:30:10 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 25-02-2014 / 22:11:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

button1PressForSelector: selector

    | impls |

    impls := codeView implementorsOf: selector.

    "/ impls size = 1 ifTrue:[^codeView browseMethod: impls anyOne].

    [

        menuShown := codeView implementorsMenu: impls selector: selector.

        "/ cg: why is this done?

        "/ self highlightClear.

        menuShown showAtPointer.

    ] ensure:[

        menuShown := nil

    ].

    "Created: / 14-02-2010 / 18:50:13 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 30-06-2011 / 19:34:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 07-07-2011 / 17:16:23 / jv"

    "Modified (comment): / 29-08-2013 / 16:27:58 / cg"

!

button1PressForVariableNode: node

    | name value |

    node isGlobalVariable ifTrue:[

        value := nil.

        name := node name asSymbolIfInterned.

        name notNil ifTrue:[

            value := Smalltalk at: name.

        ].

        value notNil ifTrue:[

            value isBehavior ifTrue:[

                self browseClass: value.

            ] ifFalse:[

                value inspect.

            ]

        ]

    ]

    "Created: / 21-02-2012 / 14:30:11 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 07-03-2014 / 22:17:41 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

button2Press

    | sel node|

    sel := codeView syntaxElementSelection.

    (sel notNil 

      and:[(node := sel node) isMessage 

           or:[node isSelector]]

    ) ifTrue:[

        ^self button2PressForSelector: node selector

    ].

    "Created: / 14-02-2010 / 18:43:04 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 08-03-2012 / 16:49:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (format): / 04-06-2014 / 11:09:33 / az"

!

button2PressForSelector: selector

    | senders |

    [

        senders := codeView sendersOf: selector.

    ] valueWithTimeout:(500 milliseconds). 

    senders isNil ifTrue:[^ self].

    "/ senders size = 1 ifTrue:[ codeView browseMethod: senders anyOne. ^ self].

    [

        menuShown := codeView sendersMenu: senders selector: selector.

        "/ cg: why is this done?

        "/ self highlightClear.

        menuShown showAtPointer.

    ] ensure:[

        menuShown := nil.

    ].

    "Created: / 14-02-2010 / 18:50:13 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 30-06-2011 / 19:34:43 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 28-08-2013 / 21:59:26 / cg"

    "Modified (comment): / 29-08-2013 / 16:28:03 / cg"

!

buttonMotion:button x:x y:y in:view 

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

     If the method returns true, the event will not be processed

     by the view."

    (view == textView and:[ textView isQuickMenuModifierPressed ]) ifTrue:[

        self highlightElementAtX:x y:y.

        ^ true

    ].

    ^ false

    "Created: / 06-03-2010 / 20:40:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (format): / 21-08-2011 / 10:07:15 / 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."

    (view == textView) ifTrue:[

        textView isQuickMenuModifierPressed ifTrue:[

            button == 1      ifTrue: [

                codeView sensor shiftDown ifTrue:[

                    ^self button2Press

                ].

                ^self button1Press

            ].

            button == #paste ifTrue: [^self button2Press].   

            button == 2      ifTrue: [^self button2Press]

        ] ifFalse:[

            button == 1 ifTrue:[

                self highlightVariableAtX:x y:y.

            ]

        ]

    ].

    ^false

    "Created: / 06-03-2010 / 21:12:26 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 25-06-2010 / 14:53:36 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 01-12-2013 / 23:42:02 / cg"

!

buttonRelease: button x:x y:y in: view

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

     If the method returns true, the event will not be processed

     by the view."

    "/ if I show a quick senders/implementors menu, eat this event

    ^ menuShown notNil

!

findNextVariableFromCursor

    | currentElement nextElement |

    codeView hasSelection ifTrue:[

        currentElement := self elementAtLine: textView selectionStartLine col: textView selectionStartCol.

    ] ifFalse:[

        currentElement := codeView syntaxElementSelection.

    ].

    currentElement isVariable ifTrue:[

        nextElement := currentElement nextElement.

        nextElement notNil ifTrue:[

            textView selectFrom: nextElement start to: nextElement stop. 

        ]

    ]

    "Created: / 18-09-2013 / 13:15:28 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

findPreviousVariableFromCursor

    | currentElement prevElement |

    codeView hasSelection ifTrue:[

        currentElement := self elementAtLine: textView selectionStartLine col: textView selectionStartCol.

    ] ifFalse:[

        currentElement := codeView syntaxElementSelection.

    ].

    currentElement isVariable ifTrue:[

        prevElement := currentElement previousElement.

        prevElement notNil ifTrue:[

            textView selectFrom: prevElement start to: prevElement stop. 

        ]

    ]

    "Created: / 18-09-2013 / 13:15:50 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

isQuickMenuModifierPressed

    ^ textView isQuickMenuModifierPressed

"/

"/    sensor := textView sensor.

"/    UserPreferences current codeView2QuickSendersAndImplementorsOnControl ifTrue:[

"/        ^ sensor ctrlDown

"/    ].

"/    ^ sensor metaDown

    "Modified: / 28-08-2013 / 22:13:18 / cg"

!

isQuickMenuModifierReleased

    |sensor|

    sensor := textView sensor.

    UserPreferences current codeView2QuickSendersAndImplementorsOnControl ifTrue:[

        ^ sensor ctrlDown not

    ].

    ^ sensor metaDown not

!

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

    <resource: #keyboard (#Control_L #Ctrl

                          #CursorRight #CursorDown #CursorLeft #CursorUp)>

    |ev p sensor|

    (view == textView) ifTrue:[

        sensor := view sensor.

        "/ ("ctrlDown" "key == #'Control_L' or:[ key == #Ctrl ]") ifTrue:[

        (textView isQuickMenuModifierPressed) ifTrue:[

            "/ because it is delegated, the position is not correct

            p := view device translatePoint:(view device pointerPosition) fromView:nil toView:view.

            "/ ev := WindowGroup lastEvent.

            "/ p := view device translatePoint:(ev x @ ev y) fromView:ev view toView:view.

            sensor 

                pushUserEvent:#highlightElementAtX:y: 

                for: self 

                withArguments:{p x. p y.}.

            ^ false "/ true. -- no, don't eat the key

        ].

"/        codeView reallyModified "textView modified" ifTrue:[

"/            self highlightClear. 

"/            codeView syntaxElements: nil.

"/            ^ false

"/        ].

        (key == #FocusNext) ifTrue:[

            sensor pushUserEvent:#findNextVariableFromCursor for:self.            

            ^ true.

        ].

        (key == #FocusPrevious) ifTrue:[

            sensor pushUserEvent:#findPreviousVariableFromCursor for:self.

            ^ true.

        ].

        (key == #CursorRight

          or:[key == #CursorDown

          or:[key == #CursorLeft

          or:[key == #CursorUp]]]

        ) ifTrue:[

            sensor pushUserEvent:#highlightVariableAtCursor for:self .

        ] ifFalse:[

            "/ sensor pushUserEvent:#highlightClear for:self .

        ]

    ].

    ^ false

    "Created: / 06-03-2010 / 20:50:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 05-09-2011 / 05:17:30 / cg"

    "Modified: / 18-09-2013 / 15:20:09 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 09-08-2018 / 10:32:11 / Claus Gittinger"

    "Modified: / 21-09-2018 / 15:09:57 / sr"

!

linesDeletedFrom: start to: end

    self highlightClear

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

    "Created: / 16-09-2011 / 15:39:33 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

linesInsertedFrom: start to: end

    self highlightClear

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

    "Created: / 16-09-2011 / 15:39:30 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

linesModifiedFrom: start to: end

    self highlightClear

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

    "Created: / 16-09-2011 / 15:19:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"