非常详细的cmake用例，收藏

CMake资料2 - Ogre3D开放资源地带

CMake资料2
出自Ogre3D开放资源地带
跳转到: 导航, 搜索

http://bbs.osgchina.org/redirect.php?tid=1229&goto=lastpost

1.5 VersionMe工程设计

下面我们将着手设计一个稍微复杂一些的工程，名为VersionMe。它同样包括一个动态链接库工程和一个依赖于它的可执行工程，并且计划实现以下一些功能：


可以查询当前操作系统的版本；

可以查询系统中安装的OpenSceneGraph库的版本；

可以执行上一次我们创建的HelloWorld工程的方法；


为了使我们的工程更具备开源工程的特征，我们模仿OpenSceneGraph的文件夹结构，设计如下：

Image:cmake1.jpg


名为VersionLib的链接库工程的头文件和源代码文件将分别保存到include和src两个目录下；而名为test的可执行工程则单独保存在同名目录下；此外，CMakeModules目录专职负责保存相关的CMake脚本数据。

这个工程的重点毫无疑问是VersionLib链接库，它的工作是提供显示系统版本和OSG版本的函数，以及调用之前的Hello::sayHello方法，再次在控制台界面上显示“Hello CMake!”这一行简单而友好的欢迎文字。

VersionLib库包括一个头文件Version和一个源代码文件Version.cpp，其代码如下：

/* Version */
#ifndef H_VERSION
#define H_VERSION
#if defined(_MSC_VER) || defined(__CYGWIN__) || defined(__MINGW32__)
# ifdef VERSIONME_LIBRARY
# define VERSIONME_EXPORT __declspec(dllexport)
# else
# define VERSIONME_EXPORT __declspec(dllimport)
# endif
#else
# define VERSIONME_EXPORT
#endif
class VERSIONME_EXPORT Version
{
public:
void printHello();
const char* systemVersion();
const char* osgVersion();
};
#endif

/* Version.cpp */
#ifdef _MSC_VER
# include
#else
# include
#endif
#include
#include
#include
#include

static char g_version[255] = "";
void Version::printHello()
{
Hello hello;
hello.sayHello();
}
const char* Version::systemVersion()
{
std::stringstream stream;
#ifdef _MSC_VER
OSVERSIONINFO osvi;
ZeroMemory( &osvi, sizeof(OSVERSIONINFO) );
osvi.dwOSVersionInfoSize = sizeof( OSVERSIONINFO );
GetVersionEx( &osvi );
stream << "Windows-";
stream << osvi.dwMajorVersion << "." << osvi.dwMinorVersion << "."
<< osvi.dwBuildNumber;
#else
struct utsname buff;
uname( &buff );
stream << buff.sysname << "-" << buff.release;
#endif
stream >> g_version;
return g_version;
}
const char* Version::osgVersion()
{
return osgGetVersion();
}

具体的实现过程我们不作介绍，这里的osgGetVersion()是OSG的版本查询函数，而GetVersionEx()和uname则分别是Windows和Linux下的版本查询API函数。嗯，是否觉得这里Windows API的实现更加费劲呢？（^_^）

此外，这里我们引用头文件Hello并调用了其中的函数，因此在之后的CMake脚本设计过程中，要考虑正确搜索和指定Hello头文件依赖目录以及依赖库的路径位置。

而Test工程的源代码就很简单了，只有一个test.cpp文件，内容如下：


/* test.cpp */
#include
#include
int main( int argc, char** argv )
{
Version obj;
std::cout << "Operating System Version: " << obj.systemVersion() << std::endl;
std::cout << "OpenSceneGraph Version: " << obj.osgVersion() << std::endl;
obj.printHello();
return 0;
}

我们希望在CMake-GUI窗口中有一个用户选项，用来决定是否编译这个Test工程。另外，我们还希望能够使用类似“make install”这样的命令来安装所有工程相关的动态库，静态库，头文件和可执行文件。（之前的HelloWorld工程是无法这样做的）

以上就是VersionMe工程设计的所有要求。下面，我们将开始CMake脚本的设计。

位于VersionMe根目录下的CMakeLists.txt脚本如下：

PROJECT( VersionMe )
CMAKE_MINIMUM_REQUIRED( VERSION 2.4.7 )
IF( COMMAND CMAKE_POLICY )
CMAKE_POLICY( SET CMP0003 NEW )
ENDIF( COMMAND CMAKE_POLICY )

