"

 COPYRIGHT (c) 1996-2011 by Claus Gittinger

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

                            SWING Research Group, Czech Technical University in Prague

 Parts of the code written by Claus Gittinger are under following

 license:

 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.

 Parts of the code written at SWING Reasearch Group [1] are MIT licensed:

 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.

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

     of one of the above copright owners.

"

"{ Package: 'stx:libjava' }"

Object subclass:#JavaClassReader

	instanceVariableNames:'inStream msb constants majorVsn minorVsn constNeeds2Slots

		constSlot classBeingLoaded'

	classVariableNames:'Verbose AnnotationsVerbose Silent AbsolutelySilent

		LazyClassLoading InvalidClassFormatSignal ClassLoaderQuerySignal

		JavaArchiveCache'

	poolDictionaries:''

	category:'Languages-Java-Support'

!

!JavaClassReader class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1996-2011 by Claus Gittinger

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

                            SWING Research Group, Czech Technical University in Prague

 Parts of the code written by Claus Gittinger are under following

 license:

 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.

 Parts of the code written at SWING Reasearch Group [1] are MIT licensed:

 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.

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

     of one of the above copright owners.

"

! !

!JavaClassReader class methodsFor:'initialization'!

initialize

    InvalidClassFormatSignal := Signal new mayProceed: true.

    InvalidClassFormatSignal notifierString: 'class load failure'.

    InvalidClassFormatSignal nameClass: self message: #invalidClassFormatSignal.

    Verbose := false.

    Silent := true.

    AbsolutelySilent := false.

    "/LazyClassLoading := false.

    LazyClassLoading := true.

    ClassLoaderQuerySignal := QuerySignal new.

    JavaArchiveCache := CacheDictionary new: 32.

    AnnotationsVerbose := false.

    "

     JavaClassReader initialize"

    "Modified: / 27-01-1998 / 17:54:23 / cg"

    "Modified: / 17-12-2010 / 17:37:45 / Marcel Hlopko <hlopik@gmail.com>"

    "Modified: / 10-05-2011 / 23:59:53 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

    "Modified: / 26-07-2011 / 17:21:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassReader class methodsFor:'Signal constants'!

classLoaderQuerySignal

    ^ ClassLoaderQuerySignal

    "Created: 14.8.1997 / 19:56:03 / cg"

!

invalidClassFormatSignal

    ^ InvalidClassFormatSignal

    "Created: 3.8.1997 / 18:17:21 / cg"

! !

!JavaClassReader class methodsFor:'constants'!

fileMajorVersions

    ^#( 

        46  "Java 1.2"

        49  "Java 5"

        50  "Java 6"

      ).

    "

     JSR 202:

     The Java virtual machine implementation of Sun's JDK release 1.0.2 supports

     class file format versions 45.0 through 45.3 inclusive. Sun's JDK releases

     1.1.X can support class file formats of versions in the range 45.0 through

     45.65535 inclusive. For k > 1 implementations of version 1.k of the Java 2

     platform can support class file formats of versions in the range 45.0 through

     44+k.0 inclusive.

"

    "Created: / 19-10-2010 / 21:40:36 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 01-06-2011 / 21:44:14 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 02-06-2011 / 22:50:17 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

fileMinorVersions

    ^ #(

        3 "Java 1.2"

        0 "Java 6"

    )

    "Created: / 19-10-2010 / 21:41:04 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

magic_LSB

    ^ 16rBEBAFECA

    "Modified: / 7.5.1998 / 13:14:27 / cg"

    "Created: / 7.5.1998 / 13:15:05 / cg"

!

magic_MSB

    ^ 16rCAFEBABE

    "Modified: / 7.5.1998 / 13:14:27 / cg"

! !

!JavaClassReader class methodsFor:'debugging'!

annotationsVerbose:aBoolean 

    AnnotationsVerbose := aBoolean

    "

     Java flushClasses.

     JavaClassReader verbose:true

     JavaClassReader verbose:false"

    "Created: / 25-02-2011 / 12:25:23 / Marcel Hlopko <hlopik@gmail.com>"

