Documentation Language: Swift

Documentation

gir2swift

Articles

gir2swift

libgir2swift

Command and configuration

S Gir2Swift
- Initializers
  - M init()
  - M init(from: any Decoder) throws
- Instance Methods
  - M func run() throws
- Default Implementations
  - ParsableArguments Implementations
    - Instance Methods
      - M func validate() throws
    - Type Methods
  - ParsableCommand Implementations
    - Instance Methods
      - M func run() throws
    - Type Properties
      - P static var configuration: CommandConfiguration
    - Type Methods

GIR document

C GIR
- Classes
  - C GIR.Alias
    - Instance Properties
      - P var kind: String
  - C GIR.Argument
  - C GIR.Bitfield
    - Instance Properties
      - P var kind: String
    - Instance Methods
      - M func registerKnownType()
  - C GIR.CType
  - C GIR.Callback
    - Instance Properties
      - P var kind: String
  - C GIR.Class
    - Instance Properties
      - P var kind: String
      - P let parent: String
      - P var parentType: Record?
      - P var rootType: Record
  - C GIR.Constant
    - Initializers
      - M init(name: String, cname: String, type: TypeReference, value: Int, comment: String, introspectable: Bool, deprecated: String?)
      - M init(node: XMLElement, at: Int, nameAttr: String)
    - Instance Properties
      - P var kind: String
      - P let value: Int
  - C GIR.Datatype
    - Initializers
      - M init(name: String, type: TypeReference, comment: String, introspectable: Bool, deprecated: String?)
      - M init(node: XMLElement, at: Int, with: TypeReference?, nameAttr: String)
    - Instance Properties
    - Instance Methods
      - M func registerKnownType()
  - C GIR.Enumeration
    - Initializers
      - M init(name: String, type: TypeReference, members: [Member], comment: String, introspectable: Bool, deprecated: String?)
      - M init(node: XMLElement, at: Int)
    - Instance Properties
      - P var kind: String
      - P let members: [Member]
    - Instance Methods
      - M func registerKnownType()
    - Type Aliases
      - T GIR.Enumeration.Member
  - C GIR.Field
    - Initializers
      - M init(node: XMLElement, at: Int)
    - Instance Properties
      - P var containedCallback: GIR.Callback?
      - P var kind: String
  - C GIR.Function
    - Instance Properties
      - P var kind: String
  - C GIR.Interface
    - Instance Properties
      - P var kind: String
  - C GIR.Method
    - Initializers
      - M init(name: String, cname: String, returns: Argument, args: [Argument], comment: String, introspectable: Bool, deprecated: String?, throwsAnError: Bool)
      - M init(node: XMLElement, at: Int)
    - Instance Properties
      - P let args: [Argument]
      - P var isBareFactory: Bool
      - P var isDesignatedConstructor: Bool
      - P var isGetter: Bool
      - P var isRef: Bool
      - P var isSetter: Bool
      - P var isUnref: Bool
      - P var kind: String
      - P let returns: Argument
      - P let throwsError: Bool
    - Instance Methods
  - C GIR.Property
    - Instance Properties
      - P var kind: String
  - C GIR.Record
  - C GIR.Signal
    - Instance Properties
      - P var kind: String
  - C GIR.Thing
    - Operators
      - static func == (GIR.Thing, GIR.Thing) -> Bool
      - static func < (GIR.Thing, GIR.Thing) -> Bool
    - Initializers
      - M init(name: String, comment: String, introspectable: Bool, disguised: Bool, deprecated: String?, markedAsDeprecated: Bool, version: String?)
      - M init(node: XMLElement, at: Int, nameAttr: String)
    - Instance Properties
    - Instance Methods
      - M func hash(into: inout Hasher)
    - Default Implementations
      - Comparable Implementations
        
        Operators
        
        static func ... (Self) -> PartialRangeFrom<Self>
        
        static func ... (Self) -> PartialRangeThrough<Self>
        
        static func ... (Self, Self) -> ClosedRange<Self>
        
        static func ..< (Self) -> PartialRangeUpTo<Self>
        
        static func ..< (Self, Self) -> Range<Self>
        
        static func > (Self, Self) -> Bool
        
        static func >= (Self, Self) -> Bool
        
        static func <= (Self, Self) -> Bool
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
  - C GIR.Union
    - Instance Properties
      - P var kind: String
