[p5sagit/p5-mst-13.2.git] / win32 / ext / Win32API / File / ppport.h


#ifndef _P_P_PORTABILITY_H_
#define _P_P_PORTABILITY_H_

/* Perl/Pollution/Portability Version 1.0007etm */

/* Copyright (C) 1999, Kenneth Albanowski. This code may be used and
   distributed under the same license as any version of Perl. */
   
/* For the latest version of this code, please retreive the Devel::PPPort
   module from CPAN, contact the author at <kjahds@kjahds.com>, or check
   with the Perl maintainers. */
   
/* If you needed to customize this file for your project, please mention
   your changes, and visible alter the version number. */


/*
   In order for a Perl extension module to be as portable as possible
   across differing versions of Perl itself, certain steps need to be taken.
   Including this header is the first major one, then using dTHR is all the
   appropriate places and using a PL_ prefix to refer to global Perl
   variables is the second.
*/


/* If you use one of a few functions that were not present in earlier
   versions of Perl, please add a define before the inclusion of ppport.h
   for a static include, or use the GLOBAL request in a single module to
   produce a global definition that can be referenced from the other
   modules.
   
   Function:            Static define:           Extern define:
   newCONSTSUB()        NEED_newCONSTSUB         NEED_newCONSTSUB_GLOBAL

*/
 

/* To verify whether ppport.h is needed for your module, and whether any
   special defines should be used, ppport.h can be run through Perl to check
   your source code. Simply say:
   
   	perl -x ppport.h *.c *.h *.xs foo/*.c [etc]
   
   The result will be a list of patches suggesting changes that should at
   least be acceptable, if not necessarily the most efficient solution, or a
   fix for all possible problems. It won't catch where dTHR is needed, and
   doesn't attempt to account for global macro or function definitions,
   nested includes, typemaps, etc.
   
   In order to test for the need of dTHR, please try your module under a
   recent version of Perl that has threading compiled-in.
 
*/ 


/*
#!/usr/bin/perl
@ARGV = ("*.xs") if !@ARGV;
%badmacros = %funcs = %macros = (); $replace = 0;
foreach (<DATA>) {
	$funcs{$1} = 1 if /Provide:\s+(\S+)/;
	$macros{$1} = 1 if /^#\s*define\s+([a-zA-Z0-9_]+)/;
	$replace = $1 if /Replace:\s+(\d+)/;
	$badmacros{$2}=$1 if $replace and /^#\s*define\s+([a-zA-Z0-9_]+).*?\s+([a-zA-Z0-9_]+)/;
	$badmacros{$1}=$2 if /Replace (\S+) with (\S+)/;
}
foreach $filename (map(glob($_),@ARGV)) {
	unless (open(IN, "<$filename")) {
		warn "Unable to read from $file: $!\n";
		next;
	}
	print "Scanning $filename...\n";
	$c = ""; while (<IN>) { $c .= $_; } close(IN);
	$need_include = 0; %add_func = (); $changes = 0;
	$has_include = ($c =~ /#.*include.*ppport/m);

	foreach $func (keys %funcs) {
		if ($c =~ /#.*define.*\bNEED_$func(_GLOBAL)?\b/m) {
			if ($c !~ /\b$func\b/m) {
				print "If $func isn't needed, you don't need to request it.\n" if
				$changes += ($c =~ s/^.*#.*define.*\bNEED_$func\b.*\n//m);
			} else {
				print "Uses $func\n";
				$need_include = 1;
			}
		} else {
			if ($c =~ /\b$func\b/m) {
				$add_func{$func} =1 ;
				print "Uses $func\n";
				$need_include = 1;
			}
		}
	}

	if (not $need_include) {
		foreach $macro (keys %macros) {
			if ($c =~ /\b$macro\b/m) {
				print "Uses $macro\n";
				$need_include = 1;
			}
		}
	}

	foreach $badmacro (keys %badmacros) {
		if ($c =~ /\b$badmacro\b/m) {
			$changes += ($c =~ s/\b$badmacro\b/$badmacros{$badmacro}/gm);
			print "Uses $badmacros{$badmacro} (instead of $badmacro)\n";
			$need_include = 1;
		}
	}
	
	if (scalar(keys %add_func) or $need_include != $has_include) {
		if (!$has_include) {
			$inc = join('',map("#define NEED_$_\n", sort keys %add_func)).
			       "#include \"ppport.h\"\n";
			$c = "$inc$c" unless $c =~ s/#.*include.*XSUB.*\n/$&$inc/m;
		} elsif (keys %add_func) {
			$inc = join('',map("#define NEED_$_\n", sort keys %add_func));
			$c = "$inc$c" unless $c =~ s/^.*#.*include.*ppport.*$/$inc$&/m;
		}
		if (!$need_include) {
			print "Doesn't seem to need ppport.h.\n";
			$c =~ s/^.*#.*include.*ppport.*\n//m;
		}
		$changes++;
	}
	
	if ($changes) {
		open(OUT,">/tmp/ppport.h.$$");
		print OUT $c;
		close(OUT);
		open(DIFF, "diff -u $filename /tmp/ppport.h.$$|");
		while (<DIFF>) { s!/tmp/ppport\.h\.$$!$filename.patched!; print STDOUT; }
		close(DIFF);
		unlink("/tmp/ppport.h.$$");
	} else {
		print "Looks OK\n";
	}
}
__DATA__
*/

