Commit | Line | Data |
d90b42a6 |
1 | |
2 | package Class::MOP::Method::Constructor; |
3 | |
4 | use strict; |
5 | use warnings; |
6 | |
7 | use Carp 'confess'; |
8 | use Scalar::Util 'blessed', 'weaken', 'looks_like_number'; |
9 | |
074ec38f |
10 | our $VERSION = '0.89'; |
d519662a |
11 | $VERSION = eval $VERSION; |
d90b42a6 |
12 | our $AUTHORITY = 'cpan:STEVAN'; |
13 | |
29d4e92a |
14 | use base 'Class::MOP::Method::Inlined'; |
d90b42a6 |
15 | |
16 | sub new { |
17 | my $class = shift; |
18 | my %options = @_; |
8d2d4c67 |
19 | |
ad315b75 |
20 | (blessed $options{metaclass} && $options{metaclass}->isa('Class::MOP::Class')) |
21 | || confess "You must pass a metaclass instance if you want to inline" |
8d2d4c67 |
22 | if $options{is_inline}; |
23 | |
b38f3848 |
24 | ($options{package_name} && $options{name}) |
32202ce2 |
25 | || confess "You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT"; |
b38f3848 |
26 | |
0bfc85b8 |
27 | my $self = $class->_new(\%options); |
d90b42a6 |
28 | |
8d2d4c67 |
29 | # we don't want this creating |
30 | # a cycle in the code, if not |
d90b42a6 |
31 | # needed |
8683db0e |
32 | weaken($self->{'associated_metaclass'}); |
d90b42a6 |
33 | |
8f7852d8 |
34 | $self->_initialize_body; |
d90b42a6 |
35 | |
8d2d4c67 |
36 | return $self; |
d90b42a6 |
37 | } |
38 | |
28b97bef |
39 | sub _new { |
0bfc85b8 |
40 | my $class = shift; |
812d58f9 |
41 | |
ec9e38e5 |
42 | return Class::MOP::Class->initialize($class)->new_object(@_) |
812d58f9 |
43 | if $class ne __PACKAGE__; |
ec9e38e5 |
44 | |
45 | my $params = @_ == 1 ? $_[0] : {@_}; |
46 | |
47 | return bless { |
48 | # inherited from Class::MOP::Method |
49 | body => $params->{body}, |
50 | # associated_metaclass => $params->{associated_metaclass}, # overriden |
51 | package_name => $params->{package_name}, |
52 | name => $params->{name}, |
53 | original_method => $params->{original_method}, |
54 | |
55 | # inherited from Class::MOP::Generated |
56 | is_inline => $params->{is_inline} || 0, |
57 | definition_context => $params->{definition_context}, |
58 | |
59 | # inherited from Class::MOP::Inlined |
60 | _expected_method_class => $params->{_expected_method_class}, |
61 | |
62 | # defined in this subclass |
63 | options => $params->{options} || {}, |
64 | associated_metaclass => $params->{metaclass}, |
28b97bef |
65 | }, $class; |
66 | } |
67 | |
8d2d4c67 |
68 | ## accessors |
c23184fc |
69 | |
8683db0e |
70 | sub options { (shift)->{'options'} } |
71 | sub associated_metaclass { (shift)->{'associated_metaclass'} } |
c23184fc |
72 | |
565f0cbb |
73 | ## cached values ... |
d90b42a6 |
74 | |
8d2d4c67 |
75 | sub meta_instance { |
c7e28c19 |
76 | Carp::cluck('The meta_instance method has been made private.' |
77 | . " The public version is deprecated and will be removed in a future release.\n"); |
d5c7f638 |
78 | shift->_meta_instance; |
5a49fb79 |
79 | } |
80 | |
81 | sub _meta_instance { |
565f0cbb |
82 | my $self = shift; |
8683db0e |
83 | $self->{'meta_instance'} ||= $self->associated_metaclass->get_meta_instance; |
565f0cbb |
84 | } |
c23184fc |
85 | |
8d2d4c67 |
86 | sub attributes { |
c7e28c19 |
87 | Carp::cluck('The attributes method has been made private.' |
88 | . " The public version is deprecated and will be removed in a future release.\n"); |
6e2f5a81 |
89 | |
780f14c2 |
90 | return shift->_attributes; |
91 | } |
92 | |
93 | sub _attributes { |
565f0cbb |
94 | my $self = shift; |
2620be77 |
95 | $self->{'attributes'} ||= [ $self->associated_metaclass->get_all_attributes ] |
565f0cbb |
96 | } |
d90b42a6 |
97 | |
98 | ## method |
99 | |
565f0cbb |
100 | sub initialize_body { |
c7e28c19 |
101 | Carp::cluck('The initialize_body method has been made private.' |
102 | . " The public version is deprecated and will be removed in a future release.\n"); |
d5c7f638 |
103 | shift->_initialize_body; |
8f7852d8 |
104 | } |
105 | |
106 | sub _initialize_body { |
565f0cbb |
107 | my $self = shift; |
ecb874a0 |
108 | my $method_name = '_generate_constructor_method'; |
8d2d4c67 |
109 | |
565f0cbb |
110 | $method_name .= '_inline' if $self->is_inline; |
8d2d4c67 |
111 | |
8683db0e |
112 | $self->{'body'} = $self->$method_name; |
565f0cbb |
113 | } |
114 | |
115 | sub generate_constructor_method { |
c7e28c19 |
116 | Carp::cluck('The generate_constructor_method method has been made private.' |
117 | . " The public version is deprecated and will be removed in a future release.\n"); |
d5c7f638 |
118 | shift->_generate_constructor_method; |
ecb874a0 |
119 | } |
120 | |
121 | sub _generate_constructor_method { |
2a2b8458 |
122 | return sub { Class::MOP::Class->initialize(shift)->new_object(@_) } |
565f0cbb |
123 | } |
124 | |
125 | sub generate_constructor_method_inline { |
c7e28c19 |
126 | Carp::cluck('The generate_constructor_method_inline method has been made private.' |
127 | . " The public version is deprecated and will be removed in a future release.\n"); |
d5c7f638 |
128 | shift->_generate_constructor_method_inline; |
ecb874a0 |
129 | } |
130 | |
131 | sub _generate_constructor_method_inline { |
d90b42a6 |
132 | my $self = shift; |
565f0cbb |
133 | |
0c6f3280 |
134 | my $close_over = {}; |
135 | |
d90b42a6 |
136 | my $source = 'sub {'; |
26ffbb36 |
137 | $source .= "\n" . 'my $class = shift;'; |
8d2d4c67 |
138 | |
26ffbb36 |
139 | $source .= "\n" . 'return Class::MOP::Class->initialize($class)->new_object(@_)'; |
8d2d4c67 |
140 | $source .= "\n" . ' if $class ne \'' . $self->associated_metaclass->name . '\';'; |
141 | |
26ffbb36 |
142 | $source .= "\n" . 'my $params = @_ == 1 ? $_[0] : {@_};'; |
143 | |
5a49fb79 |
144 | $source .= "\n" . 'my $instance = ' . $self->_meta_instance->inline_create_instance('$class'); |
8d2d4c67 |
145 | $source .= ";\n" . (join ";\n" => map { |
82cff1ae |
146 | $self->_generate_slot_initializer($_, $close_over) |
780f14c2 |
147 | } @{ $self->_attributes }); |
d90b42a6 |
148 | $source .= ";\n" . 'return $instance'; |
8d2d4c67 |
149 | $source .= ";\n" . '}'; |
150 | warn $source if $self->options->{debug}; |
151 | |
e24b19fb |
152 | my ( $code, $e ) = $self->_eval_closure( |
ffe92c8b |
153 | $close_over, |
154 | $source |
155 | ); |
e24b19fb |
156 | confess "Could not eval the constructor :\n\n$source\n\nbecause :\n\n$e" if $e; |
a6eef5a3 |
157 | |
158 | return $code; |
d90b42a6 |
159 | } |
160 | |
161 | sub _generate_slot_initializer { |
162 | my $self = shift; |
64adcd8d |
163 | my $attr = shift; |
82cff1ae |
164 | my $close = shift; |
8d2d4c67 |
165 | |
d90b42a6 |
166 | my $default; |
167 | if ($attr->has_default) { |
168 | # NOTE: |
169 | # default values can either be CODE refs |
8d2d4c67 |
170 | # in which case we need to call them. Or |
d90b42a6 |
171 | # they can be scalars (strings/numbers) |
172 | # in which case we can just deal with them |
173 | # in the code we eval. |
174 | if ($attr->is_default_a_coderef) { |
82cff1ae |
175 | my $idx = @{$close->{'@defaults'}||=[]}; |
176 | push(@{$close->{'@defaults'}}, $attr->default); |
177 | $default = '$defaults[' . $idx . ']->($instance)'; |
d90b42a6 |
178 | } |
179 | else { |
180 | $default = $attr->default; |
181 | # make sure to quote strings ... |
182 | unless (looks_like_number($default)) { |
183 | $default = "'$default'"; |
184 | } |
185 | } |
8d2d4c67 |
186 | } elsif( $attr->has_builder ) { |
187 | $default = '$instance->'.$attr->builder; |
d90b42a6 |
188 | } |
8d2d4c67 |
189 | |
2f2329a4 |
190 | if ( defined(my $init_arg = $attr->init_arg) ) { |
c16c9c1b |
191 | return ( |
2f2329a4 |
192 | 'if(exists $params->{\'' . $init_arg . '\'}){' . "\n" . |
5a49fb79 |
193 | $self->_meta_instance->inline_set_slot_value( |
c16c9c1b |
194 | '$instance', |
e9a19694 |
195 | $attr->name, |
2f2329a4 |
196 | '$params->{\'' . $init_arg . '\'}' ) . "\n" . |
c16c9c1b |
197 | '} ' . (!defined $default ? '' : 'else {' . "\n" . |
5a49fb79 |
198 | $self->_meta_instance->inline_set_slot_value( |
c16c9c1b |
199 | '$instance', |
e9a19694 |
200 | $attr->name, |
c16c9c1b |
201 | $default ) . "\n" . |
202 | '}') |
203 | ); |
204 | } elsif ( defined $default ) { |
205 | return ( |
5a49fb79 |
206 | $self->_meta_instance->inline_set_slot_value( |
c16c9c1b |
207 | '$instance', |
e9a19694 |
208 | $attr->name, |
c16c9c1b |
209 | $default ) . "\n" |
210 | ); |
211 | } else { return '' } |
d90b42a6 |
212 | } |
213 | |
214 | 1; |
215 | |
d90b42a6 |
216 | __END__ |
217 | |
218 | =pod |
219 | |
8d2d4c67 |
220 | =head1 NAME |
d90b42a6 |
221 | |
222 | Class::MOP::Method::Constructor - Method Meta Object for constructors |
223 | |
224 | =head1 SYNOPSIS |
225 | |
96e38ba6 |
226 | use Class::MOP::Method::Constructor; |
8d2d4c67 |
227 | |
96e38ba6 |
228 | my $constructor = Class::MOP::Method::Constructor->new( |
8d2d4c67 |
229 | metaclass => $metaclass, |
96e38ba6 |
230 | options => { |
231 | debug => 1, # this is all for now |
8d2d4c67 |
232 | }, |
96e38ba6 |
233 | ); |
8d2d4c67 |
234 | |
96e38ba6 |
235 | # calling the constructor ... |
b7045e66 |
236 | $constructor->body->execute($metaclass->name, %params); |
8d2d4c67 |
237 | |
d90b42a6 |
238 | =head1 DESCRIPTION |
239 | |
3fd960d9 |
240 | This is a subclass of C<Class::MOP::Method> which generates |
241 | constructor methods. |
96e38ba6 |
242 | |
d90b42a6 |
243 | =head1 METHODS |
244 | |
245 | =over 4 |
246 | |
3fd960d9 |
247 | =item B<< Class::MOP::Method::Constructor->new(%options) >> |
d90b42a6 |
248 | |
3fd960d9 |
249 | This creates a new constructor object. It accepts a hash reference of |
250 | options. |
96e38ba6 |
251 | |
3fd960d9 |
252 | =over 8 |
96e38ba6 |
253 | |
3fd960d9 |
254 | =item * metaclass |
96e38ba6 |
255 | |
3fd960d9 |
256 | This should be a L<Class::MOP::Class> object. It is required. |
c23184fc |
257 | |
3fd960d9 |
258 | =item * name |
d90b42a6 |
259 | |
3fd960d9 |
260 | The method name (without a package name). This is required. |
96e38ba6 |
261 | |
3fd960d9 |
262 | =item * package_name |
d90b42a6 |
263 | |
3fd960d9 |
264 | The package name for the method. This is required. |
c23184fc |
265 | |
3fd960d9 |
266 | =item * is_inline |
96e38ba6 |
267 | |
3fd960d9 |
268 | This indicates whether or not the constructor should be inlined. This |
269 | defaults to false. |
d90b42a6 |
270 | |
3fd960d9 |
271 | =back |
f0de47d9 |
272 | |
3fd960d9 |
273 | =item B<< $metamethod->is_inline >> |
f0de47d9 |
274 | |
3fd960d9 |
275 | Returns a boolean indicating whether or not the constructor is |
276 | inlined. |
d90b42a6 |
277 | |
3fd960d9 |
278 | =item B<< $metamethod->associated_metaclass >> |
96e38ba6 |
279 | |
3fd960d9 |
280 | This returns the L<Class::MOP::Class> object for the method. |
d90b42a6 |
281 | |
565f0cbb |
282 | =back |
283 | |
d90b42a6 |
284 | =head1 AUTHORS |
285 | |
286 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
287 | |
288 | =head1 COPYRIGHT AND LICENSE |
289 | |
070bb6c9 |
290 | Copyright 2006-2009 by Infinity Interactive, Inc. |
d90b42a6 |
291 | |
292 | L<http://www.iinteractive.com> |
293 | |
294 | This library is free software; you can redistribute it and/or modify |
8d2d4c67 |
295 | it under the same terms as Perl itself. |
d90b42a6 |
296 | |
297 | =cut |
298 | |