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