[thread.lock.shared] Exposition-only style for pm and owns

Author: frederick-vs-ja

source/threads.tex

@@ -8853,8 +8853,8 @@
     mutex_type* mutex() const noexcept;
 
   private:
-    mutex_type* pm;                             // \expos
-    bool owns;                                  // \expos
+    mutex_type* @\exposid{pm}@;                             // \expos
+    bool @\exposid{owns}@;                                  // \expos
   };
 }
 \end{codeblock}
@@ -8865,8 +8865,8 @@
 acquired at construction or after construction, and may be transferred, after
 acquisition, to another \tcode{shared_lock} object. Objects of type
 \tcode{shared_lock} are not copyable but are movable. The behavior of a program
-is undefined if the contained pointer \tcode{pm} is not null and the lockable
-object pointed to by \tcode{pm} does not exist for the entire remaining
+is undefined if the contained pointer \exposid{pm} is not null and the lockable
+object pointed to by \exposid{pm} does not exist for the entire remaining
 lifetime\iref{basic.life} of the \tcode{shared_lock} object. The supplied
 \tcode{Mutex} type shall meet the \oldconcept{SharedLockable}
 requirements\iref{thread.req.lockable.shared}.
@@ -8891,7 +8891,7 @@
 \begin{itemdescr}
 \pnum
 \ensures
-\tcode{pm == nullptr} and \tcode{owns == false}.
+\tcode{\exposid{pm} == nullptr} and \tcode{\exposid{owns} == false}.
 \end{itemdescr}
 
 \indexlibraryctor{shared_lock}%
@@ -8906,7 +8906,7 @@
 
 \pnum
 \ensures
-\tcode{pm == addressof(m)} and \tcode{owns == true}.
+\tcode{\exposid{pm} == addressof(m)} and \tcode{\exposid{owns} == true}.
 \end{itemdescr}
 
 \indexlibraryctor{shared_lock}%
@@ -8917,7 +8917,7 @@
 \begin{itemdescr}
 \pnum
 \ensures
-\tcode{pm == addressof(m)} and \tcode{owns == false}.
+\tcode{pm == addressof(m)} and \tcode{\exposid{owns} == false}.
 \end{itemdescr}
 
 \indexlibraryctor{shared_lock}%
@@ -8932,7 +8932,7 @@
 
 \pnum
 \ensures
-\tcode{pm == addressof(m)} and \tcode{owns == res}
+\tcode{\exposid{pm} == addressof(m)} and \tcode{\exposid{owns} == res}
 where \tcode{res} is the
 value returned by the call to \tcode{m.try_lock_shared()}.
 \end{itemdescr}
@@ -8949,7 +8949,7 @@
 
 \pnum
 \ensures
-\tcode{pm == addressof(m)} and \tcode{owns == true}.
+\tcode{\exposid{pm} == addressof(m)} and \tcode{\exposid{owns} == true}.
 \end{itemdescr}
 
 \indexlibraryctor{shared_lock}%
@@ -8971,7 +8971,7 @@
 
 \pnum
 \ensures
-\tcode{pm == addressof(m)} and \tcode{owns == res}
+\tcode{\exposid{pm} == addressof(m)} and \tcode{\exposid{owns} == res}
 where \tcode{res}
 is the value returned by the call to \tcode{m.try_lock_shared_until(abs_time)}.
 \end{itemdescr}
@@ -8995,7 +8995,7 @@
 
 \pnum
 \ensures
-\tcode{pm == addressof(m)} and \tcode{owns == res}
+\tcode{\exposid{pm} == addressof(m)} and \tcode{\exposid{owns} == res}
 where \tcode{res} is
 the value returned by the call to \tcode{m.try_lock_shared_for(rel_time)}.
 \end{itemdescr}
@@ -9008,7 +9008,7 @@
 \begin{itemdescr}
 \pnum
 \effects
-If \tcode{owns} calls \tcode{pm->unlock_shared()}.
+If \exposid{owns} calls \tcode{\exposid{pm}->unlock_shared()}.
 \end{itemdescr}
 
 \indexlibraryctor{shared_lock}%
@@ -9019,9 +9019,9 @@
 \begin{itemdescr}
 \pnum
 \ensures
