Cleanup

Author: oscbyspro

Sources/DiffableTextKit/Models/Attribute.swift

@@ -23,16 +23,16 @@ public struct Attribute: CustomStringConvertible, OptionSet {
     // MARK: Instances
     //=------------------------------------------------------------------------=
 
-    /// Signifies that the symbol is not real and should not be parsed.
+    /// Marks that a symbol is not real and should not be parsed.
     public static let virtual = Self(rawValue: 1 << 0)
 
-    /// Signifies that the symbol should be ignored when it is inserted.
+    /// Marks that a symbol should be ignored when inserted.
     public static let insertable = Self(rawValue: 1 << 1)
 
-    /// Signifies that the symbol should be ignored when it is removed.
+    /// Marks that a symbol should be ignored when removed.
     public static let removable = Self(rawValue: 1 << 2)
 
-    /// Signifies that the symbol has no interactive size and should be passed through.
+    /// Marks that a symbol has no real size and should be passed through.
     public static let passthrough = Self(rawValue: 1 << 3)
 
     //=------------------------------------------------------------------------=

Sources/DiffableTextKit/Models/Context.swift

@@ -263,12 +263,14 @@ extension Context {
         //=--------------------------------------=
         // Values
         //=--------------------------------------=
-        let selection  = Selection(layout!.snapshot.indices(at: selection))
+        let selection = Selection(layout!.snapshot.indices(at: selection))
         //=--------------------------------------=
         // Update
         //=--------------------------------------=
         self.unique()
-        self.storage.layout!.merge(selection: selection, momentums: momentums)
+        self.storage.layout!.merge(
+        selection: selection, /*-*/
+        momentums: momentums) /*-*/
         //=--------------------------------------=
         // Return
         //=--------------------------------------=

Sources/DiffableTextKit/Models/Status.swift

@@ -39,18 +39,15 @@ public struct Status<Style: DiffableTextStyle>: Equatable {
     // MARK: Transformations
     //=------------------------------------------------------------------------=
 
-    /// Merges member-wise inequalities.
+    /// Merges member inequalities on a case-by-case basis.
+    ///
+    /// A style marked as equals(()) will not be compared or merged.
+    ///
     @inlinable mutating func merge(_ other: Self) -> Changes {
-        let changes = (self .!= other)
-        //=--------------------------------------=
-        // Update
-        //=--------------------------------------=
-        if changes.contains(.style) { self.style = other.style }
-        if changes.contains(.value) { self.value = other.value }
-        if changes.contains(.focus) { self.focus = other.focus }
-        //=--------------------------------------=
-        // Return
-        //=--------------------------------------=
+        let changes = self .!= other
+        if  changes.contains(.style) { self.style = other.style }
+        if  changes.contains(.value) { self.value = other.value }
+        if  changes.contains(.focus) { self.focus = other.focus }
         return changes
     }
 
@@ -77,6 +74,6 @@ public struct Status<Style: DiffableTextStyle>: Equatable {
     @inlinable static func .!= (lhs: Self, rhs: Self) -> Changes {[
         .style(lhs.style != rhs.style),
         .value(lhs.value != rhs.value),
-        .focus(lhs.focus != rhs.focus),
-    ]}
+        .focus(lhs.focus != rhs.focus)]
+    }
 }

Sources/DiffableTextKit/Models/Symbol.swift

@@ -75,7 +75,7 @@ extension Sequence where Element == Symbol {
 
     /// A sequence of nonvirtual characters.
     @inlinable public func nonvirtuals() -> String {
-        String(lazy.filter({!$0.attribute.contains(.virtual)}).map({$0.character}))
+        String(lazy.nonvirtuals())
     }
 }
 

Sources/DiffableTextKit/Models/Update.swift

@@ -11,7 +11,7 @@
 // MARK: * Update [...]
 //*============================================================================*
 
-/// A message describing which remote properties need to be updated.
+/// A message describing which properties should be updated.
 @frozen public struct Update: OptionSet {
 
     public static let text      = Self(rawValue: 1 << 0)

Sources/DiffableTextKit/Utilities/Brrr.swift

@@ -8,7 +8,7 @@
 //=----------------------------------------------------------------------------=
 
 //*============================================================================*
-// MARK: * Brrr
+// MARK: * Brrr [...]
 //*============================================================================*
 
 /// A model that prints messages in DEBUG mode.
@@ -17,23 +17,15 @@
 ///
 public struct Brrr: Equatable {
 
-    //=------------------------------------------------------------------------=
-    // MARK: Instances
-    //=------------------------------------------------------------------------=
-    
     public static let cancellation   = Self("User input cancelled:")
     public static let autocorrection = Self("User input autocorrected:")
 
-    //=------------------------------------------------------------------------=
-    // MARK: State
     //=------------------------------------------------------------------------=
 
     #if DEBUG
     @usableFromInline let context: String
     #endif
 
-    //=------------------------------------------------------------------------=
-    // MARK: Initializers
     //=------------------------------------------------------------------------=
 
     @inlinable @inline(__always)
@@ -43,10 +35,6 @@ public struct Brrr: Equatable {
         #endif
     }
 
-    //=------------------------------------------------------------------------=
-    // MARK: Utilities
-    //=------------------------------------------------------------------------=
-    
     @inlinable @inline(__always)
     public static func << (brrr: Self, message: @autoclosure () -> Any) {
         #if DEBUG

Sources/DiffableTextKitXPattern/Placeholders.swift

@@ -29,11 +29,11 @@
         self.option = .none
     }
 
-    @inlinable init(_ some: (Character, Predicate)) {
+    @inlinable init(_ some: Some.Elements) {
         self.option = .some(Some(some))
     }
 
-    @inlinable init(_ many: [Character: Predicate]) {
+    @inlinable init(_ many: Many.Elements) {
         self.option = .many(Many(many))
     }
 
@@ -71,13 +71,15 @@ extension Placeholders {
 
     @usableFromInline struct Some: Equatable {
 
+        @usableFromInline typealias Elements = (Character, Predicate)
+        
         //=--------------------------------------------------------------------=
 
-        @usableFromInline let elements: (Character, Predicate)
+        @usableFromInline let elements: Elements
 
         //=--------------------------------------------------------------------=
 
-        @inlinable init(_ elements: (Character, Predicate)) {
+        @inlinable init(  _ elements: Elements) {
             self.elements = elements
         }
 
@@ -96,13 +98,15 @@ extension Placeholders {
 
     @usableFromInline struct Many: Equatable {
 
+        @usableFromInline typealias Elements = [Character: Predicate]
+        
         //=--------------------------------------------------------------------=
 
-        @usableFromInline let elements: [Character: Predicate]
+        @usableFromInline let elements: Elements
 
         //=--------------------------------------------------------------------=
 
-        @inlinable init(_ elements: [Character: Predicate]) {
+        @inlinable init(  _ elements: Elements) {
             self.elements = elements
         }
 

Sources/DiffableTextKitXPattern/Style.swift

@@ -178,20 +178,13 @@ extension PatternTextStyle {
             }
         }
     }
-}
-
-//=----------------------------------------------------------------------------=
-// MARK: + Helpers
-//=----------------------------------------------------------------------------=
-
-extension PatternTextStyle {
 
     //=------------------------------------------------------------------------=
-    // MARK: Reduce
+    // MARK: Inactive, Active, Interactive x Reduce
     //=------------------------------------------------------------------------=
 
     @inlinable @inline(never) func reduce<Content, Result>(
-    with content: Content, into result: Result,
+    with content: Content,into result: Result,
     some: (inout Result, Substring, Character) -> Void,
     none: (inout Result, Substring) -> Void,
     done: (inout Result, Substring, Content.SubSequence) throws -> Void)

Sources/DiffableTextKitXUIKit/Models/Downstream.swift

@@ -18,6 +18,7 @@ import UIKit
 //*============================================================================*
 
 @usableFromInline final class Downstream {
+    
     @usableFromInline typealias Offset = DiffableTextKit.Offset<UTF16>
 
     //=------------------------------------------------------------------------=

Sources/DiffableTextKitXUIKit/Models/Sidestream.swift

@@ -26,7 +26,7 @@ import SwiftUI
 
     @inlinable init() { }
 
-    @inlinable init(_ environment: EnvironmentValues) {
+    @inlinable init(  _ environment: EnvironmentValues) {
         self.onSubmit = environment.diffableTextViews_onSubmit
     }
 }