[latex3-commits] [git/LaTeX3-latex3-latex3] master: Merge branch 'faster-keyval_parse' of https://github.com/Skillmon/latex3 into Skillmon-faster-keyval_parse (995462d8f)
PhelypeOleinik
tex.phelype at gmail.com
Tue May 12 16:52:40 CEST 2020
Repository : https://github.com/latex3/latex3
On branch : master
Link : https://github.com/latex3/latex3/commit/995462d8fcc1c0e464099ac0d75150b7ab6ce60e
>---------------------------------------------------------------
commit 995462d8fcc1c0e464099ac0d75150b7ab6ce60e
Merge: 1fe065900 4740304e4
Author: PhelypeOleinik <tex.phelype at gmail.com>
Date: Tue May 12 11:52:40 2020 -0300
Merge branch 'faster-keyval_parse' of https://github.com/Skillmon/latex3 into Skillmon-faster-keyval_parse
>---------------------------------------------------------------
995462d8fcc1c0e464099ac0d75150b7ab6ce60e
l3kernel/l3keys.dtx | 383 +++++++++++++--------
l3kernel/testfiles/m3keyval001.luatex.tlg | 2 +-
l3kernel/testfiles/m3keyval001.tlg | 2 +-
.../{m3fp-basics003.tlg => m3keyval002.luatex.tlg} | 130 +++----
l3kernel/testfiles/m3keyval002.lvt | 74 ++++
.../{m3fp-basics002.tlg => m3keyval002.tlg} | 133 +++----
6 files changed, 407 insertions(+), 317 deletions(-)
diff --cc l3kernel/l3keys.dtx
index b3630af0b,5ee12883b..cfcb207e4
--- a/l3kernel/l3keys.dtx
+++ b/l3kernel/l3keys.dtx
@@@ -998,12 -999,30 +997,26 @@@
% \end{macrocode}
% \end{macro}
%
+ % \begin{macro}[EXP]{\@@_split_other:w, \@@_split_active:w}
+ % These two macros allow to split at the first equals sign of category 12 or
+ % 13. At the same time they also execute branching by inserting the first
+ % token following \cs{s_@@_mark} that followed the equals sign. Hence they
+ % also test for the presence of such an equals sign simultaneously.
+ % \begin{macrocode}
+ \cs_new:Npn \@@_split_other:w ##1 = ##2 \s_@@_mark ##3 ##4 \s_@@_stop
- {
- ##3 ##1 \s_@@_stop \s_@@_mark ##2
- }
++ { ##3 ##1 \s_@@_stop \s_@@_mark ##2 }
+ \cs_new:Npn \@@_split_active:w ##1 #2 ##2 \s_@@_mark ##3 ##4 \s_@@_stop
- {
- ##3 ##1 \s_@@_stop \s_@@_mark ##2
- }
++ { ##3 ##1 \s_@@_stop \s_@@_mark ##2 }
+ % \end{macrocode}
+ % \end{macro}
+ %
% \begin{macro}[EXP]{\@@_loop_other:NNw}
% The second loop uses the same test for its end as the first loop, next it
- % tests whether there are other or active equals signs, throwing an error if
- % there are both. If there are none, test whether the argument is blank or is
- % a single key. If there are only active equals signs split at those, else
- % split at others. Finally, iterate the loop.
+ % splits at the first active equals sign using \cs{@@_split_active:w}. The
+ % \cs{s_@@_nil} prevents accidental brace stripping and acts as a delimiter in
+ % the next steps. First testing for an active equals sign will reduce the
+ % number of necessary expansion steps for the expected average use case of
+ % other equals signs and hence perform better on average.
% \begin{macrocode}
\cs_new:Npn \@@_loop_other:NNw ##1 ##2 ##3 ,
{
@@@ -1032,24 -1038,78 +1032,74 @@@
% \end{macrocode}
% \end{macro}
%
- % \begin{macro}[EXP]{\@@_split_active:w}
- % \begin{macro}[EXP]{\@@_split_active:nw}
- % Splits at the first active equals sign and trims the key. Next test whether
- % there are any more valid split points, if so throw an error and gobble the
- % remaining \meta{function_2}, which will not yet be gobbled. If there was
- % only one active equals sign start trimming the spaces off the value and give
- % control to \cs[no-index]{@@_key_val:nnN}.
+ % \begin{macro}[EXP]{\@@_split_active_auxi:w}
+ % \begin{macro}[EXP]{\@@_split_active_auxii:w}
+ % \begin{macro}[EXP]{\@@_split_active_auxiii:w}
+ % \begin{macro}[EXP]{\@@_split_active_auxiv:w}
+ % \begin{macro}[EXP]{\@@_split_active_auxv:w}
+ % After \cs{@@_split_active:w} the following will only be called if there was
+ % at least one active equals sign in the current key--value pair. Therefore
+ % this is the execution branch for a key--value pair with an active equals
+ % sign. |##1| will be everything up to the first active equals sign. First it
+ % tests for other equals signs in the key name, which will eventually throw an
+ % error via \cs{@@_misplaced_equal_after_active_error:w}. If none was found we
+ % forward the key to \cs{@@_split_active_auxii:w}.
% \begin{macrocode}
- \cs_new:Npn \@@_split_active:w ##1 #2
- { \@@_trim:nN { ##1 } \@@_split_active:nw \s_@@_mark }
- \cs_new:Npn \@@_split_active:nw ##1 ##2 #2 ##3 \s_@@_stop
+ \cs_new:Npn \@@_split_active_auxi:w ##1 \s_@@_stop
{
- \@@_if_empty:w \s_@@_mark ##3 \s_@@_stop
- \@@_has_false:w \s_@@_mark \s_@@_stop \use_i:nn
- { \@@_misplaced_equal_error: \use_none:n }
- { \@@_trim:nN { ##2 } \@@_key_val:nnN { ##1 } }
+ \@@_split_other:w ##1 \s_@@_nil
+ \s_@@_mark \@@_misplaced_equal_after_active_error:w
+ = \s_@@_mark \@@_split_active_auxii:w
+ \s_@@_stop
}
% \end{macrocode}
+ % \cs{@@_split_active_auxii:w} gets the correct key name with a leading
+ % \cs{s_@@_mark} as |##1|. It has to sanitise the remainder of the previous
+ % test and trims the key name which will be forwarded to
+ % \cs{@@_split_active_auxiii:w}.
+ % \begin{macrocode}
+ \cs_new:Npn \@@_split_active_auxii:w
+ ##1 \s_@@_nil \s_@@_mark \@@_misplaced_equal_after_active_error:w
+ \s_@@_stop \s_@@_mark
- {
- \@@_trim:nN { ##1 } \@@_split_active_auxiii:w
- }
++ { \@@_trim:nN { ##1 } \@@_split_active_auxiii:w }
+ % \end{macrocode}
+ % Next we test for a misplaced active equals sign in the value, if none is
+ % found \cs{@@_split_active_auxiv:w} will be called.
+ % \begin{macrocode}
+ \cs_new:Npn \@@_split_active_auxiii:w ##1 ##2 \s_@@_nil
+ {
+ \@@_split_active:w ##2 \s_@@_nil
+ \s_@@_mark \@@_misplaced_equal_in_split_error:w
+ #2 \s_@@_mark \@@_split_active_auxiv:w
+ \s_@@_stop
+ { ##1 }
+ }
+ % \end{macrocode}
+ % This runs the last test after sanitising the remainder of the previous one.
+ % This time test for a misplaced equals sign of category 12 in the value.
+ % Finally the last auxiliary macro will be called.
+ % \begin{macrocode}
+ \cs_new:Npn \@@_split_active_auxiv:w
+ ##1 \s_@@_nil \s_@@_mark \@@_misplaced_equal_in_split_error:w
+ \s_@@_stop \s_@@_mark
+ {
+ \@@_split_other:w ##1 \s_@@_nil
+ \s_@@_mark \@@_misplaced_equal_in_split_error:w
+ = \s_@@_mark \@@_split_active_auxv:w
+ \s_@@_stop
+ }
+ % \end{macrocode}
+ % This last macro in this execution branch sanitises the last test, trims the
+ % value and passes it to \cs{@@_pair:nnNN}.
+ % \begin{macrocode}
+ \cs_new:Npn \@@_split_active_auxv:w
+ ##1 \s_@@_nil \s_@@_mark \@@_misplaced_equal_in_split_error:w
+ \s_@@_stop \s_@@_mark
- {
- \@@_trim:nN { ##1 } \@@_pair:nnNN
- }
++ { \@@_trim:nN { ##1 } \@@_pair:nnNN }
+ % \end{macrocode}
+ % \end{macro}
+ % \end{macro}
+ % \end{macro}
% \end{macro}
% \end{macro}
%
@@@ -1062,63 -1130,101 +1120,99 @@@
% \end{macrocode}
% \end{macro}
%
- % We're done with the macros which need active equals signs or commas in their
- % definition, so we can end that scope and call the temporary macro which will
- % do the definitions.
+ % \begin{macro}[EXP]{\@@_split_other_auxi:w}
+ % \begin{macro}[EXP]{\@@_split_other_auxii:w}
+ % \begin{macro}[EXP]{\@@_split_other_auxiii:w}
+ % This is executed if the key--value pair doesn't contain an active equals
+ % sign but at least one other. |##1| of \cs{@@_split_other_auxi:w} will
+ % contain the complete key name, which is trimmed and forwarded to the next
+ % auxiliary macro.
% \begin{macrocode}
- }
- \char_set_catcode_active:n { `\, }
- \char_set_catcode_active:n { `\= }
- \@@_tmp:NN , =
- \group_end:
+ \cs_new:Npn \@@_split_other_auxi:w ##1 \s_@@_stop
- {
- \@@_trim:nN { ##1 } \@@_split_other_auxii:w
- }
++ { \@@_trim:nN { ##1 } \@@_split_other_auxii:w }
+ % \end{macrocode}
+ % We know that the value doesn't contain misplaced active equals signs but we
+ % have to test for others.
+ % \begin{macrocode}
+ \cs_new:Npn \@@_split_other_auxii:w ##1 ##2 \s_@@_nil
+ {
+ \@@_split_other:w ##2 \s_@@_nil
+ \s_@@_mark \@@_misplaced_equal_in_split_error:w
+ = \s_@@_mark \@@_split_other_auxiii:w
+ \s_@@_stop
+ { ##1 }
+ }
+ % \end{macrocode}
+ % \cs{@@_split_other_auxiii:w} sanitises the test for other equals signs,
+ % trims the value and forwards it to \cs{@@_pair:nnNN}.
+ % \begin{macrocode}
+ \cs_new:Npn \@@_split_other_auxiii:w
+ ##1 \s_@@_nil \s_@@_mark \@@_misplaced_equal_in_split_error:w
+ \s_@@_stop \s_@@_mark
- {
- \@@_trim:nN { ##1 } \@@_pair:nnNN
- }
++ { \@@_trim:nN { ##1 } \@@_pair:nnNN }
% \end{macrocode}
+ % \end{macro}
+ % \end{macro}
+ % \end{macro}
%
- % \begin{macro}[EXP]{\@@_end_loop_active:w,\@@_end_loop_other:w}
- % Both of these macros just have to gobble a few tokens to remove the reminder
- % of the loops current iteration. We do this in a pretty static manner,
- % explicitly stating every token we know beforehand because this is slightly
- % faster.
+ % \begin{macro}[EXP]{\@@_clean_up_other:w}
+ % \cs{@@_clean_up_other:w} is the last branch that might exist. It is called
+ % if no equals sign was found, hence the only possibilities left are a blank
+ % list element, which is to be skipped, or a lonely key. If it's no empty list
+ % element this will trim the key name and forward it to \cs{@@_key:nNN}.
% \begin{macrocode}
- \cs_new:Npn \@@_end_loop_active:w
- \s_@@_mark \s_@@_tail
- \@@_loop_other:NNw #1 , \s_@@_tail ,
- \@@_loop_active:NNw #2 \s_@@_mark
- { }
- \cs_new:Npn \@@_end_loop_other:w
- \s_@@_mark \s_@@_tail
- \@@_if_has_equal_other:w #1 = \s_@@_stop
- \@@_has_false:w \s_@@_mark \s_@@_stop \use_i:nn
- #2
- \@@_loop_other:NNw #3 \s_@@_mark
- { }
+ \cs_new:Npn \@@_clean_up_other:w
+ ##1 \s_@@_nil \s_@@_mark \@@_split_other_auxi:w \s_@@_stop \s_@@_mark
+ {
+ \@@_if_blank:w ##1 \s_@@_nil \s_@@_stop \@@_blank_true:w
+ \s_@@_mark \s_@@_stop \use:n
+ { \@@_trim:nN { ##1 } \@@_key:nNN }
+ }
% \end{macrocode}
% \end{macro}
%
- % \begin{macro}[EXP]{\@@_split_other:w}
- % \begin{macro}[EXP]{\@@_split_other:nw}
- % These work exactly as \cs[no-index]{@@_split_active:wN}, just for
- % equals signs of category other.
+ % \begin{macro}[EXP]{\@@_misplaced_equal_after_active_error:w}
+ % \begin{macro}[EXP]{\@@_misplaced_equal_in_split_error:w}
+ % All these two macros do is gobble the remainder of the current other loop
+ % execution and throw an error.
% \begin{macrocode}
- \cs_new:Npn \@@_split_other:w #1 =
- { \@@_trim:nN { #1 } \@@_split_other:nw \s_@@_mark }
- \cs_new:Npn \@@_split_other:nw #1 #2 = #3 \s_@@_stop
- {
- \@@_if_empty:w \s_@@_mark #3 \s_@@_stop
- \@@_has_false:w \s_@@_mark \s_@@_stop \use_i:nn
- { \@@_misplaced_equal_error: \use_none:n }
- { \@@_trim:nN { #2 } \@@_key_val:nnN { #1 } }
- }
+ \cs_new:Npn \@@_misplaced_equal_after_active_error:w
+ \s_@@_mark ##1 \s_@@_stop \s_@@_mark ##2 \s_@@_nil
+ \s_@@_mark ##3 \s_@@_nil ##4 ##5
+ {
- \__kernel_msg_expandable_error:nn { kernel } { misplaced-equals-sign }
++ \__kernel_msg_expandable_error:nn
++ { kernel } { misplaced-equals-sign }
+ }
+ \cs_new:Npn \@@_misplaced_equal_in_split_error:w
+ \s_@@_mark ##1 \s_@@_stop \s_@@_mark ##2 \s_@@_nil
+ ##3 ##4 ##5
+ {
- \__kernel_msg_expandable_error:nn { kernel } { misplaced-equals-sign }
++ \__kernel_msg_expandable_error:nn
++ { kernel } { misplaced-equals-sign }
+ }
% \end{macrocode}
% \end{macro}
% \end{macro}
%
- % \begin{macro}[EXP]{\@@_key:nN}
- % This will get the current key with spaces trimmed and \meta{function_1} as
- % its arguments. All it has to do is put them in an \cs{exp_not:n} and reorder
- % them.
+ % \begin{macro}[EXP]{\@@_end_loop_other:w, \@@_end_loop_active:w}
+ % All that's left for the parsing loops are the macros which end the
+ % recursion. Both just gobble the remaining tokens of the respective loop
+ % including the next recursion call.
% \begin{macrocode}
- \cs_new:Npn \@@_key:nN #1 #2
- { \exp_not:n { #2 { #1 } } }
+ \cs_new:Npn \@@_end_loop_other:w
+ \s_@@_tail
+ \@@_split_active:w ##1 \s_@@_nil
+ \s_@@_mark \@@_split_active_auxi:w
+ #2 \s_@@_mark \@@_clean_up_active:w
+ \s_@@_stop
+ ##2 ##3
+ \@@_loop_other:NNw ##4 \s_@@_mark
- {}
++ { }
+ \cs_new:Npn \@@_end_loop_active:w
+ \s_@@_tail
+ \@@_loop_other:NNw ##1 , \s_@@_tail ,
+ \@@_loop_active:NNw ##2 \s_@@_mark
- {}
++ { }
% \end{macrocode}
% \end{macro}
%
@@@ -1143,9 -1265,9 +1253,9 @@@
% with an arbitrary token following the argument. Each of these utilize the
% fact that the argument will contain a leading \cs{s_@@_mark}.
% \begin{macrocode}
--\cs_new:Npn \@@_if_empty:w #1 \s_@@_mark \s_@@_stop {}
++\cs_new:Npn \@@_if_empty:w #1 \s_@@_mark \s_@@_stop { }
\cs_new:Npn \@@_if_blank:w \s_@@_mark #1 { \@@_if_empty:w \s_@@_mark }
- \cs_new:Npn \@@_if_recursion_tail:w #1 \s_@@_mark \s_@@_tail {}
-\cs_new:Npn \@@_if_recursion_tail:w \s_@@_mark #1 \s_@@_tail {}
++\cs_new:Npn \@@_if_recursion_tail:w \s_@@_mark #1 \s_@@_tail { }
% \end{macrocode}
% \end{macro}
%
@@@ -1153,29 -1275,11 +1263,12 @@@
% These macros will be called if the tests above didn't gobble them, they
% execute the branching.
% \begin{macrocode}
- \cs_new:Npn \@@_has_false:w \s_@@_mark \s_@@_stop \use_i:nn #1 #2 { #2 }
- \cs_new:Npn \@@_blank_true:w \s_@@_mark \s_@@_stop \use:n #1 {}
- \cs_new:Npn \@@_empty_key:w \s_@@_mark \s_@@_stop \exp_not:n #1
- { \@@_misplaced_equal_error: }
- % \end{macrocode}
- % \end{macro}
- %
- % \begin{macro}[EXP]{\@@_if_has_equal_other:w}
- % Another test that works by gobbling tokens until a specific one is hit.
- % \begin{macrocode}
- \cs_new:Npn \@@_if_has_equal_other:w #1 =
- { \@@_if_empty:w \s_@@_mark }
- % \end{macrocode}
- % \end{macro}
- %
- % \begin{macro}[EXP]{\@@_misplaced_equal_error:}
- % Just throw an error expandably. This is hid inside a macro so that other
- % macros don't have to gobble so many tokens, which increases speed for
- % correct input. This will marginally slow down the error case, but that
- % doesn't have to be fast anyway.
- % \begin{macrocode}
- \cs_new:Npn \@@_misplaced_equal_error:
- { \__kernel_msg_expandable_error:nn { kernel } { misplaced-equals-sign } }
-\cs_new:Npn \@@_blank_true:w \s_@@_mark \s_@@_stop \use:n #1 #2 #3 {}
++\cs_new:Npn \@@_blank_true:w \s_@@_mark \s_@@_stop \use:n #1 #2 #3 { }
+ \cs_new:Npn \@@_blank_key_error:w \s_@@_mark \s_@@_stop \exp_not:n #1
+ {
- \__kernel_msg_expandable_error:nn { kernel } { blank-key-name }
++ \__kernel_msg_expandable_error:nn
++ { kernel } { blank-key-name }
+ }
% \end{macrocode}
% \end{macro}
%
@@@ -1183,6 -1287,8 +1276,8 @@@
% \begin{macrocode}
\__kernel_msg_new:nnn { kernel } { misplaced-equals-sign }
{ Misplaced~equals~sign~in~key-value~input~\msg_line_context: }
+ \__kernel_msg_new:nnn { kernel } { blank-key-name }
- { Blank~key~name~in~key~value~input~\msg_line_context: }
++ { Blank~key~name~in~key-value~input~\msg_line_context: }
% \end{macrocode}
%
% \begin{macro}[EXP]{\@@_trim:nN}
@@@ -1203,7 -1309,7 +1298,7 @@@
\@@_trim_auxi:w
##1
\s_@@_nil
-- \s_@@_mark #1 {}
++ \s_@@_mark #1 { }
\s_@@_mark \@@_trim_auxii:w
\@@_trim_auxiii:w
#1 \s_@@_nil
@@@ -1482,11 -1548,11 +1577,11 @@@
\cs_if_exist:cTF { \c_@@_props_root_str \l_@@_property_str }
{ \@@_define_code:n {#2} }
{
-- \str_if_empty:NF \l_@@_property_str
-- {
-- \__kernel_msg_error:nnxx { kernel } { key-property-unknown }
- { \l_@@_property_str } { \l_keys_path_str }
- }
++ \str_if_empty:NF \l_@@_property_str
++ {
++ \__kernel_msg_error:nnxx { kernel } { key-property-unknown }
+ { \l_@@_property_str } { \l_keys_path_str }
- }
++ }
}
}
% \end{macrocode}
@@@ -2729,7 -2795,7 +2824,7 @@@
}
{
\__kernel_msg_error:nnxx { kernel } { key-unknown }
-- { \l_keys_path_str } { \l_@@_module_str }
++ { \l_keys_path_str } { \l_@@_module_str }
}
}
}
More information about the latex3-commits
mailing list.