Cmake构建工程设计——Cmake工程框架

港控/mmm° 2022-10-04 15:50 293阅读 0赞

# Cmake工程的嵌套关系 #

## 编译脚本build.sh ##

在顶层建立build文件夹，里面放入编译脚本

#!/bin/bash
    CMAKE_TYPE="MinGW Makefiles"
    PROJECT_BUILD_TYPE="Release"
    PROJRCT_INSTALL=""
    CMAKE_VS=0
    clean()
    { 
    	cd ../
    	if [ -d "project_cache/" ];then	
    		cd ./project_cache
    		make clean
    		cd -
    	fi
    	
    	rm -rf ./project_cache
    	rm -rf ./target
    	
    	echo "clean project finish."
    }
    
    init()
    { 
    	if [ $(uname) == "Linux" ]; then
    		CMAKE_TYPE="Unix Makefiles"
    	elif [ $CMAKE_VS == 1 ]; then
    		CMAKE_TYPE="Visual Studio 15 2017"
    	else
    		CMAKE_TYPE="MinGW Makefiles"
    	fi
    
    	echo "$CMAKE_TYPE Start"
    }
    
    
    for i in $*           
    do
    	case $i in
    	"inc")
    		echo "inc test $i"
    		;;
    	"clean")
    		clean
    		exit 0
    		;;
    	"test")
    		echo "clean test $i"
    		;;
    	"Debug")
    		PROJECT_BUILD_TYPE=$i
    		;;
    	"VS2017")
    		CMAKE_VS=1
    		;;
    	"install")
    		PROJRCT_INSTALL="--target install"
    		;;
    	*)
    		echo "error $i"
    		exit 1
    		;;
    	esac
    done
    
    init
    
    cd ..
    
    if [ ! -d "project_cache/" ];then
    	mkdir project_cache
    fi
    
    cd project_cache
    
    cmake -G "$CMAKE_TYPE" ../ -DCMAKE_TOOLCHAIN_FILE=../cmake_config/config.cmake -DCMAKE_BUILD_TYPE=$PROJECT_BUILD_TYPE
    
    if [ $? -ne 0 ]; then
        echo "camke filed"
    	exit 1
    fi
    
    cmake --build . $PROJRCT_INSTALL

## 顶层CMakeLists.txt ##

# Cmake支持的最低版本
    cmake_minimum_required(VERSION 3.15.5)
    
    # 工程名以及简介
    set(MAIN_NAME CmakeTest)
    project(${MAIN_NAME}
    	VERSION 1.2.3.4
    	DESCRIPTION "CmekTest"
    	HOMEPAGE_URL "https://cmake.org/cmake/help/v3.15/command/project.html")
    
    message(STATUS "PROJECT_NAME ${PROJECT_NAME}")
    message(STATUS "PROJECT_VERSION ${PROJECT_VERSION}")
    message(STATUS "PROJECT_DESCRIPTION ${PROJECT_DESCRIPTION}")
    message(STATUS "PROJECT_HOMEPAGE_URL ${PROJECT_HOMEPAGE_URL}")
    
    # 导入配置文件
    include(${PROJECT_SOURCE_DIR}/common_config.cmake)
    
    add_subdirectory(src)
    
    # 安装文件夹
    install(DIRECTORY ${PROJECT_SOURCE_DIR}/file
    		DESTINATION ${PROJECT_SOURCE_DIR}/target)
    		
    # 安装文件，可读可写
    install(FILES ${PROJECT_SOURCE_DIR}/testfile.txt
    		DESTINATION ${PROJECT_SOURCE_DIR}/target/file
    		PERMISSIONS OWNER_READ OWNER_WRITE)
    
    # 安装shell脚本，只读
    install(PROGRAMS ${PROJECT_SOURCE_DIR}/testsh.sh
    		DESTINATION ${PROJECT_SOURCE_DIR}/target/bin
    		PERMISSIONS OWNER_READ OWNER_EXECUTE)

## 源码集合层CMakeLists.txt ##

