CMake 使用方法 & CMakeList.txt

本文介绍了CMake作为跨平台的安装(编译)工具的基本概念和使用方法,包括配置、生成Makefile或project文件以及执行编译过程。通过示例展示了如何编写CMakeLists.txt文件以实现特定项目的构建。

cmake 简介


    CMake是一个跨平台的安装(编译)工具,可以用简单的语句来描述所有平台的安装(编译过程)。他能够输出各种各样的makefile或者project文件,能测试编译器所支持的C++特性,类似UNIX下的automake。

CMake 使用方法

    CMake的所有的语句都写在一个叫:CMakeLists.txt的文件中。当CMakeLists.txt文件确定后,可以用ccmake命令对相关 的变量值进行配置。这个命令必须指向CMakeLists.txt所在的目录。配置完成之后,应用cmake命令生成相应的makefile(在Unix like系统下)或者 project文件(指定用window下的相应编程工具编译时)。

    其基本操作流程为:

$> ccmake directory
$> cmake directory
$> make

其中directory为CMakeList.txt所在目录;
  • 第一条语句用于配置编译选项,如VTK_DIR目录 ,一般这一步不需要配置,直接执行第二条语句即可,但当出现错误时,这里就需要认为配置了,这一步才真正派上用场;
  • 第二条命令用于根据CMakeLists.txt生成Makefile文件;
  • 第三条命令用于执行Makefile文件,编译程序,生成可执行文件;

CMake的执行就是这么简单,其难点在于如何编写CMakeLists.txt文件,下面结合例子简单介绍CMakeLists.txt的编写,看下面这个CMakeLists.txt

#project name
PROJECT(test_math)
#head file path
INCLUDE_DIRECTORIES(
include
)
#source directory
AUX_SOURCE_DIRECTORY(src DIR_SRCS)
#set environment variable
SET(TEST_MATH
${DIR_SRCS}
)
#set extern libraries
SET(LIBRARIES
libm.so
)
#add executable file
ADD_EXECUTABLE(../bin/bin ${TEST_MATH})
#add link library
TARGET_LINK_LIBRARIES(../bin/bin ${LIBRARIES})
 

或者用下面这个CMakeLists.txt
#project name
PROJECT(test_math)
#head file path
INCLUDE_DIRECTORIES(
include
)
#source directory
AUX_SOURCE_DIRECTORY(src DIR_SRCS)
#set environment variable
SET(TEST_MATH
${DIR_SRCS}
)
#add executable file
ADD_EXECUTABLE(../bin/bin ${TEST_MATH})
#add link library
TARGET_LINK_LIBRARIES(../bin/bin m)

这是一个测试数学函数的程序的CMakeLists.txt,"#"后面为注释的内容,CMake的命令全部为大写

第2行指定生成的工程名为test_math

第4行指定头文件目录为include

第8行指定源文件目录为src,并将其赋值给环境变量DIR_SRCS

第10行设定环境变量TEST_MATH的值为环境变量DIR_SRCS的值,此处用于显示如何用环境变量对环境变量进行赋值

第14行将数学函数库赋值给环境变量LIBRARIES,当然,可以不用这个环境变量,而在后面直接使用该库名

第18行用于指定生成文件,将环境变量TEST_MATH目录下的所有文件编译生成../bin目录下的可执行文件bin

第20行指定../bin/bin执行时的链接库为环境变量LIBRARIES的值-libm.so

下面给出源文件
/src/main.c:

#include<stdio.h>
#include"../include/a.h"
int main()
{
    double b=25.0;
    double a=0.0;
    a=get_sqrt(b);
 
    printf("a is %lf, b is %lf\n",a,b);
    return 0;
}


 

/src/a.c

#include"../include/a.h"
double get_sqrt(double var1)
{
    return sqrt(var1);
}


 

/include/a.h

#ifndef  A_FILE_HEADER_INC
#define  A_FILE_HEADER_INC
#include<math.h>
 
double get_sqrt(double var1);
 
#endif 


 

将CMakeLists.txt放在当前目录下,执行CMakeLists.txt

$> cmake .
$> make


 

即可生成可执行文件,在目录/bin下的bin文件,好了运行看其效果是否和所想一样。

CMakeList.txt文件第35行使用`add_library`出现错误,可能有多种原因,以下是一些常见的错误情况及对应的解决办法: ### 1. 库名称或源文件路径错误 - **错误原因**:`add_library`命令的第一个参数是库的名称,后续参数是源文件列表。如果库名称包含非法字符,或者源文件路径错误,就会导致错误。 - **解决办法**:检查库名称是否符合命名规范,确保源文件路径正确。例如: ```cmake # 错误示例 add_library(my_lib src/wrong_path/file.cpp) # 正确示例 add_library(my_lib src/correct_path/file.cpp) ``` ### 2. 源文件不存在 - **错误原因**:指定的源文件在文件系统中并不存在,CMake无法找到这些文件进行编译。 - **解决办法**:确认源文件是否存在于指定的路径下。可以使用`file`命令来检查文件是否存在: ```cmake set(LIB_SOURCE_FILES src/file1.cpp src/file2.cpp) foreach(file ${LIB_SOURCE_FILES}) if(NOT EXISTS ${file}) message(FATAL_ERROR &quot;Source file ${file} does not exist!&quot;) endif() endforeach() add_library(my_lib ${LIB_SOURCE_FILES}) ``` ### 3. 重复定义库 - **错误原因**:在CMakeList.txt中多次使用相同的库名称调用`add_library`,会导致重复定义错误。 - **解决办法**:确保每个库只定义一次。可以使用`if`语句来检查库是否已经定义: ```cmake if(NOT TARGET my_lib) add_library(my_lib src/file.cpp) endif() ``` ### 4. 依赖项缺失 - **错误原因**:如果源文件依赖于其他库或头文件,而这些依赖项没有正确配置,会导致编译错误。 - **解决办法**:使用`find_package`或`include_directories`等命令来配置依赖项。例如: ```cmake find_package(SomeLibrary REQUIRED) include_directories(${SomeLibrary_INCLUDE_DIRS}) add_library(my_lib src/file.cpp) target_link_libraries(my_lib ${SomeLibrary_LIBRARIES}) ``` ### 5. CMake版本不兼容 - **错误原因**:`add_library`的某些特性可能在较旧的CMake版本中不支持,如果使用了这些特性,会导致错误。 - **解决办法**:确保CMake版本符合要求。可以在CMakeList.txt文件开头设置最低CMake版本: ```cmake cmake_minimum_required(VERSION 3.10) ``` ### 6. 语法错误 - **错误原因**:`add_library`命令的语法使用错误,例如参数数量不正确或参数顺序错误。 - **解决办法**:参考CMake官方文档,确保`add_library`命令的语法正确。例如: ```cmake # 错误示例 add_library(my_lib src/file.cpp extra_parameter) # 正确示例 add_library(my_lib src/file.cpp) ```
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值