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 # Default values of optionally user-supplied variables
  50 CPPCHECK_PATH                ?= .
  51 CPPCHECK_INCLUDES            ?=
  52 CPPCHECK_EXCLUDES            ?=
  53 CPPCHECK_MSG_TEMPLATE        ?= {file}:{line}: {severity} ({id}): {message}
  54 CPPCHECK_ENABLE              ?= all
  55 CPPCHECK_SUPPRESS            ?= variableScope missingInclude
  56 CPPCHECK_FAIL_ON_WARNING     ?= Y
  57 CPPCHECK_QUIET               ?= Y
  58 CPPCHECK_FLAGS               ?=
  59
  60 # Build a default argument list for cppcheck
  61 BASE_CPPCHECK_FLAGS := --template="$(CPPCHECK_MSG_TEMPLATE)" $(CPPCHECK_INCLUDES:%=-I%) $(CPPCHECK_EXCLUDES:%=-i%) --inline-suppr --force --std=c99
  62
  63 # Sanity check parameters and construct additional command line arguments to cppcheck
  64
  65 ifeq ($(CPPCHECK_FAIL_ON_WARNING), Y)
  66    BASE_CPPCHECK_FLAGS += --error-exitcode=1
  67 else ifneq ($(CPPCHECK_FAIL_ON_WARNING), N)
  68         $(error CPPCHECK_FAIL_ON_WARNING must be Y or N)
  69 endif
  70 ifeq ($(CPPCHECK_QUIET), Y)
  71    BASE_CPPCHECK_FLAGS += --quiet
  72 else ifneq ($(CPPCHECK_QUIET), N)
  73    $(error CPPCHECK_QUIET must be Y or N)
  74 endif
  75
  76 # Output Messages
  77 MSG_CPPCHECK_CMD         := ' [CPPCHECK]:'
  78
  79 cppcheck-config:
  80         @echo $(MSG_CPPCHECK_CMD) Checking cppcheck configuration for path \"$(CPPCHECK_PATH)\"
  81         cppcheck $(BASE_CPPCHECK_FLAGS) --check-config $(CPPCHECK_FLAGS) $(CPPCHECK_PATH)
  82
  83 cppcheck:
  84         @echo $(MSG_CPPCHECK_CMD) Performing cppcheck analysis on path \"$(CPPCHECK_PATH)\"
  85         cppcheck $(BASE_CPPCHECK_FLAGS) --enable=$(CPPCHECK_ENABLE) $(CPPCHECK_SUPPRESS:%=--suppress=%) $(CPPCHECK_FLAGS) $(CPPCHECK_PATH)
  86
  87 # Phony build targets for this module
  88 .PHONY: cppcheck-config cppcheck