!

verbose:aBoolean

    Verbose := aBoolean

    "

     Java flushClasses.

     JavaClassReader verbose:true

     JavaClassReader verbose:false

    "

! !

!JavaClassReader class methodsFor:'file reading'!

loadClass:aClassName

    "reads a class, installs and returns it.

     The classes string constants are resolved & <clinit> is called,

     if it implements it."

    |rslt loader|

    loader := ClassLoaderQuerySignal query.

    loader isNil ifTrue:[

        ^ self loadSystemClass:aClassName

    ].

    ^ loader loadClass:aClassName

    "

     JavaClassReader loadClass:'awt/Component'

     JavaClassReader loadClass:'awt/Button'

     JavaClassReader loadClass:'browser/AddButton'

     JavaClassReader loadClass:'java/lang/Object'

     JavaClassReader loadClass:'java/lang/AbstractMethodError'

     JavaClassReader loadClass:'java/lang/Thread'

    "

    "Created: / 15.4.1996 / 14:58:53 / cg"

    "Modified: / 20.10.1998 / 17:24:54 / cg"

!

loadClassLazy: internalJavaClassName 

    ^ self loadClassLazy: internalJavaClassName ignoring: Set new.

    "Created: / 08-04-2011 / 18:00:28 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

    "Modified: / 11-04-2011 / 19:31:04 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

loadClassLazy: aClassName ignoring: classesBeingLoaded 

    "private helper:

      reads a class, installs and returns it.

      The class is searched along the ClassPath.

     This is a partial load (to load other classes):

     - The classes stringConstants are not fixed to be JavaStrings

       (i.e they are still ST-Strings).

     - The class is NOT initialized."

    | rslt  clsName  cls  loadedClass |

    clsName := aClassName.

    (clsName endsWith: ';') 

        ifTrue: 

            [ (clsName startsWith: '[L') 

                ifTrue: [ clsName := clsName copyFrom: 3 to: clsName size - 1. ]

                ifFalse: 

                    [ ('oops - loading of ' , clsName , ' attempted') printNL.

                    self halt: 'should not happen'.

                    ^ nil. ] ].

    (clsName endsWith: '[]') 

        ifTrue: 

            [ ('oops - loading of ' , clsName , ' attempted') printNL.

            self halt: 'should not happen'.

            ^ nil ].

    (clsName includes: $.) 

        ifTrue: [ clsName := clsName asString copyReplaceAll: $. with: $/ ].

    (classesBeingLoaded notNil and: [ classesBeingLoaded includes: clsName ]) 

        ifTrue: 

            [ ('oops - recursive load of ' , clsName , ' attempted') printNL.

            self halt: 'should not happen'.

            ^ JavaUnresolvedClassConstant fullName: clsName ].

    (cls := Java at: clsName) notNil 

        ifTrue: 

            [ ('oops - ' , clsName , ' is already loaded') printNL.

            "/self halt:clsName , ' is already loaded - should not happen'.

            ^ cls ].

    classesBeingLoaded isNil 

        ifTrue: [ loadedClass := Set with: clsName ]

        ifFalse: 

            [ loadedClass := Set withAll: classesBeingLoaded.

            loadedClass add: clsName. ].

    Java effectiveClassPath do: 

            [:path | 

            | nm  p  zar  entry  zipFile  read |

            Verbose == true 

                ifTrue: [ Transcript showCR: 'trying ' , path asFilename pathName , ' ...'. ].

            p := path.

            p asFilename isDirectory 

                ifTrue: 

                    [ (p endsWith: Filename separator) 

                        ifFalse: [ p := p , (Filename separator asString) ].

                    (Array 

                        with: clsName

                        with: clsName asLowercase

                        with: clsName asUppercase) do: 

                                [:tryName | 

                                nm := p , tryName , '.class'.

                                Verbose == true ifTrue: [ Transcript showCR: 'trying ' , nm , ' ...'. ].

                                nm asFilename exists 

                                    ifTrue: 

                                        [ (Java isExcludedFromClassPath: nm) 

                                            ifFalse: 

                                                [ rslt := self loadFileLazy: nm ignoring: loadedClass.

                                                rslt notNil ifTrue: [ ^ rslt ]. ] ]. ] ]

                ifFalse: 

                    [ Verbose == true 

                        ifTrue: 

                            [ Transcript 

                                showCR: 'trying ' , (p asFilename withSuffix: 'jar') pathName , ' ...'.

                            Transcript 

                                showCR: 'and ' , (p asFilename withSuffix: 'zip') pathName , ' ...'. ].

                    ((zipFile := p asFilename withSuffix: 'jar') exists 

                        or: [ (zipFile := p asFilename withSuffix: 'zip') exists ]) 

                            ifTrue: 

                                [

                                zar := JavaArchiveCache at: zipFile

                                            ifAbsentPut: [ ZipArchive oldFileNamed: zipFile ].

                                read := 

                                        [ nm := clsName , '.class'.

                                        entry := zar extract: nm.

                                        entry notNil 

                                            ifTrue: 

                                                [ (Java isExcludedFromClassPath: nm) 

                                                    ifFalse: 

                                                        [ rslt := self loadStreamLazy: (entry readStream) ignoring: loadedClass.

                                                        rslt notNil ifTrue: [ ^ rslt ]. ] ] ].

                                JavaClassReader invalidClassFormatSignal handle: 

                                        [ "Kludge, sometimes zar gets corrupted"

                                        zar := JavaArchiveCache at: zipFile put: (ZipArchive oldFileNamed: zipFile).

                                        read value ]

                                    do: [ read value ]. ] ] ].

    ('JAVA [info]: no file found for: ' , clsName) infoPrintCR.

    ^ nil

    "Modified: / 14-08-1997 / 11:38:42 / stefan"

    "Modified: / 17-09-1998 / 20:51:25 / cg"

    "Modified: / 18-03-2011 / 16:06:47 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 21-03-2011 / 12:42:12 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

