Name
Data::Edit::Xml - Edit data held in Xml format
Synopsis
use Data::Edit::Xml;
say STDERR Data::Edit::Xml::new(inputString=><<END)-> # Docbook
<sli>
<li>
<p>Diagnose the problem</p>
<p>This can be quite difficult</p>
<p>Sometimes impossible</p>
</li>
<li>
<p><pre>ls -la</pre></p>
<p><pre>
drwxr-xr-x 2 phil phil 4096 Jun 15 2016 Desktop
drwxr-xr-x 2 phil phil 4096 Nov 9 20:26 Downloads
</pre></p>
</li>
</sli>
END
by(sub # Transform Docbook to Dita
{my ($o, $p) = @_;
if ($o->at(qw(pre p li sli)) and $o->isOnlyChild)
{$o->change($p->isFirst ? qw(cmd) : qw(stepresult));
$p->unwrap;
}
elsif ($o->at(qw(li sli)) and $o->over(qr(\Ap( p)+\Z)))
{$_->change($_->isFirst ? qw(cmd) : qw(info)) for $o->contents;
}
})->by(sub
{my ($o) = @_;
$o->change(qw(step)) if $o->at(qw(li sli));
$o->change(qw(steps)) if $o->at(qw(sli));
$o->id = 's'.($o->position+1) if $o->at(qw(step));
$o->id = 'i'.($o->index+1) if $o->at(qw(info));
$o->wrapWith(qw(screen)) if $o->at(qw(CDATA stepresult));
})->string =~ s/></>\n</gr;
# Dita (after being formatted for easier reading):
#
# <steps>
# <step id="s1">
# <cmd>Diagnose the problem</cmd>
# <info id="i1">This can be quite difficult</info>
# <info id="i2">Sometimes impossible</info>
# </step>
# <step id="s2">
# <cmd>ls -la</cmd>
# <stepresult>
# <screen>
# drwxr-xr-x 2 phil phil 4096 Jun 15 2016 Desktop
# drwxr-xr-x 2 phil phil 4096 Nov 9 20:26 Downloads
# </screen>
# </stepresult>
# </step>
# </steps>Description
Constructor
new()
New parse - call this method statically as in Data::Edit::Xml::new() with keyword parameters=> chosen from:
Parameter Description
inputString => string of xml to be parsed
inputFile => file of xml to be parsed
name => symbolic name for this parse used in messages about this parse and to name output files generated by this parse
output => directory into which to write output files
errors => sub directory of 'output' into which to write a copy of the string to be parsed in the event that an xml parse error is encountered while parsing this stringnewText()
Create a new text node which can then be inserted into a parse tree
Parameter Description
1 $tree Parse tree in which to create the new text node
2 $text Text of the new nodenewTag()
Create a new non text node which can then be inserted into a parse tree
Parameter Description
1 $tree Parse tree in which to create the new node
2 $tag Tag for the new node
3 %attributes attributes for the nodeData::Edit::Xml::newTree()
Create a new non text root node to create a new parse tree into which other nodes can be inserted
Parameter Description
1 $tag Tag for the new node
2 %attributes attributes for the nodecdata()
The name of the command name to use to represent text
Stringification
Print the parse tree
string($node)
Build a string from a node of a parse tree and the nodes below it
Parameter Description
1 $node Start nodecontentString($node)
Build a string from the contents of a node
Parameter Description
1 $node Start nodeprettyString($node)
Build a readable, prettified string from a node of a parse tree and the nodes below it
Parameter Description
1 $node Start nodePrettyContentString($node)
Build a readable, prettified string from the content of a node
Parameter Description
1 $node Start nodestringWithCondition($node, @conditions)
Build a string from a node of a parse tree and the nodes below it subject to conditions to reject some nodes
Parameter Description
1 $node Start node
2 @conditions conditions in effectaddConditions($node, @conditions)
Add conditions to a node
Parameter Description
1 $node Node
2 @conditions conditions to adddeleteConditions($node, @conditions)
Delete conditions applied to a node
Parameter Description
1 $node Node
2 @conditions conditions to addlistConditions($node)
List conditions applied to a node
Parameter Description
1 $node NodeisText($node)
Is this a text node?
Parameter Description
1 $node Node to testAttributes
Get or set attributes
attr :lvalue($node, $attribute)
Value of attribute in current command
Parameter Description
1 $node Node in parse tree
2 $attribute attribute nameattrs($node, @attributes)
Get the value of zero or more attributes
Parameter Description
1 $node Node in parse tree
2 @attribute attribute names whose values are to be retrievedattrCount($node)
Get the number of attributes for a node
Parameter Description
1 $node Node in parse treesetAttr($node, %values)
Set the value of an attribute in a command
Parameter Description
1 $node Node in parse tree
2 %values (attribute name=>new value)*Contents
Contents of the current node
contents($node)
Get all the nodes contained by this node as an array (not an array reference)
Parameter Description
1 $node NodecontentBeyond($node)
Get all the nodes beyond this node at the level of this node
Parameter Description
1 $node NodecontentBefore($node)
Get all the nodes before this node at the level of this node
Parameter Description
1 $node NodecontentAsTags($node)
Get the tags of all the nodes contained by this node as a string
Parameter Description
1 $node NodecontentBeyondAsTags($node)
Get the tags of all the nodes beyond this node as a string
Parameter Description
1 $node NodecontentBeforeAsTags($node)
Get the tags of all the nodes before this node as a string
Parameter Description
1 $node Nodeposition($node)
Find the position of a node in its parent's content
Parameter Description
1 $node Nodeindex($node)
Find the position of a node in its parent's index
Parameter Description
1 $node NodeNavigation
Move around in the parse tree
context($node)
Tags of this node and its ancestors joined to make a string
Parameter Description
1 $node Nodeget($node, @position)
Get a sub node under the current node by its position in each index with position zero assumed if no position is supplied
Parameter Description
1 $node Node
2 @position position specification: (indexc($node, $tag, $position)
Get all the nodes with the tag of the specified name below the current node
Parameter Description
1 $node Node
2 $tag tag
3 $positionfirst($node)
Get the first node below this node
Parameter Description
1 $node NodefirstOf($node, @tags)
Get the first node below this node
Parameter Description
1 $node Node
2 @tags The tags for the nodes under this node for which we want the first elementslast($node)
Get the last node below this node
Parameter Description
1 $node NodeisFirst($node)
Is this node first under its parent?
Parameter Description
1 $node NodeisLast($node)
Is this node last under its parent?
Parameter Description
1 $node NodeisOnlyChild($node)
Is this the only child of its parent?
Parameter Description
1 $node NodeisEmpty($node)
Check whether the node is empty
Parameter Description
1 $node Start nodenext($node)
Get the node next to the current node
Parameter Description
1 $node Nodeprev($node)
Get the node previous to the current node
Parameter Description
1 $node Nodeby($node, $sub, @context)
Post-order traversal of a parse tree or sub tree
Parameter Description
1 $node Starting node
2 $sub sub to call for each sub node
3 @context accumulated contextdown($node, $sub, @context)
Pre-order traversal down through a parse tree or sub tree
Parameter Description
1 $node Starting node
2 $sub sub to call for each sub node
3 @context accumulated contextat()
Check the node is in the context specified by the array of tags from the ancestors going up the parse tree from the node
over($node, $re)
Match the tags at the level below a node against a regular expression
Parameter Description
1 $node Node
2 $re regular expressionafter($node, $re)
Match the tags in the current level after a node against a regular expression
Parameter Description
1 $node Node
2 $re regular expressionbefore($node, $re)
Match the tags in the current level before a node against a regular expression
Parameter Description
1 $node Node
2 $re regular expressionup($node, @tags)
Go up to a specified context
Parameter Description
1 $node Start node
2 @tags tags identifying contextEditing
Edit the data in the parse tree
change($node, $name, @tags)
Change the name of a node in an optional tag context
Parameter Description
1 $node Node
2 $name new name
3 @tags tags defining the contextdeleteAttr($node, $attr, $value)
Delete the attribute, optionally checking its value first
Parameter Description
1 $node Node
2 $attr attribute name
3 $value optional attribute value to check firstdeleteAttrs($node, @attrs)
Delete the named attributes if present, without checking their values first
Parameter Description
1 $node Node
2 @attr Attributes to deleterenameAttr($node, $old, $new)
Change the name of an attribute regardless of whether the new attribute already exists
Parameter Description
1 $node Node
2 $old existing attribute name
3 $new new attribute namechangeAttr($node, $old, $new)
Change the name of an attribute unless it is already there
Parameter Description
1 $node Node
2 $old existing attribute name
3 $new new attribute namerenameAttrValue($node, $old, $oldValue, $new, $newValue)
Change the name and value of an attribute regardless of whether the new attribute already exists
Parameter Description
1 $node Node
2 $old existing attribute name and value
3 $oldValue new attribute name and value
4 $new
5 $newValuechangeAttrValue($node, $old, $oldValue, $new, $newValue)
Change the name and value of an attribute unless it is already there
Parameter Description
1 $node Node
2 $old existing attribute name and value
3 $oldValue new attribute name and value
4 $new
5 $newValueStructure
Change the structure of the parse tree
wrapWith($old, $tag)
Wrap the original node in a new node forcing the original node down deepening the parse tree
Parameter Description
1 $old Node
2 $tag tag for new nodewrapUp($node, @tags)
Wrap the original node in a sequence of new nodes forcing the original node down deepening the parse tree
Parameter Description
1 $old Node
2 @tags Tags to wrap the node with - with the uppermost tag rightmostwrapContentWith($old, $tag)
Wrap the content of a node in a new node, the original content then contains the new node which contains the original node's content
Parameter Description
1 $old Node
2 $tag tag for new nodeunwrap($node)
Unwrap a node by inserting its content into its parent at the point containing the node
Parameter Description
1 $node Node to unwrapreplaceWith($old, $new)
Replace a node (and all its content) with a new node (and all its content)
Parameter Description
1 $old Old node
2 $new new nodeCut and Put
Move nodes around in the parse tree
cut($node)
Cut out a node - remove the node from the parse tree and return it so that it can be put else where
Parameter Description
1 $node Node to cut outputNext($old, $new)
Place the new node just after the original node in the content of the parent
Parameter Description
1 $old Original node
2 $new new nodeputPrev($old, $new)
Place the new node just before the original node in the content of the parent
Parameter Description
1 $old Original node
2 $new new nodeputFirst($old, $new)
Place the new node at the front of the content of the original node
Parameter Description
1 $old Original node
2 $new new nodeputLast($old, $new)
Place the new node at the end of the content of the original node
Parameter Description
1 $old Original node
2 $new new nodeIndex of methods by name
"addConditions($node, @conditions)" "after($node, $re)" "at()" "attr :lvalue($node, $attribute)" "attrCount($node)" "attrs($node, @attributes)" "before($node, $re)" "by($node, $sub, @context)" "c($node, $tag, $position)" "cdata()" "change($node, $name, @tags)" "changeAttr($node, $old, $new)" "changeAttrValue($node, $old, $oldValue, $new, $newValue)" "contentAsTags($node)" "contentBefore($node)" "contentBeforeAsTags($node)" "contentBeyond($node)" "contentBeyondAsTags($node)" "contents($node)" "contentString($node)" "context($node)" "cut($node)" "deleteAttr($node, $attr, $value)" "deleteAttrs($node, @attr)" "deleteConditions($node, @conditions)" "first($node)" "firstOf($node, @tags)" "get($node, @position)" "index($node)" "isEmpty($node)" "isFirst($node)" "isLast($node)" "isOnlyChild($node)" "isText($node)" "last($node)" "listConditions($node)" "new()" "newTag()" "newText()" "Data::Edit::Xml::newTree()" "next($node)" "over($node, $re)" "position($node)" "prev($node)" "PrettyContentString($node)" "prettyString($node)" "putFirst($old, $new)" "putLast($old, $new)" "putNext($old, $new)" "putPrev($old, $new)" "renameAttr($node, $old, $new)" "renameAttrValue($node, $old, $oldValue, $new, $newValue)" "replaceWith($old, $new)" "setAttr($node, %values)" "string($node)" "stringWithCondition($node, @conditions)" "unwrap($node)" "up($node, @tags)" "wrapContentWith($old, $tag)" "wrapUp($old, @tags)" "wrapWith($old, $tag)"
Installation
This module is written in 100% Pure Perl and is thus easy to read, use, modify and install.
Standard Module::Build process for building and installing modules:
perl Build.PL
./Build
./Build test
./Build installAuthor
philiprbrenan@gmail.com
http://www.appaapps.com
Copyright
Copyright (c) 2016-2017 Philip R Brenan.
This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.