Merge pull request #939 from TomHarte/DragAndDropState

Accept insertion of state snapshots into existing windows

OSBindings/Mac/Clock Signal.xcodeproj/xcshareddata/xcschemes/Clock Signal Kiosk.xcscheme

@@ -74,7 +74,7 @@
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--new=amstradcpc"
-            isEnabled = "NO">
+            isEnabled = "YES">
          </CommandLineArgument>
          <CommandLineArgument
             argument = "&quot;/Users/thomasharte/Library/Mobile Documents/com~apple~CloudDocs/Desktop/Soft/ColecoVision/Galaxian (1983)(Atari).col&quot;"
@@ -106,11 +106,11 @@
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--rompath=/Users/thomasharte/Projects/CLK/ROMImages"
-            isEnabled = "NO">
+            isEnabled = "YES">
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--help"
-            isEnabled = "YES">
+            isEnabled = "NO">
          </CommandLineArgument>
          <CommandLineArgument
             argument = "--model=cpc6128"

OSBindings/Mac/Clock Signal/Documents/MachineDocument.swift

@@ -87,6 +87,14 @@ class MachineDocument:
 		}
 	}
 
+	private func dismissPanels() {
+		activityPanel?.setIsVisible(false)
+		activityPanel = nil
+
+		optionsPanel?.setIsVisible(false)
+		optionsPanel = nil
+	}
+
 	override func close() {
 		// Close any dangling sheets.
 		//
@@ -105,11 +113,7 @@ class MachineDocument:
 		machine?.stop()
 
 		// Dismiss panels.
-		activityPanel?.setIsVisible(false)
-		activityPanel = nil
-
-		optionsPanel?.setIsVisible(false)
-		optionsPanel = nil
+		dismissPanels()
 
 		// End the update cycle.
 		actionLock.lock()
@@ -137,19 +141,23 @@ class MachineDocument:
 	func configureAs(_ analysis: CSStaticAnalyser) {
 		self.machineDescription = analysis
 
+		actionLock.lock()
+		drawLock.lock()
+
 		let missingROMs = NSMutableArray()
 		if let machine = CSMachine(analyser: analysis, missingROMs: missingROMs) {
 			self.machine = machine
-			setupActivityDisplay()
 			machine.setVolume(userDefaultsVolume())
 			setupMachineOutput()
 		} else {
 			// Store the selected machine and list of missing ROMs, and
 			// show the missing ROMs dialogue.
 			self.missingROMs = missingROMs.map({$0 as! CSMissingROM})
-
 			requestRoms()
 		}
+
+		actionLock.unlock()
+		drawLock.unlock()
 	}
 
 	enum InteractionMode {
@@ -200,6 +208,9 @@ class MachineDocument:
 			let aspectRatio = self.aspectRatio()
 			machine.setView(scanTargetView, aspectRatio: Float(aspectRatio.width / aspectRatio.height))
 
+			// Get rid of all existing accessory panels.
+			dismissPanels()
+
 			// Attach an options panel if one is available.
 			if let optionsPanelNibName = self.machineDescription?.optionsPanelNibName {
 				Bundle.main.loadNibNamed(optionsPanelNibName, owner: self, topLevelObjects: nil)
@@ -208,11 +219,10 @@ class MachineDocument:
 				showOptions(self)
 			}
 
-			machine.delegate = self
+			// Create and populate an activity display if required.
+			setupActivityDisplay()
 
-			// Callbacks from the OpenGL may come on a different thread, immediately following the .delegate set;
-			// hence the full setup of the best-effort updater prior to setting self as a delegate.
-//			scanTargetView.delegate = self
+			machine.delegate = self
 			scanTargetView.responderDelegate = self
 
 			// If this machine has a mouse, enable mouse capture; also indicate whether usurption
@@ -252,7 +262,7 @@ class MachineDocument:
 		let isStereo = self.machine.isStereo
 		if selectedSamplingRate > 0 {
 			// [Re]create the audio queue only if necessary.
-			if self.audioQueue == nil || self.audioQueue.samplingRate != selectedSamplingRate {
+			if self.audioQueue == nil || self.audioQueue.samplingRate != selectedSamplingRate || self.audioQueue != self.machine.audioQueue {
 				self.machine.audioQueue = nil
 				self.audioQueue = CSAudioQueue(samplingRate: Float64(selectedSamplingRate), isStereo:isStereo)
 				self.audioQueue.delegate = self
@@ -280,8 +290,7 @@ class MachineDocument:
 
 	/// Delegate message to receive drag and drop files.
 	final func scanTargetView(_ view: CSScanTargetView, didReceiveFileAt URL: URL) {
-		let mediaSet = CSMediaSet(fileAt: URL)
-		mediaSet.apply(to: self.machine)
+		insertFile(URL)
 	}
 
 	/// Action for the insert menu command; displays an NSOpenPanel and then segues into the same process
@@ -292,10 +301,27 @@ class MachineDocument:
 		openPanel.beginSheetModal(for: self.windowControllers[0].window!) { (response) in
 			if response == .OK {
 				for url in openPanel.urls {
-					let mediaSet = CSMediaSet(fileAt: url)
+					self.insertFile(url)
+				}
+			}
+		}
+	}
+
+	private func insertFile(_ URL: URL) {
+		// Try to insert media.
+		let mediaSet = CSMediaSet(fileAt: URL)
+		if !mediaSet.empty {
 			mediaSet.apply(to: self.machine)
+			return
 		}
-			}
+
+		// Failing that see whether a new machine is required.
+		// TODO.
+		if let newMachine = CSStaticAnalyser(fileAt: URL) {
+			machine?.stop()
+			self.interactionMode = .notStarted
+			self.scanTargetView.willChangeScanTargetOwner()
+			configureAs(newMachine)
 		}
 	}
 

OSBindings/Mac/Clock Signal/Machine/StaticAnalyser/CSStaticAnalyser.h

@@ -114,6 +114,8 @@ typedef int Kilobytes;
 - (instancetype)initWithFileAtURL:(NSURL *)url;
 - (void)applyToMachine:(CSMachine *)machine;
 
+@property(nonatomic, readonly) BOOL empty;
+
 @end
 
 NS_ASSUME_NONNULL_END

OSBindings/Mac/Clock Signal/Machine/StaticAnalyser/CSStaticAnalyser.mm

@@ -309,4 +309,8 @@ static Analyser::Static::ZX8081::Target::MemoryModel ZX8081MemoryModelFromSize(K
 	[machine applyMedia:_media];
 }
 
+- (BOOL)empty {
+	return _media.empty();
+}
+
 @end

OSBindings/Mac/Clock Signal/ScanTarget/CSScanTarget.h

@@ -22,4 +22,6 @@
 
 - (nonnull NSBitmapImageRep *)imageRepresentation;
 
+- (void)willChangeOwner;
+
 @end

OSBindings/Mac/Clock Signal/ScanTarget/CSScanTarget.mm

@@ -1143,6 +1143,10 @@ using BufferingScanTarget = Outputs::Display::BufferingScanTarget;
 	return &_scanTarget;
 }
 
+- (void)willChangeOwner {
+	self.scanTarget->will_change_owner();
+}
+
 - (NSBitmapImageRep *)imageRepresentation {
 	// Create an NSBitmapRep as somewhere to copy pixel data to.
 	NSBitmapImageRep *const result =

OSBindings/Mac/Clock Signal/Views/CSScanTargetView.h

@@ -162,4 +162,10 @@
 */
 @property(nonatomic, readonly, nonnull) CSScanTarget *scanTarget;
 
+/*!
+	Indicates that the enclosed scan target is about to be handed off to a new owner;
+	exactly identical to calling scanTarget.will_change_owner().
+*/
+- (void)willChangeScanTargetOwner;
+
 @end

OSBindings/Mac/Clock Signal/Views/CSScanTargetView.m

@@ -129,6 +129,10 @@ static CVReturn DisplayLinkCallback(__unused CVDisplayLinkRef displayLink, const
 	return _scanTarget;
 }
 
+- (void)willChangeScanTargetOwner {
+	[_scanTarget willChangeOwner];
+}
+
 - (void)updateBacking {
 	[_scanTarget updateFrameBuffer];
 }

OSBindings/SDL/main.cpp

@@ -470,13 +470,56 @@ class DynamicWindowTitler {
 			update_window_title();
 		}
 
+		void set_file_name(const std::string &name) {
+			file_name_ = name;
+			update_window_title();
+		}
+
 	private:
 		void update_window_title() {
 			SDL_SetWindowTitle(window_, window_title().c_str());
 		}
 		bool mouse_is_captured_ = false;
 		SDL_Window *window_ = nullptr;
-		const std::string file_name_;
+		std::string file_name_;
+};
+
+/*!
+	Provides a wrapper for SDL_Joystick pointers that can keep track
+	of historic hat values.
+*/
+class SDLJoystick {
+	public:
+		SDLJoystick(SDL_Joystick *joystick) : joystick_(joystick) {
+			hat_values_.resize(SDL_JoystickNumHats(joystick));
+		}
+
+		~SDLJoystick() {
+			SDL_JoystickClose(joystick_);
+		}
+
+		/// @returns The underlying SDL_Joystick.
+		SDL_Joystick *get() {
+			return joystick_;
+		}
+
+		/// @returns A reference to the storage for the previous state of hat @c c.
+		Uint8 &last_hat_value(int c) {
+			return hat_values_[c];
+		}
+
+		/// @returns The logic OR of all stored hat states.
+		Uint8 hat_values() {
+			Uint8 value = 0;
+			for(const auto hat_value: hat_values_) {
+				value |= hat_value;
+			}
+			return value;
+		}
+
+	private:
+		SDL_Joystick *joystick_;
+		std::vector<Uint8> hat_values_;
 };
 
 }
@@ -723,7 +766,7 @@ int main(int argc, char *argv[]) {
 					if(!rom.descriptive_name.empty()) {
 						std::cerr << rom.descriptive_name << "; ";
 					}
-					std::cerr << "accepted crc32s: ";
+					std::cerr << "usual crc32s: ";
 					bool is_first = true;
 					for(const auto crc32: rom.crc32s) {
 						if(!is_first) std::cerr << ", ";
@@ -791,10 +834,6 @@ int main(int argc, char *argv[]) {
 		SDL_StartTextInput();
 	}
 
-	// Wire up the best-effort updater, its delegate, and the speaker delegate.
-	machine_runner.machine = machine.get();
-	machine_runner.machine_mutex = &machine_mutex;
-
 	// Ensure all media is inserted, if this machine accepts it.
 	{
 		auto media_target = machine->media_target();
@@ -844,6 +883,15 @@ int main(int argc, char *argv[]) {
 
 	// Setup output, assuming a CRT machine for now, and prepare a best-effort updater.
 	Outputs::Display::OpenGL::ScanTarget scan_target(target_framebuffer);
+	std::unique_ptr<ActivityObserver> activity_observer;
+	bool uses_mouse;
+	std::vector<SDLJoystick> joysticks;
+
+	machine_runner.machine_mutex = &machine_mutex;
+	const auto setup_machine_input_output = [&scan_target, &machine, &speaker_delegate, &activity_observer, &joysticks, &uses_mouse, &machine_runner] {
+		// Wire up the best-effort updater, its delegate, and the speaker delegate.
+		machine_runner.machine = machine.get();
+
 		machine->scan_producer()->set_scan_target(&scan_target);
 
 		// For now, lie about audio output intentions.
@@ -869,65 +917,35 @@ int main(int argc, char *argv[]) {
 			SDL_PauseAudioDevice(speaker_delegate.audio_device, 0);
 		}
 
-	int window_width, window_height;
-	SDL_GetWindowSize(window, &window_width, &window_height);
+		/*
+			If the machine offers anything for activity observation,
+			create and register an activity observer.
+		*/
+		Activity::Source *const activity_source = machine->activity_source();
+		if(activity_source) {
+			activity_observer = std::make_unique<ActivityObserver>(activity_source, 4.0f / 3.0f);
+		} else {
+			activity_observer = nullptr;
+		}
 
 		// If this is a joystick machine, check for and open attached joysticks.
-	/*!
-		Provides a wrapper for SDL_Joystick pointers that can keep track
-		of historic hat values.
-	*/
-	class SDLJoystick {
-		public:
-			SDLJoystick(SDL_Joystick *joystick) : joystick_(joystick) {
-				hat_values_.resize(SDL_JoystickNumHats(joystick));
-			}
-
-			~SDLJoystick() {
-				SDL_JoystickClose(joystick_);
-			}
-
-			/// @returns The underlying SDL_Joystick.
-			SDL_Joystick *get() {
-				return joystick_;
-			}
-
-			/// @returns A reference to the storage for the previous state of hat @c c.
-			Uint8 &last_hat_value(int c) {
-				return hat_values_[c];
-			}
-
-			/// @returns The logic OR of all stored hat states.
-			Uint8 hat_values() {
-				Uint8 value = 0;
-				for(const auto hat_value: hat_values_) {
-					value |= hat_value;
-				}
-				return value;
-			}
-
-		private:
-			SDL_Joystick *joystick_;
-			std::vector<Uint8> hat_values_;
-	};
-	std::vector<SDLJoystick> joysticks;
 		const auto joystick_machine = machine->joystick_machine();
 		if(joystick_machine) {
 			SDL_InitSubSystem(SDL_INIT_JOYSTICK);
 			for(int c = 0; c < SDL_NumJoysticks(); ++c) {
 				joysticks.emplace_back(SDL_JoystickOpen(c));
 			}
+		} else {
+			joysticks.clear();
 		}
 
-	/*
-		If the machine offers anything for activity observation,
-		create and register an activity observer.
-	*/
-	std::unique_ptr<ActivityObserver> activity_observer;
-	Activity::Source *const activity_source = machine->activity_source();
-	if(activity_source) {
-		activity_observer = std::make_unique<ActivityObserver>(activity_source, 4.0f / 3.0f);
-	}
+		// Keep a record of whether mouse events can be forwarded.
+		uses_mouse = !!machine->mouse_machine();
+	};
+	setup_machine_input_output();
+
+	int window_width, window_height;
+	SDL_GetWindowSize(window, &window_width, &window_height);
 
 	// SDL 2.x delivers key up/down events and text inputs separately even when they're correlated;
 	// this struct and map is used to correlate them by time.
@@ -945,7 +963,6 @@ int main(int argc, char *argv[]) {
 	std::vector<KeyPress> keypresses;
 
 	// Run the main event loop until the OS tells us to quit.
-	const bool uses_mouse = !!machine->mouse_machine();
 	bool should_quit = false;
 	Uint32 fullscreen_mode = 0;
 	machine_runner.start();
@@ -987,8 +1004,26 @@ int main(int argc, char *argv[]) {
 				break;
 
 				case SDL_DROPFILE: {
-					Analyser::Static::Media media = Analyser::Static::GetMedia(event.drop.file);
+					const Analyser::Static::Media media = Analyser::Static::GetMedia(event.drop.file);
+
+					// If the new file is only media, insert it; if it is a state snapshot then
+					// tear down the entire machine and replace it.
+					if(!media.empty()) {
 						machine->media_target()->insert_media(media);
+						break;
+					}
+
+					targets = Analyser::Static::GetTargets(event.drop.file);
+					if(targets.empty()) break;
+
+					::Machine::Error error;
+					std::unique_ptr<::Machine::DynamicMachine> new_machine(::Machine::MachineForTargets(targets, rom_fetcher, error));
+					if(error != Machine::Error::None) break;
+
+					machine = std::move(new_machine);
+					static_cast<Outputs::Display::ScanTarget *>(&scan_target)->will_change_owner();
+					setup_machine_input_output();
+					window_titler.set_file_name(final_path_component(event.drop.file));
 				} break;
 
 				case SDL_TEXTINPUT: