Perl Wikibook
Perl Wikibook
org/wiki/Perl/Print_version
Perl/Print version
From Wikibooks, the open-content textbooks collection
Getting Started
This book assumes that you know absolutely nothing about programming at all and
that Perl is your first language. However, basic operations such as making text files
are outside of the realm of this tutorial.
Obtaining Perl
To find out if you already have Perl installed on your computer, go into the command
line and type:
perl -v
This will display which version of Perl you have installed on your computer, if it is
installed.
The easiest way to install Perl on Windows may be to use the ActiveState
(http://activestate.com/Products/ActivePerl/?_x=1) distribution, which is downloadable
as a native windows installer.
Most Unix-like operating systems will include Perl by default, and Linux Standard
Base mandates that all compliant Linuxes ship with Perl installed. However, if for
some reason you don't have perl, you can explore the options available to you at the
main Perl download page (http://www.perl.com/download.csp) , which will provide
links to source and binaries.
Writing programs
A Sample Program
Perl is an interpreted language, this means you will always need the Perl interpreter
which will compile and execute your program each time you run it. Instead of
compiling your program into bytecode like in Pascal or C++ and then executing it you
can simply copy your program's source code to a different computer (that has the perl
interpreter) and run it.
For our first example, run your favorite text editor, and type something like this:
#!/usr/bin/perl
use strict;
use warnings;
If you don't understand this yet, don't worry, this will be explained in more depth
later.
Save the file as myprog.pl and you have a perl program ready to run.
Running programs
Windows
From a windows command-line interface, you can run the program thusly:
Note: You may have to specify the full path to your program unless you are running
the command prompt in that directory.
UNIX-like Systems
You can run a perl program by running perl itself, and telling the shell the name of
the file:
perl myprog.pl
Usually, perl programs are made executable on their own. This involves two changes to
the sample program. First, edit it and put the following shebang line at the top of the
file:
#!/usr/bin/perl
chmod +x myprog.pl
Your program is now executable and ready to run, just like any other file. To execute,
type:
./myprog.pl
By convention, .pl identifies a perl script, and .pm a perl library. The .pl file extension
isn't needed for either of these examples; it's just a useful way of identifying files. The
only time the convention should be violated is if the program is to be installed outside
of the current working directory, and there runs a chance you might want to some day
rewrite them in a different language.
#!/usr/bin/perl
#!/usr/bin/perl
On Unix systems this tells the Operating System to execute this file with the
program located at /usr/bin/perl. This is the default Unix location for the perl
interpreter, on Windows #! C:\Perl\bin\perl.exe should be used instead.
Shebang: A line at the start of a file that gives instructions to the operating
system.
# Outputs ...
This line is a comment - it is ignored by the perl interpreter, but is very useful. It
helps you to debug and maintain your code, and explain it to other programmers.
The print instruction writes whatever follows it to the screen. The \n at the end of
the string puts a new line to the screen. The semicolon at the end of the line tells
the perl interpreter that the instruction is finished; you must put a semicolon at
the end of every instruction in Perl code.
Exercises
Change the program so that after greeting you, it asks how you are doing, on
the next line. The output should look like this:
Hello your_name!
How are you?
Experiment with the \n character, what happens when you take it away?
What happens if you put two in a row?
Remember: if you add another print instruction you will need to put a semicolon
after it.
Strings
Any sequence of characters put together as one unit, is a string. So, the word the is a
string. This sentence is a string. Even this entire paragraph is a string. In fact, you
could consider the text of this entire book as one string.
Strings can be of any length and can contain any characters, numbers, punctuation,
special characters (like ! #, and %), and even characters in natural languages besides
English. In addition, a string can contain special whitespace formatting characters like
newline, tab, and the bell character. We will discuss special characters more later on.
For now, we will begin our consideration of strings by considering how to insert literal
strings into a Perl program.
To begin our discussion of strings in Perl, we will consider how to work with string
literals in Perl. The word literal here refers to the fact that these are used when you
want to type a string directly to Perl. This can be contrasted with storing a string in a
variable.
Any string literal can be used as an expression. We will find this useful when we want
to store string literals in variables. However, for now, we will simply consider the
different types of string literals that one can make in Perl. Later, we will learn how to
assign these string literals to variables in the Scalar Variables section.
Single quotes can be thought of as literal strings. In the previous examples, you many
have noticed that variable names were included inside the strings with double quotes.
When the results were printed, the value of the variable was placed in the printed line,
not the name of the variable. If single quote marks were used, the actual variable
name would have been printed because nearly all special characters that might be
interpreted differently are taken at face value when using single quotes.
my $name = "Fred";
print "Hello $name \n";
print 'Hello $name';
You should see "Hello Fred" on the first line and "Hello $name" on the second.
There are two characters in single quoted strings that do not always represent
themselves. This is due to necessity, since single-quoted strings start and end with the
' character. We need a way to express inside a single-quoted string that we want the
string to contain a ' character.
The solution to this problem is to preceded any ' characters we actually want to
appear in the string itself with the backslash (\ character). Thus we have strings like
this:
We have in this example a string with 7 characters exactly. Namely, this is the string:
xxx'xxx. It can be difficult at first to become accustomed to the idea that two characters
in the input to Perl actually produce only one character in the string itself. (C
programmers are already probably used to this idea.) However, just keep in mind the
rules and you will probably get used to them quickly.
Since we have used the \ character to do something special with the ' character, we
must now worry about the special cases for the backslash character itself. When we
see a \ character in a single-quoted string, we must carefully consider what will
happen.
The sequence \' yields the character ' in the actual string. (This is the exception
we already discussed above).
The sequence \\ yields the character \ in the actual string. In other words, two
backslashes right next to each other actually yield only one backslash.
The following examples exemplify the various exceptions, and use them properly:
'I don\'t think so.'; # Note the ' inside is escaped with \
'Need a \\ (backslash) or \?'; # The \\ gives us \, as does \
'You can do this: \\'; # A single backslash at the end
'Three \\\'s: "\\\\\"'; # There are three \ chars between ""
In the last example, note that the resulting string is Three \'s: "\\\". If you can follow
that example, you have definitely mastered how single-quoted strings work!
Note that there is no rule against having a single-quoted string span several lines.
When you do this, the string has newline characters embedded in it.
A newline character is a special ASCII character that indicates that a new line should
be started. In a text editor, or when printing output to the screen, this usually
indicates that the cursor should move from the end of the current line to the first
position on the line following it.
Since Perl permits the placement of these newline characters directly into single
quoted strings, we are permitted to do the following:
'Time to
start anew.'; # Represents the single string composed of:
# 'Time to' followed by a newline, followed by
# 'start anew.'
This string has a total of twenty characters. The first seven are Time to. The next
character following that is a newline. Then, the eleven characters, start anew. follow.
Note again that this is one string, with a newline as its eighth character.
Further, note that we are not permitted to put a comment in the middle of the string,
even though we are usually allowed to place a # anywhere on the line and have the rest
of the line be a comment. We cannot do this here, since we have yet to terminate our
single-quoted string with a ', and thus, any # character and comment following it
would actually become part of the single-quoted string! Remember that single-quotes
strings are delimited by ' at the beginning, and ' at the end, and everything in
between is considered part of the string, included newlines, # characters and anything
else.
Sometimes, when you have invalid string literals such as in the example above, the
error message that Perl gives is not particularly intuitive. However, when you see error
messages such as:
It is often an indication that you have runaway or invalid strings. Keep an eye out for
these problems. Chances are, you will forget and violate one of the rules for single-
quoted strings eventually, and then need to determine why you are unable to run your
Perl program.
#!/usr/bin/perl
use strict;
use warnings;
you probably noticed that nothing of interest happens. Perl gladly runs this program,
but it produces no output.
Thus, to begin to work with strings in Perl beyond simple hypothetical considerations,
we need a way to have Perl display our strings for us. The canonical way of
accomplishing this in Perl is to use the print function.
The print function in Perl can be used in a variety of ways. The simplest form is to use
the statement print STRING;, where STRING is any valid Perl string.
So, to reconsider our examples, instead of simply listing the strings, we could instead
print each one out:
#!/usr/bin/perl
use strict;
use warnings;
This program will produce output. When run, the output goes to what is called the
standard output. This is usually the terminal, console or window in which you run the
Perl program. In the case of the program above, the output to the standard output is
as follows:
Note that a newline is required to break up the lines. Thus, you need to put a newline
at the end of every valid string if you want your string to be the last thing on that line
in the output.
Note that it is particularly important to put a newline on the end of the last string of
your output. If you do not, often times, the command prompt for the command
interpreter that you are using may run together with your last line of output, and this
can be very disorienting. So, always remember to place a newline at the end of each
line, particularly on your last line of output.
Finally, you may have noticed that formatting your code with newlines in the middle of
single-quoted strings hurts readability. Since you are inside a single-quoted string, you
cannot change the format of the continued lines within the print statement, nor put
comments at the ends of those lines because that would insert data into your single-
quoted strings. To handle newlines more elegantly, you should use double-quoted
strings, which are the topic of the next section.
Interpolation is a special process whereby certain special strings written in ASCII are
replaced by something different. In Single-quoted strings section, we noted that
certain sequences in single-quoted strings (namely, \\ and \') were treated differently
- these are called backslash escape sequences. This is very similar to what happens
with interpolation.
String Interpolated As
\\ an actual, single backslash character
\$ a single $ character
\@ a single @ character
\" a single double-quote character
\t tab
\n newline
\r hard return
\f form feed
\b backspace
\a alarm (bell)
\e escape
\056 character represented by octal value, 056 (same as.)
\x2E character represented by hexadecimal value, 2E (same as .)
As you may have noticed in the previous chapter, you can put the name of a variable
within a string with its leading dollar sign. This form of interpolation replaces the
name of the variable in the string with the content of the variable.
Examples of Interpolation
#!/usr/bin/perl
use strict;
use warnings;
This program, when run, produces the following output on the screen:
A backslash: \
Tab follows: over here
Ring!
Please pay [email protected] $20.
In addition, when running, you should hear the computer beep. That is the output of
the \a character, which you cannot see on the screen. However, you should be able to
hear it.
Notice that the \n character ends a line. \n should always be used to end a line. Those
students familiar with the C language will be used to using this sequence to mean
newline. When writing Perl, the word newline and the \n character are roughly
synonymous.
String Operators
Perl uses the . operator to concatenate or connect two strings together, like this:
If you want to make the string have a space between Hello and World you could write
it like this:
Or like this:
The x Operator
This is called the string repetition operator and is used to repeat a string. All you have
to do is put a string on the left side of the x and a number on the right side. Like this:
If you wish to insert a line break after each output of the string, use:
"Hello\n" x 5
Exercises
Remember to take some time to play with single and double quoted strings, the
more practice you get, the better you will be.
Numbers
Numbers in Perl do not have to be enclosed in any kind of punctuation; they can be
written as straight numbers.
Integers
Integers are all whole numbers and their negatives (and 0): {... -3, -2, -1, 0, 1, 2, 3
...}.
Non-decimal Numbers
I'll dwell on this topic for a little longer than the other types of numbers. In Perl you
can not only specify decimal numbers, but also numbers in hex, octal, and binary. If
you are not familiar with how these systems work, you can try these Wikipedia
articles:
Hexadecimal
Octal
Binary
In Perl you have to specify when you are going to write a non-decimal number. Binary
numbers start with an 0b, so here are some possible binary numbers:
0b101011101
0b10
Octal numbers start with 0 ("zero"), so here are some possible octal numbers:
015462
062657
012
Hexadecimal numbers start with 0x, so here are some possible hexadecimal numbers:
0xF17A
0xFFFF
Number Operators
Just like strings, numbers have operators. These operators are quite obvious so I'll just
give a quick example of each one.
These operators are pretty obvious, but here are some examples:
100 - 1 # That's 99
100 / 2 # That's 50
Now let's look at one more operator that's a little less obvious.
The ** Operator
4
2**4 # That's 16, same as 2
9
4**3**2 # that's 4**(3**2), or 4 , or 262144
Extra!
The modulus operator (%) can be used to find the remainder
when dividing two numbers.
If that doesn't make sense now, that's fine, it's not that
important.
Exercises
In Perl, there are five types of variables: $calars, @rrays, %hashes, &subroutines, and
*typeglobs.
Simple variables
Variables, called scalars, are identified with the $ character, and can contain nearly
any type of data. For example:
$my_variable = 3; # integers
$my_variable = 3.1415926; # floating point
$my_variable = 3.402823669209384634633e+38; # exponents
$my_variable = $another_variable + 1; # mathematical operation
$my_variable = 'Can contain text'; # strings
$my_variable = \$another_variable; # scalar reference
$my_variable = \@array_variable; # array reference
print $my_variable;
Arrays
Arrays in Perl use the @ character to identify themselves.
However, when you deal with just one element of the array (using square brackets so
it's not confused), then that element of the array is considered a scalar which takes
the $ sigil:
$my_array[0] = 1;
$my_array[$MyNumber] = 1;
Associative arrays
Associative arrays, or "hashes," use the % character to identify themselves.
When using the => the left side is assumed to be quoted. For long lists, lining up keys
and values aids readability.
%my_hash = (
key1 => 'value1',
key2 => 'value2',
key3 => 'value3',
);
However, when you deal with just one element of the array (using braces), then that
element of the array is considered a scalar and takes the $ identifier:
$my_hash{'key1'} = 'value1';
Associative arrays are useful when you want to refer to the items by their names.
Subroutines
Subroutines are defined by the sub function, and can be called using &, though it is not
recommended. Here's an example program that calculates the Fibonnaci sequence:
sub fib {
my $n = shift;
return $n if $n < 2;
return fib( $n - 1 ) + fib( $n - 2 );
}
print fib(14);
The if statement is the primary conditional structure in Perl. The syntax is as follows:
if (boolean expression) {
expression
}
If the boolean expression evaluates to true, the statements between the two braces will
be executed. The braces around statements are mandatory, even if there is only one
statement (unlike C or Java).
if ( $x == 20 ) { print "hello"; }
and
print "hello" if ( $x == 20 );
The boolean expression conditional can contain any one of the comparison operators
covered in the next section.
Multiple conditions can be checked together using the boolean expression operators:
Conditional statements can also be extended with the elsif and else structures:
if (boolean expression 1) {
statement 1;
}
elsif (boolean expression 2) {
statement 2;
}
else {
statement 3;
}
Introduction
Perl's set of operators borrows extensively from the C programming language. Perl
expands on this by infusing new operators for string functions (.=, x, eq, ne, etc.). C by
contrast delegates its subset of Perl functionality to a library strings.h, and ctype.h,
and includes no such functionality by default compilation. Perl also includes a highly
flexible Regex engine inspired by Sed with improvements to standard POSIX regexes,
most notably the support of Unicode.
The Operators
Arithmetic
Most arithmetic operators are binary operators; this means they take two arguments.
Unary operators only take one argument. Arithmetic operators are very simple and
often transparent.
Binary
All the basic arithmetic operators are present: addition (+), subtraction (-),
multiplication (*), and division (/).
The modulus operator is %. Modulus returns the remainder of a division (/) operation.
The exponentiation operator is **. It allows you to raise one value to the power of
another. If you raise to a fraction you will get the root of the number. In this example
the second result when raised to the power of 2 should return 2 (( 2 ** (1/2) ) ** 2 = 2 ).
# Four squared:
print 4 ** 2; # prints 16
# Square root of 2
print 2 ** (1/2); # prints 1.4142135623731
The function sqrt is provided for finding a Square Root. Other fractional powers (i.e.,
(1/5), (2/13), (7/5), and similar) are suitably found using the ** operator.
Unary
The auto-decrement (--), and auto-increment (++) operators are unary operators. They
alter the scalar variable they operate on by one logical unit. On numbers, they add or
subtract one. On letters they shift one up or one down in the alphabet. On strings they
do the same respective operation, but with the added ability to roll-over. Operators
that come in post- and pre- varieties can be used two ways. The first way returns the
value of the variable before it was altered, and the second way returns the value of the
variable after it was altered.
my $foo = 1;
my $foo = 1;
my $foo = 'd';
my $foo = 'Z';
Assignment
The basic assignment operator is "=" which sets the value on the left side to be equal
to the value on the right side. It also returns the value. Thus you can do things like $a
= 5 + ($b = 6), which will set $b to a value of 6 and $a to a value of 11 (5 + 6). Why
you would want to do this is another question.
The assignment update operators from C, "+=", "-=", etc. work in perl. Perl expands
on this basic idea to encompass most of the binary operators in perl.
operator name
+= add assign
-= subtract assign
*= multiply assign
/= divide assign
%= modulo assign
**= exponent assign
.= concatenate assign
x= repeat assign
&&= logical AND assign
||= logical OR assign
my $foo = 'Hello';
$foo .= ', world';
print $foo; # prints 'Hello, world';
my $bar = '+';
$bar x= 6;
print $bar; # prints '++++++';
Comparison
Perl uses different operators to compare numbers and strings. This is done because in
most cases, Perl will happily stringify numbers and numify strings. In most cases this
helps, and is consistent with Perl's DWIM Do-What-I-Mean theme. Unfortunately, one
place this often does not help, is comparison.
Logical
Perl has two sets of logical operators, just like the comparison operators, however not
for the same reason.
The first set (sometimes referred to as the C-style logical operators because they are
borrowed from C) is &&, ||, and !. They mean logical AND, OR, and NOT respectively.
The second set is and, or, and not.
The only difference between these two sets is the precedence they take (See
Precedence). The symbolic operators take a much higher precedence than the textual.
Conditionals
In this case, you could safely substitute and for && and the conditional would still work
as expected, however, this is not always the case.
Most people prefer to use C-style logical operators and use brackets to enforce clarity
rather than using a combination of textual and C-style operators (when possible),
which can be very confusing at times.
Partial evaluation
Partial evaluation (or "short circuiting") is the property of logical operators that the
second expression is only evaluated if it needs to be.
This also works with logical OR statements. If the first expression evaluates as true,
then the second is never evaluated because the conditional is automatically true.
sub foo {
#returns a true or false value
}
foo() or print "foo() failed\n";
Here, if the foo() subroutine returns false, then "foo() failed\n" is printed. However, if
it returns true, then "foo() failed\n" is not printed, because the second expression
(print "foo() failed\n") does not need to be evaluated.
Bitwise
These operators perform the same operation as the logical operators, but instead of
being performed on the true/false value of the entire expressions, it is done on the
individual respective bits of their values.
The left and right shift operators move the bits of the left operand (e.g. $a in the case
of $a << $b) left or right a number of times equal to the right operand ($b). Each
move to the right or left effectively halves or doubles the number, except where bits
are shifted off the left or right sides. For example, $number << 3 returns $number
multiplied by 8 (2**3).
String
The string concatenation operator is ".", not "+" which some other languages use.
There is a repeat operator for strings, "x" which repeats a string a given number of
times. Thus "xy" x 2 produces "xyxy".
File Test
See Perl Programming/Function Reference#-X
Other
The range operator (..) returns a list of items in the range between two items; the
items can be characters or numbers. The type of character is determined by the first
print ('A'..'Z');
print ('a'..'z');
print ('A'..'z');
print (1..'a');
print (1..20);
print ('&'..'!');
print (10..-10);
print "$_\n" foreach (1..10);
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
ABCDEFGHIJKLMNOPQRSTUVWXYZ
1234567891011121314151617181920
&
1
2
3
4
5
6
7
8
9
10
Note that the case is defined by the first operand, and that the 1..'a' and (10..-10)
operations don't return anything.
Precedence
Precedence is a concept that will be common to you if you have studied algebra or
coded in C/C++. Each operator has its place in a hierarchy of operators, and are
executed in order. The precedence of perl operators is strict and should be overriden
with parentheses, both when you are knowingly going against precedence and when
you aren't sure of the order of precedence. For a complete listing of the order, check
perlop (http://www.perl.com/doc/manual/html/pod/perlop.html#SYNOPSIS) .
Perl has four fundamental data types: scalars, lists, hashes, and typeglobs.
scalar
is a funny way of saying a single value; it may be a number, a string, or a
reference.
list
is an ordered collection of scalars. A variable that holds a list is called an array.
Items in a list or array can be accessed by their position in the list; programs can
retrieve the first, second, third, etc. item in a list.
hash
is like an array, in that a hash holds many values, but the values are identified by
a unique "key", rather than an ordinal index position.
typeglob
is a variable representing an entry within the internal symbol table. It is used to
manipulate file handles, and to create references or aliases.
All variables are marked by a leading sigil, which identifies the data type. The same
name may be used for variables of different types, without conflict.
$foo # a scalar
@foo # a list
%foo # a hash
*foo # a typeglob
Scalar Variables
Introduction to Scalar Variables
Now that you understand how to use strings and numbers in Perl, you need to start
learning how to use variables. The best way to learn about scalar variables - Perl talk
for a single variable, as against a group or list of values - is to look at an example.
#!/usr/bin/perl
use warnings;
The first two lines you already know, #!/usr/bin/perl and use warnings;
The third line is more interesting, it contains a scalar variable. There are a few
important things to point out:
1. In case you haven't figured this out, the scalar variable in this line is
$my_scalar_variable
2. Notice the $ before the name my_scalar_variable, in order to define a scalar
variable, this sign must appear before the name.
Now let's look at the last line. This is just the familiar print function being told to
print the value of $my_scalar_variable.
Try it!
Type in the program mentioned above and run it.
In the course of writing a program, you will most likely use a variable. What is a
variable? A variable is something that stores data. A scalar variable holds a single
value.
Naming Conventions
All scalar variables names must start with a $ symbol. You can remember this by
thinking $calar.
Variable names can be comprised of alphanumeric characters and underscores.
Numeric characters are allowed in names of variables, but not as the first
character after the $.
You may recall that earlier in the book, I said that whether you use " or ' in strings
makes a big difference in the interaction of strings and variables. Well now I am going
to explain what I meant.
Now that you know what a variable is, what if you wanted to put a variable in a string?
Here's the difference:
#/usr/bin/perl
use warnings;
$variable = 4;
print "I saw $variable lions!";
#/usr/bin/perl
use warnings;
$variable = 4;
print 'I saw $variable lions!';
Try it!
Type in the programs mentioned above and run them.
This effect is because of what I said before, single quoted strings are interpreted
literally.
Comparison Operators
There are operators that are used for comparing numbers and strings. This can be
very useful when you get to more advanced programming. Both numbers and strings
have their own set of operators which test for a condition such as equal or not equal
and return either true or false.
== - Equal to
!= - Not equal to
< - Less than
> - Greater than
<= - Less than or equal to
>= - Greater than or equal to
<=> - Numeric Comparison
eq - Equal to
ne - Not equal to
lt - Less than
gt - Greater than
le - Less than or equal to
ge - Greater than or equal to
cmp - String Comparison
Note
The two 'Comparison' operators <=> and cmp are slightly
different from the rest. Rather than returning only true or
false, these operators return 1 if the left argument is
Exercises
Try writing a program like the Hello World program except elaborate it by
storing "Hello, world!\n" in a variable and then printing the variable.
Play around with all the things we have learned so far. Try to create a program
that has an example of everything we have learned so far.
Lists
A list in perl is an ordered set of scalar values. It is represented in your code as a
comma-separated sequence of values, which may or may not be contained in scalar
variables. Lists can be used to make multiple assignments at once, and can be passed
as arguments to several built-in and user-defined functions:
#!/usr/bin/perl
use strict;
use warnings;
Note
Parentheses are not required in the construction of a list.
They are used only for precedence.
When creating a list of several strings that do not include spaces, Perl provides a
shortcut to get around typing multiple quotes and commas. Instead of
you can use the qw// operator. This operator uses any non-alpha-numeric character as a
delimiter (typically the / character), and encloses a space-separated sequence of
barewords. A delimeter separates the command with the arguments. The above line is
identical to the following:
The final example uses the open and close parenthesis as a different delimeter. If
there is an open and close version of the delimiter you choose, you need to use them
both. Otherwise just repeat the same symbol twice. For example, you cannot type
qw<Paul Michael< you have to type qw<Paul Michael>.
Note
The resulting strings from the qw// operator are single-
quoted, meaning no interpolation happens in the set. If you
need to include a variable in your list, you cannot use this
method.
List Assignments
As shown above, lists can be used to make several assignments at once. If the number
of variables on the left is the same as the number of values on the right, all variables
are assigned to their corresponding values, as expected.
If there are fewer variables on the left than values on the right, the 'extra' values are
simply ignored:
#!/usr/bin/perl
($length, $width) = (10, $w, 15); #$length gets 10, $width gets the value of $w. 15 is ignored
If there are more variables on the left than values on the right, the 'extra' variables are
assigned the default undef value:
#!/usr/bin/perl
($length, $width, $depth) = (10, $w); #$length gets 10, $width gets the value of $w. $depth is undef
The existence of list assignment creates the ability to 'swap' two variables' values
without the need of an intermediary temporary variable:
#!/usr/bin/perl
$foo = 10;
$bar = 5;
($foo, $bar) = ($bar, $foo); #$foo now equals 5, while $bar equals 10;
Arrays
An array in Perl is a variable which contains a list. An array can be modified, have
elements added and removed, emptied, or reassigned to an entirely different list. Just
as all scalar variables start with the $ character, all array variables start with the @
character.
Note
It is a common and frequent mistake in Perl to use the terms
'list' and 'array' interchangeably. They do not have the same
meaning.
A decent analogy is that a list (such as qw/foo bar baz/) is to an
array (such as @values) as a string (such as 'Paul') is to a
scalar variable (such as $name).
Array Assignment
Arrays are assigned lists of values. The list of values can be arbitrarily large or small
(it can even contain 0 elements).
#!/usr/bin/perl
@nums = (1,2,3,4,5);
That last example exemplifes a feature of Perl known as 'array flattening'. When an
array is used in a list, it is the array's elements that populate the list, not the array
itself. As stated above, a list is a set of scalar values only. Therefore, the @all array
contains 1000 elements, not 2.
Note
Although this implies you cannot create an 'array of arrays',
When an array is used in scalar context - either by assigning a scalar variable to the
array's value, or using it in an operation or function that expects a scalar - the array
returns its size. That is, it returns the number of elements it currently contains
#!/usr/bin/perl
@names = ('Paul','Michael','Jessica','Megan');
$how_many = @names;
Note
A common misconception is that a list in scalar context will
also return its size. This is untrue. In fact, there is no such
thing as a list in scalar context: using the comma operator
in a scalar context does not create a list, instead it evaluates
each of its arguments, left to right, and returns the last one:
$name = ('Paul','Michael','Jessica','Megan');
print "The last name in my list is $name\n";
Printing an Array
There are two general ways of printing the values of an array. You can either print the
list of items in the array directly, or you can interpolate the array in a double-quoted
string.
In the first example, the print function is being given a list of 6 arguments: the string
'My names are: ', each of the four values in @names, and the string ".\n". Each argument
is printed separated by the value of the $, variable (which defaults to the empty
string), resulting in the values from the array being 'squished' together:
In the second example, the print function is being given exactly one argument: a string
that contains an interpolated array. When Perl interpolates an array, the result is a
string consisting of all values in the array separated by the value of the $" variable
(which defaults to a single space):
Note
Both the $, and $" variables can be changed to any string
you like. For example, to separate the array's items with a
comma and a space instead of just a space:
The elements of an array are accessed using a numerical reference within square
brackets. Because each item within an array is a scalar value, you need to use $ when
referencing a value. The first element of an array is number 0 and all the others count
up from there.
A negative number will count down from the right side of the array. This means that
-1 references the last element of the array and -3 references the third to last element.
Let's see some examples:
What if you need to know the last index? $#array will return it for you:
In fact @array[0] is a slice (that is, a sub-array of an array) that contains one element,
whereas $array[0] is a scalar which contains the value 1.
The array functions and operators listed above can easily be used to detect the passed
command line arguments and to detect the number of arguments provided.
Related Articles
Data Structures/Arrays
List Functions
Array Functions
A Perl hash is similar to an ordinary array, but instead of using integer indexes, a hash
uses "keys" that can take on any scalar value. These are usually strings or numbers.
Syntax: instead of the @ operator, associative arrays use the % symbol, and rather
than square brackets [], as in $myarray[0], hash elements are referenced using curly
brackets {}, as in $myhash{"george"}
Hashes are one of the most powerful and commonly used features in Perl. A typical
use would be to build a hash that contains a "dictionary", with each key being a word
in the dictionary, and the corresponding values being the definitions of those words.
$petsounds{"mouse"} = "squeak!";
To remove an item from a hash, use delete. Setting the value to undef does not delete the
item; using exists on a key that has been set to undef will still return true.
"Associative Arrays"
Originally, a "hash" was called an "associative array", but this term is a bit outdated
(people just got sick and tired of using seven syllables). Although it isn't intuitive for
newcomers to programming, "hash" is now the preferred term. The name is derived
from the computer science term, hashtable.
Printing Arrays
If you know PHP, you may have thought by now of some convenient way to print the
contents of your array the print_r does...
use Data::Dumper;
print Dumper(\%hash);
#!/usr/bin/perl
use Data::Dumper;
my %a=();
$a{1}{"a"}{"A"}="FIRST";
$a{1}{"c"}{"B"}="THIRD";
$a{1}{"b"}{"C"}="SECOND";
print Dumper(\%a);
1 a A FIRST
1 b C SECOND
1 c B THIRD
$VAR1 = {
'1' => {
'c' => {
'B' => 'THIRD'
},
'a' => {
'A' => 'FIRST'
},
'b' => {
'C' => 'SECOND'
}
}
};
Input/Output or IO, is an all-encompassing term that describes the way your program
interacts with the user. IO comes in two forms, or stream types: the program's stimuli
are collectively referred to as input, while the medium that the program uses to
communicate back, write logs, play sounds, etc. is known as output. Both types of
streams can be redirected either at a lower level than Perl, as is the case when done
through the operating system by the shell; or, in Perl itself, as is the case when you
reopen the file handles associated with the stream.
Output
You have already learned how to output with the print statement. A simple reference is
provided:
What this print statement is actually doing is printing to STDOUT, which stands for
standard output. Standard output is the default destination for all output. If you wish
to print anywhere else you must be explicit. We will revisit this later.
Input
As you may have imagined, it's very hard to write a good program without any type of
input; here is an example program to teach you these concepts:
#!/usr/bin/perl
use strict;
use warnings;
Standard input is usually the keyboard though this can be changed at a lower level
than your program. For now we will assume it isn't changed. However, this might not
be an assumption you wish to make in production code.
Unit Exercise
Write a program which prompts the user for a number and then returns the
number multiplied by four (or any other number).
will not work because the interpreter would think that the quotes mark the end of the
string. As with all things in Perl, there are many solutions to this problem.
This is obviously not the best solution, as it is conceivable that you are trying to print a
string containing both kinds of quote:
Escape characters
For situations like the above where only a short amount of text is being quoted, a
common solution is to escape any quotes in the string. By preceding any quotes with a
backslash they are treated as literal characters.
This of course implies that you also need to escape any backslashes you want to use in
your string. To print the line I have written above literally in perl, you would need to
write.
print " print \"I said \\\"They\\\'re the most delicious fruits\\\".\";"
Luckily perl provides us with another way of quoting strings that avoids this problem.
Custom Quotes
Perl provides the operators q and qq that allows you to decide which characters are
used to quote strings. Most punctuation characters can be used. Here are a few
examples:
The only symbols I have found that cannot be used for these quotes are $ ` /
Block Output
As can be seen, while the custom quotes option works for short strings, it can run into
problems if a lot of text containing a lot of punctuation is output. For this situation, a
technique called Block quoting can be used.
print <<OUTPUT
I said "They're the most delicious fruits!".
OUTPUT;
Any string of characters can be used instead of OUTPUT in the example above. Using
this technique anything can be output no matter what characters it contains. The one
caveat of this method is that the closing OUTPUT must be the first character on the
line, there cannot be any space before it.
print <<EverythingBetween
...
...
EverythingBetween;
Variable Output
It is possible to output variables within strings when you use some of these methods:
my $one = 'mangoes';
print <<OUT
I love $one
OUT; # I love mangoes
print <<'OUT'
I love $one
OUT; # I love $one
Caveats
The single quote ' q{ and double quote " qq <<A operators, behave differently. Whereas
when using double quotes, you can include variables and escape any characters, when
you use single quotes you can only escape single quotes and you cannot include
variables.
Control structures
The basic control structures do not differ greatly from those used in the C
programming language or Java programming language:
Loops
Note that the statements in a while (or until) loop are not executed if the boolean
do {
statement(s)
} while (Boolean expression);
do {
statement(s)
} until (Boolean expression);
The do {} while and the do {} until loops are technically statement modifiers and not
actual control structures. The statements will be executed at least once.
variable is an alias to each element of the list, starting at the first element on the first
pass through the loop. The loop is exited when all the elements in the list have been
exhausted. Since variable is an alias, changing the value of variable will change the
value of the element in the list. This should generally be avoided to enhance
maintainability of the code.
Note that for and foreach are actually synonyms and can be used interchangeably.
If-then statements
if (Boolean expression) {
statement(s)
}
Statements with else blocks (these also work with unless instead of if)
if (Boolean expression) {
statement(s)
} else {
statement(s)
}
if (Boolean expression) {
statement(s)
} elsif (Boolean expression) {
statement(s)
}
Control statements can also be written with the conditional following the statements.
This syntax functions (nearly) identically to the ones given above.
See also
w:Perl control structures
Read files
Procedural Interface
By globbing file
This method will read the whole file into an array. It will split on the special variable $/
By line processing
This method will read the file one line at a time. This will keep memory usage down,
but the program will have to poll the input stream on each iteration.
# Iterate over each line, saving the line to the scalar variable $line
while ( my $line = <$fh> ) {
# Iterate over each line, saving the line to the scalar variable $line
while ( my $line = $fh->getline ) {
my @lines = $fh->getlines;
In addition to the basic control structures, Perl allows the use of statement modifiers.
The statement modifier is placed at the end of the statement that it modifies. Note
that the do {} until and do {} while loop constructs are actually statement modifiers.
The complete list of modifiers is:
statement if expression
statement unless expression
statement while expression
statement until expression
statement foreach list
String functions
chomp
Action
Removes the last characters from a string only if they're recognized as a record
separator (e.g. a newline character)
Returns
Syntax
chomp($String = $_);
Example
See Also
chop
Action
Returns
Syntax
chop($String = $_);
Example
See Also
Removes the last character from a string (e.g. removes the newline characters when
reading from a file)
chr
crypt
The salt string needs only be 2 characters long, and provides a way of randomising the
hash, such that the same word can produce several different hashes, if used with
different values of $Salt;!
hex
index
Search for one string within another. (see rindex to search from end-to-start)
The special variable $[ always gets added to the return value, but $[ is normally 0, and
the manual recommends leaving it at 0.
lc
$Lowercase = lc($String);
lcfirst
length
oct
ord
pack
Takes a list and converts it into a string using a supplied set of rules.
b A bit string (ascending bit order inside each byte, like vec()).
B A bit string (descending bit order inside each byte).
h A hex string (low nybble first).
H A hex string (high nybble first).
u A uuencoded string.
U A Unicode character number. Encodes to UTF-8 internally.
w A BER compressed integer. Its bytes represent an unsigned integer in base 128, most significant digi
x A null byte.
X Back up a byte.
@ Null fill to absolute position.
reverse
my @ReversedList = reverse(@List);
my $ReversedString = reverse($String);
rindex
Search for one string within another, starting at the end of the string.
sprintf
Use %n to request the number of characters written so far, and put it into the next
variable in the list. You may want to check that user-supplied formatting rules don't
contain this code.
sprintf("%02d", $Minutes); # Forces leading zeros to make the string 2 characters long
sprintf("%1.5f", $Number); # Limits the number of decimal places
substr
start-position is zero-based.
A negative number starts from the end of the string.
You can use substr on the left side of an assignment statement to change part of a
string. This can actually shorten or lengthen the string.
uc
$Uppercase = uc($String);
ucfirst
Numeric functions
abs
atan2
cos
exp
hex
int
log
oct
rand
# Gets a random number (may automatically call srand() if that's not been done)
$Number = rand(); # Returns a random number from 0 to 1
$Number = int(rand(800)); # Returns a random integer from 0 to 799
$Number = 1 + int(rand(999)); # Returns a random integer from 1 to 999
sin
sqrt
See the Math::Complex module if you need to take roots of negative numbers;
srand
Version-dependant, and older versions of Perl are not guaranteed to have a good seed
value. See the Math::TrulyRandom module for more possibilities. The current version
of Perl uses the urandom device if it's available.
Array functions
pop
$LastElement = pop(@MyArray);
push
shift
splice
# Removes elements from an array, optionally replacing them with a new array
splice(@Array); # Removes all elements from array
splice(@Array, 10); # Removes from element 10 to the end of the array
splice(@Array, -10); # Removes the last 10 elements of the array
splice(@Array, 0, 10); # Removes the first 10 elements of the array
@NewArray = splice(@Array, 0, 10); # Removes the first 10 elements of the array and returns those 10 items
splice(@Array, 0, 10, @Array2); # Replaces the first 10 elements of the array with Array2
unshift
List functions
grep
join
map
reverse
sort
unpack
Unpacks a string into a list - see the templates available for the pack() function for
details
each
exists
#Tests whether or not a key exists in a hash (even if the value for that key is undef)
if (exists $hash{$key}){
print "\%hash contains a value for key '$key'\n";
}
keys
#Returns a list of all keys from the hash, in same 'random' order as each
foreach $key (keys %hash){
print "$key => $hash{$key}\n";
}
values
#Returns a list of all values from the hash, in same 'random' order as keys
foreach $value (values %hash){
print "\%hash contains a value '$value'\n";
}
close
closedir
dbmclose
dbmopen
die
Exits the program, printing to "STDERR" the first parameter and the current file and
line. Used to trap errors.
eof
eof FILEHANDLE
eof()
eof
This function returns true if the next read on FILEHANDLE would return end-of-file, or
if FILEHANDLE is not open. FILEHANDLE may be an expression whose value gives the
real filehandle, or a reference to a filehandle object of some sort. An eof without an
argument returns the end-of-file status for the last file read. An eof() with empty
parentheses () tests the ARGV filehandle (most commonly seen as the null filehandle
in <>). Therefore, inside a while (<>) loop, an eof() with parentheses will detect the
end of only the last of a group of files. Use eof (without the parentheses) to test each
file in a while (<>) loop. For example, the following code inserts dashes just before
the last line of the last file:
while (<>) {
if (eof()) {
print "-" x 30, "\n";
}
print;
}
On the other hand, this script resets line numbering on each input file:
Like "$" in a sed program, eof tends to show up in line number ranges. Here's a script
that prints lines from /pattern/ to end of each input file:
while (<>) {
print if /pattern/ .. eof;
}
Here, the flip-flop operator (..) evaluates the pattern match for each line. Until the
pattern matches, the operator returns false. When it finally matches, the operator
starts returning true, causing the lines to be printed. When the eof operator finally
returns true (at the end of the file being examined), the flip-flop operator resets, and
starts returning false again for the next file in @ARGV
fileno
flock
format
getc
printf
read
readdir
rewinddir
seek
seekdir
select
syscall
sysread
sysseek
syswrite
tell
telldir
truncate
warn
write
pack
read
# Optional offset is applied when the data is stored (not when reading)
read(FILEHANDLE, $StoreDataHere, $NumberBytes, Offset);
syscall
# (maximum 14 arguments)
$ReturnValue = syscall($Command);
sysread
syswrite
unpack
# See the pack function for details (unpack does the opposite!)
unpack($Template, $BinaryData);
vec
Filesystem functions
-X
chdir
chdir $Directory;
chdir $Directory || die("Couldn't change directory");
chmod
chown
chroot
chroot $NewRootDirectory;
Sets the root directory for the program, such that the "/" location refers to the
specified directory.
fcntl
glob
ioctl
link
lstat
Identical to stat(), except that if given file is symbolic link, stat link not the target.
mkdir
open
open(my $fp, "$Program |"); # Read from the output of another program
open(my $fp, "| $Program"); # Write to the input of another program
opendir
readlink
rename
May work differently on non-*nix operating systems, and possibly not at all when
moving between different filesystems. See [[File::Copy]] for more complicated file
operations.
rmdir
stat
@FileStatistics = stat($Filename);
symlink
umask
unlink
# Deletes a file
unlink $Filename;
unlink $Filename || die("Couldn't delete file");
unlink $File1, $File2, $File3;
(unlink($File1, $File2, $File3) == 3) || die("Couldn't delete files");
utime
Program functions
caller
Returns information about the current function call stack. In scalar context, returns
only the name of the package from where the current subroutine was called. In list
context, returns the package, filename, and line number. In list context with a
numeric argument passed, returns several pieces of information (see below). The
argument represents how many levels in the call stack to go back.
#!/usr/bin/perl
foo();
sub foo {
$package = caller; #returns 'main'
($package, $filename, $line) = caller; #returns 'main', the file name, and 3
# Line below returns all 10 pieces of info. (Descriptions self-explanatory from variable names)
($package, $filename, $line, $subroutine, $hasargs, $wantarray, $evaltext, $is_require, $hints, $bitmask)
caller(0);
}
import
The standard 'Exporter' module provides an import method if your class has it as a
base class.
package
Declares all lines that follow (until EOF or the next package statement) to belong to
the given package's namespace.
#!/usr/bin/perl
$x = 5; #sets $main::x
package Foo;
$x = 5; #sets $Foo::x
sub bar { #defines &Foo::bar
print "hello world";
}
package Temp;
$x = 5; #sets $Temp::x
require
includes the specified module's code into the current program. The module can be
specified either with an absolute or relative path, or with a bareword. If a bareword is
given, a '.pm' extention is added, and :: is replaced with the current operating system's
path seperator:
require Foo::Bar;
#identical to:
require 'Foo/Bar.pm';
use
Requires and imports the given module or pragma, at compile time. The line
is identical to:
BEGIN {
require Foo;
import Foo qw/bar baz/;
}
Misc functions
defined
dump
eval
eval('$a=30;$b=40;');
print $a,$b;
formline
local
my
reset
scalar
undef
wantarray
#returns 'true', 'false', or undef if function that called it was called in list, scalar, or void context, re
sub fctn {
my @vals = (5..10);
if (wantarray) {
return @vals;
} elsif (defined wantarray) {
return $vals[0];
} else {
warn "Warning! fctn() called in void context!\n";
}
}
Processes
alarm
exec
fork
#clones the current process, returning 0 if clone, and the process id of the clone if the parent
my $pid = fork();
if ($pid == 0) {
print "I am a copy of the original\n";
} elsif ($pid == -1) {
print "I can't create a clone for some reason!\n";
} else {
print "I am the original, my clone has a process id of $pid\n";
}
getpgrp
getppid
getpriority
kill
pipe
qx/STRING/
setpgrp
setpriority
sleep
system
times
wait
waitpid
Modules
do
import
no
package
require
use
bless
dbmclose
dbmopen
package
ref
tie
tied
untie
use
Sockets
accept
bind
connect
getpeername
getsockname
getsockopt
listen
recv
send
setsockopt
shutdown
socket
socketpair
Login information
endgrent
endhostent
endnetent
endpwent
getgrent
getgrgid
getgrnam
getlogin
getpwent
getpwnam
getpwuid
setgrent
setpwent
Network information
endprotoent
endservent
gethostbyaddr
gethostbyname
gethostent
getnetbyaddr
getnetbyname
getnetent
getprotobyname
getprotobynumber
getprotoent
getservbyname
getservbyport
getservent
sethostent
setnetent
setprotoent
setservent
@TimeParts = gmtime();
@TimeParts = gmtime($Time);
localtime
@TimeParts = localtime();
@TimeParts = localtime($Time);
time
$Time = time();
times
@CPUTimes = times();
$UserTimeForProcess = $CPUTimes[0];
$SystemTimeForProcess = $CPUTimes[1];
$UserTimeForChildren = $CPUTimes[2];
$SystemTimeForChildren = $CPUTimes[3];
print ord(chr(1));
These are a set of eight exercises that can be used to test your ability to write Perl
programs. In some cases, these exercises might include material not covered from the
textbook; in those cases, you may have to consult your platform documentation to
identify a necessary function or otherwise implement one yourself.
Exercise 1
Exercise 2
Exercise 3
Exercise 4
Exercise 5
Exercise 6
Exercise 7
Exercise 8
Introduction
So you've been plodding along with your perl scripts, fiddling with arrays and hashes
and suddenly you realize that you would like to pass a function to another function
depending on the data you encounter, or perhaps you would like to get back a hash
when you look up an array index. References are the thing for you, allowing you to
build and pass around ever more complex data structures.
my $nightmare = "clowns";
my $ref = \$nightmare;
print "I laugh in the face of " . ${$ref} . "\n";
Regular expressions are tools for complex searching of text, considered one of the
most powerful aspects of the Perl language. A regular expression can be as simple as
just the text you want to find, or it can include wildcards, logic, and even
sub-programs.
To use regular expressions in perl, use the =~ operator to bind a variable containing
your text to the regular expression:
$Haystack =~ /needle/;
Regular expression can also be used to modify strings. You can search and replace
complex patterns by using the regex format s///
Match a string
# The split function allows you to split a string wherever a regular expression is matched
@ArrayOfParts = split( /,/, $Text); # Splits wherever a comma is found
@ArrayOfParts = split( /\s+/, $Text); # Splits where whitespace is found
@ArrayOfParts = split( /,\s*/, $Text); # Comma followed by optional whitespace
@ArrayOfParts = split( /\n/, $Text); # Newline marks where to split
# The s function allows you to search and replace within a string. s(ubstitute)
$Text =~ s/search for/replace with/;
$Text =~ s|search for|replace with|;
$Text =~ s{search for}{replace with};
# Putting a g (global) at the end, means it replaces all occurances and not just the first
$Text =~ s/search for/replace with/g;
# As with everything, putting an i (insensitive) at the end ignores the differences between
# uppercase and lowercase.
Use Locale;
$Text =~ s/search for/replace with/i;
$Text =~ m/before(.*)after/;
# So, if $Text was "beforeHelloafter", $1 is now "Hello"
$Text =~ m/bef(.*)bet(.*)aft/;
# This time, if $Text was "befOnebetTwoaft", $1 is now "One" and $2 is "Two"
#If $Text was "id=889", $1 now equals "id" and $2 equals 889.
Example
Metacharacter Description Note that all the if statements return a
TRUE value
Groups a series of
pattern elements Program:
to a single
element. When $string1 = "Hello World\n";
you match a if ($string1 =~ m/(H..).(o..)/) {
print "We matched '$1' and '$2'\n";
( )
pattern within }
parentheses, you
can use any of $1,
Output:
$2, ... $9 later to
refer to the
We matched 'Hel' and 'o W';
previously
matched pattern.
Matches the *, +,
or {M,N}'d $string1 = "Hello World\n";
if ($string1 =~ m/(l+?o)/) {
?
regexp that print "The non-greedy match with one or more 'l'
comes before as print "followed by an 'o' is 'lo', not 'llo'.\n";
}
few times as
possible.
Matches any
$string = "Sky.";
[^...]
character not in if (String =~ /[^aeiou]/) {
the square print "$string doesn't contain any vowels";
}
brackets.
Matches a
$string1 = "Hello World\n";
whitespace if ($string1 =~ m/\s.*\s/) {
\s character (space, print "There are TWO whitespace ";
print "characters seperated by other characters in $string1";
tab, newline, }
formfeed)
Overview
Perl modules (Files that end with the pm extension) are files of perl code that can be
reused from program to program. There is an online repository of perl modules called
CPAN (Comprehensive Perl Archive Network) at http://cpan.org. Many of these
modules come standard with Perl, but others must be installed as needed.
There are thousands of perl modules that do everything from creating a temporary file
to calling Amazon web services. These modules can make it easy to quickly write your
application if you know how to find, install, and use the appropriate Perl modules. If
you are thinking of writing your own Perl module, the best thing to do is to first
search at http://Search.cpan.org to make sure you are not about to reinvent the wheel.
1. Object-Oriented
2. Functional
use Foo;
my $foo = Foo->new();
print $foo->bar; #call Foo's bar method and print the output.
use Foo qw/bar/; # Import the name of the subroutine you want to use.
print bar();
Find the perl module you want at http://cpan.org, and download the gzipped file.
Untar and unzip the file:
Then cd into the directory, and follow the instructions in the README or INSTALL file.
You can also use a command-line program called cpan, if you have it installed:
Perl modules differ from perl scripts in two key and simple ways. Instead of starting
the module with "#!/path/to/perl", you start the file with the following:
package My::Module::Name;
You need to end the module with a true value, so the common practice is to do this at
the end of the file:
1;
package My::Module::Name;
1;
Example
We create a new file called ExampleModule.pm, and in it have the following code:
package ExampleModule;
use strict;
use base "Exporter";
our @EXPORT = qw/hello_world/;
sub hello_world
{
print "hello, world!\n";
}
1;
perl -c ExampleModule.pm
It will print out "ExampleModule.pm syntax OK" if all is well. Otherwise, you can
debug using the messages that are printed out.
#!/usr/bin/perl
use ExampleModule;
hello_world();
exit;
CPAN-style modules have test suites and a way to build the module into the perl
library.
Download and install: Module::Starter from CPAN. Once this is installed, there will be
a program called module-starter in your path. To create a new module, do the
following from the command line:
It will then create a set of directories for you, including some shell module files with
starter POD documentation. The perl modules will be inside the lib directory inside
the directory that is created. These are the files to edit. You can put your tests for the
modules into the "t" directory. To install and build the module, you do the following:
>perl Makefile.PL
>make
>make test
>sudo make install
When Perl was initially developed there was no support at all for Object Orientated
(OO) programming. Since Perl 5 OO has been added using the concept of Perl
packages (namespaces), an operator called bless, some magic variables (@ISA,
AUTOLOAD, UNIVERSAL), the -> and some strong conventions for supporting
inheritance and encapsulation.
An object is created using the package keyword. All subroutines declared in that
package become object or class methods.
package Object;
sub new {
return bless {}, shift;
}
sub setA {
my $self = shift;
my $a = shift;
$self->{a}=$a;
}
sub getA {
my $self = shift;
return $self->{a};
}
my $o = Object->new;
$o->setA(10);
print $o->getA;
The first thing is that when a subroutine is called using the -> notation a new
argument is pre-pended to the argument list. It is a string with either the name of the
Package or a reference to the object (Object->new() or $o->setA. Until that makes
sense you will find OO in Perl very confusing.
To use private variables in objects and have variables names check, you can use a little
different approach to create objects.
package my_class;
use strict;
use warnings;
{
# All code is enclosed in block context
sub set_bar {
my $this = shift;
$bar{$this} = shift;
}
sub get_bar {
my $this = shift;
return $bar{$this};
}
}
Now you have good encapsulation - you cannot access object variables directly via
$o->{bar} but only using set/get methods. It's also impossible to make mistakes in
object variable names, because they are not a hash-keys but normal perl variables,
needed to be declared.
my $o = my_class->new();
$o->set_bar(10);
print $o->get_bar();
prints 10
Links
The comp.lang.perl.tk FAQ (http://w4.lns.cornell.edu/~pvhp/ptk/ptkFAQ.html)
A huge collection of freely usable perl modules, ranging from advanced mathematics
to database connectivity, networking and more, can be downloaded from a network of
sites called CPAN. Most or all of the software on CPAN is also available under either
the Artistic License, the GPL, or both. CPAN.pm is also the name of the perl module
that downloads and installs other perl modules from one of the CPAN mirror sites;
such installations can be done with interactive prompts, or can be fully automated.
Installing modules
With ActivePerl (Windows systems)
ppm
This will give you a "Perl Package Manager" prompt, which allows you to download
and install modules from the internet. For example, to install the Time::HiRes module,
type:
search time::hires
That will give you a list of modules which match your search query. Once you know
the module is available and what its exact name is, you can install the module with:
install Time::HiRes
With Perl
If you're using a normal version of Perl, the way to activate the package manager is
this:
This will load the CPAN module, and let you search for, download, install, and manage
the modules on your computer the same as PPM.
use Time::HiRes;
You can supply an optional list of the functions you want to use from this module, if
you're worried that some of the function names in the module are too similar to
functions you're already using:
With that done, you can simply use the supplied functions as normal. Most modules
have example programs within their documentation, and the best way to start using a
module is to copy and adapt one of the example programs.
Finding documentation
The documentation for each module is installed in your documentation directory when
you get a new module, or you can browse documentation on CPAN. To find module
documentation on your computer, try looking in some of the following directories:
c:\perl\html\lib
c:\perl\html\site\lib
If you're having real trouble finding the HTML documentation for a module, you may
be able to read the *.pm perl file yourself for POD comments, or use the POD2HTML
tool yourself to generate the HTML file.
First, you must have some way to access the program. Here we will deal with form
data and submission, so we will assume that your form code in HTML has a property
saying ACTION="programname.cgi".
#!/usr/bin/perl
use CGI;
The CGI module makes our work easy because it has pre-programmed functions in it
for internet use. Then we must create a handle to CGI - something that allows us to
access the functions. We do this with:
my $query = CGI->new();
This means that the variable $query is loading the CGI standard functions.
Now that our program is setup using the CGI module, it should look something like
this:
#!/usr/bin/perl
use CGI;
my $query = CGI->new();
So we have a program, it just doesn't do anything yet, and will actually cause a server
error because the server has no output or any idea of what kind of output to display
even if it had some.
Retrieving Information
Before we tell the server what to do with our output, we need to retrieve our input. To
do this, we use the $query variable we declared earlier. Say we have a text box in the
form that is named "Name" and we want to find out what was typed there. To do this,
we put the following line of code in our program:
my $Name = $query->param('Name');
Now, this line of code introduces us to the param() function (for "parameter"). The
param() function can do quite a few handy tricks for us, all of them nice ways to
retrieve our variables. It processes all of the http coding so all we get is a nice clean
variable. Another note, you aren't required to use $Name as your variable. It's simply
more convenient to only remember one name for the same variable. Still, use what's
best for you.
Output
Now we must create our header information. CGI even makes THIS easy for us. Instead
of memorizing a bunch of mime-type declarations (which you may do as well), all we
must do is type:
print $query->header();
and it prints out our header information. A note about headers. Inside the parenthesis,
we may specify parameters like cookies to send to the user's browser. This becomes
very useful later. For now we will just stick to the headers.
The last thing you need to put (though the program will run, displaying a blank page
without it) is some output. Let's simply have it display the user's name back to
him/her. This would look like.
#!/usr/bin/perl
use CGI;
my $query = new CGI;
my $Name = $query->param('Name');
print $query->header();
When put into perspective, we can see that the $query variable is a very important
connection to the CGI module as it tells perl that the function you are referencing
belongs to CGI; Again, you may declare any variable name in the place of $query so
long as you are consistent, though you will find many developers use $query or $q.
Also note the use of the escapeHTML method to avoid any HTML injection problems.
Final note. Make sure you change /usr/bin/perl to the path of your perl installation
(assuming that is not it) so perl will execute properly
Now we have two versions of mod_perl - 1.3 (for Apache 1.x) and 2.0 - for Apache 2.x
Handlers
Output
Parrot is the Perl6 runtime, and can be programmed at a low level in Parrot assembly
language. Parrot exists in a limited form as of June, 2003, and a small number of
languages (Jako, Cola, Basic, Forth and a subset of Perl 6) exist simply to be 'compiled'
down to Parrot assembly language opcodes.
While Perl6 is being developed, the best way to stay informed about what's happening
is to keep an eye on the front-page of http://www.perl.com/ and look out for articles.
As each new language-feature is being developed, it gets discussed on Perl.com and
the associated mailing lists, so subscribe to some of those to see glimpses of what
Perl6 will be like.
Obfuscated code
Some people claim Perl stands for 'Pathologically Eclectic Rubbish Lister' due to the
high use of meaningful punctuation characters in the language syntax.
Your mission, should you choose to accept it, is to write a one-liner perl script which
displays the phrase "Just another Perl hacker," (including the comma, and
capitalization as shown). If successful, you win the right to use it as an email signature
identifying yourself as a Perl hacker. Entries will be judged on how smart-ass the code
is. Around 100 of the first JAPHs and some funky obfu Perl can be seen on CPAN
(http://www.cpan.org/misc/japh) .
Acme
There's always a place in Perl for odd modules, and one such place is the Acme::
namespace. If you have a module which knows how long a piece of string is, or one
which converts your perl script into an image of Che Guevara, post it here.
Golf
Perl is a very compact language. So compact, that some have even create a game
around perl's terseness called perlgolf. In perlgolf, you are given a problem to solve.
You must solve it in the fewest number of characters possible. A scorecard is kept, and
after 18 "holes", a winner is announced.
#!/usr/bin/perl
# always enable compiler warnings, as they may highlight potential trouble
use warnings;
# let's ask the compiler to be more strict, make sure we declare our variables etc.
use strict;
# This statement assigns whatever is given on the standard input(usually your keyboard) to a scalar
# variable named $filename and removes the newline character that is included by default.
chomp (my $filename = <STDIN>);
# This line opens the file referred to in $filename for input via a lexical filehandle
# stored in a scalar variable named "$file".
open my $file, "<", $filename or die "Can't open '$filename' for reading: $^E\n";
# This loop goes through each line of the file, splits the line into separate characters and
# increments the number of occurrences of each letter using a hash called "%chars".
my %chars;
while(<$file>) {
$_ = lc($_); # convert everything to lowercase
my @characters = split (//, $_); # Store list of characters in an array
foreach (@characters) {
if(/\w/) { # Ignore all characters except letters and numbers
$chars{$_}++;
}
}
}
close $file;
# This loop goes through each letter in the %chars hash and prints a report informing the user of
# how many times each letter occurred.
If you executed this program on a file containing the sentence "The quick, brown fox
jumps over the lazy dog.", you would see this as output:
a appeared once.
b appeared once.
c appeared once.
d appeared once.
e appeared 3 times.
f appeared once.
g appeared once.
h appeared 2 times.
i appeared once.
j appeared once.
k appeared once.
l appeared once.
m appeared once.
n appeared once.
o appeared 4 times.
p appeared once.
q appeared once.
r appeared 2 times.
s appeared once.
t appeared 2 times.
u appeared 2 times.
v appeared once.
w appeared once.
x appeared once.
y appeared once.
z appeared once.
Hi-Lo: A simple game written in perl that asks you for a guess between 1 and 100 and
tells you if you are too high or low.
use warnings;
use strict;
$| = 1;
my $Num_Guesses = 0;
for my $gameno (1 .. $Num_Games) {
my $number = 1 + int rand 100;
my $guess;
do {
print "Enter guess from 1 to 100: ";
chomp($guess = <STDIN>);
++$Num_Guesses;
Section 7: Reference
String functions
chomp
Action
Removes the last characters from a string only if they're recognized as a record
separator (e.g. a newline character)
Returns
Syntax
chomp($String = $_);
Example
See Also
chop
Action
Returns
Syntax
chop($String = $_);
Example
See Also
Removes the last character from a string (e.g. removes the newline characters when
reading from a file)
chr
crypt
The salt string needs only be 2 characters long, and provides a way of randomising the
hash, such that the same word can produce several different hashes, if used with
different values of $Salt;!
hex
index
Search for one string within another. (see rindex to search from end-to-start)
The special variable $[ always gets added to the return value, but $[ is normally 0, and
the manual recommends leaving it at 0.
lc
$Lowercase = lc($String);
lcfirst
length
oct
ord
pack
Takes a list and converts it into a string using a supplied set of rules.
b A bit string (ascending bit order inside each byte, like vec()).
B A bit string (descending bit order inside each byte).
h A hex string (low nybble first).
H A hex string (high nybble first).
u A uuencoded string.
U A Unicode character number. Encodes to UTF-8 internally.
w A BER compressed integer. Its bytes represent an unsigned integer in base 128, most significant digi
x A null byte.
X Back up a byte.
@ Null fill to absolute position.
reverse
my @ReversedList = reverse(@List);
my $ReversedString = reverse($String);
rindex
Search for one string within another, starting at the end of the string.
sprintf
Use %n to request the number of characters written so far, and put it into the next
variable in the list. You may want to check that user-supplied formatting rules don't
contain this code.
sprintf("%02d", $Minutes); # Forces leading zeros to make the string 2 characters long
sprintf("%1.5f", $Number); # Limits the number of decimal places
substr
start-position is zero-based.
A negative number starts from the end of the string.
You can use substr on the left side of an assignment statement to change part of a
string. This can actually shorten or lengthen the string.
uc
$Uppercase = uc($String);
ucfirst
Numeric functions
abs
atan2
cos
exp
hex
int
log
oct
rand
# Gets a random number (may automatically call srand() if that's not been done)
$Number = rand(); # Returns a random number from 0 to 1
$Number = int(rand(800)); # Returns a random integer from 0 to 799
$Number = 1 + int(rand(999)); # Returns a random integer from 1 to 999
sin
sqrt
See the Math::Complex module if you need to take roots of negative numbers;
srand
Version-dependant, and older versions of Perl are not guaranteed to have a good seed
value. See the Math::TrulyRandom module for more possibilities. The current version
of Perl uses the urandom device if it's available.
Array functions
pop
$LastElement = pop(@MyArray);
push
shift
splice
# Removes elements from an array, optionally replacing them with a new array
splice(@Array); # Removes all elements from array
splice(@Array, 10); # Removes from element 10 to the end of the array
splice(@Array, -10); # Removes the last 10 elements of the array
splice(@Array, 0, 10); # Removes the first 10 elements of the array
@NewArray = splice(@Array, 0, 10); # Removes the first 10 elements of the array and returns those 10 items
splice(@Array, 0, 10, @Array2); # Replaces the first 10 elements of the array with Array2
unshift
List functions
grep
join
map
reverse
sort
unpack
Unpacks a string into a list - see the templates available for the pack() function for
details
each
exists
#Tests whether or not a key exists in a hash (even if the value for that key is undef)
if (exists $hash{$key}){
print "\%hash contains a value for key '$key'\n";
}
keys
#Returns a list of all keys from the hash, in same 'random' order as each
foreach $key (keys %hash){
print "$key => $hash{$key}\n";
}
values
#Returns a list of all values from the hash, in same 'random' order as keys
foreach $value (values %hash){
print "\%hash contains a value '$value'\n";
}
close
closedir
dbmclose
dbmopen
die
Exits the program, printing to "STDERR" the first parameter and the current file and
line. Used to trap errors.
eof
eof FILEHANDLE
eof()
eof
This function returns true if the next read on FILEHANDLE would return end-of-file, or
if FILEHANDLE is not open. FILEHANDLE may be an expression whose value gives the
real filehandle, or a reference to a filehandle object of some sort. An eof without an
argument returns the end-of-file status for the last file read. An eof() with empty
parentheses () tests the ARGV filehandle (most commonly seen as the null filehandle
in <>). Therefore, inside a while (<>) loop, an eof() with parentheses will detect the
end of only the last of a group of files. Use eof (without the parentheses) to test each
file in a while (<>) loop. For example, the following code inserts dashes just before
the last line of the last file:
while (<>) {
if (eof()) {
print "-" x 30, "\n";
}
print;
}
On the other hand, this script resets line numbering on each input file:
Like "$" in a sed program, eof tends to show up in line number ranges. Here's a script
that prints lines from /pattern/ to end of each input file:
while (<>) {
print if /pattern/ .. eof;
}
Here, the flip-flop operator (..) evaluates the pattern match for each line. Until the
pattern matches, the operator returns false. When it finally matches, the operator
starts returning true, causing the lines to be printed. When the eof operator finally
returns true (at the end of the file being examined), the flip-flop operator resets, and
starts returning false again for the next file in @ARGV
fileno
flock
format
getc
printf
read
readdir
rewinddir
seek
seekdir
select
syscall
sysread
sysseek
syswrite
tell
telldir
truncate
warn
write
pack
read
# Optional offset is applied when the data is stored (not when reading)
read(FILEHANDLE, $StoreDataHere, $NumberBytes, Offset);
syscall
# (maximum 14 arguments)
$ReturnValue = syscall($Command);
sysread
syswrite
unpack
# See the pack function for details (unpack does the opposite!)
unpack($Template, $BinaryData);
vec
Filesystem functions
-X
chdir
chdir $Directory;
chdir $Directory || die("Couldn't change directory");
chmod
chown
chroot
chroot $NewRootDirectory;
Sets the root directory for the program, such that the "/" location refers to the
specified directory.
fcntl
glob
ioctl
link
lstat
Identical to stat(), except that if given file is symbolic link, stat link not the target.
mkdir
open
open(my $fp, "$Program |"); # Read from the output of another program
open(my $fp, "| $Program"); # Write to the input of another program
opendir
readlink
rename
May work differently on non-*nix operating systems, and possibly not at all when
moving between different filesystems. See [[File::Copy]] for more complicated file
operations.
rmdir
stat
@FileStatistics = stat($Filename);
symlink
umask
unlink
# Deletes a file
unlink $Filename;
unlink $Filename || die("Couldn't delete file");
unlink $File1, $File2, $File3;
(unlink($File1, $File2, $File3) == 3) || die("Couldn't delete files");
utime
Program functions
caller
Returns information about the current function call stack. In scalar context, returns
only the name of the package from where the current subroutine was called. In list
context, returns the package, filename, and line number. In list context with a
numeric argument passed, returns several pieces of information (see below). The
argument represents how many levels in the call stack to go back.
#!/usr/bin/perl
foo();
sub foo {
$package = caller; #returns 'main'
($package, $filename, $line) = caller; #returns 'main', the file name, and 3
# Line below returns all 10 pieces of info. (Descriptions self-explanatory from variable names)
($package, $filename, $line, $subroutine, $hasargs, $wantarray, $evaltext, $is_require, $hints, $bitmask)
caller(0);
}
import
The standard 'Exporter' module provides an import method if your class has it as a
base class.
package
Declares all lines that follow (until EOF or the next package statement) to belong to
the given package's namespace.
#!/usr/bin/perl
$x = 5; #sets $main::x
package Foo;
$x = 5; #sets $Foo::x
sub bar { #defines &Foo::bar
print "hello world";
}
package Temp;
$x = 5; #sets $Temp::x
require
includes the specified module's code into the current program. The module can be
specified either with an absolute or relative path, or with a bareword. If a bareword is
given, a '.pm' extention is added, and :: is replaced with the current operating system's
path seperator:
require Foo::Bar;
#identical to:
require 'Foo/Bar.pm';
use
Requires and imports the given module or pragma, at compile time. The line
is identical to:
BEGIN {
require Foo;
import Foo qw/bar baz/;
}
Misc functions
defined
dump
eval
eval('$a=30;$b=40;');
print $a,$b;
formline
local
my
reset
scalar
undef
wantarray
#returns 'true', 'false', or undef if function that called it was called in list, scalar, or void context, re
sub fctn {
my @vals = (5..10);
if (wantarray) {
return @vals;
} elsif (defined wantarray) {
return $vals[0];
} else {
warn "Warning! fctn() called in void context!\n";
}
}
Processes
alarm
exec
fork
#clones the current process, returning 0 if clone, and the process id of the clone if the parent
my $pid = fork();
if ($pid == 0) {
print "I am a copy of the original\n";
} elsif ($pid == -1) {
print "I can't create a clone for some reason!\n";
} else {
print "I am the original, my clone has a process id of $pid\n";
}
getpgrp
getppid
getpriority
kill
pipe
qx/STRING/
setpgrp
setpriority
sleep
system
times
wait
waitpid
Modules
do
import
no
package
require
use
bless
dbmclose
dbmopen
package
ref
tie
tied
untie
use
Sockets
accept
bind
connect
getpeername
getsockname
getsockopt
listen
recv
send
setsockopt
shutdown
socket
socketpair
Login information
endgrent
endhostent
endnetent
endpwent
getgrent
getgrgid
getgrnam
getlogin
getpwent
getpwnam
getpwuid
setgrent
setpwent
Network information
endprotoent
endservent
gethostbyaddr
gethostbyname
gethostent
getnetbyaddr
getnetbyname
getnetent
getprotobyname
getprotobynumber
getprotoent
getservbyname
getservbyport
getservent
sethostent
setnetent
setprotoent
setservent
@TimeParts = gmtime();
@TimeParts = gmtime($Time);
localtime
@TimeParts = localtime();
@TimeParts = localtime($Time);
time
$Time = time();
times
@CPUTimes = times();
$UserTimeForProcess = $CPUTimes[0];
$SystemTimeForProcess = $CPUTimes[1];
$UserTimeForChildren = $CPUTimes[2];
$SystemTimeForChildren = $CPUTimes[3];
print ord(chr(1));
See http://search.cpan.org/
Also, try subscribing to the use.perl.org (http://use.perl.org) mailing list, which sends
out daily summaries of new modules as they're added to CPAN.
File Tests
Perl functions
Regular Expressions
Database
Time and Date
Official
The Perl site (http://www.perl.com)
The PerlMongers (http://www.perl.org)
The Comprehensive Perl Archive Network (http://www.cpan.org/) , a huge
repositary for Perl modules and scripts
Perl 6 development site (http://dev.perl.org/perl6/) , and The Parrot virtual
machine[1] (http://www.parrotcode.org/)
Community
PerlMongers (http://www.pm.org) , Perl User Group Index
The Perl Monastery (http://www.perlmonks.org) , themed perl based help site
Documentation
Perl documentation (http://perldoc.perl.org/)
Wikipedia Link
See Also
The DMOZ directory (http://dmoz.org/Computers/Programming/Languages/Perl/) ,
DMOZ perl index
Not a book title page. Please remove {{alphabetical}} from this page.