ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications - Perldoc Browser</title> <link rel="search" href="/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser"> <link rel="canonical" href="https://perldoc.perl.org/ExtUtils::Embed"> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous"> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" /> <style> body { background: #f4f4f5; color: #020202; } .navbar-dark { background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%); background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%); background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%); filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0); background-repeat: repeat-x; } .navbar-dark .navbar-nav .nav-link, .navbar-dark .navbar-nav .nav-link:focus { color: #fff } .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 } #wrapperlicious { margin: 0 auto; font: 0.9em 'Helvetica Neue', Helvetica, sans-serif; font-weight: normal; line-height: 1.5em; margin: 0; padding: 0; } #wrapperlicious h1 { font-size: 1.5em } #wrapperlicious h2 { font-size: 1.3em } #wrapperlicious h3 { font-size: 1.1em } #wrapperlicious h4 { font-size: 0.9em } #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3, #wrapperlicious h4, #wrapperlicious dt { color: #020202; margin-top: 1em; margin-bottom: 1em; position: relative; font-weight: bold; } #wrapperlicious a { color: inherit; text-decoration: underline } #wrapperlicious #toc { text-decoration: none } #wrapperlicious a:hover { color: #2a2a2a } #wrapperlicious a img { border: 0 } #wrapperlicious :not(pre) > code { color: inherit; background-color: rgba(0, 0, 0, 0.04); border-radius: 3px; font: 0.9em Consolas, Menlo, Monaco, monospace; padding: 0.3em; } #wrapperlicious dd { margin: 0; margin-left: 2em; } #wrapperlicious dt { color: #2a2a2a; font-weight: bold; margin-left: 0.9em; } #wrapperlicious p { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious li > p { margin-bottom: 0; margin-top: 0; } #wrapperlicious pre { border: 1px solid #c1c1c1; border-radius: 3px; font: 100% Consolas, Menlo, Monaco, monospace; margin-bottom: 1em; margin-top: 1em; } #wrapperlicious pre > code { display: block; background-color: #f6f6f6; font: 0.9em Consolas, Menlo, Monaco, monospace; line-height: 1.5em; text-align: left; white-space: pre; padding: 1em; } #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul { margin-bottom: 1em; margin-top: 1em; } #wrapperlicious ul { list-style-type: square; } #wrapperlicious ul ul { margin-bottom: 0px; margin-top: 0px; } #footer { font-size: 0.8em; padding-top: 0.5em; text-align: center; } #more { display: inline; font-size: 0.8em; } #perldocdiv { background-color: #fff; border: 1px solid #c1c1c1; border-bottom-left-radius: 5px; border-bottom-right-radius: 5px; margin-left: auto; margin-right: auto; padding: 3em; padding-top: 1em; max-width: 960px; } #moduleversion { float: right } #wrapperlicious .leading-notice { font-style: italic; padding-left: 1em; margin-top: 1em; margin-bottom: 1em; } #wrapperlicious .permalink { display: none; left: -0.75em; position: absolute; padding-right: 0.25em; text-decoration: none; } #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink, #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink, #wrapperlicious dt:hover .permalink { display: block; } </style>  <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-KVNWBNT5FB'); gtag('config', 'UA-50555-3'); </script> </head> <body> <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between"> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <a class="navbar-brand" href="/"><img src="/images/perl_camel_30.png" width="30" height="30" class="d-inline-block align-top" alt="Perl Camel Logo"> Perldoc Browser</a> <div class="collapse navbar-collapse" id="navbarNav"> <ul class="navbar-nav mr-auto"> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.14.0</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-stable"> <a class="dropdown-item" href="/ExtUtils::Embed">Latest</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1/ExtUtils::Embed">5.40.1</a> <a class="dropdown-item" href="/5.40.0/ExtUtils::Embed">5.40.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3/ExtUtils::Embed">5.38.3</a> <a class="dropdown-item" href="/5.38.2/ExtUtils::Embed">5.38.2</a> <a class="dropdown-item" href="/5.38.1/ExtUtils::Embed">5.38.1</a> <a class="dropdown-item" href="/5.38.0/ExtUtils::Embed">5.38.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.36.3/ExtUtils::Embed">5.36.3</a> <a class="dropdown-item" href="/5.36.2/ExtUtils::Embed">5.36.2</a> <a class="dropdown-item" href="/5.36.1/ExtUtils::Embed">5.36.1</a> <a class="dropdown-item" href="/5.36.0/ExtUtils::Embed">5.36.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.34.3/ExtUtils::Embed">5.34.3</a> <a class="dropdown-item" href="/5.34.2/ExtUtils::Embed">5.34.2</a> <a class="dropdown-item" href="/5.34.1/ExtUtils::Embed">5.34.1</a> <a class="dropdown-item" href="/5.34.0/ExtUtils::Embed">5.34.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.32.1/ExtUtils::Embed">5.32.1</a> <a class="dropdown-item" href="/5.32.0/ExtUtils::Embed">5.32.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.30.3/ExtUtils::Embed">5.30.3</a> <a class="dropdown-item" href="/5.30.2/ExtUtils::Embed">5.30.2</a> <a class="dropdown-item" href="/5.30.1/ExtUtils::Embed">5.30.1</a> <a class="dropdown-item" href="/5.30.0/ExtUtils::Embed">5.30.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.28.3/ExtUtils::Embed">5.28.3</a> <a class="dropdown-item" href="/5.28.2/ExtUtils::Embed">5.28.2</a> <a class="dropdown-item" href="/5.28.1/ExtUtils::Embed">5.28.1</a> <a class="dropdown-item" href="/5.28.0/ExtUtils::Embed">5.28.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.26.3/ExtUtils::Embed">5.26.3</a> <a class="dropdown-item" href="/5.26.2/ExtUtils::Embed">5.26.2</a> <a class="dropdown-item" href="/5.26.1/ExtUtils::Embed">5.26.1</a> <a class="dropdown-item" href="/5.26.0/ExtUtils::Embed">5.26.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.24.4/ExtUtils::Embed">5.24.4</a> <a class="dropdown-item" href="/5.24.3/ExtUtils::Embed">5.24.3</a> <a class="dropdown-item" href="/5.24.2/ExtUtils::Embed">5.24.2</a> <a class="dropdown-item" href="/5.24.1/ExtUtils::Embed">5.24.1</a> <a class="dropdown-item" href="/5.24.0/ExtUtils::Embed">5.24.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.22.4/ExtUtils::Embed">5.22.4</a> <a class="dropdown-item" href="/5.22.3/ExtUtils::Embed">5.22.3</a> <a class="dropdown-item" href="/5.22.2/ExtUtils::Embed">5.22.2</a> <a class="dropdown-item" href="/5.22.1/ExtUtils::Embed">5.22.1</a> <a class="dropdown-item" href="/5.22.0/ExtUtils::Embed">5.22.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.20.3/ExtUtils::Embed">5.20.3</a> <a class="dropdown-item" href="/5.20.2/ExtUtils::Embed">5.20.2</a> <a class="dropdown-item" href="/5.20.1/ExtUtils::Embed">5.20.1</a> <a class="dropdown-item" href="/5.20.0/ExtUtils::Embed">5.20.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.18.4/ExtUtils::Embed">5.18.4</a> <a class="dropdown-item" href="/5.18.3/ExtUtils::Embed">5.18.3</a> <a class="dropdown-item" href="/5.18.2/ExtUtils::Embed">5.18.2</a> <a class="dropdown-item" href="/5.18.1/ExtUtils::Embed">5.18.1</a> <a class="dropdown-item" href="/5.18.0/ExtUtils::Embed">5.18.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.16.3/ExtUtils::Embed">5.16.3</a> <a class="dropdown-item" href="/5.16.2/ExtUtils::Embed">5.16.2</a> <a class="dropdown-item" href="/5.16.1/ExtUtils::Embed">5.16.1</a> <a class="dropdown-item" href="/5.16.0/ExtUtils::Embed">5.16.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.4/ExtUtils::Embed">5.14.4</a> <a class="dropdown-item" href="/5.14.3/ExtUtils::Embed">5.14.3</a> <a class="dropdown-item" href="/5.14.2/ExtUtils::Embed">5.14.2</a> <a class="dropdown-item" href="/5.14.1/ExtUtils::Embed">5.14.1</a> <a class="dropdown-item active" href="/5.14.0/ExtUtils::Embed">5.14.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.12.5/ExtUtils::Embed">5.12.5</a> <a class="dropdown-item" href="/5.12.4/ExtUtils::Embed">5.12.4</a> <a class="dropdown-item" href="/5.12.3/ExtUtils::Embed">5.12.3</a> <a class="dropdown-item" href="/5.12.2/ExtUtils::Embed">5.12.2</a> <a class="dropdown-item" href="/5.12.1/ExtUtils::Embed">5.12.1</a> <a class="dropdown-item" href="/5.12.0/ExtUtils::Embed">5.12.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.10.1/ExtUtils::Embed">5.10.1</a> <a class="dropdown-item" href="/5.10.0/ExtUtils::Embed">5.10.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.8.9/ExtUtils::Embed">5.8.9</a> <a class="dropdown-item" href="/5.8.8/ExtUtils::Embed">5.8.8</a> <a class="dropdown-item" href="/5.8.7/ExtUtils::Embed">5.8.7</a> <a class="dropdown-item" href="/5.8.6/ExtUtils::Embed">5.8.6</a> <a class="dropdown-item" href="/5.8.5/ExtUtils::Embed">5.8.5</a> <a class="dropdown-item" href="/5.8.4/ExtUtils::Embed">5.8.4</a> <a class="dropdown-item" href="/5.8.3/ExtUtils::Embed">5.8.3</a> <a class="dropdown-item" href="/5.8.2/ExtUtils::Embed">5.8.2</a> <a class="dropdown-item" href="/5.8.1/ExtUtils::Embed">5.8.1</a> <a class="dropdown-item" href="/5.8.0/ExtUtils::Embed">5.8.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.6.2/ExtUtils::Embed">5.6.2</a> <a class="dropdown-item" href="/5.6.1/ExtUtils::Embed">5.6.1</a> <a class="dropdown-item" href="/5.6.0/ExtUtils::Embed">5.6.0</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.005_04/ExtUtils::Embed">5.005_04</a> <a class="dropdown-item" href="/5.005_03/ExtUtils::Embed">5.005_03</a> <a class="dropdown-item" href="/5.005_02/ExtUtils::Embed">5.005_02</a> <a class="dropdown-item" href="/5.005_01/ExtUtils::Embed">5.005_01</a> <a class="dropdown-item" href="/5.005/ExtUtils::Embed">5.005</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-dev"> <a class="dropdown-item" href="/blead/ExtUtils::Embed">blead</a> <a class="dropdown-item" href="/5.41.10/ExtUtils::Embed">5.41.10</a> <a class="dropdown-item" href="/5.41.9/ExtUtils::Embed">5.41.9</a> <a class="dropdown-item" href="/5.41.8/ExtUtils::Embed">5.41.8</a> <a class="dropdown-item" href="/5.41.7/ExtUtils::Embed">5.41.7</a> <a class="dropdown-item" href="/5.41.6/ExtUtils::Embed">5.41.6</a> <a class="dropdown-item" href="/5.41.5/ExtUtils::Embed">5.41.5</a> <a class="dropdown-item" href="/5.41.4/ExtUtils::Embed">5.41.4</a> <a class="dropdown-item" href="/5.41.3/ExtUtils::Embed">5.41.3</a> <a class="dropdown-item" href="/5.41.2/ExtUtils::Embed">5.41.2</a> <a class="dropdown-item" href="/5.41.1/ExtUtils::Embed">5.41.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.40.1-RC1/ExtUtils::Embed">5.40.1-RC1</a> <a class="dropdown-item" href="/5.40.0-RC2/ExtUtils::Embed">5.40.0-RC2</a> <a class="dropdown-item" href="/5.40.0-RC1/ExtUtils::Embed">5.40.0-RC1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.39.10/ExtUtils::Embed">5.39.10</a> <a class="dropdown-item" href="/5.39.9/ExtUtils::Embed">5.39.9</a> <a class="dropdown-item" href="/5.39.8/ExtUtils::Embed">5.39.8</a> <a class="dropdown-item" href="/5.39.7/ExtUtils::Embed">5.39.7</a> <a class="dropdown-item" href="/5.39.6/ExtUtils::Embed">5.39.6</a> <a class="dropdown-item" href="/5.39.5/ExtUtils::Embed">5.39.5</a> <a class="dropdown-item" href="/5.39.4/ExtUtils::Embed">5.39.4</a> <a class="dropdown-item" href="/5.39.3/ExtUtils::Embed">5.39.3</a> <a class="dropdown-item" href="/5.39.2/ExtUtils::Embed">5.39.2</a> <a class="dropdown-item" href="/5.39.1/ExtUtils::Embed">5.39.1</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.38.3-RC1/ExtUtils::Embed">5.38.3-RC1</a> </div> </li> <li class="nav-item dropdown text-nowrap"> <a class="nav-link dropdown-toggle" href="#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a> <div class="dropdown-menu" aria-labelledby="dropdownlink-nav"> <a class="dropdown-item" href="/5.14.0/perl">Perl</a> <a class="dropdown-item" href="/5.14.0/perlintro">Intro</a> <a class="dropdown-item" href="/5.14.0/perl#Tutorials">Tutorials</a> <a class="dropdown-item" href="/5.14.0/perlfaq">FAQs</a> <a class="dropdown-item" href="/5.14.0/perl#Reference-Manual">Reference</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.0/perlop">Operators</a> <a class="dropdown-item" href="/5.14.0/functions">Functions</a> <a class="dropdown-item" href="/5.14.0/variables">Variables</a> <a class="dropdown-item" href="/5.14.0/modules">Modules</a> <a class="dropdown-item" href="/5.14.0/perlutil">Utilities</a> <div class="dropdown-divider"></div> <a class="dropdown-item" href="/5.14.0/perldelta">Release Notes</a> <a class="dropdown-item" href="/5.14.0/perlcommunity">Community</a> <a class="dropdown-item" href="/5.14.0/perlhist">History</a> </div> </li> </ul> <ul class="navbar-nav"> <script> function set_expand (expand) { var perldocdiv = document.getElementById('perldocdiv'); var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width'); var expanded = (width == '' || width == 'none') ? true : false; if (expand === null) { expand = !expanded; } if ((expand && !expanded) || (!expand && expanded)) { perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px'); var button_classlist = document.getElementById('content-expand-button').classList; if (expand) { button_classlist.add('btn-light'); button_classlist.remove('btn-outline-light'); } else { button_classlist.add('btn-outline-light'); button_classlist.remove('btn-light'); } } return expand; } function toggle_expand () { var expand = set_expand(null); document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC'; } function read_expand () { return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 }); } if (document.readyState === 'loading') { document.addEventListener('DOMContentLoaded', function () { if (read_expand()) { set_expand(true); } }); } else if (read_expand()) { set_expand(true); } </script> <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-4" onclick="toggle_expand()">Expand</button> </ul> <form class="form-inline" method="get" action="/5.14.0/search"> <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search" value=""> </form> </div> </nav> <div id="wrapperlicious" class="container-fluid"> <div id="perldocdiv"> <div id="links"> <a href="/5.14.0/ExtUtils::Embed">ExtUtils::Embed</a> <div id="more"> (<a href="/5.14.0/ExtUtils::Embed.txt">source</a>, <a href="https://metacpan.org/pod/ExtUtils::Embed">CPAN</a>) </div> <div id="moduleversion">version 1.30</div> </div> <div class="leading-notice"> You are viewing the version of this documentation from Perl 5.14.0. <a href="/ExtUtils::Embed">View the latest version</a> </div> <h1><a id="toc">CONTENTS</a></h1> <ul> <li> <a class="text-decoration-none" href="#NAME">NAME</a> </li> <li> <a class="text-decoration-none" href="#SYNOPSIS">SYNOPSIS</a> </li> <li> <a class="text-decoration-none" href="#DESCRIPTION">DESCRIPTION</a> </li> <li> <a class="text-decoration-none" href="#@EXPORT">@EXPORT</a> </li> <li> <a class="text-decoration-none" href="#FUNCTIONS">FUNCTIONS</a> </li> <li> <a class="text-decoration-none" href="#EXAMPLES">EXAMPLES</a> </li> <li> <a class="text-decoration-none" href="#SEE-ALSO">SEE ALSO</a> </li> <li> <a class="text-decoration-none" href="#AUTHOR">AUTHOR</a> </li> </ul> <h1 id="NAME"><a class="permalink" href="#NAME">#</a>NAME</h1> <p>ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications</p> <h1 id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">#</a>SYNOPSIS</h1> <pre><code class="plaintext">perl -MExtUtils::Embed -e xsinit perl -MExtUtils::Embed -e ccopts perl -MExtUtils::Embed -e ldopts </code></pre> <h1 id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">#</a>DESCRIPTION</h1> <p>ExtUtils::Embed provides utility functions for embedding a Perl interpreter and extensions in your C/C++ applications. Typically, an application <b>Makefile</b> will invoke ExtUtils::Embed functions while building your application.</p> <h1 id="@EXPORT"><a class="permalink" href="#@EXPORT">#</a><a id="EXPORT"></a>@EXPORT</h1> <p>ExtUtils::Embed exports the following functions:</p> <p>xsinit(), ldopts(), ccopts(), perl_inc(), ccflags(), ccdlflags(), xsi_header(), xsi_protos(), xsi_body()</p> <h1 id="FUNCTIONS"><a class="permalink" href="#FUNCTIONS">#</a>FUNCTIONS</h1> <dl> <dt id="xsinit()"><a class="permalink" href="#xsinit()">#</a><a id="xsinit"></a>xsinit()</dt> <dd> <p>Generate C/C++ code for the XS initializer function.</p> <p>When invoked as <code>`perl -MExtUtils::Embed -e xsinit --`</code> the following options are recognized:</p> <p><b>-o</b> <output filename> (Defaults to <b>perlxsi.c</b>)</p> <p><b>-o STDOUT</b> will print to STDOUT.</p> <p><b>-std</b> (Write code for extensions that are linked with the current Perl.)</p> <p>Any additional arguments are expected to be names of modules to generate code for.</p> <p>When invoked with parameters the following are accepted and optional:</p> <p><code>xsinit($filename,$std,[@modules])</code></p> <p>Where,</p> <p><b>$filename</b> is equivalent to the <b>-o</b> option.</p> <p><b>$std</b> is boolean, equivalent to the <b>-std</b> option.</p> <p><b>[@modules]</b> is an array ref, same as additional arguments mentioned above.</p> </dd> <dt id="Examples"><a class="permalink" href="#Examples">#</a>Examples</dt> <dd> <pre><code class="plaintext">perl -MExtUtils::Embed -e xsinit -- -o xsinit.c Socket</code></pre> <p>This will generate code with an <b>xs_init</b> function that glues the perl <b>Socket::bootstrap</b> function to the C <b>boot_Socket</b> function and writes it to a file named <i>xsinit.c</i>.</p> <p>Note that <b>DynaLoader</b> is a special case where it must call <b>boot_DynaLoader</b> directly.</p> <pre><code class="plaintext">perl -MExtUtils::Embed -e xsinit</code></pre> <p>This will generate code for linking with <b>DynaLoader</b> and each static extension found in <b>$Config{static_ext}</b>. The code is written to the default file name <b>perlxsi.c</b>.</p> <pre><code class="plaintext">perl -MExtUtils::Embed -e xsinit -- -o xsinit.c -std DBI DBD::Oracle</code></pre> <p>Here, code is written for all the currently linked extensions along with code for <b>DBI</b> and <b>DBD::Oracle</b>.</p> <p>If you have a working <b>DynaLoader</b> then there is rarely any need to statically link in any other extensions.</p> </dd> <dt id="ldopts()"><a class="permalink" href="#ldopts()">#</a><a id="ldopts"></a>ldopts()</dt> <dd> <p>Output arguments for linking the Perl library and extensions to your application.</p> <p>When invoked as <code>`perl -MExtUtils::Embed -e ldopts --`</code> the following options are recognized:</p> <p><b>-std</b></p> <p>Output arguments for linking the Perl library and any extensions linked with the current Perl.</p> <p><b>-I</b> <path1:path2></p> <p>Search path for ModuleName.a archives. Default path is <b>@INC</b>. Library archives are expected to be found as <b>/some/path/auto/ModuleName/ModuleName.a</b> For example, when looking for <b>Socket.a</b> relative to a search path, we should find <b>auto/Socket/Socket.a</b></p> <p>When looking for <b>DBD::Oracle</b> relative to a search path, we should find <b>auto/DBD/Oracle/Oracle.a</b></p> <p>Keep in mind that you can always supply <b>/my/own/path/ModuleName.a</b> as an additional linker argument.</p> <p><b>--</b> <list of linker args></p> <p>Additional linker arguments to be considered.</p> <p>Any additional arguments found before the <b>--</b> token are expected to be names of modules to generate code for.</p> <p>When invoked with parameters the following are accepted and optional:</p> <p><code>ldopts($std,[@modules],[@link_args],$path)</code></p> <p>Where:</p> <p><b>$std</b> is boolean, equivalent to the <b>-std</b> option.</p> <p><b>[@modules]</b> is equivalent to additional arguments found before the <b>--</b> token.</p> <p><b>[@link_args]</b> is equivalent to arguments found after the <b>--</b> token.</p> <p><b>$path</b> is equivalent to the <b>-I</b> option.</p> <p>In addition, when ldopts is called with parameters, it will return the argument string rather than print it to STDOUT.</p> </dd> <dt id="Examples1"><a class="permalink" href="#Examples1">#</a>Examples</dt> <dd> <pre><code class="plaintext">perl -MExtUtils::Embed -e ldopts</code></pre> <p>This will print arguments for linking with <b>libperl</b> and extensions found in <b>$Config{static_ext}</b>. This includes libraries found in <b>$Config{libs}</b> and the first ModuleName.a library for each extension that is found by searching <b>@INC</b> or the path specified by the <b>-I</b> option. In addition, when ModuleName.a is found, additional linker arguments are picked up from the <b>extralibs.ld</b> file in the same directory.</p> <pre><code class="plaintext">perl -MExtUtils::Embed -e ldopts -- -std Socket</code></pre> <p>This will do the same as the above example, along with printing additional arguments for linking with the <b>Socket</b> extension.</p> <pre><code class="plaintext">perl -MExtUtils::Embed -e ldopts -- -std Msql -- -L/usr/msql/lib -lmsql</code></pre> <p>Any arguments after the second '--' token are additional linker arguments that will be examined for potential conflict. If there is no conflict, the additional arguments will be part of the output.</p> </dd> <dt id="perl_inc()"><a class="permalink" href="#perl_inc()">#</a><a id="perl_inc"></a>perl_inc()</dt> <dd> <p>For including perl header files this function simply prints:</p> <pre><code>-I$Config{archlibexp}/CORE </code></pre> <p>So, rather than having to say:</p> <pre><code>perl -MConfig -e 'print "-I$Config{archlibexp}/CORE"'</code></pre> <p>Just say:</p> <pre><code class="plaintext">perl -MExtUtils::Embed -e perl_inc</code></pre> </dd> <dt id="ccflags(),-ccdlflags()"><a class="permalink" href="#ccflags(),-ccdlflags()">#</a><a id="ccflags"></a><a id="ccflags-ccdlflags"></a>ccflags(), ccdlflags()</dt> <dd> <p>These functions simply print $Config{ccflags} and $Config{ccdlflags}</p> </dd> <dt id="ccopts()"><a class="permalink" href="#ccopts()">#</a><a id="ccopts"></a>ccopts()</dt> <dd> <p>This function combines perl_inc(), ccflags() and ccdlflags() into one.</p> </dd> <dt id="xsi_header()"><a class="permalink" href="#xsi_header()">#</a><a id="xsi_header"></a>xsi_header()</dt> <dd> <p>This function simply returns a string defining the same <b>EXTERN_C</b> macro as <b>perlmain.c</b> along with #including <b>perl.h</b> and <b>EXTERN.h</b>.</p> </dd> <dt id="xsi_protos(@modules)"><a class="permalink" href="#xsi_protos(@modules)">#</a><a id="xsi_protos"></a><a id="xsi_protos-modules"></a>xsi_protos(@modules)</dt> <dd> <p>This function returns a string of <b>boot_$ModuleName</b> prototypes for each @modules.</p> </dd> <dt id="xsi_body(@modules)"><a class="permalink" href="#xsi_body(@modules)">#</a><a id="xsi_body"></a><a id="xsi_body-modules"></a>xsi_body(@modules)</dt> <dd> <p>This function returns a string of calls to <b>newXS()</b> that glue the module <b>bootstrap</b> function to <b>boot_ModuleName</b> for each @modules.</p> <p><b>xsinit()</b> uses the xsi_* functions to generate most of its code.</p> </dd> </dl> <h1 id="EXAMPLES"><a class="permalink" href="#EXAMPLES">#</a>EXAMPLES</h1> <p>For examples on how to use <b>ExtUtils::Embed</b> for building C/C++ applications with embedded perl, see <a href="/5.14.0/perlembed">perlembed</a>.</p> <h1 id="SEE-ALSO"><a class="permalink" href="#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1> <p><a href="/5.14.0/perlembed">perlembed</a></p> <h1 id="AUTHOR"><a class="permalink" href="#AUTHOR">#</a>AUTHOR</h1> <p>Doug MacEachern <<i>dougm@osf.org</i>></p> <p>Based on ideas from Tim Bunce <<i>Tim.Bunce@ig.co.uk</i>> and <b>minimod.pl</b> by Andreas Koenig <<i>k@anna.in-berlin.de</i>> and Tim Bunce.</p> </div> <div id="footer"> <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p> <p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p> </div> </div> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script> <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script> <script src="/js/highlight.pack.js"></script> <script>hljs.highlightAll();</script> </body> </html>

CINXE.COM

ExtUtils::Embed - Utilities for embedding Perl in C/C++ applications - Perldoc Browser