Merge pull request #11 from RougeWare/feature/hardwareModelIdentifier-parsing

Hardware model identifiers

Author: KyNorthstar

LICENSE.txt

@@ -1,165 +1,6 @@
-                  BLUE HUSKY LICENSE 1 - PUBLIC SHARE - OPUS 3
+Copyright waived in 2025 by the author, Ky.
 
-0: LAYMAN'S TERMS
-   This section is meant to explain the purpose of this license in Layman's
-terms, and should thusly never be seen as legally binding. This disclaimer does
-not apply to further sections of this license.
+Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.
 
-If you made this:
+DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.
 
- 1. This is your product and you can do what you want with it
-   a. You must make sure that if you use anyone else's stuff in it, you do so
-      with their permission, or under Fair Use
-   b. If you do include someone else's stuff, you can't claim you made that
-   c. You guarantee you're providing this product for free
- 2. You must let others do what they want with it
-   a. They still have to say you made it in the first place
-   b. You have to include this license along with your product for it to count
-   c. They have to include this license when they redistribute your product
- 3. This license is overridden by governmental laws
- 4. You're not responsible for bad things that might happen because someone
-    used your product
-
-If you got this:
-
- 1. This is not your product, and you need to respect that
-   a. If you see anyone else's stuff in it, that was put there with their
-      permission, or under Fair Use
-   b. You are guaranteed you're getting this product for free
- 2. You can do what you want with this
-   a. You still have to say who made it in the first place
-   b. You get all the freedoms in this license along with this product
-   c. You have to include this license when you redistribute this product,
-      unless the creator says otherwise
-   d. You can edit this license as long as you let other editors know,
-      especially the original author
-   e. You must make sure that if you use anyone else's stuff in it, you do so
-      with their permission, or under Fair Use
-   f. If you do include someone else's stuff, you can't claim you made that
- 3. This license is overridden by governmental laws
- 4. The original creator is not responsible for bad things that might happen
-    because you used this product
-
-
-1: DECLARATION OF COPYRIGHT
-   This Product is copyright Ben 'Ky' Leggiero (c) 2021 BH-1-PS
-
-   Ben 'Ky' Leggiero may be reached at KyLeggiero@Gmail.com
-
-
-2: DEFINITIONS
- - "License": this text.
- - "Product": the product with which this License was distributed, and any
-   assets necessary for its use.
- - "Creator": any entity or entities who originally invented the Product,
-   withstanding related and contributing parties.
- - "Licensee": any entity or entities involved in consumption of the Product.
- - "Licensor": any entity or entities involved in distribution of the Product
-   and of this License. The Creator is always a Licensor, but a Licensor is not
-   always the Creator.
-
-
-3: NOTICE OF PERMISSIONS
-   Permission is hereby granted to any entity obtaining a copy of the Product,
-to use, copy, modify, host, redistribute, sublicense, sell copies of, and/or
-otherwise handle the Product, and to permit Licensees to also do so, given the
-following conditions are obeyed:
-
- 1. The above copyright notice and this permission notice shall be included in
-    all copies and/or substantial portions of the Product.
- 2. This License shall be blatantly provided, unmodified, along with the
-    Product.
- 3. Attribution to the Creator must be blatantly stated.
-
-
-4: DECLARATION OF OWNERSHIP
-   The Creator hereby declares that everything which makes up the Product is
-the intellectual property solely of the Creator and of no other party,
-notwithstanding any intellectual property which is included under Fair Use Laws
-as described in § 5.4 of this License, or within the restrictions of the
-licenses thereof. Such intellectual property falls under § 5.1 of this License.
-
-
-5: THE RIGHTS OF THE CREATOR AND FURTHER LICENSORS
- 1. The Creator reserves no rights to any previously-established intellectual
-    property which is implicitly or explicitly owned by any other entity or
-    entities.
-   a. If any such intellectual property is contained within or bundled
-      alongside the Product, or is otherwise distributed with or appears
-      covered under this License, the Creator forfeits any and all claims on
-      said property, and said property shall not be covered by this License and
-      shall not be considered a part of the Product.
- 2. The Creator will not gain any profit through the creation or distribution
-    of the Product.
-   a. The Creator forfeits the right to request compensation for any use of the
-      Product which adheres to the restrictions described by this License.
- 3. The Creator reserves the right to freely create, edit, distribute, destroy,
-    or otherwise interact with the whole of, or any part of, the Product.
- 4. In the case that any entity other than the Creator claims to own
-    intellectual property contained within the Product and requests
-    Compensation for the use of such intellectual property, the Creator
-    reserves the right to refuse such Compensation as allowed by the following
-    legal documents:
-   a. Amendment I of the United States Constitution.
-   b. Article 19 of the Universal Declaration of Human Rights.
-   c. 17 USC § 107 - Limitations on exclusive rights: Fair use.
- 5. In cases where all of the documents listed under § 5.4 of this
-    License are not legally recognized, the Creator agrees to pay the owner of
-    the disputed intellectual property a sum which equals the proportion of the
-    prevalence that the disputed intellectual property maintains in the Product
-    out of the total sum of profits garnered by the Creator for creating the
-    Product.
- 6. The Creator reserves the right to waive any conditions of this License at
-    the Creator's discretion.
- 7. The Licensor reserves the right to edit this License at any time under the
-    terms of BH-1-PS.
-   a. The Licensor agrees to increment the Opus number of this License to
-      correspond with version changes.
-   b. The Licensor agrees to never publish two or more versions of this License
-      under the same Opus number.
-   c. The Licensor agrees to notify the License's original author of any
-      changes made to the License. If such author is not reasonably accessible,
-      the Licensor agrees to notify any known authors which have previously
-      contributed to the License.
- 8. In no way are any of the Creator's moral rights affected by this License.
-
-
-6: RIGHTS AND RESTRICTIONS OF LICENSEES AND LICENSORS ("YOU")
- 1. You maintain the following rights and restrictions:
-   a. You are free to copy, distribute and transmit the Product.
-     i. For any reuse or distribution, You must make clear to others the
-        License terms of the License.
-   b. You are free to adapt the Product.
-     i.  If You alter, transform, or build upon the Product, You may distribute
-         the resulting Product only under this License.
-     ii. If you alter, transform, or build upon this License, You must do so
-         under the terms of § 5.7 of this License.
-   c. You are free to make indirect commercial use of the Product.
-     i. You may not directly profit from distribution of the Product.
-   d. You must attribute the Product in the manner specified by the Creator (but
-      not in any way that suggests that the Creator endorses You or such use of
-      the Product).
-   e. The Creator and any Licensors or Licensees previous to You are not
-      responsible for any changes made to the Product by You, or any effects
-      arising thereof.
-   f. You can be granted special rights by the Creator as described in § 5.6 of
-      this License.
- 2. In no way are any of the following rights affected by the License:
-   a. The fair dealing or fair use rights afforded to You, or other applicable
-      copyright exceptions and limitations.
-   b. Rights another entity may have, either in the Product itself or in how
-      the Product is used, such as publicity, privacy, or repair rights.
-
-
-7: ACCORDANCE WITH THE LAW
-   The terms that make up the whole and parts of this License shall not apply
-where local, state, provincial, federal, national, or any other law prohibits
-such terms.
-
-
-8: DISCLAIMER
-   THE PRODUCT IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED. IN NO EVENT SHALL THE CREATORS, LICENSEES, OR LICENSORS BE LIABLE FOR
-ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT,
-OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE PRODUCT OR THE
-USE OR OTHER DEALINGS IN OR WITH THE PRODUCT.

