Language.JVM.Type

This module contains the JType, ClassName, MethodDescriptor, and FieldDescriptor.

Base types

ClassName

newtype ClassName

A class name

Constructors

ClassName

Fields

• classNameAsText :: Text

Instances

Eq ClassName

Defined in Language.JVM.Type

Methods

(==) :: ClassName -> ClassName -> Bool

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

Ord ClassName

Defined in Language.JVM.Type

Methods

compare :: ClassName -> ClassName -> Ordering

(<) :: ClassName -> ClassName -> Bool

(<=) :: ClassName -> ClassName -> Bool

(>) :: ClassName -> ClassName -> Bool

(>=) :: ClassName -> ClassName -> Bool

max :: ClassName -> ClassName -> ClassName

min :: ClassName -> ClassName -> ClassName

Show ClassName

Defined in Language.JVM.Type

Methods

showsPrec :: Int -> ClassName -> ShowS

show :: ClassName -> String

showList :: [ClassName] -> ShowS

IsString ClassName

Defined in Language.JVM.Type

Methods

fromString :: String -> ClassName

Generic ClassName

Defined in Language.JVM.Type

Associated Types

type Rep ClassName :: Type -> Type

Methods

from :: ClassName -> Rep ClassName x

to :: Rep ClassName x -> ClassName

NFData ClassName

Defined in Language.JVM.Type

Methods

rnf :: ClassName -> ()

TypeParse ClassName

Defined in Language.JVM.Type

Methods

parseType :: Parser ClassName

typeToBuilder :: ClassName -> Builder

Referenceable ClassName

Defined in Language.JVM.Constant

Methods

fromConst :: Monad m => (forall a'. String -> m a') -> Constant High -> m ClassName

toConst :: Monad m => ClassName -> m (Constant High)

type Rep ClassName

Defined in Language.JVM.Type

