1Test::Smoke::BuildCFG(3U)ser Contributed Perl DocumentatiToenst::Smoke::BuildCFG(3)
2
6 Test::Smoke::BuildCFG - OO interface for handling build configurations
7
9 use Test::Smoke::BuildCFG;
10 my $name = 'perlcurrent.cfg';
12 my $bcfg = Test::Smoke::BuildCFG->new( $name );
13 foreach my $config ( $bcfg->configurations ) {
15 # do somthing with $config
16 }
17
19 Handle the build configurations
20
22 Test::Smoke::BuildCFG->new( [$cfgname] )
23 [ Constructor | Public ]
24 Initialise a new object.
26 Test::Smoke::BuildCFG->continue( $logfile[, $cfgname, %options] )
28 [Constructor | public]
29 Initialize a new object without the configurations that have already
31 been fully processed. If *all* configurations have been processed, just
32 pass the equivalent of the "new()" method.
33 $bldcfg->verbose
35 [ Getter | Public]
36 Get verbosity.
38 Test::Smoke::BuildCFG->config( $key[, $value] )
40 [ ClassAccessor | Public ]
41 "config()" is an interface to the package lexical %CONFIG, which holds
43 all the default values for the "new()" arguments.
44 With the special key all_defaults this returns a reference to a hash
46 holding all the default values.
47 $self->read_parse( $cfgname )
49 "read_parse()" reads the build configurations file and parses it.
50 $self->_read( $nameorref )
52 "_read()" is a private method that handles the reading.
53 Reference to a SCALAR build configurations are in $$nameorref
55 Reference to an ARRAY build configurations are in @$nameorref
56 Reference to a GLOB build configurations are read from the filehandle
57 Other values are taken as the filename for the build configurations
58 $self->_parse( )
60 "_parse()" will split the build configurations file in sections.
61 Sections are ended with a line that begins with an equals-sign ('=').
62 There are two types of section
64 buildopt-section
66 policy-section
67 A policy-section contains a "target-option". This is a build option
68 that should be in the ccflags variable in the Policy.sh file (see
69 also Test::Smoke::Policy) and starts with a (forward) slash ('/').
70 A policy-section can have only one (1) target-option.
72 $self->_serialize( )
74 "_serialize()" creates a list of Test::Smoke::BuildCFG::Config objects
75 from the parsed sections.
76 __build_list( $list, $previous_args, $policy_subst, $this_cfg, @cfgs )
78 Recursive sub, mainly taken from the old "run_tests()" in mktest.pl
79 $buildcfg->configurations( )
81 Returns the list of configurations (Test::Smoke::BuildCFG::Config
82 objects)
83 $buildcfg->policy_targets( )
85 Returns a list of policytargets from the policy substitution sections
86 as_string
88 Return the parsed configuration as a string.
89 __get_smoked_configs( $logfile )
91 Parse the logfile and return a hash(ref) of already processed
92 configurations.
93 Test::Smoke::BuildCFG->default_buildcfg()
95 This is a constant that returns a textversion of the default
96 configuration.
97 new_configuration( $config )
99 A wrapper around "Test::Smoke::BuildCFG::Config->new()" so the object
100 is accessible from outside this package.
101
103 Test::Smoke::BuildCFG::Config - OO interface for a build confiuration
104
106 my $bcfg = Test::Smoke::BuildCFG::Config->new( $args, $policy );
107 or
109 my $bcfg = Test::Smoke::BuildCFG::Config->new;
111 $bcfg->args( $args );
112 $bcfg->policy( [ -DDEBUGGING => '-DDEBUGGING' ],
113 [ -DPERL_COPY_ON_WRITE => '' ] );
114 if ( $bcfg->has_arg( '-Duseithreads' ) ) {
116 # do stuff for -Duseithreads
117 }
118
120 This is a simple object that holds both the build arguments and the
121 policy substitutions. The build arguments are stored as a string and
122 the policy subtitutions are stored as a list of lists. Each
123 substitution is represented as a list with the two elements: the target
124 and its substitute.
125
127 Test::Smoke::BuildCFG::Config->new( [ $args[, \@policy_substs ]] )
128 Create the new object as an anonymous list.
129 $buildcfg->args( [$args] )
131 Accessor for the build arguments field.
132 $buildcfg->policy( [@substitutes] )
134 Accessor for the policy substitutions.
135 $self->_split_args( )
137 Create a hash with all the build arguments as keys.
138 $buildcfg->has_arg( $arg[,...] )
140 Check the build arguments hash for $arg. If you specify more then one
141 the results will be logically ANDed!
142 $buildcfg->any_arg( $arg[,...] )
144 Check the build arguments hash for $arg. If you specify more then one
145 the results will be logically ORed!
146 $buildcfg->args_eq( $args )
148 "args_eq()" takes a string of config arguments and returns true if
149 $self has exactly the same args as the $args has.
150 There is the small matter of default_args (dfopts) kept as a Class
152 variable in Test::Smoke::BuildCFG!
153 $config->rm_arg( $arg[,..] )
155 Simply remove the argument(s) from the list and recreate the arguments
156 line.
157 $config->vms
159 Redo the the commandline switches in a VMSish way.
160
162 Test::Smoke::Smoker, Test::Smoke::Syncer::Policy
163
165 (c) 2002-2003, All rights reserved.
166 * Abe Timmerman <abeltje@cpan.org>
168 This library is free software; you can redistribute it and/or modify it
170 under the same terms as Perl itself.
171 See:
173 • http://www.perl.com/perl/misc/Artistic.html
175 • http://www.gnu.org/copyleft/gpl.html
177 This program is distributed in the hope that it will be useful, but
179 WITHOUT ANY WARRANTY; without even the implied warranty of
180 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
181perl v5.36.0 2022-07-22 Test::Smoke::BuildCFG(3)