[gitmo/Class-MOP.git] / lib / Class / MOP / Method.pm


package Class::MOP::Method;

use strict;
use warnings;

use Carp         'confess';
use Scalar::Util 'weaken';

our $VERSION   = '0.65';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';

use base 'Class::MOP::Object';

# NOTE:
# if poked in the right way,
# they should act like CODE refs.
use overload '&{}' => sub { $_[0]->body }, fallback => 1;

our $UPGRADE_ERROR_TEXT = q{
---------------------------------------------------------
NOTE: this error is likely not an error, but a regression
caused by the latest upgrade to Moose/Class::MOP. Consider
upgrading any MooseX::* modules to their latest versions
before spending too much time chasing this one down.
---------------------------------------------------------
};

# construction

sub wrap {
    my ( $class, @args ) = @_;

    unshift @args, 'body' if @args % 2 == 1;

    my %params = @args;
    my $code = $params{body};

    ('CODE' eq ref($code))
        || confess "You must supply a CODE reference to bless, not (" . ($code || 'undef') . ")";

    ($params{package_name} && $params{name})
        || confess "You must supply the package_name and name parameters $UPGRADE_ERROR_TEXT";

    my $self = (ref($class) || $class)->_new(\%params);

    weaken($self->{associated_metaclass}) if $self->{associated_metaclass};

    return $self;
}

sub _new {
    my $class = shift;
    my $params = @_ == 1 ? $_[0] : {@_};

    my $self = bless {
        'body'                 => $params->{body},
        'associated_metaclass' => $params->{associated_metaclass},
        'package_name'         => $params->{package_name},
        'name'                 => $params->{name},
    } => $class;
}

## accessors

sub body { (shift)->{'body'} }

sub associated_metaclass { shift->{'associated_metaclass'} }

sub attach_to_class {
    my ( $self, $class ) = @_;
    $self->{associated_metaclass} = $class;
    weaken($self->{associated_metaclass});
}

sub detach_from_class {
    my $self = shift;
    delete $self->{associated_metaclass};
}

sub package_name { (shift)->{'package_name'} }

sub name { (shift)->{'name'} }

sub fully_qualified_name {
    my $code = shift;
    $code->package_name . '::' . $code->name;
}

# NOTE:
# the Class::MOP bootstrap
# will create this for us
# - SL
# sub clone { ... }

1;

__END__

=pod

=head1 NAME

Class::MOP::Method - Method Meta Object

=head1 DESCRIPTION

The Method Protocol is very small, since methods in Perl 5 are just
subroutines within the particular package. We provide a very basic
introspection interface.

=head1 METHODS

=head2 Introspection

=over 4

=item B<meta>

This will return a B<Class::MOP::Class> instance which is related
to this class.

=back

=head2 Construction

=over 4

=item B<wrap ($code, %params)>

This is the basic constructor, it returns a B<Class::MOP::Method>
instance which wraps the given C<$code> reference. You can also
set the C<package_name> and C<name> attributes using the C<%params>.
If these are not set, then thier accessors will attempt to figure
it out using the C<Class::MOP::get_code_info> function.

=item B<clone (%params)>

This will make a copy of the object, allowing you to override
any values by stuffing them in C<%params>.

=back

=head2 Informational

=over 4

=item B<body>

This returns the actual CODE reference of the particular instance.

=item B<name>

This returns the name of the CODE reference.

=item B<associated_metaclass>

The metaclass of the method

=item B<package_name>

This returns the package name that the CODE reference is attached to.

=item B<fully_qualified_name>

This returns the fully qualified name of the CODE reference.

=back

=head2 Metaclass

=over 4

=item B<attach_to_class>

Sets the associated metaclass

=item B<detach_from_class>

Disassociates the method from the metaclass

=back

=head1 AUTHORS

Stevan Little E<lt>stevan@iinteractive.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright 2006-2008 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
Commit	Line	Data
8b978dd5	1
	2	package Class::MOP::Method;
	3
	4	use strict;
	5	use warnings;
	6
2eb717d5	7	use Carp 'confess';
5e607260	8	use Scalar::Util 'weaken';
2eb717d5	9
94278c1b	10	our $VERSION = '0.65';
d519662a	11	$VERSION = eval $VERSION;
f0480c45	12	our $AUTHORITY = 'cpan:STEVAN';
de19f115	13
b1897d4d	14	use base 'Class::MOP::Object';
b1897d4d	15
ce2ae40f	16	# NOTE:
32202ce2	17	# if poked in the right way,
ce2ae40f	18	# they should act like CODE refs.
c23184fc	19	use overload '&{}' => sub { $_[0]->body }, fallback => 1;
7855ddba	20
32202ce2	21	our $UPGRADE_ERROR_TEXT = q{
	22	---------------------------------------------------------
	23	NOTE: this error is likely not an error, but a regression
	24	caused by the latest upgrade to Moose/Class::MOP. Consider
	25	upgrading any MooseX::* modules to their latest versions
	26	before spending too much time chasing this one down.
	27	---------------------------------------------------------
	28	};
	29