type Rep ClassName = D1 (MetaData "ClassName" "Language.JVM.Type" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" True) (C1 (MetaCons "ClassName" PrefixI True) (S1 (MetaSel (Just "classNameAsText") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

strCls :: String -> ClassName

Wrapper method that converts a string representation of a class into a class.

dotCls :: Text -> ClassName

Takes the dot representation and converts it into a class.

JType

data JType

Constructors

JTBase JBaseType

JTRef JRefType

Instances

Eq JType

Defined in Language.JVM.Type

Methods

(==) :: JType -> JType -> Bool

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

Ord JType

Defined in Language.JVM.Type

Methods

compare :: JType -> JType -> Ordering

(<) :: JType -> JType -> Bool

(<=) :: JType -> JType -> Bool

(>) :: JType -> JType -> Bool

(>=) :: JType -> JType -> Bool

max :: JType -> JType -> JType

min :: JType -> JType -> JType

Show JType

Defined in Language.JVM.Type

Methods

showsPrec :: Int -> JType -> ShowS

show :: JType -> String

showList :: [JType] -> ShowS

IsString JType

Defined in Language.JVM.Type

Methods

fromString :: String -> JType

Generic JType

Defined in Language.JVM.Type

Associated Types

type Rep JType :: Type -> Type

Methods

from :: JType -> Rep JType x

to :: Rep JType x -> JType

NFData JType

Defined in Language.JVM.Type

Methods

rnf :: JType -> ()

TypeParse ReturnDescriptor

Defined in Language.JVM.Type

Methods

parseType :: Parser ReturnDescriptor

typeToBuilder :: ReturnDescriptor -> Builder

TypeParse JType

Defined in Language.JVM.Type

Methods

parseType :: Parser JType

typeToBuilder :: JType -> Builder

Referenceable ReturnDescriptor

Defined in Language.JVM.Constant

Methods

fromConst :: Monad m => (forall a'. String -> m a') -> Constant High -> m ReturnDescriptor

toConst :: Monad m => ReturnDescriptor -> m (Constant High)

type Rep JType

Defined in Language.JVM.Type

type Rep JType = D1 (MetaData "JType" "Language.JVM.Type" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" False) (C1 (MetaCons "JTBase" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JBaseType)) :+: C1 (MetaCons "JTRef" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JRefType)))

data JBaseType

The Jvm Primitive Types

Constructors

JTByte

JTChar

JTDouble

JTFloat

JTInt

JTLong

JTShort

JTBoolean

Instances

Eq JBaseType

Defined in Language.JVM.Type

Methods

(==) :: JBaseType -> JBaseType -> Bool

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

Ord JBaseType

Defined in Language.JVM.Type

Methods

compare :: JBaseType -> JBaseType -> Ordering

(<) :: JBaseType -> JBaseType -> Bool

(<=) :: JBaseType -> JBaseType -> Bool

(>) :: JBaseType -> JBaseType -> Bool

(>=) :: JBaseType -> JBaseType -> Bool

max :: JBaseType -> JBaseType -> JBaseType

min :: JBaseType -> JBaseType -> JBaseType

Show JBaseType

Defined in Language.JVM.Type

Methods

showsPrec :: Int -> JBaseType -> ShowS

show :: JBaseType -> String

showList :: [JBaseType] -> ShowS

Generic JBaseType

Defined in Language.JVM.Type

Associated Types

type Rep JBaseType :: Type -> Type

Methods

from :: JBaseType -> Rep JBaseType x

to :: Rep JBaseType x -> JBaseType

NFData JBaseType

Defined in Language.JVM.Type

Methods

rnf :: JBaseType -> ()

TypeParse JBaseType

Defined in Language.JVM.Type

Methods

parseType :: Parser JBaseType

typeToBuilder :: JBaseType -> Builder

type Rep JBaseType

Defined in Language.JVM.Type

type Rep JBaseType = D1 (MetaData "JBaseType" "Language.JVM.Type" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" False) (((C1 (MetaCons "JTByte" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "JTChar" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "JTDouble" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "JTFloat" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "JTInt" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "JTLong" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "JTShort" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "JTBoolean" PrefixI False) (U1 :: Type -> Type))))

jBaseTypeToChar :: JBaseType -> Char

Get the corresponding Char of a JBaseType

data JRefType

Constructors

JTClass !ClassName

JTArray !JType

Instances

Eq JRefType

Defined in Language.JVM.Type

Methods

(==) :: JRefType -> JRefType -> Bool

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

Ord JRefType

Defined in Language.JVM.Type

Methods

compare :: JRefType -> JRefType -> Ordering

(<) :: JRefType -> JRefType -> Bool

(<=) :: JRefType -> JRefType -> Bool

(>) :: JRefType -> JRefType -> Bool

(>=) :: JRefType -> JRefType -> Bool

max :: JRefType -> JRefType -> JRefType

min :: JRefType -> JRefType -> JRefType

Show JRefType

Defined in Language.JVM.Type

Methods

showsPrec :: Int -> JRefType -> ShowS

show :: JRefType -> String

showList :: [JRefType] -> ShowS

Generic JRefType

Defined in Language.JVM.Type

Associated Types

type Rep JRefType :: Type -> Type

Methods

from :: JRefType -> Rep JRefType x

to :: Rep JRefType x -> JRefType

NFData JRefType

Defined in Language.JVM.Type

Methods

rnf :: JRefType -> ()

TypeParse JRefType

Defined in Language.JVM.Type

Methods

parseType :: Parser JRefType

typeToBuilder :: JRefType -> Builder

Referenceable JRefType

Defined in Language.JVM.Constant

Methods

fromConst :: Monad m => (forall a'. String -> m a') -> Constant High -> m JRefType

toConst :: Monad m => JRefType -> m (Constant High)

type Rep JRefType

Defined in Language.JVM.Type

type Rep JRefType = D1 (MetaData "JRefType" "Language.JVM.Type" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" False) (C1 (MetaCons "JTClass" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ClassName)) :+: C1 (MetaCons "JTArray" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 JType)))

refTypeDepth :: JRefType -> Int

The number of nested arrays

MethodDescriptor

data MethodDescriptor

Method Descriptor

Constructors

MethodDescriptor

Fields

• methodDescriptorArguments :: [JType]
• methodDescriptorReturnType :: ReturnDescriptor

Instances

Eq MethodDescriptor

Defined in Language.JVM.Type

Methods

(==) :: MethodDescriptor -> MethodDescriptor -> Bool

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

Ord MethodDescriptor

Defined in Language.JVM.Type

Methods

compare :: MethodDescriptor -> MethodDescriptor -> Ordering

(<) :: MethodDescriptor -> MethodDescriptor -> Bool

(<=) :: MethodDescriptor -> MethodDescriptor -> Bool

(>) :: MethodDescriptor -> MethodDescriptor -> Bool

(>=) :: MethodDescriptor -> MethodDescriptor -> Bool

max :: MethodDescriptor -> MethodDescriptor -> MethodDescriptor

min :: MethodDescriptor -> MethodDescriptor -> MethodDescriptor

Show MethodDescriptor

Defined in Language.JVM.Type

Methods

showsPrec :: Int -> MethodDescriptor -> ShowS

show :: MethodDescriptor -> String

showList :: [MethodDescriptor] -> ShowS

IsString MethodDescriptor

Defined in Language.JVM.Type

Methods

fromString :: String -> MethodDescriptor

Generic MethodDescriptor

Defined in Language.JVM.Type

Associated Types

type Rep MethodDescriptor :: Type -> Type

Methods

from :: MethodDescriptor -> Rep MethodDescriptor x

to :: Rep MethodDescriptor x -> MethodDescriptor

NFData MethodDescriptor

Defined in Language.JVM.Type

Methods

rnf :: MethodDescriptor -> ()

TypeParse MethodDescriptor

Defined in Language.JVM.Type

Methods

parseType :: Parser MethodDescriptor

typeToBuilder :: MethodDescriptor -> Builder

Referenceable MethodDescriptor

Defined in Language.JVM.Constant

Methods

fromConst :: Monad m => (forall a'. String -> m a') -> Constant High -> m MethodDescriptor

toConst :: Monad m => MethodDescriptor -> m (Constant High)

type Rep MethodDescriptor

Defined in Language.JVM.Type

type Rep MethodDescriptor = D1 (MetaData "MethodDescriptor" "Language.JVM.Type" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" False) (C1 (MetaCons "MethodDescriptor" PrefixI True) (S1 (MetaSel (Just "methodDescriptorArguments") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [JType]) :*: S1 (MetaSel (Just "methodDescriptorReturnType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ReturnDescriptor)))

type ReturnDescriptor = Maybe JType

A ReturnDescriptor is maybe a type, otherwise it is void. https://docs.oracle.com/javase/specs/jvms/se8/html/jvms-4.html#jvms-4.3.3

FieldDescriptor

newtype FieldDescriptor

Field Descriptor

Constructors

FieldDescriptor

Fields

• fieldDescriptorType :: JType

Instances

Eq FieldDescriptor

Defined in Language.JVM.Type

Methods

(==) :: FieldDescriptor -> FieldDescriptor -> Bool

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

Ord FieldDescriptor

Defined in Language.JVM.Type

Methods

compare :: FieldDescriptor -> FieldDescriptor -> Ordering

(<) :: FieldDescriptor -> FieldDescriptor -> Bool

(<=) :: FieldDescriptor -> FieldDescriptor -> Bool

(>) :: FieldDescriptor -> FieldDescriptor -> Bool

(>=) :: FieldDescriptor -> FieldDescriptor -> Bool

max :: FieldDescriptor -> FieldDescriptor -> FieldDescriptor

min :: FieldDescriptor -> FieldDescriptor -> FieldDescriptor

Show FieldDescriptor

Defined in Language.JVM.Type

Methods

showsPrec :: Int -> FieldDescriptor -> ShowS

show :: FieldDescriptor -> String

showList :: [FieldDescriptor] -> ShowS

IsString FieldDescriptor

Defined in Language.JVM.Type

Methods

fromString :: String -> FieldDescriptor

Generic FieldDescriptor

Defined in Language.JVM.Type

Associated Types

type Rep FieldDescriptor :: Type -> Type

Methods

from :: FieldDescriptor -> Rep FieldDescriptor x

to :: Rep FieldDescriptor x -> FieldDescriptor

NFData FieldDescriptor

Defined in Language.JVM.Type

Methods

rnf :: FieldDescriptor -> ()

TypeParse FieldDescriptor

Defined in Language.JVM.Type

Methods

parseType :: Parser FieldDescriptor

typeToBuilder :: FieldDescriptor -> Builder

Referenceable FieldDescriptor

Defined in Language.JVM.Constant

Methods

fromConst :: Monad m => (forall a'. String -> m a') -> Constant High -> m FieldDescriptor

toConst :: Monad m => FieldDescriptor -> m (Constant High)

type Rep FieldDescriptor

Defined in Language.JVM.Type

type Rep FieldDescriptor = D1 (MetaData "FieldDescriptor" "Language.JVM.Type" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" True) (C1 (MetaCons "FieldDescriptor" PrefixI True) (S1 (MetaSel (Just "fieldDescriptorType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 JType)))

