update cartridge loader to support loading a cartridge implementing the cartridge interface

* Adds `cartridge_context` to provide a fluent interface to the host environment.
* Adds cartridge factory definitions for the functions exported by the dll to create a `cartridge`.
* Updates `cartridge_loader` to search for `GetPakFactory` in the loaded dll and if present use it to construct a `cartridge`.
* Updates `rom_cartridge` to use the `cartridge_context` interface instead of callbacks.
* Adds basic support for loading a ROM image (separate from loading a ROM cartridge/program pak).
* Updates MPI implementation to provide addition implementations of `cartridge_context` for use in mounting a cartridge.

Author: ChetSimpson

libcommon/include/vcc/core/cartridge_context.h

@@ -0,0 +1,51 @@
+////////////////////////////////////////////////////////////////////////////////
+//	Copyright 2015 by Joseph Forgione
+//	This file is part of VCC (Virtual Color Computer).
+//	
+//	VCC (Virtual Color Computer) is free software: you can redistribute itand/or
+//	modify it under the terms of the GNU General Public License as published by
+//	the Free Software Foundation, either version 3 of the License, or (at your
+//	option) any later version.
+//	
+//	VCC (Virtual Color Computer) is distributed in the hope that it will be
+//	useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+//	Public License for more details.
+//	
+//	You should have received a copy of the GNU General Public License along with
+//	VCC (Virtual Color Computer). If not, see <http://www.gnu.org/licenses/>.
+////////////////////////////////////////////////////////////////////////////////
+#pragma once
+#include <vcc/core/detail/exports.h>
+#include <vcc/core/interrupts.h>
+#include <string>
+
+
+// FIXME: this needs to come from the common library but is currently part of the
+// main vcc app. Update this when it is migrated.
+enum MenuItemType;
+
+namespace vcc { namespace core
+{
+
+	struct LIBCOMMON_EXPORT cartridge_context
+	{
+		using path_type = ::std::string;
+
+
+		virtual ~cartridge_context() = default;
+
+		virtual path_type configuration_path() const = 0;
+
+		virtual void reset() = 0;
+
+		virtual void assert_cartridge_line(bool line_state) = 0;
+		virtual void assert_interrupt(Interrupt interrupt, InterruptSource interrupt_source) = 0;
+
+		virtual void write_memory_byte(unsigned char value, unsigned short address) = 0;
+		virtual unsigned char read_memory_byte(unsigned short address) = 0;
+
+		virtual void add_menu_item(const char* menu_name, int menu_id, MenuItemType menu_type) = 0;
+	};
+
+} }

libcommon/include/vcc/core/cartridge_factory.h

@@ -0,0 +1,25 @@
+////////////////////////////////////////////////////////////////////////////////
+//	Copyright 2015 by Joseph Forgione
+//	This file is part of VCC (Virtual Color Computer).
+//	
+//	VCC (Virtual Color Computer) is free software: you can redistribute itand/or
+//	modify it under the terms of the GNU General Public License as published by
+//	the Free Software Foundation, either version 3 of the License, or (at your
+//	option) any later version.
+//	
+//	VCC (Virtual Color Computer) is distributed in the hope that it will be
+//	useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+//	Public License for more details.
+//	
+//	You should have received a copy of the GNU General Public License along with
+//	VCC (Virtual Color Computer). If not, see <http://www.gnu.org/licenses/>.
+////////////////////////////////////////////////////////////////////////////////
+#pragma once
+#include <vcc/core/cartridge.h>
+#include <vcc/core/cartridge_context.h>
+#include <memory>
+
+using CreatePakFactoryFunction = std::unique_ptr<::vcc::core::cartridge> (*)(std::unique_ptr<::vcc::core::cartridge_context> context);
+using GetPakFactoryFunction = CreatePakFactoryFunction(*)();
+

libcommon/include/vcc/core/cartridge_loader.h

@@ -17,6 +17,7 @@
 ////////////////////////////////////////////////////////////////////////////////
 #pragma once
 #include <vcc/core/cartridge.h>
