src/ActiveDoc/Switcher.pm

# Switcher Module
#
# Look for elements given in input has in a string
# If found then call a routine name with the same name
# Implemented as an object to maintain state info between each line
# processed.
# Interface
# ---------
# new(file,objectref) : A new object -  filename of file to parse
#                                   objectref->of the methods
# usetags(tagobjref)               : Specify a tagcontainer set to direct to
#                                    to the desired routines
# usegroupchecker(groupchecker)    : Set a groupchecker
# parse()                          : Parse the file                             
# line()                    : return the current line number of the parse
# tagstartline()            : return the line number on which the current
#                             tag was opened
# stream(filehandle)        : stream output to the filehandle if not handled
#                               in any other way
package ActiveDoc::Switcher;
require 5.001;
use Carp;

sub new { 
        my $class=shift;
        my $file=shift;
        my $objectname=shift;
        my $groupchecker=shift;

        $self = {};
        $self->{allw}=$objectname;
        bless $self, $class;
        $self->_initialise($file);
        return $self;
}

sub stream {
        my $self=shift;

        $self->{stream}=shift;
}

sub streamexclude {
        my $self=shift;
        my $tag=shift;

        $tag=~tr/A-Z/a-z/;
        $self->{streamexclude}{$tag}=1;
}

sub _initialise (hash1) {
        my $self=shift;
        $self->{filename}=shift;

        # add a default groupchecker
          use ActiveDoc::GroupChecker;
          $self->{groupchecker}=GroupChecker->new();
          $self->{groupchecker}->include("all");

        # Add a default TagContainer
          use ActiveDoc::TagContainer;
          $self->{tagcontainer}=ActiveDoc::TagContainer->new();
         
}

sub usetags {
        my $self=shift;
        my $tagcontainer=shift;

        $self->{tagcontainer}=$tagcontainer;
}

sub usegroupchecker {
        my $self=shift;
        my $ref=shift;
        
        $self->{groupchecker}=$ref;
}

sub parse {
        my $self=shift;
        my $char;
        my $buf;
        $self->{linecount}=0;
        $self->_resetvars();
        $self->{streamstore}="";
        $self->{streamtmp}="";

        # Open the file
        use FileHandle;
        local $filehandle;
        $filehandle=FileHandle->new();
        $filehandle->open("<".$self->{filename})
           or return 1;
        # The buffering seems all messed up - best not to use it
        $filehandle->setvbuf($buf, _IONBF, 3000);

        # Start file processing
        while ( ($_=<$filehandle>) ) {
         $self->{linecount}++;
         $self->{currentline}=$_;
         $self->{stringpos}=0;
         while ( ($char=$self->_nextchar()) ne "" ) {
           $self->_checkchar($char);
         } # end char while
        } # End String while loop
        undef $filehandle;
        # make sure we close the last buffer
        $self->_calltag($self->{textcontext}, $self->{textcontext},
                                                        $self->_getstore());
        #$self->_printstream();
}

#
# return the current line number
#
sub line {
        my $self=shift;
        return $self->{linecount};
}

# return the line the current tag was opened
sub tagstartline {
        my $self=shift;
        $self->{tagstart};
}
# --------------- Utility routines ----------------------------
 
#
# Some initialisation of test suites
#
sub _resetvars {
        my $self=shift;
        $self->{quotes}=0;
        $self->{lastlabel}="";
        $self->{textcontext}='none';
        $self->{tagcontext}="text";
        $self->_resetstore();
}

#
# Check for control characters
#
sub _checkchar {
        my $self=shift;
        my $char=shift;
        my $string;


        # ---- In a tag
        if ( $self->{tagcontext}=~/tag/ ) {
           if ( ! $self->_quotetest($char) ) {
            if ( ! $self->_labeltest($char) ) {
             if ( $char eq ">") { $self->_closetag(); }
             else { $self->_putstore($char); }
            }
           }  
        }
        # ------ Outside a tag
        else { 
           if ( $char eq "<") { $self->_opentag() }
           else { $self->_putstore($char) } 
        }
}


