[PATCH] D98070: [clang-tidy] Add option to ignore macros in readability-function-cognitive-complexity check.

[Jens Massberg via Phabricator via cfe-commits]

massberg created this revision.
Herald added subscribers: lebedev.ri, xazax.hun.
Herald added a reviewer: lebedev.ri.
massberg requested review of this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.

If a macro is used within a function, the code inside the macro
doesn't make the code less readable. Instead, for a reader a macro is
more like a function that is called. Thus the code inside a macro
shouldn't increase the complexity of the function in which it is called.
Thus the flag 'IgnoreMacros' is added. If set to 'true' code inside
macros isn't considered during analysis.

This isn't perfect, as now the code of a macro isn't considered at all,
even if it has a high cognitive complexity itself. It might be better if
a macro is considered in the analysis like a function and gets its own
cognitive complexity. Implementing such an analysis seems to be very
complex (if possible at all with the given AST), so we give the user the
option to either ignore macros completely or to let the expanded code
count to the calling function's complexity.

See the code example from vgeof (originally added as note in https://reviews.llvm.org/D96281)

  bool doStuff(myClass* objectPtr){
        if(objectPtr == nullptr){
            LOG_WARNING("empty object");
            return false;
        }
        if(objectPtr->getAttribute() == nullptr){
            LOG_WARNING("empty object");
            return false;
        }
        use(objectPtr->getAttribute());
    }

The LOG_WARNING macro itself might have a high complexity, but it do not make the
the function more complex to understand like e.g. a 'printf'.

By default 'IgnoreMacros' is set to 'false', which is the original behavior of the check.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D98070

Files:
  clang-tools-extra/clang-tidy/readability/FunctionCognitiveComplexityCheck.cpp
  clang-tools-extra/clang-tidy/readability/FunctionCognitiveComplexityCheck.h
  clang-tools-extra/docs/clang-tidy/checks/readability-function-cognitive-complexity.rst
  clang-tools-extra/test/clang-tidy/checkers/readability-function-cognitive-complexity-flags.cpp

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D98070.328618.patch
Type: text/x-patch
Size: 7363 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20210305/0017da2b/attachment.bin>