This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl5db] Get rid of leading ampersands.
[perl5.git] / lib / feature.pm
index 4cfa27f..46b43a8 100644 (file)
@@ -1,40 +1,52 @@
+# -*- 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.24';
+our $VERSION = '1.31';
 
-# (feature name) => (internal name, used in %^H)
-my %feature = (
+our %feature = (
+    fc              => 'feature_fc',
     say             => 'feature_say',
     state           => 'feature_state',
     switch          => 'feature_switch',
     evalbytes       => 'feature_evalbytes',
+    array_base      => 'feature_arybase',
     current_sub     => 'feature___SUB__',
+    lexical_subs    => 'feature_lexsubs',
     unicode_eval    => 'feature_unieval',
     unicode_strings => 'feature_unicode',
 );
 
-# 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;
-
-# NB. the latest bundle must be loaded by the -E switch (see toke.c)
-
 our %feature_bundle = (
-    "default" => [],
-    "5.10" => [qw(say state switch)],
-    "5.11" => [qw(say state switch unicode_strings)],
-    "5.15" => [qw(say state switch unicode_strings unicode_eval
-                  evalbytes current_sub)],
+    "5.10"    => [qw(array_base say state switch)],
+    "5.11"    => [qw(array_base say state switch unicode_strings)],
+    "5.15"    => [qw(current_sub evalbytes fc say state switch unicode_eval unicode_strings)],
+    "all"     => [qw(array_base current_sub evalbytes fc lexical_subs say state switch unicode_eval unicode_strings)],
+    "default" => [qw(array_base)],
 );
 
-# Each of these is the same as the previous bundle
-for(12...14, 16) {
-    $feature_bundle{"5.$_"} = $feature_bundle{"5.".($_-1)}
-}
-
-# special case
+$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.17"} = $feature_bundle{"5.15"};
+$feature_bundle{"5.18"} = $feature_bundle{"5.15"};
 $feature_bundle{"5.9.5"} = $feature_bundle{"5.10"};
+my %experimental = (
+    lexical_subs => 1,
+);
+
+our $hint_shift   = 26;
+our $hint_mask    = 0x1c000000;
+our @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;
 
 # TODO:
 # - think about versioned features (use feature switch => 2)
@@ -61,17 +73,17 @@ feature - Perl pragma to enable new features
 =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
+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
+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
+effect.  C<use feature qw(foo)> will only make the feature "foo" available
 from that point to the end of the enclosing block.
 
     {
@@ -82,7 +94,7 @@ from that point to the end of the enclosing block.
 
 =head2 C<no feature>
 
-Features can also be turned off by using C<no feature "foo">. This too
+Features can also be turned off by using C<no feature "foo">.  This too
 has lexical effect.
 
     use feature 'say';
@@ -93,7 +105,8 @@ has lexical effect.
     }
     say "Yet it is here.";
 
-C<no feature> with no features specified will turn off all features.
+C<no feature> with no features specified will reset to the default group.  To
+disable I<all> features (an unusual request!) use C<no feature ':all'>.
 
 =head1 AVAILABLE FEATURES
 
@@ -120,7 +133,7 @@ This feature is available starting with Perl 5.10.
 C<use feature 'switch'> tells the compiler to enable the Perl 6
 given/when construct.
 
-See L<perlsyn/"Switch statements"> for details.
+See L<perlsyn/"Switch Statements"> for details.
 
 This feature is available starting with Perl 5.10.
 
@@ -130,7 +143,8 @@ 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.
+it.  It does not change the internal representation of strings, but only how
+they are interpreted.
 
 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
@@ -140,8 +154,8 @@ 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.
 
-This feature is available starting with Perl 5.12, but was not fully
-implemented until Perl 5.14.
+This feature is available starting with Perl 5.12; was almost fully
+implemented in Perl 5.14; and extended in Perl 5.16 to cover C<quotemeta>.
 
 =head2 The 'unicode_eval' and 'evalbytes' features
 
@@ -197,10 +211,43 @@ 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.
+
+=head2 The 'fc' feature
+
+C<use feature 'fc'> tells the compiler to enable the C<fc> function,
+which implements Unicode casefolding.
+
+See L<perlfunc/fc> for details.
+
+This feature is available from Perl 5.16 onwards.
+
+=head2 The 'lexical_subs' feature
+
+B<WARNING>: This feature is still experimental and the implementation may
+change in future versions of Perl.  For this reason, F<feature.pm> will
+warn when you enable the feature, unless you have explicitly disabled the
+warning:
+
+    no warnings "experimental::lexical_subs";
+
+This enables declaration of subroutines via C<my sub foo>, C<state sub foo>
+and C<our sub foo> syntax.  See L<perlsub/Lexical Subroutines> for details.
+
+This feature is available from Perl 5.18 onwards.
+
 =head1 FEATURE BUNDLES
 
 It's possible to load multiple features together, using
-a I<feature bundle>. The name of a feature bundle is prefixed with
+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";
@@ -209,22 +256,25 @@ The following feature bundles are available:
 
   bundle    features included
   --------- -----------------
-  :default  none
+  :default  array_base
 
-  :5.10     say state switch
+  :5.10     say state switch array_base
 
-  :5.12     say state switch unicode_strings
+  :5.12     say state switch unicode_strings array_base
 
-  :5.14     say state switch unicode_strings
+  :5.14     say state switch unicode_strings array_base
 
   :5.16     say state switch unicode_strings
-            unicode_eval evalbytes current_sub
+            unicode_eval evalbytes current_sub fc
+
+  :5.18     say state switch unicode_strings
+            unicode_eval evalbytes current_sub fc
 
-The empty C<:default> bundle is provided for future
-backwards-compatibility when using L<implicit loading|/IMPLICIT LOADING>.
+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.
+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"
@@ -247,16 +297,17 @@ 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,
+the C<use VERSION> construct.  That is,
 
     use v5.10.0;
 
 will do an implicit
 
-    no feature;
+    no feature ':all';
     use feature ':5.10';
 
-and so on. Note how the trailing sub-version is automatically stripped from the
+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:
@@ -266,9 +317,7 @@ But to avoid portability warnings (see L<perlfunc/use>), you may prefer:
 with the same effect.
 
 If the required version is older than Perl 5.10, the ":default" feature
-bundle is automatically loaded instead. It is currently empty and has no
-effect, but may be used in the future to support backwards
-compatibility.
+bundle is automatically loaded instead.
 
 =back
 
@@ -276,40 +325,42 @@ compatibility.
 
 sub import {
     my $class = shift;
-    if (@_ == 0) {
+
+    if (!@_) {
         croak("No features specified");
     }
-    while (@_) {
-        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';
-    }
+
+    __common(1, @_);
 }
 
 sub unimport {
     my $class = shift;
 
-    # A bare C<no feature> should disable *all* features
+    # A bare C<no feature> should reset to the default bundle
     if (!@_) {
-        delete @^H{ values(%feature) };
-        $^H &= ~ $hint_uni8bit;
-        return;
+       $^H &= ~($hint_uni8bit|$hint_mask);
+       return;
     }
 
+    __common(0, @_);
+}
+
+
+sub __common {
+    my $import = shift;
+    my $bundle_number = $^H & $hint_mask;
+    my $features = $bundle_number != $hint_mask
+       && $feature_bundle{$hint_bundles[$bundle_number >> $hint_shift]};
+    if ($features) {
+       # Features are enabled implicitly via bundle hints.
+       # Delete any keys that may be left over from last time.
+       delete @^H{ values(%feature) };
+       $^H |= $hint_mask;
+       for (@$features) {
+           $^H{$feature{$_}} = 1;
+           $^H |= $hint_uni8bit if $_ eq 'unicode_strings';
+       }
+    }
     while (@_) {
         my $name = shift;
         if (substr($name, 0, 1) eq ":") {
@@ -323,10 +374,18 @@ sub unimport {
             unshift @_, @{$feature_bundle{$v}};
             next;
         }
-        if (!exists($feature{$name})) {
+        if (!exists $feature{$name}) {
             unknown_feature($name);
         }
-        else {
+       if ($import) {
+           $^H{$feature{$name}} = 1;
+           $^H |= $hint_uni8bit if $name eq 'unicode_strings';
+           if ($experimental{$name}) {
+               require warnings;
+               warnings::warnif("experimental::$name",
+                                "The $name feature is experimental");
+           }
+       } else {
             delete $^H{$feature{$name}};
             $^H &= ~ $hint_uni8bit if $name eq 'unicode_strings';
         }
@@ -351,3 +410,5 @@ sub croak {
 }
 
 1;
+
+# ex: set ro: