TSDuck Version 3.29-2595 (TSDuck - The MPEG Transport Stream Toolkit)
ts::xml::Document Class Reference

Representation of an XML document. More...

Inheritance diagram for ts::xml::Document:
Collaboration diagram for ts::xml::Document:

Public Member Functions

 Document (const Document &other)
 Copy constructor. More...
 
 Document (Report &report=(*(static_cast< ts::Report * >(ts::NullReport::Instance()))))
 Constructor. More...
 
size_t childrenCount () const
 Get the number of children. More...
 
virtual void clear ()
 Clear the content of the node. More...
 
virtual Nodeclone () const override
 Clone the content of the node in a dynamically allocated object. More...
 
UString debug () const
 Build a debug string for the node. More...
 
size_t depth () const
 Get the depth of an XML element. More...
 
Documentdocument ()
 Get the document into which the node is located. More...
 
const Documentdocument () const
 Get the document into which the node is located. More...
 
NodefirstChild ()
 Get the first child of a node. More...
 
const NodefirstChild () const
 Get the first child of a node. More...
 
ElementfirstChildElement ()
 Get the first child Element of a node. More...
 
const ElementfirstChildElement () const
 Get the first child Element of a node. More...
 
bool hasChildren () const
 Check if the node has children. More...
 
Elementinitialize (const UString &rootName, const UString &declaration=UString())
 Initialize the document. More...
 
NodelastChild ()
 Get the last child. More...
 
const NodelastChild () const
 Get the last child. More...
 
size_t lineNumber () const
 Get the line number in input document. More...
 
bool load (const UString &fileName, bool search=true, bool stdInputIfEmpty=false)
 Load and parse an XML file. More...
 
bool load (std::istream &strm)
 Load and parse an XML file. More...
 
NodenextSibling ()
 Get the next sibling node. More...
 
const NodenextSibling () const
 Get the next sibling node. More...
 
ElementnextSiblingElement ()
 Find the next sibling element. More...
 
const ElementnextSiblingElement () const
 Find the next sibling element. More...
 
Nodeparent ()
 Get the parent's node. More...
 
const Nodeparent () const
 Get the parent's node. More...
 
bool parse (const UString &text)
 Parse an XML document. More...
 
bool parse (const UStringList &lines)
 Parse an XML document. More...
 
NodepreviousSibling ()
 Get the previous sibling node. More...
 
const NodepreviousSibling () const
 Get the previous sibling node. More...
 
virtual void print (TextFormatter &output, bool keepNodeOpen=false) const override
 Format the node for an output XML document. More...
 
virtual void printClose (TextFormatter &output, size_t levels=std::numeric_limits< size_t >::max()) const override
 Print the closing tags for the node. More...
 
virtual void reparent (Node *newParent, bool last=true)
 Attach the node to a new parent. More...
 
Reportreport () const
 Get a reference to the report object for the XML node. More...
 
bool ringAlone () const
 Check if the node is alone in its own ring. More...
 
void ringInsertAfter (RingNode *o)
 Insert this object in a ring after the specified node. More...
 
void ringInsertBefore (RingNode *o)
 Insert this object in a ring before the specified node. More...
 
template<typename T >
T * ringNext ()
 Get the next node in the ring. More...
 
template<typename T >
const T * ringNext () const
 Get the next node in the ring. More...
 
template<typename T >
T * ringPrevious ()
 Get the previous node in the ring. More...
 
template<typename T >
const T * ringPrevious () const
 Get the previous node in the ring. More...
 
void ringRemove ()
 Remove the node from the ring it belongs to and creates its own ring.
 
size_t ringSize () const
 Count the number of element in the ring. More...
 
void ringSwap (RingNode *o)
 Swap this object and another one in their rings. More...
 
ElementrootElement ()
 Get the root element of the document. More...
 
const ElementrootElement () const
 Get the root element of the document. More...
 
bool save (const UString &fileName, size_t indent=2, bool stdOutputIfEmpty=false)
 Save an XML file. More...
 
