"

 Copyright (c) 2010-2011 Jan Vrany, Jan Kurs & Marcel Hlopko,

                         SWING Research Group, Czech Technical University 

                         in Prague

 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:libjava' }"

Lookup subclass:#JavaLookup

	instanceVariableNames:'s2j j2s'

	classVariableNames:'Instance InvokeRSelectors'

	poolDictionaries:''

	category:'Languages-Java-Interop'

!

Lookup subclass:#Java2Smalltalk

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:JavaLookup

!

Lookup subclass:#Smalltalk2Java

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:JavaLookup

!

!JavaLookup class methodsFor:'documentation'!

copyright

"

 Copyright (c) 2010-2011 Jan Vrany, Jan Kurs & Marcel Hlopko,

                         SWING Research Group, Czech Technical University 

                         in Prague

 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.

"

! !

!JavaLookup class methodsFor:'initialization'!

initialize

    "Invoked at system start or when the class is dynamically loaded."

    "/ please change as required (and remove this comment)

    InvokeRSelectors := 

        #(

            " 0" #'_INVOKEVIRTUAL_R:_:'

            " 1" #'_INVOKEVIRTUAL_R:_:_:'

            " 2" #'_INVOKEVIRTUAL_R:_:_:_:'

            " 3" #'_INVOKEVIRTUAL_R:_:_:_:_:'

            " 4" #'_INVOKEVIRTUAL_R:_:_:_:_:_:'

            " 5" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:'

            " 6" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:'

            " 7" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:_:'

            " 8" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:_:_:'

            " 9" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:_:_:_:'

            "10" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:_:_:_:_:'

            "11" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:_:_:_:_:_:'

            "12" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:_:_:_:_:_:_:'

            "13" #'_INVOKEVIRTUAL_R:_:_:_:_:_:_:_:_:_:_:_:_:_:_:'

            " 0" #'_INVOKEINTERFACE_R:_:'

            " 1" #'_INVOKEINTERFACE_R:_:_:'

            " 2" #'_INVOKEINTERFACE_R:_:_:_:'

            " 3" #'_INVOKEINTERFACE_R:_:_:_:_:'

            " 4" #'_INVOKEINTERFACE_R:_:_:_:_:_:'

            " 5" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:'

            " 6" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:'

            " 7" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:_:'

            " 8" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:_:_:'

            " 9" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:_:_:_:'

            "10" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:_:_:_:_:'

            "11" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:_:_:_:_:_:'

            "12" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:_:_:_:_:_:_:'

            "13" #'_INVOKEINTERFACE_R:_:_:_:_:_:_:_:_:_:_:_:_:_:_:'

        )

    "Modified (format): / 20-01-2014 / 13:50:29 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup class methodsFor:'instance creation'!

cleanup

    Instance := nil.

    "Modified: / 25-02-2011 / 14:45:03 / kursjan <kursjan@fit.cvut.cz>"

    "Created: / 19-09-2011 / 23:25:08 / Jan Kurs <kursjan@fit.cvut.cz>"

    "Modified: / 15-12-2011 / 23:05:37 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

instance

    Instance isNil ifTrue:[

        Instance := self basicNew initialize

    ].

    ^Instance

    "Modified: / 25-02-2011 / 14:45:03 / kursjan <kursjan@fit.cvut.cz>"

    "Created: / 19-09-2011 / 23:20:49 / Jan Kurs <kursjan@fit.cvut.cz>"

    "Modified: / 15-12-2011 / 23:05:29 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

new

    ^ self shouldNeverBeSent.

    "Created: / 25-02-2011 / 14:44:43 / kursjan <kursjan@fit.cvut.cz>"

    "Modified: / 29-08-2011 / 21:10:12 / Jan Kurs <kursjan@fit.cvut.cz>"

! !

!JavaLookup methodsFor:'initialization'!

initialize

    "Invoked when a new instance is created."

    s2j := Smalltalk2Java new.

    j2s := Java2Smalltalk new.

    "Modified: / 15-12-2011 / 23:06:57 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup methodsFor:'lookup'!

