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 my $static_inline = 0;
106 if ($flags =~ /([si])/) {
108 if ($never_returns) {
109 $type = $1 eq 's' ? "PERL_STATIC_NO_RET" : "PERL_STATIC_INLINE_NO_RET";
112 $type = $1 eq 's' ? "STATIC" : "PERL_STATIC_INLINE";
114 $retval = "$type $retval";
115 die_at_end "Don't declare static function '$plain_func' pure" if $flags =~ /P/;
116 $static_inline = $type eq 'PERL_STATIC_INLINE';
119 if ($never_returns) {
120 $retval = "PERL_CALLCONV_NO_RET $retval";
123 $retval = "PERL_CALLCONV $retval";
126 $func = full_name($plain_func, $flags);
128 $ret .= "#ifndef NO_MATHOMS\n" if $binarycompat;
129 $ret .= "#ifndef PERL_NO_INLINE_FUNCTIONS\n" if $static_inline;
130 $ret .= "$retval\t$func(";
131 if ( $has_context ) {
132 $ret .= @args ? "pTHX_ " : "pTHX";
136 for my $arg ( @args ) {
138 if ( $arg =~ /\*/ && $arg !~ /\b(NN|NULLOK)\b/ ) {
139 warn "$func: $arg needs NN or NULLOK\n";
140 ++$unflagged_pointers;
142 my $nn = ( $arg =~ s/\s*\bNN\b\s+// );
143 push( @nonnull, $n ) if $nn;
145 my $nullok = ( $arg =~ s/\s*\bNULLOK\b\s+// ); # strip NULLOK with no effect
147 # Make sure each arg has at least a type and a var name.
148 # An arg of "int" is valid C, but want it to be "int foo".
150 $temp_arg =~ s/\*//g;
151 $temp_arg =~ s/\s*\bstruct\b\s*/ /g;
152 if ( ($temp_arg ne "...")
153 && ($temp_arg !~ /\w+\s+(\w+)(?:\[\d+\])?\s*$/) ) {
154 die_at_end "$func: $arg ($n) doesn't have a name\n";
156 if (defined $1 && $nn && !($commented_out && !$binarycompat)) {
157 push @names_of_nn, $1;
160 $ret .= join ", ", @args;
163 $ret .= "void" if !$has_context;
165 $ret .= " _pDEPTH" if $has_depth;
168 if ( $flags =~ /r/ ) {
169 push @attrs, "__attribute__noreturn__";
171 if ( $flags =~ /D/ ) {
172 push @attrs, "__attribute__deprecated__";
175 push @attrs, "__attribute__malloc__";
177 if ( !$can_ignore ) {
178 push @attrs, "__attribute__warn_unused_result__";
180 if ( $flags =~ /P/ ) {
181 push @attrs, "__attribute__pure__";
183 if( $flags =~ /f/ ) {
184 my $prefix = $has_context ? 'pTHX_' : '';
186 if ($args[-1] eq '...') {
187 $args = scalar @args;
189 $args = $prefix . $args;
192 # don't check args, and guess which arg is the pattern
193 # (one of 'fmt', 'pat', 'f'),
195 my @fmts = grep $args[$_] =~ /\b(f|pat|fmt)$/, 0..$#args;
197 die "embed.pl: '$plain_func': can't determine pattern arg\n";
201 my $macro = grep($_ == $pat, @nonnull)
202 ? '__attribute__format__'
203 : '__attribute__format__null_ok__';
204 if ($plain_func =~ /strftime/) {
205 push @attrs, sprintf "%s(__strftime__,%s1,0)", $macro, $prefix;
208 push @attrs, sprintf "%s(__printf__,%s%d,%s)", $macro,
209 $prefix, $pat, $args;
214 $ret .= join( "\n", map { "\t\t\t$_" } @attrs );
217 $ret = "/* $ret */" if $commented_out;
219 $ret .= "\n#define PERL_ARGS_ASSERT_\U$plain_func\E\t\\\n\t"
220 . join '; ', map "assert($_)", @names_of_nn;
222 $ret .= "\n#endif" if $static_inline;
223 $ret .= "\n#endif" if $binarycompat;
224 $ret .= @attrs ? "\n\n" : "\n";
231 # include "pp_proto.h"
236 read_only_bottom_close_and_rename($pr) if ! $error_count;
239 die_at_end "$unflagged_pointers pointer arguments to clean up\n" if $unflagged_pointers;
242 my ($file, $pre) = @_;
245 open(FILE, '<', $file)
246 or die "embed.pl: Can't open $file: $!\n";
248 s/[ \t]*#.*//; # Delete comments.
249 if (/PERLVARA?I?C?\($pre,\s*(\w+)/) {
250 die_at_end "duplicate symbol $1 while processing $file line $.\n"
255 return sort keys %seen;
258 my @intrp = readvars 'intrpvar.h','I';
259 my @globvar = readvars 'perlvars.h','G';
262 my ($from, $to, $indent) = @_;
263 $indent = '' unless defined $indent;
264 my $t = int(length("$indent$from") / 8);
265 "#${indent}define $from" . "\t" x ($t < 3 ? 3 - $t : 1) . "$to\n";
269 my ($sym,$pre,$ptr) = @_;
270 hide("PL_$sym", "($ptr$pre$sym)");
273 my $em = open_print_header('embed.h');
276 /* (Doing namespace management portably in C is really gross.) */
278 /* By defining PERL_NO_SHORT_NAMES (not done by default) the short forms
279 * (like warn instead of Perl_warn) for the API are not defined.
280 * Not defining the short forms is a good thing for cleaner embedding. */
282 #ifndef PERL_NO_SHORT_NAMES
284 /* Hide global symbols */
291 my ($guard, $funcs) = @_;
292 print $em "$guard\n" if $guard;
298 # Indent the conditionals if we are wrapped in an #if/#endif pair.
299 $cond =~ s/#(.*)/# $1/ if $guard;
304 my ($flags,$retval,$func,@args) = @$_;
305 unless ($flags =~ /[om]/) {
306 my $args = scalar @args;
308 my $full_name = full_name($func, $flags);
309 next if $full_name eq $func; # Don't output a no-op.
310 $ret = hide($func, $full_name);
312 elsif ($args and $args[$args-1] =~ /\.\.\./) {
314 # we're out of luck for varargs functions under CPP
315 # So we can only do these macros for no implicit context:
316 $ret = "#ifndef PERL_IMPLICIT_CONTEXT\n"
317 . hide($func, full_name($func, $flags)) . "#endif\n";
321 my $alist = join(",", @az[0..$args-1]);
322 $ret = "#define $func($alist)";
323 my $t = int(length($ret) / 8);
324 $ret .= "\t" x ($t < 4 ? 4 - $t : 1);
325 $ret .= full_name($func, $flags) . "(aTHX";
326 $ret .= "_ " if $alist;
332 die "Can't use W without other args (currently)";
337 $ret = "#ifndef NO_MATHOMS\n$ret#endif\n" if $flags =~ /b/;
341 # Prune empty #if/#endif pairs.
342 while ($lines =~ s/#\s*if[^\n]+\n#\s*endif\n//) {
344 # Merge adjacent blocks.
345 while ($lines =~ s/(#ifndef PERL_IMPLICIT_CONTEXT
348 #ifndef PERL_IMPLICIT_CONTEXT
353 print $em "#endif\n" if $guard;
357 embed_h('#if defined(PERL_CORE) || defined(PERL_EXT)', $ext);
358 embed_h('#ifdef PERL_CORE', $core);
362 #endif /* #ifndef PERL_NO_SHORT_NAMES */
364 /* Compatibility stubs. Compile extensions with -DPERL_NOCOMPAT to
368 #if !defined(PERL_CORE)
369 # define sv_setptrobj(rv,ptr,name) sv_setref_iv(rv,name,PTR2IV(ptr))
370 # define sv_setptrref(rv,ptr) sv_setref_iv(rv,NULL,PTR2IV(ptr))
373 #if !defined(PERL_CORE) && !defined(PERL_NOCOMPAT)
375 /* Compatibility for various misnamed functions. All functions
376 in the API that begin with "perl_" (not "Perl_") take an explicit
377 interpreter context pointer.
378 The following are not like that, but since they had a "perl_"
379 prefix in previous versions, we provide compatibility macros.
381 # define perl_atexit(a,b) call_atexit(a,b)
385 my ($flags, $retval, $func, @args) = @$_;
387 next unless $flags =~ /O/;
389 my $alist = join ",", @az[0..$#args];
390 my $ret = "# define perl_$func($alist)";
391 my $t = (length $ret) >> 3;
392 $ret .= "\t" x ($t < 5 ? 5 - $t : 1);
393 print $em "$ret$func($alist)\n";
398 my (%has_va, %has_nocontext);
401 ++$has_va{$_->[2]} if $_->[-1] =~ /\.\.\./;
402 ++$has_nocontext{$1} if $_->[2] =~ /(.*)_nocontext/;
405 @nocontext = sort grep {
407 && !/printf/ # Not clear to me why these are skipped but they are.
413 /* varargs functions can't be handled with CPP macros. :-(
414 This provides a set of compatibility functions that don't take
415 an extra argument but grab the context pointer using the macro
418 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_SHORT_NAMES)
421 foreach (@nocontext) {
422 print $em hide($_, "Perl_${_}_nocontext", " ");
428 #endif /* !defined(PERL_CORE) && !defined(PERL_NOCOMPAT) */
430 #if !defined(PERL_IMPLICIT_CONTEXT)
431 /* undefined symbols, point them back at the usual ones */
434 foreach (@nocontext) {
435 print $em hide("Perl_${_}_nocontext", "Perl_$_", " ");
442 read_only_bottom_close_and_rename($em) if ! $error_count;
444 $em = open_print_header('embedvar.h');
447 /* (Doing namespace management portably in C is really gross.) */
450 The following combinations of MULTIPLICITY and PERL_IMPLICIT_CONTEXT
453 2) MULTIPLICITY # supported for compatibility
454 3) MULTIPLICITY && PERL_IMPLICIT_CONTEXT
456 All other combinations of these flags are errors.
458 only #3 is supported directly, while #2 is a special
459 case of #3 (supported by redefining vTHX appropriately).
462 #if defined(MULTIPLICITY)
463 /* cases 2 and 3 above */
465 # if defined(PERL_IMPLICIT_CONTEXT)
468 # define vTHX PERL_GET_INTERP
476 if ($sym eq 'sawampersand') {
477 print $em "#ifndef PL_sawampersand\n";
479 print $em multon($sym,'I','vTHX->');
480 if ($sym eq 'sawampersand') {
481 print $em "#endif\n";
487 #endif /* MULTIPLICITY */
489 #if defined(PERL_GLOBAL_STRUCT)
493 for $sym (@globvar) {
494 print $em "#ifdef OS2\n" if $sym eq 'sh_path';
495 print $em "#ifdef __VMS\n" if $sym eq 'perllib_sep';
496 print $em multon($sym, 'G','my_vars->');
497 print $em multon("G$sym",'', 'my_vars->');
498 print $em "#endif\n" if $sym eq 'sh_path';
499 print $em "#endif\n" if $sym eq 'perllib_sep';
504 #endif /* PERL_GLOBAL_STRUCT */
507 read_only_bottom_close_and_rename($em) if ! $error_count;
509 my $capih = open_print_header('perlapi.h');
511 print $capih <<'EOT';
512 /* declare accessor functions for Perl variables */
513 #ifndef __perlapi_h__
514 #define __perlapi_h__
516 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
524 #define PERLVAR(p,v,t) EXTERN_C t* Perl_##p##v##_ptr(pTHX);
525 #define PERLVARA(p,v,n,t) typedef t PL_##v##_t[n]; \
526 EXTERN_C PL_##v##_t* Perl_##p##v##_ptr(pTHX);
527 #define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
528 #define PERLVARIC(p,v,t,i) PERLVAR(p,v, const t)
530 #include "perlvars.h"
539 #if defined(PERL_CORE)
541 /* accessor functions for Perl "global" variables */
543 /* these need to be mentioned here, or most linkers won't put them in
544 the perl executable */
546 #ifndef PERL_NO_FORCE_LINK
551 EXTCONST void * const PL_force_link_funcs[];
553 EXTCONST void * const PL_force_link_funcs[] = {
558 #define PERLVAR(p,v,t) (void*)Perl_##p##v##_ptr,
559 #define PERLVARA(p,v,n,t) PERLVAR(p,v,t)
560 #define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
561 #define PERLVARIC(p,v,t,i) PERLVAR(p,v,t)
563 /* In Tru64 (__DEC && __osf__) the cc option -std1 causes that one
564 * cannot cast between void pointers and function pointers without
565 * info level warnings. The PL_force_link_funcs[] would cause a few
566 * hundred of those warnings. In code one can circumnavigate this by using
567 * unions that overlay the different pointers, but in declarations one
568 * cannot use this trick. Therefore we just disable the warning here
569 * for the duration of the PL_force_link_funcs[] declaration. */
571 #if defined(__DECC) && defined(__osf__)
573 #pragma message disable (nonstandcast)
576 #include "perlvars.h"
578 #if defined(__DECC) && defined(__osf__)
579 #pragma message restore
591 #endif /* PERL_NO_FORCE_LINK */
593 #else /* !PERL_CORE */
597 foreach $sym (@globvar) {
599 "#undef PL_$sym\n" . hide("PL_$sym", "(*Perl_G${sym}_ptr(NULL))");
602 print $capih <<'EOT';
604 #endif /* !PERL_CORE */
605 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
607 #endif /* __perlapi_h__ */
610 read_only_bottom_close_and_rename($capih) if ! $error_count;
612 my $capi = open_print_header('perlapi.c', <<'EOQ');
615 * Up to the threshold of the door there mounted a flight of twenty-seven
616 * broad stairs, hewn by some unknown art of the same black stone. This
617 * was the only entrance to the tower; ...
619 * [p.577 of _The Lord of the Rings_, III/x: "The Voice of Saruman"]
629 #if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)
631 /* accessor functions for Perl "global" variables */
635 #define PERLVARI(p,v,t,i) PERLVAR(p,v,t)
639 #define PERLVAR(p,v,t) t* Perl_##p##v##_ptr(pTHX) \
640 { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
641 #define PERLVARA(p,v,n,t) PL_##v##_t* Perl_##p##v##_ptr(pTHX) \
642 { dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
644 #define PERLVARIC(p,v,t,i) \
645 const t* Perl_##p##v##_ptr(pTHX) \
646 { PERL_UNUSED_CONTEXT; return (const t *)&(PL_##v); }
647 #include "perlvars.h"
656 #endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
659 read_only_bottom_close_and_rename($capi) if ! $error_count;
661 die "$error_count errors found" if $error_count;
663 # ex: set ts=8 sts=4 sw=4 noet: