From b939d1a0b6b375ea5bae54d83a1cb89eb888c75a Mon Sep 17 00:00:00 2001 From: gcontini <1121667+gcontini@users.noreply.github.com> Date: 周六, 21 3月 2020 20:57:47 +0800 Subject: [PATCH] update docs --- CMakeLists.txt | 166 +++++++++++++++++++++++++++++++++++++------------------ 1 files changed, 111 insertions(+), 55 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 882174e..d401573 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,11 +1,5 @@ -cmake_minimum_required(VERSION 2.8.11 FATAL_ERROR) +cmake_minimum_required(VERSION 3.6 FATAL_ERROR) -#version variables, major and minor must be 1 character only -SET(LICENSECC_MAJOR_VERSION 1) -SET(LICENSECC_MINOR_VERSION 1) -SET(LICENSECC_PATCH_VERSION 0 CACHE STRING "Licensecc patch version string") -SET(LICENSECC_INT_VERSION "${LICENSECC_MAJOR_VERSION}${LICENSECC_MINOR_VERSION}${LICENSECC_PATCH_VERSION}") -SET(LICENSECC_VERSION "${LICENSECC_MAJOR_VERSION}.${LICENSECC_MINOR_VERSION}.${LICENSECC_PATCH_VERSION}") SET(LICENSECC_SHORT_LICENSE "BSD Software License") SET(CMAKE_DISABLE_SOURCE_CHANGES OFF) #keys are generated in the source tree by default @@ -22,10 +16,16 @@ set(LCC_PROJECTS_BASE_DIR "${CMAKE_SOURCE_DIR}/projects") ENDIF(NOT LCC_PROJECTS_BASE_DIR) -project (licensecc C CXX ) +cmake_policy(SET CMP0048 NEW) +#cmake_policy(SET CMP0091 NEW) +project (licensecc + VERSION 2.0.0 + DESCRIPTION "Copy protection and licensing library" + LANGUAGES CXX) + set(CMAKE_CXX_STANDARD 11) set(CMAKE_CXX_STANDARD_REQUIRED ON) -SET(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/") +SET(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake/") #find lcc executable or build it. find_package(lcc REQUIRED) @@ -35,34 +35,22 @@ SET(CMAKE_CROSSCOMPILING_EMULATOR "wine") ENDIF() -if(MSVC) - include(target_arch) - target_architecture( TARGET_ARCHITECTURE ) - message(STATUS "architecture detected: ${TARGET_ARCHITECTURE}") - - #cmake > 3.15 handle the /MD flag more nicely than this - if(${STATIC_RUNTIME}) - string(REPLACE "/MD" "/MT" CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE}") - string(REPLACE "/MD" "/MT" CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}") - string(REPLACE "/MDd" "/MTd" CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG}") - string(REPLACE "/MDd" "/MTd" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}") - SET(Boost_USE_STATIC_RUNTIME ON) - endif(${STATIC_RUNTIME}) - - add_definitions("/D _CRT_SECURE_NO_WARNINGS") -else(MSVC) - if(MINGW) - list(APPEND EXTERNAL_LIBS "-lcrypt32 -lws2_32 -liphlpapi") - SET(CMAKE_EXE_LINKER_FLAGS "-static") - endif(MINGW) -endif(MSVC) +SET (OPENSSL_USE_STATIC_LIBS TRUE) +IF(${STATIC_RUNTIME}) + SET(OPENSSL_MSVC_STATIC_RT TRUE) +ENDIF(${STATIC_RUNTIME}) +find_package(OpenSSL COMPONENTS Crypto QUIET) +IF(OPENSSL_FOUND) + MESSAGE(STATUS "Found openssl version ${OPENSSL_VERSION} -licensecc") +ENDIF(OPENSSL_FOUND) if(UNIX) #this is true for all the linux systems but not for cross compiling "linux->windows" - #find a static version of openssl crypto library - SET ( OPENSSL_USE_STATIC_LIBS ON ) - find_package(OpenSSL REQUIRED COMPONENTS Crypto) - include_directories(${OPENSSL_INCLUDE_DIR}) - MESSAGE(STATUS "Found openssl version ${OPENSSL_VERSION} ") + IF(${STATIC_RUNTIME}) + set(CMAKE_EXE_LINKER_FLAGS "-static-libgcc -static-libstdc++ -static") + ENDIF(${STATIC_RUNTIME}) + IF(NOT OPENSSL_FOUND) + MESSAGE(SEND_ERROR "Openssl required in Linux, please install it or specify -DOPENSSL_ROOT") + ENDIF(NOT OPENSSL_FOUND) find_package(Threads) if(THREADS_HAVE_PTHREAD_ARG) @@ -72,17 +60,45 @@ list(APPEND EXTERNAL_LIBS "${CMAKE_THREAD_LIBS_INIT}") endif() endif(THREADS_HAVE_PTHREAD_ARG) + + #Zlib required with old openssl version < 1.0.1f in centos 7 + IF(OPENSSL_VERSION VERSION_LESS_EQUAL 1.0.2) + SET ( ZLIB_USE_STATIC_LIBS ON ) + find_package(ZLIB REQUIRED) + list(APPEND EXTERNAL_LIBS ${ZLIB_LIBRARIES}) + MESSAGE(STATUS "Found zlib version ${ZLIB_VERSION_STRING} - licensecc") + ELSE(OPENSSL_VERSION VERSION_LESS_EQUAL 1.0.2) + MESSAGE(STATUS "openssl ${OPENSSL_VERSION} zlib not required - licensecc") + ENDIF(OPENSSL_VERSION VERSION_LESS_EQUAL 1.0.2) find_program( MEMORYCHECK_COMMAND valgrind ) set( MEMORYCHECK_COMMAND_OPTIONS "--trace-children=yes --leak-check=full" ) - - if(USE_DBUS_IDENTIFIER) - FIND_PACKAGE(Dbus REQUIRED) - add_definitions(-DUSE_DBUS) - include_directories(${DBUS_INCLUDE_DIR}) - include_directories(${DBUS_ARCH_INCLUDE_DIR}) - list(APPEND EXTERNAL_LIBS ${DBUS_LIBRARIES}) - endif(USE_DBUS_IDENTIFIER) + set(main_lib_dest "lib/${PROJECT_NAME}") +else(UNIX) + IF(NOT OPENSSL_FOUND) + MESSAGE(STATUS "Openssl not found, configuring the library without it (running in wine not supported).") + ENDIF(NOT OPENSSL_FOUND) + if(MSVC) + include(target_arch) + target_architecture( TARGET_ARCHITECTURE ) + message(STATUS "architecture detected: ${TARGET_ARCHITECTURE}") + #cmake > 3.15 handle the /MD flag more nicely than this + if(STATIC_RUNTIME) + message(STATUS "Static runtime ${STATIC_RUNTIME}") + string(REPLACE "/MD" "/MT" CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}") + string(REPLACE "/MDd" "/MTd" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}") + #list(APPEND CMAKE_CXX_FLAGS_DEBUG "/MTd") + SET(Boost_USE_STATIC_RUNTIME ON) + endif(STATIC_RUNTIME) + add_definitions("/D _CRT_SECURE_NO_WARNINGS") + list(APPEND EXTERNAL_LIBS "bcrypt" "crypt32" "ws2_32" "iphlpapi") + else(MSVC) + if(MINGW) + list(APPEND EXTERNAL_LIBS "-lbcrypt" "-lcrypt32" "-lws2_32" "-liphlpapi") + SET(CMAKE_EXE_LINKER_FLAGS "-static -static-libstdc++") + endif(MINGW) + endif(MSVC) + set(main_lib_dest "${PROJECT_NAME}") endif(UNIX) #initialize project @@ -97,24 +113,20 @@ COMMENT "generating ${LCC_PROJECT_PUBLIC_KEY}" USES_TERMINAL ) +include_directories( ${LCC_INCLUDE_DIR} "${CMAKE_CURRENT_SOURCE_DIR}/include" ) add_custom_target(project_initialize DEPENDS "${LCC_PROJECT_PUBLIC_KEY}" "${LCC_PROJECT_PRIVATE_KEY}") -include_directories( ${LCC_INCLUDE_DIR} ${CMAKE_BINARY_DIR} "${CMAKE_CURRENT_SOURCE_DIR}/include") - -message( STATUS "C compiler : " ${CMAKE_C_COMPILER}) -message( STATUS "C compiler flags : " ${CMAKE_C_FLAGS}) -message( STATUS "CXX compiler : " ${CMAKE_CXX_COMPILER}) -message( STATUS "CXX compiler flags: " ${CMAKE_CXX_FLAGS}) +message( STATUS "CXX compiler : " ${CMAKE_CXX_COMPILER}) +message( STATUS "CXX compiler flags : " ${CMAKE_CXX_FLAGS}) message( STATUS "CXX compiler flags debug : " ${CMAKE_CXX_FLAGS_DEBUG}) message( STATUS "CXX compiler flags release: " ${CMAKE_CXX_FLAGS_RELEASE}) if(CMAKE_BUILD_TYPE) - message( STATUS "Build type : " ${CMAKE_BUILD_TYPE}) + message( STATUS "Build type : " ${CMAKE_BUILD_TYPE}) endif(CMAKE_BUILD_TYPE) -message( STATUS "Install prefix : " ${CMAKE_INSTALL_PREFIX}) -message( STATUS "Project name : " ${LCC_PROJECT_NAME} ) -message( STATUS "Project base dir : " ${LCC_PROJECTS_BASE_DIR}/${LCC_PROJECT_NAME} ) +message( STATUS "Install prefix : " ${CMAKE_INSTALL_PREFIX}) +message( STATUS "Project name : " ${LCC_PROJECT_NAME} ) +message( STATUS "Project base dir : " ${LCC_PROJECTS_BASE_DIR}/${LCC_PROJECT_NAME} ) -install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/ DESTINATION include) add_subdirectory(src) #boost is required only for tests @@ -130,7 +142,6 @@ endif() SET( Boost_USE_STATIC_LIBS ON ) find_package(Boost COMPONENTS unit_test_framework system filesystem) - #if boost is found enable tests IF(Boost_FOUND) INCLUDE(CTest) @@ -139,6 +150,51 @@ MARK_AS_ADVANCED(BUILDNAME) add_subdirectory(test) ENDIF(BUILD_TESTING) + add_subdirectory("src/inspector") ELSE(Boost_FOUND) message(WARNING "Boost not found, disabling tests") ENDIF(Boost_FOUND) + +################################# +# Documentation +################################# +find_package(Doxygen COMPONENTS dot) +find_package(Sphinx) + +IF(Doxygen_FOUND AND Sphinx_FOUND) + message(STATUS "Doxygen found, generating docs.") + SET(DOXYGEN_EXCLUDE_PATTERNS "*/library/ini/*;*/doc/resources/*") + SET(DOXYGEN_DISABLE_INDEX YES) + #SET(DOXYGEN_GENERATE_TREEVIEW YES) + SET(DOXYGEN_GENERATE_XML YES) + SET(DOXYGEN_LAYOUT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/doc/DoxygenLayout.xml") + doxygen_add_docs(docs doc src include/licensecc ${LCC_INCLUDE_DIR} COMMENT "doxygen docs") + #file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/resources/" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/html") + + #file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/doc/sphinx/" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}") + set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/doc) + set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/docs/sphinx) + + add_custom_target(documentation + COMMAND + ${SPHINX_EXECUTABLE} -b html + ${SPHINX_SOURCE} ${SPHINX_BUILD} + -Dbreathe_projects.licensecc=${CMAKE_CURRENT_BINARY_DIR}/xml + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + COMMENT "Generating documentation with Sphinx") + add_dependencies(documentation docs) + +ELSE(Doxygen_FOUND AND Sphinx_FOUND) + message(STATUS "Doxygen or Sphynx not found, not generating docs.") +ENDIF(Doxygen_FOUND AND Sphinx_FOUND) + + +install(DIRECTORY ${LCC_INCLUDE_DIR} DESTINATION include/${PROJECT_NAME}) +install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/ DESTINATION include) +install(FILES src/cmake/licensecc-config.cmake DESTINATION ${main_lib_dest}) + +include(CMakePackageConfigHelpers) +write_basic_package_version_file(${CMAKE_BINARY_DIR}/licensecc-config-version.cmake COMPATIBILITY SameMajorVersion) +install(FILES ${CMAKE_BINARY_DIR}/licensecc-config-version.cmake DESTINATION ${main_lib_dest}) + + -- Gitblit v1.9.1