separate configuration management from multipak_cartridge

add `multipak_configuration` class
update configuration dialog to get/set settings using the multipak configuration
update multipak cartridge to get settings from the multipak configuration
update multipak configuration dialog to save the selected slot and cartridge paths to the configuration.
remove `save_configuration` from `multipak_cartridge`
remove `load_Configuration` from `multipak_cartridge` and move functionality into `start`

Author: ChetSimpson

mpi/configuration_dialog.cpp

@@ -21,7 +21,6 @@
 #include <vcc/common/DialogOps.h>
 #include <vcc/core/utils/critical_section.h>
 #include <vcc/core/utils/filesystem.h>
-#include <vcc/core/utils/configuration_serializer.h>
 
 
 namespace
@@ -45,8 +44,12 @@ namespace
 
 }
 
-configuration_dialog::configuration_dialog(multipak_cartridge& mpi)
-	: mpi_(mpi)
+configuration_dialog::configuration_dialog(
+	multipak_configuration& configuration,
+	multipak_cartridge& mpi)
+	:
+	configuration_(configuration),
+	mpi_(mpi)
 {}
 
 
@@ -73,14 +76,9 @@ void configuration_dialog::close()
 
 void configuration_dialog::select_new_cartridge(size_t slot)
 {
-	::vcc::core::configuration_serializer serializer(gConfigurationFilename);
-
-	// Get default paths for modules. 
-	const auto gLastAccessedPath(serializer.read("DefaultPaths", "MPIPath"));
-
 	FileDialog dlg;
 	dlg.setTitle("Load Program Pak");
-	dlg.setInitialDir(gLastAccessedPath.c_str());
+	dlg.setInitialDir(configuration_.last_accessed_module_path().c_str());
 	dlg.setFilter(
 		"All Pak Types (*.dll; *.rom; *.ccc; *.pak)\0*.dll;*.ccc;*.rom;*.pak\0"
 		"Hardware Pak (*.dll)\0*.dll\0"
@@ -93,10 +91,8 @@ void configuration_dialog::select_new_cartridge(size_t slot)
 
 		if (mpi_.mount_cartridge(slot, dlg.path()) == cartridge_loader_status::success)
 		{
-			serializer.write(
-				"DefaultPaths",
-				"MPIPath",
-				::vcc::core::utils::get_directory_from_path(dlg.path()));
+			configuration_.slot_cartridge_path(slot, dlg.path());
+			configuration_.last_accessed_module_path(::vcc::core::utils::get_directory_from_path(dlg.path()));
 		}
 
 		mpi_.build_menu();
@@ -124,6 +120,7 @@ void configuration_dialog::set_selected_slot(size_t slot)
 
 	// FIXME: Maube move this to the callsite or when the dialog closes or at least make it optional?
 	mpi_.switch_to_slot(slot);
+	configuration_.selected_slot(slot);
 }
 
 
@@ -163,6 +160,7 @@ void configuration_dialog::eject_or_select_new_cartridge(size_t slot)
 	if (!mpi_.empty(slot))
 	{
 		mpi_.eject_cartridge(slot);
+		configuration_.slot_cartridge_path(slot, {});
 	}
 	else
 	{
@@ -198,7 +196,6 @@ INT_PTR configuration_dialog::process_message(
 	switch (message)
 	{
 	case WM_CLOSE:
-		mpi_.save_configuration();
 		DestroyWindow(hDlg);
 		dialog_handle_ = nullptr;
 		parent_handle_ = nullptr;

mpi/configuration_dialog.h

@@ -17,14 +17,17 @@
 ////////////////////////////////////////////////////////////////////////////////
 #pragma once
 #include "multipak_cartridge.h"
+#include "multipak_configuration.h"
 #include <Windows.h>
 
 
 class configuration_dialog
 {
 public:
 
-	explicit configuration_dialog(multipak_cartridge& mpi);
+	configuration_dialog(
+		multipak_configuration& configuration,
+		multipak_cartridge& mpi);
 
 	configuration_dialog(const configuration_dialog&) = delete;
 	configuration_dialog(configuration_dialog&&) = delete;
@@ -56,6 +59,7 @@ class configuration_dialog
 
 private:
 
+	multipak_configuration& configuration_;
 	multipak_cartridge& mpi_;
 	HWND dialog_handle_ = nullptr;
 	HWND parent_handle_ = nullptr;

mpi/mpi.cpp

@@ -27,11 +27,12 @@
 #define EXPORT_PUBLIC_API extern "C" __declspec(dllexport)
 
 HINSTANCE gModuleInstance = nullptr;
-std::string gConfigurationFilename;
+static std::string gConfigurationFilename;
 // FIXME: The host context will be provided by VCC once the full implementation is complete
 const std::shared_ptr<host_cartridge_context> gHostContext(std::make_shared<host_cartridge_context>(nullptr, gConfigurationFilename));
-multipak_cartridge gMultiPakInterface(gHostContext);
-configuration_dialog gConfigurationDialog(gMultiPakInterface);
+multipak_configuration gMultiPakConfiguration("MPI");
+multipak_cartridge gMultiPakInterface(gMultiPakConfiguration, gHostContext);
+configuration_dialog gConfigurationDialog(gMultiPakConfiguration, gMultiPakInterface);
 
 
 BOOL WINAPI DllMain(HINSTANCE module_instance, DWORD reason, LPVOID /*reserved*/)
@@ -78,6 +79,7 @@ extern "C"
 		const char* const configuration_path,
 		const cpak_cartridge_context* const context)
 	{
+		gMultiPakConfiguration.configuration_path(configuration_path);
 		gConfigurationFilename = configuration_path;
 		gHostContext->add_menu_item_ = context->add_menu_item;
 		gHostContext->read_memory_byte_ = context->read_memory_byte;

mpi/mpi.h

@@ -25,4 +25,3 @@ extern const std::shared_ptr<host_cartridge_context> gHostContext;
 extern multipak_cartridge gMultiPakInterface;
 extern configuration_dialog gConfigurationDialog;
 extern std::string gLastAccessedPath;
-extern std::string gConfigurationFilename;

mpi/mpi.vcxproj

@@ -97,6 +97,7 @@
     <ClCompile Include="configuration_dialog.cpp" />
     <ClCompile Include="mpi.cpp" />
     <ClCompile Include="multipak_cartridge.cpp" />
+    <ClCompile Include="multipak_configuration.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="cartridge_slot.h" />
@@ -105,6 +106,7 @@
     <ClInclude Include="multipak_cartridge.h" />
     <ClInclude Include="configuration_dialog.h" />
     <ClInclude Include="multipak_cartridge_context.h" />
+    <ClInclude Include="multipak_configuration.h" />
     <ClInclude Include="resource.h" />
   </ItemGroup>
   <ItemGroup>

mpi/mpi.vcxproj.filters

@@ -13,6 +13,9 @@
     <ClCompile Include="multipak_cartridge.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="multipak_configuration.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="cartridge_slot.h">
@@ -36,6 +39,9 @@
     <ClInclude Include="multipak_cartridge_context.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="multipak_configuration.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Filter Include="Header Files">

mpi/multipak_cartridge.cpp

@@ -19,7 +19,6 @@
 #include "multipak_cartridge_context.h"
 #include "mpi.h"
 #include "resource.h"
-#include <vcc/core/utils/configuration_serializer.h>
 #include <vcc/core/utils/winapi.h>
 #include <vcc/core/utils/filesystem.h>
 
@@ -68,8 +67,12 @@ namespace
 }
 
 
-multipak_cartridge::multipak_cartridge(std::shared_ptr<context_type> context)
-	: context_(move(context))
+multipak_cartridge::multipak_cartridge(
+	multipak_configuration& configuration,
+	std::shared_ptr<context_type> context)
+	:
+	configuration_(configuration),
+	context_(move(context))
 { }
 
 multipak_cartridge::name_type multipak_cartridge::name() const
@@ -90,7 +93,23 @@ multipak_cartridge::description_type multipak_cartridge:: description() const
 
 void multipak_cartridge::start()
 {
-	load_configuration();
+	// Get the startup slot and set Chip select and SCS slots from ini file
+	switch_slot_ = configuration_.selected_slot();
+	cached_cts_slot_ = switch_slot_;
+	cached_scs_slot_ = switch_slot_;
+
+	// Mount them
+	for (auto slot(0u); slot < slots_.size(); slot++)
+	{
+		const auto path(vcc::core::utils::find_pak_module_path(configuration_.slot_cartridge_path(slot)));
+		if (!path.empty())
+		{
+			mount_cartridge(slot, path);
+		}
+	}
+
+	// Build the dynamic menu
+	build_menu();
 }
 
 void multipak_cartridge::reset()
@@ -392,47 +411,6 @@ void multipak_cartridge::build_menu()
 }
 
 
-void multipak_cartridge::load_configuration()
-{
-	const auto& section(name());
-	::vcc::core::configuration_serializer serializer(context_->configuration_path());
-
-	// Get the startup slot and set Chip select and SCS slots from ini file
-	switch_slot_ = serializer.read(section, "SWPOSITION", 3);
-	cached_cts_slot_ = switch_slot_;
-	cached_scs_slot_ = switch_slot_;
-
-	// Mount them
-	for (auto slot(0u); slot < slots_.size(); slot++)
-	{
-		const auto path(vcc::core::utils::find_pak_module_path(serializer.read(section, "SLOT" + std::to_string(slot + 1))));
-		if (!path.empty())
-		{
-			mount_cartridge(slot, path);
-		}
-	}
-
-	// Build the dynamic menu
-	build_menu();
-}
-
-void multipak_cartridge::save_configuration() const
-{
-	vcc::core::utils::section_locker lock(mutex_);
-
-	const auto& section(name());
-	::vcc::core::configuration_serializer serializer(context_->configuration_path());
-
-	serializer.write(section, "SWPOSITION", switch_slot_);
-	for (auto slot(0u); slot < slots_.size(); slot++)
-	{
-		serializer.write(
-			section,
-			"SLOT" + ::std::to_string(slot + 1),
-			vcc::core::utils::strip_application_path(slots_[slot].path()));
-	}
-}
-
 void multipak_cartridge::assert_cartridge_line(slot_id_type slot, bool line_state)
 {
 	vcc::core::utils::section_locker lock(mutex_);

mpi/multipak_cartridge.h

@@ -17,6 +17,7 @@
 ////////////////////////////////////////////////////////////////////////////////
 #pragma once
 #include "cartridge_slot.h"
+#include "multipak_configuration.h"
 #include <vcc/core/cartridges/basic_cartridge.h>
 #include <vcc/core/cartridge_loader.h>
 #include <vcc/core/utils/critical_section.h>
@@ -41,7 +42,9 @@ class multipak_cartridge : public ::vcc::core::cartridge
 
 public:
 
-	explicit multipak_cartridge(std::shared_ptr<context_type> context);
+	multipak_cartridge(
+		multipak_configuration& configuration,
+		std::shared_ptr<context_type> context);
 	multipak_cartridge(const multipak_cartridge&) = delete;
 	multipak_cartridge(multipak_cartridge&&) = delete;
 
@@ -80,23 +83,18 @@ class multipak_cartridge : public ::vcc::core::cartridge
 	void build_menu();
 
 	// Make automatic when mounting, ejecting, selecting slot, etc.
-	void save_configuration() const;
 	void assert_cartridge_line(slot_id_type slot, bool line_state);
 	void append_menu_item(slot_id_type slot, menu_item_type item);
 
 
-private:
-
-	void load_configuration();
-
-
 private:
 
 	static const size_t slot_select_port_id = 0x7f;
 	static const size_t default_switch_slot_value = 0x03;
 	static const size_t default_slot_register_value = 0xff;
 
 	vcc::core::utils::critical_section mutex_;
+	multipak_configuration& configuration_;
 	std::shared_ptr<context_type> context_;
 	std::array<vcc::modules::mpi::cartridge_slot, NUMSLOTS> slots_;
 	unsigned char slot_register_ = default_slot_register_value;

mpi/multipak_configuration.cpp

@@ -0,0 +1,60 @@
+#include "multipak_configuration.h"
+#include <vcc/core/utils/configuration_serializer.h>
+
+
+using serializer = ::vcc::core::configuration_serializer;
+
+
+multipak_configuration::multipak_configuration(string_type section)
+	: section_(move(section))
+{}
+
+
+void multipak_configuration::configuration_path(path_type path)
+{
+	configuration_path_ = move(path);
+}
+
+multipak_configuration::path_type multipak_configuration::configuration_path() const
+{
+	return configuration_path_;
+}
+
+
+multipak_configuration::path_type multipak_configuration::last_accessed_module_path() const
+{
+	return serializer(configuration_path()).read("DefaultPaths", "MPIPath");
+}
+
+void multipak_configuration::last_accessed_module_path(const path_type& path) const
+{
+	serializer(configuration_path()).write("DefaultPaths", "MPIPath", path);
+}
+
+
+void multipak_configuration::selected_slot(slot_id_type slot) const
+{
+	serializer(configuration_path()).write(section_, "SWPOSITION", slot);
+}
+
+multipak_configuration::slot_id_type multipak_configuration::selected_slot() const
+{
+	return serializer(configuration_path()).read(section_, "SWPOSITION", 3);
+}
+
+
+void multipak_configuration::slot_cartridge_path(slot_id_type slot, const path_type& path) const
+{
+	serializer(configuration_path()).write(section_, get_slot_path_key(slot), path);
+}
+
+multipak_configuration::path_type multipak_configuration::slot_cartridge_path(slot_id_type slot) const
+{
+	return serializer(configuration_path()).read(section_, get_slot_path_key(slot));
+}
+
+
+multipak_configuration::string_type multipak_configuration::get_slot_path_key(slot_id_type slot) const
+{
+	return "SLOT" + ::std::to_string(slot + 1);
+}