Skip to content

feat(lxp): Add parser option to disable attribute positions #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Omikhleia wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat(lxp): Add parser option to disable attribute positions #41

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dbfb96
feat(lxp): Add parser option to disable attribute positions
Omikhleia Dec 6, 2024
d612402
docs: fix description of attribute_position in the documentation
Omikhleia Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions docs/manual.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Comment thread
Tieske marked this conversation as resolved.
Outdated
<dd>The parser is created by a call to the function <strong>lxp.new</strong>,
which returns the created parser or raises a Lua error. It
receives the callbacks table and optionally the parser <a href="#separator">
separator character</a> used in the namespace expanded element names.
If <em>merge_character_data</em> is false then LuaExpat will not combine multiple
CharacterData calls into one. For more info on this behaviour see CharacterData below.</dd>
CharacterData calls into one. For more info on this behaviour see CharacterData below.
If <em>attribute_position</em> is false then LuaExpat will not include the
attribute position in the attributes table. For more info on this behaviour see
StartElement below.</dd>
</dl>

<h4>Methods</h4>
Expand Down Expand Up @@ -424,7 +427,8 @@ <h4>Callbacks</h4>
every attribute in the element start tag and entries for the
default attributes for that element.<br/>
The attributes are listed by name (including the inherited ones)
and by position (inherited attributes are not considered in the
and, unless <em>attribute_position</em> is set to false when calling
<em>lxp.new()</em>, by position (inherited attributes are not considered in the
position list).<br/>
As an example if the <em>book</em> element has attributes
<em>author</em>, <em>title</em> and an optional <em>format</em>
Expand All @@ -434,8 +438,8 @@ <h4>Callbacks</h4>
</pre>
would be represented as<br/>
<pre class="example">
{[1] = "Ierusalimschy, Roberto",
[2] = "Programming in Lua",
{[1] = "author",
[2] = "title",

@Tieske Tieske Dec 9, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch!

author = "Ierusalimschy, Roberto",
format = "printed",
title = "Programming in Lua"}
Expand Down
5 changes: 4 additions & 1 deletion src/lxplib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ struct lxp_userdata {
enum XPState state;
luaL_Buffer *b; /* to concatenate sequences of cdata pieces */
int bufferCharData; /* whether to buffer cdata pieces */
int attributePosition; /* whether to include attribute position */
};

typedef struct lxp_userdata lxp_userdata;
Expand Down Expand Up @@ -201,7 +202,7 @@ static void f_DefaultExpand (void *ud, const char *data, int len) {
static void f_StartElement (void *ud, const char *name, const char **attrs) {
lxp_userdata *xpu = (lxp_userdata *)ud;
lua_State *L = xpu->L;
int lastspec = XML_GetSpecifiedAttributeCount(xpu->parser) / 2;
int lastspec = xpu->attributePosition != 0 ? XML_GetSpecifiedAttributeCount(xpu->parser) / 2 : 0;
int i = 1;
if (getHandle(xpu, StartElementKey) == 0) return; /* no handle */
lua_pushstring(L, name);
Expand Down Expand Up @@ -546,9 +547,11 @@ static void checkcallbacks (lua_State *L) {

static int lxp_make_parser (lua_State *L) {
XML_Parser p;
int attributePosition = (lua_type(L, 4) != LUA_TBOOLEAN) || (lua_toboolean(L, 4) != 0);
int bufferCharData = (lua_type(L, 3) != LUA_TBOOLEAN) || (lua_toboolean(L, 3) != 0);
char sep = *luaL_optstring(L, 2, "");
lxp_userdata *xpu = createlxp(L);
xpu->attributePosition = attributePosition;
xpu->bufferCharData = bufferCharData;
p = xpu->parser = (sep == '\0') ? XML_ParserCreate(NULL) :
XML_ParserCreateNS(NULL, sep);
Expand Down