.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Runner::Builder 3pm"
.TH FFI::Probe::Runner::Builder 3pm 2024-01-10 "perl v5.38.2" "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::Runner::Builder \- Probe runner builder for FFI
.SH VERSION
.IX Header "VERSION"
version 2.08
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\& use FFI::Probe::Runner::Builder;
\& my $builder = FFI::Probe::Runner::Builder\->new
\&   dir => "/foo/bar",
\& );
\& my $exe = $builder\->build;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a builder class for the FFI probe runner.  It is mostly only of
interest if you are hacking on FFI::Platypus itself.
.PP
The interface may and will change over time without notice.  Use in
external dependencies at your own peril.
.SH CONSTRUCTORS
.IX Header "CONSTRUCTORS"
.SS new
.IX Subsection "new"
.Vb 1
\& my $builder = FFI::Probe::Runner::Builder\->new(%args);
.Ve
.PP
Create a new instance.
.IP dir 4
.IX Item "dir"
The root directory for where to place the probe runner files.
Will be created if it doesn't already exist.  The default
makes sense for when FFI::Platypus is being built.
.SH METHODS
.IX Header "METHODS"
.SS dir
.IX Subsection "dir"
.Vb 1
\& my $dir = $builder\->dir(@subdirs);
.Ve
.PP
Returns a subdirectory from the builder root.  Directory
will be created if it doesn't already exist.
.SS cc
.IX Subsection "cc"
.Vb 1
\& my @cc = @{ $builder\->cc };
.Ve
.PP
The C compiler to use.  Returned as an array reference so that it may be modified.
.SS ccflags
.IX Subsection "ccflags"
.Vb 1
\& my @ccflags = @{ $builder\->ccflags };
.Ve
.PP
The C compiler flags to use.  Returned as an array reference so that it may be modified.
.SS optimize
.IX Subsection "optimize"
The C optimize flags to use.  Returned as an array reference so that it may be modified.
.SS ld
.IX Subsection "ld"
.Vb 1
\& my @ld = @{ $builder\->ld };
.Ve
.PP
The linker to use.  Returned as an array reference so that it may be modified.
.SS ldflags
.IX Subsection "ldflags"
.Vb 1
\& my @ldflags = @{ $builder\->ldflags };
.Ve
.PP
The linker flags to use.  Returned as an array reference so that it may be modified.
.SS libs
.IX Subsection "libs"
.Vb 1
\& my @libs = @{ $builder\->libs };
.Ve
.PP
The library flags to use.  Returned as an array reference so that it may be modified.
.SS file
.IX Subsection "file"
.Vb 1
\& my $file = $builder\->file(@subdirs, $filename);
.Ve
.PP
Returns a file in a subdirectory from the builder root.
Directory will be created if it doesn't already exist.
File will not be created.
.SS exe
.IX Subsection "exe"
.Vb 1
\& my $exe = $builder\->exe;
.Ve
.PP
The name of the executable, once it is built.
.SS source
.IX Subsection "source"
.Vb 1
\& my $source = $builder\->source;
.Ve
.PP
The C source for the probe runner.
.SS extract
.IX Subsection "extract"
.Vb 1
\& $builder\->extract;
.Ve
.PP
Extract the source for the probe runner.
.SS run
.IX Subsection "run"
.Vb 1
\& $builder\->run($type, @command);
.Ve
.PP
Runs the given command.  Dies if the command fails.
.SS run_list
.IX Subsection "run_list"
.Vb 1
\& $builder\->run($type, \e@command, \e@command, ...);
.Ve
.PP
Runs the given commands in order until one succeeds.
Dies if they all fail.
.SS build
.IX Subsection "build"
.Vb 1
\& my $exe = $builder\->build;
.Ve
.PP
Builds the probe runner.  Returns the path to the executable.
.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 Písař (ppisar)
.PP
Mohammad S Anwar (MANWAR)
.PP
Håkon Hægland (hakonhagland, HAKONH)
.PP
Meredith (merrilymeredith, MHOWARD)
.PP
Diab Jerius (DJERIUS)
.PP
Eric Brine (IKEGAMI)
.PP
szTheory
.PP
José Joaquín Atria (JJATRIA)
.PP
Pete Houston (openstrike, HOUSTON)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2015\-2022 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.