From b5aaaefa1f79c23855698af5a4cf7e79c6feb5df Mon Sep 17 00:00:00 2001
From: "Fred L. Drake, Jr."
Date: Wed, 8 Oct 2003 03:32:25 +0000
Subject: [PATCH] Added documentation for the pre-processor macros used to
configure Expat.
---
expat/doc/reference.html | 51 ++++++++++++++++++++++++++++++++++++++++
expat/doc/style.css | 7 ++++++
2 files changed, 58 insertions(+)
diff --git a/expat/doc/reference.html b/expat/doc/reference.html
index 46417279..bc2efc6f 100644
--- a/expat/doc/reference.html
+++ b/expat/doc/reference.html
@@ -607,6 +607,57 @@ arguments:
In order to read an external DTD, you also have to set an external
entity reference handler as described above.
+Configuring Expat Using the Pre-Processor
+
+Expat's feature set can be configured using a small number of
+pre-processor definitions. The definition of this symbols does not
+affect the set of entry points for Expat, only the behavior of the API
+and the definition of character types in the case of
+XML_UNICODE_WCHAR_T
. The symbols are:
+
+
+- XML_DTD
+- Include support for using and reporting DTD-based content. If
+this is defined, default attribute values from the DTD are reported
+and attribute value normalization occurs based on the type of
+attributes. Callbacks can be registered which report information from
+the DTD (including content models and attribute definitions) only if
+this is defined. Without this, Expat has a smaller memory footprint
+and can be faster.
+
+- XML_NS
+- When defined, support for the Namespaces in XML
+specification is included.
+
+- XML_UNICODE
+- When defined, character data reported to the application is
+encoded in UTF-16 using wide characters of the type
+
XML_Char
. This is implied if
+XML_UNICODE_WCHAR_T
is defined.
+
+ - XML_UNICODE_WCHAR_T
+- If defined, causes the
XML_Char
character type to be
+defined using the wchar_t
type; otherwise, unsigned
+short
is used. Defining this implies
+XML_UNICODE
.
+
+- XML_CONTEXT_BYTES
+- The number of input bytes of markup context which the parser will
+ensure are available for reporting via
XML_GetInputContext
. This is
+normally set to 1024. If this is not defined, the input context will
+not be available and XML_GetInputContext
will always report NULL. Without
+this, Expat has a smaller memory footprint and can be faster.
+
+- XML_STATIC
+- On Windows, this should be set if Expat is going to be linked
+statically with the code that calls it; this is required to get all
+the right MSVC magic annotations correct. This is ignored on other
+platforms.
+
+
diff --git a/expat/doc/style.css b/expat/doc/style.css
index 6f488607..d56cddeb 100644
--- a/expat/doc/style.css
+++ b/expat/doc/style.css
@@ -49,3 +49,10 @@ body {
dd {
margin-bottom: 2em;
}
+
+.cpp-symbols dt {
+ font-family: monospace;
+}
+.cpp-symbols dd {
+ margin-bottom: 1em;
+}