Hide Private headers and deprecate LocalCache.hh (#109)

Signed-off-by: ahcorde <[email protected]>
gazebosim · Sep 1, 2020 · d892487 · d892487
1 parent 4e6f2f1
commit d892487
Show file tree

Hide file tree

Showing 14 changed files with 80 additions and 19 deletions.
diff --git a/include/ignition/fuel_tools/CMakeLists.txt b/include/ignition/fuel_tools/CMakeLists.txt
@@ -1,4 +1 @@
-ign_install_all_headers(
-  EXCLUDE_FILES
-    WorldIterPrivate.hh
-)
+ign_install_all_headers()
diff --git a/include/ignition/fuel_tools/LocalCache.hh b/include/ignition/fuel_tools/LocalCache.hh
@@ -47,7 +47,8 @@ namespace ignition
     {
       /// \brief Constructor
       /// \param[in] _config The configuration for the client
-      public: explicit LocalCache(const ClientConfig *_config);
+      public:
+        explicit IGN_DEPRECATED(5) LocalCache(const ClientConfig *_config);
 
       /// \brief destructor
       public: virtual ~LocalCache();

diff --git a/src/FuelClient.cc b/src/FuelClient.cc
@@ -43,10 +43,10 @@
 #include "ignition/fuel_tools/JSONParser.hh"
 #include "ignition/fuel_tools/LocalCache.hh"
 #include "ignition/fuel_tools/ModelIdentifier.hh"
-#include "ignition/fuel_tools/ModelIterPrivate.hh"
+#include "ModelIterPrivate.hh"
 #include "ignition/fuel_tools/RestClient.hh"
 #include "ignition/fuel_tools/WorldIdentifier.hh"
-#include "ignition/fuel_tools/WorldIterPrivate.hh"
+#include "WorldIterPrivate.hh"
 
 using namespace ignition;
 using namespace fuel_tools;
@@ -208,9 +208,20 @@ FuelClient::FuelClient(const ClientConfig &_config, const Rest &_rest,
   this->dataPtr->rest.SetUserAgent(this->dataPtr->config.UserAgent());
 
   if (nullptr == _cache)
+  {
+#ifndef _WIN32
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
     this->dataPtr->cache.reset(new LocalCache(&(this->dataPtr->config)));
+#ifndef _WIN32
+# pragma GCC diagnostic pop
+#endif
+  }
   else
+  {
     this->dataPtr->cache.reset(_cache);
+  }
 
   this->dataPtr->urlModelRegex.reset(new std::regex(
     this->dataPtr->kModelUrlRegexStr));

diff --git a/src/JSONParser_TEST.cc b/src/JSONParser_TEST.cc
@@ -25,9 +25,9 @@
 #include "ignition/fuel_tools/ClientConfig.hh"
 #include "ignition/fuel_tools/JSONParser.hh"
 #include "ignition/fuel_tools/ModelIter.hh"
-#include "ignition/fuel_tools/ModelIterPrivate.hh"
 #include "ignition/fuel_tools/WorldIter.hh"
-#include "ignition/fuel_tools/WorldIterPrivate.hh"
+#include "ModelIterPrivate.hh"
+#include "WorldIterPrivate.hh"
 
 using namespace ignition;
 using namespace fuel_tools;

diff --git a/src/LocalCache.cc b/src/LocalCache.cc
@@ -35,10 +35,11 @@
 
 #include "ignition/fuel_tools/ClientConfig.hh"
 #include "ignition/fuel_tools/LocalCache.hh"
-#include "ignition/fuel_tools/ModelIterPrivate.hh"
-#include "ignition/fuel_tools/ModelPrivate.hh"
 #include "ignition/fuel_tools/Zip.hh"
-#include "ignition/fuel_tools/WorldIterPrivate.hh"
+
+#include "ModelPrivate.hh"
+#include "ModelIterPrivate.hh"
+#include "WorldIterPrivate.hh"
 
 using namespace ignition;
 using namespace fuel_tools;

diff --git a/src/LocalCache_TEST.cc b/src/LocalCache_TEST.cc
@@ -236,7 +236,14 @@ TEST_F(LocalCacheTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(AllModels))
   createLocal6Models(conf);
   createLocal3Models(conf);
 
+#ifndef _WIN32
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
   ignition::fuel_tools::LocalCache cache(&conf);
+#ifndef _WIN32
+# pragma GCC diagnostic pop
+#endif
 
   auto iter = cache.AllModels();
   std::set<std::string> uniqueNames;
@@ -267,7 +274,14 @@ TEST_F(LocalCacheTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(MatchingModels))
   createLocal6Models(conf);
   createLocal3Models(conf);
 
+#ifndef _WIN32
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
   ignition::fuel_tools::LocalCache cache(&conf);
+#ifndef _WIN32
+# pragma GCC diagnostic pop
+#endif
 
   ModelIdentifier am1;
   am1.SetServer(conf.Servers().front());
@@ -313,7 +327,15 @@ TEST_F(LocalCacheTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(MatchingModel))
   conf.SetCacheLocation(common::joinPaths(common::cwd(), "test_cache"));
   createLocal6Models(conf);
 
+#ifndef _WIN32
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
   ignition::fuel_tools::LocalCache cache(&conf);
+#ifndef _WIN32
+# pragma GCC diagnostic pop
+#endif
+
 
   ignition::fuel_tools::ServerConfig srv1;
   srv1.SetUrl(common::URI("http://localhost:8001/"));
@@ -372,7 +394,15 @@ TEST_F(LocalCacheTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(AllWorlds))
   createLocal6Worlds(conf);
   createLocal3Worlds(conf);
 
+#ifndef _WIN32
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
   ignition::fuel_tools::LocalCache cache(&conf);
+#ifndef _WIN32
+# pragma GCC diagnostic pop
+#endif
+
 
   auto iter = cache.AllWorlds();
   std::set<std::string> uniqueNames;
@@ -403,7 +433,15 @@ TEST_F(LocalCacheTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(MatchingWorlds))
   createLocal6Worlds(conf);
   createLocal3Worlds(conf);
 
+#ifndef _WIN32
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
   ignition::fuel_tools::LocalCache cache(&conf);
+#ifndef _WIN32
+# pragma GCC diagnostic pop
+#endif
+
 
   WorldIdentifier am1;
   am1.SetServer(conf.Servers().front());
@@ -437,7 +475,15 @@ TEST_F(LocalCacheTest, IGN_UTILS_TEST_DISABLED_ON_WIN32(MatchingWorld))
   conf.SetCacheLocation(common::joinPaths(common::cwd(), "test_cache"));
   createLocal6Worlds(conf);
 
+#ifndef _WIN32
+# pragma GCC diagnostic push
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif
   ignition::fuel_tools::LocalCache cache(&conf);
+#ifndef _WIN32
+# pragma GCC diagnostic pop
+#endif
+
 
   ignition::fuel_tools::ServerConfig srv1;
   srv1.SetUrl(ignition::common::URI("http://localhost:8001/"));

diff --git a/src/Model.cc b/src/Model.cc
@@ -20,9 +20,10 @@
 
 #include "ignition/fuel_tools/Model.hh"
 #include "ignition/fuel_tools/ModelIdentifier.hh"
-#include "ignition/fuel_tools/ModelPrivate.hh"
 #include "ignition/fuel_tools/Result.hh"
 
+#include "ModelPrivate.hh"
+
 namespace ignft = ignition::fuel_tools;
 using namespace ignition;
 using namespace ignft;

diff --git a/src/ModelIter.cc b/src/ModelIter.cc
@@ -25,10 +25,11 @@
 #include "ignition/fuel_tools/Model.hh"
 #include "ignition/fuel_tools/ModelIdentifier.hh"
 #include "ignition/fuel_tools/ModelIter.hh"
-#include "ignition/fuel_tools/ModelIterPrivate.hh"
-#include "ignition/fuel_tools/ModelPrivate.hh"
 #include "ignition/fuel_tools/RestClient.hh"
 
+#include "ModelIterPrivate.hh"
+#include "ModelPrivate.hh"
+
 using namespace ignition;
 using namespace fuel_tools;
 

diff --git a/...e/ignition/fuel_tools/ModelIterPrivate.hh → src/ModelIterPrivate.hh b/...e/ignition/fuel_tools/ModelIterPrivate.hh → src/ModelIterPrivate.hh
diff --git a/src/ModelIter_TEST.cc b/src/ModelIter_TEST.cc
@@ -21,8 +21,9 @@
 
 #include "ignition/fuel_tools/ClientConfig.hh"
 #include "ignition/fuel_tools/ModelIter.hh"
-#include "ignition/fuel_tools/ModelIterPrivate.hh"
-#include "ignition/fuel_tools/ModelPrivate.hh"
+
+#include "ModelIterPrivate.hh"
+#include "ModelPrivate.hh"
 
 using namespace ignition;
 using namespace fuel_tools;

diff --git a/include/ignition/fuel_tools/ModelPrivate.hh → src/ModelPrivate.hh b/include/ignition/fuel_tools/ModelPrivate.hh → src/ModelPrivate.hh
diff --git a/src/WorldIter.cc b/src/WorldIter.cc
@@ -24,9 +24,10 @@
 #include "ignition/fuel_tools/JSONParser.hh"
 #include "ignition/fuel_tools/WorldIdentifier.hh"
 #include "ignition/fuel_tools/WorldIter.hh"
-#include "ignition/fuel_tools/WorldIterPrivate.hh"
 #include "ignition/fuel_tools/RestClient.hh"
 
+#include "WorldIterPrivate.hh"
+
 using namespace ignition;
 using namespace fuel_tools;
 

diff --git a/...e/ignition/fuel_tools/WorldIterPrivate.hh → src/WorldIterPrivate.hh b/...e/ignition/fuel_tools/WorldIterPrivate.hh → src/WorldIterPrivate.hh
diff --git a/src/WorldIter_TEST.cc b/src/WorldIter_TEST.cc
@@ -21,7 +21,8 @@
 
 #include "ignition/fuel_tools/ClientConfig.hh"
 #include "ignition/fuel_tools/WorldIter.hh"
-#include "ignition/fuel_tools/WorldIterPrivate.hh"
+
+#include "WorldIterPrivate.hh"
 
 using namespace ignition;
 using namespace fuel_tools;