Skip to content

Commit c4f6a35

Browse files
leogdionleogdion
committed
Working Options sample
1 parent a60ab4e commit c4f6a35

9 files changed

Lines changed: 1048 additions & 5 deletions

File tree

‎Macros/Options/Sources/OptionsMacros/OptionsMacro.swift‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ public struct OptionsMacro: ExtensionMacro, PeerMacro {
104104
)
105105
))
106106
}
107+
107108
let mappedValuesDecl = VariableDeclSyntax(
108109
modifiers: DeclModifierListSyntax {
109110
DeclModifierSyntax(name: .keyword(.static, trailingTrivia: .space))
@@ -160,7 +161,34 @@ public struct OptionsMacro: ExtensionMacro, PeerMacro {
160161
memberBlock: memberBlock
161162
)
162163

163-
return [extDecl]
164+
//return [extDecl]
165+
166+
// NOTE: Once SyntaxKit is properly added as a dependency, this could be simplified to:
167+
168+
let mappedValuesVariable: Variable
169+
if hasRawValues {
170+
let keyValues: [Int: String] = caseElements.reduce(into: [:]) { (result, element) in
171+
guard let rawValue = element.rawValue?.value.as(IntegerLiteralExprSyntax.self)?.literal.text,
172+
let key = Int(rawValue) else {
173+
return
174+
}
175+
result[key] = element.name.trimmed.text
176+
}
177+
mappedValuesVariable = Variable(.let, name: "mappedValues", equals: keyValues).static()
178+
} else {
179+
let caseNames: [String] = caseElements.map { element in
180+
element.name.trimmed.text
181+
}
182+
mappedValuesVariable = Variable(.let, name: "mappedValues", equals: caseNames).static()
183+
}
184+
185+
let extensionDecl = Extension(typeName.trimmed.text) {
186+
TypeAlias("MappedType", equals: "String")
187+
mappedValuesVariable
188+
}.inherits("MappedValueRepresentable", "MappedValueRepresented")
189+
190+
return [extensionDecl.syntax.as(ExtensionDeclSyntax.self)!]
191+
164192
}
165193

166194
public static func expansion(of node: SwiftSyntax.AttributeSyntax, providingPeersOf declaration: some SwiftSyntax.DeclSyntaxProtocol, in context: some SwiftSyntaxMacros.MacroExpansionContext) throws -> [SwiftSyntax.DeclSyntax] {

‎Sources/SyntaxKit/Extension.swift‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
//
2+
// Extension.swift
3+
// SyntaxKit
4+
//
5+
// Created by Leo Dion.
6+
// Copyright © 2025 BrightDigit.
7+
//
8+
// Permission is hereby granted, free of charge, to any person
9+
// obtaining a copy of this software and associated documentation
10+
// files (the "Software"), to deal in the Software without
11+
// restriction, including without limitation the rights to use,
12+
// copy, modify, merge, publish, distribute, sublicense, and/or
13+
// sell copies of the Software, and to permit persons to whom the
14+
// Software is furnished to do so, subject to the following
15+
// conditions:
16+
//
17+
// The above copyright notice and this permission notice shall be
18+
// included in all copies or substantial portions of the Software.
19+
//
20+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21+
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
22+
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23+
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
24+
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
25+
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26+
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27+
// OTHER DEALINGS IN THE SOFTWARE.
28+
//
29+
30+
import SwiftSyntax
31+
32+
/// A Swift `extension` declaration.
33+
public struct Extension: CodeBlock {
34+
private let extendedType: String
35+
private let members: [CodeBlock]
36+
private var inheritance: [String] = []
37+
38+
/// Creates an `extension` declaration.
39+
/// - Parameters:
40+
/// - extendedType: The name of the type being extended.
41+
/// - content: A ``CodeBlockBuilder`` that provides the members of the extension.
42+
public init(_ extendedType: String, @CodeBlockBuilderResult _ content: () -> [CodeBlock]) {
43+
self.extendedType = extendedType
44+
self.members = content()
45+
}
46+
47+
/// Sets the inheritance for the extension.
48+
/// - Parameter types: The types to inherit from.
49+
/// - Returns: A copy of the extension with the inheritance set.
50+
public func inherits(_ types: String...) -> Self {
51+
var copy = self
52+
copy.inheritance = types
53+
return copy
54+
}
55+
56+
public var syntax: SyntaxProtocol {
57+
let extensionKeyword = TokenSyntax.keyword(.extension, trailingTrivia: .space)
58+
let identifier = TokenSyntax.identifier(extendedType, trailingTrivia: .space)
59+
60+
var inheritanceClause: InheritanceClauseSyntax?
61+
if !inheritance.isEmpty {
62+
let inheritedTypes = inheritance.map { type in
63+
InheritedTypeSyntax(type: IdentifierTypeSyntax(name: .identifier(type)))
64+
}
65+
inheritanceClause = InheritanceClauseSyntax(
66+
colon: .colonToken(),
67+
inheritedTypes: InheritedTypeListSyntax(
68+
inheritedTypes.enumerated().map { idx, inherited in
69+
var type = inherited
70+
if idx < inheritedTypes.count - 1 {
71+
type = type.with(\.trailingComma, TokenSyntax.commaToken(trailingTrivia: .space))
72+
}
73+
return type
74+
}
75+
)
76+
)
77+
}
78+
79+
let memberBlock = MemberBlockSyntax(
80+
leftBrace: .leftBraceToken(leadingTrivia: .space, trailingTrivia: .newline),
81+
members: MemberBlockItemListSyntax(
82+
members.compactMap { member in
83+
guard let syntax = member.syntax.as(DeclSyntax.self) else { return nil }
84+
return MemberBlockItemSyntax(decl: syntax, trailingTrivia: .newline)
85+
}),
86+
rightBrace: .rightBraceToken(leadingTrivia: .newline)
87+
)
88+
89+
return ExtensionDeclSyntax(
90+
extensionKeyword: extensionKeyword,
91+
extendedType: IdentifierTypeSyntax(name: identifier),
92+
inheritanceClause: inheritanceClause,
93+
memberBlock: memberBlock
94+
)
95+
}
96+
}

‎Sources/SyntaxKit/Literal.swift‎

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//
88
// Permission is hereby granted, free of charge, to any person
99
// obtaining a copy of this software and associated documentation
10-
// files (the “Software”), to deal in the Software without
10+
// files (the "Software"), to deal in the Software without
1111
// restriction, including without limitation the rights to use,
1212
// copy, modify, merge, publish, distribute, sublicense, and/or
1313
// sell copies of the Software, and to permit persons to whom the
@@ -17,7 +17,7 @@
1717
// The above copyright notice and this permission notice shall be
1818
// included in all copies or substantial portions of the Software.
1919
//
20-
// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
20+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
2121
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
2222
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
2323
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
@@ -29,6 +29,15 @@
2929

3030
import SwiftSyntax
3131

32+
/// A protocol for types that can be represented as literal values in Swift code.
33+
public protocol LiteralValue {
34+
/// The Swift type name for this literal value.
35+
var typeName: String { get }
36+
37+
/// Renders this value as a Swift literal string.
38+
var literalString: String { get }
39+
}
40+
3241
/// A literal value.
3342
public enum Literal: CodeBlock {
3443
/// A string literal.
@@ -64,3 +73,41 @@ public enum Literal: CodeBlock {
6473
}
6574
}
6675
}
76+
77+
// MARK: - LiteralValue Implementations
78+
79+
extension Array: LiteralValue where Element == String {
80+
public var typeName: String { "[String]" }
81+
82+
public var literalString: String {
83+
let elements = self.map { element in
84+
// Escape quotes and newlines
85+
let escaped = element
86+
.replacingOccurrences(of: "\\", with: "\\\\")
87+
.replacingOccurrences(of: "\"", with: "\\\"")
88+
.replacingOccurrences(of: "\n", with: "\\n")
89+
.replacingOccurrences(of: "\r", with: "\\r")
90+
.replacingOccurrences(of: "\t", with: "\\t")
91+
return "\"\(escaped)\""
92+
}.joined(separator: ", ")
93+
return "[\(elements)]"
94+
}
95+
}
96+
97+
extension Dictionary: LiteralValue where Key == Int, Value == String {
98+
public var typeName: String { "[Int: String]" }
99+
100+
public var literalString: String {
101+
let elements = self.map { key, value in
102+
// Escape quotes and newlines
103+
let escaped = value
104+
.replacingOccurrences(of: "\\", with: "\\\\")
105+
.replacingOccurrences(of: "\"", with: "\\\"")
106+
.replacingOccurrences(of: "\n", with: "\\n")
107+
.replacingOccurrences(of: "\r", with: "\\r")
108+
.replacingOccurrences(of: "\t", with: "\\t")
109+
return "\(key): \"\(escaped)\""
110+
}.joined(separator: ", ")
111+
return "[\(elements)]"
112+
}
113+
}

‎Sources/SyntaxKit/Variable.swift‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//
88
// Permission is hereby granted, free of charge, to any person
99
// obtaining a copy of this software and associated documentation
10-
// files (the “Software”), to deal in the Software without
10+
// files (the "Software"), to deal in the Software without
1111
// restriction, including without limitation the rights to use,
1212
// copy, modify, merge, publish, distribute, sublicense, and/or
1313
// sell copies of the Software, and to permit persons to whom the
@@ -17,7 +17,7 @@
1717
// The above copyright notice and this permission notice shall be
1818
// included in all copies or substantial portions of the Software.
1919
//
20-
// THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
20+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
2121
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
2222
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
2323
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
@@ -35,6 +35,7 @@ public struct Variable: CodeBlock {
3535
private let name: String
3636
private let type: String
3737
private let defaultValue: String?
38+
private var isStatic: Bool = false
3839

3940
/// Creates a `let` or `var` declaration with an explicit type.
4041
/// - Parameters:
@@ -49,6 +50,26 @@ public struct Variable: CodeBlock {
4950
self.type = type
5051
self.defaultValue = defaultValue
5152
}
53+
54+
/// Creates a `let` or `var` declaration with a literal value.
55+
/// - Parameters:
56+
/// - kind: The kind of variable, either ``VariableKind/let`` or ``VariableKind/var``.
57+
/// - name: The name of the variable.
58+
/// - value: A literal value that conforms to ``LiteralValue``.
59+
public init<T: LiteralValue>(_ kind: VariableKind, name: String, equals value: T) {
60+
self.kind = kind
61+
self.name = name
62+
self.type = value.typeName
63+
self.defaultValue = value.literalString
64+
}
65+
66+
/// Marks the variable as `static`.
67+
/// - Returns: A copy of the variable marked as `static`.
68+
public func `static`() -> Self {
69+
var copy = self
70+
copy.isStatic = true
71+
return copy
72+
}
5273

5374
public var syntax: SyntaxProtocol {
5475
let bindingKeyword = TokenSyntax.keyword(kind == .let ? .let : .var, trailingTrivia: .space)
@@ -64,8 +85,16 @@ public struct Variable: CodeBlock {
6485
value: ExprSyntax(DeclReferenceExprSyntax(baseName: .identifier(value)))
6586
)
6687
}
88+
89+
var modifiers: DeclModifierListSyntax = []
90+
if isStatic {
91+
modifiers = DeclModifierListSyntax([
92+
DeclModifierSyntax(name: .keyword(.static, trailingTrivia: .space))
93+
])
94+
}
6795

6896
return VariableDeclSyntax(
97+
modifiers: modifiers,
6998
bindingSpecifier: bindingKeyword,
7099
bindings: PatternBindingListSyntax([
71100
PatternBindingSyntax(

0 commit comments

Comments
 (0)