Toolkit (3pm)

This document describes Toolkit version 0.0.2

    use Toolkit;

    # All your favorites are now available

The Toolkit module provides a standard location to store modules that you use all the time, and then loads them for you automatically. For example, instead of always writing:

use strict; use warnings; use Carp; use Smart::Comments;

in every program/module, you can just write:

use Toolkit;

and put all your favorite modules in a file:

> cat $PERL5LIB/Toolkit/Macros/ALWAYS/Modules

use strict; use warnings; use Carp; use Smart::Comments;

You can also specify load-on-demand subroutines:

> cat $PERL5LIB/Toolkit/Runtime/prompt

use IO::Prompt qw( prompt );

> cat $PERL5LIB/Toolkit/Runtime/say

sub say { print @_, "\n" }

in which case Toolkit will install an \*(C`AUTOLOAD\*(C' that installs these subroutines the first time they're called.

Calling:

use Toolkit;

with no arguments loads any files in the directories:

$PERL5LIB/Toolkit/Macros/ALWAYS/ $PERL5LIB/Toolkit/Macros/DEFAULT/

or any of their subdirectories.

Calling:

use Toolkit qw(foo bar);

any files in the directories:

$PERL5LIB/Toolkit/Macros/ALWAYS/ $PERL5LIB/Toolkit/Macros/foo/ $PERL5LIB/Toolkit/Macros/bar/

or any of their subdirectories.

Using the Toolkit module in any way also installs an \*(C`AUTOLOAD\*(C' subroutine which looks in:

$PERL5LIB/Toolkit/Runtime/

for a file of the same name as the subroutine that is being autoloaded. That is, if you write:

use Toolkit;

baz();

Then the module looks for a file:

$PERL5LIB/Toolkit/Runtime/baz

and executes it in a special namespace. After the file executes, Toolkit expects that the special namespace will now have a subroutine of the required name, which it then calls.

You specified a particular macro for Toolkit to load, but it wasn't able to read the corresponding file. Usually a file permissions problem or a non-existent macro. You used a subroutine that Toolkit couldn't autoload. Did you misspell the subroutine name, or fail to install a file of the same name in your \*(C`$PERL5LIB/Toolkit/Runtime/\*(C' subdirectory. You used a subroutine that Toolkit tried to autoload. It found the corresponding file in the \*(C`$PERL5LIB/Toolkit/Runtime/\*(C' subdirectory, but executing that file didn't produce a subroutine of the correct name.

Toolkit uses the following directories and files to configure its behaviour: Files in this directory are prepended to your source code whenever Toolkit is used Files in this directory are prepended to your source code whenever Toolkit is used without arguments These files are prepended to your source code whenever Toolkit is used and their name is specified after the \*(C`use Toolkit\*(C'. Files in this directory are executed to whenever Toolkit is used and a subroutine of the same name is called. They are expected to define the required subroutine.

Requires:

• File::Spec::Functions

• Filter::Simple

• version

None reported.

No bugs have been reported.

Please report any bugs or feature requests to \*(C`[email protected]\*(C', or through the web interface at <http://rt.cpan.org>.

Damian Conway \*(C`<[email protected]>\*(C'

Copyright (c) 2005, Damian Conway \*(C`<[email protected]>\*(C'. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

\s-1BECAUSE\s0 \s-1THIS\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1LICENSED\s0 \s-1FREE\s0 \s-1OF\s0 \s-1CHARGE\s0, \s-1THERE\s0 \s-1IS\s0 \s-1NO\s0 \s-1WARRANTY\s0 \s-1FOR\s0 \s-1THE\s0 \s-1SOFTWARE\s0, \s-1TO\s0 \s-1THE\s0 \s-1EXTENT\s0 \s-1PERMITTED\s0 \s-1BY\s0 \s-1APPLICABLE\s0 \s-1LAW\s0. \s-1EXCEPT\s0 \s-1WHEN\s0 \s-1OTHERWISE\s0 \s-1STATED\s0 \s-1IN\s0 \s-1WRITING\s0 \s-1THE\s0 \s-1COPYRIGHT\s0 \s-1HOLDERS\s0 \s-1AND/OR\s0 \s-1OTHER\s0 \s-1PARTIES\s0 \s-1PROVIDE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R" \s-1WITHOUT\s0 \s-1WARRANTY\s0 \s-1OF\s0 \s-1ANY\s0 \s-1KIND\s0, \s-1EITHER\s0 \s-1EXPRESSED\s0 \s-1OR\s0 \s-1IMPLIED\s0, \s-1INCLUDING\s0, \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0, \s-1THE\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0 \s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. \s-1THE\s0 \s-1ENTIRE\s0 \s-1RISK\s0 \s-1AS\s0 \s-1TO\s0 \s-1THE\s0 \s-1QUALITY\s0 \s-1AND\s0 \s-1PERFORMANCE\s0 \s-1OF\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1WITH\s0 \s-1YOU\s0. \s-1SHOULD\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1PROVE\s0 \s-1DEFECTIVE\s0, \s-1YOU\s0 \s-1ASSUME\s0 \s-1THE\s0 \s-1COST\s0 \s-1OF\s0 \s-1ALL\s0 \s-1NECESSARY\s0 \s-1SERVICING\s0, \s-1REPAIR\s0, \s-1OR\s0 \s-1CORRECTION\s0.

\s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1UNLESS\s0 \s-1REQUIRED\s0 \s-1BY\s0 \s-1APPLICABLE\s0 \s-1LAW\s0 \s-1OR\s0 \s-1AGREED\s0 \s-1TO\s0 \s-1IN\s0 \s-1WRITING\s0 \s-1WILL\s0 \s-1ANY\s0 \s-1COPYRIGHT\s0 \s-1HOLDER\s0, \s-1OR\s0 \s-1ANY\s0 \s-1OTHER\s0 \s-1PARTY\s0 \s-1WHO\s0 \s-1MAY\s0 \s-1MODIFY\s0 \s-1AND/OR\s0 \s-1REDISTRIBUTE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1AS\s0 \s-1PERMITTED\s0 \s-1BY\s0 \s-1THE\s0 \s-1ABOVE\s0 \s-1LICENCE\s0, \s-1BE\s0 \s-1LIABLE\s0 \s-1TO\s0 \s-1YOU\s0 \s-1FOR\s0 \s-1DAMAGES\s0, \s-1INCLUDING\s0 \s-1ANY\s0 \s-1GENERAL\s0, \s-1SPECIAL\s0, \s-1INCIDENTAL\s0, \s-1OR\s0 \s-1CONSEQUENTIAL\s0 \s-1DAMAGES\s0 \s-1ARISING\s0 \s-1OUT\s0 \s-1OF\s0 \s-1THE\s0 \s-1USE\s0 \s-1OR\s0 \s-1INABILITY\s0 \s-1TO\s0 \s-1USE\s0 \s-1THE\s0 \s-1SOFTWARE\s0 (\s-1INCLUDING\s0 \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0 \s-1LOSS\s0 \s-1OF\s0 \s-1DATA\s0 \s-1OR\s0 \s-1DATA\s0 \s-1BEING\s0 \s-1RENDERED\s0 \s-1INACCURATE\s0 \s-1OR\s0 \s-1LOSSES\s0 \s-1SUSTAINED\s0 \s-1BY\s0 \s-1YOU\s0 \s-1OR\s0 \s-1THIRD\s0 \s-1PARTIES\s0 \s-1OR\s0 A \s-1FAILURE\s0 \s-1OF\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1TO\s0 \s-1OPERATE\s0 \s-1WITH\s0 \s-1ANY\s0 \s-1OTHER\s0 \s-1SOFTWARE\s0), \s-1EVEN\s0 \s-1IF\s0 \s-1SUCH\s0 \s-1HOLDER\s0 \s-1OR\s0 \s-1OTHER\s0 \s-1PARTY\s0 \s-1HAS\s0 \s-1BEEN\s0 \s-1ADVISED\s0 \s-1OF\s0 \s-1THE\s0 \s-1POSSIBILITY\s0 \s-1OF\s0 \s-1SUCH\s0 \s-1DAMAGES\s0.