diff --git a/CMake/mitkFunctionOrganizeSources.cmake b/CMake/mitkFunctionOrganizeSources.cmake index 30de7c7172..6be5c007ca 100644 --- a/CMake/mitkFunctionOrganizeSources.cmake +++ b/CMake/mitkFunctionOrganizeSources.cmake @@ -1,64 +1,69 @@ function(ORGANIZE_SOURCES) # this functions gets a filelist as input and looks # for corresponding h-files to add them to the project. # additionally files are grouped in source-groups. # No parameters explicitly declared here, because # we want to allow for variable argument lists, which # are later access by the keyword foreach(MYFILE ${ARGV}) # output: after calling the macro, files that were found # correspondigly to the given files are stored in the # variable: # ${CORRESPONDING_H_FILES} # ${CORRESPONDING_TXX_FILES} # ${CORRESPONDING_UI_H_FILES} # Globbed can be found in the variables # ${GLOBBED_TXX_FILES} (CURRENTLY COMMENTED OUT) # ${GLOBBED_DOX_FILES} MACRO_PARSE_ARGUMENTS(_ORG "HEADER;SOURCE;TXX;DOC;MOC;GEN_QRC;GEN_UI;UI;QRC" "" ${ARGN}) set(CORRESPONDING__H_FILES "" ) set(GLOBBED__H_FILES "" ) if(_ORG_HEADER) foreach(_file ${_ORG_SOURCE}) string(REGEX REPLACE "(.*)\\.(txx|cpp|c|cxx)$" "\\1.h" H_FILE ${_file}) if(EXISTS ${H_FILE}) list(APPEND CORRESPONDING__H_FILES "${H_FILE}") endif() endforeach() else() file(GLOB_RECURSE GLOBBED__H_FILES *.h) endif() if(_ORG_GEN_QRC OR _ORG_GEN_UI OR _ORG_MOC) source_group("Generated\\Qt QRC Source Files" FILES ${_ORG_GEN_QRC}) source_group("Generated\\Qt UI Header Files" FILES ${_ORG_GEN_UI}) source_group("Generated\\Qt MOC Source Files" FILES ${_ORG_MOC}) endif() #_MACRO_APPEND_TO_LIST(_ORG_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}/") source_group("== Source Files ==" FILES ${_ORG_SOURCE}) #_MACRO_APPEND_TO_LIST(_ORG_TXX "${CMAKE_CURRENT_SOURCE_DIR}/") source_group("== Template Files ==" FILES ${_ORG_TXX}) #_MACRO_APPEND_TO_LIST(_ORG_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/") source_group("== Header Files ==" FILES ${_ORG_HEADER} ${_ORG_HEADER} ${CORRESPONDING__H_FILES} ${GLOBBED__H_FILES}) + if(_ORG_UI) + #_MACRO_APPEND_TO_LIST(_ORG_UI "${CMAKE_CURRENT_SOURCE_DIR}/") + source_group("QT UI Files" FILES ${_ORG_UI}) + endif() - #_MACRO_APPEND_TO_LIST(_ORG_UI "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("QT UI Files" FILES ${_ORG_UI}) - - #_MACRO_APPEND_TO_LIST(_ORG_DOC "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("Doxygen Files" FILES ${_ORG_DOC}) + if(_ORG_DOC) + #_MACRO_APPEND_TO_LIST(_ORG_DOC "${CMAKE_CURRENT_SOURCE_DIR}/") + source_group("Doxygen Files" FILES ${_ORG_DOC}) + endif() - #_MACRO_APPEND_TO_LIST(_ORG_QRC "${CMAKE_CURRENT_SOURCE_DIR}/") - source_group("Qt Resource Files" FILES ${_ORG_QRC}) + if(_ORG_QRC) + #_MACRO_APPEND_TO_LIST(_ORG_QRC "${CMAKE_CURRENT_SOURCE_DIR}/") + source_group("Qt Resource Files" FILES ${_ORG_QRC}) + endif() endfunction(ORGANIZE_SOURCES) diff --git a/CMake/mitkMacroCreateModule.cmake b/CMake/mitkMacroCreateModule.cmake index 96c8c8facb..87f3707a6e 100644 --- a/CMake/mitkMacroCreateModule.cmake +++ b/CMake/mitkMacroCreateModule.cmake @@ -1,392 +1,367 @@ ################################################################## # # MITK_CREATE_MODULE # #! Creates a module for the automatic module dependency system within MITK. #! Configurations are generated in the moduleConf directory. #! #! USAGE: #! #! \code #! MITK_CREATE_MODULE( #! [INCLUDE_DIRS ] #! [INTERNAL_INCLUDE_DIRS ] #! [DEPENDS ] #! [PACKAGE_DEPENDS ] #! [TARGET_DEPENDS #! [EXPORT_DEFINE ] #! [QT_MODULE] #! [HEADERS_ONLY] #! [WARNINGS_AS_ERRORS] #! \endcode #! #! \param MODULE_NAME_IN The name for the new module #! \param HEADERS_ONLY specify this if the modules just contains header files. ################################################################## macro(MITK_CREATE_MODULE MODULE_NAME_IN) set(_macro_params SUBPROJECTS # list of CDash labels VERSION # module version number, e.g. "1.2.0" INCLUDE_DIRS # exported include dirs (used in mitkMacroCreateModuleConf.cmake) INTERNAL_INCLUDE_DIRS # include dirs internal to this module DEPENDS # list of modules this module depends on DEPENDS_INTERNAL # list of modules this module internally depends on PACKAGE_DEPENDS # list of "packages this module depends on (e.g. Qt, VTK, etc.) TARGET_DEPENDS # list of CMake targets this module should depend on EXPORT_DEFINE # export macro name for public symbols of this module AUTOLOAD_WITH # a module target name identifying the module which will trigger the # automatic loading of this module ADDITIONAL_LIBS # list of addidtional libraries linked to this module GENERATED_CPP # not used (?) ) set(_macro_options QT_MODULE # the module makes use of Qt features and needs moc and ui generated files FORCE_STATIC # force building this module as a static library HEADERS_ONLY # this module is a headers-only library GCC_DEFAULT_VISIBILITY # do not use gcc visibility flags - all symbols will be exported NO_INIT # do not create CppMicroServices initialization code WARNINGS_AS_ERRORS # treat all compiler warnings as errors ) MACRO_PARSE_ARGUMENTS(MODULE "${_macro_params}" "${_macro_options}" ${ARGN}) set(MODULE_NAME ${MODULE_NAME_IN}) if(MODULE_HEADERS_ONLY) set(MODULE_PROVIDES ) if(MODULE_AUTOLOAD_WITH) message(SEND_ERROR "A headers only module cannot be auto-loaded") endif() else() set(MODULE_PROVIDES ${MODULE_NAME}) if(NOT MODULE_NO_INIT AND NOT MODULE_NAME STREQUAL "Mitk") # Add a dependency to the "Mitk" module list(APPEND MODULE_DEPENDS Mitk) endif() endif() if(NOT MODULE_SUBPROJECTS) if(MITK_DEFAULT_SUBPROJECTS) set(MODULE_SUBPROJECTS ${MITK_DEFAULT_SUBPROJECTS}) endif() endif() # check if the subprojects exist as targets if(MODULE_SUBPROJECTS) foreach(subproject ${MODULE_SUBPROJECTS}) if(NOT TARGET ${subproject}) message(SEND_ERROR "The subproject ${subproject} does not have a corresponding target") endif() endforeach() endif() # check and set-up auto-loading if(MODULE_AUTOLOAD_WITH) if(NOT TARGET "${MODULE_AUTOLOAD_WITH}") message(SEND_ERROR "The module target \"${MODULE_AUTOLOAD_WITH}\" specified as the auto-loading module for \"${MODULE_NAME}\" does not exist") endif() # create a meta-target if it does not already exist set(_module_autoload_meta_target "${MODULE_AUTOLOAD_WITH}-universe") if(NOT TARGET ${_module_autoload_meta_target}) add_custom_target(${_module_autoload_meta_target}) endif() endif() # assume worst case set(MODULE_IS_ENABLED 0) # first we check if we have an explicit module build list if(MITK_MODULES_TO_BUILD) list(FIND MITK_MODULES_TO_BUILD ${MODULE_NAME} _MOD_INDEX) if(_MOD_INDEX EQUAL -1) set(MODULE_IS_EXCLUDED 1) endif() endif() - if(NOT MODULE_IS_EXCLUDED) + if(NOT MODULE_IS_EXCLUDED AND NOT (MODULE_QT_MODULE AND NOT MITK_USE_QT)) # first of all we check for the dependencies MITK_CHECK_MODULE(_MISSING_DEP ${MODULE_DEPENDS}) if(_MISSING_DEP) message("Module ${MODULE_NAME} won't be built, missing dependency: ${_MISSING_DEP}") set(MODULE_IS_ENABLED 0) else(_MISSING_DEP) set(MODULE_IS_ENABLED 1) # now check for every package if it is enabled. This overlaps a bit with # MITK_CHECK_MODULE ... foreach(_package ${MODULE_PACKAGE_DEPENDS}) if((DEFINED MITK_USE_${_package}) AND NOT (MITK_USE_${_package})) message("Module ${MODULE_NAME} won't be built. Turn on MITK_USE_${_package} if you want to use it.") set(MODULE_IS_ENABLED 0) endif() endforeach() if(MODULE_IS_ENABLED) - if(NOT MODULE_QT_MODULE OR MITK_USE_QT) - set(MODULE_IS_ENABLED 1) - _MITK_CREATE_MODULE_CONF() - if(NOT MODULE_EXPORT_DEFINE) - set(MODULE_EXPORT_DEFINE ${MODULE_NAME}_EXPORT) - endif(NOT MODULE_EXPORT_DEFINE) - - if(MITK_GENERATE_MODULE_DOT) - message("MODULEDOTNAME ${MODULE_NAME}") - foreach(dep ${MODULE_DEPENDS}) - message("MODULEDOT \"${MODULE_NAME}\" -> \"${dep}\" ; ") - endforeach(dep) - endif(MITK_GENERATE_MODULE_DOT) - - if(NOT MODULE_NO_INIT) - set(MODULE_LIBNAME ${MODULE_PROVIDES}) - - set(module_init_src_file) - usFunctionGenerateModuleInit(module_init_src_file - NAME ${MODULE_NAME} - LIBRARY_NAME ${MODULE_LIBNAME} - DEPENDS ${MODULE_DEPENDS} ${MODULE_DEPENDS_INTERNAL} ${MODULE_PACKAGE_DEPENDS} - #VERSION ${MODULE_VERSION} - ) + # clear variables defined in files.cmake + set(RESOURCE_FILES ) + set(CPP_FILES ) + set(H_FILES ) + set(TXX_FILES ) + set(DOX_FILES ) + set(UI_FILES ) + set(MOC_H_FILES ) + set(QRC_FILES ) + + # clear other variables + set(Q${KITNAME}_GENERATED_MOC_CPP ) + set(Q${KITNAME}_GENERATED_QRC_CPP ) + set(Q${KITNAME}_GENERATED_UI_CPP ) + + _MITK_CREATE_MODULE_CONF() + if(NOT MODULE_EXPORT_DEFINE) + set(MODULE_EXPORT_DEFINE ${MODULE_NAME}_EXPORT) + endif(NOT MODULE_EXPORT_DEFINE) + + if(MITK_GENERATE_MODULE_DOT) + message("MODULEDOTNAME ${MODULE_NAME}") + foreach(dep ${MODULE_DEPENDS}) + message("MODULEDOT \"${MODULE_NAME}\" -> \"${dep}\" ; ") + endforeach(dep) + endif(MITK_GENERATE_MODULE_DOT) + + set(DEPENDS "${MODULE_DEPENDS}") + set(DEPENDS_BEFORE "not initialized") + set(PACKAGE_DEPENDS "${MODULE_PACKAGE_DEPENDS}") + MITK_USE_MODULE("${MODULE_DEPENDS}") + + # ok, now create the module itself + include_directories(. ${ALL_INCLUDE_DIRECTORIES}) + include(files.cmake) + + set(module_compile_flags ) + if(WIN32) + set(module_compile_flags "${module_compile_flags} -DPOCO_NO_UNWINDOWS -DWIN32_LEAN_AND_MEAN") + endif() + + if(MODULE_GCC_DEFAULT_VISIBILITY) + set(use_visibility_flags 0) + else() + # We only support hidden visibility for gcc for now. Clang 3.0 still has troubles with + # correctly marking template declarations and explicit template instantiations as exported. + # See http://comments.gmane.org/gmane.comp.compilers.clang.scm/50028 + # and http://llvm.org/bugs/show_bug.cgi?id=10113 + if(CMAKE_COMPILER_IS_GNUCXX) + set(use_visibility_flags 1) + else() + # set(use_visibility_flags 0) endif() + endif() - set(DEPENDS "${MODULE_DEPENDS}") - set(DEPENDS_BEFORE "not initialized") - set(PACKAGE_DEPENDS "${MODULE_PACKAGE_DEPENDS}") - MITK_USE_MODULE("${MODULE_DEPENDS}") + if(CMAKE_COMPILER_IS_GNUCXX) + # MinGW does not export all symbols automatically, so no need to set flags. + # + # With gcc < 4.5, RTTI symbols from classes declared in third-party libraries + # which are not "gcc visibility aware" are marked with hidden visibility in + # DSOs which include the class declaration and which are compiled with + # hidden visibility. This leads to dynamic_cast and exception handling problems. + # While this problem could be worked around by sandwiching the include + # directives for the third-party headers between "#pragma visibility push/pop" + # statements, it is generally safer to just use default visibility with + # gcc < 4.5. + if(${GCC_VERSION} VERSION_LESS "4.5" OR MINGW) + set(use_visibility_flags 0) + endif() + endif() - # ok, now create the module itself - include_directories(. ${ALL_INCLUDE_DIRECTORIES}) - include(files.cmake) + if(use_visibility_flags) + mitkFunctionCheckCompilerFlags("-fvisibility=hidden" module_compile_flags) + mitkFunctionCheckCompilerFlags("-fvisibility-inlines-hidden" module_compile_flags) + endif() - set(module_compile_flags ) - if(WIN32) - set(module_compile_flags "${module_compile_flags} -DPOCO_NO_UNWINDOWS -DWIN32_LEAN_AND_MEAN") - endif() + configure_file(${MITK_SOURCE_DIR}/CMake/moduleExports.h.in ${CMAKE_BINARY_DIR}/${MODULES_CONF_DIRNAME}/${MODULE_NAME}Exports.h @ONLY) - if(MODULE_GCC_DEFAULT_VISIBILITY) - set(use_visibility_flags 0) + if(MODULE_WARNINGS_AS_ERRORS) + if(MSVC_VERSION) + mitkFunctionCheckCompilerFlags("/WX" module_compile_flags) else() - # We only support hidden visibility for gcc for now. Clang 3.0 still has troubles with - # correctly marking template declarations and explicit template instantiations as exported. - # See http://comments.gmane.org/gmane.comp.compilers.clang.scm/50028 - # and http://llvm.org/bugs/show_bug.cgi?id=10113 - if(CMAKE_COMPILER_IS_GNUCXX) - set(use_visibility_flags 1) - else() - # set(use_visibility_flags 0) - endif() - endif() + mitkFunctionCheckCompilerFlags("-Werror" module_compile_flags) - if(CMAKE_COMPILER_IS_GNUCXX) - # MinGW does not export all symbols automatically, so no need to set flags. + # The flag "c++0x-static-nonintegral-init" has been renamed in newer Clang + # versions to "static-member-init", see + # http://clang-developers.42468.n3.nabble.com/Wc-0x-static-nonintegral-init-gone-td3999651.html # - # With gcc < 4.5, RTTI symbols from classes declared in third-party libraries - # which are not "gcc visibility aware" are marked with hidden visibility in - # DSOs which include the class declaration and which are compiled with - # hidden visibility. This leads to dynamic_cast and exception handling problems. - # While this problem could be worked around by sandwiching the include - # directives for the third-party headers between "#pragma visibility push/pop" - # statements, it is generally safer to just use default visibility with - # gcc < 4.5. - if(${GCC_VERSION} VERSION_LESS "4.5" OR MINGW) - set(use_visibility_flags 0) - endif() - endif() + # Also, older Clang and seemingly all gcc versions do not warn if unknown + # "-no-*" flags are used, so CMake will happily append any -Wno-* flag to the + # command line. This may get confusing if unrelated compiler errors happen and + # the error output then additinally contains errors about unknown flags (which + # is not the case if there were no compile errors). + # + # So instead of using -Wno-* we use -Wno-error=*, which will be properly rejected by + # the compiler and if applicable, prints the specific warning as a real warning and + # not as an error (although -Werror was given). - if(use_visibility_flags) - mitkFunctionCheckCompilerFlags("-fvisibility=hidden" module_compile_flags) - mitkFunctionCheckCompilerFlags("-fvisibility-inlines-hidden" module_compile_flags) + mitkFunctionCheckCompilerFlags("-Wno-error=c++0x-static-nonintegral-init" module_compile_flags) + mitkFunctionCheckCompilerFlags("-Wno-error=gnu" module_compile_flags) + endif() + endif(MODULE_WARNINGS_AS_ERRORS) + + if(MODULE_FORCE_STATIC) + set(_STATIC STATIC) + else() + set(_STATIC ) + endif(MODULE_FORCE_STATIC) + + if(NOT MODULE_NO_INIT) + set(MODULE_LIBNAME ${MODULE_PROVIDES}) + + usFunctionGenerateModuleInit(CPP_FILES + NAME ${MODULE_NAME} + LIBRARY_NAME ${MODULE_LIBNAME} + DEPENDS ${MODULE_DEPENDS} ${MODULE_DEPENDS_INTERNAL} ${MODULE_PACKAGE_DEPENDS} + #VERSION ${MODULE_VERSION} + ) + + if(RESOURCE_FILES) + usFunctionEmbedResources(CPP_FILES + LIBRARY_NAME ${MODULE_LIBNAME} + ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/Resources + FILES ${RESOURCE_FILES}) endif() - configure_file(${MITK_SOURCE_DIR}/CMake/moduleExports.h.in ${CMAKE_BINARY_DIR}/${MODULES_CONF_DIRNAME}/${MODULE_NAME}Exports.h @ONLY) + endif() - if(MODULE_WARNINGS_AS_ERRORS) - if(MSVC_VERSION) - mitkFunctionCheckCompilerFlags("/WX" module_compile_flags) - else() - mitkFunctionCheckCompilerFlags("-Werror" module_compile_flags) - - # The flag "c++0x-static-nonintegral-init" has been renamed in newer Clang - # versions to "static-member-init", see - # http://clang-developers.42468.n3.nabble.com/Wc-0x-static-nonintegral-init-gone-td3999651.html - # - # Also, older Clang and seemingly all gcc versions do not warn if unknown - # "-no-*" flags are used, so CMake will happily append any -Wno-* flag to the - # command line. This may get confusing if unrelated compiler errors happen and - # the error output then additinally contains errors about unknown flags (which - # is not the case if there were no compile errors). - # - # So instead of using -Wno-* we use -Wno-error=*, which will be properly rejected by - # the compiler and if applicable, prints the specific warning as a real warning and - # not as an error (although -Werror was given). - - mitkFunctionCheckCompilerFlags("-Wno-error=c++0x-static-nonintegral-init" module_compile_flags) - mitkFunctionCheckCompilerFlags("-Wno-error=gnu" module_compile_flags) - endif() - endif(MODULE_WARNINGS_AS_ERRORS) + if(MODULE_QT_MODULE) + if(UI_FILES) + QT4_WRAP_UI(Q${KITNAME}_GENERATED_UI_CPP ${UI_FILES}) + endif(UI_FILES) - if(NOT MODULE_NO_INIT) - list(APPEND CPP_FILES ${module_init_src_file}) - endif() + if(MOC_H_FILES) + QT4_WRAP_CPP(Q${KITNAME}_GENERATED_MOC_CPP ${MOC_H_FILES}) + endif(MOC_H_FILES) - if(MODULE_FORCE_STATIC) - set(_STATIC STATIC) - else() - set(_STATIC ) - endif(MODULE_FORCE_STATIC) - - if(NOT MODULE_QT_MODULE) - ORGANIZE_SOURCES(SOURCE ${CPP_FILES} - HEADER ${H_FILES} - TXX ${TXX_FILES} - DOC ${DOX_FILES} - ) - - set(coverage_sources ${CPP_FILES} ${H_FILES} ${GLOBBED__H_FILES} ${CORRESPONDING__H_FILES} ${TXX_FILES} ${TOOL_CPPS}) - if(MODULE_SUBPROJECTS) - set_property(SOURCE ${coverage_sources} APPEND PROPERTY LABELS ${MODULE_SUBPROJECTS} MITK) - endif() + if(QRC_FILES) + QT4_ADD_RESOURCES(Q${KITNAME}_GENERATED_QRC_CPP ${QRC_FILES}) + endif(QRC_FILES) - if(NOT MODULE_HEADERS_ONLY) - if(ALL_LIBRARY_DIRS) - # LINK_DIRECTORIES applies only to targets which are added after the call to LINK_DIRECTORIES - link_directories(${ALL_LIBRARY_DIRS}) - endif(ALL_LIBRARY_DIRS) - add_library(${MODULE_PROVIDES} ${_STATIC} ${coverage_sources} ${CPP_FILES_GENERATED} ${DOX_FILES} ${UI_FILES}) - if(MODULE_TARGET_DEPENDS) - add_dependencies(${MODULE_PROVIDES} ${MODULE_TARGET_DEPENDS}) - endif() - if(MODULE_SUBPROJECTS) - set_property(TARGET ${MODULE_PROVIDES} PROPERTY LABELS ${MODULE_SUBPROJECTS} MITK) - foreach(subproject ${MODULE_SUBPROJECTS}) - add_dependencies(${subproject} ${MODULE_PROVIDES}) - endforeach() - endif() - if(ALL_LIBRARIES) - target_link_libraries(${MODULE_PROVIDES} ${ALL_LIBRARIES}) - endif(ALL_LIBRARIES) - - if(MINGW) - target_link_libraries(${MODULE_PROVIDES} ssp) # add stack smash protection lib - endif() - endif() + set(Q${KITNAME}_GENERATED_CPP ${Q${KITNAME}_GENERATED_CPP} ${Q${KITNAME}_GENERATED_UI_CPP} ${Q${KITNAME}_GENERATED_MOC_CPP} ${Q${KITNAME}_GENERATED_QRC_CPP}) + endif() - else(NOT MODULE_QT_MODULE) + ORGANIZE_SOURCES(SOURCE ${CPP_FILES} + HEADER ${H_FILES} + TXX ${TXX_FILES} + DOC ${DOX_FILES} + UI ${UI_FILES} + QRC ${QRC_FILES} + MOC ${Q${KITNAME}_GENERATED_MOC_CPP} + GEN_QRC ${Q${KITNAME}_GENERATED_QRC_CPP} + GEN_UI ${Q${KITNAME}_GENERATED_UI_CPP}) + + set(coverage_sources + ${CPP_FILES} ${H_FILES} ${GLOBBED__H_FILES} ${CORRESPONDING__H_FILES} ${TXX_FILES} + ${TOOL_CPPS} ${TOOL_GUI_CPPS}) + + if(MODULE_SUBPROJECTS) + set_property(SOURCE ${coverage_sources} APPEND PROPERTY LABELS ${MODULE_SUBPROJECTS} MITK) + endif() - include(files.cmake) - if(NOT MODULE_NO_INIT) - list(APPEND CPP_FILES ${module_init_src_file}) - endif() + if(NOT MODULE_HEADERS_ONLY) + if(ALL_LIBRARY_DIRS) + # LINK_DIRECTORIES applies only to targets which are added after the call to LINK_DIRECTORIES + link_directories(${ALL_LIBRARY_DIRS}) + endif(ALL_LIBRARY_DIRS) - if(UI_FILES) - QT4_WRAP_UI(Q${KITNAME}_GENERATED_UI_CPP ${UI_FILES}) - endif(UI_FILES) - - if(MOC_H_FILES) - QT4_WRAP_CPP(Q${KITNAME}_GENERATED_MOC_CPP ${MOC_H_FILES}) - endif(MOC_H_FILES) - - if(QRC_FILES) - QT4_ADD_RESOURCES(Q${KITNAME}_GENERATED_QRC_CPP ${QRC_FILES}) - endif(QRC_FILES) - - set(Q${KITNAME}_GENERATED_CPP ${Q${KITNAME}_GENERATED_CPP} ${Q${KITNAME}_GENERATED_UI_CPP} ${Q${KITNAME}_GENERATED_MOC_CPP} ${Q${KITNAME}_GENERATED_QRC_CPP}) - - ORGANIZE_SOURCES(SOURCE ${CPP_FILES} - HEADER ${H_FILES} - TXX ${TXX_FILES} - DOC ${DOX_FILES} - UI ${UI_FILES} - QRC ${QRC_FILES} - MOC ${Q${KITNAME}_GENERATED_MOC_CPP} - GEN_QRC ${Q${KITNAME}_GENERATED_QRC_CPP} - GEN_UI ${Q${KITNAME}_GENERATED_UI_CPP}) - - # MITK_GENERATE_TOOLS_LIBRARY(Qmitk${LIBPOSTFIX} "NO") - - set(coverage_sources ${CPP_FILES} ${CORRESPONDING__H_FILES} ${GLOBBED__H_FILES} ${TXX_FILES} ${TOOL_GUI_CPPS}) - set_property(SOURCE ${coverage_sources} APPEND PROPERTY LABELS ${MODULE_SUBPROJECTS}) - - if(NOT MODULE_HEADERS_ONLY) - if(ALL_LIBRARY_DIRS) - # LINK_DIRECTORIES applies only to targets which are added after the call to LINK_DIRECTORIES - link_directories(${ALL_LIBRARY_DIRS}) - endif(ALL_LIBRARY_DIRS) - add_library(${MODULE_PROVIDES} ${_STATIC} ${coverage_sources} ${CPP_FILES_GENERATED} ${Q${KITNAME}_GENERATED_CPP} ${DOX_FILES} ${UI_FILES} ${QRC_FILES}) - target_link_libraries(${MODULE_PROVIDES} ${QT_LIBRARIES} ${ALL_LIBRARIES}) - if(MODULE_TARGET_DEPENDS) - add_dependencies(${MODULE_PROVIDES} ${MODULE_TARGET_DEPENDS}) - endif() - if(MINGW) - target_link_libraries(${MODULE_PROVIDES} ssp) # add stack smash protection lib - endif() - if(MODULE_SUBPROJECTS) - set_property(TARGET ${MODULE_PROVIDES} PROPERTY LABELS ${MODULE_SUBPROJECTS} MITK) - foreach(subproject ${MODULE_SUBPROJECTS}) - add_dependencies(${subproject} ${MODULE_PROVIDES}) - endforeach() - endif() - endif() + add_library(${MODULE_PROVIDES} ${_STATIC} + ${coverage_sources} ${CPP_FILES_GENERATED} ${Q${KITNAME}_GENERATED_CPP} + ${DOX_FILES} ${UI_FILES} ${QRC_FILES}) - endif(NOT MODULE_QT_MODULE) + if(MODULE_TARGET_DEPENDS) + add_dependencies(${MODULE_PROVIDES} ${MODULE_TARGET_DEPENDS}) + endif() - if(NOT MODULE_HEADERS_ONLY) - # Apply properties to the module target. - set_target_properties(${MODULE_PROVIDES} PROPERTIES - COMPILE_FLAGS "${module_compile_flags}" - ) + if(MODULE_SUBPROJECTS) + set_property(TARGET ${MODULE_PROVIDES} PROPERTY LABELS ${MODULE_SUBPROJECTS} MITK) + foreach(subproject ${MODULE_SUBPROJECTS}) + add_dependencies(${subproject} ${MODULE_PROVIDES}) + endforeach() endif() - # install only if shared lib (for now) - if(NOT _STATIC OR MINGW) - if(NOT MODULE_HEADERS_ONLY) - # # deprecated: MITK_INSTALL_TARGETS(${MODULE_PROVIDES}) - endif() - endif(NOT _STATIC OR MINGW) + if(ALL_LIBRARIES) + target_link_libraries(${MODULE_PROVIDES} ${ALL_LIBRARIES}) + endif(ALL_LIBRARIES) - endif(NOT MODULE_QT_MODULE OR MITK_USE_QT) + if(MODULE_QT_MODULE AND QT_LIBRARIES) + target_link_libraries(${MODULE_PROVIDES} ${QT_LIBRARIES}) + endif() + + if(MINGW) + target_link_libraries(${MODULE_PROVIDES} ssp) # add stack smash protection lib + endif() + + # Apply properties to the module target. + set_target_properties(${MODULE_PROVIDES} PROPERTIES + COMPILE_FLAGS "${module_compile_flags}") - if(NOT MODULE_HEADERS_ONLY) # add the target name to a global property which is used in the top-level # CMakeLists.txt file to export the target set_property(GLOBAL APPEND PROPERTY MITK_MODULE_TARGETS ${MODULE_PROVIDES}) if(MODULE_AUTOLOAD_WITH) # for auto-loaded modules, adapt the output directory add_dependencies(${_module_autoload_meta_target} ${MODULE_PROVIDES}) if(WIN32) set(_module_output_prop RUNTIME_OUTPUT_DIRECTORY) else() set(_module_output_prop LIBRARY_OUTPUT_DIRECTORY) endif() set(_module_output_dir ${CMAKE_${_module_output_prop}}/${MODULE_AUTOLOAD_WITH}) get_target_property(_module_is_imported ${MODULE_AUTOLOAD_WITH} IMPORTED) if(NOT _module_is_imported) # if the auto-loading module is not imported, get its location # and put the auto-load module relative to it. get_target_property(_module_output_dir ${MODULE_AUTOLOAD_WITH} ${_module_output_prop}) set_target_properties(${MODULE_PROVIDES} PROPERTIES ${_module_output_prop} ${_module_output_dir}/${MODULE_AUTOLOAD_WITH}) else() set_target_properties(${MODULE_PROVIDES} PROPERTIES ${_module_output_prop} ${CMAKE_${_module_output_prop}}/${MODULE_AUTOLOAD_WITH}) endif() set_target_properties(${MODULE_PROVIDES} PROPERTIES MITK_AUTOLOAD_DIRECTORY ${MODULE_AUTOLOAD_WITH}) # add the auto-load module name as a property set_property(TARGET ${MODULE_AUTOLOAD_WITH} APPEND PROPERTY MITK_AUTOLOAD_TARGETS ${MODULE_PROVIDES}) else() # Add meta dependencies (e.g. on auto-load modules from depending modules) if(ALL_META_DEPENDENCIES) add_dependencies(${MODULE_PROVIDES} ${ALL_META_DEPENDENCIES}) endif() endif() endif() endif(MODULE_IS_ENABLED) endif(_MISSING_DEP) - endif(NOT MODULE_IS_EXCLUDED) + endif(NOT MODULE_IS_EXCLUDED AND NOT (MODULE_QT_MODULE AND NOT MITK_USE_QT)) if(NOT MODULE_IS_ENABLED) _MITK_CREATE_MODULE_CONF() endif(NOT MODULE_IS_ENABLED) endmacro(MITK_CREATE_MODULE) diff --git a/Core/Code/CppMicroServices/CMake/usCTestScript_custom.cmake b/Core/Code/CppMicroServices/CMake/usCTestScript_custom.cmake index 8b72a87caf..1a1faac564 100644 --- a/Core/Code/CppMicroServices/CMake/usCTestScript_custom.cmake +++ b/Core/Code/CppMicroServices/CMake/usCTestScript_custom.cmake @@ -1,25 +1,25 @@ find_program(CTEST_COVERAGE_COMMAND NAMES gcov) find_program(CTEST_MEMORYCHECK_COMMAND NAMES valgrind) find_program(CTEST_GIT_COMMAND NAMES git) set(CTEST_SITE "bigeye") set(CTEST_DASHBOARD_ROOT "/tmp") #set(CTEST_COMPILER "gcc-4.5") set(CTEST_CMAKE_GENERATOR "Unix Makefiles") set(CTEST_BUILD_FLAGS "-j") set(CTEST_BUILD_CONFIGURATION Debug) set(CTEST_PARALLEL_LEVEL 4) set(US_TEST_SHARED 1) set(US_TEST_STATIC 1) -set(US_SOURCE_DIR "/home/sascha/git/CppMicroServices") +set(US_SOURCE_DIR "${CMAKE_CURRENT_LIST_DIR}/../") set(US_BUILD_CONFIGURATION ) foreach(i RANGE 31) list(APPEND US_BUILD_CONFIGURATION ${i}) endforeach() include(${US_SOURCE_DIR}/CMake/usCTestScript.cmake) diff --git a/Core/Code/CppMicroServices/CMake/usCTestScript_travis.cmake b/Core/Code/CppMicroServices/CMake/usCTestScript_travis.cmake index c7a07722e0..1cd1030b3c 100644 --- a/Core/Code/CppMicroServices/CMake/usCTestScript_travis.cmake +++ b/Core/Code/CppMicroServices/CMake/usCTestScript_travis.cmake @@ -1,18 +1,18 @@ find_program(CTEST_COVERAGE_COMMAND NAMES gcov) find_program(CTEST_MEMORYCHECK_COMMAND NAMES valgrind) find_program(CTEST_GIT_COMMAND NAMES git) set(CTEST_SITE "travis-ci") set(CTEST_DASHBOARD_ROOT "/tmp") #set(CTEST_COMPILER "gcc-4.5") set(CTEST_CMAKE_GENERATOR "Unix Makefiles") set(CTEST_BUILD_FLAGS "-j") set(CTEST_BUILD_CONFIGURATION Release) -set(US_SOURCE_DIR "~/builds/saschazelzer/CppMicroServices") +set(US_SOURCE_DIR "${CMAKE_CURRENT_LIST_DIR}/../") set(US_BUILD_CONFIGURATION $ENV{BUILD_CONFIGURATION}) include(${US_SOURCE_DIR}/CMake/usCTestScript.cmake) diff --git a/Core/Code/CppMicroServices/CMake/usFunctionCheckCompilerFlags.cmake b/Core/Code/CppMicroServices/CMake/usFunctionCheckCompilerFlags.cmake index 8a3d1407d9..8e7e806576 100644 --- a/Core/Code/CppMicroServices/CMake/usFunctionCheckCompilerFlags.cmake +++ b/Core/Code/CppMicroServices/CMake/usFunctionCheckCompilerFlags.cmake @@ -1,53 +1,53 @@ # # Helper macro allowing to check if the given flags are supported # by the underlying build tool # # If the flag(s) is/are supported, they will be appended to the string identified by RESULT_VAR # # Usage: # usFunctionCheckCompilerFlags(FLAGS_TO_CHECK VALID_FLAGS_VAR) # # Example: # # set(myflags) # usFunctionCheckCompilerFlags("-fprofile-arcs" myflags) # message(1-myflags:${myflags}) # usFunctionCheckCompilerFlags("-fauto-bugfix" myflags) # message(2-myflags:${myflags}) # usFunctionCheckCompilerFlags("-Wall" myflags) # message(1-myflags:${myflags}) # # The output will be: # 1-myflags: -fprofile-arcs # 2-myflags: -fprofile-arcs # 3-myflags: -fprofile-arcs -Wall include(TestCXXAcceptsFlag) function(usFunctionCheckCompilerFlags CXX_FLAG_TO_TEST RESULT_VAR) if(CXX_FLAG_TO_TEST STREQUAL "") message(FATAL_ERROR "CXX_FLAG_TO_TEST shouldn't be empty") endif() set(_test_flag ${CXX_FLAG_TO_TEST}) CHECK_CXX_ACCEPTS_FLAG("-Werror=unknown-warning-option" HAS_FLAG_unknown-warning-option) if(HAS_FLAG_unknown-warning-option) set(_test_flag "-Werror=unknown-warning-option ${CXX_FLAG_TO_TEST}") endif() # Internally, the macro CMAKE_CXX_ACCEPTS_FLAG calls TRY_COMPILE. To avoid # the cost of compiling the test each time the project is configured, the variable set by # the macro is added to the cache so that following invocation of the macro with # the same variable name skip the compilation step. - # For that same reason, ctkFunctionCheckCompilerFlags function appends a unique suffix to + # For that same reason, usFunctionCheckCompilerFlags function appends a unique suffix to # the HAS_FLAG variable. This suffix is created using a 'clean version' of the flag to test. string(REGEX REPLACE "-\\s\\$\\+\\*\\{\\}\\(\\)\\#" "" suffix ${CXX_FLAG_TO_TEST}) CHECK_CXX_ACCEPTS_FLAG(${_test_flag} HAS_FLAG_${suffix}) if(HAS_FLAG_${suffix}) set(${RESULT_VAR} "${${RESULT_VAR}} ${CXX_FLAG_TO_TEST}" PARENT_SCOPE) endif() endfunction() diff --git a/Core/Code/CppMicroServices/CMake/usFunctionCreateTestModule.cmake b/Core/Code/CppMicroServices/CMake/usFunctionCreateTestModule.cmake index edae38c466..6317e5301b 100644 --- a/Core/Code/CppMicroServices/CMake/usFunctionCreateTestModule.cmake +++ b/Core/Code/CppMicroServices/CMake/usFunctionCreateTestModule.cmake @@ -1,33 +1,51 @@ macro(_us_create_test_module_helper) + if(_res_files) + usFunctionEmbedResources(_srcs LIBRARY_NAME ${name} ROOT_DIR ${_res_root} FILES ${_res_files}) + endif() + add_library(${name} ${_srcs}) if(NOT US_BUILD_SHARED_LIBS) set_property(TARGET ${name} APPEND PROPERTY COMPILE_DEFINITIONS US_STATIC_MODULE) endif() if(CMAKE_SYSTEM_PROCESSOR STREQUAL "x86_64") get_property(_compile_flags TARGET ${name} PROPERTY COMPILE_FLAGS) set_property(TARGET ${name} PROPERTY COMPILE_FLAGS "${_compile_flags} -fPIC") endif() target_link_libraries(${name} ${US_LINK_LIBRARIES}) if(NOT US_ENABLE_SERVICE_FACTORY_SUPPORT) target_link_libraries(${name} ${US_BASECLASS_LIBRARIES}) endif() set(_us_test_module_libs "${_us_test_module_libs};${name}" CACHE INTERNAL "" FORCE) endmacro() function(usFunctionCreateTestModuleWithAutoLoadDir name autoload_dir) set(_srcs ${ARGN}) usFunctionGenerateModuleInit(_srcs NAME "${name} Module" LIBRARY_NAME ${name} AUTOLOAD_DIR ${autoload_dir}) _us_create_test_module_helper() endfunction() function(usFunctionCreateTestModule name) set(_srcs ${ARGN}) + set(_res_files ) + usFunctionGenerateModuleInit(_srcs NAME "${name} Module" LIBRARY_NAME ${name}) + _us_create_test_module_helper() +endfunction() + +function(usFunctionCreateTestModuleWithResources name) + MACRO_PARSE_ARGUMENTS(US_TEST "SOURCES;RESOURCES;RESOURCES_ROOT" "" ${ARGN}) + set(_srcs ${US_TEST_SOURCES}) + set(_res_files ${US_TEST_RESOURCES}) + if (US_TEST_RESOURCES_ROOT) + set(_res_root ${US_TEST_RESOURCES_ROOT}) + else() + set(_res_root resources) + endif() usFunctionGenerateModuleInit(_srcs NAME "${name} Module" LIBRARY_NAME ${name}) _us_create_test_module_helper() endfunction() diff --git a/Core/Code/CppMicroServices/CMake/usFunctionEmbedResources.cmake b/Core/Code/CppMicroServices/CMake/usFunctionEmbedResources.cmake new file mode 100644 index 0000000000..28f6bd650f --- /dev/null +++ b/Core/Code/CppMicroServices/CMake/usFunctionEmbedResources.cmake @@ -0,0 +1,91 @@ +#! Embed resources into a shared library or executable. +#! +#! This CMake function uses an external command line program to generate a source +#! file containing data from external resources such as text files or images. The path +#! to the generated source file is appended to the \c src_var variable. +#! +#! Each module can call this function (at most once) to embed resources and make them +#! available at runtime through the Module class. Resources can also be embedded into +#! executables, using the EXECUTABLE_NAME argument instead of LIBRARY_NAME. +#! +#! Example usage: +#! \verbatim +#! set(module_srcs ) +#! usFunctionEmbedResources(module_srcs +#! LIBRARY_NAME "mylib" +#! ROOT_DIR resources +#! FILES config.properties logo.png +#! ) +#! +#! \param LIBRARY_NAME (required if EXECUTABLE_NAME is empty) The library name of the module +#! which will include the generated source file, without extension. +#! \param EXECUTABLE_NAME (required if LIBRARY_NAME is empty) The name of the executable +#! which will include the generated source file. +#! \param ROOT_DIR (optional) The root path for all resources listed after the FILES argument. +#! If no or a relative path is given, it is considered relativ to the current CMake source directory. +#! \param FILES (optional) A list of resources (paths to external files in the file system) relative +#! to the ROOT_DIR argument or the current CMake source directory if ROOT_DIR is empty. +#! +function(usFunctionEmbedResources src_var) + + MACRO_PARSE_ARGUMENTS(US_RESOURCE "LIBRARY_NAME;EXECUTABLE_NAME;ROOT_DIR;FILES" "" ${ARGN}) + + if(NOT src_var) + message(SEND_ERROR "Output variable name not specified.") + endif() + + if(US_RESOURCE_EXECUTABLE_NAME AND US_RESOURCE_LIBRARY_NAME) + message(SEND_ERROR "Only one of LIBRARY_NAME or EXECUTABLE_NAME can be specified.") + endif() + + if(NOT US_RESOURCE_LIBRARY_NAME AND NOT US_RESOURCE_EXECUTABLE_NAME) + message(SEND_ERROR "LIBRARY_NAME or EXECUTABLE_NAME argument not specified.") + endif() + + if(NOT US_RESOURCE_FILES) + message(WARNING "No FILES argument given. Skipping resource processing.") + return() + endif() + + if(NOT US_RESOURCE_ROOT_DIR) + set(US_RESOURCE_ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR}) + endif() + if(NOT IS_ABSOLUTE ${US_RESOURCE_ROOT_DIR}) + set(US_RESOURCE_ROOT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${US_RESOURCE_ROOT_DIR}") + endif() + if(NOT IS_DIRECTORY ${US_RESOURCE_ROOT_DIR}) + message(SEND_ERROR "The ROOT_DIR argument is not a directory: ${US_RESOURCE_ROOT_DIR}") + endif() + + set(absolute_res_files) + foreach(res_file ${US_RESOURCE_FILES}) + set(res_file "${US_RESOURCE_ROOT_DIR}/${res_file}") + if(IS_DIRECTORY ${res_file}) + message(SEND_ERROR "A resource cannot be a directory: ${res_file}") + endif() + if(NOT EXISTS ${res_file}) + message(SEND_ERROR "Resource does not exists: ${res_file}") + endif() + file(TO_NATIVE_PATH "${res_file}" res_file) + list(APPEND absolute_res_files ${res_file}) + endforeach() + + if(US_RESOURCE_LIBRARY_NAME) + set(us_cpp_resource_file "${CMAKE_CURRENT_BINARY_DIR}/${US_RESOURCE_LIBRARY_NAME}_resources.cpp") + set(us_lib_name ${US_RESOURCE_LIBRARY_NAME}) + else() + set(us_cpp_resource_file "${CMAKE_CURRENT_BINARY_DIR}/${US_RESOURCE_EXECUTABLE_NAME}_resources.cpp") + set(us_lib_name "\"\"") + endif() + + add_custom_command( + OUTPUT ${us_cpp_resource_file} + COMMAND ${CppMicroServices_RCC_EXECUTABLE_NAME} "${us_lib_name}" ${us_cpp_resource_file} ${absolute_res_files} + WORKING_DIRECTORY ${US_RESOURCE_ROOT_DIR} + DEPENDS ${absolute_res_files} + COMMENT "Generating embedded resource file ${us_cpp_resource_name}" + ) + + set(${src_var} "${${src_var}};${us_cpp_resource_file}" PARENT_SCOPE) + +endfunction() diff --git a/Core/Code/CppMicroServices/CMake/usFunctionGenerateModuleInit.cmake b/Core/Code/CppMicroServices/CMake/usFunctionGenerateModuleInit.cmake index f0cd7de62a..a63b6e4d9c 100644 --- a/Core/Code/CppMicroServices/CMake/usFunctionGenerateModuleInit.cmake +++ b/Core/Code/CppMicroServices/CMake/usFunctionGenerateModuleInit.cmake @@ -1,83 +1,85 @@ #! Generate a source file which handles proper initialization of a module. #! #! This CMake function will store the path to a generated source file in the #! src_var variable, which should be compiled into a module. Example usage: #! #! \verbatim #! set(module_srcs ) #! usFunctionGenerateModuleInit(module_srcs #! NAME "My Module" #! LIBRARY_NAME "mylib" #! VERSION "1.2.0" #! ) #! add_library(mylib ${module_srcs}) #! \endverbatim #! #! \param src_var (required) The name of a list variable to which the path of the generated #! source file will be appended. #! \param NAME (required) A human-readable name for the module. #! \param LIBRARY_NAME (optional) The name of the module, without extension. If empty, the #! NAME argument will be used. #! \param AUTOLOAD_DIR (optional) The name of a directory relative to this modules library #! location from which modules will be auto-loaded during activation of this module. #! If unspecified, the LIBRARY_NAME argument will be used. If an empty string is provided, #! auto-loading will be disabled for this module. #! \param DEPENDS (optional) A string containing module dependencies. #! \param VERSION (optional) A version string for the module. +#! \param EXECUTABLE (flag) A flag indicating that the initialization code is intended for +#! an executable. #! function(usFunctionGenerateModuleInit src_var) MACRO_PARSE_ARGUMENTS(US_MODULE "NAME;LIBRARY_NAME;AUTOLOAD_DIR;DEPENDS;VERSION" "EXECUTABLE" ${ARGN}) # sanity checks if(NOT US_MODULE_NAME) message(SEND_ERROR "NAME argument is mandatory") endif() if(US_MODULE_EXECUTABLE AND US_MODULE_LIBRARY_NAME) message("[Executable: ${US_MODULE_NAME}] Ignoring LIBRARY_NAME argument.") set(US_MODULE_LIBRARY_NAME ) endif() if(NOT US_MODULE_LIBRARY_NAME AND NOT US_MODULE_EXECUTABLE) set(US_MODULE_LIBRARY_NAME ${US_MODULE_NAME}) endif() -set(_regex_validation "[a-zA-Z-_][a-zA-Z-_0-9]*") +set(_regex_validation "[a-zA-Z_-][a-zA-Z_0-9-]*") if(US_MODULE_EXECUTABLE) string(REGEX MATCH ${_regex_validation} _valid_chars ${US_MODULE_NAME}) if(NOT _valid_chars STREQUAL US_MODULE_NAME) message(FATAL_ERROR "[Executable: ${US_MODULE_NAME}] MODULE_NAME contains illegal characters.") endif() else() string(REGEX MATCH ${_regex_validation} _valid_chars ${US_MODULE_LIBRARY_NAME}) if(NOT _valid_chars STREQUAL US_MODULE_LIBRARY_NAME) message(FATAL_ERROR "[Module: ${US_MODULE_NAME}] LIBRARY_NAME \"${US_MODULE_LIBRARY_NAME}\" contains illegal characters.") endif() endif() # The call to MACRO_PARSE_ARGUMENTS always defines variables for the argument names. # Check manually if AUTOLOAD_DIR was provided or not. list(FIND ARGN AUTOLOAD_DIR _is_autoload_dir_defined) if(_is_autoload_dir_defined EQUAL -1) set(US_MODULE_AUTOLOAD_DIR ${US_MODULE_LIBRARY_NAME}) endif() # Create variables of the ModuleInfo object, created in CMake/usModuleInit.cpp set(US_MODULE_DEPENDS_STR "") foreach(_dep ${US_MODULE_DEPENDS}) set(US_MODULE_DEPENDS_STR "${US_MODULE_DEPENDS_STR} ${_dep}") endforeach() if(US_MODULE_LIBRARY_NAME) set(module_init_src_file "${CMAKE_CURRENT_BINARY_DIR}/${US_MODULE_LIBRARY_NAME}_init.cpp") else() set(module_init_src_file "${CMAKE_CURRENT_BINARY_DIR}/${US_MODULE_NAME}_init.cpp") endif() configure_file(${CppMicroServices_SOURCE_DIR}/CMake/usModuleInit.cpp ${module_init_src_file} @ONLY) set(_src ${${src_var}} ${module_init_src_file}) set(${src_var} ${_src} PARENT_SCOPE) endfunction() diff --git a/Core/Code/CppMicroServices/CMakeLists.txt b/Core/Code/CppMicroServices/CMakeLists.txt index ae8ccf7a1f..69f29b7281 100644 --- a/Core/Code/CppMicroServices/CMakeLists.txt +++ b/Core/Code/CppMicroServices/CMakeLists.txt @@ -1,340 +1,356 @@ project(CppMicroServices) set(${PROJECT_NAME}_MAJOR_VERSION 0) set(${PROJECT_NAME}_MINOR_VERSION 99) set(${PROJECT_NAME}_PATCH_VERSION 0) set(${PROJECT_NAME}_VERSION ${${PROJECT_NAME}_MAJOR_VERSION}.${${PROJECT_NAME}_MINOR_VERSION}.${${PROJECT_NAME}_PATCH_VERSION}) cmake_minimum_required(VERSION 2.8) #----------------------------------------------------------------------------- # Update CMake module path #------------------------------------------------------------------------------ set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/CMake ${CMAKE_MODULE_PATH} ) #----------------------------------------------------------------------------- # CMake function(s) and macro(s) #----------------------------------------------------------------------------- include(MacroParseArguments) include(CheckCXXSourceCompiles) include(usFunctionCheckCompilerFlags) +include(usFunctionEmbedResources) include(usFunctionGetGccVersion) include(usFunctionGenerateModuleInit) #----------------------------------------------------------------------------- # Init output directories #----------------------------------------------------------------------------- set(US_ARCHIVE_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/lib") set(US_LIBRARY_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/lib") set(US_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/bin") foreach(_type ARCHIVE LIBRARY RUNTIME) if(NOT CMAKE_${_type}_OUTPUT_DIRECTORY) set(CMAKE_${_type}_OUTPUT_DIRECTORY ${US_${_type}_OUTPUT_DIRECTORY}) endif() endforeach() #----------------------------------------------------------------------------- # Set a default build type if none was specified #----------------------------------------------------------------------------- if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) message(STATUS "Setting build type to 'Debug' as none was specified.") set(CMAKE_BUILD_TYPE Debug CACHE STRING "Choose the type of build." FORCE) # Set the possible values of build type for cmake-gui set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo") endif() #----------------------------------------------------------------------------- # CMake options #----------------------------------------------------------------------------- function(us_cache_var _var_name _var_default _var_type _var_help) set(_advanced 0) set(_force) foreach(_argn ${ARGN}) if(_argn STREQUAL ADVANCED) set(_advanced 1) elseif(_argn STREQUAL FORCE) set(_force FORCE) endif() endforeach() if(US_IS_EMBEDDED) if(NOT DEFINED ${_var_name} OR _force) set(${_var_name} ${_var_default} PARENT_SCOPE) endif() else() set(${_var_name} ${_var_default} CACHE ${_var_type} "${_var_help}" ${_force}) if(_advanced) mark_as_advanced(${_var_name}) endif() endif() endfunction() # Determine if we are being build inside a larger project if(NOT DEFINED US_IS_EMBEDDED) if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME) set(US_IS_EMBEDDED 0) else() set(US_IS_EMBEDDED 1) set(CppMicroServices_EXPORTS 1) endif() endif() us_cache_var(US_ENABLE_AUTOLOADING_SUPPORT OFF BOOL "Enable module auto-loading support") us_cache_var(US_ENABLE_SERVICE_FACTORY_SUPPORT ON BOOL "Enable Service Factory support" ADVANCED) us_cache_var(US_ENABLE_THREADING_SUPPORT OFF BOOL "Enable threading support") us_cache_var(US_BUILD_SHARED_LIBS ON BOOL "Build shared libraries") us_cache_var(US_BUILD_TESTING OFF BOOL "Build tests") if(MSVC10 OR MSVC11) # Visual Studio 2010 and newer have support for C++11 enabled by default set(US_USE_C++11 1) else() us_cache_var(US_USE_C++11 OFF BOOL "Enable the use of C++11 features" ADVANCED) endif() us_cache_var(US_NAMESPACE "us" STRING "The namespace for the C++ micro services entities") us_cache_var(US_HEADER_PREFIX "" STRING "The file name prefix for the public C++ micro services header files") us_cache_var(US_BASECLASS_NAME "" STRING "The fully-qualified name of the base class") if(US_ENABLE_SERVICE_FACTORY_SUPPORT) us_cache_var(US_BASECLASS_PACKAGE "" STRING "The name of the package providing the base class definition" ADVANCED) set(bc_inc_d_doc "A list of include directories containing the header files for the base class") us_cache_var(US_BASECLASS_INCLUDE_DIRS "" STRING "${bc_inc_d_doc}" ADVANCED) set(bc_lib_d_doc "A list of library directories for the base class") us_cache_var(US_BASECLASS_LIBRARY_DIRS "" STRING "${bc_lib_d_doc}" ADVANCED) set(bc_lib_doc "A list of libraries needed for the base class") us_cache_var(US_BASECLASS_LIBRARIES "" STRING "${bc_lib_doc}" ADVANCED) us_cache_var(US_BASECLASS_HEADER "" STRING "The name of the header file containing the base class declaration" ADVANCED) endif() set(BUILD_SHARED_LIBS ${US_BUILD_SHARED_LIBS}) # Sanity checks if(US_ENABLE_SERVICE_FACTORY_SUPPORT OR US_BUILD_TESTING) if(US_BASECLASS_PACKAGE) find_package(${US_BASECLASS_PACKAGE} REQUIRED) # Try to get the include dirs foreach(_suffix DIRECTORIES DIRS DIRECTORY DIR) if(${US_BASECLASS_PACKAGE}_INCLUDE_${_suffix} AND NOT US_BASECLASS_INCLUDE_DIRS) us_cache_var(US_BASECLASS_INCLUDE_DIRS "${${US_BASECLASS_PACKAGE}_INCLUDE_${_suffix}}" STRING "${bc_inc_d_doc}" FORCE) break() endif() endforeach() # Try to get the library dirs foreach(_suffix DIRECTORIES DIRS DIRECTORY DIR) if(${US_BASECLASS_PACKAGE}_LIBRARY_${_suffix} AND NOT US_BASECLASS_LIBRARY_DIRS) us_cache_var(US_BASECLASS_LIBRARY_DIRS "${${US_BASECLASS_PACKAGE}_LIBRARY_${_suffix}}" STRING "${bc_lib_d_doc}" FORCE) break() endif() endforeach() # Try to get the libraries foreach(_suffix LIBRARIES LIBS LIBRARY LIB) if(${US_BASECLASS_PACKAGE}_${_suffix} AND NOT US_BASECLASS_LIBRARIES) us_cache_var(US_BASECLASS_LIBRARIES "${${US_BASECLASS_PACKAGE}_${_suffix}}" STRING "${bc_lib_doc}" FORCE) break() endif() endforeach() if(NOT US_BASECLASS_NAME) message(FATAL_ERROR "US_BASECLASS_NAME not set") elseif(NOT US_BASECLASS_HEADER) message(FATAL_ERROR "US_BASECLASS_HEADER not set") endif() endif() if(US_ENABLE_SERVICE_FACTORY_SUPPORT AND US_BASECLASS_NAME AND NOT US_BASECLASS_HEADER) message(FATAL_ERROR "US_ENABLE_SERVICE_FACTORY_SUPPORT requires a US_BASECLASS_HEADER value") endif() endif() set(_us_baseclass_default 0) if(NOT US_BASECLASS_NAME) message(WARNING "Using build in base class \"::${US_NAMESPACE}::Base\"") set(_us_baseclass_default 1) set(US_BASECLASS_NAME "${US_NAMESPACE}::Base") set(US_BASECLASS_HEADER "usBase.h") endif() if(US_BUILD_TESTING AND US_BASECLASS_NAME AND NOT US_BASECLASS_HEADER) message(FATAL_ERROR "US_BUILD_TESTING requires a US_BASECLASS_HEADER value") endif() set(US_BASECLASS_INCLUDE "#include <${US_BASECLASS_HEADER}>") string(REPLACE "::" ";" _bc_token "${US_BASECLASS_NAME}") list(GET _bc_token -1 _bc_name) list(REMOVE_AT _bc_token -1) set(US_BASECLASS_FORWARD_DECLARATION "") foreach(_namespace_tok ${_bc_token}) if(_namespace_tok) set(US_BASECLASS_FORWARD_DECLARATION "${US_BASECLASS_FORWARD_DECLARATION}namespace ${_namespace_tok} { ") endif() endforeach() set(US_BASECLASS_FORWARD_DECLARATION "${US_BASECLASS_FORWARD_DECLARATION}class ${_bc_name}; ") foreach(_namespace_tok ${_bc_token}) if(_namespace_tok) set(US_BASECLASS_FORWARD_DECLARATION "${US_BASECLASS_FORWARD_DECLARATION}}") endif() endforeach() #----------------------------------------------------------------------------- # US C/CXX Flags #----------------------------------------------------------------------------- set(US_C_FLAGS "${COVERAGE_C_FLAGS} ${ADDITIONAL_C_FLAGS}") set(US_CXX_FLAGS "${COVERAGE_CXX_FLAGS} ${ADDITIONAL_CXX_FLAGS}") # This is used as a preprocessor define set(US_USE_CXX11 ${US_USE_C++11}) # Set C++ compiler flags if(NOT MSVC) foreach(_cxxflag -Werror -Wall -Wextra -Wpointer-arith -Winvalid-pch -Wcast-align -Wwrite-strings -Woverloaded-virtual -Wnon-virtual-dtor -Wold-style-cast -Wstrict-null-sentinel -Wsign-promo -fdiagnostics-show-option -D_FORTIFY_SOURCE=2) usFunctionCheckCompilerFlags(${_cxxflag} US_CXX_FLAGS) endforeach() if(US_USE_C++11) usFunctionCheckCompilerFlags("-std=c++0x" US_CXX_FLAGS) endif() endif() if(CMAKE_COMPILER_IS_GNUCXX) usFunctionGetGccVersion(${CMAKE_CXX_COMPILER} GCC_VERSION) # With older versions of gcc the flag -fstack-protector-all requires an extra dependency to libssp.so. # If the gcc version is lower than 4.4.0 and the build type is Release let's not include the flag. if(${GCC_VERSION} VERSION_GREATER "4.4.0" OR (CMAKE_BUILD_TYPE STREQUAL "Debug" AND ${GCC_VERSION} VERSION_LESS "4.4.0")) usFunctionCheckCompilerFlags("-fstack-protector-all" US_CXX_FLAGS) endif() if(MINGW) # suppress warnings about auto imported symbols set(US_CXX_FLAGS "-Wl,--enable-auto-import ${US_CXX_FLAGS}") # we need to define a Windows version set(US_CXX_FLAGS "-D_WIN32_WINNT=0x0500 ${US_CXX_FLAGS}") else() # Enable visibility support if(NOT ${GCC_VERSION} VERSION_LESS "4.5") usFunctionCheckCompilerFlags("-fvisibility=hidden -fvisibility-inlines-hidden" US_CXX_FLAGS) endif() endif() -elseif(MSVC90 OR MSVC10 OR MSVC11) - set(US_CXX_FLAGS "/MP ${US_CXX_FLAGS}") +elseif(MSVC) + set(US_CXX_FLAGS "/MP /wd4996 ${US_CXX_FLAGS}") endif() if(NOT US_IS_EMBEDDED) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${US_CXX_FLAGS}") set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${US_C_FLAGS}") endif() #----------------------------------------------------------------------------- # US Link Flags #----------------------------------------------------------------------------- set(US_LINK_FLAGS ) if(NOT MSVC) foreach(_linkflag -Wl,--no-undefined) set(_add_flag) usFunctionCheckCompilerFlags("${_linkflag}" _add_flag) if(_add_flag) set(US_LINK_FLAGS "${US_LINK_FLAGS} ${_linkflag}") endif() endforeach() endif() +#----------------------------------------------------------------------------- +# US Header Checks +#----------------------------------------------------------------------------- + +include(CheckIncludeFile) + +CHECK_INCLUDE_FILE(stdint.h HAVE_STDINT) + #----------------------------------------------------------------------------- # US include dirs and libraries #----------------------------------------------------------------------------- set(US_INCLUDE_DIRS ${PROJECT_BINARY_DIR}/include ) set(US_INTERNAL_INCLUDE_DIRS ${PROJECT_BINARY_DIR}/include ${CMAKE_CURRENT_SOURCE_DIR}/src/util ${CMAKE_CURRENT_SOURCE_DIR}/src/service ${CMAKE_CURRENT_SOURCE_DIR}/src/module ) if(US_ENABLE_SERVICE_FACTORY_SUPPORT) list(APPEND US_INTERNAL_INCLUDE_DIRS ${US_BASECLASS_INCLUDE_DIRS}) endif() # link libraries for third party libs if(US_IS_EMBEDDED) set(US_LINK_LIBRARIES ${US_EMBEDDING_LIBRARY}) else() set(US_LINK_LIBRARIES ${PROJECT_NAME}) endif() # link libraries for the CppMicroServices lib set(_link_libraries ) if(UNIX) list(APPEND _link_libraries dl) endif() list(APPEND US_LINK_LIBRARIES ${_link_libraries}) if(US_ENABLE_SERVICE_FACTORY_SUPPORT) list(APPEND US_LINK_LIBRARIES ${US_BASECLASS_LIBRARIES}) endif() set(US_LINK_DIRS ) if(US_ENABLE_SERVICE_FACTORY_SUPPORT) list(APPEND US_LINK_DIRS ${US_BASECLASS_LIBRARY_DIRS}) endif() #----------------------------------------------------------------------------- # Source directory #----------------------------------------------------------------------------- set(us_config_h_file "${PROJECT_BINARY_DIR}/include/usConfig.h") configure_file(usConfig.h.in ${us_config_h_file}) +set(US_RCC_EXECUTABLE_NAME usResourceCompiler) +set(CppMicroServices_RCC_EXECUTABLE_NAME ${US_RCC_EXECUTABLE_NAME}) +set(US_RCC_EXECUTABLE "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${US_RCC_EXECUTABLE_NAME}") + +add_subdirectory(tools) + add_subdirectory(src) + #----------------------------------------------------------------------------- # US testing #----------------------------------------------------------------------------- if(US_BUILD_TESTING) enable_testing() add_subdirectory(test) endif() #----------------------------------------------------------------------------- # Documentation #----------------------------------------------------------------------------- add_subdirectory(documentation) #----------------------------------------------------------------------------- # Last configuration steps #----------------------------------------------------------------------------- configure_file(${PROJECT_NAME}Config.cmake.in ${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake @ONLY) diff --git a/Core/Code/CppMicroServices/CppMicroServicesConfig.cmake.in b/Core/Code/CppMicroServices/CppMicroServicesConfig.cmake.in index d936049d35..5870c575a5 100644 --- a/Core/Code/CppMicroServices/CppMicroServicesConfig.cmake.in +++ b/Core/Code/CppMicroServices/CppMicroServicesConfig.cmake.in @@ -1,10 +1,12 @@ set(@PROJECT_NAME@_INCLUDE_DIRS @US_INCLUDE_DIRS@) set(@PROJECT_NAME@_INTERNAL_INCLUDE_DIRS @US_INTERNAL_INCLUDE_DIRS@) set(@PROJECT_NAME@_LIBRARIES @US_LINK_LIBRARIES@) set(@PROJECT_NAME@_LIBRARY_DIRS @CMAKE_LIBRARY_OUTPUT_DIRECTORY@) set(@PROJECT_NAME@_SOURCES @US_SOURCES@) set(@PROJECT_NAME@_PUBLIC_HEADERS @US_PUBLIC_HEADERS@) set(@PROJECT_NAME@_PRIVATE_HEADERS @US_PRIVATE_HEADERS@) set(@PROJECT_NAME@_SOURCE_DIR @CMAKE_CURRENT_SOURCE_DIR@) + +set(CppMicroServices_RCC_EXECUTABLE_NAME @US_RCC_EXECUTABLE_NAME@) diff --git a/Core/Code/CppMicroServices/LICENSE b/Core/Code/CppMicroServices/LICENSE new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/Core/Code/CppMicroServices/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Core/Code/CppMicroServices/README.md b/Core/Code/CppMicroServices/README.md index fa2b98b55a..2470e5f9a3 100644 --- a/Core/Code/CppMicroServices/README.md +++ b/Core/Code/CppMicroServices/README.md @@ -1,83 +1,89 @@ [![Build Status](https://secure.travis-ci.org/saschazelzer/CppMicroServices.png)](http://travis-ci.org/saschazelzer/CppMicroServices) C++ Micro Services ================== Introduction ------------ The C++ Micro Services library provides a dynamic service registry based on the service layer as specified in the OSGi R4.2 specifications. It enables users to realize a service oriented approach within their software stack. The advantages include higher reuse of components, looser coupling, better organization of responsibilities, cleaner API contracts, etc. Requirements ------------ This is a pure C++ implementation of the OSGi service model and does not have any third-party library dependencies. Supported Platforms ------------------- The library should compile on many different platforms. Below is a list of tested compiler/OS combinations: - GCC 4.5 (Ubuntu 11.04 and MacOS X 10.6) - Visual Studio 2008 and 2010 - Clang 3.0 (Ubuntu 11.04 and MacOS X 10.6) - + +Legal +----- + +Copyright (c) German Cancer Research Center. Licensed under the [Apache License v2.0][apache_license]. + Quick Start ----------- Essentially, the C++ Micro Services library provides you with a powerful dynamic service registry. Each shared or static library has an associated `ModuleContext` object, through which the service registry is accessed. To query the registry for a service object implementing one or more specific interfaces, the code would look like this: ```cpp #include #include using namespace us; void UseService(ModuleContext* context) { ServiceReference serviceRef = context->GetServiceReference(); if (serviceRef) { SomeInterface* service = context->GetService(serviceRef); if (service) { /* do something */ } } } ``` Registering a service object against a certain interface looks like this: ```cpp #include #include using namespace us; void RegisterSomeService(ModuleContext* context, SomeInterface* service) { context->RegisterService(service); } ``` The OSGi service model additionally allows to annotate services with properties and using these properties during service look-ups. It also allows to track the life-cycle of service objects. Please see the [Documentation](http://cppmicroservices.org/doc_latest/index.html) for more examples and tutorials and the API reference. There is also a blog post about [OSGi Lite for C++](http://blog.cppmicroservices.org/2012/04/15/osgi-lite-for-c++). Build Instructions ------------------ Please visit the [Build Instructions][bi_master] page online. [bi_master]: http://cppmicroservices.org/doc_latest/BuildInstructions.html +[apache_license]: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/Core/Code/CppMicroServices/documentation/doxygen.conf.in b/Core/Code/CppMicroServices/documentation/doxygen.conf.in index 2e089a61f2..b3f88c4728 100644 --- a/Core/Code/CppMicroServices/documentation/doxygen.conf.in +++ b/Core/Code/CppMicroServices/documentation/doxygen.conf.in @@ -1,1807 +1,1808 @@ # Doxyfile 1.8.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" "). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or sequence of words) that should # identify the project. Note that if you do not use Doxywizard you need # to put quotes around the project name if it contains spaces. PROJECT_NAME = "C++ Micro Services" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = @CppMicroServices_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer # a quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "A dynamic OSGi-like C++ service registry" # With the PROJECT_LOGO tag one can specify an logo or icon that is # included in the documentation. The maximum height of the logo should not # exceed 55 pixels and the maximum width should not exceed 200 pixels. # Doxygen will copy the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = @US_DOXYGEN_OUTPUT_DIR@ # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful if your file system # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 2 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = "FIXME=\par Fix Me's:\n" \ "embmainpage{1}=@US_DOXYGEN_MAIN_PAGE_CMD@" # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding # "class=itcl::class" will allow you to use the command class in the # itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given extension. # Doxygen has a built-in mapping, but you can override or extend it using this # tag. The format is ext=language, where ext is a file extension, and language # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = # If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all # comments according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you # can mix doxygen, HTML, and XML commands with Markdown formatting. # Disable only in case of backward compatibilities issues. MARKDOWN_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also makes the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and # unions are shown inside the group in which they are included (e.g. using # @ingroup) instead of on a separate page (for HTML and Man pages) or # section (for LaTeX and RTF). INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and # unions with only public data fields will be shown inline in the documentation # of the scope in which they are defined (i.e. file, namespace, or group # documentation), provided this scope is documented. If set to NO (the default), # structs, classes, and unions are shown on a separate page (for HTML and Man # pages) or section (for LaTeX and RTF). INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penalty. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will roughly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols. SYMBOL_CACHE_SIZE = 0 # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given # their name and scope. Since this can be an expensive process and often the # same symbol appear multiple times in the code, doxygen keeps a cache of # pre-resolved symbols. If the cache is too small doxygen will become slower. # If the cache is too large, memory is wasted. The cache size is given by this # formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base # name of the file that contains the anonymous namespace. By default # anonymous namespaces are hidden. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen # will list include files with double quotes in the documentation # rather than with sharp brackets. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen # will sort the (brief and detailed) documentation of class members so that # constructors and destructors are listed first. If set to NO (the default) # the constructors will appear in the respective orders defined by # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = YES # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to # do proper type resolution of all parameters of a function it will reject a # match between the prototype and the implementation of a member function even # if there is only one candidate or it is obvious which candidate to choose # by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen # will still accept a match between prototype and implementation in such cases. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = @US_DOXYGEN_ENABLED_SECTIONS@ # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or macro consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and macros in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 0 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = NO # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. The create the layout file # that represents doxygen's defaults, run doxygen with the -l option. # You can optionally specify a file name after the option, if omitted # DoxygenLayout.xml will be used as the name of the layout file. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files # containing the references data. This must be a list of .bib files. The # .bib extension is automatically appended if omitted. Using this command # requires the bibtex tool to be installed. See also # http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style # of the bibliography can be controlled using LATEX_BIB_STYLE. To use this # feature you need bibtex and perl available in the search path. CITE_BIB_FILES = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # The WARN_NO_PARAMDOC option can be enabled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. Optionally the format may contain # $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = @PROJECT_SOURCE_DIR@ \ @PROJECT_BINARY_DIR@/include/usConfig.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py # *.f90 *.f *.for *.vhd *.vhdl FILE_PATTERNS = *.h \ *.dox \ *.md # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = @PROJECT_SOURCE_DIR@/README.md \ @PROJECT_SOURCE_DIR@/documentation/snippets/ \ @PROJECT_SOURCE_DIR@/test/ \ @PROJECT_SOURCE_DIR@/gh-pages \ @PROJECT_SOURCE_DIR@/.git/ # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = */.git/* \ *_p.h \ *Private.* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = us US_NAMESPACE # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = @PROJECT_SOURCE_DIR@/documentation/snippets/ # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = YES # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output. # If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty or if # non of the patterns match the file name, INPUT_FILTER is applied. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) # and it is also possible to disable source filtering for a specific pattern # using *.ext= (so without naming a filter). This option only has effect when # FILTER_SOURCE_FILES is enabled. FILTER_SOURCE_PATTERNS = #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = YES # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 3 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = @US_DOXYGEN_HTML_OUTPUT@ # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. Note that when using a custom header you are responsible # for the proper inclusion of any scripts and style sheets that doxygen # needs, which is dependent on the configuration options used. # It is advised to generate a default header using "doxygen -w html # header.html footer.html stylesheet.css YourConfigFile" and then modify # that header. Note that the header is subject to change so you typically # have to redo this when upgrading to a newer version of doxygen or when # changing the value of configuration settings such as GENERATE_TREEVIEW! HTML_HEADER = @US_DOXYGEN_HEADER@ # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = @US_DOXYGEN_FOOTER@ # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # style sheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = @US_DOXYGEN_CSS@ # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that # the files will be copied as-is; there are no commands or markers available. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. # Doxygen will adjust the colors in the style sheet and background images # according to this color. Hue is specified as an angle on a colorwheel, # see http://en.wikipedia.org/wiki/Hue for more information. # For instance the value 0 represents red, 60 is yellow, 120 is green, # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. # The allowed range is 0 to 359. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of # the colors in the HTML output. For a value of 0 the output will use # grayscales only. A value of 255 will produce the most vivid colors. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to # the luminance component of the colors in the HTML output. Values below # 100 gradually make the output lighter, whereas values above 100 make # the output darker. The value divided by 100 is the actual gamma applied, # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, # and 100 does not change the gamma. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting # this to NO can help when comparing the output of multiple runs. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of # entries shown in the various tree structured indices initially; the user # can expand and collapse entries dynamically later on. Doxygen will expand # the tree to such a level that at most the specified number of entries are # visible (unless a fully collapsed tree already exceeds this amount). # So setting the number of entries 1 will produce a full collapsed tree by # default. 0 is a special value representing an infinite number of entries # and will result in a full expanded tree by default. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated # that can be used as input for Qt's qhelpgenerator to generate a # Qt Compressed Help (.qch) of the generated HTML documentation. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to # add. For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see # # Qt Help Project / Custom Filters. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's # filter section matches. # # Qt Help Project / Filter Attributes. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files # will be generated, which together with the HTML files, form an Eclipse help # plugin. To install this plugin and make it available under the help contents # menu in Eclipse, the contents of the directory containing the HTML and XML # files needs to be copied into the plugins directory of eclipse. The name of # the directory within the plugins directory should be the same as # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before # the help appears. GENERATE_ECLIPSEHELP = NO # A unique identifier for the eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have # this name. ECLIPSE_DOC_ID = org.doxygen.Project # The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) # at top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. Since the tabs have the same information as the # navigation tree you can set this option to NO if you already set # GENERATE_TREEVIEW to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. # Since the tree basically has the same information as the tab index you # could consider to set DISABLE_INDEX to NO when enabling this option. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values # (range [0,1..20]) that doxygen will group on one line in the generated HTML # documentation. Note that a value of 0 will completely suppress the enum # values from appearing in the overview section. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 300 # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open # links to external symbols imported via tag files in a separate window. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are # not supported properly for IE 6.0, but are supported on all modern browsers. # Note that when changing this option you need to delete any form_*.png files # in the HTML output before the changes have effect. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax # (see http://www.mathjax.org) which uses client side Javascript for the # rendering instead of using prerendered bitmaps. Use this if you do not # have LaTeX installed or if you want to formulas look prettier in the HTML # output. When enabled you may also need to install MathJax separately and # configure the path to it using the MATHJAX_RELPATH option. USE_MATHJAX = NO # When MathJax is enabled you need to specify the location relative to the # HTML output directory using the MATHJAX_RELPATH option. The destination # directory should contain the MathJax.js script. For instance, if the mathjax # directory is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to # the MathJax Content Delivery Network so you can quickly see the result without # installing MathJax. # However, it is strongly recommended to install a local # copy of MathJax from http://www.mathjax.org before deployment. MATHJAX_RELPATH = http://www.mathjax.org/mathjax # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension # names that should be enabled during MathJax rendering. MATHJAX_EXTENSIONS = # When the SEARCHENGINE tag is enabled doxygen will generate a search box # for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets # (GENERATE_DOCSET) there is already a search function so this one should # typically be disabled. For large projects the javascript based search engine # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a PHP enabled web server instead of at the web client # using Javascript. Doxygen will generate the search PHP script and index # file to put on the web server. The advantage of the server # based approach is that it scales better to large projects and allows # full text search. The disadvantages are that it is more difficult to setup # and does not have live searching capabilities. SERVER_BASED_SEARCH = NO #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. # Note that when enabling USE_PDFLATEX this option is only used for # generating bitmaps for formulas in the HTML output, but not in the # Makefile that is written to the output directory. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = amssymb # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for # the generated latex document. The footer should contain everything after # the last chapter. If it is left blank doxygen will generate a # standard footer. Notice: only use this tag if you know what you are doing! LATEX_FOOTER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = NO # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = NO # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO # If LATEX_SOURCE_CODE is set to YES then doxygen will include # source code with syntax highlighting in the LaTeX output. # Note that which sources are shown also depends on other settings # such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See # http://en.wikipedia.org/wiki/BibTeX for more info. LATEX_BIB_STYLE = plain #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load style sheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. # This is useful # if you want to understand what is going on. # On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # pointed to by INCLUDE_PATH will be searched when a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = @PROJECT_BINARY_DIR@/include/ # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = *.h # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = US_PREPEND_NAMESPACE(x)=x \ US_BEGIN_NAMESPACE= \ US_END_NAMESPACE= \ "US_BASECLASS_NAME=@US_BASECLASS_NAME@" \ US_EXPORT= \ - US_ABI_LOCAL= + US_ABI_LOCAL= \ + US_MSVC_POP_WARNING= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition that # overrules the definition found in the source code. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all references to function-like macros # that are alone on a line, have an all uppercase name, and do not end with a # semicolon, because these will confuse the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. For each # tag file the location of the external documentation should be added. The # format of a tag file without this location is as follows: # # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths # or URLs. Note that each tag file must have a unique name (where the name does # NOT include the path). If a tag file is not located in the directory in which # doxygen is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = NO # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option also works with HAVE_DOT disabled, but it is recommended to # install and use dot, since it yields more powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = @US_HAVE_DOT@ # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is # allowed to run in parallel. When set to 0 (the default) doxygen will # base this on the number of processors available in the system. You can set it # explicitly to a value larger than 0 to get control over the balance # between CPU load and processing speed. DOT_NUM_THREADS = @US_DOXYGEN_DOT_NUM_THREADS@ # By default doxygen will use the Helvetica font for all dot files that # doxygen generates. When you want a differently looking font you can specify # the font name using DOT_FONTNAME. You need to make sure dot is able to find # the font, which can be done by putting it in a standard location or by setting # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the # directory containing the font. DOT_FONTNAME = FreeSans.ttf # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the Helvetica font. # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to # set the path where dot can find it. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If the UML_LOOK tag is enabled, the fields and methods are shown inside # the class node. If there are many fields or methods and many nodes the # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS # threshold limits the number of items for each type to make the size more # managable. Set this to 0 for no limit. Note that the threshold may be # exceeded by 50% before the limit is enforced. UML_LIMIT_NUM_FIELDS = 10 # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = NO # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will generate a graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = NO # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = NO # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are svg, png, jpg, or gif. # If left blank png will be used. If you choose svg you need to set # HTML_FILE_EXTENSION to xhtml in order to make the SVG files # visible in IE 9+ (other browsers do not have this requirement). DOT_IMAGE_FORMAT = png # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to # enable generation of interactive SVG images that allow zooming and panning. # Note that this requires a modern browser other than Internet Explorer. # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files # visible. Older versions of IE do not have SVG support. INTERACTIVE_SVG = NO # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = @US_DOXYGEN_DOT_PATH@ # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The MSCFILE_DIRS tag can be used to specify one or more directories that # contain msc files that are included in the documentation (see the # \mscfile command). MSCFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 0 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = NO # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES diff --git a/Core/Code/CppMicroServices/documentation/doxygen/MicroServices.dox b/Core/Code/CppMicroServices/documentation/doxygen/MicroServices.dox index 8f30f33cfb..8a7260e7be 100644 --- a/Core/Code/CppMicroServices/documentation/doxygen/MicroServices.dox +++ b/Core/Code/CppMicroServices/documentation/doxygen/MicroServices.dox @@ -1,84 +1,85 @@ /** \defgroup MicroServices Micro Services Classes \brief This category includes classes related to the C++ Micro Services component. The C++ Micro Services component provides a dynamic service registry based on the service layer as specified in the OSGi R4.2 specifications. */ /** \defgroup MicroServicesUtils Utility Classes \brief This category includes utility classes which can be used by others. */ /** \page MicroServices_Examples Examples This is a list of available examples: - \subpage MicroServices_DictionaryService */ /** \page MicroServices_Tutorials Tutorials This is a list of available tutorials: - \subpage MicroServices_TheModuleContext +- \subpage MicroServices_Resources - \subpage MicroServices_EmulateSingleton - \subpage MicroServices_AutoLoading - \subpage MicroServices_StaticModules */ /** \embmainpage{MicroServices_Overview} The C++ Micro Services The C++ Micro Services component provides a dynamic service registry based on the service layer as specified in the OSGi R4.2 specifications. It enables users to realize a service oriented approach within their software stack. The advantages include higher reuse of components, looser coupling, better organization of responsibilities, cleaner API contracts, etc. \if us_standalone \section MicroServices_Overview_BI Build Instructions How to build the C++ Micro Services library is explained in detail on the \ref BuildInstructions page. \endif

