.\" 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::Probe 3pm"
.TH FFI::Probe 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::Probe \- System detection and probing for FFI extensions.
.SH "VERSION"
.IX Header "VERSION"
version 1.34
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use FFI::Probe;
\& 
\& my $probe = FFI::Probe\->new;
\& $probe\->check_header(\*(Aqfoo.h\*(Aq);
\& ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides an interface for probing for system
capabilities.  It is used internally as part of the
FFI::Platypus build process, but it may also be useful
for extensions that use Platypus as well.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new"
.IX Subsection "new"
.Vb 1
\& my $probe = FFI::Probe\->new(%args);
.Ve
.PP
Creates a new instance.
.IP "log" 4
.IX Item "log"
Path to a log or file handle to write to.
.IP "data_filename" 4
.IX Item "data_filename"
Path to a file which will be used to store/cache results.
.SH "METHODS"
.IX Header "METHODS"
.SS "check_header"
.IX Subsection "check_header"
.Vb 1
\& my $bool = $probe\->check_header($header);
.Ve
.PP
Checks that the given C header file is available.
Stores the result, and returns a true/false value.
.SS "check_cpp"
.IX Subsection "check_cpp"
.SS "check_eval"
.IX Subsection "check_eval"
.Vb 1
\& my $bool = $probe>check_eval(%args);
.Ve
.IP "headers" 4
.IX Item "headers"
Any additional headers.
.IP "decl" 4
.IX Item "decl"
Any C declarations that need to be made before the \f(CW\*(C`dlmain\*(C'\fR function.
.IP "stmt" 4
.IX Item "stmt"
Any C statements that should be made before the evaluation.
.IP "eval" 4
.IX Item "eval"
Any evaluations that should be returned.
.SS "check"
.IX Subsection "check"
.SS "check_type_int"
.IX Subsection "check_type_int"
.Vb 1
\& my $type = $probe\->check_type_int($type);
.Ve
.SS "check_type_enum"
.IX Subsection "check_type_enum"
.Vb 1
\& my $type = $probe\->check_type_enum;
.Ve
.SS "check_type_enum"
.IX Subsection "check_type_enum"
.Vb 1
\& my $type = $probe\->check_type_enum;
.Ve
.SS "check_type_float"
.IX Subsection "check_type_float"
.Vb 1
\& my $type = $probe\->check_type_float($type);
.Ve
.SS "check_type_pointer"
.IX Subsection "check_type_pointer"
.Vb 1
\& my $type = $probe\->check_type_pointer;
.Ve
.SS "set"
.IX Subsection "set"
.Vb 1
\& $probe\->set(@key, $value);
.Ve
.PP
Used internally to store a value.
.SS "save"
.IX Subsection "save"
.Vb 1
\& $probe\->save;
.Ve
.PP
Saves the values already detected.
.SS "data"
.IX Subsection "data"
.Vb 1
\& my $data = $probe\->data;
.Ve
.PP
Returns a hashref of the data already detected.
.SS "log"
.IX Subsection "log"
.Vb 1
\& $probe\->log($string);
.Ve
.PP
Sends the given string to the log.
.SS "log_code"
.IX Subsection "log_code"
.Vb 1
\& $prbe\->log_code($string);
.Ve
.PP
Sends the given multi-line code block to the log.
.SS "template"
.IX Subsection "template"
.Vb 1
\& my $template = $probe\->template;
.Ve
.PP
Returns the C code template used for \f(CW\*(C`check_eval\*(C'\fR and other
\&\f(CW\*(C`check_\*(C'\fR methods.
.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.