src/BuildSystem/ToolDoc.pm

#
# ToolDoc.pm
#
# Originally Written by Christopher Williams
#
# Description
# -----------
# SimpleDoc interface to initialise Tool objects
#
# Interface
# ---------
# new()         : A new ToolDoc object
# tool(toolobj) : set the tool object for the class
# setup(file,$name,$version) : setup a tool object from the specified file
#                               return 0 for OK 1 for cancel
# interactive([0|1]) : set the interactive node 0=off 1=on

package BuildSystem::ToolDoc;
require 5.004;
use ActiveDoc::SimpleDoc;

sub new {
        my $class=shift;
        $self={};
        bless $self, $class;
        $self->init();
        return $self;
}

sub init {
        my $self=shift;
        $self->{switch}=ActiveDoc::SimpleDoc->new();
        $self->{switch}->newparse("setup");
        $self->{switch}->addtag("setup","Tool",\&Tool_Start, $self,     
                                                "", $self,
                                                \&Tool_End, $self);
        $self->{switch}->addtag("setup","Lib",\&Lib, $self,     
                                                "", $self,
                                                "", $self);
        $self->{switch}->addtag("setup","External",\&External_Start, $self,     
                                                "", $self,
                                                "", $self);
        $self->{switch}->addtag("setup","Client",\&Client_start, $self, 
                                                "", $self,
                                                \&Client_end, $self);
        $self->{switch}->addtag("setup","Environment",
                                                \&Environment_Start, $self,     
                                                \&Env_text, $self,
                                                \&Environment_End, $self);
        $self->{switch}->grouptag("Tool","setup");
        $self->{switch}->addtag("setup","Architecture",
                                        \&Arch_Start,$self,
                                        "", $self,
                                        \&Arch_End,$self);
        $self->{Arch}=1;
        push @{$self->{ARCHBLOCK}}, $self->{Arch};

}

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

sub tool {
        my $self=shift;
        $self->{tool}=shift;
}

sub setup {
        my $self=shift;
        my $file=shift;
        my $name=shift;
        my $version=shift;

        $self->{ToolEnv}{'SCRAMtoolname'}=$name;
        $self->{ToolEnv}{'SCRAMtoolversion'}=$version;
        $self->{ToolEnv}{'SCRAM_ARCH'}=$ENV{'SCRAM_ARCH'};

        $name=~tr[A-Z][a-z];
        $self->{tool}->name($name);
        $self->{tool}->version($version);
        $self->{switch}->filetoparse($file);
        $self->{toolfound}=1;
        $self->{switch}->parse("setup");
        return $self->{toolfound};
}

sub featuretext {
        my $self=shift;
        my $feature=shift;

        if ( @_ ) {
          $self->{featuretext}{$feature}=shift;
        }
        else {
          return ($self->{featuretext}{$feature});
        }
}

sub _checkdefault {
        my $self=shift;
        my $hashref=shift;

        if ( defined $$hashref{'default'} ) { #check default
          my $default;
          foreach $default ( split /:/, $$hashref{'default'} ) {
            $default=~s/\"//;
            if ($self->_testlocation($default,
               [ $self->{tool}->getfeature($$hashref{'type'})] )) { return 1; }
          }
        }
        return 0;
}

sub _testlocation {
        my $self=shift;
        my $default=shift;
        my $testfiles=shift;
        my $OK='false';
        my $file;

        chomp $default;
        $default=$self->_expandvars($default);
        print "Trying $default .... ";
        if ( -f $default ) {
                $OK="true";
        }
        else {
          my $fh=FileHandle->new();
          opendir $fh,  $default or do { print "No \n"; return 0; };
         ($#{$testfiles}==-1) ? $OK='false' : $OK='true';
          print "\n";
          my @files=readdir $fh;
          undef $fh;
          foreach $file ( @$testfiles ) {
                print "   Checking for $file .... ";
                # now check that the required files are actually there
                if ( ( $number = grep /\Q$file\L/, @files) == 0 ) {
                   $OK='false';
                   print "not found\n";
                   last;
                }
                print "found\n";
          }
        }
        if ( $OK eq 'true' ) {
                print "Directory Check Complete\n";
                return 1
        }
        return 0
}

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

        return "" , if ( ! defined $string );
        $string=~s{
                \$\((\w+)\)
        }{
          if (defined $self->{ToolEnv}{$1}) {
                $self->_expandvars($self->{ToolEnv}{$1});
          } else {
                "\$$1";
          }
        }egx;
        $string=~s{
                \$(\w+)
        }{
          if (defined $self->{ToolEnv}{$1}) {
                $self->_expandvars($self->{ToolEnv}{$1});
          } else {
                "\$$1";
          }
        }egx;
        return $string;
}


