src/BuildSystem/Tool.pm

#
# Tool.pm - Store basic tool properties
#
# Originally Written by Christopher Williams
#
# Description
# -----------
# Stores basic tool features
#
# Interface
# ---------
# new()         : A new FeatureTool object
# name()        : get/set the tools name
# version()     : get set the tool version
# url()         : get set the tool url
# features()    : return a list of features defined (ordered in relation to 
#                       their first definition)
# listtype(type) : return a list of all features of the specified type
# addfeature(name,@value) : add value(s) to the named feature
# setfeature(name,@value) : set value(s) for the named feature
# getfeature(name) : return a list of elements belonging to the named feature
#                       (with embedded dependencies)
# type(name[,type]) : get/set the type associated with a feature
# addrequirement() : add a requirement at the current parse position
# dependencies()   : return a list of dependency objects
# store(location)   : Save object to given file
# restore(location) : Restore object from specified file
# reset()           : Clean out all the features
# equals(toolobj)       : return 1 if the tools correspond in url version etc.

package BuildSystem::Tool;
use Utilities::Verbose;
require 5.004;
@ISA=qw(Utilities::Verbose);

sub new {
        my $class=shift;
        my $self={};
        bless $self, $class;
        return $self;
}

sub name {
        my $self=shift;

        @_?$self->{name}=shift
          :$self->{name};
}

sub version {
        my $self=shift;

        @_?$self->{version}=shift
          :$self->{version};
}

sub url {
        my $self=shift;

        @_?$self->{url}=shift
          :$self->{url};
}

sub equals {
        my $self=shift;
        my $tool=shift;

        my $rv=0;
        if ( ($tool->url() eq $self->url() ) &&
             ($tool->name() eq $self->name() ) &&
             ($tool->version() eq $self->version()) ) {
          $rv=1;
        }
        return $rv;
}

sub listtype {
        my $self=shift;
        my $type=shift;

        my @list=();
        foreach $v ( $self->features() ) {
          if ( $self->type($v) eq $type ) {
                push @list, $v;
          }
        }
        return @list;
}

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

        if ( @_ ) {
          $self->{featuretypes}{$name}=shift;
        }
        return ((defined $self->{featuretypes}{$name})?
                $self->{featuretypes}{$name}:"");
}

sub addfeature {
        my $self=shift;
        my $name=shift;
        my @value=@_;

        $self->_newfeature($name,@value);
        push @{$self->{features}{$name}}, @value;
}

sub setfeature {
        my $self=shift;
        my $name=shift;
        my @value=@_;

        $self->_newfeature($name,@value);
        @{$self->{features}{$name}}=@value;
}

sub reset {
        my $self=shift;
        undef $self->{features};
        undef $self->{'features_ordered'};
        undef $self->{reqobjs};
        undef $self->{requireposition};
}

sub _newfeature {
        my $self=shift;
        my $name=shift;
        my @value=@_;

        # if it dosnt exist , make sure we first mark all the current reqs
        # get inserted beforehand
        if ( ! exists $self->{features}{$name} ) {
         # add feature name to our ordered list
         push @{$self->{'features_ordered'}},$name;
         for ( $i=0; $i<=$#{$self->{reqobjs}}; $i++ ) {
           $self->_recordpos( $name, $i);
         }
        }
}

sub features {
        my $self=shift;

#       return (keys %{$self->{features}});
        return @{$self->{'features_ordered'}};
}

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

        my @rv=();
        my @rep;
        # make sure we insert requirements at the right place
        for ( my $i=-1; $i<=$#{$self->{features}{$name}}; $i++ ) {
         if ( $i>=0 ) {
           push @rv, $self->{features}{$name}[$i];
         }
         my @rep=$self->_testpos($name, $i);
         my $repobj;
         foreach $repobj ( @rep ) {
             push @rv, $repobj->getfeature($name);
         }
        }
        return @rv;
}

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

        undef @{$self->{features}{$name}};
}

