feat(lxp): Add parser option to disable attribute positions #41
Conversation
Omikhleia
force-pushed
the
feat-option-disable-attribute-positions
branch
from
612d99e to
8c2b92f
Compare
Omikhleia
force-pushed
the
feat-option-disable-attribute-positions
branch
from
8c2b92f to
5dbfb96
Compare
| {[1] = "Ierusalimschy, Roberto", | ||
| [2] = "Programming in Lua", | ||
| {[1] = "author", | ||
| [2] = "title", |
| @@ -144,13 +144,16 @@ <h4>Finishing parsing</h4> | |||
| <h4>Constructor</h4> | |||
|
|
|||
| <dl class="reference"> | |||
| <dt><strong>lxp.new(<em>callbacks [, separator[, merge_character_data]]</em>)</strong></dt> | |||
| <dt><strong>lxp.new(<em>callbacks [, separator[, merge_character_data, [attribute_position]]]</em>)</strong></dt> | |||
There was a problem hiding this comment.
should we change this function signature to an options table, instead of positional args?
There was a problem hiding this comment.
That would probably be a more user friendly API, but it would also be a major breaking change. This way the change is non-breaking and people should be able to upgrade without a hitch. The option to change the signature at a later date when we're considering cutting a major release would still be open too. Or provide a new function name for the new signature. Whatever the long term API design would be I'd be in favor of a non-breaking change we can get through and widely distributed over a major version bump that breaks things with little motivation for people to take the dive.
| <dt><strong>lxp.new(<em>callbacks [, separator[, merge_character_data, [attribute_position]]]</em>)</strong></dt> | |
| <dt><strong>lxp.new(<em>callbacks [, separator[, merge_character_data[, attribute_position]]]</em>)</strong></dt> |
There was a problem hiding this comment.
No need to be breaking. Change the signature to new(callbacks[, options]), and just check if options is a string (old format, then also grab merge_character_data), or if it is a table, in which case the options are in the table.
This is probably easier done Lua side than C side.
This PR is a proposal to add an additional flag to disable the attribute positions in the attribute list passed on StartElement.
Rationale:
I understand attribute positions may be interesting in some use cases (e.g. to re-generate some other output respecting the same order), but for use cases where they are not needed, they take useless memory, and useless code if one wants to remove them.
Note:
I also fixed a small mistake in the example that was given in the "manual" (the position list consists in attribute names, not attribute value).
For reference: