- dev-luatex - NTG Mailing Lists

Extended the documentation of some functions in the os.* namespace (J. Friedrich)
by Josef Friedrich 24 Apr '23

24 Apr '23

The following patch adds a short description of the os.sleep() function which is undocumented to the manual. The C source code of the os.sleep() function can be found here: https://gitlab.lisn.upsaclay.fr/texlive/luatex/-/blob/master/source/texk/we… In addition, the patch documents the optional argument template of the os.tmpdir([template]) function: https://gitlab.lisn.upsaclay.fr/texlive/luatex/-/blob/master/source/texk/we… The patch also fixes a few whitespace issues. See attached patch file. diff --git a/manual/luatex-lua.tex b/manual/luatex-lua.tex index 94dead9e1..01b39d832 100644 --- a/manual/luatex-lua.tex +++ b/manual/luatex-lua.tex @@ -434,8 +434,9 @@ used as building blocks for other helpers. The \type {os} library has a few extra functions and variables: \libidx {os} {selfdir}, \libidx {os} {exec}, \libidx {os} {spawn}, \libidx {os} {setenv}, -\libidx {os} {env}, \libidx {os} {gettimeofday}, \libidx {os} {times}, \libidx -{os} {tmpdir}, \libidx {os} {type}, \libidx {os} {name} and \libidx {os} {uname}, +\libidx {os} {env}, \libidx {os} {gettimeofday}, \libidx {os} {times}, +\libidx {os} {sleep}, \libidx {os} {tmpdir}, \libidx {os} {type}, +\libidx {os} {name} and \libidx {os} {uname}, that we will discuss here. \startitemize @@ -522,19 +523,29 @@ that we will discuss here. \stopitem \startitem - \type {os.times()}returns the current process times according to \ the + \type {os.times()} returns the current process times according to the \UNIX\ C library function \quote {times}. This function is not available on the \MSWINDOWS\ and \SUNOS\ platforms, so do not use this function for portable documents. \stopitem \startitem - \type {os.tmpdir()} creates a directory in the \quote {current directory} + \type {os.sleep(interval[, unit])} suspends the execution of the current run for + a given number of seconds. If the optional argument \type {unit} is present, the + function waits \type {interval / units} seconds. \type {os.sleep(1, 1000)} + for example pauses the program for one millisecond. +\stopitem + +\startitem + \type {os.tmpdir([template])} creates a directory in the \quote {current directory} with the name \type {luatex.XXXXXX} where the \type {X}-es are replaced by a unique string. The function also returns this string, so you can \type {lfs.chdir()} into it, or \type {nil} if it failed to create the directory. The user is responsible for cleaning up at the end of the run, it does not - happen automatically. + happen automatically. You can also use your own \type {template} for the name + of the temporary folder. However, the passed string must end with six capital + \type {X}-es. For example, the template \type {tmp.XXXXXX} could result in the + folder name \type {tmp.vX3gPo}. \stopitem \startitem

2 2

Update the functions overview table of the two namespaces node.* and node.direct.*
by Josef Friedrich 19 Apr '23

19 Apr '23

