home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _f8f8cc07f7fe7d749be82c2f588adffd < prev    next >
Text File  |  2000-03-23  |  9KB  |  205 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>constant - Perl pragma to declare constants</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> constant - Perl pragma to declare constants</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="#notes">NOTES</A></LI>
  26.     <LI><A HREF="#technical note">TECHNICAL NOTE</A></LI>
  27.     <LI><A HREF="#bugs">BUGS</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>constant - Perl pragma to declare constants</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.     use constant BUFFER_SIZE    => 4096;
  49.     use constant ONE_YEAR       => 365.2425 * 24 * 60 * 60;
  50.     use constant PI             => 4 * atan2 1, 1;
  51.     use constant DEBUGGING      => 0;
  52.     use constant ORACLE         => 'oracle@cs.indiana.edu';
  53.     use constant USERNAME       => scalar getpwuid($<);
  54.     use constant USERINFO       => getpwuid($<);</PRE>
  55. <PRE>
  56.     sub deg2rad { PI * $_[0] / 180 }</PRE>
  57. <PRE>
  58.     print "This line does nothing"              unless DEBUGGING;</PRE>
  59. <PRE>
  60.     # references can be constants
  61.     use constant CHASH          => { foo => 42 };
  62.     use constant CARRAY         => [ 1,2,3,4 ];
  63.     use constant CPSEUDOHASH    => [ { foo => 1}, 42 ];
  64.     use constant CCODE          => sub { "bite $_[0]\n" };</PRE>
  65. <PRE>
  66.     print CHASH->{foo};
  67.     print CARRAY->[$i];
  68.     print CPSEUDOHASH->{foo};
  69.     print CCODE->("me");
  70.     print CHASH->[10];                  # compile-time error</PRE>
  71. <P>
  72. <HR>
  73. <H1><A NAME="description">DESCRIPTION</A></H1>
  74. <P>This will declare a symbol to be a constant with the given scalar
  75. or list value.</P>
  76. <P>When you declare a constant such as <CODE>PI</CODE> using the method shown
  77. above, each machine your script runs upon can have as many digits
  78. of accuracy as it can use. Also, your program will be easier to
  79. read, more likely to be maintained (and maintained correctly), and
  80. far less likely to send a space probe to the wrong planet because
  81. nobody noticed the one equation in which you wrote <CODE>3.14195</CODE>.</P>
  82. <P>
  83. <HR>
  84. <H1><A NAME="notes">NOTES</A></H1>
  85. <P>The value or values are evaluated in a list context. You may override
  86. this with <A HREF="../lib/Pod/perlfunc.html#item_scalar"><CODE>scalar</CODE></A> as shown above.</P>
  87. <P>These constants do not directly interpolate into double-quotish
  88. strings, although you may do so indirectly. (See <A HREF="../lib/Pod/perlref.html">the perlref manpage</A> for
  89. details about how this works.)</P>
  90. <PRE>
  91.     print "The value of PI is @{[ PI ]}.\n";</PRE>
  92. <P>List constants are returned as lists, not as arrays.</P>
  93. <PRE>
  94.     $homedir = USERINFO[7];             # WRONG
  95.     $homedir = (USERINFO)[7];           # Right</PRE>
  96. <P>The use of all caps for constant names is merely a convention,
  97. although it is recommended in order to make constants stand out
  98. and to help avoid collisions with other barewords, keywords, and
  99. subroutine names. Constant names must begin with a letter or
  100. underscore. Names beginning with a double underscore are reserved. Some
  101. poor choices for names will generate warnings, if warnings are enabled at
  102. compile time.</P>
  103. <P>Constant symbols are package scoped (rather than block scoped, as
  104. <CODE>use strict</CODE> is). That is, you can refer to a constant from package
  105. Other as <CODE>Other::CONST</CODE>.</P>
  106. <P>As with all <A HREF="../lib/Pod/perlfunc.html#item_use"><CODE>use</CODE></A> directives, defining a constant happens at
  107. compile time. Thus, it's probably not correct to put a constant
  108. declaration inside of a conditional statement (like <CODE>if ($foo)
  109. { use constant ... }</CODE>).</P>
  110. <P>Omitting the value for a symbol gives it the value of <A HREF="../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> in
  111. a scalar context or the empty list, <CODE>()</CODE>, in a list context. This
  112. isn't so nice as it may sound, though, because in this case you
  113. must either quote the symbol name, or use a big arrow, (<CODE>=></CODE>),
  114. with nothing to point to. It is probably best to declare these
  115. explicitly.</P>
  116. <PRE>
  117.     use constant UNICORNS       => ();
  118.     use constant LOGFILE        => undef;</PRE>
  119. <P>The result from evaluating a list constant in a scalar context is
  120. not documented, and is <STRONG>not</STRONG> guaranteed to be any particular value
  121. in the future. In particular, you should not rely upon it being
  122. the number of elements in the list, especially since it is not
  123. <STRONG>necessarily</STRONG> that value in the current implementation.</P>
  124. <P>Magical values, tied values, and references can be made into
  125. constants at compile time, allowing for way cool stuff like this.
  126. (These error numbers aren't totally portable, alas.)</P>
  127. <PRE>
  128.     use constant E2BIG => ($! = 7);
  129.     print   E2BIG, "\n";        # something like "Arg list too long"
  130.     print 0+E2BIG, "\n";        # "7"</PRE>
  131. <P>Dereferencing constant references incorrectly (such as using an array
  132. subscript on a constant hash reference, or vice versa) will be trapped at
  133. compile time.</P>
  134. <P>In the rare case in which you need to discover at run time whether a
  135. particular constant has been declared via this module, you may use
  136. this function to examine the hash <CODE>%constant::declared</CODE>. If the given
  137. constant name does not include a package name, the current package is
  138. used.</P>
  139. <PRE>
  140.     sub declared ($) {
  141.         use constant 1.01;              # don't omit this!
  142.         my $name = shift;
  143.         $name =~ s/^::/main::/;
  144.         my $pkg = caller;
  145.         my $full_name = $name =~ /::/ ? $name : "${pkg}::$name";
  146.         $constant::declared{$full_name};
  147.     }</PRE>
  148. <P>
  149. <HR>
  150. <H1><A NAME="technical note">TECHNICAL NOTE</A></H1>
  151. <P>In the current implementation, scalar constants are actually
  152. inlinable subroutines. As of version 5.004 of Perl, the appropriate
  153. scalar constant is inserted directly in place of some subroutine
  154. calls, thereby saving the overhead of a subroutine call. See
  155. <A HREF="../lib/Pod/perlsub.html#constant functions">Constant Functions in the perlsub manpage</A> for details about how and when this
  156. happens.</P>
  157. <P>
  158. <HR>
  159. <H1><A NAME="bugs">BUGS</A></H1>
  160. <P>In the current version of Perl, list constants are not inlined
  161. and some symbols may be redefined without generating a warning.</P>
  162. <P>It is not possible to have a subroutine or keyword with the same
  163. name as a constant in the same package. This is probably a Good Thing.</P>
  164. <P>A constant with a name in the list <CODE>STDIN STDOUT STDERR ARGV ARGVOUT
  165. ENV INC SIG</CODE> is not allowed anywhere but in package <CODE>main::</CODE>, for
  166. technical reasons.</P>
  167. <P>Even though a reference may be declared as a constant, the reference may
  168. point to data which may be changed, as this code shows.</P>
  169. <PRE>
  170.     use constant CARRAY         => [ 1,2,3,4 ];
  171.     print CARRAY->[1];
  172.     CARRAY->[1] = " be changed";
  173.     print CARRAY->[1];</PRE>
  174. <P>Unlike constants in some languages, these cannot be overridden
  175. on the command line or via environment variables.</P>
  176. <P>You can get into trouble if you use constants in a context which
  177. automatically quotes barewords (as is true for any subroutine call).
  178. For example, you can't say <CODE>$hash{CONSTANT}</CODE> because <CODE>CONSTANT</CODE> will
  179. be interpreted as a string.  Use <CODE>$hash{CONSTANT()}</CODE> or
  180. <CODE>$hash{+CONSTANT}</CODE> to prevent the bareword quoting mechanism from
  181. kicking in.  Similarly, since the <CODE>=></CODE> operator quotes a bareword
  182. immediately to its left, you have to say <CODE>CONSTANT() => 'value'</CODE>
  183. (or simply use a comma in place of the big arrow) instead of
  184. <CODE>CONSTANT => 'value'</CODE>.</P>
  185. <P>
  186. <HR>
  187. <H1><A NAME="author">AUTHOR</A></H1>
  188. <P>Tom Phoenix, <<EM><A HREF="mailto:rootbeer@redcat.com">rootbeer@redcat.com</A></EM>>, with help from
  189. many other folks.</P>
  190. <P>
  191. <HR>
  192. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  193. <P>Copyright (C) 1997, 1999 Tom Phoenix</P>
  194. <P>This module is free software; you can redistribute it or modify it
  195. under the same terms as Perl itself.</P>
  196. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  197. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  198. <STRONG><P CLASS=block> constant - Perl pragma to declare constants</P></STRONG>
  199. </TD></TR>
  200. </TABLE>
  201.  
  202. </BODY>
  203.  
  204. </HTML>
  205.