"

 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

 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.

     as of 1.9.2010

"

"{ 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:'JavaConstants'

	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

 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.

     as of 1.9.2010

"

! !

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

        47  "???"

        48  "???"

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

    "Modified: / 18-08-2011 / 19:32:37 / jv"

!

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'!

readClass: aClassName 

    "reads a class, and returns it.

     <clinit> is called, class is not installed"

    ^ self readClass: aClassName ignoring: Set new.

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

    "Modified: / 20-10-1998 / 17:24:54 / cg"

    "Modified: / 08-09-2011 / 08:10:58 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

readClass: aClassName classPath: classPath  

    "reads a class, and returns it.

     <clinit> is called, class is not installed"

    ^ self readClass: aClassName ignoring: Set new classPath: classPath

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

    "Modified: / 20-10-1998 / 17:24:54 / cg"

    "Modified: / 08-09-2011 / 08:10:58 / Jan Vrany <jan.vrany@fit.cvut.cz>"

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

!

readClass: className ignoring: classesBeingLoadedOrNil 

    "This method is bit hacky, as it tries to supply 'correct'

     classloader. 

    If the class is loaded from Java release classPath (containing

    base java classes shipped with JDK/JRE), then set the classloader

    to null. Otherwise set class's loader to system class loader

    (as returned by ClassLoader#getSystemClassLoader())

    This is required to run groovy and other SW that uses resources

    or other classloader dependent stuff. When changing, make sure

    Groovy is running afterwards!!!!!!

    "

    | class |

    class := self 

                readClass: className ignoring: classesBeingLoadedOrNil 

                classPath: Java release classPath.

    class notNil ifTrue:[ ^ class ].

    class isNil ifTrue:[

        JavaVM booted ifFalse:[

            ^nil

        ].

        JavaClassReader classLoaderQuerySignal answer: JavaVM systemClassLoader do:[

            class := self

                readClass: className ignoring: classesBeingLoadedOrNil 

                classPath: Java classPath.

        ].

    ].

    ^class

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

    "Modified: / 20-10-1998 / 17:24:54 / cg"

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

    "Modified: / 30-10-2011 / 16:50:05 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

readClass: className ignoring: classesBeingLoadedOrNil classPath: classPath 

    "searches classspath for a class, loads it and returns.

     <clinit> is not called, class is not installed as global"

    | rslt  clsName  classesBeingLoaded |

    clsName := className asInternalJavaClassName.

    classesBeingLoadedOrNil isNil ifTrue: [

        classesBeingLoaded := Set with: clsName

    ] ifFalse: [

        classesBeingLoaded := classesBeingLoadedOrNil

                    add: clsName;

                    yourself.

    ].

    classPath do: [:path | 

        | nm  p  zar  entry  zipFile  read |

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

                        nm asFilename exists ifTrue: [

                            (Java isExcludedFromClassPath: nm) ifFalse: [

                                 "means we are successfully going to read something :)"

                                rslt := self readFile: nm ignoring: classesBeingLoaded.

                                rslt notNil ifTrue: [ ^ rslt. ].

                            ]

                        ].

                    ]

        ] ifFalse: [

            ((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 readStream: (entry readStream) ignoring: classesBeingLoaded.

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

                    ]

        ]

    ].

    ^nil

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

    "Modified: / 20-10-1998 / 17:24:54 / cg"

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

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

    "Modified: / 03-11-2011 / 18:14:56 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

readFile: aFilename ignoring: classesBeingLoaded 

    "reads a class from aFilename and returns it.

     The JavaClass is NOT installed as global and unresolved

     refs are NOT patched."

    | inStream  javaClass |

    [ inStream := aFilename asFilename readStream. ] on: StreamError

        do: [

    :ex | 

    Logger 

        log: ('no file: ' , aFilename asString)

        severity: #error

        facility: 'JVM'.

    self halt.

    ^ nil

].

    javaClass := self readStream: inStream ignoring: classesBeingLoaded.

    (javaClass notNil and: [ javaClass isJavaClass ]) ifTrue: [

        javaClass setBinaryFilePath: (inStream pathName).

    ].

    inStream close.

    ^ javaClass.

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

    "Modified: / 09-05-1998 / 01:44:24 / cg"

    "Modified: / 30-10-2011 / 18:01:58 / Jan Vrany <jan.vrany@fit.cvut.cz>"

!

readStream: aStream 

    "reads a class from aStream and returns it.

     The JavaClass is not installed as global"

    ^self readStream: aStream ignoring: Set new.

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

!

