FM / pod

/usr/share/perl5/pod

Name	Size	Mode	Actions
perl.pod	16667	0644	edit dl rm
perl56delta.pod	107201	0644	edit dl rm
perl58delta.pod	115165	0644	edit dl rm
perl561delta.pod	124713	0644	edit dl rm
perl581delta.pod	38060	0644	edit dl rm
perl582delta.pod	4470	0644	edit dl rm
perl583delta.pod	6335	0644	edit dl rm
perl584delta.pod	7363	0644	edit dl rm
perl585delta.pod	5889	0644	edit dl rm
perl586delta.pod	4651	0644	edit dl rm
perl587delta.pod	8357	0644	edit dl rm
perl588delta.pod	25281	0644	edit dl rm
perl589delta.pod	53904	0644	edit dl rm
perl5004delta.pod	56240	0644	edit dl rm
perl5005delta.pod	34283	0644	edit dl rm
perl5100delta.pod	55533	0644	edit dl rm
perl5101delta.pod	43888	0644	edit dl rm
perl5120delta.pod	89271	0644	edit dl rm
perl5121delta.pod	10141	0644	edit dl rm
perl5122delta.pod	9603	0644	edit dl rm
perl5123delta.pod	4100	0644	edit dl rm
perl5124delta.pod	3672	0644	edit dl rm
perl5125delta.pod	7683	0644	edit dl rm
perl5140delta.pod	144325	0644	edit dl rm
perl5141delta.pod	7966	0644	edit dl rm
perl5142delta.pod	6892	0644	edit dl rm
perl5143delta.pod	7760	0644	edit dl rm
perl5144delta.pod	6327	0644	edit dl rm
perl5160delta.pod	133651	0644	edit dl rm
perl5161delta.pod	6142	0644	edit dl rm
perl5162delta.pod	3594	0644	edit dl rm
perl5163delta.pod	4085	0644	edit dl rm
perl5180delta.pod	119429	0644	edit dl rm
perl5181delta.pod	6597	0644	edit dl rm
perl5182delta.pod	5335	0644	edit dl rm
perl5184delta.pod	4642	0644	edit dl rm
perl5200delta.pod	115698	0644	edit dl rm
perl5201delta.pod	10899	0644	edit dl rm
perl5202delta.pod	12509	0644	edit dl rm
perl5203delta.pod	9392	0644	edit dl rm
perl5220delta.pod	130963	0644	edit dl rm
perl5221delta.pod	10767	0644	edit dl rm
perl5222delta.pod	12629	0644	edit dl rm
perl5223delta.pod	8456	0644	edit dl rm
perl5224delta.pod	4460	0644	edit dl rm
perl5240delta.pod	64923	0644	edit dl rm
perl5241delta.pod	8215	0644	edit dl rm
perl5242delta.pod	4113	0644	edit dl rm
perl5243delta.pod	11428	0644	edit dl rm
perl5244delta.pod	4510	0644	edit dl rm
perl5260delta.pod	101835	0644	edit dl rm
perl5261delta.pod	7927	0644	edit dl rm
perl5262delta.pod	7880	0644	edit dl rm
perl5263delta.pod	7067	0644	edit dl rm
perl5280delta.pod	72113	0644	edit dl rm
perl5281delta.pod	4639	0644	edit dl rm
perl5282delta.pod	6200	0644	edit dl rm
perl5283delta.pod	5111	0644	edit dl rm
perl5300delta.pod	41281	0644	edit dl rm
perl5301delta.pod	5730	0644	edit dl rm
perl5302delta.pod	4682	0644	edit dl rm
perl5303delta.pod	4980	0644	edit dl rm
perl5320delta.pod	54601	0644	edit dl rm
perl5321delta.pod	7003	0644	edit dl rm
perlaix.pod	20438	0644	edit dl rm
perlamiga.pod	5749	0644	edit dl rm
perlandroid.pod	8222	0644	edit dl rm
perlapi.pod	493106	0644	edit dl rm
perlapio.pod	21336	0644	edit dl rm
perlartistic.pod	7010	0644	edit dl rm
perlbook.pod	8386	0644	edit dl rm
perlboot.pod	294	0644	edit dl rm
perlbot.pod	304	0644	edit dl rm
perlbs2000.pod	7994	0644	edit dl rm
perlcall.pod	56738	0644	edit dl rm
perlcheat.pod	4480	0644	edit dl rm
perlclib.pod	9607	0644	edit dl rm
perlcn.pod	4763	0644	edit dl rm
perlcommunity.pod	6983	0644	edit dl rm
perlcygwin.pod	27202	0644	edit dl rm
perldata.pod	49782	0644	edit dl rm
perldbmfilter.pod	4981	0644	edit dl rm
perldebguts.pod	42331	0644	edit dl rm
perldebtut.pod	22152	0644	edit dl rm
perldebug.pod	39383	0644	edit dl rm
perldelta.pod	7003	0644	edit dl rm
perldeprecation.pod	20825	0644	edit dl rm
perldiag.pod	296986	0644	edit dl rm
perldos.pod	10522	0644	edit dl rm
perldsc.pod	25614	0644	edit dl rm
perldtrace.pod	7959	0644	edit dl rm
perlebcdic.pod	84345	0644	edit dl rm
perlembed.pod	37569	0644	edit dl rm
perlexperiment.pod	7234	0644	edit dl rm
perlfork.pod	13355	0644	edit dl rm
perlform.pod	16608	0644	edit dl rm
perlfreebsd.pod	1623	0644	edit dl rm
perlfunc.pod	403777	0644	edit dl rm
perlgit.pod	29591	0644	edit dl rm
perlgov.pod	14481	0644	edit dl rm
perlgpl.pod	13815	0644	edit dl rm
perlguts.pod	162103	0644	edit dl rm
perlhack.pod	43157	0644	edit dl rm
perlhacktips.pod	57692	0644	edit dl rm
perlhacktut.pod	6153	0644	edit dl rm
perlhaiku.pod	1508	0644	edit dl rm
perlhist.pod	56164	0644	edit dl rm
perlhpux.pod	30609	0644	edit dl rm
perlhurd.pod	1994	0644	edit dl rm
perlintern.pod	83565	0644	edit dl rm
perlinterp.pod	33715	0644	edit dl rm
perlintro.pod	22135	0644	edit dl rm
perliol.pod	34804	0644	edit dl rm
perlipc.pod	71529	0644	edit dl rm
perlirix.pod	4415	0644	edit dl rm
perljp.pod	8431	0644	edit dl rm
perlko.pod	12208	0644	edit dl rm
perllexwarn.pod	355	0644	edit dl rm
perllinux.pod	2007	0644	edit dl rm
perllocale.pod	74112	0644	edit dl rm
perllol.pod	9580	0644	edit dl rm
perlmacos.pod	998	0644	edit dl rm
perlmacosx.pod	12124	0644	edit dl rm
perlmod.pod	26197	0644	edit dl rm
perlmodinstall.pod	10261	0644	edit dl rm
perlmodlib.pod	76348	0644	edit dl rm
perlmodstyle.pod	22588	0644	edit dl rm
perlmroapi.pod	3280	0644	edit dl rm
perlnetware.pod	6648	0644	edit dl rm
perlnewmod.pod	11037	0644	edit dl rm
perlnumber.pod	8353	0644	edit dl rm
perlobj.pod	35717	0644	edit dl rm
perlootut.pod	26757	0644	edit dl rm
perlop.pod	148888	0644	edit dl rm
perlopenbsd.pod	1224	0644	edit dl rm
perlopentut.pod	15223	0644	edit dl rm
perlos2.pod	93348	0644	edit dl rm
perlos390.pod	16527	0644	edit dl rm
perlos400.pod	4765	0644	edit dl rm
perlpacktut.pod	51370	0644	edit dl rm
perlperf.pod	49881	0644	edit dl rm
perlplan9.pod	5125	0644	edit dl rm
perlpod.pod	23076	0644	edit dl rm
perlpodspec.pod	68628	0644	edit dl rm
perlpolicy.pod	26562	0644	edit dl rm
perlport.pod	88693	0644	edit dl rm
perlpragma.pod	5176	0644	edit dl rm
perlqnx.pod	6673	0644	edit dl rm
perlre.pod	130817	0644	edit dl rm
perlreapi.pod	30245	0644	edit dl rm
perlrebackslash.pod	32285	0644	edit dl rm
perlrecharclass.pod	49707	0644	edit dl rm
perlref.pod	35432	0644	edit dl rm
perlreftut.pod	18826	0644	edit dl rm
perlreguts.pod	39301	0644	edit dl rm
perlrepository.pod	509	0644	edit dl rm
perlrequick.pod	19141	0644	edit dl rm
perlreref.pod	15590	0644	edit dl rm
perlretut.pod	122527	0644	edit dl rm
perlriscos.pod	1529	0644	edit dl rm
perlrun.pod	55980	0644	edit dl rm
perlsec.pod	27601	0644	edit dl rm
perlsecpolicy.pod	19450	0644	edit dl rm
perlsolaris.pod	29843	0644	edit dl rm
perlsource.pod	7132	0644	edit dl rm
perlstyle.pod	8734	0644	edit dl rm
perlsub.pod	74405	0644	edit dl rm
perlsymbian.pod	15344	0644	edit dl rm
perlsyn.pod	45138	0644	edit dl rm
perlsynology.pod	7960	0644	edit dl rm
perlthrtut.pod	46522	0644	edit dl rm
perltie.pod	39314	0644	edit dl rm
perltoc.pod	701800	0644	edit dl rm
perltodo.pod	372	0644	edit dl rm
perltooc.pod	294	0644	edit dl rm
perltoot.pod	294	0644	edit dl rm
perltrap.pod	10623	0644	edit dl rm
perltru64.pod	8492	0644	edit dl rm
perltw.pod	4463	0644	edit dl rm
perlunicode.pod	91353	0644	edit dl rm
perlunicook.pod	25658	0644	edit dl rm
perlunifaq.pod	13644	0644	edit dl rm
perluniintro.pod	38647	0644	edit dl rm
perluniprops.pod	441614	0644	edit dl rm
perlunitut.pod	7951	0644	edit dl rm
perlutil.pod	7291	0644	edit dl rm
perlvar.pod	82577	0644	edit dl rm
perlvms.pod	50823	0644	edit dl rm
perlvos.pod	3843	0644	edit dl rm
perlwin32.pod	40317	0644	edit dl rm

