Documentation Language: Swift

MTL

Essentials

Getting Started with MTL
Understanding MTL

Execution

C MTLExecutionContext
Pr MTLGenerationStrategy
- Instance Methods
  - M func createWriter(url: String, mode: MTLOpenMode, charset: String, indentation: MTLIndentation) async throws -> MTLWriter
  - M func finalizeWriter(MTLWriter) async throws

Module Structure

S MTLModule
- Operators
  - static func == (MTLModule, MTLModule) -> Bool
- Initializers
  - M init(name: String, metamodels: OrderedDictionary<String, EPackage>, extends: String?, imports: [String], templates: OrderedDictionary<String, MTLTemplate>, queries: OrderedDictionary<String, MTLQuery>, macros: OrderedDictionary<String, MTLMacro>, encoding: String)
- Instance Properties
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLTemplate
- Initializers
  - M init(name: String, visibility: MTLVisibility, parameters: [MTLVariable], guard: MTLExpression?, post: MTLExpression?, body: MTLBlock, isMain: Bool, overrides: String?, documentation: String?)
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLQuery
- Initializers
  - M init(name: String, visibility: MTLVisibility, parameters: [MTLVariable], returnType: String, body: MTLExpression, documentation: String?)
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Template Elements

S MTLBlock
- Operators
  - static func == (MTLBlock, MTLBlock) -> Bool
- Initializers
  - M init(statements: [any MTLStatement], inlined: Bool)
- Instance Properties
  - P let inlined: Bool
  - P let statements: [any MTLStatement]
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Protected Regions

C MTLProtectedAreaManager
- Structures
  - S MTLProtectedAreaManager.ProtectedAreaContent
    - Initializers
      - M init(id: String, content: String, startMarker: String, endMarker: String)
    - Instance Properties
      - P let content: String
      - P let endMarker: String
      - P let id: String
      - P let startMarker: String
    - Default Implementations
      - Equatable Implementations
        
        Operators
        
        static func != (Self, Self) -> Bool
- Initializers
  - M init()
- Instance Methods
- Default Implementations
  - Actor Implementations
    - Instance Methods

Parsing

C MTLParser
- Initializers
  - M init(enableDebugging: Bool)
- Instance Methods
  - M func parse(URL) async throws -> MTLModule
  - M func parse(String, filename: String) async throws -> MTLModule
- Default Implementations
  - Actor Implementations
    - Instance Methods

Errors

E MTLExecutionError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties
E MTLParseError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties

Classes

C MTLFileSystemStrategy
- Initializers
  - M init(basePath: String)
- Instance Methods
  - M func createWriter(url: String, mode: MTLOpenMode, charset: String, indentation: MTLIndentation) async throws -> MTLWriter
  - M func finalizeWriter(MTLWriter) async throws
- Default Implementations
  - Actor Implementations
    - Instance Methods
C MTLGenerator
C MTLInMemoryStrategy
- Initializers
  - M init()
- Instance Methods
- Default Implementations
  - Actor Implementations
    - Instance Methods
C MTLWriter
- Initializers
  - M init(indentation: MTLIndentation)
- Instance Properties
  - P var indentation: MTLIndentation
- Instance Methods
- Default Implementations
  - Actor Implementations
    - Instance Methods

Protocols

Pr MTLStatement
- Instance Properties
  - P var multiLines: Bool
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws

Structures

S MTLBinding
- Initializers
  - M init(variable: MTLVariable, initExpression: MTLExpression)
- Instance Properties
  - P let initExpression: MTLExpression
  - P let variable: MTLVariable
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLComment
- Initializers
  - M init(value: String, multiLines: Bool)
- Instance Properties
  - P let multiLines: Bool
  - P let value: String
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLExpression
- Operators
  - static func == (MTLExpression, MTLExpression) -> Bool
- Initializers
  - M init(any AQLExpression)
- Instance Properties
  - P let aqlExpression: any AQLExpression
- Instance Methods
  - M func evaluate(in: MTLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLExpressionStatement
- Initializers
  - M init(expression: MTLExpression, multiLines: Bool, newLineNeeded: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLFileStatement
- Initializers
  - M init(url: MTLExpression, mode: MTLOpenMode, charset: MTLExpression?, body: MTLBlock, multiLines: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLForStatement
- Initializers
  - M init(binding: MTLBinding, separator: MTLExpression?, body: MTLBlock, multiLines: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLGenerationStatistics
- Instance Properties
- Instance Methods
  - M func reset()
  - M func summary() -> String
S MTLIfStatement
- Operators
  - static func == (MTLIfStatement, MTLIfStatement) -> Bool
- Initializers
  - M init(condition: MTLExpression, thenBlock: MTLBlock, elseIfBlocks: [(MTLExpression, MTLBlock)], elseBlock: MTLBlock?, multiLines: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLIndentation
- Initializers
  - M init(level: Int, indentString: String)
- Instance Properties
- Instance Methods
  - M func decrement() -> MTLIndentation
  - M func increment() -> MTLIndentation
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLLetStatement
- Initializers
  - M init(variables: [MTLBinding], body: MTLBlock, multiLines: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLMacro
- Initializers
  - M init(name: String, parameters: [MTLVariable], bodyParameter: String?, body: MTLBlock, documentation: String?)
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLMacroInvocation
- Initializers
  - M init(macroName: String, arguments: [MTLExpression], bodyContent: MTLBlock?, multiLines: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLNewLineStatement
- Initializers
  - M init(indentationNeeded: Bool, multiLines: Bool, newLineNeeded: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLProtectedArea
- Initializers
  - M init(id: MTLExpression, startTagPrefix: MTLExpression?, endTagPrefix: MTLExpression?, body: MTLBlock, multiLines: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLTextStatement
- Initializers
  - M init(value: String, multiLines: Bool, newLineNeeded: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLTrace
- Initializers
  - M init(sourceExpression: MTLExpression, body: MTLBlock, multiLines: Bool)
- Instance Properties
- Instance Methods
  - M func execute(in: MTLExecutionContext) async throws
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLTraceLink
- Initializers
  - M init(sourceElement: EUUID, targetFile: String, targetRange: Range<Int>, timestamp: Date)
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S MTLVariable
- Initializers
  - M init(name: String, type: String)
- Instance Properties
  - P let name: String
  - P let type: String
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Enumerations

E MTLOpenMode
- Enumeration Cases
  - E case append
  - E case create
  - E case overwrite
- Initializers
  - M init?(rawValue: String)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Initializers
      - M init(from: any Decoder) throws
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func encode(to: any Encoder) throws
      - M func hash(into: inout Hasher)
E MTLResourceError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties
E MTLVisibility
- Enumeration Cases
  - E case `private`
  - E case protected
  - E case `public`
- Initializers
  - M init?(rawValue: String)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Initializers
      - M init(from: any Decoder) throws
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func encode(to: any Encoder) throws
      - M func hash(into: inout Hasher)

/

MTL / MTLParseError

Case

MTLParseError.invalidSyntax(_:)

Invalid MTL syntax was encountered.

case invalidSyntax(String)

Parameters

String: A description of the syntax error.

swift-docc-static by René Hexel