Quicksave

PVLibrary/PVLibrary/Domain/SaveState.swift

@@ -16,7 +16,7 @@ public protocol SaveStateInfoProvider {
     var date: Date { get }
     var lastOpened: Date? { get }
     var image: LocalFile? { get }
-    var isAutosave: Bool { get }
+    var saveType: SaveType { get }
 }
 
 public struct SaveState: SaveStateInfoProvider, Codable {
@@ -27,5 +27,5 @@ public struct SaveState: SaveStateInfoProvider, Codable {
     public let date: Date
     public let lastOpened: Date?
     public let image: LocalFile?
-    public let isAutosave: Bool
+    public let saveType: SaveType
 }

PVLibrary/PVLibrary/RealmPlatform/Entities/PVGame.swift

@@ -127,12 +127,20 @@ extension PVGame: Filed, LocalFileProvider {}
 
 public extension PVGame {
     var autoSaves: Results<PVSaveState> {
-        return saveStates.filter("isAutosave == true").sorted(byKeyPath: "date", ascending: false)
+        return saveStates.filter("saveTypeRawValue == '\(SaveType.auto.rawValue)'").sorted(byKeyPath: "date", ascending: false)
+    }
+
+    public var quickSaves : Results<PVSaveState> {
+        return saveStates.filter("saveTypeRawValue == '\(SaveType.quick.rawValue)'").sorted(byKeyPath: "date", ascending: false)
     }
 
     var newestAutoSave: PVSaveState? {
         return autoSaves.first
     }
+
+    public var newestQuickSave : PVSaveState? {
+        return quickSaves.first
+    }
 
     var lastAutosaveAge: TimeInterval? {
         guard let first = autoSaves.first else {

PVLibrary/PVLibrary/RealmPlatform/Entities/PVSaveState.swift

@@ -10,6 +10,12 @@ import Foundation
 import PVSupport
 import RealmSwift
 
+public enum SaveType: String, Codable {
+    case manual
+    case auto
+    case quick
+}
+
 public protocol Filed {
     associatedtype LocalFileProviderType: LocalFileProvider
     var file: LocalFileProviderType! { get }
@@ -29,16 +35,22 @@ public final class PVSaveState: Object, Filed, LocalFileProvider {
     public dynamic var date: Date = Date()
     public dynamic var lastOpened: Date?
     public dynamic var image: PVImageFile?
-    public dynamic var isAutosave: Bool = false
+
+    // Realm won't store enums, so we store the raw value but allow consumers to interact with the enum
+    @objc dynamic private var saveTypeRawValue: String = SaveType.manual.rawValue
+    public dynamic var saveType: SaveType {
+        get { return SaveType(rawValue: saveTypeRawValue)! }
+        set { saveTypeRawValue = newValue.rawValue }
+    }
 
     public dynamic var createdWithCoreVersion: String!
 
-    public convenience init(withGame game: PVGame, core: PVCore, file: PVFile, image: PVImageFile? = nil, isAutosave: Bool = false) {
+    public convenience init(withGame game: PVGame, core: PVCore, file: PVFile, type: SaveType = .manual, image: PVImageFile? = nil) {
         self.init()
         self.game = game
         self.file = file
         self.image = image
-        self.isAutosave = isAutosave
+        self.saveType = type
         self.core = core
         createdWithCoreVersion = core.projectVersion
     }
@@ -47,12 +59,18 @@ public final class PVSaveState: Object, Filed, LocalFileProvider {
         do {
             // Temp store these URLs
             let fileURL = state.file.url
+            let jsonFileURL = fileURL.appendingPathExtension("json")
             let imageURl = state.image?.url
 
             let database = RomDatabase.sharedInstance
             try database.delete(state)
 
             try FileManager.default.removeItem(at: fileURL)
+
+            if (FileManager.default.fileExists(atPath: jsonFileURL.absoluteString)) {
+                try FileManager.default.removeItem(at: jsonFileURL)
+            }
+
             if let imageURl = imageURl {
                 try FileManager.default.removeItem(at: imageURl)
             }
@@ -63,13 +81,23 @@ public final class PVSaveState: Object, Filed, LocalFileProvider {
     }
 
     public dynamic var isNewestAutosave: Bool {
-        guard isAutosave, let game = game, let newestSave = game.autoSaves.first else {
+        guard saveType == .auto, let game = game, let newestSave = game.autoSaves.first else {
             return false
         }
 
         let isNewest = newestSave == self
         return isNewest
     }
+
+    @objc dynamic public var isNewestQuicksave: Bool {
+        guard saveType == .quick, let game = game, let newestSave = game.quickSaves.first else {
+            return false
+        }
+
+        let isNewest = newestSave == self
+        return isNewest
+    }
+
 
     public static func == (lhs: PVSaveState, rhs: PVSaveState) -> Bool {
         return lhs.file.url == rhs.file.url
@@ -96,7 +124,8 @@ private extension SaveState {
         } else {
             image = nil
         }
-        isAutosave = saveState.isAutosave
+
+        saveType = saveState.saveType
     }
 }
 
@@ -135,7 +164,7 @@ extension SaveState: RealmRepresentable {
                 DLOG("path: \(imagePath)")
                 object.image = PVImageFile(withURL: imagePath)
             }
-            object.isAutosave = isAutosave
+            object.saveType = saveType
         }
     }
 }

PVLibrary/PVLibrary/RealmPlatform/RomDatabase.swift

@@ -11,7 +11,7 @@ import PVSupport
 import RealmSwift
 import UIKit
 
-let schemaVersion: UInt64 = 8
+let schemaVersion: UInt64 = 9
 
 public extension Notification.Name {
     static let DatabaseMigrationStarted = Notification.Name("DatabaseMigrarionStarted")
@@ -73,9 +73,12 @@ public final class RealmConfiguration {
         }
 
         let migrationBlock: MigrationBlock = { migration, oldSchemaVersion in
+            if oldSchemaVersion < schemaVersion {
+                NotificationCenter.default.post(name: NSNotification.Name.DatabaseMigrationStarted, object: nil)
+            }
+
             if oldSchemaVersion < 2 {
                 ILOG("Migrating to version 2. Adding MD5s")
-                NotificationCenter.default.post(name: NSNotification.Name.DatabaseMigrationStarted, object: nil)
 
                 var counter = 0
                 var deletions = 0
@@ -114,9 +117,25 @@ public final class RealmConfiguration {
                     newObject!["importDate"] = Date()
                 }
 
-                NotificationCenter.default.post(name: NSNotification.Name.DatabaseMigrationFinished, object: nil)
                 ILOG("Migration complete of \(counter) roms. Removed \(deletions) bad entries.")
             }
+
+            if oldSchemaVersion < 9 {
+                ILOG("Migrating to version 9. Adding support for quicksaves.")
+
+                var counter = 0
+                migration.enumerateObjects(ofType: PVSaveState.className()) { oldObject, newObject in
+                    counter += 1
+                    let isAutosave = oldObject!["isAutosave"] as! Bool
+                    newObject!["saveTypeRawValue"] = isAutosave ? SaveType.auto.rawValue : SaveType.manual.rawValue
+                }
+
+                ILOG("Migration complete of \(counter) save states.")
+            }
+
+            if oldSchemaVersion < schemaVersion {
+                NotificationCenter.default.post(name: NSNotification.Name.DatabaseMigrationFinished, object: nil)
+            }
         }
 
         #if DEBUG

PVSupport/Settings/PVSettingsModel.swift

@@ -242,6 +242,7 @@ extension MirroredSettings {
 
     public dynamic var askToAutoLoad = true
     public dynamic var autoLoadSaves = false
+    public dynamic var showQuicksaveButton = false
 
     public dynamic var disableAutoLock = false
     public dynamic var buttonVibration = true

Provenance/Emulator/PVEmulatorViewController+Saves.swift

@@ -54,7 +54,7 @@ extension PVEmulatorViewController {
             autosaveTimer = Timer.scheduledTimer(withTimeInterval: interval, repeats: true, block: { _ in
                 DispatchQueue.main.async {
                     let image = self.captureScreenshot()
-                    self.createNewSaveState(auto: true, screenshot: image) { result in
+                    self.createNewSaveState(type: .auto, screenshot: image) { result in
                         switch result {
                         case .success: break
                         case let .error(error):
@@ -91,11 +91,11 @@ extension PVEmulatorViewController {
         }
 
         let image = captureScreenshot()
-        createNewSaveState(auto: true, screenshot: image, completion: completion)
+        createNewSaveState(type: .auto, screenshot: image, completion: completion)
     }
 
     //    #error ("Use to https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/iCloud/iCloud.html to save files to iCloud from local url, and setup packages for bundles")
-    func createNewSaveState(auto: Bool, screenshot: UIImage?, completion: @escaping SaveCompletion) {
+    func createNewSaveState(type: SaveType, screenshot: UIImage?, completion: @escaping SaveCompletion) {
         guard core.supportsSaveStates else {
             WLOG("Core \(core.description) doesn't support save states.")
             completion(.error(.saveStatesUnsupportedByCore))
@@ -131,7 +131,7 @@ extension PVEmulatorViewController {
                 return
             }
 
-            DLOG("Succeeded saving state, auto: \(auto)")
+            DLOG("Succeeded saving state, type: \(type)")
             let realm = try! Realm()
             guard let core = realm.object(ofType: PVCore.self, forPrimaryKey: self.core.coreIdentifier) else {
                 completion(.error(.noCoreFound(self.core.coreIdentifier)))
@@ -142,7 +142,7 @@ extension PVEmulatorViewController {
                 var saveState: PVSaveState!
 
                 try realm.write {
-                    saveState = PVSaveState(withGame: self.game, core: core, file: saveFile, image: imageFile, isAutosave: auto)
+                    saveState = PVSaveState(withGame: self.game, core: core, file: saveFile, type: type, image: imageFile)
                     realm.add(saveState)
                 }
 
@@ -160,13 +160,22 @@ extension PVEmulatorViewController {
             }
 
             do {
-                // Delete the oldest auto-saves over 5 count
-                try realm.write {
+                if (type == .auto) {
+                    // Delete the oldest auto-saves over 5 count
                     let autoSaves = self.game.autoSaves
                     if autoSaves.count > 5 {
-                        autoSaves.suffix(from: 5).forEach {
+                        try autoSaves.suffix(from: 5).reversed().forEach {
                             DLOG("Deleting old auto save of \($0.game.title) dated: \($0.date.description)")
-                            realm.delete($0)
+                            try PVSaveState.delete($0)
+                        }
+                    }
+                } else if (type == .quick) {
+                    // Delete the oldest quicksaves over 5 count
+                    let quickSaves = self.game.quickSaves
+                    if quickSaves.count > 5 {
+                        try quickSaves.suffix(from: 5).reversed().forEach {
+                            DLOG("Deleting old quicksave of \($0.game.title) dated: \($0.date.description)")
+                            try PVSaveState.delete($0)
                         }
                     }
                 }
@@ -198,6 +207,8 @@ extension PVEmulatorViewController {
                 state.lastOpened = Date()
             }
 
+            self.core.setPauseEmulation(true)
+
             self.core.loadStateFromFile(atPath: state.file.url.path) { success, error in
                 let completion = {
                     self.core.setPauseEmulation(false)
@@ -239,11 +250,11 @@ extension PVEmulatorViewController {
     }
 
     func saveStatesViewControllerCreateNewState(_ saveStatesViewController: PVSaveStatesViewController, completion: @escaping SaveCompletion) {
-        createNewSaveState(auto: false, screenshot: saveStatesViewController.screenshot, completion: completion)
+        createNewSaveState(type: .manual, screenshot: saveStatesViewController.screenshot, completion: completion)
     }
 
     func saveStatesViewControllerOverwriteState(_ saveStatesViewController: PVSaveStatesViewController, state: PVSaveState, completion: @escaping SaveCompletion) {
-        createNewSaveState(auto: false, screenshot: saveStatesViewController.screenshot) { result in
+        createNewSaveState(type: .manual, screenshot: saveStatesViewController.screenshot) { result in
             switch result {
             case .success:
                 do {
@@ -321,7 +332,7 @@ extension PVEmulatorViewController {
                 let newURL = saveStatePath.appendingPathComponent("\(game.md5Hash).\(Date().timeIntervalSinceReferenceDate)")
                 try fileManager.moveItem(at: autoSaveURL, to: newURL)
                 let saveFile = PVFile(withURL: newURL)
-                let newState = PVSaveState(withGame: game, core: core, file: saveFile, image: nil, isAutosave: true)
+                let newState = PVSaveState(withGame: game, core: core, file: saveFile, type: .auto, image: nil)
                 try realm.write {
                     realm.add(newState)
                 }
@@ -341,12 +352,12 @@ extension PVEmulatorViewController {
                     let newURL = saveStatePath.appendingPathComponent("\(game.md5Hash).\(Date().timeIntervalSinceReferenceDate)")
                     try fileManager.moveItem(at: url, to: newURL)
                     let saveFile = PVFile(withURL: newURL)
-                    let newState = PVSaveState(withGame: game, core: core, file: saveFile, image: nil, isAutosave: false)
+                    let newState = PVSaveState(withGame: game, core: core, file: saveFile, type: .manual, image: nil)
                     try realm.write {
                         realm.add(newState)
                     }
                 } catch {
-                    presentError("Unable to convert autosave to new format: \(error.localizedDescription)")
+                    presentError("Unable to convert manual save state to new format: \(error.localizedDescription)")
                 }
             }
         }