Language.JVM.Parser

Parser for the JVM bytecode format.

Basic types

data Type

JVM Type

Constructors

ArrayType Type

BooleanType

ByteType

CharType

ClassType String

ClassType with name of packages separated by slash /

DoubleType

FloatType

IntType

LongType

ShortType

Instances

Eq Type

Ord Type

Show Type

isIValue :: Type -> Bool

Returns true if type is an integer value.

isPrimitiveType :: Type -> Bool

Returns true if Java type is a primitive type. Primitive types are the Boolean type or numeric types.

isRValue :: Type -> Bool

Returns true if type is a reference value.

stackWidth :: Type -> Int

Returns number of bits that a Java type is expected to take on the stack. Type should be a primitive type.

isFloatType :: Type -> Bool

Returns true if Java type denotes a floating point.

isRefType :: Type -> Bool

Returns true if Java type denotes a reference.

data ConstantPoolValue

A value stored in the constant pool.

Constructors

Long Int64

Float Float

Double Double

Integer Int32

String String

ClassRef String

Instances

Eq ConstantPoolValue

Show ConstantPoolValue

data Attribute

An uninterpreted user defined attribute in the class file.

Constructors

Attribute

Fields

attributeName :: String

attributeData :: ByteString

Instances

Eq Attribute

Show Attribute

data Visibility

Constructors

Default

Private

Protected

Public

Instances

Eq Visibility

Show Visibility

SerDes helpers

getClass :: Get Class

Class declarations

data Class

A JVM class or interface.

Instances

Show Class

className :: Class -> String

Returns name of the class

superClass :: Class -> Maybe String

Returns name of the super class of this class or Nothing if this class has no super class.

classIsPublic :: Class -> Bool

Returns true if class is public.

classIsFinal :: Class -> Bool

Returns true if class is final.

classIsInterface :: Class -> Bool

Returns true if class is an interface

classIsAbstract :: Class -> Bool

Returns true if class is abstract.

classHasSuperAttribute :: Class -> Bool

Returns true if class was annotated with the super attribute.

classInterfaces :: Class -> [String]

Returns interfaces this clas implements

classFields :: Class -> [Field]

Returns fields in the class

classMethods :: Class -> [Method]

Returns methods in class

classAttributes :: Class -> [Attribute]

Returns user-defined attributes on class.

loadClass :: FilePath -> IO Class

Loads class at given path.

lookupMethod :: Class -> MethodKey -> Maybe Method

Returns method with given key in class or Nothing if no method with that key is found.

showClass :: Class -> String

Field declarations

data FieldId

Unique identifier of field

Constructors

FieldId

Fields

fieldIdClass :: !String

Class name

fieldIdName :: !String

Field name

fieldIdType :: !Type

Field type

Instances

Eq FieldId

Ord FieldId

Show FieldId

data Field

A class instance of static field

Instances

Show Field

fieldName :: Field -> String

Returns name of field.

fieldType :: Field -> Type

Returns type of field.

fieldVisibility :: Field -> Visibility

Returns visibility of field.

fieldIsStatic :: Field -> Bool

Returns true if field is static.

fieldIsFinal :: Field -> Bool

Returns true if field is final.

fieldIsVolatile :: Field -> Bool

Returns true if field is volatile.

fieldIsTransient :: Field -> Bool

Returns true if field is transient.

fieldConstantValue :: Field -> Maybe ConstantPoolValue

Returns initial value of field or Nothing if not assigned.

Only static fields may have a constant value.

fieldIsSynthetic :: Field -> Bool

Returns true if field is synthetic.

fieldIsDeprecated :: Field -> Bool

Returns true if field is deprecated.

fieldIsEnum :: Field -> Bool

Returns true if field is transient.

fieldSignature :: Field -> Maybe String

fieldAttributes :: Field -> [Attribute]

Method declarations

data MethodKey

A unique identifier for looking up a method in a class.

Constructors

MethodKey

Fields

methodKeyName :: String

methodKeyParameterTypes :: [Type]

methodKeyReturnType :: Maybe Type

Instances

Eq MethodKey

Ord MethodKey

Show MethodKey

makeMethodKey

Arguments

:: String

Method name

-> String

Method descriptor

-> MethodKey

Returns method key with the given name and descriptor.

data Method

Instances

Eq Method

Ord Method

Show Method

methodName :: Method -> String

Returns name of method

methodParameterTypes :: Method -> [Type]

Return parameter types for method.

localIndexOfParameter :: Method -> Int -> LocalVariableIndex

Returns the local variable index that the parameter is stored in when the method is invoked.

methodReturnType :: Method -> Maybe Type

Return parameter types for method.

methodMaxLocals :: Method -> LocalVariableIndex

Returns maxinum number of local variables in method.

methodIsNative :: Method -> Bool

methodIsAbstract :: Method -> Bool

Returns true if method is abstract.

methodBody :: Method -> MethodBody

data MethodBody

Constructors

Code Word16 Word16 CFG [ExceptionTableEntry] LineNumberTable LocalVariableTable [Attribute]

AbstractMethod

NativeMethod

Instances

Eq MethodBody

Show MethodBody

methodExceptionTable :: Method -> [ExceptionTableEntry]

Exception table entries for method.

methodKey :: Method -> MethodKey

