clean up cartridge inteface (#457)

Reordered functions in cartridge and derived types
Moved implementations of all members of `basic_cartridge` except `name`, `catalog_id`, and `description` to `cartridge`
Moved implementations of `name`, `catalog_id`, and `description` from `basic_cartridge` to `null_cartridge`
Renamed `null_cartridge` to `empty_cartridge`
Renamed _legacy_cartridge_definitions.h_ to _cartridge_capi.h_
Renamed `legacy_cartridge_ to `capi_adapter_cartridge`
Renamed `cpak_cartridge_context` to `capi_cartridge_context`
Rhanged `cpak` to `capi` in all other usage
Removed `basic_cartridge`
Added `description` to `ramdisk_cartridge`
Added `description` to `orchestra90cc_cartridge`
Fixed order or parameters in declaration of `load_rom_cartridge` to match its definition.

Co-authored-by: Ed Jaquay <[email protected]>

Author: ChetSimpson

FD502/fd502.cpp

@@ -124,7 +124,7 @@ extern "C"
 	__declspec(dllexport) void PakInitialize(
 		void* const host_key,
 		const char* const configuration_path,
-		const cpak_cartridge_context* const context)
+		const cartridge_capi_context* const context)
 	{
 		gHostKeyPtr = host_key;
 		CartMenuCallback = context->add_menu_item;

FD502/fd502.h

@@ -16,7 +16,7 @@
 //
 //---------------------------------------------------------------------------------
 #pragma once
-#include <vcc/core/legacy_cartridge_definitions.h>
+#include <vcc/core/cartridge_capi.h>
 
 extern void*const& gHostKey;
 extern PakAssertInteruptHostCallback AssertInt;

GMC/gmc_cartridge.h

@@ -27,12 +27,17 @@ class gmc_cartridge : public ::vcc::core::cartridge
 	void start() override;
 	void stop() override;
 	void reset() override;
-	void process_horizontal_sync() override;
+
+	unsigned char read_memory_byte(unsigned short memory_address) override;
+
 	void write_port(unsigned char port_id, unsigned char value) override;
 	unsigned char read_port(unsigned char port_id) override;
-	unsigned char read_memory_byte(unsigned short memory_address) override;
-	void status(char* status_buffer, size_t buffer_size) override;
+
+	void process_horizontal_sync() override;
+
 	unsigned short sample_audio() override;
+
+	void status(char* status_buffer, size_t buffer_size) override;
 	void menu_item_clicked(unsigned char menu_item_id) override;
 
 

GMC/main.cpp

@@ -21,7 +21,7 @@ extern "C" __declspec(dllexport) CreatePakFactoryFunction GetPakFactory()
 {
 	return [](
 		[[maybe_unused]] std::unique_ptr<::vcc::core::cartridge_context> context,
-		[[maybe_unused]] const cpak_cartridge_context& cpak_context) -> std::unique_ptr<::vcc::core::cartridge>
+		[[maybe_unused]] const cartridge_capi_context& capi_context) -> std::unique_ptr<::vcc::core::cartridge>
 	{
 		return std::make_unique<gmc_cartridge>(move(context), gModuleInstance);
 	};

HardDisk/harddisk.cpp

@@ -28,7 +28,7 @@ This file is part of VCC (Virtual Color Computer).
 #include <vcc/common/DialogOps.h>
 #include "../CartridgeMenu.h"
 #include <vcc/core/interrupts.h>
-#include <vcc/core/legacy_cartridge_definitions.h>
+#include <vcc/core/cartridge_capi.h>
 #include <vcc/core/limits.h>
 
 constexpr auto DEF_HD_SIZE = 132480u;
@@ -118,7 +118,7 @@ extern "C"
 	__declspec(dllexport) void PakInitialize(
 		void* const host_key,
 		const char* const configuration_path,
-		const cpak_cartridge_context* const context)
+		const cartridge_capi_context* const context)
 	{
 		gHostKey = host_key;
 		CartMenuCallback = context->add_menu_item;

Ramdisk/main.cpp

@@ -39,7 +39,7 @@ BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved)
 extern "C" __declspec(dllexport) CreatePakFactoryFunction GetPakFactory()
 {
 	return []([[maybe_unused]] std::unique_ptr<::vcc::core::cartridge_context> context,
-			  [[maybe_unused]] const cpak_cartridge_context& cpak_context) -> std::unique_ptr<::vcc::core::cartridge>
+			  [[maybe_unused]] const cartridge_capi_context& capi_context) -> std::unique_ptr<::vcc::core::cartridge>
 	{
 		return std::make_unique<ramdisk_cartridge>();
 	};

Ramdisk/ramdisk_cartridge.cpp

@@ -33,6 +33,12 @@ ramdisk_cartridge::catalog_id_type ramdisk_cartridge::catalog_id() const
 	return ::vcc::utils::load_string(gModuleInstance, IDS_CATNUMBER);
 }
 
+ramdisk_cartridge::description_type ramdisk_cartridge::description() const
+{
+	return ::vcc::utils::load_string(gModuleInstance, IDS_DESCRIPTION);
+}
+
+
 void ramdisk_cartridge::start()
 {
 	initialize_state(true);

Ramdisk/ramdisk_cartridge.h

@@ -16,13 +16,13 @@
 //	VCC (Virtual Color Computer). If not, see <http://www.gnu.org/licenses/>.
 ////////////////////////////////////////////////////////////////////////////////
 #pragma once
-#include <vcc/cartridges/basic_cartridge.h>
+#include <vcc/core/cartridge.h>
 #include <vcc/core/cartridge_context.h>
 #include <memory>
 #include <array>
 
 
-class ramdisk_cartridge : public ::vcc::cartridges::basic_cartridge
+class ramdisk_cartridge : public ::vcc::core::cartridge
 {
 public:
 
@@ -33,6 +33,7 @@ class ramdisk_cartridge : public ::vcc::cartridges::basic_cartridge
 
 	name_type name() const override;
 	catalog_id_type catalog_id() const override;
+	description_type description() const override;
 
 	void start() override;
 	void reset() override;

SuperIDE/SuperIDE.cpp

@@ -26,7 +26,7 @@ This file is part of VCC (Virtual Color Computer).
 #include <vcc/common/FileOps.h>
 #include "../CartridgeMenu.h"
 #include <vcc/common/DialogOps.h>
-#include <vcc/core/legacy_cartridge_definitions.h>
+#include <vcc/core/cartridge_capi.h>
 #include <vcc/core/limits.h>
 
 static char FileName[MAX_PATH] { 0 };
@@ -100,7 +100,7 @@ extern "C"
 	__declspec(dllexport) void PakInitialize(
 		void* const host_key,
 		const char* const configuration_path,
-		const cpak_cartridge_context* const context)
+		const cartridge_capi_context* const context)
 	{
 		gHostKeyPtr = host_key;
 		CartMenuCallback = context->add_menu_item;

acia/acia.cpp

@@ -121,7 +121,7 @@ extern "C"
 	__declspec(dllexport) void PakInitialize(
 		void* const host_key,
 		const char* const configuration_path,
-		const cpak_cartridge_context* const context)
+		const cartridge_capi_context* const context)
 	{
 		gHostKeyPtr = host_key;
 		CartMenuCallback = context->add_menu_item;