首页 > 代码库 > 使用CMake构建项目的简明示例
使用CMake构建项目的简明示例
1.需求
[1].使用第三方动/静太库
[2].本身代码部分编译为动/静态库
[3]多项目管理
2.构建一个单独的项目
[1]目的:这个项目将生成可执行文件,动态和静态库。
先在workspace(or anywhere you like)下建立项目的目录(文件)结构:
workspace
|—— HelloWorld
|—— CMakeLists.txt
|—— include Hello.h
|—— src Hello.cpp, test.cpp, CMakeLists.txt
|—— build (CMake外部构建时的使用的目录, 可任意指定)
[2]HelloWorld根目录下的CMakeLists.txt
- # 声明CMake的最低要求版本
- cmake_minimum_required(VERSION 2.8)
- # 定义项目(工程)名称,
- # 同时定义了以下默认变量:
- # PROJECT_SOURCE_DIR 或 HELLO_SOURCE_DIR, 代指CMake开始构建的根目录(通常是项目根目录)
- # PROJECT_BINARY_DIR 或 HELLO_BINARY_DIR, 代指CMake的编译目录(即执行cmake命令的目录)
- PROJECT(HELLO)
- # 添加参与编译的子目录
- ADD_SUBDIRECTORY(src)
[3]Hello.h
- #ifndef HELLO_H
- #define HELLO_H
- class Hello
- {
- public:
- Hello(){}
- void sayHello();
- };
- #endif
[4]Hello.cpp
- #include <iostream>
- #include "Hello.h"
- void Hello::sayHello()
- {
- std::cout << "Hello CMake!" << std::endl;
- }
- #include "Hello.h"
- int main(int arg, char** argv)
- {
- Hello h;
- h.sayHello();
- }
- # 添加头文件的查找目录
- INCLUDE_DIRECTORIES(${PROJECT_SOURCE_DIR}/include)
- ## 生成各种目标(target)文件: 可执行文件、动态库、静态库
- # 指定可执行文件的输出目录,输出到bin下面
- SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
- # 指定可执行文件名(hello)和相关源文件
- ADD_EXECUTABLE(hello test.cpp Hello.cpp)
- # 指定库文件输出路径
- SET(LIBRARY_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/lib)
- # 生成动态库
- # 注意,前面已经使用target文件名hello,这里不能再用。
- ADD_LIBRARY(hello_so SHARED Hello.cpp)
- # 设置库输出名为 hello => libhello.so
- SET_TARGET_PROPERTIES(hello_so PROPERTIES OUTPUT_NAME "hello")
- # 生成静态库
- # 注意,前面已经使用target文件名hello,这里不能再用。
- ADD_LIBRARY(hello_a STATIC Hello.cpp)
- # 设置输库出名为 hello => libhello.a
- SET_TARGET_PROPERTIES(hello_a PROPERTIES OUTPUT_NAME "hello")
最后,进入build目录执行命令: cmake <项目根目录>
如果执行cmake命令的目录与项目根目录相同,称为内部编译,这时CMake生成的中间文件会与项目代码混合,不推荐。
否则,称为外部编译,所有中间文件会生成在执行cmake命令的目录下。
cmake执行完后,会生成Makefile, 直接make, 会在项目下生成bin和lib目录及目标文件。
view plain- cmake ..
- make
通常我们不需要生成所有类型的目标文件,构建时根据需要选择。
3. 构建多个项目,使用外部项目提供的库文件。
在前面的HelloWorld项目中,生成了lib文件,就可以通过头文件和lib文件发布给其他项目了。
我们创建一个Test项目来使用HelloWorld的生成的库,如下:
workspace
|—— HelloWorld
|—— Test
|—— CMakeLists.txt
|—— src main.cpp CMakeLists.txt
|—— build
(1)Test目录下的CMakeLists.txt
view plain- cmake_minimum_required(VERSION 2.8)
- PROJECT(TEST)
- ADD_SUBDIRECTORY(src)
2) main.cpp
view plain- #include "Hello.h"
- int main(int arg, char** argv)
- {
- Hello h;
- h.sayHello();
- }
(3) src下的CMakeLists.txt
view plain- # 显示系统的HOME环境变量的值
- MESSAGE(STATUS $ENV{HOME})
- # 指定头文件查找目录
- # 注意,这里指定绝对路径。
- INCLUDE_DIRECTORIES($ENV{HOME}/workspace/HelloWorld/include)
- # 指定库文件查找目录(不能只指定头文件,也需要连接到库文件)
- # 注意,这里指定绝对路径, 也可通过设置系统环境变量LD_LIBRARY_PATH来指定。
- LINK_DIRECTORIES($ENV{HOME}/workspace/HelloWorld/lib)
- # 生成可执行文件到项目的bin目录
- SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
- ADD_EXECUTABLE(main main.cpp)
- # 制定链接的外部Lib
- TARGET_LINK_LIBRARIES(main libhello.a)
最后,进入build目录执行:
view plain- cmake ..
- make
到bin目录下测试可执行文件:
view plain- $ ./main
- $ Hello CMake!
3. 在多个项目的情况下,使用自定义的Find<ProjName>.cmake模块
在workspace下增加两个目录(项目),CMakeModules和TestFindModule如下:
workspace
|—— HelloWorld
|—— Test
|—— CMakeModules FindHELLO.cmake (存放各子项目的Find<Proj>.cmake 定义)
|—— TestFindModule ( 功能同Test子项目,不过使用Find<>.cmake模块来查找、链接HelloWorld项目的头文件和库)
|—— CMakeLists.txt
|—— src main.cpp, CMakeLists.txt
|—— build
(1)CMakeModules目录下的FindHELLO.cmake
MESSAGE(STATUS $ENV{HOME}/workspace/HelloWorld)
FIND_PATH(HELLO_INCLUDE_DIR Hello.h $ENV{HOME}/workspace/HelloWorld/include)
#FIND_LIBRARY(HELLO_LIBRARY NAMES hello PATHS $ENV{HOME}/workspace/HelloWorld/lib)
FIND_LIBRARY(HELLO_LIBRARY hello $ENV{HOME}/workspace/HelloWorld/lib)
IF (HELLO_INCLUDE_DIR)
MESSAGE(STATUS "FOUND HELLO.H ${HELLO_INCLUDE_DIR}")
ENDIF (HELLO_INCLUDE_DIR)
IF (HELLO_LIBRARY)
MESSAGE(STATUS "FOUND HELLO LIB ${HELLO_LIBRARY}")
ENDIF (HELLO_LIBRARY)
IF (HELLO_INCLUDE_DIR AND HELLO_LIBRARY)
SET(HELLO_FOUND TRUE)
ENDIF (HELLO_INCLUDE_DIR AND HELLO_LIBRARY)
IF (HELLO_FOUND)
IF (NOT HELLO_FIND_QUIETLY)
MESSAGE(STATUS "Found Hello: ${HELO_LIBRARY}")
ENDIF (NOT HELLO_FIND_QUIETLY)
ELSE (HELLO_FOUND)
IF (HELLO_FIND_REQUIRED)
MESSAGE(FATAL_ERROR "Could not find hello library")
ENDIF (HELLO_FIND_REQUIRED)
ENDIF (HELLO_FOUND)(2)TestFindModule目录下的CMakeLists.txt
cmake_minimum_required(VERSION 2.8)
PROJECT(TEST)
# CMAKE_MODULE_PATH定义必须放到前面
SET(CMAKE_MODULE_PATH $ENV{HOME}/workspace/CMakeModules)
#MESSAGE(STATUS $ENV{HOME}/workspace/CMakeModules)
ADD_SUBDIRECTORY(src)(2) TestFindModule目录src下的main.cpp
#include <Hello.h>
int main(int arg, char** argv)
{
Hello h;
h.sayHello();
}(3) TestFindModule目录src下的CMakeLists.txt
# FIND_PACKAGE(<name>) 用来调用预定义在 CMAKE_MODULE_PATH 下的 Find<name>.cmake 模块
FIND_PACKAGE(HELLO)
IF (HELLO_FOUND)
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR}/bin)
ADD_EXECUTABLE(hello main.cpp)
INCLUDE_DIRECTORIES(${HELLO_INCLUDE_DIR})
TARGET_LINK_LIBRARIES(hello ${HELLO_LIBRARY})
ENDIF (HELLO_FOUND)最后,进入build目录执行:
cmake ..
make
到bin目录下测试可执行文件:
$ ./main
$ Hello CMake!
使用CMake构建项目的简明示例