"
 COPYRIGHT (c) 2001 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:libview2' }"

"{ NameSpace: Smalltalk }"

ActiveHelp subclass:#FlyByHelp
	instanceVariableNames:'currentFrame currentView currentHelpView showProcess closeProcess'
	classVariableNames:'MaxNumberOfLines MaxNumberOfColumns'
	poolDictionaries:''
	category:'Interface-Help'
!

!FlyByHelp class methodsFor:'documentation'!

copyright
"
 COPYRIGHT (c) 2001 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
"
    an instance of me is used to provide tooltips 
    (sigh: smalltalk was ahead of its time in the early 90's:
     initially called 'activeHelp', then renamed to 'flyByHelp' 
     and now commonly known as tooltip).

    I will watch the mouse movements via an event hook, and determine
    where the mouse pointer is. Then ask the underlying view about its
    helpText and display it in a little floating popup view.

    The hool is installed via:
     FlyByHelp start
    and possibly deactivated/uninstalled via:
     FlyByHelp stop

    There can be only one FlyByHelp at any time - the start/stop methods
    assure that.
"
!

examples
"
    UserPreferences current toolTipShapeStyle:nil
    UserPreferences current toolTipShapeStyle:#cartoon

     FlyByHelp isActive

     FlyByHelp stop
     FlyByHelp start
"
! !

!FlyByHelp class methodsFor:'accessing'!

currentlyShownView
    TheOneAndOnlyHelpListener isNil ifTrue:[^ nil].
    ^ TheOneAndOnlyHelpListener currentlyShownView

    "Modified: / 09-06-2010 / 16:35:48 / cg"
!

maxNumberOfColumns
    ^ MaxNumberOfColumns ? 200
!

maxNumberOfLines
    ^ MaxNumberOfLines ? 40
! !

!FlyByHelp methodsFor:'defaults'!

flyByHelpTimeoutMillis
    "abort flyby help text generation, if no text can be generated within that
     time delta. This is used to abort long-lasting parsing/scanning/analysis in
     large methods when the mouse is moved over some syntactic constructs, and
     it takes too long to parse...
     The returned time is given in ms"

    ^ 300
! !

!FlyByHelp methodsFor:'event handling'!

buttonMotion:buttonAndModifierState x:x y:y view:aView
    aView == currentHelpView ifTrue:[
        "/ the help-bubble itself
        ^ false
    ].

    "/ don't start tooltip, if this view is not active.
    "/ The following line does not work, because motion events are reported for the current focus-view,
    "/ which is always active. Must check after we have determined the view under the pointer
    "/      aView topView isActive ifFalse:[^ false].

    ^ super buttonMotion:buttonAndModifierState x:x y:y view:aView
!

buttonPress:button x:x y:y view:aView
    |prevView|

    "/ hideHelp nils the currentView
    "/ we restore it, so the tooltip is not shown again for this view
    "/ until the mouse really leaves the view
    "/ let's call this the "do-not-show-in-this-view mode"
    prevView := currentView.
    self hideHelp.
    currentView := prevView.

    ^ false

    "Modified: / 23-12-2011 / 20:37:28 / cg"
!

keyPress:key x:x y:y view:aView
    <resource: #keyboard (#Escape)>

    |prevView|

    currentHelpView notNil ifTrue:[
        key == $§ ifTrue:[
            "/ generate a line suitable for the resources file (a null translation)
            "/ into the clipboard; makes it easy to add missing translations to a .rs file,
            "/ by pressing paragraph whenever you see an untranslated helptext
            aView setClipboardText:(lastHelpText storeString , '    ' , lastHelpText storeString).
            self hideHelp.
            ^ true
        ].
        key == #Escape ifTrue:[
            prevView := currentView.
            self hideHelp.
            currentView := prevView.
            ^ true
        ].
        (#('Shift' #'Shift_L' #'Shift_R') includes:key) ifTrue:[
            "/ do not close on those...
            ^ false
        ].
    ].

    "/ hideHelp nils the currentView
    "/ we restore it, so the tooltip is not shown again for this view
    "/ until the mouse really leaves the view
    "/ let's call this the "do-not-show-in-this-view mode"
    prevView := currentView.
    self hideHelpIgnoringErrors.
    currentView := prevView.

    ^ false
    "/ ^ super keyPress:key x:x y:y view:aView

    "Modified (format): / 25-12-2011 / 10:25:23 / cg"
    "Modified (format): / 16-04-2018 / 16:53:15 / stefan"
!

mouseWheelMotion:state x:x y:y amount:amount deltaTime:dTime view:aView
    currentHelpView notNil ifTrue:[
        self handleMouseIn:aView x:x y:y.
    ].
    ^ false
