"{ Encoding: utf8 }"

"

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

"{ NameSpace: Smalltalk }"

Lookup subclass:#JavaLookup

	instanceVariableNames:'j2j j2s s2j'

	classVariableNames:'Instance InvokeRSelectors'

	poolDictionaries:''

	category:'Languages-Java-Interop'

!

Lookup subclass:#JVM

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:JavaLookup

!

JavaLookup::JVM subclass:#J2S

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:JavaLookup

!

JavaLookup::JVM subclass:#J2J

	instanceVariableNames:''

	classVariableNames:'NoSuchMethodErrorSelector'

	poolDictionaries:''

	privateIn:JavaLookup

!

JavaLookup::JVM subclass:#S2J

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

    j2j := J2J new.

    j2s := J2S new. 

    s2j := S2J new.

    "Modified: / 22-03-2016 / 22:39:19 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup methodsFor:'lookup'!

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"

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

        ].

        self breakPoint: #jv.

    ].

    ^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: / 22-03-2016 / 22:44:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup::JVM methodsFor:'lookup'!

lookupMethodForSelector: selector directedTo: c

    "This method performs standard Java lookup as required JVM 8 spec, 6.5 invokevirtual.

     NOTE: This method only handles Java method, i.e., it never returns a Smalltak

     (or other language's) extension method."

    | m s |

    "Let C be the class of objectref. The actual method to be invoked is selected by the 

     following lookup procedure:

     1. If C contains a declaration for an instance method m that

        overrides (§5.4.5) the resolved method, then m is the method

        to be invoked.

     2. Otherwise, if C has a superclass, a search for a declaration

        of an instance method that overrides the resolved method

        is performed, starting with the direct superclass of C and

        continuing with the direct superclass of that class, and so forth,

        until an overriding method is found or no further superclasses

        exist. If an overriding method is found, it is the method to be

        invoked."

    m := super lookupMethodForSelector: selector directedTo: c.

    m isJavaMethod ifTrue:[

        m notNil ifTrue:[

            [ (s := super lookupMethodForSelector: selector directedTo: m mclass superclass) notNil ] whileTrue:[

                (m overrides: s) ifFalse:[

                    m := s

                ].

            ].

        ].

    ].

    "3. Otherwise, if there is exactly one maximally-specific method

        (§5.4.3.3) in the superinterfaces of C that matches the resolved

        method's name and descriptor and is not abstract , then it is

        the method to be invoked.

    "

    m isNil ifTrue:[ 

        | class interfaces superinterfaces interfaceMethod |

        class := c.

        interfaces := Set new.

        "/ Collect interfaces from all superclasses. 

        "/ We cannot use JavaClass>>allInterfaces as it also

        "/ returns superinterfaces of interfaces, flattened."

        [ class notNil ] whileTrue:[ 

            interfaces addAll: c interfaces.

            class := class superclass.

        ].

        [ interfaces notEmpty ] whileTrue:[

            interfaces do:[ :interface|

                | interfaceMethod superinterfaces |

                interfaceMethod := interface compiledMethodAt: selector.

                "/ We must also test whether found is a JavaMethod. It could

                "/ be a Smalltalk extension in the interface - such methods

                "/ are not handled here (no such thing in JVM spec)

                (interfaceMethod notNil and: [interfaceMethod isJavaMethod]) ifTrue:[

                    m := interfaceMethod.

                    "/ To terminate the loop

                    interfaces := superinterfaces := #().

                ] ifFalse:[

                    superinterfaces isNil ifTrue:[ 

                        superinterfaces := Set new.

                    ].

                    superinterfaces addAll: interface interfaces.

                ].

                interfaces := superinterfaces.

            ]

        ]

    ].

    ^ m

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

    "Modified: / 29-03-2016 / 20:42:05 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup::J2S 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::J2S 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::J2J class methodsFor:'initialization'!

initialize

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

    NoSuchMethodErrorSelector := #(

            " 0" #'throwNoSuchMethodError'

            " 1" #'throwNoSuchMethodError_:'

            " 2" #'throwNoSuchMethodError_:_:'

            " 3" #'throwNoSuchMethodError_:_:_:'

            " 4" #'throwNoSuchMethodError_:_:_:_:'

            " 5" #'throwNoSuchMethodError_:_:_:_:_:'

            " 6" #'throwNoSuchMethodError_:_:_:_:_:_:'

            " 7" #'throwNoSuchMethodError_:_:_:_:_:_:_:'

            " 8" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:'

            " 9" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:_:'

            "10" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:_:_:'

            "11" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:_:_:_:'

            "12" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:_:_:_:_:'

            "13" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:_:_:_:_:_:'

            "14" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:_:_:_:_:_:_:'

            "15" #'throwNoSuchMethodError_:_:_:_:_:_:_:_:_:_:_:_:_:_:_:'

    ).

    "Modified (comment): / 29-03-2016 / 21:07:01 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup::J2J methodsFor:'lookup'!

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

    | method |

    method := self lookupMethodForSelector: selector directedTo: initialSearchClass.

    "/ No method found. Return a trampoline that will throw NoSuchMethodError

    method isNil ifTrue:[ 

        method := JavaVM class >> (NoSuchMethodErrorSelector at: argArrayOrNil size + 1)

    ].

    ilcCache notNil ifTrue:[

        ilcCache bindTo: method forClass: initialSearchClass.

    ].

    ^ method.

    "Created: / 22-03-2016 / 22:43:05 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 29-03-2016 / 20:45:21 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaLookup::S2J 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"