Skip to content

Commit

Permalink
Restrict use of 'coding error' text
Browse files Browse the repository at this point in the history
Really this should only be needed in l3msg: it's for low-level errors.
Moving a few l3keys messages here to stick with that also points out
that they need longer names.
  • Loading branch information
josephwright committed Mar 16, 2018
1 parent 45119a8 commit 402fd1a
Show file tree
Hide file tree
Showing 13 changed files with 77 additions and 85 deletions.
35 changes: 3 additions & 32 deletions l3kernel/l3keys.dtx
Expand Up @@ -1295,7 +1295,7 @@
{
\tl_if_empty:NF \l_@@_property_tl
{
\__kernel_msg_error:nnxx { kernel } { property-unknown }
\__kernel_msg_error:nnxx { kernel } { key-property-unknown }
{ \l_@@_property_tl } { \l_keys_path_tl }
}
}
Expand Down Expand Up @@ -1373,7 +1373,7 @@
{ \use:c { \c_@@_props_root_tl \l_@@_property_tl } }
{
\__kernel_msg_error:nnxx { kernel }
{ property-requires-value } { \l_@@_property_tl }
{ key-property-requires-value } { \l_@@_property_tl }
{ \l_keys_path_tl }
}
}
Expand Down Expand Up @@ -1658,7 +1658,7 @@
}
}
{
\__kernel_msg_error:nnx { kernel } { property-boolean-values-only }
\__kernel_msg_error:nnx { kernel } { key-property-boolean-values-only }
{ .value_ #1 :n }
}
}
Expand Down Expand Up @@ -2480,15 +2480,6 @@
The~key~'#1'~only~accepts~predefined~values,~
and~'#2'~is~not~one~of~these.
}
\__kernel_msg_new:nnnn { kernel } { key-no-property }
{ No~property~given~in~definition~of~key~'#1'. }
{
\c__msg_coding_error_text_tl
Inside~\keys_define:nn each~key~name~
needs~a~property: \\ \\
\iow_indent:n { #1 .<property> } \\ \\
LaTeX~did~not~find~a~'.'~to~indicate~the~start~of~a~property.
}
\__kernel_msg_new:nnnn { kernel } { key-unknown }
{ The~key~'#1'~is~unknown~and~is~being~ignored. }
{
Expand All @@ -2501,26 +2492,6 @@
The~key~'#1'~cannot~be~defined~as~a~choice~as~the~parent~key~'#2'~is~
itself~a~choice.
}
\__kernel_msg_new:nnnn { kernel } { property-boolean-values-only }
{ The~property~'#1'~accepts~boolean~values~only. }
{
\c__msg_coding_error_text_tl
The~property~'#1'~only~accepts~the~values~'true'~and~'false'.
}
\__kernel_msg_new:nnnn { kernel } { property-requires-value }
{ The~property~'#1'~requires~a~value. }
{
\c__msg_coding_error_text_tl
LaTeX~was~asked~to~set~property~'#1'~for~key~'#2'.\\
No~value~was~given~for~the~property,~and~one~is~required.
}
\__kernel_msg_new:nnnn { kernel } { property-unknown }
{ The~key~property~'#1'~is~unknown. }
{
\c__msg_coding_error_text_tl
LaTeX~has~been~asked~to~set~the~property~'#1'~for~key~'#2':~
this~property~is~not~defined.
}
\__kernel_msg_new:nnnn { kernel } { value-forbidden }
{ The~key~'#1'~does~not~take~a~value. }
{
Expand Down
43 changes: 32 additions & 11 deletions l3kernel/l3msg.dtx
Expand Up @@ -682,16 +682,6 @@
% \end{texnote}
% \end{function}
%
% \section{Internal \pkg{l3msg} functions}
%
% \begin{variable}{\c__msg_coding_error_text_tl}
% The text
% \begin{verbatim}
% This is a coding error.
% \end{verbatim}
% used by kernel functions when erroneous programming input is encountered.
% \end{variable}
%
% \end{documentation}
%
% \begin{implementation}
Expand Down Expand Up @@ -1793,7 +1783,8 @@
}
% \end{macrocode}
%
% Messages for earlier kernel modules.
% Messages for earlier kernel modules plus a few for \pkg{l3keys} which
% cover coding errors.
% \begin{macrocode}
\__kernel_msg_new:nnnn { kernel } { bad-number-of-arguments }
{ Function~'#1'~cannot~be~defined~with~#2~arguments. }
Expand Down Expand Up @@ -1892,6 +1883,35 @@
LaTeX~has~been~asked~to~define~the~conditional~form~'#1'~of~
the~function~'#2',~but~only~'TF',~'T',~'F',~and~'p'~forms~exist.
}
\__kernel_msg_new:nnnn { kernel } { key-no-property }
{ No~property~given~in~definition~of~key~'#1'. }
{
\c__msg_coding_error_text_tl
Inside~\keys_define:nn each~key~name~
needs~a~property: \\ \\
\iow_indent:n { #1 .<property> } \\ \\
LaTeX~did~not~find~a~'.'~to~indicate~the~start~of~a~property.
}
\__kernel_msg_new:nnnn { kernel } { key-property-boolean-values-only }
{ The~property~'#1'~accepts~boolean~values~only. }
{
\c__msg_coding_error_text_tl
The~property~'#1'~only~accepts~the~values~'true'~and~'false'.
}
\__kernel_msg_new:nnnn { kernel } { key-property-requires-value }
{ The~property~'#1'~requires~a~value. }
{
\c__msg_coding_error_text_tl
LaTeX~was~asked~to~set~property~'#1'~for~key~'#2'.\\
No~value~was~given~for~the~property,~and~one~is~required.
}
\__kernel_msg_new:nnnn { kernel } { key-property-unknown }
{ The~key~property~'#1'~is~unknown. }
{
\c__msg_coding_error_text_tl
LaTeX~has~been~asked~to~set~the~property~'#1'~for~key~'#2':~
this~property~is~not~defined.
}
\__kernel_msg_new:nnnn { kernel } { scanmark-already-defined }
{ Scan~mark~#1~already~defined. }
{
Expand Down Expand Up @@ -1963,6 +1983,7 @@
\__kernel_msg_new:nnnn { kernel } { non-declared-variable }
{ The~variable~#1~has~not~been~declared~\msg_line_context:. }
{
\c_@@_coding_error_text_tl
Checking~is~active,~and~you~have~tried~do~so~something~like: \\
\ \ \tl_set:Nn ~ #1 ~ \{ ~ ... ~ \} \\
without~first~having: \\
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl001.luatex.tlg
Expand Up @@ -3007,6 +3007,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3680,12 +3684,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl001.ptex.tlg
Expand Up @@ -2944,6 +2944,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3617,12 +3621,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl001.tlg
Expand Up @@ -2944,6 +2944,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3617,12 +3621,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl001.uptex.tlg
Expand Up @@ -2944,6 +2944,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3617,12 +3621,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl001.xetex.tlg
Expand Up @@ -3005,6 +3005,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3678,12 +3682,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl003.luatex.tlg
Expand Up @@ -3007,6 +3007,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3680,12 +3684,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl003.ptex.tlg
Expand Up @@ -2944,6 +2944,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3617,12 +3621,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl003.tlg
Expand Up @@ -2944,6 +2944,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3617,12 +3621,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl003.uptex.tlg
Expand Up @@ -2944,6 +2944,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3617,12 +3621,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
8 changes: 4 additions & 4 deletions l3kernel/testfiles/m3expl003.xetex.tlg
Expand Up @@ -3005,6 +3005,10 @@ Defining message LaTeX/kernel/overflow on line ...
Defining message LaTeX/kernel/out-of-bounds on line ...
Defining message LaTeX/kernel/protected-predicate on line ...
Defining message LaTeX/kernel/conditional-form-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-property-boolean-values-only on line ...
Defining message LaTeX/kernel/key-property-requires-value on line ...
Defining message LaTeX/kernel/key-property-unknown on line ...
Defining message LaTeX/kernel/scanmark-already-defined on line ...
Defining message LaTeX/kernel/variable-not-defined on line ...
Defining message LaTeX/kernel/variant-too-long on line ...
Expand Down Expand Up @@ -3678,12 +3682,8 @@ Defining \keys_log:nn on line ...
Defining \__keys_show:Nnn on line ...
Defining message LaTeX/kernel/boolean-values-only on line ...
Defining message LaTeX/kernel/key-choice-unknown on line ...
Defining message LaTeX/kernel/key-no-property on line ...
Defining message LaTeX/kernel/key-unknown on line ...
Defining message LaTeX/kernel/nested-choice-key on line ...
Defining message LaTeX/kernel/property-boolean-values-only on line ...
Defining message LaTeX/kernel/property-requires-value on line ...
Defining message LaTeX/kernel/property-unknown on line ...
Defining message LaTeX/kernel/value-forbidden on line ...
Defining message LaTeX/kernel/value-required on line ...
Defining message LaTeX/kernel/show-key on line ...
Expand Down
4 changes: 2 additions & 2 deletions l3kernel/testfiles/m3keys001.tlg
Expand Up @@ -184,7 +184,7 @@ TEST 10: Unknown properties, etc.
============================================================
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! LaTeX error: "kernel/property-unknown"
! LaTeX error: "kernel/key-property-unknown"
!
! The key property '.foobar' is unknown.
!
Expand All @@ -201,7 +201,7 @@ l. ... }
|...............................................
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!
! LaTeX error: "kernel/property-requires-value"
! LaTeX error: "kernel/key-property-requires-value"
!
! The property '.code:n' requires a value.
!
Expand Down

0 comments on commit 402fd1a

Please sign in to comment.