Edit: /usr/share/perl5/pod/perlclib.pod (9607B)

=head1 NAME

perlclib - Internal replacements for standard C library functions

=head1 DESCRIPTION

One thing Perl porters should note is that F<perl> doesn't tend to use that
much of the C standard library internally; you'll see very little use of, 
for example, the F<ctype.h> functions in there. This is because Perl
tends to reimplement or abstract standard library functions, so that we
know exactly how they're going to operate.

This is a reference card for people who are familiar with the C library
and who want to do things the Perl way; to tell them which functions
they ought to use instead of the more normal C functions.

=head2 Conventions

In the following tables:

=over 3

=item C<t>

is a type.

=item C<p>

is a pointer.

=item C<n>

is a number.

=item C<s>

is a string.

=back

C<sv>, C<av>, C<hv>, etc. represent variables of their respective types.

=head2 File Operations

Instead of the F<stdio.h> functions, you should use the Perl abstraction
layer. Instead of C<FILE*> types, you need to be handling C<PerlIO*>
types.  Don't forget that with the new PerlIO layered I/O abstraction 
C<FILE*> types may not even be available. See also the C<perlapio>
documentation for more information about the following functions:

Instead Of:                 Use:

stdin                       PerlIO_stdin()
 stdout                      PerlIO_stdout()
 stderr                      PerlIO_stderr()

