[PATCH] Add recursive_directory_iterator::pop(error_code&)

[PATCH] Add recursive_directory_iterator::pop(error_code&)

[Jonathan Wakely]

[-- Attachment #1: Type: text/plain, Size: 342 bytes --]

Another Filesystem TS change, implementing LWG 2706.

	* include/experimental/bits/fs_dir.h (recursive_directory_iterator):
	Overload pop (LWG 2706).
	* src/filesystem/dir.cc (recursive_directory_iterator::pop): Define
	new overload.
	* testsuite/experimental/filesystem/iterators/pop.cc: New test.

Tested x86_64-linux, committed to trunk.


[-- Attachment #2: patch.txt --]
[-- Type: text/plain, Size: 5480 bytes --]

commit aee4c6e7734b41b23d199c0c23ffc4e7fb1ccf8f
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Thu Oct 20 19:48:41 2016 +0100

    Add recursive_directory_iterator::pop(error_code&)
    
    	* include/experimental/bits/fs_dir.h (recursive_directory_iterator):
    	Overload pop (LWG 2706).
    	* src/filesystem/dir.cc (recursive_directory_iterator::pop): Define
    	new overload.
    	* testsuite/experimental/filesystem/iterators/pop.cc: New test.

diff --git a/libstdc++-v3/include/experimental/bits/fs_dir.h b/libstdc++-v3/include/experimental/bits/fs_dir.h
index 70a95eb..818e7ff 100644
--- a/libstdc++-v3/include/experimental/bits/fs_dir.h
+++ b/libstdc++-v3/include/experimental/bits/fs_dir.h
@@ -312,6 +312,7 @@ _GLIBCXX_BEGIN_NAMESPACE_CXX11
     }
 
     void pop();
+    void pop(error_code&);
 
     void disable_recursion_pending() { _M_pending = false; }
 
diff --git a/libstdc++-v3/src/filesystem/dir.cc b/libstdc++-v3/src/filesystem/dir.cc
index bcd7dd0..9a63c4a 100644
--- a/libstdc++-v3/src/filesystem/dir.cc
+++ b/libstdc++-v3/src/filesystem/dir.cc
@@ -364,19 +364,33 @@ fs::recursive_directory_iterator::increment(error_code& ec) noexcept
 }
 
 void
-fs::recursive_directory_iterator::pop()
+fs::recursive_directory_iterator::pop(error_code& ec)
 {
   if (!_M_dirs)
-    _GLIBCXX_THROW_OR_ABORT(filesystem_error(
-	  "cannot pop non-dereferenceable recursive directory iterator",
-	  std::make_error_code(errc::invalid_argument)));
+    {
+      ec = std::make_error_code(errc::invalid_argument);
+      return;
+    }
 
   do {
     _M_dirs->pop();
     if (_M_dirs->empty())
       {
 	_M_dirs.reset();
+	ec.clear();
 	return;
       }
-  } while (!_M_dirs->top().advance(nullptr, _M_options));
+  } while (!_M_dirs->top().advance(&ec, _M_options));
+}
+
+void
+fs::recursive_directory_iterator::pop()
+{
+  error_code ec;
+  pop(ec);
+  if (ec)
+    _GLIBCXX_THROW_OR_ABORT(filesystem_error(_M_dirs
+	  ? "recursive directory iterator cannot pop"
+	  : "non-dereferenceable recursive directory iterator cannot pop",
+	  ec));
 }
