summaryrefslogtreecommitdiff
path: root/lib/Class/MakeMethods/Composite
diff options
context:
space:
mode:
authorAndreas Brachold <vdr07@deltab.de>2007-08-13 18:41:27 +0000
committerAndreas Brachold <vdr07@deltab.de>2007-08-13 18:41:27 +0000
commitbcbf441e09fb502cf64924ff2530fa144bdf52c5 (patch)
treef377707a2dac078db8cd0c7d7abfe69ac1006d71 /lib/Class/MakeMethods/Composite
downloadxxv-bcbf441e09fb502cf64924ff2530fa144bdf52c5.tar.gz
xxv-bcbf441e09fb502cf64924ff2530fa144bdf52c5.tar.bz2
* Move files to trunk
Diffstat (limited to 'lib/Class/MakeMethods/Composite')
-rw-r--r--lib/Class/MakeMethods/Composite/Array.pm794
-rw-r--r--lib/Class/MakeMethods/Composite/Global.pm588
-rw-r--r--lib/Class/MakeMethods/Composite/Hash.pm719
-rw-r--r--lib/Class/MakeMethods/Composite/Inheritable.pm613
-rw-r--r--lib/Class/MakeMethods/Composite/Universal.pm150
5 files changed, 2864 insertions, 0 deletions
diff --git a/lib/Class/MakeMethods/Composite/Array.pm b/lib/Class/MakeMethods/Composite/Array.pm
new file mode 100644
index 0000000..fe04eba
--- /dev/null
+++ b/lib/Class/MakeMethods/Composite/Array.pm
@@ -0,0 +1,794 @@
+=head1 NAME
+
+Class::MakeMethods::Composite::Array - Basic array methods
+
+=head1 SYNOPSIS
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Array (
+ new => 'new',
+ scalar => [ 'foo', 'bar' ],
+ array => 'my_list',
+ hash => 'my_index',
+ );
+ ...
+
+ my $obj = MyObject->new( foo => 'Foozle' );
+ print $obj->foo();
+
+ $obj->bar('Barbados');
+ print $obj->bar();
+
+ $obj->my_list(0 => 'Foozle', 1 => 'Bang!');
+ print $obj->my_list(1);
+
+ $obj->my_index('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+ print $obj->my_index('foo');
+
+=head1 DESCRIPTION
+
+The Composite::Array suclass of MakeMethods provides a basic
+constructor and accessors for blessed-array object instances.
+
+=head2 Class::MakeMethods Calling Conventions
+
+When you C<use> this package, the method declarations you provide
+as arguments cause subroutines to be generated and installed in
+your module.
+
+You can also omit the arguments to C<use> and instead make methods
+at runtime by passing the declarations to a subsequent call to
+C<make()>.
+
+You may include any number of declarations in each call to C<use>
+or C<make()>. If methods with the same name already exist, earlier
+calls to C<use> or C<make()> win over later ones, but within each
+call, later declarations superceed earlier ones.
+
+You can install methods in a different package by passing C<-TargetClass =E<gt> I<package>> as your first arguments to C<use> or C<make>.
+
+See L<Class::MakeMethods> for more details.
+
+=head2 Class::MakeMethods::Basic Declaration Syntax
+
+The following types of Basic declarations are supported:
+
+=over 4
+
+=item *
+
+I<generator_type> => "I<method_name>"
+
+=item *
+
+I<generator_type> => "I<name_1> I<name_2>..."
+
+=item *
+
+I<generator_type> => [ "I<name_1>", "I<name_2>", ...]
+
+=back
+
+See the "METHOD GENERATOR TYPES" section below for a list of the supported values of I<generator_type>.
+
+For each method name you provide, a subroutine of the indicated
+type will be generated and installed under that name in your module.
+
+Method names should start with a letter, followed by zero or more
+letters, numbers, or underscores.
+
+=head2 Class::MakeMethods::Composite Declaration Syntax
+
+The Composite syntax also provides several ways to optionally
+associate a hash of additional parameters with a given method
+name.
+
+=over 4
+
+=item *
+
+I<generator_type> => [ "I<name_1>" => { I<param>=>I<value>... }, ... ]
+
+A hash of parameters to use just for this method name.
+
+(Note: to prevent confusion with self-contained definition hashes,
+described below, parameter hashes following a method name must not
+contain the key 'name'.)
+
+=item *
+
+I<generator_type> => [ [ "I<name_1>", "I<name_2>", ... ] => { I<param>=>I<value>... } ]
+
+Each of these method names gets a copy of the same set of parameters.
+
+=item *
+
+I<generator_type> => [ { "name"=>"I<name_1>", I<param>=>I<value>... }, ... ]
+
+By including the reserved parameter C<name>, you create a self
+contained declaration with that name and any associated hash values.
+
+=back
+
+Basic declarations, as described above, are treated as having an empty parameter hash.
+
+=cut
+
+package Class::MakeMethods::Composite::Array;
+
+$VERSION = 1.000;
+use strict;
+use Class::MakeMethods::Composite '-isasubclass';
+
+########################################################################
+
+=head2 Positional Accessors and %FIELDS
+
+Each accessor method is assigned the next available array index at
+which to store its value.
+
+The mapping between method names and array positions is stored in
+a hash named %FIELDS in the declaring package. When a package
+declares its first positional accessor, its %FIELDS are initialized
+by searching its inheritance tree.
+
+B<Warning>: Subclassing packages that use positional accessors is
+somewhat fragile, since you may end up with two distinct methods assigned to the same position. Specific cases to avoid are:
+
+=over 4
+
+=item *
+
+If you inherit from more than one class with positional accessors,
+the positions used by the two sets of methods will overlap.
+
+=item *
+
+If your superclass adds additional positional accessors after you
+declare your first, they will overlap yours.
+
+=back
+
+=cut
+
+sub _array_index {
+ my $class = shift;
+ my $name = shift;
+ no strict;
+ local $^W = 0;
+ if ( ! scalar %{$class . "::FIELDS"} ) {
+ my @classes = @{$class . "::ISA"};
+ my @fields;
+ while ( @classes ) {
+ my $superclass = shift @classes;
+ if ( scalar %{$superclass . "::FIELDS"} ) {
+ push @fields, %{$superclass . "::FIELDS"};
+ } else {
+ unshift @classes, @{$superclass . "::ISA"}
+ }
+ }
+ %{$class . "::FIELDS"} = @fields
+ }
+ my $field_hash = \%{$class . "::FIELDS"};
+ $field_hash->{$name} or $field_hash->{$name} = scalar keys %$field_hash
+}
+
+########################################################################
+
+=head1 METHOD GENERATOR TYPES
+
+=head2 new - Constructor
+
+For each method name passed, returns a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Has a reference to a sample item to copy. This defaults to a reference to an empty array, but you may override this with the C<'defaults' => I<array_ref>> method parameter.
+
+=item *
+
+If called as a class method, makes a new array containing values from the sample item, and blesses it into that class.
+
+=item *
+
+If called on an array-based instance, makes a copy of it and blesses the copy into the same class as the original instance.
+
+=item *
+
+If passed a list of method-value pairs, calls each named method with the associated value as an argument.
+
+=item *
+
+Returns the new instance.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Array (
+ new => 'new',
+ );
+ ...
+
+ # Bare constructor
+ my $empty = MyObject->new();
+
+ # Constructor with initial sequence of method calls
+ my $obj = MyObject->new( foo => 'Foozle', bar => 'Barbados' );
+
+ # Copy with overriding sequence of method calls
+ my $copy = $obj->new( bar => 'Bob' );
+
+=cut
+
+use vars qw( %ConstructorFragments );
+
+sub new {
+ (shift)->_build_composite( \%ConstructorFragments, @_ );
+}
+
+%ConstructorFragments = (
+ '' => [
+ '+init' => sub {
+ my $method = pop @_;
+ $method->{target_class} ||= $Class::MethodMaker::CONTEXT{TargetClass};
+ $method->{defaults} ||= [];
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $obj = ref($self) ? bless( [ @$self ], ref $self )
+ : bless( { @[$method->{defaults}] }, $self );
+ @_ = %{$_[0]}
+ if ( scalar @_ == 1 and ref $_[0] eq 'HASH' );
+ while ( scalar @_ ) {
+ my $method = shift @_;
+ $obj->$method( shift @_ );
+ }
+ $obj;
+ },
+ ],
+ 'with_values' => [
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ @_ = @[$_[0]]
+ if ( scalar @_ == 1 and ref $_[0] eq 'ARRAY' );
+ bless( [ @_ ], ref($self) || $self );
+ }
+ ],
+);
+
+########################################################################
+
+=head2 new_with_values - Constructor
+
+For each method name passed, returns a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or (equivalently) on any existing object of that class.
+
+=item *
+
+Creates an array, blesses it into the class, and returns the new instance.
+
+=item *
+
+If no arguments are provided, the returned array will be empty. If passed a single array-ref argument, copies its contents into the new array. If called with multiple arguments, copies them into the new array. (Note that this is a "shallow" copy, not a "deep" clone.)
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Array (
+ new => 'new',
+ );
+ ...
+
+ # Bare constructor
+ my $empty = MyObject->new();
+
+ # Constructor with initial sequence of method calls
+ my $obj = MyObject->new( foo => 'Foozle', bar => 'Barbados' );
+
+ # Copy with overriding sequence of method calls
+ my $copy = $obj->new( bar => 'Bob' );
+
+=cut
+
+########################################################################
+
+=head2 scalar - Instance Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on an array-based instance.
+
+=item *
+
+Determines the array position associated with the method name, and uses that as an index into each instance to access the related value. This defaults to the next available slot in %FIELDS, but you may override this with the C<'array_index' => I<number>> method parameter, or by pre-filling the contents of %FIELDS.
+
+=item *
+
+If called without any arguments returns the current value (or undef).
+
+=item *
+
+If called with an argument, stores that as the value, and returns it,
+
+=item *
+
+If called with multiple arguments, stores a reference to a new array with those arguments as contents, and returns that array reference.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Array (
+ scalar => 'foo',
+ );
+ ...
+
+ # Store value
+ $obj->foo('Foozle');
+
+ # Retrieve value
+ print $obj->foo;
+
+=cut
+
+use vars qw( %ScalarFragments );
+
+sub scalar {
+ (shift)->_build_composite( \%ScalarFragments, @_ );
+}
+
+%ScalarFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{target_class} ||= $Class::MethodMaker::CONTEXT{TargetClass};
+ $method->{array_index} ||=
+ _array_index( $method->{target_class}, $name );
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ if ( scalar(@_) == 0 ) {
+ $self->[$method->{array_index}];
+ } elsif ( scalar(@_) == 1 ) {
+ $self->[$method->{array_index}] = shift;
+ } else {
+ $self->[$method->{array_index}] = [@_];
+ }
+ },
+ ],
+ 'rw' => [],
+ 'p' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is protected";
+ }
+ },
+ ],
+ 'pp' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is private";
+ }
+ },
+ ],
+ 'pw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 or UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is write-protected";
+ }
+ },
+ ],
+ 'ppw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 or (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is write-private";
+ }
+ },
+ ],
+ 'r' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ @$args = ();
+ },
+ ],
+ 'ro' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 ) {
+ croak("Method $method->{name} is read-only");
+ }
+ },
+ ],
+ 'wo' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( @$args == 0 ) {
+ croak("Method $method->{name} is write-only");
+ }
+ },
+ ],
+ 'return_original' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ $method->{scratch}{return_original} = $self->[$method->{array_index}];
+ },
+ '+post' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ $method->{result} = \{ $method->{scratch}{return_original} };
+ },
+ ],
+);
+
+########################################################################
+
+=head2 array - Instance Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on an array-based instance.
+
+=item *
+
+Determines the array position associated with the method name, and uses that as an index into each instance to access the related value. This defaults to the next available slot in %FIELDS, but you may override this with the C<'array_index' => I<number>> method parameter, or by pre-filling the contents of %FIELDS.
+
+=item *
+
+The value for each instance will be a reference to an array (or undef).
+
+=item *
+
+If called without any arguments, returns the current array-ref value (or undef).
+
+=item *
+
+If called with a single non-ref argument, uses that argument as an index to retrieve from the referenced array, and returns that value (or undef).
+
+=item *
+
+If called with a single array ref argument, uses that list to return a slice of the referenced array.
+
+=item *
+
+If called with a list of argument pairs, each with a non-ref index and an associated value, stores the value at the given index in the referenced array. If the instance's value was previously undefined, a new array is autovivified. The current value in each position will be overwritten, and later arguments with the same index will override earlier ones. Returns the current array-ref value.
+
+=item *
+
+If called with a list of argument pairs, each with the first item being a reference to an array of up to two numbers, loops over each pair and uses those numbers to splice the value array.
+
+The first controlling number is the position at which the splice will begin. Zero will start before the first item in the list. Negative numbers count backwards from the end of the array.
+
+The second number is the number of items to be removed from the list. If it is omitted, or undefined, or zero, no items are removed. If it is a positive integer, that many items will be returned.
+
+If both numbers are omitted, or are both undefined, they default to containing the entire value array.
+
+If the second argument is undef, no values will be inserted; if it is a non-reference value, that one value will be inserted; if it is an array-ref, its values will be copied.
+
+The method returns the items that removed from the array, if any.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Array (
+ array => 'bar',
+ );
+ ...
+
+ # Clear and set contents of list
+ print $obj->bar([ 'Spume', 'Frost' ] );
+
+ # Set values by position
+ $obj->bar(0 => 'Foozle', 1 => 'Bang!');
+
+ # Positions may be overwritten, and in any order
+ $obj->bar(2 => 'And Mash', 1 => 'Blah!');
+
+ # Retrieve value by position
+ print $obj->bar(1);
+
+ # Direct access to referenced array
+ print scalar @{ $obj->bar() };
+
+There are also calling conventions for slice and splice operations:
+
+ # Retrieve slice of values by position
+ print join(', ', $obj->bar( undef, [0, 2] ) );
+
+ # Insert an item at position in the array
+ $obj->bar([3], 'Potatoes' );
+
+ # Remove 1 item from position 3 in the array
+ $obj->bar([3, 1], undef );
+
+ # Set a new value at position 2, and return the old value
+ print $obj->bar([2, 1], 'Froth' );
+
+=cut
+
+
+use vars qw( %ArrayFragments );
+
+sub array {
+ (shift)->_build_composite( \%ArrayFragments, @_ );
+}
+
+%ArrayFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{target_class} ||= $Class::MethodMaker::CONTEXT{TargetClass};
+ $method->{array_index} ||=
+ _array_index( $method->{target_class}, $name );
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( scalar(@$args) == 0 ) {
+ if ( $method->{auto_init} and
+ ! defined $self->[$method->{array_index}] ) {
+ $self->[$method->{array_index}] = [];
+ }
+ wantarray ? @{ $self->[$method->{array_index}] } : $self->[$method->{array_index}];
+ } elsif ( scalar(@_) == 1 and ref $_[0] eq 'ARRAY' ) {
+ $self->[$method->{array_index}] = [ @{ $_[0] } ];
+ wantarray ? @{ $self->[$method->{array_index}] } : $self->[$method->{array_index}];
+ } else {
+ $self->[$method->{array_index}] ||= [];
+ Class::MakeMethods::Composite::__array_ops(
+ $self->[$method->{array_index}], @$args );
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 hash - Instance Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on an array-based instance.
+
+=item *
+
+Determines the array position associated with the method name, and uses that as an index into each instance to access the related value. This defaults to the next available slot in %FIELDS, but you may override this with the C<'array_index' => I<number>> method parameter, or by pre-filling the contents of %FIELDS.
+
+=item *
+
+The value for each instance will be a reference to a hash (or undef).
+
+=item *
+
+If called without any arguments, returns the contents of the hash in list context, or a hash reference in scalar context (or undef).
+
+=item *
+
+If called with one non-ref argument, uses that argument as an index to retrieve from the referenced hash, and returns that value (or undef).
+
+=item *
+
+If called with one array-ref argument, uses the contents of that array to retrieve a slice of the referenced hash.
+
+=item *
+
+If called with one hash-ref argument, sets the contents of the referenced hash to match that provided.
+
+=item *
+
+If called with a list of key-value pairs, stores the value under the given key in the referenced hash. If the instance's value was previously undefined, a new hash is autovivified. The current value under each key will be overwritten, and later arguments with the same key will override earlier ones. Returns the contents of the hash in list context, or a hash reference in scalar context.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Array (
+ hash => 'baz',
+ );
+ ...
+
+ # Set values by key
+ $obj->baz('foo' => 'Foozle', 'bar' => 'Bang!');
+
+ # Values may be overwritten, and in any order
+ $obj->baz('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+
+ # Retrieve value by key
+ print $obj->baz('foo');
+
+ # Retrive slice of values by position
+ print join(', ', $obj->baz( ['foo', 'bar'] ) );
+
+ # Direct access to referenced hash
+ print keys %{ $obj->baz() };
+
+ # Reset the hash contents to empty
+ @{ $obj->baz() } = ();
+
+=cut
+
+
+use vars qw( %HashFragments );
+
+sub hash {
+ (shift)->_build_composite( \%HashFragments, @_ );
+}
+
+%HashFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( scalar(@$args) == 0 ) {
+ if ( $method->{auto_init} and ! defined $self->[$method->{array_index}] ) {
+ $self->[$method->{array_index}] = {};
+ }
+ wantarray ? %{ $self->[$method->{array_index}] } : $self->[$method->{array_index}];
+ } elsif ( scalar(@$args) == 1 ) {
+ if ( ref($_[0]) eq 'HASH' ) {
+ %{$self->[$method->{array_index}]} = %{$_[0]};
+ } elsif ( ref($_[0]) eq 'ARRAY' ) {
+ return @{$self->[$method->{array_index}]}{ @{$_[0]} }
+ } else {
+ return $self->[$method->{array_index}]->{ $_[0] }
+ }
+ } elsif ( scalar(@$args) % 2 ) {
+ croak "Odd number of items in assigment to $method->{name}";
+ } else {
+ while ( scalar(@$args) ) {
+ my $key = shift @$args;
+ $self->[$method->{array_index}]->{ $key} = shift @$args;
+ }
+ wantarray ? %{ $self->[$method->{array_index}] } : $self->[$method->{array_index}];
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 object - Instance Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on an array-based instance.
+
+=item *
+
+Determines the array position associated with the method name, and uses that as an index into each instance to access the related value. This defaults to the next available slot in %FIELDS, but you may override this with the C<'array_index' => I<number>> method parameter, or by pre-filling the contents of %FIELDS.
+
+=item *
+
+The value for each instance will be a reference to an object (or undef).
+
+=item *
+
+If called without any arguments returns the current value.
+
+=item *
+
+If called with an argument, stores that as the value, and returns it,
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Hash (
+ object => 'foo',
+ );
+ ...
+
+ # Store value
+ $obj->foo( Foozle->new() );
+
+ # Retrieve value
+ print $obj->foo;
+
+=cut
+
+use vars qw( %ObjectFragments );
+
+sub object {
+ (shift)->_build_composite( \%ObjectFragments, @_ );
+}
+
+%ObjectFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift;
+ if ( scalar @_ ) {
+ my $value = shift;
+ if ( $method->{class} and ! UNIVERSAL::isa( $value, $method->{class} ) ) {
+ croak "Wrong argument type ('$value') in assigment to $method->{name}";
+ }
+ $self->[$method->{array_index}] = $value;
+ } else {
+ if ( $method->{auto_init} and ! defined $self->[$method->{array_index}] ) {
+ my $class = $method->{class}
+ or die "Can't auto_init without a class";
+ my $new_method = $method->{new_method} || 'new';
+ $self->[$method->{array_index}] = $class->$new_method();
+ }
+ $self->[$method->{array_index}];
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head1 SEE ALSO
+
+See L<Class::MakeMethods> for general information about this distribution.
+
+See L<Class::MakeMethods::Composite> for more about this family of subclasses.
+
+=cut
+
+1;
diff --git a/lib/Class/MakeMethods/Composite/Global.pm b/lib/Class/MakeMethods/Composite/Global.pm
new file mode 100644
index 0000000..cf9af0b
--- /dev/null
+++ b/lib/Class/MakeMethods/Composite/Global.pm
@@ -0,0 +1,588 @@
+=head1 NAME
+
+Class::MakeMethods::Composite::Global - Global data
+
+=head1 SYNOPSIS
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Global (
+ scalar => [ 'foo' ],
+ array => [ 'my_list' ],
+ hash => [ 'my_index' ],
+ );
+ ...
+
+ MyClass->foo( 'Foozle' );
+ print MyClass->foo();
+
+ print MyClass->new(...)->foo(); # same value for any instance
+ print MySubclass->foo(); # ... and for any subclass
+
+ MyClass->my_list(0 => 'Foozle', 1 => 'Bang!');
+ print MyClass->my_list(1);
+
+ MyClass->my_index('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+ print MyClass->my_index('foo');
+
+
+=head1 DESCRIPTION
+
+The Composite::Global suclass of MakeMethods provides basic accessors for shared data.
+
+=head2 Class::MakeMethods Calling Interface
+
+When you C<use> this package, the method declarations you provide
+as arguments cause subroutines to be generated and installed in
+your module.
+
+You can also omit the arguments to C<use> and instead make methods
+at runtime by passing the declarations to a subsequent call to
+C<make()>.
+
+You may include any number of declarations in each call to C<use>
+or C<make()>. If methods with the same name already exist, earlier
+calls to C<use> or C<make()> win over later ones, but within each
+call, later declarations superceed earlier ones.
+
+You can install methods in a different package by passing C<-TargetClass =E<gt> I<package>> as your first arguments to C<use> or C<make>.
+
+See L<Class::MakeMethods> for more details.
+
+=head2 Class::MakeMethods::Basic Declaration Syntax
+
+The following types of Basic declarations are supported:
+
+=over 4
+
+=item *
+
+I<generator_type> => "I<method_name>"
+
+=item *
+
+I<generator_type> => "I<name_1> I<name_2>..."
+
+=item *
+
+I<generator_type> => [ "I<name_1>", "I<name_2>", ...]
+
+=back
+
+See the "METHOD GENERATOR TYPES" section below for a list of the supported values of I<generator_type>.
+
+For each method name you provide, a subroutine of the indicated
+type will be generated and installed under that name in your module.
+
+Method names should start with a letter, followed by zero or more
+letters, numbers, or underscores.
+
+=head2 Class::MakeMethods::Composite Declaration Syntax
+
+The Composite syntax also provides several ways to optionally
+associate a hash of additional parameters with a given method
+name.
+
+=over 4
+
+=item *
+
+I<generator_type> => [ "I<name_1>" => { I<param>=>I<value>... }, ... ]
+
+A hash of parameters to use just for this method name.
+
+(Note: to prevent confusion with self-contained definition hashes,
+described below, parameter hashes following a method name must not
+contain the key 'name'.)
+
+=item *
+
+I<generator_type> => [ [ "I<name_1>", "I<name_2>", ... ] => { I<param>=>I<value>... } ]
+
+Each of these method names gets a copy of the same set of parameters.
+
+=item *
+
+I<generator_type> => [ { "name"=>"I<name_1>", I<param>=>I<value>... }, ... ]
+
+By including the reserved parameter C<name>, you create a self-contained declaration with that name and any associated hash values.
+
+=back
+
+Basic declarations, as described above, are given an empty parameter hash.
+
+=cut
+
+package Class::MakeMethods::Composite::Global;
+
+$VERSION = 1.000;
+use strict;
+use Class::MakeMethods::Composite '-isasubclass';
+
+########################################################################
+
+=head1 METHOD GENERATOR TYPES
+
+=head2 scalar - Global Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or on any instance or subclass, and behaves identically regardless of what it was called on.
+
+=item *
+
+If called without any arguments returns the current value.
+
+=item *
+
+If called with an argument, stores that as the value, and returns it,
+
+=item *
+
+If called with multiple arguments, stores a reference to a new array with those arguments as contents, and returns that array reference.
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Global (
+ scalar => 'foo',
+ );
+ ...
+
+ # Store value
+ MyClass->foo('Foozle');
+
+ # Retrieve value
+ print MyClass->foo;
+
+=cut
+
+use vars qw( %ScalarFragments );
+
+sub scalar {
+ (shift)->_build_composite( \%ScalarFragments, @_ );
+}
+
+%ScalarFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{target_class} ||= $Class::MethodMaker::CONTEXT{TargetClass};
+ $method->{array_index} ||=
+ _array_index( $method->{target_class}, $name );
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ if ( scalar(@_) == 0 ) {
+ $method->{global_data};
+ } elsif ( scalar(@_) == 1 ) {
+ $method->{global_data} = shift;
+ } else {
+ $method->{global_data} = [@_];
+ }
+ },
+ ],
+ 'rw' => [],
+ 'p' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ unless ( UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is protected";
+ }
+ },
+ ],
+ 'pp' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ unless ( (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is private";
+ }
+ },
+ ],
+ 'pw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 or UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is write-protected";
+ }
+ },
+ ],
+ 'ppw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 or (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is write-private";
+ }
+ },
+ ],
+ 'r' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ @{$method->{args}} = ($self) if ( scalar @_ );
+ },
+ ],
+ 'ro' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 ) {
+ croak("Method $method->{name} is read-only");
+ }
+ },
+ ],
+ 'wo' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( @$args == 0 ) {
+ croak("Method $method->{name} is write-only");
+ }
+ },
+ ],
+ 'return_original' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ $method->{scratch}{return_original} = $method->{global_data};
+ },
+ '+post' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ $method->{result} = \{ $method->{scratch}{return_original} };
+ },
+ ],
+);
+
+########################################################################
+
+=head2 array - Global Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or on any instance or subclass, and behaves identically regardless of what it was called on.
+
+=item *
+
+The global value will be a reference to an array (or undef).
+
+=item *
+
+If called without any arguments, returns the current array-ref value (or undef).
+
+
+=item *
+
+If called with a single non-ref argument, uses that argument as an index to retrieve from the referenced array, and returns that value (or undef).
+
+=item *
+
+If called with a single array ref argument, uses that list to return a slice of the referenced array.
+
+=item *
+
+If called with a list of argument pairs, each with a non-ref index and an associated value, stores the value at the given index in the referenced array. If the global value was previously undefined, a new array is autovivified. The current value in each position will be overwritten, and later arguments with the same index will override earlier ones. Returns the current array-ref value.
+
+=item *
+
+If called with a list of argument pairs, each with the first item being a reference to an array of up to two numbers, loops over each pair and uses those numbers to splice the value array.
+
+The first controlling number is the position at which the splice will begin. Zero will start before the first item in the list. Negative numbers count backwards from the end of the array.
+
+The second number is the number of items to be removed from the list. If it is omitted, or undefined, or zero, no items are removed. If it is a positive integer, that many items will be returned.
+
+If both numbers are omitted, or are both undefined, they default to containing the entire value array.
+
+If the second argument is undef, no values will be inserted; if it is a non-reference value, that one value will be inserted; if it is an array-ref, its values will be copied.
+
+The method returns the items that removed from the array, if any.
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Global (
+ array => 'bar',
+ );
+ ...
+
+ # Clear and set contents of list
+ print MyClass->bar([ 'Spume', 'Frost' ] );
+
+ # Set values by position
+ MyClass->bar(0 => 'Foozle', 1 => 'Bang!');
+
+ # Positions may be overwritten, and in any order
+ MyClass->bar(2 => 'And Mash', 1 => 'Blah!');
+
+ # Retrieve value by position
+ print MyClass->bar(1);
+
+ # Direct access to referenced array
+ print scalar @{ MyClass->bar() };
+
+There are also calling conventions for slice and splice operations:
+
+ # Retrieve slice of values by position
+ print join(', ', MyClass->bar( undef, [0, 2] ) );
+
+ # Insert an item at position in the array
+ MyClass->bar([3], 'Potatoes' );
+
+ # Remove 1 item from position 3 in the array
+ MyClass->bar([3, 1], undef );
+
+ # Set a new value at position 2, and return the old value
+ print MyClass->bar([2, 1], 'Froth' );
+
+=cut
+
+
+use vars qw( %ArrayFragments );
+
+sub array {
+ (shift)->_build_composite( \%ArrayFragments, @_ );
+}
+
+%ArrayFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( scalar(@$args) == 0 ) {
+ if ( $method->{auto_init} and
+ ! defined $method->{global_data} ) {
+ $method->{global_data} = [];
+ }
+ wantarray ? @{ $method->{global_data} } : $method->{global_data}
+ } elsif ( scalar(@_) == 1 and ref $_[0] eq 'ARRAY' ) {
+ $method->{global_data} = [ @{ $_[0] } ];
+ wantarray ? @{ $method->{global_data} } : $method->{global_data}
+ } else {
+ $method->{global_data} ||= [];
+ Class::MakeMethods::Composite::__array_ops(
+ $method->{global_data}, @$args );
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 hash - Global Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or on any instance or subclass, and behaves identically regardless of what it was called on.
+
+=item *
+
+The global value will be a reference to a hash (or undef).
+
+=item *
+
+If called without any arguments, returns the contents of the hash in list context, or a hash reference in scalar context (or undef).
+
+=item *
+
+If called with one non-ref argument, uses that argument as an index to retrieve from the referenced hash, and returns that value (or undef).
+
+=item *
+
+If called with one array-ref argument, uses the contents of that array to retrieve a slice of the referenced hash.
+
+=item *
+
+If called with one hash-ref argument, sets the contents of the referenced hash to match that provided.
+
+=item *
+
+If called with a list of key-value pairs, stores the value under the given key in the referenced hash. If the global value was previously undefined, a new hash is autovivified. The current value under each key will be overwritten, and later arguments with the same key will override earlier ones. Returns the contents of the hash in list context, or a hash reference in scalar context.
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Global (
+ hash => 'baz',
+ );
+ ...
+
+ # Set values by key
+ MyClass->baz('foo' => 'Foozle', 'bar' => 'Bang!');
+
+ # Values may be overwritten, and in any order
+ MyClass->baz('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+
+ # Retrieve value by key
+ print MyClass->baz('foo');
+
+ # Retrive slice of values by position
+ print join(', ', MyClass->baz( ['foo', 'bar'] ) );
+
+ # Direct access to referenced hash
+ print keys %{ MyClass->baz() };
+
+ # Reset the hash contents to empty
+ @{ MyClass->baz() } = ();
+
+=cut
+
+use vars qw( %HashFragments );
+
+sub hash {
+ (shift)->_build_composite( \%HashFragments, @_ );
+}
+
+%HashFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( scalar(@$args) == 0 ) {
+ if ( $method->{auto_init} and ! defined $method->{global_data} ) {
+ $method->{global_data} = {};
+ }
+ wantarray ? %{ $method->{global_data} } : $method->{global_data};
+ } elsif ( scalar(@$args) == 1 ) {
+ if ( ref($_[0]) eq 'HASH' ) {
+ %{$method->{global_data}} = %{$_[0]};
+ } elsif ( ref($_[0]) eq 'ARRAY' ) {
+ return @{$method->{global_data}}{ @{$_[0]} }
+ } else {
+ return $method->{global_data}->{ $_[0] }
+ }
+ } elsif ( scalar(@$args) % 2 ) {
+ croak "Odd number of items in assigment to $method->{name}";
+ } else {
+ while ( scalar(@$args) ) {
+ my $key = shift @$args;
+ $method->{global_data}->{ $key} = shift @$args;
+ }
+ wantarray ? %{ $method->{global_data} } : $method->{global_data};
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 object - Global Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or on any instance or subclass, and behaves identically regardless of what it was called on.
+
+=item *
+
+The global value will be a reference to an object (or undef).
+
+=item *
+
+If called without any arguments returns the current value.
+
+=item *
+
+If called with an argument, stores that as the value, and returns it,
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Global (
+ object => 'foo',
+ );
+ ...
+
+ # Store value
+ MyClass->foo( Foozle->new() );
+
+ # Retrieve value
+ print MyClass->foo;
+
+=cut
+
+use vars qw( %ObjectFragments );
+
+sub object {
+ (shift)->_build_composite( \%ObjectFragments, @_ );
+}
+
+%ObjectFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift;
+ if ( scalar @_ ) {
+ my $value = shift;
+ if ( $method->{class} and ! UNIVERSAL::isa( $value, $method->{class} ) ) {
+ croak "Wrong argument type ('$value') in assigment to $method->{name}";
+ }
+ $method->{global_data} = $value;
+ } else {
+ if ( $method->{auto_init} and ! defined $method->{global_data} ) {
+ my $class = $method->{class}
+ or die "Can't auto_init without a class";
+ my $new_method = $method->{new_method} || 'new';
+ $method->{global_data} = $class->$new_method();
+ }
+ $method->{global_data};
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head1 SEE ALSO
+
+See L<Class::MakeMethods> for general information about this distribution.
+
+See L<Class::MakeMethods::Composite> for more about this family of subclasses.
+
+=cut
+
+1;
diff --git a/lib/Class/MakeMethods/Composite/Hash.pm b/lib/Class/MakeMethods/Composite/Hash.pm
new file mode 100644
index 0000000..969bdd0
--- /dev/null
+++ b/lib/Class/MakeMethods/Composite/Hash.pm
@@ -0,0 +1,719 @@
+=head1 NAME
+
+Class::MakeMethods::Composite::Hash - Composite hash methods
+
+=head1 SYNOPSIS
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Hash (
+ new => 'new',
+ scalar => [ 'foo', 'bar' ],
+ array => 'my_list',
+ hash => 'my_index',
+ );
+ ...
+
+ my $obj = MyObject->new( foo => 'Foozle' );
+ print $obj->foo();
+
+ $obj->bar('Barbados');
+ print $obj->bar();
+
+ $obj->my_list(0 => 'Foozle', 1 => 'Bang!');
+ print $obj->my_list(1);
+
+ $obj->my_index('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+ print $obj->my_index('foo');
+
+=head1 DESCRIPTION
+
+The Composite::Hash suclass of MakeMethods provides a basic constructor and accessors for blessed-hash object instances.
+
+=head2 Class::MakeMethods Calling Interface
+
+When you C<use> this package, the method declarations you provide
+as arguments cause subroutines to be generated and installed in
+your module.
+
+You can also omit the arguments to C<use> and instead make methods
+at runtime by passing the declarations to a subsequent call to
+C<make()>.
+
+You may include any number of declarations in each call to C<use>
+or C<make()>. If methods with the same name already exist, earlier
+calls to C<use> or C<make()> win over later ones, but within each
+call, later declarations superceed earlier ones.
+
+You can install methods in a different package by passing C<-TargetClass =E<gt> I<package>> as your first arguments to C<use> or C<make>.
+
+See L<Class::MakeMethods> for more details.
+
+=head2 Class::MakeMethods::Basic Declaration Syntax
+
+The following types of Basic declarations are supported:
+
+=over 4
+
+=item *
+
+I<generator_type> => "I<method_name>"
+
+=item *
+
+I<generator_type> => "I<name_1> I<name_2>..."
+
+=item *
+
+I<generator_type> => [ "I<name_1>", "I<name_2>", ...]
+
+=back
+
+See the "METHOD GENERATOR TYPES" section below for a list of the supported values of I<generator_type>.
+
+For each method name you provide, a subroutine of the indicated
+type will be generated and installed under that name in your module.
+
+Method names should start with a letter, followed by zero or more
+letters, numbers, or underscores.
+
+=head2 Class::MakeMethods::Composite Declaration Syntax
+
+The Composite syntax also provides several ways to optionally
+associate a hash of additional parameters with a given method
+name.
+
+=over 4
+
+=item *
+
+I<generator_type> => [ "I<name_1>" => { I<param>=>I<value>... }, ... ]
+
+A hash of parameters to use just for this method name.
+
+(Note: to prevent confusion with self-contained definition hashes,
+described below, parameter hashes following a method name must not
+contain the key 'name'.)
+
+=item *
+
+I<generator_type> => [ [ "I<name_1>", "I<name_2>", ... ] => { I<param>=>I<value>... } ]
+
+Each of these method names gets a copy of the same set of parameters.
+
+=item *
+
+I<generator_type> => [ { "name"=>"I<name_1>", I<param>=>I<value>... }, ... ]
+
+By including the reserved parameter C<name>, you create a self-contained declaration with that name and any associated hash values.
+
+=back
+
+Basic declarations, as described above, are given an empty parameter hash.
+
+=cut
+
+package Class::MakeMethods::Composite::Hash;
+
+$VERSION = 1.000;
+use strict;
+use Class::MakeMethods::Composite '-isasubclass';
+use Carp;
+
+########################################################################
+
+=head1 METHOD GENERATOR TYPES
+
+=head2 new - Constructor
+
+For each method name passed, returns a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Has a reference to a sample item to copy. This defaults to a reference to an empty hash, but you may override this with the C<'defaults' =E<gt> I<hash_ref>> method parameter.
+
+=item *
+
+If called as a class method, makes a new hash and blesses it into that class.
+
+=item *
+
+If called on a hash-based instance, makes a copy of it and blesses the copy into the same class as the original instance.
+
+=item *
+
+If passed a list of key-value pairs, appends them to the new hash. These arguments override any copied values, and later arguments with the same name will override earlier ones.
+
+=item *
+
+Returns the new instance.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Hash (
+ new => 'new',
+ );
+ ...
+
+ # Bare constructor
+ my $empty = MyObject->new();
+
+ # Constructor with initial values
+ my $obj = MyObject->new( foo => 'Foozle', bar => 'Barbados' );
+
+ # Copy with overriding value
+ my $copy = $obj->new( bar => 'Bob' );
+
+=cut
+
+=head2 new --with_values - Constructor
+
+For each method name passed, returns a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or (equivalently) on any existing object of that class.
+
+=item *
+
+Creates a hash, blesses it into the class, and returns the new instance.
+
+=item *
+
+If no arguments are provided, the returned hash will be empty. If passed a single hash-ref argument, copies its contents into the new hash. If called with multiple arguments, treats them as key-value pairs, and copies them into the new hash. (Note that this is a "shallow" copy, not a "deep" clone.)
+
+=back
+
+=cut
+
+use vars qw( %ConstructorFragments );
+
+sub new {
+ (shift)->_build_composite( \%ConstructorFragments, @_ );
+}
+
+%ConstructorFragments = (
+ '' => [
+ '+init' => sub {
+ my $method = pop @_;
+ $method->{target_class} ||= $Class::MethodMaker::CONTEXT{TargetClass};
+ $method->{defaults} ||= {};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $obj = ref($self) ? bless( { %$self }, ref $self )
+ : bless( { %{$method->{defaults}} }, $self );
+ @_ = %{$_[0]}
+ if ( scalar @_ == 1 and ref $_[0] eq 'HASH' );
+ while ( scalar @_ ) {
+ my $method = shift @_;
+ my $value = shift @_;
+ $obj->$method( $value );
+ }
+ $obj;
+ },
+ ],
+ 'with_values' => [
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ @_ = %{$_[0]}
+ if ( scalar @_ == 1 and ref $_[0] eq 'HASH' );
+ bless( { @_ }, ref($self) || $self );
+ }
+ ],
+);
+
+########################################################################
+
+=head2 scalar - Instance Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on a hash-based instance.
+
+=item *
+
+Has a specific hash key to use to access the related value for each instance.
+This defaults to the method name, but you may override this with the C<'hash_key' => I<string>> method parameter.
+
+=item *
+
+If called without any arguments returns the current value.
+
+=item *
+
+If called with an argument, stores that as the value, and returns it.
+
+=item *
+
+If called with multiple arguments, stores a reference to a new array with those arguments as contents, and returns that array reference.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Hash (
+ scalar => 'foo',
+ );
+ ...
+
+ # Store value
+ $obj->foo('Foozle');
+
+ # Retrieve value
+ print $obj->foo;
+
+=cut
+
+use vars qw( %ScalarFragments );
+
+sub scalar {
+ (shift)->_build_composite( \%ScalarFragments, @_ );
+}
+
+%ScalarFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $method->{name};
+ $method->{target_class} ||= $Class::MethodMaker::CONTEXT{TargetClass};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ if ( scalar(@_) == 0 ) {
+ $self->{$method->{hash_key}};
+ } elsif ( scalar(@_) == 1 ) {
+ $self->{$method->{hash_key}} = shift;
+ } else {
+ $self->{$method->{hash_key}} = [@_];
+ }
+ },
+ ],
+ 'rw' => [],
+ 'p' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ unless ( UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is protected";
+ }
+ },
+ ],
+ 'pp' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ unless ( (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is private";
+ }
+ },
+ ],
+ 'pw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 or UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is write-protected";
+ }
+ },
+ ],
+ 'ppw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 or (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is write-private";
+ }
+ },
+ ],
+ 'r' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ @$args = ();
+ },
+ ],
+ 'ro' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ unless ( @$args == 0 ) {
+ croak("Method $method->{name} is read-only");
+ }
+ },
+ ],
+ 'wo' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( @$args == 0 ) {
+ croak("Method $method->{name} is write-only");
+ }
+ },
+ ],
+ 'return_original' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ $method->{scratch}{return_original} = $self->{$method->{hash_key}};
+ },
+ '+post' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ ${ $method->{result} } = $method->{scratch}{return_original};
+ },
+ ],
+);
+
+########################################################################
+
+=head2 array - Instance Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on a hash-based instance.
+
+=item *
+
+Has a specific hash key to use to access the related value for each instance.
+This defaults to the method name, but you may override this with the C<'hash_key' => I<string>> method parameter.
+
+=item *
+
+The value for each instance will be a reference to an array (or undef).
+
+=item *
+
+If called without any arguments, returns the current array-ref value (or undef).
+
+
+=item *
+
+If called with a single non-ref argument, uses that argument as an index to retrieve from the referenced array, and returns that value (or undef).
+
+=item *
+
+If called with a single array ref argument, uses that list to return a slice of the referenced array.
+
+=item *
+
+If called with a list of argument pairs, each with a non-ref index and an associated value, stores the value at the given index in the referenced array. If the instance's value was previously undefined, a new array is autovivified. The current value in each position will be overwritten, and later arguments with the same index will override earlier ones. Returns the current array-ref value.
+
+=item *
+
+If called with a list of argument pairs, each with the first item being a reference to an array of up to two numbers, loops over each pair and uses those numbers to splice the value array.
+
+The first controlling number is the position at which the splice will begin. Zero will start before the first item in the list. Negative numbers count backwards from the end of the array.
+
+The second number is the number of items to be removed from the list. If it is omitted, or undefined, or zero, no items are removed. If it is a positive integer, that many items will be returned.
+
+If both numbers are omitted, or are both undefined, they default to containing the entire value array.
+
+If the second argument is undef, no values will be inserted; if it is a non-reference value, that one value will be inserted; if it is an array-ref, its values will be copied.
+
+The method returns the items that removed from the array, if any.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Hash (
+ array => 'bar',
+ );
+ ...
+
+ # Clear and set contents of list
+ print $obj->bar([ 'Spume', 'Frost' ] );
+
+ # Set values by position
+ $obj->bar(0 => 'Foozle', 1 => 'Bang!');
+
+ # Positions may be overwritten, and in any order
+ $obj->bar(2 => 'And Mash', 1 => 'Blah!');
+
+ # Retrieve value by position
+ print $obj->bar(1);
+
+ # Direct access to referenced array
+ print scalar @{ $obj->bar() };
+
+There are also calling conventions for slice and splice operations:
+
+ # Retrieve slice of values by position
+ print join(', ', $obj->bar( undef, [0, 2] ) );
+
+ # Insert an item at position in the array
+ $obj->bar([3], 'Potatoes' );
+
+ # Remove 1 item from position 3 in the array
+ $obj->bar([3, 1], undef );
+
+ # Set a new value at position 2, and return the old value
+ print $obj->bar([2, 1], 'Froth' );
+
+=cut
+
+use vars qw( %ArrayFragments );
+
+sub array {
+ (shift)->_build_composite( \%ArrayFragments, @_ );
+}
+
+%ArrayFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( scalar(@$args) == 0 ) {
+ if ( $method->{auto_init} and
+ ! defined $self->{$method->{hash_key}} ) {
+ $self->{$method->{hash_key}} = [];
+ }
+ wantarray ? @{ $self->{$method->{hash_key}} } : $self->{$method->{hash_key}};
+ } elsif ( scalar(@_) == 1 and ref $_[0] eq 'ARRAY' ) {
+ $self->{$method->{hash_key}} = [ @{ $_[0] } ];
+ wantarray ? @{ $self->{$method->{hash_key}} } : $self->{$method->{hash_key}};
+ } else {
+ $self->{$method->{hash_key}} ||= [];
+ array_splicer( $self->{$method->{hash_key}}, @$args );
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 hash - Instance Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on a hash-based instance.
+
+=item *
+
+Has a specific hash key to use to access the related value for each instance.
+This defaults to the method name, but you may override this with the C<'hash_key' => I<string>> method parameter.
+
+=item *
+
+The value for each instance will be a reference to a hash (or undef).
+
+=item *
+
+If called without any arguments, returns the contents of the hash in list context, or a hash reference in scalar context (or undef).
+
+=item *
+
+If called with one non-ref argument, uses that argument as an index to retrieve from the referenced hash, and returns that value (or undef).
+
+=item *
+
+If called with one array-ref argument, uses the contents of that array to retrieve a slice of the referenced hash.
+
+=item *
+
+If called with one hash-ref argument, sets the contents of the referenced hash to match that provided.
+
+=item *
+
+If called with a list of key-value pairs, stores the value under the given key in the referenced hash. If the instance's value was previously undefined, a new hash is autovivified. The current value under each key will be overwritten, and later arguments with the same key will override earlier ones. Returns the contents of the hash in list context, or a hash reference in scalar context.
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Hash (
+ hash => 'baz',
+ );
+ ...
+
+ # Set values by key
+ $obj->baz('foo' => 'Foozle', 'bar' => 'Bang!');
+
+ # Values may be overwritten, and in any order
+ $obj->baz('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+
+ # Retrieve value by key
+ print $obj->baz('foo');
+
+ # Retrive slice of values by position
+ print join(', ', $obj->baz( ['foo', 'bar'] ) );
+
+ # Direct access to referenced hash
+ print keys %{ $obj->baz() };
+
+ # Reset the hash contents to empty
+ @{ $obj->baz() } = ();
+
+=cut
+
+use vars qw( %HashFragments );
+
+sub hash {
+ (shift)->_build_composite( \%HashFragments, @_ );
+}
+
+%HashFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $args = \@_;
+ if ( scalar(@$args) == 0 ) {
+ if ( $method->{auto_init} and ! defined $self->{$method->{hash_key}} ) {
+ $self->{$method->{hash_key}} = {};
+ }
+ wantarray ? %{ $self->{$method->{hash_key}} } : $self->{$method->{hash_key}};
+ } elsif ( scalar(@$args) == 1 ) {
+ if ( ref($_[0]) eq 'HASH' ) {
+ %{$self->{$method->{hash_key}}} = %{$_[0]};
+ } elsif ( ref($_[0]) eq 'ARRAY' ) {
+ return @{$self->{$method->{hash_key}}}{ @{$_[0]} }
+ } else {
+ return $self->{$method->{hash_key}}->{ $_[0] }
+ }
+ } elsif ( scalar(@$args) % 2 ) {
+ croak "Odd number of items in assigment to $method->{name}";
+ } else {
+ while ( scalar(@$args) ) {
+ my $key = shift @$args;
+ $self->{$method->{hash_key}}->{ $key} = shift @$args;
+ }
+ wantarray ? %{ $self->{$method->{hash_key}} } : $self->{$method->{hash_key}};
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 object - Instance Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+Must be called on a hash-based instance.
+
+=item *
+
+Has a specific hash key to use to access the related value for each instance.
+This defaults to the method name, but you may override this with the C<'hash_key' => I<string>> method parameter.
+
+=item *
+
+The value for each instance will be a reference to an object (or undef).
+
+=item *
+
+If called without any arguments returns the current value.
+
+=item *
+
+If called with an argument, stores that as the value, and returns it,
+
+=back
+
+Sample declaration and usage:
+
+ package MyObject;
+ use Class::MakeMethods::Composite::Hash (
+ object => 'foo',
+ );
+ ...
+
+ # Store value
+ $obj->foo( Foozle->new() );
+
+ # Retrieve value
+ print $obj->foo;
+
+=cut
+
+use vars qw( %ObjectFragments );
+
+sub object {
+ (shift)->_build_composite( \%ObjectFragments, @_ );
+}
+
+%ObjectFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift;
+ if ( scalar @_ ) {
+ my $value = shift;
+ if ( $method->{class} and ! UNIVERSAL::isa( $value, $method->{class} ) ) {
+ croak "Wrong argument type ('$value') in assigment to $method->{name}";
+ }
+ $self->{$method->{hash_key}} = $value;
+ } else {
+ if ( $method->{auto_init} and ! defined $self->{$method->{hash_key}} ) {
+ my $class = $method->{class}
+ or die "Can't auto_init without a class";
+ my $new_method = $method->{new_method} || 'new';
+ $self->{$method->{hash_key}} = $class->$new_method();
+ }
+ $self->{$method->{hash_key}};
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head1 SEE ALSO
+
+See L<Class::MakeMethods> for general information about this distribution.
+
+See L<Class::MakeMethods::Composite> for more about this family of subclasses.
+
+=cut
+
+1;
diff --git a/lib/Class/MakeMethods/Composite/Inheritable.pm b/lib/Class/MakeMethods/Composite/Inheritable.pm
new file mode 100644
index 0000000..ca4be3e
--- /dev/null
+++ b/lib/Class/MakeMethods/Composite/Inheritable.pm
@@ -0,0 +1,613 @@
+=head1 NAME
+
+Class::MakeMethods::Composite::Inheritable - Overridable data
+
+=head1 SYNOPSIS
+
+ package MyClass;
+
+ use Class::MakeMethods( 'Composite::Inheritable:scalar' => 'foo' );
+ # We now have an accessor method for an "inheritable" scalar value
+
+ MyClass->foo( 'Foozle' ); # Set a class-wide value
+ print MyClass->foo(); # Retrieve class-wide value
+
+ my $obj = MyClass->new(...);
+ print $obj->foo(); # All instances "inherit" that value...
+
+ $obj->foo( 'Foible' ); # until you set a value for an instance.
+ print $obj->foo(); # This now finds object-specific value.
+ ...
+
+ package MySubClass;
+ @ISA = 'MyClass';
+
+ print MySubClass->foo(); # Intially same as superclass,
+ MySubClass->foo('Foobar'); # but overridable per subclass,
+ print $subclass_obj->foo(); # and shared by its instances
+ $subclass_obj->foo('Fosil');# until you override them...
+ ...
+
+ # Similar behaviour for hashes and arrays is currently incomplete
+ package MyClass;
+ use Class::MakeMethods::Composite::Inheritable (
+ array => 'my_list',
+ hash => 'my_index',
+ );
+
+ MyClass->my_list(0 => 'Foozle', 1 => 'Bang!');
+ print MyClass->my_list(1);
+
+ MyClass->my_index('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+ print MyClass->my_index('foo');
+
+
+=head1 DESCRIPTION
+
+The MakeMethods subclass provides accessor methods that search an inheritance tree to find a value. This allows you to set a shared or default value for a given class, optionally override it in a subclass, and then optionally override it on a per-instance basis.
+
+Note that all MakeMethods methods are inheritable, in the sense that they work as expected for subclasses. These methods are different in that the I<data> accessed by each method can be inherited or overridden in each subclass or instance. See L< Class::MakeMethods::Utility::Inheritable> for more about this type of "inheritable" or overridable" data.
+
+
+=head2 Class::MakeMethods Calling Interface
+
+When you C<use> this package, the method declarations you provide
+as arguments cause subroutines to be generated and installed in
+your module.
+
+See L<Class::MakeMethods::Standard/"Calling Conventions"> for more information.
+
+=head2 Class::MakeMethods::Standard Declaration Syntax
+
+To declare methods, pass in pairs of a method-type name followed
+by one or more method names.
+
+See the "METHOD GENERATOR TYPES" section below for a list of the supported values of I<generator_type>.
+
+See L<Class::MakeMethods::Standard/"Declaration Syntax"> and L<Class::MakeMethods::Standard/"Parameter Syntax"> for more information.
+
+=cut
+
+package Class::MakeMethods::Composite::Inheritable;
+
+$VERSION = 1.000;
+use strict;
+use Carp;
+
+use Class::MakeMethods::Composite '-isasubclass';
+use Class::MakeMethods::Utility::Inheritable qw(get_vvalue set_vvalue find_vself );
+
+########################################################################
+
+=head1 METHOD GENERATOR TYPES
+
+=head2 scalar - Overrideable Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class or instance method, on the declaring class or any subclass.
+
+=item *
+
+If called without any arguments returns the current value for the callee. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
+
+=item *
+
+If called with an argument, stores that as the value associated with the callee, whether instance or class, and returns it,
+
+=item *
+
+If called with multiple arguments, stores a reference to a new array with those arguments as contents, and returns that array reference.
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Inheritable (
+ scalar => 'foo',
+ );
+ ...
+
+ # Store value
+ MyClass->foo('Foozle');
+
+ # Retrieve value
+ print MyClass->foo;
+
+=cut
+
+use vars qw( %ScalarFragments );
+
+sub scalar {
+ (shift)->_build_composite( \%ScalarFragments, @_ );
+}
+
+%ScalarFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{target_class} ||= $Class::MethodMaker::CONTEXT{TargetClass};
+ $method->{data} ||= {};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ if ( scalar(@_) == 0 ) {
+ return get_vvalue($method->{data}, $self);
+ } else {
+ my $value = (@_ == 1 ? $_[0] : [@_]);
+ set_vvalue($method->{data}, $self, $value);
+ }
+ },
+ ],
+ 'rw' => [],
+ 'p' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ unless ( UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is protected";
+ }
+ },
+ ],
+ 'pp' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ unless ( (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is private";
+ }
+ },
+ ],
+ 'pw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ unless ( @_ == 0 or UNIVERSAL::isa((caller(1))[0], $method->{target_class}) ) {
+ croak "Method $method->{name} is write-protected";
+ }
+ },
+ ],
+ 'ppw' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ unless ( @_ == 0 or (caller(1))[0] eq $method->{target_class} ) {
+ croak "Method $method->{name} is write-private";
+ }
+ },
+ ],
+ 'r' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ @{ $method->{args} } = ();
+ },
+ ],
+ 'ro' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ unless ( @_ == 0 ) {
+ croak("Method $method->{name} is read-only");
+ }
+ },
+ ],
+ 'wo' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ if ( @_ == 0 ) {
+ croak("Method $method->{name} is write-only");
+ }
+ },
+ ],
+ 'return_original' => [
+ '+pre' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+ my $v_self = find_vself($method->{data}, $self);
+ $method->{scratch}{return_original} =
+ $v_self ? $method->{data}{$v_self} : ();
+ },
+ '+post' => sub {
+ my $method = pop @_;
+ $method->{result} = \{ $method->{scratch}{return_original} };
+ },
+ ],
+);
+
+########################################################################
+
+=head2 array - Overrideable Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or on any instance or subclass, Must be called on a hash-based instance.
+
+=item *
+
+The class value will be a reference to an array (or undef).
+
+=item *
+
+If called without any arguments, returns the current array-ref value (or undef).
+
+
+=item *
+
+If called with a single non-ref argument, uses that argument as an index to retrieve from the referenced array, and returns that value (or undef).
+
+=item *
+
+If called with a single array ref argument, uses that list to return a slice of the referenced array.
+
+=item *
+
+If called with a list of argument pairs, each with a non-ref index and an associated value, stores the value at the given index in the referenced array. If the class value was previously undefined, a new array is autovivified. The current value in each position will be overwritten, and later arguments with the same index will override earlier ones. Returns the current array-ref value.
+
+=item *
+
+If called with a list of argument pairs, each with the first item being a reference to an array of up to two numbers, loops over each pair and uses those numbers to splice the value array.
+
+The first controlling number is the position at which the splice will begin. Zero will start before the first item in the list. Negative numbers count backwards from the end of the array.
+
+The second number is the number of items to be removed from the list. If it is omitted, or undefined, or zero, no items are removed. If it is a positive integer, that many items will be returned.
+
+If both numbers are omitted, or are both undefined, they default to containing the entire value array.
+
+If the second argument is undef, no values will be inserted; if it is a non-reference value, that one value will be inserted; if it is an array-ref, its values will be copied.
+
+The method returns the items that removed from the array, if any.
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Inheritable (
+ array => 'bar',
+ );
+ ...
+
+ # Clear and set contents of list
+ print MyClass->bar([ 'Spume', 'Frost' ] );
+
+ # Set values by position
+ MyClass->bar(0 => 'Foozle', 1 => 'Bang!');
+
+ # Positions may be overwritten, and in any order
+ MyClass->bar(2 => 'And Mash', 1 => 'Blah!');
+
+ # Retrieve value by position
+ print MyClass->bar(1);
+
+ # Direct access to referenced array
+ print scalar @{ MyClass->bar() };
+
+There are also calling conventions for slice and splice operations:
+
+ # Retrieve slice of values by position
+ print join(', ', MyClass->bar( undef, [0, 2] ) );
+
+ # Insert an item at position in the array
+ MyClass->bar([3], 'Potatoes' );
+
+ # Remove 1 item from position 3 in the array
+ MyClass->bar([3, 1], undef );
+
+ # Set a new value at position 2, and return the old value
+ print MyClass->bar([2, 1], 'Froth' );
+
+B<NOTE: THIS METHOD GENERATOR HAS NOT BEEN WRITTEN YET.>
+
+=cut
+
+use vars qw( %ArrayFragments );
+
+sub array {
+ (shift)->_build_composite( \%ArrayFragments, @_ );
+}
+
+%ArrayFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ $method->{data} ||= {};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+
+ if ( scalar(@_) == 0 ) {
+ my $v_self = find_vself($method->{data}, $self);
+ my $value = $v_self ? $method->{data}{$v_self} : ();
+ if ( $method->{auto_init} and ! $value ) {
+ $value = $method->{data}{$self} = [];
+ }
+ ( ! $value ) ? () : wantarray ? @$value : $value;
+
+ } elsif ( scalar(@_) == 1 and ref $_[0] eq 'ARRAY' ) {
+ $method->{data}{$self} = [ @{ $_[0] } ];
+ wantarray ? @{ $method->{data}{$self} } : $method->{data}{$self}
+
+ } else {
+ if ( ! exists $method->{data}{$self} ) {
+ my $v_self = find_vself($method->{data}, $self);
+ $method->{data}{$self} = [ $v_self ? @{$method->{data}{$v_self}} : () ];
+ }
+ return array_splicer( $method->{data}{$self}, @_ );
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 hash - Overrideable Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or on any instance or subclass, Must be called on a hash-based instance.
+
+=item *
+
+The class value will be a reference to a hash (or undef).
+
+=item *
+
+If called without any arguments returns the contents of the hash in list context, or a hash reference in scalar context for the callee. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
+
+=item *
+
+If called with one non-ref argument, uses that argument as an index to retrieve from the referenced hash, and returns that value (or undef). If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
+
+=item *
+
+If called with one array-ref argument, uses the contents of that array to retrieve a slice of the referenced hash. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
+
+=item *
+
+If called with one hash-ref argument, sets the contents of the referenced hash to match that provided.
+
+=item *
+
+If called with a list of key-value pairs, stores the value under the given key in the hash associated with the callee, whether instance or class. If the callee did not previously have a hash-ref value associated with it, searches up instance to class, and from class to superclass, until a callee with a value is located, and copies that hash before making the assignments. The current value under each key will be overwritten, and later arguments with the same key will override earlier ones. Returns the contents of the hash in list context, or a hash reference in scalar context.
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Inheritable (
+ hash => 'baz',
+ );
+ ...
+
+ # Set values by key
+ MyClass->baz('foo' => 'Foozle', 'bar' => 'Bang!');
+
+ # Values may be overwritten, and in any order
+ MyClass->baz('broccoli' => 'Blah!', 'foo' => 'Fiddle');
+
+ # Retrieve value by key
+ print MyClass->baz('foo');
+
+ # Retrive slice of values by position
+ print join(', ', MyClass->baz( ['foo', 'bar'] ) );
+
+ # Direct access to referenced hash
+ print keys %{ MyClass->baz() };
+
+ # Reset the hash contents to empty
+ @{ MyClass->baz() } = ();
+
+B<NOTE: THIS METHOD GENERATOR IS INCOMPLETE.>
+
+=cut
+
+use vars qw( %HashFragments );
+
+sub hash {
+ (shift)->_build_composite( \%HashFragments, @_ );
+}
+
+%HashFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{hash_key} ||= $_->{name};
+ $method->{data} ||= {};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+
+ if ( scalar(@_) == 0 ) {
+ my $value = get_vvalue($method->{data}, $self);
+ if ( $method->{auto_init} and ! $value ) {
+ $value = set_vvalue( $method->{data}, $self, {} );
+ }
+ wantarray ? %$value : $value;
+ } elsif ( scalar(@_) == 1 ) {
+ if ( ref($_[0]) eq 'HASH' ) {
+ %{$method->{data}{$self}} = %{$_[0]};
+ } elsif ( ref($_[0]) eq 'ARRAY' ) {
+ my $v_self = find_vself($method->{data}, $self) or return;
+ return @{ $method->{data}{$v_self} }{ @{$_[0]} }
+ } else {
+ my $v_self = find_vself($method->{data}, $self) or return;
+ return $method->{data}{$v_self}{ $_[0] }
+ }
+
+ } elsif ( scalar(@_) % 2 ) {
+ Carp::croak "Odd number of items in assigment to $method->{name}";
+ } else {
+ if ( ! exists $method->{data}{$self} ) {
+ my $v_self = find_vself($method->{data}, $self);
+ $method->{data}{$self} = { $v_self ? %{ $method->{data}{$v_self} } : () };
+ }
+ while ( scalar(@_) ) {
+ my $key = shift();
+ $method->{data}{$self}->{ $key } = shift();
+ }
+ wantarray ? %{$method->{data}{$self}} : $method->{data}{$self};
+ }
+ },
+ ],
+);
+
+########################################################################
+
+=head2 hook - Overrideable array of subroutines
+
+A hook method is called from the outside as a normal method. However, internally, it contains an array of subroutine references, each of which are called in turn to produce the method's results.
+
+Subroutines may be added to the hook's array by calling it with a blessed subroutine reference, as shown below. Subroutines may be added on a class-wide basis or on an individual object.
+
+You might want to use this type of method to provide an easy way for callbacks to be registered.
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Inheritable ( 'hook' => 'init' );
+
+ MyClass->init( Class::MakeMethods::Composite::Inheritable->Hook( sub {
+ my $callee = shift;
+ warn "Init...";
+ } );
+
+ my $obj = MyClass->new;
+ $obj->init();
+
+=cut
+
+use vars qw( %HookFragments );
+
+sub hook {
+ (shift)->_build_composite( \%HookFragments, @_ );
+}
+
+%HookFragments = (
+ '' => [
+ '+init' => sub {
+ my ($method) = @_;
+ $method->{data} ||= {};
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $self = shift @_;
+
+ if ( scalar(@_) and
+ ref($_[0]) eq 'Class::MakeMethods::Composite::Inheritable::Hook' ) {
+ if ( ! exists $method->{data}{$self} ) {
+ my $v_self = find_vself($method->{data}, $self);
+ $method->{data}{$self} = [ $v_self ? @{ $method->{data}{$v_self} } : () ];
+ }
+ push @{ $method->{data}{$self} }, map $$_, @_;
+ } else {
+ my $v_self = find_vself($method->{data}, $self);
+ my $subs = $v_self ? $method->{data}{$v_self} : ();
+ my @subs = ( ( ! $subs ) ? () : @$subs );
+
+ if ( ! defined $method->{wantarray} ) {
+ foreach my $sub ( @subs ) {
+ &$sub( @{$method->{args}} );
+ }
+ } elsif ( ! $method->{wantarray} ) {
+ foreach my $sub ( @subs ) {
+ my $value = &$sub( @{$method->{args}} );
+ if ( defined $value ) {
+ $method->{result} = \$value;
+ }
+ }
+ } else {
+ foreach my $sub ( @subs ) {
+ my @value = &$sub( @{$method->{args}} );
+ if ( scalar @value ) {
+ push @{ $method->{result} }, @value;
+ }
+ }
+ }
+
+ }
+ return Class::MakeMethods::Composite->CurrentResults();
+ },
+ ],
+);
+
+sub Hook (&) {
+ my $package = shift;
+ my $sub = shift;
+ bless \$sub, 'Class::MakeMethods::Composite::Inheritable::Hook';
+}
+
+########################################################################
+
+=head2 object - Overrideable Ref Accessor
+
+For each method name passed, uses a closure to generate a subroutine with the following characteristics:
+
+=over 4
+
+=item *
+
+May be called as a class method, or on any instance or subclass, Must be called on a hash-based instance.
+
+=item *
+
+The class value will be a reference to an object (or undef).
+
+=item *
+
+If called without any arguments returns the current value for the callee. If the callee has not had a value defined for this method, searches up from instance to class, and from class to superclass, until a callee with a value is located.
+
+=item *
+
+If called with an argument, stores that as the value associated with the callee, whether instance or class, and returns it,
+
+=back
+
+Sample declaration and usage:
+
+ package MyClass;
+ use Class::MakeMethods::Composite::Inheritable (
+ object => 'foo',
+ );
+ ...
+
+ # Store value
+ MyClass->foo( Foozle->new() );
+
+ # Retrieve value
+ print MyClass->foo;
+
+B<NOTE: THIS METHOD GENERATOR HAS NOT BEEN WRITTEN YET.>
+
+=cut
+
+sub object { }
+
+########################################################################
+
+=head1 SEE ALSO
+
+See L<Class::MakeMethods> for general information about this distribution.
+
+See L<Class::MakeMethods::Composite> for more about this family of subclasses.
+
+=cut
+
+1;
diff --git a/lib/Class/MakeMethods/Composite/Universal.pm b/lib/Class/MakeMethods/Composite/Universal.pm
new file mode 100644
index 0000000..e53e76d
--- /dev/null
+++ b/lib/Class/MakeMethods/Composite/Universal.pm
@@ -0,0 +1,150 @@
+=head1 NAME
+
+Class::MakeMethods::Composite::Universal - Composite Method Tricks
+
+=head1 SYNOPSIS
+
+ Class::MakeMethods::Composite::Universal->make_patch(
+ -TargetClass => 'SomeClass::OverYonder',
+ name => 'foo',
+ pre_rules => [
+ sub {
+ my $method = pop;
+ warn "Arguments for foo:", @_
+ }
+ ]
+ post_rules => [
+ sub {
+ warn "Result of foo:", Class::MakeMethods::Composite->CurrentResults
+ }
+ ]
+ );
+
+=head1 DESCRIPTION
+
+The Composite::Universal suclass of MakeMethods provides some generally-applicable types of methods based on Class::MakeMethods::Composite.
+
+=cut
+
+package Class::MakeMethods::Composite::Universal;
+
+$VERSION = 1.000;
+use strict;
+use Class::MakeMethods::Composite '-isasubclass';
+use Carp;
+
+########################################################################
+
+=head1 METHOD GENERATOR TYPES
+
+=head2 patch
+
+The patch ruleset generates composites whose core behavior is based on an existing subroutine.
+
+Here's a sample usage:
+
+ sub foo {
+ my $count = shift;
+ return 'foo' x $count;
+ }
+
+ Class::MakeMethods::Composite::Universal->make(
+ -ForceInstall => 1,
+ patch => {
+ name => 'foo',
+ pre_rules => [
+ sub {
+ my $method = pop @_;
+ if ( ! scalar @_ ) {
+ @{ $method->{args} } = ( 2 );
+ }
+ },
+ sub {
+ my $method = pop @_;
+ my $count = shift;
+ if ( $count > 99 ) {
+ Carp::confess "Won't foo '$count' -- that's too many!"
+ }
+ },
+ ],
+ post_rules => [
+ sub {
+ my $method = pop @_;
+ if ( ref $method->{result} eq 'SCALAR' ) {
+ ${ $method->{result} } =~ s/oof/oozle-f/g;
+ } elsif ( ref $method->{result} eq 'ARRAY' ) {
+ map { s/oof/oozle-f/g } @{ $method->{result} };
+ }
+ }
+ ],
+ },
+ );
+
+=cut
+
+use vars qw( %PatchFragments );
+
+sub patch {
+ (shift)->_build_composite( \%PatchFragments, @_ );
+}
+
+%PatchFragments = (
+ '' => [
+ '+init' => sub {
+ my $method = pop @_;
+ my $origin = ( $Class::MethodMaker::CONTEXT{TargetClass} || '' ) .
+ '::' . $method->{name};
+ no strict 'refs';
+ $method->{patch_original} = *{ $origin }{CODE}
+ or croak "No subroutine $origin() to patch";
+ },
+ 'do' => sub {
+ my $method = pop @_;
+ my $sub = $method->{patch_original};
+ &$sub( @_ );
+ },
+ ],
+);
+
+=head2 make_patch
+
+A convenient wrapper for C<make()> and the C<patch> method generator.
+
+Provides the '-ForceInstall' flag, which is required to ensure that the patched subroutine replaces the original.
+
+For example, one could add logging to an existing method as follows:
+
+ Class::MakeMethods::Composite::Universal->make_patch(
+ -TargetClass => 'SomeClass::OverYonder',
+ name => 'foo',
+ pre_rules => [
+ sub {
+ my $method = pop;
+ warn "Arguments for foo:", @_
+ }
+ ]
+ post_rules => [
+ sub {
+ warn "Result of foo:", Class::MakeMethods::Composite->CurrentResults
+ }
+ ]
+ );
+
+=cut
+
+sub make_patch {
+ (shift)->make( -ForceInstall => 1, patch => { @_ } );
+}
+
+
+########################################################################
+
+=head1 SEE ALSO
+
+See L<Class::MakeMethods> for general information about this distribution.
+
+See L<Class::MakeMethods::Composite> for more about this family of subclasses.
+
+=cut
+
+1;