methodIsStatic :: Method -> Bool

Instruction declarations

type LocalVariableIndex = Word16

A local variable index.

data LocalVariableTableEntry

Constructors

LocalVariableTableEntry

Fields

localStart :: PC

localExtent :: PC

localName :: String

localType :: Type

localIdx :: LocalVariableIndex

Instances

Eq LocalVariableTableEntry

Show LocalVariableTableEntry

type PC = Word16

A program counter value.

data Instruction

A JVM Instruction

Constructors

Aaload

Aastore

Aconst_null

Aload LocalVariableIndex

Areturn

Arraylength

Astore LocalVariableIndex

Athrow

Baload

Bastore

Caload

Castore

Checkcast Type

D2f

D2i

D2l

Dadd

Daload

Dastore

Dcmpg

Dcmpl

Ddiv

Dload LocalVariableIndex

Dmul

Dneg

Drem

Dreturn

Dstore LocalVariableIndex

Dsub

Dup

Dup_x1

Dup_x2

Dup2

Dup2_x1

Dup2_x2

F2d

F2i

F2l

Fadd

Faload

Fastore

Fcmpg

Fcmpl

Fdiv

Fload LocalVariableIndex

Fmul

Fneg

Frem

Freturn

Fstore LocalVariableIndex

Fsub

Getfield FieldId

getfield instruction

Getstatic FieldId

Goto PC

I2b

I2c

I2d

I2f

I2l

I2s

Iadd

Iaload

Iand

Iastore

Idiv

If_acmpeq PC

If_acmpne PC

If_icmpeq PC

If_icmpne PC

If_icmplt PC

If_icmpge PC

If_icmpgt PC

If_icmple PC

Ifeq PC

Ifne PC

Iflt PC

Ifge PC

Ifgt PC

Ifle PC

Ifnonnull PC

Ifnull PC

Iinc LocalVariableIndex Int16

Iload LocalVariableIndex

Imul

Ineg

Instanceof Type

Invokeinterface String MethodKey

Invokespecial Type MethodKey

Invokestatic String MethodKey

Invokevirtual Type MethodKey

Ior

Irem

Ireturn

Ishl

Ishr

Istore LocalVariableIndex

Isub

Iushr

Ixor

Jsr PC

L2d

L2f

L2i

Ladd

Laload

Land

Lastore

Lcmp

Ldc ConstantPoolValue

Ldiv

Lload LocalVariableIndex

Lmul

Lneg

Lookupswitch PC [(Int32, PC)]

Lor

Lrem

Lreturn

Lshl

Lshr

Lstore LocalVariableIndex

Lsub

Lushr

Lxor

Monitorenter

Monitorexit

Multianewarray Type Word8

New String

Newarray Type

Nop

Pop

Pop2

Putfield FieldId

Putstatic FieldId

Ret LocalVariableIndex

Return

Saload

Sastore

Swap

Tableswitch PC Int32 Int32 [PC]

Instances

Eq Instruction

Show Instruction

lookupInstruction :: Method -> PC -> Instruction

nextPc :: Method -> PC -> PC

Exception table declarations

data ExceptionTableEntry

An entry in the exception table for a method

Instances

Eq ExceptionTableEntry

Show ExceptionTableEntry

catchType :: ExceptionTableEntry -> Maybe Type

The type of exception that should be caught or Nothing if all types of exceptions should be caught.

startPc :: ExceptionTableEntry -> PC

The starting program counter value where the exception handler applies

endPc :: ExceptionTableEntry -> PC

The ending program counter value where the exception handler applies.

handlerPc :: ExceptionTableEntry -> PC

The program counter value to jump to when an exception is caught.

Misc utility functions/values

byteArrayTy :: Type

charArrayTy :: Type

getElemTy :: Type -> Type

intArrayTy :: Type

stringTy :: Type

unparseMethodDescriptor :: MethodKey -> String

mainKey :: MethodKey

Debugging information

hasDebugInfo :: Method -> Bool

Returns true if method has debug informaiton available.

classSourceFile :: Class -> Maybe String

Returns name of source file where class was defined.

sourceLineNumberInfo :: Method -> [(Word16, PC)]

sourceLineNumberOrPrev :: Method -> PC -> Maybe Word16

Returns source line number of an instruction in a method at a given PC, or the line number of the nearest predecessor instruction, or Nothing if neither is available.

lookupLineStartPC :: Method -> Word16 -> Maybe PC

Returns the starting PC for the source at the given line number.

lookupLineMethodStartPC :: Class -> Word16 -> Maybe (Method, PC)

Returns the enclosing method and starting PC for the source at the given line number.

localVariableEntries :: Method -> PC -> [LocalVariableTableEntry]

lookupLocalVariableByIdx :: Method -> PC -> LocalVariableIndex -> Maybe LocalVariableTableEntry

Returns local variable entry at given PC and local variable index or Nothing if no mapping is found.

lookupLocalVariableByName :: Method -> PC -> String -> Maybe LocalVariableTableEntry

Returns local variable entry at given PC and local variable string or Nothing if no mapping is found.

ppInst :: Instruction -> String

slashesToDots :: String -> String

Replace / characters with . characters

cfgToDot

Arguments

:: ExceptionTable

-> CFG

-> String

method name

-> String

Render the CFG of a method into Graphviz .dot format