#
# Return the next character from the current string buffer
#
sub _nextchar() {
        my $self=shift;
        my $char;
        $char=substr($self->{currentline},$self->{stringpos}++,1);
        #print "Debug : Fetching character $char\n";

        # Keep a record for any stream processes
        $self->{streamstore}=$self->{streamstore}.$char;

        return $char;
}

sub _opentag {
        my $self=shift;
        my $char;

        # Keep a record of where the tag started
        $self->{tagstart}=$self->line();

        # Close the last text segment
        $self->{streamtmp}=$self->_popstream();
        $self->_calltag($self->{textcontext}, $self->{textcontext}, 
                                                        $self->_getstore());
        $self->_resetstore();
        $self->_resetlabels();

        # Do we have an opening or closing tag?
        if ( ($char=$self->_nextchar()) eq "/" ) { #we have a closing tag
          $self->{tagcontext}="endtag";
        }
        else { # an opening tag
          $self->{tagcontext}="starttag";
          $self->_checkchar($char);
        }
        #print "\nDebug : Opening $self->{tagcontext}\n";
}

#
# Close a tag
#
sub _closetag {
        my $self=shift;
        my $tagroutine;

        # -- Finish off any labels/get tagname
        $self->_closelabel();
        
        # -- Call the associated tag function if appropriate
        if ( defined $self->{tagname} ) {
         $tagroutine=$self->{tagname}."_".$self->{tagcontext};
         $self->_calltag($tagroutine, $self->{tagname}, 
                                                        $self->{tagvar});
         #print "\nDebug : Closing Tag $tagroutine\n";

         # -- Now make sure the text context is set for calling routines to
         # -- deal with text portions outside of tags
         if ( ($self->{tagcontext} eq "starttag") ) {
           if ( $self->{tagcontainer}->definescontext($self->{tagname}) ) {
              push @{$self->{textstack}} , $self->{textcontext};
              $self->{textcontext}=$self->{tagname};
           }
         }
         else {
          if ( $#{$self->{textstack}} > -1 ) {
            if ( $self->{textcontext} eq $self->{tagname} ) {   
               $self->{textcontext}=pop @{$self->{textstack}};
            } 
            else { #The tag we are closing is not the last one so
                   # we keep our current context.
               $self->_removefromstack($self->{tagname},$self->{textstack});
            }

          }
          else { # more close tags than open ones
             print "Warning : Unmatched </...> tag on line ".
                                        $self->line()."\n";     
          }
         }
        }
        # Reset context back to text
        $self->{tagcontext}="text";
}

sub _calltag {
        my $self=shift;
        my $tagroutine=shift;
        my @args=@_;
        my $rt;
        my $found=0;

        if ( $self->{groupchecker}->status() ||
                ( $self->{tagcontainer}->inquiregroup($tagroutine)) ) {
          ($rt,$obj)=$self->{tagcontainer}->getroutine($tagroutine);
          if ( $rt ne "" ) {
             if ( ! defined $obj ) {
               &{$rt}( $self->{allw},@_);
             }
             else {
               &{$rt}( $obj,@_);
             }
             $found=1;
          }
        }
        
        # stream function
        if ( ! exists $self->{streamexclude}{$tagroutine} ) {
            $self->_printstream();
        }
        $self->_clearstream();
}

sub _clearstream {
        my $self=shift;
        $self->{streamstore}=(($self->{streamtmp} ne "")?$self->{streamtmp}:"");
        $self->{streamtmp}="";
}

sub _popstream {
        my $self=shift;
        $self->{streamstore}=~s/(.*)(.)$/$1/;
        return $2;
}

sub _printstream {

        my $self=shift;

        # Stream output functionality
        if ( defined $self->{stream} ) {
            print {$self->{stream}} "$self->{streamstore}";
        }
}

