This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regen/embed.pl: Enforce some flag restrictions
[perl5.git] / regen / embed.pl
CommitLineData
5f05dabc 1#!/usr/bin/perl -w
6294c161
DM
2#
3# Regenerate (overwriting only if changed):
4#
5# embed.h
6# embedvar.h
6294c161
DM
7# perlapi.c
8# perlapi.h
9# proto.h
10#
11# from information stored in
12#
13# embed.fnc
14# intrpvar.h
15# perlvars.h
897d3989 16# regen/opcodes
6294c161 17#
6294c161
DM
18# Accepts the standard regen_lib -q and -v args.
19#
20# This script is normally invoked from regen.pl.
e50aee73 21
916e4025 22require 5.004; # keep this compatible, an old perl is all we may have before
954c1994 23 # we build the new one
5f05dabc 24
88e01c9d
AL
25use strict;
26
36bb303b
NC
27BEGIN {
28 # Get function prototypes
3d7c117d
MB
29 require './regen/regen_lib.pl';
30 require './regen/embed_lib.pl';
36bb303b
NC
31}
32
916e4025 33my $unflagged_pointers;
88e01c9d 34
cea2e8a9 35#
346f75ff 36# See database of global and static function prototypes in embed.fnc
cea2e8a9
GS
37# This is used to generate prototype headers under various configurations,
38# export symbols lists for different platforms, and macros to provide an
39# implicit interpreter context argument.
40#
41
eeec122d
KW
42my $error_count = 0;
43sub die_at_end ($) { # Keeps going for now, but makes sure the regen doesn't
44 # succeed.
45 warn shift;
46 $error_count++;
47}
48
03b6588a
KW
49sub full_name ($$) { # Returns the function name with potentially the
50 # prefixes 'S_' or 'Perl_'
51 my ($func, $flags) = @_;
52
5ff52e3c 53 return "Perl_$func" if $flags =~ /p/;
9f589e47 54 return "S_$func" if $flags =~ /[Si]/;
03b6588a
KW
55 return $func;
56}
57
5f8dc073 58sub open_print_header {
56fd1190 59 my ($file, $quote) = @_;
4373e329 60
5f8dc073
NC
61 return open_new($file, '>',
62 { file => $file, style => '*', by => 'regen/embed.pl',
63 from => ['data in embed.fnc', 'regen/embed.pl',
64 'regen/opcodes', 'intrpvar.h', 'perlvars.h'],
65 final => "\nEdit those files and run 'make regen_headers' to effect changes.\n",
66 copyright => [1993 .. 2009], quote => $quote });
67}
7f1be197 68
5ccbf88e
NC
69my ($embed, $core, $ext, $api) = setup_embed();
70
cea2e8a9 71# generate proto.h
9516dc40 72{
5f8dc073
NC
73 my $pr = open_print_header("proto.h");
74 print $pr "START_EXTERN_C\n";
f8394530 75 my $ret;
9516dc40 76
5ccbf88e 77 foreach (@$embed) {
9516dc40
NC
78 if (@$_ == 1) {
79 print $pr "$_->[0]\n";
80 next;
81 }
82
83 my ($flags,$retval,$plain_func,@args) = @$_;
2015d234 84 if ($flags =~ / ( [^AabCDdEefGhiMmNnOoPpRrSsTUuWXx] ) /x) {
eeec122d 85 die_at_end "flag $1 is not legal (for function $plain_func)";
556343f1 86 }
4373e329 87 my @nonnull;
2015d234 88 my $args_assert_line = ( $flags !~ /G/ );
21553840 89 my $has_depth = ( $flags =~ /W/ );
45b29440 90 my $has_context = ( $flags !~ /T/ );
88e01c9d 91 my $never_returns = ( $flags =~ /r/ );
aa4ca557 92 my $binarycompat = ( $flags =~ /b/ );
fe4f8666 93 my $commented_out = ( $flags =~ /m/ );
88e01c9d 94 my $is_malloc = ( $flags =~ /a/ );
b289a0bd 95 my $can_ignore = ( $flags !~ /R/ ) && ( $flags !~ /P/ ) && !$is_malloc;
7918f24d
NC
96 my @names_of_nn;
97 my $func;
88e01c9d 98
9f68b0f7
KW
99 if (! $can_ignore && $retval eq 'void') {
100 warn "It is nonsensical to require the return value of a void function ($plain_func) to be checked";
101 }
82728c33 102
c490e11f
KW
103 die_at_end "$plain_func: S and p flags are mutually exclusive"
104 if $flags =~ /S/ && $flags =~ /p/;
5178f485
KW
105 die_at_end "$plain_func: m and $1 flags are mutually exclusive"
106 if $flags =~ /m/ && $flags =~ /([pS])/;
88e01c9d 107
c490e11f
KW
108 die_at_end "$plain_func: u flag only usable with m" if $flags =~ /u/
109 && $flags !~ /m/;
3dbfa774 110
a5d565cd 111 my $static_inline = 0;
9f589e47 112 if ($flags =~ /([Si])/) {
98c015b7
DD
113 my $type;
114 if ($never_returns) {
9f589e47 115 $type = $1 eq 'S' ? "PERL_STATIC_NO_RET" : "PERL_STATIC_INLINE_NO_RET";
98c015b7
DD
116 }
117 else {
9f589e47 118 $type = $1 eq 'S' ? "STATIC" : "PERL_STATIC_INLINE";
98c015b7 119 }
c707756e 120 $retval = "$type $retval";
2391bfdf 121 die_at_end "Don't declare static function '$plain_func' pure" if $flags =~ /P/;
a5d565cd 122 $static_inline = $type eq 'PERL_STATIC_INLINE';
cea2e8a9 123 }
0cb96387 124 else {
718fae11 125 if ($never_returns) {
c707756e 126 $retval = "PERL_CALLCONV_NO_RET $retval";
718fae11
JD
127 }
128 else {
c707756e 129 $retval = "PERL_CALLCONV $retval";
718fae11 130 }
cea2e8a9 131 }
54c193ae 132
2568c43d
KW
133 die_at_end "For '$plain_func', M flag requires p flag"
134 if $flags =~ /M/ && $flags !~ /p/;
c490e11f
KW
135 die_at_end "For '$plain_func', C flag requires one of [pim] flag"
136 if $flags =~ /C/ && $flags !~ /[ibmp]/;
137 die_at_end "For '$plain_func', X flag requires p or i flag"
138 if $flags =~ /X/ && $flags !~ /[ip]/;
139 die_at_end "For '$plain_func', X and m flags are mutually exclusive"
140 if $flags =~ /X/ && $flags =~ /m/;
141 die_at_end "For '$plain_func', i with [ACX] requires p flag"
142 if $flags =~ /i/ && $flags =~ /[ACX]/ && $flags !~ /p/;
b45969db
KW
143 die_at_end "For '$plain_func', b and m flags are mutually exclusive"
144 . " (try M flag)" if $flags =~ /b/ && $flags =~ /m/;
91bad5a4
KW
145 die_at_end "For '$plain_func', b flag without M flag requires D flag"
146 if $flags =~ /b/ && $flags !~ /M/ && $flags !~ /D/;
54c193ae 147
03b6588a 148 $func = full_name($plain_func, $flags);
3f1866a8 149 $ret = "";
3f1866a8 150 $ret .= "$retval\t$func(";
4373e329
AL
151 if ( $has_context ) {
152 $ret .= @args ? "pTHX_ " : "pTHX";
cea2e8a9
GS
153 }
154 if (@args) {
c490e11f
KW
155 die_at_end "n flag is contradicted by having arguments"
156 if $flags =~ /n/;
4373e329
AL
157 my $n;
158 for my $arg ( @args ) {
159 ++$n;
7827dc65
AL
160 if ( $arg =~ /\*/ && $arg !~ /\b(NN|NULLOK)\b/ ) {
161 warn "$func: $arg needs NN or NULLOK\n";
7827dc65
AL
162 ++$unflagged_pointers;
163 }
88e01c9d
AL
164 my $nn = ( $arg =~ s/\s*\bNN\b\s+// );
165 push( @nonnull, $n ) if $nn;
166
167 my $nullok = ( $arg =~ s/\s*\bNULLOK\b\s+// ); # strip NULLOK with no effect
c48640ec
AL
168
169 # Make sure each arg has at least a type and a var name.
170 # An arg of "int" is valid C, but want it to be "int foo".
171 my $temp_arg = $arg;
172 $temp_arg =~ s/\*//g;
173 $temp_arg =~ s/\s*\bstruct\b\s*/ /g;
7918f24d
NC
174 if ( ($temp_arg ne "...")
175 && ($temp_arg !~ /\w+\s+(\w+)(?:\[\d+\])?\s*$/) ) {
eeec122d 176 die_at_end "$func: $arg ($n) doesn't have a name\n";
c48640ec 177 }
aa4ca557 178 if (defined $1 && $nn && !($commented_out && !$binarycompat)) {
7918f24d
NC
179 push @names_of_nn, $1;
180 }
4373e329 181 }
cea2e8a9
GS
182 $ret .= join ", ", @args;
183 }
184 else {
4373e329 185 $ret .= "void" if !$has_context;
cea2e8a9 186 }
21553840 187 $ret .= " _pDEPTH" if $has_depth;
cea2e8a9 188 $ret .= ")";
f54cb97a
AL
189 my @attrs;
190 if ( $flags =~ /r/ ) {
abb2c242 191 push @attrs, "__attribute__noreturn__";
f54cb97a 192 }
a5c26493
RGS
193 if ( $flags =~ /D/ ) {
194 push @attrs, "__attribute__deprecated__";
195 }
88e01c9d 196 if ( $is_malloc ) {
abb2c242 197 push @attrs, "__attribute__malloc__";
f54cb97a 198 }
88e01c9d 199 if ( !$can_ignore ) {
abb2c242 200 push @attrs, "__attribute__warn_unused_result__";
f54cb97a
AL
201 }
202 if ( $flags =~ /P/ ) {
abb2c242 203 push @attrs, "__attribute__pure__";
f54cb97a 204 }
1c846c1f 205 if( $flags =~ /f/ ) {
cdfeb707 206 my $prefix = $has_context ? 'pTHX_' : '';
5d37acd6
DM
207 my ($args, $pat);
208 if ($args[-1] eq '...') {
209 $args = scalar @args;
210 $pat = $args - 1;
211 $args = $prefix . $args;
212 }
213 else {
214 # don't check args, and guess which arg is the pattern
215 # (one of 'fmt', 'pat', 'f'),
216 $args = 0;
217 my @fmts = grep $args[$_] =~ /\b(f|pat|fmt)$/, 0..$#args;
218 if (@fmts != 1) {
219 die "embed.pl: '$plain_func': can't determine pattern arg\n";
220 }
221 $pat = $fmts[0] + 1;
222 }
223 my $macro = grep($_ == $pat, @nonnull)
cdfeb707
RB
224 ? '__attribute__format__'
225 : '__attribute__format__null_ok__';
531b2663
DM
226 if ($plain_func =~ /strftime/) {
227 push @attrs, sprintf "%s(__strftime__,%s1,0)", $macro, $prefix;
228 }
229 else {
5d37acd6
DM
230 push @attrs, sprintf "%s(__printf__,%s%d,%s)", $macro,
231 $prefix, $pat, $args;
531b2663 232 }
894356b3 233 }
f54cb97a
AL
234 if ( @attrs ) {
235 $ret .= "\n";
236 $ret .= join( "\n", map { "\t\t\t$_" } @attrs );
4373e329 237 }
af3c7592 238 $ret .= ";";
88e01c9d 239 $ret = "/* $ret */" if $commented_out;
2015d234
KW
240
241 $ret .= "\n#define PERL_ARGS_ASSERT_\U$plain_func\E"
242 if $args_assert_line || @names_of_nn;
243 $ret .= "\t\\\n\t" . join '; ', map "assert($_)", @names_of_nn
244 if @names_of_nn;
edfae0c7
KW
245
246 $ret = "#ifndef PERL_NO_INLINE_FUNCTIONS\n$ret\n#endif" if $static_inline;
247 $ret = "#ifndef NO_MATHOMS\n$ret\n#endif" if $binarycompat;
f54cb97a 248 $ret .= @attrs ? "\n\n" : "\n";
9516dc40
NC
249
250 print $pr $ret;
cea2e8a9 251 }
9516dc40 252
897d3989
NC
253 print $pr <<'EOF';
254#ifdef PERL_CORE
255# include "pp_proto.h"
256#endif
257END_EXTERN_C
897d3989 258EOF
9516dc40 259
eeec122d 260 read_only_bottom_close_and_rename($pr) if ! $error_count;
cea2e8a9
GS
261}
262
eeec122d 263die_at_end "$unflagged_pointers pointer arguments to clean up\n" if $unflagged_pointers;
cea2e8a9 264
adf34b4b
NC
265sub readvars {
266 my ($file, $pre) = @_;
d4cce5f1 267 local (*FILE, $_);
adf34b4b 268 my %seen;
1ae6ead9 269 open(FILE, '<', $file)
d4cce5f1
NIS
270 or die "embed.pl: Can't open $file: $!\n";
271 while (<FILE>) {
272 s/[ \t]*#.*//; # Delete comments.
115ff745 273 if (/PERLVARA?I?C?\($pre,\s*(\w+)/) {
eeec122d 274 die_at_end "duplicate symbol $1 while processing $file line $.\n"
adf34b4b 275 if $seen{$1}++;
d4cce5f1
NIS
276 }
277 }
278 close(FILE);
adf34b4b 279 return sort keys %seen;
d4cce5f1
NIS
280}
281
adf34b4b
NC
282my @intrp = readvars 'intrpvar.h','I';
283my @globvar = readvars 'perlvars.h','G';
d4cce5f1 284
125218eb
NC
285sub hide {
286 my ($from, $to, $indent) = @_;
287 $indent = '' unless defined $indent;
288 my $t = int(length("$indent$from") / 8);
289 "#${indent}define $from" . "\t" x ($t < 3 ? 3 - $t : 1) . "$to\n";
5f05dabc 290}
c6af7a1a 291
d4cce5f1
NIS
292sub multon ($$$) {
293 my ($sym,$pre,$ptr) = @_;
3280af22 294 hide("PL_$sym", "($ptr$pre$sym)");
5f05dabc 295}
54aff467 296
5f8dc073 297my $em = open_print_header('embed.h');
e50aee73 298
5f8dc073 299print $em <<'END';
e50aee73
AD
300/* (Doing namespace management portably in C is really gross.) */
301
d51482e4
JH
302/* By defining PERL_NO_SHORT_NAMES (not done by default) the short forms
303 * (like warn instead of Perl_warn) for the API are not defined.
304 * Not defining the short forms is a good thing for cleaner embedding. */
305
306#ifndef PERL_NO_SHORT_NAMES
820c3be9 307
22c35a8c 308/* Hide global symbols */
5f05dabc 309
e50aee73
AD
310END
311
cea2e8a9
GS
312my @az = ('a'..'z');
313
e8a67806
NC
314sub embed_h {
315 my ($guard, $funcs) = @_;
316 print $em "$guard\n" if $guard;
317
2a4d8072 318 my $lines;
e8a67806
NC
319 foreach (@$funcs) {
320 if (@$_ == 1) {
321 my $cond = $_->[0];
322 # Indent the conditionals if we are wrapped in an #if/#endif pair.
323 $cond =~ s/#(.*)/# $1/ if $guard;
2a4d8072 324 $lines .= "$cond\n";
e8a67806
NC
325 next;
326 }
327 my $ret = "";
328 my ($flags,$retval,$func,@args) = @$_;
54c193ae 329 unless ($flags =~ /[omM]/) {
cea2e8a9 330 my $args = scalar @args;
45b29440 331 if ($flags =~ /T/) {
da8a4494
KW
332 my $full_name = full_name($func, $flags);
333 next if $full_name eq $func; # Don't output a no-op.
334 $ret = hide($func, $full_name);
cea2e8a9 335 }
7a5a24f7 336 elsif ($args and $args[$args-1] =~ /\.\.\./) {
e64ca59f
NC
337 if ($flags =~ /p/) {
338 # we're out of luck for varargs functions under CPP
339 # So we can only do these macros for no implicit context:
340 $ret = "#ifndef PERL_IMPLICIT_CONTEXT\n"
03b6588a 341 . hide($func, full_name($func, $flags)) . "#endif\n";
e64ca59f 342 }
7a5a24f7 343 }
cea2e8a9
GS
344 else {
345 my $alist = join(",", @az[0..$args-1]);
346 $ret = "#define $func($alist)";
347 my $t = int(length($ret) / 8);
348 $ret .= "\t" x ($t < 4 ? 4 - $t : 1);
03b6588a 349 $ret .= full_name($func, $flags) . "(aTHX";
cea2e8a9 350 $ret .= "_ " if $alist;
21553840
YO
351 $ret .= $alist;
352 if ($flags =~ /W/) {
353 if ($alist) {
354 $ret .= " _aDEPTH";
355 } else {
356 die "Can't use W without other args (currently)";
357 }
358 }
359 $ret .= ")\n";
cea2e8a9 360 }
3f1866a8 361 $ret = "#ifndef NO_MATHOMS\n$ret#endif\n" if $flags =~ /b/;
cea2e8a9 362 }
2a4d8072 363 $lines .= $ret;
cea2e8a9 364 }
2a4d8072
NC
365 # Prune empty #if/#endif pairs.
366 while ($lines =~ s/#\s*if[^\n]+\n#\s*endif\n//) {
367 }
b2e549c0
NC
368 # Merge adjacent blocks.
369 while ($lines =~ s/(#ifndef PERL_IMPLICIT_CONTEXT
370[^\n]+
371)#endif
372#ifndef PERL_IMPLICIT_CONTEXT
373/$1/) {
374 }
375
2a4d8072 376 print $em $lines;
e8a67806 377 print $em "#endif\n" if $guard;
da4ddda1
NC
378}
379
5ccbf88e
NC
380embed_h('', $api);
381embed_h('#if defined(PERL_CORE) || defined(PERL_EXT)', $ext);
382embed_h('#ifdef PERL_CORE', $core);
e8a67806 383
424a4936 384print $em <<'END';
e50aee73 385
d51482e4 386#endif /* #ifndef PERL_NO_SHORT_NAMES */
35209cc8 387
cea2e8a9
GS
388/* Compatibility stubs. Compile extensions with -DPERL_NOCOMPAT to
389 disable them.
390 */
391
538feb02 392#if !defined(PERL_CORE)
5bc28da9 393# define sv_setptrobj(rv,ptr,name) sv_setref_iv(rv,name,PTR2IV(ptr))
a0714e2c 394# define sv_setptrref(rv,ptr) sv_setref_iv(rv,NULL,PTR2IV(ptr))
538feb02 395#endif
cea2e8a9 396
08e5223a 397#if !defined(PERL_CORE) && !defined(PERL_NOCOMPAT)
cea2e8a9
GS
398
399/* Compatibility for various misnamed functions. All functions
400 in the API that begin with "perl_" (not "Perl_") take an explicit
401 interpreter context pointer.
402 The following are not like that, but since they had a "perl_"
403 prefix in previous versions, we provide compatibility macros.
404 */
65cec589 405# define perl_atexit(a,b) call_atexit(a,b)
7b53c8ee
NC
406END
407
3a54c8e7
NC
408foreach (@$embed) {
409 my ($flags, $retval, $func, @args) = @$_;
410 next unless $func;
411 next unless $flags =~ /O/;
7b53c8ee
NC
412
413 my $alist = join ",", @az[0..$#args];
414 my $ret = "# define perl_$func($alist)";
415 my $t = (length $ret) >> 3;
416 $ret .= "\t" x ($t < 5 ? 5 - $t : 1);
3a54c8e7
NC
417 print $em "$ret$func($alist)\n";
418}
7b53c8ee 419
eacd26c2
NC
420my @nocontext;
421{
422 my (%has_va, %has_nocontext);
5ccbf88e 423 foreach (@$embed) {
eacd26c2
NC
424 next unless @$_ > 1;
425 ++$has_va{$_->[2]} if $_->[-1] =~ /\.\.\./;
426 ++$has_nocontext{$1} if $_->[2] =~ /(.*)_nocontext/;
427 }
428
429 @nocontext = sort grep {
430 $has_nocontext{$_}
431 && !/printf/ # Not clear to me why these are skipped but they are.
432 } keys %has_va;
433}
434
7b53c8ee 435print $em <<'END';
cea2e8a9
GS
436
437/* varargs functions can't be handled with CPP macros. :-(
438 This provides a set of compatibility functions that don't take
439 an extra argument but grab the context pointer using the macro
440 dTHX.
441 */
d51482e4 442#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_SHORT_NAMES)
125218eb
NC
443END
444
eacd26c2 445foreach (@nocontext) {
125218eb
NC
446 print $em hide($_, "Perl_${_}_nocontext", " ");
447}
448
449print $em <<'END';
cea2e8a9
GS
450#endif
451
452#endif /* !defined(PERL_CORE) && !defined(PERL_NOCOMPAT) */
453
454#if !defined(PERL_IMPLICIT_CONTEXT)
455/* undefined symbols, point them back at the usual ones */
125218eb
NC
456END
457
eacd26c2 458foreach (@nocontext) {
125218eb
NC
459 print $em hide("Perl_${_}_nocontext", "Perl_$_", " ");
460}
461
462print $em <<'END';
cea2e8a9 463#endif
d4cce5f1
NIS
464END
465
eeec122d 466read_only_bottom_close_and_rename($em) if ! $error_count;
d4cce5f1 467
5f8dc073 468$em = open_print_header('embedvar.h');
d4cce5f1 469
5f8dc073 470print $em <<'END';
d4cce5f1
NIS
471/* (Doing namespace management portably in C is really gross.) */
472
54aff467 473/*
3db8f154
MB
474 The following combinations of MULTIPLICITY and PERL_IMPLICIT_CONTEXT
475 are supported:
54aff467
GS
476 1) none
477 2) MULTIPLICITY # supported for compatibility
478 3) MULTIPLICITY && PERL_IMPLICIT_CONTEXT
54aff467
GS
479
480 All other combinations of these flags are errors.
481
3db8f154 482 only #3 is supported directly, while #2 is a special
54aff467
GS
483 case of #3 (supported by redefining vTHX appropriately).
484*/
cea2e8a9 485
54aff467 486#if defined(MULTIPLICITY)
3db8f154 487/* cases 2 and 3 above */
cea2e8a9 488
54aff467
GS
489# if defined(PERL_IMPLICIT_CONTEXT)
490# define vTHX aTHX
491# else
492# define vTHX PERL_GET_INTERP
493# endif
cea2e8a9 494
e50aee73
AD
495END
496
adf34b4b
NC
497my $sym;
498
499for $sym (@intrp) {
1a904fc8
FC
500 if ($sym eq 'sawampersand') {
501 print $em "#ifndef PL_sawampersand\n";
502 }
424a4936 503 print $em multon($sym,'I','vTHX->');
1a904fc8
FC
504 if ($sym eq 'sawampersand') {
505 print $em "#endif\n";
506 }
d4cce5f1
NIS
507}
508
424a4936 509print $em <<'END';
d4cce5f1 510
54aff467 511#endif /* MULTIPLICITY */
d4cce5f1 512
54aff467 513#if defined(PERL_GLOBAL_STRUCT)
22239a37
NIS
514
515END
516
adf34b4b 517for $sym (@globvar) {
0447859b 518 print $em "#ifdef OS2\n" if $sym eq 'sh_path';
483efd0a 519 print $em "#ifdef __VMS\n" if $sym eq 'perllib_sep';
424a4936
NC
520 print $em multon($sym, 'G','my_vars->');
521 print $em multon("G$sym",'', 'my_vars->');
0447859b 522 print $em "#endif\n" if $sym eq 'sh_path';
483efd0a 523 print $em "#endif\n" if $sym eq 'perllib_sep';
22239a37
NIS
524}
525
424a4936 526print $em <<'END';
22239a37 527
22239a37 528#endif /* PERL_GLOBAL_STRUCT */
84fee439
NIS
529END
530
eeec122d 531read_only_bottom_close_and_rename($em) if ! $error_count;
c6af7a1a 532
5f8dc073 533my $capih = open_print_header('perlapi.h');
51371543 534
5f8dc073 535print $capih <<'EOT';
51371543 536/* declare accessor functions for Perl variables */
6f4183fe
GS
537#ifndef __perlapi_h__
538#define __perlapi_h__
51371543 539
87b9e160 540#if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
c5be433b 541
51371543
GS
542START_EXTERN_C
543
544#undef PERLVAR
545#undef PERLVARA
546#undef PERLVARI
547#undef PERLVARIC
115ff745
NC
548#define PERLVAR(p,v,t) EXTERN_C t* Perl_##p##v##_ptr(pTHX);
549#define PERLVARA(p,v,n,t) typedef t PL_##v##_t[n]; \
550 EXTERN_C PL_##v##_t* Perl_##p##v##_ptr(pTHX);
551#define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
552#define PERLVARIC(p,v,t,i) PERLVAR(p,v, const t)
51371543 553
51371543
GS
554#include "perlvars.h"
555
556#undef PERLVAR
557#undef PERLVARA
558#undef PERLVARI
559#undef PERLVARIC
27da23d5 560
51371543
GS
561END_EXTERN_C
562
682fc664 563#if defined(PERL_CORE)
6f4183fe 564
87b9e160 565/* accessor functions for Perl "global" variables */
682fc664
GS
566
567/* these need to be mentioned here, or most linkers won't put them in
568 the perl executable */
569
570#ifndef PERL_NO_FORCE_LINK
571
572START_EXTERN_C
573
574#ifndef DOINIT
27da23d5 575EXTCONST void * const PL_force_link_funcs[];
682fc664 576#else
27da23d5 577EXTCONST void * const PL_force_link_funcs[] = {
682fc664
GS
578#undef PERLVAR
579#undef PERLVARA
580#undef PERLVARI
581#undef PERLVARIC
115ff745
NC
582#define PERLVAR(p,v,t) (void*)Perl_##p##v##_ptr,
583#define PERLVARA(p,v,n,t) PERLVAR(p,v,t)
584#define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
585#define PERLVARIC(p,v,t,i) PERLVAR(p,v,t)
682fc664 586
3c0f78ca
JH
587/* In Tru64 (__DEC && __osf__) the cc option -std1 causes that one
588 * cannot cast between void pointers and function pointers without
589 * info level warnings. The PL_force_link_funcs[] would cause a few
590 * hundred of those warnings. In code one can circumnavigate this by using
591 * unions that overlay the different pointers, but in declarations one
592 * cannot use this trick. Therefore we just disable the warning here
593 * for the duration of the PL_force_link_funcs[] declaration. */
594
595#if defined(__DECC) && defined(__osf__)
596#pragma message save
597#pragma message disable (nonstandcast)
598#endif
599
682fc664
GS
600#include "perlvars.h"
601
3c0f78ca
JH
602#if defined(__DECC) && defined(__osf__)
603#pragma message restore
604#endif
605
682fc664
GS
606#undef PERLVAR
607#undef PERLVARA
608#undef PERLVARI
609#undef PERLVARIC
610};
611#endif /* DOINIT */
612
acfe0abc 613END_EXTERN_C
682fc664
GS
614
615#endif /* PERL_NO_FORCE_LINK */
616
617#else /* !PERL_CORE */
51371543
GS
618
619EOT
620
adf34b4b 621foreach $sym (@globvar) {
5f9c6535
NC
622 print $capih
623 "#undef PL_$sym\n" . hide("PL_$sym", "(*Perl_G${sym}_ptr(NULL))");
6f4183fe
GS
624}
625
424a4936 626print $capih <<'EOT';
6f4183fe
GS
627
628#endif /* !PERL_CORE */
87b9e160 629#endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
6f4183fe
GS
630
631#endif /* __perlapi_h__ */
6f4183fe 632EOT
ce716c52 633
eeec122d 634read_only_bottom_close_and_rename($capih) if ! $error_count;
51371543 635
5f8dc073 636my $capi = open_print_header('perlapi.c', <<'EOQ');
56fd1190 637 *
892eaa71
NC
638 *
639 * Up to the threshold of the door there mounted a flight of twenty-seven
640 * broad stairs, hewn by some unknown art of the same black stone. This
641 * was the only entrance to the tower; ...
642 *
643 * [p.577 of _The Lord of the Rings_, III/x: "The Voice of Saruman"]
644 *
645 */
56fd1190 646EOQ
892eaa71 647
5f8dc073 648print $capi <<'EOT';
51371543
GS
649#include "EXTERN.h"
650#include "perl.h"
651#include "perlapi.h"
652
87b9e160 653#if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
51371543 654
87b9e160 655/* accessor functions for Perl "global" variables */
51371543
GS
656START_EXTERN_C
657
51371543 658#undef PERLVARI
115ff745 659#define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
c5be433b
GS
660
661#undef PERLVAR
662#undef PERLVARA
115ff745 663#define PERLVAR(p,v,t) t* Perl_##p##v##_ptr(pTHX) \
96a5add6 664 { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
115ff745 665#define PERLVARA(p,v,n,t) PL_##v##_t* Perl_##p##v##_ptr(pTHX) \
96a5add6 666 { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
34f7a5fe 667#undef PERLVARIC
115ff745
NC
668#define PERLVARIC(p,v,t,i) \
669 const t* Perl_##p##v##_ptr(pTHX) \
96a5add6 670 { PERL_UNUSED_CONTEXT; return (const t *)&(PL_##v); }
51371543
GS
671#include "perlvars.h"
672
673#undef PERLVAR
674#undef PERLVARA
675#undef PERLVARI
676#undef PERLVARIC
27da23d5 677
acfe0abc 678END_EXTERN_C
6f4183fe 679
87b9e160 680#endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
51371543
GS
681EOT
682
eeec122d
KW
683read_only_bottom_close_and_rename($capi) if ! $error_count;
684
685die "$error_count errors found" if $error_count;
acfe0abc 686
1b6737cc 687# ex: set ts=8 sts=4 sw=4 noet: