Configuring include-what-you-use in TICS

include-what-you-use (also referred to as iwyu or Iwyu in other places in this documentation) is an open-source tool which allows you to ensure very strict checks on what you do and do not include in a C/C++ source file.

Prerequisites

For a successful include-what-you-use integration, the following prerequisites must be met:

• A Linux-based operating system.
• A functional installation of the Clang compiler. include-what-you-use is heavily tied to the internals of the Clang compiler, and requires to be using a version of the tool that is built against a specific version of Clang. In the case you are not using the correct version, TICS will throw an error (rethrown from the tool) that shows you are using the wrong Iwyu version for the Clang version that is installed.

Using Mapping Files

A mapping file can be added in any configuration directory that will be used by TICS. This file must have the name iwyu_mapping.imp and have the specified content format. If no iwyu_mapping.imp file is present in the configuration, TICS will use a default file.

Content of Mapping Files

The contents of mapping files are better explained at include-what-you-use's own documentation. Specifically, an explanation of the contents of a mapping file can be found here: IWYUMappings