!

pointerLeave:state view:aView
    aView == currentHelpView ifTrue:[^ true].

    "/ clear the do-not-show-in-this-view mode (see keyPress)
"/     (currentHelpView isNil and:[currentView notNil]) ifTrue:[currentView := nil].

    ^ super pointerLeave:state view:aView
! !

!FlyByHelp methodsFor:'help texts'!

helpTextFromModel:aModel view:aView at:aPointOrNil 
    "helper: ask aModel for its helpText."

    |text|

    (aPointOrNil notNil and:[aModel respondsTo:#helpTextFor:at:]) ifTrue:[
        text := aModel helpTextFor:aView at:aPointOrNil.
        text notNil ifTrue:[
            "/ Transcript showCR:aModel.
            "/ Transcript showCR:'via model-text'; showCR:text.
            ^ text
        ].
    ].
    (aModel respondsTo:#helpTextFor:) ifTrue:[
        text := aModel helpTextFor:aView.
        text notNil ifTrue:[
            "/ Transcript showCR:aModel.
            "/ Transcript showCR:'via model-text'; showCR:text.
            ^ text
        ].
    ].
    ^ nil

    "Modified: / 09-01-2018 / 17:35:26 / stefan"
    "Modified: / 11-06-2018 / 09:53:40 / Claus Gittinger"
!

helpTextFromView:aView at:aPointOrNil 
    "helper: ask aView for its helpText."

    |text key app|

    "/ is there any view which does not understand helpTextAt: ???
    (aPointOrNil notNil and:[aView respondsTo:#helpTextAt:]) ifTrue:[
        text := aView helpTextAt:aPointOrNil.
        text notNil ifTrue:[
            "/ Transcript showCR:'via helpTextAt:'; showCR:text.
            ^ text
        ].
    ].
    "/ is there any view which does not understand helpText ???
    (aView respondsTo:#helpText) ifTrue:[
        text := aView helpText.
        text notNil ifTrue:[
            "/ Transcript showCR:'via helpText'; showCR:text.
            ^ text
        ].
    ].
    "/ to be enabled in next release...
"/    (aView superView notNil
"/    and:[aView superView respondsTo:#helpTextFor:]) ifTrue:[
"/        text := aView superView helpTextFor:aView.
"/        text notNil ifTrue:[^ text].
"/    ].

    "/ is there any view which does not understand helpKey ???
    (aView respondsTo:#helpKey) ifTrue:[
        key := aView helpKey.
        key notNil ifTrue:[
            app := aView application.
            app isNil ifTrue:[
                |topView topViewsHelpSpec|
                
                "/ special case for oldStyle Dialog subclasses.
                topView := aView topView.
                (topViewsHelpSpec := topView helpSpec) notNil ifTrue:[
                    text := topViewsHelpSpec at:key ifAbsent:nil.
                    text notNil ifTrue:[
                        "/ Transcript showCR:'via topViewspec+helpKey'; showCR:text.
                        ^ topView resources stringWithCRs:text.
                    ].    
                ].    
                app := Error handle:[:ex | nil] do:[ aView windowGroup mainGroup application ].
            ].
            app notNil ifTrue:[
                text := app helpTextForKey:key.
                true "text notNil" ifTrue:[
                    "/ Transcript showCR:'via helpKey+helpTextForKey:'; showCR:text.
                    ^ text
                ].
            ].
            text := aView resources string:key.
            true "(text notNil and:[text ~= key])" ifTrue:[
                "/ Transcript showCR:'via helpKey'; showCR:text.
                ^ text
            ]    
        ].
    ].
    ^ nil.

    "Modified: / 09-01-2018 / 17:38:42 / stefan"
    "Modified (format): / 07-06-2018 / 09:51:41 / sr"
    "Modified: / 07-09-2018 / 12:32:04 / Claus Gittinger"
! !

!FlyByHelp methodsFor:'queries'!

currentlyShownView
    ^ currentHelpView
!

toolTipFollowsMouse
    "if true, the tooltip-window moves with the pointer
     so that it stays away from (does not cover) the mouse pointer"

    ^ false

    "Modified: / 06-06-2018 / 17:37:19 / Claus Gittinger"
! !

!FlyByHelp methodsFor:'show & hide help'!

activeHelpViewForApplication:applicationOrNil text:helpText onDevice:aDevice
    applicationOrNil notNil ifTrue:[
        ^ applicationOrNil activeHelpViewFor:helpText onDevice:aDevice
    ].
    ^ ActiveHelpView for:helpText onDevice:aDevice.

    "
     (ActiveHelpView for:'Hello' onDevice:Display) open
    "
!

hideHelp
    "hide the help text"

    |p|

    "/ lastHelpText := nil.
    self stopHelpDisplayProcess.
    lastHelpText := nil.

    currentHelpView notNil ifTrue:[
        [
            currentHelpView notNil ifTrue:[
                currentHelpView destroy.
                currentHelpView := nil.
                currentView := nil.
            ]
        ] valueUninterruptably
    ].
    currentFrame := nil.
    (p := closeProcess) notNil ifTrue:[
        closeProcess := nil.
        p terminate.
    ]

    "Modified: / 28-06-1997 / 14:03:50 / cg"
    "Modified: / 16-04-2018 / 16:51:01 / stefan"
!

hideIfPointerLeft:aView
    "hide help, if the pointer is not in aView"

    |helpFrame whereOnScreen|

    (helpFrame := currentFrame) notNil ifTrue:[
        whereOnScreen := aView graphicsDevice pointerPosition.

        ((helpFrame insetBy:1@1) containsPoint:whereOnScreen) ifFalse:[
            self hideHelp.
        ] ifTrue:[
            pointerPositionAtShowTime notNil ifTrue:[
                (whereOnScreen dist:pointerPositionAtShowTime) > 10 ifTrue:[
                    self hideHelp.
                ].    
            ].    
        ].            
    ].

    "Modified: / 28-05-1996 / 20:18:28 / cg"
    "Modified: / 16-04-2018 / 16:59:48 / stefan"
    "Modified: / 08-06-2018 / 10:30:04 / Claus Gittinger"
!

initiateHelpFor:aView at:aPointOrNil now:showItNow
    "ask aView for helpText, passing x/y coordinates;
     start a timeout process to display this helpText after some delay;
     Normally used internally, but can also be used by widgets to force 
     re-negotiation of the displayed helpText 
     (for example in a menu, when the selection changes)"

    |text delayTime|

    (self interestedIn:aView) ifFalse:[
        ^ self
    ].

    "/ do not allow for more than 200 ms to be spent in the
    "/ helpText gatherer (the codeView parses the code for the variable under the cursor)
    [
        Error handle:[:ex |
            ('FlyByhelp [warning]: error while asking for helpText: ',ex description) errorPrintCR.
            Transcript showCR:'-------------------------'.
            ex suspendedContext fullPrintAllOn:Transcript.
            "/ self halt.
        ] do:[
            text := self helpTextFor:aView at:aPointOrNil.
        ].
    ] valueWithWatchDog:[ 
        'FlyByhelp [info]: flyBy text generation took too long' infoPrintCR.
        ^ self 
    ] afterMilliseconds:(self flyByHelpTimeoutMillis).

    false ifTrue:[
        (text notNil and:[text isEmpty]) ifTrue:[ 
            Logger warning:('empty help from: ',aView class printString)
        ] ifFalse:[
            text isEmptyOrNil ifTrue:[ 
                Logger warning:('no help from: ',aView class printString)
            ].
        ].
    ].
    
    (lastHelpText = text and:[lastHelpWidget == aView]) ifTrue:[ 
        self toolTipFollowsMouse ifFalse:[
            ^ self
        ]
    ].

    ((text size > 0) or:[text notNil and:[text isString not]]) ifTrue:[
        (showItNow not and:[(delayTime := self delayTime) > 0]) ifTrue:[
            self stopHelpDisplayProcess.
            showProcess := 
                [
                    Delay waitForSeconds:delayTime.
                    [
                        aView device notNil ifTrue:[    
                            aView device anyButtonPressed ifFalse:[
                                showProcess := nil.
                                self showHelp:text for:aView
                            ]
                        ].
                    ] ensure:[
                        showProcess := nil.
                    ]
                ] forkAt:(Processor userSchedulingPriority + 1).
        ] ifFalse:[
            self showHelp:text for:aView
        ]
    ] ifFalse:[
        self hideHelp
    ].

    "Modified: / 22-03-2011 / 19:10:28 / cg"
    "Modified: / 16-04-2018 / 12:20:33 / stefan"
    "Modified: / 06-06-2018 / 17:19:26 / Claus Gittinger"
!

showHelp:aHelpText for:view
    "show the help text for aView"

    |wg applicationOrNil org p v device helpTextShown textLines
     helpViewWidth helpViewHeight usableWidth monitorBounds usableHeight
     showTime cursorView pos pointerPosition|

    "/ thisContext fullPrintAllOn:Transcript.
    (wg := view windowGroup) notNil ifTrue:[
        wg isInModalLoop ifTrue:[
            wg isModal ifFalse:[
                ^ self
            ].
        ].
    ].

    device := view graphicsDevice.
    pointerPosition := device pointerPosition.
    
    "/ mouse still over that view?
    cursorView := device viewFromPoint:pointerPosition.
    cursorView ~~ view ifTrue:[
        Debugging ifTrue:[ 'mouse no longer in view' infoPrintCR ].
        ^ self
    ].

    (view == currentView and:[lastHelpText = aHelpText]) ifTrue:[
        ^ self
    ].

    pointerPositionAtShowTime := pointerPosition.
    lastHelpWidget := view.
    lastHelpText := aHelpText.
    helpTextShown := aHelpText.
    
    "/ the text originator must already have generated CRs;
    "/ no longer done here (otherwise, we could not generate tooltips with Windows filenames in it)
    textLines := helpTextShown isStringCollection 
                    ifTrue:[helpTextShown]
                    ifFalse:[ 
                        helpTextShown isString 
                            ifTrue:[helpTextShown asCollectionOfLines asStringCollection]
                            ifFalse:[nil]].
    textLines notNil ifTrue:[
        textLines size > (self class maxNumberOfLines) ifTrue:[
            textLines := (textLines copyTo:(self class maxNumberOfLines)) copyWith:'...'
        ].
        textLines := textLines collect:[:l | l contractAtEndTo:(self class maxNumberOfColumns)].
        helpTextShown := textLines asString.
    ].
    
    (p := closeProcess) notNil ifTrue:[
        closeProcess := nil.
        p terminate.
    ].
    currentHelpView notNil ifTrue:[
        self hideHelp
    ].

    "/ Transcript showCR:helpTextShown storeString.
    helpTextShown isEmptyOrNil ifTrue:[^ self].
    
    org := view originRelativeTo:nil.
    currentFrame := org extent:view extent.
    org := org + (view extent // 2).

    wg notNil ifTrue:[ applicationOrNil := wg application ].
    v := self activeHelpViewForApplication:applicationOrNil text:helpTextShown onDevice:device.
    v perform:#controllingHelpListener: with:self ifNotUnderstood:[].

    helpViewWidth := v width.
    helpViewHeight := v height.

    "https://expeccoalm.exept.de/D226383: keep the help window away from the pointer under any circumstances
     (especially when the window touches the bottom or the right edge of the screen).
     When the pointer is no longer in the current window, the help window is closed!!"
    pos := device pointerPosition.
    org := pos + (10@18).
    monitorBounds := device monitorBoundsAt:org.
    usableWidth := monitorBounds width - 2.
    usableHeight := device usableHeightAt:org.

    helpViewWidth > usableWidth ifTrue:[v width:(helpViewWidth := usableWidth)].    
    helpViewHeight > usableHeight ifTrue:[v height:(helpViewHeight := usableHeight)].    

    (org x + helpViewWidth) > (monitorBounds left + usableWidth) ifTrue:[
        org x:(monitorBounds left + usableWidth - helpViewWidth).
    ].
    (org y + helpViewHeight) > (monitorBounds top + usableHeight) ifTrue:[
        org y:(monitorBounds top + usableHeight - helpViewHeight).
    ].
    ((org extent:v extent) containsPoint:pos) ifTrue:[
        "pointer would be in the help window (see comment above).
         Help window is at the lower right edge. Move it to the left of the pointer"
        org x:(pos x - helpViewWidth - 20).
    ].
    v origin:org.
    v realize.
    currentHelpView := v.
    currentView := view.

    showTime := self showTime.
    (showTime > 0) ifTrue:[
        p :=
            [
                [
                    Delay waitForSeconds:showTime.
                    [
                        |v|
                        (v := currentHelpView) notNil ifTrue:[
                            currentHelpView := nil.
                            v destroy.
                        ]
                    ] valueUninterruptably
                ] ifCurtailed:[
                    (p == closeProcess) ifTrue:[ closeProcess := nil ].
                ].
            ] newProcess.
        p priority:(Processor userSchedulingPriority + 1).
        closeProcess := p.
        p resume.
    ].

    "Modified: / 31-08-1995 / 19:20:45 / claus"
    "Modified: / 06-06-2017 / 15:06:41 / cg"
    "Modified (format): / 16-04-2018 / 17:29:10 / stefan"
    "Modified: / 08-06-2018 / 10:28:32 / Claus Gittinger"
    "Modified (format): / 14-06-2018 / 08:29:43 / Claus Gittinger"
!

stopHelpDisplayProcess
    |p|

    (p := showProcess) notNil ifTrue:[
        showProcess := nil.
        p terminate.
    ].

    "Created: 28.6.1997 / 14:03:17 / cg"
! !

!FlyByHelp class methodsFor:'documentation'!

version
    ^ '$Header$'
!

version_CVS
    ^ '$Header$'
! !