Skip to content

Commit f923f83

Browse files
oscbysprooscbyspro
committed
Cleanup n' comments.
1 parent 2805a7b commit f923f83

File tree

3 files changed

+42
-41
lines changed

3 files changed

+42
-41
lines changed

‎Sources/DiffableTextKit/DiffableTextStyle+Nullable.swift‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,34 @@
1111
// MARK: * Style x Nullable
1212
//*============================================================================*
1313

14+
/// This protocol formalizes the implementation of optional values.
15+
///
16+
/// Wrapper styles may not know how to support optionality without also knowing
17+
/// the details of the styles they wrap. As a result, it makes sense to support
18+
/// both standard and optional values and let wrappers pick the implementation.
19+
///
1420
public protocol NullableTextStyle<Value>: DiffableTextStyle {
1521

1622
//=------------------------------------------------------------------------=
1723
// MARK: Utilities
1824
//=------------------------------------------------------------------------=
1925

26+
/// Returns formatted text.
27+
///
28+
/// A wrapper may use this method.
29+
///
2030
@inlinable func format(optional value: Value?, with cache: inout Cache) -> String
2131

32+
/// Returns an optional value and a snapshot describing it.
33+
///
34+
/// A wrapper may use this method.
35+
///
2236
@inlinable func interpret(optional value: Value?, with cache: inout Cache) -> Commit<Value?>
2337

38+
/// Returns an optional value and a snapshot describing it.
39+
///
40+
/// A wrapper may use this method.
41+
///
2442
@inlinable func resolve(optional proposal: Proposal, with cache: inout Cache) throws -> Commit<Value?>
2543
}
2644