void setTweaks (const Tweaks &tw)
 Set the global XML parsing and formatting tweaks for the document. More...
 
void setValue (const UString &value)
 Set the value of the node. More...
 
virtual bool stickyOutput () const
 Check if the text shall be stuck to other elements in XML output. More...
 
virtual UString toString () const override
 Convert to a string object. More...
 
virtual const Tweakstweaks () const override
 Get a constant reference to the global XML parsing and formatting tweaks for the document. More...
 
virtual UString typeName () const override
 Return a node type name, mainly for debug purpose. More...
 
const UStringvalue () const
 Get the value of the node. More...
 

Static Public Member Functions

static UString DisplayFileName (const UString &name, bool stdInputIfEmpty=false)
 Get a suitable display name for an XML file name or inline content. More...
 
static bool IsInlineXML (const UString &name)
 Check if a "file name" is in fact inline XML content instead of a file name. More...
 

Protected Member Functions

NodeidentifyNextNode (TextParser &parser)
 Identify the next token in the document. More...
 
virtual bool parseChildren (TextParser &parser)
 Parse children nodes and add them to the node. More...
 
virtual bool parseNode (TextParser &parser, const Node *parent) override
 Parse the node. More...
 

Detailed Description

Representation of an XML document.

Constructor & Destructor Documentation

◆ Document() [1/2]

ts::xml::Document::Document ( Report report = (*(static_cast< ts::Report * >(ts::NullReport::Instance()))))
explicit

Constructor.

Parameters
[in,out]reportWhere to report errors.

◆ Document() [2/2]

ts::xml::Document::Document ( const Document other)

Copy constructor.

Parameters
[in]otherOther instance to copy.

Member Function Documentation

◆ parse() [1/2]

bool ts::xml::Document::parse ( const UStringList lines)

Parse an XML document.

Parameters
[in]linesList of text lines forming the XML document.
Returns
True on success, false on error.

◆ parse() [2/2]

bool ts::xml::Document::parse ( const UString text)

Parse an XML document.

Parameters
[in]textThe XML document.
Returns
True on success, false on error.

◆ load() [1/2]

bool ts::xml::Document::load ( const UString fileName,
bool  search = true,
bool  stdInputIfEmpty = false 
)

Load and parse an XML file.

Parameters
[in]fileNameName of the XML file to load. If fileName starts with "<?xml", this is considered as "inline XML content". The document is loaded from this string instead of reading a file.
[in]searchIf true, use a search algorithm for the XML file: If fileName is not found and does not contain any directory part, search this file in the following places:
  • Directory of the current executable.
  • All directories in TSPLUGINS_PATH environment variable.
  • All directories in LD_LIBRARY_PATH environment variable (UNIX only).
  • All directories in PATH (UNIX) or Path (Windows) environment variable.
[in]stdInputIfEmptyIf true and if fileName is empty or "-", read the standard input.
Returns
True on success, false on error.

◆ load() [2/2]

bool ts::xml::Document::load ( std::istream &  strm)

Load and parse an XML file.

Parameters
[in,out]strmA standard text stream in input mode.
Returns
True on success, false on error.

◆ save()

bool ts::xml::Document::save ( const UString fileName,
size_t  indent = 2,
bool  stdOutputIfEmpty = false 
)

Save an XML file.

Parameters
[in]fileNameName of the XML file to save.
[in]indentIndentation width of each level.
[in]stdOutputIfEmptyIf true and if fileName is empty or "-", writes to the standard output.
Returns
True on success, false on error.

◆ IsInlineXML()

static bool ts::xml::Document::IsInlineXML ( const UString name)
static

Check if a "file name" is in fact inline XML content instead of a file name.

Parameters
[in]nameA file name string.
Returns
True if name contains inline XML content, false otherwise.

◆ DisplayFileName()

static UString ts::xml::Document::DisplayFileName ( const UString name,
bool  stdInputIfEmpty = false 
)
static

Get a suitable display name for an XML file name or inline content.

