Various bits of code cleanup; Thanks dginev

Author: brucemiller

lib/LaTeXML/Engine/Base_Utility.pool.ltxml

@@ -136,9 +136,9 @@ sub andSplit {
   return map { ($cs, T_BEGIN, @$_, T_END) } SplitTokens($tokens, T_CS('\and')); }
 
 DefMacro('\lx@splitting{}{}{}', sub {
-    my ($gullet, $op, $delimiters, $tokens) = @_;
-    my @delims = ($delimiters ? $delimiters->unlist : (T_CS('\and')));
-    return map { ($op, T_BEGIN, @$_, T_END) } SplitTokens($tokens, @delims); });
+  my ($gullet, $op, $delimiters, $tokens) = @_;
+  return map { ($op, T_BEGIN, @$_, T_END) }
+    ($delimiters ? SplitTokens($tokens, $delimiters->unlist) : ($tokens)); });
 
 sub orNull {
   return (grep { defined } @_) ? @_ : undef; }
@@ -183,11 +183,11 @@ our %ReplaceableFrontmatterTags = (
 # Digestion is deferred until \maketitle, or something similar,
 # to avoid extra side-effects, particularly when entries
 # (eg. \title, \author) get redefined & replaced.
-sub saveFrontMatter {
+sub queueFrontMatter {
   my ($stomach, $tag, $attr, $command) = @_;
   $tag = ToString($tag);
   AssignValue('frontmatter_raw', [], 'global') unless LookupValue('frontmatter_raw');
-  unsaveFrontMatter($tag) if $ReplaceableFrontmatterTags{$tag};
+  dequeueFrontMatter($tag) if $ReplaceableFrontmatterTags{$tag};
 
   # Convert KeyVals to a hash, but be concerned about multiple values!?!?
   if ($attr && (ref $attr eq 'LaTeXML::Core::KeyVals')) {
@@ -200,7 +200,7 @@ sub saveFrontMatter {
   return; }
 
 # This removes previously stored (but deferred) frontmatter that is being overridden.
-sub unsaveFrontMatter {
+sub dequeueFrontMatter {
   my ($tag, %attr) = @_;
   if (my $frontmatter = LookupValue('frontmatter_raw')) {
     my @keep = ();
@@ -218,13 +218,13 @@ DefPrimitive('\lx@clear@frontmatter {} OptionalKeyVals:Frontmatter', sub {
     my ($stomach, $tag, $kv) = @_;
     my %attr = ($kv ? $kv->getHash : ());
     map { $attr{$_} = ToString($kv->getValue($_)); } keys %attr;
-    unsaveFrontMatter(ToString($tag), %attr);
+    dequeueFrontMatter(ToString($tag), %attr);
     return; });
 
 # Remove all creators with given role (default author)
 DefPrimitive('\lx@clear@creators OptionalKeyVals:Frontmatter', sub {
     my ($stomach, $kv) = @_;
-    unsaveFrontMatter('ltx:creator', role => ($kv && ToString($kv->getValue('role'))) || 'author');
+    dequeueFrontMatter('ltx:creator', role => ($kv && ToString($kv->getValue('role'))) || 'author');
     return; });
 #DefMacro('\lx@clear@creators OptionalKeyVals:Frontmatter', '\lx@clear@frontmatter{ltx:creator)[#1]');
 DefMacro('\lx@clear@creators []', '\lx@clear@frontmatter{ltx:creator}[#1]');
@@ -259,18 +259,16 @@ Tag('ltx:contact',    afterClose => \&cleanTrailingBreak);
 #   ifnew   (only add if no previous entry)
 DefPrimitive('\@add@frontmatter OptionalKeyVals {} OptionalKeyVals {}', sub {
     my ($stomach, $keys, $tag, $attr, $tokens) = @_;
-    saveFrontMatter($stomach, $tag, $attr,
+    queueFrontMatter($stomach, $tag, $attr,
       Invocation(T_CS('\lx@add@frontmatter@now'), $keys, $tag, $attr, $tokens));
     return; });
 
 sub cleanFrontmatterMarks {
   my ($marks, $prefix) = @_;
   $marks  = ToString($marks);
   $prefix = ToString($prefix) || '';
-###  return ($marks ? map { CleanLabel($_, $prefix); } split(',', $marks) : ()); }
   my @marks = ();
   foreach my $mark (split(',', $marks)) {
-    $mark = ToString($mark);
     $mark =~ s/^\s+//; $mark =~ s/\s+$//;
     if ($mark =~ /^\\ref\{\s*([^\}]*)\s*\}$/) {
       $mark = 'LABEL:'. $1; }
@@ -285,14 +283,18 @@ DefPrimitive('\lx@add@frontmatter@now OptionalKeyVals {} OptionalKeyVals:Frontma
     $tag = ToString($tag);
     $kv  = $kv->beDigested($stomach) if $kv;
     my $frontmatter = LookupValue('frontmatter');
-    my $role        = ($kv && ToString($kv->getValue('role'))) || '';
-    my $n           = LookupMapping('num_' . $tag, $role); $n++;
-    AssignMapping('num_' . $tag, $role => $n);
+    my $role        = ($kv && ToString($kv->getValue('role')));
+    my $n           = 0;
     # extract (possibly multiple!) marks
     my @marks = cleanFrontmatterMarks(($kv && $kv->getValues('mark')) || '', '');
-    push(@marks, CleanLabel($n, $role)); # record sequence position as potential contact attachment mark
+    if ($role) {
+      $n = LookupMapping('num_' . $tag, $role); $n++;
+      AssignMapping('num_' . $tag, $role => $n);
+      # record sequence position as potential contact attachment mark
+      push(@marks, CleanLabel($n, $role)); }
     my %attr = (($kv ? $kv->getHash : ()),
-      role => $role, _num => $n, _marks => join(',', @marks));    # replace these...
+      ($role ? (role => $role, _num => $n) : ()),
+      _marks => join(',', @marks));    # replace these...
     my $entry = [$tag, {%attr}, 'place_keeper'];                  # (in case embedded)
     push(@{ $$frontmatter{$tag} }, $entry);
     Debug("ADD $tag: [" . join(',', map { $_ . '=' . ToString($attr{$_}); } sort keys %attr) . "] "
@@ -319,23 +321,24 @@ DefPrimitive('\lx@add@frontmatter@now OptionalKeyVals {} OptionalKeyVals:Frontma
 #   <default> : attach to preceding creator.
 DefPrimitive('\lx@add@contact OptionalKeyVals:Frontmatter {}', sub {
     my ($stomach, $kv, $content) = @_;
-    saveFrontMatter($stomach, 'ltx:contact', $kv, Invocation(T_CS('\lx@add@contact@now'), $kv, $content));
+    queueFrontMatter($stomach, 'ltx:contact', $kv, Invocation(T_CS('\lx@add@contact@now'), $kv, $content));
     return; });
 
 DefPrimitive('\lx@add@contact@now OptionalKeyVals:Frontmatter {}', sub {
 ##DefPrimitive('\lx@add@contact OptionalKeyVals:Frontmatter {}', sub {
     my ($stomach, $kv, $content) = @_;
     my $frontmatter = LookupValue('frontmatter');
     my %options     = ($kv ? $kv->beDigested($stomach)->getHash : ());
-    my $role        = ToString($options{role}) || '';
-    my $n           = LookupMapping('num_contacts', $role); $n++;
-    my $marks       = join(',',
-      cleanFrontmatterMarks($options{mark} || '', ''),
-      ($options{markseq} ? CleanLabel($n, ToString($options{markseq})) : ()));
-    AssignMapping('num_contacts', $role => $n);
-    if (!$options{name} || ! scalar($options{name}->unlist)) {
-      my $cs = T_CS('\lx@contact@' . $role . '@name');
-      $options{name} = DigestText($cs) if LookupDefinition($cs); }
+    my $role        = ToString($options{role});
+    my @marks       = cleanFrontmatterMarks($options{mark} || '', '');
+    if ($role) {
+      my $n           = LookupMapping('num_contacts', $role); $n++;
+      AssignMapping('num_contacts', $role => $n);
+      push(@marks, CleanLabel($n, ToString($options{markseq}))) if $options{markseq};
+      if (!$options{name} || ! scalar($options{name}->unlist)) {
+        my $cs = T_CS('\lx@contact@' . $role . '@name');
+        $options{name} = DigestText($cs) if LookupDefinition($cs); } }
+    my $marks       = join(',', @marks);
     my @allcreators = @{ $$frontmatter{'ltx:creator'} || [] };
     my @creators    = grep { ($$_[1]{role} || '') ne 'pending'; } @allcreators;
     my $ncreators   = scalar(@creators);
@@ -372,8 +375,10 @@ DefPrimitive('\lx@add@contact@now OptionalKeyVals:Frontmatter {}', sub {
       Debug("...adding to  $nprev previous" . ($newonly ? ' new' : ''));
       while (my $creator = pop(@creators)) {
         push(@$creator, $datum);
-        $$creator[1]{"_has$role"} = 1;
-        last if (--$nprev <= 0) || ($newonly && $creators[-1][1]{"_has$role"}); } }
+        if ($role) {
+          $$creator[1]{"_has$role"} = 1;
+          last if $newonly && @creators && $creators[-1][1]{"_has$role"}; }
+        last if (--$nprev <= 0); } }
     return; });
 
 DefConstructor('\lx@make@contact@@ Undigested Undigested {} Undigested',
@@ -429,7 +434,7 @@ DefPrimitive('\lx@set@contact@label Semiverbatim', sub {
 # \@add@to@frontmatter{tag}[label]{content}
 DefPrimitive('\@add@to@frontmatter {} [] {}', sub {
     my ($stomach, $tag, $label, $tokens) = @_;
-    saveFrontMatter($stomach, $tag, undef, Invocation(T_CS('\@add@to@frontmatter@now'), $tag, $label, $tokens));
+    queueFrontMatter($stomach, $tag, undef, Invocation(T_CS('\@add@to@frontmatter@now'), $tag, $label, $tokens));
     return; });
 DefPrimitive('\@add@to@frontmatter@now {} [] {}', sub {
 ##DefPrimitive('\@add@to@frontmatter {} [] {}', sub {
@@ -476,7 +481,7 @@ DefMacro('\lx@add@authors{}',
     # Note: must keep affiliations (after \\) embedded, to simplify clear@author removal
     . '\lx@splitting{\lx@author@and@affil}{\and,\And}{#1}');
 DefMacro('\lx@author@and@affil{}', '\lx@author@and@affil@#1\\\\\done');
-DefMacro('\lx@author@and@affil@ Until:\\\\ Until:\\done',
+DefMacro('\lx@author@and@affil@ Until:\\\\ Until:\done',
   '\ifx.#2.\lx@add@creator[role=author]{#1}'
     . '\else\lx@add@creator[role=author]{#1\lx@add@contact[role=affiliation]{#2}}\fi');
 
@@ -512,15 +517,13 @@ sub digestFrontMatter {
     AssignValue('frontmatter_raw', undef, 'global'); }
   my $frontmatter = LookupValue('frontmatter');
   my $digested    = {};
-  # Add punctuation to all ltx:creators, now that we know how many of each.
+  # Add punctuation to all ltx:creators, now that we know how many of each role.
   if (my $list = $$frontmatter{'ltx:creator'}) {
     foreach my $item (@$list) {
       my ($tag, $attr, @stuff) = @$item;
-      my $role = $$attr{role};
-      my $i    = $$attr{_num};
-      #        my $n = LookupMapping(num_creators => $role);
-      my $n = LookupMapping('num_ltx:creator' => $role);
-      if ((defined $i) && ($i > 1)) {
+      if($$attr{role} && (defined $$attr{_num}) && ($$attr{_num} > 1)){
+        my $i    = $$attr{_num};
+        my $n = LookupMapping('num_ltx:creator' => $$attr{role});
         $$attr{before} = DigestText(($i >= $n ? T_CS('\lx@author@conj') : T_CS('\lx@author@sep'))); } } }
   $stomach->egroup;
   return; }
@@ -607,23 +610,17 @@ Tag('ltx:document', 'afterOpen:late' => sub {
     insertFrontMatter($_[0]) unless LookupValue('frontmatter_deferred'); });
 # Request Frontmatter to appear HERE (if not already done),
 # deferring it from document begin.
-# NOTE: I *think* this is where ALL the digestion of frontmatter should be happening
-# NOTE: What exactly are in @boxes? Seems that it should mostly be empty (side effects only)?
+# This should be where ALL the digestion of frontmatter happens
 DefConstructor('\lx@frontmatterhere', sub { insertFrontMatter($_[0]); },
   afterDigest => sub {
     my ($stomach)   = @_;
-    my @boxes       = ();
     my $frontmatter = LookupValue('frontmatter');
     digestFrontMatter();
     AssignValue(frontmatter_deferred => 1, 'global');
-    return @boxes; });
+    return; });
 DefPrimitiveI('\lx@frontmatter@fallback', undef, sub {
     my ($stomach) = @_;
-    my @boxes = ();
-    # if (my $frontmatter_tks = LookupValue('@at@begin@maketitle')) {
-    #   push(@boxes, $stomach->digest(Tokens(@$frontmatter_tks)));
-    #   AssignValue('@at@begin@maketitle', undef, 'global'); }
-    return @boxes; });
+    return; });                 # ?
 
 # Maintain a list of classes that apply to the document root.
 # This might involve global style options, like leqno.