This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Remove the MANIFEST check from the release guide
[perl5.git] / pod / perlguts.pod
index e77d6b8..40b66ca 100644 (file)
@@ -597,7 +597,7 @@ The most useful types that will be returned are:
     SVt_PVAV  Array
     SVt_PVHV  Hash
     SVt_PVCV  Code
-    SVt_PVGV  Glob (possible a file handle)
+    SVt_PVGV  Glob (possibly a file handle)
     SVt_PVMG  Blessed or Magical Scalar
 
 See the F<sv.h> header file for more details.
@@ -1035,19 +1035,28 @@ The current kinds of Magic Virtual Tables are:
     (old-style char and macro)   MGVTBL          Type of magic
     --------------------------   ------          -------------
     \0 PERL_MAGIC_sv             vtbl_sv         Special scalar variable
+    #  PERL_MAGIC_arylen         vtbl_arylen     Array length ($#ary)
+    %  PERL_MAGIC_rhash          (none)          extra data for restricted
+                                                 hashes
+    .  PERL_MAGIC_pos            vtbl_pos        pos() lvalue
+    :  PERL_MAGIC_symtab         (none)          extra data for symbol tables
+    <  PERL_MAGIC_backref        vtbl_backref    for weak ref data
+    @  PERL_MAGIC_arylen_p       (none)          to move arylen out of XPVAV
     A  PERL_MAGIC_overload       vtbl_amagic     %OVERLOAD hash
     a  PERL_MAGIC_overload_elem  vtbl_amagicelem %OVERLOAD hash element
-    c  PERL_MAGIC_overload_table (none)          Holds overload table (AMT)
-                                                 on stash
-    B  PERL_MAGIC_bm             vtbl_bm         Boyer-Moore (fast string search)
-    D  PERL_MAGIC_regdata        vtbl_regdata    Regex match position data
+    B  PERL_MAGIC_bm             vtbl_regexp     Boyer-Moore 
+                                                 (fast string search)
+    c  PERL_MAGIC_overload_table vtbl_ovrld      Holds overload table 
+                                                 (AMT) on stash
+    D  PERL_MAGIC_regdata        vtbl_regdata    Regex match position data 
                                                  (@+ and @- vars)
     d  PERL_MAGIC_regdatum       vtbl_regdatum   Regex match position data
                                                  element
     E  PERL_MAGIC_env            vtbl_env        %ENV hash
     e  PERL_MAGIC_envelem        vtbl_envelem    %ENV hash element
-    f  PERL_MAGIC_fm             vtbl_fm         Formline ('compiled' format)
-    g  PERL_MAGIC_regex_global   vtbl_mglob      m//g target / study()ed string
+    f  PERL_MAGIC_fm             vtbl_regdata    Formline ('compiled' format)
+    G  PERL_MAGIC_study          vtbl_regdata    study()ed string
+    g  PERL_MAGIC_regex_global   vtbl_mglob      m//g target
     H  PERL_MAGIC_hints          vtbl_hints      %^H hash
     h  PERL_MAGIC_hintselem      vtbl_hintselem  %^H hash element
     I  PERL_MAGIC_isa            vtbl_isa        @ISA array
@@ -1055,29 +1064,28 @@ The current kinds of Magic Virtual Tables are:
     k  PERL_MAGIC_nkeys          vtbl_nkeys      scalar(keys()) lvalue
     L  PERL_MAGIC_dbfile         (none)          Debugger %_<filename
     l  PERL_MAGIC_dbline         vtbl_dbline     Debugger %_<filename element
-    o  PERL_MAGIC_collxfrm       vtbl_collxfrm   Locale collate transformation
+    N  PERL_MAGIC_shared         (none)          Shared between threads
+    n  PERL_MAGIC_shared_scalar  (none)          Shared between threads
+    o  PERL_MAGIC_collxfrm       vtbl_collxfrm   Locale transformation
     P  PERL_MAGIC_tied           vtbl_pack       Tied array or hash
     p  PERL_MAGIC_tiedelem       vtbl_packelem   Tied array or hash element
     q  PERL_MAGIC_tiedscalar     vtbl_packelem   Tied scalar or handle
-    r  PERL_MAGIC_qr             vtbl_qr         precompiled qr// regex
-    S  PERL_MAGIC_sig            vtbl_sig        %SIG hash
+    r  PERL_MAGIC_qr             vtbl_regexp     precompiled qr// regex
+    S  PERL_MAGIC_sig            (none)          %SIG hash
     s  PERL_MAGIC_sigelem        vtbl_sigelem    %SIG hash element
     t  PERL_MAGIC_taint          vtbl_taint      Taintedness
     U  PERL_MAGIC_uvar           vtbl_uvar       Available for use by extensions
+    u  PERL_MAGIC_uvar_elem      (none)          Reserved for use by extensions
+    V  PERL_MAGIC_vstring        (none)          SV was vstring literal
     v  PERL_MAGIC_vec            vtbl_vec        vec() lvalue
-    V  PERL_MAGIC_vstring        (none)          v-string scalars
-    w  PERL_MAGIC_utf8           vtbl_utf8       UTF-8 length+offset cache
+    w  PERL_MAGIC_utf8           vtbl_utf8       Cached UTF-8 information
     x  PERL_MAGIC_substr         vtbl_substr     substr() lvalue
     y  PERL_MAGIC_defelem        vtbl_defelem    Shadow "foreach" iterator
                                                  variable / smart parameter
                                                  vivification
-    #  PERL_MAGIC_arylen         vtbl_arylen     Array length ($#ary)
-    .  PERL_MAGIC_pos            vtbl_pos        pos() lvalue
-    <  PERL_MAGIC_backref        vtbl_backref    back pointer to a weak ref 
+    ]  PERL_MAGIC_checkcall      (none)          inlining/mutation of call to
+                                                 this CV
     ~  PERL_MAGIC_ext            (none)          Available for use by extensions
-    :  PERL_MAGIC_symtab         (none)          hash used as symbol table
-    %  PERL_MAGIC_rhash          (none)          hash used as restricted hash
-    @  PERL_MAGIC_arylen_p       vtbl_arylen_p   pointer to $#a from @a
 
 
 When an uppercase and lowercase letter both exist in the table, then the
@@ -1490,6 +1498,28 @@ C<m(X)PUSH[iunp]> macros instead; see L</Putting a C value on Perl stack>.
 
 For more information, consult L<perlxs> and L<perlxstut>.
 
+=head2 Autoloading with XSUBs
+
+If an AUTOLOAD routine is an XSUB, as with Perl subroutines, Perl puts the
+fully-qualified name of the autoloaded subroutine in the $AUTOLOAD variable
+of the XSUB's package.
+
+But it also puts the same information in certain fields of the XSUB itself:
+
+    HV *stash           = CvSTASH(cv);
+    const char *subname = SvPVX(cv);
+    STRLEN name_length  = SvCUR(cv); /* in bytes */
+    U32 is_utf8         = SvUTF8(cv);
+    
+C<SvPVX(cv)> contains just the sub name itself, not including the package.
+For an AUTOLOAD routine in UNIVERSAL or one of its superclasses,
+C<CvSTASH(cv)> returns NULL during a method call on a nonexistent package.
+
+B<Note>: Setting $AUTOLOAD stopped working in 5.6.1, which did not support
+XS AUTOLOAD subs at all.  Perl 5.8.0 introduced the use of fields in the
+XSUB itself.  Perl 5.16.0 restored the setting of $AUTOLOAD.  If you need
+to support 5.8-5.14, use the XSUB's fields.
+
 =head2 Calling Perl Routines from within C Programs
 
 There are four routines that can be used to call a Perl subroutine from