SET( CMAKE_MODULE_PATH
"${PROJECT_SOURCE_DIR}/CMakeModules/;${CMAKE_MODULE_PATH}" )
SET( CMAKE_DEBUG_POSTFIX "d"
CACHE STRING "add a postfix, usually d on windows" )
OPTION( BUILD_TEST "Set to ON to build the test application." ON )
IF( WIN32 )
IF( MSVC )
ADD_DEFINITIONS( -D_SCL_SECURE_NO_WARNINGS )
ADD_DEFINITIONS( -D_CRT_SECURE_NO_DEPRECATE )
ENDIF( MSVC )
ENDIF( WIN32 )

FIND_PACKAGE( Hello )
FIND_PACKAGE( osg )
INCLUDE( CustomModules )
INCLUDE_DIRECTORIES( include )
ADD_SUBDIRECTORY( src/VersionLib )
IF( BUILD_TEST )
ADD_SUBDIRECTORY( test )
ENDIF( BUILD_TEST )

这一次的代码编写恐怕比之前丰富了不少，有点眼晕吗？没关系，我们结合上一节的CMake命令和内置变量介绍，一点一点地分析。

首先设置工程名称和所需的CMake版本，此处还使用了一个CMAKE_POLICY命令来设置版本的兼容性，以避免一些不必要的警告信息。

之后，我们指定基本的CMake配置参数，包括模块搜索目录，Debug版本生成目标的后缀，一个用户选项BUILD_TEST，以及针对Visual Studio的一些宏定义设置。（通过判断WIN32和MSVC内置变量来执行这一动作）

后面的工作比较重要一些，首先是使用FIND_PACKAGE来搜索外部依赖库的路径。CMake中预置了很多模块搜索的脚本，可以用来检索各种知名工程的文件和路径信息，并以CMake变量的方式返回。例如，FIND_PACKAGE(OpenGL)将自动调用CMake安装目录share/cmake-2.6/Modules文件夹中的FindOpenGL.cmake脚本的内容，自动搜索或者由用户指定OpenGL头文件和链接库的位置，并主要返回以下变量：

* OPENGL_FOUND：是否找到OpenGL库的标识；
* OPENGL_GLU_FOUND：是否找到GLU库的标识；
* OPENGL_INCLUDE_DIR：头文件gl.h所在的文件夹路径；
* OPENGL_gl_LIBRARY：链接库opengl32的绝对路径；
* OPENGL_glu_LIBRARY：链接库glu32的绝对路径；

这个时候可以用下面的形式为名为ProjName的工程指定依赖库OpenGL的头文件和链接库文件，脚本代码如下：

INCLUDE_DIRECTORIES( ${OPENGL_INCLUDE_DIR} )
TARGET_LINK_LIBRARIES( ProjName
${OPENGL_gl_LIBRARY}
${OPENGL_glu_LIBRARY}
)

注意Windows环境下不存在OPENGL_INCLUDE_DIR，因为没有必要做特别指定。

回到我们的VersionMe工程来，这里我们试图搜索两个外部依赖库的信息：Hello代表我们之前生成的HelloWorld工程，而OSG表示外部的OpenSceneGraph工程。后者的搜索模块在CMake的较新版本中已经包含，包括Findosg，FindosgUtil，FindosgViewer等多个cmake文件，可以使用FIND_PACKAGE直接调用并返回相应的头文件和链接库路径变量。（通常名为OSG_INCLUDE_DIR，OSG_LIBRARY等）

但是Hello这个库却不可能有相应的模块文件，毕竟CMake可不知道我们之前做了什么。因此我们需要手动编写名为FindHello.cmake的脚本，并将其保存在CMakeModules目录下。具体的脚本编写方法我们稍后再说。

在使用FIND_PACKAGE搜索到外部Hello库和OSG库的具体位置之后，（也可能找不到，此时需要在CMake-GUI中手动进行设置），下一步还要使用INCLUDE命令包含一个自定模块CustomModules.cmake。它的工作是定义了几个方便VersionMe工程设置的宏函数，以免我们在后面的子工程创建过程中编写过多的代码；OSG中有一个类似功能的模块文件OsgMacroUtils.cmake，有兴趣的朋友不妨提前阅读一下。

笔者在CustomModules中手动编写了三个实用的宏函数：INCLUDE_FOR_PROJECT，LINK_PROJECT以及INSTALL_PROJECT。它们不仅将在VersionMe的设计中大显身手，也许更可以为您自己的工程脚本编写提供一些助力。

