GBA002/Delta/Pause Menu/Save States/SaveStatesViewController.swift

739 lines
29 KiB
Swift

//
// SaveStatesViewController.swift
// Delta
//
// Created by Riley Testut on 1/23/16.
// Copyright © 2016 Riley Testut. All rights reserved.
//
import UIKit
import CoreData
import DeltaCore
import Roxas
protocol SaveStatesViewControllerDelegate: class
{
func saveStatesViewController(_ saveStatesViewController: SaveStatesViewController, updateSaveState saveState: SaveState)
func saveStatesViewController(_ saveStatesViewController: SaveStatesViewController, loadSaveState saveState: SaveStateProtocol)
}
extension SaveStatesViewController
{
enum Mode
{
case saving
case loading
}
enum Section: Int
{
case auto
case general
case locked
}
}
class SaveStatesViewController: UICollectionViewController
{
var game: Game! {
didSet {
self.updateFetchedResultsController()
}
}
// Reference to a current EmulatorCore. emulatorCore.game does _not_ have to match self.game
var emulatorCore: EmulatorCore?
weak var delegate: SaveStatesViewControllerDelegate?
var mode = Mode.loading
private var backgroundView: RSTBackgroundView!
private var prototypeCell = GridCollectionViewCell()
private var prototypeCellWidthConstraint: NSLayoutConstraint!
private var prototypeHeader = SaveStatesCollectionHeaderView()
private var fetchedResultsController: NSFetchedResultsController<NSFetchRequestResult>!
private let imageOperationQueue = RSTOperationQueue()
private let imageCache = Cache<URL, UIImage>()
private var emulatorCoreSaveState: SaveStateProtocol?
private var selectedSaveState: SaveState?
private let dateFormatter: DateFormatter
private let previewGameViewController = GameViewController()
private var previewInteraction: UIPreviewInteraction!
required init?(coder aDecoder: NSCoder)
{
self.dateFormatter = DateFormatter()
self.dateFormatter.timeStyle = .short
self.dateFormatter.dateStyle = .short
super.init(coder: aDecoder)
}
}
extension SaveStatesViewController
{
override func viewDidLoad()
{
super.viewDidLoad()
self.backgroundView = RSTBackgroundView(frame: self.view.bounds)
self.backgroundView.isHidden = true
self.backgroundView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
self.backgroundView.textLabel.text = NSLocalizedString("No Save States", comment: "")
self.backgroundView.textLabel.textColor = UIColor.white
self.backgroundView.detailTextLabel.textColor = UIColor.white
self.view.insertSubview(self.backgroundView, at: 0)
let collectionViewLayout = self.collectionViewLayout as! GridCollectionViewLayout
let averageHorizontalInset = (collectionViewLayout.sectionInset.left + collectionViewLayout.sectionInset.right) / 2
let portraitScreenWidth = UIScreen.main.coordinateSpace.convert(UIScreen.main.bounds, to: UIScreen.main.fixedCoordinateSpace).width
// Use dimensions that allow two cells to fill the screen horizontally with padding in portrait mode
// We'll keep the same size for landscape orientation, which will allow more to fit
collectionViewLayout.itemWidth = (portraitScreenWidth - (averageHorizontalInset * 3)) / 2
switch self.mode
{
case .saving:
self.title = NSLocalizedString("Save State", comment: "")
self.backgroundView.detailTextLabel.text = NSLocalizedString("You can create a new save state by pressing the + button in the top right.", comment: "")
case .loading:
self.title = NSLocalizedString("Load State", comment: "")
self.backgroundView.detailTextLabel.text = NSLocalizedString("You can create a new save state by pressing the Save State option in the pause menu.", comment: "")
self.navigationItem.rightBarButtonItem = nil
}
// Manually update prototype cell properties
self.prototypeCellWidthConstraint = self.prototypeCell.contentView.widthAnchor.constraint(equalToConstant: collectionViewLayout.itemWidth)
self.prototypeCellWidthConstraint.isActive = true
let longPressGestureRecognizer = UILongPressGestureRecognizer(target: self, action: #selector(SaveStatesViewController.handleLongPressGesture(_:)))
self.collectionView?.addGestureRecognizer(longPressGestureRecognizer)
// Pre-initialize previewGameViewController with game and start/pause emulation to ensure previewingContext(_:viewControllerForLocation:) callback doesn't take too long + break 3D Touch animation
self.preparePreviewGameViewController()
self.previewInteraction = UIPreviewInteraction(view: self.collectionView!)
self.previewInteraction.delegate = self
self.registerForPreviewing(with: self, sourceView: self.collectionView!)
self.updateBackgroundView()
}
override func viewWillAppear(_ animated: Bool)
{
self.fetchedResultsController.performFetchIfNeeded()
self.updateBackgroundView()
super.viewWillAppear(animated)
}
override func viewDidDisappear(_ animated: Bool)
{
super.viewDidDisappear(animated)
self.resetEmulatorCoreIfNeeded()
}
override func didReceiveMemoryWarning()
{
super.didReceiveMemoryWarning()
}
}
private extension SaveStatesViewController
{
//MARK: - Update -
func updateFetchedResultsController()
{
let fetchRequest = SaveState.rst_fetchRequest()
fetchRequest.returnsObjectsAsFaults = false
fetchRequest.predicate = Predicate(format: "%K == %@", SaveState.Attributes.game.rawValue, self.game)
fetchRequest.sortDescriptors = [SortDescriptor(key: SaveState.Attributes.type.rawValue, ascending: true), SortDescriptor(key: SaveState.Attributes.creationDate.rawValue, ascending: true)]
self.fetchedResultsController = NSFetchedResultsController(fetchRequest: fetchRequest, managedObjectContext: DatabaseManager.sharedManager.managedObjectContext, sectionNameKeyPath: SaveState.Attributes.type.rawValue, cacheName: nil)
self.fetchedResultsController.delegate = self
}
func updateBackgroundView()
{
if let fetchedObjects = self.fetchedResultsController.fetchedObjects, fetchedObjects.count > 0
{
self.backgroundView.isHidden = true
}
else
{
self.backgroundView.isHidden = false
}
}
//MARK: - Configure Views -
func configureCollectionViewCell(_ cell: GridCollectionViewCell, forIndexPath indexPath: IndexPath, ignoreExpensiveOperations ignoreOperations: Bool = false)
{
let saveState = self.fetchedResultsController.object(at: indexPath) as! SaveState
cell.imageView.backgroundColor = UIColor.white
cell.imageView.image = UIImage(named: "DeltaPlaceholder")
if !ignoreOperations
{
let imageOperation = LoadImageOperation(URL: saveState.imageFileURL)
imageOperation.imageCache = self.imageCache
imageOperation.completionHandler = { image in
if let image = image
{
cell.imageView.backgroundColor = nil
cell.imageView.image = image
}
}
// Ensure initially visible cells have loaded their image before they appear to prevent potential flickering from placeholder to thumbnail
if self.isAppearing
{
imageOperation.isImmediate = true
}
self.imageOperationQueue.addOperation(imageOperation, forKey: indexPath)
}
let deltaCore = Delta.core(for: self.game.type)!
let dimensions = deltaCore.emulatorConfiguration.videoBufferInfo.outputDimensions
cell.maximumImageSize = CGSize(width: self.prototypeCellWidthConstraint.constant, height: (self.prototypeCellWidthConstraint.constant / dimensions.width) * dimensions.height)
cell.textLabel.textColor = UIColor.white
cell.textLabel.font = UIFont.preferredFont(forTextStyle: UIFontTextStyleSubheadline)
let name = saveState.name ?? self.dateFormatter.string(from: saveState.modifiedDate)
cell.textLabel.text = name
}
func configureCollectionViewHeaderView(_ headerView: SaveStatesCollectionHeaderView, forSection section: Int)
{
let section = self.correctedSectionForSectionIndex(section)
let title: String
switch section
{
case .auto: title = NSLocalizedString("Auto Save", comment: "")
case .general: title = NSLocalizedString("General", comment: "")
case .locked: title = NSLocalizedString("Locked", comment: "")
}
headerView.textLabel.text = title
}
//MARK: - Gestures -
@objc func handleLongPressGesture(_ gestureRecognizer: UILongPressGestureRecognizer)
{
guard gestureRecognizer.state == .began else { return }
guard let indexPath = self.collectionView?.indexPathForItem(at: gestureRecognizer.location(in: self.collectionView)) else { return }
let saveState = self.fetchedResultsController.object(at: indexPath) as! SaveState
let alertController = UIAlertController(title: nil, message: nil, preferredStyle: .actionSheet)
let actions = self.actionsForSaveState(saveState).map { $0.alertAction }
for action in actions
{
alertController.addAction(action)
}
self.present(alertController, animated: true, completion: nil)
}
//MARK: - Save States -
@IBAction func addSaveState()
{
var saveState: SaveState!
let backgroundContext = DatabaseManager.sharedManager.backgroundManagedObjectContext()
backgroundContext.performAndWait {
let game = backgroundContext.object(with: self.game.objectID) as! Game
saveState = SaveState.insertIntoManagedObjectContext(backgroundContext)
saveState.game = game
}
self.updateSaveState(saveState)
}
func updateSaveState(_ saveState: SaveState)
{
// Stop previewGameViewController.emulatorCore, and switch to self.emulatorCore
self.prepareEmulatorCore()
saveState.managedObjectContext?.performAndWait {
self.delegate?.saveStatesViewController(self, updateSaveState: saveState)
saveState.managedObjectContext?.saveWithErrorLogging()
}
DispatchQueue.main.async {
// Only restart self.previewGameViewController.emulatorCore if we're not being dismissed
if !self.isDisappearing
{
self.emulatorCore?.stop()
self.previewGameViewController.emulatorCore?.start()
self.previewGameViewController.emulatorCore?.pause()
}
}
}
func loadSaveState(_ saveState: SaveStateProtocol)
{
// Stop previewGameViewController.emulatorCore, and switch to self.emulatorCore
self.prepareEmulatorCore()
self.delegate?.saveStatesViewController(self, loadSaveState: saveState)
// Implicit assumption that loadSaveState will always result in SaveStatesViewController being dismissed
// Mostly because the method used in updateSaveState(_:) to detect this doesn't work for peek/pop, and too lazy to care rn
}
func deleteSaveState(_ saveState: SaveState)
{
let confirmationAlertController = UIAlertController(title: NSLocalizedString("Delete Save State?", comment: ""), message: NSLocalizedString("Are you sure you want to delete this save state? This cannot be undone.", comment: ""), preferredStyle: .alert)
confirmationAlertController.addAction(UIAlertAction(title: NSLocalizedString("Delete", comment: ""), style: .default, handler: { action in
let backgroundContext = DatabaseManager.sharedManager.backgroundManagedObjectContext()
backgroundContext.perform {
let temporarySaveState = backgroundContext.object(with: saveState.objectID)
backgroundContext.delete(temporarySaveState)
backgroundContext.saveWithErrorLogging()
}
}))
confirmationAlertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: nil))
self.present(confirmationAlertController, animated: true, completion: nil)
}
func renameSaveState(_ saveState: SaveState)
{
self.selectedSaveState = saveState
let alertController = UIAlertController(title: NSLocalizedString("Rename Save State", comment: ""), message: nil, preferredStyle: .alert)
alertController.addTextField { (textField) in
textField.text = saveState.name
textField.placeholder = NSLocalizedString("Name", comment: "")
textField.autocapitalizationType = .words
textField.returnKeyType = .done
textField.addTarget(self, action: #selector(SaveStatesViewController.updateSaveStateName(_:)), for: .editingDidEnd)
}
alertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: { (action) in
self.selectedSaveState = nil
}))
alertController.addAction(UIAlertAction(title: NSLocalizedString("Rename", comment: ""), style: .default, handler: { (action) in
self.updateSaveStateName(alertController.textFields!.first!)
}))
self.present(alertController, animated: true, completion: nil)
}
@objc func updateSaveStateName(_ textField: UITextField)
{
guard let selectedSaveState = self.selectedSaveState else { return }
var text = textField.text
if text?.characters.count == 0
{
// When text is nil, we know to show the timestamp instead
text = nil
}
let backgroundContext = DatabaseManager.sharedManager.backgroundManagedObjectContext()
backgroundContext.perform {
let saveState = backgroundContext.object(with: selectedSaveState.objectID) as! SaveState
saveState.name = text
backgroundContext.saveWithErrorLogging()
}
self.selectedSaveState = nil
}
func updatePreviewSaveState(_ saveState: SaveState?)
{
let alertController = UIAlertController(title: NSLocalizedString("Change Preview Save State?", comment: ""), message: NSLocalizedString("The Preview Save State is loaded whenever you preview this game from the Main Menu with 3D Touch. Are you sure you want to change it?", comment: ""), preferredStyle: .alert)
alertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: nil))
alertController.addAction(UIAlertAction(title: NSLocalizedString("Change", comment: ""), style: .default, handler: { (action) in
let backgroundContext = DatabaseManager.sharedManager.backgroundManagedObjectContext()
backgroundContext.perform {
let game = backgroundContext.object(with: self.game.objectID) as! Game
if let saveState = saveState
{
let previewSaveState = backgroundContext.object(with: saveState.objectID) as! SaveState
game.previewSaveState = previewSaveState
}
else
{
game.previewSaveState = nil
}
backgroundContext.saveWithErrorLogging()
}
}))
self.present(alertController, animated: true, completion: nil)
}
func lockSaveState(_ saveState: SaveState)
{
let backgroundContext = DatabaseManager.sharedManager.backgroundManagedObjectContext()
backgroundContext.performAndWait() {
let temporarySaveState = backgroundContext.object(with: saveState.objectID) as! SaveState
temporarySaveState.type = .locked
backgroundContext.saveWithErrorLogging()
}
}
func unlockSaveState(_ saveState: SaveState)
{
let backgroundContext = DatabaseManager.sharedManager.backgroundManagedObjectContext()
backgroundContext.performAndWait() {
let temporarySaveState = backgroundContext.object(with: saveState.objectID) as! SaveState
temporarySaveState.type = .general
backgroundContext.saveWithErrorLogging()
}
}
//MARK: - Convenience Methods -
func correctedSectionForSectionIndex(_ section: Int) -> Section
{
let sectionInfo = self.fetchedResultsController.sections![section]
let sectionIndex = Int(sectionInfo.name)!
let section = Section(rawValue: sectionIndex)!
return section
}
func actionsForSaveState(_ saveState: SaveState) -> [Action]
{
var actions = [Action]()
if self.traitCollection.forceTouchCapability == .available
{
if saveState.game.previewSaveState != saveState
{
let previewAction = Action(title: NSLocalizedString("Set as Preview Save State", comment: ""), style: .default, action: { action in
self.updatePreviewSaveState(saveState)
})
actions.append(previewAction)
}
else
{
let previewAction = Action(title: NSLocalizedString("Remove as Preview Save State", comment: ""), style: .default, action: { action in
self.updatePreviewSaveState(nil)
})
actions.append(previewAction)
}
}
let cancelAction = Action(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, action: nil)
actions.append(cancelAction)
let renameAction = Action(title: NSLocalizedString("Rename", comment: ""), style: .default, action: { action in
self.renameSaveState(saveState)
})
actions.append(renameAction)
switch saveState.type
{
case .auto: break
case .general:
let lockAction = Action(title: NSLocalizedString("Lock", comment: ""), style: .default, action: { action in
self.lockSaveState(saveState)
})
actions.append(lockAction)
case .locked:
let unlockAction = Action(title: NSLocalizedString("Unlock", comment: ""), style: .default, action: { action in
self.unlockSaveState(saveState)
})
actions.append(unlockAction)
}
let deleteAction = Action(title: NSLocalizedString("Delete", comment: ""), style: .destructive, action: { action in
self.deleteSaveState(saveState)
})
actions.append(deleteAction)
return actions
}
//MARK: - Emulator -
func resetEmulatorCoreIfNeeded()
{
guard let saveState = self.emulatorCoreSaveState else { return }
defer
{
// Remove temporary save state file
do
{
try FileManager.default.removeItem(at: saveState.fileURL)
}
catch let error as NSError
{
print(error)
}
}
self.previewGameViewController.emulatorCore?.stop()
// Kinda hacky, but isMovingFromParentViewController only returns yes when popping off navigation controller, and not being dismissed modally
// Because of this, this is only run when the user returns to PauseMenuViewController, and not when they choose a save state to load
guard self.isMovingFromParentViewController else { return }
self.prepareEmulatorCore()
}
func prepareEmulatorCore()
{
self.previewGameViewController.emulatorCore?.stop()
// We stopped emulation for 3D Touch, so now we must resume emulation and load the save state we made to make it seem like it was never stopped
if let emulatorCore = self.emulatorCore
{
// Temporarily disable video rendering to prevent flickers
emulatorCore.videoManager.enabled = false
// Load the save state we stored a reference to
emulatorCore.start()
emulatorCore.pause()
if let saveState = self.emulatorCoreSaveState
{
do
{
try emulatorCore.load(saveState)
}
catch EmulatorCore.SaveStateError.doesNotExist
{
print("Save State does not exist.")
}
catch let error as NSError
{
print(error)
}
}
// Re-enable video rendering
emulatorCore.videoManager.enabled = true
}
}
}
//MARK: - 3D Touch -
extension SaveStatesViewController: UIViewControllerPreviewingDelegate, UIPreviewInteractionDelegate
{
private func preparePreviewGameViewController()
{
if let emulatorCore = self.emulatorCore
{
// Store reference to current game state before we stop emulation so we can resume it if user decides to not load a save state
emulatorCore.save() { saveState in
let fileURL = FileManager.uniqueTemporaryURL()
do
{
try FileManager.default.moveItem(at: saveState.fileURL, to: fileURL)
self.emulatorCoreSaveState = DeltaCore.SaveState(fileURL: fileURL, gameType: emulatorCore.game.type)
}
catch let error as NSError
{
print(error)
}
}
guard self.emulatorCoreSaveState != nil else { return }
emulatorCore.stop()
}
self.previewGameViewController.game = self.game
self.previewGameViewController.emulatorCore?.start()
self.previewGameViewController.emulatorCore?.pause()
}
func previewingContext(_ previewingContext: UIViewControllerPreviewing, viewControllerForLocation location: CGPoint) -> UIViewController?
{
guard
let indexPath = self.collectionView?.indexPathForItem(at: location),
let layoutAttributes = self.collectionViewLayout.layoutAttributesForItem(at: indexPath),
self.emulatorCoreSaveState != nil
else { return nil }
previewingContext.sourceRect = layoutAttributes.frame
let saveState = self.fetchedResultsController.object(at: indexPath) as! SaveState
do
{
try self.previewGameViewController.emulatorCore?.load(saveState)
let actions = self.actionsForSaveState(saveState).lazy.filter{ $0.style != .cancel }.map{ $0.previewAction }
self.previewGameViewController.overridePreviewActionItems = Array(actions)
return self.previewGameViewController
}
catch EmulatorCore.SaveStateError.doesNotExist
{
print("Save State \(saveState.name) does not exist.")
}
catch let error as NSError
{
print(error)
}
return nil
}
func previewingContext(_ previewingContext: UIViewControllerPreviewing, commit viewControllerToCommit: UIViewController)
{
let gameViewController = viewControllerToCommit as! GameViewController
gameViewController.emulatorCore?.pause()
gameViewController.emulatorCore?.save() { saveState in
self.loadSaveState(saveState)
}
}
func previewInteraction(_ previewInteraction: UIPreviewInteraction, didUpdatePreviewTransition transitionProgress: CGFloat, ended: Bool)
{
}
func previewInteractionDidCancel(_ previewInteraction: UIPreviewInteraction)
{
self.previewGameViewController.emulatorCore?.pause()
}
}
//MARK: - <UICollectionViewDataSource> -
extension SaveStatesViewController
{
override func numberOfSections(in collectionView: UICollectionView) -> Int
{
let numberOfSections = self.fetchedResultsController.sections!.count
return numberOfSections
}
override func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int
{
let section = self.fetchedResultsController.sections![section]
return section.numberOfObjects
}
override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell
{
let cell = collectionView.dequeueReusableCell(withReuseIdentifier: RSTGenericCellIdentifier, for: indexPath) as! GridCollectionViewCell
self.configureCollectionViewCell(cell, forIndexPath: indexPath)
return cell
}
override func collectionView(_ collectionView: UICollectionView, viewForSupplementaryElementOfKind kind: String, at indexPath: IndexPath) -> UICollectionReusableView
{
let headerView = collectionView.dequeueReusableSupplementaryView(ofKind: kind, withReuseIdentifier: "Header", for: indexPath) as! SaveStatesCollectionHeaderView
self.configureCollectionViewHeaderView(headerView, forSection: (indexPath as NSIndexPath).section)
return headerView
}
}
//MARK: - <UICollectionViewDelegate> -
extension SaveStatesViewController
{
override func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath)
{
let saveState = self.fetchedResultsController.object(at: indexPath) as! SaveState
switch self.mode
{
case .saving:
let section = self.correctedSectionForSectionIndex((indexPath as NSIndexPath).section)
switch section
{
case .auto: break
case .general:
let backgroundContext = DatabaseManager.sharedManager.backgroundManagedObjectContext()
backgroundContext.performAndWait() {
let temporarySaveState = backgroundContext.object(with: saveState.objectID) as! SaveState
self.updateSaveState(temporarySaveState)
}
case .locked:
let alertController = UIAlertController(title: NSLocalizedString("Cannot Modify Locked Save State", comment: ""), message: NSLocalizedString("This save state must first be unlocked before it can be modified.", comment: ""), preferredStyle: .alert)
alertController.addAction(UIAlertAction(title: NSLocalizedString("OK", comment: ""), style: .cancel, handler: nil))
self.present(alertController, animated: true, completion: nil)
}
case .loading: self.loadSaveState(saveState)
}
}
override func collectionView(_ collectionView: UICollectionView, didEndDisplaying cell: UICollectionViewCell, forItemAt indexPath: IndexPath)
{
let operation = self.imageOperationQueue[indexPath]
operation?.cancel()
}
}
//MARK: - <UICollectionViewDelegateFlowLayout> -
extension SaveStatesViewController: UICollectionViewDelegateFlowLayout
{
func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAt indexPath: IndexPath) -> CGSize
{
// No need to load images from disk just to determine size, so we pass true for ignoreExpensiveOperations
self.configureCollectionViewCell(self.prototypeCell, forIndexPath: indexPath, ignoreExpensiveOperations: true)
let size = self.prototypeCell.contentView.systemLayoutSizeFitting(UILayoutFittingCompressedSize)
return size
}
func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, referenceSizeForHeaderInSection section: Int) -> CGSize
{
self.configureCollectionViewHeaderView(self.prototypeHeader, forSection: section)
let size = self.prototypeHeader.systemLayoutSizeFitting(UILayoutFittingCompressedSize)
return size
}
}
//MARK: - <NSFetchedResultsControllerDelegate> -
extension SaveStatesViewController: NSFetchedResultsControllerDelegate
{
func controllerDidChangeContent(_ controller: NSFetchedResultsController<NSFetchRequestResult>)
{
self.collectionView?.reloadData()
self.updateBackgroundView()
}
}