+-*- buffer-read-only: t -*-
+
+!!!!!!! DO NOT EDIT THIS FILE !!!!!!!
+This file is built by autodoc.pl extracting documentation from the C source
+files.
+
=head1 NAME
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.
- void av_clear(AV* ar)
+ void av_clear(AV *av)
+
+=for hackers
+Found in file av.c
+
+=item av_create_and_push
+X<av_create_and_push>
+
+Push an SV onto the end of the array, creating the array if necessary.
+A small internal helper function to remove a commonly duplicated idiom.
+
+NOTE: this function is experimental and may change or be
+removed without notice.
+
+ void av_create_and_push(AV **const avp, SV *const val)
+
+=for hackers
+Found in file av.c
+
+=item av_create_and_unshift_one
+X<av_create_and_unshift_one>
+
+Unshifts an SV onto the beginning of the array, creating the array if
+necessary.
+A small internal helper function to remove a commonly duplicated idiom.
+
+NOTE: this function is experimental and may change or be
+removed without notice.
+
+ SV** av_create_and_unshift_one(AV **const avp, SV *const val)
=for hackers
Found in file av.c
=item av_delete
+X<av_delete>
Deletes the element indexed by C<key> from the array. Returns the
-deleted element. C<flags> is currently ignored.
+deleted element. If C<flags> equals C<G_DISCARD>, the element is freed
+and null is returned.
- SV* av_delete(AV* ar, I32 key, I32 flags)
+ SV* av_delete(AV *av, I32 key, I32 flags)
=for hackers
Found in file av.c
=item av_exists
+X<av_exists>
Returns true if the element indexed by C<key> has been initialized.
This relies on the fact that uninitialized array elements are set to
C<&PL_sv_undef>.
- bool av_exists(AV* ar, I32 key)
+ bool av_exists(AV *av, I32 key)
=for hackers
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.
- void av_extend(AV* ar, I32 key)
+ void av_extend(AV *av, I32 key)
=for hackers
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
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
more information on how to use this function on tied arrays.
- SV** av_fetch(AV* ar, I32 key, I32 lval)
+ SV** av_fetch(AV *av, I32 key, I32 lval)
=for hackers
Found in file av.c
=item av_fill
+X<av_fill>
-Ensure than an array has a given number of elements, equivalent to
+Set the highest index in the array to the given number, equivalent to
Perl's C<$#array = $fill;>.
- void av_fill(AV* ar, I32 fill)
+The number of elements in the an array will be C<fill + 1> after
+av_fill() returns. If the array was previously shorter then the
+additional elements appended are set to C<PL_sv_undef>. If the array
+was longer, then the excess elements are freed. C<av_fill(av, -1)> is
+the same as C<av_clear(av)>.
+
+ void av_fill(AV *av, I32 fill)
=for hackers
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.
+Returns the highest index in the array. The number of elements in the
+array is C<av_len(av) + 1>. Returns -1 if the array is empty.
- I32 av_len(AV* ar)
+ I32 av_len(const AV *av)
=for hackers
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
will have a reference count of 1.
- AV* av_make(I32 size, SV** svp)
+ AV* av_make(I32 size, SV **strp)
=for hackers
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.
- SV* av_pop(AV* ar)
+ SV* av_pop(AV *av)
=for hackers
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.
- void av_push(AV* ar, SV* val)
+ void av_push(AV *av, SV *val)
=for hackers
Found in file av.c
=item av_shift
+X<av_shift>
Shifts an SV off the beginning of the array.
- SV* av_shift(AV* ar)
+ SV* av_shift(AV *av)
=for hackers
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
See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
more information on how to use this function on tied arrays.
- SV** av_store(AV* ar, I32 key, SV* val)
+ SV** av_store(AV *av, I32 key, SV *val)
=for hackers
Found in file av.c
=item av_undef
+X<av_undef>
Undefines the array. Frees the memory used by the array itself.
- void av_undef(AV* ar)
+ void av_undef(AV *av)
=for hackers
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
must then use C<av_store> to assign values to these new elements.
- void av_unshift(AV* ar, I32 num)
+ void av_unshift(AV *av, I32 num)
=for hackers
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.
AV* newAV()
=for hackers
-Found in file av.c
-
-=item Nullav
-
-Null AV pointer.
-
-
-=for hackers
Found in file av.h
=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)
+
+=for hackers
+Found in file pp_sort.c
+
+=item sortsv_flags
+X<sortsv_flags>
- void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)
+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>.
NOTE: the perl_ form of this function is deprecated.
- I32 call_sv(SV* sv, I32 flags)
+ I32 call_sv(SV* sv, VOL I32 flags)
=for hackers
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.
-perl_clone takes these flags as paramters:
+perl_clone takes these flags as parameters:
-CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
-without it we only clone the data and zero the stacks,
-with it we copy the stacks and the new perl interpreter is
-ready to run at the exact same point as the previous one.
-The pseudo-fork code uses COPY_STACKS while the
-threads->new doesn't.
+CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
+without it we only clone the data and zero the stacks,
+with it we copy the stacks and the new perl interpreter is
+ready to run at the exact same point as the previous one.
+The pseudo-fork code uses COPY_STACKS while the
+threads->create doesn't.
CLONEf_KEEP_PTR_TABLE
-perl_clone keeps a ptr_table with the pointer of the old
-variable as a key and the new variable as a value,
-this allows it to check if something has been cloned and not
-clone it again but rather just use the value and increase the
-refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
-the ptr_table using the function
-C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
-reason to keep it around is if you want to dup some of your own
-variable who are outside the graph perl scans, example of this
+perl_clone keeps a ptr_table with the pointer of the old
+variable as a key and the new variable as a value,
+this allows it to check if something has been cloned and not
+clone it again but rather just use the value and increase the
+refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
+the ptr_table using the function
+C<ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;>,
+reason to keep it around is if you want to dup some of your own
+variable who are outside the graph perl scans, example of this
code is in threads.xs create
CLONEf_CLONE_HOST
-This is a win32 thing, it is ignored on unix, it tells perls
-win32host code (which is c++) to clone itself, this is needed on
-win32 if you want to run two threads at the same time,
-if you just want to do some stuff in a separate perl interpreter
-and then throw it away and return to the original one,
+This is a win32 thing, it is ignored on unix, it tells perls
+win32host code (which is c++) to clone itself, this is needed on
+win32 if you want to run two threads at the same time,
+if you just want to do some stuff in a separate perl interpreter
+and then throw it away and return to the original one,
you don't need to do anything.
- PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)
+ PerlInterpreter* perl_clone(PerlInterpreter *proto_perl, UV flags)
=for hackers
Found in file sv.c
=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
-same effect as saying C<sub name;>). If C<create> is not set and the
-subroutine does not exist then NULL is returned.
+Uses C<strlen> to get the length of C<name>, then calls C<get_cvn_flags>.
NOTE: the perl_ form of this function is deprecated.
- CV* get_cv(const char* name, I32 create)
+ CV* get_cv(const char* name, I32 flags)
=for hackers
Found in file perl.c
-=item Nullcv
+=item get_cvn_flags
+X<get_cvn_flags>
-Null CV pointer.
+Returns the CV of the specified Perl subroutine. C<flags> are passed to
+C<gv_fetchpvn_flags>. If C<GV_ADD> is set and the Perl subroutine does not
+exist then it will be declared (which has the same effect as saying
+C<sub name;>). If C<GV_ADD> is not set and the subroutine does not exist
+then NULL is returned.
+
+NOTE: the perl_ form of this function is deprecated.
+ CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)
=for hackers
-Found in file cv.h
+Found in file perl.c
=back
=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>.
- void perl_construct(PerlInterpreter* interp)
+ void perl_construct(PerlInterpreter *my_perl)
=for hackers
Found in file perl.c
=item perl_destruct
+X<perl_destruct>
Shuts down a Perl interpreter. See L<perlembed>.
- int perl_destruct(PerlInterpreter* interp)
+ int perl_destruct(PerlInterpreter *my_perl)
=for hackers
Found in file perl.c
=item perl_free
+X<perl_free>
Releases a Perl interpreter. See L<perlembed>.
- void perl_free(PerlInterpreter* interp)
+ void perl_free(PerlInterpreter *my_perl)
=for hackers
Found in file perl.c
=item perl_parse
+X<perl_parse>
Tells a Perl interpreter to parse a Perl script. See L<perlembed>.
- int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
+ int perl_parse(PerlInterpreter *my_perl, XSINIT_t xsinit, int argc, char** argv, char** env)
=for hackers
Found in file perl.c
=item perl_run
+X<perl_run>
Tells a Perl interpreter to run. See L<perlembed>.
- int perl_run(PerlInterpreter* interp)
+ int perl_run(PerlInterpreter *my_perl)
=for hackers
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
-implemented that way; consider using Perl_load_module instead.
+implemented that way; consider using load_module instead.
NOTE: the perl_ form of this function is deprecated.
=back
-=head1 Functions in file pp_pack.c
+=head1 Functions in file dump.c
=over 8
-=item pack_cat
+=item pv_display
+X<pv_display>
-The engine implementing pack() Perl function.
+ char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
+ STRLEN pvlim, U32 flags)
- void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)
+Similar to
-=for hackers
-Found in file pp_pack.c
+ pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
-=item unpack_str
+except that an additional "\0" will be appended to the string when
+len > cur and pv[cur] is "\0".
-The engine implementing unpack() Perl function.
+Note that the final string may be up to 7 chars longer than pvlim.
- I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)
+ char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
=for hackers
-Found in file pp_pack.c
+Found in file dump.c
+=item pv_escape
+X<pv_escape>
-=back
-
-=head1 Global Variables
-
-=over 8
+ |const STRLEN count|const STRLEN max
+ |STRLEN const *escaped, const U32 flags
-=item 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.
-In a pinch, it can also be used as a symbol table for extensions
-to share data among each other. It is a good idea to use keys
-prefixed by the package name of the extension that owns the data.
+Escapes at most the first "count" chars of pv and puts the results into
+dsv such that the size of the escaped string will not exceed "max" chars
+and will not contain any incomplete escape sequences.
- HV* PL_modglobal
+If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
+will also be escaped.
-=for hackers
-Found in file intrpvar.h
+Normally the SV will be cleared before the escaped string is prepared,
+but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
-=item PL_na
+If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
+if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
+using C<is_utf8_string()> to determine if it is Unicode.
-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
-to either declare a local variable and use that instead or to use the
-C<SvPV_nolen> macro.
+If PERL_PV_ESCAPE_ALL is set then all input chars will be output
+using C<\x01F1> style escapes, otherwise only chars above 255 will be
+escaped using this style, other non printable chars will use octal or
+common escaped patterns like C<\n>. If PERL_PV_ESCAPE_NOBACKSLASH
+then all chars below 255 will be treated as printable and
+will be output as literals.
- STRLEN PL_na
+If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
+string will be escaped, regardles of max. If the string is utf8 and
+the chars value is >255 then it will be returned as a plain hex
+sequence. Thus the output will either be a single char,
+an octal escape sequence, a special escape like C<\n> or a 3 or
+more digit hex value.
-=for hackers
-Found in file thrdvar.h
+If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and
+not a '\\'. This is because regexes very often contain backslashed
+sequences, whereas '%' is not a particularly common character in patterns.
-=item PL_sv_no
+Returns a pointer to the escaped text as held by dsv.
-This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
-C<&PL_sv_no>.
+NOTE: the perl_ form of this function is deprecated.
- SV PL_sv_no
+ char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)
=for hackers
-Found in file intrpvar.h
-
-=item PL_sv_undef
+Found in file dump.c
-This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
+=item pv_pretty
+X<pv_pretty>
- SV PL_sv_undef
+ |const STRLEN count|const STRLEN max\
+ |const char const *start_color| const char const *end_color\
+ |const U32 flags
-=for hackers
-Found in file intrpvar.h
+Converts a string into something presentable, handling escaping via
+pv_escape() and supporting quoting and ellipses.
-=item PL_sv_yes
+If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
+double quoted with any double quotes in the string escaped. Otherwise
+if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
+angle brackets.
+
+If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
+string were output then an ellipsis C<...> will be appended to the
+string. Note that this happens AFTER it has been quoted.
+
+If start_color is non-null then it will be inserted after the opening
+quote (if there is one) but before the escaped text. If end_color
+is non-null then it will be inserted after the escaped text but before
+any quotes or ellipses.
-This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
-C<&PL_sv_yes>.
+Returns a pointer to the prettified text as held by dsv.
+
+NOTE: the perl_ form of this function is deprecated.
- SV PL_sv_yes
+ char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags)
=for hackers
-Found in file intrpvar.h
+Found in file dump.c
=back
-=head1 GV Functions
+=head1 Functions in file mathoms.c
+
=over 8
-=item GvSV
+=item gv_fetchmethod
+X<gv_fetchmethod>
-Return the SV from the GV.
+See L<gv_fetchmethod_autoload>.
- SV* GvSV(GV* gv)
+ GV* gv_fetchmethod(HV* stash, const char* name)
=for hackers
-Found in file gv.h
+Found in file mathoms.c
-=item 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
-accessible via @ISA and UNIVERSAL::.
-
-The argument C<level> should be either 0 or -1. If C<level==0>, as a
-side-effect creates a glob with the given C<name> in the given C<stash>
-which in the case of success contains an alias for the subroutine, and sets
-up caching info for this glob. Similarly for all the searched stashes.
+=item pack_cat
+X<pack_cat>
-This function grants C<"SUPER"> token as a postfix of the stash name. The
-GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
-visible to Perl code. So when calling C<call_sv>, you should not use
-the GV directly; instead, you should use the method's CV, which can be
-obtained from the GV with the C<GvCV> macro.
+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.
- GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
+ 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 gv.c
-
-=item gv_fetchmethod
+Found in file mathoms.c
-See L<gv_fetchmethod_autoload>.
+=item sv_2pvbyte_nolen
+X<sv_2pvbyte_nolen>
- GV* gv_fetchmethod(HV* stash, const char* name)
+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.
-=for hackers
-Found in file gv.c
+Usually accessed via the C<SvPVbyte_nolen> macro.
-=item gv_fetchmethod_autoload
+ char* sv_2pvbyte_nolen(SV* sv)
-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
-glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
-already setup.
+=for hackers
+Found in file mathoms.c
-The third parameter of C<gv_fetchmethod_autoload> determines whether
-AUTOLOAD lookup is performed if the given method is not present: non-zero
-means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
-Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
-with a non-zero C<autoload> parameter.
+=item sv_2pvutf8_nolen
+X<sv_2pvutf8_nolen>
-These functions grant C<"SUPER"> token as a prefix of the method name. Note
-that if you want to keep the returned glob for a long time, you need to
-check for it being "AUTOLOAD", since at the later time the call may load a
-different subroutine due to $AUTOLOAD changing its value. Use the glob
-created via a side effect to do this.
+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.
-These functions have the same side-effects and as C<gv_fetchmeth> with
-C<level==0>. C<name> should be writable if contains C<':'> or C<'
-''>. The warning against passing the GV returned by C<gv_fetchmeth> to
-C<call_sv> apply equally to these functions.
+Usually accessed via the C<SvPVutf8_nolen> macro.
- GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
+ char* sv_2pvutf8_nolen(SV* sv)
=for hackers
-Found in file gv.c
-
-=item gv_fetchmeth_autoload
-
-Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
-Returns a glob for the subroutine.
+Found in file mathoms.c
-For an autoloaded subroutine without a GV, will create a GV even
-if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
-of the result may be zero.
+=item sv_2pv_nolen
+X<sv_2pv_nolen>
- GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
+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 gv.c
+Found in file mathoms.c
-=item gv_stashpv
+=item sv_catpvn_mg
+X<sv_catpvn_mg>
-Returns a pointer to the stash for a specified package. C<name> should
-be a valid UTF-8 string. If C<create> is set then the package will be
-created if it does not already exist. If C<create> is not set and the
-package does not exist then NULL is returned.
+Like C<sv_catpvn>, but also handles 'set' magic.
- HV* gv_stashpv(const char* name, I32 create)
+ void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
=for hackers
-Found in file gv.c
+Found in file mathoms.c
-=item gv_stashsv
+=item sv_catsv_mg
+X<sv_catsv_mg>
-Returns a pointer to the stash for a specified package, which must be a
-valid UTF-8 string. See C<gv_stashpv>.
+Like C<sv_catsv>, but also handles 'set' magic.
- HV* gv_stashsv(SV* sv, I32 create)
+ void sv_catsv_mg(SV *dsv, SV *ssv)
=for hackers
-Found in file gv.c
+Found in file mathoms.c
+=item sv_force_normal
+X<sv_force_normal>
-=back
+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>.
-=head1 Handy Values
+ void sv_force_normal(SV *sv)
-=over 8
+=for hackers
+Found in file mathoms.c
-=item HEf_SVKEY
+=item sv_iv
+X<sv_iv>
-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
-is to be expected. (For information only--not to be used).
+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 hv.h
+Found in file mathoms.c
-=item Nullch
+=item sv_nolocking
+X<sv_nolocking>
-Null character pointer.
-=for hackers
-Found in file handy.h
+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.
-=item Nullsv
+"Superseded" by sv_nosharing().
-Null SV pointer.
+ void sv_nolocking(SV *sv)
=for hackers
-Found in file handy.h
+Found in file mathoms.c
+=item sv_nounlocking
+X<sv_nounlocking>
-=back
+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.
-=head1 Hash Manipulation Functions
+"Superseded" by sv_nosharing().
-=over 8
+ void sv_nounlocking(SV *sv)
-=item get_hv
+=for hackers
+Found in file mathoms.c
-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
-set and the variable does not exist then NULL is returned.
+=item sv_nv
+X<sv_nv>
-NOTE: the perl_ form of this function is deprecated.
+A private implementation of the C<SvNVx> macro for compilers which can't
+cope with complex macro expressions. Always use the macro instead.
- HV* get_hv(const char* name, I32 create)
+ NV sv_nv(SV* sv)
=for hackers
-Found in file perl.c
+Found in file mathoms.c
-=item HeHASH
+=item sv_pv
+X<sv_pv>
-Returns the computed hash stored in the hash entry.
+Use the C<SvPV_nolen> macro instead
- U32 HeHASH(HE* he)
+ char* sv_pv(SV *sv)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item HeKEY
+=item sv_pvbyte
+X<sv_pvbyte>
-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
-C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
-usually preferable for finding the value of a key.
+Use C<SvPVbyte_nolen> instead.
- void* HeKEY(HE* he)
+ char* sv_pvbyte(SV *sv)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item HeKLEN
+=item sv_pvbyten
+X<sv_pvbyten>
-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
-be assigned to. The C<HePV()> macro is usually preferable for finding key
-lengths.
+A private implementation of the C<SvPVbyte> macro for compilers
+which can't cope with complex macro expressions. Always use the macro
+instead.
- STRLEN HeKLEN(HE* he)
+ char* sv_pvbyten(SV *sv, STRLEN *lp)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item HePV
+=item sv_pvn
+X<sv_pvn>
-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
-is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
-not care about what the length of the key is, you may use the global
-variable C<PL_na>, though this is rather less efficient than using a local
-variable. Remember though, that hash keys in perl are free to contain
-embedded nulls, so using C<strlen()> or similar is not a good way to find
-the length of hash keys. This is very similar to the C<SvPV()> macro
-described elsewhere in this document.
+A private implementation of the C<SvPV> macro for compilers which can't
+cope with complex macro expressions. Always use the macro instead.
- char* HePV(HE* he, STRLEN len)
+ char* sv_pvn(SV *sv, STRLEN *lp)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item HeSVKEY
+=item sv_pvutf8
+X<sv_pvutf8>
-Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
-contain an C<SV*> key.
+Use the C<SvPVutf8_nolen> macro instead
- SV* HeSVKEY(HE* he)
+ char* sv_pvutf8(SV *sv)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item HeSVKEY_force
+=item sv_pvutf8n
+X<sv_pvutf8n>
-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.
+A private implementation of the C<SvPVutf8> macro for compilers
+which can't cope with complex macro expressions. Always use the macro
+instead.
- SV* HeSVKEY_force(HE* he)
+ char* sv_pvutf8n(SV *sv, STRLEN *lp)
=for hackers
-Found in file hv.h
-
-=item HeSVKEY_set
+Found in file mathoms.c
-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
-C<SV*>.
+=item sv_taint
+X<sv_taint>
- SV* HeSVKEY_set(HE* he, SV* sv)
+Taint an SV. Use C<SvTAINTED_on> instead.
+ void sv_taint(SV* sv)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item HeVAL
+=item sv_unref
+X<sv_unref>
-Returns the value slot (type C<SV*>) stored in the hash entry.
+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>.
- SV* HeVAL(HE* he)
+ void sv_unref(SV* sv)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item HvNAME
+=item sv_usepvn
+X<sv_usepvn>
-Returns the package name of a stash. See C<SvSTASH>, C<CvSTASH>.
+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>.
- char* HvNAME(HV* stash)
+ void sv_usepvn(SV* sv, char* ptr, STRLEN len)
=for hackers
-Found in file hv.h
+Found in file mathoms.c
-=item hv_clear
+=item sv_usepvn_mg
+X<sv_usepvn_mg>
-Clears a hash, making it empty.
+Like C<sv_usepvn>, but also handles 'set' magic.
- void hv_clear(HV* tb)
+ void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
=for hackers
-Found in file hv.c
+Found in file mathoms.c
-=item hv_delete
+=item sv_uv
+X<sv_uv>
-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.
-The C<flags> value will normally be zero; if set to G_DISCARD then NULL
-will be returned.
+A private implementation of the C<SvUVx> macro for compilers which can't
+cope with complex macro expressions. Always use the macro instead.
- SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
+ UV sv_uv(SV* sv)
=for hackers
-Found in file hv.c
+Found in file mathoms.c
-=item hv_delete_ent
+=item unpack_str
+X<unpack_str>
-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;
-if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
-precomputed hash value, or 0 to ask for it to be computed.
+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.
- SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
+ 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 hv.c
+Found in file mathoms.c
-=item hv_exists
-Returns a boolean indicating whether the specified hash key exists. The
-C<klen> is the length of the key.
+=back
- bool hv_exists(HV* tb, const char* key, I32 klen)
+=head1 Functions in file pp_ctl.c
-=for hackers
-Found in file hv.c
-=item hv_exists_ent
+=over 8
-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
-computed.
+=item find_runcv
+X<find_runcv>
- bool hv_exists_ent(HV* tb, SV* key, U32 hash)
+Locate the CV corresponding to the currently executing sub or eval.
+If db_seqp is non_null, skip CVs that are in the DB package and populate
+*db_seqp with the cop sequence number at the point that the DB:: code was
+entered. (allows debuggers to eval in the scope of the breakpoint rather
+than in the scope of the debugger itself).
+
+ CV* find_runcv(U32 *db_seqp)
=for hackers
-Found in file hv.c
+Found in file pp_ctl.c
-=item 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
-part of a store. Check that the return value is non-null before
-dereferencing it to an C<SV*>.
+=back
-See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
-information on how to use this function on tied hashes.
+=head1 Functions in file pp_pack.c
- SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
-=for hackers
-Found in file hv.c
+=over 8
-=item hv_fetch_ent
+=item packlist
+X<packlist>
-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
-if you want the function to compute it. IF C<lval> is set then the fetch
-will be part of a store. Make sure the return value is non-null before
-accessing it. The return value when C<tb> is a tied hash is a pointer to a
-static location, so be sure to make a copy of the structure if you need to
-store it somewhere.
+The engine implementing pack() Perl function.
-See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
-information on how to use this function on tied hashes.
+ 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.
- HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
+ I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)
=for hackers
-Found in file hv.c
+Found in file pp_pack.c
-=item 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
-currently only meaningful for hashes without tie magic.
+=back
-NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
-hash buckets that happen to be in use. If you still need that esoteric
-value, you can get it through the macro C<HvFILL(tb)>.
+=head1 GV Functions
+
+=over 8
+
+=item GvSV
+X<GvSV>
+Return the SV from the GV.
- I32 hv_iterinit(HV* tb)
+ SV* GvSV(GV* gv)
=for hackers
-Found in file hv.c
+Found in file gv.h
-=item hv_iterkey
+=item gv_const_sv
+X<gv_const_sv>
-Returns the key from the current position of the hash iterator. See
-C<hv_iterinit>.
+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.
- char* hv_iterkey(HE* entry, I32* retlen)
+ SV* gv_const_sv(GV* gv)
=for hackers
-Found in file hv.c
+Found in file gv.c
-=item hv_iterkeysv
+=item gv_fetchmeth
+X<gv_fetchmeth>
-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
-see C<hv_iterinit>.
+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
+accessible via @ISA and UNIVERSAL::.
- SV* hv_iterkeysv(HE* entry)
+The argument C<level> should be either 0 or -1. If C<level==0>, as a
+side-effect creates a glob with the given C<name> in the given C<stash>
+which in the case of success contains an alias for the subroutine, and sets
+up caching info for this glob.
+
+This function grants C<"SUPER"> token as a postfix of the stash name. The
+GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
+visible to Perl code. So when calling C<call_sv>, you should not use
+the GV directly; instead, you should use the method's CV, which can be
+obtained from the GV with the C<GvCV> macro.
+
+ GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
=for hackers
-Found in file hv.c
+Found in file gv.c
-=item hv_iternext
+=item gv_fetchmethod_autoload
+X<gv_fetchmethod_autoload>
-Returns entries from a hash iterator. See C<hv_iterinit>.
+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
+glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
+already setup.
-You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
-iterator currently points to, without losing your place or invalidating your
-iterator. Note that in this case the current entry is deleted from the hash
-with your iterator holding the last reference to it. Your iterator is flagged
-to free the entry on the next call to C<hv_iternext>, so you must not discard
-your iterator immediately else the entry will leak - call C<hv_iternext> to
-trigger the resource deallocation.
+The third parameter of C<gv_fetchmethod_autoload> determines whether
+AUTOLOAD lookup is performed if the given method is not present: non-zero
+means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
+Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
+with a non-zero C<autoload> parameter.
+
+These functions grant C<"SUPER"> token as a prefix of the method name. Note
+that if you want to keep the returned glob for a long time, you need to
+check for it being "AUTOLOAD", since at the later time the call may load a
+different subroutine due to $AUTOLOAD changing its value. Use the glob
+created via a side effect to do this.
- HE* hv_iternext(HV* tb)
+These functions have the same side-effects and as C<gv_fetchmeth> with
+C<level==0>. C<name> should be writable if contains C<':'> or C<'
+''>. The warning against passing the GV returned by C<gv_fetchmeth> to
+C<call_sv> apply equally to these functions.
+
+ GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
=for hackers
-Found in file hv.c
+Found in file gv.c
-=item hv_iternextsv
+=item gv_fetchmeth_autoload
+X<gv_fetchmeth_autoload>
-Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
-operation.
+Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
+Returns a glob for the subroutine.
+
+For an autoloaded subroutine without a GV, will create a GV even
+if C<level < 0>. For an autoloaded subroutine without a stub, GvCV()
+of the result may be zero.
- SV* hv_iternextsv(HV* hv, char** key, I32* retlen)
+ GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)
=for hackers
-Found in file hv.c
+Found in file gv.c
-=item hv_iternext_flags
+=item gv_stashpv
+X<gv_stashpv>
-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
-set the placeholders keys (for restricted hashes) will be returned in addition
-to normal keys. By default placeholders are automatically skipped over.
-Currently a placeholder is implemented with a value that is literally
-<&Perl_sv_undef> (a regular C<undef> value is a normal read-write SV for which
-C<!SvOK> is false). Note that the implementation of placeholders and
-restricted hashes may change, and the implementation currently is
-insufficiently abstracted for any change to be tidy.
+Returns a pointer to the stash for a specified package. Uses C<strlen> to
+determine the length of C<name>, then calls C<gv_stashpvn()>.
-NOTE: this function is experimental and may change or be
-removed without notice.
+ HV* gv_stashpv(const char* name, I32 flags)
+
+=for hackers
+Found in file gv.c
+
+=item gv_stashpvn
+X<gv_stashpvn>
+
+Returns a pointer to the stash for a specified package. The C<namelen>
+parameter indicates the length of the C<name>, in bytes. C<flags> is passed
+to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be
+created if it does not already exist. If the package does not exist and
+C<flags> is 0 (or any other setting that does not create packages) then NULL
+is returned.
- HE* hv_iternext_flags(HV* tb, I32 flags)
+
+ HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)
=for hackers
-Found in file hv.c
+Found in file gv.c
-=item hv_iterval
+=item gv_stashpvs
+X<gv_stashpvs>
-Returns the value from the current position of the hash iterator. See
-C<hv_iterkey>.
+Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair.
- SV* hv_iterval(HV* tb, HE* entry)
+ HV* gv_stashpvs(const char* name, I32 create)
=for hackers
-Found in file hv.c
+Found in file handy.h
-=item hv_magic
+=item gv_stashsv
+X<gv_stashsv>
-Adds magic to a hash. See C<sv_magic>.
+Returns a pointer to the stash for a specified package. See C<gv_stashpvn>.
- void hv_magic(HV* hv, GV* gv, int how)
+ HV* gv_stashsv(SV* sv, I32 flags)
=for hackers
-Found in file hv.c
+Found in file gv.c
-=item 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
-value; if it is zero then Perl will compute it. The return value will be
-NULL if the operation failed or if the value did not need to be actually
-stored within the hash (as in the case of tied hashes). Otherwise it can
-be dereferenced to get the original C<SV*>. Note that the caller is
-responsible for suitably incrementing the reference count of C<val> before
-the call, and decrementing it if the function returned NULL. Effectively
-a successful hv_store takes ownership of one reference to C<val>. This is
-usually what you want; a newly created SV has a reference count of one, so
-if all your code does is create SVs then store them in a hash, hv_store
-will own the only reference to the new SV, and your code doesn't need to do
-anything further to tidy up. hv_store is not implemented as a call to
-hv_store_ent, and does not create a temporary SV for the key, so if your
-key data is not already in SV form then use hv_store in preference to
-hv_store_ent.
+=back
-See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
-information on how to use this function on tied hashes.
+=head1 Handy Values
+
+=over 8
- SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
+=item Nullav
+X<Nullav>
+
+Null AV pointer.
+
+(deprecated - use C<(AV *)NULL> instead)
=for hackers
-Found in file hv.c
+Found in file av.h
-=item hv_store_ent
+=item Nullch
+X<Nullch>
+
+Null character pointer. (No longer available when C<PERL_CORE> is defined.)
+
+=for hackers
+Found in file handy.h
+
+=item Nullcv
+X<Nullcv>
+
+Null CV pointer.
+
+(deprecated - use C<(CV *)NULL> instead)
+
+=for hackers
+Found in file cv.h
+
+=item Nullhv
+X<Nullhv>
+
+Null HV pointer.
+
+(deprecated - use C<(HV *)NULL> instead)
+
+=for hackers
+Found in file hv.h
+
+=item Nullsv
+X<Nullsv>
+
+Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
+
+=for hackers
+Found in file handy.h
+
+
+=back
+
+=head1 Hash Manipulation Functions
+
+=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
+set and the variable does not exist then NULL is returned.
+
+NOTE: the perl_ form of this function is deprecated.
+
+ HV* get_hv(const char* name, I32 create)
+
+=for hackers
+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
+is to be expected. (For information only--not to be used).
+
+=for hackers
+Found in file hv.h
+
+=item HeHASH
+X<HeHASH>
+
+Returns the computed hash stored in the hash entry.
+
+ U32 HeHASH(HE* he)
+
+=for hackers
+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
+C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
+usually preferable for finding the value of a key.
+
+ void* HeKEY(HE* he)
+
+=for hackers
+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
+be assigned to. The C<HePV()> macro is usually preferable for finding key
+lengths.
+
+ STRLEN HeKLEN(HE* he)
+
+=for hackers
+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
+is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
+not care about what the length of the key is, you may use the global
+variable C<PL_na>, though this is rather less efficient than using a local
+variable. Remember though, that hash keys in perl are free to contain
+embedded nulls, so using C<strlen()> or similar is not a good way to find
+the length of hash keys. This is very similar to the C<SvPV()> macro
+described elsewhere in this document. See also C<HeUTF8>.
+
+If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
+new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
+efficient.
+
+ char* HePV(HE* he, STRLEN len)
+
+=for hackers
+Found in file hv.h
+
+=item HeSVKEY
+X<HeSVKEY>
+
+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)
+
+=for hackers
+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.
+
+ SV* HeSVKEY_force(HE* he)
+
+=for hackers
+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
+C<SV*>.
+
+ SV* HeSVKEY_set(HE* he, SV* sv)
+
+=for hackers
+Found in file hv.h
+
+=item HeUTF8
+X<HeUTF8>
+
+Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
+doing any necessary dereferencing of possibly C<SV*> keys. The value returned
+will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
+so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
+typedef for C<char>.
+
+ char* HeUTF8(HE* he, STRLEN len)
+
+=for hackers
+Found in file hv.h
+
+=item HeVAL
+X<HeVAL>
+
+Returns the value slot (type C<SV*>) stored in the hash entry.
+
+ SV* HeVAL(HE* he)
+
+=for hackers
+Found in file hv.h
+
+=item HvNAME
+X<HvNAME>
+
+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)
+
+=for hackers
+Found in file hv.h
+
+=item hv_assert
+X<hv_assert>
+
+Check that a hash is in an internally consistent state.
+
+ void hv_assert(HV *hv)
+
+=for hackers
+Found in file hv.c
+
+=item hv_clear
+X<hv_clear>
+
+Clears a hash, making it empty.
+
+ void hv_clear(HV *hv)
+
+=for hackers
+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
+deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
+it so it will be ignored by future operations such as iterating over the hash,
+but will still allow the hash to have a value reassigned to the key at some
+future point. This function clears any such placeholder keys from the hash.
+See Hash::Util::lock_keys() for an example of its use.
+
+ void hv_clear_placeholders(HV *hv)
+
+=for hackers
+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.
+The C<flags> value will normally be zero; if set to G_DISCARD then NULL
+will be returned.
+
+ SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)
+
+=for hackers
+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;
+if set to G_DISCARD then NULL will be returned. C<hash> can be a valid
+precomputed hash value, or 0 to ask for it to be computed.
+
+ SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)
+
+=for hackers
+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.
+
+ bool hv_exists(HV *hv, const char *key, I32 klen)
+
+=for hackers
+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
+computed.
+
+ bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)
+
+=for hackers
+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
+part of a store. Check that the return value is non-null before
+dereferencing it to an C<SV*>.
+
+See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
+information on how to use this function on tied hashes.
+
+ SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)
+
+=for hackers
+Found in file hv.c
+
+=item hv_fetchs
+X<hv_fetchs>
+
+Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
+
+ SV** hv_fetchs(HV* tb, const char* key, I32 lval)
+
+=for hackers
+Found in file handy.h
+
+=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
+if you want the function to compute it. IF C<lval> is set then the fetch
+will be part of a store. Make sure the return value is non-null before
+accessing it. The return value when C<tb> is a tied hash is a pointer to a
+static location, so be sure to make a copy of the structure if you need to
+store it somewhere.
+
+See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
+information on how to use this function on tied hashes.
+
+ HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)
+
+=for hackers
+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
+currently only meaningful for hashes without tie magic.
+
+NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
+hash buckets that happen to be in use. If you still need that esoteric
+value, you can get it through the macro C<HvFILL(tb)>.
+
+
+ I32 hv_iterinit(HV *hv)
+
+=for hackers
+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>.
+
+ char* hv_iterkey(HE* entry, I32* retlen)
+
+=for hackers
+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
+see C<hv_iterinit>.
+
+ SV* hv_iterkeysv(HE* entry)
+
+=for hackers
+Found in file hv.c
+
+=item hv_iternext
+X<hv_iternext>
+
+Returns entries from a hash iterator. See C<hv_iterinit>.
+
+You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
+iterator currently points to, without losing your place or invalidating your
+iterator. Note that in this case the current entry is deleted from the hash
+with your iterator holding the last reference to it. Your iterator is flagged
+to free the entry on the next call to C<hv_iternext>, so you must not discard
+your iterator immediately else the entry will leak - call C<hv_iternext> to
+trigger the resource deallocation.
+
+ HE* hv_iternext(HV *hv)
+
+=for hackers
+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.
+
+ SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)
+
+=for hackers
+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
+set the placeholders keys (for restricted hashes) will be returned in addition
+to normal keys. By default placeholders are automatically skipped over.
+Currently a placeholder is implemented with a value that is
+C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
+restricted hashes may change, and the implementation currently is
+insufficiently abstracted for any change to be tidy.
+
+NOTE: this function is experimental and may change or be
+removed without notice.
+
+ HE* hv_iternext_flags(HV *hv, I32 flags)
+
+=for hackers
+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>.
+
+ SV* hv_iterval(HV *hv, HE *entry)
+
+=for hackers
+Found in file hv.c
+
+=item hv_magic
+X<hv_magic>
+
+Adds magic to a hash. See C<sv_magic>.
+
+ void hv_magic(HV *hv, GV *gv, int how)
+
+=for hackers
+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.
+
+ SV* hv_scalar(HV *hv)
+
+=for hackers
+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
+value; if it is zero then Perl will compute it. The return value will be
+NULL if the operation failed or if the value did not need to be actually
+stored within the hash (as in the case of tied hashes). Otherwise it can
+be dereferenced to get the original C<SV*>. Note that the caller is
+responsible for suitably incrementing the reference count of C<val> before
+the call, and decrementing it if the function returned NULL. Effectively
+a successful hv_store takes ownership of one reference to C<val>. This is
+usually what you want; a newly created SV has a reference count of one, so
+if all your code does is create SVs then store them in a hash, hv_store
+will own the only reference to the new SV, and your code doesn't need to do
+anything further to tidy up. hv_store is not implemented as a call to
+hv_store_ent, and does not create a temporary SV for the key, so if your
+key data is not already in SV form then use hv_store in preference to
+hv_store_ent.
+
+See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
+information on how to use this function on tied hashes.
+
+ SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)
+
+=for hackers
+Found in file hv.c
+
+=item hv_stores
+X<hv_stores>
+
+Like C<hv_store>, but takes a literal string instead of a string/length pair
+and omits the hash parameter.
+
+ SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)
+
+=for hackers
+Found in file handy.h
+
+=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
SV for the key, so if your key data is not already in SV form then use
hv_store in preference to hv_store_ent.
-See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
-information on how to use this function on tied hashes.
+See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
+information on how to use this function on tied hashes.
+
+ HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
+
+=for hackers
+Found in file hv.c
+
+=item hv_undef
+X<hv_undef>
+
+Undefines the hash.
+
+ void hv_undef(HV *hv)
+
+=for hackers
+Found in file hv.c
+
+=item newHV
+X<newHV>
+
+Creates a new HV. The reference count is set to 1.
+
+ HV* newHV()
+
+=for hackers
+Found in file hv.h
+
+
+=back
+
+=head1 Magical Functions
+
+=over 8
+
+=item mg_clear
+X<mg_clear>
+
+Clear something magical that the SV represents. See C<sv_magic>.
+
+ int mg_clear(SV* sv)
+
+=for hackers
+Found in file mg.c
+
+=item mg_copy
+X<mg_copy>
+
+Copies the magic from one SV to another. See C<sv_magic>.
+
+ int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)
+
+=for hackers
+Found in file mg.c
+
+=item mg_find
+X<mg_find>
+
+Finds the magic pointer for type matching the SV. See C<sv_magic>.
+
+ MAGIC* mg_find(const SV* sv, int type)
+
+=for hackers
+Found in file mg.c
+
+=item mg_free
+X<mg_free>
+
+Free any magic storage used by the SV. See C<sv_magic>.
+
+ int mg_free(SV* sv)
+
+=for hackers
+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>.
+
+ int mg_get(SV* sv)
+
+=for hackers
+Found in file mg.c
+
+=item mg_length
+X<mg_length>
+
+Report on the SV's length. See C<sv_magic>.
+
+ U32 mg_length(SV* sv)
+
+=for hackers
+Found in file mg.c
+
+=item mg_magical
+X<mg_magical>
+
+Turns on the magical status of an SV. See C<sv_magic>.
+
+ void mg_magical(SV* sv)
+
+=for hackers
+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>.
+
+ int mg_set(SV* sv)
+
+=for hackers
+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.
+
+ void SvGETMAGIC(SV* sv)
+
+=for hackers
+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.
+
+ void SvLOCK(SV* sv)
+
+=for hackers
+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.
+
+ void SvSETMAGIC(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvSetMagicSV
+X<SvSetMagicSV>
+
+Like C<SvSetSV>, but does any set magic required afterwards.
+
+ void SvSetMagicSV(SV* dsb, SV* ssv)
+
+=for hackers
+Found in file sv.h
+
+=item SvSetMagicSV_nosteal
+X<SvSetMagicSV_nosteal>
+
+Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
+
+ void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
+
+=for hackers
+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.
+
+ void SvSetSV(SV* dsb, SV* ssv)
+
+=for hackers
+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.
+
+ void SvSetSV_nosteal(SV* dsv, SV* ssv)
+
+=for hackers
+Found in file sv.h
+
+=item SvSHARE
+X<SvSHARE>
+
+Arranges for sv to be shared between threads if a suitable module
+has been loaded.
+
+ void SvSHARE(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+=item SvUNLOCK
+X<SvUNLOCK>
+
+Releases a mutual exclusion lock on sv if a suitable module
+has been loaded.
+
+ void SvUNLOCK(SV* sv)
+
+=for hackers
+Found in file sv.h
+
+
+=back
+
+=head1 Memory Management
+
+=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
+the type. May fail on overlapping copies. See also C<Move>.
+
+ void Copy(void* src, void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item CopyD
+X<CopyD>
+
+Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
+optimise.
+
+ void * CopyD(void* src, void* dest, int nitems, type)
+
+=for hackers
+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
+the type. Can do overlapping moves. See also C<Copy>.
+
+ void Move(void* src, void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item MoveD
+X<MoveD>
+
+Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
+optimise.
+
+ void * MoveD(void* src, void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item Newx
+X<Newx>
+
+The XSUB-writer's interface to the C C<malloc> function.
+
+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 Newxc
+X<Newxc>
+
+The XSUB-writer's interface to the C C<malloc> function, with
+cast. See also C<Newx>.
+
+ void Newxc(void* ptr, int nitems, type, cast)
+
+=for hackers
+Found in file handy.h
+
+=item Newxz
+X<Newxz>
+
+The XSUB-writer's interface to the C C<malloc> function. The allocated
+memory is zeroed with C<memzero>. See also C<Newx>.
+
+ void Newxz(void* ptr, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item Poison
+X<Poison>
+
+PoisonWith(0xEF) for catching access to freed memory.
+
+ void Poison(void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item PoisonFree
+X<PoisonFree>
+
+PoisonWith(0xEF) for catching access to freed memory.
+
+ void PoisonFree(void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item PoisonNew
+X<PoisonNew>
+
+PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
+
+ void PoisonNew(void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item PoisonWith
+X<PoisonWith>
+
+Fill up memory with a byte pattern (a byte repeated over and over
+again) that hopefully catches attempts to access uninitialized memory.
+
+ void PoisonWith(void* dest, int nitems, type, U8 byte)
+
+=for hackers
+Found in file handy.h
+
+=item Renew
+X<Renew>
+
+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)
+
+=for hackers
+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
+determined by C<strlen()>. The memory allocated for the new string can
+be freed with the C<Safefree()> function.
+
+ char* savepv(const char* pv)
+
+=for hackers
+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>, 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)
+
+=for hackers
+Found in file util.c
+
+=item savepvs
+X<savepvs>
+
+Like C<savepvn>, but takes a literal string instead of a string/length pair.
+
+ char* savepvs(const char* s)
+
+=for hackers
+Found in file handy.h
+
+=item savesharedpv
+X<savesharedpv>
+
+A version of C<savepv()> which allocates the duplicate string in memory
+which is shared between threads.
+
+ char* savesharedpv(const char* pv)
+
+=for hackers
+Found in file util.c
+
+=item savesharedpvn
+X<savesharedpvn>
+
+A version of C<savepvn()> which allocates the duplicate string in memory
+which is shared between threads. (With the specific difference that a NULL
+pointer is not acceptable)
+
+ char* savesharedpvn(const char *const pv, const STRLEN len)
+
+=for hackers
+Found in file util.c
+
+=item savesvpv
+X<savesvpv>
+
+A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
+the passed in SV using C<SvPV()>
+
+ char* savesvpv(SV* sv)
+
+=for hackers
+Found in file util.c
+
+=item StructCopy
+X<StructCopy>
+
+This is an architecture-independent macro to copy one structure to another.
+
+ void StructCopy(type src, type dest, type)
+
+=for hackers
+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.
+
+ void Zero(void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+=item ZeroD
+X<ZeroD>
+
+Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
+optimise.
+
+ void * ZeroD(void* dest, int nitems, type)
+
+=for hackers
+Found in file handy.h
+
+
+=back
+
+=head1 Miscellaneous Functions
+
+=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.
+
+ void fbm_compile(SV* sv, U32 flags)
+
+=for hackers
+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<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.
+
+ char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)
+
+=for hackers
+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.
+
+ (char *) Perl_form(pTHX_ const char* pat, ...)
+
+can be used any place a string (char *) is required:
+
+ char * s = Perl_form("%d.%d",major,minor);
+
+Uses a single private buffer so if you want to format several strings you
+must explicitly copy the earlier strings away (and free the copies when you
+are done).
+
+ char* form(const char* pat, ...)
+
+=for hackers
+Found in file util.c
+
+=item getcwd_sv
+X<getcwd_sv>
+
+Fill the sv with current working directory
+
+ int getcwd_sv(SV* sv)
+
+=for hackers
+Found in file util.c
+
+=item my_snprintf
+X<my_snprintf>
+
+The C library C<snprintf> functionality, if available and
+standards-compliant (uses C<vsnprintf>, actually). However, if the
+C<vsnprintf> is not available, will unfortunately use the unsafe
+C<vsprintf> which can overrun the buffer (there is an overrun check,
+but that may be too late). Consider using C<sv_vcatpvf> instead, or
+getting C<vsnprintf>.
+
+ int my_snprintf(char *buffer, const Size_t len, const char *format, ...)
+
+=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 my_vsnprintf
+X<my_vsnprintf>
+
+The C library C<vsnprintf> if available and standards-compliant.
+However, if if the C<vsnprintf> is not available, will unfortunately
+use the unsafe C<vsprintf> which can overrun the buffer (there is an
+overrun check, but that may be too late). Consider using
+C<sv_vcatpvf> instead, or getting C<vsnprintf>.
+
+ int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
+
+=for hackers
+Found in file util.c
+
+=item new_version
+X<new_version>
+
+Returns a new version object based on the passed in SV:
+
+ SV *sv = new_version(SV *ver);
+
+Does not alter the passed in ver SV. See "upg_version" if you
+want to upgrade the SV.
+
+ SV* new_version(SV *ver)
+
+=for hackers
+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
+an RV.
+
+Function must be called with an already existing SV like
+
+ sv = newSV(0);
+ s = scan_version(s, SV *sv, bool qv);
+
+Performs some preprocessing to the string to ensure that
+it has the correct characteristics of a version. Flags the
+object if it contains an underscore (which denotes this
+is an alpha version). The boolean qv denotes that the version
+should be interpreted as if it had multiple decimals, even if
+it doesn't.
+
+ const char* scan_version(const char *s, SV *rv, 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.
+
+ bool strEQ(char* s1, char* s2)
+
+=for hackers
+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.
+
+ bool strGE(char* s1, char* s2)
+
+=for hackers
+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.
+
+ bool strGT(char* s1, char* s2)
+
+=for hackers
+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.
+
+ bool strLE(char* s1, char* s2)
+
+=for hackers
+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.
+
+ bool strLT(char* s1, char* s2)
+
+=for hackers
+Found in file handy.h
+
+=item strNE
+X<strNE>
+
+Test two strings to see if they are different. Returns true or
+false.
+
+ bool strNE(char* s1, char* s2)
+
+=for hackers
+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
+C<strncmp>).
+
+ bool strnEQ(char* s1, char* s2, STRLEN len)
+
+=for hackers
+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
+wrapper for C<strncmp>).
+
+ bool strnNE(char* s1, char* s2, STRLEN len)
+
+=for hackers
+Found in file handy.h
+
+=item sv_destroyable
+X<sv_destroyable>
+
+Dummy routine which reports that object can be destroyed when there is no
+sharing module present. It ignores its single SV argument, and returns
+'true'. Exists to avoid test for a NULL function pointer and because it
+could potentially warn under some level of strict-ness.
+
+ bool sv_destroyable(SV *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.
+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.
+
+ 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.
+
+ SV *sv = upg_version(SV *sv, bool qv);
+
+Returns a pointer to the upgraded SV. Set the boolean qv if you want
+to force this SV to be interpreted as an "extended" version.
+
+ SV* upg_version(SV *ver, bool qv)
+
+=for hackers
+Found in file util.c
+
+=item vcmp
+X<vcmp>
+
+Version object aware cmp. Both operands must already have been
+converted into version objects.
+
+ int vcmp(SV *lhv, SV *rhv)
+
+=for hackers
+Found in file util.c
+
+=item vnormal
+X<vnormal>
+
+Accepts a version object and returns the normalized string
+representation. Call like:
+
+ sv = vnormal(rv);
+
+NOTE: you can pass either the object directly or the SV
+contained within the RV.
+
+ SV* vnormal(SV *vs)
+
+=for hackers
+Found in file util.c
+
+=item vnumify
+X<vnumify>
+
+Accepts a version object and returns the normalized floating
+point representation. Call like:
+
+ sv = vnumify(rv);
+
+NOTE: you can pass either the object directly or the SV
+contained within the RV.
+
+ SV* vnumify(SV *vs)
+
+=for hackers
+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
+notation or the multiple dotted notation, depending on whether
+the original version contained 1 or more dots, respectively
- HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
+ SV* vstringify(SV *vs)
=for hackers
-Found in file hv.c
+Found in file util.c
-=item hv_undef
+=item vverify
+X<vverify>
-Undefines the hash.
+Validates that the SV contains a valid version object.
- void hv_undef(HV* tb)
+ 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 hv.c
+Found in file util.c
-=item newHV
-Creates a new HV. The reference count is set to 1.
+=back
- HV* newHV()
+=head1 MRO Functions
+
+=over 8
+
+=item mro_get_linear_isa
+X<mro_get_linear_isa>
+
+Returns either C<mro_get_linear_isa_c3> or
+C<mro_get_linear_isa_dfs> for the given stash,
+dependant upon which MRO is in effect
+for that stash. The return value is a
+read-only AV*.
+
+You are responsible for C<SvREFCNT_inc()> on the
+return value if you plan to store it anywhere
+semi-permanently (otherwise it might be deleted
+out from under you the next time the cache is
+invalidated).
+
+ AV* mro_get_linear_isa(HV* stash)
=for hackers
-Found in file hv.c
+Found in file mro.c
-=item Nullhv
+=item mro_method_changed_in
+X<mro_method_changed_in>
-Null HV pointer.
+Invalidates method caching on any child classes
+of the given stash, so that they might notice
+the changes in this one.
+
+Ideally, all instances of C<PL_sub_generation++> in
+perl source outside of C<mro.c> should be
+replaced by calls to this.
+
+Perl automatically handles most of the common
+ways a method might be redefined. However, there
+are a few ways you could change a method in a stash
+without the cache code noticing, in which case you
+need to call this method afterwards:
+
+1) Directly manipulating the stash HV entries from
+XS code.
+2) Assigning a reference to a readonly scalar
+constant into a stash entry in order to create
+a constant subroutine (like constant.pm
+does).
+
+This same method is available from pure perl
+via, C<mro::method_changed_in(classname)>.
+
+ void mro_method_changed_in(HV* stash)
=for hackers
-Found in file hv.h
+Found in file mro.c
=back
-=head1 Magical Functions
+=head1 Multicall Functions
=over 8
-=item mg_clear
+=item dMULTICALL
+X<dMULTICALL>
-Clear something magical that the SV represents. See C<sv_magic>.
+Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
- int mg_clear(SV* sv)
+ dMULTICALL;
=for hackers
-Found in file mg.c
+Found in file cop.h
-=item mg_copy
+=item MULTICALL
+X<MULTICALL>
-Copies the magic from one SV to another. See C<sv_magic>.
+Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
- int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
+ MULTICALL;
=for hackers
-Found in file mg.c
+Found in file cop.h
-=item mg_find
+=item POP_MULTICALL
+X<POP_MULTICALL>
-Finds the magic pointer for type matching the SV. See C<sv_magic>.
+Closing bracket for a lightweight callback.
+See L<perlcall/Lightweight Callbacks>.
- MAGIC* mg_find(SV* sv, int type)
+ POP_MULTICALL;
=for hackers
-Found in file mg.c
+Found in file cop.h
-=item mg_free
+=item PUSH_MULTICALL
+X<PUSH_MULTICALL>
-Free any magic storage used by the SV. See C<sv_magic>.
+Opening bracket for a lightweight callback.
+See L<perlcall/Lightweight Callbacks>.
- int mg_free(SV* sv)
+ PUSH_MULTICALL;
=for hackers
-Found in file mg.c
+Found in file cop.h
-=item mg_get
-Do magic after a value is retrieved from the SV. See C<sv_magic>.
+=back
- int mg_get(SV* sv)
+=head1 Numeric functions
+
+=over 8
+
+=item grok_bin
+X<grok_bin>
+
+converts a string representing a binary number to numeric form.
+
+On entry I<start> and I<*len> give the string to scan, I<*flags> gives
+conversion flags, and I<result> should be NULL or a pointer to an NV.
+The scan stops at the end of the string, or the first invalid character.
+Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
+invalid character will also trigger a warning.
+On return I<*len> is set to the length of the scanned string,
+and I<*flags> gives output flags.
+
+If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
+and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
+returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
+and writes the value to I<*result> (or the value is discarded if I<result>
+is NULL).
+
+The binary number may optionally be prefixed with "0b" or "b" unless
+C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
+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_p, I32* flags, NV *result)
=for hackers
-Found in file mg.c
+Found in file numeric.c
-=item mg_length
+=item grok_hex
+X<grok_hex>
-Report on the SV's length. See C<sv_magic>.
+converts a string representing a hex number to numeric form.
- U32 mg_length(SV* sv)
+On entry I<start> and I<*len> give the string to scan, I<*flags> gives
+conversion flags, and I<result> should be NULL or a pointer to an NV.
+The scan stops at the end of the string, or the first invalid character.
+Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
+invalid character will also trigger a warning.
+On return I<*len> is set to the length of the scanned string,
+and I<*flags> gives output flags.
+
+If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
+and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
+returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
+and writes the value to I<*result> (or the value is discarded if I<result>
+is NULL).
+
+The hex number may optionally be prefixed with "0x" or "x" unless
+C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
+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_p, I32* flags, NV *result)
=for hackers
-Found in file mg.c
+Found in file numeric.c
-=item mg_magical
+=item grok_number
+X<grok_number>
-Turns on the magical status of an SV. See C<sv_magic>.
+Recognise (or not) a number. The type of the number is returned
+(0 if unrecognised), otherwise it is a bit-ORed combination of
+IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
+IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
- void mg_magical(SV* sv)
+If the value of the number can fit an in UV, it is returned in the *valuep
+IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
+will never be set unless *valuep is valid, but *valuep may have been assigned
+to during processing even though IS_NUMBER_IN_UV is not set on return.
+If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
+valuep is non-NULL, but no actual assignment (or SEGV) will occur.
+
+IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
+seen (in which case *valuep gives the true value truncated to an integer), and
+IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
+absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
+number is larger than a UV.
+
+ int grok_number(const char *pv, STRLEN len, UV *valuep)
=for hackers
-Found in file mg.c
+Found in file numeric.c
-=item mg_set
+=item grok_numeric_radix
+X<grok_numeric_radix>
-Do magic after a value is assigned to the SV. See C<sv_magic>.
+Scan and skip for a numeric decimal separator (radix).
- int mg_set(SV* sv)
+ bool grok_numeric_radix(const char **sp, const char *send)
=for hackers
-Found in file mg.c
+Found in file numeric.c
-=item SvGETMAGIC
+=item grok_oct
+X<grok_oct>
-Invokes C<mg_get> on an SV if it has 'get' magic. This macro evaluates its
-argument more than once.
+converts a string representing an octal number to numeric form.
- void SvGETMAGIC(SV* sv)
+On entry I<start> and I<*len> give the string to scan, I<*flags> gives
+conversion flags, and I<result> should be NULL or a pointer to an NV.
+The scan stops at the end of the string, or the first invalid character.
+Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
+invalid character will also trigger a warning.
+On return I<*len> is set to the length of the scanned string,
+and I<*flags> gives output flags.
+
+If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
+and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
+returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
+and writes the value to I<*result> (or the value is discarded if I<result>
+is NULL).
+
+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_p, I32* flags, NV *result)
=for hackers
-Found in file sv.h
+Found in file numeric.c
+
+=item Perl_signbit
+X<Perl_signbit>
+
+Return a non-zero integer if the sign bit on an NV is set, and 0 if
+it is not.
+
+If Configure detects this system has a signbit() that will work with
+our NVs, then we just use it via the #define in perl.h. Otherwise,
+fall back on this implementation. As a first pass, this gets everything
+right except -0.0. Alas, catching -0.0 is the main use for this function,
+so this is not too helpful yet. Still, at least we have the scaffolding
+in place to support other systems, should that prove useful.
+
+
+Configure notes: This function is called 'Perl_signbit' instead of a
+plain 'signbit' because it is easy to imagine a system having a signbit()
+function or macro that doesn't happen to work with our particular choice
+of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect
+the standard system headers to be happy. Also, this is a no-context
+function (no pTHX_) because Perl_signbit() is usually re-#defined in
+perl.h as a simple macro call to the system's signbit().
+Users should just always call Perl_signbit().
+
+NOTE: this function is experimental and may change or be
+removed without notice.
+
+ int Perl_signbit(NV f)
+
+=for hackers
+Found in file numeric.c
+
+=item scan_bin
+X<scan_bin>
+
+For backwards compatibility. Use C<grok_bin> instead.
+
+ NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)
+
+=for hackers
+Found in file numeric.c
+
+=item scan_hex
+X<scan_hex>
+
+For backwards compatibility. Use C<grok_hex> instead.
+
+ NV scan_hex(const char* start, STRLEN len, STRLEN* retlen)
+
+=for hackers
+Found in file numeric.c
+
+=item scan_oct
+X<scan_oct>
+
+For backwards compatibility. Use C<grok_oct> instead.
+
+ NV scan_oct(const char* start, STRLEN len, STRLEN* retlen)
+
+=for hackers
+Found in file numeric.c
+
+
+=back
+
+=head1 Optree Manipulation Functions
+
+=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.
+
+Constant subs can be created with C<newCONSTSUB> or as described in
+L<perlsub/"Constant Functions">.
+
+ SV* cv_const_sv(CV* cv)
+
+=for hackers
+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.
+
+ CV* newCONSTSUB(HV* stash, const char* name, SV* sv)
+
+=for hackers
+Found in file op.c
+
+=item newXS
+X<newXS>
+
+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
+
+
+=back
+
+=head1 Pad Data Structures
+
+=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.
+
+ SV* pad_sv(PADOFFSET po)
+
+=for hackers
+Found in file pad.c
+
+
+=back
+
+=head1 Per-Interpreter Variables
+
+=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.
+In a pinch, it can also be used as a symbol table for extensions
+to share data among each other. It is a good idea to use keys
+prefixed by the package name of the extension that owns the data.
+
+ HV* PL_modglobal
+
+=for hackers
+Found in file intrpvar.h
-=item SvLOCK
+=item PL_na
+X<PL_na>
-Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
-has been loaded.
+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
+to either declare a local variable and use that instead or to use the
+C<SvPV_nolen> macro.
- void SvLOCK(SV* sv)
+ STRLEN PL_na
=for hackers
-Found in file sv.h
+Found in file intrpvar.h
-=item SvSETMAGIC
+=item PL_sv_no
+X<PL_sv_no>
-Invokes C<mg_set> on an SV if it has 'set' magic. This macro evaluates its
-argument more than once.
+This is the C<false> SV. See C<PL_sv_yes>. Always refer to this as
+C<&PL_sv_no>.
- void SvSETMAGIC(SV* sv)
+ SV PL_sv_no
=for hackers
-Found in file sv.h
+Found in file intrpvar.h
-=item SvSetMagicSV
+=item PL_sv_undef
+X<PL_sv_undef>
-Like C<SvSetSV>, but does any set magic required afterwards.
+This is the C<undef> SV. Always refer to this as C<&PL_sv_undef>.
- void SvSetMagicSV(SV* dsb, SV* ssv)
+ SV PL_sv_undef
=for hackers
-Found in file sv.h
+Found in file intrpvar.h
-=item SvSetMagicSV_nosteal
+=item PL_sv_yes
+X<PL_sv_yes>
-Like C<SvSetMagicSV>, but does any set magic required afterwards.
+This is the C<true> SV. See C<PL_sv_no>. Always refer to this as
+C<&PL_sv_yes>.
- void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
+ SV PL_sv_yes
=for hackers
-Found in file sv.h
+Found in file intrpvar.h
-=item SvSetSV
-Calls C<sv_setsv> if dsv is not the same as ssv. May evaluate arguments
-more than once.
+=back
- void SvSetSV(SV* dsb, SV* ssv)
+=head1 REGEXP Functions
-=for hackers
-Found in file sv.h
+=over 8
-=item SvSetSV_nosteal
+=item SvRX
+X<SvRX>
-Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
-ssv. May evaluate arguments more than once.
+Convenience macro to get the REGEXP from a SV. This is approximately
+equivalent to the following snippet:
- void SvSetSV_nosteal(SV* dsv, SV* ssv)
+ if (SvMAGICAL(sv))
+ mg_get(sv);
+ if (SvROK(sv) &&
+ (tmpsv = (SV*)SvRV(sv)) &&
+ SvTYPE(tmpsv) == SVt_PVMG &&
+ (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
+ {
+ return (REGEXP *)tmpmg->mg_obj;
+ }
+
+NULL will be returned if a REGEXP* is not found.
+
+ REGEXP * SvRX(SV *sv)
=for hackers
-Found in file sv.h
+Found in file regexp.h
-=item SvSHARE
+=item SvRXOK
+X<SvRXOK>
-Arranges for sv to be shared between threads if a suitable module
-has been loaded.
+Returns a boolean indicating whether the SV contains qr magic
+(PERL_MAGIC_qr).
- void SvSHARE(SV* sv)
+If you want to do something with the REGEXP* later use SvRX instead
+and check for NULL.
+
+ bool SvRXOK(SV* sv)
=for hackers
-Found in file sv.h
+Found in file regexp.h
=back
-=head1 Memory Management
+=head1 Simple Exception Handling Macros
=over 8
-=item Copy
+=item dXCPT
+X<dXCPT>
-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
-the type. May fail on overlapping copies. See also C<Move>.
+Set up necessary local variables for exception handling.
+See L<perlguts/"Exception Handling">.
- void Copy(void* src, void* dest, int nitems, type)
+ dXCPT;
=for hackers
-Found in file handy.h
-
-=item Move
+Found in file XSUB.h
-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
-the type. Can do overlapping moves. See also C<Copy>.
+=item XCPT_CATCH
+X<XCPT_CATCH>
- void Move(void* src, void* dest, int nitems, type)
+Introduces a catch block. See L<perlguts/"Exception Handling">.
=for hackers
-Found in file handy.h
+Found in file XSUB.h
-=item New
+=item XCPT_RETHROW
+X<XCPT_RETHROW>
-The XSUB-writer's interface to the C C<malloc> function.
+Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
- void New(int id, void* ptr, int nitems, type)
+ XCPT_RETHROW;
=for hackers
-Found in file handy.h
+Found in file XSUB.h
-=item Newc
+=item XCPT_TRY_END
+X<XCPT_TRY_END>
-The XSUB-writer's interface to the C C<malloc> function, with
-cast.
+Ends a try block. See L<perlguts/"Exception Handling">.
- void Newc(int id, void* ptr, int nitems, type, cast)
+=for hackers
+Found in file XSUB.h
+
+=item XCPT_TRY_START
+X<XCPT_TRY_START>
+
+Starts a try block. See L<perlguts/"Exception Handling">.
=for hackers
-Found in file handy.h
+Found in file XSUB.h
-=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).
+=back
+
+=head1 Stack Manipulation Macros
+
+=over 8
+
+=item dMARK
+X<dMARK>
+Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
+C<dORIGMARK>.
- SV* NEWSV(int id, STRLEN len)
+ dMARK;
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item Newz
+=item dORIGMARK
+X<dORIGMARK>
-The XSUB-writer's interface to the C C<malloc> function. The allocated
-memory is zeroed with C<memzero>.
+Saves the original stack mark for the XSUB. See C<ORIGMARK>.
- void Newz(int id, void* ptr, int nitems, type)
+ dORIGMARK;
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item Poison
+=item dSP
+X<dSP>
-Fill up memory with a pattern (byte 0xAB over and over again) that
-hopefully catches attempts to access uninitialized memory.
+Declares a local copy of perl's stack pointer for the XSUB, available via
+the C<SP> macro. See C<SP>.
- void Poison(void* dest, int nitems, type)
+ dSP;
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item Renew
+=item EXTEND
+X<EXTEND>
-The XSUB-writer's interface to the C C<realloc> function.
+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
+onto the stack.
- void Renew(void* ptr, int nitems, type)
+ void EXTEND(SP, int nitems)
=for hackers
-Found in file handy.h
-
-=item Renewc
+Found in file pp.h
-The XSUB-writer's interface to the C C<realloc> function, with
-cast.
+=item MARK
+X<MARK>
- void Renewc(void* ptr, int nitems, type, cast)
+Stack marker variable for the XSUB. See C<dMARK>.
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item Safefree
+=item mPUSHi
+X<mPUSHi>
-The XSUB-writer's interface to the C C<free> function.
+Push an integer onto the stack. The stack must have room for this element.
+Does not use C<TARG>. See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
- void Safefree(void* ptr)
+ void mPUSHi(IV iv)
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item savepv
+=item mPUSHn
+X<mPUSHn>
-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
-determined by C<strlen()>. The memory allocated for the new string can
-be freed with the C<Safefree()> function.
+Push a double onto the stack. The stack must have room for this element.
+Does not use C<TARG>. See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
- char* savepv(const char* pv)
+ void mPUSHn(NV nv)
=for hackers
-Found in file util.c
+Found in file pp.h
-=item savepvn
+=item mPUSHp
+X<mPUSHp>
-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.
+Push a string onto the stack. The stack must have room for this element.
+The C<len> indicates the length of the string. Does not use C<TARG>.
+See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
- char* savepvn(const char* pv, I32 len)
+ void mPUSHp(char* str, STRLEN len)
=for hackers
-Found in file util.c
+Found in file pp.h
-=item savesharedpv
+=item mPUSHs
+X<mPUSHs>
-A version of C<savepv()> which allocates the duplicate string in memory
-which is shared between threads.
+Push an SV onto the stack and mortalizes the SV. The stack must have room
+for this element. Does not use C<TARG>. See also C<PUSHs> and C<mXPUSHs>.
- char* savesharedpv(const char* pv)
+ void mPUSHs(SV* sv)
=for hackers
-Found in file util.c
+Found in file pp.h
-=item StructCopy
+=item mPUSHu
+X<mPUSHu>
-This is an architecture-independent macro to copy one structure to another.
+Push an unsigned integer onto the stack. The stack must have room for this
+element. Does not use C<TARG>. See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
- void StructCopy(type src, type dest, type)
+ void mPUSHu(UV uv)
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item Zero
+=item mXPUSHi
+X<mXPUSHi>
-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.
+Push an integer onto the stack, extending the stack if necessary.
+Does not use C<TARG>. See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
- void Zero(void* dest, int nitems, type)
+ void mXPUSHi(IV iv)
=for hackers
-Found in file handy.h
+Found in file pp.h
+=item mXPUSHn
+X<mXPUSHn>
-=back
+Push a double onto the stack, extending the stack if necessary.
+Does not use C<TARG>. See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
-=head1 Miscellaneous Functions
+ void mXPUSHn(NV nv)
-=over 8
+=for hackers
+Found in file pp.h
-=item fbm_compile
+=item mXPUSHp
+X<mXPUSHp>
-Analyses the string in order to make fast searches on it using fbm_instr()
--- the Boyer-Moore algorithm.
+Push a string onto the stack, extending the stack if necessary. The C<len>
+indicates the length of the string. Does not use C<TARG>. See also C<XPUSHp>,
+C<mPUSHp> and C<PUSHp>.
- void fbm_compile(SV* sv, U32 flags)
+ void mXPUSHp(char* str, STRLEN len)
=for hackers
-Found in file util.c
+Found in file pp.h
-=item fbm_instr
+=item mXPUSHs
+X<mXPUSHs>
-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>
-does not have to be fbm_compiled, but the search will not be as fast
-then.
+Push an SV onto the stack, extending the stack if necessary and mortalizes
+the SV. Does not use C<TARG>. See also C<XPUSHs> and C<mPUSHs>.
- char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
+ void mXPUSHs(SV* sv)
=for hackers
-Found in file util.c
+Found in file pp.h
-=item form
+=item mXPUSHu
+X<mXPUSHu>
-Takes a sprintf-style format pattern and conventional
-(non-SV) arguments and returns the formatted string.
+Push an unsigned integer onto the stack, extending the stack if necessary.
+Does not use C<TARG>. See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
- (char *) Perl_form(pTHX_ const char* pat, ...)
+ void mXPUSHu(UV uv)
-can be used any place a string (char *) is required:
+=for hackers
+Found in file pp.h
- char * s = Perl_form("%d.%d",major,minor);
+=item ORIGMARK
+X<ORIGMARK>
-Uses a single private buffer so if you want to format several strings you
-must explicitly copy the earlier strings away (and free the copies when you
-are done).
+The original stack mark for the XSUB. See C<dORIGMARK>.
- char* form(const char* pat, ...)
+=for hackers
+Found in file pp.h
+
+=item POPi
+X<POPi>
+
+Pops an integer off the stack.
+
+ IV POPi
=for hackers
-Found in file util.c
+Found in file pp.h
-=item getcwd_sv
+=item POPl
+X<POPl>
-Fill the sv with current working directory
+Pops a long off the stack.
- int getcwd_sv(SV* sv)
+ long POPl
=for hackers
-Found in file util.c
+Found in file pp.h
-=item strEQ
+=item POPn
+X<POPn>
-Test two strings to see if they are equal. Returns true or false.
+Pops a double off the stack.
- bool strEQ(char* s1, char* s2)
+ NV POPn
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item strGE
+=item POPp
+X<POPp>
-Test two strings to see if the first, C<s1>, is greater than or equal to
-the second, C<s2>. Returns true or false.
+Pops a string off the stack. Deprecated. New code should use POPpx.
- bool strGE(char* s1, char* s2)
+ char* POPp
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item strGT
+=item POPpbytex
+X<POPpbytex>
-Test two strings to see if the first, C<s1>, is greater than the second,
-C<s2>. Returns true or false.
+Pops a string off the stack which must consist of bytes i.e. characters < 256.
- bool strGT(char* s1, char* s2)
+ char* POPpbytex
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item strLE
+=item POPpx
+X<POPpx>
-Test two strings to see if the first, C<s1>, is less than or equal to the
-second, C<s2>. Returns true or false.
+Pops a string off the stack.
- bool strLE(char* s1, char* s2)
+ char* POPpx
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item strLT
+=item POPs
+X<POPs>
-Test two strings to see if the first, C<s1>, is less than the second,
-C<s2>. Returns true or false.
+Pops an SV off the stack.
- bool strLT(char* s1, char* s2)
+ SV* POPs
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item strNE
+=item PUSHi
+X<PUSHi>
-Test two strings to see if they are different. Returns true or
-false.
+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
+called to declare it. Do not call multiple C<TARG>-oriented macros to
+return lists from XSUB's - see C<mPUSHi> instead. See also C<XPUSHi> and
+C<mXPUSHi>.
- bool strNE(char* s1, char* s2)
+ void PUSHi(IV iv)
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item strnEQ
+=item PUSHMARK
+X<PUSHMARK>
-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
-C<strncmp>).
+Opening bracket for arguments on a callback. See C<PUTBACK> and
+L<perlcall>.
- bool strnEQ(char* s1, char* s2, STRLEN len)
+ void PUSHMARK(SP)
=for hackers
-Found in file handy.h
+Found in file pp.h
-=item strnNE
+=item PUSHmortal
+X<PUSHmortal>
-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
-wrapper for C<strncmp>).
+Push a new mortal SV onto the stack. The stack must have room for this
+element. Does not use C<TARG>. See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
- bool strnNE(char* s1, char* s2, STRLEN len)
+ void PUSHmortal()
=for hackers
-Found in file handy.h
+Found in file pp.h
+=item PUSHn
+X<PUSHn>
-=back
+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
+called to declare it. Do not call multiple C<TARG>-oriented macros to
+return lists from XSUB's - see C<mPUSHn> instead. See also C<XPUSHn> and
+C<mXPUSHn>.
-=head1 Numeric functions
+ void PUSHn(NV nv)
-=over 8
+=for hackers
+Found in file pp.h
-=item grok_bin
+=item PUSHp
+X<PUSHp>
-converts a string representing a binary number to numeric form.
+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
+C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it. Do not
+call multiple C<TARG>-oriented macros to return lists from XSUB's - see
+C<mPUSHp> instead. See also C<XPUSHp> and C<mXPUSHp>.
-On entry I<start> and I<*len> give the string to scan, I<*flags> gives
-conversion flags, and I<result> should be NULL or a pointer to an NV.
-The scan stops at the end of the string, or the first invalid character.
-On return I<*len> is set to the length scanned string, and I<*flags> gives
-output flags.
+ void PUSHp(char* str, STRLEN len)
-If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
-and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
-returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
-and writes the value to I<*result> (or the value is discarded if I<result>
-is NULL).
+=for hackers
+Found in file pp.h
-The hex number may optionally be prefixed with "0b" or "b" unless
-C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
-C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
-number may use '_' characters to separate digits.
+=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>,
+C<XPUSHs> and C<XPUSHmortal>.
- UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
+ void PUSHs(SV* sv)
=for hackers
-Found in file numeric.c
+Found in file pp.h
-=item grok_hex
+=item PUSHu
+X<PUSHu>
-converts a string representing a hex number to numeric form.
+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>
+should be called to declare it. Do not call multiple C<TARG>-oriented
+macros to return lists from XSUB's - see C<mPUSHu> instead. See also
+C<XPUSHu> and C<mXPUSHu>.
-On entry I<start> and I<*len> give the string to scan, I<*flags> gives
-conversion flags, and I<result> should be NULL or a pointer to an NV.
-The scan stops at the end of the string, or the first non-hex-digit character.
-On return I<*len> is set to the length scanned string, and I<*flags> gives
-output flags.
+ void PUSHu(UV uv)
-If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
-and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
-returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
-and writes the value to I<*result> (or the value is discarded if I<result>
-is NULL).
+=for hackers
+Found in file pp.h
-The hex number may optionally be prefixed with "0x" or "x" unless
-C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
-C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
-number may use '_' characters to separate digits.
+=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.
- UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
+ PUTBACK;
=for hackers
-Found in file numeric.c
+Found in file pp.h
-=item grok_number
+=item SP
+X<SP>
-Recognise (or not) a number. The type of the number is returned
-(0 if unrecognised), otherwise it is a bit-ORed combination of
-IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
-IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
+Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
+C<SPAGAIN>.
-If the value of the number can fit an in UV, it is returned in the *valuep
-IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
-will never be set unless *valuep is valid, but *valuep may have been assigned
-to during processing even though IS_NUMBER_IN_UV is not set on return.
-If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
-valuep is non-NULL, but no actual assignment (or SEGV) will occur.
+=for hackers
+Found in file pp.h
-IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
-seen (in which case *valuep gives the true value truncated to an integer), and
-IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
-absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
-number is larger than a UV.
+=item SPAGAIN
+X<SPAGAIN>
- int grok_number(const char *pv, STRLEN len, UV *valuep)
+Refetch the stack pointer. Used after a callback. See L<perlcall>.
+
+ SPAGAIN;
=for hackers
-Found in file numeric.c
+Found in file pp.h
-=item grok_numeric_radix
+=item XPUSHi
+X<XPUSHi>
-Scan and skip for a numeric decimal separator (radix).
+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
+declare it. Do not call multiple C<TARG>-oriented macros to return lists
+from XSUB's - see C<mXPUSHi> instead. See also C<PUSHi> and C<mPUSHi>.
- bool grok_numeric_radix(const char **sp, const char *send)
+ void XPUSHi(IV iv)
=for hackers
-Found in file numeric.c
+Found in file pp.h
-=item grok_oct
+=item XPUSHmortal
+X<XPUSHmortal>
+Push a new mortal SV onto the stack, extending the stack if necessary.
+Does not use C<TARG>. See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
- UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
+ void XPUSHmortal()
=for hackers
-Found in file numeric.c
+Found in file pp.h
-=item scan_bin
+=item XPUSHn
+X<XPUSHn>
-For backwards compatibility. Use C<grok_bin> instead.
+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
+declare it. Do not call multiple C<TARG>-oriented macros to return lists
+from XSUB's - see C<mXPUSHn> instead. See also C<PUSHn> and C<mPUSHn>.
- NV scan_bin(char* start, STRLEN len, STRLEN* retlen)
+ void XPUSHn(NV nv)
=for hackers
-Found in file numeric.c
+Found in file pp.h
-=item scan_hex
+=item XPUSHp
+X<XPUSHp>
-For backwards compatibility. Use C<grok_hex> instead.
+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
+C<dTARGET> or C<dXSTARG> should be called to declare it. Do not call
+multiple C<TARG>-oriented macros to return lists from XSUB's - see
+C<mXPUSHp> instead. See also C<PUSHp> and C<mPUSHp>.
- NV scan_hex(char* start, STRLEN len, STRLEN* retlen)
+ void XPUSHp(char* str, STRLEN len)
=for hackers
-Found in file numeric.c
+Found in file pp.h
-=item scan_oct
+=item XPUSHs
+X<XPUSHs>
-For backwards compatibility. Use C<grok_oct> instead.
+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>,
+C<PUSHs> and C<PUSHmortal>.
- NV scan_oct(char* start, STRLEN len, STRLEN* retlen)
+ void XPUSHs(SV* sv)
=for hackers
-Found in file numeric.c
-
+Found in file pp.h
-=back
+=item XPUSHu
+X<XPUSHu>
-=head1 Optree Manipulation Functions
+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
+called to declare it. Do not call multiple C<TARG>-oriented macros to
+return lists from XSUB's - see C<mXPUSHu> instead. See also C<PUSHu> and
+C<mPUSHu>.
-=over 8
+ void XPUSHu(UV uv)
-=item cv_const_sv
+=for hackers
+Found in file pp.h
-If C<cv> is a constant sub eligible for inlining. returns the constant
-value returned by the sub. Otherwise, returns NULL.
+=item XSRETURN
+X<XSRETURN>
-Constant subs can be created with C<newCONSTSUB> or as described in
-L<perlsub/"Constant Functions">.
+Return from XSUB, indicating number of items on the stack. This is usually
+handled by C<xsubpp>.
- SV* cv_const_sv(CV* cv)
+ void XSRETURN(int nitems)
=for hackers
-Found in file op.c
+Found in file XSUB.h
-=item newCONSTSUB
+=item XSRETURN_EMPTY
+X<XSRETURN_EMPTY>
-Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
-eligible for inlining at compile-time.
+Return an empty list from an XSUB immediately.
- CV* newCONSTSUB(HV* stash, char* name, SV* sv)
+ XSRETURN_EMPTY;
=for hackers
-Found in file op.c
+Found in file XSUB.h
-=item newXS
+=item XSRETURN_IV
+X<XSRETURN_IV>
+
+Return an integer from an XSUB immediately. Uses C<XST_mIV>.
-Used by C<xsubpp> to hook up XSUBs as Perl subs.
+ void XSRETURN_IV(IV iv)
=for hackers
-Found in file op.c
+Found in file XSUB.h
+=item XSRETURN_NO
+X<XSRETURN_NO>
-=back
+Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
-=head1 Pad Data Structures
+ XSRETURN_NO;
-=over 8
+=for hackers
+Found in file XSUB.h
-=item pad_sv
+=item XSRETURN_NV
+X<XSRETURN_NV>
-Get the value at offset po in the current pad.
-Use macro PAD_SV instead of calling this function directly.
+Return a double from an XSUB immediately. Uses C<XST_mNV>.
- SV* pad_sv(PADOFFSET po)
+ void XSRETURN_NV(NV nv)
=for hackers
-Found in file pad.c
+Found in file XSUB.h
+=item XSRETURN_PV
+X<XSRETURN_PV>
-=back
+Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
-=head1 Stack Manipulation Macros
+ void XSRETURN_PV(char* str)
-=over 8
+=for hackers
+Found in file XSUB.h
-=item dMARK
+=item XSRETURN_UNDEF
+X<XSRETURN_UNDEF>
-Declare a stack marker variable, C<mark>, for the XSUB. See C<MARK> and
-C<dORIGMARK>.
+Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
- dMARK;
+ XSRETURN_UNDEF;
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item dORIGMARK
+=item XSRETURN_UV
+X<XSRETURN_UV>
-Saves the original stack mark for the XSUB. See C<ORIGMARK>.
+Return an integer from an XSUB immediately. Uses C<XST_mUV>.
- dORIGMARK;
+ void XSRETURN_UV(IV uv)
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item dSP
+=item XSRETURN_YES
+X<XSRETURN_YES>
-Declares a local copy of perl's stack pointer for the XSUB, available via
-the C<SP> macro. See C<SP>.
+Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
- dSP;
+ XSRETURN_YES;
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item EXTEND
+=item XST_mIV
+X<XST_mIV>
-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
-onto the stack.
+Place an integer into the specified position C<pos> on the stack. The
+value is stored in a new mortal SV.
- void EXTEND(SP, int nitems)
+ void XST_mIV(int pos, IV iv)
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item MARK
+=item XST_mNO
+X<XST_mNO>
-Stack marker variable for the XSUB. See C<dMARK>.
+Place C<&PL_sv_no> into the specified position C<pos> on the
+stack.
+
+ void XST_mNO(int pos)
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item ORIGMARK
+=item XST_mNV
+X<XST_mNV>
-The original stack mark for the XSUB. See C<dORIGMARK>.
+Place a double into the specified position C<pos> on the stack. The value
+is stored in a new mortal SV.
+
+ void XST_mNV(int pos, NV nv)
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item POPi
+=item XST_mPV
+X<XST_mPV>
-Pops an integer off the stack.
+Place a copy of a string into the specified position C<pos> on the stack.
+The value is stored in a new mortal SV.
- IV POPi
+ void XST_mPV(int pos, char* str)
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item POPl
+=item XST_mUNDEF
+X<XST_mUNDEF>
-Pops a long off the stack.
+Place C<&PL_sv_undef> into the specified position C<pos> on the
+stack.
- long POPl
+ void XST_mUNDEF(int pos)
=for hackers
-Found in file pp.h
+Found in file XSUB.h
-=item POPn
+=item XST_mYES
+X<XST_mYES>
-Pops a double off the stack.
+Place C<&PL_sv_yes> into the specified position C<pos> on the
+stack.
- NV POPn
+ void XST_mYES(int pos)
=for hackers
-Found in file pp.h
-
-=item POPp
+Found in file XSUB.h
-Pops a string off the stack. Deprecated. New code should provide
-a STRLEN n_a and use POPpx.
- char* POPp
+=back
-=for hackers
-Found in file pp.h
+=head1 SV Flags
-=item POPpbytex
+=over 8
-Pops a string off the stack which must consist of bytes i.e. characters < 256.
-Requires a variable STRLEN n_a in scope.
+=item svtype
+X<svtype>
- char* POPpbytex
+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.
=for hackers
-Found in file pp.h
-
-=item POPpx
+Found in file sv.h
-Pops a string off the stack.
-Requires a variable STRLEN n_a in scope.
+=item SVt_IV
+X<SVt_IV>
- char* POPpx
+Integer type flag for scalars. See C<svtype>.
=for hackers
-Found in file pp.h
-
-=item POPs
+Found in file sv.h
-Pops an SV off the stack.
+=item SVt_NV
+X<SVt_NV>
- SV* POPs
+Double type flag for scalars. See C<svtype>.
=for hackers
-Found in file pp.h
-
-=item PUSHi
+Found in file sv.h
-Push an integer onto the stack. The stack must have room for this element.
-Handles 'set' magic. See C<XPUSHi>.
+=item SVt_PV
+X<SVt_PV>
- void PUSHi(IV iv)
+Pointer type flag for scalars. See C<svtype>.
=for hackers
-Found in file pp.h
-
-=item PUSHMARK
+Found in file sv.h
-Opening bracket for arguments on a callback. See C<PUTBACK> and
-L<perlcall>.
+=item SVt_PVAV
+X<SVt_PVAV>
- PUSHMARK;
+Type flag for arrays. See C<svtype>.
=for hackers
-Found in file pp.h
-
-=item PUSHn
+Found in file sv.h
-Push a double onto the stack. The stack must have room for this element.
-Handles 'set' magic. See C<XPUSHn>.
+=item SVt_PVCV
+X<SVt_PVCV>
- void PUSHn(NV nv)
+Type flag for code refs. See C<svtype>.
=for hackers
-Found in file pp.h
-
-=item PUSHp
+Found in file sv.h
-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. See
-C<XPUSHp>.
+=item SVt_PVHV
+X<SVt_PVHV>
- void PUSHp(char* str, STRLEN len)
+Type flag for hashes. See C<svtype>.
=for hackers
-Found in file pp.h
-
-=item PUSHs
+Found in file sv.h
-Push an SV onto the stack. The stack must have room for this element.
-Does not handle 'set' magic. See C<XPUSHs>.
+=item SVt_PVMG
+X<SVt_PVMG>
- void PUSHs(SV* sv)
+Type flag for blessed scalars. See C<svtype>.
=for hackers
-Found in file pp.h
+Found in file sv.h
-=item PUSHu
-Push an unsigned integer onto the stack. The stack must have room for this
-element. See C<XPUSHu>.
+=back
- void PUSHu(UV uv)
+=head1 SV Manipulation Functions
-=for hackers
-Found in file pp.h
+=over 8
-=item PUTBACK
+=item croak_xs_usage
+X<croak_xs_usage>
-Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
-See C<PUSHMARK> and L<perlcall> for other uses.
+A specialised variant of C<croak()> for emitting the usage message for xsubs
- PUTBACK;
+ croak_xs_usage(cv, "eee_yow");
-=for hackers
-Found in file pp.h
+works out the package name and subroutine name from C<cv>, and then calls
+C<croak()>. Hence if C<cv> is C<&ouch::awk>, it would call C<croak> as:
-=item SP
+ Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
-Stack pointer. This is usually handled by C<xsubpp>. See C<dSP> and
-C<SPAGAIN>.
+ void croak_xs_usage(const CV *const cv, const char *const params)
=for hackers
-Found in file pp.h
+Found in file universal.c
-=item SPAGAIN
+=item get_sv
+X<get_sv>
-Refetch the stack pointer. Used after a callback. See L<perlcall>.
+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
+set and the variable does not exist then NULL is returned.
- SPAGAIN;
+NOTE: the perl_ form of this function is deprecated.
+
+ SV* get_sv(const char* name, I32 create)
=for hackers
-Found in file pp.h
+Found in file perl.c
-=item XPUSHi
+=item newRV_inc
+X<newRV_inc>
-Push an integer onto the stack, extending the stack if necessary. Handles
-'set' magic. See C<PUSHi>.
+Creates an RV wrapper for an SV. The reference count for the original SV is
+incremented.
- void XPUSHi(IV iv)
+ SV* newRV_inc(SV* sv)
=for hackers
-Found in file pp.h
+Found in file sv.h
-=item XPUSHn
+=item newSVpvn_utf8
+X<newSVpvn_utf8>
-Push a double onto the stack, extending the stack if necessary. Handles
-'set' magic. See C<PUSHn>.
+Creates a new SV and copies a string into it. If utf8 is true, calls
+C<SvUTF8_on> on the new SV. Implemented as a wrapper around C<newSVpvn_flags>.
- void XPUSHn(NV nv)
+ SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
=for hackers
-Found in file pp.h
+Found in file sv.h
-=item XPUSHp
+=item SvCUR
+X<SvCUR>
-Push a string onto the stack, extending the stack if necessary. The C<len>
-indicates the length of the string. Handles 'set' magic. See
-C<PUSHp>.
+Returns the length of the string which is in the SV. See C<SvLEN>.
- void XPUSHp(char* str, STRLEN len)
+ STRLEN SvCUR(SV* sv)
=for hackers
-Found in file pp.h
+Found in file sv.h
-=item XPUSHs
+=item SvCUR_set
+X<SvCUR_set>
-Push an SV onto the stack, extending the stack if necessary. Does not
-handle 'set' magic. See C<PUSHs>.
+Set the current length of the string which is in the SV. See C<SvCUR>
+and C<SvIV_set>.
- void XPUSHs(SV* sv)
+ void SvCUR_set(SV* sv, STRLEN len)
=for hackers
-Found in file pp.h
+Found in file sv.h
-=item XPUSHu
+=item SvEND
+X<SvEND>
-Push an unsigned integer onto the stack, extending the stack if necessary.
-See C<PUSHu>.
+Returns a pointer to the last character in the string which is in the SV.
+See C<SvCUR>. Access the character as *(SvEND(sv)).
- void XPUSHu(UV uv)
+ char* SvEND(SV* sv)
=for hackers
-Found in file pp.h
+Found in file sv.h
-=item XSRETURN
+=item SvGAMAGIC
+X<SvGAMAGIC>
-Return from XSUB, indicating number of items on the stack. This is usually
-handled by C<xsubpp>.
+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.
- void XSRETURN(int nitems)
+ char* SvGAMAGIC(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XSRETURN_IV
+=item SvGROW
+X<SvGROW>
-Return an integer from an XSUB immediately. Uses C<XST_mIV>.
+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
+NUL character). Calls C<sv_grow> to perform the expansion if necessary.
+Returns a pointer to the character buffer.
- void XSRETURN_IV(IV iv)
+ char * SvGROW(SV* sv, STRLEN len)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XSRETURN_NO
+=item SvIOK
+X<SvIOK>
-Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
+Returns a U32 value indicating whether the SV contains an integer.
- XSRETURN_NO;
+ U32 SvIOK(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XSRETURN_NV
+=item SvIOKp
+X<SvIOKp>
-Return a double from an XSUB immediately. Uses C<XST_mNV>.
+Returns a U32 value indicating whether the SV contains an integer. Checks
+the B<private> setting. Use C<SvIOK>.
- void XSRETURN_NV(NV nv)
+ U32 SvIOKp(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XSRETURN_PV
+=item SvIOK_notUV
+X<SvIOK_notUV>
-Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
+Returns a boolean indicating whether the SV contains a signed integer.
- void XSRETURN_PV(char* str)
+ bool SvIOK_notUV(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XSRETURN_UNDEF
+=item SvIOK_off
+X<SvIOK_off>
-Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
+Unsets the IV status of an SV.
- XSRETURN_UNDEF;
+ void SvIOK_off(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XSRETURN_YES
+=item SvIOK_on
+X<SvIOK_on>
-Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
+Tells an SV that it is an integer.
- XSRETURN_YES;
+ void SvIOK_on(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XST_mIV
+=item SvIOK_only
+X<SvIOK_only>
-Place an integer into the specified position C<pos> on the stack. The
-value is stored in a new mortal SV.
+Tells an SV that it is an integer and disables all other OK bits.
- void XST_mIV(int pos, IV iv)
+ void SvIOK_only(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XST_mNO
+=item SvIOK_only_UV
+X<SvIOK_only_UV>
-Place C<&PL_sv_no> into the specified position C<pos> on the
-stack.
+Tells and SV that it is an unsigned integer and disables all other OK bits.
- void XST_mNO(int pos)
+ void SvIOK_only_UV(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XST_mNV
+=item SvIOK_UV
+X<SvIOK_UV>
-Place a double into the specified position C<pos> on the stack. The value
-is stored in a new mortal SV.
+Returns a boolean indicating whether the SV contains an unsigned integer.
- void XST_mNV(int pos, NV nv)
+ bool SvIOK_UV(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XST_mPV
+=item SvIsCOW
+X<SvIsCOW>
-Place a copy of a string into the specified position C<pos> on the stack.
-The value is stored in a new mortal SV.
+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
+COW)
- void XST_mPV(int pos, char* str)
+ bool SvIsCOW(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XST_mUNDEF
+=item SvIsCOW_shared_hash
+X<SvIsCOW_shared_hash>
-Place C<&PL_sv_undef> into the specified position C<pos> on the
-stack.
+Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
+scalar.
- void XST_mUNDEF(int pos)
+ bool SvIsCOW_shared_hash(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
-=item XST_mYES
+=item SvIV
+X<SvIV>
-Place C<&PL_sv_yes> into the specified position C<pos> on the
-stack.
+Coerces the given SV to an integer and returns it. See C<SvIVx> for a
+version which guarantees to evaluate sv only once.
- void XST_mYES(int pos)
+ IV SvIV(SV* sv)
=for hackers
-Found in file XSUB.h
+Found in file sv.h
+=item SvIVX
+X<SvIVX>
-=back
+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()>.
-=head1 SV Flags
+ IV SvIVX(SV* sv)
-=over 8
+=for hackers
+Found in file sv.h
-=item svtype
+=item SvIVx
+X<SvIVx>
-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.
+Coerces the given SV to an integer and returns it. Guarantees to evaluate
+C<sv> only once. Only use this if C<sv> is an expression with side effects,
+otherwise use the more efficient C<SvIV>.
+
+ IV SvIVx(SV* sv)
=for hackers
Found in file sv.h
-=item SVt_IV
+=item SvIV_nomg
+X<SvIV_nomg>
-Integer type flag for scalars. See C<svtype>.
+Like C<SvIV> but doesn't process magic.
+
+ IV SvIV_nomg(SV* sv)
=for hackers
Found in file sv.h
-=item SVt_NV
+=item SvIV_set
+X<SvIV_set>
-Double type flag for scalars. See C<svtype>.
+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)
=for hackers
Found in file sv.h
-=item SVt_PV
+=item SvLEN
+X<SvLEN>
-Pointer type flag for scalars. See C<svtype>.
+Returns the size of the string buffer in the SV, not including any part
+attributable to C<SvOOK>. See C<SvCUR>.
+
+ STRLEN SvLEN(SV* sv)
=for hackers
Found in file sv.h
-=item SVt_PVAV
+=item SvLEN_set
+X<SvLEN_set>
-Type flag for arrays. See C<svtype>.
+Set the actual length of the string which is in the SV. See C<SvIV_set>.
+
+ void SvLEN_set(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SVt_PVCV
+=item SvMAGIC_set
+X<SvMAGIC_set>
-Type flag for code refs. See C<svtype>.
+Set the value of the MAGIC pointer in sv to val. See C<SvIV_set>.
+
+ void SvMAGIC_set(SV* sv, MAGIC* val)
=for hackers
Found in file sv.h
-=item SVt_PVHV
+=item SvNIOK
+X<SvNIOK>
-Type flag for hashes. See C<svtype>.
+Returns a U32 value indicating whether the SV contains a number, integer or
+double.
+
+ U32 SvNIOK(SV* sv)
=for hackers
Found in file sv.h
-=item SVt_PVMG
+=item SvNIOKp
+X<SvNIOKp>
-Type flag for blessed scalars. See C<svtype>.
+Returns a U32 value indicating whether the SV contains a number, integer or
+double. Checks the B<private> setting. Use C<SvNIOK>.
+
+ U32 SvNIOKp(SV* sv)
=for hackers
Found in file sv.h
+=item SvNIOK_off
+X<SvNIOK_off>
-=back
-
-=head1 SV Manipulation Functions
+Unsets the NV/IV status of an SV.
-=over 8
+ void SvNIOK_off(SV* sv)
-=item get_sv
+=for hackers
+Found in file sv.h
-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
-set and the variable does not exist then NULL is returned.
+=item SvNOK
+X<SvNOK>
-NOTE: the perl_ form of this function is deprecated.
+Returns a U32 value indicating whether the SV contains a double.
- SV* get_sv(const char* name, I32 create)
+ U32 SvNOK(SV* sv)
=for hackers
-Found in file perl.c
+Found in file sv.h
-=item looks_like_number
+=item SvNOKp
+X<SvNOKp>
-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.
+Returns a U32 value indicating whether the SV contains a double. Checks the
+B<private> setting. Use C<SvNOK>.
- I32 looks_like_number(SV* sv)
+ U32 SvNOKp(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newRV_inc
+=item SvNOK_off
+X<SvNOK_off>
-Creates an RV wrapper for an SV. The reference count for the original SV is
-incremented.
+Unsets the NV status of an SV.
- SV* newRV_inc(SV* sv)
+ void SvNOK_off(SV* sv)
=for hackers
Found in file sv.h
-=item newRV_noinc
+=item SvNOK_on
+X<SvNOK_on>
-Creates an RV wrapper for an SV. The reference count for the original
-SV is B<not> incremented.
+Tells an SV that it is a double.
- SV* newRV_noinc(SV *sv)
+ void SvNOK_on(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSV
+=item SvNOK_only
+X<SvNOK_only>
-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.
+Tells an SV that it is a double and disables all other OK bits.
- SV* newSV(STRLEN len)
+ void SvNOK_only(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSViv
+=item SvNV
+X<SvNV>
-Creates a new SV and copies an integer into it. The reference count for the
-SV is set to 1.
+Coerce the given SV to a double and return it. See C<SvNVx> for a version
+which guarantees to evaluate sv only once.
- SV* newSViv(IV i)
+ NV SvNV(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVnv
+=item SvNVX
+X<SvNVX>
-Creates a new SV and copies a floating point value into it.
-The reference count for the SV is set to 1.
+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()>.
- SV* newSVnv(NV n)
+ NV SvNVX(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVpv
+=item SvNVx
+X<SvNVx>
-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.
+Coerces the given SV to a double and returns it. Guarantees to evaluate
+C<sv> only once. Only use this if C<sv> is an expression with side effects,
+otherwise use the more efficient C<SvNV>.
- SV* newSVpv(const char* s, STRLEN len)
+ NV SvNVx(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVpvf
+=item SvNV_set
+X<SvNV_set>
-Creates a new SV and initializes it with the string formatted like
-C<sprintf>.
+Set the value of the NV pointer in sv to val. See C<SvIV_set>.
- SV* newSVpvf(const char* pat, ...)
+ void SvNV_set(SV* sv, NV val)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVpvn
+=item SvOK
+X<SvOK>
-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.
+Returns a U32 value indicating whether the value is an SV. It also tells
+whether the value is defined or not.
- SV* newSVpvn(const char* s, STRLEN len)
+ U32 SvOK(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVpvn_share
+=item SvOOK
+X<SvOOK>
-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.
+Returns a U32 indicating whether the pointer to the string buffer is offset.
+This hack is used internally to speed up removal of characters from the
+beginning of a SvPV. When SvOOK is true, then the start of the
+allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
+This offset used to be stored in SvIVX, but is now stored within the spare
+part of the buffer.
- SV* newSVpvn_share(const char* s, I32 len, U32 hash)
+ U32 SvOOK(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVrv
+=item SvOOK_offset
+X<SvOOK_offset>
-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.
+Reads into I<len> the offset from SvPVX back to the true start of the
+allocated buffer, which will be non-zero if C<sv_chop> has been used to
+efficiently remove characters from start of the buffer. Implemented as a
+macro, which takes the address of I<len>, which must be of type C<STRLEN>.
+Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
- SV* newSVrv(SV* rv, const char* classname)
+ void SvOOK_offset(NN SV*sv, STRLEN len)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVsv
+=item SvPOK
+X<SvPOK>
-Creates a new SV which is an exact duplicate of the original SV.
-(Uses C<sv_setsv>).
+Returns a U32 value indicating whether the SV contains a character
+string.
- SV* newSVsv(SV* old)
+ U32 SvPOK(SV* sv)
=for hackers
-Found in file sv.c
+Found in file sv.h
-=item newSVuv
+=item SvPOKp
+X<SvPOKp>
-Creates a new SV and copies an unsigned integer into it.
-The reference count for the SV is set to 1.
+Returns a U32 value indicating whether the SV contains a character string.
+Checks the B<private> setting. Use C<SvPOK>.
- SV* newSVuv(UV u)
+ U32 SvPOKp(SV* sv)
=for hackers
-Found in file sv.c
-
-=item new_version
-
-Returns a new version object based on the passed in SV:
+Found in file sv.h
- SV *sv = new_version(SV *ver);
+=item SvPOK_off
+X<SvPOK_off>
-Does not alter the passed in ver SV. See "upg_version" if you
-want to upgrade the SV.
+Unsets the PV status of an SV.
- SV* new_version(SV *ver)
+ void SvPOK_off(SV* sv)
=for hackers
-Found in file util.c
+Found in file sv.h
-=item scan_version
+=item SvPOK_on
+X<SvPOK_on>
-Returns a pointer to the next character after the parsed
-version string, as well as upgrading the passed in SV to
-an RV.
+Tells an SV that it is a string.
-Function must be called with an already existing SV like
+ void SvPOK_on(SV* sv)
- sv = NEWSV(92,0);
- s = scan_version(s,sv);
+=for hackers
+Found in file sv.h
-Performs some preprocessing to the string to ensure that
-it has the correct characteristics of a version. Flags the
-object if it contains an underscore (which denotes this
-is a beta version).
+=item SvPOK_only
+X<SvPOK_only>
- char* scan_version(char *vstr, SV *sv)
+Tells an SV that it is a string and disables all other OK bits.
+Will also turn off the UTF-8 status.
+
+ void SvPOK_only(SV* sv)
=for hackers
-Found in file util.c
+Found in file sv.h
-=item scan_vstring
+=item SvPOK_only_UTF8
+X<SvPOK_only_UTF8>
-Returns a pointer to the next character after the parsed
-vstring, as well as updating the passed in sv.
+Tells an SV that it is a string and disables all other OK bits,
+and leaves the UTF-8 status as it was.
-Function must be called like
+ void SvPOK_only_UTF8(SV* sv)
+
+=for hackers
+Found in file sv.h
- sv = NEWSV(92,5);
- s = scan_vstring(s,sv);
+=item SvPV
+X<SvPV>
-The sv should already be large enough to store the vstring
-passed in, for performance reasons.
+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
+stringified version becoming C<SvPOK>. Handles 'get' magic. See also
+C<SvPVx> for a version which guarantees to evaluate sv only once.
- char* scan_vstring(char *vstr, SV *sv)
+ char* SvPV(SV* sv, STRLEN len)
=for hackers
-Found in file util.c
+Found in file sv.h
-=item SvCUR
+=item SvPVbyte
+X<SvPVbyte>
-Returns the length of the string which is in the SV. See C<SvLEN>.
+Like C<SvPV>, but converts sv to byte representation first if necessary.
- STRLEN SvCUR(SV* sv)
+ char* SvPVbyte(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvCUR_set
+=item SvPVbytex
+X<SvPVbytex>
-Set the length of the string which is in the SV. See C<SvCUR>.
+Like C<SvPV>, but converts sv to byte representation first if necessary.
+Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
+otherwise.
- void SvCUR_set(SV* sv, STRLEN len)
+ char* SvPVbytex(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvEND
+=item SvPVbytex_force
+X<SvPVbytex_force>
-Returns a pointer to the last character in the string which is in the SV.
-See C<SvCUR>. Access the character as *(SvEND(sv)).
+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>
+otherwise.
- char* SvEND(SV* sv)
+ char* SvPVbytex_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvGROW
+=item SvPVbyte_force
+X<SvPVbyte_force>
-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
-NUL character). Calls C<sv_grow> to perform the expansion if necessary.
-Returns a pointer to the character buffer.
+Like C<SvPV_force>, but converts sv to byte representation first if necessary.
- char * SvGROW(SV* sv, STRLEN len)
+ char* SvPVbyte_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIOK
+=item SvPVbyte_nolen
+X<SvPVbyte_nolen>
-Returns a boolean indicating whether the SV contains an integer.
+Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
- bool SvIOK(SV* sv)
+ char* SvPVbyte_nolen(SV* sv)
=for hackers
Found in file sv.h
-=item SvIOKp
+=item SvPVutf8
+X<SvPVutf8>
-Returns a boolean indicating whether the SV contains an integer. Checks
-the B<private> setting. Use C<SvIOK>.
+Like C<SvPV>, but converts sv to utf8 first if necessary.
- bool SvIOKp(SV* sv)
+ char* SvPVutf8(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIOK_notUV
+=item SvPVutf8x
+X<SvPVutf8x>
-Returns a boolean indicating whether the SV contains a signed integer.
+Like C<SvPV>, but converts sv to utf8 first if necessary.
+Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
+otherwise.
- void SvIOK_notUV(SV* sv)
+ char* SvPVutf8x(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIOK_off
+=item SvPVutf8x_force
+X<SvPVutf8x_force>
-Unsets the IV status of an SV.
+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>
+otherwise.
- void SvIOK_off(SV* sv)
+ char* SvPVutf8x_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIOK_on
+=item SvPVutf8_force
+X<SvPVutf8_force>
-Tells an SV that it is an integer.
+Like C<SvPV_force>, but converts sv to utf8 first if necessary.
- void SvIOK_on(SV* sv)
+ char* SvPVutf8_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIOK_only
+=item SvPVutf8_nolen
+X<SvPVutf8_nolen>
-Tells an SV that it is an integer and disables all other OK bits.
+Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
- void SvIOK_only(SV* sv)
+ char* SvPVutf8_nolen(SV* sv)
=for hackers
Found in file sv.h
-=item SvIOK_only_UV
+=item SvPVX
+X<SvPVX>
-Tells and SV that it is an unsigned integer and disables all other OK bits.
+Returns a pointer to the physical string in the SV. The SV must contain a
+string.
- void SvIOK_only_UV(SV* sv)
+ char* SvPVX(SV* sv)
=for hackers
Found in file sv.h
-=item SvIOK_UV
+=item SvPVx
+X<SvPVx>
-Returns a boolean indicating whether the SV contains an unsigned integer.
+A version of C<SvPV> which guarantees to evaluate C<sv> only once.
+Only use this if C<sv> is an expression with side effects, otherwise use the
+more efficient C<SvPVX>.
- void SvIOK_UV(SV* sv)
+ char* SvPVx(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIV
+=item SvPV_force
+X<SvPV_force>
-Coerces the given SV to an integer and returns it. See C<SvIVx> for a
-version which guarantees to evaluate sv only once.
+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>
+directly.
- IV SvIV(SV* sv)
+ char* SvPV_force(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIVx
+=item SvPV_force_nomg
+X<SvPV_force_nomg>
-Coerces the given SV to an integer and returns it. Guarantees to evaluate
-sv only once. Use the more efficient C<SvIV> otherwise.
+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>
+directly. Doesn't process magic.
- IV SvIVx(SV* sv)
+ char* SvPV_force_nomg(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvIVX
+=item SvPV_nolen
+X<SvPV_nolen>
-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()>.
+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
+stringified form becoming C<SvPOK>. Handles 'get' magic.
- IV SvIVX(SV* sv)
+ char* SvPV_nolen(SV* sv)
=for hackers
Found in file sv.h
-=item SvLEN
+=item SvPV_nomg
+X<SvPV_nomg>
-Returns the size of the string buffer in the SV, not including any part
-attributable to C<SvOOK>. See C<SvCUR>.
+Like C<SvPV> but doesn't process magic.
- STRLEN SvLEN(SV* sv)
+ char* SvPV_nomg(SV* sv, STRLEN len)
=for hackers
Found in file sv.h
-=item SvNIOK
+=item SvPV_set
+X<SvPV_set>
-Returns a boolean indicating whether the SV contains a number, integer or
-double.
+Set the value of the PV pointer in sv to val. See C<SvIV_set>.
- bool SvNIOK(SV* sv)
+ void SvPV_set(SV* sv, char* val)
=for hackers
Found in file sv.h
-=item SvNIOKp
+=item SvREFCNT
+X<SvREFCNT>
-Returns a boolean indicating whether the SV contains a number, integer or
-double. Checks the B<private> setting. Use C<SvNIOK>.
+Returns the value of the object's reference count.
- bool SvNIOKp(SV* sv)
+ U32 SvREFCNT(SV* sv)
=for hackers
Found in file sv.h
-=item SvNIOK_off
+=item SvREFCNT_dec
+X<SvREFCNT_dec>
-Unsets the NV/IV status of an SV.
+Decrements the reference count of the given SV.
- void SvNIOK_off(SV* sv)
+ void SvREFCNT_dec(SV* sv)
=for hackers
Found in file sv.h
-=item SvNOK
+=item SvREFCNT_inc
+X<SvREFCNT_inc>
+
+Increments the reference count of the given SV.
-Returns a boolean indicating whether the SV contains a double.
+All of the following SvREFCNT_inc* macros are optimized versions of
+SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
- bool SvNOK(SV* sv)
+ SV* SvREFCNT_inc(SV* sv)
=for hackers
Found in file sv.h
-=item SvNOKp
+=item SvREFCNT_inc_NN
+X<SvREFCNT_inc_NN>
-Returns a boolean indicating whether the SV contains a double. Checks the
-B<private> setting. Use C<SvNOK>.
+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.
- bool SvNOKp(SV* sv)
+ SV* SvREFCNT_inc_NN(SV* sv)
=for hackers
Found in file sv.h
-=item SvNOK_off
+=item SvREFCNT_inc_simple
+X<SvREFCNT_inc_simple>
-Unsets the NV status of an SV.
+Same as SvREFCNT_inc, but can only be used with expressions without side
+effects. Since we don't have to store a temporary value, it's faster.
- void SvNOK_off(SV* sv)
+ SV* SvREFCNT_inc_simple(SV* sv)
=for hackers
Found in file sv.h
-=item SvNOK_on
+=item SvREFCNT_inc_simple_NN
+X<SvREFCNT_inc_simple_NN>
-Tells an SV that it is a double.
+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.
- void SvNOK_on(SV* sv)
+ SV* SvREFCNT_inc_simple_NN(SV* sv)
=for hackers
Found in file sv.h
-=item SvNOK_only
+=item SvREFCNT_inc_simple_void
+X<SvREFCNT_inc_simple_void>
-Tells an SV that it is a double and disables all other OK bits.
+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.
- void SvNOK_only(SV* sv)
+ void SvREFCNT_inc_simple_void(SV* sv)
=for hackers
Found in file sv.h
-=item SvNV
+=item SvREFCNT_inc_simple_void_NN
+X<SvREFCNT_inc_simple_void_NN>
-Coerce the given SV to a double and return it. See C<SvNVx> for a version
-which guarantees to evaluate sv only once.
+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.
- NV SvNV(SV* sv)
+ void SvREFCNT_inc_simple_void_NN(SV* sv)
=for hackers
Found in file sv.h
-=item SvNVX
+=item SvREFCNT_inc_void
+X<SvREFCNT_inc_void>
-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()>.
+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.
- NV SvNVX(SV* sv)
+ void SvREFCNT_inc_void(SV* sv)
=for hackers
Found in file sv.h
-=item SvNVx
+=item SvREFCNT_inc_void_NN
+X<SvREFCNT_inc_void_NN>
-Coerces the given SV to a double and returns it. Guarantees to evaluate
-sv only once. Use the more efficient C<SvNV> otherwise.
+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.
- NV SvNVx(SV* sv)
+ void SvREFCNT_inc_void_NN(SV* sv)
=for hackers
Found in file sv.h
-=item SvOK
+=item SvROK
+X<SvROK>
-Returns a boolean indicating whether the value is an SV.
+Tests if the SV is an RV.
- bool SvOK(SV* sv)
+ U32 SvROK(SV* sv)
=for hackers
Found in file sv.h
-=item SvOOK
+=item SvROK_off
+X<SvROK_off>
-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
-from the beginning of a SvPV. When SvOOK is true, then the start of the
-allocated string buffer is really (SvPVX - SvIVX).
+Unsets the RV status of an SV.
- bool SvOOK(SV* sv)
+ void SvROK_off(SV* sv)
=for hackers
Found in file sv.h
-=item SvPOK
+=item SvROK_on
+X<SvROK_on>
-Returns a boolean indicating whether the SV contains a character
-string.
+Tells an SV that it is an RV.
- bool SvPOK(SV* sv)
+ void SvROK_on(SV* sv)
=for hackers
Found in file sv.h
-=item SvPOKp
+=item SvRV
+X<SvRV>
-Returns a boolean indicating whether the SV contains a character string.
-Checks the B<private> setting. Use C<SvPOK>.
+Dereferences an RV to return the SV.
- bool SvPOKp(SV* sv)
+ SV* SvRV(SV* sv)
=for hackers
Found in file sv.h
-=item SvPOK_off
+=item SvRV_set
+X<SvRV_set>
-Unsets the PV status of an SV.
+Set the value of the RV pointer in sv to val. See C<SvIV_set>.
- void SvPOK_off(SV* sv)
+ void SvRV_set(SV* sv, SV* val)
=for hackers
Found in file sv.h
-=item SvPOK_on
+=item SvSTASH
+X<SvSTASH>
-Tells an SV that it is a string.
+Returns the stash of the SV.
- void SvPOK_on(SV* sv)
+ HV* SvSTASH(SV* sv)
=for hackers
Found in file sv.h
-=item SvPOK_only
+=item SvSTASH_set
+X<SvSTASH_set>
-Tells an SV that it is a string and disables all other OK bits.
-Will also turn off the UTF8 status.
+Set the value of the STASH pointer in sv to val. See C<SvIV_set>.
- void SvPOK_only(SV* sv)
+ void SvSTASH_set(SV* sv, HV* val)
=for hackers
Found in file sv.h
-=item SvPOK_only_UTF8
+=item SvTAINT
+X<SvTAINT>
-Tells an SV that it is a string and disables all other OK bits,
-and leaves the UTF8 status as it was.
+Taints an SV if tainting is enabled.
- void SvPOK_only_UTF8(SV* sv)
+ void SvTAINT(SV* sv)
=for hackers
Found in file sv.h
-=item SvPV
+=item SvTAINTED
+X<SvTAINTED>
-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
-stringified version becoming C<SvPOK>. Handles 'get' magic. See also
-C<SvPVx> for a version which guarantees to evaluate sv only once.
+Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
+not.
- char* SvPV(SV* sv, STRLEN len)
+ bool SvTAINTED(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVbyte
+=item SvTAINTED_off
+X<SvTAINTED_off>
-Like C<SvPV>, but converts sv to byte representation first if necessary.
+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
+use this function unless they fully understand all the implications of
+unconditionally untainting the value. Untainting should be done in the
+standard perl fashion, via a carefully crafted regexp, rather than directly
+untainting variables.
- char* SvPVbyte(SV* sv, STRLEN len)
+ void SvTAINTED_off(SV* sv)
=for hackers
Found in file sv.h
-=item 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>
-otherwise.
+=item SvTAINTED_on
+X<SvTAINTED_on>
+Marks an SV as tainted if tainting is enabled.
- char* SvPVbytex(SV* sv, STRLEN len)
+ void SvTAINTED_on(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVbytex_force
+=item SvTRUE
+X<SvTRUE>
-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>
-otherwise.
+Returns a boolean indicating whether Perl would evaluate the SV as true or
+false, defined or undefined. Does not handle 'get' magic.
- char* SvPVbytex_force(SV* sv, STRLEN len)
+ bool SvTRUE(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVbyte_force
+=item SvTYPE
+X<SvTYPE>
-Like C<SvPV_force>, but converts sv to byte representation first if necessary.
+Returns the type of the SV. See C<svtype>.
- char* SvPVbyte_force(SV* sv, STRLEN len)
+ svtype SvTYPE(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVbyte_nolen
+=item SvUOK
+X<SvUOK>
-Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
+Returns a boolean indicating whether the SV contains an unsigned integer.
- char* SvPVbyte_nolen(SV* sv)
+ bool SvUOK(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVutf8
+=item SvUPGRADE
+X<SvUPGRADE>
-Like C<SvPV>, but converts sv to utf8 first if necessary.
+Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
+perform the upgrade if necessary. See C<svtype>.
- char* SvPVutf8(SV* sv, STRLEN len)
+ void SvUPGRADE(SV* sv, svtype type)
=for hackers
Found in file sv.h
-=item SvPVutf8x
+=item SvUTF8
+X<SvUTF8>
-Like C<SvPV>, but converts sv to utf8 first if necessary.
-Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
-otherwise.
+Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
+Call this after SvPV() in case any call to string overloading updates the
+internal flag.
- char* SvPVutf8x(SV* sv, STRLEN len)
+ U32 SvUTF8(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVutf8x_force
+=item SvUTF8_off
+X<SvUTF8_off>
-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>
-otherwise.
+Unsets the UTF-8 status of an SV.
- char* SvPVutf8x_force(SV* sv, STRLEN len)
+ void SvUTF8_off(SV *sv)
=for hackers
Found in file sv.h
-=item SvPVutf8_force
+=item SvUTF8_on
+X<SvUTF8_on>
-Like C<SvPV_force>, but converts sv to utf8 first if necessary.
+Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
+Do not use frivolously.
- char* SvPVutf8_force(SV* sv, STRLEN len)
+ void SvUTF8_on(SV *sv)
=for hackers
Found in file sv.h
-=item SvPVutf8_nolen
+=item SvUV
+X<SvUV>
-Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
+Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
+for a version which guarantees to evaluate sv only once.
- char* SvPVutf8_nolen(SV* sv)
+ UV SvUV(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVx
+=item SvUVX
+X<SvUVX>
-A version of C<SvPV> which guarantees to evaluate sv only once.
+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()>.
- char* SvPVx(SV* sv, STRLEN len)
+ UV SvUVX(SV* sv)
=for hackers
Found in file sv.h
-=item SvPVX
+=item SvUVx
+X<SvUVx>
-Returns a pointer to the physical string in the SV. The SV must contain a
-string.
+Coerces the given SV to an unsigned integer and returns it. Guarantees to
+C<sv> only once. Only use this if C<sv> is an expression with side effects,
+otherwise use the more efficient C<SvUV>.
- char* SvPVX(SV* sv)
+ UV SvUVx(SV* sv)
=for hackers
Found in file sv.h
-=item SvPV_force
+=item SvUV_nomg
+X<SvUV_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>
-directly.
+Like C<SvUV> but doesn't process magic.
- char* SvPV_force(SV* sv, STRLEN len)
+ UV SvUV_nomg(SV* sv)
=for hackers
Found in file sv.h
-=item SvPV_force_nomg
+=item SvUV_set
+X<SvUV_set>
-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>
-directly. Doesn't process magic.
+Set the value of the UV pointer in sv to val. See C<SvIV_set>.
- char* SvPV_force_nomg(SV* sv, STRLEN len)
+ void SvUV_set(SV* sv, UV val)
=for hackers
Found in file sv.h
-=item SvPV_nolen
+=item SvVOK
+X<SvVOK>
-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
-stringified form becoming C<SvPOK>. Handles 'get' magic.
+Returns a boolean indicating whether the SV contains a v-string.
- char* SvPV_nolen(SV* sv)
+ bool SvVOK(SV* sv)
=for hackers
Found in file sv.h
-=item SvREFCNT
+=item sv_catpvn_nomg
+X<sv_catpvn_nomg>
-Returns the value of the object's reference count.
+Like C<sv_catpvn> but doesn't process magic.
- U32 SvREFCNT(SV* sv)
+ void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
=for hackers
Found in file sv.h
-=item SvREFCNT_dec
+=item sv_catsv_nomg
+X<sv_catsv_nomg>
-Decrements the reference count of the given SV.
+Like C<sv_catsv> but doesn't process magic.
- void SvREFCNT_dec(SV* sv)
+ void sv_catsv_nomg(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
-=item SvREFCNT_inc
+=item sv_derived_from
+X<sv_derived_from>
-Increments the reference count of the given SV.
+Returns a boolean indicating whether the SV is derived from the specified class
+I<at the C level>. To check derivation at the Perl level, call C<isa()> as a
+normal Perl method.
- SV* SvREFCNT_inc(SV* sv)
+ bool sv_derived_from(SV* sv, const char *const name)
=for hackers
-Found in file sv.h
+Found in file universal.c
-=item SvROK
+=item sv_does
+X<sv_does>
-Tests if the SV is an RV.
+Returns a boolean indicating whether the SV performs a specific, named role.
+The SV can be a Perl object or the name of a Perl class.
- bool SvROK(SV* sv)
+ bool sv_does(SV* sv, const char *const name)
=for hackers
-Found in file sv.h
+Found in file universal.c
-=item SvROK_off
+=item sv_report_used
+X<sv_report_used>
-Unsets the RV status of an SV.
+Dump the contents of all SVs not yet freed. (Debugging aid).
- void SvROK_off(SV* sv)
+ void sv_report_used()
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvROK_on
+=item sv_setsv_nomg
+X<sv_setsv_nomg>
-Tells an SV that it is an RV.
+Like C<sv_setsv> but doesn't process magic.
- void SvROK_on(SV* sv)
+ void sv_setsv_nomg(SV* dsv, SV* ssv)
=for hackers
Found in file sv.h
-=item SvRV
-Dereferences an RV to return the SV.
+=back
- SV* SvRV(SV* sv)
+=head1 SV-Body Allocation
-=for hackers
-Found in file sv.h
+=over 8
-=item SvSTASH
+=item looks_like_number
+X<looks_like_number>
-Returns the stash of the SV.
+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.
- HV* SvSTASH(SV* sv)
+ I32 looks_like_number(SV *const sv)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvTAINT
+=item newRV_noinc
+X<newRV_noinc>
-Taints an SV if tainting is enabled
+Creates an RV wrapper for an SV. The reference count for the original
+SV is B<not> incremented.
- void SvTAINT(SV* sv)
+ SV* newRV_noinc(SV *const sv)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvTAINTED
+=item newSV
+X<newSV>
-Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
-not.
+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.
- bool SvTAINTED(SV* sv)
+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(const STRLEN len)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvTAINTED_off
+=item newSVhek
+X<newSVhek>
-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
-use this function unless they fully understand all the implications of
-unconditionally untainting the value. Untainting should be done in the
-standard perl fashion, via a carefully crafted regexp, rather than directly
-untainting variables.
+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.
- void SvTAINTED_off(SV* sv)
+ SV* newSVhek(const HEK *const hek)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvTAINTED_on
+=item newSViv
+X<newSViv>
-Marks an SV as tainted.
+Creates a new SV and copies an integer into it. The reference count for the
+SV is set to 1.
- void SvTAINTED_on(SV* sv)
+ SV* newSViv(const IV i)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvTRUE
+=item newSVnv
+X<newSVnv>
-Returns a boolean indicating whether Perl would evaluate the SV as true or
-false, defined or undefined. Does not handle 'get' magic.
+Creates a new SV and copies a floating point value into it.
+The reference count for the SV is set to 1.
- bool SvTRUE(SV* sv)
+ SV* newSVnv(const NV n)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvTYPE
+=item newSVpv
+X<newSVpv>
-Returns the type of the SV. See C<svtype>.
+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.
- svtype SvTYPE(SV* sv)
+ SV* newSVpv(const char *const s, const STRLEN len)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvUNLOCK
+=item newSVpvf
+X<newSVpvf>
-Releases a mutual exclusion lock on sv if a suitable module
-has been loaded.
+Creates a new SV and initializes it with the string formatted like
+C<sprintf>.
+ SV* newSVpvf(const char *const pat, ...)
- void SvUNLOCK(SV* sv)
+=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 *const s, const STRLEN len)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvUOK
+=item newSVpvn_flags
+X<newSVpvn_flags>
-Returns a boolean indicating whether the SV contains an unsigned integer.
+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.
+Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
+If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
+returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
+C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
- void SvUOK(SV* sv)
+ #define newSVpvn_utf8(s, len, u) \
+ newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
+
+ SV* newSVpvn_flags(const char *const s, const STRLEN len, const U32 flags)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvUPGRADE
+=item newSVpvn_share
+X<newSVpvn_share>
-Used to upgrade an SV to a more complex form. Uses C<sv_upgrade> to
-perform the upgrade if necessary. See C<svtype>.
+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. If the C<hash> parameter is non-zero, that
+value is used; otherwise the hash is computed. The string's hash can be later
+be retrieved from the SV with the C<SvSHARED_HASH()> macro. 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.
- void SvUPGRADE(SV* sv, svtype type)
+ SV* newSVpvn_share(const char* s, I32 len, U32 hash)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvUTF8
+=item newSVpvs
+X<newSVpvs>
-Returns a boolean indicating whether the SV contains UTF-8 encoded data.
+Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
- void SvUTF8(SV* sv)
+ SV* newSVpvs(const char* s)
=for hackers
-Found in file sv.h
+Found in file handy.h
-=item SvUTF8_off
+=item newSVpvs_flags
+X<newSVpvs_flags>
-Unsets the UTF8 status of an SV.
+Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
+pair.
- void SvUTF8_off(SV *sv)
+ SV* newSVpvs_flags(const char* s, U32 flags)
=for hackers
-Found in file sv.h
+Found in file handy.h
-=item SvUTF8_on
+=item newSVpvs_share
+X<newSVpvs_share>
-Turn on the UTF8 status of an SV (the data is not changed, just the flag).
-Do not use frivolously.
+Like C<newSVpvn_share>, but takes a literal string instead of a string/length
+pair and omits the hash parameter.
- void SvUTF8_on(SV *sv)
+ SV* newSVpvs_share(const char* s)
=for hackers
-Found in file sv.h
+Found in file handy.h
-=item SvUV
+=item newSVrv
+X<newSVrv>
-Coerces the given SV to an unsigned integer and returns it. See C<SvUVx>
-for a version which guarantees to evaluate sv only once.
+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.
- UV SvUV(SV* sv)
+ SV* newSVrv(SV *const rv, const char *const classname)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvUVX
+=item newSVsv
+X<newSVsv>
-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()>.
+Creates a new SV which is an exact duplicate of the original SV.
+(Uses C<sv_setsv>).
- UV SvUVX(SV* sv)
+ SV* newSVsv(SV *const old)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvUVx
+=item newSVuv
+X<newSVuv>
-Coerces the given SV to an unsigned integer and returns it. Guarantees to
-evaluate sv only once. Use the more efficient C<SvUV> otherwise.
+Creates a new SV and copies an unsigned integer into it.
+The reference count for the SV is set to 1.
- UV SvUVx(SV* sv)
+ SV* newSVuv(const UV u)
=for hackers
-Found in file sv.h
+Found in file sv.c
-=item SvVOK
+=item newSV_type
+X<newSV_type>
-Returns a boolean indicating whether the SV contains a v-string.
+Creates a new SV, of the type specified. The reference count for the new SV
+is set to 1.
- bool SvVOK(SV* sv)
+ SV* newSV_type(const svtype type)
=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.
- bool sv_2bool(SV* sv)
+ bool sv_2bool(SV *const sv)
=for hackers
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)
+ CV* sv_2cv(SV* sv, HV **const st, GV **const gvp, const I32 lref)
=for hackers
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
named after the PV if we're a string.
- IO* sv_2io(SV* sv)
+ IO* sv_2io(SV *const sv)
=for hackers
Found in file sv.c
-=item sv_2iv
+=item sv_2iv_flags
+X<sv_2iv_flags>
-Return the integer value of an SV, doing any necessary string conversion,
-magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
+Return the integer value of an SV, doing any necessary string
+conversion. If flags includes SV_GMAGIC, does an mg_get() first.
+Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
- IV sv_2iv(SV* sv)
+ IV sv_2iv_flags(SV *const sv, const I32 flags)
=for hackers
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
-statement boundaries. See also C<sv_newmortal> and C<sv_mortalcopy>.
+statement boundaries. SvTEMP() is turned on which means that the SV's
+string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
+and C<sv_mortalcopy>.
- SV* sv_2mortal(SV* sv)
+ SV* sv_2mortal(SV *const sv)
=for hackers
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)>
macros.
- NV sv_2nv(SV* sv)
+ NV sv_2nv(SV *const sv)
=for hackers
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 UTF8 as a
+to its length. May cause the SV to be downgraded from UTF-8 as a
side-effect.
Usually accessed via the C<SvPVbyte> macro.
- char* sv_2pvbyte(SV* sv, STRLEN* lp)
-
-=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 UTF8 as a side-effect.
-
-Usually accessed via the C<SvPVbyte_nolen> macro.
-
- char* sv_2pvbyte_nolen(SV* sv)
+ char* sv_2pvbyte(SV *const sv, STRLEN *const lp)
=for hackers
Found in file sv.c
=item sv_2pvutf8
+X<sv_2pvutf8>
-Return a pointer to the UTF8-encoded representation of the SV, and set *lp
-to its length. May cause the SV to be upgraded to UTF8 as a side-effect.
+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.
Usually accessed via the C<SvPVutf8> macro.
- char* sv_2pvutf8(SV* sv, STRLEN* lp)
-
-=for hackers
-Found in file sv.c
-
-=item sv_2pvutf8_nolen
-
-Return a pointer to the UTF8-encoded representation of the SV.
-May cause the SV to be upgraded to UTF8 as a side-effect.
-
-Usually accessed via the C<SvPVutf8_nolen> macro.
-
- char* sv_2pvutf8_nolen(SV* sv)
+ char* sv_2pvutf8(SV *const sv, STRLEN *const lp)
=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
Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
usually end up here too.
- char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
-
-=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)
+ char* sv_2pv_flags(SV *const sv, STRLEN *const lp, const I32 flags)
=for hackers
Found in file sv.c
-=item sv_2uv
+=item sv_2uv_flags
+X<sv_2uv_flags>
Return the unsigned integer value of an SV, doing any necessary string
-conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
-macros.
+conversion. If flags includes SV_GMAGIC, does an mg_get() first.
+Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
- UV sv_2uv(SV* sv)
+ UV sv_2uv_flags(SV *const sv, const I32 flags)
=for hackers
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.
- int sv_backoff(SV* sv)
+ int sv_backoff(SV *const sv)
=for hackers
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
of the SV is unaffected.
- SV* sv_bless(SV* sv, HV* stash)
+ SV* sv_bless(SV *const sv, HV *const stash)
=for hackers
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 UTF8 status set, then the bytes appended should be
-valid UTF8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
+If the SV has the UTF-8 status set, then the bytes appended should be
+valid UTF-8. Handles 'get' magic, but not 'set' magic. See C<sv_catpv_mg>.
- void sv_catpv(SV* sv, const char* ptr)
+ void sv_catpv(SV *const sv, const char* ptr)
=for hackers
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
(including, but not limited to, SVs with a UTF-8 PV formatted with %s,
and characters >255 formatted with %c), the original SV might get
-upgraded to UTF-8. Handles 'get' magic, but not 'set' magic.
-C<SvSETMAGIC()> must typically be called after calling this function
-to handle 'set' magic.
+upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See
+C<sv_catpvf_mg>. If the original SV was UTF-8, the pattern should be
+valid UTF-8; if the original SV was bytes, the pattern should be too.
- void sv_catpvf(SV* sv, const char* pat, ...)
+ void sv_catpvf(SV *const sv, const char *const pat, ...)
=for hackers
Found in file sv.c
=item sv_catpvf_mg
+X<sv_catpvf_mg>
Like C<sv_catpvf>, but also handles 'set' magic.
- void sv_catpvf_mg(SV *sv, const char* pat, ...)
+ void sv_catpvf_mg(SV *const sv, const char *const pat, ...)
=for hackers
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 UTF8
-status set, then the bytes appended should be valid UTF8.
+C<len> indicates number of bytes to copy. If the SV has the UTF-8
+status set, then the bytes appended should be valid UTF-8.
Handles 'get' magic, but not 'set' magic. See C<sv_catpvn_mg>.
- void sv_catpvn(SV* sv, const char* ptr, STRLEN len)
+ void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)
=for hackers
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 UTF8
-status set, then the bytes appended should be valid UTF8.
+C<len> indicates number of bytes to copy. If the SV has the UTF-8
+status set, then the bytes appended should be valid UTF-8.
If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
in terms of this function.
- void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
+ void sv_catpvn_flags(SV *const dstr, const char *sstr, const STRLEN len, const I32 flags)
=for hackers
Found in file sv.c
-=item sv_catpvn_mg
+=item sv_catpvs
+X<sv_catpvs>
-Like C<sv_catpvn>, but also handles 'set' magic.
+Like C<sv_catpvn>, but takes a literal string instead of a string/length pair.
- void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
+ void sv_catpvs(SV* sv, const char* s)
=for hackers
-Found in file sv.c
+Found in file handy.h
=item sv_catpv_mg
+X<sv_catpv_mg>
Like C<sv_catpv>, but also handles 'set' magic.
- void sv_catpv_mg(SV *sv, const char *ptr)
+ void sv_catpv_mg(SV *const sv, const char *const ptr)
=for hackers
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
not 'set' magic. See C<sv_catsv_mg>.
- void sv_catsv(SV* dsv, SV* ssv)
+ void sv_catsv(SV *dstr, SV *sstr)
=for hackers
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>
bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
and C<sv_catsv_nomg> are implemented in terms of this function.
- void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
-
-=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)
+ void sv_catsv_flags(SV *const dsv, SV *const ssv, const I32 flags)
=for hackers
Found in file sv.c
=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_const(sv) may no longer
+refer to the same chunk of data.
- void sv_chop(SV* sv, char* ptr)
+ void sv_chop(SV *const sv, const char *const 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
you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
instead.
- void sv_clear(SV* sv)
+ void sv_clear(SV *const sv)
=for hackers
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
C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
coerce its args to strings if necessary. See also C<sv_cmp_locale>.
- I32 sv_cmp(SV* sv1, SV* sv2)
+ I32 sv_cmp(SV *const sv1, SV *const sv2)
=for hackers
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
-if necessary. See also C<sv_cmp_locale>. See also C<sv_cmp>.
+if necessary. See also C<sv_cmp>.
- I32 sv_cmp_locale(SV* sv1, SV* sv2)
+ I32 sv_cmp_locale(SV *const sv1, SV *const sv2)
=for hackers
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.
memory comparison can be used to compare the data according to the locale
settings.
- char* sv_collxfrm(SV* sv, STRLEN* nxp)
+ char* sv_collxfrm(SV *const sv, STRLEN *const nxp)
=for hackers
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
coercion of numeric values into strings. Guaranteed to preserve
-UTF-8 flag even from overloaded objects. Similar in nature to
+UTF8 flag even from overloaded objects. Similar in nature to
sv_2pv[_flags] but operates directly on an SV instead of just the
string. Mostly uses sv_2pv_flags to do its work, except when that
would lose the UTF-8'ness of the PV.
- void sv_copypv(SV* dsv, SV* ssv)
+ void sv_copypv(SV *const dsv, SV *const ssv)
=for hackers
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.
- void sv_dec(SV* sv)
+ void sv_dec(SV *const sv)
=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
C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
with flags set to 0.
- void sv_force_normal_flags(SV *sv, U32 flags)
+ void sv_force_normal_flags(SV *const sv, const U32 flags)
=for hackers
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
the body; finally, deallocate the SV's head itself.
Normally called via a wrapper macro C<SvREFCNT_dec>.
- void sv_free(SV* sv)
+ void sv_free(SV *const sv)
=for hackers
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.
- char* sv_gets(SV* sv, PerlIO* fp, I32 append)
+ char* sv_gets(SV *const sv, PerlIO *const fp, I32 append)
=for hackers
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.
Use the C<SvGROW> wrapper instead.
- char* sv_grow(SV* sv, STRLEN newlen)
+ char* sv_grow(SV *const sv, STRLEN newlen)
=for hackers
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.
+
+ void sv_inc(SV *const sv)
+
+=for hackers
+Found in file sv.c
+
+=item sv_insert
+X<sv_insert>
-Auto-increment of the value in the SV, doing string to numeric conversion
-if necessary. Handles 'get' magic.
+Inserts a string at the specified offset/length within the SV. Similar to
+the Perl substr() function. Handles get magic.
- void sv_inc(SV* sv)
+ void sv_insert(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen)
=for hackers
Found in file sv.c
-=item sv_insert
+=item sv_insert_flags
+X<sv_insert_flags>
-Inserts a string at the specified offset/length within the SV. Similar to
-the Perl substr() function.
+Same as C<sv_insert>, but the extra C<flags> are passed the C<SvPV_force_flags> that applies to C<bigstr>.
- void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
+ void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)
=for hackers
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
an inheritance relationship.
- int sv_isa(SV* sv, const char* name)
+ int sv_isa(SV* sv, const char *const name)
=for hackers
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.
- STRLEN sv_len(SV* sv)
+ STRLEN sv_len(SV *const sv)
=for hackers
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
-UTF8 bytes as a single character. Handles magic and type coercion.
+UTF-8 bytes as a single character. Handles magic and type coercion.
- STRLEN sv_len_utf8(SV* sv)
+ STRLEN sv_len_utf8(SV *const sv)
=for hackers
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.
- void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
+See C<sv_magicext> (which C<sv_magic> now calls) for a description of the
+handling of the C<name> and C<namlen> arguments.
+
+You need to use C<sv_magicext> to add magic to SvREADONLY SVs and also
+to add more than one instance of the same 'how'.
+
+ void sv_magic(SV *const sv, SV *const obj, const int how, const char *const name, const I32 namlen)
=for hackers
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 pointer to the magic added.
+supplied vtable and returns a pointer to the magic added.
-Note that sv_magicext will allow things that sv_magic will not.
-In particular you can add magic to SvREADONLY SVs and and more than
-one instance of the same 'how'
+Note that C<sv_magicext> will allow things that C<sv_magic> will not.
+In particular, you can add magic to SvREADONLY SVs, and add more than
+one instance of the same 'how'.
-I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
-if C<namelen> is zero then C<name> is stored as-is and - as another special
-case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
-an C<SV*> and has its REFCNT incremented
+If C<namlen> is greater than zero then a C<savepvn> I<copy> of C<name> is
+stored, if C<namlen> is zero then C<name> is stored as-is and - as another
+special case - if C<(name && namlen == HEf_SVKEY)> then C<name> is assumed
+to contain an C<SV*> and is stored as-is with its REFCNT incremented.
-(This is now used as a subroutine by sv_magic.)
+(This is now used as a subroutine by C<sv_magic>.)
- MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )
+ MAGIC * sv_magicext(SV *const sv, SV *const obj, const int how, const MGVTBL *const vtbl, const char *const name, const 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
explicit call to FREETMPS, or by an implicit call at places such as
statement boundaries. See also C<sv_newmortal> and C<sv_2mortal>.
- SV* sv_mortalcopy(SV* oldsv)
+ SV* sv_mortalcopy(SV *const oldsv)
=for hackers
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.
- SV* sv_newref(SV* sv)
-
-=for hackers
-Found in file sv.c
-
-=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
-
-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
-
-=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 *)
-
-=for hackers
-Found in file util.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)
+ SV* sv_newref(SV *const 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 UTF8 chars.
+start of the string, to a count of the equivalent number of UTF-8 chars.
Handles magic and type coercion.
- void sv_pos_b2u(SV* sv, I32* offsetp)
+ void sv_pos_b2u(SV *const sv, I32 *const offsetp)
=for hackers
Found in file sv.c
=item sv_pos_u2b
+X<sv_pos_u2b>
-Converts the value pointed to by offsetp from a count of UTF8 chars from
+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
lenp is non-zero, it does the same to lenp, but this time starting from
the offset, rather than from the start of the string. Handles magic and
type coercion.
- void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
-
-=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)
+ void sv_pos_u2b(SV *const sv, I32 *const offsetp, I32 *const lenp)
=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.
-
- 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.
+The backend for the C<SvPVbytex_force> macro. Always use the macro instead.
- char* sv_pvn(SV *sv, STRLEN *len)
+ char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)
=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
You normally want to use the various wrapper macros instead: see
C<SvPV_force> and C<SvPV_force_nomg>
- char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
-
-=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)
+ char* sv_pvn_force_flags(SV *const sv, STRLEN *const lp, const I32 flags)
=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)
+ char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
=for hackers
Found in file sv.c
=item sv_reftype
+X<sv_reftype>
Returns a string describing what the SV is a reference to.
- char* sv_reftype(SV* sv, int ob)
+ const char* sv_reftype(const SV *const sv, const int ob)
=for hackers
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
Note that this is a rather specialist SV copying operation; most of the
time you'll want to use C<sv_setsv> or one of its many macro front-ends.
- void sv_replace(SV* sv, SV* nsv)
-
-=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()
+ void sv_replace(SV *const sv, SV *const nsv)
=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.
- void sv_reset(char* s, HV* stash)
+ void sv_reset(const char* s, HV *const stash)
=for hackers
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
push a back-reference to this RV onto the array of backreferences
-associated with that magic.
+associated with that magic. If the RV is magical, set magic will be
+called after the RV is cleared.
- SV* sv_rvweaken(SV *sv)
+ SV* sv_rvweaken(SV *const sv)
=for hackers
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>.
- void sv_setiv(SV* sv, IV num)
+ void sv_setiv(SV *const sv, const IV num)
=for hackers
Found in file sv.c
=item sv_setiv_mg
+X<sv_setiv_mg>
Like C<sv_setiv>, but also handles 'set' magic.
- void sv_setiv_mg(SV *sv, IV i)
+ void sv_setiv_mg(SV *const sv, const IV i)
=for hackers
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>.
- void sv_setnv(SV* sv, NV num)
+ void sv_setnv(SV *const sv, const NV num)
=for hackers
Found in file sv.c
=item sv_setnv_mg
+X<sv_setnv_mg>
Like C<sv_setnv>, but also handles 'set' magic.
- void sv_setnv_mg(SV *sv, NV num)
+ void sv_setnv_mg(SV *const sv, const NV num)
=for hackers
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>.
- void sv_setpv(SV* sv, const char* ptr)
+ void sv_setpv(SV *const sv, const char *const ptr)
=for hackers
Found in file sv.c
=item sv_setpvf
+X<sv_setpvf>
-Processes its arguments like C<sprintf> and sets an SV to the formatted
-output. Does not handle 'set' magic. See C<sv_setpvf_mg>.
+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>.
- void sv_setpvf(SV* sv, const char* pat, ...)
+ void sv_setpvf(SV *const sv, const char *const pat, ...)
=for hackers
Found in file sv.c
=item sv_setpvf_mg
+X<sv_setpvf_mg>
Like C<sv_setpvf>, but also handles 'set' magic.
- void sv_setpvf_mg(SV *sv, const char* pat, ...)
+ void sv_setpvf_mg(SV *const sv, const char *const pat, ...)
+
+=for hackers
+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>.
+
+ void sv_setpviv(SV *const sv, const IV num)
+
+=for hackers
+Found in file sv.c
+
+=item sv_setpviv_mg
+X<sv_setpviv_mg>
+
+Like C<sv_setpviv>, but also handles 'set' magic.
+
+ void sv_setpviv_mg(SV *const sv, const IV iv)
=for hackers
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. Does not handle 'set' magic. See C<sv_setpvn_mg>.
+bytes to be copied. If the C<ptr> argument is NULL the SV will become
+undefined. Does not handle 'set' magic. See C<sv_setpvn_mg>.
- void sv_setpvn(SV* sv, const char* ptr, STRLEN len)
+ void sv_setpvn(SV *const sv, const char *const ptr, const STRLEN len)
=for hackers
Found in file sv.c
=item sv_setpvn_mg
+X<sv_setpvn_mg>
Like C<sv_setpvn>, but also handles 'set' magic.
- void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
+ void sv_setpvn_mg(SV *const sv, const char *const ptr, const STRLEN len)
=for hackers
Found in file sv.c
+=item sv_setpvs
+X<sv_setpvs>
+
+Like C<sv_setpvn>, but takes a literal string instead of a string/length pair.
+
+ void sv_setpvs(SV* sv, const char* s)
+
+=for hackers
+Found in file handy.h
+
=item sv_setpv_mg
+X<sv_setpv_mg>
Like C<sv_setpv>, but also handles 'set' magic.
- void sv_setpv_mg(SV *sv, const char *ptr)
+ void sv_setpv_mg(SV *const sv, const char *const ptr)
=for hackers
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
-will be returned and will have a reference count of 1.
+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)
+ SV* sv_setref_iv(SV *const rv, const char *const classname, const IV iv)
=for hackers
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
-will be returned and will have a reference count of 1.
+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)
+ SV* sv_setref_nv(SV *const rv, const char *const classname, const NV nv)
=for hackers
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
-will be returned and will have a reference count of 1.
+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
objects will become corrupted by the pointer copy process.
Note that C<sv_setref_pvn> copies the string while this copies the pointer.
- SV* sv_setref_pv(SV* rv, const char* classname, void* pv)
+ SV* sv_setref_pv(SV *const rv, const char *const classname, void *const pv)
=for hackers
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 be returned and will have
-a reference count of 1.
+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 *const rv, const char *const classname, const char *const pv, const 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
-will be returned and will have a reference count of 1.
+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)
+ SV* sv_setref_uv(SV *const rv, const char *const classname, const UV uv)
=for hackers
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
C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
C<SvSetMagicSV_nosteal>.
- void sv_setsv(SV* dsv, SV* ssv)
+ void sv_setsv(SV *dstr, SV *sstr)
=for hackers
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
Loosely speaking, it performs a copy-by-value, obliterating any previous
content of the destination.
If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
-C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
-implemented in terms of this function.
+C<ssv> if appropriate, else not. If the C<flags> parameter has the
+C<NOSTEAL> bit set then the buffers of temps will not be stolen. <sv_setsv>
+and C<sv_setsv_nomg> are implemented in terms of this function.
You probably want to use one of the assortment of wrappers, such as
C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
This is the primary function for copying scalars, and most other
copy-ish functions and macros use this underneath.
- void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
+ void sv_setsv_flags(SV *dstr, SV *sstr, const I32 flags)
=for hackers
Found in file sv.c
=item sv_setsv_mg
+X<sv_setsv_mg>
Like C<sv_setsv>, but also handles 'set' magic.
- void sv_setsv_mg(SV *dstr, SV *sstr)
+ void sv_setsv_mg(SV *const dstr, SV *const sstr)
=for hackers
Found in file sv.c
=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>.
- void sv_setuv(SV* sv, UV num)
+ void sv_setuv(SV *const sv, const UV num)
=for hackers
Found in file sv.c
=item sv_setuv_mg
+X<sv_setuv_mg>
Like C<sv_setuv>, but also handles 'set' magic.
- void sv_setuv_mg(SV *sv, UV u)
-
-=for hackers
-Found in file sv.c
-
-=item sv_taint
-
-Taint an SV. Use C<SvTAINTED_on> instead.
- void sv_taint(SV* sv)
+ void sv_setuv_mg(SV *const sv, const UV u)
=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)
+ bool sv_tainted(SV *const sv)
=for hackers
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
instead use an in-line version.
- I32 sv_true(SV *sv)
+ I32 sv_true(SV *const sv)
=for hackers
Found in file sv.c
=item sv_unmagic
+X<sv_unmagic>
Removes all magic of type C<type> from an SV.
- int sv_unmagic(SV* sv, int type)
-
-=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)
+ int sv_unmagic(SV *const sv, const int type)
=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
different from one or the reference being a readonly SV).
See C<SvROK_off>.
- void sv_unref_flags(SV* sv, U32 flags)
+ void sv_unref_flags(SV *const ref, const U32 flags)
=for hackers
Found in file sv.c
=item sv_untaint
+X<sv_untaint>
Untaint an SV. Use C<SvTAINTED_off> instead.
- void sv_untaint(SV* sv)
+ void sv_untaint(SV *const sv)
=for hackers
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 *const sv, svtype new_type)
=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)
-
-=for hackers
-Found in file sv.c
+=item sv_usepvn_flags
+X<sv_usepvn_flags>
-=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 *const sv, char* ptr, const STRLEN len, const U32 flags)
=for hackers
Found in file sv.c
=item sv_utf8_decode
+X<sv_utf8_decode>
-Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
-turn off SvUTF8 if needed so that we see characters. Used as a building block
-for decode_utf8 in Encode.xs
+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
+so that it looks like a character. If the PV contains only single-byte
+characters, the C<SvUTF8> flag stays being off.
+Scans PV for validity and returns false if the PV is invalid UTF-8.
NOTE: this function is experimental and may change or be
removed without notice.
- bool sv_utf8_decode(SV *sv)
+ bool sv_utf8_decode(SV *const sv)
=for hackers
Found in file sv.c
=item sv_utf8_downgrade
+X<sv_utf8_downgrade>
-Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
-This may not be possible if the PV contains non-byte encoding characters;
-if this is the case, either returns false or, if C<fail_ok> is not
+Attempts to convert the PV of an SV from characters to bytes.
+If the PV contains a character beyond byte, this conversion will fail;
+in this case, either returns false or, if C<fail_ok> is not
true, croaks.
This is not as a general purpose Unicode to byte encoding interface:
NOTE: this function is experimental and may change or be
removed without notice.
- bool sv_utf8_downgrade(SV *sv, bool fail_ok)
+ bool sv_utf8_downgrade(SV *const sv, const bool fail_ok)
=for hackers
Found in file sv.c
=item sv_utf8_encode
+X<sv_utf8_encode>
-Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
-flag so that it looks like octets again. Used as a building block
-for encode_utf8 in Encode.xs
+Converts the PV of an SV to UTF-8, but then turns the C<SvUTF8>
+flag off so that it looks like octets again.
- void sv_utf8_encode(SV *sv)
+ void sv_utf8_encode(SV *const sv)
=for hackers
Found in file sv.c
=item sv_utf8_upgrade
+X<sv_utf8_upgrade>
-Convert the PV of an SV to its UTF8-encoded form.
+Converts the PV of an SV to its UTF-8-encoded form.
Forces the SV to string form if it is not already.
Always sets the SvUTF8 flag to avoid future validity checks even
if all the bytes have hibit clear.
Found in file sv.c
=item sv_utf8_upgrade_flags
+X<sv_utf8_upgrade_flags>
-Convert the PV of an SV to its UTF8-encoded form.
+Converts the PV of an SV to its UTF-8-encoded form.
Forces the SV to string form if it is not already.
Always sets the SvUTF8 flag to avoid future validity checks even
if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
This is not as a general purpose byte encoding to Unicode interface:
use the Encode extension for that.
- STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)
+ STRLEN sv_utf8_upgrade_flags(SV *const sv, const I32 flags)
=for hackers
Found in file sv.c
-=item sv_uv
+=item sv_vcatpvf
+X<sv_vcatpvf>
-A private implementation of the C<SvUVx> macro for compilers which can't
-cope with complex macro expressions. Always use the macro instead.
+Processes its arguments like C<vsprintf> and appends the formatted output
+to an SV. Does not handle 'set' magic. See C<sv_vcatpvf_mg>.
- UV sv_uv(SV* sv)
+Usually used via its frontend C<sv_catpvf>.
+
+ void sv_vcatpvf(SV *const sv, const char *const pat, va_list *const args)
=for hackers
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
C<maybe_tainted> if results are untrustworthy (often due to the use of
locales).
-Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
+Usually used via one of its frontends C<sv_vcatpvf> and C<sv_vcatpvf_mg>.
- void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
+ void sv_vcatpvfn(SV *const sv, const char *const pat, const STRLEN patlen, va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
=for hackers
Found in file sv.c
-=item sv_vsetpvfn
+=item sv_vcatpvf_mg
+X<sv_vcatpvf_mg>
-Works like C<vcatpvfn> but copies the text into the SV instead of
-appending it.
+Like C<sv_vcatpvf>, but also handles 'set' magic.
-Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
+Usually used via its frontend C<sv_catpvf_mg>.
- void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
+ void sv_vcatpvf_mg(SV *const sv, const char *const pat, va_list *const args)
=for hackers
Found in file sv.c
-=item upg_version
-
-In-place upgrade of the supplied SV to a version object.
-
- SV *sv = upg_version(SV *sv);
-
-Returns a pointer to the upgraded SV.
-
- SV* upg_version(SV *ver)
-
-=for hackers
-Found in file util.c
+=item sv_vsetpvf
+X<sv_vsetpvf>
-=item vcmp
+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>.
-Version object aware cmp. Both operands must already have been
-converted into version objects.
+Usually used via its frontend C<sv_setpvf>.
- int vcmp(SV *lvs, SV *rvs)
+ void sv_vsetpvf(SV *const sv, const char *const pat, va_list *const args)
=for hackers
-Found in file util.c
-
-=item vnumify
+Found in file sv.c
-Accepts a version object and returns the normalized floating
-point representation. Call like:
+=item sv_vsetpvfn
+X<sv_vsetpvfn>
- sv = vnumify(rv);
+Works like C<sv_vcatpvfn> but copies the text into the SV instead of
+appending it.
-NOTE: you can pass either the object directly or the SV
-contained within the RV.
+Usually used via one of its frontends C<sv_vsetpvf> and C<sv_vsetpvf_mg>.
- SV* vnumify(SV *vs)
+ void sv_vsetpvfn(SV *const sv, const char *const pat, const STRLEN patlen, va_list *const args, SV **const svargs, const I32 svmax, bool *const maybe_tainted)
=for hackers
-Found in file util.c
-
-=item vstringify
+Found in file sv.c
-Accepts a version object and returns the normalized string
-representation. Call like:
+=item sv_vsetpvf_mg
+X<sv_vsetpvf_mg>
- sv = vstringify(rv);
+Like C<sv_vsetpvf>, but also handles 'set' magic.
-NOTE: you can pass either the object directly or the SV
-contained within the RV.
+Usually used via its frontend C<sv_setpvf_mg>.
- SV* vstringify(SV *vs)
+ void sv_vsetpvf_mg(SV *const sv, const char *const pat, va_list *const args)
=for hackers
-Found in file util.c
+Found in file sv.c
=back
=over 8
=item bytes_from_utf8
+X<bytes_from_utf8>
-Converts a string C<s> of length C<len> from UTF8 into byte encoding.
-Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
+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
the newly-created string, and updates C<len> to contain the new
length. Returns the original string if no conversion occurs, C<len>
is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
NOTE: this function is experimental and may change or be
removed without notice.
- U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
+ U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)
=for hackers
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 UTF8 encoding.
+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
reflect the new length.
+If you want to convert to UTF-8 from other encodings than ASCII,
+see sv_recode_to_utf8().
+
NOTE: this function is experimental and may change or be
removed without notice.
- U8* bytes_to_utf8(U8 *s, STRLEN *len)
+ U8* bytes_to_utf8(const U8 *s, STRLEN *len)
=for hackers
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
in there (they will point at the beginning of the I<next> character).
If the pointers behind pe1 or pe2 are non-NULL, they are the end
pointers beyond which scanning will not continue under any
-circustances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
+circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
s2+l2 will be used as goal end pointers that will also stop the scan,
and which qualify towards defining a successful match: all the scans
that define an explicit length must reach their goal pointers for
instead of upper/lowercasing both the characters, see
http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
- I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
+ I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)
=for hackers
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
UTF-8 character. The actual number of bytes in the UTF-8 character
will be returned if it is valid, otherwise 0.
- STRLEN is_utf8_char(U8 *p)
+ STRLEN is_utf8_char(const U8 *s)
=for hackers
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>.
+
+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>.
-Returns true if first C<len> bytes of the given string form a valid UTF8
-string, false otherwise. Note that 'a valid UTF8 string' does not mean
-'a string that contains UTF8' because a valid ASCII string is a valid
-UTF8 string.
+See also is_utf8_string_loc() and is_utf8_string().
- bool is_utf8_string(U8 *s, STRLEN len)
+ 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
The pointer to the PV of the dsv is returned.
- char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
+ char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
=for hackers
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(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, 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
-that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
+that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
foldcase version may be longer than the original character (up to
three characters).
The first character of the foldcased version is returned
(but note, as explained above, that there may be more.)
- UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
+ UV to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)
=for hackers
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
-that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
-lowercase version may be longer than the original character (up to two
-characters).
+that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
+lowercase version may be longer than the original character.
The first character of the lowercased version is returned
(but note, as explained above, that there may be more.)
- UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
+ UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)
=for hackers
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
-that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
-titlecase version may be longer than the original character (up to two
-characters).
+that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
+titlecase version may be longer than the original character.
The first character of the titlecased version is returned
(but note, as explained above, that there may be more.)
- UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
+ UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)
=for hackers
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
-that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
-uppercase version may be longer than the original character (up to two
-characters).
+that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
+the uppercase version may be longer than the original character.
The first character of the uppercased version is returned
(but note, as explained above, that there may be more.)
- UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
+ UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)
=for hackers
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>
-which is assumed to be in UTF8 encoding; C<retlen> will be set to the
+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(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>
-which is assumed to be in UTF8 encoding and no longer than C<curlen>;
+Returns the Unicode code point value of the first character in the string C<s>
+which is assumed to be in UTF-8 encoding and no longer than C<curlen>;
C<retlen> will be set to the length, in bytes, of that character.
-If C<s> does not point to a well-formed UTF8 character, the behaviour
+If C<s> does not point to a well-formed UTF-8 character, the behaviour
is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
it is assumed that the caller will raise a warning, and this function
will silently just set C<retlen> to C<-1> and return zero. If the
Most code should use utf8_to_uvchr() rather than call this directly.
- UV utf8n_to_uvuni(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 UTF8 characters between the UTF-8 pointers C<a>
+Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
and C<b>.
WARNING: use only if you *know* that the pointers point inside the
same UTF-8 buffer.
- IV utf8_distance(U8 *a, U8 *b)
+ IV utf8_distance(const U8 *a, const U8 *b)
=for hackers
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.
the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
on the first byte of character or just after the last byte of a character.
- U8* utf8_hop(U8 *s, I32 off)
+ U8* utf8_hop(const U8 *s, I32 off)
=for hackers
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
up past C<e>, croaks.
- STRLEN utf8_length(U8* s, U8 *e)
+ STRLEN utf8_length(const U8* s, const U8 *e)
=for hackers
Found in file utf8.c
=item utf8_to_bytes
+X<utf8_to_bytes>
-Converts a string C<s> of length C<len> from UTF8 into byte encoding.
+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 UTF8 encoding; C<retlen> will be set to the
+which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
length, in bytes, of that character.
-If C<s> does not point to a well-formed UTF8 character, zero is
+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(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 UTF8 encoding; C<retlen> will be set to the
+which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
length, in bytes, of that character.
This function should only be used when returned UV is considered
an index into the Unicode semantic tables (e.g. swashes).
-If C<s> does not point to a well-formed UTF8 character, zero is
+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(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 UTF8 representation of the Native codepoint C<uv> to the end
-of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
+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
bytes available. The return value is the pointer to the byte after the
end of the new character. In other words,
Found in file utf8.c
=item uvuni_to_utf8_flags
+X<uvuni_to_utf8_flags>
-Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
-of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
+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
bytes available. The return value is the pointer to the byte after the
end of the new character. In other words,
=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>.
=for hackers
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>.
+
+ dAXMARK;
+
+=for hackers
+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>.
=for hackers
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>.
+
+ dUNDERBAR;
+
+=for hackers
+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
=for hackers
Found in file XSUB.h
-=item XS
+=item UNDERBAR
+X<UNDERBAR>
-Macro to declare an XSUB and its C parameter list. This is handled by
-C<xsubpp>.
+The SV* corresponding to the $_ variable. Works even if there
+is a lexical $_ in scope.
=for hackers
Found in file XSUB.h
-=item XSRETURN_EMPTY
-
-Return an empty list from an XSUB immediately.
-
+=item XS
+X<XS>
- XSRETURN_EMPTY;
+Macro to declare an XSUB and its C parameter list. This is handled by
+C<xsubpp>.
=for hackers
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 use this function the same way you use the C C<printf>
-function. See C<warn>.
+Normally call this function the same way you call the C C<printf>
+function. Calling C<croak> returns control directly to Perl,
+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. Use this
-function the same way you use the C C<printf> function. See
-C<croak>.
+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>.
void warn(const char* pat, ...)
perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
+=cut
+
+ ex: set ro:
projects / p5sagit/p5-mst-13.2.git / blobdiff