<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<ul id="index">
<li><a href="#Issues-fixed-after-release-20201207">Issues fixed after release 20201207</a></li>
<li><a href="#Issues-fixed-after-release-20201202">Issues fixed after release 20201202</a></li>
<li><a href="#Issues-fixed-after-release-20201001">Issues fixed after release 20201001</a></li>
<li><a href="#Issues-fixed-after-release-20200907">Issues fixed after release 20200907</a></li>
<li><a href="#Open-Issues">Open Issues</a></li>
</ul>
<h1 id="Issues-fixed-after-release-20201207">Issues fixed after release 20201207</h1>
<dl>
<dt id="Improve-indentation-of-multiline-qw-quotes-when--xci-flag-is-set"><b>Improve indentation of multiline qw quotes when -xci flag is set</b></dt>
<dd>
<p>The indentation of multiline qw quotes runs into problems when there is nesting, as in the following.</p>
<pre><code> # OLD: perltidy -xci -ci=4
for my $feep (
qw{
pwage pwchange pwclass pwcomment
pwexpire pwgecos pwpasswd pwquota
}
)</code></pre>
<p>The problem is that multiline qw quotes do not get the same indentation treatment as lists.</p>
<p>This update fixes this in the following circumstances:</p>
<pre><code> - the leading qw( and trailing ) are on separate lines
- the closing token is one of ) } ] >
- the -xci flag is set</code></pre>
<p>The above example becomes</p>
<pre><code> # NEW: perltidy -xci -ci=4
for my $feep (
qw{
pwage pwchange pwclass pwcomment
pwexpire pwgecos pwpasswd pwquota
}
)</code></pre>
<p>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</p>
<pre><code> # OLD and NEW: perltidy -wn -xci -ci=4
for my $feep ( qw{
pwage pwchange pwclass pwcomment
pwexpire pwgecos pwpasswd pwquota
} )</code></pre>
<p>This update added 8 Jan 2021, 474cfa8.</p>
</dd>
<dt id="Improve-alignment-of-leading-equals-in-rare-situation"><b>Improve alignment of leading equals in rare situation</b></dt>
<dd>
<p>A rare case in which a vertical alignment opportunity of leading equals was missed has been fixed. This involved lines with additional varying alignment tokens, such as 'unless' and second '=' in lines 1-3 below. In this example lines 4 and 5 were not 'looking' backwards to align their leading equals.</p>
<pre><code> # OLD:
$them = 'localhost' unless ( $them = shift );
$cmd = '!print' unless ( $cmd = shift );
$port = 2345 unless ( $port = shift );
$saddr = 'S n a4 x8';
$SIG{'INT'} = 'dokill';
# NEW
$them = 'localhost' unless ( $them = shift );
$cmd = '!print' unless ( $cmd = shift );
$port = 2345 unless ( $port = shift );
$saddr = 'S n a4 x8';
$SIG{'INT'} = 'dokill';</code></pre>
<p>Fixed 5 Jan 2021, 9244678.</p>
</dd>
<dt id="Moved-previous-patch-to-a-better-location"><b>Moved previous patch to a better location</b></dt>
<dd>
<p>The previous patch was moved to a location where it only applies if there is a side comment on the line with a closing token. This minimizes changes to other side comment locations.</p>
</dd>
<dt id="Further-improvement-in-rules-for-forgetting-last-side-comment-location"><b>Further improvement in rules for forgetting last side comment location</b></dt>
<dd>
<p>The code for forgetting the last side comment location was rewritten to improve formatting in some edge cases. The update also fixes a very rare problem discovered during testing and illustrated with the following snippet. The problem occurs for the particular combination of parameters -sct -act=2 and when a closing paren has a side comment:</p>
<pre><code> OLD: perltidy -sct -act=2
foreach $line (
[0, 1, 2], [3, 4, 5], [6, 7, 8], # rows
[0, 3, 6], [1, 4, 7], [2, 5, 8], # columns
[0, 4, 8], [2, 4, 6]) # diagonals
NEW: perltidy -sct -act=2
foreach $line (
[0, 1, 2], [3, 4, 5], [6, 7, 8], # rows
[0, 3, 6], [1, 4, 7], [2, 5, 8], # columns
[0, 4, 8], [2, 4, 6]) # diagonals</code></pre>
<p>In the old version the last side comment was aligned before the closing paren was attached to the previous line, causing the final side comment to be far to the right. A patch in the new version just places it at the default location. This is the best than can be done for now, but is preferable to the old formatting. 3 Jan 2021, e57d8db.</p>
</dd>
<dt id="Improve-rule-for-forgetting-last-side-comment-location"><b>Improve rule for forgetting last side comment location</b></dt>
<dd>
<p>The code which aligns side comments remembers the most recent side comment and in some cases tries to start aligning at that column for later side comments. Sometimes the old side comment column was being remembered too long, causing occasional poor formatting and causing a noticable and unexpected drift of side comment locations to the right. The rule for forgetting the previous side comment column has been modified to reduce this problem. The new rule is essentially to forget the previous side comment location at a new side comment with different indentation level or significant number of lines without side comments (about 12). The previous implementation forgetting changes in indentation level across code blocks only. Below is an example where the old method gets into trouble and the new method is ok:</p>
<pre><code> # OLD:
foreach my $r (@$array) {
$Dat{Data}{ uc $r->[0] } = join( ";", @$r ); # store all info
my $name = $Dat{GivenName}{ uc $r->[0] } || $r->[1];
# pass array as ad-hoc string, mark missing values
$Dat{Data}{ uc $r->[0] } = join(
";",
(
uc $r->[0], uc $name, # symbol, name
$r->[2], $r->[3], $r->[4], # price, date, time
$r->[5], $r->[6], # change, %change
$r->[7], "-", "-", "-", # vol, avg vol, bid,ask
$r->[8], $r->[9], # previous, open
"$r->[10] - $r->[11]", $r->[12], # day range,year range,
"-", "-", "-", "-", "-"
)
); # eps,p/e,div,yld,cap
}</code></pre>
<p>The second side comment is at a deeper indentation level but was not being forgotten, causing line length limits to interfere with later alignment. The new rule gives a better result:</p>
<pre><code> # NEW:
foreach my $r (@$array) {
$Dat{Data}{ uc $r->[0] } = join( ";", @$r ); # store all info
my $name = $Dat{GivenName}{ uc $r->[0] } || $r->[1];
# pass array as ad-hoc string, mark missing values
$Dat{Data}{ uc $r->[0] } = join(
";",
(
uc $r->[0], uc $name, # symbol, name
$r->[2], $r->[3], $r->[4], # price, date, time
$r->[5], $r->[6], # change, %change
$r->[7], "-", "-", "-", # vol, avg vol, bid,ask
$r->[8], $r->[9], # previous, open
"$r->[10] - $r->[11]", $r->[12], # day range,year range,
"-", "-", "-", "-", "-"
)
); # eps,p/e,div,yld,cap
}</code></pre>
<p>The following exampel shows an unexpected alignment in the cascade of trailing comments which are aligned but slowly separating from their closing containers:</p>
<pre><code> # OLD:
{
$a = [
Cascade => $menu_cb,
-menuitems => [
[ Checkbutton => 'Oil checked', -variable => \$OIL ],
[
Button => 'See current values',
-command => [
\&see_vars, $TOP,
], # end see_vars
], # end button
], # end checkbutton menuitems
]; # end checkbuttons cascade
}</code></pre>
<p>This was caused by forgetting side comments only across code block changes. The new result is more reasonable:</p>
<pre><code> # NEW:
{
$a = [
Cascade => $menu_cb,
-menuitems => [
[ Checkbutton => 'Oil checked', -variable => \$OIL ],
[
Button => 'See current values',
-command => [
\&see_vars, $TOP,
], # end see_vars
], # end button
], # end checkbutton menuitems
]; # end checkbuttons cascade
}</code></pre>
<p>This change will cause occasional differences in side comment locations from previous versions but overall it gives fewer unexpected results so it is a worthwhile change. 29-Dec-2020, 76993f4.</p>
</dd>
<dt id="Fixed-very-minor-inconsistency-in-redefining-lists-after-prune-step"><b>Fixed very minor inconsistency in redefining lists after prune step</b></dt>
<dd>
<p>In rare cases it is necessary to update the type of lists, and this influences vertical alignment. This update fixes a minor inconsistency in doing this. In some rare cases with complex list elements vertical alignment can be improved. 27 Dec, 2020, 751faec.</p>
<pre><code> # OLD
return join( '',
$pre, '<IMG ', $iconsizes{$alt} || '',
$align, 'BORDER=', $nav_border,
' ALT="', $alt, "\"\n",
' SRC="', $ICONSERVER, "/$icon",
'">' );
# NEW
return join( '',
$pre, '<IMG ', $iconsizes{$alt} || '',
$align, 'BORDER=', $nav_border,
' ALT="', $alt, "\"\n",
' SRC="', $ICONSERVER, "/$icon",
'">' );</code></pre>
</dd>
<dt id="Improved-vertical-alignment-of-some-edge-cases"><b>Improved vertical alignment of some edge cases</b></dt>
<dd>
<p>The existing rules for aligning two lines with very different lengths were rejecting some good alignments, such as the first line of numbers in the example below:</p>
<pre><code> # OLD:
@gg_3 = (
[
0.0, 1.360755E-2, 9.569446E-4, 9.569446E-4,
1.043498E-3, 1.043498E-3
],
[
9.569446E-4, 9.569446E-4, 0.0, 7.065964E-5,
1.422811E-4, 1.422811E-4
],
...
);
# NEW:
@gg_3 = (
[
0.0, 1.360755E-2, 9.569446E-4, 9.569446E-4,
1.043498E-3, 1.043498E-3
],
[
9.569446E-4, 9.569446E-4, 0.0, 7.065964E-5,
1.422811E-4, 1.422811E-4
],
...
);</code></pre>
<p>The rule in sub 'two_line_pad' was updated to allow alignment of any lists if the patterns match exactly (all numbers in this case). Updated 27-Dec-2020, 035d2b7.</p>
</dd>
<dt id="Avoid--lp-style-formatting-of-lists-containing-multiline-qw-quotes"><b>Avoid -lp style formatting of lists containing multiline qw quotes</b></dt>
<dd>
<p>The -lp formatting style often does not work well when lists contain multiline qw quotes. This update avoids this problem by not formatting such lists with the -lp style. For example,</p>
<pre><code> # OLD, perltidy -gnu
@EXPORT = (
qw(
i Re Im rho theta arg
sqrt log ln
log10 logn cbrt root
cplx cplxe
),
@trig,
);
# NEW, perltidy -gnu
@EXPORT = (
qw(
i Re Im rho theta arg
sqrt log ln
log10 logn cbrt root
cplx cplxe
),
@trig,
);</code></pre>
<p>27-Dec-2020, 948c9bd.</p>
</dd>
<dt id="improve-formatting-of-multiline-qw"><b>improve formatting of multiline qw</b></dt>
<dd>
<p>This update adds a sequence numbering system for multiline qw quotes. In the perltidy tokenizer normal container pair types, like { }, (), [], are given unique serial numbers which are used as keys to data structures. qw quoted lists do not get serial numbers by the tokenizer, so this update creates a separate serial number scheme for them to correct this problem. One formatting problem that this solves is that of preventing the closing token of a multiline quote from being outdented more than the opening token. This is a general formatting rule which should be followed. Without a sequence number, the closing qw token could not lookup its corresponding opening indentation so it had to resort to a default, breaking the rule, as in the following:</p>
<pre><code> # OLD, perltidy -wn
# qw line
if ( $pos == 0 ) {
@return = grep( /^$word/,
sort qw(
! a b d h i m o q r u autobundle clean
make test install force reload look
) ); #<-- outdented more than 'sort'
}
# Here is the same with a list instead of a qw; note how the
# closing sort paren does not outdent more than the 'sort' line.
# This is the desired result for qw.
# perltidy -wn
if ( $pos == 0 ) {
@return = grep( /^$word/,
sort (
'!', 'a', 'b', 'd', 'h', 'i', 'm', 'o', 'q', 'r', 'u',
'autobundle', 'clean',
'make', 'test', 'install', 'force', 'reload', 'look'
) ); #<-- not outdented more than 'sort'
}
# NEW (perltidy -wn)
if ( $pos == 0 ) {
@return = grep( /^$word/,
sort qw(
! a b d h i m o q r u autobundle clean
make test install force reload look
) ); #<-- not outdented more than sort
}</code></pre>
<p>Here is another example # OLD: $_->meta->make_immutable( inline_constructor => 0, constructor_name => "_new", inline_accessors => 0, ) for qw( Class::XYZ::Package Class::XYZ::Module Class::XYZ::Class</p>
<pre><code> Class::XYZ::Overload
); #<-- outdented more than the line with 'for qw('
# NEW:
$_->meta->make_immutable(
inline_constructor => 0,
constructor_name => "_new",
inline_accessors => 0,
)
for qw(
Class::XYZ::Package
Class::XYZ::Module
Class::XYZ::Class
Class::XYZ::Overload
); #<-- outdented same as the line with 'for qw('</code></pre>
<p>26 Dec 2020, cdbf0e4.</p>
</dd>
<dt id="improve-list-marking-method"><b>improve list marking method</b></dt>
<dd>
<p>In the process of making vertical alignments, lines which are simple lists of items are treated different from other lines. The old method for finding and marking these lines had a few problems which are corrected with this update. The main problem was that the old method ran into trouble when there were side comments. For example, the old method was not marking the following list and as a result the two columns of values were not aligned:</p>
<pre><code> # OLD
return (
$startpos, $ldelpos - $startpos, # PREFIX
$ldelpos, 1, # OPENING BRACKET
$ldelpos + 1, $endpos - $ldelpos - 2, # CONTENTS
$endpos - 1, 1, # CLOSING BRACKET
$endpos, length($$textref) - $endpos, # REMAINDER
);
# NEW
return (
$startpos, $ldelpos - $startpos, # PREFIX
$ldelpos, 1, # OPENING BRACKET
$ldelpos + 1, $endpos - $ldelpos - 2, # CONTENTS
$endpos - 1, 1, # CLOSING BRACKET
$endpos, length($$textref) - $endpos, # REMAINDER
);</code></pre>
<p>Another problem was that occasionally unwanted alignments were made between lines which were not really lists because the lines were incorrectly marked. For example (note padding after first comma)</p>
<pre><code> # OLD: (undesirable alignment)
my ( $isig2, $chisq ) = ( 1 / ( $sig * $sig ), 0 );
my ( $ym, $al, $cov, $bet, $olda, $ochisq, $di, $pivt, $info ) =
map { null } ( 0 .. 8 );
# NEW: (no alignment)
my ( $isig2, $chisq ) = ( 1 / ( $sig * $sig ), 0 );
my ( $ym, $al, $cov, $bet, $olda, $ochisq, $di, $pivt, $info ) =
map { null } ( 0 .. 8 );</code></pre>
<p>This update was made 22 Dec 2020, 36d4c35.</p>
</dd>
<dt id="Fix-git-51-closing-quote-pattern-delimiters-not-following--cti-flag-settings"><b>Fix git #51, closing quote pattern delimiters not following -cti flag settings</b></dt>
<dd>
<p>Closing pattern delimiter tokens of qw quotes were not following the -cti flag settings for containers in all cases, as would be expected, in particular when followed by a comma. For example, the closing qw paren below was indented with continuation indentation but would not have that extra indentation if it followed the default -cpi setting for a paren:</p>
<pre><code> # OLD:
@EXPORT = (
qw(
i Re Im rho theta arg
sqrt log ln
log10 logn cbrt root
cplx cplxe
),
@trig
);
# NEW
@EXPORT = (
qw(
i Re Im rho theta arg
sqrt log ln
log10 logn cbrt root
cplx cplxe
),
@trig
);</code></pre>
<p>This update makes closing qw quote terminators follow the settings for their corresponding container tokens as closely as possible. For a closing '>' the setting for a closing paren will now be followed. Other closing qw terminators will remain indented, to minimize changes to existing formatting. For example ('>' is outdented):</p>
<pre><code> @EXPORT = (
qw<
i Re Im rho theta arg
sqrt log ln
log10 logn cbrt root
cplx cplxe
>,
@trig
);</code></pre>
<p>but (';' remains indented):</p>
<pre><code> @EXPORT = (
qw;
i Re Im rho theta arg
sqrt log ln
log10 logn cbrt root
cplx cplxe
;,
@trig
);</code></pre>
<p>This update was added 18 Dec 2020 and modified 24 Dec 2020, 538688f.</p>
</dd>
<dt id="Update-manual-pages-regarding-issue-git-50"><b>Update manual pages regarding issue git #50</b></dt>
<dd>
<p>Additional wording was added to the man pages regarding situations in which perltidy does not change whitespace. This update was added 17 Dec 2020.</p>
</dd>
<dt id="Rewrote-sub-check_match"><b>Rewrote sub check_match</b></dt>
<dd>
<p>Moved inner part of sub check_match into sub match_line_pair in order to make info available earlier. This gave some minor alignment improvements. This was done 16 Dec 2020, 7ba4f3b.</p>
<pre><code> # OLD:
@tests = (
@common, '$_',
'"\$_"', '@_',
'"\@_"', '??N',
'"??N"', chr 256,
'"\x{100}"', chr 65536,
'"\x{10000}"', ord 'N' == 78 ? ( chr 11, '"\013"' ) : ()
);
# NEW:
@tests = (
@common, '$_',
'"\$_"', '@_',
'"\@_"', '??N',
'"??N"', chr 256,
'"\x{100}"', chr 65536,
'"\x{10000}"', ord 'N' == 78 ? ( chr 11, '"\013"' ) : ()
);</code></pre>
</dd>
<dt id="Improved-vertical-alignments-by-avoiding-pruning-step"><b>Improved vertical alignments by avoiding pruning step</b></dt>
<dd>
<p>There is a step in vertical alignment where the alignments are formed into a tree with different levels, and some deeper levels are pruned to preserve lower level alignments. This usually works well, but some deeper alignments will be lost, which is what was happening in the example below. It turns out that if the tree pruning is skipped when alignment depths increase monotonically across lines, as in the example, then better overall alignment is achieved by the subsequent 'sweep' pass.</p>
<pre><code> # OLD
my $cmd = shift @ARGV;
if ( $cmd eq "new" ) { $force_new = 1; }
elsif ( $cmd eq "interactive" ) { $interactive = 1; $batch = 0; }
elsif ( $cmd eq "batch" ) { $batch = 1; $interactive = 0; }
elsif ( $cmd eq "use_old" ) { $use_old = 1; }
elsif ( $cmd eq "show" ) { $show = 1; last; }
elsif ( $cmd eq "showall" ) { $showall = 1; last; }
elsif ( $cmd eq "show_all" ) { $showall = 1; last; }
elsif ( $cmd eq "remove" ) { $remove = 1; last; }
elsif ( $cmd eq "help" ) { $help = 1; last; }
# NEW
my $cmd = shift @ARGV;
if ( $cmd eq "new" ) { $force_new = 1; }
elsif ( $cmd eq "interactive" ) { $interactive = 1; $batch = 0; }
elsif ( $cmd eq "batch" ) { $batch = 1; $interactive = 0; }
elsif ( $cmd eq "use_old" ) { $use_old = 1; }
elsif ( $cmd eq "show" ) { $show = 1; last; }
elsif ( $cmd eq "showall" ) { $showall = 1; last; }
elsif ( $cmd eq "show_all" ) { $showall = 1; last; }
elsif ( $cmd eq "remove" ) { $remove = 1; last; }
elsif ( $cmd eq "help" ) { $help = 1; last; }</code></pre>
<p>This update was made 14 Dec 2020, 44e0afa.</p>
</dd>
<dt id="Improved-some-marginal-vertical-alignments"><b>Improved some marginal vertical alignments</b></dt>
<dd>
<p>This update fixed a rare situation in which some vertical alignment was missed. The problem had to do with two lines being incorrectly marked as a marginal match. A new routine, 'match_line_pairs' was added to set a flag with the information needed to detect and prevent this. This fix was made 13 Dec 2020, 9a8e49b.</p>
<pre><code> # OLD
$sec = $sec + ( 60 * $min );
$graphcpu[$sec] = $line;
$secmax = $sec if ( $sec > $secmax );
$linemax = $line if ( $line > $linemax );
# NEW
$sec = $sec + ( 60 * $min );
$graphcpu[$sec] = $line;
$secmax = $sec if ( $sec > $secmax );
$linemax = $line if ( $line > $linemax );</code></pre>
</dd>
<dt id="Do-not-align-equals-across-changes-in-continuation-indentation"><b>Do not align equals across changes in continuation indentation</b></dt>
<dd>
<p>A rule was added to prevent vertical alignment of lines with leading '=' across a change in continuation indentation. Sometimes aligning across a change in CI can come out okay, but sometimes it can be very poor. For example:</p>
<pre><code> # BAD:
$! = 2, die qq/$0: can't stat -${arg}'s "$file"./
unless $time = ( stat($file) )[$STAT_MTIME];
# FIXED:
$! = 2, die qq/$0: can't stat -${arg}'s "$file"./
unless $time = ( stat($file) )[$STAT_MTIME];</code></pre>
<p>The second line is a continuation of the first, and this update prevents this alignment. The above 'BAD' formatting was in the previous developmental version of perltidy, not the previous release. This update added 12 Dec 2020, 5b56147.</p>
</dd>
<dt id="Improve-vertical-alignment-in-some-two-line-matches"><b>Improve vertical alignment in some two-line matches</b></dt>
<dd>
<p>When two lines would be perfectly aligned except for the line length limit, previously they would only be aligned if they had a common leading equals. The update removes this restriction and allows as many alignments to be made as possible. The results are generally improved. This update was made 11 Dec 2020, f3c6cd8. Some examples:</p>
<p># In this example the side comments were limiting the matches</p>
<pre><code> # OLD
shift @data if @data and $data[0] =~ /Contributed\s+Perl/; # Skip header
pop @data if @data and $data[-1] =~ /^\w/; # Skip footer, like
# NEW
shift @data if @data and $data[0] =~ /Contributed\s+Perl/; # Skip header
pop @data if @data and $data[-1] =~ /^\w/; # Skip footer, like</code></pre>
<p># The same is true here.</p>
<pre><code> # OLD
if ($tvg::o_span) { $tvg::hour_span = $tvg::o_span; }
if ( $tvg::hour_span % 2 > 0 ) { $tvg::hour_span++; } # Multiple of 2
# NEW
if ($tvg::o_span) { $tvg::hour_span = $tvg::o_span; }
if ( $tvg::hour_span % 2 > 0 ) { $tvg::hour_span++; } # Multiple of 2</code></pre>
<p>In the next example, the first comma is now aligned but not the second, because of the line length limit:</p>
<pre><code> # OLD
is( MyClass->meta, $mc, '... these metas are still the same thing' );
is( MyClass->meta->meta, $mc->meta, '... these meta-metas are the same thing' );
# NEW
is( MyClass->meta, $mc, '... these metas are still the same thing' );
is( MyClass->meta->meta, $mc->meta, '... these meta-metas are the same thing' );</code></pre>
<p>In this last example, the first comma is not aligned, but alignment resumes after the second comma.</p>
<pre><code> # OLD
is( $obj->name, $COMPRESS_FILE, " Name now set to '$COMPRESS_FILE'" );
is( $obj->prefix, '', " Prefix now empty" );
# NEW
is( $obj->name, $COMPRESS_FILE, " Name now set to '$COMPRESS_FILE'" );
is( $obj->prefix, '', " Prefix now empty" );</code></pre>
</dd>
<dt id="Improve-vertical-alignment-in-some-marginal-matches"><b>Improve vertical alignment in some marginal matches</b></dt>
<dd>
<p>In perltidy a 'marginal match' occurs for example when two lines share some alignment tokens but are somewhat different. When this happens some limits are placed on the size of the padding spaces that can be introduced. In this update the amount of allowed padding is significatly increased for certain 'good' alignment tokens. Results of extensive testing were favorable provided that the change is restricted to alignments of '=', 'if' and 'unless'. Update made 10 Dec 2020, a585f0b.</p>
<pre><code> # OLD
my @roles = $self->role_names;
my $role_names = join "|", @roles;
# NEW
my @roles = $self->role_names;
my $role_names = join "|", @roles;
# OLD
$sysname .= 'del' if $self->label =~ /deletion/;
$sysname .= 'ins' if $self->label =~ /insertion/;
$sysname .= uc $self->allele_ori->seq if $self->allele_ori->seq;
# NEW
$sysname .= 'del' if $self->label =~ /deletion/;
$sysname .= 'ins' if $self->label =~ /insertion/;
$sysname .= uc $self->allele_ori->seq if $self->allele_ori->seq;</code></pre>
</dd>
<dt id="Improve-vertical-alignment-of-lines-ending-in-fat-comma"><b>Improve vertical alignment of lines ending in fat comma</b></dt>
<dd>
<p>A minor adjustment was made to the rule for aligning lines which end in '=>'. When there are just two lines in an alignment group, the alignment is avoided if the first of the two ends in a '=>'. Previously, alignment was avoided if either ended in a '=>'. The old rule was preventing some good alignments in a later stage of the iteration. In the following example, the last two lines are processed separately because they do not match the comma in 'sprintf'. The new rule allows the fat comma alignment to eventually get made later in the iteration. Update made 9 Dec 2020, ca0ddf4.</p>
<pre><code> # OLD
$template->param(
classlist => $classlist,
...,
suggestion => $suggestion,
totspent => sprintf( "%.2f", $totspent ),
totcomtd => sprintf( "%.2f", $totcomtd ),
totavail => sprintf( "%.2f", $totavail ),
nobudget => $#results == -1 ? 1 : 0,
intranetcolorstylesheet =>
C4::Context->preference("intranetcolorstylesheet"),
...
);
# NEW
$template->param(
classlist => $classlist,
...,
suggestion => $suggestion,
totspent => sprintf( "%.2f", $totspent ),
totcomtd => sprintf( "%.2f", $totcomtd ),
totavail => sprintf( "%.2f", $totavail ),
nobudget => $#results == -1 ? 1 : 0,
intranetcolorstylesheet =>
C4::Context->preference("intranetcolorstylesheet"),
...
);</code></pre>
</dd>
<dt id="Avoid-processing-a-file-more-than-once"><b>Avoid processing a file more than once</b></dt>
<dd>
<p>In the unlikely event that a user enters a filename more than once on the command line to perltidy, as for 'file1.pl' here</p>
<pre><code> perltidy file1.pl file1.pl </code></pre>
<p>then that file will be processed more than once. This looks harmless, but if the user was also using the -b (backup) parameter, then the original backup would be overwritten, which is not good. To avoid this, a filter has been placed on the list of files to remove duplicates. 9 Dec 2020, 646a542.</p>
</dd>
<dt id="Fix-for-issue-git-49-exit-status-not-correctly-set"><b>Fix for issue git #49, exit status not correctly set</b></dt>
<dd>
<p>The exit status flag was not being set for the -w option if the -se or if the -q flag were set. Issue git #44 was similar but a special case of the problem. The problem was fixed 8 Dec 2020, cb6028f.</p>
</dd>
</dl>
<h1 id="Issues-fixed-after-release-20201202">Issues fixed after release 20201202</h1>
<dl>
<dt id="Fix-for-issue-git-47"><b>Fix for issue git #47</b></dt>
<dd>
<p>This issue has to do with the --weld-nested-containers option in the specific case of formatting a function which returns a list of anonymous subs. For example</p>
<pre><code> $promises[$i]->then(
sub { $all->resolve(@_); () },
sub {
$results->[$i] = [@_];
$all->reject(@$results) if --$remaining <= 0;
return ();
}
);</code></pre>
<p>A bug introduced in v20201202 caused an incorrect welding to occur when the -wn flag was set</p>
<pre><code> $promises[$i]->then( sub { $all->resolve(@_); () },
sub {
$results->[$i] = [@_];
$all->reject(@$results) if --$remaining <= 0;
return ();
} );</code></pre>
<p>This bug has been fixed, and code which has been incorrectly formatted will be correctly formatted with the next release. The bug was a result of a new coding introduced in v20201202 for fixing some issues with parsing sub signatures. Previously they were sometimes parsed the same as prototypes and sometimes as lists, now they are always parsed as lists. Fixed 6 Dec 2020, 6fd0c4f.</p>
</dd>
</dl>
<h1 id="Issues-fixed-after-release-20201001">Issues fixed after release 20201001</h1>
<dl>
<dt id="removed-excess-spaces-in-a-package-declaration"><b>removed excess spaces in a package declaration</b></dt>
<dd>
<p>Testing revealed that for a line such as</p>
<pre><code> package Bob::Dog;</code></pre>
<p>which has extra spaces or even tabs after the keyword 'package', the extra spaces or tabs were not being removed. This was fixed 28 Nov 2020, 008443d. The line now formats to</p>
<pre><code> package Bob::Dog;</code></pre>
</dd>
<dt id="do-not-automatically-delete-closing-side-comments-with---indent-only"><b>do not automatically delete closing side comments with --indent-only</b></dt>
<dd>
<p>For the parameter combination --indent-only and --closing-side-comments, old closing side comments were getting deleted but new closing side comments were not made. A fix was made to prevent this deletion. This fix was made 27 Nov 2020, 957e0ca.</p>
</dd>
<dt id="fix-to-stop-at-1-iteration-when-using---indent-only"><b>fix to stop at 1 iteration when using --indent-only</b></dt>
<dd>
<p>Previously, for the combination --indent-only and -conv, two iterations would be done. Only one iteration is necessary in this case. Fix made 23 Nov 2020, ae493d8.</p>
</dd>
<dt id="fix-for-formatting-signed-numbers-with-spaces"><b>fix for formatting signed numbers with spaces</b></dt>
<dd>
<p>In developing an improved convergence test, an issue slowing convergence was found related to signed numbers as in the following line,</p>
<pre><code> @london = (deg2rad(- 0.5), deg2rad(90 - 51.3));</code></pre>
<p>The leading '-' here is separated from the following number '0.5'. This is handled by tokenizing the minus as type 'm' and the number as type 'n'. The whitespace between them is removed in formatting, and so the space is gone in the output. But a little problem is that the default rule for placing spaces within the parens is based on the token count, after the first formatting the result is</p>
<pre><code> @london = ( deg2rad( -0.5 ), deg2rad( 90 - 51.3 ) );</code></pre>
<p>The next time it is formatted, the '-0.5' counts as one token, resulting in</p>
<pre><code> @london = ( deg2rad(-0.5), deg2rad( 90 - 51.3 ) );</code></pre>
<p>Notice that the space within the parens around the '-0.5' is gone. An update was made to fix this, so that the final state is reached in one step. This fix was made 23 Nov 2020, f477c8b.</p>
</dd>
<dt id="fix-to-prevent-conversion-of-a-block-comment-to-hanging-side-comment"><b>fix to prevent conversion of a block comment to hanging side comment</b></dt>
<dd>
<p>A rare situation was identified during testing in which a block comment could be converted to be a hanging side comment. For example:</p>
<pre><code> sub macro_get_names { #
#
# %name = macro_get_names(); (key=macrohandle, value=macroname)
#
local (%name) = ();
...
}</code></pre>
<p>For the following specific contitions the block comment in line 2 could be converted into a hanging side comment, which is undesirable:</p>
<pre><code> 1. The line contains nothing except for a '#' with no leading space
2. It follows a line with side comment
3. It has indentation level > 0</code></pre>
<p>An update was made to prevent this from happening. There are two cases, depending on the value of --maximum-consecutive-blank-lines, or -mbl. If this value is positive (the default) then a blank line is inserted above the block comment to prevent it from becoming a hanging side comment. If this -mbl is zero, then the comment is converted to be a static block comment which again prevents it from becoming a hanging side comment. This fix was made 23 Nov 2020, 2eb3de1.</p>
</dd>
<dt id="improved-convergence-test"><b>improved convergence test</b></dt>
<dd>
<p>A better test for convergence has been added. When iterations are requested, the new test will stop after the first pass if no changes in line break locations are made. Previously, at least two passes were required to verify convergnece unless the output stream had the same checksum as the input stream. Extensive testing has been made to verify the correctness of the new test. This update was made 23 Nov 2020, 29efb63.</p>
</dd>
<dt id="fixed-problem-with-vertical-alignments-involving-if-statements"><b>fixed problem with vertical alignments involving 'if' statements</b></dt>
<dd>
<p>An update was made to break vertical alignment when a new sequence of if-like statements or ternary statements is encountered. This situation was causing a loss of alignment in some cases. For example</p>
<pre><code> OLD:
$m1 = 0;
if ( $value =~ /\bset\b/i ) { $m0 = 1; }
if ( $value =~ /\barithmetic/i ) { $m1 = 1; }
if ( $m0 && !$m1 ) { $CONFIG[1] = 0; }
elsif ( !$m0 && $m1 ) { $CONFIG[1] = 1; }
else { $ok = 0; last; }
NEW:
$m1 = 0;
if ( $value =~ /\bset\b/i ) { $m0 = 1; }
if ( $value =~ /\barithmetic/i ) { $m1 = 1; }
if ( $m0 && !$m1 ) { $CONFIG[1] = 0; }
elsif ( !$m0 && $m1 ) { $CONFIG[1] = 1; }
else { $ok = 0; last; }</code></pre>
<p>This update was made 15 Nov 2020, 2b7784d.</p>
</dd>
<dt id="added-option--wnxl-s-to-give-control-of-welding-by-the--wn-parameter"><b>added option -wnxl=s to give control of welding by the -wn parameter</b></dt>
<dd>
<p>The parameter string can restrict the types of containers which are welded. This was added 11 Nov 2020 in 'added -wnxl=s for control of -wn', 2e642d2.</p>
</dd>
<dt id="merged-pull-request-git-46"><b>merged pull request git #46</b></dt>
<dd>
<p>The man page gave the incorrect string for -fse. This was fixed 11 Nov 2020 in 1f9869e.</p>
</dd>
<dt id="recognize-overloaded-RPerl-operators-to-avoid-error-messages"><b>recognize overloaded RPerl operators to avoid error messages</b></dt>
<dd>
<p>RPerl uses some bareword operators which caused error messages. An update was made to avoid this problem in files containing 'use RPerl'. This update was made 6 Nov 2020, f8bd088.</p>
</dd>
<dt id="fix-issue-git-45--wn-and--vtc-n-now-work-together"><b>fix issue git #45, -wn and -vtc=n now work together</b></dt>
<dd>
<p>When -wn was set, the -vtc=n flag was being ignored. This was a simple fix made 5 Nov 2020 in 'fix issue git #45, -wn and -vtc=n now work together', 1fbc381.</p>
</dd>
<dt id="implement-request-RT-133649-added-parameters--kbb-s-and--kba-s"><b>implement request RT #133649, added parameters -kbb=s and -kba=s</b></dt>
<dd>
<p>These parameters request that old breakpoints be kept before or after selected token types. For example, -kbb='=>' means that newlines before fat commas should be kept. This was added 4 Nov 2020.</p>
</dd>
<dt id="added-parameters--maxue-n-and-maxle-n"><b>added parameters -maxue=n and maxle=n</b></dt>
<dd>
<p>These parameters had tentatively been hardwired in the tokenizer. Now the user can control them or turn the checks off altogether.</p>
</dd>
<dt id="Fix-problem-parsing"><b>Fix problem parsing '$$*'</b></dt>
<dd>
<p>In random testing, an error was encountered parsing the following line</p>
<pre><code> $self->{"mod_id"}=($$*1001)%(10**(rand()*6));
---^
found Number where operator expected (previous token underlined)</code></pre>
<p>The line parsed correctly with a space between the '$$' and the '*'. The problem had to do with an error in some newer code for postfix dereferencing, and this was fixed on 2 Nov 2020, 'fix problem scanning '$$'; revise call to operator_expected', 49d993b.</p>
</dd>
<dt id="Update-for-git-44-fix-exit-status-for-assert-tidy-untidy"><b>Update for git #44, fix exit status for assert-tidy/untidy</b></dt>
<dd>
<p>The exit status was always 0 for --assert-tidy if the user had turned off error messages with -quiet. This was fixed by gluesys/master in 'fix exit status for assert-tidy/untidy options', 625d250.</p>
</dd>
<dt id="Fixed-problem-parsing-extruded-signature"><b>Fixed problem parsing extruded signature</b></dt>
<dd>
<p>A parsing error was encountered in a test parsing the following extruded signature:</p>
<pre><code> sub foo2
(
$
first
,
$
,
$
third
)
{
return
"first=$first, third=$third"
;
}</code></pre>
<p>The second '$' combined with the ',' on the next line to form a punctuation variable. This was fixed 20 Oct 2020 in 'fixed problem parsing extruded signature', 9b454f6.</p>
<p>The file parses correctly now, with formatted output</p>
<pre><code> sub foo2 ( $first, $, $third ) {
return "first=$first, third=$third";
}</code></pre>
</dd>
<dt id="Fixed-several-uses-of-undefined-variables-found-in-testing"><b>Fixed several uses of undefined variables found in testing</b></dt>
<dd>
<p>Several instances of incorrect array indexing were found in testing and fixed. These each involved incorrectly indexing with index -1. They were found by placing undefs at the end of arrays. None of these was causing incorrect formatting. They were fixed 26 Oct 2020 in 'fixed several instances of incorrect array indexing', c60f694.</p>
</dd>
<dt id="Prevent-syntax-error-by-breaking-dashed-package-names"><b>Prevent syntax error by breaking dashed package names</b></dt>
<dd>
<p>In stress testing perltidy with the -extrude option, the following test snippet</p>
<pre><code> use perl6-alpha;</code></pre>
<p>was broken into sepate lines</p>
<pre><code> use
perl6
-
alpha
;</code></pre>
<p>A rule was added to prevent breaking around a dash separating two barewords. Rerunning gives</p>
<pre><code> use
perl6-alpha
;</code></pre>
<p>This was fixed 26 Oct 2020 in 'prevent breaking package names with trailing dashes', 9234be4.</p>
</dd>
<dt id="Prevent-syntax-error-by-breaking-dashed-barewords"><b>Prevent syntax error by breaking dashed barewords</b></dt>
<dd>
<p>In stress testing perltidy with the -extrude option, using the following test snippet</p>
<pre><code> my %var;
{
$var{-y} = 1;
$var{-q} = 1;
$var{-qq} = 1;
$var{-m} = 1;
$var{y} = 1;
$var{q} = 1;
$var{qq} = 1;
$var{m} = 1;
}</code></pre>
<p>a syntax error was created when newlines were placed before or after the dashes. It is necessary to always keep a dash on the same line with its surrounding tokens. A rule was added to do this. The new 'extruded' result for the above snippet is:</p>
<pre><code> my%var
;
{
$var{-y}
=
1
;
$var{-q}
=
1
;
$var{-qq}
=
1
;
$var{-m}
=
1
;
$var{y}
=
1
;
$var{q}
=
1
;
$var{qq}
=
1
;
$var{m}
=
1
;
}</code></pre>
<p>This update was added 26 Oct 2020, 'prevent syntax error by breaking dashed barewords', e121cae.</p>
</dd>
<dt id="more-types-of-severe-errors-will-prevent-formatting"><b>more types of severe errors will prevent formatting</b></dt>
<dd>
<p>Files for which 'severe errors' are found have always been output verbatim rather than being formatted. The definition of 'severe error' has been expanded to include a final indentation level error greater than 1, more than 2 brace errors, and more than 3 "unexpected token type" parsing errors. The goal is to avoid formatting a non-perl script or a perl script with severe errors. So for example the following snippet has a level error of 2</p>
<pre><code> {{{{
}}</code></pre>
<p>was previously output with default parameters as</p>
<pre><code> {
{
{
{}
}</code></pre>
<p>along with an error message. But now it is just output verbatim as</p>
<pre><code> {{{{
}}</code></pre>
<p>along with an error message. This update was added 25 Oct 2020, 'avoid formatting files with more types of severe errors', 2a86f51.</p>
</dd>
<dt id="added-state-as-keyword"><b>added 'state' as keyword</b></dt>
<dd>
<p>A statement such as the following was generating an error message at the colon:</p>
<pre><code> state $a : shared;</code></pre>
<p>The problem was that 'state' was not in the list of keywords. This has been fixed and the line now parses without error. The 'state.t' test file for perl 5.31 now formats without error. This was added 18 Oct 2020 in "add 'state' as keyword", d73e15f.</p>
</dd>
<dt id="sub-signatures-no-longer-parsed-with-prototypes"><b>sub signatures no longer parsed with prototypes</b></dt>
<dd>
<p>Simple signatures (those without commas) were being parsed with code originally written for prototypes. This prevented them from being formatted with the usual formatting rules. This was changed so that all signatures are now formatted with the normal formatting rules. For example:</p>
<pre><code> # Old, input and after formatting:
sub t123 ($list=wantarray) { $list ? "list" : "scalar" }
# New, after formatting
sub t123 ( $list = wantarray ) { $list ? "list" : "scalar" }</code></pre>
<p>Notice that some spaces have been introduced within the signature. Previously the contents of the parens not changed unless the parens contained a list.</p>
<p>This change introduced a problem parsing extended syntax within signatures which has been fixed. In the following snippet, the ':' caused a parsing error which was fixed.</p>
<pre><code> # perltidy -sal='method'
method foo4 ( $class : $bar, $bubba ) { $class->bar($bar) }</code></pre>
<p>The ':' here is given a type of 'A'. This may be used to change the spacing around it. For example:</p>
<pre><code> # perltidy -sal='method' -nwls='A'
method foo4 ( $class: $bar, $bubba ) { $class->bar($bar) }</code></pre>
<p>This update was added 18 Oct 2020, in 'format all signatures separately from prototypes', e6a10f3. The test file 'signatures.t' distributed with perl5.31 formats without error now.</p>
</dd>
<dt id="fix-parsing-problem-with"><b>fix parsing problem with $#</b></dt>
<dd>
<p>A problem with parsing variables of the form $# and $#array was found in testing and fixed. For most variables the leading sigil may be separated from the remaining part of the identifier by whitespace. An exception is for a variable beginning with '$#'. If there is any space between the '$' and '#' then the '#' starts a comment. So the following snippet is has valid syntax and is equivalent to $ans=40;</p>
<pre><code> my $ #
#
ans = 40;</code></pre>
<p>This was being misparsed and was fixed 17 Oct 2020, in 'fixed parsing error with spaces in $#' a079cdb.</p>
</dd>
<dt id="fix-missing-line-break-for-hash-of-subs-with-signatures"><b>fix missing line break for hash of subs with signatures</b></dt>
<dd>
<p>During testing the following error was found and fixed. Given the following input snippet:</p>
<pre><code> get(
on_ready => sub ($worker) {
$on_ready->end;
return;
},
on_exit => sub ( $worker, $status ) { return; },
);</code></pre>
<p>The resulting formatting was</p>
<pre><code> get(
on_ready => sub ($worker) {
$on_ready->end;
return;
}, on_exit => sub ( $worker, $status ) { return; },
);</code></pre>
<p>Notice that the break after the comma has been lost. The problem was traced to a short-cut taken by the code looking for one-line blocks. The unique circumstances in which this occured involved a hash of anonymous subs, one with a signature with multiple parameters and short enough to be a one-line block, as in the last sub definition line. This was fixed 17 Oct 2020 in 'fix missing line break for hash of subs with signatures', 51428db.</p>
</dd>
<dt id="fix-issues-with-prototype-and-signature-parsing"><b>fix issues with prototype and signature parsing</b></dt>
<dd>
<p>Problems with parsing prototypes and signatures were found during testing and fixed 17 Oct 2020 in 'fixed problem parsing multi-line signatures with comments', 017fd07. For example the following snippet was mis-parsed because of the hash mark.</p>
<pre><code> sub test ( # comment )))
$x, $x) { $x+$y }</code></pre>
<p>Complex signature expressions such as the following are now parsed without error:</p>
<pre><code> sub t086
( #foo)))
$ #foo)))
a #foo)))
) #foo)))
{ $a.$b }</code></pre>
</dd>
<dt id="improve-guess-for-pattern-or-division"><b>improve guess for pattern or division</b></dt>
<dd>
<p>The following line caused a tokenization error in which the two slashes were parsed as a pattern.</p>
<pre><code> my $masksize = ceil( Opcode::opcodes / 8 ); # /</code></pre>
<p>This problem was discovered in random testing. When a slash follows a bareword whose prototype is not known to perltidy, it has to guess whether the slash starts a pattern or is a division. The guessing logic was rewritten and improved 14 Oct 2020 in 'rewrote logic to guess if divide or pattern', afebe2f.</p>
</dd>
<dt id="fix--bos-to-keep-isolated-semicolon-breaks-after-block-braces"><b>fix -bos to keep isolated semicolon breaks after block braces</b></dt>
<dd>
<p>The flag <b>-bos</b>, or <b>--break-at-old-semicolon-breakpoints</b>, keeps breaks at old isolated semicolons. For example</p>
<pre><code> $z = sqrt($x**2 + $y**2)
;</code></pre>
<p>In testing it was found not to be doing this after braces which require semicolons, such as 'do' and anonymous subs. This was fixed 12 Oct 2020 in 'fix -bos to work with semicolons after braces', 03ee7fc. For example</p>
<pre><code> my $dist = sub {
$z = sqrt( $x**2 + $y**2 )
;
}
;</code></pre>
</dd>
<dt id="keep-break-after-use-overload"><b>keep break after 'use overload'</b></dt>
<dd>
<p>If a line break occurs after <b>use overload</b> then it will now be kept. Previously it was dropped. For example, this would be kept intact:</p>
<pre><code> use overload
'+' => sub {
print length $_[2], "\n";
my ( $x, $y ) = _order(@_);
Number::Roman->new( int $x + $y );
},
'-' => sub {
my ( $x, $y ) = _order(@_);
Number::Roman->new( int $x - $y );
},
...</code></pre>
<p>This keeps the list from shifting to the right and can avoid problems in formatting the list with certain styles, including with the -xci flag. Fixed 12 Oct 2020 in 'keep break after use overload statement', 8485afa.</p>
</dd>
<dt id="added-flag--xci-to-improve-formatting-when--ci-and--i-are-equal-issue-git-28"><b>added flag -xci to improve formatting when -ci and -i are equal, issue git #28</b></dt>
<dd>
<p>This flag causes continuation indentation to "extend" deeper into structures. If you use <b>-ci=n</b> and <b>-i=n</b> with the same value of <b>n</b> you will probably want to set this flag. Since this is a fairly new flag, the default is <b>-nxci</b> to avoid disturbing existing formatting.</p>
</dd>
<dt id="terminal-braces-not-indenting-correctly-with--bli-formatting-issue-git-40"><b>terminal braces not indenting correctly with -bli formatting, issue git #40</b></dt>
<dd>
<p>This problem is illustrated with the following snippet when run with -bli -blil='*'</p>
<pre><code> #-bli -bli list='*'
try
{
die;
}
catch
{
die;
}; # <-- this was not indenting</code></pre>
<p>This was due to conflicting rules and was fixed 1 Oct 2020 in commit 'fix issue git #40, incorrect closing brace indentation with -bli', a5aefe9.</p>
<p>At the same time, it was noted that block types sort/map/grep and eval were not following -bli formatting when -blil='*' and this was fixed. For example, with corrected formatting, we would have</p>
<pre><code> # perltidy -bli -blil='*'
eval
{
my $app = App::perlbrew->new( "install-patchperl", "-q" );
$app->run();
}
or do
{
$error = $@;
$produced_error = 1;
};</code></pre>
</dd>
</dl>
<h1 id="Issues-fixed-after-release-20200907">Issues fixed after release 20200907</h1>
<p>This is a detailed log of changes since the release 20200907. All bugs were found with the help of automated random testing.</p>
<dl>
<dt id="Keep-any-space-between-a-bareword-and-quote"><b>Keep any space between a bareword and quote</b></dt>
<dd>
<p>In random testing, the -mangle option introduced a syntax error by deleting the space between barewords and quotes (test file 'MxScreen'), such as:</p>
<pre><code> oops"Your login, $Bad_Login, is not valid";</code></pre>
<p>Sub 'is_essential_whitespace' was updated to prevent this on 27 Sep 2020, in 'keep any space between a bareword and quote', f32553c.</p>
</dd>
<dt id="Fixed-some-incorrect-indentation-disagreements-reported-in-LOG-file"><b>Fixed some incorrect indentation disagreements reported in LOG file</b></dt>
<dd>
<p>The .LOG file reports any disagreements between the indentation of the input and output files. This can help locate brace errors. These were incorrect when some of the options were used, including --whitespace-cycle, -bbhb, -nib. This was corrected 24 Sep 2020, 'fixed incorrect log entry for indentation disagreement', 3d40545. At the same time, locations of closing brace indentation disagreements are now tracked and reported in the .ERR file when there is a brace error. This can help localize the error if the file was previously formatted by perltidy.</p>
</dd>
<dt id="If-an-cut-starts-a-POD-section-within-code-give-a-warning"><b>If an =cut starts a POD section within code, give a warning</b></dt>
<dd>
<p>Previously only a complaint was given, which went into the log file and was not normally seen. Perl silently accepts this but it can cause significant problems with pod utilities, so a clear warning is better. This situation arose in testing on random files in combination with a -dp flag and it took some time to understand the results because of the lack of a warning.</p>
</dd>
<dt id="Switched-from-using-an-eval-block-to-the--can-function-for-sub-finish_formatting"><b>Switched from using an eval block to the -</b>can() function for sub finish_formatting></dt>
<dd>
<p>This is not a bug, but is cleaner coding and insures that error messages get reported. This change was made 20 Sep 2020, 'switch from eval { } to ->can('finish_formatting')', 28f2a4f.</p>
</dd>
<dt id="fixed-uninitialized-value-reference"><b>fixed uninitialized value reference</b></dt>
<dd>
<p>The following message was generated during automated testing</p>
<pre><code> Use of uninitialized value $cti in numeric eq (==) at /home/steve/bin/Perl/Tidy/Formatter.pm line 12079.
Use of uninitialized value $cti in numeric eq (==) at /home/steve/bin/Perl/Tidy/Formatter.pm line 12089.
Use of uninitialized value $cti in numeric eq (==) at /home/steve/bin/Perl/Tidy/Formatter.pm line 12097.</code></pre>
<p>The problem could be simplified to running perltidy -wn on this snippet:</p>
<pre><code> __PACKAGE__->load_components( qw(
> Core
>
> ) );</code></pre>
<p>This was fixed 20 Sep 2020 in 'fixed_uninitialized_value', 8d6c4ed.</p>
</dd>
<dt id="fix-incorrect-parsing-of-certain-deprecated-empty-here-docs"><b>fix incorrect parsing of certain deprecated empty here-docs </b></dt>
<dd>
<p>The following snippet was being incorrecly parsed:</p>
<pre><code> print <<
# Hello World 13!
;
print "DONE\n";</code></pre>
<p>This is a deprecated here-doc without a specified target but currently still a valid program. It would have been correctly parsed if the semicolon followed the '<<' operator rather than the here-doc.</p>
<p>This was found in random testing and fixed 16 Sep 2020. A warning message about deprecated here-doc targets was added.</p>
</dd>
<dt id="make-the-arrow-a-vertical-alignment-token-git-39"><b>make the arrow a vertical alignment token, git #39</b></dt>
<dd>
<p>The -> can now be vertically aligned if a space is placed before it with -wls='->'. Added 15 Sep 2020 as part of previous item, 9ac6af6.</p>
</dd>
<dt id="add-flags--bbhb-n--bbsb-n-bbp-n-git-38"><b>add flags -bbhb=n, -bbsb=n, =bbp=n, git #38</b></dt>
<dd>
<p>These flags give control over the opening token of a multiple-line list. They are described in the man pages, perltidy.html. Added 15 Sep 2020 in "added flags -bbhb=n, -bbsb=n, -bbq=n, suggestion git #38". 9ac6af6.</p>
</dd>
<dt id="Allow-vertical-alignment-of-line-ending-fat-comma"><b>Allow vertical alignment of line-ending fat comma</b></dt>
<dd>
<p>A change was made to allow a '=>' at the end of a line to align vertically, provided that it aligns with two or more other '=>' tokens. This update was 14 Sep 2020, 'Allow line-ending '=>' to align vertically', ea96739.</p>
</dd>
<dt id="fixed-uninitialized-value-reference1"><b>fixed uninitialized value reference</b></dt>
<dd>
<p>The following message was generated when running perltidy on random text:</p>
<pre><code> Use of uninitialized value $K_semicolon in subtraction (-) at /home/steve/bin/Perl/Tidy/Formatter.pm line 16467.</code></pre>
<p>This was fixed 14 Sep 2020, included in 'Allow line-ending '=>' to align vertically', ea96739.</p>
</dd>
<dt id="Do-not-create-a-zero-size-file-by-deleting-semicolons"><b>Do not create a zero size file by deleting semicolons</b></dt>
<dd>
<p>A rule was added to prevent a file consisting of a single semicolon</p>
<pre><code> ;</code></pre>
<p>from becoming a zero length file. This could cause problems with other software. Fixed 13 Sep 2020, 'do not create a zero length file by deleting semicolons', b39195e.</p>
</dd>
<dt id="fixed-uninitialized-value-reference2"><b>fixed uninitialized value reference</b></dt>
<dd>
<p>The following message was generated when running perltidy on random text:</p>
<pre><code> Use of uninitialized value $cti in numeric eq (==) at /home/steve/bin/Perl/Tidy/Formatter.pm line 11926.
Use of uninitialized value $cti in numeric eq (==) at /home/steve/bin/Perl/Tidy/Formatter.pm line 11936.
Use of uninitialized value $cti in numeric eq (==) at /home/steve/bin/Perl/Tidy/Formatter.pm line 11944.</code></pre>
<p>This was fixed 13 Sep 2020 in 'fixed unitialized variable problem ', adb2096.</p>
</dd>
<dt id="fixed-uninitialized-value-reference3"><b>fixed uninitialized value reference</b></dt>
<dd>
<p>The following message was generated when running perltidy on random text:</p>
<pre><code> substr outside of string at /home/steve/bin/Perl/Tidy/Tokenizer.pm line 7362.
Use of uninitialized value in concatenation (.) or string at /home/steve/bin/Perl/Tidy/Tokenizer.pm line 7362.</code></pre>
<p>This was fixed 13 Sep 2020 in 'fixed unitialized variable problem', 5bf49a3.</p>
</dd>
<dt id="fixed-uninitialized-value-reference4"><b>fixed uninitialized value reference</b></dt>
<dd>
<p>The following message was generated when running perltidy on random text:</p>
<pre><code> Use of uninitialized value $K_opening in subtraction (-) at /home/steve/bin/Perl/Tidy/Formatter.pm line 16467.</code></pre>
<p>This was fixed 13 Sep 2020 in 'fix undefined variable reference', 1919482.</p>
</dd>
<dt id="hashbang-warning-changed"><b>hashbang warning changed</b></dt>
<dd>
<p>The following snippet generated a warning that there might be a hash-bang after the start of the script.</p>
<pre><code> $x = 2;
#! sunos does not yet provide a /usr/bin/perl
$script = "$^X $script";</code></pre>
<p>To prevent this annoyance, the warning is not given unless the first nonblank character after the '#!' is a '/'. Note that this change is just for the warning message. The actual hash bang check does not require the slash.</p>
<p>Fixed 13 Sep 2020, 'prevent unnecessary hash-bang warning message' 4f7733e and 'improved hash-bang warning filter', fa84904.</p>
</dd>
<dt id="uninitialized-index-referenced"><b>uninitialized index referenced</b></dt>
<dd>
<p>An unitialized index was referenced when running on a file of randomly generated text:</p>
<pre><code> Use of uninitialized value $K_oo in subtraction (-) at /home/steve/bin/Perl/Tidy/Formatter.pm line 7259.</code></pre>
<p>This was fixed 12 Sep 2020 in 'fixed undefined index', 616bb88.</p>
</dd>
<dt id="Oops-message-triggered"><b>Oops message triggered</b></dt>
<dd>
<p>The parameter combination -lp -wc triggered an internal bug message from perltidy:</p>
<pre><code> 398: Program bug with -lp. seqno=77 should be 254 and i=1 should be less than max=-1
713: The logfile perltidy.LOG may contain useful information
713:
713: Oops, you seem to have encountered a bug in perltidy. Please check the
713: BUGS file at http://perltidy.sourceforge.net. If the problem is not
713: listed there, please report it so that it can be corrected. Include the
...</code></pre>
<p>The problem is that the parameters --line-up-parentheses and --whitespace-cycle=n are not compatible. The fix is to write a message and turn off the -wc parameter when the both occur. This was fixed 8 Sep 2020 in "do not allow -wc and -lp together, can cause bugs", 7103781.</p>
</dd>
<dt id="Internal-fault-detected-by-perltidy"><b>Internal fault detected by perltidy</b></dt>
<dd>
<p>This snippet after processing with the indicated parameters triggered a Fault message in store-token-to-go due to discontinuous internal index values :</p>
<pre><code> perltidy --noadd-newlines --space-terminal-semicolon
if ( $_ =~ /PENCIL/ ) { $pencil_flag= 1 } ; ;
$yy=1;</code></pre>
<p>This triggered the message:</p>
<pre><code> ==============================================================================
While operating on input stream with name: '<stdin>'
A fault was detected at line 7472 of sub 'Perl::Tidy::Formatter::store_token_to_go'
in file '/home/steve/bin/Perl/Tidy/Formatter.pm'
which was called from line 8298 of sub 'Perl::Tidy::Formatter::process_line_of_CODE'
Message: 'Unexpected break in K values: 591 != 589+1'
This is probably an error introduced by a recent programming change.
==============================================================================</code></pre>
<p>The deletion of the extra, spaced, comma had created an extra space in the token array which had not been forseen in the original programming. It was fixed 10 Sep 2020 in "fixed very rare fault found with automated testing", eb1b1d9.</p>
</dd>
<dt id="Error-parsing-deprecated-variable"><b>Error parsing deprecated $# variable</b></dt>
<dd>
<p>This problem can be illustrated with this two-line snippet:</p>
<pre><code> $#
eq$,?print"yes\n":print"no\n";</code></pre>
<p>Perltidy joined '$#' and 'eq' to get $#eq, but should have stopped at the line end to get $# followed by keyword 'eq'. (Note that $# is deprecated). This was fixed 11 Sep 2020 in "fixed several fringe parsing bugs found in testing", 85e01b7.</p>
</dd>
<dt id="Error-message-parsing-a-file-with-angle-brackets-and-ternaries"><b>Error message parsing a file with angle brackets and ternaries</b></dt>
<dd>
<p>This problem can be illustrated with the following test snippet which was not correctly parsed.</p>
<pre><code> print$$ <300?"$$<300\n":$$<700?"$$<700\n":$$<2_000?"$$<2,000\n":$$<10_000?"$$ <10,000\n":"$$>9,999\n";</code></pre>
<p>The problem is related to the '<' symbol following the '$$' variable, a possible filehandle, and is similar to a previous bug. The problem was corrected 11 Sep 2020 in "fixed several fringe parsing bugs found in testing", 85e01b7. The line now correctly formats to</p>
<pre><code> print $$ < 300 ? "$$<300\n"
: $$ < 700 ? "$$<700\n"
: $$ < 2_000 ? "$$<2,000\n"
: $$ < 10_000 ? "$$ <10,000\n"
: "$$>9,999\n";</code></pre>
</dd>
<dt id="code-crash-with-cuddled-else-formatting-on-unbalanced-files"><b>code crash with cuddled-else formatting on unbalanced files</b></dt>
<dd>
<p>A file with incorrect bracing which effectively gave negative indentation caused a crash when a stack was referenced with a negative index. The problem was fixed 8 Sept 2020 in "convert array to hash to avoid trouble with neg levels in bad files", a720e0d.</p>
</dd>
<dt id="error-message-Unterminated-angle-operator"><b>error message 'Unterminated angle operator?'</b></dt>
<dd>
<p>This error can be demonstrated with this line.</p>
<pre><code> print $i <10 ? "yes" : "no";</code></pre>
<p>Perl has some strange parsing rules near a possible filehandle, and they change over time. The '<' here is a less than symbol, but perltidy expected that it might be the start of an angle operator, based on the old rules, and gave a warning. The formatting was still correct, but the warning was confusing. This has been fixed 8 Sep 2020 in 'remove confusing warning message', 0a4d725.</p>
</dd>
<dt id="Line-broken-after-here-target"><b>Line broken after here target</b></dt>
<dd>
<p>This problem is illustrated with the following snippet</p>
<pre><code> $sth= $dbh->prepare (<<"END_OF_SELECT") or die "Couldn't prepare SQL" ;
SELECT COUNT(duration),SUM(duration)
FROM logins WHERE username='$user'
END_OF_SELECT</code></pre>
<p>When run with a short line length it got broken after the here target, causing an error. This was due to a recent program change and fixed 7 Sep 2020 in 'fixed bug where long line with here target got broken', 8f7e4cb.</p>
</dd>
<dt id="undefined-variable-named-test2"><b>undefined variable named 'test2'</b></dt>
<dd>
<p>An uninitialized value was being referenced and triggered this message:</p>
<pre><code> undefined test2, i_opening=5, max=18, caller=Perl::Tidy::Formatter ./perltidy-20200907.pl 13465
Use of uninitialized value $test2 in numeric eq (==) at ./perltidy-20200907.pl line 19692.</code></pre>
<p>Fixed 8 Sep 2020 in 'fixed rare problem with stored index values for -lp option', 4147c8c.</p>
</dd>
<dt id="Line-order-switched-at-start-of-quoted-text"><b>Line order switched at start of quoted text</b></dt>
<dd>
<p>This problem arose in several scripts involving the parameter --line-up-parentheses pluse one or more of the vertical tightness flags. It can be illustrated with the following snippet:</p>
<pre><code> perltidy --line-up-parentheses --paren-vertical-tightness=1
if (
( $name, $chap ) =
$cur_fname =~ m!^Bible/
.*?/ # testament
.*?/ # range of books
(.*?)/ # book name
.*? # optional range of verses
(\d+)$!x
)
{
$cur_name = "$name $chap";
}</code></pre>
<p>This gave</p>
<pre><code> if (( $name, $chap ) =
.*?/ # testament
$cur_fname =~ m!^Bible/
.*?/ # range of books
(.*?)/ # book name
.*? # optional range of verses
(\d+)$!x
)
{
$cur_name = "$name $chap";
}</code></pre>
<p>Notice the incorrect line order. The problem was an incorrect order of operations in the vertical aligner flush, leaving a line stranded and coming out in the wrong order. This was fixed 11 Sep 2020.</p>
</dd>
<dt id="crash-due-to-bad-index-named-j_terminal_match"><b>crash due to bad index named '$j_terminal_match'</b></dt>
<dd>
<p>This crash was due to an index error which caused a non-existant object to be referenced. The problem is fixed 2020-09-07 in "fix problem of undefined values involving j_terminal_match", c5bfa77. The particular parameters which caused this were:</p>
<pre><code> --noadd-newlines --nowant-left-space='=' </code></pre>
</dd>
<dt id="an-issue-with-the--x-flag"><b>an issue with the -x flag</b></dt>
<dd>
<p>This is not a bug but did take some time to resolve. The problem was reduced to the following script run with the -x flag (--look-for-hash-bang)</p>
<pre><code> print(SCRIPT$headmaybe . <<EOB . <<'EOF' .$tailmaybe),$!;
#!$wd/perl
EOB
print "\$^X is $^X, \$0 is $0\n";
EOF</code></pre>
<p>The resulting file had a syntax error (here-doc target EOB changed).</p>
<pre><code> print(SCRIPT$headmaybe . <<EOB . <<'EOF' .$tailmaybe),$!;
#!$wd/perl
EOB print "\$^X is $^X, \$0 is $0\n";
EOF</code></pre>
<p>The problem is that the -x flag tells perltidy not to start parsing until it sees a line starting with '#!', which happens to be in a here-doc in this case.</p>
<p>A warning was added to the manual 7 Sept 2020 in "add warning about inappropriate -x flag", fe66743.</p>
</dd>
<dt id="error-parsing-sub-signature"><b>error parsing sub signature</b></dt>
<dd>
<p>This problem was reduced to the following snippet:</p>
<pre><code> substr
(
$#
)</code></pre>
<p>The deprecated variable '$#' was being parsed incorrectly, and this was due to an error in which the word 'substr' followed by a paren was taken as the start of a sub signature. The problem was fixed 8 Sep 2020 in 'fix problem parsing sub prototypes' 569e05f. The code</p>
<pre><code> $container_type =~ /^sub/;</code></pre>
<p>was corrected to be</p>
<pre><code> $container_type =~ /^sub\b/;</code></pre>
</dd>
<dt id="uninitialized-value-message-found-7-Sep-2020"><b>uninitialized value message, found 7 Sep 2020</b></dt>
<dd>
<p>Unitialized values were referenced. An index was not being tested. Fixed 8 Sep 2020 in "fix undefined variable", 9729965.</p>
<pre><code> Use of uninitialized value $Kon in array element at /home/steve/bin/Perl/Tidy/Formatter.pm line 4022.
Use of uninitialized value $Kon in array element at /home/steve/bin/Perl/Tidy/Formatter.pm line 4023.
Use of uninitialized value $Ko in subtraction (-) at /home/steve/bin/Perl/Tidy/Formatter.pm line 4023.</code></pre>
</dd>
</dl>
<h1 id="Open-Issues">Open Issues</h1>
<p>These are known issues which have not been fixed.</p>
<dl>
<dt id="lexical-subs-not-fully-supported"><b>lexical subs not fully supported</b></dt>
<dd>
<p>Basic parsing of lexical subs works but some aspects of lexical subs are not yet functional. One of these is that unlike regular subs, lexical subs can override names of builtin functions.</p>
<p>First consider the following snippet</p>
<pre><code> sub s {
my $arg=$_[0];
print "s called with arg $arg\n";
}
s(1);
s(2);</code></pre>
<p>The 's' in the two last lines is the builtin s function, not the sub. Both perltidy and perl make the same assumption here. This program happens to still run but prints nothing. It will not run if the last semicolon is removed.</p>
<p>Now consider the following snippet in which the sub has a preceding 'my'</p>
<pre><code> use feature 'lexical_subs', 'signatures';
my sub s {
my $arg=$_[0];
print "s called with arg $arg\n";
}
s(1);
s(2);</code></pre>
<p>The builtin function 's' is replaced by the sub s here, and the program runs. Perltidy will format this but it is assuming that the s in the two last lines are the builtin s function. If the last semicolon is removed, there will be an formatting error. So perltidy and perl make different assumptions in this case.</p>
<p>Another issue is that perltidy does not yet remember the extent of the scope of a lexical sub.</p>
</dd>
<dt id="issues-with-paren-less-calls"><b>issues with paren-less calls</b></dt>
<dd>
<p>Consider the following snippet:</p>
<pre><code> use Test::More;
ok open($stdin, "<&", $1), 'open ... "<&", $magical_fileno', || _diag $!;</code></pre>
<p>Note the unusual situation of a comma followed by an '||'. Perltidy will format this satisfactorally but it will write an error message. The syntax is correct, however. Perl knows the prototype of the 'ok' function, which is called here without parens, so the last comma marks the last arg and is needed to keep the || from attaching to the last arg.</p>
<p>Full support of peren-less calls will probably never be implemented in perltidy because it would require that it parse all of the modules used to find the prototypes. This would make it impossible to run perltidy on small snippets of code from within an editor.</p>
<p>The problem can be avoid if parens are used:</p>
<pre><code> ok ( open($stdin, "<&", $1), 'open ... "<&", $magical_fileno') || _diag $!;</code></pre>
</dd>
<dt id="multiple-sub-paren-calls"><b>multiple sub paren calls</b></dt>
<dd>
<p>Perltidy currently flags as an error a closing paren followed by an opening paren, as in the following</p>
<pre><code> $subsubs[0]()(0)</code></pre>
<p>This syntax is ok. The example is from test 'current_sub.t' in perl5.31.</p>
</dd>
</dl>
</body>
</html>
|