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