Checks: '-*,abseil-*,android-*,boost-*,bugprone-*,cert-*,clang-*,cppcoreguidelines-avoid-*,cppcoreguidelines-c-copy-assignment-signature,cppcoreguidelines-interfaces-global-init,cppcoreguidelines-macro-usage,cppcoreguidelines-narrowing-conversions,cppcoreguidelines-no-malloc,cppcoreguidelines-non-private-member-variables-in-classes,cppcoreguidelines-pro-bounds-constant-array-index,cppcoreguidelines-pro-bounds-pointer-arithmetic,cppcoreguidelines-pro-type-*,cppcoreguidelines-slicing,cppcoreguidelines-special-member-functions,darwin-*,fuchsia-header-anon-namespaces,fuchsia-multiple-inheritance,fuchsia-restrict-system-includes,fuchsia-statically-constructed-objects,fuchsia-trailing-return,fuchsia-virtual-inheritance,google-build-explicit-make-pair,google-build-namespaces,google-default-arguments,google-explicit-constructor,google-global-names-in-headers,google-objc-*,google-readability-braces-around-statements,google-readability-casting,google-readability-function-size,google-readability-todo,google-runtime-*,hicpp-avoid-*,hicpp-braces-around-statements,hicpp-deprecated-headers,hicpp-exception-baseclass,hicpp-explicit-conversions,hicpp-function-size,hicpp-invalid-access-moved,hicpp-member-init,hicpp-move-const-arg,hicpp-multiway-paths-covered,hicpp-named-parameter,hicpp-new-delete-operators,hicpp-no-assembler,hicpp-no-malloc,hicpp-noexcept-move,hicpp-signed-bitwise,hicpp-special-member-functions,hicpp-static-assert,hicpp-undelegated-constructor,hicpp-uppercase-literal-suffix,hicpp-use-*,hicpp-vararg,linuxkernel-*,llvm-header-guard,llvm-twine-local,misc-*,modernize-avoid-*,modernize-concat-nested-namespaces,modernize-deprecated-*,modernize-loop-convert,modernize-make-*,modernize-pass-by-value,modernize-raw-string-literal,modernize-redundant-void-arg,modernize-replace-*,modernize-return-braced-init-list,modernize-shrink-to-fit,modernize-unary-static-assert,modernize-use-auto,modernize-use-bool-literals,modernize-use-default-member-init,modernize-use-emplace,modernize-use-equals-*,modernize-use-nodiscard,modernize-use-noexcept,modernize-use-nullptr,modernize-use-override,modernize-use-transparent-functors,modernize-use-uncaught-exceptions,modernize-use-using,mpi-*,objc-*,openmp-*,performance-*,portability-*,readability-avoid-const-params-in-decls,readability-braces-around-statements,readability-const-return-type,readability-container-size-empty,readability-delete-null-pointer,readability-deleted-default,readability-else-after-return,readability-function-size,readability-identifier-naming,readability-implicit-bool-conversion,readability-inconsistent-declaration-parameter-name,readability-isolate-declaration,readability-magic-numbers,readability-misleading-indentation,readability-misplaced-array-index,readability-named-parameter,readability-non-const-parameter,readability-qualified-auto,readability-redundant-*,readability-simplify-*,readability-static-*,readability-string-compare,readability-uniqueptr-delete-release,readability-uppercase-literal-suffix,zircon-*'

FormatStyle: 'file'

One of the problems in C++ is that if a header file was changed all files that

include that file will be recompiled and sometime it takes a lot of time.

If file *char_kind.hpp* is changed all files that

include *base_char_factory.hpp* and *base_char.hpp* will be recompiled and

it will take time. This tool helps to find the file at the top of

the include hierarchy:

The tool reads settings from *.cppinclude.json* located in the work directory or

you can pass a configuration file in the argument *configuration_file*.

You can set the path for the compile_command.json file in the configuration file:

or, pass as an argument:

PPath to a folder that contains sources. Often source files are located

in *src* or *sources* folder, not in the root folder of project.

You can set it in configuration file with:

or, pass as an argument:

If you use other file extensions than default values *file_extensions*

for C++ sources you can specify them in the configuration file with:

or, pass as an argument:

Analyze files without extension in the project directory, default: false.

You can set this option in the configuration file with:

or, pass as an argument:

Add paths to the header search directories. Default value is project folder.

You can set it in the configuration file with:

or, pass as an argument:

Folders to be ignored during project analysis.

For example: third-party libraries that are located under the project directory

but should not be analyzed.

You can set it in the configuration file with:

or, pass as an argument:

You can set it in the configuration file with:

or, pass as an argument:

or, pass as an argument:

* *unresolved* -- show included files that are not found within the project folder;

As arguments:

As a configuration file setting:

Show headers that are included but not found in the given search paths.

One possible reason is missing include files, for example:

iven a *main.cpp* file and a *include* folder that stores

the *header.hpp* header:

When *cppinclude* is run, the result will be:

Adding the *include* folder to *include_dirs* will remove the

unresolved files entry:

Show how many files will be recompiled when a given header is changed.

The above output means that a change in char_kind.hpp will force 11

files to recompile.

Show headers that are found in the search directories but that were not

included in the source code.

It often happens after refactoring when headers when include directives

were removed from code and thefiles remained in place.

* Headers with same names:

If headers have the same name but are located in different paths only one

occurrence will be counted.

only first header and other will be unincluded.

For example: *lib1/header.hpp*, *lib2/header.hpp* and *main.cpp* :

The result will be:

* Empty result for CMake project:

The current implementation ignores CMake project files.

***All limitations will be fixed in future releases***

It helps to follow code styles in project,