[re.req] Replace requirements table with \itemdescr

Author: jensmaurer

source/regex.tex

@@ -63,130 +63,283 @@
 \indextext{requirements!regular expression traits}%
 \indextext{regular expression!requirements}%
 \indextext{locale}%
-In \tref{re.req} \tcode{X} denotes a traits class
-defining types and functions for the character container
-type \tcode{charT}; \tcode{u} is an object of
-type \tcode{X}; \tcode{v} is an object of type \tcode{const
-X}; \tcode{p} is a value of type \tcode{const charT*}; \tcode{I1}
-and \tcode{I2} are input iterators\iref{input.iterators};
+In the following requirements,
+\begin{itemize}
+\item
+\tcode{X} denotes a traits class defining types and functions
+for the character container type \tcode{charT};
+\item
+\tcode{u} is an object of type \tcode{X};
+\item
+\tcode{v} is an object of type \tcode{const X};
+\item
+\tcode{p} is a value of type \tcode{const charT*};
+\item
+\tcode{I1} and \tcode{I2} are input iterators\iref{input.iterators};
+\item
 \tcode{F1} and \tcode{F2} are forward iterators\iref{forward.iterators};
+\item
 \tcode{c} is a value of type \tcode{const charT};
+\item
 \tcode{s} is an object of type \tcode{X::string_type};
+\item
 \tcode{cs} is an object of type \tcode{const X::string_type};
+\item
 \tcode{b} is a value of  type \tcode{bool};
+\item
 \tcode{I} is a value of type \tcode{int};
-\tcode{cl} is an object of type \tcode{X::char_class_type},
-and \tcode{loc} is an object of type \tcode{X::locale_type}.
-
-\begin{libreqtab3}
-  {Regular expression traits class requirements}
-  {re.req}
-\\ \topline
-\lhdr{Expression} & \chdr{Return type} & \rhdr{Assertion/note pre-/post-condition } \\ \capsep
-\endfirsthead
-\continuedcaption\\
-\hline
-\lhdr{Expression} & \chdr{Return type} & \rhdr{Assertion/note pre-/post-condition } \\ \capsep
-\endhead
-%%
+\item
+\tcode{cl} is an object of type \tcode{X::char_class_type}; and
+\item
+\tcode{loc} is an object of type \tcode{X::locale_type}.
+\end{itemize}
+
+\pnum
+A traits class \tcode{X} meets the regular expression traits requirements
+if the following types and expressions are well-formed and have the specified
+semantics.
+
+\begin{itemdecl}
+typename X::char_type
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{charT},
+the character container type used in the implementation of class
+template \tcode{basic_regex}.
+\end{itemdescr}
+
+\begin{itemdecl}
+typename X::string_type
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{basic_string<charT>}
+\end{itemdescr}
+
+\begin{itemdecl}
+typename X::locale_type
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+A copy constructible type
+that represents the locale used by the traits class.
+\end{itemdescr}
+
+\begin{itemdecl}
+typename X::char_class_type
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+A bitmask type\iref{bitmask.types}
+representing a particular character classification.
+\end{itemdescr}
+
+\begin{itemdecl}
+X::length(p)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{size_t}
+
+\pnum
+\returns
+The smallest \tcode{i} such that \tcode{p[i] == 0}.
+
+\pnum
+\complexity
+Linear in \tcode{i}.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.translate(c)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
 \tcode{X::char_type}
-  & \tcode{charT}
-  & The character container type used in the implementation of class
-    template \tcode{basic_regex}.
-  \\ \rowsep
+
+\pnum
+\returns
+A character such that for any character \tcode{d}
+that is to be considered equivalent to \tcode{c}
+then \tcode{v.translate(c) == v.translate(d)}.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.translate_nocase(c)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{X::char_type}
+
+\pnum
+\returns
+For all characters \tcode{C} that are to be considered equivalent to \tcode{c}
+when comparisons are to be performed without regard to case,
+then \tcode{v.translate_nocase(c) == v.translate_nocase(C)}.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.transform(F1, F2)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
 \tcode{X::string_type}
-  & \tcode{basic_string<charT>}
-  &
-  \\ \rowsep
-\tcode{X::locale_type}
-  & A copy constructible type
-  & A type that represents the locale used by the traits class. \indextext{locale}
- \\ \rowsep
+
+\pnum
+\returns
+A sort key for the character sequence designated by
+the iterator range \range{F1}{F2} such that
+if the character sequence \range{G1}{G2} sorts before
+the character sequence \range{H1}{H2}
+then \tcode{v.transform(G1, G2) < v.transform(H1, H2)}.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.transform_primary(F1, F2)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\indextext{regular expression traits!\idxcode{transform_primary}}%
+\indextext{transform_primary@\tcode{transform_primary}!regular expression traits}%
+\result
+\tcode{X::string_type}
+
+\pnum
+\returns
+A sort key for the character sequence designated by
+the iterator range \range{F1}{F2} such that
+if the character sequence \range{G1}{G2} sorts before
+the character sequence \range{H1}{H2}
+when character case is not considered
+then \tcode{v.transform_primary(G1, G2) < v.transform_primary(H1, H2)}.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.lookup_collatename(F1, F2)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{X::string_type}
+
+\pnum
+\returns
+A sequence of characters that represents the collating element
+consisting of the character sequence designated by
+the iterator range \range{F1}{F2}.
+Returns an empty string
+if the character sequence is not a valid collating element.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.lookup_classname(F1, F2, b)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
 \tcode{X::char_class_type}
