Move from poco::file to std::filesystem

peterfpeterson · peterfpeterson · commit 181925fb23fa · 2024-08-23T11:10:46.000-04:00
diff --git a/Framework/Kernel/inc/MantidKernel/BinaryFile.h b/Framework/Kernel/inc/MantidKernel/BinaryFile.h
@@ -8,8 +8,7 @@
 
 #include "MantidKernel/DllConfig.h"
 
-#include <Poco/File.h>
-#include <Poco/Path.h>
+#include <filesystem>
 #include <fstream>
 #include <memory>
 #include <string>
@@ -49,7 +48,7 @@ template <typename T> class DLLExport BinaryFile {
 
   //------------------------------------------------------------------------------------
   /// Constructor - open a file
-  BinaryFile(std::string filename) { this->open(filename); }
+  BinaryFile(const std::string &filename) { this->open(filename); }
 
   /// Destructor, close the file if needed
   ~BinaryFile() { this->close(); }
@@ -63,7 +62,7 @@ template <typename T> class DLLExport BinaryFile {
    * */
   void open(const std::string &filename) {
     this->handle.reset(nullptr);
-    if (!Poco::File(filename).exists()) {
+    if (!std::filesystem::exists(filename)) {
       std::stringstream msg;
       msg << "BinaryFile::open: File " << filename << " was not found.";
       throw std::invalid_argument("File does not exist.");
diff --git a/Framework/Kernel/src/AttenuationProfile.cpp b/Framework/Kernel/src/AttenuationProfile.cpp
@@ -8,8 +8,8 @@
 #include "MantidKernel/ConfigService.h"
 #include "MantidKernel/Exception.h"
 #include "MantidKernel/Material.h"
-#include <Poco/File.h>
 #include <Poco/Path.h>
+#include <filesystem>
 #include <fstream>
 
 namespace Mantid::Kernel {
@@ -37,7 +37,7 @@ AttenuationProfile::AttenuationProfile(const std::string &inputFileName, const s
 
       if (!searchPath.empty()) {
         inputFilePath = Poco::Path(Poco::Path(searchPath).parent(), inputFileName);
-        if (Poco::File(inputFilePath).exists()) {
+        if (std::filesystem::exists(inputFilePath.toString())) {
           useSearchDirectories = false;
         }
       }
diff --git a/Framework/Kernel/src/DirectoryValidator.cpp b/Framework/Kernel/src/DirectoryValidator.cpp
@@ -7,8 +7,8 @@
 #include "MantidKernel/DirectoryValidator.h"
 #include "MantidKernel/IValidator.h"
 #include <Poco/Exception.h>
-#include <Poco/File.h>
 #include <Poco/Path.h>
+#include <filesystem>
 #include <memory>
 
 namespace Mantid::Kernel {
@@ -44,12 +44,14 @@ std::string DirectoryValidator::checkValidity(const std::string &value) const {
   // If the path is required to exist check it is there
   if (m_testExist) {
     try {
-      if (value.empty() || !Poco::File(value).exists())
+      if (value.empty() || !std::filesystem::exists(value))
         return "Directory \"" + value + "\" not found";
-      if (!Poco::File(value).isDirectory())
+      if (!std::filesystem::is_directory(value))
         return "Directory \"" + value + "\" specified is actually a file";
     } catch (Poco::FileException &) {
       return "Error accessing directory \"" + value + "\"";
+    } catch (const std::filesystem::filesystem_error &) {
+      return "Error accessing directory \"" + value + "\"";
     }
   }
 
diff --git a/Framework/Kernel/src/FileDescriptor.cpp b/Framework/Kernel/src/FileDescriptor.cpp
@@ -7,8 +7,8 @@
 #include "MantidKernel/FileDescriptor.h"
 #include "MantidKernel/Strings.h"
 
-#include <Poco/File.h>
 #include <Poco/Path.h>
+#include <filesystem>
 
 #include <stdexcept>
 
@@ -131,7 +131,7 @@ FileDescriptor::FileDescriptor(const std::string &filename) : m_filename(), m_ex
   if (filename.empty()) {
     throw std::invalid_argument("FileDescriptor() - Empty filename '" + filename + "'");
   }
-  if (!Poco::File(filename).exists()) {
+  if (!std::filesystem::exists(filename)) {
     throw std::invalid_argument("FileDescriptor() - File '" + filename + "' does not exist");
   }
   initialize(filename);
diff --git a/Framework/Kernel/src/FileValidator.cpp b/Framework/Kernel/src/FileValidator.cpp
@@ -6,9 +6,9 @@
 // SPDX - License - Identifier: GPL - 3.0 +
 #include "MantidKernel/FileValidator.h"
 #include "MantidKernel/Logger.h"
-#include <Poco/File.h>
 #include <Poco/Path.h>
 #include <boost/algorithm/string/case_conv.hpp>
+#include <filesystem>
 #include <fstream>
 #include <memory>
 #include <sstream>
@@ -81,11 +81,11 @@ std::string FileValidator::checkValidity(const std::string &value) const {
   }
 
   // If the file is required to exist check it is there
-  if (m_testExist && (value.empty() || !Poco::File(value).exists())) {
+  if (m_testExist && (value.empty() || !std::filesystem::exists(value))) {
     return "File \"" + abspath + "\" not found";
   }
 
-  if (m_testExist && (Poco::File(value).exists())) {
+  if (m_testExist && (std::filesystem::exists(value))) {
     std::ifstream in;
     in.open(value.c_str());
     if (!in) {
diff --git a/Framework/Kernel/src/NexusDescriptor.cpp b/Framework/Kernel/src/NexusDescriptor.cpp
@@ -11,7 +11,7 @@
 #include <nexus/NeXusException.hpp>
 // clang-format on
 
-#include <Poco/File.h>
+#include <filesystem>
 #include <Poco/Path.h>
 
 #include <algorithm>
@@ -115,7 +115,7 @@ NexusDescriptor::NexusDescriptor(const std::string &filename, const bool init)
   if (filename.empty()) {
     throw std::invalid_argument("NexusDescriptor() - Empty filename '" + filename + "'");
   }
-  if (!Poco::File(filename).exists()) {
+  if (!std::filesystem::exists(filename)) {
     throw std::invalid_argument("NexusDescriptor() - File '" + filename + "' does not exist");
   }
 
diff --git a/Framework/Kernel/test/BinaryFileTest.h b/Framework/Kernel/test/BinaryFileTest.h
@@ -14,7 +14,6 @@
 
 using namespace Mantid::Kernel;
 
-using std::cout;
 using std::runtime_error;
 using std::size_t;
 using std::vector;
@@ -67,7 +66,7 @@ class BinaryFileTest : public CxxTest::TestSuite {
     MakeDummyFile(dummy_file, 3);
     TS_ASSERT_THROWS(file.open(dummy_file), const std::runtime_error &);
     file.close();
-    Poco::File(dummy_file).remove();
+    std::filesystem::remove(dummy_file);
   }
 
   void testOpen() {
@@ -90,7 +89,7 @@ class BinaryFileTest : public CxxTest::TestSuite {
     TS_ASSERT_EQUALS(data.at(num - 1).pid, 39);
 
     file.close();
-    Poco::File(dummy_file).remove();
+    std::filesystem::remove(dummy_file);
   }
 
   void testLoadAllIntoVector() {
@@ -111,7 +110,7 @@ class BinaryFileTest : public CxxTest::TestSuite {
     TS_ASSERT_EQUALS(data.at(num - 1).tof, 38);
     TS_ASSERT_EQUALS(data.at(num - 1).pid, 39);
     file.close();
-    Poco::File(dummy_file).remove();
+    std::filesystem::remove(dummy_file);
   }
 
   void testLoadInBlocks() {
@@ -142,7 +141,7 @@ class BinaryFileTest : public CxxTest::TestSuite {
     TS_ASSERT_EQUALS(data[9].tof, 38);
     TS_ASSERT_EQUALS(data[9].pid, 39);
     file.close();
-    Poco::File(dummy_file).remove();
+    std::filesystem::remove(dummy_file);
   }
 
   void testLoadBlockAt() {
@@ -169,7 +168,7 @@ class BinaryFileTest : public CxxTest::TestSuite {
     loaded_size = file.loadBlock(data.get(), block_size);
     TS_ASSERT_EQUALS(loaded_size, 5);
     file.close();
-    Poco::File(dummy_file).remove();
+    std::filesystem::remove(dummy_file);
   }
 
   void testCallingDestructorOnUnitializedObject() { BinaryFile<DasEvent> file2; }
diff --git a/Framework/Kernel/test/ChecksumHelperTest.h b/Framework/Kernel/test/ChecksumHelperTest.h
@@ -9,8 +9,8 @@
 #include "MantidKernel/ChecksumHelper.h"
 #include "MantidKernel/System.h"
 
-#include <Poco/File.h>
 #include <cxxtest/TestSuite.h>
+#include <filesystem>
 #include <fstream>
 
 using namespace Mantid::Kernel;
@@ -42,7 +42,7 @@ class ChecksumHelperTest : public CxxTest::TestSuite {
     std::string response = ChecksumHelper::sha1FromFile(filename, false);
     TSM_ASSERT_EQUALS("The calculated SHA-1 hash is not as expected", "363cbe9c113b8bcba9e0aa94dbe45e67856ff26b",
                       response);
-    Poco::File(filename).remove();
+    std::filesystem::remove(filename);
   }
 
   void testGitSha1FromFile() {
@@ -54,7 +54,7 @@ class ChecksumHelperTest : public CxxTest::TestSuite {
     std::string response = ChecksumHelper::gitSha1FromFile(filename);
     TSM_ASSERT_EQUALS("The calculated git-hash is not as expected", "db46957d5afdb266b4b3321f3ce2b8887f190ff5",
                       response);
-    Poco::File(filename).remove();
+    std::filesystem::remove(filename);
   }
 
   void testGitSha1FromFileWithLinuxLineEndings() {
@@ -67,7 +67,7 @@ class ChecksumHelperTest : public CxxTest::TestSuite {
     std::string response = ChecksumHelper::gitSha1FromFile(filename);
     TSM_ASSERT_EQUALS("The calculated git-hash is not as expected", "7e78655a4e48aa2fbd4a3f1aec4043009e342e31",
                       response);
-    Poco::File(filename).remove();
+    std::filesystem::remove(filename);
   }
 
   void testGitSha1FromFileWithWindowsLineEndingsFirstConvertsToLF() {
@@ -80,7 +80,7 @@ class ChecksumHelperTest : public CxxTest::TestSuite {
     std::string response = ChecksumHelper::gitSha1FromFile(filename);
     TSM_ASSERT_EQUALS("The calculated git-hash is not as expected", "23dcaeaefce51ed7cae98f6420f67e0ba0e2058a",
                       response);
-    Poco::File(filename).remove();
+    std::filesystem::remove(filename);
   }
 
   void testGitSha1FromFileWithOldStyleMacLineEndingsDoesNotConvertToLF() {
@@ -93,7 +93,7 @@ class ChecksumHelperTest : public CxxTest::TestSuite {
     std::string response = ChecksumHelper::gitSha1FromFile(filename);
     TSM_ASSERT_EQUALS("The calculated git-hash is not as expected", "7b7e77332c1610df14fd26476d1601a22a34f11f",
                       response);
-    Poco::File(filename).remove();
+    std::filesystem::remove(filename);
   }
 
   void createFile(const std::string &fileName, const std::string &data) {
diff --git a/Framework/Kernel/test/DirectoryValidatorTest.h b/Framework/Kernel/test/DirectoryValidatorTest.h
@@ -10,6 +10,8 @@
 
 #include "MantidKernel/DirectoryValidator.h"
 #include <Poco/File.h>
+#include <filesystem>
+#include <fstream>
 
 using namespace Mantid::Kernel;
 
@@ -24,10 +26,12 @@ class DirectoryValidatorTest : public CxxTest::TestSuite {
   void testFailsOnAFile() {
     DirectoryValidator v(true);
     std::string ThisIsAFile("directoryvalidatortestfile.txt");
-    Poco::File txt_file(ThisIsAFile);
-    txt_file.createFile();
+
+    std::filesystem::path txt_file(ThisIsAFile);
+    std::ofstream handle(txt_file);
+    handle.close();
     TS_ASSERT_EQUALS(v.isValid(ThisIsAFile), "Directory \"" + ThisIsAFile + "\" specified is actually a file");
-    txt_file.remove();
+    std::filesystem::remove(txt_file);
   }
 
   void testPassesOnNonexistentDirectoryIfYouSaySoForSomeReason() {
@@ -38,10 +42,10 @@ class DirectoryValidatorTest : public CxxTest::TestSuite {
 
   void testPassesOnExistingDirectory() {
     std::string TestDir("./MyTestFolder");
-    Poco::File dir(TestDir);
-    dir.createDirectory();
+    std::filesystem::path dir(TestDir);
+    TS_ASSERT(std::filesystem::create_directory(dir));
     DirectoryValidator v(true);
     TS_ASSERT_EQUALS(v.isValid(TestDir), "");
-    dir.remove(); // clean up your folder
+    std::filesystem::remove(dir); // clean up your folder
   }
 };
diff --git a/Framework/Kernel/test/FileDescriptorTest.h b/Framework/Kernel/test/FileDescriptorTest.h
@@ -12,8 +12,8 @@
 #include "MantidKernel/ConfigService.h"
 #include "MantidKernel/FileDescriptor.h"
 
-#include <Poco/File.h>
 #include <Poco/Path.h>
+#include <filesystem>
 
 using Mantid::Kernel::FileDescriptor;
 
@@ -30,16 +30,16 @@ class FileDescriptorTest : public CxxTest::TestSuite {
     const auto &dataPaths = cfg.getDataSearchDirs();
     for (const auto &dataPath : dataPaths) {
       Poco::Path nxsPath(dataPath, "CNCS_7860_event.nxs");
-      if (Poco::File(nxsPath).exists())
+      if (std::filesystem::exists(nxsPath.toString()))
         m_testNexusPath = nxsPath.toString();
       Poco::Path nonNxsPath(dataPath, "CSP79590.raw");
-      if (Poco::File(nonNxsPath).exists())
+      if (std::filesystem::exists(nonNxsPath.toString()))
         m_testNonNexusPath = nonNxsPath.toString();
       Poco::Path asciiPath(dataPath, "AsciiExample.txt");
-      if (Poco::File(asciiPath).exists())
+      if (std::filesystem::exists(asciiPath.toString()))
         m_testAsciiPath = asciiPath.toString();
       Poco::Path emptyFilePath(dataPath, "emptyFile.txt");
-      if (Poco::File(emptyFilePath).exists())
+      if (std::filesystem::exists(emptyFilePath.toString()))
         m_emptyFilePath = emptyFilePath.toString();
 
       if (!m_testNexusPath.empty() && !m_testNonNexusPath.empty() && !m_testAsciiPath.empty() &&
diff --git a/Framework/Kernel/test/GlobTest.h b/Framework/Kernel/test/GlobTest.h
@@ -11,8 +11,9 @@
 #include "MantidKernel/ConfigService.h"
 #include "MantidKernel/Glob.h"
 
-#include <Poco/File.h>
 #include <Poco/Path.h>
+#include <filesystem>
+#include <fstream>
 
 using namespace Mantid::Kernel;
 
@@ -74,22 +75,29 @@ class GlobTest : public CxxTest::TestSuite {
   }
 
   void test_match_relative_path() {
+    std::filesystem::path testDir("GlobTestDir");
+    TS_ASSERT(std::filesystem::create_directory(testDir));
 
-    Poco::File testDir("GlobTestDir");
-    testDir.createDirectory();
-    Poco::File file1("GlobTestDir/File.1");
-    file1.createFile();
-    Poco::File file2("GlobTestDir/File.2");
-    file2.createFile();
+    std::filesystem::path file1("GlobTestDir/File.1");
+    {
+      std::ofstream handle(file1);
+      handle.close();
+    }
+
+    std::filesystem::path file2("GlobTestDir/File.2");
+    {
+      std::ofstream handle(file2);
+      handle.close();
+    }
 
     std::string pattern = "GlobTestDir/File.*";
 
     std::set<std::string> files;
     Glob::glob(pattern, files);
     TS_ASSERT_EQUALS(files.size(), 2);
-    file1.remove();
-    file2.remove();
-    testDir.remove();
+    std::filesystem::remove(file1);
+    std::filesystem::remove(file2);
+    std::filesystem::remove(testDir);
   }
 
   void test_double_dots_in_pattern() {
diff --git a/Framework/Kernel/test/LogParserTest.h b/Framework/Kernel/test/LogParserTest.h
@@ -17,8 +17,9 @@
 
 #include <boost/lexical_cast.hpp>
 
-#include <Poco/File.h>
+#include <filesystem>
 
+using namespace std;
 using namespace Mantid::Kernel;
 using namespace Mantid::Types::Core;
 
@@ -28,16 +29,16 @@ class LogParserTest : public CxxTest::TestSuite {
   static void destroySuite(LogParserTest *suite) { delete suite; }
 
   class TmpFile {
-    Poco::File m_file;
+    filesystem::path m_file;
 
   public:
     TmpFile(const std::string &fname) : m_file(fname) {}
     ~TmpFile() { remove(); }
-    const std::string &path() const { return m_file.path(); }
-    bool exists() const { return m_file.exists(); }
+    const std::string path() const { return m_file.string(); }
+    bool exists() const { return filesystem::exists(m_file); }
     void remove() {
-      if (m_file.exists())
-        m_file.remove();
+      if (filesystem::exists(m_file))
+        filesystem::remove(m_file);
     }
   };
 
diff --git a/Framework/Kernel/test/LoggerTest.h b/Framework/Kernel/test/LoggerTest.h
diff --git a/Framework/Kernel/test/NexusDescriptorTest.h b/Framework/Kernel/test/NexusDescriptorTest.h
diff --git a/Framework/Kernel/test/NexusHDF5DescriptorTest.h b/Framework/Kernel/test/NexusHDF5DescriptorTest.h
diff --git a/buildconfig/CMake/CppCheck_Suppressions.txt.in b/buildconfig/CMake/CppCheck_Suppressions.txt.in

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`#include <nexus/NeXusException.hpp>`
`12`	`12`	`// clang-format on`
`13`	`13`
`14`		`-#include <Poco/File.h>`
	`14`	`+#include <filesystem>`
`15`	`15`	`#include <Poco/Path.h>`
`16`	`16`
`17`	`17`	`#include <algorithm>`
`@@ -115,7 +115,7 @@ NexusDescriptor::NexusDescriptor(const std::string &filename, const bool init)`
`115`	`115`	`if (filename.empty()) {`
`116`	`116`	`throw std::invalid_argument("NexusDescriptor() - Empty filename '" + filename + "'");`
`117`	`117`	`}`
`118`		`- if (!Poco::File(filename).exists()) {`
	`118`	`+ if (!std::filesystem::exists(filename)) {`
`119`	`119`	`throw std::invalid_argument("NexusDescriptor() - File '" + filename + "' does not exist");`
`120`	`120`	`}`
`121`	`121`