summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/l3kernel/l3io.dtx
blob: 206d2daed0955e583834d48d2770ff6ab356fc15 (plain)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
% \iffalse meta-comment
%
%% File: l3io.dtx Copyright (C) 1990-2012 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
%% license or (at your option) any later version.  The latest version
%% of this license is in the file
%%
%%    http://www.latex-project.org/lppl.txt
%%
%% This file is part of the "l3kernel bundle" (The Work in LPPL)
%% and all files in that bundle must be distributed together.
%%
%% The released version of this bundle is available from CTAN.
%%
%% -----------------------------------------------------------------------
%%
%% The development version of the bundle can be found at
%%
%%    http://www.latex-project.org/svnroot/experimental/trunk/
%%
%% for those people who are interested.
%%
%%%%%%%%%%%
%% NOTE: %%
%%%%%%%%%%%
%%
%%   Snapshots taken from the repository represent work in progress and may
%%   not work or may contain conflicting material!  We therefore ask
%%   people _not_ to put them into distributions, archives, etc. without
%%   prior consultation with the LaTeX3 Project.
%%
%% -----------------------------------------------------------------------
%
%<*driver|package>
\RequirePackage{l3names}
\GetIdInfo$Id: l3io.dtx 3245 2012-01-28 02:58:37Z bruno $
  {L3 Experimental input-output operations}
%</driver|package>
%<*driver>
\documentclass[full]{l3doc}
\begin{document}
  \DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
