-
Notifications
You must be signed in to change notification settings - Fork 4
/
wrapstuff.dtx
3547 lines (3523 loc) · 105 KB
/
wrapstuff.dtx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
% \iffalse meta-comment
% !TeX program = XeLaTeX
% !TeX encoding = UTF-8
%<*internal>
\iffalse
%</internal>
%<*readme>
wrapstuff
=========
The `wrapstuff` package provides another implementation of text wrapping.
Its implementation benefits from the paragraph hooks available since
LaTeX 2021-06-01.
Basic Usage
-----------
The package only provides a user environment `wrapstuff`.
\begin{wrapstuff}[<options>]
<wrapping stuff>
\end{wrapstuff}
<main text>
You can read the package manual (in both English and Chinese) for some explanations.
Contributing
------------
The package is still highly experimental and not fully tested.
[Issues](https://github.com/qinglee/wrapstuff/issues) and
[pull requests](https://github.com/qinglee/wrapstuff/pulls)
are always welcome.
Copyright and Licence
---------------------
Copyright (C) 2022 by Qing Lee <[email protected]>
-----------------------------------------------------------------
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3c of this license or (at your option) any later
version. This version of this license is in
http://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of
LaTeX version 2005/12/01 or later.
This work has the LPPL maintenance status "maintained".
The Current Maintainer of this work is Qing Lee.
This package consists of the file wrapstuff.dtx,
and the derived files wrapstuff.pdf,
wrapstuff.sty,
wrapstuff.ins and
README.md (this file).
%</readme>
%<*internal>
\fi
\begingroup
\def\temp{LaTeX2e}
\expandafter\endgroup\ifx\temp\fmtname\else
\csname fi\endcsname
%</internal>
%<*install>
\input ctxdocstrip %
\preamble
Copyright (C) 2022 by Qing Lee <[email protected]>
-----------------------------------------------------------------
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3c of this license or (at your option) any later
version. This version of this license is in
http://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of
LaTeX version 2005/12/01 or later.
This work has the LPPL maintenance status "maintained".
The Current Maintainer of this work is Qing Lee.
-----------------------------------------------------------------
\endpreamble
\postamble
This work consists of the file wrapstuff.dtx,
and the derived files wrapstuff.pdf,
wrapstuff.sty,
wrapstuff.ins and
README.md.
\endpostamble
\generate
{
%</install>
%<*internal>
\usedir{source/latex/wrapstuff}
\file{wrapstuff.ins} {\from{\jobname.dtx}{install}}
%</internal>
%<*install>
\usedir{tex/latex/wrapstuff}
\file{wrapstuff.sty} {\from{\jobname.dtx}{package}}
\nopreamble\nopostamble
\usedir{doc/latex/wrapstuff}
\file{README.md} {\from{\jobname.dtx}{readme}}
}
\endbatchfile
%</install>
%<*internal>
\fi
%</internal>
%<package>\NeedsTeXFormat{LaTeX2e}[2021-06-01]
%<package>\@ifundefined{ExplLoaderFileDate}{\RequirePackage{expl3}}{}
%<+package>\GetIdInfo$Id$
%<package> {Wrapping text around stuff}
%<package>\ProvidesExplPackage{\ExplFileName}
%<package> {\ExplFileDate}{0.3}{\ExplFileDescription}
%<*driver>
\documentclass{ctxdoc}
\usepackage{wrapstuff}
\usepackage{graphicx}
\usepackage{zhlipsum}
\usepackage{bookmark}
\ExplSyntaxOn
\makeatletter
\DeclareDocumentCommand \gitsha { m }
{
\href { https \c_colon_str //github.com/qinglee/wrapstuff/commit/#1 }
{ rev. ~ \texttt{#1} }
}
\DeclareDocumentCommand \QIANZIWEN { }
{
天地玄黄宇宙洪荒日月盈昃辰宿列张
寒来暑往秋收冬藏闰馀成岁律召调阳 \par
云腾致雨露结为霜金生丽水玉出昆冈 \par
}
\DeclareDocumentCommand \ADDSPECEIALKEY { m }
{
\cs_gset_eq:NN \@@_codedoc_names_typeset_save:
\__codedoc_names_typeset:
\cs_gset_protected:Npn \__codedoc_names_typeset:
{
\cs_gset_eq:NN \__codedoc_names_typeset:
\@@_codedoc_names_typeset_save:
\__codedoc_names_typeset:
#1 \\
}
}
\DeclareDocumentCommand \STOPFUNCTIONLABEL { }
{ \cs_set_eq:NN \__codedoc_function_label:nN \use_none:nn }
\DeclareDocumentCommand \IMAGE { m m }
{ \includegraphics [ width = \dim_eval:n {#1} ] { example-image-#2.pdf } }
\tl_put_left:Nn \Example
{ \trivlist \item \relax }
\tl_put_right:Nn \endExample
{ \endtrivlist }
\SideBySideExampleSet { numbers = none }
\ctex_patch_cmd:Nnn \@maketitle
{ \@title }
{ \patched@title }
\cs_new_protected:Npn \patched@title
{ \exp_args:No \@@_doc_title:n { \g_@@_doc_tl } }
\cs_new_protected:Npn \@@_doc_title:n #1
{
\prop_get:NnNTF \c_@@_doc_prop {#1} \l_tmpa_tl
{ \exp_after:wN \@@_doc_title:nnnn \l_tmpa_tl {#1} }
{ \bfseries \@title }
}
\cs_new_protected:Npn \@@_doc_title:nnnn #1#2#3#4
{
\bfseries \@title
\sectionmark {#1}
\skip_horizontal:N \tex_rightskip:D
\hbox_overlap_left:n
{
\bookmark [ level = section , dest = doc@#4 ] {#1}
\hyper@link { link } { doc@#2 }
{ \mdseries \small \sffamily \ding {43} \ #3 }
}
\hook_gput_next_code:nn
{ shipout / background }
{ \pdf_destination:nn { doc@#4 } { xyz } }
\skip_zero:N \tex_rightskip:D
}
\prop_const_from_keyval:Nn \c_@@_doc_prop
{
en = { Basic~Usage } { zh } { 中文版本 } ,
zh = { 基本用法 } { en } { English~Version }
}
\NewDocumentCommand \docversion { m }
{
\tl_gset:Nx \g_@@_doc_tl {#1}
\tl_gtrim_spaces:N \g_@@_doc_tl
}
\tl_new:N \g_@@_doc_tl
\makeatother
\ExplSyntaxOff
\DeclareDocumentCommand \EXAMPLE { }
{
What power art thou, who, from below,
Hast made me rise, unwillingly and slow,
From beds of everlasting snow.
}
\ctexset { secnumdepth = part }
\begin{document}
\DocInput{\jobname.dtx}
\IndexLayout
\PrintChanges
\PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{3127}
%
% \changes{v0.1}{2022/07/05}{初始版本。}
% \changes{v0.1}{2022/07/20}{首次提交到 CTAN 发布。}
% \changes{v0.2}{2022/07/21}{改进放置方式。}
% \changes{v0.4}{2022/12/06}{补充 Jasper Habicht 翻译的英文用户使用说明。}
%
% \GetFileId{wrapstuff.sty}
%
% \title{The \pkg{wrapstuff} Package}
% \author{Qing Lee\thanks{Translation by Jasper Habicht <\email{[email protected]}>}}
% \date{\filedate\qquad\fileversion\thanks{\gitsha{\ExplFileVersion}.}}
% \docversion{en}
% \maketitle
%
% \begin{documentation}
%
% \ctexset { figurename = Figure }
% \STOPFUNCTIONLABEL
%
% The \pkg{wrapstuff} package provides an alternative way for arranging the layout of images and text.
% The \pkg{wrapstuff} package tries to combine and extend the functionality of packages such as \pkg{picinpar}, \pkg{floatflt}, \pkg{wrapfig},
% \pkg{cutwin} or \pkg{wrapfig2}.
% This package is compatible with the \pkg{caption} package, the \pkg{float} package and the \pkg{floatrow} package and aims at being compatible with (display) math environments as well as the various \LaTeX\ environments for typesetting tables, which it can wrap properly.
%
% The implementation of the \pkg{wrapstuff} package relies on the paragraph hook management provided by \LaTeX\ 2021-06-01 or later. It requires \LaTeXiii\ 2022-04-10 or later.
%
% \begin{function}{wrapstuff}
% \begin{syntax}
% \tn{begin}\{wrapstuff\}\oarg{options}
% <contents>
% \tn{end}\{wrapstuff\}
% <surrounding text>
% \end{syntax}
% The \pkg{wrapstuff} package only provides the \env{wrapstuff} environment, which will let the following paragraph wrap around its contents. For example:
% \begin{Example}[frame=single,numbers=none,gobble=5]
% \begin{wrapstuff}[c,top=1]
% \includegraphics[width=12em]{example-image.pdf}
% \end{wrapstuff}
% \EXAMPLE \EXAMPLE \EXAMPLE \EXAMPLE \EXAMPLE \par
% \end{Example}
% \end{function}
%
% \begin{function}{\wrapstuffset}
% \begin{syntax}
% \tn{wrapstuffset} \Arg{option list}
% \end{syntax}
% Options to the \pkg{wrapstuff} package can be set when loading the package with the \tn{usepackage} macro as well as later using \tn{wrapstuffset}.
% The following options are available:
% \end{function}
%
% \ADDSPECEIALKEY{\textrm{\meta{n}}}
% \begin{function}{top}
% \begin{syntax}
% top = <non-negative integer>
% \end{syntax}
% This option sets the line number where the wrapping should start. The option can take any non-negative integer \meta{n}.
% The initial value is \num{0}.
% \end{function}
%
% \begin{function}{width}
% \begin{syntax}
% width = <dimension>
% \end{syntax}
% This option sets the width of the contents. The initial value is \qty{0}{pt}, denoting the natural width of the contents of the \env{wrapstuff} environment.
% Using the initial value of \qty{0}{pt}, the contents of the \env{wrapstuff} environment can only take one logical line and may not contain |\\| for inserting line breaks or \tn{par} for separating paragraphs.
% If you want to break lines or put several paragraphs into the \env{wrapstuff} environment, the option \opt{width} must be set to an appropriate dimension.
% \end{function}
%
% \begin{function}{height}
% \begin{syntax}
% height = <dimension>
% \end{syntax}
% This option sets the height of the contents. The initial value is \qty{0}{pt}, denoting the natural height of the contents of the \env{wrapstuff} environment.
% \end{function}
%
% \begin{function}{lines}
% \begin{syntax}
% lines = <integer>
% \end{syntax}
% This option sets the number of lines of the surrounding text the contents should cover. It takes any integer.
% The initial value is empty, which means that the number of lines is calculated from the contents of the \env{wrapstuff} environment.
% \end{function}
%
% \begin{function}{linewidth}
% \begin{syntax}
% linewidth = <dimension>
% \end{syntax}
% This option sets the line width of the surrounding text. The initial value is |\linewidth|. This option needs not to be changed in general.
% \end{function}
%
% \begin{function}{l,r,c,i,o,ratio}
% \begin{syntax}
% l/r/c/i/o
% ratio = <real number>
% \end{syntax}
% These options are used to set the arrangement of the contents of the \env{wrapstuff} environment relative to the surrounding text.
% The options \opt{l/r/c/i/o} set the alignment of the contents of the \env{wrapstuff} environment such that it sits on the left side, the right side, in the center, on the inner side or on the outer side of the surrounding text respectively.
% The option \opt{ratio} sets the ratio of the width of the part of the surrounding text that wraps around the left side. It can be set to any sensible real number within the range $[0,1]$.
% The options \opt{i/o} can be used together with the option \opt{ratio}.
% The initial value is |r|, which means that the contents of the \env{wrapstuff} environment sit on the right side and the surrounding text wraps around the left side.
% \end{function}
%
% \begin{function}{column}
% \begin{syntax}
% column = <(true)|false|par>
% \end{syntax}
% This option controls whether the contents of the \env{wrapstuff} environment should be wrapped by text that is split over two columns. Setting this option to |true| only works if the option \opt{c} is set or the option \opt{ratio} is set to a value other than $0$ or $1$.
% \opt{false} means that the characters of the surrounding text are typeset from the left to the right for each line.
% \opt{par} sets the unit for typesetting columns to paragraphs. Compare the below example:
% \end{function}
% \begin{Example}[frame=single,numbers=none,gobble=5]
% \begin{wrapstuff}[c,1]
% \IMAGE{6em}{a}
% \end{wrapstuff}
% \EXAMPLE \EXAMPLE \par \EXAMPLE \EXAMPLE \par
% \medskip
% \begin{wrapstuff}[c,1,column=par]
% \IMAGE{6em}{b}
% \end{wrapstuff}
% \EXAMPLE \EXAMPLE \par \EXAMPLE \EXAMPLE \par
% \medskip
% \begin{wrapstuff}[c,0,column=false]
% \IMAGE{6em}{c}
% \end{wrapstuff}
% \EXAMPLE \EXAMPLE \par \EXAMPLE \EXAMPLE \par
% \end{Example}
%
% \begin{function}{leftsep,rightsep,hsep}
% \begin{syntax}
% leftsep = <dimension>
% rightsep = <dimension>
% hsep = <dimension>
% \end{syntax}
% These options set the width of the margin to the right and left of the contents of the \env{wrapstuff} environment to separate it from the surrounding text. The option \opt{hsep} sets the same value for \opt{leftsep} and \opt{rightsep}. The initial value is \qty{1}{em}.
% \end{function}
%
% \begin{function}{abovesep,belowsep,vsep}
% \begin{syntax}
% abovesep = <dimension>
% belowsep = <dimension>
% vsep = <dimension>
% \end{syntax}
% These options set the width of the margin above and below the contents of the \env{wrapstuff} environment to separate it from the surrounding text. The option \opt{vsep} sets the same value for \opt{abovesep} and \opt{belowsep}. The initial value is \qty{0}{pt}.
% \end{function}
%
% \begin{function}{hoffset}
% \begin{syntax}
% hoffset = <dimension>
% \end{syntax}
% This option sets the length of the horizontal offset the contents of the \env{wrapstuff} environment should extend over the text margin.
% If the option \opt{c} is set or the option \opt{ratio} is set to a number other than $0$ or $1$, this option has no effect.
% A specific value for \tn{width} can be used to set the total width of the contents of the \env{wrapstuff} environment and the relevant offset.
% Setting \opt{hoffset} to the value of \tn{width} will completely shift the contents of the \env{wrapstuff} environment outside the text margin.
% The initial value is \qty{0}{pt}.
% \end{function}
%
% \begin{function}{voffset}
% \begin{syntax}
% voffset = <dimension>
% \end{syntax}
% This option can be used to control the vertical positioning of the contents of the \env{wrapstuff} environment.
% The initial value is \qty{0}{pt}。
% \end{function}
%
% \begin{function}{type}
% \begin{syntax}
% type = <type of floating environment>
% \end{syntax}
% This option controls the type of the floating environment that should be used for the contents of the \env{wrapstuff} environment. The initial value is empty.
% If the \tn{caption} macro is to be used inside the \env{wrapstuff} environment, the value of the \opt{type} option should be set to \opt{figure} or \opt{table} (or the type of the relevant floating environment that is used) and the \opt{width} option should be set to a specific length.
% \begin{Example}[frame=single,numbers=none,gobble=5]
% \begin{wrapstuff}[type=figure,width=15em]
% \centering
% \IMAGE{10em}{plain}
% \caption{Example}
% \end{wrapstuff}
% \EXAMPLE \EXAMPLE \par \EXAMPLE \EXAMPLE \par
% \end{Example}
% \end{function}
%
% \begin{function}{\wrapstuffclear}
% If the line count of the current paragraph of the surrounding text is not sufficient to fully enclose the contents of the \env{wrapstuff} environment, the wrapping will continue in the following paragraph.
% This may lead to some unwanted outcomes. If \tn{wrapstuffclear} is used before the following paragraph, this standard behavior of continuous wrapping is turned off.
% \end{function}
%
% \end{documentation}
%
% \clearpage
%
% \title{\pkg{wrapstuff} 宏包}
% \author{李清}
% \date{\filedate\qquad\fileversion\thanks{\gitsha{\ExplFileVersion}.}}
% \docversion{zh}
% \maketitle
%
% \begin{documentation}
%
% \pkg{wrapstuff} 宏包提供了图文绕排的另一种实现。
% \pkg{wrapstuff} 尝试整合和扩展 \pkg{picinpar}、\pkg{floatflt}、\pkg{wrapfig}、
% \pkg{cutwin} 和 \pkg{wrapfig2} 等同类宏包的功能。
% 本宏包兼容 \pkg{caption}、\pkg{float} 和 \pkg{floatrow} 等宏包，
% 并试图兼容显示（display）数学公式和各种 \LaTeX\ 列表环境，可以让他们正确绕排。
%
% \pkg{wrapstuff} 的实现依赖 \LaTeX\ 2021-06-01 开始提供的段落钩子，
% 并依赖 \LaTeXiii\ 2022-04-10 之后的版本。
%
% \begin{function}{wrapstuff}
% \begin{syntax}
% \tn{begin}\{wrapstuff\}\oarg{选项}
% <绕排内容>
% \tn{end}\{wrapstuff\}
% <正文>
% \end{syntax}
% \pkg{wrapstuff} 只提供了一个用户环境 \env{wrapstuff}，
% 会在环境之后的段落开始绕排。例如
% \begin{Example}[frame=single,numbers=none,gobble=5]
% \begin{wrapstuff}[c,top=1]
% \includegraphics[width=\dimeval{\linewidth/3}]{example-image.pdf}
% \end{wrapstuff}
% \zhlipsum[1][name=zhufu]
% \end{Example}
% \end{function}
%
% \begin{function}{\wrapstuffset}
% \begin{syntax}
% \tn{wrapstuffset} \Arg{选项列表}
% \end{syntax}
% \pkg{wrapstuff} 的选项可以在调用宏包时设置，也可以通过 \tn{wrapstuffset} 设置。
% 选项将在下面描述。
% \end{function}
%
% \ADDSPECEIALKEY{\textrm{\meta{n}}}
% \begin{function}{top}
% \begin{syntax}
% top = <非负整数>
% \end{syntax}
% 设置在正文段落的第几行之后开始绕排，可以设置为非负整数。
% 非负整数选项 \meta{n} 是设置选项 \opt{top} 为 \meta{n} 的缩写形式。
% 初始值是 \num{0}。
% \end{function}
%
% \begin{function}{width}
% \begin{syntax}
% width = <宽度>
% \end{syntax}
% 设置绕排内容的宽度，初始值为 \qty{0}{pt}，代表自然宽度。
% 此时，\env{wrapstuff} 环境内的内容只能有一行，不能使用 |\\| 换行或者 \tn{par} 分段。
% 如果需要在环境内换行或者分段，就需要将 \opt{width} 设置成合适的宽度。
% \end{function}
%
% \begin{function}{height}
% \begin{syntax}
% height = <高度>
% \end{syntax}
% 设置绕排内容的高度，初始值为 \qty{0}{pt}，代表自然高度。
% \end{function}
%
% \begin{function}{lines}
% \begin{syntax}
% lines = <正整数>
% \end{syntax}
% 设置绕排内容占据正文的行数，可以设置正整数。
% 初始值为空，根据绕排内容的高度自动计算行数。
% \end{function}
%
% \begin{function}{linewidth}
% \begin{syntax}
% linewidth = <宽度>
% \end{syntax}
% 设置正文段落的行宽，初始设置为 |\linewidth|，一般不需要调整。
% \end{function}
%
% \begin{function}{l,r,c,i,o,ratio}
% \begin{syntax}
% l/r/c/i/o
% ratio = <实数>
% \end{syntax}
% 这些选项用于设置绕排内容位于正文中的位置。
% 选项 \opt{l/r/c/i/o} 分别设置绕排内容位于正文的左侧、右侧、中间、内侧、外侧。
% 选项 \opt{ratio} 设置绕排内容左侧的正文占据行宽的比例，可以设置为 $[0,1]$ 区间中的合理实数。
% 选项 \opt{i/o} 可以与 \opt{ratio} 一起使用，这时设置的是内/外侧正文的行宽比例。
% 初始设置为 |r|，即位于正文的右侧。
% \end{function}
%
% \begin{function}{column}
% \begin{syntax}
% column = <(true)|false|par>
% \end{syntax}
% 控制是否将绕排内容两侧的正文分栏显示，只有设置 |c| 选项或者
% 设置 \opt{ratio} 不等于 $0$ 或者 $1$ 时才有效。
% \opt{false} 表示不分栏，正文文字方向始终保持从左到右的顺序；
% \opt{par} 表示以段落为单位进行分栏，如下示例。
% \begin{SideBySideExample}[xrightmargin=\dimeval{20em+5mm}]
% \begin{wrapstuff}[c,1]
% \IMAGE{2em}{a}
% \end{wrapstuff}
% \QIANZIWEN
% \begin{wrapstuff}[c,1,column=par]
% \IMAGE{2em}{b}
% \end{wrapstuff}
% \QIANZIWEN
% \begin{wrapstuff}[c,0,column=false]
% \IMAGE{2em}{c}
% \end{wrapstuff}
% \QIANZIWEN
% \end{SideBySideExample}
% \end{function}
%
% \begin{function}{leftsep,rightsep,hsep}
% \begin{syntax}
% leftsep = <长度>
% rightsep = <长度>
% hsep = <长度>
% \end{syntax}
% 设置绕排内容与正文的左/右间距，选项 \opt{hsep} 同时设置 \opt{leftsep} 和 \opt{rightsep}。
% 初始值是 \qty{1}{em}。
% \end{function}
%
% \begin{function}{abovesep,belowsep,vsep}
% \begin{syntax}
% abovesep = <长度>
% belowsep = <长度>
% vsep = <长度>
% \end{syntax}
% 设置绕排内容与正文的上/下间距，选项 \opt{vsep} 同时设置 \opt{abovesep} 和 \opt{belowsep}。
% 初始值是 \qty{0}{pt}。
% \end{function}
%
% \begin{function}{hoffset}
% \begin{syntax}
% hoffset = <长度>
% \end{syntax}
% 设置绕排内容伸出正文版心的长度。
% 当设置了选项 \opt{c} 或者选项 \opt{ratio} 的值位于 $(0,1)$ 时，本选项无效。
% 一个特殊值 \tn{width} 用于表示绕排内容和相应间距的总宽度，
% 可以将 \opt{hoffset} 设置为 \tn{width}，完全伸出版心。
% 初始值为 \qty{0}{pt}。
% \end{function}
%
% \begin{function}{voffset}
% \begin{syntax}
% voffset = <长度>
% \end{syntax}
% 用于调整绕排内容的竖直位置，初始值为 \qty{0}{pt}。
% \end{function}
%
% \begin{function}{type}
% \begin{syntax}
% type = <浮动体类型>
% \end{syntax}
% 设置绕排内容的浮动体类型，初始值为空。
% 如果需要在 \env{wrapstuff} 环境中使用 \tn{caption} 命令，
% 则需要设置 \opt{type} 为 \opt{figure} 或 \opt{table} 等类型，
% 并需要同时设置 \opt{width} 指定宽度。
% \begin{SideBySideExample}[xrightmargin=\dimeval{18em+5mm}]
% \begin{wrapstuff}[type=figure,width=5em]
% \centering
% \IMAGE{4em}{plain}
% \caption{示例}
% \end{wrapstuff}
% \QIANZIWEN
% \end{SideBySideExample}
% \end{function}
%
% \begin{function}{\wrapstuffclear}
% 如果当前正文段落的行数不够，\pkg{wrapstuff} 的作用会延续到下一段。
% 这可能会导致某些意外结果，可以在下一段之前启用命令 \tn{wrapstuffclear} 消除影响。
% \end{function}
%
% \end{documentation}
%
%
% \StopEventually{}
%
%
% \begin{implementation}
%
% \section{代码实现}
%
% \begin{macrocode}
%<*package>
% \end{macrocode}
%
% \begin{macrocode}
%<@@=wstf>
% \end{macrocode}
%
% \pkg{wrapstuff} 的实现依赖 \LaTeX\ 2021-06-01 开始提供的段落钩子。
% \begin{macrocode}
\@ifl@t@r \fmtversion { 2021-06-01 }
{ }
{
\msg_new:nnn { wrapstuff } { latex-too-old }
{
You~need~to~update~your~LaTeX~to~the~latest~release. \\
Loading~wrapstuff~will~abort!
}
\msg_critical:nn { wrapstuff } { latex-too-old }
}
% \end{macrocode}
%
% 由于使用了 \cs{keys_precompile:nnN}，需要比较新的 \LaTeXiii。
% \begin{macrocode}
\@ifl@t@r \ExplLoaderFileDate { 2022-04-10 }
{ }
{
\msg_new:nnn { wrapstuff } { latex3-too-old }
{
You~need~to~update~your~installation~of~the~bundles~
"l3kernel"~and~"l3packages". \\
Loading~wrapstuff~will~abort!
}
\msg_critical:nn { wrapstuff } { latex3-too-old }
}
% \end{macrocode}
%
% \begin{macrocode}
\prop_gput:Nnn \g_msg_module_name_prop { wstf } { wrapstuff }
% \end{macrocode}
%
% \begin{macro}[var]{
% \c_@@_global_tl_tl,
% \c_@@_global_dim_tl,
% \c_@@_global_int_tl,
% \c_@@_global_bool_tl}
% 一些需要全局设置的变量。
% \begin{macrocode}
\tl_const:Nn \c_@@_global_tl_tl
{ \g_@@_main_setting_tl }
\tl_const:Nn \c_@@_global_dim_tl
{
\g_@@_hang_ht_dim
\g_@@_total_ht_dim
\g_@@_stuff_ht_dim
\g_@@_stuff_wd_dim
\g_@@_first_dp_dim
\g_@@_first_sep_dim
\g_@@_prevdepth_dim
\g_@@_column_ht_dim
\g_@@_window_ht_dim
\g_@@_remaining_dim
\g_@@_column_room_dim
\g_@@_parshape_indent_dim
\g_@@_parshape_length_dim
}
\tl_const:Nn \c_@@_global_int_tl
{
\g_@@_top_int
\g_@@_column_int
\g_@@_window_int
}
\tl_const:Nn \c_@@_global_bool_tl
{
\g_@@_next_bool
\g_@@_leqno_bool
\g_@@_column_bool
\g_@@_entire_bool
\g_@@_display_bool
\g_@@_move_hang_bool
\g_@@_next_hang_bool
\g_@@_first_set_bool
\g_@@_first_save_bool
\g_@@_right_move_bool
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{
% \@@_tl_init:N,
% \@@_dim_init:N,
% \@@_int_init:N,
% \@@_bool_init:N}
% 全局变量的初始化，注意保存好清除和恢复的设置。
% \begin{macrocode}
\cs_new_protected:Npn \@@_tl_init:N #1
{
\tl_new:N #1
\tl_gput_right:Nn \g_@@_var_clear_tl
{ \tl_gclear:N #1 }
\tl_gput_right:Nn \g_@@_var_push_tl
{ \tl_gset:Nn \exp_not:N #1 { \exp_not:o {#1} } }
}
\cs_new_protected:Npn \@@_dim_init:N #1
{
\dim_new:N #1
\tl_gput_right:Nn \g_@@_var_clear_tl
{ \dim_gzero:N #1 }
\tl_gput_right:Nn \g_@@_var_push_tl
{ \dim_gset:Nn #1 { \dim_use:N #1 } }
}
\cs_new_protected:Npn \@@_int_init:N #1
{
\int_new:N #1
\tl_gput_right:Nn \g_@@_var_clear_tl
{ \int_gzero:N #1 }
\tl_gput_right:Nn \g_@@_var_push_tl
{ \int_gset:Nn #1 { \int_use:N #1 } }
}
\cs_new_protected:Npn \@@_bool_init:N #1
{
\bool_new:N #1
\tl_gput_right:Nn \g_@@_var_clear_tl
{ \bool_gset_false:N #1 }
\tl_gput_right:Nn \g_@@_var_push_tl
{
\bool_if:NTF #1
{ \bool_gset_true:N #1 }
{ \bool_gset_false:N #1 }
}
}
\tl_new:N \g_@@_var_clear_tl
\tl_new:N \g_@@_var_push_tl
\tl_map_function:NN \c_@@_global_tl_tl \@@_tl_init:N
\tl_map_function:NN \c_@@_global_dim_tl \@@_dim_init:N
\tl_map_function:NN \c_@@_global_int_tl \@@_int_init:N
\tl_map_function:NN \c_@@_global_bool_tl \@@_bool_init:N
% \end{macrocode}
% \cs{g_@@_top_int} 的初始值是 $-1$。
% \begin{macrocode}
\int_gdecr:N \g_@@_top_int
\tl_gput_right:Nn \g_@@_var_clear_tl
{ \int_gdecr:N \g_@@_top_int }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{
% \@@_clear:,
% \@@_clear_variable:,
% \@@_clear_kludge:,
% \@@_clear_stuff_box:}
% \begin{macrocode}
\cs_new_protected_nopar:Npn \@@_clear:
{
\@@_clear_para_hook:
\@@_clear_kludge:
\@@_clear_variable:
}
\cs_new_protected_nopar:Npn \@@_clear_variable:
{
\tl_use:N \g_@@_var_clear_tl
\box_gclear:N \g_@@_stuff_box
}
\cs_new_protected_nopar:Npn \@@_clear_kludge:
{
\bool_if:NTF \g_@@_next_bool
{
\skip_vertical:n
{ \tex_baselineskip:D * \g_@@_window_int }
}
{
\box_if_empty:NF \g_@@_stuff_box
{ \@@_clear_stuff_box: }
}
}
\cs_new_protected_nopar:Npn \@@_clear_stuff_box:
{
\@@_ignore_depth:
\skip_set:Nn \l_@@_last_skip
{ \box_dp:N \strutbox }
\skip_vertical:N \l_@@_last_skip
\box_use_drop:N \g_@@_stuff_box
\skip_vertical:N \l_@@_last_skip
\@@_ignore_depth:
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{
% \@@_status_push:,
% \@@_status_pop:,
% \@@_status_restore:,
% \@@_status_clear:}
% 全局变量的保存与恢复。
% \begin{macrocode}
\cs_new_protected_nopar:Npn \@@_status_push:
{
\tl_clear:N \l_@@_status_tl
\int_gincr:N \g_@@_status_int
\exp_args:Ne \@@_status_push_aux:n
{ \int_use:N \g_@@_status_int }
\seq_gpush:No \g_@@_status_seq { \l_@@_status_tl }
}
\cs_new_protected:Npn \@@_status_push_aux:n #1
{
\@@_push_cs:nN {#1} \@@_para_before:
\@@_push_cs:nN {#1} \@@_para_begin:
\@@_push_cs:nN {#1} \@@_para_end:
\@@_push_cs:nN {#1} \@@_display_hook:
\@@_push_box:N \g_@@_stuff_box
\@@_push_var:
}
\cs_new_protected:Npn \@@_push_cs:nN #1#2
{
\exp_args:NNc \@@_push_cs_aux:NN #2
{ @@_ #1 _ \token_to_str:N #2 }
}
\cs_new_protected:Npn \@@_push_cs_aux:NN #1#2
{
\cs_gset_eq:NN #2#1
\tl_put_right:Nn \l_@@_status_tl
{
\cs_gset_eq:NN #1#2
\cs_undefine:N #2
}
}
\cs_new_protected:Npn \@@_push_box:N #1
{
\hbox_gset:Nn \g_@@_stauts_box
{
\hbox_unpack_drop:N \g_@@_stauts_box
\box_use:N #1
}
\tl_put_right:Nn \l_@@_status_tl
{ \@@_pop_box:N #1 }
}
\cs_new_protected:Npn \@@_pop_box:N #1
{
\hbox_gset:Nw \g_@@_stauts_box
\hbox_unpack_drop:N \g_@@_stauts_box
\box_gset_to_last:N #1
\@@_if_last_hlist:TF
{ \hbox_gset_end: }
{
\hbox_gset_end:
\box_gclear:N \g_@@_stauts_box
}
}
\cs_new_protected_nopar:Npn \@@_push_var:
{
\tl_put_right:Nx \l_@@_status_tl
{ \g_@@_var_push_tl }
}
\cs_new_protected_nopar:Npn \@@_status_pop:
{
\seq_gpop:NNT \g_@@_status_seq \l_@@_status_tl
{
\int_gdecr:N \g_@@_status_int
\tl_use:N \l_@@_status_tl
}
}
\cs_new_protected_nopar:Npn \@@_status_restore:
{
\@@_status_push:
\@@_clear_para_hook:
\@@_clear_display_hook:
\@@_clear_variable:
\group_insert_after:N \@@_status_pop:
}
\cs_new_protected_nopar:Npn \@@_status_clear:
{
\bool_if:NT \g_@@_next_bool
{
\@@_clear_para_hook:
\@@_clear_variable:
}
}
\tl_new:N \l_@@_status_tl
\box_new:N \g_@@_stauts_box
\int_new:N \g_@@_status_int
\seq_new:N \g_@@_status_seq
% \end{macrocode}
% \end{macro}
%
% \changes{v0.2}{2022/07/21}{兼容 \tn{parbox} 与 \env{minipage} 等使用环境。}
%
% \begin{macro}{\wrapstuff@parboxrestore,\@arrayparboxrestore}
% 在 \LaTeX\ 的 \cs{parbox} 和 \env{minipage} 等环境中恢复正常的段落状态。
% \tn{wrapstuff@parboxrestore} 的初始值是在分组后清除活动的段落钩子和相关全局变量，
% 只有在 \env{wrapstuff@par} 环境内部才等于 \cs{@@_status_restore:}，
% 保存和恢复相关状态。
% \begin{macrocode}
\cs_new_protected_nopar:Npn \wrapstuff@parboxrestore
{ \group_insert_after:N \@@_status_clear: }
\cs_new_protected_nopar:Npn \@@_parbox_restore:
{
\cs_set_eq:NN
\wrapstuff@parboxrestore
\@@_status_restore:
}
\g@addto@macro \@arrayparboxrestore
{ \wrapstuff@parboxrestore }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}[TF]{
% \@@_if_last_none:,
% \@@_if_last_hlist:,
% \@@_if_last_whatsit:,
% \@@_if_last_glue:,
% \@@_if_last_kern:,
% \@@_if_last_penalty:}
% 一些 \hologo{eTeX} 结点判定函数。
% \begin{macrocode}
\group_begin:
\cs_set:Npn \@@_tmp:nn #1
{
\exp_args:Ncc \@@_tmp_aux:NNn
{ @@_if_last_ #1 : }
{ c_@@_ #1 _node }
}
\cs_set:Npn \@@_tmp_aux:NNn #1#2#3
{
\int_const:Nn #2 {#3}
\prg_new_conditional:Npnn #1 { T , F , TF }
{
\if_int_compare:w \tex_lastnodetype:D = #2
\prg_return_true: \else: \prg_return_false: \fi:
}
}
\@@_tmp:nn { none } { -1 }
\@@_tmp:nn { hlist } { 1 }
\@@_tmp:nn { whatsit } { 9 }
\@@_tmp:nn { glue } { 11 }
\@@_tmp:nn { kern } { 12 }
\@@_tmp:nn { penalty } { 13 }
\group_end:
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_gadd_hook:nn, \@@_package_hook:nn}
% \begin{macrocode}
\cs_new_protected:Npn \@@_gadd_hook:nn #1
{ \hook_gput_code:nnn {#1} { wrapstuff } }
\cs_new_protected:Npn \@@_package_hook:nn #1
{ \hook_gput_code:nnn { package/#1/after } { wrapstuff } }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_para_raw_end:}
% 将 \cs{para_raw_end:} 放在分组中是为了保持 \tn{parshape}。
% \begin{macrocode}
\cs_new_protected_nopar:Npn \@@_para_raw_end:
{ \group_begin: \para_raw_end: \group_end: }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_gadd_ht:Nn}
% \begin{macrocode}
\cs_new_protected:Npn \@@_gadd_ht:Nn #1#2
{ \box_gset_ht:Nn #1 { \box_ht:N #1 + \dim_eval:n {#2} } }
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{wrapstuff}
% 主要功能环境接口。
% \begin{macrocode}
\NewDocumentEnvironment { wrapstuff } { O { } }
{
\@@_clear:
\int_set:Nn \l_@@_top_int { -1 }
\tl_if_blank:nTF {#1}
{ \tl_clear:N \l_@@_main_kv_tl }
{
\keys_set_filter:nnnN { wrapstuff }
{ main , ratio }
{#1} \l_@@_main_kv_tl
}
\tl_set:Nx \l_@@_type_tl { \l_@@_type_tl }
\dim_set:Nn \l_@@_width_dim { \l_@@_width_tl }
\dim_set:Nn \l_@@_height_dim { \l_@@_height_tl }
\hbox_gset:Nw \g_@@_stuff_box
\dim_compare:nNnTF \l_@@_width_dim > \c_zero_dim
{ \@@_minipage_begin: }
{ \@@_hbox_begin: }
}
{
\dim_compare:nNnTF \l_@@_width_dim > \c_zero_dim
{ \@@_minipage_end: }
{ \@@_hbox_end: }
\@@_set_vsep:
\@@_attach_label:
\tl_if_empty:NTF \l_@@_main_kv_tl
{ \tl_gclear:N \g_@@_main_setting_tl }
{ \@@_save_main_setting: }
\@@_set_top_line: