diff mbox series

Rename condition_variable_any::wait_on_* methods

Message ID xkqetv67cqou.fsf@trodgers.remote.f30
State New
Headers show
Series Rename condition_variable_any::wait_on_* methods | expand

Commit Message

Thomas Rodgers Dec. 11, 2019, 6:38 a.m. UTC
User-agent: mu4e 1.3.4; emacs 26.2
	* include/std/condition_variable
	(condition_variable_any::wait_on(_Lock&, stop_token, _Predicate): Rename
	to match current draft standard.
	(condition_variable_any::wait_on_until(_Lock&, stop_token,
	const chrono::time_point<>&, _Predicate): Likewise.
	(condition_variable_any::wait_on_for(_Lock&, stop_token,
	const chrono::duration<>&, _Predicate(: Likewise.
	* testsuite/30_threads/condition_variable_any/stop_token/wait_on.cc (main):
	Adjust tests to account for renamed methods.
---
 libstdc++-v3/include/std/condition_variable   | 30 +++++++++----------
 .../stop_token/wait_on.cc                     | 22 +++++++-------
 2 files changed, 26 insertions(+), 26 deletions(-)

Comments

Jonathan Wakely Dec. 11, 2019, 10:41 a.m. UTC | #1
On 10/12/19 22:38 -0800, Thomas Rodgers wrote:
>User-agent: mu4e 1.3.4; emacs 26.2
>	* include/std/condition_variable
>	(condition_variable_any::wait_on(_Lock&, stop_token, _Predicate): Rename
>	to match current draft standard.
>	(condition_variable_any::wait_on_until(_Lock&, stop_token,
>	const chrono::time_point<>&, _Predicate): Likewise.
>	(condition_variable_any::wait_on_for(_Lock&, stop_token,
>	const chrono::duration<>&, _Predicate(: Likewise.

The closing paren here is an opening one. OK for trunk with that
fixed.

Optional tweaks ...

Since the names wait_on, wait_on_until and wait_on_for are
unambiguous, you could just list them without parameters i.e.

	* include/std/condition_variable (condition_variable_any::wait_on)
        (condition_variable_any::wait_on_until)
        (condition_variable_any::wait_on_for): Rename to match current
        draft standard.

>	* testsuite/30_threads/condition_variable_any/stop_token/wait_on.cc (main):

We don't generally both to say which functions were modified in tests,
so the (main) isn't needed here, but is harmless.

>	Adjust tests to account for renamed methods.
Thomas Rodgers Jan. 8, 2020, 3:11 a.m. UTC | #2
Tested x86_64-pc-linux-gnu, committed to trunk.

Jonathan Wakely writes:

> On 10/12/19 22:38 -0800, Thomas Rodgers wrote:
>>User-agent: mu4e 1.3.4; emacs 26.2
>>	* include/std/condition_variable
>>	(condition_variable_any::wait_on(_Lock&, stop_token, _Predicate): Rename
>>	to match current draft standard.
>>	(condition_variable_any::wait_on_until(_Lock&, stop_token,
>>	const chrono::time_point<>&, _Predicate): Likewise.
>>	(condition_variable_any::wait_on_for(_Lock&, stop_token,
>>	const chrono::duration<>&, _Predicate(: Likewise.
>
> The closing paren here is an opening one. OK for trunk with that
> fixed.
>
> Optional tweaks ...
>
> Since the names wait_on, wait_on_until and wait_on_for are
> unambiguous, you could just list them without parameters i.e.
>
> 	* include/std/condition_variable (condition_variable_any::wait_on)
>        (condition_variable_any::wait_on_until)
>        (condition_variable_any::wait_on_for): Rename to match current
>        draft standard.
>
>>	* testsuite/30_threads/condition_variable_any/stop_token/wait_on.cc (main):
>
> We don't generally both to say which functions were modified in tests,
> so the (main) isn't needed here, but is harmless.
>
>>	Adjust tests to account for renamed methods.
diff mbox series

Patch

diff --git a/libstdc++-v3/include/std/condition_variable b/libstdc++-v3/include/std/condition_variable
index 8887cee29fa..3346a28e5dd 100644
--- a/libstdc++-v3/include/std/condition_variable
+++ b/libstdc++-v3/include/std/condition_variable
@@ -369,9 +369,9 @@  _GLIBCXX_BEGIN_NAMESPACE_VERSION
 
 #ifdef __cpp_lib_jthread
     template <class _Lock, class _Predicate>
-    bool wait_on(_Lock& __lock,
-                 stop_token __stoken,
-                 _Predicate __p)
+    bool wait(_Lock& __lock,
+              stop_token __stoken,
+              _Predicate __p)
     {
       if (__stoken.stop_requested())
         {
@@ -397,10 +397,10 @@  _GLIBCXX_BEGIN_NAMESPACE_VERSION
     }
 
     template <class _Lock, class _Clock, class _Duration, class _Predicate>
-    bool wait_on_until(_Lock& __lock,
-                       stop_token __stoken,
-                       const chrono::time_point<_Clock, _Duration>& __abs_time,
-                       _Predicate __p)
+    bool wait_until(_Lock& __lock,
+                    stop_token __stoken,
+                    const chrono::time_point<_Clock, _Duration>& __abs_time,
+                    _Predicate __p)
     {
       if (__stoken.stop_requested())
         {
@@ -432,16 +432,16 @@  _GLIBCXX_BEGIN_NAMESPACE_VERSION
     }
 
     template <class _Lock, class _Rep, class _Period, class _Predicate>
-    bool wait_on_for(_Lock& __lock,
-                     stop_token __stoken,
-                     const chrono::duration<_Rep, _Period>& __rel_time,
-                     _Predicate __p)
+    bool wait_for(_Lock& __lock,
+                  stop_token __stoken,
+                  const chrono::duration<_Rep, _Period>& __rel_time,
+                  _Predicate __p)
     {
       auto __abst = std::chrono::steady_clock::now() + __rel_time;
-      return wait_on_until(__lock,
-                           std::move(__stoken),
-                           __abst,
-                           std::move(__p));
+      return wait_until(__lock,
+                        std::move(__stoken),
+                        __abst,
+                        std::move(__p));
     }
 #endif
   };
diff --git a/libstdc++-v3/testsuite/30_threads/condition_variable_any/stop_token/wait_on.cc b/libstdc++-v3/testsuite/30_threads/condition_variable_any/stop_token/wait_on.cc
index 212fc949b3f..636425b43fc 100644
--- a/libstdc++-v3/testsuite/30_threads/condition_variable_any/stop_token/wait_on.cc
+++ b/libstdc++-v3/testsuite/30_threads/condition_variable_any/stop_token/wait_on.cc
@@ -28,7 +28,7 @@ 
 
 using namespace::std::literals;
 
-void test_wait_on_stop()
+void test_wait_stop()
 {
   bool ready = false;
   std::mutex mtx;
@@ -40,7 +40,7 @@  void test_wait_on_stop()
   std::thread t([&ready, &mtx, &cv, tok]
                 {
                   std::unique_lock lck(mtx);
-                  auto res = cv.wait_on(lck, tok, [&ready] { return ready; });
+                  auto res = cv.wait(lck, tok, [&ready] { return ready; });
                   if (!res)
                     {
                       VERIFY(tok.stop_requested());
@@ -54,7 +54,7 @@  void test_wait_on_stop()
   VERIFY(src.stop_requested());
 }
 
-void test_wait_on_until(bool ck = true)
+void test_wait_until(bool ck = true)
 {
   bool ready = false;
   std::mutex mtx;
@@ -67,7 +67,7 @@  void test_wait_on_until(bool ck = true)
   std::thread t([ck, &ready, &mtx, &cv, abst, tok]
                 {
                   std::unique_lock lck(mtx);
-                  auto res = cv.wait_on_until(lck, tok, abst, [&ready] { return ready; });
+                  auto res = cv.wait_until(lck, tok, abst, [&ready] { return ready; });
                   if (!res && ck)
                     {
                       VERIFY(tok.stop_requested());
@@ -90,7 +90,7 @@  void test_wait_on_until(bool ck = true)
     }
 }
 
-void test_wait_on_for(bool ck = true)
+void test_wait_for(bool ck = true)
 {
   bool ready = false;
   std::mutex mtx;
@@ -102,7 +102,7 @@  void test_wait_on_for(bool ck = true)
   std::thread t([ck, &ready, &mtx, &cv, tok]
                 {
                   std::unique_lock lck(mtx);
-                  auto res = cv.wait_on_for(lck, tok, 1.0s, [&ready] { return ready; });
+                  auto res = cv.wait_for(lck, tok, 1.0s, [&ready] { return ready; });
                   if (!res && ck)
                     {
                       VERIFY(tok.stop_requested());
@@ -127,10 +127,10 @@  void test_wait_on_for(bool ck = true)
 
 int main()
 {
-  test_wait_on_stop();
-  test_wait_on_until(false);
-  test_wait_on_until();
-  test_wait_on_for();
-  test_wait_on_for(false);
+  test_wait_stop();
+  test_wait_until(false);
+  test_wait_until();
+  test_wait_for();
+  test_wait_for(false);
   return 0;
 }