ViewVC Help

View File | Revision Log | Show Annotations | Root Listing

root/cvsroot/COMP/SCRAM/src/Scram/ScramFunctions.pm

Comparing COMP/SCRAM/src/Scram/ScramFunctions.pm (file contents):
Revision 1.3 by williamc, Wed Aug 30 09:31:31 2000 UTC vs.
Revision 1.23 by sashby, Wed Feb 2 11:10:18 2005 UTC

#	Line 18 | Line 18
18		# areatoolbox(ConfigArea) : return the toolbox of the specified area
19		# setuptoolsinarea($area[,$toolname[,$toolversion[,toolfile]) : setup
20		# arch()                : get/set the architecture string
21	+	# scramobjectinterface(Class)  : print out the interface of a scram class
22	+	# webget(area,url)      : get the url into the cache of the specified area
23	+	# getversion()          : return the current scram version
24	+	# spawnversion(version,@args) : spawn the scram version with the given args
25	+	# classverbose(classstring,setting) : Set the class verbosity level
26	+	# toolruntime(ConfigArea): Get a runtime object withthe settings from
27	+	#                          the specified toolbox
28
29		package Scram::ScramFunctions;
30		use URL::URLcache;
31		use Utilities::Verbose;
32	+	use Utilities::IndexedFileStore;
33	+
34		require 5.004;
35
36		@ISA=qw(Utilities::Verbose);
37
38	<	sub new {
38	>	sub new
39	>	{
40	>	my $class=shift;
41	>	$self={};
42	>	bless $self, $class;
43	>	# -- default settings
44	>	$self->{cachedir}=$ENV{HOME}."/.scramrc/globalcache";
45	>	$self->{scramprojectsdbdir}=$ENV{SCRAM_LOOKUPDB};
46	>	($self->{scram_top})=( $ENV{SCRAM_HOME}=~/(.*)\//) ;
47	>
48	>	return $self;
49	>	}
50	>
51	>	sub classverbose {
52	>	my $self=shift;
53		my $class=shift;
54	<	$self={};
55	<	bless $self, $class;
56	<	# -- default settings
34	<	$self->{cachedir}=$ENV{HOME}."/.SCRAM/globalcache";
35	<	$self->{scramprojectsdbdir}=$ENV{SCRAM_LOOKUPDB};
36	<	return $self;
54	>	my $val=shift;
55	>
56	>	$ENV{"VERBOSE_".$class}=$val;
57		}
58
59		sub project {
#	Line 57 | Line 77 | sub project {
77
78		# -- download all tool description files
79		my $req=$self->arearequirements($area);
80	+	$area->toolboxversion($req->{configversion});
81	+
82		if ( defined $req ) {
83		$req->download($self->areatoolbox($area));
84		}
#	Line 64 | Line 86 | sub project {
86		return $area;
87		}
88
89	<	sub setuptoolsinarea {
90	<	my $self=shift;
91	<	my $area=shift;
92	<
93	<	# -- initialise
94	<	$self->_allprojectinitsearcher();
95	<
96	<	# -- create a new toolbox object
97	<	my $toolbox=$self->areatoolbox($area);
98	<	$toolbox->searcher($self->_projsearcher());
89	>	sub setuptoolsinarea
90	>	{
91	>	my $self=shift;
92	>	my $area=shift;
93	>
94	>	# -- initialise
95	>	print "Initialising setup procedure......","\n";
96	>	$self->_allprojectinitsearcher();
97	>
98	>	# -- create a new toolbox object
99	>	my $toolbox=$self->areatoolbox($area);
100	>	$toolbox->searcher($self->_allprojectinitsearcher());
101	>
102	>	if ( @_ )
103	>	{
104	>	# -- specific tool specified
105	>	if ( my $rv=$toolbox->toolsetup(@_) )
106	>	{
107	>	if ( $rv eq 1 )
108	>	{
109	>	print "Unknown tool $toolname @ARGV\n";
110	>	exit 1;
111	>	}
112	>	}
113	>	}
114	>	else
115	>	{
116	>	# -- setup all tools specified in the requirements doc
117	>	print "Going to set up all tools....","\n\n";
118	>	my $reqs=$self->arearequirements($area);
119	>	$self->verbose("Setup ToolBox from Requirements doc ($reqs)");
120	>	# reqs is a BuildSystem::Requirements object:
121	>	$reqs->setup($toolbox);
122	>	}
123	>	}
124	>
125	>	sub updatetoolsinarea
126	>	{
127	>	my $self=shift;
128	>	my $area=shift;
129	>
130	>
131	>	my $toolbox=$self->areatoolbox($area);
132	>
133	>	print "Going to refresh the setup of tools....","\n\n";
134	>	my $currenttag = $area->toolboxversion();
135	>
136	>	# Get rid of the current cache:
137	>	my $cachename = $area->cache()->location();
138	>	system("mv","$cachename","$cachename".".$currenttag");
139	>	# Create a new one:
140	>	$area->_newcache();
141	>	my $reqs=$self->arearequirements($area);
142	>	$reqs->download();
143	>	$reqs->setup($toolbox);
144	>	print "Previous configuration tag : ",$currenttag,"\n";
145	>	$area->toolboxversion($reqs->{configversion});
146	>	print "Current configuration tag  : ",$area->toolboxversion(),"\n\n";
147	>	$area->save();
148	>	}
149	>
150	>	sub satellite
151	>	{
152	>	#
153	>	# Modified to suit new structure
154	>	#
155	>	my $self=shift;
156	>	my $name=shift;
157	>	my $version=shift;
158	>	my $installarea=shift; # Where to install (-dir option in project cmd);
159	>	my $areaname=undef;    # Name of the area (comes from -name option in project cmd);
160	>
161	>	if ( @_ )
162	>	{
163	>	$areaname=shift;
164	>	}
165	>
166	>	# Get location from SCRAMDB:
167	>	my $relarea=$self->_lookupareaindb($name,$version);
168	>
169	>	if ( ! defined $relarea )
170	>	{
171	>	$self->error("Unable to Find Project $name $version");
172	>	}
173	>
174	>	# Create a satellite area:
175	>	my $area=$relarea->satellite($installarea,$areaname);
176	>	$area->archname($self->arch());
177	>
178	>	# Copy the admin dir (and with it, the ToolCache):
179	>	$relarea->copywithskip($area->location(),'ProjectCache.db');
180	>
181	>	# Copy configuration directory contents:
182	>	if ( ! -d $area->location()."/".$area->configurationdir() )
183	>	{
184	>	use Utilities::AddDir;
185	>	AddDir::copydir($relarea->location()."/".$relarea->configurationdir(),
186	>	$area->location()."/".$area->configurationdir() );
187	>	}
188	>
189	>	# Make sourcecode dir:
190	>	if ( ! -d $area->location()."/".$area->sourcedir() )
191	>	{
192	>	use Utilities::AddDir;
193	>	AddDir::adddir($area->location()."/".$area->sourcedir());
194	>	}
195	>
196	>	# Copy RequirementsDoc:
197	>	if ( ! -f $area->requirementsdoc() )
198	>	{
199	>	use File::Copy;
200	>	copy( $relarea->requirementsdoc() , $area->requirementsdoc());
201	>	}
202
203	<	if ( @_ ) {
204	<	# -- specific tool specified
80	<	if ( my $rv=$toolbox->toolsetup(@_) ) {
81	<	if ( $rv eq 1 ) {
82	<	print "Unknown tool $toolname @ARGV\n";
83	<	exit 1;
84	<	}
85	<	}
86	<	}
87	<	else {
88	<	# -- setup all tools specified in the requirements doc
89	<	my $reqs=$self->arearequirements($area);
90	<	$self->verbose("Setup ToolBox from Requirements doc ($reqs)");
91	<	$reqs->setup($toolbox);
92	<	}
93	<	}
203	>	return $area;
204	>	}
205
206	<	sub satellite {
206	>	sub toolruntime {
207		my $self=shift;
208	<	my $name=shift;
209	<	my $version=shift;
210	<	my $installarea=shift;
100	<
101	<	my $areaname="";
102	<	if ( @_ ) {
103	<	$areaname=shift;
104	<	}
105	<
106	<	# -- look up scram database for location
107	<	my $relarea=$self->_lookupareaindb($name,$version);
108	<	if ( ! defined $relarea ) {
109	<	$self->error("Unable to Find Project $name $version");
110	<	}
111	<
112	<	# -- create satellite
113	<	my $area=$relarea->satellite($installarea,$areaname);
114	<	$area->archname($self->arch());
115	<
116	<	# -- copy setup info - deprecated by toolbox copy method
117	<	#$relarea->copysetup($area->location());
118	<
119	<	# -- copy toolbox
120	<	my $rtb=$self->areatoolbox($relarea);
121	<	my $tb=$self->areatoolbox($area);
122	<	$rtb->copytools($tb);
123	<
124	<	# -- copy configuration directory
125	<	if ( ! -d $area->location()."/".$area->configurationdir() ) {
126	<	use Utilities::AddDir;
127	<	AddDir::copydir($relarea->location()."/".$relarea->configurationdir(),
128	<	$area->location()."/".$area->configurationdir() );
129	<	}
130	<
131	<	# -- copy RequirementsDoc
132	<	if ( ! -f $area->requirementsdoc() ) {
133	<	use File::Copy;
134	<	copy( $relarea->requirementsdoc() , $area->requirementsdoc());
135	<	}
208	>	my $area=shift;
209	>	my $ld_lib_path="";
210	>	my $bin_path="";
211
212	<	return $area;
212	>	my $name=$area->location();
213	>
214	>	if ( ! defined $self->{toolruntime}{$name} )
215	>	{
216	>	require Runtime;
217	>	my $toolbox=$self->areatoolbox($area);
218	>	$self->{toolruntime}{$name}=Runtime->new();
219	>
220	>	# Test for SCRAM_ARCH/lib order:
221	>	if ( -d $area->location()."/".$self->arch())
222	>	{
223	>	$ld_lib_path = $area->location()."/".$self->arch()."/lib"
224	>	unless ( ! -d $area->location()."/".$self->arch()."/lib");
225	>	$bin_path = $area->location()."/".$self->arch()."/bin"
226	>	unless ( ! -d $area->location()."/".$self->arch()."/bin");
227	>	}
228	>	# Other way around:
229	>	elsif ( -d  $area->location()."/lib/".$self->arch())
230	>	{
231	>	$ld_lib_path = $area->location()."/lib/".$self->arch()
232	>	unless ( ! -d $area->location()."/lib/".$self->arch());
233	>	$bin_path = $area->location()."/bin/".$self->arch()
234	>	unless ( ! -d $area->location()."/bin/".$self->arch());
235	>	}
236	>	else
237	>	# Assume no arch so just use lib and bin:
238	>	{
239	>	$ld_lib_path = $area->location()."/lib";
240	>	$bin_path = $area->location()."/bin";
241	>	}
242	>
243	>	# -- Now set the scram area specific runtimes accordingly:
244	>	$self->{toolruntime}{$name}->addvar("LD_LIBRARY_PATH",$ld_lib_path,"path");
245	>	$self->{toolruntime}{$name}->addvar("PATH",$bin_path,"path");
246	>
247	>	# Check for a linked area:
248	>	if ( defined $area->linkarea() )
249	>	{
250	>	my $relarea=$area->linkarea();
251	>	# Now do the checks for the release area:
252	>	if ( -d $relarea->location()."/".$self->arch())
253	>	{
254	>	$ld_lib_path = $relarea->location()."/".$self->arch()."/lib"
255	>	unless ( ! -d $relarea->location()."/".$self->arch()."/lib");
256	>	$bin_path = $relarea->location()."/".$self->arch()."/bin"
257	>	unless ( ! -d $relarea->location()."/".$self->arch()."/bin");
258	>	}
259	>	# Other way around:
260	>	elsif ( -d  $relarea->location()."/lib/".$self->arch())
261	>	{
262	>	$ld_lib_path = $relarea->location()."/lib/".$self->arch()
263	>	unless ( ! -d $relarea->location()."/lib/".$self->arch());
264	>	$bin_path = $relarea->location()."/bin/".$self->arch()
265	>	unless ( ! -d $relarea->location()."/bin/".$self->arch());
266	>	}
267	>	else
268	>	# Assume no arch so just use lib and bin:
269	>	{
270	>	$ld_lib_path = $relarea->location()."/lib";
271	>	$bin_path = $relarea->location()."/bin";
272	>	}
273	>	# Add the release paths:
274	>	$self->{toolruntime}{$name}->addvar("LD_LIBRARY_PATH",$ld_lib_path,"path");
275	>	$self->{toolruntime}{$name}->addvar("PATH",$bin_path,"path");
276	>	}
277	>
278	>	# -- get the runtime environment from all the tools
279	>	my $tool;
280	>	foreach $toolname ( $toolbox->tools() )
281	>	{
282	>	$tool=$toolbox->gettool($toolname);
283	>	if ( defined $tool )
284	>	{
285	>	# -- get runtime paths
286	>	foreach $f ( $tool->listtype("runtime_path"))
287	>	{
288	>	foreach $val ( $tool->getfeature($f) )
289	>	{
290	>	$self->{toolruntime}{$name}->addvar($f,$val,"path");
291	>	}
292	>	}
293	>	# -- get runtime vars
294	>	foreach $f ( $tool->listtype("runtime"))
295	>	{
296	>	foreach $val ( $tool->getfeature($f) )
297	>	{
298	>	$self->{toolruntime}{$name}->addvar($f,$val);
299	>	}
300	>	}
301	>	}
302	>	}
303	>
304	>	# -- Get the project level environment
305	>	my $runtimefile=$area->location()."/".$area->configurationdir()."/Runtime";
306	>
307	>	if ( -f $runtimefile )
308	>	{
309	>	$self->{toolruntime}{$name}->file($runtimefile);
310	>	}
311	>	}
312	>	return $self->{toolruntime}{$name};
313	>	}
314	>
315	>	sub webget {
316	>	my $self=shift;
317	>	my $area=shift;
318	>	my $url=shift;
319	>
320	>	require URL::URLhandler;
321	>	my $handler=URL::URLhandler->new($area->cache());
322	>	return ($handler->download($url));
323		}
324
325		sub addareatoDB {
326		my $self=shift;
327	+	my $flag=shift;
328		my $area=shift;
329		my $tagname=shift;
330		my $version=shift;
#	Line 150 | Line 336 | sub addareatoDB {
336		if ( (! defined $tagname)  || ( $tagname eq "") ) {
337		$tagname=$area->name();
338		}
153	–
339		# -- Add to the DB
340	<	$self->scramprojectdb()->addarea($tagname,$version,$area);
340	>	$self->scramprojectdb()->addarea($flag,$tagname,$version,$area);
341		}
342
343	+
344	+	sub removeareafromDB
345	+	{
346	+	###############################################################
347	+	# removearefromDB()                                           #
348	+	###############################################################
349	+	# modified : Thu Jun 14 10:46:22 2001 / SFA                   #
350	+	# params   : projectname, projectversion                      #
351	+	#          :                                                  #
352	+	#          :                                                  #
353	+	#          :                                                  #
354	+	# function : Remove project <projectname> from DB file.       #
355	+	#          :                                                  #
356	+	#          :                                                  #
357	+	###############################################################
358	+	my $self=shift;
359	+	my $flag=shift;
360	+	my $projname=shift;
361	+	my $version=shift;
362	+
363	+	# -- Remove from the DB:
364	+	$self->scramprojectdb()->removearea($flag,$projname,$version);
365	+	}
366	+
367	+
368	+	sub spawnversion
369	+	{
370	+	###############################################################
371	+	# spawnversion                                                #
372	+	###############################################################
373	+	# modified : Fri Aug 10 15:42:08 2001 / SFA                   #
374	+	# params   :                                                  #
375	+	#          :                                                  #
376	+	#          :                                                  #
377	+	#          :                                                  #
378	+	# function : Check for version of scram to run, and run it.   #
379	+	#          :                                                  #
380	+	#          :                                                  #
381	+	###############################################################
382	+
383	+	my $self=shift;
384	+	my $version=shift;
385	+	my $rv=0;
386	+
387	+	my $thisversion=$self->getversion();
388	+
389	+	if ( defined $version )
390	+	{
391	+	if ( $version ne $thisversion )
392	+	{
393	+	# first try to use the correct version
394	+	if ( -d $self->{scram_top}."/".$version )
395	+	{
396	+	$ENV{SCRAM_HOME}=$self->{scram_top}."/".$version;
397	+	$ENV{SCRAM_TOOL_HOME}="$ENV{SCRAM_HOME}/src";
398	+	$self->verbose("Spawning SCRAM version $version");
399	+	my $rv=system($ENV{SCRAM_HOME}."/src/main/scram.pl", @_)/256;
400	+	exit $rv;
401	+	}
402	+	else
403	+	{
404	+	# if not then simply warn. Send output to STDERR:
405	+	if ( -t STDERR )
406	+	{
407	+	print STDERR "******* Warning : scram version inconsistent ********\n";
408	+	print STDERR "This version: $thisversion; Required version: $version\n";
409	+	print STDERR "*****************************************************\n";
410	+	print STDERR "\n";
411	+	}
412	+	}
413	+	}
414	+	}
415	+	else
416	+	{
417	+	$self->error("Undefined value for version requested");
418	+	$rv=1;
419	+	}
420	+	return $rv;
421	+	}
422	+
423		sub globalcache {
424		my $self=shift;
425		if ( @_ ) {
#	Line 180 | Line 445 | sub scramprojectdb {
445		}
446		return $self->{scramprojectsdb};
447		}
448	+
449	+	sub getversion {
450	+	my $self=shift;
451	+
452	+	my $thisversion;
453	+	($thisversion=$ENV{SCRAM_HOME})=~s/(.*)\///;
454	+	my $scram_top=$1;
455	+	my $scram_version=$thisversion;
456	+	# deal with links
457	+	my $version=readlink $ENV{SCRAM_HOME};
458	+	if ( defined $version)  {
459	+	$scram_version=$version;
460	+	}
461	+	return $scram_version;
462	+	}
463
464		sub areatoolbox {
465		my $self=shift;
#	Line 189 | Line 469 | sub areatoolbox {
469		if ( ! defined $self->{toolboxes}{$name} ) {
470		# -- create a new toolbox object
471		require BuildSystem::ToolBox;
472	<	$self->{toolboxes}{$name}=BuildSystem::ToolBox->new($area);
472	>	$self->{toolboxes}{$name}=BuildSystem::ToolBox->new($area,
473	>	$self->arch());
474		$self->{toolboxes}{$name}->verbosity($self->verbosity());
475		}
476		return $self->{toolboxes}{$name};
477		}
478
479	+	sub areatoolmanager
480	+	{
481	+	my $self=shift;
482	+	my $area=shift;
483	+
484	+	my $name=$area->location();
485	+
486	+	if ( ! defined $self->{toolmanagers}{$name} )
487	+	{
488	+	use BuildSystem::ToolManager;
489	+	$self->{toolmanagers}{$name}=ToolManager->new($area,$self->arch());
490	+	}
491	+
492	+	return $self->{toolmanagers}{$name};
493	+	}
494	+
495		sub arearequirements {
496		my $self=shift;
497		my $area=shift;
#	Line 228 | Line 525 | sub arch {
525		:$self->{arch};
526		}
527
528	+	sub scramobjectinterface {
529	+	my $self=shift;
530	+	my $class=shift;
531	+
532	+	my $file;
533	+	($file=$class."\.pm")=~s/::/\//g;
534	+	$file=$ENV{SCRAM_TOOL_HOME}."/".$file;
535	+
536	+	if ( ! -f $file ) {
537	+	$self->error("Unable to find $class in ".$ENV{SCRAM_TOOL_HOME});
538	+	}
539	+	print "--------------------- $class ------------------\n";
540	+	my $fh=FileHandle->new();
541	+	$fh->open("<$file");
542	+	while ( <$fh> ) {
543	+	if ( $_=~/#\s*Interface/g ) {
544	+	$intregion=1;
545	+	next;
546	+	}
547	+	if ( $intregion ) { # if we are in the interface documentation
548	+	if ( ( $_!~/^#/ ) || ( $_=~/^#\s?-{40}/ ) ) { #moving out of Int doc
549	+	$intregion=0;
550	+	next;
551	+	}
552	+	print $_;
553	+	if ( $_=~/^#\s*(.*)\((.*)\)?:(.*)/ ) {
554	+	$interface=$1;
555	+	$args=$2;
556	+	$rest=$3;
557	+	next if ($interface eq "");
558	+	push @interfaces,$interface;
559	+	$interfaceargs{$interface}=$args;
560	+	}
561	+	}
562	+	}
563	+	print "\n";
564	+	undef $fh;
565	+	}
566	+
567		# -------------- Support Routines ------------------------------
568
569
#	Line 238 | Line 574 | sub _allprojectinitsearcher {
574		$search->addproject($$proj[0],$$proj[1]);
575		}
576		}
577	+	return $self->{projsearcher};
578		}
579
580		sub _projsearcher {

Diff Legend

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