PERLOP(1) Perl Programmers Reference Guide PERLOP(1)
NAME
perlop - Perl operators and precedence
DESCRIPTION
Operator Precedence and Associativity
Operator precedence and associativity work in Perl more or less like they do in mathematics.
Operator precedence means some operators are evaluated before others. For example, in "2 + 4 * 5", the multiplication has higher
precedence so "4 * 5" is evaluated first yielding "2 + 20 == 22" and not "6 * 5 == 30".
Operator associativity defines what happens if a sequence of the same operators is used one after another: whether the evaluator will
evaluate the left operations first or the right. For example, in "8 - 4 - 2", subtraction is left associative so Perl evaluates the
expression left to right. "8 - 4" is evaluated first making the expression "4 - 2 == 2" and not "8 - 2 == 6".
Perl operators have the following associativity and precedence, listed from highest precedence to lowest. Operators borrowed from C keep
the same precedence relationship with each other, even where C's precedence is slightly screwy. (This makes learning Perl easier for C
folks.) With very few exceptions, these all operate on scalar values only, not array values.
left terms and list operators (leftward)
left ->
nonassoc ++ --
right **
right ! ~ and unary + and -
left =~ !~
left * / % x
left + - .
left << >>
nonassoc named unary operators
nonassoc < > <= >= lt gt le ge
nonassoc == != <=> eq ne cmp ~~
left &
left | ^
left &&
left || //
nonassoc .. ...
right ?:
right = += -= *= etc.
left , =>
nonassoc list operators (rightward)
right not
left and
left or xor
In the following sections, these operators are covered in precedence order.
Many operators can be overloaded for objects. See overload.
Terms and List Operators (Leftward)
A TERM has the highest precedence in Perl. They include variables, quote and quote-like operators, any expression in parentheses, and any
function whose arguments are parenthesized. Actually, there aren't really functions in this sense, just list operators and unary operators
behaving as functions because you put parentheses around the arguments. These are all documented in perlfunc.
If any list operator (print(), etc.) or any unary operator (chdir(), etc.) is followed by a left parenthesis as the next token, the
operator and arguments within parentheses are taken to be of highest precedence, just like a normal function call.
In the absence of parentheses, the precedence of list operators such as "print", "sort", or "chmod" is either very high or very low
depending on whether you are looking at the left side or the right side of the operator. For example, in
@ary = (1, 3, sort 4, 2);
print @ary; # prints 1324
the commas on the right of the sort are evaluated before the sort, but the commas on the left are evaluated after. In other words, list
operators tend to gobble up all arguments that follow, and then act like a simple TERM with regard to the preceding expression. Be careful
with parentheses:
# These evaluate exit before doing the print:
print($foo, exit); # Obviously not what you want.
print $foo, exit; # Nor is this.
# These do the print before evaluating exit:
(print $foo), exit; # This is what you want.
print($foo), exit; # Or this.
print ($foo), exit; # Or even this.
Also note that
print ($foo & 255) + 1, "
";
probably doesn't do what you expect at first glance. The parentheses enclose the argument list for "print" which is evaluated (printing
the result of "$foo & 255"). Then one is added to the return value of "print" (usually 1). The result is something like this:
1 + 1, "
"; # Obviously not what you meant.
To do what you meant properly, you must write:
print(($foo & 255) + 1, "
");
See "Named Unary Operators" for more discussion of this.
Also parsed as terms are the "do {}" and "eval {}" constructs, as well as subroutine and method calls, and the anonymous constructors "[]"
and "{}".
See also "Quote and Quote-like Operators" toward the end of this section, as well as "I/O Operators".
The Arrow Operator
""->"" is an infix dereference operator, just as it is in C and C++. If the right side is either a "[...]", "{...}", or a "(...)"
subscript, then the left side must be either a hard or symbolic reference to an array, a hash, or a subroutine respectively. (Or
technically speaking, a location capable of holding a hard reference, if it's an array or hash reference being used for assignment.) See
perlreftut and perlref.
Otherwise, the right side is a method name or a simple scalar variable containing either the method name or a subroutine reference, and the
left side must be either an object (a blessed reference) or a class name (that is, a package name). See perlobj.
Auto-increment and Auto-decrement
"++" and "--" work as in C. That is, if placed before a variable, they increment or decrement the variable by one before returning the
value, and if placed after, increment or decrement after returning the value.
$i = 0; $j = 0;
print $i++; # prints 0
print ++$j; # prints 1
Note that just as in C, Perl doesn't define when the variable is incremented or decremented. You just know it will be done sometime before
or after the value is returned. This also means that modifying a variable twice in the same statement will lead to undefined behavior.
Avoid statements like:
$i = $i ++;
print ++ $i + $i ++;
Perl will not guarantee what the result of the above statements is.
The auto-increment operator has a little extra builtin magic to it. If you increment a variable that is numeric, or that has ever been
used in a numeric context, you get a normal increment. If, however, the variable has been used in only string contexts since it was set,
and has a value that is not the empty string and matches the pattern "/^[a-zA-Z]*[0-9]*z/", the increment is done as a string, preserving
each character within its range, with carry:
print ++($foo = "99"); # prints "100"
print ++($foo = "a0"); # prints "a1"
print ++($foo = "Az"); # prints "Ba"
print ++($foo = "zz"); # prints "aaa"
"undef" is always treated as numeric, and in particular is changed to 0 before incrementing (so that a post-increment of an undef value
will return 0 rather than "undef").
The auto-decrement operator is not magical.
Exponentiation
Binary "**" is the exponentiation operator. It binds even more tightly than unary minus, so -2**4 is -(2**4), not (-2)**4. (This is
implemented using C's pow(3) function, which actually works on doubles internally.)
Symbolic Unary Operators
Unary "!" performs logical negation, that is, "not". See also "not" for a lower precedence version of this.
Unary "-" performs arithmetic negation if the operand is numeric, including any string that looks like a number. If the operand is an
identifier, a string consisting of a minus sign concatenated with the identifier is returned. Otherwise, if the string starts with a plus
or minus, a string starting with the opposite sign is returned. One effect of these rules is that -bareword is equivalent to the string
"-bareword". If, however, the string begins with a non-alphabetic character (excluding "+" or "-"), Perl will attempt to convert the
string to a numeric and the arithmetic negation is performed. If the string cannot be cleanly converted to a numeric, Perl will give the
warning Argument "the string" isn't numeric in negation (-) at ....
Unary "~" performs bitwise negation, that is, 1's complement. For example, "0666 & ~027" is 0640. (See also "Integer Arithmetic" and
"Bitwise String Operators".) Note that the width of the result is platform-dependent: ~0 is 32 bits wide on a 32-bit platform, but 64 bits
wide on a 64-bit platform, so if you are expecting a certain bit width, remember to use the "&" operator to mask off the excess bits.
When complementing strings, if all characters have ordinal values under 256, then their complements will, also. But if they do not, all
characters will be in either 32- or 64-bit complements, depending on your architecture. So for example, "~"x{3B1}"" is "x{FFFF_FC4E}" on
32-bit machines and "x{FFFF_FFFF_FFFF_FC4E}" on 64-bit machines.
Unary "+" has no effect whatsoever, even on strings. It is useful syntactically for separating a function name from a parenthesized
expression that would otherwise be interpreted as the complete list of function arguments. (See examples above under "Terms and List
Operators (Leftward)".)
Unary "" creates a reference to whatever follows it. See perlreftut and perlref. Do not confuse this behavior with the behavior of
backslash within a string, although both forms do convey the notion of protecting the next thing from interpolation.
Binding Operators
Binary "=~" binds a scalar expression to a pattern match. Certain operations search or modify the string $_ by default. This operator
makes that kind of operation work on some other string. The right argument is a search pattern, substitution, or transliteration. The
left argument is what is supposed to be searched, substituted, or transliterated instead of the default $_. When used in scalar context,
the return value generally indicates the success of the operation. The exceptions are substitution (s///) and transliteration (y///) with
the "/r" (non-destructive) option, which cause the return value to be the result of the substitution. Behavior in list context depends on
the particular operator. See "Regexp Quote-Like Operators" for details and perlretut for examples using these operators.
If the right argument is an expression rather than a search pattern, substitution, or transliteration, it is interpreted as a search
pattern at run time. Note that this means that its contents will be interpolated twice, so
'\' =~ q'\';
is not ok, as the regex engine will end up trying to compile the pattern "", which it will consider a syntax error.
Binary "!~" is just like "=~" except the return value is negated in the logical sense.
Binary "!~" with a non-destructive substitution (s///r) or transliteration (y///r) is a syntax error.
Multiplicative Operators
Binary "*" multiplies two numbers.
Binary "/" divides two numbers.
Binary "%" is the modulo operator, which computes the division remainder of its first argument with respect to its second argument. Given
integer operands $a and $b: If $b is positive, then "$a % $b" is $a minus the largest multiple of $b less than or equal to $a. If $b is
negative, then "$a % $b" is $a minus the smallest multiple of $b that is not less than $a (that is, the result will be less than or equal
to zero). If the operands $a and $b are floating point values and the absolute value of $b (that is "abs($b)") is less than "(UV_MAX +
1)", only the integer portion of $a and $b will be used in the operation (Note: here "UV_MAX" means the maximum of the unsigned integer
type). If the absolute value of the right operand ("abs($b)") is greater than or equal to "(UV_MAX + 1)", "%" computes the floating-point
remainder $r in the equation "($r = $a - $i*$b)" where $i is a certain integer that makes $r have the same sign as the right operand $b
(not as the left operand $a like C function "fmod()") and the absolute value less than that of $b. Note that when "use integer" is in
scope, "%" gives you direct access to the modulo operator as implemented by your C compiler. This operator is not as well defined for
negative operands, but it will execute faster.
Binary "x" is the repetition operator. In scalar context or if the left operand is not enclosed in parentheses, it returns a string
consisting of the left operand repeated the number of times specified by the right operand. In list context, if the left operand is
enclosed in parentheses or is a list formed by "qw/STRING/", it repeats the list. If the right operand is zero or negative, it returns an
empty string or an empty list, depending on the context.
print '-' x 80; # print row of dashes
print " " x ($tab/8), ' ' x ($tab%8); # tab over
@ones = (1) x 80; # a list of 80 1's
@ones = (5) x @ones; # set all elements to 5
Additive Operators
Binary "+" returns the sum of two numbers.
Binary "-" returns the difference of two numbers.
Binary "." concatenates two strings.
Shift Operators
Binary "<<" returns the value of its left argument shifted left by the number of bits specified by the right argument. Arguments should be
integers. (See also "Integer Arithmetic".)
Binary ">>" returns the value of its left argument shifted right by the number of bits specified by the right argument. Arguments should
be integers. (See also "Integer Arithmetic".)
Note that both "<<" and ">>" in Perl are implemented directly using "<<" and ">>" in C. If "use integer" (see "Integer Arithmetic") is in
force then signed C integers are used, else unsigned C integers are used. Either way, the implementation isn't going to generate results
larger than the size of the integer type Perl was built with (32 bits or 64 bits).
The result of overflowing the range of the integers is undefined because it is undefined also in C. In other words, using 32-bit integers,
"1 << 32" is undefined. Shifting by a negative number of bits is also undefined.
If you get tired of being subject to your platform's native integers, the "use bigint" pragma neatly sidesteps the issue altogether:
print 20 << 20; # 20971520
print 20 << 40; # 5120 on 32-bit machines,
# 21990232555520 on 64-bit machines
use bigint;
print 20 << 100; # 25353012004564588029934064107520
Named Unary Operators
The various named unary operators are treated as functions with one argument, with optional parentheses.
If any list operator (print(), etc.) or any unary operator (chdir(), etc.) is followed by a left parenthesis as the next token, the
operator and arguments within parentheses are taken to be of highest precedence, just like a normal function call. For example, because
named unary operators are higher precedence than "||":
chdir $foo || die; # (chdir $foo) || die
chdir($foo) || die; # (chdir $foo) || die
chdir ($foo) || die; # (chdir $foo) || die
chdir +($foo) || die; # (chdir $foo) || die
but, because * is higher precedence than named operators:
chdir $foo * 20; # chdir ($foo * 20)
chdir($foo) * 20; # (chdir $foo) * 20
chdir ($foo) * 20; # (chdir $foo) * 20
chdir +($foo) * 20; # chdir ($foo * 20)
rand 10 * 20; # rand (10 * 20)
rand(10) * 20; # (rand 10) * 20
rand(10) * 20; # (rand 10) * 20
rand +(10) * 20; # rand (10 * 20)
Regarding precedence, the filetest operators, like "-f", "-M", etc. are treated like named unary operators, but they don't follow this
functional parenthesis rule. That means, for example, that "-f($file).".bak"" is equivalent to "-f "$file.bak"".
See also "Terms and List Operators (Leftward)".
Relational Operators
Perl operators that return true or false generally return values that can be safely used as numbers. For example, the relational operators
in this section and the equality operators in the next one return 1 for true and a special version of the defined empty string, "", which
counts as a zero but is exempt from warnings about improper numeric conversions, just as "0 but true" is.
Binary "<" returns true if the left argument is numerically less than the right argument.
Binary ">" returns true if the left argument is numerically greater than the right argument.
Binary "<=" returns true if the left argument is numerically less than or equal to the right argument.
Binary ">=" returns true if the left argument is numerically greater than or equal to the right argument.
Binary "lt" returns true if the left argument is stringwise less than the right argument.
Binary "gt" returns true if the left argument is stringwise greater than the right argument.
Binary "le" returns true if the left argument is stringwise less than or equal to the right argument.
Binary "ge" returns true if the left argument is stringwise greater than or equal to the right argument.
Equality Operators
Binary "==" returns true if the left argument is numerically equal to the right argument.
Binary "!=" returns true if the left argument is numerically not equal to the right argument.
Binary "<=>" returns -1, 0, or 1 depending on whether the left argument is numerically less than, equal to, or greater than the right
argument. If your platform supports NaNs (not-a-numbers) as numeric values, using them with "<=>" returns undef. NaN is not "<", "==",
">", "<=" or ">=" anything (even NaN), so those 5 return false. NaN != NaN returns true, as does NaN != anything else. If your platform
doesn't support NaNs then NaN is just a string with numeric value 0.
$ perl -le '$a = "NaN"; print "No NaN support here" if $a == $a'
$ perl -le '$a = "NaN"; print "NaN support here" if $a != $a'
(Note that the bigint, bigrat, and bignum pragmas all support "NaN".)
Binary "eq" returns true if the left argument is stringwise equal to the right argument.
Binary "ne" returns true if the left argument is stringwise not equal to the right argument.
Binary "cmp" returns -1, 0, or 1 depending on whether the left argument is stringwise less than, equal to, or greater than the right
argument.
Binary "~~" does a smartmatch between its arguments. Smart matching is described in the next section.
"lt", "le", "ge", "gt" and "cmp" use the collation (sort) order specified by the current locale if a legacy "use locale" (but not "use
locale ':not_characters'") is in effect. See perllocale. Do not mix these with Unicode, only with legacy binary encodings. The standard
Unicode::Collate and Unicode::Collate::Locale modules offer much more powerful solutions to collation issues.
Smartmatch Operator
First available in Perl 5.10.1 (the 5.10.0 version behaved differently), binary "~~" does a "smartmatch" between its arguments. This is
mostly used implicitly in the "when" construct described in perlsyn, although not all "when" clauses call the smartmatch operator. Unique
among all of Perl's operators, the smartmatch operator can recurse.
It is also unique in that all other Perl operators impose a context (usually string or numeric context) on their operands, autoconverting
those operands to those imposed contexts. In contrast, smartmatch infers contexts from the actual types of its operands and uses that type
information to select a suitable comparison mechanism.
The "~~" operator compares its operands "polymorphically", determining how to compare them according to their actual types (numeric,
string, array, hash, etc.) Like the equality operators with which it shares the same precedence, "~~" returns 1 for true and "" for false.
It is often best read aloud as "in", "inside of", or "is contained in", because the left operand is often looked for inside the right
operand. That makes the order of the operands to the smartmatch operand often opposite that of the regular match operator. In other
words, the "smaller" thing is usually placed in the left operand and the larger one in the right.
The behavior of a smartmatch depends on what type of things its arguments are, as determined by the following table. The first row of the
table whose types apply determines the smartmatch behavior. Because what actually happens is mostly determined by the type of the second
operand, the table is sorted on the right operand instead of on the left.
Left Right Description and pseudocode
===============================================================
Any undef check whether Any is undefined
like: !defined Any
Any Object invoke ~~ overloading on Object, or die
Right operand is an ARRAY:
Left Right Description and pseudocode
===============================================================
ARRAY1 ARRAY2 recurse on paired elements of ARRAY1 and ARRAY2[2]
like: (ARRAY1[0] ~~ ARRAY2[0])
&& (ARRAY1[1] ~~ ARRAY2[1]) && ...
HASH ARRAY any ARRAY elements exist as HASH keys
like: grep { exists HASH->{$_} } ARRAY
Regexp ARRAY any ARRAY elements pattern match Regexp
like: grep { /Regexp/ } ARRAY
undef ARRAY undef in ARRAY
like: grep { !defined } ARRAY
Any ARRAY smartmatch each ARRAY element[3]
like: grep { Any ~~ $_ } ARRAY
Right operand is a HASH:
Left Right Description and pseudocode
===============================================================
HASH1 HASH2 all same keys in both HASHes
like: keys HASH1 ==
grep { exists HASH2->{$_} } keys HASH1
ARRAY HASH any ARRAY elements exist as HASH keys
like: grep { exists HASH->{$_} } ARRAY
Regexp HASH any HASH keys pattern match Regexp
like: grep { /Regexp/ } keys HASH
undef HASH always false (undef can't be a key)
like: 0 == 1
Any HASH HASH key existence
like: exists HASH->{Any}
Right operand is CODE:
Left Right Description and pseudocode
===============================================================
ARRAY CODE sub returns true on all ARRAY elements[1]
like: !grep { !CODE->($_) } ARRAY
HASH CODE sub returns true on all HASH keys[1]
like: !grep { !CODE->($_) } keys HASH
Any CODE sub passed Any returns true
like: CODE->(Any)
Right operand is a Regexp:
Left Right Description and pseudocode
===============================================================
ARRAY Regexp any ARRAY elements match Regexp
like: grep { /Regexp/ } ARRAY
HASH Regexp any HASH keys match Regexp
like: grep { /Regexp/ } keys HASH
Any Regexp pattern match
like: Any =~ /Regexp/
Other:
Left Right Description and pseudocode
===============================================================
Object Any invoke ~~ overloading on Object,
or fall back to...
Any Num numeric equality
like: Any == Num
Num nummy[4] numeric equality
like: Num == nummy
undef Any check whether undefined
like: !defined(Any)
Any Any string equality
like: Any eq Any
Notes:
1. Empty hashes or arrays match.
2. That is, each element smartmatches the element of the same index in the other array.[3]
3. If a circular reference is found, fall back to referential equality.
4. Either an actual number, or a string that looks like one.
The smartmatch implicitly dereferences any non-blessed hash or array reference, so the "HASH" and "ARRAY" entries apply in those cases.
For blessed references, the "Object" entries apply. Smartmatches involving hashes only consider hash keys, never hash values.
The "like" code entry is not always an exact rendition. For example, the smartmatch operator short-circuits whenever possible, but "grep"
does not. Also, "grep" in scalar context returns the number of matches, but "~~" returns only true or false.
Unlike most operators, the smartmatch operator knows to treat "undef" specially:
use v5.10.1;
@array = (1, 2, 3, undef, 4, 5);
say "some elements undefined" if undef ~~ @array;
Each operand is considered in a modified scalar context, the modification being that array and hash variables are passed by reference to
the operator, which implicitly dereferences them. Both elements of each pair are the same:
use v5.10.1;
my %hash = (red => 1, blue => 2, green => 3,
orange => 4, yellow => 5, purple => 6,
black => 7, grey => 8, white => 9);
my @array = qw(red blue green);
say "some array elements in hash keys" if @array ~~ %hash;
say "some array elements in hash keys" if @array ~~ \%hash;
say "red in array" if "red" ~~ @array;
say "red in array" if "red" ~~ @array;
say "some keys end in e" if /e$/ ~~ %hash;
say "some keys end in e" if /e$/ ~~ \%hash;
Two arrays smartmatch if each element in the first array smartmatches (that is, is "in") the corresponding element in the second array,
recursively.
use v5.10.1;
my @little = qw(red blue green);
my @bigger = ("red", "blue", [ "orange", "green" ] );
if (@little ~~ @bigger) { # true!
say "little is contained in bigger";
}
Because the smartmatch operator recurses on nested arrays, this will still report that "red" is in the array.
use v5.10.1;
my @array = qw(red blue green);
my $nested_array = [[[[[[[ @array ]]]]]]];
say "red in array" if "red" ~~ $nested_array;
If two arrays smartmatch each other, then they are deep copies of each others' values, as this example reports:
use v5.12.0;
my @a = (0, 1, 2, [3, [4, 5], 6], 7);
my @b = (0, 1, 2, [3, [4, 5], 6], 7);
if (@a ~~ @b && @b ~~ @a) {
say "a and b are deep copies of each other";
}
elsif (@a ~~ @b) {
say "a smartmatches in b";
}
elsif (@b ~~ @a) {
say "b smartmatches in a";
}
else {
say "a and b don't smartmatch each other at all";
}
If you were to set "$b[3] = 4", then instead of reporting that "a and b are deep copies of each other", it now reports that "b smartmatches
in a". That because the corresponding position in @a contains an array that (eventually) has a 4 in it.
Smartmatching one hash against another reports whether both contain the same keys, no more and no less. This could be used to see whether
two records have the same field names, without caring what values those fields might have. For example:
use v5.10.1;
sub make_dogtag {
state $REQUIRED_FIELDS = { name=>1, rank=>1, serial_num=>1 };
my ($class, $init_fields) = @_;
die "Must supply (only) name, rank, and serial number"
unless $init_fields ~~ $REQUIRED_FIELDS;
...
}
or, if other non-required fields are allowed, use ARRAY ~~ HASH:
use v5.10.1;
sub make_dogtag {
state $REQUIRED_FIELDS = { name=>1, rank=>1, serial_num=>1 };
my ($class, $init_fields) = @_;
die "Must supply (at least) name, rank, and serial number"
unless [keys %{$init_fields}] ~~ $REQUIRED_FIELDS;
...
}
The smartmatch operator is most often used as the implicit operator of a "when" clause. See the section on "Switch Statements" in perlsyn.
Smartmatching of Objects
To avoid relying on an object's underlying representation, if the smartmatch's right operand is an object that doesn't overload "~~", it
raises the exception ""Smartmatching a non-overloaded object breaks encapsulation"". That's because one has no business digging around to
see whether something is "in" an object. These are all illegal on objects without a "~~" overload:
%hash ~~ $object
42 ~~ $object
"fred" ~~ $object
However, you can change the way an object is smartmatched by overloading the "~~" operator. This is allowed to extend the usual smartmatch
semantics. For objects that do have an "~~" overload, see overload.
Using an object as the left operand is allowed, although not very useful. Smartmatching rules take precedence over overloading, so even if
the object in the left operand has smartmatch overloading, this will be ignored. A left operand that is a non-overloaded object falls back
on a string or numeric comparison of whatever the "ref" operator returns. That means that
$object ~~ X
does not invoke the overload method with "X" as an argument. Instead the above table is consulted as normal, and based on the type of "X",
overloading may or may not be invoked. For simple strings or numbers, in becomes equivalent to this:
$object ~~ $number ref($object) == $number
$object ~~ $string ref($object) eq $string
For example, this reports that the handle smells IOish (but please don't really do this!):
use IO::Handle;
my $fh = IO::Handle->new();
if ($fh ~~ /IO/) {
say "handle smells IOish";
}
That's because it treats $fh as a string like "IO::Handle=GLOB(0x8039e0)", then pattern matches against that.
Bitwise And
Binary "&" returns its operands ANDed together bit by bit. (See also "Integer Arithmetic" and "Bitwise String Operators".)
Note that "&" has lower priority than relational operators, so for example the parentheses are essential in a test like
print "Even
" if ($x & 1) == 0;
Bitwise Or and Exclusive Or
Binary "|" returns its operands ORed together bit by bit. (See also "Integer Arithmetic" and "Bitwise String Operators".)
Binary "^" returns its operands XORed together bit by bit. (See also "Integer Arithmetic" and "Bitwise String Operators".)
Note that "|" and "^" have lower priority than relational operators, so for example the brackets are essential in a test like
print "false
" if (8 | 2) != 10;
C-style Logical And
Binary "&&" performs a short-circuit logical AND operation. That is, if the left operand is false, the right operand is not even
evaluated. Scalar or list context propagates down to the right operand if it is evaluated.
C-style Logical Or
Binary "||" performs a short-circuit logical OR operation. That is, if the left operand is true, the right operand is not even evaluated.
Scalar or list context propagates down to the right operand if it is evaluated.
Logical Defined-Or
Although it has no direct equivalent in C, Perl's "//" operator is related to its C-style or. In fact, it's exactly the same as "||",
except that it tests the left hand side's definedness instead of its truth. Thus, "EXPR1 // EXPR2" returns the value of "EXPR1" if it's
defined, otherwise, the value of "EXPR2" is returned. ("EXPR1" is evaluated in scalar context, "EXPR2" in the context of "//" itself).
Usually, this is the same result as "defined(EXPR1) ? EXPR1 : EXPR2" (except that the ternary-operator form can be used as a lvalue, while
"EXPR1 // EXPR2" cannot). This is very useful for providing default values for variables. If you actually want to test if at least one of
$a and $b is defined, use "defined($a // $b)".
The "||", "//" and "&&" operators return the last value evaluated (unlike C's "||" and "&&", which return 0 or 1). Thus, a reasonably
portable way to find out the home directory might be:
$home = $ENV{HOME}
// $ENV{LOGDIR}
// (getpwuid($<))[7]
// die "You're homeless!
";
In particular, this means that you shouldn't use this for selecting between two aggregates for assignment:
@a = @b || @c; # this is wrong
@a = scalar(@b) || @c; # really meant this
@a = @b ? @b : @c; # this works fine, though
As alternatives to "&&" and "||" when used for control flow, Perl provides the "and" and "or" operators (see below). The short-circuit
behavior is identical. The precedence of "and" and "or" is much lower, however, so that you can safely use them after a list operator
without the need for parentheses:
unlink "alpha", "beta", "gamma"
or gripe(), next LINE;
With the C-style operators that would have been written like this:
unlink("alpha", "beta", "gamma")
|| (gripe(), next LINE);
It would be even more readable to write that this way:
unless(unlink("alpha", "beta", "gamma")) {
gripe();
next LINE;
}
Using "or" for assignment is unlikely to do what you want; see below.
Range Operators
Binary ".." is the range operator, which is really two different operators depending on the context. In list context, it returns a list of
values counting (up by ones) from the left value to the right value. If the left value is greater than the right value then it returns the
empty list. The range operator is useful for writing "foreach (1..10)" loops and for doing slice operations on arrays. In the current
implementation, no temporary array is created when the range operator is used as the expression in "foreach" loops, but older versions of
Perl might burn a lot of memory when you write something like this:
for (1 .. 1_000_000) {
# code
}
The range operator also works on strings, using the magical auto-increment, see below.
In scalar context, ".." returns a boolean value. The operator is bistable, like a flip-flop, and emulates the line-range (comma) operator
of sed, awk, and various editors. Each ".." operator maintains its own boolean state, even across calls to a subroutine that contains it.
It is false as long as its left operand is false. Once the left operand is true, the range operator stays true until the right operand is
true, AFTER which the range operator becomes false again. It doesn't become false till the next time the range operator is evaluated. It
can test the right operand and become false on the same evaluation it became true (as in awk), but it still returns true once. If you don't
want it to test the right operand until the next evaluation, as in sed, just use three dots ("...") instead of two. In all other regards,
"..." behaves just like ".." does.
The right operand is not evaluated while the operator is in the "false" state, and the left operand is not evaluated while the operator is
in the "true" state. The precedence is a little lower than || and &&. The value returned is either the empty string for false, or a
sequence number (beginning with 1) for true. The sequence number is reset for each range encountered. The final sequence number in a
range has the string "E0" appended to it, which doesn't affect its numeric value, but gives you something to search for if you want to
exclude the endpoint. You can exclude the beginning point by waiting for the sequence number to be greater than 1.
If either operand of scalar ".." is a constant expression, that operand is considered true if it is equal ("==") to the current input line
number (the $. variable).
To be pedantic, the comparison is actually "int(EXPR) == int(EXPR)", but that is only an issue if you use a floating point expression; when
implicitly using $. as described in the previous paragraph, the comparison is "int(EXPR) == int($.)" which is only an issue when $. is set
to a floating point value and you are not reading from a file. Furthermore, "span" .. "spat" or "2.18 .. 3.14" will not do what you want
in scalar context because each of the operands are evaluated using their integer representation.
Examples:
As a scalar operator:
if (101 .. 200) { print; } # print 2nd hundred lines, short for
# if ($. == 101 .. $. == 200) { print; }
next LINE if (1 .. /^$/); # skip header lines, short for
# next LINE if ($. == 1 .. /^$/);
# (typically in a loop labeled LINE)
s/^/> / if (/^$/ .. eof()); # quote body
# parse mail messages
while (<>) {
$in_header = 1 .. /^$/;
$in_body = /^$/ .. eof;
if ($in_header) {
# do something
} else { # in body
# do something else
}
} continue {
close ARGV if eof; # reset $. each file
}
Here's a simple example to illustrate the difference between the two range operators:
@lines = (" - Foo",
"01 - Bar",
"1 - Baz",
" - Quux");
foreach (@lines) {
if (/0/ .. /1/) {
print "$_
";
}
}
This program will print only the line containing "Bar". If the range operator is changed to "...", it will also print the "Baz" line.
And now some examples as a list operator:
for (101 .. 200) { print } # print $_ 100 times
@foo = @foo[0 .. $#foo]; # an expensive no-op
@foo = @foo[$#foo-4 .. $#foo]; # slice last 5 items
The range operator (in list context) makes use of the magical auto-increment algorithm if the operands are strings. You can say
@alphabet = ("A" .. "Z");
to get all normal letters of the English alphabet, or
$hexdigit = (0 .. 9, "a" .. "f")[$num & 15];
to get a hexadecimal digit, or
@z2 = ("01" .. "31");
print $z2[$mday];
to get dates with leading zeros.
If the final value specified is not in the sequence that the magical increment would produce, the sequence goes until the next value would
be longer than the final value specified.
If the initial value specified isn't part of a magical increment sequence (that is, a non-empty string matching "/^[a-zA-Z]*[0-9]*z/"),
only the initial value will be returned. So the following will only return an alpha:
use charnames "greek";
my @greek_small = ("N{alpha}" .. "N{omega}");
To get the 25 traditional lowercase Greek letters, including both sigmas, you could use this instead:
use charnames "greek";
my @greek_small = map { chr } ( ord("N{alpha}")
..
ord("N{omega}")
);
However, because there are many other lowercase Greek characters than just those, to match lowercase Greek characters in a regular
expression, you would use the pattern "/(?:(?=p{Greek})p{Lower})+/".
Because each operand is evaluated in integer form, "2.18 .. 3.14" will return two elements in list context.
@list = (2.18 .. 3.14); # same as @list = (2 .. 3);
Conditional Operator
Ternary "?:" is the conditional operator, just as in C. It works much like an if-then-else. If the argument before the ? is true, the
argument before the : is returned, otherwise the argument after the : is returned. For example:
printf "I have %d dog%s.
", $n,
($n == 1) ? "" : "s";
Scalar or list context propagates downward into the 2nd or 3rd argument, whichever is selected.
$a = $ok ? $b : $c; # get a scalar
@a = $ok ? @b : @c; # get an array
$a = $ok ? @b : @c; # oops, that's just a count!
The operator may be assigned to if both the 2nd and 3rd arguments are legal lvalues (meaning that you can assign to them):
($a_or_b ? $a : $b) = $c;
Because this operator produces an assignable result, using assignments without parentheses will get you in trouble. For example, this:
$a % 2 ? $a += 10 : $a += 2
Really means this:
(($a % 2) ? ($a += 10) : $a) += 2
Rather than this:
($a % 2) ? ($a += 10) : ($a += 2)
That should probably be written more simply as:
$a += ($a % 2) ? 10 : 2;
Assignment Operators
"=" is the ordinary assignment operator.
Assignment operators work as in C. That is,
$a += 2;
is equivalent to
$a = $a + 2;
although without duplicating any side effects that dereferencing the lvalue might trigger, such as from tie(). Other assignment operators
work similarly. The following are recognized:
**= += *= &= <<= &&=
-= /= |= >>= ||=
.= %= ^= //=
x=
Although these are grouped by family, they all have the precedence of assignment.
Unlike in C, the scalar assignment operator produces a valid lvalue. Modifying an assignment is equivalent to doing the assignment and
then modifying the variable that was assigned to. This is useful for modifying a copy of something, like this:
($tmp = $global) =~ tr/13579/24680/;
Although as of 5.14, that can be also be accomplished this way:
use v5.14;
$tmp = ($global =~ tr/13579/24680/r);
Likewise,
($a += 2) *= 3;
is equivalent to
$a += 2;
$a *= 3;
Similarly, a list assignment in list context produces the list of lvalues assigned to, and a list assignment in scalar context returns the
number of elements produced by the expression on the right hand side of the assignment.
Comma Operator
Binary "," is the comma operator. In scalar context it evaluates its left argument, throws that value away, then evaluates its right
argument and returns that value. This is just like C's comma operator.
In list context, it's just the list argument separator, and inserts both its arguments into the list. These arguments are also evaluated
from left to right.
The "=>" operator is a synonym for the comma except that it causes a word on its left to be interpreted as a string if it begins with a
letter or underscore and is composed only of letters, digits and underscores. This includes operands that might otherwise be interpreted
as operators, constants, single number v-strings or function calls. If in doubt about this behavior, the left operand can be quoted
explicitly.
Otherwise, the "=>" operator behaves exactly as the comma operator or list argument separator, according to context.
For example:
use constant FOO => "something";
my %h = ( FOO => 23 );
is equivalent to:
my %h = ("FOO", 23);
It is NOT:
my %h = ("something", 23);
The "=>" operator is helpful in documenting the correspondence between keys and values in hashes, and other paired elements in lists.
%hash = ( $key => $value );
login( $username => $password );
The special quoting behavior ignores precedence, and hence may apply to part of the left operand:
print time.shift => "bbb";
That example prints something like "1314363215shiftbbb", because the "=>" implicitly quotes the "shift" immediately on its left, ignoring
the fact that "time.shift" is the entire left operand.
List Operators (Rightward)
On the right side of a list operator, the comma has very low precedence, such that it controls all comma-separated expressions found there.
The only operators with lower precedence are the logical operators "and", "or", and "not", which may be used to evaluate calls to list
operators without the need for parentheses:
open HANDLE, "< :utf8", "filename" or die "Can't open: $!
";
However, some people find that code harder to read than writing it with parentheses:
open(HANDLE, "< :utf8", "filename") or die "Can't open: $!
";
in which case you might as well just use the more customary "||" operator:
open(HANDLE, "< :utf8", "filename") || die "Can't open: $!
";
See also discussion of list operators in "Terms and List Operators (Leftward)".
Logical Not
Unary "not" returns the logical negation of the expression to its right. It's the equivalent of "!" except for the very low precedence.
Logical And
Binary "and" returns the logical conjunction of the two surrounding expressions. It's equivalent to "&&" except for the very low
precedence. This means that it short-circuits: the right expression is evaluated only if the left expression is true.
Logical or and Exclusive Or
Binary "or" returns the logical disjunction of the two surrounding expressions. It's equivalent to "||" except for the very low
precedence. This makes it useful for control flow:
print FH $data or die "Can't write to FH: $!";
This means that it short-circuits: the right expression is evaluated only if the left expression is false. Due to its precedence, you must
be careful to avoid using it as replacement for the "||" operator. It usually works out better for flow control than in assignments:
$a = $b or $c; # bug: this is wrong
($a = $b) or $c; # really means this
$a = $b || $c; # better written this way
However, when it's a list-context assignment and you're trying to use "||" for control flow, you probably need "or" so that the assignment
takes higher precedence.
@info = stat($file) || die; # oops, scalar sense of stat!
@info = stat($file) or die; # better, now @info gets its due
Then again, you could always use parentheses.
Binary "xor" returns the exclusive-OR of the two surrounding expressions. It cannot short-circuit (of course).
There is no low precedence operator for defined-OR.
C Operators Missing From Perl
Here is what C has that Perl doesn't:
unary & Address-of operator. (But see the "" operator for taking a reference.)
unary * Dereference-address operator. (Perl's prefix dereferencing operators are typed: $, @, %, and &.)
(TYPE) Type-casting operator.
Quote and Quote-like Operators
While we usually think of quotes as literal values, in Perl they function as operators, providing various kinds of interpolating and
pattern matching capabilities. Perl provides customary quote characters for these behaviors, but also provides a way for you to choose
your quote character for any of them. In the following table, a "{}" represents any pair of delimiters you choose.
Customary Generic Meaning Interpolates
'' q{} Literal no
"" qq{} Literal yes
`` qx{} Command yes*
qw{} Word list no
// m{} Pattern match yes*
qr{} Pattern yes*
s{}{} Substitution yes*
tr{}{} Transliteration no (but see below)
y{}{} Transliteration no (but see below)
<<EOF here-doc yes*
* unless the delimiter is ''.
Non-bracketing delimiters use the same character fore and aft, but the four sorts of ASCII brackets (round, angle, square, curly) all nest,
which means that
q{foo{bar}baz}
is the same as
'foo{bar}baz'
Note, however, that this does not always work for quoting Perl code:
$s = q{ if($a eq "}") ... }; # WRONG
is a syntax error. The "Text::Balanced" module (standard as of v5.8, and from CPAN before then) is able to do this properly.
There can be whitespace between the operator and the quoting characters, except when "#" is being used as the quoting character. "q#foo#"
is parsed as the string "foo", while "q #foo#" is the operator "q" followed by a comment. Its argument will be taken from the next line.
This allows you to write:
s {foo} # Replace foo
{bar} # with bar.
The following escape sequences are available in constructs that interpolate, and in transliterations:
Sequence Note Description
tab (HT, TAB)
newline (NL)
return (CR)
f form feed (FF)
backspace (BS)
a alarm (bell) (BEL)
e escape (ESC)
x{263A} [1,8] hex char (example: SMILEY)
x1b [2,8] restricted range hex char (example: ESC)
N{name} [3] named Unicode character or character sequence
N{U+263D} [4,8] Unicode character (example: FIRST QUARTER MOON)
c[ [5] control char (example: chr(27))
o{23072} [6,8] octal char (example: SMILEY)
33 [7,8] restricted range octal char (example: ESC)
[1] The result is the character specified by the hexadecimal number between the braces. See "[8]" below for details on which character.
Only hexadecimal digits are valid between the braces. If an invalid character is encountered, a warning will be issued and the invalid
character and all subsequent characters (valid or invalid) within the braces will be discarded.
If there are no valid digits between the braces, the generated character is the NULL character ("x{00}"). However, an explicit empty
brace ("x{}") will not cause a warning (currently).
[2] The result is the character specified by the hexadecimal number in the range 0x00 to 0xFF. See "[8]" below for details on which
character.
Only hexadecimal digits are valid following "x". When "x" is followed by fewer than two valid digits, any valid digits will be zero-
padded. This means that "x7" will be interpreted as "x07", and a lone <x> will be interpreted as "x00". Except at the end of a
string, having fewer than two valid digits will result in a warning. Note that although the warning says the illegal character is
ignored, it is only ignored as part of the escape and will still be used as the subsequent character in the string. For example:
Original Result Warns?
"x7" "x07" no
"x" "x00" no
"x7q" "x07q" yes
"xq" "x00q" yes
[3] The result is the Unicode character or character sequence given by name. See charnames.
[4] "N{U+hexadecimal number}" means the Unicode character whose Unicode code point is hexadecimal number.
[5] The character following "c" is mapped to some other character as shown in the table:
Sequence Value
c@ chr(0)
cA chr(1)
ca chr(1)
cB chr(2)
cb chr(2)
...
cZ chr(26)
cz chr(26)
c[ chr(27)
c] chr(29)
c^ chr(30)
c? chr(127)
In other words, it's the character whose code point has had 64 xor'd with its uppercase. "c?" is DELETE because "ord("@") ^ 64" is
127, and "c@" is NULL because the ord of "@" is 64, so xor'ing 64 itself produces 0.
Also, "cX" yields " chr(28) . "X"" for any X, but cannot come at the end of a string, because the backslash would be parsed as
escaping the end quote.
On ASCII platforms, the resulting characters from the list above are the complete set of ASCII controls. This isn't the case on EBCDIC
platforms; see "OPERATOR DIFFERENCES" in perlebcdic for the complete list of what these sequences mean on both ASCII and EBCDIC
platforms.
Use of any other character following the "c" besides those listed above is discouraged, and some are deprecated with the intention of
removing those in a later Perl version. What happens for any of these other characters currently though, is that the value is derived
by xor'ing with the seventh bit, which is 64.
To get platform independent controls, you can use "N{...}".
[6] The result is the character specified by the octal number between the braces. See "[8]" below for details on which character.
If a character that isn't an octal digit is encountered, a warning is raised, and the value is based on the octal digits before it,
discarding it and all following characters up to the closing brace. It is a fatal error if there are no octal digits at all.
[7] The result is the character specified by the three-digit octal number in the range 000 to 777 (but best to not use above 077, see next
paragraph). See "[8]" below for details on which character.
Some contexts allow 2 or even 1 digit, but any usage without exactly three digits, the first being a zero, may give unintended results.
(For example, in a regular expression it may be confused with a backreference; see "Octal escapes" in perlrebackslash.) Starting in
Perl 5.14, you may use "o{}" instead, which avoids all these problems. Otherwise, it is best to use this construct only for ordinals
"