perlapi - autogenerated documentation for the perl public API
=head1 DESCRIPTION
+X<Perl API> X<API> X<api>
This file contains the documentation of the perl public API generated by
embed.pl, specifically a listing of functions, macros, flags, and variables
=over 8
=item GIMME
+X<GIMME>
A backward-compatible version of C<GIMME_V> which can only return
C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
Found in file op.h
=item GIMME_V
+X<GIMME_V>
The XSUB-writer's equivalent to Perl's C<wantarray>. Returns C<G_VOID>,
C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
Found in file op.h
=item G_ARRAY
+X<G_ARRAY>
Used to indicate list context. See C<GIMME_V>, C<GIMME> and
L<perlcall>.
Found in file cop.h
=item G_DISCARD
+X<G_DISCARD>
Indicates that arguments returned from a callback should be discarded. See
L<perlcall>.
Found in file cop.h
=item G_EVAL
+X<G_EVAL>
Used to force a Perl C<eval> wrapper around a callback. See
L<perlcall>.
Found in file cop.h
=item G_NOARGS
+X<G_NOARGS>
Indicates that no arguments are being sent to a callback. See
L<perlcall>.
Found in file cop.h
=item G_SCALAR
+X<G_SCALAR>
Used to indicate scalar context. See C<GIMME_V>, C<GIMME>, and
L<perlcall>.
Found in file cop.h
=item G_VOID
+X<G_VOID>
Used to indicate void context. See C<GIMME_V> and L<perlcall>.
=over 8
=item AvFILL
+X<AvFILL>
Same as C<av_len()>. Deprecated, use C<av_len()> instead.
Found in file av.h
=item av_clear
+X<av_clear>
Clears an array, making it empty. Does not free the memory used by the
array itself.
Found in file av.c
=item av_delete
+X<av_delete>
Deletes the element indexed by C<key> from the array. Returns the
deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
Found in file av.c
=item av_exists
+X<av_exists>
Returns true if the element indexed by C<key> has been initialized.
Found in file av.c
=item av_extend
+X<av_extend>
Pre-extend an array. The C<key> is the index to which the array should be
extended.
Found in file av.c
=item av_fetch
+X<av_fetch>
Returns the SV at the specified index in the array. The C<key> is the
index. If C<lval> is set then the fetch will be part of a store. Check
Found in file av.c
=item av_fill
+X<av_fill>
Ensure than an array has a given number of elements, equivalent to
Perl's C<$#array = $fill;>.
Found in file av.c
=item av_len
+X<av_len>
Returns the highest index in the array. Returns -1 if the array is
empty.
Found in file av.c
=item av_make
+X<av_make>
Creates a new AV and populates it with a list of SVs. The SVs are copied
into the array, so they may be freed after the call to av_make. The new AV
Found in file av.c
=item av_pop
+X<av_pop>
Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
is empty.
Found in file av.c
=item av_push
+X<av_push>
Pushes an SV onto the end of the array. The array will grow automatically
to accommodate the addition.
Found in file av.c
=item av_shift
+X<av_shift>
Shifts an SV off the beginning of the array.
Found in file av.c
=item av_store
+X<av_store>
Stores an SV in an array. The array index is specified as C<key>. The
return value will be NULL if the operation failed or if the value did not
Found in file av.c
=item av_undef
+X<av_undef>
Undefines the array. Frees the memory used by the array itself.
Found in file av.c
=item av_unshift
+X<av_unshift>
Unshift the given number of C<undef> values onto the beginning of the
array. The array will grow automatically to accommodate the addition. You
Found in file av.c
=item get_av
+X<get_av>
Returns the AV of the specified Perl array. If C<create> is set and the
Perl variable does not exist then it will be created. If C<create> is not
Found in file perl.c
=item newAV
+X<newAV>
Creates a new AV. The reference count is set to 1.
Found in file av.c
=item sortsv
+X<sortsv>
Sort an array. Here is an example:
sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
-See lib/sort.pm for details about controlling the sorting algorithm.
+Currently this always uses mergesort. See sortsv_flags for a more
+flexible routine.
- void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
+ void sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)
+
+=for hackers
+Found in file pp_sort.c
+
+=item sortsv_flags
+X<sortsv_flags>
+
+Sort an array, with various options.
+
+ void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)
=for hackers
Found in file pp_sort.c
=over 8
=item call_argv
+X<call_argv>
Performs a callback to the specified Perl sub. See L<perlcall>.
Found in file perl.c
=item call_method
+X<call_method>
Performs a callback to the specified Perl method. The blessed object must
be on the stack. See L<perlcall>.
Found in file perl.c
=item call_pv
+X<call_pv>
Performs a callback to the specified Perl sub. See L<perlcall>.
Found in file perl.c
=item call_sv
+X<call_sv>
Performs a callback to the Perl sub whose name is in the SV. See
L<perlcall>.
Found in file perl.c
=item ENTER
+X<ENTER>
Opening bracket on a callback. See C<LEAVE> and L<perlcall>.
Found in file scope.h
=item eval_pv
+X<eval_pv>
Tells Perl to C<eval> the given string and return an SV* result.
Found in file perl.c
=item eval_sv
+X<eval_sv>
Tells Perl to C<eval> the string in the SV.
Found in file perl.c
=item FREETMPS
+X<FREETMPS>
Closing bracket for temporaries on a callback. See C<SAVETMPS> and
L<perlcall>.
Found in file scope.h
=item LEAVE
+X<LEAVE>
Closing bracket on a callback. See C<ENTER> and L<perlcall>.
Found in file scope.h
=item SAVETMPS
+X<SAVETMPS>
Opening bracket for temporaries on a callback. See C<FREETMPS> and
L<perlcall>.
=over 8
=item isALNUM
+X<isALNUM>
Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
character (including underscore) or digit.
Found in file handy.h
=item isALPHA
+X<isALPHA>
Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
character.
Found in file handy.h
=item isDIGIT
+X<isDIGIT>
Returns a boolean indicating whether the C C<char> is an ASCII
digit.
Found in file handy.h
=item isLOWER
+X<isLOWER>
Returns a boolean indicating whether the C C<char> is a lowercase
character.
Found in file handy.h
=item isSPACE
+X<isSPACE>
Returns a boolean indicating whether the C C<char> is whitespace.
Found in file handy.h
=item isUPPER
+X<isUPPER>
Returns a boolean indicating whether the C C<char> is an uppercase
character.
Found in file handy.h
=item toLOWER
+X<toLOWER>
Converts the specified character to lowercase.
Found in file handy.h
=item toUPPER
+X<toUPPER>
Converts the specified character to uppercase.
=over 8
=item perl_clone
+X<perl_clone>
Create and return a new interpreter by cloning the current one.
=over 8
=item CvSTASH
+X<CvSTASH>
Returns the stash of the CV.
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
=over 8
=item cv_undef
+X<cv_undef>
Clear out all the active components of a CV. This can happen either
by an explicit C<undef &foo>, or by the reference count going to zero.
Found in file op.c
=item load_module
+X<load_module>
Loads the module whose name is pointed to by the string part of name.
Note that the actual module name, not its filename, should be given.
Found in file op.c
=item nothreadhook
+X<nothreadhook>
Stub that provides thread hook for perl_destruct when there are
no threads.
Found in file perl.c
=item perl_alloc
+X<perl_alloc>
Allocates a new Perl interpreter. See L<perlembed>.
Found in file perl.c
=item perl_construct
+X<perl_construct>
Initializes a new Perl interpreter. See L<perlembed>.
Found in file perl.c
=item perl_destruct
+X<perl_destruct>
Shuts down a Perl interpreter. See L<perlembed>.
Found in file perl.c
=item perl_free
+X<perl_free>
Releases a Perl interpreter. See L<perlembed>.
Found in file perl.c
=item perl_parse
+X<perl_parse>
Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
Found in file perl.c
=item perl_run
+X<perl_run>
Tells a Perl interpreter to run. See L<perlembed>.
Found in file perl.c
=item require_pv
+X<require_pv>
Tells Perl to C<require> the file named by the string argument. It is
analogous to the Perl code C<eval "require '$file'">. It's even
=back
-=head1 Functions in file pp_pack.c
+=head1 Functions in file mathoms.c
=over 8
-=item packlist
+=item gv_fetchmethod
+X<gv_fetchmethod>
-The engine implementing pack() Perl function.
+See L<gv_fetchmethod_autoload>.
- void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
+ GV* gv_fetchmethod(HV* stash, const char* name)
=for hackers
-Found in file pp_pack.c
+Found in file mathoms.c
=item pack_cat
+X<pack_cat>
The engine implementing pack() Perl function. Note: parameters next_in_list and
flags are not used. This call should not be used; use packlist instead.
void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
=for hackers
-Found in file pp_pack.c
+Found in file mathoms.c
-=item unpackstring
+=item sv_2pvbyte_nolen
+X<sv_2pvbyte_nolen>
-The engine implementing unpack() Perl function. C<unpackstring> puts the
-extracted list items on the stack and returns the number of elements.
-Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
+Return a pointer to the byte-encoded representation of the SV.
+May cause the SV to be downgraded from UTF-8 as a side-effect.
- I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
+Usually accessed via the C<SvPVbyte_nolen> macro.
+
+ char* sv_2pvbyte_nolen(SV* sv)
=for hackers
-Found in file pp_pack.c
+Found in file mathoms.c
+
+=item sv_2pvutf8_nolen
+X<sv_2pvutf8_nolen>
+
+Return a pointer to the UTF-8-encoded representation of the SV.
+May cause the SV to be upgraded to UTF-8 as a side-effect.
+
+Usually accessed via the C<SvPVutf8_nolen> macro.
+
+ char* sv_2pvutf8_nolen(SV* sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_2pv_nolen
+X<sv_2pv_nolen>
+
+Like C<sv_2pv()>, but doesn't return the length too. You should usually
+use the macro wrapper C<SvPV_nolen(sv)> instead.
+ char* sv_2pv_nolen(SV* sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_catpvn_mg
+X<sv_catpvn_mg>
+
+Like C<sv_catpvn>, but also handles 'set' magic.
+
+ void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_catsv_mg
+X<sv_catsv_mg>
+
+Like C<sv_catsv>, but also handles 'set' magic.
+
+ void sv_catsv_mg(SV *dstr, SV *sstr)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_force_normal
+X<sv_force_normal>
+
+Undo various types of fakery on an SV: if the PV is a shared string, make
+a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
+an xpvmg. See also C<sv_force_normal_flags>.
+
+ void sv_force_normal(SV *sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_iv
+X<sv_iv>
+
+A private implementation of the C<SvIVx> macro for compilers which can't
+cope with complex macro expressions. Always use the macro instead.
+
+ IV sv_iv(SV* sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_nolocking
+X<sv_nolocking>
+
+Dummy routine which "locks" an SV when there is no locking module present.
+Exists to avoid test for a NULL function pointer and because it could
+potentially warn under some level of strict-ness.
+
+"Superseded" by sv_nosharing().
+
+ void sv_nolocking(SV *sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_nounlocking
+X<sv_nounlocking>
+
+Dummy routine which "unlocks" an SV when there is no locking module present.
+Exists to avoid test for a NULL function pointer and because it could
+potentially warn under some level of strict-ness.
+
+"Superseded" by sv_nosharing().
+
+ void sv_nounlocking(SV *sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_nv
+X<sv_nv>
+
+A private implementation of the C<SvNVx> macro for compilers which can't
+cope with complex macro expressions. Always use the macro instead.
+
+ NV sv_nv(SV* sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_pv
+X<sv_pv>
+
+Use the C<SvPV_nolen> macro instead
+
+ char* sv_pv(SV *sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_pvbyte
+X<sv_pvbyte>
+
+Use C<SvPVbyte_nolen> instead.
+
+ char* sv_pvbyte(SV *sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_pvbyten
+X<sv_pvbyten>
+
+A private implementation of the C<SvPVbyte> macro for compilers
+which can't cope with complex macro expressions. Always use the macro
+instead.
+
+ char* sv_pvbyten(SV *sv, STRLEN *len)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_pvn
+X<sv_pvn>
+
+A private implementation of the C<SvPV> macro for compilers which can't
+cope with complex macro expressions. Always use the macro instead.
+
+ char* sv_pvn(SV *sv, STRLEN *len)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_pvutf8
+X<sv_pvutf8>
+
+Use the C<SvPVutf8_nolen> macro instead
+
+ char* sv_pvutf8(SV *sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_pvutf8n
+X<sv_pvutf8n>
+
+A private implementation of the C<SvPVutf8> macro for compilers
+which can't cope with complex macro expressions. Always use the macro
+instead.
+
+ char* sv_pvutf8n(SV *sv, STRLEN *len)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_taint
+X<sv_taint>
+
+Taint an SV. Use C<SvTAINTED_on> instead.
+ void sv_taint(SV* sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_unref
+X<sv_unref>
+
+Unsets the RV status of the SV, and decrements the reference count of
+whatever was being referenced by the RV. This can almost be thought of
+as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
+being zero. See C<SvROK_off>.
+
+ void sv_unref(SV* sv)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_usepvn
+X<sv_usepvn>
+
+Tells an SV to use C<ptr> to find its string value. Implemented by
+calling C<sv_usepvn_flags> with C<flags> of 0, hence does not handle 'set'
+magic. See C<sv_usepvn_flags>.
+
+ void sv_usepvn(SV* sv, char* ptr, STRLEN len)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_usepvn_mg
+X<sv_usepvn_mg>
+
+Like C<sv_usepvn>, but also handles 'set' magic.
+
+ void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
+
+=for hackers
+Found in file mathoms.c
+
+=item sv_uv
+X<sv_uv>
+
+A private implementation of the C<SvUVx> macro for compilers which can't
+cope with complex macro expressions. Always use the macro instead.
+
+ UV sv_uv(SV* sv)
+
+=for hackers
+Found in file mathoms.c
=item unpack_str
+X<unpack_str>
The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
and ocnt are not used. This call should not be used, use unpackstring instead.
I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)
=for hackers
+Found in file mathoms.c
+
+
+=back
+
+=head1 Functions in file pp_pack.c
+
+
+=over 8
+
+=item packlist
+X<packlist>
+
+The engine implementing pack() Perl function.
+
+ void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)
+
+=for hackers
+Found in file pp_pack.c
+
+=item unpackstring
+X<unpackstring>
+
+The engine implementing unpack() Perl function. C<unpackstring> puts the
+extracted list items on the stack and returns the number of elements.
+Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
+
+ I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
+
+=for hackers
Found in file pp_pack.c
=over 8
=item PL_modglobal
+X<PL_modglobal>
C<PL_modglobal> is a general purpose, interpreter global HV for use by
extensions that need to keep information on a per-interpreter basis.
Found in file intrpvar.h
=item PL_na
+X<PL_na>
A convenience variable which is typically used with C<SvPV> when one
doesn't care about the length of the string. It is usually more efficient
Found in file thrdvar.h
=item PL_sv_no
+X<PL_sv_no>
This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
C<&PL_sv_no>.
Found in file intrpvar.h
=item PL_sv_undef
+X<PL_sv_undef>
This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
Found in file intrpvar.h
=item PL_sv_yes
+X<PL_sv_yes>
This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
C<&PL_sv_yes>.
=over 8
=item GvSV
+X<GvSV>
Return the SV from the GV.
=for hackers
Found in file gv.h
+=item gv_const_sv
+X<gv_const_sv>
+
+If C<gv> is a typeglob whose subroutine entry is a constant sub eligible for
+inlining, or C<gv> is a placeholder reference that would be promoted to such
+a typeglob, then returns the value returned by the sub. Otherwise, returns
+NULL.
+
+ SV* gv_const_sv(GV* gv)
+
+=for hackers
+Found in file gv.c
+
=item gv_fetchmeth
+X<gv_fetchmeth>
Returns the glob with the given C<name> and a defined subroutine or
C<NULL>. The glob lives in the given C<stash>, or in the stashes
=for hackers
Found in file gv.c
-=item gv_fetchmethod
-
-See L<gv_fetchmethod_autoload>.
-
- GV* gv_fetchmethod(HV* stash, const char* name)
-
-=for hackers
-Found in file gv.c
-
=item gv_fetchmethod_autoload
+X<gv_fetchmethod_autoload>
Returns the glob which contains the subroutine to call to invoke the method
on the C<stash>. In fact in the presence of autoloading this may be the
Found in file gv.c
=item gv_fetchmeth_autoload
+X<gv_fetchmeth_autoload>
Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
Returns a glob for the subroutine.
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
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
Found in file gv.c
=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>.
=over 8
=item Nullav
+X<Nullav>
Null AV pointer.
Found in file av.h
=item Nullch
+X<Nullch>
Null character pointer.
Found in file handy.h
=item Nullcv
+X<Nullcv>
Null CV pointer.
Found in file cv.h
=item Nullhv
+X<Nullhv>
Null HV pointer.
Found in file hv.h
=item Nullsv
+X<Nullsv>
Null SV pointer.
=over 8
=item get_hv
+X<get_hv>
Returns the HV of the specified Perl hash. If C<create> is set and the
Perl variable does not exist then it will be created. If C<create> is not
Found in file perl.c
=item HEf_SVKEY
+X<HEf_SVKEY>
This flag, used in the length slot of hash entries and magic structures,
specifies the structure contains an C<SV*> pointer where a C<char*> pointer
Found in file hv.h
=item HeHASH
+X<HeHASH>
Returns the computed hash stored in the hash entry.
Found in file hv.h
=item HeKEY
+X<HeKEY>
Returns the actual pointer stored in the key slot of the hash entry. The
pointer may be either C<char*> or C<SV*>, depending on the value of
Found in file hv.h
=item HeKLEN
+X<HeKLEN>
If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
Found in file hv.h
=item HePV
+X<HePV>
Returns the key slot of the hash entry as a C<char*> value, doing any
necessary dereferencing of possibly C<SV*> keys. The length of the string
Found in file hv.h
=item HeSVKEY
+X<HeSVKEY>
-Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
+Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
contain an C<SV*> key.
SV* HeSVKEY(HE* he)
Found in file hv.h
=item HeSVKEY_force
+X<HeSVKEY_force>
Returns the key as an C<SV*>. Will create and return a temporary mortal
C<SV*> if the hash entry contains only a C<char*> key.
Found in file hv.h
=item HeSVKEY_set
+X<HeSVKEY_set>
Sets the key to a given C<SV*>, taking care to set the appropriate flags to
indicate the presence of an C<SV*> key, and returns the same
Found in file hv.h
=item HeVAL
+X<HeVAL>
Returns the value slot (type C<SV*>) stored in the hash entry.
Found in file hv.h
=item HvNAME
+X<HvNAME>
-Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
+Returns the package name of a stash, or NULL if C<stash> isn't a stash.
+See C<SvSTASH>, C<CvSTASH>.
char* HvNAME(HV* stash)
Found in file hv.h
=item hv_assert
+X<hv_assert>
Check that a hash is in an internally consistent state.
Found in file hv.c
=item hv_clear
+X<hv_clear>
Clears a hash, making it empty.
Found in file hv.c
=item hv_clear_placeholders
+X<hv_clear_placeholders>
Clears any placeholders from a hash. If a restricted hash has any of its keys
marked as readonly and the key is subsequently deleted, the key is not actually
Found in file hv.c
=item hv_delete
+X<hv_delete>
Deletes a key/value pair in the hash. The value SV is removed from the
hash and returned to the caller. The C<klen> is the length of the key.
Found in file hv.c
=item hv_delete_ent
+X<hv_delete_ent>
Deletes a key/value pair in the hash. The value SV is removed from the
hash and returned to the caller. The C<flags> value will normally be zero;
Found in file hv.c
=item hv_exists
+X<hv_exists>
Returns a boolean indicating whether the specified hash key exists. The
C<klen> is the length of the key.
Found in file hv.c
=item hv_exists_ent
+X<hv_exists_ent>
Returns a boolean indicating whether the specified hash key exists. C<hash>
can be a valid precomputed hash value, or 0 to ask for it to be
Found in file hv.c
=item hv_fetch
+X<hv_fetch>
Returns the SV which corresponds to the specified key in the hash. The
C<klen> is the length of the key. If C<lval> is set then the fetch will be
Found in file hv.c
=item hv_fetch_ent
+X<hv_fetch_ent>
Returns the hash entry which corresponds to the specified key in the hash.
C<hash> must be a valid precomputed hash number for the given C<key>, or 0
Found in file hv.c
=item hv_iterinit
+X<hv_iterinit>
Prepares a starting point to traverse a hash table. Returns the number of
keys in the hash (i.e. the same as C<HvKEYS(tb)>). The return value is
Found in file hv.c
=item hv_iterkey
+X<hv_iterkey>
Returns the key from the current position of the hash iterator. See
C<hv_iterinit>.
Found in file hv.c
=item hv_iterkeysv
+X<hv_iterkeysv>
Returns the key as an C<SV*> from the current position of the hash
iterator. The return value will always be a mortal copy of the key. Also
Found in file hv.c
=item hv_iternext
+X<hv_iternext>
Returns entries from a hash iterator. See C<hv_iterinit>.
Found in file hv.c
=item hv_iternextsv
+X<hv_iternextsv>
Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
operation.
Found in file hv.c
=item hv_iternext_flags
+X<hv_iternext_flags>
Returns entries from a hash iterator. See C<hv_iterinit> and C<hv_iternext>.
The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
Found in file hv.c
=item hv_iterval
+X<hv_iterval>
Returns the value from the current position of the hash iterator. See
C<hv_iterkey>.
Found in file hv.c
=item hv_magic
+X<hv_magic>
Adds magic to a hash. See C<sv_magic>.
Found in file hv.c
=item hv_scalar
+X<hv_scalar>
Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
Found in file hv.c
=item hv_store
+X<hv_store>
Stores an SV in a hash. The hash key is specified as C<key> and C<klen> is
the length of the key. The C<hash> parameter is the precomputed hash
Found in file hv.c
=item hv_store_ent
+X<hv_store_ent>
Stores C<val> in a hash. The hash key is specified as C<key>. The C<hash>
parameter is the precomputed hash value; if it is zero then Perl will
Found in file hv.c
=item hv_undef
+X<hv_undef>
Undefines the hash.
Found in file hv.c
=item newHV
+X<newHV>
Creates a new HV. The reference count is set to 1.
=over 8
=item mg_clear
+X<mg_clear>
Clear something magical that the SV represents. See C<sv_magic>.
Found in file mg.c
=item mg_copy
+X<mg_copy>
Copies the magic from one SV to another. See C<sv_magic>.
Found in file mg.c
=item mg_find
+X<mg_find>
Finds the magic pointer for type matching the SV. See C<sv_magic>.
Found in file mg.c
=item mg_free
+X<mg_free>
Free any magic storage used by the SV. See C<sv_magic>.
Found in file mg.c
=item mg_get
+X<mg_get>
Do magic after a value is retrieved from the SV. See C<sv_magic>.
Found in file mg.c
=item mg_length
+X<mg_length>
Report on the SV's length. See C<sv_magic>.
Found in file mg.c
=item mg_magical
+X<mg_magical>
Turns on the magical status of an SV. See C<sv_magic>.
Found in file mg.c
=item mg_set
+X<mg_set>
Do magic after a value is assigned to the SV. See C<sv_magic>.
Found in file mg.c
=item SvGETMAGIC
+X<SvGETMAGIC>
Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
argument more than once.
Found in file sv.h
=item SvLOCK
+X<SvLOCK>
Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
has been loaded.
Found in file sv.h
=item SvSETMAGIC
+X<SvSETMAGIC>
Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
argument more than once.
Found in file sv.h
=item SvSetMagicSV
+X<SvSetMagicSV>
Like C<SvSetSV>, but does any set magic required afterwards.
Found in file sv.h
=item SvSetMagicSV_nosteal
+X<SvSetMagicSV_nosteal>
Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
Found in file sv.h
=item SvSetSV
+X<SvSetSV>
Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
more than once.
Found in file sv.h
=item SvSetSV_nosteal
+X<SvSetSV_nosteal>
Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
ssv. May evaluate arguments more than once.
Found in file sv.h
=item SvSHARE
+X<SvSHARE>
Arranges for sv to be shared between threads if a suitable module
has been loaded.
Found in file sv.h
=item SvUNLOCK
+X<SvUNLOCK>
Releases a mutual exclusion lock on sv if a suitable module
has been loaded.
=over 8
=item Copy
+X<Copy>
The XSUB-writer's interface to the C C<memcpy> function. The C<src> is the
source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
Found in file handy.h
=item CopyD
+X<CopyD>
Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
optimise.
Found in file handy.h
=item Move
+X<Move>
The XSUB-writer's interface to the C C<memmove> function. The C<src> is the
source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
Found in file handy.h
=item MoveD
+X<MoveD>
Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
optimise.
=for hackers
Found in file handy.h
-=item New
+=item Newx
+X<Newx>
The XSUB-writer's interface to the C C<malloc> function.
- void New(int id, void* ptr, int nitems, type)
+In 5.9.3, Newx() and friends replace the older New() API, and drops
+the first parameter, I<x>, a debug aid which allowed callers to identify
+themselves. This aid has been superseded by a new build option,
+PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>). The older API is still
+there for use in XS modules supporting older perls.
+
+ void Newx(void* ptr, int nitems, type)
=for hackers
Found in file handy.h
-=item Newc
+=item Newxc
+X<Newxc>
The XSUB-writer's interface to the C C<malloc> function, with
-cast.
+cast. See also C<Newx>.
- void Newc(int id, void* ptr, int nitems, type, cast)
+ void Newxc(void* ptr, int nitems, type, cast)
=for hackers
Found in file handy.h
-=item Newz
+=item Newxz
+X<Newxz>
The XSUB-writer's interface to the C C<malloc> function. The allocated
-memory is zeroed with C<memzero>.
+memory is zeroed with C<memzero>. See also C<Newx>.
- void Newz(int id, void* ptr, int nitems, type)
+ void Newxz(void* ptr, int nitems, type)
=for hackers
Found in file handy.h
=item Poison
+X<Poison>
-Fill up memory with a pattern (byte 0xAB over and over again) that
-hopefully catches attempts to access uninitialized memory.
+PoisonWith(0xEF) for catching access to freed memory.
void Poison(void* dest, int nitems, type)
=for hackers
Found in file handy.h
-=item Renew
+=item PoisonNew
+X<PoisonNew>
-The XSUB-writer's interface to the C C<realloc> function.
+PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
- void Renew(void* ptr, int nitems, type)
+ void PoisonNew(void* dest, int nitems, type)
=for hackers
Found in file handy.h
-=item Renewc
+=item PoisonWith
+X<PoisonWith>
-The XSUB-writer's interface to the C C<realloc> function, with
-cast.
+Fill up memory with a byte pattern (a byte repeated over and over
+again) that hopefully catches attempts to access uninitialized memory.
- void Renewc(void* ptr, int nitems, type, cast)
+ void PoisonWith(void* dest, int nitems, type, U8 byte)
=for hackers
Found in file handy.h
-=item Safefree
+=item Renew
+X<Renew>
-The XSUB-writer's interface to the C C<free> function.
+The XSUB-writer's interface to the C C<realloc> function.
+
+ void Renew(void* ptr, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item Renewc
+X<Renewc>
+
+The XSUB-writer's interface to the C C<realloc> function, with
+cast.
+
+ void Renewc(void* ptr, int nitems, type, cast)
+
+=for hackers
+Found in file handy.h
+
+=item Safefree
+X<Safefree>
+
+The XSUB-writer's interface to the C C<free> function.
void Safefree(void* ptr)
Found in file handy.h
=item savepv
+X<savepv>
Perl's version of C<strdup()>. Returns a pointer to a newly allocated
string which is a duplicate of C<pv>. The size of the string is
Found in file util.c
=item savepvn
+X<savepvn>
Perl's version of what C<strndup()> would be if it existed. Returns a
pointer to a newly allocated string which is a duplicate of the first
-C<len> bytes from C<pv>. The memory allocated for the new string can be
-freed with the C<Safefree()> function.
+C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
+the new string can be freed with the C<Safefree()> function.
char* savepvn(const char* pv, I32 len)
Found in file util.c
=item savesharedpv
+X<savesharedpv>
A version of C<savepv()> which allocates the duplicate string in memory
which is shared between threads.
Found in file util.c
=item savesvpv
+X<savesvpv>
A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
the passed in SV using C<SvPV()>
Found in file util.c
=item StructCopy
+X<StructCopy>
This is an architecture-independent macro to copy one structure to another.
Found in file handy.h
=item Zero
+X<Zero>
The XSUB-writer's interface to the C C<memzero> function. The C<dest> is the
destination, C<nitems> is the number of items, and C<type> is the type.
Found in file handy.h
=item ZeroD
+X<ZeroD>
Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
optimise.
=over 8
=item fbm_compile
+X<fbm_compile>
Analyses the string in order to make fast searches on it using fbm_instr()
-- the Boyer-Moore algorithm.
Found in file util.c
=item fbm_instr
+X<fbm_instr>
Returns the location of the SV in the string delimited by C<str> and
-C<strend>. It returns C<Nullch> if the string can't be found. The C<sv>
+C<strend>. It returns C<NULL> if the string can't be found. The C<sv>
does not have to be fbm_compiled, but the search will not be as fast
then.
Found in file util.c
=item form
+X<form>
Takes a sprintf-style format pattern and conventional
(non-SV) arguments and returns the formatted string.
Found in file util.c
=item getcwd_sv
+X<getcwd_sv>
Fill the sv with current working directory
=for hackers
Found in file util.c
+=item my_sprintf
+X<my_sprintf>
+
+The C library C<sprintf>, wrapped if necessary, to ensure that it will return
+the length of the string written to the buffer. Only rare pre-ANSI systems
+need the wrapper function - usually this is a direct call to C<sprintf>.
+
+ int my_sprintf(char *buffer, const char *pat, ...)
+
+=for hackers
+Found in file util.c
+
=item new_version
+X<new_version>
Returns a new version object based on the passed in SV:
Found in file util.c
=item scan_version
+X<scan_version>
Returns a pointer to the next character after the parsed
version string, as well as upgrading the passed in SV to
should be interpreted as if it had multiple decimals, even if
it doesn't.
- char* scan_version(const char *vstr, SV *sv, bool qv)
+ const char* scan_version(const char *vstr, SV *sv, bool qv)
=for hackers
Found in file util.c
=item strEQ
+X<strEQ>
Test two strings to see if they are equal. Returns true or false.
Found in file handy.h
=item strGE
+X<strGE>
Test two strings to see if the first, C<s1>, is greater than or equal to
the second, C<s2>. Returns true or false.
Found in file handy.h
=item strGT
+X<strGT>
Test two strings to see if the first, C<s1>, is greater than the second,
C<s2>. Returns true or false.
Found in file handy.h
=item strLE
+X<strLE>
Test two strings to see if the first, C<s1>, is less than or equal to the
second, C<s2>. Returns true or false.
Found in file handy.h
=item strLT
+X<strLT>
Test two strings to see if the first, C<s1>, is less than the second,
C<s2>. Returns true or false.
Found in file handy.h
=item strNE
+X<strNE>
Test two strings to see if they are different. Returns true or
false.
Found in file handy.h
=item strnEQ
+X<strnEQ>
Test two strings to see if they are equal. The C<len> parameter indicates
the number of bytes to compare. Returns true or false. (A wrapper for
Found in file handy.h
=item strnNE
+X<strnNE>
Test two strings to see if they are different. The C<len> parameter
indicates the number of bytes to compare. Returns true or false. (A
=for hackers
Found in file handy.h
-=item sv_nolocking
-
-Dummy routine which "locks" an SV when there is no locking module present.
-Exists to avoid test for a NULL function pointer and because it could potentially warn under
-some level of strict-ness.
-
- void sv_nolocking(SV *)
-
-=for hackers
-Found in file util.c
-
=item sv_nosharing
+X<sv_nosharing>
Dummy routine which "shares" an SV when there is no sharing module present.
-Exists to avoid test for a NULL function pointer and because it could potentially warn under
-some level of strict-ness.
-
- void sv_nosharing(SV *)
-
-=for hackers
-Found in file util.c
+Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
+Exists to avoid test for a NULL function pointer and because it could
+potentially warn under some level of strict-ness.
-=item sv_nounlocking
-
-Dummy routine which "unlocks" an SV when there is no locking module present.
-Exists to avoid test for a NULL function pointer and because it could potentially warn under
-some level of strict-ness.
-
- void sv_nounlocking(SV *)
+ void sv_nosharing(SV *sv)
=for hackers
Found in file util.c
=item upg_version
+X<upg_version>
In-place upgrade of the supplied SV to a version object.
Found in file util.c
=item vcmp
+X<vcmp>
Version object aware cmp. Both operands must already have been
converted into version objects.
Found in file util.c
=item vnormal
+X<vnormal>
Accepts a version object and returns the normalized string
representation. Call like:
Found in file util.c
=item vnumify
+X<vnumify>
Accepts a version object and returns the normalized floating
point representation. Call like:
Found in file util.c
=item vstringify
+X<vstringify>
In order to maintain maximum compatibility with earlier versions
of Perl, this function will return either the floating point
=for hackers
Found in file util.c
+=item vverify
+X<vverify>
+
+Validates that the SV contains a valid version object.
+
+ bool vverify(SV *vobj);
+
+Note that it only confirms the bare minimum structure (so as not to get
+confused by derived classes which may contain additional hash entries):
+
+ bool vverify(SV *vs)
+
+=for hackers
+Found in file util.c
+
+
+=back
+
+=head1 Multicall Functions
+
+=over 8
+
+=item dMULTICALL
+X<dMULTICALL>
+
+Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
+
+ dMULTICALL;
+
+=for hackers
+Found in file cop.h
+
+=item MULTICALL
+X<MULTICALL>
+
+Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
+
+ MULTICALL;
+
+=for hackers
+Found in file cop.h
+
+=item POP_MULTICALL
+X<POP_MULTICALL>
+
+Closing bracket for a lightweight callback.
+See L<perlcall/Lightweight Callbacks>.
+
+ POP_MULTICALL;
+
+=for hackers
+Found in file cop.h
+
+=item PUSH_MULTICALL
+X<PUSH_MULTICALL>
+
+Opening bracket for a lightweight callback.
+See L<perlcall/Lightweight Callbacks>.
+
+ PUSH_MULTICALL;
+
+=for hackers
+Found in file cop.h
+
=back
=over 8
=item grok_bin
+X<grok_bin>
converts a string representing a binary number to numeric form.
C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
number may use '_' characters to separate digits.
- UV grok_bin(const char* start, STRLEN* len, I32* flags, NV *result)
+ UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
=for hackers
Found in file numeric.c
=item grok_hex
+X<grok_hex>
converts a string representing a hex number to numeric form.
C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
number may use '_' characters to separate digits.
- UV grok_hex(const char* start, STRLEN* len, I32* flags, NV *result)
+ UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
=for hackers
Found in file numeric.c
=item grok_number
+X<grok_number>
Recognise (or not) a number. The type of the number is returned
(0 if unrecognised), otherwise it is a bit-ORed combination of
Found in file numeric.c
=item grok_numeric_radix
+X<grok_numeric_radix>
Scan and skip for a numeric decimal separator (radix).
Found in file numeric.c
=item grok_oct
+X<grok_oct>
converts a string representing an octal number to numeric form.
If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
number may use '_' characters to separate digits.
- UV grok_oct(const char* start, STRLEN* len, I32* flags, NV *result)
+ UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
=for hackers
Found in file numeric.c
=item scan_bin
+X<scan_bin>
For backwards compatibility. Use C<grok_bin> instead.
Found in file numeric.c
=item scan_hex
+X<scan_hex>
For backwards compatibility. Use C<grok_hex> instead.
Found in file numeric.c
=item scan_oct
+X<scan_oct>
For backwards compatibility. Use C<grok_oct> instead.
=over 8
=item cv_const_sv
+X<cv_const_sv>
If C<cv> is a constant sub eligible for inlining. returns the constant
value returned by the sub. Otherwise, returns NULL.
Found in file op.c
=item newCONSTSUB
+X<newCONSTSUB>
Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
eligible for inlining at compile-time.
Found in file op.c
=item newXS
+X<newXS>
-Used by C<xsubpp> to hook up XSUBs as Perl subs.
+Used by C<xsubpp> to hook up XSUBs as Perl subs. I<filename> needs to be
+static storage, as it is used directly as CvFILE(), without a copy being made.
=for hackers
Found in file op.c
=over 8
=item pad_sv
+X<pad_sv>
Get the value at offset po in the current pad.
Use macro PAD_SV instead of calling this function directly.
=over 8
=item dXCPT
+X<dXCPT>
-Set up neccessary local variables for exception handling.
+Set up necessary local variables for exception handling.
See L<perlguts/"Exception Handling">.
dXCPT;
Found in file XSUB.h
=item XCPT_CATCH
+X<XCPT_CATCH>
Introduces a catch block. See L<perlguts/"Exception Handling">.
Found in file XSUB.h
=item XCPT_RETHROW
+X<XCPT_RETHROW>
Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
Found in file XSUB.h
=item XCPT_TRY_END
+X<XCPT_TRY_END>
Ends a try block. See L<perlguts/"Exception Handling">.
Found in file XSUB.h
=item XCPT_TRY_START
+X<XCPT_TRY_START>
Starts a try block. See L<perlguts/"Exception Handling">.
=over 8
=item dMARK
+X<dMARK>
Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
C<dORIGMARK>.
Found in file pp.h
=item dORIGMARK
+X<dORIGMARK>
Saves the original stack mark for the XSUB. See C<ORIGMARK>.
Found in file pp.h
=item dSP
+X<dSP>
Declares a local copy of perl's stack pointer for the XSUB, available via
the C<SP> macro. See C<SP>.
Found in file pp.h
=item EXTEND
+X<EXTEND>
Used to extend the argument stack for an XSUB's return values. Once
used, guarantees that there is room for at least C<nitems> to be pushed
Found in file pp.h
=item MARK
+X<MARK>
Stack marker variable for the XSUB. See C<dMARK>.
Found in file pp.h
=item mPUSHi
+X<mPUSHi>
Push an integer onto the stack. The stack must have room for this element.
Handles 'set' magic. Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi>
Found in file pp.h
=item mPUSHn
+X<mPUSHn>
Push a double onto the stack. The stack must have room for this element.
Handles 'set' magic. Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn>
Found in file pp.h
=item mPUSHp
+X<mPUSHp>
Push a string onto the stack. The stack must have room for this element.
The C<len> indicates the length of the string. Handles 'set' magic. Does
Found in file pp.h
=item mPUSHu
+X<mPUSHu>
Push an unsigned integer onto the stack. The stack must have room for this
element. Handles 'set' magic. Does not use C<TARG>. See also C<PUSHu>,
Found in file pp.h
=item mXPUSHi
+X<mXPUSHi>
Push an integer onto the stack, extending the stack if necessary. Handles
'set' magic. Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and
Found in file pp.h
=item mXPUSHn
+X<mXPUSHn>
Push a double onto the stack, extending the stack if necessary. Handles
'set' magic. Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and
Found in file pp.h
=item mXPUSHp
+X<mXPUSHp>
Push a string onto the stack, extending the stack if necessary. The C<len>
indicates the length of the string. Handles 'set' magic. Does not use
Found in file pp.h
=item mXPUSHu
+X<mXPUSHu>
Push an unsigned integer onto the stack, extending the stack if necessary.
Handles 'set' magic. Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu>
Found in file pp.h
=item ORIGMARK
+X<ORIGMARK>
The original stack mark for the XSUB. See C<dORIGMARK>.
Found in file pp.h
=item POPi
+X<POPi>
Pops an integer off the stack.
Found in file pp.h
=item POPl
+X<POPl>
Pops a long off the stack.
Found in file pp.h
=item POPn
+X<POPn>
Pops a double off the stack.
Found in file pp.h
=item POPp
+X<POPp>
-Pops a string off the stack. Deprecated. New code should provide
-a STRLEN n_a and use POPpx.
+Pops a string off the stack. Deprecated. New code should use POPpx.
char* POPp
Found in file pp.h
=item POPpbytex
+X<POPpbytex>
Pops a string off the stack which must consist of bytes i.e. characters < 256.
-Requires a variable STRLEN n_a in scope.
char* POPpbytex
Found in file pp.h
=item POPpx
+X<POPpx>
Pops a string off the stack.
-Requires a variable STRLEN n_a in scope.
char* POPpx
Found in file pp.h
=item POPs
+X<POPs>
Pops an SV off the stack.
Found in file pp.h
=item PUSHi
+X<PUSHi>
Push an integer onto the stack. The stack must have room for this element.
Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
Found in file pp.h
=item PUSHMARK
+X<PUSHMARK>
Opening bracket for arguments on a callback. See C<PUTBACK> and
L<perlcall>.
Found in file pp.h
=item PUSHmortal
+X<PUSHmortal>
Push a new mortal SV onto the stack. The stack must have room for this
element. Does not handle 'set' magic. Does not use C<TARG>. See also
Found in file pp.h
=item PUSHn
+X<PUSHn>
Push a double onto the stack. The stack must have room for this element.
Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
Found in file pp.h
=item PUSHp
+X<PUSHp>
Push a string onto the stack. The stack must have room for this element.
The C<len> indicates the length of the string. Handles 'set' magic. Uses
Found in file pp.h
=item PUSHs
+X<PUSHs>
Push an SV onto the stack. The stack must have room for this element.
Does not handle 'set' magic. Does not use C<TARG>. See also C<PUSHmortal>,
Found in file pp.h
=item PUSHu
+X<PUSHu>
Push an unsigned integer onto the stack. The stack must have room for this
element. Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
Found in file pp.h
=item PUTBACK
+X<PUTBACK>
Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
See C<PUSHMARK> and L<perlcall> for other uses.
Found in file pp.h
=item SP
+X<SP>
Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
C<SPAGAIN>.
Found in file pp.h
=item SPAGAIN
+X<SPAGAIN>
Refetch the stack pointer. Used after a callback. See L<perlcall>.
Found in file pp.h
=item XPUSHi
+X<XPUSHi>
Push an integer onto the stack, extending the stack if necessary. Handles
'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
Found in file pp.h
=item XPUSHmortal
+X<XPUSHmortal>
Push a new mortal SV onto the stack, extending the stack if necessary. Does
not handle 'set' magic. Does not use C<TARG>. See also C<XPUSHs>,
Found in file pp.h
=item XPUSHn
+X<XPUSHn>
Push a double onto the stack, extending the stack if necessary. Handles
'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
Found in file pp.h
=item XPUSHp
+X<XPUSHp>
Push a string onto the stack, extending the stack if necessary. The C<len>
indicates the length of the string. Handles 'set' magic. Uses C<TARG>, so
Found in file pp.h
=item XPUSHs
+X<XPUSHs>
Push an SV onto the stack, extending the stack if necessary. Does not
handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
Found in file pp.h
=item XPUSHu
+X<XPUSHu>
Push an unsigned integer onto the stack, extending the stack if necessary.
Handles 'set' magic. Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
Found in file pp.h
=item XSRETURN
+X<XSRETURN>
Return from XSUB, indicating number of items on the stack. This is usually
handled by C<xsubpp>.
Found in file XSUB.h
=item XSRETURN_EMPTY
+X<XSRETURN_EMPTY>
Return an empty list from an XSUB immediately.
Found in file XSUB.h
=item XSRETURN_IV
+X<XSRETURN_IV>
Return an integer from an XSUB immediately. Uses C<XST_mIV>.
Found in file XSUB.h
=item XSRETURN_NO
+X<XSRETURN_NO>
Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
Found in file XSUB.h
=item XSRETURN_NV
+X<XSRETURN_NV>
Return a double from an XSUB immediately. Uses C<XST_mNV>.
Found in file XSUB.h
=item XSRETURN_PV
+X<XSRETURN_PV>
Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
Found in file XSUB.h
=item XSRETURN_UNDEF
+X<XSRETURN_UNDEF>
Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
Found in file XSUB.h
=item XSRETURN_UV
+X<XSRETURN_UV>
Return an integer from an XSUB immediately. Uses C<XST_mUV>.
Found in file XSUB.h
=item XSRETURN_YES
+X<XSRETURN_YES>
Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
Found in file XSUB.h
=item XST_mIV
+X<XST_mIV>
Place an integer into the specified position C<pos> on the stack. The
value is stored in a new mortal SV.
Found in file XSUB.h
=item XST_mNO
+X<XST_mNO>
Place C<&PL_sv_no> into the specified position C<pos> on the
stack.
Found in file XSUB.h
=item XST_mNV
+X<XST_mNV>
Place a double into the specified position C<pos> on the stack. The value
is stored in a new mortal SV.
Found in file XSUB.h
=item XST_mPV
+X<XST_mPV>
Place a copy of a string into the specified position C<pos> on the stack.
The value is stored in a new mortal SV.
Found in file XSUB.h
=item XST_mUNDEF
+X<XST_mUNDEF>
Place C<&PL_sv_undef> into the specified position C<pos> on the
stack.
Found in file XSUB.h
=item XST_mYES
+X<XST_mYES>
Place C<&PL_sv_yes> into the specified position C<pos> on the
stack.
=over 8
=item svtype
+X<svtype>
An enum of flags for Perl types. These are found in the file B<sv.h>
in the C<svtype> enum. Test these flags with the C<SvTYPE> macro.
Found in file sv.h
=item SVt_IV
+X<SVt_IV>
Integer type flag for scalars. See C<svtype>.
Found in file sv.h
=item SVt_NV
+X<SVt_NV>
Double type flag for scalars. See C<svtype>.
Found in file sv.h
=item SVt_PV
+X<SVt_PV>
Pointer type flag for scalars. See C<svtype>.
Found in file sv.h
=item SVt_PVAV
+X<SVt_PVAV>
Type flag for arrays. See C<svtype>.
Found in file sv.h
=item SVt_PVCV
+X<SVt_PVCV>
Type flag for code refs. See C<svtype>.
Found in file sv.h
=item SVt_PVHV
+X<SVt_PVHV>
Type flag for hashes. See C<svtype>.
Found in file sv.h
=item SVt_PVMG
+X<SVt_PVMG>
Type flag for blessed scalars. See C<svtype>.
=over 8
=item get_sv
+X<get_sv>
Returns the SV of the specified Perl scalar. If C<create> is set and the
Perl variable does not exist then it will be created. If C<create> is not
=for hackers
Found in file perl.c
-=item looks_like_number
-
-Test if the content of an SV looks like a number (or is a number).
-C<Inf> and C<Infinity> are treated as numbers (so will not issue a
-non-numeric warning), even if your atof() doesn't grok them.
-
- I32 looks_like_number(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item newRV_inc
+X<newRV_inc>
Creates an RV wrapper for an SV. The reference count for the original SV is
incremented.
=for hackers
Found in file sv.h
-=item newRV_noinc
-
-Creates an RV wrapper for an SV. The reference count for the original
-SV is B<not> incremented.
-
- SV* newRV_noinc(SV *sv)
-
-=for hackers
-Found in file sv.c
-
-=item NEWSV
-
-Creates a new SV. A non-zero C<len> parameter indicates the number of
-bytes of preallocated string space the SV should have. An extra byte for a
-tailing NUL is also reserved. (SvPOK is not set for the SV even if string
-space is allocated.) The reference count for the new SV is set to 1.
-C<id> is an integer id between 0 and 1299 (used to identify leaks).
-
- SV* NEWSV(int id, STRLEN len)
-
-=for hackers
-Found in file handy.h
-
-=item newSV
-
-Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
-with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
-macro.
-
- SV* newSV(STRLEN len)
-
-=for hackers
-Found in file sv.c
-
-=item newSViv
-
-Creates a new SV and copies an integer into it. The reference count for the
-SV is set to 1.
-
- SV* newSViv(IV i)
-
-=for hackers
-Found in file sv.c
-
-=item newSVnv
-
-Creates a new SV and copies a floating point value into it.
-The reference count for the SV is set to 1.
-
- SV* newSVnv(NV n)
-
-=for hackers
-Found in file sv.c
-
-=item newSVpv
-
-Creates a new SV and copies a string into it. The reference count for the
-SV is set to 1. If C<len> is zero, Perl will compute the length using
-strlen(). For efficiency, consider using C<newSVpvn> instead.
-
- SV* newSVpv(const char* s, STRLEN len)
-
-=for hackers
-Found in file sv.c
-
-=item newSVpvf
-
-Creates a new SV and initializes it with the string formatted like
-C<sprintf>.
-
- SV* newSVpvf(const char* pat, ...)
-
-=for hackers
-Found in file sv.c
-
-=item newSVpvn
-
-Creates a new SV and copies a string into it. The reference count for the
-SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
-string. You are responsible for ensuring that the source string is at least
-C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
-
- SV* newSVpvn(const char* s, STRLEN len)
-
-=for hackers
-Found in file sv.c
-
-=item newSVpvn_share
-
-Creates a new SV with its SvPVX pointing to a shared string in the string
-table. If the string does not already exist in the table, it is created
-first. Turns on READONLY and FAKE. The string's hash is stored in the UV
-slot of the SV; if the C<hash> parameter is non-zero, that value is used;
-otherwise the hash is computed. The idea here is that as the string table
-is used for shared hash keys these strings will have SvPVX == HeKEY and
-hash lookup will avoid string compare.
-
- SV* newSVpvn_share(const char* s, I32 len, U32 hash)
-
-=for hackers
-Found in file sv.c
-
-=item newSVrv
-
-Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
-it will be upgraded to one. If C<classname> is non-null then the new SV will
-be blessed in the specified package. The new SV is returned and its
-reference count is 1.
-
- SV* newSVrv(SV* rv, const char* classname)
-
-=for hackers
-Found in file sv.c
-
-=item newSVsv
-
-Creates a new SV which is an exact duplicate of the original SV.
-(Uses C<sv_setsv>).
-
- SV* newSVsv(SV* old)
-
-=for hackers
-Found in file sv.c
-
-=item newSVuv
-
-Creates a new SV and copies an unsigned integer into it.
-The reference count for the SV is set to 1.
-
- SV* newSVuv(UV u)
-
-=for hackers
-Found in file sv.c
-
=item SvCUR
+X<SvCUR>
Returns the length of the string which is in the SV. See C<SvLEN>.
Found in file sv.h
=item SvCUR_set
+X<SvCUR_set>
-Set the current length of the string which is in the SV. See C<SvCUR>.
+Set the current length of the string which is in the SV. See C<SvCUR>
+and C<SvIV_set>.
void SvCUR_set(SV* sv, STRLEN len)
Found in file sv.h
=item SvEND
+X<SvEND>
Returns a pointer to the last character in the string which is in the SV.
See C<SvCUR>. Access the character as *(SvEND(sv)).
=for hackers
Found in file sv.h
+=item SvGAMAGIC
+X<SvGAMAGIC>
+
+Returns true if the SV has get magic or overloading. If either is true then
+the scalar is active data, and has the potential to return a new value every
+time it is accessed. Hence you must be careful to only read it once per user
+logical operation and work with that returned value. If neither is true then
+the scalar's value cannot change unless written to.
+
+ char* SvGAMAGIC(SV* sv)
+
+=for hackers
+Found in file sv.h
+
=item SvGROW
+X<SvGROW>
Expands the character buffer in the SV so that it has room for the
indicated number of bytes (remember to reserve space for an extra trailing
Found in file sv.h
=item SvIOK
+X<SvIOK>
Returns a boolean indicating whether the SV contains an integer.
Found in file sv.h
=item SvIOKp
+X<SvIOKp>
Returns a boolean indicating whether the SV contains an integer. Checks
the B<private> setting. Use C<SvIOK>.
Found in file sv.h
=item SvIOK_notUV
+X<SvIOK_notUV>
Returns a boolean indicating whether the SV contains a signed integer.
Found in file sv.h
=item SvIOK_off
+X<SvIOK_off>
Unsets the IV status of an SV.
Found in file sv.h
=item SvIOK_on
+X<SvIOK_on>
Tells an SV that it is an integer.
Found in file sv.h
=item SvIOK_only
+X<SvIOK_only>
Tells an SV that it is an integer and disables all other OK bits.
Found in file sv.h
=item SvIOK_only_UV
+X<SvIOK_only_UV>
Tells and SV that it is an unsigned integer and disables all other OK bits.
Found in file sv.h
=item SvIOK_UV
+X<SvIOK_UV>
Returns a boolean indicating whether the SV contains an unsigned integer.
Found in file sv.h
=item SvIsCOW
+X<SvIsCOW>
Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
Found in file sv.h
=item SvIsCOW_shared_hash
+X<SvIsCOW_shared_hash>
Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
scalar.
Found in file sv.h
=item SvIV
+X<SvIV>
Coerces the given SV to an integer and returns it. See C<SvIVx> for a
version which guarantees to evaluate sv only once.
Found in file sv.h
=item SvIVX
+X<SvIVX>
Returns the raw value in the SV's IV slot, without checks or conversions.
Only use when you are sure SvIOK is true. See also C<SvIV()>.
Found in file sv.h
=item SvIVx
+X<SvIVx>
Coerces the given SV to an integer and returns it. Guarantees to evaluate
sv only once. Use the more efficient C<SvIV> otherwise.
Found in file sv.h
=item SvIV_nomg
+X<SvIV_nomg>
Like C<SvIV> but doesn't process magic.
Found in file sv.h
=item SvIV_set
+X<SvIV_set>
-Set the value of the IV pointer in sv to val.
+Set the value of the IV pointer in sv to val. It is possible to perform
+the same function of this macro with an lvalue assignment to C<SvIVX>.
+With future Perls, however, it will be more efficient to use
+C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
void SvIV_set(SV* sv, IV val)
Found in file sv.h
=item SvLEN
+X<SvLEN>
Returns the size of the string buffer in the SV, not including any part
attributable to C<SvOOK>. See C<SvCUR>.
Found in file sv.h
=item SvLEN_set
+X<SvLEN_set>
-Set the actual length of the string which is in the SV.
+Set the actual length of the string which is in the SV. See C<SvIV_set>.
void SvLEN_set(SV* sv, STRLEN len)
Found in file sv.h
=item SvMAGIC_set
+X<SvMAGIC_set>
-Set the value of the MAGIC pointer in sv to val.
+Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
void SvMAGIC_set(SV* sv, MAGIC* val)
Found in file sv.h
=item SvNIOK
+X<SvNIOK>
Returns a boolean indicating whether the SV contains a number, integer or
double.
Found in file sv.h
=item SvNIOKp
+X<SvNIOKp>
Returns a boolean indicating whether the SV contains a number, integer or
double. Checks the B<private> setting. Use C<SvNIOK>.
Found in file sv.h
=item SvNIOK_off
+X<SvNIOK_off>
Unsets the NV/IV status of an SV.
Found in file sv.h
=item SvNOK
+X<SvNOK>
Returns a boolean indicating whether the SV contains a double.
Found in file sv.h
=item SvNOKp
+X<SvNOKp>
Returns a boolean indicating whether the SV contains a double. Checks the
B<private> setting. Use C<SvNOK>.
Found in file sv.h
=item SvNOK_off
+X<SvNOK_off>
Unsets the NV status of an SV.
Found in file sv.h
=item SvNOK_on
+X<SvNOK_on>
Tells an SV that it is a double.
Found in file sv.h
=item SvNOK_only
+X<SvNOK_only>
Tells an SV that it is a double and disables all other OK bits.
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
which guarantees to evaluate sv only once.
Found in file sv.h
=item SvNVX
+X<SvNVX>
Returns the raw value in the SV's NV slot, without checks or conversions.
Only use when you are sure SvNOK is true. See also C<SvNV()>.
Found in file sv.h
=item SvNVx
+X<SvNVx>
Coerces the given SV to a double and returns it. Guarantees to evaluate
sv only once. Use the more efficient C<SvNV> otherwise.
Found in file sv.h
=item SvNV_set
+X<SvNV_set>
-Set the value of the IV pointer in sv to val.
+Set the value of the NV pointer in sv to val. See C<SvIV_set>.
void SvNV_set(SV* sv, NV val)
Found in file sv.h
=item SvOK
+X<SvOK>
Returns a boolean indicating whether the value is an SV. It also tells
whether the value is defined or not.
Found in file sv.h
=item SvOOK
+X<SvOOK>
Returns a boolean indicating whether the SvIVX is a valid offset value for
the SvPVX. This hack is used internally to speed up removal of characters
Found in file sv.h
=item SvPOK
+X<SvPOK>
Returns a boolean indicating whether the SV contains a character
string.
Found in file sv.h
=item SvPOKp
+X<SvPOKp>
Returns a boolean indicating whether the SV contains a character string.
Checks the B<private> setting. Use C<SvPOK>.
Found in file sv.h
=item SvPOK_off
+X<SvPOK_off>
Unsets the PV status of an SV.
Found in file sv.h
=item SvPOK_on
+X<SvPOK_on>
Tells an SV that it is a string.
Found in file sv.h
=item SvPOK_only
+X<SvPOK_only>
Tells an SV that it is a string and disables all other OK bits.
Will also turn off the UTF-8 status.
Found in file sv.h
=item SvPOK_only_UTF8
+X<SvPOK_only_UTF8>
Tells an SV that it is a string and disables all other OK bits,
and leaves the UTF-8 status as it was.
Found in file sv.h
=item SvPV
+X<SvPV>
Returns a pointer to the string in the SV, or a stringified form of
the SV if the SV does not contain a string. The SV may cache the
Found in file sv.h
=item SvPVbyte
+X<SvPVbyte>
Like C<SvPV>, but converts sv to byte representation first if necessary.
Found in file sv.h
=item SvPVbytex
+X<SvPVbytex>
Like C<SvPV>, but converts sv to byte representation first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
Found in file sv.h
=item SvPVbytex_force
+X<SvPVbytex_force>
Like C<SvPV_force>, but converts sv to byte representation first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
Found in file sv.h
=item SvPVbyte_force
+X<SvPVbyte_force>
Like C<SvPV_force>, but converts sv to byte representation first if necessary.
Found in file sv.h
=item SvPVbyte_nolen
+X<SvPVbyte_nolen>
Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
Found in file sv.h
=item SvPVutf8
+X<SvPVutf8>
Like C<SvPV>, but converts sv to utf8 first if necessary.
Found in file sv.h
=item SvPVutf8x
+X<SvPVutf8x>
Like C<SvPV>, but converts sv to utf8 first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
Found in file sv.h
=item SvPVutf8x_force
+X<SvPVutf8x_force>
Like C<SvPV_force>, but converts sv to utf8 first if necessary.
Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
Found in file sv.h
=item SvPVutf8_force
+X<SvPVutf8_force>
Like C<SvPV_force>, but converts sv to utf8 first if necessary.
Found in file sv.h
=item SvPVutf8_nolen
+X<SvPVutf8_nolen>
Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
Found in file sv.h
=item SvPVX
+X<SvPVX>
Returns a pointer to the physical string in the SV. The SV must contain a
string.
Found in file sv.h
=item SvPVx
+X<SvPVx>
A version of C<SvPV> which guarantees to evaluate sv only once.
Found in file sv.h
=item SvPV_force
+X<SvPV_force>
Like C<SvPV> but will force the SV into containing just a string
(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
Found in file sv.h
=item SvPV_force_nomg
+X<SvPV_force_nomg>
Like C<SvPV> but will force the SV into containing just a string
(C<SvPOK_only>). You want force if you are going to update the C<SvPVX>
Found in file sv.h
=item SvPV_nolen
+X<SvPV_nolen>
Returns a pointer to the string in the SV, or a stringified form of
the SV if the SV does not contain a string. The SV may cache the
Found in file sv.h
=item SvPV_nomg
+X<SvPV_nomg>
Like C<SvPV> but doesn't process magic.
Found in file sv.h
=item SvPV_set
+X<SvPV_set>
-Set the value of the PV pointer in sv to val.
+Set the value of the PV pointer in sv to val. See C<SvIV_set>.
void SvPV_set(SV* sv, char* val)
Found in file sv.h
=item SvREFCNT
+X<SvREFCNT>
Returns the value of the object's reference count.
Found in file sv.h
=item SvREFCNT_dec
+X<SvREFCNT_dec>
Decrements the reference count of the given SV.
Found in file sv.h
=item SvREFCNT_inc
+X<SvREFCNT_inc>
Increments the reference count of the given SV.
=for hackers
Found in file sv.h
+=item SvREFCNT_inc_NN
+X<SvREFCNT_inc_NN>
+
+Same as SvREFCNT_inc, but can only be used if you know I<sv>
+is not NULL. Since we don't have to check the NULLness, it's faster
+and smaller.
+
+ SV* SvREFCNT_inc_NN(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvREFCNT_inc_simple
+X<SvREFCNT_inc_simple>
+
+Same as SvREFCNT_inc, but can only be used with simple variables, not
+expressions or pointer dereferences. Since we don't have to store a
+temporary value, it's faster.
+
+ SV* SvREFCNT_inc_simple(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvREFCNT_inc_simple_NN
+X<SvREFCNT_inc_simple_NN>
+
+Same as SvREFCNT_inc_simple, but can only be used if you know I<sv>
+is not NULL. Since we don't have to check the NULLness, it's faster
+and smaller.
+
+ SV* SvREFCNT_inc_simple_NN(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvREFCNT_inc_simple_void
+X<SvREFCNT_inc_simple_void>
+
+Same as SvREFCNT_inc_simple, but can only be used if you don't need the
+return value. The macro doesn't need to return a meaningful value.
+
+ SV* SvREFCNT_inc_simple_void(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvREFCNT_inc_void
+X<SvREFCNT_inc_void>
+
+Same as SvREFCNT_inc, but can only be used if you don't need the
+return value. The macro doesn't need to return a meaningful value.
+
+ SV* SvREFCNT_inc_void(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvREFCNT_inc_void_NN
+X<SvREFCNT_inc_void_NN>
+
+Same as SvREFCNT_inc, but can only be used if you don't need the return
+value, and you know that I<sv> is not NULL. The macro doesn't need
+to return a meaningful value, or check for NULLness, so it's smaller
+and faster.
+
+ SV* SvREFCNT_inc_void_NN(SV* sv)
+
+=for hackers
+Found in file sv.h
+
=item SvROK
+X<SvROK>
Tests if the SV is an RV.
Found in file sv.h
=item SvROK_off
+X<SvROK_off>
Unsets the RV status of an SV.
Found in file sv.h
=item SvROK_on
+X<SvROK_on>
Tells an SV that it is an RV.
Found in file sv.h
=item SvRV
+X<SvRV>
Dereferences an RV to return the SV.
Found in file sv.h
=item SvRV_set
+X<SvRV_set>
-Set the value of the RV pointer in sv to val.
+Set the value of the RV pointer in sv to val. See C<SvIV_set>.
void SvRV_set(SV* sv, SV* val)
Found in file sv.h
=item SvSTASH
+X<SvSTASH>
Returns the stash of the SV.
Found in file sv.h
=item SvSTASH_set
+X<SvSTASH_set>
-Set the value of the STASH pointer in sv to val.
+Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
void SvSTASH_set(SV* sv, STASH* val)
Found in file sv.h
=item SvTAINT
+X<SvTAINT>
Taints an SV if tainting is enabled.
Found in file sv.h
=item SvTAINTED
+X<SvTAINTED>
Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
not.
Found in file sv.h
=item SvTAINTED_off
+X<SvTAINTED_off>
Untaints an SV. Be I<very> careful with this routine, as it short-circuits
some of Perl's fundamental security features. XS module authors should not
Found in file sv.h
=item SvTAINTED_on
+X<SvTAINTED_on>
Marks an SV as tainted if tainting is enabled.
Found in file sv.h
=item SvTRUE
+X<SvTRUE>
Returns a boolean indicating whether Perl would evaluate the SV as true or
false, defined or undefined. Does not handle 'get' magic.
Found in file sv.h
=item SvTYPE
+X<SvTYPE>
Returns the type of the SV. See C<svtype>.
Found in file sv.h
=item SvUOK
+X<SvUOK>
Returns a boolean indicating whether the SV contains an unsigned integer.
Found in file sv.h
=item SvUPGRADE
+X<SvUPGRADE>
Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
perform the upgrade if necessary. See C<svtype>.
Found in file sv.h
=item SvUTF8
+X<SvUTF8>
Returns a boolean indicating whether the SV contains UTF-8 encoded data.
Found in file sv.h
=item SvUTF8_off
+X<SvUTF8_off>
Unsets the UTF-8 status of an SV.
Found in file sv.h
=item SvUTF8_on
+X<SvUTF8_on>
Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
Do not use frivolously.
Found in file sv.h
=item SvUV
+X<SvUV>
Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
for a version which guarantees to evaluate sv only once.
Found in file sv.h
=item SvUVX
+X<SvUVX>
Returns the raw value in the SV's UV slot, without checks or conversions.
Only use when you are sure SvIOK is true. See also C<SvUV()>.
Found in file sv.h
=item SvUVx
+X<SvUVx>
Coerces the given SV to an unsigned integer and returns it. Guarantees to
evaluate sv only once. Use the more efficient C<SvUV> otherwise.
Found in file sv.h
=item SvUV_nomg
+X<SvUV_nomg>
Like C<SvUV> but doesn't process magic.
Found in file sv.h
=item SvUV_set
+X<SvUV_set>
-Set the value of the PV pointer in sv to val.
+Set the value of the UV pointer in sv to val. See C<SvIV_set>.
void SvUV_set(SV* sv, UV val)
=for hackers
-Found in file sv.h
+Found in file sv.h
+
+=item SvVOK
+X<SvVOK>
+
+Returns a boolean indicating whether the SV contains a v-string.
+
+ bool SvVOK(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item sv_catpvn_nomg
+X<sv_catpvn_nomg>
+
+Like C<sv_catpvn> but doesn't process magic.
+
+ void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
+
+=for hackers
+Found in file sv.h
+
+=item sv_catsv_nomg
+X<sv_catsv_nomg>
+
+Like C<sv_catsv> but doesn't process magic.
+
+ void sv_catsv_nomg(SV* dsv, SV* ssv)
+
+=for hackers
+Found in file sv.h
+
+=item sv_derived_from
+X<sv_derived_from>
+
+Returns a boolean indicating whether the SV is derived from the specified
+class. This is the function that implements C<UNIVERSAL::isa>. It works
+for class names as well as for objects.
+
+ bool sv_derived_from(SV* sv, const char* name)
+
+=for hackers
+Found in file universal.c
+
+=item sv_report_used
+X<sv_report_used>
+
+Dump the contents of all SVs not yet freed. (Debugging aid).
+
+ void sv_report_used()
+
+=for hackers
+Found in file sv.c
+
+=item sv_setsv_nomg
+X<sv_setsv_nomg>
+
+Like C<sv_setsv> but doesn't process magic.
+
+ void sv_setsv_nomg(SV* dsv, SV* ssv)
+
+=for hackers
+Found in file sv.h
+
+
+=back
+
+=head1 SV-Body Allocation
+
+=over 8
+
+=item looks_like_number
+X<looks_like_number>
+
+Test if the content of an SV looks like a number (or is a number).
+C<Inf> and C<Infinity> are treated as numbers (so will not issue a
+non-numeric warning), even if your atof() doesn't grok them.
+
+ I32 looks_like_number(SV* sv)
+
+=for hackers
+Found in file sv.c
+
+=item newRV_noinc
+X<newRV_noinc>
+
+Creates an RV wrapper for an SV. The reference count for the original
+SV is B<not> incremented.
+
+ SV* newRV_noinc(SV* sv)
+
+=for hackers
+Found in file sv.c
+
+=item newSV
+X<newSV>
+
+Creates a new SV. A non-zero C<len> parameter indicates the number of
+bytes of preallocated string space the SV should have. An extra byte for a
+trailing NUL is also reserved. (SvPOK is not set for the SV even if string
+space is allocated.) The reference count for the new SV is set to 1.
+
+In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
+parameter, I<x>, a debug aid which allowed callers to identify themselves.
+This aid has been superseded by a new build option, PERL_MEM_LOG (see
+L<perlhack/PERL_MEM_LOG>). The older API is still there for use in XS
+modules supporting older perls.
+
+ SV* newSV(STRLEN len)
+
+=for hackers
+Found in file sv.c
+
+=item newSVhek
+X<newSVhek>
+
+Creates a new SV from the hash key structure. It will generate scalars that
+point to the shared string table where possible. Returns a new (undefined)
+SV if the hek is NULL.
+
+ SV* newSVhek(const HEK *hek)
+
+=for hackers
+Found in file sv.c
+
+=item newSViv
+X<newSViv>
+
+Creates a new SV and copies an integer into it. The reference count for the
+SV is set to 1.
+
+ SV* newSViv(IV i)
+
+=for hackers
+Found in file sv.c
+
+=item newSVnv
+X<newSVnv>
+
+Creates a new SV and copies a floating point value into it.
+The reference count for the SV is set to 1.
+
+ SV* newSVnv(NV n)
+
+=for hackers
+Found in file sv.c
+
+=item newSVpv
+X<newSVpv>
+
+Creates a new SV and copies a string into it. The reference count for the
+SV is set to 1. If C<len> is zero, Perl will compute the length using
+strlen(). For efficiency, consider using C<newSVpvn> instead.
+
+ SV* newSVpv(const char* s, STRLEN len)
+
+=for hackers
+Found in file sv.c
+
+=item newSVpvf
+X<newSVpvf>
+
+Creates a new SV and initializes it with the string formatted like
+C<sprintf>.
+
+ SV* newSVpvf(const char* pat, ...)
+
+=for hackers
+Found in file sv.c
+
+=item newSVpvn
+X<newSVpvn>
+
+Creates a new SV and copies a string into it. The reference count for the
+SV is set to 1. Note that if C<len> is zero, Perl will create a zero length
+string. You are responsible for ensuring that the source string is at least
+C<len> bytes long. If the C<s> argument is NULL the new SV will be undefined.
+
+ SV* newSVpvn(const char* s, STRLEN len)
+
+=for hackers
+Found in file sv.c
+
+=item newSVpvn_share
+X<newSVpvn_share>
+
+Creates a new SV with its SvPVX_const pointing to a shared string in the string
+table. If the string does not already exist in the table, it is created
+first. Turns on READONLY and FAKE. The string's hash is stored in the UV
+slot of the SV; if the C<hash> parameter is non-zero, that value is used;
+otherwise the hash is computed. The idea here is that as the string table
+is used for shared hash keys these strings will have SvPVX_const == HeKEY and
+hash lookup will avoid string compare.
+
+ SV* newSVpvn_share(const char* s, I32 len, U32 hash)
+
+=for hackers
+Found in file sv.c
+
+=item newSVrv
+X<newSVrv>
+
+Creates a new SV for the RV, C<rv>, to point to. If C<rv> is not an RV then
+it will be upgraded to one. If C<classname> is non-null then the new SV will
+be blessed in the specified package. The new SV is returned and its
+reference count is 1.
+
+ SV* newSVrv(SV* rv, const char* classname)
+
+=for hackers
+Found in file sv.c
+
+=item newSVsv
+X<newSVsv>
+
+Creates a new SV which is an exact duplicate of the original SV.
+(Uses C<sv_setsv>).
+
+ SV* newSVsv(SV* old)
+
+=for hackers
+Found in file sv.c
-=item SvVOK
+=item newSVuv
+X<newSVuv>
-Returns a boolean indicating whether the SV contains a v-string.
+Creates a new SV and copies an unsigned integer into it.
+The reference count for the SV is set to 1.
- bool SvVOK(SV* sv)
+ SV* newSVuv(UV u)
=for hackers
-Found in file sv.h
+Found in file sv.c
=item sv_2bool
+X<sv_2bool>
This function is only called on magical items, and is only used by
sv_true() or its macro equivalent.
Found in file sv.c
=item sv_2cv
+X<sv_2cv>
Using various gambits, try to get a CV from an SV; in addition, try if
possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
+The flags in C<lref> are passed to sv_fetchsv.
CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
Found in file sv.c
=item sv_2io
+X<sv_2io>
Using various gambits, try to get an IO from an SV: the IO slot if its a
GV; or the recursive result if we're an RV; or the IO slot of the symbol
Found in file sv.c
=item sv_2iv_flags
+X<sv_2iv_flags>
Return the integer value of an SV, doing any necessary string
conversion. If flags includes SV_GMAGIC, does an mg_get() first.
Found in file sv.c
=item sv_2mortal
+X<sv_2mortal>
Marks an existing SV as mortal. The SV will be destroyed "soon", either
by an explicit call to FREETMPS, or by an implicit call at places such as
Found in file sv.c
=item sv_2nv
+X<sv_2nv>
Return the num value of an SV, doing any necessary string or integer
conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
Found in file sv.c
=item sv_2pvbyte
+X<sv_2pvbyte>
Return a pointer to the byte-encoded representation of the SV, and set *lp
to its length. May cause the SV to be downgraded from UTF-8 as a
=for hackers
Found in file sv.c
-=item sv_2pvbyte_nolen
-
-Return a pointer to the byte-encoded representation of the SV.
-May cause the SV to be downgraded from UTF-8 as a side-effect.
-
-Usually accessed via the C<SvPVbyte_nolen> macro.
-
- char* sv_2pvbyte_nolen(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_2pvutf8
+X<sv_2pvutf8>
Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
=for hackers
Found in file sv.c
-=item sv_2pvutf8_nolen
-
-Return a pointer to the UTF-8-encoded representation of the SV.
-May cause the SV to be upgraded to UTF-8 as a side-effect.
-
-Usually accessed via the C<SvPVutf8_nolen> macro.
-
- char* sv_2pvutf8_nolen(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_2pv_flags
+X<sv_2pv_flags>
Returns a pointer to the string value of an SV, and sets *lp to its length.
If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
=for hackers
Found in file sv.c
-=item sv_2pv_nolen
-
-Like C<sv_2pv()>, but doesn't return the length too. You should usually
-use the macro wrapper C<SvPV_nolen(sv)> instead.
- char* sv_2pv_nolen(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_2uv_flags
+X<sv_2uv_flags>
Return the unsigned integer value of an SV, doing any necessary string
conversion. If flags includes SV_GMAGIC, does an mg_get() first.
Found in file sv.c
=item sv_backoff
+X<sv_backoff>
Remove any string offset. You should normally use the C<SvOOK_off> macro
wrapper instead.
Found in file sv.c
=item sv_bless
+X<sv_bless>
Blesses an SV into a specified package. The SV must be an RV. The package
must be designated by its stash (see C<gv_stashpv()>). The reference count
Found in file sv.c
=item sv_catpv
+X<sv_catpv>
Concatenates the string onto the end of the string which is in the SV.
If the SV has the UTF-8 status set, then the bytes appended should be
Found in file sv.c
=item sv_catpvf
+X<sv_catpvf>
Processes its arguments like C<sprintf> and appends the formatted
output to an SV. If the appended data contains "wide" characters
Found in file sv.c
=item sv_catpvf_mg
+X<sv_catpvf_mg>
Like C<sv_catpvf>, but also handles 'set' magic.
Found in file sv.c
=item sv_catpvn
+X<sv_catpvn>
Concatenates the string onto the end of the string which is in the SV. The
C<len> indicates number of bytes to copy. If the SV has the UTF-8
Found in file sv.c
=item sv_catpvn_flags
+X<sv_catpvn_flags>
Concatenates the string onto the end of the string which is in the SV. The
C<len> indicates number of bytes to copy. If the SV has the UTF-8
=for hackers
Found in file sv.c
-=item sv_catpvn_mg
-
-Like C<sv_catpvn>, but also handles 'set' magic.
-
- void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
-
-=for hackers
-Found in file sv.c
-
-=item sv_catpvn_nomg
-
-Like C<sv_catpvn> but doesn't process magic.
-
- void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
-
-=for hackers
-Found in file sv.h
-
=item sv_catpv_mg
+X<sv_catpv_mg>
Like C<sv_catpv>, but also handles 'set' magic.
Found in file sv.c
=item sv_catsv
+X<sv_catsv>
Concatenates the string from SV C<ssv> onto the end of the string in
SV C<dsv>. Modifies C<dsv> but not C<ssv>. Handles 'get' magic, but
Found in file sv.c
=item sv_catsv_flags
+X<sv_catsv_flags>
Concatenates the string from SV C<ssv> onto the end of the string in
SV C<dsv>. Modifies C<dsv> but not C<ssv>. If C<flags> has C<SV_GMAGIC>
=for hackers
Found in file sv.c
-=item sv_catsv_mg
-
-Like C<sv_catsv>, but also handles 'set' magic.
-
- void sv_catsv_mg(SV *dstr, SV *sstr)
-
-=for hackers
-Found in file sv.c
-
-=item sv_catsv_nomg
-
-Like C<sv_catsv> but doesn't process magic.
-
- void sv_catsv_nomg(SV* dsv, SV* ssv)
-
-=for hackers
-Found in file sv.h
-
=item sv_chop
+X<sv_chop>
Efficient removal of characters from the beginning of the string buffer.
SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
the string buffer. The C<ptr> becomes the first character of the adjusted
string. Uses the "OOK hack".
-Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
+Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
refer to the same chunk of data.
- void sv_chop(SV* sv, char* ptr)
+ void sv_chop(SV* sv, const char* ptr)
=for hackers
Found in file sv.c
=item sv_clear
+X<sv_clear>
Clear an SV: call any destructors, free up any memory used by the body,
and free the body itself. The SV's head is I<not> freed, although
Found in file sv.c
=item sv_cmp
+X<sv_cmp>
Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
string in C<sv1> is less than, equal to, or greater than the string in
Found in file sv.c
=item sv_cmp_locale
+X<sv_cmp_locale>
Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
'use bytes' aware, handles get magic, and will coerce its args to strings
Found in file sv.c
=item sv_collxfrm
+X<sv_collxfrm>
Add Collate Transform magic to an SV if it doesn't already have it.
Found in file sv.c
=item sv_copypv
+X<sv_copypv>
Copies a stringified representation of the source SV into the
destination SV. Automatically performs any necessary mg_get and
Found in file sv.c
=item sv_dec
+X<sv_dec>
Auto-decrement of the value in the SV, doing string to numeric conversion
if necessary. Handles 'get' magic.
=for hackers
Found in file sv.c
-=item sv_derived_from
-
-Returns a boolean indicating whether the SV is derived from the specified
-class. This is the function that implements C<UNIVERSAL::isa>. It works
-for class names as well as for objects.
-
- bool sv_derived_from(SV* sv, const char* name)
-
-=for hackers
-Found in file universal.c
-
=item sv_eq
+X<sv_eq>
Returns a boolean indicating whether the strings in the two SVs are
identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
=for hackers
Found in file sv.c
-=item sv_force_normal
-
-Undo various types of fakery on an SV: if the PV is a shared string, make
-a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
-an xpvmg. See also C<sv_force_normal_flags>.
-
- void sv_force_normal(SV *sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_force_normal_flags
+X<sv_force_normal_flags>
Undo various types of fakery on an SV: if the PV is a shared string, make
a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
Found in file sv.c
=item sv_free
+X<sv_free>
Decrement an SV's reference count, and if it drops to zero, call
C<sv_clear> to invoke destructors and free up any memory used by
Found in file sv.c
=item sv_gets
+X<sv_gets>
Get a line from the filehandle and store it into the SV, optionally
appending to the currently-stored string.
Found in file sv.c
=item sv_grow
+X<sv_grow>
Expands the character buffer in the SV. If necessary, uses C<sv_unref> and
upgrades the SV to C<SVt_PV>. Returns a pointer to the character buffer.
Found in file sv.c
=item sv_inc
+X<sv_inc>
Auto-increment of the value in the SV, doing string to numeric conversion
if necessary. Handles 'get' magic.
Found in file sv.c
=item sv_insert
+X<sv_insert>
Inserts a string at the specified offset/length within the SV. Similar to
the Perl substr() function.
Found in file sv.c
=item sv_isa
+X<sv_isa>
Returns a boolean indicating whether the SV is blessed into the specified
class. This does not check for subtypes; use C<sv_derived_from> to verify
Found in file sv.c
=item sv_isobject
+X<sv_isobject>
Returns a boolean indicating whether the SV is an RV pointing to a blessed
object. If the SV is not an RV, or if the object is not blessed, then this
=for hackers
Found in file sv.c
-=item sv_iv
-
-A private implementation of the C<SvIVx> macro for compilers which can't
-cope with complex macro expressions. Always use the macro instead.
-
- IV sv_iv(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_len
+X<sv_len>
Returns the length of the string in the SV. Handles magic and type
coercion. See also C<SvCUR>, which gives raw access to the xpv_cur slot.
Found in file sv.c
=item sv_len_utf8
+X<sv_len_utf8>
Returns the number of characters in the string in an SV, counting wide
UTF-8 bytes as a single character. Handles magic and type coercion.
Found in file sv.c
=item sv_magic
+X<sv_magic>
Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
then adds a new magic item of type C<how> to the head of the magic list.
Found in file sv.c
=item sv_magicext
+X<sv_magicext>
Adds magic to an SV, upgrading it if necessary. Applies the
supplied vtable and returns a pointer to the magic added.
(This is now used as a subroutine by C<sv_magic>.)
- MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)
+ MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen)
=for hackers
Found in file sv.c
=item sv_mortalcopy
+X<sv_mortalcopy>
Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
The new SV is marked as mortal. It will be destroyed "soon", either by an
Found in file sv.c
=item sv_newmortal
+X<sv_newmortal>
Creates a new null SV which is mortal. The reference count of the SV is
set to 1. It will be destroyed "soon", either by an explicit call to
Found in file sv.c
=item sv_newref
+X<sv_newref>
Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
instead.
=for hackers
Found in file sv.c
-=item sv_nv
-
-A private implementation of the C<SvNVx> macro for compilers which can't
-cope with complex macro expressions. Always use the macro instead.
-
- NV sv_nv(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_pos_b2u
+X<sv_pos_b2u>
Converts the value pointed to by offsetp from a count of bytes from the
start of the string, to a count of the equivalent number of UTF-8 chars.
Found in file sv.c
=item sv_pos_u2b
+X<sv_pos_u2b>
Converts the value pointed to by offsetp from a count of UTF-8 chars from
the start of the string, to a count of the equivalent number of bytes; if
=for hackers
Found in file sv.c
-=item sv_pv
-
-Use the C<SvPV_nolen> macro instead
-
- char* sv_pv(SV *sv)
-
-=for hackers
-Found in file sv.c
-
-=item sv_pvbyte
-
-Use C<SvPVbyte_nolen> instead.
-
- char* sv_pvbyte(SV *sv)
-
-=for hackers
-Found in file sv.c
-
-=item sv_pvbyten
-
-A private implementation of the C<SvPVbyte> macro for compilers
-which can't cope with complex macro expressions. Always use the macro
-instead.
-
- char* sv_pvbyten(SV *sv, STRLEN *len)
-
-=for hackers
-Found in file sv.c
-
=item sv_pvbyten_force
+X<sv_pvbyten_force>
-A private implementation of the C<SvPVbytex_force> macro for compilers
-which can't cope with complex macro expressions. Always use the macro
-instead.
+The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
char* sv_pvbyten_force(SV* sv, STRLEN* lp)
=for hackers
Found in file sv.c
-=item sv_pvn
-
-A private implementation of the C<SvPV> macro for compilers which can't
-cope with complex macro expressions. Always use the macro instead.
-
- char* sv_pvn(SV *sv, STRLEN *len)
-
-=for hackers
-Found in file sv.c
-
=item sv_pvn_force
+X<sv_pvn_force>
Get a sensible string out of the SV somehow.
A private implementation of the C<SvPV_force> macro for compilers which
Found in file sv.c
=item sv_pvn_force_flags
+X<sv_pvn_force_flags>
Get a sensible string out of the SV somehow.
If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
=for hackers
Found in file sv.c
-=item sv_pvutf8
-
-Use the C<SvPVutf8_nolen> macro instead
-
- char* sv_pvutf8(SV *sv)
-
-=for hackers
-Found in file sv.c
-
-=item sv_pvutf8n
-
-A private implementation of the C<SvPVutf8> macro for compilers
-which can't cope with complex macro expressions. Always use the macro
-instead.
-
- char* sv_pvutf8n(SV *sv, STRLEN *len)
-
-=for hackers
-Found in file sv.c
-
=item sv_pvutf8n_force
+X<sv_pvutf8n_force>
-A private implementation of the C<SvPVutf8_force> macro for compilers
-which can't cope with complex macro expressions. Always use the macro
-instead.
+The backend for the C<SvPVutf8x_force> macro. Always use the macro instead.
char* sv_pvutf8n_force(SV* sv, STRLEN* lp)
Found in file sv.c
=item sv_reftype
+X<sv_reftype>
Returns a string describing what the SV is a reference to.
Found in file sv.c
=item sv_replace
+X<sv_replace>
Make the first argument a copy of the second, then delete the original.
The target SV physically takes over ownership of the body of the source SV
=for hackers
Found in file sv.c
-=item sv_report_used
-
-Dump the contents of all SVs not yet freed. (Debugging aid).
-
- void sv_report_used()
-
-=for hackers
-Found in file sv.c
-
=item sv_reset
+X<sv_reset>
Underlying implementation for the C<reset> Perl function.
Note that the perl-level function is vaguely deprecated.
Found in file sv.c
=item sv_rvweaken
+X<sv_rvweaken>
Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
Found in file sv.c
=item sv_setiv
+X<sv_setiv>
Copies an integer into the given SV, upgrading first if necessary.
Does not handle 'set' magic. See also C<sv_setiv_mg>.
Found in file sv.c
=item sv_setiv_mg
+X<sv_setiv_mg>
Like C<sv_setiv>, but also handles 'set' magic.
Found in file sv.c
=item sv_setnv
+X<sv_setnv>
Copies a double into the given SV, upgrading first if necessary.
Does not handle 'set' magic. See also C<sv_setnv_mg>.
Found in file sv.c
=item sv_setnv_mg
+X<sv_setnv_mg>
Like C<sv_setnv>, but also handles 'set' magic.
Found in file sv.c
=item sv_setpv
+X<sv_setpv>
Copies a string into an SV. The string must be null-terminated. Does not
handle 'set' magic. See C<sv_setpv_mg>.
Found in file sv.c
=item sv_setpvf
+X<sv_setpvf>
Works like C<sv_catpvf> but copies the text into the SV instead of
appending it. Does not handle 'set' magic. See C<sv_setpvf_mg>.
Found in file sv.c
=item sv_setpvf_mg
+X<sv_setpvf_mg>
Like C<sv_setpvf>, but also handles 'set' magic.
Found in file sv.c
=item sv_setpviv
+X<sv_setpviv>
Copies an integer into the given SV, also updating its string value.
Does not handle 'set' magic. See C<sv_setpviv_mg>.
Found in file sv.c
=item sv_setpviv_mg
+X<sv_setpviv_mg>
Like C<sv_setpviv>, but also handles 'set' magic.
Found in file sv.c
=item sv_setpvn
+X<sv_setpvn>
Copies a string into an SV. The C<len> parameter indicates the number of
bytes to be copied. If the C<ptr> argument is NULL the SV will become
Found in file sv.c
=item sv_setpvn_mg
+X<sv_setpvn_mg>
Like C<sv_setpvn>, but also handles 'set' magic.
Found in file sv.c
=item sv_setpv_mg
+X<sv_setpv_mg>
Like C<sv_setpv>, but also handles 'set' magic.
Found in file sv.c
=item sv_setref_iv
+X<sv_setref_iv>
Copies an integer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
-blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
+blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
SV* sv_setref_iv(SV* rv, const char* classname, IV iv)
Found in file sv.c
=item sv_setref_nv
+X<sv_setref_nv>
Copies a double into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
-blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
+blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
SV* sv_setref_nv(SV* rv, const char* classname, NV nv)
Found in file sv.c
=item sv_setref_pv
+X<sv_setref_pv>
Copies a pointer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
into the SV. The C<classname> argument indicates the package for the
-blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
+blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
Do not use with other Perl types such as HV, AV, SV, CV, because those
Found in file sv.c
=item sv_setref_pvn
+X<sv_setref_pvn>
Copies a string into a new SV, optionally blessing the SV. The length of the
string must be specified with C<n>. The C<rv> argument will be upgraded to
an RV. That RV will be modified to point to the new SV. The C<classname>
argument indicates the package for the blessing. Set C<classname> to
-C<Nullch> to avoid the blessing. The new SV will have a reference count
+C<NULL> to avoid the blessing. The new SV will have a reference count
of 1, and the RV will be returned.
Note that C<sv_setref_pv> copies the pointer while this copies the string.
- SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
+ SV* sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)
=for hackers
Found in file sv.c
=item sv_setref_uv
+X<sv_setref_uv>
Copies an unsigned integer into a new SV, optionally blessing the SV. The C<rv>
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The C<classname> argument indicates the package for the
-blessing. Set C<classname> to C<Nullch> to avoid the blessing. The new SV
+blessing. Set C<classname> to C<NULL> to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
SV* sv_setref_uv(SV* rv, const char* classname, UV uv)
Found in file sv.c
=item sv_setsv
+X<sv_setsv>
Copies the contents of the source SV C<ssv> into the destination SV
C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
Found in file sv.c
=item sv_setsv_flags
+X<sv_setsv_flags>
Copies the contents of the source SV C<ssv> into the destination SV
C<dsv>. The source SV may be destroyed if it is mortal, so don't use this
Found in file sv.c
=item sv_setsv_mg
+X<sv_setsv_mg>
Like C<sv_setsv>, but also handles 'set' magic.
=for hackers
Found in file sv.c
-=item sv_setsv_nomg
-
-Like C<sv_setsv> but doesn't process magic.
-
- void sv_setsv_nomg(SV* dsv, SV* ssv)
-
-=for hackers
-Found in file sv.h
-
=item sv_setuv
+X<sv_setuv>
Copies an unsigned integer into the given SV, upgrading first if necessary.
Does not handle 'set' magic. See also C<sv_setuv_mg>.
Found in file sv.c
=item sv_setuv_mg
+X<sv_setuv_mg>
Like C<sv_setuv>, but also handles 'set' magic.
=for hackers
Found in file sv.c
-=item sv_taint
-
-Taint an SV. Use C<SvTAINTED_on> instead.
- void sv_taint(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_tainted
+X<sv_tainted>
Test an SV for taintedness. Use C<SvTAINTED> instead.
bool sv_tainted(SV* sv)
Found in file sv.c
=item sv_true
+X<sv_true>
Returns true if the SV has a true value by Perl's rules.
Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
Found in file sv.c
=item sv_unmagic
+X<sv_unmagic>
Removes all magic of type C<type> from an SV.
=for hackers
Found in file sv.c
-=item sv_unref
-
-Unsets the RV status of the SV, and decrements the reference count of
-whatever was being referenced by the RV. This can almost be thought of
-as a reversal of C<newSVrv>. This is C<sv_unref_flags> with the C<flag>
-being zero. See C<SvROK_off>.
-
- void sv_unref(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_unref_flags
+X<sv_unref_flags>
Unsets the RV status of the SV, and decrements the reference count of
whatever was being referenced by the RV. This can almost be thought of
Found in file sv.c
=item sv_untaint
+X<sv_untaint>
Untaint an SV. Use C<SvTAINTED_off> instead.
void sv_untaint(SV* sv)
Found in file sv.c
=item sv_upgrade
+X<sv_upgrade>
Upgrade an SV to a more complex form. Generally adds a new body type to the
SV, then copies across as much information as possible from the old body.
You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
- bool sv_upgrade(SV* sv, U32 mt)
+ void sv_upgrade(SV* sv, U32 mt)
=for hackers
Found in file sv.c
-=item sv_usepvn
-
-Tells an SV to use C<ptr> to find its string value. Normally the string is
-stored inside the SV but sv_usepvn allows the SV to use an outside string.
-The C<ptr> should point to memory that was allocated by C<malloc>. The
-string length, C<len>, must be supplied. This function will realloc the
-memory pointed to by C<ptr>, so that pointer should not be freed or used by
-the programmer after giving it to sv_usepvn. Does not handle 'set' magic.
-See C<sv_usepvn_mg>.
-
- void sv_usepvn(SV* sv, char* ptr, STRLEN len)
+=item sv_usepvn_flags
+X<sv_usepvn_flags>
-=for hackers
-Found in file sv.c
-
-=item sv_usepvn_mg
+Tells an SV to use C<ptr> to find its string value. Normally the
+string is stored inside the SV but sv_usepvn allows the SV to use an
+outside string. The C<ptr> should point to memory that was allocated
+by C<malloc>. The string length, C<len>, must be supplied. By default
+this function will realloc (i.e. move) the memory pointed to by C<ptr>,
+so that pointer should not be freed or used by the programmer after
+giving it to sv_usepvn, and neither should any pointers from "behind"
+that pointer (e.g. ptr + 1) be used.
-Like C<sv_usepvn>, but also handles 'set' magic.
+If C<flags> & SV_SMAGIC is true, will call SvSETMAGIC. If C<flags> &
+SV_HAS_TRAILING_NUL is true, then C<ptr[len]> must be NUL, and the realloc
+will be skipped. (i.e. the buffer is actually at least 1 byte longer than
+C<len>, and already meets the requirements for storing in C<SvPVX>)
- void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
+ void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)
=for hackers
Found in file sv.c
=item sv_utf8_decode
+X<sv_utf8_decode>
If the PV of the SV is an octet sequence in UTF-8
and contains a multiple-byte character, the C<SvUTF8> flag is turned on
Found in file sv.c
=item sv_utf8_downgrade
+X<sv_utf8_downgrade>
Attempts to convert the PV of an SV from characters to bytes.
If the PV contains a character beyond byte, this conversion will fail;
Found in file sv.c
=item sv_utf8_encode
+X<sv_utf8_encode>
Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
flag off so that it looks like octets again.
Found in file sv.c
=item sv_utf8_upgrade
+X<sv_utf8_upgrade>
Converts the PV of an SV to its UTF-8-encoded form.
Forces the SV to string form if it is not already.
Found in file sv.c
=item sv_utf8_upgrade_flags
+X<sv_utf8_upgrade_flags>
Converts the PV of an SV to its UTF-8-encoded form.
Forces the SV to string form if it is not already.
=for hackers
Found in file sv.c
-=item sv_uv
-
-A private implementation of the C<SvUVx> macro for compilers which can't
-cope with complex macro expressions. Always use the macro instead.
-
- UV sv_uv(SV* sv)
-
-=for hackers
-Found in file sv.c
-
=item sv_vcatpvf
+X<sv_vcatpvf>
Processes its arguments like C<vsprintf> and appends the formatted output
to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
Found in file sv.c
=item sv_vcatpvfn
+X<sv_vcatpvfn>
Processes its arguments like C<vsprintf> and appends the formatted output
to an SV. Uses an array of SVs if the C style variable argument list is
Found in file sv.c
=item sv_vcatpvf_mg
+X<sv_vcatpvf_mg>
Like C<sv_vcatpvf>, but also handles 'set' magic.
Found in file sv.c
=item sv_vsetpvf
+X<sv_vsetpvf>
Works like C<sv_vcatpvf> but copies the text into the SV instead of
appending it. Does not handle 'set' magic. See C<sv_vsetpvf_mg>.
Found in file sv.c
=item sv_vsetpvfn
+X<sv_vsetpvfn>
Works like C<sv_vcatpvfn> but copies the text into the SV instead of
appending it.
Found in file sv.c
=item sv_vsetpvf_mg
+X<sv_vsetpvf_mg>
Like C<sv_vsetpvf>, but also handles 'set' magic.
=over 8
=item bytes_from_utf8
+X<bytes_from_utf8>
Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
Found in file utf8.c
=item bytes_to_utf8
+X<bytes_to_utf8>
Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
Returns a pointer to the newly-created string, and sets C<len> to
Found in file utf8.c
=item ibcmp_utf8
+X<ibcmp_utf8>
Return true if the strings s1 and s2 differ case-insensitively, false
if not (if they are equal case-insensitively). If u1 is true, the
Found in file utf8.c
=item is_utf8_char
+X<is_utf8_char>
Tests if some arbitrary number of bytes begins in a valid UTF-8
character. Note that an INVARIANT (i.e. ASCII) character is a valid
Found in file utf8.c
=item is_utf8_string
+X<is_utf8_string>
Returns true if first C<len> bytes of the given string form a valid
UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
not mean 'a string that contains code points above 0x7F encoded in UTF-8'
because a valid ASCII string is a valid UTF-8 string.
+See also is_utf8_string_loclen() and is_utf8_string_loc().
+
bool is_utf8_string(const U8 *s, STRLEN len)
=for hackers
Found in file utf8.c
=item is_utf8_string_loc
+X<is_utf8_string_loc>
+
+Like is_utf8_string() but stores the location of the failure (in the
+case of "utf8ness failure") or the location s+len (in the case of
+"utf8ness success") in the C<ep>.
-Like is_ut8_string but store the location of the failure in
-the last argument.
+See also is_utf8_string_loclen() and is_utf8_string().
bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)
=for hackers
Found in file utf8.c
+=item is_utf8_string_loclen
+X<is_utf8_string_loclen>
+
+Like is_utf8_string() but stores the location of the failure (in the
+case of "utf8ness failure") or the location s+len (in the case of
+"utf8ness success") in the C<ep>, and the number of UTF-8
+encoded characters in the C<el>.
+
+See also is_utf8_string_loc() and is_utf8_string().
+
+ bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)
+
+=for hackers
+Found in file utf8.c
+
=item pv_uni_display
+X<pv_uni_display>
Build to the scalar dsv a displayable version of the string spv,
length len, the displayable version being at most pvlim bytes long
Found in file utf8.c
=item sv_cat_decode
+X<sv_cat_decode>
The encoding is assumed to be an Encode object, the PV of the ssv is
assumed to be octets in that encoding and decoding the input starts
Found in file sv.c
=item sv_recode_to_utf8
+X<sv_recode_to_utf8>
The encoding is assumed to be an Encode object, on entry the PV
of the sv is assumed to be octets in that encoding, and the sv
Found in file sv.c
=item sv_uni_display
+X<sv_uni_display>
Build to the scalar dsv a displayable version of the scalar sv,
the displayable version being at most pvlim bytes long
Found in file utf8.c
=item to_utf8_case
+X<to_utf8_case>
The "p" contains the pointer to the UTF-8 string encoding
the character that is being converted.
The "swashp" is a pointer to the swash to use.
Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
-and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
+and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
but not always, a multicharacter mapping), is tried first.
The "special" is a string like "utf8::ToSpecLower", which means the
The "normal" is a string like "ToLower" which means the swash
%utf8::ToLower.
- UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, const char *normal, const char *special)
+ UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)
=for hackers
Found in file utf8.c
=item to_utf8_fold
+X<to_utf8_fold>
Convert the UTF-8 encoded character at p to its foldcase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
Found in file utf8.c
=item to_utf8_lower
+X<to_utf8_lower>
Convert the UTF-8 encoded character at p to its lowercase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
Found in file utf8.c
=item to_utf8_title
+X<to_utf8_title>
Convert the UTF-8 encoded character at p to its titlecase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
Found in file utf8.c
=item to_utf8_upper
+X<to_utf8_upper>
Convert the UTF-8 encoded character at p to its uppercase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
Found in file utf8.c
=item utf8n_to_uvchr
+X<utf8n_to_uvchr>
-Returns the native character value of the first character in the string C<s>
+flags
+
+Returns the native character value of the first character in the string
+C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
length, in bytes, of that character.
Allows length and flags to be passed to low level routine.
- UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
+ UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
=for hackers
Found in file utf8.c
=item utf8n_to_uvuni
+X<utf8n_to_uvuni>
Bottom level UTF-8 decode routine.
Returns the unicode code point value of the first character in the string C<s>
Most code should use utf8_to_uvchr() rather than call this directly.
- UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
+ UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)
=for hackers
Found in file utf8.c
=item utf8_distance
+X<utf8_distance>
Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
and C<b>.
Found in file utf8.c
=item utf8_hop
+X<utf8_hop>
Return the UTF-8 pointer C<s> displaced by C<off> characters, either
forward or backward.
Found in file utf8.c
=item utf8_length
+X<utf8_length>
Return the length of the UTF-8 char encoded string C<s> in characters.
Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
Found in file utf8.c
=item utf8_to_bytes
+X<utf8_to_bytes>
Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
Unlike C<bytes_to_utf8>, this over-writes the original string, and
updates len to contain the new length.
Returns zero on failure, setting C<len> to -1.
+If you need a copy of the string, see C<bytes_from_utf8>.
+
NOTE: this function is experimental and may change or be
removed without notice.
Found in file utf8.c
=item utf8_to_uvchr
+X<utf8_to_uvchr>
Returns the native character value of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
If C<s> does not point to a well-formed UTF-8 character, zero is
returned and retlen is set, if possible, to -1.
- UV utf8_to_uvchr(const U8 *s, STRLEN* retlen)
+ UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)
=for hackers
Found in file utf8.c
=item utf8_to_uvuni
+X<utf8_to_uvuni>
Returns the Unicode code point of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
If C<s> does not point to a well-formed UTF-8 character, zero is
returned and retlen is set, if possible, to -1.
- UV utf8_to_uvuni(const U8 *s, STRLEN* retlen)
+ UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
=for hackers
Found in file utf8.c
=item uvchr_to_utf8
+X<uvchr_to_utf8>
Adds the UTF-8 representation of the Native codepoint C<uv> to the end
of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
Found in file utf8.c
=item uvuni_to_utf8_flags
+X<uvuni_to_utf8_flags>
Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
=over 8
=item ax
+X<ax>
Variable which is setup by C<xsubpp> to indicate the stack base offset,
used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
Found in file XSUB.h
=item CLASS
+X<CLASS>
Variable which is setup by C<xsubpp> to indicate the
class name for a C++ XS constructor. This is always a C<char*>. See C<THIS>.
Found in file XSUB.h
=item dAX
+X<dAX>
Sets up the C<ax> variable.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
Found in file XSUB.h
=item dAXMARK
+X<dAXMARK>
Sets up the C<ax> variable and stack marker variable C<mark>.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
Found in file XSUB.h
=item dITEMS
+X<dITEMS>
Sets up the C<items> variable.
This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
Found in file XSUB.h
=item dUNDERBAR
+X<dUNDERBAR>
Sets up the C<padoff_du> variable for an XSUB that wishes to use
C<UNDERBAR>.
Found in file XSUB.h
=item dXSARGS
+X<dXSARGS>
Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
Found in file XSUB.h
=item dXSI32
+X<dXSI32>
Sets up the C<ix> variable for an XSUB which has aliases. This is usually
handled automatically by C<xsubpp>.
Found in file XSUB.h
=item items
+X<items>
Variable which is setup by C<xsubpp> to indicate the number of
items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
Found in file XSUB.h
=item ix
+X<ix>
Variable which is setup by C<xsubpp> to indicate which of an
XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
Found in file XSUB.h
=item newXSproto
+X<newXSproto>
Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
the subs.
Found in file XSUB.h
=item RETVAL
+X<RETVAL>
Variable which is setup by C<xsubpp> to hold the return value for an
XSUB. This is always the proper type for the XSUB. See
Found in file XSUB.h
=item ST
+X<ST>
Used to access elements on the XSUB's stack.
Found in file XSUB.h
=item THIS
+X<THIS>
Variable which is setup by C<xsubpp> to designate the object in a C++
XSUB. This is always the proper type for the C++ object. See C<CLASS> and
Found in file XSUB.h
=item UNDERBAR
+X<UNDERBAR>
The SV* corresponding to the $_ variable. Works even if there
is a lexical $_ in scope.
Found in file XSUB.h
=item XS
+X<XS>
Macro to declare an XSUB and its C parameter list. This is handled by
C<xsubpp>.
Found in file XSUB.h
=item XS_VERSION
+X<XS_VERSION>
The version identifier for an XS module. This is usually
handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
Found in file XSUB.h
=item XS_VERSION_BOOTCHECK
+X<XS_VERSION_BOOTCHECK>
Macro to verify that a PM module's $VERSION variable matches the XS
module's C<XS_VERSION> variable. This is usually handled automatically by
=over 8
=item croak
+X<croak>
This is the XSUB-writer's interface to Perl's C<die> function.
Normally call this function the same way you call the C C<printf>
sidestepping the normal C order of execution. See C<warn>.
If you want to throw an exception object, assign the object to
-C<$@> and then pass C<Nullch> to croak():
+C<$@> and then pass C<NULL> to croak():
errsv = get_sv("@", TRUE);
sv_setsv(errsv, exception_object);
- croak(Nullch);
+ croak(NULL);
void croak(const char* pat, ...)
Found in file util.c
=item warn
+X<warn>
This is the XSUB-writer's interface to Perl's C<warn> function. Call this
function the same way you call the C C<printf> function. See C<croak>.
https://perl5.git.perl.org / perl5.git / blobdiff