Safe Haskell	None
Language	Haskell98

Data.GI.CodeGen.API

Synopsis

data API
- = APIConst Constant
- | APIFunction Function
- | APICallback Callback
- | APIEnum Enumeration
- | APIFlags Flags
- | APIInterface Interface
- | APIObject Object
- | APIStruct Struct
- | APIUnion Union
data GIRInfo = GIRInfo {
- girPCPackages :: [Text]
- girNSName :: Text
- girNSVersion :: Text
- girAPIs :: [(Name, API)]
- girCTypes :: Map Text Name
}
loadGIRInfo :: Bool -> Text -> Maybe Text -> [FilePath] -> [GIRRule] -> IO (GIRInfo, [GIRInfo])
loadRawGIRInfo :: Bool -> Text -> Maybe Text -> [FilePath] -> IO GIRInfo
data GIRRule
- = GIRSetAttr (GIRPath, Name) Text
- | GIRAddNode GIRPath Name
- | GIRDeleteNode GIRPath
type GIRPath = [GIRNodeSpec]
data GIRNodeSpec
- = GIRNamed GIRNameTag
- | GIRType Text
- | GIRTypedName Text GIRNameTag
data GIRNameTag
- = GIRPlainName Text
- | GIRRegex Text
data Name = Name {
- namespace :: Text
- name :: Text
}
data Transfer
- = TransferNothing
- | TransferContainer
- | TransferEverything
data AllocationInfo = AllocationInfo {
- allocCalloc :: AllocationOp
- allocCopy :: AllocationOp
- allocFree :: AllocationOp
}
data AllocationOp
- = AllocationOpUnknown
- | AllocationOp Text
unknownAllocationInfo :: AllocationInfo
data Direction
- = DirectionIn
- | DirectionOut
- | DirectionInout
data Scope
- = ScopeTypeInvalid
- | ScopeTypeCall
- | ScopeTypeAsync
- | ScopeTypeNotified
data DeprecationInfo
data EnumerationMember = EnumerationMember {
- enumMemberName :: Text
- enumMemberValue :: Int64
- enumMemberCId :: Text
- enumMemberDoc :: Documentation
}
data PropertyFlag
- = PropertyReadable
- | PropertyWritable
- | PropertyConstruct
- | PropertyConstructOnly
data MethodType
- = Constructor
- | MemberFunction
- | OrdinaryMethod
data Constant = Constant {
- constantType :: Type
- constantValue :: Text
- constantCType :: Text
- constantDocumentation :: Documentation
- constantDeprecated :: Maybe DeprecationInfo
}
data Arg = Arg {
- argCName :: Text
- argType :: Type
- direction :: Direction
- mayBeNull :: Bool
- argDoc :: Documentation
- argScope :: Scope
- argClosure :: Int
- argDestroy :: Int
- argCallerAllocates :: Bool
- transfer :: Transfer
}
data Callable = Callable {
- returnType :: Maybe Type
- returnMayBeNull :: Bool
- returnTransfer :: Transfer
- returnDocumentation :: Documentation
- args :: [Arg]
- skipReturn :: Bool
- callableThrows :: Bool
- callableDeprecated :: Maybe DeprecationInfo
- callableDocumentation :: Documentation
}
data Function = Function {
- fnSymbol :: Text
- fnMovedTo :: Maybe Text
- fnCallable :: Callable
}
data Signal = Signal {
- sigName :: Text
- sigCallable :: Callable
- sigDeprecated :: Maybe DeprecationInfo
- sigDoc :: Documentation
}
data Property = Property {
- propName :: Text
- propType :: Type
- propFlags :: [PropertyFlag]
- propReadNullable :: Maybe Bool
- propWriteNullable :: Maybe Bool
- propTransfer :: Transfer
- propDoc :: Documentation
- propDeprecated :: Maybe DeprecationInfo
}
data Field = Field {
- fieldName :: Text
- fieldVisible :: Bool
- fieldType :: Type
- fieldIsPointer :: Maybe Bool
- fieldCallback :: Maybe Callback
- fieldOffset :: Int
- fieldFlags :: [FieldInfoFlag]
- fieldDocumentation :: Documentation
- fieldDeprecated :: Maybe DeprecationInfo
}
data Struct = Struct {
- structIsBoxed :: Bool
- structAllocationInfo :: AllocationInfo
- structTypeInit :: Maybe Text
- structCType :: Maybe Text
- structSize :: Int
- gtypeStructFor :: Maybe Name
- structIsDisguised :: Bool
- structFields :: [Field]
- structMethods :: [Method]
- structDeprecated :: Maybe DeprecationInfo
- structDocumentation :: Documentation
}
data Callback = Callback {
- cbCallable :: Callable
- cbCType :: Maybe Text
- cbDocumentation :: Documentation
}
data Interface = Interface {
- ifTypeInit :: Maybe Text
- ifCType :: Maybe Text
- ifDocumentation :: Documentation
- ifPrerequisites :: [Name]
- ifProperties :: [Property]
- ifSignals :: [Signal]
- ifMethods :: [Method]
- ifAllocationInfo :: AllocationInfo
- ifDeprecated :: Maybe DeprecationInfo
}
data Method = Method {
- methodName :: Name
- methodSymbol :: Text
- methodType :: MethodType
- methodMovedTo :: Maybe Text
- methodCallable :: Callable
}
data Object = Object {
- objParent :: Maybe Name
- objTypeInit :: Text
- objTypeName :: Text
- objCType :: Maybe Text
- objInterfaces :: [Name]
- objDeprecated :: Maybe DeprecationInfo
- objDocumentation :: Documentation
- objMethods :: [Method]
- objProperties :: [Property]
- objSignals :: [Signal]
}
data Enumeration = Enumeration {
- enumMembers :: [EnumerationMember]
- enumErrorDomain :: Maybe Text
- enumTypeInit :: Maybe Text
- enumDocumentation :: Documentation
- enumCType :: Text
- enumStorageBytes :: Int
- enumDeprecated :: Maybe DeprecationInfo
}
data Flags = Flags Enumeration
data Union = Union {
- unionIsBoxed :: Bool
- unionAllocationInfo :: AllocationInfo
- unionDocumentation :: Documentation
- unionSize :: Int
- unionTypeInit :: Maybe Text
- unionFields :: [Field]
- unionMethods :: [Method]
- unionCType :: Maybe Text
- unionDeprecated :: Maybe DeprecationInfo
}