Add this missing functions: - fix_node_lists - flush_properties_table - get_properties_table - getexpansion - hyphenating - make_extensible - set_properties_mode - setdata - traverse_list - values Put this functions into the right alphabetical sorting order: - setexpansion - getdata according to https://gitlab.lisn.upsaclay.fr/texlive/luatex/-/blob/master/source/texk/we… See patch file diff --git a/manual/luatex-nodes.tex b/manual/luatex-nodes.tex index 347987d41..a57ed98b2 100644 --- a/manual/luatex-nodes.tex +++ b/manual/luatex-nodes.tex @@ -2334,21 +2334,26 @@ consistency. You can of course always define additional accessors using \type \supported {fields} \yes \nop \supported {find_attribute} \yes \yes \supported {first_glyph} \yes \yes +\supported {fix_node_lists} \yes \nop \supported {flatten_discretionaries} \yes \yes \supported {flush_list} \yes \yes \supported {flush_node} \yes \yes +\supported {flush_properties_table} \yes \yes \supported {free} \yes \yes \supported {get_attribute} \yes \yes +\supported {get_properties_table} \yes \yes \supported {get_synctex_fields} \nop \yes \supported {getattributelist} \nop \yes \supported {getboth} \yes \yes \supported {getbox} \nop \yes \supported {getchar} \yes \yes \supported {getcomponents} \nop \yes +\supported {getdata} \nop \yes \supported {getdepth} \nop \yes \supported {getdirection} \nop \yes \supported {getdir} \nop \yes \supported {getdisc} \yes \yes +\supported {getexpansion} \nop \yes \supported {getfam} \nop \yes \supported {getfield} \yes \yes \supported {getfont} \yes \yes @@ -2369,13 +2374,13 @@ consistency. You can of course always define additional accessors using \type \supported {getsubtype} \yes \yes \supported {getsub} \nop \yes \supported {getsup} \nop \yes -\supported {getdata} \nop \yes \supported {getwhd} \yes \yes \supported {getwidth} \nop \yes \supported {has_attribute} \yes \yes \supported {has_field} \yes \yes \supported {has_glyph} \yes \yes \supported {hpack} \yes \yes +\supported {hyphenating} \nop \yes \supported {id} \yes \nop \supported {insert_after} \yes \yes \supported {insert_before} \yes \yes @@ -2388,6 +2393,7 @@ consistency. You can of course always define additional accessors using \type \supported {last_node} \yes \yes \supported {length} \yes \yes \supported {ligaturing} \yes \yes +\supported {make_extensible} \yes \nop \supported {mlist_to_hlist} \yes \nop \supported {new} \yes \yes \supported {next} \yes \nop @@ -2399,20 +2405,22 @@ consistency. You can of course always define additional accessors using \type \supported {rangedimensions} \yes \yes \supported {remove} \yes \yes \supported {set_attribute} \yes \yes +\supported {set_properties_mode} \yes \yes \supported {set_synctex_fields} \nop \yes \supported {setattributelist} \nop \yes \supported {setboth} \nop \yes \supported {setbox} \nop \yes \supported {setchar} \nop \yes \supported {setcomponents} \nop \yes +\supported {setdata} \nop \yes \supported {setdepth} \nop \yes \supported {setdirection} \nop \yes \supported {setdir} \nop \yes \supported {setdisc} \nop \yes +\supported {setexpansion} \nop \yes \supported {setfam} \nop \yes \supported {setfield} \yes \yes \supported {setfont} \nop \yes -\supported {setexpansion} \nop \yes \supported {setglue} \yes \yes \supported {setheight} \nop \yes \supported {setkern} \nop \yes @@ -2443,6 +2451,7 @@ consistency. You can of course always define additional accessors using \type \supported {traverse_char} \yes \yes \supported {traverse_glyph} \yes \yes \supported {traverse_id} \yes \yes +\supported {traverse_list} \nop \yes \supported {traverse} \yes \yes \supported {types} \yes \nop \supported {type} \yes \nop @@ -2451,6 +2460,7 @@ consistency. You can of course always define additional accessors using \type \supported {unset_attribute} \yes \yes \supported {usedlist} \yes \yes \supported {uses_font} \yes \yes +\supported {values} \yes \nop \supported {vpack} \yes \yes \supported {whatsits} \yes \nop \supported {write} \yes \yes

2 1

lua.setluaname(n, s) and lua.getluaname(n): Mismatch between documentation and implementation
by Josef Friedrich 18 Apr '23

18 Apr '23