NameAndType

data NameAndType a

A name and a type

Constructors

NameAndType

Fields

• ntName :: Text
• ntDescriptor :: a

Instances

Eq a => Eq (NameAndType a)

Defined in Language.JVM.Type

Methods

(==) :: NameAndType a -> NameAndType a -> Bool

(/=) :: NameAndType a -> NameAndType a -> Bool

Ord a => Ord (NameAndType a)

Defined in Language.JVM.Type

Methods

compare :: NameAndType a -> NameAndType a -> Ordering

(<) :: NameAndType a -> NameAndType a -> Bool

(<=) :: NameAndType a -> NameAndType a -> Bool

(>) :: NameAndType a -> NameAndType a -> Bool

(>=) :: NameAndType a -> NameAndType a -> Bool

max :: NameAndType a -> NameAndType a -> NameAndType a

min :: NameAndType a -> NameAndType a -> NameAndType a

Show a => Show (NameAndType a)

Defined in Language.JVM.Type

Methods

showsPrec :: Int -> NameAndType a -> ShowS

show :: NameAndType a -> String

showList :: [NameAndType a] -> ShowS

TypeParse t => IsString (NameAndType t)

Defined in Language.JVM.Type

Methods

fromString :: String -> NameAndType t

Generic (NameAndType a)