lookupMethodForSelector: selector directedTo: initialSearchClass

    "This method performs standard Java lookup as required JVM spec. See 

        - JVM spec, 5.4.2.1 Method overriding

        - JVM spec, 6.4 invokevirtual

     This is hacky because of those stupid package-private methods. Sigh."

    | method superMethod |

    method := super lookupMethodForSelector: selector directedTo: initialSearchClass.

    method isNil ifTrue:[ ^ nil ].

    superMethod := super lookupMethodForSelector: selector directedTo: method mclass superclass.

    [ superMethod notNil ] whileTrue:[

        (method overrides: superMethod) ifFalse:[

            method := superMethod

        ].

        superMethod := super lookupMethodForSelector: selector directedTo: superMethod mclass superclass.

    ].

    ^method

    "Created: / 05-07-2012 / 11:06:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

lookupMethodForSelector:selector directedTo:initialSearchClass for:aReceiver withArguments:argArrayOrNil from:sendingContext ilc: ilcCache

    "Invoked by the VM to ask me for a method to call.

     The arguments are: the selector, receiver and arguments,

     the class to start the search in (for here-, super and directed sends)

     the sending context and the inline/poly cache (instance of

     PolymorphicInlineCache). "

     "JV@2012-08-21: Following C code speeds up Java<->Smalltalk interop by

      order of 2 magnitudes. However, it breaks Java reflection. 

      This is because it does not handle package private methods correctly.

      On the other hand, PP methods are not handled correctly when not using 

      reflection anyway, so lets keep the optimization here.

      Once we will have functinal JIT compiler, we can remove it and Java

      package-private method will be supported correctly in all cases.

     "

     | sender |

%{

    OBJ method;

    method = __lookup(initialSearchClass, selector);

    if ( method ) {

        if ( ilcCache ) {

            __ilcBind(ilcCache, initialSearchClass, method, selector);

        }

        RETURN (method);

    }

%}.

    "/ Sigh, here we have to care about different code paths. The new JIT compilation scheme

    "/ sends JavaVM>>_INVOKE*R:... for sends whose methodref is not yet resolved. Thus the stack

    "/ (starting with sendingContext) may look like:

    "/ 

    "/ (0) real sending context - whoever it is

    "/ 

    "/ for resolved/interpreted sends or:

    "/ 

    "/ (0) performWith:withArguments:

    "/ (1) _INVOKEVIRTUAL_R:* / _INVOKEINTERFACE_R:*

    "/ (2) real sending context - whoever it is

    "/ 

    "/ for unresolved sends from JIT-compiled code.

    "/ In tha latter case we have to skip those 2 'implementation' contexts:

    sender := sendingContext.

    sender selector == #perform:withArguments: ifTrue:[

        sender := sender sender.

        (sender receiver == JavaVM and: [ InvokeRSelectors includes: sender selector ]) ifTrue:[

            sender := sender sender.

        ] ifFalse:[

            sender := sendingContext.

        ].

    ].

    sender programmingLanguage isSmalltalk ifTrue:[

        aReceiver class theNonMetaclass programmingLanguage isJavaLike ifTrue:[

            ^s2j lookupMethodForSelector:selector directedTo:initialSearchClass for:aReceiver withArguments:argArrayOrNil from:sendingContext ilc: ilcCache.

        ].

    ].

    sender programmingLanguage isJavaLike ifTrue:[

        initialSearchClass programmingLanguage isSmalltalk ifTrue:[

            "Java to Smalltalk send"

            ^j2s lookupMethodForSelector:selector directedTo:initialSearchClass for:aReceiver withArguments:argArrayOrNil from:sendingContext ilc: ilcCache.

        ].

        initialSearchClass programmingLanguage isJavaLike ifTrue:[

            "Java to Java send"

            | m |

            m := self lookupMethodForSelector: selector directedTo: initialSearchClass.

            m notNil ifTrue:[

                ilcCache notNil ifTrue:[ ilcCache bindTo: m forClass: aReceiver class ].

                ^m.

            ]

        ].

    ].

    ^super lookupMethodForSelector:selector directedTo:initialSearchClass for:aReceiver withArguments:argArrayOrNil from:sendingContext ilc: ilcCache.

    "Created: / 01-10-2011 / 13:18:40 / Jan Kurs <kursjan@fit.cvut.cz>"

    "Created: / 15-12-2011 / 23:11:45 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 20-01-2014 / 13:27:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup::Java2Smalltalk methodsFor:'lookup'!