sub _askuser {
        my $self=shift;
        my $querystring=shift;
        my $varname=shift;

        print $self->featuretext($self->{EnvContext});
        for  ( ;; ) {
         print "\n".$querystring." (RETURN to log as missing)\nset $varname = ";
         $path=<STDIN>;
         chomp $path;
         if ( $path ne "" ) {
          if ( defined $self->{'client'}) { # must be a location
           if ( $self->_testlocation($path , "H", $Envtype{$type} )) {
             return $path;
           }
           print "Error : ".$path." does not exist.\n";
           next;
          }
         }
         else {
           return $path;
         }
        } #end for

}

# -- Tag Routines

sub Client_start {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        if ( $self->{Arch} ) {
          $self->{'client'}=1;
        }
}

sub Client_end {
        my $self=shift;
        if ( $self->{Arch} ) {
        undef $self->{'client'};
        }
}
        
sub Tool_Start {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        $self->{switch}->checktag($name, $hashref, 'name');
        $self->{switch}->checktag($name, $hashref, 'version');
        $self->{switch}->opengroup("Toolactive");

        # lower case the name
        $$hashref{'name'}=~tr[A-Z][a-z];
        # make sure we only pick up the tool requested
        if ( ( $self->{tool}->name() eq $$hashref{'name'} ) && 
                ($self->{tool}->version() eq $$hashref{'version'})) {
          $self->{switch}->
                allowgroup("Toolactive",$self->{switch}->currentparsename());
          $self->{ToolEnv}{'SCRAMtoolname'}=$$hashref{'name'};
          $self->{ToolEnv}{'SCRAMtoolversion'}=$$hashref{'version'};
          $self->{toolfound}=0;
        }
        else {
          $self->{switch}->disallowgroup("Toolactive",
                                $self->{switch}->currentparsename());
        }
}

sub Tool_End {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        $self->{switch}->closegroup("Toolactive");
}

sub Environment_Start {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        $self->{switch}->checktag($name, $hashref, 'name');
        if ( $self->{Arch} ) {
          if ( defined $self->{EnvContext} ) {
            $self->parserror(" Attempted to open new <$name> context".
                        " without closing the previous one");
          }
          $self->{currentenvtext}="";
          $self->{EnvContext}=$$hashref{'name'};
          undef $self->{Envvalue};
          if ( exists $$hashref{'type'} ) {
            $$hashref{'type'}=~tr[A-Z][a-z];
            $self->{tool}->type($$hashref{'name'},$$hashref{'type'});
          }
          if ( exists $$hashref{'value'}) {
            $self->{Envvalue}=$$hashref{'value'};
          }
          elsif ( ! $self->interactive() ) {
           # check the environment
           if ( defined $ENV{$$hashref{'name'}} ) {
            $self->{Envvalue}=$ENV{$$hashref{'name'}};
           }
           elsif ( $self->_checkdefault($hashref) ) {
            $self->{Envvalue}=$$hashref{'default'};
           }
          }
        }
}

sub Env_text {
        my $self=shift;
        my $name=shift;
        my $string=shift;

        if ( $self->{Arch} ) {
          $self->{currentenvtext}=$self->{currentenvtext}.$string;
        }
}

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

        if ( $self->{Arch} ) {
          if ( ! defined $self->{EnvContext} ) {
            $self->{switch}->parseerror("</$name> without an opening context");
          }
          # - set the help text
          $self->featuretext($self->{EnvContext},$self->{currentenvtext});
          if ( ! defined $self->{Envvalue} ) {
            $self->{Envvalue}=$self->_askuser("Please Enter the Value Below:",
                        $self->{EnvContext});
          }
          $self->{Envvalue}=$self->_expandvars($self->{Envvalue});
          $self->{tool}->addfeature($self->{EnvContext}, $self->{Envvalue});
          $self->{ToolEnv}{$self->{EnvContext}}=$self->{Envvalue};
          undef $self->{EnvContext};
          undef $self->{Envvalue};
        }
}

sub Lib {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        $self->{switch}->checktag($name, $hashref, 'name');
        if ( $self->{Arch} ) {
          $self->{tool}->addfeature("lib",$$hashref{'name'});
        }
}