+#include <vcc/core/cartridge_context.h>
 #include <vcc/core/legacy_cartridge_definitions.h>
 #include <vcc/core/utils/dll_deleter.h>
 #include <string>
@@ -58,7 +59,7 @@ namespace vcc { namespace core
 		cartridge_loader_status load_result = cartridge_loader_status::not_loaded;
 	};
 
-	struct LIBCOMMON_EXPORT cartridge_loader_context
+	struct cartridge_loader_context
 	{
 		const AppendCartridgeMenuModuleCallback addMenuItemCallback;
 		const ReadMemoryByteModuleCallback readData;
@@ -69,13 +70,15 @@ namespace vcc { namespace core
 
 	LIBCOMMON_EXPORT cartridge_file_type determine_cartridge_type(const std::string& filename);
 	LIBCOMMON_EXPORT cartridge_loader_result load_rom_cartridge(
-		const cartridge_loader_context& context,
+		std::unique_ptr<cartridge_context> context,
 		const std::string& filename);
 	LIBCOMMON_EXPORT cartridge_loader_result load_legacy_cartridge(
+		std::unique_ptr<cartridge_context> cartridge_context,
 		const cartridge_loader_context& context,
 		const std::string& filename,
 		const std::string& iniPath);
 	LIBCOMMON_EXPORT cartridge_loader_result load_cartridge(
+		std::unique_ptr<cartridge_context> cartridge_context,
 		const cartridge_loader_context& context,
 		const std::string& filename,
 		const std::string& iniPath);

libcommon/include/vcc/core/cartridges/rom_cartridge.h

@@ -17,8 +17,9 @@
 ////////////////////////////////////////////////////////////////////////////////
 #pragma once
 #include <vcc/core/cartridges/basic_cartridge.h>
-#include <vcc/core/legacy_cartridge_definitions.h>
+#include <vcc/core/cartridge_context.h>
 #include <vector>
+#include <memory>
 
 
 namespace vcc { namespace core { namespace cartridges
@@ -28,6 +29,7 @@ namespace vcc { namespace core { namespace cartridges
 	{
 	public:
 
+		using context_type = ::vcc::core::cartridge_context;
 		using buffer_type = std::vector<uint8_t>;
 		using size_type = std::size_t;
 
@@ -38,7 +40,7 @@ namespace vcc { namespace core { namespace cartridges
 
 
 		LIBCOMMON_EXPORT rom_cartridge(
-			AssertCartridgeLineModuleCallback assertCartCallback,
+			std::unique_ptr<context_type> context,
 			name_type name,
 			catalog_id_type catalog_id,
 			buffer_type buffer,
@@ -59,7 +61,7 @@ namespace vcc { namespace core { namespace cartridges
 
 	private:
 
-		const AssertCartridgeLineModuleCallback assertCartCallback_;
+		const std::unique_ptr<context_type> context_;
 		const name_type name_;
 		const catalog_id_type catalog_id_;
 		const buffer_type buffer_;

libcommon/include/vcc/core/rom_image.h

@@ -0,0 +1,76 @@
+////////////////////////////////////////////////////////////////////////////////
+//	Copyright 2015 by Joseph Forgione
+//	This file is part of VCC (Virtual Color Computer).
+//	
+//	VCC (Virtual Color Computer) is free software: you can redistribute itand/or
+//	modify it under the terms of the GNU General Public License as published by
+//	the Free Software Foundation, either version 3 of the License, or (at your
+//	option) any later version.
+//	
+//	VCC (Virtual Color Computer) is distributed in the hope that it will be
+//	useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
+//	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+//	Public License for more details.
+//	
+//	You should have received a copy of the GNU General Public License along with
+//	VCC (Virtual Color Computer). If not, see <http://www.gnu.org/licenses/>.
+////////////////////////////////////////////////////////////////////////////////
+#pragma once
+#include <vcc/core/detail/exports.h>
+#include <string>
+#include <vector>
+
+namespace vcc { namespace core
+{
+
+	class rom_image
+	{
+	public:
+
+		using path_type = std::string;
+		using container_type = std::vector<unsigned char>;
+		using value_type = container_type::value_type;
+		using size_type = container_type::size_type;
+
+
+	public:
+
+		LIBCOMMON_EXPORT rom_image() = default;
+		LIBCOMMON_EXPORT ~rom_image() = default;
+
+		bool empty() const
+		{
+			return data_.empty();
+		}
+
+		path_type filename() const
+		{
+			return filename_;
+		}
+
+		LIBCOMMON_EXPORT bool load(path_type filename);
+
+		void clear()
+		{
+			filename_.clear();
+			data_.clear();
+		}
+
+		value_type read_memory_byte(size_type memory_address) const
+		{
+			if (data_.empty())
+			{
+				return 0;
+			}
+
+			return data_[memory_address % data_.size()];
+		}
+
+
+	private:
+
+		path_type filename_;
+		container_type data_;
+	};
+
+} }

libcommon/libcommon.vcxproj

@@ -102,6 +102,7 @@
     <ClCompile Include="src\core\cartridges\legacy_cartridge.cpp" />
     <ClCompile Include="src\core\cartridges\rom_cartridge.cpp" />
     <ClCompile Include="src\core\cartridge_loader.cpp" />
+    <ClCompile Include="src\core\rom_image.cpp" />
     <ClCompile Include="src\core\utils\configuration_serializer.cpp" />
     <ClCompile Include="src\core\utils\filesystem.cpp" />
     <ClCompile Include="src\core\utils\winapi.cpp" />
@@ -119,11 +120,14 @@
     <ClInclude Include="include\vcc\core\cartridges\legacy_cartridge.h" />
     <ClInclude Include="include\vcc\core\cartridges\null_cartridge.h" />
     <ClInclude Include="include\vcc\core\cartridges\rom_cartridge.h" />
+    <ClInclude Include="include\vcc\core\cartridge_context.h" />
+    <ClInclude Include="include\vcc\core\cartridge_factory.h" />
     <ClInclude Include="include\vcc\core\cartridge_loader.h" />
     <ClInclude Include="include\vcc\core\detail\exports.h" />
     <ClInclude Include="include\vcc\core\interrupts.h" />
     <ClInclude Include="include\vcc\core\legacy_cartridge_definitions.h" />
     <ClInclude Include="include\vcc\core\limits.h" />
+    <ClInclude Include="include\vcc\core\rom_image.h" />
     <ClInclude Include="include\vcc\core\utils\configuration_serializer.h" />
     <ClInclude Include="include\vcc\core\utils\critical_section.h" />
     <ClInclude Include="include\vcc\core\utils\dll_deleter.h" />

libcommon/libcommon.vcxproj.filters

@@ -75,6 +75,9 @@
     <ClCompile Include="src\core\cartridges\basic_cartridge.cpp">
       <Filter>Source Files\core\cartridges</Filter>
     </ClCompile>
+    <ClCompile Include="src\core\rom_image.cpp">
+      <Filter>Source Files\core</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="resource\resource.h">
@@ -134,6 +137,15 @@
     <ClInclude Include="include\vcc\core\cartridges\basic_cartridge.h">
       <Filter>Header Files\core\cartridges</Filter>
     </ClInclude>
+    <ClInclude Include="include\vcc\core\cartridge_context.h">
+      <Filter>Header Files\core</Filter>
+    </ClInclude>
+    <ClInclude Include="include\vcc\core\cartridge_factory.h">
+      <Filter>Header Files\core</Filter>
+    </ClInclude>
+    <ClInclude Include="include\vcc\core\rom_image.h">
+      <Filter>Header Files\core</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="resource\libcommon.rc">

libcommon/src/core/cartridge_loader.cpp

@@ -21,6 +21,7 @@
 #include <vector>
 #include <fstream>
 #include <iterator>
+#include <vcc/core/cartridge_factory.h>
 
 
 namespace vcc { namespace core
@@ -61,7 +62,7 @@ namespace vcc { namespace core
 	}
 
 	cartridge_loader_result load_rom_cartridge(
-		const cartridge_loader_context& context,
+		std::unique_ptr<cartridge_context> context,
 		const std::string& filename)
 	{
 		constexpr size_t PAK_MAX_MEM = 0x40000;
@@ -96,7 +97,7 @@ namespace vcc { namespace core
 		return {
 			nullptr,
 			std::make_unique<vcc::core::cartridges::rom_cartridge>(
-				context.assertCartridgeLine,
+				move(context),
 				extract_filename(filename),
 				"",
 				move(romImage),
@@ -106,6 +107,7 @@ namespace vcc { namespace core
 	}
 
 	cartridge_loader_result load_legacy_cartridge(
+		std::unique_ptr<cartridge_context> cartridge_context,
 		const cartridge_loader_context& context,
 		const std::string& filename,
 		const std::string& iniPath)
@@ -123,25 +125,37 @@ namespace vcc { namespace core
 			return { nullptr, nullptr, cartridge_loader_status::cannot_open };
 		}
 
-		if (GetProcAddress(details.handle.get(), "ModuleName") == nullptr)
+		const auto factoryAccessor(reinterpret_cast<GetPakFactoryFunction>(GetProcAddress(
+			details.handle.get(),
+			"GetPakFactory")));
+		if (factoryAccessor != nullptr)
 		{
-			return { nullptr, nullptr, cartridge_loader_status::not_expansion };
+			details.cartridge = factoryAccessor()(move(cartridge_context));
+			details.load_result = cartridge_loader_status::success;
+
+			return details;
 		}
 
-		details.cartridge = std::make_unique<vcc::core::cartridges::legacy_cartridge>(
-			details.handle.get(),
-			iniPath,
-			context.addMenuItemCallback,
-			context.readData,
-			context.writeData,
-			context.assertInterrupt,
-			context.assertCartridgeLine);
-		details.load_result = cartridge_loader_status::success;
-
-		return details;
+		if (GetProcAddress(details.handle.get(), "ModuleName") != nullptr)
+		{
+			details.cartridge = std::make_unique<vcc::core::cartridges::legacy_cartridge>(
+				details.handle.get(),
+				iniPath,
+				context.addMenuItemCallback,
+				context.readData,
+				context.writeData,
+				context.assertInterrupt,
+				context.assertCartridgeLine);
+			details.load_result = cartridge_loader_status::success;
+
+			return details;
+		}
+
+		return { nullptr, nullptr, cartridge_loader_status::not_expansion };
 	}
 
 	cartridge_loader_result load_cartridge(
+		std::unique_ptr<cartridge_context> cartridge_context,
 		const cartridge_loader_context& context,
 		const std::string& filename,
 		const std::string& iniPath)
@@ -153,10 +167,10 @@ namespace vcc { namespace core
 			return { nullptr, nullptr, cartridge_loader_status::cannot_open };
 
 		case cartridge_file_type::rom_image:	//	File is a ROM image
-			return vcc::core::load_rom_cartridge(context, filename);
+			return vcc::core::load_rom_cartridge(move(cartridge_context), filename);
 
 		case cartridge_file_type::library:		//	File is a DLL
-			return vcc::core::load_legacy_cartridge(context, filename, iniPath);
+			return vcc::core::load_legacy_cartridge(move(cartridge_context), context, filename, iniPath);
 		}
 	}
 

libcommon/src/core/cartridges/rom_cartridge.cpp

@@ -22,13 +22,13 @@ namespace vcc { namespace core { namespace cartridges
 {
 
 	rom_cartridge::rom_cartridge(
-		AssertCartridgeLineModuleCallback assertCartCallback,
+		std::unique_ptr<context_type> context,
 		name_type name,
 		catalog_id_type catalog_id,
 		buffer_type buffer,
 		bool enable_bank_switching)
 		:
-		assertCartCallback_(assertCartCallback),
+		context_(move(context)),
 		name_(move(name)),
 		catalog_id_(move(catalog_id)),
 		buffer_(move(buffer)),
@@ -68,7 +68,7 @@ namespace vcc { namespace core { namespace cartridges
 
 	void rom_cartridge::initialize_bus()
 	{
-		assertCartCallback_(true);
+		context_->assert_cartridge_line(true);
 	}
 
 } } }