Documentation

data API #

Constructors

APIConst Constant
APIFunction Function
APICallback Callback
APIEnum Enumeration
APIFlags Flags
APIInterface Interface
APIObject Object
APIStruct Struct
APIUnion Union

Instances

Show API #
Instance details Defined in Data.GI.CodeGen.API Methods showsPrec :: Int -> API -> ShowS # show :: API -> String # showList :: [API] -> ShowS #

data GIRInfo #

Constructors

GIRInfo
Fields girPCPackages :: [Text] girNSName :: Text girNSVersion :: Text girAPIs :: [(Name, API)] girCTypes :: Map Text Name

Instances

Show GIRInfo #
Instance details Defined in Data.GI.CodeGen.API Methods showsPrec :: Int -> GIRInfo -> ShowS # show :: GIRInfo -> String # showList :: [GIRInfo] -> ShowS #

loadGIRInfo #

Arguments

:: Bool	verbose
-> Text	name
-> Maybe Text	version
-> [FilePath]	extra paths to search
-> [GIRRule]	fixups
-> IO (GIRInfo, [GIRInfo])	(parsed doc, parsed deps)

Load and parse a GIR file, including its dependencies.

loadRawGIRInfo #

Arguments

:: Bool	verbose
-> Text	name
-> Maybe Text	version
-> [FilePath]	extra paths to search
-> IO GIRInfo	bare parsed document

Bare minimum loading and parsing of a single repository, without loading or parsing its dependencies, resolving aliases, or fixing up structs or interfaces.

data GIRRule #

A rule for modifying the GIR file.

Constructors

GIRSetAttr (GIRPath, Name) Text	(Path to element, attrName), newValue.
GIRAddNode GIRPath Name	Add a child node at the given selector.
GIRDeleteNode GIRPath	Delete any nodes matching the given selector.

Instances

