Make a dummy OPpPAD_STATE and a dummy PL_unitcheck_save available to
[p5sagit/p5-mst-13.2.git] / pod / perlapi.pod
index 992afe8..18b87a1 100644 (file)
@@ -134,6 +134,35 @@ array itself.
 =for hackers
 Found in file av.c
 
+=item av_create_and_push
+X<av_create_and_push>
+
+Push an SV onto the end of the array, creating the array if necessary.
+A small internal helper function to remove a commonly duplicated idiom.
+
+NOTE: this function is experimental and may change or be
+removed without notice.
+
+       void    av_create_and_push(AV **const avp, SV *const val)
+
+=for hackers
+Found in file av.c
+
+=item av_create_and_unshift_one
+X<av_create_and_unshift_one>
+
+Unshifts an SV onto the beginning of the array, creating the array if
+necessary.
+A small internal helper function to remove a commonly duplicated idiom.
+
+NOTE: this function is experimental and may change or be
+removed without notice.
+
+       SV**    av_create_and_unshift_one(AV **const avp, SV *const val)
+
+=for hackers
+Found in file av.c
+
 =item av_delete
 X<av_delete>
 
@@ -628,14 +657,27 @@ Found in file cv.h
 =item get_cv
 X<get_cv>
 
-Returns the CV of the specified Perl subroutine.  If C<create> is set and
-the Perl subroutine does not exist then it will be declared (which has the
-same effect as saying C<sub name;>).  If C<create> is not set and the
-subroutine does not exist then NULL is returned.
+Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
+
+NOTE: the perl_ form of this function is deprecated.
+
+       CV*     get_cv(const char* name, I32 flags)
+
+=for hackers
+Found in file perl.c
+
+=item get_cvn_flags
+X<get_cvn_flags>
+
+Returns the CV of the specified Perl subroutine.  C<flags> are passed to
+C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
+exist then it will be declared (which has the same effect as saying
+C<sub name;>).  If C<GV_ADD> is not set and the subroutine does not exist
+then NULL is returned.
 
 NOTE: the perl_ form of this function is deprecated.
 
-       CV*     get_cv(const char* name, I32 create)
+       CV*     get_cvn_flags(const char* name, STRLEN len, I32 flags)
 
 =for hackers
 Found in file perl.c
@@ -824,6 +866,10 @@ sequence. Thus the output will either be a single char,
 an octal escape sequence, a special escape like C<\n> or a 3 or 
 more digit hex value. 
 
+If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
+not a '\\'. This is because regexes very often contain backslashed
+sequences, whereas '%' is not a particularly common character in patterns.
+
 Returns a pointer to the escaped text as held by dsv.
 
 NOTE: the perl_ form of this function is deprecated.
@@ -1341,12 +1387,10 @@ Found in file gv.c
 =item gv_stashpv
 X<gv_stashpv>
 
-Returns a pointer to the stash for a specified package.  C<name> should
-be a valid UTF-8 string and must be null-terminated.  If C<create> is set
-then the package will be created if it does not already exist.  If C<create>
-is not set and the package does not exist then NULL is returned.
+Returns a pointer to the stash for a specified package.  Uses C<strlen> to
+determine the length of C<name, then calls C<gv_stashpvn()>.
 
-       HV*     gv_stashpv(const char* name, I32 create)
+       HV*     gv_stashpv(const char* name, I32 flags)
 
 =for hackers
 Found in file gv.c
@@ -1354,13 +1398,15 @@ Found in file gv.c
 =item gv_stashpvn
 X<gv_stashpvn>
 
-Returns a pointer to the stash for a specified package.  C<name> should
-be a valid UTF-8 string.  The C<namelen> parameter indicates the length of
-the C<name>, in bytes.  If C<create> is set then the package will be
-created if it does not already exist.  If C<create> is not set and the
-package does not exist then NULL is returned.
+Returns a pointer to the stash for a specified package.  The C<namelen>
+parameter indicates the length of the C<name>, in bytes.  C<flags> is passed
+to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
+created if it does not already exist.  If the package does not exist and
+C<flags> is 0 (or any other setting that does not create packages) then NULL
+is returned.
+
 
-       HV*     gv_stashpvn(const char* name, U32 namelen, I32 create)
+       HV*     gv_stashpvn(const char* name, U32 namelen, I32 flags)
 
 =for hackers
 Found in file gv.c
@@ -1378,10 +1424,9 @@ Found in file handy.h
 =item gv_stashsv
 X<gv_stashsv>
 
-Returns a pointer to the stash for a specified package, which must be a
-valid UTF-8 string.  See C<gv_stashpv>.
+Returns a pointer to the stash for a specified package.  See C<gv_stashpvn>.
 
-       HV*     gv_stashsv(SV* sv, I32 create)
+       HV*     gv_stashsv(SV* sv, I32 flags)
 
 =for hackers
 Found in file gv.c
@@ -2307,6 +2352,18 @@ which is shared between threads.
 =for hackers
 Found in file util.c
 
+=item savesharedpvn
+X<savesharedpvn>
+
+A version of C<savepvn()> which allocates the duplicate string in memory
+which is shared between threads. (With the specific difference that a NULL
+pointer is not acceptable)
+
+       char*   savesharedpvn(const char *const pv, const STRLEN len)
+
+=for hackers
+Found in file util.c
+
 =item savesvpv
 X<savesvpv>
 
