Commit | Line | Data |
f102b883 |
1 | =head1 NAME |
2 | |
3 | perlmodlib - constructing new Perl modules and finding existing ones |
4 | |
5 | =head1 DESCRIPTION |
6 | |
7 | =head1 THE PERL MODULE LIBRARY |
8 | |
9 | A number of modules are included the Perl distribution. These are |
10 | described below, and all end in F<.pm>. You may also discover files in |
11 | the library directory that end in either F<.pl> or F<.ph>. These are old |
12 | libraries supplied so that old programs that use them still run. The |
13 | F<.pl> files will all eventually be converted into standard modules, and |
14 | the F<.ph> files made by B<h2ph> will probably end up as extension modules |
15 | made by B<h2xs>. (Some F<.ph> values may already be available through the |
16 | POSIX module.) The B<pl2pm> file in the distribution may help in your |
17 | conversion, but it's just a mechanical process and therefore far from |
18 | bulletproof. |
19 | |
20 | =head2 Pragmatic Modules |
21 | |
22 | They work somewhat like pragmas in that they tend to affect the compilation of |
23 | your program, and thus will usually work well only when used within a |
24 | C<use>, or C<no>. Most of these are locally scoped, so an inner BLOCK |
25 | may countermand any of these by saying: |
26 | |
27 | no integer; |
28 | no strict 'refs'; |
29 | |
30 | which lasts until the end of that BLOCK. |
31 | |
32 | Unlike the pragmas that effect the C<$^H> hints variable, the C<use |
33 | vars> and C<use subs> declarations are not BLOCK-scoped. They allow |
34 | you to predeclare a variables or subroutines within a particular |
35 | I<file> rather than just a block. Such declarations are effective |
36 | for the entire file for which they were declared. You cannot rescind |
37 | them with C<no vars> or C<no subs>. |
38 | |
39 | The following pragmas are defined (and have their own documentation). |
40 | |
41 | =over 12 |
42 | |
43 | =item use autouse MODULE => qw(sub1 sub2 sub3) |
44 | |
45 | Defers C<require MODULE> until someone calls one of the specified |
46 | subroutines (which must be exported by MODULE). This pragma should be |
47 | used with caution, and only when necessary. |
48 | |
49 | =item blib |
50 | |
51 | manipulate @INC at compile time to use MakeMaker's uninstalled version |
52 | of a package |
53 | |
54 | =item diagnostics |
55 | |
56 | force verbose warning diagnostics |
57 | |
58 | =item integer |
59 | |
60 | compute arithmetic in integer instead of double |
61 | |
62 | =item less |
63 | |
64 | request less of something from the compiler |
65 | |
66 | =item lib |
67 | |
68 | manipulate @INC at compile time |
69 | |
70 | =item locale |
71 | |
72 | use or ignore current locale for builtin operations (see L<perllocale>) |
73 | |
74 | =item ops |
75 | |
76 | restrict named opcodes when compiling or running Perl code |
77 | |
78 | =item overload |
79 | |
80 | overload basic Perl operations |
81 | |
82 | =item sigtrap |
83 | |
84 | enable simple signal handling |
85 | |
86 | =item strict |
87 | |
88 | restrict unsafe constructs |
89 | |
90 | =item subs |
91 | |
92 | predeclare sub names |
93 | |
94 | =item vmsish |
95 | |
96 | adopt certain VMS-specific behaviors |
97 | |
98 | =item vars |
99 | |
100 | predeclare global variable names |
101 | |
102 | =back |
103 | |
104 | =head2 Standard Modules |
105 | |
106 | Standard, bundled modules are all expected to behave in a well-defined |
107 | manner with respect to namespace pollution because they use the |
108 | Exporter module. See their own documentation for details. |
109 | |
110 | =over 12 |
111 | |
112 | =item AnyDBM_File |
113 | |
114 | provide framework for multiple DBMs |
115 | |
116 | =item AutoLoader |
117 | |
118 | load functions only on demand |
119 | |
120 | =item AutoSplit |
121 | |
122 | split a package for autoloading |
123 | |
124 | =item Benchmark |
125 | |
126 | benchmark running times of code |
127 | |
128 | =item CPAN |
129 | |
130 | interface to Comprehensive Perl Archive Network |
131 | |
132 | =item CPAN::FirstTime |
133 | |
134 | create a CPAN configuration file |
135 | |
136 | =item CPAN::Nox |
137 | |
138 | run CPAN while avoiding compiled extensions |
139 | |
140 | =item Carp |
141 | |
142 | warn of errors (from perspective of caller) |
143 | |
144 | =item Class::Struct |
145 | |
146 | declare struct-like datatypes |
147 | |
148 | =item Config |
149 | |
150 | access Perl configuration information |
151 | |
152 | =item Cwd |
153 | |
154 | get pathname of current working directory |
155 | |
156 | =item DB_File |
157 | |
158 | access to Berkeley DB |
159 | |
160 | =item Devel::SelfStubber |
161 | |
162 | generate stubs for a SelfLoading module |
163 | |
164 | =item DirHandle |
165 | |
166 | supply object methods for directory handles |
167 | |
168 | =item DynaLoader |
169 | |
170 | dynamically load C libraries into Perl code |
171 | |
172 | =item English |
173 | |
174 | use nice English (or awk) names for ugly punctuation variables |
175 | |
176 | =item Env |
177 | |
178 | import environment variables |
179 | |
180 | =item Exporter |
181 | |
182 | implements default import method for modules |
183 | |
184 | =item ExtUtils::Embed |
185 | |
186 | utilities for embedding Perl in C/C++ applications |
187 | |
188 | =item ExtUtils::Install |
189 | |
190 | install files from here to there |
191 | |
192 | =item ExtUtils::Liblist |
193 | |
194 | determine libraries to use and how to use them |
195 | |
196 | =item ExtUtils::MM_OS2 |
197 | |
198 | methods to override Unix behaviour in ExtUtils::MakeMaker |
199 | |
200 | =item ExtUtils::MM_Unix |
201 | |
202 | methods used by ExtUtils::MakeMaker |
203 | |
204 | =item ExtUtils::MM_VMS |
205 | |
206 | methods to override Unix behaviour in ExtUtils::MakeMaker |
207 | |
208 | =item ExtUtils::MakeMaker |
209 | |
210 | create an extension Makefile |
211 | |
212 | =item ExtUtils::Manifest |
213 | |
214 | utilities to write and check a MANIFEST file |
215 | |
216 | =item ExtUtils::Mkbootstrap |
217 | |
218 | make a bootstrap file for use by DynaLoader |
219 | |
220 | =item ExtUtils::Mksymlists |
221 | |
222 | write linker options files for dynamic extension |
223 | |
224 | =item ExtUtils::testlib |
225 | |
226 | add blib/* directories to @INC |
227 | |
228 | =item Fcntl |
229 | |
230 | load the C Fcntl.h defines |
231 | |
232 | =item File::Basename |
233 | |
234 | split a pathname into pieces |
235 | |
236 | =item File::CheckTree |
237 | |
238 | run many filetest checks on a tree |
239 | |
240 | =item File::Compare |
241 | |
242 | compare files or filehandles |
243 | |
244 | =item File::Copy |
245 | |
246 | copy files or filehandles |
247 | |
248 | =item File::Find |
249 | |
250 | traverse a file tree |
251 | |
252 | =item File::Path |
253 | |
254 | create or remove a series of directories |
255 | |
256 | =item File::stat |
257 | |
258 | by-name interface to Perl's builtin stat() functions |
259 | |
260 | =item FileCache |
261 | |
262 | keep more files open than the system permits |
263 | |
264 | =item FileHandle |
265 | |
266 | supply object methods for filehandles |
267 | |
268 | =item FindBin |
269 | |
270 | locate directory of original perl script |
271 | |
272 | =item GDBM_File |
273 | |
274 | access to the gdbm library |
275 | |
276 | =item Getopt::Long |
277 | |
278 | extended processing of command line options |
279 | |
280 | =item Getopt::Std |
281 | |
282 | process single-character switches with switch clustering |
283 | |
284 | =item I18N::Collate |
285 | |
286 | compare 8-bit scalar data according to the current locale |
287 | |
288 | =item IO |
289 | |
290 | load various IO modules |
291 | |
292 | =item IO::File |
293 | |
294 | supply object methods for filehandles |
295 | |
296 | =item IO::Handle |
297 | |
298 | supply object methods for I/O handles |
299 | |
300 | =item IO::Pipe |
301 | |
302 | supply object methods for pipes |
303 | |
304 | =item IO::Seekable |
305 | |
306 | supply seek based methods for I/O objects |
307 | |
308 | =item IO::Select |
309 | |
310 | OO interface to the select system call |
311 | |
312 | =item IO::Socket |
313 | |
314 | object interface to socket communications |
315 | |
316 | =item IPC::Open2 |
317 | |
318 | open a process for both reading and writing |
319 | |
320 | =item IPC::Open3 |
321 | |
322 | open a process for reading, writing, and error handling |
323 | |
324 | =item Math::BigFloat |
325 | |
326 | arbitrary length float math package |
327 | |
328 | =item Math::BigInt |
329 | |
330 | arbitrary size integer math package |
331 | |
332 | =item Math::Complex |
333 | |
334 | complex numbers and associated mathematical functions |
335 | |
404b15a1 |
336 | =item Math::Trig |
337 | |
338 | simple interface to parts of Math::Complex for those who |
339 | need trigonometric functions only for real numbers |
340 | |
f102b883 |
341 | =item NDBM_File |
342 | |
343 | tied access to ndbm files |
344 | |
345 | =item Net::Ping |
346 | |
347 | Hello, anybody home? |
348 | |
349 | =item Net::hostent |
350 | |
351 | by-name interface to Perl's builtin gethost*() functions |
352 | |
353 | =item Net::netent |
354 | |
355 | by-name interface to Perl's builtin getnet*() functions |
356 | |
357 | =item Net::protoent |
358 | |
359 | by-name interface to Perl's builtin getproto*() functions |
360 | |
361 | =item Net::servent |
362 | |
363 | by-name interface to Perl's builtin getserv*() functions |
364 | |
365 | =item Opcode |
366 | |
367 | disable named opcodes when compiling or running perl code |
368 | |
369 | =item Pod::Text |
370 | |
371 | convert POD data to formatted ASCII text |
372 | |
373 | =item POSIX |
374 | |
375 | interface to IEEE Standard 1003.1 |
376 | |
377 | =item SDBM_File |
378 | |
379 | tied access to sdbm files |
380 | |
381 | =item Safe |
382 | |
383 | compile and execute code in restricted compartments |
384 | |
385 | =item Search::Dict |
386 | |
387 | search for key in dictionary file |
388 | |
389 | =item SelectSaver |
390 | |
391 | save and restore selected file handle |
392 | |
393 | =item SelfLoader |
394 | |
395 | load functions only on demand |
396 | |
397 | =item Shell |
398 | |
399 | run shell commands transparently within perl |
400 | |
401 | =item Socket |
402 | |
403 | load the C socket.h defines and structure manipulators |
404 | |
405 | =item Symbol |
406 | |
407 | manipulate Perl symbols and their names |
408 | |
409 | =item Sys::Hostname |
410 | |
411 | try every conceivable way to get hostname |
412 | |
413 | =item Sys::Syslog |
414 | |
415 | interface to the Unix syslog(3) calls |
416 | |
417 | =item Term::Cap |
418 | |
419 | termcap interface |
420 | |
421 | =item Term::Complete |
422 | |
423 | word completion module |
424 | |
425 | =item Term::ReadLine |
426 | |
427 | interface to various C<readline> packages |
428 | |
429 | =item Test::Harness |
430 | |
431 | run perl standard test scripts with statistics |
432 | |
433 | =item Text::Abbrev |
434 | |
435 | create an abbreviation table from a list |
436 | |
437 | =item Text::ParseWords |
438 | |
439 | parse text into an array of tokens |
440 | |
441 | =item Text::Soundex |
442 | |
443 | implementation of the Soundex Algorithm as described by Knuth |
444 | |
445 | =item Text::Tabs |
446 | |
447 | expand and unexpand tabs per the Unix expand(1) and unexpand(1) |
448 | |
449 | =item Text::Wrap |
450 | |
451 | line wrapping to form simple paragraphs |
452 | |
453 | =item Tie::Hash |
454 | |
455 | base class definitions for tied hashes |
456 | |
457 | =item Tie::RefHash |
458 | |
459 | base class definitions for tied hashes with references as keys |
460 | |
461 | =item Tie::Scalar |
462 | |
463 | base class definitions for tied scalars |
464 | |
465 | =item Tie::SubstrHash |
466 | |
467 | fixed-table-size, fixed-key-length hashing |
468 | |
469 | =item Time::Local |
470 | |
471 | efficiently compute time from local and GMT time |
472 | |
473 | =item Time::gmtime |
474 | |
475 | by-name interface to Perl's builtin gmtime() function |
476 | |
477 | =item Time::localtime |
478 | |
479 | by-name interface to Perl's builtin localtime() function |
480 | |
481 | =item Time::tm |
482 | |
483 | internal object used by Time::gmtime and Time::localtime |
484 | |
485 | =item UNIVERSAL |
486 | |
487 | base class for ALL classes (blessed references) |
488 | |
489 | =item User::grent |
490 | |
491 | by-name interface to Perl's builtin getgr*() functions |
492 | |
493 | =item User::pwent |
494 | |
495 | by-name interface to Perl's builtin getpw*() functions |
496 | |
497 | =back |
498 | |
499 | To find out I<all> the modules installed on your system, including |
500 | those without documentation or outside the standard release, do this: |
501 | |
502 | find `perl -e 'print "@INC"'` -name '*.pm' -print |
503 | |
504 | They should all have their own documentation installed and accessible via |
505 | your system man(1) command. If that fails, try the I<perldoc> program. |
506 | |
507 | =head2 Extension Modules |
508 | |
509 | Extension modules are written in C (or a mix of Perl and C) and may be |
510 | statically linked or in general are |
511 | dynamically loaded into Perl if and when you need them. Supported |
512 | extension modules include the Socket, Fcntl, and POSIX modules. |
513 | |
514 | Many popular C extension modules do not come bundled (at least, not |
515 | completely) due to their sizes, volatility, or simply lack of time for |
516 | adequate testing and configuration across the multitude of platforms on |
517 | which Perl was beta-tested. You are encouraged to look for them in |
518 | archie(1L), the Perl FAQ or Meta-FAQ, the WWW page, and even with their |
519 | authors before randomly posting asking for their present condition and |
520 | disposition. |
521 | |
522 | =head1 CPAN |
523 | |
524 | CPAN stands for the Comprehensive Perl Archive Network. This is a globally |
525 | replicated collection of all known Perl materials, including hundreds |
526 | of unbundled modules. Here are the major categories of modules: |
527 | |
528 | =over |
529 | |
530 | =item * |
531 | Language Extensions and Documentation Tools |
532 | |
533 | =item * |
534 | Development Support |
535 | |
536 | =item * |
537 | Operating System Interfaces |
538 | |
539 | =item * |
540 | Networking, Device Control (modems) and InterProcess Communication |
541 | |
542 | =item * |
543 | Data Types and Data Type Utilities |
544 | |
545 | =item * |
546 | Database Interfaces |
547 | |
548 | =item * |
549 | User Interfaces |
550 | |
551 | =item * |
552 | Interfaces to / Emulations of Other Programming Languages |
553 | |
554 | =item * |
555 | File Names, File Systems and File Locking (see also File Handles) |
556 | |
557 | =item * |
558 | String Processing, Language Text Processing, Parsing, and Searching |
559 | |
560 | =item * |
561 | Option, Argument, Parameter, and Configuration File Processing |
562 | |
563 | =item * |
564 | Internationalization and Locale |
565 | |
566 | =item * |
567 | Authentication, Security, and Encryption |
568 | |
569 | =item * |
570 | World Wide Web, HTML, HTTP, CGI, MIME |
571 | |
572 | =item * |
573 | Server and Daemon Utilities |
574 | |
575 | =item * |
576 | Archiving and Compression |
577 | |
578 | =item * |
579 | Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing |
580 | |
581 | =item * |
582 | Mail and Usenet News |
583 | |
584 | =item * |
585 | Control Flow Utilities (callbacks and exceptions etc) |
586 | |
587 | =item * |
588 | File Handle and Input/Output Stream Utilities |
589 | |
590 | =item * |
591 | Miscellaneous Modules |
592 | |
593 | =back |
594 | |
595 | The registered CPAN sites as of this writing include the following. |
596 | You should try to choose one close to you: |
597 | |
598 | =over |
599 | |
600 | =item * |
601 | Africa |
602 | |
603 | South Africa ftp://ftp.is.co.za/programming/perl/CPAN/ |
604 | |
605 | =item * |
606 | Asia |
607 | |
608 | Hong Kong ftp://ftp.hkstar.com/pub/CPAN/ |
609 | Japan ftp://ftp.jaist.ac.jp/pub/lang/perl/CPAN/ |
610 | ftp://ftp.lab.kdd.co.jp/lang/perl/CPAN/ |
611 | South Korea ftp://ftp.nuri.net/pub/CPAN/ |
612 | Taiwan ftp://dongpo.math.ncu.edu.tw/perl/CPAN/ |
613 | ftp://ftp.wownet.net/pub2/PERL/ |
614 | |
615 | =item * |
616 | Australasia |
617 | |
618 | Australia ftp://ftp.netinfo.com.au/pub/perl/CPAN/ |
619 | New Zealand ftp://ftp.tekotago.ac.nz/pub/perl/CPAN/ |
620 | |
621 | =item * |
622 | Europe |
623 | |
624 | Austria ftp://ftp.tuwien.ac.at/pub/languages/perl/CPAN/ |
625 | Belgium ftp://ftp.kulnet.kuleuven.ac.be/pub/mirror/CPAN/ |
626 | Czech Republic ftp://sunsite.mff.cuni.cz/Languages/Perl/CPAN/ |
627 | Denmark ftp://sunsite.auc.dk/pub/languages/perl/CPAN/ |
628 | Finland ftp://ftp.funet.fi/pub/languages/perl/CPAN/ |
629 | France ftp://ftp.ibp.fr/pub/perl/CPAN/ |
630 | ftp://ftp.pasteur.fr/pub/computing/unix/perl/CPAN/ |
631 | Germany ftp://ftp.gmd.de/packages/CPAN/ |
632 | ftp://ftp.leo.org/pub/comp/programming/languages/perl/CPAN/ |
633 | ftp://ftp.mpi-sb.mpg.de/pub/perl/CPAN/ |
634 | ftp://ftp.rz.ruhr-uni-bochum.de/pub/CPAN/ |
635 | ftp://ftp.uni-erlangen.de/pub/source/Perl/CPAN/ |
636 | ftp://ftp.uni-hamburg.de/pub/soft/lang/perl/CPAN/ |
637 | Greece ftp://ftp.ntua.gr/pub/lang/perl/ |
638 | Hungary ftp://ftp.kfki.hu/pub/packages/perl/CPAN/ |
639 | Italy ftp://cis.utovrm.it/CPAN/ |
640 | the Netherlands ftp://ftp.cs.ruu.nl/pub/PERL/CPAN/ |
641 | ftp://ftp.EU.net/packages/cpan/ |
642 | Norway ftp://ftp.uit.no/pub/languages/perl/cpan/ |
643 | Poland ftp://ftp.pk.edu.pl/pub/lang/perl/CPAN/ |
644 | ftp://sunsite.icm.edu.pl/pub/CPAN/ |
645 | Portugal ftp://ftp.ci.uminho.pt/pub/lang/perl/ |
646 | ftp://ftp.telepac.pt/pub/CPAN/ |
647 | Russia ftp://ftp.sai.msu.su/pub/lang/perl/CPAN/ |
648 | Slovenia ftp://ftp.arnes.si/software/perl/CPAN/ |
649 | Spain ftp://ftp.etse.urv.es/pub/mirror/perl/ |
650 | ftp://ftp.rediris.es/mirror/CPAN/ |
651 | Sweden ftp://ftp.sunet.se/pub/lang/perl/CPAN/ |
652 | UK ftp://ftp.demon.co.uk/pub/mirrors/perl/CPAN/ |
653 | ftp://sunsite.doc.ic.ac.uk/packages/CPAN/ |
654 | ftp://unix.hensa.ac.uk/mirrors/perl-CPAN/ |
655 | |
656 | =item * |
657 | North America |
658 | |
659 | Ontario ftp://ftp.utilis.com/public/CPAN/ |
660 | ftp://enterprise.ic.gc.ca/pub/perl/CPAN/ |
661 | Manitoba ftp://theory.uwinnipeg.ca/pub/CPAN/ |
662 | California ftp://ftp.digital.com/pub/plan/perl/CPAN/ |
663 | ftp://ftp.cdrom.com/pub/perl/CPAN/ |
664 | Colorado ftp://ftp.cs.colorado.edu/pub/perl/CPAN/ |
665 | Florida ftp://ftp.cis.ufl.edu/pub/perl/CPAN/ |
666 | Illinois ftp://uiarchive.uiuc.edu/pub/lang/perl/CPAN/ |
667 | Massachusetts ftp://ftp.iguide.com/pub/mirrors/packages/perl/CPAN/ |
668 | New York ftp://ftp.rge.com/pub/languages/perl/ |
669 | North Carolina ftp://ftp.duke.edu/pub/perl/ |
670 | Oklahoma ftp://ftp.ou.edu/mirrors/CPAN/ |
671 | Oregon http://www.perl.org/CPAN/ |
672 | ftp://ftp.orst.edu/pub/packages/CPAN/ |
673 | Pennsylvania ftp://ftp.epix.net/pub/languages/perl/ |
674 | Texas ftp://ftp.sedl.org/pub/mirrors/CPAN/ |
675 | ftp://ftp.metronet.com/pub/perl/ |
676 | |
677 | =item * |
678 | South America |
679 | |
680 | Chile ftp://sunsite.dcc.uchile.cl/pub/Lang/perl/CPAN/ |
681 | |
682 | =back |
683 | |
684 | For an up-to-date listing of CPAN sites, |
685 | see F<http://www.perl.com/perl/CPAN> or F<ftp://ftp.perl.com/perl/>. |
686 | |
687 | =head1 Modules: Creation, Use, and Abuse |
688 | |
689 | (The following section is borrowed directly from Tim Bunce's modules |
690 | file, available at your nearest CPAN site.) |
691 | |
692 | Perl implements a class using a package, but the presence of a |
693 | package doesn't imply the presence of a class. A package is just a |
694 | namespace. A class is a package that provides subroutines that can be |
695 | used as methods. A method is just a subroutine that expects, as its |
696 | first argument, either the name of a package (for "static" methods), |
697 | or a reference to something (for "virtual" methods). |
698 | |
699 | A module is a file that (by convention) provides a class of the same |
700 | name (sans the .pm), plus an import method in that class that can be |
701 | called to fetch exported symbols. This module may implement some of |
702 | its methods by loading dynamic C or C++ objects, but that should be |
703 | totally transparent to the user of the module. Likewise, the module |
704 | might set up an AUTOLOAD function to slurp in subroutine definitions on |
705 | demand, but this is also transparent. Only the F<.pm> file is required to |
706 | exist. See L<perlsub>, L<perltoot>, and L<AutoLoader> for details about |
707 | the AUTOLOAD mechanism. |
708 | |
709 | =head2 Guidelines for Module Creation |
710 | |
711 | =over 4 |
712 | |
713 | =item Do similar modules already exist in some form? |
714 | |
715 | If so, please try to reuse the existing modules either in whole or |
716 | by inheriting useful features into a new class. If this is not |
717 | practical try to get together with the module authors to work on |
718 | extending or enhancing the functionality of the existing modules. |
719 | A perfect example is the plethora of packages in perl4 for dealing |
720 | with command line options. |
721 | |
722 | If you are writing a module to expand an already existing set of |
723 | modules, please coordinate with the author of the package. It |
724 | helps if you follow the same naming scheme and module interaction |
725 | scheme as the original author. |
726 | |
727 | =item Try to design the new module to be easy to extend and reuse. |
728 | |
729 | Use blessed references. Use the two argument form of bless to bless |
730 | into the class name given as the first parameter of the constructor, |
731 | e.g.,: |
732 | |
733 | sub new { |
734 | my $class = shift; |
735 | return bless {}, $class; |
736 | } |
737 | |
738 | or even this if you'd like it to be used as either a static |
739 | or a virtual method. |
740 | |
741 | sub new { |
742 | my $self = shift; |
743 | my $class = ref($self) || $self; |
744 | return bless {}, $class; |
745 | } |
746 | |
747 | Pass arrays as references so more parameters can be added later |
748 | (it's also faster). Convert functions into methods where |
749 | appropriate. Split large methods into smaller more flexible ones. |
750 | Inherit methods from other modules if appropriate. |
751 | |
752 | Avoid class name tests like: C<die "Invalid" unless ref $ref eq 'FOO'>. |
753 | Generally you can delete the "C<eq 'FOO'>" part with no harm at all. |
754 | Let the objects look after themselves! Generally, avoid hard-wired |
755 | class names as far as possible. |
756 | |
757 | Avoid C<$r-E<gt>Class::func()> where using C<@ISA=qw(... Class ...)> and |
758 | C<$r-E<gt>func()> would work (see L<perlbot> for more details). |
759 | |
760 | Use autosplit so little used or newly added functions won't be a |
761 | burden to programs which don't use them. Add test functions to |
762 | the module after __END__ either using AutoSplit or by saying: |
763 | |
764 | eval join('',<main::DATA>) || die $@ unless caller(); |
765 | |
766 | Does your module pass the 'empty subclass' test? If you say |
767 | "C<@SUBCLASS::ISA = qw(YOURCLASS);>" your applications should be able |
768 | to use SUBCLASS in exactly the same way as YOURCLASS. For example, |
769 | does your application still work if you change: C<$obj = new YOURCLASS;> |
770 | into: C<$obj = new SUBCLASS;> ? |
771 | |
772 | Avoid keeping any state information in your packages. It makes it |
773 | difficult for multiple other packages to use yours. Keep state |
774 | information in objects. |
775 | |
776 | Always use B<-w>. Try to C<use strict;> (or C<use strict qw(...);>). |
777 | Remember that you can add C<no strict qw(...);> to individual blocks |
778 | of code which need less strictness. Always use B<-w>. Always use B<-w>! |
779 | Follow the guidelines in the perlstyle(1) manual. |
780 | |
781 | =item Some simple style guidelines |
782 | |
783 | The perlstyle manual supplied with perl has many helpful points. |
784 | |
785 | Coding style is a matter of personal taste. Many people evolve their |
786 | style over several years as they learn what helps them write and |
787 | maintain good code. Here's one set of assorted suggestions that |
788 | seem to be widely used by experienced developers: |
789 | |
790 | Use underscores to separate words. It is generally easier to read |
791 | $var_names_like_this than $VarNamesLikeThis, especially for |
792 | non-native speakers of English. It's also a simple rule that works |
793 | consistently with VAR_NAMES_LIKE_THIS. |
794 | |
795 | Package/Module names are an exception to this rule. Perl informally |
796 | reserves lowercase module names for 'pragma' modules like integer |
797 | and strict. Other modules normally begin with a capital letter and |
798 | use mixed case with no underscores (need to be short and portable). |
799 | |
800 | You may find it helpful to use letter case to indicate the scope |
801 | or nature of a variable. For example: |
802 | |
803 | $ALL_CAPS_HERE constants only (beware clashes with perl vars) |
804 | $Some_Caps_Here package-wide global/static |
805 | $no_caps_here function scope my() or local() variables |
806 | |
807 | Function and method names seem to work best as all lowercase. |
808 | e.g., C<$obj-E<gt>as_string()>. |
809 | |
810 | You can use a leading underscore to indicate that a variable or |
811 | function should not be used outside the package that defined it. |
812 | |
813 | =item Select what to export. |
814 | |
815 | Do NOT export method names! |
816 | |
817 | Do NOT export anything else by default without a good reason! |
818 | |
819 | Exports pollute the namespace of the module user. If you must |
820 | export try to use @EXPORT_OK in preference to @EXPORT and avoid |
821 | short or common names to reduce the risk of name clashes. |
822 | |
823 | Generally anything not exported is still accessible from outside the |
824 | module using the ModuleName::item_name (or C<$blessed_ref-E<gt>method>) |
825 | syntax. By convention you can use a leading underscore on names to |
826 | indicate informally that they are 'internal' and not for public use. |
827 | |
828 | (It is actually possible to get private functions by saying: |
829 | C<my $subref = sub { ... }; &$subref;>. But there's no way to call that |
830 | directly as a method, because a method must have a name in the symbol |
831 | table.) |
832 | |
833 | As a general rule, if the module is trying to be object oriented |
834 | then export nothing. If it's just a collection of functions then |
835 | @EXPORT_OK anything but use @EXPORT with caution. |
836 | |
837 | =item Select a name for the module. |
838 | |
839 | This name should be as descriptive, accurate, and complete as |
840 | possible. Avoid any risk of ambiguity. Always try to use two or |
841 | more whole words. Generally the name should reflect what is special |
842 | about what the module does rather than how it does it. Please use |
843 | nested module names to group informally or categorize a module. |
844 | There should be a very good reason for a module not to have a nested name. |
845 | Module names should begin with a capital letter. |
846 | |
847 | Having 57 modules all called Sort will not make life easy for anyone |
848 | (though having 23 called Sort::Quick is only marginally better :-). |
849 | Imagine someone trying to install your module alongside many others. |
850 | If in any doubt ask for suggestions in comp.lang.perl.misc. |
851 | |
852 | If you are developing a suite of related modules/classes it's good |
853 | practice to use nested classes with a common prefix as this will |
854 | avoid namespace clashes. For example: Xyz::Control, Xyz::View, |
855 | Xyz::Model etc. Use the modules in this list as a naming guide. |
856 | |
857 | If adding a new module to a set, follow the original author's |
858 | standards for naming modules and the interface to methods in |
859 | those modules. |
860 | |
861 | To be portable each component of a module name should be limited to |
862 | 11 characters. If it might be used on MS-DOS then try to ensure each is |
863 | unique in the first 8 characters. Nested modules make this easier. |
864 | |
865 | =item Have you got it right? |
866 | |
867 | How do you know that you've made the right decisions? Have you |
868 | picked an interface design that will cause problems later? Have |
869 | you picked the most appropriate name? Do you have any questions? |
870 | |
871 | The best way to know for sure, and pick up many helpful suggestions, |
872 | is to ask someone who knows. Comp.lang.perl.misc is read by just about |
873 | all the people who develop modules and it's the best place to ask. |
874 | |
875 | All you need to do is post a short summary of the module, its |
876 | purpose and interfaces. A few lines on each of the main methods is |
877 | probably enough. (If you post the whole module it might be ignored |
878 | by busy people - generally the very people you want to read it!) |
879 | |
880 | Don't worry about posting if you can't say when the module will be |
881 | ready - just say so in the message. It might be worth inviting |
882 | others to help you, they may be able to complete it for you! |
883 | |
884 | =item README and other Additional Files. |
885 | |
886 | It's well known that software developers usually fully document the |
887 | software they write. If, however, the world is in urgent need of |
888 | your software and there is not enough time to write the full |
889 | documentation please at least provide a README file containing: |
890 | |
891 | =over 10 |
892 | |
893 | =item * |
894 | A description of the module/package/extension etc. |
895 | |
896 | =item * |
897 | A copyright notice - see below. |
898 | |
899 | =item * |
900 | Prerequisites - what else you may need to have. |
901 | |
902 | =item * |
903 | How to build it - possible changes to Makefile.PL etc. |
904 | |
905 | =item * |
906 | How to install it. |
907 | |
908 | =item * |
909 | Recent changes in this release, especially incompatibilities |
910 | |
911 | =item * |
912 | Changes / enhancements you plan to make in the future. |
913 | |
914 | =back |
915 | |
916 | If the README file seems to be getting too large you may wish to |
917 | split out some of the sections into separate files: INSTALL, |
918 | Copying, ToDo etc. |
919 | |
920 | =over 4 |
921 | |
922 | =item Adding a Copyright Notice. |
923 | |
924 | How you choose to license your work is a personal decision. |
925 | The general mechanism is to assert your Copyright and then make |
926 | a declaration of how others may copy/use/modify your work. |
927 | |
928 | Perl, for example, is supplied with two types of licence: The GNU |
929 | GPL and The Artistic Licence (see the files README, Copying, and |
930 | Artistic). Larry has good reasons for NOT just using the GNU GPL. |
931 | |
932 | My personal recommendation, out of respect for Larry, Perl, and the |
933 | perl community at large is to state something simply like: |
934 | |
935 | Copyright (c) 1995 Your Name. All rights reserved. |
936 | This program is free software; you can redistribute it and/or |
937 | modify it under the same terms as Perl itself. |
938 | |
939 | This statement should at least appear in the README file. You may |
940 | also wish to include it in a Copying file and your source files. |
941 | Remember to include the other words in addition to the Copyright. |
942 | |
943 | =item Give the module a version/issue/release number. |
944 | |
945 | To be fully compatible with the Exporter and MakeMaker modules you |
946 | should store your module's version number in a non-my package |
947 | variable called $VERSION. This should be a floating point |
948 | number with at least two digits after the decimal (i.e., hundredths, |
949 | e.g, C<$VERSION = "0.01">). Don't use a "1.3.2" style version. |
950 | See Exporter.pm in Perl5.001m or later for details. |
951 | |
952 | It may be handy to add a function or method to retrieve the number. |
953 | Use the number in announcements and archive file names when |
954 | releasing the module (ModuleName-1.02.tar.Z). |
955 | See perldoc ExtUtils::MakeMaker.pm for details. |
956 | |
957 | =item How to release and distribute a module. |
958 | |
959 | It's good idea to post an announcement of the availability of your |
960 | module (or the module itself if small) to the comp.lang.perl.announce |
961 | Usenet newsgroup. This will at least ensure very wide once-off |
962 | distribution. |
963 | |
964 | If possible you should place the module into a major ftp archive and |
965 | include details of its location in your announcement. |
966 | |
967 | Some notes about ftp archives: Please use a long descriptive file |
968 | name which includes the version number. Most incoming directories |
969 | will not be readable/listable, i.e., you won't be able to see your |
970 | file after uploading it. Remember to send your email notification |
971 | message as soon as possible after uploading else your file may get |
972 | deleted automatically. Allow time for the file to be processed |
973 | and/or check the file has been processed before announcing its |
974 | location. |
975 | |
976 | FTP Archives for Perl Modules: |
977 | |
978 | Follow the instructions and links on |
979 | |
980 | http://franz.ww.tu-berlin.de/modulelist |
981 | |
982 | or upload to one of these sites: |
983 | |
984 | ftp://franz.ww.tu-berlin.de/incoming |
985 | ftp://ftp.cis.ufl.edu/incoming |
986 | |
987 | and notify <F<upload@franz.ww.tu-berlin.de>>. |
988 | |
989 | By using the WWW interface you can ask the Upload Server to mirror |
990 | your modules from your ftp or WWW site into your own directory on |
991 | CPAN! |
992 | |
993 | Please remember to send me an updated entry for the Module list! |
994 | |
995 | =item Take care when changing a released module. |
996 | |
997 | Always strive to remain compatible with previous released versions |
998 | (see 2.2 above) Otherwise try to add a mechanism to revert to the |
999 | old behaviour if people rely on it. Document incompatible changes. |
1000 | |
1001 | =back |
1002 | |
1003 | =back |
1004 | |
1005 | =head2 Guidelines for Converting Perl 4 Library Scripts into Modules |
1006 | |
1007 | =over 4 |
1008 | |
1009 | =item There is no requirement to convert anything. |
1010 | |
1011 | If it ain't broke, don't fix it! Perl 4 library scripts should |
1012 | continue to work with no problems. You may need to make some minor |
1013 | changes (like escaping non-array @'s in double quoted strings) but |
1014 | there is no need to convert a .pl file into a Module for just that. |
1015 | |
1016 | =item Consider the implications. |
1017 | |
1018 | All the perl applications which make use of the script will need to |
1019 | be changed (slightly) if the script is converted into a module. Is |
1020 | it worth it unless you plan to make other changes at the same time? |
1021 | |
1022 | =item Make the most of the opportunity. |
1023 | |
1024 | If you are going to convert the script to a module you can use the |
1025 | opportunity to redesign the interface. The 'Guidelines for Module |
1026 | Creation' above include many of the issues you should consider. |
1027 | |
1028 | =item The pl2pm utility will get you started. |
1029 | |
1030 | This utility will read *.pl files (given as parameters) and write |
1031 | corresponding *.pm files. The pl2pm utilities does the following: |
1032 | |
1033 | =over 10 |
1034 | |
1035 | =item * |
1036 | Adds the standard Module prologue lines |
1037 | |
1038 | =item * |
1039 | Converts package specifiers from ' to :: |
1040 | |
1041 | =item * |
1042 | Converts die(...) to croak(...) |
1043 | |
1044 | =item * |
1045 | Several other minor changes |
1046 | |
1047 | =back |
1048 | |
1049 | Being a mechanical process pl2pm is not bullet proof. The converted |
1050 | code will need careful checking, especially any package statements. |
1051 | Don't delete the original .pl file till the new .pm one works! |
1052 | |
1053 | =back |
1054 | |
1055 | =head2 Guidelines for Reusing Application Code |
1056 | |
1057 | =over 4 |
1058 | |
1059 | =item Complete applications rarely belong in the Perl Module Library. |
1060 | |
1061 | =item Many applications contain some perl code which could be reused. |
1062 | |
1063 | Help save the world! Share your code in a form that makes it easy |
1064 | to reuse. |
1065 | |
1066 | =item Break-out the reusable code into one or more separate module files. |
1067 | |
1068 | =item Take the opportunity to reconsider and redesign the interfaces. |
1069 | |
1070 | =item In some cases the 'application' can then be reduced to a small |
1071 | |
1072 | fragment of code built on top of the reusable modules. In these cases |
1073 | the application could invoked as: |
1074 | |
1075 | perl -e 'use Module::Name; method(@ARGV)' ... |
1076 | or |
1077 | perl -mModule::Name ... (in perl5.002 or higher) |
1078 | |
1079 | =back |
1080 | |
1081 | =head1 NOTE |
1082 | |
1083 | Perl does not enforce private and public parts of its modules as you may |
1084 | have been used to in other languages like C++, Ada, or Modula-17. Perl |
1085 | doesn't have an infatuation with enforced privacy. It would prefer |
1086 | that you stayed out of its living room because you weren't invited, not |
1087 | because it has a shotgun. |
1088 | |
1089 | The module and its user have a contract, part of which is common law, |
1090 | and part of which is "written". Part of the common law contract is |
1091 | that a module doesn't pollute any namespace it wasn't asked to. The |
1092 | written contract for the module (A.K.A. documentation) may make other |
1093 | provisions. But then you know when you C<use RedefineTheWorld> that |
1094 | you're redefining the world and willing to take the consequences. |