| 1 | # /=====================================================================\ # | ||
| 2 | # | LaTeXML::Util::ObjectDB::Entry | # | ||
| 3 | # | Database of Objects for crossreferencing, etc | # | ||
| 4 | # |=====================================================================| # | ||
| 5 | # | Part of LaTeXML: | # | ||
| 6 | # | Public domain software, produced as part of work done by the | # | ||
| 7 | # | United States Government & not subject to copyright in the US. | # | ||
| 8 | # |---------------------------------------------------------------------| # | ||
| 9 | # | Bruce Miller <bruce.miller@nist.gov> #_# | # | ||
| 10 | # | http://dlmf.nist.gov/LaTeXML/ (o o) | # | ||
| 11 | # \=========================================================ooo==U==ooo=/ # | ||
| 12 | package LaTeXML::Util::ObjectDB::Entry; | ||
| 13 | use strict; | ||
| 14 | use warnings; | ||
| 15 | use LaTeXML::Common::XML; | ||
| 16 | |||
| 17 | my $XMLParser = LaTeXML::Common::XML::Parser->new(); # [CONSTANT] | ||
| 18 | |||
| 19 | sub new { | ||
| 20 | my ($class, $key, %data) = @_; | ||
| 21 | return bless { key => $key, %data }, $class; } | ||
| 22 | |||
| 23 | sub key { | ||
| 24 | my ($entry) = @_; | ||
| 25 | return $$entry{key}; } | ||
| 26 | |||
| 27 | sub getAttributes { | ||
| 28 | my ($self) = @_; | ||
| 29 | return keys %$self; } | ||
| 30 | |||
| 31 | # Get/Set a value (column) in the DBRow entry, noting whether it modifies the entry. | ||
| 32 | # Note that XML data is stored in it's serialized form, prefixed by "XML::". | ||
| 33 | sub hasValue { | ||
| 34 | my ($self, $attr) = @_; | ||
| 35 | return exists $$self{$attr}; } | ||
| 36 | |||
| 37 | sub getValue { | ||
| 38 | my ($self, $attr) = @_; | ||
| 39 | return decodeValue($$self{$attr}); } | ||
| 40 | |||
| 41 | sub setValues { | ||
| 42 | my ($self, %avpairs) = @_; | ||
| 43 | foreach my $attr (keys %avpairs) { | ||
| 44 | my $value = encodeValue($avpairs{$attr}); | ||
| 45 | if (!defined $value) { | ||
| 46 | if (defined $$self{$attr}) { | ||
| 47 | delete $$self{$attr}; } } | ||
| 48 | elsif ((!defined $$self{$attr}) || ($$self{$attr} ne $value)) { | ||
| 49 | $$self{$attr} = $value; } } | ||
| 50 | return; } | ||
| 51 | |||
| 52 | sub pushValues { | ||
| 53 | my ($self, $attr, @values) = @_; | ||
| 54 | my $list = $$self{$attr}; | ||
| 55 | foreach my $value (@values) { | ||
| 56 | push(@$list, encodeValue($value)) if defined $value; } | ||
| 57 | return; } | ||
| 58 | |||
| 59 | sub pushNew { | ||
| 60 | my ($self, $attr, @values) = @_; | ||
| 61 | my $list = $$self{$attr}; | ||
| 62 | foreach my $value (@values) { | ||
| 63 | my $value = encodeValue($value); | ||
| 64 | push(@$list, $value) if (defined $value) && !grep { $_ eq $value } @$list; } | ||
| 65 | return; } | ||
| 66 | |||
| 67 | # Note an association with this entry | ||
| 68 | # Roughly equivalent to $$entry{key1}{key2}{...}=1, | ||
| 69 | # but keeps track of modification timestamps. --- not any more! | ||
| 70 | sub noteAssociation { | ||
| 71 | my ($self, @keys) = @_; | ||
| 72 | my $hash = $self; | ||
| 73 | while (@keys) { | ||
| 74 | my $key = shift(@keys); | ||
| 75 | if (defined $$hash{$key}) { | ||
| 76 | $hash = $$hash{$key}; } | ||
| 77 | else { | ||
| 78 | $hash = $$hash{$key} = (@keys ? {} : 1); } } | ||
| 79 | return; } | ||
| 80 | |||
| 81 | # Debugging aid | ||
| 82 | use Text::Wrap; | ||
| 83 | |||
| 84 | sub show { | ||
| 85 | my ($self) = @_; | ||
| 86 | my $string = "ObjectDB Entry for: $$self{key}\n"; | ||
| 87 | foreach my $attr (grep { $_ ne 'key' } keys %{$self}) { | ||
| 88 | my $label = sprintf(' %16s : ', $attr); | ||
| 89 | my $value = showvalue($self->getValue($attr)); | ||
| 90 | # hack around bug in Text::Wrap 2012.0818 | ||
| 91 | my $line; | ||
| 92 | eval { | ||
| 93 | local $LaTeXML::IGNORE_ERRORS = 1; | ||
| 94 | $line = wrap($label, (' ' x 20), $value); }; | ||
| 95 | $string .= (defined $line ? $line : $label . $value) . "\n"; } | ||
| 96 | return $string; } | ||
| 97 | |||
| 98 | sub showvalue { | ||
| 99 | my ($value) = @_; | ||
| 100 | if ((ref $value) =~ /^XML::/) { | ||
| 101 | return $value->toString(1); } | ||
| 102 | elsif (ref $value eq 'HASH') { | ||
| 103 | return "{" . join(', ', map { "$_=>" . showvalue($$value{$_}) } keys %$value) . "}"; } | ||
| 104 | elsif (ref $value eq 'ARRAY') { | ||
| 105 | return "[" . join(', ', map { showvalue($_) } @$value) . "]"; } | ||
| 106 | else { | ||
| 107 | return "$value"; } } | ||
| 108 | |||
| 109 | #====================================================================== | ||
| 110 | # Internal methods to encode/decode values; primarily to serialize/deserialize XML. | ||
| 111 | # Yikes, this ultimately needs to be recursive! | ||
| 112 | sub encodeValue { | ||
| 113 | my ($value) = @_; | ||
| 114 | my $ref = ref $value; | ||
| 115 | if (!defined $value) { | ||
| 116 | return $value; } | ||
| 117 | elsif (!$ref) { | ||
| 118 | return $value; } | ||
| 119 | # The node is cloned so as to copy any inherited namespace nodes. | ||
| 120 | elsif ($ref =~ /^XML::/) { | ||
| 121 | if ($ref eq 'XML::LibXML::DocumentFragment') { | ||
| 122 | my @c = $value->childNodes; | ||
| 123 | if (scalar(@c) > 1) { | ||
| 124 | warn "Encoding XML Document fragment; dropping all except 1st node!"; } | ||
| 125 | $value = $c[0]; } | ||
| 126 | return "XML::" . $value->cloneNode(1)->toString; } | ||
| 127 | elsif ($ref eq 'ARRAY') { | ||
| 128 | return [map { encodeValue($_) } @$value]; } | ||
| 129 | elsif ($ref eq 'HASH') { | ||
| 130 | my %h = map { ($_ => encodeValue($$value{$_})) } keys %$value; | ||
| 131 | return \%h; } | ||
| 132 | else { | ||
| 133 | return $value; } } | ||
| 134 | |||
| 135 | sub decodeValue { | ||
| 136 | my ($value) = @_; | ||
| 137 | my $ref = ref $value; | ||
| 138 | if (!defined $value) { | ||
| 139 | return $value; } | ||
| 140 | elsif ($value =~ /^XML::/) { | ||
| 141 | return $XMLParser->parseChunk(substr($value, 5)); } | ||
| 142 | elsif (!$ref) { | ||
| 143 | return $value; } | ||
| 144 | elsif ($ref eq 'ARRAY') { | ||
| 145 | return [map { decodeValue($_) } @$value]; } | ||
| 146 | elsif ($ref eq 'HASH') { | ||
| 147 | my %h = map { ($_ => decodeValue($$value{$_})) } keys %$value; | ||
| 148 | return \%h; } | ||
| 149 | else { | ||
| 150 | return $value; } } | ||
| 151 | |||
| 152 | #====================================================================== | ||
| 153 | 1; |