X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FExporter.pm;h=e3cb85a848be0546f216482683baf1bb67294bec;hp=f60c4e9a31dee2c077de90d24228a013ac1195ff;hb=3d7c6ec96a92be50258d124bdec61fb91bca3830;hpb=db9fc23783271f93e5a2bf15300f2f4a5284cc96 diff --git a/lib/Mouse/Exporter.pm b/lib/Mouse/Exporter.pm index f60c4e9..e3cb85a 100644 --- a/lib/Mouse/Exporter.pm +++ b/lib/Mouse/Exporter.pm @@ -4,15 +4,50 @@ use warnings; use Carp qw(confess); -use Mouse::Util qw(get_code_info); - my %SPEC; +use constant _strict_bits => strict::bits(qw(subs refs vars)); + +# it must be "require", because Mouse::Util depends on Mouse::Exporter, +# which depends on Mouse::Util::import() +require Mouse::Util; + +sub import{ + $^H |= _strict_bits; # strict->import; + ${^WARNING_BITS} |= $warnings::Bits{all}; # warnings->import; + return; +} + + sub setup_import_methods{ my($class, %args) = @_; my $exporting_package = $args{exporting_package} ||= caller(); + my($import, $unimport) = $class->build_import_methods(%args); + + no strict 'refs'; + + *{$exporting_package . '::import'} = $import; + *{$exporting_package . '::unimport'} = $unimport; + + # for backward compatibility + *{$exporting_package . '::export_to_level'} = sub{ + my($package, $level, undef, @args) = @_; # the third argument is redundant + $package->import({ into_level => $level + 1 }, @args); + }; + *{$exporting_package . '::export'} = sub{ + my($package, $into, @args) = @_; + $package->import({ into => $into }, @args); + }; + return; +} + +sub build_import_methods{ + my($class, %args) = @_; + + my $exporting_package = $args{exporting_package} ||= caller(); + $SPEC{$exporting_package} = \%args; # canonicalize args @@ -25,7 +60,7 @@ sub setup_import_methods{ push @export_from, $current; my $also = $SPEC{$current}{also} or next; - push @stack, grep{ !$seen{$_}++ } @{ $also }; + push @stack, grep{ !$seen{$_}++ } ref($also) ? @{ $also } : $also; } } else{ @@ -35,86 +70,94 @@ sub setup_import_methods{ { my %exports; my @removables; + my @all; + + my @init_meta_methods; foreach my $package(@export_from){ my $spec = $SPEC{$package} or next; if(my $as_is = $spec->{as_is}){ foreach my $thingy (@{$as_is}){ - my($name, $code); + my($code_package, $code_name, $code); if(ref($thingy)){ - my $code_package; $code = $thingy; - ($code_package, $name) = get_code_info($code); + ($code_package, $code_name) = Mouse::Util::get_code_info($code); } else{ no strict 'refs'; - $name = $thingy; - $code = \&{ $package . '::' . $name }; + $code_package = $package; + $code_name = $thingy; + $code = \&{ $code_package . '::' . $code_name }; } - $exports{$name} = $code; - push @removables, $name; + push @all, $code_name; + $exports{$code_name} = $code; + if($code_package eq $package){ + push @removables, $code_name; + } + } + } + + if(my $init_meta = $package->can('init_meta')){ + if(!grep{ $_ == $init_meta } @init_meta_methods){ + push @init_meta_methods, $init_meta; } } } $args{EXPORTS} = \%exports; $args{REMOVABLES} = \@removables; - $args{group}{default} ||= \@removables; - $args{group}{all} ||= \@removables; - } - - no strict 'refs'; + $args{groups}{all} ||= \@all; - *{$exporting_package . '::import'} = \&do_import; - *{$exporting_package . '::unimport'} = \&do_unimport; + if(my $default_list = $args{groups}{default}){ + my %default; + foreach my $keyword(@{$default_list}){ + $default{$keyword} = $exports{$keyword} + || confess(qq{The $exporting_package package does not export "$keyword"}); + } + $args{DEFAULT} = \%default; + } + else{ + $args{groups}{default} ||= \@all; + $args{DEFAULT} = $args{EXPORTS}; + } - if(!defined &{$exporting_package . '::init_meta'}){ - *{$exporting_package . '::init_meta'} = \&do_init_meta; + if(@init_meta_methods){ + $args{INIT_META} = \@init_meta_methods; + } } - return; -} - -# the entity of general init_meta() -sub do_init_meta { - my($class, %args) = @_; - - my $spec = $SPEC{$class} - or confess("The package $class does not use Mouse::Exporter"); - - my $for_class = $args{for_class} - or confess("Cannot call init_meta without specifying a for_class"); - - my $base_class = $args{base_class} || 'Mouse::Object'; - my $metaclass = $args{metaclass} || 'Mouse::Meta::Class'; - - my $meta = $metaclass->initialize($for_class); - $meta->add_method(meta => sub{ - $metaclass->initialize(ref($_[0]) || $_[0]); - }); - - $meta->superclasses($base_class) - unless $meta->superclasses; - - return $meta; + return (\&do_import, \&do_unimport); } + # the entity of general import() sub do_import { - my($class, @args) = @_; + my($package, @args) = @_; - my $spec = $SPEC{$class} - or confess("The package $class does not use Mouse::Exporter"); + my $spec = $SPEC{$package} + || confess("The package $package package does not use Mouse::Exporter"); my $into = _get_caller_package(ref($args[0]) ? shift @args : undef); my @exports; - foreach my $arg(@args){ - if($arg =~ s/^[-:]//){ - my $group = $spec->{group}{$arg} or confess(qq{group "$arg" is not exported by the $class module}); + my @traits; + + while(@args){ + my $arg = shift @args; + if($arg =~ s/^-//){ + if($arg eq 'traits'){ + push @traits, ref($args[0]) ? @{shift(@args)} : shift(@args); + } + else { + Mouse::Util::not_supported("-$arg"); + } + } + elsif($arg =~ s/^://){ + my $group = $spec->{groups}{$arg} + || confess(qq{The $package package does not export the group "$arg"}); push @exports, @{$group}; } else{ @@ -122,40 +165,59 @@ sub do_import { } } - strict->import; - warnings->import; + $^H |= _strict_bits; # strict->import; + ${^WARNING_BITS} |= $warnings::Bits{all}; # warnings->import; - if($into eq 'main' && !$spec->{_not_export_to_main}){ - warn qq{$class does not export its sugar to the 'main' package.\n}; - return; - } - - if($class->can('init_meta')){ - my $meta = $class->init_meta( - for_class => $into, - ); + if($spec->{INIT_META}){ + my $meta; + foreach my $init_meta(@{$spec->{INIT_META}}){ + $meta = $package->$init_meta(for_class => $into); + } - # TODO: process -metaclass and -traits - # ... + if(@traits){ + my $type = (split /::/, ref $meta)[-1]; # e.g. "Class" for "My::Meta::Class" + @traits = + map{ + ref($_) ? $_ + : Mouse::Util::resolve_metaclass_alias($type => $_, trait => 1) + } @traits; + + require Mouse::Util::MetaRole; + Mouse::Util::MetaRole::apply_metaroles( + for => $into, + Mouse::Util::is_a_metarole($into->meta) + ? (role_metaroles => { role => \@traits }) + : (class_metaroles => { class => \@traits }), + ); + } + } + elsif(@traits){ + Carp::confess("Cannot provide traits when $package does not have an init_meta() method"); } - - my $exports_ref = @exports ? \@exports : $spec->{group}{default}; - - foreach my $keyword(@{$exports_ref}){ - no strict 'refs'; - *{$into.'::'.$keyword} = $spec->{EXPORTS}{$keyword} - or confess(qq{"$keyword" is not exported by the $class module}); + if(@exports){ + foreach my $keyword(@exports){ + no strict 'refs'; + *{$into.'::'.$keyword} = $spec->{EXPORTS}{$keyword} + || confess(qq{The $package package does not export "$keyword"}); + } + } + else{ + my $default = $spec->{DEFAULT}; + while(my($keyword, $code) = each %{$default}){ + no strict 'refs'; + *{$into.'::'.$keyword} = $code; + } } return; } # the entity of general unimport() sub do_unimport { - my($class, $arg) = @_; + my($package, $arg) = @_; - my $spec = $SPEC{$class} - or confess("The package $class does not use Mouse::Exporter"); + my $spec = $SPEC{$package} + || confess("The package $package does not use Mouse::Exporter"); my $from = _get_caller_package($arg); @@ -165,7 +227,11 @@ sub do_unimport { }; for my $keyword (@{ $spec->{REMOVABLES} }) { - delete $stash->{$keyword}; + next if !exists $stash->{$keyword}; + my $gv = \$stash->{$keyword}; + if(ref($gv) eq 'GLOB' && *{$gv}{CODE} == $spec->{EXPORTS}{$keyword}){ # make sure it is from us + delete $stash->{$keyword}; + } } return; } @@ -173,42 +239,82 @@ sub do_unimport { sub _get_caller_package { my($arg) = @_; - # 2 extra level because it's called by import so there's a layer - # of indirection - my $offset = 1; - + # We need one extra level because it's called by import so there's a layer + # of indirection if(ref $arg){ return defined($arg->{into}) ? $arg->{into} - : defined($arg->{into_level}) ? scalar caller($offset + $arg->{into_level}) - : scalar caller($offset); + : defined($arg->{into_level}) ? scalar caller(1 + $arg->{into_level}) + : scalar caller(1); } else{ - return scalar caller($offset); + return scalar caller(1); } } -1; +#sub _spec{ %SPEC } +1; __END__ =head1 NAME -Mouse - The Mouse Exporter +Mouse::Exporter - make an import() and unimport() just like Mouse.pm + +=head1 VERSION + +This document describes Mouse version 0.49 =head1 SYNOPSIS - package MouseX::Foo; + package MyApp::Mouse; + + use Mouse (); use Mouse::Exporter; Mouse::Exporter->setup_import_methods( - + as_is => [ 'has_rw', 'other_sugar', \&Some::Random::thing ], + also => 'Mouse', ); + sub has_rw { + my $meta = caller->meta; + my ( $name, %options ) = @_; + $meta->add_attribute( + $name, + is => 'rw', + %options, + ); + } + + # then later ... + package MyApp::User; + + use MyApp::Mouse; + + has 'name'; + has_rw 'size'; + thing; + + no MyApp::Mouse; + =head1 DESCRIPTION +This module encapsulates the exporting of sugar functions in a +C-like manner. It does this by building custom C, +C methods for your module, based on a spec you provide. + +Note that C does not provide the C option, +but you can easily get the metaclass by C<< caller->meta >> as L shows. + +=head1 METHODS + +=head2 C<< setup_import_methods( ARGS ) >> + +=head2 C<< build_import_methods( ARGS ) -> (\&import, \&unimport) >> =head1 SEE ALSO L =cut +