add indentation level to multiline qw when -xci set

diff --git a/lib/Perl/Tidy/Formatter.pm b/lib/Perl/Tidy/Formatter.pm
index fff7daf98f650ec0f49f181f8c60103949ffbc36..9016df9e1ddde11b325b242e65e74f37a90de9e3 100644 (file)
--- a/lib/Perl/Tidy/Formatter.pm
+++ b/lib/Perl/Tidy/Formatter.pm
@@ -413,6 +413,7 @@ BEGIN {
         _rending_multiline_qw_seqno_by_K_   => $i++,
         _rKrange_multiline_qw_by_seqno_     => $i++,
         _rcontains_multiline_qw_by_seqno_   => $i++,
+        _rmultiline_qw_has_extra_level_     => $i++,
     };
 
     # Array index names for _this_batch_ (in above list)
@@ -749,6 +750,7 @@ sub new {
     $self->[_rending_multiline_qw_seqno_by_K_]   = {};
     $self->[_rKrange_multiline_qw_by_seqno_]     = {};
     $self->[_rcontains_multiline_qw_by_seqno_]   = {};
+    $self->[_rmultiline_qw_has_extra_level_]     = {};
 
     # This flag will be updated later by a call to get_save_logfile()
     $self->[_save_logfile_] = defined($logger_object);
@@ -5922,7 +5924,7 @@ sub parent_seqno_by_K {
     # hash was greater because this routine is called once per line whereas a
     # hash must be created token-by-token.
 
-    my $rLL = $self->[_rLL_];
+    my $rLL   = $self->[_rLL_];
     my $KNEXT = $KK;
 
     # For example, consider the following with seqno=5 of the '[' and ']'
@@ -7078,10 +7080,25 @@ sub weld_nested_quotes {
             $rweld_len_left_closing->{$outer_seqno}  = 1;
             $rweld_len_right_opening->{$outer_seqno} = 2;
 
-            # QW PATCH 1 (Testing)
-            # undo CI for welded quotes
-            foreach my $K ( $Kn .. $Kt_end ) {
-                $rLL->[$K]->[_CI_LEVEL_] = 0;
+            # Undo one indentation level if an extra level was added to this
+            # multiline quote
+            my $qw_seqno = $self->[_rstarting_multiline_qw_seqno_by_K_]->{$Kn};
+            if (   $qw_seqno
+                && $self->[_rmultiline_qw_has_extra_level_]->{$qw_seqno} )
+            {
+                foreach my $K ( $Kn + 1 .. $Kt_end - 1 ) {
+                    $rLL->[$K]->[_LEVEL_] -= 1;
+                }
+                $rLL->[$Kn]->[_CI_LEVEL_]     = 0;
+                $rLL->[$Kt_end]->[_CI_LEVEL_] = 0;
+            }
+
+            # undo CI for other welded quotes
+            else {
+
+                foreach my $K ( $Kn .. $Kt_end ) {
+                    $rLL->[$K]->[_CI_LEVEL_] = 0;
+                }
             }
 
             # Change the level of a closing qw token to be that of the outer
@@ -7748,6 +7765,7 @@ sub find_multiline_qw {
     my $rending_multiline_qw_seqno_by_K   = {};
     my $rKrange_multiline_qw_by_seqno     = {};
     my $rcontains_multiline_qw_by_seqno   = {};
+    my $rmultiline_qw_has_extra_level     = {};
 
     my $rlines = $self->[_rlines_];
     my $rLL    = $self->[_rLL_];
@@ -7801,6 +7819,41 @@ EOM
         }
     }
 
+    # Give multiline qw lists extra indentation instead of CI.  This option
+    # works well but is currently only activated when the -xci flag is set.
+    # The reason is to avoid unexpected changes in formatting.
+    if ( $rOpts->{'extended-continuation-indentation'} ) {
+        while ( my ( $qw_seqno, $rKrange ) =
+            each %{$rKrange_multiline_qw_by_seqno} )
+        {
+            my ( $Kbeg, $Kend ) = @{$rKrange};
+
+            # require isolated closing token
+            my $token_end = $rLL->[$Kend]->[_TOKEN_];
+            next
+              unless ( length($token_end) == 1
+                && ( $is_closing_token{$token_end} || $token_end eq '>' ) );
+
+            # require isolated opening token
+            my $token_beg = $rLL->[$Kbeg]->[_TOKEN_];
+
+            # allow space(s) after the qw
+            if ( length($token_beg) > 3 && substr( $token_beg, 2, 1 ) eq ' ' ) {
+                $token_beg =~ s/\s+//;
+            }
+
+            next unless ( length($token_beg) == 3 );
+
+            foreach my $KK ( $Kbeg + 1 .. $Kend - 1 ) {
+                $rLL->[$KK]->[_LEVEL_]++;
+                $rLL->[$KK]->[_CI_LEVEL_] = 0;
+            }
+
+            # set flag for -wn option, which will remove the level
+            $rmultiline_qw_has_extra_level->{$qw_seqno} = 1;
+        }
+    }
+
     # For the -lp option we need to mark all parent containers of
     # multiline quotes
     if ($rOpts_line_up_parentheses) {
@@ -7847,6 +7900,7 @@ EOM
     $self->[_rKrange_multiline_qw_by_seqno_] = $rKrange_multiline_qw_by_seqno;
     $self->[_rcontains_multiline_qw_by_seqno_] =
       $rcontains_multiline_qw_by_seqno;
+    $self->[_rmultiline_qw_has_extra_level_] = $rmultiline_qw_has_extra_level;
 
     return;
 }

diff --git a/local-docs/BugLog.pod b/local-docs/BugLog.pod
index 8cef02a8439d4373d3a8010af5beaac9b3694525..7ed103a8a28706571e65dd24dfd95598569db462 100644 (file)
--- a/local-docs/BugLog.pod
+++ b/local-docs/BugLog.pod
@@ -2,6 +2,50 @@
 
 =over 4
 
+=item B<Improve indentation of multiline qw quotes when -xci flag is set>
+
+The indentation of multiline qw quotes runs into problems when there is nesting,
+as in the following.
+
+    # OLD: perltidy -xci -ci=4
+    for my $feep (
+        qw{
+        pwage      pwchange   pwclass    pwcomment
+        pwexpire   pwgecos    pwpasswd   pwquota
+        }
+        )
+
+The problem is that multiline qw quotes do not get the same indentation
+treatment as lists. 
+
+This update fixes this in the following circumstances:
+
+  - the leading qw( and trailing ) are on separate lines
+  - the closing token is one of ) } ] >
+  - the -xci flag is set
+
+The above example becomes
+
+    # NEW: perltidy -xci -ci=4
+    for my $feep (
+        qw{
+            pwage      pwchange   pwclass    pwcomment
+            pwexpire   pwgecos    pwpasswd   pwquota
+        }
+        )
+
+The reason that the -xci flag is required is to minimize unexpected changes to
+existing scripts.  The extra indentation is removed if the -wn flag is also
+given, so both old and new versions with -wn give
+
+    # OLD and NEW: perltidy -wn -xci -ci=4
+    for my $feep ( qw{
+        pwage      pwchange   pwclass    pwcomment
+        pwexpire   pwgecos    pwpasswd   pwquota
+    } )
+
+This update added 8 Jan 2021.
+
 =item B<Improve alignment of leading equals in rare situation>
 
 A rare case in which a vertical alignment opportunity of leading equals was