Z991239-515 #comment 将测试实体移到test目录下；添加硬件实体基类

Common/ErrorCode.h

@@ -8,14 +8,14 @@ enum ErrorCodeEnum
 {
 	Error_Succeed=0,
 	
-	//date check's category
+	//data check's category
 	Error_DataCheck=100,		//mark the beginning for this category
-	Error_Null,					//the error of a null pointer
-	Error_Param,				//the error of a illegal parameter
-	Error_Overflow,				//The length or range overflow
-	Error_TooSmallBuffer,		// buffer too small
-	Error_NotIntegrated,		//The package or result is not intergrated
-	Error_CheckSum,				//Check sum is not the same
+	Error_Null,					        //the error of a null pointer
+	Error_Param,				        //the error of a illegal parameter
+	Error_Overflow,				    //The length or range overflow
+	Error_TooSmallBuffer,		   // buffer too small
+	Error_NotIntegrated,		    //The package or result is not intergrated
+	Error_CheckSum,				   //Check sum is not the same
 
 	//Target being's category
 	Error_TargetBeing=0x200,		
@@ -31,6 +31,7 @@ enum ErrorCodeEnum
 	Error_BridgeNotBind,	    // bridge bind indication
 	Error_BridgeNotOK,		    // try bridge fail
 	Error_NotSupport,          // don't support the request
+	Error_NotConfig,                /** The dream configuration is unsettled*/
 
 	//Entity state's category
 	Error_InvalidState=0x300,	//state is not valid for current call
@@ -95,7 +96,7 @@ enum ErrorCodeEnum
 	Error_Resource,				//The system resource ec:memory/handle/space,do not retry,should restart system
 	Error_NewProcess,			//start process failed
 	Error_FailVerify,			//Signature verification failed of entity
-	Error_Block,				//The thread block and the module hold
+	Error_Block,				    //The thread block and the module hold
 	Error_Exception,			//except throw
 	Error_Unexpect=0x7ffffffe,	//the fail reason is not expect
 

module/CMakeLists.txt

@@ -5,9 +5,6 @@ macro(define_moudle _module_name)
 	string(TOUPPER "MOD_${MODULE_NAME}" MODULE_PREFIX)
 endmacro(define_moudle)
 
-#macro(add_module _module_prefix _module_name)
-#endmacro(add_module)
-
 #对于 Windows 设置实体的版本信息
 #定义共享库输出
 macro(add_module_libraries _module_prefix _module_name _module_version)
@@ -70,25 +67,9 @@ macro(deploy_module _module_prefix _module_name)
     set_property(TARGET ${_module_name} PROPERTY FOLDER "module/")
 endmacro(deploy_module)
 
-#set(${MODULE_PREFIX}_LIBS ${${MODULE_PREFIX}_LIBS} freerdp-client)
-#set(${MODULE_PREFIX}_LIBS ${${MODULE_PREFIX}_LIBS} winpr freerdp)
-#set(${MODULE_PREFIX}_LIBS ${${MODULE_PREFIX}_LIBS} msimg32)
-#target_link_libraries(${MODULE_NAME} ${${MODULE_PREFIX}_LIBS})
 set(MODULE_BASE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 # 遍历实体
-# file(GLOB module_dirs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} "${CMAKE_CURRENT_SOURCE_DIR}/*")
-# set(module_list "")
-# foreach(module_dir ${module_dirs})
-#   if(IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${module_dir})
-#        list(APPEND module_list ${module_dir})
-#    endif()
-#endforeach()
-#foreach(module ${module_list})
-#    message(STATUS  "add module ${module}...")
-#    add_subdirectory(${module})
-#endforeach()
-
 file(GLOB all_valid_subdirs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} "*/CMakeLists.txt")
 
 foreach(dir ${all_valid_subdirs})

module/include/mod_DevAdptEntityBase.hpp

@@ -0,0 +1,197 @@
+#ifndef _RVC_DEVICE_ADAPTER_ENTITY_BASE_H__
+#define _RVC_DEVICE_ADAPTER_ENTITY_BASE_H__
+
+#pragma once
+
+#include "SpHelper.h"
+#include "DeviceBaseClass.h"
+
+#define SAFE_FREE_LIBRARY(hModule)	\
+	do {							\
+	if(hModule){					\
+	FreeLibrary(hModule);		\
+	hModule = NULL;				\
+	}							\
+	}while(0)
+
+using DevAdaptObjCreateFunc = ErrorCodeEnum(*)(DWORD dwDevClassID, DeviceBaseClass * &pOutDevAptObj);
+using DevAdaptObjReleaseFunc = ErrorCodeEnum(*)(DWORD dwDevClassID, DeviceBaseClass * &pInDevAptObj);
+
+template <typename TSubAdpt>
+struct DevAdptLibHelper
+{
+	ErrorCodeEnum LoadLibAddress(const CSimpleStringA& strFullLibPath)
+	{
+		ErrorCodeEnum erroCode = Error_Succeed;
+
+		do 
+		{
+			hModule = LoadLibraryA(strFullLibPath);
+			if (hModule == NULL) {
+				DWORD tmpError = GetLastError();
+				Dbg("LoadLibraryA[%s] failed with error %u.", strFullLibPath, tmpError);
+				if (tmpError == 126) {
+					Dbg("该问题是缺失某个DLL导致的错误。");
+					SetLastError(126);
+				}
+				erroCode = Error_DevLoadFileFailed;
+				break;
+			}
+
+			if ((pFuncCreateAdapt = (DevAdaptObjCreateFunc)GetProcAddress(hModule,
+				"CreateDevComponent")) == NULL) {
+				//TODO: SetCustLastErrorCode();
+				Dbg("Get 'CreateDevComponent' Func address failed with code %d", GetLastError());
+				erroCode = Error_DevLoadFileFailed;
+				break;
+			}
+			if ((pFuncReleaseAdapt = (DevAdaptObjReleaseFunc)GetProcAddress(hModule,
+				"ReleaseDevComponent")) == NULL) {
+				Dbg("Get 'ReleaseDevComponent' Func address failed with code %d", GetLastError());
+				erroCode = Error_DevLoadFileFailed;
+				break;
+			}
+
+		} while (false);
+
+		if (IS_FAILURED(erroCode)) {
+			TearDown();
+		}
+
+		return erroCode;
+	}
+
+	ErrorCodeEnum CreateDevAdptObject()
+	{
+		if (m_AdptObjPtr != nullptr) {
+			return Error_AlreadyExist;
+		}
+		if (hModule == nullptr || pFuncCreateAdapt == nullptr || pFuncReleaseAdapt == nullptr) {
+			return Error_NotInit;
+		}
+
+		ErrorCodeEnum erroCode = Error_Succeed;
+		erroCode = pFuncCreateAdapt((DeviceBaseClass*&)m_AdptObjPtr);
+		if (IS_FAILURED(erroCode)) {
+			Dbg("Create device adapter object failed! EC=%s", SpStrError(erroCode));
+			return erroCode;
+		}
+
+		LOG_ASSERT(m_AdptObjPtr != nullptr);
+
+		return Error_Succeed;
+	}
+
+	ErrorCodeEnum TearDown()
+	{
+		if (m_AdptObjPtr != nullptr) {
+			m_AdptObjPtr->DevClose();
+		}
+		if (m_AdptObjPtr != nullptr && nullptr != pFuncReleaseAdapt) {
+			pFuncReleaseAdapt(0, m_AdptObjPtr);
+			m_AdptObjPtr = nullptr;
+		}
+		SAFE_FREE_LIBRARY(hModule);
+	}
+
+	TSubAdpt* operator ->() { return m_AdptObjPtr; }
+
+	DevAdptLibHelper()
+		:hModule(nullptr)
+		, pFuncCreateAdapt(nullptr), pFuncReleaseAdapt(nullptr)
+		, m_AdptObjPtr(nullptr)
+	{
+
+	}
+
+private:
+
+	HMODULE hModule;
+	DevAdaptObjCreateFunc pFuncCreateAdapt;
+	DevAdaptObjReleaseFunc pFuncReleaseAdapt;
+
+	TSubAdpt* m_AdptObjPtr;
+};
+
+
+class CDevAdptEntityBase : public CEntityBase
+{
+
+public:
+
+	CDevAdptEntityBase() :m_strLibName(true) {}
+
+	CSimpleStringA GetVendorLibName()
+	{
+		if (m_strLibName.IsNullOrEmpty()) {
+			ExtractVendorLibName(m_strLibName);
+		}
+		return m_strLibName;
+	}
+
+	ErrorCodeEnum ExtractVendorLibFullPath(CSimpleStringA& csLibFullPath);
+
+private:
+
+	ErrorCodeEnum ExtractVendorLibName(CSimpleStringA& csLibName);
+
+private:
+
+	CSimpleStringA m_strLibName;
+};
+
+ErrorCodeEnum CDevAdptEntityBase::ExtractVendorLibName(CSimpleStringA& csLibName)
+{
+	CSmartPointer<IConfigInfo> spRootConfig;
+	ErrorCodeEnum erroCode = GetFunction()->OpenConfig(Config_Root, spRootConfig);
+
+	if (IS_SUCCEED(erroCode)) {
+		CSimpleStringA strSection = CSimpleStringA("Device.") + GetEntityName();
+		csLibName = GetEntityBase()->GetEntityName();
+		CSimpleStringA str;
+		spRootConfig->ReadConfigValue(strSection, "Vendor", str);
+		if (!str.IsNullOrEmpty()) {
+			csLibName += ".";
+			csLibName += str;
+		} else {
+			erroCode = Error_NotConfig;
+		}
+
+		str.Clear();
+		spRootConfig->ReadConfigValue(strSection, "Version", str);
+		if (!str.IsNullOrEmpty()) {
+			csLibName += ".";
+			csLibName += str;
+		}
+
+		str.Clear();
+		spRootConfig->ReadConfigValue(strSection, "Batch", str);
+		if (!str.IsNullOrEmpty()) {
+			csLibName += ".";
+			csLibName += str;
+		}
+
+		str = csLibName + ".dll";
+		csLibName = str;
+	}
+	else {
+		//TODO: SetCustLastErrorCode();
+	}
+	return erroCode;
+}
+
+ErrorCodeEnum CDevAdptEntityBase::ExtractVendorLibFullPath(CSimpleStringA& csLibFullPath)
+{
+	CSimpleStringA strLibName = GetVendorLibName();
+	if (strLibName.IsNullOrEmpty()) {
+		return Error_Unexpect;
+	}
+	
+	CSimpleStringA strDepPath;
+	GetFunction()->GetPath("Dep", strDepPath);
+	csLibFullPath = CSimpleStringA::Format("%s\\%s", (LPCTSTR)strDepPath, (LPCTSTR)strLibName);
+
+	return Error_Succeed;
+}
+
+#endif /*_RVC_DEVICE_ADAPTER_ENTITY_BASE_H__*/

module/module_list.md

@@ -1,8 +0,0 @@
-* **mod_blackSheep**:专用于启动失败
-* **mod_helloservice**:服务端，与*mod_helloservice*通信
-* **mod_helloclient**:客户端，与*mod_helloservice*通信
-* **mod_sample**: 测试*xml*支持的所有接口，测试状态机
-* **mod_testNormalEntity**:测试常规实体的接口
-* **mod_testPrivilegeEntity**:测试高权限实体的接口
-* **mod_testPassiveEntity**:被*mod_testPrivilegeEntity*直接启动的实体；测试多个实体声明在同一模块中
-* **mod_testSubscribe**:测试框架提供的订阅功能，包括各等级的日志事件，系统变量，实体生命周期

spbase/SpBase.cpp

@@ -463,6 +463,7 @@ on_error:
 	MAP(Error_TooSmallBuffer, "Error_TooSmallBuffer")	\
 	MAP(Error_NotIntegrated, "Error_NotIntegrated")	\
 	MAP(Error_CheckSum, "Error_CheckSum")	\
+    MAP(Error_NotConfig, "Error_NotConfig")	\
 	MAP(Error_TargetBeing, "Error_TargetBeing")	\
 	MAP(Error_NoTarget, "Error_NoTarget")	\
 	MAP(Error_NoDefine, "Error_NoDefine")	\

test/CMakeLists.txt

@@ -1 +1 @@
-# add_subdirectory(module)
+add_subdirectory(module)

test/module/CMakeLists.txt

@@ -0,0 +1,87 @@
+
+#设置实体名称 ${MODULE_NAME}，和实体前缀定义 ${MODULE_PREFIX}
+macro(define_moudle _module_name)
+	set(MODULE_NAME "mod_${_module_name}")
+	string(TOUPPER "MOD_${MODULE_NAME}" MODULE_PREFIX)
+endmacro(define_moudle)
+
+#macro(add_module _module_prefix _module_name)
+#endmacro(add_module)
+
+#对于 Windows 设置实体的版本信息
+#定义共享库输出
+macro(add_module_libraries _module_prefix _module_name _module_version)
+    
+    string(STRIP ${_module_version} RAW_VERSION_STRING)
+    set(VERSION_REGEX "^.?([0-9]+)\\.([0-9]+)\\.([0-9]+)-?(.*)")
+    string(REGEX REPLACE "${VERSION_REGEX}" "\\1" MOD_VERSION_MAJOR "${RAW_VERSION_STRING}")
+    string(REGEX REPLACE "${VERSION_REGEX}" "\\2" MOD_VERSION_MINOR "${RAW_VERSION_STRING}")
+    string(REGEX REPLACE "${VERSION_REGEX}" "\\3" MOD_VERSION_REVISION "${RAW_VERSION_STRING}")
+    string(REGEX REPLACE "${VERSION_REGEX}" "\\4" MOD_VERSION_SUFFIX "${RAW_VERSION_STRING}")
+
+    set(MOD_VERSION "${MOD_VERSION_MAJOR}.${MOD_VERSION_MINOR}.${MOD_VERSION_REVISION}")
+    set(MOD_API_VERSION "${MOD_VERSION_MAJOR}")
+    if (MOD_VERSION_SUFFIX)
+	    set(MOD_VERSION_FULL "${MOD_VERSION}-${MOD_VERSION_SUFFIX}")
+    else()
+	    set(MOD_VERSION_FULL "${MOD_VERSION}")
+    endif()
+
+	if(WIN32)
+	    set (RC_VERSION_MAJOR ${RVC_VERSION_MAJOR})
+        set (RC_VERSION_MINOR ${MOD_VERSION_MAJOR})
+        set (RC_VERSION_BUILD   ${MOD_VERSION_MINOR})
+        set (RC_VERSION_PATCH ${MOD_VERSION_REVISION})
+        set(RC_VERSION_DESCRIPTION "${CMAKE_SHARED_LIBRARY_PREFIX}${_module_name}_${MOD_VERSION_FULL}${CMAKE_SHARED_LIBRARY_SUFFIX}")
+       configure_file(
+        ${CMAKE_SOURCE_DIR}/Version.rc.in
+        ${CMAKE_CURRENT_BINARY_DIR}/version.rc
+        @ONLY)
+        set(${_module_prefix}_SRCS ${${_module_prefix}_SRCS} ${CMAKE_CURRENT_BINARY_DIR}/version.rc)
+    endif(WIN32)
+
+    add_library(${_module_name} SHARED ${${_module_prefix}_SRCS})
+    
+    target_include_directories(${_module_name} PRIVATE ${MODULE_BASE_DIR}/include)
+    
+    configure_file("${MODULE_BASE_DIR}/include/modVer.h.in" "${CMAKE_CURRENT_BINARY_DIR}/modVer.h")
+    target_include_directories(${_module_name} PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
+
+    # 设置工程输出路径
+    if(SIMULATE_DEV_AND_TEST_TEMP)
+        set_target_properties(${_module_name} 
+        PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/run/version/1.2.3.4/mod")
+    endif(SIMULATE_DEV_AND_TEST_TEMP)
+endmacro(add_module_libraries)
+
+# 设置实体的安装拷贝路径
+# 对于 Windows 设置实体项目工程在解决方案的节点
+macro(deploy_module _module_prefix _module_name)
+    install(TARGETS ${_module_name} 
+    RUNTIME DESTINATION "${RVC_MODULE_PATH}"
+    ARCHIVE DESTINATION "${RVC_LIBRARY_PATH}"
+    LIBRARY DESTINATION "${RVC_LIBRARY_PATH}"
+    COMPONENT modules)
+
+    if (WITH_DEBUG_SYMBOLS AND MSVC AND BUILD_SHARED_LIBS)
+        install(FILES ${CMAKE_PDB_BINARY_DIR}/${_module_name}.pdb DESTINATION ${CMAKE_INSTALL_BINDIR} COMPONENT symbols)
+    endif()
+
+    set_property(TARGET ${_module_name} PROPERTY FOLDER "test/module/")
+endmacro(deploy_module)
+
+set(MODULE_BASE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
+
+# 遍历实体
+file(GLOB all_valid_subdirs RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} "*/CMakeLists.txt")
+
+foreach(dir ${all_valid_subdirs})
+	if(${dir} MATCHES "^([^/]*)/+CMakeLists.txt")
+		string(REGEX REPLACE "^([^/]*)/+CMakeLists.txt" "\\1" dir_trimmed ${dir})
+		message(STATUS "add test module ${dir_trimmed}")
+		add_subdirectory(${dir_trimmed})
+	endif()
+endforeach(dir)
+
+
+

test/module/include/modVer.h.in

@@ -0,0 +1,13 @@
+#ifndef MODULE_VERSION_H
+#define MODULE_VERSION_H
+
+#define MODULE_VERSION_MAJOR ${MOD_VERSION_MAJOR}
+#define MODULE_VERSION_MINOR ${MOD_VERSION_MINOR}
+#define MODULE_VERSION_REVISION ${MOD_VERSION_REVISION}
+#define MODULE_VERSION_SUFFIX "${MOD_VERSION_SUFFIX}"
+
+#define MODULE_API_VERSION "${MOD_API_VERSION}"
+#define MODULE_VERSION "${MOD_VERSION}"
+#define MODULE_VERSION_FULL "${MOD_VERSION_FULL}"
+
+#endif /* MODULE_VERSION_H */

test/module/module_list.md

@@ -0,0 +1,8 @@
+* **mod_blackSheep**:专用于启动失败
+* **mod_helloservice**:服务端，与*mod_helloservice*通信
+* **mod_helloclient**:客户端，与*mod_helloservice*通信
+* **mod_sample**: 测试*xml*支持的所有接口，测试状态机
+* **mod_testNormalEntity**:测试常规实体的接口
+* **mod_testPrivilegeEntity**:测试高权限实体的接口
+* **mod_testPassiveEntity**:被*mod_testPrivilegeEntity*直接启动的实体；测试多个实体声明在同一模块中
+* **mod_testSubscribe**:测试框架提供的订阅功能，包括各等级的日志事件，系统变量，实体生命周期