File: CanonicalOptions.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (47 lines) | stat: -rw-r--r-- 2,083 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/// A type representing a `canonopt` values supplied to currently-executing
/// `canon lift` or `canon lower`.
/// > Note:
/// <https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#runtime-state>
public struct CanonicalOptions {
    /// A type of string encoding used in the Component Model.
    public enum StringEncoding {
        /// UTF-8
        case utf8
        /// UTF-16
        case utf16
        /// Dynamic encoding of Latin-1 or UTF-16
        case latin1OrUTF16
    }

    /// The memory address used for lifting or lowering operations.
    public let memory: MemoryAddress
    /// The string encoding used for lifting or lowering string values.
    public let stringEncoding: StringEncoding
    /// The realloc function address used for lifting or lowering values.
    public let realloc: Function?
    /// The function address called when a lifted/lowered function returns.
    public let postReturn: Function?

    public init(
        memory: MemoryAddress, stringEncoding: StringEncoding,
        realloc: Function?, postReturn: Function?
    ) {
        self.memory = memory
        self.stringEncoding = stringEncoding
        self.realloc = realloc
        self.postReturn = postReturn
    }

    /// FIXME: This deriviation is wrong because the options should be determined by `(canon lift)` or `(canon lower)`
    /// in an encoded component at componetizing-time. (e.g. wit-component tool is one of the componetizers)
    /// Remove this temporary method after we will accept binary form of component file.
    public static func _derive(from moduleInstance: ModuleInstance, exportName: String) -> CanonicalOptions {
        guard case let .memory(memory) = moduleInstance.exports["memory"] else {
            fatalError("Missing required \"memory\" export")
        }
        return CanonicalOptions(
            memory: memory, stringEncoding: .utf8,
            realloc: moduleInstance.exportedFunction(name: "cabi_realloc"),
            postReturn: moduleInstance.exportedFunction(name: "cabi_post_\(exportName)"))
    }
}