This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Defaulting to VMS is probably not right.
[perl5.git] / perlapi.h
1 /* -*- buffer-read-only: t -*-
2  *
3  *    perlapi.h
4  *
5  *    Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
6  *    2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 by Larry Wall and others
7  *
8  *    You may distribute under the terms of either the GNU General Public
9  *    License or the Artistic License, as specified in the README file.
10  *
11  * !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
12  * This file is built by regen/embed.pl from data in embed.fnc,
13  * regen/embed.pl, regen/opcodes, intrpvar.h and perlvars.h.
14  * Any changes made here will be lost!
15  *
16  * Edit those files and run 'make regen_headers' to effect changes.
17  */
18
19 /* declare accessor functions for Perl variables */
20 #ifndef __perlapi_h__
21 #define __perlapi_h__
22
23 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
24
25 START_EXTERN_C
26
27 #undef PERLVAR
28 #undef PERLVARA
29 #undef PERLVARI
30 #undef PERLVARIC
31 #define PERLVAR(p,v,t)  EXTERN_C t* Perl_##p##v##_ptr(pTHX);
32 #define PERLVARA(p,v,n,t)       typedef t PL_##v##_t[n];                \
33                         EXTERN_C PL_##v##_t* Perl_##p##v##_ptr(pTHX);
34 #define PERLVARI(p,v,t,i)       PERLVAR(p,v,t)
35 #define PERLVARIC(p,v,t,i) PERLVAR(p,v, const t)
36
37 #include "perlvars.h"
38
39 #undef PERLVAR
40 #undef PERLVARA
41 #undef PERLVARI
42 #undef PERLVARIC
43
44 END_EXTERN_C
45
46 #if defined(PERL_CORE)
47
48 /* accessor functions for Perl "global" variables */
49
50 /* these need to be mentioned here, or most linkers won't put them in
51    the perl executable */
52
53 #ifndef PERL_NO_FORCE_LINK
54
55 START_EXTERN_C
56
57 #ifndef DOINIT
58 EXTCONST void * const PL_force_link_funcs[];
59 #else
60 EXTCONST void * const PL_force_link_funcs[] = {
61 #undef PERLVAR
62 #undef PERLVARA
63 #undef PERLVARI
64 #undef PERLVARIC
65 #define PERLVAR(p,v,t)          (void*)Perl_##p##v##_ptr,
66 #define PERLVARA(p,v,n,t)       PERLVAR(p,v,t)
67 #define PERLVARI(p,v,t,i)       PERLVAR(p,v,t)
68 #define PERLVARIC(p,v,t,i)      PERLVAR(p,v,t)
69
70 /* In Tru64 (__DEC && __osf__) the cc option -std1 causes that one
71  * cannot cast between void pointers and function pointers without
72  * info level warnings.  The PL_force_link_funcs[] would cause a few
73  * hundred of those warnings.  In code one can circumnavigate this by using
74  * unions that overlay the different pointers, but in declarations one
75  * cannot use this trick.  Therefore we just disable the warning here
76  * for the duration of the PL_force_link_funcs[] declaration. */
77
78 #if defined(__DECC) && defined(__osf__)
79 #pragma message save
80 #pragma message disable (nonstandcast)
81 #endif
82
83 #include "perlvars.h"
84
85 #if defined(__DECC) && defined(__osf__)
86 #pragma message restore
87 #endif
88
89 #undef PERLVAR
90 #undef PERLVARA
91 #undef PERLVARI
92 #undef PERLVARIC
93 };
94 #endif  /* DOINIT */
95
96 END_EXTERN_C
97
98 #endif  /* PERL_NO_FORCE_LINK */
99
100 #else   /* !PERL_CORE */
101
102 #undef  PL_appctx
103 #define PL_appctx               (*Perl_Gappctx_ptr(NULL))
104 #undef  PL_check
105 #define PL_check                (*Perl_Gcheck_ptr(NULL))
106 #undef  PL_check_mutex
107 #define PL_check_mutex          (*Perl_Gcheck_mutex_ptr(NULL))
108 #undef  PL_csighandlerp
109 #define PL_csighandlerp         (*Perl_Gcsighandlerp_ptr(NULL))
110 #undef  PL_curinterp
111 #define PL_curinterp            (*Perl_Gcurinterp_ptr(NULL))
112 #undef  PL_do_undump
113 #define PL_do_undump            (*Perl_Gdo_undump_ptr(NULL))
114 #undef  PL_dollarzero_mutex
115 #define PL_dollarzero_mutex     (*Perl_Gdollarzero_mutex_ptr(NULL))
116 #undef  PL_fold_locale
117 #define PL_fold_locale          (*Perl_Gfold_locale_ptr(NULL))
118 #undef  PL_hash_seed
119 #define PL_hash_seed            (*Perl_Ghash_seed_ptr(NULL))
120 #undef  PL_hash_seed_set
121 #define PL_hash_seed_set        (*Perl_Ghash_seed_set_ptr(NULL))
122 #undef  PL_hints_mutex
123 #define PL_hints_mutex          (*Perl_Ghints_mutex_ptr(NULL))
124 #undef  PL_keyword_plugin
125 #define PL_keyword_plugin       (*Perl_Gkeyword_plugin_ptr(NULL))
126 #undef  PL_malloc_mutex
127 #define PL_malloc_mutex         (*Perl_Gmalloc_mutex_ptr(NULL))
128 #undef  PL_mmap_page_size
129 #define PL_mmap_page_size       (*Perl_Gmmap_page_size_ptr(NULL))
130 #undef  PL_my_ctx_mutex
131 #define PL_my_ctx_mutex         (*Perl_Gmy_ctx_mutex_ptr(NULL))
132 #undef  PL_my_cxt_index
133 #define PL_my_cxt_index         (*Perl_Gmy_cxt_index_ptr(NULL))
134 #undef  PL_op_mutex
135 #define PL_op_mutex             (*Perl_Gop_mutex_ptr(NULL))
136 #undef  PL_op_seq
137 #define PL_op_seq               (*Perl_Gop_seq_ptr(NULL))
138 #undef  PL_op_sequence
139 #define PL_op_sequence          (*Perl_Gop_sequence_ptr(NULL))
140 #undef  PL_perlio_debug_fd
141 #define PL_perlio_debug_fd      (*Perl_Gperlio_debug_fd_ptr(NULL))
142 #undef  PL_perlio_fd_refcnt
143 #define PL_perlio_fd_refcnt     (*Perl_Gperlio_fd_refcnt_ptr(NULL))
144 #undef  PL_perlio_fd_refcnt_size
145 #define PL_perlio_fd_refcnt_size        (*Perl_Gperlio_fd_refcnt_size_ptr(NULL))
146 #undef  PL_perlio_mutex
147 #define PL_perlio_mutex         (*Perl_Gperlio_mutex_ptr(NULL))
148 #undef  PL_ppaddr
149 #define PL_ppaddr               (*Perl_Gppaddr_ptr(NULL))
150 #undef  PL_sh_path
151 #define PL_sh_path              (*Perl_Gsh_path_ptr(NULL))
152 #undef  PL_sig_defaulting
153 #define PL_sig_defaulting       (*Perl_Gsig_defaulting_ptr(NULL))
154 #undef  PL_sig_handlers_initted
155 #define PL_sig_handlers_initted (*Perl_Gsig_handlers_initted_ptr(NULL))
156 #undef  PL_sig_ignoring
157 #define PL_sig_ignoring         (*Perl_Gsig_ignoring_ptr(NULL))
158 #undef  PL_sig_trapped
159 #define PL_sig_trapped          (*Perl_Gsig_trapped_ptr(NULL))
160 #undef  PL_sigfpe_saved
161 #define PL_sigfpe_saved         (*Perl_Gsigfpe_saved_ptr(NULL))
162 #undef  PL_sv_placeholder
163 #define PL_sv_placeholder       (*Perl_Gsv_placeholder_ptr(NULL))
164 #undef  PL_thr_key
165 #define PL_thr_key              (*Perl_Gthr_key_ptr(NULL))
166 #undef  PL_timesbase
167 #define PL_timesbase            (*Perl_Gtimesbase_ptr(NULL))
168 #undef  PL_use_safe_putenv
169 #define PL_use_safe_putenv      (*Perl_Guse_safe_putenv_ptr(NULL))
170 #undef  PL_veto_cleanup
171 #define PL_veto_cleanup         (*Perl_Gveto_cleanup_ptr(NULL))
172 #undef  PL_watch_pvx
173 #define PL_watch_pvx            (*Perl_Gwatch_pvx_ptr(NULL))
174
175 #endif /* !PERL_CORE */
176 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
177
178 #endif /* __perlapi_h__ */
179
180 /* ex: set ro: */