summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/base/ltluatex.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/base/ltluatex.dtx')
-rw-r--r--Master/texmf-dist/source/latex/base/ltluatex.dtx136
1 files changed, 76 insertions, 60 deletions
diff --git a/Master/texmf-dist/source/latex/base/ltluatex.dtx b/Master/texmf-dist/source/latex/base/ltluatex.dtx
index 49e75c856cc..c8a432f08ec 100644
--- a/Master/texmf-dist/source/latex/base/ltluatex.dtx
+++ b/Master/texmf-dist/source/latex/base/ltluatex.dtx
@@ -1,6 +1,6 @@
% \iffalse meta-comment
%
-% Copyright 2015
+% Copyright 2015 2016
% The LaTeX3 Project and any individual authors listed elsewhere
% in this file.
%
@@ -24,7 +24,7 @@
\ProvidesFile{ltluatex.dtx}
%</driver>
%<*tex>
-[2015/12/18 v1.0l
+[2016/03/13 v1.0n
%</tex>
%<plain> LuaTeX support for plain TeX (core)
%<*tex>
@@ -170,7 +170,7 @@
%
% \subsection{Allocators in Lua}
%
-% \DescribeMacro{new_attribute}
+% \DescribeMacro{new\_attribute}
% |luatexbase.new_attribute(|\meta{attribute}|)|\\
% Returns an allocation number for the \meta{attribute}, indexed from~$1$.
% The attribute will be initialised with the marker value |-"7FFFFFFF|
@@ -182,18 +182,18 @@
% consistently for attributes declared in \TeX\ or Lua.
%
% \noindent
-% \DescribeMacro{new_whatsit}
+% \DescribeMacro{new\_whatsit}
% |luatexbase.new_whatsit(|\meta{whatsit}|)|\\
% Returns an allocation number for the custom \meta{whatsit}, indexed from~$1$.
%
% \noindent
-% \DescribeMacro{new_bytecode}
+% \DescribeMacro{new\_bytecode}
% |luatexbase.new_bytecode(|\meta{bytecode}|)|\\
% Returns an allocation number for a bytecode register, indexed from~$1$.
% The optional \meta{name} argument is just used for logging.
%
% \noindent
-% \DescribeMacro{new_chunkname}
+% \DescribeMacro{new\_chunkname}
% |luatexbase.new_chunkname(|\meta{chunkname}|)|\\
% Returns an allocation number for a Lua chunk name for use with
% |\directlua| and |\latelua|, indexed from~$1$.
@@ -276,7 +276,7 @@
%
% \subsection{Module utilities}
%
-% \DescribeMacro{provides_module}
+% \DescribeMacro{provides\_module}
% |luatexbase.provides_module(|\meta{info}|)|\\
% This function is used by modules to identify themselves; the |info| should be
% a table containing information about the module. The required field
@@ -286,9 +286,9 @@
% information will be recorded in the log. Other fields are ignored.
%
% \noindent
-% \DescribeMacro{module_info}
-% \DescribeMacro{module_warning}
-% \DescribeMacro{module_error}
+% \DescribeMacro{module\_info}
+% \DescribeMacro{module\_warning}
+% \DescribeMacro{module\_error}
% |luatexbase.module_info(|\meta{module}, \meta{text}|)|\\
% |luatexbase.module_warning(|\meta{module}, \meta{text}|)|\\
% |luatexbase.module_error(|\meta{module}, \meta{text}|)|\\
@@ -305,7 +305,7 @@
% \subsection{Callback management}
%
% \noindent
-% \DescribeMacro{add_to_callback}
+% \DescribeMacro{add\_to\_callback}
% |luatexbase.add_to_callback(|^^A
% \meta{callback}, \meta{function}, \meta{description}|)|
% Registers the \meta{function} into the \meta{callback} with a textual
@@ -313,20 +313,20 @@
% in the order loaded.
%
% \noindent
-% \DescribeMacro{remove_from_callback}
+% \DescribeMacro{remove\_from\_callback}
% |luatexbase.remove_from_callback(|\meta{callback}, \meta{description}|)|
% Removes the callback function with \meta{description} from the \meta{callback}.
% The removed function and its description
% are returned as the results of this function.
%
% \noindent
-% \DescribeMacro{in_callback}
+% \DescribeMacro{in\_callback}
% |luatexbase.in_callback(|\meta{callback}, \meta{description}|)|
% Checks if the \meta{description} matches one of the functions added
% to the list for the \meta{callback}, returning a boolean value.
%
% \noindent
-% \DescribeMacro{disable_callback}
+% \DescribeMacro{disable\_callback}
% |luatexbase.disable_callback(|\meta{callback}|)|
% Sets the \meta{callback} to \texttt{false} as described in the Lua\TeX{}
% manual for the underlying \texttt{callback.register} built-in. Callbacks
@@ -334,24 +334,23 @@
% no functions registered using the callback.
%
% \noindent
-% \DescribeMacro{callback_descriptions}
+% \DescribeMacro{callback\_descriptions}
% A list of the descriptions of functions registered to the specified
% callback is returned. |{}| is returned if there are no functions registered.
%
% \noindent
-% \DescribeMacro{create_callback}
+% \DescribeMacro{create\_callback}
% |luatexbase.create_callback(|\meta{name},meta{type},\meta{default}|)|
% Defines a user defined callback. The last argument is a default
% function or |false|.
%
% \noindent
-% \DescribeMacro{call_callback}
+% \DescribeMacro{call\_callback}
% |luatexbase.call_callback(|\meta{name},\ldots|)|
% Calls a user defined callback with the supplied arguments.
%
% \endgroup
%
-% \CheckSum{558}
% \StopEventually{}
%
% \section{Implementation}
@@ -860,7 +859,7 @@ local modules = modules or { }
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{provides_module}
+% \begin{macro}{provides\_module}
% \changes{v1.0a}{2015/09/24}{Function added}
% \changes{v1.0f}{2015/10/03}{use luatexbase\_log}
% Local function to write to the log.
@@ -933,11 +932,11 @@ local function msg_format(mod, msg_type, text)
end
% \end{macrocode}
%
-% \begin{macro}{module_info}
+% \begin{macro}{module\_info}
% \changes{v1.0a}{2015/09/24}{Function added}
-% \begin{macro}{module_warning}
+% \begin{macro}{module\_warning}
% \changes{v1.0a}{2015/09/24}{Function added}
-% \begin{macro}{module_error}
+% \begin{macro}{module\_error}
% \changes{v1.0a}{2015/09/24}{Function added}
% Write messages.
% \begin{macrocode}
@@ -1039,7 +1038,7 @@ luatexbase.registernumber = registernumber
%
% \subsection{Attribute allocation}
%
-% \begin{macro}{new_attribute}
+% \begin{macro}{new\_attribute}
% \changes{v1.0a}{2015/09/24}{Function added}
% As attributes are used for Lua manipulations its useful to be able
% to assign from this end.
@@ -1072,7 +1071,7 @@ luatexbase.new_attribute = new_attribute
%
% \subsection{Custom whatsit allocation}
%
-% \begin{macro}{new_whatsit}
+% \begin{macro}{new\_whatsit}
% Much the same as for attribute allocation in Lua.
% \begin{macrocode}
local function new_whatsit(name)
@@ -1091,7 +1090,7 @@ luatexbase.new_whatsit = new_whatsit
%
% \subsection{Bytecode register allocation}
%
-% \begin{macro}{new_bytecode}
+% \begin{macro}{new\_bytecode}
% Much the same as for attribute allocation in Lua.
% The optional \meta{name} argument is used in the log if given.
% \begin{macrocode}
@@ -1111,7 +1110,7 @@ luatexbase.new_bytecode = new_bytecode
%
% \subsection{Lua chunk name allocation}
%
-% \begin{macro}{new_chunkname}
+% \begin{macro}{new\_chunkname}
% As for bytecode registers but also store the name in the
% |lua.name| table.
% \begin{macrocode}
@@ -1209,39 +1208,58 @@ local callbacktypes = callbacktypes or {
read_type1_file = exclusive,
read_opentype_file = exclusive,
% \end{macrocode}
+% \changes{v1.0m}{2016/02/11}{read\_cidmap\_file added}
+% Not currently used by luatex but included for completeness.
+% may be used by a font handler.
+% \begin{macrocode}
+ find_cidmap_file = data,
+ read_cidmap_file = exclusive,
+% \end{macrocode}
% Section 4.1.3: data processing callbacks.
+% \changes{v1.0m}{2016/02/11}{token\_filter removed}
% \begin{macrocode}
process_input_buffer = data,
process_output_buffer = data,
process_jobname = data,
- token_filter = exclusive,
% \end{macrocode}
% Section 4.1.4: node list processing callbacks.
-% \begin{macrocode}
- buildpage_filter = simple,
- pre_linebreak_filter = list,
- linebreak_filter = list,
- post_linebreak_filter = list,
- hpack_filter = list,
- vpack_filter = list,
- pre_output_filter = list,
- hyphenate = simple,
- ligaturing = simple,
- kerning = simple,
- mlist_to_hlist = list,
+% \changes{v1.0m}{2016/02/11}
+% {process\_rule, [hv]pack\_quality append\_to\_vlist\_filter added}
+% \changes{v1.0n}{2016/03/13}{insert\_local\_par added}
+% \changes{v1.0n}{2016/03/13}{contribute\_filter added}
+% \begin{macrocode}
+ contribute_filter = simple,
+ buildpage_filter = simple,
+ pre_linebreak_filter = list,
+ linebreak_filter = list,
+ append_to_vlist_filter = list,
+ post_linebreak_filter = list,
+ hpack_filter = list,
+ vpack_filter = list,
+ hpack_quality = list,
+ vpack_quality = list,
+ pre_output_filter = list,
+ process_rule = list,
+ hyphenate = simple,
+ ligaturing = simple,
+ kerning = simple,
+ insert_local_par = simple,
+ mlist_to_hlist = list,
% \end{macrocode}
% Section 4.1.5: information reporting callbacks.
-% \begin{macrocode}
- pre_dump = simple,
- start_run = simple,
- stop_run = simple,
- start_page_number = simple,
- stop_page_number = simple,
- show_error_hook = simple,
- show_error_message = simple,
- show_lua_error_hook = simple,
- start_file = simple,
- stop_file = simple,
+% \changes{v1.0m}{2016/02/11}{show\_warning\_message added}
+% \begin{macrocode}
+ pre_dump = simple,
+ start_run = simple,
+ stop_run = simple,
+ start_page_number = simple,
+ stop_page_number = simple,
+ show_error_hook = simple,
+ show_warning_message = simple,
+ show_error_message = simple,
+ show_lua_error_hook = simple,
+ start_file = simple,
+ stop_file = simple,
% \end{macrocode}
% Section 4.1.6: PDF-related callbacks.
% \begin{macrocode}
@@ -1252,10 +1270,8 @@ local callbacktypes = callbacktypes or {
% \begin{macrocode}
define_font = exclusive,
% \end{macrocode}
-% Undocumented callbacks which are likely to get documented.
+% \changes{v1.0m}{2016/02/11}{pdf\_stream\_filter\_callback removed}
% \begin{macrocode}
- find_cidmap_file = data,
- pdf_stream_filter_callback = data,
}
luatexbase.callbacktypes=callbacktypes
% \end{macrocode}
@@ -1362,7 +1378,7 @@ local handlers = {
local user_callbacks_defaults = { }
% \end{macrocode}
%
-% \begin{macro}{create_callback}
+% \begin{macro}{create\_callback}
% \changes{v1.0a}{2015/09/24}{Function added}
% \changes{v1.0i}{2015/11/29}{Check name is not nil in error message (PHG)}
% \changes{v1.0k}{2015/12/02}{Give more specific error messages (PHG)}
@@ -1390,7 +1406,7 @@ luatexbase.create_callback = create_callback
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{call_callback}
+% \begin{macro}{call\_callback}
% \changes{v1.0a}{2015/09/24}{Function added}
% \changes{v1.0i}{2015/11/29}{Check name is not nil in error message (PHG)}
% \changes{v1.0k}{2015/12/02}{Give more specific error messages (PHG)}
@@ -1421,7 +1437,7 @@ luatexbase.call_callback=call_callback
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{add_to_callback}
+% \begin{macro}{add\_to\_callback}
% \changes{v1.0a}{2015/09/24}{Function added}
% Add a function to a callback. First check arguments.
% \changes{v1.0k}{2015/12/02}{Give more specific error messages (PHG)}
@@ -1485,7 +1501,7 @@ luatexbase.add_to_callback = add_to_callback
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{remove_from_callback}
+% \begin{macro}{remove\_from\_callback}
% \changes{v1.0a}{2015/09/24}{Function added}
% \changes{v1.0k}{2015/12/02}{adjust initialisation of cb local (PHG)}
% \changes{v1.0k}{2015/12/02}{Give more specific error messages (PHG)}
@@ -1542,7 +1558,7 @@ luatexbase.remove_from_callback = remove_from_callback
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{in_callback}
+% \begin{macro}{in\_callback}
% \changes{v1.0a}{2015/09/24}{Function added}
% \changes{v1.0h}{2015/11/27}{Guard against undefined list latex/4445}
% Look for a function description in a callback.
@@ -1566,7 +1582,7 @@ luatexbase.in_callback = in_callback
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{disable_callback}
+% \begin{macro}{disable\_callback}
% \changes{v1.0a}{2015/09/24}{Function added}
% As we subvert the engine interface we need to provide a way to access
% this functionality.
@@ -1582,7 +1598,7 @@ luatexbase.disable_callback = disable_callback
% \end{macrocode}
% \end{macro}
%
-% \begin{macro}{callback_descriptions}
+% \begin{macro}{callback\_descriptions}
% \changes{v1.0a}{2015/09/24}{Function added}
% \changes{v1.0h}{2015/11/27}{Match test in in-callback latex/4445}
% List the descriptions of functions registered for the given callback.