X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperlapi.pod;h=98abdc1d0766671f976baf19f4c12bc3f5154267;hb=4b3603a49f6eac34b6cdb154bf3bd8a8f5240085;hp=b1feed3197e0eab752a85e4adf879b21bcb473af;hpb=914184e127659d74e06479dfe3f4f7da0f8315c4;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perlapi.pod b/pod/perlapi.pod index b1feed3..98abdc1 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -1201,7 +1201,7 @@ Found in file sv.c Creates a new SV. A non-zero C 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. +space is allocated.) The reference count for the new SV is set to 1. C is an integer id between 0 and 1299 (used to identify leaks). SV* NEWSV(int id, STRLEN len) @@ -2355,19 +2355,19 @@ false, defined or undefined. Does not handle 'get' magic. =for hackers Found in file sv.h -=item SvTYPE - -Returns the type of the SV. See C. +=item svtype - svtype SvTYPE(SV* sv) +An enum of flags for Perl types. These are found in the file B +in the C enum. Test these flags with the C macro. =for hackers Found in file sv.h -=item svtype +=item SvTYPE -An enum of flags for Perl types. These are found in the file B -in the C enum. Test these flags with the C macro. +Returns the type of the SV. See C. + + svtype SvTYPE(SV* sv) =for hackers Found in file sv.h @@ -3195,13 +3195,46 @@ Found in file utf8.c Converts a string C of length C from UTF8 into byte encoding. Unlike C, this over-writes the original string, and updates len to contain the new length. -Returns zero on failure leaving the string and len unchanged +Returns zero on failure, setting C to -1. U8 * utf8_to_bytes(U8 *s, STRLEN *len) =for hackers Found in file utf8.c +=item utf8_to_uv + +Returns the character value of the first character in the string C +which is assumed to be in UTF8 encoding; C will be set to the +length, in bytes, of that character, and the pointer C will be +advanced to the end of the character. + +If C does not point to a well-formed UTF8 character, an optional UTF8 +warning is produced. + + U8* s utf8_to_uv(I32 *retlen) + +=for hackers +Found in file utf8.c + +=item utf8_to_uv_chk + +Returns the character value of the first character in the string C +which is assumed to be in UTF8 encoding; C will be set to the +length, in bytes, of that character, and the pointer C will be +advanced to the end of the character. + +If C does not point to a well-formed UTF8 character, the behaviour +is dependent on the value of C: if this is true, it is +assumed that the caller will raise a warning, and this function will +set C to C<-1> and return. If C is not true, an optional UTF8 +warning is produced. + + U8* s utf8_to_uv_chk(I32 *retlen, I32 checking) + +=for hackers +Found in file utf8.c + =item warn This is the XSUB-writer's interface to Perl's C function. Use this