This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Make #2012 glob pattern more portable.
[perl5.git] / configpm
index fcf4e3d..ba07f14 100755 (executable)
--- a/configpm
+++ b/configpm
@@ -1,6 +1,7 @@
 #!./miniperl -w
 
-$config_pm = $ARGV[0] || 'lib/Config.pm';
+my $config_pm = $ARGV[0] || 'lib/Config.pm';
+my $glossary = $ARGV[1] || 'Porting/Glossary';
 @ARGV = "./config.sh";
 
 # list names to put first (and hence lookup fastest)
@@ -45,17 +46,19 @@ while (<>) {
     next if m:^#!/bin/sh:;
     # Catch CONFIG=true and PATCHLEVEL=n line from Configure.
     s/^(\w+)=(true|\d+)\s*$/$1='$2'\n/;
-    unless ($in_v or m/^(\w+)='(.*\n)/){
+    # We can delimit things in config.sh with either ' or ". 
+    unless ($in_v or m/^(\w+)=(['"])(.*\n)/){
        push(@non_v, "#$_"); # not a name='value' line
        next;
     }
+    $quote = $2;
     if ($in_v) { $val .= $_;             }
-    else       { ($name,$val) = ($1,$2); }
-    $in_v = $val !~ /'\n/;
+    else       { ($name,$val) = ($1,$3); }
+    $in_v = $val !~ /$quote\n/;
     next if $in_v;
     if ($extensions{$name}) { s,/,::,g }
-    if (!$fast{$name}){ push(@v_others, "$name='$val"); next; }
-    push(@v_fast,"$name='$val");
+    if (!$fast{$name}){ push(@v_others, "$name=$quote$val"); next; }
+    push(@v_fast,"$name=$quote$val");
 }
 
 foreach(@non_v){ print CONFIG $_ }
@@ -79,7 +82,8 @@ my $summary_expanded = 0;
 
 sub myconfig {
        return $summary if $summary_expanded;
-       $summary =~ s/\$(\w+)/$Config{$1}/ge;
+       $summary =~ s{\$(\w+)}
+                    { my $c = $Config{$1}; defined($c) ? $c : 'undef' }ge;
        $summary_expanded = 1;
        $summary;
 }
@@ -94,17 +98,41 @@ sub FETCH {
     return $_[0]->{$_[1]} if (exists $_[0]->{$_[1]});
 
     # Search for it in the big string 
-    my($value, $start, $marker);
-    $marker = "$_[1]='";
+    my($value, $start, $marker, $quote_type);
+    $marker = "$_[1]=";
+    $quote_type = "'";
     # return undef unless (($value) = $config_sh =~ m/^$_[1]='(.*)'\s*$/m);
-    $start = index($config_sh, "\n$marker");
+    # Check for the common case, ' delimeted
+    $start = index($config_sh, "\n$marker$quote_type");
+    # If that failed, check for " delimited
+    if ($start == -1) {
+      $quote_type = '"';
+      $start = index($config_sh, "\n$marker$quote_type");
+    }
     return undef if ( ($start == -1) &&  # in case it's first 
         (substr($config_sh, 0, length($marker)) ne $marker) );
-    if ($start == -1) { $start = length($marker) } 
-        else { $start += length($marker) + 1 }
+    if ($start == -1) { 
+      # It's the very first thing we found. Skip $start forward
+      # and figure out the quote mark after the =.
+      $start = length($marker) + 1;
+      $quote_type = substr($config_sh, $start - 1, 1);
+    } 
+    else { 
+      $start += length($marker) + 2;
+    }
     $value = substr($config_sh, $start, 
-        index($config_sh, qq('\n), $start) - $start);
+        index($config_sh, "$quote_type\n", $start) - $start);
  
+    # If we had a double-quote, we'd better eval it so escape
+    # sequences and such can be interpolated. Since the incoming
+    # value is supposed to follow shell rules and not perl rules,
+    # we escape any perl variable markers
+    if ($quote_type eq '"') {
+      $value =~ s/\$/\\\$/g;
+      $value =~ s/\@/\\\@/g;
+      eval "\$value = \"$value\"";
+    }
+    #$value = sprintf($value) if $quote_type eq '"';
     $value = undef if $value eq 'undef'; # So we can say "if $Config{'foo'}".
     $_[0]->{$_[1]} = $value; # cache it
     return $value;
@@ -120,7 +148,9 @@ sub FIRSTKEY {
 }
 
 sub NEXTKEY {
-    my $pos = index($config_sh, qq('\n), $prevpos) + 2;
+    # Find out how the current key's quoted so we can skip to its end.
+    my $quote = substr($config_sh, index($config_sh, "=", $prevpos)+1, 1);
+    my $pos = index($config_sh, qq($quote\n), $prevpos) + 2;
     my $len = index($config_sh, "=", $pos) - $pos;
     $prevpos = $pos;
     $len > 0 ? substr($config_sh, $pos, $len) : undef;
@@ -130,7 +160,9 @@ sub EXISTS {
     # exists($_[0]->{$_[1]})  or  $config_sh =~ m/^$_[1]=/m;
     exists($_[0]->{$_[1]}) or
     index($config_sh, "\n$_[1]='") != -1 or
-    substr($config_sh, 0, length($_[1])+2) eq "$_[1]='";
+    substr($config_sh, 0, length($_[1])+2) eq "$_[1]='" or
+    index($config_sh, "\n$_[1]=\"") != -1 or
+    substr($config_sh, 0, length($_[1])+2) eq "$_[1]=\"";
 }
 
 sub STORE  { die "\%Config::Config is read-only\n" }
@@ -179,6 +211,9 @@ ENDOFSET
 
 print CONFIG <<'ENDOFTAIL';
 
+# avoid Config..Exporter..UNIVERSAL search for DESTROY then AUTOLOAD
+sub DESTROY { }
+
 tie %Config, 'Config';
 
 1;
@@ -274,6 +309,79 @@ The Config module is installed into the architecture and version
 specific library directory ($Config{installarchlib}) and it checks the
 perl version number when loaded.
 
+The values stored in config.sh may be either single-quoted or
+double-quoted. Double-quoted strings are handy for those cases where you
+need to include escape sequences in the strings. To avoid runtime variable
+interpolation, any C<$> and C<@> characters are replaced by C<\$> and
+C<\@>, respectively. This isn't foolproof, of course, so don't embed C<\$>
+or C<\@> in double-quoted strings unless you're willing to deal with the
+consequences. (The slashes will end up escaped and the C<$> or C<@> will
+trigger variable interpolation)
+
+=head1 GLOSSARY
+
+Most C<Config> variables are determined by the C<Configure> script
+on platforms supported by it (which is most UNIX platforms).  Some
+platforms have custom-made C<Config> variables, and may thus not have
+some of the variables described below, or may have extraneous variables
+specific to that particular port.  See the port specific documentation
+in such cases.
+
+ENDOFTAIL
+
+open(GLOS, "<$glossary") or die "Can't open $glossary: $!";
+%seen = ();
+$text = 0;
+$/ = '';
+
+sub process {
+  s/\A(\w*)\s+\(([\w.]+)\):\s*\n(\t?)/=item C<$1>\n\nFrom F<$2>:\n\n/m;
+  my $c = substr $1, 0, 1;
+  unless ($seen{$c}++) {
+    print CONFIG <<EOF if $text;
+=back
+
+EOF
+    print CONFIG <<EOF;
+=head2 $c
+
+=over
+
+EOF
+    $text = 1;
+  }
+  s/n't/n\00t/g;               # leave can't, won't etc untouched
+  s/^\t\s+(.*)/\n\t$1\n/gm;    # Indented lines ===> paragraphs
+  s/^(?<!\n\n)\t(.*)/$1/gm;    # Not indented lines ===> text
+  s{([\'\"])(?=[^\'\"\s]*[./][^\'\"\s]*\1)([^\'\"\s]+)\1}(F<$2>)g; # '.o'
+  s{([\'\"])([^\'\"\s]+)\1}(C<$2>)g; # "date" command
+  s{\'([A-Za-z_\- *=/]+)\'}(C<$1>)g; # 'ln -s'
+  s{
+     (?<! [\w./<\'\"] )                # Only standalone file names
+     (?! e \. g \. )           # Not e.g.
+     (?! \. \. \. )            # Not ...
+     (?! \d )                  # Not 5.004
+     ( [\w./]* [./] [\w./]* )  # Require . or / inside
+     (?<! \. (?= \s ) )                # Do not include trailing dot
+     (?! [\w/] )               # Include all of it
+   }
+   (F<$1>)xg;                  # /usr/local
+  s/((?<=\s)~\w*)/F<$1>/g;     # ~name
+  s/(?<![.<\'\"])\b([A-Z_]{2,})\b(?![\'\"])/C<$1>/g;   # UNISTD
+  s/(?<![.<\'\"])\b(?!the\b)(\w+)\s+macro\b/C<$1> macro/g; # FILE_cnt macro
+  s/n[\0]t/n't/g;              # undo can't, won't damage
+}
+
+<GLOS>;                                # Skip the preamble
+while (<GLOS>) {
+  process;
+  print CONFIG;
+}
+
+print CONFIG <<'ENDOFTAIL';
+
+=back
+
 =head1 NOTE
 
 This module contains a good example of how to use tie to implement a
@@ -285,6 +393,7 @@ outside of it.
 ENDOFTAIL
 
 close(CONFIG);
+close(GLOS);
 
 # Now do some simple tests on the Config.pm file we have created
 unshift(@INC,'lib');