.\" 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 "Filter::EOF 3pm"
.TH Filter::EOF 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"
Filter::EOF \- Run a callback after a file has been compiled
.SH "VERSION"
.IX Header "VERSION"
0.04
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  package MyPackage;
\&  use warnings;
\&  use strict;
\&
\&  use Filter::EOF;
\&
\&  sub import {
\&      my ($class, @args) = @_;
\&      my $caller = scalar caller;
\&
\&      # set the COMPILE_TIME package var to a false value
\&      # when the file was compiled
\&      Filter::EOF\->on_eof_call(sub {
\&          no strict \*(Aqrefs\*(Aq;
\&          ${ $caller . \*(Aq::COMPILE_TIME\*(Aq } = 0;
\&      });
\&
\&      # set the COMPILE_TIME package var to a true value when
\&      # we start compiling it.
\&      {   no strict \*(Aqrefs\*(Aq;
\&          ${ $caller . \*(Aq::COMPILE_TIME\*(Aq } = 1;
\&      }
\&  }
\&
\&  1;
\&  ...
\&
\&  package MyUsingPackage;
\&  use warnings;
\&  use strict;
\&
\&  our $COMPILE_TIME;
\&  use MyPackage;
\&
\&  # prints \*(Aqyes\*(Aq
\&  BEGIN { print +( $COMPILE_TIME ? \*(Aqyes\*(Aq : \*(Aqno\*(Aq ), "\en" }
\&
\&  # prints \*(Aqno\*(Aq
\&  print +( $COMPILE_TIME ? \*(Aqyes\*(Aq : \*(Aqno\*(Aq ), "\en";
\&
\&  1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module utilises Perl's source filters to provide you with a
mechanism to run some code after a file using your module has been
processed.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """import( @functions )"""
.el .SS "\f(CWimport( @functions )\fP"
.IX Subsection "import( @functions )"
Currently, only a function equivalent of the \f(CW\*(C`on_eof_call\*(C'\fR method
is provided for export.
.PP
.Vb 1
\&  use Filter::EOF qw( on_eof_call );
\&
\&  sub import {
\&      my ($class) = @_;
\&      ...
\&      on_eof_call { ... };
\&  }
\&  ...
.Ve
.ie n .SS """on_eof_call( $code_ref )"""
.el .SS "\f(CWon_eof_call( $code_ref )\fP"
.IX Subsection "on_eof_call( $code_ref )"
Call this method in your own \f(CW\*(C`import\*(C'\fR method to register a code 
reference that should be called when the file \f(CW\*(C`use\*(C'\fRing yours was
compiled.
.PP
The code reference will get a scalar reference as first argument
to an empty string. if you change this string to something else,
it will be appended at the end of the source.
.PP
.Vb 5
\&  # call C<some_function()> after runtime.
\&  Filter\->on_eof_call(sub { 
\&      my $append = shift;
\&      $$append .= \*(Aq; some_function(); 1;\*(Aq;
\&  });
.Ve
.SH "EXPORTS"
.IX Header "EXPORTS"
.SS "on_eof_call"
.IX Subsection "on_eof_call"
You can optionally import the \f(CW\*(C`on_eof_call\*(C'\fR function into your namespace.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
You can find the example mentioned in \*(L"\s-1SYNOPSIS\*(R"\s0 in the distribution
directory \f(CW\*(C`examples/synopsis/\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Filter::Call::Util,
\&\*(L"Exporting without using Exporter's import method\*(R" in Exporter
.SH "AUTHOR AND COPYRIGHT"
.IX Header "AUTHOR AND COPYRIGHT"
Robert 'phaylon' Sedlacek \- \f(CW\*(C`<rs@474.at>\*(C'\fR. Many thanks to
Matt S Trout for the idea and inspirations on this module.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify
it under the same terms as perl itself.