.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Perl6::Export 3pm"
.TH Perl6::Export 3pm "2022-10-13" "perl v5.34.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"
Perl6::Export \- Implements the Perl 6 'is export(...)' trait
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    # Perl 5 code...
\&
\&    package Some::Module;
\&    use Perl6::Export;
\&
\&    # Export &foo by default, when explicitly requested,
\&    # or when the \*(Aq:ALL\*(Aq export set is requested...
\&
\&    sub foo is export(:DEFAULT) {
\&        print "phooo!";
\&    }
\&
\&
\&    # Export &bar by default, when explicitly requested,
\&    # or when the \*(Aq:bees\*(Aq, \*(Aq:pubs\*(Aq, or \*(Aq:ALL\*(Aq export set is requested...
\&    # the parens after \*(Aqis export\*(Aq are like the parens of a qw(...)
\&
\&    sub bar is export(:DEFAULT :bees :pubs) {
\&        print "baaa!";
\&    }
\&
\&
\&    # Export &baz when explicitly requested
\&    # or when the \*(Aq:bees\*(Aq or \*(Aq:ALL\*(Aq export set is requested...
\&
\&    sub baz is export(:bees) {
\&        print "baassss!";
\&    }
\&
\&
\&    # Always export &qux 
\&    # (no matter what else is explicitly or implicitly requested)
\&
\&    sub qux is export(:MANDATORY) {
\&        print "quuuuuuuuux!";
\&    }
\&
\&
\&    IMPORT {
\&        # This block is called when the module is used (as usual),
\&        # but it is called after any export requests have been handled.
\&        # Those requests will have been stripped from its @_ argument list
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Implements what I hope the Perl 6 symbol export mechanism might look like.
.PP
It's very straightforward:
.IP "\(bu" 4
If you want a subroutine to be capable of being exported (when
explicitly requested in the \f(CW\*(C`use\*(C'\fR arguments), you mark it
with the \f(CW\*(C`is export\*(C'\fR trait.
.IP "\(bu" 4
If you want a subroutine to be automatically exported when the module is
used (without specific overriding arguments), you mark it with
the \f(CW\*(C`is export(:DEFAULT)\*(C'\fR trait.
.IP "\(bu" 4
If you want a subroutine to be automatically exported when the module is
used (even if the user specifies overriding arguments), you mark it with
the \f(CW\*(C`is export(:MANDATORY)\*(C'\fR trait.
.IP "\(bu" 4
If the subroutine should also be exported when particular export groups
are requested, you add the names of those export groups to the trait's
argument list.
.PP
That's it.
.ie n .SS """IMPORT"" blocks"
.el .SS "\f(CWIMPORT\fP blocks"
.IX Subsection "IMPORT blocks"
Perl 6 replaces the \f(CW\*(C`import\*(C'\fR subroutine with an \f(CW\*(C`IMPORT\*(C'\fR block. It's
analogous to a \f(CW\*(C`BEGIN\*(C'\fR or \f(CW\*(C`END\*(C'\fR block, except that it's executed every
time the corresponding module is \f(CW\*(C`use\*(C'\fR'd.
.PP
Perl6::Export honours either the Perl5\-ish:
.PP
.Vb 1
\&    sub import {...}
.Ve
.PP
or the equivalent Perl6\-ish:
.PP
.Vb 1
\&    IMPORT {...}
.Ve
.PP
In either case the subroutine/block is passed the argument list that was
specified on the \f(CW\*(C`use\*(C'\fR line that loaded the corresponding module. However,
any export specifications (names of subroutines or tagsets to be exported)
will have already been removed from that argument list before
\&\f(CW\*(C`import\*(C'\fR/\f(CW\*(C`IMPORT\*(C'\fR receives it.
.SH "WARNING"
.IX Header "WARNING"
The syntax and semantics of Perl 6 is still being finalized
and consequently is at any time subject to change. That means the
same caveat applies to this module.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Requires Filter::Simple
.SH "AUTHOR"
.IX Header "AUTHOR"
Damian Conway (damian@conway.org)
.SH "BUGS AND IRRITATIONS"
.IX Header "BUGS AND IRRITATIONS"
Does not yet handle the export of variables. 
The author personally believes this is a feature, rather than a bug.
.PP
Comments, suggestions, and patches welcome.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 3
\& Copyright (c) 2003, Damian Conway. All Rights Reserved.
\& This module is free software. It may be used, redistributed
\&    and/or modified under the same terms as Perl itself.
.Ve