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 | |
1aab4011 |
12 | our $VERSION = '0.64'; |
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) |
c245d69b |
88 | || Moose->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($_) || |
fa92d705 |
92 | Moose->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) |
c245d69b |
105 | || Moose->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 { |
114 | Moose->throw_error("Could not locate the base type ($base_type)"); |
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) |
c245d69b |
137 | # || Moose->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) |
c245d69b |
155 | # || Moose->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; |
c245d69b |
255 | Moose->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 | |
308 | Moose::Meta::TypeConstraint->new( |
309 | parent => find_type_constraint('Item'), |
310 | constraint => sub { |
311 | my $check = $type_parameter->_compiled_type_constraint; |
312 | return 1 if not(defined($_)) || $check->($_); |
313 | return; |
314 | } |
315 | ) |
316 | } |
317 | |
9c27968f |
318 | sub coerce { |
e85d2a5d |
319 | my ($type_name, @coercion_map) = @_; |
7c13858b |
320 | _install_type_coercions($type_name, \@coercion_map); |
182134e8 |
321 | } |
322 | |
9c27968f |
323 | sub as { @_ } |
324 | sub from { @_ } |
76d37e5a |
325 | sub where (&) { $_[0] } |
326 | sub via (&) { $_[0] } |
8ecb1fa0 |
327 | |
328 | sub message (&) { +{ message => $_[0] } } |
329 | sub optimize_as (&) { +{ optimized => $_[0] } } |
a15dff8d |
330 | |
9c27968f |
331 | sub enum { |
fcec2383 |
332 | my ($type_name, @values) = @_; |
4ab662d6 |
333 | # NOTE: |
334 | # if only an array-ref is passed then |
9f4334a1 |
335 | # you get an anon-enum |
336 | # - SL |
337 | if (ref $type_name eq 'ARRAY' && !@values) { |
338 | @values = @$type_name; |
339 | $type_name = undef; |
340 | } |
2c0cbef7 |
341 | (scalar @values >= 2) |
c245d69b |
342 | || Moose->throw_error("You must have at least two values to enumerate through"); |
c4fe165f |
343 | my %valid = map { $_ => 1 } @values; |
dabed765 |
344 | |
345 | register_type_constraint( |
346 | create_enum_type_constraint( |
347 | $type_name, |
348 | \@values, |
349 | ) |
350 | ); |
351 | } |
352 | |
0c015f1b |
353 | sub create_enum_type_constraint { |
dabed765 |
354 | my ( $type_name, $values ) = @_; |
e606ae5f |
355 | |
dabed765 |
356 | Moose::Meta::TypeConstraint::Enum->new( |
357 | name => $type_name || '__ANON__', |
358 | values => $values, |
a0f8153d |
359 | ); |
fcec2383 |
360 | } |
361 | |
d9b40005 |
362 | ## -------------------------------------------------------- |
363 | ## desugaring functions ... |
364 | ## -------------------------------------------------------- |
365 | |
e85d2a5d |
366 | sub _create_type_constraint ($$$;$$) { |
d9b40005 |
367 | my $name = shift; |
368 | my $parent = shift; |
8de73ff1 |
369 | my $check = shift; |
e85d2a5d |
370 | |
1da6728b |
371 | my ( $message, $optimized ); |
d9b40005 |
372 | for (@_) { |
373 | $message = $_->{message} if exists $_->{message}; |
e85d2a5d |
374 | $optimized = $_->{optimized} if exists $_->{optimized}; |
d9b40005 |
375 | } |
376 | |
1da6728b |
377 | my $pkg_defined_in = scalar( caller(0) ); |
e85d2a5d |
378 | |
1da6728b |
379 | if ( defined $name ) { |
d9b40005 |
380 | my $type = $REGISTRY->get_type_constraint($name); |
e85d2a5d |
381 | |
5f223879 |
382 | ( $type->_package_defined_in eq $pkg_defined_in ) |
383 | || _confess( |
384 | "The type constraint '$name' has already been created in " |
385 | . $type->_package_defined_in |
386 | . " and cannot be created again in " |
387 | . $pkg_defined_in ) |
388 | if defined $type; |
e85d2a5d |
389 | } |
1da6728b |
390 | |
9ceb576e |
391 | my %opts = ( |
ec8b7b21 |
392 | name => $name, |
d9b40005 |
393 | package_defined_in => $pkg_defined_in, |
e85d2a5d |
394 | |
1da6728b |
395 | ( $check ? ( constraint => $check ) : () ), |
396 | ( $message ? ( message => $message ) : () ), |
397 | ( $optimized ? ( optimized => $optimized ) : () ), |
d9b40005 |
398 | ); |
1da6728b |
399 | |
9ceb576e |
400 | my $constraint; |
1da6728b |
401 | if ( defined $parent |
402 | and $parent |
403 | = blessed $parent ? $parent : find_or_parse_type_constraint($parent) ) |
404 | { |
85a9908f |
405 | $constraint = $parent->create_child_type(%opts); |
1da6728b |
406 | } |
407 | else { |
408 | $constraint = Moose::Meta::TypeConstraint->new(%opts); |
4ab662d6 |
409 | } |
d9b40005 |
410 | |
411 | $REGISTRY->add_type_constraint($constraint) |
412 | if defined $name; |
413 | |
414 | return $constraint; |
415 | } |
416 | |
e85d2a5d |
417 | sub _install_type_coercions ($$) { |
d9b40005 |
418 | my ($type_name, $coercion_map) = @_; |
e606ae5f |
419 | my $type = find_type_constraint($type_name); |
6f9ff1af |
420 | (defined $type) |
c245d69b |
421 | || Moose->throw_error("Cannot find type '$type_name', perhaps you forgot to load it."); |
41e007e4 |
422 | if ($type->has_coercion) { |
423 | $type->coercion->add_type_coercions(@$coercion_map); |
424 | } |
425 | else { |
426 | my $type_coercion = Moose::Meta::TypeCoercion->new( |
427 | type_coercion_map => $coercion_map, |
428 | type_constraint => $type |
429 | ); |
430 | $type->coercion($type_coercion); |
431 | } |
d9b40005 |
432 | } |
433 | |
434 | ## -------------------------------------------------------- |
f1917f58 |
435 | ## type notation parsing ... |
436 | ## -------------------------------------------------------- |
437 | |
438 | { |
e85d2a5d |
439 | # All I have to say is mugwump++ cause I know |
440 | # do not even have enough regexp-fu to be able |
441 | # to have written this (I can only barely |
f1917f58 |
442 | # understand it as it is) |
e85d2a5d |
443 | # - SL |
444 | |
f1917f58 |
445 | use re "eval"; |
446 | |
3796382a |
447 | my $valid_chars = qr{[\w:]}; |
f1917f58 |
448 | my $type_atom = qr{ $valid_chars+ }; |
449 | |
be722745 |
450 | my $any; |
451 | |
369a74ee |
452 | my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x; |
08380fdb |
453 | my $type_capture_parts = qr{ ($valid_chars+) (?: \[ \s* ((??{$any})) \s* \] )? }x; |
369a74ee |
454 | my $type_with_parameter = qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x; |
f1917f58 |
455 | |
3796382a |
456 | my $op_union = qr{ \s* \| \s* }x; |
f1917f58 |
457 | my $union = qr{ $type (?: $op_union $type )+ }x; |
458 | |
84a9c64c |
459 | $any = qr{ $type | $union }x; |
f1917f58 |
460 | |
0fbd4b0a |
461 | sub _parse_parameterized_type_constraint { |
be722745 |
462 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
84a9c64c |
463 | $_[0] =~ m{ $type_capture_parts }x; |
464 | return ($1, $2); |
f1917f58 |
465 | } |
466 | |
0fbd4b0a |
467 | sub _detect_parameterized_type_constraint { |
be722745 |
468 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
e85d2a5d |
469 | $_[0] =~ m{ ^ $type_with_parameter $ }x; |
f1917f58 |
470 | } |
471 | |
472 | sub _parse_type_constraint_union { |
be722745 |
473 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
e85d2a5d |
474 | my $given = shift; |
475 | my @rv; |
476 | while ( $given =~ m{ \G (?: $op_union )? ($type) }gcx ) { |
82a5b1a7 |
477 | push @rv => $1; |
e85d2a5d |
478 | } |
479 | (pos($given) eq length($given)) |
c245d69b |
480 | || Moose->throw_error("'$given' didn't parse (parse-pos=" |
e85d2a5d |
481 | . pos($given) |
482 | . " and str-length=" |
483 | . length($given) |
4c0b3599 |
484 | . ")"); |
e85d2a5d |
485 | @rv; |
f1917f58 |
486 | } |
487 | |
488 | sub _detect_type_constraint_union { |
be722745 |
489 | { no warnings 'void'; $any; } # force capture of interpolated lexical |
e85d2a5d |
490 | $_[0] =~ m{^ $type $op_union $type ( $op_union .* )? $}x; |
f1917f58 |
491 | } |
492 | } |
493 | |
494 | ## -------------------------------------------------------- |
d9b40005 |
495 | # define some basic built-in types |
496 | ## -------------------------------------------------------- |
a15dff8d |
497 | |
3cae4250 |
498 | # By making these classes immutable before creating all the types we |
499 | # below, we avoid repeatedly calling the slow MOP-based accessors. |
500 | $_->make_immutable( |
501 | inline_constructor => 1, |
502 | constructor_name => "_new", |
503 | |
504 | # these are Class::MOP accessors, so they need inlining |
505 | inline_accessors => 1 |
506 | ) for grep { $_->is_mutable } |
507 | map { $_->meta } |
508 | qw( |
509 | Moose::Meta::TypeConstraint |
510 | Moose::Meta::TypeConstraint::Union |
511 | Moose::Meta::TypeConstraint::Parameterized |
512 | Moose::Meta::TypeConstraint::Parameterizable |
513 | Moose::Meta::TypeConstraint::Class |
514 | Moose::Meta::TypeConstraint::Role |
515 | Moose::Meta::TypeConstraint::Enum |
516 | Moose::Meta::TypeConstraint::Registry |
517 | ); |
518 | |
f65cb534 |
519 | type 'Any' => where { 1 }; # meta-type including all |
e85d2a5d |
520 | type 'Item' => where { 1 }; # base-type |
a15dff8d |
521 | |
fd542f49 |
522 | subtype 'Undef' => as 'Item' => where { !defined($_) }; |
523 | subtype 'Defined' => as 'Item' => where { defined($_) }; |
a15dff8d |
524 | |
8ecb1fa0 |
525 | subtype 'Bool' |
e85d2a5d |
526 | => as 'Item' |
8ecb1fa0 |
527 | => where { !defined($_) || $_ eq "" || "$_" eq '1' || "$_" eq '0' }; |
5a4c5493 |
528 | |
e85d2a5d |
529 | subtype 'Value' |
530 | => as 'Defined' |
531 | => where { !ref($_) } |
28ffb449 |
532 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Value; |
e85d2a5d |
533 | |
8ecb1fa0 |
534 | subtype 'Ref' |
e85d2a5d |
535 | => as 'Defined' |
536 | => where { ref($_) } |
28ffb449 |
537 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Ref; |
8ecb1fa0 |
538 | |
e85d2a5d |
539 | subtype 'Str' |
540 | => as 'Value' |
541 | => where { 1 } |
28ffb449 |
542 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Str; |
8ecb1fa0 |
543 | |
e85d2a5d |
544 | subtype 'Num' |
545 | => as 'Value' |
546 | => where { Scalar::Util::looks_like_number($_) } |
28ffb449 |
547 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Num; |
e85d2a5d |
548 | |
549 | subtype 'Int' |
550 | => as 'Num' |
8ecb1fa0 |
551 | => where { "$_" =~ /^-?[0-9]+$/ } |
28ffb449 |
552 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Int; |
8ecb1fa0 |
553 | |
28ffb449 |
554 | subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::ScalarRef; |
28ffb449 |
555 | subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::CodeRef; |
556 | subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::RegexpRef; |
557 | subtype 'GlobRef' => as 'Ref' => where { ref($_) eq 'GLOB' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::GlobRef; |
a15dff8d |
558 | |
0a5bd159 |
559 | # NOTE: |
e85d2a5d |
560 | # scalar filehandles are GLOB refs, |
0a5bd159 |
561 | # but a GLOB ref is not always a filehandle |
e85d2a5d |
562 | subtype 'FileHandle' |
563 | => as 'GlobRef' |
128c601e |
564 | => where { Scalar::Util::openhandle($_) || ( blessed($_) && $_->isa("IO::Handle") ) } |
28ffb449 |
565 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::FileHandle; |
0a5bd159 |
566 | |
e85d2a5d |
567 | # NOTE: |
a15dff8d |
568 | # blessed(qr/.../) returns true,.. how odd |
e85d2a5d |
569 | subtype 'Object' |
570 | => as 'Ref' |
8ecb1fa0 |
571 | => where { blessed($_) && blessed($_) ne 'Regexp' } |
28ffb449 |
572 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Object; |
a15dff8d |
573 | |
e85d2a5d |
574 | subtype 'Role' |
575 | => as 'Object' |
8ecb1fa0 |
576 | => where { $_->can('does') } |
28ffb449 |
577 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Role; |
e85d2a5d |
578 | |
0e0709ea |
579 | my $_class_name_checker = sub { |
0e0709ea |
580 | }; |
581 | |
e85d2a5d |
582 | subtype 'ClassName' |
583 | => as 'Str' |
e151db23 |
584 | => where { Class::MOP::is_class_loaded($_) } |
585 | => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::ClassName; |
02a0fb52 |
586 | |
d9b40005 |
587 | ## -------------------------------------------------------- |
7e4e1ad4 |
588 | # parameterizable types ... |
589 | |
590 | $REGISTRY->add_type_constraint( |
591 | Moose::Meta::TypeConstraint::Parameterizable->new( |
592 | name => 'ArrayRef', |
593 | package_defined_in => __PACKAGE__, |
594 | parent => find_type_constraint('Ref'), |
595 | constraint => sub { ref($_) eq 'ARRAY' }, |
596 | optimized => \&Moose::Util::TypeConstraints::OptimizedConstraints::ArrayRef, |
597 | constraint_generator => sub { |
598 | my $type_parameter = shift; |
dabed765 |
599 | my $check = $type_parameter->_compiled_type_constraint; |
7e4e1ad4 |
600 | return sub { |
601 | foreach my $x (@$_) { |
dabed765 |
602 | ($check->($x)) || return |
7e4e1ad4 |
603 | } 1; |
604 | } |
605 | } |
606 | ) |
607 | ); |
608 | |
609 | $REGISTRY->add_type_constraint( |
610 | Moose::Meta::TypeConstraint::Parameterizable->new( |
611 | name => 'HashRef', |
612 | package_defined_in => __PACKAGE__, |
613 | parent => find_type_constraint('Ref'), |
614 | constraint => sub { ref($_) eq 'HASH' }, |
615 | optimized => \&Moose::Util::TypeConstraints::OptimizedConstraints::HashRef, |
616 | constraint_generator => sub { |
4ab662d6 |
617 | my $type_parameter = shift; |
dabed765 |
618 | my $check = $type_parameter->_compiled_type_constraint; |
7e4e1ad4 |
619 | return sub { |
620 | foreach my $x (values %$_) { |
dabed765 |
621 | ($check->($x)) || return |
7e4e1ad4 |
622 | } 1; |
623 | } |
624 | } |
625 | ) |
626 | ); |
627 | |
628 | $REGISTRY->add_type_constraint( |
629 | Moose::Meta::TypeConstraint::Parameterizable->new( |
630 | name => 'Maybe', |
631 | package_defined_in => __PACKAGE__, |
632 | parent => find_type_constraint('Item'), |
633 | constraint => sub { 1 }, |
634 | constraint_generator => sub { |
4ab662d6 |
635 | my $type_parameter = shift; |
dabed765 |
636 | my $check = $type_parameter->_compiled_type_constraint; |
7e4e1ad4 |
637 | return sub { |
dabed765 |
638 | return 1 if not(defined($_)) || $check->($_); |
7e4e1ad4 |
639 | return; |
640 | } |
641 | } |
642 | ) |
643 | ); |
644 | |
4ab662d6 |
645 | my @PARAMETERIZABLE_TYPES = map { |
646 | $REGISTRY->get_type_constraint($_) |
7e4e1ad4 |
647 | } qw[ArrayRef HashRef Maybe]; |
648 | |
649 | sub get_all_parameterizable_types { @PARAMETERIZABLE_TYPES } |
4ab662d6 |
650 | sub add_parameterizable_type { |
7e4e1ad4 |
651 | my $type = shift; |
652 | (blessed $type && $type->isa('Moose::Meta::TypeConstraint::Parameterizable')) |
c245d69b |
653 | || Moose->throw_error("Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type"); |
7e4e1ad4 |
654 | push @PARAMETERIZABLE_TYPES => $type; |
4ab662d6 |
655 | } |
7e4e1ad4 |
656 | |
657 | ## -------------------------------------------------------- |
d9b40005 |
658 | # end of built-in types ... |
659 | ## -------------------------------------------------------- |
660 | |
943596a6 |
661 | { |
662 | my @BUILTINS = list_all_type_constraints(); |
663 | sub list_all_builtin_type_constraints { @BUILTINS } |
664 | } |
665 | |
a15dff8d |
666 | 1; |
667 | |
668 | __END__ |
669 | |
670 | =pod |
671 | |
672 | =head1 NAME |
673 | |
e522431d |
674 | Moose::Util::TypeConstraints - Type constraint system for Moose |
a15dff8d |
675 | |
676 | =head1 SYNOPSIS |
677 | |
678 | use Moose::Util::TypeConstraints; |
679 | |
2c0cbef7 |
680 | type 'Num' => where { Scalar::Util::looks_like_number($_) }; |
e85d2a5d |
681 | |
682 | subtype 'Natural' |
e606ae5f |
683 | => as 'Int' |
a15dff8d |
684 | => where { $_ > 0 }; |
e85d2a5d |
685 | |
686 | subtype 'NaturalLessThanTen' |
2c0cbef7 |
687 | => as 'Natural' |
79592a54 |
688 | => where { $_ < 10 } |
689 | => message { "This number ($_) is not less than ten!" }; |
e85d2a5d |
690 | |
691 | coerce 'Num' |
2c0cbef7 |
692 | => from 'Str' |
e85d2a5d |
693 | => via { 0+$_ }; |
694 | |
2c0cbef7 |
695 | enum 'RGBColors' => qw(red green blue); |
a15dff8d |
696 | |
697 | =head1 DESCRIPTION |
698 | |
e85d2a5d |
699 | This module provides Moose with the ability to create custom type |
700 | contraints to be used in attribute definition. |
e522431d |
701 | |
6ba6d68c |
702 | =head2 Important Caveat |
703 | |
e85d2a5d |
704 | This is B<NOT> a type system for Perl 5. These are type constraints, |
705 | and they are not used by Moose unless you tell it to. No type |
706 | inference is performed, expression are not typed, etc. etc. etc. |
6ba6d68c |
707 | |
e85d2a5d |
708 | This is simply a means of creating small constraint functions which |
e606ae5f |
709 | can be used to simplify your own type-checking code, with the added |
004222dc |
710 | side benefit of making your intentions clearer through self-documentation. |
6ba6d68c |
711 | |
2c0cbef7 |
712 | =head2 Slightly Less Important Caveat |
713 | |
004222dc |
714 | It is B<always> a good idea to quote your type and subtype names. |
715 | |
e85d2a5d |
716 | This is to prevent perl from trying to execute the call as an indirect |
2c0cbef7 |
717 | object call. This issue only seems to come up when you have a subtype |
e85d2a5d |
718 | the same name as a valid class, but when the issue does arise it tends |
719 | to be quite annoying to debug. |
2c0cbef7 |
720 | |
721 | So for instance, this: |
e85d2a5d |
722 | |
2c0cbef7 |
723 | subtype DateTime => as Object => where { $_->isa('DateTime') }; |
724 | |
725 | will I<Just Work>, while this: |
726 | |
727 | use DateTime; |
728 | subtype DateTime => as Object => where { $_->isa('DateTime') }; |
729 | |
e85d2a5d |
730 | will fail silently and cause many headaches. The simple way to solve |
731 | this, as well as future proof your subtypes from classes which have |
2c0cbef7 |
732 | yet to have been created yet, is to simply do this: |
733 | |
734 | use DateTime; |
d44714be |
735 | subtype 'DateTime' => as 'Object' => where { $_->isa('DateTime') }; |
2c0cbef7 |
736 | |
6ba6d68c |
737 | =head2 Default Type Constraints |
e522431d |
738 | |
e606ae5f |
739 | This module also provides a simple hierarchy for Perl 5 types, here is |
004222dc |
740 | that hierarchy represented visually. |
e522431d |
741 | |
742 | Any |
e85d2a5d |
743 | Item |
5a4c5493 |
744 | Bool |
7e4e1ad4 |
745 | Maybe[`a] |
f65cb534 |
746 | Undef |
747 | Defined |
5a4c5493 |
748 | Value |
749 | Num |
750 | Int |
751 | Str |
9af1d28b |
752 | ClassName |
5a4c5493 |
753 | Ref |
754 | ScalarRef |
7e4e1ad4 |
755 | ArrayRef[`a] |
756 | HashRef[`a] |
5a4c5493 |
757 | CodeRef |
758 | RegexpRef |
3f7376b0 |
759 | GlobRef |
0a5bd159 |
760 | FileHandle |
e85d2a5d |
761 | Object |
5a4c5493 |
762 | Role |
e522431d |
763 | |
4ab662d6 |
764 | B<NOTE:> Any type followed by a type parameter C<[`a]> can be |
7e4e1ad4 |
765 | parameterized, this means you can say: |
766 | |
757e07ef |
767 | ArrayRef[Int] # an array of integers |
7e4e1ad4 |
768 | HashRef[CodeRef] # a hash of str to CODE ref mappings |
769 | Maybe[Str] # value may be a string, may be undefined |
770 | |
e606ae5f |
771 | B<NOTE:> Unless you parameterize a type, then it is invalid to |
772 | include the square brackets. I.e. C<ArrayRef[]> will be |
773 | literally interpreted as a type name. |
774 | |
4ab662d6 |
775 | B<NOTE:> The C<Undef> type constraint for the most part works |
776 | correctly now, but edge cases may still exist, please use it |
7e4e1ad4 |
777 | sparringly. |
703e92fb |
778 | |
7e4e1ad4 |
779 | B<NOTE:> The C<ClassName> type constraint does a complex package |
4ab662d6 |
780 | existence check. This means that your class B<must> be loaded for |
781 | this type constraint to pass. I know this is not ideal for all, |
7e4e1ad4 |
782 | but it is a saner restriction than most others. |
9af1d28b |
783 | |
e606ae5f |
784 | =head2 Type Constraint Naming |
004222dc |
785 | |
e606ae5f |
786 | Since the types created by this module are global, it is suggested |
787 | that you namespace your types just as you would namespace your |
004222dc |
788 | modules. So instead of creating a I<Color> type for your B<My::Graphics> |
789 | module, you would call the type I<My::Graphics::Color> instead. |
790 | |
703e92fb |
791 | =head2 Use with Other Constraint Modules |
792 | |
e85d2a5d |
793 | This module should play fairly nicely with other constraint |
794 | modules with only some slight tweaking. The C<where> clause |
703e92fb |
795 | in types is expected to be a C<CODE> reference which checks |
004222dc |
796 | it's first argument and returns a boolean. Since most constraint |
e85d2a5d |
797 | modules work in a similar way, it should be simple to adapt |
703e92fb |
798 | them to work with Moose. |
799 | |
e85d2a5d |
800 | For instance, this is how you could use it with |
801 | L<Declare::Constraints::Simple> to declare a completely new type. |
703e92fb |
802 | |
e85d2a5d |
803 | type 'HashOfArrayOfObjects' |
703e92fb |
804 | => IsHashRef( |
805 | -keys => HasLength, |
806 | -values => IsArrayRef( IsObject )); |
807 | |
e606ae5f |
808 | For more examples see the F<t/200_examples/204_example_w_DCS.t> |
004222dc |
809 | test file. |
703e92fb |
810 | |
e85d2a5d |
811 | Here is an example of using L<Test::Deep> and it's non-test |
812 | related C<eq_deeply> function. |
703e92fb |
813 | |
e85d2a5d |
814 | type 'ArrayOfHashOfBarsAndRandomNumbers' |
703e92fb |
815 | => where { |
e85d2a5d |
816 | eq_deeply($_, |
703e92fb |
817 | array_each(subhashof({ |
818 | bar => isa('Bar'), |
819 | random_number => ignore() |
e85d2a5d |
820 | }))) |
703e92fb |
821 | }; |
822 | |
e606ae5f |
823 | For a complete example see the |
004222dc |
824 | F<t/200_examples/205_example_w_TestDeep.t> test file. |
e85d2a5d |
825 | |
a15dff8d |
826 | =head1 FUNCTIONS |
827 | |
828 | =head2 Type Constraint Constructors |
829 | |
e85d2a5d |
830 | The following functions are used to create type constraints. |
831 | They will then register the type constraints in a global store |
832 | where Moose can get to them if it needs to. |
a15dff8d |
833 | |
25f2c3fc |
834 | See the L<SYNOPSIS> for an example of how to use these. |
a15dff8d |
835 | |
6ba6d68c |
836 | =over 4 |
a15dff8d |
837 | |
6ba6d68c |
838 | =item B<type ($name, $where_clause)> |
a15dff8d |
839 | |
e85d2a5d |
840 | This creates a base type, which has no parent. |
a15dff8d |
841 | |
79592a54 |
842 | =item B<subtype ($name, $parent, $where_clause, ?$message)> |
182134e8 |
843 | |
e85d2a5d |
844 | This creates a named subtype. |
d6e2d9a1 |
845 | |
79592a54 |
846 | =item B<subtype ($parent, $where_clause, ?$message)> |
182134e8 |
847 | |
e85d2a5d |
848 | This creates an unnamed subtype and will return the type |
849 | constraint meta-object, which will be an instance of |
850 | L<Moose::Meta::TypeConstraint>. |
a15dff8d |
851 | |
620db045 |
852 | =item B<class_type ($class, ?$options)> |
3fef8ce8 |
853 | |
854 | Creates a type constraint with the name C<$class> and the metaclass |
855 | L<Moose::Meta::TypeConstraint::Class>. |
856 | |
620db045 |
857 | =item B<role_type ($role, ?$options)> |
858 | |
859 | Creates a type constraint with the name C<$role> and the metaclass |
860 | L<Moose::Meta::TypeConstraint::Role>. |
861 | |
1b2c9bda |
862 | =item B<maybe_type ($type)> |
863 | |
864 | Creates a type constraint for either C<undef> or something of the |
865 | given type. |
866 | |
fcec2383 |
867 | =item B<enum ($name, @values)> |
868 | |
e85d2a5d |
869 | This will create a basic subtype for a given set of strings. |
870 | The resulting constraint will be a subtype of C<Str> and |
4ce56d04 |
871 | will match any of the items in C<@values>. It is case sensitive. |
872 | See the L<SYNOPSIS> for a simple example. |
2c0cbef7 |
873 | |
e85d2a5d |
874 | B<NOTE:> This is not a true proper enum type, it is simple |
2c0cbef7 |
875 | a convient constraint builder. |
876 | |
9f4334a1 |
877 | =item B<enum (\@values)> |
878 | |
4ab662d6 |
879 | If passed an ARRAY reference instead of the C<$name>, C<@values> pair, |
9f4334a1 |
880 | this will create an unnamed enum. This can then be used in an attribute |
881 | definition like so: |
882 | |
883 | has 'sort_order' => ( |
884 | is => 'ro', |
4ab662d6 |
885 | isa => enum([qw[ ascending descending ]]), |
9f4334a1 |
886 | ); |
887 | |
6ba6d68c |
888 | =item B<as> |
a15dff8d |
889 | |
6ba6d68c |
890 | This is just sugar for the type constraint construction syntax. |
a15dff8d |
891 | |
6ba6d68c |
892 | =item B<where> |
a15dff8d |
893 | |
6ba6d68c |
894 | This is just sugar for the type constraint construction syntax. |
76d37e5a |
895 | |
e606ae5f |
896 | Takes a block/code ref as an argument. When the type constraint is |
897 | tested, the supplied code is run with the value to be tested in |
898 | $_. This block should return true or false to indicate whether or not |
899 | the constraint check passed. |
900 | |
76d37e5a |
901 | =item B<message> |
902 | |
903 | This is just sugar for the type constraint construction syntax. |
a15dff8d |
904 | |
e606ae5f |
905 | Takes a block/code ref as an argument. When the type constraint fails, |
906 | then the code block is run (with the value provided in $_). This code |
907 | ref should return a string, which will be used in the text of the |
908 | exception thrown. |
909 | |
8ecb1fa0 |
910 | =item B<optimize_as> |
911 | |
e85d2a5d |
912 | This can be used to define a "hand optimized" version of your |
d44714be |
913 | type constraint which can be used to avoid traversing a subtype |
e85d2a5d |
914 | constraint heirarchy. |
d44714be |
915 | |
e85d2a5d |
916 | B<NOTE:> You should only use this if you know what you are doing, |
917 | all the built in types use this, so your subtypes (assuming they |
d44714be |
918 | are shallow) will not likely need to use this. |
919 | |
6ba6d68c |
920 | =back |
a15dff8d |
921 | |
6ba6d68c |
922 | =head2 Type Coercion Constructors |
a15dff8d |
923 | |
e85d2a5d |
924 | Type constraints can also contain type coercions as well. If you |
925 | ask your accessor to coerce, then Moose will run the type-coercion |
926 | code first, followed by the type constraint check. This feature |
927 | should be used carefully as it is very powerful and could easily |
587ae0d2 |
928 | take off a limb if you are not careful. |
a15dff8d |
929 | |
25f2c3fc |
930 | See the L<SYNOPSIS> for an example of how to use these. |
a15dff8d |
931 | |
6ba6d68c |
932 | =over 4 |
a15dff8d |
933 | |
6ba6d68c |
934 | =item B<coerce> |
a15dff8d |
935 | |
6ba6d68c |
936 | =item B<from> |
a15dff8d |
937 | |
6ba6d68c |
938 | This is just sugar for the type coercion construction syntax. |
939 | |
940 | =item B<via> |
a15dff8d |
941 | |
6ba6d68c |
942 | This is just sugar for the type coercion construction syntax. |
a15dff8d |
943 | |
944 | =back |
945 | |
004222dc |
946 | =head2 Type Constraint Construction & Locating |
947 | |
948 | =over 4 |
949 | |
eb4c4e82 |
950 | =item B<normalize_type_constraint_name ($type_constraint_name)> |
951 | |
952 | Given a string that is expected to match a type constraint, will normalize the |
953 | string so that extra whitespace and newlines are removed. |
954 | |
004222dc |
955 | =item B<create_type_constraint_union ($pipe_seperated_types | @type_constraint_names)> |
956 | |
957 | Given string with C<$pipe_seperated_types> or a list of C<@type_constraint_names>, |
958 | this will return a L<Moose::Meta::TypeConstraint::Union> instance. |
959 | |
960 | =item B<create_parameterized_type_constraint ($type_name)> |
961 | |
962 | Given a C<$type_name> in the form of: |
963 | |
964 | BaseType[ContainerType] |
965 | |
966 | this will extract the base type and container type and build an instance of |
967 | L<Moose::Meta::TypeConstraint::Parameterized> for it. |
968 | |
620db045 |
969 | =item B<create_class_type_constraint ($class, ?$options)> |
004222dc |
970 | |
971 | Given a class name it will create a new L<Moose::Meta::TypeConstraint::Class> |
972 | object for that class name. |
973 | |
620db045 |
974 | =item B<create_role_type_constraint ($role, ?$options)> |
975 | |
976 | Given a role name it will create a new L<Moose::Meta::TypeConstraint::Role> |
977 | object for that role name. |
978 | |
dabed765 |
979 | =item B<create_enum_type_constraint ($name, $values)> |
980 | |
620db045 |
981 | =item B<find_or_parse_type_constraint ($type_name)> |
004222dc |
982 | |
983 | This will attempt to find or create a type constraint given the a C<$type_name>. |
984 | If it cannot find it in the registry, it will see if it should be a union or |
620db045 |
985 | container type an create one if appropriate |
986 | |
987 | =item B<find_or_create_type_constraint ($type_name, ?$options_for_anon_type)> |
988 | |
989 | This function will first call C<find_or_parse_type_constraint> with the type name. |
990 | |
991 | If no type is found or created, but C<$options_for_anon_type> are provided, it |
992 | will create the corresponding type. |
993 | |
994 | This was used by the C<does> and C<isa> parameters to L<Moose::Meta::Attribute> |
995 | and are now superseded by C<find_or_create_isa_type_constraint> and |
996 | C<find_or_create_does_type_constraint>. |
997 | |
998 | =item B<find_or_create_isa_type_constraint ($type_name)> |
999 | |
1000 | =item B<find_or_create_does_type_constraint ($type_name)> |
1001 | |
ae55929d |
1002 | Attempts to parse the type name using C<find_or_parse_type_constraint> and if |
620db045 |
1003 | no appropriate constraint is found will create a new anonymous one. |
1004 | |
1005 | The C<isa> variant will use C<create_class_type_constraint> and the C<does> |
1006 | variant will use C<create_role_type_constraint>. |
004222dc |
1007 | |
1008 | =item B<find_type_constraint ($type_name)> |
1009 | |
1010 | This function can be used to locate a specific type constraint |
1011 | meta-object, of the class L<Moose::Meta::TypeConstraint> or a |
1012 | derivative. What you do with it from there is up to you :) |
1013 | |
1014 | =item B<register_type_constraint ($type_object)> |
1015 | |
1016 | This function will register a named type constraint with the type registry. |
1017 | |
1018 | =item B<get_type_constraint_registry> |
1019 | |
1020 | Fetch the L<Moose::Meta::TypeConstraint::Registry> object which |
1021 | keeps track of all type constraints. |
1022 | |
1023 | =item B<list_all_type_constraints> |
1024 | |
1025 | This will return a list of type constraint names, you can then |
1026 | fetch them using C<find_type_constraint ($type_name)> if you |
1027 | want to. |
1028 | |
1029 | =item B<list_all_builtin_type_constraints> |
1030 | |
1031 | This will return a list of builtin type constraints, meaning, |
1032 | those which are defined in this module. See the section |
1033 | labeled L<Default Type Constraints> for a complete list. |
1034 | |
1035 | =item B<export_type_constraints_as_functions> |
1036 | |
1037 | This will export all the current type constraints as functions |
1038 | into the caller's namespace. Right now, this is mostly used for |
1039 | testing, but it might prove useful to others. |
1040 | |
1041 | =item B<get_all_parameterizable_types> |
1042 | |
1043 | This returns all the parameterizable types that have been registered. |
1044 | |
1045 | =item B<add_parameterizable_type ($type)> |
1046 | |
1047 | Adds C<$type> to the list of parameterizable types |
1048 | |
1049 | =back |
1050 | |
571dd39f |
1051 | =head2 Namespace Management |
1052 | |
1053 | =over 4 |
1054 | |
1055 | =item B<unimport> |
1056 | |
e85d2a5d |
1057 | This will remove all the type constraint keywords from the |
571dd39f |
1058 | calling class namespace. |
1059 | |
1060 | =back |
1061 | |
a15dff8d |
1062 | =head1 BUGS |
1063 | |
e85d2a5d |
1064 | All complex software has bugs lurking in it, and this module is no |
a15dff8d |
1065 | exception. If you find a bug please either email me, or add the bug |
1066 | to cpan-RT. |
1067 | |
a15dff8d |
1068 | =head1 AUTHOR |
1069 | |
1070 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
1071 | |
1072 | =head1 COPYRIGHT AND LICENSE |
1073 | |
778db3ac |
1074 | Copyright 2006-2008 by Infinity Interactive, Inc. |
a15dff8d |
1075 | |
1076 | L<http://www.iinteractive.com> |
1077 | |
1078 | This library is free software; you can redistribute it and/or modify |
e85d2a5d |
1079 | it under the same terms as Perl itself. |
a15dff8d |
1080 | |
81dc201f |
1081 | =cut |