To attribute #2465
To attribute #2465
Conversation
…omizing conversion to attribute value, with syntax analogous to revert
…se use toAttribute
… pure text spacing in attribute values
…ttribute, not toString
There was a problem hiding this comment.
Interesting upgrade, looks healthy.
I have a naming comment (no surprise there). The toNoun names are typically used for methods in latexml. The alternative form specifiers tend to have some noun name as with reversion, alias, sizer...
Indeed, toAttribute names methods implemented by our Box-like objects. I think it would be helpful to name the config parameter in the Definition objects slightly differently.
(Aside: one of my related questions was wheter we want a generic ->toAttribute method in Definition.pm, which defaults to ->toString)
A simple distinction would be to swap to for as, namely asAttribute. Another is intoAttribute (Rust has standardized .into() as one reason I thought of that).
The main point of my comment is that the distinction between reversion and revert() is a nice model to follow for ? and toAttribute(). Maybe attributeSpec or attributeForm gets even closer to that...
lib/LaTeXML/Core/Document.pm
Outdated
| @@ -1376,8 +1376,14 @@ sub makeError { | |||
| # [xml:id and namespaced attributes are always allowed] | |||
| sub setAttribute { | |||
| my ($self, $node, $key, $value) = @_; | |||
| return if (ref $value) && ((!blessed($value)) || !$value->can('toAttribute')); | |||
| $value = $value->toAttribute if ref $value; | |||
| return if (ref $value) && ((!blessed($value)) || !$value->can('toAttribute')); | |||
There was a problem hiding this comment.
Would it be useful to emit a Warning if this unusual case is encountered, where $value was e.g. a perl array ref or hash ref? Could be some rare mistake that gets caught quickly with a warning message.
| elsif (ref $spec eq 'CODE') { # If handled by CODE, call it | ||
| $spec = &$spec($self, $self->getArgs); } | ||
| # Now, similar to substituteParameters, but creating a string. | ||
| $spec =~ s/#(#|[1-9]|\w+)/ toAttribute_aux($self,$1)/eg; |
There was a problem hiding this comment.
Hm, I think I understand the code here, but I am wondering if we should have a an example DefConstructor that uses this argument-based toAttribute string form, and a test that exercises it.
There was a problem hiding this comment.
The conceit is that it should work just like reversion.
lib/LaTeXML/Core/Whatsit.pm
Outdated
| $value = $self->getArg(ord($code) - ord('0')); } | ||
| else { | ||
| $value = $self->getProperty($code); } | ||
| $value = $value->toAttribute if (defined $value) && (ref $value); |
There was a problem hiding this comment.
minor, but ref undef works fine, so defined $value is redundnat.
| (the default is C<toString>). | ||
| The I<textstring> string can include C<#1>, C<#2>... | ||
| The I<code> is called with the C<$whatsit> and digested arguments | ||
| and must return a string. |
There was a problem hiding this comment.
Possibly a doc string like this is also needed for the DefEnvironment addition.
|
Yeah, the naming is generally off for all these toNoun things, but I like your |
This PR provides an option
toAttributetoDefConstructor,DefEnvironment(andWhatsits generally) to customize the conversion of a whatsit to an attribute value; its sytax is analogous to that of thereversionoption, being a sub or string, possibly containing#1...This is useful for objects which need the flexibility of a
Whatsit(as opposed to simpleBox) but which are sometimes placed in an attribute value that ends up in the text (or html) of the conversion; In those cases, the value should contain neither XML, nor the TeX reversion (astoStringtypically does). The motivating example is\hskip.The
setAttributemethod ofDocument, when given an object reference as value, will usetoAttributeto turn it into a string, but we need to be careful not to useToStringon such values before they get there.