<!-- GENERATED by docs/sphinx/bin/20-reference (p5) from reference/bundled/FFI/Probe/Runner/Builder.md. Do not edit. -->

```{index} single: FFI::Probe::Runner::Builder
```

# FFI::Probe::Runner::Builder

Probe runner builder for FFI

## VERSION

version 2.12

## SYNOPSIS

```perl
use FFI::Probe::Runner::Builder;
my $builder = FFI::Probe::Runner::Builder->new
  dir => "/foo/bar",
);
my $exe = $builder->build;
```

## DESCRIPTION

This is a builder class for the FFI probe runner.  It is mostly only of
interest if you are hacking on [FFI::Platypus](../../Platypus.md) itself.

The interface may and will change over time without notice.  Use in
external dependencies at your own peril.

## CONSTRUCTORS

### new

```perl
my $builder = FFI::Probe::Runner::Builder->new(%args);
```

Create a new instance.

- 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](../../Platypus.md) is being built.

## METHODS

### dir

```perl
my $dir = $builder->dir(@subdirs);
```

Returns a subdirectory from the builder root.  Directory
will be created if it doesn't already exist.

### cc

```perl
my @cc = @{ $builder->cc };
```

The C compiler to use.  Returned as an array reference so that it may be modified.

### ccflags

```perl
my @ccflags = @{ $builder->ccflags };
```

The C compiler flags to use.  Returned as an array reference so that it may be modified.

### optimize

The C optimize flags to use.  Returned as an array reference so that it may be modified.

### ld

```perl
my @ld = @{ $builder->ld };
```

The linker to use.  Returned as an array reference so that it may be modified.

### ldflags

```perl
my @ldflags = @{ $builder->ldflags };
```

The linker flags to use.  Returned as an array reference so that it may be modified.

### libs

```perl
my @libs = @{ $builder->libs };
```

The library flags to use.  Returned as an array reference so that it may be modified.

### file

```perl
my $file = $builder->file(@subdirs, $filename);
```

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.

### exe

```perl
my $exe = $builder->exe;
```

The name of the executable, once it is built.

### source

```perl
my $source = $builder->source;
```

The C source for the probe runner.

### extract

```perl
$builder->extract;
```

Extract the source for the probe runner.

### run

```perl
$builder->run($type, @command);
```

Runs the given command.  Dies if the command fails.

### run\_list

```perl
$builder->run($type, \@command, \@command, ...);
```

Runs the given commands in order until one succeeds.
Dies if they all fail.

### build

```perl
my $exe = $builder->build;
```

Builds the probe runner.  Returns the path to the executable.

## AUTHOR

Author: Graham Ollis <plicease@cpan.org>

Contributors:

Bakkiaraj Murugesan (bakkiaraj)

Dylan Cali (calid)

pipcet

Zaki Mughal (zmughal)

Fitz Elliott (felliott)

Vickenty Fesunov (vyf)

Gregor Herrmann (gregoa)

Shlomi Fish (shlomif)

Damyan Ivanov

Ilya Pavlov (Ilya33)

Petr Písař (ppisar)

Mohammad S Anwar (MANWAR)

Håkon Hægland (hakonhagland, HAKONH)

Meredith (merrilymeredith, MHOWARD)

Diab Jerius (DJERIUS)

Eric Brine (IKEGAMI)

szTheory

José Joaquín Atria (JJATRIA)

Pete Houston (openstrike, HOUSTON)

Lukas Mai (MAUKE)

## COPYRIGHT AND LICENSE

This software is copyright (c) 2015-2022 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.