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
• type GIRPath = [GIRNodeSpec]
• data GIRNodeSpec
  • = GIRNamed Text
  • | GIRType Text
  • | GIRTypedName Text Text
• data Name = Name {
  • namespace :: Text
  • name :: Text
  }
• data Transfer
  • = TransferNothing
  • | TransferContainer
  • | TransferEverything
• data Direction
  • = DirectionIn
  • | DirectionOut
  • | DirectionInout
• data Scope
  • = ScopeTypeInvalid
  • | ScopeTypeCall
  • | ScopeTypeAsync
  • | ScopeTypeNotified
• deprecatedPragma :: Text -> Maybe DeprecationInfo -> Text
• data DeprecationInfo
• data PropertyFlag
  • = PropertyReadable
  • | PropertyWritable
  • | PropertyConstruct
  • | PropertyConstructOnly
• data MethodType
  • = Constructor
  • | MemberFunction
  • | OrdinaryMethod
• data Constant = Constant {
  • constantType :: Type
  • constantValue :: Text
  • constantDeprecated :: Maybe DeprecationInfo
  }
• data Arg = Arg {
  • argCName :: Text
  • argType :: Type
  • direction :: Direction
  • mayBeNull :: Bool
  • argScope :: Scope
  • argClosure :: Int
  • argDestroy :: Int
  • argCallerAllocates :: Bool
  • transfer :: Transfer
  }
• data Callable = Callable {
  • returnType :: Maybe Type
  • returnMayBeNull :: Bool
  • returnTransfer :: Transfer
  • args :: [Arg]
  • skipReturn :: Bool
  • callableDeprecated :: Maybe DeprecationInfo
  }
• data Function = Function {
  • fnSymbol :: Text
  • fnThrows :: Bool
  • fnMovedTo :: Maybe Text
  • fnCallable :: Callable
  }
• data Signal = Signal {
  • sigName :: Text
  • sigCallable :: Callable
  • sigDeprecated :: Maybe DeprecationInfo
  }
• data Property = Property {
  • propName :: Text
  • propType :: Type
  • propFlags :: [PropertyFlag]
  • propReadNullable :: Maybe Bool
  • propWriteNullable :: Maybe Bool
  • propTransfer :: Transfer
  • propDeprecated :: Maybe DeprecationInfo
  }
• data Field = Field {
  • fieldName :: Text
  • fieldVisible :: Bool
  • fieldType :: Type
  • fieldCallback :: Maybe Callback
  • fieldOffset :: Int
  • fieldFlags :: [FieldInfoFlag]
  • fieldDeprecated :: Maybe DeprecationInfo
  }
• data Struct = Struct {
  • structIsBoxed :: Bool
  • structTypeInit :: Maybe Text
  • structSize :: Int
  • gtypeStructFor :: Maybe Name
  • structIsDisguised :: Bool
  • structFields :: [Field]
  • structMethods :: [Method]
  • structDeprecated :: Maybe DeprecationInfo
  • structDocumentation :: Maybe Documentation
  }
• data Callback = Callback Callable
• data Interface = Interface {
  • ifTypeInit :: Maybe Text
  • ifPrerequisites :: [Name]
  • ifProperties :: [Property]
  • ifSignals :: [Signal]
  • ifMethods :: [Method]
  • ifDeprecated :: Maybe DeprecationInfo
  }
• data Method = Method {
  • methodName :: Name
  • methodSymbol :: Text
  • methodThrows :: Bool
  • methodType :: MethodType
  • methodMovedTo :: Maybe Text
  • methodCallable :: Callable
  }
• data Object = Object {
  • objParent :: Maybe Name
  • objTypeInit :: Text
  • objTypeName :: Text
  • objInterfaces :: [Name]
  • objDeprecated :: Maybe DeprecationInfo
  • objDocumentation :: Maybe Documentation
  • objMethods :: [Method]
  • objProperties :: [Property]
  • objSignals :: [Signal]
  }
• data Enumeration = Enumeration {
  • enumValues :: [(Text, Int64)]
  • errorDomain :: Maybe Text
  • enumTypeInit :: Maybe Text
  • enumStorageBytes :: Int
  • enumDeprecated :: Maybe DeprecationInfo
  }
• data Flags = Flags Enumeration
• data Union = Union {
  • unionIsBoxed :: Bool
  • unionSize :: Int
  • unionTypeInit :: Maybe Text
  • unionFields :: [Field]
  • unionMethods :: [Method]
  • unionDeprecated :: Maybe DeprecationInfo
  }

Documentation