diff --git a/libstdc++-v3/testsuite/experimental/filesystem/iterators/pop.cc b/libstdc++-v3/testsuite/experimental/filesystem/iterators/pop.cc
new file mode 100644
index 0000000..fa1ae62
--- /dev/null
+++ b/libstdc++-v3/testsuite/experimental/filesystem/iterators/pop.cc
@@ -0,0 +1,115 @@
+// Copyright (C) 2016 Free Software Foundation, Inc.
+//
+// This file is part of the GNU ISO C++ Library.  This library is free
+// software; you can redistribute it and/or modify it under the
+// terms of the GNU General Public License as published by the
+// Free Software Foundation; either version 3, or (at your option)
+// any later version.
+
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License along
+// with this library; see the file COPYING3.  If not see
+// <http://www.gnu.org/licenses/>.
+
+// { dg-options "-lstdc++fs" }
+// { dg-do run { target c++11 } }
+// { dg-require-filesystem-ts "" }
+
+#include <experimental/filesystem>
+#include <testsuite_hooks.h>
+#include <testsuite_fs.h>
+
+namespace fs = std::experimental::filesystem;
+
+void
+test01()
+{
+  std::error_code ec;
+  fs::recursive_directory_iterator dir;
+  dir.pop(ec);  // This is undefined, but our implementation
+  VERIFY( ec ); // checks and returns an error.
+  VERIFY( dir == end(dir) );
+
+  std::error_code ec2;
+  try
+  {
+    dir.pop();
+  }
+  catch (const fs::filesystem_error& ex)
+  {
+    ec2 = ex.code();
+  }
+  VERIFY( ec2 == ec );
+}
+
+void
+test02()
+{
+  std::error_code ec = make_error_code(std::errc::interrupted);
+  const auto p = __gnu_test::nonexistent_path();
+  create_directories(p / "d1/d2/d3");
+  for (int i = 0; i < 3; ++i)
+  {
+    fs::recursive_directory_iterator dir(p);
+    std::advance(dir, i);
+    VERIFY( dir.depth() == i );
+    dir.pop(ec);
+    VERIFY( !ec );
+    VERIFY( dir == end(dir) );
+
+    dir = fs::recursive_directory_iterator(p);
+    std::advance(dir, i);
+    VERIFY( dir.depth() == i );
+    dir.pop();
+    VERIFY( dir == end(dir) );
+  }
+  remove_all(p, ec);
+}
+
+void
+test03()
+{
+  std::error_code ec = make_error_code(std::errc::interrupted);
+  const auto p = __gnu_test::nonexistent_path();
+  create_directories(p / "d1/d2/d3");
+  create_directories(p / "d1/d2/e3");
+  create_directories(p / "d1/e2/d3");
+  create_directories(p / "e1");
+  __gnu_test::scoped_file f(p / "d1/d2/d3/f");
+  for (int i = 0; i < 4; ++i)
+  {
+    fs::recursive_directory_iterator dir(p);
+    std::advance(dir, i);
+    int expected_depth = std::min(i, 3); // fourth entry is a file, not dir
+    VERIFY( dir.depth() == expected_depth );
+    __builtin_printf("%d %d %s\n", i, dir.depth(), dir->path().c_str());
+    dir.pop(ec);
+    VERIFY( !ec );
+    if (dir != end(dir))
+    {
+    __builtin_printf("%d %d %s\n", i, dir.depth(), dir->path().c_str());
+      VERIFY( dir.depth() == (expected_depth - 1) );
+    }
+
+    dir = fs::recursive_directory_iterator(p);
+    std::advance(dir, i);
+    VERIFY( dir.depth() == i );
+    dir.pop();
+    if (dir != end(dir))
+      VERIFY( dir.depth() == (i -1) );
+  }
+  f.path.clear();
+  remove_all(p, ec);
+}
+
+int
+main()
+{
+  test01();
+  test02();
+  test03();
+}

Re: [PATCH] Add recursive_directory_iterator::pop(error_code&)

[Jonathan Wakely]

[-- Attachment #1: Type: text/plain, Size: 484 bytes --]

On 26/10/16 16:19 +0100, Jonathan Wakely wrote:
>Another Filesystem TS change, implementing LWG 2706.
>
>	* include/experimental/bits/fs_dir.h (recursive_directory_iterator):
>	Overload pop (LWG 2706).
>	* src/filesystem/dir.cc (recursive_directory_iterator::pop): Define
>	new overload.
>	* testsuite/experimental/filesystem/iterators/pop.cc: New test.
>

This new test isn't reliable, it depends on directory order. This
simplifies it so it behaves reliably.

Committed to trunk.



[-- Attachment #2: patch.txt --]
[-- Type: text/x-patch, Size: 1373 bytes --]

commit a16b18039731f450dfb4a8c4fff8db8b8da41817
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Wed Oct 26 16:31:19 2016 +0100

    Fix test for recursive_directory_iterator::pop
    
    	* testsuite/experimental/filesystem/iterators/pop.cc: Remove
    	unreliable dependency on directory order.

diff --git a/libstdc++-v3/testsuite/experimental/filesystem/iterators/pop.cc b/libstdc++-v3/testsuite/experimental/filesystem/iterators/pop.cc
index fa1ae62..d247ab4 100644
--- a/libstdc++-v3/testsuite/experimental/filesystem/iterators/pop.cc
+++ b/libstdc++-v3/testsuite/experimental/filesystem/iterators/pop.cc
@@ -78,13 +78,11 @@ test03()
   create_directories(p / "d1/d2/d3");
   create_directories(p / "d1/d2/e3");
   create_directories(p / "d1/e2/d3");
-  create_directories(p / "e1");
-  __gnu_test::scoped_file f(p / "d1/d2/d3/f");
-  for (int i = 0; i < 4; ++i)
+  for (int i = 0; i < 3; ++i)
   {
     fs::recursive_directory_iterator dir(p);
     std::advance(dir, i);
-    int expected_depth = std::min(i, 3); // fourth entry is a file, not dir
+    int expected_depth = i;
     VERIFY( dir.depth() == expected_depth );
     __builtin_printf("%d %d %s\n", i, dir.depth(), dir->path().c_str());
     dir.pop(ec);
@@ -102,7 +100,6 @@ test03()
     if (dir != end(dir))
       VERIFY( dir.depth() == (i -1) );
   }
-  f.path.clear();
   remove_all(p, ec);
 }