Once again syncing after too long an absence

[p5sagit/p5-mst-13.2.git] / lib / Class / Struct.pm

diff --git a/lib/Class/Struct.pm b/lib/Class/Struct.pm
index ac1fb47..185a8ff 100644 (file)
--- a/lib/Class/Struct.pm
+++ b/lib/Class/Struct.pm
@@ -14,7 +14,7 @@ require Exporter;
 @ISA = qw(Exporter);
 @EXPORT = qw(struct);
 
-$VERSION = '0.58';
+$VERSION = '0.59';
 
 ## Tested on 5.002 and 5.003 without class membership tests:
 my $CHECK_CLASS_MEMBERSHIP = ($] >= 5.003_95);
@@ -51,6 +51,20 @@ sub printem {
     sub DESTROY { }
 }
 
+sub import {
+    my $self = shift;
+
+    if ( @_ == 0 ) {
+      $self->export_to_level( 1, $self, @EXPORT );
+    } elsif ( @_ == 1 ) {
+       # This is admittedly a little bit silly:
+       # do we ever export anything else than 'struct'...?
+      $self->export_to_level( 1, $self, @_ );
+    } else {
+      &struct;
+    }
+}
+
 sub struct {
 
     # Determine parameter list structure, one of:
@@ -76,6 +90,7 @@ sub struct {
         $class = (caller())[0];
         @decls = @_;
     }
+
     _usage_error() if @decls % 2 == 1;
 
     # Ensure we are not, and will not be, a subclass.
@@ -242,6 +257,9 @@ Class::Struct - declare struct-like datatypes as Perl classes
             # declare struct, based on array, implicit class name:
     struct( ELEMENT_NAME => ELEMENT_TYPE, ... );
 
+    # Declare struct at compile time
+    use Class::Struct CLASS_NAME => [ ELEMENT_NAME => ELEMENT_TYPE, ... ];
+    use Class::Struct CLASS_NAME => { ELEMENT_NAME => ELEMENT_TYPE, ... };
 
     package Myobj;
     use Class::Struct;
@@ -262,14 +280,13 @@ Class::Struct - declare struct-like datatypes as Perl classes
                                     # hash type accessor:
     $hash_ref = $obj->h;                # reference to whole hash
     $hash_element_value = $obj->h('x'); # hash element value
-    $obj->h('x', 'new value');        # assign to hash element
+    $obj->h('x', 'new value');          # assign to hash element
 
                                     # class type accessor:
     $element_value = $obj->c;           # object reference
     $obj->c->method(...);               # call method of object
     $obj->c(new My_Other_Class);        # assign a new object
 
-
 =head1 DESCRIPTION
 
 C<Class::Struct> exports a single function, C<struct>.
@@ -287,7 +304,6 @@ same name in the package.  (See Example 2.)
 
 Each element's type can be scalar, array, hash, or class.
 
-
 =head2 The C<struct()> function
 
 The C<struct> function has three forms of parameter-list.
@@ -326,6 +342,15 @@ element name will be defined as an accessor method unless a
 method by that name is explicitly defined; in the latter case, a
 warning is issued if the warning flag (B<-w>) is set.
 
+=head2 Class Creation at Compile Time
+
+C<Class::Struct> can create your class at compile time.  The main reason
+for doing this is obvious, so your class acts like every other class in
+Perl.  Creating your class at compile time will make the order of events
+similar to using any other class ( or Perl module ).
+
+There is no significant speed gain between compile time and run time
+class creation, there is just a new, more standard order of events.
 
 =head2 Element Types and Accessor Methods
 
@@ -410,7 +435,6 @@ contents of that hash are passed to the element's own constructor.
 
 See Example 3 below for an example of initialization.
 
-
 =head1 EXAMPLES
 
 =over
@@ -444,7 +468,6 @@ type C<timeval>.
     $t->ru_stime->tv_secs(5);
     $t->ru_stime->tv_usecs(0);
 
-
 =item Example 2
 
 An accessor function can be redefined in order to provide
@@ -492,7 +515,6 @@ Note that the initializer for a nested struct is specified
 as an anonymous hash of initializers, which is passed on to the nested
 struct's constructor.
 
-
     use Class::Struct;
 
     struct Breed =>
@@ -524,6 +546,9 @@ struct's constructor.
 
 =head1 Author and Modification History
 
+Modified by Casey Tweten, 2000-11-08, v0.59.
+
+    Added the ability for compile time class creation.
 
 Modified by Damian Conway, 1999-03-05, v0.58.
 
@@ -541,7 +566,6 @@ Modified by Damian Conway, 1999-03-05, v0.58.
     Previously these were returned as a reference to a reference
     to the element.
 
-
 Renamed to C<Class::Struct> and modified by Jim Miner, 1997-04-02.
 
     members() function removed.
@@ -553,7 +577,6 @@ Renamed to C<Class::Struct> and modified by Jim Miner, 1997-04-02.
     Class name to struct() made optional.
     Diagnostic checks added.
 
-
 Originally C<Class::Template> by Dean Roehrich.
 
     # Template.pm   --- struct/member template builder