Language.JVM.ClassFileReader

Documentation

readClassFile :: ByteString -> Either ClassFileError (ClassFile High)

Top level command that combines decode and evolve.

writeClassFile :: ClassFile High -> ByteString

Top level command that combines devolve and encode.

writeClassFile' :: ConstantPool Low -> ClassFile High -> ByteString

Top level command that combines devolve and encode, but tries to retain exact syntax of a previous run using the class pool.

Finer granularity commands

decodeClassFile :: ByteString -> Either ClassFileError (ClassFile Low)

Decode a class file from a lazy ByteString. Ensures that the lazy bytestring is read to EOF, and thereby closing any open files.

encodeClassFile :: ClassFile Low -> ByteString

Create a lazy byte string from a class file

evolveClassFile :: ((AttributeLocation, Text) -> Bool) -> ClassFile Low -> Either ClassFileError (ClassFile High)

Evolve the class file to inline the references. A filter function is provided to remove some attributes. This will sometimes give faster loading times.

devolveClassFile :: ClassFile High -> ClassFile Low

Devolve a ClassFile from High to Low. This might make the ClassFile contain invalid attributes, since we can't read all attributes. If this this is a problem see devolveClassFile'.

devolveClassFile' :: ConstantPool Low -> ClassFile High -> ClassFile Low

Devolve a ClassFile form High to Low, while maintaining the class pool of the original class file. This is useful if we care that unread attributes are still valid. This can cause untended bloat as we do not want to throw away anything in the program

Helpers

roundtripCopy :: FilePath -> FilePath -> IO ()

A test function, essentially reading the classfile and then writing it to another file.

Evolve

data Evolve a

Instances

Monad Evolve

Defined in Language.JVM.ClassFileReader

Methods

(>>=) :: Evolve a -> (a -> Evolve b) -> Evolve b

(>>) :: Evolve a -> Evolve b -> Evolve b

return :: a -> Evolve a

fail :: String -> Evolve a

Functor Evolve

Defined in Language.JVM.ClassFileReader

Methods

fmap :: (a -> b) -> Evolve a -> Evolve b

(<$) :: a -> Evolve b -> Evolve a

Applicative Evolve

Defined in Language.JVM.ClassFileReader

Methods

pure :: a -> Evolve a

(<*>) :: Evolve (a -> b) -> Evolve a -> Evolve b

liftA2 :: (a -> b -> c) -> Evolve a -> Evolve b -> Evolve c

(*>) :: Evolve a -> Evolve b -> Evolve b

(<*) :: Evolve a -> Evolve b -> Evolve a

EvolveM Evolve

Defined in Language.JVM.ClassFileReader

Methods

link :: Referenceable r => Index -> Evolve r

attributeFilter :: Evolve ((AttributeLocation, Text) -> Bool)

attributeError :: String -> Evolve r

LabelM Evolve

Defined in Language.JVM.ClassFileReader

Methods

label :: String -> Evolve a -> Evolve a

MonadReader EvolveConfig Evolve

Defined in Language.JVM.ClassFileReader

Methods

ask :: Evolve EvolveConfig

local :: (EvolveConfig -> EvolveConfig) -> Evolve a -> Evolve a

reader :: (EvolveConfig -> a) -> Evolve a

MonadError ClassFileError Evolve

Defined in Language.JVM.ClassFileReader

Methods

throwError :: ClassFileError -> Evolve a

catchError :: Evolve a -> (ClassFileError -> Evolve a) -> Evolve a

data ClassFileError

An error while reading a class file is represented using this data structure

Instances

Eq ClassFileError

Defined in Language.JVM.ClassFileReader

Methods

(==) :: ClassFileError -> ClassFileError -> Bool

(/=) :: ClassFileError -> ClassFileError -> Bool

Show ClassFileError

Defined in Language.JVM.ClassFileReader

Methods

showsPrec :: Int -> ClassFileError -> ShowS

show :: ClassFileError -> String

showList :: [ClassFileError] -> ShowS

Generic ClassFileError

Defined in Language.JVM.ClassFileReader

Associated Types

type Rep ClassFileError :: Type -> Type

Methods

from :: ClassFileError -> Rep ClassFileError x

to :: Rep ClassFileError x -> ClassFileError

NFData ClassFileError

Defined in Language.JVM.ClassFileReader

Methods

rnf :: ClassFileError -> ()

MonadError ClassFileError Evolve

Defined in Language.JVM.ClassFileReader

Methods

throwError :: ClassFileError -> Evolve a

