X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FPackage.pm;h=23785e8486c78658a73250e7dc97f17c72cc7610;hb=52c685d33a36910371f8265346d0030934ba6b95;hp=82a732473d6f0e7b3dfec42c17f1d5470d8782bb;hpb=9d6dce77cd867d92c418eb4fcfd199eaca6efc10;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Package.pm b/lib/Class/MOP/Package.pm index 82a7324..23785e8 100644 --- a/lib/Class/MOP/Package.pm +++ b/lib/Class/MOP/Package.pm @@ -7,23 +7,68 @@ use warnings; use Scalar::Util 'blessed'; use Carp 'confess'; -our $VERSION = '0.02'; +our $VERSION = '0.69'; +$VERSION = eval $VERSION; +our $AUTHORITY = 'cpan:STEVAN'; -# introspection - -sub meta { - require Class::MOP::Class; - Class::MOP::Class->initialize(blessed($_[0]) || $_[0]); -} +use base 'Class::MOP::Object'; # creation ... sub initialize { - my $class = shift; - my $package_name = shift; + my ( $class, @args ) = @_; + + unshift @args, "package" if @args % 2; + + my %options = @args; + my $package_name = $options{package}; + + # we hand-construct the class # until we can bootstrap it - return bless { '$:package' => $package_name } => $class; + if ( my $meta = Class::MOP::get_metaclass_by_name($package_name) ) { + return $meta; + } else { + my $meta = ( ref $class || $class )->_new({ + 'package' => $package_name, + }); + + Class::MOP::store_metaclass_by_name($package_name, $meta); + + return $meta; + } +} + +sub reinitialize { + my ( $class, @args ) = @_; + + unshift @args, "package" if @args % 2; + + my %options = @args; + my $package_name = delete $options{package}; + + (defined $package_name && $package_name && !blessed($package_name)) + || confess "You must pass a package name and it cannot be blessed"; + + Class::MOP::remove_metaclass_by_name($package_name); + + $class->initialize($package_name, %options); # call with first arg form for compat +} + +sub _new { + my $class = shift; + my $options = @_ == 1 ? $_[0] : {@_}; + + # NOTE: + # because of issues with the Perl API + # to the typeglob in some versions, we + # need to just always grab a new + # reference to the hash in the accessor. + # Ideally we could just store a ref and + # it would Just Work, but oh well :\ + $options->{namespace} ||= \undef; + + bless $options, $class; } # Attributes @@ -32,9 +77,20 @@ sub initialize { # all these attribute readers will be bootstrapped # away in the Class::MOP bootstrap section -sub name { $_[0]->{'$:package'} } +sub name { $_[0]->{'package'} } +sub namespace { + # NOTE: + # because of issues with the Perl API + # to the typeglob in some versions, we + # need to just always grab a new + # reference to the hash here. Ideally + # we could just store a ref and it would + # Just Work, but oh well :\ + no strict 'refs'; + \%{$_[0]->{'package'} . '::'} +} -# Class attributes +# utility methods { my %SIGIL_MAP = ( @@ -43,110 +99,209 @@ sub name { $_[0]->{'$:package'} } '%' => 'HASH', '&' => 'CODE', ); - - sub add_package_symbol { - my ($self, $variable, $initial_value) = @_; + sub _deconstruct_variable_name { + my ($self, $variable) = @_; + (defined $variable) || confess "You must pass a variable name"; - - my ($sigil, $name) = ($variable =~ /^(.)(.*)$/); - + + my $sigil = substr($variable, 0, 1, ''); + (defined $sigil) || confess "The variable name must include a sigil"; - + (exists $SIGIL_MAP{$sigil}) - || confess "I do not recognize that sigil '$sigil'"; - - no strict 'refs'; - no warnings 'misc', 'redefine'; - *{$self->name . '::' . $name} = $initial_value; + || confess "I do not recognize that sigil '$sigil'"; + + return ($variable, $sigil, $SIGIL_MAP{$sigil}); } +} - sub has_package_symbol { - my ($self, $variable) = @_; - (defined $variable) - || confess "You must pass a variable name"; +# Class attributes - my ($sigil, $name) = ($variable =~ /^(.)(.*)$/); - - (defined $sigil) - || confess "The variable name must include a sigil"; +# ... these functions have to touch the symbol table itself,.. yuk + +sub add_package_symbol { + my ($self, $variable, $initial_value) = @_; + + my ($name, $sigil, $type) = ref $variable eq 'HASH' + ? @{$variable}{qw[name sigil type]} + : $self->_deconstruct_variable_name($variable); + + my $pkg = $self->{'package'}; + + no strict 'refs'; + no warnings 'redefine', 'misc'; + *{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value; +} + +sub remove_package_glob { + my ($self, $name) = @_; + no strict 'refs'; + delete ${$self->name . '::'}{$name}; +} + +# ... these functions deal with stuff on the namespace level + +sub has_package_symbol { + my ($self, $variable) = @_; + + my ($name, $sigil, $type) = ref $variable eq 'HASH' + ? @{$variable}{qw[name sigil type]} + : $self->_deconstruct_variable_name($variable); - (exists $SIGIL_MAP{$sigil}) - || confess "I do not recognize that sigil '$sigil'"; + my $namespace = $self->namespace; - no strict 'refs'; - defined *{$self->name . '::' . $name}{$SIGIL_MAP{$sigil}} ? 1 : 0; + return 0 unless exists $namespace->{$name}; + # FIXME: + # For some really stupid reason + # a typeglob will have a default + # value of \undef in the SCALAR + # slot, so we need to work around + # this. Which of course means that + # if you put \undef in your scalar + # then this is broken. + + if (ref($namespace->{$name}) eq 'SCALAR') { + return ($type eq 'CODE'); + } + elsif ($type eq 'SCALAR') { + my $val = *{$namespace->{$name}}{$type}; + return defined(${$val}); + } + else { + defined(*{$namespace->{$name}}{$type}); } +} - sub get_package_symbol { - my ($self, $variable) = @_; - (defined $variable) - || confess "You must pass a variable name"; - - my ($sigil, $name) = ($variable =~ /^(.)(.*)$/); - - (defined $sigil) - || confess "The variable name must include a sigil"; - - (exists $SIGIL_MAP{$sigil}) - || confess "I do not recognize that sigil '$sigil'"; - - no strict 'refs'; - return *{$self->name . '::' . $name}{$SIGIL_MAP{$sigil}}; +sub get_package_symbol { + my ($self, $variable) = @_; - } + my ($name, $sigil, $type) = ref $variable eq 'HASH' + ? @{$variable}{qw[name sigil type]} + : $self->_deconstruct_variable_name($variable); - sub remove_package_symbol { - my ($self, $variable) = @_; - - (defined $variable) - || confess "You must pass a variable name"; - - my ($sigil, $name) = ($variable =~ /^(.)(.*)$/); - - (defined $sigil) - || confess "The variable name must include a sigil"; - - (exists $SIGIL_MAP{$sigil}) - || confess "I do not recognize that sigil '$sigil'"; - - no strict 'refs'; - if ($SIGIL_MAP{$sigil} eq 'SCALAR') { - undef ${$self->name . '::' . $name}; - } - elsif ($SIGIL_MAP{$sigil} eq 'ARRAY') { - undef @{$self->name . '::' . $name}; - } - elsif ($SIGIL_MAP{$sigil} eq 'HASH') { - undef %{$self->name . '::' . $name}; + my $namespace = $self->namespace; + + $self->add_package_symbol($variable) + unless exists $namespace->{$name}; + + if (ref($namespace->{$name}) eq 'SCALAR') { + if ($type eq 'CODE') { + no strict 'refs'; + return \&{$self->name.'::'.$name}; } - elsif ($SIGIL_MAP{$sigil} eq 'CODE') { - # FIXME: - # this is crap, it is probably much - # easier to write this in XS. - my ($scalar, @array, %hash); - $scalar = ${$self->name . '::' . $name} if defined *{$self->name . '::' . $name}{SCALAR}; - @array = @{$self->name . '::' . $name} if defined *{$self->name . '::' . $name}{ARRAY}; - %hash = %{$self->name . '::' . $name} if defined *{$self->name . '::' . $name}{HASH}; - delete ${$self->name . '::'}{$name}; - ${$self->name . '::' . $name} = $scalar if defined $scalar; - @{$self->name . '::' . $name} = @array if scalar @array; - %{$self->name . '::' . $name} = %hash if keys %hash; - } else { - confess "This should never ever ever happen"; + return undef; } } + else { + return *{$namespace->{$name}}{$type}; + } +} + +sub remove_package_symbol { + my ($self, $variable) = @_; + + my ($name, $sigil, $type) = ref $variable eq 'HASH' + ? @{$variable}{qw[name sigil type]} + : $self->_deconstruct_variable_name($variable); + + # FIXME: + # no doubt this is grossly inefficient and + # could be done much easier and faster in XS + + my ($scalar_desc, $array_desc, $hash_desc, $code_desc) = ( + { sigil => '$', type => 'SCALAR', name => $name }, + { sigil => '@', type => 'ARRAY', name => $name }, + { sigil => '%', type => 'HASH', name => $name }, + { sigil => '&', type => 'CODE', name => $name }, + ); + + my ($scalar, $array, $hash, $code); + if ($type eq 'SCALAR') { + $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc); + $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc); + $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc); + } + elsif ($type eq 'ARRAY') { + $scalar = $self->get_package_symbol($scalar_desc) if $self->has_package_symbol($scalar_desc); + $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc); + $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc); + } + elsif ($type eq 'HASH') { + $scalar = $self->get_package_symbol($scalar_desc) if $self->has_package_symbol($scalar_desc); + $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc); + $code = $self->get_package_symbol($code_desc) if $self->has_package_symbol($code_desc); + } + elsif ($type eq 'CODE') { + $scalar = $self->get_package_symbol($scalar_desc) if $self->has_package_symbol($scalar_desc); + $array = $self->get_package_symbol($array_desc) if $self->has_package_symbol($array_desc); + $hash = $self->get_package_symbol($hash_desc) if $self->has_package_symbol($hash_desc); + } + else { + confess "This should never ever ever happen"; + } + + $self->remove_package_glob($name); + $self->add_package_symbol($scalar_desc => $scalar) if defined $scalar; + $self->add_package_symbol($array_desc => $array) if defined $array; + $self->add_package_symbol($hash_desc => $hash) if defined $hash; + $self->add_package_symbol($code_desc => $code) if defined $code; } sub list_all_package_symbols { - my ($self) = @_; - no strict 'refs'; - return keys %{$self->name . '::'}; + my ($self, $type_filter) = @_; + + my $namespace = $self->namespace; + return keys %{$namespace} unless defined $type_filter; + + # NOTE: + # or we can filter based on + # type (SCALAR|ARRAY|HASH|CODE) + if ( $type_filter eq 'CODE' ) { + return grep { + (ref($namespace->{$_}) + ? (ref($namespace->{$_}) eq 'SCALAR') + : (ref(\$namespace->{$_}) eq 'GLOB' + && defined(*{$namespace->{$_}}{CODE}))); + } keys %{$namespace}; + } else { + return grep { *{$namespace->{$_}}{$type_filter} } keys %{$namespace}; + } +} + +sub get_all_package_symbols { + my ($self, $type_filter) = @_; + + die "Cannot call get_all_package_symbols as a class method" + unless ref $self; + + my $namespace = $self->namespace; + + return %$namespace unless defined $type_filter; + + # for some reason this nasty impl is orders of magnitude faster than a clean version + if ( $type_filter eq 'CODE' ) { + my $pkg; + no strict 'refs'; + return map { + (ref($namespace->{$_}) + ? ( $_ => \&{$pkg ||= $self->name . "::$_"} ) + : ( (*{$namespace->{$_}}{CODE}) # the extra parents prevent breakage on 5.8.2 + ? ( $_ => *{$namespace->{$_}}{CODE} ) + : () ) ) + } keys %$namespace; + } else { + return map { + $_ => *{$namespace->{$_}}{$type_filter} + } grep { + !ref($namespace->{$_}) && *{$namespace->{$_}}{$type_filter} + } keys %$namespace; + } } 1; @@ -159,29 +314,81 @@ __END__ Class::MOP::Package - Package Meta Object -=head1 SYNOPSIS - =head1 DESCRIPTION +This is an abstraction of a Perl 5 package, it is a superclass of +L and provides all of the symbol table +introspection methods. + =head1 METHODS =over 4 =item B -=item B +Returns a metaclass for this package. + +=item B + +This will initialize a Class::MOP::Package instance which represents +the package of C<$package_name>. + +=item B + +This removes the old metaclass, and creates a new one in it's place. +Do B use this unless you really know what you are doing, it could +very easily make a very large mess of your program. =item B -=item B +This is a read-only attribute which returns the package name for the +given instance. + +=item B + +This returns a HASH reference to the symbol table. The keys of the +HASH are the symbol names, and the values are typeglob references. + +=item B + +Given a C<$variable_name>, which must contain a leading sigil, this +method will create that variable within the package which houses the +class. It also takes an optional C<$initial_value>, which must be a +reference of the same type as the sigil of the C<$variable_name> +implies. + +=item B + +This will return a reference to the package variable in +C<$variable_name>. + +=item B -=item B +Returns true (C<1>) if there is a package variable defined for +C<$variable_name>, and false (C<0>) otherwise. -=item B +=item B -=item B +This will attempt to remove the package variable at C<$variable_name>. -=item B +=item B + +This will attempt to remove the entire typeglob associated with +C<$glob_name> from the package. + +=item B + +This will list all the glob names associated with the current package. +By inspecting the globs returned you can discern all the variables in +the package. + +By passing a C<$type_filter>, you can limit the list to only those +which match the filter (either SCALAR, ARRAY, HASH or CODE). + +=item B + +Works exactly like C but returns a HASH of +name => thing mapping instead of just an ARRAY of names. =back @@ -189,15 +396,13 @@ Class::MOP::Package - Package Meta Object Stevan Little Estevan@iinteractive.comE -Yuval Kogman Enothingmuch@woobling.comE - =head1 COPYRIGHT AND LICENSE -Copyright 2006 by Infinity Interactive, Inc. +Copyright 2006-2008 by Infinity Interactive, Inc. L This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. -=cut \ No newline at end of file +=cut