| Portability | portable |
|---|---|
| Stability | stable |
| Maintainer | atomb@galois.com |
| Safe Haskell | None |
Language.JVM.Parser
Contents
Description
Parser for the JVM bytecode format.
- data Type
- isIValue :: Type -> Bool
- isPrimitiveType :: Type -> Bool
- isRValue :: Type -> Bool
- stackWidth :: Type -> Int
- isFloatType :: Type -> Bool
- isRefType :: Type -> Bool
- data ConstantPoolValue
- data Attribute = Attribute {}
- data Visibility
- getClass :: Get Class
- data Class
- className :: Class -> String
- superClass :: Class -> Maybe String
- classIsPublic :: Class -> Bool
- classIsFinal :: Class -> Bool
- classIsInterface :: Class -> Bool
- classIsAbstract :: Class -> Bool
- classHasSuperAttribute :: Class -> Bool
- classInterfaces :: Class -> [String]
- classFields :: Class -> [Field]
- classMethods :: Class -> [Method]
- classAttributes :: Class -> [Attribute]
- loadClass :: FilePath -> IO Class
- lookupMethod :: Class -> MethodKey -> Maybe Method
- showClass :: Class -> String
- data FieldId = FieldId {
- fieldIdClass :: !String
- fieldIdName :: !String
- fieldIdType :: !Type
- data Field
- fieldName :: Field -> String
- fieldType :: Field -> Type
- fieldVisibility :: Field -> Visibility
- fieldIsStatic :: Field -> Bool
- fieldIsFinal :: Field -> Bool
- fieldIsVolatile :: Field -> Bool
- fieldIsTransient :: Field -> Bool
- fieldConstantValue :: Field -> Maybe ConstantPoolValue
- fieldIsSynthetic :: Field -> Bool
- fieldIsDeprecated :: Field -> Bool
- fieldIsEnum :: Field -> Bool
- fieldSignature :: Field -> Maybe String
- fieldAttributes :: Field -> [Attribute]
- data MethodKey = MethodKey {}
- makeMethodKey :: String -> String -> MethodKey
- data Method
- methodName :: Method -> String
- methodParameterTypes :: Method -> [Type]
- localIndexOfParameter :: Method -> Int -> LocalVariableIndex
- methodReturnType :: Method -> Maybe Type
- methodMaxLocals :: Method -> LocalVariableIndex
- methodIsNative :: Method -> Bool
- methodIsAbstract :: Method -> Bool
- methodBody :: Method -> MethodBody
- data MethodBody
- = Code Word16 Word16 CFG [ExceptionTableEntry] LineNumberTable LocalVariableTable [Attribute]
- | AbstractMethod
- | NativeMethod
- methodExceptionTable :: Method -> [ExceptionTableEntry]
- methodKey :: Method -> MethodKey
- methodIsStatic :: Method -> Bool
- type LocalVariableIndex = Word16
- data LocalVariableTableEntry = LocalVariableTableEntry {
- localStart :: PC
- localExtent :: PC
- localName :: String
- localType :: Type
- localIdx :: LocalVariableIndex
- type PC = Word16
- data Instruction
- = 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
- | 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]
- lookupInstruction :: Method -> PC -> Instruction
- nextPc :: Method -> PC -> PC
- data ExceptionTableEntry
- catchType :: ExceptionTableEntry -> Maybe Type
- startPc :: ExceptionTableEntry -> PC
- endPc :: ExceptionTableEntry -> PC
- handlerPc :: ExceptionTableEntry -> PC
- byteArrayTy :: Type
- charArrayTy :: Type
- getElemTy :: Type -> Type
- intArrayTy :: Type
- stringTy :: Type
- unparseMethodDescriptor :: MethodKey -> String
- mainKey :: MethodKey
- hasDebugInfo :: Method -> Bool
- classSourceFile :: Class -> Maybe String
- sourceLineNumberInfo :: Method -> [(Word16, PC)]
- sourceLineNumberOrPrev :: Method -> PC -> Maybe Word16
- lookupLineStartPC :: Method -> Word16 -> Maybe PC
- lookupLineMethodStartPC :: Class -> Word16 -> Maybe (Method, PC)
- localVariableEntries :: Method -> PC -> [LocalVariableTableEntry]
- lookupLocalVariableByIdx :: Method -> PC -> LocalVariableIndex -> Maybe LocalVariableTableEntry
- lookupLocalVariableByName :: Method -> PC -> String -> Maybe LocalVariableTableEntry
- ppInst :: Instruction -> String
- slashesToDots :: String -> String
- cfgToDot :: ExceptionTable -> CFG -> String -> String
Basic types
JVM Type
isPrimitiveType :: Type -> BoolSource
Returns true if Java type is a primitive type. Primitive types are the Boolean type or numeric types.
stackWidth :: Type -> IntSource
Returns number of bits that a Java type is expected to take on the stack. Type should be a primitive type.
isFloatType :: Type -> BoolSource
Returns true if Java type denotes a floating point.
An uninterpreted user defined attribute in the class file.
Constructors
| Attribute | |
Fields | |
data Visibility Source
Instances
SerDes helpers
Class declarations
superClass :: Class -> Maybe StringSource
Returns name of the super class of this class or Nothing if this class has no super class.
classIsPublic :: Class -> BoolSource
Returns true if class is public.
classIsFinal :: Class -> BoolSource
Returns true if class is final.
classIsInterface :: Class -> BoolSource
Returns true if class is an interface
classIsAbstract :: Class -> BoolSource
Returns true if class is abstract.
classHasSuperAttribute :: Class -> BoolSource
Returns true if class was annotated with the super attribute.
classInterfaces :: Class -> [String]Source
Returns interfaces this clas implements
classFields :: Class -> [Field]Source
Returns fields in the class
classMethods :: Class -> [Method]Source
Returns methods in class
classAttributes :: Class -> [Attribute]Source
Returns user-defined attributes on class.
lookupMethod :: Class -> MethodKey -> Maybe MethodSource
Returns method with given key in class or Nothing if no method with that key is found.
Field declarations
Unique identifier of field
Constructors
| FieldId | |
Fields
| |
fieldVisibility :: Field -> VisibilitySource
Returns visibility of field.
fieldIsStatic :: Field -> BoolSource
Returns true if field is static.
fieldIsFinal :: Field -> BoolSource
Returns true if field is final.
fieldIsVolatile :: Field -> BoolSource
Returns true if field is volatile.
fieldIsTransient :: Field -> BoolSource
Returns true if field is transient.
fieldConstantValue :: Field -> Maybe ConstantPoolValueSource
Returns initial value of field or Nothing if not assigned.
Only static fields may have a constant value.
fieldIsSynthetic :: Field -> BoolSource
Returns true if field is synthetic.
fieldIsDeprecated :: Field -> BoolSource
Returns true if field is deprecated.
fieldIsEnum :: Field -> BoolSource
Returns true if field is transient.
fieldSignature :: Field -> Maybe StringSource
fieldAttributes :: Field -> [Attribute]Source
Method declarations
A unique identifier for looking up a method in a class.
Constructors
| MethodKey | |
Fields | |
Returns method key with the given name and descriptor.
methodName :: Method -> StringSource
Returns name of method
methodParameterTypes :: Method -> [Type]Source
Return parameter types for method.
localIndexOfParameter :: Method -> Int -> LocalVariableIndexSource
Returns the local variable index that the parameter is stored in when the method is invoked.
methodReturnType :: Method -> Maybe TypeSource
Return parameter types for method.
methodMaxLocals :: Method -> LocalVariableIndexSource
Returns maxinum number of local variables in method.
methodIsNative :: Method -> BoolSource
methodIsAbstract :: Method -> BoolSource
Returns true if method is abstract.
methodBody :: Method -> MethodBodySource
data MethodBody Source
Constructors
| Code Word16 Word16 CFG [ExceptionTableEntry] LineNumberTable LocalVariableTable [Attribute] | |
| AbstractMethod | |
| NativeMethod |
Instances
methodExceptionTable :: Method -> [ExceptionTableEntry]Source
Exception table entries for method.
methodIsStatic :: Method -> BoolSource
Instruction declarations
type LocalVariableIndex = Word16Source
A local variable index.
data LocalVariableTableEntry Source
Constructors
| LocalVariableTableEntry | |
Fields
| |
data Instruction Source
A JVM Instruction
Constructors
Instances
lookupInstruction :: Method -> PC -> InstructionSource
Exception table declarations
catchType :: ExceptionTableEntry -> Maybe TypeSource
The type of exception that should be caught or Nothing if all types of exceptions should be caught.
startPc :: ExceptionTableEntry -> PCSource
The starting program counter value where the exception handler applies
endPc :: ExceptionTableEntry -> PCSource
The ending program counter value where the exception handler applies.
handlerPc :: ExceptionTableEntry -> PCSource
The program counter value to jump to when an exception is caught.
Misc utility functions/values
Debugging information
hasDebugInfo :: Method -> BoolSource
Returns true if method has debug informaiton available.
classSourceFile :: Class -> Maybe StringSource
Returns name of source file where class was defined.
sourceLineNumberInfo :: Method -> [(Word16, PC)]Source
sourceLineNumberOrPrev :: Method -> PC -> Maybe Word16Source
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 PCSource
Returns the starting PC for the source at the given line number.
lookupLineMethodStartPC :: Class -> Word16 -> Maybe (Method, PC)Source
Returns the enclosing method and starting PC for the source at the given line number.
lookupLocalVariableByIdx :: Method -> PC -> LocalVariableIndex -> Maybe LocalVariableTableEntrySource
Returns local variable entry at given PC and local variable index or Nothing if no mapping is found.
lookupLocalVariableByName :: Method -> PC -> String -> Maybe LocalVariableTableEntrySource
Returns local variable entry at given PC and local variable string or Nothing if no mapping is found.
ppInst :: Instruction -> StringSource