set(PROJECT_APP project_app)
    
    # 添加可执行文件
    add_executable(${PROJECT_APP})
    
    # 添加头文件依赖
    target_include_directories(${PROJECT_APP} 
    	PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)
    
    # 添加宏定义
    target_compile_definitions(${PROJECT_APP} 
    	PRIVATE -D DEFINE_TEST)
    
    add_subdirectory(app)
    add_subdirectory(lib)
    add_subdirectory(system)
    
    install(TARGETS ${PROJECT_APP}
            CONFIGURATIONS ${CMAKE_BUILD_TYPE}
            RUNTIME DESTINATION ${PROJECT_SOURCE_DIR}/target)

## 模块层CMakeLists.txt ##

target_include_directories(${SOURCE_LIB} 
        PRIVATE ${PROJECT_SOURCE_DIR}/src/include
        PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/inc)
    
    aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src SRC_CODE)
    
    target_sources(${SOURCE_LIB} PRIVATE ${SRC_CODE})

## 库文件层CMakeLists.txt ##

set(SOURCE_LIB test_lib)
    
    aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR}/src CODE_SOURCE)
    
    add_library(${SOURCE_LIB} ${LIB_TYPE} ${CODE_SOURCE})
    
    target_include_directories(${SOURCE_LIB}
        PRIVATE ${PROJECT_SOURCE_DIR}/src/include
        PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/inc)
    
    set_target_properties(${SOURCE_LIB} PROPERTIES VERSION 1.2.3.4 SOVERSION 5)
    
    target_link_libraries( ${PROJECT_APP} PRIVATE ${SOURCE_LIB})
    
    install(TARGETS ${SOURCE_LIB}
            CONFIGURATIONS ${CMAKE_BUILD_TYPE} # Debug 或 Release
            ARCHIVE DESTINATION ${PROJECT_SOURCE_DIR}/target/${CMAKE_BUILD_TYPE}/staticLib  #静态库安装路径
            LIBRARY DESTINATION ${PROJECT_SOURCE_DIR}/target/${CMAKE_BUILD_TYPE}/sharedLib) #动态库安装路径

# 工程架构 #

Cmake工程的大致框架如下

.
    ├── build
    │   └── build.sh—————————————————————————————————Cmake入口
    ├── CMakeLists.txt———————————————————————————————顶层Cmake 定义工程：project 导入配置文件：include 工程安装：install
    └── src
        ├── CMakeLists.txt———————————————————————————工程Cmake 链接头文件：target_include_directories  安装可执行程序：install
        ├── include——————————————————————————————————工程整体头文件
        │   └── project_public.h
        ├── project_module———————————————————————————模块 
        │   ├── CMakeLists.txt———————————————————————链接头文件：target_include_directories 链接源码：target_sources
        │   ├── inc
        │   │   └── project_module.h
        │   └── src
        │       └── project_module.cpp
        ├── project_lib——————————————————————————————库
        │   ├── CMakeLists.txt———————————————————————链接头文件：target_include_directories 链接库源码：aux_source_directory 创建库：add_library
        │   ├── inc									 链接库：target_link_libraries 安装库：install
        │   │   └── project_lib.h
        │   └── src
        │       └── project_lib.c
        └── project_system——————————————————————————工程main
            ├── CMakeLists.txt——————————————————————链接头文件：target_include_directories 链接源码：target_sources
            ├── inc
            │   └── project_system.h
            └── src
                └── main.cpp

# 工程编译 #

启动build.sh脚本，解析整个工程的CmakeLists.txt

Windows MinGW 编译

