[vcpkg] Add Forward Declarations (originally by @cngzhnp) (microsoft#…

…12985) Co-authored-by: cngzhnp <[email protected]>
strega-nil · Aug 19, 2020 · ed78528 · ed78528
1 parent c8b5803
commit ed78528
Show file tree

Hide file tree

Showing 57 changed files with 172 additions and 67 deletions.
diff --git a/.clang-format b/.clang-format
@@ -40,11 +40,13 @@ IncludeCategories:
     Priority: -1
   - Regex: '^<catch2/catch\.hpp>$'
     Priority: 1
-  - Regex: '^<vcpkg/base/.*\.h>$'
+  - Regex: '^<vcpkg/fwd/.*\.h>$'
     Priority: 2
-  - Regex: '^<vcpkg/.*\.h>$'
+  - Regex: '^<vcpkg/base/.*\.h>$'
     Priority: 3
-  - Regex: '^<[a-z0-9_]*\.h>$'
+  - Regex: '^<vcpkg/.*\.h>$'
     Priority: 4
-  - Regex: '^<[a-z0-9_]*>$' # C++ standard library
+  - Regex: '^<[a-z0-9_]*\.h>$'
     Priority: 5
+  - Regex: '^<[a-z0-9_]*>$' # C++ standard library
+    Priority: 6
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -157,10 +157,10 @@ if(CLANG_FORMAT)
     add_custom_target(format COMMAND ${CLANG_FORMAT} -i -verbose
         ${CMAKE_CURRENT_SOURCE_DIR}/src/pch.cpp
         ${VCPKGLIB_BASE_SOURCES}
-        ${VCPKGLIB_NON_PCH_SOURCES}
+        ${VCPKGLIB_SOURCES}
         ${CMAKE_CURRENT_SOURCE_DIR}/include/pch.h
         ${VCPKGLIB_BASE_INCLUDES}
-        ${VCPKGLIB_NON_PCH_INCLUDES}
+        ${VCPKGLIB_INCLUDES}
 
         ${VCPKG_SOURCES}
         ${VCPKGMETRICSUPLOADER_SOURCES}

diff --git a/include/vcpkg-test/mockcmakevarprovider.h b/include/vcpkg-test/mockcmakevarprovider.h
@@ -19,7 +19,7 @@ namespace vcpkg::Test
         {
             for (auto&& spec : specs)
                 tag_vars[spec.package_spec] = {};
-            Util::unused(port_provider);
+            (void)(port_provider);
         }
 
         Optional<const std::unordered_map<std::string, std::string>&> get_generic_triplet_vars(

diff --git a/include/vcpkg/archives.h b/include/vcpkg/archives.h
@@ -1,8 +1,8 @@
 #pragma once
 
-#include <vcpkg/base/files.h>
+#include <vcpkg/fwd/vcpkgpaths.h>
 
-#include <vcpkg/vcpkgpaths.h>
+#include <vcpkg/base/files.h>
 
 namespace vcpkg::Archives
 {

diff --git a/include/vcpkg/base/util.h b/include/vcpkg/base/util.h
@@ -239,15 +239,4 @@ namespace vcpkg::Util
             return e == E::YES;
         }
     }
-
-    template<class... Ts>
-    void unused(const Ts&...)
-    {
-    }
-
-    template<class T>
-    T copy(const T& t)
-    {
-        return t;
-    }
 }
diff --git a/include/vcpkg/buildenvironment.h b/include/vcpkg/buildenvironment.h
@@ -1,6 +1,8 @@
-#include <vcpkg/base/system.process.h>
+#pragma once
+
+#include <vcpkg/fwd/vcpkgpaths.h>
 
-#include <vcpkg/vcpkgpaths.h>
+#include <vcpkg/base/system.process.h>
 
 #include <string>
 #include <vector>

diff --git a/include/vcpkg/cmakevars.h b/include/vcpkg/cmakevars.h
@@ -1,9 +1,10 @@
 #pragma once
 
+#include <vcpkg/fwd/vcpkgpaths.h>
+
 #include <vcpkg/base/optional.h>
 
 #include <vcpkg/portfileprovider.h>
