This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
another ext/SDBM_File/sdbm build fix
[perl5.git] / sv.h
diff --git a/sv.h b/sv.h
index 8af8cbb..a9a57df 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -1,6 +1,7 @@
 /*    sv.h
  *
- *    Copyright (c) 1991-2003, Larry Wall
+ *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+ *    2000, 2001, 2002, 2003, by Larry Wall and others
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
@@ -212,6 +213,7 @@ perform the upgrade if necessary.  See C<svtype>.
 
 #define SVrepl_EVAL    0x40000000      /* Replacement part of s///e */
 
+#define SVphv_REHASH   0x10000000      /* HV is recalculating hash values */
 #define SVphv_SHAREKEYS 0x20000000     /* keys live on shared string table */
 #define SVphv_LAZYDEL  0x40000000      /* entry in xhv_eiter must be deleted */
 #define SVphv_HASKFLAGS        0x80000000      /* keys have flag byte after hash */
@@ -273,7 +275,8 @@ struct xpvlv {
     STRLEN     xlv_targoff;
     STRLEN     xlv_targlen;
     SV*                xlv_targ;
-    char       xlv_type;
+    char       xlv_type;       /* k=keys .=pos x=substr v=vec /=join/re
+                                * y=alem/helem/iter t=tie T=tied HE */
 };
 
 struct xpvgv {
@@ -306,7 +309,7 @@ struct xpvbm {
     U8         xbm_rare;       /* rarest character in string */
 };
 
-/* This structure much match XPVCV in cv.h */
+/* This structure must match XPVCV in cv.h */
 
 typedef U16 cv_flags_t;
 
@@ -462,7 +465,7 @@ Unsets the PV status of an SV.
 
 =for apidoc Am|void|SvPOK_only|SV* sv
 Tells an SV that it is a string and disables all other OK bits.
-Will also turn off the UTF8 status.
+Will also turn off the UTF-8 status.
 
 =for apidoc Am|bool|SvVOK|SV* sv
 Returns a boolean indicating whether the SV contains a v-string.
@@ -526,8 +529,8 @@ Set the length of the string which is in the SV.  See C<SvCUR>.
 #define SvNIOK_off(sv)         (SvFLAGS(sv) &= ~(SVf_IOK|SVf_NOK| \
                                                  SVp_IOK|SVp_NOK|SVf_IVisUV))
 
-#ifdef __GNUC__
-#define assert_not_ROK(sv)     ({assert(!SvROK(sv) || !SvRV(sv))}),
+#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
+#define assert_not_ROK(sv)     ({assert(!SvROK(sv) || !SvRV(sv));}),
 #else
 #define assert_not_ROK(sv)     
 #endif
@@ -582,15 +585,15 @@ Set the length of the string which is in the SV.  See C<SvCUR>.
 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
 
 =for apidoc Am|void|SvUTF8_on|SV *sv
-Turn on the UTF8 status of an SV (the data is not changed, just the flag).
+Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
 Do not use frivolously.
 
 =for apidoc Am|void|SvUTF8_off|SV *sv
-Unsets the UTF8 status of an SV.
+Unsets the UTF-8 status of an SV.
 
 =for apidoc Am|void|SvPOK_only_UTF8|SV* sv
 Tells an SV that it is a string and disables all other OK bits,
-and leaves the UTF8 status as it was.
+and leaves the UTF-8 status as it was.
 
 =cut
  */
@@ -786,14 +789,16 @@ and leaves the UTF8 status as it was.
 #define IoFLAGS(sv)    ((XPVIO*)  SvANY(sv))->xio_flags
 
 /* IoTYPE(sv) is a single character telling the type of I/O connection. */
-#define IoTYPE_RDONLY  '<'
-#define IoTYPE_WRONLY  '>'
-#define IoTYPE_RDWR    '+'
-#define IoTYPE_APPEND  'a'
-#define IoTYPE_PIPE    '|'
-#define IoTYPE_STD     '-'     /* stdin or stdout */
-#define IoTYPE_SOCKET  's'
-#define IoTYPE_CLOSED  ' '
+#define IoTYPE_RDONLY          '<'
+#define IoTYPE_WRONLY          '>'
+#define IoTYPE_RDWR            '+'
+#define IoTYPE_APPEND          'a'
+#define IoTYPE_PIPE            '|'
+#define IoTYPE_STD             '-'     /* stdin or stdout */
+#define IoTYPE_SOCKET          's'
+#define IoTYPE_CLOSED          ' '
+#define IoTYPE_IMPLICIT                'I'     /* stdin or stdout or stderr */
+#define IoTYPE_NUMERIC         '#'     /* fdopen */
 
 /*
 =for apidoc Am|bool|SvTAINTED|SV* sv
@@ -801,7 +806,7 @@ Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
 not.
 
 =for apidoc Am|void|SvTAINTED_on|SV* sv
-Marks an SV as tainted.
+Marks an SV as tainted if tainting is enabled.
 
 =for apidoc Am|void|SvTAINTED_off|SV* sv
 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
@@ -812,7 +817,7 @@ standard perl fashion, via a carefully crafted regexp, rather than directly
 untainting variables.
 
 =for apidoc Am|void|SvTAINT|SV* sv
-Taints an SV if tainting is enabled
+Taints an SV if tainting is enabled.
 
 =cut
 */
@@ -999,7 +1004,7 @@ scalar.
 #define SvPVutf8x_force(sv, lp) sv_pvutf8n_force(sv, &lp)
 #define SvPVbytex_force(sv, lp) sv_pvbyten_force(sv, &lp)
 
-#if defined(__GNUC__) && !defined(__STRICT_ANSI__) && !defined(PERL_GCC_PEDANTIC)
+#if defined(__GNUC__) && !defined(PERL_GCC_BRACE_GROUPS_FORBIDDEN)
 
 #  define SvIVx(sv) ({SV *nsv = (SV*)(sv); SvIV(nsv); })
 #  define SvUVx(sv) ({SV *nsv = (SV*)(sv); SvUV(nsv); })
@@ -1225,7 +1230,7 @@ Returns a pointer to the character buffer.
 #define SvPEEK(sv) ""
 #endif
 
-#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no)
+#define SvIMMORTAL(sv) ((sv)==&PL_sv_undef || (sv)==&PL_sv_yes || (sv)==&PL_sv_no || (sv)==&PL_sv_placeholder)
 
 #define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)