]> git.vpit.fr Git - perl/modules/subs-auto.git/blob - README
Code cleanup
[perl/modules/subs-auto.git] / README
1 NAME
2     subs::auto - Read barewords as subroutine names.
3
4 VERSION
5     Version 0.05
6
7 SYNOPSIS
8         {
9          use subs::auto;
10          foo;             # Compile to "foo()"     instead of "'foo'"
11                           #                        or croaking on strict subs
12          foo $x;          # Compile to "foo($x)"   instead of "$x->foo"
13          foo 1;           # Compile to "foo(1)"    instead of croaking
14          foo 1, 2;        # Compile to "foo(1, 2)" instead of croaking
15          foo(@a);         # Still ok
16          foo->meth;       # "'foo'->meth" if you have use'd foo somewhere,
17                           #  or "foo()->meth" otherwise
18          print foo 'wut'; # print to the filehandle foo if it's actually one,
19                           #  or "print(foo('wut'))" otherwise
20         } # ... but function calls will fail at run-time if you don't
21           # actually define foo somewhere
22     
23         foo; # BANG
24
25 DESCRIPTION
26     This pragma lexically enables the parsing of any bareword as a
27     subroutine name, except those which corresponds to an entry in %INC
28     (expected to be class names) or whose symbol table entry has an IO slot
29     (expected to be filehandles).
30
31     You can pass options to "import" as key / value pairs :
32
33     *   "in => $pkg"
34
35         Specifies on which package the pragma should act. Setting $pkg to
36         "Some::Package" allows you to resolve all functions name of the type
37         "Some::Package::func ..." in the current scope. You can use the
38         pragma several times with different package names to allow
39         resolution of all the corresponding barewords. Defaults to the
40         current package.
41
42     This module is not a source filter.
43
44 EXPORT
45     None.
46
47 CAVEATS
48     "*{'::foo'}{CODE}" will appear as defined in a scope where the pragma is
49     enabled, "foo" is used as a bareword, but is never actually defined
50     afterwards. This may or may not be considered as Doing The Right Thing.
51     However, "*{'::foo'}{CODE}" will always return the right value if you
52     fetch it outside the pragma's scope. Actually, you can make it return
53     the right value even in the pragma's scope by reading "*{'::foo'}{CODE}"
54     outside (or by actually defining "foo", which is ultimately why you use
55     this pragma, right ?).
56
57     You have to open global filehandles outside of the scope of this pragma
58     if you want them not to be treated as function calls. Or just use
59     lexical filehandles and default ones as you should be.
60
61 DEPENDENCIES
62     perl 5.10.0.
63
64     Carp (standard since perl 5), Symbol (since 5.002).
65
66     Variable::Magic with "uvar" magic enabled (this should be assured by the
67     required perl version).
68
69 AUTHOR
70     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
71
72     You can contact me by mail or on "irc.perl.org" (vincent).
73
74 BUGS
75     Please report any bugs or feature requests to "bug-subs-auto at
76     rt.cpan.org", or through the web interface at
77     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=subs-auto>. I will be
78     notified, and then you'll automatically be notified of progress on your
79     bug as I make changes.
80
81 SUPPORT
82     You can find documentation for this module with the perldoc command.
83
84         perldoc subs::auto
85
86     Tests code coverage report is available at
87     <http://www.profvince.com/perl/cover/subs-auto>.
88
89 ACKNOWLEDGEMENTS
90     Thanks to Sebastien Aperghis-Tramoni for helping to name this pragma.
91
92 COPYRIGHT & LICENSE
93     Copyright 2008 Vincent Pit, all rights reserved.
94
95     This program is free software; you can redistribute it and/or modify it
96     under the same terms as Perl itself.
97