Add a new flag SVprv_PCS_IMPORTED (which is a pseudonym for SVf_SCREAM)
[p5sagit/p5-mst-13.2.git] / sv.h
diff --git a/sv.h b/sv.h
index 8b1f385..9265197 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -283,52 +283,56 @@ perform the upgrade if necessary.  See C<svtype>.
 
 #define SvUPGRADE(sv, mt) (SvTYPE(sv) >= (mt) || (sv_upgrade(sv, mt), 1))
 
-#define SVf_IOK                0x00000100      /* has valid public integer value */
-#define SVf_NOK                0x00000200      /* has valid public numeric value */
-#define SVf_POK                0x00000400      /* has valid public pointer value */
-#define SVf_ROK                0x00000800      /* has a valid reference pointer */
-
-#define SVp_IOK                0x00001000      /* has valid non-public integer value */
-#define SVp_NOK                0x00002000      /* has valid non-public numeric value */
-#define SVp_POK                0x00004000      /* has valid non-public pointer value */
-#define SVp_SCREAM     0x00008000      /* has been studied? */
-#define SVphv_CLONEABLE        0x00008000      /* PVHV (stashes) clone its objects */
-
-#define SVs_PADSTALE   0x00010000      /* lexical has gone out of scope */
-#define SVpad_STATE    0x00010000      /* pad name is a "state" var */
-#define SVs_PADTMP     0x00020000      /* in use as tmp */
-#define SVpad_TYPED    0x00020000      /* pad name is a Typed Lexical */
-#define SVs_PADMY      0x00040000      /* in use a "my" variable */
-#define SVpad_OUR      0x00040000      /* pad name is "our" instead of "my" */
-#define SVs_TEMP       0x00080000      /* string is stealable? */
-#define SVs_OBJECT     0x00100000      /* is "blessed" */
-#define SVs_GMG                0x00200000      /* has magical get method */
-#define SVs_SMG                0x00400000      /* has magical set method */
-#define SVs_RMG                0x00800000      /* has random magical methods */
-
-#define SVf_FAKE       0x01000000      /* 0: glob or lexical is just a copy
-                                          1: SV head arena wasn't malloc()ed
-                                          2: in conjunction with SVf_READONLY
-                                             marks a shared hash key scalar
-                                             (SvLEN == 0) or a copy on write
-                                             string (SvLEN != 0) [SvIsCOW(sv)]
-                                          3: For PVCV, whether CvUNIQUE(cv)
-                                             refers to an eval or once only
-                                             [CvEVAL(cv), CvSPECIAL(cv)]
-                                          4: Whether the regexp pointer is in
-                                             fact an offset [SvREPADTMP(sv)]
-                                          5: On a pad name SV, that slot in the
-                                             frame AV is a REFCNT'ed reference
-                                             to a lexical from "outside". */
-#define SVphv_REHASH   SVf_FAKE        /* 6: On a PVHV, hash values are being
-                                             recalculated */
-#define SVf_OOK                0x02000000      /* has valid offset value
-                                          For a PVHV this means that a
-                                          hv_aux struct is present after the
-                                          main array  */
-#define SVf_BREAK      0x04000000      /* refcnt is artificially low - used
-                                        * by SV's in final arena  cleanup */
-#define SVf_READONLY   0x08000000      /* may not be modified */
+#define SVf_IOK                0x00000100  /* has valid public integer value */
+#define SVf_NOK                0x00000200  /* has valid public numeric value */
+#define SVf_POK                0x00000400  /* has valid public pointer value */
+#define SVf_ROK                0x00000800  /* has a valid reference pointer */
+
+#define SVp_IOK                0x00001000  /* has valid non-public integer value */
+#define SVp_NOK                0x00002000  /* has valid non-public numeric value */
+#define SVp_POK                0x00004000  /* has valid non-public pointer value */
+#define SVp_SCREAM     0x00008000  /* has been studied? */
+#define SVphv_CLONEABLE        SVp_SCREAM  /* PVHV (stashes) clone its objects */
+#define SVpgv_GP       SVp_SCREAM  /* GV has a valid GP */
+#define SVprv_PCS_IMPORTED  SVp_SCREAM  /* RV is a proxy for a constant
+                                      subroutine in another package. Set the
+                                      CvIMPORTED_CV_ON() if it needs to be
+                                      expanded to a real GV */
+
+#define SVs_PADSTALE   0x00010000  /* lexical has gone out of scope */
+#define SVpad_STATE    0x00010000  /* pad name is a "state" var */
+#define SVs_PADTMP     0x00020000  /* in use as tmp */
+#define SVpad_TYPED    0x00020000  /* pad name is a Typed Lexical */
+#define SVs_PADMY      0x00040000  /* in use a "my" variable */
+#define SVpad_OUR      0x00040000  /* pad name is "our" instead of "my" */
+#define SVs_TEMP       0x00080000  /* string is stealable? */
+#define SVs_OBJECT     0x00100000  /* is "blessed" */
+#define SVs_GMG                0x00200000  /* has magical get method */
+#define SVs_SMG                0x00400000  /* has magical set method */
+#define SVs_RMG                0x00800000  /* has random magical methods */
+
+#define SVf_FAKE       0x01000000  /* 0: glob or lexical is just a copy
+                                      1: SV head arena wasn't malloc()ed
+                                      2: in conjunction with SVf_READONLY
+                                         marks a shared hash key scalar
+                                         (SvLEN == 0) or a copy on write
+                                         string (SvLEN != 0) [SvIsCOW(sv)]
+                                      3: For PVCV, whether CvUNIQUE(cv)
+                                         refers to an eval or once only
+                                         [CvEVAL(cv), CvSPECIAL(cv)]
+                                      4: Whether the regexp pointer is in
+                                         fact an offset [SvREPADTMP(sv)]
+                                      5: On a pad name SV, that slot in the
+                                         frame AV is a REFCNT'ed reference
+                                         to a lexical from "outside". */
+#define SVphv_REHASH   SVf_FAKE    /* 6: On a PVHV, hash values are being
+                                         recalculated */
+#define SVf_OOK                0x02000000  /* has valid offset value. For a PVHV this
+                                      means that a hv_aux struct is present
+                                      after the main array */
+#define SVf_BREAK      0x04000000  /* refcnt is artificially low - used by
+                                      SV's in final arena  cleanup */
+#define SVf_READONLY   0x08000000  /* may not be modified */
 
 
 