sub _removefromstack {
        my $self=shift;
        my $name=shift;
        my $stack=shift;
        my $this;

        undef @tempstack;
        #print "In  ----".$#{$stack};
        # Keep popping until we find our string
        while ( ($this=(pop @{$stack})) ne "$name") {
          push @tempstack, $this; 
          if ( $#{$stack} < 0 ) { last; }
        }
        # Now put them back
        while ( $#tempstack>-1) {
          $this=pop @tempstack;
          push @{$stack}, $this;
        }
        #print " Out ----".$#{$stack};
}

#
# Quote handling
#

sub _quotetest {
        my $self=shift;
        my $char=shift;

        # --- Are we already in a quote context?
        if ( $self->{quotes} ) {
         if ( $char eq $self->{openquote} ) {
           $self->{quotes}=0;
         }
         else {
           $self->_putstore($char);
         }
        }
        # --- Unquoted Context
        elsif ( (($char eq "\"") || ($char eq "\'") || ($char eq "\`")) ) {
           $self->{quotes}=1;
           $self->{openquote}=$char;
        }
        else { return 0; } # Return zero if not quoted
        return 1;          # 1 otherwise
}

#
# Label handling
#
sub _labeltest {
        my $self=shift;
        my $char=shift;

        # Spaces are markers between tags
        if ( ($char eq " ") || ($char eq "\n") || ($char eq "\t")) {
          $self->_closelabel();
        }
        # Check for a change in label status
        elsif ( $char eq "=" ) {
                $self->{lastlabel}=$self->_getstore();
                $self->_resetstore();
        }
        else {
             return 0;
        }
        return 1;
}

sub _resetlabels {
        my $self=shift;
        undef $self->{tagvar};
        undef $self->{tagname};
}

sub _closelabel {
        my $self=shift;

        # Do we have a label name?
        if ( $self->{lastlabel} ne "" ) {
         $self->{tagvar}{$self->{lastlabel}}=$self->_getstore();
         $self->{lastlabel}="";
        }
        elsif ( $self->_getstore() ne "") { 
         # Then it must be the tag name
         if ( ! defined $self->{tagname} ) {
            ($self->{tagname}=$self->_getstore())=~tr/A-Z/a-z/;
         }
         else {
            die ">Tag syntax error in $self->{tagname} on line ".
                $self->line()." of file \n$self->{filename}";
         }
        }
        $self->_resetstore();
}

#
# Character Store management interface
#
sub _putstore() {
        my $self=shift;
        my $char=shift;

        $self->{stringbuff}=$self->{stringbuff}.$char;
}

sub _getstore() {
        my $self=shift;

        return $self->{stringbuff};
}

sub _resetstore {
        my $self=shift;
        $self->{stringbuff}="";
}
Revision:	1.13.2.4
Committed:	Fri May 12 10:29:43 2000 UTC (25 years ago) by williamc
Content type:	text/plain
Branch:	V0_9branch
Changes since 1.13.2.3:	+5 -3 lines
Log Message:	Fix for no context tags
#	User	Rev	Content
1	williamc	1.1	# Switcher Module
2			#
3			# Look for elements given in input has in a string
4			# If found then call a routine name with the same name
5			# Implemented as an object to maintain state info between each line
6			# processed.
7			# Interface
8			# ---------
9			# new(file,objectref) : A new object - filename of file to parse
10			# objectref->of the methods
11			# usetags(tagobjref) : Specify a tagcontainer set to direct to
12			# to the desired routines
13			# usegroupchecker(groupchecker) : Set a groupchecker
14			# parse() : Parse the file
15			# line() : return the current line number of the parse
16	williamc	1.12	# tagstartline() : return the line number on which the current
17			# tag was opened
18	williamc	1.6	# stream(filehandle) : stream output to the filehandle if not handled
19			# in any other way
20	williamc	1.3	package ActiveDoc::Switcher;
21	williamc	1.1	require 5.001;
22			use Carp;
23
24			sub new {
25			my $class=shift;
26			my $file=shift;
27			my $objectname=shift;
28			my $groupchecker=shift;
29
30	williamc	1.4	$self = {};
31	williamc	1.1	$self->{allw}=$objectname;
32			bless $self, $class;
33			$self->_initialise($file);
34			return $self;
35			}
36
37	williamc	1.6	sub stream {
38			my $self=shift;
39
40			$self->{stream}=shift;
41			}
42
43	williamc	1.8	sub streamexclude {
44			my $self=shift;
45			my $tag=shift;
46
47			$tag=~tr/A-Z/a-z/;
48			$self->{streamexclude}{$tag}=1;
49			}
50
51	williamc	1.1	sub _initialise (hash1) {
52			my $self=shift;
53			$self->{filename}=shift;
54
55			# add a default groupchecker
56			use ActiveDoc::GroupChecker;
57			$self->{groupchecker}=GroupChecker->new();
58			$self->{groupchecker}->include("all");
59
60			# Add a default TagContainer
61			use ActiveDoc::TagContainer;
62	williamc	1.3	$self->{tagcontainer}=ActiveDoc::TagContainer->new();
63	williamc	1.1
64			}
65
66			sub usetags {
67			my $self=shift;
68			my $tagcontainer=shift;
69
70			$self->{tagcontainer}=$tagcontainer;
71			}
72
73			sub usegroupchecker {
74			my $self=shift;
75			my $ref=shift;
76
77			$self->{groupchecker}=$ref;
78			}
79
80			sub parse {
81			my $self=shift;
82			my $char;
83	williamc	1.4	my $buf;
84	williamc	1.1	$self->{linecount}=0;
85			$self->_resetvars();
86	williamc	1.6	$self->{streamstore}="";
87	williamc	1.8	$self->{streamtmp}="";
88	williamc	1.1
89			# Open the file
90			use FileHandle;
91	williamc	1.6	local $filehandle;
92	williamc	1.4	$filehandle=FileHandle->new();
93	williamc	1.6	$filehandle->open("<".$self->{filename})
94	williamc	1.2	or return 1;
95	williamc	1.4	# The buffering seems all messed up - best not to use it
96	williamc	1.5	$filehandle->setvbuf($buf, _IONBF, 3000);
97	williamc	1.1
98			# Start file processing
99	williamc	1.4	while ( ($_=<$filehandle>) ) {
100	williamc	1.1	$self->{linecount}++;
101			$self->{currentline}=$_;
102			$self->{stringpos}=0;
103			while ( ($char=$self->_nextchar()) ne "" ) {
104			$self->_checkchar($char);
105			} # end char while
106			} # End String while loop
107	williamc	1.5	undef $filehandle;
108	williamc	1.13.2.2	# make sure we close the last buffer
109			$self->_calltag($self->{textcontext}, $self->{textcontext},
110			$self->_getstore());
111			#$self->_printstream();
112	williamc	1.1	}
113
114			#
115			# return the current line number
116			#
117			sub line {
118			my $self=shift;
119			return $self->{linecount};
120			}
121	williamc	1.12
122			# return the line the current tag was opened
123			sub tagstartline {
124			my $self=shift;
125			$self->{tagstart};
126			}
127	williamc	1.1	# --------------- Utility routines ----------------------------
128
129			#
130			# Some initialisation of test suites
131			#
132			sub _resetvars {
133			my $self=shift;
134			$self->{quotes}=0;
135			$self->{lastlabel}="";
136			$self->{textcontext}='none';
137			$self->{tagcontext}="text";
138			$self->_resetstore();
139			}
140
141			#
142			# Check for control characters
143			#
144			sub _checkchar {
145			my $self=shift;
146			my $char=shift;
147			my $string;
148
149	williamc	1.6
150	williamc	1.1	# ---- In a tag
151			if ( $self->{tagcontext}=~/tag/ ) {
152			if ( ! $self->_quotetest($char) ) {
153			if ( ! $self->_labeltest($char) ) {
154			if ( $char eq ">") { $self->_closetag(); }
155			else { $self->_putstore($char); }
156			}
157			}
158			}
159			# ------ Outside a tag
160			else {
161			if ( $char eq "<") { $self->_opentag() }
162			else { $self->_putstore($char) }
163			}
164			}
165
166
167			#
168			# Return the next character from the current string buffer
169			#
170			sub _nextchar() {
171			my $self=shift;
172			my $char;
173			$char=substr($self->{currentline},$self->{stringpos}++,1);
174	williamc	1.13.2.3	#print "Debug : Fetching character $char\n";
175	williamc	1.6
176			# Keep a record for any stream processes
177			$self->{streamstore}=$self->{streamstore}.$char;
178
179	williamc	1.1	return $char;
180			}
181
182			sub _opentag {
183			my $self=shift;
184			my $char;
185	williamc	1.12
186			# Keep a record of where the tag started
187			$self->{tagstart}=$self->line();
188	williamc	1.1
189			# Close the last text segment
190	williamc	1.8	$self->{streamtmp}=$self->_popstream();
191	williamc	1.1	$self->_calltag($self->{textcontext}, $self->{textcontext},
192			$self->_getstore());
193			$self->_resetstore();
194			$self->_resetlabels();
195
196			# Do we have an opening or closing tag?
197			if ( ($char=$self->_nextchar()) eq "/" ) { #we have a closing tag
198			$self->{tagcontext}="endtag";
199			}
200			else { # an opening tag
201			$self->{tagcontext}="starttag";
202			$self->_checkchar($char);
203			}
204			#print "\nDebug : Opening $self->{tagcontext}\n";
205			}
206
207			#
208			# Close a tag
209			#
210			sub _closetag {
211			my $self=shift;
212			my $tagroutine;
213
214			# -- Finish off any labels/get tagname
215			$self->_closelabel();
216
217			# -- Call the associated tag function if appropriate
218	williamc	1.13	if ( defined $self->{tagname} ) {
219			$tagroutine=$self->{tagname}."_".$self->{tagcontext};
220			$self->_calltag($tagroutine, $self->{tagname},
221	williamc	1.1	$self->{tagvar});
222	williamc	1.13.2.3	#print "\nDebug : Closing Tag $tagroutine\n";
223	williamc	1.1
224	williamc	1.13	# -- Now make sure the text context is set for calling routines to
225			# -- deal with text portions outside of tags
226	williamc	1.13.2.4	if ( ($self->{tagcontext} eq "starttag") ) {
227			if ( $self->{tagcontainer}->definescontext($self->{tagname}) ) {
228			push @{$self->{textstack}} , $self->{textcontext};
229			$self->{textcontext}=$self->{tagname};
230			}
231	williamc	1.13	}
232			else {
233	williamc	1.1	if ( $#{$self->{textstack}} > -1 ) {
234			if ( $self->{textcontext} eq $self->{tagname} ) {
235			$self->{textcontext}=pop @{$self->{textstack}};
236			}
237			else { #The tag we are closing is not the last one so
238			# we keep our current context.
239			$self->_removefromstack($self->{tagname},$self->{textstack});
240			}
241
242			}
243			else { # more close tags than open ones
244			print "Warning : Unmatched </...> tag on line ".
245			$self->line()."\n";
246			}
247	williamc	1.13	}
248	williamc	1.1	}
249			# Reset context back to text
250			$self->{tagcontext}="text";
251			}
252
253			sub _calltag {
254			my $self=shift;
255			my $tagroutine=shift;
256			my @args=@_;
257			my $rt;
258	williamc	1.6	my $found=0;
259	williamc	1.1
260			if ( $self->{groupchecker}->status() \|\|
261			( $self->{tagcontainer}->inquiregroup($tagroutine)) ) {
262	williamc	1.7	($rt,$obj)=$self->{tagcontainer}->getroutine($tagroutine);
263	williamc	1.1	if ( $rt ne "" ) {
264	williamc	1.7	if ( ! defined $obj ) {
265	williamc	1.1	&{$rt}( $self->{allw},@_);
266	williamc	1.7	}
267			else {
268			&{$rt}( $obj,@_);
269			}
270			$found=1;
271	williamc	1.1	}
272			}
273	williamc	1.6
274	williamc	1.8	# stream function
275			if ( ! exists $self->{streamexclude}{$tagroutine} ) {
276	williamc	1.6	$self->_printstream();
277			}
278			$self->_clearstream();
279			}
280
281			sub _clearstream {
282			my $self=shift;
283			$self->{streamstore}=(($self->{streamtmp} ne "")?$self->{streamtmp}:"");
284			$self->{streamtmp}="";
285			}
286
287			sub _popstream {
288			my $self=shift;
289			$self->{streamstore}=~s/(.*)(.)$/$1/;
290			return $2;
291			}
292
293			sub _printstream {
294
295			my $self=shift;
296
297			# Stream output functionality
298			if ( defined $self->{stream} ) {
299			print {$self->{stream}} "$self->{streamstore}";
300			}
301	williamc	1.1	}
302
303			sub _removefromstack {
304			my $self=shift;
305			my $name=shift;
306			my $stack=shift;
307			my $this;
308
309			undef @tempstack;
310			#print "In ----".$#{$stack};
311			# Keep popping until we find our string
312			while ( ($this=(pop @{$stack})) ne "$name") {
313			push @tempstack, $this;
314			if ( $#{$stack} < 0 ) { last; }
315			}
316			# Now put them back
317			while ( $#tempstack>-1) {
318			$this=pop @tempstack;
319			push @{$stack}, $this;
320			}
321			#print " Out ----".$#{$stack};
322			}
323
324			#
325			# Quote handling
326			#
327
328			sub _quotetest {
329			my $self=shift;
330			my $char=shift;
331
332			# --- Are we already in a quote context?
333			if ( $self->{quotes} ) {
334			if ( $char eq $self->{openquote} ) {
335			$self->{quotes}=0;
336			}
337			else {
338			$self->_putstore($char);
339			}
340			}
341			# --- Unquoted Context
342			elsif ( (($char eq "\"") \|\| ($char eq "\'") \|\| ($char eq "\`")) ) {
343			$self->{quotes}=1;
344			$self->{openquote}=$char;
345			}
346			else { return 0; } # Return zero if not quoted
347			return 1; # 1 otherwise
348			}
349
350			#
351			# Label handling
352			#
353			sub _labeltest {
354			my $self=shift;
355			my $char=shift;
356
357			# Spaces are markers between tags
358			if ( ($char eq " ") \|\| ($char eq "\n") \|\| ($char eq "\t")) {
359			$self->_closelabel();
360			}
361			# Check for a change in label status
362			elsif ( $char eq "=" ) {
363			$self->{lastlabel}=$self->_getstore();
364			$self->_resetstore();
365			}
366			else {
367			return 0;
368			}
369			return 1;
370			}
371
372			sub _resetlabels {
373			my $self=shift;
374			undef $self->{tagvar};
375	williamc	1.9	undef $self->{tagname};
376	williamc	1.1	}
377
378			sub _closelabel {
379			my $self=shift;
380
381			# Do we have a label name?
382			if ( $self->{lastlabel} ne "" ) {
383			$self->{tagvar}{$self->{lastlabel}}=$self->_getstore();
384			$self->{lastlabel}="";
385			}
386			elsif ( $self->_getstore() ne "") {
387	williamc	1.9	# Then it must be the tag name
388			if ( ! defined $self->{tagname} ) {
389			($self->{tagname}=$self->_getstore())=~tr/A-Z/a-z/;
390			}
391			else {
392	williamc	1.10	die ">Tag syntax error in $self->{tagname} on line ".
393	williamc	1.11	$self->line()." of file \n$self->{filename}";
394	williamc	1.9	}
395	williamc	1.1	}
396			$self->_resetstore();
397			}
398
399			#
400			# Character Store management interface
401			#
402			sub _putstore() {
403			my $self=shift;
404			my $char=shift;
405
406			$self->{stringbuff}=$self->{stringbuff}.$char;
407			}
408
409			sub _getstore() {
410			my $self=shift;
411
412			return $self->{stringbuff};
413			}
414
415			sub _resetstore {
416			my $self=shift;
417			$self->{stringbuff}="";
418			}