Cmake入门

Cmake官方网址

https://cmake.org/

CMakeLists.txt

复制代码
 1 #CMakeLists.txt
 2 
 3 PROJECT(HELLO)
 4 
 5 SET(SRC_LIST main.cpp)
 6 
 7 MESSAGE(STATUS "This is BINARY dir" ${HELLO_BINARY_DIR})
 8 
 9 MESSAGE(STATUS "This is SOURCE dir" ${HELLO_SOURCE_DIR})
10 
11 ADD_EXECUTABLE(hello ${SRC_LIST})
复制代码

CMake关键字

PROJECT关键字

 可以用来指定工程的名字和支持的语言，默认支持所有语言

PROJECT(HELLO) 制定了工程的名字，并且支持所有语言-建议

PPRJECT(HELLO CXX) 指定了工程的名字，并且支持语言是C++

PROJECT(HELLO C CXX) 指定了工程的名字，并且支持语言是C和C++

该指定隐式定义了两个CMake的变量

<projectname>_BINARY_DIR，本例中是HELLO_BINARY_DIR

<projectname>_SOURCE_DIR，本例中是HELLO_SOURCE_DIR

MESSAGE关键字可以直接使用这两个变量，当前都指向当前的工作目录，后续会写外部编译

问题：如果改了工程名，这两个变量名也会改变

解决：又定义两个预定义变量：PROJECT_BINARY_DIR和PROJECT_SOURCE_DIR，这两个变量和HELLO_BINARY_DIR, HELLO_SOURCE_DIR是一致的

SET关键字

用来显式地指定变量的

SET(SRC_LIST main.cpp) SRC_LIST变量包含了main.cpp

也可以SET(SRC _LIST main.cpp t1.cpp t2.cpp)

MESSAGE关键字

向终端输出用户自定义的信息

主要包含三种信息：

  • SEND_ERROR，产生错误，生成过程被跳过。
  • SATUS，输出前缀为-的信息。
  • FATAL_ERROR，立即终止所有cmake过程。

ADD_EXECUTABLE关键字

生成可执行文件

ADD_EXECUTABLE(hello ${SRC_LIST})  生成的可执行文件是hello，源文件读取变量SRC_LIST中的内容

也可以直接写ADD_EXECUTABLE(hello main.cpp)

上述例子可以简化地写成

PROJECT(HELLO)

ADD_EXECUTABLE(hello main.cpp)

注意：工程名的HELLO和可执行文件hello是没有任何关系的

语法的基本原则

  • 变量使用${}方式取值，但是在IF控制语句中是直接使用变量名
  • 指令{参数1，参数2，...}参数使用括弧括起，参数之间使用空格或者分好分开。以上的ADD_EXECUTABLE指令为例，如果存在另外一个func.cpp源文件 就要写成：ADD_EXECUTABLE(hello main.cpp func.cpp)或者ADD_EXECUTABLE(hello main.cppp;func.cpp)
  • 指令是大小写无关的，参数和变量是大小写相关的。但是 推荐全部使用大写指令

语法注意事项

  • SET(SRC_LIST main.cpp)可以写成SET(SRC_LIST "main.cpp" )，如果源文件中含有空格，就必须要加双引号
  • ADD_EXECUTABLE(hello main)后缀可以不用，CMake会自动去找.c和.cpp，最好不要这么写，可能会有这两个文件 main.cpp和main

内部构建和外部构建

  • 上述例子就是内部构建，它生成的临时文件特别多，不方便清理
  • 外部构建，就会把生成的临时文件放在build目录下，不会对源文件有任何影响强烈使用外部构建方式

外部构件方式举例

 

  1. 建立一个build目录，可以在任何地方，建议在当前目录下
  2. 进入build，运行cmake。当然..表示上一级目录，你可以写CMakeLists.txt所在的绝对路径，生成的文件都在build目录下
  3. 在build目录下，运行make来构建工程

注意外部构建的两个变量

  1. HELLO_SOURCE_DIR 还是工作目录
  2. HELLO_BINARY_DIR 编译路径 也就是/root/cmake/build

 

 

