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