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