3 # Regenerate (overwriting only if changed):
11 # from information stored in
18 # Accepts the standard regen_lib -q and -v args.
20 # This script is normally invoked from regen.pl.
22 require 5.004; # keep this compatible, an old perl is all we may have before
23 # we build the new one
28 # Get function prototypes
29 require './regen/regen_lib.pl';
30 require './regen/embed_lib.pl';
33 my $unflagged_pointers;
36 # See database of global and static function prototypes in embed.fnc
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.
43 sub die_at_end ($) { # Keeps going for now, but makes sure the regen doesn't
49 sub full_name ($$) { # Returns the function name with potentially the
50 # prefixes 'S_' or 'Perl_'
51 my ($func, $flags) = @_;
53 return "Perl_$func" if $flags =~ /p/;
54 return "S_$func" if $flags =~ /[si]/;
58 sub open_print_header {
59 my ($file, $quote) = @_;
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 });
69 my ($embed, $core, $ext, $api) = setup_embed();
73 my $pr = open_print_header("proto.h");
74 print $pr "START_EXTERN_C\n";
79 print $pr "$_->[0]\n";
83 my ($flags,$retval,$plain_func,@args) = @$_;
84 if ($flags =~ / ( [^AabDdEfiMmnOoPpRrsUWXx] ) /x) {
85 die_at_end "flag $1 is not legal (for function $plain_func)";
88 my $has_depth = ( $flags =~ /W/ );
89 my $has_context = ( $flags !~ /n/ );
90 my $never_returns = ( $flags =~ /r/ );
91 my $binarycompat = ( $flags =~ /b/ );
92 my $commented_out = ( ! $binarycompat && $flags =~ /m/ );
93 my $is_malloc = ( $flags =~ /a/ );
94 my $can_ignore = ( $flags !~ /R/ ) && ( $flags !~ /P/ ) && !$is_malloc;
98 if (! $can_ignore && $retval eq 'void') {
99 warn "It is nonsensical to require the return value of a void function ($plain_func) to be checked";
102 die_at_end "$plain_func: s flag is mutually exclusive from the i and p plags"
103 if $flags =~ /s/ && $flags =~ /[ip]/;
105 if ($flags =~ /([si])/) {
107 if ($never_returns) {
108 $type = $1 eq 's' ? "PERL_STATIC_NO_RET" : "PERL_STATIC_INLINE_NO_RET";
111 $type = $1 eq 's' ? "STATIC" : "PERL_STATIC_INLINE";
113 $retval = "$type $retval";
114 die_at_end "Don't declare static function '$plain_func' pure" if $flags =~ /P/;
117 if ($never_returns) {
118 $retval = "PERL_CALLCONV_NO_RET $retval";
121 $retval = "PERL_CALLCONV $retval";
124 $func = full_name($plain_func, $flags);
126 $ret .= "#ifndef NO_MATHOMS\n" if $binarycompat;
127 $ret .= "$retval\t$func(";
128 if ( $has_context ) {
129 $ret .= @args ? "pTHX_ " : "pTHX";
133 for my $arg ( @args ) {
135 if ( $arg =~ /\*/ && $arg !~ /\b(NN|NULLOK)\b/ ) {
136 warn "$func: $arg needs NN or NULLOK\n";
137 ++$unflagged_pointers;
139 my $nn = ( $arg =~ s/\s*\bNN\b\s+// );
140 push( @nonnull, $n ) if $nn;
142 my $nullok = ( $arg =~ s/\s*\bNULLOK\b\s+// ); # strip NULLOK with no effect
144 # Make sure each arg has at least a type and a var name.
145 # An arg of "int" is valid C, but want it to be "int foo".
147 $temp_arg =~ s/\*//g;
148 $temp_arg =~ s/\s*\bstruct\b\s*/ /g;
149 if ( ($temp_arg ne "...")
150 && ($temp_arg !~ /\w+\s+(\w+)(?:\[\d+\])?\s*$/) ) {
151 die_at_end "$func: $arg ($n) doesn't have a name\n";
153 if (defined $1 && $nn && !($commented_out && !$binarycompat)) {
154 push @names_of_nn, $1;
157 $ret .= join ", ", @args;
160 $ret .= "void" if !$has_context;
162 $ret .= " _pDEPTH" if $has_depth;
165 if ( $flags =~ /r/ ) {
166 push @attrs, "__attribute__noreturn__";
168 if ( $flags =~ /D/ ) {
169 push @attrs, "__attribute__deprecated__";
172 push @attrs, "__attribute__malloc__";
174 if ( !$can_ignore ) {
175 push @attrs, "__attribute__warn_unused_result__";
177 if ( $flags =~ /P/ ) {
178 push @attrs, "__attribute__pure__";
180 if( $flags =~ /f/ ) {
181 my $prefix = $has_context ? 'pTHX_' : '';
183 if ($args[-1] eq '...') {
184 $args = scalar @args;
186 $args = $prefix . $args;
189 # don't check args, and guess which arg is the pattern
190 # (one of 'fmt', 'pat', 'f'),
192 my @fmts = grep $args[$_] =~ /\b(f|pat|fmt)$/, 0..$#args;
194 die "embed.pl: '$plain_func': can't determine pattern arg\n";
198 my $macro = grep($_ == $pat, @nonnull)
199 ? '__attribute__format__'
200 : '__attribute__format__null_ok__';
201 if ($plain_func =~ /strftime/) {
202 push @attrs, sprintf "%s(__strftime__,%s1,0)", $macro, $prefix;
205 push @attrs, sprintf "%s(__printf__,%s%d,%s)", $macro,
206 $prefix, $pat, $args;
211 $ret .= join( "\n", map { "\t\t\t$_" } @attrs );
214 $ret = "/* $ret */" if $commented_out;
216 $ret .= "\n#define PERL_ARGS_ASSERT_\U$plain_func\E\t\\\n\t"
217 . join '; ', map "assert($_)", @names_of_nn;
219 $ret .= "\n#endif" if $binarycompat;
220 $ret .= @attrs ? "\n\n" : "\n";
227 # include "pp_proto.h"
232 read_only_bottom_close_and_rename($pr) if ! $error_count;
235 die_at_end "$unflagged_pointers pointer arguments to clean up\n" if $unflagged_pointers;
238 my ($file, $pre) = @_;
241 open(FILE, '<', $file)
242 or die "embed.pl: Can't open $file: $!\n";
244 s/[ \t]*#.*//; # Delete comments.
245 if (/PERLVARA?I?C?\($pre,\s*(\w+)/) {
246 die_at_end "duplicate symbol $1 while processing $file line $.\n"
251 return sort keys %seen;
254 my @intrp = readvars 'intrpvar.h','I';
255 my @globvar = readvars 'perlvars.h','G';
258 my ($from, $to, $indent) = @_;
259 $indent = '' unless defined $indent;
260 my $t = int(length("$indent$from") / 8);
261 "#${indent}define $from" . "\t" x ($t < 3 ? 3 - $t : 1) . "$to\n";
265 my ($sym,$pre,$ptr) = @_;
266 hide("PL_$sym", "($ptr$pre$sym)");
269 my $em = open_print_header('embed.h');
272 /* (Doing namespace management portably in C is really gross.) */
274 /* By defining PERL_NO_SHORT_NAMES (not done by default) the short forms
275 * (like warn instead of Perl_warn) for the API are not defined.
276 * Not defining the short forms is a good thing for cleaner embedding. */
278 #ifndef PERL_NO_SHORT_NAMES
280 /* Hide global symbols */
287 my ($guard, $funcs) = @_;
288 print $em "$guard\n" if $guard;
294 # Indent the conditionals if we are wrapped in an #if/#endif pair.
295 $cond =~ s/#(.*)/# $1/ if $guard;
300 my ($flags,$retval,$func,@args) = @$_;
301 unless ($flags =~ /[om]/) {
302 my $args = scalar @args;
304 my $full_name = full_name($func, $flags);
305 next if $full_name eq $func; # Don't output a no-op.
306 $ret = hide($func, $full_name);
308 elsif ($args and $args[$args-1] =~ /\.\.\./) {
310 # we're out of luck for varargs functions under CPP
311 # So we can only do these macros for no implicit context:
312 $ret = "#ifndef PERL_IMPLICIT_CONTEXT\n"
313 . hide($func, full_name($func, $flags)) . "#endif\n";
317 my $alist = join(",", @az[0..$args-1]);
318 $ret = "#define $func($alist)";
319 my $t = int(length($ret) / 8);
320 $ret .= "\t" x ($t < 4 ? 4 - $t : 1);
321 $ret .= full_name($func, $flags) . "(aTHX";
322 $ret .= "_ " if $alist;
328 die "Can't use W without other args (currently)";
333 $ret = "#ifndef NO_MATHOMS\n$ret#endif\n" if $flags =~ /b/;
337 # Prune empty #if/#endif pairs.
338 while ($lines =~ s/#\s*if[^\n]+\n#\s*endif\n//) {
340 # Merge adjacent blocks.
341 while ($lines =~ s/(#ifndef PERL_IMPLICIT_CONTEXT
344 #ifndef PERL_IMPLICIT_CONTEXT
349 print $em "#endif\n" if $guard;
353 embed_h('#if defined(PERL_CORE) || defined(PERL_EXT)', $ext);
354 embed_h('#ifdef PERL_CORE', $core);
358 #endif /* #ifndef PERL_NO_SHORT_NAMES */
360 /* Compatibility stubs. Compile extensions with -DPERL_NOCOMPAT to
364 #if !defined(PERL_CORE)
365 # define sv_setptrobj(rv,ptr,name) sv_setref_iv(rv,name,PTR2IV(ptr))
366 # define sv_setptrref(rv,ptr) sv_setref_iv(rv,NULL,PTR2IV(ptr))
369 #if !defined(PERL_CORE) && !defined(PERL_NOCOMPAT)
371 /* Compatibility for various misnamed functions. All functions
372 in the API that begin with "perl_" (not "Perl_") take an explicit
373 interpreter context pointer.
374 The following are not like that, but since they had a "perl_"
375 prefix in previous versions, we provide compatibility macros.
377 # define perl_atexit(a,b) call_atexit(a,b)
381 my ($flags, $retval, $func, @args) = @$_;
383 next unless $flags =~ /O/;
385 my $alist = join ",", @az[0..$#args];
386 my $ret = "# define perl_$func($alist)";
387 my $t = (length $ret) >> 3;
388 $ret .= "\t" x ($t < 5 ? 5 - $t : 1);
389 print $em "$ret$func($alist)\n";
394 my (%has_va, %has_nocontext);
397 ++$has_va{$_->[2]} if $_->[-1] =~ /\.\.\./;
398 ++$has_nocontext{$1} if $_->[2] =~ /(.*)_nocontext/;
401 @nocontext = sort grep {
403 && !/printf/ # Not clear to me why these are skipped but they are.
409 /* varargs functions can't be handled with CPP macros. :-(
410 This provides a set of compatibility functions that don't take
411 an extra argument but grab the context pointer using the macro
414 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_SHORT_NAMES)
417 foreach (@nocontext) {
418 print $em hide($_, "Perl_${_}_nocontext", " ");
424 #endif /* !defined(PERL_CORE) && !defined(PERL_NOCOMPAT) */
426 #if !defined(PERL_IMPLICIT_CONTEXT)
427 /* undefined symbols, point them back at the usual ones */
430 foreach (@nocontext) {
431 print $em hide("Perl_${_}_nocontext", "Perl_$_", " ");
438 read_only_bottom_close_and_rename($em) if ! $error_count;
440 $em = open_print_header('embedvar.h');
443 /* (Doing namespace management portably in C is really gross.) */
446 The following combinations of MULTIPLICITY and PERL_IMPLICIT_CONTEXT
449 2) MULTIPLICITY # supported for compatibility
450 3) MULTIPLICITY && PERL_IMPLICIT_CONTEXT
452 All other combinations of these flags are errors.
454 only #3 is supported directly, while #2 is a special
455 case of #3 (supported by redefining vTHX appropriately).
458 #if defined(MULTIPLICITY)
459 /* cases 2 and 3 above */
461 # if defined(PERL_IMPLICIT_CONTEXT)
464 # define vTHX PERL_GET_INTERP
472 if ($sym eq 'sawampersand') {
473 print $em "#ifndef PL_sawampersand\n";
475 print $em multon($sym,'I','vTHX->');
476 if ($sym eq 'sawampersand') {
477 print $em "#endif\n";
483 #endif /* MULTIPLICITY */
485 #if defined(PERL_GLOBAL_STRUCT)
489 for $sym (@globvar) {
490 print $em "#ifdef OS2\n" if $sym eq 'sh_path';
491 print $em "#ifdef __VMS\n" if $sym eq 'perllib_sep';
492 print $em multon($sym, 'G','my_vars->');
493 print $em multon("G$sym",'', 'my_vars->');
494 print $em "#endif\n" if $sym eq 'sh_path';
495 print $em "#endif\n" if $sym eq 'perllib_sep';
500 #endif /* PERL_GLOBAL_STRUCT */
503 read_only_bottom_close_and_rename($em) if ! $error_count;
505 my $capih = open_print_header('perlapi.h');
507 print $capih <<'EOT';
508 /* declare accessor functions for Perl variables */
509 #ifndef __perlapi_h__
510 #define __perlapi_h__
512 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
520 #define PERLVAR(p,v,t) EXTERN_C t* Perl_##p##v##_ptr(pTHX);
521 #define PERLVARA(p,v,n,t) typedef t PL_##v##_t[n]; \
522 EXTERN_C PL_##v##_t* Perl_##p##v##_ptr(pTHX);
523 #define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
524 #define PERLVARIC(p,v,t,i) PERLVAR(p,v, const t)
526 #include "perlvars.h"
535 #if defined(PERL_CORE)
537 /* accessor functions for Perl "global" variables */
539 /* these need to be mentioned here, or most linkers won't put them in
540 the perl executable */
542 #ifndef PERL_NO_FORCE_LINK
547 EXTCONST void * const PL_force_link_funcs[];
549 EXTCONST void * const PL_force_link_funcs[] = {
554 #define PERLVAR(p,v,t) (void*)Perl_##p##v##_ptr,
555 #define PERLVARA(p,v,n,t) PERLVAR(p,v,t)
556 #define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
557 #define PERLVARIC(p,v,t,i) PERLVAR(p,v,t)
559 /* In Tru64 (__DEC && __osf__) the cc option -std1 causes that one
560 * cannot cast between void pointers and function pointers without
561 * info level warnings. The PL_force_link_funcs[] would cause a few
562 * hundred of those warnings. In code one can circumnavigate this by using
563 * unions that overlay the different pointers, but in declarations one
564 * cannot use this trick. Therefore we just disable the warning here
565 * for the duration of the PL_force_link_funcs[] declaration. */
567 #if defined(__DECC) && defined(__osf__)
569 #pragma message disable (nonstandcast)
572 #include "perlvars.h"
574 #if defined(__DECC) && defined(__osf__)
575 #pragma message restore
587 #endif /* PERL_NO_FORCE_LINK */
589 #else /* !PERL_CORE */
593 foreach $sym (@globvar) {
595 "#undef PL_$sym\n" . hide("PL_$sym", "(*Perl_G${sym}_ptr(NULL))");
598 print $capih <<'EOT';
600 #endif /* !PERL_CORE */
601 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
603 #endif /* __perlapi_h__ */
606 read_only_bottom_close_and_rename($capih) if ! $error_count;
608 my $capi = open_print_header('perlapi.c', <<'EOQ');
611 * Up to the threshold of the door there mounted a flight of twenty-seven
612 * broad stairs, hewn by some unknown art of the same black stone. This
613 * was the only entrance to the tower; ...
615 * [p.577 of _The Lord of the Rings_, III/x: "The Voice of Saruman"]
625 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
627 /* accessor functions for Perl "global" variables */
631 #define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
635 #define PERLVAR(p,v,t) t* Perl_##p##v##_ptr(pTHX) \
636 { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
637 #define PERLVARA(p,v,n,t) PL_##v##_t* Perl_##p##v##_ptr(pTHX) \
638 { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
640 #define PERLVARIC(p,v,t,i) \
641 const t* Perl_##p##v##_ptr(pTHX) \
642 { PERL_UNUSED_CONTEXT; return (const t *)&(PL_##v); }
643 #include "perlvars.h"
652 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
655 read_only_bottom_close_and_rename($capi) if ! $error_count;
657 die "$error_count errors found" if $error_count;
659 # ex: set ts=8 sts=4 sw=4 noet: