TSDuck v3.38-3675
MPEG Transport Stream Toolkit
Loading...
Searching...
No Matches
ts::xml::Comment Class Reference

Comment in an XML document. More...

#include <tsxmlComment.h>

Inheritance diagram for ts::xml::Comment:
Collaboration diagram for ts::xml::Comment:

Public Member Functions

 Comment (const Comment &other)
 Copy constructor.
 
 Comment (Node *parent, const UString &text, bool last=true)
 Constructor.
 
 Comment (Report &report=(ts::NullReport::Instance()), size_t line=0)
 Constructor.
 
size_t childrenCount () const
 Get the number of children.
 
virtual void clear ()
 Clear the content of the node.
 
virtual Nodeclone () const override
 Clone the content of the node in a dynamically allocated object.
 
UString debug () const
 Build a debug string for the node.
 
size_t depth () const
 Get the depth of an XML element.
 
Documentdocument ()
 Get the document into which the node is located.
 
const Documentdocument () const
 Get the document into which the node is located.
 
NodefirstChild ()
 Get the first child of a node.
 
const NodefirstChild () const
 Get the first child of a node.
 
ElementfirstChildElement ()
 Get the first child Element of a node.
 
const ElementfirstChildElement () const
 Get the first child Element of a node.
 
bool hasChildren () const
 Check if the node has children.
 
NodelastChild ()
 Get the last child.
 
const NodelastChild () const
 Get the last child.
 
size_t lineNumber () const
 Get the line number in input document.
 
void move (Node *newSibling, bool before)
 Move the node before or after another node, potentially to a new parent.
 
void moveAfter (Node *newSibling)
 Move the node after another node, potentially to a new parent.
 
void moveBefore (Node *newSibling)
 Move the node before another node, potentially to a new parent.
 
NodenextSibling ()
 Get the next sibling node.
 
const NodenextSibling () const
 Get the next sibling node.
 
ElementnextSiblingElement ()
 Find the next sibling element.
 
const ElementnextSiblingElement () const
 Find the next sibling element.
 
virtual UString oneLiner () const
 Format the value as a one-liner XML text.
 
Nodeparent ()
 Get the parent's node.
 
const Nodeparent () const
 Get the parent's node.
 
bool preserveSpace () const
 Check if the node or one of its ancestors has attribute xml:space="preserve".
 
NodepreviousSibling ()
 Get the previous sibling node.
 
const NodepreviousSibling () const
 Get the previous sibling node.
 
ElementpreviousSiblingElement ()
 Find the previous sibling element.
 
const ElementpreviousSiblingElement () const
 Find the previous sibling element.
 
virtual void print (TextFormatter &output, bool keepNodeOpen=false) const override
 Format the node for an output XML document.
 
virtual void printClose (TextFormatter &output, size_t levels=std::numeric_limits< size_t >::max()) const
 Print the closing tags for the node.
 
void removeComments (bool recurse)
 Remove all comments in the XML node.
 
void reparent (Node *newParent, bool last=true)
 Attach the node to a new parent.
 
Reportreport () const
 Get a reference to the report object for the XML node.
 
bool ringAlone () const
 Check if the node is alone in its own ring.
 
void ringInsertAfter (RingNode *o)
 Insert this object in a ring after the specified node.
 
void ringInsertBefore (RingNode *o)
 Insert this object in a ring before the specified node.
 
template<typename T >
T * ringNext ()
 Get the next node in the ring.
 
template<typename T >
const T * ringNext () const
 Get the next node in the ring.
 
template<typename T >
T * ringPrevious ()
 Get the previous node in the ring.
 
template<typename T >
const T * ringPrevious () const
 Get the previous node in the ring.
 
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.
 
void ringSwap (RingNode *o)
 Swap this object and another one in their rings.
 
void setValue (const UString &value)
 Set the value of the node.
 
virtual bool stickyOutput () const
 Check if the text shall be stuck to other elements in XML output.
 
virtual const Tweakstweaks () const
 Get a constant reference to the current XML parsing and formatting tweaks for this node.
 
