cpplint.cmake 2.0 KB
Newer Older
Z
zhangjinchao01 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
# util to check C++ file style
# * it basically use google cpplint.py.
# * It provide "add_style_check_target" for cmake.
#   Usage see add_style_check_target's document
#
# TODO(yuyang18): Add python style check.

set(STYLE_FILTER)

# diable unwanted filters

# paddle do not indent public/potected/private in class
set(STYLE_FILTER "${STYLE_FILTER}-whitespace/indent,")
# paddle use mutable reference. BUT IT IS NOT RECOMMANDED
set(STYLE_FILTER "${STYLE_FILTER}-runtime/references,")
# paddle use relative path for include.
set(STYLE_FILTER "${STYLE_FILTER}-build/include,")
# paddle use <thread>, <mutex>, etc.
set(STYLE_FILTER "${STYLE_FILTER}-build/c++11,")
# paddle use c style casting. BUT IT IS NOT RECOMMANDED
set(STYLE_FILTER "${STYLE_FILTER}-readability/casting")


# IGNORE SOME FILES
set(IGNORE_PATTERN
    .*ImportanceSampler.*
    .*cblas\\.h.*
D
dongzhihong 已提交
28
    .*\\.pb\\.txt
Z
zhangjinchao01 已提交
29
    .*LtrDataProvider.*
L
liaogang 已提交
30 31
    .*MultiDataProvider.*
    .*pb.*)
Z
zhangjinchao01 已提交
32 33 34 35 36 37 38

# add_style_check_target
#
# attach check code style step for target.
#
# first argument: target name to attach
# rest arguments: source list to check code style.
X
xuwei06 已提交
39
#
Z
zhangjinchao01 已提交
40 41 42 43 44 45 46 47
# NOTE: If WITH_STYLE_CHECK is OFF, then this macro just do nothing.
macro(add_style_check_target TARGET_NAME)
    if(WITH_STYLE_CHECK)
        set(SOURCES_LIST ${ARGN})
        list(REMOVE_DUPLICATES SOURCES_LIST)
        foreach(filename ${SOURCES_LIST})
            foreach(pattern ${IGNORE_PATTERN})
                if(filename MATCHES ${pattern})
L
liaogang 已提交
48
                    list(REMOVE_ITEM SOURCES_LIST ${filename})
X
xuwei06 已提交
49
                endif()
Z
zhangjinchao01 已提交
50 51
            endforeach()
        endforeach()
L
liaogang 已提交
52 53 54

        if(SOURCES_LIST)
            add_custom_command(TARGET ${TARGET_NAME} POST_BUILD
55
                COMMAND "${PYTHON_EXECUTABLE}" "${PADDLE_SOURCE_DIR}/paddle/scripts/cpplint.py"
L
liaogang 已提交
56 57 58 59 60
                        "--filter=${STYLE_FILTER}"
                        ${SOURCES_LIST}
                COMMENT "cpplint: Checking source code style"
                WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})        
        endif()
Z
zhangjinchao01 已提交
61 62
    endif()
endmacro()