1 <h1>Perltidy Change Log</h1>
5 <pre><code>- This release is being made mainly because of the next item, in which an
6 error message about an uninitialized value error message could be produced
7 in certain cases when format-skipping is used. The error message was
8 annoying but harmless to formatting.
10 - Fixed an undefined variable message, see git #67. When a format skipping
11 comment '#<<' is placed before the first line of code in a script, a
12 message 'Use of uninitialized value $Ktoken_vars in numeric ...' can
15 - A warning will no longer be given if a script has an opening code-skipping
16 comment '#<<V' which is not terminated with a closing comment '#>>V'. This
17 makes code-skipping and format-skipping behave in a similar way: an
18 opening comment without a corresponding closing comment will cause
19 the rest of a file to be skipped. If there is a question about which lines
20 are skipped, a .LOG file can be produced with the -g flag and it will have
23 - Removed the limit on -ci=n when -xci is set, reference: rt #136415.
24 This update removes a limit in the previous two versions in which the
25 value of -ci=n was limited to the value of -i=n when -xci was set.
26 This limit had been placed to avoid some formatting instabilities,
27 but recent coding improvements allow the limit to be removed.
29 - The -wn and -bbxx=n flags were not working together correctly. This has
32 - This version may produce occasional differences in formatting compared to
33 previous versions, mainly for lines which are near the specified line
34 length limit. This is due to ongoing efforts to eliminate edge cases of
35 formatting instability.
37 - Numerous minor fixes have been made. A complete list is at:
39 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
44 <pre><code>- This release adds several new requested parameters. No significant bugs have
45 been found since the last release, but a number of minor problems have been
48 - Added a new option '--code-skipping', requested in git #65, in which code
49 between comment lines '#<<V' and '#>>V' is passed verbatim to the output
50 stream without error checking. It is simmilar to --format-skipping
51 but there is no error checking of the skipped code. This can be useful for
52 skipping past code which employs an extended syntax.
54 - Added a new option for closing paren placement, -vtc=3, requested in rt #136417.
56 - Added flag -atnl, --add-terminal-newline, to help issue git #58.
57 This flag tells perltidy to terminate the last line of the output stream
58 with a newline character, regardless of whether or not the input stream
59 was terminated with a newline character. This is the default.
60 If this flag is negated, with -natnl, then perltidy will add a terminal
61 newline character to the the output stream only if the input
62 stream is terminated with a newline.
64 - Some nested structures formatted with the -lp indentation option may have
65 some changes in indentation. This is due to updates which were made to
66 prevent formatting instability when line lengths are limited by the maximum line
67 length. Most scripts will not be affected. If this causes unwanted formatting
68 changes, try increasing the --maximum-line-length by a few characters.
70 - Numerous minor fixes have been made. A complete list is at:
72 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
77 <pre><code>- This release fixes several non-critical bugs which have been found since the last
78 release. An effort has been made to keep existing formatting unchanged.
80 - Fixed issue git #57 regarding uninitialized warning flag.
82 - Added experimental flag -lpxl=s requested in issue git #56 to provide some
83 control over which containers get -lp indentation.
85 - Fixed issue git #55 regarding lack of coordination of the --break-before-xxx
86 flags and the --line-up-parens flag.
88 - Fixed issue git #54 regarding irregular application of the --break-before-paren
89 and similar --break-before-xxx flags, in which lists without commas were not
90 being formatted according to these flags.
92 - Fixed issue git #53. A flag was added to turn off alignment of spaced function
93 parens. If the --space-function-paren, -sfp flag is set, a side-effect is that the
94 spaced function parens may get vertically aligned. This can be undesirable,
95 so a new parameter '--function-paren-vertical-alignment', or '-fpva', has been
96 added to turn this vertical alignment off. The default is '-fpva', so that
97 existing formatting is not changed. Use '-nfpva' to turn off unwanted
98 vertical alignment. To illustrate the possibilities:
101 myfun( $aaa, $b, $cc );
102 mylongfun( $a, $b, $c );
105 myfun ( $aaa, $b, $cc );
106 mylongfun ( $a, $b, $c );
108 # perltidy -sfp -nfpva
109 myfun ( $aaa, $b, $cc );
110 mylongfun ( $a, $b, $c );
112 - Fixed issue git #51, a closing qw bare paren was not being outdented when
113 the -nodelete-old-newlines flag was set.
115 - Fixed numerous edge cases involving unusual parameter combinations which
116 could cause alternating output states. Most scripts will not be
117 changed by these fixes.
119 - A more complete list of updates is at
121 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
126 <pre><code>- Fixed issue git #49, -se breaks warnings exit status behavior.
127 The exit status flag was not always being set when the -se flag was set.
129 - Some improvements have been made in the method for aligning side comments.
130 One of the problems that was fixed is that there was a tendency for side comment
131 placement to drift to the right in long scripts. Programs with side comments
132 may have a few changes.
134 - Some improvements have been made in formatting qw quoted lists. This
135 fixes issue git #51, in which closing qw pattern delimiters not always
136 following the settings specified by the --closing-token-indentation=n settings.
137 Now qw closing delimiters ')', '}' and ']' follow these flags, and the
138 delimiter '>' follows the flag for ')'. Other qw pattern delimiters remain
139 indented as the are now. This change will cause some small formatting changes
140 in some existing programs.
142 - Another change involving qw lists is that they get full indentation,
143 rather than just continuation indentation, if
145 (1) the closing delimiter is one of } ) ] > and is on a separate line,
146 (2) the opening delimiter (i.e. 'qw{' ) is also on a separate line, and
147 (3) the -xci flag (--extended-continuation-indentation) is set.
149 This improves formatting when qw lists are contained in other lists. For example,
154 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
155 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
158 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
159 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
166 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
167 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
170 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
171 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
175 - Some minor improvements have been made to the rules for formatting
176 some edge vertical alignment cases, usually involving two dissimilar lines.
178 - A more complete list of updates is at
180 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
185 <pre><code>- Fixed issue git #47, incorrect welding of anonymous subs.
186 An incorrect weld format was being made when the --weld-nested-containers option
187 (-wn) was used in to format a function which returns a list of anonymous subs.
188 For example, the following snippet was incorrectly being welded.
190 $promises[$i]->then(
191 sub { $all->resolve(@_); () },
193 $results->[$i] = [@_];
194 $all->reject(@$results) if --$remaining <= 0;
199 This was due to an error introduced in v20201201 related to parsing sub
200 signatures. Reformatting with the current version will fix the problem.
205 <pre><code>- This release is being made primarily to make available a several new formatting
206 parameters, in particular -xci, -kbb=s, -kba=s, and -wnxl=s. No significant
207 bugs have been found since the previous release, but numerous minor issues have
208 been found and fixed as listed below.
210 - This version is about 20% faster than the previous version due to optimizations
211 made with the help of Devel::NYTProf.
213 - Added flag -wnxl=s, --weld-nested-exclusion-list=s, to provide control which containers
214 are welded with the --weld-nested-containers parameter. This is related to issue git #45.
216 - Merged pull request git #46 which fixes the docs regarding the -fse flag.
218 - Fixed issue git #45, -vtc=n flag was ignored when -wn was set.
220 - implement request RT #133649, delete-old-newlines selectively. Two parameters,
222 -kbb=s or --keep-old-breakpoints-before=s, and
223 -kba=s or --keep-old-breakpoints-after=s
225 were added to request that old breakpoints be kept before or after
226 selected token types. For example, -kbb='=>' means that newlines before
227 fat commas should be kept.
229 - Fix git #44, fix exit status for assert-tidy/untidy. The exit status was
230 always 0 for --assert-tidy if the user had turned off all error messages with
231 the -quiet flag. This has been fixed.
233 - Add flag -maxfs=n, --maximum-file-size-mb=n. This parameter is provided to
234 avoid causing system problems by accidentally attempting to format an
235 extremely large data file. The default is n=10. The command to increase
236 the limit to 20 MB for example would be -mfs=20. This only applies to
237 files specified by filename on the command line.
239 - Skip formatting if there are too many indentation level errors. This is
240 controlled with -maxle=n, --maximum-level-errors=n. This means that if
241 the ending indentation differs from the starting indentation by more than
242 n levels, the file will be output verbatim. The default is n=1.
243 To skip this check, set n=-1 or set n to a large number.
245 - A related new flag, --maximum-unexpected-errors=n, or -maxue=n, is available
246 but is off by default.
248 - Add flag -xci, --extended-continuation-indentation, regarding issue git #28
249 This flag causes continuation indentation to "extend" deeper into structures.
250 Since this is a fairly new flag, the default is -nxci to avoid disturbing
251 existing formatting. BUT you will probably see some improved formatting
252 in complex data structures by setting this flag if you currently use -ci=n
253 and -i=n with the same value of 'n' (as is the case if you use -pbp,
254 --perl-best-practices, where n=4).
256 - Fix issue git #42, clarify how --break-at-old-logical-breakpoints works.
257 The man page was updated to note that it does not cause all logical breakpoints
258 to be replicated in the output file.
260 - Fix issue git #41, typo in manual regarding -fsb.
262 - Fix issue git #40: when using the -bli option, a closing brace followed by
263 a semicolon was not being indented. This applies to braces which require
264 semicolons, such as a 'do' block.
266 - Added 'state' as a keyword.
268 - A better test for convergence has been added. When iterations are requested,
269 the new test will stop after the first pass if no changes in line break
270 locations are made. Previously, file checksums were used and required at least two
271 passes to verify convergence unless no formatting changes were made. With the new test,
272 only a single pass is needed when formatting changes are limited to adjustments of
273 indentation and whitespace on the lines of code. Extensive testing has been made to
274 verify the correctness of the new convergence test.
276 - Line breaks are now automatically placed after 'use overload' to
277 improve formatting when there are numerous overloaded operators. For
284 - A number of minor problems with parsing signatures and prototypes have
285 been corrected, particularly multi-line signatures. Some signatures
286 had previously been parsed as if they were prototypes, which meant the
287 normal spacing rules were not applied. For example
290 sub echo ($message= 'Hello World!' ) {
295 sub echo ( $message = 'Hello World!' ) {
299 - Numerous minor issues that the average user would not encounter were found
300 and fixed. They can be seen in the more complete list of updates at
302 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
307 <pre><code>- Robustness of perltidy has been significantly improved. Updating is recommended. Continual
308 automated testing runs began about 1 Sep 2020 and numerous issues have been found and fixed.
309 Many involve references to uninitialized variables when perltidy is fed random text and random
312 - Added the token '->' to the list of alignment tokens, as suggested in git
313 #39, so that it can be vertically aligned if a space is placed before them with -wls='->'.
315 - Added parameters -bbhb=n (--break-before-hash-brace=n), -bbsb=n (--break-before-square-bracket=n),
316 and -bbp=n (--break-before-paren=n) suggested in git #38. These provide control over the
317 opening container token of a multiple-line list. Related new parameters -bbhbi=n, -bbsbi=n, -bbpi=n
318 control indentation of these tokens.
320 - Added keyword 'isa'.
325 <pre><code>- Fixed bug git #37, an error when the combination -scbb -csc was used.
326 It occurs in perltidy versions 20200110, 20200619, and 20200822. What happens is
327 that when two consecutive lines with isolated closing braces had new side
328 comments generated by the -csc parameter, a separating newline was missing.
329 The resulting script will not then run, but worse, if it is reformatted with
330 the same parameters then closing side comments could be overwritten and data
333 This problem was found during automated random testing. The parameter
334 -scbb is rarely used, which is probably why this has not been reported. Please
335 upgrade your version.
337 - Added parameter --non-indenting-braces, or -nib, which prevents
338 code from indenting one level if it follows an opening brace marked
339 with a special side comment, '#<<<'. For example,
341 { #<<< a closure to contain lexical vars
343 my $var; # this line does not indent
347 # this line cannot 'see' $var;
349 This is on by default. If your code happens to have some
350 opening braces followed by '#<<<', and you
351 don't want this, you can use -nnib to deactivate it.
353 - Side comment locations reset at a line ending in a level 0 open
354 block, such as when a new multi-line sub begins. This is intended to
355 help keep side comments from drifting to far to the right.
360 <pre><code>- Fix RT #133166, encoding not set for -st. Also reported as RT #133171
363 This is a significant bug in version 20200616 which can corrupt data if
364 perltidy is run as a filter on encoded text.
367 <p><strong>Please upgrade</strong></p>
369 <pre><code>- Fix issue RT #133161, perltidy -html was not working on pod
371 - Fix issue git #33, allow control of space after '->'
373 - Vertical alignment has been improved. Numerous minor issues have
376 - Formatting with the -lp option is improved.
378 - Fixed issue git #32, misparse of bare 'ref' in ternary
380 - When --assert-tidy is used and triggers an error, the first difference
381 between input and output files is shown in the error output. This is
382 a partial response to issue git #30.
387 <pre><code>- Added support for Switch::Plain syntax, issue git #31.
389 - Fixed minor problem where trailing 'unless' clauses were not
390 getting vertically aligned.
392 - Added a parameter --logical-padding or -lop to allow logical padding
393 to be turned off. Requested by git #29. This flag is on by default.
394 The man pages have examples.
396 - Added a parameter -kpit=n to control spaces inside of parens following
397 certain keywords, requested in git#26. This flag is off by default.
399 - Added fix for git#25, improve vertical alignment for long lists with
400 varying numbers of items per line.
402 - calls to the module Perl::Tidy can now capture any output produced
403 by a debug flag or one of the 'tee' flags through the new 'debugfile' and
404 'teefile' call parameters. These output streams are rarely used but
405 they are now treated the same as any 'logfile' stream.
407 - add option --break-at-old-semicolon-breakpoints', -bos, requested
408 in RT#131644. This flag will keep lines beginning with a semicolon.
410 - Added --use-unicode-gcstring to control use of Unicode::GCString for
411 evaluating character widths of encoded data. The default is
412 not to use this (--nouse-unicode-gcstring). If this flag is set,
413 perltidy will look for Unicode::GCString and, if found, will use it
414 to evaluate character display widths. This can improve displayed
415 vertical alignment for files with wide characters. It is a nice
416 feature but it is off by default to avoid conflicting formatting
417 when there are multiple developers. Perltidy installation does not
418 require Unicode::GCString, so users wanting to use this feature need
419 set this flag and also to install Unicode::GCString separately.
421 - Added --character-encoding=guess or -guess to have perltidy guess
422 if a file (or other input stream) is encoded as -utf8 or some
423 other single-byte encoding. This is useful when processing a mixture
424 of file types, such as utf8 and latin-1.
426 Please Note: The default encoding has been set to be 'guess'
427 instead of 'none'. This seems like the best default, since
428 it allows perltidy work properly with both
429 utf8 files and older latin-1 files. The guess mode uses Encode::Guess,
430 which is included in standard perl distributions, and only tries to
431 guess if a file is utf8 or not, never any other encoding. If the guess is
432 utf8, and if the file successfully decodes as utf8, then it the encoding
433 is assumed to be utf8. Otherwise, no encoding is assumed.
434 If you do not want to use this new default guess mode, or have a
435 problem with it, you can set --character-encoding=none (the previous
436 default) or --character-encoding=utf8 (if you deal with utf8 files).
438 - Specific encodings of input files other than utf8 may now be given, for
439 example --character-encoding=euc-jp.
441 - Fix for git#22, Preserve function signature on a single line. An
442 unwanted line break was being introduced when a closing signature paren
443 followed a closing do brace.
445 - Fix RT#132059, the -dac parameter was not working and caused an error exit
447 - When -utf8 is used, any error output is encoded as utf8
449 - Fix for git#19, adjust line break around an 'xor'
451 - Fix for git#18, added warning for missing comma before unknown bare word.
456 <pre><code>- This release adds a flag to control the feature RT#130394 (allow short nested blocks)
457 introduced in the previous release. Unfortunately that feature breaks
458 RPerl installations, so a control flag has been introduced and that feature is now
459 off by default. The flag is:
461 --one-line-block-nesting=n, or -olbn=n, where n is an integer as follows:
463 -olbn=0 break nested one-line blocks into multiple lines [new DEFAULT]
464 -olbn=1 stable; keep existing nested-one line blocks intact [previous DEFAULT]
466 For example, consider this input line:
468 foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
470 The new default behavior (-olbn=0), and behavior prior to version 20191203, is to break it into multiple lines:
473 if ( $_ eq $asked_for ) { last }
477 To keep nested one-line blocks such as this on a single line you can add the parameter -olbn=1.
479 - Fixed issue RT#131288: parse error for un-prototyped constant function without parenthesized
480 call parameters followed by ternary.
482 - Fixed issue RT#131360, installation documentation. Added a note that the binary
483 'perltidy' comes with the Perl::Tidy module. They can both normally be installed with
489 <pre><code>- Fixed issue RT#131115: -bli option not working correctly.
490 Closing braces were not indented in some cases due to a glitch
491 introduced in version 20181120.
493 - Fixed issue RT#130394: Allow short nested blocks. Given the following
495 $factorial = sub { reduce { $a * $b } 1 .. 11 };
497 Previous versions would always break the sub block because it
498 contains another block (the reduce block). The fix keeps
499 short one-line blocks such as this intact.
501 - Implement issue RT#130640: Allow different subroutine keywords.
502 Added a flag --sub-alias-list=s or -sal=s, where s is a string with
503 one or more aliases for 'sub', separated by spaces or commas.
506 perltidy -sal='method fun'
508 will cause the perltidy to treat the words 'method' and 'fun' to be
509 treated the same as if they were 'sub'.
511 - Added flag --space-prototype-paren=i, or -spp=i, to control spacing
512 before the opening paren of a prototype, where i=0, 1, or 2:
514 i=1 follow input [current and default]
517 Previously, perltidy always followed the input.
518 For example, given the following input
523 sub usage(); # i=0 [no space]
524 sub usage(); # i=1 [default; follows input]
525 sub usage (); # i=2 [space]
527 - Fixed issue git#16, minor vertical alignment issue.
529 - Fixed issue git#10, minor conflict of -wn and -ce
531 - Improved some vertical alignments involving two lines.
536 <pre><code>- fixed issue RT#130344: false warning "operator in print statement"
539 - fixed issue RT#130304: standard error output should include filename.
540 When perltidy error messages are directed to the standard error output
541 with -se or --standard-error-output, the message lines now have a prefix
542 'filename:' for clarification in case multiple files
543 are processed, where 'filename' is the name of the input file. If
544 input is from the standard input the displayed filename is '<stdin>',
545 and if it is from a data structure then displayed filename
546 is '<source_stream>'.
548 - implement issue RT#130425: check mode. A new flag '--assert-tidy'
549 will cause an error message if the output script is not identical to
550 the input script. For completeness, the opposite flag '--assert-untidy'
551 has also been added. The next item, RT#130297, insures that the script
552 will exit with a non-zero exit flag if the assertion fails.
554 - fixed issue RT#130297; the perltidy script now exits with a nonzero exit
555 status if it wrote to the standard error output. Prevously only fatal
556 run errors produced a non-zero exit flag. Now, even non-fatal messages
557 requested with the -w flag will cause a non-zero exit flag. The exit
558 flag now has these values:
561 1 = perltidy could not run to completion due to errors
562 2 = perltidy ran to completion with error messages
564 - added warning message for RT#130008, which warns of conflicting input
565 parameters -iob and -bom or -boc.
567 - fixed RT#129850; concerning a space between a closing block brace and
568 opening bracket or brace, as occurs before the '[' in this line:
570 my @addunix = map { File::Spec::Unix->catfile( @ROOT, @$_ ) } ['b'];
572 Formerly, any space was removed. Now it is optional, and the output will
575 - fixed issue git#13, needless trailing whitespace in error message
577 - fixed issue git#9: if the -ce (--cuddled-else) flag is used,
578 do not try to form new one line blocks for a block type
579 specified with -cbl, particularly map, sort, grep
581 - iteration speedup for unchanged code. Previously, when iterations were
582 requested, at least two formatting passes were made. Now just a single pass
583 is made if the formatted code is identical to the input code.
585 - some improved vertical alignments
590 <pre><code>- rt #128477: Prevent inconsistent owner/group and setuid/setgid bits.
591 In the -b (--backup-and-modify-in-place) mode, an attempt is made to set ownership
592 of the output file equal to the input file, if they differ.
593 In all cases, if the final output file ownership differs from input file, any setuid/setgid bits are cleared.
595 - Added option -bom (--break-at-old-method-breakpoints) by
596 merrillymeredith which preserves breakpoints of method chains. Modified to also handle a cuddled call style.
598 - Merged patch to fix Windows EOL translation error with UTF-8 written by
599 Ron Ivy. This update prevents automatic conversion to 'DOS' CRLF line
600 endings. Also, Windows system testing at the appveyor site is working again.
602 - RT #128280, added flag --one-line-block-semicolons=n (-olbs=n)
603 to control semicolons in one-line blocks. The values of n are:
604 n=0 means no semicolons termininating simple one-line blocks
605 n=1 means stable; do not change from input file [DEFAULT and current]
606 n=2 means always add semicolons in one-line blocks
607 The current behavior corresponds to the default n=1.
609 - RT #128216, Minor update to prevent inserting unwanted blank line at
610 indentation level change. This should not change existing scripts.
612 - RT #81852: Improved indentation when quoted word (qw) lists are
613 nested within other containers using the --weld-nested (-wn) flag.
614 The example given previously (below) is now closer to what it would
615 be with a simple list instead of qw:
629 - RT#12764, introduced new feature allowing placement of blanks around
630 sequences of selected keywords. This can be activated with the -kgb*
631 series of parameters described in the manual.
633 - Rewrote vertical algnment module. It is better at finding
634 patterns in complex code. For example,
637 /^-std$/ && do { $std = 1; next; };
638 /^--$/ && do { @link_args = @argv; last; };
639 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
642 /^-std$/ && do { $std = 1; next; };
643 /^--$/ && do { @link_args = @argv; last; };
644 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
646 - Add repository URLs to META files
648 - RT #118553, "leave only one newline at end of file". This option was not
649 added because of undesirable side effects, but a new filter script
650 was added which can do this, "examples/delete_ending_blank_lines.pl".
655 <pre><code>- fix RT#127736 Perl-Tidy-20181119 has the EXE_FILES entry commented out in
656 Makefile.PL so it doesn't install the perltidy script or its manpage.
661 <pre><code>- Removed test case 'filter_example.t' which was causing a failure on a
662 Windows installation for unknown reasons, possibly due to an unexpected
663 perltidyrc being read by the test script. Added VERSION numbers to all
669 <pre><code>- Fixed RT #126965, in which a ternary operator was misparsed if immediately
670 following a function call without arguments, such as:
671 my $restrict_customer = shift ? 1 : 0;
673 - Fixed RT #125012: bug in -mangle --delete-all-comments
674 A needed blank space before bareword tokens was being removed when comments
677 - Fixed RT #81852: Stacked containers and quoting operators. Quoted words
678 (qw) delimited by container tokens ('{', '[', '(', '<') are now included in
679 the --weld-nested (-wn) flag:
693 - The cuddled-else (-ce) coding was merged with the new cuddled-block (-cb)
694 coding. The change is backward compatible and simplifies input.
695 The --cuddled-block-option=n (-cbo=n) flag now applies to both -ce and -cb
696 formatting. In fact the -cb flag is just an alias for -ce now.
698 - Fixed RT #124594, license text desc. changed from 'GPL-2.0+' to 'gpl_2'
700 - Fixed bug in which a warning about a possible code bug was issued in a
701 script with brace errors.
703 - added option --notimestamp or -nts to eliminate any time stamps in output
704 files. This is used to prevent differences in test scripts from causing
705 failure at installation. For example, the -cscw option will put a date
706 stamp on certain closing side comments. We need to avoid this in order
707 to test this feature in an installation test.
709 - Fixed bug with the entab option, -et=8, in which the leading space of
710 some lines was was not entabbed. This happened in code which was adjusted
711 for vertical alignment and in hanging side comments. Thanks to Glenn.
713 - Fixed RT #127633, undesirable line break after return when -baao flag is set
715 - Fixed RT #127035, vertical alignment. Vertical alignment has been improved
716 in several ways. Thanks especially to Michael Wardman and Glenn for sending
719 - Alignment of the =~ operators has been reactivated.
722 $service_profile =~ s/^\s+|\s+$//g;
723 $host_profile =~ s/^\s+|\s+$//g;
726 $service_profile =~ s/^\s+|\s+$//g;
727 $host_profile =~ s/^\s+|\s+$//g;
729 - Alignment of the // operator has been reactivated.
732 is( pop // 7, 7, 'pop // ... works' );
733 is( pop() // 7, 0, 'pop() // ... works' );
734 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
737 is( pop // 7, 7, 'pop // ... works' );
738 is( pop() // 7, 0, 'pop() // ... works' );
739 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
741 - The rules for alignment of just two lines have been adjusted,
742 hopefully to be a little better overall. In some cases, two
743 lines which were previously unaligned are now aligned, and vice-versa.
746 $expect = "1$expect" if $expect =~ /^e/i;
747 $p = "1$p" if defined $p and $p =~ /^e/i;
750 $expect = "1$expect" if $expect =~ /^e/i;
751 $p = "1$p" if defined $p and $p =~ /^e/i;
754 - RT #106493; source code repository location has been added to docs; it is
755 https://github.com/perltidy/perltidy
757 - The packaging for this version has changed. The Tidy.pm module is much
758 smaller. Supporting modules have been split out from it and placed below
759 it in the path Perl/Tidy/*.
761 - A number of new installation test cases have been added. Updates are now
762 continuously tested at Travis CI against versions back to Perl 5.08.
767 <pre><code>- RT #124469, #124494, perltidy often making empty files. The previous had
768 an index error causing it to fail, particularly in version 5.18 of Perl.
770 Please avoid version 20180219.
775 <pre><code>- RT #79947, cuddled-else generalization. A new flag -cb provides
776 'cuddled-else' type formatting for an arbitrary type of block chain. The
777 default is try-catch-finally, but this can be modified with the
780 - Fixed RT #124298: add space after ! operator without breaking !! secret
783 - RT #123749: numerous minor improvements to the -wn flag were made.
785 - Fixed a problem with convergence tests in which iterations were stopping
788 - Here doc targets for <<~ type here-docs may now have leading whitespace.
790 - Fixed RT #124354. The '-indent-only' flag was not working correctly in the
791 previous release. A bug in version 20180101 caused extra blank lines
794 - Issue RT #124114. Some improvements were made in vertical alignment
795 involving 'fat commas'.
800 <pre><code>- Added new flag -wn (--weld-nested-containers) which addresses these issues:
801 RT #123749: Problem with promises;
802 RT #119970: opening token stacking strange behavior;
803 RT #81853: Can't stack block braces
805 This option causes closely nested pairs of opening and closing containers
806 to be "welded" together and essentially be formatted as a single unit,
807 with just one level of indentation.
809 Since this is a new flag it is set to be "off" by default but it has given
810 excellent results in testing.
812 EXAMPLE 1, multiple blocks, default formatting:
815 next if $x == $y; # do something here
817 } until $x++ > $z;
822 } } until $x++ > $z;
824 EXAMPLE 2, three levels of wrapped function calls, default formatting:
828 translate( param('verb') ), param('tense'),
836 translate( param('verb') ),
837 param('tense'), param('person')
840 # EXAMPLE 3, chained method calls, default formatting:
841 get('http://mojolicious.org')->then(
844 say $mojo->res->code;
845 return get('http://metacpan.org');
850 say $cpan->res->code;
855 warn "Something went wrong: $err";
860 get('http://mojolicious.org')->then( sub {
862 say $mojo->res->code;
863 return get('http://metacpan.org');
866 say $cpan->res->code;
869 warn "Something went wrong: $err";
873 - Fixed RT #114359: Missparsing of "print $x ** 0.5;
875 - Deactivated the --check-syntax flag for better security. It will be
878 - Corrected minimum perl version from 5.004 to 5.008 based on perlver
879 report. The change is required for coding involving wide characters.
881 - For certain severe errors, the source file will be copied directly to the
882 output without formatting. These include ending in a quote, ending in a
883 here doc, and encountering an unidentified character.
888 <pre><code>- RT #123749, partial fix. "Continuation indentation" is removed from lines
889 with leading closing parens which are part of a call chain.
890 For example, the call to pack() is is now outdented to the starting
891 indentation in the following experession:
895 -text => "New Document",
896 -command => \&new_document
898 -side => 'bottom',
904 -text => "New Document",
905 -command => \&new_document
907 -side => 'bottom',
911 This modification improves readability of complex expressions, especially
912 when the user uses the same value for continuation indentation (-ci=n) and
913 normal indentation (-i=n). Perltidy was already programmed to
914 do this but a minor bug was preventing it.
916 - RT #123774, added flag to control space between a backslash and a single or
917 double quote, requested by Robert Rothenberg. The issue is that lines like
922 confuse syntax highlighters unless a space is left between the backslash and
925 The new flag to control this is -sbq=n (--space-backslash-quote=n),
926 where n=0 means no space, n=1 means follow existing code, n=2 means always
927 space. The default is n=1, meaning that a space will be retained if there
928 is one in the source code.
930 - Fixed RT #123492, support added for indented here doc operator <<~ added
931 in v5.26. Thanks to Chris Weyl for the report.
933 - Fixed docs; --closing-side-comment-list-string should have been just
934 --closing-side-comment-list. Thanks to F.Li.
936 - Added patch RT #122030] Perl::Tidy sometimes does not call binmode.
937 Thanks to Irilis Aelae.
939 - Fixed RT #121959, PERLTIDY doesn't honor the 'three dot' notation for
940 locating a config file using environment variables. Thanks to John
943 - Minor improvements to formatting, in which some additional vertical
944 aligmnemt is done. Thanks to Keith Neargarder.
946 - RT #119588. Vertical alignment is no longer done for // operator.
951 <pre><code>- Fixed debian #862667: failure to check for perltidy.ERR deletion can lead
952 to overwriting arbitrary files by symlink attack. Perltidy was continuing
953 to write files after an unlink failure. Thanks to Don Armstrong
956 - Fixed RT #116344, perltidy fails on certain anonymous hash references:
957 in the following code snippet the '?' was misparsed as a pattern
958 delimiter rather than a ternary operator.
959 return ref {} ? 1 : 0;
961 - Fixed RT #113792: misparsing of a fat comma (=>) right after
962 the __END__ or __DATA__ tokens. These keywords were getting
963 incorrectly quoted by the following => operator.
965 - Fixed RT #118558. Custom Getopt::Long configuration breaks parsing
966 of perltidyrc. Perltidy was resetting the users configuration too soon.
968 - Fixed RT #119140, failure to parse double diamond operator. Code to
969 handle this new operator has been added.
971 - Fixed RT #120968. Fixed problem where -enc=utf8 didn't work
972 with --backup-and-modify-in-place. Thanks to Heinz Knutzen for this patch.
974 - Fixed minor formatting issue where one-line blocks for subs with signatures
975 were unnecessarily broken
977 - RT #32905, patch to fix utf-8 error when output was STDOUT.
979 - RT #79947, improved spacing of try/catch/finally blocks. Thanks to qsimpleq
982 - Fixed #114909, Anonymous subs with signatures and prototypes misparsed as
983 broken ternaries, in which a statement such as this was not being parsed
985 return sub ( $fh, $out ) : prototype(*$) { ... }
987 - Implemented RT #113689, option to introduces spaces after an opening block
988 brace and before a closing block brace. Four new optional controls are
989 added. The first two define the minimum number of blank lines to be
992 -blao=i or --blank-lines-after-opening-block=i
993 -blbc=i or --blank-lines-before-closing-block=i
995 where i is an integer, the number of lines (the default is 0).
997 The second two define the types of blocks to which the first two apply
999 -blaol=s or --blank-lines-after-opening-block-list=s
1000 -blbcl=s or --blank-lines-before-closing-block-list=s
1002 where s is a string of possible block keywords (default is just 'sub',
1003 meaning a named subroutine).
1005 For more information please see the documentation.
1007 - The method for specifying block types for certain input parameters has
1008 been generalized to distinguish between normal named subroutines and
1009 anonymous subs. The keyword for normal subroutines remains 'sub', and
1010 the new keyword for anonymous subs is 'asub'.
1012 - Minor documentation changes. The BUGS sections now have a link
1013 to CPAN where most open bugs and issues can be reviewed and bug reports
1014 can be submitted. The information in the AUTHOR and CREDITS sections of
1015 the man pages have been removed from the man pages to streamline the
1016 documentation. This information is still in the source code.
1021 <pre><code>- RT #112534. Corrected a minor problem in which an unwanted newline
1022 was placed before the closing brace of an anonymous sub with
1023 a signature, if it was in a list. Thanks to Dmytro Zagashev.
1025 - Corrected a minor problem in which occasional extra indentation was
1026 given to the closing brace of an anonymous sub in a list when the -lp
1032 <pre><code> - RT #104427. Added support for signatures.
1034 - RT #111512. Changed global warning flag $^W = 1 to use warnings;
1035 Thanks to Dmytro Zagashev.
1037 - RT #110297, added support for new regexp modifier /n
1038 Thanks to Dmytro Zagashev.
1040 - RT #111519. The -io (--indent-only) and -dac (--delete-all-comments)
1041 can now both be used in one pass. Thanks to Dmitry Veltishev.
1043 - Patch to avoid error message with 'catch' used by TryCatch, as in
1047 Thanks to Nick Tonkin.
1049 - RT #32905, UTF-8 coding is now more robust. Thanks to qsimpleq
1050 and Dmytro for patches.
1052 - RT #106885. Added string bitwise operators ^. &. |. ~. ^.= &.= |.=
1054 - Fixed RT #107832 and #106492, lack of vertical alignment of two lines
1055 when -boc flag (break at old commas) is set. This bug was
1056 inadvertently introduced in previous bug fix RT #98902.
1058 - Some common extensions to Perl syntax are handled better.
1059 In particular, the following snippet is now foratted cleanly:
1061 method deposit( Num $amount) {
1062 $self->balance( $self->balance + $amount );
1065 A new flag -xs (--extended-syntax) was added to enable this, and the default
1068 In previous versions, and now only when -nxs is set, this snippet of code
1069 generates the following error message:
1071 "syntax error at ') {', didn't see one of: case elsif for foreach given if switch unless until when while"
1076 <pre><code> - Fixed RT# 105484, Invalid warning about 'else' in 'switch' statement. The
1077 warning happened if a 'case' statement did not use parens.
1079 - Fixed RT# 101547, misparse of // caused error message. Also..
1081 - Fixed RT# 102371, misparse of // caused unwated space in //=
1083 - Fixed RT# 100871, "silent failure of HTML Output on Windows".
1084 Changed calls to tempfile() from:
1085 my ( $fh_tmp, $tmpfile ) = tempfile();
1086 to have the full path name:
1087 my ( $fh_tmp, $tmpfile ) = File::Temp::tempfile()
1088 because of problems in the Windows version reported by Dean Pearce.
1090 - Fixed RT# 99514, calling the perltidy module multiple times with
1091 a .perltidyrc file containing the parameter --output-line-ending
1092 caused a crash. This was a glitch in the memoization logic.
1094 - Fixed RT#99961, multiple lines inside a cast block caused unwanted
1095 continuation indentation.
1097 - RT# 32905, broken handling of UTF-8 strings.
1098 A new flag -utf8 causes perltidy assume UTF-8 encoding for input and
1099 output of an io stream. Thanks to Sebastian Podjasek for a patch.
1100 This feature may not work correctly in older versions of Perl.
1101 It worked in a linux version 5.10.1 but not in a Windows version 5.8.3 (but
1102 otherwise perltidy ran correctly).
1104 - Warning files now report perltidy VERSION. Suggested by John Karr.
1106 - Fixed long flag --nostack-closing-tokens (-nsct has always worked though).
1107 This was due to a typo. This also fixed --nostack-opening-tokens to
1108 behave correctly. Thanks to Rob Dixon.
1113 <pre><code>- Fixed RT #94902: abbreviation parsing in .perltidyrc files was not
1114 working for multi-line abbreviations. Thanks to Eric Fung for
1117 - Fixed RT #95708, misparsing of a hash when the first key was a perl
1118 keyword, causing a semicolon to be incorrectly added.
1120 - Fixed RT #94338 for-loop in a parenthesized block-map. A code block within
1121 parentheses of a map, sort, or grep function was being mistokenized. In
1122 rare cases this could produce in an incorrect error message. The fix will
1123 produce some minor formatting changes. Thanks to Daniel Trizen
1124 discovering and documenting this.
1126 - Fixed RT #94354, excess indentation for stacked tokens. Thanks to
1127 Colin Williams for supplying a patch.
1129 - Added support for experimental postfix dereferencing notation introduced in
1130 perl 5.20. RT #96021.
1132 - Updated documentation to clarify the behavior of the -io flag
1133 in response to RT #95709. You can add -noll or -l=0 to prevent
1134 long comments from being outdented when -io is used.
1136 - Added a check to prevent a problem reported in RT #81866, where large
1137 scripts which had been compressed to a single line could not be formatted
1138 because of a check for VERSION for MakeMaker. The workaround was to
1139 use -nvpl, but this shouldn't be necessary now.
1141 - Fixed RT #96101; Closing brace of anonymous sub in a list was being
1142 indented. For example, the closing brace of the anonymous sub below
1143 will now be lined up with the word 'callback'. This problem
1144 occurred if there was no comma after the closing brace of the anonymous sub.
1145 This update may cause minor changes to formatting of code with lists
1146 of anonymous subs, especially TK code.
1153 path => '/_Operate/Transcode and split',
1154 callback => sub {
1155 return 1 if not $self->project_opened;
1156 $self->comp('project')->transcode( split => 1 );
1166 path => '/_Operate/Transcode and split',
1167 callback => sub {
1168 return 1 if not $self->project_opened;
1169 $self->comp('project')->transcode( split => 1 );
1177 <pre><code>- Fixed RT #94190 and debian Bug #742004: perltidy.LOG file left behind.
1178 Thanks to George Hartzell for debugging this. The problem was
1179 caused by the memoization speedup patch in version 20121207. An
1180 unwanted flag was being set which caused a LOG to be written if
1181 perltidy was called multiple times.
1183 - New default behavior for LOG files: If the source is from an array or
1184 string (through a call to the perltidy module) then a LOG output is only
1185 possible if a logfile stream is specified. This is to prevent
1186 unexpected perltidy.LOG files.
1188 - Fixed debian Bug #740670, insecure temporary file usage. File::Temp is now
1189 used to get a temporary file. Thanks to Don Anderson for a patch.
1191 - Any -b (--backup-and-modify-in-place) flag is silently ignored when a
1192 source stream, destination stream, or standard output is used.
1193 This is because the -b flag may have been in a .perltidyrc file and
1194 warnings break Test::NoWarnings. Thanks to Marijn Brand.
1199 <pre><code>- Fixed RT #88020. --converge was not working with wide characters.
1201 - Fixed RT #78156. package NAMESPACE VERSION syntax not accepted.
1203 - First attempt to fix RT #88588. INDEX END tag change in pod2html breaks
1204 perltidy -html. I put in a patch which should work but I don't yet have
1205 a way of testing it.
1210 <pre><code>- Fixed RT #87107, spelling
1215 <pre><code>- Fixed RT #87502, incorrect of parsing of smartmatch before hash brace
1217 - Added feature request RT #87330, trim whitespace after POD.
1218 The flag -trp (--trim-pod) will trim trailing whitespace from lines of POD
1223 <pre><code>- Fixed RT #86929, #86930, missing lhs of assignment.
1225 - Fixed RT #84922, moved pod from Tidy.pm into Tidy.pod
1230 <pre><code>- The flag -cab=n or --comma-arrow-breakpoints=n has been generalized
1231 to give better control over breaking open short containers. The
1232 possible values are now:
1234 n=0 break at all commas after =>
1235 n=1 stable: break at all commas after => if container is open,
1236 EXCEPT FOR one-line containers
1237 n=2 break at all commas after =>, BUT try to form the maximum
1238 maximum one-line container lengths
1239 n=3 do not treat commas after => specially at all
1240 n=4 break everything: like n=0 but also break a short container with
1241 a => not followed by a comma
1242 n=5 stable: like n=1 but ALSO break at open one-line containers (default)
1244 New values n=4 and n=5 have been added to allow short blocks to be
1245 broken open. The new default is n=5, stable. It should more closely
1246 follow the breaks in the input file, and previously formatted code
1247 should remain unchanged. If this causes problems use -cab=1 to recover
1248 the former behavior. Thanks to Tony Maszeroski for the suggestion.
1250 To illustrate the need for the new options, if perltidy is given
1251 the following code, then the old default (-cab=1) was to close up
1252 the 'index' container even if it was open in the source. The new
1253 default (-cab=5) will keep it open if it was open in the source.
1258 'key' => 'value',
1268 - New debug flag --memoize (-mem). This version contains a
1269 patch supplied by Jonathan Swartz which can significantly speed up
1270 repeated calls to Perl::Tidy::perltidy in a single process by caching
1271 the result of parsing the formatting parameters. A factor of up to 10
1272 speedup was achieved for masontidy (https://metacpan.org/module/masontidy).
1273 The memoization patch is on by default but can be deactivated for
1274 testing with -nmem (or --no-memoize).
1276 - New flag -tso (--tight-secret-operators) causes certain perl operator
1277 sequences (secret operators) to be formatted "tightly" (without spaces).
1278 The most common of these are 0 + and + 0 which become 0+ and +0. The
1279 operators currently modified by this flag are:
1280 =( )= 0+ +0 ()x!! ~~<> ,=>
1281 Suggested by by Philippe Bruhat. See https://metacpan.org/module/perlsecret
1282 This flag is off by default.
1284 - New flag -vmll (--variable-maximum-line-length) makes the maximum
1285 line length increase with the nesting depth of a line of code.
1286 Basically, it causes the length of leading whitespace to be ignored when
1287 setting line breaks, so the formatting of a block of code is independent
1288 of its nesting depth. Try this option if you have deeply nested
1289 code or data structures, perhaps in conjunction with the -wc flag
1290 described next. The default is not todo this.
1292 - New flag -wc=n (--whitespace-cycle=n) also addresses problems with
1293 very deeply nested code and data structures. When this parameter is
1294 used and the nesting depth exceeds the value n, the leading whitespace
1295 will be reduced and start at 1 again. The result is that deeply
1296 nested blocks of code will shift back to the left. This occurs cyclically
1297 to any nesting depth. This flag may be used either with or without -vmll.
1298 The default is not to use this (-wc=0).
1300 - Fixed RT #78764, error parsing smartmatch operator followed by anonymous
1301 hash or array and then a ternary operator; two examples:
1303 qr/3/ ~~ ['1234'] ? 1 : 0;
1304 map { $_ ~~ [ '0', '1' ] ? 'x' : 'o' } @a;
1306 - Fixed problem with specifying spaces around arrows using -wls='->'
1307 and -wrs='->'. Thanks to Alain Valleton for documenting this problem.
1309 - Implemented RT #53183, wishlist, lines of code with the same indentation
1310 level which are contained with multiple stacked opening and closing tokens
1311 (requested with flags -sot -sct) now have reduced indentation.
1314 $sender->MailMsg(
1317 subject => $subject,
1322 # OLD: perltidy -sot -sct
1323 $sender->MailMsg( {
1325 subject => $subject,
1329 # NEW: perltidy -sot -sct
1330 $sender->MailMsg( {
1332 subject => $subject,
1336 - New flag -act=n (--all-containers-tightness=n) is an abbreviation for
1337 -pt=n -sbt=n -bt=n -bbt=n, where n=0,1, or 2. It simplifies input when all
1338 containers have the same tightness. Using the same example:
1340 # NEW: perltidy -sot -sct -act=2
1341 $sender->MailMsg({
1343 subject => $subject,
1347 - New flag -sac (--stack-all-containers) is an abbreviation for -sot -sct
1348 This is part of wishlist item RT #53183. Using the same example again:
1350 # NEW: perltidy -sac -act=2
1351 $sender->MailMsg({
1353 subject => $subject,
1357 - new flag -scbb (--stack-closing-block-brace) causes isolated closing
1358 block braces to stack as in the following example. (Wishlist item RT#73788)
1365 push( @lines, "$w1 $w2 $w3 $w4\n" );
1376 push( @lines, "$w1 $w2 $w3 $w4\n" );
1379 There is, at present, no flag to place these closing braces at the end
1380 of the previous line. It seems difficult to develop good rules for
1381 doing this for a wide variety of code and data structures.
1383 - Parameters defining block types may use a wildcard '*' to indicate
1384 all block types. Previously it was not possible to include bare blocks.
1386 - A flag -sobb (--stack-opening-block-brace) has been introduced as an
1387 alias for -bbvt=2 -bbvtl='*'. So for example the following test code:
1389 {{{{{{{ $testing }}}}}}}
1391 cannot be formatted as above but can at least be kept vertically compact
1392 using perltidy -sobb -scbb
1394 { { { { { { { $testing
1397 Or even, perltidy -sobb -scbb -i=1 -bbt=2
1402 - Error message improved for conflicts due to -pbp; thanks to Djun Kim.
1404 - Fixed RT #80645, error parsing special array name '@$' when used as
1407 - Eliminated the -chk debug flag which was included in version 20010406 to
1408 do a one-time check for a bug with multi-line quotes. It has not been
1411 - Numerous other minor formatting improvements.
1416 <pre><code>- Added flag -iscl (--ignore-side-comment-lengths) which causes perltidy
1417 to ignore the length of side comments when setting line breaks,
1418 RT #71848. The default is to include the length of side comments when
1419 breaking lines to stay within the length prescribed by the -l=n
1420 maximum line length parameter. For example,
1422 Default behavior on a single line with long side comment:
1423 $vmsfile =~ s/;[\d\-]*$//
1424 ; # Clip off version number; we can use a newer version as well
1426 perltidy -iscl leaves the line intact:
1428 $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well
1430 - Fixed RT #78182, side effects with STDERR. Error handling has been
1431 revised and the documentation has been updated. STDERR can now be
1432 redirected to a string reference, and perltidy now returns an
1433 error flag instead of calling die when input errors are detected.
1434 If the error flag is set then no tidied output was produced.
1435 See man Perl::Tidy for an example.
1437 - Fixed RT #78156, erroneous warning message for package VERSION syntax.
1439 - Added abbreviations -conv (--converge) to simplify iteration control.
1440 -conv is equivalent to -it=4 and will insure that the tidied code is
1441 converged to its final state with the minimum number of iterations.
1443 - Minor formatting modifications have been made to insure convergence.
1445 - Simplified and hopefully improved the method for guessing the starting
1446 indentation level of entabbed code. Added flag -dt=n (--default_tabsize=n)
1447 which might be helpful if the guessing method does not work well for
1450 - Added support for stacked labels, upper case X/B in hex and binary, and
1453 - Eliminated warning messages for using keyword names as constants.
1458 <pre><code>- Corrected problem introduced by using a chomp on scalar references, RT #77978
1460 - Added support for Perl 5.14 package block syntax, RT #78114.
1462 - A convergence test is made if three or more iterations are requested with
1463 the -it=n parameter to avoid wasting computer time. Several hundred Mb of
1464 code gleaned from the internet were searched with the results that:
1465 - It is unusual for two iterations to be required unless a major
1466 style change is being made.
1467 - Only one case has been found where three iterations were required.
1468 - No cases requiring four iterations have been found with this version.
1469 For the previous version several cases where found the results could
1470 oscillate between two semi-stable states. This version corrects this.
1472 So if it is important that the code be converged it is okay to set -it=4
1473 with this version and it will probably stop after the second iteration.
1475 - Improved ability to identify and retain good line break points in the
1476 input stream, such as at commas and equals. You can always tell
1477 perltidy to ignore old breakpoints with -iob.
1479 - Fixed glitch in which a terminal closing hash brace followed by semicolon
1480 was not outdented back to the leading line depth like other closing
1481 tokens. Thanks to Keith Neargarder for noting this.
1484 my ( $pre, $post ) = @{
1486 "pp_anonlist" => [ "[", "]" ],
1487 "pp_anonhash" => [ "{", "}" ]
1488 }->{ $kid->ppaddr }
1492 my ( $pre, $post ) = @{
1494 "pp_anonlist" => [ "[", "]" ],
1495 "pp_anonhash" => [ "{", "}" ]
1496 }->{ $kid->ppaddr }
1499 - Removed extra indentation given to trailing 'if' and 'unless' clauses
1500 without parentheses because this occasionally produced undesirable
1501 results. This only applies where parens are not used after the if or
1506 unless my ( $who, $actions ) =
1507 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1511 unless my ( $who, $actions ) =
1512 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1517 <pre><code>- Updated perltidy to handle all quote modifiers defined for perl 5 version 16.
1519 - Side comment text in perltidyrc configuration files must now begin with
1520 at least one space before the #. Thus:
1523 -l=78 # Max line width is 78 cols
1525 -l=78# Max line width is 78 cols
1527 This is probably true of almost all existing perltidyrc files,
1528 but if you get an error message about bad parameters
1529 involving a '#' the first time you run this version, please check the side
1530 comments in your perltidyrc file, and add a space before the # if necessary.
1531 You can quickly see the contents your perltidyrc file, if any, with the
1536 The reason for this change is that some parameters naturally involve
1537 the # symbol, and this can get interpreted as a side comment unless the
1538 parameter is quoted. For example, to define -sphb=# it used to be necessary
1541 to keep the # from becoming part of a comment. This was causing
1542 trouble for new users. Now it can also be written without quotes:
1545 - Fixed bug in processing some .perltidyrc files containing parameters with
1546 an opening brace character, '{'. For example the following was
1547 incorrectly processed:
1548 --static-block-comment-prefix="^#{2,}[^\s#]"
1551 - Added flag -boa (--break-at-old-attribute-breakpoints) which retains
1552 any existing line breaks at attribute separation ':'. This is now the
1553 default, use -nboa to deactivate. Thanks to Daphne Phister for the patch.
1554 For example, given the following code, the line breaks at the ':'s will be
1560 : Get('Name' => 'foo') : Set('Name');
1562 whereas the previous version would have output a single line. If
1563 the attributes are on a single line then they will remain on a single line.
1565 - Added new flags --blank-lines-before-subs=n (-blbs=n) and
1566 --blank-lines-before-packages=n (-blbp=n) to put n blank lines before
1567 subs and packages. The old flag -bbs is now equivalent to -blbs=1 -blbp=1.
1568 and -nbbs is equivalent to -blbs=0 -blbp=0. Requested by M. Schwern and
1571 - Added feature -nsak='*' meaning no space between any keyword and opening
1572 paren. This avoids listing entering a long list of keywords. Requested
1575 - Added option to delete a backup of original file with in-place-modify (-b)
1576 if there were no errors. This can be requested with the flag -bext='/'.
1577 See documentation for details. Requested by M. Schwern and others.
1579 - Fixed bug where the module postfilter parameter was not applied when -b
1580 flag was used. This was discovered during testing.
1582 - Fixed in-place-modify (-b) to work with symbolic links to source files.
1583 Thanks to Ted Johnson.
1585 - Fixed bug where the Perl::Tidy module did not allow -b to be used
1588 - No extra blank line is added before a comment which follows
1589 a short line ending in an opening token, for example like this:
1593 # unless we follow a blank or comment line
1594 $last_line_leading_type !~ /^[#b]$/
1599 # unless we follow a blank or comment line
1600 $last_line_leading_type !~ /^[#b]$/
1603 The blank is not needed for readability in these cases because there
1604 already is already space above the comment. If a blank already
1605 exists there it will not be removed, so this change should not
1606 change code which has previously been formatted with perltidy.
1607 Thanks to R.W.Stauner.
1609 - Likewise, no extra blank line is added above a comment consisting of a
1610 single #, since nothing is gained in readability.
1612 - Fixed error in which a blank line was removed after a #>>> directive.
1613 Thanks to Ricky Morse.
1615 - Unnecessary semicolons after given/when/default blocks are now removed.
1617 - Fixed bug where an unwanted blank line could be added before
1618 pod text in __DATA__ or __END__ section. Thanks to jidani.
1620 - Changed exit flags from 1 to 0 to indicate success for -help, -version,
1621 and all -dump commands. Also added -? as another way to dump the help.
1622 Requested by Keith Neargarder.
1624 - Fixed bug where .ERR and .LOG files were not written except for -it=2 or more
1626 - Fixed bug where trailing blank lines at the end of a file were dropped when
1629 - Fixed bug where a line occasionally ended with an extra space. This reduces
1630 rhe number of instances where a second iteration gives a result different
1633 - Updated documentation to note that the Tidy.pm module <stderr> parameter may
1634 not be a reference to SCALAR or ARRAY; it must be a file.
1636 - Syntax check with perl now work when the Tidy.pm module is processing
1637 references to arrays and strings. Thanks to Charles Alderman.
1639 - Zero-length files are no longer processed due to concerns for data loss
1640 due to side effects in some scenarios.
1642 - block labels, if any, are now included in closing side comment text
1643 when the -csc flag is used. Suggested by Aaron. For example,
1644 the label L102 in the following block is now included in the -csc text:
1646 L102: for my $i ( 1 .. 10 ) {
1648 } ## end L102: for my $i ( 1 .. 10 )
1653 <pre><code>- added new flag -it=n or --iterations=n
1654 This flag causes perltidy to do n complete iterations.
1655 For most purposes the default of n=1 should be satisfactory. However n=2
1656 can be useful when a major style change is being made, or when code is being
1657 beautified on check-in to a source code control system. The run time will be
1658 approximately proportional to n, and it should seldom be necessary to use a
1659 value greater than n=2. Thanks to Jonathan Swartz
1661 - A configuration file pathname begins with three dots, e.g.
1662 ".../.perltidyrc", indicates that the file should be searched for starting
1663 in the current directory and working upwards. This makes it easier to have
1664 multiple projects each with their own .perltidyrc in their root directories.
1665 Thanks to Jonathan Swartz for this patch.
1667 - Added flag --notidy which disables all formatting and causes the input to be
1668 copied unchanged. This can be useful in conjunction with hierarchical
1669 F<.perltidyrc> files to prevent unwanted tidying.
1670 Thanks to Jonathan Swartz for this patch.
1672 - Added prefilters and postfilters in the call to the Tidy.pm module.
1673 Prefilters and postfilters. The prefilter is a code reference that
1674 will be applied to the source before tidying, and the postfilter
1675 is a code reference to the result before outputting.
1677 Thanks to Jonathan Swartz for this patch. He writes:
1678 This is useful for all manner of customizations. For example, I use
1679 it to convert the 'method' keyword to 'sub' so that perltidy will work for
1680 Method::Signature::Simple code:
1682 Perl::Tidy::perltidy(
1683 prefilter => sub { $_ = $_[0]; s/^method (.*)/sub $1 \#__METHOD/gm; return $_ },
1684 postfilter => sub { $_ = $_[0]; s/^sub (.*?)\s* \#__METHOD/method $1/gm; return $_ }
1687 - The starting indentation level of sections of code entabbed with -et=n
1688 is correctly guessed if it was also produced with the same -et=n flag. This
1689 keeps the indentation stable on repeated formatting passes within an editor.
1690 Thanks to Sam Kington and Glenn.
1692 - Functions with prototype '&' had a space between the function and opening
1693 peren. This space now only occurs if the flag --space-function-paren (-sfp)
1694 is set. Thanks to Zrajm Akfohg.
1696 - Patch to never put spaces around a bare word in braces beginning with ^ as in:
1697 my $before = ${^PREMATCH};
1698 even if requested with the -bt=0 flag because any spaces cause a syntax error in perl.
1699 Thanks to Fabrice Dulanoy.
1704 <pre><code>- Allow configuration file to be 'perltidy.ini' for Windows systems.
1705 i.e. C:\Documents and Settings\User\perltidy.ini
1706 and added documentation for setting configuation file under Windows in man
1707 page. Thanks to Stuart Clark.
1709 - Corrected problem of unwanted semicolons in hash ref within given/when code.
1710 Thanks to Nelo Onyiah.
1712 - added new flag -cscb or --closing-side-comments-balanced
1713 When using closing-side-comments, and the closing-side-comment-maximum-text
1714 limit is exceeded, then the comment text must be truncated. Previous
1715 versions of perltidy terminate with three dots, and this can still be
1716 achieved with -ncscb:
1718 perltidy -csc -ncscb
1720 } ## end foreach my $foo (sort { $b cmp $a ...
1722 However this causes a problem with older editors which cannot recognize
1723 comments or are not configured to doso because they cannot "bounce" around in
1724 the text correctly. The B<-cscb> flag tries to help them by
1725 appending appropriate terminal balancing structure:
1729 } ## end foreach my $foo (sort { $b cmp $a ... })
1731 Since there is much to be gained and little to be lost by doing this,
1732 the default is B<-cscb>. Use B<-ncscb> if you do not want this.
1734 Thanks to Daniel Becker for suggesting this option.
1736 - After an isolated closing eval block the continuation indentation will be
1737 removed so that the braces line up more like other blocks. Thanks to Yves Orton.
1756 -A new flag -asbl (or --opening-anonymous-sub-brace-on-new-line) has
1757 been added to put the opening brace of anonymous sub's on a new line,
1758 as in the following snippet:
1763 return $arg->(@_);
1766 This was not possible before because the -sbl flag only applies to named
1767 subs. Thanks to Benjamin Krupp.
1769 -Fix tokenization bug with the following snippet
1770 print 'hi' if { x => 1, }->{x};
1771 which resulted in a semicolon being added after the comma. The workaround
1772 was to use -nasc, but this is no longer necessary. Thanks to Brian Duggan.
1774 -Fixed problem in which an incorrect error message could be triggered
1775 by the (unusual) combination of parameters -lp -i=0 -l=2 -ci=0 for
1776 example. Thanks to Richard Jelinek.
1778 -A new flag --keep-old-blank-lines=n has been added to
1779 give more control over the treatment of old blank lines in
1780 a script. The manual has been revised to discuss the new
1781 flag and clarify the treatment of old blank lines. Thanks
1787 <pre><code>-Improved support for perl 5.10: New quote modifier 'p', new block type UNITCHECK,
1788 new keyword break, improved formatting of given/when.
1790 -Corrected tokenization bug of something like $var{-q}.
1792 -Numerous minor formatting improvements.
1794 -Corrected list of operators controlled by -baao -bbao to include
1795 . : ? && || and or err xor
1797 -Corrected very minor error in log file involving incorrect comment
1798 regarding need for upper case of labels.
1800 -Fixed problem where perltidy could run for a very long time
1801 when given certain non-perl text files.
1803 -Line breaks in un-parenthesized lists now try to follow
1804 line breaks in the input file rather than trying to fill
1805 lines. This usually works better, but if this causes
1806 trouble you can use -iob to ignore any old line breaks.
1807 Example for the following input snippet:
1810 "conformability (Not the same dimension)\n",
1811 "\t", $have, " is ", text_unit($hu), "\n",
1812 "\t", $want, " is ", text_unit($wu), "\n",
1816 print "conformability (Not the same dimension)\n", "\t", $have, " is ",
1817 text_unit($hu), "\n", "\t", $want, " is ", text_unit($wu), "\n",;
1820 print "conformability (Not the same dimension)\n",
1821 "\t", $have, " is ", text_unit($hu), "\n",
1822 "\t", $want, " is ", text_unit($wu), "\n",
1828 <pre><code>-Added -fpsc option (--fixed-position-side-comment). Thanks to Ueli Hugenschmidt.
1829 For example -fpsc=40 tells perltidy to put side comments in column 40
1832 -Added -bbao and -baao options (--break-before-all-operators and
1833 --break-after-all-operators) to simplify command lines and configuration
1834 files. These define an initial preference for breaking at operators which can
1835 be modified with -wba and -wbb flags. For example to break before all operators
1836 except an = one could use --bbao -wba='=' rather than listing every
1837 single perl operator (except =) on a -wbb flag.
1839 -Added -kis option (--keep-interior-semicolons). Use the B<-kis> flag
1840 to prevent breaking at a semicolon if there was no break there in the
1841 input file. To illustrate, consider the following input lines:
1843 dbmclose(%verb_delim); undef %verb_delim;
1844 dbmclose(%expanded); undef %expanded;
1845 dbmclose(%global); undef %global;
1847 Normally these would be broken into six lines, but
1848 perltidy -kis gives:
1850 dbmclose(%verb_delim); undef %verb_delim;
1851 dbmclose(%expanded); undef %expanded;
1852 dbmclose(%global); undef %global;
1854 -Improved formatting of complex ternary statements, with indentation
1855 of nested statements.
1857 return defined( $cw->{Selected} )
1859 ? @{ $cw->{Selected} }
1860 : $cw->{Selected}[0]
1864 return defined( $cw->{Selected} )
1866 ? @{ $cw->{Selected} }
1867 : $cw->{Selected}[0]
1870 -Text following un-parenthesized if/unless/while/until statements get a
1871 full level of indentation. Suggested by Jeff Armstrong and others.
1873 return $ship->chargeWeapons("phaser-canon")
1874 if $encounter->description eq 'klingon'
1875 and $ship->firepower >= $encounter->firepower
1876 and $location->status ne 'neutral';
1878 return $ship->chargeWeapons("phaser-canon")
1879 if $encounter->description eq 'klingon'
1880 and $ship->firepower >= $encounter->firepower
1881 and $location->status ne 'neutral';
1886 <pre><code>-Fixed bug where #line directives were being indented. Thanks to
1892 <pre><code>-Fixed problem where an extra blank line was added after an =cut when either
1893 (a) the =cut started (not stopped) a POD section, or (b) -mbl > 1.
1894 Thanks to J. Robert Ray and Bill Moseley.
1899 <pre><code>-ole (--output-line-ending) and -ple (--preserve-line-endings) should
1900 now work on all systems rather than just unix systems. Thanks to Dan
1903 -Fixed problem of a warning issued for multiple subs for BEGIN subs
1904 and other control subs. Thanks to Heiko Eissfeldt.
1906 -Fixed problem where no space was introduced between a keyword or
1907 bareword and a colon, such as:
1909 ( ref($result) eq 'HASH' && !%$result ) ? undef: $result;
1913 -Added a utility program 'break_long_quotes.pl' to the examples directory of
1914 the distribution. It breaks long quoted strings into a chain of concatenated
1915 sub strings no longer than a selected length. Suggested by Michael Renner as
1916 a perltidy feature but was judged to be best done in a separate program.
1918 -Updated docs to remove extra < and >= from list of tokens
1919 after which breaks are made by default. Thanks to Bob Kleemann.
1921 -Removed improper uses of $_ to avoid conflicts with external calls, giving
1922 error message similar to:
1923 Modification of a read-only value attempted at
1924 /usr/share/perl5/Perl/Tidy.pm line 6907.
1925 Thanks to Michael Renner.
1927 -Fixed problem when errorfile was not a plain filename or filehandle
1928 in a call to Tidy.pm. The call
1929 perltidy(source => \$input, destination => \$output, errorfile => \$err);
1930 gave the following error message:
1931 Not a GLOB reference at /usr/share/perl5/Perl/Tidy.pm line 3827.
1932 Thanks to Michael Renner and Phillipe Bruhat.
1934 -Fixed problem where -sot would not stack an opening token followed by
1935 a side comment. Thanks to Jens Schicke.
1937 -improved breakpoints in complex math and other long statements. Example:
1940 log($n) + 0.577215664901532 + ( 1 / ( 2 * $n ) ) -
1941 ( 1 / ( 12 * ( $n**2 ) ) ) + ( 1 / ( 120 * ( $n**4 ) ) );
1944 log($n) + 0.577215664901532 +
1945 ( 1 / ( 2 * $n ) ) -
1946 ( 1 / ( 12 * ( $n**2 ) ) ) +
1947 ( 1 / ( 120 * ( $n**4 ) ) );
1949 -more robust vertical alignment of complex terminal else blocks and ternary
1955 <pre><code>-Eliminated bug where a here-doc invoked through an 'e' modifier on a pattern
1956 replacement text was not recognized. The tokenizer now recursively scans
1957 replacement text (but does not reformat it).
1959 -improved vertical alignment of terminal else blocks and ternary statements.
1960 Thanks to Chris for the suggestion.
1963 if ( IsBitmap() ) { return GetBitmap(); }
1964 elsif ( IsFiles() ) { return GetFiles(); }
1965 else { return GetText(); }
1968 if ( IsBitmap() ) { return GetBitmap(); }
1969 elsif ( IsFiles() ) { return GetFiles(); }
1970 else { return GetText(); }
1974 $opts{"t"} ? 'title'
1975 : $opts{"s"} ? 'subject'
1976 : $opts{"a"} ? 'author'
1981 $opts{"t"} ? 'title'
1982 : $opts{"s"} ? 'subject'
1983 : $opts{"a"} ? 'author'
1986 -improved indentation of try/catch blocks and other externally defined
1987 functions accepting a block argument. Thanks to jae.
1989 -Added support for Perl 5.10 features say and smartmatch.
1991 -Added flag -pbp (--perl-best-practices) as an abbreviation for parameters
1992 suggested in Damian Conway's "Perl Best Practices". -pbp is the same as:
1994 -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
1995 -wbb="% + - * / x != == >= <= =~ !~ < > | & >= < =
1996 **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
1998 Please note that the -st here restricts input to standard input; use
1999 -nst if necessary to override.
2001 -Eliminated some needless breaks at equals signs in -lp indentation.
2005 Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
2006 TOP + $y * (BOTTOM - TOP) / SIZE);
2008 $c = Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
2009 TOP + $y * (BOTTOM - TOP) / SIZE);
2011 A break at an equals is sometimes useful for preventing complex statements
2012 from hitting the line length limit. The decision to do this was
2013 over-eager in some cases and has been improved. Thanks to Royce Reece.
2015 -qw quotes contained in braces, square brackets, and parens are being
2016 treated more like those containers as far as stacking of tokens. Also
2017 stack of closing tokens ending ');' will outdent to where the ');' would
2018 have outdented if the closing stack is matched with a similar opening stack.
2020 OLD: perltidy -soc -sct
2021 __PACKAGE__->load_components(
2027 NEW: perltidy -soc -sct
2028 __PACKAGE__->load_components( qw(
2032 Thanks to Aran Deltac
2034 -Eliminated some undesirable or marginally desirable vertical alignments.
2035 These include terminal colons, opening braces, and equals, and particularly
2036 when just two lines would be aligned.
2039 my $accurate_timestamps = $Stamps{lnk};
2043 my $accurate_timestamps = $Stamps{lnk};
2046 -Corrected a problem with -mangle in which a space would be removed
2047 between a keyword and variable beginning with ::.
2052 <pre><code>-Attribute argument lists are now correctly treated as quoted strings
2053 and not formatted. This is the most important update in this version.
2054 Thanks to Borris Zentner, Greg Ferguson, Steve Kirkup.
2056 -Updated to recognize the defined or operator, //, to be released in Perl 10.
2057 Thanks to Sebastien Aperghis-Tramoni.
2059 -A useful utility perltidyrc_dump.pl is included in the examples section. It
2060 will read any perltidyrc file and write it back out in a standard format
2061 (though comments are lost).
2063 -Added option to have perltidy read and return a hash with the contents of a
2064 perltidyrc file. This may be used by Leif Eriksen's tidyview code. This
2065 feature is used by the demonstration program 'perltidyrc_dump.pl' in the
2068 -Improved error checking in perltidyrc files. Unknown bare words were not
2071 -The --dump-options parameter now dumps parameters in the format required by a
2074 -V-Strings with underscores are now recognized.
2075 For example: $v = v1.2_3;
2077 -cti=3 option added which gives one extra indentation level to closing
2078 tokens always. This provides more predictable closing token placement
2079 than cti=2. If you are using cti=2 you might want to try cti=3.
2081 -To identify all left-adjusted comments as static block comments, use C<-sbcp='^#'>.
2083 -New parameters -fs, -fsb, -fse added to allow sections of code between #<<<
2084 and #>>> to be passed through verbatim. This is enabled by default and turned
2085 off by -nfs. Flags -fsb and -fse allow other beginning and ending markers.
2086 Thanks to Wolfgang Werner and Marion Berryman for suggesting this.
2088 -added flag -skp to put a space between all Perl keywords and following paren.
2089 The default is to only do this for certain keywords. Suggested by
2092 -added flag -sfp to put a space between a function name and following paren.
2093 The default is not to do this. Suggested by H.Merijn Brand.
2095 -Added patch to avoid breaking GetOpt::Long::Configure set by calling program.
2096 Thanks to Philippe Bruhat.
2098 -An error was fixed in which certain parameters in a .perltidyrc file given
2099 without the equals sign were not recognized. That is,
2100 '--brace-tightness 0' gave an error but '--brace-tightness=0' worked
2101 ok. Thanks to Zac Hansen.
2103 -An error preventing the -nwrs flag from working was corrected. Thanks to
2106 -Corrected some alignment problems with entab option.
2108 -A bug with the combination of -lp and -extrude was fixed (though this
2109 combination doesn't really make sense). The bug was that a line with
2110 a single zero would be dropped. Thanks to Cameron Hayne.
2112 -Updated Windows detection code to avoid an undefined variable.
2113 Thanks to Joe Yates and Russ Jones.
2115 -Improved formatting for short trailing statements following a closing paren.
2116 Thanks to Joe Matarazzo.
2118 -The handling of the -icb (indent closing block braces) flag has been changed
2119 slightly to provide more consistent and predictable formatting of complex
2120 structures. Instead of giving a closing block brace the indentation of the
2121 previous line, it is now given one extra indentation level. The two methods
2122 give the same result if the previous line was a complete statement, as in this
2131 The change also fixes a problem with empty blocks such as:
2141 -A problem with -icb was fixed in which a closing brace was misplaced when
2142 it followed a quote which spanned multiple lines.
2144 -Some improved breakpoints for -wba='&& || and or'
2146 -Fixed problem with misaligned cuddled else in complex statements
2147 when the -bar flag was also used. Thanks to Alex and Royce Reese.
2149 -Corrected documentation to show that --outdent-long-comments is the default.
2150 Thanks to Mario Lia.
2152 -New flag -otr (opening-token-right) is similar to -bar (braces-always-right)
2153 but applies to non-structural opening tokens.
2155 -new flags -sot (stack-opening-token), -sct (stack-closing-token).
2161 <pre><code>-The default has been changed to not do syntax checking with perl.
2162 Use -syn if you want it. Perltidy is very robust now, and the -syn
2163 flag now causes more problems than it's worth because of BEGIN blocks
2164 (which get executed with perl -c). For example, perltidy will never
2165 return when trying to beautify this code if -syn is used:
2167 BEGIN { 1 while { }; }
2169 Although this is an obvious error, perltidy is often run on untested
2170 code which is more likely to have this sort of problem. A more subtle
2173 BEGIN { use FindBin; }
2175 which may hang on some systems using -syn if a shared file system is
2178 -Changed style -gnu to use -cti=1 instead of -cti=2 (see next item).
2179 In most cases it looks better. To recover the previous format, use
2182 -Added flags -cti=n for finer control of closing token indentation.
2183 -cti = 0 no extra indentation (default; same as -nicp)
2184 -cti = 1 enough indentation so that the closing token
2185 aligns with its opening token.
2186 -cti = 2 one extra indentation level if the line has the form
2187 ); ]; or }; (same as -icp).
2189 The new option -cti=1 works well with -lp:
2193 # perltidy -lp -cti=1
2195 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2196 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2199 # perltidy -lp -cti=2
2201 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2202 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2204 This is backwards compatible with -icp. See revised manual for
2205 details. Suggested by Mike Pennington.
2207 -Added flag '--preserve-line-endings' or '-ple' to cause the output
2208 line ending to be the same as in the input file, for unix, dos,
2209 or mac line endings. Only works under unix. Suggested by
2212 -Added flag '--output-line-ending=s' or '-ole=s' where s=dos or win,
2213 unix, or mac. Only works under unix.
2215 -Files with Mac line endings should now be handled properly under unix
2216 and dos without being passed through a converter.
2218 -You may now include 'and', 'or', and 'xor' in the list following
2219 '--want-break-after' to get line breaks after those keywords rather than
2220 before them. Suggested by Rainer Hochschild.
2222 -Corrected problem with command line option for -vtc=n and -vt=n. The
2223 equals sign was being eaten up by the Windows shell so perltidy didn't
2229 <pre><code>-Corrected cause of warning message with recent versions of Perl:
2230 "Possible precedence problem on bitwise & operator at ..."
2231 Thanks to Jim Files.
2233 -fixed bug with -html with '=for pod2html' sections, in which code/pod
2234 output order was incorrect. Thanks to Tassilo von Parseval.
2236 -fixed bug when the -html flag is used, in which the following error
2237 message, plus others, appear:
2238 did not see <body> in pod2html output
2239 This was caused by a change in the format of html output by pod2html
2240 VERSION 1.04 (included with perl 5.8). Thanks to Tassilo von Parseval.
2242 -Fixed bug where an __END__ statement would be mistaken for a label
2243 if it is immediately followed by a line with a leading colon. Thanks
2246 -Implemented guessing logic for brace types when it is ambiguous. This
2247 has been on the TODO list a long time. Thanks to Boris Zentner for
2250 -Long options may now be negated either as '--nolong-option'
2251 or '--no-long-option'. Thanks to Philip Newton for the suggestion.
2253 -added flag --html-entities or -hent which controls the use of
2254 Html::Entities for html formatting. Use --nohtml-entities or -nhent to
2255 prevent the use of Html::Entities to encode special symbols. The
2256 default is -hent. Html::Entities when formatting perl text to escape
2257 special symbols. This may or may not be the right thing to do,
2258 depending on browser/language combinations. Thanks to Burak Gursoy for
2261 -Bareword strings with leading '-', like, '-foo' now count as 1 token
2262 for horizontal tightness. This way $a{'-foo'}, $a{foo}, and $a{-foo}
2263 are now all treated similarly. Thus, by default, OLD: $a{ -foo } will
2264 now be NEW: $a{-foo}. Suggested by Mark Olesen.
2266 -added 2 new flags to control spaces between keywords and opening parens:
2267 -sak=s or --space-after-keyword=s, and
2268 -nsak=s or --nospace-after-keyword=s, where 's' is a list of keywords.
2270 The new default list of keywords which get a space is:
2272 "my local our and or eq ne if else elsif until unless while for foreach
2273 return switch case given when"
2275 Use -sak=s and -nsak=s to add and remove keywords from this list,
2278 Explanation: Stephen Hildrey noted that perltidy was being inconsistent
2279 in placing spaces between keywords and opening parens, and sent a patch
2280 to give user control over this. The above list was selected as being
2281 a reasonable default keyword list. Previously, perltidy
2282 had a hardwired list which also included these keywords:
2284 push pop shift unshift join split die
2286 but did not have 'our'. Example: if you prefer to make perltidy behave
2287 exactly as before, you can include the following two lines in your
2290 -sak="push pop local shift unshift join split die"
2293 -Corrected html error in .toc file when -frm -html is used (extra ");
2294 browsers were tolerant of it.
2296 -Improved alignment of chains of binary and ?/: operators. Example:
2310 -improved breakpoint choices involving '->'
2312 -Corrected tokenization of things like ${#}. For example,
2313 ${#} is valid, but ${# } is a syntax error.
2315 -Corrected minor tokenization errors with indirect object notation.
2316 For example, 'new A::()' works now.
2318 -Minor tokenization improvements; all perl code distributed with perl 5.8
2319 seems to be parsed correctly except for one instance (lextest.t)
2325 <pre><code>-Implemented scalar attributes. Thanks to Sean Tobin for noting this.
2327 -Fixed glitch introduced in previous release where -pre option
2328 was not outputting a leading html <pre> tag.
2330 -Numerous minor improvements in vertical alignment, including the following:
2332 -Improved alignment of opening braces in many cases. Needed for improved
2333 switch/case formatting, and also suggested by Mark Olesen for sort/map/grep
2334 formatting. For example:
2339 sort { $a->[1] <=> $b->[1] }
2340 map { [ $_, -M ] } @filenames;
2345 sort { $a->[1] <=> $b->[1] }
2346 map { [ $_, -M ] } @filenames;
2348 -Eliminated alignments across unrelated statements. Example:
2350 $borrowerinfo->configure( -state => 'disabled' );
2351 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
2354 $borrowerinfo->configure( -state => 'disabled' );
2355 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
2357 Thanks to Mark Olesen for suggesting this.
2359 -Improved alignement of '='s in certain cases.
2360 Thanks to Norbert Gruener for sending an example.
2362 -Outdent-long-comments (-olc) has been re-instated as a default, since
2363 it works much better now. Use -nolc if you want to prevent it.
2365 -Added check for 'perltidy file.pl -o file.pl', which causes file.pl
2366 to be lost. (The -b option should be used instead). Thanks to mreister
2367 for reporting this problem.
2372 <pre><code>-Switch/case or given/when syntax is now recognized. Its vertical alignment
2373 is not great yet, but it parses ok. The words 'switch', 'case', 'given',
2374 and 'when' are now treated as keywords. If this causes trouble with older
2375 code, we could introduce a switch to deactivate it. Thanks to Stan Brown
2376 and Jochen Schneider for recommending this.
2378 -Corrected error parsing sub attributes with call parameters.
2379 Thanks to Marc Kerr for catching this.
2381 -Sub prototypes no longer need to be on the same line as sub names.
2383 -a new flag -frm or --frames will cause html output to be in a
2384 frame, with table of contents in the left panel and formatted source
2385 in the right panel. Try 'perltidy -html -frm somemodule.pm' for example.
2387 -The new default for -html formatting is to pass the pod through Pod::Html.
2388 The result is syntax colored code within your pod documents. This can be
2389 deactivated with -npod. Thanks to those who have written to discuss this,
2390 particularly Mark Olesen and Hugh Myers.
2392 -the -olc (--outdent-long-comments) option works much better. It now outdents
2393 groups of consecutive comments together, and by just the amount needed to
2394 avoid having any one line exceeding the maximum line length.
2396 -block comments are now trimmed of trailing whitespace.
2398 -if a directory specified with -opath does not exist, it will be created.
2400 -a table of contents to packages and subs is output when -html is used.
2401 Use -ntoc to prevent this.
2403 -fixed an unusual bug in which a 'for' statement following a 'format'
2404 statement was not correctly tokenized. Thanks to Boris Zentner for
2407 -Tidy.pm is no longer dependent on modules IO::Scalar and IO::ScalarArray.
2408 There were some speed issues. Suggested by Joerg Walter.
2410 -The treatment of quoted wildcards (file globs) is now system-independent.
2413 perltidy 'b*x.p[lm]'
2415 would match box.pl, box.pm, brinx.pm under any operating system. Of
2416 course, anything unquoted will be subject to expansion by any shell.
2418 -default color for keywords under -html changed from
2419 SaddleBrown (#8B4513) to magenta4 (#8B008B).
2421 -fixed an arg parsing glitch in which something like:
2423 would trigger the help message and exit, rather than operate on the
2429 <pre><code>-New option '-b' or '--backup-and-modify-in-place' will cause perltidy to
2430 overwrite the original file with the tidied output file. The original
2431 file will be saved with a '.bak' extension (which can be changed with
2432 -bext=s). Thanks to Rudi Farkas for the suggestion.
2434 -An index to all subs is included at the top of -html output, unless
2435 only the <pre> section is written.
2437 -Anchor lines of the form <a name="mysub"></a> are now inserted at key points
2438 in html output, such as before sub definitions, for the convenience of
2439 postprocessing scripts. Suggested by Howard Owen.
2441 -The cuddled-else (-ce) flag now also makes cuddled continues, like
2444 while ( ( $pack, $file, $line ) = caller( $i++ ) ) {
2450 Suggested by Simon Perreault.
2452 -Fixed bug in which an extra blank line was added before an =head or
2453 similar pod line after an __END__ or __DATA__ line each time
2454 perltidy was run. Also, an extra blank was being added after
2455 a terminal =cut. Thanks to Mike Birdsall for reporting this.
2460 <pre><code>-Fixed bug in which space was inserted in a hyphenated hash key:
2461 my $val = $myhash{USER-NAME};
2463 my $val = $myhash{USER -NAME};
2464 Thanks to an anonymous bug reporter at sourceforge.
2466 -Fixed problem with the '-io' ('--indent-only') where all lines
2467 were double spaced. Thanks to Nick Andrew for reporting this bug.
2469 -Fixed tokenization error in which something like '-e1' was
2472 -Corrected a rare problem involving older perl versions, in which
2473 a line break before a bareword caused problems with 'use strict'.
2474 Thanks to Wolfgang Weisselberg for noting this.
2476 -More syntax error checking added.
2478 -Outdenting labels (-ola) has been made the default, in order to follow the
2479 perlstyle guidelines better. It's probably a good idea in general, but
2480 if you do not want this, use -nola in your .perltidyrc file.
2482 -Updated rules for padding logical expressions to include more cases.
2483 Thanks to Wolfgang Weisselberg for helpful discussions.
2485 -Added new flag -osbc (--outdent-static-block-comments) which will
2486 outdent static block comments by 2 spaces (or whatever -ci equals).
2487 Requested by Jon Robison.
2492 <pre><code>-Corrected a bug, introduced in the previous release, in which some
2493 closing side comments (-csc) could have incorrect text. This is
2494 annoying but will be correct the next time perltidy is run with -csc.
2496 -Fixed bug where whitespace was being removed between 'Bar' and '()'
2497 in a use statement like:
2501 -Whenever possible, if a logical expression is broken with leading
2502 '&&', '||', 'and', or 'or', then the leading line will be padded
2503 with additional space to produce alignment. This has been on the
2504 todo list for a long time; thanks to Frank Steinhauer for reminding
2505 me to do it. Notice the first line after the open parens here:
2509 !param("rules.to.$linecount")
2510 && !param("rules.from.$linecount")
2511 && !param("rules.subject.$linecount")
2513 param("rules.fieldname.$linecount")
2514 && param("rules.fieldval.$linecount")
2516 && !param("rules.size.$linecount")
2517 && !param("rules.custom.$linecount")
2522 !param("rules.to.$linecount")
2523 && !param("rules.from.$linecount")
2524 && !param("rules.subject.$linecount")
2526 param("rules.fieldname.$linecount")
2527 && param("rules.fieldval.$linecount")
2529 && !param("rules.size.$linecount")
2530 && !param("rules.custom.$linecount")
2536 <pre><code>-Corrected a mistokenization of variables for a package with a name
2537 equal to a perl keyword. For example:
2541 sub qx{print "Hello from my::qx\n";}
2543 In this case, the leading 'my' was mistokenized as a keyword, and a
2544 space was being place between 'my' and '::'. This has been
2545 corrected. Thanks to Martin Sluka for discovering this.
2547 -A new flag -bol (--break-at-old-logic-breakpoints)
2548 has been added to control whether containers with logical expressions
2549 should be broken open. This is the default.
2551 -A new flag -bok (--break-at-old-keyword-breakpoints)
2552 has been added to follow breaks at old keywords which return lists,
2553 such as sort and map. This is the default.
2555 -A new flag -bot (--break-at-old-trinary-breakpoints) has been added to
2556 follow breaks at trinary (conditional) operators. This is the default.
2558 -A new flag -cab=n has been added to control breaks at commas after
2559 '=>' tokens. The default is n=1, meaning break unless this breaks
2560 open an existing on-line container.
2562 -A new flag -boc has been added to allow existing list formatting
2563 to be retained. (--break-at-old-comma-breakpoints). See updated manual.
2565 -A new flag -iob (--ignore-old-breakpoints) has been added to
2566 prevent the locations of old breakpoints from influencing the output
2569 -Corrected problem where nested parentheses were not getting full
2570 indentation. This has been on the todo list for some time; thanks
2571 to Axel Rose for a snippet demonstrating this issue.
2573 OLD: inner list is not indented
2574 $this->sendnumeric(
2577 $ret->name, $user->username, $user->host,
2578 $user->server->name, $user->nick, "H"
2583 $this->sendnumeric(
2586 $ret->name, $user->username, $user->host,
2587 $user->server->name, $user->nick, "H"
2591 -Code cleaned up by removing the following unused, undocumented flags.
2592 They should not be in any .perltidyrc files because they were just
2593 experimental flags which were never documented. Most of them placed
2594 artificial limits on spaces, and Wolfgang Weisselberg convinced me that
2595 most of them they do more harm than good by causing unexpected results.
2597 --maximum-continuation-indentation (-mci)
2598 --maximum-whitespace-columns
2599 --maximum-space-to-comment (-xsc)
2600 --big-space-jump (-bsj)
2602 -Pod file 'perltidy.pod' has been appended to the script 'perltidy', and
2603 Tidy.pod has been append to the module 'Tidy.pm'. Older MakeMaker's
2604 were having trouble.
2606 -A new flag -isbc has been added for more control on comments. This flag
2607 has the effect that if there is no leading space on the line, then the
2608 comment will not be indented, and otherwise it may be. If both -ibc and
2609 -isbc are set, then -isbc takes priority. Thanks to Frank Steinhauer
2610 for suggesting this.
2612 -A new document 'stylekey.pod' has been created to quickly guide new users
2613 through the maze of perltidy style parameters. An html version is
2614 on the perltidy web page. Take a look! It should be very helpful.
2616 -Parameters for controlling 'vertical tightness' have been added:
2617 -vt and -vtc are the main controls, but finer control is provided
2618 with -pvt, -pcvt, -bvt, -bcvt, -sbvt, -sbcvt. Block brace vertical
2619 tightness controls have also been added.
2620 See updated manual and also see 'stylekey.pod'. Simple examples:
2622 # perltidy -lp -vt=1 -vtc=1
2623 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2624 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
2626 # perltidy -lp -vt=1 -vtc=0
2627 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2628 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2631 -Lists which do not format well in uniform columns are now better
2632 identified and formated.
2635 return $c->create( 'polygon', $x, $y, $x + $ruler_info{'size'},
2636 $y + $ruler_info{'size'}, $x - $ruler_info{'size'},
2637 $y + $ruler_info{'size'} );
2640 return $c->create(
2642 $x + $ruler_info{'size'},
2643 $y + $ruler_info{'size'},
2644 $x - $ruler_info{'size'},
2645 $y + $ruler_info{'size'}
2649 radlablist($f1, pad('Initial', $p), $b->{Init}->get_panel_ref, 'None ',
2650 'None', 'Default', 'Default', 'Simple', 'Simple');
2654 $b->{Init}->get_panel_ref,
2655 'None ', 'None', 'Default', 'Default', 'Simple', 'Simple');
2657 -Corrected problem where an incorrect html filename was generated for
2658 external calls to Tidy.pm module. Fixed incorrect html title when
2659 Tidy.pm is called with IO::Scalar or IO::Array source.
2661 -Output file permissions are now set as follows. An output script file
2662 gets the same permission as the input file, except that owner
2663 read/write permission is added (otherwise, perltidy could not be
2664 rerun). Html output files use system defaults. Previously chmod 0755
2665 was used in all cases. Thanks to Mark Olesen for bringing this up.
2667 -Missing semicolons will not be added in multi-line blocks of type
2668 sort, map, or grep. This brings perltidy into closer agreement
2669 with common practice. Of course, you can still put semicolons
2670 there if you like. Thanks to Simon Perreault for a discussion of this.
2672 -Most instances of extra semicolons are now deleted. This is
2673 particularly important if the -csc option is used. Thanks to Wolfgang
2674 Weisselberg for noting this. For example, the following line
2675 (produced by 'h2xs' :) has an extra semicolon which will now be
2678 BEGIN { plan tests => 1 };
2680 -New parameter -csce (--closing-side-comment-else-flag) can be used
2681 to control what text is appended to 'else' and 'elsif' blocks.
2682 Default is to just add leading 'if' text to an 'else'. See manual.
2684 -The -csc option now labels 'else' blocks with additinal information
2685 from the opening if statement and elsif statements, if space.
2686 Thanks to Wolfgang Weisselberg for suggesting this.
2688 -The -csc option will now remove any old closing side comments
2689 below the line interval threshold. Thanks to Wolfgang Weisselberg for
2692 -The abbreviation feature, which was broken in the previous version,
2693 is now fixed. Thanks to Michael Cartmell for noting this.
2695 -Vertical alignment is now done for '||=' .. somehow this was
2701 <pre><code>-This version uses modules for the first time, and a standard perl
2702 Makefile.PL has been supplied. However, perltidy may still be
2703 installed as a single script, without modules. See INSTALL for
2706 -The man page 'perl2web' has been merged back into the main 'perltidy'
2707 man page to simplify installation. So you may remove that man page
2708 if you have an older installation.
2710 -Added patch from Axel Rose for MacPerl. The patch prompts the user
2711 for command line arguments before calling the module
2712 Perl::Tidy::perltidy.
2714 -Corrected bug with '-bar' which was introduced in the previous
2715 version. A closing block brace was being indented. Thanks to
2716 Alexandros M Manoussakis for reporting this.
2718 -New parameter '--entab-leading-whitespace=n', or '-et=n', has been
2719 added for those who prefer tabs. This behaves different from the
2720 existing '-t' parameter; see updated man page. Suggested by Mark
2723 -New parameter '--perl-syntax-check-flags=s' or '-pcsf=s' can be
2724 used to change the flags passed to perltidy in a syntax check.
2725 See updated man page. Suggested by Mark Olesen.
2727 -New parameter '--output-path=s' or '-opath=s' will cause output
2728 files to be placed in directory s. See updated man page. Thanks for
2729 Mark Olesen for suggesting this.
2731 -New parameter --dump-profile (or -dpro) will dump to
2732 standard output information about the search for a
2733 configuration file, the name of whatever configuration file
2734 is selected, and its contents. This should help debugging
2735 config files, especially on different Windows systems.
2737 -The -w parameter now notes possible errors of the form:
2739 $comment = s/^\s*(\S+)\..*/$1/; # trim whitespace
2741 -Corrections added for a leading ':' and for leaving a leading 'tcsh'
2742 line untouched. Mark Olesen reported that lines of this form were
2743 accepted by perl but not by perltidy:
2745 : # use -*- perl -*-
2746 eval 'exec perl -wS $0 "$@"' # shell should exec 'perl'
2747 unless 1; # but Perl should skip this one
2749 Perl will silently swallow a leading colon on line 1 of a
2750 script, and now perltidy will do likewise. For example,
2751 this is a valid script, provided that it is the first line,
2754 : print "Hello World\n";
2756 Also, perltidy will now mark a first line with leading ':' followed by
2757 '#' as type SYSTEM (just as a #! line), not to be formatted.
2759 -List formatting improved for certain lists with special
2760 initial terms, such as occur with 'printf', 'sprintf',
2761 'push', 'pack', 'join', 'chmod'. The special initial term is
2762 now placed on a line by itself. For example, perltidy -gnu
2766 "C4", hex($SourceAddr[0]),
2767 hex($SourceAddr[1]), hex($SourceAddr[2]),
2773 hex($SourceAddr[0]), hex($SourceAddr[1]),
2774 hex($SourceAddr[2]), hex($SourceAddr[3]));
2778 @{$$self{states}}, '64', '66', '68',
2779 '70', '72', '74', '76',
2780 '78', '80', '82', '84',
2781 '86', '88', '90', '92',
2782 '94', '96', '98', '100',
2789 '64', '66', '68', '70', '72', '74', '76',
2790 '78', '80', '82', '84', '86', '88', '90',
2791 '92', '94', '96', '98', '100', '102', '104'
2794 -Lists of complex items, such as matricies, are now detected
2795 and displayed with just one item per row:
2798 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2799 [ 1, tan( deg2rad($a) ), 0 ], [ tan( deg2rad($b) ), 1, 0 ],
2804 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2805 [ 1, tan( deg2rad($a) ), 0 ],
2806 [ tan( deg2rad($b) ), 1, 0 ],
2810 -The perl syntax check will be turned off for now when input is from
2811 standard input or standard output. The reason is that this requires
2812 temporary files, which has produced far too many problems during
2813 Windows testing. For example, the POSIX module under Windows XP/2000
2814 creates temporary names in the root directory, to which only the
2815 administrator should have permission to write.
2817 -Merged patch sent by Yves Orton to handle appropriate
2818 configuration file locations for different Windows varieties
2819 (2000, NT, Me, XP, 95, 98).
2821 -Added patch to properly handle a for/foreach loop without
2822 parens around a list represented as a qw. I didn't know this
2823 was possible until Wolfgang Weisselberg pointed it out:
2825 foreach my $key qw\Uno Due Tres Quadro\ {
2829 But Perl will give a syntax error without the $ variable; ie this will
2832 foreach qw\Uno Due Tres Quadro\ {
2836 -Merged Windows version detection code sent by Yves Orton. Perltidy
2837 now automatically turns off syntax checking for Win 9x/ME versions,
2838 and this has solved a lot of robustness problems. These systems
2839 cannot reliably handle backtick operators. See man page for
2842 -Merged VMS filename handling patch sent by Michael Cartmell. (Invalid
2843 output filenames were being created in some cases).
2845 -Numerous minor improvements have been made for -lp style indentation.
2847 -Long C-style 'for' expressions will be broken after each ';'.
2849 'perltidy -gnu' gives:
2852 for ($status = $db->seq($key, $value, R_CURSOR()) ; $status == 0
2853 and $key eq $origkey ; $status = $db->seq($key, $value, R_NEXT()))
2856 for ($status = $db->seq($key, $value, R_CURSOR()) ;
2857 $status == 0 and $key eq $origkey ;
2858 $status = $db->seq($key, $value, R_NEXT()))
2860 -For the -lp option, a single long term within parens
2861 (without commas) now has better alignment. For example,
2865 $self->throw("Must specify a known host, not $location,"
2866 . " possible values ("
2867 . join (",", sort keys %hosts) . ")");
2870 $self->throw("Must specify a known host, not $location,"
2871 . " possible values ("
2872 . join (",", sort keys %hosts) . ")");
2877 <pre><code>-This version is about 20 percent faster than the previous
2878 version as a result of optimization work. The largest gain
2879 came from switching to a dispatch hash table in the
2882 -perltidy -html will check to see if HTML::Entities is
2883 installed, and if so, it will use it to encode unsafe
2886 -Added flag -oext=ext to change the output file extension to
2887 be different from the default ('tdy' or 'html'). For
2890 perltidy -html -oext=htm filename
2892 will produce filename.htm
2894 -Added flag -cscw to issue warnings if a closing side comment would replace
2895 an existing, different side comments. See the man page for details.
2896 Thanks to Peter Masiar for helpful discussions.
2898 -Corrected tokenization error of signed hex/octal/binary numbers. For
2899 example, the first hex number below would have been parsed correctly
2900 but the second one was not:
2901 if ( ( $tmp >= 0x80_00_00 ) || ( $tmp < -0x80_00_00 ) ) { }
2903 -'**=' was incorrectly tokenized as '**' and '='. This only
2904 caused a problem with the -extrude opton.
2906 -Corrected a divide by zero when -extrude option is used
2908 -The flag -w will now contain all errors reported by 'perl -c' on the
2909 input file, but otherwise they are not reported. The reason is that
2910 perl will report lots of problems and syntax errors which are not of
2911 interest when only a small snippet is being formatted (such as missing
2912 modules and unknown bare words). Perltidy will always report all
2913 significant syntax errors that it finds, such as unbalanced braces,
2914 unless the -q (quiet) flag is set.
2916 -Merged modifications created by Hugh Myers into perltidy.
2917 These include a 'streamhandle' routine which allows perltidy
2918 as a module to operate on input and output arrays and strings
2919 in addition to files. Documentation and new packaging as a
2920 module should be ready early next year; This is an elegant,
2921 powerful update; many thanks to Hugh for contributing it.
2926 <pre><code>-added a tentative patch which tries to keep any existing breakpoints
2927 at lines with leading keywords map,sort,eval,grep. The idea is to
2928 improve formatting of sequences of list operations, as in a schwartzian
2932 my @sorted = map { $_->[0] }
2933 sort { $a->[1] <=> $b->[1] }
2934 map { [ $_, rand ] } @list;
2938 map { $_->[0] } sort { $a->[1] <=> $b->[1] } map { [ $_, rand ] } @list;
2941 my @sorted = map { $_->[0] }
2942 sort { $a->[1] <=> $b->[1] }
2943 map { [ $_, rand ] } @list;
2945 The new alignment is not as nice as the input, but this is an improvement.
2946 Thanks to Yves Orton for this suggestion.
2948 -modified indentation logic so that a line with leading opening paren,
2949 brace, or square bracket will never have less indentation than the
2950 line with the corresponding opening token. Here's a simple example:
2954 -text => "New Document",
2955 -command => \&new_document
2957 -side => 'bottom',
2961 Note how the closing ');' is lined up with the first line, even
2962 though it closes a paren in the 'pack' line. That seems wrong.
2966 -text => "New Document",
2967 -command => \&new_document
2969 -side => 'bottom',
2973 This seems nicer: you can up-arrow with an editor and arrive at the
2974 opening 'pack' line.
2976 -corrected minor glitch in which cuddled else (-ce) did not get applied
2977 to an 'unless' block, which should look like this:
2985 Thanks to Jeremy Mates for reporting this.
2987 -The man page has been reorganized to parameters easier to find.
2989 -Added check for multiple definitions of same subroutine. It is easy
2990 to introduce this problem when cutting and pasting. Perl does not
2991 complain about it, but it can lead to disaster.
2993 -The command -pro=filename or -profile=filename may be used to specify a
2994 configuration file which will override the default name of .perltidyrc.
2995 There must not be a space on either side of the '=' sign. I needed
2996 this to be able to easily test perltidy with a variety of different
2997 configuration files.
2999 -Side comment alignment has been improved somewhat across frequent level
3000 changes, as in short if/else blocks. Thanks to Wolfgang Weisselberg
3001 for pointing out this problem. For example:
3004 if ( ref $self ) { # Called as a method
3007 else { # Regular procedure call
3013 if ( ref $self ) { # Called as a method
3016 else { # Regular procedure call
3021 -New command -ssc (--static-side-comment) and related command allows
3022 side comments to be spaced close to preceding character. This is
3023 useful for displaying commented code as side comments.
3025 -New command -csc (--closing-side-comment) and several related
3026 commands allow comments to be added to (and deleted from) any or all
3027 closing block braces. This can be useful if you have to maintain large
3028 programs, especially those that you didn't write. See updated man page.
3029 Thanks to Peter Masiar for this suggestion. For a simple example:
3034 if ( !defined( $_[0] ) ) {
3035 print("Hello, World\n");
3038 print( $_[0], "\n" );
3042 This added '## end sub foo' to the closing brace.
3043 To remove it, perltidy -ncsc.
3045 -New commands -ola, for outdenting labels, and -okw, for outdenting
3046 selected control keywords, were implemented. See the perltidy man
3047 page for details. Thanks to Peter Masiar for this suggestion.
3049 -Hanging side comment change: a comment will not be considered to be a
3050 hanging side comment if there is no leading whitespace on the line.
3051 This should improve the reliability of identifying hanging side comments.
3052 Thanks to Peter Masiar for this suggestion.
3054 -Two new commands for outdenting, -olq (outdent-long-quotes) and -olc
3055 (outdent-long-comments), have been added. The original -oll
3056 (outdent-long-lines) remains, and now is an abbreviation for -olq and -olc.
3057 The new default is just -olq. This was necessary to avoid inconsistency with
3058 the new static block comment option.
3060 -Static block comments: to provide a way to display commented code
3061 better, the convention is used that comments with a leading '##' should
3062 not be formatted as usual. Please see '-sbc' (or '--static-block-comment')
3063 for documentation. It can be deactivated with with -nsbc, but
3064 should not normally be necessary. Thanks to Peter Masiar for this
3067 -Two changes were made to help show structure of complex lists:
3068 (1) breakpoints are forced after every ',' in a list where any of
3069 the list items spans multiple lines, and
3070 (2) List items which span multiple lines now get continuation indentation.
3072 The following example illustrates both of these points. Many thanks to
3073 Wolfgang Weisselberg for this snippet and a discussion of it; this is a
3074 significant formatting improvement. Note how it is easier to see the call
3075 parameters in the NEW version:
3078 assert( __LINE__, ( not defined $check )
3081 or $check eq "old", "Error in parameters",
3082 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
3083 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
3084 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef" );
3089 ( not defined $check )
3093 "Error in parameters",
3094 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
3095 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
3096 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef"
3099 Another example shows how this helps displaying lists:
3102 %{ $self->{COMPONENTS} } = (
3104 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
3106 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
3109 The structure is clearer with the added indentation:
3112 %{ $self->{COMPONENTS} } = (
3114 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
3116 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
3119 -The structure of nested logical expressions is now displayed better.
3120 Thanks to Wolfgang Weisselberg for helpful discussions. For example,
3121 note how the status of the final 'or' is displayed in the following:
3125 and null( $op->sibling )
3126 and $op->ppaddr eq "pp_null"
3127 and class($op) eq "UNOP"
3128 and ( ( $op->first->ppaddr =~ /^pp_(and|or)$/
3129 and $op->first->first->sibling->ppaddr eq "pp_lineseq" )
3130 or ( $op->first->ppaddr eq "pp_lineseq"
3131 and not null $op->first->first->sibling
3132 and $op->first->first->sibling->ppaddr eq "pp_unstack" ) ) );
3137 and null( $op->sibling )
3138 and $op->ppaddr eq "pp_null"
3139 and class($op) eq "UNOP"
3142 $op->first->ppaddr =~ /^pp_(and|or)$/
3143 and $op->first->first->sibling->ppaddr eq "pp_lineseq"
3145 or ( $op->first->ppaddr eq "pp_lineseq"
3146 and not null $op->first->first->sibling
3147 and $op->first->first->sibling->ppaddr eq "pp_unstack" )
3151 -A break will always be put before a list item containing a comma-arrow.
3152 This will improve formatting of mixed lists of this form:
3156 'text', 225, 20, -text => 'A Simple Plot',
3164 -text => 'A Simple Plot',
3169 -For convenience, the command -dac (--delete-all-comments) now also
3170 deletes pod. Likewise, -tac (--tee-all-comments) now also sends pod
3171 to a '.TEE' file. Complete control over the treatment of pod and
3172 comments is still possible, as described in the updated help message
3175 -The logic which breaks open 'containers' has been rewritten to be completely
3176 symmetric in the following sense: if a line break is placed after an opening
3177 {, [, or (, then a break will be placed before the corresponding closing
3178 token. Thus, a container either remains closed or is completely cracked
3181 -Improved indentation of parenthesized lists. For example,
3186 atan2( $GPSTempCompLong - $GPSLongitude,
3187 $GPSLatitude - $GPSTempCompLat ) * 180 / 3.14159265 );
3190 $GPSCompCourse = int(
3192 $GPSTempCompLong - $GPSLongitude,
3193 $GPSLatitude - $GPSTempCompLat
3194 ) * 180 / 3.14159265
3197 Further improvements will be made in future releases.
3199 -Some improvements were made in formatting small lists.
3201 -Correspondence between Input and Output line numbers reported in a
3202 .LOG file should now be exact. They were sometimes off due to the size
3203 of intermediate buffers.
3205 -Corrected minor tokenization error in which a ';' in a foreach loop
3206 control was tokenized as a statement termination, which forced a
3219 foreach ( $i = 0 ; $i <= 10 ; $i += 2 ) {
3223 -Corrected a problem with reading config files, in which quote marks were not
3224 stripped. As a result, something like -wba="&& . || " would have the leading
3225 quote attached to the && and not work correctly. A workaround for older
3226 versions is to place a space around all tokens within the quotes, like this:
3227 -wba=" && . || "
3229 -Removed any existing space between a label and its ':'
3232 This was necessary because the label and its colon are a single token.
3234 -Corrected tokenization error for the following (highly non-recommended)
3236 $user = @vars[1] / 100;
3238 -Resolved cause of a difference between perltidy under perl v5.6.1 and
3239 5.005_03; the problem was different behavior of \G regex position
3245 <pre><code>-Corrected a bug in which a break was not being made after a full-line
3246 comment within a short eval/sort/map/grep block. A flag was not being
3247 zeroed. The syntax error check catches this. Here is a snippet which
3248 illustrates the bug:
3251 #open Socket to Dispatcher
3252 $sock = &OpenSocket;
3255 The formatter mistakenly thought that it had found the following
3258 eval {#open Socket to Dispatcher$sock = &OpenSocket; };
3260 The patch fixes this. Many thanks to Henry Story for reporting this bug.
3262 -Changes were made to help diagnose and resolve problems in a
3264 (1) processing of command parameters has been into two separate
3265 batches so that any errors in a .perltidyrc file can be localized.
3266 (2) commands --help, --version, and as many of the --dump-xxx
3267 commands are handled immediately, without any command line processing
3269 (3) Perltidy will ignore any commands in the .perltidyrc file which
3270 cause immediate exit. These are: -h -v -ddf -dln -dop -dsn -dtt
3271 -dwls -dwrs -ss. Thanks to Wolfgang Weisselberg for helpful
3272 suggestions regarding these updates.
3274 -Syntax check has been reinstated as default for MSWin32 systems. This
3275 way Windows 2000 users will get syntax check by default, which seems
3276 like a better idea, since the number of Win 95/98 systems will be
3277 decreasing over time. Documentation revised to warn Windows 95/98
3278 users about the problem with empty '&1'. Too bad these systems
3279 all report themselves as MSWin32.
3284 <pre><code>-Fixed tokenization error in which a method call of the form
3288 got a space before the '::' like this:
3290 Module ::->new();
3292 Thanks to David Holden for reporting this.
3294 -Added -html control over pod text, using a new abbreviation 'pd'. See
3295 updated perl2web man page. The default is to use the color of a comment,
3296 but italicized. Old .css style sheets will need a new line for
3297 .pd to use this. The old color was the color of a string, and there
3300 -.css lines are now printed in sorted order.
3302 -Fixed interpolation problem where html files had '$input_file' as title
3303 instead of actual input file name. Thanks to Simon Perreault for finding
3304 this and sending a patch, and also to Tobias Weber.
3306 -Breaks will now have the ':' placed at the start of a line,
3307 one per line by default because this shows logical structure
3308 more clearly. This coding has been completely redone. Some
3309 examples of new ?/: formatting:
3312 wantarray ? map( $dir::cwd->lookup($_)->path, @_ ) :
3313 $dir::cwd->lookup( $_[0] )->path;
3317 ? map( $dir::cwd->lookup($_)->path, @_ )
3318 : $dir::cwd->lookup( $_[0] )->path;
3321 $a = ( $b > 0 ) ? {
3324 } : { a => 6, b => 8 };
3332 : { a => 6, b => 8 };
3335 $self->note($self->{skip} ? "Hunk #$self->{hunk} ignored at 1.\n" :
3336 "Hunk #$self->{hunk} failed--$@");
3339 $self->note($self->{skip}
3340 ? "Hunk #$self->{hunk} ignored at 1.\n"
3341 : "Hunk #$self->{hunk} failed--$@");
3345 $opts{"t"} ? 'title' :
3346 $opts{"s"} ? 'subject' : $opts{"a"} ? 'author' : 'title';
3350 $opts{"t"} ? 'title'
3351 : $opts{"s"} ? 'subject'
3352 : $opts{"a"} ? 'author'
3355 You can use -wba=':' to recover the previous default which placed ':'
3356 at the end of a line. Thanks to Michael Cartmell for helpful
3357 discussions and examples.
3359 -Tokenizer updated to do syntax checking for matched ?/: pairs. Also,
3360 the tokenizer now outputs a unique serial number for every balanced
3361 pair of brace types and ?/: pairs. This greatly simplifies the
3364 -Long lines with repeated 'and', 'or', '&&', '||' will now have
3365 one such item per line. For example:
3368 if ( $opt_d || $opt_m || $opt_p || $opt_t || $opt_x
3369 || ( -e $archive && $opt_r ) )
3371 ( $pAr, $pNames ) = readAr($archive);
3380 || ( -e $archive && $opt_r ) )
3382 ( $pAr, $pNames ) = readAr($archive);
3386 if ( $vp->{X0} + 4 <= $x && $vp->{X0} + $vp->{W} - 4 >= $x
3387 && $vp->{Y0} + 4 <= $y && $vp->{Y0} + $vp->{H} - 4 >= $y )
3390 if ( $vp->{X0} + 4 <= $x
3391 && $vp->{X0} + $vp->{W} - 4 >= $x
3392 && $vp->{Y0} + 4 <= $y
3393 && $vp->{Y0} + $vp->{H} - 4 >= $y )
3395 -Long lines with multiple concatenated tokens will have concatenated
3396 terms (see below) placed one per line, except for short items. For
3401 "Device type:" . $ib->family . " ID:" . $ib->serial . " CRC:"
3402 . $ib->crc . ": " . $ib->model() . "\n";
3405 $report .= "Device type:"
3406 . $ib->family . " ID:"
3407 . $ib->serial . " CRC:"
3409 . $ib->crc . ": " . "\n";
3411 NOTE: at present 'short' means 8 characters or less. There is a
3412 tentative flag to change this (-scl), but it is undocumented and
3413 is likely to be changed or removed later, so only use it for testing.
3414 In the above example, the tokens " ID:", " CRC:", and "\n" are below
3417 -If a line which is short enough to fit on a single line was
3418 nevertheless broken in the input file at a 'good' location (see below),
3419 perltidy will try to retain a break. For example, the following line
3420 will be formatted as:
3422 open SUM, "<$file"
3423 or die "Cannot open $file ($!)";
3425 if it was broken in the input file, and like this if not:
3427 open SUM, "<$file" or die "Cannot open $file ($!)";
3429 GOOD: 'good' location means before 'and','or','if','unless','&&','||'
3431 The reason perltidy does not just always break at these points is that if
3432 there are multiple, similar statements, this would preclude alignment. So
3433 rather than check for this, perltidy just tries to follow the input style,
3434 in the hopes that the author made a good choice. Here is an example where
3435 we might not want to break before each 'if':
3437 ($Locale, @Locale) = ($English, @English) if (@English > @Locale);
3438 ($Locale, @Locale) = ($German, @German) if (@German > @Locale);
3439 ($Locale, @Locale) = ($French, @French) if (@French > @Locale);
3440 ($Locale, @Locale) = ($Spanish, @Spanish) if (@Spanish > @Locale);
3442 -Added wildcard file expansion for systems with shells which lack this.
3443 Now 'perltidy *.pl' should work under MSDOS/Windows. Thanks to Hugh Myers
3444 for suggesting this. This uses builtin glob() for now; I may change that.
3446 -Added new flag -sbl which, if specified, overrides the value of -bl
3447 for opening sub braces. This allows formatting of this type:
3453 if (!defined($_[0])) {
3454 print("Hello, World\n");
3460 Requested by Don Alexander.
3462 -Fixed minor parsing error which prevented a space after a $$ variable
3463 (pid) in some cases. Thanks to Michael Cartmell for noting this.
3468 -Improved line break choices 'and' and 'or' to display logic better.
3472 exists $self->{'build_dir'} and push @e,
3473 "Unwrapped into directory $self->{'build_dir'}";
3476 exists $self->{'build_dir'}
3477 and push @e, "Unwrapped into directory $self->{'build_dir'}";
3479 -Fixed error of multiple use of abbreviatioin '-dsc'. -dsc remains
3480 abbreviation for delete-side-comments; -dsm is new abbreviation for
3483 -Corrected and updated 'usage' help routine. Thanks to Slaven Rezic for
3486 -The default for Windows is, for now, not to do a 'perl -c' syntax
3487 check (but -syn will activate it). This is because of problems with
3488 command.com. James Freeman sent me a patch which tries to get around
3489 the problems, and it works in many cases, but testing revealed several
3490 issues that still need to be resolved. So for now, the default is no
3491 syntax check for Windows.
3493 -I added a -T flag when doing perl -c syntax check.
3494 This is because I test it on a large number of scripts from sources
3495 unknown, and who knows what might be hidden in initialization blocks?
3496 Also, deactivated the syntax check if perltidy is run as root. As a
3497 benign example, running the previous version of perltidy on the
3498 following file would cause it to disappear:
3501 print "Bye, bye baby!\n";
3505 The new version will not let that happen.
3507 -I am contemplating (but have not yet implemented) making '-lp' the
3508 default indentation, because it is stable now and may be closer to how
3509 perl is commonly formatted. This could be in the next release. The
3510 reason that '-lp' was not the original default is that the coding for
3511 it was complex and not ready for the initial release of perltidy. If
3512 anyone has any strong feelings about this, I'd like to hear. The
3513 current default could always be recovered with the '-nlp' flag.
3518 <pre><code>-html updates:
3519 - sub definition names are now specially colored, red by default.
3520 The letter 'm' is used to identify them.
3521 - keyword 'sub' now has color of other keywords.
3522 - restored html keyword color to __END__ and __DATA__, which was
3523 accidentally removed in the previous version.
3525 -A new -se (--standard-error-output) flag has been implemented and
3526 documented which causes all errors to be written to standard output
3527 instead of a .ERR file.
3529 -A new -w (--warning-output) flag has been implemented and documented
3530 which causes perltidy to output certain non-critical messages to the
3531 error output file, .ERR. These include complaints about pod usage,
3532 for example. The default is to not include these.
3534 NOTE: This replaces an undocumented -w=0 or --warning-level flag
3535 which was tentatively introduced in the previous version to avoid some
3536 unwanted messages. The new default is the same as the old -w=0, so
3537 that is no longer needed.
3539 -Improved syntax checking and corrected tokenization of functions such
3540 as rand, srand, sqrt, ... These can accept either an operator or a term
3541 to their right. This has been corrected.
3543 -Corrected tokenization of semicolon: testing of the previous update showed
3544 that the semicolon in the following statement was being mis-tokenized. That
3545 did no harm, other than adding an extra blank space, but has been corrected.
3547 for (sort {strcoll($a,$b);} keys %investments) {
3551 -New syntax check: after wasting 5 minutes trying to resolve a syntax
3552 error in which I had an extra terminal ';' in a complex for (;;) statement,
3553 I spent a few more minutes adding a check for this in perltidy so it won't
3556 -The behavior of --break-before-subs (-bbs) and --break-before-blocks
3557 (-bbb) has been modified. Also, a new control parameter,
3558 --long-block-line-count=n (-lbl=n) has been introduced to give more
3559 control on -bbb. This was previously a hardwired value. The reason
3560 for the change is to reduce the number of unwanted blank lines that
3561 perltidy introduces, and make it less erratic. It's annoying to remove
3562 an unwanted blank line and have perltidy put it back. The goal is to
3563 be able to sprinkle a few blank lines in that dense script you
3564 inherited from Bubba. I did a lot of experimenting with different
3565 schemes for introducing blank lines before and after code blocks, and
3566 decided that there is no really good way to do it. But I think the new
3567 scheme is an improvement. You can always deactivate this with -nbbb.
3568 I've been meaning to work on this; thanks to Erik Thaysen for bringing
3571 -The .LOG file is seldom needed, and I get tired of deleting them, so
3572 they will now only be automatically saved if perltidy thinks that it
3573 made an error, which is almost never. You can still force the logfile
3574 to be saved with -log or -g.
3576 -Improved method for computing number of columns in a table. The old
3577 method always tried for an even number. The new method allows odd
3578 numbers when it is obvious that a list is not a hash initialization
3582 $name, $xsargs, $parobjs, $optypes,
3583 $hasp2child, $pmcode, $hdrcode, $inplacecode,
3584 $globalnew, $callcopy
3589 $name, $xsargs, $parobjs, $optypes, $hasp2child,
3590 $pmcode, $hdrcode, $inplacecode, $globalnew, $callcopy
3594 -I fiddled with the list threshold adjustment, and some small lists
3595 look better now. Here is the change for one of the lists in test file
3599 ("in", "in", "pt", "pt", "pc", "pi", "mm", "mm", "cm", "cm", "\\hsize", "%",
3600 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%");
3604 "in", "in", "pt", "pt", "pc", "pi",
3605 "mm", "mm", "cm", "cm", "\\hsize", "%",
3606 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%"
3609 -Improved -lp formatting at '=' sign. A break was always being added after
3610 the '=' sign in a statement such as this, (to be sure there was enough room
3611 for the parameters):
3616 $biblionumber, $constraint,
3620 The updated version doesn't do this unless the space is really needed:
3622 new: my $fee = CalcReserveFee(
3624 $biblionumber, $constraint,
3628 -I updated the tokenizer to allow $#+ and $#-, which seem to be new to
3629 Perl 5.6. Some experimenting with a recent version of Perl indicated
3630 that it allows these non-alphanumeric '$#' array maximum index
3631 variables: $#: $#- $#+ so I updated the parser accordingly. Only $#:
3632 seems to be valid in older versions of Perl.
3634 -Fixed a rare formatting problem with -lp (and -gnu) which caused
3635 excessive indentation.
3637 -Many additional syntax checks have been added.
3639 -Revised method for testing here-doc target strings; the following
3640 was causing trouble with a regex test because of the '*' characters:
3641 print <<"*EOF*";
3644 Perl seems to allow almost anything to be a here doc target, so an
3645 exact string comparison is now used.
3647 -Made update to allow underscores in binary numbers, like '0b1100_0000'.
3649 -Corrected problem with scanning certain module names; a blank space was
3650 being inserted after 'warnings' in the following:
3651 use warnings::register;
3652 The problem was that warnings (and a couple of other key modules) were
3653 being tokenized as keywords. They should have just been identifiers.
3655 -Corrected tokenization of indirect objects after sort, system, and exec,
3656 after testing produced an incorrect error message for the following
3658 print sort $sortsubref @list;
3660 -Corrected minor problem where a line after a format had unwanted
3661 extra continuation indentation.
3663 -Delete-block-comments (and -dac) now retain any leading hash-bang line
3665 -Update for -lp (and -gnu) to not align the leading '=' of a list
3666 with a previous '=', since this interferes with alignment of parameters.
3668 old: my $hireDay = new Date;
3670 firstName => undef,
3671 lastName => undef,
3672 hireDay => $hireDay
3675 new: my $hireDay = new Date;
3677 firstName => undef,
3678 lastName => undef,
3679 hireDay => $hireDay
3682 -Modifications made to display tables more compactly when possible,
3683 without adding lines. For example,
3685 '1', "I", '2', "II", '3', "III", '4', "IV",
3686 '5', "V", '6', "VI", '7', "VII", '8', "VIII",
3689 '1', "I", '2', "II", '3', "III",
3690 '4', "IV", '5', "V", '6', "VI",
3691 '7', "VII", '8', "VIII", '9', "IX"
3693 -Corrected minor bug in which -pt=2 did not keep the right paren tight
3694 around a '++' or '--' token, like this:
3696 for ($i = 0 ; $i < length $key ; $i++ )
3698 The formatting for this should be, and now is:
3700 for ($i = 0 ; $i < length $key ; $i++)
3702 Thanks to Erik Thaysen for noting this.
3704 -Discovered a new bug involving here-docs during testing! See BUGS.html.
3706 -Finally fixed parsing of subroutine attributes (A Perl 5.6 feature).
3707 However, the attributes and prototypes must still be on the same line
3713 <pre><code>-Corrected minor, uncommon bug found during routine testing, in which a
3714 blank got inserted between a function name and its opening paren after
3715 a file test operator, but only in the case that the function had not
3716 been previously seen. Perl uses the existence (or lack thereof) of
3717 the blank to guess if it is a function call. That is,
3718 if (-l pid_filename()) {
3720 if (-l pid_filename ()) {
3721 which is a syntax error if pid_filename has not been seen by perl.
3723 -If the AutoLoader module is used, perltidy will continue formatting
3724 code after seeing an __END__ line. Use -nlal to deactivate this feature.
3725 Likewise, if the SelfLoader module is used, perltidy will continue
3726 formatting code after seeing a __DATA__ line. Use -nlsl to
3727 deactivate this feature. Thanks to Slaven Rezic for this suggestion.
3729 -pod text after __END__ and __DATA__ is now identified by perltidy
3730 so that -dp works correctly. Thanks to Slaven Rezic for this suggestion.
3732 -The first $VERSION line which might be eval'd by MakeMaker
3733 is now passed through unchanged. Use -npvl to deactivate this feature.
3734 Thanks to Manfred Winter for this suggestion.
3736 -Improved indentation of nested parenthesized expressions. Tests have
3737 given favorable results. Thanks to Wolfgang Weisselberg for helpful
3743 <pre><code>-Fixed a very rare problem in which an unwanted semicolon was inserted
3744 due to misidentification of anonymous hash reference curly as a code
3745 block curly. (No instances of this have been reported; I discovered it
3746 during testing). A workaround for older versions of perltidy is to use
3749 -Added -icb (-indent-closing-brace) parameter to indent a brace which
3750 terminates a code block to the same level as the previous line.
3751 Suggested by Andrew Cutler. For example,
3760 -Rewrote error message triggered by an unknown bareword in a print or
3761 printf filehandle position, and added flag -w=0 to prevent issuing this
3762 error message. Suggested by Byron Jones.
3764 -Added modification to align a one-line 'if' block with similar
3765 following 'elsif' one-line blocks, like this:
3766 if ( $something eq "simple" ) { &handle_simple }
3767 elsif ( $something eq "hard" ) { &handle_hard }
3768 (Suggested by Wolfgang Weisselberg).
3773 <pre><code>-Eliminated all constants with leading underscores because perl 5.005_03
3774 does not support that. For example, _SPACES changed to XX_SPACES.
3775 Thanks to kromJx for this update.
3780 <pre><code>-the directory of test files has been moved to a separate distribution
3781 file because it is getting large but is of little interest to most users.
3782 For the current distribution:
3783 perltidy-20010701.tgz contains the source and docs for perltidy
3784 perltidy-20010701-test.tgz contains the test files
3786 -fixed bug where temporary file perltidy.TMPI was not being deleted
3787 when input was from stdin.
3789 -adjusted line break logic to not break after closing brace of an
3790 eval block (suggested by Boris Zentner).
3792 -added flag -gnu (--gnu-style) to give an approximation to the GNU
3793 style as sometimes applied to perl. The programming style in GNU
3794 'automake' was used as a guide in setting the parameters; these
3795 parameters will probably be adjusted over time.
3797 -an empty code block now has one space for emphasis:
3798 if ( $cmd eq "bg_untested" ) {} # old
3799 if ( $cmd eq "bg_untested" ) { } # new
3800 If this bothers anyone, we could create a parameter.
3802 -the -bt (--brace-tightness) parameter has been split into two
3803 parameters to give more control. -bt now applies only to non-BLOCK
3804 braces, while a new parameter -bbt (block-brace-tightness) applies to
3805 curly braces which contain code BLOCKS. The default value is -bbt=0.
3807 -added flag -icp (--indent-closing-paren) which leaves a statement
3808 termination of the form );, };, or ]; indented with the same
3809 indentation as the previous line. For example,
3811 @month_of_year = ( # default, or -nicp
3812 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3816 @month_of_year = ( # -icp
3817 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3821 -Vertical alignment updated to synchronize with tokens &&, ||,
3822 and, or, if, unless. Allowable space before forcing
3823 resynchronization has been increased. (Suggested by Wolfgang
3826 -html corrected to use -nohtml-bold-xxxxxxx or -nhbx to negate bold,
3827 and likewise -nohtml-italic-xxxxxxx or -nhbi to negate italic. There
3828 was no way to negate these previously. html documentation updated and
3829 corrected. (Suggested by Wolfgang Weisselberg).
3831 -Some modifications have been made which improve the -lp formatting in
3834 -Perltidy now retains or creates a blank line after an =cut to keep
3835 podchecker happy (Suggested by Manfred H. Winter). This appears to be
3836 a glitch in podchecker, but it was annoying.
3841 <pre><code>-Added -bli flag to give continuation indentation to braces, like this
3845 extra_indentation();
3848 -Corrected an error with the tab (-t) option which caused the last line
3849 of a multi-line quote to receive a leading tab. This error was in
3850 version 2001 06 08 but not 2001 04 06. If you formatted a script
3851 with -t with this version, please check it by running once with the
3852 -chk flag and perltidy will scan for this possible error.
3854 -Corrected an invalid pattern (\R should have been just R), changed
3855 $^W =1 to BEGIN {$^W=1} to use warnings in compile phase, and corrected
3856 several unnecessary 'my' declarations. Many thanks to Wolfgang Weisselberg,
3857 2001-06-12, for catching these errors.
3859 -A '-bar' flag has been added to require braces to always be on the
3860 right, even for multi-line if and foreach statements. For example,
3861 the default formatting of a long if statement would be:
3863 if ($bigwasteofspace1 && $bigwasteofspace2
3864 || $bigwasteofspace3 && $bigwasteofspace4)
3869 With -bar, the formatting is:
3871 if ($bigwasteofspace1 && $bigwasteofspace2
3872 || $bigwasteofspace3 && $bigwasteofspace4) {
3875 Suggested by Eli Fidler 2001-06-11.
3877 -Uploaded perltidy to sourceforge cvs 2001-06-10.
3879 -An '-lp' flag (--line-up-parentheses) has been added which causes lists
3880 to be indented with extra indentation in the manner sometimes
3881 associated with emacs or the GNU suggestions. Thanks to Ian Stuart for
3882 this suggestion and for extensive help in testing it.
3884 -Subroutine call parameter lists are now formatted as other lists.
3885 This should improve formatting of tables being passed via subroutine
3886 calls. This will also cause full indentation ('-i=n, default n= 4) of
3887 continued parameter list lines rather than just the number of spaces
3888 given with -ci=n, default n=2.
3890 -Added support for hanging side comments. Perltidy identifies a hanging
3891 side comment as a comment immediately following a line with a side
3892 comment or another hanging side comment. This should work in most
3893 cases. It can be deactivated with --no-hanging-side-comments (-nhsc).
3894 The manual has been updated to discuss this. Suggested by Brad
3895 Eisenberg some time ago, and finally implemented.
3900 <pre><code>-fixed problem with parsing command parameters containing quoted
3901 strings in .perltidyrc files. (Reported by Roger Espel Llima 2001-06-07).
3903 -added two command line flags, --want-break-after and
3904 --want-break-before, which allow changing whether perltidy
3905 breaks lines before or after any operators. Please see the revised
3906 man pages for details.
3908 -added system-wide configuration file capability.
3909 If perltidy does not find a .perltidyrc command line file in
3910 the current directory, nor in the home directory, it now looks
3911 for '/usr/local/etc/perltidyrc' and then for '/etc/perltidyrc'.
3912 (Suggested by Roger Espel Llima 2001-05-31).
3914 -fixed problem in which spaces were trimmed from lines of a multi-line
3915 quote. (Reported by Roger Espel Llima 2001-05-30). This is an
3916 uncommon situation, but serious, because it could conceivably change
3917 the proper function of a script.
3919 -fixed problem in which a semicolon was incorrectly added within
3920 an anonymous hash. (Reported by A.C. Yardley, 2001-5-23).
3921 (You would know if this happened, because perl would give a syntax
3922 error for the resulting script).
3924 -fixed problem in which an incorrect error message was produced
3925 after a version number on a 'use' line, like this ( Reported
3926 by Andres Kroonmaa, 2001-5-14):
3928 use CGI 2.42 qw(fatalsToBrowser);
3930 Other than the extraneous error message, this bug was harmless.
3935 <pre><code>-fixed serious bug in which the last line of some multi-line quotes or
3936 patterns was given continuation indentation spaces. This may make
3937 a pattern incorrect unless it uses the /x modifier. To find
3938 instances of this error in scripts which have been formatted with
3939 earlier versions of perltidy, run with the -chk flag, which has
3940 been added for this purpose (SLH, 2001-04-05).
3942 ** So, please check previously formatted scripts by running with -chk
3945 -continuation indentation has been reprogrammed to be hierarchical,
3946 which improves deeply nested structures.
3948 -fixed problem with undefined value in list formatting (reported by Michael
3951 -Switched to graphical display of nesting in .LOG files. If an
3952 old format string was "(1 [0 {2", the new string is "{{(". This
3953 is easier to read and also shows the order of nesting.
3955 -added outdenting of cuddled paren structures, like ")->pack(".
3957 -added line break and outdenting of ')->' so that instead of
3960 -text => "perltidy",
3961 -relief => 'ridge')->pack;
3963 the current default is:
3966 -text => "perltidy",
3967 -relief => 'ridge'
3970 (requested by Michael Langner 2001-03-31; in the future this could
3971 be controlled by a command-line parameter).
3973 -revised list indentation logic, so that lists following an assignment
3974 operator get one full indentation level, rather than just continuation
3975 indentation. Also corrected some minor glitches in the continuation
3978 -Fixed problem with unwanted continuation indentation after a blank line
3979 (reported by Erik Thaysen 2001-03-28):
3981 -minor update to avoid stranding a single '(' on one line
3984 <h2>2001 03 28:</h2>
3986 <pre><code>-corrected serious error tokenizing filehandles, in which a sub call
3987 after a print or printf, like this:
3988 print usage() and exit;
3990 print usage () and exit;
3991 Unfortunately, this converts 'usage' to a filehandle. To fix this, rerun
3992 perltidy; it will look for this situation and issue a warning.
3994 -fixed another cuddled-else formatting bug (Reported by Craig Bourne)
3996 -added several diagnostic --dump routines
3998 -added token-level whitespace controls (suggested by Hans Ecke)
4001 <h2>2001 03 23:</h2>
4003 <pre><code>-added support for special variables of the form ${^WANT_BITS}
4005 -space added between scalar and left paren in 'for' and 'foreach' loops,
4006 (suggestion by Michael Cartmell):
4008 for $i( 1 .. 20 ) # old
4009 for $i ( 1 .. 20 ) # new
4011 -html now outputs cascading style sheets (thanks to suggestion from
4014 -flags -o and -st now work with -html
4016 -added missing -html documentation for comments (noted by Alex Izvorski)
4018 -support for VMS added (thanks to Michael Cartmell for code patches and
4021 -v-strings implemented (noted by Hans Ecke and Michael Cartmell; extensive
4022 testing by Michael Cartmell)
4024 -fixed problem where operand may be empty at line 3970
4025 (\b should be just b in lines 3970, 3973) (Thanks to Erik Thaysen,
4026 Keith Marshall for bug reports)
4028 -fixed -ce bug (cuddled else), where lines like '} else {' were indented
4029 (Thanks to Shawn Stepper and Rick Measham for reporting this)
4032 <h2>2001 03 04:</h2>
4034 <pre><code>-fixed undefined value in line 153 (only worked with -I set)
4035 (Thanks to Mike Stok, Phantom of the Opcodes, Ian Ehrenwald, and others)
4037 -fixed undefined value in line 1069 (filehandle problem with perl versions <
4038 5.6) (Thanks to Yuri Leikind, Mike Stok, Michael Holve, Jeff Kolber)
4041 <h2>2001 03 03:</h2>
4043 <pre><code>-Initial announcement at freshmeat.net; started Change Log
4044 (Unfortunately this version was DOA, but it was fixed the next day)