cmake函数參数解析

近期在迁移公司的make系统到cmake上。发现cmake的function參数非常奇怪。比如，假设我们向一个function传递list作为參数，在function中，形參会变成例如以下状况：

set(SRC)

list(APPEND SRC a.cpp b.cpp)

list(APPEND SRC c.cpp d.cpp)

function(tst_arguments src_list)

	message("src_list = "${src_list})

endfunction()

message("SRC = "${SRC})

tst_arguments(${SRC})

==== output ====

SRC = a.cppb.cppc.cppd.cpp

src_list = a.cpp

非常奇怪的是，这里的${SRC}在function外是完整的4个元素。而在function却仅仅剩下了头一个元素（可能跟list的定长有关）。

假设我们要传给function以n个源文件组成的list，这样显然不行。

一种简单的解决方法是使用ARGV。ARGC配合，他们的含义如同C/C++中main的argv和argc。分别代表參数和參数个数。使用例如以下方法解析參数：

function(tst_arguments src_list)

	message("ARGC = "${ARGC})

	message("ARGV = "${ARGV})

        set(INDEX 0)

	while(INDEX LESS ${ARGC})

		message("ARG = "${ARGV${INDEX}})

		math(EXPR INDEX "${INDEX} + 1")

	endwhile()

endfunction()

tst_arguments(${SRC})

==== output ====

ARGC = 4

ARGV = a.cppb.cppc.cppd.cpp

ARG = a.cpp

ARG = b.cpp

ARG = c.cpp

ARG = d.cpp

当然，你也能够使用cmake的foreach循环遍历參数。这招对付仅仅有一个list的參数时十分有效。可是在出现多个參数的情况就非常麻烦。例如以下：

#

#如果函数link_lib将src_list中的源文件链接成库，依据type制定是链接静态库还是动态库

#

function(link_lib src_list type)

        message("ARGC = "${ARGC})

	message("ARGV = "${ARGV})

        #下面依据參数的实际情做了操作，手动处理。以保证正确获取src_list和type

        set(INDEX 0)

        math(EXPR MAX "${ARGC} - 1")

        while(INDEX LESS ${MAX})

             #do something to link

             math(EXPR INDEX "${INDEX} + 1")

        endwhile()

endfunction()

link_lib(${SRC} , so)

==== output ====

ARGC = 5

ARGV = a.cppb.cppc.cppd.cppso

原来，ARG把两个參数混在了一起，尽管后面我们使用while进行了特殊处理，可是这对于cmake的函数不具备普遍性。移植起来非常麻烦。

决定版的solution是使用cmake的cmake_parse_arguments来解析函数參数，它有点像解析一个map键值对。首先看下它的函数原型：

include (CMakeParseArguments)  #必须包括这个cmake文件才干使用<span class="highlighted">cmake_parse_arguments</span>

CMAKE_PARSE_ARGUMENTS(<prefix> <options> <one_value_keywords> <multi_value_keywords> args...)

首先，prefix是一个前缀。等会儿在引用參数的时候会提到，<option>是一个列表。里面能够包括一些你感兴趣的KeyWord，随后能够通过它来看看你所须要的KeyWord是否被设置。<one_value_keywords>是一个单值參数的KeyWord列表。<multi_value_keywords>是一个多值參数的KeyWord列表（如list），以下举个样例，看看怎样使用它们，首先定义所须要的函数，因为參数是由CMAKE_PARSE_ARGUMENTS来解析的，所以在函数声明中就不须要定义參数了：

function(tst_arguments)

  CMAKE_PARSE_ARGUMENTS(

    TEST "" "NAME;COMMAND;BASELINE"

       "ARGSLIST"

       ${ARGN}

  )

  message("TEST_DEFAULT_ARGS is ${TEST_DEFAULT_ARGS} from ${ARGN}")

  message("TEST_NAME is ${TEST_NAME}")

  message("TEST_COMMAND is ${TEST_COMMAND}")

  message("TEST_ARGSLIST is ${TEST_ARGSLIST}")

  message("TEST_BASELINE is ${TEST_BASELINE}")

endfunction(tst_arguments)

这里的前缀是TEST，<one_value_keywords>我们设置单值參数的KeyWord（NAME;COMMAND;BASELINE）。这将在随后的函数调用中注明KeyWord和Value的关系，<multi_value_keywords>我们设置多值參数的KeyWord（"ARGSLIST"），调用函数：

TEST_ARGUMENT(

    NAME

      testiso

    COMMAND

      "RunMe"

    ARGSLIST

      ${SRC}

    BASELINE

      "/home/sakaue/iWork"

)

==== output ====

TEST_DEFAULT_ARGS is  from NAME;testiso;COMMAND;RunMe;ARGSLIST;a.cpp;b.cpp;c.cpp;d.cpp;BASELINE;/home/sakaue/iWork

TEST_NAME is testiso

TEST_COMMAND is RunMe

TEST_ARGSLIST is a.cpp;b.cpp;c.cpp;d.cpp

TEST_BASELINE is /home/sakaue/iWork

能够看见，这里调用时的參数传递如同map一样<NAME ,testiso_${datafile} >,<COMMAND , "RunMe">,<ARGSLIST , ${SRC}>等等。在函数中。使用前缀+KeyWord 来调用Value，这样比自己解析參数方便很多，并且也不会在还有list參数时和其它类型函数混在一起的情况。

很多其它讯息參考：http://www.cmake.org/cmake/help/v3.0/module/CMakeParseArguments.html?highlight=cmake_parse_arguments

秒客网

cmake函数參数解析

相关文章