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