project(CMakeTest)

set(SRC_LIST main.cpp)

message(STATUS "This is BINARY dir " ${HELLO_BINARY_DIR})

message(STATUS "This is SOURCE dir " ${HELLO_SOURCE_DIR})

add_executable(hello ${SRC_LIST})

project(CMakeTest)  		# 支持所有语言

project(CMakeTest CXX)		# 支持 c++

project(CMakeTest C CXX)	# 支持 c++ 和 c

set(SRC_LIST main.cpp m1.cpp m2.cpp)

add_executable(hello main.cpp m1.cpp m2.cpp)

file(WRITE filename "message to write"... ) # 将消息写入 filename

file(APPEND filename "message to write"... ) # 将消息追加写入 filename

file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX]) # 从 filename 读取消息到 variable

file(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> filename variable) # 计算 filename 的加密哈希到 variable

file(STRINGS filename variable [LIMIT_COUNT num] # 将解析 filename 中的 ASCII 字符串列表并将其存储在 variable 中。二进制数据 和 回车会被忽略

     [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]

     [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]

     [NEWLINE_CONSUME] [REGEX regex]

     [NO_HEX_CONVERSION])

file(GLOB variable [RELATIVE path] [globbing expressions]...) # 生成 variable 用来存储 RELATIVE path 下所有满足 globbing expressions 的文件

file(GLOB_RECURSE variable [RELATIVE path] # 和 GLOB 类似，但不仅仅匹配文件，还匹配目录

     [FOLLOW_SYMLINKS] [globbing expressions]...)

file(RENAME <oldname> <newname>) # 移动文件或目录，操作是原子性的

file(REMOVE [file1 ...]) # 删除文件，包括子目录

file(REMOVE_RECURSE [file1 ...]) # 删除目录或文件，包括子目录

file(MAKE_DIRECTORY [directory1 directory2 ...]) # 创建目录，支持不存在父目录的创建

file(RELATIVE_PATH variable directory file) # 获取 directory 和 file 的相对路径关系并保存在 variable。

file(TO_CMAKE_PATH path result) # 将路径转为 unix 的 cmake 样式

file(TO_NATIVE_PATH path result) # 将路径转为 windows 的 cmake 样式

file(DOWNLOAD url file [INACTIVITY_TIMEOUT timeout] # 将 url 内容下载到 file

     [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS]

     [EXPECTED_HASH ALGO=value] [EXPECTED_MD5 sum]

     [TLS_VERIFY on|off] [TLS_CAINFO file])

file(UPLOAD filename url [INACTIVITY_TIMEOUT timeout] # 将 filename 内容上传到 url

     [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS])

file(TIMESTAMP filename variable [<format string>] [UTC]) # 获取 filename 修改的时间字符串到 variable

file(GENERATE OUTPUT output_file # 将 input_file | input_content 内容写入 output_file

     <INPUT input_file|CONTENT input_content>

     [CONDITION expression])

file(GLOB_RECURSE my_src *.cpp *.h) # 获取当前路径下的所有 .cpp 和 .h

add_executable(my_executable ${my_src}) # 编译出可执行文件

macro(<name> [arg1 [arg2 [arg3 ...]]])

	# dosomthing ...

endmacro(<name>)

include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]

                      [NO_POLICY_SCOPE])

# xxx.cmake

macro(myfunc msg)

	message(STATUS ${msg})

endmacro(myfunc msg)

# CMakeLists.txt

include(xxx.cmake)

myfunc("this is msg")

if(expression)

	# dosomthing ...

elseif (expression)

	# dosomthing ...

endif()

foreach(loop_var arg1 arg2 ...) # foreach(var IN list_xxx) | foreach(var RANGE start stop [step])

	# dosomthing ...

endforeach()

configure_file(<input> <output>

               [COPYONLY] [ESCAPE_QUOTES] [@ONLY]

               [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])

# example

configure_file(file1 /src/file1)

math(EXPR <output variable> <math expression>)

# example

math(EXPR var "8 * 8")

string(REGEX MATCH <regular_expression>		# 正则匹配字符串，返回首个匹配项

       <output variable> <input> [<input>...])

string(REGEX MATCHALL <regular_expression>	# 正则匹配字符串，尽可能多的匹配

       <output variable> <input> [<input>...])

string(REGEX REPLACE <regular_expression>	# 正则匹配字符串，尽可能多的匹配，匹配成功后进行替换

       <replace_expression> <output variable>

       <input> [<input>...])

string(REPLACE <match_string>			  # 非正则模式下尽可能多的字符串匹配和替换

       <replace_string> <output variable>

       <input> [<input>...])

