This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Mention the syntax C<use feature ':5.10'> in feature.pm's synopsis
[perl5.git] / lib / feature.pm
1 package feature;
2
3 our $VERSION = '1.10';
4
5 # (feature name) => (internal name, used in %^H)
6 my %feature = (
7     switch => 'feature_switch',
8     say    => "feature_say",
9     err    => "feature_err",
10     state  => "feature_state",
11 );
12
13 my %feature_bundle = (
14     "5.10.0" => [qw(switch say err state)],
15 );
16 # latest version here
17 # keep it harcoded until we actually bump the version number to 5.10
18 $feature_bundle{"5.10"} = $feature_bundle{"5.10.0"};
19 #$feature_bundle{"5.10"} = $feature_bundle{sprintf("%vd",$^V)};
20
21 # TODO:
22 # - think about versioned features (use feature switch => 2)
23
24 =head1 NAME
25
26 feature - Perl pragma to enable new syntactic features
27
28 =head1 SYNOPSIS
29
30     use feature qw(switch say);
31     given ($foo) {
32         when (1)          { say "\$foo == 1" }
33         when ([2,3])      { say "\$foo == 2 || \$foo == 3" }
34         when (/^a[bc]d$/) { say "\$foo eq 'abd' || \$foo eq 'acd'" }
35         when ($_ > 100)   { say "\$foo > 100" }
36         default           { say "None of the above" }
37     }
38
39     use feature ':5.10'; # loads all features available in perl 5.10
40
41 =head1 DESCRIPTION
42
43 It is usually impossible to add new syntax to Perl without breaking
44 some existing programs. This pragma provides a way to minimize that
45 risk. New syntactic constructs can be enabled by C<use feature 'foo'>,
46 and will be parsed only when the appropriate feature pragma is in
47 scope.
48
49 =head2 Lexical effect
50
51 Like other pragmas (C<use strict>, for example), features have a lexical
52 effect. C<use feature qw(foo)> will only make the feature "foo" available
53 from that point to the end of the enclosing block.
54
55     {
56         use feature 'say';
57         say "say is available here";
58     }
59     print "But not here.\n";
60
61 =head2 C<no feature>
62
63 Features can also be turned off by using C<no feature "foo">. This too
64 has lexical effect.
65
66     use feature 'say';
67     say "say is available here";
68     {
69         no feature 'say';
70         print "But not here.\n";
71     }
72     say "Yet it is here.";
73
74 C<no feature> with no features specified will turn off all features.
75
76 =head2 The 'switch' feature
77
78 C<use feature 'switch'> tells the compiler to enable the Perl 6
79 given/when construct.
80
81 See L<perlsyn/"Switch statements"> for details.
82
83 =head2 The 'say' feature
84
85 C<use feature 'say'> tells the compiler to enable the Perl 6
86 C<say> function.
87
88 See L<perlfunc/say> for details.
89
90 =head2 the 'err' feature
91
92 C<use feature 'err'> tells the compiler to enable the C<err>
93 operator.
94
95 C<err> is a low-precedence variant of the C<//> operator:
96 see C<perlop> for details.
97
98 =head2 the 'state' feature
99
100 C<use feature 'state'> tells the compiler to enable C<state>
101 variables.
102
103 See L<perlsub/"Persistent Private Variables"> for details.
104
105 =head1 FEATURE BUNDLES
106
107 It's possible to load a whole slew of features in one go, using
108 a I<feature bundle>. The name of a feature bundle is prefixed with
109 a colon, to distinguish it from an actual feature. At present, the
110 only feature bundles are C<use feature ":5.10"> and C<use feature ":5.10.0">,
111 which both are equivalent to C<use feature qw(switch say err state)>.
112
113 In the forthcoming 5.10.X perl releases, C<use feature ":5.10"> will be
114 equivalent to the latest C<use feature ":5.10.X">.
115
116 =cut
117
118 sub import {
119     my $class = shift;
120     if (@_ == 0) {
121         croak("No features specified");
122     }
123     while (@_) {
124         my $name = shift(@_);
125         if ($name =~ /^:(.*)/) {
126             if (!exists $feature_bundle{$1}) {
127                 unknown_feature_bundle($1);
128             }
129             unshift @_, @{$feature_bundle{$1}};
130             next;
131         }
132         if (!exists $feature{$name}) {
133             unknown_feature($name);
134         }
135         $^H{$feature{$name}} = 1;
136     }
137 }
138
139 sub unimport {
140     my $class = shift;
141
142     # A bare C<no feature> should disable *all* features
143     if (!@_) {
144         delete @^H{ values(%feature) };
145         return;
146     }
147
148     while (@_) {
149         my $name = shift;
150         if ($name =~ /^:(.*)/) {
151             if (!exists $feature_bundle{$1}) {
152                 unknown_feature_bundle($1);
153             }
154             unshift @_, @{$feature_bundle{$1}};
155             next;
156         }
157         if (!exists($feature{$name})) {
158             unknown_feature($name);
159         }
160         else {
161             delete $^H{$feature{$name}};
162         }
163     }
164 }
165
166 sub unknown_feature {
167     my $feature = shift;
168     croak(sprintf('Feature "%s" is not supported by Perl %vd',
169             $feature, $^V));
170 }
171
172 sub unknown_feature_bundle {
173     my $feature = shift;
174     croak(sprintf('Feature bundle "%s" is not supported by Perl %vd',
175             $feature, $^V));
176 }
177
178 sub croak {
179     require Carp;
180     Carp::croak(@_);
181 }
182
183 1;