This file contains the documentation of the perl public API generated by
embed.pl, specifically a listing of functions, macros, flags, and variables
that may be used by extension writers. The interfaces of any functions that
are not listed here are subject to change without notice. For this reason,
blindly using functions listed in proto.h is to be avoided when writing
extensions.
Note that all Perl API global variables must be referenced with the PL_
prefix. Some macros are provided for compatibility with the older,
unadorned names, but this support may be disabled in a future release.
A backward-compatible version of GIMME_V which can only return
G_SCALAR or G_ARRAY; in a void context, it returns G_SCALAR.
Deprecated. Use GIMME_V instead.
Returns the SV at the specified index in the array. The key is the
index. If lval is set then the fetch will be part of a store. Check
that the return value is non-null before dereferencing it to a SV*.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 61.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for
more information on how to use this function on tied arrays.
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.
Stores an SV in an array. The array index is specified as key. The
return value will be NULL if the operation failed or if the value did not
need to be actually stored within the array (as in the case of tied
arrays). Otherwise it can be dereferenced to get the original SV*. Note
that the caller is responsible for suitably incrementing the reference
count of val before the call, and decrementing it if the function
returned NULL.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 90.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for
more information on how to use this function on tied arrays.
Unshift the given number of undef values onto the beginning of the
array. The array will grow automatically to accommodate the addition. You
must then use av_store to assign values to these new elements.
Returns the AV of the specified Perl array. If create is set and the
Perl variable does not exist then it will be created. If create is not
set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
Create and return a new interpreter by cloning the current one.
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_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
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,
you don't need to do anything.
Returns the CV of the specified Perl subroutine. If create is set and
the Perl subroutine does not exist then it will be declared (which has the
same effect as saying sub name;). If create is not set and the
subroutine does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
Clear out all the active components of a CV. This can happen either
by an explicit undef &foo, or by the reference count going to zero.
In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
children can still follow the full lexical scope chain.
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.
Eg, ``Foo::Bar'' instead of ``Foo/Bar.pm''. flags can be any of
PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
(or 0 for no flags). ver, if specified, provides version semantics
similar to use Foo::Bar VERSION. The optional trailing SV*
arguments can be used to specify arguments to the module's import()
method, similar to use Foo::Bar VERSION LIST.
Tells Perl to require the file named by the string argument. It is
analogous to the Perl code eval "require '$file'". It's even
implemented that way; consider using load_module instead.
NOTE: the perl_ form of this function is deprecated.
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.
The engine implementing unpack() Perl function. unpackstring puts the
extracted list items on the stack and returns the number of elements.
Issue PUTBACK before and SPAGAIN after the call to this function.
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.
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.
A convenience variable which is typically used with 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
SvPV_nolen macro.
Returns the glob with the given name and a defined subroutine or
NULL. The glob lives in the given stash, or in the stashes
accessible via @ISA and UNIVERSAL::.
The argument level should be either 0 or -1. If level==0, as a
side-effect creates a glob with the given name in the given 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.
This function grants "SUPER" token as a postfix of the stash name. The
GV returned from gv_fetchmeth may be a method cache entry, which is not
visible to Perl code. So when calling 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 GvCV macro.
Returns the glob which contains the subroutine to call to invoke the method
on the 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.
The third parameter of 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 gv_fetchmethod is equivalent to calling gv_fetchmethod_autoload
with a non-zero autoload parameter.
These functions grant "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.
These functions have the same side-effects and as gv_fetchmeth with
level==0. name should be writable if contains ':' or '
''. The warning against passing the GV returned by gv_fetchmeth to
call_sv apply equally to these functions.
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 iflevel < 0. For an autoloaded subroutine without a stub, GvCV()
of the result may be zero.
Returns a pointer to the stash for a specified package. name should
be a valid UTF-8 string and must be null-terminated. If create is set
then the package will be created if it does not already exist. If create
is not set and the package does not exist then NULL is returned.
Returns a pointer to the stash for a specified package. name should
be a valid UTF-8 string. The namelen parameter indicates the length of
the name, in bytes. If create is set then the package will be
created if it does not already exist. If create is not set and the
package does not exist then NULL is returned.
Returns the HV of the specified Perl hash. If create is set and the
Perl variable does not exist then it will be created. If create is not
set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
This flag, used in the length slot of hash entries and magic structures,
specifies the structure contains an SV* pointer where a char* pointer
is to be expected. (For information only--not to be used).
Returns the actual pointer stored in the key slot of the hash entry. The
pointer may be either char* or SV*, depending on the value of
HeKLEN(). Can be assigned to. The HePV() or HeSVKEY() macros are
usually preferable for finding the value of a key.
If this is negative, and amounts to HEf_SVKEY, it indicates the entry
holds an SV* key. Otherwise, holds the actual length of the key. Can
be assigned to. The HePV() macro is usually preferable for finding key
lengths.
Returns the key slot of the hash entry as a char* value, doing any
necessary dereferencing of possibly SV* keys. The length of the string
is placed in len (this is a macro, so do not use &len). If you do
not care about what the length of the key is, you may use the global
variable 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 strlen() or similar is not a good way to find
the length of hash keys. This is very similar to the SvPV() macro
described elsewhere in this document.
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.
Deletes a key/value pair in the hash. The value SV is removed from the
hash and returned to the caller. The klen is the length of the key.
The flags value will normally be zero; if set to G_DISCARD then NULL
will be returned.
Deletes a key/value pair in the hash. The value SV is removed from the
hash and returned to the caller. The flags value will normally be zero; if set to G_DISCARD then NULL will be returned. hash can be a valid
precomputed hash value, or 0 to ask for it to be computed.
Returns the SV which corresponds to the specified key in the hash. The
klen is the length of the key. If 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 SV*.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 441.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more
information on how to use this function on tied hashes.
Returns the hash entry which corresponds to the specified key in the hash.
hash must be a valid precomputed hash number for the given key, or 0 if you want the function to compute it. IF 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 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.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 446.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more
information on how to use this function on tied hashes.
Prepares a starting point to traverse a hash table. Returns the number of
keys in the hash (i.e. the same as HvKEYS(tb)). The return value is
currently only meaningful for hashes without tie magic.
NOTE: Before version 5.004_65, 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 HvFILL(tb).
Returns the key as an SV* from the current position of the hash
iterator. The return value will always be a mortal copy of the key. Also
see hv_iterinit.
Returns entries from a hash iterator. See hv_iterinit.
You may call hv_delete or 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 hv_iternext, so you must not discard
your iterator immediately else the entry will leak - call hv_iternext to
trigger the resource deallocation.
Returns entries from a hash iterator. See hv_iterinit and hv_iternext.
The 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
&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.
Stores an SV in a hash. The hash key is specified as key and klen is
the length of the key. The 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 SV*. Note that the caller is
responsible for suitably incrementing the reference count of val before
the call, and decrementing it if the function returned NULL. Effectively
a successful hv_store takes ownership of one reference to 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.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 490.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more
information on how to use this function on tied hashes.
Stores val in a hash. The hash key is specified as key. The hash
parameter is the precomputed hash value; if it is zero then Perl will
compute it. The return value is the new hash entry so created. It 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 the
contents of the return value can be accessed using the He? macros
described here. Note that the caller is responsible for suitably
incrementing the reference count of val before the call, and
decrementing it if the function returned NULL. Effectively a successful
hv_store_ent takes ownership of one reference to 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. Note that hv_store_ent only reads the key;
unlike val it does not take ownership of it, so maintaining the correct
reference count on key is entirely the caller's responsibility. 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.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 495.
See perlguts/``Understanding the Magic of Tied Hashes and Arrays'' for more
information on how to use this function on tied hashes.
The XSUB-writer's interface to the C memcpy function. The src is the
source, dest is the destination, nitems is the number of items, and type is
the type. May fail on overlapping copies. See also Move.
void Copy(void* src, void* dest, int nitems, type)
The XSUB-writer's interface to the C memmove function. The src is the
source, dest is the destination, nitems is the number of items, and type is
the type. Can do overlapping moves. See also Copy.
void Move(void* src, void* dest, int nitems, type)
The XSUB-writer's interface to the C malloc function. The allocated
memory is zeroed with memzero.
In 5.9.3, we removed the 1st parameter, a debug aid, from the api. It
was used to uniquely identify each usage of these allocation
functions, but was deemed unnecessary with the availability of better
memory tracking tools, valgrind for example.
Perl's version of strdup(). Returns a pointer to a newly allocated
string which is a duplicate of pv. The size of the string is
determined by strlen(). The memory allocated for the new string can
be freed with the Safefree() function.
Perl's version of what strndup() would be if it existed. Returns a
pointer to a newly allocated string which is a duplicate of the first
lenbytes from pv. The memory allocated for the new string can be
freed with the Safefree() function.
Returns the location of the SV in the string delimited by str and
strend. It returns Nullchif the string can't be found. The sv
does not have to be fbm_compiled, but the search will not be as fast
then.
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).
Test two strings to see if they are different. The len parameter
indicates the number of bytes to compare. Returns true or false. (A
wrapper for strncmp).
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.
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.
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.
converts a string representing a binary number to numeric form.
On entry start and *len give the string to scan, *flags gives
conversion flags, and 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 PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an
invalid character will also trigger a warning.
On return *len is set to the length of the scanned string,
and *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 *result. If the value is > UV_MAX grok_bin
returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,
and writes the value to *result (or the value is discarded ifresult
is NULL).
The binary number may optionally be prefixed with ``0b'' or ``b'' unless
PERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. If
PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the binary
number may use '_' characters to separate digits.
converts a string representing a hex number to numeric form.
On entry start and *len give the string to scan, *flags gives
conversion flags, and 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 PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an
invalid character will also trigger a warning.
On return *len is set to the length of the scanned string,
and *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 *result. If the value is > UV_MAX grok_hex
returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,
and writes the value to *result (or the value is discarded ifresult
is NULL).
The hex number may optionally be prefixed with ``0x'' or ``x'' unless
PERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. If
PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the hex
number may use '_' characters to separate digits.
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).
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)
converts a string representing an octal number to numeric form.
On entry start and *len give the string to scan, *flags gives
conversion flags, and 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 PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an
invalid character will also trigger a warning.
On return *len is set to the length of the scanned string,
and *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 *result. If the value is > UV_MAX grok_oct
returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,
and writes the value to *result (or the value is discarded ifresult
is NULL).
If PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the octal
number may use '_' characters to separate digits.
Used to extend the argument stack for an XSUB's return values. Once
used, guarantees that there is room for at least nitems to be pushed
onto the stack.
Push a string onto the stack. The stack must have room for this element.
The len indicates the length of the string. Handles 'set' magic. Does
not use TARG. See also PUSHp, mXPUSHp and XPUSHp.
Push an unsigned integer onto the stack. The stack must have room for this
element. Handles 'set' magic. Does not use TARG. See also PUSHu,
mXPUSHu and XPUSHu.
Push a string onto the stack, extending the stack if necessary. The len
indicates the length of the string. Handles 'set' magic. Does not use
TARG. See also XPUSHp, mPUSHp and PUSHp.
Push an integer onto the stack. The stack must have room for this element.
Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be
called to declare it. Do not call multiple TARG-oriented macros to
return lists from XSUB's - see mPUSHi instead. See also XPUSHi and
mXPUSHi.
Push a new mortal SV onto the stack. The stack must have room for this
element. Does not handle 'set' magic. Does not use TARG. See also
PUSHs, XPUSHmortal and XPUSHs.
Push a double onto the stack. The stack must have room for this element.
Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be
called to declare it. Do not call multiple TARG-oriented macros to
return lists from XSUB's - see mPUSHn instead. See also XPUSHn and
mXPUSHn.
Push a string onto the stack. The stack must have room for this element.
The len indicates the length of the string. Handles 'set' magic. Uses
TARG, so dTARGET or dXSTARG should be called to declare it. Do not
call multiple TARG-oriented macros to return lists from XSUB's - see
mPUSHp instead. See also XPUSHp and mXPUSHp.
Push an SV onto the stack. The stack must have room for this element.
Does not handle 'set' magic. Does not use TARG. See also PUSHmortal,
XPUSHs and XPUSHmortal.
Push an unsigned integer onto the stack. The stack must have room for this
element. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG
should be called to declare it. Do not call multiple TARG-oriented
macros to return lists from XSUB's - see mPUSHu instead. See also
XPUSHu and mXPUSHu.
Push an integer onto the stack, extending the stack if necessary. Handles
'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to
declare it. Do not call multiple TARG-oriented macros to return lists
from XSUB's - see mXPUSHi instead. See also PUSHi and mPUSHi.
Push a new mortal SV onto the stack, extending the stack if necessary. Does
not handle 'set' magic. Does not use TARG. See also XPUSHs,
PUSHmortal and PUSHs.
Push a double onto the stack, extending the stack if necessary. Handles
'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to
declare it. Do not call multiple TARG-oriented macros to return lists
from XSUB's - see mXPUSHn instead. See also PUSHn and mPUSHn.
Push a string onto the stack, extending the stack if necessary. The len
indicates the length of the string. Handles 'set' magic. Uses TARG, so
dTARGET or dXSTARG should be called to declare it. Do not call
multiple TARG-oriented macros to return lists from XSUB's - see
mXPUSHp instead. See also PUSHp and mPUSHp.
Push an SV onto the stack, extending the stack if necessary. Does not
handle 'set' magic. Does not use TARG. See also XPUSHmortal,
PUSHs and PUSHmortal.
Push an unsigned integer onto the stack, extending the stack if necessary.
Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be
called to declare it. Do not call multiple TARG-oriented macros to
return lists from XSUB's - see mXPUSHu instead. See also PUSHu and
mPUSHu.
Returns the SV of the specified Perl scalar. If create is set and the
Perl variable does not exist then it will be created. If create is not
set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
Test if the content of an SV looks like a number (or is a number).
Inf and Infinity are treated as numbers (so will not issue a
non-numeric warning), even if your atof() doesn't grok them.
Creates a new SV. A non-zero 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.
id is an integer id between 0 and 1299 (used to identify leaks).
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.
Creates a new SV and copies a string into it. The reference count for the
SV is set to 1. If len is zero, Perl will compute the length using
strlen(). For efficiency, consider using newSVpvn instead.
Creates a new SV and copies a string into it. The reference count for the
SV is set to 1. Note that iflen is zero, Perl will create a zero length
string. You are responsible for ensuring that the source string is at least
lenbytes long. If the s argument is NULL the new SV will be undefined.
Creates a new SV with its SvPVX_const pointing to a shared string in the string
table. If the string does not already exist in the table, it is created
first. Turns on READONLY and FAKE. The string's hash is stored in the UV
slot of the SV; if the hash parameter is non-zero, that value is used;
otherwise the hash is computed. The idea here is that as the string table
is used for shared hash keys these strings will have SvPVX_const == HeKEY and
hash lookup will avoid string compare.
Creates a new SV for the RV, rv, to point to. If rv is not an RV then
it will be upgraded to one. If 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.
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 sv_grow to perform the expansion if necessary.
Returns a pointer to the character buffer.
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)
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 SvIVX.
With future Perls, however, it will be more efficient to use
SvIV_set instead of the lvalue assignment to SvIVX.
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).
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 SvPOK. Handles 'get' magic. See also
SvPVx for a version which guarantees to evaluate sv only once.
Like SvPV_force, but converts sv to byte representation first if necessary.
Guarantees to evaluate sv only once; use the more efficient SvPVbyte_force
otherwise.
Like SvPV but will force the SV into containing just a string
(SvPOK_only). You want force if you are going to update the SvPVX
directly. Doesn't process magic.
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 SvPOK. Handles 'get' magic.
Untaints an SV. Be 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.
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.
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. SvTEMP() is turned on which means that the SV's
string buffer can be ``stolen'' if this SV is copied. See also sv_newmortal
and sv_mortalcopy.
Return a pointer to the byte-encoded representation of the SV, and set *lp
to its length. May cause the SV to be downgraded from UTF-8 as a
side-effect.
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 if necessary.
Normally invoked via the SvPV_flags macro. sv_2pv() and sv_2pv_nomg
usually end up here too.
Blesses an SV into a specified package. The SV must be an RV. The package
must be designated by its stash (see gv_stashpv()). The reference count
of the SV is unaffected.
Concatenates the string onto the end of the string which is in the SV.
If the SV has the UTF-8 status set, then the bytes appended should be
valid UTF-8. Handles 'get' magic, but not 'set' magic. See sv_catpv_mg.
Processes its arguments like 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. See
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.
Concatenates the string onto the end of the string which is in the SV. The
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 sv_catpvn_mg.
Concatenates the string onto the end of the string which is in the SV. The
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 flags has SV_GMAGIC bit set, will mg_get on dsvif appropriate, else not. sv_catpvn and sv_catpvn_nomg are implemented
in terms of this function.
Concatenates the string from SV ssv onto the end of the string in
SV dsv. Modifies dsv but not ssv. Handles 'get' magic, but
not 'set' magic. See sv_catsv_mg.
Concatenates the string from SV ssv onto the end of the string in
SV dsv. Modifies dsv but not ssv. If flags has SV_GMAGIC
bit set, will mg_get on the SVs if appropriate, else not. sv_catsv
and sv_catsv_nomg are implemented in terms of this function.
Efficient removal of characters from the beginning of the string buffer.
SvPOK(sv) must be true and the ptr must be a pointer to somewhere inside
the string buffer. The ptr becomes the first character of the adjusted
string. Uses the ``OOK hack''.
Beware: after this function returns, ptr and SvPVX_const(sv) may no longer
refer to the same chunk of data.
Clear an SV: call any destructors, free up any memory used by the body,
and free the body itself. The SV's head is not freed, although
its type is set to all 1's so that it won't inadvertently be assumed
to be live during global destruction etc.
This function should only be called when REFCNT is zero. Most of the time
you'll want to call sv_free() (or its macro wrapper SvREFCNT_dec)
instead.
Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
string in sv1 is less than, equal to, or greater than the string in
sv2. Is UTF-8 and 'use bytes' aware, handles get magic, and will
coerce its args to strings if necessary. See also 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 sv_cmp_locale. See also sv_cmp.
Add Collate Transform magic to an SV if it doesn't already have it.
Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
scalar data of the variable, but transformed to such a format that a normal
memory comparison can be used to compare the data according to the locale settings.
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
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.
Returns a boolean indicating whether the SV is derived from the specified
class. This is the function that implements UNIVERSAL::isa. It works
for class names as well as for objects.
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
coerce its args to strings if necessary.
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 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
an xpvmg. The flags parameter gets passed to sv_unref_flags()
when unrefing. sv_force_normal calls this function with flags set to 0.
Decrement an SV's reference count, and if it drops to zero, call
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 SvREFCNT_dec.
Expands the character buffer in the SV. If necessary, uses sv_unref and
upgrades the SV to SVt_PV. Returns a pointer to the character buffer.
Use the SvGROW wrapper instead.
Returns a boolean indicating whether the SV is blessed into the specified
class. This does not check for subtypes; use sv_derived_from to verify
an inheritance relationship.
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
will return false.
Adds magic to an SV, upgrading it if necessary. Applies the
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 add more than
one instance of the same 'how'.
If namlen is greater than zero then a savepvncopy of name is
stored, ifnamlen is zero then name is stored as-is and - as another
special case - if(name && namlen == HEf_SVKEY) then name is assumed
to contain an SV* and is stored as-is with its REFCNT incremented.
Creates a new SV which is a copy of the original SV (using 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 sv_newmortal and sv_2mortal.
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
FREETMPS, or by an implicit call at places such as statement boundaries.
See also sv_mortalcopy and sv_2mortal.
Converts the value pointed to by offsetp from a count of bytes from the
start of the string, to a count of the equivalent number of UTF-8 chars.
Handles magic and type coercion.
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.
Get a sensible string out of the SV somehow.
A private implementation of the SvPV_force macro for compilers which
can't cope with complex macro expressions. Always use the macro instead.
Get a sensible string out of the SV somehow.
If flags has SV_GMAGIC bit set, will mg_get on svif appropriate, else not. sv_pvn_force and sv_pvn_force_nomg are
implemented in terms of this function.
You normally want to use the various wrapper macros instead: see
SvPV_force and SvPV_force_nomg
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
and inherits its flags; however, the target keeps any magic it owns,
and any magic in the source is discarded.
Note that this is a rather specialist SV copying operation; most of the
time you'll want to use sv_setsv or one of its many macro front-ends.
Weaken a reference: set the SvWEAKREF flag on this RV; give the
referred-to SV 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.
Copies a string into an SV. The len parameter indicates the number of bytes to be copied. If the ptr argument is NULL the SV will become
undefined. Does not handle 'set' magic. See sv_setpvn_mg.
Copies an integer into a new SV, optionally blessing the SV. The rv
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The classname argument indicates the package for the
blessing. Set classname to Nullch 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)
Copies a double into a new SV, optionally blessing the SV. The rv
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The classname argument indicates the package for the
blessing. Set classname to Nullch to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
Copies a pointer into a new SV, optionally blessing the SV. The rv
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. If the pv argument is NULL then PL_sv_undef will be placed
into the SV. The classname argument indicates the package for the
blessing. Set classname to Nullch 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 sv_setref_pvn copies the string while this copies the pointer.
Copies a string into a new SV, optionally blessing the SV. The length of the
string must be specified with n. The rv argument will be upgraded to
an RV. That RV will be modified to point to the new SV. The classname
argument indicates the package for the blessing. Set classname to
Nullch to avoid the blessing. The new SV will have a reference count
of 1, and the RV will be returned.
Note that sv_setref_pv copies the pointer while this copies the string.
Copies an unsigned integer into a new SV, optionally blessing the SV. The rv
argument will be upgraded to an RV. That RV will be modified to point to
the new SV. The classname argument indicates the package for the
blessing. Set classname to Nullch to avoid the blessing. The new SV
will have a reference count of 1, and the RV will be returned.
Copies the contents of the source SV ssv into the destination SV
dsv. The source SV may be destroyed if it is mortal, so don't use this
function if the source SV needs to be reused. Does not handle 'set' magic.
Loosely speaking, it performs a copy-by-value, obliterating any previous
content of the destination.
You probably want to use one of the assortment of wrappers, such as
SvSetSV, SvSetSV_nosteal, SvSetMagicSV and
SvSetMagicSV_nosteal.
Copies the contents of the source SV ssv into the destination SV
dsv. The source SV may be destroyed if it is mortal, so don't use this
function if the source SV needs to be reused. Does not handle 'set' magic.
Loosely speaking, it performs a copy-by-value, obliterating any previous
content of the destination.
If the flags parameter has the SV_GMAGIC bit set, will mg_get on
ssvif appropriate, else not. If the flags parameter has the
NOSTEAL bit set then the buffers of temps will not be stolen. <sv_setsv>
and sv_setsv_nomg are implemented in terms of this function.
You probably want to use one of the assortment of wrappers, such as
SvSetSV, SvSetSV_nosteal, SvSetMagicSV and
SvSetMagicSV_nosteal.
This is the primary function for copying scalars, and most other
copy-ish functions and macros use this underneath.
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 newSVrv. This is sv_unref_flags with the flag
being zero. See SvROK_off.
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 newSVrv. The cflags argument can contain
SV_IMMEDIATE_UNREF to force the reference count to be decremented
(otherwise the decrementing is conditional on the reference count being
different from one or the reference being a readonly SV).
See SvROK_off.
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 SvUPGRADE macro wrapper. See also svtype.
Tells an SV to use 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 ptr should point to memory that was allocated by malloc. The
string length, len, must be supplied. This function will realloc the
memory pointed to by 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 sv_usepvn_mg.
If the PV of the SV is an octet sequence in UTF-8
and contains a multiple-byte character, the SvUTF8 flag is turned on
so that it looks like a character. If the PV contains only single-byte
characters, the 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.
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, iffail_ok is not
true, croaks.
This is not as a general purpose Unicode to byte encoding interface:
use the Encode extension for that.
NOTE: this function is experimental and may change or be
removed without notice.
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.
This is not as a general purpose byte encoding to Unicode interface:
use the Encode extension for that.
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 flags has SV_GMAGIC bit set,
will mg_get on svif appropriate, else not. sv_utf8_upgrade and
sv_utf8_upgrade_nomg are implemented in terms of this function.
This is not as a general purpose byte encoding to Unicode interface:
use the Encode extension for that.
Processes its arguments like vsprintf and appends the formatted output
to an SV. Uses an array of SVs if the C style variable argument list is
missing (NULL). When running with taint checks enabled, indicates via
maybe_taintedif results are untrustworthy (often due to the use of
locales).
XXX Except that it maybe_tainted is never assigned to.
Usually used via one of its frontends sv_vcatpvf and sv_vcatpvf_mg.
Converts a string s of length len from UTF-8 into byte encoding.
Unlike utf8_to_bytes but like bytes_to_utf8, returns a pointer to
the newly-created string, and updates len to contain the new
length. Returns the original string if no conversion occurs, len
is unchanged. Do nothing ifis_utf8 points to 0. Sets is_utf8 to
0 ifs is converted or contains all 7bit characters.
NOTE: this function is experimental and may change or be
removed without notice.
Converts a string s of length len from ASCII into UTF-8 encoding.
Returns a pointer to the newly-created string, and sets 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.
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
string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
are false, the respective string is assumed to be in native 8-bit
encoding.
If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
in there (they will point at the beginning of the 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
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
a match to succeed).
For case-insensitiveness, the ``casefolding'' of Unicode is used
instead of upper/lowercasing both the characters, see
http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
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.
Returns true if first lenbytes 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().
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 ep.
See also is_utf8_string_loclen() and is_utf8_string().
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 ep, and the number of UTF-8
encoded characters in the el.
See also is_utf8_string_loc() and is_utf8_string().
Build to the scalar dsv a displayable version of the string spv,
length len, the displayable version being at most pvlim bytes long
(if longer, the rest is truncated and ``...'' will be appended).
The flags argument can have UNI_DISPLAY_ISPRINT set to display
isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
to display the \\[nrfta\\] as the backslashed versions (like '\n')
(UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
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
from the position which (PV + *offset) pointed to. The dsv will be
concatenated the decoded UTF-8 string from ssv. Decoding will terminate
when the string tstr appears in decoding output or the input ends on
the PV of the ssv. The value which the offset points will be modified
to the last input position on the ssv.
Returns TRUE if the terminator was found, else returns FALSE.
bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
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
will be converted into Unicode (and UTF-8).
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 1963.
If the sv already is UTF-8 (or if it is not POK), or if the encoding is not a reference, nothing is done to the sv. If the encoding is not
an Encode::XS Encoding object, bad things will happen.
(See lib/encoding.pm and Encode).
Build to the scalar dsv a displayable version of the scalar sv,
the displayable version being at most pvlim bytes long
(if longer, the rest is truncated and ``...'' will be appended).
The ``p'' contains the pointer to the UTF-8 string encoding the character that is being converted.
The ``ustrp'' is a pointer to the character buffer to put the
conversion result to. The ``lenp'' is a pointer to the length
of the result.
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,
but not always, a multicharacter mapping), is tried first.
The ``special'' is a string like ``utf8::ToSpecLower'', which means the
hash %utf8::ToSpecLower. The access to the hash is through
Perl_to_utf8_case().
The ``normal'' is a string like ``ToLower'' which means the swash
%utf8::ToLower.
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_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.)
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_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.)
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_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.)
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_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.)
Returns the native character value of the first character in the string s
which is assumed to be in UTF-8 encoding; retlen will be set to the
length, in bytes, of that character.
Allows length and flags to be passed to low level routine.
Bottom level UTF-8 decode routine.
Returns the unicode code point value of the first character in the string s
which is assumed to be in UTF-8 encoding and no longer than curlen;
retlen will be set to the length, in bytes, of that character.
If s does not point to a well-formed UTF-8 character, the behaviour
is dependent on the value of flags: if it contains UTF8_CHECK_ONLY,
it is assumed that the caller will raise a warning, and this function
will silently just set retlen to -1 and return zero. If the
flags does not contain UTF8_CHECK_ONLY, warnings about
malformations will be given, retlen will be set to the expected
length of the UTF-8 character in bytes, and zero will be returned.
The flags can also contain various flags to allow deviations from
the strict UTF-8 encoding (see utf8.h).
Most code should use utf8_to_uvchr() rather than call this directly.
Return the UTF-8 pointer s displaced by off characters, either
forward or backward.
WARNING: do not use the following unless you *know* off is within
the UTF-8 data pointed to by s *and* that on entry s is aligned
on the first byte of character or just after the last byte of a character.
Converts a string s of length len from UTF-8 into byte encoding.
Unlike bytes_to_utf8, this over-writes the original string, and
updates len to contain the new length.
Returns zero on failure, setting len to -1.
NOTE: this function is experimental and may change or be
removed without notice.
Returns the native character value of the first character in the string s
which is assumed to be in UTF-8 encoding; retlen will be set to the
length, in bytes, of that character.
If s does not point to a well-formed UTF-8 character, zero is
returned and retlen is set, if possible, to -1.
Returns the Unicode code point of the first character in the string s
which is assumed to be in UTF-8 encoding; 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 s does not point to a well-formed UTF-8 character, zero is
returned and retlen is set, if possible, to -1.
Adds the UTF-8 representation of the Native codepoint uv to the end
of the string d; d should be have at least 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,
d = uvchr_to_utf8(d, uv);
is the recommended wide native character-aware way of saying
Adds the UTF-8 representation of the Unicode codepoint uv to the end
of the string d; d should be have at least 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,
Variable which is setup by xsubpp to indicate the stack base offset,
used by the ST, XSprePUSH and XSRETURN macros. The dMARK macro
must be called prior to setup the MARK variable.
Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
Sets up the ax and items variables by calling dAX and dITEMS.
This is usually handled automatically by xsubpp.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 2105.
Variable which is setup by xsubpp to hold the return value for an
XSUB. This is always the proper type for the XSUB. See
perlxs/``The RETVAL Variable''.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 2113.
Variable which is setup by xsubpp to designate the object in a C++
XSUB. This is always the proper type for the C++ object. See CLASS and
perlxs/``Using XS With C++''.
perldoc2tree.cgi: /usr/lib/perl5/5.8.8/pod/perlapi.pod: cannot resolve L in paragraph 2123.
Macro to verify that a PM module's $VERSION variable matches the XS
module's XS_VERSION variable. This is usually handled automatically by
xsubpp. See perlxs/``The VERSIONCHECK: Keyword''.
This is the XSUB-writer's interface to Perl's die function.
Normally call this function the same way you call the C printf
function. Calling croak returns control directly to Perl,
sidestepping the normal C order of execution. See warn.
If you want to throw an exception object, assign the object to
$@ and then pass Nullch to croak():
Until May 1997, this document was maintained by Jeff Okamoto
<okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
Stephen McCamant, and Gurusamy Sarathy.