#ifndef PERL_REVISION
#   ifndef __PATCHLEVEL_H_INCLUDED__
#       include "patchlevel.h"
#   endif
#   ifndef PERL_REVISION
#	define PERL_REVISION	(5)
        /* Replace: 1 */
#       define PERL_VERSION	PATCHLEVEL
#       define PERL_SUBVERSION	SUBVERSION
        /* Replace PERL_PATCHLEVEL with PERL_VERSION */
        /* Replace: 0 */
#   endif
#endif

#define PERL_BCDVERSION ((PERL_REVISION * 0x1000000L) + (PERL_VERSION * 0x1000L) + PERL_SUBVERSION)

#ifndef ERRSV
#	define ERRSV perl_get_sv("@",FALSE)
#endif

#if (PERL_VERSION < 4) || ((PERL_VERSION == 4) && (PERL_SUBVERSION <= 5))
/* Replace: 1 */
#	define PL_sv_undef	sv_undef
#	define PL_sv_yes	sv_yes
#	define PL_sv_no		sv_no
#	define PL_na		na
#	define PL_stdingv	stdingv
#	define PL_hints		hints
#	define PL_curcop	curcop
#	define PL_curstash	curstash
#	define PL_copline	copline
#	define PL_Sv		Sv
/* Replace: 0 */
#endif

#ifndef dTHR
#  ifdef WIN32
#	define dTHR extern int Perl___notused
#  else
#	define dTHR extern int errno
#  endif
#endif

#ifndef boolSV
#	define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
#endif

#ifndef gv_stashpvn
#	define gv_stashpvn(str,len,flags) gv_stashpv(str,flags)
#endif

#ifndef newSVpvn
#	define newSVpvn(data,len) ((len) ? newSVpv ((data), (len)) : newSVpv ("", 0))
#endif

#ifndef newRV_inc
/* Replace: 1 */
#	define newRV_inc(sv) newRV(sv)
/* Replace: 0 */
#endif

#ifndef newRV_noinc
#  ifdef __GNUC__
#    define newRV_noinc(sv)               \
      ({                                  \
          SV *nsv = (SV*)newRV(sv);       \
          SvREFCNT_dec(sv);               \
          nsv;                            \
      })
