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