Functions

The following functions are available globally.

get_opt(_:)
Wrapper for POSIX getopt() to return a Swift tuple. Returns nil if the getopt() returned -1, otherwise returns a tuple of the option character with an optional argument
Declaration
Swift

public func get_opt(_ options: String) -> (Character, String?)?
Show on GitHub

getterSetterPairs(for:)
return setter/getter pairs from a list of methods
Declaration
Swift

public func getterSetterPairs(for allMethods: [GIR.Method]) -> [GetterSetterPair]
Show on GitHub
commentCode(_:indentation:)
SwiftDoc representation of comments
Declaration
Swift

public func commentCode(_ thing: GIR.Thing, indentation: String = "") -> String
Show on GitHub
deprecatedCode(_:indentation:)
Swift representation of deprecation
Declaration
Swift

public func deprecatedCode(_ thing: GIR.Thing, indentation: String) -> String?
Show on GitHub


                    
                    
                    swiftCode(_:_:indentation:)

Swift code representation with code following the comments

Declaration

Swift

public func swiftCode(_ thing: GIR.Thing, _ postfix: String = "", indentation: String = "") -> String

Show on GitHub

swiftCode(alias:)
Swift code representation of a type alias
Declaration
Swift

public func swiftCode(alias: GIR.Alias) -> String
Show on GitHub
swiftCallbackAliasCode(callback:)
Swift code representation of a callback as a type alias
Declaration
Swift

public func swiftCallbackAliasCode(callback: GIR.Callback) -> String
Show on GitHub
swiftCode(constant:)
Swift code representation of a constant
Declaration
Swift

public func swiftCode(constant: GIR.Constant) -> String
Show on GitHub
typeAlias(_:)
Swift code type alias representation of an enum
Declaration
Swift

public func typeAlias(_ e: GIR.Enumeration) -> String
Show on GitHub
swiftCode(_:)
Swift code representation of an enum
Declaration
Swift

public func swiftCode(_ e: GIR.Enumeration) -> String
Show on GitHub


                    
                    
                    valueCode(_:)

Swift code representation of an enum value

Declaration

Swift

public func valueCode(_ indentation: String) -> (GIR.Enumeration.Member) -> String

Show on GitHub

recordProtocolCode(_:parent:indentation:ptr:)
Swift protocol representation of a record/class as a wrapper of a pointer
Declaration
Swift

public func recordProtocolCode(_ e: GIR.Record, parent: String, indentation: String = " ", ptr: String = "ptr") -> String
Show on GitHub


                    
                    
                    recordProtocolExtensionCode(_:_:indentation:ptr:)

Default implementation for record methods as protocol extension

Declaration

Swift

public func recordProtocolExtensionCode(_ globalFunctions: [GIR.Function], _ e: GIR.Record, indentation: String = "    ", ptr ptrName: String = "ptr") -> String

Show on GitHub


                    
                    
                    functionCode(_:indentation:initialIndentation:)

Default implementation for functions

Declaration

Swift

public func functionCode(_ f: GIR.Function, indentation: String = "    ", initialIndentation i: String = "") -> String

Show on GitHub


                    
                    
                    methodCode(_:initialIndentation:record:publicDesignation:convertName:ptr:)

Swift code for methods (with a given indentation)

Declaration

Swift

public func methodCode(_ indentation: String, initialIndentation: String? = nil, record: GIR.Record? = nil, publicDesignation: String = "public ", convertName: @escaping (String) -> String = { $0.camelCase }, ptr ptrName: String = "ptr") -> (GIR.Method) -> String

Show on GitHub


                    
                    
                    computedPropertyCode(_:record:publicDesignation:ptr:)

Swift code for computed properties

Declaration

Swift

public func computedPropertyCode(_ indentation: String, record: GIR.Record, publicDesignation: String = "public ", ptr ptrName: String = "ptr") -> (GetterSetterPair) -> String

Show on GitHub


                    
                    
                    convenienceConstructorCode(_:indentation:convenience:publicDesignation:factory:convertName:)

Swift code for convenience constructors

Declaration

Swift

public func convenienceConstructorCode(_ typeName: String, indentation: String, convenience: String = "", publicDesignation: String = "public ", factory: Bool = false, convertName: @escaping (String) -> String = { $0.camelCase }) -> (GIR.Record) -> (GIR.Method) -> String

Show on GitHub


                    
                    
                    returnTypeCode(_:)

Return the return type of a method,

Declaration

Swift

public func returnTypeCode(_ tr: (typeName: String, record: GIR.Record, isConstructor: Bool)? = nil) -> (GIR.Method) -> String?

Show on GitHub


                    
                    
                    returnDeclarationCode(_:)

Return code declaration for functions/methods/convenience constructors

Declaration

Swift

public func returnDeclarationCode(_ tr: (typeName: String, record: GIR.Record, isConstructor: Bool)? = nil) -> (GIR.Method) -> String

Show on GitHub


                    
                    
                    returnCode(_:_:ptr:)

Return code for functions/methods/convenience constructors

Declaration

Swift

public func returnCode(_ indentation: String, _ tr: (typeName: String, record: GIR.Record, isConstructor: Bool, isConvenience: Bool)? = nil, ptr: String = "ptr") -> (GIR.Method) -> String

Show on GitHub


                    
                    
                    callCode(_:_:ptr:)

Swift code for calling the underlying function and assigning the raw return value

Declaration

Swift

