Commit | Line | Data |
a15dff8d |
1 | |
2 | package Moose::Util::TypeConstraints; |
3 | |
998a8a25 |
4 | use Carp (); |
9e856c83 |
5 | use List::MoreUtils qw( all any ); |
9a63faba |
6 | use Scalar::Util qw( blessed reftype ); |
e606ae5f |
7 | use Moose::Exporter; |
a15dff8d |
8 | |
e6ab9ca5 |
9 | our $VERSION = '0.83'; |
e606ae5f |
10 | $VERSION = eval $VERSION; |
d44714be |
11 | our $AUTHORITY = 'cpan:STEVAN'; |
a15dff8d |
12 | |
d9b40005 |
13 | ## -------------------------------------------------------- |
e85d2a5d |
14 | # Prototyped subs must be predeclared because we have a |
15 | # circular dependency with Moose::Meta::Attribute et. al. |
16 | # so in case of us being use'd first the predeclaration |
d9b40005 |
17 | # ensures the prototypes are in scope when consumers are |
18 | # compiled. |
19 | |
d9b40005 |
20 | # dah sugah! |
180899ed |
21 | sub where (&); |
22 | sub via (&); |
23 | sub message (&); |
d9b40005 |
24 | sub optimize_as (&); |
d9b40005 |
25 | |
d9b40005 |
26 | ## -------------------------------------------------------- |
8c4acc60 |
27 | |
4e036ee4 |
28 | use Moose::Meta::TypeConstraint; |
3726f905 |
29 | use Moose::Meta::TypeConstraint::Union; |
0fbd4b0a |
30 | use Moose::Meta::TypeConstraint::Parameterized; |
7e4e1ad4 |
31 | use Moose::Meta::TypeConstraint::Parameterizable; |
620db045 |
32 | use Moose::Meta::TypeConstraint::Class; |
33 | use Moose::Meta::TypeConstraint::Role; |
dabed765 |
34 | use Moose::Meta::TypeConstraint::Enum; |
0a6bff54 |
35 | use Moose::Meta::TypeConstraint::DuckType; |
2ca63f5d |
36 | use Moose::Meta::TypeCoercion; |
3726f905 |
37 | use Moose::Meta::TypeCoercion::Union; |
22aed3c0 |
38 | use Moose::Meta::TypeConstraint::Registry; |
28ffb449 |
39 | use Moose::Util::TypeConstraints::OptimizedConstraints; |
4e036ee4 |
40 | |
e606ae5f |
41 | Moose::Exporter->setup_import_methods( |
42 | as_is => [ |
43 | qw( |
180899ed |
44 | type subtype class_type role_type maybe_type duck_type |
1b2c9bda |
45 | as where message optimize_as |
e606ae5f |
46 | coerce from via |
47 | enum |
48 | find_type_constraint |
49 | register_type_constraint ) |
50 | ], |
51 | _export_to_main => 1, |
52 | ); |
a15dff8d |
53 | |
d9b40005 |
54 | ## -------------------------------------------------------- |
55 | ## type registry and some useful functions for it |
56 | ## -------------------------------------------------------- |
57 | |
22aed3c0 |
58 | my $REGISTRY = Moose::Meta::TypeConstraint::Registry->new; |
587ae0d2 |
59 | |
180899ed |
60 | sub get_type_constraint_registry {$REGISTRY} |
61 | sub list_all_type_constraints { keys %{ $REGISTRY->type_constraints } } |
62 | |
d9b40005 |
63 | sub export_type_constraints_as_functions { |
64 | my $pkg = caller(); |
65 | no strict 'refs'; |
180899ed |
66 | foreach my $constraint ( keys %{ $REGISTRY->type_constraints } ) { |
67 | my $tc = $REGISTRY->get_type_constraint($constraint) |
68 | ->_compiled_type_constraint; |
69 | *{"${pkg}::${constraint}"} |
70 | = sub { $tc->( $_[0] ) ? 1 : undef }; # the undef is for compat |
a0f8153d |
71 | } |
d9b40005 |
72 | } |
182134e8 |
73 | |
0c015f1b |
74 | sub create_type_constraint_union { |
d9b40005 |
75 | my @type_constraint_names; |
e85d2a5d |
76 | |
180899ed |
77 | if ( scalar @_ == 1 && _detect_type_constraint_union( $_[0] ) ) { |
78 | @type_constraint_names = _parse_type_constraint_union( $_[0] ); |
d9b40005 |
79 | } |
80 | else { |
81 | @type_constraint_names = @_; |
429ccc11 |
82 | } |
180899ed |
83 | |
84 | ( scalar @type_constraint_names >= 2 ) |
85 | || __PACKAGE__->_throw_error( |
86 | "You must pass in at least 2 type names to make a union"); |
e85d2a5d |
87 | |
84a9c64c |
88 | my @type_constraints = map { |
180899ed |
89 | find_or_parse_type_constraint($_) |
90 | || __PACKAGE__->_throw_error( |
91 | "Could not locate type constraint ($_) for the union"); |
08380fdb |
92 | } @type_constraint_names; |
84a9c64c |
93 | |
3726f905 |
94 | return Moose::Meta::TypeConstraint::Union->new( |
180899ed |
95 | type_constraints => \@type_constraints ); |
182134e8 |
96 | } |
a15dff8d |
97 | |
0c015f1b |
98 | sub create_parameterized_type_constraint { |
d9b40005 |
99 | my $type_constraint_name = shift; |
180899ed |
100 | my ( $base_type, $type_parameter ) |
101 | = _parse_parameterized_type_constraint($type_constraint_name); |
e85d2a5d |
102 | |
180899ed |
103 | ( defined $base_type && defined $type_parameter ) |
104 | || __PACKAGE__->_throw_error( |
105 | "Could not parse type name ($type_constraint_name) correctly"); |
e85d2a5d |
106 | |
180899ed |
107 | if ( $REGISTRY->has_type_constraint($base_type) ) { |
90e78884 |
108 | my $base_type_tc = $REGISTRY->get_type_constraint($base_type); |
109 | return _create_parameterized_type_constraint( |
110 | $base_type_tc, |
111 | $type_parameter |
112 | ); |
180899ed |
113 | } |
114 | else { |
115 | __PACKAGE__->_throw_error( |
116 | "Could not locate the base type ($base_type)"); |
90e78884 |
117 | } |
22aed3c0 |
118 | } |
119 | |
90e78884 |
120 | sub _create_parameterized_type_constraint { |
121 | my ( $base_type_tc, $type_parameter ) = @_; |
122 | if ( $base_type_tc->can('parameterize') ) { |
123 | return $base_type_tc->parameterize($type_parameter); |
180899ed |
124 | } |
125 | else { |
90e78884 |
126 | return Moose::Meta::TypeConstraint::Parameterized->new( |
180899ed |
127 | name => $base_type_tc->name . '[' . $type_parameter . ']', |
90e78884 |
128 | parent => $base_type_tc, |
180899ed |
129 | type_parameter => |
130 | find_or_create_isa_type_constraint($type_parameter), |
90e78884 |
131 | ); |
132 | } |
180899ed |
133 | } |
90e78884 |
134 | |
4ab662d6 |
135 | #should we also support optimized checks? |
0c015f1b |
136 | sub create_class_type_constraint { |
620db045 |
137 | my ( $class, $options ) = @_; |
138 | |
180899ed |
139 | # too early for this check |
140 | #find_type_constraint("ClassName")->check($class) |
141 | # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name"); |
3fef8ce8 |
142 | |
620db045 |
143 | my %options = ( |
144 | class => $class, |
145 | name => $class, |
146 | %{ $options || {} }, |
4ab662d6 |
147 | ); |
620db045 |
148 | |
149 | $options{name} ||= "__ANON__"; |
150 | |
180899ed |
151 | Moose::Meta::TypeConstraint::Class->new(%options); |
3fef8ce8 |
152 | } |
153 | |
0c015f1b |
154 | sub create_role_type_constraint { |
620db045 |
155 | my ( $role, $options ) = @_; |
e85d2a5d |
156 | |
180899ed |
157 | # too early for this check |
158 | #find_type_constraint("ClassName")->check($class) |
159 | # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name"); |
e85d2a5d |
160 | |
620db045 |
161 | my %options = ( |
162 | role => $role, |
163 | name => $role, |
164 | %{ $options || {} }, |
165 | ); |
e85d2a5d |
166 | |
620db045 |
167 | $options{name} ||= "__ANON__"; |
168 | |
180899ed |
169 | Moose::Meta::TypeConstraint::Role->new(%options); |
620db045 |
170 | } |
171 | |
0c015f1b |
172 | sub find_or_create_type_constraint { |
620db045 |
173 | my ( $type_constraint_name, $options_for_anon_type ) = @_; |
174 | |
180899ed |
175 | if ( my $constraint |
176 | = find_or_parse_type_constraint($type_constraint_name) ) { |
620db045 |
177 | return $constraint; |
d9b40005 |
178 | } |
620db045 |
179 | elsif ( defined $options_for_anon_type ) { |
180899ed |
180 | |
d9b40005 |
181 | # NOTE: |
4ab662d6 |
182 | # if there is no $options_for_anon_type |
183 | # specified, then we assume they don't |
f3c4e20e |
184 | # want to create one, and return nothing. |
f3c4e20e |
185 | |
d9b40005 |
186 | # otherwise assume that we should create |
e85d2a5d |
187 | # an ANON type with the $options_for_anon_type |
d9b40005 |
188 | # options which can be passed in. It should |
e85d2a5d |
189 | # be noted that these don't get registered |
d9b40005 |
190 | # so we need to return it. |
191 | # - SL |
192 | return Moose::Meta::TypeConstraint->new( |
193 | name => '__ANON__', |
e85d2a5d |
194 | %{$options_for_anon_type} |
d9b40005 |
195 | ); |
196 | } |
e85d2a5d |
197 | |
620db045 |
198 | return; |
199 | } |
200 | |
0c015f1b |
201 | sub find_or_create_isa_type_constraint { |
620db045 |
202 | my $type_constraint_name = shift; |
180899ed |
203 | find_or_parse_type_constraint($type_constraint_name) |
204 | || create_class_type_constraint($type_constraint_name); |
620db045 |
205 | } |
206 | |
0c015f1b |
207 | sub find_or_create_does_type_constraint { |
620db045 |
208 | my $type_constraint_name = shift; |
180899ed |
209 | find_or_parse_type_constraint($type_constraint_name) |
210 | || create_role_type_constraint($type_constraint_name); |
620db045 |
211 | } |
212 | |
0c015f1b |
213 | sub find_or_parse_type_constraint { |
eb4c4e82 |
214 | my $type_constraint_name = normalize_type_constraint_name(shift); |
620db045 |
215 | my $constraint; |
180899ed |
216 | |
217 | if ( $constraint = find_type_constraint($type_constraint_name) ) { |
e606ae5f |
218 | return $constraint; |
180899ed |
219 | } |
220 | elsif ( _detect_type_constraint_union($type_constraint_name) ) { |
620db045 |
221 | $constraint = create_type_constraint_union($type_constraint_name); |
180899ed |
222 | } |
223 | elsif ( _detect_parameterized_type_constraint($type_constraint_name) ) { |
224 | $constraint |
225 | = create_parameterized_type_constraint($type_constraint_name); |
226 | } |
227 | else { |
620db045 |
228 | return; |
229 | } |
bb6c8335 |
230 | |
d9b40005 |
231 | $REGISTRY->add_type_constraint($constraint); |
e85d2a5d |
232 | return $constraint; |
d9b40005 |
233 | } |
22aed3c0 |
234 | |
eb4c4e82 |
235 | sub normalize_type_constraint_name { |
84a9c64c |
236 | my $type_constraint_name = shift; |
c8f663b2 |
237 | $type_constraint_name =~ s/\s//g; |
eb4c4e82 |
238 | return $type_constraint_name; |
239 | } |
240 | |
5f223879 |
241 | sub _confess { |
242 | my $error = shift; |
243 | |
244 | local $Carp::CarpLevel = $Carp::CarpLevel + 1; |
245 | Carp::confess($error); |
246 | } |
247 | |
22aed3c0 |
248 | ## -------------------------------------------------------- |
249 | ## exported functions ... |
250 | ## -------------------------------------------------------- |
251 | |
0c015f1b |
252 | sub find_type_constraint { |
eeedfc8a |
253 | my $type = shift; |
254 | |
255 | if ( blessed $type and $type->isa("Moose::Meta::TypeConstraint") ) { |
256 | return $type; |
e606ae5f |
257 | } |
258 | else { |
259 | return unless $REGISTRY->has_type_constraint($type); |
eeedfc8a |
260 | return $REGISTRY->get_type_constraint($type); |
261 | } |
262 | } |
22aed3c0 |
263 | |
0c015f1b |
264 | sub register_type_constraint { |
3fef8ce8 |
265 | my $constraint = shift; |
180899ed |
266 | __PACKAGE__->_throw_error("can't register an unnamed type constraint") |
267 | unless defined $constraint->name; |
3fef8ce8 |
268 | $REGISTRY->add_type_constraint($constraint); |
dabed765 |
269 | return $constraint; |
3fef8ce8 |
270 | } |
271 | |
7c13858b |
272 | # type constructors |
a15dff8d |
273 | |
9c27968f |
274 | sub type { |
180899ed |
275 | |
9e856c83 |
276 | # back-compat version, called without sugar |
180899ed |
277 | if ( !any { ( reftype($_) || '' ) eq 'HASH' } @_ ) { |
9e856c83 |
278 | return _create_type_constraint( $_[0], undef, $_[1] ); |
9a63faba |
279 | } |
9a63faba |
280 | |
9e856c83 |
281 | my $name = shift; |
9a63faba |
282 | |
9e856c83 |
283 | my %p = map { %{$_} } @_; |
284 | |
180899ed |
285 | return _create_type_constraint( |
286 | $name, undef, $p{where}, $p{message}, |
287 | $p{optimize_as} |
288 | ); |
a15dff8d |
289 | } |
290 | |
9c27968f |
291 | sub subtype { |
180899ed |
292 | |
9a63faba |
293 | # crazy back-compat code for being called without sugar ... |
e3979c3e |
294 | # |
9a63faba |
295 | # subtype 'Parent', sub { where }; |
296 | if ( scalar @_ == 2 && ( reftype( $_[1] ) || '' ) eq 'CODE' ) { |
297 | return _create_type_constraint( undef, @_ ); |
298 | } |
299 | |
300 | # subtype 'Parent', sub { where }, sub { message }; |
301 | # subtype 'Parent', sub { where }, sub { message }, sub { optimized }; |
302 | if ( scalar @_ >= 3 && all { ( reftype($_) || '' ) eq 'CODE' } |
180899ed |
303 | @_[ 1 .. $#_ ] ) { |
9a63faba |
304 | return _create_type_constraint( undef, @_ ); |
305 | } |
306 | |
307 | # subtype 'Name', 'Parent', ... |
308 | if ( scalar @_ >= 2 && all { !ref } @_[ 0, 1 ] ) { |
309 | return _create_type_constraint(@_); |
310 | } |
311 | |
180899ed |
312 | if ( @_ == 1 && !ref $_[0] ) { |
313 | __PACKAGE__->_throw_error( |
314 | 'A subtype cannot consist solely of a name, it must have a parent' |
315 | ); |
f75f625d |
316 | } |
317 | |
f6c0c589 |
318 | # The blessed check is mostly to accommodate MooseX::Types, which |
319 | # uses an object which overloads stringification as a type name. |
180899ed |
320 | my $name = ref $_[0] && !blessed $_[0] ? undef : shift; |
9a63faba |
321 | |
322 | my %p = map { %{$_} } @_; |
323 | |
324 | # subtype Str => where { ... }; |
180899ed |
325 | if ( !exists $p{as} ) { |
9e856c83 |
326 | $p{as} = $name; |
9a63faba |
327 | $name = undef; |
328 | } |
329 | |
180899ed |
330 | return _create_type_constraint( |
331 | $name, $p{as}, $p{where}, $p{message}, |
332 | $p{optimize_as} |
333 | ); |
a15dff8d |
334 | } |
335 | |
9c27968f |
336 | sub class_type { |
4ab662d6 |
337 | register_type_constraint( |
338 | create_class_type_constraint( |
339 | $_[0], |
180899ed |
340 | ( defined( $_[1] ) ? $_[1] : () ), |
4ab662d6 |
341 | ) |
342 | ); |
3fef8ce8 |
343 | } |
344 | |
620db045 |
345 | sub role_type ($;$) { |
346 | register_type_constraint( |
347 | create_role_type_constraint( |
348 | $_[0], |
180899ed |
349 | ( defined( $_[1] ) ? $_[1] : () ), |
620db045 |
350 | ) |
351 | ); |
352 | } |
353 | |
1b2c9bda |
354 | sub maybe_type { |
355 | my ($type_parameter) = @_; |
356 | |
28ce1444 |
357 | register_type_constraint( |
ed7060d9 |
358 | $REGISTRY->get_type_constraint('Maybe')->parameterize($type_parameter) |
28ce1444 |
359 | ); |
1b2c9bda |
360 | } |
361 | |
180899ed |
362 | sub duck_type { |
cdacfaf3 |
363 | my ( $type_name, @methods ) = @_; |
180899ed |
364 | if ( ref $type_name eq 'ARRAY' && !@methods ) { |
cdacfaf3 |
365 | @methods = @$type_name; |
180899ed |
366 | $type_name = undef; |
367 | } |
368 | |
369 | register_type_constraint( |
0a6bff54 |
370 | create_duck_type_constraint( |
cdacfaf3 |
371 | $type_name, |
0a6bff54 |
372 | \@methods, |
180899ed |
373 | ) |
374 | ); |
375 | } |
376 | |
9c27968f |
377 | sub coerce { |
180899ed |
378 | my ( $type_name, @coercion_map ) = @_; |
379 | _install_type_coercions( $type_name, \@coercion_map ); |
182134e8 |
380 | } |
381 | |
f6c0c589 |
382 | # The trick of returning @_ lets us avoid having to specify a |
383 | # prototype. Perl will parse this: |
384 | # |
385 | # subtype 'Foo' |
386 | # => as 'Str' |
387 | # => where { ... } |
388 | # |
389 | # as this: |
390 | # |
391 | # subtype( 'Foo', as( 'Str', where { ... } ) ); |
392 | # |
393 | # If as() returns all it's extra arguments, this just works, and |
394 | # preserves backwards compatibility. |
180899ed |
395 | sub as { { as => shift }, @_ } |
9e856c83 |
396 | sub where (&) { { where => $_[0] } } |
397 | sub message (&) { { message => $_[0] } } |
398 | sub optimize_as (&) { { optimize_as => $_[0] } } |
8ecb1fa0 |
399 | |
9a63faba |
400 | sub from {@_} |
401 | sub via (&) { $_[0] } |
a15dff8d |
402 | |
9c27968f |
403 | sub enum { |
180899ed |
404 | my ( $type_name, @values ) = @_; |
405 | |
4ab662d6 |
406 | # NOTE: |
407 | # if only an array-ref is passed then |
9f4334a1 |
408 | # you get an anon-enum |
409 | # - SL |
180899ed |
410 | if ( ref $type_name eq 'ARRAY' && !@values ) { |
9f4334a1 |
411 | @values = @$type_name; |
412 | $type_name = undef; |
413 | } |
180899ed |
414 | ( scalar @values >= 2 ) |
415 | || __PACKAGE__->_throw_error( |
416 | "You must have at least two values to enumerate through"); |
c4fe165f |
417 | my %valid = map { $_ => 1 } @values; |
dabed765 |
418 | |
419 | register_type_constraint( |
420 | create_enum_type_constraint( |
421 | $type_name, |
422 | \@values, |
423 | ) |
424 | ); |
425 | } |
426 | |
0c015f1b |
427 | sub create_enum_type_constraint { |
dabed765 |
428 | my ( $type_name, $values ) = @_; |
e606ae5f |
429 | |
dabed765 |
430 | Moose::Meta::TypeConstraint::Enum->new( |
180899ed |
431 | name => $type_name || '__ANON__', |
dabed765 |
432 | values => $values, |
a0f8153d |
433 | ); |
fcec2383 |
434 | } |
435 | |
0a6bff54 |
436 | sub create_duck_type_constraint { |
437 | my ( $type_name, $methods ) = @_; |
438 | |
439 | Moose::Meta::TypeConstraint::DuckType->new( |
440 | name => $type_name || '__ANON__', |
441 | methods => $methods, |
442 | ); |
443 | } |
444 | |
d9b40005 |
445 | ## -------------------------------------------------------- |
446 | ## desugaring functions ... |
447 | ## -------------------------------------------------------- |
448 | |
e85d2a5d |
449 | sub _create_type_constraint ($$$;$$) { |
9a63faba |
450 | my $name = shift; |
451 | my $parent = shift; |
452 | my $check = shift; |
453 | my $message = shift; |
454 | my $optimized = shift; |
d9b40005 |
455 | |
9a63faba |
456 | my $pkg_defined_in = scalar( caller(1) ); |
e85d2a5d |
457 | |
1da6728b |
458 | if ( defined $name ) { |
d9b40005 |
459 | my $type = $REGISTRY->get_type_constraint($name); |
e85d2a5d |
460 | |
5f223879 |
461 | ( $type->_package_defined_in eq $pkg_defined_in ) |
462 | || _confess( |
463 | "The type constraint '$name' has already been created in " |
464 | . $type->_package_defined_in |
465 | . " and cannot be created again in " |
466 | . $pkg_defined_in ) |
467 | if defined $type; |
eee1a213 |
468 | |
469 | $name =~ /^[\w:\.]+$/ |
470 | or die qq{$name contains invalid characters for a type name.} |
33c8a6d0 |
471 | . qq{ Names can contain alphanumeric character, ":", and "."\n}; |
e85d2a5d |
472 | } |
1da6728b |
473 | |
9ceb576e |
474 | my %opts = ( |
9a63faba |
475 | name => $name, |
d9b40005 |
476 | package_defined_in => $pkg_defined_in, |
e85d2a5d |
477 | |
1da6728b |
478 | ( $check ? ( constraint => $check ) : () ), |
479 | ( $message ? ( message => $message ) : () ), |
480 | ( $optimized ? ( optimized => $optimized ) : () ), |
d9b40005 |
481 | ); |
1da6728b |
482 | |
9ceb576e |
483 | my $constraint; |
180899ed |
484 | if ( |
485 | defined $parent |
1da6728b |
486 | and $parent |
180899ed |
487 | = blessed $parent |
488 | ? $parent |
489 | : find_or_create_isa_type_constraint($parent) |
490 | ) { |
85a9908f |
491 | $constraint = $parent->create_child_type(%opts); |
1da6728b |
492 | } |
493 | else { |
494 | $constraint = Moose::Meta::TypeConstraint->new(%opts); |
4ab662d6 |
495 | } |
d9b40005 |
496 | |
497 | $REGISTRY->add_type_constraint($constraint) |
498 | if defined $name; |
499 | |
500 | return $constraint; |
501 | } |
502 | |
e85d2a5d |
503 | sub _install_type_coercions ($$) { |
180899ed |
504 | my ( $type_name, $coercion_map ) = @_; |
e606ae5f |
505 | my $type = find_type_constraint($type_name); |
180899ed |
506 | ( defined $type ) |
507 | || __PACKAGE__->_throw_error( |
a885c019 |
508 | "Cannot find type '$type_name', perhaps you forgot to load it"); |
180899ed |
509 | if ( $type->has_coercion ) { |
41e007e4 |
510 | $type->coercion->add_type_coercions(@$coercion_map); |
511 | } |
512 | else { |
513 | my $type_coercion = Moose::Meta::TypeCoercion->new( |
514 | type_coercion_map => $coercion_map, |
515 | type_constraint => $type |
516 | ); |
517 | $type->coercion($type_coercion); |
518 | } |
d9b40005 |
519 | } |
520 | |
521 | ## -------------------------------------------------------- |
f1917f58 |
522 | ## type notation parsing ... |
523 | ## -------------------------------------------------------- |
524 | |
525 | { |
180899ed |
526 | |
e85d2a5d |
527 | # All I have to say is mugwump++ cause I know |
528 | # do not even have enough regexp-fu to be able |
529 | # to have written this (I can only barely |
f1917f58 |
530 | # understand it as it is) |
e85d2a5d |
531 | # - SL |
532 | |
f1917f58 |
533 | use re "eval"; |
534 | |
eee1a213 |
535 | my $valid_chars = qr{[\w:\.]}; |
f1917f58 |
536 | my $type_atom = qr{ $valid_chars+ }; |
537 | |
be722745 |
538 | my $any; |
539 | |
180899ed |
540 | my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x; |
541 | my $type_capture_parts |
542 | = qr{ ($valid_chars+) (?: \[ \s* ((??{$any})) \s* \] )? }x; |
543 | my $type_with_parameter |
544 | = qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x; |
f1917f58 |
545 | |
3796382a |
546 | my $op_union = qr{ \s* \| \s* }x; |
f1917f58 |
547 | my $union = qr{ $type (?: $op_union $type )+ }x; |
548 | |
84a9c64c |
549 | $any = qr{ $type | $union }x; |
f1917f58 |
550 | |
0fbd4b0a |
551 | sub _parse_parameterized_type_constraint { |
180899ed |
552 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
84a9c64c |
553 | $_[0] =~ m{ $type_capture_parts }x; |
180899ed |
554 | return ( $1, $2 ); |
f1917f58 |
555 | } |
556 | |
0fbd4b0a |
557 | sub _detect_parameterized_type_constraint { |
180899ed |
558 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
e85d2a5d |
559 | $_[0] =~ m{ ^ $type_with_parameter $ }x; |
f1917f58 |
560 | } |
561 | |
562 | sub _parse_type_constraint_union { |
180899ed |
563 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
e85d2a5d |
564 | my $given = shift; |
565 | my @rv; |
566 | while ( $given =~ m{ \G (?: $op_union )? ($type) }gcx ) { |
82a5b1a7 |
567 | push @rv => $1; |
e85d2a5d |
568 | } |
180899ed |
569 | ( pos($given) eq length($given) ) |
570 | || __PACKAGE__->_throw_error( "'$given' didn't parse (parse-pos=" |
571 | . pos($given) |
572 | . " and str-length=" |
573 | . length($given) |
574 | . ")" ); |
e85d2a5d |
575 | @rv; |
f1917f58 |
576 | } |
577 | |
578 | sub _detect_type_constraint_union { |
180899ed |
579 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
e85d2a5d |
580 | $_[0] =~ m{^ $type $op_union $type ( $op_union .* )? $}x; |
f1917f58 |
581 | } |
582 | } |
583 | |
584 | ## -------------------------------------------------------- |
d9b40005 |
585 | # define some basic built-in types |
586 | ## -------------------------------------------------------- |
a15dff8d |
587 | |
3cae4250 |
588 | # By making these classes immutable before creating all the types we |
589 | # below, we avoid repeatedly calling the slow MOP-based accessors. |
590 | $_->make_immutable( |
591 | inline_constructor => 1, |
592 | constructor_name => "_new", |
593 | |
594 | # these are Class::MOP accessors, so they need inlining |
595 | inline_accessors => 1 |
596 | ) for grep { $_->is_mutable } |
37edf27e |
597 | map { Class::MOP::class_of($_) } |
3cae4250 |
598 | qw( |
599 | Moose::Meta::TypeConstraint |
600 | Moose::Meta::TypeConstraint::Union |
601 | Moose::Meta::TypeConstraint::Parameterized |
602 | Moose::Meta::TypeConstraint::Parameterizable |
603 | Moose::Meta::TypeConstraint::Class |
604 | Moose::Meta::TypeConstraint::Role |
605 | Moose::Meta::TypeConstraint::Enum |
0a6bff54 |
606 | Moose::Meta::TypeConstraint::DuckType |
3cae4250 |
607 | Moose::Meta::TypeConstraint::Registry |
608 | ); |
609 | |
180899ed |
610 | type 'Any' => where {1}; # meta-type including all |
3054a5c9 |
611 | subtype 'Item' => as 'Any'; # base-type |
a15dff8d |
612 | |
fd542f49 |
613 | subtype 'Undef' => as 'Item' => where { !defined($_) }; |
180899ed |
614 | subtype 'Defined' => as 'Item' => where { defined($_) }; |
615 | |
616 | subtype 'Bool' => as 'Item' => |
617 | where { !defined($_) || $_ eq "" || "$_" eq '1' || "$_" eq '0' }; |
618 | |
619 | subtype 'Value' => as 'Defined' => where { !ref($_) } => |
620 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Value; |
621 | |
622 | subtype 'Ref' => as 'Defined' => where { ref($_) } => |
623 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Ref; |
624 | |
625 | subtype 'Str' => as 'Value' => where {1} => |
626 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Str; |
627 | |
c29e3978 |
628 | subtype 'Num' => as 'Str' => |
180899ed |
629 | where { Scalar::Util::looks_like_number($_) } => |
630 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Num; |
631 | |
632 | subtype 'Int' => as 'Num' => where { "$_" =~ /^-?[0-9]+$/ } => |
633 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Int; |
634 | |
635 | subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' } => |
636 | optimize_as |
637 | \&Moose::Util::TypeConstraints::OptimizedConstraints::ScalarRef; |
638 | subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' } => |
639 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::CodeRef; |
640 | subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' } => |
641 | optimize_as |
642 | \&Moose::Util::TypeConstraints::OptimizedConstraints::RegexpRef; |
643 | subtype 'GlobRef' => as 'Ref' => where { ref($_) eq 'GLOB' } => |
644 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::GlobRef; |
a15dff8d |
645 | |
0a5bd159 |
646 | # NOTE: |
e85d2a5d |
647 | # scalar filehandles are GLOB refs, |
0a5bd159 |
648 | # but a GLOB ref is not always a filehandle |
180899ed |
649 | subtype 'FileHandle' => as 'GlobRef' => where { |
650 | Scalar::Util::openhandle($_) || ( blessed($_) && $_->isa("IO::Handle") ); |
651 | } => optimize_as |
652 | \&Moose::Util::TypeConstraints::OptimizedConstraints::FileHandle; |
0a5bd159 |
653 | |
e85d2a5d |
654 | # NOTE: |
a15dff8d |
655 | # blessed(qr/.../) returns true,.. how odd |
180899ed |
656 | subtype 'Object' => as 'Ref' => |
657 | where { blessed($_) && blessed($_) ne 'Regexp' } => |
658 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Object; |
a15dff8d |
659 | |
180899ed |
660 | subtype 'Role' => as 'Object' => where { $_->can('does') } => |
661 | optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Role; |
e85d2a5d |
662 | |
180899ed |
663 | my $_class_name_checker = sub { }; |
0e0709ea |
664 | |
180899ed |
665 | subtype 'ClassName' => as 'Str' => |
666 | where { Class::MOP::is_class_loaded($_) } => optimize_as |
667 | \&Moose::Util::TypeConstraints::OptimizedConstraints::ClassName; |
02a0fb52 |
668 | |
180899ed |
669 | subtype 'RoleName' => as 'ClassName' => where { |
6b885dfa |
670 | (Class::MOP::class_of($_) || return)->isa('Moose::Meta::Role'); |
180899ed |
671 | } => optimize_as |
672 | \&Moose::Util::TypeConstraints::OptimizedConstraints::RoleName; |
f0cac16f |
673 | |
d9b40005 |
674 | ## -------------------------------------------------------- |
7e4e1ad4 |
675 | # parameterizable types ... |
676 | |
677 | $REGISTRY->add_type_constraint( |
678 | Moose::Meta::TypeConstraint::Parameterizable->new( |
180899ed |
679 | name => 'ArrayRef', |
680 | package_defined_in => __PACKAGE__, |
681 | parent => find_type_constraint('Ref'), |
682 | constraint => sub { ref($_) eq 'ARRAY' }, |
683 | optimized => |
684 | \&Moose::Util::TypeConstraints::OptimizedConstraints::ArrayRef, |
7e4e1ad4 |
685 | constraint_generator => sub { |
686 | my $type_parameter = shift; |
180899ed |
687 | my $check = $type_parameter->_compiled_type_constraint; |
7e4e1ad4 |
688 | return sub { |
689 | foreach my $x (@$_) { |
180899ed |
690 | ( $check->($x) ) || return; |
691 | } |
692 | 1; |
693 | } |
7e4e1ad4 |
694 | } |
695 | ) |
696 | ); |
697 | |
698 | $REGISTRY->add_type_constraint( |
699 | Moose::Meta::TypeConstraint::Parameterizable->new( |
180899ed |
700 | name => 'HashRef', |
701 | package_defined_in => __PACKAGE__, |
702 | parent => find_type_constraint('Ref'), |
703 | constraint => sub { ref($_) eq 'HASH' }, |
704 | optimized => |
705 | \&Moose::Util::TypeConstraints::OptimizedConstraints::HashRef, |
7e4e1ad4 |
706 | constraint_generator => sub { |
4ab662d6 |
707 | my $type_parameter = shift; |
180899ed |
708 | my $check = $type_parameter->_compiled_type_constraint; |
7e4e1ad4 |
709 | return sub { |
180899ed |
710 | foreach my $x ( values %$_ ) { |
711 | ( $check->($x) ) || return; |
712 | } |
713 | 1; |
714 | } |
7e4e1ad4 |
715 | } |
716 | ) |
717 | ); |
718 | |
719 | $REGISTRY->add_type_constraint( |
720 | Moose::Meta::TypeConstraint::Parameterizable->new( |
721 | name => 'Maybe', |
722 | package_defined_in => __PACKAGE__, |
723 | parent => find_type_constraint('Item'), |
180899ed |
724 | constraint => sub {1}, |
7e4e1ad4 |
725 | constraint_generator => sub { |
4ab662d6 |
726 | my $type_parameter = shift; |
180899ed |
727 | my $check = $type_parameter->_compiled_type_constraint; |
7e4e1ad4 |
728 | return sub { |
180899ed |
729 | return 1 if not( defined($_) ) || $check->($_); |
7e4e1ad4 |
730 | return; |
180899ed |
731 | } |
7e4e1ad4 |
732 | } |
733 | ) |
734 | ); |
735 | |
180899ed |
736 | my @PARAMETERIZABLE_TYPES |
737 | = map { $REGISTRY->get_type_constraint($_) } qw[ArrayRef HashRef Maybe]; |
738 | |
739 | sub get_all_parameterizable_types {@PARAMETERIZABLE_TYPES} |
7e4e1ad4 |
740 | |
4ab662d6 |
741 | sub add_parameterizable_type { |
7e4e1ad4 |
742 | my $type = shift; |
180899ed |
743 | ( blessed $type |
744 | && $type->isa('Moose::Meta::TypeConstraint::Parameterizable') ) |
745 | || __PACKAGE__->_throw_error( |
746 | "Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type" |
747 | ); |
7e4e1ad4 |
748 | push @PARAMETERIZABLE_TYPES => $type; |
4ab662d6 |
749 | } |
7e4e1ad4 |
750 | |
751 | ## -------------------------------------------------------- |
d9b40005 |
752 | # end of built-in types ... |
753 | ## -------------------------------------------------------- |
754 | |
943596a6 |
755 | { |
756 | my @BUILTINS = list_all_type_constraints(); |
180899ed |
757 | sub list_all_builtin_type_constraints {@BUILTINS} |
943596a6 |
758 | } |
759 | |
6ea98933 |
760 | sub _throw_error { |
6b83828f |
761 | shift; |
6ea98933 |
762 | require Moose; |
763 | unshift @_, 'Moose'; |
764 | goto &Moose::throw_error; |
765 | } |
766 | |
a15dff8d |
767 | 1; |
768 | |
769 | __END__ |
770 | |
771 | =pod |
772 | |
773 | =head1 NAME |
774 | |
e522431d |
775 | Moose::Util::TypeConstraints - Type constraint system for Moose |
a15dff8d |
776 | |
777 | =head1 SYNOPSIS |
778 | |
779 | use Moose::Util::TypeConstraints; |
780 | |
e85d2a5d |
781 | subtype 'Natural' |
e606ae5f |
782 | => as 'Int' |
a15dff8d |
783 | => where { $_ > 0 }; |
e85d2a5d |
784 | |
785 | subtype 'NaturalLessThanTen' |
2c0cbef7 |
786 | => as 'Natural' |
79592a54 |
787 | => where { $_ < 10 } |
788 | => message { "This number ($_) is not less than ten!" }; |
e85d2a5d |
789 | |
790 | coerce 'Num' |
2c0cbef7 |
791 | => from 'Str' |
e85d2a5d |
792 | => via { 0+$_ }; |
793 | |
2c0cbef7 |
794 | enum 'RGBColors' => qw(red green blue); |
a15dff8d |
795 | |
e7fcb7b2 |
796 | no Moose::Util::TypeConstraints; |
797 | |
a15dff8d |
798 | =head1 DESCRIPTION |
799 | |
e85d2a5d |
800 | This module provides Moose with the ability to create custom type |
6549b0d1 |
801 | constraints to be used in attribute definition. |
e522431d |
802 | |
6ba6d68c |
803 | =head2 Important Caveat |
804 | |
e85d2a5d |
805 | This is B<NOT> a type system for Perl 5. These are type constraints, |
806 | and they are not used by Moose unless you tell it to. No type |
e7fcb7b2 |
807 | inference is performed, expressions are not typed, etc. etc. etc. |
6ba6d68c |
808 | |
e7fcb7b2 |
809 | A type constraint is at heart a small "check if a value is valid" |
810 | function. A constraint can be associated with an attribute. This |
811 | simplifies parameter validation, and makes your code clearer to read, |
812 | because you can refer to constraints by name. |
6ba6d68c |
813 | |
2c0cbef7 |
814 | =head2 Slightly Less Important Caveat |
815 | |
e7fcb7b2 |
816 | It is B<always> a good idea to quote your type names. |
004222dc |
817 | |
e7fcb7b2 |
818 | This prevents Perl from trying to execute the call as an indirect |
819 | object call. This can be an issue when you have a subtype with the |
820 | same name as a valid class. |
2c0cbef7 |
821 | |
e7fcb7b2 |
822 | For instance: |
e85d2a5d |
823 | |
2c0cbef7 |
824 | subtype DateTime => as Object => where { $_->isa('DateTime') }; |
825 | |
e7fcb7b2 |
826 | will I<just work>, while this: |
2c0cbef7 |
827 | |
828 | use DateTime; |
829 | subtype DateTime => as Object => where { $_->isa('DateTime') }; |
830 | |
e85d2a5d |
831 | will fail silently and cause many headaches. The simple way to solve |
832 | this, as well as future proof your subtypes from classes which have |
e7fcb7b2 |
833 | yet to have been created, is to quote the type name: |
2c0cbef7 |
834 | |
835 | use DateTime; |
d44714be |
836 | subtype 'DateTime' => as 'Object' => where { $_->isa('DateTime') }; |
2c0cbef7 |
837 | |
6ba6d68c |
838 | =head2 Default Type Constraints |
e522431d |
839 | |
e606ae5f |
840 | This module also provides a simple hierarchy for Perl 5 types, here is |
004222dc |
841 | that hierarchy represented visually. |
e522431d |
842 | |
843 | Any |
e85d2a5d |
844 | Item |
5a4c5493 |
845 | Bool |
7e4e1ad4 |
846 | Maybe[`a] |
f65cb534 |
847 | Undef |
848 | Defined |
5a4c5493 |
849 | Value |
850 | Num |
851 | Int |
852 | Str |
9af1d28b |
853 | ClassName |
ed87d4fd |
854 | RoleName |
5a4c5493 |
855 | Ref |
856 | ScalarRef |
7e4e1ad4 |
857 | ArrayRef[`a] |
858 | HashRef[`a] |
5a4c5493 |
859 | CodeRef |
860 | RegexpRef |
3f7376b0 |
861 | GlobRef |
0a5bd159 |
862 | FileHandle |
e85d2a5d |
863 | Object |
2cbb5233 |
864 | Role |
e522431d |
865 | |
4ab662d6 |
866 | B<NOTE:> Any type followed by a type parameter C<[`a]> can be |
7e4e1ad4 |
867 | parameterized, this means you can say: |
868 | |
757e07ef |
869 | ArrayRef[Int] # an array of integers |
7e4e1ad4 |
870 | HashRef[CodeRef] # a hash of str to CODE ref mappings |
871 | Maybe[Str] # value may be a string, may be undefined |
872 | |
4e8a0f64 |
873 | If Moose finds a name in brackets that it does not recognize as an |
874 | existing type, it assumes that this is a class name, for example |
875 | C<ArrayRef[DateTime]>. |
876 | |
e7fcb7b2 |
877 | B<NOTE:> Unless you parameterize a type, then it is invalid to include |
878 | the square brackets. I.e. C<ArrayRef[]> will be treated as a new type |
879 | name, I<not> as a parameterization of C<ArrayRef>. |
e606ae5f |
880 | |
4ab662d6 |
881 | B<NOTE:> The C<Undef> type constraint for the most part works |
882 | correctly now, but edge cases may still exist, please use it |
6549b0d1 |
883 | sparingly. |
703e92fb |
884 | |
7e4e1ad4 |
885 | B<NOTE:> The C<ClassName> type constraint does a complex package |
e7fcb7b2 |
886 | existence check. This means that your class B<must> be loaded for this |
887 | type constraint to pass. |
9af1d28b |
888 | |
e7fcb7b2 |
889 | B<NOTE:> The C<RoleName> constraint checks a string is a I<package |
890 | name> which is a role, like C<'MyApp::Role::Comparable'>. The C<Role> |
891 | constraint checks that an I<object does> the named role. |
ed87d4fd |
892 | |
e606ae5f |
893 | =head2 Type Constraint Naming |
004222dc |
894 | |
eee1a213 |
895 | Type name declared via this module can only contain alphanumeric |
896 | characters, colons (:), and periods (.). |
897 | |
e606ae5f |
898 | Since the types created by this module are global, it is suggested |
899 | that you namespace your types just as you would namespace your |
e7fcb7b2 |
900 | modules. So instead of creating a I<Color> type for your |
901 | B<My::Graphics> module, you would call the type |
902 | I<My::Graphics::Types::Color> instead. |
004222dc |
903 | |
703e92fb |
904 | =head2 Use with Other Constraint Modules |
905 | |
e7fcb7b2 |
906 | This module can play nicely with other constraint modules with some |
907 | slight tweaking. The C<where> clause in types is expected to be a |
908 | C<CODE> reference which checks it's first argument and returns a |
909 | boolean. Since most constraint modules work in a similar way, it |
910 | should be simple to adapt them to work with Moose. |
703e92fb |
911 | |
e85d2a5d |
912 | For instance, this is how you could use it with |
913 | L<Declare::Constraints::Simple> to declare a completely new type. |
703e92fb |
914 | |
9e856c83 |
915 | type 'HashOfArrayOfObjects', |
916 | { |
917 | where => IsHashRef( |
703e92fb |
918 | -keys => HasLength, |
9e856c83 |
919 | -values => IsArrayRef(IsObject) |
920 | ) |
921 | }; |
703e92fb |
922 | |
e7fcb7b2 |
923 | For more examples see the F<t/200_examples/004_example_w_DCS.t> test |
924 | file. |
703e92fb |
925 | |
e85d2a5d |
926 | Here is an example of using L<Test::Deep> and it's non-test |
927 | related C<eq_deeply> function. |
703e92fb |
928 | |
e85d2a5d |
929 | type 'ArrayOfHashOfBarsAndRandomNumbers' |
703e92fb |
930 | => where { |
e85d2a5d |
931 | eq_deeply($_, |
703e92fb |
932 | array_each(subhashof({ |
933 | bar => isa('Bar'), |
934 | random_number => ignore() |
e85d2a5d |
935 | }))) |
703e92fb |
936 | }; |
937 | |
e606ae5f |
938 | For a complete example see the |
e7fcb7b2 |
939 | F<t/200_examples/005_example_w_TestDeep.t> test file. |
e85d2a5d |
940 | |
a15dff8d |
941 | =head1 FUNCTIONS |
942 | |
943 | =head2 Type Constraint Constructors |
944 | |
e7fcb7b2 |
945 | The following functions are used to create type constraints. They |
946 | will also register the type constraints your create in a global |
947 | registry that is used to look types up by name. |
a15dff8d |
948 | |
25f2c3fc |
949 | See the L<SYNOPSIS> for an example of how to use these. |
a15dff8d |
950 | |
6ba6d68c |
951 | =over 4 |
a15dff8d |
952 | |
fbe1e4a5 |
953 | =item B<< subtype 'Name' => as 'Parent' => where { } ... >> |
182134e8 |
954 | |
e85d2a5d |
955 | This creates a named subtype. |
d6e2d9a1 |
956 | |
dba9208a |
957 | If you provide a parent that Moose does not recognize, it will |
958 | automatically create a new class type constraint for this name. |
959 | |
9e856c83 |
960 | When creating a named type, the C<subtype> function should either be |
961 | called with the sugar helpers (C<where>, C<message>, etc), or with a |
962 | name and a hashref of parameters: |
963 | |
964 | subtype( 'Foo', { where => ..., message => ... } ); |
965 | |
966 | The valid hashref keys are C<as> (the parent), C<where>, C<message>, |
967 | and C<optimize_as>. |
9a63faba |
968 | |
fbe1e4a5 |
969 | =item B<< subtype as 'Parent' => where { } ... >> |
182134e8 |
970 | |
e85d2a5d |
971 | This creates an unnamed subtype and will return the type |
972 | constraint meta-object, which will be an instance of |
973 | L<Moose::Meta::TypeConstraint>. |
a15dff8d |
974 | |
9e856c83 |
975 | When creating an anonymous type, the C<subtype> function should either |
976 | be called with the sugar helpers (C<where>, C<message>, etc), or with |
977 | just a hashref of parameters: |
978 | |
979 | subtype( { where => ..., message => ... } ); |
980 | |
620db045 |
981 | =item B<class_type ($class, ?$options)> |
3fef8ce8 |
982 | |
ed87d4fd |
983 | Creates a new subtype of C<Object> with the name C<$class> and the |
984 | metaclass L<Moose::Meta::TypeConstraint::Class>. |
3fef8ce8 |
985 | |
620db045 |
986 | =item B<role_type ($role, ?$options)> |
987 | |
ed87d4fd |
988 | Creates a C<Role> type constraint with the name C<$role> and the |
989 | metaclass L<Moose::Meta::TypeConstraint::Role>. |
620db045 |
990 | |
1b2c9bda |
991 | =item B<maybe_type ($type)> |
992 | |
993 | Creates a type constraint for either C<undef> or something of the |
994 | given type. |
995 | |
e451e855 |
996 | =item B<duck_type ($name, @methods)> |
997 | |
88b68372 |
998 | This will create a subtype of Object and test to make sure the value |
999 | C<can()> do the methods in C<@methods>. |
1000 | |
1001 | This is intended as an easy way to accept non-Moose objects that |
1002 | provide a certain interface. If you're using Moose classes, we |
1003 | recommend that you use a C<requires>-only Role instead. |
e451e855 |
1004 | |
1005 | =item B<duck_type (\@methods)> |
1006 | |
88b68372 |
1007 | If passed an ARRAY reference instead of the C<$name>, C<@methods> |
1008 | pair, this will create an unnamed duck type. This can be used in an |
91aecfa0 |
1009 | attribute definition like so: |
e451e855 |
1010 | |
88b68372 |
1011 | has 'cache' => ( |
1012 | is => 'ro', |
1013 | isa => duck_type( [qw( get_set )] ), |
1014 | ); |
e451e855 |
1015 | |
fcec2383 |
1016 | =item B<enum ($name, @values)> |
1017 | |
e85d2a5d |
1018 | This will create a basic subtype for a given set of strings. |
1019 | The resulting constraint will be a subtype of C<Str> and |
4ce56d04 |
1020 | will match any of the items in C<@values>. It is case sensitive. |
1021 | See the L<SYNOPSIS> for a simple example. |
2c0cbef7 |
1022 | |
6549b0d1 |
1023 | B<NOTE:> This is not a true proper enum type, it is simply |
1024 | a convenient constraint builder. |
2c0cbef7 |
1025 | |
9f4334a1 |
1026 | =item B<enum (\@values)> |
1027 | |
4ab662d6 |
1028 | If passed an ARRAY reference instead of the C<$name>, C<@values> pair, |
9f4334a1 |
1029 | this will create an unnamed enum. This can then be used in an attribute |
1030 | definition like so: |
1031 | |
1032 | has 'sort_order' => ( |
1033 | is => 'ro', |
4ab662d6 |
1034 | isa => enum([qw[ ascending descending ]]), |
9f4334a1 |
1035 | ); |
1036 | |
e7fcb7b2 |
1037 | =item B<as 'Parent'> |
a15dff8d |
1038 | |
6ba6d68c |
1039 | This is just sugar for the type constraint construction syntax. |
a15dff8d |
1040 | |
e7fcb7b2 |
1041 | It takes a single argument, which is the name of a parent type. |
1042 | |
1043 | =item B<where { ... }> |
a15dff8d |
1044 | |
6ba6d68c |
1045 | This is just sugar for the type constraint construction syntax. |
76d37e5a |
1046 | |
e7fcb7b2 |
1047 | It takes a subroutine reference as an argument. When the type |
1048 | constraint is tested, the reference is run with the value to be tested |
1049 | in C<$_>. This reference should return true or false to indicate |
1050 | whether or not the constraint check passed. |
e606ae5f |
1051 | |
e7fcb7b2 |
1052 | =item B<message { ... }> |
76d37e5a |
1053 | |
1054 | This is just sugar for the type constraint construction syntax. |
a15dff8d |
1055 | |
e7fcb7b2 |
1056 | It takes a subroutine reference as an argument. When the type |
1057 | constraint fails, then the code block is run with the value provided |
1058 | in C<$_>. This reference should return a string, which will be used in |
1059 | the text of the exception thrown. |
e606ae5f |
1060 | |
e7fcb7b2 |
1061 | =item B<optimize_as { ... }> |
8ecb1fa0 |
1062 | |
e85d2a5d |
1063 | This can be used to define a "hand optimized" version of your |
d44714be |
1064 | type constraint which can be used to avoid traversing a subtype |
6549b0d1 |
1065 | constraint hierarchy. |
d44714be |
1066 | |
e85d2a5d |
1067 | B<NOTE:> You should only use this if you know what you are doing, |
1068 | all the built in types use this, so your subtypes (assuming they |
d44714be |
1069 | are shallow) will not likely need to use this. |
1070 | |
e7fcb7b2 |
1071 | =item B<type 'Name' => where { } ... > |
1072 | |
1073 | This creates a base type, which has no parent. |
1074 | |
1075 | The C<type> function should either be called with the sugar helpers |
1076 | (C<where>, C<message>, etc), or with a name and a hashref of |
1077 | parameters: |
1078 | |
1079 | type( 'Foo', { where => ..., message => ... } ); |
1080 | |
1081 | The valid hashref keys are C<where>, C<message>, and C<optimize_as>. |
1082 | |
6ba6d68c |
1083 | =back |
a15dff8d |
1084 | |
6ba6d68c |
1085 | =head2 Type Coercion Constructors |
a15dff8d |
1086 | |
e7fcb7b2 |
1087 | You can define coercions for type constraints, which allow you to |
1088 | automatically transform values to something valid for the type |
1089 | constraint. If you ask your accessor to coerce, then Moose will run |
1090 | the type-coercion code first, followed by the type constraint |
1091 | check. This feature should be used carefully as it is very powerful |
1092 | and could easily take off a limb if you are not careful. |
a15dff8d |
1093 | |
25f2c3fc |
1094 | See the L<SYNOPSIS> for an example of how to use these. |
a15dff8d |
1095 | |
6ba6d68c |
1096 | =over 4 |
a15dff8d |
1097 | |
e7fcb7b2 |
1098 | =item B<< coerce 'Name' => from 'OtherName' => via { ... } >> |
a15dff8d |
1099 | |
e7fcb7b2 |
1100 | This defines a coercion from one type to another. The C<Name> argument |
1101 | is the type you are coercing I<to>. |
1102 | |
1103 | =item B<from 'OtherName'> |
a15dff8d |
1104 | |
6ba6d68c |
1105 | This is just sugar for the type coercion construction syntax. |
1106 | |
e7fcb7b2 |
1107 | It takes a single type name (or type object), which is the type being |
1108 | coerced I<from>. |
1109 | |
1110 | =item B<via { ... }> |
a15dff8d |
1111 | |
6ba6d68c |
1112 | This is just sugar for the type coercion construction syntax. |
a15dff8d |
1113 | |
e7fcb7b2 |
1114 | It takes a subroutine reference. This reference will be called with |
1115 | the value to be coerced in C<$_>. It is expected to return a new value |
1116 | of the proper type for the coercion. |
1117 | |
a15dff8d |
1118 | =back |
1119 | |
e7fcb7b2 |
1120 | =head2 Creating and Finding Type Constraints |
1121 | |
1122 | These are additional functions for creating and finding type |
1123 | constraints. Most of these functions are not available for |
1124 | importing. The ones that are importable as specified. |
004222dc |
1125 | |
1126 | =over 4 |
1127 | |
e7fcb7b2 |
1128 | =item B<find_type_constraint($type_name)> |
eb4c4e82 |
1129 | |
e7fcb7b2 |
1130 | This function can be used to locate the L<Moose::Meta::TypeConstraint> |
1131 | object for a named type. |
eb4c4e82 |
1132 | |
e7fcb7b2 |
1133 | This function is importable. |
004222dc |
1134 | |
e7fcb7b2 |
1135 | =item B<register_type_constraint($type_object)> |
004222dc |
1136 | |
e7fcb7b2 |
1137 | This function will register a L<Moose::Meta::TypeConstraint> with the |
1138 | global type registry. |
004222dc |
1139 | |
e7fcb7b2 |
1140 | This function is importable. |
004222dc |
1141 | |
e7fcb7b2 |
1142 | =item B<normalize_type_constraint_name($type_constraint_name)> |
004222dc |
1143 | |
e7fcb7b2 |
1144 | This method takes a type constraint name and returns the normalized |
1145 | form. This removes any whitespace in the string. |
004222dc |
1146 | |
e7fcb7b2 |
1147 | =item B<create_type_constraint_union($pipe_separated_types | @type_constraint_names)> |
004222dc |
1148 | |
e7fcb7b2 |
1149 | This can take a union type specification like C<'Int|ArrayRef[Int]'>, |
1150 | or a list of names. It returns a new |
1151 | L<Moose::Meta::TypeConstraint::Union> object. |
004222dc |
1152 | |
e7fcb7b2 |
1153 | =item B<create_parameterized_type_constraint($type_name)> |
620db045 |
1154 | |
e7fcb7b2 |
1155 | Given a C<$type_name> in the form of C<'BaseType[ContainerType]'>, |
1156 | this will create a new L<Moose::Meta::TypeConstraint::Parameterized> |
1157 | object. The C<BaseType> must exist already exist as a parameterizable |
1158 | type. |
620db045 |
1159 | |
e7fcb7b2 |
1160 | =item B<create_class_type_constraint($class, $options)> |
dabed765 |
1161 | |
e7fcb7b2 |
1162 | Given a class name this function will create a new |
1163 | L<Moose::Meta::TypeConstraint::Class> object for that class name. |
004222dc |
1164 | |
e7fcb7b2 |
1165 | The C<$options> is a hash reference that will be passed to the |
1166 | L<Moose::Meta::TypeConstraint::Class> constructor (as a hash). |
620db045 |
1167 | |
e7fcb7b2 |
1168 | =item B<create_role_type_constraint($role, $options)> |
620db045 |
1169 | |
e7fcb7b2 |
1170 | Given a role name this function will create a new |
1171 | L<Moose::Meta::TypeConstraint::Role> object for that role name. |
620db045 |
1172 | |
e7fcb7b2 |
1173 | The C<$options> is a hash reference that will be passed to the |
1174 | L<Moose::Meta::TypeConstraint::Role> constructor (as a hash). |
620db045 |
1175 | |
8a6c8c47 |
1176 | =item B<create_enum_type_constraint($name, $values)> |
1177 | |
1178 | Given a enum name this function will create a new |
1179 | L<Moose::Meta::TypeConstraint::Enum> object for that enum name. |
1180 | |
0a6bff54 |
1181 | =item B<create_duck_type_constraint($name, $methods)> |
1182 | |
1183 | Given a duck type name this function will create a new |
1184 | L<Moose::Meta::TypeConstraint::DuckType> object for that enum name. |
1185 | |
e7fcb7b2 |
1186 | =item B<find_or_parse_type_constraint($type_name)> |
620db045 |
1187 | |
ec4b72d2 |
1188 | Given a type name, this first attempts to find a matching constraint |
e7fcb7b2 |
1189 | in the global registry. |
620db045 |
1190 | |
e7fcb7b2 |
1191 | If the type name is a union or parameterized type, it will create a |
1192 | new object of the appropriate, but if given a "regular" type that does |
1193 | not yet exist, it simply returns false. |
620db045 |
1194 | |
e7fcb7b2 |
1195 | When given a union or parameterized type, the member or base type must |
1196 | already exist. |
620db045 |
1197 | |
e7fcb7b2 |
1198 | If it creates a new union or parameterized type, it will add it to the |
1199 | global registry. |
004222dc |
1200 | |
e7fcb7b2 |
1201 | =item B<find_or_create_isa_type_constraint($type_name)> |
004222dc |
1202 | |
e7fcb7b2 |
1203 | =item B<find_or_create_does_type_constraint($type_name)> |
004222dc |
1204 | |
e7fcb7b2 |
1205 | These functions will first call C<find_or_parse_type_constraint>. If |
1206 | that function does not return a type, a new anonymous type object will |
1207 | be created. |
004222dc |
1208 | |
e7fcb7b2 |
1209 | The C<isa> variant will use C<create_class_type_constraint> and the |
1210 | C<does> variant will use C<create_role_type_constraint>. |
004222dc |
1211 | |
1212 | =item B<get_type_constraint_registry> |
1213 | |
e7fcb7b2 |
1214 | Returns the L<Moose::Meta::TypeConstraint::Registry> object which |
004222dc |
1215 | keeps track of all type constraints. |
1216 | |
1217 | =item B<list_all_type_constraints> |
1218 | |
e7fcb7b2 |
1219 | This will return a list of type constraint names in the global |
1220 | registry. You can then fetch the actual type object using |
1221 | C<find_type_constraint($type_name)>. |
004222dc |
1222 | |
1223 | =item B<list_all_builtin_type_constraints> |
1224 | |
e7fcb7b2 |
1225 | This will return a list of builtin type constraints, meaning those |
1226 | which are defined in this module. See the L<Default Type Constraints> |
1227 | section for a complete list. |
004222dc |
1228 | |
1229 | =item B<export_type_constraints_as_functions> |
1230 | |
e7fcb7b2 |
1231 | This will export all the current type constraints as functions into |
1232 | the caller's namespace (C<Int()>, C<Str()>, etc). Right now, this is |
1233 | mostly used for testing, but it might prove useful to others. |
004222dc |
1234 | |
1235 | =item B<get_all_parameterizable_types> |
1236 | |
e7fcb7b2 |
1237 | This returns all the parameterizable types that have been registered, |
1238 | as a list of type objects. |
004222dc |
1239 | |
e7fcb7b2 |
1240 | =item B<add_parameterizable_type($type)> |
004222dc |
1241 | |
1242 | Adds C<$type> to the list of parameterizable types |
1243 | |
1244 | =back |
1245 | |
a15dff8d |
1246 | =head1 BUGS |
1247 | |
e85d2a5d |
1248 | All complex software has bugs lurking in it, and this module is no |
a15dff8d |
1249 | exception. If you find a bug please either email me, or add the bug |
1250 | to cpan-RT. |
1251 | |
a15dff8d |
1252 | =head1 AUTHOR |
1253 | |
1254 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
1255 | |
1256 | =head1 COPYRIGHT AND LICENSE |
1257 | |
2840a3b2 |
1258 | Copyright 2006-2009 by Infinity Interactive, Inc. |
a15dff8d |
1259 | |
1260 | L<http://www.iinteractive.com> |
1261 | |
1262 | This library is free software; you can redistribute it and/or modify |
e85d2a5d |
1263 | it under the same terms as Perl itself. |
a15dff8d |
1264 | |
81dc201f |
1265 | =cut |