"

 COPYRIGHT (c) 1996-2011 by Claus Gittinger

 New code and modifications done at SWING Research Group [1]:

 COPYRIGHT (c) 2010-2011 by Jan Vrany, Jan Kurs and Marcel Hlopko

                            SWING Research Group, Czech Technical University in Prague

 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.

 [1] Code written at SWING Research Group contains a signature

     of one of the above copright owners. For exact set of such code,

     see the differences between this version and version stx:libjava

     as of 1.9.2010

"

"{ Package: 'stx:libjava' }"

Object subclass:#JavaClassRegistry

	instanceVariableNames:'vm loaders notifier'

	classVariableNames:''

	poolDictionaries:'JavaVMData'

	category:'Languages-Java-Support'

!

!JavaClassRegistry class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1996-2011 by Claus Gittinger

 New code and modifications done at SWING Research Group [1]:

 COPYRIGHT (c) 2010-2011 by Jan Vrany, Jan Kurs and Marcel Hlopko

                            SWING Research Group, Czech Technical University in Prague

 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.

 [1] Code written at SWING Research Group contains a signature

     of one of the above copright owners. For exact set of such code,

     see the differences between this version and version stx:libjava

     as of 1.9.2010

"

! !

!JavaClassRegistry class methodsFor:'instance creation'!

for: aJavaVM

    ^self new setVM: aJavaVM.

    "Created: / 21-12-2010 / 19:42:55 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

new

    ^ self basicNew initialize.

    "Modified (format): / 30-10-2011 / 12:07:09 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassRegistry class methodsFor:'others'!

version_HG

    ^ '$Changeset: <not expanded> $'

! !

!JavaClassRegistry methodsFor:'accessing'!

classForName: className loader: classLoader ifAbsent: aBlock 

    "Get class loaded by given classLoader from registry or evaluate aBlock if class is not yet registered"

    | classes class |

    self assert: (className includes: $.) not.

    "Classes loaded by primordial classloader are always

     used"

    classLoader notNil ifTrue:[

        classes := loaders at: nil ifAbsent: nil.

        class := classes at: className ifAbsent: nil.

        class notNil ifTrue:[

            ^class.

        ]

    ].

    "No bootstrap class found, search given classloader"

    classes := loaders at: classLoader ifAbsent: [^aBlock value].

    ^classes at: className ifAbsent: aBlock

    "Modified: / 21-10-2011 / 12:39:04 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

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

!

classForName: className loader: classLoader ifAbsentPut: block 

    "Get class loaded by classLoader from registry. if absent block is evaluated and resulting class in registered in registry, "

    | class |

    self assert: (className includes: $.) not.

     "if class is already registered with the same cl, just return it"

    class := self classNamed: className loader: classLoader.

    class notNil ifTrue: [ ^ class ].

    "if java vm is booted, nil class loader means system class loader, lets check it too"

    (vm notNil and:[vm booted and: [classLoader isNil]]) ifTrue: [

        class := self classNamed: className loader: vm systemClassLoader. 

        class notNil ifTrue: [^class]

    ].

     "otherwise evaluate block"

    class := block value.

    class notNil ifTrue: [

    self registerClass: class.].

    ^ class.

    "Created: / 21-10-2011 / 12:00:30 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

    "Created: / 23-10-2011 / 11:36:51 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 02-11-2011 / 17:29:20 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

    "Modified (format): / 24-01-2013 / 11:19:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

classNamed: className

    "Return a class for given classname loaded by 'current classloader' or 

     nil if not yet loaded"

    ^self classNamed: className loader: JavaClassReader classLoaderQuerySignal query

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

!

classNamed: className loader: classLoader

    "Return a class for given classname loaded by given classloader or 

     nil if not yet loaded"

    ^self classForName: className loader: classLoader ifAbsent:[nil].

    "Created: / 23-10-2011 / 12:23:02 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

classes

    ^Iterator on:[:whatToDo|self classesDo: whatToDo]

    "Created: / 23-10-2011 / 20:14:28 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