Show GIRRule #
Instance details Defined in Data.GI.CodeGen.API Methods showsPrec :: Int -> GIRRule -> ShowS # show :: GIRRule -> String # showList :: [GIRRule] -> ShowS #

type GIRPath = [GIRNodeSpec] #

Path to a node in the GIR file, starting from the document root of the GIR file. This is a very simplified version of something like XPath.

data GIRNodeSpec #

Node selector for a path in the GIR file.

Constructors

GIRNamed GIRNameTag	Node with the given "name" attr.
GIRType Text	Node of the given type.
GIRTypedName Text GIRNameTag	Combination of the above.

Instances

Show GIRNodeSpec #
Instance details Defined in Data.GI.CodeGen.API Methods showsPrec :: Int -> GIRNodeSpec -> ShowS # show :: GIRNodeSpec -> String # showList :: [GIRNodeSpec] -> ShowS #

data GIRNameTag #

A name tag, which is either a name or a regular expression.

Constructors

GIRPlainName Text
GIRRegex Text

Instances

Show GIRNameTag #
Instance details Defined in Data.GI.CodeGen.API Methods showsPrec :: Int -> GIRNameTag -> ShowS # show :: GIRNameTag -> String # showList :: [GIRNameTag] -> ShowS #

data Name #

Name for a symbol in the GIR file.

Constructors

Name
Fields namespace :: Text name :: Text

Instances

Eq Name #
Instance details Defined in Data.GI.GIR.BasicTypes Methods (==) :: Name -> Name -> Bool # (/=) :: Name -> Name -> Bool #
Ord Name #
Instance details Defined in Data.GI.GIR.BasicTypes Methods compare :: Name -> Name -> Ordering # (<) :: Name -> Name -> Bool # (<=) :: Name -> Name -> Bool # (>) :: Name -> Name -> Bool # (>=) :: Name -> Name -> Bool # max :: Name -> Name -> Name # min :: Name -> Name -> Name #
Show Name #
Instance details Defined in Data.GI.GIR.BasicTypes Methods showsPrec :: Int -> Name -> ShowS # show :: Name -> String # showList :: [Name] -> ShowS #

data Transfer #

Transfer mode for an argument or property.

Constructors

TransferNothing
TransferContainer
TransferEverything

Instances

Eq Transfer #
Instance details Defined in Data.GI.GIR.BasicTypes Methods (==) :: Transfer -> Transfer -> Bool # (/=) :: Transfer -> Transfer -> Bool #
Ord Transfer #
Instance details Defined in Data.GI.GIR.BasicTypes Methods compare :: Transfer -> Transfer -> Ordering # (<) :: Transfer -> Transfer -> Bool # (<=) :: Transfer -> Transfer -> Bool # (>) :: Transfer -> Transfer -> Bool # (>=) :: Transfer -> Transfer -> Bool # max :: Transfer -> Transfer -> Transfer # min :: Transfer -> Transfer -> Transfer #
Show Transfer #
Instance details Defined in Data.GI.GIR.BasicTypes Methods showsPrec :: Int -> Transfer -> ShowS # show :: Transfer -> String # showList :: [Transfer] -> ShowS #

data AllocationInfo #

Allocation/deallocation information for a given foreign pointer.

Constructors

AllocationInfo
Fields allocCalloc :: AllocationOp allocCopy :: AllocationOp allocFree :: AllocationOp

Instances

Show AllocationInfo #
Instance details Defined in Data.GI.GIR.Allocation Methods showsPrec :: Int -> AllocationInfo -> ShowS # show :: AllocationInfo -> String # showList :: [AllocationInfo] -> ShowS #

data AllocationOp #

Information about a given allocation operation. It is either disallowed, allowed via the given function, or it is unknown at the current stage how to perform the operation.

Constructors

AllocationOpUnknown
AllocationOp Text

Instances

Eq AllocationOp #
Instance details Defined in Data.GI.GIR.Allocation Methods (==) :: AllocationOp -> AllocationOp -> Bool # (/=) :: AllocationOp -> AllocationOp -> Bool #
Show AllocationOp #
Instance details Defined in Data.GI.GIR.Allocation Methods showsPrec :: Int -> AllocationOp -> ShowS # show :: AllocationOp -> String # showList :: [AllocationOp] -> ShowS #