@@ -336,46 +340,49 @@ perform the upgrade if necessary.  See C<svtype>.
 #define SVf_THINKFIRST (SVf_READONLY|SVf_ROK|SVf_FAKE)
 
 #define SVf_OK         (SVf_IOK|SVf_NOK|SVf_POK|SVf_ROK| \
-                        SVp_IOK|SVp_NOK|SVp_POK|SVp_SCREAM)
+                        SVp_IOK|SVp_NOK|SVp_POK|SVpgv_GP)
 
 #define PRIVSHIFT 4    /* (SVp_?OK >> PRIVSHIFT) == SVf_?OK */
 
-#define SVf_AMAGIC     0x10000000      /* has magical overloaded methods */
-#define SVf_UTF8        0x20000000      /* SvPV is UTF-8 encoded */
+#define SVf_AMAGIC     0x10000000  /* has magical overloaded methods */
+#define SVf_UTF8        0x20000000  /* SvPV is UTF-8 encoded
+                                      This is also set on RVs whose overloaded
+                                      stringification is UTF-8. This might
+                                      only happen as a side effect of SvPV() */
+                                          
 /* Ensure this value does not clash with the GV_ADD* flags in gv.h */
 
 /* Some private flags. */
 
 /* PVHV */
-#define SVphv_SHAREKEYS 0x20000000     /* PVHV
-                                          keys live on shared string table */
+#define SVphv_SHAREKEYS 0x20000000  /* PVHV keys live on shared string table */
 /* PVNV, PVMG, presumably only inside pads */
-#define SVpad_NAME     0x40000000      /* This SV is a name in the PAD, so
-                                          SVpad_TYPED, SVpad_OUR and
-                                          SVpad_STATE apply */
+#define SVpad_NAME     0x40000000  /* This SV is a name in the PAD, so
+                                      SVpad_TYPED, SVpad_OUR and SVpad_STATE
+                                      apply */
 /* PVAV */
-#define SVpav_REAL     0x40000000      /* free old entries */
+#define SVpav_REAL     0x40000000  /* free old entries */
 /* PVHV */
-#define SVphv_LAZYDEL  0x40000000      /* entry in xhv_eiter must be deleted */
+#define SVphv_LAZYDEL  0x40000000  /* entry in xhv_eiter must be deleted */
 /* This is only set true on a PVGV when it's playing "PVBM", but is tested for
    on any regular scalar (anything <= PVLV) */
 #define SVpbm_VALID    0x40000000
 /* ??? */
-#define SVrepl_EVAL    0x40000000      /* Replacement part of s///e */
+#define SVrepl_EVAL    0x40000000  /* Replacement part of s///e */
 
 /* IV, PVIV, PVNV, PVMG, PVGV and (I assume) PVLV  */
 /* Presumably IVs aren't stored in pads */
-#define SVf_IVisUV     0x80000000      /* use XPVUV instead of XPVIV */
+#define SVf_IVisUV     0x80000000  /* use XPVUV instead of XPVIV */
 /* PVAV */
-#define SVpav_REIFY    0x80000000      /* can become real */
+#define SVpav_REIFY    0x80000000  /* can become real */
 /* PVHV */