string(CONCAT <output variable> [<input>...]) # 字符串拼接类似 "".join

string(<MD5|SHA1|SHA224|SHA256|SHA384|SHA512> # 计算字符串的加密哈希

       <output variable> <input>)

# 字符串比较

string(COMPARE EQUAL <string1> <string2> <output variable>)

string(COMPARE NOTEQUAL <string1> <string2> <output variable>)

string(COMPARE LESS <string1> <string2> <output variable>)

string(COMPARE GREATER <string1> <string2> <output variable>)

string(ASCII <number> [<number> ...] <output variable>) # 将字符串中的数字转为 ASCII 编码

 # 字符串转换

string(CONFIGURE <string1> <output variable>

       [@ONLY] [ESCAPE_QUOTES])

string(TOUPPER <string1> <output variable>)

string(TOLOWER <string1> <output variable>)

string(LENGTH <string> <output variable>) # 获取长度

string(SUBSTRING <string> <begin> <length> <output variable>) # 字符串切片

string(STRIP <string> <output variable>) # 字符去空格和 tab

string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>] # 生成固定长度随机字符串

       [RANDOM_SEED <seed>] <output variable>)

string(FIND <string> <substring> <output variable> [REVERSE]) # 查找给定字串的下标

string(TIMESTAMP <output variable> [<format string>] [UTC]) # 输出当前时间字符串

string(MAKE_C_IDENTIFIER <input string> <output variable>) # will write a string which can be used as an identifier in C.

option(<option_variable> "help string describing option"

       [initial value])

# example

option(NEED_CHECK_CONFIG "是否需要检查配置" ON)

if (NEED_CHECK_CONFIG)

	# dosomething ...

endif ()

add_definitions(-DFOO -DBAR ...)

# example

add_definitions("-DNEED_CHECK_CONFIG") # NEED_CHECK_CONFIG  on -> off

list(LENGTH <list> <output variable>)

list(GET <list> <element index> [<element index> ...]

     <output variable>)

list(APPEND <list> [<element> ...])

list(FIND <list> <value> <output variable>)

list(INSERT <list> <element_index> <element> [<element> ...])

list(REMOVE_ITEM <list> <value> [<value> ...])

list(REMOVE_AT <list> <index> [<index> ...])

list(REMOVE_DUPLICATES <list>)

list(REVERSE <list>)

list(SORT <list>)

install(<FILES|PROGRAMS> files... DESTINATION <dir>

        [PERMISSIONS permissions...]

        [CONFIGURATIONS [Debug|Release|...]]

        [COMPONENT <component>]

        [RENAME <name>] [OPTIONAL])

# example FILES

# 把 README COPYRIGHT 两个文件安装到 ${CMAKE_INSTALL_PREFIX}/doc 下

install(FILES README COPYRIGHT DESTINATION /doc)

# example PROGRAMS

# 把 build.sh 安装到 ${CMAKE_INSTALL_PREFIX}/shell 下

install(PROGRAMS build.sh DESTINATION /shell)

install(DIRECTORY dirs... DESTINATION <dir>

        [FILE_PERMISSIONS permissions...]

        [DIRECTORY_PERMISSIONS permissions...]

        [USE_SOURCE_PERMISSIONS] [OPTIONAL]

        [CONFIGURATIONS [Debug|Release|...]]

        [COMPONENT <component>] [FILES_MATCHING]

        [[PATTERN <pattern> | REGEX <regex>]

         [EXCLUDE] [PERMISSIONS permissions...]] [...])

# example DIRECTORY

# 把 doc 目录下的内容安装到 ${CMAKE_INSTALL_PREFIX}/doc 下

install(DIRECTORY doc/ DESTINATION /doc)

install(TARGETS targets... [EXPORT <export-name>]

        [RUNTIME_DEPENDENCIES args...|RUNTIME_DEPENDENCY_SET <set-name>]

        [[ARCHIVE|LIBRARY|RUNTIME|OBJECTS|FRAMEWORK|BUNDLE|

          PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE|FILE_SET <set-name>]

         [DESTINATION <dir>]

         [PERMISSIONS permissions...]

         [CONFIGURATIONS [Debug|Release|...]]

         [COMPONENT <component>]

         [NAMELINK_COMPONENT <component>]

         [OPTIONAL] [EXCLUDE_FROM_ALL]

         [NAMELINK_ONLY|NAMELINK_SKIP]

        ] [...]

        [INCLUDES DESTINATION [<dir> ...]]

        )

# example TARGETS

# 把 arenasvr 按照 RUNTIME 模式安装到 ${CMAKE_INSTALL_PREFIX}/as/bin 下

