File Coverage

blib/lib/XML/Bare.pm

Criterion	Covered	Total	%
statement	162	540	30.0
branch	68	294	23.1
condition	12	65	18.4
subroutine	19	38	50.0
pod	29	29	100.0
total	290	966	30.0

package XML::Bare;

# ABSTRACT: Minimal XML parser implemented via a C state engine


use 5.008;
use Carp;
use strict;
use vars qw( @ISA @EXPORT @EXPORT_OK $VERSION );
use utf8;
require Exporter;
require DynaLoader;
@ISA = qw(Exporter DynaLoader);

our $VERSION = '0.46_03'; # VERSION
our $AUTHORITY = 'cpan:NIGELM'; # AUTHORITY

use vars qw($VERSION *AUTOLOAD);

*AUTOLOAD = \&XML::Bare::AUTOLOAD;
bootstrap XML::Bare $VERSION;

@EXPORT    = qw( );
@EXPORT_OK = qw( xget merge clean add_node del_node find_node del_node forcearray del_by_perl xmlin xval );

sub new {
    my $class = shift;
    my $self  = {@_};

    if ( $self->{'text'} ) {
        XML::Bare::c_parse( $self->{'text'} );
        $self->{'structroot'} = XML::Bare::get_root();
    }
    else {
        my $res = open( my $XML, '<', $self->{'file'} );
        if ( !$res ) {
            $self->{'xml'} = 0;
            return 0;
        }
        {
            local $/ = undef;
            $self->{'text'} = <$XML>;
        }
        close($XML);
        XML::Bare::c_parse( $self->{'text'} );
        $self->{'structroot'} = XML::Bare::get_root();
    }
    bless $self, $class;
    return $self if ( !wantarray );
    return ( $self, $self->parse() );
}

sub DESTROY {
    my $self = shift;
    $self->free_tree();
    undef $self->{'xml'};
}

sub xget {
    my $hash = shift;
    return map $_->{'value'}, @{%$hash}{@_};
}

sub forcearray {
    my $ref = shift;
    return [] if ( !$ref );
    return $ref if ( ref($ref) eq 'ARRAY' );
    return [$ref];
}

sub merge {

    # shift in the two array references as well as the field to merge on
    my ( $a, $b, $id ) = @_;
    my %hash = map { $_->{$id} ? ( $_->{$id}->{'value'} => $_ ) : ( 0 => 0 ) } @$a;
    for my $one (@$b) {
        next if ( !$one->{$id} );
        my $short = $hash{ $one->{$id}->{'value'} };
        next if ( !$short );
        foreach my $key ( keys %$one ) {
            next if ( $key eq '_pos' || $key eq 'id' );
            my $cur = $short->{$key};
            my $add = $one->{$key};
            if ( !$cur ) { $short->{$key} = $add; }
            else {
                my $type = ref($cur);
                if ( $type eq 'HASH' ) {
                    my @arr;
                    $short->{$key} = \@arr;
                    push( @arr, $cur );
                }
                if ( ref($add) eq 'HASH' ) {
                    push( @{ $short->{$key} }, $add );
                }
                else {    # we are merging an array
                    push( @{ $short->{$key} }, @$add );
                }
            }

            # we need to deal with the case where this node
            # is already there, either alone or as an array
        }
    }
    return $a;
}

sub clean {
    my $ob   = new XML::Bare(@_);
    my $root = $ob->parse();
    if ( $ob->{'save'} ) {
        $ob->{'file'} = $ob->{'save'} if ( "$ob->{'save'}" ne "1" );
        $ob->save();
        return;
    }
    return $ob->xml($root);
}

sub xmlin {
    my $text   = shift;
    my %ops    = (@_);
    my $ob     = new XML::Bare( text => $text );
    my $simple = $ob->simple();
    if ( !$ops{'keeproot'} ) {
        my @keys  = keys %$simple;
        my $first = $keys[0];
        $simple = $simple->{$first} if ($first);
    }
    return $simple;
}

sub tohtml {
    my %ops = (@_);
    my $ob  = new XML::Bare(%ops);
    return $ob->html( $ob->parse(), $ops{'root'} || 'xml' );
}

# Load a file using XML::DOM, convert it to a hash, and return the hash
sub parse {
    my $self = shift;

    my $res = XML::Bare::xml2obj();
    $self->{'structroot'} = XML::Bare::get_root();
    $self->free_tree();

    if ( defined( $self->{'scheme'} ) ) {
        $self->{'xbs'} = new XML::Bare( %{ $self->{'scheme'} } );
    }
    if ( defined( $self->{'xbs'} ) ) {
        my $xbs = $self->{'xbs'};
        my $ob  = $xbs->parse();
        $self->{'xbso'} = $ob;
        readxbs($ob);
    }

    if ( $res < 0 ) { croak "Error at " . $self->lineinfo( -$res ); }
    $self->{'xml'} = $res;

    if ( defined( $self->{'xbso'} ) ) {
        my $ob = $self->{'xbso'};
        my $cres = $self->check( $res, $ob );
        croak($cres) if ($cres);
    }

    return $self->{'xml'};
}

sub lineinfo {
    my $self = shift;
    my $res  = shift;
    my $line = 1;
    my $j    = 0;
    for ( my $i = 0; $i < $res; $i++ ) {
        my $let = substr( $self->{'text'}, $i, 1 );
        if ( ord($let) == 10 ) {
            $line++;
            $j = $i;
        }
    }
    my $part = substr( $self->{'text'}, $res, 10 );
    $part =~ s/\n//g;
    $res -= $j;
    if ( $self->{'offset'} ) {
        my $off = $self->{'offset'};
        $line += $off;
        return "$off line $line char $res \"$part\"";
    }
    return "line $line char $res \"$part\"";
}

