This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
slightly tweaked version of suggested patch
[perl5.git] / intrpvar.h
1 /***********************************************/
2 /* Global only to current interpreter instance */
3 /***********************************************/
4
5 /* Don't forget to re-run embed.pl to propagate changes! */
6
7 /* The 'I' prefix is only needed for vars that need appropriate #defines
8  * generated when built with or without MULTIPLICITY.  It is also used
9  * to generate the appropriate export list for win32.
10  *
11  * When building without MULTIPLICITY, these variables will be truly global.
12  *
13  * Avoid build-specific #ifdefs here, like DEBUGGING.  That way,
14  * we can keep binary compatibility of the curinterp structure */
15
16 /* pseudo environmental stuff */
17 PERLVAR(Iorigargc,      int)
18 PERLVAR(Iorigargv,      char **)
19 PERLVAR(Ienvgv,         GV *)
20 PERLVAR(Isiggv,         GV *)
21 PERLVAR(Iincgv,         GV *)
22 PERLVAR(Ihintgv,        GV *)
23 PERLVAR(Iorigfilename,  char *)
24 PERLVAR(Idiehook,       SV *)
25 PERLVAR(Iwarnhook,      SV *)
26 PERLVAR(Iparsehook,     SV *)
27 PERLVAR(Icddir,         char *)         /* switches */
28 PERLVAR(Iminus_c,       bool)
29 PERLVAR(Ipatchlevel[10],char)
30 PERLVAR(Ilocalpatches,  char **)
31 PERLVARI(Isplitstr,     char *, " ")
32 PERLVAR(Ipreprocess,    bool)
33 PERLVAR(Iminus_n,       bool)
34 PERLVAR(Iminus_p,       bool)
35 PERLVAR(Iminus_l,       bool)
36 PERLVAR(Iminus_a,       bool)
37 PERLVAR(Iminus_F,       bool)
38 PERLVAR(Idoswitches,    bool)
39 PERLVAR(Idowarn,        bool)
40 PERLVAR(Idoextract,     bool)
41 PERLVAR(Isawampersand,  bool)           /* must save all match strings */
42 PERLVAR(Isawstudy,      bool)           /* do fbm_instr on all strings */
43 PERLVAR(Isawvec,        bool)
44 PERLVAR(Iunsafe,        bool)
45 PERLVAR(Iinplace,       char *)
46 PERLVAR(Ie_script,      SV *)
47 PERLVAR(Iperldb,        U32)
48
49 /* This value may be raised by extensions for testing purposes */
50 /* 0=none, 1=full, 2=full with checks */
51 PERLVARI(Iperl_destruct_level,  int,    0)
52
53 /* magical thingies */
54 PERLVAR(Ibasetime,      Time_t)         /* $^T */
55 PERLVAR(Iformfeed,      SV *)           /* $^L */
56
57
58 PERLVARI(Imaxsysfd,     I32,    MAXSYSFD)
59                                         /* top fd to pass to subprocesses */
60 PERLVAR(Imultiline,     int)            /* $*--do strings hold >1 line? */
61 PERLVAR(Istatusvalue,   I32)            /* $? */
62 #ifdef VMS
63 PERLVAR(Istatusvalue_vms,U32)
64 #endif
65
66 /* shortcuts to various I/O objects */
67 PERLVAR(Istdingv,       GV *)
68 PERLVAR(Idefgv,         GV *)
69 PERLVAR(Iargvgv,        GV *)
70 PERLVAR(Iargvoutgv,     GV *)
71
72 /* shortcuts to regexp stuff */
73 /* XXX these three aren't used anywhere */
74 PERLVAR(Ileftgv,        GV *)
75 PERLVAR(Iampergv,       GV *)
76 PERLVAR(Irightgv,       GV *)
77
78 /* this one needs to be moved to thrdvar.h and accessed via
79  * find_threadsv() when USE_THREADS */
80 PERLVAR(Ireplgv,        GV *)
81
82 /* shortcuts to misc objects */
83 PERLVAR(Ierrgv,         GV *)
84
85 /* shortcuts to debugging objects */
86 PERLVAR(IDBgv,          GV *)
87 PERLVAR(IDBline,        GV *)
88 PERLVAR(IDBsub,         GV *)
89 PERLVAR(IDBsingle,      SV *)
90 PERLVAR(IDBtrace,       SV *)
91 PERLVAR(IDBsignal,      SV *)
92 PERLVAR(Ilineary,       AV *)           /* lines of script for debugger */
93 PERLVAR(Idbargs,        AV *)           /* args to call listed by caller function */
94
95 /* symbol tables */
96 PERLVAR(Idebstash,      HV *)           /* symbol table for perldb package */
97 PERLVAR(Iglobalstash,   HV *)           /* global keyword overrides imported here */
98 PERLVAR(Icurstname,     SV *)           /* name of current package */
99 PERLVAR(Ibeginav,       AV *)           /* names of BEGIN subroutines */
100 PERLVAR(Iendav,         AV *)           /* names of END subroutines */
101 PERLVAR(Iinitav,        AV *)           /* names of INIT subroutines */
102 PERLVAR(Istrtab,        HV *)           /* shared string table */
103 PERLVARI(Isub_generation,U32,1)         /* incr to invalidate method cache */
104
105 /* memory management */
106 PERLVAR(Isv_count,      I32)            /* how many SV* are currently allocated */
107 PERLVAR(Isv_objcount,   I32)            /* how many objects are currently allocated */
108 PERLVAR(Isv_root,       SV*)            /* storage for SVs belonging to interp */
109 PERLVAR(Isv_arenaroot,  SV*)            /* list of areas for garbage collection */
110
111 /* funky return mechanisms */
112 PERLVAR(Ilastspbase,    I32)
113 PERLVAR(Ilastsize,      I32)
114 PERLVAR(Iforkprocess,   int)            /* so do_open |- can return proc# */
115
116 /* subprocess state */
117 PERLVAR(Ifdpid,         AV *)           /* keep fd-to-pid mappings for my_popen */
118
119 /* internal state */
120 PERLVAR(Itainting,      bool)           /* doing taint checks */
121 PERLVARI(Iop_mask,      char *, NULL)   /* masked operations for safe evals */
122
123 /* trace state */
124 PERLVAR(Idlevel,        I32)
125 PERLVARI(Idlmax,        I32,    128)
126 PERLVAR(Idebname,       char *)
127 PERLVAR(Idebdelim,      char *)
128
129 /* current interpreter roots */
130 PERLVAR(Imain_cv,       CV *)
131 PERLVAR(Imain_root,     OP *)
132 PERLVAR(Imain_start,    OP *)
133 PERLVAR(Ieval_root,     OP *)
134 PERLVAR(Ieval_start,    OP *)
135
136 /* runtime control stuff */
137 PERLVARI(Icurcopdb,     COP *,  NULL)
138 PERLVARI(Icopline,      line_t, NOLINE)
139
140 /* statics moved here for shared library purposes */
141 PERLVAR(Istrchop,       SV)             /* return value from chop */
142 PERLVAR(Ifilemode,      int)            /* so nextargv() can preserve mode */
143 PERLVAR(Ilastfd,        int)            /* what to preserve mode on */
144 PERLVAR(Ioldname,       char *)         /* what to preserve mode on */
145 PERLVAR(IArgv,          char **)        /* stuff to free from do_aexec, vfork safe */
146 PERLVAR(ICmd,           char *)         /* stuff to free from do_aexec, vfork safe */
147 PERLVAR(Imystrk,        SV *)           /* temp key string for do_each() */
148 PERLVAR(Ioldlastpm,     PMOP *)         /* for saving regexp context in debugger */
149 PERLVAR(Igensym,        I32)            /* next symbol for getsym() to define */
150 PERLVAR(Ipreambled,     bool)
151 PERLVAR(Ipreambleav,    AV *)
152 PERLVARI(Ilaststatval,  int,    -1)
153 PERLVARI(Ilaststype,    I32,    OP_STAT)
154 PERLVAR(Imess_sv,       SV *)
155
156 /* XXX shouldn't these be per-thread? --GSAR */
157 PERLVAR(Iors,           char *)         /* output record separator $\ */
158 PERLVAR(Iorslen,        STRLEN)
159 PERLVAR(Iofmt,          char *)         /* output format for numbers $# */
160
161 /* interpreter atexit processing */
162 PERLVARI(Iexitlist,     PerlExitListEntry *, NULL)
163                                         /* list of exit functions */
164 PERLVARI(Iexitlistlen,  I32, 0)         /* length of same */
165 PERLVAR(Imodglobal,     HV *)           /* per-interp module data */
166
167 /* these used to be in global before 5.004_68 */
168 PERLVARI(Iprofiledata,  U32 *,  NULL)   /* table of ops, counts */
169 PERLVARI(Irsfp, PerlIO * VOL,   Nullfp) /* current source file pointer */
170 PERLVARI(Irsfp_filters, AV *,   Nullav) /* keeps active source filters */
171
172 PERLVAR(Icompiling,     COP)            /* compiling/done executing marker */
173
174 PERLVAR(Icompcv,        CV *)           /* currently compiling subroutine */
175 PERLVAR(Icomppad,       AV *)           /* storage for lexically scoped temporaries */
176 PERLVAR(Icomppad_name,  AV *)           /* variable names for "my" variables */
177 PERLVAR(Icomppad_name_fill,     I32)    /* last "introduced" variable offset */
178 PERLVAR(Icomppad_name_floor,    I32)    /* start of vars in innermost block */
179
180 #ifdef HAVE_INTERP_INTERN
181 PERLVAR(Isys_intern,    struct interp_intern)
182                                         /* platform internals */
183 #endif
184
185 /* more statics moved here */
186 PERLVARI(Igeneration,   int,    100)    /* from op.c */
187 PERLVAR(IDBcv,          CV *)           /* from perl.c */
188 PERLVAR(Iarchpat_auto,  char*)          /* from perl.c */
189
190 PERLVARI(Iin_clean_objs,bool,    FALSE) /* from sv.c */
191 PERLVARI(Iin_clean_all, bool,    FALSE) /* from sv.c */
192
193 PERLVAR(Ilinestart,     char *)         /* beg. of most recently read line */
194 PERLVAR(Ipending_ident, char)           /* pending identifier lookup */
195 PERLVAR(Isublex_info,   SUBLEXINFO)     /* from toke.c */
196
197 #ifdef USE_THREADS
198 PERLVAR(Ithrsv,         SV *)           /* struct perl_thread for main thread */
199 PERLVARI(Ithreadnum,    U32,    0)      /* incremented each thread creation */
200 PERLVAR(Istrtab_mutex,  perl_mutex)     /* Mutex for string table access */
201 #endif /* USE_THREADS */
202
203 PERLVAR(Iuid,           int)            /* current real user id */
204 PERLVAR(Ieuid,          int)            /* current effective user id */
205 PERLVAR(Igid,           int)            /* current real group id */
206 PERLVAR(Iegid,          int)            /* current effective group id */
207 PERLVAR(Inomemok,       bool)           /* let malloc context handle nomem */
208 PERLVAR(Ian,            U32)            /* malloc sequence number */
209 PERLVAR(Icop_seqmax,    U32)            /* statement sequence number */
210 PERLVAR(Iop_seqmax,     U16)            /* op sequence number */
211 PERLVAR(Ievalseq,       U32)            /* eval sequence number */
212 PERLVAR(Iorigenviron,   char **)
213 PERLVAR(Iorigalen,      U32)
214 PERLVAR(Ipidstatus,     HV *)           /* pid-to-status mappings for waitpid */
215 PERLVARI(Imaxo, int,    MAXO)           /* maximum number of ops */
216 PERLVAR(Iosname,        char *)         /* operating system */
217 PERLVARI(Ish_path,      char *, SH_PATH)/* full path of shell */
218 PERLVAR(Isighandlerp,   Sighandler_t)
219
220 PERLVAR(Ixiv_arenaroot, XPV*)           /* list of allocated xiv areas */
221 PERLVAR(Ixiv_root,      IV *)           /* free xiv list--shared by interpreters */
222 PERLVAR(Ixnv_root,      NV *)           /* free xnv list--shared by interpreters */
223 PERLVAR(Ixrv_root,      XRV *)          /* free xrv list--shared by interpreters */
224 PERLVAR(Ixpv_root,      XPV *)          /* free xpv list--shared by interpreters */
225 PERLVAR(Ihe_root,       HE *)           /* free he list--shared by interpreters */
226 PERLVAR(Inice_chunk,    char *)         /* a nice chunk of memory to reuse */
227 PERLVAR(Inice_chunk_size,       U32)    /* how nice the chunk of memory is */
228
229 PERLVARI(Irunops,       runops_proc_t,  FUNC_NAME_TO_PTR(RUNOPS_DEFAULT))
230
231 PERLVAR(Itokenbuf[256], char)
232
233 PERLVAR(Isv_undef,      SV)
234 PERLVAR(Isv_no,         SV)
235 PERLVAR(Isv_yes,        SV)
236
237 #ifdef CSH
238 PERLVARI(Icshname,      char *, CSH)
239 PERLVAR(Icshlen,        I32)
240 #endif
241
242 PERLVAR(Ilex_state,     U32)            /* next token is determined */
243 PERLVAR(Ilex_defer,     U32)            /* state after determined token */
244 PERLVAR(Ilex_expect,    expectation)    /* expect after determined token */
245 PERLVAR(Ilex_brackets,  I32)            /* bracket count */
246 PERLVAR(Ilex_formbrack, I32)            /* bracket count at outer format level */
247 PERLVAR(Ilex_fakebrack, I32)            /* outer bracket is mere delimiter */
248 PERLVAR(Ilex_casemods,  I32)            /* casemod count */
249 PERLVAR(Ilex_dojoin,    I32)            /* doing an array interpolation */
250 PERLVAR(Ilex_starts,    I32)            /* how many interps done on level */
251 PERLVAR(Ilex_stuff,     SV *)           /* runtime pattern from m// or s/// */
252 PERLVAR(Ilex_repl,      SV *)           /* runtime replacement from s/// */
253 PERLVAR(Ilex_op,        OP *)           /* extra info to pass back on op */
254 PERLVAR(Ilex_inpat,     OP *)           /* in pattern $) and $| are special */
255 PERLVAR(Ilex_inwhat,    I32)            /* what kind of quoting are we in */
256 PERLVAR(Ilex_brackstack,char *)         /* what kind of brackets to pop */
257 PERLVAR(Ilex_casestack, char *)         /* what kind of case mods in effect */
258
259 /* What we know when we're in LEX_KNOWNEXT state. */
260 PERLVAR(Inextval[5],    YYSTYPE)        /* value of next token, if any */
261 PERLVAR(Inexttype[5],   I32)            /* type of next token */
262 PERLVAR(Inexttoke,      I32)
263
264 PERLVAR(Ilinestr,       SV *)
265 PERLVAR(Ibufptr,        char *)
266 PERLVAR(Ioldbufptr,     char *)
267 PERLVAR(Ioldoldbufptr,  char *)
268 PERLVAR(Ibufend,        char *)
269 PERLVARI(Iexpect,expectation,   XSTATE) /* how to interpret ambiguous tokens */
270
271 PERLVAR(Imulti_start,   I32)            /* 1st line of multi-line string */
272 PERLVAR(Imulti_end,     I32)            /* last line of multi-line string */
273 PERLVAR(Imulti_open,    I32)            /* delimiter of said string */
274 PERLVAR(Imulti_close,   I32)            /* delimiter of said string */
275
276 PERLVAR(Ierror_count,   I32)            /* how many errors so far, max 10 */
277 PERLVAR(Isubline,       I32)            /* line this subroutine began on */
278 PERLVAR(Isubname,       SV *)           /* name of current subroutine */
279
280 PERLVAR(Imin_intro_pending,     I32)    /* start of vars to introduce */
281 PERLVAR(Imax_intro_pending,     I32)    /* end of vars to introduce */
282 PERLVAR(Ipadix,         I32)            /* max used index in current "register" pad */
283 PERLVAR(Ipadix_floor,   I32)            /* how low may inner block reset padix */
284 PERLVAR(Ipad_reset_pending,     I32)    /* reset pad on next attempted alloc */
285
286 PERLVAR(Ithisexpr,      I32)            /* name id for nothing_in_common() */
287 PERLVAR(Ilast_uni,      char *)         /* position of last named-unary op */
288 PERLVAR(Ilast_lop,      char *)         /* position of last list operator */
289 PERLVAR(Ilast_lop_op,   OPCODE)         /* last list operator */
290 PERLVAR(Iin_my,         bool)           /* we're compiling a "my" declaration */
291 PERLVAR(Iin_my_stash,   HV *)           /* declared class of this "my" declaration */
292 #ifdef FCRYPT
293 PERLVAR(Icryptseen,     I32)            /* has fast crypt() been initialized? */
294 #endif
295
296 PERLVAR(Ihints, U32)                    /* pragma-tic compile-time flags */
297
298 PERLVAR(Idebug,         VOL U32)        /* flags given to -D switch */
299
300 PERLVAR(Iamagic_generation,     long)
301
302 #ifdef USE_LOCALE_COLLATE
303 PERLVAR(Icollation_ix,  U32)            /* Collation generation index */
304 PERLVAR(Icollation_name,char *)         /* Name of current collation */
305 PERLVARI(Icollation_standard, bool,     TRUE)
306                                         /* Assume simple collation */
307 PERLVAR(Icollxfrm_base, Size_t)         /* Basic overhead in *xfrm() */
308 PERLVARI(Icollxfrm_mult,Size_t, 2)      /* Expansion factor in *xfrm() */
309 #endif /* USE_LOCALE_COLLATE */
310
311 #ifdef USE_LOCALE_NUMERIC
312
313 PERLVAR(Inumeric_name,  char *)         /* Name of current numeric locale */
314 PERLVARI(Inumeric_standard,     bool,   TRUE)
315                                         /* Assume simple numerics */
316 PERLVARI(Inumeric_local,        bool,   TRUE)
317                                         /* Assume local numerics */
318 PERLVAR(Inumeric_radix,         char)
319                                         /* The radix character if not '.' */
320
321 #endif /* !USE_LOCALE_NUMERIC */
322
323 /* utf8 character classes */
324 PERLVAR(Iutf8_alnum,    SV *)
325 PERLVAR(Iutf8_alpha,    SV *)
326 PERLVAR(Iutf8_space,    SV *)
327 PERLVAR(Iutf8_digit,    SV *)
328 PERLVAR(Iutf8_upper,    SV *)
329 PERLVAR(Iutf8_lower,    SV *)
330 PERLVAR(Iutf8_print,    SV *)
331 PERLVAR(Iutf8_mark,     SV *)
332 PERLVAR(Iutf8_toupper,  SV *)
333 PERLVAR(Iutf8_totitle,  SV *)
334 PERLVAR(Iutf8_tolower,  SV *)
335 PERLVAR(Ilast_swash_hv, HV *)
336 PERLVAR(Ilast_swash_klen,       U32)
337 PERLVAR(Ilast_swash_key[10],    U8)
338 PERLVAR(Ilast_swash_tmps,       U8 *)
339 PERLVAR(Ilast_swash_slen,       STRLEN)
340
341 /* perly.c globals */
342 PERLVAR(Iyydebug,       int)
343 PERLVAR(Iyynerrs,       int)
344 PERLVAR(Iyyerrflag,     int)
345 PERLVAR(Iyychar,        int)
346 PERLVAR(Iyyval,         YYSTYPE)
347 PERLVAR(Iyylval,        YYSTYPE)
348
349 PERLVAR(Iglob_index,    int)
350 PERLVAR(Iefloatbuf,     char*)
351 PERLVAR(Iefloatsize,    STRLEN)
352 PERLVAR(Isrand_called,  bool)
353 PERLVAR(Iuudmap[256],   char)
354 PERLVAR(Ibitcount,      char *)
355 PERLVAR(Ifilter_debug,  int)
356
357 #ifdef USE_THREADS
358 PERLVAR(Ithr_key,       perl_key)       /* For per-thread struct perl_thread* */
359 PERLVAR(Isv_mutex,      perl_mutex)     /* Mutex for allocating SVs in sv.c */
360 PERLVAR(Imalloc_mutex,  perl_mutex)     /* Mutex for malloc */
361 PERLVAR(Ieval_mutex,    perl_mutex)     /* Mutex for doeval */
362 PERLVAR(Ieval_cond,     perl_cond)      /* Condition variable for doeval */
363 PERLVAR(Ieval_owner,    struct perl_thread *)
364                                         /* Owner thread for doeval */
365 PERLVAR(Inthreads,      int)            /* Number of threads currently */
366 PERLVAR(Ithreads_mutex, perl_mutex)     /* Mutex for nthreads and thread list */
367 PERLVAR(Inthreads_cond, perl_cond)      /* Condition variable for nthreads */
368 PERLVAR(Isvref_mutex,   perl_mutex)     /* Mutex for SvREFCNT_{inc,dec} */
369 PERLVARI(Ithreadsv_names,char *,        THREADSV_NAMES)
370 #ifdef FAKE_THREADS
371 PERLVAR(Icurthr,        struct perl_thread *)
372                                         /* Currently executing (fake) thread */
373 #endif
374
375 PERLVAR(Icred_mutex,    perl_mutex)     /* altered credentials in effect */
376
377 #endif /* USE_THREADS */
378
379 #ifdef PERL_OBJECT
380 PERLVARI(piMem,         IPerlMem*,  NULL)
381 PERLVARI(piENV,         IPerlEnv*,  NULL)
382 PERLVARI(piStdIO,       IPerlStdIO*, NULL)
383 PERLVARI(piLIO,         IPerlLIO*,  NULL)
384 PERLVARI(piDir,         IPerlDir*,  NULL)
385 PERLVARI(piSock,        IPerlSock*, NULL)
386 PERLVARI(piProc,        IPerlProc*, NULL)
387 #endif