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