%
% \title{^^A
%   The \pkg{l3io} package\\ Input--output operations^^A
%   \thanks{This file describes v\ExplFileVersion,
%      last revised \ExplFileDate.}^^A
% }
%
% \author{^^A
%  The \LaTeX3 Project\thanks
%    {^^A
%      E-mail:
%        \href{mailto:latex-team@latex-project.org}
%          {latex-team@latex-project.org}^^A
%    }^^A
% }
%
% \date{Released \ExplFileDate}
%
% \maketitle
%
% \begin{documentation}
%
% Reading and writing from file streams is handled in \LaTeX3 using
% functions with prefixes \cs{iow_\ldots} (file reading) and
% \cs{ior_\ldots} (file writing). Many of the basic functions are
% very similar, with reading and writing using the same syntax and
% function concepts. As a result, the reading and writing functions
% are documented together where this makes sense.
%
% As \TeX{} is limited to $16$ input streams and $16$ output
% streams, direct use of the streams by the programmer is not
% supported in \LaTeX3. Instead, an internal pool of streams is
% maintained, and these are allocated and deallocated as needed
% by other modules. As a result, the programmer should close streams
% when they are no longer needed, to release them for other processes.
%
% Reading from or writing to a file requires a \meta{stream} to
% be used. This is a csname which refers to the file being processed,
% and is independent of the name of the file (except of course that
% the file name is needed when the file is opened).
%
% \section{Managing streams}
%
% \begin{function}[added = 2011-09-26, updated = 2011-12-27]
%   {\ior_new:N, \ior_new:c, \iow_new:N, \io_new:c}
%   \begin{syntax}
%     \cs{ior_new:Nn} \meta{stream}
%   \end{syntax}
%   Globally reserves the name of the \meta{stream}, either for reading
%   or for writing as appropriate. The \meta{stream} is not opened until the
%   appropriate \cs{\ldots_open:Nn} function is used. Attempting to use
%   a \meta{stream} which has not been opened will result in a \TeX{}
%   error.
% \end{function}
%
% \begin{function}[updated = 2012-01-25]{\ior_open:Nn, \ior_open:cn}
%   \begin{syntax}
%     \cs{ior_open:Nn} \meta{stream} \Arg{file name}
%   \end{syntax}
%   Opens \meta{file name} for reading using \meta{stream} as the
%   control sequence for file access. If the \meta{stream} was already
%   open it is closed before the new operation begins. The
%   \meta{stream} is available for access immediately and will remain
%   allocated to \meta{file name} until a \cs{ior_close:N} instruction
%   is given or the file ends.
%   \begin{texnote}
%     The \meta{file name} may contain both literal items and expandable
%     content, which should on full expansion be the desired file name.
%     Any active characters (as declared in \cs{l_char_active_seq}) will
%     \emph{not} be expanded, allowing the direct use of these in
%     file names.
%   \end{texnote}
% \end{function}
%
% \begin{function}[updated = 2012-01-25]{\iow_open:Nn, \iow_open:cn}
%   \begin{syntax}
%     \cs{iow_open:Nn} \meta{stream} \Arg{file name}
%   \end{syntax}
%   Opens \meta{file name} for writing using \meta{stream} as the
%   control sequence for file access. If the \meta{stream} was already
%   open it is closed before the new operation begins. The
%   \meta{stream} is available for access immediately and will remain
%   allocated to \meta{file name} until a \cs{iow_close:N} instruction
%   is given or the file ends. Opening a file for writing will clear
%   any existing content in the file (\emph{i.e.}~writing is \emph{not}
%   additive).
%   \begin{texnote}
%     The \meta{file name} may contain both literal items and expandable
%     content, which should on full expansion be the desired file name.
%     Any active characters (as declared in \cs{l_char_active_seq}) will
%     \emph{not} be expanded, allowing the direct use of these in
%     file names.
%   \end{texnote}
% \end{function}
%
% \begin{function}[updated = 2011-12-27]{\ior_close:N, \ior_close:c}
%   \begin{syntax}
%     \cs{ior_close:N} \meta{stream}
%   \end{syntax}
%   Closes the \meta{stream}. Streams should always be closed when
%   they are finished with as this ensures that they remain available
%   to other programmer.
% \end{function}
%
% \begin{function}[updated = 2011-12-27]{\iow_close:N, \iow_close:c}
%   \begin{syntax}
%     \cs{iow_close:N} \meta{stream}
%   \end{syntax}
%   Closes the \meta{stream}. Streams should always be closed when
%   they are finished with as this ensures that they remain available
%   to other programmer.
% \end{function}
%
% \begin{function}{\ior_list_streams:, \iow_list_streams:}
%   \begin{syntax}
%     \cs{ior_list_streams:} \\
%     \cs{iow_list_streams:}
%   \end{syntax}
%   Displays a list of the file names associated with each open
%   stream: intended for tracking down problems.
% \end{function}
%
% \section{Writing to files}
%
% \begin{function}{\iow_now:Nn, \iow_now:Nx}
%   \begin{syntax}
%     \cs{iow_now:Nn} \meta{stream} \Arg{tokens}
%   \end{syntax}
%   This functions writes \meta{tokens} to the specified
%   \meta{stream} immediately (\emph{i.e.}~the write operation is called
%   on expansion of \cs{iow_now:Nn}).
%   \begin{texnote}
%     \cs{iow_now:Nx} is a protected macro which expands to
%     the two \TeX{} primitives \tn{immediate}\tn{write}.
%   \end{texnote}
% \end{function}
%
% \begin{function}{\iow_log:n, \iow_log:x}
%   \begin{syntax}
%     \cs{iow_log:n} \Arg{tokens}
%   \end{syntax}
%   This function writes the given \meta{tokens} to the log (transcript)
%   file immediately: it is a dedicated version of \cs{iow_now:Nn}.
% \end{function}
%
% \begin{function}{\iow_term:n, \iow_term:x}
%   \begin{syntax}
%     \cs{iow_term:n} \Arg{tokens}
%   \end{syntax}
%   This function writes the given \meta{tokens} to the terminal
%   file immediately: it is a dedicated version of \cs{iow_now:Nn}.
% \end{function}
%
% \begin{function}{\iow_now_when_avail:Nn, \iow_now_when_avail:Nx}
%   \begin{syntax}
%     \cs{iow_now_when_avail:Nn} \meta{stream} \Arg{tokens}
%   \end{syntax}
%   If \meta{stream} is open, writes the \meta{tokens} to the \meta{stream}
%   in the  same manner as \cs{iow_now:Nn}. If the \meta{stream} is not open,
%   the \meta{tokens}are simply thrown away.
% \end{function}
%
% \begin{function}{\iow_shipout:Nn, \iow_shipout:Nx}
%   \begin{syntax}
%     \cs{iow_shipout:Nn} \meta{stream} \Arg{tokens}
%   \end{syntax}
%   This functions writes \meta{tokens} to the specified
%   \meta{stream} when the current page is finalised (\emph{i.e.}~at
%   shipout). The \texttt{x}-type variants expand the \meta{tokens}
%   at the point where the function is used but \emph{not} when the
%   resulting tokens are written to the \meta{stream}
%   (\emph{cf.}~\cs{iow_shipout_x:Nn}).
% \end{function}
%
% \begin{function}{\iow_shipout_x:Nn, \iow_shipout_x:Nx}
%   \begin{syntax}
%     \cs{iow_shipout_x:Nn} \meta{stream} \Arg{tokens}
%   \end{syntax}
%   This functions writes \meta{tokens} to the specified
%   \meta{stream} when the current page is finalised (\emph{i.e}.~at
%   shipout). The \meta{tokens} are expanded at the time of writing
%   in addition to any expansion when the function is used. This makes
%   these functions suitable for including material finalised during
%   the page building process (such as the page number integer).
%   \begin{texnote}
%     \cs{iow_shipout_x:Nn} is the \TeX{} primitive \tn{write} renamed.
%   \end{texnote}
% \end{function}
%
% \begin{function}[EXP]{\iow_char:N}
%   \begin{syntax}
%     \cs{iow_char:N} \meta{token}
%   \end{syntax}
%   Inserts \meta{token} into the output stream. Useful when trying to
%   write difficult characters such as "%", "{", "}",
%   \emph{etc}.~in messages, for example:
%   \begin{verbatim}
%     \iow_now:Nx \g_my_iow { \iow_char:N \{ text \iow_char:N \} }
%   \end{verbatim}
%   The function has no effect if writing is taking place without
%   expansion (\emph{e.g.}~in the second argument of \cs{iow_now:Nn}).
% \end{function}
%
% \begin{function}[EXP]{\iow_newline:}
%   \begin{syntax}
%     \cs{iow_newline:}
%   \end{syntax}
%   Function to add a new line within the \meta{tokens} written to a
%   file. The function has no effect if writing is taking place without
%   expansion (\emph{e.g.}~in the second argument of \cs{iow_now:Nn}).
% \end{function}
%
% \section{Wrapping lines in output}
%
% \begin{function}[updated = 2011-09-21]{\iow_wrap:xnnnN}
%   \begin{syntax}
%     \cs{iow_wrap:xnnnN} \Arg{text} \Arg{run-on text} \Arg{run-on length} \Arg{set up} \meta{function}
%   \end{syntax}
%   This function will wrap the \meta{text} to a fixed number of
%   characters per line. At the start of each line which is wrapped,
%   the \meta{run-on text} will be inserted.  The line length targeted
%   will be the value of \cs{l_iow_line_length_int} minus the
%   \meta{run-on length}. The later value should be the number of
%   characters in the \meta{run-on text}. Additional functions may be
%   added to the wrapping by using the \meta{set up}, which is executed
%   before the wrapping takes place. The result of the wrapping operation
%   is passed as a braced argument to the \meta{function}, which will
%   typically be a wrapper around a writing operation. Within the
%   \meta{text},
%   \begin{itemize}
%   \item |\\| may be used to force a new line,
%   \item \verb|\ | may be used to represent a forced space
%     (for example after a control sequence),
%   \item |\#|, |\%|, |\{|, |\}|, |\~| may be used to represent
%     the corresponding character,
%   \item \cs{iow_indent:n} may be used to indent a part of the
%     message.
%   \end{itemize}
%   Both the wrapping process and the subsequent write operation
%   will perform \texttt{x}-type expansion. For this reason, material which
%   is to be written \enquote{as is} should be given as the argument to
%   \cs{token_to_str:N} or \cs{tl_to_str:n} (as appropriate) within
%   the \meta{text}. The output of \cs{iow_wrap:xnnnN} (\emph{i.e.}~the
%   argument passed to the \meta{function}) will consist of characters of
%   category code $12$ (other) and $10$ (space) only. This means that the
%   output will \emph{not} expand further when written to a file.
% \end{function}
%
% \begin{function}[added = 2011-09-21]{\iow_indent:n}
%   \begin{syntax}
%     \cs{iow_indent:n} \Arg{text}
%   \end{syntax}
%   In the context of \cs{iow_wrap:xnnnN} (for instance in messages),
%   indents \meta{text} by four spaces. This function will not cause
%   a line break, and only affects lines which start within the scope
%   of the \meta{text}. In case the indented \meta{text} should appear
%   on separate lines from the surrounding text, use |\\| to force
%   line breaks.
% \end{function}
%
% \begin{variable}{\l_iow_line_length_int}
%   The maximum length of a line to be written by the \cs{iow_wrap:xxnnN}
%   function. This value depends on the \TeX{} system in use: the standard
%   value is $78$, which is typically correct for unmodified \TeX{}live
%   and MiK\TeX{} systems.
% \end{variable}
%
% \begin{variable}[added = 2011-09-05]{\c_catcode_other_space_tl}
%   Token list containing one character with category code $12$,
%   (\enquote{other}), and character code $32$ (space).
% \end{variable}
%
% \section{Reading from files}
%
% \begin{function}{\ior_to:NN,\ior_gto:NN}
%   \begin{syntax}
%     \cs{ior_to:NN} \meta{stream} \meta{token list variable}
%   \end{syntax}
%   Functions that reads one or more lines (until an equal number of left
%   and right braces are found) from the input \meta{stream} and stores
%   the result in the \meta{token list} variable, locally or globally. If the
%   \meta{stream} is not open, input is requested from the terminal.
%   The material read from the \meta{stream} will be tokenized by
%   \TeX{} according to the category codes in force when the function
%   is used.
%   \begin{texnote}
%     This protected macro expands to the \TeX{} primitives \tn{read}
%     or \tn{global}\tn{read} along with the |to| keyword.
%   \end{texnote}
% \end{function}
%
% \begin{function}{\ior_str_to:NN,\ior_str_gto:NN}
%   \begin{syntax}
%     \cs{ior_str_to:NN} \meta{stream} \meta{token list variable}
%   \end{syntax}
%   Functions that reads one line from the input \meta{stream} and stores
%   the result in the \meta{token list} variable, locally or globally. If the
%   \meta{stream} is not open, input is requested from the terminal.
%   The material read from the \meta{stream} as a series of tokens with
%   category code $12$ (other), with the exception of space
%   characters which are given category code $10$ (space).
%   \begin{texnote}
%     This protected macro expands to the \eTeX{} primitives \tn{readline}
%     or \tn{global}\tn{readline} along with the |to| keyword.
%   \end{texnote}
% \end{function}
%
%\begin{function}[updated = 2011-09-26, EXP,pTF]{\ior_if_eof:N}
%  \begin{syntax}
%    \cs{ior_if_eof_p:N} \meta{stream} \\
%    \cs{ior_if_eof:NTF} \meta{stream} \Arg{true code} \Arg{false code}
%  \end{syntax}
%  Tests if the end of a \meta{stream} has been reached during a reading
%  operation. The test will also return a \texttt{true} value if
%  the \meta{stream} is not open or the \meta{file name} associated with
%  a \meta{stream} does not exist at all.
%\end{function}
%
% \section{Constants}
%
% \begin{variable}{\c_term_ior}
%   Constant input stream for reading from the terminal. Reading from this
%   stream using \cs{ior_to:NN} or similar will result in a prompt from
%   \TeX{} of the form
%   \begin{verbatim}
%     <tl>=
%   \end{verbatim}
% \end{variable}
%
% \begin{variable}{\c_log_iow, \c_term_iow}
%   Constant output streams for writing to the log and to the terminal
%   (plus the log), respectively.
% \end{variable}
%
% \section{Experimental functions}
%
% \begin{function}{\ior_map_inline:nn}
%   \begin{syntax}
%     \cs{ior_map_inline:nn} \Arg{file name} \Arg{inline function}
%   \end{syntax}
%   Applies the \meta{inline function} to \meta{items} obtained by
%   reading one or more lines (until an equal number of left and right
%   braces are found) from the \meta{file}. The \meta{inline function}
%   should consist of code which will receive the \meta{line} as |#1|.
%   One in line mapping can be nested inside another.
%   If the file is not found, the \meta{inline function} is never called.
% \end{function}
%
% \begin{function}{\ior_str_map_inline:nn}
%   \begin{syntax}
%     \cs{ior_str_map_inline:nn} \Arg{file name} \Arg{inline function}
%   \end{syntax}
%   Applies the \meta{inline function} to every \meta{line}
%   in the \meta{file}. The material is read from the \meta{file}
%   as a series of tokens with category code $12$ (other), with the
%   exception of space characters which are given category code $10$
%   (space). The \meta{inline function} should consist of code which
%   will receive the \meta{line} as |#1|.
%   One in line mapping can be nested inside another.
%   If the file is not found, the \meta{inline function} is never called.
% \end{function}
%
% \section{Internal input--output functions}
%
% \begin{function}[EXP]{\if_eof:w}
%   \begin{syntax}
%     \cs{if_eof:w} \meta{stream}
%     ~~\meta{true code}
%     \cs{else:}
%     ~~\meta{false code}
%     \cs{fi:}
%   \end{syntax}
%   Tests if the \meta{stream} returns \enquote{end of file}, which is true
%   for non-existent files. The \cs{else:} branch is optional.
%   \begin{texnote}
%     This is the \TeX{} primitive \tn{ifeof}.
%   \end{texnote}
% \end{function}
%
% \begin{function}[added = 2012-01-23]
%   {\ior_open_unsafe:Nn, \iow_open_unsafe:Nn}
%   \begin{syntax}
%     \cs{ior_open_unsafe:Nn} \meta{stream} \Arg{file name}
%   \end{syntax}
%   These functions have identical syntax to the generally-available
%   versions without the |_unsafe| suffix. However, these functions do not
%   take precautions against active characters in the \meta{file name}: they
%   are therefore intended to be used by higher-level functions which
%   have already fully expanded the \meta{file name} and which need to
%   perform multiple open or close operations. See for example the
%   implementation of \cs{file_add_path:Nn},
% \end{function}
%
% \begin{function}{\ior_raw_new:N, \ior_raw_new:c}
%   \begin{syntax}
%     \cs{ior_raw_new:N} \meta{stream}
%   \end{syntax}
%   Directly allocates a new stream for reading, bypassing the stack
%   system. This is to be used only when a new stream is required at a
%   \TeX{} level, when a new stream is requested by the stack itself.
% \end{function}
%
% \begin{function}{\iow_raw_new:N, \iow_raw_new:c}
%   \begin{syntax}
%     \cs{iow_raw_new:N} \meta{stream}
%   \end{syntax}
%   Directly allocates a new stream for writing, bypassing the stack
%   system. This is to be used only when a new stream is required at a
%   \TeX{} level, when a new stream is requested by the stack itself.
% \end{function}
%
% \end{documentation}
%
% \begin{implementation}
%
% \section{\pkg{l3io} implementation}
%
%    \begin{macrocode}
%<*initex|package>
%    \end{macrocode}
%
%    \begin{macrocode}
%<*package>
\ProvidesExplPackage
  {\ExplFileName}{\ExplFileDate}{\ExplFileVersion}{\ExplFileDescription}
