Visual Studio 2015 - 使用 git branch 和 git commit 定义预处理器变量

Question

我在 Visual Studio 2015 上使用 C++ 并使用 Git 作为源代码控制。 我正在编写一个多平台应用程序，并希望我的应用程序包含 git 分支并提交它。

在 Visual Studio 以外的平台上，我在 Makefile 中添加了以下几行：

GIT_CUR_COMMIT := $(shell git rev-parse --verify HEAD)
GIT_CUR_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
DEPS += -DGIT_COMMIT=\"$(GIT_CUR_COMMIT)\" -DGIT_BRANCH=\"$(GIT_CUR_BRANCH)\"

然后在我的应用程序中，我有代码来读取这些预处理器变量并以编程方式公开它们：

std::string getGitCommit()
{
    #ifdef GIT_COMMIT
    return GIT_COMMIT;
    #endif
    return "unavailable";
}

std::string getGitBranch()
{
    #ifdef GIT_BRANCH
    return GIT_BRANCH;
    #endif
    return "unavailable";   
}

但在 Visual Studio 中没有 Makefile。如何在编译时定义这两个变量 GIT_CUR_COMMIT 和 GIT_CUR_BRANCH 并实现相同的行为？

Answer 1

可能 - 您可以在 VS 中以完全相同的方式执行此操作 - 但我觉得以下过程会更容易实现

在项目属性中选择“Build Events”/“Pre-Build Event”

在命令行中添加以下命令

echo | set /p dummyName=#define GIT_CUR_COMMIT >  gitparams.h
git rev-parse --verify HEAD >>  gitparams.h

echo | set /p dummyName=#define GIT_BRANCH >>  gitparams.h
git rev-parse --abbrev-ref HEAD >>  gitparams.h

这应该在你每次编译你的项目时生成以下头文件（gitparams.h）

#define GIT_CUR_COMMIT 8a6b3f147fababda57ddd39262df5aa83bc853c4
#define GIT_BRANCH master

确保将其添加到 .gitignore

在你的代码中你可以使用

#include "gitparams.h"

#define ADD_QUOTES_HELPER(s) #s
#define ADD_QUOTES(s) ADD_QUOTES_HELPER(s)

std::string getGitCommit()
{
#ifdef GIT_CURR_COMMIT
    return ADD_QUOTES(GIT_CURR_COMMIT);
#endif
    return "unavailable";
}