Skip to content

[macros, atomic] Align placeholders #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 66 additions & 66 deletions source/atomics.tex
Original file line number Diff line number Diff line change
Expand Up @@ -739,7 +739,7 @@

\indexlibrary{\idxcode{atomic type}!constructor}%
\begin{itemdecl}
@\textit{A}@::@\textit{A}@() noexcept = default;
@\placeholdernc{A}@::@\placeholdernc{A}@() noexcept = default;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -753,7 +753,7 @@

\indexlibrary{\idxcode{atomic type}!constructor}%
\begin{itemdecl}
constexpr @\textit{A}@::@\textit{A}@(@\textit{C}@ desired) noexcept;
constexpr @\placeholdernc{A}@::@\placeholdernc{A}@(@\placeholdernc{C}@ desired) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand Down Expand Up @@ -790,10 +790,10 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{atomic_is_lock_free}}%
\indexlibrary{\idxcode{atomic_is_lock_free}!\idxcode{atomic type}}%
\begin{itemdecl}
bool atomic_is_lock_free(const volatile @\textit{A}@* object) noexcept;
bool atomic_is_lock_free(const @\textit{A}@* object) noexcept;
bool @\textit{A}@::is_lock_free() const volatile noexcept;
bool @\textit{A}@::is_lock_free() const noexcept;
bool atomic_is_lock_free(const volatile @\placeholder{A}@*@\itcorr[-1]@ object) noexcept;
bool atomic_is_lock_free(const @\placeholder{A}@*@\itcorr[-1]@ object) noexcept;
bool @\placeholdernc{A}@::is_lock_free() const volatile noexcept;
bool @\placeholdernc{A}@::is_lock_free() const noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -802,8 +802,8 @@
\end{itemdescr}