- Initializers
- Instance Properties
- Instance Methods
- Type Properties
- Type Methods
- Enumerations
  - E GIR.OwnershipTransfer
    - Enumeration Cases
      - E case container
      - E case floating
      - E case full
      - E case none
    - Initializers
      - M init?(rawValue: String)
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
      - RawRepresentable Implementations
        
        Instance Properties
        
        P var hashValue: Int
        
        Instance Methods
        
        M func hash(into: inout Hasher)
  - E GIR.ParameterDirection
    - Enumeration Cases
      - E case `in`
      - E case `inout`
      - E case out
    - Initializers
      - M init?(rawValue: String)
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
      - RawRepresentable Implementations
        
        Instance Properties
        
        P var hashValue: Int
        
        Instance Methods
        
        M func hash(into: inout Hasher)

GIR element models

C GIR.Thing
- Operators
  - static func == (GIR.Thing, GIR.Thing) -> Bool
  - static func < (GIR.Thing, GIR.Thing) -> Bool
- Initializers
  - M init(name: String, comment: String, introspectable: Bool, disguised: Bool, deprecated: String?, markedAsDeprecated: Bool, version: String?)
  - M init(node: XMLElement, at: Int, nameAttr: String)
- Instance Properties
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - Comparable Implementations
    - Operators
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
C GIR.Datatype
- Initializers
  - M init(name: String, type: TypeReference, comment: String, introspectable: Bool, deprecated: String?)
  - M init(node: XMLElement, at: Int, with: TypeReference?, nameAttr: String)
- Instance Properties
- Instance Methods
  - M func registerKnownType()
C GIR.CType
C GIR.Alias
- Instance Properties
  - P var kind: String
C GIR.Argument
C GIR.Bitfield
- Instance Properties
  - P var kind: String
- Instance Methods
  - M func registerKnownType()
C GIR.Callback
- Instance Properties
  - P var kind: String
C GIR.Class
- Instance Properties
  - P var kind: String
  - P let parent: String
  - P var parentType: Record?
  - P var rootType: Record
C GIR.Constant
- Initializers
  - M init(name: String, cname: String, type: TypeReference, value: Int, comment: String, introspectable: Bool, deprecated: String?)
  - M init(node: XMLElement, at: Int, nameAttr: String)
- Instance Properties
  - P var kind: String
  - P let value: Int
C GIR.Enumeration
- Initializers
  - M init(name: String, type: TypeReference, members: [Member], comment: String, introspectable: Bool, deprecated: String?)
  - M init(node: XMLElement, at: Int)
- Instance Properties
  - P var kind: String
  - P let members: [Member]
- Instance Methods
  - M func registerKnownType()
- Type Aliases
  - T GIR.Enumeration.Member
C GIR.Field
- Initializers
  - M init(node: XMLElement, at: Int)
- Instance Properties
  - P var containedCallback: GIR.Callback?
  - P var kind: String
C GIR.Function
- Instance Properties
  - P var kind: String
C GIR.Interface
- Instance Properties
  - P var kind: String
C GIR.Method
- Initializers
  - M init(name: String, cname: String, returns: Argument, args: [Argument], comment: String, introspectable: Bool, deprecated: String?, throwsAnError: Bool)
  - M init(node: XMLElement, at: Int)
- Instance Properties
  - P let args: [Argument]
  - P var isBareFactory: Bool
  - P var isDesignatedConstructor: Bool
  - P var isGetter: Bool
  - P var isRef: Bool
  - P var isSetter: Bool
  - P var isUnref: Bool
  - P var kind: String
  - P let returns: Argument
  - P let throwsError: Bool
- Instance Methods
C GIR.Property
- Instance Properties
  - P var kind: String
C GIR.Record
C GIR.Signal
- Instance Properties
  - P var kind: String
C GIR.Union
- Instance Properties
  - P var kind: String

Type system

C GIRType
C GIRStringType
- Instance Methods
  - M func cast(expression: String, pointerLevel: Int, const: Bool, isConstSource: Bool) -> String
C GIRRawPointerType
- Instance Methods
  - M func cast(expression: String, pointerLevel: Int, const: Bool, isConstSource: Bool) -> String
C GIRRecordType
- Instance Methods
  - M func cast(expression: String, pointerLevel: Int, const: Bool, isConstSource: Bool) -> String
C GIRGenericType
- Initializers
  - M init(name: String, containedType: GIRType, in: String, swiftName: String?, typeName: String?, ctype: String, superType: TypeReference?, isAlias: Bool, conversions: [GIRType : [TypeConversion]])
