7 use Scalar::Util 'blessed';
9 use Mouse::Util qw(load_class not_supported);
12 our @EXPORT = qw(before after around super override inner augment has extends with requires excludes confess blessed);
13 our %is_removable = map{ $_ => undef } @EXPORT;
14 delete $is_removable{confess};
15 delete $is_removable{blessed};
18 my $meta = Mouse::Meta::Role->initialize(scalar caller);
22 $meta->add_before_method_modifier($_ => $code);
27 my $meta = Mouse::Meta::Role->initialize(scalar caller);
31 $meta->add_after_method_modifier($_ => $code);
36 my $meta = Mouse::Meta::Role->initialize(scalar caller);
40 $meta->add_around_method_modifier($_ => $code);
46 return unless $Mouse::SUPER_BODY;
47 $Mouse::SUPER_BODY->(@Mouse::SUPER_ARGS);
51 my $classname = caller;
52 my $meta = Mouse::Meta::Role->initialize($classname);
56 my $fullname = "${classname}::${name}";
59 && $meta->throw_error("Cannot add an override of method '$fullname' "
60 . "because there is a local version of '$fullname'");
62 $meta->add_override_method_modifier($name => sub {
63 local $Mouse::SUPER_PACKAGE = shift;
64 local $Mouse::SUPER_BODY = shift;
65 local @Mouse::SUPER_ARGS = @_;
71 # We keep the same errors messages as Moose::Role emits, here.
73 Carp::croak "Roles cannot support 'inner'";
77 Carp::croak "Roles cannot support 'augment'";
81 my $meta = Mouse::Meta::Role->initialize(scalar caller);
86 $meta->add_attribute($name => \%opts);
90 Carp::croak "Roles do not support 'extends'"
94 my $meta = Mouse::Meta::Role->initialize(scalar caller);
95 Mouse::Util::apply_all_roles($meta->name, @_);
99 my $meta = Mouse::Meta::Role->initialize(scalar caller);
100 $meta->throw_error("Must specify at least one method") unless @_;
101 $meta->add_required_methods(@_);
116 # we should never export to main
117 if ($caller eq 'main') {
118 warn qq{$class does not export its sugar to the 'main' package.\n};
122 Mouse::Meta::Role->initialize($caller)->add_method(meta => sub {
123 return Mouse::Meta::Role->initialize(ref($_[0]) || $_[0]);
126 Mouse::Role->export_to_level(1, @_);
137 for my $keyword (@EXPORT) {
139 if(exists $is_removable{$keyword}
140 && ($code = $caller->can($keyword))
141 && (Mouse::Util::get_code_info($code))[0] eq __PACKAGE__){
143 delete $stash->{$keyword};
155 Mouse::Role - define a role in Mouse
159 =head2 meta -> Mouse::Meta::Role
161 Returns this role's metaclass instance.
163 =head2 before (method|methods) => Code
165 Sets up a "before" method modifier. See L<Moose/before> or
166 L<Class::Method::Modifiers/before>.
168 =head2 after (method|methods) => Code
170 Sets up an "after" method modifier. See L<Moose/after> or
171 L<Class::Method::Modifiers/after>.
173 =head2 around (method|methods) => Code
175 Sets up an "around" method modifier. See L<Moose/around> or
176 L<Class::Method::Modifiers/around>.
182 Sets up the "super" keyword. See L<Moose/super>.
184 =item B<override ($name, &sub)>
186 Sets up an "override" method modifier. See L<Moose/Role/override>.
190 This is not supported and emits an error. See L<Moose/Role>.
192 =item B<augment ($name, &sub)>
194 This is not supported and emits an error. See L<Moose/Role>.
198 =head2 has (name|names) => parameters
200 Sets up an attribute (or if passed an arrayref of names, multiple attributes) to
201 this role. See L<Mouse/has>.
203 =head2 confess error -> BOOM
205 L<Carp/confess> for your convenience.
207 =head2 blessed value -> ClassName | undef
209 L<Scalar::Util/blessed> for your convenience.
215 Importing Mouse::Role will give you sugar.
219 Please unimport Mouse (C<no Mouse::Role>) so that if someone calls one of the
220 keywords (such as L</has>) it will break loudly instead breaking subtly.