public func callCode(_ indentation: String, _ record: GIR.Record? = nil, ptr: String = "ptr") -> (GIR.Method) -> String

Show on GitHub


                    
                    
                    callSetter(_:_:ptr:)

Swift code for calling the underlying setter function and assigning the raw return value

Declaration

Swift

public func callSetter(_ indentation: String, _ record: GIR.Record? = nil, ptr ptrName: String = "ptr") -> (GIR.Method) -> String

Show on GitHub

constructorParam(_:prefix:)
Swift code for the parameters of a constructor
Declaration
Swift

public func constructorParam(_ method: GIR.Method, prefix: String?) -> String
Show on GitHub
constructorPrefix(_:)
Swift code for constructor first argument prefix extracted from a method name
Declaration
Swift

public func constructorPrefix(_ method: GIR.Method) -> String?
Show on GitHub
codeFor(argument:)
Swift code for auto-prefixed arguments
Declaration
Swift

public func codeFor(argument a: GIR.Argument) -> String
Show on GitHub


                    
                    
                    codeFor(argument:prefix:)

Swift code for methods

Declaration

Swift

public func codeFor(argument a: GIR.Argument, prefix: String) -> String

Show on GitHub

toSwift(_:ptr:)
Swift code for passing an argument to a free standing function
Declaration
Swift

public func toSwift(_ arg: GIR.Argument, ptr: String = "ptr") -> String
Show on GitHub
convertSetterArgumentToSwiftFor(_:ptr:)
Swift code for passing a setter to a method of a record / class
Declaration
Swift

public func convertSetterArgumentToSwiftFor(_ record: GIR.Record?, ptr: String = "ptr") -> (GIR.Argument) -> String
Show on GitHub


                    
                    
                    signalNameCode(indentation:convertName:)

Swift code for signal names without prefixes

Declaration

Swift

public func signalNameCode(indentation indent: String, convertName: @escaping (String) -> String = { $0.camelSignal }) -> (GIR.CType) -> String

Show on GitHub


                    
                    
                    signalNameCode(indentation:prefixes:convertName:)

Swift code for signal names with prefixes

Declaration

Swift

public func signalNameCode(indentation indent: String, prefixes: (String, String), convertName: @escaping (String) -> String = { $0.camelSignalComponent }) -> (GIR.CType) -> String

Show on GitHub

recordStructCode(_:indentation:ptr:)
Swift struct representation of a record/class as a wrapper of a pointer
Declaration
Swift

public func recordStructCode(_ e: GIR.Record, indentation: String = " ", ptr: String = "ptr") -> String
Show on GitHub
recordClassCode(_:parent:indentation:ptr:)
Swift struct representation of a record/class as a wrapper of a pointer
Declaration
Swift

public func recordClassCode(_ e: GIR.Record, parent: String, indentation: String = " ", ptr: String = "ptr") -> String
Show on GitHub


                    
                    
                    swiftCode(_:)

Swift code representation of a record

Declaration

Swift

public func swiftCode(_ funcs: [GIR.Function]) -> (String) -> (GIR.Record) -> String

Show on GitHub

swiftCode(_:)
Swift code representation of a free standing function
Declaration
Swift

public func swiftCode(_ f: GIR.Function) -> String
Show on GitHub


                    
                    
                    ==(_:_:)

Comparator to check whether two Things are equal

Declaration

Swift

public func == (lhs: GIR.Thing, rhs: GIR.Thing) -> Bool

Parameters

`lhs`	`Thing` to compare
`rhs`	`Thing` to compare with

Show on GitHub


                    
                    
                    <(_:_:)

Comparator to check the ordering of two Things

Declaration

Swift

public func < (lhs: GIR.Thing, rhs: GIR.Thing) -> Bool

Parameters

`lhs`	first `Thing` to compare
`rhs`	second `Thing` to compare

Show on GitHub


                    
                    
                    gtkDoc2SwiftDoc(_:linePrefix:)

Convert the given String to SwiftDoc

Declaration

Swift

public func gtkDoc2SwiftDoc(_ gtkDoc: String, linePrefix: String = "/// ") -> String

Parameters

`gtkDoc`	String in `gtk-doc` format
`linePrefix`	string to prefix each line with (e.g. indentation and/or ///)

Return Value

String in SwiftDoc format

Show on GitHub


                    
                    
                    with_mmap(_:protection:flags:process:)

memory map the given file with the given protection and flags, then call the process function with the memory address of the mapped file

Declaration

Swift

public func with_mmap(_ file: String, protection: Int32 = PROT_READ, flags: Int32 = MAP_PRIVATE, process: (UnsafeMutableRawPointer, Int) -> Void)

Parameters

`file`	Name of the file to `open()` and `mmap()`
`protection`	memory protection flags to use
`flags`	memory mapping flags to use
`process`	callback for processing the content of the file while memory mapped

Show on GitHub


                    
                    
                    with_mmap(_:protection:flags:process:)

memory map the given file to an unsafe buffer pointer then call the process function with the memory address of the mapped file

Declaration

Swift

public func with_mmap<Element>(_ file: String, protection p: Int32 = PROT_READ, flags f: Int32 = MAP_PRIVATE, process: (UnsafeBufferPointer<Element>) -> Void)

Parameters

`file`	Name of the file to `open()` and `mmap()` to memory pointing to the given `Element` type
`p`	memory protection flags to use
`f`	memory mapping flags to use
`process`	callback for processing the content of the file while memory mapped and bound to `Element`

Show on GitHub