将SCons设置为自动链接

Question

我正在使用google的cpplint.py来验证我的项目中的源代码是否符合Google C++ Style Guide中规定的标准.我们使用SCons进行构建,所以我想通过让SCons首先读取所有.h和.cc文件然后在它们上运行cpplint.py来自动化该过程,只有在它通过时才构建文件.问题如下:

1. 在SCons中,我如何预先挂钩构建过程？在通过linting之前,不应编译任何文件.
2. cpplint不返回退出代码.如何在SCons中运行命令并检查结果是否与正则表达式匹配？IE,如何输出文本？
3. 项目很大,无论#1和#2的解决方案如何,当-j选项传递给SCons时,它应该同时运行.
4. 我需要一个白名单,允许一些文件跳过lint检查.

Answer 1

实现此目的的一种方法是对对象发射器函数进行猴子修补，该函数将 C++ 代码转换为可链接的对象文件。有 2 个这样的发射器函数；一种用于静态对象，一种用于共享对象。以下是您可以将其复制粘贴到 SConstruct 中的示例：

import sys
import SCons.Defaults
import SCons.Builder
OriginalShared = SCons.Defaults.SharedObjectEmitter
OriginalStatic = SCons.Defaults.StaticObjectEmitter

def DoLint(env, source):
    for s in source:
        env.Lint(s.srcnode().path + ".lint", s)

def SharedObjectEmitter(target, source, env):
    DoLint(env, source)
    return OriginalShared(target, source, env)

def StaticObjectEmitter(target, source, env):
    DoLint(env, source)
    return OriginalStatic(target, source, env)

SCons.Defaults.SharedObjectEmitter = SharedObjectEmitter
SCons.Defaults.StaticObjectEmitter = StaticObjectEmitter
linter = SCons.Builder.Builder(
    action=['$PYTHON $LINT $LINT_OPTIONS $SOURCE','date > $TARGET'],
    suffix='.lint',
    src_suffix='.cpp')

# actual build
env = Environment()
env.Append(BUILDERS={'Lint': linter})
env["PYTHON"] = sys.executable
env["LINT"] = "cpplint.py"
env["LINT_OPTIONS"] = ["--filter=-whitespace,+whitespace/tab", "--verbose=3"]
env.Program("test", Glob("*.cpp"))

确实没有什么太棘手的。您可以将 LINT 设置为 cpplint.py 副本的路径，并为您的项目设置适当的 LINT_OPTIONS。唯一的问题是如果使用命令行date程序检查通过，则创建目标文件。如果你想跨平台，那么就必须改变。

添加白名单现在只是常规的 Python 代码，如下所示：

whitelist = """"
src/legacy_code.cpp
src/by_the_PHB.cpp
"""".split()

def DoLint(env, source):
    for s in source:
        src = s.srcnode().path
        if src not in whitelist:
            env.Lint( + ".lint", s)

看来 cpplint.py 确实输出了正确的错误状态。当出现错误时，它返回 1，否则返回 0。因此不需要做任何额外的工作。如果 lint 检查失败，构建就会失败。

此解决方案适用于 -j，但 C++ 文件可能会编译，因为 lint fake 输出和目标文件目标之间没有隐式依赖关系。您可以在其中添加显式内容env.Depends以强制“.lint”输出取决于对象目标。这可能就足够了，因为即使在所有 C++ 编译之后，如果仍然存在任何剩余的 lint 问题，构建本身也会失败（scons 给出非零返回代码）。为了完整起见，DoLint 函数中的依赖代码将如下所示：

def DoLint(env, source, target):
    for i in range(len(source)):
        s = source[i]
        out = env.Lint(s.srcnode().path + ".lint", s)
        env.Depends(target[i], out)