2 /* ppport.h -- Perl/Pollution/Portability Version 2.0002
4 * Automatically Created by Devel::PPPort on Wed Oct 8 22:28:04 2003
6 * Do NOT edit this file directly! -- Edit PPPort.pm instead.
8 * Version 2.x, Copyright (C) 2001, Paul Marquess.
9 * Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
10 * This code may be used and distributed under the same license as any
13 * This version of ppport.h is designed to support operation with Perl
14 * installations back to 5.004, and has been tested up to 5.8.0.
16 * If this version of ppport.h is failing during the compilation of this
17 * module, please check if a newer version of Devel::PPPort is available
18 * on CPAN before sending a bug report.
20 * If you are using the latest version of Devel::PPPort and it is failing
21 * during compilation of this module, please send a report to perlbug@perl.com
23 * Include all following information:
25 * 1. The complete output from running "perl -V"
29 * 3. The name & version of the module you were trying to build.
31 * 4. A full log of the build that failed.
33 * 5. Any other information that you think could be relevant.
36 * For the latest version of this code, please retreive the Devel::PPPort
42 * In order for a Perl extension module to be as portable as possible
43 * across differing versions of Perl itself, certain steps need to be taken.
44 * Including this header is the first major one, then using dTHR is all the
45 * appropriate places and using a PL_ prefix to refer to global Perl
46 * variables is the second.
51 /* If you use one of a few functions that were not present in earlier
52 * versions of Perl, please add a define before the inclusion of ppport.h
53 * for a static include, or use the GLOBAL request in a single module to
54 * produce a global definition that can be referenced from the other
57 * Function: Static define: Extern define:
58 * newCONSTSUB() NEED_newCONSTSUB NEED_newCONSTSUB_GLOBAL
63 /* To verify whether ppport.h is needed for your module, and whether any
64 * special defines should be used, ppport.h can be run through Perl to check
65 * your source code. Simply say:
67 * perl -x ppport.h *.c *.h *.xs foo/bar*.c [etc]
69 * The result will be a list of patches suggesting changes that should at
70 * least be acceptable, if not necessarily the most efficient solution, or a
71 * fix for all possible problems. It won't catch where dTHR is needed, and
72 * doesn't attempt to account for global macro or function definitions,
73 * nested includes, typemaps, etc.
75 * In order to test for the need of dTHR, please try your module under a
76 * recent version of Perl that has threading compiled-in.
83 @ARGV = ("*.xs") if !@ARGV;
84 %badmacros = %funcs = %macros = (); $replace = 0;
86 $funcs{$1} = 1 if /Provide:\s+(\S+)/;
87 $macros{$1} = 1 if /^#\s*define\s+([a-zA-Z0-9_]+)/;
88 $replace = $1 if /Replace:\s+(\d+)/;
89 $badmacros{$2}=$1 if $replace and /^#\s*define\s+([a-zA-Z0-9_]+).*?\s+([a-zA-Z0-9_]+)/;
90 $badmacros{$1}=$2 if /Replace (\S+) with (\S+)/;
92 foreach $filename (map(glob($_),@ARGV)) {
93 unless (open(IN, "<$filename")) {
94 warn "Unable to read from $file: $!\n";
97 print "Scanning $filename...\n";
98 $c = ""; while (<IN>) { $c .= $_; } close(IN);
99 $need_include = 0; %add_func = (); $changes = 0;
100 $has_include = ($c =~ /#.*include.*ppport/m);
102 foreach $func (keys %funcs) {
103 if ($c =~ /#.*define.*\bNEED_$func(_GLOBAL)?\b/m) {
104 if ($c !~ /\b$func\b/m) {
105 print "If $func isn't needed, you don't need to request it.\n" if
106 $changes += ($c =~ s/^.*#.*define.*\bNEED_$func\b.*\n//m);
108 print "Uses $func\n";
112 if ($c =~ /\b$func\b/m) {
113 $add_func{$func} =1 ;
114 print "Uses $func\n";
120 if (not $need_include) {
121 foreach $macro (keys %macros) {
122 if ($c =~ /\b$macro\b/m) {
123 print "Uses $macro\n";
129 foreach $badmacro (keys %badmacros) {
130 if ($c =~ /\b$badmacro\b/m) {
131 $changes += ($c =~ s/\b$badmacro\b/$badmacros{$badmacro}/gm);
132 print "Uses $badmacros{$badmacro} (instead of $badmacro)\n";
137 if (scalar(keys %add_func) or $need_include != $has_include) {
139 $inc = join('',map("#define NEED_$_\n", sort keys %add_func)).
140 "#include \"ppport.h\"\n";
141 $c = "$inc$c" unless $c =~ s/#.*include.*XSUB.*\n/$&$inc/m;
142 } elsif (keys %add_func) {
143 $inc = join('',map("#define NEED_$_\n", sort keys %add_func));
144 $c = "$inc$c" unless $c =~ s/^.*#.*include.*ppport.*$/$inc$&/m;
146 if (!$need_include) {
147 print "Doesn't seem to need ppport.h.\n";
148 $c =~ s/^.*#.*include.*ppport.*\n//m;
154 open(OUT,">/tmp/ppport.h.$$");
157 open(DIFF, "diff -u $filename /tmp/ppport.h.$$|");
158 while (<DIFF>) { s!/tmp/ppport\.h\.$$!$filename.patched!; print STDOUT; }
160 unlink("/tmp/ppport.h.$$");
168 #ifndef _P_P_PORTABILITY_H_
169 #define _P_P_PORTABILITY_H_
171 #ifndef PERL_REVISION
172 # ifndef __PATCHLEVEL_H_INCLUDED__
173 # include "patchlevel.h"
175 # ifndef PERL_REVISION
176 # define PERL_REVISION (5)
178 # define PERL_VERSION PATCHLEVEL
179 # define PERL_SUBVERSION SUBVERSION
180 /* Replace PERL_PATCHLEVEL with PERL_VERSION */
185 #define PERL_BCDVERSION ((PERL_REVISION * 0x1000000L) + (PERL_VERSION * 0x1000L) + PERL_SUBVERSION)
187 /* It is very unlikely that anyone will try to use this with Perl 6
188 (or greater), but who knows.
190 #if PERL_REVISION != 5
191 # error ppport.h only works with Perl version 5
192 #endif /* PERL_REVISION != 5 */
195 # define ERRSV perl_get_sv("@",FALSE)
198 #if (PERL_VERSION < 4) || ((PERL_VERSION == 4) && (PERL_SUBVERSION <= 5))
201 # define PL_compiling compiling
202 # define PL_copline copline
203 # define PL_curcop curcop
204 # define PL_curstash curstash
205 # define PL_defgv defgv
206 # define PL_dirty dirty
207 # define PL_dowarn dowarn
208 # define PL_hints hints
210 # define PL_perldb perldb
211 # define PL_rsfp_filters rsfp_filters
212 # define PL_rsfpv rsfp
213 # define PL_stdingv stdingv
214 # define PL_sv_no sv_no
215 # define PL_sv_undef sv_undef
216 # define PL_sv_yes sv_yes
221 # if defined(__GNUC__) && defined(__cplusplus)
222 # define PERL_UNUSED_DECL
224 # define PERL_UNUSED_DECL __attribute__((unused))
227 # define PERL_UNUSED_DECL
231 # define NOOP (void)0
232 # define dNOOP extern int Perl___notused PERL_UNUSED_DECL
241 # define dTHXa(x) dNOOP
242 # define dTHXoa(x) dNOOP
253 # define UVSIZE IVSIZE
257 # if defined(USE_LONG_DOUBLE) && defined(HAS_LONG_DOUBLE)
258 # define NVTYPE long double
260 # define NVTYPE double
267 #if (IVSIZE == PTRSIZE) && (UVSIZE == PTRSIZE)
269 # define INT2PTR(any,d) (any)(d)
271 # if PTRSIZE == LONGSIZE
272 # define PTRV unsigned long
274 # define PTRV unsigned
276 # define INT2PTR(any,d) (any)(PTRV)(d)
278 #define NUM2PTR(any,d) (any)(PTRV)(d)
279 #define PTR2IV(p) INT2PTR(IV,p)
280 #define PTR2UV(p) INT2PTR(UV,p)
281 #define PTR2NV(p) NUM2PTR(NV,p)
282 #if PTRSIZE == LONGSIZE
283 # define PTR2ul(p) (unsigned long)(p)
285 # define PTR2ul(p) INT2PTR(unsigned long,p)
288 #endif /* !INT2PTR */
291 # define boolSV(b) ((b) ? &PL_sv_yes : &PL_sv_no)
295 # define gv_stashpvn(str,len,flags) gv_stashpv(str,flags)
299 # define newSVpvn(data,len) ((len) ? newSVpv ((data), (len)) : newSVpv ("", 0))
304 # define newRV_inc(sv) newRV(sv)
308 /* DEFSV appears first in 5.004_56 */
310 # define DEFSV GvSV(PL_defgv)
314 # define SAVE_DEFSV SAVESPTR(GvSV(PL_defgv))
319 # define newRV_noinc(sv) \
321 SV *nsv = (SV*)newRV(sv); \
326 # if defined(USE_THREADS)
327 static SV * newRV_noinc (SV * sv)
329 SV *nsv = (SV*)newRV(sv);
334 # define newRV_noinc(sv) \
335 (PL_Sv=(SV*)newRV(sv), SvREFCNT_dec(sv), (SV*)PL_Sv)
340 /* Provide: newCONSTSUB */
342 /* newCONSTSUB from IO.xs is in the core starting with 5.004_63 */
343 #if (PERL_VERSION < 4) || ((PERL_VERSION == 4) && (PERL_SUBVERSION < 63))
345 #if defined(NEED_newCONSTSUB)
348 extern void newCONSTSUB(HV * stash, char * name, SV *sv);
351 #if defined(NEED_newCONSTSUB) || defined(NEED_newCONSTSUB_GLOBAL)
353 newCONSTSUB(stash,name,sv)
358 U32 oldhints = PL_hints;
359 HV *old_cop_stash = PL_curcop->cop_stash;
360 HV *old_curstash = PL_curstash;
361 line_t oldline = PL_curcop->cop_line;
362 PL_curcop->cop_line = PL_copline;
364 PL_hints &= ~HINT_BLOCK_SCOPE;
366 PL_curstash = PL_curcop->cop_stash = stash;
370 #if (PERL_VERSION < 3) || ((PERL_VERSION == 3) && (PERL_SUBVERSION < 22))
371 /* before 5.003_22 */
374 # if (PERL_VERSION == 3) && (PERL_SUBVERSION == 22)
378 /* 5.003_23 onwards */
379 start_subparse(FALSE, 0),
383 newSVOP(OP_CONST, 0, newSVpv(name,0)),
384 newSVOP(OP_CONST, 0, &PL_sv_no), /* SvPV(&PL_sv_no) == "" -- GMB */
385 newSTATEOP(0, Nullch, newSVOP(OP_CONST, 0, sv))
389 PL_curcop->cop_stash = old_cop_stash;
390 PL_curstash = old_curstash;
391 PL_curcop->cop_line = oldline;
395 #endif /* newCONSTSUB */
400 * Boilerplate macros for initializing and accessing interpreter-local
401 * data from C. All statics in extensions should be reworked to use
402 * this, if you want to make the extension thread-safe. See ext/re/re.xs
403 * for an example of the use of these macros.
405 * Code that uses these macros is responsible for the following:
406 * 1. #define MY_CXT_KEY to a unique string, e.g. "DynaLoader_guts"
407 * 2. Declare a typedef named my_cxt_t that is a structure that contains
408 * all the data that needs to be interpreter-local.
409 * 3. Use the START_MY_CXT macro after the declaration of my_cxt_t.
410 * 4. Use the MY_CXT_INIT macro such that it is called exactly once
411 * (typically put in the BOOT: section).
412 * 5. Use the members of the my_cxt_t structure everywhere as
414 * 6. Use the dMY_CXT macro (a declaration) in all the functions that
418 #if defined(MULTIPLICITY) || defined(PERL_OBJECT) || \
419 defined(PERL_CAPI) || defined(PERL_IMPLICIT_CONTEXT)
421 /* This must appear in all extensions that define a my_cxt_t structure,
422 * right after the definition (i.e. at file scope). The non-threads
423 * case below uses it to declare the data as static. */
426 #if (PERL_VERSION < 4 || (PERL_VERSION == 4 && PERL_SUBVERSION < 68 ))
427 /* Fetches the SV that keeps the per-interpreter data. */
429 SV *my_cxt_sv = perl_get_sv(MY_CXT_KEY, FALSE)
430 #else /* >= perl5.004_68 */
432 SV *my_cxt_sv = *hv_fetch(PL_modglobal, MY_CXT_KEY, \
433 sizeof(MY_CXT_KEY)-1, TRUE)
434 #endif /* < perl5.004_68 */
436 /* This declaration should be used within all functions that use the
437 * interpreter-local data. */
440 my_cxt_t *my_cxtp = INT2PTR(my_cxt_t*,SvUV(my_cxt_sv))
442 /* Creates and zeroes the per-interpreter data.
443 * (We allocate my_cxtp in a Perl SV so that it will be released when
444 * the interpreter goes away.) */
445 #define MY_CXT_INIT \
447 /* newSV() allocates one more than needed */ \
448 my_cxt_t *my_cxtp = (my_cxt_t*)SvPVX(newSV(sizeof(my_cxt_t)-1));\
449 Zero(my_cxtp, 1, my_cxt_t); \
450 sv_setuv(my_cxt_sv, PTR2UV(my_cxtp))
452 /* This macro must be used to access members of the my_cxt_t structure.
453 * e.g. MYCXT.some_data */
454 #define MY_CXT (*my_cxtp)
456 /* Judicious use of these macros can reduce the number of times dMY_CXT
457 * is used. Use is similar to pTHX, aTHX etc. */
458 #define pMY_CXT my_cxt_t *my_cxtp
459 #define pMY_CXT_ pMY_CXT,
460 #define _pMY_CXT ,pMY_CXT
461 #define aMY_CXT my_cxtp
462 #define aMY_CXT_ aMY_CXT,
463 #define _aMY_CXT ,aMY_CXT
465 #else /* single interpreter */
468 #define START_MY_CXT static my_cxt_t my_cxt;
469 #define dMY_CXT_SV dNOOP
470 #define dMY_CXT dNOOP
471 #define MY_CXT_INIT NOOP
472 #define MY_CXT my_cxt
483 #endif /* START_MY_CXT */
486 # if IVSIZE == LONGSIZE
493 # if IVSIZE == INTSIZE
504 # if defined(USE_LONG_DOUBLE) && defined(HAS_LONG_DOUBLE) && \
505 defined(PERL_PRIfldbl) /* Not very likely, but let's try anyway. */
506 # define NVef PERL_PRIeldbl
507 # define NVff PERL_PRIfldbl
508 # define NVgf PERL_PRIgldbl
516 #ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
517 # define AvFILLp AvFILL
521 # if PERL_REVISION == 5 && PERL_VERSION < 7
522 /* SvPVbyte does not work in perl-5.6.1, borrowed version for 5.7.3 */
524 # define SvPVbyte(sv, lp) \
525 ((SvFLAGS(sv) & (SVf_POK|SVf_UTF8)) == (SVf_POK) \
526 ? ((lp = SvCUR(sv)), SvPVX(sv)) : my_sv_2pvbyte(aTHX_ sv, &lp))
528 my_sv_2pvbyte(pTHX_ register SV *sv, STRLEN *lp)
530 sv_utf8_downgrade(sv,0);
535 # define SvPVbyte SvPV
538 #endif /* _P_P_PORTABILITY_H_ */
540 /* End of File ppport.h */