Filename | /usr/lib/x86_64-linux-gnu/perl5/5.20/Template/Base.pm |
Statements | Executed 0 statements in 0s |
Calls | P | F | Exclusive Time |
Inclusive Time |
Subroutine |
---|---|---|---|---|---|
1 | 1 | 1 | 2.19ms | 3.43ms | BEGIN@24 | Template::Base::
1 | 1 | 1 | 18µs | 27µs | BEGIN@22 | Template::Base::
1 | 1 | 1 | 15µs | 28µs | BEGIN@44 | Template::Base::
1 | 1 | 1 | 12µs | 22µs | BEGIN@85 | Template::Base::
1 | 1 | 1 | 11µs | 20µs | BEGIN@137 | Template::Base::
1 | 1 | 1 | 9µs | 31µs | BEGIN@45 | Template::Base::
1 | 1 | 1 | 9µs | 14µs | BEGIN@23 | Template::Base::
0 | 0 | 0 | 0s | 0s | _init | Template::Base::
0 | 0 | 0 | 0s | 0s | debug | Template::Base::
0 | 0 | 0 | 0s | 0s | error | Template::Base::
0 | 0 | 0 | 0s | 0s | module_version | Template::Base::
0 | 0 | 0 | 0s | 0s | new | Template::Base::
Line | State ments |
Time on line |
Calls | Time in subs |
Code |
---|---|---|---|---|---|
1 | #============================================================= -*-perl-*- | ||||
2 | # | ||||
3 | # Template::Base | ||||
4 | # | ||||
5 | # DESCRIPTION | ||||
6 | # Base class module implementing common functionality for various other | ||||
7 | # Template Toolkit modules. | ||||
8 | # | ||||
9 | # AUTHOR | ||||
10 | # Andy Wardley <abw@wardley.org> | ||||
11 | # | ||||
12 | # COPYRIGHT | ||||
13 | # Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved. | ||||
14 | # | ||||
15 | # This module is free software; you can redistribute it and/or | ||||
16 | # modify it under the same terms as Perl itself. | ||||
17 | # | ||||
18 | #======================================================================== | ||||
19 | |||||
20 | package Template::Base; | ||||
21 | |||||
22 | 2 | 36µs | # spent 27µs (18+9) within Template::Base::BEGIN@22 which was called:
# once (18µs+9µs) by base::import at line 22 # spent 27µs making 1 call to Template::Base::BEGIN@22
# spent 9µs making 1 call to strict::import | ||
23 | 2 | 20µs | # spent 14µs (9+6) within Template::Base::BEGIN@23 which was called:
# once (9µs+6µs) by base::import at line 23 # spent 14µs making 1 call to Template::Base::BEGIN@23
# spent 6µs making 1 call to warnings::import | ||
24 | 2 | 3.46ms | # spent 3.43ms (2.19+1.24) within Template::Base::BEGIN@24 which was called:
# once (2.19ms+1.24ms) by base::import at line 24 # spent 3.43ms making 1 call to Template::Base::BEGIN@24
# spent 33µs making 1 call to Exporter::import | ||
25 | |||||
26 | our $VERSION = 2.78; | ||||
27 | |||||
28 | |||||
29 | #------------------------------------------------------------------------ | ||||
30 | # new(\%params) | ||||
31 | # | ||||
32 | # General purpose constructor method which expects a hash reference of | ||||
33 | # configuration parameters, or a list of name => value pairs which are | ||||
34 | # folded into a hash. Blesses a hash into an object and calls its | ||||
35 | # _init() method, passing the parameter hash reference. Returns a new | ||||
36 | # object derived from Template::Base, or undef on error. | ||||
37 | #------------------------------------------------------------------------ | ||||
38 | |||||
39 | sub new { | ||||
40 | my $class = shift; | ||||
41 | my ($argnames, @args, $arg, $cfg); | ||||
42 | # $class->error(''); # always clear package $ERROR var? | ||||
43 | |||||
44 | 2 | 41µs | # spent 28µs (15+13) within Template::Base::BEGIN@44 which was called:
# once (15µs+13µs) by base::import at line 44 # spent 28µs making 1 call to Template::Base::BEGIN@44
# spent 13µs making 1 call to strict::unimport | ||
45 | 2 | 53µs | # spent 31µs (9+22) within Template::Base::BEGIN@45 which was called:
# once (9µs+22µs) by base::import at line 45 # spent 31µs making 1 call to Template::Base::BEGIN@45
# spent 22µs making 1 call to warnings::unimport | ||
46 | $argnames = \@{"$class\::BASEARGS"} || [ ]; | ||||
47 | } | ||||
48 | |||||
49 | # shift off all mandatory args, returning error if undefined or null | ||||
50 | foreach $arg (@$argnames) { | ||||
51 | return $class->error("no $arg specified") | ||||
52 | unless ($cfg = shift); | ||||
53 | push(@args, $cfg); | ||||
54 | } | ||||
55 | |||||
56 | # fold all remaining args into a hash, or use provided hash ref | ||||
57 | $cfg = defined $_[0] && ref($_[0]) eq 'HASH' ? shift : { @_ }; | ||||
58 | |||||
59 | my $self = bless { | ||||
60 | (map { ($_ => shift @args) } @$argnames), | ||||
61 | _ERROR => '', | ||||
62 | DEBUG => 0, | ||||
63 | }, $class; | ||||
64 | |||||
65 | return $self->_init($cfg) ? $self : $class->error($self->error); | ||||
66 | } | ||||
67 | |||||
68 | |||||
69 | #------------------------------------------------------------------------ | ||||
70 | # error() | ||||
71 | # error($msg, ...) | ||||
72 | # | ||||
73 | # May be called as a class or object method to set or retrieve the | ||||
74 | # package variable $ERROR (class method) or internal member | ||||
75 | # $self->{ _ERROR } (object method). The presence of parameters indicates | ||||
76 | # that the error value should be set. Undef is then returned. In the | ||||
77 | # abscence of parameters, the current error value is returned. | ||||
78 | #------------------------------------------------------------------------ | ||||
79 | |||||
80 | sub error { | ||||
81 | my $self = shift; | ||||
82 | my $errvar; | ||||
83 | |||||
84 | { | ||||
85 | 2 | 32µs | # spent 22µs (12+10) within Template::Base::BEGIN@85 which was called:
# once (12µs+10µs) by base::import at line 85 # spent 22µs making 1 call to Template::Base::BEGIN@85
# spent 10µs making 1 call to strict::unimport | ||
86 | $errvar = ref $self ? \$self->{ _ERROR } : \${"$self\::ERROR"}; | ||||
87 | } | ||||
88 | if (@_) { | ||||
89 | $$errvar = ref($_[0]) ? shift : join('', @_); | ||||
90 | return undef; | ||||
91 | } | ||||
92 | else { | ||||
93 | return $$errvar; | ||||
94 | } | ||||
95 | } | ||||
96 | |||||
97 | |||||
98 | #------------------------------------------------------------------------ | ||||
99 | # _init() | ||||
100 | # | ||||
101 | # Initialisation method called by the new() constructor and passing a | ||||
102 | # reference to a hash array containing any configuration items specified | ||||
103 | # as constructor arguments. Should return $self on success or undef on | ||||
104 | # error, via a call to the error() method to set the error message. | ||||
105 | #------------------------------------------------------------------------ | ||||
106 | |||||
107 | sub _init { | ||||
108 | my ($self, $config) = @_; | ||||
109 | return $self; | ||||
110 | } | ||||
111 | |||||
112 | |||||
113 | sub debug { | ||||
114 | my $self = shift; | ||||
115 | my $msg = join('', @_); | ||||
116 | my ($pkg, $file, $line) = caller(); | ||||
117 | |||||
118 | unless ($msg =~ /\n$/) { | ||||
119 | $msg .= ($self->{ DEBUG } & Template::Constants::DEBUG_CALLER) | ||||
120 | ? " at $file line $line\n" | ||||
121 | : "\n"; | ||||
122 | } | ||||
123 | |||||
124 | print STDERR "[$pkg] $msg"; | ||||
125 | } | ||||
126 | |||||
127 | |||||
128 | #------------------------------------------------------------------------ | ||||
129 | # module_version() | ||||
130 | # | ||||
131 | # Returns the current version number. | ||||
132 | #------------------------------------------------------------------------ | ||||
133 | |||||
134 | sub module_version { | ||||
135 | my $self = shift; | ||||
136 | my $class = ref $self || $self; | ||||
137 | 2 | 28µs | # spent 20µs (11+8) within Template::Base::BEGIN@137 which was called:
# once (11µs+8µs) by base::import at line 137 # spent 20µs making 1 call to Template::Base::BEGIN@137
# spent 8µs making 1 call to strict::unimport | ||
138 | return ${"${class}::VERSION"}; | ||||
139 | } | ||||
140 | |||||
141 | |||||
142 | 1; | ||||
143 | |||||
144 | __END__ |