CMakeLists 문법 with catkin_make

참고 : 

https://runebook.dev/ko/docs/cmake/command/execute_process

CMake - execute_process 하나 이상의 자식 프로세스를 실행하십시오.

 

https://cmake.org/cmake/help/latest/command/find_package.html

find_package — CMake 3.25.1 Documentation

 

https://enssionaut.com/board_robotics/1264

로봇 - ROS(Robot Operating System) 개념과 활용 - 10. CMakeLists.txt 파헤치기

 

https://www.tuwlab.com/ece/27260

[CMake 튜토리얼] 2. CMakeLists.txt 주요 명령과 변수 정리 - ECE - TUWLAB

---

http://wiki.ros.org/ko/ROS/Tutorials/BuildingPackages

ko/ROS/Tutorials/BuildingPackages - ROS Wiki

http://wiki.ros.org/catkin/commands/catkin_make

catkin/commands/catkin_make - ROS Wiki

 

catkin_make <- cmake 랑 make를 합쳐서 특정 빌드를 하는 구조.

• $ cd ~/catkin_ws
  $ catkin_make

위의 내용을 풀어서 쓰면 [ install 은 실행바이너리와 라이브러리등 실행파일, devel은 install 파일들 + 코드파일까지 ]

• $ cd ~/catkin_ws
  $ cd src
  $ catkin_init_workspace
  $ cd ..
  $ mkdir build
  $ cd build
  $ cmake ../src -DCMAKE_INSTALL_PREFIX=../install -DCATKIN_DEVEL_PREFIX=../devel
  $ make

 

또한 install folder를 만들어 배포용으로 작업 할 수 도 있다. ( src에 작성한 코드가 없으면 의미 없음 )

• $ cd ~/catkin_ws
  $ catkin_make install

위의 경우는 아래와 동일하다. 

• $ cd ~/catkin_ws/build
  # If cmake hasn't already been called
  $ cmake ../src -DCMAKE_INSTALL_PREFIX=../install -DCATKIN_DEVEL_PREFIX=../devel
  $ make
  $ make install

 

---

키워드

 

cmake_minimum_required

  -  CMake 최소 버전

 

project

  -  패키지 이름

 

set

  - Variable 선언 , 1:1 대응이나 밑에 예시처럼 해도 된다.

unset

  - Variable 취소

 

execute_process

  - COMMAND 명령을 실행 : 실행 후 실행에 관련 alias를 이용할 수 있다 위의 예시 처럼 

 

message

  - 메시지 출력

 

find_pacakge

  - 빌드에 필요한 CMake, catkin 관련 패키지 탐색

 

add_message_files(), add_service_files(), add_action_files() 

- ROS 메시지, 서비스, 액션 생성기

 

generate_messages()

  - 메시지, 서비스, 액션 생성

 

catkin_package()

  - catkin 관련 빌드 정보 지정

 

add_library(), add_executable(), target_link_libraries()

  - 라이브러리, 실행 파일 지정

catkin_add_gtest()

  - 유닛 테스트

install()

  - 생성된 target에 대한 설치 옵션 지정

 

if 문

if(NOT _res EQUAL 0 AND NOT _res EQUAL 2)

endif()

 

for 문 

  foreach(path ${CMAKE_PREFIX_PATH})

  endforeach()

 

---

설명 및 예시

 

cmake_minimum_required

cmake_minimum_required(VERSION 3.0.2)

  -  CMake 최소 버전

 

project

project(Project)

  -  패키지 이름

 

set

set(CATKIN_TOPLEVEL TRUE)

set(_cmd "catkin_find_pkg" "catkin" "${CMAKE_SOURCE_DIR}")

  - Variable 선언 , 1:1 대응이나 밑에 예시처럼 해도 된다.

unset

  - Variable 취소

 

execute_process

execute_process(COMMAND ${_cmd}
  RESULT_VARIABLE _res
  OUTPUT_VARIABLE _out
  ERROR_VARIABLE _err
  OUTPUT_STRIP_TRAILING_WHITESPACE
  ERROR_STRIP_TRAILING_WHITESPACE
)

  - COMMAND 명령을 실행 : 실행 후 실행에 관련 alias를 이용할 수 있다 위의 예시 처럼 

 

message

message(FATAL_ERROR "Search for 'catkin' in workspace failed (${_cmd_str}): ${_err}")

  - 메시지 출력

 

find_pacakge

find_package(catkin REQUIRED COMPONENTS
  roscpp
  rospy
  std_msgs
)

 위 내용을 바꿔서 보자면 밑에 내용이랑 동일함.

find_package(catkin REQUIRED)
find_package(roscpp REQUIRED)
find_package(rospy REQUIRED)

find_package(std_msgs REQUIRED)

또 예를들어 이런식으로 쓰면 C++ Boost의 threads를 사용하고자 할 경우 : find_package(Boost REQUIRED COMPONENTS thread)

  - 빌드에 필요한 CMake, catkin 관련 패키지 탐색

 

add_message_files(), add_service_files(), add_action_files()

## Generate messages in the 'msg' folder
# add_message_files(
#   FILES
#   Message1.msg
#   Message2.msg
# )
## Generate services in the 'srv' folder
# add_service_files(
#   FILES
#   Service1.srv
#   Service2.srv
# )
## Generate actions in the 'action' folder
# add_action_files(
#   FILES
#   Action1.action
#   Action2.action
# )
  - ROS 메시지, 서비스, 액션 생성기

 

generate_messages()

## Generate added messages and services with any dependencies listed here
# generate_messages(
#   DEPENDENCIES
#   std_msgs
# )

  - 메시지, 서비스, 액션 생성

 

catkin_package()

catkin_package(
#  INCLUDE_DIRS include
#  LIBRARIES test_3
#  CATKIN_DEPENDS roscpp rospy std_msgs
#  DEPENDS system_lib
)

  - catkin 관련 빌드 정보 지정

 

add_library(), add_executable(), target_link_libraries()

  - 라이브러리, 실행 파일 지정

catkin_add_gtest()

  - 유닛 테스트

install()

  - 생성된 target에 대한 설치 옵션 지정

 

if 문

if(NOT _res EQUAL 0 AND NOT _res EQUAL 2)
  # searching fot catkin resulted in an error
  string(REPLACE ";" " " _cmd_str "${_cmd}")
  message(FATAL_ERROR "Search for 'catkin' in workspace failed (${_cmd_str}): ${_err}")
endif()

 

for 문 

  foreach(path ${CMAKE_PREFIX_PATH})
    if(EXISTS "${path}/.catkin")
      list(FIND catkin_search_path ${path} _index)
      if(_index EQUAL -1)
        list(APPEND catkin_search_path ${path})
      endif()
    endif()
  endforeach()