Parameters
[in]nameA file name string.
[in]stdInputIfEmptyIf true and if fileName is empty, reads the standard input.
Returns
A suitable string to display.

◆ rootElement() [1/2]

const Element* ts::xml::Document::rootElement ( ) const
inline

Get the root element of the document.

Returns
The root element of the document or zero if there is none.

◆ rootElement() [2/2]

Element* ts::xml::Document::rootElement ( )
inline

Get the root element of the document.

Returns
The root element of the document or zero if there is none.

◆ initialize()

Element* ts::xml::Document::initialize ( const UString rootName,
const UString declaration = UString() 
)

Initialize the document.

The initial declaration and root are created.

Parameters
[in]rootNameName of the root element to create.
[in]declarationOptional XML declaration. When omitted, the standard declaration is used, specifying UTF-8 as format.
Returns
New root element of the document or null on error.

◆ tweaks()

virtual const Tweaks& ts::xml::Document::tweaks ( ) const
overridevirtual

Get a constant reference to the global XML parsing and formatting tweaks for the document.

Returns
A constant reference to the global XML tweaks.

Reimplemented from ts::xml::Node.

◆ setTweaks()

void ts::xml::Document::setTweaks ( const Tweaks tw)
inline

Set the global XML parsing and formatting tweaks for the document.

Parameters
[in]twThe new global XML tweaks.

◆ toString()

virtual UString ts::xml::Document::toString ( ) const
overridevirtual

Convert to a string object.

Returns
This object, converted as a string.

Implements ts::StringifyInterface.

◆ clone()

virtual Node* ts::xml::Document::clone ( ) const
overridevirtual

Clone the content of the node in a dynamically allocated object.

This virtual method must be implemented by subclasses to allocate a object of the right class.

Returns
The address of a new XML node of the same class as this object, same content, same structure.

Implements ts::xml::Node.

◆ typeName()

virtual UString ts::xml::Document::typeName ( ) const
overridevirtual

Return a node type name, mainly for debug purpose.

Returns
Node type name.

Implements ts::xml::Node.

◆ print()

virtual void ts::xml::Document::print ( TextFormatter output,
bool  keepNodeOpen = false 
) const
overridevirtual

Format the node for an output XML document.

Parameters
[in,out]outputThe output object to format the XML document.
[in]keepNodeOpenIf true, keep the node open so that children may be printed later.

Implements ts::xml::Node.

◆ printClose()

virtual void ts::xml::Document::printClose ( TextFormatter output,
size_t  levels = std::numeric_limits< size_t >::max() 
) const
overridevirtual

Print the closing tags for the node.

Typically used after print() when keepNodeOpen was true. The default implementation is to do nothing. Subclasses may replace this.

Parameters
[in,out]outputThe output object to format the XML document.
[in]levelsNumber of levels to close. By default, close the complete document. If zero, no output is produced.

Reimplemented from ts::xml::Node.

◆ parseNode()

virtual bool ts::xml::Document::parseNode ( TextParser parser,
const Node parent 
)
overrideprotectedvirtual

Parse the node.

Parameters
[in,out]parserThe document parser. On input, the current position of the parser after the tag which identified the node ("<?", "<!--", etc.) On output, it must be after the last character of the node.
[in]parentCandidate parent node, for information only, do not modify. Can be null.
Returns
True on success, false on error.

Implements ts::xml::Node.

◆ lineNumber()

size_t ts::xml::Node::lineNumber ( ) const
inlineinherited

Get the line number in input document.

Returns
The line number in input document, zero if the node was built programmatically.

◆ clear()

virtual void ts::xml::Node::clear ( )
virtualinherited

Clear the content of the node.

The node becomes empty but remains attached to its parent.

Reimplemented in ts::xml::Element.

◆ reparent()

virtual void ts::xml::Node::reparent ( Node newParent,
bool  last = true 
)
virtualinherited

Attach the node to a new parent.

The node is first detached from its previous parent.

