ViewVC Help

View File | Revision Log | Show Annotations | Root Listing

root/cvsroot/COMP/SCRAM/src/Configuration/ConfigArea.pm

Comparing COMP/SCRAM/src/Configuration/ConfigArea.pm (file contents):
Revision 1.27 by sashby, Fri Mar 4 17:46:58 2005 UTC vs.
Revision 1.30 by sashby, Thu Aug 25 17:27:17 2005 UTC

#	Line 1 | Line 1
1	<	#
2	<	# ConfigArea.pm
3	<	#
4	<	# Written by Christopher Williams
5	<	#
6	<	# Description
7	<	# -----------
8	<	# creates and manages a configuration area
9	<	#
10	<	# Notes
11	<	# -------
12	<	# Persistency - remember to call the save method to make changes persistent
13	<	#
14	<	# Interface
15	<	# ---------
16	<	# new()                         : A new ConfigArea object
17	<	# name()                        : get/set project name
18	<	# setup(dir[,areaname])         : setup a fresh area in dir
19	<	# satellite(dir[,areaname])     : setup a satellite area in dir
20	<	# version()                     : get/set project version
21	<	# location([dir])               : set/return the location of the work area
22	<	# bootstrapfromlocation([location]) : bootstrap the object based on location.
23	<	#                                     no location specified - cwd used
24	<	#                                     return 0 if succesful 1 otherwise
25	<	# requirementsdoc()             : get set the requirements doc
26	<	# searchlocation([startdir])    : returns the location directory. search starts
27	<	#                                 from cwd if not specified
28	<	# scramversion()                : return the scram version associated with
29	<	#                                 area
30	<	# configurationdir()            : return the location of the project
31	<	#                                 configuration directory
32	<	# copy(location)                : copy a configuration
33	<	# copysetup(location)           : copy the architecture specific tool setup
34	<	#                                 returns 0 if successful, 1 otherwise
35	<	# copyenv($ref)                 : copy the areas environment into the hashref
36	<	# toolbox()                     : return the areas toolbox object
37	<	# save()                        : save changes permanently
38	<	# linkto(location)              : link the current area to that at location
39	<	# unlinkarea()                  : destroy link (autosave)
40	<	# linkarea([ConfigArea])        : link the current area to the apec Area Object
41	<	# archname()            : get/set a string to indicate architecture
42	<	# archdir()             : return the location of the administration arch dep
43	<	#                         directory
44	<	# objectstore()         : return the objectStore object of the area
45	<	# - temporary
46	<	# align()                       : adjust hard paths to suit local loaction
1	>	=head1 NAME
2	>
3	>	Configuration::ConfigArea - Creates and manages a configuration area (i.e. a project area).
4	>
5	>	=head1 SYNOPSIS
6	>
7	>	my $obj = Configuration::ConfigArea->new();
8	>
9	>	=head1 DESCRIPTION
10	>
11	>	Create and manage SCRAM project configuration areas.
12	>
13	>	=head1 METHODS
14	>
15	>	=over
16	>
17	>	=cut
18	>
19	>	=item C<new()>
20	>
21	>	Create a new Configuration::ConfigArea object.
22	>
23	>	=item C<name()>
24	>
25	>	Get/set project name.
26	>
27	>	=item C<setup($dir[,$areaname])>
28	>
29	>	Set up a fresh area in $dir.
30	>
31	>	=item C<satellite($dir[,$areaname])>
32	>
33	>	Set up a satellite area in $dir.
34	>
35	>	=item C<version()>
36	>
37	>	Get/set project version.
38	>
39	>	=item C<location([$dir])>
40	>
41	>	Set/return the location of the work area.
42	>
43	>	=item C<bootstrapfromlocation([$location])>
44	>
45	>	Bootstrap the object based on location.
46	>	No location specified - current directory used
47	>	Return 0 if succesful, 1 otherwise.
48	>
49	>	=item C<requirementsdoc()>
50	>
51	>	Get or set the requirements document.
52	>
53	>	=item C<searchlocation([$startdir])>
54	>
55	>	Returns the location directory. search starts
56	>	from current directory if not specified.
57	>
58	>	=item C<scramversion()>
59	>
60	>	Return the scram version associated with the area.
61	>
62	>	=item C<configurationdir()>
63	>
64	>	Return the location of the project configuration directory.
65	>
66	>	=item C<copy($location)>
67	>
68	>	Copy a configuration from $location.
69	>
70	>	=item C<copysetup($location)>
71	>
72	>	Copy the architecture-specific tool setup.
73	>	Returns 0 if successful, 1 otherwise.
74	>
75	>	=item C<copyenv($ref)>
76	>
77	>	Copy the area environment into the hashref $ref.
78	>
79	>	=item C<toolbox()>
80	>
81	>	Return the area toolbox object.
82	>
83	>	=item C<save()>
84	>
85	>	Save changes permanently.
86	>
87	>	=item C<linkto($location)>
88	>
89	>	Link the current area to that at location.
90	>
91	>	=item C<unlinkarea()>
92	>
93	>	Destroy link ($autosave).
94	>
95	>	=item C<linkarea([Configuration::ConfigArea])>
96	>
97	>	Link the current area to the specified area object.
98	>
99	>	=item C<archname()>
100	>
101	>	Get/set a string to indicate architecture.
102	>
103	>	=item C<archdir()>
104	>
105	>	Return the location of the administration
106	>	architecture-dependent directory.
107	>
108	>	=item C<objectstore()>
109	>
110	>	Return the B<objectStore> object of the area temporary.
111	>
112	>	=item C<align()>
113	>
114	>	Adjust hard paths to suit local location.
115	>
116	>
117	>	=back
118	>
119	>	=head1 AUTHOR
120	>
121	>	Originally written by Christopher Williams.
122	>
123	>	=head1 MAINTAINER
124	>
125	>	Shaun ASHBY
126	>
127	>	=cut
128
129		package Configuration::ConfigArea;
130		require 5.004;
#	Line 311 | Line 392 | sub sitename
392		return $self->{sitename};
393		}
394
395	+	sub admindir()
396	+	{
397	+	my $self=shift;
398	+
399	+	@_ ? $self->{admindir} = shift
400	+	: $self->{admindir};
401	+	}
402
403		sub bootstrapfromlocation {
404		my $self=shift;
#	Line 689 | Line 777 | sub _LoadEnvFile
777		}
778		if ( defined $self->{ENV}{"SCRAM_TOOLBOXVERSION"} )
779		{
780	<	$self->toolboxversion($self->{ENV}{"SCRAM_TOOLBOXVERSION"});
780	>	if ($self->{ENV}{"SCRAM_TOOLBOXVERSION"} eq '')
781	>	{
782	>	$self->toolboxversion("STANDALONE");
783	>	}
784	>	else
785	>	{
786	>	$self->toolboxversion($self->{ENV}{"SCRAM_TOOLBOXVERSION"});
787	>	}
788		}
789
790		if ( ( defined $self->{ENV}{"RELEASETOP"} ) &&

Diff Legend

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