Use include-what-you-use on lib/core (#32046)

* A first pass at running IWYU with some manual fixes * Refert platform file changes * Move one header up due to self-review * Move self-header to top of file * Another pass this time with -Xiwyu flags * Start adding a IWYU mapping so we need less manual fixes * Fix command line * Update iwyu.imp * Remove forward decl * Fix for compile * Fixes to compile locally ... several things could be cleaned * One more cleanup, linux all-clusters compiles at least --------- Co-authored-by: Andrei Litvin <[email protected]>
project-chip · Feb 13, 2024 · f8d7d1d · f8d7d1d
1 parent f5b4caf
commit f8d7d1d
Show file tree

Hide file tree

Showing 23 changed files with 165 additions and 140 deletions.
diff --git a/iwyu.imp b/iwyu.imp
@@ -0,0 +1,22 @@
+# General IWYU command example:
+#
+# iwyu_tool.py                                                  \
+#    -p out/linux-x64-all-clusters-clang/compile_commands.json  \
+#    src/lib/core/                                              \
+#    --                                                         \
+#    -Xiwyu --mapping_file=$(pwd)/iwyu.imp                      \
+#    -Xiwyu --no_comments                                       \
+#    -Xiwyu --comment_style=none                                \
+#    -Xiwyu --cxx17ns                                           \
+#    -Xiwyu no_fwd_decls                                        \
+#  | tee out/iwyu.out
+#
+# cd out/linux-x64-all-clusters-clang
+#
+# fix_includes.py <../iwyu.out
+#
+[
+    { include: [ '"system/SystemBuildConfig.h"', private, '<system/SystemConfig.h>', public ] },
+    { include: [ '"core/CHIPBuildConfig.h"', private, '<lib/core/CHIPConfig.h>', public ] },
+    { include: [ '@"platform/.*/CHIPPlatformConfig.h"', private, '<lib/core/CHIPConfig.h>', public ] },
+]
diff --git a/src/lib/core/CHIPError.cpp b/src/lib/core/CHIPError.cpp
@@ -15,13 +15,7 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-
-/**
- *    @file
- *      This file contains functions for working with CHIP errors.
- */
-
-#include <stddef.h>
+#include <lib/core/CHIPError.h>
 
 #include <lib/core/CHIPConfig.h>
 #include <lib/core/ErrorStr.h>

diff --git a/src/lib/core/CHIPError.h b/src/lib/core/CHIPError.h
@@ -33,7 +33,6 @@
 
 #include <inttypes.h>
 #include <limits>
-#include <stdint.h>
 #include <type_traits>
 
 namespace chip {

diff --git a/src/lib/core/CHIPKeyIds.cpp b/src/lib/core/CHIPKeyIds.cpp
@@ -15,15 +15,8 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
+#include <lib/core/CHIPKeyIds.h>
 
-/**
- *    @file
- *      This file implements CHIP key types helper functions.
- *
- */
-#include "CHIPKeyIds.h"
-
-#include <lib/core/CHIPCore.h>
 #include <lib/support/CodeUtils.h>
 
 namespace chip {

diff --git a/src/lib/core/CHIPKeyIds.h b/src/lib/core/CHIPKeyIds.h
@@ -22,10 +22,8 @@
  *      key flags, key ID fields, and helper API functions.
  *
  */
-
 #pragma once
 
-#include <limits.h>
 #include <stdint.h>
 
 namespace chip {

diff --git a/src/lib/core/ErrorStr.cpp b/src/lib/core/ErrorStr.cpp
@@ -15,24 +15,19 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-
-/**
- *    @file
- *      This file implements functions to translate error codes used
- *      throughout the CHIP package into human-readable strings.
- *
- */
+#include <lib/core/ErrorStr.h>
 
 #ifndef __STDC_FORMAT_MACROS
 #define __STDC_FORMAT_MACROS
 #endif
 
+#include <lib/core/CHIPConfig.h>
+#include <lib/core/CHIPError.h>
+#include <lib/support/DLLUtil.h>
+
 #include <inttypes.h>
 #include <stdio.h>
 
-#include <lib/core/CHIPConfig.h>
-#include <lib/core/ErrorStr.h>
-
 namespace chip {
 
 /**

diff --git a/src/lib/core/ErrorStr.h b/src/lib/core/ErrorStr.h
@@ -28,7 +28,6 @@
 #include <stdint.h>
 
 #include <lib/core/CHIPError.h>
-#include <lib/support/DLLUtil.h>
 
 namespace chip {
 

diff --git a/src/lib/core/OTAImageHeader.cpp b/src/lib/core/OTAImageHeader.cpp
@@ -14,12 +14,19 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
+#include <lib/core/OTAImageHeader.h>
 
-#include "OTAImageHeader.h"
-
-#include <lib/core/TLV.h>
+#include <lib/core/CHIPError.h>
+#include <lib/core/Optional.h>
+#include <lib/core/TLVReader.h>
+#include <lib/core/TLVTags.h>
+#include <lib/core/TLVTypes.h>
 #include <lib/support/BufferReader.h>
 #include <lib/support/CodeUtils.h>
+#include <lib/support/ScopedBuffer.h>
+#include <lib/support/Span.h>
+
+#include <string.h>
 
 namespace chip {
 

diff --git a/src/lib/core/OTAImageHeader.h b/src/lib/core/OTAImageHeader.h
@@ -17,6 +17,7 @@
 
 #pragma once
 
+#include <lib/core/CHIPError.h>
 #include <lib/core/Optional.h>
 #include <lib/support/ScopedBuffer.h>
 #include <lib/support/Span.h>

diff --git a/src/lib/core/TLVCircularBuffer.cpp b/src/lib/core/TLVCircularBuffer.cpp
@@ -26,16 +26,17 @@
  *      to continually add top-level TLV elements by evicting
  *      pre-existing elements.
  */
+#include <lib/core/TLVCircularBuffer.h>
 
 #ifndef __STDC_LIMIT_MACROS
 #define __STDC_LIMIT_MACROS
 #endif
-#include <lib/core/TLVCircularBuffer.h>
-
-#include <lib/core/CHIPCore.h>
-#include <lib/core/CHIPEncoding.h>
-#include <lib/core/TLV.h>
 
+#include <lib/core/CHIPError.h>
+#include <lib/core/TLVReader.h>
+#include <lib/core/TLVTags.h>
+#include <lib/core/TLVWriter.h>
+#include <lib/support/BufferWriter.h>
 #include <lib/support/CodeUtils.h>
 
 #include <stdint.h>

diff --git a/src/lib/core/TLVCircularBuffer.h b/src/lib/core/TLVCircularBuffer.h
@@ -30,12 +30,12 @@
 #pragma once
 
 #include <lib/core/CHIPError.h>
-#include <lib/core/TLV.h>
-#include <lib/core/TLVTags.h>
-#include <lib/core/TLVTypes.h>
-
+#include <lib/core/TLVBackingStore.h>
+#include <lib/core/TLVReader.h>
+#include <lib/core/TLVWriter.h>
 #include <lib/support/DLLUtil.h>
 
+#include <stdint.h>
 #include <stdlib.h>
 
 namespace chip {

diff --git a/src/lib/core/TLVDebug.cpp b/src/lib/core/TLVDebug.cpp
@@ -15,27 +15,20 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-
-/**
- *    @file
- *      This file implements interfaces for debugging and logging
- *      CHIP TLV.
- *
- */
+#include <lib/core/TLVDebug.h>
 
 #ifndef __STDC_FORMAT_MACROS
 #define __STDC_FORMAT_MACROS
 #endif
 
-#include <ctype.h>
 #include <inttypes.h>
-#include <string.h>
 
-#include <lib/core/TLV.h>
-#include <lib/core/TLVDebug.h>
+#include <lib/core/CHIPError.h>
+#include <lib/core/TLVReader.h>
+#include <lib/core/TLVTags.h>
+#include <lib/core/TLVTypes.h>
 #include <lib/core/TLVUtilities.h>
 #include <lib/support/CodeUtils.h>
-#include <lib/support/logging/CHIPLogging.h>
 
 namespace chip {
 

diff --git a/src/lib/core/TLVDebug.h b/src/lib/core/TLVDebug.h
@@ -15,24 +15,16 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-
-/**
- *    @file
- *      This file defines types and interfaces for debugging and
- *      logging CHIP TLV.
- *
- */
-
 #pragma once
 
 #include <stddef.h>
-#include <stdint.h>
 
 #include <lib/core/CHIPError.h>
-#include <lib/core/TLV.h>
+#include <lib/core/TLVReader.h>
+#include <lib/core/TLVTags.h>
+#include <lib/core/TLVTypes.h>
 
 namespace chip {
-
 namespace TLV {
 
 /**

diff --git a/src/lib/core/TLVReader.cpp b/src/lib/core/TLVReader.cpp
@@ -15,24 +15,32 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
+#include <lib/core/TLVReader.h>
 
-/**
- *    @file
- *      This file implements a parser for the CHIP TLV (Tag-Length-Value) encoding format.
- *
- */
+#include <stdint.h>
+#include <string.h>
 
-#include <stdlib.h>
-
-#include <lib/core/CHIPCore.h>
+#include <lib/core/CHIPConfig.h>
 #include <lib/core/CHIPEncoding.h>
+#include <lib/core/CHIPError.h>
 #include <lib/core/CHIPSafeCasts.h>
-#include <lib/core/TLV.h>
+#include <lib/core/DataModelTypes.h>
+#include <lib/core/Optional.h>
+#include <lib/core/TLVBackingStore.h>
+#include <lib/core/TLVCommon.h>
+#include <lib/core/TLVTags.h>
+#include <lib/core/TLVTypes.h>
+#include <lib/support/BufferWriter.h>
 #include <lib/support/BytesToHex.h>
 #include <lib/support/CHIPMem.h>
 #include <lib/support/CodeUtils.h>
 #include <lib/support/SafeInt.h>
+#include <lib/support/Span.h>
+#include <lib/support/logging/TextOnlyLogging.h>
+
+#if CHIP_CONFIG_TLV_VALIDATE_CHAR_STRING_ON_READ
 #include <lib/support/utf8.h>
+#endif
 
 namespace chip {
 namespace TLV {

diff --git a/src/lib/core/TLVReader.h b/src/lib/core/TLVReader.h
@@ -24,14 +24,25 @@
  *      shares many properties with the commonly used JSON serialization format while being considerably
  *      more compact over the wire.
  */
-
 #pragma once
 
+#include <stddef.h>
+#include <stdint.h>
+#include <type_traits>
+#include <utility>
+
+#include <lib/core/CHIPError.h>
 #include <lib/core/DataModelTypes.h>
 #include <lib/core/Optional.h>
-
-#include "TLVCommon.h"
-#include "TLVWriter.h"
+#include <lib/core/TLVBackingStore.h>
+#include <lib/core/TLVTags.h>
+#include <lib/core/TLVTypes.h>
+#include <lib/support/BitFlags.h>
+#include <lib/support/BitMask.h>
+#include <lib/support/CodeUtils.h>
+#include <lib/support/DLLUtil.h>
+#include <lib/support/ScopedBuffer.h>
+#include <lib/support/Span.h>
 
 /**
  * @namespace chip::TLV

diff --git a/src/lib/core/TLVTags.cpp b/src/lib/core/TLVTags.cpp
@@ -15,7 +15,12 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-#include "TLVTags.h"
+#include <lib/core/TLVTags.h>
+
+#include <inttypes.h>
+
+#include <lib/support/StringBuilder.h>
+#include <lib/support/logging/TextOnlyLogging.h>
 
 namespace chip {
 namespace TLV {

diff --git a/src/lib/core/TLVTags.h b/src/lib/core/TLVTags.h
@@ -15,18 +15,12 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-
-/**
- *    @file
- *      This file contains definitions for working with CHIP TLV tags.
- *
- */
-
 #pragma once
 
-#include <cstdint>
 #include <lib/support/StringBuilder.h>
 #include <lib/support/TypeTraits.h>
+
+#include <cstdint>
 #include <type_traits>
 
 namespace chip {

diff --git a/src/lib/core/TLVUpdater.cpp b/src/lib/core/TLVUpdater.cpp
@@ -15,18 +15,22 @@
  *    See the License for the specific language governing permissions and
  *    limitations under the License.
  */
-
-/**
- *    @file
- *      This file implements an updating encoder for the CHIP TLV
- *      (Tag-Length-Value) encoding format.
- *
- */
-
-#include <lib/core/CHIPCore.h>
-#include <lib/core/CHIPEncoding.h>
-#include <lib/core/TLV.h>
+#include <lib/core/TLVUpdater.h>
+
+#include <stdint.h>
+#include <string.h>
+
+#include <lib/core/CHIPConfig.h>
+#include <lib/core/CHIPError.h>
+#include <lib/core/TLVCommon.h>
+#include <lib/core/TLVReader.h>
+#include <lib/core/TLVTags.h>
+#include <lib/core/TLVTypes.h>
+#include <lib/core/TLVWriter.h>
+#include <lib/support/BufferWriter.h>
 #include <lib/support/CodeUtils.h>
+#include <lib/support/logging/Constants.h>
+#include <lib/support/logging/TextOnlyLogging.h>
 
 namespace chip {
 namespace TLV {