fopen(fn, mode)             PerlIO_open(fn, mode)
 freopen(fn, mode, stream)   PerlIO_reopen(fn, mode, perlio) (Dep-
                               recated)
 fflush(stream)              PerlIO_flush(perlio)
 fclose(stream)              PerlIO_close(perlio)

=head2 File Input and Output

Instead Of:                 Use:

fprintf(stream, fmt, ...)   PerlIO_printf(perlio, fmt, ...)

[f]getc(stream)             PerlIO_getc(perlio)
 [f]putc(stream, n)          PerlIO_putc(perlio, n)
 ungetc(n, stream)           PerlIO_ungetc(perlio, n)

Note that the PerlIO equivalents of C<fread> and C<fwrite> are slightly
different from their C library counterparts:

fread(p, size, n, stream)   PerlIO_read(perlio, buf, numbytes)
 fwrite(p, size, n, stream)  PerlIO_write(perlio, buf, numbytes)

fputs(s, stream)            PerlIO_puts(perlio, s)

There is no equivalent to C<fgets>; one should use C<sv_gets> instead:

fgets(s, n, stream)         sv_gets(sv, perlio, append)

=head2 File Positioning

Instead Of:                 Use:

feof(stream)                PerlIO_eof(perlio)
 fseek(stream, n, whence)    PerlIO_seek(perlio, n, whence)
 rewind(stream)              PerlIO_rewind(perlio)

