use strict;
use warnings;
-use B;
-use Scalar::Util 'blessed';
+use Scalar::Util 'blessed', 'reftype';
use Carp 'confess';
-our $VERSION = '0.78';
+our $VERSION = '0.98';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
-use base 'Class::MOP::Object';
+use base 'Class::MOP::Object', 'Class::MOP::Mixin::HasMethods';
# creation ...
'package' => $package_name,
%options,
});
-
Class::MOP::store_metaclass_by_name($package_name, $meta);
return $meta;
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";
+ (defined $package_name && $package_name
+ && (!blessed $package_name || $package_name->isa('Class::MOP::Package')))
+ || confess "You must pass a package name or an existing Class::MOP::Package instance";
+
+ $package_name = $package_name->name
+ if blessed $package_name;
Class::MOP::remove_metaclass_by_name($package_name);
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;
+ return Class::MOP::Class->initialize($class)->new_object(@_)
+ if $class ne __PACKAGE__;
+
+ my $params = @_ == 1 ? $_[0] : {@_};
+
+ return bless {
+ package => $params->{package},
- bless $options, $class;
+ # 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 :\
+
+ namespace => \undef,
+
+ } => $class;
}
# Attributes
my ($name, $sigil, $type) = ref $variable eq 'HASH'
? @{$variable}{qw[name sigil type]}
- : $self->_deconstruct_variable_name($variable);
+ : $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;
+ no warnings 'redefine', 'misc', 'prototype';
+ *{$pkg . '::' . $name} = ref $initial_value ? $initial_value : \$initial_value;
}
sub remove_package_glob {
# ... these functions deal with stuff on the namespace level
sub has_package_symbol {
- my ($self, $variable) = @_;
+ my ( $self, $variable ) = @_;
- my ($name, $sigil, $type) = ref $variable eq 'HASH'
+ my ( $name, $sigil, $type )
+ = ref $variable eq 'HASH'
? @{$variable}{qw[name sigil type]}
: $self->_deconstruct_variable_name($variable);
-
+
my $namespace = $self->namespace;
-
- 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});
+
+ return 0 unless exists $namespace->{$name};
+
+ my $entry_ref = \$namespace->{$name};
+ if ( reftype($entry_ref) eq 'GLOB' ) {
+ if ( $type eq 'SCALAR' ) {
+ return defined( ${ *{$entry_ref}{SCALAR} } );
+ }
+ else {
+ return defined( *{$entry_ref}{$type} );
+ }
}
else {
- defined(*{$namespace->{$name}}{$type});
+
+ # a symbol table entry can be -1 (stub), string (stub with prototype),
+ # or reference (constant)
+ return $type eq 'CODE';
}
}
my $namespace = $self->namespace;
+ # FIXME
$self->add_package_symbol($variable)
unless exists $namespace->{$name};
- if (ref($namespace->{$name}) eq 'SCALAR') {
- if ($type eq 'CODE') {
+ my $entry_ref = \$namespace->{$name};
+
+ if ( ref($entry_ref) eq 'GLOB' ) {
+ return *{$entry_ref}{$type};
+ }
+ else {
+ if ( $type eq 'CODE' ) {
no strict 'refs';
- return \&{$self->name.'::'.$name};
+ return \&{ $self->name . '::' . $name };
}
else {
return undef;
}
}
- else {
- return *{$namespace->{$name}}{$type};
- }
}
sub remove_package_symbol {
=head1 DESCRIPTION
-This is an abstraction of a Perl 5 package, it is a superclass of
-L<Class::MOP::Class> and provides all of the symbol table
-introspection methods.
-
-=head1 INHERITANCE
-
-B<Class::MOP::Package> is a subclass of L<Class::MOP::Object>
+The Package Protocol provides an abstraction of a Perl 5 package. A
+package is basically namespace, and this module provides methods for
+looking at and changing that namespace's symbol table.
=head1 METHODS
=over 4
-=item B<meta>
+=item B<< Class::MOP::Package->initialize($package_name) >>
+
+This method creates a new C<Class::MOP::Package> instance which
+represents specified package. If an existing metaclass object exists
+for the package, that will be returned instead.
+
+=item B<< Class::MOP::Package->reinitialize($package) >>
+
+This method forcibly removes any existing metaclass for the package
+before calling C<initialize>. In contrast to C<initialize>, you may
+also pass an existing C<Class::MOP::Package> instance instead of just
+a package name as C<$package>.
+
+Do not call this unless you know what you are doing.
+
+=item B<< $metapackage->name >>
+
+This is returns the package's name, as passed to the constructor.
+
+=item B<< $metapackage->namespace >>
+
+This returns a hash reference to the package's symbol table. The keys
+are symbol names and the values are typeglob references.
+
+=item B<< $metapackage->add_package_symbol($variable_name, $initial_value) >>
+
+This method accepts a variable name and an optional initial value. The
+C<$variable_name> must contain a leading sigil.
+
+This method creates the variable in the package's symbol table, and
+sets it to the initial value if one was provided.
+
+=item B<< $metapackage->get_package_symbol($variable_name) >>
+
+Given a variable name, this method returns the variable as a reference
+or undef if it does not exist. The C<$variable_name> must contain a
+leading sigil.
-Returns a metaclass for this package.
+=item B<< $metapackage->has_package_symbol($variable_name) >>
-=item B<initialize ($package_name)>
+Returns true if there is a package variable defined for
+C<$variable_name>. The C<$variable_name> must contain a leading sigil.
-This will initialize a Class::MOP::Package instance which represents
-the package of C<$package_name>.
+=item B<< $metapackage->remove_package_symbol($variable_name) >>
-=item B<reinitialize ($package_name, %options)>
+This will remove the package variable specified C<$variable_name>. The
+C<$variable_name> must contain a leading sigil.
-This removes the old metaclass, and creates a new one in it's place.
-Do B<not> use this unless you really know what you are doing, it could
-very easily make a very large mess of your program.
+=item B<< $metapackage->remove_package_glob($glob_name) >>
-=item B<name>
+Given the name of a glob, this will remove that glob from the
+package's symbol table. Glob names do not include a sigil. Removing
+the glob removes all variables and subroutines with the specified
+name.
+
+=item B<< $metapackage->list_all_package_symbols($type_filter) >>
+
+This will list all the glob names associated with the current
+package. These names do not have leading sigils.
+
+You can provide an optional type filter, which should be one of
+'SCALAR', 'ARRAY', 'HASH', or 'CODE'.
+
+=item B<< $metapackage->get_all_package_symbols($type_filter) >>
+
+This works much like C<list_all_package_symbols>, but it returns a
+hash reference. The keys are glob names and the values are references
+to the value for that name.
+
+=back
+
+=head2 Method introspection and creation
+
+These methods allow you to introspect a class's methods, as well as
+add, remove, or change methods.
+
+Determining what is truly a method in a Perl 5 class requires some
+heuristics (aka guessing).
+
+Methods defined outside the package with a fully qualified name (C<sub
+Package::name { ... }>) will be included. Similarly, methods named
+with a fully qualified name using L<Sub::Name> are also included.
+
+However, we attempt to ignore imported functions.
+
+Ultimately, we are using heuristics to determine what truly is a
+method in a class, and these heuristics may get the wrong answer in
+some edge cases. However, for most "normal" cases the heuristics work
+correctly.
+
+=over 4
-This is a read-only attribute which returns the package name for the
-given instance.
+=item B<< $metapackage->get_method($method_name) >>
-=item B<namespace>
+This will return a L<Class::MOP::Method> for the specified
+C<$method_name>. If the class does not have the specified method, it
+returns C<undef>
-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<< $metapackage->has_method($method_name) >>
-=item B<add_package_symbol ($variable_name, ?$initial_value)>
+Returns a boolean indicating whether or not the class defines the
+named method. It does not include methods inherited from parent
+classes.
-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<< $metapackage->get_method_list >>
-=item B<get_package_symbol ($variable_name)>
+This will return a list of method I<names> for all methods defined in
+this class.
-This will return a reference to the package variable in
-C<$variable_name>.
+=item B<< $metapackage->add_method($method_name, $method) >>
-=item B<has_package_symbol ($variable_name)>
+This method takes a method name and a subroutine reference, and adds
+the method to the class.
-Returns true (C<1>) if there is a package variable defined for
-C<$variable_name>, and false (C<0>) otherwise.
+The subroutine reference can be a L<Class::MOP::Method>, and you are
+strongly encouraged to pass a meta method object instead of a code
+reference. If you do so, that object gets stored as part of the
+class's method map directly. If not, the meta information will have to
+be recreated later, and may be incorrect.
-=item B<remove_package_symbol ($variable_name)>
+If you provide a method object, this method will clone that object if
+the object's package name does not match the class name. This lets us
+track the original source of any methods added from other classes
+(notably Moose roles).
-This will attempt to remove the package variable at C<$variable_name>.
+=item B<< $metapackage->remove_method($method_name) >>
-=item B<remove_package_glob ($glob_name)>
+Remove the named method from the class. This method returns the
+L<Class::MOP::Method> object for the method.
-This will attempt to remove the entire typeglob associated with
-C<$glob_name> from the package.
+=item B<< $metapackage->method_metaclass >>
-=item B<list_all_package_symbols (?$type_filter)>
+Returns the class name of the method metaclass, see
+L<Class::MOP::Method> for more information on the method metaclass.
-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.
+=item B<< $metapackage->wrapped_method_metaclass >>
-By passing a C<$type_filter>, you can limit the list to only those
-which match the filter (either SCALAR, ARRAY, HASH or CODE).
+Returns the class name of the wrapped method metaclass, see
+L<Class::MOP::Method::Wrapped> for more information on the wrapped
+method metaclass.
-=item B<get_all_package_symbols (?$type_filter)>
+=item B<< Class::MOP::Package->meta >>
-Works exactly like C<list_all_package_symbols> but returns a HASH of
-name => thing mapping instead of just an ARRAY of names.
+This will return a L<Class::MOP::Class> instance for this class.
=back
=head1 COPYRIGHT AND LICENSE
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/Class-MOP.git / blobdiff