Commit | Line | Data |
---|---|---|
68dc0745 | 1 | =head1 NAME |
2 | ||
d92eb7b0 | 3 | perlfaq3 - Programming Tools ($Revision: 1.38 $, $Date: 1999/05/23 16:08:30 $) |
68dc0745 | 4 | |
5 | =head1 DESCRIPTION | |
6 | ||
7 | This section of the FAQ answers questions related to programmer tools | |
8 | and programming support. | |
9 | ||
10 | =head2 How do I do (anything)? | |
11 | ||
12 | Have you looked at CPAN (see L<perlfaq2>)? The chances are that | |
13 | someone has already written a module that can solve your problem. | |
46fc3d4c | 14 | Have you read the appropriate man pages? 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 | |
25 | Various http://www.perl.com/CPAN/doc/FMTEYEWTK/index.html | |
26 | (not a man-page but still useful) | |
27 | ||
87275199 | 28 | A crude table of contents for the Perl man page set is found in L<perltoc>. |
68dc0745 | 29 | |
30 | =head2 How can I use Perl interactively? | |
31 | ||
32 | The typical approach uses the Perl debugger, described in the | |
92c2ed05 | 33 | perldebug(1) man page, on an ``empty'' program, like this: |
68dc0745 | 34 | |
35 | perl -de 42 | |
36 | ||
37 | Now just type in any legal Perl code, and it will be immediately | |
38 | evaluated. You can also examine the symbol table, get stack | |
39 | backtraces, check variable values, set breakpoints, and other | |
92c2ed05 | 40 | operations typically found in symbolic debuggers. |
68dc0745 | 41 | |
42 | =head2 Is there a Perl shell? | |
43 | ||
87275199 GS |
44 | In general, no. The Shell.pm module (distributed with Perl) makes |
45 | Perl try commands which aren't part of the Perl language as shell | |
68dc0745 | 46 | commands. perlsh from the source distribution is simplistic and |
47 | uninteresting, but may still be what you want. | |
48 | ||
49 | =head2 How do I debug my Perl programs? | |
50 | ||
9f1b1f2d | 51 | Have you tried C<use warnings> or used C<-w>? They enable warnings |
a6dd486b | 52 | to detect dubious practices. |
68dc0745 | 53 | |
92c2ed05 GS |
54 | Have you tried C<use strict>? It prevents you from using symbolic |
55 | references, makes you predeclare any subroutines that you call as bare | |
56 | words, and (probably most importantly) forces you to predeclare your | |
a6dd486b | 57 | variables with C<my>, C<our>, or C<use vars>. |
68dc0745 | 58 | |
a6dd486b JB |
59 | Did you check the return values of each and every system call? The operating |
60 | system (and thus Perl) tells you whether they worked, and if not | |
92c2ed05 | 61 | why. |
68dc0745 | 62 | |
92c2ed05 GS |
63 | open(FH, "> /etc/cantwrite") |
64 | or die "Couldn't write to /etc/cantwrite: $!\n"; | |
68dc0745 | 65 | |
92c2ed05 | 66 | Did you read L<perltrap>? It's full of gotchas for old and new Perl |
a6dd486b | 67 | programmers and even has sections for those of you who are upgrading |
92c2ed05 GS |
68 | from languages like I<awk> and I<C>. |
69 | ||
70 | Have you tried the Perl debugger, described in L<perldebug>? You can | |
71 | step through your program and see what it's doing and thus work out | |
72 | why what it's doing isn't what it should be doing. | |
68dc0745 | 73 | |
74 | =head2 How do I profile my Perl programs? | |
75 | ||
e083a89c | 76 | You should get the Devel::DProf module from the standard distribution |
733271b5 PK |
77 | (or separately on CPAN) and also use Benchmark.pm from the standard |
78 | distribution. The Benchmark module lets you time specific portions of | |
79 | your code, while Devel::DProf gives detailed breakdowns of where your | |
e083a89c | 80 | code spends its time. |
68dc0745 | 81 | |
92c2ed05 GS |
82 | Here's a sample use of Benchmark: |
83 | ||
84 | use Benchmark; | |
85 | ||
86 | @junk = `cat /etc/motd`; | |
87 | $count = 10_000; | |
88 | ||
89 | timethese($count, { | |
90 | 'map' => sub { my @a = @junk; | |
91 | map { s/a/b/ } @a; | |
92 | return @a | |
93 | }, | |
94 | 'for' => sub { my @a = @junk; | |
95 | local $_; | |
96 | for (@a) { s/a/b/ }; | |
97 | return @a }, | |
98 | }); | |
99 | ||
100 | This is what it prints (on one machine--your results will be dependent | |
101 | on your hardware, operating system, and the load on your machine): | |
102 | ||
103 | Benchmark: timing 10000 iterations of for, map... | |
104 | for: 4 secs ( 3.97 usr 0.01 sys = 3.98 cpu) | |
105 | map: 6 secs ( 4.97 usr 0.00 sys = 4.97 cpu) | |
106 | ||
65acb1b1 | 107 | Be aware that a good benchmark is very hard to write. It only tests the |
a6dd486b | 108 | data you give it and proves little about the differing complexities |
65acb1b1 TC |
109 | of contrasting algorithms. |
110 | ||
68dc0745 | 111 | =head2 How do I cross-reference my Perl programs? |
112 | ||
113 | The B::Xref module, shipped with the new, alpha-release Perl compiler | |
5a964f20 TC |
114 | (not the general distribution prior to the 5.005 release), can be used |
115 | to generate cross-reference reports for Perl programs. | |
68dc0745 | 116 | |
c8db1d39 | 117 | perl -MO=Xref[,OPTIONS] scriptname.plx |
68dc0745 | 118 | |
119 | =head2 Is there a pretty-printer (formatter) for Perl? | |
120 | ||
92c2ed05 GS |
121 | There is no program that will reformat Perl as much as indent(1) does |
122 | for C. The complex feedback between the scanner and the parser (this | |
123 | feedback is what confuses the vgrind and emacs programs) makes it | |
68dc0745 | 124 | challenging at best to write a stand-alone Perl parser. |
125 | ||
126 | Of course, if you simply follow the guidelines in L<perlstyle>, you | |
92c2ed05 GS |
127 | shouldn't need to reformat. The habit of formatting your code as you |
128 | write it will help prevent bugs. Your editor can and should help you | |
a6dd486b JB |
129 | with this. The perl-mode or newer cperl-mode for emacs can provide |
130 | remarkable amounts of help with most (but not all) code, and even less | |
131 | programmable editors can provide significant assistance. Tom swears | |
132 | by the following settings in vi and its clones: | |
65acb1b1 TC |
133 | |
134 | set ai sw=4 | |
d92eb7b0 | 135 | map! ^O {^M}^[O^T |
65acb1b1 TC |
136 | |
137 | Now put that in your F<.exrc> file (replacing the caret characters | |
138 | with control characters) and away you go. In insert mode, ^T is | |
a6dd486b | 139 | for indenting, ^D is for undenting, and ^O is for blockdenting-- |
65acb1b1 TC |
140 | as it were. If you haven't used the last one, you're missing |
141 | a lot. A more complete example, with comments, can be found at | |
142 | http://www.perl.com/CPAN-local/authors/id/TOMC/scripts/toms.exrc.gz | |
92c2ed05 | 143 | |
65acb1b1 | 144 | If you are used to using the I<vgrind> program for printing out nice code |
92c2ed05 | 145 | to a laser printer, you can take a stab at this using |
68dc0745 | 146 | http://www.perl.com/CPAN/doc/misc/tips/working.vgrind.entry, but the |
147 | results are not particularly satisfying for sophisticated code. | |
148 | ||
87275199 | 149 | The a2ps at http://www.infres.enst.fr/%7Edemaille/a2ps/ does lots of things |
65acb1b1 TC |
150 | related to generating nicely printed output of documents. |
151 | ||
d92eb7b0 | 152 | =head2 Is there a ctags for Perl? |
68dc0745 | 153 | |
d92eb7b0 | 154 | There's a simple one at |
68dc0745 | 155 | http://www.perl.com/CPAN/authors/id/TOMC/scripts/ptags.gz which may do |
65acb1b1 TC |
156 | the trick. And if not, it's easy to hack into what you want. |
157 | ||
158 | =head2 Is there an IDE or Windows Perl Editor? | |
159 | ||
6641ed39 JH |
160 | Perl programs are just plain text, so any editor will do. |
161 | ||
162 | If you're transferring Windows text files to Unix using FTP be sure | |
163 | to transfer them in ASCII mode so the ends of lines are appropriately | |
164 | converted. | |
165 | ||
166 | If you're on Unix, you already have an IDE--Unix itself. The UNIX | |
167 | philosophy is the philosophy of several small tools that each do one | |
168 | thing and do it well. It's like a carpenter's toolbox. | |
169 | ||
170 | For Windows: PerlBuilder (http://www.solutionsoft.com/perl.htm) is | |
171 | an integrated development environment for Windows that supports Perl | |
172 | development. Komodo, ActiveState's cross-platform, multi-language IDE | |
173 | has Perl support, including a regular expression debugger and remote | |
174 | debugging (http://www.ActiveState.com/Products/Komodo/index.html). | |
175 | (Visual Perl, a Visual Studio.NET plug-in is currently in beta | |
176 | (late 2000) (http://www.ActiveState.com/Products/VisualPerl/index.html)). | |
12134a58 | 177 | The visiPerl+ IDE is available from Help Consulting |
6641ed39 JH |
178 | (http://helpconsulting.net/visiperl/). Perl code magic is another IDE |
179 | (http://www.petes-place.com/codemagic.html). CodeMagicCD | |
12134a58 | 180 | (http://www.codemagiccd.com/) is another IDE. The Object System |
8782d048 | 181 | (http://www.castlelink.co.uk/object_system/) is a Perl web |
614a1598 | 182 | applications development IDE. |
8782d048 | 183 | |
6641ed39 JH |
184 | Editors: if you're on Unix you probably have vi or a vi clone already, |
185 | and possibly an emacs too, so you may not need to download anything. | |
186 | In anyemacs the cperl-mode (M-x cperl-mode) gives you perhaps the | |
187 | best available Perl editing mode in any editor. | |
188 | ||
189 | In Windows: you can download GNU Emacs | |
190 | (http://www.gnu.org/software/emacs/windows/ntemacs.html) or XEmacs | |
191 | (http://www.xemacs.org/Download/index.html), or a vi clone such as | |
192 | Elvis (ftp://ftp.cs.pdx.edu/pub/elvis/, http://www.fh-wedel.de/elvis/), | |
193 | Vile (http://www.clark.net/pub/dickey/vile/vile.html), or | |
194 | Vim (http://www.vim.org/) (win32: http://www.cs.vu.nl/%7Etmgil/vi.html). | |
195 | For vi lovers in general: http://www.thomer.com/thomer/vi/vi.html | |
196 | ||
197 | nvi (http://www.bostic.com/vi/, available from CPAN in src/misc/) is | |
198 | yet another vi clone, not unfortunately available for Windows, but in | |
199 | UNIX platforms you might be interested in trying it out, firstly because | |
200 | strictly speaking it is not a vi clone, it is the real vi, or the new | |
201 | incarnation of it, and secondly because you can embed Perl inside it | |
202 | to use Perl as the scripting language. nvi is not alone in this, | |
203 | though: at least also vim offers an embedded Perl. | |
614a1598 JH |
204 | |
205 | The following are Win32 multilanguage editor/IDESs that support Perl: | |
206 | Codewright (http://www.starbase.com/), MultiEdit (http://www.MultiEdit.com/), | |
207 | SlickEdit (http://www.slickedit.com/). | |
8782d048 | 208 | |
6641ed39 JH |
209 | There is also a toyedit Text widget based editor written in Perl |
210 | that is distributed with the Tk module on CPAN. The ptkdb | |
8782d048 JH |
211 | (http://world.std.com/~aep/ptkdb/) is a Perl/tk based debugger that |
212 | acts as a development environment of sorts. Perl Composer | |
e083a89c JH |
213 | (http://perlcomposer.sourceforge.net/vperl.html) is an IDE for Perl/Tk |
214 | GUI creation. | |
215 | ||
8782d048 JH |
216 | In addition to an editor/IDE you might be interested in a more |
217 | powerful shell environment for Win32. Your options include the Bash | |
218 | from the Cygwin package (http://sources.redhat.com/cygwin/), or the | |
219 | Ksh from the MKS Toolkit (http://www.mks.com/), or the Bourne shell of | |
220 | the U/WIN environment (http://www.research.att.com/sw/tools/uwin/), or | |
614a1598 JH |
221 | the Tcsh (ftp://ftp.astron.com/pub/tcsh/, see also |
222 | http://www.primate.wisc.edu/software/csh-tcsh-book/), or the Zsh | |
223 | (ftp://ftp.blarg.net/users/amol/zsh/, see also http://www.zsh.org/). | |
224 | MKS and U/WIN are commercial (U/WIN is free for educational and | |
225 | research purposes), Cygwin is covered by the GNU Public License (but | |
226 | that shouldn't matter for Perl use). The Cygwin, MKS, and U/WIN all | |
227 | contain (in addition to the shells) a comprehensive set of standard | |
228 | UNIX toolkit utilities. | |
8782d048 | 229 | |
e083a89c JH |
230 | On Mac OS the MacPerl Application comes with a simple 32k text editor |
231 | that behaves like a rudimentary IDE. In contrast to the MacPerl Application | |
733271b5 | 232 | the MPW Perl tool can make use of the MPW Shell itself as an editor (with |
e083a89c | 233 | no 32k limit). BBEdit and BBEdit Lite are text editors for Mac OS |
733271b5 PK |
234 | that have a Perl sensitivity mode (http://web.barebones.com/). |
235 | Alpha is an editor, written and extensible in Tcl, that nonetheless has | |
236 | built in support for several popular markup and programming languages | |
237 | including Perl and HTML (http://alpha.olm.net/). | |
68dc0745 | 238 | |
239 | =head2 Where can I get Perl macros for vi? | |
240 | ||
241 | For a complete version of Tom Christiansen's vi configuration file, | |
a6dd486b JB |
242 | see http://www.perl.com/CPAN/authors/Tom_Christiansen/scripts/toms.exrc.gz , |
243 | the standard benchmark file for vi emulators. The file runs best with nvi, | |
5a964f20 | 244 | the current version of vi out of Berkeley, which incidentally can be built |
a6dd486b | 245 | with an embedded Perl interpreter--see http://www.perl.com/CPAN/src/misc. |
68dc0745 | 246 | |
247 | =head2 Where can I get perl-mode for emacs? | |
248 | ||
249 | Since Emacs version 19 patchlevel 22 or so, there have been both a | |
87275199 | 250 | perl-mode.el and support for the Perl debugger built in. These should |
68dc0745 | 251 | come with the standard Emacs 19 distribution. |
252 | ||
87275199 | 253 | In the Perl source directory, you'll find a directory called "emacs", |
68dc0745 | 254 | which contains a cperl-mode that color-codes keywords, provides |
255 | context-sensitive help, and other nifty things. | |
256 | ||
92c2ed05 | 257 | Note that the perl-mode of emacs will have fits with C<"main'foo"> |
d92eb7b0 | 258 | (single quote), and mess up the indentation and highlighting. You |
65acb1b1 | 259 | are probably using C<"main::foo"> in new Perl code anyway, so this |
92c2ed05 | 260 | shouldn't be an issue. |
68dc0745 | 261 | |
262 | =head2 How can I use curses with Perl? | |
263 | ||
264 | The Curses module from CPAN provides a dynamically loadable object | |
5a964f20 TC |
265 | module interface to a curses library. A small demo can be found at the |
266 | directory http://www.perl.com/CPAN/authors/Tom_Christiansen/scripts/rep; | |
267 | this program repeats a command and updates the screen as needed, rendering | |
268 | B<rep ps axu> similar to B<top>. | |
68dc0745 | 269 | |
270 | =head2 How can I use X or Tk with Perl? | |
271 | ||
5a964f20 TC |
272 | Tk is a completely Perl-based, object-oriented interface to the Tk toolkit |
273 | that doesn't force you to use Tcl just to get at Tk. Sx is an interface | |
274 | to the Athena Widget set. Both are available from CPAN. See the | |
275 | directory http://www.perl.com/CPAN/modules/by-category/08_User_Interfaces/ | |
68dc0745 | 276 | |
a6dd486b | 277 | Invaluable for Perl/Tk programming are the Perl/Tk FAQ at |
87275199 | 278 | http://w4.lns.cornell.edu/%7Epvhp/ptk/ptkTOC.html , the Perl/Tk Reference |
92c2ed05 GS |
279 | Guide available at |
280 | http://www.perl.com/CPAN-local/authors/Stephen_O_Lidie/ , and the | |
281 | online manpages at | |
87275199 | 282 | http://www-users.cs.umn.edu/%7Eamundson/perl/perltk/toc.html . |
92c2ed05 | 283 | |
68dc0745 | 284 | =head2 How can I generate simple menus without using CGI or Tk? |
285 | ||
286 | The http://www.perl.com/CPAN/authors/id/SKUNZ/perlmenu.v4.0.tar.gz | |
287 | module, which is curses-based, can help with this. | |
288 | ||
68dc0745 | 289 | =head2 What is undump? |
290 | ||
a6dd486b | 291 | See the next question on ``How can I make my Perl program run faster?'' |
68dc0745 | 292 | |
293 | =head2 How can I make my Perl program run faster? | |
294 | ||
92c2ed05 | 295 | The best way to do this is to come up with a better algorithm. This |
b73a15ae | 296 | can often make a dramatic difference. Jon Bentley's book |
92c2ed05 GS |
297 | ``Programming Pearls'' (that's not a misspelling!) has some good tips |
298 | on optimization, too. Advice on benchmarking boils down to: benchmark | |
299 | and profile to make sure you're optimizing the right part, look for | |
300 | better algorithms instead of microtuning your code, and when all else | |
301 | fails consider just buying faster hardware. | |
68dc0745 | 302 | |
92c2ed05 | 303 | A different approach is to autoload seldom-used Perl code. See the |
68dc0745 | 304 | AutoSplit and AutoLoader modules in the standard distribution for |
305 | that. Or you could locate the bottleneck and think about writing just | |
306 | that part in C, the way we used to take bottlenecks in C code and | |
a6dd486b JB |
307 | write them in assembler. Similar to rewriting in C, |
308 | modules that have critical sections can be written in C (for instance, the | |
68dc0745 | 309 | PDL module from CPAN). |
310 | ||
311 | In some cases, it may be worth it to use the backend compiler to | |
312 | produce byte code (saving compilation time) or compile into C, which | |
313 | will certainly save compilation time and sometimes a small amount (but | |
314 | not much) execution time. See the question about compiling your Perl | |
92c2ed05 GS |
315 | programs for more on the compiler--the wins aren't as obvious as you'd |
316 | hope. | |
68dc0745 | 317 | |
92c2ed05 | 318 | If you're currently linking your perl executable to a shared I<libc.so>, |
68dc0745 | 319 | you can often gain a 10-25% performance benefit by rebuilding it to |
320 | link with a static libc.a instead. This will make a bigger perl | |
321 | executable, but your Perl programs (and programmers) may thank you for | |
322 | it. See the F<INSTALL> file in the source distribution for more | |
323 | information. | |
324 | ||
325 | Unsubstantiated reports allege that Perl interpreters that use sfio | |
87275199 | 326 | outperform those that don't (for I/O intensive applications). To try |
68dc0745 | 327 | this, see the F<INSTALL> file in the source distribution, especially |
87275199 | 328 | the ``Selecting File I/O mechanisms'' section. |
68dc0745 | 329 | |
330 | The undump program was an old attempt to speed up your Perl program | |
331 | by storing the already-compiled form to disk. This is no longer | |
332 | a viable option, as it only worked on a few architectures, and | |
333 | wasn't a good solution anyway. | |
334 | ||
335 | =head2 How can I make my Perl program take less memory? | |
336 | ||
337 | When it comes to time-space tradeoffs, Perl nearly always prefers to | |
338 | throw memory at a problem. Scalars in Perl use more memory than | |
65acb1b1 | 339 | strings in C, arrays take more than that, and hashes use even more. While |
68dc0745 | 340 | there's still a lot to be done, recent releases have been addressing |
341 | these issues. For example, as of 5.004, duplicate hash keys are | |
342 | shared amongst all hashes using them, so require no reallocation. | |
343 | ||
344 | In some cases, using substr() or vec() to simulate arrays can be | |
345 | highly beneficial. For example, an array of a thousand booleans will | |
346 | take at least 20,000 bytes of space, but it can be turned into one | |
a6dd486b | 347 | 125-byte bit vector--a considerable memory savings. The standard |
68dc0745 | 348 | Tie::SubstrHash module can also help for certain types of data |
349 | structure. If you're working with specialist data structures | |
350 | (matrices, for instance) modules that implement these in C may use | |
351 | less memory than equivalent Perl modules. | |
352 | ||
353 | Another thing to try is learning whether your Perl was compiled with | |
54310121 | 354 | the system malloc or with Perl's builtin malloc. Whichever one it |
68dc0745 | 355 | is, try using the other one and see whether this makes a difference. |
356 | Information about malloc is in the F<INSTALL> file in the source | |
357 | distribution. You can find out whether you are using perl's malloc by | |
358 | typing C<perl -V:usemymalloc>. | |
359 | ||
360 | =head2 Is it unsafe to return a pointer to local data? | |
361 | ||
362 | No, Perl's garbage collection system takes care of this. | |
363 | ||
364 | sub makeone { | |
365 | my @a = ( 1 .. 10 ); | |
366 | return \@a; | |
367 | } | |
368 | ||
369 | for $i ( 1 .. 10 ) { | |
370 | push @many, makeone(); | |
371 | } | |
372 | ||
373 | print $many[4][5], "\n"; | |
374 | ||
375 | print "@many\n"; | |
376 | ||
377 | =head2 How can I free an array or hash so my program shrinks? | |
378 | ||
c8db1d39 TC |
379 | You can't. On most operating systems, memory allocated to a program |
380 | can never be returned to the system. That's why long-running programs | |
65acb1b1 TC |
381 | sometimes re-exec themselves. Some operating systems (notably, |
382 | FreeBSD and Linux) allegedly reclaim large chunks of memory that is no | |
383 | longer used, but it doesn't appear to happen with Perl (yet). The Mac | |
384 | appears to be the only platform that will reliably (albeit, slowly) | |
385 | return memory to the OS. | |
386 | ||
387 | We've had reports that on Linux (Redhat 5.1) on Intel, C<undef | |
388 | $scalar> will return memory to the system, while on Solaris 2.6 it | |
389 | won't. In general, try it yourself and see. | |
68dc0745 | 390 | |
391 | However, judicious use of my() on your variables will help make sure | |
a6dd486b | 392 | that they go out of scope so that Perl can free up that space for |
92c2ed05 | 393 | use in other parts of your program. A global variable, of course, never |
68dc0745 | 394 | goes out of scope, so you can't get its space automatically reclaimed, |
395 | although undef()ing and/or delete()ing it will achieve the same effect. | |
46fc3d4c | 396 | In general, memory allocation and de-allocation isn't something you can |
68dc0745 | 397 | or should be worrying about much in Perl, but even this capability |
398 | (preallocation of data types) is in the works. | |
399 | ||
400 | =head2 How can I make my CGI script more efficient? | |
401 | ||
402 | Beyond the normal measures described to make general Perl programs | |
403 | faster or smaller, a CGI program has additional issues. It may be run | |
404 | several times per second. Given that each time it runs it will need | |
46fc3d4c | 405 | to be re-compiled and will often allocate a megabyte or more of system |
68dc0745 | 406 | memory, this can be a killer. Compiling into C B<isn't going to help |
46fc3d4c | 407 | you> because the process start-up overhead is where the bottleneck is. |
68dc0745 | 408 | |
92c2ed05 GS |
409 | There are two popular ways to avoid this overhead. One solution |
410 | involves running the Apache HTTP server (available from | |
68dc0745 | 411 | http://www.apache.org/) with either of the mod_perl or mod_fastcgi |
92c2ed05 GS |
412 | plugin modules. |
413 | ||
414 | With mod_perl and the Apache::Registry module (distributed with | |
415 | mod_perl), httpd will run with an embedded Perl interpreter which | |
416 | pre-compiles your script and then executes it within the same address | |
417 | space without forking. The Apache extension also gives Perl access to | |
418 | the internal server API, so modules written in Perl can do just about | |
419 | anything a module written in C can. For more on mod_perl, see | |
420 | http://perl.apache.org/ | |
421 | ||
65acb1b1 | 422 | With the FCGI module (from CPAN) and the mod_fastcgi |
87275199 GS |
423 | module (available from http://www.fastcgi.com/) each of your Perl |
424 | programs becomes a permanent CGI daemon process. | |
68dc0745 | 425 | |
426 | Both of these solutions can have far-reaching effects on your system | |
87275199 | 427 | and on the way you write your CGI programs, so investigate them with |
68dc0745 | 428 | care. |
429 | ||
92c2ed05 | 430 | See http://www.perl.com/CPAN/modules/by-category/15_World_Wide_Web_HTML_HTTP_CGI/ . |
5a964f20 | 431 | |
65acb1b1 | 432 | A non-free, commercial product, ``The Velocity Engine for Perl'', |
a6dd486b JB |
433 | (http://www.binevolve.com/ or http://www.binevolve.com/velocigen/ ) |
434 | might also be worth looking at. It will allow you to increase the | |
435 | performance of your Perl programs, running programs up to 25 times | |
436 | faster than normal CGI Perl when running in persistent Perl mode or 4 | |
437 | to 5 times faster without any modification to your existing CGI | |
438 | programs. Fully functional evaluation copies are available from the | |
439 | web site. | |
c8db1d39 | 440 | |
68dc0745 | 441 | =head2 How can I hide the source for my Perl program? |
442 | ||
443 | Delete it. :-) Seriously, there are a number of (mostly | |
92c2ed05 | 444 | unsatisfactory) solutions with varying levels of ``security''. |
68dc0745 | 445 | |
446 | First of all, however, you I<can't> take away read permission, because | |
447 | the source code has to be readable in order to be compiled and | |
448 | interpreted. (That doesn't mean that a CGI script's source is | |
a6dd486b JB |
449 | readable by people on the web, though--only by people with access to |
450 | the filesystem.) So you have to leave the permissions at the socially | |
92c2ed05 | 451 | friendly 0755 level. |
68dc0745 | 452 | |
453 | Some people regard this as a security problem. If your program does | |
a6dd486b | 454 | insecure things and relies on people not knowing how to exploit those |
68dc0745 | 455 | insecurities, it is not secure. It is often possible for someone to |
456 | determine the insecure things and exploit them without viewing the | |
457 | source. Security through obscurity, the name for hiding your bugs | |
458 | instead of fixing them, is little security indeed. | |
459 | ||
92c2ed05 | 460 | You can try using encryption via source filters (Filter::* from CPAN), |
65acb1b1 TC |
461 | but any decent programmer will be able to decrypt it. You can try using |
462 | the byte code compiler and interpreter described below, but the curious | |
463 | might still be able to de-compile it. You can try using the native-code | |
464 | compiler described below, but crackers might be able to disassemble it. | |
465 | These pose varying degrees of difficulty to people wanting to get at | |
a6dd486b | 466 | your code, but none can definitively conceal it (true of every |
68dc0745 | 467 | language, not just Perl). |
468 | ||
469 | If you're concerned about people profiting from your code, then the | |
d92eb7b0 | 470 | bottom line is that nothing but a restrictive license will give you |
68dc0745 | 471 | legal security. License your software and pepper it with threatening |
92c2ed05 | 472 | statements like ``This is unpublished proprietary software of XYZ Corp. |
68dc0745 | 473 | Your access to it does not give you permission to use it blah blah |
92c2ed05 | 474 | blah.'' We are not lawyers, of course, so you should see a lawyer if |
d92eb7b0 | 475 | you want to be sure your license's wording will stand up in court. |
68dc0745 | 476 | |
54310121 | 477 | =head2 How can I compile my Perl program into byte code or C? |
68dc0745 | 478 | |
479 | Malcolm Beattie has written a multifunction backend compiler, | |
5e3006a4 GS |
480 | available from CPAN, that can do both these things. It is included |
481 | in the perl5.005 release, but is still considered experimental. | |
482 | This means it's fun to play with if you're a programmer but not | |
483 | really for people looking for turn-key solutions. | |
68dc0745 | 484 | |
92c2ed05 GS |
485 | Merely compiling into C does not in and of itself guarantee that your |
486 | code will run very much faster. That's because except for lucky cases | |
487 | where a lot of native type inferencing is possible, the normal Perl | |
a6dd486b | 488 | run-time system is still present and so your program will take just as |
92c2ed05 GS |
489 | long to run and be just as big. Most programs save little more than |
490 | compilation time, leaving execution no more than 10-30% faster. A few | |
a6dd486b | 491 | rare programs actually benefit significantly (even running several times |
92c2ed05 | 492 | faster), but this takes some tweaking of your code. |
68dc0745 | 493 | |
68dc0745 | 494 | You'll probably be astonished to learn that the current version of the |
495 | compiler generates a compiled form of your script whose executable is | |
496 | just as big as the original perl executable, and then some. That's | |
497 | because as currently written, all programs are prepared for a full | |
498 | eval() statement. You can tremendously reduce this cost by building a | |
92c2ed05 | 499 | shared I<libperl.so> library and linking against that. See the |
87275199 | 500 | F<INSTALL> podfile in the Perl source distribution for details. If |
d92eb7b0 | 501 | you link your main perl binary with this, it will make it minuscule. |
92c2ed05 | 502 | For example, on one author's system, F</usr/bin/perl> is only 11k in |
68dc0745 | 503 | size! |
504 | ||
5a964f20 | 505 | In general, the compiler will do nothing to make a Perl program smaller, |
a6dd486b JB |
506 | faster, more portable, or more secure. In fact, it can make your |
507 | situation worse. The executable will be bigger, your VM system may take | |
5a964f20 TC |
508 | longer to load the whole thing, the binary is fragile and hard to fix, |
509 | and compilation never stopped software piracy in the form of crackers, | |
510 | viruses, or bootleggers. The real advantage of the compiler is merely | |
511 | packaging, and once you see the size of what it makes (well, unless | |
512 | you use a shared I<libperl.so>), you'll probably want a complete | |
5e3006a4 | 513 | Perl install anyway. |
5a964f20 | 514 | |
65acb1b1 TC |
515 | =head2 How can I compile Perl into Java? |
516 | ||
a6dd486b | 517 | You can also integrate Java and Perl with the |
65acb1b1 | 518 | Perl Resource Kit from O'Reilly and Associates. See |
a6dd486b JB |
519 | http://www.oreilly.com/catalog/prkunix/ . |
520 | ||
521 | Perl 5.6 comes with Java Perl Lingo, or JPL. JPL, still in | |
522 | development, allows Perl code to be called from Java. See jpl/README | |
523 | in the Perl source tree. | |
65acb1b1 | 524 | |
92c2ed05 | 525 | =head2 How can I get C<#!perl> to work on [MS-DOS,NT,...]? |
68dc0745 | 526 | |
527 | For OS/2 just use | |
528 | ||
529 | extproc perl -S -your_switches | |
530 | ||
531 | as the first line in C<*.cmd> file (C<-S> due to a bug in cmd.exe's | |
46fc3d4c | 532 | `extproc' handling). For DOS one should first invent a corresponding |
a6dd486b | 533 | batch file and codify it in C<ALTERNATIVE_SHEBANG> (see the |
68dc0745 | 534 | F<INSTALL> file in the source distribution for more information). |
535 | ||
92c2ed05 GS |
536 | The Win95/NT installation, when using the ActiveState port of Perl, |
537 | will modify the Registry to associate the C<.pl> extension with the | |
d92eb7b0 GS |
538 | perl interpreter. If you install another port, perhaps even building |
539 | your own Win95/NT Perl from the standard sources by using a Windows port | |
d702ae42 | 540 | of gcc (e.g., with cygwin or mingw32), then you'll have to modify |
d92eb7b0 GS |
541 | the Registry yourself. In addition to associating C<.pl> with the |
542 | interpreter, NT people can use: C<SET PATHEXT=%PATHEXT%;.PL> to let them | |
543 | run the program C<install-linux.pl> merely by typing C<install-linux>. | |
68dc0745 | 544 | |
87275199 GS |
545 | Macintosh Perl programs will have the appropriate Creator and |
546 | Type, so that double-clicking them will invoke the Perl application. | |
68dc0745 | 547 | |
548 | I<IMPORTANT!>: Whatever you do, PLEASE don't get frustrated, and just | |
549 | throw the perl interpreter into your cgi-bin directory, in order to | |
87275199 | 550 | get your programs working for a web server. This is an EXTREMELY big |
68dc0745 | 551 | security risk. Take the time to figure out how to do it correctly. |
552 | ||
87275199 | 553 | =head2 Can I write useful Perl programs on the command line? |
68dc0745 | 554 | |
555 | Yes. Read L<perlrun> for more information. Some examples follow. | |
556 | (These assume standard Unix shell quoting rules.) | |
557 | ||
558 | # sum first and last fields | |
5a964f20 | 559 | perl -lane 'print $F[0] + $F[-1]' * |
68dc0745 | 560 | |
561 | # identify text files | |
562 | perl -le 'for(@ARGV) {print if -f && -T _}' * | |
563 | ||
5a964f20 | 564 | # remove (most) comments from C program |
68dc0745 | 565 | perl -0777 -pe 's{/\*.*?\*/}{}gs' foo.c |
566 | ||
567 | # make file a month younger than today, defeating reaper daemons | |
568 | perl -e '$X=24*60*60; utime(time(),time() + 30 * $X,@ARGV)' * | |
569 | ||
570 | # find first unused uid | |
571 | perl -le '$i++ while getpwuid($i); print $i' | |
572 | ||
573 | # display reasonable manpath | |
574 | echo $PATH | perl -nl -072 -e ' | |
575 | s![^/+]*$!man!&&-d&&!$s{$_}++&&push@m,$_;END{print"@m"}' | |
576 | ||
87275199 | 577 | OK, the last one was actually an Obfuscated Perl Contest entry. :-) |
68dc0745 | 578 | |
87275199 | 579 | =head2 Why don't Perl one-liners work on my DOS/Mac/VMS system? |
68dc0745 | 580 | |
581 | The problem is usually that the command interpreters on those systems | |
582 | have rather different ideas about quoting than the Unix shells under | |
583 | which the one-liners were created. On some systems, you may have to | |
584 | change single-quotes to double ones, which you must I<NOT> do on Unix | |
585 | or Plan9 systems. You might also have to change a single % to a %%. | |
586 | ||
587 | For example: | |
588 | ||
589 | # Unix | |
590 | perl -e 'print "Hello world\n"' | |
591 | ||
46fc3d4c | 592 | # DOS, etc. |
68dc0745 | 593 | perl -e "print \"Hello world\n\"" |
594 | ||
46fc3d4c | 595 | # Mac |
68dc0745 | 596 | print "Hello world\n" |
597 | (then Run "Myscript" or Shift-Command-R) | |
598 | ||
599 | # VMS | |
600 | perl -e "print ""Hello world\n""" | |
601 | ||
a6dd486b | 602 | The problem is that none of these examples are reliable: they depend on the |
92c2ed05 | 603 | command interpreter. Under Unix, the first two often work. Under DOS, |
a6dd486b | 604 | it's entirely possible that neither works. If 4DOS was the command shell, |
92c2ed05 | 605 | you'd probably have better luck like this: |
68dc0745 | 606 | |
607 | perl -e "print <Ctrl-x>"Hello world\n<Ctrl-x>"" | |
608 | ||
46fc3d4c | 609 | Under the Mac, it depends which environment you are using. The MacPerl |
68dc0745 | 610 | shell, or MPW, is much like Unix shells in its support for several |
46fc3d4c | 611 | quoting variants, except that it makes free use of the Mac's non-ASCII |
68dc0745 | 612 | characters as control characters. |
613 | ||
65acb1b1 TC |
614 | Using qq(), q(), and qx(), instead of "double quotes", 'single |
615 | quotes', and `backticks`, may make one-liners easier to write. | |
616 | ||
92c2ed05 GS |
617 | There is no general solution to all of this. It is a mess, pure and |
618 | simple. Sucks to be away from Unix, huh? :-) | |
68dc0745 | 619 | |
620 | [Some of this answer was contributed by Kenneth Albanowski.] | |
621 | ||
622 | =head2 Where can I learn about CGI or Web programming in Perl? | |
623 | ||
624 | For modules, get the CGI or LWP modules from CPAN. For textbooks, | |
625 | see the two especially dedicated to web stuff in the question on | |
92c2ed05 GS |
626 | books. For problems and questions related to the web, like ``Why |
627 | do I get 500 Errors'' or ``Why doesn't it run from the browser right | |
628 | when it runs fine on the command line'', see these sources: | |
68dc0745 | 629 | |
5a964f20 TC |
630 | WWW Security FAQ |
631 | http://www.w3.org/Security/Faq/ | |
68dc0745 | 632 | |
5a964f20 TC |
633 | Web FAQ |
634 | http://www.boutell.com/faq/ | |
68dc0745 | 635 | |
5a964f20 | 636 | CGI FAQ |
6cecdcac | 637 | http://www.webthing.com/tutorials/cgifaq.html |
68dc0745 | 638 | |
5a964f20 TC |
639 | HTTP Spec |
640 | http://www.w3.org/pub/WWW/Protocols/HTTP/ | |
641 | ||
642 | HTML Spec | |
643 | http://www.w3.org/TR/REC-html40/ | |
644 | http://www.w3.org/pub/WWW/MarkUp/ | |
645 | ||
646 | CGI Spec | |
647 | http://www.w3.org/CGI/ | |
648 | ||
649 | CGI Security FAQ | |
650 | http://www.go2net.com/people/paulp/cgi-security/safe-cgi.txt | |
68dc0745 | 651 | |
68dc0745 | 652 | =head2 Where can I learn about object-oriented Perl programming? |
653 | ||
a6dd486b JB |
654 | A good place to start is L<perltoot>, and you can use L<perlobj>, |
655 | L<perlboot>, and L<perlbot> for reference. Perltoot didn't come out | |
656 | until the 5.004 release; you can get a copy (in pod, html, or | |
657 | postscript) from http://www.perl.com/CPAN/doc/FMTEYEWTK/ . | |
68dc0745 | 658 | |
659 | =head2 Where can I learn about linking C with Perl? [h2xs, xsubpp] | |
660 | ||
661 | If you want to call C from Perl, start with L<perlxstut>, | |
662 | moving on to L<perlxs>, L<xsubpp>, and L<perlguts>. If you want to | |
663 | call Perl from C, then read L<perlembed>, L<perlcall>, and | |
664 | L<perlguts>. Don't forget that you can learn a lot from looking at | |
665 | how the authors of existing extension modules wrote their code and | |
666 | solved their problems. | |
667 | ||
668 | =head2 I've read perlembed, perlguts, etc., but I can't embed perl in | |
a6dd486b | 669 | my C program; what am I doing wrong? |
68dc0745 | 670 | |
671 | Download the ExtUtils::Embed kit from CPAN and run `make test'. If | |
672 | the tests pass, read the pods again and again and again. If they | |
87275199 | 673 | fail, see L<perlbug> and send a bug report with the output of |
68dc0745 | 674 | C<make test TEST_VERBOSE=1> along with C<perl -V>. |
675 | ||
676 | =head2 When I tried to run my script, I got this message. What does it | |
677 | mean? | |
678 | ||
87275199 GS |
679 | A complete list of Perl's error messages and warnings with explanatory |
680 | text can be found in L<perldiag>. You can also use the splain program | |
681 | (distributed with Perl) to explain the error messages: | |
68dc0745 | 682 | |
683 | perl program 2>diag.out | |
684 | splain [-v] [-p] diag.out | |
685 | ||
686 | or change your program to explain the messages for you: | |
687 | ||
688 | use diagnostics; | |
689 | ||
690 | or | |
691 | ||
692 | use diagnostics -verbose; | |
693 | ||
694 | =head2 What's MakeMaker? | |
695 | ||
87275199 | 696 | This module (part of the standard Perl distribution) is designed to |
68dc0745 | 697 | write a Makefile for an extension module from a Makefile.PL. For more |
698 | information, see L<ExtUtils::MakeMaker>. | |
699 | ||
700 | =head1 AUTHOR AND COPYRIGHT | |
701 | ||
65acb1b1 | 702 | Copyright (c) 1997-1999 Tom Christiansen and Nathan Torkington. |
5a964f20 TC |
703 | All rights reserved. |
704 | ||
c8db1d39 | 705 | When included as an integrated part of the Standard Distribution |
d92eb7b0 GS |
706 | of Perl or of its documentation (printed or otherwise), this works is |
707 | covered under Perl's Artistic License. For separate distributions of | |
c8db1d39 TC |
708 | all or part of this FAQ outside of that, see L<perlfaq>. |
709 | ||
87275199 | 710 | Irrespective of its distribution, all code examples here are in the public |
c8db1d39 TC |
711 | domain. You are permitted and encouraged to use this code and any |
712 | derivatives thereof in your own programs for fun or for profit as you | |
713 | see fit. A simple comment in the code giving credit to the FAQ would | |
714 | be courteous but is not required. |