.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.IX Title "Devel::PPPort 3"
.TH Devel::PPPort 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
Devel::PPPort \- Perl/Pollution/Portability
\& Devel::PPPort::WriteFile(); # defaults to ./ppport.h
\& Devel::PPPort::WriteFile('someheader.h');
Perl's \s-1API\s0 has changed over time, gaining new features, new functions,
increasing its flexibility, and reducing the impact on the C namespace
environment (reduced pollution). The header file written by this module,
typically \fIppport.h\fR, attempts to bring some of the newer Perl \s-1API\s0
features to older versions of Perl, so that you can worry less about
keeping track of old releases, but users can still reap the benefit.
\&\f(CW\*(C`Devel::PPPort\*(C'\fR contains a single function, called \f(CW\*(C`WriteFile\*(C'\fR. Its
only purpose is to write the \fIppport.h\fR C header file. This file
contains a series of macros and, if explicitly requested, functions that
allow \s-1XS\s0 modules to be built using older versions of Perl. Currently,
Perl versions from 5.003 to 5.9.3 are supported.
This module is used by \f(CW\*(C`h2xs\*(C'\fR to write the file \fIppport.h\fR.
.IX Subsection "Why use ppport.h?"
You should use \fIppport.h\fR in modern code so that your code will work
with the widest range of Perl interpreters possible, without significant
You should attempt older code to fully use \fIppport.h\fR, because the
reduced pollution of newer Perl versions is an important thing. It's so
important that the old polluting ways of original Perl modules will not be
supported very far into the future, and your module will almost certainly
break! By adapting to it now, you'll gain compatibility and a sense of
having done the electronic ecology some good.
.Sh "How to use ppport.h"
.IX Subsection "How to use ppport.h"
Don't direct the users of your module to download \f(CW\*(C`Devel::PPPort\*(C'\fR.
They are most probably no \s-1XS\s0 writers. Also, don't make \fIppport.h\fR
optional. Rather, just take the most recent copy of \fIppport.h\fR that
you can find (e.g. by generating it with the latest \f(CW\*(C`Devel::PPPort\*(C'\fR
release from \s-1CPAN\s0), copy it into your project, adjust your project to
use it, and distribute the header along with your module.
.IX Subsection "Running ppport.h"
But \fIppport.h\fR is more than just a C header. It's also a Perl script
that can check your source code. It will suggest hints and portability
notes, and can even make suggestions on how to change your code. You
can run it like any other Perl program:
\& perl ppport.h [options] [files]
It also has embedded documentation, so you can use
to find out more about how to use it.
.IX Subsection "WriteFile"
\&\f(CW\*(C`WriteFile\*(C'\fR takes one optional argument. When called with one
argument, it expects to be passed a filename. When called with
no arguments, it defaults to the filename \fIppport.h\fR.
The function returns a true value if the file was written successfully.
Otherwise it returns a false value.
.IX Header "COMPATIBILITY"
\&\fIppport.h\fR supports Perl versions from 5.003 to 5.9.3
in threaded and non-threaded configurations.
.Sh "Provided Perl compatibility \s-1API\s0"
.IX Subsection "Provided Perl compatibility API"
The header file written by this module, typically \fIppport.h\fR, provides
access to the following elements of the Perl \s-1API\s0 that is not available
\& IS_NUMBER_GREATER_THAN_UV_MAX
\& PERL_GCC_BRACE_GROUPS_FORBIDDEN
\& PERL_MAGIC_overload_elem
\& PERL_MAGIC_overload_table
\& PERL_MAGIC_regex_global
\& PERL_MAGIC_shared_scalar
\& PERL_SCAN_ALLOW_UNDERSCORES
\& PERL_SCAN_DISALLOW_PREFIX
\& PERL_SCAN_GREATER_THAN_UV_MAX
\& PERL_SCAN_SILENT_ILLDIGIT
\& PL_perl_destruct_level
\& sv_catpvf_mg_nocontext
\& sv_setpvf_mg_nocontext
.Sh "Perl \s-1API\s0 not supported by ppport.h"
.IX Subsection "Perl API not supported by ppport.h"
There is still a big part of the \s-1API\s0 not supported by \fIppport.h\fR.
Either because it doesn't make sense to back-port that part of the \s-1API\s0,
or simply because it hasn't been implemented yet. Patches welcome!
Here's a list of the currently unsupported \s-1API\s0, and also the version of
Perl below which it is unsupported:
\& utf16_to_utf8_reversed
\& gv_fetchmethod_autoload
If you find any bugs, \f(CW\*(C`Devel::PPPort\*(C'\fR doesn't seem to build on your
system or any of its tests fail, please use the \s-1CPAN\s0 Request Tracker
at <http://rt.cpan.org/> to create a ticket for the module.
Version 1.x of Devel::PPPort was written by Kenneth Albanowski.
Version 2.x was ported to the Perl core by Paul Marquess.
Version 3.x was ported back to \s-1CPAN\s0 by Marcus Holland\-Moritz.
Version 3.x, Copyright (C) 2004\-2005, Marcus Holland\-Moritz.
Version 2.x, Copyright (C) 2001, Paul Marquess.
Version 1.x, Copyright (C) 1999, Kenneth Albanowski.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
projects / OpenSPARC-T2-SAM / blob