loadClassesIn: directory 

    "load all classes (.class files, strictly speaking) found in given directory.

     The argument is string containing the name of the directory.

    Returns a set of loaded classes."

    ^self loadClassesIn: directory  matching: '*'

    "Modified: / 11-06-2011 / 13:35:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

loadClassesIn: directory matching: pattern

    "load all classes (.class files, strictly speaking) found in given directory.

     The arguments are a string containing the name of the directory

     and a class name pattern. Only classes matching the pattern are loaded.

     class names are matched using String>>matches:.

     Returns a set of loaded classes."

    | dir  dirString  className  loadedClasses |

    dir := directory asFilename asAbsoluteFilename.

    loadedClasses := Set new.

    Java addToClassPath: dir pathName.

    dir recursiveDirectoryContentsAsFilenamesDo: 

            [:filename |

            (filename isRegularFile and: [ filename suffix = #class ]) 

                ifTrue: 

                    [ dirString := dir pathName.

                    className := filename withoutSuffix pathName.

                    className := className subString: dirString size + 2 to: className size.

                    className := className copyReplaceAll: (Filename separator) with: $..

                    (className matches: pattern) ifTrue:

                        [loadedClasses add: (self loadClass: className)]]].

    ^ loadedClasses.

    "Modified: / 29-04-2011 / 17:43:32 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

    "Created: / 11-06-2011 / 13:34:39 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 11-06-2011 / 16:19:40 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

loadFile:aFilename

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

     The classes strings are fixed and its class-init function is called."

    self loadFileLazy:aFilename ignoring:(Set new).

    self postLoadActions

!

loadFileLazy:aFilename ignoring:classesBeingLoaded

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

     Strings are fixed and classrefs are fixed, 

     but NO no class-init functions are called."

    |aClass pool|

    aClass := self readFile:aFilename ignoring:classesBeingLoaded.

    aClass notNil ifTrue:[

        aClass isJavaClass ifTrue:[

            "/ a java class

            Java at:(aClass fullName asSymbol) put:aClass.

            classesBeingLoaded remove:aClass fullName ifAbsent:nil.

            JavaUnresolvedConstant resolveFor:aClass.

        ] ifFalse:[    

            "/ a smalltalk class

            "/ self halt.

aClass inspect.

        ]

    ].

    ^ aClass

    "

     JavaClassReader loadFile:'/phys/ibm3/hotjava/classes/browser/AddButton.class'

     '/phys/ibm3/java/lib/java/lang' asFilename

        directoryContents do:[:nm |

            (nm endsWith:'.class') ifTrue:[

                ('/phys/ibm3/java/lib/java/lang/' , nm) printNL.

                JavaClassReader loadFile:'/phys/ibm3/java/lib/java/lang/' , nm

            ]

        ].

     '/phys/ibm3/java/lib/java/io' asFilename

        directoryContents do:[:nm |

            (nm endsWith:'.class') ifTrue:[

                ('/phys/ibm3/java/lib/java/io/' , nm) printNL.

                JavaClassReader loadFile:'/phys/ibm3/java/lib/java/io/' , nm

            ]

        ].

     '/phys/ibm3/java/lib/java/net' asFilename

        directoryContents do:[:nm |

            (nm endsWith:'.class') ifTrue:[

                ('/phys/ibm3/java/lib/java/net/' , nm) printNL.

                JavaClassReader loadFile:'/phys/ibm3/java/lib/java/net/' , nm

            ]

        ].

     '/phys/ibm3/java/lib/java/util' asFilename

        directoryContents do:[:nm |

            (nm endsWith:'.class') ifTrue:[

                ('/phys/ibm3/java/lib/java/util/' , nm) printNL.

                JavaClassReader loadFile:'/phys/ibm3/java/lib/java/util/' , nm

            ]

        ].

     '/phys/ibm3/java/lib/java/awt' asFilename

        directoryContents do:[:nm |

            (nm endsWith:'.class') ifTrue:[

                ('/phys/ibm3/java/lib/java/awt/' , nm) printNL.

                JavaClassReader loadFile:'/phys/ibm3/java/lib/java/awt/' , nm

            ]

        ].

     '/phys/ibm3/java/lib/java/applet' asFilename

        directoryContents do:[:nm |

            (nm endsWith:'.class') ifTrue:[

                ('/phys/ibm3/java/lib/java/applet/' , nm) printNL.

                JavaClassReader loadFile:'/phys/ibm3/java/lib/java/applet/' , nm

            ]

        ].

     JavaClassReader loadFile:'/phys/ibm3/java/lib/java/lang/AbstractMethodError.class'

     JavaClassReader loadFile:'/phys/ibm3/java/lib/java/lang/Thread.class'

    "

    "Created: / 15.4.1996 / 14:58:53 / cg"

    "Modified: / 12.5.1998 / 22:06:52 / cg"

!

loadStreamLazy:aStream ignoring:classesBeingLoaded

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

     Strings are fixed and classrefs are fixed, 

     but NO no class-init functions are called."

    |javaClass pool|

    javaClass := self readStream:aStream ignoring:classesBeingLoaded.

    javaClass notNil ifTrue:[

        Java at:(javaClass fullName asSymbol) put:javaClass.

        classesBeingLoaded remove:javaClass fullName ifAbsent:nil.

        JavaUnresolvedConstant resolveFor:javaClass.

    ].

    ^ javaClass

    "Created: / 30.3.1998 / 17:59:02 / cg"

!

loadSystemClass: aClassName 

    "reads a class, installs and returns it.

     The classes string constants are resolved & <clinit> is called,

     if it implements it.

     This only loads local classes (i.e. any Java classReader is not used)"

    | rslt |

    rslt := JavaClassReader loadClassLazy: aClassName ignoring: (Set new).

    rslt notNil ifTrue: [ JavaClassReader postLoadActions ].

    self assert: rslt constantPool owner == rslt.