📄 constant.3
字号:
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05).\".\" Standard preamble:.\" ========================================================================.de Sh \" Subsection heading.br.if t .Sp.ne 5.PP\fB\\$1\fR.PP...de Sp \" Vertical space (when we can't use .PP).if t .sp .5v.if n .sp...de Vb \" Begin verbatim text.ft CW.nf.ne \\$1...de Ve \" End verbatim text.ft R.fi...\" Set up some character translations and predefined strings. \*(-- will.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left.\" double quote, and \*(R" will give a right double quote. \*(C+ will.\" give a nicer C++. Capital omega is used to do unbreakable dashes and.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,.\" nothing in troff, for use with C<>..tr \(*W-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'.ie n \{\. ds -- \(*W-. ds PI pi. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch. ds L" "". ds R" "". ds C` "". ds C' ""'br\}.el\{\. ds -- \|\(em\|. ds PI \(*p. ds L" ``. ds R" '''br\}.\".\" Escape single quotes in literal strings from groff's Unicode transform..ie \n(.g .ds Aq \(aq.el .ds Aq '.\".\" If the F register is turned on, we'll generate index entries on stderr for.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index.\" entries marked with X<> in POD. Of course, you'll have to process the.\" output yourself in some meaningful fashion..ie \nF \{\. de IX. tm Index:\\$1\t\\n%\t"\\$2"... nr % 0. rr F.\}.el \{\. de IX...\}.\".\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2)..\" Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff.if n \{\. ds #H 0. ds #V .8m. ds #F .3m. ds #[ \f1. ds #] \fP.\}.if t \{\. ds #H ((1u-(\\\\n(.fu%2u))*.13m). ds #V .6m. ds #F 0. ds #[ \&. ds #] \&.\}. \" simple accents for nroff and troff.if n \{\. ds ' \&. ds ` \&. ds ^ \&. ds , \&. ds ~ ~. ds /.\}.if t \{\. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u". ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'.\}. \" troff and (daisy-wheel) nroff accents.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'.ds 8 \h'\*(#H'\(*b\h'-\*(#H'.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#].ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#].ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#].ds ae a\h'-(\w'a'u*4/10)'e.ds Ae A\h'-(\w'A'u*4/10)'E. \" corrections for vroff.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'. \" for low resolution devices (crt and lpr).if \n(.H>23 .if \n(.V>19 \\{\. ds : e. ds 8 ss. ds o a. ds d- d\h'-1'\(ga. ds D- D\h'-1'\(hy. ds th \o'bp'. ds Th \o'LP'. ds ae ae. ds Ae AE.\}.rm #[ #] #H #V #F C.\" ========================================================================.\".IX Title "constant 3".TH constant 3 "2007-12-18" "perl v5.10.0" "Perl Programmers Reference Guide".\" For nroff, turn off justification. Always turn off hyphenation; it makes.\" way too many mistakes in technical documents..if n .ad l.nh.SH "NAME"constant \- Perl pragma to declare constants.SH "SYNOPSIS".IX Header "SYNOPSIS".Vb 2\& use constant PI => 4 * atan2(1, 1);\& use constant DEBUG => 0;\&\& print "Pi equals ", PI, "...\en" if DEBUG;\&\& use constant {\& SEC => 0,\& MIN => 1,\& HOUR => 2,\& MDAY => 3,\& MON => 4,\& YEAR => 5,\& WDAY => 6,\& YDAY => 7,\& ISDST => 8,\& };\&\& use constant WEEKDAYS => qw(\& Sunday Monday Tuesday Wednesday Thursday Friday Saturday\& );\&\& print "Today is ", (WEEKDAYS)[ (localtime)[WDAY] ], ".\en";.Ve.SH "DESCRIPTION".IX Header "DESCRIPTION"This pragma allows you to declare constants at compile-time..PPWhen you declare a constant such as \f(CW\*(C`PI\*(C'\fR using the method shownabove, each machine your script runs upon can have as many digitsof accuracy as it can use. Also, your program will be easier toread, more likely to be maintained (and maintained correctly), andfar less likely to send a space probe to the wrong planet becausenobody noticed the one equation in which you wrote \f(CW3.14195\fR..PPWhen a constant is used in an expression, perl replaces it with itsvalue at compile time, and may then optimize the expression further.In particular, any code in an \f(CW\*(C`if (CONSTANT)\*(C'\fR block will be optimizedaway if the constant is false..SH "NOTES".IX Header "NOTES"As with all \f(CW\*(C`use\*(C'\fR directives, defining a constant happens atcompile time. Thus, it's probably not correct to put a constantdeclaration inside of a conditional statement (like \f(CW\*(C`if ($foo){ use constant ... }\*(C'\fR)..PPConstants defined using this module cannot be interpolated intostrings like variables. However, concatenation works just fine:.PP.Vb 2\& print "Pi equals PI...\en"; # WRONG: does not expand "PI"\& print "Pi equals ".PI."...\en"; # right.Ve.PPEven though a reference may be declared as a constant, the reference maypoint to data which may be changed, as this code shows..PP.Vb 4\& use constant ARRAY => [ 1,2,3,4 ];\& print ARRAY\->[1];\& ARRAY\->[1] = " be changed";\& print ARRAY\->[1];.Ve.PPDereferencing constant references incorrectly (such as using an arraysubscript on a constant hash reference, or vice versa) will be trapped atcompile time..PPConstants belong to the package they are defined in. To refer to aconstant defined in another package, specify the full package name, asin \f(CW\*(C`Some::Package::CONSTANT\*(C'\fR. Constants may be exported by modules,and may also be called as either class or instance methods, that is,as \f(CW\*(C`Some::Package\->CONSTANT\*(C'\fR or as \f(CW\*(C`$obj\->CONSTANT\*(C'\fR where\&\f(CW$obj\fR is an instance of \f(CW\*(C`Some::Package\*(C'\fR. Subclasses may definetheir own constants to override those in their base class..PPThe use of all caps for constant names is merely a convention,although it is recommended in order to make constants stand outand to help avoid collisions with other barewords, keywords, andsubroutine names. Constant names must begin with a letter orunderscore. Names beginning with a double underscore are reserved. Somepoor choices for names will generate warnings, if warnings are enabled atcompile time..Sh "List constants".IX Subsection "List constants"Constants may be lists of more (or less) than one value. A constantwith no values evaluates to \f(CW\*(C`undef\*(C'\fR in scalar context. Note thatconstants with more than one value do \fInot\fR return their last value inscalar context as one might expect. They currently return the numberof values, but \fBthis may change in the future\fR. Do not use constantswith multiple values in scalar context..PP\&\fB\s-1NOTE:\s0\fR This implies that the expression defining the value of aconstant is evaluated in list context. This may produce surprises:.PP.Vb 2\& use constant TIMESTAMP => localtime; # WRONG!\& use constant TIMESTAMP => scalar localtime; # right.Ve.PPThe first line above defines \f(CW\*(C`TIMESTAMP\*(C'\fR as a 9\-element list, asreturned by \f(CW\*(C`localtime()\*(C'\fR in list context. To set it to the stringreturned by \f(CW\*(C`localtime()\*(C'\fR in scalar context, an explicit \f(CW\*(C`scalar\*(C'\fRkeyword is required..PPList constants are lists, not arrays. To index or slice them, theymust be placed in parentheses..PP.Vb 2\& my @workdays = WEEKDAYS[1 .. 5]; # WRONG!\& my @workdays = (WEEKDAYS)[1 .. 5]; # right.Ve.Sh "Defining multiple constants at once".IX Subsection "Defining multiple constants at once"Instead of writing multiple \f(CW\*(C`use constant\*(C'\fR statements, you may definemultiple constants in a single statement by giving, instead of theconstant name, a reference to a hash where the keys are the names ofthe constants to be defined. Obviously, all constants defined usingthis method must have a single value..PP.Vb 4\& use constant {\& FOO => "A single value",\& BAR => "This", "won\*(Aqt", "work!", # Error!\& };.Ve.PPThis is a fundamental limitation of the way hashes are constructed inPerl. The error messages produced when this happens will often bequite cryptic \*(-- in the worst case there may be none at all, andyou'll only later find that something is broken..PPWhen defining multiple constants, you cannot use the values of otherconstants defined in the same declaration. This is because thecalling package doesn't know about any constant within that groupuntil \fIafter\fR the \f(CW\*(C`use\*(C'\fR statement is finished..PP.Vb 4\& use constant {\& BITMASK => 0xAFBAEBA8,\& NEGMASK => ~BITMASK, # Error!\& };.Ve.Sh "Magic constants".IX Subsection "Magic constants"Magical values and references can be made into constants at compiletime, allowing for way cool stuff like this. (These error numbersaren't totally portable, alas.).PP.Vb 3\& use constant E2BIG => ($! = 7);\& print E2BIG, "\en"; # something like "Arg list too long"\& print 0+E2BIG, "\en"; # "7".Ve.PPYou can't produce a tied constant by giving a tied scalar as thevalue. References to tied variables, however, can be used asconstants without any problems..SH "TECHNICAL NOTES".IX Header "TECHNICAL NOTES"In the current implementation, scalar constants are actuallyinlinable subroutines. As of version 5.004 of Perl, the appropriatescalar constant is inserted directly in place of some subroutinecalls, thereby saving the overhead of a subroutine call. See\&\*(L"Constant Functions\*(R" in perlsub for details about how and when thishappens..PPIn the rare case in which you need to discover at run time whether aparticular constant has been declared via this module, you may usethis function to examine the hash \f(CW%constant::declared\fR. If the givenconstant name does not include a package name, the current package isused..PP.Vb 8\& sub declared ($) {\& use constant 1.01; # don\*(Aqt omit this!\& my $name = shift;\& $name =~ s/^::/main::/;\& my $pkg = caller;\& my $full_name = $name =~ /::/ ? $name : "${pkg}::$name";\& $constant::declared{$full_name};\& }.Ve.SH "CAVEATS".IX Header "CAVEATS"In the current version of Perl, list constants are not inlinedand some symbols may be redefined without generating a warning..PPIt is not possible to have a subroutine or a keyword with the samename as a constant in the same package. This is probably a Good Thing..PPA constant with a name in the list \f(CW\*(C`STDIN STDOUT STDERR ARGV ARGVOUTENV INC SIG\*(C'\fR is not allowed anywhere but in package \f(CW\*(C`main::\*(C'\fR, fortechnical reasons..PPUnlike constants in some languages, these cannot be overriddenon the command line or via environment variables..PPYou can get into trouble if you use constants in a context whichautomatically quotes barewords (as is true for any subroutine call).For example, you can't say \f(CW$hash{CONSTANT}\fR because \f(CW\*(C`CONSTANT\*(C'\fR willbe interpreted as a string. Use \f(CW$hash{CONSTANT()}\fR or\&\f(CW$hash{+CONSTANT}\fR to prevent the bareword quoting mechanism fromkicking in. Similarly, since the \f(CW\*(C`=>\*(C'\fR operator quotes a barewordimmediately to its left, you have to say \f(CW\*(C`CONSTANT() => \*(Aqvalue\*(Aq\*(C'\fR(or simply use a comma in place of the big arrow) instead of\&\f(CW\*(C`CONSTANT => \*(Aqvalue\*(Aq\*(C'\fR..SH "BUGS".IX Header "BUGS"Please report any bugs or feature requests via the \fIperlbug\fR\|(1) utility..SH "AUTHORS".IX Header "AUTHORS"Tom Phoenix, <\fIrootbeer@redcat.com\fR>, with help frommany other folks..PPMultiple constant declarations at once added by Casey West,<\fIcasey@geeknest.com\fR>..PPDocumentation mostly rewritten by Ilmari Karonen,<\fIperl@itz.pp.sci.fi\fR>..PPThis program is maintained by the Perl 5 Porters. The \s-1CPAN\s0 distribution is maintained by Se\*'bastien Aperghis-Tramoni<\fIsebastien@aperghis.net\fR>..SH "COPYRIGHT".IX Header "COPYRIGHT"Copyright (C) 1997, 1999 Tom Phoenix.PPThis module is free software; you can redistribute it or modify itunder the same terms as Perl itself.
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -