cmake构建一个学习项目

Bertha 。 2023-06-09 10:15 11阅读 0赞

## 做了什么 ##

1.  构建一个学习项目（比如: <unix 高级编程> <unix 网络编程>，都能使用例中的方法，减少增加代码后的重新编译库文件)
2.  遇见问题总结
3.  区分系统，使用不同库

## 首先看下项目结构 ##

cmake_project/
    ├── build
    ├── CMakeLists.txt
    ├── include
    ├── lib
    └── src
        ├── CMakeLists.txt
        ├── lib
        │   ├── CMakeLists.txt
        │   ├── hello.c
        │   └── hello.h
        └── test
            ├── CMakeLists.txt
            └── main.c

*  项目中的一级目录和文件有５个，４个目录、１个文件。build　最后用于编译的文件，cmake编译时会有副产物，不想副产物和代码混一起就老实加个build。include 是后面放头文件的位置。lib是后面放库文件的位置。src是源代码存放位置。CMakeLists.txt是cmake运行规则集，文件名不能错了要带s。下面看看根目录下的CMakeLists.txt（用到4个CMakeLists.txt)

PROJECT(cmake_project)        #项目名,不能有空格。我试了下，有空格时cmake会报找不到compliter
    CMAKE_MINIMUM_REQUIRED(VERSION 2.8)     #cmake最小版本
    
    #这里设置安装目录前缀为当前项目根目录，系统默认是/usr/local。不想安装到系统中，只是一个学习测试用。
    SET(CMAKE_INSTALL_PREFIX ${CMAKE_SOURCE_DIR})
    
    #源文件子项目
    ADD_SUBDIRECTORY(src)

第行用途也写得很明白，就不多说啥了。

*  src目录中2个目录，1个文件。lib 中是会使用到的库文件源码和头文件源码。test目录是一个简单测试用例。CMakeLists.txt是src子项目cmake运行规则集。看看

#添加共用库源文件
    ADD_SUBDIRECTORY(lib)
    
    #判断共用库头文件和库是否在根目录的lib,include中存在
    if(EXISTS ${CMAKE_SOURCE_DIR}/include/hello.h AND EXISTS ${CMAKE_SOURCE_DIR}/lib/libhello.so)
            MESSAGE("hello.h 头文件和libhello.so 找到了")
            MESSAGE("开始添加hello库")
            #先把共用库头文件和库文件加入项目搜索路径
            INCLUDE_DIRECTORIES(${CMAKE_SOURCE_DIR}/include/)
            #这是只能先使用LINK_DIRECTORIES,再使用LINK_LIBRARIES。
            #我的第一个做法是直接LINK_LIBRARIES(${CMAKE_SOURCE_DIR}/lib/libhello.so),然而是不行的，cmake会去找../lib/YOULIB，提示找不到库文件。
            LINK_DIRECTORIES(${CMAKE_SOURCE_DIR}/lib)
            LINK_LIBRARIES(hello)
            MESSAGE("添加hello库成功")
            #下面是你添加子项目的位置，可以多个添加。子项目中默认已经引入了hello共享库
            #这里我犯了一个错误，先ADD_SUBDIRECTORY；再使用前面的三句加库文件和头文件，cmake死活找不到头文件和库文件。看别人的代码才意识到问题
            #对于学习项目，以后要加入新的学习项目，就可以将项目目录加入到这个位置。还有个办法是把test替换成一个变量，在变量中加入子项目
            ADD_SUBDIRECTORY(test)
    #这里只是一些根目录没有找到库文件和头文件的提示信息
    else()
            MESSAGE("hello.h 或 libhello.so 没有找到，用下面方法添加hello>库：")
            MESSAGE("１）进入项目主目录")
            MESSAGE("２）cd build")
            MESSAGE("３）cmake ..")
            MESSAGE("４）make")
            MESSAGE("５）make install")
    endif()

这里面有2个地方出过问题，注释中都有提到。还是单独例出来：

1  加link_libraries
        只能先指定库文件搜索路径，再指定库文件。想直接指定库文件为`LINK_LIBRARIES(${ CMAKE_SOURCE_DIR}/lib/libhello.so)`是不行了。${CMAKE_SOURCE_DIR}会被直接转换成cmake后面的
        .. 或 别的目录。最终找不到库文件
    2  对于想要使用共用库的子项目，只能在指定共用库头文件和库文件后再使用`ADD_SUBDIRECTORY()`加入项目。
    3 if,elseif,else后面都要加（），平时else后面都不用加的容易忘记

*  lib 目录：1个头文件hello.h, 1个库文件源码hello.c, 1个CMakeLists.txt

/* lib/hello.h */
    #ifndef _hello_h
    void hello();
    #endif

/* lib/hello.c*/
    #include "hello.h"
    #include <stdio.h>
    
    void hello(){ 
            printf("<start>\n");
            printf("你好cmake\n");
            printf("这是一个共用库\n");
            printf("<end>\n");
    }

#生成libhello.so动态库
    ADD_LIBRARY(hello SHARED hello.c)
    
    #设置libhello.so版本信息，非必需
    SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.0 SOVERSION 1)
    
    #make install 执行动作
    INSTALL(TARGETS hello DESTINATION lib)
    INSTALL(FILES hello.h DESTINATION include)

*  test目录就更简单了，1个测试文件，1个CMakeLists.txt

/* test/main.c */
    #include "hello.h"
    
    int
    main(void){ 
            printf("这是对hello()的第一次使用\n");
            hello();
            printf("第一次使用到此结束\n");
    }

# test/CMakeLists.txt 
    ADD_EXECUTABLE(main main.c)

至此所有需要编写的文件就写完了，开始运行。

cd 根目录/build
    cmake ..

下面是运行cmake会出现的一段提示，这些提示是src/CMakeLists.txt里面我们自己加入的。

hello.h 或 libhello.so 没有找到，用下面方法添加hello库：
    １）进入项目主目录
    ２）cd build
    ３）cmake ..
    ４）make
    ５）make install

接下来运行`make&make install`安装公共库和公共头文件到lib、include。安装完成后，可以打开 `根目录/lib 根目录/include` 察看有没有生成库和头文件。

再次打开 `根目录/build` 运行：

cmake ..
    make
    cd src/test
    ./main

找到 根目录/build/src/test/main 执行文件。执行结果：

这是对hello()的第一次使用
    <start>
    你好cmake
    这是一个共用库
    <end>
    第一次使用到此结束

可以看到程序执行顺利。以后再加入新的学习子项目，就可以直接加入到src/ 目录下面。再增加一行src/CMakeLists.txt内容。在新项目中出完全不用新加入include\_directories 、link\_directories、link\_library了。只需要生成执行文件或库文件就可以了。然后再在 根目录/build 下面 cmake … ＆ make 就可以了。就能在对应的`build/src/新子项目`中找到执行文件或库文件了。

## 最后再说下不同系统间移植问题 ##

这个网络上其实挺多的就是用几个变量判断下而已，不过我的情况特殊。我使用termux 它返回的系统是unix 而不是Android 但有的库文件又和unix是有区别的这就比较烦人了。暂时做法是强行区分系统。电脑上用的系统uname -r返回没有perf+字段，而手机termux上的uname -r 返回是带一个perf+字段。我暂时就是用的这个字段区分它们。

if(UNIX AND ${CMAKE_SYSTEM} MATCHES perf)
    	MESSAGE("system is termux")
    elseif(UNIX)
    	MESSAGE("system is unix-like")
    else()
    	MESSAGE("sorry, not test for this system")
    endif()

cmake手册里面有几个变量是专门为区分系统设置的，可以参考手册页找到合适你的。