10 use Scalar::Util 'blessed';
13 use Mouse::Meta::Attribute;
14 use Mouse::Meta::Class;
16 use Mouse::Util::TypeConstraints;
18 our @EXPORT = qw(extends has before after around override super blessed confess with);
20 our %is_removable = map{ $_ => undef } @EXPORT;
21 delete $is_removable{blessed};
22 delete $is_removable{confess};
24 sub extends { Mouse::Meta::Class->initialize(caller)->superclasses(@_) }
27 my $meta = Mouse::Meta::Class->initialize(caller);
28 $meta->add_attribute(@_);
32 my $meta = Mouse::Meta::Class->initialize(caller);
37 $meta->add_before_method_modifier($_ => $code);
42 my $meta = Mouse::Meta::Class->initialize(caller);
47 $meta->add_after_method_modifier($_ => $code);
52 my $meta = Mouse::Meta::Class->initialize(caller);
57 $meta->add_around_method_modifier($_ => $code);
62 Mouse::Util::apply_all_roles((caller)[0], @_);
70 # This check avoids a recursion loop - see
71 # t/100_bugs/020_super_recursion.t
72 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
73 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
77 my $meta = Mouse::Meta::Class->initialize(caller);
78 my $pkg = $meta->name;
83 my $body = $pkg->can($name)
84 or confess "You cannot override '$name' because it has no super method";
86 $meta->add_method($name => sub {
87 local $SUPER_PACKAGE = $pkg;
88 local @SUPER_ARGS = @_;
89 local $SUPER_BODY = $body;
96 # This used to be called as a function. This hack preserves
97 # backwards compatibility.
98 if ( $_[0] ne __PACKAGE__ ) {
99 return __PACKAGE__->init_meta(
109 my $class = $args{for_class}
111 "Cannot call init_meta without specifying a for_class");
112 my $base_class = $args{base_class} || 'Mouse::Object';
113 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
115 Carp::croak("The Metaclass $metaclass must be a subclass of Mouse::Meta::Class.")
116 unless $metaclass->isa('Mouse::Meta::Class');
118 # make a subtype for each Mouse class
120 unless find_type_constraint($class);
122 my $meta = $metaclass->initialize($class);
123 $meta->superclasses($base_class)
124 unless $meta->superclasses;
126 $meta->add_method(meta => sub{
127 return Mouse::Meta::Class->initialize(ref($_[0]) || $_[0]);
141 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
147 my $level = delete $opts->{into_level};
148 $level = 0 unless defined $level;
149 my $caller = caller($level);
151 # we should never export to main
152 if ($caller eq 'main') {
153 warn qq{$class does not export its sugar to the 'main' package.\n};
158 for_class => $caller,
162 __PACKAGE__->export_to_level( $level+1, $class, @_);
164 # shortcut for the common case of no type character
166 for my $keyword (@EXPORT) {
167 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
180 for my $keyword (@EXPORT) {
182 if(exists $is_removable{$keyword}
183 && ($code = $caller->can($keyword))
184 && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
186 delete $stash->{$keyword};
194 if (!Mouse::Util::is_valid_class_name($class)) {
195 my $display = defined($class) ? $class : 'undef';
196 confess "Invalid class name ($display)";
199 return 1 if is_class_loaded($class);
201 (my $file = "$class.pm") =~ s{::}{/}g;
203 eval { CORE::require($file) };
204 confess "Could not load class ($class) because : $@" if $@;
209 my %is_class_loaded_cache;
210 sub is_class_loaded {
213 return 0 if ref($class) || !defined($class) || !length($class);
215 return 1 if exists $is_class_loaded_cache{$class};
217 # walk the symbol table tree to avoid autovififying
218 # \*{${main::}{"Foo::"}} == \*main::Foo::
221 foreach my $part (split('::', $class)) {
222 return 0 unless exists ${$$pack}{"${part}::"};
223 $pack = \*{${$$pack}{"${part}::"}};
226 # check for $VERSION or @ISA
227 return ++$is_class_loaded_cache{$class} if exists ${$$pack}{VERSION}
228 && defined *{${$$pack}{VERSION}}{SCALAR};
229 return ++$is_class_loaded_cache{$class} if exists ${$$pack}{ISA}
230 && defined *{${$$pack}{ISA}}{ARRAY};
232 # check for any method
233 foreach ( keys %{$$pack} ) {
234 next if substr($_, -2, 2) eq '::';
235 return ++$is_class_loaded_cache{$class} if defined *{${$$pack}{$_}}{CODE};
243 return Mouse::Meta::Class::class_of($_[0]);
252 Mouse - Moose minus the antlers
257 use Mouse; # automatically turns on strict and warnings
259 has 'x' => (is => 'rw', isa => 'Int');
260 has 'y' => (is => 'rw', isa => 'Int');
273 has 'z' => (is => 'rw', isa => 'Int');
275 after 'clear' => sub {
282 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
284 Unfortunately, Moose has a compile-time penalty. Though significant progress
285 has been made over the years, the compile time penalty is a non-starter for
286 some very specific applications. If you are writing a command-line application
287 or CGI script where startup time is essential, you may not be able to use
288 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
291 Mouse aims to alleviate this by providing a subset of Moose's functionality,
294 We're also going as light on dependencies as possible.
295 L<Class::Method::Modifiers::Fast> or L<Class::Method::Modifiers> is required
296 if you want support for L</before>, L</after>, and L</around>.
300 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
301 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
302 over 96%. Even the error messages are taken from Moose. The Mouse code just
303 runs the test suite 4x faster.
305 The idea is that, if you need the extra power, you should be able to run
306 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
307 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
308 in which case it will act as Moose. Since Mouse is a little sloppier than
309 Moose, if you run into weird errors, it would be worth running:
311 ANY_MOOSE=Moose perl your-script.pl
313 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
318 Please don't copy MooseX code to MouseX. If you need extensions, you really
319 should upgrade to Moose. We don't need two parallel sets of extensions!
321 If you really must write a Mouse extension, please contact the Moose mailing
322 list or #moose on IRC beforehand.
326 The original author of this module has mostly stepped down from maintaining
327 Mouse. See L<http://www.nntp.perl.org/group/perl.moose/2009/04/msg653.html>.
328 If you would like to help maintain this module, please get in touch with us.
332 =head2 meta -> Mouse::Meta::Class
334 Returns this class' metaclass instance.
336 =head2 extends superclasses
338 Sets this class' superclasses.
340 =head2 before (method|methods) => Code
342 Installs a "before" method modifier. See L<Moose/before> or
343 L<Class::Method::Modifiers/before>.
345 Use of this feature requires L<Class::Method::Modifiers>!
347 =head2 after (method|methods) => Code
349 Installs an "after" method modifier. See L<Moose/after> or
350 L<Class::Method::Modifiers/after>.
352 Use of this feature requires L<Class::Method::Modifiers>!
354 =head2 around (method|methods) => Code
356 Installs an "around" method modifier. See L<Moose/around> or
357 L<Class::Method::Modifiers/around>.
359 Use of this feature requires L<Class::Method::Modifiers>!
361 =head2 has (name|names) => parameters
363 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
370 If specified, inlines a read-only/read-write accessor with the same name as
373 =item isa => TypeConstraint
375 Provides type checking in the constructor and accessor. The following types are
376 supported. Any unknown type is taken to be a class check (e.g. isa =>
377 'DateTime' would accept only L<DateTime> objects).
379 Any Item Bool Undef Defined Value Num Int Str ClassName
380 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
383 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
386 =item required => 0|1
388 Whether this attribute is required to have a value. If the attribute is lazy or
389 has a builder, then providing a value for the attribute in the constructor is
392 =item init_arg => Str | Undef
394 Allows you to use a different key name in the constructor. If undef, the
395 attribue can't be passed to the constructor.
397 =item default => Value | CodeRef
399 Sets the default value of the attribute. If the default is a coderef, it will
400 be invoked to get the default value. Due to quirks of Perl, any bare reference
401 is forbidden, you must wrap the reference in a coderef. Otherwise, all
402 instances will share the same reference.
406 If specified, the default is calculated on demand instead of in the
409 =item predicate => Str
411 Lets you specify a method name for installing a predicate method, which checks
412 that the attribute has a value. It will not invoke a lazy default or builder
417 Lets you specify a method name for installing a clearer method, which clears
418 the attribute's value from the instance. On the next read, lazy or builder will
421 =item handles => HashRef|ArrayRef
423 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
424 given method names to method calls on the attribute. HashRef maps local method
425 names to remote method names called on the attribute. Other forms of
426 L</handles>, such as regular expression and coderef, are not yet supported.
428 =item weak_ref => 0|1
430 Lets you automatically weaken any reference stored in the attribute.
432 Use of this feature requires L<Scalar::Util>!
434 =item trigger => CodeRef
436 Any time the attribute's value is set (either through the accessor or the constructor), the trigger is called on it. The trigger receives as arguments the instance, the new value, and the attribute instance.
438 Mouse 0.05 supported more complex triggers, but this behavior is now removed.
442 Defines a method name to be called to provide the default value of the
443 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
444 C<< default => sub { $_[0]->build_foo } >>.
446 =item auto_deref => 0|1
448 Allows you to automatically dereference ArrayRef and HashRef attributes in list
449 context. In scalar context, the reference is returned (NOT the list length or
450 bucket status). You must specify an appropriate type constraint to use
453 =item lazy_build => 0|1
455 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
456 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
460 =head2 confess error -> BOOM
462 L<Carp/confess> for your convenience.
464 =head2 blessed value -> ClassName | undef
466 L<Scalar::Util/blessed> for your convenience.
472 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
473 You may use L</extends> to replace the superclass list.
477 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
478 keywords (such as L</extends>) it will break loudly instead breaking subtly.
482 =head2 load_class Class::Name
484 This will load a given C<Class::Name> (or die if it's not loadable).
485 This function can be used in place of tricks like
486 C<eval "use $module"> or using C<require>.
488 =head2 is_class_loaded Class::Name -> Bool
490 Returns whether this class is actually loaded or not. It uses a heuristic which
491 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
492 locally-defined method.
494 =head1 SOURCE CODE ACCESS
496 We have a public git repo:
498 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
502 Shawn M Moore, C<< <sartak at gmail.com> >>
504 Yuval Kogman, C<< <nothingmuch at woobling.org> >>
512 with plenty of code borrowed from L<Class::MOP> and L<Moose>
516 There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
517 this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
518 to resolve these tests are more than welcome.
520 Please report any bugs through RT: email
521 C<bug-mouse at rt.cpan.org>, or browse
522 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
524 =head1 COPYRIGHT AND LICENSE
526 Copyright 2008-2009 Infinity Interactive, Inc.
528 http://www.iinteractive.com/
530 This program is free software; you can redistribute it and/or modify it
531 under the same terms as Perl itself.