Merge pull request #145 from orchetect/object-properties

API Unification for Object Properties
orchetect · Oct 27, 2022 · 5fb631b · 5fb631b
2 parents a4f0424 + 710f5b2
commit 5fb631b
Show file tree

Hide file tree

Showing 95 changed files with 1,646 additions and 1,317 deletions.
diff --git a/Examples/Advanced/MIDISystemInfo/MIDISystemInfo/ContentView.swift b/Examples/Advanced/MIDISystemInfo/MIDISystemInfo/ContentView.swift
@@ -53,7 +53,7 @@ struct ContentView: View {
                             }
 
                             Group {
-                                if let nsImg = item.getImageAsNSImage() {
+                                if let nsImg = item.imageAsNSImage {
                                     Image(nsImage: nsImg)
                                         .resizable()
                                 } else {
@@ -76,14 +76,14 @@ struct ContentView: View {
                     // filter out endpoints that have an entity because
                     // they are already being displayed in the Devices tree
                     let items = midiManager.endpoints.inputs.sortedByName()
-                        .filter { $0.getEntity() == nil }
+                        .filter { $0.entity == nil }
 
                     ForEach(items) { item in
                         let detailsView = DetailsView(object: item.asAnyMIDIIOObject())
 
                         NavigationLink(destination: detailsView) {
                             Group {
-                                if let nsImg = item.getImageAsNSImage() {
+                                if let nsImg = item.imageAsNSImage {
                                     Image(nsImage: nsImg)
                                         .resizable()
                                 } else {
@@ -101,14 +101,14 @@ struct ContentView: View {
                     // filter out endpoints that have an entity because
                     // they are already being displayed in the Devices tree
                     let items = midiManager.endpoints.outputs.sortedByName()
-                        .filter { $0.getEntity() == nil }
+                        .filter { $0.entity == nil }
 
                     ForEach(items) { item in
                         let detailsView = DetailsView(object: item.asAnyMIDIIOObject())
 
                         NavigationLink(destination: detailsView) {
                             Group {
-                                if let nsImg = item.getImageAsNSImage() {
+                                if let nsImg = item.imageAsNSImage {
                                     Image(nsImage: nsImg)
                                         .resizable()
                                 } else {

diff --git a/Examples/Advanced/MIDISystemInfo/MIDISystemInfo/DetailsView.swift b/Examples/Advanced/MIDISystemInfo/MIDISystemInfo/DetailsView.swift
@@ -31,7 +31,7 @@ struct DetailsView: View {
     @State private var showAll: Bool = false
 
     func generateHTML(_ endpoint: AnyMIDIIOObject) -> String {
-        let flatProperties = endpoint.getPropertiesAsStrings(onlyIncludeRelevant: !showAll)
+        let flatProperties = endpoint.propertiesAsStrings(onlyIncludeRelevant: !showAll)
 
         let htmlStart = """
             <HTML>

diff --git a/...MIDIKit/MIDIKit.docc/MIDIKitControlSurfaces/MIDIKitControlSurfaces-Internals.md b/...MIDIKit/MIDIKit.docc/MIDIKitControlSurfaces/MIDIKitControlSurfaces-Internals.md
@@ -17,14 +17,14 @@
 
 ### HUI Strings and Characters
 
-- ``HUICharacterProtocol``
-- ``HUIStringProtocol``
+- ``HUICharacter``
+- ``HUIString``
 - ``HUIStringCharsValidation``
 - ``HUILargeDisplaySlices``
 
 ### Protocols
 
-- ``HUIDecoderProtocol``
-- ``HUIEventProtocol``
+- ``HUIDecoder``
+- ``HUIEvent``
 - ``HUISwitchProtocol``
-- ``HUISurfaceStateProtocol``
+- ``HUISurfaceModelState``
diff --git a/Sources/MIDIKit/MIDIKit.docc/MIDIKitCore/MIDIKitCore-Internals.md b/Sources/MIDIKit/MIDIKit.docc/MIDIKitCore/MIDIKitCore-Internals.md
@@ -12,7 +12,3 @@
 ### Value Type Protocols
 
 - ``MIDIUnsignedInteger``
-
-### Deprecated
-
-- ``MIDI``
diff --git a/Sources/MIDIKit/MIDIKit.docc/MIDIKitIO/MIDIKitIO-Internals.md b/Sources/MIDIKit/MIDIKit.docc/MIDIKitIO/MIDIKitIO-Internals.md
@@ -56,13 +56,12 @@
 - ``MIDIIOObjectType``
 - ``AnyMIDIIOObject``
 
-- ``MIDIIOEndpointProtocol``
-- ``MIDIIODevicesProtocol``
-- ``MIDIIOEndpointsProtocol``
-- ``MIDIIOManagedProtocol``
-- ``MIDIIOReceivesMIDIMessagesProtocol``
-- ``MIDIIOSendsMIDIMessagesProtocol``
-- ``MIDIIOReceiveHandlerProtocol``
+- ``MIDIEndpoint``
+- ``MIDIDevicesProtocol``
+- ``MIDIEndpointsProtocol``
+- ``MIDIManaged``
+- ``MIDIManagedReceivesMessages``
+- ``MIDIManagedSendsMessages``
 
 ### Value Type Protocols
 

diff --git a/Sources/MIDIKit/MIDIKit.docc/MIDIKitIO/MIDIKitIO-Sending-MIDI-Events.md b/Sources/MIDIKit/MIDIKit.docc/MIDIKitIO/MIDIKitIO-Sending-MIDI-Events.md
@@ -10,7 +10,7 @@ In order to begin sending MIDI events, there are two primary mechanisms:
 
 ### Send events from a created Output
 
-To send events, call the ``MIDIIOSendsMIDIMessagesProtocol/send(event:)`` method on the ``MIDIManager/managedOutputs`` dictionary.
+To send events, call the ``MIDIManagedSendsMessages/send(event:)`` method on the ``MIDIManager/managedOutputs`` dictionary.
 
 The dictionary key corresponds to the `tag` property that was specified at the time of creating the connection in the ``MIDIManager``.
 
@@ -21,7 +21,7 @@ try conn?.send(event: .noteOn(60, velocity: .midi1(127), channel: 0x2))
 
 ### Send events from a managed Output Connection
 
-To send events, call the ``MIDIIOSendsMIDIMessagesProtocol/send(event:)`` method on the ``MIDIManager/managedOutputConnections`` dictionary.
+To send events, call the ``MIDIManagedSendsMessages/send(event:)`` method on the ``MIDIManager/managedOutputConnections`` dictionary.
 
 The dictionary key corresponds to the `tag` property that was specified at the time of creating the connection in the ``MIDIManager``.
 
@@ -34,8 +34,8 @@ try conn?.send(event: .noteOn(60, velocity: .midi1(127), channel: 0x2))
 
 ### Send Methods
 
-- ``MIDIIOSendsMIDIMessagesProtocol/send(event:)``
-- ``MIDIIOSendsMIDIMessagesProtocol/send(events:)``
+- ``MIDIManagedSendsMessages/send(event:)``
+- ``MIDIManagedSendsMessages/send(events:)``
 
 ### Protocols
 

diff --git a/Sources/MIDIKit/MIDIKit.docc/MIDIKitIO/MIDIManager-Creating-Ports.md b/Sources/MIDIKit/MIDIKit.docc/MIDIKitIO/MIDIManager-Creating-Ports.md
@@ -75,7 +75,7 @@ try midiManager.addOutput(
 
 For the `uniqueID:` parameter it is best to use ``MIDIIdentifierPersistence/userDefaultsManaged(key:suite:)`` which automatically manages the endpoint's Core MIDI identity and restores it each time the same virtual endpoint is created, which other applications rely on to uniquely identify your endpoint so that they can reconnect to it in future.
 
-To send events, call the ``MIDIIOSendsMIDIMessagesProtocol/send(event:)`` method on the ``MIDIManager/managedOutputs`` dictionary in the ``MIDIManager`` instance.
+To send events, call the ``MIDIManagedSendsMessages/send(event:)`` method on the ``MIDIManager/managedOutputs`` dictionary in the ``MIDIManager`` instance.
 
 ```swift
 let output = midiManager.managedOutputs[outputTag]

diff --git a/...and LED Tables/HUICharacterProtocol.swift → ...aracter and LED Tables/HUICharacter.swift b/...and LED Tables/HUICharacterProtocol.swift → ...aracter and LED Tables/HUICharacter.swift
@@ -1,12 +1,12 @@
 //
-//  HUICharacterProtocol.swift
+//  HUICharacter.swift
 //  MIDIKit • https://github.com/orchetect/MIDIKit
 //  © 2021-2022 Steffan Andrews • Licensed under MIT License
 //
 
 import Foundation
 
-public protocol HUICharacterProtocol: CustomStringConvertible
+public protocol HUICharacter: CustomStringConvertible
 where Self: RawRepresentable, RawValue == UInt8, Self: CaseIterable {
     /// Returns the user-facing display string of the character.
     var string: String { get }
@@ -21,15 +21,15 @@ where Self: RawRepresentable, RawValue == UInt8, Self: CaseIterable {
     static func unknown() -> Self
 }
 
-internal protocol _HUICharacterProtocol: HUICharacterProtocol {
+internal protocol _HUICharacter: HUICharacter {
     /// Internal:
     /// Table of characters. Array index corresponds to raw HUI encoding value.
     static var stringTable: [String] { get }
 }
 
 // MARK: - Default Implementation
 
-extension _HUICharacterProtocol {
+extension _HUICharacter {
     /// Returns the user-facing display string of the character.
     public var string: String {
         Self.stringTable[Int(rawValue)]
@@ -45,15 +45,15 @@ extension _HUICharacterProtocol {
 
 // MARK: - CustomStringConvertible
 
-extension HUICharacterProtocol /* : CustomStringConvertible */ {
+extension HUICharacter /* : CustomStringConvertible */ {
     public var description: String {
         string
     }
 }
 
 // MARK: - Sequence Category Methods
 
-extension RangeReplaceableCollection where Element: HUICharacterProtocol {
+extension RangeReplaceableCollection where Element: HUICharacter {
     /// Returns the HUI character sequence as a single concatenated string of characters.
     public var stringValue: String {
         map { $0.string }.joined()

diff --git a/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUILargeDisplayCharacter.swift b/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUILargeDisplayCharacter.swift
@@ -176,7 +176,7 @@ public enum HUILargeDisplayCharacter: UInt8, CaseIterable {
     case leftArrow = 0x7F
 }
 
-extension HUILargeDisplayCharacter: _HUICharacterProtocol {
+extension HUILargeDisplayCharacter: _HUICharacter {
     // swiftformat:options --wrapcollections preserve
     // swiftformat:options --maxwidth none
     static let stringTable = [
@@ -215,7 +215,7 @@ extension HUILargeDisplayCharacter: _HUICharacterProtocol {
     ]
 }
 
-extension HUILargeDisplayCharacter: HUICharacterProtocol {
+extension HUILargeDisplayCharacter: HUICharacter {
     /// Suitable default case for use as a default/neutral character.
     public static func `default`() -> Self {
         .space

diff --git a/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUILargeDisplayString.swift b/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUILargeDisplayString.swift
@@ -8,7 +8,7 @@ import Foundation
 import MIDIKitCore
 
 /// HUI large text display 40-character string.
-public struct HUILargeDisplayString: HUIStringProtocol, Equatable, Hashable {
+public struct HUILargeDisplayString: HUIString, Equatable, Hashable {
     public typealias Element = HUILargeDisplayCharacter
 
     public static let staticCount = 40

diff --git a/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUISmallDisplayCharacter.swift b/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUISmallDisplayCharacter.swift
@@ -165,7 +165,7 @@ public enum HUISmallDisplayCharacter: UInt8, CaseIterable {
     case shadedSquare = 0x7F
 }
 
-extension HUISmallDisplayCharacter: _HUICharacterProtocol {
+extension HUISmallDisplayCharacter: _HUICharacter {
     static let stringTable = [
         "ì",  "↑",  "→",  "↓",  "←",  "¿",  "à",  "Ø", // 0x00 ...
         "ø",  "ò",  "ù",  "Ň",  "Ç",  "ê",  "É",  "é", //      ... 0x0F
@@ -186,7 +186,7 @@ extension HUISmallDisplayCharacter: _HUICharacterProtocol {
     ]
 }
 
-extension HUISmallDisplayCharacter: HUICharacterProtocol {
+extension HUISmallDisplayCharacter: HUICharacter {
     public static func `default`() -> Self {
         .space
     }

diff --git a/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUISmallDisplayString.swift b/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUISmallDisplayString.swift
@@ -7,7 +7,7 @@
 import Foundation
 
 /// HUI small text display 4-character string.
-public struct HUISmallDisplayString: HUIStringProtocol, Equatable, Hashable {
+public struct HUISmallDisplayString: HUIString, Equatable, Hashable {
     public typealias Element = HUISmallDisplayCharacter
 
     public static let staticCount = 4

diff --git a/...er and LED Tables/HUIStringProtocol.swift → .../Character and LED Tables/HUIString.swift b/...er and LED Tables/HUIStringProtocol.swift → .../Character and LED Tables/HUIString.swift
@@ -1,16 +1,16 @@
 //
-//  HUIStringProtocol.swift
+//  HUIString.swift
 //  MIDIKit • https://github.com/orchetect/MIDIKit
 //  © 2021-2022 Steffan Andrews • Licensed under MIT License
 //
 
 import Foundation
 
-public protocol HUIStringProtocol: CustomStringConvertible
+public protocol HUIString: CustomStringConvertible
     where Self: Equatable & Hashable,
     Element: Equatable & Hashable
 {
-    associatedtype Element: HUICharacterProtocol
+    associatedtype Element: HUICharacter
     static var defaultChars: [Element] { get }
 
     /// Fixed (static) char length for the string.
@@ -38,7 +38,7 @@ public protocol HUIStringProtocol: CustomStringConvertible
 
 // MARK: - Default Implementation
 
-extension HUIStringProtocol {
+extension HUIString {
     public static var defaultChars: [Element] {
         .init(
             repeating: .default(),
@@ -67,23 +67,23 @@ extension HUIStringProtocol {
 
 // MARK: - CustomStringConvertible
 
-extension HUIStringProtocol /* : CustomStringConvertible */ {
+extension HUIString /* : CustomStringConvertible */ {
     public var description: String {
         stringValue
     }
 }
 
 // MARK: - Equatable
 
-extension HUIStringProtocol /* : Equatable */ {
+extension HUIString /* : Equatable */ {
     public static func == (lhs: Self, rhs: Self) -> Bool {
         lhs.chars == rhs.chars
     }
 }
 
 // MARK: - Hashable
 
-extension HUIStringProtocol /* : Hashable */ {
+extension HUIString /* : Hashable */ {
     public func hash(into hasher: inout Hasher) {
         hasher.combine(chars)
     }
@@ -92,7 +92,7 @@ extension HUIStringProtocol /* : Hashable */ {
 // MARK: - Validation PropertyWrapper
 
 @propertyWrapper
-public struct HUIStringCharsValidation<Str: HUIStringProtocol> {
+public struct HUIStringCharsValidation<Str: HUIString> {
     private var value: [Str.Element]
 
     public var wrappedValue: [Str.Element] {
@@ -117,7 +117,7 @@ public struct HUIStringCharsValidation<Str: HUIStringProtocol> {
 
 /// Utility:
 /// Pads/truncates char array to static char length.
-func pad<S: HUIStringProtocol>(
+func pad<S: HUIString>(
     chars: [S.Element],
     for stringType: S.Type
 ) -> [S.Element] {

diff --git a/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUITimeDisplayCharacter.swift b/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUITimeDisplayCharacter.swift
@@ -73,7 +73,7 @@ public enum HUITimeDisplayCharacter: UInt8, CaseIterable {
     case spaceDot    = 0x30
 }
 
-extension HUITimeDisplayCharacter: _HUICharacterProtocol {
+extension HUITimeDisplayCharacter: _HUICharacter {
     // swiftformat:options --wrapcollections preserve
     // swiftformat:options --maxwidth none
 
@@ -96,7 +96,7 @@ extension HUITimeDisplayCharacter: _HUICharacterProtocol {
     ]
 }
 
-extension HUITimeDisplayCharacter: HUICharacterProtocol {
+extension HUITimeDisplayCharacter: HUICharacter {
     public static func `default`() -> Self {
         .space
     }

diff --git a/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUITimeDisplayString.swift b/Sources/MIDIKitControlSurfaces/HUI/Character and LED Tables/HUITimeDisplayString.swift
@@ -11,7 +11,7 @@ import Foundation
 /// The time display consists of eight 7-segment displays (called digits).
 /// Every digit except the last (rightmost) has the ability
 /// to show a trailing decimal point (dot).
-public struct HUITimeDisplayString: HUIStringProtocol, Equatable, Hashable {
+public struct HUITimeDisplayString: HUIString, Equatable, Hashable {
     public typealias Element = HUITimeDisplayCharacter
 
     public static let staticCount = 8