5 - This release adds a flag to control the feature RT#130394 (allow short nested blocks)
6 introduced in the previous release. Unfortunately that feature breaks
7 RPerl installations, so a control flag has been introduced and that feature is now
8 off by default. The flag is:
10 --one-line-block-nesting=n, or -olbn=n, where n is an integer as follows:
12 -olbn=0 break nested one-line blocks into multiple lines [new DEFAULT]
13 -olbn=1 stable; keep existing nested-one line blocks intact [previous DEFAULT]
15 For example, consider this input line:
17 foreach (@list) { if ($_ eq $asked_for) { last } ++$found }
19 The new default behavior (-olbn=0), and behavior prior to version 20191203, is to break it into multiple lines:
22 if ( $_ eq $asked_for ) { last }
26 To keep nested one-line blocks such as this on a single line you can add the parameter -olbn=1.
28 - Fixed issue RT#131288: parse error for un-prototyped constant function without parenthesized
29 call parameters followed by ternary.
31 - Fixed issue RT#131360, installation documentation. Added a note that the binary
32 'perltidy' comes with the Perl::Tidy module. They can both normally be installed with
38 - Fixed issue RT#131115: -bli option not working correctly.
39 Closing braces were not indented in some cases due to a glitch
40 introduced in version 20181120.
42 - Fixed issue RT#130394: Allow short nested blocks. Given the following
44 $factorial = sub { reduce { $a * $b } 1 .. 11 };
46 Previous versions would always break the sub block because it
47 contains another block (the reduce block). The fix keeps
48 short one-line blocks such as this intact.
50 - Implement issue RT#130640: Allow different subroutine keywords.
51 Added a flag --sub-alias-list=s or -sal=s, where s is a string with
52 one or more aliases for 'sub', separated by spaces or commas.
55 perltidy -sal='method fun'
57 will cause the perltidy to treat the words 'method' and 'fun' to be
58 treated the same as if they were 'sub'.
60 - Added flag --space-prototype-paren=i, or -spp=i, to control spacing
61 before the opening paren of a prototype, where i=0, 1, or 2:
63 i=1 follow input [current and default]
66 Previously, perltidy always followed the input.
67 For example, given the following input
72 sub usage(); # i=0 [no space]
73 sub usage(); # i=1 [default; follows input]
74 sub usage (); # i=2 [space]
76 - Fixed issue git#16, minor vertical alignment issue.
78 - Fixed issue git#10, minor conflict of -wn and -ce
80 - Improved some vertical alignments involving two lines.
85 - fixed issue RT#130344: false warning "operator in print statement"
88 - fixed issue RT#130304: standard error output should include filename.
89 When perltidy error messages are directed to the standard error output
90 with -se or --standard-error-output, the message lines now have a prefix
91 'filename:' for clarification in case multiple files
92 are processed, where 'filename' is the name of the input file. If
93 input is from the standard input the displayed filename is '<stdin>',
94 and if it is from a data structure then displayed filename
97 - implement issue RT#130425: check mode. A new flag '--assert-tidy'
98 will cause an error message if the output script is not identical to
99 the input script. For completeness, the opposite flag '--assert-untidy'
100 has also been added. The next item, RT#130297, insures that the script
101 will exit with a non-zero exit flag if the assertion fails.
103 - fixed issue RT#130297; the perltidy script now exits with a nonzero exit
104 status if it wrote to the standard error output. Prevously only fatal
105 run errors produced a non-zero exit flag. Now, even non-fatal messages
106 requested with the -w flag will cause a non-zero exit flag. The exit
107 flag now has these values:
110 1 = perltidy could not run to completion due to errors
111 2 = perltidy ran to completion with error messages
113 - added warning message for RT#130008, which warns of conflicting input
114 parameters -iob and -bom or -boc.
116 - fixed RT#129850; concerning a space between a closing block brace and
117 opening bracket or brace, as occurs before the '[' in this line:
119 my @addunix = map { File::Spec::Unix->catfile( @ROOT, @$_ ) } ['b'];
121 Formerly, any space was removed. Now it is optional, and the output will
124 - fixed issue git#13, needless trailing whitespace in error message
126 - fixed issue git#9: if the -ce (--cuddled-else) flag is used,
127 do not try to form new one line blocks for a block type
128 specified with -cbl, particularly map, sort, grep
130 - iteration speedup for unchanged code. Previously, when iterations were
131 requested, at least two formatting passes were made. Now just a single pass
132 is made if the formatted code is identical to the input code.
134 - some improved vertical alignments
138 - rt #128477: Prevent inconsistent owner/group and setuid/setgid bits.
139 In the -b (--backup-and-modify-in-place) mode, an attempt is made to set ownership
140 of the output file equal to the input file, if they differ.
141 In all cases, if the final output file ownership differs from input file, any setuid/setgid bits are cleared.
143 - Added option -bom (--break-at-old-method-breakpoints) by
144 merrillymeredith which preserves breakpoints of method chains. Modified to also handle a cuddled call style.
146 - Merged patch to fix Windows EOL translation error with UTF-8 written by
147 Ron Ivy. This update prevents automatic conversion to 'DOS' CRLF line
148 endings. Also, Windows system testing at the appveyor site is working again.
150 - RT #128280, added flag --one-line-block-semicolons=n (-olbs=n)
151 to control semicolons in one-line blocks. The values of n are:
152 n=0 means no semicolons termininating simple one-line blocks
153 n=1 means stable; do not change from input file [DEFAULT and current]
154 n=2 means always add semicolons in one-line blocks
155 The current behavior corresponds to the default n=1.
157 - RT #128216, Minor update to prevent inserting unwanted blank line at
158 indentation level change. This should not change existing scripts.
160 - RT #81852: Improved indentation when quoted word (qw) lists are
161 nested within other containers using the --weld-nested (-wn) flag.
162 The example given previously (below) is now closer to what it would
163 be with a simple list instead of qw:
177 - RT#12764, introduced new feature allowing placement of blanks around
178 sequences of selected keywords. This can be activated with the -kgb*
179 series of parameters described in the manual.
181 - Rewrote vertical algnment module. It is better at finding
182 patterns in complex code. For example,
185 /^-std$/ && do { $std = 1; next; };
186 /^--$/ && do { @link_args = @argv; last; };
187 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
190 /^-std$/ && do { $std = 1; next; };
191 /^--$/ && do { @link_args = @argv; last; };
192 /^-I(.*)/ && do { $path = $1 || shift @argv; next; };
194 - Add repository URLs to META files
196 - RT #118553, "leave only one newline at end of file". This option was not
197 added because of undesirable side effects, but a new filter script
198 was added which can do this, "examples/delete_ending_blank_lines.pl".
202 - fix RT#127736 Perl-Tidy-20181119 has the EXE_FILES entry commented out in
203 Makefile.PL so it doesn't install the perltidy script or its manpage.
208 - Removed test case 'filter_example.t' which was causing a failure on a
209 Windows installation for unknown reasons, possibly due to an unexpected
210 perltidyrc being read by the test script. Added VERSION numbers to all
215 - Fixed RT #126965, in which a ternary operator was misparsed if immediately
216 following a function call without arguments, such as:
217 my $restrict_customer = shift ? 1 : 0;
219 - Fixed RT #125012: bug in -mangle --delete-all-comments
220 A needed blank space before bareword tokens was being removed when comments
223 - Fixed RT #81852: Stacked containers and quoting operators. Quoted words
224 (qw) delimited by container tokens ('{', '[', '(', '<') are now included in
225 the --weld-nested (-wn) flag:
239 - The cuddled-else (-ce) coding was merged with the new cuddled-block (-cb)
240 coding. The change is backward compatible and simplifies input.
241 The --cuddled-block-option=n (-cbo=n) flag now applies to both -ce and -cb
242 formatting. In fact the -cb flag is just an alias for -ce now.
244 - Fixed RT #124594, license text desc. changed from 'GPL-2.0+' to 'gpl_2'
246 - Fixed bug in which a warning about a possible code bug was issued in a
247 script with brace errors.
249 - added option --notimestamp or -nts to eliminate any time stamps in output
250 files. This is used to prevent differences in test scripts from causing
251 failure at installation. For example, the -cscw option will put a date
252 stamp on certain closing side comments. We need to avoid this in order
253 to test this feature in an installation test.
255 - Fixed bug with the entab option, -et=8, in which the leading space of
256 some lines was was not entabbed. This happened in code which was adjusted
257 for vertical alignment and in hanging side comments. Thanks to Glenn.
259 - Fixed RT #127633, undesirable line break after return when -baao flag is set
261 - Fixed RT #127035, vertical alignment. Vertical alignment has been improved
262 in several ways. Thanks especially to Michael Wardman and Glenn for sending
265 - Alignment of the =~ operators has been reactivated.
268 $service_profile =~ s/^\s+|\s+$//g;
269 $host_profile =~ s/^\s+|\s+$//g;
272 $service_profile =~ s/^\s+|\s+$//g;
273 $host_profile =~ s/^\s+|\s+$//g;
275 - Alignment of the // operator has been reactivated.
278 is( pop // 7, 7, 'pop // ... works' );
279 is( pop() // 7, 0, 'pop() // ... works' );
280 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
283 is( pop // 7, 7, 'pop // ... works' );
284 is( pop() // 7, 0, 'pop() // ... works' );
285 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
287 - The rules for alignment of just two lines have been adjusted,
288 hopefully to be a little better overall. In some cases, two
289 lines which were previously unaligned are now aligned, and vice-versa.
292 $expect = "1$expect" if $expect =~ /^e/i;
293 $p = "1$p" if defined $p and $p =~ /^e/i;
296 $expect = "1$expect" if $expect =~ /^e/i;
297 $p = "1$p" if defined $p and $p =~ /^e/i;
300 - RT #106493; source code repository location has been added to docs; it is
301 https://github.com/perltidy/perltidy
303 - The packaging for this version has changed. The Tidy.pm module is much
304 smaller. Supporting modules have been split out from it and placed below
305 it in the path Perl/Tidy/*.
307 - A number of new installation test cases have been added. Updates are now
308 continuously tested at Travis CI against versions back to Perl 5.08.
312 - RT #124469, #124494, perltidy often making empty files. The previous had
313 an index error causing it to fail, particularly in version 5.18 of Perl.
315 Please avoid version 20180219.
319 - RT #79947, cuddled-else generalization. A new flag -cb provides
320 'cuddled-else' type formatting for an arbitrary type of block chain. The
321 default is try-catch-finally, but this can be modified with the
324 - Fixed RT #124298: add space after ! operator without breaking !! secret
327 - RT #123749: numerous minor improvements to the -wn flag were made.
329 - Fixed a problem with convergence tests in which iterations were stopping
332 - Here doc targets for <<~ type here-docs may now have leading whitespace.
334 - Fixed RT #124354. The '-indent-only' flag was not working correctly in the
335 previous release. A bug in version 20180101 caused extra blank lines
338 - Issue RT #124114. Some improvements were made in vertical alignment
339 involving 'fat commas'.
343 - Added new flag -wn (--weld-nested-containers) which addresses these issues:
344 RT #123749: Problem with promises;
345 RT #119970: opening token stacking strange behavior;
346 RT #81853: Can't stack block braces
348 This option causes closely nested pairs of opening and closing containers
349 to be "welded" together and essentially be formatted as a single unit,
350 with just one level of indentation.
352 Since this is a new flag it is set to be "off" by default but it has given
353 excellent results in testing.
355 EXAMPLE 1, multiple blocks, default formatting:
358 next if $x == $y; # do something here
367 EXAMPLE 2, three levels of wrapped function calls, default formatting:
371 translate( param('verb') ), param('tense'),
379 translate( param('verb') ),
380 param('tense'), param('person')
383 # EXAMPLE 3, chained method calls, default formatting:
384 get('http://mojolicious.org')->then(
387 say $mojo->res->code;
388 return get('http://metacpan.org');
393 say $cpan->res->code;
398 warn "Something went wrong: $err";
403 get('http://mojolicious.org')->then( sub {
405 say $mojo->res->code;
406 return get('http://metacpan.org');
409 say $cpan->res->code;
412 warn "Something went wrong: $err";
416 - Fixed RT #114359: Missparsing of "print $x ** 0.5;
418 - Deactivated the --check-syntax flag for better security. It will be
421 - Corrected minimum perl version from 5.004 to 5.008 based on perlver
422 report. The change is required for coding involving wide characters.
424 - For certain severe errors, the source file will be copied directly to the
425 output without formatting. These include ending in a quote, ending in a
426 here doc, and encountering an unidentified character.
430 - RT #123749, partial fix. "Continuation indentation" is removed from lines
431 with leading closing parens which are part of a call chain.
432 For example, the call to pack() is is now outdented to the starting
433 indentation in the following experession:
437 -text => "New Document",
438 -command => \&new_document
446 -text => "New Document",
447 -command => \&new_document
453 This modification improves readability of complex expressions, especially
454 when the user uses the same value for continuation indentation (-ci=n) and
455 normal indentation (-i=n). Perltidy was already programmed to
456 do this but a minor bug was preventing it.
458 - RT #123774, added flag to control space between a backslash and a single or
459 double quote, requested by Robert Rothenberg. The issue is that lines like
464 confuse syntax highlighters unless a space is left between the backslash and
467 The new flag to control this is -sbq=n (--space-backslash-quote=n),
468 where n=0 means no space, n=1 means follow existing code, n=2 means always
469 space. The default is n=1, meaning that a space will be retained if there
470 is one in the source code.
472 - Fixed RT #123492, support added for indented here doc operator <<~ added
473 in v5.26. Thanks to Chris Weyl for the report.
475 - Fixed docs; --closing-side-comment-list-string should have been just
476 --closing-side-comment-list. Thanks to F.Li.
478 - Added patch RT #122030] Perl::Tidy sometimes does not call binmode.
479 Thanks to Irilis Aelae.
481 - Fixed RT #121959, PERLTIDY doesn't honor the 'three dot' notation for
482 locating a config file using environment variables. Thanks to John
485 - Minor improvements to formatting, in which some additional vertical
486 aligmnemt is done. Thanks to Keith Neargarder.
488 - RT #119588. Vertical alignment is no longer done for // operator.
492 - Fixed debian #862667: failure to check for perltidy.ERR deletion can lead
493 to overwriting arbitrary files by symlink attack. Perltidy was continuing
494 to write files after an unlink failure. Thanks to Don Armstrong
497 - Fixed RT #116344, perltidy fails on certain anonymous hash references:
498 in the following code snippet the '?' was misparsed as a pattern
499 delimiter rather than a ternary operator.
500 return ref {} ? 1 : 0;
502 - Fixed RT #113792: misparsing of a fat comma (=>) right after
503 the __END__ or __DATA__ tokens. These keywords were getting
504 incorrectly quoted by the following => operator.
506 - Fixed RT #118558. Custom Getopt::Long configuration breaks parsing
507 of perltidyrc. Perltidy was resetting the users configuration too soon.
509 - Fixed RT #119140, failure to parse double diamond operator. Code to
510 handle this new operator has been added.
512 - Fixed RT #120968. Fixed problem where -enc=utf8 didn't work
513 with --backup-and-modify-in-place. Thanks to Heinz Knutzen for this patch.
515 - Fixed minor formatting issue where one-line blocks for subs with signatures
516 were unnecessarily broken
518 - RT #32905, patch to fix utf-8 error when output was STDOUT.
520 - RT #79947, improved spacing of try/catch/finally blocks. Thanks to qsimpleq
523 - Fixed #114909, Anonymous subs with signatures and prototypes misparsed as
524 broken ternaries, in which a statement such as this was not being parsed
526 return sub ( $fh, $out ) : prototype(*$) { ... }
528 - Implemented RT #113689, option to introduces spaces after an opening block
529 brace and before a closing block brace. Four new optional controls are
530 added. The first two define the minimum number of blank lines to be
533 -blao=i or --blank-lines-after-opening-block=i
534 -blbc=i or --blank-lines-before-closing-block=i
536 where i is an integer, the number of lines (the default is 0).
538 The second two define the types of blocks to which the first two apply
540 -blaol=s or --blank-lines-after-opening-block-list=s
541 -blbcl=s or --blank-lines-before-closing-block-list=s
543 where s is a string of possible block keywords (default is just 'sub',
544 meaning a named subroutine).
546 For more information please see the documentation.
548 - The method for specifying block types for certain input parameters has
549 been generalized to distinguish between normal named subroutines and
550 anonymous subs. The keyword for normal subroutines remains 'sub', and
551 the new keyword for anonymous subs is 'asub'.
553 - Minor documentation changes. The BUGS sections now have a link
554 to CPAN where most open bugs and issues can be reviewed and bug reports
555 can be submitted. The information in the AUTHOR and CREDITS sections of
556 the man pages have been removed from the man pages to streamline the
557 documentation. This information is still in the source code.
561 - RT #112534. Corrected a minor problem in which an unwanted newline
562 was placed before the closing brace of an anonymous sub with
563 a signature, if it was in a list. Thanks to Dmytro Zagashev.
565 - Corrected a minor problem in which occasional extra indentation was
566 given to the closing brace of an anonymous sub in a list when the -lp
571 - RT #104427. Added support for signatures.
573 - RT #111512. Changed global warning flag $^W = 1 to use warnings;
574 Thanks to Dmytro Zagashev.
576 - RT #110297, added support for new regexp modifier /n
577 Thanks to Dmytro Zagashev.
579 - RT #111519. The -io (--indent-only) and -dac (--delete-all-comments)
580 can now both be used in one pass. Thanks to Dmitry Veltishev.
582 - Patch to avoid error message with 'catch' used by TryCatch, as in
586 Thanks to Nick Tonkin.
588 - RT #32905, UTF-8 coding is now more robust. Thanks to qsimpleq
589 and Dmytro for patches.
591 - RT #106885. Added string bitwise operators ^. &. |. ~. ^.= &.= |.=
593 - Fixed RT #107832 and #106492, lack of vertical alignment of two lines
594 when -boc flag (break at old commas) is set. This bug was
595 inadvertently introduced in previous bug fix RT #98902.
597 - Some common extensions to Perl syntax are handled better.
598 In particular, the following snippet is now foratted cleanly:
600 method deposit( Num $amount) {
601 $self->balance( $self->balance + $amount );
604 A new flag -xs (--extended-syntax) was added to enable this, and the default
607 In previous versions, and now only when -nxs is set, this snippet of code
608 generates the following error message:
610 "syntax error at ') {', didn't see one of: case elsif for foreach given if switch unless until when while"
614 - Fixed RT# 105484, Invalid warning about 'else' in 'switch' statement. The
615 warning happened if a 'case' statement did not use parens.
617 - Fixed RT# 101547, misparse of // caused error message. Also..
619 - Fixed RT# 102371, misparse of // caused unwated space in //=
621 - Fixed RT# 100871, "silent failure of HTML Output on Windows".
622 Changed calls to tempfile() from:
623 my ( $fh_tmp, $tmpfile ) = tempfile();
624 to have the full path name:
625 my ( $fh_tmp, $tmpfile ) = File::Temp::tempfile()
626 because of problems in the Windows version reported by Dean Pearce.
628 - Fixed RT# 99514, calling the perltidy module multiple times with
629 a .perltidyrc file containing the parameter --output-line-ending
630 caused a crash. This was a glitch in the memoization logic.
632 - Fixed RT#99961, multiple lines inside a cast block caused unwanted
633 continuation indentation.
635 - RT# 32905, broken handling of UTF-8 strings.
636 A new flag -utf8 causes perltidy assume UTF-8 encoding for input and
637 output of an io stream. Thanks to Sebastian Podjasek for a patch.
638 This feature may not work correctly in older versions of Perl.
639 It worked in a linux version 5.10.1 but not in a Windows version 5.8.3 (but
640 otherwise perltidy ran correctly).
642 - Warning files now report perltidy VERSION. Suggested by John Karr.
644 - Fixed long flag --nostack-closing-tokens (-nsct has always worked though).
645 This was due to a typo. This also fixed --nostack-opening-tokens to
646 behave correctly. Thanks to Rob Dixon.
650 - Fixed RT #94902: abbreviation parsing in .perltidyrc files was not
651 working for multi-line abbreviations. Thanks to Eric Fung for
654 - Fixed RT #95708, misparsing of a hash when the first key was a perl
655 keyword, causing a semicolon to be incorrectly added.
657 - Fixed RT #94338 for-loop in a parenthesized block-map. A code block within
658 parentheses of a map, sort, or grep function was being mistokenized. In
659 rare cases this could produce in an incorrect error message. The fix will
660 produce some minor formatting changes. Thanks to Daniel Trizen
661 discovering and documenting this.
663 - Fixed RT #94354, excess indentation for stacked tokens. Thanks to
664 Colin Williams for supplying a patch.
666 - Added support for experimental postfix dereferencing notation introduced in
667 perl 5.20. RT #96021.
669 - Updated documentation to clarify the behavior of the -io flag
670 in response to RT #95709. You can add -noll or -l=0 to prevent
671 long comments from being outdented when -io is used.
673 - Added a check to prevent a problem reported in RT #81866, where large
674 scripts which had been compressed to a single line could not be formatted
675 because of a check for VERSION for MakeMaker. The workaround was to
676 use -nvpl, but this shouldn't be necessary now.
678 - Fixed RT #96101; Closing brace of anonymous sub in a list was being
679 indented. For example, the closing brace of the anonymous sub below
680 will now be lined up with the word 'callback'. This problem
681 occurred if there was no comma after the closing brace of the anonymous sub.
682 This update may cause minor changes to formatting of code with lists
683 of anonymous subs, especially TK code.
690 path => '/_Operate/Transcode and split',
692 return 1 if not $self->project_opened;
693 $self->comp('project')->transcode( split => 1 );
703 path => '/_Operate/Transcode and split',
705 return 1 if not $self->project_opened;
706 $self->comp('project')->transcode( split => 1 );
713 - Fixed RT #94190 and debian Bug #742004: perltidy.LOG file left behind.
714 Thanks to George Hartzell for debugging this. The problem was
715 caused by the memoization speedup patch in version 20121207. An
716 unwanted flag was being set which caused a LOG to be written if
717 perltidy was called multiple times.
719 - New default behavior for LOG files: If the source is from an array or
720 string (through a call to the perltidy module) then a LOG output is only
721 possible if a logfile stream is specified. This is to prevent
722 unexpected perltidy.LOG files.
724 - Fixed debian Bug #740670, insecure temporary file usage. File::Temp is now
725 used to get a temporary file. Thanks to Don Anderson for a patch.
727 - Any -b (--backup-and-modify-in-place) flag is silently ignored when a
728 source stream, destination stream, or standard output is used.
729 This is because the -b flag may have been in a .perltidyrc file and
730 warnings break Test::NoWarnings. Thanks to Marijn Brand.
734 - Fixed RT #88020. --converge was not working with wide characters.
736 - Fixed RT #78156. package NAMESPACE VERSION syntax not accepted.
738 - First attempt to fix RT #88588. INDEX END tag change in pod2html breaks
739 perltidy -html. I put in a patch which should work but I don't yet have
744 - Fixed RT #87107, spelling
748 - Fixed RT #87502, incorrect of parsing of smartmatch before hash brace
750 - Added feature request RT #87330, trim whitespace after POD.
751 The flag -trp (--trim-pod) will trim trailing whitespace from lines of POD
755 - Fixed RT #86929, #86930, missing lhs of assignment.
757 - Fixed RT #84922, moved pod from Tidy.pm into Tidy.pod
761 - The flag -cab=n or --comma-arrow-breakpoints=n has been generalized
762 to give better control over breaking open short containers. The
763 possible values are now:
765 n=0 break at all commas after =>
766 n=1 stable: break at all commas after => if container is open,
767 EXCEPT FOR one-line containers
768 n=2 break at all commas after =>, BUT try to form the maximum
769 maximum one-line container lengths
770 n=3 do not treat commas after => specially at all
771 n=4 break everything: like n=0 but also break a short container with
772 a => not followed by a comma
773 n=5 stable: like n=1 but ALSO break at open one-line containers (default)
775 New values n=4 and n=5 have been added to allow short blocks to be
776 broken open. The new default is n=5, stable. It should more closely
777 follow the breaks in the input file, and previously formatted code
778 should remain unchanged. If this causes problems use -cab=1 to recover
779 the former behavior. Thanks to Tony Maszeroski for the suggestion.
781 To illustrate the need for the new options, if perltidy is given
782 the following code, then the old default (-cab=1) was to close up
783 the 'index' container even if it was open in the source. The new
784 default (-cab=5) will keep it open if it was open in the source.
799 - New debug flag --memoize (-mem). This version contains a
800 patch supplied by Jonathan Swartz which can significantly speed up
801 repeated calls to Perl::Tidy::perltidy in a single process by caching
802 the result of parsing the formatting parameters. A factor of up to 10
803 speedup was achieved for masontidy (https://metacpan.org/module/masontidy).
804 The memoization patch is on by default but can be deactivated for
805 testing with -nmem (or --no-memoize).
807 - New flag -tso (--tight-secret-operators) causes certain perl operator
808 sequences (secret operators) to be formatted "tightly" (without spaces).
809 The most common of these are 0 + and + 0 which become 0+ and +0. The
810 operators currently modified by this flag are:
811 =( )= 0+ +0 ()x!! ~~<> ,=>
812 Suggested by by Philippe Bruhat. See https://metacpan.org/module/perlsecret
813 This flag is off by default.
815 - New flag -vmll (--variable-maximum-line-length) makes the maximum
816 line length increase with the nesting depth of a line of code.
817 Basically, it causes the length of leading whitespace to be ignored when
818 setting line breaks, so the formatting of a block of code is independent
819 of its nesting depth. Try this option if you have deeply nested
820 code or data structures, perhaps in conjunction with the -wc flag
821 described next. The default is not todo this.
823 - New flag -wc=n (--whitespace-cycle=n) also addresses problems with
824 very deeply nested code and data structures. When this parameter is
825 used and the nesting depth exceeds the value n, the leading whitespace
826 will be reduced and start at 1 again. The result is that deeply
827 nested blocks of code will shift back to the left. This occurs cyclically
828 to any nesting depth. This flag may be used either with or without -vmll.
829 The default is not to use this (-wc=0).
831 - Fixed RT #78764, error parsing smartmatch operator followed by anonymous
832 hash or array and then a ternary operator; two examples:
834 qr/3/ ~~ ['1234'] ? 1 : 0;
835 map { $_ ~~ [ '0', '1' ] ? 'x' : 'o' } @a;
837 - Fixed problem with specifying spaces around arrows using -wls='->'
838 and -wrs='->'. Thanks to Alain Valleton for documenting this problem.
840 - Implemented RT #53183, wishlist, lines of code with the same indentation
841 level which are contained with multiple stacked opening and closing tokens
842 (requested with flags -sot -sct) now have reduced indentation.
853 # OLD: perltidy -sot -sct
860 # NEW: perltidy -sot -sct
867 - New flag -act=n (--all-containers-tightness=n) is an abbreviation for
868 -pt=n -sbt=n -bt=n -bbt=n, where n=0,1, or 2. It simplifies input when all
869 containers have the same tightness. Using the same example:
871 # NEW: perltidy -sot -sct -act=2
878 - New flag -sac (--stack-all-containers) is an abbreviation for -sot -sct
879 This is part of wishlist item RT #53183. Using the same example again:
881 # NEW: perltidy -sac -act=2
888 - new flag -scbb (--stack-closing-block-brace) causes isolated closing
889 block braces to stack as in the following example. (Wishlist item RT#73788)
896 push( @lines, "$w1 $w2 $w3 $w4\n" );
907 push( @lines, "$w1 $w2 $w3 $w4\n" );
910 There is, at present, no flag to place these closing braces at the end
911 of the previous line. It seems difficult to develop good rules for
912 doing this for a wide variety of code and data structures.
914 - Parameters defining block types may use a wildcard '*' to indicate
915 all block types. Previously it was not possible to include bare blocks.
917 - A flag -sobb (--stack-opening-block-brace) has been introduced as an
918 alias for -bbvt=2 -bbvtl='*'. So for example the following test code:
920 {{{{{{{ $testing }}}}}}}
922 cannot be formatted as above but can at least be kept vertically compact
923 using perltidy -sobb -scbb
925 { { { { { { { $testing
928 Or even, perltidy -sobb -scbb -i=1 -bbt=2
933 - Error message improved for conflicts due to -pbp; thanks to Djun Kim.
935 - Fixed RT #80645, error parsing special array name '@$' when used as
938 - Eliminated the -chk debug flag which was included in version 20010406 to
939 do a one-time check for a bug with multi-line quotes. It has not been
942 - Numerous other minor formatting improvements.
946 - Added flag -iscl (--ignore-side-comment-lengths) which causes perltidy
947 to ignore the length of side comments when setting line breaks,
948 RT #71848. The default is to include the length of side comments when
949 breaking lines to stay within the length prescribed by the -l=n
950 maximum line length parameter. For example,
952 Default behavior on a single line with long side comment:
953 $vmsfile =~ s/;[\d\-]*$//
954 ; # Clip off version number; we can use a newer version as well
956 perltidy -iscl leaves the line intact:
958 $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well
960 - Fixed RT #78182, side effects with STDERR. Error handling has been
961 revised and the documentation has been updated. STDERR can now be
962 redirected to a string reference, and perltidy now returns an
963 error flag instead of calling die when input errors are detected.
964 If the error flag is set then no tidied output was produced.
965 See man Perl::Tidy for an example.
967 - Fixed RT #78156, erroneous warning message for package VERSION syntax.
969 - Added abbreviations -conv (--converge) to simplify iteration control.
970 -conv is equivalent to -it=4 and will insure that the tidied code is
971 converged to its final state with the minimum number of iterations.
973 - Minor formatting modifications have been made to insure convergence.
975 - Simplified and hopefully improved the method for guessing the starting
976 indentation level of entabbed code. Added flag -dt=n (--default_tabsize=n)
977 which might be helpful if the guessing method does not work well for
980 - Added support for stacked labels, upper case X/B in hex and binary, and
983 - Eliminated warning messages for using keyword names as constants.
987 - Corrected problem introduced by using a chomp on scalar references, RT #77978
989 - Added support for Perl 5.14 package block syntax, RT #78114.
991 - A convergence test is made if three or more iterations are requested with
992 the -it=n parameter to avoid wasting computer time. Several hundred Mb of
993 code gleaned from the internet were searched with the results that:
994 - It is unusual for two iterations to be required unless a major
995 style change is being made.
996 - Only one case has been found where three iterations were required.
997 - No cases requiring four iterations have been found with this version.
998 For the previous version several cases where found the results could
999 oscillate between two semi-stable states. This version corrects this.
1001 So if it is important that the code be converged it is okay to set -it=4
1002 with this version and it will probably stop after the second iteration.
1004 - Improved ability to identify and retain good line break points in the
1005 input stream, such as at commas and equals. You can always tell
1006 perltidy to ignore old breakpoints with -iob.
1008 - Fixed glitch in which a terminal closing hash brace followed by semicolon
1009 was not outdented back to the leading line depth like other closing
1010 tokens. Thanks to Keith Neargarder for noting this.
1013 my ( $pre, $post ) = @{
1015 "pp_anonlist" => [ "[", "]" ],
1016 "pp_anonhash" => [ "{", "}" ]
1021 my ( $pre, $post ) = @{
1023 "pp_anonlist" => [ "[", "]" ],
1024 "pp_anonhash" => [ "{", "}" ]
1028 - Removed extra indentation given to trailing 'if' and 'unless' clauses
1029 without parentheses because this occasionally produced undesirable
1030 results. This only applies where parens are not used after the if or
1035 unless my ( $who, $actions ) =
1036 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1040 unless my ( $who, $actions ) =
1041 $clause =~ /^($who_re)((?:$action_re)+)$/o;
1045 - Updated perltidy to handle all quote modifiers defined for perl 5 version 16.
1047 - Side comment text in perltidyrc configuration files must now begin with
1048 at least one space before the #. Thus:
1051 -l=78 # Max line width is 78 cols
1053 -l=78# Max line width is 78 cols
1055 This is probably true of almost all existing perltidyrc files,
1056 but if you get an error message about bad parameters
1057 involving a '#' the first time you run this version, please check the side
1058 comments in your perltidyrc file, and add a space before the # if necessary.
1059 You can quickly see the contents your perltidyrc file, if any, with the
1064 The reason for this change is that some parameters naturally involve
1065 the # symbol, and this can get interpreted as a side comment unless the
1066 parameter is quoted. For example, to define -sphb=# it used to be necessary
1069 to keep the # from becoming part of a comment. This was causing
1070 trouble for new users. Now it can also be written without quotes:
1073 - Fixed bug in processing some .perltidyrc files containing parameters with
1074 an opening brace character, '{'. For example the following was
1075 incorrectly processed:
1076 --static-block-comment-prefix="^#{2,}[^\s#]"
1079 - Added flag -boa (--break-at-old-attribute-breakpoints) which retains
1080 any existing line breaks at attribute separation ':'. This is now the
1081 default, use -nboa to deactivate. Thanks to Daphne Phister for the patch.
1082 For example, given the following code, the line breaks at the ':'s will be
1088 : Get('Name' => 'foo') : Set('Name');
1090 whereas the previous version would have output a single line. If
1091 the attributes are on a single line then they will remain on a single line.
1093 - Added new flags --blank-lines-before-subs=n (-blbs=n) and
1094 --blank-lines-before-packages=n (-blbp=n) to put n blank lines before
1095 subs and packages. The old flag -bbs is now equivalent to -blbs=1 -blbp=1.
1096 and -nbbs is equivalent to -blbs=0 -blbp=0. Requested by M. Schwern and
1099 - Added feature -nsak='*' meaning no space between any keyword and opening
1100 paren. This avoids listing entering a long list of keywords. Requested
1103 - Added option to delete a backup of original file with in-place-modify (-b)
1104 if there were no errors. This can be requested with the flag -bext='/'.
1105 See documentation for details. Requested by M. Schwern and others.
1107 - Fixed bug where the module postfilter parameter was not applied when -b
1108 flag was used. This was discovered during testing.
1110 - Fixed in-place-modify (-b) to work with symbolic links to source files.
1111 Thanks to Ted Johnson.
1113 - Fixed bug where the Perl::Tidy module did not allow -b to be used
1116 - No extra blank line is added before a comment which follows
1117 a short line ending in an opening token, for example like this:
1121 # unless we follow a blank or comment line
1122 $last_line_leading_type !~ /^[#b]$/
1127 # unless we follow a blank or comment line
1128 $last_line_leading_type !~ /^[#b]$/
1131 The blank is not needed for readability in these cases because there
1132 already is already space above the comment. If a blank already
1133 exists there it will not be removed, so this change should not
1134 change code which has previously been formatted with perltidy.
1135 Thanks to R.W.Stauner.
1137 - Likewise, no extra blank line is added above a comment consisting of a
1138 single #, since nothing is gained in readability.
1140 - Fixed error in which a blank line was removed after a #>>> directive.
1141 Thanks to Ricky Morse.
1143 - Unnecessary semicolons after given/when/default blocks are now removed.
1145 - Fixed bug where an unwanted blank line could be added before
1146 pod text in __DATA__ or __END__ section. Thanks to jidani.
1148 - Changed exit flags from 1 to 0 to indicate success for -help, -version,
1149 and all -dump commands. Also added -? as another way to dump the help.
1150 Requested by Keith Neargarder.
1152 - Fixed bug where .ERR and .LOG files were not written except for -it=2 or more
1154 - Fixed bug where trailing blank lines at the end of a file were dropped when
1157 - Fixed bug where a line occasionally ended with an extra space. This reduces
1158 rhe number of instances where a second iteration gives a result different
1161 - Updated documentation to note that the Tidy.pm module <stderr> parameter may
1162 not be a reference to SCALAR or ARRAY; it must be a file.
1164 - Syntax check with perl now work when the Tidy.pm module is processing
1165 references to arrays and strings. Thanks to Charles Alderman.
1167 - Zero-length files are no longer processed due to concerns for data loss
1168 due to side effects in some scenarios.
1170 - block labels, if any, are now included in closing side comment text
1171 when the -csc flag is used. Suggested by Aaron. For example,
1172 the label L102 in the following block is now included in the -csc text:
1174 L102: for my $i ( 1 .. 10 ) {
1176 } ## end L102: for my $i ( 1 .. 10 )
1180 - added new flag -it=n or --iterations=n
1181 This flag causes perltidy to do n complete iterations.
1182 For most purposes the default of n=1 should be satisfactory. However n=2
1183 can be useful when a major style change is being made, or when code is being
1184 beautified on check-in to a source code control system. The run time will be
1185 approximately proportional to n, and it should seldom be necessary to use a
1186 value greater than n=2. Thanks to Jonathan Swartz
1188 - A configuration file pathname begins with three dots, e.g.
1189 ".../.perltidyrc", indicates that the file should be searched for starting
1190 in the current directory and working upwards. This makes it easier to have
1191 multiple projects each with their own .perltidyrc in their root directories.
1192 Thanks to Jonathan Swartz for this patch.
1194 - Added flag --notidy which disables all formatting and causes the input to be
1195 copied unchanged. This can be useful in conjunction with hierarchical
1196 F<.perltidyrc> files to prevent unwanted tidying.
1197 Thanks to Jonathan Swartz for this patch.
1199 - Added prefilters and postfilters in the call to the Tidy.pm module.
1200 Prefilters and postfilters. The prefilter is a code reference that
1201 will be applied to the source before tidying, and the postfilter
1202 is a code reference to the result before outputting.
1204 Thanks to Jonathan Swartz for this patch. He writes:
1205 This is useful for all manner of customizations. For example, I use
1206 it to convert the 'method' keyword to 'sub' so that perltidy will work for
1207 Method::Signature::Simple code:
1209 Perl::Tidy::perltidy(
1210 prefilter => sub { $_ = $_[0]; s/^method (.*)/sub $1 \#__METHOD/gm; return $_ },
1211 postfilter => sub { $_ = $_[0]; s/^sub (.*?)\s* \#__METHOD/method $1/gm; return $_ }
1214 - The starting indentation level of sections of code entabbed with -et=n
1215 is correctly guessed if it was also produced with the same -et=n flag. This
1216 keeps the indentation stable on repeated formatting passes within an editor.
1217 Thanks to Sam Kington and Glenn.
1219 - Functions with prototype '&' had a space between the function and opening
1220 peren. This space now only occurs if the flag --space-function-paren (-sfp)
1221 is set. Thanks to Zrajm Akfohg.
1223 - Patch to never put spaces around a bare word in braces beginning with ^ as in:
1224 my $before = ${^PREMATCH};
1225 even if requested with the -bt=0 flag because any spaces cause a syntax error in perl.
1226 Thanks to Fabrice Dulanoy.
1230 - Allow configuration file to be 'perltidy.ini' for Windows systems.
1231 i.e. C:\Documents and Settings\User\perltidy.ini
1232 and added documentation for setting configuation file under Windows in man
1233 page. Thanks to Stuart Clark.
1235 - Corrected problem of unwanted semicolons in hash ref within given/when code.
1236 Thanks to Nelo Onyiah.
1238 - added new flag -cscb or --closing-side-comments-balanced
1239 When using closing-side-comments, and the closing-side-comment-maximum-text
1240 limit is exceeded, then the comment text must be truncated. Previous
1241 versions of perltidy terminate with three dots, and this can still be
1242 achieved with -ncscb:
1244 perltidy -csc -ncscb
1246 } ## end foreach my $foo (sort { $b cmp $a ...
1248 However this causes a problem with older editors which cannot recognize
1249 comments or are not configured to doso because they cannot "bounce" around in
1250 the text correctly. The B<-cscb> flag tries to help them by
1251 appending appropriate terminal balancing structure:
1255 } ## end foreach my $foo (sort { $b cmp $a ... })
1257 Since there is much to be gained and little to be lost by doing this,
1258 the default is B<-cscb>. Use B<-ncscb> if you do not want this.
1260 Thanks to Daniel Becker for suggesting this option.
1262 - After an isolated closing eval block the continuation indentation will be
1263 removed so that the braces line up more like other blocks. Thanks to Yves Orton.
1282 -A new flag -asbl (or --opening-anonymous-sub-brace-on-new-line) has
1283 been added to put the opening brace of anonymous sub's on a new line,
1284 as in the following snippet:
1292 This was not possible before because the -sbl flag only applies to named
1293 subs. Thanks to Benjamin Krupp.
1295 -Fix tokenization bug with the following snippet
1296 print 'hi' if { x => 1, }->{x};
1297 which resulted in a semicolon being added after the comma. The workaround
1298 was to use -nasc, but this is no longer necessary. Thanks to Brian Duggan.
1300 -Fixed problem in which an incorrect error message could be triggered
1301 by the (unusual) combination of parameters -lp -i=0 -l=2 -ci=0 for
1302 example. Thanks to Richard Jelinek.
1304 -A new flag --keep-old-blank-lines=n has been added to
1305 give more control over the treatment of old blank lines in
1306 a script. The manual has been revised to discuss the new
1307 flag and clarify the treatment of old blank lines. Thanks
1312 -Improved support for perl 5.10: New quote modifier 'p', new block type UNITCHECK,
1313 new keyword break, improved formatting of given/when.
1315 -Corrected tokenization bug of something like $var{-q}.
1317 -Numerous minor formatting improvements.
1319 -Corrected list of operators controlled by -baao -bbao to include
1320 . : ? && || and or err xor
1322 -Corrected very minor error in log file involving incorrect comment
1323 regarding need for upper case of labels.
1325 -Fixed problem where perltidy could run for a very long time
1326 when given certain non-perl text files.
1328 -Line breaks in un-parenthesized lists now try to follow
1329 line breaks in the input file rather than trying to fill
1330 lines. This usually works better, but if this causes
1331 trouble you can use -iob to ignore any old line breaks.
1332 Example for the following input snippet:
1335 "conformability (Not the same dimension)\n",
1336 "\t", $have, " is ", text_unit($hu), "\n",
1337 "\t", $want, " is ", text_unit($wu), "\n",
1341 print "conformability (Not the same dimension)\n", "\t", $have, " is ",
1342 text_unit($hu), "\n", "\t", $want, " is ", text_unit($wu), "\n",;
1345 print "conformability (Not the same dimension)\n",
1346 "\t", $have, " is ", text_unit($hu), "\n",
1347 "\t", $want, " is ", text_unit($wu), "\n",
1352 -Added -fpsc option (--fixed-position-side-comment). Thanks to Ueli Hugenschmidt.
1353 For example -fpsc=40 tells perltidy to put side comments in column 40
1356 -Added -bbao and -baao options (--break-before-all-operators and
1357 --break-after-all-operators) to simplify command lines and configuration
1358 files. These define an initial preference for breaking at operators which can
1359 be modified with -wba and -wbb flags. For example to break before all operators
1360 except an = one could use --bbao -wba='=' rather than listing every
1361 single perl operator (except =) on a -wbb flag.
1363 -Added -kis option (--keep-interior-semicolons). Use the B<-kis> flag
1364 to prevent breaking at a semicolon if there was no break there in the
1365 input file. To illustrate, consider the following input lines:
1367 dbmclose(%verb_delim); undef %verb_delim;
1368 dbmclose(%expanded); undef %expanded;
1369 dbmclose(%global); undef %global;
1371 Normally these would be broken into six lines, but
1372 perltidy -kis gives:
1374 dbmclose(%verb_delim); undef %verb_delim;
1375 dbmclose(%expanded); undef %expanded;
1376 dbmclose(%global); undef %global;
1378 -Improved formatting of complex ternary statements, with indentation
1379 of nested statements.
1381 return defined( $cw->{Selected} )
1383 ? @{ $cw->{Selected} }
1384 : $cw->{Selected}[0]
1388 return defined( $cw->{Selected} )
1390 ? @{ $cw->{Selected} }
1391 : $cw->{Selected}[0]
1394 -Text following un-parenthesized if/unless/while/until statements get a
1395 full level of indentation. Suggested by Jeff Armstrong and others.
1397 return $ship->chargeWeapons("phaser-canon")
1398 if $encounter->description eq 'klingon'
1399 and $ship->firepower >= $encounter->firepower
1400 and $location->status ne 'neutral';
1402 return $ship->chargeWeapons("phaser-canon")
1403 if $encounter->description eq 'klingon'
1404 and $ship->firepower >= $encounter->firepower
1405 and $location->status ne 'neutral';
1409 -Fixed bug where #line directives were being indented. Thanks to
1414 -Fixed problem where an extra blank line was added after an =cut when either
1415 (a) the =cut started (not stopped) a POD section, or (b) -mbl > 1.
1416 Thanks to J. Robert Ray and Bill Moseley.
1420 -ole (--output-line-ending) and -ple (--preserve-line-endings) should
1421 now work on all systems rather than just unix systems. Thanks to Dan
1424 -Fixed problem of a warning issued for multiple subs for BEGIN subs
1425 and other control subs. Thanks to Heiko Eissfeldt.
1427 -Fixed problem where no space was introduced between a keyword or
1428 bareword and a colon, such as:
1430 ( ref($result) eq 'HASH' && !%$result ) ? undef: $result;
1434 -Added a utility program 'break_long_quotes.pl' to the examples directory of
1435 the distribution. It breaks long quoted strings into a chain of concatenated
1436 sub strings no longer than a selected length. Suggested by Michael Renner as
1437 a perltidy feature but was judged to be best done in a separate program.
1439 -Updated docs to remove extra < and >= from list of tokens
1440 after which breaks are made by default. Thanks to Bob Kleemann.
1442 -Removed improper uses of $_ to avoid conflicts with external calls, giving
1443 error message similar to:
1444 Modification of a read-only value attempted at
1445 /usr/share/perl5/Perl/Tidy.pm line 6907.
1446 Thanks to Michael Renner.
1448 -Fixed problem when errorfile was not a plain filename or filehandle
1449 in a call to Tidy.pm. The call
1450 perltidy(source => \$input, destination => \$output, errorfile => \$err);
1451 gave the following error message:
1452 Not a GLOB reference at /usr/share/perl5/Perl/Tidy.pm line 3827.
1453 Thanks to Michael Renner and Phillipe Bruhat.
1455 -Fixed problem where -sot would not stack an opening token followed by
1456 a side comment. Thanks to Jens Schicke.
1458 -improved breakpoints in complex math and other long statements. Example:
1461 log($n) + 0.577215664901532 + ( 1 / ( 2 * $n ) ) -
1462 ( 1 / ( 12 * ( $n**2 ) ) ) + ( 1 / ( 120 * ( $n**4 ) ) );
1465 log($n) + 0.577215664901532 +
1466 ( 1 / ( 2 * $n ) ) -
1467 ( 1 / ( 12 * ( $n**2 ) ) ) +
1468 ( 1 / ( 120 * ( $n**4 ) ) );
1470 -more robust vertical alignment of complex terminal else blocks and ternary
1475 -Eliminated bug where a here-doc invoked through an 'e' modifier on a pattern
1476 replacement text was not recognized. The tokenizer now recursively scans
1477 replacement text (but does not reformat it).
1479 -improved vertical alignment of terminal else blocks and ternary statements.
1480 Thanks to Chris for the suggestion.
1483 if ( IsBitmap() ) { return GetBitmap(); }
1484 elsif ( IsFiles() ) { return GetFiles(); }
1485 else { return GetText(); }
1488 if ( IsBitmap() ) { return GetBitmap(); }
1489 elsif ( IsFiles() ) { return GetFiles(); }
1490 else { return GetText(); }
1494 $opts{"t"} ? 'title'
1495 : $opts{"s"} ? 'subject'
1496 : $opts{"a"} ? 'author'
1501 $opts{"t"} ? 'title'
1502 : $opts{"s"} ? 'subject'
1503 : $opts{"a"} ? 'author'
1506 -improved indentation of try/catch blocks and other externally defined
1507 functions accepting a block argument. Thanks to jae.
1509 -Added support for Perl 5.10 features say and smartmatch.
1511 -Added flag -pbp (--perl-best-practices) as an abbreviation for parameters
1512 suggested in Damian Conway's "Perl Best Practices". -pbp is the same as:
1514 -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
1515 -wbb="% + - * / x != == >= <= =~ !~ < > | & >= < =
1516 **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
1518 Please note that the -st here restricts input to standard input; use
1519 -nst if necessary to override.
1521 -Eliminated some needless breaks at equals signs in -lp indentation.
1525 Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
1526 TOP + $y * (BOTTOM - TOP) / SIZE);
1528 $c = Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
1529 TOP + $y * (BOTTOM - TOP) / SIZE);
1531 A break at an equals is sometimes useful for preventing complex statements
1532 from hitting the line length limit. The decision to do this was
1533 over-eager in some cases and has been improved. Thanks to Royce Reece.
1535 -qw quotes contained in braces, square brackets, and parens are being
1536 treated more like those containers as far as stacking of tokens. Also
1537 stack of closing tokens ending ');' will outdent to where the ');' would
1538 have outdented if the closing stack is matched with a similar opening stack.
1540 OLD: perltidy -soc -sct
1541 __PACKAGE__->load_components(
1547 NEW: perltidy -soc -sct
1548 __PACKAGE__->load_components( qw(
1552 Thanks to Aran Deltac
1554 -Eliminated some undesirable or marginally desirable vertical alignments.
1555 These include terminal colons, opening braces, and equals, and particularly
1556 when just two lines would be aligned.
1559 my $accurate_timestamps = $Stamps{lnk};
1563 my $accurate_timestamps = $Stamps{lnk};
1566 -Corrected a problem with -mangle in which a space would be removed
1567 between a keyword and variable beginning with ::.
1571 -Attribute argument lists are now correctly treated as quoted strings
1572 and not formatted. This is the most important update in this version.
1573 Thanks to Borris Zentner, Greg Ferguson, Steve Kirkup.
1575 -Updated to recognize the defined or operator, //, to be released in Perl 10.
1576 Thanks to Sebastien Aperghis-Tramoni.
1578 -A useful utility perltidyrc_dump.pl is included in the examples section. It
1579 will read any perltidyrc file and write it back out in a standard format
1580 (though comments are lost).
1582 -Added option to have perltidy read and return a hash with the contents of a
1583 perltidyrc file. This may be used by Leif Eriksen's tidyview code. This
1584 feature is used by the demonstration program 'perltidyrc_dump.pl' in the
1587 -Improved error checking in perltidyrc files. Unknown bare words were not
1590 -The --dump-options parameter now dumps parameters in the format required by a
1593 -V-Strings with underscores are now recognized.
1594 For example: $v = v1.2_3;
1596 -cti=3 option added which gives one extra indentation level to closing
1597 tokens always. This provides more predictable closing token placement
1598 than cti=2. If you are using cti=2 you might want to try cti=3.
1600 -To identify all left-adjusted comments as static block comments, use C<-sbcp='^#'>.
1602 -New parameters -fs, -fsb, -fse added to allow sections of code between #<<<
1603 and #>>> to be passed through verbatim. This is enabled by default and turned
1604 off by -nfs. Flags -fsb and -fse allow other beginning and ending markers.
1605 Thanks to Wolfgang Werner and Marion Berryman for suggesting this.
1607 -added flag -skp to put a space between all Perl keywords and following paren.
1608 The default is to only do this for certain keywords. Suggested by
1611 -added flag -sfp to put a space between a function name and following paren.
1612 The default is not to do this. Suggested by H.Merijn Brand.
1614 -Added patch to avoid breaking GetOpt::Long::Configure set by calling program.
1615 Thanks to Philippe Bruhat.
1617 -An error was fixed in which certain parameters in a .perltidyrc file given
1618 without the equals sign were not recognized. That is,
1619 '--brace-tightness 0' gave an error but '--brace-tightness=0' worked
1620 ok. Thanks to Zac Hansen.
1622 -An error preventing the -nwrs flag from working was corrected. Thanks to
1625 -Corrected some alignment problems with entab option.
1627 -A bug with the combination of -lp and -extrude was fixed (though this
1628 combination doesn't really make sense). The bug was that a line with
1629 a single zero would be dropped. Thanks to Cameron Hayne.
1631 -Updated Windows detection code to avoid an undefined variable.
1632 Thanks to Joe Yates and Russ Jones.
1634 -Improved formatting for short trailing statements following a closing paren.
1635 Thanks to Joe Matarazzo.
1637 -The handling of the -icb (indent closing block braces) flag has been changed
1638 slightly to provide more consistent and predictable formatting of complex
1639 structures. Instead of giving a closing block brace the indentation of the
1640 previous line, it is now given one extra indentation level. The two methods
1641 give the same result if the previous line was a complete statement, as in this
1650 The change also fixes a problem with empty blocks such as:
1660 -A problem with -icb was fixed in which a closing brace was misplaced when
1661 it followed a quote which spanned multiple lines.
1663 -Some improved breakpoints for -wba='&& || and or'
1665 -Fixed problem with misaligned cuddled else in complex statements
1666 when the -bar flag was also used. Thanks to Alex and Royce Reese.
1668 -Corrected documentation to show that --outdent-long-comments is the default.
1669 Thanks to Mario Lia.
1671 -New flag -otr (opening-token-right) is similar to -bar (braces-always-right)
1672 but applies to non-structural opening tokens.
1674 -new flags -sot (stack-opening-token), -sct (stack-closing-token).
1679 -The default has been changed to not do syntax checking with perl.
1680 Use -syn if you want it. Perltidy is very robust now, and the -syn
1681 flag now causes more problems than it's worth because of BEGIN blocks
1682 (which get executed with perl -c). For example, perltidy will never
1683 return when trying to beautify this code if -syn is used:
1685 BEGIN { 1 while { }; }
1687 Although this is an obvious error, perltidy is often run on untested
1688 code which is more likely to have this sort of problem. A more subtle
1691 BEGIN { use FindBin; }
1693 which may hang on some systems using -syn if a shared file system is
1696 -Changed style -gnu to use -cti=1 instead of -cti=2 (see next item).
1697 In most cases it looks better. To recover the previous format, use
1700 -Added flags -cti=n for finer control of closing token indentation.
1701 -cti = 0 no extra indentation (default; same as -nicp)
1702 -cti = 1 enough indentation so that the closing token
1703 aligns with its opening token.
1704 -cti = 2 one extra indentation level if the line has the form
1705 ); ]; or }; (same as -icp).
1707 The new option -cti=1 works well with -lp:
1711 # perltidy -lp -cti=1
1713 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1714 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
1717 # perltidy -lp -cti=2
1719 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1720 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
1722 This is backwards compatible with -icp. See revised manual for
1723 details. Suggested by Mike Pennington.
1725 -Added flag '--preserve-line-endings' or '-ple' to cause the output
1726 line ending to be the same as in the input file, for unix, dos,
1727 or mac line endings. Only works under unix. Suggested by
1730 -Added flag '--output-line-ending=s' or '-ole=s' where s=dos or win,
1731 unix, or mac. Only works under unix.
1733 -Files with Mac line endings should now be handled properly under unix
1734 and dos without being passed through a converter.
1736 -You may now include 'and', 'or', and 'xor' in the list following
1737 '--want-break-after' to get line breaks after those keywords rather than
1738 before them. Suggested by Rainer Hochschild.
1740 -Corrected problem with command line option for -vtc=n and -vt=n. The
1741 equals sign was being eaten up by the Windows shell so perltidy didn't
1746 -Corrected cause of warning message with recent versions of Perl:
1747 "Possible precedence problem on bitwise & operator at ..."
1748 Thanks to Jim Files.
1750 -fixed bug with -html with '=for pod2html' sections, in which code/pod
1751 output order was incorrect. Thanks to Tassilo von Parseval.
1753 -fixed bug when the -html flag is used, in which the following error
1754 message, plus others, appear:
1755 did not see <body> in pod2html output
1756 This was caused by a change in the format of html output by pod2html
1757 VERSION 1.04 (included with perl 5.8). Thanks to Tassilo von Parseval.
1759 -Fixed bug where an __END__ statement would be mistaken for a label
1760 if it is immediately followed by a line with a leading colon. Thanks
1763 -Implemented guessing logic for brace types when it is ambiguous. This
1764 has been on the TODO list a long time. Thanks to Boris Zentner for
1767 -Long options may now be negated either as '--nolong-option'
1768 or '--no-long-option'. Thanks to Philip Newton for the suggestion.
1770 -added flag --html-entities or -hent which controls the use of
1771 Html::Entities for html formatting. Use --nohtml-entities or -nhent to
1772 prevent the use of Html::Entities to encode special symbols. The
1773 default is -hent. Html::Entities when formatting perl text to escape
1774 special symbols. This may or may not be the right thing to do,
1775 depending on browser/language combinations. Thanks to Burak Gursoy for
1778 -Bareword strings with leading '-', like, '-foo' now count as 1 token
1779 for horizontal tightness. This way $a{'-foo'}, $a{foo}, and $a{-foo}
1780 are now all treated similarly. Thus, by default, OLD: $a{ -foo } will
1781 now be NEW: $a{-foo}. Suggested by Mark Olesen.
1783 -added 2 new flags to control spaces between keywords and opening parens:
1784 -sak=s or --space-after-keyword=s, and
1785 -nsak=s or --nospace-after-keyword=s, where 's' is a list of keywords.
1787 The new default list of keywords which get a space is:
1789 "my local our and or eq ne if else elsif until unless while for foreach
1790 return switch case given when"
1792 Use -sak=s and -nsak=s to add and remove keywords from this list,
1795 Explanation: Stephen Hildrey noted that perltidy was being inconsistent
1796 in placing spaces between keywords and opening parens, and sent a patch
1797 to give user control over this. The above list was selected as being
1798 a reasonable default keyword list. Previously, perltidy
1799 had a hardwired list which also included these keywords:
1801 push pop shift unshift join split die
1803 but did not have 'our'. Example: if you prefer to make perltidy behave
1804 exactly as before, you can include the following two lines in your
1807 -sak="push pop local shift unshift join split die"
1810 -Corrected html error in .toc file when -frm -html is used (extra ");
1811 browsers were tolerant of it.
1813 -Improved alignment of chains of binary and ?/: operators. Example:
1827 -improved breakpoint choices involving '->'
1829 -Corrected tokenization of things like ${#}. For example,
1830 ${#} is valid, but ${# } is a syntax error.
1832 -Corrected minor tokenization errors with indirect object notation.
1833 For example, 'new A::()' works now.
1835 -Minor tokenization improvements; all perl code distributed with perl 5.8
1836 seems to be parsed correctly except for one instance (lextest.t)
1841 -Implemented scalar attributes. Thanks to Sean Tobin for noting this.
1843 -Fixed glitch introduced in previous release where -pre option
1844 was not outputting a leading html <pre> tag.
1846 -Numerous minor improvements in vertical alignment, including the following:
1848 -Improved alignment of opening braces in many cases. Needed for improved
1849 switch/case formatting, and also suggested by Mark Olesen for sort/map/grep
1850 formatting. For example:
1855 sort { $a->[1] <=> $b->[1] }
1856 map { [ $_, -M ] } @filenames;
1861 sort { $a->[1] <=> $b->[1] }
1862 map { [ $_, -M ] } @filenames;
1864 -Eliminated alignments across unrelated statements. Example:
1866 $borrowerinfo->configure( -state => 'disabled' );
1867 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
1870 $borrowerinfo->configure( -state => 'disabled' );
1871 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
1873 Thanks to Mark Olesen for suggesting this.
1875 -Improved alignement of '='s in certain cases.
1876 Thanks to Norbert Gruener for sending an example.
1878 -Outdent-long-comments (-olc) has been re-instated as a default, since
1879 it works much better now. Use -nolc if you want to prevent it.
1881 -Added check for 'perltidy file.pl -o file.pl', which causes file.pl
1882 to be lost. (The -b option should be used instead). Thanks to mreister
1883 for reporting this problem.
1887 -Switch/case or given/when syntax is now recognized. Its vertical alignment
1888 is not great yet, but it parses ok. The words 'switch', 'case', 'given',
1889 and 'when' are now treated as keywords. If this causes trouble with older
1890 code, we could introduce a switch to deactivate it. Thanks to Stan Brown
1891 and Jochen Schneider for recommending this.
1893 -Corrected error parsing sub attributes with call parameters.
1894 Thanks to Marc Kerr for catching this.
1896 -Sub prototypes no longer need to be on the same line as sub names.
1898 -a new flag -frm or --frames will cause html output to be in a
1899 frame, with table of contents in the left panel and formatted source
1900 in the right panel. Try 'perltidy -html -frm somemodule.pm' for example.
1902 -The new default for -html formatting is to pass the pod through Pod::Html.
1903 The result is syntax colored code within your pod documents. This can be
1904 deactivated with -npod. Thanks to those who have written to discuss this,
1905 particularly Mark Olesen and Hugh Myers.
1907 -the -olc (--outdent-long-comments) option works much better. It now outdents
1908 groups of consecutive comments together, and by just the amount needed to
1909 avoid having any one line exceeding the maximum line length.
1911 -block comments are now trimmed of trailing whitespace.
1913 -if a directory specified with -opath does not exist, it will be created.
1915 -a table of contents to packages and subs is output when -html is used.
1916 Use -ntoc to prevent this.
1918 -fixed an unusual bug in which a 'for' statement following a 'format'
1919 statement was not correctly tokenized. Thanks to Boris Zentner for
1922 -Tidy.pm is no longer dependent on modules IO::Scalar and IO::ScalarArray.
1923 There were some speed issues. Suggested by Joerg Walter.
1925 -The treatment of quoted wildcards (file globs) is now system-independent.
1928 perltidy 'b*x.p[lm]'
1930 would match box.pl, box.pm, brinx.pm under any operating system. Of
1931 course, anything unquoted will be subject to expansion by any shell.
1933 -default color for keywords under -html changed from
1934 SaddleBrown (#8B4513) to magenta4 (#8B008B).
1936 -fixed an arg parsing glitch in which something like:
1938 would trigger the help message and exit, rather than operate on the
1943 -New option '-b' or '--backup-and-modify-in-place' will cause perltidy to
1944 overwrite the original file with the tidied output file. The original
1945 file will be saved with a '.bak' extension (which can be changed with
1946 -bext=s). Thanks to Rudi Farkas for the suggestion.
1948 -An index to all subs is included at the top of -html output, unless
1949 only the <pre> section is written.
1951 -Anchor lines of the form <a name="mysub"></a> are now inserted at key points
1952 in html output, such as before sub definitions, for the convenience of
1953 postprocessing scripts. Suggested by Howard Owen.
1955 -The cuddled-else (-ce) flag now also makes cuddled continues, like
1958 while ( ( $pack, $file, $line ) = caller( $i++ ) ) {
1964 Suggested by Simon Perreault.
1966 -Fixed bug in which an extra blank line was added before an =head or
1967 similar pod line after an __END__ or __DATA__ line each time
1968 perltidy was run. Also, an extra blank was being added after
1969 a terminal =cut. Thanks to Mike Birdsall for reporting this.
1973 -Fixed bug in which space was inserted in a hyphenated hash key:
1974 my $val = $myhash{USER-NAME};
1976 my $val = $myhash{USER -NAME};
1977 Thanks to an anonymous bug reporter at sourceforge.
1979 -Fixed problem with the '-io' ('--indent-only') where all lines
1980 were double spaced. Thanks to Nick Andrew for reporting this bug.
1982 -Fixed tokenization error in which something like '-e1' was
1985 -Corrected a rare problem involving older perl versions, in which
1986 a line break before a bareword caused problems with 'use strict'.
1987 Thanks to Wolfgang Weisselberg for noting this.
1989 -More syntax error checking added.
1991 -Outdenting labels (-ola) has been made the default, in order to follow the
1992 perlstyle guidelines better. It's probably a good idea in general, but
1993 if you do not want this, use -nola in your .perltidyrc file.
1995 -Updated rules for padding logical expressions to include more cases.
1996 Thanks to Wolfgang Weisselberg for helpful discussions.
1998 -Added new flag -osbc (--outdent-static-block-comments) which will
1999 outdent static block comments by 2 spaces (or whatever -ci equals).
2000 Requested by Jon Robison.
2004 -Corrected a bug, introduced in the previous release, in which some
2005 closing side comments (-csc) could have incorrect text. This is
2006 annoying but will be correct the next time perltidy is run with -csc.
2008 -Fixed bug where whitespace was being removed between 'Bar' and '()'
2009 in a use statement like:
2013 -Whenever possible, if a logical expression is broken with leading
2014 '&&', '||', 'and', or 'or', then the leading line will be padded
2015 with additional space to produce alignment. This has been on the
2016 todo list for a long time; thanks to Frank Steinhauer for reminding
2017 me to do it. Notice the first line after the open parens here:
2021 !param("rules.to.$linecount")
2022 && !param("rules.from.$linecount")
2023 && !param("rules.subject.$linecount")
2025 param("rules.fieldname.$linecount")
2026 && param("rules.fieldval.$linecount")
2028 && !param("rules.size.$linecount")
2029 && !param("rules.custom.$linecount")
2034 !param("rules.to.$linecount")
2035 && !param("rules.from.$linecount")
2036 && !param("rules.subject.$linecount")
2038 param("rules.fieldname.$linecount")
2039 && param("rules.fieldval.$linecount")
2041 && !param("rules.size.$linecount")
2042 && !param("rules.custom.$linecount")
2047 -Corrected a mistokenization of variables for a package with a name
2048 equal to a perl keyword. For example:
2052 sub qx{print "Hello from my::qx\n";}
2054 In this case, the leading 'my' was mistokenized as a keyword, and a
2055 space was being place between 'my' and '::'. This has been
2056 corrected. Thanks to Martin Sluka for discovering this.
2058 -A new flag -bol (--break-at-old-logic-breakpoints)
2059 has been added to control whether containers with logical expressions
2060 should be broken open. This is the default.
2062 -A new flag -bok (--break-at-old-keyword-breakpoints)
2063 has been added to follow breaks at old keywords which return lists,
2064 such as sort and map. This is the default.
2066 -A new flag -bot (--break-at-old-trinary-breakpoints) has been added to
2067 follow breaks at trinary (conditional) operators. This is the default.
2069 -A new flag -cab=n has been added to control breaks at commas after
2070 '=>' tokens. The default is n=1, meaning break unless this breaks
2071 open an existing on-line container.
2073 -A new flag -boc has been added to allow existing list formatting
2074 to be retained. (--break-at-old-comma-breakpoints). See updated manual.
2076 -A new flag -iob (--ignore-old-breakpoints) has been added to
2077 prevent the locations of old breakpoints from influencing the output
2080 -Corrected problem where nested parentheses were not getting full
2081 indentation. This has been on the todo list for some time; thanks
2082 to Axel Rose for a snippet demonstrating this issue.
2084 OLD: inner list is not indented
2088 $ret->name, $user->username, $user->host,
2089 $user->server->name, $user->nick, "H"
2097 $ret->name, $user->username, $user->host,
2098 $user->server->name, $user->nick, "H"
2102 -Code cleaned up by removing the following unused, undocumented flags.
2103 They should not be in any .perltidyrc files because they were just
2104 experimental flags which were never documented. Most of them placed
2105 artificial limits on spaces, and Wolfgang Weisselberg convinced me that
2106 most of them they do more harm than good by causing unexpected results.
2108 --maximum-continuation-indentation (-mci)
2109 --maximum-whitespace-columns
2110 --maximum-space-to-comment (-xsc)
2111 --big-space-jump (-bsj)
2113 -Pod file 'perltidy.pod' has been appended to the script 'perltidy', and
2114 Tidy.pod has been append to the module 'Tidy.pm'. Older MakeMaker's
2115 were having trouble.
2117 -A new flag -isbc has been added for more control on comments. This flag
2118 has the effect that if there is no leading space on the line, then the
2119 comment will not be indented, and otherwise it may be. If both -ibc and
2120 -isbc are set, then -isbc takes priority. Thanks to Frank Steinhauer
2121 for suggesting this.
2123 -A new document 'stylekey.pod' has been created to quickly guide new users
2124 through the maze of perltidy style parameters. An html version is
2125 on the perltidy web page. Take a look! It should be very helpful.
2127 -Parameters for controlling 'vertical tightness' have been added:
2128 -vt and -vtc are the main controls, but finer control is provided
2129 with -pvt, -pcvt, -bvt, -bcvt, -sbvt, -sbcvt. Block brace vertical
2130 tightness controls have also been added.
2131 See updated manual and also see 'stylekey.pod'. Simple examples:
2133 # perltidy -lp -vt=1 -vtc=1
2134 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2135 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
2137 # perltidy -lp -vt=1 -vtc=0
2138 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
2139 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
2142 -Lists which do not format well in uniform columns are now better
2143 identified and formated.
2146 return $c->create( 'polygon', $x, $y, $x + $ruler_info{'size'},
2147 $y + $ruler_info{'size'}, $x - $ruler_info{'size'},
2148 $y + $ruler_info{'size'} );
2153 $x + $ruler_info{'size'},
2154 $y + $ruler_info{'size'},
2155 $x - $ruler_info{'size'},
2156 $y + $ruler_info{'size'}
2160 radlablist($f1, pad('Initial', $p), $b->{Init}->get_panel_ref, 'None ',
2161 'None', 'Default', 'Default', 'Simple', 'Simple');
2165 $b->{Init}->get_panel_ref,
2166 'None ', 'None', 'Default', 'Default', 'Simple', 'Simple');
2168 -Corrected problem where an incorrect html filename was generated for
2169 external calls to Tidy.pm module. Fixed incorrect html title when
2170 Tidy.pm is called with IO::Scalar or IO::Array source.
2172 -Output file permissions are now set as follows. An output script file
2173 gets the same permission as the input file, except that owner
2174 read/write permission is added (otherwise, perltidy could not be
2175 rerun). Html output files use system defaults. Previously chmod 0755
2176 was used in all cases. Thanks to Mark Olesen for bringing this up.
2178 -Missing semicolons will not be added in multi-line blocks of type
2179 sort, map, or grep. This brings perltidy into closer agreement
2180 with common practice. Of course, you can still put semicolons
2181 there if you like. Thanks to Simon Perreault for a discussion of this.
2183 -Most instances of extra semicolons are now deleted. This is
2184 particularly important if the -csc option is used. Thanks to Wolfgang
2185 Weisselberg for noting this. For example, the following line
2186 (produced by 'h2xs' :) has an extra semicolon which will now be
2189 BEGIN { plan tests => 1 };
2191 -New parameter -csce (--closing-side-comment-else-flag) can be used
2192 to control what text is appended to 'else' and 'elsif' blocks.
2193 Default is to just add leading 'if' text to an 'else'. See manual.
2195 -The -csc option now labels 'else' blocks with additinal information
2196 from the opening if statement and elsif statements, if space.
2197 Thanks to Wolfgang Weisselberg for suggesting this.
2199 -The -csc option will now remove any old closing side comments
2200 below the line interval threshold. Thanks to Wolfgang Weisselberg for
2203 -The abbreviation feature, which was broken in the previous version,
2204 is now fixed. Thanks to Michael Cartmell for noting this.
2206 -Vertical alignment is now done for '||=' .. somehow this was
2211 -This version uses modules for the first time, and a standard perl
2212 Makefile.PL has been supplied. However, perltidy may still be
2213 installed as a single script, without modules. See INSTALL for
2216 -The man page 'perl2web' has been merged back into the main 'perltidy'
2217 man page to simplify installation. So you may remove that man page
2218 if you have an older installation.
2220 -Added patch from Axel Rose for MacPerl. The patch prompts the user
2221 for command line arguments before calling the module
2222 Perl::Tidy::perltidy.
2224 -Corrected bug with '-bar' which was introduced in the previous
2225 version. A closing block brace was being indented. Thanks to
2226 Alexandros M Manoussakis for reporting this.
2228 -New parameter '--entab-leading-whitespace=n', or '-et=n', has been
2229 added for those who prefer tabs. This behaves different from the
2230 existing '-t' parameter; see updated man page. Suggested by Mark
2233 -New parameter '--perl-syntax-check-flags=s' or '-pcsf=s' can be
2234 used to change the flags passed to perltidy in a syntax check.
2235 See updated man page. Suggested by Mark Olesen.
2237 -New parameter '--output-path=s' or '-opath=s' will cause output
2238 files to be placed in directory s. See updated man page. Thanks for
2239 Mark Olesen for suggesting this.
2241 -New parameter --dump-profile (or -dpro) will dump to
2242 standard output information about the search for a
2243 configuration file, the name of whatever configuration file
2244 is selected, and its contents. This should help debugging
2245 config files, especially on different Windows systems.
2247 -The -w parameter now notes possible errors of the form:
2249 $comment = s/^\s*(\S+)\..*/$1/; # trim whitespace
2251 -Corrections added for a leading ':' and for leaving a leading 'tcsh'
2252 line untouched. Mark Olesen reported that lines of this form were
2253 accepted by perl but not by perltidy:
2255 : # use -*- perl -*-
2256 eval 'exec perl -wS $0 "$@"' # shell should exec 'perl'
2257 unless 1; # but Perl should skip this one
2259 Perl will silently swallow a leading colon on line 1 of a
2260 script, and now perltidy will do likewise. For example,
2261 this is a valid script, provided that it is the first line,
2264 : print "Hello World\n";
2266 Also, perltidy will now mark a first line with leading ':' followed by
2267 '#' as type SYSTEM (just as a #! line), not to be formatted.
2269 -List formatting improved for certain lists with special
2270 initial terms, such as occur with 'printf', 'sprintf',
2271 'push', 'pack', 'join', 'chmod'. The special initial term is
2272 now placed on a line by itself. For example, perltidy -gnu
2276 "C4", hex($SourceAddr[0]),
2277 hex($SourceAddr[1]), hex($SourceAddr[2]),
2283 hex($SourceAddr[0]), hex($SourceAddr[1]),
2284 hex($SourceAddr[2]), hex($SourceAddr[3]));
2288 @{$$self{states}}, '64', '66', '68',
2289 '70', '72', '74', '76',
2290 '78', '80', '82', '84',
2291 '86', '88', '90', '92',
2292 '94', '96', '98', '100',
2299 '64', '66', '68', '70', '72', '74', '76',
2300 '78', '80', '82', '84', '86', '88', '90',
2301 '92', '94', '96', '98', '100', '102', '104'
2304 -Lists of complex items, such as matricies, are now detected
2305 and displayed with just one item per row:
2308 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2309 [ 1, tan( deg2rad($a) ), 0 ], [ tan( deg2rad($b) ), 1, 0 ],
2314 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2315 [ 1, tan( deg2rad($a) ), 0 ],
2316 [ tan( deg2rad($b) ), 1, 0 ],
2320 -The perl syntax check will be turned off for now when input is from
2321 standard input or standard output. The reason is that this requires
2322 temporary files, which has produced far too many problems during
2323 Windows testing. For example, the POSIX module under Windows XP/2000
2324 creates temporary names in the root directory, to which only the
2325 administrator should have permission to write.
2327 -Merged patch sent by Yves Orton to handle appropriate
2328 configuration file locations for different Windows varieties
2329 (2000, NT, Me, XP, 95, 98).
2331 -Added patch to properly handle a for/foreach loop without
2332 parens around a list represented as a qw. I didn't know this
2333 was possible until Wolfgang Weisselberg pointed it out:
2335 foreach my $key qw\Uno Due Tres Quadro\ {
2339 But Perl will give a syntax error without the $ variable; ie this will
2342 foreach qw\Uno Due Tres Quadro\ {
2346 -Merged Windows version detection code sent by Yves Orton. Perltidy
2347 now automatically turns off syntax checking for Win 9x/ME versions,
2348 and this has solved a lot of robustness problems. These systems
2349 cannot reliably handle backtick operators. See man page for
2352 -Merged VMS filename handling patch sent by Michael Cartmell. (Invalid
2353 output filenames were being created in some cases).
2355 -Numerous minor improvements have been made for -lp style indentation.
2357 -Long C-style 'for' expressions will be broken after each ';'.
2359 'perltidy -gnu' gives:
2362 for ($status = $db->seq($key, $value, R_CURSOR()) ; $status == 0
2363 and $key eq $origkey ; $status = $db->seq($key, $value, R_NEXT()))
2366 for ($status = $db->seq($key, $value, R_CURSOR()) ;
2367 $status == 0 and $key eq $origkey ;
2368 $status = $db->seq($key, $value, R_NEXT()))
2370 -For the -lp option, a single long term within parens
2371 (without commas) now has better alignment. For example,
2375 $self->throw("Must specify a known host, not $location,"
2376 . " possible values ("
2377 . join (",", sort keys %hosts) . ")");
2380 $self->throw("Must specify a known host, not $location,"
2381 . " possible values ("
2382 . join (",", sort keys %hosts) . ")");
2386 -This version is about 20 percent faster than the previous
2387 version as a result of optimization work. The largest gain
2388 came from switching to a dispatch hash table in the
2391 -perltidy -html will check to see if HTML::Entities is
2392 installed, and if so, it will use it to encode unsafe
2395 -Added flag -oext=ext to change the output file extension to
2396 be different from the default ('tdy' or 'html'). For
2399 perltidy -html -oext=htm filename
2401 will produce filename.htm
2403 -Added flag -cscw to issue warnings if a closing side comment would replace
2404 an existing, different side comments. See the man page for details.
2405 Thanks to Peter Masiar for helpful discussions.
2407 -Corrected tokenization error of signed hex/octal/binary numbers. For
2408 example, the first hex number below would have been parsed correctly
2409 but the second one was not:
2410 if ( ( $tmp >= 0x80_00_00 ) || ( $tmp < -0x80_00_00 ) ) { }
2412 -'**=' was incorrectly tokenized as '**' and '='. This only
2413 caused a problem with the -extrude opton.
2415 -Corrected a divide by zero when -extrude option is used
2417 -The flag -w will now contain all errors reported by 'perl -c' on the
2418 input file, but otherwise they are not reported. The reason is that
2419 perl will report lots of problems and syntax errors which are not of
2420 interest when only a small snippet is being formatted (such as missing
2421 modules and unknown bare words). Perltidy will always report all
2422 significant syntax errors that it finds, such as unbalanced braces,
2423 unless the -q (quiet) flag is set.
2425 -Merged modifications created by Hugh Myers into perltidy.
2426 These include a 'streamhandle' routine which allows perltidy
2427 as a module to operate on input and output arrays and strings
2428 in addition to files. Documentation and new packaging as a
2429 module should be ready early next year; This is an elegant,
2430 powerful update; many thanks to Hugh for contributing it.
2434 -added a tentative patch which tries to keep any existing breakpoints
2435 at lines with leading keywords map,sort,eval,grep. The idea is to
2436 improve formatting of sequences of list operations, as in a schwartzian
2440 my @sorted = map { $_->[0] }
2441 sort { $a->[1] <=> $b->[1] }
2442 map { [ $_, rand ] } @list;
2446 map { $_->[0] } sort { $a->[1] <=> $b->[1] } map { [ $_, rand ] } @list;
2449 my @sorted = map { $_->[0] }
2450 sort { $a->[1] <=> $b->[1] }
2451 map { [ $_, rand ] } @list;
2453 The new alignment is not as nice as the input, but this is an improvement.
2454 Thanks to Yves Orton for this suggestion.
2456 -modified indentation logic so that a line with leading opening paren,
2457 brace, or square bracket will never have less indentation than the
2458 line with the corresponding opening token. Here's a simple example:
2462 -text => "New Document",
2463 -command => \&new_document
2469 Note how the closing ');' is lined up with the first line, even
2470 though it closes a paren in the 'pack' line. That seems wrong.
2474 -text => "New Document",
2475 -command => \&new_document
2481 This seems nicer: you can up-arrow with an editor and arrive at the
2482 opening 'pack' line.
2484 -corrected minor glitch in which cuddled else (-ce) did not get applied
2485 to an 'unless' block, which should look like this:
2493 Thanks to Jeremy Mates for reporting this.
2495 -The man page has been reorganized to parameters easier to find.
2497 -Added check for multiple definitions of same subroutine. It is easy
2498 to introduce this problem when cutting and pasting. Perl does not
2499 complain about it, but it can lead to disaster.
2501 -The command -pro=filename or -profile=filename may be used to specify a
2502 configuration file which will override the default name of .perltidyrc.
2503 There must not be a space on either side of the '=' sign. I needed
2504 this to be able to easily test perltidy with a variety of different
2505 configuration files.
2507 -Side comment alignment has been improved somewhat across frequent level
2508 changes, as in short if/else blocks. Thanks to Wolfgang Weisselberg
2509 for pointing out this problem. For example:
2512 if ( ref $self ) { # Called as a method
2515 else { # Regular procedure call
2521 if ( ref $self ) { # Called as a method
2524 else { # Regular procedure call
2529 -New command -ssc (--static-side-comment) and related command allows
2530 side comments to be spaced close to preceding character. This is
2531 useful for displaying commented code as side comments.
2533 -New command -csc (--closing-side-comment) and several related
2534 commands allow comments to be added to (and deleted from) any or all
2535 closing block braces. This can be useful if you have to maintain large
2536 programs, especially those that you didn't write. See updated man page.
2537 Thanks to Peter Masiar for this suggestion. For a simple example:
2542 if ( !defined( $_[0] ) ) {
2543 print("Hello, World\n");
2546 print( $_[0], "\n" );
2550 This added '## end sub foo' to the closing brace.
2551 To remove it, perltidy -ncsc.
2553 -New commands -ola, for outdenting labels, and -okw, for outdenting
2554 selected control keywords, were implemented. See the perltidy man
2555 page for details. Thanks to Peter Masiar for this suggestion.
2557 -Hanging side comment change: a comment will not be considered to be a
2558 hanging side comment if there is no leading whitespace on the line.
2559 This should improve the reliability of identifying hanging side comments.
2560 Thanks to Peter Masiar for this suggestion.
2562 -Two new commands for outdenting, -olq (outdent-long-quotes) and -olc
2563 (outdent-long-comments), have been added. The original -oll
2564 (outdent-long-lines) remains, and now is an abbreviation for -olq and -olc.
2565 The new default is just -olq. This was necessary to avoid inconsistency with
2566 the new static block comment option.
2568 -Static block comments: to provide a way to display commented code
2569 better, the convention is used that comments with a leading '##' should
2570 not be formatted as usual. Please see '-sbc' (or '--static-block-comment')
2571 for documentation. It can be deactivated with with -nsbc, but
2572 should not normally be necessary. Thanks to Peter Masiar for this
2575 -Two changes were made to help show structure of complex lists:
2576 (1) breakpoints are forced after every ',' in a list where any of
2577 the list items spans multiple lines, and
2578 (2) List items which span multiple lines now get continuation indentation.
2580 The following example illustrates both of these points. Many thanks to
2581 Wolfgang Weisselberg for this snippet and a discussion of it; this is a
2582 significant formatting improvement. Note how it is easier to see the call
2583 parameters in the NEW version:
2586 assert( __LINE__, ( not defined $check )
2589 or $check eq "old", "Error in parameters",
2590 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
2591 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
2592 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef" );
2597 ( not defined $check )
2601 "Error in parameters",
2602 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
2603 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
2604 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef"
2607 Another example shows how this helps displaying lists:
2610 %{ $self->{COMPONENTS} } = (
2612 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
2614 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
2617 The structure is clearer with the added indentation:
2620 %{ $self->{COMPONENTS} } = (
2622 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
2624 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
2627 -The structure of nested logical expressions is now displayed better.
2628 Thanks to Wolfgang Weisselberg for helpful discussions. For example,
2629 note how the status of the final 'or' is displayed in the following:
2633 and null( $op->sibling )
2634 and $op->ppaddr eq "pp_null"
2635 and class($op) eq "UNOP"
2636 and ( ( $op->first->ppaddr =~ /^pp_(and|or)$/
2637 and $op->first->first->sibling->ppaddr eq "pp_lineseq" )
2638 or ( $op->first->ppaddr eq "pp_lineseq"
2639 and not null $op->first->first->sibling
2640 and $op->first->first->sibling->ppaddr eq "pp_unstack" ) ) );
2645 and null( $op->sibling )
2646 and $op->ppaddr eq "pp_null"
2647 and class($op) eq "UNOP"
2650 $op->first->ppaddr =~ /^pp_(and|or)$/
2651 and $op->first->first->sibling->ppaddr eq "pp_lineseq"
2653 or ( $op->first->ppaddr eq "pp_lineseq"
2654 and not null $op->first->first->sibling
2655 and $op->first->first->sibling->ppaddr eq "pp_unstack" )
2659 -A break will always be put before a list item containing a comma-arrow.
2660 This will improve formatting of mixed lists of this form:
2664 'text', 225, 20, -text => 'A Simple Plot',
2672 -text => 'A Simple Plot',
2677 -For convenience, the command -dac (--delete-all-comments) now also
2678 deletes pod. Likewise, -tac (--tee-all-comments) now also sends pod
2679 to a '.TEE' file. Complete control over the treatment of pod and
2680 comments is still possible, as described in the updated help message
2683 -The logic which breaks open 'containers' has been rewritten to be completely
2684 symmetric in the following sense: if a line break is placed after an opening
2685 {, [, or (, then a break will be placed before the corresponding closing
2686 token. Thus, a container either remains closed or is completely cracked
2689 -Improved indentation of parenthesized lists. For example,
2694 atan2( $GPSTempCompLong - $GPSLongitude,
2695 $GPSLatitude - $GPSTempCompLat ) * 180 / 3.14159265 );
2698 $GPSCompCourse = int(
2700 $GPSTempCompLong - $GPSLongitude,
2701 $GPSLatitude - $GPSTempCompLat
2702 ) * 180 / 3.14159265
2705 Further improvements will be made in future releases.
2707 -Some improvements were made in formatting small lists.
2709 -Correspondence between Input and Output line numbers reported in a
2710 .LOG file should now be exact. They were sometimes off due to the size
2711 of intermediate buffers.
2713 -Corrected minor tokenization error in which a ';' in a foreach loop
2714 control was tokenized as a statement termination, which forced a
2727 foreach ( $i = 0 ; $i <= 10 ; $i += 2 ) {
2731 -Corrected a problem with reading config files, in which quote marks were not
2732 stripped. As a result, something like -wba="&& . || " would have the leading
2733 quote attached to the && and not work correctly. A workaround for older
2734 versions is to place a space around all tokens within the quotes, like this:
2737 -Removed any existing space between a label and its ':'
2740 This was necessary because the label and its colon are a single token.
2742 -Corrected tokenization error for the following (highly non-recommended)
2744 $user = @vars[1] / 100;
2746 -Resolved cause of a difference between perltidy under perl v5.6.1 and
2747 5.005_03; the problem was different behavior of \G regex position
2752 -Corrected a bug in which a break was not being made after a full-line
2753 comment within a short eval/sort/map/grep block. A flag was not being
2754 zeroed. The syntax error check catches this. Here is a snippet which
2755 illustrates the bug:
2758 #open Socket to Dispatcher
2759 $sock = &OpenSocket;
2762 The formatter mistakenly thought that it had found the following
2765 eval {#open Socket to Dispatcher$sock = &OpenSocket; };
2767 The patch fixes this. Many thanks to Henry Story for reporting this bug.
2769 -Changes were made to help diagnose and resolve problems in a
2771 (1) processing of command parameters has been into two separate
2772 batches so that any errors in a .perltidyrc file can be localized.
2773 (2) commands --help, --version, and as many of the --dump-xxx
2774 commands are handled immediately, without any command line processing
2776 (3) Perltidy will ignore any commands in the .perltidyrc file which
2777 cause immediate exit. These are: -h -v -ddf -dln -dop -dsn -dtt
2778 -dwls -dwrs -ss. Thanks to Wolfgang Weisselberg for helpful
2779 suggestions regarding these updates.
2781 -Syntax check has been reinstated as default for MSWin32 systems. This
2782 way Windows 2000 users will get syntax check by default, which seems
2783 like a better idea, since the number of Win 95/98 systems will be
2784 decreasing over time. Documentation revised to warn Windows 95/98
2785 users about the problem with empty '&1'. Too bad these systems
2786 all report themselves as MSWin32.
2790 -Fixed tokenization error in which a method call of the form
2794 got a space before the '::' like this:
2798 Thanks to David Holden for reporting this.
2800 -Added -html control over pod text, using a new abbreviation 'pd'. See
2801 updated perl2web man page. The default is to use the color of a comment,
2802 but italicized. Old .css style sheets will need a new line for
2803 .pd to use this. The old color was the color of a string, and there
2806 -.css lines are now printed in sorted order.
2808 -Fixed interpolation problem where html files had '$input_file' as title
2809 instead of actual input file name. Thanks to Simon Perreault for finding
2810 this and sending a patch, and also to Tobias Weber.
2812 -Breaks will now have the ':' placed at the start of a line,
2813 one per line by default because this shows logical structure
2814 more clearly. This coding has been completely redone. Some
2815 examples of new ?/: formatting:
2818 wantarray ? map( $dir::cwd->lookup($_)->path, @_ ) :
2819 $dir::cwd->lookup( $_[0] )->path;
2823 ? map( $dir::cwd->lookup($_)->path, @_ )
2824 : $dir::cwd->lookup( $_[0] )->path;
2830 } : { a => 6, b => 8 };
2838 : { a => 6, b => 8 };
2841 $self->note($self->{skip} ? "Hunk #$self->{hunk} ignored at 1.\n" :
2842 "Hunk #$self->{hunk} failed--$@");
2845 $self->note($self->{skip}
2846 ? "Hunk #$self->{hunk} ignored at 1.\n"
2847 : "Hunk #$self->{hunk} failed--$@");
2851 $opts{"t"} ? 'title' :
2852 $opts{"s"} ? 'subject' : $opts{"a"} ? 'author' : 'title';
2856 $opts{"t"} ? 'title'
2857 : $opts{"s"} ? 'subject'
2858 : $opts{"a"} ? 'author'
2861 You can use -wba=':' to recover the previous default which placed ':'
2862 at the end of a line. Thanks to Michael Cartmell for helpful
2863 discussions and examples.
2865 -Tokenizer updated to do syntax checking for matched ?/: pairs. Also,
2866 the tokenizer now outputs a unique serial number for every balanced
2867 pair of brace types and ?/: pairs. This greatly simplifies the
2870 -Long lines with repeated 'and', 'or', '&&', '||' will now have
2871 one such item per line. For example:
2874 if ( $opt_d || $opt_m || $opt_p || $opt_t || $opt_x
2875 || ( -e $archive && $opt_r ) )
2877 ( $pAr, $pNames ) = readAr($archive);
2886 || ( -e $archive && $opt_r ) )
2888 ( $pAr, $pNames ) = readAr($archive);
2892 if ( $vp->{X0} + 4 <= $x && $vp->{X0} + $vp->{W} - 4 >= $x
2893 && $vp->{Y0} + 4 <= $y && $vp->{Y0} + $vp->{H} - 4 >= $y )
2896 if ( $vp->{X0} + 4 <= $x
2897 && $vp->{X0} + $vp->{W} - 4 >= $x
2898 && $vp->{Y0} + 4 <= $y
2899 && $vp->{Y0} + $vp->{H} - 4 >= $y )
2901 -Long lines with multiple concatenated tokens will have concatenated
2902 terms (see below) placed one per line, except for short items. For
2907 "Device type:" . $ib->family . " ID:" . $ib->serial . " CRC:"
2908 . $ib->crc . ": " . $ib->model() . "\n";
2911 $report .= "Device type:"
2912 . $ib->family . " ID:"
2913 . $ib->serial . " CRC:"
2915 . $ib->crc . ": " . "\n";
2917 NOTE: at present 'short' means 8 characters or less. There is a
2918 tentative flag to change this (-scl), but it is undocumented and
2919 is likely to be changed or removed later, so only use it for testing.
2920 In the above example, the tokens " ID:", " CRC:", and "\n" are below
2923 -If a line which is short enough to fit on a single line was
2924 nevertheless broken in the input file at a 'good' location (see below),
2925 perltidy will try to retain a break. For example, the following line
2926 will be formatted as:
2929 or die "Cannot open $file ($!)";
2931 if it was broken in the input file, and like this if not:
2933 open SUM, "<$file" or die "Cannot open $file ($!)";
2935 GOOD: 'good' location means before 'and','or','if','unless','&&','||'
2937 The reason perltidy does not just always break at these points is that if
2938 there are multiple, similar statements, this would preclude alignment. So
2939 rather than check for this, perltidy just tries to follow the input style,
2940 in the hopes that the author made a good choice. Here is an example where
2941 we might not want to break before each 'if':
2943 ($Locale, @Locale) = ($English, @English) if (@English > @Locale);
2944 ($Locale, @Locale) = ($German, @German) if (@German > @Locale);
2945 ($Locale, @Locale) = ($French, @French) if (@French > @Locale);
2946 ($Locale, @Locale) = ($Spanish, @Spanish) if (@Spanish > @Locale);
2948 -Added wildcard file expansion for systems with shells which lack this.
2949 Now 'perltidy *.pl' should work under MSDOS/Windows. Thanks to Hugh Myers
2950 for suggesting this. This uses builtin glob() for now; I may change that.
2952 -Added new flag -sbl which, if specified, overrides the value of -bl
2953 for opening sub braces. This allows formatting of this type:
2959 if (!defined($_[0])) {
2960 print("Hello, World\n");
2966 Requested by Don Alexander.
2968 -Fixed minor parsing error which prevented a space after a $$ variable
2969 (pid) in some cases. Thanks to Michael Cartmell for noting this.
2974 -Improved line break choices 'and' and 'or' to display logic better.
2978 exists $self->{'build_dir'} and push @e,
2979 "Unwrapped into directory $self->{'build_dir'}";
2982 exists $self->{'build_dir'}
2983 and push @e, "Unwrapped into directory $self->{'build_dir'}";
2985 -Fixed error of multiple use of abbreviatioin '-dsc'. -dsc remains
2986 abbreviation for delete-side-comments; -dsm is new abbreviation for
2989 -Corrected and updated 'usage' help routine. Thanks to Slaven Rezic for
2992 -The default for Windows is, for now, not to do a 'perl -c' syntax
2993 check (but -syn will activate it). This is because of problems with
2994 command.com. James Freeman sent me a patch which tries to get around
2995 the problems, and it works in many cases, but testing revealed several
2996 issues that still need to be resolved. So for now, the default is no
2997 syntax check for Windows.
2999 -I added a -T flag when doing perl -c syntax check.
3000 This is because I test it on a large number of scripts from sources
3001 unknown, and who knows what might be hidden in initialization blocks?
3002 Also, deactivated the syntax check if perltidy is run as root. As a
3003 benign example, running the previous version of perltidy on the
3004 following file would cause it to disappear:
3007 print "Bye, bye baby!\n";
3011 The new version will not let that happen.
3013 -I am contemplating (but have not yet implemented) making '-lp' the
3014 default indentation, because it is stable now and may be closer to how
3015 perl is commonly formatted. This could be in the next release. The
3016 reason that '-lp' was not the original default is that the coding for
3017 it was complex and not ready for the initial release of perltidy. If
3018 anyone has any strong feelings about this, I'd like to hear. The
3019 current default could always be recovered with the '-nlp' flag.
3024 - sub definition names are now specially colored, red by default.
3025 The letter 'm' is used to identify them.
3026 - keyword 'sub' now has color of other keywords.
3027 - restored html keyword color to __END__ and __DATA__, which was
3028 accidentally removed in the previous version.
3030 -A new -se (--standard-error-output) flag has been implemented and
3031 documented which causes all errors to be written to standard output
3032 instead of a .ERR file.
3034 -A new -w (--warning-output) flag has been implemented and documented
3035 which causes perltidy to output certain non-critical messages to the
3036 error output file, .ERR. These include complaints about pod usage,
3037 for example. The default is to not include these.
3039 NOTE: This replaces an undocumented -w=0 or --warning-level flag
3040 which was tentatively introduced in the previous version to avoid some
3041 unwanted messages. The new default is the same as the old -w=0, so
3042 that is no longer needed.
3044 -Improved syntax checking and corrected tokenization of functions such
3045 as rand, srand, sqrt, ... These can accept either an operator or a term
3046 to their right. This has been corrected.
3048 -Corrected tokenization of semicolon: testing of the previous update showed
3049 that the semicolon in the following statement was being mis-tokenized. That
3050 did no harm, other than adding an extra blank space, but has been corrected.
3052 for (sort {strcoll($a,$b);} keys %investments) {
3056 -New syntax check: after wasting 5 minutes trying to resolve a syntax
3057 error in which I had an extra terminal ';' in a complex for (;;) statement,
3058 I spent a few more minutes adding a check for this in perltidy so it won't
3061 -The behavior of --break-before-subs (-bbs) and --break-before-blocks
3062 (-bbb) has been modified. Also, a new control parameter,
3063 --long-block-line-count=n (-lbl=n) has been introduced to give more
3064 control on -bbb. This was previously a hardwired value. The reason
3065 for the change is to reduce the number of unwanted blank lines that
3066 perltidy introduces, and make it less erratic. It's annoying to remove
3067 an unwanted blank line and have perltidy put it back. The goal is to
3068 be able to sprinkle a few blank lines in that dense script you
3069 inherited from Bubba. I did a lot of experimenting with different
3070 schemes for introducing blank lines before and after code blocks, and
3071 decided that there is no really good way to do it. But I think the new
3072 scheme is an improvement. You can always deactivate this with -nbbb.
3073 I've been meaning to work on this; thanks to Erik Thaysen for bringing
3076 -The .LOG file is seldom needed, and I get tired of deleting them, so
3077 they will now only be automatically saved if perltidy thinks that it
3078 made an error, which is almost never. You can still force the logfile
3079 to be saved with -log or -g.
3081 -Improved method for computing number of columns in a table. The old
3082 method always tried for an even number. The new method allows odd
3083 numbers when it is obvious that a list is not a hash initialization
3087 $name, $xsargs, $parobjs, $optypes,
3088 $hasp2child, $pmcode, $hdrcode, $inplacecode,
3089 $globalnew, $callcopy
3094 $name, $xsargs, $parobjs, $optypes, $hasp2child,
3095 $pmcode, $hdrcode, $inplacecode, $globalnew, $callcopy
3099 -I fiddled with the list threshold adjustment, and some small lists
3100 look better now. Here is the change for one of the lists in test file
3104 ("in", "in", "pt", "pt", "pc", "pi", "mm", "mm", "cm", "cm", "\\hsize", "%",
3105 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%");
3109 "in", "in", "pt", "pt", "pc", "pi",
3110 "mm", "mm", "cm", "cm", "\\hsize", "%",
3111 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%"
3114 -Improved -lp formatting at '=' sign. A break was always being added after
3115 the '=' sign in a statement such as this, (to be sure there was enough room
3116 for the parameters):
3121 $biblionumber, $constraint,
3125 The updated version doesn't do this unless the space is really needed:
3127 new: my $fee = CalcReserveFee(
3129 $biblionumber, $constraint,
3133 -I updated the tokenizer to allow $#+ and $#-, which seem to be new to
3134 Perl 5.6. Some experimenting with a recent version of Perl indicated
3135 that it allows these non-alphanumeric '$#' array maximum index
3136 variables: $#: $#- $#+ so I updated the parser accordingly. Only $#:
3137 seems to be valid in older versions of Perl.
3139 -Fixed a rare formatting problem with -lp (and -gnu) which caused
3140 excessive indentation.
3142 -Many additional syntax checks have been added.
3144 -Revised method for testing here-doc target strings; the following
3145 was causing trouble with a regex test because of the '*' characters:
3149 Perl seems to allow almost anything to be a here doc target, so an
3150 exact string comparison is now used.
3152 -Made update to allow underscores in binary numbers, like '0b1100_0000'.
3154 -Corrected problem with scanning certain module names; a blank space was
3155 being inserted after 'warnings' in the following:
3156 use warnings::register;
3157 The problem was that warnings (and a couple of other key modules) were
3158 being tokenized as keywords. They should have just been identifiers.
3160 -Corrected tokenization of indirect objects after sort, system, and exec,
3161 after testing produced an incorrect error message for the following
3163 print sort $sortsubref @list;
3165 -Corrected minor problem where a line after a format had unwanted
3166 extra continuation indentation.
3168 -Delete-block-comments (and -dac) now retain any leading hash-bang line
3170 -Update for -lp (and -gnu) to not align the leading '=' of a list
3171 with a previous '=', since this interferes with alignment of parameters.
3173 old: my $hireDay = new Date;
3180 new: my $hireDay = new Date;
3187 -Modifications made to display tables more compactly when possible,
3188 without adding lines. For example,
3190 '1', "I", '2', "II", '3', "III", '4', "IV",
3191 '5', "V", '6', "VI", '7', "VII", '8', "VIII",
3194 '1', "I", '2', "II", '3', "III",
3195 '4', "IV", '5', "V", '6', "VI",
3196 '7', "VII", '8', "VIII", '9', "IX"
3198 -Corrected minor bug in which -pt=2 did not keep the right paren tight
3199 around a '++' or '--' token, like this:
3201 for ($i = 0 ; $i < length $key ; $i++ )
3203 The formatting for this should be, and now is:
3205 for ($i = 0 ; $i < length $key ; $i++)
3207 Thanks to Erik Thaysen for noting this.
3209 -Discovered a new bug involving here-docs during testing! See BUGS.html.
3211 -Finally fixed parsing of subroutine attributes (A Perl 5.6 feature).
3212 However, the attributes and prototypes must still be on the same line
3217 -Corrected minor, uncommon bug found during routine testing, in which a
3218 blank got inserted between a function name and its opening paren after
3219 a file test operator, but only in the case that the function had not
3220 been previously seen. Perl uses the existence (or lack thereof) of
3221 the blank to guess if it is a function call. That is,
3222 if (-l pid_filename()) {
3224 if (-l pid_filename ()) {
3225 which is a syntax error if pid_filename has not been seen by perl.
3227 -If the AutoLoader module is used, perltidy will continue formatting
3228 code after seeing an __END__ line. Use -nlal to deactivate this feature.
3229 Likewise, if the SelfLoader module is used, perltidy will continue
3230 formatting code after seeing a __DATA__ line. Use -nlsl to
3231 deactivate this feature. Thanks to Slaven Rezic for this suggestion.
3233 -pod text after __END__ and __DATA__ is now identified by perltidy
3234 so that -dp works correctly. Thanks to Slaven Rezic for this suggestion.
3236 -The first $VERSION line which might be eval'd by MakeMaker
3237 is now passed through unchanged. Use -npvl to deactivate this feature.
3238 Thanks to Manfred Winter for this suggestion.
3240 -Improved indentation of nested parenthesized expressions. Tests have
3241 given favorable results. Thanks to Wolfgang Weisselberg for helpful
3246 -Fixed a very rare problem in which an unwanted semicolon was inserted
3247 due to misidentification of anonymous hash reference curly as a code
3248 block curly. (No instances of this have been reported; I discovered it
3249 during testing). A workaround for older versions of perltidy is to use
3252 -Added -icb (-indent-closing-brace) parameter to indent a brace which
3253 terminates a code block to the same level as the previous line.
3254 Suggested by Andrew Cutler. For example,
3263 -Rewrote error message triggered by an unknown bareword in a print or
3264 printf filehandle position, and added flag -w=0 to prevent issuing this
3265 error message. Suggested by Byron Jones.
3267 -Added modification to align a one-line 'if' block with similar
3268 following 'elsif' one-line blocks, like this:
3269 if ( $something eq "simple" ) { &handle_simple }
3270 elsif ( $something eq "hard" ) { &handle_hard }
3271 (Suggested by Wolfgang Weisselberg).
3275 -Eliminated all constants with leading underscores because perl 5.005_03
3276 does not support that. For example, _SPACES changed to XX_SPACES.
3277 Thanks to kromJx for this update.
3281 -the directory of test files has been moved to a separate distribution
3282 file because it is getting large but is of little interest to most users.
3283 For the current distribution:
3284 perltidy-20010701.tgz contains the source and docs for perltidy
3285 perltidy-20010701-test.tgz contains the test files
3287 -fixed bug where temporary file perltidy.TMPI was not being deleted
3288 when input was from stdin.
3290 -adjusted line break logic to not break after closing brace of an
3291 eval block (suggested by Boris Zentner).
3293 -added flag -gnu (--gnu-style) to give an approximation to the GNU
3294 style as sometimes applied to perl. The programming style in GNU
3295 'automake' was used as a guide in setting the parameters; these
3296 parameters will probably be adjusted over time.
3298 -an empty code block now has one space for emphasis:
3299 if ( $cmd eq "bg_untested" ) {} # old
3300 if ( $cmd eq "bg_untested" ) { } # new
3301 If this bothers anyone, we could create a parameter.
3303 -the -bt (--brace-tightness) parameter has been split into two
3304 parameters to give more control. -bt now applies only to non-BLOCK
3305 braces, while a new parameter -bbt (block-brace-tightness) applies to
3306 curly braces which contain code BLOCKS. The default value is -bbt=0.
3308 -added flag -icp (--indent-closing-paren) which leaves a statement
3309 termination of the form );, };, or ]; indented with the same
3310 indentation as the previous line. For example,
3312 @month_of_year = ( # default, or -nicp
3313 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3317 @month_of_year = ( # -icp
3318 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3322 -Vertical alignment updated to synchronize with tokens &&, ||,
3323 and, or, if, unless. Allowable space before forcing
3324 resynchronization has been increased. (Suggested by Wolfgang
3327 -html corrected to use -nohtml-bold-xxxxxxx or -nhbx to negate bold,
3328 and likewise -nohtml-italic-xxxxxxx or -nhbi to negate italic. There
3329 was no way to negate these previously. html documentation updated and
3330 corrected. (Suggested by Wolfgang Weisselberg).
3332 -Some modifications have been made which improve the -lp formatting in
3335 -Perltidy now retains or creates a blank line after an =cut to keep
3336 podchecker happy (Suggested by Manfred H. Winter). This appears to be
3337 a glitch in podchecker, but it was annoying.
3341 -Added -bli flag to give continuation indentation to braces, like this
3345 extra_indentation();
3348 -Corrected an error with the tab (-t) option which caused the last line
3349 of a multi-line quote to receive a leading tab. This error was in
3350 version 2001 06 08 but not 2001 04 06. If you formatted a script
3351 with -t with this version, please check it by running once with the
3352 -chk flag and perltidy will scan for this possible error.
3354 -Corrected an invalid pattern (\R should have been just R), changed
3355 $^W =1 to BEGIN {$^W=1} to use warnings in compile phase, and corrected
3356 several unnecessary 'my' declarations. Many thanks to Wolfgang Weisselberg,
3357 2001-06-12, for catching these errors.
3359 -A '-bar' flag has been added to require braces to always be on the
3360 right, even for multi-line if and foreach statements. For example,
3361 the default formatting of a long if statement would be:
3363 if ($bigwasteofspace1 && $bigwasteofspace2
3364 || $bigwasteofspace3 && $bigwasteofspace4)
3369 With -bar, the formatting is:
3371 if ($bigwasteofspace1 && $bigwasteofspace2
3372 || $bigwasteofspace3 && $bigwasteofspace4) {
3375 Suggested by Eli Fidler 2001-06-11.
3377 -Uploaded perltidy to sourceforge cvs 2001-06-10.
3379 -An '-lp' flag (--line-up-parentheses) has been added which causes lists
3380 to be indented with extra indentation in the manner sometimes
3381 associated with emacs or the GNU suggestions. Thanks to Ian Stuart for
3382 this suggestion and for extensive help in testing it.
3384 -Subroutine call parameter lists are now formatted as other lists.
3385 This should improve formatting of tables being passed via subroutine
3386 calls. This will also cause full indentation ('-i=n, default n= 4) of
3387 continued parameter list lines rather than just the number of spaces
3388 given with -ci=n, default n=2.
3390 -Added support for hanging side comments. Perltidy identifies a hanging
3391 side comment as a comment immediately following a line with a side
3392 comment or another hanging side comment. This should work in most
3393 cases. It can be deactivated with --no-hanging-side-comments (-nhsc).
3394 The manual has been updated to discuss this. Suggested by Brad
3395 Eisenberg some time ago, and finally implemented.
3399 -fixed problem with parsing command parameters containing quoted
3400 strings in .perltidyrc files. (Reported by Roger Espel Llima 2001-06-07).
3402 -added two command line flags, --want-break-after and
3403 --want-break-before, which allow changing whether perltidy
3404 breaks lines before or after any operators. Please see the revised
3405 man pages for details.
3407 -added system-wide configuration file capability.
3408 If perltidy does not find a .perltidyrc command line file in
3409 the current directory, nor in the home directory, it now looks
3410 for '/usr/local/etc/perltidyrc' and then for '/etc/perltidyrc'.
3411 (Suggested by Roger Espel Llima 2001-05-31).
3413 -fixed problem in which spaces were trimmed from lines of a multi-line
3414 quote. (Reported by Roger Espel Llima 2001-05-30). This is an
3415 uncommon situation, but serious, because it could conceivably change
3416 the proper function of a script.
3418 -fixed problem in which a semicolon was incorrectly added within
3419 an anonymous hash. (Reported by A.C. Yardley, 2001-5-23).
3420 (You would know if this happened, because perl would give a syntax
3421 error for the resulting script).
3423 -fixed problem in which an incorrect error message was produced
3424 after a version number on a 'use' line, like this ( Reported
3425 by Andres Kroonmaa, 2001-5-14):
3427 use CGI 2.42 qw(fatalsToBrowser);
3429 Other than the extraneous error message, this bug was harmless.
3433 -fixed serious bug in which the last line of some multi-line quotes or
3434 patterns was given continuation indentation spaces. This may make
3435 a pattern incorrect unless it uses the /x modifier. To find
3436 instances of this error in scripts which have been formatted with
3437 earlier versions of perltidy, run with the -chk flag, which has
3438 been added for this purpose (SLH, 2001-04-05).
3440 ** So, please check previously formatted scripts by running with -chk
3443 -continuation indentation has been reprogrammed to be hierarchical,
3444 which improves deeply nested structures.
3446 -fixed problem with undefined value in list formatting (reported by Michael
3449 -Switched to graphical display of nesting in .LOG files. If an
3450 old format string was "(1 [0 {2", the new string is "{{(". This
3451 is easier to read and also shows the order of nesting.
3453 -added outdenting of cuddled paren structures, like ")->pack(".
3455 -added line break and outdenting of ')->' so that instead of
3458 -text => "perltidy",
3459 -relief => 'ridge')->pack;
3461 the current default is:
3464 -text => "perltidy",
3468 (requested by Michael Langner 2001-03-31; in the future this could
3469 be controlled by a command-line parameter).
3471 -revised list indentation logic, so that lists following an assignment
3472 operator get one full indentation level, rather than just continuation
3473 indentation. Also corrected some minor glitches in the continuation
3476 -Fixed problem with unwanted continuation indentation after a blank line
3477 (reported by Erik Thaysen 2001-03-28):
3479 -minor update to avoid stranding a single '(' on one line
3483 -corrected serious error tokenizing filehandles, in which a sub call
3484 after a print or printf, like this:
3485 print usage() and exit;
3487 print usage () and exit;
3488 Unfortunately, this converts 'usage' to a filehandle. To fix this, rerun
3489 perltidy; it will look for this situation and issue a warning.
3491 -fixed another cuddled-else formatting bug (Reported by Craig Bourne)
3493 -added several diagnostic --dump routines
3495 -added token-level whitespace controls (suggested by Hans Ecke)
3499 -added support for special variables of the form ${^WANT_BITS}
3501 -space added between scalar and left paren in 'for' and 'foreach' loops,
3502 (suggestion by Michael Cartmell):
3504 for $i( 1 .. 20 ) # old
3505 for $i ( 1 .. 20 ) # new
3507 -html now outputs cascading style sheets (thanks to suggestion from
3510 -flags -o and -st now work with -html
3512 -added missing -html documentation for comments (noted by Alex Izvorski)
3514 -support for VMS added (thanks to Michael Cartmell for code patches and
3517 -v-strings implemented (noted by Hans Ecke and Michael Cartmell; extensive
3518 testing by Michael Cartmell)
3520 -fixed problem where operand may be empty at line 3970
3521 (\b should be just b in lines 3970, 3973) (Thanks to Erik Thaysen,
3522 Keith Marshall for bug reports)
3524 -fixed -ce bug (cuddled else), where lines like '} else {' were indented
3525 (Thanks to Shawn Stepper and Rick Measham for reporting this)
3529 -fixed undefined value in line 153 (only worked with -I set)
3530 (Thanks to Mike Stok, Phantom of the Opcodes, Ian Ehrenwald, and others)
3532 -fixed undefined value in line 1069 (filehandle problem with perl versions <
3533 5.6) (Thanks to Yuri Leikind, Mike Stok, Michael Holve, Jeff Kolber)
3537 -Initial announcement at freshmeat.net; started Change Log
3538 (Unfortunately this version was DOA, but it was fixed the next day)