b53a69a15c4990867ee5ca1ff0742def7686f2f1
[perl.git] / regen / embed.pl
1 #!/usr/bin/perl -w
2
3 # Regenerate (overwriting only if changed):
4 #
5 #    embed.h
6 #    embedvar.h
7 #    global.sym
8 #    perlapi.c
9 #    perlapi.h
10 #    proto.h
11 #
12 # from information stored in
13 #
14 #    embed.fnc
15 #    intrpvar.h
16 #    perlvars.h
17 #    regen/opcodes
18 #
19 # Accepts the standard regen_lib -q and -v args.
20 #
21 # This script is normally invoked from regen.pl.
22
23 require 5.004;  # keep this compatible, an old perl is all we may have before
24                 # we build the new one
25
26 use strict;
27
28 BEGIN {
29     # Get function prototypes
30     require 'regen/regen_lib.pl';
31 }
32
33 my $SPLINT = 0; # Turn true for experimental splint support http://www.splint.org
34 my $unflagged_pointers;
35
36 #
37 # See database of global and static function prototypes in embed.fnc
38 # This is used to generate prototype headers under various configurations,
39 # export symbols lists for different platforms, and macros to provide an
40 # implicit interpreter context argument.
41 #
42
43 sub do_not_edit ($)
44 {
45     my $file = shift;
46
47     return read_only_top(lang => ($file =~ /\.[ch]$/ ? 'C' : 'Perl'),
48                          file => $file, style => '*', by => 'regen/embed.pl',
49                          from => ['data in embed.fnc', 'regen/embed.pl',
50                                   'regen/opcodes', 'intrpvar.h', 'perlvars.h'],
51                          final => "\nEdit those files and run 'make regen_headers' to effect changes.\n",
52                          copyright => [1993 .. 2009]);
53 } # do_not_edit
54
55 open IN, "embed.fnc" or die $!;
56
57 my @embed;
58 my (%has_va, %has_nocontext);
59
60 while (<IN>) {
61     chomp;
62     next if /^:/;
63     next if /^$/;
64     while (s|\\$||) {
65         $_ .= <IN>;
66         chomp;
67     }
68     s/\s+$//;
69     my @args;
70     if (/^\s*(#|$)/) {
71         @args = $_;
72     }
73     else {
74         @args = split /\s*\|\s*/, $_;
75         my $func = $args[2];
76         if ($func) {
77             ++$has_va{$func} if $args[-1] =~ /\.\.\./;
78             ++$has_nocontext{$1} if $func =~ /(.*)_nocontext/;
79         }
80     }
81     if (@args == 1 && $args[0] !~ /^#\s*(?:if|ifdef|ifndef|else|endif)/) {
82         die "Illegal line $. '$args[0]' in embed.fnc";
83     }
84     push @embed, \@args;
85 }
86
87 open IN, 'regen/opcodes' or die $!;
88 {
89     my %syms;
90
91     while (<IN>) {
92         chop;
93         next unless $_;
94         next if /^#/;
95         my (undef, undef, $check) = split /\t+/, $_;
96         ++$syms{$check};
97     }
98
99     foreach (keys %syms) {
100         # These are all indirectly referenced by globals.c.
101         push @embed, ['pR', 'OP *', $_, 'NN OP *o'];
102     }
103 }
104 close IN;
105
106 my (@core, @ext, @api);
107 {
108     # Cluster entries in embed.fnc that have the same #ifdef guards.
109     # Also, split out at the top level the three classes of functions.
110     my @state;
111     my %groups;
112     my $current;
113     foreach (@embed) {
114         if (@$_ > 1) {
115             push @$current, $_;
116             next;
117         }
118         $_->[0] =~ s/^#\s+/#/;
119         $_->[0] =~ /^\S*/;
120         $_->[0] =~ s/^#ifdef\s+(\S+)/#if defined($1)/;
121         $_->[0] =~ s/^#ifndef\s+(\S+)/#if !defined($1)/;
122         if ($_->[0] =~ /^#if\s*(.*)/) {
123             push @state, $1;
124         } elsif ($_->[0] =~ /^#else\s*$/) {
125             die "Unmatched #else in embed.fnc" unless @state;
126             $state[-1] = "!($state[-1])";
127         } elsif ($_->[0] =~ m!^#endif\s*(?:/\*.*\*/)?$!) {
128             die "Unmatched #endif in embed.fnc" unless @state;
129             pop @state;
130         } else {
131             die "Unhandled pre-processor directive '$_->[0]' in embed.fnc";
132         }
133         $current = \%groups;
134         # Nested #if blocks are effectively &&ed together
135         # For embed.fnc, ordering withing the && isn't relevant, so we can
136         # sort them to try to group more functions together.
137         my @sorted = sort @state;
138         while (my $directive = shift @sorted) {
139             $current->{$directive} ||= {};
140             $current = $current->{$directive};
141         }
142         $current->{''} ||= [];
143         $current = $current->{''};
144     }
145
146     sub add_level {
147         my ($level, $indent, $wanted) = @_;
148         my $funcs = $level->{''};
149         my @entries;
150         if ($funcs) {
151             if (!defined $wanted) {
152                 @entries = @$funcs;
153             } else {
154                 foreach (@$funcs) {
155                     if ($_->[0] =~ /A/) {
156                         push @entries, $_ if $wanted eq 'A';
157                     } elsif ($_->[0] =~ /E/) {
158                         push @entries, $_ if $wanted eq 'E';
159                     } else {
160                         push @entries, $_ if $wanted eq '';
161                     }
162                 }
163             }
164             @entries = sort {$a->[2] cmp $b->[2]} @entries;
165         }
166         foreach (sort grep {length $_} keys %$level) {
167             my @conditional = add_level($level->{$_}, $indent . '  ', $wanted);
168             push @entries,
169                 ["#${indent}if $_"], @conditional, ["#${indent}endif"]
170                     if @conditional;
171         }
172         return @entries;
173     }
174     @core = add_level(\%groups, '', '');
175     @ext = add_level(\%groups, '', 'E');
176     @api = add_level(\%groups, '', 'A');
177
178     @embed = add_level(\%groups, '');
179 }
180
181 # walk table providing an array of components in each line to
182 # subroutine, printing the result
183 sub walk_table (&@) {
184     my ($function, $filename, $trailer) = @_;
185     my $F;
186     if (ref $filename) {        # filehandle
187         $F = $filename;
188     }
189     else {
190         $F = safer_open("$filename-new", $filename);
191         print $F do_not_edit ($filename);
192     }
193     foreach (@embed) {
194         my @outs = &{$function}(@$_);
195         # $function->(@args) is not 5.003
196         print $F @outs;
197     }
198     print $F $trailer if $trailer;
199     unless (ref $filename) {
200         close_and_rename($F);
201     }
202 }
203
204 # generate proto.h
205 {
206     my $pr = safer_open('proto.h-new', 'proto.h');
207     print $pr do_not_edit ("proto.h"), "START_EXTERN_C\n";
208     my $ret;
209
210     foreach (@embed) {
211         if (@$_ == 1) {
212             print $pr "$_->[0]\n";
213             next;
214         }
215
216         my ($flags,$retval,$plain_func,@args) = @$_;
217         my @nonnull;
218         my $has_context = ( $flags !~ /n/ );
219         my $never_returns = ( $flags =~ /r/ );
220         my $commented_out = ( $flags =~ /m/ );
221         my $binarycompat = ( $flags =~ /b/ );
222         my $is_malloc = ( $flags =~ /a/ );
223         my $can_ignore = ( $flags !~ /R/ ) && !$is_malloc;
224         my @names_of_nn;
225         my $func;
226
227         my $splint_flags = "";
228         if ( $SPLINT && !$commented_out ) {
229             $splint_flags .= '/*@noreturn@*/ ' if $never_returns;
230             if ($can_ignore && ($retval ne 'void') && ($retval !~ /\*/)) {
231                 $retval .= " /*\@alt void\@*/";
232             }
233         }
234
235         if ($flags =~ /s/) {
236             $retval = "STATIC $splint_flags$retval";
237             $func = "S_$plain_func";
238         }
239         else {
240             $retval = "PERL_CALLCONV $splint_flags$retval";
241             if ($flags =~ /[bp]/) {
242                 $func = "Perl_$plain_func";
243             } else {
244                 $func = $plain_func;
245             }
246         }
247         $ret = "$retval\t$func(";
248         if ( $has_context ) {
249             $ret .= @args ? "pTHX_ " : "pTHX";
250         }
251         if (@args) {
252             my $n;
253             for my $arg ( @args ) {
254                 ++$n;
255                 if ( $arg =~ /\*/ && $arg !~ /\b(NN|NULLOK)\b/ ) {
256                     warn "$func: $arg needs NN or NULLOK\n";
257                     ++$unflagged_pointers;
258                 }
259                 my $nn = ( $arg =~ s/\s*\bNN\b\s+// );
260                 push( @nonnull, $n ) if $nn;
261
262                 my $nullok = ( $arg =~ s/\s*\bNULLOK\b\s+// ); # strip NULLOK with no effect
263
264                 # Make sure each arg has at least a type and a var name.
265                 # An arg of "int" is valid C, but want it to be "int foo".
266                 my $temp_arg = $arg;
267                 $temp_arg =~ s/\*//g;
268                 $temp_arg =~ s/\s*\bstruct\b\s*/ /g;
269                 if ( ($temp_arg ne "...")
270                      && ($temp_arg !~ /\w+\s+(\w+)(?:\[\d+\])?\s*$/) ) {
271                     warn "$func: $arg ($n) doesn't have a name\n";
272                 }
273                 if ( $SPLINT && $nullok && !$commented_out ) {
274                     $arg = '/*@null@*/ ' . $arg;
275                 }
276                 if (defined $1 && $nn && !($commented_out && !$binarycompat)) {
277                     push @names_of_nn, $1;
278                 }
279             }
280             $ret .= join ", ", @args;
281         }
282         else {
283             $ret .= "void" if !$has_context;
284         }
285         $ret .= ")";
286         my @attrs;
287         if ( $flags =~ /r/ ) {
288             push @attrs, "__attribute__noreturn__";
289         }
290         if ( $flags =~ /D/ ) {
291             push @attrs, "__attribute__deprecated__";
292         }
293         if ( $is_malloc ) {
294             push @attrs, "__attribute__malloc__";
295         }
296         if ( !$can_ignore ) {
297             push @attrs, "__attribute__warn_unused_result__";
298         }
299         if ( $flags =~ /P/ ) {
300             push @attrs, "__attribute__pure__";
301         }
302         if( $flags =~ /f/ ) {
303             my $prefix  = $has_context ? 'pTHX_' : '';
304             my $args    = scalar @args;
305             my $pat     = $args - 1;
306             my $macro   = @nonnull && $nonnull[-1] == $pat  
307                                 ? '__attribute__format__'
308                                 : '__attribute__format__null_ok__';
309             push @attrs, sprintf "%s(__printf__,%s%d,%s%d)", $macro,
310                                 $prefix, $pat, $prefix, $args;
311         }
312         if ( @nonnull ) {
313             my @pos = map { $has_context ? "pTHX_$_" : $_ } @nonnull;
314             push @attrs, map { sprintf( "__attribute__nonnull__(%s)", $_ ) } @pos;
315         }
316         if ( @attrs ) {
317             $ret .= "\n";
318             $ret .= join( "\n", map { "\t\t\t$_" } @attrs );
319         }
320         $ret .= ";";
321         $ret = "/* $ret */" if $commented_out;
322         if (@names_of_nn) {
323             $ret .= "\n#define PERL_ARGS_ASSERT_\U$plain_func\E\t\\\n\t"
324                 . join '; ', map "assert($_)", @names_of_nn;
325         }
326         $ret .= @attrs ? "\n\n" : "\n";
327
328         print $pr $ret;
329     }
330
331     print $pr <<'EOF';
332 #ifdef PERL_CORE
333 #  include "pp_proto.h"
334 #endif
335 END_EXTERN_C
336 /* ex: set ro: */
337 EOF
338
339     close_and_rename($pr);
340 }
341
342 # generates global.sym (API export list)
343 {
344   my %seen;
345   sub write_global_sym {
346       if (@_ > 1) {
347           my ($flags,$retval,$func,@args) = @_;
348           if ($flags =~ /[AX]/ && $flags !~ /[xm]/
349               || $flags =~ /b/) { # public API, so export
350               # If a function is defined twice, for example before and after
351               # an #else, only export its name once.
352               return '' if $seen{$func}++;
353               $func = "Perl_$func" if $flags =~ /[pbX]/;
354               return "$func\n";
355           }
356       }
357       return '';
358   }
359 }
360
361 warn "$unflagged_pointers pointer arguments to clean up\n" if $unflagged_pointers;
362 walk_table(\&write_global_sym, "global.sym", "# ex: set ro:\n");
363
364 sub readvars(\%$$@) {
365     my ($syms, $file,$pre,$keep_pre) = @_;
366     local (*FILE, $_);
367     open(FILE, "< $file")
368         or die "embed.pl: Can't open $file: $!\n";
369     while (<FILE>) {
370         s/[ \t]*#.*//;          # Delete comments.
371         if (/PERLVARA?I?S?C?\($pre(\w+)/) {
372             my $sym = $1;
373             $sym = $pre . $sym if $keep_pre;
374             warn "duplicate symbol $sym while processing $file line $.\n"
375                 if exists $$syms{$sym};
376             $$syms{$sym} = $pre || 1;
377         }
378     }
379     close(FILE);
380 }
381
382 my %intrp;
383 my %globvar;
384
385 readvars %intrp,  'intrpvar.h','I';
386 readvars %globvar, 'perlvars.h','G';
387
388 my $sym;
389
390 sub undefine ($) {
391     my ($sym) = @_;
392     "#undef  $sym\n";
393 }
394
395 sub hide {
396     my ($from, $to, $indent) = @_;
397     $indent = '' unless defined $indent;
398     my $t = int(length("$indent$from") / 8);
399     "#${indent}define $from" . "\t" x ($t < 3 ? 3 - $t : 1) . "$to\n";
400 }
401
402 sub bincompat_var ($$) {
403     my ($pfx, $sym) = @_;
404     my $arg = ($pfx eq 'G' ? 'NULL' : 'aTHX');
405     undefine("PL_$sym") . hide("PL_$sym", "(*Perl_${pfx}${sym}_ptr($arg))");
406 }
407
408 sub multon ($$$) {
409     my ($sym,$pre,$ptr) = @_;
410     hide("PL_$sym", "($ptr$pre$sym)");
411 }
412
413 sub multoff ($$) {
414     my ($sym,$pre) = @_;
415     return hide("PL_$pre$sym", "PL_$sym");
416 }
417
418 my $em = safer_open('embed.h-new', 'embed.h');
419
420 print $em do_not_edit ("embed.h"), <<'END';
421 /* (Doing namespace management portably in C is really gross.) */
422
423 /* By defining PERL_NO_SHORT_NAMES (not done by default) the short forms
424  * (like warn instead of Perl_warn) for the API are not defined.
425  * Not defining the short forms is a good thing for cleaner embedding. */
426
427 #ifndef PERL_NO_SHORT_NAMES
428
429 /* Hide global symbols */
430
431 END
432
433 my @az = ('a'..'z');
434
435 sub embed_h {
436     my ($guard, $funcs) = @_;
437     print $em "$guard\n" if $guard;
438
439     my $lines;
440     foreach (@$funcs) {
441         if (@$_ == 1) {
442             my $cond = $_->[0];
443             # Indent the conditionals if we are wrapped in an #if/#endif pair.
444             $cond =~ s/#(.*)/#  $1/ if $guard;
445             $lines .= "$cond\n";
446             next;
447         }
448         my $ret = "";
449         my ($flags,$retval,$func,@args) = @$_;
450         unless ($flags =~ /[om]/) {
451             my $args = scalar @args;
452             if ($flags =~ /n/) {
453                 if ($flags =~ /s/) {
454                     $ret = hide($func,"S_$func");
455                 }
456                 elsif ($flags =~ /p/) {
457                     $ret = hide($func,"Perl_$func");
458                 }
459             }
460             elsif ($args and $args[$args-1] =~ /\.\.\./) {
461                 if ($flags =~ /p/) {
462                     # we're out of luck for varargs functions under CPP
463                     # So we can only do these macros for no implicit context:
464                     $ret = "#ifndef PERL_IMPLICIT_CONTEXT\n"
465                         . hide($func,"Perl_$func") . "#endif\n";
466                 }
467             }
468             else {
469                 my $alist = join(",", @az[0..$args-1]);
470                 $ret = "#define $func($alist)";
471                 my $t = int(length($ret) / 8);
472                 $ret .=  "\t" x ($t < 4 ? 4 - $t : 1);
473                 if ($flags =~ /s/) {
474                     $ret .= "S_$func(aTHX";
475                 }
476                 elsif ($flags =~ /p/) {
477                     $ret .= "Perl_$func(aTHX";
478                 }
479                 $ret .= "_ " if $alist;
480                 $ret .= $alist . ")\n";
481             }
482         }
483         $lines .= $ret;
484     }
485     # Prune empty #if/#endif pairs.
486     while ($lines =~ s/#\s*if[^\n]+\n#\s*endif\n//) {
487     }
488     # Merge adjacent blocks.
489     while ($lines =~ s/(#ifndef PERL_IMPLICIT_CONTEXT
490 [^\n]+
491 )#endif
492 #ifndef PERL_IMPLICIT_CONTEXT
493 /$1/) {
494     }
495
496     print $em $lines;
497     print $em "#endif\n" if $guard;
498 }
499
500 embed_h('', \@api);
501 embed_h('#if defined(PERL_CORE) || defined(PERL_EXT)', \@ext);
502 embed_h('#ifdef PERL_CORE', \@core);
503
504 print $em <<'END';
505
506 #endif  /* #ifndef PERL_NO_SHORT_NAMES */
507
508 /* Compatibility stubs.  Compile extensions with -DPERL_NOCOMPAT to
509    disable them.
510  */
511
512 #if !defined(PERL_CORE)
513 #  define sv_setptrobj(rv,ptr,name)     sv_setref_iv(rv,name,PTR2IV(ptr))
514 #  define sv_setptrref(rv,ptr)          sv_setref_iv(rv,NULL,PTR2IV(ptr))
515 #endif
516
517 #if !defined(PERL_CORE) && !defined(PERL_NOCOMPAT)
518
519 /* Compatibility for various misnamed functions.  All functions
520    in the API that begin with "perl_" (not "Perl_") take an explicit
521    interpreter context pointer.
522    The following are not like that, but since they had a "perl_"
523    prefix in previous versions, we provide compatibility macros.
524  */
525 #  define perl_atexit(a,b)              call_atexit(a,b)
526 END
527
528 walk_table {
529     my ($flags,$retval,$func,@args) = @_;
530     return unless $func;
531     return unless $flags =~ /O/;
532
533     my $alist = join ",", @az[0..$#args];
534     my $ret = "#  define perl_$func($alist)";
535     my $t = (length $ret) >> 3;
536     $ret .=  "\t" x ($t < 5 ? 5 - $t : 1);
537     "$ret$func($alist)\n";
538 } $em;
539
540 print $em <<'END';
541
542 /* varargs functions can't be handled with CPP macros. :-(
543    This provides a set of compatibility functions that don't take
544    an extra argument but grab the context pointer using the macro
545    dTHX.
546  */
547 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_SHORT_NAMES)
548 END
549
550 foreach (sort keys %has_va) {
551     next unless $has_nocontext{$_};
552     next if /printf/; # Not clear to me why these are skipped but they are.
553     print $em hide($_, "Perl_${_}_nocontext", "  ");
554 }
555
556 print $em <<'END';
557 #endif
558
559 #endif /* !defined(PERL_CORE) && !defined(PERL_NOCOMPAT) */
560
561 #if !defined(PERL_IMPLICIT_CONTEXT)
562 /* undefined symbols, point them back at the usual ones */
563 END
564
565 foreach (sort keys %has_va) {
566     next unless $has_nocontext{$_};
567     next if /printf/; # Not clear to me why these are skipped but they are.
568     print $em hide("Perl_${_}_nocontext", "Perl_$_", "  ");
569 }
570
571 print $em <<'END';
572 #endif
573
574 /* ex: set ro: */
575 END
576
577 close_and_rename($em);
578
579 $em = safer_open('embedvar.h-new', 'embedvar.h');
580
581 print $em do_not_edit ("embedvar.h"), <<'END';
582 /* (Doing namespace management portably in C is really gross.) */
583
584 /*
585    The following combinations of MULTIPLICITY and PERL_IMPLICIT_CONTEXT
586    are supported:
587      1) none
588      2) MULTIPLICITY    # supported for compatibility
589      3) MULTIPLICITY && PERL_IMPLICIT_CONTEXT
590
591    All other combinations of these flags are errors.
592
593    only #3 is supported directly, while #2 is a special
594    case of #3 (supported by redefining vTHX appropriately).
595 */
596
597 #if defined(MULTIPLICITY)
598 /* cases 2 and 3 above */
599
600 #  if defined(PERL_IMPLICIT_CONTEXT)
601 #    define vTHX        aTHX
602 #  else
603 #    define vTHX        PERL_GET_INTERP
604 #  endif
605
606 END
607
608 for $sym (sort keys %intrp) {
609     print $em multon($sym,'I','vTHX->');
610 }
611
612 print $em <<'END';
613
614 #else   /* !MULTIPLICITY */
615
616 /* case 1 above */
617
618 END
619
620 for $sym (sort keys %intrp) {
621     print $em multoff($sym,'I');
622 }
623
624 print $em <<'END';
625
626 END
627
628 print $em <<'END';
629
630 #endif  /* MULTIPLICITY */
631
632 #if defined(PERL_GLOBAL_STRUCT)
633
634 END
635
636 for $sym (sort keys %globvar) {
637     print $em multon($sym,   'G','my_vars->');
638     print $em multon("G$sym",'', 'my_vars->');
639 }
640
641 print $em <<'END';
642
643 #else /* !PERL_GLOBAL_STRUCT */
644
645 END
646
647 for $sym (sort keys %globvar) {
648     print $em multoff($sym,'G');
649 }
650
651 print $em <<'END';
652
653 #endif /* PERL_GLOBAL_STRUCT */
654
655 /* ex: set ro: */
656 END
657
658 close_and_rename($em);
659
660 my $capi = safer_open('perlapi.c-new', 'perlapi.c');
661 my $capih = safer_open('perlapi.h-new', 'perlapi.h');
662
663 print $capih do_not_edit ("perlapi.h"), <<'EOT';
664 /* declare accessor functions for Perl variables */
665 #ifndef __perlapi_h__
666 #define __perlapi_h__
667
668 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
669
670 START_EXTERN_C
671
672 #undef PERLVAR
673 #undef PERLVARA
674 #undef PERLVARI
675 #undef PERLVARIC
676 #undef PERLVARISC
677 #define PERLVAR(v,t)    EXTERN_C t* Perl_##v##_ptr(pTHX);
678 #define PERLVARA(v,n,t) typedef t PL_##v##_t[n];                        \
679                         EXTERN_C PL_##v##_t* Perl_##v##_ptr(pTHX);
680 #define PERLVARI(v,t,i) PERLVAR(v,t)
681 #define PERLVARIC(v,t,i) PERLVAR(v, const t)
682 #define PERLVARISC(v,i) typedef const char PL_##v##_t[sizeof(i)];       \
683                         EXTERN_C PL_##v##_t* Perl_##v##_ptr(pTHX);
684
685 #include "perlvars.h"
686
687 #undef PERLVAR
688 #undef PERLVARA
689 #undef PERLVARI
690 #undef PERLVARIC
691 #undef PERLVARISC
692
693 END_EXTERN_C
694
695 #if defined(PERL_CORE)
696
697 /* accessor functions for Perl "global" variables */
698
699 /* these need to be mentioned here, or most linkers won't put them in
700    the perl executable */
701
702 #ifndef PERL_NO_FORCE_LINK
703
704 START_EXTERN_C
705
706 #ifndef DOINIT
707 EXTCONST void * const PL_force_link_funcs[];
708 #else
709 EXTCONST void * const PL_force_link_funcs[] = {
710 #undef PERLVAR
711 #undef PERLVARA
712 #undef PERLVARI
713 #undef PERLVARIC
714 #define PERLVAR(v,t)    (void*)Perl_##v##_ptr,
715 #define PERLVARA(v,n,t) PERLVAR(v,t)
716 #define PERLVARI(v,t,i) PERLVAR(v,t)
717 #define PERLVARIC(v,t,i) PERLVAR(v,t)
718 #define PERLVARISC(v,i) PERLVAR(v,char)
719
720 /* In Tru64 (__DEC && __osf__) the cc option -std1 causes that one
721  * cannot cast between void pointers and function pointers without
722  * info level warnings.  The PL_force_link_funcs[] would cause a few
723  * hundred of those warnings.  In code one can circumnavigate this by using
724  * unions that overlay the different pointers, but in declarations one
725  * cannot use this trick.  Therefore we just disable the warning here
726  * for the duration of the PL_force_link_funcs[] declaration. */
727
728 #if defined(__DECC) && defined(__osf__)
729 #pragma message save
730 #pragma message disable (nonstandcast)
731 #endif
732
733 #include "perlvars.h"
734
735 #if defined(__DECC) && defined(__osf__)
736 #pragma message restore
737 #endif
738
739 #undef PERLVAR
740 #undef PERLVARA
741 #undef PERLVARI
742 #undef PERLVARIC
743 #undef PERLVARISC
744 };
745 #endif  /* DOINIT */
746
747 END_EXTERN_C
748
749 #endif  /* PERL_NO_FORCE_LINK */
750
751 #else   /* !PERL_CORE */
752
753 EOT
754
755 foreach $sym (sort keys %globvar) {
756     print $capih bincompat_var('G',$sym);
757 }
758
759 print $capih <<'EOT';
760
761 #endif /* !PERL_CORE */
762 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
763
764 #endif /* __perlapi_h__ */
765
766 /* ex: set ro: */
767 EOT
768 close_and_rename($capih);
769
770 my $warning = do_not_edit ("perlapi.c");
771 $warning =~ s! \*/\n! *
772  *
773  * Up to the threshold of the door there mounted a flight of twenty-seven
774  * broad stairs, hewn by some unknown art of the same black stone.  This
775  * was the only entrance to the tower; ...
776  *
777  *     [p.577 of _The Lord of the Rings_, III/x: "The Voice of Saruman"]
778  *
779  */
780 !;
781
782 print $capi $warning, <<'EOT';
783 #include "EXTERN.h"
784 #include "perl.h"
785 #include "perlapi.h"
786
787 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
788
789 /* accessor functions for Perl "global" variables */
790 START_EXTERN_C
791
792 #undef PERLVARI
793 #define PERLVARI(v,t,i) PERLVAR(v,t)
794
795 #undef PERLVAR
796 #undef PERLVARA
797 #define PERLVAR(v,t)    t* Perl_##v##_ptr(pTHX)                         \
798                         { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
799 #define PERLVARA(v,n,t) PL_##v##_t* Perl_##v##_ptr(pTHX)                \
800                         { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
801 #undef PERLVARIC
802 #undef PERLVARISC
803 #define PERLVARIC(v,t,i)        \
804                         const t* Perl_##v##_ptr(pTHX)           \
805                         { PERL_UNUSED_CONTEXT; return (const t *)&(PL_##v); }
806 #define PERLVARISC(v,i) PL_##v##_t* Perl_##v##_ptr(pTHX)        \
807                         { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
808 #include "perlvars.h"
809
810 #undef PERLVAR
811 #undef PERLVARA
812 #undef PERLVARI
813 #undef PERLVARIC
814 #undef PERLVARISC
815
816 END_EXTERN_C
817
818 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
819
820 /* ex: set ro: */
821 EOT
822
823 close_and_rename($capi);
824
825 # ex: set ts=8 sts=4 sw=4 noet: