This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #122445] test for overload assigned to $DB::single
[perl5.git] / mg_vtable.h
CommitLineData
8b09643d
NC
1/* -*- buffer-read-only: t -*-
2 *
3 * mg_vtable.h
4 * !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
5 * This file is built by regen/mg_vtable.pl.
6 * Any changes made here will be lost!
7 */
8
abf9aa7a
NC
9/* These constants should be used in preference to raw characters
10 * when using magic. Note that some perl guts still assume
11 * certain character properties of these constants, namely that
12 * isUPPER() and toLOWER() may do useful mappings.
13 */
14
15#define PERL_MAGIC_sv '\0' /* Special scalar variable */
23cfd2fc
NC
16#define PERL_MAGIC_arylen '#' /* Array length ($#ary) */
17#define PERL_MAGIC_rhash '%' /* extra data for restricted hashes */
2a388207 18#define PERL_MAGIC_proto '&' /* my sub prototype CV */
23cfd2fc
NC
19#define PERL_MAGIC_pos '.' /* pos() lvalue */
20#define PERL_MAGIC_symtab ':' /* extra data for symbol tables */
21#define PERL_MAGIC_backref '<' /* for weak ref data */
22#define PERL_MAGIC_arylen_p '@' /* to move arylen out of XPVAV */
abf9aa7a 23#define PERL_MAGIC_bm 'B' /* Boyer-Moore (fast string search) */
23cfd2fc 24#define PERL_MAGIC_overload_table 'c' /* Holds overload table (AMT) on stash */
abf9aa7a
NC
25#define PERL_MAGIC_regdata 'D' /* Regex match position data
26 (@+ and @- vars) */
27#define PERL_MAGIC_regdatum 'd' /* Regex match position data element */
28#define PERL_MAGIC_env 'E' /* %ENV hash */
29#define PERL_MAGIC_envelem 'e' /* %ENV hash element */
30#define PERL_MAGIC_fm 'f' /* Formline ('compiled' format) */
0177730e 31#define PERL_MAGIC_regex_global 'g' /* m//g target */
abf9aa7a
NC
32#define PERL_MAGIC_hints 'H' /* %^H hash */
33#define PERL_MAGIC_hintselem 'h' /* %^H hash element */
34#define PERL_MAGIC_isa 'I' /* @ISA array */
35#define PERL_MAGIC_isaelem 'i' /* @ISA array element */
36#define PERL_MAGIC_nkeys 'k' /* scalar(keys()) lvalue */
37#define PERL_MAGIC_dbfile 'L' /* Debugger %_<filename */
38#define PERL_MAGIC_dbline 'l' /* Debugger %_<filename element */
39#define PERL_MAGIC_shared 'N' /* Shared between threads */
40#define PERL_MAGIC_shared_scalar 'n' /* Shared between threads */
41#define PERL_MAGIC_collxfrm 'o' /* Locale transformation */
42#define PERL_MAGIC_tied 'P' /* Tied array or hash */
43#define PERL_MAGIC_tiedelem 'p' /* Tied array or hash element */
44#define PERL_MAGIC_tiedscalar 'q' /* Tied scalar or handle */
45#define PERL_MAGIC_qr 'r' /* precompiled qr// regex */
46#define PERL_MAGIC_sig 'S' /* %SIG hash */
47#define PERL_MAGIC_sigelem 's' /* %SIG hash element */
48#define PERL_MAGIC_taint 't' /* Taintedness */
49#define PERL_MAGIC_uvar 'U' /* Available for use by extensions */
50#define PERL_MAGIC_uvar_elem 'u' /* Reserved for use by extensions */
abf9aa7a 51#define PERL_MAGIC_vstring 'V' /* SV was vstring literal */
23cfd2fc 52#define PERL_MAGIC_vec 'v' /* vec() lvalue */
abf9aa7a
NC
53#define PERL_MAGIC_utf8 'w' /* Cached UTF-8 information */
54#define PERL_MAGIC_substr 'x' /* substr() lvalue */
55#define PERL_MAGIC_defelem 'y' /* Shadow "foreach" iterator variable /
56 smart parameter vivification */
abf9aa7a 57#define PERL_MAGIC_checkcall ']' /* inlining/mutation of call to this CV */
23cfd2fc 58#define PERL_MAGIC_ext '~' /* Available for use by extensions */
abf9aa7a 59
ca298f7d 60enum { /* pass one of these to get_vtbl */
23cfd2fc
NC
61 want_vtbl_arylen,
62 want_vtbl_arylen_p,
63 want_vtbl_backref,
09fb282d 64 want_vtbl_checkcall,
23cfd2fc
NC
65 want_vtbl_collxfrm,
66 want_vtbl_dbline,
67 want_vtbl_defelem,
ca298f7d
NC
68 want_vtbl_env,
69 want_vtbl_envelem,
23cfd2fc
NC
70 want_vtbl_hints,
71 want_vtbl_hintselem,
ca298f7d
NC
72 want_vtbl_isa,
73 want_vtbl_isaelem,
ca298f7d
NC
74 want_vtbl_mglob,
75 want_vtbl_nkeys,
23cfd2fc
NC
76 want_vtbl_ovrld,
77 want_vtbl_pack,
78 want_vtbl_packelem,
ca298f7d 79 want_vtbl_pos,
ca298f7d
NC
80 want_vtbl_regdata,
81 want_vtbl_regdatum,
23cfd2fc
NC
82 want_vtbl_regexp,
83 want_vtbl_sigelem,
84 want_vtbl_substr,
85 want_vtbl_sv,
86 want_vtbl_taint,
ca298f7d 87 want_vtbl_utf8,
23cfd2fc
NC
88 want_vtbl_uvar,
89 want_vtbl_vec,
c7fdacb9 90 magic_vtable_max
ca298f7d
NC
91};
92
2d1f1fe5 93#ifdef DOINIT
bfd14e52 94EXTCONST char * const PL_magic_vtable_names[magic_vtable_max] = {
23cfd2fc
NC
95 "arylen",
96 "arylen_p",
97 "backref",
09fb282d 98 "checkcall",
23cfd2fc
NC
99 "collxfrm",
100 "dbline",
101 "defelem",
2d1f1fe5
NC
102 "env",
103 "envelem",
23cfd2fc
NC
104 "hints",
105 "hintselem",
2d1f1fe5
NC
106 "isa",
107 "isaelem",
2d1f1fe5
NC
108 "mglob",
109 "nkeys",
23cfd2fc
NC
110 "ovrld",
111 "pack",
112 "packelem",
2d1f1fe5 113 "pos",
2d1f1fe5
NC
114 "regdata",
115 "regdatum",
23cfd2fc
NC
116 "regexp",
117 "sigelem",
118 "substr",
119 "sv",
120 "taint",
2d1f1fe5 121 "utf8",
23cfd2fc 122 "uvar",
4499db73 123 "vec"
2d1f1fe5
NC
124};
125#else
bfd14e52 126EXTCONST char * const PL_magic_vtable_names[magic_vtable_max];
2d1f1fe5
NC
127#endif
128
8b09643d
NC
129/* These all need to be 0, not NULL, as NULL can be (void*)0, which is a
130 * pointer to data, whereas we're assigning pointers to functions, which are
131 * not the same beast. ANSI doesn't allow the assignment from one to the other.
132 * (although most, but not all, compilers are prepared to do it)
133 */
134
0ffb5b03 135/* order is:
8b09643d
NC
136 get
137 set
138 len
139 clear
140 free
141 copy
142 dup
143 local
144*/
145
0ffb5b03 146#ifdef DOINIT
c7fdacb9 147EXT_MGVTBL PL_magic_vtables[magic_vtable_max] = {
23cfd2fc 148 { (int (*)(pTHX_ SV *, MAGIC *))Perl_magic_getarylen, Perl_magic_setarylen, 0, 0, 0, 0, 0, 0 },
83f29afa 149 { 0, 0, 0, Perl_magic_cleararylen_p, Perl_magic_freearylen_p, 0, 0, 0 },
23cfd2fc 150 { 0, 0, 0, 0, Perl_magic_killbackrefs, 0, 0, 0 },
09fb282d 151 { 0, 0, 0, 0, 0, Perl_magic_copycallchecker, 0, 0 },
23cfd2fc
NC
152#ifdef USE_LOCALE_COLLATE
153 { 0, Perl_magic_setcollxfrm, 0, 0, 0, 0, 0, 0 },
b7b5e578
NC
154#else
155 { 0, 0, 0, 0, 0, 0, 0, 0 },
156#endif
b7b5e578 157 { 0, Perl_magic_setdbline, 0, 0, 0, 0, 0, 0 },
23cfd2fc
NC
158 { Perl_magic_getdefelem, Perl_magic_setdefelem, 0, 0, 0, 0, 0, 0 },
159 { 0, Perl_magic_set_all_env, 0, Perl_magic_clear_all_env, 0, 0, 0, 0 },
160 { 0, Perl_magic_setenv, 0, Perl_magic_clearenv, 0, 0, 0, 0 },
161 { 0, 0, 0, Perl_magic_clearhints, 0, 0, 0, 0 },
162 { 0, Perl_magic_sethint, 0, Perl_magic_clearhint, 0, 0, 0, 0 },
b7b5e578
NC
163 { 0, Perl_magic_setisa, 0, Perl_magic_clearisa, 0, 0, 0, 0 },
164 { 0, Perl_magic_setisa, 0, 0, 0, 0, 0, 0 },
b7b5e578
NC
165 { 0, Perl_magic_setmglob, 0, 0, 0, 0, 0, 0 },
166 { Perl_magic_getnkeys, Perl_magic_setnkeys, 0, 0, 0, 0, 0, 0 },
23cfd2fc
NC
167 { 0, 0, 0, 0, Perl_magic_freeovrld, 0, 0, 0 },
168 { 0, 0, Perl_magic_sizepack, Perl_magic_wipepack, 0, 0, 0, 0 },
169 { Perl_magic_getpack, Perl_magic_setpack, 0, Perl_magic_clearpack, 0, 0, 0, 0 },
b7b5e578 170 { Perl_magic_getpos, Perl_magic_setpos, 0, 0, 0, 0, 0, 0 },
b7b5e578
NC
171 { 0, 0, Perl_magic_regdata_cnt, 0, 0, 0, 0, 0 },
172 { Perl_magic_regdatum_get, Perl_magic_regdatum_set, 0, 0, 0, 0, 0, 0 },
23cfd2fc
NC
173 { 0, Perl_magic_setregexp, 0, 0, 0, 0, 0, 0 },
174#ifndef PERL_MICRO
175 { Perl_magic_getsig, Perl_magic_setsig, 0, Perl_magic_clearsig, 0, 0, 0, 0 },
0ffb5b03 176#else
b7b5e578 177 { 0, 0, 0, 0, 0, 0, 0, 0 },
0ffb5b03 178#endif
23cfd2fc 179 { Perl_magic_getsubstr, Perl_magic_setsubstr, 0, 0, 0, 0, 0, 0 },
9bb29b68 180 { Perl_magic_get, Perl_magic_set, 0, 0, 0, 0, 0, 0 },
23cfd2fc
NC
181 { Perl_magic_gettaint, Perl_magic_settaint, 0, 0, 0, 0, 0, 0 },
182 { 0, Perl_magic_setutf8, 0, 0, 0, 0, 0, 0 },
183 { Perl_magic_getuvar, Perl_magic_setuvar, 0, 0, 0, 0, 0, 0 },
4499db73 184 { Perl_magic_getvec, Perl_magic_setvec, 0, 0, 0, 0, 0, 0 }
b7b5e578 185};
0ffb5b03 186#else
c7fdacb9 187EXT_MGVTBL PL_magic_vtables[magic_vtable_max];
b7b5e578
NC
188#endif
189
b2e9fc6f
NC
190#define want_vtbl_bm want_vtbl_regexp
191#define want_vtbl_fm want_vtbl_regexp
192
b7b5e578
NC
193#define PL_vtbl_arylen PL_magic_vtables[want_vtbl_arylen]
194#define PL_vtbl_arylen_p PL_magic_vtables[want_vtbl_arylen_p]
195#define PL_vtbl_backref PL_magic_vtables[want_vtbl_backref]
196#define PL_vtbl_bm PL_magic_vtables[want_vtbl_bm]
09fb282d 197#define PL_vtbl_checkcall PL_magic_vtables[want_vtbl_checkcall]
b7b5e578
NC
198#define PL_vtbl_collxfrm PL_magic_vtables[want_vtbl_collxfrm]
199#define PL_vtbl_dbline PL_magic_vtables[want_vtbl_dbline]
200#define PL_vtbl_defelem PL_magic_vtables[want_vtbl_defelem]
201#define PL_vtbl_env PL_magic_vtables[want_vtbl_env]
202#define PL_vtbl_envelem PL_magic_vtables[want_vtbl_envelem]
203#define PL_vtbl_fm PL_magic_vtables[want_vtbl_fm]
204#define PL_vtbl_hints PL_magic_vtables[want_vtbl_hints]
205#define PL_vtbl_hintselem PL_magic_vtables[want_vtbl_hintselem]
206#define PL_vtbl_isa PL_magic_vtables[want_vtbl_isa]
207#define PL_vtbl_isaelem PL_magic_vtables[want_vtbl_isaelem]
208#define PL_vtbl_mglob PL_magic_vtables[want_vtbl_mglob]
209#define PL_vtbl_nkeys PL_magic_vtables[want_vtbl_nkeys]
210#define PL_vtbl_ovrld PL_magic_vtables[want_vtbl_ovrld]
211#define PL_vtbl_pack PL_magic_vtables[want_vtbl_pack]
212#define PL_vtbl_packelem PL_magic_vtables[want_vtbl_packelem]
213#define PL_vtbl_pos PL_magic_vtables[want_vtbl_pos]
214#define PL_vtbl_regdata PL_magic_vtables[want_vtbl_regdata]
215#define PL_vtbl_regdatum PL_magic_vtables[want_vtbl_regdatum]
216#define PL_vtbl_regexp PL_magic_vtables[want_vtbl_regexp]
217#define PL_vtbl_sigelem PL_magic_vtables[want_vtbl_sigelem]
218#define PL_vtbl_substr PL_magic_vtables[want_vtbl_substr]
219#define PL_vtbl_sv PL_magic_vtables[want_vtbl_sv]
220#define PL_vtbl_taint PL_magic_vtables[want_vtbl_taint]
221#define PL_vtbl_utf8 PL_magic_vtables[want_vtbl_utf8]
222#define PL_vtbl_uvar PL_magic_vtables[want_vtbl_uvar]
223#define PL_vtbl_vec PL_magic_vtables[want_vtbl_vec]
8b09643d
NC
224
225/* ex: set ro: */