Skip to content

Commit

Permalink
Rename \hbox_unpack_clear:N as _drop
Browse files Browse the repository at this point in the history
  • Loading branch information
josephwright committed Jan 18, 2019
1 parent 75d6706 commit 3329447
Show file tree
Hide file tree
Showing 17 changed files with 79 additions and 46 deletions.
3 changes: 2 additions & 1 deletion l3kernel/CHANGELOG.md
Expand Up @@ -9,7 +9,7 @@ this project uses date-based 'snapshot' version identifiers.

### Added

- `\box_(g)set_eq_drop:NN`
- `\box_(g)set_eq_drop:NN`, `\hbox_unpack_drop:N`
- `\file_get:nnN` and `\file_get:nnNTF`
- Experimental functions `\sys_shell_get:nnN` and `\sys_shell_get:nnNTF`

Expand All @@ -21,6 +21,7 @@ this project uses date-based 'snapshot' version identifiers.
### Deprecated

- `\box_(g)set_eq_clear:NN`, replaced by `\box_(g)set_eq_drop:NN`
- `\hbox_unpack_clear:N`, replaced by `\hbox_unpack_drop:N`
- `\tl_(g)set_from_file(_x):Nnn`, replaced by `\file_get:nnN`

### Fixed
Expand Down
40 changes: 25 additions & 15 deletions l3kernel/l3box.dtx
Expand Up @@ -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
Expand Down Expand Up @@ -641,6 +629,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 original \meta{box}
% is then dropped.
% \begin{texnote}
% This is the \TeX{} primitive \tn{unhbox}.
% \end{texnote}
% \end{function}
%
% \section{Affine transformations}
%
% Affine transformations are changes which (informally) preserve straight
Expand Down Expand Up @@ -1359,14 +1360,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}
Expand Down Expand Up @@ -2137,6 +2138,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}
Expand Down
4 changes: 2 additions & 2 deletions l3kernel/l3doc.dtx
Expand Up @@ -2986,7 +2986,7 @@ and all files in that bundle must be distributed together.
{
\llap
{
\hbox_unpack_clear:N \l_@@_macro_index_box
\hbox_unpack_drop:N \l_@@_macro_index_box
\vtop to \baselineskip
{
\vbox_unpack_clear:N \l_@@_macro_box
Expand Down Expand Up @@ -3052,7 +3052,7 @@ and all files in that bundle must be distributed together.
\@@_if_macro_internal:nF {#1}
{ \seq_gput_right:Nn \g_doc_macros_seq {#1} }
\hbox_set:Nw \l_@@_macro_index_box
\hbox_unpack_clear:N \l_@@_macro_index_box
\hbox_unpack_drop:N \l_@@_macro_index_box
\int_gincr:N \c@CodelineNo
\@@_special_index:nn {#1} { main }
\int_gdecr:N \c@CodelineNo
Expand Down
2 changes: 2 additions & 0 deletions l3kernel/l3obsolete.txt
Expand Up @@ -47,6 +47,8 @@ Function Expires end
\c_one_thousand 2019
\c_ten_thousand 2019
\etex_....:D 2019
\hbox_unpack_clear:c 2020
\hbox_unpack_clear:N 2020
\lua_escape_x:n 2019
\lua_now_x:n 2019
\lua_shipout_x:n 2019
Expand Down
4 changes: 2 additions & 2 deletions l3kernel/testfiles/m3box002.lvt
Expand Up @@ -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:
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl001.luatex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl001.ptex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl001.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl001.uptex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl001.xetex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl003.luatex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl003.ptex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl003.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl003.uptex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
6 changes: 4 additions & 2 deletions l3kernel/testfiles/m3expl003.xetex.tlg
Expand Up @@ -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 ...
Expand Down Expand Up @@ -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 ...
Expand Down
10 changes: 5 additions & 5 deletions l3trial/l3tree/l3tree.dtx
@@ -1,6 +1,6 @@
% \iffalse
%
%% File l3tree.dtx (C) Copyright 2012-2014,2016-2018 The LaTeX3 Project
%% File l3tree.dtx (C) Copyright 2012-2014,2016-2019 The LaTeX3 Project
%%
%% It may be distributed and/or modified under the conditions of the
%% LaTeX Project Public License (LPPL), either version 1.3c of this
Expand Down Expand Up @@ -204,15 +204,15 @@
\tex_setbox:D #1 \tex_hbox:D \c_group_begin_token
\q_stop
\tex_everyhbox:D { }
\hbox_unpack_clear:N #1
\hbox_unpack_drop:N #1
}
\cs_new_protected:Npn \tree_gedit:Nw #1
{
\tex_afterassignment:D \use_none_delimit_by_q_stop:w
\tex_global:D \tex_setbox:D #1 \tex_hbox:D \c_group_begin_token
\q_stop
\tex_everyhbox:D { }
\hbox_unpack_clear:N #1
\hbox_unpack_drop:N #1
}
% \end{macrocode}
% \end{macro}
Expand Down Expand Up @@ -311,7 +311,7 @@
{
\tex_setbox:D \l_tree_first_box \tex_lastbox:D
\if_hbox:N \l_tree_first_box
\hbox_unpack_clear:N \l_tree_first_box
\hbox_unpack_drop:N \l_tree_first_box
\else:
\if_int_compare:w \tex_ht:D \l_tree_first_box = 0 \exp_stop_f:
\exp_after:wN \exp_after:wN \exp_after:wN \use_none:n
Expand Down Expand Up @@ -403,7 +403,7 @@
\if_box_empty:N \l_tree_first_box
\exp_after:wN \use_none:n
\else:
\hbox_unpack_clear:N \l_tree_first_box
\hbox_unpack_drop:N \l_tree_first_box
\fi:
\tree_put_loop:
}
Expand Down
2 changes: 1 addition & 1 deletion l3trial/xfont/xfss.dtx
@@ -1,6 +1,6 @@
% \iffalse
%
%% File xfss.dtx Copyright (C) 2011,2012,2013,2015-2018 The LaTeX3 Project
%% File xfss.dtx Copyright (C) 2011,2012,2013,2015-2019 The LaTeX3 Project
%%
%% It may be distributed and/or modified under the conditions of the
%% LaTeX Project Public License (LPPL), either version 1.3c of this
Expand Down

0 comments on commit 3329447

Please sign in to comment.