- Instance Properties
- Instance Methods
  - M func cast(expression: String, pointerLevel: Int, const: Bool, isConstSource: Bool) -> String
C GIROpaquePointerType
- Instance Methods
  - M func cast(expression: String, pointerLevel: Int, const: Bool, isConstSource: Bool) -> String
C TypeConversion
- Operators
  - static func == (TypeConversion, TypeConversion) -> Bool
- Initializers
  - M init(source: GIRType, target: GIRType)
- Instance Properties
  - P let source: GIRType
  - P let target: GIRType
- Instance Methods
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
C CastConversion
- Instance Methods
  - M func castFromTarget(expression: String) -> String
  - M func castToTarget(from: String) -> String
C StringConversion
- Instance Methods
  - M func castFromTarget(expression: String) -> String
  - M func castToTarget(from: String) -> String
C SubClassConversion
- Instance Methods
  - M func castFromTarget(expression: String) -> String
  - M func castToTarget(from: String) -> String
C OptionalSubClassConversion
- Instance Methods
  - M func castFromTarget(expression: String) -> String
C CustomConversion
- Initializers
  - M init(source: GIRType, target: GIRType, downPrefix: String, downSuffix: String, upPrefix: String, upSuffix: String)
- Instance Properties
- Instance Methods
  - M func castFromTarget(expression: String) -> String
  - M func castToTarget(from: String) -> String
C NestedConversion
- Initializers
  - M init(source: GIRType, target: GIRType, downPrefix: String, downSuffix: String, upPrefix: String, upSuffix: String, embedding: TypeConversion)
- Instance Properties
  - P var innerConversion: TypeConversion
C EnumTypeConversion
- Instance Methods
  - M func castToTarget(from: String) -> String
C BitfieldTypeConversion
C RawPointerConversion
- Instance Methods
  - M func castFromTarget(expression: String) -> String
S TypeReference
- Initializers
  - M init(type: GIRType, in: String?, identifier: String?, isConst: Bool, isOptional: Bool, isArray: Bool, constPointers: [Bool])
- Instance Properties
- Instance Methods
- Type Properties
  - P static var void: TypeReference
- Type Methods
  - M static func pointer(to: GIRType, in: String?, isConst: Bool, pointerIsConst: Bool) -> TypeReference
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Structures

S GetterSetterPair

Functions