-#include <vcpkg/vcpkgpaths.h>
 
 namespace vcpkg::Dependencies
 {

diff --git a/include/vcpkg/commands.h b/include/vcpkg/commands.h
@@ -2,12 +2,6 @@
 
 #include <vcpkg/build.h>
 #include <vcpkg/commands.interface.h>
-#include <vcpkg/dependencies.h>
-#include <vcpkg/statusparagraphs.h>
-
-#include <array>
-#include <map>
-#include <vector>
 
 namespace vcpkg::Commands
 {

diff --git a/include/vcpkg/commands.interface.h b/include/vcpkg/commands.interface.h
@@ -1,7 +1,11 @@
 #pragma once
 
-#include <vcpkg/vcpkgcmdarguments.h>
-#include <vcpkg/vcpkgpaths.h>
+#include <vcpkg/fwd/vcpkgcmdarguments.h>
+#include <vcpkg/fwd/vcpkgpaths.h>
+
+#include <vcpkg/base/files.h>
+
+#include <vcpkg/triplet.h>
 
 namespace vcpkg::Commands
 {

diff --git a/include/vcpkg/commands.owns.h b/include/vcpkg/commands.owns.h
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <vcpkg/commands.interface.h>
+#include <vcpkg/vcpkgcmdarguments.h>
 
 namespace vcpkg::Commands::Owns
 {

diff --git a/include/vcpkg/commands.search.h b/include/vcpkg/commands.search.h
@@ -1,6 +1,7 @@
 #pragma once
 
 #include <vcpkg/commands.interface.h>
+#include <vcpkg/vcpkgcmdarguments.h>
 
 namespace vcpkg::Commands::Search
 {

diff --git a/include/vcpkg/dependencies.h b/include/vcpkg/dependencies.h
@@ -4,11 +4,7 @@
 #include <vcpkg/base/util.h>
 
 #include <vcpkg/build.h>
-#include <vcpkg/cmakevars.h>
 #include <vcpkg/packagespec.h>
-#include <vcpkg/portfileprovider.h>
-#include <vcpkg/statusparagraphs.h>
-#include <vcpkg/vcpkgpaths.h>
 
 #include <functional>
 #include <map>
@@ -19,6 +15,21 @@ namespace vcpkg::Graphs
     struct Randomizer;
 }
 
+namespace vcpkg::CMakeVars
+{
+    struct CMakeVarProvider;
+}
+
+namespace vcpkg::PortFileProvider
+{
+    struct PortFileProvider;
+}
+
+namespace vcpkg
+{
+    struct StatusParagraphs;
+}
+
 namespace vcpkg::Dependencies
 {
     enum class RequestType

diff --git a/include/vcpkg/export.ifw.h b/include/vcpkg/export.ifw.h
@@ -1,7 +1,8 @@
 #pragma once
 
+#include <vcpkg/fwd/vcpkgpaths.h>
+
 #include <vcpkg/dependencies.h>
-#include <vcpkg/vcpkgpaths.h>
 
 #include <string>
 #include <vector>

diff --git a/include/vcpkg/fwd/registries.h b/include/vcpkg/fwd/registries.h
@@ -0,0 +1,6 @@
+#pragma once
+
+namespace vcpkg
+{
+    struct Registry;
+}
diff --git a/include/vcpkg/fwd/vcpkgcmdarguments.h b/include/vcpkg/fwd/vcpkgcmdarguments.h
@@ -0,0 +1,13 @@
+#pragma once
+
+namespace vcpkg
+{
+    struct ParsedArguments;
+    struct CommandSwitch;
+    struct CommandSetting;
+    struct CommandMultiSetting;
+    struct CommandOptionsStructure;
+    struct CommandStructure;
+    struct HelpTableFormatter;
+    struct VcpkgCmdArguments;
+}
diff --git a/include/vcpkg/fwd/vcpkgpaths.h b/include/vcpkg/fwd/vcpkgpaths.h
@@ -0,0 +1,8 @@
+#pragma once
+
+namespace vcpkg
+{
+    struct ToolsetArchOption;
+    struct Toolset;
+    struct VcpkgPaths;
+}
diff --git a/include/vcpkg/registries.h b/include/vcpkg/registries.h
@@ -0,0 +1,32 @@
+#pragma once
+
+#include <vcpkg/base/files.h>
+#include <vcpkg/base/optional.h>
+#include <vcpkg/base/
+
+#include <vcpkg/fwd/registries.h>
+
+#include <memory>
+#include <string>
+#include <system_error>
+#include <vector>
+
+namespace vcpkg
+{
+    struct RegistryImpl
+    {
+        virtual void update(std::error_code&) = 0;
+        virtual Optional<fs::path> find_port(StringView name) const = 0;
+
+        virtual ~RegistryImpl() = default;
+    };
+
+    struct Registry
+    {
+        std::string name;
+        std::vector<std::string> packages;
+
+        std::unique_ptr<RegistryImpl> underlying;
+    };
+
+}
diff --git a/include/vcpkg/statusparagraph.h b/include/vcpkg/statusparagraph.h
@@ -1,5 +1,7 @@
 #pragma once
 
+#include <vcpkg/fwd/vcpkgpaths.h>
+
 #include <vcpkg/binaryparagraph.h>
 
 #include <map>
@@ -62,5 +64,5 @@ namespace vcpkg
         std::vector<const StatusParagraph*> features;
     };
 
-    Json::Value serialize_ipv(const InstalledPackageView& ipv, const struct VcpkgPaths& paths);
+    Json::Value serialize_ipv(const InstalledPackageView& ipv, const VcpkgPaths& paths);
 }
diff --git a/include/vcpkg/tools.h b/include/vcpkg/tools.h
@@ -1,14 +1,14 @@
 #pragma once
 
+#include <vcpkg/fwd/vcpkgpaths.h>
+
 #include <vcpkg/base/files.h>
 
 #include <string>
 #include <utility>
 
 namespace vcpkg
 {
-    struct VcpkgPaths;
-
     namespace Tools
     {
         static const std::string SEVEN_ZIP = "7zip";

diff --git a/include/vcpkg/vcpkgcmdarguments.h b/include/vcpkg/vcpkgcmdarguments.h
@@ -1,5 +1,8 @@
 #pragma once
 
+#include <vcpkg/fwd/vcpkgcmdarguments.h>
+#include <vcpkg/fwd/vcpkgpaths.h>
+
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/optional.h>
 #include <vcpkg/base/span.h>
@@ -19,8 +22,6 @@ namespace vcpkg
         std::unordered_map<std::string, std::vector<std::string>> multisettings;
     };
 
-    struct VcpkgPaths;
-
     struct CommandSwitch
     {
         constexpr CommandSwitch(const StringLiteral& name, const StringLiteral& short_help_text)

diff --git a/include/vcpkg/vcpkgpaths.h b/include/vcpkg/vcpkgpaths.h
@@ -1,5 +1,7 @@
 #pragma once
 
+#include <vcpkg/fwd/vcpkgpaths.h>
+
 #include <vcpkg/base/cache.h>
 #include <vcpkg/base/files.h>
 #include <vcpkg/base/lazy.h>

diff --git a/src/vcpkg-test/util.cpp b/src/vcpkg-test/util.cpp
@@ -195,7 +195,7 @@ namespace vcpkg::Test
             ec.assign(errno, std::system_category());
         }
 #else
-        Util::unused(target, file, ec);
+        (void)(target, file, ec);
         vcpkg::Checks::exit_with_message(VCPKG_LINE_INFO, no_filesystem_message);
 #endif
     }
@@ -217,7 +217,7 @@ namespace vcpkg::Test
 #elif FILESYSTEM_SYMLINK == FILESYSTEM_SYMLINK_UNIX
         ::vcpkg::Test::create_symlink(target, file, ec);
 #else
-        Util::unused(target, file, ec);
+        (void)(target, file, ec);
         vcpkg::Checks::exit_with_message(VCPKG_LINE_INFO, no_filesystem_message);
 #endif
     }

diff --git a/src/vcpkg/archives.cpp b/src/vcpkg/archives.cpp
@@ -3,6 +3,7 @@
 #include <vcpkg/archives.h>
 #include <vcpkg/commands.h>
 #include <vcpkg/tools.h>
+#include <vcpkg/vcpkgpaths.h>
 
 namespace vcpkg::Archives
 {

diff --git a/src/vcpkg/base/files.cpp b/src/vcpkg/base/files.cpp
@@ -601,7 +601,7 @@ namespace vcpkg::Files
                                     std::error_code& ec) override
         {
             this->rename(oldpath, newpath, ec);
-            Util::unused(temp_suffix);
+            (void)(temp_suffix);
 #if !defined(_WIN32)
             if (ec)
             {

diff --git a/src/vcpkg/base/system.print.cpp b/src/vcpkg/base/system.print.cpp
@@ -22,7 +22,7 @@ namespace vcpkg::System
 #else
             // TODO: add color handling code
             // it should probably use VT-220 codes
-            Util::unused(c);
+            (void)(c);
             System::print2(message);
 #endif
         }

diff --git a/src/vcpkg/build.cpp b/src/vcpkg/build.cpp
@@ -473,7 +473,7 @@ namespace vcpkg::Build
 #if !defined(_WIN32)
         // TODO: remove when vcpkg.exe is in charge for acquiring tools. Change introduced in vcpkg v0.0.107.
         // bootstrap should have already downloaded ninja, but making sure it is present in case it was deleted.
-        vcpkg::Util::unused(paths.get_tool_exe(Tools::NINJA));
+        (void)(paths.get_tool_exe(Tools::NINJA));
 #endif
         std::vector<System::CMakeVariable> cmake_args{
             {"CURRENT_PORT_DIR", paths.scripts / "detect_compiler"},
@@ -539,7 +539,7 @@ namespace vcpkg::Build
 #if !defined(_WIN32)
         // TODO: remove when vcpkg.exe is in charge for acquiring tools. Change introduced in vcpkg v0.0.107.
         // bootstrap should have already downloaded ninja, but making sure it is present in case it was deleted.
-        vcpkg::Util::unused(paths.get_tool_exe(Tools::NINJA));
+        (void)(paths.get_tool_exe(Tools::NINJA));
 #endif
         auto& scfl = action.source_control_file_location.value_or_exit(VCPKG_LINE_INFO);
         auto& scf = *scfl.source_control_file;

diff --git a/src/vcpkg/buildenvironment.cpp b/src/vcpkg/buildenvironment.cpp
@@ -1,5 +1,6 @@
 #include <vcpkg/buildenvironment.h>
 #include <vcpkg/tools.h>
+#include <vcpkg/vcpkgpaths.h>
 
 namespace vcpkg
 {

diff --git a/src/vcpkg/commands.autocomplete.cpp b/src/vcpkg/commands.autocomplete.cpp
@@ -8,6 +8,7 @@
 #include <vcpkg/metrics.h>
 #include <vcpkg/paragraphs.h>
 #include <vcpkg/remove.h>
+#include <vcpkg/vcpkgcmdarguments.h>
 #include <vcpkg/vcpkglib.h>
 
 namespace vcpkg::Commands::Autocomplete

diff --git a/src/vcpkg/commands.buildexternal.cpp b/src/vcpkg/commands.buildexternal.cpp
@@ -4,6 +4,7 @@
 #include <vcpkg/commands.buildexternal.h>
 #include <vcpkg/help.h>
 #include <vcpkg/input.h>
+#include <vcpkg/vcpkgcmdarguments.h>
 
 namespace vcpkg::Commands::BuildExternal
 {

diff --git a/src/vcpkg/commands.cache.cpp b/src/vcpkg/commands.cache.cpp
@@ -5,6 +5,7 @@
 #include <vcpkg/commands.cache.h>
 #include <vcpkg/help.h>
 #include <vcpkg/paragraphs.h>
+#include <vcpkg/vcpkgcmdarguments.h>
 
 namespace vcpkg::Commands::Cache
 {
@@ -36,7 +37,7 @@ namespace vcpkg::Commands::Cache
 
     void perform_and_exit(const VcpkgCmdArguments& args, const VcpkgPaths& paths)
     {
-        Util::unused(args.parse_arguments(COMMAND_STRUCTURE));
+        (void)(args.parse_arguments(COMMAND_STRUCTURE));
 
         const std::vector<BinaryParagraph> binary_paragraphs = read_all_binary_paragraphs(paths);
         if (binary_paragraphs.empty())