.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" 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.  \*(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<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    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
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FFI::Platypus::TypeParser::Version0 3pm"
.TH FFI::Platypus::TypeParser::Version0 3pm "2020-11-08" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
FFI::Platypus::TypeParser::Version0 \- FFI Type Parser Version Zero
.SH "VERSION"
.IX Header "VERSION"
version 1.34
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\& use FFI::Platypus;
\& my $ffi = FFI::Platypus\->new( api => 0 );
\& $ffi\->type(\*(Aqrecord(Foo::Bar)\*(Aq => \*(Aqfoo_bar_t\*(Aq);
\& $ffi\->type(\*(Aqopaque\*(Aq => \*(Aqbaz_t\*(Aq);
\& $ffi\->type(\*(Aqopaque*\*(Aq => \*(Aqbaz_ptr\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This documents the original FFI::Platypus type parser.  It was the default and only
type parser used by FFI::Platypus starting with version \f(CW0.02\fR.  Starting with
version \f(CW1.00\fR FFI::Platypus comes with a new type parser with design fixes that
are not backward compatibility.
.SS "Interface differences"
.IX Subsection "Interface differences"
.IP "Pass-by-value records are not allowed" 4
.IX Item "Pass-by-value records are not allowed"
Originally FFI::Platypus only supported passing records as a pointer.  The type
\&\f(CW\*(C`record(Foo::Bar)\*(C'\fR actually passes a pointer to the record.  In the version 1.00 parser
allows \f(CW\*(C`record(Foo::Bar)\*(C'\fR which is pass-by-value (the contents of the record is copied
onto the stack) and \f(CW\*(C`record(Foo::Bar)*\*(C'\fR which is pass-by-reference or pointer (a pointer
to the record is passed to the callee so that it can make modifications to the record).
.Sp
\&\s-1TL\s0;DR \f(CW\*(C`record(Foo::Bar)\*(C'\fR in version 0 is equivalent to \f(CW\*(C`record(Foo::Bar)*\*(C'\fR in the
version 1 \s-1API.\s0  There is no equivalent to \f(CW\*(C`record(Foo::Bar)*\*(C'\fR in the version 0 \s-1API.\s0
.IP "decorate aliases of basic types" 4
.IX Item "decorate aliases of basic types"
This is not allowed in the version 0 \s-1API:\s0
.Sp
.Vb 2
\& $ffi\->type(\*(Aqopaque\*(Aq => \*(Aqfoo_t\*(Aq);    # ok!
\& $ffi\->type(\*(Aqfoo_t*\*(Aq => \*(Aqfoo_ptr\*(Aq);  # not ok! in version 0, ok! in version 1
.Ve
.Sp
Instead you need to use the basic type in the second type definition:
.Sp
.Vb 2
\& $ffi\->type(\*(Aqopaque\*(Aq => \*(Aqfoo_t\*(Aq);    # ok!
\& $ffi\->type(\*(Aqopaque*\*(Aq => \*(Aqfoo_ptr\*(Aq); # ok!
.Ve
.IP "object types are not allowed" 4
.IX Item "object types are not allowed"
.Vb 1
\& $ffi\->type(\*(Aqobject(Foo::Bar)\*(Aq);   # not ok! in version 0, ok! in version 1
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "FFI::Platypus" 4
.IX Item "FFI::Platypus"
The core FFI::Platypus documentation.
.IP "FFI::Platypus::TypeParser::Version1" 4
.IX Item "FFI::Platypus::TypeParser::Version1"
The \s-1API\s0 \f(CW1.00\fR type parser.
.SH "AUTHOR"
.IX Header "AUTHOR"
Author: Graham Ollis <plicease@cpan.org>
.PP
Contributors:
.PP
Bakkiaraj Murugesan (bakkiaraj)
.PP
Dylan Cali (calid)
.PP
pipcet
.PP
Zaki Mughal (zmughal)
.PP
Fitz Elliott (felliott)
.PP
Vickenty Fesunov (vyf)
.PP
Gregor Herrmann (gregoa)
.PP
Shlomi Fish (shlomif)
.PP
Damyan Ivanov
.PP
Ilya Pavlov (Ilya33)
.PP
Petr Pisar (ppisar)
.PP
Mohammad S Anwar (\s-1MANWAR\s0)
.PP
Håkon Hægland (hakonhagland, \s-1HAKONH\s0)
.PP
Meredith (merrilymeredith, \s-1MHOWARD\s0)
.PP
Diab Jerius (\s-1DJERIUS\s0)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2015,2016,2017,2018,2019,2020 by Graham Ollis.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.