blib/lib/Uplug/XML/SubTree.pm untested

filter: Statementstmt 0.0% 0 / 141 Branchbran 0.0% 0 / 36 Conditioncond 0.0% 0 / 12 MC/DCmcdc 0.0% 0 / 8 Subroutinesub 0.0% 0 / 32 Podpod 0.0% 0 / 30 totaltotal 0.0% 0 / 259 CC 19 SCAR 25.1
CC
19
Cov
0%
XmlTreeStart
42.0
parse
30.0
setTags
20.0
CRAP 12.3
1  
2 # Copyright (C) 2004 Jörg Tiedemann <joerg@stp.ling.uu.se>
3 #####################################################################
4 #
5 #
6 #
7 #####################################################################
8 # $Author$
9 # $Id$
10 #
11 #
12  
13 package Uplug::XML::SubTree;
14  
15  
16  
17 use strict;
18 use XML::Parser;
19  
20  
21 our $DOCROOT='document';
22 our $SUBTREEROOT='.*';
23 our $IGNOREWARNINGS=1;
24  
25  
26 sub new{
27 my $class=shift;
28 my $self={};
29 bless $self,$class;
30 $self->init(@_);
31 return $self;
32 }
33  
34  
35 sub init{
36 my $self=shift;
37 my ($SubTreeRoot,$DocRoot,$DocBody)=@_;
38  
39 if (not ref($self->{XmlParser})){
40 $self->{XmlParser}=
41 new XML::Parser(Handlers => {Start => \&XmlTreeStart,
42 End => \&XmlTreeEnd,
43 Default => \&XmlTreeChar,
44 XMLDecl => \&XmlDecl,
45 # Doctype => \&XmlDoctype
46 },);
47 }
48 $self->{XmlHandle}=$self->{XmlParser}->parse_start;
49 $self->setTags($SubTreeRoot,$DocRoot,$DocBody);
50 $self->{XmlHandle}->{XmlProlog}='';
51 }
52  
53 sub parser{return $_[0]->{XmlParser};}
54 sub handle{return $_[0]->{XmlHandle};}
55  
56 #----------------------------------------------
57 # get handles and set handles for XML::Parser
58  
59 sub starthandle{return \&XmlTreeStart;}
60 sub endhandle{return \&XmlTreeEnd;}
61 sub charhandle{return \&XmlTreeChar;}
62 sub declhandle{return \&XmlTreeDecl;}
63  
64 sub setStarthandle{$_[0]->{XmlParser}->setHandlers('Start',$_[1]);}
65 sub setEndhandle{$_[0]->{XmlParser}->setHandlers('End',$_[1]);}
66 sub setCharhandle{$_[0]->{XmlParser}->setHandlers('Default',$_[1]);}
67 sub setDeclhandle{$_[0]->{XmlParser}->setHandlers('XMLDecl',$_[1]);}
68  
69 #---------------------------------------------------------------------------
70 # set document-specific XML tags for the XML::Parser
71 # and compile regular expressions
72  
73 sub setTags{
74 my $self=shift;
75 my ($SubTreeRoot,$DocRoot,$DocBody)=@_;
76  
77 if (not $SubTreeRoot){$SubTreeRoot=$SUBTREEROOT;}
78 $self->{XmlHandle}->{SubTreeRoot}=$SubTreeRoot;
79 $self->{XmlHandle}->{DocRootTag}=$DocRoot if ($DocRoot);
80 $self->{XmlHandle}->{DocBodyTag}=$DocBody if ($DocBody);
81 $self->CompileTagREs();
82 }
83  
84  
85 #--------------------------------------------------
86 # compile regular expressions for matching XML-tags
87  
88 sub CompileTagREs{
89 my $self=shift;
90 foreach my $t ('DocRootTag','SubTreeRoot','DocBodyTag'){
91 $self->{XmlHandle}->{$t.'RE'}=qr/^($self->{XmlHandle}->{$t})$/;
92 }
93 }
94  
95 #-----------------------------------------------------
96 # parse XML-strings and return the next XML-sub-tree
97 # - uses XML::Parser
98 #
99 # next($root)
100 # $root ---> root tag of the XML sub-tree
101  
102 sub parse{
103 my $self=shift;
104 my $xml=shift;
105 my $root=shift;
106 if (($root) and ($root ne $self->SubTreeRoot)){
107 $self->setTags($root);
108 }
109  
110 my $header=undef;
111 my $tail=undef;
112  
113 eval { $self->{XmlHandle}->parse_more($xml); };
114  
115 if ($@){
116 if (not $IGNOREWARNINGS){
117 warn $@;
118 print STDERR $_;
119 }
120 $header=$self->{XmlHandle}->{BeforeSubTree}.$_;
121 $self->{XmlHandle}->{SubTreeEnded}=undef;
122 $self->{XmlHandle}=$self->{XmlParser}->parse_start; # re-start
123 my $ParseStr=$self->{XmlHandle}->{XmlProlog}; # XML parsern!
124 eval { $self->{XmlHandle}->parse_more($ParseStr); };
125 return 2;
126 }
127 $self->{BeforeSubTree}=$self->{XmlHandle}->{BeforeSubTree}; # header
128 $self->{SubTreeRoot}=$self->{XmlHandle}->{SubTreeEnded}; # root-tag
129 if ($self->{XmlHandle}->{SubTreeEnded}){
130 my $subtree=$self->{XmlHandle}->{SubTreeString};
131 $self->{XmlHandle}->{BeforeSubTree}=undef;
132 $self->{XmlHandle}->{SubTreeString}=undef;
133 $self->{XmlHandle}->{SubTreeEnded}=undef;
134 return $subtree;
135 }
136 return undef;
137 }
138  
139 sub XmlProlog{
140 my $self=shift;
141 return $self->{XmlHandle}->{XmlProlog};
142 }
143  
144 sub SubTreeRoot{
145 my $self=shift;
146 return $self->{XmlHandle}->{SubTreeRoot};
147 }
148  
149 sub DocRootTag{
150 my $self=shift;
151 return $self->{XmlHandle}->{DocRootTag};
152 }
153  
154 sub DocBodyTag{
155 my $self=shift;
156 return $self->{XmlHandle}->{DocBodyTag};
157 }
158  
159 sub DocRoot{
160 my $self=shift;
161 return $self->{XmlHandle}->{DocRoot};
162 }
163  
164 sub DocBody{
165 my $self=shift;
166 return $self->{XmlHandle}->{DocBody};
167 }
168  
169 sub NewDoc{
170 my $self=shift;
171 if ($self->{XmlHandle}->{NewDoc}){
172 $self->{XmlHandle}->{NewDoc}=0;
173 return 1;
174 }
175 return 0;
176 }
177  
178 sub NewBody{
179 my $self=shift;
180 if ($self->{XmlHandle}->{NewBody}){
181 $self->{XmlHandle}->{NewBody}=0;
182 return 1;
183 }
184 return 0;
185 }
186  
187  
188  
189 sub header{
190 my $self=shift;
191 return $self->{BeforeSubTree};
192 }
193  
194 sub root{
195 my $self=shift;
196 return $self->{SubTreeRoot};
197 }
198  
199  
200 #---------------------------------------------------------------------------
201 #---------------------------------------------------------------------------
202 # subroutines for the XML-parser
203 #
204  
205 sub XmlTreeStart{
206 my $p=shift;
207 my $e=shift;
208  
209 #--------------------------------------------------
210 # document root tags are parsed ... but ignored
211 #--------------------------------------------------
212 if ((defined $p->{DocRootTagRE}) and ($e=~/$p->{DocRootTagRE}/)){
213 $p->{BeforeSubTree}='';
214 $p->{DocRootTag}=$e;
215 $p->{DocRootTagRE}=qr/^($p->{DocRootTag})$/;
216 $p->{NewDoc}=1;
217 %{$p->{DocRoot}}=@_;
218 return;
219 }
220  
221 #--------------------------------------------------
222 # a new subtree starts!
223 #--------------------------------------------------
224 if ($e=~/$p->{SubTreeRootRE}/){
225 if ($p->{SubTreeString}){
226 $p->{BeforeSubTree}.=$p->{SubTreeString}
227 }
228 $p->{SubTreeStarted}=$1;
229 $p->{SubTreeEnded}=0;
230 $p->{SubTreeString}=$p->original_string;
231 }
232 #--------------------------------------------------
233 # we are inside a valid subtree!
234 #--------------------------------------------------
235 elsif($p->{SubTreeStarted}){
236 $p->{SubTreeString}.=$p->original_string;
237 }
238 #--------------------------------------------------
239 # ... neither inside nor at the beginning of a new one
240 #--------------------------------------------------
241 else{
242 if ((defined $p->{DocBodyTagRE}) and ($e=~/$p->{DocBodyTagRE}/)){
243 $p->{DocBodyTag}=$e;
244 $p->{DocBodyTagRE}=qr/^($p->{DocBodyTag})$/;
245 $p->{NewBody}=1;
246 %{$p->{DocBody}}=@_;
247 }
248 $p->{BeforeSubTree}.=$p->original_string;
249 }
250 }
251  
252 sub XmlTreeEnd{
253 my ($p,$e)=@_;
254  
255 #--------------------------------------------------
256 # the subtree ended!
257 #--------------------------------------------------
258 if (($e=~/$p->{SubTreeRootRE}/) and
259 ($p->{SubTreeStarted} eq $1)){
260 $p->{SubTreeStarted}=0;
261 $p->{SubTreeEnded}=$1;
262 # $p->{BeforeSubTree}=~s/\s*$/\n/s;
263 # $p->{BeforeSubTree}=~s/^\s*//s;
264 $p->{SubTreeString}.=$p->original_string;
265 }
266 #--------------------------------------------------
267 # still inside ...
268 #--------------------------------------------------
269 elsif($p->{SubTreeStarted}){
270 $p->{SubTreeString}.=$p->original_string;
271 }
272 #--------------------------------------------------
273 # neither inside nor at the end
274 #--------------------------------------------------
275 else{
276 $p->{BeforeSubTree}.=$p->original_string;
277 }
278 }
279 sub XmlTreeChar{
280 my ($p,$e)=@_;
281  
282 #--------------------------------------------------
283 # inside a subtree -> save the string
284 #--------------------------------------------------
285 if ($p->{SubTreeStarted}){
286 $p->{SubTreeString}.=$p->original_string;
287 }
288 #--------------------------------------------------
289 # not inside?! -> save string as header
290 #--------------------------------------------------
291 else{
292 $p->{BeforeSubTree}.=$p->original_string;
293 }
294 }
295  
296 sub XmlDecl{
297 my ($p,$v,$e,$s)=@_;
298  
299 $p->{XmlProlog}=$p->original_string;
300 $p->{XmlEncoding}=$e;
301 $p->{XmlVersion}=$v;
302 }
303  
304 sub XmlDoctype{
305 my ($p,$name,$sysid,$publid,$internal)=@_;
306 }
307