sub External_Start {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        $self->{switch}->checktag($name, $hashref,'ref');
        if ( $self->{Arch} ) {
          $self->{tool}->addfeature("_externals",$$hashref{'ref'});
        }
}

sub Arch_Start {
        my $self=shift;
        my $name=shift;
        my $hashref=shift;

        $self->{switch}->checktag($name, $hashref,'name');
        ( ($ENV{SCRAM_ARCH}=~/$$hashref{name}.*/) )? ($self->{Arch}=1)
                                                : ($self->{Arch}=0);
        push @{$self->{ARCHBLOCK}}, $self->{Arch};
}

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

        pop @{$self->{ARCHBLOCK}};
        $self->{Arch}=$self->{ARCHBLOCK}[$#{$self->{ARCHBLOCK}}];
}


Revision:	1.1.2.10
Committed:	Fri May 5 14:18:45 2000 UTC (25 years ago) by williamc
Content type:	text/plain
Branch:	V0_9branch
CVS Tags:	V0_12_11, V0_12_9b, V0_12_10, V0_12_9, V0_12_8, V0_12_7, V0_12_6, V0_12_5, V0_12_4
Changes since 1.1.2.9:	+3 -2 lines
Log Message:	bugfix - pass types
#	User	Rev	Content
1	williamc	1.1.2.1	#
2			# ToolDoc.pm
3			#
4			# Originally Written by Christopher Williams
5			#
6			# Description
7			# -----------
8			# SimpleDoc interface to initialise Tool objects
9			#
10			# Interface
11			# ---------
12			# new() : A new ToolDoc object
13			# tool(toolobj) : set the tool object for the class
14			# setup(file,$name,$version) : setup a tool object from the specified file
15	williamc	1.1.2.3	# return 0 for OK 1 for cancel
16	williamc	1.1.2.1	# interactive([0\|1]) : set the interactive node 0=off 1=on
17
18			package BuildSystem::ToolDoc;
19			require 5.004;
20			use ActiveDoc::SimpleDoc;
21
22			sub new {
23			my $class=shift;
24			$self={};
25			bless $self, $class;
26			$self->init();
27			return $self;
28			}
29
30			sub init {
31			my $self=shift;
32			$self->{switch}=ActiveDoc::SimpleDoc->new();
33			$self->{switch}->newparse("setup");
34			$self->{switch}->addtag("setup","Tool",\&Tool_Start, $self,
35			"", $self,
36			\&Tool_End, $self);
37			$self->{switch}->addtag("setup","Lib",\&Lib, $self,
38			"", $self,
39			"", $self);
40			$self->{switch}->addtag("setup","External",\&External_Start, $self,
41			"", $self,
42			"", $self);
43			$self->{switch}->addtag("setup","Client",\&Client_start, $self,
44			"", $self,
45			\&Client_end, $self);
46			$self->{switch}->addtag("setup","Environment",
47			\&Environment_Start, $self,
48			\&Env_text, $self,
49			\&Environment_End, $self);
50			$self->{switch}->grouptag("Tool","setup");
51			$self->{switch}->addtag("setup","Architecture",
52			\&Arch_Start,$self,
53			"", $self,
54			\&Arch_End,$self);
55			$self->{Arch}=1;
56	williamc	1.1.2.6	push @{$self->{ARCHBLOCK}}, $self->{Arch};
57	williamc	1.1.2.1
58			}
59
60			sub interactive {
61			my $self=shift;
62
63			@_?$self->{interactive}=shift
64			:((defined $self->{interactive})?$self->{interactive}:0);
65			}
66
67			sub tool {
68			my $self=shift;
69			$self->{tool}=shift;
70			}
71
72			sub setup {
73			my $self=shift;
74			my $file=shift;
75			my $name=shift;
76			my $version=shift;
77
78			$self->{ToolEnv}{'SCRAMtoolname'}=$name;
79			$self->{ToolEnv}{'SCRAMtoolversion'}=$version;
80			$self->{ToolEnv}{'SCRAM_ARCH'}=$ENV{'SCRAM_ARCH'};
81
82			$name=~tr[A-Z][a-z];
83			$self->{tool}->name($name);
84			$self->{tool}->version($version);
85			$self->{switch}->filetoparse($file);
86	williamc	1.1.2.4	$self->{toolfound}=1;
87	williamc	1.1.2.1	$self->{switch}->parse("setup");
88	williamc	1.1.2.4	return $self->{toolfound};
89	williamc	1.1.2.1	}
90
91			sub featuretext {
92			my $self=shift;
93			my $feature=shift;
94
95			if ( @_ ) {
96			$self->{featuretext}{$feature}=shift;
97			}
98			else {
99			return ($self->{featuretext}{$feature});
100			}
101			}
102
103			sub _checkdefault {
104			my $self=shift;
105			my $hashref=shift;
106
107			if ( defined $$hashref{'default'} ) { #check default
108			my $default;
109			foreach $default ( split /:/, $$hashref{'default'} ) {
110			$default=~s/\"//;
111			if ($self->_testlocation($default,
112			[ $self->{tool}->getfeature($$hashref{'type'})] )) { return 1; }
113			}
114			}
115			return 0;
116			}
117
118			sub _testlocation {
119			my $self=shift;
120			my $default=shift;
121			my $testfiles=shift;
122			my $OK='false';
123			my $file;
124
125			chomp $default;
126			$default=$self->_expandvars($default);
127			print "Trying $default .... ";
128			if ( -f $default ) {
129			$OK="true";
130			}
131			else {
132			my $fh=FileHandle->new();
133			opendir $fh, $default or do { print "No \n"; return 0; };
134			($#{$testfiles}==-1) ? $OK='false' : $OK='true';
135			print "\n";
136			my @files=readdir $fh;
137			undef $fh;
138			foreach $file ( @$testfiles ) {
139			print " Checking for $file .... ";
140			# now check that the required files are actually there
141			if ( ( $number = grep /\Q$file\L/, @files) == 0 ) {
142			$OK='false';
143			print "not found\n";
144			last;
145			}
146			print "found\n";
147			}
148			}
149			if ( $OK eq 'true' ) {
150			print "Directory Check Complete\n";
151			return 1
152			}
153			return 0
154			}
155
156			sub _expandvars {
157			my $self=shift;
158			my $string=shift;
159
160			return "" , if ( ! defined $string );
161			$string=~s{
162			\$\((\w+)\)
163			}{
164			if (defined $self->{ToolEnv}{$1}) {
165			$self->_expandvars($self->{ToolEnv}{$1});
166			} else {
167			"\$$1";
168			}
169			}egx;
170			$string=~s{
171			\$(\w+)
172			}{
173			if (defined $self->{ToolEnv}{$1}) {
174			$self->_expandvars($self->{ToolEnv}{$1});
175			} else {
176			"\$$1";
177			}
178			}egx;
179			return $string;
180			}
181
182
183			sub _askuser {
184			my $self=shift;
185			my $querystring=shift;
186			my $varname=shift;
187
188			print $self->featuretext($self->{EnvContext});
189			for ( ;; ) {
190			print "\n".$querystring." (RETURN to log as missing)\nset $varname = ";
191			$path=<STDIN>;
192			chomp $path;
193			if ( $path ne "" ) {
194			if ( defined $self->{'client'}) { # must be a location
195			if ( $self->_testlocation($path , "H", $Envtype{$type} )) {
196			return $path;
197			}
198			print "Error : ".$path." does not exist.\n";
199			next;
200			}
201			}
202			else {
203			return $path;
204			}
205			} #end for
206
207			}
208
209			# -- Tag Routines
210
211			sub Client_start {
212			my $self=shift;
213			my $name=shift;
214			my $hashref=shift;
215
216			if ( $self->{Arch} ) {
217			$self->{'client'}=1;
218			}
219			}
220
221			sub Client_end {
222			my $self=shift;
223			if ( $self->{Arch} ) {
224			undef $self->{'client'};
225			}
226			}
227
228			sub Tool_Start {
229			my $self=shift;
230			my $name=shift;
231			my $hashref=shift;
232
233			$self->{switch}->checktag($name, $hashref, 'name');
234			$self->{switch}->checktag($name, $hashref, 'version');
235			$self->{switch}->opengroup("Toolactive");
236
237			# lower case the name
238			$$hashref{'name'}=~tr[A-Z][a-z];
239			# make sure we only pick up the tool requested
240			if ( ( $self->{tool}->name() eq $$hashref{'name'} ) &&
241			($self->{tool}->version() eq $$hashref{'version'})) {
242			$self->{switch}->
243			allowgroup("Toolactive",$self->{switch}->currentparsename());
244			$self->{ToolEnv}{'SCRAMtoolname'}=$$hashref{'name'};
245			$self->{ToolEnv}{'SCRAMtoolversion'}=$$hashref{'version'};
246	williamc	1.1.2.4	$self->{toolfound}=0;
247	williamc	1.1.2.1	}
248			else {
249			$self->{switch}->disallowgroup("Toolactive",
250			$self->{switch}->currentparsename());
251			}
252			}
253
254			sub Tool_End {
255			my $self=shift;
256			my $name=shift;
257			my $hashref=shift;
258
259			$self->{switch}->closegroup("Toolactive");
260			}
261
262			sub Environment_Start {
263			my $self=shift;
264			my $name=shift;
265			my $hashref=shift;
266
267			$self->{switch}->checktag($name, $hashref, 'name');
268			if ( $self->{Arch} ) {
269			if ( defined $self->{EnvContext} ) {
270			$self->parserror(" Attempted to open new <$name> context".
271			" without closing the previous one");
272			}
273			$self->{currentenvtext}="";
274			$self->{EnvContext}=$$hashref{'name'};
275			undef $self->{Envvalue};
276	williamc	1.1.2.10	if ( exists $$hashref{'type'} ) {
277			$$hashref{'type'}=~tr[A-Z][a-z];
278			$self->{tool}->type($$hashref{'name'},$$hashref{'type'});
279	williamc	1.1.2.1	}
280			if ( exists $$hashref{'value'}) {
281			$self->{Envvalue}=$$hashref{'value'};
282			}
283			elsif ( ! $self->interactive() ) {
284	williamc	1.1.2.5	# check the environment
285			if ( defined $ENV{$$hashref{'name'}} ) {
286			$self->{Envvalue}=$ENV{$$hashref{'name'}};
287			}
288			elsif ( $self->_checkdefault($hashref) ) {
289	williamc	1.1.2.1	$self->{Envvalue}=$$hashref{'default'};
290			}
291			}
292			}
293			}
294
295			sub Env_text {
296			my $self=shift;
297			my $name=shift;
298			my $string=shift;
299
300			if ( $self->{Arch} ) {
301			$self->{currentenvtext}=$self->{currentenvtext}.$string;
302			}
303			}
304
305			sub Environment_End {
306			my $self=shift;
307			my $name=shift;
308
309			if ( $self->{Arch} ) {
310			if ( ! defined $self->{EnvContext} ) {
311	williamc	1.1.2.8	$self->{switch}->parseerror("</$name> without an opening context");
312	williamc	1.1.2.1	}
313			# - set the help text
314			$self->featuretext($self->{EnvContext},$self->{currentenvtext});
315			if ( ! defined $self->{Envvalue} ) {
316			$self->{Envvalue}=$self->_askuser("Please Enter the Value Below:",
317			$self->{EnvContext});
318			}
319			$self->{Envvalue}=$self->_expandvars($self->{Envvalue});
320			$self->{tool}->addfeature($self->{EnvContext}, $self->{Envvalue});
321			$self->{ToolEnv}{$self->{EnvContext}}=$self->{Envvalue};
322			undef $self->{EnvContext};
323			undef $self->{Envvalue};
324			}
325			}
326
327			sub Lib {
328			my $self=shift;
329			my $name=shift;
330			my $hashref=shift;
331
332			$self->{switch}->checktag($name, $hashref, 'name');
333			if ( $self->{Arch} ) {
334			$self->{tool}->addfeature("lib",$$hashref{'name'});
335			}
336			}
337
338			sub External_Start {
339			my $self=shift;
340			my $name=shift;
341			my $hashref=shift;
342
343			$self->{switch}->checktag($name, $hashref,'ref');
344			if ( $self->{Arch} ) {
345	williamc	1.1.2.2	$self->{tool}->addfeature("_externals",$$hashref{'ref'});
346	williamc	1.1.2.1	}
347			}
348
349			sub Arch_Start {
350			my $self=shift;
351			my $name=shift;
352			my $hashref=shift;
353
354	williamc	1.1.2.5	$self->{switch}->checktag($name, $hashref,'name');
355	williamc	1.1.2.1	( ($ENV{SCRAM_ARCH}=~/$$hashref{name}.*/) )? ($self->{Arch}=1)
356			: ($self->{Arch}=0);
357			push @{$self->{ARCHBLOCK}}, $self->{Arch};
358			}
359
360			sub Arch_End {
361			my $self=shift;
362			my $name=shift;
363
364			pop @{$self->{ARCHBLOCK}};
365			$self->{Arch}=$self->{ARCHBLOCK}[$#{$self->{ARCHBLOCK}}];
366			}
367
368