让Hello World看起来更像一个工程

  • 为工程添加一个子目录src，用来存放工程原代码
  • 太耐一个子目录doc，用来存放这个工程的文档hello.txt
  • 在工程目录添加文本文件COPYRIGHT，RENAME
  • 在工程目录添加一个runhello.sh脚本，用来调用hello二进制
  • 将构建后的目标文件放入构建目录的bin子目录中
  • 将doc目录的内容以及COPYRIGHT/RENAME 安装到/usr/share/doc/cmake/

 

将目标文件放入构建目录的bin子目录

每个目录下都要有一个CMakeLists.txt说明

 

外层CMakeLists.txt



PROJECT(HELLO)




ADD_SUBDIRECTORY(src bin)




src下的CMakeLists.txt




ADD_EXECUTABLE(hello main.cpp)




ADD_SUBDIRECTORY指令


 ADD_SUBDIRECTORY(source_dir [binary_dir] [EXCLUDE_FROM_ALL])


    

  • 这个指令用于向当前工程添加存放源文件的子目录，并可以指定中间二进制和目标二进制存放的位置
    • 

  • EXCLUDE_FROM_ALL函数是将写的目录从编译中排除，如程序中的example
    • 

  • ADD_SUBDIRECTORY(src bin)

      

    • 　将src子目录加入工程中并制定编译输出（包含编译中间结果）路径为bin目录
      • 

    •     如果不进行bin目录的指定，那么编译结果（包含中间结果）都将存放在build/src目录
      • 

    

    • 



更改二进制的保存地址


SET指令从新定义了EXECUTABLE_OUTPUT_PATH和LIBRARY_OUTPUT_PATH变量，来指定最终的目标二进制的位置


SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)


SET(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)


思考：加载哪个CMakeLists.txt当中


哪里要改变目标存放路径，就在哪个加入上述的约定，所以应在src下的CMakeLists.txt下写


 


安装


    

  • 一种是从代码编译后直接make install安装
    • 

  • 一种是打包时的指定，目录安装

      

    • 简单的可以指定目录 make install DESTDIR=/tmp/test
      • 

    • 稍微复杂一点可以这样指定目录：./configure -prefix=/usr
      • 

    

    • 



如何安装HelloWorld


使用CMAKE 一个新指令：INSTALL


　　INSTALL的安装可以包括：二进制、动态库、静态库以及文件、目录、脚本等。


使用CMAKE的一个新的变量：CMAKE_INSTALL_PREFIX




 


安装文件COPYRIGHT和README


INSTALL(FILES COPYRIGHT README DESTINATION share/doc/cmake/)


FILES:文件


DESTINATION:


    

  1. 写绝对路径
    2. 

  2. 可以写相对路径，相对路径实际路径是：${CMAKE_INSTALL_PREFIX}/<DESTINATION定义的路径> CMAKE_INSTALL_PREFIX 默认在/usr/local/。 cmake-DCMAKE_INSTALL_PREFIX=/usr 在cmake的时候指定CMAKE_INSTALL_PREFIX变量的路径
    3. 



安装脚本runhello.sh


PROGRAMS:非目标文件的可执行程序安装(比如脚本之类)


INSTALL(PROGRAMS runhello.sh DESTINATION bin)


说明：实际安装的是/usr/bin


安装doc中的hello.txt


    

  • 一是是通过直接在doc目录建立CMakeLists.txt，通过install下的file
    • 

  • 二是直接在工程目录通过 INSTALL(DIRECTORY doc/ DESTINATION share/doc/cmake)
    • 



DIRECTORY后面连接的是所在Source目录的相对路径


注意：abc和abc/有很大的区别


　　目录名不以/结尾：这个目录将被安装位目标路径下的abc


　　目录名以/结尾：将这个目录中的内容安装到目标路径


安装过程


cmake


make


make install




 


静态库和动态库的构建


 任务：


    

  1. 建立一个静态库和动态库。提供HelloFunc函数供其他程序变成使用，HelloFunc向终端输出Hello World字符串。
    2. 

  2. 安装头文件与共享库。
    3. 



 


静态库与动态库的区别


    

  • 静态库的可扩展名一般以“.a”或“.lib”;动态库的扩展名一般为“.so”或“.dll”。
    • 

  • 静态库在编译时会直接整合到目标程序中，编译成功的可执行文件可独立运行。
    • 

  • 动态库在编译时不会放到连接的目标程序中，即可执行文件无法单独运行。
    • 



 