-\tcode{pm == sl_p.pm} and \tcode{owns == sl_p.owns} (where
+\tcode{\exposid{pm} == sl_p.\exposid{pm}} and \tcode{\exposid{owns} == sl_p.\exposid{owns}} (where
 \tcode{sl_p} is the state of \tcode{sl} just prior to this construction),
-\tcode{sl.pm == nullptr} and \tcode{sl.owns == false}.
+\tcode{sl.\exposid{pm} == nullptr} and \tcode{sl.\exposid{owns} == false}.
 \end{itemdescr}
 
 \indexlibrarymember{operator=}{shared_lock}%
@@ -9049,22 +9049,22 @@
 \begin{itemdescr}
 \pnum
 \effects
-As if by \tcode{pm->lock_shared()}.
+As if by \tcode{\exposid{pm}->lock_shared()}.
 
 \pnum
 \ensures
-\tcode{owns == true}.
+\tcode{\exposid{owns} == true}.
 
 \pnum
 \throws
-Any exception thrown by \tcode{pm->lock_shared()}.
+Any exception thrown by \tcode{\exposid{pm}->lock_shared()}.
 \tcode{system_error} when an exception is required\iref{thread.req.exception}.
 
 \pnum
 \errors
 \begin{itemize}
-\item \tcode{operation_not_permitted} --- if \tcode{pm} is \keyword{nullptr}.
-\item \tcode{resource_deadlock_would_occur} --- if on entry \tcode{owns} is
+\item \tcode{operation_not_permitted} --- if \exposid{pm} is \keyword{nullptr}.
+\item \tcode{resource_deadlock_would_occur} --- if on entry \exposid{owns} is
 \tcode{true}.
 \end{itemize}
 \end{itemdescr}
@@ -9077,27 +9077,27 @@
 \begin{itemdescr}
 \pnum
 \effects
-As if by \tcode{pm->try_lock_shared()}.
+As if by \tcode{\exposid{pm}->try_lock_shared()}.
 
 \pnum
 \ensures
-\tcode{owns == res}, where \tcode{res} is the value returned by
-the call to \tcode{pm->try_lock_shared()}.
+\tcode{\exposid{owns} == res}, where \tcode{res} is the value returned by
+the call to \tcode{\exposid{pm}->try_lock_shared()}.
 
 \pnum
 \returns
-The value returned by the call to \tcode{pm->try_lock_shared()}.
+The value returned by the call to \tcode{\exposid{pm}->try_lock_shared()}.
 
 \pnum
 \throws
-Any exception thrown by \tcode{pm->try_lock_shared()}.
+Any exception thrown by \tcode{\exposid{pm}->try_lock_shared()}.
 \tcode{system_error} when an exception is required\iref{thread.req.exception}.
 
 \pnum
 \errors
 \begin{itemize}
-\item \tcode{operation_not_permitted} --- if \tcode{pm} is \keyword{nullptr}.
-\item \tcode{resource_deadlock_would_occur} --- if on entry \tcode{owns} is
+\item \tcode{operation_not_permitted} --- if \exposid{pm} is \keyword{nullptr}.
+\item \tcode{resource_deadlock_would_occur} --- if on entry \exposid{owns} is
 \tcode{true}.
 \end{itemize}
 \end{itemdescr}
@@ -9116,28 +9116,28 @@
 
 \pnum
 \effects
-As if by \tcode{pm->try_lock_shared_until(abs_time)}.
+As if by \tcode{\exposid{pm}->try_lock_shared_until(abs_time)}.
 
 \pnum
 \ensures
-\tcode{owns == res}, where \tcode{res} is the value returned by
-the call to \tcode{pm->try_lock_shared_until(abs_time)}.
+\tcode{\exposid{owns} == res}, where \tcode{res} is the value returned by
+the call to \tcode{\exposid{pm}->try_lock_shared_until(abs_time)}.
 
 \pnum
 \returns
 The value returned by the call to
-\tcode{pm->try_lock_shared_until(abs_time)}.
+\tcode{\exposid{pm}->try_lock_shared_until(abs_time)}.
 
 \pnum
 \throws
-Any exception thrown by \tcode{pm->try_lock_shared_until(abs_time)}.
+Any exception thrown by \tcode{\exposid{pm}->try_lock_shared_until(abs_time)}.
 \tcode{system_error} when an exception is required\iref{thread.req.exception}.
 
 \pnum
 \errors
 \begin{itemize}
-\item \tcode{operation_not_permitted} --- if \tcode{pm} is \keyword{nullptr}.
-\item \tcode{resource_deadlock_would_occur} --- if on entry \tcode{owns} is
+\item \tcode{operation_not_permitted} --- if \exposid{pm} is \keyword{nullptr}.
+\item \tcode{resource_deadlock_would_occur} --- if on entry \exposid{owns} is
 \tcode{true}.
 \end{itemize}
 \end{itemdescr}
@@ -9156,25 +9156,25 @@
 
 \pnum
 \effects
-As if by \tcode{pm->try_lock_shared_for(rel_time)}.
+As if by \tcode{\exposid{pm}->try_lock_shared_for(rel_time)}.
 
 \pnum
 \ensures
-\tcode{owns == res}, where \tcode{res} is the value returned by the call to \tcode{pm->try_lock_shared_for(rel_time)}.
+\tcode{\exposid{owns} == res}, where \tcode{res} is the value returned by the call to \tcode{\exposid{pm}->try_lock_shared_for(rel_time)}.
 
 \pnum
 \returns
-The value returned by the call to \tcode{pm->try_lock_shared_for(rel_time)}.
+The value returned by the call to \tcode{\exposid{pm}->try_lock_shared_for(rel_time)}.
 
 \pnum
 \throws
-Any exception thrown by \tcode{pm->try_lock_shared_for(rel_time)}. \tcode{system_error} when an exception is required\iref{thread.req.exception}.
+Any exception thrown by \tcode{\exposid{pm}->try_lock_shared_for(rel_time)}. \tcode{system_error} when an exception is required\iref{thread.req.exception}.
 
 \pnum
 \errors
 \begin{itemize}
-\item \tcode{operation_not_permitted} --- if \tcode{pm} is \keyword{nullptr}.
-\item \tcode{resource_deadlock_would_occur} --- if on entry \tcode{owns} is
+\item \tcode{operation_not_permitted} --- if \exposid{pm} is \keyword{nullptr}.
+\item \tcode{resource_deadlock_would_occur} --- if on entry \exposid{owns} is
 \tcode{true}.
 \end{itemize}
 \end{itemdescr}
@@ -9187,11 +9187,11 @@
 \begin{itemdescr}
 \pnum
 \effects
-As if by \tcode{pm->unlock_shared()}.
+As if by \tcode{\exposid{pm}->unlock_shared()}.
 
 \pnum
 \ensures
-\tcode{owns == false}.
+\tcode{\exposid{owns} == false}.
 
 \pnum
 \throws
@@ -9200,7 +9200,7 @@
 \pnum
 \errors
 \begin{itemize}
-\item \tcode{operation_not_permitted} --- if on entry \tcode{owns} is
+\item \tcode{operation_not_permitted} --- if on entry \exposid{owns} is
 \tcode{false}.
 \end{itemize}
 \end{itemdescr}
@@ -9226,11 +9226,11 @@
 \begin{itemdescr}
 \pnum
 \ensures
-\tcode{pm == nullptr} and \tcode{owns == false}.
+\tcode{\exposid{pm} == nullptr} and \tcode{\exposid{owns} == false}.
 
 \pnum
 \returns
-The previous value of \tcode{pm}.
+The previous value of \exposid{pm}.
 \end{itemdescr}
 
 \indexlibrarymember{swap}{shared_lock}%
@@ -9255,7 +9255,7 @@
 \begin{itemdescr}
 \pnum
 \returns
-\tcode{owns}.
+\exposid{owns}.
 \end{itemdescr}
 
 \indexlibrarymember{operator bool}{shared_lock}%
@@ -9266,7 +9266,7 @@
 \begin{itemdescr}
 \pnum
 \returns
-\tcode{owns}.
+\exposid{owns}.
 \end{itemdescr}
 
 \indexlibrarymember{mutex}{shared_lock}%
@@ -9277,7 +9277,7 @@
 \begin{itemdescr}
 \pnum
 \returns
-\tcode{pm}.
+\exposid{pm}.
 \end{itemdescr}
 
 \rSec2[thread.lock.algorithm]{Generic locking algorithms}