1 <h1>Perltidy Change Log</h1>
5 <pre><code>- No significant bugs have been found since the last release but users
6 of programs which call the Perl::Tidy module should note the first
7 item below, which changes a default setting. The main change to
8 existing formatting is the second item below, which adds vertical
9 alignment to 'use' statements.
11 - The flag --encode-output-strings, or -eos, is now set 'on' by default.
12 This has no effect on the use of the 'perltidy' binary script, but could
13 change the behavior of some programs which use the Perl::Tidy module on
14 files encoded in UTF-8. If any problems are noticed, an emergency fix
15 can be made by reverting to the old default by setting -neos. For
16 an explanation of why this change needs to be made see:
18 https://github.com/perltidy/perltidy/issues/92
20 https://github.com/perltidy/perltidy/blob/master/docs/eos_flag.md
22 - Added vertical alignment for qw quotes and empty parens in 'use'
23 statements (see issue #git 93). This new alignment is 'on' by default
24 and will change formatting as shown below. If this is not wanted it can
25 be turned off with the parameter -vxl='q' (--valign-exclude-list='q').
27 # old default, or -vxl='q'
28 use Getopt::Long qw(GetOptions);
29 use Fcntl qw(O_RDONLY O_WRONLY O_EXCL O_CREAT);
30 use Symbol qw(gensym);
34 use Getopt::Long qw(GetOptions);
35 use Fcntl qw(O_RDONLY O_WRONLY O_EXCL O_CREAT);
36 use Symbol qw(gensym);
39 - The parameter -kbb (--keep-break-before) now ignores a request to break
40 before an opening token, such as '('. Likewise, -kba (--keep-break-after)
41 now ignores a request to break after a closing token, such as ')'. This
42 change was made to avoid a rare instability discovered in random testing.
44 - Previously, if a -dsc command was used to delete all side comments,
45 then any special side comments for controlling non-indenting braces got
46 deleted too. Now, these control side comments are retained when -dsc is
47 set unless a -nnib (--nonon-indenting-braces) flag is also set to
50 - This version runs about 10 percent faster on large files than the previous
51 release due to optimizations made with the help of Devel::NYTProf. Much
52 of the gain came from faster processing of blank tokens and comments.
54 - This version of perltidy was stress-tested for many cpu hours with
55 random input parameters. No failures to converge, internal fault checks,
56 undefined variable references or other irregularities were seen.
61 <pre><code>- A new flag, --encode-output-strings, or -eos, has been added to resolve
62 issue git #83. This issue involves the interface between Perl::Tidy and
63 calling programs, and Code::TidyAll (tidyall) in particular. The problem
64 is that perltidy by default returns decoded character strings, but
65 tidyall expects encoded strings. This flag provides a fix for that.
67 So, tidyall users who process encoded (utf8) files should update to this
68 version of Perl::Tidy and use -eos for tidyall. For further info see:
70 https://github.com/houseabsolute/perl-code-tidyall/issues/84, and
71 https://github.com/perltidy/perltidy/issues/83
73 If there are other applications having utf8 problems at the interface
74 with Perl::Tidy, this flag probably may need to be set.
76 - The default value of the new flag, --encode-output-strings, -eos, is currently
77 -neos BUT THIS MAY CHANGE in a future release because the current
78 default is inconvenient. So authors of programs which receive character
79 strings back from Perl::Tidy should set this flag, if necessary,
80 to avoid any problems when the default changes. For more information see the
81 above links and the Perl::Tidy man pages for example coding.
83 - The possible values of the string 's' for the flag '--character-encoding=s'
84 have been limited to 'utf8' (or UTF-8), 'none', or 'guess'. Previously an
85 arbitrary encoding could also be specified, but as a result of discussions
86 regarding git #83 it became clear that this could cause trouble
87 since the output encoding was still restricted to UTF-8. Users
88 who need to work in other encodings can write a short program calling
89 Perl::Tidy with pre- and post-processing to handle encoding/decoding.
91 - A new flag --break-after-labels=i, or -bal=i, was added for git #86. This
92 controls line breaks after labels, to provide a uniform style, as follows:
94 -bal=0 follows the input line breaks [DEFAULT]
95 -bal=1 always break after a label
96 -bal=2 never break after a label
111 - Fix issue git #82, an error handling something like ${bareword} in a
112 possible indirect object location. Perl allows this, now perltidy does too.
114 - The flags -kbb=s or --keep-old-breakpoints-before=s, and its counterpart
115 -kba=s or --keep-old-breakpoints-after=s have expanded functionality
116 for the container tokens: { [ ( } ] ). The updated man pages have
119 - Two new flags have been added to provide finer vertical alignment control,
120 --valign-exclusion-list=s (-vxl=s) and --valign-inclusion-list=s (-vil=s).
121 This has been requested several times, most recently in git #79, and it
122 finally got done. For example, -vil='=>' means just align on '=>'.
124 - A new flag -gal=s, --grep-alias-list=s, has been added as suggested in
125 git #77. This allows code blocks passed to list operator functions to
126 be formatted in the same way as a code block passed to grep, map, or sort.
127 By default, the following list operators in List::Util are included:
129 all any first none notall reduce reductions
131 They can be changed with the flag -gaxl=s, -grep-alias-exclusion-list=s
133 - A new flag -xlp has been added which can be set to avoid most of the
134 limitations of the -lp flag regarding side comments, blank lines, and
135 code blocks. See the man pages for more info. This fixes git #64 and git #74.
136 The older -lp flag still works.
138 - A new flag -lpil=s, --line-up-parentheses-inclusion-list=s, has been added
139 as an alternative to -lpxl=s, --line-up-parentheses-exclusion-list=s.
140 It supplies equivalent information but is much easier to describe and use.
141 It works for both the older -lp version and the newer -xlp.
143 - The coding for the older -lp flag has been updated to avoid some problems
144 and limitations. The new coding allows the -lp indentation style to
145 mix smoothly with the standard indentation in a single file. Some problems
146 where -lp and -xci flags were not working well together have been fixed, such
147 as happened in issue rt140025. As a result of these updates some minor
148 changes in existing code using the -lp style may occur.
150 - This version of perltidy was stress-tested for many cpu hours with
151 random input parameters. No failures to converge, internal fault checks,
152 undefined variable references or other irregularities were seen.
154 - Numerous minor fixes have been made, mostly very rare formatting
155 instabilities found in random testing.
160 <pre><code>- No significant bugs have been found since the last release, but several
161 minor issues have been fixed. Vertical alignment has been improved for
162 lists of call args which are not contained within parens (next item).
164 - Vertical alignment of function calls without parens has been improved with
165 the goal of making vertical alignment essentially the same with or
166 without parens around the call args. Some examples:
169 mkTextConfig $c, $x, $y, -anchor => 'se', $color;
170 mkTextConfig $c, $x + 30, $y, -anchor => 's', $color;
171 mkTextConfig $c, $x + 60, $y, -anchor => 'sw', $color;
172 mkTextConfig $c, $x, $y + 30, -anchor => 'e', $color;
175 mkTextConfig $c, $x, $y, -anchor => 'se', $color;
176 mkTextConfig $c, $x + 30, $y, -anchor => 's', $color;
177 mkTextConfig $c, $x + 60, $y, -anchor => 'sw', $color;
178 mkTextConfig $c, $x, $y + 30, -anchor => 'e', $color;
181 is id_2obj($id), undef, "unregistered object not retrieved";
182 is scalar keys %$ob_reg, 0, "object registry empty";
183 is register($obj), $obj, "object returned by register";
184 is scalar keys %$ob_reg, 1, "object registry nonempty";
185 is id_2obj($id), $obj, "registered object retrieved";
188 is id_2obj($id), undef, "unregistered object not retrieved";
189 is scalar keys %$ob_reg, 0, "object registry empty";
190 is register($obj), $obj, "object returned by register";
191 is scalar keys %$ob_reg, 1, "object registry nonempty";
192 is id_2obj($id), $obj, "registered object retrieved";
194 This will cause some changes in alignment, hopefully for the better,
195 particularly in test code which often uses numerous parenless function
196 calls with functions like 'ok', 'is', 'is_deeply', ....
198 - Two new parameters were added to control the block types to which the
199 -bl (--opening-brace-on-new-line) flag applies. The new parameters are
200 -block-left-list=s, or -bll=s, and --block-left-exclusion-list=s,
201 or -blxl=s. Previously the -bl flag was 'hardwired' to apply to
202 nearly all blocks. The default values of the new parameters
203 retain the the old default behavior but allow it to be changed.
205 - The default behavior of the -bli (-brace-left-and-indent) flag has changed
206 slightly. Previously, if you set -bli, then the -bl flag would also
207 automatically be set. Consequently, block types which were not included
208 in the default list for -bli would get -bl formatting. This is no longer done,
209 and these two styles are now controlled independently. The manual describes
210 the controls. If you want to recover the exact previous default behavior of
211 the -bli then add the -bl flag.
213 - A partial fix was made for issue for git #74. The -lp formatting style was
214 being lost when a one-line anonymous sub was followed by a closing brace.
216 - Fixed issue git #73, in which the -nfpva flag was not working correctly.
217 Some unwanted vertical alignments of spaced function perens
220 - Updated the man pages to clarify the flags -valign and -novalign
221 for turning vertical alignment on and off (issue git #72).
222 Added parameters -vc -vsc -vbc for separately turning off vertical
223 alignment of code, side comments and block comments.
225 - Fixed issue git #68, where a blank line following a closing code-skipping
226 comment, '#>>V', could be lost.
228 - This version runs 10 to 15 percent faster on large files than the
229 previous release due to optimizations made with the help of NYTProf.
231 - This version of perltidy was stress-tested for many cpu hours with
232 random input parameters. No instabilities, internal fault checks,
233 undefined variable references or other irregularities were seen.
235 - Numerous minor fixes have been made, mostly very rare formatting instabilities
236 found in random testing. An effort has been made to minimize changes to
237 existing formatting that these fixes produce, but occasional changes
238 may occur. Many of these updates are listed at:
240 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
245 <pre><code>- This release is being made mainly because of the next item, in which an
246 error message about an uninitialized value error message could be produced
247 in certain cases when format-skipping is used. The error message was
248 annoying but harmless to formatting.
250 - Fixed an undefined variable message, see git #67. When a format skipping
251 comment '#<<' is placed before the first line of code in a script, a
252 message 'Use of uninitialized value $Ktoken_vars in numeric ...' can
255 - A warning will no longer be given if a script has an opening code-skipping
256 comment '#<<V' which is not terminated with a closing comment '#>>V'. This
257 makes code-skipping and format-skipping behave in a similar way: an
258 opening comment without a corresponding closing comment will cause
259 the rest of a file to be skipped. If there is a question about which lines
260 are skipped, a .LOG file can be produced with the -g flag and it will have
263 - Removed the limit on -ci=n when -xci is set, reference: rt #136415.
264 This update removes a limit in the previous two versions in which the
265 value of -ci=n was limited to the value of -i=n when -xci was set.
266 This limit had been placed to avoid some formatting instabilities,
267 but recent coding improvements allow the limit to be removed.
269 - The -wn and -bbxx=n flags were not working together correctly. This has
272 - This version may produce occasional differences in formatting compared to
273 previous versions, mainly for lines which are near the specified line
274 length limit. This is due to ongoing efforts to eliminate edge cases of
275 formatting instability.
277 - Numerous minor fixes have been made. A complete list is at:
279 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
284 <pre><code>- This release adds several new requested parameters. No significant bugs have
285 been found since the last release, but a number of minor problems have been
288 - Added a new option '--code-skipping', requested in git #65, in which code
289 between comment lines '#<<V' and '#>>V' is passed verbatim to the output
290 stream without error checking. It is simmilar to --format-skipping
291 but there is no error checking of the skipped code. This can be useful for
292 skipping past code which employs an extended syntax.
294 - Added a new option for closing paren placement, -vtc=3, requested in rt #136417.
296 - Added flag -atnl, --add-terminal-newline, to help issue git #58.
297 This flag tells perltidy to terminate the last line of the output stream
298 with a newline character, regardless of whether or not the input stream
299 was terminated with a newline character. This is the default.
300 If this flag is negated, with -natnl, then perltidy will add a terminal
301 newline character to the the output stream only if the input
302 stream is terminated with a newline.
304 - Some nested structures formatted with the -lp indentation option may have
305 some changes in indentation. This is due to updates which were made to
306 prevent formatting instability when line lengths are limited by the maximum line
307 length. Most scripts will not be affected. If this causes unwanted formatting
308 changes, try increasing the --maximum-line-length by a few characters.
310 - Numerous minor fixes have been made. A complete list is at:
312 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
317 <pre><code>- This release fixes several non-critical bugs which have been found since the last
318 release. An effort has been made to keep existing formatting unchanged.
320 - Fixed issue git #57 regarding uninitialized warning flag.
322 - Added experimental flag -lpxl=s requested in issue git #56 to provide some
323 control over which containers get -lp indentation.
325 - Fixed issue git #55 regarding lack of coordination of the --break-before-xxx
326 flags and the --line-up-parens flag.
328 - Fixed issue git #54 regarding irregular application of the --break-before-paren
329 and similar --break-before-xxx flags, in which lists without commas were not
330 being formatted according to these flags.
332 - Fixed issue git #53. A flag was added to turn off alignment of spaced function
333 parens. If the --space-function-paren, -sfp flag is set, a side-effect is that the
334 spaced function parens may get vertically aligned. This can be undesirable,
335 so a new parameter '--function-paren-vertical-alignment', or '-fpva', has been
336 added to turn this vertical alignment off. The default is '-fpva', so that
337 existing formatting is not changed. Use '-nfpva' to turn off unwanted
338 vertical alignment. To illustrate the possibilities:
341 myfun( $aaa, $b, $cc );
342 mylongfun( $a, $b, $c );
345 myfun ( $aaa, $b, $cc );
346 mylongfun ( $a, $b, $c );
348 # perltidy -sfp -nfpva
349 myfun ( $aaa, $b, $cc );
350 mylongfun ( $a, $b, $c );
352 - Fixed issue git #51, a closing qw bare paren was not being outdented when
353 the -nodelete-old-newlines flag was set.
355 - Fixed numerous edge cases involving unusual parameter combinations which
356 could cause alternating output states. Most scripts will not be
357 changed by these fixes.
359 - A more complete list of updates is at
361 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
366 <pre><code>- Fixed issue git #49, -se breaks warnings exit status behavior.
367 The exit status flag was not always being set when the -se flag was set.
369 - Some improvements have been made in the method for aligning side comments.
370 One of the problems that was fixed is that there was a tendency for side comment
371 placement to drift to the right in long scripts. Programs with side comments
372 may have a few changes.
374 - Some improvements have been made in formatting qw quoted lists. This
375 fixes issue git #51, in which closing qw pattern delimiters not always
376 following the settings specified by the --closing-token-indentation=n settings.
377 Now qw closing delimiters ')', '}' and ']' follow these flags, and the
378 delimiter '>' follows the flag for ')'. Other qw pattern delimiters remain
379 indented as the are now. This change will cause some small formatting changes
380 in some existing programs.
382 - Another change involving qw lists is that they get full indentation,
383 rather than just continuation indentation, if
385 (1) the closing delimiter is one of } ) ] > and is on a separate line,
386 (2) the opening delimiter (i.e. 'qw{' ) is also on a separate line, and
387 (3) the -xci flag (--extended-continuation-indentation) is set.
389 This improves formatting when qw lists are contained in other lists. For example,
394 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
395 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
398 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
399 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
406 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
407 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
410 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
411 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
415 - Some minor improvements have been made to the rules for formatting
416 some edge vertical alignment cases, usually involving two dissimilar lines.
418 - A more complete list of updates is at
420 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
425 <pre><code>- Fixed issue git #47, incorrect welding of anonymous subs.
426 An incorrect weld format was being made when the --weld-nested-containers option
427 (-wn) was used in to format a function which returns a list of anonymous subs.
428 For example, the following snippet was incorrectly being welded.
430 $promises[$i]->then(
431 sub { $all->resolve(@_); () },
433 $results->[$i] = [@_];
434 $all->reject(@$results) if --$remaining <= 0;
439 This was due to an error introduced in v20201201 related to parsing sub
440 signatures. Reformatting with the current version will fix the problem.
445 <pre><code>- This release is being made primarily to make available a several new formatting
446 parameters, in particular -xci, -kbb=s, -kba=s, and -wnxl=s. No significant
447 bugs have been found since the previous release, but numerous minor issues have
448 been found and fixed as listed below.
450 - This version is about 20% faster than the previous version due to optimizations
451 made with the help of Devel::NYTProf.
453 - Added flag -wnxl=s, --weld-nested-exclusion-list=s, to provide control which containers
454 are welded with the --weld-nested-containers parameter. This is related to issue git #45.
456 - Merged pull request git #46 which fixes the docs regarding the -fse flag.
458 - Fixed issue git #45, -vtc=n flag was ignored when -wn was set.
460 - implement request RT #133649, delete-old-newlines selectively. Two parameters,
462 -kbb=s or --keep-old-breakpoints-before=s, and
463 -kba=s or --keep-old-breakpoints-after=s
465 were added to request that old breakpoints be kept before or after
466 selected token types. For example, -kbb='=>' means that newlines before
467 fat commas should be kept.
469 - Fix git #44, fix exit status for assert-tidy/untidy. The exit status was
470 always 0 for --assert-tidy if the user had turned off all error messages with
471 the -quiet flag. This has been fixed.
473 - Add flag -maxfs=n, --maximum-file-size-mb=n. This parameter is provided to
474 avoid causing system problems by accidentally attempting to format an
475 extremely large data file. The default is n=10. The command to increase
476 the limit to 20 MB for example would be -mfs=20. This only applies to
477 files specified by filename on the command line.
479 - Skip formatting if there are too many indentation level errors. This is
480 controlled with -maxle=n, --maximum-level-errors=n. This means that if
481 the ending indentation differs from the starting indentation by more than
482 n levels, the file will be output verbatim. The default is n=1.
483 To skip this check, set n=-1 or set n to a large number.
485 - A related new flag, --maximum-unexpected-errors=n, or -maxue=n, is available
486 but is off by default.
488 - Add flag -xci, --extended-continuation-indentation, regarding issue git #28
489 This flag causes continuation indentation to "extend" deeper into structures.
490 Since this is a fairly new flag, the default is -nxci to avoid disturbing
491 existing formatting. BUT you will probably see some improved formatting
492 in complex data structures by setting this flag if you currently use -ci=n
493 and -i=n with the same value of 'n' (as is the case if you use -pbp,
494 --perl-best-practices, where n=4).
496 - Fix issue git #42, clarify how --break-at-old-logical-breakpoints works.
497 The man page was updated to note that it does not cause all logical breakpoints
498 to be replicated in the output file.
500 - Fix issue git #41, typo in manual regarding -fsb.
502 - Fix issue git #40: when using the -bli option, a closing brace followed by
503 a semicolon was not being indented. This applies to braces which require
504 semicolons, such as a 'do' block.
506 - Added 'state' as a keyword.
508 - A better test for convergence has been added. When iterations are requested,
509 the new test will stop after the first pass if no changes in line break
510 locations are made. Previously, file checksums were used and required at least two
511 passes to verify convergence unless no formatting changes were made. With the new test,
512 only a single pass is needed when formatting changes are limited to adjustments of
513 indentation and whitespace on the lines of code. Extensive testing has been made to
514 verify the correctness of the new convergence test.
516 - Line breaks are now automatically placed after 'use overload' to
517 improve formatting when there are numerous overloaded operators. For
524 - A number of minor problems with parsing signatures and prototypes have
525 been corrected, particularly multi-line signatures. Some signatures
526 had previously been parsed as if they were prototypes, which meant the
527 normal spacing rules were not applied. For example
530 sub echo ($message= 'Hello World!' ) {
535 sub echo ( $message = 'Hello World!' ) {
539 - Numerous minor issues that the average user would not encounter were found
540 and fixed. They can be seen in the more complete list of updates at
542 https://github.com/perltidy/perltidy/blob/master/local-docs/BugLog.pod
547 <pre><code>- Robustness of perltidy has been significantly improved. Updating is recommended. Continual
548 automated testing runs began about 1 Sep 2020 and numerous issues have been found and fixed.
549 Many involve references to uninitialized variables when perltidy is fed random text and random
552 - Added the token '->' to the list of alignment tokens, as suggested in git
553 #39, so that it can be vertically aligned if a space is placed before them with -wls='->'.
555 - Added parameters -bbhb=n (--break-before-hash-brace=n), -bbsb=n (--break-before-square-bracket=n),
556 and -bbp=n (--break-before-paren=n) suggested in git #38. These provide control over the
557 opening container token of a multiple-line list. Related new parameters -bbhbi=n, -bbsbi=n, -bbpi=n
558 control indentation of these tokens.
560 - Added keyword 'isa'.
565 <pre><code>- Fixed bug git #37, an error when the combination -scbb -csc was used.
566 It occurs in perltidy versions 20200110, 20200619, and 20200822. What happens is
567 that when two consecutive lines with isolated closing braces had new side
568 comments generated by the -csc parameter, a separating newline was missing.
569 The resulting script will not then run, but worse, if it is reformatted with
570 the same parameters then closing side comments could be overwritten and data
573 This problem was found during automated random testing. The parameter
574 -scbb is rarely used, which is probably why this has not been reported. Please
575 upgrade your version.
577 - Added parameter --non-indenting-braces, or -nib, which prevents
578 code from indenting one level if it follows an opening brace marked
579 with a special side comment, '#<<<'. For example,
581 { #<<< a closure to contain lexical vars
583 my $var; # this line does not indent
587 # this line cannot 'see' $var;
589 This is on by default. If your code happens to have some
590 opening braces followed by '#<<<', and you
591 don't want this, you can use -nnib to deactivate it.
593 - Side comment locations reset at a line ending in a level 0 open
594 block, such as when a new multi-line sub begins. This is intended to
595 help keep side comments from drifting to far to the right.
600 <pre><code>- Fix RT #133166, encoding not set for -st. Also reported as RT #133171
603 This is a significant bug in version 20200616 which can corrupt data if
604 perltidy is run as a filter on encoded text.
607 <p><strong>Please upgrade</strong></p>
609 <pre><code>- Fix issue RT #133161, perltidy -html was not working on pod
611 - Fix issue git #33, allow control of space after '->'
613 - Vertical alignment has been improved. Numerous minor issues have
616 - Formatting with the -lp option is improved.
618 - Fixed issue git #32, misparse of bare 'ref' in ternary
620 - When --assert-tidy is used and triggers an error, the first difference
621 between input and output files is shown in the error output. This is
622 a partial response to issue git #30.
627 <pre><code>- Added support for Switch::Plain syntax, issue git #31.
629 - Fixed minor problem where trailing 'unless' clauses were not
630 getting vertically aligned.
632 - Added a parameter --logical-padding or -lop to allow logical padding
633 to be turned off. Requested by git #29. This flag is on by default.
634 The man pages have examples.
636 - Added a parameter -kpit=n to control spaces inside of parens following
637 certain keywords, requested in git#26. This flag is off by default.
639 - Added fix for git#25, improve vertical alignment for long lists with
640 varying numbers of items per line.
642 - calls to the module Perl::Tidy can now capture any output produced
643 by a debug flag or one of the 'tee' flags through the new 'debugfile' and
644 'teefile' call parameters. These output streams are rarely used but
645 they are now treated the same as any 'logfile' stream.
647 - add option --break-at-old-semicolon-breakpoints', -bos, requested
648 in RT#131644. This flag will keep lines beginning with a semicolon.
650 - Added --use-unicode-gcstring to control use of Unicode::GCString for
651 evaluating character widths of encoded data. The default is
652 not to use this (--nouse-unicode-gcstring). If this flag is set,
653 perltidy will look for Unicode::GCString and, if found, will use it
654 to evaluate character display widths. This can improve displayed
655 vertical alignment for files with wide characters. It is a nice
656 feature but it is off by default to avoid conflicting formatting
657 when there are multiple developers. Perltidy installation does not
658 require Unicode::GCString, so users wanting to use this feature need
659 set this flag and also to install Unicode::GCString separately.
661 - Added --character-encoding=guess or -guess to have perltidy guess
662 if a file (or other input stream) is encoded as -utf8 or some
663 other single-byte encoding. This is useful when processing a mixture
664 of file types, such as utf8 and latin-1.
666 Please Note: The default encoding has been set to be 'guess'
667 instead of 'none'. This seems like the best default, since
668 it allows perltidy work properly with both
669 utf8 files and older latin-1 files. The guess mode uses Encode::Guess,
670 which is included in standard perl distributions, and only tries to
671 guess if a file is utf8 or not, never any other encoding. If the guess is
672 utf8, and if the file successfully decodes as utf8, then it the encoding
673 is assumed to be utf8. Otherwise, no encoding is assumed.
674 If you do not want to use this new default guess mode, or have a
675 problem with it, you can set --character-encoding=none (the previous
676 default) or --character-encoding=utf8 (if you deal with utf8 files).
678 - Specific encodings of input files other than utf8 may now be given, for
679 example --character-encoding=euc-jp.
681 - Fix for git#22, Preserve function signature on a single line. An
682 unwanted line break was being introduced when a closing signature paren
683 followed a closing do brace.
685 - Fix RT#132059, the -dac parameter was not working and caused an error exit
687 - When -utf8 is used, any error output is encoded as utf8
689 - Fix for git#19, adjust line break around an 'xor'
691 - Fix for git#18, added warning for missing comma before unknown bare word.
696 <pre><code>- This release adds a flag to control the feature RT#130394 (allow short nested blocks)
697 introduced in the previous release. Unfortunately that feature breaks
698 RPerl installations, so a control flag has been introduced and that feature is now
699 off by default. The flag is:
701 --one-line-block-nesting=n, or -olbn=n, where n is an integer as follows:
703 -olbn=0 break nested one-line blocks into multiple lines [new DEFAULT]
704 -olbn=1 stable; keep existing nested-one line blocks intact [previous DEFAULT]
706 For example, consider this input line:
708 foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
710 The new default behavior (-olbn=0), and behavior prior to version 20191203, is to break it into multiple lines:
713 if ( $_ eq $asked_for ) { last }
717 To keep nested one-line blocks such as this on a single line you can add the parameter -olbn=1.
719 - Fixed issue RT#131288: parse error for un-prototyped constant function without parenthesized
720 call parameters followed by ternary.
722 - Fixed issue RT#131360, installation documentation. Added a note that the binary
723 'perltidy' comes with the Perl::Tidy module. They can both normally be installed with
729 <pre><code>- Fixed issue RT#131115: -bli option not working correctly.
730 Closing braces were not indented in some cases due to a glitch
731 introduced in version 20181120.
733 - Fixed issue RT#130394: Allow short nested blocks. Given the following
735 $factorial = sub { reduce { $a * $b } 1 .. 11 };
737 Previous versions would always break the sub block because it
738 contains another block (the reduce block). The fix keeps
739 short one-line blocks such as this intact.
741 - Implement issue RT#130640: Allow different subroutine keywords.
742 Added a flag --sub-alias-list=s or -sal=s, where s is a string with
743 one or more aliases for 'sub', separated by spaces or commas.
746 perltidy -sal='method fun'
748 will cause the perltidy to treat the words 'method' and 'fun' to be
749 treated the same as if they were 'sub'.
751 - Added flag --space-prototype-paren=i, or -spp=i, to control spacing
752 before the opening paren of a prototype, where i=0, 1, or 2:
754 i=1 follow input [current and default]
757 Previously, perltidy always followed the input.
758 For example, given the following input
763 sub usage(); # i=0 [no space]
764 sub usage(); # i=1 [default; follows input]
765 sub usage (); # i=2 [space]
767 - Fixed issue git#16, minor vertical alignment issue.
769 - Fixed issue git#10, minor conflict of -wn and -ce
771 - Improved some vertical alignments involving two lines.
776 <pre><code>- fixed issue RT#130344: false warning "operator in print statement"
779 - fixed issue RT#130304: standard error output should include filename.
780 When perltidy error messages are directed to the standard error output
781 with -se or --standard-error-output, the message lines now have a prefix
782 'filename:' for clarification in case multiple files
783 are processed, where 'filename' is the name of the input file. If
784 input is from the standard input the displayed filename is '<stdin>',
785 and if it is from a data structure then displayed filename
786 is '<source_stream>'.
788 - implement issue RT#130425: check mode. A new flag '--assert-tidy'
789 will cause an error message if the output script is not identical to
790 the input script. For completeness, the opposite flag '--assert-untidy'
791 has also been added. The next item, RT#130297, insures that the script
792 will exit with a non-zero exit flag if the assertion fails.
794 - fixed issue RT#130297; the perltidy script now exits with a nonzero exit
795 status if it wrote to the standard error output. Prevously only fatal
796 run errors produced a non-zero exit flag. Now, even non-fatal messages
797 requested with the -w flag will cause a non-zero exit flag. The exit
798 flag now has these values:
801 1 = perltidy could not run to completion due to errors
802 2 = perltidy ran to completion with error messages
804 - added warning message for RT#130008, which warns of conflicting input
805 parameters -iob and -bom or -boc.
807 - fixed RT#129850; concerning a space between a closing block brace and
808 opening bracket or brace, as occurs before the '[' in this line:
810 my @addunix = map { File::Spec::Unix->catfile( @ROOT, @$_ ) } ['b'];
812 Formerly, any space was removed. Now it is optional, and the output will
815 - fixed issue git#13, needless trailing whitespace in error message
817 - fixed issue git#9: if the -ce (--cuddled-else) flag is used,
818 do not try to form new one line blocks for a block type
819 specified with -cbl, particularly map, sort, grep
821 - iteration speedup for unchanged code. Previously, when iterations were
822 requested, at least two formatting passes were made. Now just a single pass
823 is made if the formatted code is identical to the input code.
825 - some improved vertical alignments
830 <pre><code>- rt #128477: Prevent inconsistent owner/group and setuid/setgid bits.
831 In the -b (--backup-and-modify-in-place) mode, an attempt is made to set ownership
832 of the output file equal to the input file, if they differ.
833 In all cases, if the final output file ownership differs from input file, any setuid/setgid bits are cleared.
835 - Added option -bom (--break-at-old-method-breakpoints) by
836 merrillymeredith which preserves breakpoints of method chains. Modified to also handle a cuddled call style.
838 - Merged patch to fix Windows EOL translation error with UTF-8 written by
839 Ron Ivy. This update prevents automatic conversion to 'DOS' CRLF line
840 endings. Also, Windows system testing at the appveyor site is working again.
842 - RT #128280, added flag --one-line-block-semicolons=n (-olbs=n)
843 to control semicolons in one-line blocks. The values of n are:
844 n=0 means no semicolons termininating simple one-line blocks
845 n=1 means stable; do not change from input file [DEFAULT and current]
846 n=2 means always add semicolons in one-line blocks
847 The current behavior corresponds to the default n=1.
849 - RT #128216, Minor update to prevent inserting unwanted blank line at
850 indentation level change. This should not change existing scripts.
852 - RT #81852: Improved indentation when quoted word (qw) lists are
853 nested within other containers using the --weld-nested (-wn) flag.
854 The example given previously (below) is now closer to what it would
855 be with a simple list instead of qw:
869 - RT#12764, introduced new feature allowing placement of blanks around
870 sequences of selected keywords. This can be activated with the -kgb*
871 series of parameters described in the manual.
873 - Rewrote vertical algnment module. It is better at finding
874 patterns in complex code. For example,
877 /^-std$/ && do { $std = 1; next; };
878 /^--$/ && do { @link_args = @argv; last; };
879 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
882 /^-std$/ && do { $std = 1; next; };
883 /^--$/ && do { @link_args = @argv; last; };
884 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
886 - Add repository URLs to META files
888 - RT #118553, "leave only one newline at end of file". This option was not
889 added because of undesirable side effects, but a new filter script
890 was added which can do this, "examples/delete_ending_blank_lines.pl".
895 <pre><code>- fix RT#127736 Perl-Tidy-20181119 has the EXE_FILES entry commented out in
896 Makefile.PL so it doesn't install the perltidy script or its manpage.
901 <pre><code>- Removed test case 'filter_example.t' which was causing a failure on a
902 Windows installation for unknown reasons, possibly due to an unexpected
903 perltidyrc being read by the test script. Added VERSION numbers to all
909 <pre><code>- Fixed RT #126965, in which a ternary operator was misparsed if immediately
910 following a function call without arguments, such as:
911 my $restrict_customer = shift ? 1 : 0;
913 - Fixed RT #125012: bug in -mangle --delete-all-comments
914 A needed blank space before bareword tokens was being removed when comments
917 - Fixed RT #81852: Stacked containers and quoting operators. Quoted words
918 (qw) delimited by container tokens ('{', '[', '(', '<') are now included in
919 the --weld-nested (-wn) flag:
933 - The cuddled-else (-ce) coding was merged with the new cuddled-block (-cb)
934 coding. The change is backward compatible and simplifies input.
935 The --cuddled-block-option=n (-cbo=n) flag now applies to both -ce and -cb
936 formatting. In fact the -cb flag is just an alias for -ce now.
938 - Fixed RT #124594, license text desc. changed from 'GPL-2.0+' to 'gpl_2'
940 - Fixed bug in which a warning about a possible code bug was issued in a
941 script with brace errors.
943 - added option --notimestamp or -nts to eliminate any time stamps in output
944 files. This is used to prevent differences in test scripts from causing
945 failure at installation. For example, the -cscw option will put a date
946 stamp on certain closing side comments. We need to avoid this in order
947 to test this feature in an installation test.
949 - Fixed bug with the entab option, -et=8, in which the leading space of
950 some lines was was not entabbed. This happened in code which was adjusted
951 for vertical alignment and in hanging side comments. Thanks to Glenn.
953 - Fixed RT #127633, undesirable line break after return when -baao flag is set
955 - Fixed RT #127035, vertical alignment. Vertical alignment has been improved
956 in several ways. Thanks especially to Michael Wardman and Glenn for sending
959 - Alignment of the =~ operators has been reactivated.
962 $service_profile =~ s/^\s+|\s+$//g;
963 $host_profile =~ s/^\s+|\s+$//g;
966 $service_profile =~ s/^\s+|\s+$//g;
967 $host_profile =~ s/^\s+|\s+$//g;
969 - Alignment of the // operator has been reactivated.
972 is( pop // 7, 7, 'pop // ... works' );
973 is( pop() // 7, 0, 'pop() // ... works' );
974 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
977 is( pop // 7, 7, 'pop // ... works' );
978 is( pop() // 7, 0, 'pop() // ... works' );
979 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
981 - The rules for alignment of just two lines have been adjusted,
982 hopefully to be a little better overall. In some cases, two
983 lines which were previously unaligned are now aligned, and vice-versa.
986 $expect = "1$expect" if $expect =~ /^e/i;
987 $p = "1$p" if defined $p and $p =~ /^e/i;
990 $expect = "1$expect" if $expect =~ /^e/i;
991 $p = "1$p" if defined $p and $p =~ /^e/i;
994 - RT #106493; source code repository location has been added to docs; it is
995 https://github.com/perltidy/perltidy
997 - The packaging for this version has changed. The Tidy.pm module is much
998 smaller. Supporting modules have been split out from it and placed below
999 it in the path Perl/Tidy/*.
1001 - A number of new installation test cases have been added. Updates are now
1002 continuously tested at Travis CI against versions back to Perl 5.08.
1007 <pre><code>- RT #124469, #124494, perltidy often making empty files. The previous had
1008 an index error causing it to fail, particularly in version 5.18 of Perl.
1010 Please avoid version 20180219.
1015 <pre><code>- RT #79947, cuddled-else generalization. A new flag -cb provides
1016 'cuddled-else' type formatting for an arbitrary type of block chain. The
1017 default is try-catch-finally, but this can be modified with the
1020 - Fixed RT #124298: add space after ! operator without breaking !! secret
1023 - RT #123749: numerous minor improvements to the -wn flag were made.
1025 - Fixed a problem with convergence tests in which iterations were stopping
1028 - Here doc targets for <<~ type here-docs may now have leading whitespace.
1030 - Fixed RT #124354. The '-indent-only' flag was not working correctly in the
1031 previous release. A bug in version 20180101 caused extra blank lines
1034 - Issue RT #124114. Some improvements were made in vertical alignment
1035 involving 'fat commas'.
1040 <pre><code>- Added new flag -wn (--weld-nested-containers) which addresses these issues:
1041 RT #123749: Problem with promises;
1042 RT #119970: opening token stacking strange behavior;
1043 RT #81853: Can't stack block braces
1045 This option causes closely nested pairs of opening and closing containers
1046 to be "welded" together and essentially be formatted as a single unit,
1047 with just one level of indentation.
1049 Since this is a new flag it is set to be "off" by default but it has given
1050 excellent results in testing.
1052 EXAMPLE 1, multiple blocks, default formatting:
1055 next if $x == $y; # do something here
1057 } until $x++ > $z;
1062 } } until $x++ > $z;
1064 EXAMPLE 2, three levels of wrapped function calls, default formatting:
1068 translate( param('verb') ), param('tense'),
1076 translate( param('verb') ),
1077 param('tense'), param('person')
1080 # EXAMPLE 3, chained method calls, default formatting:
1081 get('http://mojolicious.org')->then(
1084 say $mojo->res->code;
1085 return get('http://metacpan.org');
1090 say $cpan->res->code;
1095 warn "Something went wrong: $err";
1100 get('http://mojolicious.org')->then( sub {
1102 say $mojo->res->code;
1103 return get('http://metacpan.org');
1106 say $cpan->res->code;
1107 } )->catch( sub {
1109 warn "Something went wrong: $err";
1113 - Fixed RT #114359: Missparsing of "print $x ** 0.5;
1115 - Deactivated the --check-syntax flag for better security. It will be
1118 - Corrected minimum perl version from 5.004 to 5.008 based on perlver
1119 report. The change is required for coding involving wide characters.
1121 - For certain severe errors, the source file will be copied directly to the
1122 output without formatting. These include ending in a quote, ending in a
1123 here doc, and encountering an unidentified character.
1128 <pre><code>- RT #123749, partial fix. "Continuation indentation" is removed from lines
1129 with leading closing parens which are part of a call chain.
1130 For example, the call to pack() is is now outdented to the starting
1131 indentation in the following experession:
1135 -text => "New Document",
1136 -command => \&new_document
1138 -side => 'bottom',
1144 -text => "New Document",
1145 -command => \&new_document
1147 -side => 'bottom',
1151 This modification improves readability of complex expressions, especially
1152 when the user uses the same value for continuation indentation (-ci=n) and
1153 normal indentation (-i=n). Perltidy was already programmed to
1154 do this but a minor bug was preventing it.
1156 - RT #123774, added flag to control space between a backslash and a single or
1157 double quote, requested by Robert Rothenberg. The issue is that lines like
1162 confuse syntax highlighters unless a space is left between the backslash and
1165 The new flag to control this is -sbq=n (--space-backslash-quote=n),
1166 where n=0 means no space, n=1 means follow existing code, n=2 means always
1167 space. The default is n=1, meaning that a space will be retained if there
1168 is one in the source code.
1170 - Fixed RT #123492, support added for indented here doc operator <<~ added
1171 in v5.26. Thanks to Chris Weyl for the report.
1173 - Fixed docs; --closing-side-comment-list-string should have been just
1174 --closing-side-comment-list. Thanks to F.Li.
1176 - Added patch RT #122030] Perl::Tidy sometimes does not call binmode.
1177 Thanks to Irilis Aelae.
1179 - Fixed RT #121959, PERLTIDY doesn't honor the 'three dot' notation for
1180 locating a config file using environment variables. Thanks to John
1183 - Minor improvements to formatting, in which some additional vertical
1184 aligmnemt is done. Thanks to Keith Neargarder.
1186 - RT #119588. Vertical alignment is no longer done for // operator.
1191 <pre><code>- Fixed debian #862667: failure to check for perltidy.ERR deletion can lead
1192 to overwriting arbitrary files by symlink attack. Perltidy was continuing
1193 to write files after an unlink failure. Thanks to Don Armstrong
1196 - Fixed RT #116344, perltidy fails on certain anonymous hash references:
1197 in the following code snippet the '?' was misparsed as a pattern
1198 delimiter rather than a ternary operator.
1199 return ref {} ? 1 : 0;
1201 - Fixed RT #113792: misparsing of a fat comma (=>) right after
1202 the __END__ or __DATA__ tokens. These keywords were getting
1203 incorrectly quoted by the following => operator.
1205 - Fixed RT #118558. Custom Getopt::Long configuration breaks parsing
1206 of perltidyrc. Perltidy was resetting the users configuration too soon.
1208 - Fixed RT #119140, failure to parse double diamond operator. Code to
1209 handle this new operator has been added.
1211 - Fixed RT #120968. Fixed problem where -enc=utf8 didn't work
1212 with --backup-and-modify-in-place. Thanks to Heinz Knutzen for this patch.
1214 - Fixed minor formatting issue where one-line blocks for subs with signatures
1215 were unnecessarily broken
1217 - RT #32905, patch to fix utf-8 error when output was STDOUT.
1219 - RT #79947, improved spacing of try/catch/finally blocks. Thanks to qsimpleq
1222 - Fixed #114909, Anonymous subs with signatures and prototypes misparsed as
1223 broken ternaries, in which a statement such as this was not being parsed
1225 return sub ( $fh, $out ) : prototype(*$) { ... }
1227 - Implemented RT #113689, option to introduces spaces after an opening block
1228 brace and before a closing block brace. Four new optional controls are
1229 added. The first two define the minimum number of blank lines to be
1232 -blao=i or --blank-lines-after-opening-block=i
1233 -blbc=i or --blank-lines-before-closing-block=i
1235 where i is an integer, the number of lines (the default is 0).
1237 The second two define the types of blocks to which the first two apply
1239 -blaol=s or --blank-lines-after-opening-block-list=s
1240 -blbcl=s or --blank-lines-before-closing-block-list=s
1242 where s is a string of possible block keywords (default is just 'sub',
1243 meaning a named subroutine).
1245 For more information please see the documentation.
1247 - The method for specifying block types for certain input parameters has
1248 been generalized to distinguish between normal named subroutines and
1249 anonymous subs. The keyword for normal subroutines remains 'sub', and
1250 the new keyword for anonymous subs is 'asub'.
1252 - Minor documentation changes. The BUGS sections now have a link
1253 to CPAN where most open bugs and issues can be reviewed and bug reports
1254 can be submitted. The information in the AUTHOR and CREDITS sections of
1255 the man pages have been removed from the man pages to streamline the
1256 documentation. This information is still in the source code.
1261 <pre><code>- RT #112534. Corrected a minor problem in which an unwanted newline
1262 was placed before the closing brace of an anonymous sub with
1263 a signature, if it was in a list. Thanks to Dmytro Zagashev.
1265 - Corrected a minor problem in which occasional extra indentation was
1266 given to the closing brace of an anonymous sub in a list when the -lp
1272 <pre><code> - RT #104427. Added support for signatures.
1274 - RT #111512. Changed global warning flag $^W = 1 to use warnings;
1275 Thanks to Dmytro Zagashev.
1277 - RT #110297, added support for new regexp modifier /n
1278 Thanks to Dmytro Zagashev.
1280 - RT #111519. The -io (--indent-only) and -dac (--delete-all-comments)
1281 can now both be used in one pass. Thanks to Dmitry Veltishev.
1283 - Patch to avoid error message with 'catch' used by TryCatch, as in
1287 Thanks to Nick Tonkin.
1289 - RT #32905, UTF-8 coding is now more robust. Thanks to qsimpleq
1290 and Dmytro for patches.
1292 - RT #106885. Added string bitwise operators ^. &. |. ~. ^.= &.= |.=
1294 - Fixed RT #107832 and #106492, lack of vertical alignment of two lines
1295 when -boc flag (break at old commas) is set. This bug was
1296 inadvertently introduced in previous bug fix RT #98902.
1298 - Some common extensions to Perl syntax are handled better.
1299 In particular, the following snippet is now foratted cleanly:
1301 method deposit( Num $amount) {
1302 $self->balance( $self->balance + $amount );
1305 A new flag -xs (--extended-syntax) was added to enable this, and the default
1308 In previous versions, and now only when -nxs is set, this snippet of code
1309 generates the following error message:
1311 "syntax error at ') {', didn't see one of: case elsif for foreach given if switch unless until when while"
1316 <pre><code> - Fixed RT# 105484, Invalid warning about 'else' in 'switch' statement. The
1317 warning happened if a 'case' statement did not use parens.
1319 - Fixed RT# 101547, misparse of // caused error message. Also..
1321 - Fixed RT# 102371, misparse of // caused unwated space in //=
1323 - Fixed RT# 100871, "silent failure of HTML Output on Windows".
1324 Changed calls to tempfile() from:
1325 my ( $fh_tmp, $tmpfile ) = tempfile();
1326 to have the full path name:
1327 my ( $fh_tmp, $tmpfile ) = File::Temp::tempfile()
1328 because of problems in the Windows version reported by Dean Pearce.
1330 - Fixed RT# 99514, calling the perltidy module multiple times with
1331 a .perltidyrc file containing the parameter --output-line-ending
1332 caused a crash. This was a glitch in the memoization logic.
1334 - Fixed RT#99961, multiple lines inside a cast block caused unwanted
1335 continuation indentation.
1337 - RT# 32905, broken handling of UTF-8 strings.
1338 A new flag -utf8 causes perltidy assume UTF-8 encoding for input and
1339 output of an io stream. Thanks to Sebastian Podjasek for a patch.
1340 This feature may not work correctly in older versions of Perl.
1341 It worked in a linux version 5.10.1 but not in a Windows version 5.8.3 (but
1342 otherwise perltidy ran correctly).
1344 - Warning files now report perltidy VERSION. Suggested by John Karr.
1346 - Fixed long flag --nostack-closing-tokens (-nsct has always worked though).
1347 This was due to a typo. This also fixed --nostack-opening-tokens to
1348 behave correctly. Thanks to Rob Dixon.
1353 <pre><code>- Fixed RT #94902: abbreviation parsing in .perltidyrc files was not
1354 working for multi-line abbreviations. Thanks to Eric Fung for
1357 - Fixed RT #95708, misparsing of a hash when the first key was a perl
1358 keyword, causing a semicolon to be incorrectly added.
1360 - Fixed RT #94338 for-loop in a parenthesized block-map. A code block within
1361 parentheses of a map, sort, or grep function was being mistokenized. In
1362 rare cases this could produce in an incorrect error message. The fix will
1363 produce some minor formatting changes. Thanks to Daniel Trizen
1364 discovering and documenting this.
1366 - Fixed RT #94354, excess indentation for stacked tokens. Thanks to
1367 Colin Williams for supplying a patch.
1369 - Added support for experimental postfix dereferencing notation introduced in
1370 perl 5.20. RT #96021.
1372 - Updated documentation to clarify the behavior of the -io flag
1373 in response to RT #95709. You can add -noll or -l=0 to prevent
1374 long comments from being outdented when -io is used.
1376 - Added a check to prevent a problem reported in RT #81866, where large
1377 scripts which had been compressed to a single line could not be formatted
1378 because of a check for VERSION for MakeMaker. The workaround was to
1379 use -nvpl, but this shouldn't be necessary now.
1381 - Fixed RT #96101; Closing brace of anonymous sub in a list was being
1382 indented. For example, the closing brace of the anonymous sub below
1383 will now be lined up with the word 'callback'. This problem
1384 occurred if there was no comma after the closing brace of the anonymous sub.
1385 This update may cause minor changes to formatting of code with lists
1386 of anonymous subs, especially TK code.
1393 path => '/_Operate/Transcode and split',
1394 callback => sub {
1395 return 1 if not $self->project_opened;
1396 $self->comp('project')->transcode( split => 1 );
1406 path => '/_Operate/Transcode and split',
1407 callback => sub {
1408 return 1 if not $self->project_opened;
1409 $self->comp('project')->transcode( split => 1 );
1417 <pre><code>- Fixed RT #94190 and debian Bug #742004: perltidy.LOG file left behind.
1418 Thanks to George Hartzell for debugging this. The problem was
1419 caused by the memoization speedup patch in version 20121207. An
1420 unwanted flag was being set which caused a LOG to be written if
1421 perltidy was called multiple times.
1423 - New default behavior for LOG files: If the source is from an array or
1424 string (through a call to the perltidy module) then a LOG output is only
1425 possible if a logfile stream is specified. This is to prevent
1426 unexpected perltidy.LOG files.
1428 - Fixed debian Bug #740670, insecure temporary file usage. File::Temp is now
1429 used to get a temporary file. Thanks to Don Anderson for a patch.
1431 - Any -b (--backup-and-modify-in-place) flag is silently ignored when a
1432 source stream, destination stream, or standard output is used.
1433 This is because the -b flag may have been in a .perltidyrc file and
1434 warnings break Test::NoWarnings. Thanks to Marijn Brand.
1439 <pre><code>- Fixed RT #88020. --converge was not working with wide characters.
1441 - Fixed RT #78156. package NAMESPACE VERSION syntax not accepted.
1443 - First attempt to fix RT #88588. INDEX END tag change in pod2html breaks
1444 perltidy -html. I put in a patch which should work but I don't yet have
1445 a way of testing it.
1450 <pre><code>- Fixed RT #87107, spelling
1455 <pre><code>- Fixed RT #87502, incorrect of parsing of smartmatch before hash brace
1457 - Added feature request RT #87330, trim whitespace after POD.
1458 The flag -trp (--trim-pod) will trim trailing whitespace from lines of POD
1463 <pre><code>- Fixed RT #86929, #86930, missing lhs of assignment.
1465 - Fixed RT #84922, moved pod from Tidy.pm into Tidy.pod
1470 <pre><code>- The flag -cab=n or --comma-arrow-breakpoints=n has been generalized
1471 to give better control over breaking open short containers. The
1472 possible values are now:
1474 n=0 break at all commas after =>
1475 n=1 stable: break at all commas after => if container is open,
1476 EXCEPT FOR one-line containers
1477 n=2 break at all commas after =>, BUT try to form the maximum
1478 maximum one-line container lengths
1479 n=3 do not treat commas after => specially at all
1480 n=4 break everything: like n=0 but also break a short container with
1481 a => not followed by a comma
1482 n=5 stable: like n=1 but ALSO break at open one-line containers (default)
1484 New values n=4 and n=5 have been added to allow short blocks to be
1485 broken open. The new default is n=5, stable. It should more closely
1486 follow the breaks in the input file, and previously formatted code
1487 should remain unchanged. If this causes problems use -cab=1 to recover
1488 the former behavior. Thanks to Tony Maszeroski for the suggestion.
1490 To illustrate the need for the new options, if perltidy is given
1491 the following code, then the old default (-cab=1) was to close up
1492 the 'index' container even if it was open in the source. The new
1493 default (-cab=5) will keep it open if it was open in the source.
1498 'key' => 'value',
1508 - New debug flag --memoize (-mem). This version contains a
1509 patch supplied by Jonathan Swartz which can significantly speed up
1510 repeated calls to Perl::Tidy::perltidy in a single process by caching
1511 the result of parsing the formatting parameters. A factor of up to 10
1512 speedup was achieved for masontidy (https://metacpan.org/module/masontidy).
1513 The memoization patch is on by default but can be deactivated for
1514 testing with -nmem (or --no-memoize).
1516 - New flag -tso (--tight-secret-operators) causes certain perl operator
1517 sequences (secret operators) to be formatted "tightly" (without spaces).
1518 The most common of these are 0 + and + 0 which become 0+ and +0. The
1519 operators currently modified by this flag are:
1520 =( )= 0+ +0 ()x!! ~~<> ,=>
1521 Suggested by by Philippe Bruhat. See https://metacpan.org/module/perlsecret
1522 This flag is off by default.
1524 - New flag -vmll (--variable-maximum-line-length) makes the maximum
1525 line length increase with the nesting depth of a line of code.
1526 Basically, it causes the length of leading whitespace to be ignored when
1527 setting line breaks, so the formatting of a block of code is independent
1528 of its nesting depth. Try this option if you have deeply nested
1529 code or data structures, perhaps in conjunction with the -wc flag
1530 described next. The default is not todo this.
1532 - New flag -wc=n (--whitespace-cycle=n) also addresses problems with
1533 very deeply nested code and data structures. When this parameter is
1534 used and the nesting depth exceeds the value n, the leading whitespace
1535 will be reduced and start at 1 again. The result is that deeply
1536 nested blocks of code will shift back to the left. This occurs cyclically
1537 to any nesting depth. This flag may be used either with or without -vmll.
1538 The default is not to use this (-wc=0).
1540 - Fixed RT #78764, error parsing smartmatch operator followed by anonymous
1541 hash or array and then a ternary operator; two examples:
1543 qr/3/ ~~ ['1234'] ? 1 : 0;
1544 map { $_ ~~ [ '0', '1' ] ? 'x' : 'o' } @a;
1546 - Fixed problem with specifying spaces around arrows using -wls='->'
1547 and -wrs='->'. Thanks to Alain Valleton for documenting this problem.
1549 - Implemented RT #53183, wishlist, lines of code with the same indentation
1550 level which are contained with multiple stacked opening and closing tokens
1551 (requested with flags -sot -sct) now have reduced indentation.
1554 $sender->MailMsg(
1557 subject => $subject,
1562 # OLD: perltidy -sot -sct
1563 $sender->MailMsg( {
1565 subject => $subject,
1569 # NEW: perltidy -sot -sct
1570 $sender->MailMsg( {
1572 subject => $subject,
1576 - New flag -act=n (--all-containers-tightness=n) is an abbreviation for
1577 -pt=n -sbt=n -bt=n -bbt=n, where n=0,1, or 2. It simplifies input when all
1578 containers have the same tightness. Using the same example:
1580 # NEW: perltidy -sot -sct -act=2
1581 $sender->MailMsg({
1583 subject => $subject,
1587 - New flag -sac (--stack-all-containers) is an abbreviation for -sot -sct
1588 This is part of wishlist item RT #53183. Using the same example again:
1590 # NEW: perltidy -sac -act=2
1591 $sender->MailMsg({
1593 subject => $subject,
1597 - new flag -scbb (--stack-closing-block-brace) causes isolated closing
1598 block braces to stack as in the following example. (Wishlist item RT#73788)
1605 push( @lines, "$w1 $w2 $w3 $w4\n" );
1616 push( @lines, "$w1 $w2 $w3 $w4\n" );
1619 There is, at present, no flag to place these closing braces at the end
1620 of the previous line. It seems difficult to develop good rules for
1621 doing this for a wide variety of code and data structures.
1623 - Parameters defining block types may use a wildcard '*' to indicate
1624 all block types. Previously it was not possible to include bare blocks.
1626 - A flag -sobb (--stack-opening-block-brace) has been introduced as an
1627 alias for -bbvt=2 -bbvtl='*'. So for example the following test code:
1629 {{{{{{{ $testing }}}}}}}
1631 cannot be formatted as above but can at least be kept vertically compact
1632 using perltidy -sobb -scbb
1634 { { { { { { { $testing
1637 Or even, perltidy -sobb -scbb -i=1 -bbt=2
1642 - Error message improved for conflicts due to -pbp; thanks to Djun Kim.
1644 - Fixed RT #80645, error parsing special array name '@$' when used as
1647 - Eliminated the -chk debug flag which was included in version 20010406 to
1648 do a one-time check for a bug with multi-line quotes. It has not been
1651 - Numerous other minor formatting improvements.
1656 <pre><code>- Added flag -iscl (--ignore-side-comment-lengths) which causes perltidy
1657 to ignore the length of side comments when setting line breaks,
1658 RT #71848. The default is to include the length of side comments when
1659 breaking lines to stay within the length prescribed by the -l=n
1660 maximum line length parameter. For example,
1662 Default behavior on a single line with long side comment:
1663 $vmsfile =~ s/;[\d\-]*$//
1664 ; # Clip off version number; we can use a newer version as well
1666 perltidy -iscl leaves the line intact:
1668 $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well
1670 - Fixed RT #78182, side effects with STDERR. Error handling has been
1671 revised and the documentation has been updated. STDERR can now be
1672 redirected to a string reference, and perltidy now returns an
1673 error flag instead of calling die when input errors are detected.
1674 If the error flag is set then no tidied output was produced.
1675 See man Perl::Tidy for an example.
1677 - Fixed RT #78156, erroneous warning message for package VERSION syntax.
1679 - Added abbreviations -conv (--converge) to simplify iteration control.
1680 -conv is equivalent to -it=4 and will insure that the tidied code is
1681 converged to its final state with the minimum number of iterations.
1683 - Minor formatting modifications have been made to insure convergence.
1685 - Simplified and hopefully improved the method for guessing the starting
1686 indentation level of entabbed code. Added flag -dt=n (--default_tabsize=n)
1687 which might be helpful if the guessing method does not work well for
1690 - Added support for stacked labels, upper case X/B in hex and binary, and
1693 - Eliminated warning messages for using keyword names as constants.
1698 <pre><code>- Corrected problem introduced by using a chomp on scalar references, RT #77978
1700 - Added support for Perl 5.14 package block syntax, RT #78114.
1702 - A convergence test is made if three or more iterations are requested with
1703 the -it=n parameter to avoid wasting computer time. Several hundred Mb of
1704 code gleaned from the internet were searched with the results that:
1705 - It is unusual for two iterations to be required unless a major
1706 style change is being made.
1707 - Only one case has been found where three iterations were required.
1708 - No cases requiring four iterations have been found with this version.
1709 For the previous version several cases where found the results could
1710 oscillate between two semi-stable states. This version corrects this.
1712 So if it is important that the code be converged it is okay to set -it=4
1713 with this version and it will probably stop after the second iteration.
1715 - Improved ability to identify and retain good line break points in the
1716 input stream, such as at commas and equals. You can always tell
1717 perltidy to ignore old breakpoints with -iob.
1719 - Fixed glitch in which a terminal closing hash brace followed by semicolon
1720 was not outdented back to the leading line depth like other closing
1721 tokens. Thanks to Keith Neargarder for noting this.
1724 my ( $pre, $post ) = @{
1726 "pp_anonlist" => [ "[", "]" ],
1727 "pp_anonhash" => [ "{", "}" ]
1728 }->{ $kid->ppaddr }
1732 my ( $pre, $post ) = @{
1734 "pp_anonlist" => [ "[", "]" ],
1735 "pp_anonhash" => [ "{", "}" ]
1736 }->{ $kid->ppaddr }
1739 - Removed extra indentation given to trailing 'if' and 'unless' clauses
1740 without parentheses because this occasionally produced undesirable
1741 results. This only applies where parens are not used after the if or
1746 unless my ( $who, $actions ) =
1747 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1751 unless my ( $who, $actions ) =
1752 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1757 <pre><code>- Updated perltidy to handle all quote modifiers defined for perl 5 version 16.
1759 - Side comment text in perltidyrc configuration files must now begin with
1760 at least one space before the #. Thus:
1763 -l=78 # Max line width is 78 cols
1765 -l=78# Max line width is 78 cols
1767 This is probably true of almost all existing perltidyrc files,
1768 but if you get an error message about bad parameters
1769 involving a '#' the first time you run this version, please check the side
1770 comments in your perltidyrc file, and add a space before the # if necessary.
1771 You can quickly see the contents your perltidyrc file, if any, with the
1776 The reason for this change is that some parameters naturally involve
1777 the # symbol, and this can get interpreted as a side comment unless the
1778 parameter is quoted. For example, to define -sphb=# it used to be necessary
1781 to keep the # from becoming part of a comment. This was causing
1782 trouble for new users. Now it can also be written without quotes:
1785 - Fixed bug in processing some .perltidyrc files containing parameters with
1786 an opening brace character, '{'. For example the following was
1787 incorrectly processed:
1788 --static-block-comment-prefix="^#{2,}[^\s#]"
1791 - Added flag -boa (--break-at-old-attribute-breakpoints) which retains
1792 any existing line breaks at attribute separation ':'. This is now the
1793 default, use -nboa to deactivate. Thanks to Daphne Phister for the patch.
1794 For example, given the following code, the line breaks at the ':'s will be
1800 : Get('Name' => 'foo') : Set('Name');
1802 whereas the previous version would have output a single line. If
1803 the attributes are on a single line then they will remain on a single line.
1805 - Added new flags --blank-lines-before-subs=n (-blbs=n) and
1806 --blank-lines-before-packages=n (-blbp=n) to put n blank lines before
1807 subs and packages. The old flag -bbs is now equivalent to -blbs=1 -blbp=1.
1808 and -nbbs is equivalent to -blbs=0 -blbp=0. Requested by M. Schwern and
1811 - Added feature -nsak='*' meaning no space between any keyword and opening
1812 paren. This avoids listing entering a long list of keywords. Requested
1815 - Added option to delete a backup of original file with in-place-modify (-b)
1816 if there were no errors. This can be requested with the flag -bext='/'.
1817 See documentation for details. Requested by M. Schwern and others.
1819 - Fixed bug where the module postfilter parameter was not applied when -b
1820 flag was used. This was discovered during testing.
1822 - Fixed in-place-modify (-b) to work with symbolic links to source files.
1823 Thanks to Ted Johnson.
1825 - Fixed bug where the Perl::Tidy module did not allow -b to be used
1828 - No extra blank line is added before a comment which follows
1829 a short line ending in an opening token, for example like this:
1833 # unless we follow a blank or comment line
1834 $last_line_leading_type !~ /^[#b]$/
1839 # unless we follow a blank or comment line
1840 $last_line_leading_type !~ /^[#b]$/
1843 The blank is not needed for readability in these cases because there
1844 already is already space above the comment. If a blank already
1845 exists there it will not be removed, so this change should not
1846 change code which has previously been formatted with perltidy.
1847 Thanks to R.W.Stauner.
1849 - Likewise, no extra blank line is added above a comment consisting of a
1850 single #, since nothing is gained in readability.
1852 - Fixed error in which a blank line was removed after a #>>> directive.
1853 Thanks to Ricky Morse.
1855 - Unnecessary semicolons after given/when/default blocks are now removed.
1857 - Fixed bug where an unwanted blank line could be added before
1858 pod text in __DATA__ or __END__ section. Thanks to jidani.
1860 - Changed exit flags from 1 to 0 to indicate success for -help, -version,
1861 and all -dump commands. Also added -? as another way to dump the help.
1862 Requested by Keith Neargarder.
1864 - Fixed bug where .ERR and .LOG files were not written except for -it=2 or more
1866 - Fixed bug where trailing blank lines at the end of a file were dropped when
1869 - Fixed bug where a line occasionally ended with an extra space. This reduces
1870 rhe number of instances where a second iteration gives a result different
1873 - Updated documentation to note that the Tidy.pm module <stderr> parameter may
1874 not be a reference to SCALAR or ARRAY; it must be a file.
1876 - Syntax check with perl now work when the Tidy.pm module is processing
1877 references to arrays and strings. Thanks to Charles Alderman.
1879 - Zero-length files are no longer processed due to concerns for data loss
1880 due to side effects in some scenarios.
1882 - block labels, if any, are now included in closing side comment text
1883 when the -csc flag is used. Suggested by Aaron. For example,
1884 the label L102 in the following block is now included in the -csc text:
1886 L102: for my $i ( 1 .. 10 ) {
1888 } ## end L102: for my $i ( 1 .. 10 )
1893 <pre><code>- added new flag -it=n or --iterations=n
1894 This flag causes perltidy to do n complete iterations.
1895 For most purposes the default of n=1 should be satisfactory. However n=2
1896 can be useful when a major style change is being made, or when code is being
1897 beautified on check-in to a source code control system. The run time will be
1898 approximately proportional to n, and it should seldom be necessary to use a
1899 value greater than n=2. Thanks to Jonathan Swartz
1901 - A configuration file pathname begins with three dots, e.g.
1902 ".../.perltidyrc", indicates that the file should be searched for starting
1903 in the current directory and working upwards. This makes it easier to have
1904 multiple projects each with their own .perltidyrc in their root directories.
1905 Thanks to Jonathan Swartz for this patch.
1907 - Added flag --notidy which disables all formatting and causes the input to be
1908 copied unchanged. This can be useful in conjunction with hierarchical
1909 F<.perltidyrc> files to prevent unwanted tidying.
1910 Thanks to Jonathan Swartz for this patch.
1912 - Added prefilters and postfilters in the call to the Tidy.pm module.
1913 Prefilters and postfilters. The prefilter is a code reference that
1914 will be applied to the source before tidying, and the postfilter
1915 is a code reference to the result before outputting.
1917 Thanks to Jonathan Swartz for this patch. He writes:
1918 This is useful for all manner of customizations. For example, I use
1919 it to convert the 'method' keyword to 'sub' so that perltidy will work for
1920 Method::Signature::Simple code:
1922 Perl::Tidy::perltidy(
1923 prefilter => sub { $_ = $_[0]; s/^method (.*)/sub $1 \#__METHOD/gm; return $_ },
1924 postfilter => sub { $_ = $_[0]; s/^sub (.*?)\s* \#__METHOD/method $1/gm; return $_ }
1927 - The starting indentation level of sections of code entabbed with -et=n
1928 is correctly guessed if it was also produced with the same -et=n flag. This
1929 keeps the indentation stable on repeated formatting passes within an editor.
1930 Thanks to Sam Kington and Glenn.
1932 - Functions with prototype '&' had a space between the function and opening
1933 peren. This space now only occurs if the flag --space-function-paren (-sfp)
1934 is set. Thanks to Zrajm Akfohg.
1936 - Patch to never put spaces around a bare word in braces beginning with ^ as in:
1937 my $before = ${^PREMATCH};
1938 even if requested with the -bt=0 flag because any spaces cause a syntax error in perl.
1939 Thanks to Fabrice Dulanoy.
1944 <pre><code>- Allow configuration file to be 'perltidy.ini' for Windows systems.
1945 i.e. C:\Documents and Settings\User\perltidy.ini
1946 and added documentation for setting configuation file under Windows in man
1947 page. Thanks to Stuart Clark.
1949 - Corrected problem of unwanted semicolons in hash ref within given/when code.
1950 Thanks to Nelo Onyiah.
1952 - added new flag -cscb or --closing-side-comments-balanced
1953 When using closing-side-comments, and the closing-side-comment-maximum-text
1954 limit is exceeded, then the comment text must be truncated. Previous
1955 versions of perltidy terminate with three dots, and this can still be
1956 achieved with -ncscb:
1958 perltidy -csc -ncscb
1960 } ## end foreach my $foo (sort { $b cmp $a ...
1962 However this causes a problem with older editors which cannot recognize
1963 comments or are not configured to doso because they cannot "bounce" around in
1964 the text correctly. The B<-cscb> flag tries to help them by
1965 appending appropriate terminal balancing structure:
1969 } ## end foreach my $foo (sort { $b cmp $a ... })
1971 Since there is much to be gained and little to be lost by doing this,
1972 the default is B<-cscb>. Use B<-ncscb> if you do not want this.
1974 Thanks to Daniel Becker for suggesting this option.
1976 - After an isolated closing eval block the continuation indentation will be
1977 removed so that the braces line up more like other blocks. Thanks to Yves Orton.
1996 -A new flag -asbl (or --opening-anonymous-sub-brace-on-new-line) has
1997 been added to put the opening brace of anonymous sub's on a new line,
1998 as in the following snippet:
2003 return $arg->(@_);
2006 This was not possible before because the -sbl flag only applies to named
2007 subs. Thanks to Benjamin Krupp.
2009 -Fix tokenization bug with the following snippet
2010 print 'hi' if { x => 1, }->{x};
2011 which resulted in a semicolon being added after the comma. The workaround
2012 was to use -nasc, but this is no longer necessary. Thanks to Brian Duggan.
2014 -Fixed problem in which an incorrect error message could be triggered
2015 by the (unusual) combination of parameters -lp -i=0 -l=2 -ci=0 for
2016 example. Thanks to Richard Jelinek.
2018 -A new flag --keep-old-blank-lines=n has been added to
2019 give more control over the treatment of old blank lines in
2020 a script. The manual has been revised to discuss the new
2021 flag and clarify the treatment of old blank lines. Thanks
2027 <pre><code>-Improved support for perl 5.10: New quote modifier 'p', new block type UNITCHECK,
2028 new keyword break, improved formatting of given/when.
2030 -Corrected tokenization bug of something like $var{-q}.
2032 -Numerous minor formatting improvements.
2034 -Corrected list of operators controlled by -baao -bbao to include
2035 . : ? && || and or err xor
2037 -Corrected very minor error in log file involving incorrect comment
2038 regarding need for upper case of labels.
2040 -Fixed problem where perltidy could run for a very long time
2041 when given certain non-perl text files.
2043 -Line breaks in un-parenthesized lists now try to follow
2044 line breaks in the input file rather than trying to fill
2045 lines. This usually works better, but if this causes
2046 trouble you can use -iob to ignore any old line breaks.
2047 Example for the following input snippet:
2050 "conformability (Not the same dimension)\n",
2051 "\t", $have, " is ", text_unit($hu), "\n",
2052 "\t", $want, " is ", text_unit($wu), "\n",
2056 print "conformability (Not the same dimension)\n", "\t", $have, " is ",
2057 text_unit($hu), "\n", "\t", $want, " is ", text_unit($wu), "\n",;
2060 print "conformability (Not the same dimension)\n",
2061 "\t", $have, " is ", text_unit($hu), "\n",
2062 "\t", $want, " is ", text_unit($wu), "\n",
2068 <pre><code>-Added -fpsc option (--fixed-position-side-comment). Thanks to Ueli Hugenschmidt.
2069 For example -fpsc=40 tells perltidy to put side comments in column 40
2072 -Added -bbao and -baao options (--break-before-all-operators and
2073 --break-after-all-operators) to simplify command lines and configuration
2074 files. These define an initial preference for breaking at operators which can
2075 be modified with -wba and -wbb flags. For example to break before all operators
2076 except an = one could use --bbao -wba='=' rather than listing every
2077 single perl operator (except =) on a -wbb flag.
2079 -Added -kis option (--keep-interior-semicolons). Use the B<-kis> flag
2080 to prevent breaking at a semicolon if there was no break there in the
2081 input file. To illustrate, consider the following input lines:
2083 dbmclose(%verb_delim); undef %verb_delim;
2084 dbmclose(%expanded); undef %expanded;
2085 dbmclose(%global); undef %global;
2087 Normally these would be broken into six lines, but
2088 perltidy -kis gives:
2090 dbmclose(%verb_delim); undef %verb_delim;
2091 dbmclose(%expanded); undef %expanded;
2092 dbmclose(%global); undef %global;
2094 -Improved formatting of complex ternary statements, with indentation
2095 of nested statements.
2097 return defined( $cw->{Selected} )
2099 ? @{ $cw->{Selected} }
2100 : $cw->{Selected}[0]
2104 return defined( $cw->{Selected} )
2106 ? @{ $cw->{Selected} }
2107 : $cw->{Selected}[0]
2110 -Text following un-parenthesized if/unless/while/until statements get a
2111 full level of indentation. Suggested by Jeff Armstrong and others.
2113 return $ship->chargeWeapons("phaser-canon")
2114 if $encounter->description eq 'klingon'
2115 and $ship->firepower >= $encounter->firepower
2116 and $location->status ne 'neutral';
2118 return $ship->chargeWeapons("phaser-canon")
2119 if $encounter->description eq 'klingon'
2120 and $ship->firepower >= $encounter->firepower
2121 and $location->status ne 'neutral';
2126 <pre><code>-Fixed bug where #line directives were being indented. Thanks to
2132 <pre><code>-Fixed problem where an extra blank line was added after an =cut when either
2133 (a) the =cut started (not stopped) a POD section, or (b) -mbl > 1.
2134 Thanks to J. Robert Ray and Bill Moseley.
2139 <pre><code>-ole (--output-line-ending) and -ple (--preserve-line-endings) should
2140 now work on all systems rather than just unix systems. Thanks to Dan
2143 -Fixed problem of a warning issued for multiple subs for BEGIN subs
2144 and other control subs. Thanks to Heiko Eissfeldt.
2146 -Fixed problem where no space was introduced between a keyword or
2147 bareword and a colon, such as:
2149 ( ref($result) eq 'HASH' && !%$result ) ? undef: $result;
2153 -Added a utility program 'break_long_quotes.pl' to the examples directory of
2154 the distribution. It breaks long quoted strings into a chain of concatenated
2155 sub strings no longer than a selected length. Suggested by Michael Renner as
2156 a perltidy feature but was judged to be best done in a separate program.
2158 -Updated docs to remove extra < and >= from list of tokens
2159 after which breaks are made by default. Thanks to Bob Kleemann.
2161 -Removed improper uses of $_ to avoid conflicts with external calls, giving
2162 error message similar to:
2163 Modification of a read-only value attempted at
2164 /usr/share/perl5/Perl/Tidy.pm line 6907.
2165 Thanks to Michael Renner.
2167 -Fixed problem when errorfile was not a plain filename or filehandle
2168 in a call to Tidy.pm. The call
2169 perltidy(source => \$input, destination => \$output, errorfile => \$err);
2170 gave the following error message:
2171 Not a GLOB reference at /usr/share/perl5/Perl/Tidy.pm line 3827.
2172 Thanks to Michael Renner and Phillipe Bruhat.
2174 -Fixed problem where -sot would not stack an opening token followed by
2175 a side comment. Thanks to Jens Schicke.
2177 -improved breakpoints in complex math and other long statements. Example:
2180 log($n) + 0.577215664901532 + ( 1 / ( 2 * $n ) ) -
2181 ( 1 / ( 12 * ( $n**2 ) ) ) + ( 1 / ( 120 * ( $n**4 ) ) );
2184 log($n) + 0.577215664901532 +
2185 ( 1 / ( 2 * $n ) ) -
2186 ( 1 / ( 12 * ( $n**2 ) ) ) +
2187 ( 1 / ( 120 * ( $n**4 ) ) );
2189 -more robust vertical alignment of complex terminal else blocks and ternary
2195 <pre><code>-Eliminated bug where a here-doc invoked through an 'e' modifier on a pattern
2196 replacement text was not recognized. The tokenizer now recursively scans
2197 replacement text (but does not reformat it).
2199 -improved vertical alignment of terminal else blocks and ternary statements.
2200 Thanks to Chris for the suggestion.
2203 if ( IsBitmap() ) { return GetBitmap(); }
2204 elsif ( IsFiles() ) { return GetFiles(); }
2205 else { return GetText(); }
2208 if ( IsBitmap() ) { return GetBitmap(); }
2209 elsif ( IsFiles() ) { return GetFiles(); }
2210 else { return GetText(); }
2214 $opts{"t"} ? 'title'
2215 : $opts{"s"} ? 'subject'
2216 : $opts{"a"} ? 'author'
2221 $opts{"t"} ? 'title'
2222 : $opts{"s"} ? 'subject'
2223 : $opts{"a"} ? 'author'
2226 -improved indentation of try/catch blocks and other externally defined
2227 functions accepting a block argument. Thanks to jae.
2229 -Added support for Perl 5.10 features say and smartmatch.
2231 -Added flag -pbp (--perl-best-practices) as an abbreviation for parameters
2232 suggested in Damian Conway's "Perl Best Practices". -pbp is the same as:
2234 -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
2235 -wbb="% + - * / x != == >= <= =~ !~ < > | & >= < =
2236 **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
2238 Please note that the -st here restricts input to standard input; use
2239 -nst if necessary to override.
2241 -Eliminated some needless breaks at equals signs in -lp indentation.
2245 Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
2246 TOP + $y * (BOTTOM - TOP) / SIZE);
2248 $c = Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
2249 TOP + $y * (BOTTOM - TOP) / SIZE);
2251 A break at an equals is sometimes useful for preventing complex statements
2252 from hitting the line length limit. The decision to do this was
2253 over-eager in some cases and has been improved. Thanks to Royce Reece.
2255 -qw quotes contained in braces, square brackets, and parens are being
2256 treated more like those containers as far as stacking of tokens. Also
2257 stack of closing tokens ending ');' will outdent to where the ');' would
2258 have outdented if the closing stack is matched with a similar opening stack.
2260 OLD: perltidy -soc -sct
2261 __PACKAGE__->load_components(
2267 NEW: perltidy -soc -sct
2268 __PACKAGE__->load_components( qw(
2272 Thanks to Aran Deltac
2274 -Eliminated some undesirable or marginally desirable vertical alignments.
2275 These include terminal colons, opening braces, and equals, and particularly
2276 when just two lines would be aligned.
2279 my $accurate_timestamps = $Stamps{lnk};
2283 my $accurate_timestamps = $Stamps{lnk};
2286 -Corrected a problem with -mangle in which a space would be removed
2287 between a keyword and variable beginning with ::.
2292 <pre><code>-Attribute argument lists are now correctly treated as quoted strings
2293 and not formatted. This is the most important update in this version.
2294 Thanks to Borris Zentner, Greg Ferguson, Steve Kirkup.
2296 -Updated to recognize the defined or operator, //, to be released in Perl 10.
2297 Thanks to Sebastien Aperghis-Tramoni.
2299 -A useful utility perltidyrc_dump.pl is included in the examples section. It
2300 will read any perltidyrc file and write it back out in a standard format
2301 (though comments are lost).
2303 -Added option to have perltidy read and return a hash with the contents of a
2304 perltidyrc file. This may be used by Leif Eriksen's tidyview code. This
2305 feature is used by the demonstration program 'perltidyrc_dump.pl' in the
2308 -Improved error checking in perltidyrc files. Unknown bare words were not
2311 -The --dump-options parameter now dumps parameters in the format required by a
2314 -V-Strings with underscores are now recognized.
2315 For example: $v = v1.2_3;
2317 -cti=3 option added which gives one extra indentation level to closing
2318 tokens always. This provides more predictable closing token placement
2319 than cti=2. If you are using cti=2 you might want to try cti=3.
2321 -To identify all left-adjusted comments as static block comments, use C<-sbcp='^#'>.
2323 -New parameters -fs, -fsb, -fse added to allow sections of code between #<<<
2324 and #>>> to be passed through verbatim. This is enabled by default and turned
2325 off by -nfs. Flags -fsb and -fse allow other beginning and ending markers.
2326 Thanks to Wolfgang Werner and Marion Berryman for suggesting this.
2328 -added flag -skp to put a space between all Perl keywords and following paren.
2329 The default is to only do this for certain keywords. Suggested by
2332 -added flag -sfp to put a space between a function name and following paren.
2333 The default is not to do this. Suggested by H.Merijn Brand.
2335 -Added patch to avoid breaking GetOpt::Long::Configure set by calling program.
2336 Thanks to Philippe Bruhat.
2338 -An error was fixed in which certain parameters in a .perltidyrc file given
2339 without the equals sign were not recognized. That is,
2340 '--brace-tightness 0' gave an error but '--brace-tightness=0' worked
2341 ok. Thanks to Zac Hansen.
2343 -An error preventing the -nwrs flag from working was corrected. Thanks to
2346 -Corrected some alignment problems with entab option.
2348 -A bug with the combination of -lp and -extrude was fixed (though this
2349 combination doesn't really make sense). The bug was that a line with
2350 a single zero would be dropped. Thanks to Cameron Hayne.
2352 -Updated Windows detection code to avoid an undefined variable.
2353 Thanks to Joe Yates and Russ Jones.
2355 -Improved formatting for short trailing statements following a closing paren.
2356 Thanks to Joe Matarazzo.
2358 -The handling of the -icb (indent closing block braces) flag has been changed
2359 slightly to provide more consistent and predictable formatting of complex
2360 structures. Instead of giving a closing block brace the indentation of the
2361 previous line, it is now given one extra indentation level. The two methods
2362 give the same result if the previous line was a complete statement, as in this
2371 The change also fixes a problem with empty blocks such as:
2381 -A problem with -icb was fixed in which a closing brace was misplaced when
2382 it followed a quote which spanned multiple lines.
2384 -Some improved breakpoints for -wba='&& || and or'
2386 -Fixed problem with misaligned cuddled else in complex statements
2387 when the -bar flag was also used. Thanks to Alex and Royce Reese.
2389 -Corrected documentation to show that --outdent-long-comments is the default.
2390 Thanks to Mario Lia.
2392 -New flag -otr (opening-token-right) is similar to -bar (braces-always-right)
2393 but applies to non-structural opening tokens.
2395 -new flags -sot (stack-opening-token), -sct (stack-closing-token).
2401 <pre><code>-The default has been changed to not do syntax checking with perl.
2402 Use -syn if you want it. Perltidy is very robust now, and the -syn
2403 flag now causes more problems than it's worth because of BEGIN blocks
2404 (which get executed with perl -c). For example, perltidy will never
2405 return when trying to beautify this code if -syn is used:
2407 BEGIN { 1 while { }; }
2409 Although this is an obvious error, perltidy is often run on untested
2410 code which is more likely to have this sort of problem. A more subtle
2413 BEGIN { use FindBin; }
2415 which may hang on some systems using -syn if a shared file system is
2418 -Changed style -gnu to use -cti=1 instead of -cti=2 (see next item).
2419 In most cases it looks better. To recover the previous format, use
2422 -Added flags -cti=n for finer control of closing token indentation.
2423 -cti = 0 no extra indentation (default; same as -nicp)
2424 -cti = 1 enough indentation so that the closing token
2425 aligns with its opening token.
2426 -cti = 2 one extra indentation level if the line has the form
2427 ); ]; or }; (same as -icp).
2429 The new option -cti=1 works well with -lp:
2433 # perltidy -lp -cti=1
2435 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2436 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2439 # perltidy -lp -cti=2
2441 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2442 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2444 This is backwards compatible with -icp. See revised manual for
2445 details. Suggested by Mike Pennington.
2447 -Added flag '--preserve-line-endings' or '-ple' to cause the output
2448 line ending to be the same as in the input file, for unix, dos,
2449 or mac line endings. Only works under unix. Suggested by
2452 -Added flag '--output-line-ending=s' or '-ole=s' where s=dos or win,
2453 unix, or mac. Only works under unix.
2455 -Files with Mac line endings should now be handled properly under unix
2456 and dos without being passed through a converter.
2458 -You may now include 'and', 'or', and 'xor' in the list following
2459 '--want-break-after' to get line breaks after those keywords rather than
2460 before them. Suggested by Rainer Hochschild.
2462 -Corrected problem with command line option for -vtc=n and -vt=n. The
2463 equals sign was being eaten up by the Windows shell so perltidy didn't
2469 <pre><code>-Corrected cause of warning message with recent versions of Perl:
2470 "Possible precedence problem on bitwise & operator at ..."
2471 Thanks to Jim Files.
2473 -fixed bug with -html with '=for pod2html' sections, in which code/pod
2474 output order was incorrect. Thanks to Tassilo von Parseval.
2476 -fixed bug when the -html flag is used, in which the following error
2477 message, plus others, appear:
2478 did not see <body> in pod2html output
2479 This was caused by a change in the format of html output by pod2html
2480 VERSION 1.04 (included with perl 5.8). Thanks to Tassilo von Parseval.
2482 -Fixed bug where an __END__ statement would be mistaken for a label
2483 if it is immediately followed by a line with a leading colon. Thanks
2486 -Implemented guessing logic for brace types when it is ambiguous. This
2487 has been on the TODO list a long time. Thanks to Boris Zentner for
2490 -Long options may now be negated either as '--nolong-option'
2491 or '--no-long-option'. Thanks to Philip Newton for the suggestion.
2493 -added flag --html-entities or -hent which controls the use of
2494 Html::Entities for html formatting. Use --nohtml-entities or -nhent to
2495 prevent the use of Html::Entities to encode special symbols. The
2496 default is -hent. Html::Entities when formatting perl text to escape
2497 special symbols. This may or may not be the right thing to do,
2498 depending on browser/language combinations. Thanks to Burak Gursoy for
2501 -Bareword strings with leading '-', like, '-foo' now count as 1 token
2502 for horizontal tightness. This way $a{'-foo'}, $a{foo}, and $a{-foo}
2503 are now all treated similarly. Thus, by default, OLD: $a{ -foo } will
2504 now be NEW: $a{-foo}. Suggested by Mark Olesen.
2506 -added 2 new flags to control spaces between keywords and opening parens:
2507 -sak=s or --space-after-keyword=s, and
2508 -nsak=s or --nospace-after-keyword=s, where 's' is a list of keywords.
2510 The new default list of keywords which get a space is:
2512 "my local our and or eq ne if else elsif until unless while for foreach
2513 return switch case given when"
2515 Use -sak=s and -nsak=s to add and remove keywords from this list,
2518 Explanation: Stephen Hildrey noted that perltidy was being inconsistent
2519 in placing spaces between keywords and opening parens, and sent a patch
2520 to give user control over this. The above list was selected as being
2521 a reasonable default keyword list. Previously, perltidy
2522 had a hardwired list which also included these keywords:
2524 push pop shift unshift join split die
2526 but did not have 'our'. Example: if you prefer to make perltidy behave
2527 exactly as before, you can include the following two lines in your
2530 -sak="push pop local shift unshift join split die"
2533 -Corrected html error in .toc file when -frm -html is used (extra ");
2534 browsers were tolerant of it.
2536 -Improved alignment of chains of binary and ?/: operators. Example:
2550 -improved breakpoint choices involving '->'
2552 -Corrected tokenization of things like ${#}. For example,
2553 ${#} is valid, but ${# } is a syntax error.
2555 -Corrected minor tokenization errors with indirect object notation.
2556 For example, 'new A::()' works now.
2558 -Minor tokenization improvements; all perl code distributed with perl 5.8
2559 seems to be parsed correctly except for one instance (lextest.t)
2565 <pre><code>-Implemented scalar attributes. Thanks to Sean Tobin for noting this.
2567 -Fixed glitch introduced in previous release where -pre option
2568 was not outputting a leading html <pre> tag.
2570 -Numerous minor improvements in vertical alignment, including the following:
2572 -Improved alignment of opening braces in many cases. Needed for improved
2573 switch/case formatting, and also suggested by Mark Olesen for sort/map/grep
2574 formatting. For example:
2579 sort { $a->[1] <=> $b->[1] }
2580 map { [ $_, -M ] } @filenames;
2585 sort { $a->[1] <=> $b->[1] }
2586 map { [ $_, -M ] } @filenames;
2588 -Eliminated alignments across unrelated statements. Example:
2590 $borrowerinfo->configure( -state => 'disabled' );
2591 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
2594 $borrowerinfo->configure( -state => 'disabled' );
2595 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
2597 Thanks to Mark Olesen for suggesting this.
2599 -Improved alignement of '='s in certain cases.
2600 Thanks to Norbert Gruener for sending an example.
2602 -Outdent-long-comments (-olc) has been re-instated as a default, since
2603 it works much better now. Use -nolc if you want to prevent it.
2605 -Added check for 'perltidy file.pl -o file.pl', which causes file.pl
2606 to be lost. (The -b option should be used instead). Thanks to mreister
2607 for reporting this problem.
2612 <pre><code>-Switch/case or given/when syntax is now recognized. Its vertical alignment
2613 is not great yet, but it parses ok. The words 'switch', 'case', 'given',
2614 and 'when' are now treated as keywords. If this causes trouble with older
2615 code, we could introduce a switch to deactivate it. Thanks to Stan Brown
2616 and Jochen Schneider for recommending this.
2618 -Corrected error parsing sub attributes with call parameters.
2619 Thanks to Marc Kerr for catching this.
2621 -Sub prototypes no longer need to be on the same line as sub names.
2623 -a new flag -frm or --frames will cause html output to be in a
2624 frame, with table of contents in the left panel and formatted source
2625 in the right panel. Try 'perltidy -html -frm somemodule.pm' for example.
2627 -The new default for -html formatting is to pass the pod through Pod::Html.
2628 The result is syntax colored code within your pod documents. This can be
2629 deactivated with -npod. Thanks to those who have written to discuss this,
2630 particularly Mark Olesen and Hugh Myers.
2632 -the -olc (--outdent-long-comments) option works much better. It now outdents
2633 groups of consecutive comments together, and by just the amount needed to
2634 avoid having any one line exceeding the maximum line length.
2636 -block comments are now trimmed of trailing whitespace.
2638 -if a directory specified with -opath does not exist, it will be created.
2640 -a table of contents to packages and subs is output when -html is used.
2641 Use -ntoc to prevent this.
2643 -fixed an unusual bug in which a 'for' statement following a 'format'
2644 statement was not correctly tokenized. Thanks to Boris Zentner for
2647 -Tidy.pm is no longer dependent on modules IO::Scalar and IO::ScalarArray.
2648 There were some speed issues. Suggested by Joerg Walter.
2650 -The treatment of quoted wildcards (file globs) is now system-independent.
2653 perltidy 'b*x.p[lm]'
2655 would match box.pl, box.pm, brinx.pm under any operating system. Of
2656 course, anything unquoted will be subject to expansion by any shell.
2658 -default color for keywords under -html changed from
2659 SaddleBrown (#8B4513) to magenta4 (#8B008B).
2661 -fixed an arg parsing glitch in which something like:
2663 would trigger the help message and exit, rather than operate on the
2669 <pre><code>-New option '-b' or '--backup-and-modify-in-place' will cause perltidy to
2670 overwrite the original file with the tidied output file. The original
2671 file will be saved with a '.bak' extension (which can be changed with
2672 -bext=s). Thanks to Rudi Farkas for the suggestion.
2674 -An index to all subs is included at the top of -html output, unless
2675 only the <pre> section is written.
2677 -Anchor lines of the form <a name="mysub"></a> are now inserted at key points
2678 in html output, such as before sub definitions, for the convenience of
2679 postprocessing scripts. Suggested by Howard Owen.
2681 -The cuddled-else (-ce) flag now also makes cuddled continues, like
2684 while ( ( $pack, $file, $line ) = caller( $i++ ) ) {
2690 Suggested by Simon Perreault.
2692 -Fixed bug in which an extra blank line was added before an =head or
2693 similar pod line after an __END__ or __DATA__ line each time
2694 perltidy was run. Also, an extra blank was being added after
2695 a terminal =cut. Thanks to Mike Birdsall for reporting this.
2700 <pre><code>-Fixed bug in which space was inserted in a hyphenated hash key:
2701 my $val = $myhash{USER-NAME};
2703 my $val = $myhash{USER -NAME};
2704 Thanks to an anonymous bug reporter at sourceforge.
2706 -Fixed problem with the '-io' ('--indent-only') where all lines
2707 were double spaced. Thanks to Nick Andrew for reporting this bug.
2709 -Fixed tokenization error in which something like '-e1' was
2712 -Corrected a rare problem involving older perl versions, in which
2713 a line break before a bareword caused problems with 'use strict'.
2714 Thanks to Wolfgang Weisselberg for noting this.
2716 -More syntax error checking added.
2718 -Outdenting labels (-ola) has been made the default, in order to follow the
2719 perlstyle guidelines better. It's probably a good idea in general, but
2720 if you do not want this, use -nola in your .perltidyrc file.
2722 -Updated rules for padding logical expressions to include more cases.
2723 Thanks to Wolfgang Weisselberg for helpful discussions.
2725 -Added new flag -osbc (--outdent-static-block-comments) which will
2726 outdent static block comments by 2 spaces (or whatever -ci equals).
2727 Requested by Jon Robison.
2732 <pre><code>-Corrected a bug, introduced in the previous release, in which some
2733 closing side comments (-csc) could have incorrect text. This is
2734 annoying but will be correct the next time perltidy is run with -csc.
2736 -Fixed bug where whitespace was being removed between 'Bar' and '()'
2737 in a use statement like:
2741 -Whenever possible, if a logical expression is broken with leading
2742 '&&', '||', 'and', or 'or', then the leading line will be padded
2743 with additional space to produce alignment. This has been on the
2744 todo list for a long time; thanks to Frank Steinhauer for reminding
2745 me to do it. Notice the first line after the open parens here:
2749 !param("rules.to.$linecount")
2750 && !param("rules.from.$linecount")
2751 && !param("rules.subject.$linecount")
2753 param("rules.fieldname.$linecount")
2754 && param("rules.fieldval.$linecount")
2756 && !param("rules.size.$linecount")
2757 && !param("rules.custom.$linecount")
2762 !param("rules.to.$linecount")
2763 && !param("rules.from.$linecount")
2764 && !param("rules.subject.$linecount")
2766 param("rules.fieldname.$linecount")
2767 && param("rules.fieldval.$linecount")
2769 && !param("rules.size.$linecount")
2770 && !param("rules.custom.$linecount")
2776 <pre><code>-Corrected a mistokenization of variables for a package with a name
2777 equal to a perl keyword. For example:
2781 sub qx{print "Hello from my::qx\n";}
2783 In this case, the leading 'my' was mistokenized as a keyword, and a
2784 space was being place between 'my' and '::'. This has been
2785 corrected. Thanks to Martin Sluka for discovering this.
2787 -A new flag -bol (--break-at-old-logic-breakpoints)
2788 has been added to control whether containers with logical expressions
2789 should be broken open. This is the default.
2791 -A new flag -bok (--break-at-old-keyword-breakpoints)
2792 has been added to follow breaks at old keywords which return lists,
2793 such as sort and map. This is the default.
2795 -A new flag -bot (--break-at-old-trinary-breakpoints) has been added to
2796 follow breaks at trinary (conditional) operators. This is the default.
2798 -A new flag -cab=n has been added to control breaks at commas after
2799 '=>' tokens. The default is n=1, meaning break unless this breaks
2800 open an existing on-line container.
2802 -A new flag -boc has been added to allow existing list formatting
2803 to be retained. (--break-at-old-comma-breakpoints). See updated manual.
2805 -A new flag -iob (--ignore-old-breakpoints) has been added to
2806 prevent the locations of old breakpoints from influencing the output
2809 -Corrected problem where nested parentheses were not getting full
2810 indentation. This has been on the todo list for some time; thanks
2811 to Axel Rose for a snippet demonstrating this issue.
2813 OLD: inner list is not indented
2814 $this->sendnumeric(
2817 $ret->name, $user->username, $user->host,
2818 $user->server->name, $user->nick, "H"
2823 $this->sendnumeric(
2826 $ret->name, $user->username, $user->host,
2827 $user->server->name, $user->nick, "H"
2831 -Code cleaned up by removing the following unused, undocumented flags.
2832 They should not be in any .perltidyrc files because they were just
2833 experimental flags which were never documented. Most of them placed
2834 artificial limits on spaces, and Wolfgang Weisselberg convinced me that
2835 most of them they do more harm than good by causing unexpected results.
2837 --maximum-continuation-indentation (-mci)
2838 --maximum-whitespace-columns
2839 --maximum-space-to-comment (-xsc)
2840 --big-space-jump (-bsj)
2842 -Pod file 'perltidy.pod' has been appended to the script 'perltidy', and
2843 Tidy.pod has been append to the module 'Tidy.pm'. Older MakeMaker's
2844 were having trouble.
2846 -A new flag -isbc has been added for more control on comments. This flag
2847 has the effect that if there is no leading space on the line, then the
2848 comment will not be indented, and otherwise it may be. If both -ibc and
2849 -isbc are set, then -isbc takes priority. Thanks to Frank Steinhauer
2850 for suggesting this.
2852 -A new document 'stylekey.pod' has been created to quickly guide new users
2853 through the maze of perltidy style parameters. An html version is
2854 on the perltidy web page. Take a look! It should be very helpful.
2856 -Parameters for controlling 'vertical tightness' have been added:
2857 -vt and -vtc are the main controls, but finer control is provided
2858 with -pvt, -pcvt, -bvt, -bcvt, -sbvt, -sbcvt. Block brace vertical
2859 tightness controls have also been added.
2860 See updated manual and also see 'stylekey.pod'. Simple examples:
2862 # perltidy -lp -vt=1 -vtc=1
2863 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2864 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
2866 # perltidy -lp -vt=1 -vtc=0
2867 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2868 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2871 -Lists which do not format well in uniform columns are now better
2872 identified and formated.
2875 return $c->create( 'polygon', $x, $y, $x + $ruler_info{'size'},
2876 $y + $ruler_info{'size'}, $x - $ruler_info{'size'},
2877 $y + $ruler_info{'size'} );
2880 return $c->create(
2882 $x + $ruler_info{'size'},
2883 $y + $ruler_info{'size'},
2884 $x - $ruler_info{'size'},
2885 $y + $ruler_info{'size'}
2889 radlablist($f1, pad('Initial', $p), $b->{Init}->get_panel_ref, 'None ',
2890 'None', 'Default', 'Default', 'Simple', 'Simple');
2894 $b->{Init}->get_panel_ref,
2895 'None ', 'None', 'Default', 'Default', 'Simple', 'Simple');
2897 -Corrected problem where an incorrect html filename was generated for
2898 external calls to Tidy.pm module. Fixed incorrect html title when
2899 Tidy.pm is called with IO::Scalar or IO::Array source.
2901 -Output file permissions are now set as follows. An output script file
2902 gets the same permission as the input file, except that owner
2903 read/write permission is added (otherwise, perltidy could not be
2904 rerun). Html output files use system defaults. Previously chmod 0755
2905 was used in all cases. Thanks to Mark Olesen for bringing this up.
2907 -Missing semicolons will not be added in multi-line blocks of type
2908 sort, map, or grep. This brings perltidy into closer agreement
2909 with common practice. Of course, you can still put semicolons
2910 there if you like. Thanks to Simon Perreault for a discussion of this.
2912 -Most instances of extra semicolons are now deleted. This is
2913 particularly important if the -csc option is used. Thanks to Wolfgang
2914 Weisselberg for noting this. For example, the following line
2915 (produced by 'h2xs' :) has an extra semicolon which will now be
2918 BEGIN { plan tests => 1 };
2920 -New parameter -csce (--closing-side-comment-else-flag) can be used
2921 to control what text is appended to 'else' and 'elsif' blocks.
2922 Default is to just add leading 'if' text to an 'else'. See manual.
2924 -The -csc option now labels 'else' blocks with additinal information
2925 from the opening if statement and elsif statements, if space.
2926 Thanks to Wolfgang Weisselberg for suggesting this.
2928 -The -csc option will now remove any old closing side comments
2929 below the line interval threshold. Thanks to Wolfgang Weisselberg for
2932 -The abbreviation feature, which was broken in the previous version,
2933 is now fixed. Thanks to Michael Cartmell for noting this.
2935 -Vertical alignment is now done for '||=' .. somehow this was
2941 <pre><code>-This version uses modules for the first time, and a standard perl
2942 Makefile.PL has been supplied. However, perltidy may still be
2943 installed as a single script, without modules. See INSTALL for
2946 -The man page 'perl2web' has been merged back into the main 'perltidy'
2947 man page to simplify installation. So you may remove that man page
2948 if you have an older installation.
2950 -Added patch from Axel Rose for MacPerl. The patch prompts the user
2951 for command line arguments before calling the module
2952 Perl::Tidy::perltidy.
2954 -Corrected bug with '-bar' which was introduced in the previous
2955 version. A closing block brace was being indented. Thanks to
2956 Alexandros M Manoussakis for reporting this.
2958 -New parameter '--entab-leading-whitespace=n', or '-et=n', has been
2959 added for those who prefer tabs. This behaves different from the
2960 existing '-t' parameter; see updated man page. Suggested by Mark
2963 -New parameter '--perl-syntax-check-flags=s' or '-pcsf=s' can be
2964 used to change the flags passed to perltidy in a syntax check.
2965 See updated man page. Suggested by Mark Olesen.
2967 -New parameter '--output-path=s' or '-opath=s' will cause output
2968 files to be placed in directory s. See updated man page. Thanks for
2969 Mark Olesen for suggesting this.
2971 -New parameter --dump-profile (or -dpro) will dump to
2972 standard output information about the search for a
2973 configuration file, the name of whatever configuration file
2974 is selected, and its contents. This should help debugging
2975 config files, especially on different Windows systems.
2977 -The -w parameter now notes possible errors of the form:
2979 $comment = s/^\s*(\S+)\..*/$1/; # trim whitespace
2981 -Corrections added for a leading ':' and for leaving a leading 'tcsh'
2982 line untouched. Mark Olesen reported that lines of this form were
2983 accepted by perl but not by perltidy:
2985 : # use -*- perl -*-
2986 eval 'exec perl -wS $0 "$@"' # shell should exec 'perl'
2987 unless 1; # but Perl should skip this one
2989 Perl will silently swallow a leading colon on line 1 of a
2990 script, and now perltidy will do likewise. For example,
2991 this is a valid script, provided that it is the first line,
2994 : print "Hello World\n";
2996 Also, perltidy will now mark a first line with leading ':' followed by
2997 '#' as type SYSTEM (just as a #! line), not to be formatted.
2999 -List formatting improved for certain lists with special
3000 initial terms, such as occur with 'printf', 'sprintf',
3001 'push', 'pack', 'join', 'chmod'. The special initial term is
3002 now placed on a line by itself. For example, perltidy -gnu
3006 "C4", hex($SourceAddr[0]),
3007 hex($SourceAddr[1]), hex($SourceAddr[2]),
3013 hex($SourceAddr[0]), hex($SourceAddr[1]),
3014 hex($SourceAddr[2]), hex($SourceAddr[3]));
3018 @{$$self{states}}, '64', '66', '68',
3019 '70', '72', '74', '76',
3020 '78', '80', '82', '84',
3021 '86', '88', '90', '92',
3022 '94', '96', '98', '100',
3029 '64', '66', '68', '70', '72', '74', '76',
3030 '78', '80', '82', '84', '86', '88', '90',
3031 '92', '94', '96', '98', '100', '102', '104'
3034 -Lists of complex items, such as matricies, are now detected
3035 and displayed with just one item per row:
3038 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
3039 [ 1, tan( deg2rad($a) ), 0 ], [ tan( deg2rad($b) ), 1, 0 ],
3044 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
3045 [ 1, tan( deg2rad($a) ), 0 ],
3046 [ tan( deg2rad($b) ), 1, 0 ],
3050 -The perl syntax check will be turned off for now when input is from
3051 standard input or standard output. The reason is that this requires
3052 temporary files, which has produced far too many problems during
3053 Windows testing. For example, the POSIX module under Windows XP/2000
3054 creates temporary names in the root directory, to which only the
3055 administrator should have permission to write.
3057 -Merged patch sent by Yves Orton to handle appropriate
3058 configuration file locations for different Windows varieties
3059 (2000, NT, Me, XP, 95, 98).
3061 -Added patch to properly handle a for/foreach loop without
3062 parens around a list represented as a qw. I didn't know this
3063 was possible until Wolfgang Weisselberg pointed it out:
3065 foreach my $key qw\Uno Due Tres Quadro\ {
3069 But Perl will give a syntax error without the $ variable; ie this will
3072 foreach qw\Uno Due Tres Quadro\ {
3076 -Merged Windows version detection code sent by Yves Orton. Perltidy
3077 now automatically turns off syntax checking for Win 9x/ME versions,
3078 and this has solved a lot of robustness problems. These systems
3079 cannot reliably handle backtick operators. See man page for
3082 -Merged VMS filename handling patch sent by Michael Cartmell. (Invalid
3083 output filenames were being created in some cases).
3085 -Numerous minor improvements have been made for -lp style indentation.
3087 -Long C-style 'for' expressions will be broken after each ';'.
3089 'perltidy -gnu' gives:
3092 for ($status = $db->seq($key, $value, R_CURSOR()) ; $status == 0
3093 and $key eq $origkey ; $status = $db->seq($key, $value, R_NEXT()))
3096 for ($status = $db->seq($key, $value, R_CURSOR()) ;
3097 $status == 0 and $key eq $origkey ;
3098 $status = $db->seq($key, $value, R_NEXT()))
3100 -For the -lp option, a single long term within parens
3101 (without commas) now has better alignment. For example,
3105 $self->throw("Must specify a known host, not $location,"
3106 . " possible values ("
3107 . join (",", sort keys %hosts) . ")");
3110 $self->throw("Must specify a known host, not $location,"
3111 . " possible values ("
3112 . join (",", sort keys %hosts) . ")");
3117 <pre><code>-This version is about 20 percent faster than the previous
3118 version as a result of optimization work. The largest gain
3119 came from switching to a dispatch hash table in the
3122 -perltidy -html will check to see if HTML::Entities is
3123 installed, and if so, it will use it to encode unsafe
3126 -Added flag -oext=ext to change the output file extension to
3127 be different from the default ('tdy' or 'html'). For
3130 perltidy -html -oext=htm filename
3132 will produce filename.htm
3134 -Added flag -cscw to issue warnings if a closing side comment would replace
3135 an existing, different side comments. See the man page for details.
3136 Thanks to Peter Masiar for helpful discussions.
3138 -Corrected tokenization error of signed hex/octal/binary numbers. For
3139 example, the first hex number below would have been parsed correctly
3140 but the second one was not:
3141 if ( ( $tmp >= 0x80_00_00 ) || ( $tmp < -0x80_00_00 ) ) { }
3143 -'**=' was incorrectly tokenized as '**' and '='. This only
3144 caused a problem with the -extrude opton.
3146 -Corrected a divide by zero when -extrude option is used
3148 -The flag -w will now contain all errors reported by 'perl -c' on the
3149 input file, but otherwise they are not reported. The reason is that
3150 perl will report lots of problems and syntax errors which are not of
3151 interest when only a small snippet is being formatted (such as missing
3152 modules and unknown bare words). Perltidy will always report all
3153 significant syntax errors that it finds, such as unbalanced braces,
3154 unless the -q (quiet) flag is set.
3156 -Merged modifications created by Hugh Myers into perltidy.
3157 These include a 'streamhandle' routine which allows perltidy
3158 as a module to operate on input and output arrays and strings
3159 in addition to files. Documentation and new packaging as a
3160 module should be ready early next year; This is an elegant,
3161 powerful update; many thanks to Hugh for contributing it.
3166 <pre><code>-added a tentative patch which tries to keep any existing breakpoints
3167 at lines with leading keywords map,sort,eval,grep. The idea is to
3168 improve formatting of sequences of list operations, as in a schwartzian
3172 my @sorted = map { $_->[0] }
3173 sort { $a->[1] <=> $b->[1] }
3174 map { [ $_, rand ] } @list;
3178 map { $_->[0] } sort { $a->[1] <=> $b->[1] } map { [ $_, rand ] } @list;
3181 my @sorted = map { $_->[0] }
3182 sort { $a->[1] <=> $b->[1] }
3183 map { [ $_, rand ] } @list;
3185 The new alignment is not as nice as the input, but this is an improvement.
3186 Thanks to Yves Orton for this suggestion.
3188 -modified indentation logic so that a line with leading opening paren,
3189 brace, or square bracket will never have less indentation than the
3190 line with the corresponding opening token. Here's a simple example:
3194 -text => "New Document",
3195 -command => \&new_document
3197 -side => 'bottom',
3201 Note how the closing ');' is lined up with the first line, even
3202 though it closes a paren in the 'pack' line. That seems wrong.
3206 -text => "New Document",
3207 -command => \&new_document
3209 -side => 'bottom',
3213 This seems nicer: you can up-arrow with an editor and arrive at the
3214 opening 'pack' line.
3216 -corrected minor glitch in which cuddled else (-ce) did not get applied
3217 to an 'unless' block, which should look like this:
3225 Thanks to Jeremy Mates for reporting this.
3227 -The man page has been reorganized to parameters easier to find.
3229 -Added check for multiple definitions of same subroutine. It is easy
3230 to introduce this problem when cutting and pasting. Perl does not
3231 complain about it, but it can lead to disaster.
3233 -The command -pro=filename or -profile=filename may be used to specify a
3234 configuration file which will override the default name of .perltidyrc.
3235 There must not be a space on either side of the '=' sign. I needed
3236 this to be able to easily test perltidy with a variety of different
3237 configuration files.
3239 -Side comment alignment has been improved somewhat across frequent level
3240 changes, as in short if/else blocks. Thanks to Wolfgang Weisselberg
3241 for pointing out this problem. For example:
3244 if ( ref $self ) { # Called as a method
3247 else { # Regular procedure call
3253 if ( ref $self ) { # Called as a method
3256 else { # Regular procedure call
3261 -New command -ssc (--static-side-comment) and related command allows
3262 side comments to be spaced close to preceding character. This is
3263 useful for displaying commented code as side comments.
3265 -New command -csc (--closing-side-comment) and several related
3266 commands allow comments to be added to (and deleted from) any or all
3267 closing block braces. This can be useful if you have to maintain large
3268 programs, especially those that you didn't write. See updated man page.
3269 Thanks to Peter Masiar for this suggestion. For a simple example:
3274 if ( !defined( $_[0] ) ) {
3275 print("Hello, World\n");
3278 print( $_[0], "\n" );
3282 This added '## end sub foo' to the closing brace.
3283 To remove it, perltidy -ncsc.
3285 -New commands -ola, for outdenting labels, and -okw, for outdenting
3286 selected control keywords, were implemented. See the perltidy man
3287 page for details. Thanks to Peter Masiar for this suggestion.
3289 -Hanging side comment change: a comment will not be considered to be a
3290 hanging side comment if there is no leading whitespace on the line.
3291 This should improve the reliability of identifying hanging side comments.
3292 Thanks to Peter Masiar for this suggestion.
3294 -Two new commands for outdenting, -olq (outdent-long-quotes) and -olc
3295 (outdent-long-comments), have been added. The original -oll
3296 (outdent-long-lines) remains, and now is an abbreviation for -olq and -olc.
3297 The new default is just -olq. This was necessary to avoid inconsistency with
3298 the new static block comment option.
3300 -Static block comments: to provide a way to display commented code
3301 better, the convention is used that comments with a leading '##' should
3302 not be formatted as usual. Please see '-sbc' (or '--static-block-comment')
3303 for documentation. It can be deactivated with with -nsbc, but
3304 should not normally be necessary. Thanks to Peter Masiar for this
3307 -Two changes were made to help show structure of complex lists:
3308 (1) breakpoints are forced after every ',' in a list where any of
3309 the list items spans multiple lines, and
3310 (2) List items which span multiple lines now get continuation indentation.
3312 The following example illustrates both of these points. Many thanks to
3313 Wolfgang Weisselberg for this snippet and a discussion of it; this is a
3314 significant formatting improvement. Note how it is easier to see the call
3315 parameters in the NEW version:
3318 assert( __LINE__, ( not defined $check )
3321 or $check eq "old", "Error in parameters",
3322 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
3323 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
3324 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef" );
3329 ( not defined $check )
3333 "Error in parameters",
3334 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
3335 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
3336 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef"
3339 Another example shows how this helps displaying lists:
3342 %{ $self->{COMPONENTS} } = (
3344 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
3346 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
3349 The structure is clearer with the added indentation:
3352 %{ $self->{COMPONENTS} } = (
3354 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
3356 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
3359 -The structure of nested logical expressions is now displayed better.
3360 Thanks to Wolfgang Weisselberg for helpful discussions. For example,
3361 note how the status of the final 'or' is displayed in the following:
3365 and null( $op->sibling )
3366 and $op->ppaddr eq "pp_null"
3367 and class($op) eq "UNOP"
3368 and ( ( $op->first->ppaddr =~ /^pp_(and|or)$/
3369 and $op->first->first->sibling->ppaddr eq "pp_lineseq" )
3370 or ( $op->first->ppaddr eq "pp_lineseq"
3371 and not null $op->first->first->sibling
3372 and $op->first->first->sibling->ppaddr eq "pp_unstack" ) ) );
3377 and null( $op->sibling )
3378 and $op->ppaddr eq "pp_null"
3379 and class($op) eq "UNOP"
3382 $op->first->ppaddr =~ /^pp_(and|or)$/
3383 and $op->first->first->sibling->ppaddr eq "pp_lineseq"
3385 or ( $op->first->ppaddr eq "pp_lineseq"
3386 and not null $op->first->first->sibling
3387 and $op->first->first->sibling->ppaddr eq "pp_unstack" )
3391 -A break will always be put before a list item containing a comma-arrow.
3392 This will improve formatting of mixed lists of this form:
3396 'text', 225, 20, -text => 'A Simple Plot',
3404 -text => 'A Simple Plot',
3409 -For convenience, the command -dac (--delete-all-comments) now also
3410 deletes pod. Likewise, -tac (--tee-all-comments) now also sends pod
3411 to a '.TEE' file. Complete control over the treatment of pod and
3412 comments is still possible, as described in the updated help message
3415 -The logic which breaks open 'containers' has been rewritten to be completely
3416 symmetric in the following sense: if a line break is placed after an opening
3417 {, [, or (, then a break will be placed before the corresponding closing
3418 token. Thus, a container either remains closed or is completely cracked
3421 -Improved indentation of parenthesized lists. For example,
3426 atan2( $GPSTempCompLong - $GPSLongitude,
3427 $GPSLatitude - $GPSTempCompLat ) * 180 / 3.14159265 );
3430 $GPSCompCourse = int(
3432 $GPSTempCompLong - $GPSLongitude,
3433 $GPSLatitude - $GPSTempCompLat
3434 ) * 180 / 3.14159265
3437 Further improvements will be made in future releases.
3439 -Some improvements were made in formatting small lists.
3441 -Correspondence between Input and Output line numbers reported in a
3442 .LOG file should now be exact. They were sometimes off due to the size
3443 of intermediate buffers.
3445 -Corrected minor tokenization error in which a ';' in a foreach loop
3446 control was tokenized as a statement termination, which forced a
3459 foreach ( $i = 0 ; $i <= 10 ; $i += 2 ) {
3463 -Corrected a problem with reading config files, in which quote marks were not
3464 stripped. As a result, something like -wba="&& . || " would have the leading
3465 quote attached to the && and not work correctly. A workaround for older
3466 versions is to place a space around all tokens within the quotes, like this:
3467 -wba=" && . || "
3469 -Removed any existing space between a label and its ':'
3472 This was necessary because the label and its colon are a single token.
3474 -Corrected tokenization error for the following (highly non-recommended)
3476 $user = @vars[1] / 100;
3478 -Resolved cause of a difference between perltidy under perl v5.6.1 and
3479 5.005_03; the problem was different behavior of \G regex position
3485 <pre><code>-Corrected a bug in which a break was not being made after a full-line
3486 comment within a short eval/sort/map/grep block. A flag was not being
3487 zeroed. The syntax error check catches this. Here is a snippet which
3488 illustrates the bug:
3491 #open Socket to Dispatcher
3492 $sock = &OpenSocket;
3495 The formatter mistakenly thought that it had found the following
3498 eval {#open Socket to Dispatcher$sock = &OpenSocket; };
3500 The patch fixes this. Many thanks to Henry Story for reporting this bug.
3502 -Changes were made to help diagnose and resolve problems in a
3504 (1) processing of command parameters has been into two separate
3505 batches so that any errors in a .perltidyrc file can be localized.
3506 (2) commands --help, --version, and as many of the --dump-xxx
3507 commands are handled immediately, without any command line processing
3509 (3) Perltidy will ignore any commands in the .perltidyrc file which
3510 cause immediate exit. These are: -h -v -ddf -dln -dop -dsn -dtt
3511 -dwls -dwrs -ss. Thanks to Wolfgang Weisselberg for helpful
3512 suggestions regarding these updates.
3514 -Syntax check has been reinstated as default for MSWin32 systems. This
3515 way Windows 2000 users will get syntax check by default, which seems
3516 like a better idea, since the number of Win 95/98 systems will be
3517 decreasing over time. Documentation revised to warn Windows 95/98
3518 users about the problem with empty '&1'. Too bad these systems
3519 all report themselves as MSWin32.
3524 <pre><code>-Fixed tokenization error in which a method call of the form
3528 got a space before the '::' like this:
3530 Module ::->new();
3532 Thanks to David Holden for reporting this.
3534 -Added -html control over pod text, using a new abbreviation 'pd'. See
3535 updated perl2web man page. The default is to use the color of a comment,
3536 but italicized. Old .css style sheets will need a new line for
3537 .pd to use this. The old color was the color of a string, and there
3540 -.css lines are now printed in sorted order.
3542 -Fixed interpolation problem where html files had '$input_file' as title
3543 instead of actual input file name. Thanks to Simon Perreault for finding
3544 this and sending a patch, and also to Tobias Weber.
3546 -Breaks will now have the ':' placed at the start of a line,
3547 one per line by default because this shows logical structure
3548 more clearly. This coding has been completely redone. Some
3549 examples of new ?/: formatting:
3552 wantarray ? map( $dir::cwd->lookup($_)->path, @_ ) :
3553 $dir::cwd->lookup( $_[0] )->path;
3557 ? map( $dir::cwd->lookup($_)->path, @_ )
3558 : $dir::cwd->lookup( $_[0] )->path;
3561 $a = ( $b > 0 ) ? {
3564 } : { a => 6, b => 8 };
3572 : { a => 6, b => 8 };
3575 $self->note($self->{skip} ? "Hunk #$self->{hunk} ignored at 1.\n" :
3576 "Hunk #$self->{hunk} failed--$@");
3579 $self->note($self->{skip}
3580 ? "Hunk #$self->{hunk} ignored at 1.\n"
3581 : "Hunk #$self->{hunk} failed--$@");
3585 $opts{"t"} ? 'title' :
3586 $opts{"s"} ? 'subject' : $opts{"a"} ? 'author' : 'title';
3590 $opts{"t"} ? 'title'
3591 : $opts{"s"} ? 'subject'
3592 : $opts{"a"} ? 'author'
3595 You can use -wba=':' to recover the previous default which placed ':'
3596 at the end of a line. Thanks to Michael Cartmell for helpful
3597 discussions and examples.
3599 -Tokenizer updated to do syntax checking for matched ?/: pairs. Also,
3600 the tokenizer now outputs a unique serial number for every balanced
3601 pair of brace types and ?/: pairs. This greatly simplifies the
3604 -Long lines with repeated 'and', 'or', '&&', '||' will now have
3605 one such item per line. For example:
3608 if ( $opt_d || $opt_m || $opt_p || $opt_t || $opt_x
3609 || ( -e $archive && $opt_r ) )
3611 ( $pAr, $pNames ) = readAr($archive);
3620 || ( -e $archive && $opt_r ) )
3622 ( $pAr, $pNames ) = readAr($archive);
3626 if ( $vp->{X0} + 4 <= $x && $vp->{X0} + $vp->{W} - 4 >= $x
3627 && $vp->{Y0} + 4 <= $y && $vp->{Y0} + $vp->{H} - 4 >= $y )
3630 if ( $vp->{X0} + 4 <= $x
3631 && $vp->{X0} + $vp->{W} - 4 >= $x
3632 && $vp->{Y0} + 4 <= $y
3633 && $vp->{Y0} + $vp->{H} - 4 >= $y )
3635 -Long lines with multiple concatenated tokens will have concatenated
3636 terms (see below) placed one per line, except for short items. For
3641 "Device type:" . $ib->family . " ID:" . $ib->serial . " CRC:"
3642 . $ib->crc . ": " . $ib->model() . "\n";
3645 $report .= "Device type:"
3646 . $ib->family . " ID:"
3647 . $ib->serial . " CRC:"
3649 . $ib->crc . ": " . "\n";
3651 NOTE: at present 'short' means 8 characters or less. There is a
3652 tentative flag to change this (-scl), but it is undocumented and
3653 is likely to be changed or removed later, so only use it for testing.
3654 In the above example, the tokens " ID:", " CRC:", and "\n" are below
3657 -If a line which is short enough to fit on a single line was
3658 nevertheless broken in the input file at a 'good' location (see below),
3659 perltidy will try to retain a break. For example, the following line
3660 will be formatted as:
3662 open SUM, "<$file"
3663 or die "Cannot open $file ($!)";
3665 if it was broken in the input file, and like this if not:
3667 open SUM, "<$file" or die "Cannot open $file ($!)";
3669 GOOD: 'good' location means before 'and','or','if','unless','&&','||'
3671 The reason perltidy does not just always break at these points is that if
3672 there are multiple, similar statements, this would preclude alignment. So
3673 rather than check for this, perltidy just tries to follow the input style,
3674 in the hopes that the author made a good choice. Here is an example where
3675 we might not want to break before each 'if':
3677 ($Locale, @Locale) = ($English, @English) if (@English > @Locale);
3678 ($Locale, @Locale) = ($German, @German) if (@German > @Locale);
3679 ($Locale, @Locale) = ($French, @French) if (@French > @Locale);
3680 ($Locale, @Locale) = ($Spanish, @Spanish) if (@Spanish > @Locale);
3682 -Added wildcard file expansion for systems with shells which lack this.
3683 Now 'perltidy *.pl' should work under MSDOS/Windows. Thanks to Hugh Myers
3684 for suggesting this. This uses builtin glob() for now; I may change that.
3686 -Added new flag -sbl which, if specified, overrides the value of -bl
3687 for opening sub braces. This allows formatting of this type:
3693 if (!defined($_[0])) {
3694 print("Hello, World\n");
3700 Requested by Don Alexander.
3702 -Fixed minor parsing error which prevented a space after a $$ variable
3703 (pid) in some cases. Thanks to Michael Cartmell for noting this.
3708 -Improved line break choices 'and' and 'or' to display logic better.
3712 exists $self->{'build_dir'} and push @e,
3713 "Unwrapped into directory $self->{'build_dir'}";
3716 exists $self->{'build_dir'}
3717 and push @e, "Unwrapped into directory $self->{'build_dir'}";
3719 -Fixed error of multiple use of abbreviatioin '-dsc'. -dsc remains
3720 abbreviation for delete-side-comments; -dsm is new abbreviation for
3723 -Corrected and updated 'usage' help routine. Thanks to Slaven Rezic for
3726 -The default for Windows is, for now, not to do a 'perl -c' syntax
3727 check (but -syn will activate it). This is because of problems with
3728 command.com. James Freeman sent me a patch which tries to get around
3729 the problems, and it works in many cases, but testing revealed several
3730 issues that still need to be resolved. So for now, the default is no
3731 syntax check for Windows.
3733 -I added a -T flag when doing perl -c syntax check.
3734 This is because I test it on a large number of scripts from sources
3735 unknown, and who knows what might be hidden in initialization blocks?
3736 Also, deactivated the syntax check if perltidy is run as root. As a
3737 benign example, running the previous version of perltidy on the
3738 following file would cause it to disappear:
3741 print "Bye, bye baby!\n";
3745 The new version will not let that happen.
3747 -I am contemplating (but have not yet implemented) making '-lp' the
3748 default indentation, because it is stable now and may be closer to how
3749 perl is commonly formatted. This could be in the next release. The
3750 reason that '-lp' was not the original default is that the coding for
3751 it was complex and not ready for the initial release of perltidy. If
3752 anyone has any strong feelings about this, I'd like to hear. The
3753 current default could always be recovered with the '-nlp' flag.
3758 <pre><code>-html updates:
3759 - sub definition names are now specially colored, red by default.
3760 The letter 'm' is used to identify them.
3761 - keyword 'sub' now has color of other keywords.
3762 - restored html keyword color to __END__ and __DATA__, which was
3763 accidentally removed in the previous version.
3765 -A new -se (--standard-error-output) flag has been implemented and
3766 documented which causes all errors to be written to standard output
3767 instead of a .ERR file.
3769 -A new -w (--warning-output) flag has been implemented and documented
3770 which causes perltidy to output certain non-critical messages to the
3771 error output file, .ERR. These include complaints about pod usage,
3772 for example. The default is to not include these.
3774 NOTE: This replaces an undocumented -w=0 or --warning-level flag
3775 which was tentatively introduced in the previous version to avoid some
3776 unwanted messages. The new default is the same as the old -w=0, so
3777 that is no longer needed.
3779 -Improved syntax checking and corrected tokenization of functions such
3780 as rand, srand, sqrt, ... These can accept either an operator or a term
3781 to their right. This has been corrected.
3783 -Corrected tokenization of semicolon: testing of the previous update showed
3784 that the semicolon in the following statement was being mis-tokenized. That
3785 did no harm, other than adding an extra blank space, but has been corrected.
3787 for (sort {strcoll($a,$b);} keys %investments) {
3791 -New syntax check: after wasting 5 minutes trying to resolve a syntax
3792 error in which I had an extra terminal ';' in a complex for (;;) statement,
3793 I spent a few more minutes adding a check for this in perltidy so it won't
3796 -The behavior of --break-before-subs (-bbs) and --break-before-blocks
3797 (-bbb) has been modified. Also, a new control parameter,
3798 --long-block-line-count=n (-lbl=n) has been introduced to give more
3799 control on -bbb. This was previously a hardwired value. The reason
3800 for the change is to reduce the number of unwanted blank lines that
3801 perltidy introduces, and make it less erratic. It's annoying to remove
3802 an unwanted blank line and have perltidy put it back. The goal is to
3803 be able to sprinkle a few blank lines in that dense script you
3804 inherited from Bubba. I did a lot of experimenting with different
3805 schemes for introducing blank lines before and after code blocks, and
3806 decided that there is no really good way to do it. But I think the new
3807 scheme is an improvement. You can always deactivate this with -nbbb.
3808 I've been meaning to work on this; thanks to Erik Thaysen for bringing
3811 -The .LOG file is seldom needed, and I get tired of deleting them, so
3812 they will now only be automatically saved if perltidy thinks that it
3813 made an error, which is almost never. You can still force the logfile
3814 to be saved with -log or -g.
3816 -Improved method for computing number of columns in a table. The old
3817 method always tried for an even number. The new method allows odd
3818 numbers when it is obvious that a list is not a hash initialization
3822 $name, $xsargs, $parobjs, $optypes,
3823 $hasp2child, $pmcode, $hdrcode, $inplacecode,
3824 $globalnew, $callcopy
3829 $name, $xsargs, $parobjs, $optypes, $hasp2child,
3830 $pmcode, $hdrcode, $inplacecode, $globalnew, $callcopy
3834 -I fiddled with the list threshold adjustment, and some small lists
3835 look better now. Here is the change for one of the lists in test file
3839 ("in", "in", "pt", "pt", "pc", "pi", "mm", "mm", "cm", "cm", "\\hsize", "%",
3840 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%");
3844 "in", "in", "pt", "pt", "pc", "pi",
3845 "mm", "mm", "cm", "cm", "\\hsize", "%",
3846 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%"
3849 -Improved -lp formatting at '=' sign. A break was always being added after
3850 the '=' sign in a statement such as this, (to be sure there was enough room
3851 for the parameters):
3856 $biblionumber, $constraint,
3860 The updated version doesn't do this unless the space is really needed:
3862 new: my $fee = CalcReserveFee(
3864 $biblionumber, $constraint,
3868 -I updated the tokenizer to allow $#+ and $#-, which seem to be new to
3869 Perl 5.6. Some experimenting with a recent version of Perl indicated
3870 that it allows these non-alphanumeric '$#' array maximum index
3871 variables: $#: $#- $#+ so I updated the parser accordingly. Only $#:
3872 seems to be valid in older versions of Perl.
3874 -Fixed a rare formatting problem with -lp (and -gnu) which caused
3875 excessive indentation.
3877 -Many additional syntax checks have been added.
3879 -Revised method for testing here-doc target strings; the following
3880 was causing trouble with a regex test because of the '*' characters:
3881 print <<"*EOF*";
3884 Perl seems to allow almost anything to be a here doc target, so an
3885 exact string comparison is now used.
3887 -Made update to allow underscores in binary numbers, like '0b1100_0000'.
3889 -Corrected problem with scanning certain module names; a blank space was
3890 being inserted after 'warnings' in the following:
3891 use warnings::register;
3892 The problem was that warnings (and a couple of other key modules) were
3893 being tokenized as keywords. They should have just been identifiers.
3895 -Corrected tokenization of indirect objects after sort, system, and exec,
3896 after testing produced an incorrect error message for the following
3898 print sort $sortsubref @list;
3900 -Corrected minor problem where a line after a format had unwanted
3901 extra continuation indentation.
3903 -Delete-block-comments (and -dac) now retain any leading hash-bang line
3905 -Update for -lp (and -gnu) to not align the leading '=' of a list
3906 with a previous '=', since this interferes with alignment of parameters.
3908 old: my $hireDay = new Date;
3910 firstName => undef,
3911 lastName => undef,
3912 hireDay => $hireDay
3915 new: my $hireDay = new Date;
3917 firstName => undef,
3918 lastName => undef,
3919 hireDay => $hireDay
3922 -Modifications made to display tables more compactly when possible,
3923 without adding lines. For example,
3925 '1', "I", '2', "II", '3', "III", '4', "IV",
3926 '5', "V", '6', "VI", '7', "VII", '8', "VIII",
3929 '1', "I", '2', "II", '3', "III",
3930 '4', "IV", '5', "V", '6', "VI",
3931 '7', "VII", '8', "VIII", '9', "IX"
3933 -Corrected minor bug in which -pt=2 did not keep the right paren tight
3934 around a '++' or '--' token, like this:
3936 for ($i = 0 ; $i < length $key ; $i++ )
3938 The formatting for this should be, and now is:
3940 for ($i = 0 ; $i < length $key ; $i++)
3942 Thanks to Erik Thaysen for noting this.
3944 -Discovered a new bug involving here-docs during testing! See BUGS.html.
3946 -Finally fixed parsing of subroutine attributes (A Perl 5.6 feature).
3947 However, the attributes and prototypes must still be on the same line
3953 <pre><code>-Corrected minor, uncommon bug found during routine testing, in which a
3954 blank got inserted between a function name and its opening paren after
3955 a file test operator, but only in the case that the function had not
3956 been previously seen. Perl uses the existence (or lack thereof) of
3957 the blank to guess if it is a function call. That is,
3958 if (-l pid_filename()) {
3960 if (-l pid_filename ()) {
3961 which is a syntax error if pid_filename has not been seen by perl.
3963 -If the AutoLoader module is used, perltidy will continue formatting
3964 code after seeing an __END__ line. Use -nlal to deactivate this feature.
3965 Likewise, if the SelfLoader module is used, perltidy will continue
3966 formatting code after seeing a __DATA__ line. Use -nlsl to
3967 deactivate this feature. Thanks to Slaven Rezic for this suggestion.
3969 -pod text after __END__ and __DATA__ is now identified by perltidy
3970 so that -dp works correctly. Thanks to Slaven Rezic for this suggestion.
3972 -The first $VERSION line which might be eval'd by MakeMaker
3973 is now passed through unchanged. Use -npvl to deactivate this feature.
3974 Thanks to Manfred Winter for this suggestion.
3976 -Improved indentation of nested parenthesized expressions. Tests have
3977 given favorable results. Thanks to Wolfgang Weisselberg for helpful
3983 <pre><code>-Fixed a very rare problem in which an unwanted semicolon was inserted
3984 due to misidentification of anonymous hash reference curly as a code
3985 block curly. (No instances of this have been reported; I discovered it
3986 during testing). A workaround for older versions of perltidy is to use
3989 -Added -icb (-indent-closing-brace) parameter to indent a brace which
3990 terminates a code block to the same level as the previous line.
3991 Suggested by Andrew Cutler. For example,
4000 -Rewrote error message triggered by an unknown bareword in a print or
4001 printf filehandle position, and added flag -w=0 to prevent issuing this
4002 error message. Suggested by Byron Jones.
4004 -Added modification to align a one-line 'if' block with similar
4005 following 'elsif' one-line blocks, like this:
4006 if ( $something eq "simple" ) { &handle_simple }
4007 elsif ( $something eq "hard" ) { &handle_hard }
4008 (Suggested by Wolfgang Weisselberg).
4013 <pre><code>-Eliminated all constants with leading underscores because perl 5.005_03
4014 does not support that. For example, _SPACES changed to XX_SPACES.
4015 Thanks to kromJx for this update.
4020 <pre><code>-the directory of test files has been moved to a separate distribution
4021 file because it is getting large but is of little interest to most users.
4022 For the current distribution:
4023 perltidy-20010701.tgz contains the source and docs for perltidy
4024 perltidy-20010701-test.tgz contains the test files
4026 -fixed bug where temporary file perltidy.TMPI was not being deleted
4027 when input was from stdin.
4029 -adjusted line break logic to not break after closing brace of an
4030 eval block (suggested by Boris Zentner).
4032 -added flag -gnu (--gnu-style) to give an approximation to the GNU
4033 style as sometimes applied to perl. The programming style in GNU
4034 'automake' was used as a guide in setting the parameters; these
4035 parameters will probably be adjusted over time.
4037 -an empty code block now has one space for emphasis:
4038 if ( $cmd eq "bg_untested" ) {} # old
4039 if ( $cmd eq "bg_untested" ) { } # new
4040 If this bothers anyone, we could create a parameter.
4042 -the -bt (--brace-tightness) parameter has been split into two
4043 parameters to give more control. -bt now applies only to non-BLOCK
4044 braces, while a new parameter -bbt (block-brace-tightness) applies to
4045 curly braces which contain code BLOCKS. The default value is -bbt=0.
4047 -added flag -icp (--indent-closing-paren) which leaves a statement
4048 termination of the form );, };, or ]; indented with the same
4049 indentation as the previous line. For example,
4051 @month_of_year = ( # default, or -nicp
4052 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
4056 @month_of_year = ( # -icp
4057 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
4061 -Vertical alignment updated to synchronize with tokens &&, ||,
4062 and, or, if, unless. Allowable space before forcing
4063 resynchronization has been increased. (Suggested by Wolfgang
4066 -html corrected to use -nohtml-bold-xxxxxxx or -nhbx to negate bold,
4067 and likewise -nohtml-italic-xxxxxxx or -nhbi to negate italic. There
4068 was no way to negate these previously. html documentation updated and
4069 corrected. (Suggested by Wolfgang Weisselberg).
4071 -Some modifications have been made which improve the -lp formatting in
4074 -Perltidy now retains or creates a blank line after an =cut to keep
4075 podchecker happy (Suggested by Manfred H. Winter). This appears to be
4076 a glitch in podchecker, but it was annoying.
4081 <pre><code>-Added -bli flag to give continuation indentation to braces, like this
4085 extra_indentation();
4088 -Corrected an error with the tab (-t) option which caused the last line
4089 of a multi-line quote to receive a leading tab. This error was in
4090 version 2001 06 08 but not 2001 04 06. If you formatted a script
4091 with -t with this version, please check it by running once with the
4092 -chk flag and perltidy will scan for this possible error.
4094 -Corrected an invalid pattern (\R should have been just R), changed
4095 $^W =1 to BEGIN {$^W=1} to use warnings in compile phase, and corrected
4096 several unnecessary 'my' declarations. Many thanks to Wolfgang Weisselberg,
4097 2001-06-12, for catching these errors.
4099 -A '-bar' flag has been added to require braces to always be on the
4100 right, even for multi-line if and foreach statements. For example,
4101 the default formatting of a long if statement would be:
4103 if ($bigwasteofspace1 && $bigwasteofspace2
4104 || $bigwasteofspace3 && $bigwasteofspace4)
4109 With -bar, the formatting is:
4111 if ($bigwasteofspace1 && $bigwasteofspace2
4112 || $bigwasteofspace3 && $bigwasteofspace4) {
4115 Suggested by Eli Fidler 2001-06-11.
4117 -Uploaded perltidy to sourceforge cvs 2001-06-10.
4119 -An '-lp' flag (--line-up-parentheses) has been added which causes lists
4120 to be indented with extra indentation in the manner sometimes
4121 associated with emacs or the GNU suggestions. Thanks to Ian Stuart for
4122 this suggestion and for extensive help in testing it.
4124 -Subroutine call parameter lists are now formatted as other lists.
4125 This should improve formatting of tables being passed via subroutine
4126 calls. This will also cause full indentation ('-i=n, default n= 4) of
4127 continued parameter list lines rather than just the number of spaces
4128 given with -ci=n, default n=2.
4130 -Added support for hanging side comments. Perltidy identifies a hanging
4131 side comment as a comment immediately following a line with a side
4132 comment or another hanging side comment. This should work in most
4133 cases. It can be deactivated with --no-hanging-side-comments (-nhsc).
4134 The manual has been updated to discuss this. Suggested by Brad
4135 Eisenberg some time ago, and finally implemented.
4140 <pre><code>-fixed problem with parsing command parameters containing quoted
4141 strings in .perltidyrc files. (Reported by Roger Espel Llima 2001-06-07).
4143 -added two command line flags, --want-break-after and
4144 --want-break-before, which allow changing whether perltidy
4145 breaks lines before or after any operators. Please see the revised
4146 man pages for details.
4148 -added system-wide configuration file capability.
4149 If perltidy does not find a .perltidyrc command line file in
4150 the current directory, nor in the home directory, it now looks
4151 for '/usr/local/etc/perltidyrc' and then for '/etc/perltidyrc'.
4152 (Suggested by Roger Espel Llima 2001-05-31).
4154 -fixed problem in which spaces were trimmed from lines of a multi-line
4155 quote. (Reported by Roger Espel Llima 2001-05-30). This is an
4156 uncommon situation, but serious, because it could conceivably change
4157 the proper function of a script.
4159 -fixed problem in which a semicolon was incorrectly added within
4160 an anonymous hash. (Reported by A.C. Yardley, 2001-5-23).
4161 (You would know if this happened, because perl would give a syntax
4162 error for the resulting script).
4164 -fixed problem in which an incorrect error message was produced
4165 after a version number on a 'use' line, like this ( Reported
4166 by Andres Kroonmaa, 2001-5-14):
4168 use CGI 2.42 qw(fatalsToBrowser);
4170 Other than the extraneous error message, this bug was harmless.
4175 <pre><code>-fixed serious bug in which the last line of some multi-line quotes or
4176 patterns was given continuation indentation spaces. This may make
4177 a pattern incorrect unless it uses the /x modifier. To find
4178 instances of this error in scripts which have been formatted with
4179 earlier versions of perltidy, run with the -chk flag, which has
4180 been added for this purpose (SLH, 2001-04-05).
4182 ** So, please check previously formatted scripts by running with -chk
4185 -continuation indentation has been reprogrammed to be hierarchical,
4186 which improves deeply nested structures.
4188 -fixed problem with undefined value in list formatting (reported by Michael
4191 -Switched to graphical display of nesting in .LOG files. If an
4192 old format string was "(1 [0 {2", the new string is "{{(". This
4193 is easier to read and also shows the order of nesting.
4195 -added outdenting of cuddled paren structures, like ")->pack(".
4197 -added line break and outdenting of ')->' so that instead of
4200 -text => "perltidy",
4201 -relief => 'ridge')->pack;
4203 the current default is:
4206 -text => "perltidy",
4207 -relief => 'ridge'
4210 (requested by Michael Langner 2001-03-31; in the future this could
4211 be controlled by a command-line parameter).
4213 -revised list indentation logic, so that lists following an assignment
4214 operator get one full indentation level, rather than just continuation
4215 indentation. Also corrected some minor glitches in the continuation
4218 -Fixed problem with unwanted continuation indentation after a blank line
4219 (reported by Erik Thaysen 2001-03-28):
4221 -minor update to avoid stranding a single '(' on one line
4224 <h2>2001 03 28:</h2>
4226 <pre><code>-corrected serious error tokenizing filehandles, in which a sub call
4227 after a print or printf, like this:
4228 print usage() and exit;
4230 print usage () and exit;
4231 Unfortunately, this converts 'usage' to a filehandle. To fix this, rerun
4232 perltidy; it will look for this situation and issue a warning.
4234 -fixed another cuddled-else formatting bug (Reported by Craig Bourne)
4236 -added several diagnostic --dump routines
4238 -added token-level whitespace controls (suggested by Hans Ecke)
4241 <h2>2001 03 23:</h2>
4243 <pre><code>-added support for special variables of the form ${^WANT_BITS}
4245 -space added between scalar and left paren in 'for' and 'foreach' loops,
4246 (suggestion by Michael Cartmell):
4248 for $i( 1 .. 20 ) # old
4249 for $i ( 1 .. 20 ) # new
4251 -html now outputs cascading style sheets (thanks to suggestion from
4254 -flags -o and -st now work with -html
4256 -added missing -html documentation for comments (noted by Alex Izvorski)
4258 -support for VMS added (thanks to Michael Cartmell for code patches and
4261 -v-strings implemented (noted by Hans Ecke and Michael Cartmell; extensive
4262 testing by Michael Cartmell)
4264 -fixed problem where operand may be empty at line 3970
4265 (\b should be just b in lines 3970, 3973) (Thanks to Erik Thaysen,
4266 Keith Marshall for bug reports)
4268 -fixed -ce bug (cuddled else), where lines like '} else {' were indented
4269 (Thanks to Shawn Stepper and Rick Measham for reporting this)
4272 <h2>2001 03 04:</h2>
4274 <pre><code>-fixed undefined value in line 153 (only worked with -I set)
4275 (Thanks to Mike Stok, Phantom of the Opcodes, Ian Ehrenwald, and others)
4277 -fixed undefined value in line 1069 (filehandle problem with perl versions <
4278 5.6) (Thanks to Yuri Leikind, Mike Stok, Michael Holve, Jeff Kolber)
4281 <h2>2001 03 03:</h2>
4283 <pre><code>-Initial announcement at freshmeat.net; started Change Log
4284 (Unfortunately this version was DOA, but it was fixed the next day)