install(TARGETS arenasvr RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/as/bin)

add_library(<name> [STATIC | SHARED | MODULE]

            [EXCLUDE_FROM_ALL]

            source1 [source2 ...])

# example

add_library(lib_func STATIC lib_func.cpp)

# 构建时会得到 lib${name}.xx 的库文件，例如这里对 lib_func 的构建结果为 liblib_func.a

add_library(lib_func STATIC lib.cpp)

add_executable(hello main.cpp)

project(ROOT)

add_subdirectory(lib bin/lib)

add_subdirectory(src bin/src)

add_subdirectory(source_dir [binary_dir]

                 [EXCLUDE_FROM_ALL])

# example 编译 src 下面的 CMakeLists.txt 并把结果输出到 ${PROJECT_SOURCE_DIR}/bin/src 下

add_subdirectory(src bin/src)

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

# example

include_directories(${CMAKE_SOURCE_DIR}/lib)

add_executable(hello main.cpp)

target_link_libraries(<target> [item1 [item2 [...]]]

                      [[debug|optimized|general] <item>] ...)

# example 记得 target_link_libraries 需要放在 add_executable 后面

include_directories(${CMAKE_SOURCE_DIR}/lib)

set(LIB_FUNC_PATH ${CMAKE_SOURCE_DIR}/debugbuild/bin/lib) #/data/rwbyguo/cmake_test/debugbuild/bin/lib

add_executable(hello main.cpp)

target_link_libraries(hello ${LIB_FUNC_PATH}/liblib_func.a)

link_directories(directory1 directory2 ...)

# example

include_directories(${CMAKE_SOURCE_DIR}/lib)

set(LIB_FUNC_PATH ${CMAKE_SOURCE_DIR}/debugbuild/bin/lib) #/data/rwbyguo/cmake_test/debugbuild/bin/lib

link_directories(${LIB_FUNC_PATH})

add_executable(hello main.cpp)

target_link_libraries(hello liblib_func.a)

link_libraries(library1 <debug | optimized> library2 ...)

# example

include_directories(${CMAKE_SOURCE_DIR}/lib)

set(LIB_FUNC_PATH ${CMAKE_SOURCE_DIR}/debugbuild/bin/lib) #/data/rwbyguo/cmake_test/debugbuild/bin/lib

link_libraries(${LIB_FUNC_PATH}/liblib_func.a)

add_executable(hello main.cpp)

find_package(<package> [version] [EXACT] [QUIET]

             [REQUIRED] [[COMPONENTS] [components...]]

             [CONFIG|NO_MODULE]

             [NO_POLICY_SCOPE]

             [NAMES name1 [name2 ...]]

             [CONFIGS config1 [config2 ...]]

             [HINTS path1 [path2 ... ]]

             [PATHS path1 [path2 ... ]]

             [PATH_SUFFIXES suffix1 [suffix2 ...]]

             [NO_DEFAULT_PATH]

             [NO_CMAKE_ENVIRONMENT_PATH]

             [NO_CMAKE_PATH]

             [NO_SYSTEM_ENVIRONMENT_PATH]

             [NO_CMAKE_PACKAGE_REGISTRY]

             [NO_CMAKE_BUILDS_PATH]

             [NO_CMAKE_SYSTEM_PATH]

             [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]

             [CMAKE_FIND_ROOT_PATH_BOTH |

              ONLY_CMAKE_FIND_ROOT_PATH |

              NO_CMAKE_FIND_ROOT_PATH])

# example 官方提供了 protobuf 的配置 https://cmake.org/cmake/help/latest/module/FindProtobuf.html

#protobuf

set(PROTOBUF_DIR ${CMAKE_SOURCE_DIR}/external/protobuf)

set(PROTOBUF_INCLUDE_DIR ${PROTOBUF_DIR}/include)

set(PROTOBUF_LIBRARY_DIR ${PROTOBUF_DIR}/lib)

set(PROTOBUF_PROTOC_EXECUTABLE ${PROTOBUF_DIR}/bin/protoc)

if(MSVC)

    set(PROTOBUF_PROTOC_EXECUTABLE ${PROTOBUF_DIR}/bin/protoc.exe)

endif(MSVC)

set(PROTOBUF_LIBRARY ${PROTOBUF_LIBRARY_DIR}/libprotobuf.a)

set(PROTOBUF_LIBRARY_DEBUG ${PROTOBUF_LIBRARY_DIR}/libprotobuf.a)

set(PROTOBUF_IMPORT_DIRS)

find_package(Protobuf REQUIRED)