1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
package Class::MOP::Package;
use strict;
use warnings;
use Scalar::Util 'blessed', 'reftype';
use Carp 'confess';
use Package::Stash;
our $VERSION = '1.04';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
use base 'Class::MOP::Object';
# creation ...
sub initialize {
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
if ( my $meta = Class::MOP::get_metaclass_by_name($package_name) ) {
return $meta;
} else {
my $meta = ( ref $class || $class )->_new({
'package' => $package_name,
%options,
});
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 || $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);
$class->initialize($package_name, %options); # call with first arg form for compat
}
sub _new {
my $class = shift;
return Class::MOP::Class->initialize($class)->new_object(@_)
if $class ne __PACKAGE__;
my $params = @_ == 1 ? $_[0] : {@_};
return bless {
package => $params->{package},
# 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
# NOTE:
# all these attribute readers will be bootstrapped
# away in the Class::MOP bootstrap section
sub _package_stash {
$_[0]->{_package_stash} ||= Package::Stash->new($_[0]->name)
}
sub namespace {
$_[0]->_package_stash->namespace
}
# Class attributes
# ... these functions have to touch the symbol table itself,.. yuk
sub add_package_symbol {
my $self = shift;
$self->_package_stash->add_package_symbol(@_);
}
sub remove_package_glob {
my $self = shift;
$self->_package_stash->remove_package_glob(@_);
}
# ... these functions deal with stuff on the namespace level
sub has_package_symbol {
my $self = shift;
$self->_package_stash->has_package_symbol(@_);
}
sub get_package_symbol {
my $self = shift;
$self->_package_stash->get_package_symbol(@_);
}
sub remove_package_symbol {
my $self = shift;
$self->_package_stash->remove_package_symbol(@_);
}
sub list_all_package_symbols {
my $self = shift;
$self->_package_stash->list_all_package_symbols(@_);
}
1;
__END__
=pod
=head1 NAME
Class::MOP::Package - Package Meta Object
=head1 DESCRIPTION
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<< 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.
=item B<< $metapackage->has_package_symbol($variable_name) >>
Returns true if there is a package variable defined for
C<$variable_name>. The C<$variable_name> must contain a leading sigil.
=item B<< $metapackage->remove_package_symbol($variable_name) >>
This will remove the package variable specified C<$variable_name>. The
C<$variable_name> must contain a leading sigil.
=item B<< $metapackage->remove_package_glob($glob_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.
=item B<< Class::MOP::Package->meta >>
This will return a L<Class::MOP::Class> instance for this class.
=back
=head1 AUTHORS
Stevan Little E<lt>stevan@iinteractive.comE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2006-2010 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|