- & A bitmask type\iref{bitmask.types}.
- & A bitmask type representing a particular character classification.
- \\ \rowsep
-\tcode{X::length(p)}
-  & \tcode{size_t}
-  & Yields the smallest \tcode{i} such that \tcode{p[i] == 0}. Complexity is
-    linear in \tcode{i}.
-  \\ \rowsep
-\tcode{v.translate(c)}
-  & \tcode{X::char_type}
-  & Returns a character such that for any character \tcode{d} that is to
-    be considered equivalent to \tcode{c} then \tcode{v.translate(c) == v.translate(d)}.
-  \\ \rowsep
-\tcode{v.translate_nocase(c)}
-  & \tcode{X::char_type}
-  & For all characters \tcode{C} that are to be considered equivalent
-    to \tcode{c} when comparisons are to be performed without regard to
-  case, then \tcode{v.translate_nocase(c) == v.translate_nocase(C)}.
-  \\ \rowsep
-\tcode{v.transform(F1, F2)}
-  & \tcode{X::string_type}
-  & Returns a sort key for the character sequence designated by the
-    iterator range \range{F1}{F2} such that if the character sequence
-  \range{G1}{G2} sorts before the character sequence \range{H1}{H2}
-  then \tcode{v.transform(G1, G2) < v.transform(H1, H2)}.
-  \\ \rowsep
-\tcode{v.transform_primary(F1, F2)}
-  & \tcode{X::string_type}
-  & Returns a sort key for the character sequence designated by the
-    iterator range \range{F1}{F2} such that if the character sequence
-  \range{G1}{G2} sorts before the character sequence \range{H1}{H2}
-  when character case is not considered
-  then \tcode{v.transform_primary(G1, G2) < v.transform_primary(H1, H2)}.
-   \indextext{regular expression traits!\idxcode{transform_primary}}%
-   \indextext{transform_primary@\tcode{transform_primary}!regular expression traits}%
-  \\ \rowsep
-\tcode{v.lookup_collatename(F1, F2)}
-  & \tcode{X::string_type}
-  & Returns a sequence of characters that represents the collating element
-    consisting of the character sequence designated by the iterator range
-  \range{F1}{F2}. Returns an empty string if the character sequence is not
-  a valid collating element.
-  \\ \rowsep
-\tcode{v.lookup_classname(F1, F2, b)}
-  & \tcode{X::char_class_type}
-  &  Converts the character sequence designated by the iterator range
-   \range{F1}{F2} into a value of a bitmask type that can
-    subsequently be passed to \tcode{isctype}. Values returned from
-    \tcode{lookup_classname} can be bitwise \logop{OR}'ed together; the
-    resulting value represents membership in either of the
-    corresponding character classes.
-  If \tcode{b} is \tcode{true}, the returned bitmask is suitable for
-  matching characters without regard to their case.
-  Returns \tcode{0} if the character
-    sequence is not the name of a character class recognized by
-    \tcode{X}.  The value returned shall be independent of the case of
-    the characters in the sequence.
-  \\ \rowsep
-\tcode{v.isctype(c, cl)}
-  & \tcode{bool}
-  & Returns \tcode{true} if character \tcode{c} is a member of
-    one of the character classes designated by \tcode{cl},
-    \tcode{false} otherwise.
-  \\ \rowsep
-\tcode{v.value(c, I)}
-  & \tcode{int}
-  & Returns the value represented by the digit \textit{c} in base
-    \textit{I} if the character \textit{c} is a valid digit in base \textit{I};
-  otherwise returns \tcode{-1}.
-\begin{tailnote}
-The value of \textit{I} will only
-  be 8, 10, or 16.
-\end{tailnote}
-  \\ \rowsep
-\tcode{u.imbue(loc)}
-  & \tcode{X::locale_type}
-  & Imbues \tcode{u} with the locale \tcode{loc} and returns the previous locale
-    used by \tcode{u} if any. \indextext{locale}%
-  \\ \rowsep
-\tcode{v.getloc()}
-  & \tcode{X::locale_type}
-  & Returns the current locale used by \tcode{v}, if any. \indextext{locale}%
-  \\
-\end{libreqtab3}
+
+\pnum
+\returns
+Converts the character sequence designated by the iterator range
+\range{F1}{F2} into a value of a bitmask type that can
+subsequently be passed to \tcode{isctype}.
+Values returned from \tcode{lookup_classname} can be bitwise \logop{OR}'ed together;
+the resulting value represents membership
+in either of the corresponding character classes.
+If \tcode{b} is \tcode{true}, the returned bitmask is suitable for
+matching characters without regard to their case.
+Returns \tcode{0}
+if the character sequence is not the name of
+a character class recognized by  \tcode{X}.
+The value returned shall be independent of
+the case of the characters in the sequence.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.isctype(c, cl)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{bool}
+
+\pnum
+\returns
+Returns \tcode{true} if character \tcode{c} is a member of
+one of the character classes designated by \tcode{cl},
+\tcode{false} otherwise.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.value(c, I)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{int}
+
+\pnum
+\returns
+Returns the value represented by the digit \textit{c} in base
+\textit{I} if the character \textit{c} is a valid digit in base \textit{I};
+otherwise returns \tcode{-1}.
+\begin{note}
+The value of \textit{I} will only be 8, 10, or 16.
+\end{note}
+\end{itemdescr}
+
+\begin{itemdecl}
+u.imbue(loc)
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{X::locale_type}
+
+\indextext{locale}%
+\pnum
+\effects
+Imbues \tcode{u} with the locale \tcode{loc} and
+returns the previous locale used by \tcode{u} if any.
+\end{itemdescr}
+
+\begin{itemdecl}
+v.getloc()
+\end{itemdecl}
+
+\begin{itemdescr}
+\pnum
+\result
+\tcode{X::locale_type}
+
+\pnum
+\returns
+Returns the current locale used by \tcode{v}, if any. \indextext{locale}%
+\end{itemdescr}
 
 \pnum
 \begin{note}