PATCH [perl 116252]: Correct nested pod bullets in perl5177delta.pod
[perl.git] / intrpvar.h
1 /*   intrpvar.h 
2  *
3  *    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4  *    2006, 2007, 2008 by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 #include "handy.h"
12
13 /*
14 =head1 Per-Interpreter Variables
15 */
16
17 /* These variables are per-interpreter in threaded/multiplicity builds,
18  * global otherwise.
19
20  * Don't forget to re-run regen/embed.pl to propagate changes! */
21
22 /* New variables must be added to the very end for binary compatibility. */
23
24 /* Don't forget to add your variable also to perl_clone()! (in sv.c) */
25
26 /* The 'I' prefix is only needed for vars that need appropriate #defines
27  * generated when built with or without MULTIPLICITY.  It is also used
28  * to generate the appropriate export list for win32.  If the variable
29  * needs to be initialized, use PERLVARI.
30  *
31  * When building without MULTIPLICITY, these variables will be truly global.
32  *
33  * Important ones in the first cache line (if alignment is done right) */
34
35 PERLVAR(I, stack_sp,    SV **)          /* top of the stack */
36 #ifdef OP_IN_REGISTER
37 PERLVAR(I, opsave,      OP *)
38 #else
39 PERLVAR(I, op,          OP *)           /* currently executing op */
40 #endif
41 PERLVAR(I, curpad,      SV **)          /* active pad (lexicals+tmps) */
42
43 PERLVAR(I, stack_base,  SV **)
44 PERLVAR(I, stack_max,   SV **)
45
46 PERLVAR(I, scopestack,  I32 *)          /* scopes we've ENTERed */
47 /* name of the scopes we've ENTERed. Only used with -DDEBUGGING, but needs to be
48    present always, as -DDEUBGGING must be binary compatible with non.  */
49 PERLVARI(I, scopestack_name, const char * *, NULL)
50 PERLVAR(I, scopestack_ix, I32)
51 PERLVAR(I, scopestack_max, I32)
52
53 PERLVAR(I, savestack,   ANY *)          /* items that need to be restored when
54                                            LEAVEing scopes we've ENTERed */
55 PERLVAR(I, savestack_ix, I32)
56 PERLVAR(I, savestack_max, I32)
57
58 PERLVAR(I, tmps_stack,  SV **)          /* mortals we've made */
59 PERLVARI(I, tmps_ix,    I32,    -1)
60 PERLVARI(I, tmps_floor, I32,    -1)
61 PERLVAR(I, tmps_max,    I32)
62 PERLVAR(I, modcount,    I32)            /* how much op_lvalue()ification in
63                                            assignment? */
64
65 PERLVAR(I, markstack,   I32 *)          /* stack_sp locations we're
66                                            remembering */
67 PERLVAR(I, markstack_ptr, I32 *)
68 PERLVAR(I, markstack_max, I32 *)
69
70 PERLVAR(I, Sv,          SV *)           /* used to hold temporary values */
71 PERLVAR(I, Xpv,         XPV *)          /* used to hold temporary values */
72
73 /*
74 =for apidoc Amn|STRLEN|PL_na
75
76 A convenience variable which is typically used with C<SvPV> when one
77 doesn't care about the length of the string.  It is usually more efficient
78 to either declare a local variable and use that instead or to use the
79 C<SvPV_nolen> macro.
80
81 =cut
82 */
83
84 PERLVAR(I, na,          STRLEN)         /* for use in SvPV when length is
85                                            Not Applicable */
86
87 /* stat stuff */
88 PERLVAR(I, statbuf,     Stat_t)
89 PERLVAR(I, statcache,   Stat_t)         /* _ */
90 PERLVAR(I, statgv,      GV *)
91 PERLVARI(I, statname,   SV *,   NULL)
92
93 #ifdef HAS_TIMES
94 PERLVAR(I, timesbuf,    struct tms)
95 #endif
96
97 /* Fields used by magic variables such as $@, $/ and so on */
98 PERLVAR(I, curpm,       PMOP *)         /* what to do \ interps in REs from */
99
100 /*
101 =for apidoc mn|SV*|PL_rs
102
103 The input record separator - C<$/> in Perl space.
104
105 =for apidoc mn|GV*|PL_last_in_gv
106
107 The GV which was last used for a filehandle input operation. (C<< <FH> >>)
108
109 =for apidoc mn|GV*|PL_ofsgv
110
111 The glob containing the output field separator - C<*,> in Perl space.
112
113 =cut
114 */
115
116 PERLVAR(I, rs,          SV *)           /* input record separator $/ */
117 PERLVAR(I, last_in_gv,  GV *)           /* GV used in last <FH> */
118 PERLVAR(I, ofsgv,       GV *)           /* GV of output field separator *, */
119 PERLVAR(I, defoutgv,    GV *)           /* default FH for output */
120 PERLVARI(I, chopset,    const char *, " \n-")   /* $: */
121 PERLVAR(I, formtarget,  SV *)
122 PERLVAR(I, bodytarget,  SV *)
123 PERLVAR(I, toptarget,   SV *)
124
125 /* Stashes */
126 PERLVAR(I, defstash,    HV *)           /* main symbol table */
127 PERLVAR(I, curstash,    HV *)           /* symbol table for current package */
128
129 PERLVAR(I, restartop,   OP *)           /* propagating an error from croak? */
130 PERLVAR(I, restartjmpenv, JMPENV *)     /* target frame for longjmp in die */
131 PERLVAR(I, curcop,      COP *)
132 PERLVAR(I, curstack,    AV *)           /* THE STACK */
133 PERLVAR(I, curstackinfo, PERL_SI *)     /* current stack + context */
134 PERLVAR(I, mainstack,   AV *)           /* the stack when nothing funny is
135                                            happening */
136
137 PERLVAR(I, top_env,     JMPENV *)       /* ptr to current sigjmp environment */
138 PERLVAR(I, start_env,   JMPENV)         /* empty startup sigjmp environment */
139 PERLVARI(I, errors,     SV *,   NULL)   /* outstanding queued errors */
140
141 /* statics "owned" by various functions */
142 PERLVAR(I, hv_fetch_ent_mh, HE*)        /* owned by hv_fetch_ent() */
143
144 PERLVAR(I, lastgotoprobe, OP*)          /* from pp_ctl.c */
145
146 /* sort stuff */
147 PERLVAR(I, sortcop,     OP *)           /* user defined sort routine */
148 PERLVAR(I, sortstash,   HV *)           /* which is in some package or other */
149 PERLVAR(I, firstgv,     GV *)           /* $a */
150 PERLVAR(I, secondgv,    GV *)           /* $b */
151
152 /* float buffer */
153 PERLVAR(I, efloatbuf,   char *)
154 PERLVAR(I, efloatsize,  STRLEN)
155
156 /* regex stuff */
157
158 PERLVAR(I, reg_state,   struct re_save_state)
159
160 PERLVAR(I, regdummy,    regnode)        /* from regcomp.c */
161
162 PERLVARI(I, dumpindent, U16,    4)      /* number of blanks per dump
163                                            indentation level */
164
165
166 PERLVAR(I, utf8locale,  bool)           /* utf8 locale detected */
167
168 PERLVARA(I, colors,6,   char *)         /* from regcomp.c */
169
170 /*
171 =for apidoc Amn|peep_t|PL_peepp
172
173 Pointer to the per-subroutine peephole optimiser.  This is a function
174 that gets called at the end of compilation of a Perl subroutine (or
175 equivalently independent piece of Perl code) to perform fixups of
176 some ops and to perform small-scale optimisations.  The function is
177 called once for each subroutine that is compiled, and is passed, as sole
178 parameter, a pointer to the op that is the entry point to the subroutine.
179 It modifies the op tree in place.
180
181 The peephole optimiser should never be completely replaced.  Rather,
182 add code to it by wrapping the existing optimiser.  The basic way to do
183 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
184 If the new code wishes to operate on ops throughout the subroutine's
185 structure, rather than just at the top level, it is likely to be more
186 convenient to wrap the L</PL_rpeepp> hook.
187
188 =cut
189 */
190
191 PERLVARI(I, peepp,      peep_t, Perl_peep)
192
193 /*
194 =for apidoc Amn|peep_t|PL_rpeepp
195
196 Pointer to the recursive peephole optimiser.  This is a function
197 that gets called at the end of compilation of a Perl subroutine (or
198 equivalently independent piece of Perl code) to perform fixups of some
199 ops and to perform small-scale optimisations.  The function is called
200 once for each chain of ops linked through their C<op_next> fields;
201 it is recursively called to handle each side chain.  It is passed, as
202 sole parameter, a pointer to the op that is at the head of the chain.
203 It modifies the op tree in place.
204
205 The peephole optimiser should never be completely replaced.  Rather,
206 add code to it by wrapping the existing optimiser.  The basic way to do
207 this can be seen in L<perlguts/Compile pass 3: peephole optimization>.
208 If the new code wishes to operate only on ops at a subroutine's top level,
209 rather than throughout the structure, it is likely to be more convenient
210 to wrap the L</PL_peepp> hook.
211
212 =cut
213 */
214
215 PERLVARI(I, rpeepp,     peep_t, Perl_rpeep)
216
217 /*
218 =for apidoc Amn|Perl_ophook_t|PL_opfreehook
219
220 When non-C<NULL>, the function pointed by this variable will be called each time an OP is freed with the corresponding OP as the argument.
221 This allows extensions to free any extra attribute they have locally attached to an OP.
222 It is also assured to first fire for the parent OP and then for its kids.
223
224 When you replace this variable, it is considered a good practice to store the possibly previously installed hook and that you recall it inside your own.
225
226 =cut
227 */
228
229 PERLVARI(I, opfreehook, Perl_ophook_t, 0) /* op_free() hook */
230
231 PERLVARI(I, watchaddr,  char **, 0)
232 PERLVAR(I, watchok,     char *)
233
234 /* the currently active slab in a chain of slabs of regmatch states,
235  * and the currently active state within that slab */
236
237 PERLVARI(I, regmatch_slab, regmatch_slab *,     NULL)
238 PERLVAR(I, regmatch_state, regmatch_state *)
239
240 /* Put anything new that is pointer aligned here. */
241
242 PERLVAR(I, delaymagic,  U16)            /* ($<,$>) = ... */
243 PERLVAR(I, localizing,  U8)             /* are we processing a local() list? */
244 PERLVAR(I, colorset,    bool)           /* from regcomp.c */
245 PERLVAR(I, in_eval,     U8)             /* trap "fatal" errors? */
246 PERLVAR(I, tainted,     bool)           /* using variables controlled by $< */
247 PERLVAR(I, tainting,    bool)           /* doing taint checks */
248
249 /* This value may be set when embedding for full cleanup  */
250 /* 0=none, 1=full, 2=full with checks */
251 /* mod_perl is special, and also assigns a meaning -1 */
252 PERLVARI(I, perl_destruct_level, signed char,   0)
253
254 /* current phase the interpreter is in */
255 PERLVARI(I, phase,      enum perl_phase, PERL_PHASE_CONSTRUCT)
256
257 PERLVAR(I, perldb,      U32)
258
259 PERLVAR(I, signals,     U32)    /* Using which pre-5.8 signals */
260
261 /* pseudo environmental stuff */
262 PERLVAR(I, origargc,    int)
263 PERLVAR(I, origargv,    char **)
264 PERLVAR(I, envgv,       GV *)
265 PERLVAR(I, incgv,       GV *)
266 PERLVAR(I, hintgv,      GV *)
267 PERLVAR(I, origfilename, char *)
268 PERLVAR(I, diehook,     SV *)
269 PERLVAR(I, warnhook,    SV *)
270
271 /* switches */
272 PERLVAR(I, patchlevel,  SV *)
273 PERLVAR(I, apiversion,  SV *)
274 PERLVAR(I, localpatches, const char * const *)
275 PERLVARI(I, splitstr,   const char *, " ")
276
277 PERLVAR(I, minus_c,     bool)
278 PERLVAR(I, minus_n,     bool)
279 PERLVAR(I, minus_p,     bool)
280 PERLVAR(I, minus_l,     bool)
281 PERLVAR(I, minus_a,     bool)
282 PERLVAR(I, minus_F,     bool)
283 PERLVAR(I, doswitches,  bool)
284 PERLVAR(I, minus_E,     bool)
285
286 /*
287
288 =for apidoc mn|bool|PL_dowarn
289
290 The C variable which corresponds to Perl's $^W warning variable.
291
292 =cut
293 */
294
295 PERLVAR(I, dowarn,      U8)
296 #ifdef PERL_SAWAMPERSAND
297 PERLVAR(I, sawampersand, U8)            /* must save all match strings */
298 #endif
299 PERLVAR(I, unsafe,      bool)
300 PERLVAR(I, exit_flags,  U8)             /* was exit() unexpected, etc. */
301
302 PERLVAR(I, inplace,     char *)
303 PERLVAR(I, e_script,    SV *)
304
305 PERLVAR(I, basetime,    Time_t)         /* $^T */
306
307 PERLVARI(I, maxsysfd,   I32,    MAXSYSFD)
308                                         /* top fd to pass to subprocesses */
309 PERLVAR(I, statusvalue, I32)            /* $? */
310 #ifdef VMS
311 PERLVAR(I, statusvalue_vms, U32)
312 #else
313 PERLVAR(I, statusvalue_posix, I32)
314 #endif
315
316 PERLVARI(I, sig_pending, int, 0)        /* Number if highest signal pending */
317 PERLVAR(I, psig_pend, int *)            /* per-signal "count" of pending */
318
319 /* shortcuts to various I/O objects */
320 PERLVAR(I, stdingv,     GV *)           /*  *STDIN      */
321 PERLVAR(I, stderrgv,    GV *)           /*  *STDERR     */
322 PERLVAR(I, defgv,       GV *)
323 PERLVAR(I, argvgv,      GV *)           /*  *ARGV       */
324 PERLVAR(I, argvoutgv,   GV *)           /*  *ARGVOUT    */
325 PERLVAR(I, argvout_stack, AV *)
326
327 /* shortcuts to regexp stuff */
328 PERLVAR(I, replgv,      GV *)           /*  *^R         */
329
330 /* shortcuts to misc objects */
331 PERLVAR(I, errgv,       GV *)           /*  *@          */
332
333 /* shortcuts to debugging objects */
334 PERLVAR(I, DBgv,        GV *)           /*  *DB::DB     */
335 PERLVAR(I, DBline,      GV *)           /*  *DB::line   */
336
337 /*
338 =for apidoc mn|GV *|PL_DBsub
339 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
340 the SV which holds the name of the sub being debugged.  This is the C
341 variable which corresponds to Perl's $DB::sub variable.  See
342 C<PL_DBsingle>.
343
344 =for apidoc mn|SV *|PL_DBsingle
345 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
346 boolean which indicates whether subs are being single-stepped.
347 Single-stepping is automatically turned on after every step.  This is the C
348 variable which corresponds to Perl's $DB::single variable.  See
349 C<PL_DBsub>.
350
351 =for apidoc mn|SV *|PL_DBtrace
352 Trace variable used when Perl is run in debugging mode, with the B<-d>
353 switch.  This is the C variable which corresponds to Perl's $DB::trace
354 variable.  See C<PL_DBsingle>.
355
356 =cut
357 */
358
359 PERLVAR(I, DBsub,       GV *)           /*  *DB::sub    */
360 PERLVAR(I, DBsingle,    SV *)           /*  $DB::single */
361 PERLVAR(I, DBtrace,     SV *)           /*  $DB::trace  */
362 PERLVAR(I, DBsignal,    SV *)           /*  $DB::signal */
363 PERLVAR(I, dbargs,      AV *)           /* args to call listed by caller function */
364
365 /* symbol tables */
366 PERLVAR(I, debstash,    HV *)           /* symbol table for perldb package */
367 PERLVAR(I, globalstash, HV *)           /* global keyword overrides imported here */
368 PERLVAR(I, curstname,   SV *)           /* name of current package */
369 PERLVAR(I, beginav,     AV *)           /* names of BEGIN subroutines */
370 PERLVAR(I, endav,       AV *)           /* names of END subroutines */
371 PERLVAR(I, unitcheckav, AV *)           /* names of UNITCHECK subroutines */
372 PERLVAR(I, checkav,     AV *)           /* names of CHECK subroutines */
373 PERLVAR(I, initav,      AV *)           /* names of INIT subroutines */
374 PERLVAR(I, strtab,      HV *)           /* shared string table */
375 PERLVARI(I, sub_generation, U32, 1)     /* incr to invalidate method cache */
376
377 /* funky return mechanisms */
378 PERLVAR(I, forkprocess, int)            /* so do_open |- can return proc# */
379
380 /* memory management */
381 PERLVAR(I, sv_count,    I32)            /* how many SV* are currently allocated */
382 PERLVAR(I, sv_objcount, I32)            /* how many objects are currently allocated */
383 PERLVAR(I, sv_root,     SV *)           /* storage for SVs belonging to interp */
384 PERLVAR(I, sv_arenaroot, SV *)          /* list of areas for garbage collection */
385
386 /* subprocess state */
387 PERLVAR(I, fdpid,       AV *)           /* keep fd-to-pid mappings for my_popen */
388
389 /* internal state */
390 PERLVARI(I, op_mask,    char *, NULL)   /* masked operations for safe evals */
391
392 /* current interpreter roots */
393 PERLVAR(I, main_cv,     CV *)
394 PERLVAR(I, main_root,   OP *)
395 PERLVAR(I, main_start,  OP *)
396 PERLVAR(I, eval_root,   OP *)
397 PERLVAR(I, eval_start,  OP *)
398
399 /* runtime control stuff */
400 PERLVARI(I, curcopdb,   COP *,  NULL)
401
402 PERLVAR(I, filemode,    int)            /* so nextargv() can preserve mode */
403 PERLVAR(I, lastfd,      int)            /* what to preserve mode on */
404 PERLVAR(I, oldname,     char *)         /* what to preserve mode on */
405 PERLVAR(I, Argv,        const char **)  /* stuff to free from do_aexec, vfork safe */
406 PERLVAR(I, Cmd,         char *)         /* stuff to free from do_aexec, vfork safe */
407 /* Elements in this array have ';' appended and are injected as a single line
408    into the tokeniser. You can't put any (literal) newlines into any program
409    you stuff in into this array, as the point where it's injected is expecting
410    a single physical line. */
411 PERLVAR(I, preambleav,  AV *)
412 PERLVAR(I, mess_sv,     SV *)
413 PERLVAR(I, ors_sv,      SV *)           /* output record separator $\ */
414 /* statics moved here for shared library purposes */
415 PERLVARI(I, gensym,     I32,    0)      /* next symbol for getsym() to define */
416 PERLVARI(I, cv_has_eval, bool, FALSE)   /* PL_compcv includes an entereval or similar */
417 PERLVAR(I, taint_warn,  bool)           /* taint warns instead of dying */
418 PERLVARI(I, laststype,  U16,    OP_STAT)
419 PERLVARI(I, laststatval, int,   -1)
420
421 /* interpreter atexit processing */
422 PERLVARI(I, exitlistlen, I32, 0)        /* length of same */
423 PERLVARI(I, exitlist,   PerlExitListEntry *, NULL)
424                                         /* list of exit functions */
425
426 /*
427 =for apidoc Amn|HV*|PL_modglobal
428
429 C<PL_modglobal> is a general purpose, interpreter global HV for use by
430 extensions that need to keep information on a per-interpreter basis.
431 In a pinch, it can also be used as a symbol table for extensions
432 to share data among each other.  It is a good idea to use keys
433 prefixed by the package name of the extension that owns the data.
434
435 =cut
436 */
437
438 PERLVAR(I, modglobal,   HV *)           /* per-interp module data */
439
440 /* these used to be in global before 5.004_68 */
441 PERLVARI(I, profiledata, U32 *, NULL)   /* table of ops, counts */
442
443 PERLVAR(I, compiling,   COP)            /* compiling/done executing marker */
444
445 PERLVAR(I, compcv,      CV *)           /* currently compiling subroutine */
446 PERLVAR(I, comppad,     PAD *)          /* storage for lexically scoped temporaries */
447 PERLVAR(I, comppad_name, PADNAMELIST *) /* variable names for "my" variables */
448 PERLVAR(I, comppad_name_fill,   I32)    /* last "introduced" variable offset */
449 PERLVAR(I, comppad_name_floor,  I32)    /* start of vars in innermost block */
450
451 #ifdef HAVE_INTERP_INTERN
452 PERLVAR(I, sys_intern,  struct interp_intern)
453                                         /* platform internals */
454 #endif
455
456 /* more statics moved here */
457 PERLVAR(I, DBcv,        CV *)           /* from perl.c */
458 PERLVARI(I, generation, int,    100)    /* from op.c */
459
460 PERLVARI(I, in_clean_objs,bool,    FALSE)       /* from sv.c */
461 PERLVARI(I, in_clean_all, bool,    FALSE)       /* ptrs to freed SVs now legal */
462 PERLVAR(I, nomemok,     bool)           /* let malloc context handle nomem */
463 PERLVARI(I, savebegin,  bool,   FALSE)  /* save BEGINs for compiler     */
464
465 PERLVAR(I, delaymagic_uid,      Uid_t)  /* current real user id, only for delaymagic */
466 PERLVAR(I, delaymagic_euid,     Uid_t)  /* current effective user id, only for delaymagic */
467 PERLVAR(I, delaymagic_gid,      Gid_t)  /* current real group id, only for delaymagic */
468 PERLVAR(I, delaymagic_egid,     Gid_t)  /* current effective group id, only for delaymagic */
469 PERLVARI(I, an,         U32,    0)      /* malloc sequence number */
470
471 #ifdef DEBUGGING
472     /* exercise wrap-around */
473     #define PERL_COP_SEQMAX (U32_MAX-50)
474 #else
475     #define PERL_COP_SEQMAX 0
476 #endif
477 PERLVARI(I, cop_seqmax, U32,    PERL_COP_SEQMAX) /* statement sequence number */
478 #undef PERL_COP_SEQMAX
479
480 PERLVARI(I, evalseq,    U32,    0)      /* eval sequence number */
481 PERLVAR(I, origalen,    U32)
482 PERLVAR(I, origenviron, char **)
483 #ifdef PERL_USES_PL_PIDSTATUS
484 PERLVAR(I, pidstatus,   HV *)           /* pid-to-status mappings for waitpid */
485 #endif
486 PERLVAR(I, osname,      char *)         /* operating system */
487
488 PERLVAR(I, sighandlerp, Sighandler_t)
489
490 PERLVARA(I, body_roots, PERL_ARENA_ROOTS_SIZE, void*) /* array of body roots */
491
492 PERLVAR(I, unicode, U32)        /* Unicode features: $ENV{PERL_UNICODE} or -C */
493
494 PERLVARI(I, maxo,       int,    MAXO)   /* maximum number of ops */
495
496 PERLVARI(I, runops,     runops_proc_t, RUNOPS_DEFAULT)
497
498 /*
499 =for apidoc Amn|SV|PL_sv_undef
500 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
501
502 =for apidoc Amn|SV|PL_sv_no
503 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
504 C<&PL_sv_no>.
505
506 =for apidoc Amn|SV|PL_sv_yes
507 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
508 C<&PL_sv_yes>.
509
510 =cut
511 */
512
513 PERLVAR(I, sv_undef,    SV)
514 PERLVAR(I, sv_no,       SV)
515 PERLVAR(I, sv_yes,      SV)
516
517 PERLVAR(I, subname,     SV *)           /* name of current subroutine */
518
519 PERLVAR(I, subline,     I32)            /* line this subroutine began on */
520 PERLVAR(I, min_intro_pending, I32)      /* start of vars to introduce */
521
522 PERLVAR(I, max_intro_pending, I32)      /* end of vars to introduce */
523 PERLVAR(I, padix,       I32)            /* max used index in current "register" pad */
524
525 PERLVAR(I, padix_floor, I32)            /* how low may inner block reset padix */
526
527 PERLVAR(I, hints,       U32)            /* pragma-tic compile-time flags */
528
529 PERLVAR(I, debug,       VOL U32)        /* flags given to -D switch */
530
531 /* Perl_Ibreakable_sub_generation_ptr was too long for VMS, hence "gen"  */
532 PERLVARI(I, breakable_sub_gen, U32, 0)
533
534 #ifdef USE_LOCALE_COLLATE
535 PERLVAR(I, collation_name, char *)      /* Name of current collation */
536 PERLVAR(I, collxfrm_base, Size_t)       /* Basic overhead in *xfrm() */
537 PERLVARI(I, collxfrm_mult,Size_t, 2)    /* Expansion factor in *xfrm() */
538 PERLVARI(I, collation_ix, U32,  0)      /* Collation generation index */
539 PERLVARI(I, collation_standard, bool, TRUE)
540                                         /* Assume simple collation */
541 #endif /* USE_LOCALE_COLLATE */
542
543
544 #if defined (PERL_UTF8_CACHE_ASSERT) || defined (DEBUGGING)
545 #  define PERL___I -1
546 #else
547 #  define PERL___I 1
548 #endif
549 PERLVARI(I, utf8cache, I8, PERL___I)    /* Is the utf8 caching code enabled? */
550 #undef PERL___I
551
552
553 #ifdef USE_LOCALE_NUMERIC
554
555 PERLVARI(I, numeric_standard, bool, TRUE)
556                                         /* Assume simple numerics */
557 PERLVARI(I, numeric_local, bool, TRUE)
558                                         /* Assume local numerics */
559 PERLVAR(I, numeric_name, char *)        /* Name of current numeric locale */
560 PERLVAR(I, numeric_radix_sv, SV *)      /* The radix separator if not '.' */
561
562 #endif /* !USE_LOCALE_NUMERIC */
563
564 /* Unicode inversion lists */
565 PERLVAR(I, ASCII,       SV *)
566 PERLVAR(I, Latin1,      SV *)
567 PERLVAR(I, AboveLatin1, SV *)
568
569 PERLVAR(I, NonL1NonFinalFold,   SV *)
570 PERLVAR(I, HasMultiCharFold,   SV *)
571
572 /* utf8 character class swashes */
573 PERLVAR(I, utf8_mark,   SV *)
574 PERLVAR(I, utf8_X_regular_begin, SV *)
575 PERLVAR(I, utf8_X_extend, SV *)
576 PERLVAR(I, utf8_toupper, SV *)
577 PERLVAR(I, utf8_totitle, SV *)
578 PERLVAR(I, utf8_tolower, SV *)
579 PERLVAR(I, utf8_tofold, SV *)
580 PERLVAR(I, utf8_charname_begin, SV *)
581 PERLVAR(I, utf8_charname_continue, SV *)
582
583 PERLVARA(I, utf8_swash_ptrs, POSIX_SWASH_COUNT, SV *)
584 PERLVARA(I, Posix_ptrs, POSIX_CC_COUNT, SV *)
585 PERLVARA(I, L1Posix_ptrs, POSIX_CC_COUNT, SV *)
586 PERLVARA(I, XPosix_ptrs, POSIX_CC_COUNT, SV *)
587
588 PERLVAR(I, last_swash_hv, HV *)
589 PERLVAR(I, last_swash_tmps, U8 *)
590 PERLVAR(I, last_swash_slen, STRLEN)
591 PERLVARA(I, last_swash_key,UTF8_MAXBYTES-1, U8)
592 PERLVAR(I, last_swash_klen, U8)         /* Only needs to store 0-12  */
593
594 #ifdef FCRYPT
595 PERLVARI(I, cryptseen,  bool,   FALSE)  /* has fast crypt() been initialized? */
596 #endif
597
598 PERLVAR(I, pad_reset_pending, bool)     /* reset pad on next attempted alloc */
599 PERLVAR(I, srand_called, bool)
600 PERLVARI(I, in_load_module, bool, FALSE)        /* to prevent recursions in PerlIO_find_layer */
601
602 PERLVAR(I, parser,      yy_parser *)    /* current parser state */
603
604 /* Array of signal handlers, indexed by signal number, through which the C
605    signal handler dispatches.  */
606 PERLVAR(I, psig_ptr,    SV **)
607 /* Array of names of signals, indexed by signal number, for (re)use as the first
608    argument to a signal handler.   Only one block of memory is allocated for
609    both psig_name and psig_ptr.  */
610 PERLVAR(I, psig_name,   SV **)
611
612 #if defined(PERL_IMPLICIT_SYS)
613 PERLVAR(I, Mem,         struct IPerlMem *)
614 PERLVAR(I, MemShared,   struct IPerlMem *)
615 PERLVAR(I, MemParse,    struct IPerlMem *)
616 PERLVAR(I, Env,         struct IPerlEnv *)
617 PERLVAR(I, StdIO,       struct IPerlStdIO *)
618 PERLVAR(I, LIO,         struct IPerlLIO *)
619 PERLVAR(I, Dir,         struct IPerlDir *)
620 PERLVAR(I, Sock,        struct IPerlSock *)
621 PERLVAR(I, Proc,        struct IPerlProc *)
622 #endif
623
624 PERLVAR(I, ptr_table,   PTR_TBL_t *)
625 PERLVARI(I, beginav_save, AV *, NULL)   /* save BEGIN{}s when compiling */
626
627 PERLVAR(I, body_arenas, void *)         /* pointer to list of body-arenas */
628
629
630 #if defined(USE_ITHREADS)
631 PERLVAR(I, regex_pad,     SV **)        /* Shortcut into the array of
632                                            regex_padav */
633 PERLVAR(I, regex_padav,   AV *)         /* All regex objects, indexed via the
634                                            values in op_pmoffset of pmop.
635                                            Entry 0 is an SV whose PV is a
636                                            "packed" list of IVs listing
637                                            the now-free slots in the array */
638 PERLVAR(I, stashpad,    HV **)          /* for CopSTASH */
639 PERLVARI(I, stashpadmax, PADOFFSET, 64)
640 PERLVARI(I, stashpadix, PADOFFSET, 0)
641 #endif
642
643 #ifdef USE_REENTRANT_API
644 PERLVAR(I, reentrant_buffer, REENTR *)  /* here we store the _r buffers */
645 #endif
646
647 PERLVAR(I, custom_op_names, HV *)       /* Names of user defined ops */
648 PERLVAR(I, custom_op_descs, HV *)       /* Descriptions of user defined ops */
649
650 #ifdef PERLIO_LAYERS
651 PERLVARI(I, perlio,     PerlIOl *, NULL)
652 PERLVARI(I, known_layers, PerlIO_list_t *, NULL)
653 PERLVARI(I, def_layerlist, PerlIO_list_t *, NULL)
654 #endif
655
656 PERLVARI(I, encoding,   SV *,   NULL)   /* character encoding */
657
658 PERLVAR(I, debug_pad,   struct perl_debug_pad)  /* always needed because of the re extension */
659
660 PERLVAR(I, utf8_idstart, SV *)
661 PERLVAR(I, utf8_idcont, SV *)
662 PERLVAR(I, utf8_xidstart, SV *)
663 PERLVAR(I, utf8_perl_idstart, SV *)
664 PERLVAR(I, utf8_perl_idcont, SV *)
665 PERLVAR(I, utf8_xidcont, SV *)
666
667 PERLVAR(I, sort_RealCmp, SVCOMPARE_t)
668
669 PERLVARI(I, checkav_save, AV *, NULL)   /* save CHECK{}s when compiling */
670 PERLVARI(I, unitcheckav_save, AV *, NULL)
671                                         /* save UNITCHECK{}s when compiling */
672
673 PERLVARI(I, clocktick,  long,   0)      /* this many times() ticks in a second */
674
675 PERLVAR(I, stashcache,  HV *)           /* Cache to speed up S_method_common */
676
677 /* Hooks to shared SVs and locks. */
678 PERLVARI(I, sharehook,  share_proc_t, Perl_sv_nosharing)
679 PERLVARI(I, lockhook,   share_proc_t, Perl_sv_nosharing)
680 #ifdef NO_MATHOMS
681 #  define PERL_UNLOCK_HOOK Perl_sv_nosharing
682 #else
683 /* This reference ensures that the mathoms are linked with perl */
684 #  define PERL_UNLOCK_HOOK Perl_sv_nounlocking
685 #endif
686 PERLVARI(I, unlockhook, share_proc_t, PERL_UNLOCK_HOOK)
687
688 PERLVARI(I, threadhook, thrhook_proc_t, Perl_nothreadhook)
689
690 /* Can shared object be destroyed */
691 PERLVARI(I, destroyhook, destroyable_proc_t, Perl_sv_destroyable)
692
693 #ifndef PERL_MICRO
694 PERLVARI(I, signalhook, despatch_signals_proc_t, Perl_despatch_signals)
695 #endif
696
697 PERLVARI(I, isarev, HV *, NULL)         /* Reverse map of @ISA dependencies */
698
699 /* Register of known Method Resolution Orders.
700    What this actually points to is an implementation detail (it may change to
701    a structure incorporating a reference count - use mro_get_from_name to
702    retrieve a C<struct mro_alg *>  */
703 PERLVAR(I, registered_mros, HV *)
704
705 /* Compile-time block start/end hooks */
706 PERLVAR(I, blockhooks,  AV *)
707
708 /* Everything that folds to a given character, for case insensitivity regex
709  * matching */
710 PERLVARI(I, utf8_foldclosures, HV *, NULL)
711
712 /* List of characters that participate in folds (except marks, etc in
713  * multi-char folds) */
714 PERLVARI(I, utf8_foldable, SV *, NULL)
715
716 PERLVAR(I, custom_ops,  HV *)           /* custom op registrations */
717
718 /* Hook for File::Glob */
719 PERLVARI(I, globhook,   globhook_t, NULL)
720
721 PERLVAR(I, reentrant_retint, int)       /* Integer return value from reentrant functions */
722
723 /* The last unconditional member of the interpreter structure when 5.10.0 was
724    released. The offset of the end of this is baked into a global variable in 
725    any shared perl library which will allow a sanity test in future perl
726    releases.  */
727 #define PERL_LAST_5_16_0_INTERP_MEMBER  Ireentrant_retint
728
729 #ifdef PERL_IMPLICIT_CONTEXT
730 PERLVARI(I, my_cxt_list, void **, NULL) /* per-module array of MY_CXT pointers */
731 PERLVARI(I, my_cxt_size, int,   0)      /* size of PL_my_cxt_list */
732 #  ifdef PERL_GLOBAL_STRUCT_PRIVATE
733 PERLVARI(I, my_cxt_keys, const char **, NULL) /* per-module array of pointers to MY_CXT_KEY constants */
734 #  endif
735 #endif
736
737 #ifdef PERL_TRACK_MEMPOOL
738 /* For use with the memory debugging code in util.c  */
739 PERLVAR(I, memory_debug_header, struct perl_memory_debug_header)
740 #endif
741
742 #ifdef DEBUG_LEAKING_SCALARS_FORK_DUMP
743 /* File descriptor to talk to the child which dumps scalars.  */
744 PERLVARI(I, dumper_fd,  int,    -1)
745 #endif
746
747 #ifdef PERL_MAD
748 PERLVARI(I, madskills,  bool,   FALSE)  /* preserve all syntactic info */
749                                         /* (MAD = Misc Attribute Decoration) */
750 PERLVARI(I, xmlfp,      PerlIO *, NULL)
751 #endif
752
753 #ifdef DEBUG_LEAKING_SCALARS
754 PERLVARI(I, sv_serial,  U32,    0)      /* SV serial number, used in sv.c */
755 #endif
756
757 /* If you are adding a U8 or U16, check to see if there are 'Space' comments
758  * above on where there are gaps which currently will be structure padding.  */
759
760 /* Within a stable branch, new variables must be added to the very end, before
761  * this comment, for binary compatibility (the offsets of the old members must
762  *  not change).
763  * (Don't forget to add your variable also to perl_clone()!)
764  * XSUB.h provides wrapper functions via perlapi.h that make this
765  * irrelevant, but not all code may be expected to #include XSUB.h.
766  */