ViewVC Help

View File | Revision Log | Show Annotations | Root Listing

root/cvsroot/COMP/SCRAM/src/ActiveDoc/ActiveDoc.pm

Comparing COMP/SCRAM/src/ActiveDoc/ActiveDoc.pm (file contents):
Revision 1.4 by williamc, Mon Sep 27 14:05:22 1999 UTC vs.
Revision 1.16 by williamc, Thu Jan 20 18:40:39 2000 UTC

#	Line 1 | Line 1
1		#
2	<	# The base functionality for the ActiveDocument - inherits from Basetags
2	>	# ActiveDoc.pm
3	>	#
4	>	# Originally Written by Christopher Williams
5	>	#
6	>	# Description
7		#
4	–	# Inherits from BaseTags
5	–	# --------
8		# Interface
9		# ---------
10	<	# new(filename, DOChandler): create a new object based on a file and
11	<	#                                 associate with a base DOChandler
12	<	# parse()                       : parse the input file
13	<	# include(url) : Activate include file mechanism, returns the object ref if OK
14	<	# treenode()   : return the associated TreeNode object reference
15	<	# getincludeObjectStore : Return a pointer to the ObectStore that contains all
16	<	#                         included objects
17	<	# find(string)  : find the object reference related to string in the associated
18	<	#                 tree. Mechanism for getting object references
19	<	# _addgroup()   : Add group functionality to document
20	<	# parseerror(String) : Report an error to the user
21	<	# userinterface()       : return the default User Interface object
22	<	# checktag($hashref, param , tagname) : Check a hash returned from switcher
23	<	#                                       for a given parameter
10	>	# new(ActiveConfig[,options])           : A new ActiveDoc object
11	>	# url()         : Return/set the docs url - essential
12	>	# file()        : Return the local filename of document
13	>	#
14	>	# parse(parselabel): Parse the document file for the given parse level
15	>	# newparse(parselabel) : Create a new parse type
16	>	# addtag(parselabel,tagname,start,obj,text,obj,end,obj)
17	>	#                               : Add tags to the parse given by label
18	>	# checktag(tagname, hashref, param) : check for existence of param in
19	>	#                                       hashref from a tag call
20	>	# includeparse(local_parsename, objparsename, activedoc) : copy the parse from
21	>	#                                                       one object to another
22	>	# currentparsename([name]) : get/set current parse name
23	>	# newdoc(file)  : Return an new object of the appropriate type
24	>	# getfile(url)  : get a processedfile object given a url
25	>	# activatedoc(url) : Return the object ref for a doc described by the given url
26	>	#                    -- any parse called "init" will also be run
27	>	# config([ActiveConfig]) : Set up/return Configuration for the document
28	>	# basequery([ActiveConfig]) : Set up/return UserQuery for the doc
29	>	# copydocconfig(ActiveDoc) : Copy the basic configuration from the ActiveDoc
30	>	# copydocquery(ActiveDoc) : Copy the basicquery from the ActiveDoc
31	>	# userinterface()       : Return the defaullt userinterface
32	>	# option(var)           : return the value of the option var
33	>	# requestoption("message") : Ask the user to supply a value for an option
34	>	#                            if it dosnt already exist
35	>	#
36	>	# -- error methods --
37	>	# error(string)       : Report an general error to the user
38	>	# parseerror(string)  : Report an error during parsing a file
39	>	# line()              : Return the current line number of the document
40	>	#                       and the ProcessedFileObj it is in
41
42		package ActiveDoc::ActiveDoc;
43	<	require 5.001;
44	<	use ActiveDoc::DOChandler;
45	<	use ActiveDoc::TreeNode;
46	<	use ActiveDoc::UserQuery;
47	<	use ObjectStoreCont;
48	<
49	<	@ISA = qw(BaseTags);
50	<
51	<	# Initialise
52	<	sub _init {
53	<	my $self=shift;
54	<	my $DOChandler=shift;
55	<	my $OC=shift;
56	<
57	<	$self->_addurl();
58	<	$self->{urlhandler}->setcache($DOChandler->defaultcache());
59	<	$self->{treenode}=ActiveDoc::TreeNode->new();
60	<	$self->{dochandler}=$DOChandler;
61	<	$self->{UserQuery}=$DOChandler->{UserQuery};
62	<	$self->{tags}->addtag("Use", \&Use_Start, "", "");
63	<	# Add the minimal functionality tag - feel free to override
64	<	$self->{tags}->addtag("Include", \&Include_Start, "", "");
65	<	$self->init();
43	>	require 5.004;
44	>	use ActiveDoc::Parse;
45	>	use ActiveDoc::ActiveConfig;
46	>	use ActiveDoc::PreProcessedFile;
47	>	use ObjectUtilities::StorableObject;
48	>	use URL::URLhandler;
49	>
50	>	@ISA = qw(ObjectUtilities::StorableObject);
51	>
52	>	sub new {
53	>	my $class=shift;
54	>	$self={};
55	>	bless $self, $class;
56	>	$self->config(shift);
57	>
58	>	# have some override options been passed
59	>	if ( @_ ) {
60	>	$self->basequery(shift);
61	>	}
62	>	else {
63	>	# --- is there a starter document?
64	>	my $basedoc=$self->config()->basedoc();
65	>	if ( defined $basedoc ) {
66	>	$self->copydocquery($basedoc);
67	>	}
68	>	else {
69	>	$self->error("Error : No base doc found");
70	>	}
71	>	}
72	>	$self->_init2();
73		}
74
75	<	sub init {
76	<	# Dummy Routine - override for derrived classes
75	>	sub _init2 {
76	>
77	>	my $self=shift;
78	>	# A URL handler per document
79	>	$self->{urlhandler}=URL::URLhandler->new($self->config()->cache());
80	>
81	>	# A default UserInterface
82	>	$self->{userinterface}=ActiveDoc::SimpleUserInterface->new();
83	>	$self->init(@_);
84	>	return $self;
85	>
86		}
87	<	#
88	<	# use mechanism
89	<	#
90	<	sub include {
91	<	my $self=shift;
92	<	my $url=shift;
93	<	my $linkfile=shift;
94	<	my $filename;
95	<	my $obj;
96	<
97	<	$file=$self->{urlhandler}->get($url);
98	<	if ( ( defined $linkfile) && ( $linkfile ne "" ) ) {
99	<	$filename=$file."/".$linkfile;
87	>
88	>	# ----- parse related routines --------------
89	>	sub parse {
90	>	my $self=shift;
91	>	$parselabel=shift;
92	>
93	>	my $file=$self->file();
94	>	if ( $file ) {
95	>	if ( exists $self->{parsers}{$parselabel} ) {
96	>	$self->{currentparsename}=$parselabel;
97	>	$self->{currentparser}=$self->{parsers}{$parselabel};
98	>	$self->{parsers}{$parselabel}->parse($file,@_);
99	>	delete $self->{currentparser};
100	>	$self->{currentparsename}="";
101	>	}
102		}
103		else {
104	<	$filename=$file;
104	>	print "Cannot parse - file not known\n";
105		}
106	<	$obj=$self->{dochandler}->newdoc($filename);
106	>	}
107
108	<	# Now Extend our tree
109	<	$self->{treenode}->grow($obj->treenode());
110	<	return $obj;
108	>	sub currentparsename {
109	>	my $self=shift;
110	>	@_?$self->{currentparsename}=shift
111	>	:$self->{currentparsename};
112		}
113
114	<	sub userinterface {
114	>	sub newparse {
115		my $self=shift;
116	<	return $self->{dochandler}->{UserInterface};
116	>	my $parselabel=shift;
117	>
118	>	$self->{parsers}{$parselabel}=ActiveDoc::Parse->new();
119	>	$self->{parsers}{$parselabel}->addignoretags();
120	>	$self->{parsers}{$parselabel}->addgrouptags();
121		}
122
123	<	sub treenode {
123	>	sub cleartags {
124		my $self=shift;
125	<	return $self->{treenode};
125	>	my $parselabel=shift;
126	>
127	>	$self->{parsers}{$parselabel}->cleartags();
128		}
129
130	<	sub getincludeObjectStore {
131	<	my $self=shift;
132	<	return $self->{includeOS};
130	>
131	>	sub includeparse {
132	>	my $self=shift;
133	>	my $parselabel=shift;
134	>	my $remoteparselabel=shift;
135	>	my $activedoc=shift;
136	>
137	>	# Some error trapping
138	>	if ( ! exists $self->{parsers}{$parselabel} ) {
139	>	$self->error("Unknown local parse name specified");
140	>	}
141	>	if ( ! exists $activedoc->{parsers}{$remoteparselabel} ) {
142	>	$self->error("Unknown parse name specified in remote obj $activedoc");
143	>	}
144	>
145	>	#
146	>	my $rp=$activedoc->{parsers}{$remoteparselabel};
147	>	$self->{parsers}{$parselabel}->includeparse($rp);
148	>	}
149	>
150	>	sub addtag {
151	>	my $self=shift;
152	>	my $parselabel=shift;
153	>	if ( $#_ != 6 ) {
154	>	$self->error("Incorrect addtags specification\n".
155	>	"called with :\n@_ \n");
156	>	}
157	>	$self->{parsers}{$parselabel}->addtag(@_);
158	>	}
159	>
160	>	sub addurltags {
161	>	my $self=shift;
162	>	my $parselabel=shift;
163	>
164	>	$self->{parsers}{$parselabel}->
165	>	addtag("Base", \&Base_start, $self, "", $self,
166	>	\&Base_end, $self);
167		}
168
169	<	sub find($) {
169	>	sub url {
170		my $self=shift;
171	+	# get file & preprocess
172	+	if ( @_  ) {$self->{File}=$self->getfile(shift)}
173	+	$self->{File}->url();
174	+	}
175	+
176	+	sub copydocconfig {
177	+	my $self=shift;
178	+	my $ActiveDoc=shift;
179	+
180	+	$self->config($ActiveDoc->config());
181	+
182	+	}
183	+
184	+	sub copydocquery {
185	+	my $self=shift;
186	+	my $ActiveDoc=shift;
187	+
188	+	$self->basequery($ActiveDoc->basequery());
189	+	}
190	+
191	+	sub config {
192	+	my $self=shift;
193	+	@_?$self->{ActiveConfig}=shift
194	+	: $self->{ActiveConfig};
195	+	}
196	+
197	+	sub basequery {
198	+	my $self=shift;
199	+	@_ ? $self->{Query}=shift
200	+	: $self->{Query};
201	+	}
202	+
203	+	sub option {
204	+	my $self=shift;
205	+	my $param=shift;
206	+	if ( defined $self->basequery()) {
207	+	return $self->basequery()->getparam($param);
208	+	}
209	+	else {
210	+	return $undef;
211	+	}
212	+	}
213	+
214	+	sub requestoption {
215	+	my $self=shift;
216	+	my $param=shift;
217		my $string=shift;
94	–	my $tn;
218
219	<	$tn=$self->{treenode}->find($string);
220	<	if ( $tn eq "" ) {
221	<	$self->parseerror("Unable to find $string");
219	>	my $par=undef;
220	>	if ( defined $self->basequery()) {
221	>	$par=$self->basequery()->getparam($param);
222	>	while ( ! defined $par ) {
223	>	$self->basequery()->querytype( $param, "basic");
224	>	$self->basequery()->querymessage( $param, $string);
225	>	$self->userinterface()->askuser($self->basequery());
226	>	$par=$self->basequery()->getparam($param);
227	>	}
228		}
229	<	return $tn->associate();
229	>	return $par;
230		}
231
232	<	sub line {
232	>	sub getfile() {
233		my $self=shift;
234	<	return $self->{switch}->line();
234	>	my $origurl=shift;
235	>
236	>	my $fileref;
237	>	my ($url, $file)=$self->{urlhandler}->get($origurl);
238	>	# do we already have an appropriate object?
239	>	($fileref)=$self->config()->find($url);
240	>	#undef $fileref;
241	>	if (  defined $fileref ) {
242	>	print "found $url in database ----\n";
243	>	$fileref->update();
244	>	}
245	>	else {
246	>	if ( $file eq "" ) {
247	>	$self->parseerror("Unable to get $origurl");
248	>	}
249	>	#-- set up a new preprocess file
250	>	print "Making a new file $url----\n";
251	>	$fileref=ActiveDoc::PreProcessedFile->new($self->config());
252	>	$fileref->url($url);
253	>	$fileref->update();
254	>	}
255	>	return $fileref;
256		}
257
258	<	sub error {
258	>	sub activatedoc {
259		my $self=shift;
260	<	my $string=shift;
260	>	my $url=shift;
261
262	<	die $string."\n";
262	>	# first get a preprocessed copy of the file
263	>	#       my $fileob=$self->getfile($url);
264
265	+	# now parse it for the <DocType> tag
266	+	my $tempdoc=ActiveDoc::ActiveDoc->new($self->config());
267	+	$tempdoc->{urlhandler}=$self->{urlhandler};
268	+	$tempdoc->url($url);
269	+	$tempdoc->{doctypefound}=0;
270	+	$tempdoc->newparse("doctype");
271	+	$tempdoc->addtag("doctype","Doc", \&Doc_Start, $tempdoc,
272	+	"", $tempdoc, "", $tempdoc);
273	+	$tempdoc->parse("doctype");
274	+
275	+	if ( ! defined $tempdoc->{docobject} ) {
276	+	print "No <Doc type=> Specified in ".$url."\n";
277	+	exit 1;
278	+	}
279	+	# Set up a new object of the specified type
280	+	eval "require $tempdoc->{docobject}";
281	+	die $@ if $@;
282	+	my $newobj=$tempdoc->{docobject}->new($self->config());
283	+	undef $tempdoc;
284	+	$newobj->url($url);
285	+	$newobj->_initparse();
286	+	return $newobj;
287		}
288	<	sub parseerror {
288	>
289	>	sub _initparse {
290		my $self=shift;
117	–	my $string=shift;
291
292	<	print "Parse Error in $self->{url}, line ".
293	<	$self->line()."\n";
294	<	print $string."\n";
295	<	die;
292	>	$self->parse("init");
293	>	}
294	>	# -------- Error Handling and Error services --------------
295	>
296	>	sub error {
297	>	my $self=shift;
298	>	my $string=shift;
299	>
300	>	die $string."\n";
301	>	}
302	>
303	>	sub parseerror {
304	>	my $self=shift;
305	>	my $string=shift;
306	>
307	>	($line, $file)=$self->line();
308	>	print "Parse Error in ".$file->url().", line ".
309	>	$line."\n";
310	>	print $string."\n";
311	>	die;
312		}
313
314		sub checktag {
315	+	my $self=shift;
316	+	my $tagname=shift;
317	+	my $hashref=shift;
318	+	my $param=shift;
319	+
320	+	if ( ! exists $$hashref{$param} ) {
321	+	$self->parseerror("Incomplete Tag <$tagname> : $param required");
322	+	}
323	+	}
324	+
325	+	sub line {
326		my $self=shift;
127	–	my $hashref=shift;
128	–	my $param=shift;
129	–	my $tagname=shift;
327
328	<	if ( ! exists $$hashref{$param} ) {
329	<	$self->parseerror("Incomplete Tag <$tagname> : $param required");
330	<	}
328	>	my ($line, $fileobj)=
329	>	$self->{File}->realline($self->{currentparser}->line());
330	>	return ($line, $fileobj);
331	>	}
332	>
333	>	sub tagstartline {
334	>	my $self=shift;
335	>	my ($line, $fileobj)=$self->{File}->line(
336	>	$self->{currentparser}->tagstartline());
337	>	return ($line, $fileobj);
338	>	}
339	>
340	>	sub file {
341	>	my $self=shift;
342	>
343	>	$self->{File}->file();
344		}
345
346	<	# ------------------------ Tag Routines ------------------------------
346	>	# --------------- Initialisation Methods ---------------------------
347	>
348	>	sub init {
349	>	# Dummy Routine - override for derived classes
350	>	}
351	>
352	>	# ------------------- Tag Routines -----------------------------------
353		#
354	<	# The Include tag
354	>	# Base - for setting url bases
355		#
356	+	sub Base_start {
357	+	my $self=shift;
358	+	my $name=shift;
359	+	my $hashref=shift;
360	+
361	+	$self->checktag($name, $hashref, 'type' );
362	+	$self->checktag($name, $hashref, 'base' );
363	+
364	+	# Keep track of base tags
365	+	push @{$self->{basestack}}, $$hashref{"type"};
366	+	# Set the base
367	+	$self->{urlhandler}->setbase($$hashref{"type"},$hashref);
368	+	}
369	+
370	+	sub Base_end {
371	+	my $self=shift;
372	+	my $name=shift;
373	+	my $type;
374	+
375	+	if ( $#{$self->{basestack}} == -1 ) {
376	+	print "Parse Error : unmatched </".$name."> on line ".
377	+	$self->line()."\n";
378	+	die;
379	+	}
380	+	else {
381	+	$type = pop @{$self->{basestack}};
382	+	$self->{urlhandler}->unsetbase($type);
383	+	}
384	+	}
385
386	<	sub Include_Start {
386	>	sub Doc_Start {
387		my $self=shift;
388		my $name=shift;
389		my $hashref=shift;
390	<
391	<	$self->{switch}->checkparam( $name, "ref");
392	<	print "<Include> tag not yet implemented\n";
393	<	#        $self->include($$hashref{'ref'},$$hashref{'linkdoc'});
390	>
391	>	$self->checktag($name, $hashref, "type");
392	>	$self->{doctypefound}++;
393	>	if ( $self->{doctypefound} == 1 ) { # only take first doctype
394	>	$self->{docobject}=$$hashref{'type'};
395	>	}
396		}
397
398	<	sub Use_Start {
398	>	sub userinterface {
399		my $self=shift;
400	<	my $name=shift;
401	<	my $hashref=shift;
155	<
156	<	print "<Use> tag not yet implemented\n";
400	>	@_?$self->{userinterface}=shift
401	>	:$self->{userinterface}
402		}

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines