This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
https://perl5.git.perl.org / perl5.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Document variants of ‘Can’t modify’ individually
[perl5.git] / pad.h
diff --git a/pad.h b/pad.h
index 30895c9..d800b19 100644 (file)
--- a/pad.h
+++ b/pad.h
@@ -31,8 +31,7 @@ typedef U64TYPE PADOFFSET;
 struct padlist {
     SSize_t    xpadl_max;      /* max index for which array has space */
     PAD **     xpadl_alloc;    /* pointer to beginning of array of AVs */
-    U32                xpadl_id;       /* Semi-unique ID, shared between clones */
-    U32                xpadl_outid;    /* ID of outer pad */
+    PADNAMELIST*xpadl_outid;   /* Padnamelist of outer pad; used as ID */
 };
 
 
@@ -136,22 +135,20 @@ typedef enum {
  * whether PL_comppad and PL_curpad are consistent and whether they have
  * active values */
 
-#ifndef PERL_MAD
 #  define pad_peg(label)
-#endif
 
 #ifdef DEBUGGING
 #  define ASSERT_CURPAD_LEGAL(label) \
     pad_peg(label); \
     if (PL_comppad ? (AvARRAY(PL_comppad) != PL_curpad) : (PL_curpad != 0))  \
-       Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%"UVxf"[0x%"UVxf"]",\
+       Perl_croak(aTHX_ "panic: illegal pad in %s: 0x%" UVxf "[0x%" UVxf "]",\
            label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
 
 
 #  define ASSERT_CURPAD_ACTIVE(label) \
     pad_peg(label); \
     if (!PL_comppad || (AvARRAY(PL_comppad) != PL_curpad))               \
-       Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%"UVxf"[0x%"UVxf"]",\
+       Perl_croak(aTHX_ "panic: invalid pad in %s: 0x%" UVxf "[0x%" UVxf "]",\
            label, PTR2UV(PL_comppad), PTR2UV(PL_curpad));
 #else
 #  define ASSERT_CURPAD_LEGAL(label)
@@ -169,62 +166,73 @@ Save a pad slot (used to restore after an iteration)
 
 XXX DAPM it would make more sense to make the arg a PADOFFSET
 =for apidoc m|void|SAVECLEARSV |SV **svp
-Clear the pointed to pad value on scope exit. (i.e. the runtime action of 'my')
+Clear the pointed to pad value on scope exit.  (i.e. the runtime action of
+'my')
 
 =for apidoc m|void|SAVECOMPPAD
 save PL_comppad and PL_curpad
 
 
-=for apidoc Amx|PAD **|PADLIST_ARRAY|PADLIST padlist
+=for apidoc Amx|PAD **|PadlistARRAY|PADLIST padlist
 The C array of a padlist, containing the pads.  Only subscript it with
 numbers >= 1, as the 0th entry is not guaranteed to remain usable.
 
-=for apidoc Amx|SSize_t|PADLIST_MAX|PADLIST padlist
-The index of the last pad in the padlist.
+=for apidoc Amx|SSize_t|PadlistMAX|PADLIST padlist
+The index of the last allocated space in the padlist.  Note that the last
+pad may be in an earlier slot.  Any entries following it will be NULL in
+that case.
 
-=for apidoc Amx|PADNAMELIST *|PADLIST_NAMES|PADLIST padlist
+=for apidoc Amx|PADNAMELIST *|PadlistNAMES|PADLIST padlist
 The names associated with pad entries.
 
-=for apidoc Amx|PADNAME **|PADLIST_NAMESARRAY|PADLIST padlist
+=for apidoc Amx|PADNAME **|PadlistNAMESARRAY|PADLIST padlist
 The C array of pad names.
 
-=for apidoc Amx|SSize_t|PADLIST_NAMESMAX|PADLIST padlist
+=for apidoc Amx|SSize_t|PadlistNAMESMAX|PADLIST padlist
 The index of the last pad name.
 
-=for apidoc Amx|U32|PADLIST_REFCNT|PADLIST padlist
+=for apidoc Amx|U32|PadlistREFCNT|PADLIST padlist
 The reference count of the padlist.  Currently this is always 1.
 
-=for apidoc Amx|PADNAME **|PADNAMELIST_ARRAY|PADNAMELIST pnl
+=for apidoc Amx|PADNAME **|PadnamelistARRAY|PADNAMELIST pnl
 The C array of pad names.
 
-=for apidoc Amx|SSize_t|PADNAMELIST_MAX|PADNAMELIST pnl
+=for apidoc Amx|SSize_t|PadnamelistMAX|PADNAMELIST pnl
 The index of the last pad name.
 
-=for apidoc Amx|SV **|PAD_ARRAY|PAD pad
+=for apidoc Amx|SV **|PadARRAY|PAD pad
 The C array of pad entries.
 
-=for apidoc Amx|SSize_t|PAD_MAX|PAD pad
+=for apidoc Amx|SSize_t|PadMAX|PAD pad
 The index of the last pad entry.
 
-=for apidoc Amx|char *|PADNAME_PV|PADNAME pn   
-The name stored in the pad name struct.
+=for apidoc Amx|char *|PadnamePV|PADNAME pn    
+The name stored in the pad name struct.  This returns NULL for a target or
+GV slot.
 
-=for apidoc Amx|STRLEN|PADNAME_LEN|PADNAME pn  
+=for apidoc Amx|STRLEN|PadnameLEN|PADNAME pn   
 The length of the name.
 
-=for apidoc Amx|bool|PADNAME_UTF8|PADNAME pn
-Whether PADNAME_PV is in UTF8.
+=for apidoc Amx|bool|PadnameUTF8|PADNAME pn
+Whether PadnamePV is in UTF8.
+
+=for apidoc Amx|SV *|PadnameSV|PADNAME pn
+Returns the pad name as an SV.  This is currently just C<pn>.  It will
+begin returning a new mortal SV if pad names ever stop being SVs.
 
-=for apidoc m|bool|PADNAME_isOUR|PADNAME pn
+=for apidoc m|bool|PadnameIsOUR|PADNAME pn
 Whether this is an "our" variable.
 
-=for apidoc m|HV *|PADNAME_OURSTASH
+=for apidoc m|HV *|PadnameOURSTASH
 The stash in which this "our" variable was declared.
 
-=for apidoc m|bool|PADNAME_OUTER|PADNAME pn
+=for apidoc m|bool|PadnameOUTER|PADNAME pn
 Whether this entry belongs to an outer pad.
 
-=for apidoc m|HV *|PADNAME_TYPE|PADNAME pn
+=for apidoc m|bool|PadnameIsSTATE|PADNAME pn
+Whether this is a "state" variable.
+
+=for apidoc m|HV *|PadnameTYPE|PADNAME pn
 The stash associated with a typed lexical.  This returns the %Foo:: hash
 for C<my Foo $bar>.
 
@@ -232,7 +240,7 @@ for C<my Foo $bar>.
 =for apidoc m|SV *|PAD_SETSV   |PADOFFSET po|SV* sv
 Set the slot at offset C<po> in the current pad to C<sv>
 
-=for apidoc m|void|PAD_SV      |PADOFFSET po
+=for apidoc m|SV *|PAD_SV      |PADOFFSET po
 Get the value at offset C<po> in the current pad
 
 =for apidoc m|SV *|PAD_SVl     |PADOFFSET po
@@ -246,7 +254,7 @@ Get the value from slot C<po> in the base (DEPTH=1) pad of a padlist
 
 =for apidoc m|void|PAD_SET_CUR |PADLIST padlist|I32 n
 Set the current pad to be pad C<n> in the padlist, saving
-the previous current pad. NB currently this macro expands to a string too
+the previous current pad.  NB currently this macro expands to a string too
 long for some compilers, so it's best to replace it with
 
     SAVECOMPPAD();
@@ -269,26 +277,30 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
 =cut
 */
 
-#define PADLIST_ARRAY(pl)      (pl)->xpadl_alloc
-#define PADLIST_MAX(pl)                (pl)->xpadl_max
-#define PADLIST_NAMES(pl)      (*PADLIST_ARRAY(pl))
-#define PADLIST_NAMESARRAY(pl) PADNAMELIST_ARRAY(PADLIST_NAMES(pl))
-#define PADLIST_NAMESMAX(pl)   PADNAMELIST_MAX(PADLIST_NAMES(pl))
-#define PADLIST_REFCNT(pl)     1       /* reserved for future use */
+#define PadlistARRAY(pl)       (pl)->xpadl_alloc
+#define PadlistMAX(pl)         (pl)->xpadl_max
+#define PadlistNAMES(pl)       (*PadlistARRAY(pl))
+#define PadlistNAMESARRAY(pl)  PadnamelistARRAY(PadlistNAMES(pl))
+#define PadlistNAMESMAX(pl)    PadnamelistMAX(PadlistNAMES(pl))
+#define PadlistREFCNT(pl)      1       /* reserved for future use */
 
-#define PADNAMELIST_ARRAY(pnl) AvARRAY(pnl)
-#define PADNAMELIST_MAX(pnl)   AvFILLp(pnl)
+#define PadnamelistARRAY(pnl)  AvARRAY(pnl)
+#define PadnamelistMAX(pnl)    AvFILLp(pnl)
+#define PadnamelistMAXNAMED(pnl) \
+       ((XPVAV*) SvANY(pnl))->xmg_u.xmg_hash_index
 
-#define PAD_ARRAY(pad)         AvARRAY(pad)
-#define PAD_MAX(pad)           AvFILLp(pad)
+#define PadARRAY(pad)          AvARRAY(pad)
+#define PadMAX(pad)            AvFILLp(pad)
 
-#define PADNAME_PV(pn)         SvPV_nolen(pn)
-#define PADNAME_LEN(pn)                SvCUR(pn)
-#define PADNAME_UTF8(pn)       !!SvUTF8(pn)
-#define PADNAME_isOUR(pn)      !!SvPAD_OUR(pn)
-#define PADNAME_OURSTASH       SvOURSTASH(pn)
-#define PADNAME_OUTER          !!SvFAKE(pn)
-#define PADNAME_TYPE(pn)       (SvPAD_TYPED(pn) ? SvSTASH(pn) : NULL)
+#define PadnamePV(pn)          (SvPOKp(pn) ? SvPVX(pn) : NULL)
+#define PadnameLEN(pn)         ((pn) == &PL_sv_undef ? 0 : SvCUR(pn))
+#define PadnameUTF8(pn)                !!SvUTF8(pn)
+#define PadnameSV(pn)          pn
+#define PadnameIsOUR(pn)       !!SvPAD_OUR(pn)
+#define PadnameOURSTASH(pn)    SvOURSTASH(pn)
+#define PadnameOUTER(pn)       !!SvFAKE(pn)
+#define PadnameIsSTATE(pn)     !!SvPAD_STATE(pn)
+#define PadnameTYPE(pn)                (SvPAD_TYPED(pn) ? SvSTASH(pn) : NULL)
 
 
 #ifdef DEBUGGING
@@ -302,16 +314,16 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
 #define PAD_SVl(po)       (PL_curpad[po])
 
 #define PAD_BASE_SV(padlist, po) \
-       (PADLIST_ARRAY(padlist)[1])                                     \
-           ? AvARRAY(MUTABLE_AV((PADLIST_ARRAY(padlist)[1])))[po] \
+       (PadlistARRAY(padlist)[1])                                      \
+           ? AvARRAY(MUTABLE_AV((PadlistARRAY(padlist)[1])))[po] \
            : NULL;
 
 
 #define PAD_SET_CUR_NOSAVE(padlist,nth) \
-       PL_comppad = (PAD*) (PADLIST_ARRAY(padlist)[nth]);      \
+       PL_comppad = (PAD*) (PadlistARRAY(padlist)[nth]);       \
        PL_curpad = AvARRAY(PL_comppad);                        \
        DEBUG_Xv(PerlIO_printf(Perl_debug_log,                  \
-             "Pad 0x%"UVxf"[0x%"UVxf"] set_cur    depth=%d\n", \
+             "Pad 0x%" UVxf "[0x%" UVxf "] set_cur    depth=%d\n",     \
              PTR2UV(PL_comppad), PTR2UV(PL_curpad), (int)(nth)));
 
 
@@ -329,7 +341,7 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
        PL_comppad = (npad);                                    \
        PL_curpad =  PL_comppad ? AvARRAY(PL_comppad) : NULL;   \
        DEBUG_Xv(PerlIO_printf(Perl_debug_log,                  \
-             "Pad 0x%"UVxf"[0x%"UVxf"] save_local\n",          \
+             "Pad 0x%" UVxf "[0x%" UVxf "] save_local\n",              \
              PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
 
 #define PAD_RESTORE_LOCAL(opad) \
@@ -337,7 +349,7 @@ Restore the old pad saved into the local variable opad by PAD_SAVE_LOCAL()
        PL_comppad = opad;                                              \
        PL_curpad =  PL_comppad ? AvARRAY(PL_comppad) : NULL;   \
        DEBUG_Xv(PerlIO_printf(Perl_debug_log,                  \
-             "Pad 0x%"UVxf"[0x%"UVxf"] restore_local\n",       \
+             "Pad 0x%" UVxf "[0x%" UVxf "] restore_local\n",   \
              PTR2UV(PL_comppad), PTR2UV(PL_curpad)));
 
 
@@ -359,15 +371,15 @@ context block structure (can be used as an lvalue).
 /*
 =for apidoc m|U32|PAD_COMPNAME_FLAGS|PADOFFSET po
 Return the flags for the current compiling pad name
-at offset C<po>. Assumes a valid slot entry.
+at offset C<po>.  Assumes a valid slot entry.
 
 =for apidoc m|char *|PAD_COMPNAME_PV|PADOFFSET po
 Return the name of the current compiling pad name
-at offset C<po>. Assumes a valid slot entry.
+at offset C<po>.  Assumes a valid slot entry.
 
 =for apidoc m|HV *|PAD_COMPNAME_TYPE|PADOFFSET po
 Return the type (stash) of the current compiling pad name at offset
-C<po>. Must be a valid name. Returns null if not typed.
+C<po>.  Must be a valid name.  Returns null if not typed.
 
 =for apidoc m|HV *|PAD_COMPNAME_OURSTASH|PADOFFSET po
 Return the stash associated with an C<our> variable.
@@ -375,7 +387,7 @@ Assumes the slot entry is a valid C<our> lexical.
 
 =for apidoc m|STRLEN|PAD_COMPNAME_GEN|PADOFFSET po
 The generation number of the name at offset C<po> in the current
-compiling pad (lvalue). Note that C<SvUVX> is hijacked for this purpose.
+compiling pad (lvalue).  Note that C<SvUVX> is hijacked for this purpose.
 
 =for apidoc m|STRLEN|PAD_COMPNAME_GEN_set|PADOFFSET po|int gen
 Sets the generation number of the name at offset C<po> in the current
@@ -386,7 +398,7 @@ ling pad (lvalue) to C<gen>.  Note that C<SvUV_set> is hijacked for this purpose
 */
 
 #define PAD_COMPNAME(po)       PAD_COMPNAME_SV(po)
-#define PAD_COMPNAME_SV(po) (*av_fetch(PL_comppad_name, (po), FALSE))
+#define PAD_COMPNAME_SV(po) (AvARRAY(PL_comppad_name)[(po)])
 #define PAD_COMPNAME_FLAGS(po) SvFLAGS(PAD_COMPNAME_SV(po))
 #define PAD_COMPNAME_FLAGS_isOUR(po) SvPAD_OUR(PAD_COMPNAME_SV(po))
 #define PAD_COMPNAME_PV(po) SvPV_nolen(PAD_COMPNAME_SV(po))
Unnamed repository; edit this file 'description' to name the repository.