.\" -*- 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 "Future::AsyncAwait::ExtensionBuilder 3pm" .TH Future::AsyncAwait::ExtensionBuilder 3pm 2024-03-07 "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 "Future::AsyncAwait::ExtensionBuilder" \- build\-time support for extensions to "Future::AsyncAwait" .SH SYNOPSIS .IX Header "SYNOPSIS" In \fIBuild.PL\fR: .PP .Vb 1 \& use Future::AsyncAwait::ExtensionBuilder; \& \& my $build = Module::Build\->new( \& ..., \& configure_requires => { \& ... \& \*(AqFuture::AsyncAwait::ExtensionBuilder\*(Aq => 0, \& } \& ); \& \& Future::AsyncAwait::ExtensionBuilder\->extend_module_build( $build ); \& \& ... .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" This module provides a build-time helper to assist authors writing XS modules that provide extensions to Future::AsyncAwait. It prepares a Module::Build\-using distribution to be able to make use of the \&\f(CW\*(C`Future::AsyncAwait\*(C'\fR extension API. .SH FUNCTIONS .IX Header "FUNCTIONS" .SS write_AsyncAwait_h .IX Subsection "write_AsyncAwait_h" .Vb 1 \& Future::AsyncAwait::ExtensionBuilder\->write_AsyncAwait_h .Ve .PP Writes the \fIAsyncAwait.h\fR file to the current working directory. To cause the compiler to actually find this file, see "extra_compiler_flags". .SS extra_compiler_flags .IX Subsection "extra_compiler_flags" .Vb 1 \& @flags = Future::AsyncAwait::ExtensionBuilder\->extra_compiler_flags .Ve .PP Returns a list of extra flags that the build scripts should add to the compiler invocation. This enables the C compiler to find the \&\fIAsyncAwait.h\fR file. .SS extend_module_build .IX Subsection "extend_module_build" .Vb 1 \& Future::AsyncAwait::ExtensionBuilder\->extend_module_build( $build ) .Ve .PP A convenient shortcut for performing all the tasks necessary to make a Module::Build\-based distribution use the helper. .SH AUTHOR .IX Header "AUTHOR" Paul Evans