Sources/Introspection/Bundle Reading.swift

@@ -2,8 +2,7 @@
 //  Bundle Reading.swift
 //  Swift-Introspection
 //
-//  Created by Ky Leggiero on 2021-07-24.
-//  Copyright Ben 'Ky' Leggiero 2021 BH-1-PS
+//  Created by Ky on 2021-07-24.
 //
 
 import Foundation

Sources/Introspection/Device Info.swift

@@ -2,8 +2,7 @@
 //  Device Info.swift
 //  Swift-Introspection
 //
-//  Created by Ky Leggiero on 2021-07-24.
-//  Copyright Ben 'Ky' Leggiero 2021 BH-1-PS
+//  Created by Ky on 2021-07-24.
 //
 
 import Foundation
@@ -25,6 +24,11 @@ public extension Introspection {
     @dynamicMemberLookup
     struct Device {
 
+        /// The device’s hardware model identifier, like `{"Mac", 14, 8}` or `{"iPhone", 18, 2}`.
+        ///
+        /// `nil` signifies that it's unknown or unimportant to the current usecase.
+        public let hardwareModelIdentifier: HardwareModelIdentifier?
+        
         /// The device's model type, like `.macPro` or `.iPhone`
         public let modelType: ModelType
 
@@ -37,11 +41,13 @@ public extension Introspection {
         /// Creates a new `Device` value
         ///
         /// - Parameters:
+        ///   - hardwareModelIdentifier: _optional_ - The device's hardware model identifier, like `{"Mac", 14, 8}` or `{"iPhone", 18, 2}`
         ///   - modelType: The device's model type, like `.macBookPro` or `.iPad`
         ///   - `class`:  _optional_ - The device's class, like `.laptop` or `.tablet`. Defaults to inferring this from the model type.
-        public init(modelType: ModelType, `class`: Class? = nil) {
+        public init(hardwareModelIdentifier: HardwareModelIdentifier? = nil, modelType: ModelType, `class`: Class? = nil) {
+            self.hardwareModelIdentifier = hardwareModelIdentifier
             self.modelType = modelType
-            self.deviceClass = `class` ?? modelType.deviceClass
+            self.deviceClass = `class` ?? modelType.deviceClass // FIXME: For some fuckin reason, Apple's latest Mac Pro isn't `"MacPro14,8"`; it's `"Mac14,8"` :/
         }
 
 
@@ -79,7 +85,7 @@ public extension Introspection.Device {
 
 public extension Introspection.Device {
 
-    /// The  current device's hardware model type, like `"MacBookPro"` or `"iPad"`
+    /// The current device's hardware model type, like `"MacBookPro"` or `"iPad"`
     ///
     /// - Note: This relies on the return value from `sysctl`. There is a chance that it will not return a value at all, in which case, the value returned from this will be `.unknown`
     @inline(__always)
@@ -94,14 +100,85 @@ public extension Introspection.Device {
         UIDevice.current.modelName
         #endif
     }
+    
+    
+    /// The hardware model identifier of the current device, like `{"Mac", 14, 8}` or `{"iPhone", 18, 2}`
+    static let hardwareModelIdentifier: HardwareModelIdentifier? = {
+        guard let identifierString = hardwareModelIdentifierString else { return nil }
+        let match = hardwareModelRegex
+            .firstMatch(in: identifierString, options: .anchored, range: NSRange(location: 0, length: identifierString.count))
+        
+        guard let typeRange = match?.range(withName: "Type"),
+              let type = identifierString[orNil: typeRange],
+              
+              let versionRange = match?.range(withName: "Version"),
+              let version = identifierString[orNil: versionRange],
+              
+              let majorVersionRange = match?.range(withName: "MajorVersion"),
+              let majorVersionString = identifierString[orNil: majorVersionRange],
+              let majorVersion = Int(majorVersionString),
+              
+              let minorVersionRange = match?.range(withName: "MinorVersion"),
+              let minorVersionString = identifierString[orNil: minorVersionRange],
+              let minorVersion = Int(minorVersionString)
+        else {
+            print("malformed hardware model identifier: \(identifierString)")
+            return nil
+        }
+        
+        return HardwareModelIdentifier(
+            type: .init(String(type)),
+            version: .init(full: String(version), major: majorVersion, minor: minorVersion)
+        )
+    }()
+    
+    
+    /// Splits something like `"MacBookAir9,1"` into the groups `"Type"` (`"MacBookAir"`), `"Version"` (`"9,1"`), `"MajorVersion"` (`"9"`), and `"MinorVersion"` (`"1"`)
+    fileprivate static let hardwareModelRegex = try! NSRegularExpression(pattern: #"^(?<Type>\w+?)(?<Version>(?<MajorVersion>\d+),(?<MinorVersion>\d+))$"#, options: [])
+    
+    
+    
+    /// Models the components of a hardware model identifier. So `"MacBookAir9,1"` would split into `{type: "MacBookAir", version: {full: "9,1", major: 9, minor: 1}}`
+    public struct HardwareModelIdentifier: Hashable {
+        
+        /// The "type" portion of the hardware model identifier, like `"MacBookAir"` or `"iPhone"`
+        public let type: ModelType
+        
+        /// A breakdown of the "version" portion of the model identifier
+        public let version: Version
+        
+        
+        
+        /// A breakdown of the "version" portion of a model identifier. In `"MacBookAir9,1"`, this would be the `9,1` part
+        public struct Version: Hashable {
+            
+            /// The raw "version" portion of the model identifier. For `"MacBookAir9,1"`, this would be `"9,1"`
+            public let full: String
+            
+            /// The "major version" portion of the model identifier. For `"iPhone18,2"`, this would be `18`
+            public let major: Int
+            
+            /// The "minor version" portion of the model identifier. For `"iPad13,2"`, this would be `2`
+            public let minor: Int
+        }
+    }
+}
+
+
+
+public extension Introspection.Device.HardwareModelIdentifier {
+    /// The hardware model identifier of the current device, like `{"Mac", 14, 8}` or `{"iPhone", 18, 2}`
+    static var current: Self? {
+        Introspection.Device.hardwareModelIdentifier
+    }
 }
 
 
 
 public extension Introspection.Device.ModelType {
 
 
-    /// The  current device's hardware model type, like `"MacBookPro"` or `"iPad"`
+    /// The current device's hardware model type, like `"MacBookPro"` or `"iPad"`
     ///
     /// - Note: This relies on the return value from `sysctl`. There is a chance that it will not return a value at all, in which case, the value returned from this will be `.unknown`
     static var current: Self {
@@ -110,21 +187,17 @@ public extension Introspection.Device.ModelType {
         }
 
         guard
-            let matchRange = hardwareModelRegex
+            let typeRange = Introspection.Device.hardwareModelRegex
                 .firstMatch(in: identifier, options: .anchored, range: NSRange(location: 0, length: identifier.count))?
                 .range(withName: "Type"),
-            let type = identifier[orNil: matchRange]
+            let type = identifier[orNil: typeRange]
         else {
             // Not an Apple-format identifier; just return the string itself
             return .init(identifier)
         }
 
         return .init(.init(type))
     }
-    
-    
-    /// Splits something like `"MacBookAir9,1"` into the groups `"Type"` (`"MacBookAir"`), `"Version"` (`"9,1"`), `"MajorVersion"` (`"9"`), and `"MinorVersion"` (`"1"`)
-    private static let hardwareModelRegex = try! NSRegularExpression(pattern: #"^(?<Type>\w+?)(?<Version>(?<MajorVersion>\d+),(?<MinorVersion>\d+))$"#, options: [])
 }
 
 
@@ -134,7 +207,12 @@ public extension Introspection.Device.ModelType {
 public extension Introspection.Device {
 
     /// The current device
-    static var current: Self { self.init(modelType: .current) }
+    static var current: Self {
+        self.init(
+            hardwareModelIdentifier: .current,
+            modelType: .current
+        )
+    }
 
 
     // There's a bug in the Swift compiler that makes this impossible, so I have to enumerate them by-hand:
@@ -377,21 +455,17 @@ public extension Introspection.Device.ModelType {
 private func sysctl(category: CInt, value: CInt) -> String? {
     var mib = [category, value]
 
-    var len = size_t()
-    var rstring: String?
-    
-    sysctl(&mib, 2, nil, &len, nil, 0 )
-    let mallocated = malloc( len )
-    defer {
-        free(&rstring )
-        rstring = nil
-    }
+    var len: size_t = 0
+    let getSizeResult = sysctl(&mib, 2, nil, &len, nil, 0)
+    guard getSizeResult == 0, len > 0 else { return nil }
 
-    rstring = mallocated?.load(as: String.self)
+    let buffer = UnsafeMutablePointer<CChar>.allocate(capacity: len)
+    defer { buffer.deallocate() }
 
-    sysctl(&mib, 2, &rstring, &len, nil, 0 )
+    let getResult = sysctl(&mib, 2, buffer, &len, nil, 0)
+    guard getResult == 0 else { return nil }
 
-    return rstring
+    return String(validatingUTF8: buffer)
 }
 
 

Sources/Introspection/Introspection.swift

@@ -2,8 +2,7 @@
 //  Introspection.swift
 //  Swift-Introspection
 //
-//  Created by Ky Leggiero on 2021-07-24.
-//  Copyright Ben 'Ky' Leggiero 2021 BH-1-PS
+//  Created by Ky on 2021-07-24.
 //
 
 import Foundation