JVM.ClassFile

Description

This module declares (low-level) data types for Java .class files structures, and Binary instances to read/write them.

Synopsis

Documentation

Any (class field method/ ...) attribute format. Some formats specify special formats for attributeValue.

Constructors

Attribute
Fields attributeName :: Word16 attributeLength :: Word32 attributeValue :: ByteString

Instances

Eq Attribute
Show Attribute
Binary Attribute
BinaryState Integer Attribute

data FieldType Source

Field signature format

Constructors

SignedByte	B
CharByte	C
DoubleType	D
FloatType	F
IntType	I
LongInt	J
ShortInt	S
BoolType	Z
ObjectType String	L `{class name}`
Array (Maybe Int) FieldType	[{type}

Instances

Eq FieldType
Show FieldType
Binary FieldType

type FieldSignature = FieldType Source

Class field signature

data MethodSignature Source

Class method argument signature

Constructors

MethodSignature [ArgumentSignature] ReturnSignature

Instances

Eq MethodSignature
Show MethodSignature
Binary MethodSignature

data ReturnSignature Source

Return value signature

Constructors

Returns FieldType
ReturnsVoid

Instances

Eq ReturnSignature
Show ReturnSignature
Binary ReturnSignature

type ArgumentSignature = FieldType Source

Method argument signature

type Pool stage = Map Word16 (Constant stage)Source

Constant pool

type family Link s a Source

data Method stage Source

Class method format

Constructors

Method
Fields methodAccessFlags :: AccessFlags stage methodName :: Link stage ByteString methodSignature :: Link stage MethodSignature methodAttributesCount :: Word16 methodAttributes :: Attributes stage

Instances

HasAttributes Method
HasSignature Method
Eq (Method Resolved)
Eq (Method Pointers)
Show (Method Resolved)
Show (Method Pointers)
Binary (Method Pointers)

data Field stage Source

Class field format

Constructors

Field
Fields fieldAccessFlags :: AccessFlags stage fieldName :: Link stage ByteString fieldSignature :: Link stage FieldSignature fieldAttributesCount :: Word16 fieldAttributes :: Attributes stage

Instances

HasAttributes Field
HasSignature Field
Eq (Field Resolved)
Eq (Field Pointers)
Show (Field Resolved)
Show (Field Pointers)
Binary (Field Pointers)

data Class stage Source

Generic .class file format

Constructors

Class

Fields

magic :: Word32

Magic value: 0xCAFEBABE

minorVersion :: Word16

majorVersion :: Word16

constsPoolSize :: Word16

Number of items in constants pool

constsPool :: Pool stage

Constants pool itself

accessFlags :: AccessFlags stage

See JVM.Types.AccessFlag

thisClass :: Link stage ByteString

Constants pool item index for this class

superClass :: Link stage ByteString

-/-- for super class, zero for java.lang.Object

interfacesCount :: Word16

Number of implemented interfaces

interfaces :: [Link stage ByteString]

Constants pool item indexes for implemented interfaces

classFieldsCount :: Word16

Number of class fileds

classFields :: [Field stage]

Class fields

classMethodsCount :: Word16

Number of class methods

classMethods :: [Method stage]

Class methods

classAttributesCount :: Word16

Number of class attributes

classAttributes :: Attributes stage

Class attributes

Instances

HasAttributes Class
Binary (Class Pointers)

data Constant stage Source

Constant pool item

Constructors

CClass (Link stage ByteString)
CField
Fields refClass :: Link stage ByteString fieldNameType :: Link stage (NameType Field)
CMethod
Fields refClass :: Link stage ByteString nameType :: Link stage (NameType Method)
CIfaceMethod
Fields refClass :: Link stage ByteString nameType :: Link stage (NameType Method)
CString (Link stage ByteString)
CInteger Word32
CFloat Float
CLong Integer
CDouble Double
CNameType (Link stage ByteString) (Link stage ByteString)
CUTF8
Fields getString :: ByteString
CUnicode
Fields getString :: ByteString

Instances

Eq (Constant Resolved)
Eq (Constant Pointers)
Show (Constant Resolved)
Show (Constant Pointers)
Binary (Constant Pointers)

data Pointers Source

Instances

Eq (Method Pointers)
Eq (Field Pointers)
Eq (Constant Pointers)
Eq (Attributes Pointers)
Show (Method Pointers)
Show (Field Pointers)
Show (Constant Pointers)
Show (Attributes Pointers)
Binary (Method Pointers)
Binary (Field Pointers)
Binary (Class Pointers)
Binary (Constant Pointers)

data Resolved Source

Instances

Eq (Method Resolved)
Eq (Field Resolved)
Eq (Constant Resolved)
Eq (Attributes Resolved)
Show (Method Resolved)
Show (Field Resolved)
Show (Constant Resolved)
Show (Attributes Resolved)

data NameType a Source

Name and signature pair. Used for methods and fields.

Constructors

NameType
Fields ntName :: ByteString ntSignature :: Signature a

Instances

Eq (Signature a) => Eq (NameType a)
Show (Signature a) => Show (NameType a)
Binary (Signature a) => Binary (NameType a)

class HasSignature a Source

Associated Types

type Signature a Source

Instances

HasSignature Method
HasSignature Field

class HasAttributes a whereSource

Methods

attributes :: a stage -> Attributes stageSource

Instances

HasAttributes Method
HasAttributes Field
HasAttributes Class

data AccessFlag Source

Access flags. Used for classess, methods, variables.

Constructors

ACC_PUBLIC	0x0001 Visible for all
ACC_PRIVATE	0x0002 Visible only for defined class
ACC_PROTECTED	0x0004 Visible only for subclasses
ACC_STATIC	0x0008 Static method or variable
ACC_FINAL	0x0010 No further subclassing or assignments
ACC_SYNCHRONIZED	0x0020 Uses monitors
ACC_VOLATILE	0x0040 Could not be cached
ACC_TRANSIENT	0x0080
ACC_NATIVE	0x0100 Implemented in other language
ACC_INTERFACE	0x0200 Class is interface
ACC_ABSTRACT	0x0400

Instances

Enum AccessFlag
Eq AccessFlag
Ord AccessFlag
Show AccessFlag

type family AccessFlags stage Source

data family Attributes stage Source

className :: Constant Resolved -> ByteString Source

apsize :: Attributes Pointers -> Int Source

arsize :: Attributes Resolved -> Int Source

arlist :: Attributes Resolved -> [(ByteString, ByteString)]Source