donner::svg::parser::SVGParser Class Reference

Parse an SVG XML document. More...

#include "donner/svg/parser/SVGParser.h"

Classes
struct	Options
	Options to modify the parsing behavior. More...

Static Public Member Functions
static ParseResult< SVGDocument >	ParseSVG (std::string_view source, ParseWarningSink &warningSink, Options options={}, SVGDocument::Settings settings={}) noexcept
	Parses an SVG XML document from a string (typically the contents of a .svg file).
static ParseResult< SVGDocument >	ParseXMLDocument (xml::XMLDocument &&xmlDocument, ParseWarningSink &warningSink, Options options={}, SVGDocument::Settings settings={}) noexcept
	Parses an SVG XML document from an XML document tree.

Static Public Attributes
static constexpr size_t	kDefaultMaximumInputSize = 16 * 1024 * 1024
	Default maximum number of source or expanded SVG bytes accepted from untrusted input.
static constexpr size_t	kDefaultMaximumParsedPayloadSize = 64 * 1024 * 1024
	Default retained dynamic payload envelope for one untrusted SVG document.
static constexpr size_t	kDefaultMaximumContentProjectionChunks = 4096
	Default maximum direct text/CDATA chunks projected into one SVG element.
static constexpr size_t	kDefaultMaximumTreeNodes = 8 * 1024
	Default maximum XML tree nodes visited while converting a document into SVG components.
static constexpr size_t	kDefaultMaximumTreeDepth = 256
	Default maximum SVG element depth visited during XML-to-SVG conversion.

Detailed Description

Parse an SVG XML document.

Elements outside the SVG namespace are retained in the tree as unknown elements rather than detached, so whole-tree consumers (attribute selectors, export checks, source projection) see a complete document. They are marked non-rendering: neither a foreign element nor its subtree paints, matching how conforming SVG consumers treat foreign content. A retained foreign subtree counts against Options::maximumTreeNodes and Options::maximumTreeDepth like any other content, and reports one unsupported-namespace warning at the top of the subtree.

Member Function Documentation

ParseSVG()

ParseResult< SVGDocument > donner::svg::parser::SVGParser::ParseSVG ( std::string_view source, ParseWarningSink & warningSink, Options options = {}, SVGDocument::Settings settings = {} )

staticnoexcept

Parses an SVG XML document from a string (typically the contents of a .svg file).

The input buffer does not need to be null-terminated, but if there are embedded null characters parsing will stop. Gzip-compressed input (SVGZ) is detected and decompressed automatically.

Parameters

source	Input buffer containing the SVG XML document. Will not be modified.
warningSink	Sink to collect warnings encountered during parsing.
options	Options to modify the parsing behavior.
settings	Document settings, including the resource loader and processing mode.

Returns

Parsed SVGDocument, or an error if a fatal error is encountered.

Examples

geode_embed.cc, svg_animation.cc, svg_filter_interaction.cc, svg_quickstart.cc, svg_text_interaction.cc, svg_to_png.cc, and svg_tree_interaction.cc.

ParseXMLDocument()

ParseResult< SVGDocument > donner::svg::parser::SVGParser::ParseXMLDocument ( xml::XMLDocument && xmlDocument, ParseWarningSink & warningSink, Options options = {}, SVGDocument::Settings settings = {} )

staticnoexcept

Parses an SVG XML document from an XML document tree.

Parameters

xmlDocument	XML document to parse.
warningSink	Sink to collect warnings encountered during parsing.
options	Options to modify the parsing behavior.
settings	Document settings, including the resource loader and processing mode.

Returns

Parsed SVGDocument, or an error if a fatal error is encountered.

---

The documentation for this class was generated from the following file:

• donner/svg/parser/SVGParser.h