src/ActiveDoc/SimpleDoc.pm

#
# SimpleDoc.pm
#
# Originally Written by Christopher Williams
#
# Description
# -----------
# Simple multi parsing functionality and group manipulation
#
# Interface
# ---------
# new([DocVersionTag])          : A new ActiveDoc object. You can also
#                                 specify an alternative doc version tag
# filetoparse([filename])       : Set/Return the filename of document
# newparse(parselabel) : Create a new parse type
# parse(parselabel)    : Parse the document file for the given parse level
# addtag(parselabel,tagname,start,obj,[text,obj,end,obj]) :
#                                Add tags to the parse given by label
# grouptag(tagname, parselabel) : Allow a tag to switch context 
#                                 - if not you can never turn a context off!
# checktag(tagname, hashref, param) : check for existence of param in
#                                       hashref from a tag call
# includeparse(local_parsename, objparsename, activedoc) : copy the parse from 
#                                                       one object to another
# currentparser() : return the current parser object
# currentparsename([name]) : get/set current parse name
#
# addignoretags(parsename) : add <ignore> </igonore> tags funtionality to the
#                               specified parse
# opengroup(name) : declare a group to be open
# closegroup(name) : declare a group to be closed
# allowgroup(name,parse) : allow a group so named
# disallowgroup(name,parse) : disallow the named group
# restoregroup(name,parse) : restore group access setting (that before last change)
# doctype()             : return the (type,version) of the document
#                         as specified by the DocVersionTag
# filenameref(string)   : A string to refer to the file in parse error messages
#                         etc. Default is filetoparse
# --------------- Error handling routines ---------------
# verbose(string)       : Print string in verbosity mode
# verbosity(0|1)        : verbosity off|on 
# line()                : return the current line number in the current parse
# tagstartline()        : return the line number where the current tag was
#                         opened
# parseerror(string)   :  print error and associate with line number etc.
# error(string) : handle an error

package ActiveDoc::SimpleDoc;
require 5.004;
use ActiveDoc::Parse;

sub new {
        my $class=shift;
        $self={};
        bless $self, $class;
        $self->_initdoc("doc",@_);
        return $self;
}

sub doctype {
        my $self=shift;
        my $rv=1;

        undef $self->{docversion};
        undef $self->{doctype};
        $self->parse("doc");
        return ($self->{doctype},$self->{docversion});
}

sub filenameref {
        my $self=shift;
        if ( @_ ) {
           $self->{filenameref}=shift;
        }
        return (defined $self->{filenameref})?$self->{filenameref}
                                             :$self->filetoparse();
}

sub _initdoc {
        my $self=shift;
        my $parsename=shift;

        $self->{doctag}="DOC";
        if ( @_ ) {
          $self->{doctag}=shift;
        }
        $self->newparse($parsename);
        $self->addtag($parsename,$self->{doctag},\&Doc_Start, $self);
}

sub verbosity {
        my $self=shift;
        $self->{verbose}=shift;
}

sub verbose {
        my $self=shift;
        my $string=shift;

        if ( $self->{verbose} ) {
          print ">".ref($self)."($self) : \n->".$string."\n";
        }
}

# ----- parse related routines --------------
sub parse {
        my $self=shift;
        $parselabel=shift;

        my $file=$self->filetoparse();
        if ( -f $file ) {
          if ( exists $self->{parsers}{$parselabel} ) {
            $self->verbose("Parsing $parselabel in file $file");
            $self->{currentparsename}=$parselabel;
            $self->{currentparser}=$self->{parsers}{$parselabel};
            $self->{parsers}{$parselabel}->parse($file,@_);
            delete $self->{currentparser};
            $self->{currentparsename}="";
            $self->verbose("Parse $parselabel Complete");
          }
        }
        else {
          $self->error("Cannot parse \"$parselabel\" - file $file not known");
        }
}

sub currentparsename {
        my $self=shift;
        @_?$self->{currentparsename}=shift
          :(defined $self->{currentparsename}?$self->{currentparsename}:"");
}

sub currentparser {
        my $self=shift;
        return $self->{currentparser};
}


sub newparse {
        my $self=shift;
        my $parselabel=shift;

        $self->{parsers}{$parselabel}=ActiveDoc::Parse->new();
}

sub addignoretags {
        my $self=shift;
        my $parselabel=shift;
        $self->{parsers}{$parselabel}->addignoretags();
}

sub cleartags {
        my $self=shift;
        my $parselabel=shift;

        $self->{parsers}{$parselabel}->cleartags();
}