The documentation and the implementation of the two functions lua.setluaname and lua.getluaname do not match. Minimal working example (MWE): % lua.setluaname(42, '@filename') not working \directlua{ lua.setluaname(nil, 42, '@filename') } \directlua 42 {xxx} \bye This is how the parameters should be arranged in the set function: lua.setluaname(<number> n, <string> s) <string> s = lua.getluaname(<number> n) # Patch: diff --git a/manual/luatex-tex.tex b/manual/luatex-tex.tex index f8c3d5ac6..e953a1802 100644 --- a/manual/luatex-tex.tex +++ b/manual/luatex-tex.tex @@ -96,7 +96,7 @@ If you want to unset a \LUA\ name, you can assign \type {nil} to it. The functio accessors are: \startfunctioncall -lua.setluaname(<string> s,<number> n]) +lua.setluaname(<number> n, <string> s) <string> s = lua.getluaname(<number> n) \stopfunctioncall @@ -2747,7 +2747,6 @@ The options match commandline arguments from \type {kpsewhich}: If \type {--output-directory} is specified and the value is a relative pathname, the file is searched first here and then in the standard tree. - \stopsubsection \startsubsection[title={\type {init_prog}}] diff --git a/source/texk/web2c/luatexdir/lua/llualib.c b/source/texk/web2c/luatexdir/lua/llualib.c index 0586aba02..d91a9a729 100644 --- a/source/texk/web2c/luatexdir/lua/llualib.c +++ b/source/texk/web2c/luatexdir/lua/llualib.c @@ -319,8 +319,8 @@ static int set_luaname(lua_State * L) { int k; const char *s; - if (lua_gettop(L) == 3) { - k = (int) luaL_checkinteger(L, 2); + if (lua_gettop(L) == 2) { + k = (int) luaL_checkinteger(L, 1); if (k > 65535 || k < 0) { /* error */ } else { @@ -328,8 +328,8 @@ static int set_luaname(lua_State * L) free(luanames[k]); luanames[k] = NULL; } - if (lua_type(L,3) == LUA_TSTRING) { - s = lua_tostring(L, 3); + if (lua_type(L, 2) == LUA_TSTRING) { + s = lua_tostring(L, 2); if (s != NULL) luanames[k] = xstrdup(s); } @@ -340,7 +340,7 @@ static int set_luaname(lua_State * L) static int get_luaname(lua_State * L) { - int k = (int) luaL_checkinteger(L, 2); + int k = (int) luaL_checkinteger(L, 1); if (k > 65535 || k < 0) { /* error */ lua_pushnil(L);

2 2

Patches for luatex
by luigi scarso 18 Apr '23

18 Apr '23

First of all, thank you all for the past, present and future patches. I would ask you to send me the attached patches, because copying and pasting from email text is not robust -- sometimes I, sometimes you copy badly. A single file with patches is fine. I take as a reference https://gitlab.lisn.upsaclay.fr/texlive/luatex texlive may be a little further behind. -- luigi

1 0

Fix wrong data type of the field `table_version` in manual/luatex-fontloader.tex
by Josef Friedrich 15 Apr '23

15 Apr '23

See https://github.com/TeX-Live/luatex/blob/f52b099f3e01d53dc03b315e1909245c3d5… diff --git a/manual/luatex-fontloader.tex b/manual/luatex-fontloader.tex index 1e12b61f1..055228bcd 100644 --- a/manual/luatex-fontloader.tex +++ b/manual/luatex-fontloader.tex @@ -306,7 +306,7 @@ the documentation are not yet finished): \starttabulate[|l|l|p|] \DB key \BC type \NC explanation \NC \NR \TB -\NC \type{table_version} \NC number \NC indicates the metrics version (currently~0.3)\NC \NR +\NC \type{table_version} \NC string \NC indicates the metrics version (currently~0.3)\NC \NR \NC \type{fontname} \NC string \NC \POSTSCRIPT\ font name\NC \NR \NC \type{fullname} \NC string \NC official (human-oriented) font name\NC \NR \NC \type{familyname} \NC string \NC family name\NC \NR

2 1

Fix typo in source/texk/web2c/luatexdir/tex/texnodes.c
by Josef Friedrich 14 Apr '23

14 Apr '23