hello.h


hello.cpp


项目中CMakeLists.txt内容


lib中CMakeLists.txt内容




SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})




 


ADD_LIBRARY


ADD_LIBRARY(hello SHARED ${LIBRARY_SRC})


    

  • hello:就是正常的库名，生成的名字前面会加上lib，最终产生的文件时libhello.so
    • 

  • SHARED:动态库 STATIC:静态库
    • 

  • ${LIBRARY_SRC}:源文件
    • 





 


同时构建静态和动态库




//如果使用这种方式，只会构建一个动态库，不会构建出静态库，虽然静态库的后缀是.a
SET_LIBRARY(hello SHARED ${LIBHELLO_SRC})
SET_LIBRARY(hello STATIC ${LIBHELLO_SRC})

//修改静态库的名字，这样是可以的，但是我们往往希望它们的名字是相同的，只是后缀不同而已
SET_LIBRARY(hello SHARED ${LIBHELLO_SRC})
SET_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})




 


 


SET_TARGET_PROPERTIES


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


 


同时构建静态库和动态库


复制代码


SET(LIBHELLO_SRC hello.cpp)

ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

//对hello_static的重命名为hello
SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME "hello")

//cmake 在构建一个新的target时，会尝试清楚其他使用这个名字的库，因为，在构建 libhello.so时，就会清理掉libhello.a
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

SET_TARGET_PROPERTIES(hello PROPERTIES OUTPUTNAME "hello")
SET_TAARGET_PROPETIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)


复制代码


动态库的版本号


一般动态库都有一个版本号的关联




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




CMakeLists.txt插入如下




SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)
//VERSION指代动态库版本号 SOVERSION指代API版本号




 


安装共享库和头文件


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


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




?
1
2
3
4
5
6
//文件安装到该目录下
INSTALL(FILES hello.h DESTINATION include/hello)
 
//二进制，静态库，动态库安装都用TARGETS
//ARCHIVE 特指静态库，LIBRARY特指动态库，RUNTIME特指可执行目标二进制
INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)




　


注意：


安装的时候，指定一下路径，放到系统下




cmake -D CMAKE_INSTALL_PREFIX=/usr ..




 




 


使用外部共享库和头文件




 


main.cpp




#include <hello.h>

void main(){
    HelloFunc();
} 




 


解决：make后头文件找不到的问题


PS:include<hello/hello.h> 这样include是可以，这么做的话，就没什么可讲的了


关键字：INCLUDE_DIRECTORIES 这条指令可以用来向工程添加多个特定的头文件搜索路径，路径之间用空格分割


在CMakeLists.txt中添加头文件搜索路径




INCLUDE_DIRECTORIES(/usr/include/hello)




 


解决：找到引用的函数问题


报错信息：undefined reference to "HelloFunc()"


关键字：LINK_DIRECTORIES 添加非标准的共享库搜索路径


关键字：TARGET_LINK_LIBRARIES 添加需要连接的共享库


在CMakeLists.txt中插入连接共享库，主要要插在executable后面




TARGET_LINK_LIBRARIES(hello libhello.so)






 






            

            
posted @ 
 
王广元 
阅读(63) 
评论(0) 
编辑 
收藏 
举报


        

	    
	    
    









    
    

    
    



    

        
    

        

            
                
                
            
        

    



    相关博文：

    

            

                · 
                Docker入门
            

            

                · 
                【Spring】学习笔记04-Spring配置说明
            

            

                · 
                Cmake入门
            

            

                · 
                CMake简单学习
            

            

                · 
                CMake学习，我们怎么从零开始狂写大型项目
            

    





    

    阅读排行：
    

 ·          分享一个免费、快速、无限量使用的满血 DeepSeek R1 模型，支持深度思考和联网搜索！
        

 ·          使用C#创建一个MCP客户端
        

 ·          基于 Docker 搭建 FRP 内网穿透开源项目（很简单哒）
        

 ·          ollama系列1：轻松3步本地部署deepseek，普通电脑可用
        

 ·          按钮权限的设计及实现
        



    

    



	

	

	
	

	

	

	





    

         
        
        



 
分享到： 









 
 
 
 


 





    


    
    








  

  
点击右上角即可分享

  微信分享提示

   
    
AI IDE Trae