Adds support for GBC games

Adds System enum to represent supported game systems, simplifying the process to add future game systems.
js-john · May 1, 2017 · 9349353 · 9349353
1 parent d7db699
commit 9349353
Show file tree

Hide file tree

Showing 20 changed files with 315 additions and 215 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -10,3 +10,6 @@
 [submodule "Cores/GBADeltaCore"]
 	path = Cores/GBADeltaCore
 	url = [email protected]:rileytestut/GBADeltaCore.git
+[submodule "Cores/GBCDeltaCore"]
+	path = Cores/GBCDeltaCore
+	url = [email protected]:rileytestut/GBCDeltaCore.git
diff --git a/Cores/GBCDeltaCore b/Cores/GBCDeltaCore
diff --git a/Delta.xcodeproj/project.pbxproj b/Delta.xcodeproj/project.pbxproj
diff --git a/Delta.xcworkspace/contents.xcworkspacedata b/Delta.xcworkspace/contents.xcworkspacedata
diff --git a/Delta/AppDelegate.swift b/Delta/AppDelegate.swift
@@ -9,8 +9,6 @@
 import UIKit
 
 import DeltaCore
-import SNESDeltaCore
-import GBADeltaCore
 
 @UIApplicationMain
 class AppDelegate: UIResponder, UIApplicationDelegate
