2 package Moose::Util::TypeConstraints;
8 use List::MoreUtils qw( all any );
9 use Scalar::Util qw( blessed reftype );
12 our $VERSION = '0.71';
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
29 ## --------------------------------------------------------
31 use Moose::Meta::TypeConstraint;
32 use Moose::Meta::TypeConstraint::Union;
33 use Moose::Meta::TypeConstraint::Parameterized;
34 use Moose::Meta::TypeConstraint::Parameterizable;
35 use Moose::Meta::TypeConstraint::Class;
36 use Moose::Meta::TypeConstraint::Role;
37 use Moose::Meta::TypeConstraint::Enum;
38 use Moose::Meta::TypeCoercion;
39 use Moose::Meta::TypeCoercion::Union;
40 use Moose::Meta::TypeConstraint::Registry;
41 use Moose::Util::TypeConstraints::OptimizedConstraints;
43 Moose::Exporter->setup_import_methods(
46 type subtype class_type role_type maybe_type
47 as where message optimize_as
51 register_type_constraint )
56 ## --------------------------------------------------------
57 ## type registry and some useful functions for it
58 ## --------------------------------------------------------
60 my $REGISTRY = Moose::Meta::TypeConstraint::Registry->new;
62 sub get_type_constraint_registry { $REGISTRY }
63 sub list_all_type_constraints { keys %{$REGISTRY->type_constraints} }
64 sub export_type_constraints_as_functions {
67 foreach my $constraint (keys %{$REGISTRY->type_constraints}) {
68 my $tc = $REGISTRY->get_type_constraint($constraint)->_compiled_type_constraint;
69 *{"${pkg}::${constraint}"} = sub { $tc->($_[0]) ? 1 : undef }; # the undef is for compat
73 sub create_type_constraint_union {
74 my @type_constraint_names;
76 if (scalar @_ == 1 && _detect_type_constraint_union($_[0])) {
77 @type_constraint_names = _parse_type_constraint_union($_[0]);
80 @type_constraint_names = @_;
83 (scalar @type_constraint_names >= 2)
84 || __PACKAGE__->_throw_error("You must pass in at least 2 type names to make a union");
86 my @type_constraints = map {
87 find_or_parse_type_constraint($_) ||
88 __PACKAGE__->_throw_error("Could not locate type constraint ($_) for the union");
89 } @type_constraint_names;
91 return Moose::Meta::TypeConstraint::Union->new(
92 type_constraints => \@type_constraints
96 sub create_parameterized_type_constraint {
97 my $type_constraint_name = shift;
98 my ($base_type, $type_parameter) = _parse_parameterized_type_constraint($type_constraint_name);
100 (defined $base_type && defined $type_parameter)
101 || __PACKAGE__->_throw_error("Could not parse type name ($type_constraint_name) correctly");
103 if ($REGISTRY->has_type_constraint($base_type)) {
104 my $base_type_tc = $REGISTRY->get_type_constraint($base_type);
105 return _create_parameterized_type_constraint(
110 __PACKAGE__->_throw_error("Could not locate the base type ($base_type)");
114 sub _create_parameterized_type_constraint {
115 my ( $base_type_tc, $type_parameter ) = @_;
116 if ( $base_type_tc->can('parameterize') ) {
117 return $base_type_tc->parameterize($type_parameter);
119 return Moose::Meta::TypeConstraint::Parameterized->new(
120 name => $base_type_tc->name . '[' . $type_parameter . ']',
121 parent => $base_type_tc,
122 type_parameter => find_or_create_isa_type_constraint($type_parameter),
127 #should we also support optimized checks?
128 sub create_class_type_constraint {
129 my ( $class, $options ) = @_;
131 # too early for this check
132 #find_type_constraint("ClassName")->check($class)
133 # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name");
141 $options{name} ||= "__ANON__";
143 Moose::Meta::TypeConstraint::Class->new( %options );
146 sub create_role_type_constraint {
147 my ( $role, $options ) = @_;
149 # too early for this check
150 #find_type_constraint("ClassName")->check($class)
151 # || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name");
159 $options{name} ||= "__ANON__";
161 Moose::Meta::TypeConstraint::Role->new( %options );
165 sub find_or_create_type_constraint {
166 my ( $type_constraint_name, $options_for_anon_type ) = @_;
168 if ( my $constraint = find_or_parse_type_constraint($type_constraint_name) ) {
171 elsif ( defined $options_for_anon_type ) {
173 # if there is no $options_for_anon_type
174 # specified, then we assume they don't
175 # want to create one, and return nothing.
177 # otherwise assume that we should create
178 # an ANON type with the $options_for_anon_type
179 # options which can be passed in. It should
180 # be noted that these don't get registered
181 # so we need to return it.
183 return Moose::Meta::TypeConstraint->new(
185 %{$options_for_anon_type}
192 sub find_or_create_isa_type_constraint {
193 my $type_constraint_name = shift;
194 find_or_parse_type_constraint($type_constraint_name) || create_class_type_constraint($type_constraint_name)
197 sub find_or_create_does_type_constraint {
198 my $type_constraint_name = shift;
199 find_or_parse_type_constraint($type_constraint_name) || create_role_type_constraint($type_constraint_name)
202 sub find_or_parse_type_constraint {
203 my $type_constraint_name = normalize_type_constraint_name(shift);
206 if ($constraint = find_type_constraint($type_constraint_name)) {
208 } elsif (_detect_type_constraint_union($type_constraint_name)) {
209 $constraint = create_type_constraint_union($type_constraint_name);
210 } elsif (_detect_parameterized_type_constraint($type_constraint_name)) {
211 $constraint = create_parameterized_type_constraint($type_constraint_name);
216 $REGISTRY->add_type_constraint($constraint);
220 sub normalize_type_constraint_name {
221 my $type_constraint_name = shift;
222 $type_constraint_name =~ s/\s//g;
223 return $type_constraint_name;
229 local $Carp::CarpLevel = $Carp::CarpLevel + 1;
230 Carp::confess($error);
233 ## --------------------------------------------------------
234 ## exported functions ...
235 ## --------------------------------------------------------
237 sub find_type_constraint {
240 if ( blessed $type and $type->isa("Moose::Meta::TypeConstraint") ) {
244 return unless $REGISTRY->has_type_constraint($type);
245 return $REGISTRY->get_type_constraint($type);
249 sub register_type_constraint {
250 my $constraint = shift;
251 __PACKAGE__->_throw_error("can't register an unnamed type constraint") unless defined $constraint->name;
252 $REGISTRY->add_type_constraint($constraint);
259 # back-compat version, called without sugar
260 if ( ! any { ( reftype($_) || '' ) eq 'HASH' } @_ ) {
261 return _create_type_constraint( $_[0], undef, $_[1] );
266 my %p = map { %{$_} } @_;
268 return _create_type_constraint( $name, undef, $p{where}, $p{message}, $p{optimize_as} );
272 # crazy back-compat code for being called without sugar ...
274 # subtype 'Parent', sub { where };
275 if ( scalar @_ == 2 && ( reftype( $_[1] ) || '' ) eq 'CODE' ) {
276 return _create_type_constraint( undef, @_ );
279 # subtype 'Parent', sub { where }, sub { message };
280 # subtype 'Parent', sub { where }, sub { message }, sub { optimized };
281 if ( scalar @_ >= 3 && all { ( reftype($_) || '' ) eq 'CODE' }
283 return _create_type_constraint( undef, @_ );
286 # subtype 'Name', 'Parent', ...
287 if ( scalar @_ >= 2 && all { !ref } @_[ 0, 1 ] ) {
288 return _create_type_constraint(@_);
291 my $name = ref $_[0] ? undef : shift;
293 my %p = map { %{$_} } @_;
295 # subtype Str => where { ... };
296 if ( ! exists $p{as} ) {
301 return _create_type_constraint( $name, $p{as}, $p{where}, $p{message}, $p{optimize_as} );
305 register_type_constraint(
306 create_class_type_constraint(
308 ( defined($_[1]) ? $_[1] : () ),
313 sub role_type ($;$) {
314 register_type_constraint(
315 create_role_type_constraint(
317 ( defined($_[1]) ? $_[1] : () ),
323 my ($type_parameter) = @_;
325 register_type_constraint(
326 $REGISTRY->get_type_constraint('Maybe')->parameterize($type_parameter)
331 my ($type_name, @coercion_map) = @_;
332 _install_type_coercions($type_name, \@coercion_map);
335 sub as ($) { { as => $_[0] } }
336 sub where (&) { { where => $_[0] } }
337 sub message (&) { { message => $_[0] } }
338 sub optimize_as (&) { { optimize_as => $_[0] } }
341 sub via (&) { $_[0] }
344 my ($type_name, @values) = @_;
346 # if only an array-ref is passed then
347 # you get an anon-enum
349 if (ref $type_name eq 'ARRAY' && !@values) {
350 @values = @$type_name;
353 (scalar @values >= 2)
354 || __PACKAGE__->_throw_error("You must have at least two values to enumerate through");
355 my %valid = map { $_ => 1 } @values;
357 register_type_constraint(
358 create_enum_type_constraint(
365 sub create_enum_type_constraint {
366 my ( $type_name, $values ) = @_;
368 Moose::Meta::TypeConstraint::Enum->new(
369 name => $type_name || '__ANON__',
374 ## --------------------------------------------------------
375 ## desugaring functions ...
376 ## --------------------------------------------------------
378 sub _create_type_constraint ($$$;$$) {
383 my $optimized = shift;
385 my $pkg_defined_in = scalar( caller(1) );
387 if ( defined $name ) {
388 my $type = $REGISTRY->get_type_constraint($name);
390 ( $type->_package_defined_in eq $pkg_defined_in )
392 "The type constraint '$name' has already been created in "
393 . $type->_package_defined_in
394 . " and cannot be created again in "
398 $name =~ /^[\w:\.]+$/
399 or die qq{$name contains invalid characters for a type name.}
400 . qq{ Names can contain alphanumeric character, ":", and "."\n};
405 package_defined_in => $pkg_defined_in,
407 ( $check ? ( constraint => $check ) : () ),
408 ( $message ? ( message => $message ) : () ),
409 ( $optimized ? ( optimized => $optimized ) : () ),
415 = blessed $parent ? $parent : find_or_create_isa_type_constraint($parent) )
417 $constraint = $parent->create_child_type(%opts);
420 $constraint = Moose::Meta::TypeConstraint->new(%opts);
423 $REGISTRY->add_type_constraint($constraint)
429 sub _install_type_coercions ($$) {
430 my ($type_name, $coercion_map) = @_;
431 my $type = find_type_constraint($type_name);
433 || __PACKAGE__->_throw_error("Cannot find type '$type_name', perhaps you forgot to load it.");
434 if ($type->has_coercion) {
435 $type->coercion->add_type_coercions(@$coercion_map);
438 my $type_coercion = Moose::Meta::TypeCoercion->new(
439 type_coercion_map => $coercion_map,
440 type_constraint => $type
442 $type->coercion($type_coercion);
446 ## --------------------------------------------------------
447 ## type notation parsing ...
448 ## --------------------------------------------------------
451 # All I have to say is mugwump++ cause I know
452 # do not even have enough regexp-fu to be able
453 # to have written this (I can only barely
454 # understand it as it is)
459 my $valid_chars = qr{[\w:\.]};
460 my $type_atom = qr{ $valid_chars+ };
464 my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x;
465 my $type_capture_parts = qr{ ($valid_chars+) (?: \[ \s* ((??{$any})) \s* \] )? }x;
466 my $type_with_parameter = qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x;
468 my $op_union = qr{ \s* \| \s* }x;
469 my $union = qr{ $type (?: $op_union $type )+ }x;
471 $any = qr{ $type | $union }x;
473 sub _parse_parameterized_type_constraint {
474 { no warnings 'void'; $any; } # force capture of interpolated lexical
475 $_[0] =~ m{ $type_capture_parts }x;
479 sub _detect_parameterized_type_constraint {
480 { no warnings 'void'; $any; } # force capture of interpolated lexical
481 $_[0] =~ m{ ^ $type_with_parameter $ }x;
484 sub _parse_type_constraint_union {
485 { no warnings 'void'; $any; } # force capture of interpolated lexical
488 while ( $given =~ m{ \G (?: $op_union )? ($type) }gcx ) {
491 (pos($given) eq length($given))
492 || __PACKAGE__->_throw_error("'$given' didn't parse (parse-pos="
500 sub _detect_type_constraint_union {
501 { no warnings 'void'; $any; } # force capture of interpolated lexical
502 $_[0] =~ m{^ $type $op_union $type ( $op_union .* )? $}x;
506 ## --------------------------------------------------------
507 # define some basic built-in types
508 ## --------------------------------------------------------
510 # By making these classes immutable before creating all the types we
511 # below, we avoid repeatedly calling the slow MOP-based accessors.
513 inline_constructor => 1,
514 constructor_name => "_new",
516 # these are Class::MOP accessors, so they need inlining
517 inline_accessors => 1
518 ) for grep { $_->is_mutable }
521 Moose::Meta::TypeConstraint
522 Moose::Meta::TypeConstraint::Union
523 Moose::Meta::TypeConstraint::Parameterized
524 Moose::Meta::TypeConstraint::Parameterizable
525 Moose::Meta::TypeConstraint::Class
526 Moose::Meta::TypeConstraint::Role
527 Moose::Meta::TypeConstraint::Enum
528 Moose::Meta::TypeConstraint::Registry
531 type 'Any' => where { 1 }; # meta-type including all
532 type 'Item' => where { 1 }; # base-type
534 subtype 'Undef' => as 'Item' => where { !defined($_) };
535 subtype 'Defined' => as 'Item' => where { defined($_) };
539 => where { !defined($_) || $_ eq "" || "$_" eq '1' || "$_" eq '0' };
543 => where { !ref($_) }
544 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Value;
549 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Ref;
554 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Str;
558 => where { Scalar::Util::looks_like_number($_) }
559 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Num;
563 => where { "$_" =~ /^-?[0-9]+$/ }
564 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Int;
566 subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::ScalarRef;
567 subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::CodeRef;
568 subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::RegexpRef;
569 subtype 'GlobRef' => as 'Ref' => where { ref($_) eq 'GLOB' } => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::GlobRef;
572 # scalar filehandles are GLOB refs,
573 # but a GLOB ref is not always a filehandle
576 => where { Scalar::Util::openhandle($_) || ( blessed($_) && $_->isa("IO::Handle") ) }
577 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::FileHandle;
580 # blessed(qr/.../) returns true,.. how odd
583 => where { blessed($_) && blessed($_) ne 'Regexp' }
584 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Object;
588 => where { $_->can('does') }
589 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Role;
591 my $_class_name_checker = sub {};
595 => where { Class::MOP::is_class_loaded($_) }
596 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::ClassName;
600 => where { (($_->can('meta') || return)->($_) || return)->isa('Moose::Meta::Role') }
601 => optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::RoleName; ;
603 ## --------------------------------------------------------
604 # parameterizable types ...
606 $REGISTRY->add_type_constraint(
607 Moose::Meta::TypeConstraint::Parameterizable->new(
609 package_defined_in => __PACKAGE__,
610 parent => find_type_constraint('Ref'),
611 constraint => sub { ref($_) eq 'ARRAY' },
612 optimized => \&Moose::Util::TypeConstraints::OptimizedConstraints::ArrayRef,
613 constraint_generator => sub {
614 my $type_parameter = shift;
615 my $check = $type_parameter->_compiled_type_constraint;
617 foreach my $x (@$_) {
618 ($check->($x)) || return
625 $REGISTRY->add_type_constraint(
626 Moose::Meta::TypeConstraint::Parameterizable->new(
628 package_defined_in => __PACKAGE__,
629 parent => find_type_constraint('Ref'),
630 constraint => sub { ref($_) eq 'HASH' },
631 optimized => \&Moose::Util::TypeConstraints::OptimizedConstraints::HashRef,
632 constraint_generator => sub {
633 my $type_parameter = shift;
634 my $check = $type_parameter->_compiled_type_constraint;
636 foreach my $x (values %$_) {
637 ($check->($x)) || return
644 $REGISTRY->add_type_constraint(
645 Moose::Meta::TypeConstraint::Parameterizable->new(
647 package_defined_in => __PACKAGE__,
648 parent => find_type_constraint('Item'),
649 constraint => sub { 1 },
650 constraint_generator => sub {
651 my $type_parameter = shift;
652 my $check = $type_parameter->_compiled_type_constraint;
654 return 1 if not(defined($_)) || $check->($_);
661 my @PARAMETERIZABLE_TYPES = map {
662 $REGISTRY->get_type_constraint($_)
663 } qw[ArrayRef HashRef Maybe];
665 sub get_all_parameterizable_types { @PARAMETERIZABLE_TYPES }
666 sub add_parameterizable_type {
668 (blessed $type && $type->isa('Moose::Meta::TypeConstraint::Parameterizable'))
669 || __PACKAGE__->_throw_error("Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type");
670 push @PARAMETERIZABLE_TYPES => $type;
673 ## --------------------------------------------------------
674 # end of built-in types ...
675 ## --------------------------------------------------------
678 my @BUILTINS = list_all_type_constraints();
679 sub list_all_builtin_type_constraints { @BUILTINS }
686 goto &Moose::throw_error;
697 Moose::Util::TypeConstraints - Type constraint system for Moose
701 use Moose::Util::TypeConstraints;
703 type 'Num' => where { Scalar::Util::looks_like_number($_) };
709 subtype 'NaturalLessThanTen'
712 => message { "This number ($_) is not less than ten!" };
718 enum 'RGBColors' => qw(red green blue);
722 This module provides Moose with the ability to create custom type
723 constraints to be used in attribute definition.
725 =head2 Important Caveat
727 This is B<NOT> a type system for Perl 5. These are type constraints,
728 and they are not used by Moose unless you tell it to. No type
729 inference is performed, expression are not typed, etc. etc. etc.
731 This is simply a means of creating small constraint functions which
732 can be used to simplify your own type-checking code, with the added
733 side benefit of making your intentions clearer through self-documentation.
735 =head2 Slightly Less Important Caveat
737 It is B<always> a good idea to quote your type and subtype names.
739 This is to prevent perl from trying to execute the call as an indirect
740 object call. This issue only seems to come up when you have a subtype
741 the same name as a valid class, but when the issue does arise it tends
742 to be quite annoying to debug.
744 So for instance, this:
746 subtype DateTime => as Object => where { $_->isa('DateTime') };
748 will I<Just Work>, while this:
751 subtype DateTime => as Object => where { $_->isa('DateTime') };
753 will fail silently and cause many headaches. The simple way to solve
754 this, as well as future proof your subtypes from classes which have
755 yet to have been created yet, is to simply do this:
758 subtype 'DateTime' => as 'Object' => where { $_->isa('DateTime') };
760 =head2 Default Type Constraints
762 This module also provides a simple hierarchy for Perl 5 types, here is
763 that hierarchy represented visually.
788 B<NOTE:> Any type followed by a type parameter C<[`a]> can be
789 parameterized, this means you can say:
791 ArrayRef[Int] # an array of integers
792 HashRef[CodeRef] # a hash of str to CODE ref mappings
793 Maybe[Str] # value may be a string, may be undefined
795 If Moose finds a name in brackets that it does not recognize as an
796 existing type, it assumes that this is a class name, for example
797 C<ArrayRef[DateTime]>.
799 B<NOTE:> Unless you parameterize a type, then it is invalid to
800 include the square brackets. I.e. C<ArrayRef[]> will be
801 literally interpreted as a type name.
803 B<NOTE:> The C<Undef> type constraint for the most part works
804 correctly now, but edge cases may still exist, please use it
807 B<NOTE:> The C<ClassName> type constraint does a complex package
808 existence check. This means that your class B<must> be loaded for
809 this type constraint to pass. I know this is not ideal for all,
810 but it is a saner restriction than most others.
812 B<NOTE:> The C<RoleName> constraint checks a string is I<package name>
813 which is a role, like C<'MyApp::Role::Comparable'>. The C<Role>
814 constraint checks that an I<object> does the named role.
816 =head2 Type Constraint Naming
818 Type name declared via this module can only contain alphanumeric
819 characters, colons (:), and periods (.).
821 Since the types created by this module are global, it is suggested
822 that you namespace your types just as you would namespace your
823 modules. So instead of creating a I<Color> type for your B<My::Graphics>
824 module, you would call the type I<My.Graphics.Color> instead.
826 =head2 Use with Other Constraint Modules
828 This module should play fairly nicely with other constraint
829 modules with only some slight tweaking. The C<where> clause
830 in types is expected to be a C<CODE> reference which checks
831 it's first argument and returns a boolean. Since most constraint
832 modules work in a similar way, it should be simple to adapt
833 them to work with Moose.
835 For instance, this is how you could use it with
836 L<Declare::Constraints::Simple> to declare a completely new type.
838 type 'HashOfArrayOfObjects',
842 -values => IsArrayRef(IsObject)
846 For more examples see the F<t/200_examples/204_example_w_DCS.t>
849 Here is an example of using L<Test::Deep> and it's non-test
850 related C<eq_deeply> function.
852 type 'ArrayOfHashOfBarsAndRandomNumbers'
855 array_each(subhashof({
857 random_number => ignore()
861 For a complete example see the
862 F<t/200_examples/205_example_w_TestDeep.t> test file.
866 =head2 Type Constraint Constructors
868 The following functions are used to create type constraints.
869 They will then register the type constraints in a global store
870 where Moose can get to them if it needs to.
872 See the L<SYNOPSIS> for an example of how to use these.
876 =item B<type 'Name' => where { } ... >
878 This creates a base type, which has no parent.
880 The C<type> function should either be called with the sugar helpers
881 (C<where>, C<message>, etc), or with a name and a hashref of
884 type( 'Foo', { where => ..., message => ... } );
886 The valid hashref keys are C<where>, C<message>, and C<optimize_as>.
888 =item B<subtype 'Name' => as 'Parent' => where { } ...>
890 This creates a named subtype.
892 If you provide a parent that Moose does not recognize, it will
893 automatically create a new class type constraint for this name.
895 When creating a named type, the C<subtype> function should either be
896 called with the sugar helpers (C<where>, C<message>, etc), or with a
897 name and a hashref of parameters:
899 subtype( 'Foo', { where => ..., message => ... } );
901 The valid hashref keys are C<as> (the parent), C<where>, C<message>,
904 =item B<subtype as 'Parent' => where { } ...>
906 This creates an unnamed subtype and will return the type
907 constraint meta-object, which will be an instance of
908 L<Moose::Meta::TypeConstraint>.
910 When creating an anonymous type, the C<subtype> function should either
911 be called with the sugar helpers (C<where>, C<message>, etc), or with
912 just a hashref of parameters:
914 subtype( { where => ..., message => ... } );
916 =item B<class_type ($class, ?$options)>
918 Creates a new subtype of C<Object> with the name C<$class> and the
919 metaclass L<Moose::Meta::TypeConstraint::Class>.
921 =item B<role_type ($role, ?$options)>
923 Creates a C<Role> type constraint with the name C<$role> and the
924 metaclass L<Moose::Meta::TypeConstraint::Role>.
926 =item B<maybe_type ($type)>
928 Creates a type constraint for either C<undef> or something of the
931 =item B<enum ($name, @values)>
933 This will create a basic subtype for a given set of strings.
934 The resulting constraint will be a subtype of C<Str> and
935 will match any of the items in C<@values>. It is case sensitive.
936 See the L<SYNOPSIS> for a simple example.
938 B<NOTE:> This is not a true proper enum type, it is simply
939 a convenient constraint builder.
941 =item B<enum (\@values)>
943 If passed an ARRAY reference instead of the C<$name>, C<@values> pair,
944 this will create an unnamed enum. This can then be used in an attribute
947 has 'sort_order' => (
949 isa => enum([qw[ ascending descending ]]),
954 This is just sugar for the type constraint construction syntax.
958 This is just sugar for the type constraint construction syntax.
960 Takes a block/code ref as an argument. When the type constraint is
961 tested, the supplied code is run with the value to be tested in
962 $_. This block should return true or false to indicate whether or not
963 the constraint check passed.
967 This is just sugar for the type constraint construction syntax.
969 Takes a block/code ref as an argument. When the type constraint fails,
970 then the code block is run (with the value provided in $_). This code
971 ref should return a string, which will be used in the text of the
976 This can be used to define a "hand optimized" version of your
977 type constraint which can be used to avoid traversing a subtype
978 constraint hierarchy.
980 B<NOTE:> You should only use this if you know what you are doing,
981 all the built in types use this, so your subtypes (assuming they
982 are shallow) will not likely need to use this.
986 =head2 Type Coercion Constructors
988 Type constraints can also contain type coercions as well. If you
989 ask your accessor to coerce, then Moose will run the type-coercion
990 code first, followed by the type constraint check. This feature
991 should be used carefully as it is very powerful and could easily
992 take off a limb if you are not careful.
994 See the L<SYNOPSIS> for an example of how to use these.
1002 This is just sugar for the type coercion construction syntax.
1006 This is just sugar for the type coercion construction syntax.
1010 =head2 Type Constraint Construction & Locating
1014 =item B<normalize_type_constraint_name ($type_constraint_name)>
1016 Given a string that is expected to match a type constraint, will normalize the
1017 string so that extra whitespace and newlines are removed.
1019 =item B<create_type_constraint_union ($pipe_separated_types | @type_constraint_names)>
1021 Given string with C<$pipe_separated_types> or a list of C<@type_constraint_names>,
1022 this will return a L<Moose::Meta::TypeConstraint::Union> instance.
1024 =item B<create_parameterized_type_constraint ($type_name)>
1026 Given a C<$type_name> in the form of:
1028 BaseType[ContainerType]
1030 this will extract the base type and container type and build an instance of
1031 L<Moose::Meta::TypeConstraint::Parameterized> for it.
1033 =item B<create_class_type_constraint ($class, ?$options)>
1035 Given a class name it will create a new L<Moose::Meta::TypeConstraint::Class>
1036 object for that class name.
1038 =item B<create_role_type_constraint ($role, ?$options)>
1040 Given a role name it will create a new L<Moose::Meta::TypeConstraint::Role>
1041 object for that role name.
1043 =item B<create_enum_type_constraint ($name, $values)>
1045 =item B<find_or_parse_type_constraint ($type_name)>
1047 This will attempt to find or create a type constraint given the a C<$type_name>.
1048 If it cannot find it in the registry, it will see if it should be a union or
1049 container type an create one if appropriate
1051 =item B<find_or_create_type_constraint ($type_name, ?$options_for_anon_type)>
1053 This function will first call C<find_or_parse_type_constraint> with the type name.
1055 If no type is found or created, but C<$options_for_anon_type> are provided, it
1056 will create the corresponding type.
1058 This was used by the C<does> and C<isa> parameters to L<Moose::Meta::Attribute>
1059 and are now superseded by C<find_or_create_isa_type_constraint> and
1060 C<find_or_create_does_type_constraint>.
1062 =item B<find_or_create_isa_type_constraint ($type_name)>
1064 =item B<find_or_create_does_type_constraint ($type_name)>
1066 Attempts to parse the type name using C<find_or_parse_type_constraint> and if
1067 no appropriate constraint is found will create a new anonymous one.
1069 The C<isa> variant will use C<create_class_type_constraint> and the C<does>
1070 variant will use C<create_role_type_constraint>.
1072 =item B<find_type_constraint ($type_name)>
1074 This function can be used to locate a specific type constraint
1075 meta-object, of the class L<Moose::Meta::TypeConstraint> or a
1076 derivative. What you do with it from there is up to you :)
1078 =item B<register_type_constraint ($type_object)>
1080 This function will register a named type constraint with the type registry.
1082 =item B<get_type_constraint_registry>
1084 Fetch the L<Moose::Meta::TypeConstraint::Registry> object which
1085 keeps track of all type constraints.
1087 =item B<list_all_type_constraints>
1089 This will return a list of type constraint names, you can then
1090 fetch them using C<find_type_constraint ($type_name)> if you
1093 =item B<list_all_builtin_type_constraints>
1095 This will return a list of builtin type constraints, meaning,
1096 those which are defined in this module. See the section
1097 labeled L<Default Type Constraints> for a complete list.
1099 =item B<export_type_constraints_as_functions>
1101 This will export all the current type constraints as functions
1102 into the caller's namespace. Right now, this is mostly used for
1103 testing, but it might prove useful to others.
1105 =item B<get_all_parameterizable_types>
1107 This returns all the parameterizable types that have been registered.
1109 =item B<add_parameterizable_type ($type)>
1111 Adds C<$type> to the list of parameterizable types
1115 =head2 Namespace Management
1121 This will remove all the type constraint keywords from the
1122 calling class namespace.
1128 All complex software has bugs lurking in it, and this module is no
1129 exception. If you find a bug please either email me, or add the bug
1134 Stevan Little E<lt>stevan@iinteractive.comE<gt>
1136 =head1 COPYRIGHT AND LICENSE
1138 Copyright 2006-2009 by Infinity Interactive, Inc.
1140 L<http://www.iinteractive.com>
1142 This library is free software; you can redistribute it and/or modify
1143 it under the same terms as Perl itself.