?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
sinc with TeXLive revision 41114. (trunk,fix prev. wrong message)
[luatex.git] / manual / old / fdata.lua
blob7da05df3a2ea35c2148a4307dd0da516c62be092
1 -- $Id: fdata.lua 4106 2011-04-10 12:51:54Z hhenkel $
2
3 local fdata = {
4 ["callback"]={
5 ["functions"]={
6 ["buildpage_filter"]={
7 ["arguments"]={
8 {
9 ["name"]="info",
10 ["optional"]=false,
11 ["type"]="string",
12 },
13 },
14 ["returnvalues"]={},
15 ["shortdesc"]="Process objects as they are added to the main vertical list. The string argument gives some context.",
16 ["type"]="callback",
17 },
18 ["close"]={
19 ["arguments"]={
20 {
21 ["name"]="env",
22 ["optional"]=false,
23 ["type"]="table",
24 },
25 },
26 ["returnvalues"]={},
27 ["shortdesc"]="Close a file opened with the \\afunction{open_read_file} callback. The argument is the return value from the \\afunction{open_read_file}",
28 ["type"]="callback",
29 },
30 ["define_font"]={
31 ["arguments"]={
32 {
33 ["name"]="name",
34 ["optional"]=false,
35 ["type"]="string",
36 },
37 {
38 ["name"]="size",
39 ["optional"]=false,
40 ["type"]="number",
41 },
42 },
43 ["returnvalues"]={
44 {
45 ["name"]="font",
46 ["optional"]=false,
47 ["type"]="metrics",
48 },
49 },
50 ["shortdesc"]="Define a font from within lua code. The arguments are the user-supplied information, with negative numbers indicating \\type{scaled}, positive numbers \\type{at}",
51 ["type"]="callback",
52 },
53 ["find"]={
54 ["arguments"]={
55 {
56 ["name"]="callback_name",
57 ["optional"]=false,
58 ["type"]="string",
59 },
60 },
61 ["returnvalues"]={
62 {
63 ["name"]="f",
64 ["optional"]=false,
65 ["type"]="function",
66 },
67 },
68 ["shortdesc"]="Returns the function currently associated with a callback, or \\type{nil}",
69 ["type"]="function",
70 },
71 ["find_data_file"]={
72 ["arguments"]={
73 {
74 ["name"]="asked_name",
75 ["optional"]=false,
76 ["type"]="string",
77 },
78 },
79 ["returnvalues"]={
80 {
81 ["name"]="actual_name",
82 ["optional"]=false,
83 ["type"]="string",
84 },
85 },
86 ["shortdesc"]="Find an input data file for PDF attachment.",
87 ["type"]="callback",
88 },
89 ["find_enc_file"]={
90 ["arguments"]={
91 {
92 ["name"]="asked_name",
93 ["optional"]=false,
94 ["type"]="string",
95 },
96 },
97 ["returnvalues"]={
98 {
99 ["name"]="actual_name",
100 ["optional"]=false,
101 ["type"]="string",
102 },
103 },
104 ["shortdesc"]="Find a font encoding file.",
105 ["type"]="callback",
106 },
107 ["find_font_file"]={
108 ["arguments"]={
109 {
110 ["name"]="asked_name",
111 ["optional"]=false,
112 ["type"]="string",
113 },
114 },
115 ["returnvalues"]={
116 {
117 ["name"]="actual_name",
118 ["optional"]=false,
119 ["type"]="string",
120 },
121 },
122 ["shortdesc"]="Find a font metrics file.",
123 ["type"]="callback",
124 },
125 ["find_format_file"]={
126 ["arguments"]={
127 {
128 ["name"]="asked_name",
129 ["optional"]=false,
130 ["type"]="string",
131 },
132 },
133 ["returnvalues"]={
134 {
135 ["name"]="actual_name",
136 ["optional"]=false,
137 ["type"]="string",
138 },
139 },
140 ["shortdesc"]="Find the format file.",
141 ["type"]="callback",
142 },
143 ["find_image_file"]={
144 ["arguments"]={
145 {
146 ["name"]="asked_name",
147 ["optional"]=false,
148 ["type"]="string",
149 },
150 },
151 ["returnvalues"]={
152 {
153 ["name"]="actual_name",
154 ["optional"]=false,
155 ["type"]="string",
156 },
157 },
158 ["shortdesc"]="Find an image file for inclusion.",
159 ["type"]="callback",
160 },
161 ["find_map_file"]={
162 ["arguments"]={
163 {
164 ["name"]="asked_name",
165 ["optional"]=false,
166 ["type"]="string",
167 },
168 },
169 ["returnvalues"]={
170 {
171 ["name"]="actual_name",
172 ["optional"]=false,
173 ["type"]="string",
174 },
175 },
176 ["shortdesc"]="Find a font map file.",
177 ["type"]="callback",
178 },
179 ["find_opentype_file"]={
180 ["arguments"]={
181 {
182 ["name"]="asked_name",
183 ["optional"]=false,
184 ["type"]="string",
185 },
186 },
187 ["returnvalues"]={
188 {
189 ["name"]="actual_name",
190 ["optional"]=false,
191 ["type"]="string",
192 },
193 },
194 ["shortdesc"]="Find an OpenType font file.",
195 ["type"]="callback",
196 },
197 ["find_output_file"]={
198 ["arguments"]={
199 {
200 ["name"]="asked_name",
201 ["optional"]=false,
202 ["type"]="string",
203 },
204 },
205 ["returnvalues"]={
206 {
207 ["name"]="actual_name",
208 ["optional"]=false,
209 ["type"]="string",
210 },
211 },
212 ["shortdesc"]="Find the output (PDF or DVI) file.",
213 ["type"]="callback",
214 },
215 ["find_pk_file"]={
216 ["arguments"]={
217 {
218 ["name"]="asked_name",
219 ["optional"]=false,
220 ["type"]="string",
221 },
222 },
223 ["returnvalues"]={
224 {
225 ["name"]="actual_name",
226 ["optional"]=false,
227 ["type"]="string",
228 },
229 },
230 ["shortdesc"]="Find a PK font bitmap file.",
231 ["type"]="callback",
232 },
233 ["find_read_file"]={
234 ["arguments"]={
235 {
236 ["name"]="id_number",
237 ["optional"]=false,
238 ["type"]="number",
239 },
240 {
241 ["name"]="asked_name",
242 ["optional"]=false,
243 ["type"]="string",
244 },
245 },
246 ["returnvalues"]={
247 {
248 ["name"]="actual_name",
249 ["optional"]=false,
250 ["type"]="string",
251 },
252 },
253 ["shortdesc"]="Find a file for \\tex{input} (0) or \\tex{openin} (higher integers).",
254 ["type"]="callback",
255 },
256 ["find_subfont_file"]={
257 ["arguments"]={
258 {
259 ["name"]="asked_name",
260 ["optional"]=false,
261 ["type"]="string",
262 },
263 },
264 ["returnvalues"]={
265 {
266 ["name"]="actual_name",
267 ["optional"]=false,
268 ["type"]="string",
269 },
270 },
271 ["shortdesc"]="Find a subfont definition file.",
272 ["type"]="callback",
273 },
274 ["find_truetype_file"]={
275 ["arguments"]={
276 {
277 ["name"]="asked_name",
278 ["optional"]=false,
279 ["type"]="string",
280 },
281 },
282 ["returnvalues"]={
283 {
284 ["name"]="actual_name",
285 ["optional"]=false,
286 ["type"]="string",
287 },
288 },
289 ["shortdesc"]="Find an TrueType font file.",
290 ["type"]="callback",
291 },
292 ["find_type1_file"]={
293 ["arguments"]={
294 {
295 ["name"]="asked_name",
296 ["optional"]=false,
297 ["type"]="string",
298 },
299 },
300 ["returnvalues"]={
301 {
302 ["name"]="actual_name",
303 ["optional"]=false,
304 ["type"]="string",
305 },
306 },
307 ["shortdesc"]="Find an Type1 (PostScript) font file.",
308 ["type"]="callback",
309 },
310 ["find_vf_file"]={
311 ["arguments"]={
312 {
313 ["name"]="asked_name",
314 ["optional"]=false,
315 ["type"]="string",
316 },
317 },
318 ["returnvalues"]={
319 {
320 ["name"]="actual_name",
321 ["optional"]=false,
322 ["type"]="string",
323 },
324 },
325 ["shortdesc"]="Find a VF file.",
326 ["type"]="callback",
327 },
328 ["find_write_file"]={
329 ["arguments"]={
330 {
331 ["name"]="id_number",
332 ["optional"]=false,
333 ["type"]="number",
334 },
335 {
336 ["name"]="asked_name",
337 ["optional"]=false,
338 ["type"]="string",
339 },
340 },
341 ["returnvalues"]={
342 {
343 ["name"]="actual_name",
344 ["optional"]=false,
345 ["type"]="string",
346 },
347 },
348 ["shortdesc"]="Find a file for writing to the log file (0) or with \\tex{write} (higher integers).",
349 ["type"]="callback",
350 },
351 ["finish_pdffile"]={
352 ["arguments"]={},
353 ["returnvalues"]={},
354 ["shortdesc"]="Run actions just before the PDF closing takes place.",
355 ["type"]="callback",
356 },
357 ["hpack_filter"]={
358 ["arguments"]={
359 {
360 ["name"]="head",
361 ["optional"]=false,
362 ["type"]="node",
363 },
364 {
365 ["name"]="groupcode",
366 ["optional"]=false,
367 ["type"]="string",
368 },
369 {
370 ["name"]="size",
371 ["optional"]=false,
372 ["type"]="number",
373 },
374 {
375 ["name"]="packtype",
376 ["optional"]=false,
377 ["type"]="string",
378 },
379 {
380 ["name"]="direction",
381 ["optional"]=false,
382 ["type"]="string",
383 },
384 },
385 ["returnvalues"]={
386 {
387 ["name"]="newhead",
388 ["optional"]=false,
389 ["type"]="node",
390 },
391 },
392 ["shortdesc"]="Alter a node list before horizontal packing takes place. The first string gives some context,\
393 the number is the desired size, the second string is either \\aliteral{exact} or \\aliteral{additional} (modifies the first string),\
394 the third string is the desired direction",
395 ["type"]="callback",
396 },
397 ["hyphenate"]={
398 ["arguments"]={
399 {
400 ["name"]="head",
401 ["optional"]=false,
402 ["type"]="node",
403 },
404 {
405 ["name"]="tail",
406 ["optional"]=false,
407 ["type"]="node",
408 },
409 },
410 ["returnvalues"]={},
411 ["shortdesc"]="Apply hyphenation to a node list.",
412 ["type"]="callback",
413 },
414 ["kerning"]={
415 ["arguments"]={
416 {
417 ["name"]="head",
418 ["optional"]=false,
419 ["type"]="node",
420 },
421 {
422 ["name"]="tail",
423 ["optional"]=false,
424 ["type"]="node",
425 },
426 },
427 ["returnvalues"]={},
428 ["shortdesc"]="Apply kerning to a node list.",
429 ["type"]="callback",
430 },
431 ["ligaturing"]={
432 ["arguments"]={
433 {
434 ["name"]="head",
435 ["optional"]=false,
436 ["type"]="node",
437 },
438 {
439 ["name"]="tail",
440 ["optional"]=false,
441 ["type"]="node",
442 },
443 },
444 ["returnvalues"]={},
445 ["shortdesc"]="Apply ligaturing to a node list.",
446 ["type"]="callback",
447 },
448 ["linebreak_filter"]={
449 ["arguments"]={
450 {
451 ["name"]="head",
452 ["optional"]=false,
453 ["type"]="node",
454 },
455 {
456 ["name"]="is_display",
457 ["optional"]=false,
458 ["type"]="boolean",
459 },
460 },
461 ["returnvalues"]={
462 {
463 ["name"]="newhead",
464 ["optional"]=false,
465 ["type"]="node",
466 },
467 },
468 ["shortdesc"]="Override the linebreaking algorithm. The boolean is \\type{true} if this is a pre-display break.",
469 ["type"]="callback",
470 },
471 ["list"]={
472 ["arguments"]={},
473 ["returnvalues"]={
474 {
475 ["name"]="info",
476 ["optional"]=false,
477 ["type"]="table",
478 },
479 },
480 ["shortdesc"]="Produce a list of all known callback names.",
481 ["type"]="function",
482 },
483 ["mlist_to_hlist"]={
484 ["arguments"]={
485 {
486 ["name"]="head",
487 ["optional"]=false,
488 ["type"]="node",
489 },
490 {
491 ["name"]="displaytype",
492 ["optional"]=false,
493 ["type"]="string",
494 },
495 {
496 ["name"]="need_penalties",
497 ["optional"]=false,
498 ["type"]="boolean",
499 },
500 },
501 ["returnvalues"]={
502 {
503 ["name"]="newhead",
504 ["optional"]=false,
505 ["type"]="node",
506 },
507 },
508 ["shortdesc"]="Convert a math node list into a horizontal node list.",
509 ["type"]="callback",
510 },
511 ["open_read_file"]={
512 ["arguments"]={
513 {
514 ["name"]="file_name",
515 ["optional"]=false,
516 ["type"]="string",
517 },
518 },
519 ["returnvalues"]={
520 {
521 ["name"]="env",
522 ["optional"]=false,
523 ["type"]="table",
524 },
525 },
526 ["shortdesc"]="Open a file for reading. The returned table should define key functions for \\aliteral{reader} and \\aliteral{close}.",
527 ["type"]="callback",
528 },
529 ["post_linebreak_filter"]={
530 ["arguments"]={
531 {
532 ["name"]="head",
533 ["optional"]=false,
534 ["type"]="node",
535 },
536 {
537 ["name"]="groupcode",
538 ["optional"]=false,
539 ["type"]="string",
540 },
541 },
542 ["returnvalues"]={
543 {
544 ["name"]="newhead",
545 ["optional"]=false,
546 ["type"]="node",
547 },
548 },
549 ["shortdesc"]="Alter a node list afer linebreaking has taken place. The string argument gives some context.",
550 ["type"]="callback",
551 },
552 ["pre_dump"]={
553 ["arguments"]={},
554 ["returnvalues"]={},
555 ["shortdesc"]="Run actions just before format dumping takes place.",
556 ["type"]="callback",
557 },
558 ["pre_linebreak_filter"]={
559 ["arguments"]={
560 {
561 ["name"]="head",
562 ["optional"]=false,
563 ["type"]="node",
564 },
565 {
566 ["name"]="groupcode",
567 ["optional"]=false,
568 ["type"]="string",
569 },
570 },
571 ["returnvalues"]={
572 {
573 ["name"]="newhead",
574 ["optional"]=false,
575 ["type"]="node",
576 },
577 },
578 ["shortdesc"]="Alter a node list before linebreaking takes place. The string argument gives some context.",
579 ["type"]="callback",
580 },
581 ["pre_output_filter"]={
582 ["arguments"]={
583 {
584 ["name"]="head",
585 ["optional"]=false,
586 ["type"]="node",
587 },
588 {
589 ["name"]="groupcode",
590 ["optional"]=false,
591 ["type"]="string",
592 },
593 {
594 ["name"]="size",
595 ["optional"]=false,
596 ["type"]="number",
597 },
598 {
599 ["name"]="packtype",
600 ["optional"]=false,
601 ["type"]="string",
602 },
603 {
604 ["name"]="maxdepth",
605 ["optional"]=false,
606 ["type"]="number",
607 },
608 {
609 ["name"]="direction",
610 ["optional"]=false,
611 ["type"]="string",
612 },
613 },
614 ["returnvalues"]={
615 {
616 ["name"]="newhead",
617 ["optional"]=false,
618 ["type"]="node",
619 },
620 },
621 ["shortdesc"]="Alter a node list before boxing to \\tex{outputbox} takes place. See \\afunction{vpack_filter} for the arguments.",
622 ["type"]="callback",
623 },
624 ["process_input_buffer"]={
625 ["arguments"]={
626 {
627 ["name"]="buffer",
628 ["optional"]=false,
629 ["type"]="string",
630 },
631 },
632 ["returnvalues"]={
633 {
634 ["name"]="adjusted_buffer",
635 ["optional"]=false,
636 ["type"]="string",
637 },
638 },
639 ["shortdesc"]="Modify the encoding of the input buffer.",
640 ["type"]="callback",
641 },
642 ["process_output_buffer"]={
643 ["arguments"]={
644 {
645 ["name"]="buffer",
646 ["optional"]=false,
647 ["type"]="string",
648 },
649 },
650 ["returnvalues"]={
651 {
652 ["name"]="adjusted_buffer",
653 ["optional"]=false,
654 ["type"]="string",
655 },
656 },
657 ["shortdesc"]="Modify the encoding of the output buffer.",
658 ["type"]="callback",
659 },
660 ["read_data_file"]={
661 ["arguments"]={
662 {
663 ["name"]="name",
664 ["optional"]=false,
665 ["type"]="string",
666 },
667 },
668 ["returnvalues"]={
669 {
670 ["name"]="success",
671 ["optional"]=false,
672 ["type"]="boolean",
673 },
674 {
675 ["name"]="data",
676 ["optional"]=false,
677 ["type"]="string",
678 },
679 {
680 ["name"]="data_size",
681 ["optional"]=false,
682 ["type"]="number",
683 },
684 },
685 ["shortdesc"]="Read a data file.",
686 ["type"]="callback",
687 },
688 ["read_enc_file"]={
689 ["arguments"]={
690 {
691 ["name"]="name",
692 ["optional"]=false,
693 ["type"]="string",
694 },
695 },
696 ["returnvalues"]={
697 {
698 ["name"]="success",
699 ["optional"]=false,
700 ["type"]="boolean",
701 },
702 {
703 ["name"]="data",
704 ["optional"]=false,
705 ["type"]="string",
706 },
707 {
708 ["name"]="data_size",
709 ["optional"]=false,
710 ["type"]="number",
711 },
712 },
713 ["shortdesc"]="Read a font encoding file.",
714 ["type"]="callback",
715 },
716 ["read_font_file"]={
717 ["arguments"]={
718 {
719 ["name"]="name",
720 ["optional"]=false,
721 ["type"]="string",
722 },
723 },
724 ["returnvalues"]={
725 {
726 ["name"]="success",
727 ["optional"]=false,
728 ["type"]="boolean",
729 },
730 {
731 ["name"]="data",
732 ["optional"]=false,
733 ["type"]="string",
734 },
735 {
736 ["name"]="data_size",
737 ["optional"]=false,
738 ["type"]="number",
739 },
740 },
741 ["shortdesc"]="Read a TFM metrics file. Return \\type{true}, the data, and the data length for success, \\type{false} otherwise",
742 ["type"]="callback",
743 },
744 ["read_map_file"]={
745 ["arguments"]={
746 {
747 ["name"]="name",
748 ["optional"]=false,
749 ["type"]="string",
750 },
751 },
752 ["returnvalues"]={
753 {
754 ["name"]="success",
755 ["optional"]=false,
756 ["type"]="boolean",
757 },
758 {
759 ["name"]="data",
760 ["optional"]=false,
761 ["type"]="string",
762 },
763 {
764 ["name"]="data_size",
765 ["optional"]=false,
766 ["type"]="number",
767 },
768 },
769 ["shortdesc"]="Read a font map file.",
770 ["type"]="callback",
771 },
772 ["read_opentype_file"]={
773 ["arguments"]={
774 {
775 ["name"]="name",
776 ["optional"]=false,
777 ["type"]="string",
778 },
779 },
780 ["returnvalues"]={
781 {
782 ["name"]="success",
783 ["optional"]=false,
784 ["type"]="boolean",
785 },
786 {
787 ["name"]="data",
788 ["optional"]=false,
789 ["type"]="string",
790 },
791 {
792 ["name"]="data_size",
793 ["optional"]=false,
794 ["type"]="number",
795 },
796 },
797 ["shortdesc"]="Read an OpenType font.",
798 ["type"]="callback",
799 },
800 ["read_pk_file"]={
801 ["arguments"]={
802 {
803 ["name"]="name",
804 ["optional"]=false,
805 ["type"]="string",
806 },
807 },
808 ["returnvalues"]={
809 {
810 ["name"]="success",
811 ["optional"]=false,
812 ["type"]="boolean",
813 },
814 {
815 ["name"]="data",
816 ["optional"]=false,
817 ["type"]="string",
818 },
819 {
820 ["name"]="data_size",
821 ["optional"]=false,
822 ["type"]="number",
823 },
824 },
825 ["shortdesc"]="Read a font bitmap PK file.",
826 ["type"]="callback",
827 },
828 ["read_sfd_file"]={
829 ["arguments"]={
830 {
831 ["name"]="name",
832 ["optional"]=false,
833 ["type"]="string",
834 },
835 },
836 ["returnvalues"]={
837 {
838 ["name"]="success",
839 ["optional"]=false,
840 ["type"]="boolean",
841 },
842 {
843 ["name"]="data",
844 ["optional"]=false,
845 ["type"]="string",
846 },
847 {
848 ["name"]="data_size",
849 ["optional"]=false,
850 ["type"]="number",
851 },
852 },
853 ["shortdesc"]="Read a subfont definition file.",
854 ["type"]="callback",
855 },
856 ["read_truetype_file"]={
857 ["arguments"]={
858 {
859 ["name"]="name",
860 ["optional"]=false,
861 ["type"]="string",
862 },
863 },
864 ["returnvalues"]={
865 {
866 ["name"]="success",
867 ["optional"]=false,
868 ["type"]="boolean",
869 },
870 {
871 ["name"]="data",
872 ["optional"]=false,
873 ["type"]="string",
874 },
875 {
876 ["name"]="data_size",
877 ["optional"]=false,
878 ["type"]="number",
879 },
880 },
881 ["shortdesc"]="Read a TrueType font.",
882 ["type"]="callback",
883 },
884 ["read_type1_file"]={
885 ["arguments"]={
886 {
887 ["name"]="name",
888 ["optional"]=false,
889 ["type"]="string",
890 },
891 },
892 ["returnvalues"]={
893 {
894 ["name"]="success",
895 ["optional"]=false,
896 ["type"]="boolean",
897 },
898 {
899 ["name"]="data",
900 ["optional"]=false,
901 ["type"]="string",
902 },
903 {
904 ["name"]="data_size",
905 ["optional"]=false,
906 ["type"]="number",
907 },
908 },
909 ["shortdesc"]="Read a Type1 font.",
910 ["type"]="callback",
911 },
912 ["read_vf_file"]={
913 ["arguments"]={
914 {
915 ["name"]="name",
916 ["optional"]=false,
917 ["type"]="string",
918 },
919 },
920 ["returnvalues"]={
921 {
922 ["name"]="success",
923 ["optional"]=false,
924 ["type"]="boolean",
925 },
926 {
927 ["name"]="data",
928 ["optional"]=false,
929 ["type"]="string",
930 },
931 {
932 ["name"]="data_size",
933 ["optional"]=false,
934 ["type"]="number",
935 },
936 },
937 ["shortdesc"]="Read a VF metrics file.",
938 ["type"]="callback",
939 },
940 ["reader"]={
941 ["arguments"]={
942 {
943 ["name"]="env",
944 ["optional"]=false,
945 ["type"]="table",
946 },
947 },
948 ["returnvalues"]={
949 {
950 ["name"]="line",
951 ["optional"]=false,
952 ["type"]="string",
953 },
954 },
955 ["shortdesc"]="Read a line from a file opened with the \\afunction{open_read_file} callback. The argument is the return value from \\afunction{open_read_file}",
956 ["type"]="callback",
957 },
958 ["register"]={
959 ["arguments"]={
960 {
961 ["name"]="callback_name",
962 ["optional"]=false,
963 ["type"]="string",
964 },
965 {
966 ["name"]="callback_func",
967 ["optional"]=false,
968 ["type"]="function",
969 },
970 },
971 ["returnvalues"]={
972 {
973 ["name"]="id",
974 ["optional"]=false,
975 ["type"]="number",
976 },
977 {
978 ["name"]="error",
979 ["optional"]=true,
980 ["type"]="string",
981 },
982 },
983 ["shortdesc"]="Register a callback. Passing \\type{nil} removes an existing callback. Returns \\type{nil}, \\type{error} on failure.",
984 ["type"]="function",
985 },
986 ["show_error_hook"]={
987 ["arguments"]={},
988 ["returnvalues"]={},
989 ["shortdesc"]="Run action at error reporting time.",
990 ["type"]="callback",
991 },
992 ["start_page_number"]={
993 ["arguments"]={},
994 ["returnvalues"]={},
995 ["shortdesc"]="Run actions at the start of typeset page number message reporting.",
996 ["type"]="callback",
997 },
998 ["start_run"]={
999 ["arguments"]={},
1000 ["returnvalues"]={},
1001 ["shortdesc"]="Run actions at the start of the typesetting run.",
1002 ["type"]="callback",
1003 },
1004 ["stop_page_number"]={
1005 ["arguments"]={},
1006 ["returnvalues"]={},
1007 ["shortdesc"]="Run actions at the end of typeset page number message reporting.",
1008 ["type"]="callback",
1009 },
1010 ["stop_run"]={
1011 ["arguments"]={},
1012 ["returnvalues"]={},
1013 ["shortdesc"]="Run actions just before the end of the typesetting run.",
1014 ["type"]="callback",
1015 },
1016 ["token_filter"]={
1017 ["arguments"]={},
1018 ["returnvalues"]={
1019 {
1020 ["name"]="token",
1021 ["optional"]=false,
1022 ["type"]="table",
1023 },
1024 },
1025 ["shortdesc"]="Override the tokenization process. Return value is a \\type{token} or an array of tokens",
1026 ["type"]="callback",
1027 },
1028 ["vpack_filter"]={
1029 ["arguments"]={
1030 {
1031 ["name"]="head",
1032 ["optional"]=false,
1033 ["type"]="node",
1034 },
1035 {
1036 ["name"]="groupcode",
1037 ["optional"]=false,
1038 ["type"]="string",
1039 },
1040 {
1041 ["name"]="size",
1042 ["optional"]=false,
1043 ["type"]="number",
1044 },
1045 {
1046 ["name"]="packtype",
1047 ["optional"]=false,
1048 ["type"]="string",
1049 },
1050 {
1051 ["name"]="maxdepth",
1052 ["optional"]=false,
1053 ["type"]="number",
1054 },
1055 {
1056 ["name"]="direction",
1057 ["optional"]=false,
1058 ["type"]="string",
1059 },
1060 },
1061 ["returnvalues"]={
1062 {
1063 ["name"]="newhead",
1064 ["optional"]=false,
1065 ["type"]="node",
1066 },
1067 },
1068 ["shortdesc"]="Alter a node list before vertical packing takes place. The second number is the desired max depth. See \\afunction{hpack_filter} for the arguments.",
1069 ["type"]="callback",
1070 },
1071 },
1072 ["methods"]={
1073 },
1074 },
1075 ["epdf"] = require "fdata_epdf",
1076 ["font"]={
1077 ["functions"]={
1078 ["current"]={
1079 ["arguments"]={
1080 {
1081 ["name"]="i",
1082 ["optional"]=true,
1083 ["type"]="number",
1084 },
1085 },
1086 ["returnvalues"]={
1087 {
1088 ["name"]="i",
1089 ["optional"]=true,
1090 ["type"]="number",
1091 },
1092 },
1093 ["shortdesc"]="Get or set the currently active font",
1094 ["type"]="function",
1095 },
1096 ["define"]={
1097 ["arguments"]={
1098 {
1099 ["name"]="f",
1100 ["optional"]=false,
1101 ["type"]="metrics",
1102 },
1103 },
1104 ["returnvalues"]={
1105 {
1106 ["name"]="i",
1107 ["optional"]=false,
1108 ["type"]="number",
1109 },
1110 },
1111 ["shortdesc"]="Process a font metrics table and stores it in the internal font table, returning its internal id.",
1112 ["type"]="function",
1113 },
1114 ["each"]={
1115 ["arguments"]={},
1116 ["returnvalues"]={
1117 {
1118 ["name"]="i",
1119 ["optional"]=false,
1120 ["type"]="number",
1121 },
1122 {
1123 ["name"]="v",
1124 ["optional"]=false,
1125 ["type"]="metrics",
1126 },
1127 },
1128 ["shortdesc"]="Iterate over all the defined fonts.",
1129 ["type"]="function",
1130 },
1131 ["frozen"]={
1132 ["arguments"]={
1133 {
1134 ["name"]="n",
1135 ["optional"]=false,
1136 ["type"]="number",
1137 },
1138 },
1139 ["returnvalues"]={
1140 {
1141 ["name"]="f",
1142 ["optional"]=false,
1143 ["type"]="boolean",
1144 },
1145 },
1146 ["shortdesc"]="True if the font is frozen and can no longer be altered.",
1147 ["type"]="function",
1148 },
1149 ["getfont"]={
1150 ["arguments"]={
1151 {
1152 ["name"]="n",
1153 ["optional"]=false,
1154 ["type"]="number",
1155 },
1156 },
1157 ["returnvalues"]={
1158 {
1159 ["name"]="f",
1160 ["optional"]=false,
1161 ["type"]="metrics",
1162 },
1163 },
1164 ["shortdesc"]="Fetch an internal font id as a lua table.",
1165 ["type"]="function",
1166 },
1167 ["id"]={
1168 ["arguments"]={
1169 {
1170 ["name"]="csname",
1171 ["optional"]=false,
1172 ["type"]="string",
1173 },
1174 },
1175 ["returnvalues"]={
1176 {
1177 ["name"]="i",
1178 ["optional"]=false,
1179 ["type"]="number",
1180 },
1181 },
1182 ["shortdesc"]="Return the font id of the font accessed by the csname given.",
1183 ["type"]="function",
1184 },
1185 ["max"]={
1186 ["arguments"]={},
1187 ["returnvalues"]={
1188 {
1189 ["name"]="i",
1190 ["optional"]=false,
1191 ["type"]="number",
1192 },
1193 },
1194 ["shortdesc"]="Return the highest used font id at this moment.",
1195 ["type"]="function",
1196 },
1197 ["nextid"]={
1198 ["arguments"]={},
1199 ["returnvalues"]={
1200 {
1201 ["name"]="i",
1202 ["optional"]=false,
1203 ["type"]="number",
1204 },
1205 },
1206 ["shortdesc"]="Return the next free font id number.",
1207 ["type"]="function",
1208 },
1209 ["read_tfm"]={
1210 ["arguments"]={
1211 {
1212 ["name"]="name",
1213 ["optional"]=false,
1214 ["type"]="string",
1215 },
1216 {
1217 ["name"]="s",
1218 ["optional"]=false,
1219 ["type"]="number",
1220 },
1221 },
1222 ["returnvalues"]={
1223 {
1224 ["name"]="fnt",
1225 ["optional"]=false,
1226 ["type"]="metrics",
1227 },
1228 },
1229 ["shortdesc"]="Parse a font metrics file, at the size indicated by the number.",
1230 ["type"]="function",
1231 },
1232 ["read_vf"]={
1233 ["arguments"]={
1234 {
1235 ["name"]="name",
1236 ["optional"]=false,
1237 ["type"]="string",
1238 },
1239 {
1240 ["name"]="s",
1241 ["optional"]=false,
1242 ["type"]="number",
1243 },
1244 },
1245 ["returnvalues"]={
1246 {
1247 ["name"]="vf_fnt",
1248 ["optional"]=false,
1249 ["type"]="metrics",
1250 },
1251 },
1252 ["shortdesc"]="Parse a virtual font metrics file, at the size indicated by the number.",
1253 ["type"]="function",
1254 },
1255 ["setfont"]={
1256 ["arguments"]={
1257 {
1258 ["name"]="n",
1259 ["optional"]=false,
1260 ["type"]="number",
1261 },
1262 {
1263 ["name"]="f",
1264 ["optional"]=false,
1265 ["type"]="metrics",
1266 },
1267 },
1268 ["returnvalues"]={},
1269 ["shortdesc"]="Set an internal font id from a lua table.",
1270 ["type"]="function",
1271 },
1272 },
1273 ["methods"]={
1274 },
1275 },
1276 ["fontloader"]={
1277 ["functions"]={
1278 ["apply_afmfile"]={
1279 ["arguments"]={
1280 {
1281 ["name"]="f",
1282 ["optional"]=false,
1283 ["type"]="luafont",
1284 },
1285 {
1286 ["name"]="filename",
1287 ["optional"]=false,
1288 ["type"]="string",
1289 },
1290 },
1291 ["returnvalues"]={},
1292 ["shortdesc"]="Apply an AFM file to a fontloader table.",
1293 ["type"]="function",
1294 },
1295 ["apply_featurefile"]={
1296 ["arguments"]={
1297 {
1298 ["name"]="f",
1299 ["optional"]=false,
1300 ["type"]="luafont",
1301 },
1302 {
1303 ["name"]="filename",
1304 ["optional"]=false,
1305 ["type"]="string",
1306 },
1307 },
1308 ["returnvalues"]={},
1309 ["shortdesc"]="Apply a feature file to a fontloader table.",
1310 ["type"]="function",
1311 },
1312 ["info"]={
1313 ["arguments"]={
1314 {
1315 ["name"]="filename",
1316 ["optional"]=false,
1317 ["type"]="string",
1318 },
1319 },
1320 ["returnvalues"]={
1321 {
1322 ["name"]="info",
1323 ["optional"]=false,
1324 ["type"]="table",
1325 },
1326 },
1327 ["shortdesc"]="Get various information fields from an font file.",
1328 ["type"]="function",
1329 },
1330 ["open"]={
1331 ["arguments"]={
1332 {
1333 ["name"]="filename",
1334 ["optional"]=false,
1335 ["type"]="string",
1336 },
1337 {
1338 ["name"]="fontname",
1339 ["optional"]=true,
1340 ["type"]="string",
1341 },
1342 },
1343 ["returnvalues"]={
1344 {
1345 ["name"]="f",
1346 ["optional"]=false,
1347 ["type"]="luafont",
1348 },
1349 {
1350 ["name"]="w",
1351 ["optional"]=false,
1352 ["type"]="table",
1353 },
1354 },
1355 ["shortdesc"]="Parse a font file and return a table representing its contents. The optional argument\
1356 is the name of the desired font in case of font collection files. The optional return\
1357 value contains any parser error strings.",
1358 ["type"]="function",
1359 },
1360 },
1361 ["methods"]={
1362 },
1363 },
1364 ["img"] = require "fdata_img",
1365 ["kpse"]={
1366 ["functions"]={
1367 ["expand_braces"]={
1368 ["arguments"]={
1369 {
1370 ["name"]="s",
1371 ["optional"]=false,
1372 ["type"]="string",
1373 },
1374 },
1375 ["returnvalues"]={
1376 {
1377 ["name"]="r",
1378 ["optional"]=false,
1379 ["type"]="string",
1380 },
1381 },
1382 ["shortdesc"]="Expand the braces in a variable.",
1383 ["type"]="function",
1384 },
1385 ["expand_path"]={
1386 ["arguments"]={
1387 {
1388 ["name"]="s",
1389 ["optional"]=false,
1390 ["type"]="string",
1391 },
1392 },
1393 ["returnvalues"]={
1394 {
1395 ["name"]="r",
1396 ["optional"]=false,
1397 ["type"]="string",
1398 },
1399 },
1400 ["shortdesc"]="Expand a path.",
1401 ["type"]="function",
1402 },
1403 ["expand_var"]={
1404 ["arguments"]={
1405 {
1406 ["name"]="s",
1407 ["optional"]=false,
1408 ["type"]="string",
1409 },
1410 },
1411 ["returnvalues"]={
1412 {
1413 ["name"]="r",
1414 ["optional"]=false,
1415 ["type"]="string",
1416 },
1417 },
1418 ["shortdesc"]="Expand a variable.",
1419 ["type"]="function",
1420 },
1421 ["find_file"]={
1422 ["arguments"]={
1423 {
1424 ["name"]="filename",
1425 ["optional"]=false,
1426 ["type"]="string",
1427 },
1428 {
1429 ["name"]="ftype",
1430 ["optional"]=true,
1431 ["type"]="string",
1432 },
1433 {
1434 ["name"]="mustexist",
1435 ["optional"]=true,
1436 ["type"]="boolean",
1437 },
1438 {
1439 ["name"]="dpi",
1440 ["optional"]=true,
1441 ["type"]="number",
1442 },
1443 },
1444 ["returnvalues"]={
1445 {
1446 ["name"]="f",
1447 ["optional"]=false,
1448 ["type"]="string",
1449 },
1450 },
1451 ["shortdesc"]="Find a file. The optional string is the file type as supported by the\
1452 standalone \\type{kpsewhich} program (default is \\aliteral{{tex}}, no autodiscovery takes place).\
1453 The optional boolean indicates wether the file must exist.\
1454 The optional number is the dpi value for PK files.\
1455 ",
1456 ["type"]="function",
1457 },
1458 ["init_prog"]={
1459 ["arguments"]={
1460 {
1461 ["name"]="prefix",
1462 ["optional"]=false,
1463 ["type"]="string",
1464 },
1465 {
1466 ["name"]="base_dpi",
1467 ["optional"]=false,
1468 ["type"]="number",
1469 },
1470 {
1471 ["name"]="mfmode",
1472 ["optional"]=false,
1473 ["type"]="string",
1474 },
1475 {
1476 ["name"]="fallback",
1477 ["optional"]=true,
1478 ["type"]="string",
1479 },
1480 },
1481 ["returnvalues"]={},
1482 ["shortdesc"]="Initialize a PK generation program. The optional string is the metafont mode fallback name",
1483 ["type"]="function",
1484 },
1485 ["lookup"]={
1486 ["arguments"]={
1487 {
1488 ["name"]="filename",
1489 ["optional"]=false,
1490 ["type"]="string",
1491 },
1492 {
1493 ["name"]="options",
1494 ["optional"]=false,
1495 ["type"]="table",
1496 },
1497 },
1498 ["returnvalues"]={
1499 {
1500 ["name"]="f",
1501 ["optional"]=false,
1502 ["type"]="string",
1503 },
1504 },
1505 ["shortdesc"]="Find a file (extended interface).",
1506 ["type"]="function",
1507 },
1508 ["new"]={
1509 ["arguments"]={
1510 {
1511 ["name"]="name",
1512 ["optional"]=false,
1513 ["type"]="string",
1514 },
1515 {
1516 ["name"]="progname",
1517 ["optional"]=true,
1518 ["type"]="string",
1519 },
1520 },
1521 ["returnvalues"]={
1522 {
1523 ["name"]="kpathsea",
1524 ["optional"]=false,
1525 ["type"]="kpathsea",
1526 },
1527 },
1528 ["shortdesc"]="Create a new kpathsea library instance. The optional string allows explicit \\type{progname} setting.",
1529 ["type"]="function",
1530 },
1531 ["readable_file"]={
1532 ["arguments"]={
1533 {
1534 ["name"]="name",
1535 ["optional"]=false,
1536 ["type"]="string",
1537 },
1538 },
1539 ["returnvalues"]={
1540 {
1541 ["name"]="f",
1542 ["optional"]=false,
1543 ["type"]="string",
1544 },
1545 },
1546 ["shortdesc"]="Returns true if a file exists and is readable.",
1547 ["type"]="function",
1548 },
1549 ["set_program_name"]={
1550 ["arguments"]={
1551 {
1552 ["name"]="name",
1553 ["optional"]=false,
1554 ["type"]="string",
1555 },
1556 {
1557 ["name"]="progname",
1558 ["optional"]=true,
1559 ["type"]="string",
1560 },
1561 },
1562 ["returnvalues"]={},
1563 ["shortdesc"]="Initialize the kpathsea library by setting the program name. The optional string allows explicit \\type{progname} setting.",
1564 ["type"]="function",
1565 },
1566 ["show_path"]={
1567 ["arguments"]={
1568 {
1569 ["name"]="ftype",
1570 ["optional"]=false,
1571 ["type"]="string",
1572 },
1573 },
1574 ["returnvalues"]={
1575 {
1576 ["name"]="r",
1577 ["optional"]=false,
1578 ["type"]="string",
1579 },
1580 },
1581 ["shortdesc"]="List the search path for a specific file type.",
1582 ["type"]="function",
1583 },
1584 ["var_value"]={
1585 ["arguments"]={
1586 {
1587 ["name"]="s",
1588 ["optional"]=false,
1589 ["type"]="string",
1590 },
1591 },
1592 ["returnvalues"]={
1593 {
1594 ["name"]="r",
1595 ["optional"]=false,
1596 ["type"]="string",
1597 },
1598 },
1599 ["shortdesc"]="Return the value of a variable.",
1600 ["type"]="function",
1601 },
1602 ["version"]={
1603 ["arguments"]={},
1604 ["returnvalues"]={
1605 {
1606 ["name"]="r",
1607 ["optional"]=false,
1608 ["type"]="string",
1609 },
1610 },
1611 ["shortdesc"]="Return the kpathsea version.",
1612 ["type"]="function",
1613 },
1614 },
1615 ["methods"]={
1616 },
1617 },
1618 ["lang"]={
1619 ["functions"]={
1620 ["clean"]={
1621 ["arguments"]={
1622 {
1623 ["name"]="o",
1624 ["optional"]=false,
1625 ["type"]="string",
1626 },
1627 },
1628 ["returnvalues"]={
1629 {
1630 ["name"]="n",
1631 ["optional"]=false,
1632 ["type"]="string",
1633 },
1634 },
1635 ["shortdesc"]="Creates a hyphenation key from the supplied hyphenation exception.",
1636 ["type"]="function",
1637 },
1638 ["clear_hyphenation"]={
1639 ["arguments"]={
1640 {
1641 ["name"]="l",
1642 ["optional"]=false,
1643 ["type"]="language",
1644 },
1645 },
1646 ["returnvalues"]={},
1647 ["shortdesc"]="Clear the set of hyphenation exceptions.",
1648 ["type"]="function",
1649 },
1650 ["clear_patterns"]={
1651 ["arguments"]={
1652 {
1653 ["name"]="l",
1654 ["optional"]=false,
1655 ["type"]="language",
1656 },
1657 },
1658 ["returnvalues"]={},
1659 ["shortdesc"]="Clear the set of hyphenation patterns.",
1660 ["type"]="function",
1661 },
1662 ["hyphenate"]={
1663 ["arguments"]={
1664 {
1665 ["name"]="head",
1666 ["optional"]=false,
1667 ["type"]="node",
1668 },
1669 {
1670 ["name"]="tail",
1671 ["optional"]=true,
1672 ["type"]="node",
1673 },
1674 },
1675 ["returnvalues"]={
1676 {
1677 ["name"]="success",
1678 ["optional"]=false,
1679 ["type"]="boolean",
1680 },
1681 },
1682 ["shortdesc"]="Hyphenate a node list.",
1683 ["type"]="function",
1684 },
1685 ["hyphenation"]={
1686 ["arguments"]={
1687 {
1688 ["name"]="l",
1689 ["optional"]=false,
1690 ["type"]="language",
1691 },
1692 {
1693 ["name"]="n",
1694 ["optional"]=true,
1695 ["type"]="string",
1696 },
1697 },
1698 ["returnvalues"]={
1699 {
1700 ["name"]="n",
1701 ["optional"]=true,
1702 ["type"]="string",
1703 },
1704 },
1705 ["shortdesc"]="Get or set hyphenation exceptions.",
1706 ["type"]="function",
1707 },
1708 ["id"]={
1709 ["arguments"]={
1710 {
1711 ["name"]="l",
1712 ["optional"]=false,
1713 ["type"]="language",
1714 },
1715 },
1716 ["returnvalues"]={
1717 {
1718 ["name"]="n",
1719 ["optional"]=false,
1720 ["type"]="number",
1721 },
1722 },
1723 ["shortdesc"]="Returns the current internal \\tex{language} id number.",
1724 ["type"]="function",
1725 },
1726 ["new"]={
1727 ["arguments"]={
1728 {
1729 ["name"]="id",
1730 ["optional"]=true,
1731 ["type"]="number",
1732 },
1733 },
1734 ["returnvalues"]={
1735 {
1736 ["name"]="l",
1737 ["optional"]=false,
1738 ["type"]="language",
1739 },
1740 },
1741 ["shortdesc"]="Create a new language object, with an optional fixed id number.",
1742 ["type"]="function",
1743 },
1744 ["patterns"]={
1745 ["arguments"]={
1746 {
1747 ["name"]="l",
1748 ["optional"]=false,
1749 ["type"]="language",
1750 },
1751 {
1752 ["name"]="n",
1753 ["optional"]=true,
1754 ["type"]="string",
1755 },
1756 },
1757 ["returnvalues"]={
1758 {
1759 ["name"]="n",
1760 ["optional"]=true,
1761 ["type"]="string",
1762 },
1763 },
1764 ["shortdesc"]="Get or set hyphenation patterns.",
1765 ["type"]="function",
1766 },
1767 ["postexhyphenchar"]={
1768 ["arguments"]={
1769 {
1770 ["name"]="l",
1771 ["optional"]=false,
1772 ["type"]="language",
1773 },
1774 {
1775 ["name"]="n",
1776 ["optional"]=true,
1777 ["type"]="number",
1778 },
1779 },
1780 ["returnvalues"]={
1781 {
1782 ["name"]="n",
1783 ["optional"]=true,
1784 ["type"]="number",
1785 },
1786 },
1787 ["shortdesc"]="Set the post-hyphenchar for explicit hyphenation.",
1788 ["type"]="function",
1789 },
1790 ["posthyphenchar"]={
1791 ["arguments"]={
1792 {
1793 ["name"]="l",
1794 ["optional"]=false,
1795 ["type"]="language",
1796 },
1797 {
1798 ["name"]="n",
1799 ["optional"]=true,
1800 ["type"]="number",
1801 },
1802 },
1803 ["returnvalues"]={
1804 {
1805 ["name"]="n",
1806 ["optional"]=true,
1807 ["type"]="number",
1808 },
1809 },
1810 ["shortdesc"]="Set the post-hyphenchar for implicit hyphenation.",
1811 ["type"]="function",
1812 },
1813 ["preexhyphenchar"]={
1814 ["arguments"]={
1815 {
1816 ["name"]="l",
1817 ["optional"]=false,
1818 ["type"]="language",
1819 },
1820 {
1821 ["name"]="n",
1822 ["optional"]=true,
1823 ["type"]="number",
1824 },
1825 },
1826 ["returnvalues"]={
1827 {
1828 ["name"]="n",
1829 ["optional"]=true,
1830 ["type"]="number",
1831 },
1832 },
1833 ["shortdesc"]="Set the pre-hyphenchar for explicit hyphenation.",
1834 ["type"]="function",
1835 },
1836 ["prehyphenchar"]={
1837 ["arguments"]={
1838 {
1839 ["name"]="l",
1840 ["optional"]=false,
1841 ["type"]="language",
1842 },
1843 {
1844 ["name"]="n",
1845 ["optional"]=true,
1846 ["type"]="number",
1847 },
1848 },
1849 ["returnvalues"]={
1850 {
1851 ["name"]="n",
1852 ["optional"]=true,
1853 ["type"]="number",
1854 },
1855 },
1856 ["shortdesc"]="Set the pre-hyphenchar for implicit hyphenation.",
1857 ["type"]="function",
1858 },
1859 },
1860 ["methods"]={
1861 },
1862 },
1863 ["lfs"]={
1864 ["functions"]={
1865 ["isdir"]={
1866 ["arguments"]={
1867 {
1868 ["name"]="filename",
1869 ["optional"]=false,
1870 ["type"]="string",
1871 },
1872 },
1873 ["returnvalues"]={
1874 {
1875 ["name"]="t",
1876 ["optional"]=false,
1877 ["type"]="boolean",
1878 },
1879 },
1880 ["shortdesc"]="Return true if the string is a directory.",
1881 ["type"]="function",
1882 },
1883 ["isfile"]={
1884 ["arguments"]={
1885 {
1886 ["name"]="filename",
1887 ["optional"]=false,
1888 ["type"]="string",
1889 },
1890 },
1891 ["returnvalues"]={
1892 {
1893 ["name"]="t",
1894 ["optional"]=false,
1895 ["type"]="boolean",
1896 },
1897 },
1898 ["shortdesc"]="Return true if the string is a file.",
1899 ["type"]="function",
1900 },
1901 ["readlink"]={
1902 ["arguments"]={
1903 {
1904 ["name"]="filename",
1905 ["optional"]=false,
1906 ["type"]="string",
1907 },
1908 },
1909 ["returnvalues"]={
1910 {
1911 ["name"]="f",
1912 ["optional"]=false,
1913 ["type"]="string",
1914 },
1915 },
1916 ["shortdesc"]="Return the contents of a symlink (Unix only).",
1917 ["type"]="function",
1918 },
1919 ["shortname"]={
1920 ["arguments"]={
1921 {
1922 ["name"]="filename",
1923 ["optional"]=false,
1924 ["type"]="string",
1925 },
1926 },
1927 ["returnvalues"]={
1928 {
1929 ["name"]="fat",
1930 ["optional"]=false,
1931 ["type"]="string",
1932 },
1933 },
1934 ["shortdesc"]="Return the FAT name of a file (Windows only).",
1935 ["type"]="function",
1936 },
1937 },
1938 ["methods"]={
1939 },
1940 },
1941 ["lua"]={
1942 ["functions"]={
1943 ["getbytecode"]={
1944 ["arguments"]={
1945 {
1946 ["name"]="n",
1947 ["optional"]=false,
1948 ["type"]="number",
1949 },
1950 },
1951 ["returnvalues"]={
1952 {
1953 ["name"]="f",
1954 ["optional"]=false,
1955 ["type"]="function",
1956 },
1957 },
1958 ["shortdesc"]="Return a previously stored function from a bytecode register.",
1959 ["type"]="function",
1960 },
1961 ["setbytecode"]={
1962 ["arguments"]={
1963 {
1964 ["name"]="n",
1965 ["optional"]=false,
1966 ["type"]="number",
1967 },
1968 {
1969 ["name"]="f",
1970 ["optional"]=false,
1971 ["type"]="function",
1972 },
1973 },
1974 ["returnvalues"]={},
1975 ["shortdesc"]="Save a function in a bytecode register.",
1976 ["type"]="function",
1977 },
1978 },
1979 ["methods"]={
1980 },
1981 },
1982 ["mp"]={
1983 ["functions"]={
1984 ["char_depth"]={
1985 ["arguments"]={
1986 {
1987 ["name"]="fontname",
1988 ["optional"]=false,
1989 ["type"]="string",
1990 },
1991 {
1992 ["name"]="char",
1993 ["optional"]=false,
1994 ["type"]="number",
1995 },
1996 },
1997 ["returnvalues"]={
1998 {
1999 ["name"]="w",
2000 ["optional"]=false,
2001 ["type"]="number",
2002 },
2003 },
2004 ["shortdesc"]="Report a character's depth.",
2005 ["type"]="method",
2006 },
2007 ["char_height"]={
2008 ["arguments"]={
2009 {
2010 ["name"]="fontname",
2011 ["optional"]=false,
2012 ["type"]="string",
2013 },
2014 {
2015 ["name"]="char",
2016 ["optional"]=false,
2017 ["type"]="number",
2018 },
2019 },
2020 ["returnvalues"]={
2021 {
2022 ["name"]="w",
2023 ["optional"]=false,
2024 ["type"]="number",
2025 },
2026 },
2027 ["shortdesc"]="Report a character's height.",
2028 ["type"]="method",
2029 },
2030 ["char_width"]={
2031 ["arguments"]={
2032 {
2033 ["name"]="fontname",
2034 ["optional"]=false,
2035 ["type"]="string",
2036 },
2037 {
2038 ["name"]="char",
2039 ["optional"]=false,
2040 ["type"]="number",
2041 },
2042 },
2043 ["returnvalues"]={
2044 {
2045 ["name"]="w",
2046 ["optional"]=false,
2047 ["type"]="number",
2048 },
2049 },
2050 ["shortdesc"]="Report a character's width.",
2051 ["type"]="method",
2052 },
2053 ["execute"]={
2054 ["arguments"]={
2055 {
2056 ["name"]="chunk",
2057 ["optional"]=false,
2058 ["type"]="string",
2059 },
2060 },
2061 ["returnvalues"]={
2062 {
2063 ["name"]="rettable",
2064 ["optional"]=false,
2065 ["type"]="mpdata",
2066 },
2067 },
2068 ["shortdesc"]="Execute metapost code in the instance.",
2069 ["type"]="method",
2070 },
2071 ["finish"]={
2072 ["arguments"]={},
2073 ["returnvalues"]={
2074 {
2075 ["name"]="rettable",
2076 ["optional"]=false,
2077 ["type"]="mpdata",
2078 },
2079 },
2080 ["shortdesc"]="Finish a metapost instance.",
2081 ["type"]="method",
2082 },
2083 ["statistics"]={
2084 ["arguments"]={},
2085 ["returnvalues"]={
2086 {
2087 ["name"]="stats",
2088 ["optional"]=false,
2089 ["type"]="table",
2090 },
2091 },
2092 ["shortdesc"]="Returns some statistics for this metapost instance.",
2093 ["type"]="method",
2094 },
2095 },
2096 ["methods"]={
2097 },
2098 },
2099 ["mplib"]={
2100 ["functions"]={
2101 ["new"]={
2102 ["arguments"]={
2103 {
2104 ["name"]="options",
2105 ["optional"]=false,
2106 ["type"]="table",
2107 },
2108 },
2109 ["returnvalues"]={
2110 {
2111 ["name"]="mp",
2112 ["optional"]=false,
2113 ["type"]="mpinstance",
2114 },
2115 },
2116 ["shortdesc"]="Create a new metapost instance.",
2117 ["type"]="function",
2118 },
2119 ["version"]={
2120 ["arguments"]={},
2121 ["returnvalues"]={
2122 {
2123 ["name"]="v",
2124 ["optional"]=false,
2125 ["type"]="string",
2126 },
2127 },
2128 ["shortdesc"]="Returns the mplib version.",
2129 ["type"]="function",
2130 },
2131 },
2132 ["methods"]={
2133 },
2134 },
2135 ["node"]={
2136 ["functions"]={
2137 ["copy"]={
2138 ["arguments"]={
2139 {
2140 ["name"]="n",
2141 ["optional"]=false,
2142 ["type"]="node",
2143 },
2144 },
2145 ["returnvalues"]={
2146 {
2147 ["name"]="m",
2148 ["optional"]=false,
2149 ["type"]="node",
2150 },
2151 },
2152 ["shortdesc"]="Copy a node.",
2153 ["type"]="function",
2154 },
2155 ["copy_list"]={
2156 ["arguments"]={
2157 {
2158 ["name"]="n",
2159 ["optional"]=false,
2160 ["type"]="node",
2161 },
2162 {
2163 ["name"]="m",
2164 ["optional"]=true,
2165 ["type"]="node",
2166 },
2167 },
2168 ["returnvalues"]={
2169 {
2170 ["name"]="m",
2171 ["optional"]=false,
2172 ["type"]="node",
2173 },
2174 },
2175 ["shortdesc"]="Copy a node list.",
2176 ["type"]="function",
2177 },
2178 ["count"]={
2179 ["arguments"]={
2180 {
2181 ["name"]="id",
2182 ["optional"]=false,
2183 ["type"]="number",
2184 },
2185 {
2186 ["name"]="n",
2187 ["optional"]=false,
2188 ["type"]="node",
2189 },
2190 {
2191 ["name"]="m",
2192 ["optional"]=true,
2193 ["type"]="node",
2194 },
2195 },
2196 ["returnvalues"]={
2197 {
2198 ["name"]="i",
2199 ["optional"]=false,
2200 ["type"]="number",
2201 },
2202 },
2203 ["shortdesc"]="Return the count of nodes with a specific id in a node list. Processing stops just before the optional node.",
2204 ["type"]="function",
2205 },
2206 ["dimensions"]={
2207 ["arguments"]={
2208 {
2209 ["name"]="glue_set",
2210 ["optional"]=true,
2211 ["type"]="number",
2212 },
2213 {
2214 ["name"]="glue_sign",
2215 ["optional"]=true,
2216 ["type"]="number",
2217 },
2218 {
2219 ["name"]="glue_order",
2220 ["optional"]=true,
2221 ["type"]="number",
2222 },
2223 {
2224 ["name"]="n",
2225 ["optional"]=false,
2226 ["type"]="node",
2227 },
2228 {
2229 ["name"]="t",
2230 ["optional"]=true,
2231 ["type"]="node",
2232 },
2233 },
2234 ["returnvalues"]={
2235 {
2236 ["name"]="w",
2237 ["optional"]=false,
2238 ["type"]="number",
2239 },
2240 {
2241 ["name"]="h",
2242 ["optional"]=false,
2243 ["type"]="number",
2244 },
2245 {
2246 ["name"]="d",
2247 ["optional"]=false,
2248 ["type"]="number",
2249 },
2250 },
2251 ["shortdesc"]="Return the natural dimensions of a (horizontal) node list. The 3 optional numbers represent \
2252 glue_set, glue_sign, and glue_order. The calculation stops just before the optional node (default end of list)",
2253 ["type"]="function",
2254 },
2255 ["fields"]={
2256 ["arguments"]={
2257 {
2258 ["name"]="id",
2259 ["optional"]=false,
2260 ["type"]="number",
2261 },
2262 {
2263 ["name"]="subid",
2264 ["optional"]=true,
2265 ["type"]="number",
2266 },
2267 },
2268 ["returnvalues"]={
2269 {
2270 ["name"]="t",
2271 ["optional"]=false,
2272 ["type"]="table",
2273 },
2274 },
2275 ["shortdesc"]="Report the fields a node type understands. The optional argument is needed for whatsits.",
2276 ["type"]="function",
2277 },
2278 ["first_glyph"]={
2279 ["arguments"]={
2280 {
2281 ["name"]="n",
2282 ["optional"]=false,
2283 ["type"]="node",
2284 },
2285 {
2286 ["name"]="m",
2287 ["optional"]=true,
2288 ["type"]="node",
2289 },
2290 },
2291 ["returnvalues"]={
2292 {
2293 ["name"]="n",
2294 ["optional"]=false,
2295 ["type"]="node",
2296 },
2297 },
2298 ["shortdesc"]="Return the first character node in a list. Processing stops just before the optional node.",
2299 ["type"]="function",
2300 },
2301 ["flush_list"]={
2302 ["arguments"]={
2303 {
2304 ["name"]="n",
2305 ["optional"]=false,
2306 ["type"]="node",
2307 },
2308 },
2309 ["returnvalues"]={},
2310 ["shortdesc"]="Release a list of nodes.",
2311 ["type"]="function",
2312 },
2313 ["free"]={
2314 ["arguments"]={
2315 {
2316 ["name"]="n",
2317 ["optional"]=false,
2318 ["type"]="node",
2319 },
2320 },
2321 ["returnvalues"]={},
2322 ["shortdesc"]="Release a node.",
2323 ["type"]="function",
2324 },
2325 ["has_attribute"]={
2326 ["arguments"]={
2327 {
2328 ["name"]="n",
2329 ["optional"]=false,
2330 ["type"]="node",
2331 },
2332 {
2333 ["name"]="id",
2334 ["optional"]=false,
2335 ["type"]="number",
2336 },
2337 {
2338 ["name"]="val",
2339 ["optional"]=true,
2340 ["type"]="number",
2341 },
2342 },
2343 ["returnvalues"]={
2344 {
2345 ["name"]="v",
2346 ["optional"]=false,
2347 ["type"]="number",
2348 },
2349 },
2350 ["shortdesc"]="Return an attribute value for a node, if it has one. The optional number tests for a specific value",
2351 ["type"]="function",
2352 },
2353 ["has_field"]={
2354 ["arguments"]={
2355 {
2356 ["name"]="n",
2357 ["optional"]=false,
2358 ["type"]="node",
2359 },
2360 {
2361 ["name"]="field",
2362 ["optional"]=false,
2363 ["type"]="string",
2364 },
2365 },
2366 ["returnvalues"]={
2367 {
2368 ["name"]="t",
2369 ["optional"]=false,
2370 ["type"]="boolean",
2371 },
2372 },
2373 ["shortdesc"]="Return true if the node understands the named field.",
2374 ["type"]="function",
2375 },
2376 ["hpack"]={
2377 ["arguments"]={
2378 {
2379 ["name"]="n",
2380 ["optional"]=false,
2381 ["type"]="node",
2382 },
2383 {
2384 ["name"]="w",
2385 ["optional"]=true,
2386 ["type"]="number",
2387 },
2388 {
2389 ["name"]="info",
2390 ["optional"]=true,
2391 ["type"]="string",
2392 },
2393 {
2394 ["name"]="dir",
2395 ["optional"]=true,
2396 ["type"]="string",
2397 },
2398 },
2399 ["returnvalues"]={
2400 {
2401 ["name"]="h",
2402 ["optional"]=false,
2403 ["type"]="node",
2404 },
2405 {
2406 ["name"]="b",
2407 ["optional"]=false,
2408 ["type"]="number",
2409 },
2410 },
2411 ["shortdesc"]="Pack a node list into a horizontal list. The number is the desired size, the first string is either \\aliteral{exact} or \\aliteral{additional} (modifies the first string),\
2412 the second string is the desired direction",
2413 ["type"]="function",
2414 },
2415 ["id"]={
2416 ["arguments"]={
2417 {
2418 ["name"]="type",
2419 ["optional"]=false,
2420 ["type"]="string",
2421 },
2422 },
2423 ["returnvalues"]={
2424 {
2425 ["name"]="id",
2426 ["optional"]=false,
2427 ["type"]="number",
2428 },
2429 },
2430 ["shortdesc"]="Convert a node type string into a node id number.",
2431 ["type"]="function",
2432 },
2433 ["insert_after"]={
2434 ["arguments"]={
2435 {
2436 ["name"]="head",
2437 ["optional"]=false,
2438 ["type"]="node",
2439 },
2440 {
2441 ["name"]="current",
2442 ["optional"]=false,
2443 ["type"]="node",
2444 },
2445 {
2446 ["name"]="new",
2447 ["optional"]=false,
2448 ["type"]="node",
2449 },
2450 },
2451 ["returnvalues"]={
2452 {
2453 ["name"]="head",
2454 ["optional"]=false,
2455 ["type"]="node",
2456 },
2457 {
2458 ["name"]="new",
2459 ["optional"]=false,
2460 ["type"]="node",
2461 },
2462 },
2463 ["shortdesc"]="Insert the third node just after the second node in the list that starts at the first node.",
2464 ["type"]="function",
2465 },
2466 ["insert_before"]={
2467 ["arguments"]={
2468 {
2469 ["name"]="head",
2470 ["optional"]=false,
2471 ["type"]="node",
2472 },
2473 {
2474 ["name"]="current",
2475 ["optional"]=false,
2476 ["type"]="node",
2477 },
2478 {
2479 ["name"]="new",
2480 ["optional"]=false,
2481 ["type"]="node",
2482 },
2483 },
2484 ["returnvalues"]={
2485 {
2486 ["name"]="head",
2487 ["optional"]=false,
2488 ["type"]="node",
2489 },
2490 {
2491 ["name"]="new",
2492 ["optional"]=false,
2493 ["type"]="node",
2494 },
2495 },
2496 ["shortdesc"]="Insert the third node just before the second node in the list that starts at the first node.",
2497 ["type"]="function",
2498 },
2499 ["is_node"]={
2500 ["arguments"]={
2501 {
2502 ["name"]="n",
2503 ["optional"]=false,
2504 ["type"]="any",
2505 },
2506 },
2507 ["returnvalues"]={
2508 {
2509 ["name"]="yes",
2510 ["optional"]=false,
2511 ["type"]="boolean",
2512 },
2513 },
2514 ["shortdesc"]="Return true if the object is a <node>.",
2515 ["type"]="function",
2516 },
2517 ["kerning"]={
2518 ["arguments"]={
2519 {
2520 ["name"]="n",
2521 ["optional"]=false,
2522 ["type"]="node",
2523 },
2524 {
2525 ["name"]="m",
2526 ["optional"]=true,
2527 ["type"]="node",
2528 },
2529 },
2530 ["returnvalues"]={
2531 {
2532 ["name"]="h",
2533 ["optional"]=false,
2534 ["type"]="node",
2535 },
2536 {
2537 ["name"]="t",
2538 ["optional"]=false,
2539 ["type"]="node",
2540 },
2541 {
2542 ["name"]="success",
2543 ["optional"]=false,
2544 ["type"]="boolean",
2545 },
2546 },
2547 ["shortdesc"]="Apply the internal kerning routine to a node list. Processing stops just before the optional node.",
2548 ["type"]="function",
2549 },
2550 ["last_node"]={
2551 ["arguments"]={},
2552 ["returnvalues"]={
2553 {
2554 ["name"]="n",
2555 ["optional"]=false,
2556 ["type"]="node",
2557 },
2558 },
2559 ["shortdesc"]="Pops and returns the last node on the current output list.",
2560 ["type"]="function",
2561 },
2562 ["length"]={
2563 ["arguments"]={
2564 {
2565 ["name"]="n",
2566 ["optional"]=false,
2567 ["type"]="node",
2568 },
2569 {
2570 ["name"]="m",
2571 ["optional"]=true,
2572 ["type"]="node",
2573 },
2574 },
2575 ["returnvalues"]={
2576 {
2577 ["name"]="i",
2578 ["optional"]=false,
2579 ["type"]="number",
2580 },
2581 },
2582 ["shortdesc"]="Return the length of a node list. Processing stops just before the optional node.",
2583 ["type"]="function",
2584 },
2585 ["ligaturing"]={
2586 ["arguments"]={
2587 {
2588 ["name"]="n",
2589 ["optional"]=false,
2590 ["type"]="node",
2591 },
2592 {
2593 ["name"]="m",
2594 ["optional"]=true,
2595 ["type"]="node",
2596 },
2597 },
2598 ["returnvalues"]={
2599 {
2600 ["name"]="h",
2601 ["optional"]=false,
2602 ["type"]="node",
2603 },
2604 {
2605 ["name"]="t",
2606 ["optional"]=false,
2607 ["type"]="node",
2608 },
2609 {
2610 ["name"]="success",
2611 ["optional"]=false,
2612 ["type"]="boolean",
2613 },
2614 },
2615 ["shortdesc"]="Apply the internal ligaturing routine to a node list. Processing stops just before the optional node.",
2616 ["type"]="function",
2617 },
2618 ["mlist_to_hlist"]={
2619 ["arguments"]={
2620 {
2621 ["name"]="n",
2622 ["optional"]=false,
2623 ["type"]="node",
2624 },
2625 {
2626 ["name"]="displaytype",
2627 ["optional"]=false,
2628 ["type"]="string",
2629 },
2630 {
2631 ["name"]="penalties",
2632 ["optional"]=false,
2633 ["type"]="boolean",
2634 },
2635 },
2636 ["returnvalues"]={
2637 {
2638 ["name"]="h",
2639 ["optional"]=false,
2640 ["type"]="node",
2641 },
2642 },
2643 ["shortdesc"]="Recursively convert a math list into a horizontal list. The string differentiates display and inline, the boolean\
2644 whether penalties are inserted",
2645 ["type"]="function",
2646 },
2647 ["new"]={
2648 ["arguments"]={
2649 {
2650 ["name"]="id",
2651 ["optional"]=false,
2652 ["type"]="number",
2653 },
2654 {
2655 ["name"]="subid",
2656 ["optional"]=true,
2657 ["type"]="number",
2658 },
2659 },
2660 ["returnvalues"]={
2661 {
2662 ["name"]="n",
2663 ["optional"]=false,
2664 ["type"]="node",
2665 },
2666 },
2667 ["shortdesc"]="Create a new node with id and (optional) subtype.",
2668 ["type"]="function",
2669 },
2670 ["protect_glyphs"]={
2671 ["arguments"]={
2672 {
2673 ["name"]="n",
2674 ["optional"]=false,
2675 ["type"]="node",
2676 },
2677 },
2678 ["returnvalues"]={},
2679 ["shortdesc"]="Mark all processed glyphs in a node list as being characters.",
2680 ["type"]="function",
2681 },
2682 ["protrusion_skippable"]={
2683 ["arguments"]={
2684 {
2685 ["name"]="n",
2686 ["optional"]=false,
2687 ["type"]="node",
2688 },
2689 },
2690 ["returnvalues"]={
2691 {
2692 ["name"]="yes",
2693 ["optional"]=false,
2694 ["type"]="boolean",
2695 },
2696 },
2697 ["shortdesc"]="Return true if the node could be skipped for protrusion purposes.",
2698 ["type"]="function",
2699 },
2700 ["remove"]={
2701 ["arguments"]={
2702 {
2703 ["name"]="head",
2704 ["optional"]=false,
2705 ["type"]="node",
2706 },
2707 {
2708 ["name"]="current",
2709 ["optional"]=false,
2710 ["type"]="node",
2711 },
2712 },
2713 ["returnvalues"]={
2714 {
2715 ["name"]="head",
2716 ["optional"]=false,
2717 ["type"]="node",
2718 },
2719 {
2720 ["name"]="current",
2721 ["optional"]=false,
2722 ["type"]="node",
2723 },
2724 },
2725 ["shortdesc"]="Extract and remove a second node from the list that starts in the first node.",
2726 ["type"]="function",
2727 },
2728 ["set_attribute"]={
2729 ["arguments"]={
2730 {
2731 ["name"]="n",
2732 ["optional"]=false,
2733 ["type"]="node",
2734 },
2735 {
2736 ["name"]="id",
2737 ["optional"]=false,
2738 ["type"]="number",
2739 },
2740 {
2741 ["name"]="val",
2742 ["optional"]=false,
2743 ["type"]="number",
2744 },
2745 },
2746 ["returnvalues"]={},
2747 ["shortdesc"]="Set an attribute value for a node.",
2748 ["type"]="function",
2749 },
2750 ["slide"]={
2751 ["arguments"]={
2752 {
2753 ["name"]="n",
2754 ["optional"]=false,
2755 ["type"]="node",
2756 },
2757 },
2758 ["returnvalues"]={
2759 {
2760 ["name"]="m",
2761 ["optional"]=false,
2762 ["type"]="node",
2763 },
2764 },
2765 ["shortdesc"]="Move to the last node of a list while fixing next and prev pointers.",
2766 ["type"]="function",
2767 },
2768 ["next"]={
2769 ["arguments"]={
2770 {
2771 ["name"]="n",
2772 ["optional"]=false,
2773 ["type"]="node",
2774 },
2775 },
2776 ["returnvalues"]={
2777 {
2778 ["name"]="m",
2779 ["optional"]=false,
2780 ["type"]="node",
2781 },
2782 },
2783 ["shortdesc"]="Returns the next node.",
2784 ["type"]="function",
2785 },
2786 ["prev"]={
2787 ["arguments"]={
2788 {
2789 ["name"]="n",
2790 ["optional"]=false,
2791 ["type"]="node",
2792 },
2793 },
2794 ["returnvalues"]={
2795 {
2796 ["name"]="m",
2797 ["optional"]=false,
2798 ["type"]="node",
2799 },
2800 },
2801 ["shortdesc"]="Returns the previous node.",
2802 ["type"]="function",
2803 },
2804 ["subtype"]={
2805 ["arguments"]={
2806 {
2807 ["name"]="type",
2808 ["optional"]=false,
2809 ["type"]="string",
2810 },
2811 },
2812 ["returnvalues"]={
2813 {
2814 ["name"]="subtype",
2815 ["optional"]=false,
2816 ["type"]="number",
2817 },
2818 },
2819 ["shortdesc"]="Convert a whatsit type string into a node subtype number.",
2820 ["type"]="function",
2821 },
2822 ["tail"]={
2823 ["arguments"]={
2824 {
2825 ["name"]="n",
2826 ["optional"]=false,
2827 ["type"]="node",
2828 },
2829 },
2830 ["returnvalues"]={
2831 {
2832 ["name"]="m",
2833 ["optional"]=false,
2834 ["type"]="node",
2835 },
2836 },
2837 ["shortdesc"]="Return the last node in a list.",
2838 ["type"]="function",
2839 },
2840 ["traverse"]={
2841 ["arguments"]={
2842 {
2843 ["name"]="n",
2844 ["optional"]=false,
2845 ["type"]="node",
2846 },
2847 },
2848 ["returnvalues"]={
2849 {
2850 ["name"]="t",
2851 ["optional"]=false,
2852 ["type"]="node",
2853 },
2854 },
2855 ["shortdesc"]="Iterate over a node list.",
2856 ["type"]="function",
2857 },
2858 ["traverse_id"]={
2859 ["arguments"]={
2860 {
2861 ["name"]="id",
2862 ["optional"]=false,
2863 ["type"]="number",
2864 },
2865 {
2866 ["name"]="n",
2867 ["optional"]=false,
2868 ["type"]="node",
2869 },
2870 },
2871 ["returnvalues"]={
2872 {
2873 ["name"]="t",
2874 ["optional"]=false,
2875 ["type"]="node",
2876 },
2877 },
2878 ["shortdesc"]="Iterate over nodes with id matching the number in a node list.",
2879 ["type"]="function",
2880 },
2881 ["type"]={
2882 ["arguments"]={
2883 {
2884 ["name"]="id",
2885 ["optional"]=false,
2886 ["type"]="number",
2887 },
2888 },
2889 ["returnvalues"]={
2890 {
2891 ["name"]="type",
2892 ["optional"]=false,
2893 ["type"]="string",
2894 },
2895 },
2896 ["shortdesc"]="convert a node id number into a node type string.",
2897 ["type"]="function",
2898 },
2899 ["types"]={
2900 ["arguments"]={},
2901 ["returnvalues"]={
2902 {
2903 ["name"]="t",
2904 ["optional"]=false,
2905 ["type"]="table",
2906 },
2907 },
2908 ["shortdesc"]="Return the list of node types.",
2909 ["type"]="function",
2910 },
2911 ["unprotect_glyphs"]={
2912 ["arguments"]={
2913 {
2914 ["name"]="n",
2915 ["optional"]=false,
2916 ["type"]="node",
2917 },
2918 },
2919 ["returnvalues"]={},
2920 ["shortdesc"]="Mark all characters in a node list as being processed glyphs.",
2921 ["type"]="function",
2922 },
2923 ["unset_attribute"]={
2924 ["arguments"]={
2925 {
2926 ["name"]="n",
2927 ["optional"]=false,
2928 ["type"]="node",
2929 },
2930 {
2931 ["name"]="i",
2932 ["optional"]=false,
2933 ["type"]="number",
2934 },
2935 {
2936 ["name"]="val",
2937 ["optional"]=true,
2938 ["type"]="number",
2939 },
2940 },
2941 ["returnvalues"]={
2942 {
2943 ["name"]="v",
2944 ["optional"]=false,
2945 ["type"]="number",
2946 },
2947 },
2948 ["shortdesc"]="Unset an attribute value for a node. The optional number tests for a specific value",
2949 ["type"]="function",
2950 },
2951 ["vpack"]={
2952 ["arguments"]={
2953 {
2954 ["name"]="n",
2955 ["optional"]=false,
2956 ["type"]="node",
2957 },
2958 {
2959 ["name"]="w",
2960 ["optional"]=true,
2961 ["type"]="number",
2962 },
2963 {
2964 ["name"]="info",
2965 ["optional"]=true,
2966 ["type"]="string",
2967 },
2968 {
2969 ["name"]="dir",
2970 ["optional"]=true,
2971 ["type"]="string",
2972 },
2973 },
2974 ["returnvalues"]={
2975 {
2976 ["name"]="h",
2977 ["optional"]=false,
2978 ["type"]="node",
2979 },
2980 {
2981 ["name"]="b",
2982 ["optional"]=false,
2983 ["type"]="number",
2984 },
2985 },
2986 ["shortdesc"]="Pack a node list into a vertical list. Arguments as for node.hpack",
2987 ["type"]="function",
2988 },
2989 ["whatsits"]={
2990 ["arguments"]={},
2991 ["returnvalues"]={
2992 {
2993 ["name"]="t",
2994 ["optional"]=false,
2995 ["type"]="table",
2996 },
2997 },
2998 ["shortdesc"]="Return the list of whatsit types.",
2999 ["type"]="function",
3000 },
3001 ["write"]={
3002 ["arguments"]={
3003 {
3004 ["name"]="n",
3005 ["optional"]=false,
3006 ["type"]="node",
3007 },
3008 },
3009 ["returnvalues"]={},
3010 ["shortdesc"]="Appends a node to the current output list.",
3011 ["type"]="function",
3012 },
3013 },
3014 ["methods"]={
3015 },
3016 },
3017 ["os"]={
3018 ["functions"]={
3019 ["exec"]={
3020 ["arguments"]={
3021 {
3022 ["name"]="command",
3023 ["optional"]=false,
3024 ["type"]="table",
3025 },
3026 },
3027 ["returnvalues"]={},
3028 ["shortdesc"]=" Run an external command and exit. The table is an array of arguments, with an optional \\type{argv[0]} in index 0.",
3029 ["type"]="function",
3030 },
3031 ["gettimeofday"]={
3032 ["arguments"]={},
3033 ["returnvalues"]={
3034 {
3035 ["name"]="time",
3036 ["optional"]=false,
3037 ["type"]="number",
3038 },
3039 },
3040 ["shortdesc"]="Get the time as a floating point number (Unix only).",
3041 ["type"]="function",
3042 },
3043 ["setenv"]={
3044 ["arguments"]={
3045 {
3046 ["name"]="key",
3047 ["optional"]=false,
3048 ["type"]="string",
3049 },
3050 {
3051 ["name"]="value",
3052 ["optional"]=false,
3053 ["type"]="string",
3054 },
3055 },
3056 ["returnvalues"]={},
3057 ["shortdesc"]="Set an environment variable.",
3058 ["type"]="function",
3059 },
3060 ["spawn"]={
3061 ["arguments"]={
3062 {
3063 ["name"]="command",
3064 ["optional"]=false,
3065 ["type"]="table",
3066 },
3067 },
3068 ["returnvalues"]={
3069 {
3070 ["name"]="succ",
3071 ["optional"]=false,
3072 ["type"]="boolean",
3073 },
3074 },
3075 ["shortdesc"]="Run an external command and return its exit code. The table is an array of arguments, with an optional \\type{argv[0]} in index 0.",
3076 ["type"]="function",
3077 },
3078 ["times"]={
3079 ["arguments"]={},
3080 ["returnvalues"]={
3081 {
3082 ["name"]="times",
3083 ["optional"]=false,
3084 ["type"]="table",
3085 },
3086 },
3087 ["shortdesc"]="Return process times.",
3088 ["type"]="function",
3089 },
3090 ["tmpdir"]={
3091 ["arguments"]={},
3092 ["returnvalues"]={
3093 {
3094 ["name"]="d",
3095 ["optional"]=false,
3096 ["type"]="string",
3097 },
3098 },
3099 ["shortdesc"]="Create a temporary directory inside the current directory.",
3100 ["type"]="function",
3101 },
3102 ["selfdir"]={
3103 ["arguments"]={},
3104 ["returnvalues"]={
3105 {
3106 ["name"]="d",
3107 ["optional"]=false,
3108 ["type"]="string",
3109 },
3110 },
3111 ["shortdesc"]="Return the directory path of argv[0].",
3112 ["type"]="function",
3113 },
3114 ["uname"]={
3115 ["arguments"]={},
3116 ["returnvalues"]={
3117 {
3118 ["name"]="data",
3119 ["optional"]=false,
3120 ["type"]="table",
3121 },
3122 },
3123 ["shortdesc"]="Return various information strings about the computer.",
3124 ["type"]="function",
3125 },
3126 },
3127 ["methods"]={
3128 },
3129 },
3130 ["pdf"]={
3131 ["functions"]={
3132 ["immediateobj"]={
3133 ["arguments"]={
3134 {
3135 ["name"]="n",
3136 ["optional"]=true,
3137 ["type"]="number",
3138 },
3139 {
3140 ["name"]="type",
3141 ["optional"]=true,
3142 ["type"]="string",
3143 },
3144 {
3145 ["name"]="objtext",
3146 ["optional"]=false,
3147 ["type"]="string",
3148 },
3149 {
3150 ["name"]="extradata",
3151 ["optional"]=true,
3152 ["type"]="string",
3153 },
3154 },
3155 ["returnvalues"]={
3156 {
3157 ["name"]="n",
3158 ["optional"]=false,
3159 ["type"]="number",
3160 },
3161 },
3162 ["shortdesc"]="Write an object to the PDF file immediately. The optional number is an object id,\
3163 the first optional string is \\aliteral{{file}}, \\aliteral{{stream}}, or \\aliteral{{filestream}}.\
3164 the second optional string contains stream attributes for the latter two cases.\
3165 ",
3166 ["type"]="function",
3167 },
3168 ["obj"]={
3169 ["arguments"]={
3170 {
3171 ["name"]="n",
3172 ["optional"]=true,
3173 ["type"]="number",
3174 },
3175 {
3176 ["name"]="type",
3177 ["optional"]=true,
3178 ["type"]="string",
3179 },
3180 {
3181 ["name"]="objtext",
3182 ["optional"]=false,
3183 ["type"]="string",
3184 },
3185 {
3186 ["name"]="extradata",
3187 ["optional"]=true,
3188 ["type"]="string",
3189 },
3190 },
3191 ["returnvalues"]={
3192 {
3193 ["name"]="n",
3194 ["optional"]=false,
3195 ["type"]="number",
3196 },
3197 },
3198 ["shortdesc"]="Write an object to the PDF file. See \\aliteral{pdf.immediateobj} for arguments.",
3199 ["type"]="function",
3200 },
3201 ["refobj"]={
3202 ["arguments"]={
3203 {
3204 ["name"]="n",
3205 ["optional"]=false,
3206 ["type"]="number",
3207 }
3208 },
3209 ["returnvalues"]={},
3210 ["shortdesc"]="Reference an object, so that it will be written out.",
3211 ["type"]="function",
3212 },
3213 ["print"]={
3214 ["arguments"]={
3215 {
3216 ["name"]="type",
3217 ["optional"]=true,
3218 ["type"]="string",
3219 },
3220 {
3221 ["name"]="s",
3222 ["optional"]=false,
3223 ["type"]="string",
3224 },
3225 },
3226 ["returnvalues"]={},
3227 ["shortdesc"]="Write directly to the PDF file (use in \\tex{latelua}). The optional string is\
3228 one of \\aliteral{{direct}} or \\aliteral{{page}}",
3229 ["type"]="function",
3230 },
3231 ["registerannot"]={
3232 ["arguments"]={
3233 {
3234 ["name"]="objnum",
3235 ["optional"]=false,
3236 ["type"]="number",
3237 },
3238 },
3239 ["returnvalues"]={},
3240 ["shortdesc"]="Register an annotation in the PDF backend.",
3241 ["type"]="function",
3242 },
3243 ["pageref"]={
3244 ["arguments"]={
3245 {
3246 ["name"]="objnum",
3247 ["optional"]=false,
3248 ["type"]="number",
3249 },
3250 },
3251 ["returnvalues"]={
3252 {
3253 ["name"]="page",
3254 ["optional"]=false,
3255 ["type"]="number",
3256 },
3257 },
3258 ["shortdesc"]="Return the pageref object number.",
3259 ["type"]="function",
3260 },
3261
3262 ["mapfile"]={
3263 ["arguments"]={
3264 {
3265 ["name"]="s",
3266 ["optional"]=false,
3267 ["type"]="string",
3268 },
3269 },
3270 ["returnvalues"]={},
3271 ["shortdesc"]="Register a font map file.",
3272 ["type"]="function",
3273 },
3274
3275 ["mapline"]={
3276 ["arguments"]={
3277 {
3278 ["name"]="s",
3279 ["optional"]=false,
3280 ["type"]="string",
3281 },
3282 },
3283 ["returnvalues"]={},
3284 ["shortdesc"]="Register a font map line.",
3285 ["type"]="function",
3286 },
3287
3288 ["reserveobj"]={
3289 ["arguments"]={},
3290 ["returnvalues"]={
3291 {
3292 ["name"]="n",
3293 ["optional"]=false,
3294 ["type"]="number",
3295 },
3296 },
3297 ["shortdesc"]="Reserve an object number in the PDF backend.",
3298 ["type"]="function",
3299 },
3300 },
3301 ["methods"]={
3302 },
3303 },
3304 ["status"]={
3305 ["functions"]={
3306 ["list"]={
3307 ["arguments"]={},
3308 ["returnvalues"]={
3309 {
3310 ["name"]="info",
3311 ["optional"]=false,
3312 ["type"]="table",
3313 },
3314 },
3315 ["shortdesc"]="Returns a table with various status items.",
3316 ["type"]="function",
3317 },
3318 },
3319 ["methods"]={
3320 },
3321 },
3322 ["string"]={
3323 ["functions"]={
3324 ["bytepairs"]={
3325 ["arguments"]={
3326 {
3327 ["name"]="s",
3328 ["optional"]=false,
3329 ["type"]="string",
3330 },
3331 },
3332 ["returnvalues"]={
3333 {
3334 ["name"]="n",
3335 ["optional"]=false,
3336 ["type"]="number",
3337 },
3338 {
3339 ["name"]="m",
3340 ["optional"]=false,
3341 ["type"]="number",
3342 },
3343 },
3344 ["shortdesc"]="Iterator that returns two values representing two single 8-byte tokens.",
3345 ["type"]="function",
3346 },
3347 ["bytes"]={
3348 ["arguments"]={
3349 {
3350 ["name"]="s",
3351 ["optional"]=false,
3352 ["type"]="string",
3353 },
3354 },
3355 ["returnvalues"]={
3356 {
3357 ["name"]="n",
3358 ["optional"]=false,
3359 ["type"]="number",
3360 },
3361 },
3362 ["shortdesc"]="Iterator that returns a value representing a single 8-byte token.",
3363 ["type"]="function",
3364 },
3365 ["characterpairs"]={
3366 ["arguments"]={
3367 {
3368 ["name"]="s",
3369 ["optional"]=false,
3370 ["type"]="string",
3371 },
3372 },
3373 ["returnvalues"]={
3374 {
3375 ["name"]="s",
3376 ["optional"]=false,
3377 ["type"]="string",
3378 },
3379 {
3380 ["name"]="t",
3381 ["optional"]=false,
3382 ["type"]="string",
3383 },
3384 },
3385 ["shortdesc"]="Iterator that returns two strings representing two single \\UTF-8 tokens.",
3386 ["type"]="function",
3387 },
3388 ["characters"]={
3389 ["arguments"]={
3390 {
3391 ["name"]="s",
3392 ["optional"]=false,
3393 ["type"]="string",
3394 },
3395 },
3396 ["returnvalues"]={
3397 {
3398 ["name"]="s",
3399 ["optional"]=false,
3400 ["type"]="string",
3401 },
3402 },
3403 ["shortdesc"]="Iterator that returns a string representing a single 8-byte token.",
3404 ["type"]="function",
3405 },
3406 ["explode"]={
3407 ["arguments"]={
3408 {
3409 ["name"]="s",
3410 ["optional"]=false,
3411 ["type"]="string",
3412 },
3413 {
3414 ["name"]="sep",
3415 ["optional"]=true,
3416 ["type"]="string",
3417 },
3418 },
3419 ["returnvalues"]={
3420 {
3421 ["name"]="i",
3422 ["optional"]=false,
3423 ["type"]="table",
3424 },
3425 },
3426 ["shortdesc"]="Break a string into pieces. The optional argument is a character possibly followed by a plus sign (default \\aliteral{{ +}})",
3427 ["type"]="function",
3428 },
3429 ["utfcharacters"]={
3430 ["arguments"]={
3431 {
3432 ["name"]="s",
3433 ["optional"]=false,
3434 ["type"]="string",
3435 },
3436 },
3437 ["returnvalues"]={
3438 {
3439 ["name"]="s",
3440 ["optional"]=false,
3441 ["type"]="string",
3442 },
3443 },
3444 ["shortdesc"]="Iterator that returns a string representing a single \\UTF-8 token.",
3445 ["type"]="function",
3446 },
3447 ["utfvalues"]={
3448 ["arguments"]={
3449 {
3450 ["name"]="s",
3451 ["optional"]=false,
3452 ["type"]="string",
3453 },
3454 },
3455 ["returnvalues"]={
3456 {
3457 ["name"]="n",
3458 ["optional"]=false,
3459 ["type"]="number",
3460 },
3461 },
3462 ["shortdesc"]="Iterator that returns a value representing a single \\UTF-8 token.",
3463 ["type"]="function",
3464 },
3465 },
3466 ["methods"]={
3467 },
3468 },
3469 ["tex"]={
3470 ["functions"]={
3471 ["badness"]={
3472 ["arguments"]={
3473 {
3474 ["name"]="f",
3475 ["optional"]=false,
3476 ["type"]="number",
3477 },
3478 {
3479 ["name"]="s",
3480 ["optional"]=false,
3481 ["type"]="number",
3482 },
3483 },
3484 ["returnvalues"]={
3485 {
3486 ["name"]="b",
3487 ["optional"]=false,
3488 ["type"]="number",
3489 },
3490 },
3491 ["shortdesc"]="Compute a badness value.",
3492 ["type"]="function",
3493 },
3494 ["definefont"]={
3495 ["arguments"]={
3496 {
3497 ["name"]="global",
3498 ["optional"]=true,
3499 ["type"]="boolean",
3500 },
3501 {
3502 ["name"]="csname",
3503 ["optional"]=false,
3504 ["type"]="string",
3505 },
3506 {
3507 ["name"]="fontid",
3508 ["optional"]=false,
3509 ["type"]="number",
3510 },
3511 },
3512 ["returnvalues"]={},
3513 ["shortdesc"]="Define a font csname. The optional boolean indicates for global definition, the string is the csname, the number is a font id.",
3514 ["type"]="function",
3515 },
3516 ["enableprimitives"]={
3517 ["arguments"]={
3518 {
3519 ["name"]="prefix",
3520 ["optional"]=false,
3521 ["type"]="string",
3522 },
3523 {
3524 ["name"]="names",
3525 ["optional"]=false,
3526 ["type"]="table",
3527 },
3528 },
3529 ["returnvalues"]={},
3530 ["shortdesc"]="Enable the all primitives in the array using the string as prefix.",
3531 ["type"]="function",
3532 },
3533 ["error"]={
3534 ["arguments"]={
3535 {
3536 ["name"]="s",
3537 ["optional"]=false,
3538 ["type"]="string",
3539 },
3540 {
3541 ["name"]="helptext",
3542 ["optional"]=true,
3543 ["type"]="table",
3544 },
3545 },
3546 ["returnvalues"]={},
3547 ["shortdesc"]="Create an error that is presented to the user. The optional table is an array of help message strings.",
3548 ["type"]="function",
3549 },
3550 ["extraprimitives"]={
3551 ["arguments"]={
3552 {
3553 ["name"]="s1",
3554 ["optional"]=false,
3555 ["type"]="string",
3556 },
3557 {
3558 ["name"]="s2",
3559 ["optional"]=true,
3560 ["type"]="string",
3561 },
3562 },
3563 ["returnvalues"]={
3564 {
3565 ["name"]="t",
3566 ["optional"]=false,
3567 ["type"]="table",
3568 },
3569 },
3570 ["shortdesc"]="Return all primitives in a (set of) extension identifiers. Valid identifiers are: \
3571 \\aliteral{tex}, \\aliteral{core}, \\aliteral{etex}, \\aliteral{pdftex}, \\aliteral{omega}, \\aliteral{aleph}, and \\aliteral{luatex}.",
3572 ["type"]="function",
3573 },
3574 ["get"]={
3575 ["arguments"]={
3576 {
3577 ["name"]="n",
3578 ["optional"]=false,
3579 ["type"]="string",
3580 },
3581 },
3582 ["returnvalues"]={
3583 {
3584 ["name"]="v",
3585 ["optional"]=false,
3586 ["type"]="value",
3587 },
3588 },
3589 ["shortdesc"]="Get a named internal register. Also accepts a predefined csname string.",
3590 ["type"]="function",
3591 },
3592 ["getattribute"]={
3593 ["arguments"]={
3594 {
3595 ["name"]="n",
3596 ["optional"]=false,
3597 ["type"]="number",
3598 },
3599 },
3600 ["returnvalues"]={
3601 {
3602 ["name"]="s",
3603 ["optional"]=false,
3604 ["type"]="number",
3605 },
3606 },
3607 ["shortdesc"]="Get an attribute register. Also accepts a predefined csname string.",
3608 ["type"]="function",
3609 },
3610 ["getbox"]={
3611 ["arguments"]={
3612 {
3613 ["name"]="n",
3614 ["optional"]=false,
3615 ["type"]="number",
3616 },
3617 },
3618 ["returnvalues"]={
3619 {
3620 ["name"]="s",
3621 ["optional"]=false,
3622 ["type"]="node",
3623 },
3624 },
3625 ["shortdesc"]="Get a box register. Also accepts a predefined csname string.",
3626 ["type"]="function",
3627 },
3628 ["getcount"]={
3629 ["arguments"]={
3630 {
3631 ["name"]="n",
3632 ["optional"]=false,
3633 ["type"]="number",
3634 },
3635 },
3636 ["returnvalues"]={
3637 {
3638 ["name"]="s",
3639 ["optional"]=false,
3640 ["type"]="number",
3641 },
3642 },
3643 ["shortdesc"]="Get a count register. Also accepts a predefined csname string.",
3644 ["type"]="function",
3645 },
3646 ["getdimen"]={
3647 ["arguments"]={
3648 {
3649 ["name"]="n",
3650 ["optional"]=false,
3651 ["type"]="number",
3652 },
3653 },
3654 ["returnvalues"]={
3655 {
3656 ["name"]="s",
3657 ["optional"]=false,
3658 ["type"]="number",
3659 },
3660 },
3661 ["shortdesc"]="Get a dimen register. Also accepts a predefined csname string.",
3662 ["type"]="function",
3663 },
3664 ["getmath"]={
3665 ["arguments"]={
3666 {
3667 ["name"]="n",
3668 ["optional"]=false,
3669 ["type"]="string",
3670 },
3671 {
3672 ["name"]="t",
3673 ["optional"]=false,
3674 ["type"]="string",
3675 },
3676 },
3677 ["returnvalues"]={
3678 {
3679 ["name"]="n",
3680 ["optional"]=false,
3681 ["type"]="number",
3682 },
3683 },
3684 ["shortdesc"]="Get an internal math parameter. The first string is like the csname but without the \\type{Umath} prefix, the second string is a style name minus the \\type{style} suffix.",
3685 ["type"]="function",
3686 },
3687 ["getskip"]={
3688 ["arguments"]={
3689 {
3690 ["name"]="n",
3691 ["optional"]=false,
3692 ["type"]="number",
3693 },
3694 },
3695 ["returnvalues"]={
3696 {
3697 ["name"]="s",
3698 ["optional"]=false,
3699 ["type"]="node",
3700 },
3701 },
3702 ["shortdesc"]="Get a skip register. Also accepts a predefined csname string.",
3703 ["type"]="function",
3704 },
3705 ["gettoks"]={
3706 ["arguments"]={
3707 {
3708 ["name"]="n",
3709 ["optional"]=false,
3710 ["type"]="number",
3711 },
3712 },
3713 ["returnvalues"]={
3714 {
3715 ["name"]="s",
3716 ["optional"]=false,
3717 ["type"]="string",
3718 },
3719 },
3720 ["shortdesc"]="Get a toks register. Also accepts a predefined csname string.",
3721 ["type"]="function",
3722 },
3723
3724
3725 ["getlccode"]={
3726 ["arguments"]={
3727 {
3728 ["name"]="n",
3729 ["optional"]=false,
3730 ["type"]="number",
3731 },
3732 },
3733 ["returnvalues"]={
3734 {
3735 ["name"]="s",
3736 ["optional"]=false,
3737 ["type"]="number",
3738 },
3739 },
3740 ["shortdesc"]="Get a lowercase code.",
3741 ["type"]="function",
3742 },
3743
3744 ["setlccode"]={
3745 ["arguments"]={
3746 {
3747 ["name"]="global",
3748 ["optional"]=true,
3749 ["type"]="string",
3750 },
3751 {
3752 ["name"]="n",
3753 ["optional"]=false,
3754 ["type"]="number",
3755 },
3756 {
3757 ["name"]="lc",
3758 ["optional"]=false,
3759 ["type"]="number",
3760 },
3761 {
3762 ["name"]="uc",
3763 ["optional"]=true,
3764 ["type"]="number",
3765 },
3766 },
3767 ["returnvalues"]={},
3768 ["shortdesc"]="Set a lowercase code.",
3769 ["type"]="function",
3770 },
3771
3772 ["getuccode"]={
3773 ["arguments"]={
3774 {
3775 ["name"]="n",
3776 ["optional"]=false,
3777 ["type"]="number",
3778 },
3779 },
3780 ["returnvalues"]={
3781 {
3782 ["name"]="s",
3783 ["optional"]=false,
3784 ["type"]="number",
3785 },
3786 },
3787 ["shortdesc"]="Get an uppercase code.",
3788 ["type"]="function",
3789 },
3790 ["setuccode"]={
3791 ["arguments"]={
3792 {
3793 ["name"]="global",
3794 ["optional"]=true,
3795 ["type"]="string",
3796 },
3797 {
3798 ["name"]="n",
3799 ["optional"]=false,
3800 ["type"]="number",
3801 },
3802 {
3803 ["name"]="uc",
3804 ["optional"]=false,
3805 ["type"]="number",
3806 },
3807 {
3808 ["name"]="lc",
3809 ["optional"]=true,
3810 ["type"]="number",
3811 },
3812 },
3813 ["returnvalues"]={},
3814 ["shortdesc"]="Set an uppercase code.",
3815 ["type"]="function",
3816 },
3817 ["getsfcode"]={
3818 ["arguments"]={
3819 {
3820 ["name"]="n",
3821 ["optional"]=false,
3822 ["type"]="number",
3823 },
3824 },
3825 ["returnvalues"]={
3826 {
3827 ["name"]="s",
3828 ["optional"]=false,
3829 ["type"]="number",
3830 },
3831 },
3832 ["shortdesc"]="Get a space factor.",
3833 ["type"]="function",
3834 },
3835 ["setsfcode"]={
3836 ["arguments"]={
3837 {
3838 ["name"]="global",
3839 ["optional"]=true,
3840 ["type"]="string",
3841 },
3842 {
3843 ["name"]="n",
3844 ["optional"]=false,
3845 ["type"]="number",
3846 },
3847 {
3848 ["name"]="sf",
3849 ["optional"]=false,
3850 ["type"]="number",
3851 },
3852 },
3853 ["returnvalues"]={},
3854 ["shortdesc"]="Set a space factor.",
3855 ["type"]="function",
3856 },
3857
3858 ["getcatcode"]={
3859 ["arguments"]={
3860 {
3861 ["name"]="cattable",
3862 ["optional"]=true,
3863 ["type"]="number",
3864 },
3865 {
3866 ["name"]="n",
3867 ["optional"]=false,
3868 ["type"]="number",
3869 },
3870 },
3871 ["returnvalues"]={
3872 {
3873 ["name"]="c",
3874 ["optional"]=false,
3875 ["type"]="number",
3876 },
3877 },
3878 ["shortdesc"]="Get a category code.",
3879 ["type"]="function",
3880 },
3881
3882 ["setcatcode"]={
3883 ["arguments"]={
3884 {
3885 ["name"]="global",
3886 ["optional"]=true,
3887 ["type"]="string",
3888 },
3889 {
3890 ["name"]="cattable",
3891 ["optional"]=true,
3892 ["type"]="number",
3893 },
3894 {
3895 ["name"]="n",
3896 ["optional"]=false,
3897 ["type"]="number",
3898 },
3899 {
3900 ["name"]="c",
3901 ["optional"]=false,
3902 ["type"]="number",
3903 },
3904 },
3905 ["returnvalues"]={},
3906 ["shortdesc"]="Set a category code.",
3907 ["type"]="function",
3908 },
3909
3910 ["getmathcode"]={
3911 ["arguments"]={
3912 {
3913 ["name"]="n",
3914 ["optional"]=false,
3915 ["type"]="number",
3916 },
3917 },
3918 ["returnvalues"]={
3919 {
3920 ["name"]="s",
3921 ["optional"]=false,
3922 ["type"]="table",
3923 },
3924 },
3925 ["shortdesc"]="Get a math code.",
3926 ["type"]="function",
3927 },
3928
3929 ["setmathcode"]={
3930 ["arguments"]={
3931 {
3932 ["name"]="global",
3933 ["optional"]=true,
3934 ["type"]="string",
3935 },
3936 {
3937 ["name"]="n",
3938 ["optional"]=false,
3939 ["type"]="number",
3940 },
3941 {
3942 ["name"]="mval",
3943 ["optional"]=false,
3944 ["type"]="table",
3945 },
3946 },
3947 ["returnvalues"]={},
3948 ["shortdesc"]="Set a math code.",
3949 ["type"]="function",
3950 },
3951
3952 ["getdelcode"]={
3953 ["arguments"]={
3954 {
3955 ["name"]="n",
3956 ["optional"]=false,
3957 ["type"]="number",
3958 },
3959 },
3960 ["returnvalues"]={
3961 {
3962 ["name"]="s",
3963 ["optional"]=false,
3964 ["type"]="table",
3965 },
3966 },
3967 ["shortdesc"]="Get a delimiter code.",
3968 ["type"]="function",
3969 },
3970
3971 ["setdelcode"]={
3972 ["arguments"]={
3973 {
3974 ["name"]="global",
3975 ["optional"]=true,
3976 ["type"]="string",
3977 },
3978 {
3979 ["name"]="n",
3980 ["optional"]=false,
3981 ["type"]="number",
3982 },
3983 {
3984 ["name"]="mval",
3985 ["optional"]=false,
3986 ["type"]="table",
3987 },
3988 },
3989 ["returnvalues"]={},
3990 ["shortdesc"]="Set a delimiter code.",
3991 ["type"]="function",
3992 },
3993
3994
3995
3996 ["linebreak"]={
3997 ["arguments"]={
3998 {
3999 ["name"]="listhead",
4000 ["optional"]=false,
4001 ["type"]="node",
4002 },
4003 {
4004 ["name"]="parameters",
4005 ["optional"]=false,
4006 ["type"]="table",
4007 },
4008 },
4009 ["returnvalues"]={},
4010 ["shortdesc"]="Run the line breaker on a node list. The table lists settings.",
4011 ["type"]="function",
4012 },
4013 ["primitives"]={
4014 ["arguments"]={},
4015 ["returnvalues"]={
4016 {
4017 ["name"]="t",
4018 ["optional"]=false,
4019 ["type"]="table",
4020 },
4021 },
4022 ["shortdesc"]="Returns a table of all currently active primitives, with their meaning.",
4023 ["type"]="function",
4024 },
4025 ["print"]={
4026 ["arguments"]={
4027 {
4028 ["name"]="n",
4029 ["optional"]=true,
4030 ["type"]="number",
4031 },
4032 {
4033 ["name"]="s1",
4034 ["optional"]=false,
4035 ["type"]="string",
4036 },
4037 {
4038 ["name"]="s2",
4039 ["optional"]=true,
4040 ["type"]="string",
4041 },
4042 },
4043 ["returnvalues"]={},
4044 ["shortdesc"]=" Print a sequence of strings (not just two) as lines. The optional argument is a catcode table id.",
4045 ["type"]="function",
4046 },
4047 ["round"]={
4048 ["arguments"]={
4049 {
4050 ["name"]="o",
4051 ["optional"]=false,
4052 ["type"]="number",
4053 },
4054 },
4055 ["returnvalues"]={
4056 {
4057 ["name"]="n",
4058 ["optional"]=false,
4059 ["type"]="number",
4060 },
4061 },
4062 ["shortdesc"]="Round a number.",
4063 ["type"]="function",
4064 },
4065 ["scale"]={
4066 ["arguments"]={
4067 {
4068 ["name"]="o",
4069 ["optional"]=false,
4070 ["type"]="number",
4071 },
4072 {
4073 ["name"]="delta",
4074 ["optional"]=false,
4075 ["type"]="number",
4076 },
4077 },
4078 ["returnvalues"]={
4079 {
4080 ["name"]="n",
4081 ["optional"]=false,
4082 ["type"]="number",
4083 },
4084 },
4085 ["shortdesc"]="Multiplies the first number (or all fields in a table) with the second argument (if the first argument is a table, so is the return value).",
4086 ["type"]="function",
4087 },
4088 ["set"]={
4089 ["arguments"]={
4090 {
4091 ["name"]="global",
4092 ["optional"]=true,
4093 ["type"]="string",
4094 },
4095 {
4096 ["name"]="n",
4097 ["optional"]=false,
4098 ["type"]="string",
4099 },
4100 {
4101 ["name"]="v",
4102 ["optional"]=false,
4103 ["type"]="value",
4104 },
4105 },
4106 ["returnvalues"]={},
4107 ["shortdesc"]="Set a named internal register. Also accepts a predefined csname string.",
4108 ["type"]="function",
4109 },
4110 ["setattribute"]={
4111 ["arguments"]={
4112 {
4113 ["name"]="global",
4114 ["optional"]=true,
4115 ["type"]="string",
4116 },
4117 {
4118 ["name"]="n",
4119 ["optional"]=false,
4120 ["type"]="number",
4121 },
4122 {
4123 ["name"]="s",
4124 ["optional"]=false,
4125 ["type"]="number",
4126 },
4127 },
4128 ["returnvalues"]={},
4129 ["shortdesc"]="Set an attribute register. Also accepts a predefined csname string.",
4130 ["type"]="function",
4131 },
4132 ["setbox"]={
4133 ["arguments"]={
4134 {
4135 ["name"]="global",
4136 ["optional"]=true,
4137 ["type"]="string",
4138 },
4139 {
4140 ["name"]="n",
4141 ["optional"]=false,
4142 ["type"]="number",
4143 },
4144 {
4145 ["name"]="s",
4146 ["optional"]=false,
4147 ["type"]="node",
4148 },
4149 },
4150 ["returnvalues"]={},
4151 ["shortdesc"]="Set a box register. Also accepts a predefined csname string.",
4152 ["type"]="function",
4153 },
4154 ["setcount"]={
4155 ["arguments"]={
4156 {
4157 ["name"]="global",
4158 ["optional"]=true,
4159 ["type"]="string",
4160 },
4161 {
4162 ["name"]="n",
4163 ["optional"]=false,
4164 ["type"]="number",
4165 },
4166 {
4167 ["name"]="s",
4168 ["optional"]=false,
4169 ["type"]="number",
4170 },
4171 },
4172 ["returnvalues"]={},
4173 ["shortdesc"]="Set a count register. Also accepts a predefined csname string.",
4174 ["type"]="function",
4175 },
4176 ["setdimen"]={
4177 ["arguments"]={
4178 {
4179 ["name"]="global",
4180 ["optional"]=true,
4181 ["type"]="string",
4182 },
4183 {
4184 ["name"]="n",
4185 ["optional"]=false,
4186 ["type"]="number",
4187 },
4188 {
4189 ["name"]="s",
4190 ["optional"]=false,
4191 ["type"]="number",
4192 },
4193 },
4194 ["returnvalues"]={},
4195 ["shortdesc"]="Set a dimen register. Also accepts a predefined csname string.",
4196 ["type"]="function",
4197 },
4198 ["setmath"]={
4199 ["arguments"]={
4200 {
4201 ["name"]="global",
4202 ["optional"]=true,
4203 ["type"]="string",
4204 },
4205 {
4206 ["name"]="n",
4207 ["optional"]=false,
4208 ["type"]="string",
4209 },
4210 {
4211 ["name"]="t",
4212 ["optional"]=false,
4213 ["type"]="string",
4214 },
4215 {
4216 ["name"]="n",
4217 ["optional"]=false,
4218 ["type"]="number",
4219 },
4220 },
4221 ["returnvalues"]={},
4222 ["shortdesc"]="Set an internal math parameter. The first string is like the csname but without the \\type{Umath} prefix, the second string is a style name minus the \\type{style} suffix.",
4223 ["type"]="function",
4224 },
4225 ["setskip"]={
4226 ["arguments"]={
4227 {
4228 ["name"]="global",
4229 ["optional"]=true,
4230 ["type"]="string",
4231 },
4232 {
4233 ["name"]="n",
4234 ["optional"]=false,
4235 ["type"]="number",
4236 },
4237 {
4238 ["name"]="s",
4239 ["optional"]=false,
4240 ["type"]="node",
4241 },
4242 },
4243 ["returnvalues"]={},
4244 ["shortdesc"]="Set a skip register. Also accepts a predefined csname string.",
4245 ["type"]="function",
4246 },
4247 ["settoks"]={
4248 ["arguments"]={
4249 {
4250 ["name"]="global",
4251 ["optional"]=true,
4252 ["type"]="string",
4253 },
4254 {
4255 ["name"]="n",
4256 ["optional"]=false,
4257 ["type"]="number",
4258 },
4259 {
4260 ["name"]="s",
4261 ["optional"]=false,
4262 ["type"]="string",
4263 },
4264 },
4265 ["returnvalues"]={},
4266 ["shortdesc"]="Set a toks register. Also accepts a predefined csname string.",
4267 ["type"]="function",
4268 },
4269 ["shipout"]={
4270 ["arguments"]={
4271 {
4272 ["name"]="n",
4273 ["optional"]=false,
4274 ["type"]="number",
4275 },
4276 },
4277 ["returnvalues"]={},
4278 ["shortdesc"]="Ships the box to the output file and clears the box.",
4279 ["type"]="function",
4280 },
4281 ["sp"]={
4282 ["arguments"]={
4283 {
4284 ["name"]="s",
4285 ["optional"]=false,
4286 ["type"]="string",
4287 },
4288 },
4289 ["returnvalues"]={
4290 {
4291 ["name"]="n",
4292 ["optional"]=false,
4293 ["type"]="number",
4294 },
4295 },
4296 ["shortdesc"]="Convert a dimension string to scaled points.",
4297 ["type"]="function",
4298 },
4299 ["sprint"]={
4300 ["arguments"]={
4301 {
4302 ["name"]="n",
4303 ["optional"]=true,
4304 ["type"]="number",
4305 },
4306 {
4307 ["name"]="s1",
4308 ["optional"]=false,
4309 ["type"]="string",
4310 },
4311 {
4312 ["name"]="s2",
4313 ["optional"]=true,
4314 ["type"]="string",
4315 },
4316 },
4317 ["returnvalues"]={},
4318 ["shortdesc"]=" Print a sequence of strings (not just two) as partial lines. The optional argument is a catcode table id.",
4319 ["type"]="function",
4320 },
4321 ["tprint"]={
4322 ["arguments"]={
4323 {
4324 ["name"]="a1",
4325 ["optional"]=false,
4326 ["type"]="table",
4327 },
4328 {
4329 ["name"]="a2",
4330 ["optional"]=true,
4331 ["type"]="table",
4332 },
4333 },
4334 ["returnvalues"]={},
4335 ["shortdesc"]="Combine any number of \\type{tex.sprint}'s into a single function call.",
4336 ["type"]="function",
4337 },
4338 ["write"]={
4339 ["arguments"]={
4340 {
4341 ["name"]="s",
4342 ["optional"]=false,
4343 ["type"]="string",
4344 },
4345 },
4346 ["returnvalues"]={},
4347 ["shortdesc"]=" Print a sequence of strings (not just two) as detokenized data.",
4348 ["type"]="function",
4349 },
4350 },
4351 ["methods"]={
4352 },
4353 },
4354 ["texio"]={
4355 ["functions"]={
4356 ["write"]={
4357 ["arguments"]={
4358 {
4359 ["name"]="target",
4360 ["optional"]=true,
4361 ["type"]="string",
4362 },
4363 {
4364 ["name"]="s",
4365 ["optional"]=false,
4366 ["type"]="string",
4367 },
4368 },
4369 ["returnvalues"]={},
4370 ["shortdesc"]="Write a string to the log and/or terminal. The optional argument is\
4371 \\aliteral{{term}}, \\aliteral{{term and log}}, or \\aliteral{{log}}.",
4372 ["type"]="function",
4373 },
4374 ["write_nl"]={
4375 ["arguments"]={
4376 {
4377 ["name"]="target",
4378 ["optional"]=true,
4379 ["type"]="string",
4380 },
4381 {
4382 ["name"]="s",
4383 ["optional"]=false,
4384 ["type"]="string",
4385 },
4386 },
4387 ["returnvalues"]={},
4388 ["shortdesc"]="Write a string to the log and/or terminal, starting on a new line. \
4389 The optional argument is \
4390 \\aliteral{{term}}, \\aliteral{{term and log}}, or \\aliteral{{log}}.",
4391 ["type"]="function",
4392 },
4393 },
4394 ["methods"]={
4395 },
4396 },
4397 ["token"]={
4398 ["functions"]={
4399 ["command_id"]={
4400 ["arguments"]={
4401 {
4402 ["name"]="commandname",
4403 ["optional"]=false,
4404 ["type"]="string",
4405 },
4406 },
4407 ["returnvalues"]={
4408 {
4409 ["name"]="i",
4410 ["optional"]=false,
4411 ["type"]="number",
4412 },
4413 },
4414 ["shortdesc"]="Return the internal number representing a command code.",
4415 ["type"]="function",
4416 },
4417 ["command_name"]={
4418 ["arguments"]={
4419 {
4420 ["name"]="t",
4421 ["optional"]=false,
4422 ["type"]="token",
4423 },
4424 },
4425 ["returnvalues"]={
4426 {
4427 ["name"]="commandname",
4428 ["optional"]=false,
4429 ["type"]="string",
4430 },
4431 },
4432 ["shortdesc"]="Return the internal string representing a command code.",
4433 ["type"]="function",
4434 },
4435 ["create"]={
4436 ["arguments"]={
4437 {
4438 ["name"]="char",
4439 ["optional"]=false,
4440 ["type"]="number",
4441 },
4442 {
4443 ["name"]="catcode",
4444 ["optional"]=true,
4445 ["type"]="number",
4446 },
4447 },
4448 ["returnvalues"]={
4449 {
4450 ["name"]="t",
4451 ["optional"]=false,
4452 ["type"]="token",
4453 },
4454 },
4455 ["shortdesc"]="Create a token from scratch, the optional argument is a category code. Also accepts strings, in which case a token matching that csname is created.",
4456 ["type"]="function",
4457 },
4458 ["csname_id"]={
4459 ["arguments"]={
4460 {
4461 ["name"]="csname",
4462 ["optional"]=false,
4463 ["type"]="string",
4464 },
4465 },
4466 ["returnvalues"]={
4467 {
4468 ["name"]="i",
4469 ["optional"]=false,
4470 ["type"]="number",
4471 },
4472 },
4473 ["shortdesc"]="Returns the value for a csname string.",
4474 ["type"]="function",
4475 },
4476 ["csname_name"]={
4477 ["arguments"]={
4478 {
4479 ["name"]="t",
4480 ["optional"]=false,
4481 ["type"]="token",
4482 },
4483 },
4484 ["returnvalues"]={
4485 {
4486 ["name"]="csname",
4487 ["optional"]=false,
4488 ["type"]="string",
4489 },
4490 },
4491 ["shortdesc"]="Return the csname associated with a token.",
4492 ["type"]="function",
4493 },
4494 ["expand"]={
4495 ["arguments"]={},
4496 ["returnvalues"]={},
4497 ["shortdesc"]="Expand a token the tokenb waiting in the input stream.",
4498 ["type"]="function",
4499 },
4500 ["get_next"]={
4501 ["arguments"]={},
4502 ["returnvalues"]={
4503 {
4504 ["name"]="t",
4505 ["optional"]=false,
4506 ["type"]="token",
4507 },
4508 },
4509 ["shortdesc"]="Fetch the next token from the input stream.",
4510 ["type"]="function",
4511 },
4512 ["is_activechar"]={
4513 ["arguments"]={
4514 {
4515 ["name"]="t",
4516 ["optional"]=false,
4517 ["type"]="token",
4518 },
4519 },
4520 ["returnvalues"]={
4521 {
4522 ["name"]="b",
4523 ["optional"]=false,
4524 ["type"]="boolean",
4525 },
4526 },
4527 ["shortdesc"]="True if the token represents and active character.",
4528 ["type"]="function",
4529 },
4530 ["is_expandable"]={
4531 ["arguments"]={
4532 {
4533 ["name"]="t",
4534 ["optional"]=false,
4535 ["type"]="token",
4536 },
4537 },
4538 ["returnvalues"]={
4539 {
4540 ["name"]="b",
4541 ["optional"]=false,
4542 ["type"]="boolean",
4543 },
4544 },
4545 ["shortdesc"]="True if the token is expandable.",
4546 ["type"]="function",
4547 },
4548 },
4549 ["methods"]={
4550 },
4551 },
4552 }
4553
4554 return fdata;
LuaTeX git mirror