summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/base/luatex-callbacks.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/luatex/base/luatex-callbacks.tex')
-rw-r--r--Master/texmf-dist/doc/luatex/base/luatex-callbacks.tex61
1 files changed, 19 insertions, 42 deletions
diff --git a/Master/texmf-dist/doc/luatex/base/luatex-callbacks.tex b/Master/texmf-dist/doc/luatex/base/luatex-callbacks.tex
index 37213eb7343..aa6f9ed8a2d 100644
--- a/Master/texmf-dist/doc/luatex/base/luatex-callbacks.tex
+++ b/Master/texmf-dist/doc/luatex/base/luatex-callbacks.tex
@@ -397,15 +397,16 @@ end
The string reports the group code. From this you can deduce from
what list you can give a treat.
-\starttabulate[|lT|p|]
-\NC \rmbf value \NC \bf explanation \NC \NR
-\NC pre_box \NC interline material is being added \NC \NR
-\NC pre_adjust \NC \type {\vadjust} material is being added \NC \NR
-\NC box \NC a typeset box is being added (always called) \NC \NR
-\NC adjust \NC \type {\vadjust} material is being added \NC \NR
+\starttabulate
+\NC \bf group codes \NC \bf pointer \NC \NR
+\HL
+\NC\type {pre_box} \NC \type {contrib_head} \NC \NR
+\NC\type {pre_adjust_tail} \NC \type {pre_adjust_head} \NC \NR
+\NC\type {just} \NC \type {just_box} \NC \NR
+\NC\type {adjust_tail} \NC \type {adjust_head} \NC \NR
\stoptabulate
-\subsection{\type {buildpage_filter}}
+\subsection{\type {buildpage_filter} and \type {contribute_filter}}
This callback is called whenever \LUATEX\ is ready to move stuff to the main
vertical list. You can use this callback to do specialized manipulation of the
@@ -421,7 +422,7 @@ state is with respect to the \quote {current page}. The possible values for the
\type {buildpage_filter} callback are:
\starttabulate[|lT|p|]
-\NC \rmbf value \NC \bf explanation \NC \NR
+\NC \ssbf value \NC \bf explanation \NC \NR
\NC alignment \NC a (partial) alignment is being added \NC \NR
\NC after_output \NC an output routine has just finished \NC \NR
\NC new_graf \NC the beginning of a new paragraph \NC \NR
@@ -434,32 +435,19 @@ state is with respect to the \quote {current page}. The possible values for the
\NC end \NC \LUATEX\ is terminating (it's all over) \NC \NR
\stoptabulate
-\subsection{\type {build_page_insert}}
-
-This callback is called when the pagebuilder adds an insert. There is not much
-control over this mechanism but this callback permits some last minute
-manipulations of the spacing before an insert, something that might be handy when
-for instance multiple inserts (types) are appended in a row.
-
-\startfunctioncall
-function(<number> n, <number> i)
- return <number> register
-end
-\stopfunctioncall
-
-with
+And for the \type {contribute_filter} called in the post line break handler
+we have four cases (three are only called when there is a need for it).
\starttabulate[|lT|p|]
-\NC \rmbf value \NC \bf explanation \NC \NR
-\NC n \NC the insert class \NC \NR
-\NC i \NC the order of the insert \NC \NR
+\NC \ssbf value \NC \bf explanation \NC \NR
+\NC pre_box \NC interline material is being added \NC \NR
+\NC pre_adjust \NC \type {\vadjust} material is being added \NC \NR
+\NC box \NC a typeset box is being added (always called) \NC \NR
+\NC adjust \NC \type {\vadjust} material is being added \NC \NR
\stoptabulate
-The return value is a number indicating the skip register to use for the
-prepended spacing. This permits for instance a different top space (when \type
-{i} equals one) and intermediate space (when \type {i} is larger than one). Of course
-you can mess with the insert box but you need to make sure that \LUATEX\ is happy
-afterwards.
+Just before the \type {box} related call we have a callout to the \type
+{append_to_vlist_filter}. These callbacks do not replace any internal code.
\subsection{\type {pre_linebreak_filter}}
@@ -479,7 +467,7 @@ for the \type {hpack_filter} and \type {vpack_filter} callbacks that will be
explained in the next two paragraphs.
\starttabulate[|lT|p|]
-\NC \rmbf value \NC \bf explanation \NC \NR
+\NC \ssbf value \NC \bf explanation \NC \NR
\NC <empty> \NC main vertical list \NC \NR
\NC hbox \NC \type {\hbox} in horizontal mode \NC \NR
\NC adjusted_hbox \NC \type {\hbox} in vertical mode \NC \NR
@@ -864,17 +852,6 @@ end
This callback replaces the code that prints \LUATEX's when a file is closed like
the \type {)} for regular files.
-\subsection{\type {call_edit}}
-
-\startfunctioncall
-function(filename,linenumber)
-end
-\stopfunctioncall
-
-This callback replaces the call to an external editor when \quote{E} is pressed
-in reply to an error message. Processing will end immediately after the callback
-returns control to the main program.
-
\section{PDF-related callbacks}
\subsection{\type {finish_pdffile}}