在INCLUDE命令之后，注意我们还使用了一次INCLUDE_DIRECTORIES命令。这是什么意思呢？再次考虑VersionMe的文件夹结构，和之前的HelloWorld工程不同，这一次所有的头文件不再与源代码文件放在同一目录下，而是放置在单独的include文件夹，以便于更有效的文件管理。但是，对于编译器而言，这样会使它无法正确搜索到#include引用的头文件位置。因此我们必须提前设置好相应的头文件依赖路径，并且这一设置对于所有的子工程都是统一的。

仅对于上例而言，下面两种指定头文件路径的方式是等价的：

INCLUDE_DIRECTORIES( include )
INCLUDE_DIRECTORIES( “${PROJECT_SOURCE_DIR}/include” )

这之后的脚本代码就轻松一点了，ADD_SUBDIRECTORY命令指定了下一级子工程CMake脚本的位置，此外我们还通过判断用户是否选择了BUILD_TEST选项，来决定是否编译test工程。（即是否进入test工程所在的脚本目录）

我们快速浏览一下VersionLib子工程和test子工程的脚本代码：

SET( LIB_NAME VersionLib )
SET( HEADER_PATH ${PROJECT_SOURCE_DIR}/include/${LIB_NAME} )
SET( ${LIB_NAME}_HEADERS
${HEADER_PATH}/Version
)
SET( ${LIB_NAME}_SOURCES
Version.cpp
)
ADD_DEFINITIONS( -DVERSIONME_LIBRARY )
ADD_LIBRARY( ${LIB_NAME} SHARED
${${LIB_NAME}_HEADERS}
${${LIB_NAME}_SOURCES}
)
SET_TARGET_PROPERTIES( ${LIB_NAME}
PROPERTIES DEBUG_POSTFIX
"${CMAKE_DEBUG_POSTFIX}"
)

INCLUDE_FOR_PROJECT( ${LIB_NAME} HELLO OSG )
LINK_PROJECT( ${LIB_NAME} HELLO OSG )
INSTALL_PROJECT( ${LIB_NAME} )

虽然看上去复杂了一些，但其实源文件设置和工程属性设置的脚本代码并没有太多深奥的地方。无非是大量使用CMake变量而已，如果您熟悉其它程序语言设计的话，相信很快会对此习以为常，并能够适当地在自己的工程中加以借鉴。当使用ADD_LIBRARY新增了一个动态链接库工程之后，我们还额外地使用SET_TARGET_PROPERTIES设置了工程Debug版本的生成目标后缀——它有什么作用呢？还记得您编译OSG的时候，会生成osgd，osgDBd，osgViewerd等一系列有别于Release版本文件的链接库吧，这里就是同样的道理，这个命令将为VersionLib库的Debug版本文件新增一个用于区分的后缀，使之成为VersionLibd.dll的形式，要知道编译器自己可不会这样做。

之后我们依次调用三个自定义的宏函数，也就是前文说过的INCLUDE_FOR_PROJECT，LINK_PROJECT和INSTALL_PROJECT。它们的工作依次是：指定工程所用的头文件依赖目录（Hello库和OSG库的头文件目录）；工程所需的外部链接库文件绝对路径（HelloLib.lib和osg.lib）；以及指定安装这个工程的相关生成文件到预设的目录中。

这些宏函数的具体实现过程稍后详述。

子工程test的脚本代码为：

SET( EXAMPLE_NAME Test )
SET( EXAMPLE_FILES
test.cpp
)
ADD_EXECUTABLE( ${EXAMPLE_NAME} test.cpp )
SET_TARGET_PROPERTIES( ${EXAMPLE_NAME}
PROPERTIES DEBUG_POSTFIX
"${CMAKE_DEBUG_POSTFIX}" )
LINK_PROJECT( ${EXAMPLE_NAME} VersionLib )
INSTALL_PROJECT( ${EXAMPLE_NAME} )

注意我们没有必要为Test工程设置头文件依赖目录了，从test.cpp的源代码可以看出，它只需要引用VersionLib/Version这个头文件，（以及一个可以由编译器自动找到的STL头文件iostream）而这个文件的路径位于：${PROJECT_SOURCE_DIR}/include，毫无疑问，它在前文中已经由INCLUDE_DIRECTORIES设置完毕了。

Test子工程依赖于即将生成的VersionLib库，不必担心它们的编译顺序上会有什么偏差，CMake会为我们安排好一切。