.\" 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 "ExtUtils::Typemaps::Cmd 3perl" .TH ExtUtils::Typemaps::Cmd 3perl "2021-09-24" "perl v5.32.1" "Perl Programmers Reference Guide" .\" 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" ExtUtils::Typemaps::Cmd \- Quick commands for handling typemaps .SH "SYNOPSIS" .IX Header "SYNOPSIS" From \s-1XS:\s0 .PP .Vb 2 \& INCLUDE_COMMAND: $^X \-MExtUtils::Typemaps::Cmd \e \& \-e "print embeddable_typemap(q{Excommunicated})" .Ve .PP Loads \f(CW\*(C`ExtUtils::Typemaps::Excommunicated\*(C'\fR, instantiates an object, and dumps it as an embeddable typemap for use directly in your \s-1XS\s0 file. .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is a helper module for ExtUtils::Typemaps for quick one-liners, specifically for inclusion of shared typemaps that live on \s-1CPAN\s0 into an \s-1XS\s0 file (see \s-1SYNOPSIS\s0). .PP For this reason, the following functions are exported by default: .SH "EXPORTED FUNCTIONS" .IX Header "EXPORTED FUNCTIONS" .SS "embeddable_typemap" .IX Subsection "embeddable_typemap" Given a list of identifiers, \f(CW\*(C`embeddable_typemap\*(C'\fR tries to load typemaps from a file of the given name(s), or from a module that is an \f(CW\*(C`ExtUtils::Typemaps\*(C'\fR subclass. .PP Returns a string representation of the merged typemaps that can be included verbatim into \s-1XS.\s0 Example: .PP .Vb 3 \& print embeddable_typemap( \& "Excommunicated", "ExtUtils::Typemaps::Basic", "./typemap" \& ); .Ve .PP This will try to load a module \f(CW\*(C`ExtUtils::Typemaps::Excommunicated\*(C'\fR and use it as an \f(CW\*(C`ExtUtils::Typemaps\*(C'\fR subclass. If that fails, it'll try loading \f(CW\*(C`Excommunicated\*(C'\fR as a module, if that fails, it'll try to read a file called \fIExcommunicated\fR. It'll work similarly for the second argument, but the third will be loaded as a file first. .PP After loading all typemap files or modules, it will merge them in the specified order and dump the result as an embeddable typemap. .SH "SEE ALSO" .IX Header "SEE ALSO" ExtUtils::Typemaps .PP perlxs .SH "AUTHOR" .IX Header "AUTHOR" Steffen Mueller \f(CW\*(C` .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2012 Steffen Mueller .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.