-#define SVphv_HASKFLAGS        0x80000000      /* keys have flag byte after hash */
+#define SVphv_HASKFLAGS        0x80000000  /* keys have flag byte after hash */
 /* PVFM */
-#define SVpfm_COMPILED 0x80000000      /* FORMLINE is compiled */
+#define SVpfm_COMPILED 0x80000000  /* FORMLINE is compiled */
 /* PVGV when SVpbm_VALID is true */
 #define SVpbm_TAIL     0x80000000
 /* RV upwards. However, SVf_ROK and SVp_IOK are exclusive  */
-#define SVprv_WEAKREF   0x80000000      /* Weak reference */
+#define SVprv_WEAKREF   0x80000000  /* Weak reference */
 
 
 struct xpv {
@@ -903,6 +910,8 @@ Set the actual length of the string which is in the SV.  See C<SvIV_set>.
 /*
 =for apidoc Am|bool|SvUTF8|SV* sv
 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
+Call this after SvPV() in case any call to string overloading updates the
+internal flag.
 
 =for apidoc Am|void|SvUTF8_on|SV *sv
 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
@@ -1008,6 +1017,11 @@ the scalar's value cannot change unless written to.
 #define SvWEAKREF_on(sv)       (SvFLAGS(sv) |=  (SVf_ROK|SVprv_WEAKREF))
 #define SvWEAKREF_off(sv)      (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_WEAKREF))
 
+#define SvPCS_IMPORTED(sv)     ((SvFLAGS(sv) & (SVf_ROK|SVprv_PCS_IMPORTED)) \
+                                == (SVf_ROK|SVprv_PCS_IMPORTED))
+#define SvPCS_IMPORTED_on(sv)  (SvFLAGS(sv) |=  (SVf_ROK|SVprv_PCS_IMPORTED))
+#define SvPCS_IMPORTED_off(sv) (SvFLAGS(sv) &= ~(SVf_ROK|SVprv_PCS_IMPORTED))
+
 #define SvTHINKFIRST(sv)       (SvFLAGS(sv) & SVf_THINKFIRST)
 
 #define SvPADSTALE(sv)         (SvFLAGS(sv) & SVs_PADSTALE)
@@ -1334,8 +1348,13 @@ the scalar's value cannot change unless written to.
 #define PERL_FBM_TABLE_OFFSET 5        /* Number of bytes between EOS and table */
 #define PERL_FBM_FLAGS_OFFSET_FROM_TABLE -1
 /* how many characters in string before rare? */
-#define PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE -2
-#define PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE -3
+#if (BYTEORDER == 0x4321) || (BYTEORDER == 0x87654321)
+#  define PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE -2
+#  define PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE -3
+#else
+#  define PERL_FBM_PREVIOUS_H_OFFSET_FROM_TABLE -2
+#  define PERL_FBM_PREVIOUS_L_OFFSET_FROM_TABLE -3
+#endif
 /* rarest character in string */
 #define PERL_FBM_RARE_OFFSET_FROM_TABLE -4
 
@@ -1965,8 +1984,23 @@ Returns a pointer to the character buffer.
 /* If I give every macro argument a different name, then there won't be bugs
    where nested macros get confused. Been there, done that.  */
 #define isGV_with_GP(pwadak) \
-       (((SvFLAGS(pwadak) & (SVp_POK|SVp_SCREAM)) == SVp_SCREAM)       \
+       (((SvFLAGS(pwadak) & (SVp_POK|SVpgv_GP)) == SVpgv_GP)   \
        && (SvTYPE(pwadak) == SVt_PVGV || SvTYPE(pwadak) == SVt_PVLV))
+#define isGV_with_GP_on(sv)    STMT_START {                           \
+       GV *const uggh = (GV*) sv;                                     \
+       assert (SvTYPE(uggh) == SVt_PVGV || SvTYPE(uggh) == SVt_PVLV); \
+       assert (!SvPOKp(uggh));                                        \
+       assert (!SvIOKp(uggh));                                        \
+       (SvFLAGS(uggh) |= SVpgv_GP);                                   \
+    } STMT_END
+#define isGV_with_GP_off(sv)   STMT_START {                           \
+       GV *const uggh = (GV *) sv;                                    \
+       assert (SvTYPE(uggh) == SVt_PVGV || SvTYPE(uggh) == SVt_PVLV); \
+       assert (!SvPOKp(uggh));                                        \
+       assert (!SvIOKp(uggh));                                        \
+       (SvFLAGS(sv) &= ~SVpgv_GP);                                    \
+    } STMT_END
+
 
 #define SvGROW(sv,len) (SvLEN(sv) < (len) ? sv_grow(sv,len) : SvPVX(sv))
 #define SvGROW_mutable(sv,len) \