]> git.vpit.fr Git - perl/modules/subs-auto.git/blob - README
This is 0.02
[perl/modules/subs-auto.git] / README
1 NAME
2     subs::auto - Read barewords as subroutine names.
3
4 VERSION
5     Version 0.02
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 "foo()->print('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 a 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. Defaults to the
36         current package.
37
38 EXPORT
39     None.
40
41 CAVEATS
42     "*{'::foo'}{CODE}" will appear as defined in a scope where the pragma is
43     enabled, "foo" is used as a bareword, but is never actually defined
44     afterwards. This may or may not be considered as Doing The Right Thing.
45     However, "*{'::foo'}{CODE}" will always return the right value if you
46     fetch it outside the pragma's scope. Actually, you can make it return
47     the right value even in the pragma's scope by reading "*{'::foo'}{CODE}"
48     outside (or by actually defining "foo", which is ultimately why you use
49     this pragma, right ?).
50
51     You have to open global filehandles outside of the scope of this pragma
52     if you want them not to be treated as function calls. Or just use
53     lexical filehandles and default ones as you should be.
54
55 DEPENDENCIES
56     perl 5.10.0.
57
58     Carp (standard since perl 5), Symbol (since 5.002).
59
60     Variable::Magic with "uvar" magic enabled (this should be assured by the
61     required perl version).
62
63 AUTHOR
64     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
65
66     You can contact me by mail or on #perl @ FreeNode (vincent or
67     Prof_Vince).
68
69 BUGS
70     Please report any bugs or feature requests to "bug-subs-auto at
71     rt.cpan.org", or through the web interface at
72     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=subs-auto>. I will be
73     notified, and then you'll automatically be notified of progress on your
74     bug as I make changes.
75
76 SUPPORT
77     You can find documentation for this module with the perldoc command.
78
79         perldoc subs::auto
80
81     Tests code coverage report is available at
82     <http://www.profvince.com/perl/cover/subs-auto>.
83
84 ACKNOWLEDGEMENTS
85     Thanks to Sebastien Aperghis-Tramoni for helping to name this pragma.
86
87 COPYRIGHT & LICENSE
88     Copyright 2008 Vincent Pit, all rights reserved.
89
90     This program is free software; you can redistribute it and/or modify it
91     under the same terms as Perl itself.
92