corelist: updated for File::Copy doc updates
[perl.git] / mg_vtable.h
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
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_arylen         '#' /* Array length ($#ary) */
17 #define PERL_MAGIC_rhash          '%' /* Extra data for restricted hashes */
18 #define PERL_MAGIC_debugvar       '*' /* $DB::single, signal, trace vars */
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 */
23 #define PERL_MAGIC_bm             'B' /* Boyer-Moore (fast string search) */
24 #define PERL_MAGIC_overload_table 'c' /* Holds overload table (AMT) on stash */
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) */
31 #define PERL_MAGIC_regex_global   'g' /* m//g target */
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 */
51 #define PERL_MAGIC_vstring        'V' /* SV was vstring literal */
52 #define PERL_MAGIC_vec            'v' /* vec() lvalue */
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 */
57 #define PERL_MAGIC_lvref          '\\' /* Lvalue reference constructor */
58 #define PERL_MAGIC_checkcall      ']' /* Inlining/mutation of call to this CV */
59 #define PERL_MAGIC_ext            '~' /* Available for use by extensions */
60
61 enum {          /* pass one of these to get_vtbl */
62     want_vtbl_arylen,
63     want_vtbl_arylen_p,
64     want_vtbl_backref,
65     want_vtbl_checkcall,
66     want_vtbl_collxfrm,
67     want_vtbl_dbline,
68     want_vtbl_debugvar,
69     want_vtbl_defelem,
70     want_vtbl_env,
71     want_vtbl_envelem,
72     want_vtbl_hints,
73     want_vtbl_hintselem,
74     want_vtbl_isa,
75     want_vtbl_isaelem,
76     want_vtbl_lvref,
77     want_vtbl_mglob,
78     want_vtbl_nkeys,
79     want_vtbl_ovrld,
80     want_vtbl_pack,
81     want_vtbl_packelem,
82     want_vtbl_pos,
83     want_vtbl_regdata,
84     want_vtbl_regdatum,
85     want_vtbl_regexp,
86     want_vtbl_sigelem,
87     want_vtbl_substr,
88     want_vtbl_sv,
89     want_vtbl_taint,
90     want_vtbl_utf8,
91     want_vtbl_uvar,
92     want_vtbl_vec,
93     magic_vtable_max
94 };
95
96 #ifdef DOINIT
97 EXTCONST char * const PL_magic_vtable_names[magic_vtable_max] = {
98     "arylen",
99     "arylen_p",
100     "backref",
101     "checkcall",
102     "collxfrm",
103     "dbline",
104     "debugvar",
105     "defelem",
106     "env",
107     "envelem",
108     "hints",
109     "hintselem",
110     "isa",
111     "isaelem",
112     "lvref",
113     "mglob",
114     "nkeys",
115     "ovrld",
116     "pack",
117     "packelem",
118     "pos",
119     "regdata",
120     "regdatum",
121     "regexp",
122     "sigelem",
123     "substr",
124     "sv",
125     "taint",
126     "utf8",
127     "uvar",
128     "vec"
129 };
130 #else
131 EXTCONST char * const PL_magic_vtable_names[magic_vtable_max];
132 #endif
133
134 /* These all need to be 0, not NULL, as NULL can be (void*)0, which is a
135  * pointer to data, whereas we're assigning pointers to functions, which are
136  * not the same beast. ANSI doesn't allow the assignment from one to the other.
137  * (although most, but not all, compilers are prepared to do it)
138  */
139
140 /* order is:
141     get
142     set
143     len
144     clear
145     free
146     copy
147     dup
148     local
149 */
150
151 #ifdef DOINIT
152 EXT_MGVTBL PL_magic_vtables[magic_vtable_max] = {
153   { (int (*)(pTHX_ SV *, MAGIC *))Perl_magic_getarylen, Perl_magic_setarylen, 0, 0, 0, 0, 0, 0 },
154   { 0, 0, 0, Perl_magic_cleararylen_p, Perl_magic_freearylen_p, 0, 0, 0 },
155   { 0, 0, 0, 0, Perl_magic_killbackrefs, 0, 0, 0 },
156   { 0, 0, 0, 0, 0, Perl_magic_copycallchecker, 0, 0 },
157 #ifdef USE_LOCALE_COLLATE
158   { 0, Perl_magic_setcollxfrm, 0, 0, 0, 0, 0, 0 },
159 #else
160   { 0, 0, 0, 0, 0, 0, 0, 0 },
161 #endif
162   { 0, Perl_magic_setdbline, 0, 0, 0, 0, 0, 0 },
163   { Perl_magic_getdebugvar, Perl_magic_setdebugvar, 0, 0, 0, 0, 0, 0 },
164   { Perl_magic_getdefelem, Perl_magic_setdefelem, 0, 0, 0, 0, 0, 0 },
165   { 0, Perl_magic_set_all_env, 0, Perl_magic_clear_all_env, 0, 0, 0, 0 },
166   { 0, Perl_magic_setenv, 0, Perl_magic_clearenv, 0, 0, 0, 0 },
167   { 0, 0, 0, Perl_magic_clearhints, 0, 0, 0, 0 },
168   { 0, Perl_magic_sethint, 0, Perl_magic_clearhint, 0, 0, 0, 0 },
169   { 0, Perl_magic_setisa, 0, Perl_magic_clearisa, 0, 0, 0, 0 },
170   { 0, Perl_magic_setisa, 0, 0, 0, 0, 0, 0 },
171   { 0, Perl_magic_setlvref, 0, 0, 0, 0, 0, 0 },
172   { 0, Perl_magic_setmglob, 0, 0, 0, 0, 0, 0 },
173   { Perl_magic_getnkeys, Perl_magic_setnkeys, 0, 0, 0, 0, 0, 0 },
174   { 0, 0, 0, 0, Perl_magic_freeovrld, 0, 0, 0 },
175   { 0, 0, Perl_magic_sizepack, Perl_magic_wipepack, 0, 0, 0, 0 },
176   { Perl_magic_getpack, Perl_magic_setpack, 0, Perl_magic_clearpack, 0, 0, 0, 0 },
177   { Perl_magic_getpos, Perl_magic_setpos, 0, 0, 0, 0, 0, 0 },
178   { 0, 0, Perl_magic_regdata_cnt, 0, 0, 0, 0, 0 },
179   { Perl_magic_regdatum_get, Perl_magic_regdatum_set, 0, 0, 0, 0, 0, 0 },
180   { 0, Perl_magic_setregexp, 0, 0, 0, 0, 0, 0 },
181 #ifndef PERL_MICRO
182   { Perl_magic_getsig, Perl_magic_setsig, 0, Perl_magic_clearsig, 0, 0, 0, 0 },
183 #else
184   { 0, 0, 0, 0, 0, 0, 0, 0 },
185 #endif
186   { Perl_magic_getsubstr, Perl_magic_setsubstr, 0, 0, 0, 0, 0, 0 },
187   { Perl_magic_get, Perl_magic_set, 0, 0, 0, 0, 0, 0 },
188   { Perl_magic_gettaint, Perl_magic_settaint, 0, 0, 0, 0, 0, 0 },
189   { 0, Perl_magic_setutf8, 0, 0, 0, 0, 0, 0 },
190   { Perl_magic_getuvar, Perl_magic_setuvar, 0, 0, 0, 0, 0, 0 },
191   { Perl_magic_getvec, Perl_magic_setvec, 0, 0, 0, 0, 0, 0 }
192 };
193 #else
194 EXT_MGVTBL PL_magic_vtables[magic_vtable_max];
195 #endif
196
197 #define want_vtbl_bm want_vtbl_regexp
198 #define want_vtbl_fm want_vtbl_regexp
199
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_checkcall PL_magic_vtables[want_vtbl_checkcall]
205 #define PL_vtbl_collxfrm PL_magic_vtables[want_vtbl_collxfrm]
206 #define PL_vtbl_dbline PL_magic_vtables[want_vtbl_dbline]
207 #define PL_vtbl_debugvar PL_magic_vtables[want_vtbl_debugvar]
208 #define PL_vtbl_defelem PL_magic_vtables[want_vtbl_defelem]
209 #define PL_vtbl_env PL_magic_vtables[want_vtbl_env]
210 #define PL_vtbl_envelem PL_magic_vtables[want_vtbl_envelem]
211 #define PL_vtbl_fm PL_magic_vtables[want_vtbl_fm]
212 #define PL_vtbl_hints PL_magic_vtables[want_vtbl_hints]
213 #define PL_vtbl_hintselem PL_magic_vtables[want_vtbl_hintselem]
214 #define PL_vtbl_isa PL_magic_vtables[want_vtbl_isa]
215 #define PL_vtbl_isaelem PL_magic_vtables[want_vtbl_isaelem]
216 #define PL_vtbl_lvref PL_magic_vtables[want_vtbl_lvref]
217 #define PL_vtbl_mglob PL_magic_vtables[want_vtbl_mglob]
218 #define PL_vtbl_nkeys PL_magic_vtables[want_vtbl_nkeys]
219 #define PL_vtbl_ovrld PL_magic_vtables[want_vtbl_ovrld]
220 #define PL_vtbl_pack PL_magic_vtables[want_vtbl_pack]
221 #define PL_vtbl_packelem PL_magic_vtables[want_vtbl_packelem]
222 #define PL_vtbl_pos PL_magic_vtables[want_vtbl_pos]
223 #define PL_vtbl_regdata PL_magic_vtables[want_vtbl_regdata]
224 #define PL_vtbl_regdatum PL_magic_vtables[want_vtbl_regdatum]
225 #define PL_vtbl_regexp PL_magic_vtables[want_vtbl_regexp]
226 #define PL_vtbl_sigelem PL_magic_vtables[want_vtbl_sigelem]
227 #define PL_vtbl_substr PL_magic_vtables[want_vtbl_substr]
228 #define PL_vtbl_sv PL_magic_vtables[want_vtbl_sv]
229 #define PL_vtbl_taint PL_magic_vtables[want_vtbl_taint]
230 #define PL_vtbl_utf8 PL_magic_vtables[want_vtbl_utf8]
231 #define PL_vtbl_uvar PL_magic_vtables[want_vtbl_uvar]
232 #define PL_vtbl_vec PL_magic_vtables[want_vtbl_vec]
233
234 /* ex: set ro: */