4 use Mouse::Exporter; # enables strict and warnings
9 use Scalar::Util qw(blessed);
11 use Mouse::Util qw(load_class is_class_loaded get_code_package not_supported);
13 use Mouse::Meta::Module;
14 use Mouse::Meta::Class;
15 use Mouse::Meta::Role;
16 use Mouse::Meta::Attribute;
18 use Mouse::Util::TypeConstraints ();
20 Mouse::Exporter->setup_import_methods(
28 \&Scalar::Util::blessed,
35 Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_);
40 Mouse::Util::apply_all_roles(scalar(caller), @_);
45 my $meta = Mouse::Meta::Class->initialize(scalar caller);
48 $meta->throw_error(q{Usage: has 'name' => ( key => value, ... )})
49 if @_ % 2; # odd number of arguments
51 if(ref $name){ # has [qw(foo bar)] => (...)
53 $meta->add_attribute($_ => @_);
56 else{ # has foo => (...)
57 $meta->add_attribute($name => @_);
63 my $meta = Mouse::Meta::Class->initialize(scalar caller);
68 $meta->add_before_method_modifier($_ => $code);
74 my $meta = Mouse::Meta::Class->initialize(scalar caller);
79 $meta->add_after_method_modifier($_ => $code);
85 my $meta = Mouse::Meta::Class->initialize(scalar caller);
90 $meta->add_around_method_modifier($_ => $code);
100 # This check avoids a recursion loop - see
101 # t/100_bugs/020_super_recursion.t
102 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
103 return if !defined $SUPER_BODY;
104 $SUPER_BODY->(@SUPER_ARGS);
108 # my($name, $method) = @_;
109 Mouse::Meta::Class->initialize(scalar caller)->add_override_method_modifier(@_);
117 if ( my $body = $INNER_BODY{$pkg} ) {
118 my $args = $INNER_ARGS{$pkg};
119 local $INNER_ARGS{$pkg};
120 local $INNER_BODY{$pkg};
121 return $body->(@{$args});
129 #my($name, $method) = @_;
130 Mouse::Meta::Class->initialize(scalar caller)->add_augment_method_modifier(@_);
138 my $class = $args{for_class}
139 or confess("Cannot call init_meta without specifying a for_class");
141 my $base_class = $args{base_class} || 'Mouse::Object';
142 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
144 my $meta = $metaclass->initialize($class);
146 $meta->add_method(meta => sub{
147 return $metaclass->initialize(ref($_[0]) || $_[0]);
150 $meta->superclasses($base_class)
151 unless $meta->superclasses;
153 # make a class type for each Mouse class
154 Mouse::Util::TypeConstraints::class_type($class)
155 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
165 Mouse - Moose minus the antlers
169 This document describes Mouse version 0.42
174 use Mouse; # automatically turns on strict and warnings
176 has 'x' => (is => 'rw', isa => 'Int');
177 has 'y' => (is => 'rw', isa => 'Int');
190 has 'z' => (is => 'rw', isa => 'Int');
192 after 'clear' => sub {
199 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
201 Unfortunately, Moose has a compile-time penalty. Though significant progress
202 has been made over the years, the compile time penalty is a non-starter for
203 some very specific applications. If you are writing a command-line application
204 or CGI script where startup time is essential, you may not be able to use
205 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
208 Mouse aims to alleviate this by providing a subset of Moose's functionality,
211 We're also going as light on dependencies as possible. Mouse currently has
212 B<no dependencies> except for testing modules.
214 =head2 MOOSE COMPATIBILITY
216 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
217 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
218 over 96%. Even the error messages are taken from Moose. The Mouse code just
219 runs the test suite 4x faster.
221 The idea is that, if you need the extra power, you should be able to run
222 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
223 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
224 in which case it will act as Moose. Since Mouse is a little sloppier than
225 Moose, if you run into weird errors, it would be worth running:
227 ANY_MOOSE=Moose perl your-script.pl
229 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
232 See also L<Mouse::Spec> for compatibility and incompatibility with Moose.
236 Please don't copy MooseX code to MouseX. If you need extensions, you really
237 should upgrade to Moose. We don't need two parallel sets of extensions!
239 If you really must write a Mouse extension, please contact the Moose mailing
240 list or #moose on IRC beforehand.
244 =head2 C<< $object->meta -> Mouse::Meta::Class >>
246 Returns this class' metaclass instance.
248 =head2 C<< extends superclasses >>
250 Sets this class' superclasses.
252 =head2 C<< before (method|methods) => CodeRef >>
254 Installs a "before" method modifier. See L<Moose/before>.
256 =head2 C<< after (method|methods) => CodeRef >>
258 Installs an "after" method modifier. See L<Moose/after>.
260 =head2 C<< around (method|methods) => CodeRef >>
262 Installs an "around" method modifier. See L<Moose/around>.
264 =head2 C<< has (name|names) => parameters >>
266 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
271 =item C<< is => ro|rw|bare >>
273 If specified, inlines a read-only/read-write accessor with the same name as
276 =item C<< isa => TypeConstraint >>
278 Provides type checking in the constructor and accessor. The following types are
279 supported. Any unknown type is taken to be a class check
280 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
282 Any Item Bool Undef Defined Value Num Int Str ClassName
283 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
286 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
289 =item C<< required => Bool >>
291 Whether this attribute is required to have a value. If the attribute is lazy or
292 has a builder, then providing a value for the attribute in the constructor is
295 =item C<< init_arg => Str | Undef >>
297 Allows you to use a different key name in the constructor. If undef, the
298 attribute can't be passed to the constructor.
300 =item C<< default => Value | CodeRef >>
302 Sets the default value of the attribute. If the default is a coderef, it will
303 be invoked to get the default value. Due to quirks of Perl, any bare reference
304 is forbidden, you must wrap the reference in a coderef. Otherwise, all
305 instances will share the same reference.
307 =item C<< lazy => Bool >>
309 If specified, the default is calculated on demand instead of in the
312 =item C<< predicate => Str >>
314 Lets you specify a method name for installing a predicate method, which checks
315 that the attribute has a value. It will not invoke a lazy default or builder
318 =item C<< clearer => Str >>
320 Lets you specify a method name for installing a clearer method, which clears
321 the attribute's value from the instance. On the next read, lazy or builder will
324 =item C<< handles => HashRef|ArrayRef >>
326 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
327 given method names to method calls on the attribute. HashRef maps local method
328 names to remote method names called on the attribute. Other forms of
329 L</handles>, such as regular expression and coderef, are not yet supported.
331 =item C<< weak_ref => Bool >>
333 Lets you automatically weaken any reference stored in the attribute.
335 Use of this feature requires L<Scalar::Util>!
337 =item C<< trigger => CodeRef >>
339 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.
341 =item C<< builder => Str >>
343 Defines a method name to be called to provide the default value of the
344 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
345 C<< default => sub { $_[0]->build_foo } >>.
347 =item C<< auto_deref => Bool >>
349 Allows you to automatically dereference ArrayRef and HashRef attributes in list
350 context. In scalar context, the reference is returned (NOT the list length or
351 bucket status). You must specify an appropriate type constraint to use
354 =item C<< lazy_build => Bool >>
356 Automatically define the following options:
361 builder => "_build_$attr",
362 clearer => "clear_$attr",
363 predicate => "has_$attr",
368 =head2 C<< confess(message) -> BOOM >>
370 L<Carp/confess> for your convenience.
372 =head2 C<< blessed(value) -> ClassName | undef >>
374 L<Scalar::Util/blessed> for your convenience.
380 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
381 You may use L</extends> to replace the superclass list.
385 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
386 keywords (such as L</extends>) it will break loudly instead breaking subtly.
388 =head1 SOURCE CODE ACCESS
390 We have a public git repository:
392 git clone git://git.moose.perl.org/Mouse.git
412 Shawn M Moore E<lt>sartak at gmail.comE<gt>
414 Yuval Kogman E<lt>nothingmuch at woobling.orgE<gt>
422 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
424 with plenty of code borrowed from L<Class::MOP> and L<Moose>
428 All complex software has bugs lurking in it, and this module is no exception.
429 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
430 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
432 =head1 COPYRIGHT AND LICENSE
434 Copyright 2008-2009 Infinity Interactive, Inc.
436 http://www.iinteractive.com/
438 This program is free software; you can redistribute it and/or modify it
439 under the same terms as Perl itself.