diff --git a/source/texk/web2c/luatexdir/tex/texnodes.c b/source/texk/web2c/luatexdir/tex/texnodes.c index 6e0ae1ff8..72f6716dd 100644 --- a/source/texk/web2c/luatexdir/tex/texnodes.c +++ b/source/texk/web2c/luatexdir/tex/texnodes.c @@ -1203,7 +1203,7 @@ void l_set_whatsit_data(void) { the original one as a metatable. After some experiments (that also included timing) with these scenarios I decided that a deep copy made no sense, nor did nilling. In the end both the shallow copy and the metatable variant were - both ok, although the second ons is slower. The most important aspect to keep + both ok, although the second one is slower. The most important aspect to keep in mind is that references to other nodes in properties no longer can be valid for that copy. We could use two tables (one unique and one shared) or metatables but that only complicates matters.

2 1

Fix documentation for function `prepend_prevdepth` in node.* and node.direct.*
by Josef Friedrich 14 Apr '23

14 Apr '23

The function `prepend_prevdepth` is available in both namespaces, both node.* and node.direct.*. node.*: https://gitlab.lisn.upsaclay.fr/texlive/luatex/-/blob/master/source/texk/we… node.direct.*: https://gitlab.lisn.upsaclay.fr/texlive/luatex/-/blob/master/source/texk/we… diff --git a/manual/luatex-nodes.tex b/manual/luatex-nodes.tex index 9b72fdf2c..347987d41 100644 --- a/manual/luatex-nodes.tex +++ b/manual/luatex-nodes.tex @@ -2391,7 +2391,7 @@ consistency. You can of course always define additional accessors using \type \supported {mlist_to_hlist} \yes \nop \supported {new} \yes \yes \supported {next} \yes \nop -\supported {prepend_prevdepth} \nop \yes +\supported {prepend_prevdepth} \yes \yes \supported {prev} \yes \nop \supported {protect_glyphs} \yes \yes \supported {protect_glyph} \yes \yes

2 1

A possible bug in mixed directional typesetting
by Udicoudco 11 Apr '23

11 Apr '23

Hello all, Attached a file with what I believe to be a wrong output. Strangely, if I do one of the following steps, the last "ab" returns to the correct ocation (currently the last ab is at the left hand side bottom corner): * if I remove one of the "unnecessary" \textdir TLT * if I remove the grouping around \textdir TRT * if I add another group around {ab\texdir TRT ab}\textdir TLT I can reproduce this result on both miktex and texlive with LaTeX 1.16.0. Is this a bug? or am I somehow misusing the \textdir primitive? Regards, Udi

2 3

Correction of a typo in the manual
by Josef Friedrich 10 Apr '23

10 Apr '23

diff --git a/manual/luatex-languages.tex b/manual/luatex-languages.tex index 573727a66..9ca27a095 100644 --- a/manual/luatex-languages.tex +++ b/manual/luatex-languages.tex @@ -140,7 +140,7 @@ hyphenation happens is (normally) when the paragraph or a horizontal box is constructed. When \prm {savinghyphcodes} was zero when the language got initialized you start out with nothing, otherwise you already have a set. -When a \lpr {hjcode} is greater than 0 but less than 32 is indicates the +When a \lpr {hjcode} is greater than 0 but less than 32 it indicates the to be used length. In the following example we map a character (\type {x}) onto another one in the patterns and tell the engine that \type {œ} counts as one character. Because traditionally zero itself is reserved for inhibiting @@ -1110,4 +1110,3 @@ initialized due to \prm {savinghyphcodes} being larger than zero. % 12-34-\vrule width 1em height 1.5ex \par % 12-\hbox{34}-56 \par % 12-\vrule width 1em height 1.5ex-56 \par -

2 1

Documentation of the *_syntex_fields functions
by Josef Friedrich 08 Apr '23

08 Apr '23

The *_syntex_fields functions are located in the node.direct.* namespace, not in the node.* namespace. See source code: set_* https://gitlab.lisn.upsaclay.fr/texlive/luatex/-/blob/master/source/texk/we… get_* https://gitlab.lisn.upsaclay.fr/texlive/luatex/-/blob/master/source/texk/we… diff --git a/manual/luatex-nodes.tex b/manual/luatex-nodes.tex index 42a4aedc7..9b72fdf2c 100644 --- a/manual/luatex-nodes.tex +++ b/manual/luatex-nodes.tex @@ -2490,9 +2490,9 @@ number, for a glue, kern, hlist, vlist, rule and math nodes as well as glyph nodes (although this last one is not used in native \SYNCTEX). \startfunctioncall -node.set_synctex_fields(<integer> f, <integer> l) +node.direct.set_synctex_fields(<integer> n, <integer> f, <integer> l) <integer> f, <integer> l = - node.get_synctex_fields(<node> n) + node.direct.get_synctex_fields(<integer> n) \stopfunctioncall Of course you need to know what you're doing as no checking on sane values takes

2 1