systemPackage: syspkg

    "Return name (as string) of system package named syspkg or nil if no such package is loaded"

    | classes syspkgSlashed |

    classes := loaders at: nil ifAbsent:[nil].

    classes isEmptyOrNil ifTrue:[ ^ #() ].

    syspkgSlashed := syspkg copyReplaceAll: $. with: $/.

    classes keysDo:[:name|

        (name startsWith:syspkgSlashed) ifTrue:[

            ^ syspkg

        ]

    ].

    ^ nil

    "Created: / 16-08-2012 / 17:40:38 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

systemPackages

    "Return a collection system packages (as smalltalk strings) currently loaded"

    | classes syspkgs |

    classes := loaders at: nil ifAbsent:[nil].

    classes isEmptyOrNil ifTrue:[ ^ #() ].

    syspkgs := Set new.

    classes keysDo:[:name|

        | slashpos |

        slashpos := name lastIndexOf: $/.

        slashpos ~~ 0 ifTrue:[

            | syspkg |

            syspkg := name copyTo: slashpos - 1.

            syspkg replaceAll: $/ with: $..

            syspkgs add: syspkg.

        ]

    ].

    ^syspkgs

    "Created: / 16-08-2012 / 17:32:35 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassRegistry methodsFor:'class loading'!

loadFile: aFilename 

    "reads a class from aFilename, installs and returns it."

    | aClass |

    self breakPoint: #mh.

    aClass := JavaClassReader readFile: aFilename ignoring: Set new.

    aClass isJavaClass ifFalse:[self breakPoint:#mh].

    self registerClass: aClass.

    ^ aClass.

    "Created: / 15-04-1996 / 14:58:53 / cg"

    "Modified: / 12-05-1998 / 22:06:52 / cg"

    "Modified: / 23-10-2011 / 11:55:36 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

loadStream: javaClassDataStream loader: aJavaClassLoader 

    "reads a class from aStream and returns it.

     The JavaClass is installed as global.

     If new classes are required to be loaded, aClassLoader is

     asked to do it."

    | javaClass |

    self breakPoint: #mh.

    self breakPoint: #jv.

    javaClass := JavaClassReader readStream: javaClassDataStream loader: aJavaClassLoader.

    javaClass isNil ifTrue: [

            Logger 

                log: 'JavaClassReader was not able to read given data stream'

                severity: #warn

                facility: #JVM.

            self breakPoint: #mh.

            ^ nil.

        ].

    javaClass isJavaClass ifFalse: [ self breakPoint: #mh. ].

    javaClass classLoader: aJavaClassLoader.

    self registerClass: javaClass.

    ^ javaClass

    "Modified: / 02-05-2013 / 09:55:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassRegistry methodsFor:'enumerating'!

classesDo: aBlock

    loaders do:[:classes|

        classes do:[:class|

            aBlock value: class

        ]        

    ]

    "Created: / 23-10-2011 / 20:13:40 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassRegistry methodsFor:'helpers'!

addClassLoader: aJavaClassLoader

loaders at: aJavaClassLoader put: Dictionary new.

!

getClassesDefinedBy:classLoader 

    ^loaders at: classLoader ifAbsent: [nil].

! !

!JavaClassRegistry methodsFor:'initialization'!

flush

    self initialize.

    "Modified: / 30-10-2011 / 12:06:20 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

initialize

    loaders := WeakIdentityDictionary new.

    loaders at: nil put: Dictionary new.

    notifier := BackgroundQueueProcessingJob 

                    named: 'Java class registry notifier'

                    on:[:typeAndClass|Smalltalk changed: typeAndClass first with: typeAndClass second].

    notifier priority: Processor userBackgroundPriority - 1.

    "Modified: / 08-02-2013 / 00:58:28 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

setVM: aJavaVM

    "Now, aJavaVM == JavaVM (i.e, the class JavaVM 

    itself, not its instance)"

    vm := aJavaVM.

    "Created: / 21-12-2010 / 19:44:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (format): / 07-02-2013 / 17:36:19 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassRegistry methodsFor:'registering'!

registerClass: newClass

    | classes oldClass |

    ((newClass binaryName == #'$do$It$') 

        and:[newClass superclass binaryName == #'groovy/lang/Script']) ifTrue:[

        "/ Mhhh...Groovy do-it. No need to register this!!

        ^ self

    ].

    self assert: (newClass binaryName includes: $.) not.

    loaders keysAndValuesDo:[:loader :classesPerLoader|

        (classesPerLoader includesKey: newClass binaryName) ifTrue:[

            loader == newClass classLoader ifTrue:[

                (oldClass := classesPerLoader at: newClass binaryName) ~~ newClass ifTrue:[

                    "Class already exists, reload & reinstall"

                    | reloadedClass |

                    reloadedClass := JavaClassReloader reload: oldClass with: newClass.

                    "/OK, full reload, not just method dictionary update"

                    reloadedClass ~~ oldClass ifTrue:[

                        classesPerLoader

                            at: newClass binaryName 

                            put: reloadedClass.

                        self registerClassInSmalltalk: reloadedClass notify: false.

                    ].

                    Smalltalk changed: #classDefinition with: reloadedClass.

                    ^self.             

                ].

            ].

        ].

    ].

    classes := loaders at: newClass classLoader ifAbsent: nil.

    classes isNil ifTrue:[

        classes := loaders at: newClass classLoader put: Dictionary new.

    ].

    classes at: newClass binaryName  put: newClass.

    "/ There may be classes already loaded with compile errors.

    "/ Try to recompile all erroneous classes that depends on this one...

    JavaCompiler notNil ifTrue:[

       JavaCompiler recompileErroneousClassesReferringTo: newClass ignoring: newClass.  

    ].

    "Created: / 23-10-2011 / 11:53:58 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 02-11-2011 / 18:40:52 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

registerClassInSmalltalk: javaclass notify: doNotify

    "Registers class in Smalltalk system dictionary and

     notifies system, so the class become visible by

     Smalltalk"

    | nameComponents accessor nsName nsNameAsSymbol ns  |

    javaclass isSynthetic ifTrue:[ ^ self ].

    nameComponents := javaclass binaryName asCollectionOfSubstringsSeparatedBy:$/.

    nameComponents size > 1 ifTrue:[

        javaclass setCategory:((nameComponents asStringWith:$/ from:1 to:(nameComponents size - 1))

                            replaceAll:$/ with:$. ).

    ] ifFalse:[

        javaclass setCategory:#'(default)'

    ].

    nameComponents size > 1 ifTrue:[

        javaclass setPackage:((nameComponents copyButLast:1) asStringWith:$/) asSymbol

    ] ifFalse:[

        javaclass setPackage:#'java/(default)'

    ].

    "/ break up the package and create nameSpaces

    "/ for each package component.

    "/ This allows java.foo.bar to be visible in ST/X

    "/ under the name JAVA::java::foo::bar

    accessor := javaclass"JavaClassAccessor fullName: aString".    

    nsName := javaclass nameSpaceName.

    nsNameAsSymbol := nsName asSymbolIfInterned.

    (nsNameAsSymbol isNil or:[(ns := Smalltalk at: nsNameAsSymbol) isNil]) ifTrue:[

        Metaclass confirmationQuerySignal answer:false do:[

            Class withoutUpdatingChangesDo:[

                ns := JavaPackage fullName:(nsName contents).

            ].

        ].

    ].

    ns isNameSpace ifTrue:[

        ns at:nameComponents last asSymbol put:accessor.

        javaclass setEnvironment: ns.

        javaclass setName: (nsName , '::' , nameComponents last) asSymbol

    ] ifFalse:[

        self breakPoint: #jv

    ].

    doNotify ifTrue:[

        notifier add:(Array with: #newClass with: javaclass).

    ].

    "Created: / 04-04-2012 / 10:01:09 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 08-10-2013 / 19:27:42 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

registerClasses: classes

    classes do:[:cls|self registerClass: cls].

    "Created: / 02-01-2013 / 17:01:15 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

registerClasses: classes andWait: doWait

    "Register given set of classes and if

     `doWait` is true, wait until all pending notifications

     are delivered"

    classes do:[:cls|self registerClass: cls].

    doWait ifTrue:[

        notifier waitUntilProcessed.

    ]

    "Created: / 04-08-2013 / 03:55:49 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

unregisterClass: oldClass

    | classes |

    "/ First. remove the class from system dictionary

    "/ and from registry so nobody could resolve it.

    self unregisterClassInSmalltalk: oldClass notify: true.

    classes := loaders at: oldClass classLoader ifAbsent: nil.

    classes notNil ifTrue:[

        "/ Check if the class is there, it could be removed meanwhile...

        (classes includesKey: oldClass binaryName) ifTrue:[

            classes removeKey: oldClass binaryName.

            "/ Now, invalidate references and unload all dependent clases

            "/ (JavaClassReloader will unload them by recursively call #unregisterClass:

            JavaClassReloader unload: oldClass.

        ]

    ].

    "Created: / 04-04-2012 / 02:43:16 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 14-09-2013 / 23:41:52 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (comment): / 17-10-2013 / 02:25:47 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

unregisterClassInSmalltalk: javaclass notify: doNotify

    "Unregisters given class from Smalltalk system dictionary

     so the class is no longer visible from Smalltalk"

    | nameInSmalltalk nameInSmalltalkSymbol nameSpace |

    "/ Must wait here - if classes are added and removed too fast,

    "/ a race condition occur in stx:libbasic code (something is

    "/ nilled menawhile and event handler does not handle this case.

    "/ This can happen for example when running tests...

    notifier waitUntilProcessed.        

    javaclass isSynthetic ifTrue:[ ^ self ].

    nameSpace := javaclass nameSpace.

    nameInSmalltalk := javaclass nameInSmalltalk.

    nameInSmalltalkSymbol := nameInSmalltalk asSymbolIfInterned.

    nameInSmalltalkSymbol notNil ifTrue:[

        Smalltalk removeKey: nameInSmalltalkSymbol

    ].

    doNotify ifTrue:[

        notifier add:(Array with: #classRemove with: javaclass).

    ].

    [ nameSpace notNil and:[nameSpace ~~ JAVA and:[nameSpace allClasses size == 0]]] whileTrue:[

        Smalltalk removeClass: nameSpace.

        nameSpace := nameSpace nameSpace.

    ].

    "Created: / 04-04-2012 / 10:01:40 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 17-10-2013 / 10:50:17 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

unregisterClassLoader: aJavaClassLoader 

    | classes |

    classes := loaders at: aJavaClassLoader ifAbsent:[ ^ self ].

    self unregisterClasses: classes values.

    loaders removeKey: aJavaClassLoader.

    "Created: / 16-12-2012 / 16:39:45 / Marcel Hlopko <marcel.hlopko@fit.cvut.cz>"

    "Modified: / 17-10-2013 / 10:37:16 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

unregisterClasses: classes

    classes do:[:cls|self unregisterClass: cls].

    "Created: / 02-01-2013 / 17:01:26 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassRegistry class methodsFor:'documentation'!

version_CVS

    ^ '$Header: /cvs/stx/stx/libjava/JavaClassRegistry.st,v 1.5 2013-09-06 00:41:22 vrany Exp $'

!

version_SVN

    ^ 'Id'

! !