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