de19f115	30	# construction
de19f115	31
32202ce2	32	sub wrap {
5caf45ce	33	my ( $class, @args ) = @_;
	34
	35	unshift @args, 'body' if @args % 2 == 1;
	36
	37	my %params = @args;
	38	my $code = $params{body};
32202ce2	39
9b522fc4	40	('CODE' eq ref($code))
4d47b77f	41	\|\| confess "You must supply a CODE reference to bless, not (" . ($code \|\| 'undef') . ")";
32202ce2	42
b38f3848	43	($params{package_name} && $params{name})
32202ce2	44	\|\| confess "You must supply the package_name and name parameters $UPGRADE_ERROR_TEXT";
32202ce2	45
0bfc85b8	46	my $self = (ref($class) \|\| $class)->_new(\%params);
5e607260	47
	48	weaken($self->{associated_metaclass}) if $self->{associated_metaclass};
	49
	50	return $self;
de19f115	51	}
de19f115	52
71b98d4f	53	sub _new {
0bfc85b8	54	my $class = shift;
0bfc85b8	55	my $params = @_ == 1 ? $_[0] : {@_};
71b98d4f	56
71b98d4f	57	my $self = bless {
0bfc85b8	58	'body' => $params->{body},
	59	'associated_metaclass' => $params->{associated_metaclass},
	60	'package_name' => $params->{package_name},
	61	'name' => $params->{name},
71b98d4f	62	} => $class;
	63	}
	64
ce2ae40f	65	## accessors
ce2ae40f	66
8683db0e	67	sub body { (shift)->{'body'} }
7855ddba	68
5e607260	69	sub associated_metaclass { shift->{'associated_metaclass'} }
b1897d4d	70
5e607260	71	sub attach_to_class {
	72	my ( $self, $class ) = @_;
	73	$self->{associated_metaclass} = $class;
	74	weaken($self->{associated_metaclass});
	75	}
	76
	77	sub detach_from_class {
	78	my $self = shift;
	79	delete $self->{associated_metaclass};
	80	}
de19f115	81
da88f307	82	sub package_name { (shift)->{'package_name'} }
de19f115	83
da88f307	84	sub name { (shift)->{'name'} }
de19f115	85
96ceced8	86	sub fully_qualified_name {
0310d95d	87	my $code = shift;
0310d95d	88	$code->package_name . '::' . $code->name;
96ceced8	89	}
96ceced8	90
4c105333	91	# NOTE:
	92	# the Class::MOP bootstrap
	93	# will create this for us
	94	# - SL
	95	# sub clone { ... }
	96
8b978dd5	97	1;
	98
	99	__END__
	100
	101	=pod
	102
32202ce2	103	=head1 NAME
8b978dd5	104
	105	Class::MOP::Method - Method Meta Object
	106
8b978dd5	107	=head1 DESCRIPTION
8b978dd5	108
32202ce2	109	The Method Protocol is very small, since methods in Perl 5 are just
32202ce2	110	subroutines within the particular package. We provide a very basic
86482605	111	introspection interface.
fe122940	112
2eb717d5	113	=head1 METHODS
2eb717d5	114
de19f115	115	=head2 Introspection
2eb717d5	116
de19f115	117	=over 4
fe122940	118
2eb717d5	119	=item B<meta>
2eb717d5	120
32202ce2	121	This will return a B<Class::MOP::Class> instance which is related
fe122940	122	to this class.
fe122940	123
2eb717d5	124	=back
2eb717d5	125
de19f115	126	=head2 Construction
	127
	128	=over 4
	129
4c105333	130	=item B<wrap ($code, %params)>
127d39a7	131
32202ce2	132	This is the basic constructor, it returns a B<Class::MOP::Method>
32202ce2	133	instance which wraps the given C<$code> reference. You can also
4c105333	134	set the C<package_name> and C<name> attributes using the C<%params>.
32202ce2	135	If these are not set, then thier accessors will attempt to figure
4c105333	136	it out using the C<Class::MOP::get_code_info> function.
	137
	138	=item B<clone (%params)>
	139
32202ce2	140	This will make a copy of the object, allowing you to override
4c105333	141	any values by stuffing them in C<%params>.
de19f115	142
de19f115	143	=back
	144
	145	=head2 Informational
	146
	147	=over 4
	148
7855ddba	149	=item B<body>
7855ddba	150
127d39a7	151	This returns the actual CODE reference of the particular instance.
127d39a7	152
de19f115	153	=item B<name>
de19f115	154
127d39a7	155	This returns the name of the CODE reference.
127d39a7	156
5e607260	157	=item B<associated_metaclass>
	158
	159	The metaclass of the method
	160
de19f115	161	=item B<package_name>
de19f115	162
127d39a7	163	This returns the package name that the CODE reference is attached to.
127d39a7	164
96ceced8	165	=item B<fully_qualified_name>
96ceced8	166
127d39a7	167	This returns the fully qualified name of the CODE reference.
127d39a7	168
96ceced8	169	=back
96ceced8	170
5e607260	171	=head2 Metaclass
	172
	173	=over 4
	174
	175	=item B<attach_to_class>
	176
	177	Sets the associated metaclass
	178
	179	=item B<detach_from_class>
	180
	181	Disassociates the method from the metaclass
	182
	183	=back
	184
1a09d9cc	185	=head1 AUTHORS
8b978dd5	186
a2e85e6c	187	Stevan Little E<lt>stevan@iinteractive.comE<gt>
8b978dd5	188
	189	=head1 COPYRIGHT AND LICENSE
	190
69e3ab0a	191	Copyright 2006-2008 by Infinity Interactive, Inc.
8b978dd5	192
	193	L<http://www.iinteractive.com>
	194
	195	This library is free software; you can redistribute it and/or modify
32202ce2	196	it under the same terms as Perl itself.
8b978dd5	197
16e960bd	198	=cut
16e960bd	199