Wrapper.pm

filter: Statementstmt 87.7% 100 / 114 Branchbran 45.2% 19 / 42 Conditioncond 17.5% 7 / 40 MC/DCmcdc 0.0% 0 / 21 Subroutinesub 93.5% 29 / 31 Podpod 100% 14 / 14 totaltotal 64.5% 169 / 262 CC 34 SCAR 22.0
CC
34
Cov
64%
load
35.2
add_language
12.0
__ANON__
7.9
CRAP 9.0
↑ Summary Wrapper/Module.pm »
1 package Inline::Wrapper;
2 #
3 # Inline::* module dynamic loader and useful wrapper routines
4 #
5 # $Id: Wrapper.pm 14 2010-03-10 09:08:18Z infidel $
6 #
7 # POD documentation after __END__
8 #
9  
10 7 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
11 7 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
12 7 ▶use Carp qw( carp croak );
Subroutine BEGIN: called CC=1 SCAR=0.0
13 7 ▶use Data::Dumper;
Subroutine BEGIN: called CC=1 SCAR=0.0
14 7 ▶use vars qw( $TRUE $FALSE $VERSION );
Subroutine BEGIN: called CC=1 SCAR=0.0
15 7 ▶BEGIN { $INC{'Inline::Wrapper.pm'} ||= __FILE__ }; # recursive use check
Subroutine BEGIN: called CC=2 SCAR=7.6
Condition50%1/2
$INC{"Inline::Wrapper.pm"} ||= __FILE__
l!l
07
MC/DC0%0/1
$INC{"Inline::Wrapper.pm"} ||= __FILE__
$INC{"Inline::Wrapper.pm"}
Truth table50%1/2
A
A= $INC{"Inline::Wrapper.pm"}
Aresult
11
00
16 7 ▶use Inline::Wrapper::Module; # individual code modules
Subroutine BEGIN: called CC=1 SCAR=0.0
17  
18 ###
19 ### VARS
20 ###
21  
22 7 $VERSION = '0.05';
23 7 *TRUE = \1;
24 7 *FALSE = \0;
25  
26 7 my $DEFAULTS = {
27 base_dir => '.', # default search directory
28 auto_reload => $FALSE, # automatically reload module?
29 language => 'Lua', # default language
30 };
31  
32 7 my $LANGS = {
33 Foo => '.foo', # built in to Inline's distro
34 C => '.c',
35 Lua => '.lua',
36 # 'C++' => '.cpp',
37 # Java => '.java',
38 # Python => '.py',
39 # Tcl => '.tcl',
40 # Ruby => '.rb',
41 };
42  
43 my $PARAMS = {
44 6 ▶ base_dir => sub { $_[0] },
Subroutine __ANON__: called CC=1 SCAR=0.0
45 2 ▶ auto_reload => sub { $_[0] ? $TRUE : $FALSE },
Subroutine __ANON__: called CC=2 SCAR=6.9
Branch: 1 branch
BranchTrueFalseTotal
$_[0] ? : 1 1 2
46 7 ▶ language => sub {
Subroutine __ANON__: called CC=4 SCAR=20.7
47 defined( $_[0] ) and exists( $LANGS->{$_[0]} )
48 ? $_[0]
49 : ( carp sprintf( "Invalid language: %s; using %s",
50 $_[0], $DEFAULTS->{language} )
51 and $DEFAULTS->{language} )
52 7 ▶ },
Branch: 2 branches
BranchTrueFalseTotal
defined $_[0] and exists $$LANGS{$_[0]} ? $_[0] : carp(sprintf('Invalid language: %s; using %s', $_[0], $DEFAULTS->{"language"})) && $DEFAULTS->{"language"} 7 0 7
exists $$LANGS{$_[0]} ? : 7 0 7
Condition0%0/3
carp(sprintf('Invalid language: %s; using %s', $_[0], $DEFAULTS->{"language"})) and $DEFAULTS->{"language"}
!ll&&!rl&&r
000
MC/DC0%0/2
carp(sprintf('Invalid language: %s; using %s', $_[0], $DEFAULTS->{"language"})) and $DEFAULTS->{"language"}
carp(sprintf('Invalid language: %s; using %s', $_[0], $DEFAULTS->{"language"})) $DEFAULTS->{"language"}
Truth table0%0/3
A and B
A= carp(sprintf('Invalid language: %s; using %s', $_[0], $DEFAULTS->{"language"}))B= $DEFAULTS->{"language"}
ABresult
0X0
100
111
53 7 };
54  
55 ###
56 ### CONSTRUCTOR
57 ###
58  
59 sub new
60 7 ▶{
Subroutine new: called CC=3 SCAR=11.3
Pod documented
61 7 my( $class, @args ) = @_;
62  
63 # Check parameters
64 0 ▶ @args = %{ $args[0] } if( ref( $args[0] ) eq 'HASH' );
Branch: 1 branch
BranchTrueFalseTotal
if ref $args[0] eq "HASH" 0 7 7
65 7 ▶ croak "$class: \%args must be a hash; read the docs" if( @args & 1 );
Branch: 1 branch
BranchTrueFalseTotal
if @args & 1 0 7 7
66  
67 # Set up object
68 7 my $self = {
69 %$DEFAULTS,
70 # modules => {},
71 };
72 7 bless( $self, $class );
73  
74 # Initialize object instance
75 7 @args = $self->_process_args( @args );
76 7 $self->initialize( @args );
77  
78 7 return( $self );
79 }
80  
81 sub initialize
82 6 ▶{
Subroutine initialize: called CC=1 SCAR=0.0
Pod documented
83 6 my( $self ) = @_;
84  
85 6 $self->{modules} = {};
86  
87 6 return;
88 }
89  
90 ###
91 ### PUBLIC METHODS
92 ###
93  
94 # Load a code module named $modname from $base_dir with $lang_extension
95 sub load
96 1 ▶{
Subroutine load: called CC=10 SCAR=35.6
Pod documented
97 1 my( $self, $modname, @args ) = @_;
98  
99 # Check arguments
100 1 ▶ croak "load() \$modname is a required param; read the docs"
Branch: 1 branch
BranchTrueFalseTotal
unless $modname 0 1 1
101 unless( $modname );
102 0 ▶ @args = %{ $args[0] } if( ref( $args[0] ) eq 'HASH' );
Branch: 1 branch
BranchTrueFalseTotal
if ref $args[0] eq "HASH" 0 1 1
103 1 ▶ croak "load(): \%args must be a hash; read the docs"
Branch: 1 branch
BranchTrueFalseTotal
if @args & 1 0 1 1
104 if( @args & 1 );
105 1 my %args = @args;
106  
107 # Check for duplicate modules, return @function list if found
108 # XXX: Possible bug; should probably issue reload if auto_reload
109 # ends up being set to true.
110 1 ▶ if( my $temp_module = $self->_module( $modname ) )
Branch: 1 branch
BranchTrueFalseTotal
if (my $temp_module = $self->_module($modname)) 0 1 1
111 {
112 0 ▶ my $temp_lang = $args{language} || $self->language();
Condition0%0/3
$args{'language'} || $self->language
l!l&&r!l&&!r
000
MC/DC0%0/2
$args{'language'} || $self->language
$args{'language'} $self->language
Truth table0%0/3
A || B
A= $args{'language'}B= $self->language
ABresult
1X1
011
000
113 0 ▶ my $temp_base_dir = $args{base_dir} || $self->base_dir();
Condition0%0/3
$args{'base_dir'} || $self->base_dir
l!l&&r!l&&!r
000
MC/DC0%0/2
$args{'base_dir'} || $self->base_dir
$args{'base_dir'} $self->base_dir
Truth table0%0/3
A || B
A= $args{'base_dir'}B= $self->base_dir
ABresult
1X1
011
000
114 0 ▶ if( $temp_lang eq $temp_module->language() &&
Branch: 1 branch
BranchTrueFalseTotal
if ($temp_lang eq $temp_module->language and $temp_base_dir eq $temp_module->base_dir) 0 0 0
Condition0%0/3
$temp_lang eq $temp_module->language and $temp_base_dir eq $temp_module->base_dir
!ll&&!rl&&r
000
MC/DC0%0/2
$temp_lang eq $temp_module->language and $temp_base_dir eq $temp_module->base_dir
$temp_lang eq $temp_module->language $temp_base_dir eq $temp_module->base_dir
Truth table0%0/3
A and B
A= $temp_lang eq $temp_module->languageB= $temp_base_dir eq $temp_module->base_dir
ABresult
0X0
100
111
115 $temp_base_dir eq $temp_module->base_dir() )
116 {
117 $temp_module->set_auto_reload( $args{auto_reload} )
118 0 ▶ if( $args{auto_reload} );
Branch: 1 branch
BranchTrueFalseTotal
if $args{"auto_reload"} 0 0 0
119 0 print "HONK!\n";
120 0 return( $temp_module->_function_list() ); # RETURN
121 }
122 }
123  
124 # Create a new module object
125 1 my $module = Inline::Wrapper::Module->new(
126 module_name => $modname,
127 lang_ext => $self->_lang_ext(),
128 $self->_settings(),
129 %args,
130 );
131 1 $self->_add_module( $modname, $module );
132  
133 # Actually attempt to load the inline module
134 1 my @functions = $module->_load();
135  
136 1 return( @functions );
137 }
138  
139 # Completely unload a loaded $modname, rendering its functions uncallable
140 sub unload
141 1 ▶{
Subroutine unload: called CC=4 SCAR=18.7
Pod documented
142 1 my( $self, $modname ) = @_;
143  
144 1 ▶ carp "$modname not loaded" and return
Branch: 1 branch
BranchTrueFalseTotal
unless ref $self->_module($modname) 0 1 1
Condition20%1/5
ref $self->_module($modname) || carp("$modname not loaded") && (return)
l!l&&r!l&&!r
100
carp("$modname not loaded") and return
!ll
00
MC/DC0%0/2
ref $self->_module($modname) || carp("$modname not loaded") && (return)
ref $self->_module($modname) carp("$modname not loaded")
Truth table33%1/3
A || B
A= ref $self->_module($modname)B= carp("$modname not loaded")
ABresult
1X1
011
000
145 unless( ref( $self->_module( $modname ) ) );
146  
147 1 ▶ return( $self->_del_module( $modname ) && $modname );
Condition33%1/3
$self->_del_module($modname) && $modname
!ll&&!rl&&r
001
MC/DC0%0/2
$self->_del_module($modname) && $modname
$self->_del_module($modname) $modname
Truth table33%1/3
A && B
A= $self->_del_module($modname)B= $modname
ABresult
0X0
100
111
148 }
149  
150 # Run a $modname::$funcname function, passing it @args
151 sub run
152 1 ▶{
Subroutine run: called CC=1 SCAR=0.0
Pod documented
153 1 my( $self, $modname, $funcname, @args ) = @_;
154  
155 1 my $module = $self->_module( $modname );
156 1 my @retvals = $module->_run( $funcname, @args );
157  
158 1 return( @retvals );
159 }
160  
161 # Return the list of already-loaded modules
162 sub modules
163 4 ▶{
Subroutine modules: called CC=1 SCAR=0.0
Pod documented
164 4 my( $self ) = @_;
165  
166 4 return( $self->_module_names() );
167 }
168  
169 # Return the list of functions loaded from $modname
170 sub functions
171 1 ▶{
Subroutine functions: called CC=3 SCAR=13.5
Pod documented
172 1 my( $self, $modname ) = @_;
173  
174 1 my $module = $self->_module( $modname );
175 1 ▶ carp "Module '$modname' not loaded"
Branch: 1 branch
BranchTrueFalseTotal
unless ref $module 0 1 1
Condition20%1/5
ref $module || carp("Module '${modname}' not loaded") && (return ())
l!l&&r!l&&!r
100
carp("Module '${modname}' not loaded") and return ()
!ll
00
MC/DC0%0/2
ref $module || carp("Module '${modname}' not loaded") && (return ())
ref $module carp("Module '${modname}' not loaded")
Truth table33%1/3
A || B
A= ref $moduleB= carp("Module '${modname}' not loaded")
ABresult
1X1
011
000
176 and return()
177 unless( ref( $module ) );
178  
179 1 return( $module->_function_list() );
180 }
181  
182 ###
183 ### PRIVATE METHODS
184 ###
185  
186 sub _process_args
187 7 ▶{
Subroutine _process_args: called CC=4 SCAR=13.9
188 7 my( $self, @args ) = @_;
189 7 ▶ croak "_process_args() requires an even number of params" if( @args & 1 );
Branch: 1 branch
BranchTrueFalseTotal
if @args & 1 0 7 7
190 7 my %args = @args;
191  
192 7 for( keys %args )
193 {
194 15 ▶ next unless( exists( $PARAMS->{lc $_} ) ); # not for us, pass on
Branch: 1 branch
BranchTrueFalseTotal
unless exists $$PARAMS{lc $_} 2 13 15
195 13 $self->{lc $_} = $PARAMS->{lc $_}->( $args{$_} );
196 13 delete( $args{$_} );
197 }
198  
199 7 return( %args );
200 }
201  
202 sub _module_names
203 4 ▶{
Subroutine _module_names: called CC=1 SCAR=0.0
204 4 my( $self ) = @_;
205  
206 4 return( keys( %{ $self->{modules} } ) );
207 }
208  
209 sub _settings
210 1 ▶{
Subroutine _settings: called CC=1 SCAR=0.0
211 1 my( $self ) = @_;
212  
213 1 my %defaults = map { $_ => $self->{$_} } keys( %$DEFAULTS );
214  
215 1 return( %defaults );
216 }
217  
218 ###
219 ### ACCESSORS
220 ###
221  
222 sub base_dir
223 7 ▶{
Subroutine base_dir: called CC=1 SCAR=0.0
Pod documented
224 7 my( $self ) = @_;
225  
226 7 return( $self->{base_dir} );
227 }
228  
229 sub set_base_dir
230 0 ▶{
Subroutine set_base_dir: not called CC=2 SCAR=17.9
Pod documented
231 0 my( $self, $base_dir ) = @_;
232  
233 # Validate
234 0 $base_dir = $PARAMS->{base_dir}->( $base_dir );
235  
236 return( defined( $base_dir )
237 ? $self->{base_dir} = $base_dir
238 0 ▶ : $self->{base_dir} );
Branch: 1 branch
BranchTrueFalseTotal
defined $base_dir ? : 0 0 0
239 }
240  
241 sub language
242 6 ▶{
Subroutine language: called CC=1 SCAR=0.0
Pod documented
243 6 my( $self ) = @_;
244  
245 6 return( $self->{language} );
246 }
247  
248 sub set_language
249 2 ▶{
Subroutine set_language: called CC=2 SCAR=7.1
Pod documented
250 2 my( $self, $language ) = @_;
251  
252 # Validate
253 2 $language = $PARAMS->{language}->( $language );
254  
255 return( defined( $language )
256 ? $self->{language} = $language
257 2 ▶ : $self->{language} );
Branch: 1 branch
BranchTrueFalseTotal
defined $language ? : 2 0 2
258 }
259  
260 sub add_language
261 2 ▶{
Subroutine add_language: called CC=6 SCAR=24.8
Pod documented
262 2 my( $self, $language, $lang_ext ) = @_;
263  
264 2 ▶ carp "add_language(): Language not set; read the docs"
Branch: 1 branch
BranchTrueFalseTotal
unless $language 0 2 2
Condition20%1/5
$language || carp('add_language(): Language not set; read the docs') && (return)
l!l&&r!l&&!r
200
carp("add_language(): Language not set; read the docs") and return
!ll
00
MC/DC0%0/2
$language || carp('add_language(): Language not set; read the docs') && (return)
$language carp("add_language(): Language not set; read the docs")
Truth table33%1/3
A || B
A= $languageB= carp("add_language(): Language not set; read the docs")
ABresult
1X1
011
000
265 and return
266 unless( $language );
267 2 ▶ carp "add_language(): Language extension not set; read the docs"
Branch: 1 branch
BranchTrueFalseTotal
unless $lang_ext 0 2 2
Condition20%1/5
$lang_ext || carp('add_language(): Language extension not set; read the docs') && (return)
l!l&&r!l&&!r
200
carp("add_language(): Language extension not set; read the docs") and return
!ll
00
MC/DC0%0/2
$lang_ext || carp('add_language(): Language extension not set; read the docs') && (return)
$lang_ext carp("add_language(): Language extension not set; read the docs")
Truth table33%1/3
A || B
A= $lang_extB= carp("add_language(): Language extension not set; read the docs")
ABresult
1X1
011
000
268 and return
269 unless( $lang_ext );
270  
271 2 ▶ return( ( $LANGS->{$language} = $lang_ext ) ? $language : undef );
Branch: 1 branch
BranchTrueFalseTotal
($LANGS->{$language} = $lang_ext) ? : 2 0 2
272 }
273  
274 sub auto_reload
275 7 ▶{
Subroutine auto_reload: called CC=1 SCAR=0.0
Pod documented
276 7 my( $self ) = @_;
277  
278 7 return( $self->{auto_reload} );
279 }
280  
281 sub set_auto_reload
282 0 ▶{
Subroutine set_auto_reload: not called CC=2 SCAR=17.9
Pod documented
283 0 my( $self, $auto_reload ) = @_;
284  
285 # Validate
286 0 $auto_reload = $PARAMS->{auto_reload}->( $auto_reload );
287  
288 return( defined( $auto_reload )
289 ? $self->{auto_reload} = $auto_reload
290 0 ▶ : $self->{auto_reload} );
Branch: 1 branch
BranchTrueFalseTotal
defined $auto_reload ? : 0 0 0
291 }
292  
293 ### PRIVATE ACCESSORS
294  
295 sub _module
296 4 ▶{
Subroutine _module: called CC=1 SCAR=0.0
297 4 my( $self, $modname ) = @_;
298  
299 4 return( $self->{modules}->{$modname} );
300 }
301  
302 sub _add_module
303 1 ▶{
Subroutine _add_module: called CC=1 SCAR=0.0
304 1 my( $self, $modname, $module ) = @_;
305  
306 1 return( $self->{modules}->{$modname} = $module );
307 }
308  
309 sub _del_module
310 1 ▶{
Subroutine _del_module: called CC=1 SCAR=0.0
311 1 my( $self, $modname ) = @_;
312  
313 # Namespace is deleted by $module->DESTROY()
314 1 return( delete( $self->{modules}->{$modname} ) );
315 }
316  
317 ###
318 ### PRIVATE UTILITY ROUTINES
319 ###
320  
321 sub _lang_ext
322 8 ▶{
Subroutine _lang_ext: called CC=2 SCAR=7.6
323 8 my( $self, $language ) = @_;
324  
325 8 ▶ $language ||= $self->{language};
Condition33%1/3
$language ||= $self->{"language"}
l!l&&r!l&&!r
080
MC/DC0%0/2
$language ||= $self->{"language"}
$language $self->{"language"}
Truth table33%1/3
A ||= B
A= $languageB= $self->{"language"}
ABresult
1X1
011
000
326  
327 8 return( $LANGS->{$language} );
328 }
329  
330 7 1;
331  
332 __END__
↑ Summary Wrapper/Module.pm »