[perl5.git] / regen / embed.pl

#!/usr/bin/perl -w
# 
# Regenerate (overwriting only if changed):
#
#    embed.h
#    embedvar.h
#    perlapi.c
#    perlapi.h
#    proto.h
#
# from information stored in
#
#    embed.fnc
#    intrpvar.h
#    perlvars.h
#    regen/opcodes
#
# Accepts the standard regen_lib -q and -v args.
#
# This script is normally invoked from regen.pl.

require 5.004;	# keep this compatible, an old perl is all we may have before
                # we build the new one

use strict;

BEGIN {
    # Get function prototypes
    require 'regen/regen_lib.pl';
    require 'regen/embed_lib.pl';
}

my $SPLINT = 0; # Turn true for experimental splint support http://www.splint.org
my $unflagged_pointers;

#
# See database of global and static function prototypes in embed.fnc
# This is used to generate prototype headers under various configurations,
# export symbols lists for different platforms, and macros to provide an
# implicit interpreter context argument.
#

sub open_print_header {
    my ($file, $quote) = @_;

    return open_new($file, '>',
		    { file => $file, style => '*', by => 'regen/embed.pl',
		      from => ['data in embed.fnc', 'regen/embed.pl',
			       'regen/opcodes', 'intrpvar.h', 'perlvars.h'],
		      final => "\nEdit those files and run 'make regen_headers' to effect changes.\n",
		      copyright => [1993 .. 2009], quote => $quote });
}

my ($embed, $core, $ext, $api) = setup_embed();