# xml bare schema
sub check {
    my ( $self, $node, $scheme, $parent ) = @_;

    my $fail = '';
    if ( ref($scheme) eq 'ARRAY' ) {
        for my $one (@$scheme) {
            my $res = $self->checkone( $node, $one, $parent );
            return 0 if ( !$res );
            $fail .= "$res\n";
        }
    }
    else { return $self->checkone( $node, $scheme, $parent ); }
    return $fail;
}

sub checkone {
    my ( $self, $node, $scheme, $parent ) = @_;

    for my $key ( keys %$node ) {
        next if ( substr( $key, 0, 1 ) eq '_' || $key eq '_att' || $key eq 'comment' );
        if ( $key eq 'value' ) {
            my $val    = $node->{'value'};
            my $regexp = $scheme->{'value'};
            if ($regexp) {
                if ( $val !~ m/^($regexp)$/ ) {
                    my $linfo = $self->lineinfo( $node->{'_i'} );
                    return "Value of '$parent' node ($val) does not match /$regexp/ [$linfo]";
                }
            }
            next;
        }
        my $sub  = $node->{$key};
        my $ssub = $scheme->{$key};
        if ( !$ssub ) {    #&& ref( $schemesub ) ne 'HASH'
            my $linfo = $self->lineinfo( $sub->{'_i'} );
            return "Invalid node '$key' in xml [$linfo]";
        }
        if ( ref($sub) eq 'HASH' ) {
            my $res = $self->check( $sub, $ssub, $key );
            return $res if ($res);
        }
        if ( ref($sub) eq 'ARRAY' ) {
            my $asub = $ssub;
            if ( ref($asub) eq 'ARRAY' ) {
                $asub = $asub->[0];
            }
            if ( $asub->{'_t'} ) {
                my $max = $asub->{'_max'} || 0;
                if ( $#$sub >= $max ) {
                    my $linfo = $self->lineinfo( $sub->[0]->{'_i'} );
                    return "Too many nodes of type '$key'; max $max; [$linfo]";
                }
                my $min = $asub->{'_min'} || 0;
                if ( ( $#$sub + 1 ) < $min ) {
                    my $linfo = $self->lineinfo( $sub->[0]->{'_i'} );
                    return "Not enough nodes of type '$key'; min $min [$linfo]";
                }
            }
            for (@$sub) {
                my $res = $self->check( $_, $ssub, $key );
                return $res if ($res);
            }
        }
    }
    if ( my $dem = $scheme->{'_demand'} ) {
        for my $req ( @{ $scheme->{'_demand'} } ) {
            my $ck = $node->{$req};
            if ( !$ck ) {
                my $linfo = $self->lineinfo( $node->{'_i'} );
                return "Required node '$req' does not exist [$linfo]";
            }
            if ( ref($ck) eq 'ARRAY' ) {
                my $linfo = $self->lineinfo( $node->{'_i'} );
                return "Required node '$req' is empty array [$linfo]" if ( $#$ck == -1 );
            }
        }
    }
    return 0;
}

sub readxbs {    # xbs = xml bare schema
    my $node = shift;
    my @demand;
    for my $key ( keys %$node ) {
        next if ( substr( $key, 0, 1 ) eq '_' || $key eq '_att' || $key eq 'comment' );
        if ( $key eq 'value' ) {
            my $val = $node->{'value'};
            delete $node->{'value'} if ( $val =~ m/^\W*$/ );
            next;
        }
        my $sub = $node->{$key};

        if ( $key =~ m/([a-z_]+)([^a-z_]+)/ ) {
            my $name = $1;
            my $t    = $2;
            my $min;
            my $max;
            if ( $t eq '+' ) {
                $min = 1;
                $max = 1000;
            }
            elsif ( $t eq '*' ) {
                $min = 0;
                $max = 1000;
            }
            elsif ( $t eq '?' ) {
                $min = 0;
                $max = 1;
            }
            elsif ( $t eq '@' ) {
                $name = 'multi_' . $name;
                $min  = 1;
                $max  = 1;
            }
            elsif ( $t =~ m/\{([0-9]+),([0-9]+)\}/ ) {
                $min = $1;
                $max = $2;
                $t   = 'r';    # range
            }

            my $res;
            if ( ref($sub) eq 'HASH' ) {
                $res = readxbs($sub);
                $sub->{'_t'}   = $t;
                $sub->{'_min'} = $min;
                $sub->{'_max'} = $max;
            }
            if ( ref($sub) eq 'ARRAY' ) {
                for my $item (@$sub) {
                    $res = readxbs($item);
                    $item->{'_t'}   = $t;
                    $item->{'_min'} = $min;
                    $item->{'_max'} = $max;
                }
            }

            push( @demand, $name ) if ($min);
            $node->{$name} = $node->{$key};
            delete $node->{$key};
        }
        else {
            if ( ref($sub) eq 'HASH' ) {
                readxbs($sub);
                $sub->{'_t'}   = 'r';
                $sub->{'_min'} = 1;
                $sub->{'_max'} = 1;
            }
            if ( ref($sub) eq 'ARRAY' ) {
                for my $item (@$sub) {
                    readxbs($item);
                    $item->{'_t'}   = 'r';
                    $item->{'_min'} = 1;
                    $item->{'_max'} = 1;
                }
            }

            push( @demand, $key );
        }
    }
    if (@demand) { $node->{'_demand'} = \@demand; }
}

sub simple {
    my $self = shift;

    my $res = XML::Bare::xml2obj_simple();
    $self->{'structroot'} = XML::Bare::get_root();
    $self->free_tree();

    return $res;
}

sub add_node {
    my ( $self, $node, $name ) = @_;
    my @newar;
    my %blank;
    $node->{ 'multi_' . $name } = \%blank if ( !$node->{ 'multi_' . $name } );
    $node->{$name} = \@newar if ( !$node->{$name} );
    my $newnode = new_node( 0, splice( @_, 3 ) );
    push( @{ $node->{$name} }, $newnode );
    return $newnode;
}

sub add_node_after {
    my ( $self, $node, $prev, $name ) = @_;
    my @newar;
    my %blank;
    $node->{ 'multi_' . $name } = \%blank if ( !$node->{ 'multi_' . $name } );
    $node->{$name} = \@newar if ( !$node->{$name} );
    my $newnode = $self->new_node( splice( @_, 4 ) );

    my $cur = 0;
    for my $anode ( @{ $node->{$name} } ) {
        $anode->{'_pos'} = $cur if ( !$anode->{'_pos'} );
        $cur++;
    }
    my $opos = $prev->{'_pos'};
    for my $anode ( @{ $node->{$name} } ) {
        $anode->{'_pos'}++ if ( $anode->{'_pos'} > $opos );
    }
    $newnode->{'_pos'} = $opos + 1;

    push( @{ $node->{$name} }, $newnode );

    return $newnode;
}

sub find_by_perl {
    my $arr  = shift;
    my $cond = shift;
    $cond =~ s/-([a-z]+)/\$ob->\{'$1'\}->\{'value'\}/g;
    my @res;
    ## no critic
    foreach my $ob (@$arr) { push( @res, $ob ) if ( eval($cond) ); }
    ## use critic
    return \@res;
}

sub find_node {
    my $self  = shift;
    my $node  = shift;
    my $name  = shift;
    my %match = @_;

    #croak "Cannot search empty node for $name" if( !$node );
    #$node = $node->{ $name } or croak "Cannot find $name";
    $node = $node->{$name} or return 0;
    return 0 if ( !$node );
    if ( ref($node) eq 'HASH' ) {
        foreach my $key ( keys %match ) {
            my $val = $match{$key};
            next if ( !$val );
            if ( $node->{$key}->{'value'} eq $val ) {
                return $node;
            }
        }
    }
    if ( ref($node) eq 'ARRAY' ) {
        for ( my $i = 0; $i <= $#$node; $i++ ) {
            my $one = $node->[$i];
            foreach my $key ( keys %match ) {
                my $val = $match{$key};
                croak('undefined value in find') unless defined $val;
                if ( $one->{$key}->{'value'} eq $val ) {
                    return $node->[$i];
                }
            }
        }
    }
    return 0;
}

sub del_node {
    my $self  = shift;
    my $node  = shift;
    my $name  = shift;
    my %match = @_;
    $node = $node->{$name};
    return if ( !$node );
    for ( my $i = 0; $i <= $#$node; $i++ ) {
        my $one = $node->[$i];
        foreach my $key ( keys %match ) {
            my $val = $match{$key};
            if ( $one->{$key}->{'value'} eq $val ) {
                delete $node->[$i];
            }
        }
    }
}

sub del_by_perl {
    my $arr  = shift;
    my $cond = shift;
    $cond =~ s/-value/\$ob->\{'value'\}/g;
    $cond =~ s/-([a-z]+)/\$ob->\{'$1'\}->\{'value'\}/g;
    my @res;
    for ( my $i = 0; $i <= $#$arr; $i++ ) {
        my $ob = $arr->[$i];
        ## no critic
        delete $arr->[$i] if ( eval($cond) );
        ## use critic
    }
    return \@res;
}

# Created a node of XML hash with the passed in variables already set
sub new_node {
    my $self  = shift;
    my %parts = @_;

    my %newnode;
    foreach ( keys %parts ) {
        my $val = $parts{$_};
        if ( m/^_/ || ref($val) eq 'HASH' ) {
            $newnode{$_} = $val;
        }
        else {
            $newnode{$_} = { value => $val };
        }
    }

    return \%newnode;
}

sub newhash { shift; return { value => shift }; }

sub simplify {
    my $self = shift;
    my $root = shift;
    my %ret;
    foreach my $name ( keys %$root ) {
        next if ( $name =~ m|^_| || $name eq 'comment' || $name eq 'value' );
        my $val = xval $root->{$name};
        $ret{$name} = $val;
    }
    return \%ret;
}

sub xval {
    return $_[0] ? $_[0]->{'value'} : ( $_[1] || '' );
}

# Save an XML hash tree into a file
sub save {
    my $self = shift;
    return if ( !$self->{'xml'} );

    my $xml = $self->xml( $self->{'xml'} );

    my $len;
    {
        use bytes;
        $len = length($xml);
    }
    return if ( !$len );

    open my $F, '>:encoding(UTF-8)', $self->{'file'};
    print $F $xml;

    seek( $F, 0, 2 );
    my $cursize = tell($F);
    if ( $cursize != $len ) {    # concurrency; we are writing a smaller file
        warn "Truncating File $self->{'file'}";
        truncate( $F, $len );
    }
    seek( $F, 0, 2 );
    $cursize = tell($F);
    if ( $cursize != $len ) {    # still not the right size even after truncate??
        die "Write problem; $cursize != $len";
    }
    close $F;
}

sub xml {
    my ( $self, $obj, $name ) = @_;
    if ( !$name ) {
        my %hash;
        $hash{0} = $obj;
        return obj2xml( \%hash, '', 0 );
    }
    my %hash;
    $hash{$name} = $obj;
    return obj2xml( \%hash, '', 0 );
}

sub html {
    my ( $self, $obj, $name ) = @_;
    my $pre = '';
    if ( $self->{'style'} ) {
        $pre = "\@import '$self->{'style'}';";
    }
    if ( !$name ) {
        my %hash;
        $hash{0} = $obj;
        return $pre . obj2html( \%hash, '', 0 );
    }
    my %hash;
    $hash{$name} = $obj;
    return $pre . obj2html( \%hash, '', 0 );
}

sub obj2xml {
    my ( $objs, $name, $pad, $level ) = @_;
    $level = 0  if ( !$level );
    $pad   = '' if ( $level <= 2 );
    my $xml = '';
    my $att = '';
    my $imm = 1;
    return '' if ( !$objs );

    #return $objs->{'_raw'} if( $objs->{'_raw'} );
    my @dex = sort {
        my $oba  = $objs->{$a};
        my $obb  = $objs->{$b};
        my $posa = 0;
        my $posb = 0;
        $oba = $oba->[0] if ( ref($oba) eq 'ARRAY' );
        $obb = $obb->[0] if ( ref($obb) eq 'ARRAY' );
        if ( ref($oba) eq 'HASH' ) { $posa = $oba->{'_pos'} || 0; }
        if ( ref($obb) eq 'HASH' ) { $posb = $obb->{'_pos'} || 0; }
        return $posa <=> $posb;
    } keys %$objs;
    for my $i (@dex) {
        my $obj = $objs->{$i} || '';
        my $type = ref($obj);
        if ( $type eq 'ARRAY' ) {
            $imm = 0;

            my @dex2 = sort {
                if ( !$a ) { return 0; }
                if ( !$b ) { return 0; }
                if ( ref($a) eq 'HASH' && ref($b) eq 'HASH' ) {
                    my $posa = $a->{'_pos'};
                    my $posb = $b->{'_pos'};
                    if ( !$posa ) { $posa = 0; }
                    if ( !$posb ) { $posb = 0; }
                    return $posa <=> $posb;
                }
                return 0;
            } @$obj;

            for my $j (@dex2) {
                $xml .= obj2xml( $j, $i, $pad . '  ', $level + 1, $#dex );
            }
        }
        elsif ( $type eq 'HASH' && $i !~ /^_/ ) {
            if ( $obj->{'_att'} ) {
                $att .= ' ' . $i . '="' . $obj->{'value'} . '"' if ( $i !~ /^_/ );
            }
            else {
                $imm = 0;
                $xml .= obj2xml( $obj, $i, $pad . '  ', $level + 1, $#dex );
            }
        }
        else {
            if ( $i eq 'comment' ) { $xml .= '' . "\n"; }
            elsif ( $i eq 'value' ) {
                if ( $level > 1 ) {    # $#dex < 4 &&
                    if   ( $obj && $obj =~ /[<>&;]/ ) { $xml .= ''; }
                    else                              { $xml .= $obj if ( $obj =~ /\S/ ); }
                }
            }
            elsif ( $i =~ /^_/ ) { }
            else                 { $xml .= '<' . $i . '>' . $obj . ''; }
        }
    }
    my $pad2 = $imm ? '' : $pad;
    my $cr   = $imm ? '' : "\n";
    if ( substr( $name, 0, 1 ) ne '_' ) {
        if ($name) {
            if ($xml) {
                $xml = $pad . '<' . $name . $att . '>' . $cr . $xml . $pad2 . '';
            }
            else {
                $xml = $pad . '<' . $name . $att . ' />';
            }
        }
        return $xml . "\n" if ( $level > 1 );
        return $xml;
    }
    return '';
}

sub obj2html {
    my ( $objs, $name, $pad, $level ) = @_;

    my $less = "<";
    my $more = ">";
    my $tn0  = "";
    my $tn1  = "";
    my $eq0  = "";
    my $eq1  = "";
    my $qo0  = "";
    my $qo1  = "";
    my $sp0  = "";
    my $sp1  = "";
    my $cd0  = "";
    my $cd1  = "";

    $level = 0  if ( !$level );
    $pad   = '' if ( $level == 1 );
    my $xml = '';
    my $att = '';
    my $imm = 1;
    return '' if ( !$objs );
    my @dex = sort {
        my $oba  = $objs->{$a};
        my $obb  = $objs->{$b};
        my $posa = 0;
        my $posb = 0;
        $oba = $oba->[0] if ( ref($oba) eq 'ARRAY' );
        $obb = $obb->[0] if ( ref($obb) eq 'ARRAY' );
        if ( ref($oba) eq 'HASH' ) { $posa = $oba->{'_pos'} || 0; }
        if ( ref($obb) eq 'HASH' ) { $posb = $obb->{'_pos'} || 0; }
        return $posa <=> $posb;
    } keys %$objs;

    if ( $objs->{'_cdata'} ) {
        my $val = $objs->{'value'};
        $val =~ s/^(\s*\n)+//;
        $val =~ s/\s+$//;
        $val =~ s/&/&/g;
        $val =~ s/
        $objs->{'value'} = $val;

        #$xml = "$less![CDATA[$val]]$more";
        $cd0 = "$less![CDATA[";
        $cd1 = "]]$more";
    }
    for my $i (@dex) {
        my $obj = $objs->{$i} || '';
        my $type = ref($obj);
        if ( $type eq 'ARRAY' ) {
            $imm = 0;

            my @dex2 = sort {
                if ( !$a ) { return 0; }
                if ( !$b ) { return 0; }
                if ( ref($a) eq 'HASH' && ref($b) eq 'HASH' ) {
                    my $posa = $a->{'_pos'};
                    my $posb = $b->{'_pos'};
                    if ( !$posa ) { $posa = 0; }
                    if ( !$posb ) { $posb = 0; }
                    return $posa <=> $posb;
                }
                return 0;
            } @$obj;

            for my $j (@dex2) { $xml .= obj2html( $j, $i, $pad . '  ', $level + 1, $#dex ); }
        }
        elsif ( $type eq 'HASH' && $i !~ /^_/ ) {
            if ( $obj->{'_att'} ) {
                my $val = $obj->{'value'};
                $val =~ s/
                if ( $val eq '' ) {
                    $att .= " $i" if ( $i !~ /^_/ );
                }
                else {
                    $att .= " $i$eq0=$eq1$qo0\"$qo1$val$qo0\"$qo1" if ( $i !~ /^_/ );
                }
            }
            else {
                $imm = 0;
                $xml .= obj2html( $obj, $i, $pad . '  ', $level + 1, $#dex );
            }
        }
        else {
            if ( $i eq 'comment' ) { $xml .= "$less!--" . $obj . "--$more" . "\n"; }
            elsif ( $i eq 'value' ) {
                if ( $level > 1 ) {
                    if   ( $obj && $obj =~ /[<>&;]/ && !$objs->{'_cdata'} ) { $xml .= "$less![CDATA[$obj]]$more"; }
                    else                                                    { $xml .= $obj if ( $obj =~ /\S/ ); }
                }
            }
            elsif ( $i =~ /^_/ ) { }
            else                 { $xml .= "$less$tn0$i$tn1$more$obj$less/$tn0$i$tn1$more"; }
        }
    }
    if ( substr( $name, 0, 1 ) ne '_' ) {
        if ($name) {
            if ($imm) {
                if ( $xml =~ /\S/ ) {
                    $xml = "$sp0$pad$sp1$less$tn0$name$tn1$att$more$cd0$xml$cd1$less/$tn0$name$tn1$more";
                }
                else {
                    $xml = "$sp0$pad$sp1$less$tn0$name$tn1$att/$more";
                }
            }
            else {
                if ( $xml =~ /\S/ ) {
                    $xml =
                        "$sp0$pad$sp1$less$tn0$name$tn1$att$more$xml$sp0$pad$sp1$less/$tn0$name$tn1$more";
                }
                else { $xml = "$sp0$pad$sp1$less$tn0$name$tn1$att/$more"; }
            }
        }
        $xml .= "" if ( $objs->{'_br'} );
        if ( $objs->{'_note'} ) {
            $xml .= "";
            my $note = $objs->{'_note'}{'value'};
            my @notes = split( /\|/, $note );
            for (@notes) {
                $xml
                    .= "$sp0$pad$sp1<!-- $_ -->";
            }
        }
        return $xml . "\n" if ($level);
        return $xml;
    }
    return '';
}

sub free_tree {
    my $self = shift;
    if ( $self->{'structroot'} ) {
        XML::Bare::free_tree_c( $self->{'structroot'} );
        delete( $self->{'structroot'} );
    }
}

1;



=pod

=for stopwords CDATA GDSL LibXML Sergey Skvortsov XBS dequoting exe
executables html iff keeproot makebench nodeset notree recognised
subnode templated tmpl xml xmlin

=head1 NAME

XML::Bare - Minimal XML parser implemented via a C state engine

=head1 VERSION

version 0.46_03

=head1 SYNOPSIS

  use XML::Bare;

  my $ob = new XML::Bare( text => 'Bob' );

  # Parse the xml into a hash tree
  my $root = $ob->parse();

  # Print the content of the name node
  print $root->{xml}->{name}->{value};

  # --------------------------------------------------------------

  # Load xml from a file ( assume same contents as first example )
  my $ob2 = new XML::Bare( file => 'test.xml' );

  my $root2 = $ob2->parse();

  $root2->{xml}->{name}->{value} = 'Tim';

  # Save the changes back to the file
  $ob2->save();

  # --------------------------------------------------------------

  # Load xml and verify against XBS ( XML Bare Schema )
  my $xml_text = '';
  my $schema_text = '';
  my $ob3 = new XML::Bare( text => $xml_text, schema => { text => $schema_text } );
  $ob3->parse(); # this will error out if schema is invalid

=head1 DESCRIPTION

This module is a 'Bare' XML parser. It is implemented in C. The parser
itself is a simple state engine that is less than 500 lines of C. The
parser builds a C struct tree from input text. That C struct tree is
converted to a Perl hash by a Perl function that makes basic calls back
to the C to go through the nodes sequentially.

The parser itself will only cease parsing if it encounters tags that
are not closed properly. All other inputs will parse, even invalid
inputs. To allowing checking for validity, a schema checker is included
in the module as well.

The schema format is custom and is meant to be as simple as possible.
It is based loosely around the way multiplicity is handled in Perl
regular expressions.

=head2 Supported XML

To demonstrate what sort of XML is supported, consider the following
examples. Each of the PERL statements evaluates to true.

=over 2

=item * Node containing just text

  XML: blah
  PERL: $root->{xml}->{value} eq "blah";

=item * Subset nodes

  XML: Bob
  PERL: $root->{xml}->{name}->{value} eq "Bob";

=item * Attributes unquoted

  XML: Link
  PERL: $root->{xml}->{a}->{href}->{value} eq "index.htm";

=item * Attributes quoted

  XML: Link
  PERL: $root->{xml}->{a}->{href}->{value} eq "index.htm";

=item * CDATA nodes

  XML: ]]>
  PERL: $root->{xml}->{raw}->{value} eq "some raw \$~";

=item * Multiple nodes; form array

  XML: 12
  PERL: $root->{xml}->{item}->[0]->{value} eq "1";

=item * Forcing array creation

  XML: 1
  PERL: $root->{xml}->{item}->[0]->{value} eq "1";

=item * One comment supported per node

  XML:
  PERL: $root->{xml}->{comment} eq 'test';

=back

=head2 Schema Checking

Schema checking is done by providing the module with an XBS (XML::Bare Schema) to check
the XML against. If the XML checks as valid against the schema, parsing will continue as
normal. If the XML is invalid, the parse function will die, providing information about
the failure.

The following information is provided in the error message:

=over 2

=item * The type of error

=item * Where the error occurred ( line and char )

=item * A short snippet of the XML at the point of failure

=back

=head2 XBS ( XML::Bare Schema ) Format

=over 2

=item * Required nodes

  XML:
  XBS:

=item * Optional nodes - allow one

  XML:
  XBS:
  or XBS:

=item * Optional nodes - allow 0 or more

  XML:
  XBS:

=item * Required nodes - allow 1 or more

  XML:
  XBS:

=item * Nodes - specified minimum and maximum number

  XML:
  XBS:
  or XBS:
  or XBS:

=item * Multiple acceptable node formats

  XML:
  XBS:

=item * Regular expressions checking for values

  XML:
  XBS:

=item * Require multi_ tags

  XML:
  XBS:

=back

=head2 Parsed Hash Structure

The hash structure returned from XML parsing is created in a specific format.
Besides as described above, the structure contains some additional nodes in
order to preserve information that will allow that structure to be correctly
converted back to XML.

Nodes may contain the following 3 additional subnodes:

=over 2

=item * _i

The character offset within the original parsed XML of where the node
begins. This is used to provide line information for errors when XML
fails a schema check.

=item * _pos

This is a number indicating the ordering of nodes. It is used to allow
items in a perl hash to be sorted when writing back to xml. Note that
items are not sorted after parsing in order to save time if all you
are doing is reading and you do not care about the order.

In future versions of this module an option will be added to allow
you to sort your nodes so that you can read them in order.
( note that multiple nodes of the same name are stored in order )

=item * _att

This is a boolean value that exists and is 1 iff the node is an
attribute.

=back

=head2 Parsing Limitations / Features

=over 2

=item * CDATA parsed correctly, but stripped if unneeded

Currently the contents of a node that are CDATA are read and
put into the value hash, but the hash structure does not have
a value indicating the node contains CDATA.

When converting back to XML, the contents of the value hash
are parsed to check for xml incompatible data using a regular
expression. If 'CDATA like' stuff is encountered, the node
is output as CDATA.

=item * Standard XML quoted characters are decoded

The basic XML quoted characters - C<&> C<>> C<<> C
and C<'> - are recognised and decoded when reading values.
However when writing the builder will put any values that need quoting
into a CDATA wrapper as described above.

=item * Node position stored, but hash remains unsorted

The ordering of nodes is noted using the '_pos' value, but
the hash itself is not ordered after parsing. Currently
items will be out of order when looking at them in the
hash.

Note that when converted back to XML, the nodes are then
sorted and output in the correct order to XML. Note that
nodes of the same name with the same parent will be
grouped together; the position of the first item to
appear will determine the output position of the group.

=item * Comments are parsed but only one is stored per node.

For each node, there can be a comment within it, and that
comment will be saved and output back when dumping to XML.

=item * Comments override output of immediate value

If a node contains only a comment node and a text value,
only the comment node will be displayed. This is in line
with treating a comment node as a node and only displaying
immediate values when a node contains no subnodes.

=item * PI sections are parsed, but discarded

=item * Unknown C<< > sections are parsed, but discarded

=item * Attributes may use no quotes, single quotes, quotes

=item * Quoted attributes cannot contain escaped quotes

No escape character is recognized within quotes. As a result,
regular quotes cannot be stored to XML, or the written XML
will not be correct, due to all attributes always being written
using quotes.

=item * Attributes are always written back to XML with quotes

=item * Nodes cannot contain subnodes as well as an immediate value

Actually nodes can in fact contain a value as well, but that
value will be discarded if you write back to XML. That value is
equal to the first continuous string of text besides a subnode.

  texttext2
  ( the value of node is text )

  text
  ( the value of node is text )


    text

  ( the value of node is "\n  " )

=back

=head2 Module Functions

=over 2

=item * C<< $ob = new XML::Bare( text => "[some xml]" ) >>

Create a new XML object, with the given text as the xml source.

=item * C<< $object = new XML::Bare( file => "[filename]" ) >>

Create a new XML object, with the given filename/path as the xml source

=item * C<< $object = new XML::Bare( text => "[some xml]", file => "[filename]" ) >>

Create a new XML object, with the given text as the xml input, and the given
filename/path as the potential output ( used by save() )

=item * C<< $object = new XML::Bare( file => "data.xml", scheme => { file => "scheme.xbs" } ) >>

Create a new XML object and check to ensure it is valid xml by way of the XBS scheme.

=item * C<< $tree = $object->parse() >>

Parse the xml of the object and return a tree reference

=item * C<< $tree = $object->simple() >>

Alternate to the parse function which generates a tree similar to that
generated by XML::Simple. Note that the sets of nodes are turned into
arrays always, regardless of whether they have a 'name' attribute, unlike
XML::Simple.

Note that currently the generated tree cannot be used with any of the
functions in this module that operate upon trees. The function is provided
purely as a quick and dirty way to read simple XML files.

=item * C<< $tree = xmlin( $xmlext, keeproot => 1 ) >>

The xmlin function is a shortcut to creating an XML::Bare object and
parsing it using the simple function. It behaves similarly to the
XML::Simple function by the same name. The keeproot option is optional
and if left out the root node will be discarded, same as the function
in XML::Simple.

=item * C<< $text = $object->xml( [root] ) >>

Take the hash tree in [root] and turn it into cleanly indented ( 2 spaces )
XML text.

=item * C<< $text = $object->html( [root], [root node name] ) >>

Take the hash tree in [root] and turn it into nicely colorized and styled
html. [root node name] is optional.

=item * C<< $object->save() >>

The the current tree in the object, cleanly indent it, and save it
to the file parameter specified when creating the object.

=item * C<< $value = xval $node, $default >>

Returns the value of $node or $default if the node does not exist.
If default is not passed to the function, then '' is returned as
a default value when the node does not exist.

=item * C<< ( $name, $age ) = xget( $personnode, qw/name age/ ) >>

Shortcut function to grab a number of values from a node all at the
same time. Note that this function assumes that all of the subnodes
exist; it will fail if they do not.

=item * C<< $text = XML::Bare::clean( text => "[some xml]" ) >>

Shortcut to creating an xml object and immediately turning it into clean xml text.

=item * C<< $text = XML::Bare::clean( file => "[filename]" ) >>

Similar to previous.

=item * C<< XML::Bare::clean( file => "[filename]", save => 1 ) >>

Clean up the xml in the file, saving the results back to the file

=item * C<< XML::Bare::clean( text => "[some xml]", save => "[filename]" ) >>

Clean up the xml provided, and save it into the specified file.

=item * C<< XML::Bare::clean( file => "[filename1]", save => "[filename2]" ) >>

Clean up the xml in filename1 and save the results to filename2.

=item * C<< $html = XML::Bare::tohtml( text => "[some xml]", root => 'xml' ) >>

Shortcut to creating an xml object and immediately turning it into html.
Root is optional, and specifies the name of the root node for the xml
( which defaults to 'xml' )

=item * C<< $object->add_node( [node], [nodeset name], name => value, name2 => value2, ... ) >>

  Example:
    $object->add_node( $root->{xml}, 'item', name => 'Bob' );

  Result:


        Bob



=item * C<< $object->add_node_after( [node], [subnode within node to add after], [nodeset name], ... ) >>

=item * C<< $object->del_node( [node], [nodeset name], name => value ) >>

  Example:
    Starting XML:


          1


          2



    Code:
      $xml->del_node( $root->{xml}, 'a', b=>'1' );

    Ending XML:


          2



=item * C<< $object->find_node( [node], [nodeset name], name => value ) >>

  Example:
    Starting XML:


          1
          a


          2
          b



    Code:
      $object->find_node( $root->{xml}, 'ob', key => '1' )->{val}->{value} = 'test';

    Ending XML:


          1
          test


          2
          b



=item * C<< $object->find_by_perl( [nodeset], "[perl code]" ) >>

find_by_perl evaluates some perl code for each node in a set of nodes, and
returns the nodes where the perl code evaluates as true. In order to
easily reference node values, node values can be directly referred
to from within the perl code by the name of the node with a dash(-) in
front of the name. See the example below.

Note that this function returns an array reference as opposed to a single
node unlike the find_node function.

  Example:
    Starting XML:


          1
          a


          2
          b



    Code:
      $object->find_by_perl( $root->{xml}->{ob}, "-key eq '1'" )->[0]->{val}->{value} = 'test';

    Ending XML:


          1
          test


          2
          b



=item * C<< XML::Bare::merge( [nodeset1], [nodeset2], [id node name] ) >>

Merges the nodes from nodeset2 into nodeset1, matching the contents of
each node based up the content in the id node.

Example:

  Code:
    my $ob1 = new XML::Bare( text => "


        bob

          1
          blue

      " );
    my $ob2 = new XML::Bare( text => "


        john

          1
          bob
          1

      " );
    my $root1 = $ob1->parse();
    my $root2 = $ob2->parse();
    merge( $root1->{'xml'}->{'a'}, $root2->{'xml'}->{'a'}, 'id' );
    print $ob1->xml( $root1 );

  Output:


      bob

        1
        blue
        bob
        1



=item * C<< XML::Bare::del_by_perl( ... ) >>

Works exactly like find_by_perl, but deletes whatever matches.

=item * C<< XML::Bare::forcearray( [noderef] ) >>

Turns the node reference into an array reference, whether that
node is just a single node, or is already an array reference.

=item * C<< XML::Bare::new_node( ... ) >>

Creates a new node...

=item * C<< XML::Bare::newhash( ... ) >>

Creates a new hash with the specified value.

=item * C<< XML::Bare::simplify( [noderef] ) >>

Take a node with children that have immediate values and
creates a hashref to reference those values by the name of
each child.

=back

=head2 Functions Used Internally

=over 2

=item * C<< check() checkone() readxbs() free_tree_c() >>

=item * C<< lineinfo() c_parse() c_parsefile() free_tree() xml2obj() >>

=item * C<< obj2xml() get_root() obj2html() xml2obj_simple() >>

=back

=head2 Performance

In comparison to other available perl xml parsers that create trees, XML::Bare
is extremely fast. In order to measure the performance of loading and parsing
compared to the alternatives, a templated speed comparison mechanism has been
created and included with XML::Bare.

The include makebench.pl file runs when you make the module and creates perl
files within the bench directory corresponding to the .tmpl contained there.

Currently there are three types of modules that can be tested against,
executable parsers ( exe.tmpl ), tree parsers ( tree.tmpl ), and parsers
that do not generated trees ( notree.tmpl ).

A full list of modules currently tested against is as follows:

  Tiny XML (exe)
  EzXML (exe)
  XMLIO (exe)
  XML::LibXML (notree)
  XML::Parser (notree)
  XML::Parser::Expat (notree)
  XML::Descent (notree)
  XML::Parser::EasyTree
  XML::Handler::Trees
  XML::Twig
  XML::Smart
  XML::Simple using XML::Parser
  XML::Simple using XML::SAX::PurePerl
  XML::Simple using XML::LibXML::SAX::Parser
  XML::Simple using XML::Bare::SAX::Parser
  XML::TreePP
  XML::Trivial
  XML::SAX::Simple
  XML::Grove::Builder
  XML::XPath::XMLParser
  XML::DOM

To run the comparisons, run the appropriate perl file within the
bench directory. ( exe.pl, tree.pl, or notree.pl )

The script measures the milliseconds of loading and parsing, and
compares the time against the time of XML::Bare. So a 7 means
it takes 7 times as long as XML::Bare.

Here is a combined table of the script run against each alternative
using the included test.xml:

  -Module-                   load     parse    total
  XML::Bare                  1        1        1
  XML::TreePP                2.3063   33.1776  6.1598
  XML::Parser::EasyTree      4.9405   25.7278  7.4571
  XML::Handler::Trees        7.2303   26.5688  9.6447
  XML::Trivial               5.0636   12.4715  7.3046
  XML::Smart                 6.8138   78.7939  15.8296
  XML::Simple (XML::Parser)  2.3346   50.4772  10.7455
  XML::Simple (PurePerl)     2.361    261.4571 33.6524
  XML::Simple (LibXML)       2.3187   163.7501 23.1816
  XML::Simple (XML::Bare)    2.3252   59.1254  10.9163
  XML::SAX::Simple           8.7792   170.7313 28.3634
  XML::Twig                  27.8266  56.4476  31.3594
  XML::Grove::Builder        7.1267   26.1672  9.4064
  XML::XPath::XMLParser      9.7783   35.5486  13.0002
  XML::LibXML (notree)       11.0038  4.5758   10.6881
  XML::Parser (notree)       4.4698   17.6448  5.8609
  XML::Parser::Expat(notree) 3.7681   50.0382  6.0069
  XML::Descent (notree)      6.0525   37.0265  11.0322
  Tiny XML (exe)                               1.0095
  EzXML (exe)                                  1.1284
  XMLIO (exe)                                  1.0165

Here is a combined table of the script run against each alternative
using the included feed2.xml:

  -Module-                   load     parse    total
  XML::Bare                  1        1        1
  XML::TreePP                2.3068   23.7554  7.6921
  XML::Parser::EasyTree      4.8799   25.3691  9.6257
  XML::Handler::Trees        6.8545   33.1007  13.0575
  XML::Trivial               5.0105   32.0043  11.4113
  XML::Simple (XML::Parser)  2.3498   41.9007  12.3062
  XML::Simple (PurePerl)     2.3551   224.3027 51.7832
  XML::Simple (LibXML)       2.3617   88.8741  23.215
  XML::Simple (XML::Bare)    2.4319   37.7355  10.2343
  XML::Simple                2.7168   90.7203  26.7525
  XML::SAX::Simple           8.7386   94.8276  29.2166
  XML::Twig                  28.3206  48.1014  33.1222
  XML::Grove::Builder        7.2021   30.7926  12.9334
  XML::XPath::XMLParser      9.6869   43.5032  17.4941
  XML::LibXML (notree)       11.0023  5.022    10.5214
  XML::Parser (notree)       4.3748   25.0213  5.9803
  XML::Parser::Expat(notree) 3.6555   51.6426  7.4316
  XML::Descent (notree)      5.9206   155.0289 18.7767
  Tiny XML (exe)                               1.2212
  EzXML (exe)                                  1.3618
  XMLIO (exe)                                  1.0145

These results show that XML::Bare is, at least on the
test machine, running all tests within cygwin, faster
at loading and parsing than everything being tested
against.

The following things are shown as well:
  - XML::Bare can parse XML and create a hash tree
  in less time than it takes LibXML just to parse.
  - XML::Bare can parse XML and create a tree
  in less time than all three binary parsers take
  just to parse.

Note that the executable parsers are not perl modules
and are timed using dummy programs that just uses the
library to load and parse the example files. The
executables are not included with this program. Any
source modifications used to generate the shown test
results can be found in the bench/src directory of
the distribution

=head1 CONTRIBUTED CODE

The XML dequoting code used is taken from L by I
Skvortsov> (I on CPAN) with very minor modifications.

=head1 INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

=head1 BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests through the web interface at
L.

=head1 AVAILABILITY

The project homepage is L.

The latest version of this module is available from the Comprehensive Perl
Archive Network (CPAN). Visit L to find a CPAN
site near you, or see L.

The development version lives at L
and may be cloned from L.
Instead of sending patches, please fork this project using the standard
git and github infrastructure.

=head1 AUTHORS

=over 4

=item *

David Helkowski

=item *

Nigel Metheringham

=back

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by David Helkowski.

This is free software, licensed under:

  The GNU General Public License, Version 2, June 1991

=cut


__END__