unknownAllocationInfo :: AllocationInfo #

A convenience function, filling in all the allocation info to unknown.

data Direction #

Constructors

DirectionIn
DirectionOut
DirectionInout

Instances

Eq Direction #
Instance details Defined in Data.GI.GIR.Arg Methods (==) :: Direction -> Direction -> Bool # (/=) :: Direction -> Direction -> Bool #
Ord Direction #
Instance details Defined in Data.GI.GIR.Arg Methods compare :: Direction -> Direction -> Ordering # (<) :: Direction -> Direction -> Bool # (<=) :: Direction -> Direction -> Bool # (>) :: Direction -> Direction -> Bool # (>=) :: Direction -> Direction -> Bool # max :: Direction -> Direction -> Direction # min :: Direction -> Direction -> Direction #
Show Direction #
Instance details Defined in Data.GI.GIR.Arg Methods showsPrec :: Int -> Direction -> ShowS # show :: Direction -> String # showList :: [Direction] -> ShowS #

data Scope #

Constructors

ScopeTypeInvalid
ScopeTypeCall
ScopeTypeAsync
ScopeTypeNotified

Instances

Eq Scope #
Instance details Defined in Data.GI.GIR.Arg Methods (==) :: Scope -> Scope -> Bool # (/=) :: Scope -> Scope -> Bool #
Ord Scope #
Instance details Defined in Data.GI.GIR.Arg Methods compare :: Scope -> Scope -> Ordering # (<) :: Scope -> Scope -> Bool # (<=) :: Scope -> Scope -> Bool # (>) :: Scope -> Scope -> Bool # (>=) :: Scope -> Scope -> Bool # max :: Scope -> Scope -> Scope # min :: Scope -> Scope -> Scope #
Show Scope #
Instance details Defined in Data.GI.GIR.Arg Methods showsPrec :: Int -> Scope -> ShowS # show :: Scope -> String # showList :: [Scope] -> ShowS #

data DeprecationInfo #

Deprecation information on a symbol.

Instances

Eq DeprecationInfo #
Instance details Defined in Data.GI.GIR.Deprecation Methods (==) :: DeprecationInfo -> DeprecationInfo -> Bool # (/=) :: DeprecationInfo -> DeprecationInfo -> Bool #
Show DeprecationInfo #
Instance details Defined in Data.GI.GIR.Deprecation Methods showsPrec :: Int -> DeprecationInfo -> ShowS # show :: DeprecationInfo -> String # showList :: [DeprecationInfo] -> ShowS #

data EnumerationMember #

Member of an enumeration.

Constructors

EnumerationMember
Fields enumMemberName :: Text enumMemberValue :: Int64 enumMemberCId :: Text enumMemberDoc :: Documentation

Instances

Show EnumerationMember #
Instance details Defined in Data.GI.GIR.Enum Methods showsPrec :: Int -> EnumerationMember -> ShowS # show :: EnumerationMember -> String # showList :: [EnumerationMember] -> ShowS #

data PropertyFlag #

Constructors

PropertyReadable
PropertyWritable
PropertyConstruct
PropertyConstructOnly

Instances

Eq PropertyFlag #
Instance details Defined in Data.GI.GIR.Property Methods (==) :: PropertyFlag -> PropertyFlag -> Bool # (/=) :: PropertyFlag -> PropertyFlag -> Bool #
Show PropertyFlag #
Instance details Defined in Data.GI.GIR.Property Methods showsPrec :: Int -> PropertyFlag -> ShowS # show :: PropertyFlag -> String # showList :: [PropertyFlag] -> ShowS #

data MethodType #

Constructors

Constructor	Constructs an instance of the parent type
MemberFunction	A function in the namespace
OrdinaryMethod	A function taking the parent instance as first argument.

Instances

Eq MethodType #
Instance details Defined in Data.GI.GIR.Method Methods (==) :: MethodType -> MethodType -> Bool # (/=) :: MethodType -> MethodType -> Bool #
Show MethodType #
Instance details Defined in Data.GI.GIR.Method Methods showsPrec :: Int -> MethodType -> ShowS # show :: MethodType -> String # showList :: [MethodType] -> ShowS #

data Constant #

Info about a constant.

Constructors

Constant
Fields constantType :: Type constantValue :: Text constantCType :: Text constantDocumentation :: Documentation constantDeprecated :: Maybe DeprecationInfo

Instances

Show Constant #
Instance details Defined in Data.GI.GIR.Constant Methods showsPrec :: Int -> Constant -> ShowS # show :: Constant -> String # showList :: [Constant] -> ShowS #

data Arg #

Constructors

Arg
Fields argCName :: Text C name for the argument. For a escaped name valid in Haskell code, use `escapedArgName`. argType :: Type direction :: Direction mayBeNull :: Bool argDoc :: Documentation argScope :: Scope argClosure :: Int argDestroy :: Int argCallerAllocates :: Bool transfer :: Transfer

Instances

Eq Arg #
Instance details Defined in Data.GI.GIR.Arg Methods (==) :: Arg -> Arg -> Bool # (/=) :: Arg -> Arg -> Bool #
Ord Arg #
Instance details Defined in Data.GI.GIR.Arg Methods compare :: Arg -> Arg -> Ordering # (<) :: Arg -> Arg -> Bool # (<=) :: Arg -> Arg -> Bool # (>) :: Arg -> Arg -> Bool # (>=) :: Arg -> Arg -> Bool # max :: Arg -> Arg -> Arg # min :: Arg -> Arg -> Arg #
Show Arg #
Instance details Defined in Data.GI.GIR.Arg Methods showsPrec :: Int -> Arg -> ShowS # show :: Arg -> String # showList :: [Arg] -> ShowS #

data Callable #

Constructors

Callable
Fields returnType :: Maybe Type returnMayBeNull :: Bool returnTransfer :: Transfer returnDocumentation :: Documentation args :: [Arg] skipReturn :: Bool callableThrows :: Bool callableDeprecated :: Maybe DeprecationInfo callableDocumentation :: Documentation

Instances

Eq Callable #
Instance details Defined in Data.GI.GIR.Callable Methods (==) :: Callable -> Callable -> Bool # (/=) :: Callable -> Callable -> Bool #
Show Callable #
Instance details Defined in Data.GI.GIR.Callable Methods showsPrec :: Int -> Callable -> ShowS # show :: Callable -> String # showList :: [Callable] -> ShowS #

data Function #

Constructors

Function
Fields fnSymbol :: Text fnMovedTo :: Maybe Text fnCallable :: Callable

Instances

Show Function #
Instance details Defined in Data.GI.GIR.Function Methods showsPrec :: Int -> Function -> ShowS # show :: Function -> String # showList :: [Function] -> ShowS #

data Signal #

Constructors

Signal
Fields sigName :: Text sigCallable :: Callable sigDeprecated :: Maybe DeprecationInfo sigDoc :: Documentation

Instances

Eq Signal #
Instance details Defined in Data.GI.GIR.Signal Methods (==) :: Signal -> Signal -> Bool # (/=) :: Signal -> Signal -> Bool #
Show Signal #
Instance details Defined in Data.GI.GIR.Signal Methods showsPrec :: Int -> Signal -> ShowS # show :: Signal -> String # showList :: [Signal] -> ShowS #

data Property #

Constructors

Property
Fields propName :: Text propType :: Type propFlags :: [PropertyFlag] propReadNullable :: Maybe Bool propWriteNullable :: Maybe Bool propTransfer :: Transfer propDoc :: Documentation propDeprecated :: Maybe DeprecationInfo

Instances

Eq Property #
Instance details Defined in Data.GI.GIR.Property Methods (==) :: Property -> Property -> Bool # (/=) :: Property -> Property -> Bool #
Show Property #
Instance details Defined in Data.GI.GIR.Property Methods showsPrec :: Int -> Property -> ShowS # show :: Property -> String # showList :: [Property] -> ShowS #

data Field #

Constructors

Field
Fields fieldName :: Text fieldVisible :: Bool fieldType :: Type fieldIsPointer :: Maybe Bool `Nothing` if not known. fieldCallback :: Maybe Callback fieldOffset :: Int fieldFlags :: [FieldInfoFlag] fieldDocumentation :: Documentation fieldDeprecated :: Maybe DeprecationInfo

Instances

Show Field #
Instance details Defined in Data.GI.GIR.Field Methods showsPrec :: Int -> Field -> ShowS # show :: Field -> String # showList :: [Field] -> ShowS #

data Struct #

Constructors

Struct
Fields structIsBoxed :: Bool structAllocationInfo :: AllocationInfo structTypeInit :: Maybe Text structCType :: Maybe Text structSize :: Int gtypeStructFor :: Maybe Name structIsDisguised :: Bool structFields :: [Field] structMethods :: [Method] structDeprecated :: Maybe DeprecationInfo structDocumentation :: Documentation

Instances

Show Struct #
Instance details Defined in Data.GI.GIR.Struct Methods showsPrec :: Int -> Struct -> ShowS # show :: Struct -> String # showList :: [Struct] -> ShowS #

data Callback #

Constructors

Callback
Fields cbCallable :: Callable cbCType :: Maybe Text cbDocumentation :: Documentation

Instances

Show Callback #
Instance details Defined in Data.GI.GIR.Callback Methods showsPrec :: Int -> Callback -> ShowS # show :: Callback -> String # showList :: [Callback] -> ShowS #

data Interface #

Constructors

Interface
Fields ifTypeInit :: Maybe Text ifCType :: Maybe Text ifDocumentation :: Documentation ifPrerequisites :: [Name] ifProperties :: [Property] ifSignals :: [Signal] ifMethods :: [Method] ifAllocationInfo :: AllocationInfo ifDeprecated :: Maybe DeprecationInfo

Instances

Show Interface #
Instance details Defined in Data.GI.GIR.Interface Methods showsPrec :: Int -> Interface -> ShowS # show :: Interface -> String # showList :: [Interface] -> ShowS #

data Method #

Constructors

Method
Fields methodName :: Name methodSymbol :: Text methodType :: MethodType methodMovedTo :: Maybe Text methodCallable :: Callable

Instances

Eq Method #
Instance details Defined in Data.GI.GIR.Method Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Show Method #
Instance details Defined in Data.GI.GIR.Method Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #

data Object #

Constructors

Object
Fields objParent :: Maybe Name objTypeInit :: Text objTypeName :: Text objCType :: Maybe Text objInterfaces :: [Name] objDeprecated :: Maybe DeprecationInfo objDocumentation :: Documentation objMethods :: [Method] objProperties :: [Property] objSignals :: [Signal]

Instances

Show Object #
Instance details Defined in Data.GI.GIR.Object Methods showsPrec :: Int -> Object -> ShowS # show :: Object -> String # showList :: [Object] -> ShowS #

data Enumeration #

Constructors

Enumeration
Fields enumMembers :: [EnumerationMember] enumErrorDomain :: Maybe Text enumTypeInit :: Maybe Text enumDocumentation :: Documentation enumCType :: Text enumStorageBytes :: Int Bytes used for storage of this struct. enumDeprecated :: Maybe DeprecationInfo

Instances

Show Enumeration #
Instance details Defined in Data.GI.GIR.Enum Methods showsPrec :: Int -> Enumeration -> ShowS # show :: Enumeration -> String # showList :: [Enumeration] -> ShowS #

data Flags #

Constructors

Flags Enumeration

Instances

Show Flags #
Instance details Defined in Data.GI.GIR.Flags Methods showsPrec :: Int -> Flags -> ShowS # show :: Flags -> String # showList :: [Flags] -> ShowS #

data Union #

Constructors

Union
Fields unionIsBoxed :: Bool unionAllocationInfo :: AllocationInfo unionDocumentation :: Documentation unionSize :: Int unionTypeInit :: Maybe Text unionFields :: [Field] unionMethods :: [Method] unionCType :: Maybe Text unionDeprecated :: Maybe DeprecationInfo

Instances

Show Union #
Instance details Defined in Data.GI.GIR.Union Methods showsPrec :: Int -> Union -> ShowS # show :: Union -> String # showList :: [Union] -> ShowS #