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