.\" 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::Build::MM 3pm" .TH FFI::Build::MM 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::Build::MM \- FFI::Build installer code for ExtUtils::MakeMaker .SH "VERSION" .IX Header "VERSION" version 1.34 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In your Makefile.PL: .PP .Vb 2 \& use ExtUtils::MakeMaker; \& use FFI::Build::MM; \& \& my $fbmm = FFI::Build::MM\->new; \& \& WriteMakefile($fbmm\->mm_args( \& ABSTRACT => \*(AqMy FFI extension\*(Aq, \& DISTNAME => \*(AqFoo\-Bar\-Baz\-FFI\*(Aq, \& NAME => \*(AqFoo::Bar::Baz::FFI\*(Aq, \& VERSION_FROM => \*(Aqlib/Foo/Bar/Baz/FFI.pm\*(Aq, \& ... \& )); \& \& sub MY::postamble { \& $fbmm\->mm_postamble; \& } .Ve .PP Then put the C, \*(C+ or Fortran files in \f(CW\*(C`./ffi\*(C'\fR for your runtime library and \f(CW\*(C`./t/ffi\*(C'\fR for your test time library. .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a thin layer between FFI::Build and ExtUtils::MakeMaker. Its interface is influenced by the design of Alien::Build::MM. The idea is that for your distribution you throw some C, \*(C+ or Fortran source files into a directory called \f(CW\*(C`ffi\*(C'\fR and these files will be compiled and linked into a library that can be used by your module. There is a control file \f(CW\*(C`ffi/*.fbx\*(C'\fR which can be used to control the compiler and linker options. (options passed directly into FFI::Build). The interface for this file is still under development. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" .Vb 1 \& my $fbmm = FFI::Build::MM\->new; .Ve .PP Create a new instance of FFI::Build::MM. .SH "METHODS" .IX Header "METHODS" .SS "mm_args" .IX Subsection "mm_args" .Vb 1 \& my %new_args = $fbmm\->mm_args(%old_args); .Ve .PP This method does two things: .IP "reads the arguments to determine sensible defaults (library name, install location, etc)." 4 .IX Item "reads the arguments to determine sensible defaults (library name, install location, etc)." .PD 0 .IP "adjusts the arguments as necessary and returns an updated set of arguments." 4 .IX Item "adjusts the arguments as necessary and returns an updated set of arguments." .PD .SS "mm_postamble" .IX Subsection "mm_postamble" .Vb 1 \& my $postamble = $fbmm\->mm_postamble; .Ve .PP This returns the Makefile postamble used by ExtUtils::MakeMaker. The synopsis above for how to invoke it properly. It adds the following Make targets: .IP "fbx_build / ffi" 4 .IX Item "fbx_build / ffi" build the main runtime library in \f(CW\*(C`./ffi\*(C'\fR. .IP "fbx_test / ffi-test" 4 .IX Item "fbx_test / ffi-test" Build the test library in \f(CW\*(C`./t/ffi\*(C'\fR. .IP "fbx_clean / ffi-clean" 4 .IX Item "fbx_clean / ffi-clean" Clean any runtime or test libraries already built. .PP Normally you do not need to build these targets manually, they will be built automatically at the appropriate stage. .SH "AUTHOR" .IX Header "AUTHOR" Author: Graham Ollis .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.