This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
more cleanup: avoid unused knowledge of "file GV" notion in CV and GV
[perl5.git] / cv.h
1 /*    cv.h
2  *
3  *    Copyright (c) 1991-1999, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 /* This structure much match the beginning of XPVFM */
11
12 struct xpvcv {
13     char *      xpv_pv;         /* pointer to malloced string */
14     STRLEN      xpv_cur;        /* length of xp_pv as a C string */
15     STRLEN      xpv_len;        /* allocated size */
16     IV          xof_off;        /* integer value */
17     NV          xnv_nv;         /* numeric value, if any */
18     MAGIC*      xmg_magic;      /* magic for scalar array */
19     HV*         xmg_stash;      /* class package */
20
21     HV *        xcv_stash;
22     OP *        xcv_start;
23     OP *        xcv_root;
24     void        (*xcv_xsub) (pTHXo_ CV*);
25     ANY         xcv_xsubany;
26     GV *        xcv_gv;
27 #if defined(PERL_BINCOMPAT_5005)
28     GV *        xcv_filegv;     /* XXX unused (and deprecated) */
29 #endif
30     long        xcv_depth;      /* >= 2 indicates recursive call */
31     AV *        xcv_padlist;
32     CV *        xcv_outside;
33 #ifdef USE_THREADS
34     perl_mutex *xcv_mutexp;
35     struct perl_thread *xcv_owner;      /* current owner thread */
36 #endif /* USE_THREADS */
37     cv_flags_t  xcv_flags;
38 };
39
40 #define Nullcv Null(CV*)
41
42 #define CvSTASH(sv)     ((XPVCV*)SvANY(sv))->xcv_stash
43 #define CvSTART(sv)     ((XPVCV*)SvANY(sv))->xcv_start
44 #define CvROOT(sv)      ((XPVCV*)SvANY(sv))->xcv_root
45 #define CvXSUB(sv)      ((XPVCV*)SvANY(sv))->xcv_xsub
46 #define CvXSUBANY(sv)   ((XPVCV*)SvANY(sv))->xcv_xsubany
47 #define CvGV(sv)        ((XPVCV*)SvANY(sv))->xcv_gv
48 #define CvDEPTH(sv)     ((XPVCV*)SvANY(sv))->xcv_depth
49 #define CvPADLIST(sv)   ((XPVCV*)SvANY(sv))->xcv_padlist
50 #define CvOUTSIDE(sv)   ((XPVCV*)SvANY(sv))->xcv_outside
51 #ifdef USE_THREADS
52 #define CvMUTEXP(sv)    ((XPVCV*)SvANY(sv))->xcv_mutexp
53 #define CvOWNER(sv)     ((XPVCV*)SvANY(sv))->xcv_owner
54 #endif /* USE_THREADS */
55 #define CvFLAGS(sv)     ((XPVCV*)SvANY(sv))->xcv_flags
56
57 #define CVf_CLONE       0x0001  /* anon CV uses external lexicals */
58 #define CVf_CLONED      0x0002  /* a clone of one of those */
59 #define CVf_ANON        0x0004  /* CvGV() can't be trusted */
60 #define CVf_OLDSTYLE    0x0008
61 #define CVf_UNIQUE      0x0010  /* can't be cloned */
62 #define CVf_NODEBUG     0x0020  /* no DB::sub indirection for this CV
63                                    (esp. useful for special XSUBs) */
64 #define CVf_METHOD      0x0040  /* CV is explicitly marked as a method */
65 #define CVf_LOCKED      0x0080  /* CV locks itself or first arg on entry */
66 #define CVf_LVALUE      0x0100  /* CV return value can be used as lvalue */
67
68 #define CvCLONE(cv)             (CvFLAGS(cv) & CVf_CLONE)
69 #define CvCLONE_on(cv)          (CvFLAGS(cv) |= CVf_CLONE)
70 #define CvCLONE_off(cv)         (CvFLAGS(cv) &= ~CVf_CLONE)
71
72 #define CvCLONED(cv)            (CvFLAGS(cv) & CVf_CLONED)
73 #define CvCLONED_on(cv)         (CvFLAGS(cv) |= CVf_CLONED)
74 #define CvCLONED_off(cv)        (CvFLAGS(cv) &= ~CVf_CLONED)
75
76 #define CvANON(cv)              (CvFLAGS(cv) & CVf_ANON)
77 #define CvANON_on(cv)           (CvFLAGS(cv) |= CVf_ANON)
78 #define CvANON_off(cv)          (CvFLAGS(cv) &= ~CVf_ANON)
79
80 #ifdef PERL_XSUB_OLDSTYLE
81 #define CvOLDSTYLE(cv)          (CvFLAGS(cv) & CVf_OLDSTYLE)
82 #define CvOLDSTYLE_on(cv)       (CvFLAGS(cv) |= CVf_OLDSTYLE)
83 #define CvOLDSTYLE_off(cv)      (CvFLAGS(cv) &= ~CVf_OLDSTYLE)
84 #endif
85
86 #define CvUNIQUE(cv)            (CvFLAGS(cv) & CVf_UNIQUE)
87 #define CvUNIQUE_on(cv)         (CvFLAGS(cv) |= CVf_UNIQUE)
88 #define CvUNIQUE_off(cv)        (CvFLAGS(cv) &= ~CVf_UNIQUE)
89
90 #define CvNODEBUG(cv)           (CvFLAGS(cv) & CVf_NODEBUG)
91 #define CvNODEBUG_on(cv)        (CvFLAGS(cv) |= CVf_NODEBUG)
92 #define CvNODEBUG_off(cv)       (CvFLAGS(cv) &= ~CVf_NODEBUG)
93
94 #define CvMETHOD(cv)            (CvFLAGS(cv) & CVf_METHOD)
95 #define CvMETHOD_on(cv)         (CvFLAGS(cv) |= CVf_METHOD)
96 #define CvMETHOD_off(cv)        (CvFLAGS(cv) &= ~CVf_METHOD)
97
98 #define CvLOCKED(cv)            (CvFLAGS(cv) & CVf_LOCKED)
99 #define CvLOCKED_on(cv)         (CvFLAGS(cv) |= CVf_LOCKED)
100 #define CvLOCKED_off(cv)        (CvFLAGS(cv) &= ~CVf_LOCKED)
101
102 #define CvLVALUE(cv)            (CvFLAGS(cv) & CVf_LVALUE)
103 #define CvLVALUE_on(cv)         (CvFLAGS(cv) |= CVf_LVALUE)
104 #define CvLVALUE_off(cv)        (CvFLAGS(cv) &= ~CVf_LVALUE)
105
106 #define CvEVAL(cv)              (CvUNIQUE(cv) && !SvFAKE(cv))
107 #define CvEVAL_on(cv)           (CvUNIQUE_on(cv),SvFAKE_off(cv))
108 #define CvEVAL_off(cv)          CvUNIQUE_off(cv)
109
110 /* BEGIN|INIT|END */
111 #define CvSPECIAL(cv)           (CvUNIQUE(cv) && SvFAKE(cv))
112 #define CvSPECIAL_on(cv)        (CvUNIQUE_on(cv),SvFAKE_on(cv))
113 #define CvSPECIAL_off(cv)       (CvUNIQUE_off(cv),SvFAKE_off(cv))