home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _9345c27bde1693abcc92bda21ccbb5a6 < prev    next >
Text File  |  2000-03-23  |  6KB  |  160 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>fields - compile-time class fields</TITLE>
  5. <LINK REL="stylesheet" HREF="../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> fields - compile-time class fields</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  26. </UL>
  27. <!-- INDEX END -->
  28.  
  29. <HR>
  30. <P>
  31. <H1><A NAME="name">NAME</A></H1>
  32. <P>fields - compile-time class fields</P>
  33. <P>
  34. <HR>
  35. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  36. <UL>
  37. <LI>Linux</LI>
  38. <LI>Solaris</LI>
  39. <LI>Windows</LI>
  40. </UL>
  41. <HR>
  42. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  43. <PRE>
  44.     {
  45.         package Foo;
  46.         use fields qw(foo bar _Foo_private);
  47.         sub new {
  48.             my Foo $self = shift;
  49.             unless (ref $self) {
  50.                 $self = fields::new($self);
  51.                 $self->{_Foo_private} = "this is Foo's secret";
  52.             }
  53.             $self->{foo} = 10;
  54.             $self->{bar} = 20;
  55.             return $self;
  56.         }
  57.     }</PRE>
  58. <PRE>
  59.     my Foo $var = Foo::->new;
  60.     $var->{foo} = 42;</PRE>
  61. <PRE>
  62.     # this will generate a compile-time error
  63.     $var->{zap} = 42;</PRE>
  64. <PRE>
  65.     # subclassing
  66.     {
  67.         package Bar;
  68.         use base 'Foo';
  69.         use fields qw(baz _Bar_private);        # not shared with Foo
  70.         sub new {
  71.             my $class = shift;
  72.             my $self = fields::new($class);
  73.             $self->SUPER::new();                # init base fields
  74.             $self->{baz} = 10;                  # init own fields
  75.             $self->{_Bar_private} = "this is Bar's secret";
  76.             return $self;
  77.         }
  78.     }</PRE>
  79. <P>
  80. <HR>
  81. <H1><A NAME="description">DESCRIPTION</A></H1>
  82. <P>The <CODE>fields</CODE> pragma enables compile-time verified class fields.</P>
  83. <P>NOTE: The current implementation keeps the declared fields in the %FIELDS
  84. hash of the calling package, but this may change in future versions.
  85. Do <STRONG>not</STRONG> update the %FIELDS hash directly, because it must be created
  86. at compile-time for it to be fully useful, as is done by this pragma.</P>
  87. <P>If a typed lexical variable holding a reference is used to access a
  88. hash element and a package with the same name as the type has declared
  89. class fields using this pragma, then the operation is turned into an
  90. array access at compile time.</P>
  91. <P>The related <CODE>base</CODE> pragma will combine fields from base classes and any
  92. fields declared using the <CODE>fields</CODE> pragma.  This enables field
  93. inheritance to work properly.</P>
  94. <P>Field names that start with an underscore character are made private to
  95. the class and are not visible to subclasses.  Inherited fields can be
  96. overridden but will generate a warning if used together with the <CODE>-w</CODE>
  97. switch.</P>
  98. <P>The effect of all this is that you can have objects with named fields
  99. which are as compact and as fast arrays to access.  This only works
  100. as long as the objects are accessed through properly typed variables.
  101. If the objects are not typed, access is only checked at run time.</P>
  102. <P>The following functions are supported:</P>
  103. <DL>
  104. <DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
  105. <DD>
  106. fields::new() creates and blesses a pseudo-hash comprised of the fields
  107. declared using the <CODE>fields</CODE> pragma into the specified class.
  108. This makes it possible to write a constructor like this:
  109. <PRE>
  110.     package Critter::Sounds;
  111.     use fields qw(cat dog bird);</PRE>
  112. <PRE>
  113.     sub new {
  114.         my Critter::Sounds $self = shift;
  115.         $self = fields::new($self) unless ref $self;
  116.         $self->{cat} = 'meow';                          # scalar element
  117.         @$self{'dog','bird'} = ('bark','tweet');        # slice
  118.         return $self;
  119.     }</PRE>
  120. <P></P>
  121. <DT><STRONG><A NAME="item_phash">phash</A></STRONG><BR>
  122. <DD>
  123. fields::phash() can be used to create and initialize a plain (unblessed)
  124. pseudo-hash.  This function should always be used instead of creating
  125. pseudo-hashes directly.
  126. <P>If the first argument is a reference to an array, the pseudo-hash will
  127. be created with keys from that array.  If a second argument is supplied,
  128. it must also be a reference to an array whose elements will be used as
  129. the values.  If the second array contains less elements than the first,
  130. the trailing elements of the pseudo-hash will not be initialized.
  131. This makes it particularly useful for creating a pseudo-hash from
  132. subroutine arguments:</P>
  133. <PRE>
  134.     sub dogtag {
  135.         my $tag = fields::phash([qw(name rank ser_num)], [@_]);
  136.     }</PRE>
  137. <P>fields::phash() also accepts a list of key-value pairs that will
  138. be used to construct the pseudo hash.  Examples:</P>
  139. <PRE>
  140.     my $tag = fields::phash(name => "Joe",
  141.                             rank => "captain",
  142.                             ser_num => 42);</PRE>
  143. <PRE>
  144.     my $pseudohash = fields::phash(%args);</PRE>
  145. <P></P></DL>
  146. <P>
  147. <HR>
  148. <H1><A NAME="see also">SEE ALSO</A></H1>
  149. <P><A HREF="../lib/base.html">the base manpage</A>,
  150. <A HREF="../lib/Pod/perlref.html#pseudohashes: using an array as a hash">Pseudo-hashes: Using an array as a hash in the perlref manpage</A></P>
  151. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  152. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  153. <STRONG><P CLASS=block> fields - compile-time class fields</P></STRONG>
  154. </TD></TR>
  155. </TABLE>
  156.  
  157. </BODY>
  158.  
  159. </HTML>
  160.