Rename \hbox_unpack_clear:N as _drop

latex3 · Jan 17, 2019 · ac933c9 · ac933c9
1 parent 26ae485
commit ac933c9
Show file tree

Hide file tree

Showing 12 changed files with 67 additions and 37 deletions.
diff --git a/l3kernel/l3box.dtx b/l3kernel/l3box.dtx
@@ -417,18 +417,6 @@
 %   \end{texnote}
 % \end{function}
 %
-% \begin{function}{\hbox_unpack_clear:N, \hbox_unpack_clear:c}
-%   \begin{syntax}
-%     \cs{hbox_unpack_clear:N} \meta{box}
-%   \end{syntax}
-%   Unpacks the content of the horizontal \meta{box}, retaining any stretching
-%   or shrinking applied when the \meta{box} was set. The \meta{box} is
-%   then cleared globally.
-%   \begin{texnote}
-%     This is the \TeX{} primitive \tn{unhbox}.
-%   \end{texnote}
-% \end{function}
-%
 % \section{Vertical mode boxes}
 %
 % Vertical boxes inherit their baseline from their contents. The
@@ -639,6 +627,19 @@
 %   then drops \meta{box_2}.
 % \end{function}
 %
+% \begin{function}[added = 2019-01-17]
+%   {\hbox_unpack_drop:N, \hbox_unpack_drop:c}
+%   \begin{syntax}
+%     \cs{hbox_unpack_drop:N} \meta{box}
+%   \end{syntax}
+%   Unpacks the content of the horizontal \meta{box}, retaining any stretching
+%   or shrinking applied when the \meta{box} was set. The \meta{box} is
+%   then cleared globally.
+%   \begin{texnote}
+%     This is the \TeX{} primitive \tn{unhbox}.
+%   \end{texnote}
+% \end{function}
+%
 % \section{Affine transformations}
 %
 % Affine transformations are changes which (informally) preserve straight
@@ -1357,14 +1358,14 @@
 % \end{macro}
 %
 % \begin{macro}{\hbox_unpack:N, \hbox_unpack:c}
-% \begin{macro}{\hbox_unpack_clear:N, \hbox_unpack_clear:c}
+% \begin{macro}{\hbox_unpack_drop:N, \hbox_unpack_drop:c}
 % \testfile*
 %   Unpacking a box and if requested also clear it.
 %    \begin{macrocode}
 \cs_new_eq:NN \hbox_unpack:N \tex_unhcopy:D
-\cs_new_eq:NN \hbox_unpack_clear:N \tex_unhbox:D
+\cs_new_eq:NN \hbox_unpack_drop:N \tex_unhbox:D
 \cs_generate_variant:Nn \hbox_unpack:N { c }
-\cs_generate_variant:Nn \hbox_unpack_clear:N { c }
+\cs_generate_variant:Nn \hbox_unpack_drop:N { c }
 %    \end{macrocode}
 % \end{macro}
 % \end{macro}
@@ -2135,6 +2136,15 @@
 % \end{macro}
 % \end{macro}
 %
+% \begin{macro}{\hbox_unpack_clear:N, \hbox_unpack_clear:c}
+%    \begin{macrocode}
+\__kernel_patch_deprecation:nnNNpn { 2020-12-31 } { \hbox_unpack_drop:N }
+\cs_new_protected:Npn \hbox_unpack_clear:N
+  { \hbox_unpack_drop:N }
+\cs_generate_variant:Nn \hbox_unpack_clear:N { c }
+%    \end{macrocode}
+% \end{macro}
+%
 %    \begin{macrocode}
 %</initex|package>
 %    \end{macrocode}

diff --git a/l3kernel/testfiles/m3box002.lvt b/l3kernel/testfiles/m3box002.lvt
@@ -70,8 +70,8 @@
   \box_show:N \l_tempa_box
   \box_show:N \l_tempb_box
   \group_begin:
-    \hbox_unpack_clear:N \l_tempa_box
-    \hbox_unpack_clear:c {l_tempb_box}
+    \hbox_unpack_drop:N \l_tempa_box
+    \hbox_unpack_drop:c {l_tempb_box}
     \box_show:N \l_tempa_box
     \box_show:N \l_tempb_box
   \group_end:

diff --git a/l3kernel/testfiles/m3expl001.luatex.tlg b/l3kernel/testfiles/m3expl001.luatex.tlg
@@ -5160,9 +5160,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5262,6 +5262,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl001.ptex.tlg b/l3kernel/testfiles/m3expl001.ptex.tlg
@@ -5456,9 +5456,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5558,6 +5558,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl001.tlg b/l3kernel/testfiles/m3expl001.tlg
@@ -5456,9 +5456,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5558,6 +5558,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl001.uptex.tlg b/l3kernel/testfiles/m3expl001.uptex.tlg
@@ -5453,9 +5453,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5555,6 +5555,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl001.xetex.tlg b/l3kernel/testfiles/m3expl001.xetex.tlg
@@ -5171,9 +5171,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5273,6 +5273,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl003.luatex.tlg b/l3kernel/testfiles/m3expl003.luatex.tlg
@@ -5160,9 +5160,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5262,6 +5262,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl003.ptex.tlg b/l3kernel/testfiles/m3expl003.ptex.tlg
@@ -5456,9 +5456,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5558,6 +5558,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl003.tlg b/l3kernel/testfiles/m3expl003.tlg
@@ -5456,9 +5456,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5558,6 +5558,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl003.uptex.tlg b/l3kernel/testfiles/m3expl003.uptex.tlg
@@ -5453,9 +5453,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5555,6 +5555,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...

diff --git a/l3kernel/testfiles/m3expl003.xetex.tlg b/l3kernel/testfiles/m3expl003.xetex.tlg
@@ -5171,9 +5171,9 @@ Defining \hbox_to_zero:n on line ...
 Defining \hbox_overlap_left:n on line ...
 Defining \hbox_overlap_right:n on line ...
 Defining \hbox_unpack:N on line ...
-Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_drop:N on line ...
 Defining \hbox_unpack:c on line ...
-Defining \hbox_unpack_clear:c on line ...
+Defining \hbox_unpack_drop:c on line ...
 Defining \vbox:n on line ...
 Defining \vbox_top:n on line ...
 Defining \vbox_to_ht:nn on line ...
@@ -5273,6 +5273,8 @@ Defining \box_set_eq_clear:cc on line ...
 Defining \box_gset_eq_clear:cN on line ...
 Defining \box_gset_eq_clear:Nc on line ...
 Defining \box_gset_eq_clear:cc on line ...
+Defining \hbox_unpack_clear:N on line ...
+Defining \hbox_unpack_clear:c on line ...
 Defining \color_group_begin: on line ...
 Defining \color_group_end: on line ...
 Defining \color_ensure_current: on line ...