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 sub extends { Mouse::Meta::Class->initialize(caller)->superclasses(@_) }
23 my $meta = Mouse::Meta::Class->initialize(caller);
24 $meta->add_attribute(@_);
28 my $meta = Mouse::Meta::Class->initialize(caller);
33 $meta->add_before_method_modifier($_ => $code);
38 my $meta = Mouse::Meta::Class->initialize(caller);
43 $meta->add_after_method_modifier($_ => $code);
48 my $meta = Mouse::Meta::Class->initialize(caller);
53 $meta->add_around_method_modifier($_ => $code);
58 Mouse::Util::apply_all_roles((caller)[0], @_);
66 # This check avoids a recursion loop - see
67 # t/100_bugs/020_super_recursion.t
68 return if defined $SUPER_PACKAGE && $SUPER_PACKAGE ne caller();
69 return unless $SUPER_BODY; $SUPER_BODY->(@SUPER_ARGS);
73 my $meta = Mouse::Meta::Class->initialize(caller);
74 my $pkg = $meta->name;
79 my $body = $pkg->can($name)
80 or confess "You cannot override '$name' because it has no super method";
82 $meta->add_method($name => sub {
83 local $SUPER_PACKAGE = $pkg;
84 local @SUPER_ARGS = @_;
85 local $SUPER_BODY = $body;
98 if (ref($_[0]) && ref($_[0]) eq 'HASH') {
104 my $level = delete $opts->{into_level};
105 $level = 0 unless defined $level;
106 my $caller = caller($level);
108 # we should never export to main
109 if ($caller eq 'main') {
110 warn qq{$class does not export its sugar to the 'main' package.\n};
114 my $meta = Mouse::Meta::Class->initialize($caller);
115 $meta->superclasses('Mouse::Object')
116 unless $meta->superclasses;
118 # make a subtype for each Mouse class
119 class_type($caller) unless find_type_constraint($caller);
122 no warnings 'redefine';
123 *{$caller.'::meta'} = sub { $meta };
126 __PACKAGE__->export_to_level( $level+1, $class, @_);
128 # shortcut for the common case of no type character
130 for my $keyword (@EXPORT) {
131 *{ $caller . '::' . $keyword } = *{__PACKAGE__ . '::' . $keyword};
140 for my $keyword (@EXPORT) {
141 delete ${ $caller . '::' }{$keyword};
148 if (ref($class) || !defined($class) || !length($class)) {
149 my $display = defined($class) ? $class : 'undef';
150 confess "Invalid class name ($display)";
153 return 1 if $class eq 'Mouse::Object';
154 return 1 if is_class_loaded($class);
156 (my $file = "$class.pm") =~ s{::}{/}g;
158 eval { CORE::require($file) };
159 confess "Could not load class ($class) because : $@" if $@;
164 sub is_class_loaded {
167 return 0 if ref($class) || !defined($class) || !length($class);
169 # walk the symbol table tree to avoid autovififying
170 # \*{${main::}{"Foo::"}} == \*main::Foo::
173 foreach my $part (split('::', $class)) {
174 return 0 unless exists ${$$pack}{"${part}::"};
175 $pack = \*{${$$pack}{"${part}::"}};
178 # check for $VERSION or @ISA
179 return 1 if exists ${$$pack}{VERSION}
180 && defined *{${$$pack}{VERSION}}{SCALAR};
181 return 1 if exists ${$$pack}{ISA}
182 && defined *{${$$pack}{ISA}}{ARRAY};
184 # check for any method
185 foreach ( keys %{$$pack} ) {
186 next if substr($_, -2, 2) eq '::';
187 return 1 if defined *{${$$pack}{$_}}{CODE};
195 return unless defined $_[0];
196 my $class = blessed($_[0]) || $_[0];
197 return Mouse::Meta::Class::get_metaclass_by_name($class);
206 Mouse - Moose minus the antlers
211 use Mouse; # automatically turns on strict and warnings
213 has 'x' => (is => 'rw', isa => 'Int');
214 has 'y' => (is => 'rw', isa => 'Int');
227 has 'z' => (is => 'rw', isa => 'Int');
229 after 'clear' => sub {
236 L<Moose> is wonderful. B<Use Moose instead of Mouse.>
238 Unfortunately, Moose has a compile-time penalty. Though significant progress has
239 been made over the years, the compile time penalty is a non-starter for some
242 Mouse aims to alleviate this by providing a subset of Moose's functionality,
245 We're also going as light on dependencies as possible.
246 L<Class::Method::Modifiers> or L<Data::Util> is required if you want support
247 for L</before>, L</after>, and L</around>.
251 Compatibility with Moose has been the utmost concern. Fewer than 1% of the
252 tests fail when run against Moose instead of Mouse. Mouse code coverage is also
253 over 96%. Even the error messages are taken from Moose. The Mouse code just
254 runs the test suite 4x faster.
256 The idea is that, if you need the extra power, you should be able to run
257 C<s/Mouse/Moose/g> on your codebase and have nothing break. To that end,
258 we have written L<Any::Moose> which will act as Mouse unless Moose is loaded,
259 in which case it will act as Moose.
263 Please don't copy MooseX code to MouseX. If you need extensions, you really
264 should upgrade to Moose. We don't need two parallel sets of extensions!
266 If you really must write a Mouse extension, please contact the Moose mailing
267 list or #moose on IRC beforehand.
271 =head2 meta -> Mouse::Meta::Class
273 Returns this class' metaclass instance.
275 =head2 extends superclasses
277 Sets this class' superclasses.
279 =head2 before (method|methods) => Code
281 Installs a "before" method modifier. See L<Moose/before> or
282 L<Class::Method::Modifiers/before>.
284 Use of this feature requires L<Class::Method::Modifiers>!
286 =head2 after (method|methods) => Code
288 Installs an "after" method modifier. See L<Moose/after> or
289 L<Class::Method::Modifiers/after>.
291 Use of this feature requires L<Class::Method::Modifiers>!
293 =head2 around (method|methods) => Code
295 Installs an "around" method modifier. See L<Moose/around> or
296 L<Class::Method::Modifiers/around>.
298 Use of this feature requires L<Class::Method::Modifiers>!
300 =head2 has (name|names) => parameters
302 Adds an attribute (or if passed an arrayref of names, multiple attributes) to
309 If specified, inlines a read-only/read-write accessor with the same name as
312 =item isa => TypeConstraint
314 Provides type checking in the constructor and accessor. The following types are
315 supported. Any unknown type is taken to be a class check (e.g. isa =>
316 'DateTime' would accept only L<DateTime> objects).
318 Any Item Bool Undef Defined Value Num Int Str ClassName
319 Ref ScalarRef ArrayRef HashRef CodeRef RegexpRef GlobRef
322 For more documentation on type constraints, see L<Mouse::Util::TypeConstraints>.
325 =item required => 0|1
327 Whether this attribute is required to have a value. If the attribute is lazy or
328 has a builder, then providing a value for the attribute in the constructor is
331 =item init_arg => Str | Undef
333 Allows you to use a different key name in the constructor. If undef, the
334 attribue can't be passed to the constructor.
336 =item default => Value | CodeRef
338 Sets the default value of the attribute. If the default is a coderef, it will
339 be invoked to get the default value. Due to quirks of Perl, any bare reference
340 is forbidden, you must wrap the reference in a coderef. Otherwise, all
341 instances will share the same reference.
345 If specified, the default is calculated on demand instead of in the
348 =item predicate => Str
350 Lets you specify a method name for installing a predicate method, which checks
351 that the attribute has a value. It will not invoke a lazy default or builder
356 Lets you specify a method name for installing a clearer method, which clears
357 the attribute's value from the instance. On the next read, lazy or builder will
360 =item handles => HashRef|ArrayRef
362 Lets you specify methods to delegate to the attribute. ArrayRef forwards the
363 given method names to method calls on the attribute. HashRef maps local method
364 names to remote method names called on the attribute. Other forms of
365 L</handles>, such as regular expression and coderef, are not yet supported.
367 =item weak_ref => 0|1
369 Lets you automatically weaken any reference stored in the attribute.
371 Use of this feature requires L<Scalar::Util>!
373 =item trigger => CodeRef
375 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.
377 Mouse 0.05 supported more complex triggers, but this behavior is now removed.
381 Defines a method name to be called to provide the default value of the
382 attribute. C<< builder => 'build_foo' >> is mostly equivalent to
383 C<< default => sub { $_[0]->build_foo } >>.
385 =item auto_deref => 0|1
387 Allows you to automatically dereference ArrayRef and HashRef attributes in list
388 context. In scalar context, the reference is returned (NOT the list length or
389 bucket status). You must specify an appropriate type constraint to use
392 =item lazy_build => 0|1
394 Automatically define lazy => 1 as well as builder => "_build_$attr", clearer =>
395 "clear_$attr', predicate => 'has_$attr' unless they are already defined.
399 =head2 confess error -> BOOM
401 L<Carp/confess> for your convenience.
403 =head2 blessed value -> ClassName | undef
405 L<Scalar::Util/blessed> for your convenience.
411 Importing Mouse will default your class' superclass list to L<Mouse::Object>.
412 You may use L</extends> to replace the superclass list.
416 Please unimport Mouse (C<no Mouse>) so that if someone calls one of the
417 keywords (such as L</extends>) it will break loudly instead breaking subtly.
421 =head2 load_class Class::Name
423 This will load a given C<Class::Name> (or die if it's not loadable).
424 This function can be used in place of tricks like
425 C<eval "use $module"> or using C<require>.
427 =head2 is_class_loaded Class::Name -> Bool
429 Returns whether this class is actually loaded or not. It uses a heuristic which
430 involves checking for the existence of C<$VERSION>, C<@ISA>, and any
431 locally-defined method.
433 =head1 SOURCE CODE ACCESS
435 We have a public git repo:
437 git clone git://jules.scsys.co.uk/gitmo/Mouse.git
441 Shawn M Moore, C<< <sartak at gmail.com> >>
443 Yuval Kogman, C<< <nothingmuch at woobling.org> >>
451 with plenty of code borrowed from L<Class::MOP> and L<Moose>
455 There is a known issue with Mouse on 5.6.2 regarding the @ISA tests. Until
456 this is resolve the minimum version of Perl for Mouse is set to 5.8.0. Patches
457 to resolve these tests are more than welcome.
459 Please report any bugs through RT: email
460 C<bug-mouse at rt.cpan.org>, or browse
461 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Mouse>.
463 =head1 COPYRIGHT AND LICENSE
465 Copyright 2008 Shawn M Moore.
467 This program is free software; you can redistribute it and/or modify it
468 under the same terms as Perl itself.