$ ./build.sh Debug install
    MinGW Makefiles Start
    import config.cmake
    import config.cmake
    -- The C compiler identification is GNU 9.2.0
    -- The CXX compiler identification is GNU 9.2.0
    -- Check for working C compiler: F:/Tools/MinGW/bin/gcc.exe
    import config.cmake
    -- Check for working C compiler: F:/Tools/MinGW/bin/gcc.exe -- works
    -- Detecting C compiler ABI info
    import config.cmake
    -- Detecting C compiler ABI info - done
    -- Detecting C compile features
    -- Detecting C compile features - done
    -- Check for working CXX compiler: F:/Tools/MinGW/bin/g++.exe
    import config.cmake
    -- Check for working CXX compiler: F:/Tools/MinGW/bin/g++.exe -- works
    -- Detecting CXX compiler ABI info
    import config.cmake
    -- Detecting CXX compiler ABI info - done
    -- Detecting CXX compile features
    -- Detecting CXX compile features - done
    -- PROJECT_NAME CmakeTest
    -- PROJECT_VERSION 1.2.3.4
    -- PROJECT_DESCRIPTION CmekTest
    -- PROJECT_HOMEPAGE_URL https://cmake.org/cmake/help/v3.15/command/project.html
    import common_config.cmake
    -- Configuring done
    -- Generating done
    -- Build files have been written to: G:/share/Code/test_Makefile/project_cache
    Scanning dependencies of target test_lib
    [  3%] Building C object src/lib/TestLib/CMakeFiles/test_lib.dir/src/open_module1.c.obj
    [  7%] Building C object src/lib/TestLib/CMakeFiles/test_lib.dir/src/open_module2.c.obj
    [ 10%] Linking C static library libtest_lib.a
    [ 10%] Built target test_lib
    Scanning dependencies of target module
    [ 14%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_func.c.obj
    [ 17%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_list.c.obj
    [ 21%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_steam_file.c.obj
    [ 25%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_system.c.obj
    [ 28%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/CApp/module_CApp.cpp.obj
    [ 32%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/CApp/module_steam_CApp.cpp.obj
    [ 35%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/CApp/module_string.cpp.obj
    [ 39%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_list.cpp.obj
    [ 42%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_map.cpp.obj
    [ 46%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_sort.cpp.obj
    [ 50%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_string.cpp.obj
    [ 53%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_vector.cpp.obj
    [ 57%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/Cpp_STL_random_shuffle.cpp.obj
    [ 60%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/Cpp_STL_unique.cpp.obj
    [ 64%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/The_C_list/module_Clist.cpp.obj
    [ 67%] Linking CXX static library libmodule.a
    [ 67%] Built target module
    Scanning dependencies of target algorithmTest
    [ 71%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/BinaryTree.cpp.obj
    [ 75%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/ClassicalAlgorithm.cpp.obj
    [ 78%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/FindAlgorithm.cpp.obj
    [ 82%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/SortAlgorithm.cpp.obj
    [ 85%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/module_queue.cpp.obj
    [ 89%] Linking CXX static library libalgorithmTest.a
    [ 89%] Built target algorithmTest
    Scanning dependencies of target project_app
    [ 92%] Building CXX object src/CMakeFiles/project_app.dir/system/src/System_Interpace.cpp.obj
    [ 96%] Building CXX object src/CMakeFiles/project_app.dir/system/src/main.cpp.obj
    [100%] Linking CXX executable project_app.exe
    [100%] Built target project_app
    Install the project...
    -- Install configuration: "Debug"
    -- Installing: G:/share/Code/test_Makefile/target/Debug/staticLib/libalgorithmTest.a
    -- Installing: G:/share/Code/test_Makefile/target/Debug/staticLib/libmodule.a
    -- Installing: G:/share/Code/test_Makefile/target/Debug/staticLib/libtest_lib.a
    -- Installing: G:/share/Code/test_Makefile/target/project_app.exe
    -- Installing: G:/share/Code/test_Makefile/target/file
    -- Installing: G:/share/Code/test_Makefile/target/file/file.bin
    -- Installing: G:/share/Code/test_Makefile/target/file/file.txt
    -- Installing: G:/share/Code/test_Makefile/target/file/testfile.txt
    -- Installing: G:/share/Code/test_Makefile/target/bin/testsh.sh

Linux gcc 编译

ghost@ghost-machine:~/Project/build$ ./build.sh Debug install
    Unix Makefiles Start
    import config.cmake
    import config.cmake
    -- The C compiler identification is GNU 7.5.0
    -- The CXX compiler identification is GNU 7.5.0
    -- Check for working C compiler: /usr/bin/cc
    import config.cmake
    -- Check for working C compiler: /usr/bin/cc - works
    -- Detecting C compiler ABI info
    import config.cmake
    -- Detecting C compiler ABI info - done
    -- Detecting C compile features
    -- Detecting C compile features - done
    -- Check for working CXX compiler: /usr/bin/c++
    import config.cmake
    -- Check for working CXX compiler: /usr/bin/c++ - works
    -- Detecting CXX compiler ABI info
    import config.cmake
    -- Detecting CXX compiler ABI info - done
    -- Detecting CXX compile features
    -- Detecting CXX compile features - done
    -- PROJECT_NAME CmakeTest
    -- PROJECT_VERSION 1.2.3.4
    -- PROJECT_DESCRIPTION CmekTest
    -- PROJECT_HOMEPAGE_URL https://cmake.org/cmake/help/v3.15/command/project.html
    Cmake end message
    import common_config.cmake
    PC UNIX Debug
    using gcc
    -- Configuring done
    -- Generating done
    -- Build files have been written to: /home/ghost/Project/project_cache
    Scanning dependencies of target test_lib
    [  3%] Building C object src/lib/TestLib/CMakeFiles/test_lib.dir/src/open_module1.c.o
    [  7%] Building C object src/lib/TestLib/CMakeFiles/test_lib.dir/src/open_module2.c.o
    [ 10%] Linking C shared library libtest_lib.so
    [ 10%] Built target test_lib
    Scanning dependencies of target algorithmTest
    [ 14%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/BinaryTree.cpp.o
    [ 17%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/ClassicalAlgorithm.cpp.o
    [ 21%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/FindAlgorithm.cpp.o
    [ 25%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/SortAlgorithm.cpp.o
    [ 28%] Building CXX object src/app/AlgorithmTest/CMakeFiles/algorithmTest.dir/src/module_queue.cpp.o
    [ 32%] Linking CXX static library libalgorithmTest.a
    [ 32%] Built target algorithmTest
    Scanning dependencies of target module
    [ 35%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_func.c.o
    [ 39%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_list.c.o
    [ 42%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_steam_file.c.o
    [ 46%] Building C object src/app/module/CMakeFiles/module.dir/c_code/src/module_system.c.o
    [ 50%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/CApp/module_CApp.cpp.o
    [ 53%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/CApp/module_steam_CApp.cpp.o
    [ 57%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/CApp/module_string.cpp.o
    [ 60%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_list.cpp.o
    [ 64%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_map.cpp.o
    [ 67%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_sort.cpp.o
    [ 71%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_string.cpp.o
    [ 75%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/CApp_STL_vector.cpp.o
    [ 78%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/Cpp_STL_random_shuffle.cpp.o
    [ 82%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/STL_containers/Cpp_STL_unique.cpp.o
    [ 85%] Building CXX object src/app/module/CMakeFiles/module.dir/cpp_code/The_C_list/module_Clist.cpp.o
    [ 89%] Linking CXX static library libmodule.a
    [ 89%] Built target module
    Scanning dependencies of target project_app
    [ 92%] Building CXX object src/CMakeFiles/project_app.dir/system/src/System_Interpace.cpp.o
    [ 96%] Building CXX object src/CMakeFiles/project_app.dir/system/src/main.cpp.o
    [100%] Linking CXX executable project_app
    [100%] Built target project_app
    Install the project...
    -- Install configuration: "Debug"
    -- Installing: /home/ghost/Project/target/Debug/staticLib/libalgorithmTest.a
    -- Installing: /home/ghost/Project/target/Debug/staticLib/libmodule.a
    -- Installing: /home/ghost/Project/target/Debug/sharedLib/libtest_lib.so.1.2.3.4
    -- Installing: /home/ghost/Project/target/Debug/sharedLib/libtest_lib.so.5
    -- Installing: /home/ghost/Project/target/Debug/sharedLib/libtest_lib.so
    -- Installing: /home/ghost/Project/target/project_app
    -- Set runtime path of "/home/ghost/Project/target/project_app" to ""
    -- Installing: /home/ghost/Project/target/file
    -- Installing: /home/ghost/Project/target/file/file.txt
    -- Installing: /home/ghost/Project/target/file/file.bin
    -- Installing: /home/ghost/Project/target/file/testfile.txt
    -- Installing: /home/ghost/Project/target/bin/testsh.sh