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.70
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|Moose> is a postmodern object system for Perl5. Moose is wonderful.
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 persistent Perl executing environments
205 like C<FastCGI> for the latter, if possible.
207 Mouse is a Moose compatible object system, which aims to alleviate this by
208 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. Mouse also works without XS,
212 although it has an XS backend to make it much faster.
214 =head2 MOOSE COMPATIBILITY
216 Compatibility with Moose has been the utmost concern. The sugary interface is
217 highly compatible with Moose. Even the error messages are taken from Moose.
218 The Mouse code just runs the test suite 4x faster.
220 The idea is that, if you need the extra power, you should be able to run
221 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
222 we have written L<Any::Moose|Any::Moose> which will act as Mouse unless Moose is loaded,
223 in which case it will act as Moose. Since Mouse is a little sloppier than
224 Moose, if you run into weird errors, it would be worth running:
226 ANY_MOOSE=Moose perl your-script.pl
228 to see if the bug is caused by Mouse. Moose's diagnostics and validation are
231 See also L<Mouse::Spec> for compatibility and incompatibility with Moose.
235 Please don't copy MooseX code to MouseX. If you need extensions, you really
236 should upgrade to Moose. We don't need two parallel sets of extensions!
238 If you really must write a Mouse extension, please contact the Moose mailing
239 list or #moose on IRC beforehand.
243 =head2 C<< $object->meta -> Mouse::Meta::Class >>
245 Returns this class' metaclass instance.
247 =head2 C<< extends superclasses >>
249 Sets this class' superclasses.
251 =head2 C<< before (method|methods|regexp) => CodeRef >>
253 Installs a "before" method modifier. See L<Moose/before>.
255 =head2 C<< after (method|methods|regexp) => CodeRef >>
257 Installs an "after" method modifier. See L<Moose/after>.
259 =head2 C<< around (method|methods|regexp) => CodeRef >>
261 Installs an "around" method modifier. See L<Moose/around>.
263 =head2 C<< has (name|names) => parameters >>
265 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
270 =item C<< is => ro|rw|bare >>
272 The I<is> option accepts either I<rw> (for read/write), I<ro> (for read
273 only) or I<bare> (for nothing). These will create either a read/write accessor
274 or a read-only accessor respectively, using the same name as the C<$name> of
277 If you need more control over how your accessors are named, you can
278 use the C<reader>, C<writer> and C<accessor> options, however if you
279 use those, you won't need the I<is> option.
281 =item C<< isa => TypeName | ClassName >>
283 Provides type checking in the constructor and accessor. The following types are
284 supported. Any unknown type is taken to be a class check
285 (e.g. C<< isa => 'DateTime' >> would accept only L<DateTime> objects).
287 Any Item Bool Undef Defined Value Num Int Str ClassName
288 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
291 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
293 =item C<< does => RoleName >>
295 This will accept the name of a role which the value stored in this attribute
296 is expected to have consumed.
298 =item C<< coerce => Bool >>
300 This will attempt to use coercion with the supplied type constraint to change
301 the value passed into any accessors or constructors. You B<must> have supplied
302 a type constraint in order for this to work. See L<Moose::Cookbook::Basics::Recipe5>
305 =item C<< required => Bool >>
307 Whether this attribute is required to have a value. If the attribute is lazy or
308 has a builder, then providing a value for the attribute in the constructor is
311 =item C<< init_arg => Str | Undef >>
313 Allows you to use a different key name in the constructor. If undef, the
314 attribute can't be passed to the constructor.
316 =item C<< default => Value | CodeRef >>
318 Sets the default value of the attribute. If the default is a coderef, it will
319 be invoked to get the default value. Due to quirks of Perl, any bare reference
320 is forbidden, you must wrap the reference in a coderef. Otherwise, all
321 instances will share the same reference.
323 =item C<< lazy => Bool >>
325 If specified, the default is calculated on demand instead of in the
328 =item C<< predicate => Str >>
330 Lets you specify a method name for installing a predicate method, which checks
331 that the attribute has a value. It will not invoke a lazy default or builder
334 =item C<< clearer => Str >>
336 Lets you specify a method name for installing a clearer method, which clears
337 the attribute's value from the instance. On the next read, lazy or builder will
340 =item C<< handles => HashRef|ArrayRef|Regexp >>
342 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
343 given method names to method calls on the attribute. HashRef maps local method
344 names to remote method names called on the attribute. Other forms of
345 L</handles>, such as RoleName and CodeRef, are not yet supported.
347 =item C<< weak_ref => Bool >>
349 Lets you automatically weaken any reference stored in the attribute.
351 Use of this feature requires L<Scalar::Util>!
353 =item C<< trigger => CodeRef >>
355 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.
357 =item C<< builder => Str >>
359 Defines a method name to be called to provide the default value of the
360 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
361 C<< default => sub { $_[0]->build_foo } >>.
363 =item C<< auto_deref => Bool >>
365 Allows you to automatically dereference ArrayRef and HashRef attributes in list
366 context. In scalar context, the reference is returned (NOT the list length or
367 bucket status). You must specify an appropriate type constraint to use
370 =item C<< lazy_build => Bool >>
372 Automatically define the following options:
377 builder => "_build_$attr",
378 clearer => "clear_$attr",
379 predicate => "has_$attr",
384 =head2 C<< confess(message) -> BOOM >>
386 L<Carp/confess> for your convenience.
388 =head2 C<< blessed(value) -> ClassName | undef >>
390 L<Scalar::Util/blessed> for your convenience.
396 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
397 You may use L</extends> to replace the superclass list.
401 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
402 keywords (such as L</extends>) it will break loudly instead breaking subtly.
404 =head1 SOURCE CODE ACCESS
406 We have a public git repository:
408 git clone git://git.moose.perl.org/Mouse.git
428 Shawn M Moore E<lt>sartak at gmail.comE<gt>
430 Yuval Kogman E<lt>nothingmuch at woobling.orgE<gt>
438 Goro Fuji (gfx) E<lt>gfuji at cpan.orgE<gt>
440 with plenty of code borrowed from L<Class::MOP> and L<Moose>
444 All complex software has bugs lurking in it, and this module is no exception.
445 Please report any bugs to C<bug-mouse at rt.cpan.org>, or through the web
446 interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=Mouse>
448 =head1 COPYRIGHT AND LICENSE
450 Copyright (c) 2008-2010 Infinity Interactive, Inc.
452 http://www.iinteractive.com/
454 This program is free software; you can redistribute it and/or modify it
455 under the same terms as Perl itself.