Bump $open::VERSION
[p5sagit/p5-mst-13.2.git] / pod / perlfaq3.pod
CommitLineData
68dc0745 1=head1 NAME
2
ee891a00 3perlfaq3 - Programming Tools ($Revision: 8539 $)
68dc0745 4
5=head1 DESCRIPTION
6
7This section of the FAQ answers questions related to programmer tools
8and programming support.
9
10=head2 How do I do (anything)?
11
12Have you looked at CPAN (see L<perlfaq2>)? The chances are that
13someone has already written a module that can solve your problem.
3958b146 14Have you read the appropriate manpages? Here's a brief index:
68dc0745 15
5a964f20 16 Basics perldata, perlvar, perlsyn, perlop, perlsub
17 Execution perlrun, perldebug
18 Functions perlfunc
68dc0745 19 Objects perlref, perlmod, perlobj, perltie
20 Data Structures perlref, perllol, perldsc
f102b883 21 Modules perlmod, perlmodlib, perlsub
d92eb7b0 22 Regexes perlre, perlfunc, perlop, perllocale
68dc0745 23 Moving to perl5 perltrap, perl
24 Linking w/C perlxstut, perlxs, perlcall, perlguts, perlembed
06a5f41f 25 Various http://www.cpan.org/misc/olddoc/FMTEYEWTK.tgz
26 (not a man-page but still useful, a collection
27 of various essays on Perl techniques)
68dc0745 28
3958b146 29A crude table of contents for the Perl manpage set is found in L<perltoc>.
68dc0745 30
31=head2 How can I use Perl interactively?
32
33The typical approach uses the Perl debugger, described in the
b432a672 34perldebug(1) manpage, on an "empty" program, like this:
68dc0745 35
36 perl -de 42
37
38Now just type in any legal Perl code, and it will be immediately
39evaluated. You can also examine the symbol table, get stack
40backtraces, check variable values, set breakpoints, and other
92c2ed05 41operations typically found in symbolic debuggers.
68dc0745 42
43=head2 Is there a Perl shell?
44
a05e4845 45The psh (Perl sh) is currently at version 1.8. The Perl Shell is a shell
46that combines the interactive nature of a Unix shell with the power of
47Perl. The goal is a full featured shell that behaves as expected for
48normal shell activity and uses Perl syntax and functionality for
49control-flow statements and other things. You can get psh at
50http://sourceforge.net/projects/psh/ .
55e174a4 51
f3b9614f 52Zoidberg is a similar project and provides a shell written in perl,
53configured in perl and operated in perl. It is intended as a login shell
54and development environment. It can be found at http://zoidberg.sf.net/
55or your local CPAN mirror.
56
55e174a4 57The Shell.pm module (distributed with Perl) makes Perl try commands
a05e4845 58which aren't part of the Perl language as shell commands. perlsh from
59the source distribution is simplistic and uninteresting, but may still
60be what you want.
68dc0745 61
49d635f9 62=head2 How do I find which modules are installed on my system?
63
a05e4845 64You can use the ExtUtils::Installed module to show all installed
65distributions, although it can take awhile to do its magic. The
66standard library which comes with Perl just shows up as "Perl" (although
67you can get those with Module::CoreList).
49d635f9 68
69 use ExtUtils::Installed;
197aec24 70
49d635f9 71 my $inst = ExtUtils::Installed->new();
72 my @modules = $inst->modules();
73
74If you want a list of all of the Perl module filenames, you
75can use File::Find::Rule.
76
77 use File::Find::Rule;
197aec24 78
49d635f9 79 my @files = File::Find::Rule->file()->name( '*.pm' )->in( @INC );
80
81If you do not have that module, you can do the same thing
197aec24 82with File::Find which is part of the standard library.
49d635f9 83
84 use File::Find;
85 my @files;
86
54bd407c 87 find(
58103a2e 88 sub {
89 push @files, $File::Find::name
90 if -f $File::Find::name && /\.pm$/
a05e4845 91 },
58103a2e 92
54bd407c 93 @INC
a05e4845 94 );
49d635f9 95
a05e4845 96 print join "\n", @files;
197aec24 97
49d635f9 98If you simply need to quickly check to see if a module is
99available, you can check for its documentation. If you can
197aec24 100read the documentation the module is most likely installed.
49d635f9 101If you cannot read the documentation, the module might not
102have any (in rare cases).
103
104 prompt% perldoc Module::Name
105
106You can also try to include the module in a one-liner to see if
107perl finds it.
108
109 perl -MModule::Name -e1
197aec24 110
68dc0745 111=head2 How do I debug my Perl programs?
112
500071f4 113(contributed by brian d foy)
114
115Before you do anything else, you can help yourself by ensuring that
116you let Perl tell you about problem areas in your code. By turning
ac9dac7f 117on warnings and strictures, you can head off many problems before
500071f4 118they get too big. You can find out more about these in L<strict>
119and L<warnings>.
120
121 #!/usr/bin/perl
122 use strict;
123 use warnings;
ac9dac7f 124
500071f4 125Beyond that, the simplest debugger is the C<print> function. Use it
126to look at values as you run your program:
127
128 print STDERR "The value is [$value]\n";
68dc0745 129
500071f4 130The C<Data::Dumper> module can pretty-print Perl data structures:
68dc0745 131
ac9dac7f 132 use Data::Dumper qw( Dumper );
133 print STDERR "The hash is " . Dumper( \%hash ) . "\n";
134
500071f4 135Perl comes with an interactive debugger, which you can start with the
136C<-d> switch. It's fully explained in L<perldebug>.
68dc0745 137
500071f4 138If you'd like a graphical user interface and you have Tk, you can use
139C<ptkdb>. It's on CPAN and available for free.
68dc0745 140
500071f4 141If you need something much more sophisicated and controllable, Leon
142Brocard's Devel::ebug (which you can call with the -D switch as -Debug)
143gives you the programmatic hooks into everything you need to write your
144own (without too much pain and suffering).
92c2ed05 145
500071f4 146You can also use a commercial debugger such as Affrus (Mac OS X), Komodo
147from Activestate (Windows and Mac OS X), or EPIC (most platforms).
68dc0745 148
149=head2 How do I profile my Perl programs?
150
e083a89c 151You should get the Devel::DProf module from the standard distribution
197aec24 152(or separately on CPAN) and also use Benchmark.pm from the standard
153distribution. The Benchmark module lets you time specific portions of
154your code, while Devel::DProf gives detailed breakdowns of where your
e083a89c 155code spends its time.
68dc0745 156
92c2ed05 157Here's a sample use of Benchmark:
158
159 use Benchmark;
160
161 @junk = `cat /etc/motd`;
162 $count = 10_000;
163
164 timethese($count, {
165 'map' => sub { my @a = @junk;
166 map { s/a/b/ } @a;
6c43ef16 167 return @a },
92c2ed05 168 'for' => sub { my @a = @junk;
92c2ed05 169 for (@a) { s/a/b/ };
170 return @a },
171 });
172
173This is what it prints (on one machine--your results will be dependent
174on your hardware, operating system, and the load on your machine):
175
176 Benchmark: timing 10000 iterations of for, map...
177 for: 4 secs ( 3.97 usr 0.01 sys = 3.98 cpu)
178 map: 6 secs ( 4.97 usr 0.00 sys = 4.97 cpu)
179
65acb1b1 180Be aware that a good benchmark is very hard to write. It only tests the
a6dd486b 181data you give it and proves little about the differing complexities
65acb1b1 182of contrasting algorithms.
183
68dc0745 184=head2 How do I cross-reference my Perl programs?
185
197aec24 186The B::Xref module can be used to generate cross-reference reports
83ded9ee 187for Perl programs.
68dc0745 188
c8db1d39 189 perl -MO=Xref[,OPTIONS] scriptname.plx
68dc0745 190
191=head2 Is there a pretty-printer (formatter) for Perl?
192
55e174a4 193Perltidy is a Perl script which indents and reformats Perl scripts
194to make them easier to read by trying to follow the rules of the
195L<perlstyle>. If you write Perl scripts, or spend much time reading
196them, you will probably find it useful. It is available at
197http://perltidy.sourceforge.net
198
199Of course, if you simply follow the guidelines in L<perlstyle>,
200you shouldn't need to reformat. The habit of formatting your code
201as you write it will help prevent bugs. Your editor can and should
202help you with this. The perl-mode or newer cperl-mode for emacs
203can provide remarkable amounts of help with most (but not all)
204code, and even less programmable editors can provide significant
205assistance. Tom Christiansen and many other VI users swear by
206the following settings in vi and its clones:
65acb1b1 207
208 set ai sw=4
d92eb7b0 209 map! ^O {^M}^[O^T
65acb1b1 210
55e174a4 211Put that in your F<.exrc> file (replacing the caret characters
65acb1b1 212with control characters) and away you go. In insert mode, ^T is
ac9dac7f 213for indenting, ^D is for undenting, and ^O is for blockdenting--as
214it were. A more complete example, with comments, can be found at
213329dd 215http://www.cpan.org/authors/id/TOMC/scripts/toms.exrc.gz
92c2ed05 216
49d635f9 217The a2ps http://www-inf.enst.fr/%7Edemaille/a2ps/black+white.ps.gz does
06a5f41f 218lots of things related to generating nicely printed output of
f05bbc40 219documents, as does enscript at http://people.ssh.fi/mtr/genscript/ .
65acb1b1 220
d92eb7b0 221=head2 Is there a ctags for Perl?
68dc0745 222
b68463f7 223(contributed by brian d foy)
224
ac9dac7f 225Ctags uses an index to quickly find things in source code, and many
226popular editors support ctags for several different languages,
227including Perl.
228
b68463f7 229Exuberent ctags supports Perl: http://ctags.sourceforge.net/
bc06af74 230
b68463f7 231You might also try pltags: http://www.mscha.com/pltags.zip
65acb1b1 232
233=head2 Is there an IDE or Windows Perl Editor?
234
6641ed39 235Perl programs are just plain text, so any editor will do.
236
6641ed39 237If you're on Unix, you already have an IDE--Unix itself. The UNIX
238philosophy is the philosophy of several small tools that each do one
239thing and do it well. It's like a carpenter's toolbox.
240
28b41a80 241If you want an IDE, check the following (in alphabetical order, not
242order of preference):
68fbfbd7 243
244=over 4
245
28b41a80 246=item Eclipse
247
b68463f7 248http://e-p-i-c.sf.net/
249
6670e5e7 250The Eclipse Perl Integration Project integrates Perl
28b41a80 251editing/debugging with Eclipse.
252
b68463f7 253=item Enginsite
254
255http://www.enginsite.com/
256
257Perl Editor by EngInSite is a complete integrated development
258environment (IDE) for creating, testing, and debugging Perl scripts;
259the tool runs on Windows 9x/NT/2000/XP or later.
28b41a80 260
68fbfbd7 261=item Komodo
262
b68463f7 263http://www.ActiveState.com/Products/Komodo/
264
28b41a80 265ActiveState's cross-platform (as of October 2004, that's Windows, Linux,
266and Solaris), multi-language IDE has Perl support, including a regular expression
b68463f7 267debugger and remote debugging.
68fbfbd7 268
ac1094a1 269=item Open Perl IDE
270
b68463f7 271http://open-perl-ide.sourceforge.net/
272
ac1094a1 273Open Perl IDE is an integrated development environment for writing
274and debugging Perl scripts with ActiveState's ActivePerl distribution
275under Windows 95/98/NT/2000.
276
28b41a80 277=item OptiPerl
278
b68463f7 279http://www.optiperl.com/
280
281OptiPerl is a Windows IDE with simulated CGI environment, including
282debugger and syntax highlighting editor.
28b41a80 283
5ca69f12 284=item PerlBuilder
285
b68463f7 286http://www.solutionsoft.com/perl.htm
287
288PerlBuidler is an integrated development environment for Windows that
289supports Perl development.
8782d048 290
68fbfbd7 291=item visiPerl+
292
b68463f7 293http://helpconsulting.net/visiperl/
294
ac1094a1 295From Help Consulting, for Windows.
68fbfbd7 296
28b41a80 297=item Visual Perl
298
b68463f7 299http://www.activestate.com/Products/Visual_Perl/
300
28b41a80 301Visual Perl is a Visual Studio.NET plug-in from ActiveState.
29b1171f 302
b68463f7 303=item Zeus
304
305http://www.zeusedit.com/lookmain.html
306
307Zeus for Window is another Win32 multi-language editor/IDE
308that comes with support for Perl:
29b1171f 309
68fbfbd7 310=back
311
b68463f7 312For editors: if you're on Unix you probably have vi or a vi clone
313already, and possibly an emacs too, so you may not need to download
314anything. In any emacs the cperl-mode (M-x cperl-mode) gives you
315perhaps the best available Perl editing mode in any editor.
316
317If you are using Windows, you can use any editor that lets you work
318with plain text, such as NotePad or WordPad. Word processors, such as
319Microsoft Word or WordPerfect, typically do not work since they insert
320all sorts of behind-the-scenes information, although some allow you to
321save files as "Text Only". You can also download text editors designed
322specifically for programming, such as Textpad (
323http://www.textpad.com/ ) and UltraEdit ( http://www.ultraedit.com/ ),
324among others.
325
326If you are using MacOS, the same concerns apply. MacPerl (for Classic
327environments) comes with a simple editor. Popular external editors are
328BBEdit ( http://www.bbedit.com/ ) or Alpha (
329http://www.his.com/~jguyer/Alpha/Alpha8.html ). MacOS X users can use
330Unix editors as well. Neil Bowers (the man behind Geekcruises) has a
331list of Mac editors that can handle Perl (
332http://www.neilbowers.org/macperleditors.html ).
68fbfbd7 333
334=over 4
335
336=item GNU Emacs
337
338http://www.gnu.org/software/emacs/windows/ntemacs.html
339
340=item MicroEMACS
341
49d635f9 342http://www.microemacs.de/
68fbfbd7 343
344=item XEmacs
345
346http://www.xemacs.org/Download/index.html
347
49d635f9 348=item Jed
349
350http://space.mit.edu/~davis/jed/
351
68fbfbd7 352=back
353
354or a vi clone such as
355
356=over 4
357
358=item Elvis
359
360ftp://ftp.cs.pdx.edu/pub/elvis/ http://www.fh-wedel.de/elvis/
361
362=item Vile
363
49d635f9 364http://dickey.his.com/vile/vile.html
68fbfbd7 365
366=item Vim
367
368http://www.vim.org/
369
68fbfbd7 370=back
371
5a13f98a 372For vi lovers in general, Windows or elsewhere:
f05bbc40 373
374 http://www.thomer.com/thomer/vi/vi.html
6641ed39 375
f224927c 376nvi ( http://www.bostic.com/vi/ , available from CPAN in src/misc/) is
5a13f98a 377yet another vi clone, unfortunately not available for Windows, but in
6641ed39 378UNIX platforms you might be interested in trying it out, firstly because
379strictly speaking it is not a vi clone, it is the real vi, or the new
380incarnation of it, and secondly because you can embed Perl inside it
381to use Perl as the scripting language. nvi is not alone in this,
7c82de66 382though: at least also vim and vile offer an embedded Perl.
614a1598 383
68fbfbd7 384The following are Win32 multilanguage editor/IDESs that support Perl:
385
386=over 4
387
388=item Codewright
389
c98c5709 390http://www.borland.com/codewright/
68fbfbd7 391
392=item MultiEdit
393
394http://www.MultiEdit.com/
395
396=item SlickEdit
397
398http://www.slickedit.com/
399
400=back
8782d048 401
6641ed39 402There is also a toyedit Text widget based editor written in Perl
403that is distributed with the Tk module on CPAN. The ptkdb
f224927c 404( http://world.std.com/~aep/ptkdb/ ) is a Perl/tk based debugger that
8782d048 405acts as a development environment of sorts. Perl Composer
49d635f9 406( http://perlcomposer.sourceforge.net/ ) is an IDE for Perl/Tk
e083a89c 407GUI creation.
408
8782d048 409In addition to an editor/IDE you might be interested in a more
68fbfbd7 410powerful shell environment for Win32. Your options include
411
412=over 4
413
414=item Bash
415
1577cd80 416from the Cygwin package ( http://sources.redhat.com/cygwin/ )
68fbfbd7 417
418=item Ksh
419
f224927c 420from the MKS Toolkit ( http://www.mks.com/ ), or the Bourne shell of
1577cd80 421the U/WIN environment ( http://www.research.att.com/sw/tools/uwin/ )
68fbfbd7 422
423=item Tcsh
424
f224927c 425ftp://ftp.astron.com/pub/tcsh/ , see also
68fbfbd7 426http://www.primate.wisc.edu/software/csh-tcsh-book/
427
428=item Zsh
429
ac9dac7f 430http://www.zsh.org/
68fbfbd7 431
432=back
433
614a1598 434MKS and U/WIN are commercial (U/WIN is free for educational and
435research purposes), Cygwin is covered by the GNU Public License (but
436that shouldn't matter for Perl use). The Cygwin, MKS, and U/WIN all
437contain (in addition to the shells) a comprehensive set of standard
438UNIX toolkit utilities.
8782d048 439
5a13f98a 440If you're transferring text files between Unix and Windows using FTP
441be sure to transfer them in ASCII mode so the ends of lines are
442appropriately converted.
443
e083a89c 444On Mac OS the MacPerl Application comes with a simple 32k text editor
445that behaves like a rudimentary IDE. In contrast to the MacPerl Application
733271b5 446the MPW Perl tool can make use of the MPW Shell itself as an editor (with
68fbfbd7 447no 32k limit).
448
449=over 4
450
c98c5709 451=item Affrus
68fbfbd7 452
d7f8936a 453is a full Perl development environment with full debugger support
7678cced 454( http://www.latenightsw.com ).
68fbfbd7 455
456=item Alpha
457
458is an editor, written and extensible in Tcl, that nonetheless has
733271b5 459built in support for several popular markup and programming languages
c98c5709 460including Perl and HTML ( http://www.his.com/~jguyer/Alpha/Alpha8.html ).
461
462=item BBEdit and BBEdit Lite
463
464are text editors for Mac OS that have a Perl sensitivity mode
465( http://web.barebones.com/ ).
466
68fbfbd7 467
468=back
469
470Pepper and Pe are programming language sensitive text editors for Mac
1577cd80 471OS X and BeOS respectively ( http://www.hekkelman.com/ ).
68dc0745 472
473=head2 Where can I get Perl macros for vi?
474
475For a complete version of Tom Christiansen's vi configuration file,
a93751fa 476see http://www.cpan.org/authors/Tom_Christiansen/scripts/toms.exrc.gz ,
a6dd486b 477the standard benchmark file for vi emulators. The file runs best with nvi,
5a964f20 478the current version of vi out of Berkeley, which incidentally can be built
bfeeaf1b 479with an embedded Perl interpreter--see http://www.cpan.org/src/misc/ .
68dc0745 480
481=head2 Where can I get perl-mode for emacs?
482
483Since Emacs version 19 patchlevel 22 or so, there have been both a
87275199 484perl-mode.el and support for the Perl debugger built in. These should
68dc0745 485come with the standard Emacs 19 distribution.
486
87275199 487In the Perl source directory, you'll find a directory called "emacs",
68dc0745 488which contains a cperl-mode that color-codes keywords, provides
489context-sensitive help, and other nifty things.
490
92c2ed05 491Note that the perl-mode of emacs will have fits with C<"main'foo">
d92eb7b0 492(single quote), and mess up the indentation and highlighting. You
65acb1b1 493are probably using C<"main::foo"> in new Perl code anyway, so this
92c2ed05 494shouldn't be an issue.
68dc0745 495
496=head2 How can I use curses with Perl?
497
498The Curses module from CPAN provides a dynamically loadable object
5a964f20 499module interface to a curses library. A small demo can be found at the
49d635f9 500directory http://www.cpan.org/authors/Tom_Christiansen/scripts/rep.gz ;
5a964f20 501this program repeats a command and updates the screen as needed, rendering
502B<rep ps axu> similar to B<top>.
68dc0745 503
504=head2 How can I use X or Tk with Perl?
505
ac9dac7f 506The Tk.pm module is a completely Perl-based, object-oriented interface
507to the Tk toolkit that doesn't force you to use Tcl just to get at Tk.
508Sx is an interface to the Athena Widget set. Both are available from
509CPAN. See the directory
510http://www.cpan.org/modules/by-category/08_User_Interfaces/
68dc0745 511
a6dd486b 512Invaluable for Perl/Tk programming are the Perl/Tk FAQ at
c98c5709 513http://phaseit.net/claird/comp.lang.perl.tk/ptkFAQ.html , the Perl/Tk Reference
92c2ed05 514Guide available at
213329dd 515http://www.cpan.org/authors/Stephen_O_Lidie/ , and the
92c2ed05 516online manpages at
87275199 517http://www-users.cs.umn.edu/%7Eamundson/perl/perltk/toc.html .
92c2ed05 518
68dc0745 519=head2 How can I make my Perl program run faster?
520
92c2ed05 521The best way to do this is to come up with a better algorithm. This
b73a15ae 522can often make a dramatic difference. Jon Bentley's book
5cd0b561 523I<Programming Pearls> (that's not a misspelling!) has some good tips
92c2ed05 524on optimization, too. Advice on benchmarking boils down to: benchmark
525and profile to make sure you're optimizing the right part, look for
526better algorithms instead of microtuning your code, and when all else
57b19278 527fails consider just buying faster hardware. You will probably want to
b432a672 528read the answer to the earlier question "How do I profile my Perl
529programs?" if you haven't done so already.
68dc0745 530
92c2ed05 531A different approach is to autoload seldom-used Perl code. See the
68dc0745 532AutoSplit and AutoLoader modules in the standard distribution for
533that. Or you could locate the bottleneck and think about writing just
534that part in C, the way we used to take bottlenecks in C code and
5cd0b561 535write them in assembler. Similar to rewriting in C, modules that have
536critical sections can be written in C (for instance, the PDL module
537from CPAN).
538
539If you're currently linking your perl executable to a shared
540I<libc.so>, you can often gain a 10-25% performance benefit by
541rebuilding it to link with a static libc.a instead. This will make a
542bigger perl executable, but your Perl programs (and programmers) may
543thank you for it. See the F<INSTALL> file in the source distribution
544for more information.
545
546The undump program was an ancient attempt to speed up Perl program by
547storing the already-compiled form to disk. This is no longer a viable
548option, as it only worked on a few architectures, and wasn't a good
549solution anyway.
68dc0745 550
551=head2 How can I make my Perl program take less memory?
552
553When it comes to time-space tradeoffs, Perl nearly always prefers to
554throw memory at a problem. Scalars in Perl use more memory than
65acb1b1 555strings in C, arrays take more than that, and hashes use even more. While
68dc0745 556there's still a lot to be done, recent releases have been addressing
557these issues. For example, as of 5.004, duplicate hash keys are
558shared amongst all hashes using them, so require no reallocation.
559
560In some cases, using substr() or vec() to simulate arrays can be
561highly beneficial. For example, an array of a thousand booleans will
562take at least 20,000 bytes of space, but it can be turned into one
a6dd486b 563125-byte bit vector--a considerable memory savings. The standard
68dc0745 564Tie::SubstrHash module can also help for certain types of data
565structure. If you're working with specialist data structures
566(matrices, for instance) modules that implement these in C may use
567less memory than equivalent Perl modules.
568
569Another thing to try is learning whether your Perl was compiled with
54310121 570the system malloc or with Perl's builtin malloc. Whichever one it
68dc0745 571is, try using the other one and see whether this makes a difference.
572Information about malloc is in the F<INSTALL> file in the source
573distribution. You can find out whether you are using perl's malloc by
574typing C<perl -V:usemymalloc>.
575
24f1ba9b 576Of course, the best way to save memory is to not do anything to waste
577it in the first place. Good programming practices can go a long way
578toward this:
579
580=over 4
581
582=item * Don't slurp!
583
584Don't read an entire file into memory if you can process it line
585by line. Or more concretely, use a loop like this:
586
587 #
588 # Good Idea
589 #
590 while (<FILE>) {
591 # ...
592 }
593
594instead of this:
595
596 #
597 # Bad Idea
598 #
599 @data = <FILE>;
600 foreach (@data) {
601 # ...
602 }
603
604When the files you're processing are small, it doesn't much matter which
605way you do it, but it makes a huge difference when they start getting
197aec24 606larger.
24f1ba9b 607
bc06af74 608=item * Use map and grep selectively
609
610Remember that both map and grep expect a LIST argument, so doing this:
611
612 @wanted = grep {/pattern/} <FILE>;
613
614will cause the entire file to be slurped. For large files, it's better
615to loop:
616
617 while (<FILE>) {
618 push(@wanted, $_) if /pattern/;
619 }
620
621=item * Avoid unnecessary quotes and stringification
622
623Don't quote large strings unless absolutely necessary:
624
625 my $copy = "$large_string";
626
627makes 2 copies of $large_string (one for $copy and another for the
628quotes), whereas
629
630 my $copy = $large_string;
631
632only makes one copy.
633
634Ditto for stringifying large arrays:
635
636 {
637 local $, = "\n";
638 print @big_array;
639 }
640
641is much more memory-efficient than either
642
643 print join "\n", @big_array;
644
645or
646
647 {
648 local $" = "\n";
649 print "@big_array";
650 }
651
652
24f1ba9b 653=item * Pass by reference
654
655Pass arrays and hashes by reference, not by value. For one thing, it's
656the only way to pass multiple lists or hashes (or both) in a single
657call/return. It also avoids creating a copy of all the contents. This
658requires some judgment, however, because any changes will be propagated
659back to the original data. If you really want to mangle (er, modify) a
660copy, you'll have to sacrifice the memory needed to make one.
661
662=item * Tie large variables to disk.
663
664For "big" data stores (i.e. ones that exceed available memory) consider
665using one of the DB modules to store it on disk instead of in RAM. This
ed8cf1fe 666will incur a penalty in access time, but that's probably better than
24f1ba9b 667causing your hard disk to thrash due to massive swapping.
668
669=back
670
49d635f9 671=head2 Is it safe to return a reference to local or lexical data?
68dc0745 672
49d635f9 673Yes. Perl's garbage collection system takes care of this so
674everything works out right.
68dc0745 675
676 sub makeone {
677 my @a = ( 1 .. 10 );
678 return \@a;
679 }
680
197aec24 681 for ( 1 .. 10 ) {
68dc0745 682 push @many, makeone();
683 }
684
685 print $many[4][5], "\n";
686
687 print "@many\n";
688
689=head2 How can I free an array or hash so my program shrinks?
690
7678cced 691(contributed by Michael Carman)
692
693You usually can't. Memory allocated to lexicals (i.e. my() variables)
694cannot be reclaimed or reused even if they go out of scope. It is
695reserved in case the variables come back into scope. Memory allocated
696to global variables can be reused (within your program) by using
697undef()ing and/or delete().
698
699On most operating systems, memory allocated to a program can never be
700returned to the system. That's why long-running programs sometimes re-
701exec themselves. Some operating systems (notably, systems that use
702mmap(2) for allocating large chunks of memory) can reclaim memory that
703is no longer used, but on such systems, perl must be configured and
704compiled to use the OS's malloc, not perl's.
705
46fc3d4c 706In general, memory allocation and de-allocation isn't something you can
7678cced 707or should be worrying about much in Perl.
708
709See also "How can I make my Perl program take less memory?"
68dc0745 710
711=head2 How can I make my CGI script more efficient?
712
713Beyond the normal measures described to make general Perl programs
714faster or smaller, a CGI program has additional issues. It may be run
715several times per second. Given that each time it runs it will need
46fc3d4c 716to be re-compiled and will often allocate a megabyte or more of system
68dc0745 717memory, this can be a killer. Compiling into C B<isn't going to help
46fc3d4c 718you> because the process start-up overhead is where the bottleneck is.
68dc0745 719
92c2ed05 720There are two popular ways to avoid this overhead. One solution
721involves running the Apache HTTP server (available from
f224927c 722http://www.apache.org/ ) with either of the mod_perl or mod_fastcgi
92c2ed05 723plugin modules.
724
725With mod_perl and the Apache::Registry module (distributed with
726mod_perl), httpd will run with an embedded Perl interpreter which
727pre-compiles your script and then executes it within the same address
728space without forking. The Apache extension also gives Perl access to
729the internal server API, so modules written in Perl can do just about
730anything a module written in C can. For more on mod_perl, see
731http://perl.apache.org/
732
65acb1b1 733With the FCGI module (from CPAN) and the mod_fastcgi
bfeeaf1b 734module (available from http://www.fastcgi.com/ ) each of your Perl
87275199 735programs becomes a permanent CGI daemon process.
68dc0745 736
737Both of these solutions can have far-reaching effects on your system
87275199 738and on the way you write your CGI programs, so investigate them with
68dc0745 739care.
740
a93751fa 741See http://www.cpan.org/modules/by-category/15_World_Wide_Web_HTML_HTTP_CGI/ .
5a964f20 742
68dc0745 743=head2 How can I hide the source for my Perl program?
744
745Delete it. :-) Seriously, there are a number of (mostly
b432a672 746unsatisfactory) solutions with varying levels of "security".
68dc0745 747
748First of all, however, you I<can't> take away read permission, because
749the source code has to be readable in order to be compiled and
750interpreted. (That doesn't mean that a CGI script's source is
a6dd486b 751readable by people on the web, though--only by people with access to
752the filesystem.) So you have to leave the permissions at the socially
92c2ed05 753friendly 0755 level.
68dc0745 754
755Some people regard this as a security problem. If your program does
a6dd486b 756insecure things and relies on people not knowing how to exploit those
68dc0745 757insecurities, it is not secure. It is often possible for someone to
758determine the insecure things and exploit them without viewing the
759source. Security through obscurity, the name for hiding your bugs
760instead of fixing them, is little security indeed.
761
83df6a1d 762You can try using encryption via source filters (Starting from Perl
7635.8 the Filter::Simple and Filter::Util::Call modules are included in
764the standard distribution), but any decent programmer will be able to
765decrypt it. You can try using the byte code compiler and interpreter
ac9dac7f 766described later in L<perlfaq3>, but the curious might still be able to
767de-compile it. You can try using the native-code compiler described
768later, but crackers might be able to disassemble it. These pose
769varying degrees of difficulty to people wanting to get at your code,
770but none can definitively conceal it (true of every language, not just
771Perl).
68dc0745 772
49d635f9 773It is very easy to recover the source of Perl programs. You simply
774feed the program to the perl interpreter and use the modules in
775the B:: hierarchy. The B::Deparse module should be able to
776defeat most attempts to hide source. Again, this is not
777unique to Perl.
778
68dc0745 779If you're concerned about people profiting from your code, then the
d92eb7b0 780bottom line is that nothing but a restrictive license will give you
68dc0745 781legal security. License your software and pepper it with threatening
b432a672 782statements like "This is unpublished proprietary software of XYZ Corp.
68dc0745 783Your access to it does not give you permission to use it blah blah
b432a672 784blah." We are not lawyers, of course, so you should see a lawyer if
d92eb7b0 785you want to be sure your license's wording will stand up in court.
68dc0745 786
54310121 787=head2 How can I compile my Perl program into byte code or C?
68dc0745 788
7678cced 789(contributed by brian d foy)
790
791In general, you can't do this. There are some things that may work
792for your situation though. People usually ask this question
6670e5e7 793because they want to distribute their works without giving away
7678cced 794the source code, and most solutions trade disk space for convenience.
795You probably won't see much of a speed increase either, since most
6670e5e7 796solutions simply bundle a Perl interpreter in the final product
7678cced 797(but see L<How can I make my Perl program run faster?>).
798
ac9dac7f 799The Perl Archive Toolkit ( http://par.perl.org/ ) is Perl's
9e72e4c6 800analog to Java's JAR. It's freely available and on CPAN (
801http://search.cpan.org/dist/PAR/ ).
7678cced 802
9e72e4c6 803There are also some commercial products that may work for you, although
804you have to buy a license for them.
7678cced 805
9e72e4c6 806The Perl Dev Kit ( http://www.activestate.com/Products/Perl_Dev_Kit/ )
807from ActiveState can "Turn your Perl programs into ready-to-run
7678cced 808executables for HP-UX, Linux, Solaris and Windows."
809
9e72e4c6 810Perl2Exe ( http://www.indigostar.com/perl2exe.htm ) is a command line
811program for converting perl scripts to executable files. It targets both
812Windows and unix platforms.
5a964f20 813
92c2ed05 814=head2 How can I get C<#!perl> to work on [MS-DOS,NT,...]?
68dc0745 815
816For OS/2 just use
817
818 extproc perl -S -your_switches
819
820as the first line in C<*.cmd> file (C<-S> due to a bug in cmd.exe's
b432a672 821"extproc" handling). For DOS one should first invent a corresponding
fd1adc71 822batch file and codify it in C<ALTERNATE_SHEBANG> (see the
823F<dosish.h> file in the source distribution for more information).
68dc0745 824
92c2ed05 825The Win95/NT installation, when using the ActiveState port of Perl,
826will modify the Registry to associate the C<.pl> extension with the
d92eb7b0 827perl interpreter. If you install another port, perhaps even building
828your own Win95/NT Perl from the standard sources by using a Windows port
d702ae42 829of gcc (e.g., with cygwin or mingw32), then you'll have to modify
d92eb7b0 830the Registry yourself. In addition to associating C<.pl> with the
831interpreter, NT people can use: C<SET PATHEXT=%PATHEXT%;.PL> to let them
832run the program C<install-linux.pl> merely by typing C<install-linux>.
68dc0745 833
8e30f651 834Under "Classic" MacOS, a perl program will have the appropriate Creator and
835Type, so that double-clicking them will invoke the MacPerl application.
836Under Mac OS X, clickable apps can be made from any C<#!> script using Wil
837Sanchez' DropScript utility: http://www.wsanchez.net/software/ .
68dc0745 838
839I<IMPORTANT!>: Whatever you do, PLEASE don't get frustrated, and just
840throw the perl interpreter into your cgi-bin directory, in order to
87275199 841get your programs working for a web server. This is an EXTREMELY big
68dc0745 842security risk. Take the time to figure out how to do it correctly.
843
87275199 844=head2 Can I write useful Perl programs on the command line?
68dc0745 845
846Yes. Read L<perlrun> for more information. Some examples follow.
847(These assume standard Unix shell quoting rules.)
848
849 # sum first and last fields
5a964f20 850 perl -lane 'print $F[0] + $F[-1]' *
68dc0745 851
852 # identify text files
853 perl -le 'for(@ARGV) {print if -f && -T _}' *
854
5a964f20 855 # remove (most) comments from C program
68dc0745 856 perl -0777 -pe 's{/\*.*?\*/}{}gs' foo.c
857
858 # make file a month younger than today, defeating reaper daemons
859 perl -e '$X=24*60*60; utime(time(),time() + 30 * $X,@ARGV)' *
860
861 # find first unused uid
862 perl -le '$i++ while getpwuid($i); print $i'
863
864 # display reasonable manpath
865 echo $PATH | perl -nl -072 -e '
866 s![^/+]*$!man!&&-d&&!$s{$_}++&&push@m,$_;END{print"@m"}'
867
87275199 868OK, the last one was actually an Obfuscated Perl Contest entry. :-)
68dc0745 869
87275199 870=head2 Why don't Perl one-liners work on my DOS/Mac/VMS system?
68dc0745 871
872The problem is usually that the command interpreters on those systems
873have rather different ideas about quoting than the Unix shells under
874which the one-liners were created. On some systems, you may have to
875change single-quotes to double ones, which you must I<NOT> do on Unix
876or Plan9 systems. You might also have to change a single % to a %%.
877
878For example:
879
e573f903 880 # Unix (including Mac OS X)
68dc0745 881 perl -e 'print "Hello world\n"'
882
46fc3d4c 883 # DOS, etc.
68dc0745 884 perl -e "print \"Hello world\n\""
885
e573f903 886 # Mac Classic
68dc0745 887 print "Hello world\n"
888 (then Run "Myscript" or Shift-Command-R)
889
d2321c93 890 # MPW
891 perl -e 'print "Hello world\n"'
892
68dc0745 893 # VMS
894 perl -e "print ""Hello world\n"""
895
a6dd486b 896The problem is that none of these examples are reliable: they depend on the
92c2ed05 897command interpreter. Under Unix, the first two often work. Under DOS,
a6dd486b 898it's entirely possible that neither works. If 4DOS was the command shell,
92c2ed05 899you'd probably have better luck like this:
68dc0745 900
901 perl -e "print <Ctrl-x>"Hello world\n<Ctrl-x>""
902
46fc3d4c 903Under the Mac, it depends which environment you are using. The MacPerl
68dc0745 904shell, or MPW, is much like Unix shells in its support for several
46fc3d4c 905quoting variants, except that it makes free use of the Mac's non-ASCII
68dc0745 906characters as control characters.
907
65acb1b1 908Using qq(), q(), and qx(), instead of "double quotes", 'single
909quotes', and `backticks`, may make one-liners easier to write.
910
d2321c93 911There is no general solution to all of this. It is a mess.
68dc0745 912
913[Some of this answer was contributed by Kenneth Albanowski.]
914
915=head2 Where can I learn about CGI or Web programming in Perl?
916
917For modules, get the CGI or LWP modules from CPAN. For textbooks,
918see the two especially dedicated to web stuff in the question on
b432a672 919books. For problems and questions related to the web, like "Why
920do I get 500 Errors" or "Why doesn't it run from the browser right
921when it runs fine on the command line", see the troubleshooting
8305e449 922guides and references in L<perlfaq9> or in the CGI MetaFAQ:
68dc0745 923
8305e449 924 http://www.perl.org/CGI_MetaFAQ.html
0f542199 925
68dc0745 926=head2 Where can I learn about object-oriented Perl programming?
927
a6dd486b 928A good place to start is L<perltoot>, and you can use L<perlobj>,
06a5f41f 929L<perlboot>, L<perltoot>, L<perltooc>, and L<perlbot> for reference.
06a5f41f 930
931A good book on OO on Perl is the "Object-Oriented Perl"
e573f903 932by Damian Conway from Manning Publications, or "Intermediate Perl"
ac9dac7f 933by Randal Schwartz, brian d foy, and Tom Phoenix from O'Reilly Media.
68dc0745 934
b68463f7 935=head2 Where can I learn about linking C with Perl?
68dc0745 936
937If you want to call C from Perl, start with L<perlxstut>,
938moving on to L<perlxs>, L<xsubpp>, and L<perlguts>. If you want to
939call Perl from C, then read L<perlembed>, L<perlcall>, and
940L<perlguts>. Don't forget that you can learn a lot from looking at
941how the authors of existing extension modules wrote their code and
942solved their problems.
943
b68463f7 944You might not need all the power of XS. The Inline::C module lets
945you put C code directly in your Perl source. It handles all the
58103a2e 946magic to make it work. You still have to learn at least some of
b68463f7 947the perl API but you won't have to deal with the complexity of the
948XS support files.
949
7678cced 950=head2 I've read perlembed, perlguts, etc., but I can't embed perl in my C program; what am I doing wrong?
68dc0745 951
952Download the ExtUtils::Embed kit from CPAN and run `make test'. If
953the tests pass, read the pods again and again and again. If they
87275199 954fail, see L<perlbug> and send a bug report with the output of
68dc0745 955C<make test TEST_VERBOSE=1> along with C<perl -V>.
956
83ded9ee 957=head2 When I tried to run my script, I got this message. What does it mean?
68dc0745 958
87275199 959A complete list of Perl's error messages and warnings with explanatory
960text can be found in L<perldiag>. You can also use the splain program
961(distributed with Perl) to explain the error messages:
68dc0745 962
963 perl program 2>diag.out
964 splain [-v] [-p] diag.out
965
966or change your program to explain the messages for you:
967
968 use diagnostics;
969
970or
971
972 use diagnostics -verbose;
973
974=head2 What's MakeMaker?
975
ac9dac7f 976(contributed by brian d foy)
977
978The C<ExtUtils::MakeMaker> module, better known simply as "MakeMaker",
979turns a Perl script, typically called C<Makefile.PL>, into a Makefile.
980The unix tool C<make> uses this file to manage dependencies and actions
981to process and install a Perl distribution.
68dc0745 982
500071f4 983=head1 REVISION
984
ee891a00 985Revision: $Revision: 8539 $
500071f4 986
f449fe8a 987Date: $Date: 2007-01-11 00:07:14 +0100 (Thu, 11 Jan 2007) $
500071f4 988
989See L<perlfaq> for source control details and availability.
990
68dc0745 991=head1 AUTHOR AND COPYRIGHT
992
ee891a00 993Copyright (c) 1997-2007 Tom Christiansen, Nathan Torkington, and
7678cced 994other authors as noted. All rights reserved.
5a964f20 995
5a7beb56 996This documentation is free; you can redistribute it and/or modify it
997under the same terms as Perl itself.
c8db1d39 998
87275199 999Irrespective of its distribution, all code examples here are in the public
c8db1d39 1000domain. You are permitted and encouraged to use this code and any
1001derivatives thereof in your own programs for fun or for profit as you
1002see fit. A simple comment in the code giving credit to the FAQ would
1003be courteous but is not required.