fgetpos(stream, p)          PerlIO_getpos(perlio, sv)
 fsetpos(stream, p)          PerlIO_setpos(perlio, sv)

ferror(stream)              PerlIO_error(perlio)
 clearerr(stream)            PerlIO_clearerr(perlio)

=head2 Memory Management and String Handling

Instead Of:                    Use:

t* p = malloc(n)               Newx(p, n, t)
 t* p = calloc(n, s)            Newxz(p, n, t)
 p = realloc(p, n)              Renew(p, n, t)
 memcpy(dst, src, n)            Copy(src, dst, n, t)
 memmove(dst, src, n)           Move(src, dst, n, t)
 memcpy(dst, src, sizeof(t))    StructCopy(src, dst, t)
 memset(dst, 0, n * sizeof(t))  Zero(dst, n, t)
 memzero(dst, 0)                Zero(dst, n, char)
 free(p)                        Safefree(p)

strdup(p)                      savepv(p)
 strndup(p, n)                  savepvn(p, n) (Hey, strndup doesn't
                                               exist!)

strstr(big, little)            instr(big, little)
 strcmp(s1, s2)                 strLE(s1, s2) / strEQ(s1, s2)
                                              / strGT(s1,s2)
 strncmp(s1, s2, n)             strnNE(s1, s2, n) / strnEQ(s1, s2, n)

memcmp(p1, p2, n)              memNE(p1, p2, n)
 !memcmp(p1, p2, n)             memEQ(p1, p2, n)

Notice the different order of arguments to C<Copy> and C<Move> than used
in C<memcpy> and C<memmove>.

Most of the time, though, you'll want to be dealing with SVs internally
instead of raw C<char *> strings:

strlen(s)                   sv_len(sv)
 strcpy(dt, src)             sv_setpv(sv, s)
 strncpy(dt, src, n)         sv_setpvn(sv, s, n)
 strcat(dt, src)             sv_catpv(sv, s)
 strncat(dt, src)            sv_catpvn(sv, s)
 sprintf(s, fmt, ...)        sv_setpvf(sv, fmt, ...)

Note also the existence of C<sv_catpvf> and C<sv_vcatpvfn>, combining
concatenation with formatting.

Sometimes instead of zeroing the allocated heap by using Newxz() you
should consider "poisoning" the data.  This means writing a bit
pattern into it that should be illegal as pointers (and floating point
numbers), and also hopefully surprising enough as integers, so that
any code attempting to use the data without forethought will break
sooner rather than later.  Poisoning can be done using the Poison()
macros, which have similar arguments to Zero():

PoisonWith(dst, n, t, b)    scribble memory with byte b
 PoisonNew(dst, n, t)        equal to PoisonWith(dst, n, t, 0xAB)
 PoisonFree(dst, n, t)       equal to PoisonWith(dst, n, t, 0xEF)
 Poison(dst, n, t)           equal to PoisonFree(dst, n, t)

=head2 Character Class Tests

There are several types of character class tests that Perl implements.
The only ones described here are those that directly correspond to C
library functions that operate on 8-bit characters, but there are
equivalents that operate on wide characters, and UTF-8 encoded strings.
All are more fully described in L<perlapi/Character classification> and
L<perlapi/Character case changing>.

The C library routines listed in the table below return values based on
the current locale.  Use the entries in the final column for that
functionality.  The other two columns always assume a POSIX (or C)
locale.  The entries in the ASCII column are only meaningful for ASCII
inputs, returning FALSE for anything else.  Use these only when you
B<know> that is what you want.  The entries in the Latin1 column assume
that the non-ASCII 8-bit characters are as Unicode defines, them, the
same as ISO-8859-1, often called Latin 1.

Instead Of:  Use for ASCII:   Use for Latin1:      Use for locale:

