zoukankan      html  css  js  c++  java
  • HelloWorld CMake CMake中构建静态库与动态库及其使用

    继续完善Hello World,建立它的共享库, 包括静态库和动态库。

    本节的任务:

    1,建立一个静态库和动态库,提供HelloFunc函数供其他程序编程使用,HelloFunc

    向终端输出Hello World字符串。

    2,安装头文件与共享库。

    3, 编写一个程序使用创建的共享库(静态库和动态库)。

    cd /home/ccj/CMakeDemo

    mkdir t3

     

    cd /backup/cmake/t3

    mkdir lib

     

    在t3目录下建立CMakeLists.txt,内容如下:

    PROJECT(HELLOLIB)

    # 通过在主工程文件CMakeLists.txt中修改ADD_SUBDIRECTORY (lib) 指令来指定一个编译输出位置;

    # 指定本工程中静态库libhello.so生成的位置,即 build/lib;

    ADD_SUBDIRECTORY(lib)

    # 也可以通过变更为其他的位置,如

    # ADD_SUBDIRECTORY(lib lib_new)

    # 则,静态库libhello.so生成的位置变为 build/lib_new;

     

    在lib目录下建立两个源文件hello.cpp与 hello.h

    hello.cpp内容如下:

    #include "hello.h"

    using namespace std;

    void HelloFunc(){

    cout << "Hello World/n";

    }

    hello.h内容如下:

    #ifndef HELLO_H

    #define HELLO_H

    #include <stdio.h>

    void HelloFunc();

    #endif

     

    在lib目录下建立CMakeLists.txt,内容如下:

    注意: 这里我们将Section 7之前的CMakeLists.txt中应有的内容提供如下:

    SET (LIBHELLO_SRC hello.cpp)

    # SET (LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)

     

    # three kinds of libraries:

    # 1. shared, i.e., dynamic library,动态库文件扩展名常为 "*.so";

    # 2. static, i.e., static library, 静态库文件扩展名常为 "*.a";

    # 而且,我们通常希望静态库和动态库文件名保持一致,只是扩展名不同;

    # 3. module, this parameter is valid only when dyld is supported;

    # otherwise, will be considered as shared

    # 添加动态库,关键词为shared,你不需要写全libhello.so,

    # 只需要填写hello即可,cmake系统会自动为你生成 libhello.X

    ADD_LIBRARY (hello SHARED ${LIBHELLO_SRC})

    # 添加静态库,关键词为static,

    # ADD_LIBRARY (hello STATIC ${LIBHELLO_SRC})

    # 仍然用hello作为target名时,是不能成功创建所需的静态库的,

    # 因为hello作为一个target是不能重名的, 故把上面的hello修改为hello_static

    # 同理,你不需要写全libhello_static.a

    # 只需要填写hello即可,cmake系统会自动为你生成 libhello_static.X

    ADD_LIBRARY (hello_static STATIC ${LIBHELLO_SRC})

     

    # 按照一般的习惯,静态库名字跟动态库名字应该是一致的,只是扩展名不同;

    # 即:静态库名为 libhello.a; 动态库名为libhello.so ;

    # 所以,希望 "hello_static" 在输出时,不是"hello_static",而是以"hello"的名字显示,故设置如下:

    SET_TARGET_PROPERTIES (hello_static PROPERTIES OUTPUT_NAME "hello")

     

    GET_TARGET_PROPERTY (OUTPUT_VALUE hello_static OUTPUT_NAME)

    MESSAGE (STATUS "This is the hello_static OUTPUT_NAME: " ${OUTPUT_VALUE})

     

    # cmake在构建一个新的target时,会尝试清理掉其他使用这个名字的库,

    # 因此,在构建libhello.a时,就会清理掉libhello.so.

    # 为了回避这个问题,比如再次使用SET_TARGET_PROPERTIES定义 CLEAN_DIRECT_OUTPUT属性。

    SET_TARGET_PROPERTIES (hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

    SET_TARGET_PROPERTIES (hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)

     

    # 按照规则,动态库是应该包含一个版本号的,

    # VERSION指代动态库版本,SOVERSION指代API版本。

    SET_TARGET_PROPERTIES (hello PROPERTIES VERSION 1.2 SOVERSION 1)

     

    # 我们需要将libhello.a, libhello.so.x以及hello.h安装到系统目录,才能真正让其他人开发使用,

    # 在本例中我们将hello的共享库安装到<prefix>/lib目录;

    # 将hello.h安装<prefix>/include/hello目录。

    INSTALL (TARGETS hello hello_static LIBRARY DESTINATION lib

    ARCHIVE DESTINATION lib)

    INSTALL (FILES hello.h DESTINATION include/hello)

     

     

    :

    仍然采用out-of-source编译的方式,按照习惯,我们建立一个build目录,在build

    目录中

    cmake ..

    make

    这时,你就可以在lib目录得到一个libhello.so,这就是我们期望的共享库。

    如果你要指定libhello.so生成的位置,可以通过:

    • 在主工程文件CMakeLists.txt中修改ADD_SUBDIRECTORY (lib) 指令来指定一个编译输出位置;
    • 或者在 lib/CMakeLists.txt中添加SET (LIBRARY_OUTPUT_PATH <路径>) 来指定一个新的位置。

     

    这两者的区别我们上一节已经提到了,所以,这里不再赘述,下面,我们解释一下一个新的

    指令ADD_LIBRARY。

     

    ADD_LIBRARY(libname [SHARED|STATIC|MODULE]

    [EXCLUDE_FROM_ALL] source1 source2 ... sourceN)

    你不需要写全 libhello.so,只需要填写hello即可,cmake系统会自动为你生成 libhello.X

     

    类型有三种:

    • SHARED,动态库;
    • STATIC,静态库
    • MODULE,在使用dyld的系统有效,如果不支持dyld,则被当作SHARED对待。

     

    EXCLUDE_FROM_ALL参数的意思是这个库不会被默认构建,除非有其他的组件依赖或者手动构建。

     

    同样使用上面的指令,我们在支持动态库的基础上再为工程添加一个静态库,按照一般的习

    惯,静态库名字跟动态库名字应该是一致的,只不过后缀是.a罢了。

    下面我们用这个指令再来添加静态库:

     

    ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})

     

    然后再在build目录进行外部编译,我们会发现,静态库根本没有被构建,仍然只生成了

    一个动态库。因为hello作为一个ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

    就可以构建一个libhello_static.a的静态库了。

    这种结果显示不是我们想要的,我们需要的是名字相同的静态库和动态库,因为target名

    称是唯一的,所以,我们肯定不能通过ADD_LIBRARY指令来实现了。这时候我们需要用到

    另外一个指令:

    SET_TARGET_PROPERTIES,

    其基本语法是:

    SET_TARGET_PROPERTIES (target1 target2 ...PROPERTIES prop1 value1 prop2 value2 ...)

    这条指令可以用来设置输出的名称,对于动态库,还可以用来指定动态库版本和API版本。

     

    在本例中,我们需要作的是向lib/CMakeLists.txt中添加一条:

    SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")

    这样,我们就可以同时得到libhello.so 和 libhello.a两个库了。

     

    与SET_TARGET_PROPERTIES对应的指令是:

    GET_TARGET_PROPERTY (VAR target property)

     

    具体用法如下例,我们向lib/CMakeListst.txt中添加:

    GET_TARGET_PROPERTY (OUTPUT_VALUE hello_static OUTPUT_NAME)

    MESSAGE(STATUS "This is the hello_static OUTPUT_NAME: "${OUTPUT_VALUE})

    如果没有这个属性定义,则返回NOTFOUND.

     

    让我们来检查一下最终的构建结果,我们发现,libhello.a已经构建完成,位于

    build/lib目录中,但是libhello.so去消失了。这个问题的原因是:cmake在构建一

    个新的target时,会尝试清理掉其他使用这个名字的库,因为,在构建libhello.a时,

    就会清理掉libhello.so. 为了回避这个问题,比如再次使用SET_TARGET_PROPERTIES定义

    CLEAN_DIRECT_OUTPUT属性。

     

    向lib/CMakeLists.txt中添加:

    SET_TARGET_PROPERTIES (hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)

    SET_TARGET_PROPERTIES (hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

    这时候,我们再次进行构建,会发现build/lib目录中同时生成libhello.so和libhello.a了。

     

    按照规则,动态库是应该包含一个版本号的,我们可以看一下系统的动态库,一般情况是

    libhello.so.1.2

    libhello.so ->libhello.so.1

    libhello.so.1->libhello.so.1.2

    为了实现动态库版本号,我们仍然需要使用SET_TARGET_PROPERTIES指令。

    具体使用方法如下:

    SET_TARGET_PROPERTIES (hello PROPERTIES VERSION 1.2 SOVERSION 1)

    VERSION指代动态库版本,SOVERSION指代API版本。

    将上述指令加入lib/CMakeLists.txt中,重新构建看看结果。

    在build/lib目录会生成:

    libhello.so.1.2

    libhello.so.1->libhello.so.1.2

    libhello.so ->libhello.so.1

     

     

    目录,将hello.h安装<prefix>/include/hello目录。

    利用上一节了解到的INSTALL指令,我们向lib/CMakeLists.txt中添加如下指令:

    INSTALL (TARGETS hello hello_static LIBRARY DESTINATION lib

    ARCHIVE DESTINATION lib)

    INSTALL (FILES hello.h DESTINATION include/hello)

    注意,静态库要使用ARCHIVE关键字

     

    通过:

    cmake -DCMAKE_INSTALL_PREFIX=/usr/loal ..

    make

    sudo make install

    我们就可以将头文件和共享库安装到系统目录/usr/local/lib和/usr/local/include/hello中了。

    如下图:

     

     

    前几个sections中,我们已经完成了libhello静、动态库的构建以及安装,本section中我们需要

    编写一个程序使用构建好的共享库。

     

    )在目录下建立目:#include "hello.h"

    int main(){

    HelloFunc();

    return 0;

    }

     

    编写工程主文件CMakeLists.txt

    PROJECT(NEWHELLO)

    ADD_SUBDIRECTORY(src)

     

    编写src/CMakeLists.txt

    ADD_EXECUTABLE(main main.cpp)

     

    )外部构建cmake ..

    make

     

    构建失败,如果需要查看细节,可以使用 make VERBOSE=1来构建。

    错误结果如下:

    1

     

    )引入头文件搜索路径。

    hello.h位于/usr/local/include/hello目录中,并没有位于,同志,要这么干,我这

    一节就没什么可写了,只能选择一个glib或者libX11来写了,这些代码写出来很多同志

    是看不懂的)

    为了让我们的工程能够找到hello.h头文件,我们需要引入一个新的指令

    INCLUDE_DIRECTORIES,其完整语法为:

    INCLUDE_DIRECTORIES([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

    这条指令可以用来向工程添加多个特定的头文件搜索路径,路径之间用现在我们在src/CMakeLists.txt中添加一个头文件搜索路径,方式很简单,加入:

    INCLUDE_DIRECTORIES(/usr/local/include/hello)

     

    进入build目录,重新进行构建,这时找不到hello.h的错误已经消失,但是出现了一个新的错误:

     

    2

    main.cpp:(.text+0x5): undefined reference to `HelloFunc()'

     

     

    因为我们并没有link到共享库libhello上。

     

    )target这个指令可以用来为target添加需要链接的共享库,本例中是一个可执行文件,但是同样可以用于为自己编写的共享库添加共享库链接。

     

    为了解决我们前面遇到的"HelloFunc()"未定义错误,我们需要作的是向

    src/CMakeLists.txt中添加如下指令:

    也可以写成

    进入build目录重新进行构建。

    cmake ..

    make

    这时我们就得到了一个连接到libhello的可执行程序main,位于build/src目录,

    运行main的结果是

    让我们来检查一下main的链接情况:

    $ ldd src/main

    虽然了这个结果,但是没有理解明白,到底链接什么库

     

    可以清楚的看到main确实链接了共享库libhello,而且链接的是动态库libhello.so.1

     

    $ ldd src/main

    虽然了这个结果,但是没有理解明白,到底链接什么库

     

    说明,main确实链接到了静态库libhello.a

     

    )特殊的环境变量:和务必注意CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH这两个是环境变量来进行,使用bash的方法如下:

    然后在头文件中将INCLUDE_DIRECTORIES(/usr/local/include/hello)替换为:

    FIND_PATH(myHeader hello.h)

    IF(myHeader)

    INCLUDE_DIRECTORIES(${myHeader})

    ENDIF(myHeader)

     

    上述的一些指令我们在后面会介绍。这里简单说明一下,FIND_PATH用来在指定路径中搜索文件名,比如:FIND_PATH (myHeader NAMES hello.h PATHS /usr/local/include /usr/local/include/hello)

    这里我们没有指定路径,但是,cmake仍然可以帮我们找到hello.h存放的路径,就是因

    为我们设置了环境变量CMAKE_INCLUDE_PATH。

    如果你不使用FIND_PATH,CMAKE_INCLUDE_PATH变量的设置是不会起作用的,你不能指

    望它会直接为编译器命令添加参数-I<CMAKE_INCLUDE_PATH>。

     

    同理,CMAKE_LIBRARY_PATH可以用在FIND_LIBRARY中。同样,因为这些变量直接为FIND_指令所使用,所以所有使用FIND_指令的cmake模块都会受益。

     

    到这里为止,您应该基本可以使用cmake工作了,但是还有很多高级的话题没有探讨,比

    如编译条件检查、编译器定义、平台判断、如何跟pkgconfig配合使用等等。

    到这里,或许你可以理解前面讲到的"cmake的使用过程其实就是学习cmake语言,并编写

    cmake程序的过程",既然是"cmake语言",自然涉及到变量、语法等. 下一节,我们将抛开程序的话题,看看常用的CMAKE变量以及一些基本的控制语法规则。

  • 相关阅读:
    rhel 7.0 配置centos yum源(2016/12/8),成功!
    rosetta2014/2015安装时出现INCLUDE(keyerror)错误,解决。
    显示python已安装模块及路径,添加修改模块搜索路径
    sort
    linux 查看磁盘剩余命令
    cat hesA/Models/score_tgt.sc| awk '{ print $2,$19}' | sort -n -k 1
    Python_sys模块
    Python_os模块
    Python_datetime模块
    Python_time模块
  • 原文地址:https://www.cnblogs.com/lidabo/p/13846872.html
Copyright © 2011-2022 走看看