@@ -3752,9 +3809,9 @@ Found in file sv.h
 =item SvIOK
 X<SvIOK>
 
-Returns a boolean indicating whether the SV contains an integer.
+Returns a U32 value indicating whether the SV contains an integer.
 
-       bool    SvIOK(SV* sv)
+       U32     SvIOK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -3762,10 +3819,10 @@ Found in file sv.h
 =item SvIOKp
 X<SvIOKp>
 
-Returns a boolean indicating whether the SV contains an integer.  Checks
+Returns a U32 value indicating whether the SV contains an integer.  Checks
 the B<private> setting.  Use C<SvIOK>.
 
-       bool    SvIOKp(SV* sv)
+       U32     SvIOKp(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -3856,7 +3913,7 @@ Found in file sv.h
 =item SvIV
 X<SvIV>
 
-Coerces the given SV to an integer and returns it. See  C<SvIVx> for a
+Coerces the given SV to an integer and returns it. See C<SvIVx> for a
 version which guarantees to evaluate sv only once.
 
        IV      SvIV(SV* sv)
@@ -3943,10 +4000,10 @@ Found in file sv.h
 =item SvNIOK
 X<SvNIOK>
 
-Returns a boolean indicating whether the SV contains a number, integer or
+Returns a U32 value indicating whether the SV contains a number, integer or
 double.
 
-       bool    SvNIOK(SV* sv)
+       U32     SvNIOK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -3954,10 +4011,10 @@ Found in file sv.h
 =item SvNIOKp
 X<SvNIOKp>
 
-Returns a boolean indicating whether the SV contains a number, integer or
+Returns a U32 value indicating whether the SV contains a number, integer or
 double.  Checks the B<private> setting.  Use C<SvNIOK>.
 
-       bool    SvNIOKp(SV* sv)
+       U32     SvNIOKp(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -3975,9 +4032,9 @@ Found in file sv.h
 =item SvNOK
 X<SvNOK>
 
-Returns a boolean indicating whether the SV contains a double.
+Returns a U32 value indicating whether the SV contains a double.
 
-       bool    SvNOK(SV* sv)
+       U32     SvNOK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -3985,10 +4042,10 @@ Found in file sv.h
 =item SvNOKp
 X<SvNOKp>
 
-Returns a boolean indicating whether the SV contains a double.  Checks the
+Returns a U32 value indicating whether the SV contains a double.  Checks the
 B<private> setting.  Use C<SvNOK>.
 
-       bool    SvNOKp(SV* sv)
+       U32     SvNOKp(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -4026,7 +4083,7 @@ Found in file sv.h
 =item SvNV
 X<SvNV>
 
-Coerce the given SV to a double and return it. See  C<SvNVx> for a version
+Coerce the given SV to a double and return it. See C<SvNVx> for a version
 which guarantees to evaluate sv only once.
 
        NV      SvNV(SV* sv)
@@ -4069,10 +4126,10 @@ Found in file sv.h
 =item SvOK
 X<SvOK>
 
-Returns a boolean indicating whether the value is an SV. It also tells
+Returns a U32 value indicating whether the value is an SV. It also tells
 whether the value is defined or not.
 
-       bool    SvOK(SV* sv)
+       U32     SvOK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -4080,12 +4137,12 @@ Found in file sv.h
 =item SvOOK
 X<SvOOK>
 
-Returns a boolean indicating whether the SvIVX is a valid offset value for
+Returns a U32 indicating whether the SvIVX is a valid offset value for
 the SvPVX.  This hack is used internally to speed up removal of characters
 from the beginning of a SvPV.  When SvOOK is true, then the start of the
 allocated string buffer is really (SvPVX - SvIVX).
 
-       bool    SvOOK(SV* sv)
+       U32     SvOOK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -4093,10 +4150,10 @@ Found in file sv.h
 =item SvPOK
 X<SvPOK>
 
-Returns a boolean indicating whether the SV contains a character
+Returns a U32 value indicating whether the SV contains a character
 string.
 
-       bool    SvPOK(SV* sv)
+       U32     SvPOK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -4104,10 +4161,10 @@ Found in file sv.h
 =item SvPOKp
 X<SvPOKp>
 
-Returns a boolean indicating whether the SV contains a character string.
+Returns a U32 value indicating whether the SV contains a character string.
 Checks the B<private> setting.  Use C<SvPOK>.
 
-       bool    SvPOKp(SV* sv)
+       U32     SvPOKp(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -4474,7 +4531,7 @@ X<SvROK>
 
 Tests if the SV is an RV.
 
-       bool    SvROK(SV* sv)
+       U32     SvROK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -4611,7 +4668,7 @@ X<SvUOK>
 
 Returns a boolean indicating whether the SV contains an unsigned integer.
 
-       void    SvUOK(SV* sv)
+       bool    SvUOK(SV* sv)
 
 =for hackers
 Found in file sv.h
@@ -4630,11 +4687,11 @@ Found in file sv.h
 =item SvUTF8
 X<SvUTF8>
 
-Returns a boolean indicating whether the SV contains UTF-8 encoded data.
+Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
 Call this after SvPV() in case any call to string overloading updates the
 internal flag.
 
-       bool    SvUTF8(SV* sv)
+       U32     SvUTF8(SV* sv)
 
 =for hackers
 Found in file sv.h