Parameters
[in,out]newParentNew parent. If zero, the node becomes orphan. In that case, the node will no longer be freed by its parent and must be explicitly deleted.
[in]lastIf true, the child is added at the end of the list of children. If false, it is added at the beginning.

◆ parent() [1/2]

const Node* ts::xml::Node::parent ( ) const
inlineinherited

Get the parent's node.

Returns
The parent's node or zero if this is a top-level document.

◆ parent() [2/2]

Node* ts::xml::Node::parent ( )
inlineinherited

Get the parent's node.

Returns
The parent's node or zero if this is a top-level document.

◆ document() [1/2]

const Document* ts::xml::Node::document ( ) const
inlineinherited

Get the document into which the node is located.

Returns
The node's document or zero if there is no document.

◆ document() [2/2]

Document* ts::xml::Node::document ( )
inherited

Get the document into which the node is located.

Returns
The node's document or zero if there is no document.

◆ depth()

size_t ts::xml::Node::depth ( ) const
inherited

Get the depth of an XML element.

Returns
The depth of the element, ie. the number of ancestors.

◆ hasChildren()

bool ts::xml::Node::hasChildren ( ) const
inlineinherited

Check if the node has children.

Returns
True if the node has children.

◆ childrenCount()

size_t ts::xml::Node::childrenCount ( ) const
inlineinherited

Get the number of children.

Returns
The number of children.

◆ firstChild() [1/2]

const Node* ts::xml::Node::firstChild ( ) const
inlineinherited

Get the first child of a node.

Returns
The first child of the node or zero if there is no children.

◆ firstChild() [2/2]

Node* ts::xml::Node::firstChild ( )
inlineinherited

Get the first child of a node.

Returns
The first child of the node or zero if there is no children.

◆ lastChild() [1/2]

const Node* ts::xml::Node::lastChild ( ) const
inlineinherited

Get the last child.

Returns
The last child or zero if there is none.

◆ lastChild() [2/2]

Node* ts::xml::Node::lastChild ( )
inlineinherited

Get the last child.

Returns
The last child or nullptr if there is none.

◆ nextSibling() [1/2]

const Node* ts::xml::Node::nextSibling ( ) const
inlineinherited

Get the next sibling node.

Returns
The next sibling node or zero if the node is the last child.

◆ nextSibling() [2/2]

Node* ts::xml::Node::nextSibling ( )
inherited

Get the next sibling node.

Returns
The next sibling node or zero if the node is the last child.

◆ previousSibling() [1/2]

const Node* ts::xml::Node::previousSibling ( ) const
inlineinherited

Get the previous sibling node.

Returns
The previous sibling node or zero if the node is the first child.

◆ previousSibling() [2/2]

Node* ts::xml::Node::previousSibling ( )
inherited

Get the previous sibling node.

Returns
The previous sibling node or zero if the node is the first child.

◆ firstChildElement() [1/2]

const Element* ts::xml::Node::firstChildElement ( ) const
inlineinherited

Get the first child Element of a node.

Returns
The first child Element of the node or zero if there is no child Element.

◆ firstChildElement() [2/2]

Element* ts::xml::Node::firstChildElement ( )
inherited

Get the first child Element of a node.

Returns
The first child Element of the node or zero if there is no child Element.

◆ nextSiblingElement() [1/2]

const Element* ts::xml::Node::nextSiblingElement ( ) const
inlineinherited

Find the next sibling element.

Returns
Element address or zero if not found.

◆ nextSiblingElement() [2/2]

Element* ts::xml::Node::nextSiblingElement ( )
inherited

Find the next sibling element.

Returns
Element address or zero if not found.

◆ value()

const UString& ts::xml::Node::value ( ) const
inlineinherited

Get the value of the node.

The semantic of the value depends on the node subclass:

  • Comment: Content of the comment, without "<!--" and "-->".
  • Declaration: Content of the declaration, without "<?" and "?>".
  • Document: Empty.
  • Element: Name of the element.
  • Text: Text content of the element, including spaces and new-lines.
  • Unknown: Content of the tag, probably an uninterpreted DTD.