@@ -21,8 +19,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate
     {
         Settings.registerDefaults()
 
-        Delta.register(SNES.core)
-        Delta.register(GBA.core)
+        System.supportedSystems.forEach { Delta.register($0.deltaCore) }
 
         self.configureAppearance()
 
@@ -92,8 +89,7 @@ extension AppDelegate
     {
         guard url.isFileURL else { return false }
 
-        let gameType = GameType.gameType(forFileExtension: url.pathExtension)
-        if gameType != .unknown || url.pathExtension.lowercased() == "zip"
+        if GameType(fileExtension: url.pathExtension) != nil || url.pathExtension.lowercased() == "zip"
         {
             return self.importGame(at: url)
         }

diff --git a/Delta/Components/Importing/ImportController.swift b/Delta/Components/Importing/ImportController.swift
@@ -40,7 +40,7 @@ class ImportController: NSObject
     {
         self.presentingViewController = presentingViewController
 
-        var documentTypes = GameType.supportedTypes.map { $0.rawValue }
+        var documentTypes = System.supportedSystems.map { $0.gameType.rawValue }
         documentTypes.append(kUTTypeDeltaControllerSkin as String)
         documentTypes.append(kUTTypeZipArchive as String)
 
@@ -75,7 +75,7 @@ class ImportController: NSObject
                     let controllerSkinURLs = contents.filter { $0.pathExtension.lowercased() == "deltaskin" }
                     self.importControllerSkins(at: Set(controllerSkinURLs))
 
-                    let gameURLs = contents.filter { GameType.gameType(forFileExtension: $0.pathExtension) != .unknown || $0.pathExtension.lowercased() == "zip" }
+                    let gameURLs = contents.filter { GameType(fileExtension: $0.pathExtension) != nil || $0.pathExtension.lowercased() == "zip" }
                     self.importGames(at: Set(gameURLs))
                 }
 

diff --git a/Delta/Database/DatabaseManager.swift b/Delta/Database/DatabaseManager.swift
@@ -22,6 +22,7 @@ extension DatabaseManager
     {
         case doesNotExist(URL)
         case invalid(URL)
+        case unsupported(URL)
         case unknown(URL, NSError)
         case saveFailed(Set<URL>, NSError)
 
@@ -30,8 +31,9 @@ extension DatabaseManager
             {
             case .doesNotExist: return 0
             case .invalid: return 1
-            case .unknown: return 2
-            case .saveFailed: return 3
+            case .unsupported: return 2
+            case .unknown: return 3
+            case .saveFailed: return 4
             }
         }
 
@@ -41,10 +43,12 @@ extension DatabaseManager
             {
             case (let .doesNotExist(url1), let .doesNotExist(url2)) where url1 == url2: return true
             case (let .invalid(url1), let .invalid(url2)) where url1 == url2: return true
+            case (let .unsupported(url1), let .unsupported(url2)) where url1 == url2: return true
             case (let .unknown(url1, error1), let .unknown(url2, error2)) where url1 == url2 && error1 == error2: return true
             case (let .saveFailed(urls1, error1), let .saveFailed(urls2, error2)) where urls1 == urls2 && error1 == error2: return true
             case (.doesNotExist, _): return false
             case (.invalid, _): return false
+            case (.unsupported, _): return false
             case (.unknown, _): return false
             case (.saveFailed, _): return false
             }
@@ -99,9 +103,9 @@ private extension DatabaseManager
     {
         self.performBackgroundTask { (context) in
 
-            for gameType in GameType.supportedTypes
+            for system in System.supportedSystems
             {
-                guard let deltaControllerSkin = DeltaCore.ControllerSkin.standardControllerSkin(for: gameType) else { continue }
+                guard let deltaControllerSkin = DeltaCore.ControllerSkin.standardControllerSkin(for: system.gameType) else { continue }
 
                 let controllerSkin = ControllerSkin(context: context)
                 controllerSkin.isStandard = true
@@ -173,21 +177,27 @@ extension DatabaseManager
                     continue
                 }
 
-                let identifier = FileHash.sha1HashOfFile(atPath: url.path) as String
+                guard let gameType = GameType(fileExtension: url.pathExtension), let system = System(gameType: gameType) else {
+                    errors.insert(.unsupported(url))
+                    continue
+                }
 
+                let identifier = FileHash.sha1HashOfFile(atPath: url.path) as String
                 let filename = identifier + "." + url.pathExtension
 
-                let game = Game.insertIntoManagedObjectContext(context)
+                let game = Game(context: context)
                 game.identifier = identifier
+                game.type = gameType
                 game.filename = filename
 
                 let databaseMetadata = self.gamesDatabase?.metadata(for: game)
                 game.name = databaseMetadata?.name ?? url.deletingPathExtension().lastPathComponent
                 game.artworkURL = databaseMetadata?.artworkURL
-
-                let gameCollection = GameCollection.gameSystemCollectionForPathExtension(url.pathExtension, inManagedObjectContext: context)
-                game.type = GameType(rawValue: gameCollection.identifier)
-                game.gameCollections.insert(gameCollection)
+
+                let gameCollection = GameCollection(context: context)
+                gameCollection.identifier = gameType.rawValue
+                gameCollection.index = Int16(system.year)
+                gameCollection.games.insert(game)
 
                 do
                 {
@@ -212,7 +222,6 @@ extension DatabaseManager
 
                     errors.insert(.unknown(url, error))
                 }
-
             }
 
             do
@@ -328,9 +337,8 @@ extension DatabaseManager
                         guard !entry.fileName.contains("/") else { continue }
 
                         let fileExtension = (entry.fileName as NSString).pathExtension
-                        let gameType = GameType.gameType(forFileExtension: fileExtension)
-
-                        guard gameType != .unknown else { continue }
+
+                        guard GameType(fileExtension: fileExtension) != nil else { continue }
 
                         // At least one entry is a valid game file, so we set archiveContainsValidGameFile to true
                         // This will result in this archive being considered valid, and thus we will not return an ImportError.invalid error for the archive

diff --git a/Delta/Database/Model/Human/GameCollection.swift b/Delta/Database/Model/Human/GameCollection.swift
@@ -9,48 +9,22 @@
 import CoreData
 
 import DeltaCore
-import SNESDeltaCore
-import GBADeltaCore
 
 @objc(GameCollection)
-public class GameCollection: _GameCollection 
+public class GameCollection: _GameCollection
 {
-    var name: String
-    {
-        let gameType = GameType(rawValue: self.identifier)
-        return gameType.localizedName
+    var name: String {
+        return self.system?.localizedName ?? NSLocalizedString("Unknown", comment: "")
     }
 
-    var shortName: String
-    {
-        let gameType = GameType(rawValue: self.identifier)
-        return gameType.localizedShortName
+    var shortName: String {
+        return self.system?.localizedShortName ?? NSLocalizedString("Unknown", comment: "")
     }
 
-    class func gameSystemCollectionForPathExtension(_ pathExtension: String?, inManagedObjectContext managedObjectContext: NSManagedObjectContext) -> GameCollection
-    {
-        let gameType = GameType.gameType(forFileExtension: pathExtension ?? "")
-        let identifier = gameType.rawValue
-
-        let index: Int16
-
-        switch gameType
-        {
-        case GameType.snes: index = 1990
-        case GameType.gba: index = 2001
-        default: index = Int16(INT16_MAX)
-        }
-
-        let predicate = NSPredicate(format: "%K == %@", #keyPath(GameCollection.identifier), identifier)
-
-        var gameCollection = GameCollection.instancesWithPredicate(predicate, inManagedObjectContext: managedObjectContext, type: GameCollection.self).first
-        if gameCollection == nil
-        {
-            gameCollection = GameCollection.insertIntoManagedObjectContext(managedObjectContext)
-            gameCollection?.identifier = identifier
-            gameCollection?.index = index
-        }
+    var system: System? {
+        let gameType = GameType(rawValue: self.identifier)
 
-        return gameCollection!
+        let system = System(gameType: gameType)
+        return system
     }
 }
diff --git a/Delta/Emulation/GameViewController.swift b/Delta/Emulation/GameViewController.swift
@@ -391,11 +391,11 @@ private extension GameViewController
 
     func updateControllerSkin()
     {
-        guard let game = self.game else { return }
+        guard let game = self.game, let system = System(gameType: game.type) else { return }
 
         let traits = DeltaCore.ControllerSkin.Traits.defaults(for: self.view)
 
-        let controllerSkin = Settings.preferredControllerSkin(for: game.type, traits: traits)
+        let controllerSkin = Settings.preferredControllerSkin(for: system, traits: traits)
         self.controllerView.controllerSkin = controllerSkin
 
         if controllerSkin?.isTranslucent(for: traits) ?? false
@@ -807,12 +807,12 @@ private extension GameViewController
 
         case .preferredControllerSkin:
             guard
-                let gameType = notification.userInfo?[Settings.NotificationUserInfoKey.gameType] as? GameType,
+                let system = notification.userInfo?[Settings.NotificationUserInfoKey.system] as? System,
                 let traits = notification.userInfo?[Settings.NotificationUserInfoKey.traits] as? DeltaCore.ControllerSkin.Traits
             else { return }
 
             let currentTraits = DeltaCore.ControllerSkin.Traits.defaults(for: self.view)
-            if gameType == self.game?.type && traits == currentTraits
+            if system.gameType == self.game?.type && traits == currentTraits
             {
                 self.updateControllerSkin()
             }

diff --git a/Delta/Extensions/DeltaCoreProtocol+Delta.swift b/Delta/Extensions/DeltaCoreProtocol+Delta.swift
@@ -7,15 +7,17 @@
 //
 
 import DeltaCore
-import GBADeltaCore
 
 extension DeltaCoreProtocol
 {
     var supportedRates: ClosedRange<Double> {
-        switch self.gameType
+        guard let system = System(gameType: self.gameType) else { return 1...1 }
+
+        switch system
         {
-        case GameType.gba: return 1...3
-        default: return 1...4
+        case .snes: return 1...4
+        case .gba: return 1...3
+        case .gbc: return 1...4
         }
     }
 }
diff --git a/Delta/Extensions/GameType+Delta.swift b/Delta/Extensions/GameType+Delta.swift
diff --git a/Delta/Extensions/GameType+Localization.swift b/Delta/Extensions/GameType+Localization.swift
diff --git a/Delta/Extensions/UIAlertController+Importing.swift b/Delta/Extensions/UIAlertController+Importing.swift
@@ -38,6 +38,7 @@ extension UIAlertController
             {
             case .doesNotExist(let url): urls.insert(url)
             case .invalid(let url): urls.insert(url)
+            case .unsupported(let url): urls.insert(url)
             case .unknown(let url, _): urls.insert(url)
             case .saveFailed(let errorURLs, _): urls.formUnion(errorURLs)
             }

diff --git a/Delta/Settings/Controller Skins/ControllerSkinsViewController.swift b/Delta/Settings/Controller Skins/ControllerSkinsViewController.swift
@@ -23,7 +23,7 @@ extension ControllerSkinsViewController
 
 class ControllerSkinsViewController: UITableViewController
 {
-    var gameType: GameType! {
+    var system: System! {
         didSet {
             self.updateDataSource()
         }
@@ -67,12 +67,12 @@ private extension ControllerSkinsViewController
     //MARK: - Update
     func updateDataSource()
     {
-        guard let gameType = self.gameType, let traits = self.traits else { return }
+        guard let system = self.system, let traits = self.traits else { return }
 
         let configuration = ControllerSkinConfigurations(traits: traits)
 
         let fetchRequest: NSFetchRequest<ControllerSkin> = ControllerSkin.fetchRequest()
-        fetchRequest.predicate = NSPredicate(format: "%K == %@ AND (%K & %d) == %d", #keyPath(ControllerSkin.gameType), gameType.rawValue, #keyPath(ControllerSkin.supportedConfigurations), configuration.rawValue, configuration.rawValue)
+        fetchRequest.predicate = NSPredicate(format: "%K == %@ AND (%K & %d) == %d", #keyPath(ControllerSkin.gameType), system.gameType.rawValue, #keyPath(ControllerSkin.supportedConfigurations), configuration.rawValue, configuration.rawValue)
         fetchRequest.sortDescriptors = [NSSortDescriptor(key: #keyPath(ControllerSkin.isStandard), ascending: false), NSSortDescriptor(key: #keyPath(ControllerSkin.name), ascending: true)]
 
         self.dataSource.fetchedResultsController = NSFetchedResultsController(fetchRequest: fetchRequest, managedObjectContext: DatabaseManager.shared.viewContext, sectionNameKeyPath: #keyPath(ControllerSkin.name), cacheName: nil)
@@ -159,7 +159,7 @@ extension ControllerSkinsViewController
     override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath)
     {
         let controllerSkin = self.dataSource.item(at: indexPath)
-        Settings.setPreferredControllerSkin(controllerSkin, for: self.gameType, traits: self.traits)
+        Settings.setPreferredControllerSkin(controllerSkin, for: self.system, traits: self.traits)
 
         _ = self.navigationController?.popViewController(animated: true)
     }