sub includeparse {
        my $self=shift;
        my $parselabel=shift;
        my $remoteparselabel=shift;
        my $activedoc=shift;

        # Some error trapping
        if ( ! exists $self->{parsers}{$parselabel} ) {
          $self->error("Unknown local parse name specified");
        }
        if ( ! exists $activedoc->{parsers}{$remoteparselabel} ) {
          $self->error("Unknown parse name specified in remote obj $activedoc");
        }

        #
        my $rp=$activedoc->{parsers}{$remoteparselabel};
        $self->{parsers}{$parselabel}->includeparse($rp);
}

sub addtag {
        my $self=shift;
        my $parselabel=shift;
        if ( ( $#_ != 6 ) && ( $#_ != 2) ) {
                $self->error("Incorrect addtags specification\n".
                                "called with :\n@_ \n");
        }
        $self->{parsers}{$parselabel}->addtag(@_);
}

sub filetoparse {
        my $self=shift;

        if ( @_ ) {
           $self->{filename}=shift;
        }
        return $self->{filename};
}
# --------- Group services
sub grouptag {
        my $self=shift;
        my $name=shift;
        my $parselabel=shift;

        $self->{parsers}{$parselabel}->contexttag($name);
}

sub opengroup {
        my $self=shift;
        my $name=shift;

        if ( defined $self->currentparser ) {
           $self->currentparser()->opencontext($name);
        }
        else {
           $self->error("Cannot Call opengroup outside of a parse (".
                        caller().")");
        }
}

sub closegroup {
        my $self=shift;
        my $name=shift;

        if ( defined $self->currentparser ) {
           $self->currentparser()->closecontext($name);
        }
        else {
           $self->error("Cannot Call closegroup outside of a parse (".
                        caller().")");
        }
}

sub allowgroup {
        my $self=shift;
        my $name=shift;
        my $parselabel=shift;

        $self->{parsers}{$parselabel}->includecontext($name);
}

sub disallowgroup {
        my $self=shift;
        my $name=shift;
        my $parselabel=shift;

        $self->{parsers}{$parselabel}->excludecontext($name);
}

# -------- Error Handling and Error services --------------

sub error {
        my $self=shift;
        my $string=shift;

        die $string."\n";
}

sub parseerror {
        my $self=shift;
        my $string=shift;

        if ( $self->currentparsename() eq "" ) {
                $self->error("Error In file ".$self->filenameref."\n".$string);
        }
        else {
         $line=$self->line();
         print "Parse Error in ".$self->filenameref().", line ".
                                        $line."\n";
         print $string."\n";
         exit;
        }
}

sub checktag {
        my $self=shift;
        my $tagname=shift;
        my $hashref=shift;
        my $param=shift;

        if ( ! exists $$hashref{$param} ) {
          $self->parseerror("Incomplete Tag <$tagname> : $param required");
        }
}

sub line {
        my $self=shift;
        return $self->{currentparser}->line();
}

sub tagstartline {
        my $self=shift;
        return $self->{currentparser}->tagstartline();
}

# -- tag routines
sub Doc_Start {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        $self->checktag($name, $hashref, "type");
        $self->checktag($name, $hashref, "version");

        $self->{doctype}=$$hashref{'type'};
        $self->{docversion}=$$hashref{'version'};
}
Revision:	1.4
Committed:	Tue Dec 4 19:24:04 2001 UTC (23 years, 5 months ago) by sashby
Content type:	text/plain
Branch:	MAIN
CVS Tags:	V1_pre0, SCRAM_V1, SCRAMV1_IMPORT, V0_19_7, V0_19_6, V0_19_6p1, V0_19_5, SFATEST, V0_19_4, V0_19_4_pre3, V0_19_4_pre2, V0_19_4_pre1, V0_19_3, V0_19_2, V0_19_1
Branch point for:	V1_pre1, SCRAM_V1_BRANCH, V0_19_4_B
Changes since 1.3:	+0 -1 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	williamc	1.1	#
2			# SimpleDoc.pm
3			#
4			# Originally Written by Christopher Williams
5			#
6			# Description
7			# -----------
8	williamc	1.2	# Simple multi parsing functionality and group manipulation
9	williamc	1.1	#
10			# Interface
11			# ---------
12	williamc	1.3	# new([DocVersionTag]) : A new ActiveDoc object. You can also
13			# specify an alternative doc version tag
14	williamc	1.1	# filetoparse([filename]) : Set/Return the filename of document
15			# newparse(parselabel) : Create a new parse type
16			# parse(parselabel) : Parse the document file for the given parse level
17	williamc	1.3	# addtag(parselabel,tagname,start,obj,[text,obj,end,obj]) :
18	williamc	1.1	# Add tags to the parse given by label
19	williamc	1.2	# grouptag(tagname, parselabel) : Allow a tag to switch context
20			# - if not you can never turn a context off!
21	williamc	1.1	# checktag(tagname, hashref, param) : check for existence of param in
22			# hashref from a tag call
23			# includeparse(local_parsename, objparsename, activedoc) : copy the parse from
24			# one object to another
25			# currentparser() : return the current parser object
26			# currentparsename([name]) : get/set current parse name
27			#
28			# addignoretags(parsename) : add <ignore> </igonore> tags funtionality to the
29			# specified parse
30	williamc	1.2	# opengroup(name) : declare a group to be open
31			# closegroup(name) : declare a group to be closed
32			# allowgroup(name,parse) : allow a group so named
33			# disallowgroup(name,parse) : disallow the named group
34			# restoregroup(name,parse) : restore group access setting (that before last change)
35	williamc	1.3	# doctype() : return the (type,version) of the document
36			# as specified by the DocVersionTag
37			# filenameref(string) : A string to refer to the file in parse error messages
38			# etc. Default is filetoparse
39	williamc	1.1	# --------------- Error handling routines ---------------
40			# verbose(string) : Print string in verbosity mode
41			# verbosity(0\|1) : verbosity off\|on
42			# line() : return the current line number in the current parse
43			# tagstartline() : return the line number where the current tag was
44			# opened
45			# parseerror(string) : print error and associate with line number etc.
46			# error(string) : handle an error
47
48			package ActiveDoc::SimpleDoc;
49			require 5.004;
50			use ActiveDoc::Parse;
51
52			sub new {
53			my $class=shift;
54			$self={};
55			bless $self, $class;
56	williamc	1.3	$self->_initdoc("doc",@_);
57	williamc	1.1	return $self;
58			}
59
60	williamc	1.3	sub doctype {
61			my $self=shift;
62			my $rv=1;
63
64			undef $self->{docversion};
65			undef $self->{doctype};
66			$self->parse("doc");
67			return ($self->{doctype},$self->{docversion});
68			}
69
70			sub filenameref {
71			my $self=shift;
72			if ( @_ ) {
73			$self->{filenameref}=shift;
74			}
75			return (defined $self->{filenameref})?$self->{filenameref}
76			:$self->filetoparse();
77			}
78
79			sub _initdoc {
80			my $self=shift;
81			my $parsename=shift;
82
83			$self->{doctag}="DOC";
84			if ( @_ ) {
85			$self->{doctag}=shift;
86			}
87			$self->newparse($parsename);
88			$self->addtag($parsename,$self->{doctag},\&Doc_Start, $self);
89	williamc	1.1	}
90
91			sub verbosity {
92			my $self=shift;
93			$self->{verbose}=shift;
94			}
95
96			sub verbose {
97			my $self=shift;
98			my $string=shift;
99
100			if ( $self->{verbose} ) {
101			print ">".ref($self)."($self) : \n->".$string."\n";
102			}
103			}
104
105			# ----- parse related routines --------------
106			sub parse {
107			my $self=shift;
108			$parselabel=shift;
109
110			my $file=$self->filetoparse();
111	williamc	1.3	if ( -f $file ) {
112	williamc	1.1	if ( exists $self->{parsers}{$parselabel} ) {
113			$self->verbose("Parsing $parselabel in file $file");
114			$self->{currentparsename}=$parselabel;
115			$self->{currentparser}=$self->{parsers}{$parselabel};
116			$self->{parsers}{$parselabel}->parse($file,@_);
117			delete $self->{currentparser};
118			$self->{currentparsename}="";
119			$self->verbose("Parse $parselabel Complete");
120			}
121			}
122			else {
123	williamc	1.3	$self->error("Cannot parse \"$parselabel\" - file $file not known");
124	williamc	1.1	}
125			}
126
127			sub currentparsename {
128			my $self=shift;
129			@_?$self->{currentparsename}=shift
130			:(defined $self->{currentparsename}?$self->{currentparsename}:"");
131			}
132
133			sub currentparser {
134			my $self=shift;
135			return $self->{currentparser};
136			}
137
138
139			sub newparse {
140			my $self=shift;
141			my $parselabel=shift;
142
143			$self->{parsers}{$parselabel}=ActiveDoc::Parse->new();
144			}
145
146			sub addignoretags {
147			my $self=shift;
148			my $parselabel=shift;
149			$self->{parsers}{$parselabel}->addignoretags();
150			}
151
152			sub cleartags {
153			my $self=shift;
154			my $parselabel=shift;
155
156			$self->{parsers}{$parselabel}->cleartags();
157			}
158
159
160			sub includeparse {
161			my $self=shift;
162			my $parselabel=shift;
163			my $remoteparselabel=shift;
164			my $activedoc=shift;
165
166			# Some error trapping
167			if ( ! exists $self->{parsers}{$parselabel} ) {
168			$self->error("Unknown local parse name specified");
169			}
170			if ( ! exists $activedoc->{parsers}{$remoteparselabel} ) {
171			$self->error("Unknown parse name specified in remote obj $activedoc");
172			}
173
174			#
175			my $rp=$activedoc->{parsers}{$remoteparselabel};
176			$self->{parsers}{$parselabel}->includeparse($rp);
177			}
178
179			sub addtag {
180			my $self=shift;
181			my $parselabel=shift;
182	williamc	1.3	if ( ( $#_ != 6 ) && ( $#_ != 2) ) {
183	williamc	1.1	$self->error("Incorrect addtags specification\n".
184			"called with :\n@_ \n");
185			}
186			$self->{parsers}{$parselabel}->addtag(@_);
187			}
188
189			sub filetoparse {
190			my $self=shift;
191
192			if ( @_ ) {
193			$self->{filename}=shift;
194			}
195			return $self->{filename};
196	williamc	1.2	}
197			# --------- Group services
198			sub grouptag {
199			my $self=shift;
200			my $name=shift;
201			my $parselabel=shift;
202
203			$self->{parsers}{$parselabel}->contexttag($name);
204			}
205
206			sub opengroup {
207			my $self=shift;
208			my $name=shift;
209
210			if ( defined $self->currentparser ) {
211			$self->currentparser()->opencontext($name);
212			}
213			else {
214			$self->error("Cannot Call opengroup outside of a parse (".
215			caller().")");
216			}
217			}
218
219			sub closegroup {
220			my $self=shift;
221			my $name=shift;
222
223			if ( defined $self->currentparser ) {
224			$self->currentparser()->closecontext($name);
225			}
226			else {
227			$self->error("Cannot Call closegroup outside of a parse (".
228			caller().")");
229			}
230			}
231
232			sub allowgroup {
233			my $self=shift;
234			my $name=shift;
235			my $parselabel=shift;
236
237			$self->{parsers}{$parselabel}->includecontext($name);
238			}
239
240			sub disallowgroup {
241			my $self=shift;
242			my $name=shift;
243			my $parselabel=shift;
244
245			$self->{parsers}{$parselabel}->excludecontext($name);
246	williamc	1.1	}
247
248			# -------- Error Handling and Error services --------------
249
250			sub error {
251			my $self=shift;
252			my $string=shift;
253
254			die $string."\n";
255			}
256
257			sub parseerror {
258			my $self=shift;
259			my $string=shift;
260
261			if ( $self->currentparsename() eq "" ) {
262	williamc	1.3	$self->error("Error In file ".$self->filenameref."\n".$string);
263	williamc	1.1	}
264			else {
265			$line=$self->line();
266	williamc	1.3	print "Parse Error in ".$self->filenameref().", line ".
267	williamc	1.1	$line."\n";
268			print $string."\n";
269			exit;
270			}
271			}
272
273			sub checktag {
274			my $self=shift;
275			my $tagname=shift;
276			my $hashref=shift;
277			my $param=shift;
278
279			if ( ! exists $$hashref{$param} ) {
280			$self->parseerror("Incomplete Tag <$tagname> : $param required");
281			}
282			}
283
284			sub line {
285			my $self=shift;
286			return $self->{currentparser}->line();
287			}
288
289			sub tagstartline {
290			my $self=shift;
291			return $self->{currentparser}->tagstartline();
292			}
293
294	williamc	1.3	# -- tag routines
295			sub Doc_Start {
296			my $self=shift;
297			my $name=shift;
298			my $hashref=shift;
299
300			$self->checktag($name, $hashref, "type");
301			$self->checktag($name, $hashref, "version");
302
303			$self->{doctype}=$$hashref{'type'};
304			$self->{docversion}=$$hashref{'version'};
305			}