Merge pull request VCCE#485 from ejaquay/sdcrefact

Beginings of SDC code clean up and refactor

Author: ejaquay

becker/becker_cartridge.cpp

@@ -1,17 +1,17 @@
 ////////////////////////////////////////////////////////////////////////////////
 //	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/>.
 ////////////////////////////////////////////////////////////////////////////////
@@ -21,6 +21,7 @@
 #include <vcc/utils/configuration_serializer.h>
 #include "../CartridgeMenu.h"
 
+// Contains Becker cart exports
 
 becker_cartridge::becker_cartridge(std::unique_ptr<context_type> context, HINSTANCE module_instance)
 	:
@@ -48,13 +49,16 @@ becker_cartridge::description_type becker_cartridge::description() const
 
 void becker_cartridge::start()
 {
+
+//  Load becker config
 	::vcc::utils::configuration_serializer serializer(context_->configuration_path());
 
 	gBecker.sethost(
 		serializer.read(configuration_section_id_, "DWServerAddr", "127.0.0.1").c_str(),
 		serializer.read(configuration_section_id_, "DWServerPort", "65504").c_str());
 	gBecker.enable(true);
 
+//  Create dynamic menu
 	build_menu();
 }
 
@@ -80,7 +84,7 @@ unsigned char becker_cartridge::read_port(unsigned char port_id)
 	{
 	case 0x41:	// read status
 		return gBecker.read(port_id) != 0 ? 2 : 0;
-		
+
 	case 0x42:	// read data
 		return gBecker.read(port_id);
 	}
@@ -122,6 +126,7 @@ becker_cartridge::string_type becker_cartridge::server_port() const
 	return gBecker.server_port();
 }
 
+// Save becker config
 void becker_cartridge::configure_server(string_type server_address, string_type server_port)
 {
 	gBecker.sethost(server_address.c_str(), server_port.c_str());

becker/configuration_dialog.cpp

@@ -123,6 +123,7 @@ INT_PTR configuration_dialog::process_message(
 		switch (LOWORD(wParam))
 		{
 		case IDOK:
+			// Save config dialog data
 			controller_.configure_server(
 				::vcc::utils::get_dialog_item_text(hDlg, IDC_TCPHOST),
 				::vcc::utils::get_dialog_item_text(hDlg, IDC_TCPPORT));

becker/main.cpp

@@ -22,7 +22,7 @@
 
 static HINSTANCE gModuleInstance;
 
-
+// Becker dll main
 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved)
 {
 	if (fdwReason == DLL_PROCESS_ATTACH)
@@ -33,7 +33,7 @@ BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpReserved)
 	return true;
 }
 
-
+// Establish Becker cart exports
 extern "C" __declspec(dllexport) CreatePakFactoryFunction GetPakFactory()
 {
 	return [](

libcommon/include/vcc/utils/configuration_serializer.h

@@ -15,10 +15,18 @@
 //	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>
 
+// The configuration_serializer class reads or writes VCC settings kept in the
+// VCC initialization file (typically vcc.ini)
+//
+// In programming, a serializer is a mechanism or tool used to convert a complex
+// data structure or object into a format that can be easily stored, transmitted,
+// or reconstructed later. This class barely meets that definition. It might be
+// better named "settings_manager" or just "Settings".
 
 namespace vcc::utils
 {

libcommon/include/vcc/utils/winapi.h

@@ -20,6 +20,7 @@
 #include <Windows.h>
 #include <string>
 
+// returns resource strings
 
 namespace vcc::utils
 {

libcommon/src/utils/configuration_serializer.cpp

@@ -18,6 +18,8 @@
 #include <vcc/utils/configuration_serializer.h>
 #include <Windows.h>
 
+// The configuration_serializer class reads or writes VCC configuration data from
+// the VCC initialization store (typically vcc.ini)
 
 namespace vcc::utils
 {

mpi/configuration_dialog.cpp

@@ -155,7 +155,7 @@ void configuration_dialog::update_slot_details(slot_id_type slot)
 		gSlotUiElementIds[slot].insert_button_id,
 		WM_SETTEXT,
 		0,
-		reinterpret_cast<LPARAM>(mpi_.empty(slot) ? "..." : "X"));
+		reinterpret_cast<LPARAM>(mpi_.empty(slot) ? ">" : "X"));
 }
 
 

mpi/mpi.rc

@@ -78,7 +78,7 @@ BEGIN
     EDITTEXT        IDC_MODINFO,        175,8,118,115, ES_MULTILINE|ES_READONLY|ES_WANTRETURN
 
 	LTEXT "Radio button selects startup slot.", IDC_STATIC, 10,128,105,10
-	LTEXT "...  Mount cartridge.", IDC_STATIC, 125,128,90,10
+	LTEXT ">  Mount cartridge.", IDC_STATIC, 125,128,90,10
 	LTEXT "X  Eject cartridge.", IDC_STATIC, 215,128,60,10
 
 //    CHECKBOX        "Persistent ProgramPak Images",IDC_PERSIST_PAK,   15,165,110,10

sdc/sdc.h

@@ -96,11 +96,14 @@
     </Link>
   </ItemDefinitionGroup>
   <ItemGroup>
-    <ClCompile Include="sdc.cpp" />
+    <ClCompile Include="sdc_dllmain.cpp" />
+    <ClCompile Include="sdc_cartridge.cpp" />
+    <ClCompile Include="sdc_configuration.cpp" />
   </ItemGroup>
   <ItemGroup>
-    <ClInclude Include="sdc.h" />
     <ClInclude Include="resource.h" />
+    <ClInclude Include="sdc_cartridge.h" />
+    <ClInclude Include="sdc_configuration.h" />
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="sdc.rc" />
@@ -113,4 +116,4 @@
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
   <ImportGroup Label="ExtensionTargets">
   </ImportGroup>
-</Project>
+</Project>