virtual UString typeName () const override
 Return a node type name, mainly for debug purpose.
 
const UStringvalue () const
 Get the value of the node.
 

Protected Member Functions

NodeidentifyNextNode (TextParser &parser)
 Identify the next token in the document.
 
virtual bool parseChildren (TextParser &parser)
 Parse children nodes and add them to the node.
 
virtual bool parseNode (TextParser &parser, const Node *parent) override
 Parse the node.
 
void setPreserveSpace (bool on)
 Called by the subclass when its spaces shall be preserved.
 

Detailed Description

Comment in an XML document.

Constructor & Destructor Documentation

◆ Comment() [1/3]

ts::xml::Comment::Comment ( Report report = (ts::NullReport::Instance()),
size_t  line = 0 
)
explicit

Constructor.

Parameters
[in,out]reportWhere to report errors.
[in]lineLine number in input document.

◆ Comment() [2/3]

ts::xml::Comment::Comment ( Node parent,
const UString text,
bool  last = true 
)

Constructor.

Parameters
[in,out]parentThe parent node into which the comment is added.
[in]textContent of the comment.
[in]lastIf true, the child is added at the end of the list of children. If false, it is added at the beginning.

◆ Comment() [3/3]

ts::xml::Comment::Comment ( const Comment other)

Copy constructor.

Parameters
[in]otherOther instance to copy.

Member Function Documentation

◆ clone()

virtual Node * ts::xml::Comment::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::Comment::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::Comment::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.

◆ parseNode()

virtual bool ts::xml::Comment::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()

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

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.

◆ moveBefore()

void ts::xml::Node::moveBefore ( Node newSibling)
inlineinherited

Move the node before another node, potentially to a new parent.

Parameters
[in,out]newSiblingA new sibling. The node will be moved before this one.

◆ moveAfter()

void ts::xml::Node::moveAfter ( Node newSibling)
inlineinherited

Move the node after another node, potentially to a new parent.

Parameters
[in,out]newSiblingA new sibling. The node will be moved after this one.

◆ move()

void ts::xml::Node::move ( Node newSibling,
bool  before 
)
inherited

Move the node before or after another node, potentially to a new parent.

Parameters
[in,out]newSiblingA new sibling. The node will be moved before or after this one.
[in]beforeIf true, move the node before newSibling, after it otherwise.

◆ parent() [1/2]

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

Get the parent's node.

Returns
The parent's node or a null pointer 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.

◆ tweaks()

virtual const Tweaks & ts::xml::Node::tweaks ( ) const
virtualinherited

Get a constant reference to the current XML parsing and formatting tweaks for this node.

Returns
A constant reference to the XML tweaks to apply. When the node is part of a document, get the global tweaks of the document. Otherwise, get the default tweaks.

Reimplemented in ts::xml::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.

◆ preserveSpace()

bool ts::xml::Node::preserveSpace ( ) const
inherited

Check if the node or one of its ancestors has attribute xml:space="preserve".

Returns
True if spaces shall be preserved.

◆ 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.

◆ previousSiblingElement() [1/2]

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

Find the previous sibling element.

Returns
Element address or zero if not found.

◆ previousSiblingElement() [2/2]

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

Find the previous 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()

◆ removeComments()

void ts::xml::Node::removeComments ( bool  recurse)
inherited

Remove all comments in the XML node.

Parameters
[in]recurseIf true, apply recursively to all children nodes.

◆ printClose()

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

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 in ts::xml::Document, and ts::xml::Element.

◆ oneLiner()

virtual UString ts::xml::Node::oneLiner ( ) const
virtualinherited

Format the value as a one-liner XML text.

Returns
The formatted one-line XML text.

◆ 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.

◆ setPreserveSpace()

void ts::xml::Node::setPreserveSpace ( bool  on)
inlineprotectedinherited

Called by the subclass when its spaces shall be preserved.

Typically called when xml:space="preserve" is encountered.

Parameters
[in]onTrue is spaces shall be preserved.

◆ 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: