From 7ac316ad35c4bdc17e5b7e2c852bc041b48b2fec Mon Sep 17 00:00:00 2001
From: Steve Hancock <perltidy@users.sourceforge.net>
Date: Sun, 18 Sep 2022 11:32:24 -0700
Subject: [PATCH] allow phantom commas

---
 lib/Perl/Tidy/Formatter.pm | 74 ++++++++++++++++++++++++++++----------
 1 file changed, 55 insertions(+), 19 deletions(-)

diff --git a/lib/Perl/Tidy/Formatter.pm b/lib/Perl/Tidy/Formatter.pm
index 7a92d859..d9666469 100644
--- a/lib/Perl/Tidy/Formatter.pm
+++ b/lib/Perl/Tidy/Formatter.pm
@@ -323,6 +323,8 @@ my (
     %line_up_parentheses_control_hash,
     $line_up_parentheses_control_is_lxpl,
 
+    %phantom_token_map,
+
     # regex patterns for text identification.
     # Most are initialized in a sub make_**_pattern during configuration.
     # Most can be configured by user parameters.
@@ -734,6 +736,12 @@ BEGIN {
     push @q, ',';
     @is_counted_type{@q} = (1) x scalar(@q);
 
+    # type => token of possible phantom tokens
+    %phantom_token_map = (
+        ';' => ';',
+        ',' => ',',
+    );
+
 }
 
 {    ## begin closure to count instances
@@ -15281,11 +15289,11 @@ EOM
             $do_not_pad = $self->correct_lp_indentation( $ri_first, $ri_last );
         }
 
-        #--------------------------
-        # unmask phantom semicolons
-        #--------------------------
-        if ( !$tokens_to_go[$imax] && $types_to_go[$imax] eq ';' ) {
-            $self->unmask_phantom_semicolon($imax);
+        #----------------------------------
+        # unmask line-ending phantom tokens
+        #----------------------------------
+        if ( !$tokens_to_go[$imax] ) {
+            $self->unmask_phantom_token($imax);
         }
 
         if ( $rOpts_one_line_block_semicolons == 0 ) {
@@ -15337,24 +15345,52 @@ EOM
         return;
     } ## end sub grind_batch_of_CODE
 
-    sub unmask_phantom_semicolon {
+    sub unmask_phantom_token {
         my ( $self, $imax ) = @_;
-        my $rLL     = $self->[_rLL_];
-        my $i       = $imax;
-        my $tok     = ';';
-        my $tok_len = 1;
-        if ( $want_left_space{';'} != WS_NO ) {
-            $tok     = ' ;';
-            $tok_len = 2;
-        }
-        $tokens_to_go[$i]        = $tok;
-        $token_lengths_to_go[$i] = $tok_len;
-        my $KK = $K_to_go[$i];
+
+        # Turn a phantom token into a real token.
+
+        # Phantom tokens are specially marked token types (such as ';')  with
+        # no token text which only become real tokens if they occur at the end
+        # of an output line.
+
+        # Input parameter:
+        #   $imax = the index in the output batch array of this token.
+        my $type = $types_to_go[$imax];
+
+        # Always ignore deleted side comments
+        return if ( $type eq '#' );
+
+        my $rLL         = $self->[_rLL_];
+        my $KK          = $K_to_go[$imax];
+        my $line_number = 1 + $rLL->[$KK]->[_LINE_INDEX_];
+        my $tok         = $phantom_token_map{$type};
+        if ( !$tok ) {
+
+            # TESTING: unexpected blank token, need to investigate
+            if (DEVEL_MODE) {
+                Fault("no token for phantom type $type at line $line_number\n");
+            }
+            return;
+        }
+        my $tok_len = length($tok);
+        if ( $want_left_space{$type} != WS_NO ) {
+            $tok = ' ' . $tok;
+            $tok_len += 1;
+        }
+        $tokens_to_go[$imax]        = $tok;
+        $token_lengths_to_go[$imax] = $tok_len;
+
         $rLL->[$KK]->[_TOKEN_]        = $tok;
         $rLL->[$KK]->[_TOKEN_LENGTH_] = $tok_len;
-        my $line_number = 1 + $rLL->[$KK]->[_LINE_INDEX_];
-        $self->note_added_semicolon($line_number);
 
+        if ( $type eq ';' ) {
+            $self->note_added_semicolon($line_number);
+        }
+
+        # TODO: could eventually note added comma here
+
+        # This changes the summed lengths of the rest of this batch
         foreach ( $imax .. $max_index_to_go ) {
             $summed_lengths_to_go[ $_ + 1 ] += $tok_len;
         }
-- 
2.39.5