LUFA/Build/lufa.cppcheck.in

   1 #
   2 #             LUFA Library
   3 #     Copyright (C) Dean Camera, 2012.
   4 #
   5 #  dean [at] fourwalledcubicle [dot] com
   6 #           www.lufa-lib.org
   7 #
   8
   9 LUFA_BUILD_MODULES        += CPPCHECK
  10 LUFA_BUILD_TARGETS        += cppcheck cppcheck-config
  11 LUFA_BUILD_MANDATORY_VARS +=
  12 LUFA_BUILD_OPTIONAL_VARS  += CPPCHECK_PATH CPPCHECK_INCLUDES CPPCHECK_EXCLUDES CPPCHECK_MSG_TEMPLATE \
  13                              CPPCHECK_ENABLE CPPCHECK_SUPPRESS CPPCHECK_FAIL_ON_WARNING CPPCHECK_QUIET \
  14                              CPPCHECK_FLAGS
  15
  16 # -----------------------------------------------------------------------------
  17 #                LUFA CPPCheck Buildsystem Makefile Module.
  18 # -----------------------------------------------------------------------------
  19 # DESCRIPTION:
  20 #   Provides a set of targets to scan a project with the free "cppcheck" static
  21 #   analysis tool, to check for code errors at runtime (see http://cppcheck.sourceforge.net).
  22 # -----------------------------------------------------------------------------
  23 # TARGETS:
  24 #
  25 #    cppcheck                  - Scan the project with CPPCheck
  26 #    cppcheck-config           - Use CPPCheck to look for missing include files
  27 #
  28 # MANDATORY PARAMETERS:
  29 #
  30 #    (None)
  31 #
  32 # OPTIONAL PARAMETERS:
  33 #
  34 #    CPPCHECK_PATH             - Path of the files to statically analyze
  35 #    CPPCHECK_INCLUDES         - Extra include paths to search for missing
  36 #                                header files
  37 #    CPPCHECK_EXCLUDES         - Source file paths to exclude checking (can be
  38 #                                a path fragment if desired)
  39 #    CPPCHECK_MSG_TEMPLATE     - Template for cppcheck error and warning output
  40 #    CPPCHECK_ENABLE           - General cppcheck category checks to enable
  41 #    CPPCHECK_SUPPRESS         - Specific cppcheck warnings to disable by ID
  42 #    CPPCHECK_FAIL_ON_WARNING  - Set to Y to fail the build on cppcheck
  43 #                                warnings, N to continue even if warnings occur
  44 #    CPPCHECK_QUIET            - Enable cppcheck verbose or quiet output mode
  45 #    CPPCHECK_FLAGS            - Additional flags to pass to cppcheck
  46 #
  47 # -----------------------------------------------------------------------------
  48
  49 ERROR_IF_UNSET   = $(if $(filter undefined, $(origin $(strip $(1)))), $(error Makefile $(strip $(1)) value not set))
  50 ERROR_IF_EMPTY   = $(if $(strip $($(strip $(1)))), , $(error Makefile $(strip $(1)) option cannot be blank))
  51 ERROR_IF_NONBOOL = $(if $(filter Y N, $($(strip $(1)))), , $(error Makefile $(strip $(1)) option must be Y or N))
  52
  53 # Default values of optionally user-supplied variables
  54 CPPCHECK_PATH                ?= .
  55 CPPCHECK_INCLUDES            ?=
  56 CPPCHECK_EXCLUDES            ?=
  57 CPPCHECK_MSG_TEMPLATE        ?= {file}:{line}: {severity} ({id}): {message}
  58 CPPCHECK_ENABLE              ?= all
  59 CPPCHECK_SUPPRESS            ?= variableScope missingInclude
  60 CPPCHECK_FAIL_ON_WARNING     ?= Y
  61 CPPCHECK_QUIET               ?= Y
  62 CPPCHECK_FLAGS               ?=
  63
  64 # Sanity check user supplied values
  65 $(foreach MANDATORY_VAR, $(LUFA_BUILD_MANDATORY_VARS), $(call ERROR_IF_UNSET, $(MANDATORY_VAR)))
  66 $(call ERROR_IF_EMPTY, CPPCHECK_PATH)
  67 $(call ERROR_IF_EMPTY, CPPCHECK_MSG_TEMPLATE)
  68 $(call ERROR_IF_EMPTY, CPPCHECK_ENABLE)
  69 $(call ERROR_IF_NONBOOL, CPPCHECK_FAIL_ON_WARNING)
  70 $(call ERROR_IF_NONBOOL, CPPCHECK_QUIET)
  71
  72 # Build a default argument list for cppcheck
  73 BASE_CPPCHECK_FLAGS := --template="$(CPPCHECK_MSG_TEMPLATE)" $(CPPCHECK_INCLUDES:%=-I%) $(CPPCHECK_EXCLUDES:%=-i%) --inline-suppr --force --std=c99
  74
  75 # Sanity check parameters and construct additional command line arguments to cppcheck
  76 ifeq ($(CPPCHECK_FAIL_ON_WARNING), Y)
  77    BASE_CPPCHECK_FLAGS += --error-exitcode=1
  78 endif
  79 ifeq ($(CPPCHECK_QUIET), Y)
  80    BASE_CPPCHECK_FLAGS += --quiet
  81 endif
  82
  83 # Output Messages
  84 MSG_CPPCHECK_CMD         := ' [CPPCHECK]:'
  85
  86 cppcheck-config:
  87         @echo $(MSG_CPPCHECK_CMD) Checking cppcheck configuration for path \"$(CPPCHECK_PATH)\"
  88         cppcheck $(BASE_CPPCHECK_FLAGS) --check-config $(CPPCHECK_FLAGS) $(CPPCHECK_PATH)
  89
  90 cppcheck:
  91         @echo $(MSG_CPPCHECK_CMD) Performing cppcheck analysis on path \"$(CPPCHECK_PATH)\"
  92         cppcheck $(BASE_CPPCHECK_FLAGS) --enable=$(CPPCHECK_ENABLE) $(CPPCHECK_SUPPRESS:%=--suppress=%) $(CPPCHECK_FLAGS) $(CPPCHECK_PATH)
  93
  94 # Phony build targets for this module
  95 .PHONY: cppcheck-config cppcheck