M func bitfieldTypeHead(GIR.Bitfield, enumRawType: String, indentation: String) -> String
M func bitfieldValueCode(GIR.Bitfield, String) -> (GIR.Bitfield.Member) -> String
M func callSetter(String, GIR.Record?, ptr: String) -> (GIR.Method) -> String
M func callbackDecl(for: GIR.Callback) -> String
M func callbackParameterCode(for: GIR.Argument) -> String
M func commentCode(GIR.Thing, indentation: String) -> String
M func computedPropertyCode(String, record: GIR.Record, avoiding: Set<String>, publicDesignation: String, ptr: String) -> (GetterSetterPair) -> String
M func constantSwiftCode(indentedBy: String, scopePrefix: String) -> (GIR.Constant) -> String
M func constructorParam(GIR.Method, prefix: String?) -> String
M func constructorPrefix(GIR.Method) -> String?
M func convenienceConstructorCode(TypeReference, indentation: String, convenience: String, override: String, publicDesignation: String, factory: Bool, hasParent: Bool, shouldSink: Bool, convertName: (String) -> String) -> (GIR.Record) -> (GIR.Method) -> String
M func convertSetterArgumentToSwiftFor(GIR.Record?, ptr: String) -> (GIR.Argument) -> String
M func deprecatedCode(GIR.Thing, indentation: String) -> String?
M func fieldCode(String, record: GIR.Record, avoiding: Set<String>, publicDesignation: String, ptr: String) -> (GIR.Field) -> String
M func forceUnwrappedDecl(for: GIR.Callback) -> String
M func functionCallCode(String, GIR.Record?, constructedRecord: GIR.Record?, ptr: String, rvVar: String, doThrow: Bool, isConstructor: Bool, useStruct: Bool) -> (GIR.Method) -> String
M func functionCode(GIR.Function, indentation: String, initialIndentation: String) -> String
M func getterSetterPairs(for: [GIR.Method]) -> [GetterSetterPair]
M func gtkDoc2SwiftDoc(for: GIR.Thing, String, linePrefix: String) -> String
M func instanceReturnCode(String, (typeRef: TypeReference, record: GIR.Record, isConstructor: Bool, isConvenience: Bool)?, ptr: String, castVar: String, hasParent: Bool, forceCast: Bool, noCast: Bool, convertToSwiftTypes: Bool, useIdiomaticSwift: Bool) -> (GIR.CType) -> String
M func methodCode(String, initialIndentation: String?, record: GIR.Record?, allowConstructor: Bool, functionPrefix: String, avoiding: Set<String>, publicDesignation: String, convertName: (String) -> String, ptr: String) -> (GIR.Method) -> String
M func namespacedAliasCode(for: GIR.Datatype, prefix: String, indentation: String) -> String
M func namespacedAliasSwiftCode(prefixedWith: String, indentation: String) -> (GIR.Datatype) -> String
M func nullableRefParameterCode(for: GIR.Argument) -> String
M func prefixedNullableRefParameterCode(for: GIR.Argument, prefix: String) -> String
M func prefixedTemplatedParameterCode(for: GIR.Argument, prefix: String) -> String
M func recordClassCode(GIR.Record, parent: String, indentation: String, ptr: String) -> String
M func recordProtocolCode(GIR.Record, parent: String, indentation: String, ptr: String) -> String
M func recordProtocolExtensionCode([GIR.Function], GIR.Record, indentation: String, ptr: String) -> String
M func recordStructCode(GIR.Record, indentation: String, ptr: String) -> String
M func returnCode(String, (typeRef: TypeReference, record: GIR.Record, isConstructor: Bool, isConvenience: Bool)?, ptr: String, hasParent: Bool, useIdiomaticSwift: Bool, noCast: Bool) -> (GIR.Method) -> String
M func returnCode<T>(String, (typeRef: TypeReference, record: GIR.Record, isConstructor: Bool, isConvenience: Bool)?, ptr: String, rv: String, hasParent: Bool, forceCast: Bool, convertToSwiftTypes: Bool, useIdiomaticSwift: Bool, noCast: Bool, extract: (T) -> GIR.CType) -> (T) -> String
M func returnCode(for: GIR.Argument) -> String
M func returnCode(for: GIR.Argument, prefix: String) -> String
M func returnDeclarationCode((typeRef: TypeReference, record: GIR.Record, isConstructor: Bool)?, useStruct: Bool) -> (GIR.Method) -> String
M func returnTypeCode(for: GIR.Method, (typeRef: TypeReference, record: GIR.Record, isConstructor: Bool)?, useIdiomaticSwift: Bool, useStruct: Bool) -> String?
M func signalNameCode(indentation: String, convertName: (String) -> String) -> (GIR.CType) -> String
M func signalNameCode(indentation: String, prefixes: (String, String), convertName: (String) -> String) -> (GIR.CType) -> String
M func subRecordProperty(GIR.Record, ptr: String, GIR.Record, indentation: String, publicDesignation: String) -> String
M func subTypeAlias(GIR.Record, GIR.Record, publicDesignation: String) -> String
M func swiftCallbackAliasCode(callback: GIR.Callback) -> String
M func swiftCode(GIR.Function) -> String
M func swiftCode(GIR.Bitfield) -> String
M func swiftCode(GIR.Enumeration) -> String
M func swiftCode([GIR.Function]) -> (String) -> (GIR.Record) -> String
M func swiftCode(GIR.Thing, String, indentation: String) -> String
M func swiftCode(alias: GIR.Alias) -> String
M func swiftCode(constant: GIR.Constant) -> String
M func swiftUnionsConversion([GIR.Function]) -> (GIR.Union) -> String
M func templatedParameterCode(for: GIR.Argument) -> String
M func toSwift(GIR.Argument, ptr: String) -> String
M func typeAlias(GIR.Enumeration) -> String
M func typeAliasCode(for: GIR.Datatype, prefix: String) -> String
M func typeAliasSwiftCode(prefixedWith: String) -> (GIR.Datatype) -> String
M func typedCollection(for: String, containedTypes: [GIR.CType], unwrappedName: String, typeRef: TypeReference) -> TypeReference?
M func valueCode(String) -> (GIR.Enumeration.Member) -> String

Type Aliases

T EmptyConversion

gir2swift-plugin

/

libgir2swift / GIR / GIR.Enumeration

Type Alias

GIR.Enumeration.Member

an enumeration value in C is a constant

typealias Member = Constant

swift-docc-static by René Hexel