isalnum(c)  isALPHANUMERIC(c) isALPHANUMERIC_L1(c) isALPHANUMERIC_LC(c)
 isalpha(c)  isALPHA(c)        isALPHA_L1(c)        isALPHA_LC(u )
 isascii(c)  isASCII(c)                             isASCII_LC(c)
 isblank(c)  isBLANK(c)        isBLANK_L1(c)        isBLANK_LC(c)
 iscntrl(c)  isCNTRL(c)        isCNTRL_L1(c)        isCNTRL_LC(c)
 isdigit(c)  isDIGIT(c)        isDIGIT_L1(c)        isDIGIT_LC(c)
 isgraph(c)  isGRAPH(c)        isGRAPH_L1(c)        isGRAPH_LC(c)
 islower(c)  isLOWER(c)        isLOWER_L1(c)        isLOWER_LC(c)
 isprint(c)  isPRINT(c)        isPRINT_L1(c)        isPRINT_LC(c)
 ispunct(c)  isPUNCT(c)        isPUNCT_L1(c)        isPUNCT_LC(c)
 isspace(c)  isSPACE(c)        isSPACE_L1(c)        isSPACE_LC(c)
 isupper(c)  isUPPER(c)        isUPPER_L1(c)        isUPPER_LC(c)
 isxdigit(c) isXDIGIT(c)       isXDIGIT_L1(c)       isXDIGIT_LC(c)

tolower(c)  toLOWER(c)        toLOWER_L1(c)        toLOWER_LC(c)
 toupper(c)  toUPPER(c)                             toUPPER_LC(c)

To emphasize that you are operating only on ASCII characters, you can
append C<_A> to each of the macros in the ASCII column: C<isALPHA_A>,
C<isDIGIT_A>, and so on.

(There is no entry in the Latin1 column for C<isascii> even though there
is an C<isASCII_L1>, which is identical to C<isASCII>;  the
latter name is clearer.  There is no entry in the Latin1 column for
C<toupper> because the result can be non-Latin1.  You have to use
C<toUPPER_uni>, as described in L<perlapi/Character case changing>.)

=head2 F<stdlib.h> functions

Instead Of:                 Use:

atof(s)                     Atof(s)
 atoi(s)                     grok_atoUV(s, &uv, &e)
 atol(s)                     grok_atoUV(s, &uv, &e)
 strtod(s, &p)               Strtod(s, &p)
 strtol(s, &p, n)            Strtol(s, &p, b)
 strtoul(s, &p, n)           Strtoul(s, &p, b)

Typical use is to do range checks on C<uv> before casting:

int i; UV uv;
  char* end_ptr = input_end;
  if (grok_atoUV(input, &uv, &end_ptr)
      && uv <= INT_MAX)
    i = (int)uv;
    ... /* continue parsing from end_ptr */
  } else {
    ... /* parse error: not a decimal integer in range 0 .. MAX_IV */
  }

Notice also the C<grok_bin>, C<grok_hex>, and C<grok_oct> functions in
F<numeric.c> for converting strings representing numbers in the respective
bases into C<NV>s.  Note that grok_atoUV() doesn't handle negative inputs,
or leading whitespace (being purposefully strict).

Note that strtol() and strtoul() may be disguised as Strtol(), Strtoul(),
Atol(), Atoul().  Avoid those, too.

In theory C<Strtol> and C<Strtoul> may not be defined if the machine perl is
built on doesn't actually have strtol and strtoul. But as those 2
functions are part of the 1989 ANSI C spec we suspect you'll find them
everywhere by now.

int rand()                  double Drand01()
 srand(n)                    { seedDrand01((Rand_seed_t)n);
                               PL_srand_called = TRUE; }

exit(n)                     my_exit(n)
 system(s)                   Don't. Look at pp_system or use my_popen.

getenv(s)                   PerlEnv_getenv(s)
 setenv(s, val)              my_setenv(s, val)

=head2 Miscellaneous functions

You should not even B<want> to use F<setjmp.h> functions, but if you
think you do, use the C<JMPENV> stack in F<scope.h> instead.

For C<signal>/C<sigaction>, use C<rsignal(signo, handler)>.

=head1 SEE ALSO

L<perlapi>, L<perlapio>, L<perlguts>

cmd: