4 use Mouse::Exporter; # enables strict and warnings
6 our $VERSION = '0.40_08';
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,
33 # XXX: for backward compatibility
43 sub extends { Mouse::Meta::Class->initialize(scalar caller)->superclasses(@_) }
46 my $meta = Mouse::Meta::Class->initialize(scalar caller);
49 $meta->throw_error(q{Usage: has 'name' => ( key => value, ... )})
\r
50 if @_ % 2; # odd number of arguments
52 $meta->add_attribute($_ => @_) for ref($name) ? @{$name} : $name;
56 my $meta = Mouse::Meta::Class->initialize(scalar caller);
61 $meta->add_before_method_modifier($_ => $code);
66 my $meta = Mouse::Meta::Class->initialize(scalar caller);
71 $meta->add_after_method_modifier($_ => $code);
76 my $meta = Mouse::Meta::Class->initialize(scalar caller);
81 $meta->add_around_method_modifier($_ => $code);
86 Mouse::Util::apply_all_roles(scalar(caller), @_);
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(@_);
131 my $class = $args{for_class}
132 or confess("Cannot call init_meta without specifying a for_class");
134 my $base_class = $args{base_class} || 'Mouse::Object';
135 my $metaclass = $args{metaclass} || 'Mouse::Meta::Class';
137 my $meta = $metaclass->initialize($class);
139 $meta->add_method(meta => sub{
140 return $metaclass->initialize(ref($_[0]) || $_[0]);
143 $meta->superclasses($base_class)
144 unless $meta->superclasses;
146 # make a class type for each Mouse class
147 Mouse::Util::TypeConstraints::class_type($class)
148 unless Mouse::Util::TypeConstraints::find_type_constraint($class);
159 Mouse - Moose minus the antlers
163 This document describes Mouse version 0.40_08
168 use Mouse; # automatically turns on strict and warnings
170 has 'x' => (is => 'rw', isa => 'Int');
171 has 'y' => (is => 'rw', isa => 'Int');
184 has 'z' => (is => 'rw', isa => 'Int');
186 after 'clear' => sub {
193 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
195 Unfortunately, Moose has a compile-time penalty. Though significant progress
196 has been made over the years, the compile time penalty is a non-starter for
197 some very specific applications. If you are writing a command-line application
198 or CGI script where startup time is essential, you may not be able to use
199 Moose. We recommend that you instead use L<HTTP::Engine> and FastCGI for the
202 Mouse aims to alleviate this by providing a subset of Moose's functionality,
205 We're also going as light on dependencies as possible. Mouse currently has
206 B<no dependencies> except for testing modules.
208 =head2 MOOSE COMPATIBILITY
210 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
211 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
212 over 96%. Even the error messages are taken from Moose. The Mouse code just
213 runs the test suite 4x faster.
215 The idea is that, if you need the extra power, you should be able to run
216 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
217 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
218 in which case it will act as Moose. Since Mouse is a little sloppier than
219 Moose, if you run into weird errors, it would be worth running:
221 ANY_MOOSE=Moose perl your-script.pl
223 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
226 See also L<Mouse::Spec> for compatibility and incompatibility with Moose.
230 Please don't copy MooseX code to MouseX. If you need extensions, you really
231 should upgrade to Moose. We don't need two parallel sets of extensions!
233 If you really must write a Mouse extension, please contact the Moose mailing
234 list or #moose on IRC beforehand.
238 =head2 C<< $object->meta -> Mouse::Meta::Class >>
240 Returns this class' metaclass instance.
242 =head2 C<< extends superclasses >>
244 Sets this class' superclasses.
246 =head2 C<< before (method|methods) => CodeRef >>
248 Installs a "before" method modifier. See L<Moose/before> or
249 L<Class::Method::Modifiers/before>.
251 Use of this feature requires L<Class::Method::Modifiers>!
253 =head2 C<< after (method|methods) => CodeRef >>
255 Installs an "after" method modifier. See L<Moose/after> or
256 L<Class::Method::Modifiers/after>.
258 Use of this feature requires L<Class::Method::Modifiers>!
260 =head2 C<< around (method|methods) => CodeRef >>
262 Installs an "around" method modifier. See L<Moose/around> or
263 L<Class::Method::Modifiers/around>.
265 Use of this feature requires L<Class::Method::Modifiers>!
267 =head2 C<< has (name|names) => parameters >>
269 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
274 =item C<< is => ro|rw|bare >>
276 If specified, inlines a read-only/read-write accessor with the same name as
279 =item C<< isa => TypeConstraint >>
281 Provides type checking in the constructor and accessor. The following types are
282 supported. Any unknown type is taken to be a class check
283 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
285 Any Item Bool Undef Defined Value Num Int Str ClassName
286 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
289 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
292 =item C<< required => Bool >>
294 Whether this attribute is required to have a value. If the attribute is lazy or
295 has a builder, then providing a value for the attribute in the constructor is
298 =item C<< init_arg => Str | Undef >>
300 Allows you to use a different key name in the constructor. If undef, the
301 attribute can't be passed to the constructor.
303 =item C<< default => Value | CodeRef >>
305 Sets the default value of the attribute. If the default is a coderef, it will
306 be invoked to get the default value. Due to quirks of Perl, any bare reference
307 is forbidden, you must wrap the reference in a coderef. Otherwise, all
308 instances will share the same reference.
310 =item C<< lazy => Bool >>
312 If specified, the default is calculated on demand instead of in the
315 =item C<< predicate => Str >>
317 Lets you specify a method name for installing a predicate method, which checks
318 that the attribute has a value. It will not invoke a lazy default or builder
321 =item C<< clearer => Str >>
323 Lets you specify a method name for installing a clearer method, which clears
324 the attribute's value from the instance. On the next read, lazy or builder will
327 =item C<< handles => HashRef|ArrayRef >>
329 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
330 given method names to method calls on the attribute. HashRef maps local method
331 names to remote method names called on the attribute. Other forms of
332 L</handles>, such as regular expression and coderef, are not yet supported.
334 =item C<< weak_ref => Bool >>
336 Lets you automatically weaken any reference stored in the attribute.
338 Use of this feature requires L<Scalar::Util>!
340 =item C<< trigger => CodeRef >>
342 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.
344 =item C<< builder => Str >>
346 Defines a method name to be called to provide the default value of the
347 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
348 C<< default => sub { $_[0]->build_foo } >>.
350 =item C<< auto_deref => Bool >>
352 Allows you to automatically dereference ArrayRef and HashRef attributes in list
353 context. In scalar context, the reference is returned (NOT the list length or
354 bucket status). You must specify an appropriate type constraint to use
357 =item C<< lazy_build => Bool >>
359 Automatically define the following options:
364 builder => "_build_$attr",
365 clearer => "clear_$attr",
366 predicate => "has_$attr",
371 =head2 C<< confess(message) -> BOOM >>
373 L<Carp/confess> for your convenience.
375 =head2 C<< blessed(value) -> ClassName | undef >>
377 L<Scalar::Util/blessed> for your convenience.
383 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
384 You may use L</extends> to replace the superclass list.
388 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
389 keywords (such as L</extends>) it will break loudly instead breaking subtly.
391 =head1 SOURCE CODE ACCESS
393 We have a public git repository:
395 git clone git://git.moose.perl.org/Mouse.git
411 Shawn M Moore E<lt>sartak at gmail.comE<gt>
413 Yuval Kogman E<lt>nothingmuch at woobling.orgE<gt>
421 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
423 with plenty of code borrowed from L<Class::MOP> and L<Moose>
427 All complex software has bugs lurking in it, and this module is no exception.
428 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
429 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
431 =head1 COPYRIGHT AND LICENSE
433 Copyright 2008-2009 Infinity Interactive, Inc.
435 http://www.iinteractive.com/
437 This program is free software; you can redistribute it and/or modify it
438 under the same terms as Perl itself.