‎Sources/DiffableTextKit/Utilities/Brrr.swift‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,13 @@ public struct Brrr: Equatable {
2828

2929
//=------------------------------------------------------------------------=
3030

31-
@inlinable @inline(__always)
32-
public init(_ context: @autoclosure () -> String) {
31+
@inlinable @inline(__always) public init(_ context: @autoclosure () -> String) {
3332
#if DEBUG
3433
self.context = context()
3534
#endif
3635
}
3736

38-
@inlinable @inline(__always)
39-
public static func << (brrr: Self, message: @autoclosure () -> Any) {
37+
@inlinable @inline(__always) public static func << (brrr: Self, message: @autoclosure () -> Any) {
4038
#if DEBUG
4139
Swift.print(brrr.context, message())
4240
#endif

‎Sources/DiffableTextKit/Utilities/Info.swift‎

Lines changed: 22 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
///
1818
@resultBuilder public struct Info: CustomStringConvertible, Error, Equatable,
1919
ExpressibleByStringInterpolation, ExpressibleByStringLiteral {
20+
2021
public static let unknown = "[REDACTED]"
2122
public static let separator = "\u{0020}"
2223

@@ -32,8 +33,7 @@ ExpressibleByStringInterpolation, ExpressibleByStringLiteral {
3233
// MARK: Initializers
3334
//=------------------------------------------------------------------------=
3435

35-
@inlinable @inline(__always)
36-
init(_ content: @autoclosure () -> [String] = []) {
36+
@inlinable @inline(__always) init(_ content: @autoclosure () -> [String] = []) {
3737
#if DEBUG
3838
self.content = content()
3939
#endif
@@ -43,61 +43,47 @@ ExpressibleByStringInterpolation, ExpressibleByStringLiteral {
4343
// MARK: Initializers
4444
//=------------------------------------------------------------------------=
4545

46-
@inlinable @inline(__always)
47-
public init(stringLiteral content: String) {
46+
@inlinable @inline(__always) public init(stringLiteral content: String) {
4847
self.init([content])
4948
}
5049

51-
@inlinable @inline(__always)
52-
public init(_ info: @autoclosure () -> Self) {
53-
self.init([info().description])
54-
}
55-
56-
@inlinable @inline(__always)
57-
public init(@Info _ info: () -> Self) {
50+
@inlinable @inline(__always) public init(@Info _ info: () -> Self) {
5851
self.init(info())
5952
}
6053

61-
@inlinable @inline(__always)
62-
public init(_ transform: (inout Self) -> Void) {
63-
self.init({ var info = Self(); transform(&info); return info }())
54+
@inlinable @inline(__always) public init(_ transform: (inout Self) -> Void) {
55+
self.init({ var instance = Self(); transform(&instance); return instance }())
6456
}
6557

66-
@inlinable @inline(__always)
67-
public init(_ many: @autoclosure () -> [Self]) {
68-
self.init(many().map(\.description))
58+
@inlinable @inline(__always) public init(_ error: @autoclosure () -> any Error) {
59+
self.init([String(describing: error())])
6960
}
7061

71-
@inlinable @inline(__always)
72-
public init(_ error: @autoclosure () -> any Error) {
73-
self.init([String(describing: error())])
62+
@inlinable @inline(__always) public init(_ instances: @autoclosure () -> [Self]) {
63+
self.init(instances().map(\.description))
7464
}
7565

76-
@inlinable @inline(__always)
77-
public static func buildBlock(_ instances: Self...) -> Self {
66+
@inlinable @inline(__always) public static func buildBlock(_ instances: Self...) -> Self {
7867
Self(instances)
7968
}
8069

8170
//=------------------------------------------------------------------------=
8271
// MARK: Initializers
8372
//=------------------------------------------------------------------------=
8473

85-
@inlinable @inline(__always)
86-
public static func note(_ item: @autoclosure () -> Any) -> Self {
74+
@inlinable @inline(__always) public static func note(_ item: @autoclosure () -> Any) -> Self {
8775
self.init([String(describing: item())])
8876
}
8977

90-
@inlinable @inline(__always)
91-
public static func mark(_ item: @autoclosure () -> Any) -> Self {
78+
@inlinable @inline(__always) public static func mark(_ item: @autoclosure () -> Any) -> Self {
9279
Self(["« \(item()) »"])
9380
}
9481

9582
//=------------------------------------------------------------------------=
9683
// MARK: Accessors
9784
//=------------------------------------------------------------------------=
9885

99-
@inlinable @inline(__always)
100-
public var description: String {
86+
@inlinable @inline(__always) public var description: String {
10187
#if DEBUG
10288
self.content.joined(separator: Self.separator)
10389
#else
@@ -109,8 +95,7 @@ ExpressibleByStringInterpolation, ExpressibleByStringLiteral {
10995
// MARK: Transformations
11096
//=------------------------------------------------------------------------=
11197

112-
@inlinable @inline(__always)
113-
mutating func transform(_ transform: (inout [String]) -> Void) {
98+
@inlinable @inline(__always) mutating func transform(_ transform: (inout [String]) -> Void) {
11499
#if DEBUG
115100
transform(&self.content)
116101
#endif
@@ -120,18 +105,18 @@ ExpressibleByStringInterpolation, ExpressibleByStringLiteral {
120105
// MARK: Transformations
121106
//=------------------------------------------------------------------------=
122107

123-
@inlinable @inline(__always)
124-
public mutating func join(separator: @autoclosure () -> String = Self.separator) {
108+
@inlinable @inline(__always) public mutating func join(
109+
separator: @autoclosure () -> String = Self.separator){
125110
self.transform({ $0 = [$0.joined(separator: separator())] })
126111
}
127112

128-
@inlinable @inline(__always)
129-
public func joined(separator: @autoclosure () -> String = Self.separator) -> Self {
113+
@inlinable @inline(__always) public func joined(
114+
separator: @autoclosure () -> String = Self.separator) -> Self {
130115
Self({ $0.join(separator: separator()) })
131116
}
132117

133-
@inlinable @inline(__always)
134-
public static func += (info: inout Self, other: @autoclosure () -> Self) {
135-
info.transform({ $0.append(other().description) })
118+
@inlinable @inline(__always) public static func += (
119+
instance: inout Self, other: @autoclosure () -> Self) {
120+
instance.transform({ $0.append(other().description) })
136121
}
137122
}

0 commit comments

Comments
 (0)