readStream: aStream ignoring: classesBeingLoaded 

    "reads a class from aStream and returns it.

     The JavaClass is not installed as global"

    | javaClass |

    javaClass := JavaClassReader new readStream: aStream ignoring: classesBeingLoaded.

    Logger 

        log: 'loaded class ' , javaClass displayString

        severity: #info

        facility: 'JVM'.

    ^ javaClass.

    "Modified: / 30-03-1998 / 18:14:40 / cg"

    "Modified: / 09-05-2011 / 23:15:30 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

    "Modified: / 14-09-2011 / 22:21:34 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified (format): / 30-10-2011 / 18:02:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"

! !

!JavaClassReader class methodsFor:'obsolete'!

resolveClass: aJavaClass 

    "Resolve a particular classes' constants.

     Perform all class initialization functions

     (of those which are not yet initialized)."

    | loader  classToLoad |

     "new resolving does not need this - shouldn't be called at all"

    LazyClassLoading ifFalse: [

        loader := (aJavaClass classLoader).

        [

            classToLoad := nil.

            aJavaClass constantPool do: [

                :item | 

                | itemClass |

                itemClass := item class.

                itemClass == JavaUnresolvedClassConstant ifTrue: [

                    classToLoad := item className.

"/                ] ifFalse:[

"/                    itemClass == JavaUnresolvedMethodrefConstant ifTrue:[

"/self halt.

"/                    ] ifFalse:[

"/                        itemClass == JavaUnresolvedInterfaceMethodrefConstant ifTrue:[

"/self halt.

"/                        ]

"/                    ]

                ].

            ].

            classToLoad notNil ifTrue: [

                loader isNil ifTrue: [ JavaVM classForName: classToLoad. ] ifFalse: [

                    "/

                    "/ the aquired loader is a javaClassLoader

                    "/ which expects an URL as arg.

                    "/

                    "/ classURL := Java as_URL:('file:' , nextUnresolved asString , '.class').

                    "/ loader loadClass:classURL

                    loader perform: #'loadClass(Ljava/lang/String;)Ljava/lang/Class;'

                        with: (Java as_String: (classToLoad asString)).

                ]

            ].

            classToLoad notNil.

        ] whileTrue.

        aJavaClass isInitialized ifFalse: [

            Silent ifFalse: [

                'performing class initialization of ' print.

                aJavaClass fullName printCR.

            ].

            aJavaClass classInit

        ].

    ]

    "Created: / 20-10-1998 / 17:53:22 / cg"

    "Modified: / 16-11-2011 / 14:39:32 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

! !

!JavaClassReader methodsFor:'accessing'!

constants   

^ constants.

    "Created: / 10-05-2011 / 13:48:30 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

constants: aJavaConstantPool

    constants := aJavaConstantPool.

    "Created: / 10-05-2011 / 13:48:46 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

stream

^ inStream.

    "Created: / 09-05-2011 / 23:22:38 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

!

stream:aReadStream

    inStream := aReadStream.

    "Created: / 09-05-2011 / 23:23:11 / Marcel Hlopko <hlopkmar@fel.cvut.cz>"

! !

!JavaClassReader methodsFor:'file reading'!

readClassFileIgnoring: classesbeingLoaded 

    "reads a class from inStream and returns it.

     The JavaClass is not installed as global and its constants

     (especially strings) may not be fully resolved."

    | magic  access_flags  this_class_index  super_class  super_class_index  this_class_ref  existingSuperClass  fields  interfaces  staticFields  nStatic  superClassName  thisClassName  existing_class  thisMetaClass |

    "/

    "/ read magic, determine byte order

    "/

    msb := true.

    magic := inStream nextUnsignedLongMSB: true.

    magic = (self class magic_MSB) ifFalse: [

        magic = (self class magic_LSB) ifFalse: [

            InvalidClassFormatSignal raiseErrorString: 'not a java class file'.

            ^ nil

        ].

        msb := false.

        Verbose ifTrue: [ Transcript showCR: 'file is lsb' ].

    ] ifTrue: [ Verbose ifTrue: [ Transcript showCR: 'file is msb' ]. ].

    "/

    "/ get version

    "/

    minorVsn := inStream nextUnsignedShortMSB: msb.

    majorVsn := inStream nextUnsignedShortMSB: msb.

    ((self class fileMajorVersions includes: majorVsn) not 

        or: [ (self class fileMinorVersions includes: minorVsn) not ]) 

            ifTrue: [

                Transcript

                    show: 'warning this file has version ';

                    show: majorVsn;

                    show: '.';

                    showCR: minorVsn.

            ].

    Verbose ifTrue: [

        Transcript

            show: 'version = ';

            show: (majorVsn printString);

            show: '.';

            showCR: (minorVsn printString).

    ].

    "/