# generate proto.h
{
    my $pr = open_print_header("proto.h");
    print $pr "START_EXTERN_C\n";
    my $ret;

    foreach (@$embed) {
	if (@$_ == 1) {
	    print $pr "$_->[0]\n";
	    next;
	}

	my ($flags,$retval,$plain_func,@args) = @$_;
	my @nonnull;
	my $has_context = ( $flags !~ /n/ );
	my $never_returns = ( $flags =~ /r/ );
	my $commented_out = ( $flags =~ /m/ );
	my $binarycompat = ( $flags =~ /b/ );
	my $is_malloc = ( $flags =~ /a/ );
	my $can_ignore = ( $flags !~ /R/ ) && !$is_malloc;
	my @names_of_nn;
	my $func;

	my $splint_flags = "";
	if ( $SPLINT && !$commented_out ) {
	    $splint_flags .= '/*@noreturn@*/ ' if $never_returns;
	    if ($can_ignore && ($retval ne 'void') && ($retval !~ /\*/)) {
		$retval .= " /*\@alt void\@*/";
	    }
	}

	if ($flags =~ /([si])/) {
	    my $type = ($1 eq 's') ? "STATIC" : "PERL_STATIC_INLINE";
	    warn "$func: i and s flags are mutually exclusive"
					    if $flags =~ /s/ && $flags =~ /i/;
	    $retval = "$type $splint_flags$retval";
	    $func = "S_$plain_func";
	}
	else {
	    $retval = "PERL_CALLCONV $splint_flags$retval";
	    if ($flags =~ /[bp]/) {
		$func = "Perl_$plain_func";
	    } else {
		$func = $plain_func;
	    }
	}
	$ret = "$retval\t$func(";
	if ( $has_context ) {
	    $ret .= @args ? "pTHX_ " : "pTHX";
	}
	if (@args) {
	    my $n;
	    for my $arg ( @args ) {
		++$n;
		if ( $arg =~ /\*/ && $arg !~ /\b(NN|NULLOK)\b/ ) {
		    warn "$func: $arg needs NN or NULLOK\n";
		    ++$unflagged_pointers;
		}
		my $nn = ( $arg =~ s/\s*\bNN\b\s+// );
		push( @nonnull, $n ) if $nn;

		my $nullok = ( $arg =~ s/\s*\bNULLOK\b\s+// ); # strip NULLOK with no effect

		# Make sure each arg has at least a type and a var name.
		# An arg of "int" is valid C, but want it to be "int foo".
		my $temp_arg = $arg;
		$temp_arg =~ s/\*//g;
		$temp_arg =~ s/\s*\bstruct\b\s*/ /g;
		if ( ($temp_arg ne "...")
		     && ($temp_arg !~ /\w+\s+(\w+)(?:\[\d+\])?\s*$/) ) {
		    warn "$func: $arg ($n) doesn't have a name\n";
		}
		if ( $SPLINT && $nullok && !$commented_out ) {
		    $arg = '/*@null@*/ ' . $arg;
		}
		if (defined $1 && $nn && !($commented_out && !$binarycompat)) {
		    push @names_of_nn, $1;
		}
	    }
	    $ret .= join ", ", @args;
	}
	else {
	    $ret .= "void" if !$has_context;
	}
	$ret .= ")";
	my @attrs;
	if ( $flags =~ /r/ ) {
	    push @attrs, "__attribute__noreturn__";
	}
	if ( $flags =~ /D/ ) {
	    push @attrs, "__attribute__deprecated__";
	}
	if ( $is_malloc ) {
	    push @attrs, "__attribute__malloc__";
	}
	if ( !$can_ignore ) {
	    push @attrs, "__attribute__warn_unused_result__";
	}
	if ( $flags =~ /P/ ) {
	    push @attrs, "__attribute__pure__";
	}
	if( $flags =~ /f/ ) {
	    my $prefix	= $has_context ? 'pTHX_' : '';
	    my $args	= scalar @args;
 	    my $pat	= $args - 1;
	    my $macro	= @nonnull && $nonnull[-1] == $pat  
				? '__attribute__format__'
				: '__attribute__format__null_ok__';
	    push @attrs, sprintf "%s(__printf__,%s%d,%s%d)", $macro,
				$prefix, $pat, $prefix, $args;
	}
	if ( @nonnull ) {
	    my @pos = map { $has_context ? "pTHX_$_" : $_ } @nonnull;
	    push @attrs, map { sprintf( "__attribute__nonnull__(%s)", $_ ) } @pos;
	}
	if ( @attrs ) {
	    $ret .= "\n";
	    $ret .= join( "\n", map { "\t\t\t$_" } @attrs );
	}
	$ret .= ";";
	$ret = "/* $ret */" if $commented_out;
	if (@names_of_nn) {
	    $ret .= "\n#define PERL_ARGS_ASSERT_\U$plain_func\E\t\\\n\t"
		. join '; ', map "assert($_)", @names_of_nn;
	}
	$ret .= @attrs ? "\n\n" : "\n";

	print $pr $ret;
    }

    print $pr <<'EOF';
#ifdef PERL_CORE
#  include "pp_proto.h"
#endif
END_EXTERN_C
EOF

    read_only_bottom_close_and_rename($pr);
}

warn "$unflagged_pointers pointer arguments to clean up\n" if $unflagged_pointers;

sub readvars {
    my ($file, $pre) = @_;
    local (*FILE, $_);
    my %seen;
    open(FILE, "< $file")
	or die "embed.pl: Can't open $file: $!\n";
    while (<FILE>) {
	s/[ \t]*#.*//;		# Delete comments.
	if (/PERLVARA?I?C?\($pre,\s*(\w+)/) {
	    warn "duplicate symbol $1 while processing $file line $.\n"
		if $seen{$1}++;
	}
    }
    close(FILE);
    return sort keys %seen;
}

my @intrp = readvars 'intrpvar.h','I';
my @globvar = readvars 'perlvars.h','G';

sub hide {
    my ($from, $to, $indent) = @_;
    $indent = '' unless defined $indent;
    my $t = int(length("$indent$from") / 8);
    "#${indent}define $from" . "\t" x ($t < 3 ? 3 - $t : 1) . "$to\n";
}

sub multon ($$$) {
    my ($sym,$pre,$ptr) = @_;
    hide("PL_$sym", "($ptr$pre$sym)");
}

my $em = open_print_header('embed.h');

print $em <<'END';
/* (Doing namespace management portably in C is really gross.) */

/* By defining PERL_NO_SHORT_NAMES (not done by default) the short forms
 * (like warn instead of Perl_warn) for the API are not defined.
 * Not defining the short forms is a good thing for cleaner embedding. */

#ifndef PERL_NO_SHORT_NAMES

/* Hide global symbols */

END

my @az = ('a'..'z');

sub embed_h {
    my ($guard, $funcs) = @_;
    print $em "$guard\n" if $guard;

    my $lines;
    foreach (@$funcs) {
	if (@$_ == 1) {
	    my $cond = $_->[0];
	    # Indent the conditionals if we are wrapped in an #if/#endif pair.
	    $cond =~ s/#(.*)/#  $1/ if $guard;
	    $lines .= "$cond\n";
	    next;
	}
	my $ret = "";
	my ($flags,$retval,$func,@args) = @$_;
	unless ($flags =~ /[om]/) {
	    my $args = scalar @args;
	    if ($flags =~ /n/) {
		if ($flags =~ /s/) {
		    $ret = hide($func,"S_$func");
		}
		elsif ($flags =~ /p/) {
		    $ret = hide($func,"Perl_$func");
		}
	    }
	    elsif ($args and $args[$args-1] =~ /\.\.\./) {
		if ($flags =~ /p/) {
		    # we're out of luck for varargs functions under CPP
		    # So we can only do these macros for no implicit context:
		    $ret = "#ifndef PERL_IMPLICIT_CONTEXT\n"
			. hide($func,"Perl_$func") . "#endif\n";
		}
	    }
	    else {
		my $alist = join(",", @az[0..$args-1]);
		$ret = "#define $func($alist)";
		my $t = int(length($ret) / 8);
		$ret .=  "\t" x ($t < 4 ? 4 - $t : 1);
		if ($flags =~ /[si]/) {
		    $ret .= "S_$func(aTHX";
		}
		elsif ($flags =~ /p/) {
		    $ret .= "Perl_$func(aTHX";
		}
		$ret .= "_ " if $alist;
		$ret .= $alist . ")\n";
	    }
	}
	$lines .= $ret;
    }
    # Prune empty #if/#endif pairs.
    while ($lines =~ s/#\s*if[^\n]+\n#\s*endif\n//) {
    }
    # Merge adjacent blocks.
    while ($lines =~ s/(#ifndef PERL_IMPLICIT_CONTEXT
[^\n]+
)#endif
#ifndef PERL_IMPLICIT_CONTEXT
/$1/) {
    }

    print $em $lines;
    print $em "#endif\n" if $guard;
}

embed_h('', $api);
embed_h('#if defined(PERL_CORE) || defined(PERL_EXT)', $ext);
embed_h('#ifdef PERL_CORE', $core);

print $em <<'END';

#endif	/* #ifndef PERL_NO_SHORT_NAMES */

/* Compatibility stubs.  Compile extensions with -DPERL_NOCOMPAT to
   disable them.
 */

#if !defined(PERL_CORE)
#  define sv_setptrobj(rv,ptr,name)	sv_setref_iv(rv,name,PTR2IV(ptr))
#  define sv_setptrref(rv,ptr)		sv_setref_iv(rv,NULL,PTR2IV(ptr))
#endif

#if !defined(PERL_CORE) && !defined(PERL_NOCOMPAT)

/* Compatibility for various misnamed functions.  All functions
   in the API that begin with "perl_" (not "Perl_") take an explicit
   interpreter context pointer.
   The following are not like that, but since they had a "perl_"
   prefix in previous versions, we provide compatibility macros.
 */
#  define perl_atexit(a,b)		call_atexit(a,b)
END

foreach (@$embed) {
    my ($flags, $retval, $func, @args) = @$_;
    next unless $func;
    next unless $flags =~ /O/;

    my $alist = join ",", @az[0..$#args];
    my $ret = "#  define perl_$func($alist)";
    my $t = (length $ret) >> 3;
    $ret .=  "\t" x ($t < 5 ? 5 - $t : 1);
    print $em "$ret$func($alist)\n";
}

my @nocontext;
{
    my (%has_va, %has_nocontext);
    foreach (@$embed) {
	next unless @$_ > 1;
	++$has_va{$_->[2]} if $_->[-1] =~ /\.\.\./;
	++$has_nocontext{$1} if $_->[2] =~ /(.*)_nocontext/;
    }

    @nocontext = sort grep {
	$has_nocontext{$_}
	    && !/printf/ # Not clear to me why these are skipped but they are.
    } keys %has_va;
}

print $em <<'END';

/* varargs functions can't be handled with CPP macros. :-(
   This provides a set of compatibility functions that don't take
   an extra argument but grab the context pointer using the macro
   dTHX.
 */
#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_SHORT_NAMES)
END

foreach (@nocontext) {
    print $em hide($_, "Perl_${_}_nocontext", "  ");
}

print $em <<'END';
#endif

#endif /* !defined(PERL_CORE) && !defined(PERL_NOCOMPAT) */

#if !defined(PERL_IMPLICIT_CONTEXT)
/* undefined symbols, point them back at the usual ones */
END

foreach (@nocontext) {
    print $em hide("Perl_${_}_nocontext", "Perl_$_", "  ");
}

print $em <<'END';
#endif
END

read_only_bottom_close_and_rename($em);

$em = open_print_header('embedvar.h');

print $em <<'END';
/* (Doing namespace management portably in C is really gross.) */

/*
   The following combinations of MULTIPLICITY and PERL_IMPLICIT_CONTEXT
   are supported:
     1) none
     2) MULTIPLICITY	# supported for compatibility
     3) MULTIPLICITY && PERL_IMPLICIT_CONTEXT

   All other combinations of these flags are errors.

   only #3 is supported directly, while #2 is a special
   case of #3 (supported by redefining vTHX appropriately).
*/

#if defined(MULTIPLICITY)
/* cases 2 and 3 above */

#  if defined(PERL_IMPLICIT_CONTEXT)
#    define vTHX	aTHX
#  else
#    define vTHX	PERL_GET_INTERP
#  endif

END

my $sym;

for $sym (@intrp) {
    print $em multon($sym,'I','vTHX->');
}

print $em <<'END';

#endif	/* MULTIPLICITY */

#if defined(PERL_GLOBAL_STRUCT)

END

for $sym (@globvar) {
    print $em "#ifdef OS2\n" if $sym eq 'sh_path';
    print $em multon($sym,   'G','my_vars->');
    print $em multon("G$sym",'', 'my_vars->');
    print $em "#endif\n" if $sym eq 'sh_path';
}

print $em <<'END';

#endif /* PERL_GLOBAL_STRUCT */
END

read_only_bottom_close_and_rename($em);

my $capih = open_print_header('perlapi.h');

print $capih <<'EOT';
/* declare accessor functions for Perl variables */
#ifndef __perlapi_h__
#define __perlapi_h__

#if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)

START_EXTERN_C

#undef PERLVAR
#undef PERLVARA
#undef PERLVARI
#undef PERLVARIC
#define PERLVAR(p,v,t)	EXTERN_C t* Perl_##p##v##_ptr(pTHX);
#define PERLVARA(p,v,n,t)	typedef t PL_##v##_t[n];		\
			EXTERN_C PL_##v##_t* Perl_##p##v##_ptr(pTHX);
#define PERLVARI(p,v,t,i)	PERLVAR(p,v,t)
#define PERLVARIC(p,v,t,i) PERLVAR(p,v, const t)

#include "perlvars.h"

#undef PERLVAR
#undef PERLVARA
#undef PERLVARI
#undef PERLVARIC

END_EXTERN_C

#if defined(PERL_CORE)

/* accessor functions for Perl "global" variables */

/* these need to be mentioned here, or most linkers won't put them in
   the perl executable */

#ifndef PERL_NO_FORCE_LINK

START_EXTERN_C

#ifndef DOINIT
EXTCONST void * const PL_force_link_funcs[];
#else
EXTCONST void * const PL_force_link_funcs[] = {
#undef PERLVAR
#undef PERLVARA
#undef PERLVARI
#undef PERLVARIC
#define PERLVAR(p,v,t)		(void*)Perl_##p##v##_ptr,
#define PERLVARA(p,v,n,t)	PERLVAR(p,v,t)
#define PERLVARI(p,v,t,i)	PERLVAR(p,v,t)
#define PERLVARIC(p,v,t,i)	PERLVAR(p,v,t)

/* In Tru64 (__DEC && __osf__) the cc option -std1 causes that one
 * cannot cast between void pointers and function pointers without
 * info level warnings.  The PL_force_link_funcs[] would cause a few
 * hundred of those warnings.  In code one can circumnavigate this by using
 * unions that overlay the different pointers, but in declarations one
 * cannot use this trick.  Therefore we just disable the warning here
 * for the duration of the PL_force_link_funcs[] declaration. */

#if defined(__DECC) && defined(__osf__)
#pragma message save
#pragma message disable (nonstandcast)
#endif

#include "perlvars.h"

#if defined(__DECC) && defined(__osf__)
#pragma message restore
#endif

#undef PERLVAR
#undef PERLVARA
#undef PERLVARI
#undef PERLVARIC
};
#endif	/* DOINIT */

END_EXTERN_C

#endif	/* PERL_NO_FORCE_LINK */

#else	/* !PERL_CORE */

EOT

foreach $sym (@globvar) {
    print $capih
	"#undef  PL_$sym\n" . hide("PL_$sym", "(*Perl_G${sym}_ptr(NULL))");
}

print $capih <<'EOT';

#endif /* !PERL_CORE */
#endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */

#endif /* __perlapi_h__ */
EOT

read_only_bottom_close_and_rename($capih);

my $capi = open_print_header('perlapi.c', <<'EOQ');
 *
 *
 * Up to the threshold of the door there mounted a flight of twenty-seven
 * broad stairs, hewn by some unknown art of the same black stone.  This
 * was the only entrance to the tower; ...
 *
 *     [p.577 of _The Lord of the Rings_, III/x: "The Voice of Saruman"]
 *
 */
EOQ

print $capi <<'EOT';
#include "EXTERN.h"
#include "perl.h"
#include "perlapi.h"

#if defined (MULTIPLICITY) && defined (PERL_GLOBAL_STRUCT)

/* accessor functions for Perl "global" variables */
START_EXTERN_C

#undef PERLVARI
#define PERLVARI(p,v,t,i) PERLVAR(p,v,t)

#undef PERLVAR
#undef PERLVARA
#define PERLVAR(p,v,t)		t* Perl_##p##v##_ptr(pTHX)		\
			{ dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
#define PERLVARA(p,v,n,t)	PL_##v##_t* Perl_##p##v##_ptr(pTHX)	\
			{ dVAR; PERL_UNUSED_CONTEXT; return &(PL_##v); }
#undef PERLVARIC
#define PERLVARIC(p,v,t,i)	\
			const t* Perl_##p##v##_ptr(pTHX)		\
			{ PERL_UNUSED_CONTEXT; return (const t *)&(PL_##v); }
#include "perlvars.h"

#undef PERLVAR
#undef PERLVARA
#undef PERLVARI
#undef PERLVARIC

END_EXTERN_C

#endif /* MULTIPLICITY && PERL_GLOBAL_STRUCT */
EOT

read_only_bottom_close_and_rename($capi);

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