Safe Haskell | None |
---|---|
Language | Haskell98 |
- data API
- data GIRInfo = GIRInfo {}
- 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
- data Name = Name {}
- data Transfer
- data AllocationInfo = AllocationInfo {}
- data AllocationOp
- unknownAllocationInfo :: AllocationInfo
- data Direction
- data Scope
- deprecatedPragma :: Text -> Maybe DeprecationInfo -> Text
- data DeprecationInfo
- data PropertyFlag
- data MethodType
- data Constant = Constant {}
- data Arg = Arg {}
- data Callable = Callable {}
- data Function = Function {}
- data Signal = Signal {}
- data Property = Property {}
- data Field = Field {}
- data Struct = Struct {}
- data Callback = Callback Callable
- data Interface = Interface {
- ifTypeInit :: Maybe Text
- ifPrerequisites :: [Name]
- ifProperties :: [Property]
- ifSignals :: [Signal]
- ifMethods :: [Method]
- ifDeprecated :: Maybe DeprecationInfo
- data Method = Method {}
- 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 {}
Documentation
:: 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.
:: 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.
A rule for modifying the GIR file.
GIRSetAttr (GIRPath, Name) Text | (Path to element, attrName), newValue |
type GIRPath = [GIRNodeSpec] Source
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 Source
Node selector for a path in the GIR file.
Name for a symbol in the GIR file.
Transfer mode for an argument or property.
data AllocationInfo Source
Allocation/deallocation information for a given foreign pointer.
data AllocationOp Source
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.
unknownAllocationInfo :: AllocationInfo Source
A convenience function, filling in all the allocation info to unknown.
deprecatedPragma :: Text -> Maybe DeprecationInfo -> Text Source
Encode the given DeprecationInfo
for the given symbol as a
deprecation pragma.
data DeprecationInfo Source
Deprecation information on a symbol.
data PropertyFlag Source
data MethodType Source
Constructor | Constructs an instance of the parent type |
MemberFunction | A function in the namespace |
OrdinaryMethod | A function taking the parent instance as first argument. |
Info about a constant.
Callable | |
|
Property | |
|
Field | |
|
Interface | |
|
Method | |
|
Object | |
|
data Enumeration Source
Enumeration | |
|
Union | |
|