lookupMethodForSelector:selector directedTo:initialSearchClass for:receiver withArguments:argArrayOrNil from:sendingContext ilc: ilc

    | d m |

    d := JavaDescriptor readFrom: (selector readStream skipThrough: $(; backStep; yourself).

    m := self lookupMethodForSelector: selector directedTo: initialSearchClass numArguments: d numArgs.

    m notNil ifTrue: [

        m := self compileProxyWithSelector: selector descriptor: d in: receiver class calling: m.

        ilc notNil ifTrue:[ilc bindTo: m forClass: receiver class].

        ^m.

    ] ifFalse:[

        ^ nil

    ]

    "Created: / 06-09-2011 / 22:04:04 / Jan Kurs <kursjan@fit.cvut.cz>"

    "Modified: / 09-10-2011 / 22:59:18 / kursjan <kursjan@fit.cvut.cz>"

    "Created: / 19-11-2011 / 12:37:26 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

lookupMethodForSelector:jselector directedTo:initialSearchClass numArguments: nArgs

    | name cls |

    name := jselector upTo: $(.

    "Pass 1: Search for explicitly annotated method"

    cls := initialSearchClass.

    [ cls notNil ] whileTrue:[

        cls methodDictionary keysAndValuesDo:[:sel :mthd|

            | jdescriptor |

            mthd numArgs == nArgs ifTrue:[

                (jdescriptor := mthd annotationAt: #javaselector:) notNil ifTrue:[

                    jdescriptor arguments first == jselector ifTrue: [

                        ^mthd    

                    ]

                ].

            ]

        ].

        cls := cls superclass.

    ].

    "Pass 2: Search for method with matching name"

    cls := initialSearchClass.

    [ cls notNil ] whileTrue:[

        cls methodDictionary keysAndValuesDo:[:sel :mthd|

            mthd numArgs == nArgs ifTrue:[

                (sel startsWith: name) ifTrue:[

                    ^mthd

                ]

            ]

        ].

        cls := cls superclass.

    ].

    ^nil

    "Created: / 16-12-2011 / 00:00:31 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup::Java2Smalltalk methodsFor:'utilities'!

addSelector:selector withMethod:proxy toClass:class 

    ProxyMethod installProxies ifTrue:[

        Class withoutUpdatingChangesDo:[

            class addSelector:selector withMethod:proxy.

        ]

    ]

    "Modified: / 23-12-2011 / 13:09:06 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

compileProxyWithSelector:selector descriptor:descriptor in:class calling:callee 

    |compiler proxy body|

    compiler := ProxyMethodCompiler new.

    body := compiler newJavaMethodInvocation: callee.

    body descriptor:descriptor.

    proxy := compiler 

                compile:body 

                arguments:callee numArgs 

                selector: selector.

"/    JK: do nod add here

"/    JV: Why?

    self 

        addSelector:selector

        withMethod:proxy

        toClass:class.

    ^ proxy

    "Created: / 14-12-2011 / 20:48:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 01-01-2012 / 19:33:45 / kursjan <kursjan@fit.cvut.cz>"

    "Modified: / 24-02-2012 / 20:36:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup::Smalltalk2Java methodsFor:'lookup'!

lookupMethodForSelector: selector directedTo: initialSearchClass for: receiver withArguments: argArrayOrNil from: sendingContext ilc: ilc 

    "

     As a courtesy to a Smalltalker, try to map smalltalk selectors to a java ones.

     Returns a method or nil"

    | name nameSizePlusOne  candidates  finder1 finder2  static  cls  m ifacesQ ifacesSeen |

    name := selector upTo: $:.

    nameSizePlusOne := name size + 1.

    static := receiver isBehavior.

    candidates := OrderedCollection new.

    ifacesSeen := Set new.

    "/ Method finder to lookup extension methods in interfaces...

    finder1 := [:cls |

        cls interfaces notEmptyOrNil ifTrue:[

            ifacesQ := OrderedCollection with: (cls interfaces).

            [ ifacesQ notEmpty ] whileTrue:[

                | ifaces newIfaces extension |

                ifaces := ifacesQ removeFirst.

                extension := nil.

                ifaces do:[:iface |

                    (ifacesSeen includes: iface) ifFalse:[

                        | m |

                        ifacesSeen add: iface.

                        m := iface compiledMethodAt: selector.

                        m notNil ifTrue:[

                            extension notNil ifTrue:[

                                "/ Ambiguous, return error trampoline

                                | sel |

                                sel :=

                                    #(  ambiguousMessageSend

                                        ambiguousMessageSendWith:

                                        ambiguousMessageSendWith:With:

                                        ambiguousMessageSendWith:With:With:

                                        ambiguousMessageSendWith:With:With:With:

                                        ambiguousMessageSendWith:With:With:With:With:

                                        ambiguousMessageSendWith:With:With:With:With:With:

                                        ambiguousMessageSendWith:With:With:With:With:With:With:

                                        ambiguousMessageSendWith:With:With:With:With:With:With:With:

                                    ) at: selector numArgs + 1.

                                ^ self class compiledMethodAt: sel.

                            ] ifFalse:[

                                extension := m.

                            ].

                        ].

                    ].

                ].

                extension notNil ifTrue:[ ^ extension ].

                newIfaces := Set new.

                ifaces do:[:iface| newIfaces addAll: iface interfaces ].

                newIfaces notEmpty ifTrue:[

                    ifacesQ add: newIfaces.

                ].        

            ].

        ].

    ]. 

    "/ Method finder to map Java methods to smalltalk selectors...

    finder2 := [:cls |

        cls methodDictionary keysAndValuesDo: [:sel :mthd | 

            "candidates may contain a method with same selector ->

             do not add super-class's method"

            (candidates contains: [:each | each selector == sel ]) ifFalse: [

                (mthd mclass ~~ ProxyMethod 

                    and: [

                        ((sel size >= nameSizePlusOne) 

                            and: [ (sel at: nameSizePlusOne) == $( and: [ (sel startsWith: name) ] ]) 

                                and: [ mthd descriptor numArgs == argArrayOrNil size ]

                    ]) 

                        ifTrue: [ candidates add: mthd ]

            ]

        ]

    ].

    "Search class for method candidates"

    cls := initialSearchClass theNonMetaclass.

    static ifTrue: [ 

        finder2 value: cls 

    ] ifFalse: [

        [ cls notNil and: [ cls ~~ JavaObject ] ] whileTrue: [

            finder1 value: cls.

            finder2 value: cls.

            cls := cls superclass.

        ]

    ].

    candidates notEmpty ifTrue: [

        "because java compiler generates synthetic method, when overriden

         method has narrower return type than method from superclass/interface,

         we don't take these particular synthetic methods as candidates, they just

         delegate to overridden methods."

        ((candidates size > 1) and:[candidates anySatisfy:[:each|each isSynthetic]]) ifTrue:[

            | candidatesPerNameAndArg |

            candidatesPerNameAndArg := Dictionary new.

            candidates do:[:each|

                | nameAndArgs |

                nameAndArgs := each selector upTo:$).

                candidatesPerNameAndArg at: nameAndArgs ifAbsentPut:[each]. 

            ].

            candidates := candidatesPerNameAndArg values.

        ].        

        m := self 

                compileProxyWithSelector: selector

                in: receiver class

                calling: candidates.

        ilc notNil ifTrue: [ ilc bindTo: m forClass: receiver class ].

         "Install the proxy"

        self 

            addSelector: selector

            withMethod: m

            toClass: receiver class.

        ^ m.