Defined in Language.JVM.Type

Associated Types

type Rep (NameAndType a) :: Type -> Type

Methods

from :: NameAndType a -> Rep (NameAndType a) x

to :: Rep (NameAndType a) x -> NameAndType a

NFData a => NFData (NameAndType a)

Defined in Language.JVM.Type

Methods

rnf :: NameAndType a -> ()

TypeParse t => TypeParse (NameAndType t)

Defined in Language.JVM.Type

Methods

parseType :: Parser (NameAndType t)

typeToBuilder :: NameAndType t -> Builder

TypeParse a => Referenceable (NameAndType a)

Defined in Language.JVM.Constant

Methods

fromConst :: Monad m => (forall a'. String -> m a') -> Constant High -> m (NameAndType a)

toConst :: Monad m => NameAndType a -> m (Constant High)

type Rep (NameAndType a)

Defined in Language.JVM.Type

type Rep (NameAndType a) = D1 (MetaData "NameAndType" "Language.JVM.Type" "jvm-binary-0.8.0-HpvPbNkzsQo844TuM02sMI" False) (C1 (MetaCons "NameAndType" PrefixI True) (S1 (MetaSel (Just "ntName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "ntDescriptor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)))

(<:>) :: Text -> a -> NameAndType a

TypeParse

class TypeParse a where

Methods

parseType :: Parser a

A TypeParse should be parsable

typeToBuilder :: a -> Builder

A TypeParse should be printable

Instances

TypeParse FieldDescriptor

Defined in Language.JVM.Type

Methods

parseType :: Parser FieldDescriptor

typeToBuilder :: FieldDescriptor -> Builder

TypeParse MethodDescriptor

Defined in Language.JVM.Type

Methods

parseType :: Parser MethodDescriptor

typeToBuilder :: MethodDescriptor -> Builder

TypeParse ReturnDescriptor

Defined in Language.JVM.Type

Methods

parseType :: Parser ReturnDescriptor

typeToBuilder :: ReturnDescriptor -> Builder

TypeParse JType

Defined in Language.JVM.Type

Methods

parseType :: Parser JType

typeToBuilder :: JType -> Builder

TypeParse JRefType

Defined in Language.JVM.Type

Methods

parseType :: Parser JRefType

typeToBuilder :: JRefType -> Builder

TypeParse JBaseType

Defined in Language.JVM.Type

Methods

parseType :: Parser JBaseType

typeToBuilder :: JBaseType -> Builder

TypeParse ClassName

Defined in Language.JVM.Type

Methods

parseType :: Parser ClassName

typeToBuilder :: ClassName -> Builder

TypeParse t => TypeParse (NameAndType t)

Defined in Language.JVM.Type

Methods

parseType :: Parser (NameAndType t)

typeToBuilder :: NameAndType t -> Builder

typeFromText :: TypeParse a => Text -> Either String a

Parse a type from text

typeToText :: TypeParse a => a -> Text

Convert a type into text

parseOnly :: Parser a -> Text -> Either String a

Run a parser that cannot be resupplied via a Partial result.

This function does not force a parser to consume all of its input. Instead, any residual input will be discarded. To force a parser to consume all of its input, use something like this:

parseOnly (myParser <* endOfInput)
 

parseFlatJRefType :: Parser JRefType

jRefTypeToFlatText :: JRefType -> Text