GBA002/Delta/Pause Menu/Save States/SaveStatesViewController.swift
2017-04-30 19:36:48 -07:00

686 lines
27 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.updateDataSource()
}
}
// 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
var theme = Theme.translucent {
didSet {
if self.isViewLoaded
{
self.updateTheme()
}
}
}
fileprivate var vibrancyView: UIVisualEffectView!
fileprivate var placeholderView: RSTPlaceholderView!
fileprivate var prototypeCell = GridCollectionViewCell()
fileprivate var prototypeCellWidthConstraint: NSLayoutConstraint!
fileprivate var prototypeHeader = SaveStatesCollectionHeaderView()
fileprivate let dataSource = RSTFetchedResultsCollectionViewDataSource<SaveState>(fetchedResultsController: NSFetchedResultsController())
fileprivate let imageOperationQueue = RSTOperationQueue()
fileprivate let imageCache = NSCache<NSURL, UIImage>()
fileprivate var emulatorCoreSaveState: SaveStateProtocol?
fileprivate let dateFormatter: DateFormatter
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.vibrancyView = UIVisualEffectView(effect: nil)
self.placeholderView = RSTPlaceholderView(frame: CGRect(x: 0, y: 0, width: self.vibrancyView.bounds.width, height: self.vibrancyView.bounds.height))
self.placeholderView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
self.placeholderView.textLabel.text = NSLocalizedString("No Save States", comment: "")
self.placeholderView.textLabel.textColor = UIColor.white
self.placeholderView.detailTextLabel.textColor = UIColor.white
self.vibrancyView.contentView.addSubview(self.placeholderView)
self.dataSource.proxy = self
self.dataSource.placeholderView = self.vibrancyView
self.dataSource.cellConfigurationHandler = { [unowned self] (cell, item, indexPath) in
self.configure(cell as! GridCollectionViewCell, for: indexPath)
}
self.collectionView?.dataSource = self.dataSource
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: "")
placeholderView.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: "")
placeholderView.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)
self.prepareEmulatorCoreSaveState()
self.registerForPreviewing(with: self, sourceView: self.collectionView!)
self.navigationController?.navigationBar.barStyle = .blackTranslucent
self.navigationController?.toolbar.barStyle = .blackTranslucent
self.updateTheme()
}
override func viewDidDisappear(_ animated: Bool)
{
super.viewDidDisappear(animated)
self.resetEmulatorCoreIfNeeded()
}
override func didReceiveMemoryWarning()
{
super.didReceiveMemoryWarning()
}
}
private extension SaveStatesViewController
{
//MARK: - Update -
func updateDataSource()
{
let fetchRequest: NSFetchRequest<SaveState> = SaveState.fetchRequest()
fetchRequest.returnsObjectsAsFaults = false
fetchRequest.predicate = NSPredicate(format: "%K == %@", #keyPath(SaveState.game), self.game)
fetchRequest.sortDescriptors = [NSSortDescriptor(key: #keyPath(SaveState.type), ascending: true), NSSortDescriptor(key: #keyPath(SaveState.creationDate), ascending: true)]
self.dataSource.fetchedResultsController = NSFetchedResultsController(fetchRequest: fetchRequest, managedObjectContext: DatabaseManager.shared.viewContext, sectionNameKeyPath: #keyPath(SaveState.type), cacheName: nil)
}
func updateTheme()
{
switch self.theme
{
case .opaque:
self.view.backgroundColor = UIColor.deltaDarkGray
self.vibrancyView.effect = nil
self.placeholderView.textLabel.textColor = UIColor.gray
self.placeholderView.detailTextLabel.textColor = UIColor.gray
case .translucent:
self.view.backgroundColor = nil
self.vibrancyView.effect = UIVibrancyEffect(blurEffect: UIBlurEffect(style: .dark))
self.placeholderView.textLabel.textColor = UIColor.white
self.placeholderView.detailTextLabel.textColor = UIColor.white
}
}
//MARK: - Configure Views -
func configure(_ cell: GridCollectionViewCell, for indexPath: IndexPath, ignoreExpensiveOperations ignoreOperations: Bool = false)
{
let saveState = self.dataSource.item(at: indexPath)
cell.imageView.backgroundColor = UIColor.white
cell.imageView.image = UIImage(named: "DeltaPlaceholder")
cell.textLabel.textColor = UIColor.gray
switch self.theme
{
case .opaque:
cell.isTextLabelVibrancyEnabled = false
cell.isImageViewVibrancyEnabled = false
case .translucent:
cell.isTextLabelVibrancyEnabled = true
cell.isImageViewVibrancyEnabled = true
}
if !ignoreOperations
{
let imageOperation = LoadImageURLOperation(url: saveState.imageFileURL)
imageOperation.resultsCache = self.imageCache
imageOperation.resultHandler = { (image, error) in
if let image = image
{
DispatchQueue.main.async {
cell.imageView.backgroundColor = nil
cell.imageView.image = image
cell.isImageViewVibrancyEnabled = false
}
}
}
// 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 as NSCopying)
}
let deltaCore = Delta.core(for: self.game.type)!
let dimensions = deltaCore.videoFormat.dimensions
cell.maximumImageSize = CGSize(width: self.prototypeCellWidthConstraint.constant, height: (self.prototypeCellWidthConstraint.constant / dimensions.width) * dimensions.height)
cell.textLabel.font = UIFont.preferredFont(forTextStyle: .subheadline)
let name = saveState.name ?? self.dateFormatter.string(from: saveState.modifiedDate)
cell.textLabel.text = name
}
func configure(_ 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
headerView.textLabel.textColor = UIColor.white
switch self.theme
{
case .opaque: headerView.isTextLabelVibrancyEnabled = false
case .translucent: headerView.isTextLabelVibrancyEnabled = true
}
}
//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.dataSource.item(at: indexPath)
guard let actions = self.actionsForSaveState(saveState) else { return }
let alertController = UIAlertController(actions: actions)
self.present(alertController, animated: true, completion: nil)
}
//MARK: - Save States -
@IBAction func addSaveState()
{
var saveState: SaveState!
let backgroundContext = DatabaseManager.shared.newBackgroundContext()
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)
{
// Switch back to self.emulatorCore
self.prepareEmulatorCore()
saveState.managedObjectContext?.performAndWait {
self.delegate?.saveStatesViewController(self, updateSaveState: saveState)
saveState.managedObjectContext?.saveWithErrorLogging()
}
}
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
DatabaseManager.shared.performBackgroundTask { (context) in
let temporarySaveState = context.object(with: saveState.objectID)
context.delete(temporarySaveState)
context.saveWithErrorLogging()
}
}))
confirmationAlertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: nil))
self.present(confirmationAlertController, animated: true, completion: nil)
}
func renameSaveState(_ saveState: 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
}
alertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: nil))
alertController.addAction(UIAlertAction(title: NSLocalizedString("Rename", comment: ""), style: .default, handler: { [unowned alertController] (action) in
self.rename(saveState, with: alertController.textFields?.first?.text)
}))
self.present(alertController, animated: true, completion: nil)
}
func rename(_ saveState: SaveState, with name: String?)
{
var name = name
if (name ?? "").characters.count == 0
{
// When text is nil, we know to show the timestamp instead
name = nil
}
DatabaseManager.shared.performBackgroundTask { (context) in
let saveState = context.object(with: saveState.objectID) as! SaveState
saveState.name = name
context.saveWithErrorLogging()
}
}
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
DatabaseManager.shared.performBackgroundTask { (context) in
let game = context.object(with: self.game.objectID) as! Game
if let saveState = saveState
{
let previewSaveState = context.object(with: saveState.objectID) as! SaveState
game.previewSaveState = previewSaveState
}
else
{
game.previewSaveState = nil
}
context.saveWithErrorLogging()
}
}))
self.present(alertController, animated: true, completion: nil)
}
func lockSaveState(_ saveState: SaveState)
{
let backgroundContext = DatabaseManager.shared.newBackgroundContext()
backgroundContext.performAndWait() {
let temporarySaveState = backgroundContext.object(with: saveState.objectID) as! SaveState
temporarySaveState.type = .locked
backgroundContext.saveWithErrorLogging()
}
}
func unlockSaveState(_ saveState: SaveState)
{
let backgroundContext = DatabaseManager.shared.newBackgroundContext()
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.dataSource.fetchedResultsController.sections![section]
let sectionIndex = Int(sectionInfo.name)!
let section = Section(rawValue: sectionIndex)!
return section
}
func actionsForSaveState(_ saveState: SaveState) -> [Action]?
{
guard saveState.type != .auto else { return nil }
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: { [unowned self] action in
self.updatePreviewSaveState(saveState)
})
actions.append(previewAction)
}
else
{
let previewAction = Action(title: NSLocalizedString("Remove as Preview Save State", comment: ""), style: .default, action: { [unowned self] 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: { [unowned self] 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: { [unowned self] action in
self.lockSaveState(saveState)
})
actions.append(lockAction)
case .locked:
let unlockAction = Action(title: NSLocalizedString("Unlock", comment: ""), style: .default, action: { [unowned self] action in
self.unlockSaveState(saveState)
})
actions.append(unlockAction)
}
let deleteAction = Action(title: NSLocalizedString("Delete", comment: ""), style: .destructive, action: { [unowned self] action in
self.deleteSaveState(saveState)
})
actions.append(deleteAction)
return actions
}
//MARK: - Emulator -
func resetEmulatorCoreIfNeeded()
{
self.prepareEmulatorCore()
if let saveState = self.emulatorCoreSaveState
{
// Remove temporary save state file
do
{
try FileManager.default.removeItem(at: saveState.fileURL)
}
catch let error as NSError
{
print(error)
}
}
}
func prepareEmulatorCore()
{
// 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
// Additionally, if emulatorCore.state != .stopped, then we have already resumed emulation with correct save state, and don't need to do it again
guard let emulatorCore = self.emulatorCore, emulatorCore.state == .stopped else { return }
// Temporarily disable video rendering to prevent flickers
emulatorCore.videoManager.isEnabled = 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.isEnabled = true
}
}
//MARK: - 3D Touch -
extension SaveStatesViewController: UIViewControllerPreviewingDelegate
{
fileprivate func prepareEmulatorCoreSaveState()
{
guard let emulatorCore = self.emulatorCore else { return }
// Store reference to current game state before we stop emulation so we can resume it if user decides to not load a save state
let fileURL = FileManager.uniqueTemporaryURL()
self.emulatorCoreSaveState = emulatorCore.saveSaveState(to: fileURL)
if self.emulatorCoreSaveState != nil
{
emulatorCore.stop()
}
}
func previewingContext(_ previewingContext: UIViewControllerPreviewing, viewControllerForLocation location: CGPoint) -> UIViewController?
{
guard
let indexPath = self.collectionView?.indexPathForItem(at: location),
let layoutAttributes = self.collectionViewLayout.layoutAttributesForItem(at: indexPath)
else { return nil }
guard self.emulatorCore == nil || (self.emulatorCore != nil && self.emulatorCoreSaveState != nil) else { return nil }
previewingContext.sourceRect = layoutAttributes.frame
let saveState = self.dataSource.item(at: indexPath)
let actions = self.actionsForSaveState(saveState)?.previewActions ?? []
let previewImage = self.imageCache.object(forKey: saveState.imageFileURL as NSURL) ?? UIImage(contentsOfFile: saveState.imageFileURL.path)
let previewGameViewController = PreviewGameViewController()
previewGameViewController.game = self.game
previewGameViewController.overridePreviewActionItems = actions
previewGameViewController.previewSaveState = saveState
previewGameViewController.previewImage = previewImage
return previewGameViewController
}
func previewingContext(_ previewingContext: UIViewControllerPreviewing, commit viewControllerToCommit: UIViewController)
{
let gameViewController = viewControllerToCommit as! PreviewGameViewController
gameViewController.emulatorCore?.pause()
let fileURL = FileManager.uniqueTemporaryURL()
if let saveState = gameViewController.emulatorCore?.saveSaveState(to: fileURL)
{
gameViewController.emulatorCore?.stop()
self.loadSaveState(saveState)
do
{
try FileManager.default.removeItem(at: fileURL)
}
catch
{
print(error)
}
}
}
}
//MARK: - <UICollectionViewDataSource> -
extension SaveStatesViewController
{
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.configure(headerView, forSection: indexPath.section)
return headerView
}
}
//MARK: - <UICollectionViewDelegate> -
extension SaveStatesViewController
{
override func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath)
{
let saveState = self.dataSource.item(at: indexPath)
switch self.mode
{
case .saving:
let section = self.correctedSectionForSectionIndex((indexPath as NSIndexPath).section)
switch section
{
case .auto: break
case .general:
let backgroundContext = DatabaseManager.shared.newBackgroundContext()
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 as NSCopying]
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.configure(self.prototypeCell, for: indexPath, ignoreExpensiveOperations: true)
let size = self.prototypeCell.contentView.systemLayoutSizeFitting(UILayoutFittingCompressedSize)
return size
}
func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, referenceSizeForHeaderInSection section: Int) -> CGSize
{
self.configure(self.prototypeHeader, forSection: section)
let size = self.prototypeHeader.systemLayoutSizeFitting(UILayoutFittingCompressedSize)
return size
}
}