/ 
Filter-Macro-0.10
River stage zero No dependents
/ Filter::Macro

NAME

Filter::Macro - Make macro modules that are expanded inline

VERSION

This document describes version 0.10 of Filter::Macro, released May 5, 2006.

SYNOPSIS

In MyHandyModules.pm:

package MyHandyModules;
use Filter::Macro;
# lines below will be expanded into caller's code
use strict;
use warnings;
use Switch;
use IO::All;
use Quantum::Superpositions;

In your program or module:

use MyHandyModules; # lines above are expanded here

DESCRIPTION

If many of your programs begin with the same lines, it may make sense to abstract them away into a module, and use that module instead.

Sadly, it does not work that way, because by default, all lexical pragmas, source filters and subroutine imports invoked in MyHandyModules.pm takes effect in that module, not the calling programs.

One way to solve this problem is to use Filter::Include:

use Filter::Include;
include MyHandyModules;

However, it would be really nice if MyHandyModules.pm could define the macro-like semantic itself, instead of placing the burden on the caller.

This module lets you do precisely that. All you need to do is to put one line in MyHandyModules.pm, after the package MyHandyModules; line:

use Filter::Macro;

With this, a program or module that says use Filter::Macro will expand lines below use Filter::Macro into their own code, instead of the default semantic of evaluating them in the MyHandyModules package.

Line numbers in error and warning messages are unaffected by this module; they still point to the correct file name and line numbers.

SEE ALSO

Filter::Include, Filter::Simple::Cached

AUTHORS

Audrey Tang <cpan@audreyt.org>

Based on Damian Conway's concept, covered in his excellent Sufficiently Advanced Technologies talk.

COPYRIGHT (The "MIT" License)

Copyright 2004, 2006 by Audrey Tang <cpan@audreyt.org>.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is fur- nished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FIT- NESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.