\begin{itemdecl}
void atomic_init(volatile @\textit{A}@* object, @\textit{C}@ desired) noexcept;
void atomic_init(@\textit{A}@* object, @\textit{C}@ desired) noexcept;
void atomic_init(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired) noexcept;
void atomic_init(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -828,12 +828,12 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{store}}%
\indexlibrary{\idxcode{store}!\idxcode{atomic type}}%
\begin{itemdecl}
void atomic_store(volatile @\textit{A}@* object, @\textit{C}@ desired) noexcept;
void atomic_store(@\textit{A}@* object, @\textit{C}@ desired) noexcept;
void atomic_store_explicit(volatile @\textit{A}@* object, @\textit{C}@ desired, memory_order order) noexcept;
void atomic_store_explicit(@\textit{A}@* object, @\textit{C}@ desired, memory_order order) noexcept;
void @\textit{A}@::store(@\textit{C}@ desired, memory_order order = memory_order_seq_cst) volatile noexcept;
void @\textit{A}@::store(@\textit{C}@ desired, memory_order order = memory_order_seq_cst) noexcept;
void atomic_store(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired) noexcept;
void atomic_store(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired) noexcept;
void atomic_store_explicit(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired, memory_order order) noexcept;
void atomic_store_explicit(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired, memory_order order) noexcept;
void @\placeholdernc{A}@::store(@\placeholdernc{C}@ desired, memory_order order = memory_order_seq_cst) volatile noexcept;
void @\placeholdernc{A}@::store(@\placeholdernc{C}@ desired, memory_order order = memory_order_seq_cst) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -850,8 +850,8 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{operator=}}%
\indexlibrary{\idxcode{operator=}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C} \textit{A}@::operator=(@\textit{C}@ desired) volatile noexcept;
@\textit{C}@ @\textit{A}@::operator=(@\textit{C}@ desired) noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator=(@\placeholdernc{C}@ desired) volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator=(@\placeholdernc{C}@ desired) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -869,12 +869,12 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{load}}%
\indexlibrary{\idxcode{load}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ atomic_load(const volatile @\textit{A}@* object) noexcept;
@\textit{C}@ atomic_load(const @\textit{A}@* object) noexcept;
@\textit{C}@ atomic_load_explicit(const volatile @\textit{A}@* object, memory_order) noexcept;
@\textit{C}@ atomic_load_explicit(const @\textit{A}@* object, memory_order) noexcept;
@\textit{C}@ @\textit{A}@::load(memory_order order = memory_order_seq_cst) const volatile noexcept;
@\textit{C}@ @\textit{A}@::load(memory_order order = memory_order_seq_cst) const noexcept;
@\placeholdernc{C}@ atomic_load(const volatile @\placeholder{A}@*@\itcorr[-1]@ object) noexcept;
@\placeholdernc{C}@ atomic_load(const @\placeholder{A}@*@\itcorr[-1]@ object) noexcept;
@\placeholdernc{C}@ atomic_load_explicit(const volatile @\placeholder{A}@*@\itcorr[-1]@ object, memory_order) noexcept;
@\placeholdernc{C}@ atomic_load_explicit(const @\placeholder{A}@*@\itcorr[-1]@ object, memory_order) noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::load(memory_order order = memory_order_seq_cst) const volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::load(memory_order order = memory_order_seq_cst) const noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -888,11 +888,11 @@
\returns Atomically returns the value pointed to by \tcode{object} or by \tcode{this}.
\end{itemdescr}

\indexlibrary{\idxcode{atomic type}!operator C@\tcode{operator \textit{C}}}%
\indexlibrary{operator C@\tcode{operator \textit{C}}!\idxcode{atomic type}}%
\indexlibrary{\idxcode{atomic type}!operator C@\tcode{operator \placeholder{C}}}%
\indexlibrary{operator C@\tcode{operator \placeholder{C}}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{A}@::operator @\textit{C}@() const volatile noexcept;
@\textit{A}@::operator @\textit{C}@() const noexcept;
@\placeholdernc{A}@::operator @\placeholder{C}@() const volatile noexcept;
@\placeholdernc{A}@::operator @\placeholder{C}@() const noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -911,12 +911,12 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{exchange}}%
\indexlibrary{\idxcode{exchange}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ atomic_exchange(volatile @\textit{A}@* object, @\textit{C}@ desired) noexcept;
@\textit{C}@ atomic_exchange(@\textit{A}@* object, @\textit{C}@ desired) noexcept;
@\textit{C}@ atomic_exchange_explicit(volatile @\textit{A}@* object, @\textit{C}@ desired, memory_order) noexcept;
@\textit{C}@ atomic_exchange_explicit(@\textit{A}@* object, @\textit{C}@ desired, memory_order) noexcept;
@\textit{C}@ @\textit{A}@::exchange(@\textit{C}@ desired, memory_order order = memory_order_seq_cst) volatile noexcept;
@\textit{C}@ @\textit{A}@::exchange(@\textit{C}@ desired, memory_order order = memory_order_seq_cst) noexcept;
@\placeholdernc{C}@ atomic_exchange(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired) noexcept;
@\placeholdernc{C}@ atomic_exchange(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired) noexcept;
@\placeholdernc{C}@ atomic_exchange_explicit(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired, memory_order) noexcept;
@\placeholdernc{C}@ atomic_exchange_explicit(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{C}@ desired, memory_order) noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::exchange(@\placeholdernc{C}@ desired, memory_order order = memory_order_seq_cst) volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::exchange(@\placeholdernc{C}@ desired, memory_order order = memory_order_seq_cst) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand Down Expand Up @@ -947,33 +947,33 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{compare_exchange_strong_explicit}}%
\indexlibrary{\idxcode{compare_exchange_strong_explicit}!\idxcode{atomic type}}%
\begin{itemdecl}
bool atomic_compare_exchange_weak(volatile @\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired) noexcept;
bool atomic_compare_exchange_weak(@\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired) noexcept;
bool atomic_compare_exchange_strong(volatile @\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired) noexcept;
bool atomic_compare_exchange_strong(@\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired) noexcept;
bool atomic_compare_exchange_weak_explicit(volatile @\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired,
bool atomic_compare_exchange_weak(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired) noexcept;
bool atomic_compare_exchange_weak(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired) noexcept;
bool atomic_compare_exchange_strong(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired) noexcept;
bool atomic_compare_exchange_strong(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired) noexcept;
bool atomic_compare_exchange_weak_explicit(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) noexcept;
bool atomic_compare_exchange_weak_explicit(@\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired,
bool atomic_compare_exchange_weak_explicit(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) noexcept;
bool atomic_compare_exchange_strong_explicit(volatile @\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired,
bool atomic_compare_exchange_strong_explicit(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) noexcept;
bool atomic_compare_exchange_strong_explicit(@\textit{A}@* object, @\textit{C}@* expected, @\textit{C}@ desired,
bool atomic_compare_exchange_strong_explicit(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholder{C}@*@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) noexcept;
bool @\textit{A}@::compare_exchange_weak(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_weak(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) volatile noexcept;
bool @\textit{A}@::compare_exchange_weak(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_weak(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) noexcept;
bool @\textit{A}@::compare_exchange_strong(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_strong(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) volatile noexcept;
bool @\textit{A}@::compare_exchange_strong(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_strong(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order success, memory_order failure) noexcept;
bool @\textit{A}@::compare_exchange_weak(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_weak(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order order = memory_order_seq_cst) volatile noexcept;
bool @\textit{A}@::compare_exchange_weak(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_weak(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order order = memory_order_seq_cst) noexcept;
bool @\textit{A}@::compare_exchange_strong(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_strong(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order order = memory_order_seq_cst) volatile noexcept;
bool @\textit{A}@::compare_exchange_strong(@\textit{C}@& expected, @\textit{C}@ desired,
bool @\placeholdernc{A}@::compare_exchange_strong(@\placeholder{C}@&@\itcorr[-1]@ expected, @\placeholdernc{C}@ desired,
memory_order order = memory_order_seq_cst) noexcept;
\end{itemdecl}

Expand Down Expand Up @@ -1089,12 +1089,12 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{fetch_}}%
\indexlibrary{\idxcode{fetch_}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ atomic_fetch_@\textit{key}@(volatile @\textit{A}@* object, @\textit{M}@ operand) noexcept;
@\textit{C}@ atomic_fetch_@\textit{key}@(@\textit{A}@* object, @\textit{M}@ operand) noexcept;
@\textit{C}@ atomic_fetch_@\textit{key}@_explicit(volatile @\textit{A}@* object, @\textit{M}@ operand, memory_order order) noexcept;
@\textit{C}@ atomic_fetch_@\textit{key}@_explicit(@\textit{A}@* object, @\textit{M}@ operand, memory_order order) noexcept;
@\textit{C}@ @\textit{A}@::fetch_@\textit{key}@(@\textit{M}@ operand, memory_order order = memory_order_seq_cst) volatile noexcept;
@\textit{C}@ @\textit{A}@::fetch_@\textit{key}@(@\textit{M}@ operand, memory_order order = memory_order_seq_cst) noexcept;
@\placeholdernc{C}@ atomic_fetch_@\placeholdernc{key}@(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{M}@ operand) noexcept;
@\placeholdernc{C}@ atomic_fetch_@\placeholdernc{key}@(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{M}@ operand) noexcept;
@\placeholdernc{C}@ atomic_fetch_@\placeholdernc{key}@_explicit(volatile @\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{M}@ operand, memory_order order) noexcept;
@\placeholdernc{C}@ atomic_fetch_@\placeholdernc{key}@_explicit(@\placeholder{A}@*@\itcorr[-1]@ object, @\placeholdernc{M}@ operand, memory_order order) noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::fetch_@\placeholdernc{key}@(@\placeholdernc{M}@ operand, memory_order order = memory_order_seq_cst) volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::fetch_@\placeholdernc{key}@(@\placeholdernc{M}@ operand, memory_order order = memory_order_seq_cst) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -1117,23 +1117,23 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{operator "@=}}%
\indexlibrary{\idxcode{operator "@=}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ @\textit{A}@::operator @\textit{op}@=(@\textit{M}@ operand) volatile noexcept;
@\textit{C}@ @\textit{A}@::operator @\textit{op}@=(@\textit{M}@ operand) noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator @\textit{op}@=(@\placeholdernc{M}@ operand) volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator @\textit{op}@=(@\placeholdernc{M}@ operand) noexcept;
\end{itemdecl}

\begin{itemdescr}
\pnum
\effects \tcode{fetch_\textit{key}(operand)}
\effects \tcode{fetch_\placeholder{key}(operand)}

\pnum
\returns \tcode{fetch_\textit{key}(operand) op operand}
\returns \tcode{fetch_\placeholder{key}(operand) op operand}
\end{itemdescr}

\indexlibrary{\idxcode{atomic type}!\idxcode{operator++}}%
\indexlibrary{\idxcode{operator++}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ @\textit{A}@::operator++(int) volatile noexcept;
@\textit{C}@ @\textit{A}@::operator++(int) noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator++(int) volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator++(int) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -1144,8 +1144,8 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{operator\dcr}}%
\indexlibrary{\idxcode{operator\dcr}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ @\textit{A}@::operator--(int) volatile noexcept;
@\textit{C}@ @\textit{A}@::operator--(int) noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator--(int) volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator--(int) noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -1156,8 +1156,8 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{operator++}}%
\indexlibrary{\idxcode{operator++}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ @\textit{A}@::operator++() volatile noexcept;
@\textit{C}@ @\textit{A}@::operator++() noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator++() volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator++() noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand All @@ -1171,8 +1171,8 @@
\indexlibrary{\idxcode{atomic type}!\idxcode{operator\dcr}}%
\indexlibrary{\idxcode{operator\dcr}!\idxcode{atomic type}}%
\begin{itemdecl}
@\textit{C}@ @\textit{A}@::operator--() volatile noexcept;
@\textit{C}@ @\textit{A}@::operator--() noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator--() volatile noexcept;
@\placeholdernc{C}@ @\placeholdernc{A}@::operator--() noexcept;
\end{itemdecl}

\begin{itemdescr}
Expand Down
1 change: 1 addition & 0 deletions source/macros.tex
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@
\newcommand{\term}[1]{\textit{#1}\xspace}
\newcommand{\grammarterm}[1]{\textit{#1}\xspace}
\newcommand{\placeholder}[1]{\textit{#1}}
\newcommand{\placeholdernc}[1]{\textit{#1\nocorr}}

%%--------------------------------------------------
%% allow line break if needed for justification
Expand Down