\package_check_loaded_expl:
%</package>
%    \end{macrocode}
%
% \subsection{Primitives}
%
% \begin{macro}{\if_eof:w}
%   The primitive conditional
%    \begin{macrocode}
\cs_new_eq:NN \if_eof:w \tex_ifeof:D
%    \end{macrocode}
% \end{macro}
%
% \subsection{Variables and constants}
%
% \begin{variable}{\c_term_ior}
%   Reading from the terminal (with a prompt) is done using a positive
%   but non-existent stream number. Unlike writing, there is no concept
%   of reading from the log.
%    \begin{macrocode}
\cs_new_eq:NN \c_term_ior \c_sixteen
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\c_log_iow, \c_term_iow}
%   Here we allocate two output streams for writing to the transcript
%   file only (\cs{c_log_iow}) and to both the terminal and
%   transcript file (\cs{c_term_iow}).
%    \begin{macrocode}
\cs_new_eq:NN \c_log_iow  \c_minus_one
\cs_new_eq:NN \c_term_iow \c_sixteen
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\c_iow_streams_tl, \c_ior_streams_tl}
%   The list of streams available, by number.
%    \begin{macrocode}
\tl_const:Nn \c_iow_streams_tl
  {
    \c_zero
    \c_one
    \c_two
    \c_three
    \c_four
    \c_five
    \c_six
    \c_seven
    \c_eight
    \c_nine
    \c_ten
    \c_eleven
    \c_twelve
    \c_thirteen
    \c_fourteen
    \c_fifteen
  }
