X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FEnglish.pm;h=77f27c5b7165a0fb10f31635aa55bb5d146c0e22;hb=400728b860602b352de8071deef81019cfa0d73e;hp=d40d28af7d008cfad3b6f1bbba2da1343c4a9a50;hpb=748a93069b3d16374a9859d1456065dd3ae11394;p=p5sagit%2Fp5-mst-13.2.git

diff --git a/lib/English.pm b/lib/English.pm
index d40d28a..77f27c5 100644
--- a/lib/English.pm
+++ b/lib/English.pm
@@ -1,23 +1,81 @@
 package English;
 
+our $VERSION = '1.00';
+
 require Exporter;
 @ISA = (Exporter);
 
-local $^W = 0;
+=head1 NAME
+
+English - use nice English (or awk) names for ugly punctuation variables
+
+=head1 SYNOPSIS
+
+    use English qw( -no_match_vars ) ;  # Avoids regex performance penalty
+    use English;
+    ...
+    if ($ERRNO =~ /denied/) { ... }
+
+=head1 DESCRIPTION
+
+This module provides aliases for the built-in variables whose
+names no one seems to like to read.  Variables with side-effects
+which get triggered just by accessing them (like $0) will still 
+be affected.
+
+For those variables that have an B<awk> version, both long
+and short English alternatives are provided.  For example, 
+the C<$/> variable can be referred to either $RS or 
+$INPUT_RECORD_SEPARATOR if you are using the English module.
+
+See L<perlvar> for a complete list of these.
+
+=head1 PERFORMANCE
+
+This module can provoke sizeable inefficiencies for regular expressions,
+due to unfortunate implementation details.  If performance matters in
+your application and you don't need $PREMATCH, $MATCH, or $POSTMATCH,
+try doing
+
+   use English qw( -no_match_vars ) ;
+
+.  B<It is especially important to do this in modules to avoid penalizing
+all applications which use them.>
+
+=cut
+
+no warnings;
+
+my $globbed_match ;
 
 # Grandfather $NAME import
 sub import {
     my $this = shift;
-    my @list = @_;
+    my @list = grep { ! /^-no_match_vars$/ } @_ ;
     local $Exporter::ExportLevel = 1;
+    if ( @_ == @list ) {
+        *EXPORT = \@COMPLETE_EXPORT ;
+        $globbed_match ||= (
+	    eval q{
+		*MATCH				= *&	;
+		*PREMATCH				= *`	;
+		*POSTMATCH				= *'	;
+		1 ;
+	       }
+	    || do {
+		require Carp ;
+		Carp::croak "Can't create English for match leftovers: $@" ;
+	    }
+	) ;
+    }
+    else {
+        *EXPORT = \@MINIMAL_EXPORT ;
+    }
     Exporter::import($this,grep {s/^\$/*/} @list);
 }
 
-@EXPORT = qw(
+@MINIMAL_EXPORT = qw(
 	*ARG
-	*MATCH
-	*PREMATCH
-	*POSTMATCH
 	*LAST_PAREN_MATCH
 	*INPUT_LINE_NUMBER
 	*NR
@@ -41,6 +99,7 @@ sub import {
 	*CHILD_ERROR
 	*OS_ERROR
 	*ERRNO
+	*EXTENDED_OS_ERROR
 	*EVAL_ERROR
 	*PROCESS_ID
 	*PID
@@ -62,18 +121,31 @@ sub import {
 	*BASETIME
 	*WARNING
 	*EXECUTABLE_NAME
+	*OSNAME
+	*LAST_REGEXP_CODE_RESULT
+	*EXCEPTIONS_BEING_CAUGHT
+	@LAST_MATCH_START
+	@LAST_MATCH_END
+);
+
+
+@MATCH_EXPORT = qw(
+	*MATCH
+	*PREMATCH
+	*POSTMATCH
 );
 
-# The ground of all being.
+@COMPLETE_EXPORT = ( @MINIMAL_EXPORT, @MATCH_EXPORT ) ;
+
+# The ground of all being. @ARG is deprecated (5.005 makes @_ lexical)
 
 	*ARG					= *_	;
 
 # Matching.
 
-	*MATCH					= *&	;
-	*PREMATCH				= *`	;
-	*POSTMATCH				= *'	;
 	*LAST_PAREN_MATCH			= *+	;
+	*LAST_MATCH_START			= *-{ARRAY} ;
+	*LAST_MATCH_END				= *+{ARRAY} ;
 
 # Input.
 
@@ -111,6 +183,7 @@ sub import {
 	*CHILD_ERROR				= *?	;
 	*OS_ERROR				= *!	;
 	    *ERRNO				= *!	;
+	*EXTENDED_OS_ERROR			= *^E	;
 	*EVAL_ERROR				= *@	;
 
 # Process info.
@@ -129,20 +202,25 @@ sub import {
 
 # Internals.
 
-	*PERL_VERSION				= *]	;
+	*PERL_VERSION				= *^V	;
 	*ACCUMULATOR				= *^A	;
+	*COMPILING				= *^C	;
 	*DEBUGGING				= *^D	;
 	*SYSTEM_FD_MAX				= *^F	;
 	*INPLACE_EDIT				= *^I	;
 	*PERLDB					= *^P	;
+	*LAST_REGEXP_CODE_RESULT		= *^R	;
+	*EXCEPTIONS_BEING_CAUGHT		= *^S	;
 	*BASETIME				= *^T	;
 	*WARNING				= *^W	;
 	*EXECUTABLE_NAME			= *^X	;
+	*OSNAME					= *^O	;
 
 # Deprecated.
 
 #	*ARRAY_BASE				= *[	;
 #	*OFMT					= *#	;
 #	*MULTILINE_MATCHING			= **	;
+#	*OLD_PERL_VERSION			= *]	;
 
 1;