catchError :: Evolve a -> (ClassFileError -> Evolve a) -> Evolve a

type Rep ClassFileError

Defined in Language.JVM.ClassFileReader

type Rep ClassFileError = D1 (MetaData "ClassFileError" "Language.JVM.ClassFileReader" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" False) ((C1 (MetaCons "CFEPoolAccessError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PoolAccessError)) :+: C1 (MetaCons "CFEInconsistentClassPool" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String))) :+: (C1 (MetaCons "CFEConversionError" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)) :+: C1 (MetaCons "CFEUnreadableFile" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String))))

data EvolveConfig

Constructors

EvolveConfig

Fields

• ecLabel :: [String]
• ecConstantPool :: ConstantPool High
• ecAttributeFilter :: (AttributeLocation, Text) -> Bool

Instances

MonadReader EvolveConfig Evolve

Defined in Language.JVM.ClassFileReader

Methods

ask :: Evolve EvolveConfig

local :: (EvolveConfig -> EvolveConfig) -> Evolve a -> Evolve a

reader :: (EvolveConfig -> a) -> Evolve a

runEvolve :: EvolveConfig -> Evolve a -> Either ClassFileError a

bootstrapConstantPool :: ConstantPool Low -> Either ClassFileError (ConstantPool High)

Untie the constant pool, this requires a special operation as the constant pool might reference itself.

Builder

data ConstantPoolBuilder a

Instances

Monad ConstantPoolBuilder

Defined in Language.JVM.ClassFileReader

Methods

(>>=) :: ConstantPoolBuilder a -> (a -> ConstantPoolBuilder b) -> ConstantPoolBuilder b

(>>) :: ConstantPoolBuilder a -> ConstantPoolBuilder b -> ConstantPoolBuilder b

return :: a -> ConstantPoolBuilder a

fail :: String -> ConstantPoolBuilder a

Functor ConstantPoolBuilder

Defined in Language.JVM.ClassFileReader

Methods

fmap :: (a -> b) -> ConstantPoolBuilder a -> ConstantPoolBuilder b

(<$) :: a -> ConstantPoolBuilder b -> ConstantPoolBuilder a

Applicative ConstantPoolBuilder

Defined in Language.JVM.ClassFileReader

Methods

pure :: a -> ConstantPoolBuilder a

(<*>) :: ConstantPoolBuilder (a -> b) -> ConstantPoolBuilder a -> ConstantPoolBuilder b

liftA2 :: (a -> b -> c) -> ConstantPoolBuilder a -> ConstantPoolBuilder b -> ConstantPoolBuilder c

(*>) :: ConstantPoolBuilder a -> ConstantPoolBuilder b -> ConstantPoolBuilder b

(<*) :: ConstantPoolBuilder a -> ConstantPoolBuilder b -> ConstantPoolBuilder a

DevolveM ConstantPoolBuilder

Defined in Language.JVM.ClassFileReader

Methods

unlink :: Referenceable r => r -> ConstantPoolBuilder Index

LabelM ConstantPoolBuilder

Defined in Language.JVM.ClassFileReader

Methods

label :: String -> ConstantPoolBuilder a -> ConstantPoolBuilder a

MonadState CPBuilder ConstantPoolBuilder

Defined in Language.JVM.ClassFileReader

Methods

get :: ConstantPoolBuilder CPBuilder

put :: CPBuilder -> ConstantPoolBuilder ()

state :: (CPBuilder -> (a, CPBuilder)) -> ConstantPoolBuilder a

runConstantPoolBuilder :: ConstantPoolBuilder a -> CPBuilder -> (a, CPBuilder)

data CPBuilder

Constructors

CPBuilder

Fields

• cpbMapper :: Map (Constant Low) Index
• cpbNextIndex :: Index
• cpbConstants :: [Constant Low]

Instances

Show CPBuilder

Defined in Language.JVM.ClassFileReader

Methods

showsPrec :: Int -> CPBuilder -> ShowS

show :: CPBuilder -> String

showList :: [CPBuilder] -> ShowS

MonadState CPBuilder ConstantPoolBuilder

Defined in Language.JVM.ClassFileReader

Methods

get :: ConstantPoolBuilder CPBuilder

put :: CPBuilder -> ConstantPoolBuilder ()

state :: (CPBuilder -> (a, CPBuilder)) -> ConstantPoolBuilder a

builderFromConstantPool :: ConstantPool Low -> CPBuilder

constantPoolFromBuilder :: CPBuilder -> ConstantPool Low

cpbEmpty :: CPBuilder