\cs_new_eq:NN \c_ior_streams_tl \c_iow_streams_tl
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\g_iow_streams_prop, \g_ior_streams_prop}
%   The allocations for streams are stored in property lists, which
%   are set up to have a \enquote{full} set of allocations from the start.
%   In package mode, a few slots are always taken, so these are
%   blocked off from use.
%    \begin{macrocode}
\prop_new:N \g_iow_streams_prop
\prop_new:N \g_ior_streams_prop
%<*package>
\prop_put:Nnn \g_iow_streams_prop { 0 } { LaTeX2e~reserved }
\prop_put:Nnn \g_iow_streams_prop { 1 } { LaTeX2e~reserved }
\prop_put:Nnn \g_iow_streams_prop { 2 } { LaTeX2e~reserved }
\prop_put:Nnn \g_ior_streams_prop { 0 } { LaTeX2e~reserved }
%</package>
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_ior_internal_tl, \l_iow_internal_tl}
%   For expanding file names.
%    \begin{macrocode}
\tl_new:N \l_ior_internal_tl
\tl_new:N \l_iow_internal_tl
%    \end{macrocode}
% \end{variable}
%
% \begin{variable}{\l_iow_stream_int, \l_ior_stream_int}
%   Used to track the number allocated to the stream being created:
%   this is taken from the property list but does alter.
%    \begin{macrocode}
\int_new:N \l_iow_stream_int
\cs_new_eq:NN \l_ior_stream_int \l_iow_stream_int
%    \end{macrocode}
% \end{variable}
%
% \subsection{Stream management}
%
% \begin{macro}[int]{\ior_raw_new:N, \ior_raw_new:c}
% \begin{macro}[int]{\iow_raw_new:N, \iow_raw_new:c}
% The lowest level for stream management is actually creating raw \TeX{}
% streams. As these are very limited (even with \eTeX{}), this should not
% be addressed directly.
%    \begin{macrocode}
%<*initex>
\alloc_setup_type:nnn { ior } \c_zero \c_sixteen
\cs_new_protected:Npn \ior_raw_new:N #1
  { \alloc_reg:nNN { ior } \tex_chardef:D #1 }
\alloc_setup_type:nnn { iow } \c_zero \c_sixteen
\cs_new_protected:Npn \iow_raw_new:N #1
  { \alloc_reg:nNN { iow } \tex_chardef:D #1 }
%</initex>
%<*package>
\cs_set_eq:NN \iow_raw_new:N \newwrite
\cs_set_eq:NN \ior_raw_new:N \newread
%</package>
\cs_generate_variant:Nn \ior_raw_new:N { c }
\cs_generate_variant:Nn \iow_raw_new:N { c }
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\ior_new:N, \ior_new:c, \iow_new:N, \iow_new:c}
%   Reserving a new stream is done by defining the name as equal to using the
%   terminal.
%    \begin{macrocode}
\cs_new_protected:Npn \ior_new:N #1 { \cs_new_eq:NN #1 \c_term_ior }
\cs_generate_variant:Nn \ior_new:N { c }
\cs_new_protected:Npn \iow_new:N #1 { \cs_new_eq:NN #1 \c_term_iow }
\cs_generate_variant:Nn \iow_new:N { c }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\ior_open:Nn, \ior_open:cn, \iow_open:Nn, \iow_open:cn}
% \begin{macro}[int]{\ior_open_unsafe:Nn, \iow_open_unsafe:Nn}
%   In both cases, opening a stream starts with a call to the closing
%   function: this is safest. There is then a loop through the
%   allocation number list to find the first free stream number.
%   When one is found the allocation can take place, the information
%   can be stored and finally the file can actually be opened. Before
%   any actual file operations there is a precaution against special
%   characters in file names.
%    \begin{macrocode}
\cs_new_protected:Npn \ior_open:Nn #1#2
  {
    \group_begin:
      \tl_to_str_active_safe:Nx \l_ior_internal_tl {#2}
      \tl_if_in:NnT \l_ior_internal_tl { ~ }
        {
          \msg_kernel_error:nnx { io } { space-in-file-name }
            { \l_ior_internal_tl }
        }
      \exp_args:NNNo \group_end:
      \ior_open_unsafe:Nn #1 \l_ior_internal_tl
  }
\cs_generate_variant:Nn \ior_open:Nn { c }
\cs_new_protected:Npn \iow_open:Nn #1#2
  {
    \group_begin:
      \tl_to_str_active_safe:Nx \l_iow_internal_tl {#2}
      \tl_if_in:NnT \l_iow_internal_tl { ~ }
        {
          \msg_kernel_error:nnx { io } { space-in-file-name }
            { \l_iow_internal_tl }
        }
    \exp_args:NNNo \group_end:
    \iow_open_unsafe:Nn #1 \l_iow_internal_tl
  }
\cs_generate_variant:Nn \iow_open:Nn { c }
\cs_new_protected:Npn \ior_open_unsafe:Nn #1#2
  {
    \ior_close:N #1
    \int_set:Nn \l_ior_stream_int \c_sixteen
    \tl_map_function:NN \c_ior_streams_tl \ior_alloc_read:n
    \int_compare:nNnTF \l_ior_stream_int = \c_sixteen
      { \msg_kernel_fatal:nn { ior } { streams-exhausted } }
      {
        \ior_stream_alloc:N #1
        \prop_gput:NVn \g_ior_streams_prop \l_ior_stream_int {#2}
        \tex_openin:D #1#2 \scan_stop:
      }
  }
\cs_new_protected:Npn \iow_open_unsafe:Nn #1#2
  {
    \iow_close:N #1
    \int_set:Nn \l_iow_stream_int \c_sixteen
    \tl_map_function:NN \c_iow_streams_tl \iow_alloc_write:n
    \int_compare:nNnTF \l_iow_stream_int = \c_sixteen
      { \msg_kernel_fatal:nn { iow } { streams-exhausted } }
      {
        \iow_stream_alloc:N #1
        \prop_gput:NVn \g_iow_streams_prop \l_iow_stream_int {#2}
        \tex_immediate:D \tex_openout:D #1#2 \scan_stop:
      }
  }
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}[aux]{\ior_alloc_read:n}
% \begin{macro}[aux]{\iow_alloc_write:n}
% These functions are used to see if a particular stream is available.
% The property list contains file names for streams in use, so
% any unused ones are for the taking.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_alloc_write:n #1
  {
    \prop_if_in:NnF \g_iow_streams_prop {#1}
      {
        \int_set:Nn \l_iow_stream_int {#1}
        \tl_map_break:
      }
  }
\cs_new_protected:Npn \ior_alloc_read:n #1
  {
    \prop_if_in:NnF \g_iow_streams_prop {#1}
      {
        \int_set:Nn \l_ior_stream_int {#1}
        \tl_map_break:
      }
  }
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}[aux]{\iow_stream_alloc:N}
% \begin{macro}[aux]{\ior_stream_alloc:N}
% \begin{macro}[aux]{\iow_stream_alloc_aux:}
% \begin{macro}[aux]{\ior_stream_alloc_aux:}
% \begin{variable}{\g_iow_internal_iow}
% \begin{variable}{\g_ior_internal_ior}
%   Allocating a raw stream is much easier in \IniTeX{} mode than for
%   the package. For the format, all streams will be allocated by
%   \pkg{l3io} and so there is a simple check to see if a raw
%   stream is actually available. On the other hand, for the
%   package there will be non-managed streams. So if the managed
%   one is not open, a check is made to see if some other managed
%   stream is available before deciding to open a new one. If a new
%   one is needed, we get the number allocated by \LaTeXe{} to get
%   \enquote{back on track} with allocation.
%    \begin{macrocode}
\iow_new:N \g_iow_internal_iow
\ior_new:N \g_ior_internal_ior
\cs_new_protected:Npn \iow_stream_alloc:N #1
  {
    \cs_if_exist:cTF { g_iow_ \int_use:N \l_iow_stream_int _iow }
      { \cs_gset_eq:Nc #1 { g_iow_ \int_use:N \l_iow_stream_int _iow } }
      {
%<*package>
        \iow_stream_alloc_aux:
        \int_compare:nNnT \l_iow_stream_int = \c_sixteen
          {
            \iow_raw_new:N \g_iow_internal_iow
            \int_set:Nn \l_iow_stream_int { \g_iow_internal_iow }
            \cs_gset_eq:cN
              { g_iow_ \int_use:N \l_iow_stream_int _iow } \g_iow_internal_iow
          }
%</package>
%<*initex>
        \iow_raw_new:c { g_iow_ \int_use:N \l_iow_stream_int _iow }
%</initex>
        \cs_gset_eq:Nc #1 { g_iow_ \int_use:N \l_iow_stream_int _iow }
      }
  }
%<*package>
\cs_new_protected_nopar:Npn \iow_stream_alloc_aux:
  {
    \int_incr:N \l_iow_stream_int
    \int_compare:nNnT \l_iow_stream_int < \c_sixteen
      {
         \cs_if_exist:cTF { g_iow_ \int_use:N \l_iow_stream_int _iow }
           {
             \prop_if_in:NVT \g_iow_streams_prop \l_iow_stream_int
               { \iow_stream_alloc_aux: }
           }
           { \iow_stream_alloc_aux: }
      }
  }
%</package>
\cs_new_protected:Npn \ior_stream_alloc:N #1
  {
    \cs_if_exist:cTF { g_ior_ \int_use:N \l_ior_stream_int _ior }
      { \cs_gset_eq:Nc #1 { g_ior_ \int_use:N \l_ior_stream_int _ior } }
      {
%<*package>
        \ior_stream_alloc_aux:
        \int_compare:nNnT \l_ior_stream_int = \c_sixteen
          {
            \ior_raw_new:N \g_ior_internal_ior
            \int_set:Nn \l_ior_stream_int { \g_ior_internal_ior }
            \cs_gset_eq:cN
              { g_ior_ \int_use:N \l_iow_stream_int _ior } \g_ior_internal_ior
          }
%</package>
%<*initex>
        \ior_raw_new:c { g_ior_ \int_use:N \l_ior_stream_int _ior }
%</initex>
        \cs_gset_eq:Nc #1 { g_ior_ \int_use:N \l_ior_stream_int _ior }
      }
  }
%<*package>
\cs_new_protected_nopar:Npn \ior_stream_alloc_aux:
  {
    \int_incr:N \l_ior_stream_int
    \int_compare:nNnT \l_ior_stream_int < \c_sixteen
      {
         \cs_if_exist:cTF { g_ior_ \int_use:N \l_ior_stream_int _ior }
           {
             \prop_if_in:NVT \g_ior_streams_prop \l_ior_stream_int
               { \ior_stream_alloc_aux: }
           }
           { \ior_stream_alloc_aux: }
      }
  }
%</package>
%    \end{macrocode}
% \end{variable}
% \end{variable}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\iow_close:N, \iow_close:c}
% \begin{macro}{\iow_close:N, \iow_close:c}
%   Closing a stream is not quite the reverse of opening one. First,
%   the close operation is easier than the open one, and second as the
%   stream is actually a number we can use it directly to show that the
%   slot has been freed up.
%    \begin{macrocode}
\cs_new_protected:Npn \ior_close:N #1
  {
    \cs_if_exist:NT #1
      {
        \int_compare:nNnF #1 = \c_minus_one
          {
            \int_compare:nNnF #1 = \c_sixteen
              { \tex_closein:D #1 }
            \prop_gdel:NV \g_ior_streams_prop #1
            \cs_gset_eq:NN #1 \c_term_ior
          }
      }
  }
\cs_new_protected:Npn \iow_close:N #1
  {
    \cs_if_exist:NT #1
      {
        \int_compare:nNnF #1 = \c_minus_one
          {
            \int_compare:nNnF #1 = \c_sixteen
              { \tex_closein:D #1 }
            \prop_gdel:NV \g_iow_streams_prop #1
            \cs_gset_eq:NN #1 \c_term_iow
          }
      }
  }
\cs_generate_variant:Nn \ior_close:N { c }
\cs_generate_variant:Nn \iow_close:N { c }
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\ior_list_streams:}
%   Show the property lists, but with some \enquote{pretty printing}.
%   See the \pkg{l3msg} module. If there are no open read streams,
%   issue the message \texttt{show-no-stream}, and show an empty
%   token list. If there are open read streams, format them with
%   \cs{msg_aux_show_unbraced:nn}, and with the message
%   \texttt{show-open-streams}.
%    \begin{macrocode}
\cs_new_protected_nopar:Npn \ior_list_streams:
  { \ior_list_streams_aux:Nn \g_ior_streams_prop { ior } }
\cs_new_protected_nopar:Npn \iow_list_streams:
  { \ior_list_streams_aux:Nn \g_iow_streams_prop { iow } }
\cs_new_protected:Npn \ior_list_streams_aux:Nn #1#2
  {
    \msg_aux_use:nn { LaTeX / #2 }
      { \prop_if_empty:NTF #1 { show-no-stream } { show-open-streams } }
    \msg_aux_show:x
      { \prop_map_function:NN #1 \msg_aux_show_unbraced:nn }
  }
%    \end{macrocode}
% \end{macro}
%
% Text for the error messages.
%    \begin{macrocode}
\msg_kernel_new:nnnn { iow } { streams-exhausted }
  { Output~streams~exhausted }
  {
    TeX~can~only~open~up~to~16~output~streams~at~one~time.\\
    All~16 are currently~in~use,~and~something~wanted~to~open
    another~one.
  }
\msg_kernel_new:nnnn { ior } { streams-exhausted }
  { Input~streams~exhausted }
  {
    TeX~can~only~open~up~to~16~input~streams~at~one~time.\\
    All~16 are currently~in~use,~and~something~wanted~to~open
    another~one.
  }
%    \end{macrocode}
%
% \subsection{Deferred writing}
%
% \begin{macro}{\iow_shipout_x:Nn, \iow_shipout_x:Nx}
%   First the easy part, this is the primitive.
%    \begin{macrocode}
\cs_new_eq:NN \iow_shipout_x:Nn \tex_write:D
\cs_generate_variant:Nn \iow_shipout_x:Nn { Nx }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\iow_shipout:Nn, \iow_shipout:Nx}
%   With \eTeX{} available deferred writing is easy.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_shipout:Nn #1#2
  { \iow_shipout_x:Nn #1 { \exp_not:n {#2} } }
\cs_generate_variant:Nn \iow_shipout:Nn { Nx }
%    \end{macrocode}
% \end{macro}
%
% \subsection{Immediate writing}
%
% \begin{macro}{\iow_now:Nx}
%   An abbreviation for an often used operation, which immediately
%   writes its second argument expanded to the output stream.
%    \begin{macrocode}
\cs_new_protected_nopar:Npn \iow_now:Nx { \tex_immediate:D \iow_shipout_x:Nn }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\iow_now:Nn}
%   This routine writes the second argument onto the output stream without
%   expansion. If this stream isn't open, the output goes to the terminal
%   instead. If the first argument is no output stream at all, we get an
%   internal error.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_now:Nn #1#2
  { \iow_now:Nx #1 { \exp_not:n {#2} } }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\iow_log:n, \iow_log:x}
% \begin{macro}{\iow_term:n, \iow_term:x}
% Writing to the log and the terminal directly are relatively easy.
%    \begin{macrocode}
\cs_set_protected_nopar:Npn \iow_log:x  { \iow_now:Nx \c_log_iow  }
\cs_new_protected_nopar:Npn \iow_log:n  { \iow_now:Nn \c_log_iow  }
\cs_set_protected_nopar:Npn \iow_term:x { \iow_now:Nx \c_term_iow }
\cs_new_protected_nopar:Npn \iow_term:n { \iow_now:Nn \c_term_iow }
%    \end{macrocode}
%\end{macro}
%\end{macro}
%
% \begin{macro}{\iow_now_when_avail:Nn, \iow_now_when_avail:Nx}
% For writing only if the stream requested is open at all.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_now_when_avail:Nn #1
  { \cs_if_free:NTF #1 { \use_none:n } { \iow_now:Nn #1 } }
\cs_new_protected:Npn \iow_now_when_avail:Nx #1
  { \cs_if_free:NTF #1 { \use_none:n } { \iow_now:Nx #1 } }
%    \end{macrocode}
% \end{macro}
%
% \subsection{Special characters for writing}
%
% \begin{macro}{\iow_newline:}
%   Global variable holding the character that forces a new line when
%   something is written to an output stream
%    \begin{macrocode}
\cs_new_nopar:Npn \iow_newline: { ^^J }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\iow_char:N}
%   Function to write any escaped char to an output stream.
%    \begin{macrocode}
\cs_new_eq:NN \iow_char:N \cs_to_str:N
%    \end{macrocode}
% \end{macro}
%
% \subsection{Hard-wrapping lines based on length}
%
% The code here implements a generic hard-wrapping function. This is
% used by the messaging system, but is designed such that it is
% available for other uses.
%
% \begin{macro}{\l_iow_line_length_int}
%   This is the \enquote{raw} length of a line which can be written to a
%   file. The standard value is the line length typically used by
%   \TeX{}Live and Mik\TeX{}.
%    \begin{macrocode}
\int_new:N  \l_iow_line_length_int
\int_set:Nn \l_iow_line_length_int { 78 }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{\l_iow_target_length_int}
%   This stores the target line length: the full length minus any
%   part for a leader at the start of each line.
%    \begin{macrocode}
\int_new:N \l_iow_target_length_int
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{
%     \l_iow_current_line_int,
%     \l_iow_current_word_int,
%     \l_iow_current_indentation_int}
%   These store the number of characters in the line and word currently
%   being constructed, and the current indentation, respectively.
%    \begin{macrocode}
\int_new:N \l_iow_current_line_int
\int_new:N \l_iow_current_word_int
\int_new:N \l_iow_current_indentation_int
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{
%     \l_iow_current_line_tl,
%     \l_iow_current_word_tl,
%     \l_iow_current_indentation_tl}
%   These hold the current line of text and current word,
%   and a number of spaces for indentation, respectively.
%    \begin{macrocode}
\tl_new:N \l_iow_current_line_tl
\tl_new:N \l_iow_current_word_tl
\tl_new:N \l_iow_current_indentation_tl
%    \end{macrocode}
%\end{macro}
%
% \begin{macro}[aux]{\l_iow_wrap_tl}
%   Used for the expansion step before detokenizing.
%    \begin{macrocode}
\tl_new:N \l_iow_wrap_tl
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{\l_iow_wrapped_tl}
%   The output from wrapping text: fully expanded and with lines
%   which are not overly long.
%    \begin{macrocode}
\tl_new:N \l_iow_wrapped_tl
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{\l_iow_line_start_bool}
%   Boolean to avoid adding a space at the beginning of forced newlines.
%    \begin{macrocode}
\bool_new:N \l_iow_line_start_bool
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{\c_catcode_other_space_tl}
%   Lowercase a character with category code $12$ to produce an
%   \enquote{other} space. We can do everything within the group,
%   because \cs{tl_const:Nn} defines its argument globally.
%    \begin{macrocode}
\group_begin:
  \char_set_catcode_other:N \*
  \char_set_lccode:nn {`\*} {`\ }
  \tl_to_lowercase:n { \tl_const:Nn \c_catcode_other_space_tl { * } }
\group_end:
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{\c_iow_wrap_marker_tl}
% \begin{macro}[aux]{
%     \c_iow_wrap_end_marker_tl,
%     \c_iow_wrap_newline_marker_tl,
%     \c_iow_wrap_indent_marker_tl,
%     \c_iow_wrap_unindent_marker_tl}
% \begin{macro}[aux]{\iow_wrap_new_marker:n}
%   Every special action of the wrapping code is preceeded by
%   the same recognizable string, \cs{c_iow_wrap_marker_tl}.
%   Upon seeing that \enquote{word}, the wrapping code reads
%   one space-delimited argument to know what operation to
%   perform. The setting of \tn{escapechar} here is not
%   very important, but makes \cs{c_iow_wrap_marker_tl} look
%   nicer. Note that \cs{iow_wrap_new_marker:n} does not
%   survive the group, but all constants are defined globally.
%    \begin{macrocode}
\group_begin:
  \int_set_eq:NN \tex_escapechar:D \c_minus_one
  \tl_const:Nx \c_iow_wrap_marker_tl
    { \tl_to_str:n { \^^I \^^O \^^W \^^_ \^^W \^^R \^^A \^^P } }
  \cs_set:Npn \iow_wrap_new_marker:n #1
    {
      \tl_const:cx { c_iow_wrap_ #1 _marker_tl }
        {
          \c_catcode_other_space_tl
          \c_iow_wrap_marker_tl
          \c_catcode_other_space_tl
          #1
          \c_catcode_other_space_tl
        }
    }
  \iow_wrap_new_marker:n { end }
  \iow_wrap_new_marker:n { newline }
  \iow_wrap_new_marker:n { indent }
  \iow_wrap_new_marker:n { unindent }
\group_end:
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\iow_indent:n}
% \begin{macro}[aux]{\iow_indent_expandable:n}
%   We give a dummy (protected) definition to \cs{iow_indent:n}
%   when outside messages. Within wrapped message, it places
%   the instruction for increasing the indentation before its
%   argument, and the instruction for unindenting afterwards.
%   Note that there will be no forced line-break, so the indentation
%   only changes when the next line is started.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_indent:n #1 { }
\cs_new:Npx \iow_indent_expandable:n #1
  {
    \c_iow_wrap_indent_marker_tl
    #1
    \c_iow_wrap_unindent_marker_tl
  }
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\iow_wrap:xnnnN}
%   The main wrapping function works as follows. The target number of
%   characters in a line is calculated, before fully-expanding the input
%   such that |\\| and \verb*|\ | are converted into the appropriate
%   values. There is then a loop over each word in the input, which
%   will do the actual wrapping. After the loop, the resulting text is
%   passed on to the function which has been given as a post-processor.
%   The argument |#4| is available for additional set up steps for
%   the output. The definition of |\\| and \verb*|\ | use an
%   \enquote{other} space rather than a normal space, because the latter
%   might be absorbed by \TeX{} to end a number or other \texttt{f}-type
%   expansions. The \cs{tl_to_str:N} step converts the \enquote{other}
%   space back to a normal space.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_wrap:xnnnN #1#2#3#4#5
  {
    \group_begin:
      \int_set:Nn \l_iow_target_length_int { \l_iow_line_length_int - ( #3 ) }
      \int_zero:N \l_iow_current_indentation_int
      \tl_clear:N \l_iow_current_indentation_tl
      \int_zero:N \l_iow_current_line_int
      \tl_clear:N \l_iow_current_line_tl
      \tl_clear:N \l_iow_wrap_tl
      \bool_set_true:N \l_iow_line_start_bool
      \int_set_eq:NN \tex_escapechar:D \c_minus_one
      \cs_set_nopar:Npx \{ { \token_to_str:N \{ }
      \cs_set_nopar:Npx \# { \token_to_str:N \# }
      \cs_set_nopar:Npx \} { \token_to_str:N \} }
      \cs_set_nopar:Npx \% { \token_to_str:N \% }
      \cs_set_nopar:Npx \~ { \token_to_str:N \~ }
      \int_set:Nn \tex_escapechar:D { 92 }
      \cs_set_eq:NN \\ \c_iow_wrap_newline_marker_tl
      \cs_set_eq:NN \  \c_catcode_other_space_tl
      \cs_set_eq:NN \iow_indent:n \iow_indent_expandable:n
      #4
%<*initex>
      \tl_set:Nx \l_iow_wrap_tl {#1}
%</initex>
%<*package>
      \protected@edef \l_iow_wrap_tl {#1}
%</package>
      \cs_set:Npn \\ { \iow_newline: #2 }
      \use:x
        {
          \iow_wrap_loop:w
          \tl_to_str:N \l_iow_wrap_tl
          \tl_to_str:N \c_iow_wrap_end_marker_tl
          \c_space_tl \c_space_tl
          \exp_not:N \q_stop
        }
    \exp_args:NNo \group_end:
    #5 \l_iow_wrapped_tl
  }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{\iow_wrap_loop:w}
%   The loop grabs one word in the input, and checks whether it is
%   the special marker, or a normal word.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_wrap_loop:w #1 ~ %
  {
    \tl_set:Nn \l_iow_current_word_tl {#1}
    \tl_if_eq:NNTF \l_iow_current_word_tl \c_iow_wrap_marker_tl
      { \iow_wrap_special:w }
      { \iow_wrap_word: }
  }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}[aux]{\iow_wrap_word:}
% \begin{macro}[aux]{\iow_wrap_word_fits:}
% \begin{macro}[aux]{\iow_wrap_word_newline:}
%   For a normal word, update the line length, then test if the current
%   word would fit in the current line, and call the appropriate function.
%   If the word fits in the current line, add it to the line, preceded by
%   a space unless it is the first word of the line.
%   Otherwise, the current line is added to the result, with the run-on text.
%   The current word (and its length) are then put in the new line.
%    \begin{macrocode}
\cs_new_protected_nopar:Npn \iow_wrap_word:
  {
    \int_set:Nn \l_iow_current_word_int
      { \str_length_skip_spaces:N \l_iow_current_word_tl }
    \int_add:Nn \l_iow_current_line_int { \l_iow_current_word_int }
    \int_compare:nNnTF \l_iow_current_line_int < \l_iow_target_length_int
      { \iow_wrap_word_fits: }
      { \iow_wrap_word_newline: }
    \iow_wrap_loop:w
  }
\cs_new_protected_nopar:Npn \iow_wrap_word_fits:
  {
    \bool_if:NTF \l_iow_line_start_bool
      {
        \bool_set_false:N \l_iow_line_start_bool
        \tl_put_right:Nx \l_iow_current_line_tl
          { \l_iow_current_indentation_tl \l_iow_current_word_tl }
        \int_add:Nn \l_iow_current_line_int
          { \l_iow_current_indentation_int }
      }
      {
        \tl_put_right:Nx \l_iow_current_line_tl
          { ~ \l_iow_current_word_tl }
        \int_incr:N \l_iow_current_line_int
      }
  }
\cs_new_protected_nopar:Npn \iow_wrap_word_newline:
  {
    \tl_put_right:Nx \l_iow_wrapped_tl
      { \l_iow_current_line_tl \\ }
    \int_set:Nn \l_iow_current_line_int
      {
        \l_iow_current_word_int
        + \l_iow_current_indentation_int
      }
    \tl_set:Nx \l_iow_current_line_tl
      { \l_iow_current_indentation_tl \l_iow_current_word_tl }
  }
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}[aux]{\iow_wrap_special:w}
% \begin{macro}[aux]{\iow_wrap_newline:w}
% \begin{macro}[aux]{\iow_wrap_indent:w}
% \begin{macro}[aux]{\iow_wrap_unindent:w}
% \begin{macro}[aux]{\iow_wrap_end:w}
%   When the \enquote{special} marker is encountered,
%   read what operation to perform, as a space-delimited
%   argument, perform it, and remember to loop.
%   In fact, to avoid spurious spaces when two special
%   actions follow each other, we look ahead for another
%   copy of the marker.
%   Forced newlines are almost identical to those caused by overflow,
%   except that here the word is empty.
%   To indent more, add four spaces to the start of the indentation
%   token list. To reduce indentation, rebuild the indentation token
%   list using \cs{prg_replicate:nn}.
%   At the end, we simply save the last line (without the run-on text),
%   and prevent the loop.
%    \begin{macrocode}
\cs_new_protected:Npn \iow_wrap_special:w #1 ~ #2 ~ #3 ~ %
  {
    \use:c { iow_wrap_#1: }
    \str_if_eq:xxTF { #2~#3 } { ~ \c_iow_wrap_marker_tl }
      { \iow_wrap_special:w }
      { \iow_wrap_loop:w #2 ~ #3 ~ }
  }
\cs_new_protected_nopar:Npn \iow_wrap_newline:
  {
    \tl_put_right:Nx \l_iow_wrapped_tl
      { \l_iow_current_line_tl \\ }
    \int_zero:N \l_iow_current_line_int
    \tl_clear:N \l_iow_current_line_tl
    \bool_set_true:N \l_iow_line_start_bool
  }
\cs_new_protected_nopar:Npx \iow_wrap_indent:
  {
    \int_add:Nn \l_iow_current_indentation_int \c_four
    \tl_put_right:Nx \exp_not:N \l_iow_current_indentation_tl
      { \c_space_tl \c_space_tl \c_space_tl \c_space_tl }
  }
\cs_new_protected_nopar:Npn \iow_wrap_unindent:
  {
    \int_sub:Nn \l_iow_current_indentation_int \c_four
    \tl_set:Nx \l_iow_current_indentation_tl
      { \prg_replicate:nn \l_iow_current_indentation_int { ~ } }
  }
\cs_new_protected_nopar:Npn \iow_wrap_end:
  {
    \tl_put_right:Nx \l_iow_wrapped_tl
      { \l_iow_current_line_tl }
    \use_none_delimit_by_q_stop:w
  }
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \begin{macro}[aux]{\str_length_skip_spaces:N}
% \begin{macro}[aux]{\str_length_skip_spaces:n}
% \begin{macro}[aux]{\str_length_loop:NNNNNNNNN}
%   The wrapping code requires to measure the number of character
%   in each word. This could be done with \cs{tl_length:n}, but
%   it is ten times faster (literally) to use the code below.
%    \begin{macrocode}
\cs_new_nopar:Npn \str_length_skip_spaces:N
  { \exp_args:No \str_length_skip_spaces:n }
\cs_new:Npn \str_length_skip_spaces:n #1
  {
    \int_value:w \int_eval:w
      \exp_after:wN \str_length_loop:NNNNNNNNN \tl_to_str:n {#1}
      {X8}{X7}{X6}{X5}{X4}{X3}{X2}{X1}{X0} \q_stop
    \int_eval_end:
  }
\cs_new:Npn \str_length_loop:NNNNNNNNN #1#2#3#4#5#6#7#8#9
  {
    \if_catcode:w X #9
      \exp_after:wN \use_none_delimit_by_q_stop:w
    \else:
      9 +
      \exp_after:wN \str_length_loop:NNNNNNNNN
    \fi:
  }
%    \end{macrocode}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \subsection{Reading input}
%
% \begin{macro}[pTF]{\ior_if_eof_p:N}
% To test if some particular input stream is exhausted the following
% conditional is provided. As the pool model means that closed
% streams are undefined control sequences, the test has two parts.
%    \begin{macrocode}
\prg_new_conditional:Nnn \ior_if_eof:N { p , T , F , TF }
  {
    \cs_if_exist:NTF #1
      {
        \if_int_compare:w #1 = \c_sixteen
          \prg_return_true:
        \else:
          \if_eof:w #1
            \prg_return_true:
          \else:
            \prg_return_false:
          \fi:
        \fi:
      }
      { \prg_return_true: }
  }
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\ior_to:NN}
% \begin{macro}{\ior_gto:NN}
%  And here we read from files.
%    \begin{macrocode}
\cs_new_protected:Npn \ior_to:NN #1#2
  { \tex_read:D #1 to #2 }
\cs_new_protected:Npn \ior_gto:NN #1#2
  { \tex_global:D \tex_read:D #1 to #2 }
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \begin{macro}{\ior_str_to:NN}
% \begin{macro}{\ior_str_gto:NN}
%  Reading as strings is also a primitive wrapper.
%    \begin{macrocode}
\cs_new_protected:Npn \ior_str_to:NN #1#2
  { \etex_readline:D #1 to #2 }
\cs_new_protected:Npn \ior_str_gto:NN #1#2
  { \tex_global:D \etex_readline:D #1 to #2 }
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
% \subsection{Experimental functions}
%
% \begin{macro}{\ior_map_inline:nn}
% \begin{macro}{\ior_str_map_inline:nn}
% \begin{macro}[aux]{\ior_str_map_inline_aux:Nnn}
% \begin{macro}[aux]{\ior_str_map_inline_aux:NNNnn}
% \begin{macro}[aux]{\ior_str_map_inline_loop:NNN}
% \begin{variable}{\l_ior_internal_tl}
%   The five arguments of \cs{ior_str_map_inline_aux:NNNnn} are:
%   the read stream used at this level of map nesting;
%   the control sequence which will hold the function to map;
%   either \cs{ior_to:NN} or \cs{ior_str_to:NN}; the file name;
%   and finally the inline function. We make sure to decrease
%   \cs{g_prg_map_int} and close the file after the mapping,
%   even if the mapping exits prematurely because of a
%   \cs{prg_map_break:} instruction. The \cs{ior_if_eof:nF}
%   tests are a little bit tricky to get right: if the file
%   does not exist, we should do nothing, hence the preliminary
%   test. Then the end-of-file test must be done after reading
%   each line.
%    \begin{macrocode}
\cs_new_protected_nopar:Npn \ior_map_inline:nn
  { \ior_map_inline_aux:Nnn \ior_to:NN }
\cs_new_protected_nopar:Npn \ior_str_map_inline:nn
  { \ior_map_inline_aux:Nnn \ior_str_to:NN }
\cs_new_protected_nopar:Npn \ior_map_inline_aux:Nnn
  {
    \exp_args:Ncc \ior_map_inline_aux:NNNnn
      { g_ior_map_ \int_use:N \g_prg_map_int _ior }
      { ior_map_ \int_use:N \g_prg_map_int :n }
  }
\cs_new_protected:Npn \ior_map_inline_aux:NNNnn #1#2#3#4#5
  {
    \cs_if_exist:NF #1 { \ior_new:N #1 }
    \cs_set:Npn #2 ##1 {#5}
    \ior_open:Nn #1 {#4}
    \int_gincr:N \g_prg_map_int
    \ior_if_eof:NF #1 { \ior_map_inline_loop:NNN #1#2#3 }
    \prg_break_point:n
      {
        \int_gdecr:N \g_prg_map_int
        \ior_close:N #1
      }
  }
\cs_new_protected:Npn \ior_map_inline_loop:NNN #1#2#3
  {
    #3 #1 \l_ior_internal_tl
    \ior_if_eof:NF #1
      {
        \exp_args:No #2 \l_ior_internal_tl
        \ior_map_inline_loop:NNN #1#2#3
      }
  }
%    \end{macrocode}
% \end{variable}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
% \end{macro}
%
% \subsection{Messages}
%
%    \begin{macrocode}
\msg_kernel_new:nnnn { io } { space-in-file-name }
  { Space~in~file~name~'#1'. }
  {
    Spaces~are~not~permitted~in~files~loaded~by~LaTeX: \\
    Further~errors~may~follow!
  }
%    \end{macrocode}
%
% \subsection{Deprecated functions}
%
% Deprecated on 2011-05-27, for removal by 2011-08-31.
%
% \begin{macro}{\iow_now_buffer_safe:Nn, \iow_now_buffer_safe:Nx}
%   This is much more easily done using the wrapping system: there is
%   an expansion there, so a bit of a hack is needed.
%    \begin{macrocode}
%<*deprecated>
\cs_new_protected:Npn \iow_now_buffer_safe:Nn #1#2
  { \iow_wrap:xnnnN { \exp_not:n {#2} } { } \c_zero { } \iow_now:Nn #1 }
\cs_new_protected:Npn \iow_now_buffer_safe:Nx #1#2
  { \iow_wrap:xnnnN {#2} { } \c_zero { } \iow_now:Nn #1 }
%</deprecated>
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\ior_open_streams:}
% \begin{macro}{\iow_open_streams:}
%   Slightly misleading names.
%    \begin{macrocode}
%<*deprecated>
\cs_new_eq:NN \ior_open_streams: \ior_list_streams:
\cs_new_eq:NN \iow_open_streams: \iow_list_streams:
%</deprecated>
%    \end{macrocode}
% \end{macro}
% \end{macro}
%
%    \begin{macrocode}
%</initex|package>
%    \end{macrocode}
%
% \end{implementation}
%
% \PrintIndex