This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate mainline
authorNick Ing-Simmons <nik@tiuk.ti.com>
Fri, 29 Jun 2001 10:20:30 +0000 (10:20 +0000)
committerNick Ing-Simmons <nik@tiuk.ti.com>
Fri, 29 Jun 2001 10:20:30 +0000 (10:20 +0000)
p4raw-id: //depot/perlio@11017

1  2 
pod/perlapi.pod

diff --combined pod/perlapi.pod
@@@ -555,8 -555,20 +555,20 @@@ Found in file op.
  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 (defined in perl.h).  If the value
- of the number can fit an in UV, it is returned in the *valuep.
+ IS_NUMBER_NEG, IS_NUMBER_INFINITY (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)
  
@@@ -2213,22 -2225,22 +2225,22 @@@ which guarantees to evaluate sv only on
  =for hackers
  Found in file sv.h
  
 -=item SvNVX
 +=item SvNVx
  
 -Returns the raw value in the SV's NV slot, without checks or conversions.
 -Only use when you are sure SvNOK is true. See also C<SvNV()>.
 +Coerces the given SV to a double and returns it. Guarantees to evaluate
 +sv only once. Use the more efficent C<SvNV> otherwise.
  
 -      NV      SvNVX(SV* sv)
 +      NV      SvNVx(SV* sv)
  
  =for hackers
  Found in file sv.h
  
 -=item SvNVx
 +=item SvNVX
  
 -Coerces the given SV to a double and returns it. Guarantees to evaluate
 -sv only once. Use the more efficent C<SvNV> otherwise.
 +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()>.
  
 -      NV      SvNVx(SV* sv)
 +      NV      SvNVX(SV* sv)
  
  =for hackers
  Found in file sv.h
@@@ -2422,21 -2434,21 +2434,21 @@@ Like C<SvPV_nolen>, but converts sv to 
  =for hackers
  Found in file sv.h
  
 -=item SvPVx
 +=item SvPVX
  
 -A version of C<SvPV> which guarantees to evaluate sv only once.
 +Returns a pointer to the physical string in the SV.  The SV must contain a
 +string.
  
 -      char*   SvPVx(SV* sv, STRLEN len)
 +      char*   SvPVX(SV* sv)
  
  =for hackers
  Found in file sv.h
  
 -=item SvPVX
 +=item SvPVx
  
 -Returns a pointer to the physical string in the SV.  The SV must contain a
 -string.
 +A version of C<SvPV> which guarantees to evaluate sv only once.
  
 -      char*   SvPVX(SV* sv)
 +      char*   SvPVx(SV* sv, STRLEN len)
  
  =for hackers
  Found in file sv.h
@@@ -2643,19 -2655,19 +2655,19 @@@ false, defined or undefined.  Does not 
  =for hackers
  Found in file sv.h
  
 -=item SvTYPE
 -
 -Returns the type of the SV.  See C<svtype>.
 +=item svtype
  
 -      svtype  SvTYPE(SV* sv)
 +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 sv.h
  
 -=item svtype
 +=item SvTYPE
  
 -An enum of flags for Perl types.  These are found in the file B<sv.h> 
 -in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
 +Returns the type of the SV.  See C<svtype>.
 +
 +      svtype  SvTYPE(SV* sv)
  
  =for hackers
  Found in file sv.h
@@@ -2766,22 -2778,22 +2778,22 @@@ for a version which guarantees to evalu
  =for hackers
  Found in file sv.h
  
 -=item SvUVx
 +=item SvUVX
  
 -Coerces the given SV to an unsigned integer and returns it. Guarantees to
 -evaluate sv only once. Use the more efficent C<SvUV> otherwise.
 +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()>.
  
 -      UV      SvUVx(SV* sv)
 +      UV      SvUVX(SV* sv)
  
  =for hackers
  Found in file sv.h
  
 -=item SvUVX
 +=item SvUVx
  
 -Returns the raw value in the SV's UV slot, without checks or conversions.
 -Only use when you are sure SvIOK is true. See also C<SvUV()>.
 +Coerces the given SV to an unsigned integer and returns it. Guarantees to
 +evaluate sv only once. Use the more efficent C<SvUV> otherwise.
  
 -      UV      SvUVX(SV* sv)
 +      UV      SvUVx(SV* sv)
  
  =for hackers
  Found in file sv.h