Returns
A constant reference to the node value, as a string.

◆ setValue()

void ts::xml::Node::setValue ( const UString value)
inlineinherited

Set the value of the node.

Parameters
[in]valueNew value to set.
See also
value()

◆ stickyOutput()

virtual bool ts::xml::Node::stickyOutput ( ) const
virtualinherited

Check if the text shall be stuck to other elements in XML output.

Returns
True if the text shall be stuck to other elements. False by default.

Reimplemented in ts::xml::Text.

◆ debug()

UString ts::xml::Node::debug ( ) const
inherited

Build a debug string for the node.

Returns
A debug string for the node.

◆ report()

Report& ts::xml::Node::report ( ) const
inlineinherited

Get a reference to the report object for the XML node.

Returns
A reference to the report object for the XML node.

◆ identifyNextNode()

Node* ts::xml::Node::identifyNextNode ( TextParser parser)
protectedinherited

Identify the next token in the document.

Parameters
[in,out]parserThe document parser.
Returns
A new node or zero either at end of document or before a "</" sequence. The returned node, when not zero, is not yet linked to its parent and siblings. When the returned node is not zero, the parser is located after the tag which identified the node ("<?", "<!--", etc.)

◆ parseChildren()

virtual bool ts::xml::Node::parseChildren ( TextParser parser)
protectedvirtualinherited

Parse children nodes and add them to the node.

Stop either at end of document or before a "</" sequence or on error.

Parameters
[in,out]parserThe document parser.
Returns
True on success, false on error.

◆ ringAlone()

bool ts::RingNode::ringAlone ( ) const
inlineinherited

Check if the node is alone in its own ring.

Returns
True if the node is alone in its own ring.

◆ ringInsertAfter()

void ts::RingNode::ringInsertAfter ( RingNode o)
inherited

Insert this object in a ring after the specified node.

Parameters
[in]oA node of a ring. This object is inserted after o in the ring.

◆ ringInsertBefore()

void ts::RingNode::ringInsertBefore ( RingNode o)
inherited

Insert this object in a ring before the specified node.

Parameters
[in]oA node of a ring. This object is inserted before o in the ring.

◆ ringSwap()

void ts::RingNode::ringSwap ( RingNode o)
inherited

Swap this object and another one in their rings.

If the two objects belong to the same ring, their positions are swapped. If they belong to distinct rings, they also move to each other's ring.

Parameters
[in]oThe node to swap with.

◆ ringNext() [1/2]

template<typename T >
T* ts::RingNode::ringNext ( )
inlineinherited

Get the next node in the ring.

Template Parameters
TA superclass of RingNode, the expected type of the next object in the ring.
Returns
Address of the next node in the ring or zero if the next node is not a subclass of T.

◆ ringNext() [2/2]

template<typename T >
const T* ts::RingNode::ringNext ( ) const
inlineinherited

Get the next node in the ring.

Template Parameters
TA superclass of RingNode, the expected type of the next object in the ring.
Returns
Address of the next node in the ring or zero if the next node is not a subclass of T.

◆ ringPrevious() [1/2]

template<typename T >
T* ts::RingNode::ringPrevious ( )
inlineinherited

Get the previous node in the ring.

Template Parameters
TA superclass of RingNode, the expected type of the previous object in the ring.
Returns
Address of the previous node in the ring or zero if the previous node is not a subclass of T.

◆ ringPrevious() [2/2]

template<typename T >
const T* ts::RingNode::ringPrevious ( ) const
inlineinherited

Get the previous node in the ring.

Template Parameters
TA superclass of RingNode, the expected type of the previous object in the ring.
Returns
Address of the previous node in the ring or zero if the previous node is not a subclass of T.

◆ ringSize()

size_t ts::RingNode::ringSize ( ) const
inherited

Count the number of element in the ring.

Warning: This method has a linear response time, avoid using it when possible.

Returns
The number of nodes in the ring.

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