skia2/tools/sk_app
Kevin Lubick e253cc3e55 [bazel] Use toolchain features to opt files into being IWYU compliant.
PS1 regenerates the Bazel files.

It is recommended to review this CL with a diff from PS1.

Example output when a file does not pass the test:
    tools/sk_app/CommandSet.h should add these lines:
    #include "include/core/SkTypes.h"
    #include "include/private/SkTArray.h"
    #include "tools/skui/InputState.h"
    #include "tools/skui/Key.h"
    #include "tools/skui/ModifierKey.h"
    namespace sk_app { class Window; }

    tools/sk_app/CommandSet.h should remove these lines:
    - #include "tools/sk_app/Window.h"

    The full include-list for tools/sk_app/CommandSet.h:
    #include "include/core/SkString.h"
    #include "include/core/SkTypes.h"
    #include "include/private/SkTArray.h"
    #include "tools/skui/InputState.h"
    #include "tools/skui/Key.h"
    #include "tools/skui/ModifierKey.h"
    #include <functional>
    #include <vector>
    class SkCanvas;
    namespace sk_app { class Window; }
    ---

This makes use of Bazel's toolchain features
https://bazel.build/docs/cc-toolchain-config-reference#features
to allow us to configure compiler flags when compiling
individual files. This analysis is off by default, and can
be turned on with --features skia_enforce_iwyu. When enabled,
it will only be run for files that have opted in.
Example:
    bazelisk build //example:hello_world_gl --config=clang \
       --sandbox_base=/dev/shm --features skia_enforce_iwyu

There are two ways to opt files in:
 - Add enforce_iwyu = True to a generated_cc_atom rule
 - Add enforce_iwyu_on_package() to a BUILD.bazel file
   (which enforces IWYU for all rules in that file)

Note that Bazel does not propagate features to dependencies
or dependents, so trying to enable the feature on cc_library
or cc_executable targets will only impact any files listed in
srcs or hdrs, not deps. This may be counter-intuitive when
compared to things like defines.

IWYU supports a mapping file, which we supply to help properly
handle things system headers (//toolchain/IWYU_mapping.imp)

Suggested Review Order:
 - toolchain/build_toolchain.bzl to see how we get the IWYU
   binaries into the toolchain
 - toolchain/BUILD.bazel and toolchain/IWYU_mapping.imp
   to see how the mapping file is made available for
   all compile steps
 - toolchain/clang_toolchain_config.bzl, where we define the
   skia_enforce_iwyu feature to turn on any verification at
   all and skia_opt_file_into_iwyu to enable the check for
   specific files using a define.
 - toolchain/clang_trampoline.sh, which is the toolchain is
   configured to call instead of clang directly (see line 83
   of clang_toolchain_config.bzl). This bash script used to
   just forward all arguments directly onto clang. Now it
   inspects them and either calls clang directly (if
   it does not find the define in the arguments or we are
   linking [bazel sometimes links with clang instead of ld])
   or calls clang and then include-what-you-use. In all cases,
   the trampoline sends the arguments to clang and IWYU
   unchanged).
 - //tools/sk_app/... to see enforcement enabled (and fixed)
   for select files, as an example of that method.
 - //experimental/bazel_test/... to see enforcement enabled
   for all rules in a BUILD.bazel file.
 - all other files.

Change-Id: I60a2ea9d5dc9955b6a8f166bd449de9e2b81a233
Bug: skia:13052
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/519776
Reviewed-by: Ben Wagner <bungeman@google.com>
Reviewed-by: Leandro Lovisolo <lovisolo@google.com>
Commit-Queue: Kevin Lubick <kjlubick@google.com>
2022-03-16 13:09:46 +00:00
..
android Convert 0 and NULL to nullptr. 2022-02-09 14:20:57 +00:00
ios [bazel] Try adding cc_binary rules that use generated rules 2021-11-30 18:18:53 +00:00
mac [dawn] Clean up include paths and dawn_native namespace 2022-03-07 14:38:55 +00:00
unix [bazel] Support Vulkan 2022-03-08 21:21:17 +00:00
wasm Set up basic hello world sk_app 2022-01-06 20:29:35 +00:00
win [bazel] Support Vulkan 2022-03-08 21:21:17 +00:00
Application.h Remove SampleApp and convert HelloWorld to sk_app 2017-11-21 18:37:19 +00:00
BUILD.bazel [bazel] Use toolchain features to opt files into being IWYU compliant. 2022-03-16 13:09:46 +00:00
CommandSet.cpp [bazel] Use toolchain features to opt files into being IWYU compliant. 2022-03-16 13:09:46 +00:00
CommandSet.h [bazel] Use toolchain features to opt files into being IWYU compliant. 2022-03-16 13:09:46 +00:00
DawnWindowContext.cpp [dawn] Clean up include paths and dawn_native namespace 2022-03-07 14:38:55 +00:00
DawnWindowContext.h [dawn] Clean up include paths and dawn_native namespace 2022-03-07 14:38:55 +00:00
DisplayParams.h Hide binaryArchive use in Viewer behind a flag. 2020-11-25 17:27:47 +00:00
GLWindowContext.cpp Rename GrContextPriv to GrDirectContextPriv 2020-10-14 16:46:01 +00:00
GLWindowContext.h Update the sk_app WindowContext to hold a GrDirectContext 2020-07-10 18:27:03 +00:00
GraphiteMetalWindowContext.h [graphite] Add support to Mac Viewer. 2021-09-30 21:38:25 +00:00
GraphiteMetalWindowContext.mm [graphite] Fix shader dictionary's map key equality check. 2022-02-18 20:25:39 +00:00
MetalWindowContext.h Fix ODR violation in Metal code. 2021-10-20 21:33:32 +00:00
MetalWindowContext.mm Reland "Add new GrSurfaceInfo class and related backend structs." 2021-09-20 20:44:53 +00:00
RasterWindowContext.h rewrite includes to not need so much -Ifoo 2019-04-24 16:27:11 +00:00
VulkanWindowContext.cpp In vulkan tests, use vkGetInstanceProcAddr to get vkGetDeviceProcAddr. 2022-01-14 17:04:16 +00:00
VulkanWindowContext.h In vulkan tests, use vkGetInstanceProcAddr to get vkGetDeviceProcAddr. 2022-01-14 17:04:16 +00:00
Window.cpp Add activation events to sk_app. 2020-11-16 16:44:08 +00:00
Window.h [graphite] Add support to Mac Viewer. 2021-09-30 21:38:25 +00:00
WindowContext.cpp [graphite] Hook up viewer 2022-01-18 15:49:51 +00:00
WindowContext.h [graphite] Make Context no longer ref counted. 2022-02-03 17:18:40 +00:00