sub addrequirement {
        my $self=shift;
        my $reqobj=shift;

        push @{$self->{reqobjs}}, $reqobj;
        foreach $key ( keys %{$self->{features}} ) {
           $self->_recordpos($key,$#{$self->{reqobjs}});
        }
}

sub dependencies {
        my $self=shift;
        return @{$self->{recobjs}}
}

sub store {
        my $self=shift;
        my $location=shift;

        my $fh=FileHandle->new();
        $self->verbose("opening $location for output");
        $fh->open(">".$location) or die "Unable to open $location for output".
                                $!."\n";
        print $fh "name:".$self->name().":_sys\n";
        print $fh "version:".$self->version().":_sys\n";
        print $fh "url:".$self->url().":_sys\n";
        foreach $f ( $self->features()) {
          foreach $val ( $self->getfeature($f) ) {
           print $fh $f.":".$val.":".$self->type($f)."\n";
          }
        }
        undef $fh;
}

sub restore {
        my $self=shift;
        my $location=shift;

        my $fh=FileHandle->new();
        $fh->open("<".$location) or die "Unable to open $location for output".
                                $!."\n";
        my ($tool,$type,$variable,$value);
        while ( <$fh> ) {
          chomp;
          next if /^#/;
          next if /^\s*$/;
          ($variable, $value, $type)=split /:/;
          next if ( $variable=~/\&/ );
          $product=~tr[A-Z][a-z];
          if ( $type eq "_sys" ) {
             if ( $self->can($variable)) {
               $self->$variable($value);
             }
          }
          else {
            $self->addfeature($variable,$value);
          }
        }
        undef $fh;
}

sub _recordpos {
        my $self=shift;
        my $name=shift;
        my $recref=shift;

        push @{$self->{requireposition}{$name}{$#{$self->{features}{$name}}}}
                ,$recref;
}

# return array of objects that correspond to the required position
sub _testpos {
        my $self=shift;
        my $name=shift;
        my $ref=shift;

        my @rv=();
        if ( exists $self->{requireposition}{$name}{$ref} ) {
           foreach $recref ( @{$self->{requireposition}{$name}{$ref}} ) {
             push @rv, $self->{reqobjs}[$recref];
           }
        }
        return @rv;
}


Revision:	1.1.2.7
Committed:	Thu Apr 27 13:22:03 2000 UTC (25 years ago) by williamc
Content type:	text/plain
Branch:	V0_9branch
Changes since 1.1.2.6:	+14 -0 lines
Log Message:	Add equals method
#	User	Rev	Content
1	williamc	1.1.2.1	#
2			# Tool.pm - Store basic tool properties
3			#
4			# Originally Written by Christopher Williams
5			#
6			# Description
7			# -----------
8			# Stores basic tool features
9			#
10			# Interface
11			# ---------
12			# new() : A new FeatureTool object
13			# name() : get/set the tools name
14			# version() : get set the tool version
15			# url() : get set the tool url
16			# features() : return a list of features defined (ordered in relation to
17			# their first definition)
18	williamc	1.1.2.3	# listtype(type) : return a list of all features of the specified type
19	williamc	1.1.2.1	# addfeature(name,@value) : add value(s) to the named feature
20			# setfeature(name,@value) : set value(s) for the named feature
21			# getfeature(name) : return a list of elements belonging to the named feature
22	williamc	1.1.2.2	# (with embedded dependencies)
23			# type(name[,type]) : get/set the type associated with a feature
24	williamc	1.1.2.1	# addrequirement() : add a requirement at the current parse position
25			# dependencies() : return a list of dependency objects
26	williamc	1.1.2.3	# store(location) : Save object to given file
27	williamc	1.1.2.2	# restore(location) : Restore object from specified file
28	williamc	1.1.2.5	# reset() : Clean out all the features
29	williamc	1.1.2.7	# equals(toolobj) : return 1 if the tools correspond in url version etc.
30	williamc	1.1.2.1
31			package BuildSystem::Tool;
32	williamc	1.1.2.6	use Utilities::Verbose;
33	williamc	1.1.2.1	require 5.004;
34	williamc	1.1.2.6	@ISA=qw(Utilities::Verbose);
35	williamc	1.1.2.1
36			sub new {
37			my $class=shift;
38			my $self={};
39			bless $self, $class;
40			return $self;
41			}
42
43			sub name {
44			my $self=shift;
45
46			@_?$self->{name}=shift
47			:$self->{name};
48			}
49
50			sub version {
51			my $self=shift;
52
53			@_?$self->{version}=shift
54			:$self->{version};
55			}
56
57			sub url {
58			my $self=shift;
59
60			@_?$self->{url}=shift
61			:$self->{url};
62	williamc	1.1.2.7	}
63
64			sub equals {
65			my $self=shift;
66			my $tool=shift;
67
68			my $rv=0;
69			if ( ($tool->url() eq $self->url() ) &&
70			($tool->name() eq $self->name() ) &&
71			($tool->version() eq $self->version()) ) {
72			$rv=1;
73			}
74			return $rv;
75	williamc	1.1.2.1	}
76
77	williamc	1.1.2.3	sub listtype {
78			my $self=shift;
79			my $type=shift;
80
81			my @list=();
82			foreach $v ( $self->features() ) {
83			if ( $self->type($v) eq $type ) {
84			push @list, $v;
85			}
86			}
87			return @list;
88			}
89
90	williamc	1.1.2.2	sub type {
91			my $self=shift;
92			my $name=shift;
93
94			if ( @_ ) {
95			$self->{featuretypes}{$name}=shift;
96			}
97			return ((defined $self->{featuretypes}{$name})?
98			$self->{featuretypes}{$name}:"");
99			}
100	williamc	1.1.2.1
101			sub addfeature {
102			my $self=shift;
103			my $name=shift;
104			my @value=@_;
105
106			$self->_newfeature($name,@value);
107			push @{$self->{features}{$name}}, @value;
108			}
109
110			sub setfeature {
111			my $self=shift;
112			my $name=shift;
113			my @value=@_;
114
115			$self->_newfeature($name,@value);
116			@{$self->{features}{$name}}=@value;
117			}
118
119	williamc	1.1.2.5	sub reset {
120			my $self=shift;
121			undef $self->{features};
122			undef $self->{'features_ordered'};
123			undef $self->{reqobjs};
124			undef $self->{requireposition};
125			}
126	williamc	1.1.2.1
127			sub _newfeature {
128			my $self=shift;
129			my $name=shift;
130			my @value=@_;
131
132			# if it dosnt exist , make sure we first mark all the current reqs
133			# get inserted beforehand
134			if ( ! exists $self->{features}{$name} ) {
135			# add feature name to our ordered list
136			push @{$self->{'features_ordered'}},$name;
137			for ( $i=0; $i<=$#{$self->{reqobjs}}; $i++ ) {
138			$self->_recordpos( $name, $i);
139			}
140			}
141			}
142
143			sub features {
144			my $self=shift;
145
146			# return (keys %{$self->{features}});
147			return @{$self->{'features_ordered'}};
148			}
149
150			sub getfeature {
151			my $self=shift;
152			my $name=shift;
153
154			my @rv=();
155			my @rep;
156			# make sure we insert requirements at the right place
157			for ( my $i=-1; $i<=$#{$self->{features}{$name}}; $i++ ) {
158			if ( $i>=0 ) {
159			push @rv, $self->{features}{$name}[$i];
160			}
161			my @rep=$self->_testpos($name, $i);
162			my $repobj;
163			foreach $repobj ( @rep ) {
164			push @rv, $repobj->getfeature($name);
165			}
166			}
167			return @rv;
168			}
169
170			sub clearfeature {
171			my $self=shift;
172			my $name=shift;
173
174			undef @{$self->{features}{$name}};
175			}
176
177			sub addrequirement {
178			my $self=shift;
179			my $reqobj=shift;
180
181			push @{$self->{reqobjs}}, $reqobj;
182			foreach $key ( keys %{$self->{features}} ) {
183			$self->_recordpos($key,$#{$self->{reqobjs}});
184			}
185			}
186
187			sub dependencies {
188			my $self=shift;
189			return @{$self->{recobjs}}
190			}
191
192	williamc	1.1.2.3	sub store {
193	williamc	1.1.2.2	my $self=shift;
194			my $location=shift;
195
196			my $fh=FileHandle->new();
197	williamc	1.1.2.6	$self->verbose("opening $location for output");
198	williamc	1.1.2.2	$fh->open(">".$location) or die "Unable to open $location for output".
199			$!."\n";
200	williamc	1.1.2.3	print $fh "name:".$self->name().":_sys\n";
201			print $fh "version:".$self->version().":_sys\n";
202	williamc	1.1.2.4	print $fh "url:".$self->url().":_sys\n";
203	williamc	1.1.2.2	foreach $f ( $self->features()) {
204			foreach $val ( $self->getfeature($f) ) {
205	williamc	1.1.2.3	print $fh $f.":".$val.":".$self->type($f)."\n";
206	williamc	1.1.2.2	}
207			}
208			undef $fh;
209			}
210
211			sub restore {
212			my $self=shift;
213			my $location=shift;
214
215			my $fh=FileHandle->new();
216			$fh->open("<".$location) or die "Unable to open $location for output".
217			$!."\n";
218			my ($tool,$type,$variable,$value);
219			while ( <$fh> ) {
220			chomp;
221			next if /^#/;
222			next if /^\s*$/;
223	williamc	1.1.2.3	($variable, $value, $type)=split /:/;
224	williamc	1.1.2.2	next if ( $variable=~/\&/ );
225			$product=~tr[A-Z][a-z];
226			if ( $type eq "_sys" ) {
227	williamc	1.1.2.3	if ( $self->can($variable)) {
228	williamc	1.1.2.2	$self->$variable($value);
229			}
230			}
231			else {
232			$self->addfeature($variable,$value);
233			}
234			}
235			undef $fh;
236			}
237
238	williamc	1.1.2.1	sub _recordpos {
239			my $self=shift;
240			my $name=shift;
241			my $recref=shift;
242
243			push @{$self->{requireposition}{$name}{$#{$self->{features}{$name}}}}
244			,$recref;
245			}
246
247			# return array of objects that correspond to the required position
248			sub _testpos {
249			my $self=shift;
250			my $name=shift;
251			my $ref=shift;
252
253			my @rv=();
254			if ( exists $self->{requireposition}{$name}{$ref} ) {
255			foreach $recref ( @{$self->{requireposition}{$name}{$ref}} ) {
256			push @rv, $self->{reqobjs}[$recref];
257			}
258			}
259			return @rv;
260			}
261	williamc	1.1.2.2
262