update README text and bump LICENSE - xmlparser - XML parser
(HTM) git clone git://git.codemadness.org/xmlparser
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 0acf4adc915dae0ca25cee374189a602f905cdce
(DIR) parent 317a612f61bb72c4b67a0cb8f923c2d37e7bdcec
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sun, 21 Sep 2025 14:25:52 +0200
update README text and bump LICENSE
Diffstat:
M LICENSE | 2 +-
M README | 28 +++++++++++++++++-----------
2 files changed, 18 insertions(+), 12 deletions(-)
---
(DIR) diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
ISC License
-Copyright (c) 2011-2024 Hiltjo Posthuma <hiltjo@codemadness.org>
+Copyright (c) 2011-2025 Hiltjo Posthuma <hiltjo@codemadness.org>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
(DIR) diff --git a/README b/README
@@ -14,8 +14,8 @@ Features
--------
- Relatively small parser.
-- Pretty simple API.
-- Pretty fast.
+- Simple API using callback functions.
+- Fast
- Portable
- No dynamic memory allocation.
@@ -30,29 +30,35 @@ Supports
- CDATA sections.
- Helper function (xml_entitytostr) to convert XML 1.0 / HTML 2.0 named entities
and numeric entities to UTF-8.
-- Reading XML from a fd, string buffer or implement a custom reader:
+- Reading XML from a file descriptor, string buffer or any custom reader:
see: XMLParser.getnext or GETNEXT() macro.
-Caveats
--------
+Design choices and scope
+------------------------
-- It is not a compliant XML parser.
+- Compliance: it is not a fully compliant XML parser, but it supports reading
+ XML data for many practical use-cases, some are:
+ - RSS reader (sfeed)
+ - HTML to plain-text converter (webdump).
+ - HTML extractor for websites (idiotbox/tscrape/frontends).
+- The XML data is not checked for errors so it will continue parsing XML data.
+ However the parser should not crash, hang, etc.
- Performance: data is buffered even if a handler is not set: to make parsing
faster change this code from xml.c.
-- The XML is not checked for errors so it will continue parsing XML data, this
- is by design.
- Internally fixed-size buffers are used, callbacks like XMLParser.xmldata are
called multiple times for the same tag if the data size is bigger than the
internal buffer size (sizeof(XMLParser.data)). To differentiate between new
- calls for data you can use the xml*start and xml*end handlers.
+ calls for data the xml*start and xml*end handlers can be used.
- It does not handle XML white-space rules for tag data. The raw values
including white-space is passed. This is useful in some cases, like for
- HTML <pre> tags.
+ parsing HTML <pre> tags.
- The XML specification has no limits on tag and attribute names. For
simplicity/sanity sake this XML parser takes some liberties. Tag and
attribute names are truncated if they are excessively long.
-- Entity expansions are not parsed as well as DOCTYPE, ATTLIST etc.
+- Security: entity expansions are not handled (can cause "billion laughs
+ attack").
+- DOCTYPE, ATTLIST or DTD declarations are ignored.
Files used