Add IWYU pragmas (#1008)

Added include-what-you-use pragmas to:
* let IWYU point users to the main include file CLI/CLI.hpp
* tell IWYU that CLI/CLI.hpp is the main exporting header.

This should fix #816

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Philip Top <phlptp@gmail.com>

Author: 3 people

include/CLI/App.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <cstdint>
@@ -1442,5 +1444,5 @@ struct AppFriend {
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/App_inl.hpp"
+#include "impl/App_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/Argv.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <string>
 #include <vector>
@@ -25,5 +27,5 @@ CLI11_INLINE std::vector<std::string> compute_win32_argv();
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/Argv_inl.hpp"
+#include "impl/Argv_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/CLI.hpp

@@ -9,6 +9,8 @@
 // CLI Library includes
 // Order is important for combiner script
 
+// IWYU pragma: begin_exports
+
 #include "Version.hpp"
 
 #include "Macros.hpp"
@@ -38,3 +40,5 @@
 #include "Config.hpp"
 
 #include "Formatter.hpp"
+
+// IWYU pragma: end_exports

include/CLI/Config.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <cctype>
@@ -49,5 +51,5 @@ void checkParentSegments(std::vector<ConfigItem> &output, const std::string &cur
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/Config_inl.hpp"
+#include "impl/Config_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/ConfigFwd.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <fstream>

include/CLI/Encoding.hpp

@@ -6,6 +6,7 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
 #include "Macros.hpp"
 
 // [CLI11:public_includes:set]
@@ -50,5 +51,5 @@ CLI11_INLINE std::filesystem::path to_path(std::string_view str);
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/Encoding_inl.hpp"
+#include "impl/Encoding_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/Error.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <exception>
 #include <stdexcept>

include/CLI/Formatter.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <string>
@@ -21,5 +23,5 @@ namespace CLI {
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/Formatter_inl.hpp"
+#include "impl/Formatter_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/FormatterFwd.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <functional>
 #include <map>

include/CLI/Macros.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:macros_hpp:verbatim]
 
 // The following version macro is very similar to the one in pybind11

include/CLI/Option.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <functional>
@@ -804,5 +806,5 @@ class Option : public OptionBase<Option> {
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/Option_inl.hpp"
+#include "impl/Option_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/Split.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <string>
 #include <tuple>
@@ -44,5 +46,5 @@ get_names(const std::vector<std::string> &input);
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/Split_inl.hpp"
+#include "impl/Split_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/StringTools.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <iomanip>
@@ -263,5 +265,5 @@ CLI11_INLINE bool process_quoted_string(std::string &str, char string_char = '\"
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/StringTools_inl.hpp"
+#include "impl/StringTools_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/Timer.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // On GCC < 4.8, the following define is often missing. Due to the
 // fact that this library only uses sleep_for, this should be safe
 #if defined(__GNUC__) && !defined(__clang__) && __GNUC__ < 5 && __GNUC_MINOR__ < 8

include/CLI/TypeTools.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <cmath>

include/CLI/Validators.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 #include "Error.hpp"
 #include "Macros.hpp"
 #include "StringTools.hpp"
@@ -892,5 +894,5 @@ CLI11_INLINE std::pair<std::string, std::string> split_program_name(std::string
 }  // namespace CLI
 
 #ifndef CLI11_COMPILE
-#include "impl/Validators_inl.hpp"
+#include "impl/Validators_inl.hpp"  // IWYU pragma: export
 #endif

include/CLI/Version.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // [CLI11:version_hpp:verbatim]
 
 #define CLI11_VERSION_MAJOR 2

include/CLI/impl/App_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../App.hpp"
 

include/CLI/impl/Argv_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../Argv.hpp"
 

include/CLI/impl/Config_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../Config.hpp"
 

include/CLI/impl/Encoding_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../Encoding.hpp"
 #include "../Macros.hpp"

include/CLI/impl/Formatter_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../Formatter.hpp"
 

include/CLI/impl/Option_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../Option.hpp"
 

include/CLI/impl/Split_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../Split.hpp"
 

include/CLI/impl/StringTools_inl.hpp

@@ -6,6 +6,8 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
+
 // This include is only needed for IDEs to discover symbols
 #include "../StringTools.hpp"
 

include/CLI/impl/Validators_inl.hpp

@@ -6,6 +6,7 @@
 
 #pragma once
 
+// IWYU pragma: private, include "CLI/CLI.hpp"
 #include "../Validators.hpp"
 
 #include "../Encoding.hpp"

src/Precompile.cpp

@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
+// IWYU pragma: begin_keep
+
 #include <CLI/impl/App_inl.hpp>
 #include <CLI/impl/Argv_inl.hpp>
 #include <CLI/impl/Config_inl.hpp>
@@ -13,3 +15,5 @@
 #include <CLI/impl/Split_inl.hpp>
 #include <CLI/impl/StringTools_inl.hpp>
 #include <CLI/impl/Validators_inl.hpp>
+
+// IWYU pragma: end_keep