| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "ExtUtils::Typemaps::Cmd 3perl" |
| 58 |
.TH ExtUtils::Typemaps::Cmd 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
ExtUtils::Typemaps::Cmd \- Quick commands for handling typemaps |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
From XS: |
| 68 |
.PP |
| 69 |
.Vb 2 |
| 70 |
\& INCLUDE_COMMAND: $^X \-MExtUtils::Typemaps::Cmd \e |
| 71 |
\& \-e "print embeddable_typemap(q{Excommunicated})" |
| 72 |
.Ve |
| 73 |
.PP |
| 74 |
Loads \f(CW\*(C`ExtUtils::Typemaps::Excommunicated\*(C'\fR, instantiates an object, |
| 75 |
and dumps it as an embeddable typemap for use directly in your XS file. |
| 76 |
.SH DESCRIPTION |
| 77 |
.IX Header "DESCRIPTION" |
| 78 |
This is a helper module for ExtUtils::Typemaps for quick |
| 79 |
one-liners, specifically for inclusion of shared typemaps |
| 80 |
that live on CPAN into an XS file (see SYNOPSIS). |
| 81 |
.PP |
| 82 |
For this reason, the following functions are exported by default: |
| 83 |
.SH "EXPORTED FUNCTIONS" |
| 84 |
.IX Header "EXPORTED FUNCTIONS" |
| 85 |
.SS embeddable_typemap |
| 86 |
.IX Subsection "embeddable_typemap" |
| 87 |
Given a list of identifiers, \f(CW\*(C`embeddable_typemap\*(C'\fR |
| 88 |
tries to load typemaps from a file of the given name(s), |
| 89 |
or from a module that is an \f(CW\*(C`ExtUtils::Typemaps\*(C'\fR subclass. |
| 90 |
.PP |
| 91 |
Returns a string representation of the merged typemaps that can |
| 92 |
be included verbatim into XS. Example: |
| 93 |
.PP |
| 94 |
.Vb 3 |
| 95 |
\& print embeddable_typemap( |
| 96 |
\& "Excommunicated", "ExtUtils::Typemaps::Basic", "./typemap" |
| 97 |
\& ); |
| 98 |
.Ve |
| 99 |
.PP |
| 100 |
This will try to load a module \f(CW\*(C`ExtUtils::Typemaps::Excommunicated\*(C'\fR |
| 101 |
and use it as an \f(CW\*(C`ExtUtils::Typemaps\*(C'\fR subclass. If that fails, it'll |
| 102 |
try loading \f(CW\*(C`Excommunicated\*(C'\fR as a module, if that fails, it'll try to |
| 103 |
read a file called \fIExcommunicated\fR. It'll work similarly for the |
| 104 |
second argument, but the third will be loaded as a file first. |
| 105 |
.PP |
| 106 |
After loading all typemap files or modules, it will merge them in the |
| 107 |
specified order and dump the result as an embeddable typemap. |
| 108 |
.SH "SEE ALSO" |
| 109 |
.IX Header "SEE ALSO" |
| 110 |
ExtUtils::Typemaps |
| 111 |
.PP |
| 112 |
perlxs |
| 113 |
.SH AUTHOR |
| 114 |
.IX Header "AUTHOR" |
| 115 |
Steffen Mueller \f(CW\*(C`<[email protected]\*(C'\fR> |
| 116 |
.SH "COPYRIGHT & LICENSE" |
| 117 |
.IX Header "COPYRIGHT & LICENSE" |
| 118 |
Copyright 2012 Steffen Mueller |
| 119 |
.PP |
| 120 |
This program is free software; you can redistribute it and/or |
| 121 |
modify it under the same terms as Perl itself. |