4 use Mouse::Exporter; # enables strict and warnings
9 use Scalar::Util qw(blessed);
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);
65 for my $name($meta->_collect_methods(@_)) {
66 $meta->add_before_method_modifier($name => $code);
72 my $meta = Mouse::Meta::Class->initialize(scalar caller);
74 for my $name($meta->_collect_methods(@_)) {
75 $meta->add_after_method_modifier($name => $code);
81 my $meta = Mouse::Meta::Class->initialize(scalar caller);
83 for my $name($meta->_collect_methods(@_)) {
84 $meta->add_around_method_modifier($name => $code);
94 # This check avoids a recursion loop - see
95 # t/100_bugs/020_super_recursion.t
96 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
97 return if !defined $SUPER_BODY;
98 $SUPER_BODY->(@SUPER_ARGS);
102 # my($name, $method) = @_;
103 Mouse::Meta::Class->initialize(scalar caller)->add_override_method_modifier(@_);
111 if ( my $body = $INNER_BODY{$pkg} ) {
112 my $args = $INNER_ARGS{$pkg};
113 local $INNER_ARGS{$pkg};
114 local $INNER_BODY{$pkg};
115 return $body->(@{$args});
123 #my($name, $method) = @_;
124 Mouse::Meta::Class->initialize(scalar caller)->add_augment_method_modifier(@_);
132 my $class = $args{for_class}
133 or confess("Cannot call init_meta without specifying a for_class");
135 my $base_class = $args{base_class} || 'Mouse::Object';
136 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
138 my $meta = $metaclass->initialize($class);
140 $meta->add_method(meta => sub{
141 return $metaclass->initialize(ref($_[0]) || $_[0]);
144 $meta->superclasses($base_class)
145 unless $meta->superclasses;
147 # make a class type for each Mouse class
148 Mouse::Util::TypeConstraints::class_type($class)
149 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
159 Mouse - Moose minus the antlers
163 This document describes Mouse version 0.51
168 use Mouse; # automatically turns on strict and warnings
170 has 'x' => (is => 'rw', isa => 'Int');
171 has 'y' => (is => 'rw', isa => 'Int');
180 __PACKAGE__->meta->make_immutable();
187 has 'z' => (is => 'rw', isa => 'Int');
189 after 'clear' => sub {
194 __PACKAGE__->meta->make_immutable();
198 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
200 Unfortunately, Moose has a compile-time penalty. Though significant progress
201 has been made over the years, the compile time penalty is a non-starter for
202 some very specific applications. If you are writing a command-line application
203 or CGI script where startup time is essential, you may not be able to use
204 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
207 Mouse aims to alleviate this by providing a subset of Moose's functionality,
210 We're also going as light on dependencies as possible. Mouse currently has
211 B<no dependencies> except for testing modules.
213 =head2 MOOSE COMPATIBILITY
215 Compatibility with Moose has been the utmost concern. The sugary interface is
216 highly compatible with Moose. Even the error messages are taken from Moose.
217 The Mouse code just runs the test suite 4x faster.
219 The idea is that, if you need the extra power, you should be able to run
220 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
221 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
222 in which case it will act as Moose. Since Mouse is a little sloppier than
223 Moose, if you run into weird errors, it would be worth running:
225 ANY_MOOSE=Moose perl your-script.pl
227 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
230 See also L<Mouse::Spec> for compatibility and incompatibility with Moose.
234 Please don't copy MooseX code to MouseX. If you need extensions, you really
235 should upgrade to Moose. We don't need two parallel sets of extensions!
237 If you really must write a Mouse extension, please contact the Moose mailing
238 list or #moose on IRC beforehand.
242 =head2 C<< $object->meta -> Mouse::Meta::Class >>
244 Returns this class' metaclass instance.
246 =head2 C<< extends superclasses >>
248 Sets this class' superclasses.
250 =head2 C<< before (method|methods|regexp) => CodeRef >>
252 Installs a "before" method modifier. See L<Moose/before>.
254 =head2 C<< after (method|methods|regexp) => CodeRef >>
256 Installs an "after" method modifier. See L<Moose/after>.
258 =head2 C<< around (method|methods|regexp) => CodeRef >>
260 Installs an "around" method modifier. See L<Moose/around>.
262 =head2 C<< has (name|names) => parameters >>
264 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
269 =item C<< is => ro|rw|bare >>
271 The I<is> option accepts either I<rw> (for read/write), I<ro> (for read
272 only) or I<bare> (for nothing). These will create either a read/write accessor
273 or a read-only accessor respectively, using the same name as the C<$name> of
276 If you need more control over how your accessors are named, you can
277 use the C<reader>, C<writer> and C<accessor> options, however if you
278 use those, you won't need the I<is> option.
280 =item C<< isa => TypeName | ClassName >>
282 Provides type checking in the constructor and accessor. The following types are
283 supported. Any unknown type is taken to be a class check
284 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
286 Any Item Bool Undef Defined Value Num Int Str ClassName
287 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
290 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
292 =item C<< does => RoleName >>
294 This will accept the name of a role which the value stored in this attribute
295 is expected to have consumed.
297 =item C<< coerce => Bool >>
299 This will attempt to use coercion with the supplied type constraint to change
300 the value passed into any accessors or constructors. You B<must> have supplied
301 a type constraint in order for this to work. See L<Moose::Cookbook::Basics::Recipe5>
304 =item C<< required => Bool >>
306 Whether this attribute is required to have a value. If the attribute is lazy or
307 has a builder, then providing a value for the attribute in the constructor is
310 =item C<< init_arg => Str | Undef >>
312 Allows you to use a different key name in the constructor. If undef, the
313 attribute can't be passed to the constructor.
315 =item C<< default => Value | CodeRef >>
317 Sets the default value of the attribute. If the default is a coderef, it will
318 be invoked to get the default value. Due to quirks of Perl, any bare reference
319 is forbidden, you must wrap the reference in a coderef. Otherwise, all
320 instances will share the same reference.
322 =item C<< lazy => Bool >>
324 If specified, the default is calculated on demand instead of in the
327 =item C<< predicate => Str >>
329 Lets you specify a method name for installing a predicate method, which checks
330 that the attribute has a value. It will not invoke a lazy default or builder
333 =item C<< clearer => Str >>
335 Lets you specify a method name for installing a clearer method, which clears
336 the attribute's value from the instance. On the next read, lazy or builder will
339 =item C<< handles => HashRef|ArrayRef|Regexp >>
341 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
342 given method names to method calls on the attribute. HashRef maps local method
343 names to remote method names called on the attribute. Other forms of
344 L</handles>, such as RoleName and CodeRef, are not yet supported.
346 =item C<< weak_ref => Bool >>
348 Lets you automatically weaken any reference stored in the attribute.
350 Use of this feature requires L<Scalar::Util>!
352 =item C<< trigger => CodeRef >>
354 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.
356 =item C<< builder => Str >>
358 Defines a method name to be called to provide the default value of the
359 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
360 C<< default => sub { $_[0]->build_foo } >>.
362 =item C<< auto_deref => Bool >>
364 Allows you to automatically dereference ArrayRef and HashRef attributes in list
365 context. In scalar context, the reference is returned (NOT the list length or
366 bucket status). You must specify an appropriate type constraint to use
369 =item C<< lazy_build => Bool >>
371 Automatically define the following options:
376 builder => "_build_$attr",
377 clearer => "clear_$attr",
378 predicate => "has_$attr",
383 =head2 C<< confess(message) -> BOOM >>
385 L<Carp/confess> for your convenience.
387 =head2 C<< blessed(value) -> ClassName | undef >>
389 L<Scalar::Util/blessed> for your convenience.
395 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
396 You may use L</extends> to replace the superclass list.
400 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
401 keywords (such as L</extends>) it will break loudly instead breaking subtly.
405 If you use Mouse::XS you might see a fatal error on callbacks
406 which include C<eval 'BEGIN{ die }'>, which typically occurs in such code
407 as C<eval 'use NotInstalledModule'>. This is not
408 a bug in Mouse. In fact, it is a bug in Perl (RT #69939).
410 To work around this problem, surround C<eval STRING> with C<eval BLOCK>:
413 # eval 'use NotInstalledModule'; # NG
414 eval{ eval 'use NotInstalledModule' }; # OK
417 It seems ridiculous, but it works as you expected.
419 =head1 SOURCE CODE ACCESS
421 We have a public git repository:
423 git clone git://git.moose.perl.org/Mouse.git
443 Shawn M Moore E<lt>sartak at gmail.comE<gt>
445 Yuval Kogman E<lt>nothingmuch at woobling.orgE<gt>
453 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
455 with plenty of code borrowed from L<Class::MOP> and L<Moose>
459 All complex software has bugs lurking in it, and this module is no exception.
460 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
461 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
463 =head1 COPYRIGHT AND LICENSE
465 Copyright (c) 2008-2010 Infinity Interactive, Inc.
467 http://www.iinteractive.com/
469 This program is free software; you can redistribute it and/or modify it
470 under the same terms as Perl itself.