#  else
#    if defined(CRIPPLED_CC) || defined(USE_THREADS)
static SV * newRV_noinc (SV * sv)
{
          SV *nsv = (SV*)newRV(sv);       
          SvREFCNT_dec(sv);               
          return nsv;                     
}
#    else
#      define newRV_noinc(sv)    \
        ((PL_Sv=(SV*)newRV(sv), SvREFCNT_dec(sv), (SV*)PL_Sv)
#    endif
#  endif
#endif

/* Provide: newCONSTSUB */

/* newCONSTSUB from IO.xs is in the core starting with 5.004_63 */
#if (PERL_VERSION < 4) || ((PERL_VERSION == 4) && (PERL_SUBVERSION < 63))

#if defined(NEED_newCONSTSUB)
static
#else
extern void newCONSTSUB _((HV * stash, char * name, SV *sv));
#endif

#if defined(NEED_newCONSTSUB) || defined(NEED_newCONSTSUB_GLOBAL)
void
newCONSTSUB( HV *stash, char *name, SV *sv )
{
	U32 oldhints = PL_hints;
	HV *old_cop_stash = PL_curcop->cop_stash;
	HV *old_curstash = PL_curstash;
	line_t oldline = PL_curcop->cop_line;
	PL_curcop->cop_line = PL_copline;

	PL_hints &= ~HINT_BLOCK_SCOPE;
	if (stash)
		PL_curstash = PL_curcop->cop_stash = stash;

	newSUB(

#if (PERL_VERSION < 3) || ((PERL_VERSION == 3) && (PERL_SUBVERSION < 22))
     /* before 5.003_22 */
		start_subparse(),
#else
#  if (PERL_VERSION == 3) && (PERL_SUBVERSION == 22)
     /* 5.003_22 */
     		start_subparse(0),
#  else
     /* 5.003_23  onwards */
     		start_subparse(FALSE, 0),
#  endif
#endif

		newSVOP(OP_CONST, 0, newSVpv(name,0)),
		newSVOP(OP_CONST, 0, &PL_sv_no),   /* SvPV(&PL_sv_no) == "" -- GMB */
		newSTATEOP(0, Nullch, newSVOP(OP_CONST, 0, sv))
	);

	PL_hints = oldhints;
	PL_curcop->cop_stash = old_cop_stash;
	PL_curstash = old_curstash;
	PL_curcop->cop_line = oldline;
}
#endif

#endif /* newCONSTSUB */


#endif /* _P_P_PORTABILITY_H_ */
Commit	Line	Data
00701878	1
	2	#ifndef _P_P_PORTABILITY_H_
	3	#define _P_P_PORTABILITY_H_
	4
	5	/* Perl/Pollution/Portability Version 1.0007etm */
	6
	7	/* Copyright (C) 1999, Kenneth Albanowski. This code may be used and
	8	distributed under the same license as any version of Perl. */
	9
	10	/* For the latest version of this code, please retreive the Devel::PPPort
	11	module from CPAN, contact the author at <kjahds@kjahds.com>, or check
	12	with the Perl maintainers. */
	13
	14	/* If you needed to customize this file for your project, please mention
	15	your changes, and visible alter the version number. */
	16
	17
	18	/*
	19	In order for a Perl extension module to be as portable as possible
	20	across differing versions of Perl itself, certain steps need to be taken.
	21	Including this header is the first major one, then using dTHR is all the
	22	appropriate places and using a PL_ prefix to refer to global Perl
	23	variables is the second.
	24	*/
	25
	26
	27	/* If you use one of a few functions that were not present in earlier
	28	versions of Perl, please add a define before the inclusion of ppport.h
	29	for a static include, or use the GLOBAL request in a single module to
	30	produce a global definition that can be referenced from the other
	31	modules.
	32
	33	Function: Static define: Extern define:
	34	newCONSTSUB() NEED_newCONSTSUB NEED_newCONSTSUB_GLOBAL
	35
	36	*/
	37
	38
	39	/* To verify whether ppport.h is needed for your module, and whether any
	40	special defines should be used, ppport.h can be run through Perl to check
	41	your source code. Simply say:
	42
	43	perl -x ppport.h .c .h .xs foo/.c [etc]
	44
	45	The result will be a list of patches suggesting changes that should at
	46	least be acceptable, if not necessarily the most efficient solution, or a
	47	fix for all possible problems. It won't catch where dTHR is needed, and
	48	doesn't attempt to account for global macro or function definitions,
	49	nested includes, typemaps, etc.
	50
	51	In order to test for the need of dTHR, please try your module under a
	52	recent version of Perl that has threading compiled-in.
	53
	54	*/
	55
	56
	57	/*
	58	#!/usr/bin/perl
	59	@ARGV = ("*.xs") if !@ARGV;
	60	%badmacros = %funcs = %macros = (); $replace = 0;
	61	foreach (<DATA>) {
	62	$funcs{$1} = 1 if /Provide:\s+(\S+)/;
	63	$macros{$1} = 1 if /^#\s*define\s+([a-zA-Z0-9_]+)/;
	64	$replace = $1 if /Replace:\s+(\d+)/;
65	$badmacros{$2}=$1 if $replace and /^#\sdefine\s+([a-zA-Z0-9_]+).?\s+([a-zA-Z0-9_]+)/;
66	$badmacros{$1}=$2 if /Replace (\S+) with (\S+)/;
67	}
68	foreach $filename (map(glob($_),@ARGV)) {
69	unless (open(IN, "<$filename")) {
70	warn "Unable to read from $file: $!\n";
71	next;
72	}
73	print "Scanning $filename...\n";
74	$c = ""; while (<IN>) { $c .= $_; } close(IN);
75	$need_include = 0; %add_func = (); $changes = 0;
76	$has_include = ($c =~ /#.include.ppport/m);
77
78	foreach $func (keys %funcs) {
79	if ($c =~ /#.define.\bNEED_$func(_GLOBAL)?\b/m) {
80	if ($c !~ /\b$func\b/m) {
81	print "If $func isn't needed, you don't need to request it.\n" if
82	$changes += ($c =~ s/^.#.define.\bNEED_$func\b.\n//m);
83	} else {
84	print "Uses $func\n";
85	$need_include = 1;
86	}
87	} else {
88	if ($c =~ /\b$func\b/m) {
89	$add_func{$func} =1 ;
90	print "Uses $func\n";
91	$need_include = 1;
92	}
93	}
94	}
95
96	if (not $need_include) {
97	foreach $macro (keys %macros) {
98	if ($c =~ /\b$macro\b/m) {
99	print "Uses $macro\n";
100	$need_include = 1;
101	}
102	}
103	}
104
105	foreach $badmacro (keys %badmacros) {
106	if ($c =~ /\b$badmacro\b/m) {
107	$changes += ($c =~ s/\b$badmacro\b/$badmacros{$badmacro}/gm);
108	print "Uses $badmacros{$badmacro} (instead of $badmacro)\n";
109	$need_include = 1;
110	}
111	}
112
113	if (scalar(keys %add_func) or $need_include != $has_include) {
114	if (!$has_include) {
115	$inc = join('',map("#define NEED_$_\n", sort keys %add_func)).
116	"#include \"ppport.h\"\n";
117	$c = "$inc$c" unless $c =~ s/#.include.XSUB.*\n/$&$inc/m;
118	} elsif (keys %add_func) {
119	$inc = join('',map("#define NEED_$_\n", sort keys %add_func));
120	$c = "$inc$c" unless $c =~ s/^.#.include.ppport.$/$inc$&/m;
121	}
122	if (!$need_include) {
123	print "Doesn't seem to need ppport.h.\n";
124	$c =~ s/^.#.include.ppport.\n//m;
125	}
126	$changes++;
127	}
128
129	if ($changes) {
130	open(OUT,">/tmp/ppport.h.$$");
131	print OUT $c;
132	close(OUT);
133	open(DIFF, "diff -u $filename /tmp/ppport.h.$$\|");
134	while (<DIFF>) { s!/tmp/ppport\.h\.$$!$filename.patched!; print STDOUT; }
135	close(DIFF);
136	unlink("/tmp/ppport.h.$$");
137	} else {
138	print "Looks OK\n";
139	}
140	}
141	__DATA__
142	*/
143
144	#ifndef PERL_REVISION
145	# ifndef __PATCHLEVEL_H_INCLUDED__
146	# include "patchlevel.h"
147	# endif
148	# ifndef PERL_REVISION
149	# define PERL_REVISION (5)
150	/* Replace: 1 */
151	# define PERL_VERSION PATCHLEVEL
152	# define PERL_SUBVERSION SUBVERSION
153	/* Replace PERL_PATCHLEVEL with PERL_VERSION */
154	/* Replace: 0 */
155	# endif
156	#endif
157
158	#define PERL_BCDVERSION ((PERL_REVISION * 0x1000000L) + (PERL_VERSION * 0x1000L) + PERL_SUBVERSION)
159
160	#ifndef ERRSV
161	# define ERRSV perl_get_sv("@",FALSE)
162	#endif
163
164	#if (PERL_VERSION < 4) \|\| ((PERL_VERSION == 4) && (PERL_SUBVERSION <= 5))
165	/* Replace: 1 */
166	# define PL_sv_undef sv_undef
167	# define PL_sv_yes sv_yes
168	# define PL_sv_no sv_no
169	# define PL_na na
170	# define PL_stdingv stdingv
171	# define PL_hints hints
172	# define PL_curcop curcop
173	# define PL_curstash curstash
174	# define PL_copline copline
175	# define PL_Sv Sv
176	/* Replace: 0 */
177	#endif
178
179	#ifndef dTHR
180	# ifdef WIN32
181	# define dTHR extern int Perl___notused
182	# else
183	# define dTHR extern int errno
184	# endif
185	#endif
186
187	#ifndef boolSV
188	# define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
189	#endif
190
191	#ifndef gv_stashpvn
192	# define gv_stashpvn(str,len,flags) gv_stashpv(str,flags)
193	#endif
194
195	#ifndef newSVpvn
196	# define newSVpvn(data,len) ((len) ? newSVpv ((data), (len)) : newSVpv ("", 0))
197	#endif
198
199	#ifndef newRV_inc
200	/* Replace: 1 */
201	# define newRV_inc(sv) newRV(sv)
202	/* Replace: 0 */
203	#endif
204
205	#ifndef newRV_noinc
206	# ifdef __GNUC__
207	# define newRV_noinc(sv) \
208	({ \
209	SV nsv = (SV)newRV(sv); \
210	SvREFCNT_dec(sv); \
211	nsv; \
212	})
213	# else
214	# if defined(CRIPPLED_CC) \|\| defined(USE_THREADS)
215	static SV * newRV_noinc (SV * sv)
216	{
217	SV nsv = (SV)newRV(sv);
218	SvREFCNT_dec(sv);
219	return nsv;
220	}
221	# else
222	# define newRV_noinc(sv) \
223	((PL_Sv=(SV)newRV(sv), SvREFCNT_dec(sv), (SV)PL_Sv)
224	# endif
225	# endif
226	#endif
227
228	/* Provide: newCONSTSUB */
229
230	/* newCONSTSUB from IO.xs is in the core starting with 5.004_63 */
231	#if (PERL_VERSION < 4) \|\| ((PERL_VERSION == 4) && (PERL_SUBVERSION < 63))
232
233	#if defined(NEED_newCONSTSUB)
234	static
235	#else
236	extern void newCONSTSUB _((HV * stash, char * name, SV *sv));
237	#endif
238
239	#if defined(NEED_newCONSTSUB) \|\| defined(NEED_newCONSTSUB_GLOBAL)
240	void
241	newCONSTSUB( HV stash, char name, SV *sv )
242	{
243	U32 oldhints = PL_hints;
244	HV *old_cop_stash = PL_curcop->cop_stash;
245	HV *old_curstash = PL_curstash;
246	line_t oldline = PL_curcop->cop_line;
247	PL_curcop->cop_line = PL_copline;
248
249	PL_hints &= ~HINT_BLOCK_SCOPE;
250	if (stash)
251	PL_curstash = PL_curcop->cop_stash = stash;
252
253	newSUB(
254
255	#if (PERL_VERSION < 3) \|\| ((PERL_VERSION == 3) && (PERL_SUBVERSION < 22))
256	/* before 5.003_22 */
257	start_subparse(),
258	#else
259	# if (PERL_VERSION == 3) && (PERL_SUBVERSION == 22)
260	/* 5.003_22 */
261	start_subparse(0),
262	# else
263	/* 5.003_23 onwards */
264	start_subparse(FALSE, 0),
265	# endif
266	#endif
267
268	newSVOP(OP_CONST, 0, newSVpv(name,0)),
269	newSVOP(OP_CONST, 0, &PL_sv_no), /* SvPV(&PL_sv_no) == "" -- GMB */
270	newSTATEOP(0, Nullch, newSVOP(OP_CONST, 0, sv))
271	);
272
273	PL_hints = oldhints;
274	PL_curcop->cop_stash = old_cop_stash;
275	PL_curstash = old_curstash;
276	PL_curcop->cop_line = oldline;
277	}
278	#endif
279
280	#endif /* newCONSTSUB */
281
282
283	#endif /* _P_P_PORTABILITY_H_ */