X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FMOP%2FImmutable.pm;h=47e1bac757b1b2390fe6585cf610027e2ff86784;hb=f0de47d9b033b6b5175454e7fb3fb43c4ef5ed2e;hp=1d91c8d3db9aa4389c88bd29c20eb66f74ea8f98;hpb=0ac992ee5992b68d0019cf1c1fd16000adf9b71f;p=gitmo%2FClass-MOP.git diff --git a/lib/Class/MOP/Immutable.pm b/lib/Class/MOP/Immutable.pm index 1d91c8d..47e1bac 100644 --- a/lib/Class/MOP/Immutable.pm +++ b/lib/Class/MOP/Immutable.pm @@ -9,29 +9,55 @@ use Class::MOP::Method::Constructor; use Carp 'confess'; use Scalar::Util 'blessed'; -our $VERSION = '0.01'; +our $VERSION = '0.71_01'; +$VERSION = eval $VERSION; our $AUTHORITY = 'cpan:STEVAN'; +use base 'Class::MOP::Object'; + sub new { - my ($class, $metaclass, $options) = @_; + my ($class, @args) = @_; - my $self = bless { - '$!metaclass' => $metaclass, - '%!options' => $options, - '$!immutable_metaclass' => undef, - } => $class; + my ( $metaclass, $options ); - # NOTE: - # we initialize the immutable - # version of the metaclass here - $self->create_immutable_metaclass; + if ( @args == 2 ) { + # compatibility args + ( $metaclass, $options ) = @args; + } else { + unshift @args, "metaclass" if @args % 2 == 1; + + # default named args + my %options = @args; + $options = \%options; + $metaclass = $options{metaclass}; + } + + my $self = $class->_new( + 'metaclass' => $metaclass, + 'options' => $options, + 'immutable_metaclass' => undef, + ); return $self; } -sub immutable_metaclass { (shift)->{'$!immutable_metaclass'} } -sub metaclass { (shift)->{'$!metaclass'} } -sub options { (shift)->{'%!options'} } +sub _new { + my $class = shift; + my $options = @_ == 1 ? $_[0] : {@_}; + + bless $options, $class; +} + +sub immutable_metaclass { + my $self = shift; + + $self->create_immutable_metaclass unless $self->{'immutable_metaclass'}; + + return $self->{'immutable_metaclass'}; +} + +sub metaclass { (shift)->{'metaclass'} } +sub options { (shift)->{'options'} } sub create_immutable_metaclass { my $self = shift; @@ -41,25 +67,35 @@ sub create_immutable_metaclass { # metaclass is just a anon-class # which shadows the methods # appropriately - $self->{'$!immutable_metaclass'} = Class::MOP::Class->create_anon_class( + $self->{'immutable_metaclass'} = Class::MOP::Class->create_anon_class( superclasses => [ blessed($self->metaclass) ], methods => $self->create_methods_for_immutable_metaclass, ); } + my %DEFAULT_METHODS = ( + # I don't really understand this, but removing it breaks tests (groditi) meta => sub { my $self = shift; # if it is not blessed, then someone is asking - # for the meta of Class::MOP::Class::Immutable + # for the meta of Class::MOP::Immutable return Class::MOP::Class->initialize($self) unless blessed($self); # otherwise, they are asking for the metaclass # which has been made immutable, which is itself - return $self; + # except in the cases where it is a metaclass itself + # that has been made immutable and for that we need + # to dig a bit ... + if ($self->isa('Class::MOP::Class')) { + return $self->{'___original_class'}->meta; + } + else { + return $self; + } }, - is_mutable => sub { 0 }, - is_immutable => sub { 1 }, - make_immutable => sub { ( ) }, + is_mutable => sub { 0 }, + is_immutable => sub { 1 }, + make_immutable => sub { () }, ); # NOTE: @@ -67,168 +103,263 @@ my %DEFAULT_METHODS = ( # existing metaclass to an immutable # version of itself sub make_metaclass_immutable { - my ($self, $metaclass, %options) = @_; - - $options{inline_accessors} = 1 unless exists $options{inline_accessors}; - $options{inline_constructor} = 1 unless exists $options{inline_constructor}; - $options{inline_destructor} = 0 unless exists $options{inline_destructor}; - $options{constructor_name} = 'new' unless exists $options{constructor_name}; - $options{debug} = 0 unless exists $options{debug}; - - if ($options{inline_accessors}) { - foreach my $attr_name ($metaclass->get_attribute_list) { - # inline the accessors - $metaclass->get_attribute($attr_name) - ->install_accessors(1); - } - } + my ($self, $metaclass, $options) = @_; + + my %options = ( + inline_accessors => 1, + inline_constructor => 1, + inline_destructor => 0, + constructor_name => 'new', + debug => 0, + %$options, + ); - if ($options{inline_constructor}) { - my $constructor_class = $options{constructor_class} || 'Class::MOP::Method::Constructor'; + %$options = %options; # FIXME who the hell is relying on this?!? tests fail =( - $metaclass->add_method( - $options{constructor_name}, - $constructor_class->new( - options => \%options, - metaclass => $metaclass, - ) - ) unless $metaclass->has_method($options{constructor_name}); - } + $self->_inline_accessors( $metaclass, \%options ); + $self->_inline_constructor( $metaclass, \%options ); + $self->_inline_destructor( $metaclass, \%options ); + $self->_check_memoized_methods( $metaclass, \%options ); - if ($options{inline_destructor}) { - (exists $options{destructor_class}) - || confess "The 'inline_destructor' option is present, but " - . "no destructor class was specified"; - - my $destructor_class = $options{destructor_class}; - - my $destructor = $destructor_class->new( - options => \%options, - metaclass => $metaclass, - ); - - $metaclass->add_method('DESTROY' => $destructor) - # NOTE: - # we allow the destructor to determine - # if it is needed or not, it can perform - # all sorts of checks because it has the - # metaclass instance - if $destructor->is_needed; - } + $metaclass->{'___original_class'} = blessed($metaclass); + bless $metaclass => $self->immutable_metaclass->name; +} - my $memoized_methods = $self->options->{memoize}; - foreach my $method_name (keys %{$memoized_methods}) { - my $type = $memoized_methods->{$method_name}; +sub _inline_accessors { + my ( $self, $metaclass, $options ) = @_; - ($metaclass->can($method_name)) - || confess "Could not find the method '$method_name' in " . $metaclass->name; + return unless $options->{inline_accessors}; - if ($type eq 'ARRAY') { - $metaclass->{'___' . $method_name} = [ $metaclass->$method_name ]; - } - elsif ($type eq 'HASH') { - $metaclass->{'___' . $method_name} = { $metaclass->$method_name }; - } - elsif ($type eq 'SCALAR') { - $metaclass->{'___' . $method_name} = $metaclass->$method_name; - } + foreach my $attr_name ( $metaclass->get_attribute_list ) { + $metaclass->get_attribute($attr_name)->install_accessors(1); } +} - #I'm not sure i understand this, stevan suggested the addition i don't think its actually needed - #my $is_immutable = $metaclass->is_anon_class; - #$self->immutable_metaclass->add_method('is_anon_class' => sub { $is_immutable }); +sub _inline_constructor { + my ( $self, $metaclass, $options ) = @_; - $metaclass->{'___original_class'} = blessed($metaclass); - bless $metaclass => $self->immutable_metaclass->name; + return unless $options->{inline_constructor}; + + return + unless $options->{replace_constructor} + or !$metaclass->has_method( $options->{constructor_name} ); + + my $constructor_class = $options->{constructor_class} + || 'Class::MOP::Method::Constructor'; + + my $constructor = $constructor_class->new( + options => $options, + metaclass => $metaclass, + is_inline => 1, + package_name => $metaclass->name, + name => $options->{constructor_name}, + ); + + $metaclass->add_method( $options->{constructor_name} => $constructor ) + if $constructor->can_be_inlined; } -sub make_metaclass_mutable { - my ($self, $immutable, %options) = @_; +sub _inline_destructor { + my ( $self, $metaclass, $options ) = @_; - my $original_class = $immutable->get_mutable_metaclass_name; - delete $immutable->{'___original_class'} ; - bless $immutable => $original_class; + return unless $options->{inline_destructor}; - my $memoized_methods = $self->options->{memoize}; - foreach my $method_name (keys %{$memoized_methods}) { - my $type = $memoized_methods->{$method_name}; + ( exists $options->{destructor_class} ) + || confess "The 'inline_destructor' option is present, but " + . "no destructor class was specified"; - ($immutable->can($method_name)) - || confess "Could not find the method '$method_name' in " . $immutable->name; - if ($type eq 'SCALAR' || $type eq 'ARRAY' || $type eq 'HASH' ) { - delete $immutable->{'___' . $method_name}; - } - } + my $destructor_class = $options->{destructor_class}; - if ($options{inline_destructor} && $immutable->has_method('DESTROY')) { - $immutable->remove_method('DESTROY') - if $immutable->get_method('DESTROY')->blessed eq $options{destructor_class}; - } + return unless $destructor_class->is_needed($metaclass); - #14:01 <@stevan> nah,. you shouldnt - #14:01 <@stevan> they are just inlined - #14:01 <@stevan> which is the default in Moose anyway - #14:02 <@stevan> and adding new attributes will just DWIM - #14:02 <@stevan> and you really cant change an attribute anyway - #if ($options{inline_accessors}) { - # foreach my $attr_name ($immutable->get_attribute_list) { - # my $attr = $immutable->get_attribute($attr_name); - # $attr->remove_accessors; - # $attr->install_accessors(0); - # } - #} - - #14:26 <@stevan> the only user of ::Method::Constructor is immutable - #14:27 <@stevan> if someone uses it outside of immutable,.. they are either: mst or groditi - #14:27 <@stevan> so I am not worried - $options{constructor_name} = 'new' unless exists $options{constructor_name}; - if ($options{inline_constructor}) { - my $constructor_class = $options{constructor_class} || 'Class::MOP::Method::Constructor'; - $immutable->remove_method( $options{constructor_name} ) - if $immutable->get_method($options{constructor_name})->blessed eq $constructor_class; + my $destructor = $destructor_class->new( + options => $options, + metaclass => $metaclass, + package_name => $metaclass->name, + name => 'DESTROY' + ); + + return unless $destructor->is_needed; + + $metaclass->add_method( 'DESTROY' => $destructor ) +} + +sub _check_memoized_methods { + my ( $self, $metaclass, $options ) = @_; + + my $memoized_methods = $self->options->{memoize}; + foreach my $method_name ( keys %{$memoized_methods} ) { + my $type = $memoized_methods->{$method_name}; + + ( $metaclass->can($method_name) ) + || confess "Could not find the method '$method_name' in " + . $metaclass->name; } } sub create_methods_for_immutable_metaclass { my $self = shift; - my %methods = %DEFAULT_METHODS; + my %methods = %DEFAULT_METHODS; + my $metaclass = $self->metaclass; + my $meta = $metaclass->meta; - foreach my $read_only_method (@{$self->options->{read_only}}) { - my $method = $self->metaclass->meta->find_method_by_name($read_only_method); + $methods{get_mutable_metaclass_name} + = sub { (shift)->{'___original_class'} }; - (defined $method) - || confess "Could not find the method '$read_only_method' in " . $self->metaclass->name; + $methods{immutable_transformer} = sub {$self}; + + return { + %DEFAULT_METHODS, + $self->_make_read_only_methods( $metaclass, $meta ), + $self->_make_uncallable_methods( $metaclass, $meta ), + $self->_make_memoized_methods( $metaclass, $meta ), + $self->_make_wrapped_methods( $metaclass, $meta ), + get_mutable_metaclass_name => sub { (shift)->{'___original_class'} }, + immutable_transformer => sub {$self}, + }; +} + +sub _make_read_only_methods { + my ( $self, $metaclass, $meta ) = @_; + + my %methods; + foreach my $read_only_method ( @{ $self->options->{read_only} } ) { + my $method = $meta->find_method_by_name($read_only_method); + + ( defined $method ) + || confess "Could not find the method '$read_only_method' in " + . $metaclass->name; $methods{$read_only_method} = sub { confess "This method is read-only" if scalar @_ > 1; - goto &{$method->body} + goto &{ $method->body }; }; } - foreach my $cannot_call_method (@{$self->options->{cannot_call}}) { + return %methods; +} + +sub _make_uncallable_methods { + my ( $self, $metaclass, $meta ) = @_; + + my %methods; + foreach my $cannot_call_method ( @{ $self->options->{cannot_call} } ) { $methods{$cannot_call_method} = sub { - confess "This method ($cannot_call_method) cannot be called on an immutable instance"; + confess + "This method ($cannot_call_method) cannot be called on an immutable instance"; }; } + return %methods; +} + +sub _make_memoized_methods { + my ( $self, $metaclass, $meta ) = @_; + + my %methods; + my $memoized_methods = $self->options->{memoize}; - foreach my $method_name (keys %{$memoized_methods}) { - my $type = $memoized_methods->{$method_name}; - if ($type eq 'ARRAY') { - $methods{$method_name} = sub { @{$_[0]->{'___' . $method_name}} }; + foreach my $method_name ( keys %{$memoized_methods} ) { + my $type = $memoized_methods->{$method_name}; + my $key = '___' . $method_name; + my $method = $meta->find_method_by_name($method_name); + + if ( $type eq 'ARRAY' ) { + $methods{$method_name} = sub { + @{ $_[0]->{$key} } = $method->execute( $_[0] ) + if !exists $_[0]->{$key}; + return @{ $_[0]->{$key} }; + }; } - elsif ($type eq 'HASH') { - $methods{$method_name} = sub { %{$_[0]->{'___' . $method_name}} }; + elsif ( $type eq 'HASH' ) { + $methods{$method_name} = sub { + %{ $_[0]->{$key} } = $method->execute( $_[0] ) + if !exists $_[0]->{$key}; + return %{ $_[0]->{$key} }; + }; } - elsif ($type eq 'SCALAR') { - $methods{$method_name} = sub { $_[0]->{'___' . $method_name} }; + elsif ( $type eq 'SCALAR' ) { + $methods{$method_name} = sub { + $_[0]->{$key} = $method->execute( $_[0] ) + if !exists $_[0]->{$key}; + return $_[0]->{$key}; + }; } } - $methods{get_mutable_metaclass_name} = sub { (shift)->{'___original_class'} }; + return %methods; +} - return \%methods; +sub _make_wrapped_methods { + my ( $self, $metaclass, $meta ) = @_; + + my %methods; + + my $wrapped_methods = $self->options->{wrapped}; + + foreach my $method_name ( keys %{$wrapped_methods} ) { + my $method = $meta->find_method_by_name($method_name); + + ( defined $method ) + || confess "Could not find the method '$method_name' in " + . $metaclass->name; + + my $wrapper = $wrapped_methods->{$method_name}; + + $methods{$method_name} = sub { $wrapper->( $method, @_ ) }; + } + + return %methods; +} + +sub make_metaclass_mutable { + my ($self, $immutable, $options) = @_; + + my %options = %$options; + + my $original_class = $immutable->get_mutable_metaclass_name; + delete $immutable->{'___original_class'} ; + bless $immutable => $original_class; + + my $memoized_methods = $self->options->{memoize}; + foreach my $method_name (keys %{$memoized_methods}) { + my $type = $memoized_methods->{$method_name}; + + ($immutable->can($method_name)) + || confess "Could not find the method '$method_name' in " . $immutable->name; + if ($type eq 'SCALAR' || $type eq 'ARRAY' || $type eq 'HASH' ) { + delete $immutable->{'___' . $method_name}; + } + } + + if ($options{inline_destructor} && $immutable->has_method('DESTROY')) { + $immutable->remove_method('DESTROY') + if blessed($immutable->get_method('DESTROY')) eq $options{destructor_class}; + } + + # NOTE: + # 14:01 <@stevan> nah,. you shouldnt + # 14:01 <@stevan> they are just inlined + # 14:01 <@stevan> which is the default in Moose anyway + # 14:02 <@stevan> and adding new attributes will just DWIM + # 14:02 <@stevan> and you really cant change an attribute anyway + # if ($options{inline_accessors}) { + # foreach my $attr_name ($immutable->get_attribute_list) { + # my $attr = $immutable->get_attribute($attr_name); + # $attr->remove_accessors; + # $attr->install_accessors(0); + # } + # } + + # 14:26 <@stevan> the only user of ::Method::Constructor is immutable + # 14:27 <@stevan> if someone uses it outside of immutable,.. they are either: mst or groditi + # 14:27 <@stevan> so I am not worried + if ($options{inline_constructor} && $immutable->has_method($options{constructor_name})) { + my $constructor_class = $options{constructor_class} || 'Class::MOP::Method::Constructor'; + $immutable->remove_method( $options{constructor_name} ) + if blessed($immutable->get_method($options{constructor_name})) eq $constructor_class; + } } 1; @@ -273,8 +404,9 @@ metaclass. Current features include making methods read-only, making methods un-callable and memoizing methods (in a type specific way too). -This module is fairly new to the MOP, and quite possibly will be -expanded and further generalized as the need arises. +This module is not for the feint of heart, it does some whacky things +to the metaclass in order to make it immutable. If you are just curious, +I suggest you turn back now, there is nothing to see here. =head1 METHODS @@ -331,7 +463,7 @@ Stevan Little Estevan@iinteractive.comE =head1 COPYRIGHT AND LICENSE -Copyright 2006, 2007 by Infinity Interactive, Inc. +Copyright 2006-2008 by Infinity Interactive, Inc. L