2 package Moose::Util::TypeConstraints;
8 use List::MoreUtils qw( all );
9 use Scalar::Util 'blessed';
12 our $VERSION = '0.62_02';
13 $VERSION = eval $VERSION;
14 our $AUTHORITY = 'cpan:STEVAN';
16 ## --------------------------------------------------------
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
20 # ensures the prototypes are in scope when consumers are
30 sub _create_type_constraint ($$$;$$);
31 sub _install_type_coercions ($$);
33 ## --------------------------------------------------------
35 use Moose::Meta::TypeConstraint;
36 use Moose::Meta::TypeConstraint::Union;
37 use Moose::Meta::TypeConstraint::Parameterized;
38 use Moose::Meta::TypeConstraint::Parameterizable;
39 use Moose::Meta::TypeConstraint::Class;
40 use Moose::Meta::TypeConstraint::Role;
41 use Moose::Meta::TypeConstraint::Enum;
42 use Moose::Meta::TypeCoercion;
43 use Moose::Meta::TypeCoercion::Union;
44 use Moose::Meta::TypeConstraint::Registry;
45 use Moose::Util::TypeConstraints::OptimizedConstraints;
47 Moose::Exporter->setup_import_methods(
50 type subtype class_type role_type as where message optimize_as
54 register_type_constraint )
59 ## --------------------------------------------------------
60 ## type registry and some useful functions for it
61 ## --------------------------------------------------------
63 my $REGISTRY = Moose::Meta::TypeConstraint::Registry->new;
65 sub get_type_constraint_registry { $REGISTRY }
66 sub list_all_type_constraints { keys %{$REGISTRY->type_constraints} }
67 sub export_type_constraints_as_functions {
70 foreach my $constraint (keys %{$REGISTRY->type_constraints}) {
71 my $tc = $REGISTRY->get_type_constraint($constraint)->_compiled_type_constraint;
72 *{"${pkg}::${constraint}"} = sub { $tc->($_[0]) ? 1 : undef }; # the undef is for compat
76 sub create_type_constraint_union {
77 my @type_constraint_names;
79 if (scalar @_ == 1 && _detect_type_constraint_union($_[0])) {
80 @type_constraint_names = _parse_type_constraint_union($_[0]);
83 @type_constraint_names = @_;
86 (scalar @type_constraint_names >= 2)
87 || Moose->throw_error("You must pass in at least 2 type names to make a union");
89 my @type_constraints = map {
90 find_or_parse_type_constraint($_) ||
91 Moose->throw_error("Could not locate type constraint ($_) for the union");
92 } @type_constraint_names;
94 return Moose::Meta::TypeConstraint::Union->new(
95 type_constraints => \@type_constraints
99 sub create_parameterized_type_constraint {
100 my $type_constraint_name = shift;
101 my ($base_type, $type_parameter) = _parse_parameterized_type_constraint($type_constraint_name);
103 (defined $base_type && defined $type_parameter)
104 || Moose->throw_error("Could not parse type name ($type_constraint_name) correctly");
106 if ($REGISTRY->has_type_constraint($base_type)) {
107 my $base_type_tc = $REGISTRY->get_type_constraint($base_type);
108 return _create_parameterized_type_constraint(
113 Moose->throw_error("Could not locate the base type ($base_type)");
117 sub _create_parameterized_type_constraint {
118 my ( $base_type_tc, $type_parameter ) = @_;
119 if ( $base_type_tc->can('parameterize') ) {
120 return $base_type_tc->parameterize($type_parameter);
122 return Moose::Meta::TypeConstraint::Parameterized->new(
123 name => $base_type_tc->name . '[' . $type_parameter . ']',
124 parent => $base_type_tc,
125 type_parameter => find_or_create_isa_type_constraint($type_parameter),
130 #should we also support optimized checks?
131 sub create_class_type_constraint {
132 my ( $class, $options ) = @_;
134 # too early for this check
135 #find_type_constraint("ClassName")->check($class)
136 # || Moose->throw_error("Can't create a class type constraint because '$class' is not a class name");
144 $options{name} ||= "__ANON__";
146 Moose::Meta::TypeConstraint::Class->new( %options );
149 sub create_role_type_constraint {
150 my ( $role, $options ) = @_;
152 # too early for this check
153 #find_type_constraint("ClassName")->check($class)
154 # || Moose->throw_error("Can't create a class type constraint because '$class' is not a class name");
162 $options{name} ||= "__ANON__";
164 Moose::Meta::TypeConstraint::Role->new( %options );
168 sub find_or_create_type_constraint {
169 my ( $type_constraint_name, $options_for_anon_type ) = @_;
171 if ( my $constraint = find_or_parse_type_constraint($type_constraint_name) ) {
174 elsif ( defined $options_for_anon_type ) {
176 # if there is no $options_for_anon_type
177 # specified, then we assume they don't
178 # want to create one, and return nothing.
180 # otherwise assume that we should create
181 # an ANON type with the $options_for_anon_type
182 # options which can be passed in. It should
183 # be noted that these don't get registered
184 # so we need to return it.
186 return Moose::Meta::TypeConstraint->new(
188 %{$options_for_anon_type}
195 sub find_or_create_isa_type_constraint {
196 my $type_constraint_name = shift;
197 find_or_parse_type_constraint($type_constraint_name) || create_class_type_constraint($type_constraint_name)
200 sub find_or_create_does_type_constraint {
201 my $type_constraint_name = shift;
202 find_or_parse_type_constraint($type_constraint_name) || create_role_type_constraint($type_constraint_name)
205 sub find_or_parse_type_constraint {
206 my $type_constraint_name = normalize_type_constraint_name(shift);
209 if ($constraint = find_type_constraint($type_constraint_name)) {
211 } elsif (_detect_type_constraint_union($type_constraint_name)) {
212 $constraint = create_type_constraint_union($type_constraint_name);
213 } elsif (_detect_parameterized_type_constraint($type_constraint_name)) {
214 $constraint = create_parameterized_type_constraint($type_constraint_name);
219 $REGISTRY->add_type_constraint($constraint);
223 sub normalize_type_constraint_name {
224 my $type_constraint_name = shift;
225 $type_constraint_name =~ s/\s//g;
226 return $type_constraint_name;
232 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
233 Carp::confess($error);
236 ## --------------------------------------------------------
237 ## exported functions ...
238 ## --------------------------------------------------------
240 sub find_type_constraint {
243 if ( blessed $type and $type->isa("Moose::Meta::TypeConstraint") ) {
247 return unless $REGISTRY->has_type_constraint($type);
248 return $REGISTRY->get_type_constraint($type);
252 sub register_type_constraint {
253 my $constraint = shift;
254 Moose->throw_error("can't register an unnamed type constraint") unless defined $constraint->name;
255 $REGISTRY->add_type_constraint($constraint);
262 splice(@_, 1, 0, undef);
263 goto &_create_type_constraint;
268 # this adds an undef for the name
269 # if this is an anon-subtype:
270 # subtype(Num => where { $_ % 2 == 0 }) # anon 'even' subtype
272 # subtype(Num => where { $_ % 2 == 0 }) message { "$_ must be an even number" }
274 # but if the last arg is not a code ref then it is a subtype
277 # subtype(MyNumbers => as Num); # now MyNumbers is the same as Num
278 # ... yeah I know it's ugly code
280 unshift @_ => undef if scalar @_ == 2 && ( 'CODE' eq ref( $_[-1] ) );
282 if scalar @_ == 3 && all { ref($_) =~ /^(?:CODE|HASH)$/ } @_[ 1, 2 ];
283 goto &_create_type_constraint;
287 register_type_constraint(
288 create_class_type_constraint(
290 ( defined($_[1]) ? $_[1] : () ),
295 sub role_type ($;$) {
296 register_type_constraint(
297 create_role_type_constraint(
299 ( defined($_[1]) ? $_[1] : () ),
305 my ($type_name, @coercion_map) = @_;
306 _install_type_coercions($type_name, \@coercion_map);
311 sub where (&) { $_[0] }
312 sub via (&) { $_[0] }
314 sub message (&) { +{ message => $_[0] } }
315 sub optimize_as (&) { +{ optimized => $_[0] } }
318 my ($type_name, @values) = @_;
320 # if only an array-ref is passed then
321 # you get an anon-enum
323 if (ref $type_name eq 'ARRAY' && !@values) {
324 @values = @$type_name;
327 (scalar @values >= 2)
328 || Moose->throw_error("You must have at least two values to enumerate through");
329 my %valid = map { $_ => 1 } @values;
331 register_type_constraint(
332 create_enum_type_constraint(
339 sub create_enum_type_constraint {
340 my ( $type_name, $values ) = @_;
342 Moose::Meta::TypeConstraint::Enum->new(
343 name => $type_name || '__ANON__',
348 ## --------------------------------------------------------
349 ## desugaring functions ...
350 ## --------------------------------------------------------
352 sub _create_type_constraint ($$$;$$) {
357 my ( $message, $optimized );
359 $message = $_->{message} if exists $_->{message};
360 $optimized = $_->{optimized} if exists $_->{optimized};
363 my $pkg_defined_in = scalar( caller(0) );
365 if ( defined $name ) {
366 my $type = $REGISTRY->get_type_constraint($name);
368 ( $type->_package_defined_in eq $pkg_defined_in )
370 "The type constraint '$name' has already been created in "
371 . $type->_package_defined_in
372 . " and cannot be created again in "
379 package_defined_in => $pkg_defined_in,
381 ( $check ? ( constraint => $check ) : () ),
382 ( $message ? ( message => $message ) : () ),
383 ( $optimized ? ( optimized => $optimized ) : () ),
389 = blessed $parent ? $parent : find_or_parse_type_constraint($parent) )
391 $constraint = $parent->create_child_type(%opts);
394 $constraint = Moose::Meta::TypeConstraint->new(%opts);
397 $REGISTRY->add_type_constraint($constraint)
403 sub _install_type_coercions ($$) {
404 my ($type_name, $coercion_map) = @_;
405 my $type = find_type_constraint($type_name);
407 || Moose->throw_error("Cannot find type '$type_name', perhaps you forgot to load it.");
408 if ($type->has_coercion) {
409 $type->coercion->add_type_coercions(@$coercion_map);
412 my $type_coercion = Moose::Meta::TypeCoercion->new(
413 type_coercion_map => $coercion_map,
414 type_constraint => $type
416 $type->coercion($type_coercion);
420 ## --------------------------------------------------------
421 ## type notation parsing ...
422 ## --------------------------------------------------------
425 # All I have to say is mugwump++ cause I know
426 # do not even have enough regexp-fu to be able
427 # to have written this (I can only barely
428 # understand it as it is)
433 my $valid_chars = qr{[\w:]};
434 my $type_atom = qr{ $valid_chars+ };
438 my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x;
439 my $type_capture_parts = qr{ ($valid_chars+) (?: \[ \s* ((??{$any})) \s* \] )? }x;
440 my $type_with_parameter = qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x;
442 my $op_union = qr{ \s* \| \s* }x;
443 my $union = qr{ $type (?: $op_union $type )+ }x;
445 $any = qr{ $type | $union }x;
447 sub _parse_parameterized_type_constraint {
448 { no warnings 'void'; $any; } # force capture of interpolated lexical
449 $_[0] =~ m{ $type_capture_parts }x;
453 sub _detect_parameterized_type_constraint {
454 { no warnings 'void'; $any; } # force capture of interpolated lexical
455 $_[0] =~ m{ ^ $type_with_parameter $ }x;
458 sub _parse_type_constraint_union {
459 { no warnings 'void'; $any; } # force capture of interpolated lexical
462 while ( $given =~ m{ \G (?: $op_union )? ($type) }gcx ) {
465 (pos($given) eq length($given))
466 || Moose->throw_error("'$given' didn't parse (parse-pos="
474 sub _detect_type_constraint_union {
475 { no warnings 'void'; $any; } # force capture of interpolated lexical
476 $_[0] =~ m{^ $type $op_union $type ( $op_union .* )? $}x;
480 ## --------------------------------------------------------
481 # define some basic built-in types
482 ## --------------------------------------------------------
484 # By making these classes immutable before creating all the types we
485 # below, we avoid repeatedly calling the slow MOP-based accessors.
487 inline_constructor => 1,
488 constructor_name => "_new",
490 # these are Class::MOP accessors, so they need inlining
491 inline_accessors => 1
492 ) for grep { $_->is_mutable }
495 Moose::Meta::TypeConstraint
496 Moose::Meta::TypeConstraint::Union
497 Moose::Meta::TypeConstraint::Parameterized
498 Moose::Meta::TypeConstraint::Parameterizable
499 Moose::Meta::TypeConstraint::Class
500 Moose::Meta::TypeConstraint::Role
501 Moose::Meta::TypeConstraint::Enum
502 Moose::Meta::TypeConstraint::Registry
505 type 'Any' => where { 1 }; # meta-type including all
506 type 'Item' => where { 1 }; # base-type
508 subtype 'Undef' => as 'Item' => where { !defined($_) };
509 subtype 'Defined' => as 'Item' => where { defined($_) };
513 => where { !defined($_) || $_ eq "" || "$_" eq '1' || "$_" eq '0' };
517 => where { !ref($_) }
518 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Value;
523 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Ref;
528 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Str;
532 => where { Scalar::Util::looks_like_number($_) }
533 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Num;
537 => where { "$_" =~ /^-?[0-9]+$/ }
538 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Int;
540 subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::ScalarRef;
541 subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::CodeRef;
542 subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::RegexpRef;
543 subtype 'GlobRef' => as 'Ref' => where { ref($_) eq 'GLOB' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::GlobRef;
546 # scalar filehandles are GLOB refs,
547 # but a GLOB ref is not always a filehandle
550 => where { Scalar::Util::openhandle($_) || ( blessed($_) && $_->isa("IO::Handle") ) }
551 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::FileHandle;
554 # blessed(qr/.../) returns true,.. how odd
557 => where { blessed($_) && blessed($_) ne 'Regexp' }
558 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Object;
562 => where { $_->can('does') }
563 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Role;
565 my $_class_name_checker = sub {
570 => where { Class::MOP::is_class_loaded($_) }
571 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::ClassName;
573 ## --------------------------------------------------------
574 # parameterizable types ...
576 $REGISTRY->add_type_constraint(
577 Moose::Meta::TypeConstraint::Parameterizable->new(
579 package_defined_in => __PACKAGE__,
580 parent => find_type_constraint('Ref'),
581 constraint => sub { ref($_) eq 'ARRAY' },
582 optimized => \&Moose::Util::TypeConstraints::OptimizedConstraints::ArrayRef,
583 constraint_generator => sub {
584 my $type_parameter = shift;
585 my $check = $type_parameter->_compiled_type_constraint;
587 foreach my $x (@$_) {
588 ($check->($x)) || return
595 $REGISTRY->add_type_constraint(
596 Moose::Meta::TypeConstraint::Parameterizable->new(
598 package_defined_in => __PACKAGE__,
599 parent => find_type_constraint('Ref'),
600 constraint => sub { ref($_) eq 'HASH' },
601 optimized => \&Moose::Util::TypeConstraints::OptimizedConstraints::HashRef,
602 constraint_generator => sub {
603 my $type_parameter = shift;
604 my $check = $type_parameter->_compiled_type_constraint;
606 foreach my $x (values %$_) {
607 ($check->($x)) || return
614 $REGISTRY->add_type_constraint(
615 Moose::Meta::TypeConstraint::Parameterizable->new(
617 package_defined_in => __PACKAGE__,
618 parent => find_type_constraint('Item'),
619 constraint => sub { 1 },
620 constraint_generator => sub {
621 my $type_parameter = shift;
622 my $check = $type_parameter->_compiled_type_constraint;
624 return 1 if not(defined($_)) || $check->($_);
631 my @PARAMETERIZABLE_TYPES = map {
632 $REGISTRY->get_type_constraint($_)
633 } qw[ArrayRef HashRef Maybe];
635 sub get_all_parameterizable_types { @PARAMETERIZABLE_TYPES }
636 sub add_parameterizable_type {
638 (blessed $type && $type->isa('Moose::Meta::TypeConstraint::Parameterizable'))
639 || Moose->throw_error("Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type");
640 push @PARAMETERIZABLE_TYPES => $type;
643 ## --------------------------------------------------------
644 # end of built-in types ...
645 ## --------------------------------------------------------
648 my @BUILTINS = list_all_type_constraints();
649 sub list_all_builtin_type_constraints { @BUILTINS }
660 Moose::Util::TypeConstraints - Type constraint system for Moose
664 use Moose::Util::TypeConstraints;
666 type 'Num' => where { Scalar::Util::looks_like_number($_) };
672 subtype 'NaturalLessThanTen'
675 => message { "This number ($_) is not less than ten!" };
681 enum 'RGBColors' => qw(red green blue);
685 This module provides Moose with the ability to create custom type
686 contraints to be used in attribute definition.
688 =head2 Important Caveat
690 This is B<NOT> a type system for Perl 5. These are type constraints,
691 and they are not used by Moose unless you tell it to. No type
692 inference is performed, expression are not typed, etc. etc. etc.
694 This is simply a means of creating small constraint functions which
695 can be used to simplify your own type-checking code, with the added
696 side benefit of making your intentions clearer through self-documentation.
698 =head2 Slightly Less Important Caveat
700 It is B<always> a good idea to quote your type and subtype names.
702 This is to prevent perl from trying to execute the call as an indirect
703 object call. This issue only seems to come up when you have a subtype
704 the same name as a valid class, but when the issue does arise it tends
705 to be quite annoying to debug.
707 So for instance, this:
709 subtype DateTime => as Object => where { $_->isa('DateTime') };
711 will I<Just Work>, while this:
714 subtype DateTime => as Object => where { $_->isa('DateTime') };
716 will fail silently and cause many headaches. The simple way to solve
717 this, as well as future proof your subtypes from classes which have
718 yet to have been created yet, is to simply do this:
721 subtype 'DateTime' => as 'Object' => where { $_->isa('DateTime') };
723 =head2 Default Type Constraints
725 This module also provides a simple hierarchy for Perl 5 types, here is
726 that hierarchy represented visually.
750 B<NOTE:> Any type followed by a type parameter C<[`a]> can be
751 parameterized, this means you can say:
753 ArrayRef[Int] # an array of integers
754 HashRef[CodeRef] # a hash of str to CODE ref mappings
755 Maybe[Str] # value may be a string, may be undefined
757 B<NOTE:> Unless you parameterize a type, then it is invalid to
758 include the square brackets. I.e. C<ArrayRef[]> will be
759 literally interpreted as a type name.
761 B<NOTE:> The C<Undef> type constraint for the most part works
762 correctly now, but edge cases may still exist, please use it
765 B<NOTE:> The C<ClassName> type constraint does a complex package
766 existence check. This means that your class B<must> be loaded for
767 this type constraint to pass. I know this is not ideal for all,
768 but it is a saner restriction than most others.
770 =head2 Type Constraint Naming
772 Since the types created by this module are global, it is suggested
773 that you namespace your types just as you would namespace your
774 modules. So instead of creating a I<Color> type for your B<My::Graphics>
775 module, you would call the type I<My::Graphics::Color> instead.
777 =head2 Use with Other Constraint Modules
779 This module should play fairly nicely with other constraint
780 modules with only some slight tweaking. The C<where> clause
781 in types is expected to be a C<CODE> reference which checks
782 it's first argument and returns a boolean. Since most constraint
783 modules work in a similar way, it should be simple to adapt
784 them to work with Moose.
786 For instance, this is how you could use it with
787 L<Declare::Constraints::Simple> to declare a completely new type.
789 type 'HashOfArrayOfObjects'
792 -values => IsArrayRef( IsObject ));
794 For more examples see the F<t/200_examples/204_example_w_DCS.t>
797 Here is an example of using L<Test::Deep> and it's non-test
798 related C<eq_deeply> function.
800 type 'ArrayOfHashOfBarsAndRandomNumbers'
803 array_each(subhashof({
805 random_number => ignore()
809 For a complete example see the
810 F<t/200_examples/205_example_w_TestDeep.t> test file.
814 =head2 Type Constraint Constructors
816 The following functions are used to create type constraints.
817 They will then register the type constraints in a global store
818 where Moose can get to them if it needs to.
820 See the L<SYNOPSIS> for an example of how to use these.
824 =item B<type ($name, $where_clause)>
826 This creates a base type, which has no parent.
828 =item B<subtype ($name, $parent, $where_clause, ?$message)>
830 This creates a named subtype.
832 =item B<subtype ($parent, $where_clause, ?$message)>
834 This creates an unnamed subtype and will return the type
835 constraint meta-object, which will be an instance of
836 L<Moose::Meta::TypeConstraint>.
838 =item B<class_type ($class, ?$options)>
840 Creates a type constraint with the name C<$class> and the metaclass
841 L<Moose::Meta::TypeConstraint::Class>.
843 =item B<role_type ($role, ?$options)>
845 Creates a type constraint with the name C<$role> and the metaclass
846 L<Moose::Meta::TypeConstraint::Role>.
848 =item B<enum ($name, @values)>
850 This will create a basic subtype for a given set of strings.
851 The resulting constraint will be a subtype of C<Str> and
852 will match any of the items in C<@values>. It is case sensitive.
853 See the L<SYNOPSIS> for a simple example.
855 B<NOTE:> This is not a true proper enum type, it is simple
856 a convient constraint builder.
858 =item B<enum (\@values)>
860 If passed an ARRAY reference instead of the C<$name>, C<@values> pair,
861 this will create an unnamed enum. This can then be used in an attribute
864 has 'sort_order' => (
866 isa => enum([qw[ ascending descending ]]),
871 This is just sugar for the type constraint construction syntax.
875 This is just sugar for the type constraint construction syntax.
877 Takes a block/code ref as an argument. When the type constraint is
878 tested, the supplied code is run with the value to be tested in
879 $_. This block should return true or false to indicate whether or not
880 the constraint check passed.
884 This is just sugar for the type constraint construction syntax.
886 Takes a block/code ref as an argument. When the type constraint fails,
887 then the code block is run (with the value provided in $_). This code
888 ref should return a string, which will be used in the text of the
893 This can be used to define a "hand optimized" version of your
894 type constraint which can be used to avoid traversing a subtype
895 constraint heirarchy.
897 B<NOTE:> You should only use this if you know what you are doing,
898 all the built in types use this, so your subtypes (assuming they
899 are shallow) will not likely need to use this.
903 =head2 Type Coercion Constructors
905 Type constraints can also contain type coercions as well. If you
906 ask your accessor to coerce, then Moose will run the type-coercion
907 code first, followed by the type constraint check. This feature
908 should be used carefully as it is very powerful and could easily
909 take off a limb if you are not careful.
911 See the L<SYNOPSIS> for an example of how to use these.
919 This is just sugar for the type coercion construction syntax.
923 This is just sugar for the type coercion construction syntax.
927 =head2 Type Constraint Construction & Locating
931 =item B<normalize_type_constraint_name ($type_constraint_name)>
933 Given a string that is expected to match a type constraint, will normalize the
934 string so that extra whitespace and newlines are removed.
936 =item B<create_type_constraint_union ($pipe_seperated_types | @type_constraint_names)>
938 Given string with C<$pipe_seperated_types> or a list of C<@type_constraint_names>,
939 this will return a L<Moose::Meta::TypeConstraint::Union> instance.
941 =item B<create_parameterized_type_constraint ($type_name)>
943 Given a C<$type_name> in the form of:
945 BaseType[ContainerType]
947 this will extract the base type and container type and build an instance of
948 L<Moose::Meta::TypeConstraint::Parameterized> for it.
950 =item B<create_class_type_constraint ($class, ?$options)>
952 Given a class name it will create a new L<Moose::Meta::TypeConstraint::Class>
953 object for that class name.
955 =item B<create_role_type_constraint ($role, ?$options)>
957 Given a role name it will create a new L<Moose::Meta::TypeConstraint::Role>
958 object for that role name.
960 =item B<create_enum_type_constraint ($name, $values)>
962 =item B<find_or_parse_type_constraint ($type_name)>
964 This will attempt to find or create a type constraint given the a C<$type_name>.
965 If it cannot find it in the registry, it will see if it should be a union or
966 container type an create one if appropriate
968 =item B<find_or_create_type_constraint ($type_name, ?$options_for_anon_type)>
970 This function will first call C<find_or_parse_type_constraint> with the type name.
972 If no type is found or created, but C<$options_for_anon_type> are provided, it
973 will create the corresponding type.
975 This was used by the C<does> and C<isa> parameters to L<Moose::Meta::Attribute>
976 and are now superseded by C<find_or_create_isa_type_constraint> and
977 C<find_or_create_does_type_constraint>.
979 =item B<find_or_create_isa_type_constraint ($type_name)>
981 =item B<find_or_create_does_type_constraint ($type_name)>
983 Attempts to parse the type name using C<find_or_parse_type_constraint> and if
984 no appropriate constraint is found will create a new anonymous one.
986 The C<isa> variant will use C<create_class_type_constraint> and the C<does>
987 variant will use C<create_role_type_constraint>.
989 =item B<find_type_constraint ($type_name)>
991 This function can be used to locate a specific type constraint
992 meta-object, of the class L<Moose::Meta::TypeConstraint> or a
993 derivative. What you do with it from there is up to you :)
995 =item B<register_type_constraint ($type_object)>
997 This function will register a named type constraint with the type registry.
999 =item B<get_type_constraint_registry>
1001 Fetch the L<Moose::Meta::TypeConstraint::Registry> object which
1002 keeps track of all type constraints.
1004 =item B<list_all_type_constraints>
1006 This will return a list of type constraint names, you can then
1007 fetch them using C<find_type_constraint ($type_name)> if you
1010 =item B<list_all_builtin_type_constraints>
1012 This will return a list of builtin type constraints, meaning,
1013 those which are defined in this module. See the section
1014 labeled L<Default Type Constraints> for a complete list.
1016 =item B<export_type_constraints_as_functions>
1018 This will export all the current type constraints as functions
1019 into the caller's namespace. Right now, this is mostly used for
1020 testing, but it might prove useful to others.
1022 =item B<get_all_parameterizable_types>
1024 This returns all the parameterizable types that have been registered.
1026 =item B<add_parameterizable_type ($type)>
1028 Adds C<$type> to the list of parameterizable types
1032 =head2 Namespace Management
1038 This will remove all the type constraint keywords from the
1039 calling class namespace.
1045 All complex software has bugs lurking in it, and this module is no
1046 exception. If you find a bug please either email me, or add the bug
1051 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1053 =head1 COPYRIGHT AND LICENSE
1055 Copyright 2006-2008 by Infinity Interactive, Inc.
1057 L<http://www.iinteractive.com>
1059 This library is free software; you can redistribute it and/or modify
1060 it under the same terms as Perl itself.