+# -*- buffer-read-only: t -*-
+# !!!!!!! DO NOT EDIT THIS FILE !!!!!!!
+# This file is built by regen/feature.pl.
+# Any changes made here will be lost!
+
package feature;
-our $VERSION = '1.01';
+our $VERSION = '1.25';
-# (feature name) => (internal name, used in %^H)
my %feature = (
- switch => 'feature_switch',
- "~~" => "feature_~~",
- say => "feature_say",
- err => "feature_err",
- dor => "feature_err",
- state => "feature_state",
+ say => 'feature_say',
+ state => 'feature_state',
+ switch => 'feature_switch',
+ evalbytes => 'feature_evalbytes',
+ array_base => 'feature_arybase',
+ current_sub => 'feature___SUB__',
+ unicode_eval => 'feature_unieval',
+ unicode_strings => 'feature_unicode',
);
-my %feature_bundle = (
- "5.10" => [qw(switch ~~ say err state)],
+our %feature_bundle = (
+ "5.10" => [qw(array_base say state switch)],
+ "5.11" => [qw(array_base say state switch unicode_strings)],
+ "5.15" => [qw(current_sub evalbytes say state switch unicode_eval unicode_strings)],
+ "default" => [qw(array_base)],
);
+$feature_bundle{"5.12"} = $feature_bundle{"5.11"};
+$feature_bundle{"5.13"} = $feature_bundle{"5.11"};
+$feature_bundle{"5.14"} = $feature_bundle{"5.11"};
+$feature_bundle{"5.16"} = $feature_bundle{"5.15"};
+$feature_bundle{"5.9.5"} = $feature_bundle{"5.10"};
+
+my $hint_shift = 26;
+my $hint_mask = 0x1c000000;
+my @hint_bundles = qw( default 5.10 5.11 5.15 );
+
+# This gets set (for now) in $^H as well as in %^H,
+# for runtime speed of the uc/lc/ucfirst/lcfirst functions.
+# See HINT_UNI_8_BIT in perl.h.
+our $hint_uni8bit = 0x00000800;
-# Here are some notes that probably shouldn't be in the public
-# documentation, but which it's useful to have somewhere.
-#
-# One side-effect of the change is that C<prototype("CORE::continue")>
-# no longer throws the error C<Can't find an opnumber for "continue">.
-# One of the tests in t/op/cproto.t had to be changed to accommodate
-# this, but it really shouldn't affect real-world code.
-#
# TODO:
-# - sort out the smartmatch semantics
-# - think about versioned features (use switch => 2)
-#
-# -- Robin 2005-12
+# - think about versioned features (use feature switch => 2)
=head1 NAME
-feature - Perl pragma to enable new syntactic features
+feature - Perl pragma to enable new features
=head1 SYNOPSIS
- use feature qw(switch say);
+ use feature qw(say switch);
given ($foo) {
- when (1) { say "\$foo == 1" }
- when ([2,3]) { say "\$foo == 2 || \$foo == 3" }
- when (/^a[bc]d$/) { say "\$foo eq 'abd' || \$foo eq 'acd'" }
- when ($_ > 100) { say "\$foo > 100" }
- default { say "None of the above" }
+ when (1) { say "\$foo == 1" }
+ when ([2,3]) { say "\$foo == 2 || \$foo == 3" }
+ when (/^a[bc]d$/) { say "\$foo eq 'abd' || \$foo eq 'acd'" }
+ when ($_ > 100) { say "\$foo > 100" }
+ default { say "None of the above" }
}
+ use feature ':5.10'; # loads all features available in perl 5.10
+
+ use v5.10; # implicitly loads :5.10 feature bundle
+
=head1 DESCRIPTION
It is usually impossible to add new syntax to Perl without breaking
-some existing programs. This pragma provides a way to minimize that
-risk. New syntactic constructs can be enabled by C<use feature 'foo'>,
-and will be parsed only when the appropriate feature pragma is in
-scope.
+some existing programs. This pragma provides a way to minimize that
+risk. New syntactic constructs, or new semantic meanings to older
+constructs, can be enabled by C<use feature 'foo'>, and will be parsed
+only when the appropriate feature pragma is in scope. (Nevertheless, the
+C<CORE::> prefix provides access to all Perl keywords, regardless of this
+pragma.)
+
+=head2 Lexical effect
+
+Like other pragmas (C<use strict>, for example), features have a lexical
+effect. C<use feature qw(foo)> will only make the feature "foo" available
+from that point to the end of the enclosing block.
+
+ {
+ use feature 'say';
+ say "say is available here";
+ }
+ print "But not here.\n";
+
+=head2 C<no feature>
+
+Features can also be turned off by using C<no feature "foo">. This too
+has lexical effect.
+
+ use feature 'say';
+ say "say is available here";
+ {
+ no feature 'say';
+ print "But not here.\n";
+ }
+ say "Yet it is here.";
+
+C<no feature> with no features specified will turn off all features.
+
+=head1 AVAILABLE FEATURES
+
+=head2 The 'say' feature
+
+C<use feature 'say'> tells the compiler to enable the Perl 6 style
+C<say> function.
+
+See L<perlfunc/say> for details.
+
+This feature is available starting with Perl 5.10.
+
+=head2 The 'state' feature
+
+C<use feature 'state'> tells the compiler to enable C<state>
+variables.
+
+See L<perlsub/"Persistent Private Variables"> for details.
+
+This feature is available starting with Perl 5.10.
=head2 The 'switch' feature
C<use feature 'switch'> tells the compiler to enable the Perl 6
-given/when construct from here to the end of the enclosing BLOCK.
+given/when construct.
See L<perlsyn/"Switch statements"> for details.
-=head2 The '~~' feature
+This feature is available starting with Perl 5.10.
-C<use feature '~~'> tells the compiler to enable the Perl 6
-smart match C<~~> operator from here to the end of the enclosing BLOCK.
+=head2 The 'unicode_strings' feature
-See L<perlsyn/"Smart Matching in Detail"> for details.
+C<use feature 'unicode_strings'> tells the compiler to use Unicode semantics
+in all string operations executed within its scope (unless they are also
+within the scope of either C<use locale> or C<use bytes>). The same applies
+to all regular expressions compiled within the scope, even if executed outside
+it.
-=head2 The 'say' feature
+C<no feature 'unicode_strings'> tells the compiler to use the traditional
+Perl semantics wherein the native character set semantics is used unless it is
+clear to Perl that Unicode is desired. This can lead to some surprises
+when the behavior suddenly changes. (See
+L<perlunicode/The "Unicode Bug"> for details.) For this reason, if you are
+potentially using Unicode in your program, the
+C<use feature 'unicode_strings'> subpragma is B<strongly> recommended.
-C<use feature 'say'> tells the compiler to enable the Perl 6
-C<say> function from here to the end of the enclosing BLOCK.
+This feature is available starting with Perl 5.12, but was not fully
+implemented until Perl 5.14.
-See L<perlfunc/say> for details.
+=head2 The 'unicode_eval' and 'evalbytes' features
-=head2 the 'err' feature
+Under the C<unicode_eval> feature, Perl's C<eval> function, when passed a
+string, will evaluate it as a string of characters, ignoring any
+C<use utf8> declarations. C<use utf8> exists to declare the encoding of
+the script, which only makes sense for a stream of bytes, not a string of
+characters. Source filters are forbidden, as they also really only make
+sense on strings of bytes. Any attempt to activate a source filter will
+result in an error.
-C<use feature 'err'> tells the compiler to enable the C<err>
-operator from here to the end of the enclosing BLOCK.
+The C<evalbytes> feature enables the C<evalbytes> keyword, which evaluates
+the argument passed to it as a string of bytes. It dies if the string
+contains any characters outside the 8-bit range. Source filters work
+within C<evalbytes>: they apply to the contents of the string being
+evaluated.
-C<err> is a low-precedence variant of the C<//> operator:
-see C<perlop> for details.
+Together, these two features are intended to replace the historical C<eval>
+function, which has (at least) two bugs in it, that cannot easily be fixed
+without breaking existing programs:
-=head2 the 'dor' feature
+=over
-The 'dor' feature is an alias for the 'err' feature.
+=item *
-=head2 the 'state' feature
+C<eval> behaves differently depending on the internal encoding of the
+string, sometimes treating its argument as a string of bytes, and sometimes
+as a string of characters.
-C<use feature 'state'> tells the compiler to enable C<state>
-variables from here to the end of the enclosing BLOCK.
+=item *
+
+Source filters activated within C<eval> leak out into whichever I<file>
+scope is currently being compiled. To give an example with the CPAN module
+L<Semi::Semicolons>:
+
+ BEGIN { eval "use Semi::Semicolons; # not filtered here " }
+ # filtered here!
+
+C<evalbytes> fixes that to work the way one would expect:
+
+ use feature "evalbytes";
+ BEGIN { evalbytes "use Semi::Semicolons; # filtered " }
+ # not filtered
+
+=back
+
+These two features are available starting with Perl 5.16.
+
+=head2 The 'current_sub' feature
+
+This provides the C<__SUB__> token that returns a reference to the current
+subroutine or C<undef> outside of a subroutine.
+
+This feature is available starting with Perl 5.16.
+
+=head2 The 'array_base' feature
+
+This feature supports the legacy C<$[> variable. See L<perlvar/$[> and
+L<arybase>. It is on by default but disabled under C<use v5.16> (see
+L</IMPLICIT LOADING>, below).
+
+This feature is available under this name starting with Perl 5.16. In
+previous versions, it was simply on all the time, and this pragma knew
+nothing about it.
=head1 FEATURE BUNDLES
-It's possible to load a whole slew of features in one go, using
-a I<feature bundle>. The name of a feature bundle is prefixed with
-a colon, to distinguish it from an actual feature. At present, the
-only feature bundle is C<use feature ":5.10">, which is equivalent
-to C<use feature qw(switch ~~ say err state)>.
+It's possible to load multiple features together, using
+a I<feature bundle>. The name of a feature bundle is prefixed with
+a colon, to distinguish it from an actual feature.
+
+ use feature ":5.10";
+
+The following feature bundles are available:
+
+ bundle features included
+ --------- -----------------
+ :default array_base
+
+ :5.10 say state switch array_base
+
+ :5.12 say state switch unicode_strings array_base
+
+ :5.14 say state switch unicode_strings array_base
+
+ :5.16 say state switch unicode_strings
+ unicode_eval evalbytes current_sub
+
+The C<:default> bundle represents the feature set that is enabled before
+any C<use feature> or C<no feature> declaration.
+
+Specifying sub-versions such as the C<0> in C<5.14.0> in feature bundles has
+no effect. Feature bundles are guaranteed to be the same for all sub-versions.
+
+ use feature ":5.14.0"; # same as ":5.14"
+ use feature ":5.14.1"; # same as ":5.14"
+
+=head1 IMPLICIT LOADING
+
+Instead of loading feature bundles by name, it is easier to let Perl do
+implicit loading of a feature bundle for you.
+
+There are two ways to load the C<feature> pragma implicitly:
+
+=over 4
+
+=item *
+
+By using the C<-E> switch on the Perl command-line instead of C<-e>.
+That will enable the feature bundle for that version of Perl in the
+main compilation unit (that is, the one-liner that follows C<-E>).
+
+=item *
+
+By explicitly requiring a minimum Perl version number for your program, with
+the C<use VERSION> construct. That is,
+
+ use v5.10.0;
+
+will do an implicit
+
+ no feature;
+ use feature ':5.10';
+
+and so on. Note how the trailing sub-version
+is automatically stripped from the
+version.
+
+But to avoid portability warnings (see L<perlfunc/use>), you may prefer:
+
+ use 5.010;
+
+with the same effect.
+
+If the required version is older than Perl 5.10, the ":default" feature
+bundle is automatically loaded instead.
+
+=back
=cut
+sub current_bundle {
+ my $bundle_number = $^H & $hint_mask;
+ return if $bundle_number == $hint_mask;
+ return $feature_bundle{@hint_bundles[$bundle_number >> $hint_shift]};
+}
+
sub import {
my $class = shift;
if (@_ == 0) {
- croak("No features specified");
+ croak("No features specified");
+ }
+ if (my $features = current_bundle) {
+ # Features are enabled implicitly via bundle hints.
+
+ # Delete any keys that may be left over from last time.
+ delete @^H{ values(%feature) };
+
+ unshift @_, @$features;
+ $^H |= $hint_mask;
}
while (@_) {
- my $name = shift(@_);
- if ($name =~ /^:(.*)/) {
- if (!exists $feature_bundle{$1}) {
- unknown_feature_bundle($1);
- }
- unshift @_, @{$feature_bundle{$1}};
- next;
- }
- if (!exists $feature{$name}) {
- unknown_feature($name);
- }
- $^H{$feature{$name}} = 1;
+ my $name = shift(@_);
+ if (substr($name, 0, 1) eq ":") {
+ my $v = substr($name, 1);
+ if (!exists $feature_bundle{$v}) {
+ $v =~ s/^([0-9]+)\.([0-9]+).[0-9]+$/$1.$2/;
+ if (!exists $feature_bundle{$v}) {
+ unknown_feature_bundle(substr($name, 1));
+ }
+ }
+ unshift @_, @{$feature_bundle{$v}};
+ next;
+ }
+ if (!exists $feature{$name}) {
+ unknown_feature($name);
+ }
+ $^H{$feature{$name}} = 1;
+ $^H |= $hint_uni8bit if $name eq 'unicode_strings';
}
}
sub unimport {
my $class = shift;
+ if (my $features = current_bundle) {
+ # Features are enabled implicitly via bundle hints
+ # Pass them to import() to put them in a form we can handle.
+ import(undef, @$features);
+ $^H |= $hint_mask;
+ }
+
# A bare C<no feature> should disable *all* features
if (!@_) {
- delete @^H{ values(%feature) };
- return;
+ delete @^H{ values(%feature) };
+ $^H &= ~ $hint_uni8bit;
+ return;
}
while (@_) {
- my $name = shift;
- if ($name =~ /^:(.*)/) {
- if (!exists $feature_bundle{$1}) {
- unknown_feature_bundle($1);
- }
- unshift @_, @{$feature_bundle{$1}};
- next;
- }
- if (!exists($feature{$name})) {
- unknown_feature($name);
- }
- else {
- delete $^H{$feature{$name}};
- }
+ my $name = shift;
+ if (substr($name, 0, 1) eq ":") {
+ my $v = substr($name, 1);
+ if (!exists $feature_bundle{$v}) {
+ $v =~ s/^([0-9]+)\.([0-9]+).[0-9]+$/$1.$2/;
+ if (!exists $feature_bundle{$v}) {
+ unknown_feature_bundle(substr($name, 1));
+ }
+ }
+ unshift @_, @{$feature_bundle{$v}};
+ next;
+ }
+ if (!exists($feature{$name})) {
+ unknown_feature($name);
+ }
+ else {
+ delete $^H{$feature{$name}};
+ $^H &= ~ $hint_uni8bit if $name eq 'unicode_strings';
+ }
}
}
sub unknown_feature {
my $feature = shift;
croak(sprintf('Feature "%s" is not supported by Perl %vd',
- $feature, $^V));
+ $feature, $^V));
}
sub unknown_feature_bundle {
my $feature = shift;
croak(sprintf('Feature bundle "%s" is not supported by Perl %vd',
- $feature, $^V));
+ $feature, $^V));
}
sub croak {
}
1;
+
+# ex: set ro:
https://perl5.git.perl.org / perl5.git / blobdiff