Examples

\if us_standalone Here is a list of \ref MicroServices_Examples "examples": \else Here is a list of \subpage MicroServices_Examples "examples": \endif - \ref MicroServices_DictionaryService

Tutorials

The following list contains use cases and common patterns in the form of \if us_standalone \ref MicroServices_Tutorials "tutorials": \else \subpage MicroServices_Tutorials "tutorials": \endif - \ref MicroServices_TheModuleContext - \ref MicroServices_EmulateSingleton - \ref MicroServices_AutoLoading - \ref MicroServices_StaticModules */ diff --git a/Core/Code/CppMicroServices/documentation/doxygen/MicroServices_Resources.md b/Core/Code/CppMicroServices/documentation/doxygen/MicroServices_Resources.md new file mode 100644 index 0000000000..2c69fed77b --- /dev/null +++ b/Core/Code/CppMicroServices/documentation/doxygen/MicroServices_Resources.md @@ -0,0 +1,54 @@ +The Resources System {#MicroServices_Resources} +==================== + +The C++ Micro Services library provides a generic resources system to embed arbitrary files into a +module's shared library (the current size limitation is based on the largest source code file size +your compiler can handle). + +The following features are supported: + + * Embed arbitrary data into shared or static modules or executables. + * Resources are accessed via a Module instance, providing individual resource lookup and access + for each module. + * Resources are managed in a tree hierarchy, modeling the original child - parent relationship + on the file-system. + * The ModuleResource class provides a high-level API for accessing resource information and + traversing the resource tree. + * The ModuleResourceStream class provides an STL input stream derived class for the seamless usage + of embedded resource data in third-party libraries. + + +Embedding Resources in a %Module +------------------------------- + +Resources are embedded by compiling a source file generated by the `usResourceCompiler` executable +into a module's shared or static library (or into an executable). + +If you are using CMake, consider using the provided `usFunctionEmbedResources` CMake macro which +handles the invocation of the `usResourceCompiler` executable and sets up the correct file +dependencies. + +Accessing Resources at Runtime +------------------------------ + +Each module provides access to its embedded resources via the Module class which provides methods +returning ModuleResource objects. The ModuleResourceStream class provides a std::istream compatible +object to access the resource contents. + +The following example shows how to retrieve a resource from each currently loaded module whose path +is specified by a module property: + +\snippet uServices-resources/main.cpp 2 + +This example could be enhanced to dynamically react to modules being loaded and unloaded, making use +of the popular "extender pattern" from OSGi. + +Limitations +----------- + +Currently, the system has the following limitations: + + * At most one file generated by the `usResourceCompiler` executable can be compiled into a module's + shared library (you can work around this limitation by creating static modules and importing them). + * The size of embedded resources is limited by the file size your compiler can handle. However, the file + size is the sum of the size of all resources embedded into a module plus a small overhead. diff --git a/Core/Code/CppMicroServices/documentation/doxygen/MicroServices_StaticModules.md b/Core/Code/CppMicroServices/documentation/doxygen/MicroServices_StaticModules.md index 153c3a46f0..a62d196755 100644 --- a/Core/Code/CppMicroServices/documentation/doxygen/MicroServices_StaticModules.md +++ b/Core/Code/CppMicroServices/documentation/doxygen/MicroServices_StaticModules.md @@ -1,89 +1,92 @@ Static Modules {#MicroServices_StaticModules} ============== -The normal and most flexible way to include a CppMicroServices module with an application is to compile +The normal and most flexible way to include a CppMicroServices module in an application is to compile it into a shared library that is either linked by another library (or executable) or \ref MicroServices_AutoLoading "auto-loaded" during runtime. However, modules can be linked statically to your application or shared library. This makes the deployment of your application less error-prone and in the case of a complete static build also minimizes its binary size and start-up time. The disadvantage is that no functionality can be added without a rebuild and redistribution of the application. ## Creating Static Modules Static modules are written just like shared modules - there are no differences in the usage of the CppMicroServices API or the provided preprocessor macros. The only thing you need to make sure is that the `US_STATIC_MODULE` preprocessor macro is defined when building a module statically. ## Using Static Modules Static modules can be used (imported) in shared or other static libraries or in the executable itself. Assuming that a static module makes use of the CppMicroServices API (e.g. by registering some services using a ModuleContext), the importing library or executable needs to put a call to the `#US_INITIALIZE_MODULE` macro somewhere in its source code. This ensures the availability of a module context which is shared with all imported static libraries (see also \ref MicroServices_StaticModules_Context). \note Note that if your static module does not export a module activator by using the macro -`#US_EXPORT_MODULE_ACTIVATOR` you do not need to put the special import macros explained below into +`#US_EXPORT_MODULE_ACTIVATOR` or does not contain embedded resources (see \ref MicroServices_Resources) you +do not need to put the special import macros explained below into your code. You can use and link the static module just like any other static library. For every static module you would like to import, you need to put a call to `#US_IMPORT_MODULE` into the -source code of the importing library. Addidtionally, you need a call to `#US_LOAD_IMPORTED_MODULES` +source code of the importing library. To make the static module's resources available to the importing module, +you must also call `#US_IMPORT_MODULE_RESOURCES`. Addidtionally, you need a call to `#US_LOAD_IMPORTED_MODULES` which contains a space-deliminated list of module names in the importing libaries source code. This ensures -that the module activators of the imported static modules are called appropriately. +that the module activators of the imported static modules (if they exist) are called appropriately and that +the embedded resources are registered with the importing module. \note When importing a static module into another static module, the call to `#US_LOAD_IMPORTED_MODULES` in the importing static module will have no effect. This macro can only be used in shared modules or executables. There are two main usage scenarios which are explained below together with some example code. ### Using a Shared CppMicroServices Library Building the CppMicroServices library as a shared library allows you to import static modules into other shared or static modules or into the executable. As noted above, the importing shared module or executable needs to provide a module context by calling the `#US_INITIALIZE_MODULE` macro. Additionally, you must ensure to use the `#US_LOAD_IMPORTED_MODULES_INTO_MAIN` macro instead of `#US_LOAD_IMPORTED_MODULES` when importing static modules into an executable. Example code for importing the two static modules `MyStaticModule1` and `MyStaticModule2` into an executable: \snippet uServices-staticmodules/main.cpp ImportStaticModuleIntoMain Importing the static module `MyStaticModule` into a shared or static module looks like this: \snippet uServices-staticmodules/main.cpp ImportStaticModuleIntoLib Having a shared CppMicroServices library, the executable also needs some initialization code: \snippet uServices-staticmodules/main.cpp InitializeExecutable Note that shared (but not static) modules also need the `#US_INITIALIZE_MODULE` call when importing static modules, but can omit the US_BUILD_SHARED_LIBS guard. ### Using a Static CppMicroServices Library The CppMicroServices library can be build as a static library. In that case, creating shared modules is not supported. If you create shared modules which link a static version of the CppMicroServices library, the runtime behavior is undefined. In this usage scenario, every module will be statically build and linked to an executable. The executable needs to import all the static modules, just like above: \snippet uServices-staticmodules/main.cpp ImportStaticModuleIntoMain However, it can omit the `#US_INITIALIZE_MODULE` macro call (the module context from the CppMicroServices library will be shared across all modules and the executable). ## A Note About The Module Context {#MicroServices_StaticModules_Context} Modules using the CppMicroServices API frequently need a `ModuleContext` object to query, retrieve, and register services. Static modules will never get their own module context but will share the context with their importing module or executable. Therefore, the importing module or executable needs to ensure the availability of such a context (by using the `#US_INITIALIZE_MODULE` macro). \note The CppMicroServices library will *always* provide a module context, independent of its library build mode. So in a completely statically build application, the CppMicroServices library provides a global module context for all imported modules and the executable. diff --git a/Core/Code/CppMicroServices/documentation/doxygen/doxygen.css b/Core/Code/CppMicroServices/documentation/doxygen/doxygen.css index d1046f765a..8d4e9bba34 100644 --- a/Core/Code/CppMicroServices/documentation/doxygen/doxygen.css +++ b/Core/Code/CppMicroServices/documentation/doxygen/doxygen.css @@ -1,1147 +1,1141 @@ /* The standard CSS for doxygen */ /* body, table, div, p, dl { font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; font-size: 13px; line-height: 1.3; } */ /* @group Heading Levels */ h1 { font-size: 150%; } .title { font-size: 150%; font-weight: bold; margin: 10px 2px; } h2 { font-size: 120%; } h3 { font-size: 100%; } h1, h2, h3, h4, h5, h6 { -webkit-transition: text-shadow 0.5s linear; -moz-transition: text-shadow 0.5s linear; -ms-transition: text-shadow 0.5s linear; -o-transition: text-shadow 0.5s linear; transition: text-shadow 0.5s linear; margin-right: 15px; } h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { text-shadow: 0 0 15px cyan; } dt { font-weight: bold; } div.multicol { -moz-column-gap: 1em; -webkit-column-gap: 1em; -moz-column-count: 3; -webkit-column-count: 3; } p.startli, p.startdd, p.starttd { margin-top: 2px; } p.endli { margin-bottom: 0px; } p.enddd { margin-bottom: 4px; } p.endtd { margin-bottom: 2px; } /* @end */ caption { font-weight: bold; } span.legend { font-size: 70%; text-align: center; } h3.version { font-size: 90%; text-align: center; } div.qindex, div.navtab{ border: 1px solid #e6e6e6; text-align: center; } div.qindex, div.navpath { width: 100%; padding: 0 10px; } div.navtab { margin-right: 15px; } /* @group Link Styling */ a { font-weight: normal; text-decoration: none; } .contents a:visited { color: #4665A2; } a.qindex { font-weight: bold; } a.qindexHL { font-weight: bold; background-color: #9CAFD4; color: #ffffff; border: 1px double #869DCA; } .contents a.qindexHL:visited { color: #ffffff; } a.el { font-weight: bold; } a.elRef { } a.code, a.code:visited { - color: #4665A2; + color: #4665A2; } a.codeRef, a.codeRef:visited { - color: #4665A2; + color: #4665A2; } /* @end */ dl.el { margin-left: -1cm; } pre.fragment { border-top-style: solid; border-bottom-style: solid; border-width: 1px 0 1px 0; border-color: #e6e6e6; border-radius: 0; padding: 4px 6px; margin: 4px 8px 4px 2px; overflow: auto; word-wrap: break-word; font-size: 9pt; line-height: 125%; } div.fragment { padding: 4px 6px; margin: 4px 8px 4px 2px; border-top-style: solid; border-bottom-style: solid; border-width: 1px 0 1px 0; border-color: #e6e6e6; background-color: #F5F5F5; } div.line { font-family: monospace, fixed; font-size: 13px; min-height: 13px; line-height: 1.0; text-wrap: unrestricted; white-space: -moz-pre-wrap; /* Moz */ white-space: -pre-wrap; /* Opera 4-6 */ white-space: -o-pre-wrap; /* Opera 7 */ white-space: pre-wrap; /* CSS3 */ word-wrap: break-word; /* IE 5.5+ */ text-indent: -53px; padding-left: 53px; padding-bottom: 0px; margin: 0px; } span.lineno { padding-right: 4px; text-align: right; border-right: 2px solid #0F0; background-color: #E8E8E8; white-space: pre; } span.lineno a { background-color: #D8D8D8; } span.lineno a:hover { background-color: #C8C8C8; } div.ah { background-color: #f6f6f6; font-weight: bold; margin-bottom: 3px; margin-top: 3px; padding: 0.2em; border: solid thin #e6e6e6; border-radius: 0.5em; -webkit-border-radius: .5em; -moz-border-radius: .5em; } div.groupHeader { margin-left: 16px; margin-top: 12px; font-weight: bold; } div.groupText { margin-left: 16px; font-style: italic; } div.contents { margin-top: 10px; margin-left: 12px; margin-right: 8px; } td.indexkey { font-weight: bold; margin: 2px 0px 2px 0; padding: 2px 10px; white-space: nowrap; vertical-align: top; } td.indexvalue { padding: 2px 10px; margin: 2px 0px; } tr.memlist { background-color: #EEF1F7; } p.formulaDsp { text-align: center; } img.formulaDsp { - + } img.formulaInl { vertical-align: middle; } div.center { text-align: center; margin-top: 0px; margin-bottom: 0px; padding: 0px; } div.center img { border: 0px; } address.footer { text-align: right; padding-right: 12px; } img.footer { border: 0px; vertical-align: middle; } /* @group Code Colorization */ span.keyword { color: #008000 } span.keywordtype { color: #604020 } span.keywordflow { color: #e08000 } span.comment { color: #800000 } span.preprocessor { color: #806020 } span.stringliteral { color: #002080 } span.charliteral { color: #008080 } -span.vhdldigit { - color: #ff00ff +span.vhdldigit { + color: #ff00ff } -span.vhdlchar { - color: #000000 +span.vhdlchar { + color: #000000 } -span.vhdlkeyword { - color: #700070 +span.vhdlkeyword { + color: #700070 } -span.vhdllogic { - color: #ff0000 +span.vhdllogic { + color: #ff0000 } blockquote { background-color: #F7F8FB; border-left: 2px solid #9CAFD4; margin: 0 24px 0 4px; padding: 0 12px 0 16px; } /* @end */ /* .search { color: #003399; font-weight: bold; } form.search { margin-bottom: 0px; margin-top: 0px; } input.search { font-size: 75%; color: #000080; font-weight: normal; background-color: #e8eef2; } */ td.tiny { font-size: 75%; } .dirtab { padding: 4px; border-collapse: collapse; border: 1px solid #A3B4D7; } th.dirtab { background: #EBEFF6; font-weight: bold; } hr { height: 0px; border: none; border-top: 1px solid #e6e6e6; } hr.footer { height: 1px; } /* @group Member Descriptions */ table.memberdecls { border-spacing: 0px; padding: 0px; } .memberdecls td { -webkit-transition-property: background-color, box-shadow; -webkit-transition-duration: 0.5s; -moz-transition-property: background-color, box-shadow; -moz-transition-duration: 0.5s; -ms-transition-property: background-color, box-shadow; -ms-transition-duration: 0.5s; -o-transition-property: background-color, box-shadow; -o-transition-duration: 0.5s; transition-property: background-color, box-shadow; transition-duration: 0.5s; } .memberdecls td.glow { background-color: cyan; box-shadow: 0 0 15px cyan; } .mdescLeft, .mdescRight, .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight, .memTemplParams { /*background-color: #F9FAFC;*/ border: none; margin: 4px; padding: 1px 0 0 8px; } .mdescLeft, .mdescRight { padding: 0px 8px 4px 8px; color: #555; } /* .memItemLeft, .memItemRight, .memTemplParams { border-top: 1px solid #C4CFE5; } */ .memItemLeft, .memTemplItemLeft { white-space: nowrap; } .memItemRight { width: 100%; } .memTemplParams { color: #4665A2; white-space: nowrap; } /* @end */ /* @group Member Details */ /* Styles for detailed member documentation */ .memtemplate { font-size: 80%; color: #4665A2; font-weight: normal; margin-left: 9px; } .memnav { background-color: #EBEFF6; border: 1px solid #A3B4D7; text-align: center; margin: 2px; margin-right: 15px; padding: 2px; } .mempage { width: 100%; } .memitem { padding: 0; margin-bottom: 10px; margin-right: 5px; -webkit-transition: box-shadow 0.5s linear; -moz-transition: box-shadow 0.5s linear; -ms-transition: box-shadow 0.5s linear; -o-transition: box-shadow 0.5s linear; transition: box-shadow 0.5s linear; } .memitem.glow { box-shadow: 0 0 15px cyan; } .memname { font-weight: bold; margin-left: 6px; } .memname td { vertical-align: bottom; } .memproto, dl.reflist dt { border-top: 1px solid #e6e6e6; border-left: 1px solid #e6e6e6; border-right: 1px solid #e6e6e6; padding: 6px 0px 6px 0px; color: #253555; font-weight: bold; /* opera specific markup */ border-top-right-radius: 8px; border-top-left-radius: 8px; /* firefox specific markup */ -moz-border-radius-topright: 8px; -moz-border-radius-topleft: 8px; /* webkit specific markup */ -webkit-border-top-right-radius: 8px; -webkit-border-top-left-radius: 8px; background-color: #f6f6f6; } .memdoc, dl.reflist dd { border-bottom: 1px solid #e6e6e6; border-left: 1px solid #e6e6e6; border-right: 1px solid #e6e6e6; padding: 2px 5px; border-top-width: 0; /* opera specific markup */ border-bottom-left-radius: 8px; border-bottom-right-radius: 8px; /* firefox specific markup */ -moz-border-radius-bottomleft: 8px; -moz-border-radius-bottomright: 8px; /* webkit specific markup */ -webkit-border-bottom-left-radius: 8px; -webkit-border-bottom-right-radius: 8px; } dl.reflist dt { padding: 5px; } dl.reflist dd { margin: 0px 0px 10px 0px; padding: 5px; } .paramkey { text-align: right; } .paramtype { white-space: nowrap; } .paramname { color: #602020; white-space: nowrap; } .paramname em { font-style: normal; } .params, .retval, .exception, .tparams { margin-left: 0px; padding-left: 0px; -} +} -.params .paramname, .retval .paramname { +.params .paramname, .tparams .paramname, .retval .paramname { font-weight: bold; vertical-align: top; + padding-right: 10px; } - + .params .paramtype { font-style: italic; vertical-align: top; -} - +} + .params .paramdir { font-family: "courier new",courier,monospace; vertical-align: top; } table.mlabels { border-spacing: 0px; } td.mlabels-left { width: 100%; padding: 0px; } td.mlabels-right { vertical-align: bottom; padding: 0px; white-space: nowrap; } span.mlabels { margin-left: 8px; } span.mlabel { background-color: #728DC1; border-top:1px solid #405C93; border-left:1px solid #405C93; border-right:1px solid #C4CFE5; border-bottom:1px solid #C4CFE5; text-shadow: none; color: white; margin-right: 4px; padding: 2px 3px; border-radius: 3px; font-size: 7pt; white-space: nowrap; } /* @end */ /* these are for tree view when not used as main index */ div.directory { margin: 10px 0px; /*border-top: 1px solid #A8B8D9; border-bottom: 1px solid #A8B8D9;*/ width: 100%; } .directory table { border-collapse:collapse; } .directory td { margin: 0px; padding: 0px; vertical-align: baseline; } .directory td.entry { white-space: nowrap; padding-right: 6px; } .directory td.entry a { outline:none; } .directory td.desc { width: 100%; padding-left: 6px; padding-right: 6px; border-left: 1px solid rgba(0,0,0,0.05); } .directory tr.even { padding-left: 6px; /*background-color: #F7F8FB;*/ } .directory img { vertical-align: -30%; } .directory .levels { white-space: nowrap; width: 100%; text-align: right; font-size: 9pt; } .directory .levels span { cursor: pointer; padding-left: 2px; padding-right: 2px; color: #3D578C; } div.dynheader { margin-top: 8px; } address { font-style: normal; margin: 0; } table.doxtable { border-collapse:collapse; margin-top: 4px; margin-bottom: 4px; } table.doxtable td, table.doxtable th { border: 1px solid #2D4068; padding: 3px 7px 2px; } table.doxtable th { background-color: #374F7F; color: #FFFFFF; font-size: 110%; padding-bottom: 4px; padding-top: 5px; } table.fieldtable { width: 100%; margin-bottom: 10px; border: 1px solid #A8B8D9; border-spacing: 0px; -moz-border-radius: 4px; -webkit-border-radius: 4px; border-radius: 4px; -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); } .fieldtable td, .fieldtable th { padding: 3px 7px 2px; } .fieldtable td.fieldtype, .fieldtable td.fieldname { white-space: nowrap; border-right: 1px solid #A8B8D9; border-bottom: 1px solid #A8B8D9; vertical-align: top; } .fieldtable td.fielddoc { border-bottom: 1px solid #A8B8D9; width: 100%; } .fieldtable tr:last-child td { border-bottom: none; } .fieldtable th { background-image:url('nav_f.png'); background-repeat:repeat-x; background-color: #E2E8F2; font-size: 90%; color: #253555; padding-bottom: 4px; padding-top: 5px; text-align:left; -moz-border-radius-topleft: 4px; -moz-border-radius-topright: 4px; -webkit-border-top-left-radius: 4px; -webkit-border-top-right-radius: 4px; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom: 1px solid #A8B8D9; } .tabsearch { top: 0px; left: 10px; height: 36px; background-image: url('tab_b.png'); z-index: 101; overflow: hidden; font-size: 13px; } .navpath ul { font-size: 11px; overflow:hidden; margin:0px; padding:0px; } .navpath li { list-style-type:none; float:left; padding-left:10px; padding-right:15px; } .navpath li.navelem a { height:22px; display:block; text-decoration: none; outline: none; color: #999; } .navpath li.navelem a:hover { text-decoration: underline; } .navpath li.footer { list-style-type:none; float:right; padding-left:10px; padding-right:15px; background-image:none; background-repeat:no-repeat; background-position:right; color:#364D7C; font-size: 8pt; } div.summary { float: right; font-size: 8pt; padding-right: 5px; width: 50%; text-align: right; -} +} div.summary a { white-space: nowrap; } div.ingroups { margin-left: 5px; font-size: 8pt; padding-left: 5px; width: 50%; text-align: left; } div.ingroups a { white-space: nowrap; } div.header { margin: 0px; border-bottom: 1px solid #333333; } div.headertitle { padding: 0px 5px 0px 7px; } dl { padding: 0 0 0 10px; } /* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ dl.section { margin-left: 0px; padding-left: 0px; } dl.note { - margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #D0C000; } dl.warning, dl.attention { - margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #FF0000; } dl.pre, dl.post, dl.invariant { - margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #00D000; } dl.deprecated { - margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #505050; } dl.todo { - margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #00C0E0; } dl.test { - margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #3030E0; } dl.bug { - margin-left:-7px; padding-left: 3px; border-left:4px solid; border-color: #C08050; } dl.section dd { margin-bottom: 6px; } #projectlogo { text-align: center; vertical-align: bottom; border-collapse: separate; } - + #projectlogo img -{ +{ border: 0px none; } - + #projectname { font: 300% Tahoma, Arial,sans-serif; margin: 0px; padding: 2px 0px; } - + #projectbrief { font: 120% Tahoma, Arial,sans-serif; margin: 0px; padding: 0px; } #projectnumber { font: 50% Tahoma, Arial,sans-serif; margin: 0px; padding: 0px; } #titlearea { padding: 0px; margin: 0px; width: 100%; border-bottom: 1px solid #5373B4; } .image { text-align: center; } .dotgraph { text-align: center; } .mscgraph { text-align: center; } .caption { font-weight: bold; } div.zoom { border: 1px solid #90A5CE; } dl.citelist { margin-bottom:50px; } dl.citelist dt { color:#334975; float:left; font-weight:bold; margin-right:10px; padding:5px; } dl.citelist dd { margin:2px 0; padding:5px 0; } div.toc { padding: 14px 25px; background-color: #F4F6FA; border: 1px solid #D8DFEE; border-radius: 7px 7px 7px 7px; float: right; height: auto; margin: 0 20px 10px 10px; width: 200px; } div.toc li { background: url("bdwn.png") no-repeat scroll 0 5px transparent; font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; margin-top: 5px; padding-left: 10px; padding-top: 2px; } div.toc h3 { font: bold 12px/1.2 Arial,FreeSans,sans-serif; color: #4665A2; border-bottom: 0 none; margin: 0; } div.toc ul { list-style: none outside none; border: medium none; padding: 0px; -} +} div.toc li.level1 { margin-left: 0px; } div.toc li.level2 { margin-left: 15px; } div.toc li.level3 { margin-left: 30px; } div.toc li.level4 { margin-left: 45px; } .inherit_header { font-weight: bold; color: gray; cursor: pointer; -webkit-touch-callout: none; -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none; } .inherit_header td { padding: 6px 0px 2px 5px; } .inherit { display: none; } tr.heading h2 { margin-top: 12px; margin-bottom: 4px; } @media print { #top { display: none; } #side-nav { display: none; } #nav-path { display: none; } body { overflow:visible; } h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } .summary { display: none; } .memitem { page-break-inside: avoid; } #doc-content { margin-left:0 !important; height:auto !important; width:auto !important; overflow:inherit; display:inline; } } code { background-color: none; border: none; color: #333333; padding: 1; } .doxygen-header { background-color: #F5F5F5; margin: -20px -20px 20px; } .tabs, .tabs2, .tabs3 { width: 100%; font-size: 16px; position: relative; } .tabs2 { font-size: 14px; } .tabs3 { font-size: 12px; } .tablist { margin: 0; padding: 0; display: table; } .tablist li { float: left; display: table-cell; list-style: none; } .tablist a { display: block; padding: 10px 20px; font-weight: bold; color: #999999; text-decoration: none; outline: none; } .tabs3 .tablist a { padding: 0 10px; } .tablist a:hover { text-decoration: underline; } .tablist li.current a { color: #fff; background-color: #bbb; } diff --git a/Core/Code/CppMicroServices/documentation/snippets/uServices-resources/main.cpp b/Core/Code/CppMicroServices/documentation/snippets/uServices-resources/main.cpp new file mode 100644 index 0000000000..78674294d6 --- /dev/null +++ b/Core/Code/CppMicroServices/documentation/snippets/uServices-resources/main.cpp @@ -0,0 +1,88 @@ +#include +#include +#include +#include +#include +#include + +US_USE_NAMESPACE + +void resourceExample() +{ + //! [1] + // Get this module's Module object + Module* module = GetModuleContext()->GetModule(); + + ModuleResource resource = module->GetResource("config.properties"); + if (resource.IsValid()) + { + // Create a ModuleResourceStream object + ModuleResourceStream resourceStream(resource); + + // Read the contents line by line + std::string line; + while (std::getline(resourceStream, line)) + { + // Process the content + std::cout << line << std::endl; + } + } + else + { + // Error handling + } + //! [1] +} + +void parseComponentDefinition(std::istream&) +{ +} + +void extenderPattern() +{ + //! [2] + // Get all loaded modules + std::vector modules; + ModuleRegistry::GetLoadedModules(modules); + + // Check if a module defines a "service-component" property + // and use its value to retrieve an embedded resource containing + // a component description. + for(std::size_t i = 0; i < modules.size(); ++i) + { + Module* const module = modules[i]; + std::string componentPath = module->GetProperty("service-component"); + if (!componentPath.empty()) + { + ModuleResource componentResource = module->GetResource(componentPath); + if (!componentResource.IsValid() || componentResource.IsDir()) continue; + + // Create a std::istream compatible object and parse the + // component description. + ModuleResourceStream resStream(componentResource); + parseComponentDefinition(resStream); + } + } + //! [2] +} + +int main(int /*argc*/, char* /*argv*/[]) +{ + //! [0] + ModuleContext* moduleContext = GetModuleContext(); + Module* module = moduleContext->GetModule(); + + // List all XML files in the config directory + std::vector xmlFiles = module->FindResources("config", "*.xml", false); + + // Find the resource named vertex_shader.txt starting at the root directory + std::vector shaders = module->FindResources("", "vertex_shader.txt", true); + //! [0] + + return 0; +} + +#ifdef US_BUILD_SHARED_LIBS +#include +US_INITIALIZE_MODULE("uServices-snippet-resources", "", "", "1.0.0") +#endif diff --git a/Core/Code/CppMicroServices/documentation/snippets/uServices-staticmodules/main.cpp b/Core/Code/CppMicroServices/documentation/snippets/uServices-staticmodules/main.cpp index 16d9479a2c..13364d4d34 100644 --- a/Core/Code/CppMicroServices/documentation/snippets/uServices-staticmodules/main.cpp +++ b/Core/Code/CppMicroServices/documentation/snippets/uServices-staticmodules/main.cpp @@ -1,34 +1,36 @@ #include US_USE_NAMESPACE //! [ImportStaticModuleIntoLib] #include US_IMPORT_MODULE(MyStaticModule) US_LOAD_IMPORTED_MODULES(HostingModule, MyStaticModule) //! [ImportStaticModuleIntoLib] // This is just for illustration purposes in code snippets extern "C" ModuleActivator* _us_module_activator_instance_MyStaticModule1() { return NULL; } extern "C" ModuleActivator* _us_module_activator_instance_MyStaticModule2() { return NULL; } +extern "C" ModuleActivator* _us_init_resources_MyStaticModule2() { return NULL; } //! [ImportStaticModuleIntoMain] #include US_IMPORT_MODULE(MyStaticModule1) US_IMPORT_MODULE(MyStaticModule2) +US_IMPORT_MODULE_RESOURCES(MyStaticModule2) US_LOAD_IMPORTED_MODULES_INTO_MAIN(MyStaticModule1 MyStaticModule2) //! [ImportStaticModuleIntoMain] int main(int /*argc*/, char* /*argv*/[]) { return 0; } //! [InitializeExecutable] #ifdef US_BUILD_SHARED_LIBS #include -US_INITIALIZE_MODULE("My Executable", "", "", "1.0.0") +US_INITIALIZE_MODULE("MyExecutable", "", "", "1.0.0") #endif //! [InitializeExecutable] diff --git a/Core/Code/CppMicroServices/src/CMakeLists.txt b/Core/Code/CppMicroServices/src/CMakeLists.txt index a30ce07ecc..12959997e7 100644 --- a/Core/Code/CppMicroServices/src/CMakeLists.txt +++ b/Core/Code/CppMicroServices/src/CMakeLists.txt @@ -1,169 +1,181 @@ #----------------------------------------------------------------------------- # US source files #----------------------------------------------------------------------------- set(_srcs util/usAny.cpp util/usThreads.cpp util/usUtils.cpp service/usLDAPExpr.cpp service/usLDAPFilter.cpp service/usServiceException.cpp service/usServiceEvent.cpp service/usServiceListenerEntry.cpp service/usServiceListenerEntry_p.h service/usServiceListeners.cpp service/usServiceListeners_p.h service/usServiceProperties.cpp service/usServiceReference.cpp service/usServiceReferencePrivate.cpp service/usServiceRegistration.cpp service/usServiceRegistrationPrivate.cpp service/usServiceRegistry.cpp service/usServiceRegistry_p.h module/usCoreModuleContext_p.h module/usCoreModuleContext.cpp module/usModuleContext.cpp module/usModule.cpp module/usModuleEvent.cpp module/usModuleInfo.cpp module/usModulePrivate.cpp module/usModuleRegistry.cpp + module/usModuleResource.cpp + module/usModuleResourceBuffer.cpp + module/usModuleResourceStream.cpp + module/usModuleResourceTree.cpp module/usModuleSettings.cpp module/usModuleUtils.cpp module/usModuleVersion.cpp ) set(_private_headers util/usAtomicInt_p.h util/usFunctor_p.h util/usStaticInit_p.h util/usThreads_p.h util/usUtils_p.h - + + util/dirent_win32_p.h + util/stdint_p.h + util/stdint_vc_p.h + service/usServiceTracker.tpp service/usServiceTrackerPrivate.h service/usServiceTrackerPrivate.tpp service/usTrackedService_p.h service/usTrackedServiceListener_p.h service/usTrackedService.tpp - + module/usModuleAbstractTracked_p.h module/usModuleAbstractTracked.tpp + module/usModuleResourceBuffer_p.h + module/usModuleResourceTree_p.h module/usModuleUtils_p.h ) set(_public_headers util/usAny.h util/usSharedData.h - + service/usLDAPFilter.h service/usServiceEvent.h service/usServiceException.h service/usServiceInterface.h service/usServiceProperties.h service/usServiceReference.h service/usServiceRegistration.h service/usServiceTracker.h service/usServiceTrackerCustomizer.h - + module/usGetModuleContext.h module/usModule.h module/usModuleActivator.h module/usModuleContext.h module/usModuleEvent.h module/usModuleImport.h module/usModuleInfo.h module/usModuleInitialization.h module/usModuleRegistry.h + module/usModuleResource.h + module/usModuleResourceStream.h module/usModuleSettings.h module/usModuleVersion.h ) if(_us_baseclass_default) list(APPEND _public_headers util/usBase.h) endif() if(US_ENABLE_SERVICE_FACTORY_SUPPORT) list(APPEND _public_headers service/usServiceFactory.h) endif() if(US_IS_EMBEDDED) set(US_SOURCES ) get_filename_component(_path_prefix "${PROJECT_SOURCE_DIR}" NAME) set(_path_prefix "${_path_prefix}/src") foreach(_src ${_srcs} ${_public_headers} ${_private_headers}) list(APPEND US_SOURCES ${_path_prefix}/${_src}) endforeach() set(US_SOURCES ${US_SOURCES} PARENT_SCOPE) endif() #----------------------------------------------------------------------------- # Create library (only if not in embedded mode) #----------------------------------------------------------------------------- if(NOT US_IS_EMBEDDED) include_directories(${US_INTERNAL_INCLUDE_DIRS}) if(US_LINK_DIRS) link_directories(${US_LINK_DIRS}) endif() usFunctionGenerateModuleInit(_srcs NAME ${PROJECT_NAME} VERSION "0.9.0") add_library(${PROJECT_NAME} ${_srcs} ${_public_headers} ${_private_headers} ${us_config_h_file}) if(NOT US_IS_EMBEDDED AND US_LINK_FLAGS) set_target_properties(${PROJECT_NAME} PROPERTIES LINK_FLAGS "${US_LINK_FLAGS}") endif() set_property(TARGET ${PROJECT_NAME} APPEND PROPERTY COMPILE_DEFINITIONS US_FORCE_MODULE_INIT) set_property(TARGET ${PROJECT_NAME} PROPERTY FRAMEWORK 1) if(US_LINK_LIBRARIES) target_link_libraries(${PROJECT_NAME} ${US_LINK_LIBRARIES}) endif() endif() #----------------------------------------------------------------------------- # Configure public header wrappers #----------------------------------------------------------------------------- set(US_PUBLIC_HEADERS ${_public_headers}) if(US_HEADER_PREFIX) set(US_PUBLIC_HEADERS ) foreach(_public_header ${_public_headers}) get_filename_component(_public_header_basename ${_public_header} NAME_WE) set(_us_public_header ${_public_header_basename}.h) string(SUBSTRING "${_public_header_basename}" 2 -1 _public_header_basename) set(_header_wrapper "${PROJECT_BINARY_DIR}/include/${US_HEADER_PREFIX}${_public_header_basename}.h") configure_file(${PROJECT_SOURCE_DIR}/CMake/usPublicHeaderWrapper.h.in ${_header_wrapper} @ONLY) list(APPEND US_PUBLIC_HEADERS ${_header_wrapper}) endforeach() endif() foreach(_header ${_public_headers} ${_private_headers}) get_filename_component(_header_name "${_header}" NAME) configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${_header} "${PROJECT_BINARY_DIR}/include/${_header_name}") endforeach() if(NOT US_IS_EMBEDDED) set_property(TARGET ${PROJECT_NAME} PROPERTY PUBLIC_HEADER ${US_PUBLIC_HEADERS}) set_property(TARGET ${PROJECT_NAME} PROPERTY PRIVATE_HEADER ${_private_headers} ${us_config_h_file}) else() set(US_PUBLIC_HEADERS ${US_PUBLIC_HEADERS} PARENT_SCOPE) set(US_PRIVATE_HEADERS ${US_PRIVATE_HEADERS} PARENT_SCOPE) endif() #----------------------------------------------------------------------------- # Install support (only if not in embedded mode) #----------------------------------------------------------------------------- if(NOT US_IS_EMBEDDED) install(TARGETS ${PROJECT_NAME} FRAMEWORK DESTINATION . RUNTIME DESTINATION bin LIBRARY DESTINATION lib - ARCHIVE DESTINATION lib + ARCHIVE DESTINATION lib PUBLIC_HEADER DESTINATION include PRIVATE_HEADER DESTINATION include) endif() diff --git a/Core/Code/CppMicroServices/src/module/usModule.cpp b/Core/Code/CppMicroServices/src/module/usModule.cpp index 84da72f744..dbe528c288 100644 --- a/Core/Code/CppMicroServices/src/module/usModule.cpp +++ b/Core/Code/CppMicroServices/src/module/usModule.cpp @@ -1,243 +1,281 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include "usModule.h" #include "usModuleContext.h" #include "usModuleActivator.h" #include "usModulePrivate.h" +#include "usModuleResource.h" #include "usModuleSettings.h" #include "usCoreModuleContext_p.h" US_BEGIN_NAMESPACE const std::string& Module::PROP_ID() { static const std::string s("module.id"); return s; } const std::string& Module::PROP_NAME() { static const std::string s("module.name"); return s; } const std::string& Module::PROP_LOCATION() { static const std::string s("module.location"); return s; } const std::string& Module::PROP_MODULE_DEPENDS() { static const std::string s("module.module_depends"); return s; } const std::string& Module::PROP_LIB_DEPENDS() { static const std::string s("module.lib_depends"); return s; } const std::string& Module::PROP_VERSION() { static const std::string s("module.version"); return s; } Module::Module() : d(0) { } Module::~Module() { delete d; } void Module::Init(CoreModuleContext* coreCtx, ModuleInfo* info) { ModulePrivate* mp = new ModulePrivate(this, coreCtx, info); std::swap(mp, d); delete mp; } void Module::Uninit() { if (d->moduleContext) { delete d->moduleContext; d->moduleContext = 0; } d->moduleActivator = 0; } bool Module::IsLoaded() const { return d->moduleContext != 0; } void Module::Start() { if (d->moduleContext) { US_WARN << "Module " << d->info.name << " already started."; return; } d->moduleContext = new ModuleContext(this->d); // try // { d->coreCtx->listeners.ModuleChanged(ModuleEvent(ModuleEvent::LOADING, this)); // try to get a ModuleActivator instance if (d->info.activatorHook) { try { d->moduleActivator = d->info.activatorHook(); } catch (...) { US_ERROR << "Creating the module activator of " << d->info.name << " failed"; throw; } d->moduleActivator->Load(d->moduleContext); } d->StartStaticModules(); #ifdef US_ENABLE_AUTOLOADING_SUPPORT if (ModuleSettings::IsAutoLoadingEnabled()) { AutoLoadModules(d->info); } #endif d->coreCtx->listeners.ModuleChanged(ModuleEvent(ModuleEvent::LOADED, this)); // } // catch (...) // { // d->coreCtx->listeners.ModuleChanged(ModuleEvent(ModuleEvent::UNLOADING, this)); // d->RemoveModuleResources(); // delete d->moduleContext; // d->moduleContext = 0; // d->coreCtx->listeners.ModuleChanged(ModuleEvent(ModuleEvent::UNLOADED, this)); // US_ERROR << "Calling the module activator Load() method of " << d->info.name << " failed!"; // throw; // } } void Module::Stop() { if (d->moduleContext == 0) { US_WARN << "Module " << d->info.name << " already stopped."; return; } try { d->coreCtx->listeners.ModuleChanged(ModuleEvent(ModuleEvent::UNLOADING, this)); d->StopStaticModules(); if (d->moduleActivator) { d->moduleActivator->Unload(d->moduleContext); } } catch (...) { US_WARN << "Calling the module activator Unload() method of " << d->info.name << " failed!"; try { d->RemoveModuleResources(); } catch (...) {} delete d->moduleContext; d->moduleContext = 0; d->coreCtx->listeners.ModuleChanged(ModuleEvent(ModuleEvent::UNLOADED, this)); throw; } d->RemoveModuleResources(); delete d->moduleContext; d->moduleContext = 0; d->coreCtx->listeners.ModuleChanged(ModuleEvent(ModuleEvent::UNLOADED, this)); } ModuleContext* Module::GetModuleContext() const { return d->moduleContext; } long Module::GetModuleId() const { return d->info.id; } std::string Module::GetLocation() const { return d->info.location; } std::string Module::GetName() const { return d->info.name; } ModuleVersion Module::GetVersion() const { return d->version; } std::string Module::GetProperty(const std::string& key) const { if (d->properties.count(key) == 0) return ""; return d->properties[key]; } +ModuleResource Module::GetResource(const std::string& path) const +{ + if (d->resourceTreePtrs.empty()) + { + return ModuleResource(); + } + + for (std::size_t i = 0; i < d->resourceTreePtrs.size(); ++i) + { + if (!d->resourceTreePtrs[i]->IsValid()) continue; + ModuleResource result(path, d->resourceTreePtrs[i], d->resourceTreePtrs); + if (result) return result; + } + return ModuleResource(); +} + +std::vector Module::FindResources(const std::string& path, const std::string& filePattern, + bool recurse) const +{ + std::vector result; + if (d->resourceTreePtrs.empty()) return result; + + for (std::size_t i = 0; i < d->resourceTreePtrs.size(); ++i) + { + if (!d->resourceTreePtrs[i]->IsValid()) continue; + + std::vector nodes; + d->resourceTreePtrs[i]->FindNodes(path, filePattern, recurse, nodes); + for (std::vector::iterator nodeIter = nodes.begin(); + nodeIter != nodes.end(); ++nodeIter) + { + result.push_back(ModuleResource(*nodeIter, d->resourceTreePtrs[i], d->resourceTreePtrs)); + } + } + return result; +} + US_END_NAMESPACE US_USE_NAMESPACE std::ostream& operator<<(std::ostream& os, const Module& module) { os << "Module[" << "id=" << module.GetModuleId() << ", loc=" << module.GetLocation() << ", name=" << module.GetName() << "]"; return os; } std::ostream& operator<<(std::ostream& os, Module const * module) { return operator<<(os, *module); } diff --git a/Core/Code/CppMicroServices/src/module/usModule.h b/Core/Code/CppMicroServices/src/module/usModule.h index b0ef8c003f..de8aede10f 100644 --- a/Core/Code/CppMicroServices/src/module/usModule.h +++ b/Core/Code/CppMicroServices/src/module/usModule.h @@ -1,214 +1,267 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #ifndef USMODULE_H #define USMODULE_H #include "usModuleVersion.h" +#include + US_BEGIN_NAMESPACE class CoreModuleContext; struct ModuleInfo; class ModuleContext; +class ModuleResource; class ModulePrivate; /** * \ingroup MicroServices * * Represents a CppMicroServices module. * *

* A %Module object is the access point to a CppMicroServices module. * Each CppMicroServices module has an associated %Module object. * *

* A module has unique identity, a long, chosen by the * framework. This identity does not change during the lifecycle of a module. * *

* A module can be in one of two states: *

    *
  • LOADED *
  • UNLOADED *
*

* You can determine the current state by using IsLoaded(). * *

* A module can only execute code when its state is LOADED. * An UNLOADED module is a * zombie and can only be reached because it was loaded before. However, * unloaded modules can be loaded again. * *

* The framework is the only entity that is allowed to create * %Module objects. * * @remarks This class is thread safe. */ class US_EXPORT Module { public: static const std::string& PROP_ID(); static const std::string& PROP_NAME(); static const std::string& PROP_LOCATION(); static const std::string& PROP_MODULE_DEPENDS(); static const std::string& PROP_LIB_DEPENDS(); static const std::string& PROP_VERSION(); ~Module(); /** * Returns this module's current state. * *

* A module can be in only one state at any time. * * @return true if the module is LOADED * false if it is UNLOADED */ bool IsLoaded() const; /** * Returns this module's {@link ModuleContext}. The returned * ModuleContext can be used by the caller to act on behalf * of this module. * *

* If this module is not in the LOADED state, then this * module has no valid ModuleContext. This method will * return 0 if this module has no valid * ModuleContext. * * @return A ModuleContext for this module or * 0 if this module has no valid * ModuleContext. */ ModuleContext* GetModuleContext() const; /** * Returns this module's unique identifier. This module is assigned a unique * identifier by the framework when it was loaded. * *

* A module's unique identifier has the following attributes: *

    *
  • Is unique. *
  • Is a long. *
  • Its value is not reused for another module, even after a module is * unloaded. *
  • Does not change while a module remains loaded. *
  • Does not change when a module is reloaded. *
* *

* This method continues to return this module's unique identifier while * this module is in the UNLOADED state. * * @return The unique identifier of this module. */ long GetModuleId() const; /** * Returns this module's location. * *

* The location is the full path to the module's shared library. * This method continues to return this module's location * while this module is in the UNLOADED state. * * @return The string representation of this module's location. */ std::string GetLocation() const; /** * Returns the name of this module as specified by the * US_CREATE_MODULE CMake macro. The module * name together with a version must identify a unique module. * *

* This method continues to return this module's name while * this module is in the UNLOADED state. * * @return The name of this module. */ std::string GetName() const; /** * Returns the version of this module as specified by the * US_INITIALIZE_MODULE CMake macro. If this module does not have a * specified version then {@link ModuleVersion::EmptyVersion} is returned. * *

* This method continues to return this module's version while * this module is in the UNLOADED state. * * @return The version of this module. */ ModuleVersion GetVersion() const; /** * Returns the value of the specified property for this module. The * method returns an empty string if the property is not found. * * @param key The name of the requested property. * @return The value of the requested property, or an empty string * if the property is undefined. */ std::string GetProperty(const std::string& key) const; + /** + * Returns the resource at the specified \c path in this module. + * The specified \c path is always relative to the root of this module and may + * begin with '/'. A path value of "/" indicates the root of this module. + * + * \note In case of other modules being statically linked into this module, + * the \c path can be ambiguous and returns the first resource matching the + * provided \c path according to the order of the static module names in the + * #US_LOAD_IMPORTED_MODULES macro. + * + * @param path The path name of the resource. + * @return A ModuleResource object for the given \c path. If the \c path cannot + * be found in this module or the module's state is \c UNLOADED, an invalid + * ModuleResource object is returned. + */ + ModuleResource GetResource(const std::string& path) const; + + /** + * Returns resources in this module and its statically linked modules. + * + * This method is intended to be used to obtain configuration, setup, localization + * and other information from this module. + * + * This method can either return only resources in the specified \c path or recurse + * into subdirectories returning resources in the directory tree beginning at the + * specified path. + * + * Examples: + * \snippet uServices-resources/main.cpp 0 + * + * \note In case of modules statically linked into this module, the returned + * ModuleResource objects can represent the same resource path, coming from + * different static modules. The order of the ModuleResource objects in the + * returned container matches the order of the static module names in the + * #US_LOAD_IMPORTED_MODULES macro. + * + * @param path The path name in which to look. The path is always relative to the root + * of this module and may begin with '/'. A path value of "/" indicates the root of this module. + * @param filePattern The resource name pattern for selecting entries in the specified path. + * The pattern is only matched against the last element of the resource path. Substring + * matching is supported using the wildcard charachter ('*'). If \c filePattern is empty, + * this is equivalent to "*" and matches all resources. + * @param recurse If \c true, recurse into subdirectories. Otherwise only return resources + * from the specified path. + * @return A vector of ModuleResource objects for each matching entry. The objects are sorted + * such that resources from this module are returned first followed by the resources from + * statically linked modules in the load order as specified in #US_LOAD_IMPORTED_MODULES. + */ + std::vector FindResources(const std::string& path, const std::string& filePattern, bool recurse) const; + private: friend class ModuleRegistry; friend class ServiceReferencePrivate; ModulePrivate* d; Module(); void Init(CoreModuleContext* coreCtx, ModuleInfo* info); void Uninit(); void Start(); void Stop(); // purposely not implemented Module(const Module &); Module& operator=(const Module&); }; US_END_NAMESPACE /** * \ingroup MicroServices */ US_EXPORT std::ostream& operator<<(std::ostream& os, const US_PREPEND_NAMESPACE(Module)& module); /** * \ingroup MicroServices */ US_EXPORT std::ostream& operator<<(std::ostream& os, US_PREPEND_NAMESPACE(Module) const * module); #endif // USMODULE_H diff --git a/Core/Code/CppMicroServices/src/module/usModuleActivator.h b/Core/Code/CppMicroServices/src/module/usModuleActivator.h index 90e120a41e..c131c70ed5 100644 --- a/Core/Code/CppMicroServices/src/module/usModuleActivator.h +++ b/Core/Code/CppMicroServices/src/module/usModuleActivator.h @@ -1,132 +1,137 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #ifndef USMODULEACTIVATOR_H_ #define USMODULEACTIVATOR_H_ #include US_BEGIN_NAMESPACE class ModuleContext; /** * \ingroup MicroServices * * Customizes the starting and stopping of a CppMicroServices module. *

* %ModuleActivator is an interface that can be implemented by * CppMicroServices modules. The CppMicroServices library can create instances of a * module's %ModuleActivator as required. If an instance's * ModuleActivator::Load method executes successfully, it is * guaranteed that the same instance's %ModuleActivator::Unload * method will be called when the module is to be unloaded. The CppMicroServices * library does not concurrently call a %ModuleActivator object. * *

* %ModuleActivator is an abstract class interface whose implementations * must be exported via a special macro. Implementations are usually declared * and defined directly in .cpp files. * *

* \snippet uServices-activator/main.cpp 0 * *

* The class implementing the %ModuleActivator interface must have a public * default constructor so that a %ModuleActivator * object can be created by the CppMicroServices library. * */ struct ModuleActivator { virtual ~ModuleActivator() {} /** * Called when this module is loaded. This method * can be used to register services or to allocate any resources that this * module may need globally (during the whole module lifetime). * *

* This method must complete and return to its caller in a timely manner. * * @param context The execution context of the module being loaded. * @throws std::exception If this method throws an exception, this * module is marked as stopped and the framework will remove this * module's listeners, unregister all services registered by this * module, and release all services used by this module. */ virtual void Load(ModuleContext* context) = 0; /** * Called when this module is unloaded. In general, this * method should undo the work that the ModuleActivator::Load * method started. There should be no active threads that were started by * this module when this method returns. * *

* This method must complete and return to its caller in a timely manner. * * @param context The execution context of the module being unloaded. * @throws std::exception If this method throws an exception, the * module is still marked as unloaded, and the framework will remove * the module's listeners, unregister all services registered by the * module, and release all services used by the module. */ virtual void Unload(ModuleContext* context) = 0; }; US_END_NAMESPACE #define US_MODULE_ACTIVATOR_INSTANCE_FUNCTION(type) \ struct ScopedPointer \ { \ ScopedPointer(US_PREPEND_NAMESPACE(ModuleActivator)* activator = 0) : m_Activator(activator) {} \ ~ScopedPointer() { delete m_Activator; } \ US_PREPEND_NAMESPACE(ModuleActivator)* m_Activator; \ }; \ \ static ScopedPointer activatorPtr; \ if (activatorPtr.m_Activator == 0) activatorPtr.m_Activator = new type; \ return activatorPtr.m_Activator; /** * \ingroup MicroServices * * \brief Export a module activator class. * * \param _module_libname The physical name of the module, without prefix or suffix. * \param _activator_type The fully-qualified type-name of the module activator class. * * Call this macro after the definition of your module activator to make it * accessible by the CppMicroServices library. * * Example: * \snippet uServices-activator/main.cpp 0 + * + * \note If you use this macro in a source file compiled into an executable, additional + * requirements for the macro arguments apply: + * - The \c _module_libname argument must match the value of \c _module_name used in the + * \c #US_INITIALIZE_MODULE macro call. */ #define US_EXPORT_MODULE_ACTIVATOR(_module_libname, _activator_type) \ extern "C" US_ABI_EXPORT US_PREPEND_NAMESPACE(ModuleActivator)* _us_module_activator_instance_ ## _module_libname () \ { \ US_MODULE_ACTIVATOR_INSTANCE_FUNCTION(_activator_type) \ } #endif /* USMODULEACTIVATOR_H_ */ diff --git a/Core/Code/CppMicroServices/src/module/usModuleImport.h b/Core/Code/CppMicroServices/src/module/usModuleImport.h index f022bd6aa1..a5f7c99056 100644 --- a/Core/Code/CppMicroServices/src/module/usModuleImport.h +++ b/Core/Code/CppMicroServices/src/module/usModuleImport.h @@ -1,127 +1,158 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #ifndef USMODULEIMPORT_H #define USMODULEIMPORT_H #include #include US_BEGIN_NAMESPACE struct ModuleActivator; US_END_NAMESPACE /** * \ingroup MicroServices * * \brief Import a static module. * * \param _import_module_libname The physical name of the module to import, without prefix or suffix. * * This macro imports the static module named \c _import_module_libname. * * Inserting this macro into your application's source code will allow you to make use of * a static module. Do not forget to list the imported module when calling the macro * #US_LOAD_IMPORTED_MODULES and to actually link the static module to the importing * executable or shared library. * * Example: * \snippet uServices-staticmodules/main.cpp ImportStaticModuleIntoLib * * \sa US_LOAD_IMPORTED_MODULES * \sa \ref MicroServices_StaticModules */ #define US_IMPORT_MODULE(_import_module_libname) \ extern "C" US_PREPEND_NAMESPACE(ModuleActivator)* _us_module_activator_instance_ ## _import_module_libname (); \ void _dummy_reference_to_ ## _import_module_libname ## _activator() \ { \ _us_module_activator_instance_ ## _import_module_libname(); \ } +/** + * \ingroup MicroServices + * + * \brief Import a static module's resources. + * + * \param _import_module_libname The physical name of the module to import, without prefix or suffix. + * + * This macro imports the resources of the static module named \c _import_module_libname. + * + * Inserting this macro into your application's source code will allow you to make use of + * the resources embedded in a static module. Do not forget to list the imported module when + * calling the macro #US_LOAD_IMPORTED_MODULES and to actually link the static module to the + * importing executable or shared library. + * + * \sa US_IMPORT_MODULE + * \sa US_LOAD_IMPORTED_MODULES + * \sa \ref MicroServices_StaticModules + */ +#define US_IMPORT_MODULE_RESOURCES(_import_module_libname) \ + extern "C" US_PREPEND_NAMESPACE(ModuleActivator)* _us_init_resources_ ## _import_module_libname (); \ + void _dummy_reference_to_ ## _import_module_libname ## _init_resources() \ + { \ + _us_init_resources_ ## _import_module_libname(); \ + } + /** * \ingroup MicroServices * \def US_LOAD_IMPORTED_MODULES_INTO_MAIN(_static_modules) * * \brief Import a list of static modules into an executable. * * \param _static_modules A space-deliminated list of physical module names, without prefix * or suffix. * * This macro ensures that the ModuleActivator::Load(ModuleContext*) function is called - * for each imported static module when the importing executable is loaded. + * for each imported static module when the importing executable is loaded (if the static + * module provides an activator). If the static module provides embedded resources and + * the US_IMPORT_MODULE_RESOURCES macro was called, the resources will be made available + * through the importing module. * * There must be exactly one call of this macro in the executable which is * importing static modules. * * Example: * \snippet uServices-staticmodules/main.cpp ImportStaticModuleIntoMain * * \sa US_IMPORT_MODULE * \sa US_LOAD_IMPORTED_MODULES * \sa \ref MicroServices_StaticModules */ #ifdef US_BUILD_SHARED_LIBS #define US_LOAD_IMPORTED_MODULES_INTO_MAIN(_static_modules) \ extern "C" US_ABI_EXPORT const char* _us_get_imported_modules_for_() \ { \ return #_static_modules; \ } #else #define US_LOAD_IMPORTED_MODULES_INTO_MAIN(_static_modules) \ extern "C" US_ABI_EXPORT const char* _us_get_imported_modules_for_CppMicroServices() \ { \ return #_static_modules; \ } #endif /** * \ingroup MicroServices * * \brief Import a list of static modules into a shared library. * * \param _module_libname The physical name of the importing module, without prefix or suffix. * \param _static_modules A space-deliminated list of physical module names, without prefix * or suffix. * * This macro ensures that the ModuleActivator::Load(ModuleContext*) function is called - * for each imported static module when the importing shared library is loaded. + * for each imported static module when the importing shared library is loaded (if the static + * module provides an activator). If the static module provides embedded resources and + * the US_IMPORT_MODULE_RESOURCES macro was called, the resources will be made available + * through the importing module. * * There must be exactly one call of this macro in the shared library which is * importing static modules. * * Example: * \snippet uServices-staticmodules/main.cpp ImportStaticModuleIntoLib * * \sa US_IMPORT_MODULE * \sa US_LOAD_IMPORTED_MODULES_INTO_MAIN * \sa \ref MicroServices_StaticModules */ #define US_LOAD_IMPORTED_MODULES(_module_libname, _static_modules) \ extern "C" US_ABI_EXPORT const char* _us_get_imported_modules_for_ ## _module_libname () \ { \ return #_static_modules; \ } #endif // USMODULEREGISTRY_H diff --git a/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp b/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp index 810b2cc98f..669c333b67 100644 --- a/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp +++ b/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp @@ -1,35 +1,39 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include "usModuleInfo.h" US_BEGIN_NAMESPACE ModuleInfo::ModuleInfo(const std::string& name, const std::string& libName, const std::string& autoLoadDir, const std::string& moduleDeps, const std::string& version) - : name(name), libName(libName), moduleDeps(moduleDeps), - version(version), autoLoadDir(autoLoadDir), id(0), - activatorHook(0) + : name(name) + , libName(libName) + , moduleDeps(moduleDeps) + , version(version) + , autoLoadDir(autoLoadDir) + , id(0) + , activatorHook(NULL) {} US_END_NAMESPACE diff --git a/Core/Code/CppMicroServices/src/module/usModuleInfo.h b/Core/Code/CppMicroServices/src/module/usModuleInfo.h index c6dd8a5ea9..da9da07803 100644 --- a/Core/Code/CppMicroServices/src/module/usModuleInfo.h +++ b/Core/Code/CppMicroServices/src/module/usModuleInfo.h @@ -1,70 +1,80 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #ifndef USMODULEINFO_H #define USMODULEINFO_H #include #include +#include #ifdef _MSC_VER # pragma warning(push) # pragma warning(disable: 4251) #endif US_BEGIN_NAMESPACE struct ModuleActivator; /** * This class is not intended to be used directly. It is exported to support * the CppMicroServices module system. */ struct US_EXPORT ModuleInfo { ModuleInfo(const std::string& name, const std::string& libName, const std::string& autoLoadDir, const std::string& moduleDeps, const std::string& version); typedef ModuleActivator*(*ModuleActivatorHook)(void); + typedef int(*InitResourcesHook)(ModuleInfo*); + typedef const unsigned char* ModuleResourceData; std::string name; std::string libName; std::string moduleDeps; std::string version; std::string location; std::string autoLoadDir; long id; ModuleActivatorHook activatorHook; + + // In case of statically linked (imported) modules, there could + // be more than one set of ModuleResourceData pointers. We aggregate + // all pointers here. + std::vector resourceData; + std::vector resourceNames; + std::vector resourceTree; }; US_END_NAMESPACE #ifdef _MSC_VER # pragma warning(pop) #endif #endif // USMODULEINFO_H diff --git a/Core/Code/CppMicroServices/src/module/usModuleInitialization.h b/Core/Code/CppMicroServices/src/module/usModuleInitialization.h index a90c596c30..96b9a60b8f 100644 --- a/Core/Code/CppMicroServices/src/module/usModuleInitialization.h +++ b/Core/Code/CppMicroServices/src/module/usModuleInitialization.h @@ -1,164 +1,170 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include #include #include #include #include #include #ifndef USMODULEINITIALIZATION_H #define USMODULEINITIALIZATION_H /** * \ingroup MicroServices * * \brief Creates initialization code for a module. * * Each module which wants to register itself with the CppMicroServices library * has to put a call to this macro (or to #US_INITIALIZE_MODULE_WITH_CUSTOM_AUTOLOADDIR) * in one of its source files. * * Example call for a module with file-name "libmylibname.so". * \code * US_INITIALIZE_MODULE("My Service Implementation", "mylibname", "", "1.0.0") * \endcode * * This will initialize the module for use with the CppMicroServices library, using a default * auto-load directory named after the provided library name in \c _module_libname. * * \sa US_INITIALIZE_MODULE_WITH_CUSTOM_AUTOLOADDIR * * \remarks If you are using CMake, consider using the provided CMake macro * usFunctionGenerateModuleInit(). * * \param _module_name A human-readable name for the module. * If you use this macro in a source file for an executable, the module name must * be a valid C-identifier (no spaces etc.). * \param _module_libname The physical name of the module, withou prefix or suffix. * \param _module_depends A list of module dependencies. This is meta-data only. * \param _module_version A version string in the form of "...". + * + * \note If you use this macro in a source file compiled into an executable, additional + * requirements for the macro arguments apply: + * - The \c _module_name argument must be a valid C-identifier (no spaces etc.). + * - The \c _module_libname argument must be an empty string. + * */ #define US_INITIALIZE_MODULE(_module_name, _module_libname, _module_depends, _module_version) \ US_INITIALIZE_MODULE_WITH_CUSTOM_AUTOLOADDIR(_module_name, _module_libname, _module_libname, _module_depends, _module_version) /** * \ingroup MicroServices * * \brief Creates initialization code for a module using a custom auto-load directory. * * Each module which wants to register itself with the CppMicroServices library * has to put a call to this macro (or to #US_INITIALIZE_MODULE) in one of its source files. * * Example call for a module with file-name "libmylibname.so". * \code * US_INITIALIZE_MODULE_WITH_CUSTOM_AUTOLOADDIR("My Service Implementation", "mylibname", "autoload_mysublibs", "", "1.0.0") * \endcode * * \remarks If you are using CMake, consider using the provided CMake macro * usFunctionGenerateModuleInit(). * * \param _module_name A human-readable name for the module. * If you use this macro in a source file for an executable, the module name must * be a valid C-identifier (no spaces etc.). * \param _module_libname The physical name of the module, withou prefix or suffix. * \param _module_autoload_dir A directory name relative to this modules library location from which * modules will be auto-loaded during activation of this module. Provide an empty string to * disable auto-loading for this module. * \param _module_depends A list of module dependencies. This is meta-data only. * \param _module_version A version string in the form of "...". */ #define US_INITIALIZE_MODULE_WITH_CUSTOM_AUTOLOADDIR(_module_name, _module_libname, _module_autoload_dir, _module_depends, _module_version) \ US_BEGIN_NAMESPACE \ \ /* Declare a file scoped ModuleInfo object */ \ US_GLOBAL_STATIC_WITH_ARGS(ModuleInfo, moduleInfo, (_module_name, _module_libname, _module_autoload_dir, _module_depends, _module_version)) \ \ /* This class is used to statically initialize the library within the C++ Micro services \ library. It looks up a library specific C-style function returning an instance \ of the ModuleActivator interface. */ \ class US_ABI_LOCAL ModuleInitializer { \ \ public: \ \ ModuleInitializer() \ { \ std::string location = ModuleUtils::GetLibraryPath(moduleInfo()->libName, \ reinterpret_cast(moduleInfo)); \ std::string activator_func = "_us_module_activator_instance_"; \ if(moduleInfo()->libName.empty()) \ { \ activator_func.append(moduleInfo()->name); \ } \ else \ { \ activator_func.append(moduleInfo()->libName); \ } \ \ moduleInfo()->location = location; \ \ if (moduleInfo()->libName.empty()) \ { \ /* make sure we retrieve symbols from the executable, if "libName" is empty */ \ location.clear(); \ } \ moduleInfo()->activatorHook = reinterpret_cast(ModuleUtils::GetSymbol(location, activator_func.c_str())); \ \ Register(); \ } \ \ static void Register() \ { \ ModuleRegistry::Register(moduleInfo()); \ } \ \ ~ModuleInitializer() \ { \ ModuleRegistry::UnRegister(moduleInfo()); \ } \ \ }; \ \ US_ABI_LOCAL ModuleContext* GetModuleContext() \ { \ /* make sure the module is registered */ \ if (moduleInfo()->id == 0) \ { \ ModuleInitializer::Register(); \ } \ \ return ModuleRegistry::GetModule(moduleInfo()->id)->GetModuleContext(); \ } \ \ US_END_NAMESPACE \ \ static US_PREPEND_NAMESPACE(ModuleInitializer) _InitializeModule; // Static modules usually don't get initialization code. They are initialized within the // module importing the static module(s). #if defined(US_STATIC_MODULE) && !defined(US_FORCE_MODULE_INIT) #undef US_INITIALIZE_MODULE_WITH_CUSTOM_AUTOLOADDIR #define US_INITIALIZE_MODULE_WITH_CUSTOM_AUTOLOADDIR(_a,_b,_c,_d,_e) #endif #endif // USMODULEINITIALIZATION_H diff --git a/Core/Code/CppMicroServices/src/module/usModulePrivate.cpp b/Core/Code/CppMicroServices/src/module/usModulePrivate.cpp index d13a5f3ecf..77e10d4464 100644 --- a/Core/Code/CppMicroServices/src/module/usModulePrivate.cpp +++ b/Core/Code/CppMicroServices/src/module/usModulePrivate.cpp @@ -1,192 +1,248 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include #include "usModulePrivate.h" #include "usModule.h" #include "usModuleActivator.h" #include "usModuleUtils_p.h" #include "usCoreModuleContext_p.h" #include "usServiceRegistration.h" #include "usServiceReferencePrivate.h" #include #include +#include US_BEGIN_NAMESPACE AtomicInt ModulePrivate::idCounter; ModulePrivate::ModulePrivate(Module* qq, CoreModuleContext* coreCtx, ModuleInfo* info) - : coreCtx(coreCtx), info(*info), moduleContext(0), moduleActivator(0), q(qq) + : coreCtx(coreCtx) + , info(*info) + , moduleContext(0) + , moduleActivator(0) + , q(qq) { + // Parse the statically imported module library names + typedef const char*(*GetImportedModulesFunc)(void); + + std::string getImportedModulesSymbol("_us_get_imported_modules_for_"); + getImportedModulesSymbol += this->info.libName; + + std::string location = this->info.location; + if (this->info.libName.empty()) + { + /* make sure we retrieve symbols from the executable, if "libName" is empty */ + location.clear(); + } + + GetImportedModulesFunc getImportedModulesFunc = reinterpret_cast( + ModuleUtils::GetSymbol(location, getImportedModulesSymbol.c_str())); + if (getImportedModulesFunc != NULL) + { + std::string importedStaticModuleLibNames = getImportedModulesFunc(); + + std::istringstream iss(importedStaticModuleLibNames); + std::copy(std::istream_iterator(iss), std::istream_iterator(), + std::back_inserter >(this->staticModuleLibNames)); + } + + InitializeResources(location); std::stringstream propId; propId << this->info.id; properties[Module::PROP_ID()] = propId.str(); std::stringstream propModuleDepends; std::stringstream propLibDepends; - std::stringstream propPackageDepends; int counter = 0; int counter2 = 0; std::stringstream ss(this->info.moduleDeps); while (ss) { std::string moduleDep; ss >> moduleDep; if (!moduleDep.empty()) { Module* dep = ModuleRegistry::GetModule(moduleDep); if (dep) { requiresIds.push_back(dep->GetModuleId()); if (counter > 0) propModuleDepends << ", "; propModuleDepends << moduleDep; ++counter; } else { requiresLibs.push_back(moduleDep); if (counter2 > 0) propLibDepends << ", "; propLibDepends << moduleDep; ++counter2; } } } properties[Module::PROP_MODULE_DEPENDS()] = propModuleDepends.str(); properties[Module::PROP_LIB_DEPENDS()] = propLibDepends.str(); if (!this->info.version.empty()) { try { version = ModuleVersion(this->info.version); properties[Module::PROP_VERSION()] = this->info.version; } catch (const std::exception& e) { throw std::invalid_argument(std::string("CppMicroServices module does not specify a valid version identifier. Got exception: ") + e.what()); } } properties[Module::PROP_LOCATION()] = this->info.location; properties[Module::PROP_NAME()] = this->info.name; } ModulePrivate::~ModulePrivate() { delete moduleContext; + + for (std::size_t i = 0; i < this->resourceTreePtrs.size(); ++i) + { + delete resourceTreePtrs[i]; + } } void ModulePrivate::RemoveModuleResources() { coreCtx->listeners.RemoveAllListeners(moduleContext); std::list srs; coreCtx->services.GetRegisteredByModule(this, srs); for (std::list::iterator i = srs.begin(); i != srs.end(); ++i) { try { i->Unregister(); } catch (const std::logic_error& /*ignore*/) { // Someone has unregistered the service after stop completed. // This should not occur, but we don't want get stuck in // an illegal state so we catch it. } } srs.clear(); coreCtx->services.GetUsedByModule(q, srs); for (std::list::const_iterator i = srs.begin(); i != srs.end(); ++i) { i->GetReference().d->UngetService(q, false); } + + for (std::size_t i = 0; i < resourceTreePtrs.size(); ++i) + { + resourceTreePtrs[i]->Invalidate(); + } } void ModulePrivate::StartStaticModules() { - typedef const char*(*GetImportedModulesFunc)(void); - - std::string getImportedModulesSymbol("_us_get_imported_modules_for_"); - getImportedModulesSymbol += info.libName; - - std::string location = info.location; - if (info.libName.empty()) + std::string location = this->info.location; + if (this->info.libName.empty()) { /* make sure we retrieve symbols from the executable, if "libName" is empty */ location.clear(); } - GetImportedModulesFunc getImportedModulesFunc = reinterpret_cast(ModuleUtils::GetSymbol(location,getImportedModulesSymbol.c_str())); - - if (getImportedModulesFunc == NULL) return; - - std::string importedStaticModuleLibNames = getImportedModulesFunc(); - - std::vector staticModuleLibNames; - std::istringstream iss(importedStaticModuleLibNames); - std::copy(std::istream_iterator(iss), std::istream_iterator(), - std::back_inserter >(staticModuleLibNames)); - for (std::vector::iterator i = staticModuleLibNames.begin(); i != staticModuleLibNames.end(); ++i) { std::string staticActivatorSymbol = "_us_module_activator_instance_"; staticActivatorSymbol += *i; - ModuleInfo::ModuleActivatorHook staticActivator = reinterpret_cast(ModuleUtils::GetSymbol(location, staticActivatorSymbol.c_str())); + ModuleInfo::ModuleActivatorHook staticActivator = + reinterpret_cast(ModuleUtils::GetSymbol(location, staticActivatorSymbol.c_str())); if (staticActivator) { US_DEBUG << "Loading static activator " << *i; staticActivators.push_back(staticActivator); staticActivator()->Load(moduleContext); } else { - US_WARN << "Could not find an activator for the static module " << (*i) - << ". You either forgot a US_IMPORT_MODULE macro call in " << info.libName - << " or to link " << (*i) << " to " << info.libName << "."; + US_DEBUG << "Could not find an activator for the static module " << (*i) + << ". It propably does not provide an activator on purpose.\n Or you either " + "forgot a US_IMPORT_MODULE macro call in " << info.libName + << " or to link " << (*i) << " to " << info.libName << "."; } } } void ModulePrivate::StopStaticModules() { for (std::list::iterator i = staticActivators.begin(); i != staticActivators.end(); ++i) { (*i)()->Unload(moduleContext); } } +void ModulePrivate::InitializeResources(const std::string& location) +{ + // Get the resource data from static modules and this module + std::vector moduleLibNames; + moduleLibNames.push_back(this->info.libName); + moduleLibNames.insert(moduleLibNames.end(), + this->staticModuleLibNames.begin(), this->staticModuleLibNames.end()); + + std::string initResourcesSymbolPrefix = "_us_init_resources_"; + for (std::size_t i = 0; i < moduleLibNames.size(); ++i) + { + std::string initResourcesSymbol = initResourcesSymbolPrefix + moduleLibNames[i]; + ModuleInfo::InitResourcesHook initResourcesFunc = reinterpret_cast( + ModuleUtils::GetSymbol(location, initResourcesSymbol.c_str())); + if (initResourcesFunc) + { + initResourcesFunc(&this->info); + } + } + + // Initialize this modules resource trees + assert(this->info.resourceData.size() == this->info.resourceNames.size()); + assert(this->info.resourceNames.size() == this->info.resourceTree.size()); + for (std::size_t i = 0; i < this->info.resourceData.size(); ++i) + { + resourceTreePtrs.push_back(new ModuleResourceTree(this->info.resourceTree[i], + this->info.resourceNames[i], + this->info.resourceData[i])); + } +} + US_END_NAMESPACE diff --git a/Core/Code/CppMicroServices/src/module/usModulePrivate.h b/Core/Code/CppMicroServices/src/module/usModulePrivate.h index 99c02469a7..6d1f4e4a07 100644 --- a/Core/Code/CppMicroServices/src/module/usModulePrivate.h +++ b/Core/Code/CppMicroServices/src/module/usModulePrivate.h @@ -1,98 +1,105 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #ifndef USMODULEPRIVATE_H #define USMODULEPRIVATE_H #include #include #include "usModuleRegistry.h" #include "usModuleVersion.h" #include "usModuleInfo.h" +#include "usModuleResourceTree_p.h" #include "usAtomicInt_p.h" US_BEGIN_NAMESPACE class CoreModuleContext; class ModuleContext; struct ModuleActivator; /** * \ingroup MicroServices */ class ModulePrivate { public: /** * Construct a new module based on a ModuleInfo object. */ ModulePrivate(Module* qq, CoreModuleContext* coreCtx, ModuleInfo* info); virtual ~ModulePrivate(); void RemoveModuleResources(); void StartStaticModules(); void StopStaticModules(); CoreModuleContext* const coreCtx; std::vector requiresIds; std::vector requiresLibs; + std::vector staticModuleLibNames; + /** * Module version */ ModuleVersion version; ModuleInfo info; + std::vector resourceTreePtrs; + /** * ModuleContext for the module */ ModuleContext* moduleContext; ModuleActivator* moduleActivator; std::map properties; Module* const q; private: + void InitializeResources(const std::string& location); + std::list staticActivators; static AtomicInt idCounter; // purposely not implemented ModulePrivate(const ModulePrivate&); ModulePrivate& operator=(const ModulePrivate&); }; US_END_NAMESPACE #endif // USMODULEPRIVATE_H diff --git a/Core/Code/CppMicroServices/src/module/usModuleResource.cpp b/Core/Code/CppMicroServices/src/module/usModuleResource.cpp new file mode 100644 index 0000000000..4af82ea877 --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResource.cpp @@ -0,0 +1,262 @@ +/*============================================================================= + + Library: CppMicroServices + + Copyright (c) German Cancer Research Center, + Division of Medical and Biological Informatics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================*/ + + +#include "usModuleResource.h" + +#include "usAtomicInt_p.h" +#include "usModuleResourceTree_p.h" + +#include + +US_BEGIN_NAMESPACE + +class ModuleResourcePrivate +{ + +public: + + ModuleResourcePrivate() + : associatedResourceTree(NULL) + , node(-1) + , size(0) + , data(NULL) + , isFile(false) + , ref(1) + {} + + std::string fileName; + std::string path; + std::string filePath; + + std::vector resourceTrees; + const ModuleResourceTree* associatedResourceTree; + + int node; + int32_t size; + const unsigned char* data; + + mutable std::vector children; + + bool isFile; + + /** + * Reference count for implicitly shared private implementation. + */ + AtomicInt ref; +}; + +ModuleResource::ModuleResource() + : d(new ModuleResourcePrivate) +{ +} + +ModuleResource::ModuleResource(const ModuleResource &resource) + : d(resource.d) +{ + d->ref.Ref(); +} + +ModuleResource::ModuleResource(const std::string& _file, ModuleResourceTree* associatedResourceTree, + const std::vector& resourceTrees) + : d(new ModuleResourcePrivate) +{ + d->resourceTrees = resourceTrees; + d->associatedResourceTree = associatedResourceTree; + + std::string file = _file; + if (file.empty()) file = "/"; + if (file[0] != '/') file = std::string("/") + file; + + std::size_t index = file.find_last_of('/'); + if (index < file.size()-1) + { + d->fileName = file.substr(index+1); + } + std::string rawPath = file.substr(0,index+1); + + // remove duplicate / + std::string::value_type lastChar = 0; + for (std::size_t i = 0; i < rawPath.size(); ++i) + { + if (rawPath[i] == '/' && lastChar == '/') + { + continue; + } + lastChar = rawPath[i]; + d->path.push_back(lastChar); + } + + d->filePath = d->path + d->fileName; + + d->node = d->associatedResourceTree->FindNode(GetResourcePath()); + if (d->node != -1) + { + d->isFile = !associatedResourceTree->IsDir(d->node); + if (d->isFile) + { + d->data = d->associatedResourceTree->GetData(d->node, &d->size); + } + } +} + +ModuleResource::~ModuleResource() +{ + if (!d->ref.Deref()) + delete d; +} + +ModuleResource& ModuleResource::operator =(const ModuleResource& resource) +{ + ModuleResourcePrivate* curr_d = d; + d = resource.d; + d->ref.Ref(); + + if (!curr_d->ref.Deref()) + delete curr_d; + + return *this; +} + +bool ModuleResource::operator <(const ModuleResource& resource) const +{ + return this->GetResourcePath() < resource.GetResourcePath(); +} + +bool ModuleResource::operator ==(const ModuleResource& resource) const +{ + return d->associatedResourceTree == resource.d->associatedResourceTree && + this->GetResourcePath() == resource.GetResourcePath(); +} + +bool ModuleResource::operator !=(const ModuleResource &resource) const +{ + return !(*this == resource); +} + +bool ModuleResource::IsValid() const +{ + return d->associatedResourceTree && d->associatedResourceTree->IsValid() && d->node > -1; +} + +ModuleResource::operator bool() const +{ + return IsValid(); +} + +std::string ModuleResource::GetName() const +{ + return d->fileName; +} + +std::string ModuleResource::GetPath() const +{ + return d->path; +} + +std::string ModuleResource::GetResourcePath() const +{ + return d->filePath; +} + +std::string ModuleResource::GetBaseName() const +{ + return d->fileName.substr(0, d->fileName.find_first_of('.')); +} + +std::string ModuleResource::GetCompleteBaseName() const +{ + return d->fileName.substr(0, d->fileName.find_last_of('.')); +} + +std::string ModuleResource::GetSuffix() const +{ + std::size_t index = d->fileName.find_last_of('.'); + return index < d->fileName.size()-1 ? d->fileName.substr(index+1) : std::string(""); +} + +std::string ModuleResource::GetCompleteSuffix() const +{ + std::size_t index = d->fileName.find_first_of('.'); + return index < d->fileName.size()-1 ? d->fileName.substr(index+1) : std::string(""); +} + +bool ModuleResource::IsDir() const +{ + return !d->isFile; +} + +bool ModuleResource::IsFile() const +{ + return d->isFile; +} + +std::vector ModuleResource::GetChildren() const +{ + if (d->isFile || !IsValid()) return d->children; + + if (!d->children.empty()) return d->children; + + bool indexPastAssociatedResTree = false; + for (std::size_t i = 0; i < d->resourceTrees.size(); ++i) + { + if (d->resourceTrees[i] == d->associatedResourceTree) + { + indexPastAssociatedResTree = true; + d->associatedResourceTree->GetChildren(d->node, d->children); + } + else if (indexPastAssociatedResTree) + { + int nodeIndex = d->resourceTrees[i]->FindNode(GetPath()); + if (nodeIndex > -1) + { + d->resourceTrees[i]->GetChildren(d->node, d->children); + } + } + } + return d->children; +} + +int ModuleResource::GetSize() const +{ + return d->size; +} + +const unsigned char* ModuleResource::GetData() const +{ + if (!IsValid()) return NULL; + return d->data; +} + +std::size_t ModuleResource::Hash() const +{ + using namespace US_HASH_FUNCTION_NAMESPACE; + return US_HASH_FUNCTION(std::string, this->GetResourcePath()); +} + +US_END_NAMESPACE + +US_USE_NAMESPACE + +std::ostream& operator<<(std::ostream& os, const ModuleResource& resource) +{ + return os << resource.GetResourcePath(); +} diff --git a/Core/Code/CppMicroServices/src/module/usModuleResource.h b/Core/Code/CppMicroServices/src/module/usModuleResource.h new file mode 100644 index 0000000000..1bcf8a0657 --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResource.h @@ -0,0 +1,293 @@ +/*============================================================================= + + Library: CppMicroServices + + Copyright (c) German Cancer Research Center, + Division of Medical and Biological Informatics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================*/ + + +#ifndef USMODULERESOURCE_H +#define USMODULERESOURCE_H + +#include + +#include +#include + +US_MSVC_PUSH_DISABLE_WARNING(4396) + +US_BEGIN_NAMESPACE + +class ModuleResourcePrivate; +class ModuleResourceTree; + +/** + * \ingroup MicroServices + * + * Represents a resource (text file, image, etc.) embedded in a CppMicroServices module. + * + * A \c %ModuleResource object provides information about a resource (external file) which + * was embedded into this module's shared library. \c %ModuleResource objects can be obtained + * be calling Module#GetResource or Module#FindResources. + * + * Example code for retreiving a resource object and reading its contents: + * \snippet uServices-resources/main.cpp 1 + * + * %ModuleResource objects have value semantics and copies are very inexpensive. + * + * \see ModuleResourceStream + * \see \ref MicroServices_Resources + */ +class US_EXPORT ModuleResource +{ + +public: + + /** + * Creates in invalid %ModuleResource object. + */ + ModuleResource(); + /** + * Copy constructor. + * @param resource The object to be copied. + */ + ModuleResource(const ModuleResource& resource); + + ~ModuleResource(); + + /** + * Assignment operator. + * + * @param resource The %ModuleResource object which is assigned to this instance. + * @return A reference to this %ModuleResource instance. + */ + ModuleResource& operator=(const ModuleResource& resource); + + /** + * A less then operator using the full resource path as returned by + * GetResourcePath() to define the ordering. + * + * @param resource The object to which this %ModuleResource object is compared to. + * @return \c true if this %ModuleResource object is less then \c resource, + * \c false otherwise. + */ + bool operator<(const ModuleResource& resource) const; + + /** + * Equality operator for %ModuleResource objects. + * + * @param resource The object for testing equality. + * @return \c true if this %ModuleResource object is equal to \c resource, i.e. + * they are coming from the same module (shared or static) and have an equal + * resource path, \c false otherwise. + */ + bool operator==(const ModuleResource& resource) const; + + /** + * Inequality operator for %ModuleResource objects. + * + * @param resource The object for testing inequality. + * @return The result of !(*this == resource). + */ + bool operator!=(const ModuleResource& resource) const; + + /** + * Tests this %ModuleResource object for validity. + * + * Invalid %ModuleResource objects are created by the default constructor or + * can be returned by the Module class if the resource path is not found. If a + * module from which %ModuleResource objects have been obtained is un-loaded, + * these objects become invalid. + * + * @return \c true if this %ModuleReource object is valid and can safely be used, + * \c false otherwise. + */ + bool IsValid() const; + + /** + * Boolean conversion operator using IsValid(). + */ + operator bool() const; + + /** + * Returns the name of the resource, excluding the path. + * + * Example: + * \code + * ModuleResource resource = module->GetResource("/data/archive.tar.gz"); + * std::string name = resource.GetName(); // name = "archive.tar.gz" + * \endcode + * + * @return The resource name. + * @see GetPath(), GetResourcePath() + */ + std::string GetName() const; + + /** + * Returns the resource's path, without the file name. + * + * Example: + * \code + * ModuleResource resource = module->GetResource("/data/archive.tar.gz"); + * std::string path = resource.GetPath(); // path = "/data" + * \endcode + * + * @return The resource path without the name. + * @see GetResourcePath(), GetName() and IsDir() + */ + std::string GetPath() const; + + /** + * Returns the resource name including the path. + * + * @return The resource path include the name. + * @see GetPath(), GetName() and IsDir() + */ + std::string GetResourcePath() const; + + /** + * Returns the base name of the resource without the path. + * + * Example: + * \code + * ModuleResource resource = module->GetResource("/data/archive.tar.gz"); + * std::string base = resource.GetBaseName(); // base = "archive" + * \endcode + * + * @return The resource base name. + * @see GetName(), GetSuffix(), GetCompleteSuffix() and GetCompleteBaseName() + */ + std::string GetBaseName() const; + + /** + * Returns the complete base name of the resource without the path. + * + * Example: + * \code + * ModuleResource resource = module->GetResource("/data/archive.tar.gz"); + * std::string base = resource.GetCompleteBaseName(); // base = "archive.tar" + * \endcode + * + * @return The resource's complete base name. + * @see GetName(), GetSuffix(), GetCompleteSuffix(), and GetBaseName() + */ + std::string GetCompleteBaseName() const; + + /** + * Returns the suffix of the resource. + * + * The suffix consists of all characters in the resource name after (but not + * including) the last '.'. + * + * Example: + * \code + * ModuleResource resource = module->GetResource("/data/archive.tar.gz"); + * std::string suffix = resource.GetSuffix(); // suffix = "gz" + * \endcode + * + * @return The resource name suffix. + * @see GetName(), GetCompleteSuffix(), GetBaseName() and GetCompleteBaseName() + */ + std::string GetSuffix() const; + + /** + * Returns the complete suffix of the resource. + * + * The suffix consists of all characters in the resource name after (but not + * including) the first '.'. + * + * Example: + * \code + * ModuleResource resource = module->GetResource("/data/archive.tar.gz"); + * std::string suffix = resource.GetCompleteSuffix(); // suffix = "tar.gz" + * \endcode + * + * @return The resource name suffix. + * @see GetName(), GetSuffix(), GetBaseName(), and GetCompleteBaseName() + */ + std::string GetCompleteSuffix() const; + + /** + * Returns \c true if this %ModuleResource object points to a directory. + * + * @return \c true if this object points to a directory, \c false otherwise. + */ + bool IsDir() const; + + /** + * Returns \c true if this %ModuleResource object points to a file resource. + * + * @return \c true if this object points to an embedded file, \c false otherwise. + */ + bool IsFile() const; + + /** + * Returns a list of resource names which are children of this object. + * + * The returned names are relative to the path of this %ModuleResource object and + * may contain duplicates in case of modules which are statically linked into the + * module from which this object was retreived. + * + * @return A list of child resource names. + */ + std::vector GetChildren() const; + + /** + * Returns the size of the raw embedded data for this %ModuleResource object. + * + * @return The resource data size. + */ + int GetSize() const; + + /** + * Returns a data pointer pointing to the raw data of this %ModuleResource object. + * + * @return A raw pointer to the embedded data. + */ + const unsigned char* GetData() const; + +private: + + ModuleResource(const std::string& file, ModuleResourceTree* resourceTree, + const std::vector& resourceTrees); + + friend class Module; + + US_HASH_FUNCTION_FRIEND(ModuleResource); + + std::size_t Hash() const; + + ModuleResourcePrivate* d; + +}; + +US_END_NAMESPACE + +US_MSVC_POP_WARNING + +/** + * \ingroup MicroServices + */ +US_EXPORT std::ostream& operator<<(std::ostream& os, const US_PREPEND_NAMESPACE(ModuleResource)& resource); + +US_HASH_FUNCTION_NAMESPACE_BEGIN +US_HASH_FUNCTION_BEGIN(US_PREPEND_NAMESPACE(ModuleResource)) + return arg.Hash(); +US_HASH_FUNCTION_END +US_HASH_FUNCTION_NAMESPACE_END + +#endif // USMODULERESOURCE_H diff --git a/Core/Code/CppMicroServices/src/module/usModuleResourceBuffer.cpp b/Core/Code/CppMicroServices/src/module/usModuleResourceBuffer.cpp new file mode 100644 index 0000000000..3b76d4aa9e --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResourceBuffer.cpp @@ -0,0 +1,275 @@ +/*=================================================================== + +BlueBerry Platform + +Copyright (c) German Cancer Research Center, +Division of Medical and Biological Informatics. +All rights reserved. + +This software is distributed WITHOUT ANY WARRANTY; without +even the implied warranty of MERCHANTABILITY or FITNESS FOR +A PARTICULAR PURPOSE. + +See LICENSE.txt or http://www.mitk.org for details. + +===================================================================*/ + +#include "usModuleResourceBuffer_p.h" + +#include "stdint_p.h" + +#include +#include + +#ifdef US_PLATFORM_WINDOWS +#define DATA_NEEDS_NEWLINE_CONVERSION 1 +#undef REMOVE_LAST_NEWLINE_IN_TEXT_MODE +#else +#undef DATA_NEEDS_NEWLINE_CONVERSION +#define REMOVE_LAST_NEWLINE_IN_TEXT_MODE 1 +#endif + +US_BEGIN_NAMESPACE + +static const std::size_t BUFFER_SIZE = 1024; + +class ModuleResourceBufferPrivate +{ +public: + + ModuleResourceBufferPrivate(const char* begin, std::size_t size, std::ios_base::openmode mode) + : begin(begin) + , end(begin + size) + , current(begin) + , mode(mode) + #ifdef DATA_NEEDS_NEWLINE_CONVERSION + , pos(0) + #endif + { + } + + const char* const begin; + const char* const end; + const char* current; + + const std::ios_base::openmode mode; + +#ifdef DATA_NEEDS_NEWLINE_CONVERSION + // records the stream position ignoring CR characters + std::streambuf::pos_type pos; +#endif + +}; + +ModuleResourceBuffer::ModuleResourceBuffer(const unsigned char* data, std::size_t _size, + std::ios_base::openmode mode) + : d(NULL) +{ + assert(_size < static_cast(std::numeric_limits::max())); + // assert(data != NULL); + + const char* begin = reinterpret_cast(data); + std::size_t size = _size; + +#ifdef DATA_NEEDS_NEWLINE_CONVERSION + if (data != NULL && !(mode & std::ios_base::binary) && begin[0] == '\r') + { + ++begin; + --size; + } +#endif + +#ifdef REMOVE_LAST_NEWLINE_IN_TEXT_MODE + if(data != NULL && !(mode & std::ios_base::binary) && begin[size-1] == '\n') + { + --size; + } +#endif + + d = new ModuleResourceBufferPrivate(begin, size, mode); +} + +ModuleResourceBuffer::~ModuleResourceBuffer() +{ + delete d; +} + +ModuleResourceBuffer::int_type ModuleResourceBuffer::underflow() +{ + if (d->current == d->end) + return traits_type::eof(); + +#ifdef DATA_NEEDS_NEWLINE_CONVERSION + char c = *d->current; + if (!(d->mode & std::ios_base::binary)) + { + if (c == '\r') + { + if (d->current + 1 == d->end) + { + return traits_type::eof(); + } + c = d->current[1]; + } + } + return traits_type::to_int_type(c); +#else + return traits_type::to_int_type(*d->current); +#endif +} + +ModuleResourceBuffer::int_type ModuleResourceBuffer::uflow() +{ + if (d->current == d->end) + return traits_type::eof(); + +#ifdef DATA_NEEDS_NEWLINE_CONVERSION + char c = *d->current++; + if (!(d->mode & std::ios_base::binary)) + { + if (c == '\r') + { + if (d->current == d->end) + { + return traits_type::eof(); + } + c = *d->current++; + } + } + return traits_type::to_int_type(c); +#else + return traits_type::to_int_type(*d->current++); +#endif +} + +ModuleResourceBuffer::int_type ModuleResourceBuffer::pbackfail(int_type ch) +{ + int backOffset = -1; +#ifdef DATA_NEEDS_NEWLINE_CONVERSION + if (!(d->mode & std::ios_base::binary)) + { + while ((d->current - backOffset) >= d->begin && d->current[backOffset] == '\r') + { + --backOffset; + } + // d->begin always points to a character != '\r' + } +#endif + if (d->current == d->begin || (ch != traits_type::eof() && ch != d->current[backOffset])) + { + return traits_type::eof(); + } + + d->current += backOffset; + return traits_type::to_int_type(*d->current); +} + +std::streamsize ModuleResourceBuffer::showmanyc() +{ + assert(d->current <= d->end); + +#ifdef DATA_NEEDS_NEWLINE_CONVERSION + std::streamsize ssize = 0; + std::size_t chunkSize = d->end - d->current; + for (std::size_t i = 0; i < chunkSize; ++i) + { + if (d->current[i] != '\r') + { + ++ssize; + } + } + return ssize; +#else + return d->end - d->current; +#endif +} + +std::streambuf::pos_type ModuleResourceBuffer::seekoff(std::streambuf::off_type off, + std::ios_base::seekdir way, + std::ios_base::openmode /*which*/) +{ +#ifdef DATA_NEEDS_NEWLINE_CONVERSION + std::streambuf::off_type step = 1; + if (way == std::ios_base::beg) + { + d->current = d->begin; + } + else if (way == std::ios_base::end) + { + d->current = d->end; + step = -1; + } + + if (!(d->mode & std::ios_base::binary)) + { + if (way == std::ios_base::beg) + { + d->pos = 0; + } + else if (way == std::ios_base::end) + { + d->current -= 1; + } + + std::streambuf::off_type i = 0; + // scan through off amount of characters excluding '\r' + while (i != off) + { + if (*d->current != '\r') + { + i += step; + d->pos += step; + } + d->current += step; + } + + // adjust the position in case of a "backwards" seek + if (way == std::ios_base::end) + { + // fix pointer from previous while loop + d->current += 1; + d->pos = 0; + i = 0; + const std::streampos currInternalPos = d->current - d->begin; + while (i != currInternalPos) + { + if (d->begin[i] != '\r') + { + d->pos += 1; + } + ++i; + } + } + } + else + { + d->current += off; + d->pos = d->current - d->begin; + } + return d->pos; +#else + if (way == std::ios_base::beg) + { + d->current = d->begin + off; + return off; + } + else if (way == std::ios_base::cur) + { + d->current += off; + return d->current - d->begin; + } + else + { + d->current = d->end + off; + return d->current - d->begin; + } +#endif +} + +std::streambuf::pos_type ModuleResourceBuffer::seekpos(std::streambuf::pos_type sp, + std::ios_base::openmode /*which*/) +{ + return this->seekoff(sp, std::ios_base::beg); +} + +US_END_NAMESPACE diff --git a/Core/Code/CppMicroServices/src/module/usModuleResourceBuffer_p.h b/Core/Code/CppMicroServices/src/module/usModuleResourceBuffer_p.h new file mode 100644 index 0000000000..8432a5ab23 --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResourceBuffer_p.h @@ -0,0 +1,63 @@ +/*=================================================================== + +BlueBerry Platform + +Copyright (c) German Cancer Research Center, +Division of Medical and Biological Informatics. +All rights reserved. + +This software is distributed WITHOUT ANY WARRANTY; without +even the implied warranty of MERCHANTABILITY or FITNESS FOR +A PARTICULAR PURPOSE. + +See LICENSE.txt or http://www.mitk.org for details. + +===================================================================*/ + +#ifndef USMODULERESOURCEBUFFER_P_H +#define USMODULERESOURCEBUFFER_P_H + +#include + +#include + +US_BEGIN_NAMESPACE + +class ModuleResourceBufferPrivate; + +class US_EXPORT ModuleResourceBuffer: public std::streambuf +{ + +public: + + explicit ModuleResourceBuffer(const unsigned char* data, std::size_t size, + std::ios_base::openmode mode); + + ~ModuleResourceBuffer(); + +private: + + int_type underflow(); + + int_type uflow(); + + int_type pbackfail(int_type ch); + + std::streamsize showmanyc(); + + pos_type seekoff (off_type off, std::ios_base::seekdir way, std::ios_base::openmode which = std::ios_base::in | std::ios_base::out); + pos_type seekpos (pos_type sp, std::ios_base::openmode which = std::ios_base::in | std::ios_base::out); + + // purposely not implemented + ModuleResourceBuffer(const ModuleResourceBuffer&); + ModuleResourceBuffer& operator=(const ModuleResourceBuffer&); + +private: + + ModuleResourceBufferPrivate* d; + +}; + +US_END_NAMESPACE + +#endif // USMODULERESOURCEBUFFER_P_H diff --git a/Core/Code/CppMicroServices/src/module/usModuleResourceStream.cpp b/Core/Code/CppMicroServices/src/module/usModuleResourceStream.cpp new file mode 100644 index 0000000000..3288e4c463 --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResourceStream.cpp @@ -0,0 +1,34 @@ +/*=================================================================== + +BlueBerry Platform + +Copyright (c) German Cancer Research Center, +Division of Medical and Biological Informatics. +All rights reserved. + +This software is distributed WITHOUT ANY WARRANTY; without +even the implied warranty of MERCHANTABILITY or FITNESS FOR +A PARTICULAR PURPOSE. + +See LICENSE.txt or http://www.mitk.org for details. + +===================================================================*/ + +#include "usModuleResourceStream.h" + +#include "usModuleResource.h" + +// 'this' used in base member initializer list +US_MSVC_PUSH_DISABLE_WARNING(4355) + +US_BEGIN_NAMESPACE + +ModuleResourceStream::ModuleResourceStream(const ModuleResource& resource, std::ios_base::openmode mode) + : ModuleResourceBuffer(resource.GetData(), resource.GetSize(), mode | std::ios_base::in) + , std::istream(this) +{ +} + +US_END_NAMESPACE + +US_MSVC_POP_WARNING \ No newline at end of file diff --git a/Core/Code/CppMicroServices/src/module/usModuleResourceStream.h b/Core/Code/CppMicroServices/src/module/usModuleResourceStream.h new file mode 100644 index 0000000000..7c4610e1dc --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResourceStream.h @@ -0,0 +1,65 @@ +/*=================================================================== + +BlueBerry Platform + +Copyright (c) German Cancer Research Center, +Division of Medical and Biological Informatics. +All rights reserved. + +This software is distributed WITHOUT ANY WARRANTY; without +even the implied warranty of MERCHANTABILITY or FITNESS FOR +A PARTICULAR PURPOSE. + +See LICENSE.txt or http://www.mitk.org for details. + +===================================================================*/ + +#ifndef USMODULERESOURCESTREAM_H +#define USMODULERESOURCESTREAM_H + +#include "usModuleResourceBuffer_p.h" + +#include + +US_BEGIN_NAMESPACE + +class ModuleResource; + +/** + * \ingroup MicroServices + * + * An input stream class for ModuleResource objects. + * + * This class provides access to the resource data embedded in a module's + * shared library via a STL input stream interface. + * + * \see ModuleResource for an example how to use this class. + */ +class US_EXPORT ModuleResourceStream : private ModuleResourceBuffer, public std::istream +{ + +public: + + /** + * Construct a %ModuleResourceStream object. + * + * @param resource The ModuleResource object for which an input stream + * should be constructed. + * @param mode The open mode of the stream. If \c std::ios_base::binary + * is used, the resource data will be treated as binary data, otherwise + * the data is interpreted as text data and the usual platform specific + * end-of-line translations take place. + */ + ModuleResourceStream(const ModuleResource& resource, + std::ios_base::openmode mode = std::ios_base::in); + +private: + + // purposely not implemented + ModuleResourceStream(const ModuleResourceStream&); + ModuleResourceStream& operator=(const ModuleResourceStream&); +}; + +US_END_NAMESPACE + +#endif // USMODULERESOURCESTREAM_H diff --git a/Core/Code/CppMicroServices/src/module/usModuleResourceTree.cpp b/Core/Code/CppMicroServices/src/module/usModuleResourceTree.cpp new file mode 100644 index 0000000000..3c760e91a8 --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResourceTree.cpp @@ -0,0 +1,345 @@ +/*============================================================================= + + Library: CppMicroServices + + Copyright (c) German Cancer Research Center, + Division of Medical and Biological Informatics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================*/ + + +#include "usModuleResourceTree_p.h" + +#include "usUtils_p.h" +#include "stdint_p.h" + +#include +#include + +//#define DEBUG_RESOURCE_MATCH + +US_BEGIN_NAMESPACE + +US_EXPORT bool RegisterResourceData(int, ModuleInfo* moduleInfo, + ModuleInfo::ModuleResourceData resourceTree, + ModuleInfo::ModuleResourceData resourceNames, + ModuleInfo::ModuleResourceData resourceData) +{ + moduleInfo->resourceTree.push_back(resourceTree); + moduleInfo->resourceNames.push_back(resourceNames); + moduleInfo->resourceData.push_back(resourceData); + return true; +} + + +ModuleResourceTree::ModuleResourceTree(ModuleInfo::ModuleResourceData resourceTree, + ModuleInfo::ModuleResourceData resourceNames, + ModuleInfo::ModuleResourceData resourceData) + : isValid(resourceTree && resourceNames && resourceData) + , tree(resourceTree) + , names(resourceNames) + , payloads(resourceData) +{ +} + +bool ModuleResourceTree::IsValid() const +{ + return isValid; +} + +void ModuleResourceTree::Invalidate() +{ + isValid = false; +} + +inline std::string ModuleResourceTree::GetName(int node) const +{ + if(!node) // root + return std::string(); + + const int offset = FindOffset(node); + + std::string ret; + int nameOffset = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + const int16_t nameLength = (names[nameOffset+0] << 8) + + (names[nameOffset+1] << 0); + nameOffset += 2; // jump past name length + nameOffset += 4; // jump past hash + + ret.resize(nameLength); + for(int i = 0; i < nameLength; ++i) + { + ret[i] = names[nameOffset+i]; + } + return ret; +} + +int ModuleResourceTree::FindNode(const std::string& _path) const +{ + std::string path = _path.empty() ? "/" : _path; + +#ifdef DEBUG_RESOURCE_MATCH + US_DEBUG << "***" << " START " << path; +#endif + + if(path == "/") + return 0; + + // the root node is always first + int childCount = (tree[6] << 24) + (tree[7] << 16) + + (tree[8] << 8) + (tree[9] << 0); + int child = (tree[10] << 24) + (tree[11] << 16) + + (tree[12] << 8) + (tree[13] << 0); + + int node = -1; + + // split the full path into segments + std::vector segments; + { + std::stringstream ss(path); + std::string item; + while(std::getline(ss, item, '/')) + { + if (item.empty()) continue; + segments.push_back(item); + } + } + + //now iterate up the path hierarchy + for (std::size_t i = 0; i < segments.size() && childCount; ++i) + { + const std::string& segment = segments[i]; + +#ifdef DEBUG_RESOURCE_MATCH + US_DEBUG << " CHILDREN " << segment; + for(int j = 0; j < childCount; ++j) + { + US_DEBUG << " " << child+j << " :: " << GetName(child+j); + } +#endif + + // get the hash value for the current segment + const uint32_t currHash = static_cast(US_HASH_FUNCTION_NAMESPACE::US_HASH_FUNCTION(std::string,segment)); + + // do a binary search for the hash + int l = 0; + int r = childCount-1; + int subNode = (l+r+1)/2; + while(r != l) + { + const uint32_t subNodeHash = GetHash(child+subNode); + if(currHash == subNodeHash) + break; + else if(currHash < subNodeHash) + r = subNode - 1; + else + l = subNode; + subNode = (l+r+1) / 2; + } + subNode += child; + + // now check fo collisions and do compare using equality + bool found = false; + if(GetHash(subNode) == currHash) + { + while(subNode > child && GetHash(subNode-1) == currHash) // walk up to include all collisions + --subNode; + for(; subNode < child+childCount && GetHash(subNode) == currHash; ++subNode) + { + // now test using name comparison + if(GetName(subNode) == segment) + { + found = true; + int offset = FindOffset(subNode); +#ifdef DEBUG_RESOURCE_MATCH + US_DEBUG << " TRY " << subNode << " " << GetName(subNode) << " " << offset; +#endif + offset += 4; // jump past name + + const short flags = (tree[offset+0] << 8) + (tree[offset+1] << 0); + offset += 2; + + if(i == segments.size()-1) + { +#ifdef DEBUG_RESOURCE_MATCH + US_DEBUG << "!!!!" << " FINISHED " << subNode; +#endif + return subNode; + } + + // if we are not at the end of the resource path and the current + // segment is not a directory, return "not found" (this shouldn't happen). + if(!(flags & Directory)) + return -1; + + childCount = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + offset += 4; + child = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + break; + } + } + } + if(!found) + { + break; + } + } +#ifdef DEBUG_RESOURCE_MATCH + US_DEBUG << "***" << " FINISHED " << node; +#endif + return node; +} + +void ModuleResourceTree::FindNodes(const std::string& _path, + const std::string& _filePattern, + bool recurse, std::vector& result) +{ + std::string path = _path.empty() ? std::string("/") : _path; + if (path[path.size()-1] != '/') path.append("/"); + + std::string filePattern = _filePattern.empty() ? std::string("*") : _filePattern; + + int rootNode = FindNode(path); + if (rootNode > -1) + { + this->FindNodes(result, path, rootNode, filePattern, recurse); + } +} + +short ModuleResourceTree::GetFlags(int node) const +{ + if(node == -1) + return 0; + const int offset = FindOffset(node) + 4; //jump past name + return (tree[offset+0] << 8) + (tree[offset+1] << 0); +} + +void ModuleResourceTree::FindNodes(std::vector &result, const std::string& path, + const int rootNode, + const std::string &filePattern, bool recurse) +{ + int offset = FindOffset(rootNode) + 6; // jump past name and type + + const int childCount = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + offset += 4; + const int childNode = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + + for(int i = childNode; i < childNode+childCount; ++i) + { + const int childOffset = FindOffset(i); + const short childFlags = (tree[childOffset+4] << 8) + (tree[childOffset+5] << 0); + if (!(childFlags & Directory)) + { + const std::string name = GetName(i); + if (this->Matches(name, filePattern)) + { + result.push_back(path + name); + } + } + else if (recurse) + { + this->FindNodes(result, path + GetName(i) + "/", i, filePattern, recurse); + } + } +} + +uint32_t ModuleResourceTree::GetHash(int node) const +{ + if(!node) // root node + return 0; + + const int offset = FindOffset(node); + int nameOffset = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + nameOffset += 2; // jump past name length + return (names[nameOffset+0] << 24) + (names[nameOffset+1] << 16) + + (names[nameOffset+2] << 8) + (names[nameOffset+3] << 0); +} + +bool ModuleResourceTree::Matches(const std::string &name, const std::string &filePattern) +{ + // short-cut + if (filePattern == "*") return true; + + std::stringstream ss(filePattern); + std::string tok; + std::size_t pos = 0; + while(std::getline(ss, tok, '*')) + { + std::size_t index = name.find(tok, pos); + if (index == std::string::npos) return false; + pos = index + tok.size(); + } + return true; +} + +const unsigned char* ModuleResourceTree::GetData(int node, int32_t* size) const +{ + if(node == -1) + { + *size = 0; + return 0; + } + int offset = FindOffset(node) + 4; // jump past name + + const short flags = (tree[offset+0] << 8) + (tree[offset+1] << 0); + offset += 2; + + offset += 4; // jump past the padding + + if(!(flags & Directory)) + { + const int dataOffset = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + const int32_t dataLength = (payloads[dataOffset+0] << 24) + (payloads[dataOffset+1] << 16) + + (payloads[dataOffset+2] << 8) + (payloads[dataOffset+3] << 0); + const unsigned char* ret = payloads+dataOffset+4; + *size = dataLength; + return ret; + } + *size = 0; + return 0; +} + +void ModuleResourceTree::GetChildren(int node, std::vector& ret) const +{ + if(node == -1) + return; + + int offset = FindOffset(node) + 4; // jump past name + + const short flags = (tree[offset+0] << 8) + (tree[offset+1] << 0); + offset += 2; + + if(flags & Directory) + { + const int childCount = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + offset += 4; + const int childOffset = (tree[offset+0] << 24) + (tree[offset+1] << 16) + + (tree[offset+2] << 8) + (tree[offset+3] << 0); + for(int i = childOffset; i < childOffset+childCount; ++i) + { + ret.push_back(GetName(i)); + } + } +} + +US_END_NAMESPACE diff --git a/Core/Code/CppMicroServices/src/module/usModuleResourceTree_p.h b/Core/Code/CppMicroServices/src/module/usModuleResourceTree_p.h new file mode 100644 index 0000000000..9ebfb44cc3 --- /dev/null +++ b/Core/Code/CppMicroServices/src/module/usModuleResourceTree_p.h @@ -0,0 +1,96 @@ +/*============================================================================= + + Library: CppMicroServices + + Copyright (c) German Cancer Research Center, + Division of Medical and Biological Informatics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================*/ + + +#ifndef USMODULERESOURCETREE_H +#define USMODULERESOURCETREE_H + +#include + +#include "usModuleInfo.h" +#include "stdint_p.h" + +#include + +US_BEGIN_NAMESPACE + +struct ModuleInfo; + +/* + * This class represents the triple of data pointers + * (us_resource_data, us_resource_name, us_resource_tree) generate by + * the resource compiler. + * + * Each module owns zero or one such triple but in case of a statically + * linked (imported) module, the resource trees are "merged" together. + */ +class ModuleResourceTree +{ + +private: + + enum Flags + { + Directory = 0x01 + }; + + bool isValid; + const unsigned char *tree, *names, *payloads; + + // Returns the offset in the us_resource_tree array for a given node index + inline int FindOffset(int node) const { return node * 14; } // sizeof each tree element + + std::string GetName(int node) const; + short GetFlags(int node) const; + + void FindNodes(std::vector& result, const std::string& path, + const int rootNode, + const std::string& filePattern, bool recurse); + + uint32_t GetHash(int node) const; + + bool Matches(const std::string& name, const std::string& filePattern); + +public: + + ModuleResourceTree(ModuleInfo::ModuleResourceData resourceTree, + ModuleInfo::ModuleResourceData resourceNames, + ModuleInfo::ModuleResourceData resourceData); + + bool IsValid() const; + void Invalidate(); + + // Returns an index enumerating the info entries in the us_resource_tree array for + // the given resource path. + int FindNode(const std::string& path) const; + + void FindNodes(const std::string& path, const std::string& filePattern, + bool recurse, std::vector& result); + + inline bool IsDir(int node) const { return GetFlags(node) & Directory; } + const unsigned char* GetData(int node, int32_t *size) const; + void GetChildren(int node, std::vector& children) const; + +}; + +US_END_NAMESPACE + +#endif // USMODULERESOURCETREE_H diff --git a/Core/Code/CppMicroServices/src/service/usServiceReference.h b/Core/Code/CppMicroServices/src/service/usServiceReference.h index 773b77b9cd..c692f80cb7 100644 --- a/Core/Code/CppMicroServices/src/service/usServiceReference.h +++ b/Core/Code/CppMicroServices/src/service/usServiceReference.h @@ -1,225 +1,223 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #ifndef USSERVICEREFERENCE_H #define USSERVICEREFERENCE_H #include -#ifdef _MSC_VER -#pragma warning(push) -#pragma warning(disable:4396) -#endif +US_MSVC_PUSH_DISABLE_WARNING(4396) US_BEGIN_NAMESPACE class Module; class ServiceRegistrationPrivate; class ServiceReferencePrivate; /** * \ingroup MicroServices * * A reference to a service. * *

* The framework returns ServiceReference objects from the * ModuleContext::GetServiceReference and * ModuleContext::GetServiceReferences methods. *

* A ServiceReference object may be shared between modules and * can be used to examine the properties of the service and to get the service * object. *

* Every service registered in the framework has a unique * ServiceRegistration object and may have multiple, distinct * ServiceReference objects referring to it. * ServiceReference objects associated with a * ServiceRegistration are considered equal * (more specifically, their operator==() * method will return true when compared). *

* If the same service object is registered multiple times, * ServiceReference objects associated with different * ServiceRegistration objects are not equal. * * @see ModuleContext::GetServiceReference * @see ModuleContext::GetServiceReferences * @see ModuleContext::GetService * @remarks This class is thread safe. */ class US_EXPORT ServiceReference { public: /** * Creates an invalid ServiceReference object. You can use * this object in boolean expressions and it will evaluate to * false. */ ServiceReference(); ServiceReference(const ServiceReference& ref); /** * Converts this ServiceReference instance into a boolean * expression. If this instance was default constructed or * the service it references has been unregistered, the conversion * returns false, otherwise it returns true. */ operator bool() const; /** * Releases any resources held or locked by this * ServiceReference and renders it invalid. */ ServiceReference& operator=(int null); ~ServiceReference(); /** * Returns the property value to which the specified property key is mapped * in the properties ServiceProperties object of the service * referenced by this ServiceReference object. * *

* Property keys are case-insensitive. * *

* This method continues to return property values after the service has * been unregistered. This is so references to unregistered services can * still be interrogated. * * @param key The property key. * @return The property value to which the key is mapped; an invalid Any * if there is no property named after the key. */ Any GetProperty(const std::string& key) const; /** * Returns a list of the keys in the ServiceProperties * object of the service referenced by this ServiceReference * object. * *

* This method will continue to return the keys after the service has been * unregistered. This is so references to unregistered services can * still be interrogated. * * @param keys A vector being filled with the property keys. */ void GetPropertyKeys(std::vector& keys) const; /** * Returns the module that registered the service referenced by this * ServiceReference object. * *

* This method must return 0 when the service has been * unregistered. This can be used to determine if the service has been * unregistered. * * @return The module that registered the service referenced by this * ServiceReference object; 0 if that * service has already been unregistered. * @see ModuleContext::RegisterService(const std::vector&, US_BASECLASS_NAME*, const ServiceProperties&) */ Module* GetModule() const; /** * Returns the modules that are using the service referenced by this * ServiceReference object. Specifically, this method returns * the modules whose usage count for that service is greater than zero. * * @param modules A list of modules whose usage count for the service referenced * by this ServiceReference object is greater than * zero. */ void GetUsingModules(std::vector& modules) const; /** * Compares this ServiceReference with the specified * ServiceReference for order. * *

* If this ServiceReference and the specified * ServiceReference have the same \link ServiceConstants::SERVICE_ID() * service id\endlink they are equal. This ServiceReference is less * than the specified ServiceReference if it has a lower * {@link ServiceConstants::SERVICE_RANKING service ranking} and greater if it has a * higher service ranking. Otherwise, if this ServiceReference * and the specified ServiceReference have the same * {@link ServiceConstants::SERVICE_RANKING service ranking}, this * ServiceReference is less than the specified * ServiceReference if it has a higher * {@link ServiceConstants::SERVICE_ID service id} and greater if it has a lower * service id. * * @param reference The ServiceReference to be compared. * @return Returns a false or true if this * ServiceReference is less than or greater * than the specified ServiceReference. */ bool operator<(const ServiceReference& reference) const; bool operator==(const ServiceReference& reference) const; ServiceReference& operator=(const ServiceReference& reference); private: friend class ModulePrivate; friend class ModuleContext; friend class ServiceFilter; friend class ServiceRegistrationPrivate; friend class ServiceListeners; friend class LDAPFilter; template friend class ServiceTracker; template friend class ServiceTrackerPrivate; template friend class ModuleAbstractTracked; US_HASH_FUNCTION_FRIEND(ServiceReference); std::size_t Hash() const; ServiceReference(ServiceRegistrationPrivate* reg); ServiceReferencePrivate* d; }; US_END_NAMESPACE -#ifdef _MSC_VER -#pragma warning(pop) -#endif +US_MSVC_POP_WARNING +/** + * \ingroup MicroServices + */ US_EXPORT std::ostream& operator<<(std::ostream& os, const US_PREPEND_NAMESPACE(ServiceReference)& serviceRef); US_HASH_FUNCTION_NAMESPACE_BEGIN US_HASH_FUNCTION_BEGIN(US_PREPEND_NAMESPACE(ServiceReference)) return arg.Hash(); US_HASH_FUNCTION_END US_HASH_FUNCTION_NAMESPACE_END #endif // USSERVICEREFERENCE_H diff --git a/Core/Code/CppMicroServices/src/service/usServiceTracker.tpp b/Core/Code/CppMicroServices/src/service/usServiceTracker.tpp index 742291b621..17388d634f 100644 --- a/Core/Code/CppMicroServices/src/service/usServiceTracker.tpp +++ b/Core/Code/CppMicroServices/src/service/usServiceTracker.tpp @@ -1,448 +1,448 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include "usServiceTrackerPrivate.h" #include "usTrackedService_p.h" #include "usServiceException.h" #include "usModuleContext.h" #include #include US_BEGIN_NAMESPACE template ServiceTracker::~ServiceTracker() { Close(); delete d; } #ifdef _MSC_VER #pragma warning(push) #pragma warning(disable:4355) #endif template ServiceTracker::ServiceTracker(ModuleContext* context, const ServiceReference& reference, _ServiceTrackerCustomizer* customizer) : d(new _ServiceTrackerPrivate(this, context, reference, customizer)) { } template ServiceTracker::ServiceTracker(ModuleContext* context, const std::string& clazz, _ServiceTrackerCustomizer* customizer) : d(new _ServiceTrackerPrivate(this, context, clazz, customizer)) { } template ServiceTracker::ServiceTracker(ModuleContext* context, const LDAPFilter& filter, _ServiceTrackerCustomizer* customizer) : d(new _ServiceTrackerPrivate(this, context, filter, customizer)) { } template ServiceTracker::ServiceTracker(ModuleContext *context, ServiceTrackerCustomizer *customizer) : d(new _ServiceTrackerPrivate(this, context, us_service_interface_iid(), customizer)) { const char* clazz = us_service_interface_iid(); if (clazz == 0) throw ServiceException("The service interface class has no US_DECLARE_SERVICE_INTERFACE macro"); } #ifdef _MSC_VER #pragma warning(pop) #endif template void ServiceTracker::Open() { _TrackedService* t; { typename _ServiceTrackerPrivate::Lock l(d); if (d->trackedService) { return; } US_DEBUG(d->DEBUG) << "ServiceTracker::Open: " << d->filter; t = new _TrackedService(this, d->customizer); { typename _TrackedService::Lock l(*t); try { d->context->AddServiceListener(t, &_TrackedService::ServiceChanged, d->listenerFilter); std::list references; if (!d->trackClass.empty()) { references = d->GetInitialReferences(d->trackClass, std::string()); } else { if (d->trackReference.GetModule() != 0) { references.push_back(d->trackReference); } else { /* user supplied filter */ references = d->GetInitialReferences(std::string(), (d->listenerFilter.empty()) ? d->filter.ToString() : d->listenerFilter); } } /* set tracked with the initial references */ t->SetInitial(references); } catch (const std::invalid_argument& e) { throw std::runtime_error(std::string("unexpected std::invalid_argument exception: ") + e.what()); } } d->trackedService = t; } /* Call tracked outside of synchronized region */ t->TrackInitial(); /* process the initial references */ } template void ServiceTracker::Close() { _TrackedService* outgoing; std::list references; { typename _ServiceTrackerPrivate::Lock l(d); outgoing = d->trackedService; if (outgoing == 0) { return; } US_DEBUG(d->DEBUG) << "ServiceTracker::close:" << d->filter; outgoing->Close(); GetServiceReferences(references); d->trackedService = 0; try { d->context->RemoveServiceListener(outgoing, &_TrackedService::ServiceChanged); } catch (const std::logic_error& /*e*/) { /* In case the context was stopped. */ } } d->Modified(); /* clear the cache */ { typename _TrackedService::Lock l(outgoing); outgoing->NotifyAll(); /* wake up any waiters */ } for(std::list::const_iterator ref = references.begin(); ref != references.end(); ++ref) { outgoing->Untrack(*ref, ServiceEvent()); } if (d->DEBUG) { typename _ServiceTrackerPrivate::Lock l(d); if ((d->cachedReference.GetModule() == 0) && (d->cachedService == 0)) { US_DEBUG(true) << "ServiceTracker::close[cached cleared]:" << d->filter; } } delete outgoing; d->trackedService = 0; } template T ServiceTracker::WaitForService(unsigned long timeoutMillis) { T object = GetService(); while (object == 0) { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return 0; } { typename _TrackedService::Lock l(t); if (t->Size() == 0) { t->Wait(timeoutMillis); } } object = GetService(); } return object; } template void ServiceTracker::GetServiceReferences(std::list& refs) const { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return; } { typename _TrackedService::Lock l(t); d->GetServiceReferences_unlocked(refs, t); } } template ServiceReference ServiceTracker::GetServiceReference() const { ServiceReference reference(0); { typename _ServiceTrackerPrivate::Lock l(d); reference = d->cachedReference; } if (reference.GetModule() != 0) { US_DEBUG(d->DEBUG) << "ServiceTracker::getServiceReference[cached]:" << d->filter; return reference; } US_DEBUG(d->DEBUG) << "ServiceTracker::getServiceReference:" << d->filter; std::list references; GetServiceReferences(references); - int length = references.size(); + std::size_t length = references.size(); if (length == 0) { /* if no service is being tracked */ throw ServiceException("No service is being tracked"); } std::list::const_iterator selectedRef; if (length > 1) { /* if more than one service, select highest ranking */ std::vector rankings(length); int count = 0; int maxRanking = std::numeric_limits::min(); std::list::const_iterator refIter = references.begin(); for (int i = 0; i < length; i++) { Any rankingAny = refIter->GetProperty(ServiceConstants::SERVICE_RANKING()); int ranking = 0; if (rankingAny.Type() == typeid(int)) { ranking = any_cast(rankingAny); } rankings[i] = ranking; if (ranking > maxRanking) { selectedRef = refIter; maxRanking = ranking; count = 1; } else { if (ranking == maxRanking) { count++; } } ++refIter; } if (count > 1) { /* if still more than one service, select lowest id */ long int minId = std::numeric_limits::max(); refIter = references.begin(); for (int i = 0; i < length; i++) { if (rankings[i] == maxRanking) { Any idAny = refIter->GetProperty(ServiceConstants::SERVICE_ID()); long int id = 0; if (idAny.Type() == typeid(long int)) { id = any_cast(idAny); } if (id < minId) { selectedRef = refIter; minId = id; } } ++refIter; } } } { typename _ServiceTrackerPrivate::Lock l(d); d->cachedReference = *selectedRef; return d->cachedReference; } } template T ServiceTracker::GetService(const ServiceReference& reference) const { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return 0; } { typename _TrackedService::Lock l(t); return t->GetCustomizedObject(reference); } } template void ServiceTracker::GetServices(std::list& services) const { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return; } { typename _TrackedService::Lock l(t); std::list references; d->GetServiceReferences_unlocked(references, t); for(std::list::const_iterator ref = references.begin(); ref != references.end(); ++ref) { services.push_back(t->GetCustomizedObject(*ref)); } } } template T ServiceTracker::GetService() const { T service = d->cachedService; if (service != 0) { US_DEBUG(d->DEBUG) << "ServiceTracker::getService[cached]:" << d->filter; return service; } US_DEBUG(d->DEBUG) << "ServiceTracker::getService:" << d->filter; try { ServiceReference reference = GetServiceReference(); if (reference.GetModule() == 0) { return 0; } return d->cachedService = GetService(reference); } catch (const ServiceException&) { return 0; } } template void ServiceTracker::Remove(const ServiceReference& reference) { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return; } t->Untrack(reference, ServiceEvent()); } template int ServiceTracker::Size() const { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return 0; } { typename _TrackedService::Lock l(t); - return t->Size(); + return static_cast(t->Size()); } } template int ServiceTracker::GetTrackingCount() const { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return -1; } { typename _TrackedService::Lock l(t); return t->GetTrackingCount(); } } template void ServiceTracker::GetTracked(TrackingMap& map) const { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return; } { typename _TrackedService::Lock l(t); t->CopyEntries(map); } } template bool ServiceTracker::IsEmpty() const { _TrackedService* t = d->Tracked(); if (t == 0) { /* if ServiceTracker is not open */ return true; } { typename _TrackedService::Lock l(t); return t->IsEmpty(); } } template T ServiceTracker::AddingService(const ServiceReference& reference) { return dynamic_cast(d->context->GetService(reference)); } template void ServiceTracker::ModifiedService(const ServiceReference& /*reference*/, T /*service*/) { /* do nothing */ } template void ServiceTracker::RemovedService(const ServiceReference& reference, T /*service*/) { d->context->UngetService(reference); } US_END_NAMESPACE diff --git a/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp b/Core/Code/CppMicroServices/src/util/stdint_p.h similarity index 66% copy from Core/Code/CppMicroServices/src/module/usModuleInfo.cpp copy to Core/Code/CppMicroServices/src/util/stdint_p.h index 810b2cc98f..242332bac2 100644 --- a/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp +++ b/Core/Code/CppMicroServices/src/util/stdint_p.h @@ -1,35 +1,33 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ - -#include "usModuleInfo.h" - -US_BEGIN_NAMESPACE - -ModuleInfo::ModuleInfo(const std::string& name, const std::string& libName, - const std::string& autoLoadDir, const std::string& moduleDeps, - const std::string& version) - : name(name), libName(libName), moduleDeps(moduleDeps), - version(version), autoLoadDir(autoLoadDir), id(0), - activatorHook(0) -{} - -US_END_NAMESPACE +#ifndef USSTDINT_H +#define USSTDINT_H + +#ifdef HAVE_STDINT +#include +#elif defined(_MSC_VER) +#include "stdint_vc_p.h" +#else +#error The stdint.h header is not available +#endif + +#endif // USSTDINT_H diff --git a/Core/Code/CppMicroServices/src/util/stdint_vc_p.h b/Core/Code/CppMicroServices/src/util/stdint_vc_p.h new file mode 100644 index 0000000000..c660849c42 --- /dev/null +++ b/Core/Code/CppMicroServices/src/util/stdint_vc_p.h @@ -0,0 +1,235 @@ +/* ISO C9x 7.18 Integer types + * Based on ISO/IEC SC22/WG14 9899 Committee draft (SC22 N2794) + * + * THIS SOFTWARE IS NOT COPYRIGHTED + * + * Contributor: Danny Smith + * + * This source code is offered for use in the public domain. You may + * use, modify or distribute it freely. + * + * This code is distributed in the hope that it will be useful but + * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY + * DISCLAIMED. This includes but is not limited to warranties of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + * + * Date: 2000-12-02 + * + * mwb: This was modified in the following ways: + * + * - make it compatible with Visual C++ 6 (which uses + * non-standard keywords and suffixes for 64-bit types) + * - some environments need stddef.h included (for wchar stuff?) + * - handle the fact that Microsoft's limits.h header defines + * SIZE_MAX + * - make corrections for SIZE_MAX, INTPTR_MIN, INTPTR_MAX, UINTPTR_MAX, + * PTRDIFF_MIN, PTRDIFF_MAX, SIG_ATOMIC_MIN, and SIG_ATOMIC_MAX + * to be 64-bit aware. + */ + + +#ifndef _STDINT_H +#define _STDINT_H +#define __need_wint_t +#define __need_wchar_t +#include +#include + +#if _MSC_VER && (_MSC_VER < 1300) +/* using MSVC 6 or earlier - no "long long" type, but might have _int64 type */ +#define __STDINT_LONGLONG __int64 +#define __STDINT_LONGLONG_SUFFIX i64 +#else +#define __STDINT_LONGLONG long long +#define __STDINT_LONGLONG_SUFFIX LL +#endif + +#if !defined( PASTE) +#define PASTE2( x, y) x##y +#define PASTE( x, y) PASTE2( x, y) +#endif /* PASTE */ + + +/* 7.18.1.1 Exact-width integer types */ +typedef signed char int8_t; +typedef unsigned char uint8_t; +typedef short int16_t; +typedef unsigned short uint16_t; +typedef int int32_t; +typedef unsigned uint32_t; +typedef __STDINT_LONGLONG int64_t; +typedef unsigned __STDINT_LONGLONG uint64_t; + +/* 7.18.1.2 Minimum-width integer types */ +typedef signed char int_least8_t; +typedef unsigned char uint_least8_t; +typedef short int_least16_t; +typedef unsigned short uint_least16_t; +typedef int int_least32_t; +typedef unsigned uint_least32_t; +typedef __STDINT_LONGLONG int_least64_t; +typedef unsigned __STDINT_LONGLONG uint_least64_t; + +/* 7.18.1.3 Fastest minimum-width integer types + * Not actually guaranteed to be fastest for all purposes + * Here we use the exact-width types for 8 and 16-bit ints. + */ +typedef char int_fast8_t; +typedef unsigned char uint_fast8_t; +typedef short int_fast16_t; +typedef unsigned short uint_fast16_t; +typedef int int_fast32_t; +typedef unsigned int uint_fast32_t; +typedef __STDINT_LONGLONG int_fast64_t; +typedef unsigned __STDINT_LONGLONG uint_fast64_t; + +/* 7.18.1.4 Integer types capable of holding object pointers */ +#ifndef _INTPTR_T_DEFINED +#define _INTPTR_T_DEFINED +#ifdef _WIN64 +typedef __STDINT_LONGLONG intptr_t +#else +typedef int intptr_t; +#endif /* _WIN64 */ +#endif /* _INTPTR_T_DEFINED */ + +#ifndef _UINTPTR_T_DEFINED +#define _UINTPTR_T_DEFINED +#ifdef _WIN64 +typedef unsigned __STDINT_LONGLONG uintptr_t +#else +typedef unsigned int uintptr_t; +#endif /* _WIN64 */ +#endif /* _UINTPTR_T_DEFINED */ + +/* 7.18.1.5 Greatest-width integer types */ +typedef __STDINT_LONGLONG intmax_t; +typedef unsigned __STDINT_LONGLONG uintmax_t; + +/* 7.18.2 Limits of specified-width integer types */ +#if !defined ( __cplusplus) || defined (__STDC_LIMIT_MACROS) + +/* 7.18.2.1 Limits of exact-width integer types */ +#define INT8_MIN (-128) +#define INT16_MIN (-32768) +#define INT32_MIN (-2147483647 - 1) +#define INT64_MIN (PASTE( -9223372036854775807, __STDINT_LONGLONG_SUFFIX) - 1) + +#define INT8_MAX 127 +#define INT16_MAX 32767 +#define INT32_MAX 2147483647 +#define INT64_MAX (PASTE( 9223372036854775807, __STDINT_LONGLONG_SUFFIX)) + +#define UINT8_MAX 0xff /* 255U */ +#define UINT16_MAX 0xffff /* 65535U */ +#define UINT32_MAX 0xffffffff /* 4294967295U */ +#define UINT64_MAX (PASTE( 0xffffffffffffffffU, __STDINT_LONGLONG_SUFFIX)) /* 18446744073709551615ULL */ + +/* 7.18.2.2 Limits of minimum-width integer types */ +#define INT_LEAST8_MIN INT8_MIN +#define INT_LEAST16_MIN INT16_MIN +#define INT_LEAST32_MIN INT32_MIN +#define INT_LEAST64_MIN INT64_MIN + +#define INT_LEAST8_MAX INT8_MAX +#define INT_LEAST16_MAX INT16_MAX +#define INT_LEAST32_MAX INT32_MAX +#define INT_LEAST64_MAX INT64_MAX + +#define UINT_LEAST8_MAX UINT8_MAX +#define UINT_LEAST16_MAX UINT16_MAX +#define UINT_LEAST32_MAX UINT32_MAX +#define UINT_LEAST64_MAX UINT64_MAX + +/* 7.18.2.3 Limits of fastest minimum-width integer types */ +#define INT_FAST8_MIN INT8_MIN +#define INT_FAST16_MIN INT16_MIN +#define INT_FAST32_MIN INT32_MIN +#define INT_FAST64_MIN INT64_MIN + +#define INT_FAST8_MAX INT8_MAX +#define INT_FAST16_MAX INT16_MAX +#define INT_FAST32_MAX INT32_MAX +#define INT_FAST64_MAX INT64_MAX + +#define UINT_FAST8_MAX UINT8_MAX +#define UINT_FAST16_MAX UINT16_MAX +#define UINT_FAST32_MAX UINT32_MAX +#define UINT_FAST64_MAX UINT64_MAX + +/* 7.18.2.4 Limits of integer types capable of holding + object pointers */ +#ifdef _WIN64 +#define INTPTR_MIN INT64_MIN +#define INTPTR_MAX INT64_MAX +#define UINTPTR_MAX UINT64_MAX +#else +#define INTPTR_MIN INT32_MIN +#define INTPTR_MAX INT32_MAX +#define UINTPTR_MAX UINT32_MAX +#endif /* _WIN64 */ + +/* 7.18.2.5 Limits of greatest-width integer types */ +#define INTMAX_MIN INT64_MIN +#define INTMAX_MAX INT64_MAX +#define UINTMAX_MAX UINT64_MAX + +/* 7.18.3 Limits of other integer types */ +#define PTRDIFF_MIN INTPTR_MIN +#define PTRDIFF_MAX INTPTR_MAX + +#define SIG_ATOMIC_MIN INTPTR_MIN +#define SIG_ATOMIC_MAX INTPTR_MAX + +/* we need to check for SIZE_MAX already defined because MS defines it in limits.h */ +#ifndef SIZE_MAX +#define SIZE_MAX UINTPTR_MAX +#endif + +#ifndef WCHAR_MIN /* also in wchar.h */ +#define WCHAR_MIN 0 +#define WCHAR_MAX ((wchar_t)-1) /* UINT16_MAX */ +#endif + +/* + * wint_t is unsigned short for compatibility with MS runtime + */ +#define WINT_MIN 0 +#define WINT_MAX ((wint_t)-1) /* UINT16_MAX */ + +#endif /* !defined ( __cplusplus) || defined __STDC_LIMIT_MACROS */ + + +/* 7.18.4 Macros for integer constants */ +#if !defined ( __cplusplus) || defined (__STDC_CONSTANT_MACROS) + +/* 7.18.4.1 Macros for minimum-width integer constants + + Accoding to Douglas Gwyn : +"This spec was changed in ISO/IEC 9899:1999 TC1; in ISO/IEC +9899:1999 as initially published, the expansion was required +to be an integer constant of precisely matching type, which +is impossible to accomplish for the shorter types on most +platforms, because C99 provides no standard way to designate +an integer constant with width less than that of type int. +TC1 changed this to require just an integer constant +*expression* with *promoted* type." +*/ + +#define INT8_C(val) ((int8_t) + (val)) +#define UINT8_C(val) ((uint8_t) + (val##U)) +#define INT16_C(val) ((int16_t) + (val)) +#define UINT16_C(val) ((uint16_t) + (val##U)) + +#define INT32_C(val) val##L +#define UINT32_C(val) val##UL +#define INT64_C(val) (PASTE( val, __STDINT_LONGLONG_SUFFIX)) +#define UINT64_C(val)(PASTE( PASTE( val, U), __STDINT_LONGLONG_SUFFIX)) + +/* 7.18.4.2 Macros for greatest-width integer constants */ +#define INTMAX_C(val) INT64_C(val) +#define UINTMAX_C(val) UINT64_C(val) + +#endif /* !defined ( __cplusplus) || defined __STDC_CONSTANT_MACROS */ + +#endif diff --git a/Core/Code/CppMicroServices/test/CMakeLists.txt b/Core/Code/CppMicroServices/test/CMakeLists.txt index cd8bc207e6..c762ed9048 100644 --- a/Core/Code/CppMicroServices/test/CMakeLists.txt +++ b/Core/Code/CppMicroServices/test/CMakeLists.txt @@ -1,98 +1,102 @@ #----------------------------------------------------------------------------- # Configure files, include dirs, etc. #----------------------------------------------------------------------------- configure_file("${CMAKE_CURRENT_SOURCE_DIR}/usTestingConfig.h.in" "${PROJECT_BINARY_DIR}/include/usTestingConfig.h") include_directories(${US_INCLUDE_DIRS} ${CMAKE_CURRENT_SOURCE_DIR}) if(NOT US_ENABLE_SERVICE_FACTORY_SUPPORT) include_directories(${US_BASECLASS_INCLUDE_DIRS}) endif() link_directories(${US_LINK_DIRS}) if(NOT US_ENABLE_SERVICE_FACTORY_SUPPORT) link_directories(${US_BASECLASS_LIBRARY_DIRS}) endif() #----------------------------------------------------------------------------- # Create test modules #----------------------------------------------------------------------------- include(usFunctionCreateTestModule) set(_us_test_module_libs "" CACHE INTERNAL "" FORCE) add_subdirectory(modules) #----------------------------------------------------------------------------- # Add unit tests #----------------------------------------------------------------------------- set(_tests usDebugOutputTest usLDAPFilterTest usModuleTest + usModuleResourceTest usServiceRegistryTest usServiceTrackerTest + usStaticModuleResourceTest usStaticModuleTest ) if(US_BUILD_SHARED_LIBS) list(APPEND _tests usServiceListenerTest) if(US_ENABLE_AUTOLOADING_SUPPORT) list(APPEND _tests usModuleAutoLoadTest) endif() endif() set(_additional_srcs usTestManager.cpp usTestUtilModuleListener.cpp usTestUtilSharedLibrary.cpp ) set(_test_driver ${PROJECT_NAME}TestDriver) set(_test_sourcelist_extra_args ) create_test_sourcelist(_srcs ${_test_driver}.cpp ${_tests} ${_test_sourcelist_extra_args}) +usFunctionEmbedResources(_srcs EXECUTABLE_NAME ${_test_driver} FILES usTestResource.txt) + # Generate a custom "module init" file for the test driver executable set(MODULE_DEPENDS_STR ) foreach(_dep ${US_LINK_LIBRARIES}) set(MODULE_DEPENDS_STR "${MODULE_DEPENDS_STR} ${_dep}") endforeach() if(US_BUILD_SHARED_LIBS) usFunctionGenerateModuleInit(_srcs NAME ${_test_driver} DEPENDS "${MODULE_DEPENDS_STR}" VERSION "0.1.0" EXECUTABLE ) endif() add_executable(${_test_driver} ${_srcs} ${_additional_srcs}) if(NOT US_BUILD_SHARED_LIBS) target_link_libraries(${_test_driver} ${_us_test_module_libs}) endif() target_link_libraries(${_test_driver} ${US_LINK_LIBRARIES}) if(NOT US_ENABLE_SERVICE_FACTORY_SUPPORT) target_link_libraries(${_test_driver} ${US_BASECLASS_LIBRARIES}) endif() # Register tests foreach(_test ${_tests}) add_test(NAME ${_test} COMMAND ${_test_driver} ${_test}) endforeach() if(US_TEST_LABELS) set_tests_properties(${_tests} PROPERTIES LABELS "${US_TEST_LABELS}") endif() #----------------------------------------------------------------------------- # Add dependencies for shared libraries #----------------------------------------------------------------------------- if(US_BUILD_SHARED_LIBS) foreach(_test_module ${_us_test_module_libs}) add_dependencies(${_test_driver} ${_test_module}) endforeach() endif() diff --git a/Core/Code/CppMicroServices/test/modules/CMakeLists.txt b/Core/Code/CppMicroServices/test/modules/CMakeLists.txt index 5ebdf2f5cd..6d02314c68 100644 --- a/Core/Code/CppMicroServices/test/modules/CMakeLists.txt +++ b/Core/Code/CppMicroServices/test/modules/CMakeLists.txt @@ -1,9 +1,11 @@ add_subdirectory(libA) add_subdirectory(libA2) add_subdirectory(libAL) add_subdirectory(libAL2) add_subdirectory(libBWithStatic) add_subdirectory(libS) add_subdirectory(libSL1) add_subdirectory(libSL3) add_subdirectory(libSL4) + +add_subdirectory(libRWithResources) diff --git a/Core/Code/CppMicroServices/test/modules/libBWithStatic/CMakeLists.txt b/Core/Code/CppMicroServices/test/modules/libBWithStatic/CMakeLists.txt index 06ba122530..30b9cf7be6 100644 --- a/Core/Code/CppMicroServices/test/modules/libBWithStatic/CMakeLists.txt +++ b/Core/Code/CppMicroServices/test/modules/libBWithStatic/CMakeLists.txt @@ -1,7 +1,12 @@ -usFunctionCreateTestModule(TestModuleB usTestModuleB.cpp) +usFunctionCreateTestModuleWithResources(TestModuleB + SOURCES usTestModuleB.cpp + RESOURCES dynamic.txt res.txt) set(BUILD_SHARED_LIBS 0) -usFunctionCreateTestModule(TestModuleImportedByB usTestModuleImportedByB.cpp) +usFunctionCreateTestModuleWithResources(TestModuleImportedByB + SOURCES usTestModuleImportedByB.cpp + RESOURCES static.txt res.txt + RESOURCES_ROOT resources_static) target_link_libraries(TestModuleB TestModuleImportedByB) diff --git a/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources/dynamic.txt b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources/dynamic.txt new file mode 100644 index 0000000000..380a834a99 --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources/dynamic.txt @@ -0,0 +1 @@ +dynamic diff --git a/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources/res.txt b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources/res.txt new file mode 100644 index 0000000000..21f035c230 --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources/res.txt @@ -0,0 +1 @@ +dynamic resource diff --git a/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources_static/res.txt b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources_static/res.txt new file mode 100644 index 0000000000..68f9caa9f2 --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources_static/res.txt @@ -0,0 +1 @@ +static resource diff --git a/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources_static/static.txt b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources_static/static.txt new file mode 100644 index 0000000000..7b4d4ba2e6 --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libBWithStatic/resources_static/static.txt @@ -0,0 +1 @@ +static diff --git a/Core/Code/CppMicroServices/test/modules/libBWithStatic/usTestModuleB.cpp b/Core/Code/CppMicroServices/test/modules/libBWithStatic/usTestModuleB.cpp index e08ce94e1c..1b18b2a4c8 100644 --- a/Core/Code/CppMicroServices/test/modules/libBWithStatic/usTestModuleB.cpp +++ b/Core/Code/CppMicroServices/test/modules/libBWithStatic/usTestModuleB.cpp @@ -1,72 +1,73 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include "usTestModuleBService.h" #include #include #include #include #include US_BASECLASS_HEADER US_BEGIN_NAMESPACE struct TestModuleB : public US_BASECLASS_NAME, public TestModuleBService { TestModuleB(ModuleContext* mc) { US_INFO << "Registering TestModuleBService"; mc->RegisterService(this); } }; class TestModuleBActivator : public ModuleActivator { public: TestModuleBActivator() : s(0) {} ~TestModuleBActivator() { delete s; } void Load(ModuleContext* context) { s = new TestModuleB(context); } void Unload(ModuleContext*) { } private: TestModuleB* s; }; US_END_NAMESPACE US_EXPORT_MODULE_ACTIVATOR(TestModuleB, US_PREPEND_NAMESPACE(TestModuleBActivator)) US_IMPORT_MODULE(TestModuleImportedByB) +US_IMPORT_MODULE_RESOURCES(TestModuleImportedByB) US_LOAD_IMPORTED_MODULES(TestModuleB, TestModuleImportedByB) diff --git a/Core/Code/CppMicroServices/test/modules/libRWithResources/CMakeLists.txt b/Core/Code/CppMicroServices/test/modules/libRWithResources/CMakeLists.txt new file mode 100644 index 0000000000..2b4880e3ca --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libRWithResources/CMakeLists.txt @@ -0,0 +1,13 @@ + +set(resource_files + icons/cppmicroservices.png + icons/readme.txt + foo.txt + special_chars.dummy.txt + test.xml +) + +usFunctionCreateTestModuleWithResources(TestModuleR + SOURCES usTestModuleR.cpp + RESOURCES ${resource_files}) + diff --git a/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/foo.txt b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/foo.txt new file mode 100644 index 0000000000..f004091c6b --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/foo.txt @@ -0,0 +1,3 @@ +foo and +bar + diff --git a/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/icons/cppmicroservices.png b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/icons/cppmicroservices.png new file mode 100644 index 0000000000..e115492256 Binary files /dev/null and b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/icons/cppmicroservices.png differ diff --git a/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/icons/readme.txt b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/icons/readme.txt new file mode 100644 index 0000000000..30af5fe09c --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/icons/readme.txt @@ -0,0 +1 @@ +icons diff --git a/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/special_chars.dummy.txt b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/special_chars.dummy.txt new file mode 100644 index 0000000000..47bfa90dd0 --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/special_chars.dummy.txt @@ -0,0 +1,2 @@ +German Füße (feet) +French garçon de café (waiter) diff --git a/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/test.xml b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/test.xml new file mode 100644 index 0000000000..23208713be --- /dev/null +++ b/Core/Code/CppMicroServices/test/modules/libRWithResources/resources/test.xml @@ -0,0 +1,4 @@ + + +hi + diff --git a/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp b/Core/Code/CppMicroServices/test/modules/libRWithResources/usTestModuleR.cpp similarity index 69% copy from Core/Code/CppMicroServices/src/module/usModuleInfo.cpp copy to Core/Code/CppMicroServices/test/modules/libRWithResources/usTestModuleR.cpp index 810b2cc98f..602caaf82f 100644 --- a/Core/Code/CppMicroServices/src/module/usModuleInfo.cpp +++ b/Core/Code/CppMicroServices/test/modules/libRWithResources/usTestModuleR.cpp @@ -1,35 +1,44 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ -#include "usModuleInfo.h" +#include US_BEGIN_NAMESPACE -ModuleInfo::ModuleInfo(const std::string& name, const std::string& libName, - const std::string& autoLoadDir, const std::string& moduleDeps, - const std::string& version) - : name(name), libName(libName), moduleDeps(moduleDeps), - version(version), autoLoadDir(autoLoadDir), id(0), - activatorHook(0) -{} +class TestModuleRActivator : public ModuleActivator +{ +public: + + void Load(ModuleContext*) + { + } + + void Unload(ModuleContext*) + { + } + +}; US_END_NAMESPACE + +US_EXPORT_MODULE_ACTIVATOR(TestModuleR, US_PREPEND_NAMESPACE(TestModuleRActivator)) + diff --git a/Core/Code/CppMicroServices/test/usModuleResourceTest.cpp b/Core/Code/CppMicroServices/test/usModuleResourceTest.cpp new file mode 100644 index 0000000000..b37ccd8dc2 --- /dev/null +++ b/Core/Code/CppMicroServices/test/usModuleResourceTest.cpp @@ -0,0 +1,477 @@ +/*============================================================================= + + Library: CppMicroServices + + Copyright (c) German Cancer Research Center, + Division of Medical and Biological Informatics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================*/ + +#include +#include +#include +#include +#include +#include + +#include + +#include "usTestUtilSharedLibrary.h" +#include "usTestingMacros.h" + +#include + +#include + +US_USE_NAMESPACE + +namespace { + +void checkResourceInfo(const ModuleResource& res, const std::string& path, + const std::string& baseName, + const std::string& completeBaseName, const std::string& suffix, + const std::string& completeSuffix, + int size, bool children = false) +{ + US_TEST_CONDITION_REQUIRED(res.IsValid(), "Valid resource") + US_TEST_CONDITION(res.GetBaseName() == baseName, "GetBaseName()") + US_TEST_CONDITION(res.GetChildren().empty() == !children, "No children") + US_TEST_CONDITION(res.GetCompleteBaseName() == completeBaseName, "GetCompleteBaseName()") + US_TEST_CONDITION(res.GetName() == completeBaseName + "." + suffix, "GetName()") + US_TEST_CONDITION(res.GetResourcePath() == path + completeBaseName + "." + suffix, "GetResourcePath()") + US_TEST_CONDITION(res.GetPath() == path, "GetPath()") + US_TEST_CONDITION(res.GetSize() == size, "Data size") + US_TEST_CONDITION(res.GetSuffix() == suffix, "Suffix") + US_TEST_CONDITION(res.GetCompleteSuffix() == completeSuffix, "Complete suffix") +} + +void testTextResource(Module* module) +{ + ModuleResource res = module->GetResource("foo.txt"); +#ifdef US_PLATFORM_WINDOWS + checkResourceInfo(res, "/", "foo", "foo", "txt", "txt", 16, false); + const std::streampos ssize(13); + const std::string fileData = "foo and\nbar\n\n"; +#else + checkResourceInfo(res, "/", "foo", "foo", "txt", "txt", 13, false); + const std::streampos ssize(12); + const std::string fileData = "foo and\nbar\n"; +#endif + + ModuleResourceStream rs(res); + + rs.seekg(0, std::ios::end); + US_TEST_CONDITION(rs.tellg() == ssize, "Stream content length"); + rs.seekg(0, std::ios::beg); + + std::string content; + content.reserve(res.GetSize()); + char buffer[1024]; + while (rs.read(buffer, sizeof(buffer))) + { + content.append(buffer, sizeof(buffer)); + } + content.append(buffer, static_cast(rs.gcount())); + + US_TEST_CONDITION(rs.eof(), "EOF check"); + US_TEST_CONDITION(content == fileData, "Resource content"); + + rs.clear(); + rs.seekg(0); + + US_TEST_CONDITION_REQUIRED(rs.tellg() == std::streampos(0), "Move to start") + US_TEST_CONDITION_REQUIRED(rs.good(), "Start re-reading"); + + std::vector lines; + std::string line; + while (std::getline(rs, line)) + { + lines.push_back(line); + } + US_TEST_CONDITION_REQUIRED(lines.size() > 1, "Number of lines") + US_TEST_CONDITION(lines[0] == "foo and", "Check first line") + US_TEST_CONDITION(lines[1] == "bar", "Check second line") +} + +void testTextResourceAsBinary(Module* module) +{ + ModuleResource res = module->GetResource("foo.txt"); + +#ifdef US_PLATFORM_WINDOWS + checkResourceInfo(res, "/", "foo", "foo", "txt", "txt", 16, false); + const std::streampos ssize(16); + const std::string fileData = "foo and\r\nbar\r\n\r\n"; +#else + checkResourceInfo(res, "/", "foo", "foo", "txt", "txt", 13, false); + const std::streampos ssize(13); + const std::string fileData = "foo and\nbar\n\n"; +#endif + + + ModuleResourceStream rs(res, std::ios_base::binary); + + rs.seekg(0, std::ios::end); + US_TEST_CONDITION(rs.tellg() == ssize, "Stream content length"); + rs.seekg(0, std::ios::beg); + + std::string content; + content.reserve(res.GetSize()); + char buffer[1024]; + while (rs.read(buffer, sizeof(buffer))) + { + content.append(buffer, sizeof(buffer)); + } + content.append(buffer, static_cast(rs.gcount())); + + US_TEST_CONDITION(rs.eof(), "EOF check"); + US_TEST_CONDITION(content == fileData, "Resource content"); +} + +void testInvalidResource(Module* module) +{ + ModuleResource res = module->GetResource("invalid"); + US_TEST_CONDITION_REQUIRED(res.IsValid() == false, "Check invalid resource") + US_TEST_CONDITION(res.GetName().empty(), "Check empty name") + US_TEST_CONDITION(res.GetPath().empty(), "Check empty path") + US_TEST_CONDITION(res.GetResourcePath().empty(), "Check empty resource path") + US_TEST_CONDITION(res.GetBaseName().empty(), "Check empty base name") + US_TEST_CONDITION(res.GetCompleteBaseName().empty(), "Check empty complete base name") + US_TEST_CONDITION(res.GetSuffix().empty(), "Check empty suffix") + + US_TEST_CONDITION(res.GetChildren().empty(), "Check empty children") + US_TEST_CONDITION(res.GetSize() == 0, "Check zero size") + US_TEST_CONDITION(res.GetData() == NULL, "Check NULL data") + + ModuleResourceStream rs(res); + US_TEST_CONDITION(rs.good() == true, "Check invalid resource stream") + rs.ignore(); + US_TEST_CONDITION(rs.good() == false, "Check invalid resource stream") + US_TEST_CONDITION(rs.eof() == true, "Check invalid resource stream") +} + +void testSpecialCharacters(Module* module) +{ + ModuleResource res = module->GetResource("special_chars.dummy.txt"); +#ifdef US_PLATFORM_WINDOWS + checkResourceInfo(res, "/", "special_chars", "special_chars.dummy", "txt", "dummy.txt", 56, false); + const std::streampos ssize(54); + const std::string fileData = "German Füße (feet)\nFrench garçon de café (waiter)\n"; +#else + checkResourceInfo(res, "/", "special_chars", "special_chars.dummy", "txt", "dummy.txt", 54, false); + const std::streampos ssize(53); + const std::string fileData = "German Füße (feet)\nFrench garçon de café (waiter)"; +#endif + + ModuleResourceStream rs(res); + + rs.seekg(0, std::ios_base::end); + US_TEST_CONDITION(rs.tellg() == ssize, "Stream content length"); + rs.seekg(0, std::ios_base::beg); + + std::string content; + content.reserve(res.GetSize()); + char buffer[1024]; + while (rs.read(buffer, sizeof(buffer))) + { + content.append(buffer, sizeof(buffer)); + } + content.append(buffer, static_cast(rs.gcount())); + + US_TEST_CONDITION(rs.eof(), "EOF check"); + US_TEST_CONDITION(content == fileData, "Resource content"); +} + +void testBinaryResource(Module* module) +{ + ModuleResource res = module->GetResource("/icons/cppmicroservices.png"); + checkResourceInfo(res, "/icons/", "cppmicroservices", "cppmicroservices", "png", "png", 2424, false); + + ModuleResourceStream rs(res, std::ios_base::binary); + rs.seekg(0, std::ios_base::end); + std::streampos resLength = rs.tellg(); + rs.seekg(0); + + std::ifstream png(CppMicroServices_SOURCE_DIR "/test/modules/libRWithResources/resources/icons/cppmicroservices.png", + std::ifstream::in | std::ifstream::binary); + + US_TEST_CONDITION_REQUIRED(png.is_open(), "Open reference file") + + png.seekg(0, std::ios_base::end); + std::streampos pngLength = png.tellg(); + png.seekg(0); + US_TEST_CONDITION(resLength = res.GetSize(), "Check resource size") + US_TEST_CONDITION_REQUIRED(resLength == pngLength, "Compare sizes") + + char c1 = 0; + char c2 = 0; + bool isEqual = true; + int count = 0; + while (png.get(c1) && rs.get(c2)) + { + ++count; + if (c1 != c2) + { + isEqual = false; + break; + } + } + + US_TEST_CONDITION_REQUIRED(count == pngLength, "Check if everything was read"); + US_TEST_CONDITION_REQUIRED(isEqual, "Equal binary contents"); + US_TEST_CONDITION(png.eof(), "EOF check"); +} + +struct ResourceComparator { + bool operator()(const ModuleResource& mr1, const ModuleResource& mr2) const + { + return mr1 < mr2; + } +}; + +void testResourceTree(Module* module) +{ + ModuleResource res = module->GetResource(""); + US_TEST_CONDITION(res.GetResourcePath() == "/", "Check root file path") + US_TEST_CONDITION(res.IsDir() == true, "Check type") + + std::vector children = res.GetChildren(); + std::sort(children.begin(), children.end()); + US_TEST_CONDITION_REQUIRED(children.size() == 4, "Check child count") + US_TEST_CONDITION(children[0] == "foo.txt", "Check child name") + US_TEST_CONDITION(children[1] == "icons", "Check child name") + US_TEST_CONDITION(children[2] == "special_chars.dummy.txt", "Check child name") + US_TEST_CONDITION(children[3] == "test.xml", "Check child name") + + + ModuleResource readme = module->GetResource("/icons/readme.txt"); + US_TEST_CONDITION(readme.IsFile() && readme.GetChildren().empty(), "Check file resource") + + ModuleResource icons = module->GetResource("icons"); + US_TEST_CONDITION(icons.IsDir() && !icons.IsFile() && !icons.GetChildren().empty(), "Check directory resource") + + children = icons.GetChildren(); + US_TEST_CONDITION_REQUIRED(children.size() == 2, "Check icons child count") + std::sort(children.begin(), children.end()); + US_TEST_CONDITION(children[0] == "cppmicroservices.png", "Check child name") + US_TEST_CONDITION(children[1] == "readme.txt", "Check child name") + + ResourceComparator resourceComparator; + + // find all .txt files + std::vector nodes = module->FindResources("", "*.txt", false); + std::sort(nodes.begin(), nodes.end(), resourceComparator); + US_TEST_CONDITION_REQUIRED(nodes.size() == 2, "Found child count") + US_TEST_CONDITION(nodes[0].GetResourcePath() == "/foo.txt", "Check child name") + US_TEST_CONDITION(nodes[1].GetResourcePath() == "/special_chars.dummy.txt", "Check child name") + + nodes = module->FindResources("", "*.txt", true); + std::sort(nodes.begin(), nodes.end(), resourceComparator); + US_TEST_CONDITION_REQUIRED(nodes.size() == 3, "Found child count") + US_TEST_CONDITION(nodes[0].GetResourcePath() == "/foo.txt", "Check child name") + US_TEST_CONDITION(nodes[1].GetResourcePath() == "/icons/readme.txt", "Check child name") + US_TEST_CONDITION(nodes[2].GetResourcePath() == "/special_chars.dummy.txt", "Check child name") + + // find all resources + nodes = module->FindResources("", "", true); + US_TEST_CONDITION(nodes.size() == 5, "Total resource number") + nodes = module->FindResources("", "**", true); + US_TEST_CONDITION(nodes.size() == 5, "Total resource number") + + + // test pattern matching + nodes.clear(); + nodes = module->FindResources("/icons", "*micro*.png", false); + US_TEST_CONDITION(nodes.size() == 1 && nodes[0].GetResourcePath() == "/icons/cppmicroservices.png", "Check file pattern matches") + + nodes.clear(); + nodes = module->FindResources("", "*.txt", true); + US_TEST_CONDITION(nodes.size() == 3, "Check recursive pattern matches") +} + +void testStaticResourceTree(Module* module) +{ + ModuleResource res = module->GetResource(""); + US_TEST_CONDITION(res.GetResourcePath() == "/", "Check root file path") + US_TEST_CONDITION(res.IsDir() == true, "Check type") + + std::vector children = res.GetChildren(); + std::sort(children.begin(), children.end()); + US_TEST_CONDITION_REQUIRED(children.size() == 8, "Check child count") + US_TEST_CONDITION(children[0] == "dynamic.txt", "Check dynamic.txt child name") + US_TEST_CONDITION(children[1] == "foo.txt", "Check foo.txt child name") + US_TEST_CONDITION(children[2] == "icons", "Check icons child name") + US_TEST_CONDITION(children[3] == "res.txt", "Check res.txt child name") + US_TEST_CONDITION(children[4] == "res.txt", "Check res.txt child name") + US_TEST_CONDITION(children[5] == "special_chars.dummy.txt", "Check special_chars.dummy.txt child name") + US_TEST_CONDITION(children[6] == "static.txt", "Check static.txt child name") + US_TEST_CONDITION(children[7] == "test.xml", "Check test.xml child name") + + + ModuleResource readme = module->GetResource("/icons/readme.txt"); + US_TEST_CONDITION(readme.IsFile() && readme.GetChildren().empty(), "Check file resource") + + ModuleResource icons = module->GetResource("icons"); + US_TEST_CONDITION(icons.IsDir() && !icons.IsFile() && !icons.GetChildren().empty(), "Check directory resource") + + children = icons.GetChildren(); + US_TEST_CONDITION_REQUIRED(children.size() == 2, "Check icons child count") + std::sort(children.begin(), children.end()); + US_TEST_CONDITION(children[0] == "cppmicroservices.png", "Check child name") + US_TEST_CONDITION(children[1] == "readme.txt", "Check child name") + + ResourceComparator resourceComparator; + + // find all .txt files + std::vector nodes = module->FindResources("", "*.txt", false); + std::sort(nodes.begin(), nodes.end(), resourceComparator); + US_TEST_CONDITION_REQUIRED(nodes.size() == 6, "Found child count") + US_TEST_CONDITION(nodes[0].GetResourcePath() == "/dynamic.txt", "Check dynamic.txt child name") + US_TEST_CONDITION(nodes[1].GetResourcePath() == "/foo.txt", "Check child name") + US_TEST_CONDITION(nodes[2].GetResourcePath() == "/res.txt", "Check res.txt child name") + US_TEST_CONDITION(nodes[3].GetResourcePath() == "/res.txt", "Check res.txt child name") + US_TEST_CONDITION(nodes[4].GetResourcePath() == "/special_chars.dummy.txt", "Check child name") + US_TEST_CONDITION(nodes[5].GetResourcePath() == "/static.txt", "Check static.txt child name") + + nodes = module->FindResources("", "*.txt", true); + std::sort(nodes.begin(), nodes.end(), resourceComparator); + US_TEST_CONDITION_REQUIRED(nodes.size() == 7, "Found child count") + US_TEST_CONDITION(nodes[0].GetResourcePath() == "/dynamic.txt", "Check dynamic.txt child name") + US_TEST_CONDITION(nodes[1].GetResourcePath() == "/foo.txt", "Check child name") + US_TEST_CONDITION(nodes[2].GetResourcePath() == "/icons/readme.txt", "Check child name") + US_TEST_CONDITION(nodes[3].GetResourcePath() == "/res.txt", "Check res.txt child name") + US_TEST_CONDITION(nodes[4].GetResourcePath() == "/res.txt", "Check res.txt child name") + US_TEST_CONDITION(nodes[5].GetResourcePath() == "/special_chars.dummy.txt", "Check child name") + US_TEST_CONDITION(nodes[6].GetResourcePath() == "/static.txt", "Check static.txt child name") + + // find all resources + nodes = module->FindResources("", "", true); + US_TEST_CONDITION(nodes.size() == 9, "Total resource number") + nodes = module->FindResources("", "**", true); + US_TEST_CONDITION(nodes.size() == 9, "Total resource number") + + + // test pattern matching + nodes.clear(); + nodes = module->FindResources("/icons", "*micro*.png", false); + US_TEST_CONDITION(nodes.size() == 1 && nodes[0].GetResourcePath() == "/icons/cppmicroservices.png", "Check file pattern matches") + + nodes.clear(); + nodes = module->FindResources("", "*.txt", true); + US_TEST_CONDITION(nodes.size() == 7, "Check recursive pattern matches") +} + +void testResourceOperators(Module* module) +{ + ModuleResource invalid = module->GetResource("invalid"); + ModuleResource foo = module->GetResource("foo.txt"); + US_TEST_CONDITION_REQUIRED(foo.IsValid() && foo, "Check valid resource") + ModuleResource foo2(foo); + US_TEST_CONDITION(foo == foo, "Check equality operator") + US_TEST_CONDITION(foo == foo2, "Check copy constructor and equality operator") + US_TEST_CONDITION(foo != invalid, "Check inequality with invalid resource") + + ModuleResource xml = module->GetResource("/test.xml"); + US_TEST_CONDITION_REQUIRED(xml.IsValid() && xml, "Check valid resource") + US_TEST_CONDITION(foo != xml, "Check inequality") + US_TEST_CONDITION(foo < xml, "Check operator<") + + // check operator< by using a set + std::set resources; + resources.insert(foo); + resources.insert(foo); + resources.insert(xml); + US_TEST_CONDITION(resources.size() == 2, "Check operator< with set") + + // check hash function specialization + US_UNORDERED_SET_TYPE resources2; + resources2.insert(foo); + resources2.insert(foo); + resources2.insert(xml); + US_TEST_CONDITION(resources2.size() == 2, "Check operator< with unordered set") + + // check operator<< + std::ostringstream oss; + oss << foo; + US_TEST_CONDITION(oss.str() == foo.GetResourcePath(), "Check operator<<") +} + +void testResourceFromExecutable(Module* module) +{ + ModuleResource resource = module->GetResource("usTestResource.txt"); + US_TEST_CONDITION_REQUIRED(resource.IsValid(), "Check valid executable resource") + + std::string line; + ModuleResourceStream rs(resource); + std::getline(rs, line); + US_TEST_CONDITION(line == "meant to be compiled into the test driver", "Check executable resource content") +} + +} // end unnamed namespace + + +int usModuleResourceTest(int /*argc*/, char* /*argv*/[]) +{ + US_TEST_BEGIN("ModuleResourceTest"); + + ModuleContext* mc = GetModuleContext(); + assert(mc); + +#ifdef US_BUILD_SHARED_LIBS + SharedLibraryHandle libR("TestModuleR"); + + try + { + libR.Load(); + } + catch (const std::exception& e) + { + US_TEST_FAILED_MSG(<< "Load module exception: " << e.what()) + } + + Module* moduleR = ModuleRegistry::GetModule("TestModuleR Module"); + US_TEST_CONDITION_REQUIRED(moduleR != NULL, "Test for existing module TestModuleR") + + US_TEST_CONDITION(moduleR->GetName() == "TestModuleR Module", "Test module name") + + testInvalidResource(moduleR); + testResourceTree(moduleR); + testResourceFromExecutable(mc->GetModule()); +#else + Module* moduleR = mc->GetModule(); + US_TEST_CONDITION_REQUIRED(moduleR != NULL, "Test for existing module 0") + + US_TEST_CONDITION(moduleR->GetName() == "CppMicroServices", "Test module name") + + testStaticResourceTree(moduleR); +#endif + + testResourceOperators(moduleR); + + testTextResource(moduleR); + testTextResourceAsBinary(moduleR); + testSpecialCharacters(moduleR); + + testBinaryResource(moduleR); + +#ifdef US_BUILD_SHARED_LIBS + ModuleResource foo = moduleR->GetResource("foo.txt"); + US_TEST_CONDITION(foo.IsValid() == true, "Valid resource") + libR.Unload(); + US_TEST_CONDITION(foo.IsValid() == false, "Invalidated resource") + US_TEST_CONDITION(foo.GetData() == NULL, "NULL data") +#endif + + US_TEST_END() +} diff --git a/Core/Code/CppMicroServices/test/usServiceListenerTest.cpp b/Core/Code/CppMicroServices/test/usServiceListenerTest.cpp index 103befce2e..c49d2ca0d9 100644 --- a/Core/Code/CppMicroServices/test/usServiceListenerTest.cpp +++ b/Core/Code/CppMicroServices/test/usServiceListenerTest.cpp @@ -1,561 +1,561 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include #include #include #include #include #include US_BASECLASS_HEADER #include #include "usTestUtilSharedLibrary.h" US_USE_NAMESPACE class TestServiceListener { private: friend bool runLoadUnloadTest(const std::string&, int cnt, SharedLibraryHandle&, const std::vector&); const bool checkUsingModules; std::vector events; bool teststatus; ModuleContext* mc; public: TestServiceListener(ModuleContext* mc, bool checkUsingModules = true) : checkUsingModules(checkUsingModules), events(), teststatus(true), mc(mc) {} bool getTestStatus() const { return teststatus; } void clearEvents() { events.clear(); } bool checkEvents(const std::vector& eventTypes) { if (events.size() != eventTypes.size()) { dumpEvents(eventTypes); return false; } for (std::size_t i=0; i < eventTypes.size(); ++i) { if (eventTypes[i] != events[i].GetType()) { dumpEvents(eventTypes); return false; } } return true; } void serviceChanged(const ServiceEvent evt) { events.push_back(evt); US_TEST_OUTPUT( << "ServiceEvent: " << evt ); if (ServiceEvent::UNREGISTERING == evt.GetType()) { ServiceReference sr = evt.GetServiceReference(); // Validate that no module is marked as using the service std::vector usingModules; sr.GetUsingModules(usingModules); if (checkUsingModules && !usingModules.empty()) { teststatus = false; printUsingModules(sr, "*** Using modules (unreg) should be empty but is: "); } // Check if the service can be fetched US_BASECLASS_NAME* service = mc->GetService(sr); sr.GetUsingModules(usingModules); // if (UNREGISTERSERVICE_VALID_DURING_UNREGISTERING) { // In this mode the service shall be obtainable during // unregistration. if (service == 0) { teststatus = false; US_TEST_OUTPUT( << "*** Service should be available to ServiceListener " << "while handling unregistering event." ); } US_TEST_OUTPUT( << "Service (unreg): " << us_service_impl_name(service) ); if (checkUsingModules && usingModules.size() != 1) { teststatus = false; printUsingModules(sr, "*** One using module expected " "(unreg, after getService), found: "); } else { printUsingModules(sr, "Using modules (unreg, after getService): "); } // } else { // // In this mode the service shall NOT be obtainable during // // unregistration. // if (null!=service) { // teststatus = false; // out.print("*** Service should not be available to ServiceListener " // +"while handling unregistering event."); // } // if (checkUsingBundles && null!=usingBundles) { // teststatus = false; // printUsingBundles(sr, // "*** Using bundles (unreg, after getService), " // +"should be null but is: "); // } else { // printUsingBundles(sr, // "Using bundles (unreg, after getService): null"); // } // } mc->UngetService(sr); // Check that the UNREGISTERING service can not be looked up // using the service registry. try { long sid = any_cast(sr.GetProperty(ServiceConstants::SERVICE_ID())); std::stringstream ss; ss << "(" << ServiceConstants::SERVICE_ID() << "=" << sid << ")"; std::list srs = mc->GetServiceReferences("", ss.str()); if (srs.empty()) { US_TEST_OUTPUT( << "ServiceReference for UNREGISTERING service is not" " found in the service registry; ok." ); } else { teststatus = false; US_TEST_OUTPUT( << "*** ServiceReference for UNREGISTERING service," << sr << ", not found in the service registry; fail." ); US_TEST_OUTPUT( << "Found the following Service references:") ; for(std::list::const_iterator sr = srs.begin(); sr != srs.end(); ++sr) { US_TEST_OUTPUT( << (*sr) ); } } } catch (const std::exception& e) { teststatus = false; US_TEST_OUTPUT( << "*** Unexpected excpetion when trying to lookup a" " service while it is in state UNREGISTERING: " << e.what() ); } } } void printUsingModules(const ServiceReference& sr, const std::string& caption) { std::vector usingModules; sr.GetUsingModules(usingModules); US_TEST_OUTPUT( << (caption.empty() ? "Using modules: " : caption) ); for(std::vector::const_iterator module = usingModules.begin(); module != usingModules.end(); ++module) { US_TEST_OUTPUT( << " -" << (*module) ); } } // Print expected and actual service events. void dumpEvents(const std::vector& eventTypes) { std::size_t max = events.size() > eventTypes.size() ? events.size() : eventTypes.size(); US_TEST_OUTPUT( << "Expected event type -- Actual event" ); for (std::size_t i=0; i < max; ++i) { ServiceEvent evt = i < events.size() ? events[i] : ServiceEvent(); if (i < eventTypes.size()) { US_TEST_OUTPUT( << " " << eventTypes[i] << "--" << evt ); } else { US_TEST_OUTPUT( << " " << "- NONE - " << "--" << evt ); } } } }; // end of class ServiceListener bool runLoadUnloadTest(const std::string& name, int cnt, SharedLibraryHandle& target, const std::vector& events) { bool teststatus = true; ModuleContext* mc = GetModuleContext(); for (int i = 0; i < cnt && teststatus; ++i) { TestServiceListener sListen(mc); try { mc->AddServiceListener(&sListen, &TestServiceListener::serviceChanged); //mc->AddServiceListener(MessageDelegate1(&sListen, &ServiceListener::serviceChanged)); } catch (const std::logic_error& ise) { teststatus = false; US_TEST_FAILED_MSG( << "service listener registration failed " << ise.what() << " :" << name << ":FAIL" ); } // Start the test target to get a service published. try { target.Load(); } catch (const std::exception& e) { teststatus = false; US_TEST_FAILED_MSG( << "Failed to load module, got exception: " << e.what() << " + in " << name << ":FAIL" ); } // Stop the test target to get a service unpublished. try { target.Unload(); } catch (const std::exception& e) { teststatus = false; US_TEST_FAILED_MSG( << "Failed to unload module, got exception: " << e.what() << " + in " << name << ":FAIL" ); } if (teststatus && !sListen.checkEvents(events)) { teststatus = false; US_TEST_FAILED_MSG( << "Service listener event notification error :" << name << ":FAIL" ); } try { mc->RemoveServiceListener(&sListen, &TestServiceListener::serviceChanged); teststatus &= sListen.teststatus; sListen.clearEvents(); } catch (const std::logic_error& ise) { teststatus = false; US_TEST_FAILED_MSG( << "service listener removal failed " << ise.what() << " :" << name << ":FAIL" ); } } return teststatus; } void frameSL02a() { ModuleContext* mc = GetModuleContext(); TestServiceListener listener1(mc); TestServiceListener listener2(mc); try { mc->RemoveServiceListener(&listener1, &TestServiceListener::serviceChanged); mc->AddServiceListener(&listener1, &TestServiceListener::serviceChanged); mc->RemoveServiceListener(&listener2, &TestServiceListener::serviceChanged); mc->AddServiceListener(&listener2, &TestServiceListener::serviceChanged); } catch (const std::logic_error& ise) { US_TEST_FAILED_MSG( << "service listener registration failed " << ise.what() << " : frameSL02a:FAIL" ); } SharedLibraryHandle target("TestModuleA"); // Start the test target to get a service published. try { target.Load(); } catch (const std::exception& e) { US_TEST_FAILED_MSG( << "Failed to load module, got exception: " << e.what() << " + in frameSL02a:FAIL" ); } std::vector events; events.push_back(ServiceEvent::REGISTERED); US_TEST_CONDITION(listener1.checkEvents(events), "Check first service listener") US_TEST_CONDITION(listener2.checkEvents(events), "Check second service listener") mc->RemoveServiceListener(&listener1, &TestServiceListener::serviceChanged); mc->RemoveServiceListener(&listener2, &TestServiceListener::serviceChanged); target.Unload(); } void frameSL05a() { std::vector events; events.push_back(ServiceEvent::REGISTERED); events.push_back(ServiceEvent::UNREGISTERING); SharedLibraryHandle libA("TestModuleA"); bool testStatus = runLoadUnloadTest("FrameSL05a", 1, libA, events); US_TEST_CONDITION(testStatus, "FrameSL05a") } void frameSL10a() { std::vector events; events.push_back(ServiceEvent::REGISTERED); events.push_back(ServiceEvent::UNREGISTERING); SharedLibraryHandle libA2("TestModuleA2"); bool testStatus = runLoadUnloadTest("FrameSL10a", 1, libA2, events); US_TEST_CONDITION(testStatus, "FrameSL10a") } void frameSL25a() { ModuleContext* mc = GetModuleContext(); TestServiceListener sListen(mc, false); try { mc->AddServiceListener(&sListen, &TestServiceListener::serviceChanged); } catch (const std::logic_error& ise) { US_TEST_OUTPUT( << "service listener registration failed " << ise.what() ); throw; } SharedLibraryHandle libSL1("TestModuleSL1"); SharedLibraryHandle libSL3("TestModuleSL3"); SharedLibraryHandle libSL4("TestModuleSL4"); std::vector expectedServiceEventTypes; // Startup expectedServiceEventTypes.push_back(ServiceEvent::REGISTERED); // at start of libSL1 expectedServiceEventTypes.push_back(ServiceEvent::REGISTERED); // FooService at start of libSL4 expectedServiceEventTypes.push_back(ServiceEvent::REGISTERED); // at start of libSL3 // Stop libSL4 expectedServiceEventTypes.push_back(ServiceEvent::UNREGISTERING); // FooService at first stop of libSL4 #ifdef US_BUILD_SHARED_LIBS // Shutdown expectedServiceEventTypes.push_back(ServiceEvent::UNREGISTERING); // at stop of libSL1 expectedServiceEventTypes.push_back(ServiceEvent::UNREGISTERING); // at stop of libSL3 #endif // Start libModuleTestSL1 to ensure that the Service interface is available. try { US_TEST_OUTPUT( << "Starting libModuleTestSL1: " << libSL1.GetAbsolutePath() ); libSL1.Load(); } catch (const std::exception& e) { US_TEST_OUTPUT( << "Failed to load module, got exception: " << e.what() ); throw; } // Start libModuleTestSL4 that will require the serivce interface and publish - // ctkFooService + // us::FooService try { US_TEST_OUTPUT( << "Starting libModuleTestSL4: " << libSL4.GetAbsolutePath() ); libSL4.Load(); } catch (const std::exception& e) { US_TEST_OUTPUT( << "Failed to load module, got exception: " << e.what() ); throw; } // Start libModuleTestSL3 that will require the serivce interface and get the service try { US_TEST_OUTPUT( << "Starting libModuleTestSL3: " << libSL3.GetAbsolutePath() ); libSL3.Load(); } catch (const std::exception& e) { US_TEST_OUTPUT( << "Failed to load module, got exception: " << e.what() ); throw; } // Check that libSL3 has been notified about the FooService. US_TEST_OUTPUT( << "Check that FooService is added to service tracker in libSL3" ); try { ServiceReference libSL3SR = mc->GetServiceReference("ActivatorSL3"); US_BASECLASS_NAME* libSL3Activator = mc->GetService(libSL3SR); US_TEST_CONDITION_REQUIRED(libSL3Activator, "ActivatorSL3 service != 0"); ModulePropsInterface* propsInterface = dynamic_cast(libSL3Activator); US_TEST_CONDITION_REQUIRED(propsInterface, "Cast to ModulePropsInterface"); ModulePropsInterface::Properties::const_iterator i = propsInterface->GetProperties().find("serviceAdded"); US_TEST_CONDITION_REQUIRED(i != propsInterface->GetProperties().end(), "Property serviceAdded"); Any serviceAddedField3 = i->second; US_TEST_CONDITION_REQUIRED(!serviceAddedField3.Empty() && any_cast(serviceAddedField3), "libSL3 notified about presence of FooService"); mc->UngetService(libSL3SR); } catch (const ServiceException& se) { US_TEST_FAILED_MSG( << "Failed to get service reference:" << se ); } // Check that libSL1 has been notified about the FooService. US_TEST_OUTPUT( << "Check that FooService is added to service tracker in libSL1" ); try { ServiceReference libSL1SR = mc->GetServiceReference("ActivatorSL1"); US_BASECLASS_NAME* libSL1Activator = mc->GetService(libSL1SR); US_TEST_CONDITION_REQUIRED(libSL1Activator, "ActivatorSL1 service != 0"); ModulePropsInterface* propsInterface = dynamic_cast(libSL1Activator); US_TEST_CONDITION_REQUIRED(propsInterface, "Cast to ModulePropsInterface"); ModulePropsInterface::Properties::const_iterator i = propsInterface->GetProperties().find("serviceAdded"); US_TEST_CONDITION_REQUIRED(i != propsInterface->GetProperties().end(), "Property serviceAdded"); Any serviceAddedField1 = i->second; US_TEST_CONDITION_REQUIRED(!serviceAddedField1.Empty() && any_cast(serviceAddedField1), "libSL1 notified about presence of FooService"); mc->UngetService(libSL1SR); } catch (const ServiceException& se) { US_TEST_FAILED_MSG( << "Failed to get service reference:" << se ); } // Stop the service provider: libSL4 try { US_TEST_OUTPUT( << "Stop libSL4: " << libSL4.GetAbsolutePath() ); libSL4.Unload(); } catch (const std::exception& e) { US_TEST_OUTPUT( << "Failed to unload module, got exception:" << e.what() ); throw; } // Check that libSL3 has been notified about the removal of FooService. US_TEST_OUTPUT( << "Check that FooService is removed from service tracker in libSL3" ); try { ServiceReference libSL3SR = mc->GetServiceReference("ActivatorSL3"); US_BASECLASS_NAME* libSL3Activator = mc->GetService(libSL3SR); US_TEST_CONDITION_REQUIRED(libSL3Activator, "ActivatorSL3 service != 0"); ModulePropsInterface* propsInterface = dynamic_cast(libSL3Activator); US_TEST_CONDITION_REQUIRED(propsInterface, "Cast to ModulePropsInterface"); ModulePropsInterface::Properties::const_iterator i = propsInterface->GetProperties().find("serviceRemoved"); US_TEST_CONDITION_REQUIRED(i != propsInterface->GetProperties().end(), "Property serviceRemoved"); Any serviceRemovedField3 = i->second; US_TEST_CONDITION(!serviceRemovedField3.Empty() && any_cast(serviceRemovedField3), "libSL3 notified about removal of FooService"); mc->UngetService(libSL3SR); } catch (const ServiceException& se) { US_TEST_FAILED_MSG( << "Failed to get service reference:" << se ); } // Stop libSL1 try { US_TEST_OUTPUT( << "Stop libSL1:" << libSL1.GetAbsolutePath() ); libSL1.Unload(); } catch (const std::exception& e) { US_TEST_OUTPUT( << "Failed to unload module got exception" << e.what() ); throw; } // Stop pSL3 try { US_TEST_OUTPUT( << "Stop libSL3:" << libSL3.GetAbsolutePath() ); libSL3.Unload(); } catch (const std::exception& e) { US_TEST_OUTPUT( << "Failed to unload module got exception" << e.what() ); throw; } // Check service events seen by this class US_TEST_OUTPUT( << "Checking ServiceEvents(ServiceListener):" ); if (!sListen.checkEvents(expectedServiceEventTypes)) { US_TEST_FAILED_MSG( << "Service listener event notification error" ); } US_TEST_CONDITION_REQUIRED(sListen.getTestStatus(), "Service listener checks"); try { mc->RemoveServiceListener(&sListen, &TestServiceListener::serviceChanged); sListen.clearEvents(); } catch (const std::logic_error& ise) { US_TEST_FAILED_MSG( << "service listener removal failed: " << ise.what() ); } } int usServiceListenerTest(int /*argc*/, char* /*argv*/[]) { US_TEST_BEGIN("ServiceListenerTest"); frameSL02a(); frameSL05a(); frameSL10a(); frameSL25a(); US_TEST_END() } diff --git a/Core/Code/CppMicroServices/test/usServiceTrackerTest.cpp b/Core/Code/CppMicroServices/test/usServiceTrackerTest.cpp index 2c3c30bd23..cf1ad82485 100644 --- a/Core/Code/CppMicroServices/test/usServiceTrackerTest.cpp +++ b/Core/Code/CppMicroServices/test/usServiceTrackerTest.cpp @@ -1,204 +1,202 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ -#include - #include #include #include #include #include #include #include #include US_BASECLASS_HEADER #include "usServiceControlInterface.h" #include "usTestUtilSharedLibrary.h" #include US_USE_NAMESPACE int usServiceTrackerTest(int /*argc*/, char* /*argv*/[]) { US_TEST_BEGIN("ServiceTrackerTest") ModuleContext* mc = GetModuleContext(); SharedLibraryHandle libS("TestModuleS"); // Start the test target to get a service published. try { libS.Load(); } catch (const std::exception& e) { US_TEST_FAILED_MSG( << "Failed to load module, got exception: " << e.what() ); } // 1. Create a ServiceTracker with ServiceTrackerCustomizer == null std::string s1("org.cppmicroservices.TestModuleSService"); ServiceReference servref = mc->GetServiceReference(s1 + "0"); US_TEST_CONDITION_REQUIRED(servref != 0, "Test if registered service of id org.cppmicroservices.TestModuleSService0"); ServiceControlInterface* serviceController = mc->GetService(servref); US_TEST_CONDITION_REQUIRED(serviceController != 0, "Test valid service controller"); std::auto_ptr > st1(new ServiceTracker<>(mc, servref)); // 2. Check the size method with an unopened service tracker US_TEST_CONDITION_REQUIRED(st1->Size() == 0, "Test if size == 0"); // 3. Open the service tracker and see what it finds, // expect to find one instance of the implementation, // "org.cppmicroservices.TestModuleSService0" st1->Open(); std::string expName = "TestModuleS"; std::list sa2; st1->GetServiceReferences(sa2); US_TEST_CONDITION_REQUIRED(sa2.size() == 1, "Checking ServiceTracker size"); std::string name(us_service_impl_name(mc->GetService(sa2.front()))); US_TEST_CONDITION_REQUIRED(name == expName, "Checking service implementation name"); // 5. Close this service tracker st1->Close(); // 6. Check the size method, now when the servicetracker is closed US_TEST_CONDITION_REQUIRED(st1->Size() == 0, "Checking ServiceTracker size"); // 7. Check if we still track anything , we should get null sa2.clear(); st1->GetServiceReferences(sa2); US_TEST_CONDITION_REQUIRED(sa2.empty(), "Checking ServiceTracker size"); // 8. A new Servicetracker, this time with a filter for the object std::string fs = std::string("(") + ServiceConstants::OBJECTCLASS() + "=" + s1 + "*" + ")"; LDAPFilter f1(fs); st1.reset(new ServiceTracker<>(mc, f1)); // add a service serviceController->ServiceControl(1, "register", 7); // 9. Open the service tracker and see what it finds, // expect to find two instances of references to // "org.cppmicroservices.TestModuleSService*" // i.e. they refer to the same piece of code st1->Open(); sa2.clear(); st1->GetServiceReferences(sa2); US_TEST_CONDITION_REQUIRED(sa2.size() == 2, "Checking service reference count"); for (std::list::const_iterator i = sa2.begin(); i != sa2.end(); ++i) { std::string name(mc->GetService(*i)->GetNameOfClass()); US_TEST_CONDITION_REQUIRED(name == expName, "Check for expected class name"); } // 10. Get libTestModuleS to register one more service and see if it appears serviceController->ServiceControl(2, "register", 1); sa2.clear(); st1->GetServiceReferences(sa2); US_TEST_CONDITION_REQUIRED(sa2.size() == 3, "Checking service reference count"); for (std::list::const_iterator i = sa2.begin(); i != sa2.end(); ++i) { std::string name(mc->GetService(*i)->GetNameOfClass()); US_TEST_CONDITION_REQUIRED(name == expName, "Check for expected class name"); } // 11. Get libTestModuleS to register one more service and see if it appears serviceController->ServiceControl(3, "register", 2); sa2.clear(); st1->GetServiceReferences(sa2); US_TEST_CONDITION_REQUIRED(sa2.size() == 4, "Checking service reference count"); for (std::list::const_iterator i = sa2.begin(); i != sa2.end(); ++i) { std::string name = mc->GetService(*i)->GetNameOfClass(); US_TEST_CONDITION_REQUIRED(name == expName, "Check for expected class name"); } // 12. Get libTestModuleS to unregister one service and see if it disappears serviceController->ServiceControl(3, "unregister", 0); sa2.clear(); st1->GetServiceReferences(sa2); US_TEST_CONDITION_REQUIRED(sa2.size() == 3, "Checking service reference count"); for (std::list::const_iterator i = sa2.begin(); i != sa2.end(); ++i) { std::string name = mc->GetService(*i)->GetNameOfClass(); US_TEST_CONDITION_REQUIRED(name == expName, "Check for expected class name"); } // 13. Get the highest ranking service reference, it should have ranking 7 ServiceReference h1 = st1->GetServiceReference(); int rank = any_cast(h1.GetProperty(ServiceConstants::SERVICE_RANKING())); US_TEST_CONDITION_REQUIRED(rank == 7, "Check service rank"); // 14. Get the service of the highest ranked service reference US_BASECLASS_NAME* o1 = st1->GetService(h1); US_TEST_CONDITION_REQUIRED(o1 != 0, "Check for non-null service"); // 14a Get the highest ranked service, directly this time US_BASECLASS_NAME* o3 = st1->GetService(); US_TEST_CONDITION_REQUIRED(o3 != 0, "Check for non-null service"); US_TEST_CONDITION_REQUIRED(o1 == o3, "Check for equal service instances"); // 15. Now release the tracking of that service and then try to get it // from the servicetracker, which should yield a null object serviceController->ServiceControl(1, "unregister", 7); US_BASECLASS_NAME* o2 = st1->GetService(h1); US_TEST_CONDITION_REQUIRED(o2 == 0, "Checkt that service is null"); // 16. Get all service objects this tracker tracks, it should be 2 std::list ts1; st1->GetServices(ts1); US_TEST_CONDITION_REQUIRED(ts1.size() == 2, "Check service count"); // 17. Test the remove method. // First register another service, then remove it being tracked serviceController->ServiceControl(1, "register", 7); h1 = st1->GetServiceReference(); std::list sa3; st1->GetServiceReferences(sa3); US_TEST_CONDITION_REQUIRED(sa3.size() == 3, "Check service reference count"); for (std::list::const_iterator i = sa3.begin(); i != sa3.end(); ++i) { std::string name = mc->GetService(*i)->GetNameOfClass(); US_TEST_CONDITION_REQUIRED(name == expName, "Checking for expected class name"); } st1->Remove(h1); // remove tracking on one servref sa2.clear(); st1->GetServiceReferences(sa2); US_TEST_CONDITION_REQUIRED(sa2.size() == 2, "Check service reference count"); // 18. Test the addingService method,add a service reference // 19. Test the removedService method, remove a service reference // 20. Test the waitForService method US_BASECLASS_NAME* o9 = st1->WaitForService(50); US_TEST_CONDITION_REQUIRED(o9 != 0, "Checking WaitForService method"); US_TEST_END() } diff --git a/Core/Code/CppMicroServices/test/usStaticModuleResourceTest.cpp b/Core/Code/CppMicroServices/test/usStaticModuleResourceTest.cpp new file mode 100644 index 0000000000..dc73a7fe72 --- /dev/null +++ b/Core/Code/CppMicroServices/test/usStaticModuleResourceTest.cpp @@ -0,0 +1,151 @@ +/*============================================================================= + + Library: CppMicroServices + + Copyright (c) German Cancer Research Center, + Division of Medical and Biological Informatics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================*/ + +#include +#include +#include +#include +#include +#include + +#include + +#include "usTestUtilSharedLibrary.h" +#include "usTestingMacros.h" + +#include + +#include + +US_USE_NAMESPACE + +namespace { + +std::string GetResourceContent(const ModuleResource& resource) +{ + std::string line; + ModuleResourceStream rs(resource); + std::getline(rs, line); + return line; +} + +struct ResourceComparator { + bool operator()(const ModuleResource& mr1, const ModuleResource& mr2) const + { + return mr1 < mr2; + } +}; + +void testResourceOperators(Module* module) +{ + std::vector resources = module->FindResources("", "res.txt", false); + US_TEST_CONDITION_REQUIRED(resources.size() == 2, "Check resource count") + US_TEST_CONDITION(resources[0] != resources[1], "Check non-equality for equally named resources") +} + +void testResourcesWithStaticImport(Module* module) +{ + ModuleResource resource = module->GetResource("res.txt"); + US_TEST_CONDITION_REQUIRED(resource.IsValid(), "Check valid res.txt resource") + std::string line = GetResourceContent(resource); + US_TEST_CONDITION(line == "dynamic resource", "Check dynamic resource content") + + resource = module->GetResource("dynamic.txt"); + US_TEST_CONDITION_REQUIRED(resource.IsValid(), "Check valid dynamic.txt resource") + line = GetResourceContent(resource); + US_TEST_CONDITION(line == "dynamic", "Check dynamic resource content") + + resource = module->GetResource("static.txt"); + US_TEST_CONDITION_REQUIRED(resource.IsValid(), "Check valid static.txt resource") + line = GetResourceContent(resource); + US_TEST_CONDITION(line == "static", "Check dynamic resource content") + + std::vector resources = module->FindResources("", "*.txt", false); + std::stable_sort(resources.begin(), resources.end(), ResourceComparator()); +#ifdef US_BUILD_SHARED_LIBS + US_TEST_CONDITION(resources.size() == 4, "Check imported resource count") + line = GetResourceContent(resources[0]); + US_TEST_CONDITION(line == "dynamic", "Check dynamic.txt resource content") + line = GetResourceContent(resources[1]); + US_TEST_CONDITION(line == "dynamic resource", "Check res.txt (from importing module) resource content") + line = GetResourceContent(resources[2]); + US_TEST_CONDITION(line == "static resource", "Check res.txt (from imported module) resource content") + line = GetResourceContent(resources[3]); + US_TEST_CONDITION(line == "static", "Check static.txt (from importing module) resource content") +#else + US_TEST_CONDITION(resources.size() == 6, "Check imported resource count") + line = GetResourceContent(resources[0]); + US_TEST_CONDITION(line == "dynamic", "Check dynamic.txt resource content") + // skip foo.txt + line = GetResourceContent(resources[2]); + US_TEST_CONDITION(line == "dynamic resource", "Check res.txt (from importing module) resource content") + line = GetResourceContent(resources[3]); + US_TEST_CONDITION(line == "static resource", "Check res.txt (from imported module) resource content") + // skip special_chars.dummy.txt + line = GetResourceContent(resources[5]); + US_TEST_CONDITION(line == "static", "Check static.txt (from importing module) resource content") +#endif +} + +} // end unnamed namespace + + +int usStaticModuleResourceTest(int /*argc*/, char* /*argv*/[]) +{ + US_TEST_BEGIN("StaticModuleResourceTest"); + + ModuleContext* mc = GetModuleContext(); + assert(mc); + +#ifdef US_BUILD_SHARED_LIBS + SharedLibraryHandle libB("TestModuleB"); + + try + { + libB.Load(); + } + catch (const std::exception& e) + { + US_TEST_FAILED_MSG(<< "Load module exception: " << e.what()) + } + + Module* module = ModuleRegistry::GetModule("TestModuleB Module"); + US_TEST_CONDITION_REQUIRED(module != NULL, "Test for existing module TestModuleB") + + US_TEST_CONDITION(module->GetName() == "TestModuleB Module", "Test module name") +#else + Module* module = mc->GetModule(); +#endif + + testResourceOperators(module); + testResourcesWithStaticImport(module); + +#ifdef US_BUILD_SHARED_LIBS + ModuleResource resource = module->GetResource("static.txt"); + US_TEST_CONDITION_REQUIRED(resource.IsValid(), "Check valid static.txt resource") + + libB.Unload(); + + US_TEST_CONDITION_REQUIRED(resource.IsValid() == false, "Check invalid static.txt resource") +#endif + + US_TEST_END() +} diff --git a/Core/Code/CppMicroServices/test/usTestManager.cpp b/Core/Code/CppMicroServices/test/usTestManager.cpp index e52a2a7c7c..4d0a2a29a0 100644 --- a/Core/Code/CppMicroServices/test/usTestManager.cpp +++ b/Core/Code/CppMicroServices/test/usTestManager.cpp @@ -1,72 +1,78 @@ /*============================================================================= Library: CppMicroServices Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. =============================================================================*/ #include "usTestManager.h" #include "usModuleImport.h" US_BEGIN_NAMESPACE TestManager& TestManager::GetInstance() { static TestManager instance; return instance; } void TestManager::Initialize() { m_FailedTests = 0; m_PassedTests = 0; } int TestManager::NumberOfFailedTests() { return m_FailedTests; } int TestManager::NumberOfPassedTests() { return m_PassedTests; } void TestManager::TestFailed() { m_FailedTests++; } void TestManager::TestPassed() { m_PassedTests++; } US_END_NAMESPACE #ifndef US_BUILD_SHARED_LIBS US_IMPORT_MODULE(TestModuleA) US_IMPORT_MODULE(TestModuleA2) US_IMPORT_MODULE(TestModuleB) +US_IMPORT_MODULE_RESOURCES(TestModuleB) +US_IMPORT_MODULE(TestModuleR) +US_IMPORT_MODULE_RESOURCES(TestModuleR) US_IMPORT_MODULE(TestModuleS) US_IMPORT_MODULE(TestModuleSL1) US_IMPORT_MODULE(TestModuleSL3) US_IMPORT_MODULE(TestModuleSL4) -US_LOAD_IMPORTED_MODULES_INTO_MAIN(TestModuleA TestModuleA2 TestModuleB TestModuleImportedByB TestModuleS TestModuleSL1 TestModuleSL3 TestModuleSL4) +US_LOAD_IMPORTED_MODULES_INTO_MAIN( + TestModuleA TestModuleA2 TestModuleB TestModuleImportedByB TestModuleR + TestModuleS TestModuleSL1 TestModuleSL3 TestModuleSL4 + ) #endif diff --git a/Core/Code/CppMicroServices/test/usTestResource.txt b/Core/Code/CppMicroServices/test/usTestResource.txt new file mode 100644 index 0000000000..b5125a157a --- /dev/null +++ b/Core/Code/CppMicroServices/test/usTestResource.txt @@ -0,0 +1 @@ +meant to be compiled into the test driver diff --git a/Core/Code/CppMicroServices/tools/CMakeLists.txt b/Core/Code/CppMicroServices/tools/CMakeLists.txt new file mode 100644 index 0000000000..daa64f269d --- /dev/null +++ b/Core/Code/CppMicroServices/tools/CMakeLists.txt @@ -0,0 +1,6 @@ + +include_directories(${US_INCLUDE_DIRS}) + +add_definitions(-DUS_RCC_EXECUTABLE_NAME=\"${US_RCC_EXECUTABLE_NAME}\") + +add_executable(${US_RCC_EXECUTABLE_NAME} usResourceCompiler.cpp) diff --git a/Core/Code/CppMicroServices/tools/usResourceCompiler.cpp b/Core/Code/CppMicroServices/tools/usResourceCompiler.cpp new file mode 100644 index 0000000000..391a7adb86 --- /dev/null +++ b/Core/Code/CppMicroServices/tools/usResourceCompiler.cpp @@ -0,0 +1,668 @@ +/*============================================================================= + + Library: CppMicroServices + + Copyright (c) German Cancer Research Center, + Division of Medical and Biological Informatics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================*/ + +#include "usConfig.h" + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "stdint_p.h" + +#include "usConfig.h" + +#ifdef US_PLATFORM_WINDOWS +static const char DIR_SEP = '\\'; +#else +static const char DIR_SEP = '/'; +#endif + +class ResourceWriter; + +class Resource +{ + +public: + + enum Flags + { + NoFlags = 0x00, + Directory = 0x01 + }; + + Resource(const std::string& name, const std::string& path = std::string(), unsigned int flags = NoFlags); + ~Resource(); + + std::string GetResourcePath() const; + + int64_t WriteName(ResourceWriter& writer, int64_t offset); + void WriteTreeInfo(ResourceWriter& writer); + int64_t WritePayload(ResourceWriter& writer, int64_t offset, std::string* errorMessage); + + std::string name; + std::string path; + unsigned int flags; + Resource* parent; + std::map children; + std::map sortedChildren; + + int64_t nameOffset; + int64_t dataOffset; + int64_t childOffset; + +}; + +class ResourceWriter +{ + +public: + + ResourceWriter(const std::string& fileName, const std::string& libName); + ~ResourceWriter(); + + bool AddFiles(const std::vector& files, const std::string& basePath); + bool Write(); + +private: + + friend class Resource; + + bool AddFile(const std::string& alias, const Resource& file); + + bool WriteHeader(); + bool WritePayloads(); + bool WriteNames(); + bool WriteDataTree(); + bool WriteRegistrationCode(); + + void WriteString(const std::string& str); + void WriteChar(char c); + void WriteHex(uint8_t tmp); + void WriteNumber2(uint16_t number); + void WriteNumber4(uint32_t number); + + std::ofstream out; + std::vector files; + + std::string libName; + std::string fileName; + + Resource* root; +}; + +Resource::Resource(const std::string& name, const std::string& path, unsigned int flags) + : name(name) + , path(path) + , flags(flags) + , parent(NULL) + , nameOffset(0) + , dataOffset(0) + , childOffset(0) +{ +} + +Resource::~Resource() +{ + for (std::map::iterator i = children.begin(); + i != children.end(); ++i) + { + delete i->second; + } +} + +std::string Resource::GetResourcePath() const +{ + std::string resource = name; + for (Resource* p = parent; p; p = p->parent) + { + resource = resource.insert(0, p->name + '/'); + } + return resource; +} + +int64_t Resource::WriteName(ResourceWriter& writer, int64_t offset) +{ + // capture the offset + nameOffset = offset; + + // write the resource name as a comment + writer.WriteString(" // "); + writer.WriteString(name); + writer.WriteString("\n "); + + // write the length of the name + writer.WriteNumber2(static_cast(name.size())); + writer.WriteString("\n "); + offset += 2; + + // write the hash value + writer.WriteNumber4(static_cast(US_HASH_FUNCTION_NAMESPACE::US_HASH_FUNCTION(std::string, name))); + writer.WriteString("\n "); + offset += 4; + + // write the name itself + for (std::size_t i = 0; i < name.length(); ++i) + { + writer.WriteHex(name[i]); + if (i != 0 && i % 32 == 0) + writer.WriteString("\n "); + } + offset += name.length(); + + // done + writer.WriteString("\n "); + return offset; +} + +void Resource::WriteTreeInfo(ResourceWriter& writer) +{ + // write the resource path as a comment + writer.WriteString(" // "); + writer.WriteString(GetResourcePath()); + writer.WriteString("\n "); + + if (flags & Directory) + { + // name offset (in the us_resource_name array) + writer.WriteNumber4(static_cast(nameOffset)); + + // flags + writer.WriteNumber2(flags); + + // child count + writer.WriteNumber4(static_cast(children.size())); + + // first child offset (in the us_resource_tree array) + writer.WriteNumber4(static_cast(childOffset)); + } + else + { + // name offset + writer.WriteNumber4(static_cast(nameOffset)); + + // flags + writer.WriteNumber2(flags); + + // padding (not used) + writer.WriteNumber4(0); + + // data offset + writer.WriteNumber4(static_cast(dataOffset)); + } + writer.WriteChar('\n'); +} + +int64_t Resource::WritePayload(ResourceWriter& writer, int64_t offset, std::string* errorMessage) +{ + // capture the offset + dataOffset = offset; + + // open the resource file on the file system + std::ifstream file(path.c_str(), std::ifstream::in | std::ifstream::binary); + if (!file) + { + *errorMessage = "File could not be opened: " + path; + return 0; + } + + // write the full path of the resource in the file system as a comment + writer.WriteString(" // "); + writer.WriteString(path); + writer.WriteString("\n "); + + // write the length + file.seekg(0, std::ifstream::end); + std::ifstream::pos_type size = file.tellg(); + file.seekg(0); + writer.WriteNumber4(static_cast(size)); + writer.WriteString("\n "); + offset += 4; + + // write the actual payload + int charsLeft = 16; + char c = 0; + while (file.get(c)) + { + --charsLeft; + writer.WriteHex(static_cast(c)); + if (charsLeft == 0) + { + writer.WriteString("\n "); + charsLeft = 16; + } + } + + offset += size; + + // done + writer.WriteString("\n "); + return offset; +} + +ResourceWriter::ResourceWriter(const std::string& fileName, const std::string& libName) + : libName(libName) + , fileName(fileName) + , root(NULL) +{ + out.exceptions(std::ofstream::goodbit); + out.open(fileName.c_str()); +} + +ResourceWriter::~ResourceWriter() +{ + delete root; +} + +bool ResourceWriter::AddFiles(const std::vector& files, const std::string& basePath) +{ + bool success = true; + for (std::size_t i = 0; i < files.size(); ++i) + { + const std::string& file = files[i]; + if (file.size() <= basePath.size() || file.substr(0, basePath.size()) != basePath) + { + std::cerr << "File " << file << " is not an absolute path starting with " << basePath << std::endl; + success = false; + } + else + { + const std::string relativePath = file.substr(basePath.size()); + std::string name = relativePath; + std::size_t index = relativePath.find_last_of(DIR_SEP); + if (index != std::string::npos) + { + name = relativePath.substr(index+1); + } + success &= AddFile(relativePath, Resource(name, file)); + } + } + return success; +} + +bool ResourceWriter::Write() +{ + if (!WriteHeader()) + { + std::cerr << "Could not write header." << std::endl; + return false; + } + if (!WritePayloads()) + { + std::cerr << "Could not write data blobs." << std::endl; + return false; + } + if (!WriteNames()) + { + std::cerr << "Could not write file names." << std::endl; + return false; + } + if (!WriteDataTree()) + { + std::cerr << "Could not write data tree." << std::endl; + return false; + } + if (!WriteRegistrationCode()) + { + std::cerr << "Could not write footer" << std::endl; + return false; + } + + return true; +} + +bool ResourceWriter::AddFile(const std::string& alias, const Resource& file) +{ + std::ifstream in(file.path.c_str(), std::ifstream::in | std::ifstream::binary); + if (!in) + { + std::cerr << "File could not be opened: " << file.path << std::endl; + return false; + } + in.seekg(0, std::ifstream::end); + std::ifstream::pos_type size = in.tellg(); + in.close(); + + if (size > 0xffffffff) + { + std::cerr << "File too big: " << file.path << std::endl; + return false; + } + + if (!root) + { + root = new Resource(std::string(), std::string(), Resource::Directory); + } + + Resource* parent = root; + std::stringstream ss(alias); + std::vector nodes; + { + std::string node; + while (std::getline(ss, node, DIR_SEP)) + { + if (node.empty()) + continue; + nodes.push_back(node); + } + } + + for(std::size_t i = 0; i < nodes.size()-1; ++i) + { + const std::string& node = nodes[i]; + if (parent->children.find(node) == parent->children.end()) + { + Resource* s = new Resource(node, std::string(), Resource::Directory); + s->parent = parent; + parent->children.insert(std::make_pair(node, s)); + parent->sortedChildren.insert(std::make_pair(static_cast(US_HASH_FUNCTION_NAMESPACE::US_HASH_FUNCTION(std::string, node)), s)); + parent = s; + } + else + { + parent = parent->children[node]; + } + } + + const std::string filename = nodes.back(); + Resource* s = new Resource(file); + s->parent = parent; + parent->children.insert(std::make_pair(filename, s)); + parent->sortedChildren.insert(std::make_pair(static_cast(US_HASH_FUNCTION_NAMESPACE::US_HASH_FUNCTION(std::string, filename)), s)); + return true; +} + +bool ResourceWriter::WriteHeader() +{ + std::stringstream ss; + std::time_t now = time(0); + ss << std::ctime(&now); + + WriteString("/*=============================================================================\n"); + WriteString(" Resource object code\n"); + WriteString("\n"); + WriteString(" Created: "); + WriteString(ss.str()); + WriteString(" by: The Resource Compiler for CppMicroServices version "); + WriteString(CppMicroServices_VERSION_STR); + WriteString("\n\n"); + WriteString(" WARNING! All changes made in this file will be lost!\n"); + WriteString( "=============================================================================*/\n\n"); + WriteString("#include \n"); + WriteString("#include \n\n"); + return true; +} + +bool ResourceWriter::WritePayloads() +{ + if (!root) + return false; + + WriteString("static const unsigned char us_resource_data[] = {\n"); + std::stack pending; + + pending.push(root); + int64_t offset = 0; + std::string errorMessage; + while (!pending.empty()) + { + Resource* file = pending.top(); + pending.pop(); + for (std::map::iterator i = file->children.begin(); + i != file->children.end(); ++i) + { + Resource* child = i->second; + if (child->flags & Resource::Directory) + { + pending.push(child); + } + else + { + offset = child->WritePayload(*this, offset, &errorMessage); + if (offset == 0) + { + std::cerr << errorMessage << std::endl; + } + } + } + } + WriteString("\n};\n\n"); + return true; +} + +bool ResourceWriter::WriteNames() +{ + if (!root) + return false; + + WriteString("static const unsigned char us_resource_name[] = {\n"); + + std::map names; + std::stack pending; + + pending.push(root); + int64_t offset = 0; + while (!pending.empty()) + { + Resource* file = pending.top(); + pending.pop(); + for (std::map::iterator it = file->children.begin(); + it != file->children.end(); ++it) + { + Resource* child = it->second; + if (child->flags & Resource::Directory) + { + pending.push(child); + } + if (names.find(child->name) != names.end()) + { + child->nameOffset = names[child->name]; + } + else + { + names.insert(std::make_pair(child->name, offset)); + offset = child->WriteName(*this, offset); + } + } + } + WriteString("\n};\n\n"); + return true; +} + +bool ResourceWriter::WriteDataTree() +{ + if (!root) + return false; + + WriteString("static const unsigned char us_resource_tree[] = {\n"); + std::stack pending; + + // calculate the child offsets in the us_resource_tree array + pending.push(root); + int offset = 1; + while (!pending.empty()) + { + Resource* file = pending.top(); + pending.pop(); + file->childOffset = offset; + + // calculate the offset now + for (std::map::iterator i = file->sortedChildren.begin(); + i != file->sortedChildren.end(); ++i) + { + Resource* child = i->second; + ++offset; + if (child->flags & Resource::Directory) + { + pending.push(child); + } + } + } + + // write the tree structure + pending.push(root); + root->WriteTreeInfo(*this); + while (!pending.empty()) + { + Resource *file = pending.top(); + pending.pop(); + + // write the actual data now + for (std::map::iterator i = file->sortedChildren.begin(); + i != file->sortedChildren.end(); ++i) + { + Resource *child = i->second; + child->WriteTreeInfo(*this); + if (child->flags & Resource::Directory) + { + pending.push(child); + } + } + } + WriteString("\n};\n\n"); + + return true; +} + +bool ResourceWriter::WriteRegistrationCode() +{ + WriteString("US_BEGIN_NAMESPACE\n\n"); + WriteString("extern US_EXPORT bool RegisterResourceData(int, ModuleInfo*, ModuleInfo::ModuleResourceData, ModuleInfo::ModuleResourceData, ModuleInfo::ModuleResourceData);\n\n"); + WriteString("US_END_NAMESPACE\n\n"); + + WriteString(std::string("extern \"C\" US_ABI_EXPORT int _us_init_resources_") + libName + + "(US_PREPEND_NAMESPACE(ModuleInfo)* moduleInfo)\n"); + WriteString("{\n"); + WriteString(" US_PREPEND_NAMESPACE(RegisterResourceData)(0x01, moduleInfo, us_resource_tree, us_resource_name, us_resource_data);\n"); + WriteString(" return 1;\n"); + WriteString("}\n"); + + return true; +} + +void ResourceWriter::WriteString(const std::string& str) +{ + out << str; +} + +void ResourceWriter::WriteChar(char c) +{ + out << c; +} + +void ResourceWriter::WriteHex(uint8_t tmp) +{ + const char* const digits = "0123456789abcdef"; + WriteChar('0'); + WriteChar('x'); + if (tmp < 16) + { + WriteChar(digits[tmp]); + } + else + { + WriteChar(digits[tmp >> 4]); + WriteChar(digits[tmp & 0xf]); + } + WriteChar(','); +} + +void ResourceWriter::WriteNumber2(uint16_t number) +{ + WriteHex(number >> 8); + WriteHex(static_cast(number)); +} + +void ResourceWriter::WriteNumber4(uint32_t number) +{ + WriteHex(number >> 24); + WriteHex(number >> 16); + WriteHex(number >> 8); + WriteHex(number); +} + + +#ifdef US_PLATFORM_POSIX +#include +std::string GetCurrentDir() +{ + char currDir[512]; + if (!getcwd(currDir, sizeof(currDir))) + { + std::cerr << "Getting the current directory failed." << std::endl; + exit(EXIT_FAILURE); + } + return std::string(currDir); +} +#else +#ifndef WIN32_LEAN_AND_MEAN +#define WIN32_LEAN_AND_MEAN +#endif +#include +std::string GetCurrentDir() +{ + TCHAR currDir[512]; + DWORD dwRet; + dwRet = GetCurrentDirectory(sizeof(currDir), currDir); + + if( dwRet == 0 || dwRet > 512) + { + std::cerr << "Getting the current directory failed." << std::endl; + exit(EXIT_FAILURE); + } + return std::string(currDir); +} +#endif + +int main(int argc, char** argv) +{ + if (argc < 4) + { + std::cout << US_RCC_EXECUTABLE_NAME " - A resource compiler for C++ Micro Services modules\n" + "\n" + "Usage: " US_RCC_EXECUTABLE_NAME " LIBNAME OUTPUT INPUT [INPUT]...\n" + "Convert all INPUT files into hex code embedded in C funtions written to OUTPUT.\n"; + exit(EXIT_SUCCESS); + } + + std::string libName(argv[1]); + std::string fileName(argv[2]); + + std::vector inputFiles; + + for (int i = 3; i < argc; i++) + { + inputFiles.push_back(argv[i]); + } + + ResourceWriter writer(fileName, libName); + if (!writer.AddFiles(inputFiles, GetCurrentDir())) + { + return EXIT_FAILURE; + } + + return writer.Write() ? EXIT_SUCCESS : EXIT_FAILURE; +} diff --git a/Core/Code/CppMicroServices/usConfig.h.in b/Core/Code/CppMicroServices/usConfig.h.in index 05802cb127..59c59a4753 100644 --- a/Core/Code/CppMicroServices/usConfig.h.in +++ b/Core/Code/CppMicroServices/usConfig.h.in @@ -1,229 +1,253 @@ /* USCONFIG.h this file is generated. Do not change! */ #ifndef USCONFIG_H #define USCONFIG_H #cmakedefine US_BUILD_SHARED_LIBS #cmakedefine CppMicroServices_EXPORTS #cmakedefine US_ENABLE_AUTOLOADING_SUPPORT #cmakedefine US_ENABLE_THREADING_SUPPORT #cmakedefine US_ENABLE_SERVICE_FACTORY_SUPPORT #cmakedefine US_USE_CXX11 ///------------------------------------------------------------------- // Version information //------------------------------------------------------------------- #define CppMicroServices_VERSION_MAJOR @CppMicroServices_VERSION_MAJOR@ #define CppMicroServices_VERSION_MINOR @CppMicroServices_VERSION_MINOR@ #define CppMicroServices_VERSION_PATH @CppMicroServices_VERSION_PATCH@ #define CppMicroServices_VERSION @CppMicroServices_VERSION@ #define CppMicroServices_VERSION_STR "@CppMicroServices_VERSION@" +///------------------------------------------------------------------- +// Macros used by the unit tests +//------------------------------------------------------------------- + +#define CppMicroServices_SOURCE_DIR "@CppMicroServices_SOURCE_DIR@" + ///------------------------------------------------------------------- // Macros for import/export declarations //------------------------------------------------------------------- #if defined(WIN32) #define US_ABI_EXPORT __declspec(dllexport) #define US_ABI_IMPORT __declspec(dllimport) #define US_ABI_LOCAL #else #if __GNUC__ >= 4 #define US_ABI_EXPORT __attribute__ ((visibility ("default"))) #define US_ABI_IMPORT __attribute__ ((visibility ("default"))) #define US_ABI_LOCAL __attribute__ ((visibility ("hidden"))) #else #define US_ABI_EXPORT #define US_ABI_IMPORT #define US_ABI_LOCAL #endif #endif #ifdef US_BUILD_SHARED_LIBS // We are building a shared lib #ifdef CppMicroServices_EXPORTS #define US_EXPORT US_ABI_EXPORT #else #define US_EXPORT US_ABI_IMPORT #endif #else // We are building a static lib #if __GNUC__ >= 4 // Don't hide RTTI symbols of definitions in the C++ Micro Services // headers that are included in DSOs with hidden visibility #define US_EXPORT US_ABI_EXPORT #else #define US_EXPORT #endif #endif //------------------------------------------------------------------- // Namespace customization //------------------------------------------------------------------- #define US_NAMESPACE @US_NAMESPACE@ #ifndef US_NAMESPACE /* user namespace */ # define US_PREPEND_NAMESPACE(name) ::name # define US_USE_NAMESPACE # define US_BEGIN_NAMESPACE # define US_END_NAMESPACE # define US_FORWARD_DECLARE_CLASS(name) class name; # define US_FORWARD_DECLARE_STRUCT(name) struct name; #else /* user namespace */ # define US_PREPEND_NAMESPACE(name) ::US_NAMESPACE::name # define US_USE_NAMESPACE using namespace ::US_NAMESPACE; # define US_BEGIN_NAMESPACE namespace US_NAMESPACE { # define US_END_NAMESPACE } # define US_FORWARD_DECLARE_CLASS(name) \ US_BEGIN_NAMESPACE class name; US_END_NAMESPACE # define US_FORWARD_DECLARE_STRUCT(name) \ US_BEGIN_NAMESPACE struct name; US_END_NAMESPACE namespace US_NAMESPACE {} #endif /* user namespace */ #define US_BASECLASS_NAME @US_BASECLASS_NAME@ #define US_BASECLASS_HEADER <@US_BASECLASS_HEADER@> // base class forward declaration @US_BASECLASS_FORWARD_DECLARATION@ //------------------------------------------------------------------- // Platform defines //------------------------------------------------------------------- #if defined(__APPLE__) #define US_PLATFORM_APPLE #endif #if defined(__linux__) #define US_PLATFORM_LINUX #endif #if defined(_WIN32) || defined(_WIN64) #define US_PLATFORM_WINDOWS #else #define US_PLATFORM_POSIX #endif //------------------------------------------------------------------- -// Compiler defines +// Macros for suppressing warnings //------------------------------------------------------------------- -#if defined(_MSC_VER) && !defined(_SCL_SECURE_NO_WARNINGS) - #define _SCL_SECURE_NO_WARNINGS +#ifdef _MSC_VER +#define US_MSVC_PUSH_DISABLE_WARNING(wn) \ +__pragma(warning(push)) \ +__pragma(warning(disable:wn)) +#define US_MSVC_POP_WARNING \ +__pragma(warning(pop)) +#define US_MSVC_DISABLE_WARNING(wn) \ +__pragma(warning(disable:wn)) +#else +#define US_MSVC_PUSH_DISABLE_WARNING(wn) +#define US_MSVC_POP_WARNING +#define US_MSVC_DISABLE_WARNING(wn) #endif +// Do not warn about the usage of deprecated unsafe functions +US_MSVC_DISABLE_WARNING(4996) + //------------------------------------------------------------------- // Debuging & Logging //------------------------------------------------------------------- #if defined(NDEBUG) && !defined(US_NO_DEBUG_OUTPUT) #define US_NO_DEBUG_OUTPUT #endif US_BEGIN_NAMESPACE enum MsgType { DebugMsg = 0, InfoMsg = 1, WarningMsg = 2, ErrorMsg = 3 }; typedef void (*MsgHandler)(MsgType, const char *); US_EXPORT MsgHandler installMsgHandler(MsgHandler); US_END_NAMESPACE //------------------------------------------------------------------- // Hash Container //------------------------------------------------------------------- #ifdef US_USE_CXX11 #include #include #define US_HASH_FUNCTION_BEGIN(type) \ template<> \ struct hash : std::unary_function { \ std::size_t operator()(const type& arg) const { #define US_HASH_FUNCTION_END } }; #define US_HASH_FUNCTION(type, arg) hash()(arg) - + #if defined(US_PLATFORM_WINDOWS) && (_MSC_VER < 1700) #define US_HASH_FUNCTION_FRIEND(type) friend class ::std::hash #else #define US_HASH_FUNCTION_FRIEND(type) friend struct ::std::hash #endif #define US_UNORDERED_MAP_TYPE ::std::unordered_map #define US_UNORDERED_SET_TYPE ::std::unordered_set #define US_HASH_FUNCTION_NAMESPACE ::std #define US_HASH_FUNCTION_NAMESPACE_BEGIN namespace std { #define US_HASH_FUNCTION_NAMESPACE_END } #elif defined(__GNUC__) #include #include - + #define US_HASH_FUNCTION_BEGIN(type) \ template<> \ struct hash : std::unary_function { \ - std::size_t operator()(const type& arg) const { - + std::size_t operator()(const type& arg) const { + #define US_HASH_FUNCTION_END } }; - + #define US_HASH_FUNCTION(type, arg) hash()(arg) #define US_HASH_FUNCTION_FRIEND(type) friend struct ::std::tr1::hash #define US_UNORDERED_MAP_TYPE ::std::tr1::unordered_map #define US_UNORDERED_SET_TYPE ::std::tr1::unordered_set #define US_HASH_FUNCTION_NAMESPACE ::std::tr1 #define US_HASH_FUNCTION_NAMESPACE_BEGIN namespace std { namespace tr1 { #define US_HASH_FUNCTION_NAMESPACE_END }} #elif _MSC_VER <= 1500 // Visual Studio 2008 and lower #include #include - + #define US_HASH_FUNCTION_BEGIN(type) \ template<> \ - inline std::size_t hash_value(const type& arg) { - + inline std::size_t hash_value(const type& arg) { + #define US_HASH_FUNCTION_END } - + #define US_HASH_FUNCTION(type, arg) hash_value(arg) #define US_HASH_FUNCTION_FRIEND(type) friend std::size_t stdext::hash_value(const type&) #define US_UNORDERED_MAP_TYPE ::stdext::hash_map #define US_UNORDERED_SET_TYPE ::stdext::hash_set #define US_HASH_FUNCTION_NAMESPACE ::stdext #define US_HASH_FUNCTION_NAMESPACE_BEGIN namespace stdext { #define US_HASH_FUNCTION_NAMESPACE_END } #endif //------------------------------------------------------------------- // Threading Configuration //------------------------------------------------------------------- #ifdef US_ENABLE_THREADING_SUPPORT #define US_DEFAULT_THREADING US_PREPEND_NAMESPACE(MultiThreaded) #else #define US_DEFAULT_THREADING US_PREPEND_NAMESPACE(SingleThreaded) #endif +//------------------------------------------------------------------- +// Header Availability +//------------------------------------------------------------------- + +#cmakedefine HAVE_STDINT #endif // USCONFIG_H