more-package-refactoring
[gitmo/Class-MOP.git] / lib / Class / MOP / Package.pm
CommitLineData
2243a22b 1
2package Class::MOP::Package;
3
4use strict;
5use warnings;
6
7use Scalar::Util 'blessed';
6d5355c3 8use Carp 'confess';
2243a22b 9
9d6dce77 10our $VERSION = '0.02';
2243a22b 11
12# introspection
13
14sub meta {
15 require Class::MOP::Class;
16 Class::MOP::Class->initialize(blessed($_[0]) || $_[0]);
17}
18
6d5355c3 19# creation ...
20
21sub initialize {
9d6dce77 22 my $class = shift;
23 my $package_name = shift;
24 # we hand-construct the class
25 # until we can bootstrap it
a5e51f0b 26 no strict 'refs';
27 return bless {
28 '$:package' => $package_name,
29 '%:namespace' => \%{$package_name . '::'},
30 } => $class;
6d5355c3 31}
32
33# Attributes
34
35# NOTE:
36# all these attribute readers will be bootstrapped
37# away in the Class::MOP bootstrap section
38
a5e51f0b 39sub name { $_[0]->{'$:package'} }
40sub namespace { $_[0]->{'%:namespace'} }
6d5355c3 41
a5e51f0b 42# utility methods
6d5355c3 43
c0cbf4d9 44{
45 my %SIGIL_MAP = (
46 '$' => 'SCALAR',
47 '@' => 'ARRAY',
48 '%' => 'HASH',
49 '&' => 'CODE',
50 );
6d5355c3 51
a5e51f0b 52 sub _deconstruct_variable_name {
53 my ($self, $variable) = @_;
54
c0cbf4d9 55 (defined $variable)
56 || confess "You must pass a variable name";
a5e51f0b 57
c0cbf4d9 58 my ($sigil, $name) = ($variable =~ /^(.)(.*)$/);
a5e51f0b 59
c0cbf4d9 60 (defined $sigil)
61 || confess "The variable name must include a sigil";
a5e51f0b 62
c0cbf4d9 63 (exists $SIGIL_MAP{$sigil})
a5e51f0b 64 || confess "I do not recognize that sigil '$sigil'";
65
66 return ($name, $sigil, $SIGIL_MAP{$sigil});
c0cbf4d9 67 }
a5e51f0b 68}
6d5355c3 69
a5e51f0b 70# Class attributes
6d5355c3 71
a5e51f0b 72sub add_package_symbol {
73 my ($self, $variable, $initial_value) = @_;
6d5355c3 74
a5e51f0b 75 my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable);
6d5355c3 76
a5e51f0b 77 no strict 'refs';
78 no warnings 'misc', 'redefine';
79 *{$self->name . '::' . $name} = $initial_value;
80}
6d5355c3 81
a5e51f0b 82sub has_package_symbol {
83 my ($self, $variable) = @_;
84
85 my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable);
86
87 return 0 unless exists $self->namespace->{$name};
88 defined *{$self->namespace->{$name}}{$type} ? 1 : 0;
89}
90
91sub get_package_symbol {
92 my ($self, $variable) = @_;
93
94 my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable);
95
96 return *{$self->namespace->{$name}}{$type}
97 if exists $self->namespace->{$name};
98 $self->add_package_symbol($variable);
99}
100
101sub remove_package_symbol {
102 my ($self, $variable) = @_;
103
104 my ($name, $sigil, $type) = $self->_deconstruct_variable_name($variable);
105
106 if ($type eq 'SCALAR') {
107 undef ${$self->namespace->{$name}};
108 }
109 elsif ($type eq 'ARRAY') {
110 undef @{$self->namespace->{$name}};
111 }
112 elsif ($type eq 'HASH') {
113 undef %{$self->namespace->{$name}};
114 }
115 elsif ($type eq 'CODE') {
116 # FIXME:
117 # this is crap, it is probably much
118 # easier to write this in XS.
119 my ($scalar, @array, %hash);
120 $scalar = ${$self->namespace->{$name}} if defined *{$self->namespace->{$name}}{SCALAR};
121 @array = @{$self->namespace->{$name}} if defined *{$self->namespace->{$name}}{ARRAY};
122 %hash = %{$self->namespace->{$name}} if defined *{$self->namespace->{$name}}{HASH};
123 {
124 no strict 'refs';
9d6dce77 125 delete ${$self->name . '::'}{$name};
c0cbf4d9 126 }
a5e51f0b 127 ${$self->namespace->{$name}} = $scalar if defined $scalar;
128 @{$self->namespace->{$name}} = @array if scalar @array;
129 %{$self->namespace->{$name}} = %hash if keys %hash;
130 }
131 else {
132 confess "This should never ever ever happen";
7f436b8c 133 }
9d6dce77 134}
c0cbf4d9 135
9d6dce77 136sub list_all_package_symbols {
137 my ($self) = @_;
a5e51f0b 138 return keys %{$self->namespace};
6d5355c3 139}
140
2243a22b 1411;
142
143__END__
144
145=pod
146
147=head1 NAME
148
149Class::MOP::Package - Package Meta Object
150
151=head1 SYNOPSIS
152
153=head1 DESCRIPTION
154
155=head1 METHODS
156
157=over 4
158
159=item B<meta>
160
6d5355c3 161=item B<initialize>
162
163=item B<name>
164
a5e51f0b 165=item B<namespace>
166
58d75218 167=item B<add_package_symbol>
6d5355c3 168
58d75218 169=item B<get_package_symbol>
6d5355c3 170
58d75218 171=item B<has_package_symbol>
6d5355c3 172
58d75218 173=item B<remove_package_symbol>
6d5355c3 174
9d6dce77 175=item B<list_all_package_symbols>
176
2243a22b 177=back
178
1a09d9cc 179=head1 AUTHORS
2243a22b 180
181Stevan Little E<lt>stevan@iinteractive.comE<gt>
182
1a09d9cc 183Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
184
2243a22b 185=head1 COPYRIGHT AND LICENSE
186
187Copyright 2006 by Infinity Interactive, Inc.
188
189L<http://www.iinteractive.com>
190
191This library is free software; you can redistribute it and/or modify
192it under the same terms as Perl itself.
193
194=cut