lib/LaTeXML/Core/KeyVal.pm untested

filter: Statementstmt 0.0% 0 / 123 Branchbran 0.0% 0 / 38 Conditioncond 0.0% 0 / 13 MC/DCmcdc 0.0% 0 / 7 Subroutinesub 0.0% 0 / 19 Podpod 0.0% 0 / 11 totaltotal 0.0% 0 / 211 CC 20 SCAR 38.0
CC
20
Cov
0%
define
90.0
defineChoice
90.0
defineBoolean
12.0
CRAP 44.7
1 # /=====================================================================\ #
2 # | LaTeXML::Core::KeyVal | #
3 # | Key-Value Definitions in LaTeXML | #
4 # |=====================================================================| #
5 # | Thanks to Tom Wiesing <tom.wiesing@gmail.com> | #
6 # | Part of LaTeXML: | #
7 # | Public domain software, produced as part of work done by the | #
8 # | United States Government & not subject to copyright in the US. | #
9 # |---------------------------------------------------------------------| #
10 # | Bruce Miller <bruce.miller@nist.gov> #_# | #
11 # | http://dlmf.nist.gov/LaTeXML/ (o o) | #
12 # \=========================================================ooo==U==ooo=/ #
13 package LaTeXML::Core::KeyVal;
14 use strict;
15 use warnings;
16 use LaTeXML::Global;
17 use LaTeXML::Common::Object;
18 use LaTeXML::Common::Error;
19 use LaTeXML::Core::Token;
20 use LaTeXML::Core::Tokens;
21 use base qw(LaTeXML::Common::Object);
22  
23 our @EXPORT = (
24 qw(&DefKeyVal &DisableKeyVal &HasKeyVal),
25 # Semi-internals
26 qw(&keyval_qname &keyval_get));
27  
28 #======================================================================
29 # Exposed Methods
30 #======================================================================
31  
32 # Defines a new key-value pair
33 sub DefKeyVal {
34 my ($keyset, $key, $type, $default, %options) = @_;
35 # extract the prefix
36 my $prefix = $options{prefix} || 'KV';
37 delete $options{prefix};
38 define($prefix, $keyset, $key, $type, $default, %options);
39 return; }
40  
41 # check if a key-value pair is defined
42 sub HasKeyVal {
43 my ($prefix, $keyset, $key) = @_;
44 my $qname = keyval_qname($prefix, $keyset, $key);
45 return $STATE->lookupValue('KEYVAL@defined@' . $qname)
46 || (defined $STATE->lookupMeaning(T_CS('\\' . $qname))); }
47  
48 # disable a given key-val
49 sub DisableKeyVal {
50 my ($prefix, $keyset, $key) = @_;
51 my $qname = keyval_qname($prefix, $keyset, $key);
52 keyval_set($qname, 'disabled', 1);
53 # disable the key
54 defineOrdinary($qname, sub {
55 LaTeXML::Package::Tokenize("\\PackageWarning{keyval}{`" . $key . "' has been disabled. }");
56 });
57 return; }
58  
59 # useful (only) for LaTeXML::Core::KeyVals
60 sub keyval_qname {
61 my ($prefix, $keyset, $key) = @_;
62 return ($prefix || 'KV') . '@' . $keyset . '@' . $key; }
63  
64 sub keyval_get {
65 my ($qname, $prop) = @_;
66 return $STATE->lookupValue('KEYVAL@' . $prop . '@' . $qname); }
67  
68 sub keyval_set {
69 my ($qname, $prop, $value) = @_;
70 return $STATE->assignValue('KEYVAL@' . $prop . '@' . $qname, $value); }
71  
72 #======================================================================
73 # Key Definition
74 #======================================================================
75  
76 # (re-)define this key
77 sub define {
78 my ($prefix, $keyset, $key, $type, $default, %options) = @_;
79 my $qname = keyval_qname($prefix, $keyset, $key);
80  
81 # define that the key exists and is not disabled
82 keyval_set($qname, exists => 1);
83 keyval_set($qname, disabled => 0);
84 # set the type
85 my $paramlist = LaTeXML::Package::parseParameters($type || "{}",
86 "KeyVal $key in set $keyset with prefix $prefix");
87 if (scalar(@$paramlist) != 1) {
88 Warn('unexpected', 'keyval', $key,
89 "Too many parameters in keyval $key (in set $keyset with prefix $prefix)"
90 . "taking only first", $paramlist); }
91 keyval_set($qname, type => $$paramlist[0]);
92 # set the default
93 # Question: Why was $default converted ToString ???
94 if (defined $default) {
95 my @tdefault = LaTeXML::Package::Tokenize($default);
96 keyval_set($qname, default => Tokens(@tdefault));
97 LaTeXML::Package::DefMacroI('\\' . $qname . '@default', undef,
98 Tokens(T_CS('\\' . $qname), T_BEGIN, @tdefault, T_END)); }
99  
100 # figure out the kind of key-val parameter we are defining
101 my $kind = $options{kind} || 'ordinary';
102 if ($kind eq 'ordinary') {
103 defineOrdinary($qname, $options{code}); }
104 elsif ($kind eq 'command') {
105 my $macroname = ($options{macroprefix} ? $options{macroprefix} . $key : "cmd" . $qname);
106 defineCommand($qname, $options{code}, $macroname); }
107 elsif ($kind eq 'choice') {
108 defineChoice($qname, $options{code}, $options{mismatch},
109 $options{choices}, ($options{normalize} || 0), $options{bin}); }
110 elsif ($kind eq 'boolean') {
111 my $macroname = ($options{macroprefix} ? $options{macroprefix} . $key : $qname);
112 defineBoolean($qname, $options{code}, $options{mismatch}, $macroname); }
113 else {
114 Warn('unknown', undef, "Unknown KeyVals kind $kind",
115 "should be one of 'ordinary', 'command', 'choice', 'boolean'. "); }
116 return; }
117  
118 sub defineOrdinary {
119 my ($qname, $code) = @_;
120 LaTeXML::Package::DefMacroI('\\' . $qname, '{}', (defined($code) ? $code : ''));
121 return; }
122  
123 sub defineCommand {
124 my ($qname, $code, $macroname) = @_;
125 LaTeXML::Package::DefMacroI('\\' . $qname, '{}', sub {
126 my ($gullet, $value) = @_;
127 my $orig = '\\ltxml@orig@' . $qname;
128 LaTeXML::Package::DefMacroI($orig, '{}', $code);
129 Tokens(T_CS("\\def"), T_CS('\\' . $macroname), T_BEGIN, $value, T_END,
130 T_CS($orig), T_BEGIN, T_PARAM, $value, T_END); # $value !?!??! Is it a number 1--9 ???
131 });
132 return; }
133  
134 sub defineChoice {
135 my ($qname, $code, $mismatch, $choices, $normalize, $bin) = @_;
136 my $norm = ($normalize ? sub { lc $_[0]; } : sub { $_[0]; });
137 my ($varmacro, $idxmacro) = defined($bin) ? $bin->unlist : (undef, undef);
138 LaTeXML::Package::DefMacroI('\\' . $qname, '{}', sub {
139 my ($gullet, $value) = @_;
140 # Store the normalized value (if applicable)
141 my $nvalue = &$norm(ToString($value));
142 LaTeXML::Package::DefMacro($varmacro, sub { Explode($nvalue); }) if defined($varmacro);
143 # iterate over the possible choices and store them
144 my $ochoice;
145 my $index = 0;
146 my $valid = 0;
147 foreach my $choice (@{$choices}) {
148 if (&$norm(ToString($choice)) eq $nvalue) {
149 $ochoice = $choice;
150 $valid = 1;
151 LaTeXML::Package::DefMacro($idxmacro, Explode(ToString($index))) if defined($idxmacro); }
152 $index += 1; }
153 # find a name for the original macro to store in
154 my @tokens = ();
155 my $orig = '\\ltxml@orig@' . $qname;
156 # if we have chosen a valid index, run $code
157 if ($valid) {
158 if (defined($code)) {
159 LaTeXML::Package::DefMacroI($orig, '{}', $code);
160 push(@tokens, T_CS($orig), T_BEGIN, $value, T_END); } }
161 # else run $mismatch
162 elsif (defined($mismatch)) {
163 LaTeXML::Package::DefMacroI($orig, '{}', $mismatch);
164 push(@tokens, T_CS($orig), T_BEGIN, $value, T_END); }
165 @tokens; });
166 return; }
167  
168 sub defineBoolean {
169 my ($qname, $code, $mismatch, $macroname) = @_;
170 LaTeXML::Package::DefConditional(T_CS("\\if$macroname")); # We might need to $scope here
171 defineChoice($qname, sub {
172 my ($gullet, $value) = @_;
173 # set the value to true (if needed)
174 my @tokens = ();
175 push(@tokens, T_CS('\\' . $macroname . (((lc ToString($value)) eq 'true') ? 'true' : 'false')));
176 # Store and invoke the original macro if needed
177 if ($code) {
178 my $orig = '\\ltxml@@rig@' . $qname;
179 LaTeXML::Package::DefMacroI($orig, '{}', $code);
180 push(@tokens, T_CS($orig), T_BEGIN, $value, T_END); }
181 @tokens; },
182 $mismatch, [("true", "false")], 1);
183 return; }
184  
185 #======================================================================
186 1;
187  
188 __END__