5 - fix RT#127736 Perl-Tidy-20181119 has the EXE_FILES entry commented out in
6 Makefile.PL so it doesn't install the perltidy script or its manpage.
11 - Removed test case 'filter_example.t' which was causing a failure on a
12 Windows installation for unknown reasons, possibly due to an unexpected
13 perltidyrc being read by the test script. Added VERSION numbers to all
18 - Fixed RT #126965, in which a ternary operator was misparsed if immediately
19 following a function call without arguments, such as:
20 my $restrict_customer = shift ? 1 : 0;
22 - Fixed RT #125012: bug in -mangle --delete-all-comments
23 A needed blank space before bareword tokens was being removed when comments
26 - Fixed RT #81852: Stacked containers and quoting operators. Quoted words
27 (qw) delimited by container tokens ('{', '[', '(', '<') are now included in
28 the --weld-nested (-wn) flag:
42 - The cuddled-else (-ce) coding was merged with the new cuddled-block (-cb)
43 coding. The change is backward compatible and simplifies input.
44 The --cuddled-block-option=n (-cbo=n) flag now applies to both -ce and -cb
45 formatting. In fact the -cb flag is just an alias for -ce now.
47 - Fixed RT #124594, license text desc. changed from 'GPL-2.0+' to 'gpl_2'
49 - Fixed bug in which a warning about a possible code bug was issued in a
50 script with brace errors.
52 - added option --notimestamp or -nts to eliminate any time stamps in output
53 files. This is used to prevent differences in test scripts from causing
54 failure at installation. For example, the -cscw option will put a date
55 stamp on certain closing side comments. We need to avoid this in order
56 to test this feature in an installation test.
58 - Fixed bug with the entab option, -et=8, in which the leading space of
59 some lines was was not entabbed. This happened in code which was adjusted
60 for vertical alignment and in hanging side comments. Thanks to Glenn.
62 - Fixed RT #127633, undesirable line break after return when -baao flag is set
64 - Fixed RT #127035, vertical alignment. Vertical alignment has been improved
65 in several ways. Thanks especially to Michael Wardman and Glenn for sending
68 - Alignment of the =~ operators has been reactivated.
71 $service_profile =~ s/^\s+|\s+$//g;
72 $host_profile =~ s/^\s+|\s+$//g;
75 $service_profile =~ s/^\s+|\s+$//g;
76 $host_profile =~ s/^\s+|\s+$//g;
78 - Alignment of the // operator has been reactivated.
81 is( pop // 7, 7, 'pop // ... works' );
82 is( pop() // 7, 0, 'pop() // ... works' );
83 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
86 is( pop // 7, 7, 'pop // ... works' );
87 is( pop() // 7, 0, 'pop() // ... works' );
88 is( pop @ARGV // 7, 3, 'pop @array // ... works' );
90 - The rules for alignment of just two lines have been adjusted,
91 hopefully to be a little better overall. In some cases, two
92 lines which were previously unaligned are now aligned, and vice-versa.
95 $expect = "1$expect" if $expect =~ /^e/i;
96 $p = "1$p" if defined $p and $p =~ /^e/i;
99 $expect = "1$expect" if $expect =~ /^e/i;
100 $p = "1$p" if defined $p and $p =~ /^e/i;
103 - RT #106493; source code repository location has been added to docs; it is
104 https://github.com/perltidy/perltidy
106 - The packaging for this version has changed. The Tidy.pm module is much
107 smaller. Supporting modules have been split out from it and placed below
108 it in the path Perl/Tidy/*.
110 - A number of new installation test cases have been added. Updates are now
111 continuously tested at Travis CI against versions back to Perl 5.08.
115 - RT #124469, #124494, perltidy often making empty files. The previous had
116 an index error causing it to fail, particularly in version 5.18 of Perl.
118 Please avoid version 20180219.
122 - RT #79947, cuddled-else generalization. A new flag -cb provides
123 'cuddled-else' type formatting for an arbitrary type of block chain. The
124 default is try-catch-finally, but this can be modified with the
127 - Fixed RT #124298: add space after ! operator without breaking !! secret
130 - RT #123749: numerous minor improvements to the -wn flag were made.
132 - Fixed a problem with convergence tests in which iterations were stopping
135 - Here doc targets for <<~ type here-docs may now have leading whitespace.
137 - Fixed RT #124354. The '-indent-only' flag was not working correctly in the
138 previous release. A bug in version 20180101 caused extra blank lines
141 - Issue RT #124114. Some improvements were made in vertical alignment
142 involving 'fat commas'.
146 - Added new flag -wn (--weld-nested-containers) which addresses these issues:
147 RT #123749: Problem with promises;
148 RT #119970: opening token stacking strange behavior;
149 RT #81853: Can't stack block braces
151 This option causes closely nested pairs of opening and closing containers
152 to be "welded" together and essentially be formatted as a single unit,
153 with just one level of indentation.
155 Since this is a new flag it is set to be "off" by default but it has given
156 excellent results in testing.
158 EXAMPLE 1, multiple blocks, default formatting:
161 next if $x == $y; # do something here
170 EXAMPLE 2, three levels of wrapped function calls, default formatting:
174 translate( param('verb') ), param('tense'),
182 translate( param('verb') ),
183 param('tense'), param('person')
186 # EXAMPLE 3, chained method calls, default formatting:
187 get('http://mojolicious.org')->then(
190 say $mojo->res->code;
191 return get('http://metacpan.org');
196 say $cpan->res->code;
201 warn "Something went wrong: $err";
206 get('http://mojolicious.org')->then( sub {
208 say $mojo->res->code;
209 return get('http://metacpan.org');
212 say $cpan->res->code;
215 warn "Something went wrong: $err";
219 - Fixed RT #114359: Missparsing of "print $x ** 0.5;
221 - Deactivated the --check-syntax flag for better security. It will be
224 - Corrected minimum perl version from 5.004 to 5.008 based on perlver
225 report. The change is required for coding involving wide characters.
227 - For certain severe errors, the source file will be copied directly to the
228 output without formatting. These include ending in a quote, ending in a
229 here doc, and encountering an unidentified character.
233 - RT #123749, partial fix. "Continuation indentation" is removed from lines
234 with leading closing parens which are part of a call chain.
235 For example, the call to pack() is is now outdented to the starting
236 indentation in the following experession:
240 -text => "New Document",
241 -command => \&new_document
249 -text => "New Document",
250 -command => \&new_document
256 This modification improves readability of complex expressions, especially
257 when the user uses the same value for continuation indentation (-ci=n) and
258 normal indentation (-i=n). Perltidy was already programmed to
259 do this but a minor bug was preventing it.
261 - RT #123774, added flag to control space between a backslash and a single or
262 double quote, requested by Robert Rothenberg. The issue is that lines like
267 confuse syntax highlighters unless a space is left between the backslash and
270 The new flag to control this is -sbq=n (--space-backslash-quote=n),
271 where n=0 means no space, n=1 means follow existing code, n=2 means always
272 space. The default is n=1, meaning that a space will be retained if there
273 is one in the source code.
275 - Fixed RT #123492, support added for indented here doc operator <<~ added
276 in v5.26. Thanks to Chris Weyl for the report.
278 - Fixed docs; --closing-side-comment-list-string should have been just
279 --closing-side-comment-list. Thanks to F.Li.
281 - Added patch RT #122030] Perl::Tidy sometimes does not call binmode.
282 Thanks to Irilis Aelae.
284 - Fixed RT #121959, PERLTIDY doesn't honor the 'three dot' notation for
285 locating a config file using environment variables. Thanks to John
288 - Minor improvements to formatting, in which some additional vertical
289 aligmnemt is done. Thanks to Keith Neargarder.
291 - RT #119588. Vertical alignment is no longer done for // operator.
295 - Fixed debian #862667: failure to check for perltidy.ERR deletion can lead
296 to overwriting abritrary files by symlink attack. Perltidy was continuing
297 to write files after an unlink failure. Thanks to Don Armstrong
300 - Fixed RT #116344, perltidy fails on certain anonymous hash references:
301 in the following code snippet the '?' was misparsed as a pattern
302 delimiter rather than a ternary operator.
303 return ref {} ? 1 : 0;
305 - Fixed RT #113792: misparsing of a fat comma (=>) right after
306 the __END__ or __DATA__ tokens. These keywords were getting
307 incorrectly quoted by the following => operator.
309 - Fixed RT #118558. Custom Getopt::Long configuration breaks parsing
310 of perltidyrc. Perltidy was resetting the users configuration too soon.
312 - Fixed RT #119140, failure to parse double diamond operator. Code to
313 handle this new operator has been added.
315 - Fixed RT #120968. Fixed problem where -enc=utf8 didn't work
316 with --backup-and-modify-in-place. Thanks to Heinz Knutzen for this patch.
318 - Fixed minor formatting issue where one-line blocks for subs with signatures
319 were unnecesarily broken
321 - RT #32905, patch to fix utf-8 error when output was STDOUT.
323 - RT #79947, improved spacing of try/catch/finally blocks. Thanks to qsimpleq
326 - Fixed #114909, Anonymous subs with signatures and prototypes misparsed as
327 broken ternaries, in which a statement such as this was not being parsed
329 return sub ( $fh, $out ) : prototype(*$) { ... }
331 - Implemented RT #113689, option to introduces spaces after an opening block
332 brace and before a closing block brace. Four new optional controls are
333 added. The first two define the minimum number of blank lines to be
336 -blao=i or --blank-lines-after-opening-block=i
337 -blbc=i or --blank-lines-before-closing-block=i
339 where i is an integer, the number of lines (the default is 0).
341 The second two define the types of blocks to which the first two apply
343 -blaol=s or --blank-lines-after-opening-block-list=s
344 -blbcl=s or --blank-lines-before-closing-block-list=s
346 where s is a string of possible block keywords (default is just 'sub',
347 meaning a named subroutine).
349 For more information please see the documentation.
351 - The method for specifying block types for certain input parameters has
352 been generalized to distinguish between normal named subroutines and
353 anonymous subs. The keyword for normal subroutines remains 'sub', and
354 the new keyword for anonymous subs is 'asub'.
356 - Minor documentation changes. The BUGS sections now have a link
357 to CPAN where most open bugs and issues can be reviewed and bug reports
358 can be submitted. The information in the AUTHOR and CREDITS sections of
359 the man pages have been removed from the man pages to streamline the
360 documentation. This information is still in the source code.
364 - RT #112534. Corrected a minor problem in which an unwanted newline
365 was placed before the closing brace of an anonymous sub with
366 a signature, if it was in a list. Thanks to Dmytro Zagashev.
368 - Corrected a minor problem in which occasional extra indentation was
369 given to the closing brace of an anonymous sub in a list when the -lp
374 - RT #104427. Added support for signatures.
376 - RT #111512. Changed global warning flag $^W = 1 to use warnings;
377 Thanks to Dmytro Zagashev.
379 - RT #110297, added support for new regexp modifier /n
380 Thanks to Dmytro Zagashev.
382 - RT #111519. The -io (--indent-only) and -dac (--delete-all-comments)
383 can now both be used in one pass. Thanks to Dmitry Veltishev.
385 - Patch to avoid error message with 'catch' used by TryCatch, as in
389 Thanks to Nick Tonkin.
391 - RT #32905, UTF-8 coding is now more robust. Thanks to qsimpleq
392 and Dmytro for patches.
394 - RT #106885. Added string bitwise operators ^. &. |. ~. ^.= &.= |.=
396 - Fixed RT #107832 and #106492, lack of vertical alignment of two lines
397 when -boc flag (break at old commas) is set. This bug was
398 inadvertantly introduced in previous bug fix RT #98902.
400 - Some common extensions to Perl syntax are handled better.
401 In particular, the following snippet is now foratted cleanly:
403 method deposit( Num $amount) {
404 $self->balance( $self->balance + $amount );
407 A new flag -xs (--extended-syntax) was added to enable this, and the default
410 In previous versions, and now only when -nxs is set, this snippet of code
411 generates the following error message:
413 "syntax error at ') {', didn't see one of: case elsif for foreach given if switch unless until when while"
417 - Fixed RT# 105484, Invalid warning about 'else' in 'switch' statement. The
418 warning happened if a 'case' statement did not use parens.
420 - Fixed RT# 101547, misparse of // caused error message. Also..
422 - Fixed RT# 102371, misparse of // caused unwated space in //=
424 - Fixed RT# 100871, "silent failure of HTML Output on Windows".
425 Changed calls to tempfile() from:
426 my ( $fh_tmp, $tmpfile ) = tempfile();
427 to have the full path name:
428 my ( $fh_tmp, $tmpfile ) = File::Temp::tempfile()
429 because of problems in the Windows version reported by Dean Pearce.
431 - Fixed RT# 99514, calling the perltidy module multiple times with
432 a .perltidyrc file containing the parameter --output-line-ending
433 caused a crash. This was a glitch in the memoization logic.
435 - Fixed RT#99961, multiple lines inside a cast block caused unwanted
436 continuation indentation.
438 - RT# 32905, broken handling of UTF-8 strings.
439 A new flag -utf8 causes perltidy assume UTF-8 encoding for input and
440 output of an io stream. Thanks to Sebastian Podjasek for a patch.
441 This feature may not work correctly in older versions of Perl.
442 It worked in a linux version 5.10.1 but not in a Windows version 5.8.3 (but
443 otherwise perltidy ran correctly).
445 - Warning files now report perltidy VERSION. Suggested by John Karr.
447 - Fixed long flag --nostack-closing-tokens (-nsct has always worked though).
448 This was due to a typo. This also fixed --nostack-opening-tokens to
449 behave correctly. Thanks to Rob Dixon.
453 - Fixed RT #94902: abbreviation parsing in .perltidyrc files was not
454 working for multi-line abbreviations. Thanks to Eric Fung for
457 - Fixed RT #95708, misparsing of a hash when the first key was a perl
458 keyword, causing a semicolon to be incorrectly added.
460 - Fixed RT #94338 for-loop in a parenthesized block-map. A code block within
461 parentheses of a map, sort, or grep function was being mistokenized. In
462 rare cases this could produce in an incorrect error message. The fix will
463 produce some minor formatting changes. Thanks to Daniel Trizen
464 discovering and documenting this.
466 - Fixed RT #94354, excess indentation for stacked tokens. Thanks to
467 Colin Williams for supplying a patch.
469 - Added support for experimental postfix dereferencing notation introduced in
470 perl 5.20. RT #96021.
472 - Updated documentation to clarify the behavior of the -io flag
473 in response to RT #95709. You can add -noll or -l=0 to prevent
474 long comments from being outdented when -io is used.
476 - Added a check to prevent a problem reported in RT #81866, where large
477 scripts which had been compressed to a single line could not be formatted
478 because of a check for VERSION for MakeMaker. The workaround was to
479 use -nvpl, but this shouldn't be necessary now.
481 - Fixed RT #96101; Closing brace of anonymous sub in a list was being
482 indented. For example, the closing brace of the anonymous sub below
483 will now be lined up with the word 'callback'. This problem
484 occured if there was no comma after the closing brace of the anonymous sub.
485 This update may cause minor changes to formatting of code with lists
486 of anonymous subs, especially TK code.
493 path => '/_Operate/Transcode and split',
495 return 1 if not $self->project_opened;
496 $self->comp('project')->transcode( split => 1 );
506 path => '/_Operate/Transcode and split',
508 return 1 if not $self->project_opened;
509 $self->comp('project')->transcode( split => 1 );
516 - Fixed RT #94190 and debian Bug #742004: perltidy.LOG file left behind.
517 Thanks to George Hartzell for debugging this. The problem was
518 caused by the memoization speedup patch in version 20121207. An
519 unwanted flag was being set which caused a LOG to be written if
520 perltidy was called multiple times.
522 - New default behavior for LOG files: If the source is from an array or
523 string (through a call to the perltidy module) then a LOG output is only
524 possible if a logfile stream is specified. This is to prevent
525 unexpected perltidy.LOG files.
527 - Fixed debian Bug #740670, insecure temporary file usage. File::Temp is now
528 used to get a temporary file. Thanks to Don Anderson for a patch.
530 - Any -b (--backup-and-modify-in-place) flag is silently ignored when a
531 source stream, destination stream, or standard output is used.
532 This is because the -b flag may have been in a .perltidyrc file and
533 warnings break Test::NoWarnings. Thanks to Marijn Brand.
537 - Fixed RT #88020. --converge was not working with wide characters.
539 - Fixed RT #78156. package NAMESPACE VERSION syntax not accepted.
541 - First attempt to fix RT #88588. INDEX END tag change in pod2html breaks
542 perltidy -html. I put in a patch which should work but I don't yet have
547 - Fixed RT #87107, spelling
551 - Fixed RT #87502, incorrect of parsing of smartmatch before hash brace
553 - Added feature request RT #87330, trim whitespace after POD.
554 The flag -trp (--trim-pod) will trim trailing whitespace from lines of POD
558 - Fixed RT #86929, #86930, missing lhs of assignment.
560 - Fixed RT #84922, moved pod from Tidy.pm into Tidy.pod
564 - The flag -cab=n or --comma-arrow-breakpoints=n has been generalized
565 to give better control over breaking open short containers. The
566 possible values are now:
568 n=0 break at all commas after =>
569 n=1 stable: break at all commas after => if container is open,
570 EXCEPT FOR one-line containers
571 n=2 break at all commas after =>, BUT try to form the maximum
572 maximum one-line container lengths
573 n=3 do not treat commas after => specially at all
574 n=4 break everything: like n=0 but also break a short container with
575 a => not followed by a comma
576 n=5 stable: like n=1 but ALSO break at open one-line containers (default)
578 New values n=4 and n=5 have been added to allow short blocks to be
579 broken open. The new default is n=5, stable. It should more closely
580 follow the breaks in the input file, and previously formatted code
581 should remain unchanged. If this causes problems use -cab=1 to recover
582 the former behavior. Thanks to Tony Maszeroski for the suggestion.
584 To illustrate the need for the new options, if perltidy is given
585 the following code, then the old default (-cab=1) was to close up
586 the 'index' container even if it was open in the source. The new
587 default (-cab=5) will keep it open if it was open in the source.
602 - New debug flag --memoize (-mem). This version contains a
603 patch supplied by Jonathan Swartz which can significantly speed up
604 repeated calls to Perl::Tidy::perltidy in a single process by caching
605 the result of parsing the formatting parameters. A factor of up to 10
606 speedup was achieved for masontidy (https://metacpan.org/module/masontidy).
607 The memoization patch is on by default but can be deactivated for
608 testing with -nmem (or --no-memoize).
610 - New flag -tso (--tight-secret-operators) causes certain perl operator
611 sequences (secret operators) to be formatted "tightly" (without spaces).
612 The most common of these are 0 + and + 0 which become 0+ and +0. The
613 operators currently modified by this flag are:
614 =( )= 0+ +0 ()x!! ~~<> ,=>
615 Suggested by by Philippe Bruhat. See https://metacpan.org/module/perlsecret
616 This flag is off by default.
618 - New flag -vmll (--variable-maximum-line-length) makes the maximum
619 line length increase with the nesting depth of a line of code.
620 Basically, it causes the length of leading whitespace to be ignored when
621 setting line breaks, so the formatting of a block of code is independent
622 of its nesting depth. Try this option if you have deeply nested
623 code or data structures, perhaps in conjunction with the -wc flag
624 described next. The default is not todo this.
626 - New flag -wc=n (--whitespace-cycle=n) also addresses problems with
627 very deeply nested code and data structures. When this parameter is
628 used and the nesting depth exceeds the value n, the leading whitespace
629 will be reduced and start at 1 again. The result is that deeply
630 nested blocks of code will shift back to the left. This occurs cyclically
631 to any nesting depth. This flag may be used either with or without -vmll.
632 The default is not to use this (-wc=0).
634 - Fixed RT #78764, error parsing smartmatch operator followed by anonymous
635 hash or array and then a ternary operator; two examples:
637 qr/3/ ~~ ['1234'] ? 1 : 0;
638 map { $_ ~~ [ '0', '1' ] ? 'x' : 'o' } @a;
640 - Fixed problem with specifying spaces around arrows using -wls='->'
641 and -wrs='->'. Thanks to Alain Valleton for documenting this problem.
643 - Implemented RT #53183, wishlist, lines of code with the same indentation
644 level which are contained with multiple stacked opening and closing tokens
645 (requested with flags -sot -sct) now have reduced indentation.
656 # OLD: perltidy -sot -sct
663 # NEW: perltidy -sot -sct
670 - New flag -act=n (--all-containers-tightness=n) is an abbreviation for
671 -pt=n -sbt=n -bt=n -bbt=n, where n=0,1, or 2. It simplifies input when all
672 containers have the same tightness. Using the same example:
674 # NEW: perltidy -sot -sct -act=2
681 - New flag -sac (--stack-all-containers) is an abbreviation for -sot -sct
682 This is part of wishlist item RT #53183. Using the same example again:
684 # NEW: perltidy -sac -act=2
691 - new flag -scbb (--stack-closing-block-brace) causes isolated closing
692 block braces to stack as in the following example. (Wishlist item RT#73788)
699 push( @lines, "$w1 $w2 $w3 $w4\n" );
710 push( @lines, "$w1 $w2 $w3 $w4\n" );
713 There is, at present, no flag to place these closing braces at the end
714 of the previous line. It seems difficult to develop good rules for
715 doing this for a wide variety of code and data structures.
717 - Parameters defining block types may use a wildcard '*' to indicate
718 all block types. Previously it was not possible to include bare blocks.
720 - A flag -sobb (--stack-opening-block-brace) has been introduced as an
721 alias for -bbvt=2 -bbvtl='*'. So for example the following test code:
723 {{{{{{{ $testing }}}}}}}
725 cannot be formatted as above but can at least be kept vertically compact
726 using perltidy -sobb -scbb
728 { { { { { { { $testing
731 Or even, perltidy -sobb -scbb -i=1 -bbt=2
736 - Error message improved for conflicts due to -pbp; thanks to Djun Kim.
738 - Fixed RT #80645, error parsing special array name '@$' when used as
741 - Eliminated the -chk debug flag which was included in version 20010406 to
742 do a one-time check for a bug with multi-line quotes. It has not been
745 - Numerous other minor formatting improvements.
749 - Added flag -iscl (--ignore-side-comment-lengths) which causes perltidy
750 to ignore the length of side comments when setting line breaks,
751 RT #71848. The default is to include the length of side comments when
752 breaking lines to stay within the length prescribed by the -l=n
753 maximum line length parameter. For example,
755 Default behavior on a single line with long side comment:
756 $vmsfile =~ s/;[\d\-]*$//
757 ; # Clip off version number; we can use a newer version as well
759 perltidy -iscl leaves the line intact:
761 $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well
763 - Fixed RT #78182, side effects with STDERR. Error handling has been
764 revised and the documentation has been updated. STDERR can now be
765 redirected to a string reference, and perltidy now returns an
766 error flag instead of calling die when input errors are detected.
767 If the error flag is set then no tidied output was produced.
768 See man Perl::Tidy for an example.
770 - Fixed RT #78156, erroneous warning message for package VERSION syntax.
772 - Added abbreviations -conv (--converge) to simplify iteration control.
773 -conv is equivalent to -it=4 and will insure that the tidied code is
774 converged to its final state with the minimum number of iterations.
776 - Minor formatting modifications have been made to insure convergence.
778 - Simplified and hopefully improved the method for guessing the starting
779 indentation level of entabbed code. Added flag -dt=n (--default_tabsize=n)
780 which might be helpful if the guessing method does not work well for
783 - Added support for stacked labels, upper case X/B in hex and binary, and
786 - Eliminated warning messages for using keyword names as constants.
790 - Corrected problem introduced by using a chomp on scalar references, RT #77978
792 - Added support for Perl 5.14 package block syntax, RT #78114.
794 - A convergence test is made if three or more iterations are requested with
795 the -it=n parameter to avoid wasting computer time. Several hundred Mb of
796 code gleaned from the internet were searched with the results that:
797 - It is unusual for two iterations to be required unless a major
798 style change is being made.
799 - Only one case has been found where three iterations were required.
800 - No cases requiring four iterations have been found with this version.
801 For the previous version several cases where found the results could
802 oscillate between two semi-stable states. This version corrects this.
804 So if it is important that the code be converged it is okay to set -it=4
805 with this version and it will probably stop after the second iteration.
807 - Improved ability to identify and retain good line break points in the
808 input stream, such as at commas and equals. You can always tell
809 perltidy to ignore old breakpoints with -iob.
811 - Fixed glitch in which a terminal closing hash brace followed by semicolon
812 was not outdented back to the leading line depth like other closing
813 tokens. Thanks to Keith Neargarder for noting this.
816 my ( $pre, $post ) = @{
818 "pp_anonlist" => [ "[", "]" ],
819 "pp_anonhash" => [ "{", "}" ]
824 my ( $pre, $post ) = @{
826 "pp_anonlist" => [ "[", "]" ],
827 "pp_anonhash" => [ "{", "}" ]
831 - Removed extra indentation given to trailing 'if' and 'unless' clauses
832 without parentheses because this occasionally produced undesirable
833 results. This only applies where parens are not used after the if or
838 unless my ( $who, $actions ) =
839 $clause =~ /^($who_re)((?:$action_re)+)$/o;
843 unless my ( $who, $actions ) =
844 $clause =~ /^($who_re)((?:$action_re)+)$/o;
848 - Updated perltidy to handle all quote modifiers defined for perl 5 version 16.
850 - Side comment text in perltidyrc configuration files must now begin with
851 at least one space before the #. Thus:
854 -l=78 # Max line width is 78 cols
856 -l=78# Max line width is 78 cols
858 This is probably true of almost all existing perltidyrc files,
859 but if you get an error message about bad parameters
860 involving a '#' the first time you run this version, please check the side
861 comments in your perltidyrc file, and add a space before the # if necessary.
862 You can quickly see the contents your perltidyrc file, if any, with the
867 The reason for this change is that some parameters naturally involve
868 the # symbol, and this can get interpreted as a side comment unless the
869 parameter is quoted. For example, to define -sphb=# it used to be necessary
872 to keep the # from becoming part of a comment. This was causing
873 trouble for new users. Now it can also be written without quotes:
876 - Fixed bug in processing some .perltidyrc files containing parameters with
877 an opening brace character, '{'. For example the following was
878 incorrectly processed:
879 --static-block-comment-prefix="^#{2,}[^\s#]"
882 - Added flag -boa (--break-at-old-attribute-breakpoints) which retains
883 any existing line breaks at attribute separation ':'. This is now the
884 default, use -nboa to deactivate. Thanks to Daphne Phister for the patch.
885 For example, given the following code, the line breaks at the ':'s will be
891 : Get('Name' => 'foo') : Set('Name');
893 whereas the previous version would have output a single line. If
894 the attributes are on a single line then they will remain on a single line.
896 - Added new flags --blank-lines-before-subs=n (-blbs=n) and
897 --blank-lines-before-packages=n (-blbp=n) to put n blank lines before
898 subs and packages. The old flag -bbs is now equivalent to -blbs=1 -blbp=1.
899 and -nbbs is equivalent to -blbs=0 -blbp=0. Requested by M. Schwern and
902 - Added feature -nsak='*' meaning no space between any keyword and opening
903 paren. This avoids listing entering a long list of keywords. Requested
906 - Added option to delete a backup of original file with in-place-modify (-b)
907 if there were no errors. This can be requested with the flag -bext='/'.
908 See documentation for details. Requested by M. Schwern and others.
910 - Fixed bug where the module postfilter parameter was not applied when -b
911 flag was used. This was discovered during testing.
913 - Fixed in-place-modify (-b) to work with symbolic links to source files.
914 Thanks to Ted Johnson.
916 - Fixed bug where the Perl::Tidy module did not allow -b to be used
919 - No extra blank line is added before a comment which follows
920 a short line ending in an opening token, for example like this:
924 # unless we follow a blank or comment line
925 $last_line_leading_type !~ /^[#b]$/
930 # unless we follow a blank or comment line
931 $last_line_leading_type !~ /^[#b]$/
934 The blank is not needed for readability in these cases because there
935 already is already space above the comment. If a blank already
936 exists there it will not be removed, so this change should not
937 change code which has previously been formatted with perltidy.
938 Thanks to R.W.Stauner.
940 - Likewise, no extra blank line is added above a comment consisting of a
941 single #, since nothing is gained in readability.
943 - Fixed error in which a blank line was removed after a #>>> directive.
944 Thanks to Ricky Morse.
946 - Unnecessary semicolons after given/when/default blocks are now removed.
948 - Fixed bug where an unwanted blank line could be added before
949 pod text in __DATA__ or __END__ section. Thanks to jidani.
951 - Changed exit flags from 1 to 0 to indicate success for -help, -version,
952 and all -dump commands. Also added -? as another way to dump the help.
953 Requested by Keith Neargarder.
955 - Fixed bug where .ERR and .LOG files were not written except for -it=2 or more
957 - Fixed bug where trailing blank lines at the end of a file were dropped when
960 - Fixed bug where a line occasionally ended with an extra space. This reduces
961 rhe number of instances where a second iteration gives a result different
964 - Updated documentation to note that the Tidy.pm module <stderr> parameter may
965 not be a reference to SCALAR or ARRAY; it must be a file.
967 - Syntax check with perl now work when the Tidy.pm module is processing
968 references to arrays and strings. Thanks to Charles Alderman.
970 - Zero-length files are no longer processed due to concerns for data loss
971 due to side effects in some scenarios.
973 - block labels, if any, are now included in closing side comment text
974 when the -csc flag is used. Suggested by Aaron. For example,
975 the label L102 in the following block is now included in the -csc text:
977 L102: for my $i ( 1 .. 10 ) {
979 } ## end L102: for my $i ( 1 .. 10 )
983 - added new flag -it=n or --iterations=n
984 This flag causes perltidy to do n complete iterations.
985 For most purposes the default of n=1 should be satisfactory. However n=2
986 can be useful when a major style change is being made, or when code is being
987 beautified on check-in to a source code control system. The run time will be
988 approximately proportional to n, and it should seldom be necessary to use a
989 value greater than n=2. Thanks to Jonathan Swartz
991 - A configuration file pathname begins with three dots, e.g.
992 ".../.perltidyrc", indicates that the file should be searched for starting
993 in the current directory and working upwards. This makes it easier to have
994 multiple projects each with their own .perltidyrc in their root directories.
995 Thanks to Jonathan Swartz for this patch.
997 - Added flag --notidy which disables all formatting and causes the input to be
998 copied unchanged. This can be useful in conjunction with hierarchical
999 F<.perltidyrc> files to prevent unwanted tidying.
1000 Thanks to Jonathan Swartz for this patch.
1002 - Added prefilters and postfilters in the call to the Tidy.pm module.
1003 Prefilters and postfilters. The prefilter is a code reference that
1004 will be applied to the source before tidying, and the postfilter
1005 is a code reference to the result before outputting.
1007 Thanks to Jonathan Swartz for this patch. He writes:
1008 This is useful for all manner of customizations. For example, I use
1009 it to convert the 'method' keyword to 'sub' so that perltidy will work for
1010 Method::Signature::Simple code:
1012 Perl::Tidy::perltidy(
1013 prefilter => sub { $_ = $_[0]; s/^method (.*)/sub $1 \#__METHOD/gm; return $_ },
1014 postfilter => sub { $_ = $_[0]; s/^sub (.*?)\s* \#__METHOD/method $1/gm; return $_ }
1017 - The starting indentation level of sections of code entabbed with -et=n
1018 is correctly guessed if it was also produced with the same -et=n flag. This
1019 keeps the indentation stable on repeated formatting passes within an editor.
1020 Thanks to Sam Kington and Glenn.
1022 - Functions with prototype '&' had a space between the function and opening
1023 peren. This space now only occurs if the flag --space-function-paren (-sfp)
1024 is set. Thanks to Zrajm Akfohg.
1026 - Patch to never put spaces around a bare word in braces beginning with ^ as in:
1027 my $before = ${^PREMATCH};
1028 even if requested with the -bt=0 flag because any spaces cause a syntax error in perl.
1029 Thanks to Fabrice Dulanoy.
1033 - Allow configuration file to be 'perltidy.ini' for Windows systems.
1034 i.e. C:\Documents and Settings\User\perltidy.ini
1035 and added documentation for setting configuation file under Windows in man
1036 page. Thanks to Stuart Clark.
1038 - Corrected problem of unwanted semicolons in hash ref within given/when code.
1039 Thanks to Nelo Onyiah.
1041 - added new flag -cscb or --closing-side-comments-balanced
1042 When using closing-side-comments, and the closing-side-comment-maximum-text
1043 limit is exceeded, then the comment text must be truncated. Previous
1044 versions of perltidy terminate with three dots, and this can still be
1045 achieved with -ncscb:
1047 perltidy -csc -ncscb
1049 } ## end foreach my $foo (sort { $b cmp $a ...
1051 However this causes a problem with older editors which cannot recognize
1052 comments or are not configured to doso because they cannot "bounce" around in
1053 the text correctly. The B<-cscb> flag tries to help them by
1054 appending appropriate terminal balancing structure:
1058 } ## end foreach my $foo (sort { $b cmp $a ... })
1060 Since there is much to be gained and little to be lost by doing this,
1061 the default is B<-cscb>. Use B<-ncscb> if you do not want this.
1063 Thanks to Daniel Becker for suggesting this option.
1065 - After an isolated closing eval block the continuation indentation will be
1066 removed so that the braces line up more like other blocks. Thanks to Yves Orton.
1085 -A new flag -asbl (or --opening-anonymous-sub-brace-on-new-line) has
1086 been added to put the opening brace of anonymous sub's on a new line,
1087 as in the following snippet:
1095 This was not possible before because the -sbl flag only applies to named
1096 subs. Thanks to Benjamin Krupp.
1098 -Fix tokenization bug with the following snippet
1099 print 'hi' if { x => 1, }->{x};
1100 which resulted in a semicolon being added after the comma. The workaround
1101 was to use -nasc, but this is no longer necessary. Thanks to Brian Duggan.
1103 -Fixed problem in which an incorrect error message could be triggered
1104 by the (unusual) combination of parameters -lp -i=0 -l=2 -ci=0 for
1105 example. Thanks to Richard Jelinek.
1107 -A new flag --keep-old-blank-lines=n has been added to
1108 give more control over the treatment of old blank lines in
1109 a script. The manual has been revised to discuss the new
1110 flag and clarify the treatment of old blank lines. Thanks
1115 -Improved support for perl 5.10: New quote modifier 'p', new block type UNITCHECK,
1116 new keyword break, improved formatting of given/when.
1118 -Corrected tokenization bug of something like $var{-q}.
1120 -Numerous minor formatting improvements.
1122 -Corrected list of operators controlled by -baao -bbao to include
1123 . : ? && || and or err xor
1125 -Corrected very minor error in log file involving incorrect comment
1126 regarding need for upper case of labels.
1128 -Fixed problem where perltidy could run for a very long time
1129 when given certain non-perl text files.
1131 -Line breaks in un-parenthesized lists now try to follow
1132 line breaks in the input file rather than trying to fill
1133 lines. This usually works better, but if this causes
1134 trouble you can use -iob to ignore any old line breaks.
1135 Example for the following input snippet:
1138 "conformability (Not the same dimension)\n",
1139 "\t", $have, " is ", text_unit($hu), "\n",
1140 "\t", $want, " is ", text_unit($wu), "\n",
1144 print "conformability (Not the same dimension)\n", "\t", $have, " is ",
1145 text_unit($hu), "\n", "\t", $want, " is ", text_unit($wu), "\n",;
1148 print "conformability (Not the same dimension)\n",
1149 "\t", $have, " is ", text_unit($hu), "\n",
1150 "\t", $want, " is ", text_unit($wu), "\n",
1155 -Added -fpsc option (--fixed-position-side-comment). Thanks to Ueli Hugenschmidt.
1156 For example -fpsc=40 tells perltidy to put side comments in column 40
1159 -Added -bbao and -baao options (--break-before-all-operators and
1160 --break-after-all-operators) to simplify command lines and configuration
1161 files. These define an initial preference for breaking at operators which can
1162 be modified with -wba and -wbb flags. For example to break before all operators
1163 except an = one could use --bbao -wba='=' rather than listing every
1164 single perl operator (except =) on a -wbb flag.
1166 -Added -kis option (--keep-interior-semicolons). Use the B<-kis> flag
1167 to prevent breaking at a semicolon if there was no break there in the
1168 input file. To illustrate, consider the following input lines:
1170 dbmclose(%verb_delim); undef %verb_delim;
1171 dbmclose(%expanded); undef %expanded;
1172 dbmclose(%global); undef %global;
1174 Normally these would be broken into six lines, but
1175 perltidy -kis gives:
1177 dbmclose(%verb_delim); undef %verb_delim;
1178 dbmclose(%expanded); undef %expanded;
1179 dbmclose(%global); undef %global;
1181 -Improved formatting of complex ternary statements, with indentation
1182 of nested statements.
1184 return defined( $cw->{Selected} )
1186 ? @{ $cw->{Selected} }
1187 : $cw->{Selected}[0]
1191 return defined( $cw->{Selected} )
1193 ? @{ $cw->{Selected} }
1194 : $cw->{Selected}[0]
1197 -Text following un-parenthesized if/unless/while/until statements get a
1198 full level of indentation. Suggested by Jeff Armstorng and others.
1200 return $ship->chargeWeapons("phaser-canon")
1201 if $encounter->description eq 'klingon'
1202 and $ship->firepower >= $encounter->firepower
1203 and $location->status ne 'neutral';
1205 return $ship->chargeWeapons("phaser-canon")
1206 if $encounter->description eq 'klingon'
1207 and $ship->firepower >= $encounter->firepower
1208 and $location->status ne 'neutral';
1212 -Fixed bug where #line directives were being indented. Thanks to
1217 -Fixed problem where an extra blank line was added after an =cut when either
1218 (a) the =cut started (not stopped) a POD section, or (b) -mbl > 1.
1219 Thanks to J. Robert Ray and Bill Moseley.
1223 -ole (--output-line-ending) and -ple (--preserve-line-endings) should
1224 now work on all systems rather than just unix systems. Thanks to Dan
1227 -Fixed problem of a warning issued for multiple subs for BEGIN subs
1228 and other control subs. Thanks to Heiko Eissfeldt.
1230 -Fixed problem where no space was introduced between a keyword or
1231 bareword and a colon, such as:
1233 ( ref($result) eq 'HASH' && !%$result ) ? undef: $result;
1237 -Added a utility program 'break_long_quotes.pl' to the examples directory of
1238 the distribution. It breaks long quoted strings into a chain of concatenated
1239 sub strings no longer than a selected length. Suggested by Michael Renner as
1240 a perltidy feature but was judged to be best done in a separate program.
1242 -Updated docs to remove extra < and >= from list of tokens
1243 after which breaks are made by default. Thanks to Bob Kleemann.
1245 -Removed improper uses of $_ to avoid conflicts with external calls, giving
1246 error message similar to:
1247 Modification of a read-only value attempted at
1248 /usr/share/perl5/Perl/Tidy.pm line 6907.
1249 Thanks to Michael Renner.
1251 -Fixed problem when errorfile was not a plain filename or filehandle
1252 in a call to Tidy.pm. The call
1253 perltidy(source => \$input, destination => \$output, errorfile => \$err);
1254 gave the following error message:
1255 Not a GLOB reference at /usr/share/perl5/Perl/Tidy.pm line 3827.
1256 Thanks to Michael Renner and Phillipe Bruhat.
1258 -Fixed problem where -sot would not stack an opening token followed by
1259 a side comment. Thanks to Jens Schicke.
1261 -improved breakpoints in complex math and other long statements. Example:
1264 log($n) + 0.577215664901532 + ( 1 / ( 2 * $n ) ) -
1265 ( 1 / ( 12 * ( $n**2 ) ) ) + ( 1 / ( 120 * ( $n**4 ) ) );
1268 log($n) + 0.577215664901532 +
1269 ( 1 / ( 2 * $n ) ) -
1270 ( 1 / ( 12 * ( $n**2 ) ) ) +
1271 ( 1 / ( 120 * ( $n**4 ) ) );
1273 -more robust vertical alignment of complex terminal else blocks and ternary
1278 -Eliminated bug where a here-doc invoked through an 'e' modifier on a pattern
1279 replacement text was not recognized. The tokenizer now recursively scans
1280 replacement text (but does not reformat it).
1282 -improved vertical alignment of terminal else blocks and ternary statements.
1283 Thanks to Chris for the suggestion.
1286 if ( IsBitmap() ) { return GetBitmap(); }
1287 elsif ( IsFiles() ) { return GetFiles(); }
1288 else { return GetText(); }
1291 if ( IsBitmap() ) { return GetBitmap(); }
1292 elsif ( IsFiles() ) { return GetFiles(); }
1293 else { return GetText(); }
1297 $opts{"t"} ? 'title'
1298 : $opts{"s"} ? 'subject'
1299 : $opts{"a"} ? 'author'
1304 $opts{"t"} ? 'title'
1305 : $opts{"s"} ? 'subject'
1306 : $opts{"a"} ? 'author'
1309 -improved indentation of try/catch blocks and other externally defined
1310 functions accepting a block argument. Thanks to jae.
1312 -Added support for Perl 5.10 features say and smartmatch.
1314 -Added flag -pbp (--perl-best-practices) as an abbreviation for parameters
1315 suggested in Damian Conway's "Perl Best Practices". -pbp is the same as:
1317 -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
1318 -wbb="% + - * / x != == >= <= =~ !~ < > | & >= < =
1319 **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
1321 Please note that the -st here restricts input to standard input; use
1322 -nst if necessary to override.
1324 -Eliminated some needless breaks at equals signs in -lp indentation.
1328 Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
1329 TOP + $y * (BOTTOM - TOP) / SIZE);
1331 $c = Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
1332 TOP + $y * (BOTTOM - TOP) / SIZE);
1334 A break at an equals is sometimes useful for preventing complex statements
1335 from hitting the line length limit. The decision to do this was
1336 over-eager in some cases and has been improved. Thanks to Royce Reece.
1338 -qw quotes contained in braces, square brackets, and parens are being
1339 treated more like those containers as far as stacking of tokens. Also
1340 stack of closing tokens ending ');' will outdent to where the ');' would
1341 have outdented if the closing stack is matched with a similar opening stack.
1343 OLD: perltidy -soc -sct
1344 __PACKAGE__->load_components(
1350 NEW: perltidy -soc -sct
1351 __PACKAGE__->load_components( qw(
1355 Thanks to Aran Deltac
1357 -Eliminated some undesirable or marginally desirable vertical alignments.
1358 These include terminal colons, opening braces, and equals, and particularly
1359 when just two lines would be aligned.
1362 my $accurate_timestamps = $Stamps{lnk};
1366 my $accurate_timestamps = $Stamps{lnk};
1369 -Corrected a problem with -mangle in which a space would be removed
1370 between a keyword and variable beginning with ::.
1374 -Attribute argument lists are now correctly treated as quoted strings
1375 and not formatted. This is the most important update in this version.
1376 Thanks to Borris Zentner, Greg Ferguson, Steve Kirkup.
1378 -Updated to recognize the defined or operator, //, to be released in Perl 10.
1379 Thanks to Sebastien Aperghis-Tramoni.
1381 -A useful utility perltidyrc_dump.pl is included in the examples section. It
1382 will read any perltidyrc file and write it back out in a standard format
1383 (though comments are lost).
1385 -Added option to have perltidy read and return a hash with the contents of a
1386 perltidyrc file. This may be used by Leif Eriksen's tidyview code. This
1387 feature is used by the demonstration program 'perltidyrc_dump.pl' in the
1390 -Improved error checking in perltidyrc files. Unknown bare words were not
1393 -The --dump-options parameter now dumps parameters in the format required by a
1396 -V-Strings with underscores are now recognized.
1397 For example: $v = v1.2_3;
1399 -cti=3 option added which gives one extra indentation level to closing
1400 tokens always. This provides more predictable closing token placement
1401 than cti=2. If you are using cti=2 you might want to try cti=3.
1403 -To identify all left-adjusted comments as static block comments, use C<-sbcp='^#'>.
1405 -New parameters -fs, -fsb, -fse added to allow sections of code between #<<<
1406 and #>>> to be passed through verbatim. This is enabled by default and turned
1407 off by -nfs. Flags -fsb and -fse allow other beginning and ending markers.
1408 Thanks to Wolfgang Werner and Marion Berryman for suggesting this.
1410 -added flag -skp to put a space between all Perl keywords and following paren.
1411 The default is to only do this for certain keywords. Suggested by
1414 -added flag -sfp to put a space between a function name and following paren.
1415 The default is not to do this. Suggested by H.Merijn Brand.
1417 -Added patch to avoid breaking GetOpt::Long::Configure set by calling program.
1418 Thanks to Philippe Bruhat.
1420 -An error was fixed in which certain parameters in a .perltidyrc file given
1421 without the equals sign were not recognized. That is,
1422 '--brace-tightness 0' gave an error but '--brace-tightness=0' worked
1423 ok. Thanks to Zac Hansen.
1425 -An error preventing the -nwrs flag from working was corrected. Thanks to
1428 -Corrected some alignment problems with entab option.
1430 -A bug with the combination of -lp and -extrude was fixed (though this
1431 combination doesn't really make sense). The bug was that a line with
1432 a single zero would be dropped. Thanks to Cameron Hayne.
1434 -Updated Windows detection code to avoid an undefined variable.
1435 Thanks to Joe Yates and Russ Jones.
1437 -Improved formatting for short trailing statements following a closing paren.
1438 Thanks to Joe Matarazzo.
1440 -The handling of the -icb (indent closing block braces) flag has been changed
1441 slightly to provide more consistent and predictable formatting of complex
1442 structures. Instead of giving a closing block brace the indentation of the
1443 previous line, it is now given one extra indentation level. The two methods
1444 give the same result if the previous line was a complete statement, as in this
1453 The change also fixes a problem with empty blocks such as:
1463 -A problem with -icb was fixed in which a closing brace was misplaced when
1464 it followed a quote which spanned multiple lines.
1466 -Some improved breakpoints for -wba='&& || and or'
1468 -Fixed problem with misaligned cuddled else in complex statements
1469 when the -bar flag was also used. Thanks to Alex and Royce Reese.
1471 -Corrected documentation to show that --outdent-long-comments is the default.
1472 Thanks to Mario Lia.
1474 -New flag -otr (opening-token-right) is similar to -bar (braces-always-right)
1475 but applies to non-structural opening tokens.
1477 -new flags -sot (stack-opening-token), -sct (stack-closing-token).
1482 -The default has been changed to not do syntax checking with perl.
1483 Use -syn if you want it. Perltidy is very robust now, and the -syn
1484 flag now causes more problems than it's worth because of BEGIN blocks
1485 (which get executed with perl -c). For example, perltidy will never
1486 return when trying to beautify this code if -syn is used:
1488 BEGIN { 1 while { }; }
1490 Although this is an obvious error, perltidy is often run on untested
1491 code which is more likely to have this sort of problem. A more subtle
1494 BEGIN { use FindBin; }
1496 which may hang on some systems using -syn if a shared file system is
1499 -Changed style -gnu to use -cti=1 instead of -cti=2 (see next item).
1500 In most cases it looks better. To recover the previous format, use
1503 -Added flags -cti=n for finer control of closing token indentation.
1504 -cti = 0 no extra indentation (default; same as -nicp)
1505 -cti = 1 enough indentation so that the closing token
1506 aligns with its opening token.
1507 -cti = 2 one extra indentation level if the line has the form
1508 ); ]; or }; (same as -icp).
1510 The new option -cti=1 works well with -lp:
1514 # perltidy -lp -cti=1
1516 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1517 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
1520 # perltidy -lp -cti=2
1522 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1523 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
1525 This is backwards compatible with -icp. See revised manual for
1526 details. Suggested by Mike Pennington.
1528 -Added flag '--preserve-line-endings' or '-ple' to cause the output
1529 line ending to be the same as in the input file, for unix, dos,
1530 or mac line endings. Only works under unix. Suggested by
1533 -Added flag '--output-line-ending=s' or '-ole=s' where s=dos or win,
1534 unix, or mac. Only works under unix.
1536 -Files with Mac line endings should now be handled properly under unix
1537 and dos without being passed through a converter.
1539 -You may now include 'and', 'or', and 'xor' in the list following
1540 '--want-break-after' to get line breaks after those keywords rather than
1541 before them. Suggested by Rainer Hochschild.
1543 -Corrected problem with command line option for -vtc=n and -vt=n. The
1544 equals sign was being eaten up by the Windows shell so perltidy didn't
1549 -Corrected cause of warning message with recent versions of Perl:
1550 "Possible precedence problem on bitwise & operator at ..."
1551 Thanks to Jim Files.
1553 -fixed bug with -html with '=for pod2html' sections, in which code/pod
1554 output order was incorrect. Thanks to Tassilo von Parseval.
1556 -fixed bug when the -html flag is used, in which the following error
1557 message, plus others, appear:
1558 did not see <body> in pod2html output
1559 This was caused by a change in the format of html output by pod2html
1560 VERSION 1.04 (included with perl 5.8). Thanks to Tassilo von Parseval.
1562 -Fixed bug where an __END__ statement would be mistaken for a label
1563 if it is immediately followed by a line with a leading colon. Thanks
1566 -Implemented guessing logic for brace types when it is ambiguous. This
1567 has been on the TODO list a long time. Thanks to Boris Zentner for
1570 -Long options may now be negated either as '--nolong-option'
1571 or '--no-long-option'. Thanks to Philip Newton for the suggestion.
1573 -added flag --html-entities or -hent which controls the use of
1574 Html::Entities for html formatting. Use --nohtml-entities or -nhent to
1575 prevent the use of Html::Entities to encode special symbols. The
1576 default is -hent. Html::Entities when formatting perl text to escape
1577 special symbols. This may or may not be the right thing to do,
1578 depending on browser/language combinations. Thanks to Burak Gursoy for
1581 -Bareword strings with leading '-', like, '-foo' now count as 1 token
1582 for horizontal tightness. This way $a{'-foo'}, $a{foo}, and $a{-foo}
1583 are now all treated similarly. Thus, by default, OLD: $a{ -foo } will
1584 now be NEW: $a{-foo}. Suggested by Mark Olesen.
1586 -added 2 new flags to control spaces between keywords and opening parens:
1587 -sak=s or --space-after-keyword=s, and
1588 -nsak=s or --nospace-after-keyword=s, where 's' is a list of keywords.
1590 The new default list of keywords which get a space is:
1592 "my local our and or eq ne if else elsif until unless while for foreach
1593 return switch case given when"
1595 Use -sak=s and -nsak=s to add and remove keywords from this list,
1598 Explanation: Stephen Hildrey noted that perltidy was being inconsistent
1599 in placing spaces between keywords and opening parens, and sent a patch
1600 to give user control over this. The above list was selected as being
1601 a reasonable default keyword list. Previously, perltidy
1602 had a hardwired list which also included these keywords:
1604 push pop shift unshift join split die
1606 but did not have 'our'. Example: if you prefer to make perltidy behave
1607 exactly as before, you can include the following two lines in your
1610 -sak="push pop local shift unshift join split die"
1613 -Corrected html error in .toc file when -frm -html is used (extra ");
1614 browsers were tolerant of it.
1616 -Improved alignment of chains of binary and ?/: operators. Example:
1630 -improved breakpoint choices involving '->'
1632 -Corrected tokenization of things like ${#}. For example,
1633 ${#} is valid, but ${# } is a syntax error.
1635 -Corrected minor tokenization errors with indirect object notation.
1636 For example, 'new A::()' works now.
1638 -Minor tokenization improvements; all perl code distributed with perl 5.8
1639 seems to be parsed correctly except for one instance (lextest.t)
1644 -Implemented scalar attributes. Thanks to Sean Tobin for noting this.
1646 -Fixed glitch introduced in previous release where -pre option
1647 was not outputting a leading html <pre> tag.
1649 -Numerous minor improvements in vertical alignment, including the following:
1651 -Improved alignment of opening braces in many cases. Needed for improved
1652 switch/case formatting, and also suggested by Mark Olesen for sort/map/grep
1653 formatting. For example:
1658 sort { $a->[1] <=> $b->[1] }
1659 map { [ $_, -M ] } @filenames;
1664 sort { $a->[1] <=> $b->[1] }
1665 map { [ $_, -M ] } @filenames;
1667 -Eliminated alignments across unrelated statements. Example:
1669 $borrowerinfo->configure( -state => 'disabled' );
1670 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
1673 $borrowerinfo->configure( -state => 'disabled' );
1674 $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
1676 Thanks to Mark Olesen for suggesting this.
1678 -Improved alignement of '='s in certain cases.
1679 Thanks to Norbert Gruener for sending an example.
1681 -Outdent-long-comments (-olc) has been re-instated as a default, since
1682 it works much better now. Use -nolc if you want to prevent it.
1684 -Added check for 'perltidy file.pl -o file.pl', which causes file.pl
1685 to be lost. (The -b option should be used instead). Thanks to mreister
1686 for reporting this problem.
1690 -Switch/case or given/when syntax is now recognized. Its vertical alignment
1691 is not great yet, but it parses ok. The words 'switch', 'case', 'given',
1692 and 'when' are now treated as keywords. If this causes trouble with older
1693 code, we could introduce a switch to deactivate it. Thanks to Stan Brown
1694 and Jochen Schneider for recommending this.
1696 -Corrected error parsing sub attributes with call parameters.
1697 Thanks to Marc Kerr for catching this.
1699 -Sub prototypes no longer need to be on the same line as sub names.
1701 -a new flag -frm or --frames will cause html output to be in a
1702 frame, with table of contents in the left panel and formatted source
1703 in the right panel. Try 'perltidy -html -frm somemodule.pm' for example.
1705 -The new default for -html formatting is to pass the pod through Pod::Html.
1706 The result is syntax colored code within your pod documents. This can be
1707 deactivated with -npod. Thanks to those who have written to discuss this,
1708 particularly Mark Olesen and Hugh Myers.
1710 -the -olc (--outdent-long-comments) option works much better. It now outdents
1711 groups of consecutive comments together, and by just the amount needed to
1712 avoid having any one line exceeding the maximum line length.
1714 -block comments are now trimmed of trailing whitespace.
1716 -if a directory specified with -opath does not exist, it will be created.
1718 -a table of contents to packages and subs is output when -html is used.
1719 Use -ntoc to prevent this.
1721 -fixed an unusual bug in which a 'for' statement following a 'format'
1722 statement was not correctly tokenized. Thanks to Boris Zentner for
1725 -Tidy.pm is no longer dependent on modules IO::Scalar and IO::ScalarArray.
1726 There were some speed issues. Suggested by Joerg Walter.
1728 -The treatment of quoted wildcards (file globs) is now system-independent.
1731 perltidy 'b*x.p[lm]'
1733 would match box.pl, box.pm, brinx.pm under any operating system. Of
1734 course, anything unquoted will be subject to expansion by any shell.
1736 -default color for keywords under -html changed from
1737 SaddleBrown (#8B4513) to magenta4 (#8B008B).
1739 -fixed an arg parsing glitch in which something like:
1741 would trigger the help message and exit, rather than operate on the
1746 -New option '-b' or '--backup-and-modify-in-place' will cause perltidy to
1747 overwrite the original file with the tidied output file. The original
1748 file will be saved with a '.bak' extension (which can be changed with
1749 -bext=s). Thanks to Rudi Farkas for the suggestion.
1751 -An index to all subs is included at the top of -html output, unless
1752 only the <pre> section is written.
1754 -Anchor lines of the form <a name="mysub"></a> are now inserted at key points
1755 in html output, such as before sub definitions, for the convenience of
1756 postprocessing scripts. Suggested by Howard Owen.
1758 -The cuddled-else (-ce) flag now also makes cuddled continues, like
1761 while ( ( $pack, $file, $line ) = caller( $i++ ) ) {
1767 Suggested by Simon Perreault.
1769 -Fixed bug in which an extra blank line was added before an =head or
1770 similar pod line after an __END__ or __DATA__ line each time
1771 perltidy was run. Also, an extra blank was being added after
1772 a terminal =cut. Thanks to Mike Birdsall for reporting this.
1776 -Fixed bug in which space was inserted in a hyphenated hash key:
1777 my $val = $myhash{USER-NAME};
1779 my $val = $myhash{USER -NAME};
1780 Thanks to an anonymous bug reporter at sourceforge.
1782 -Fixed problem with the '-io' ('--indent-only') where all lines
1783 were double spaced. Thanks to Nick Andrew for reporting this bug.
1785 -Fixed tokenization error in which something like '-e1' was
1788 -Corrected a rare problem involving older perl versions, in which
1789 a line break before a bareword caused problems with 'use strict'.
1790 Thanks to Wolfgang Weisselberg for noting this.
1792 -More syntax error checking added.
1794 -Outdenting labels (-ola) has been made the default, in order to follow the
1795 perlstyle guidelines better. It's probably a good idea in general, but
1796 if you do not want this, use -nola in your .perltidyrc file.
1798 -Updated rules for padding logical expressions to include more cases.
1799 Thanks to Wolfgang Weisselberg for helpful discussions.
1801 -Added new flag -osbc (--outdent-static-block-comments) which will
1802 outdent static block comments by 2 spaces (or whatever -ci equals).
1803 Requested by Jon Robison.
1807 -Corrected a bug, introduced in the previous release, in which some
1808 closing side comments (-csc) could have incorrect text. This is
1809 annoying but will be correct the next time perltidy is run with -csc.
1811 -Fixed bug where whitespace was being removed between 'Bar' and '()'
1812 in a use statement like:
1816 -Whenever possible, if a logical expression is broken with leading
1817 '&&', '||', 'and', or 'or', then the leading line will be padded
1818 with additional space to produce alignment. This has been on the
1819 todo list for a long time; thanks to Frank Steinhauer for reminding
1820 me to do it. Notice the first line after the open parens here:
1824 !param("rules.to.$linecount")
1825 && !param("rules.from.$linecount")
1826 && !param("rules.subject.$linecount")
1828 param("rules.fieldname.$linecount")
1829 && param("rules.fieldval.$linecount")
1831 && !param("rules.size.$linecount")
1832 && !param("rules.custom.$linecount")
1837 !param("rules.to.$linecount")
1838 && !param("rules.from.$linecount")
1839 && !param("rules.subject.$linecount")
1841 param("rules.fieldname.$linecount")
1842 && param("rules.fieldval.$linecount")
1844 && !param("rules.size.$linecount")
1845 && !param("rules.custom.$linecount")
1850 -Corrected a mistokenization of variables for a package with a name
1851 equal to a perl keyword. For example:
1855 sub qx{print "Hello from my::qx\n";}
1857 In this case, the leading 'my' was mistokenized as a keyword, and a
1858 space was being place between 'my' and '::'. This has been
1859 corrected. Thanks to Martin Sluka for discovering this.
1861 -A new flag -bol (--break-at-old-logic-breakpoints)
1862 has been added to control whether containers with logical expressions
1863 should be broken open. This is the default.
1865 -A new flag -bok (--break-at-old-keyword-breakpoints)
1866 has been added to follow breaks at old keywords which return lists,
1867 such as sort and map. This is the default.
1869 -A new flag -bot (--break-at-old-trinary-breakpoints) has been added to
1870 follow breaks at trinary (conditional) operators. This is the default.
1872 -A new flag -cab=n has been added to control breaks at commas after
1873 '=>' tokens. The default is n=1, meaning break unless this breaks
1874 open an existing on-line container.
1876 -A new flag -boc has been added to allow existing list formatting
1877 to be retained. (--break-at-old-comma-breakpoints). See updated manual.
1879 -A new flag -iob (--ignore-old-breakpoints) has been added to
1880 prevent the locations of old breakpoints from influencing the output
1883 -Corrected problem where nested parentheses were not getting full
1884 indentation. This has been on the todo list for some time; thanks
1885 to Axel Rose for a snippet demonstrating this issue.
1887 OLD: inner list is not indented
1891 $ret->name, $user->username, $user->host,
1892 $user->server->name, $user->nick, "H"
1900 $ret->name, $user->username, $user->host,
1901 $user->server->name, $user->nick, "H"
1905 -Code cleaned up by removing the following unused, undocumented flags.
1906 They should not be in any .perltidyrc files because they were just
1907 experimental flags which were never documented. Most of them placed
1908 artificial limits on spaces, and Wolfgang Weisselberg convinced me that
1909 most of them they do more harm than good by causing unexpected results.
1911 --maximum-continuation-indentation (-mci)
1912 --maximum-whitespace-columns
1913 --maximum-space-to-comment (-xsc)
1914 --big-space-jump (-bsj)
1916 -Pod file 'perltidy.pod' has been appended to the script 'perltidy', and
1917 Tidy.pod has been append to the module 'Tidy.pm'. Older MakeMaker's
1918 were having trouble.
1920 -A new flag -isbc has been added for more control on comments. This flag
1921 has the effect that if there is no leading space on the line, then the
1922 comment will not be indented, and otherwise it may be. If both -ibc and
1923 -isbc are set, then -isbc takes priority. Thanks to Frank Steinhauer
1924 for suggesting this.
1926 -A new document 'stylekey.pod' has been created to quickly guide new users
1927 through the maze of perltidy style parameters. An html version is
1928 on the perltidy web page. Take a look! It should be very helpful.
1930 -Parameters for controlling 'vertical tightness' have been added:
1931 -vt and -vtc are the main controls, but finer control is provided
1932 with -pvt, -pcvt, -bvt, -bcvt, -sbvt, -sbcvt. Block brace vertical
1933 tightness controls have also been added.
1934 See updated manual and also see 'stylekey.pod'. Simple examples:
1936 # perltidy -lp -vt=1 -vtc=1
1937 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1938 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
1940 # perltidy -lp -vt=1 -vtc=0
1941 @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1942 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
1945 -Lists which do not format well in uniform columns are now better
1946 identified and formated.
1949 return $c->create( 'polygon', $x, $y, $x + $ruler_info{'size'},
1950 $y + $ruler_info{'size'}, $x - $ruler_info{'size'},
1951 $y + $ruler_info{'size'} );
1956 $x + $ruler_info{'size'},
1957 $y + $ruler_info{'size'},
1958 $x - $ruler_info{'size'},
1959 $y + $ruler_info{'size'}
1963 radlablist($f1, pad('Initial', $p), $b->{Init}->get_panel_ref, 'None ',
1964 'None', 'Default', 'Default', 'Simple', 'Simple');
1968 $b->{Init}->get_panel_ref,
1969 'None ', 'None', 'Default', 'Default', 'Simple', 'Simple');
1971 -Corrected problem where an incorrect html filename was generated for
1972 external calls to Tidy.pm module. Fixed incorrect html title when
1973 Tidy.pm is called with IO::Scalar or IO::Array source.
1975 -Output file permissons are now set as follows. An output script file
1976 gets the same permission as the input file, except that owner
1977 read/write permission is added (otherwise, perltidy could not be
1978 rerun). Html output files use system defaults. Previously chmod 0755
1979 was used in all cases. Thanks to Mark Olesen for bringing this up.
1981 -Missing semicolons will not be added in multi-line blocks of type
1982 sort, map, or grep. This brings perltidy into closer agreement
1983 with common practice. Of course, you can still put semicolons
1984 there if you like. Thanks to Simon Perreault for a discussion of this.
1986 -Most instances of extra semicolons are now deleted. This is
1987 particularly important if the -csc option is used. Thanks to Wolfgang
1988 Weisselberg for noting this. For example, the following line
1989 (produced by 'h2xs' :) has an extra semicolon which will now be
1992 BEGIN { plan tests => 1 };
1994 -New parameter -csce (--closing-side-comment-else-flag) can be used
1995 to control what text is appended to 'else' and 'elsif' blocks.
1996 Default is to just add leading 'if' text to an 'else'. See manual.
1998 -The -csc option now labels 'else' blocks with additinal information
1999 from the opening if statement and elsif statements, if space.
2000 Thanks to Wolfgang Weisselberg for suggesting this.
2002 -The -csc option will now remove any old closing side comments
2003 below the line interval threshold. Thanks to Wolfgang Weisselberg for
2006 -The abbreviation feature, which was broken in the previous version,
2007 is now fixed. Thanks to Michael Cartmell for noting this.
2009 -Vertical alignment is now done for '||=' .. somehow this was
2014 -This version uses modules for the first time, and a standard perl
2015 Makefile.PL has been supplied. However, perltidy may still be
2016 installed as a single script, without modules. See INSTALL for
2019 -The man page 'perl2web' has been merged back into the main 'perltidy'
2020 man page to simplify installation. So you may remove that man page
2021 if you have an older installation.
2023 -Added patch from Axel Rose for MacPerl. The patch prompts the user
2024 for command line arguments before calling the module
2025 Perl::Tidy::perltidy.
2027 -Corrected bug with '-bar' which was introduced in the previous
2028 version. A closing block brace was being indented. Thanks to
2029 Alexandros M Manoussakis for reporting this.
2031 -New parameter '--entab-leading-whitespace=n', or '-et=n', has been
2032 added for those who prefer tabs. This behaves different from the
2033 existing '-t' parameter; see updated man page. Suggested by Mark
2036 -New parameter '--perl-syntax-check-flags=s' or '-pcsf=s' can be
2037 used to change the flags passed to perltidy in a syntax check.
2038 See updated man page. Suggested by Mark Olesen.
2040 -New parameter '--output-path=s' or '-opath=s' will cause output
2041 files to be placed in directory s. See updated man page. Thanks for
2042 Mark Olesen for suggesting this.
2044 -New parameter --dump-profile (or -dpro) will dump to
2045 standard output information about the search for a
2046 configuration file, the name of whatever configuration file
2047 is selected, and its contents. This should help debugging
2048 config files, especially on different Windows systems.
2050 -The -w parameter now notes possible errors of the form:
2052 $comment = s/^\s*(\S+)\..*/$1/; # trim whitespace
2054 -Corrections added for a leading ':' and for leaving a leading 'tcsh'
2055 line untouched. Mark Olesen reported that lines of this form were
2056 accepted by perl but not by perltidy:
2058 : # use -*- perl -*-
2059 eval 'exec perl -wS $0 "$@"' # shell should exec 'perl'
2060 unless 1; # but Perl should skip this one
2062 Perl will silently swallow a leading colon on line 1 of a
2063 script, and now perltidy will do likewise. For example,
2064 this is a valid script, provided that it is the first line,
2067 : print "Hello World\n";
2069 Also, perltidy will now mark a first line with leading ':' followed by
2070 '#' as type SYSTEM (just as a #! line), not to be formatted.
2072 -List formatting improved for certain lists with special
2073 initial terms, such as occur with 'printf', 'sprintf',
2074 'push', 'pack', 'join', 'chmod'. The special initial term is
2075 now placed on a line by itself. For example, perltidy -gnu
2079 "C4", hex($SourceAddr[0]),
2080 hex($SourceAddr[1]), hex($SourceAddr[2]),
2086 hex($SourceAddr[0]), hex($SourceAddr[1]),
2087 hex($SourceAddr[2]), hex($SourceAddr[3]));
2091 @{$$self{states}}, '64', '66', '68',
2092 '70', '72', '74', '76',
2093 '78', '80', '82', '84',
2094 '86', '88', '90', '92',
2095 '94', '96', '98', '100',
2102 '64', '66', '68', '70', '72', '74', '76',
2103 '78', '80', '82', '84', '86', '88', '90',
2104 '92', '94', '96', '98', '100', '102', '104'
2107 -Lists of complex items, such as matricies, are now detected
2108 and displayed with just one item per row:
2111 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2112 [ 1, tan( deg2rad($a) ), 0 ], [ tan( deg2rad($b) ), 1, 0 ],
2117 $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
2118 [ 1, tan( deg2rad($a) ), 0 ],
2119 [ tan( deg2rad($b) ), 1, 0 ],
2123 -The perl syntax check will be turned off for now when input is from
2124 standard input or standard output. The reason is that this requires
2125 temporary files, which has produced far too many problems during
2126 Windows testing. For example, the POSIX module under Windows XP/2000
2127 creates temporary names in the root directory, to which only the
2128 administrator should have permission to write.
2130 -Merged patch sent by Yves Orton to handle appropriate
2131 configuration file locations for different Windows varieties
2132 (2000, NT, Me, XP, 95, 98).
2134 -Added patch to properly handle a for/foreach loop without
2135 parens around a list represented as a qw. I didn't know this
2136 was possible until Wolfgang Weisselberg pointed it out:
2138 foreach my $key qw\Uno Due Tres Quadro\ {
2142 But Perl will give a syntax error without the $ variable; ie this will
2145 foreach qw\Uno Due Tres Quadro\ {
2149 -Merged Windows version detection code sent by Yves Orton. Perltidy
2150 now automatically turns off syntax checking for Win 9x/ME versions,
2151 and this has solved a lot of robustness problems. These systems
2152 cannot reliably handle backtick operators. See man page for
2155 -Merged VMS filename handling patch sent by Michael Cartmell. (Invalid
2156 output filenames were being created in some cases).
2158 -Numerous minor improvements have been made for -lp style indentation.
2160 -Long C-style 'for' expressions will be broken after each ';'.
2162 'perltidy -gnu' gives:
2165 for ($status = $db->seq($key, $value, R_CURSOR()) ; $status == 0
2166 and $key eq $origkey ; $status = $db->seq($key, $value, R_NEXT()))
2169 for ($status = $db->seq($key, $value, R_CURSOR()) ;
2170 $status == 0 and $key eq $origkey ;
2171 $status = $db->seq($key, $value, R_NEXT()))
2173 -For the -lp option, a single long term within parens
2174 (without commas) now has better alignment. For example,
2178 $self->throw("Must specify a known host, not $location,"
2179 . " possible values ("
2180 . join (",", sort keys %hosts) . ")");
2183 $self->throw("Must specify a known host, not $location,"
2184 . " possible values ("
2185 . join (",", sort keys %hosts) . ")");
2189 -This version is about 20 percent faster than the previous
2190 version as a result of optimization work. The largest gain
2191 came from switching to a dispatch hash table in the
2194 -perltidy -html will check to see if HTML::Entities is
2195 installed, and if so, it will use it to encode unsafe
2198 -Added flag -oext=ext to change the output file extension to
2199 be different from the default ('tdy' or 'html'). For
2202 perltidy -html -oext=htm filename
2204 will produce filename.htm
2206 -Added flag -cscw to issue warnings if a closing side comment would replace
2207 an existing, different side comments. See the man page for details.
2208 Thanks to Peter Masiar for helpful discussions.
2210 -Corrected tokenization error of signed hex/octal/binary numbers. For
2211 example, the first hex number below would have been parsed correctly
2212 but the second one was not:
2213 if ( ( $tmp >= 0x80_00_00 ) || ( $tmp < -0x80_00_00 ) ) { }
2215 -'**=' was incorrectly tokenized as '**' and '='. This only
2216 caused a problem with the -extrude opton.
2218 -Corrected a divide by zero when -extrude option is used
2220 -The flag -w will now contain all errors reported by 'perl -c' on the
2221 input file, but otherwise they are not reported. The reason is that
2222 perl will report lots of problems and syntax errors which are not of
2223 interest when only a small snippet is being formatted (such as missing
2224 modules and unknown bare words). Perltidy will always report all
2225 significant syntax errors that it finds, such as unbalanced braces,
2226 unless the -q (quiet) flag is set.
2228 -Merged modifications created by Hugh Myers into perltidy.
2229 These include a 'streamhandle' routine which allows perltidy
2230 as a module to operate on input and output arrays and strings
2231 in addition to files. Documentation and new packaging as a
2232 module should be ready early next year; This is an elegant,
2233 powerful update; many thanks to Hugh for contributing it.
2237 -added a tentative patch which tries to keep any existing breakpoints
2238 at lines with leading keywords map,sort,eval,grep. The idea is to
2239 improve formatting of sequences of list operations, as in a schwartzian
2243 my @sorted = map { $_->[0] }
2244 sort { $a->[1] <=> $b->[1] }
2245 map { [ $_, rand ] } @list;
2249 map { $_->[0] } sort { $a->[1] <=> $b->[1] } map { [ $_, rand ] } @list;
2252 my @sorted = map { $_->[0] }
2253 sort { $a->[1] <=> $b->[1] }
2254 map { [ $_, rand ] } @list;
2256 The new alignment is not as nice as the input, but this is an improvement.
2257 Thanks to Yves Orton for this suggestion.
2259 -modified indentation logic so that a line with leading opening paren,
2260 brace, or square bracket will never have less indentation than the
2261 line with the corresponding opening token. Here's a simple example:
2265 -text => "New Document",
2266 -command => \&new_document
2272 Note how the closing ');' is lined up with the first line, even
2273 though it closes a paren in the 'pack' line. That seems wrong.
2277 -text => "New Document",
2278 -command => \&new_document
2284 This seems nicer: you can up-arrow with an editor and arrive at the
2285 opening 'pack' line.
2287 -corrected minor glitch in which cuddled else (-ce) did not get applied
2288 to an 'unless' block, which should look like this:
2296 Thanks to Jeremy Mates for reporting this.
2298 -The man page has been reorganized to parameters easier to find.
2300 -Added check for multiple definitions of same subroutine. It is easy
2301 to introduce this problem when cutting and pasting. Perl does not
2302 complain about it, but it can lead to disaster.
2304 -The command -pro=filename or -profile=filename may be used to specify a
2305 configuration file which will override the default name of .perltidyrc.
2306 There must not be a space on either side of the '=' sign. I needed
2307 this to be able to easily test perltidy with a variety of different
2308 configuration files.
2310 -Side comment alignment has been improved somewhat across frequent level
2311 changes, as in short if/else blocks. Thanks to Wolfgang Weisselberg
2312 for pointing out this problem. For example:
2315 if ( ref $self ) { # Called as a method
2318 else { # Regular procedure call
2324 if ( ref $self ) { # Called as a method
2327 else { # Regular procedure call
2332 -New command -ssc (--static-side-comment) and related command allows
2333 side comments to be spaced close to preceding character. This is
2334 useful for displaying commented code as side comments.
2336 -New command -csc (--closing-side-comment) and several related
2337 commands allow comments to be added to (and deleted from) any or all
2338 closing block braces. This can be useful if you have to maintain large
2339 programs, especially those that you didn't write. See updated man page.
2340 Thanks to Peter Masiar for this suggestion. For a simple example:
2345 if ( !defined( $_[0] ) ) {
2346 print("Hello, World\n");
2349 print( $_[0], "\n" );
2353 This added '## end sub foo' to the closing brace.
2354 To remove it, perltidy -ncsc.
2356 -New commands -ola, for outdenting labels, and -okw, for outdenting
2357 selected control keywords, were implemented. See the perltidy man
2358 page for details. Thanks to Peter Masiar for this suggestion.
2360 -Hanging side comment change: a comment will not be considered to be a
2361 hanging side comment if there is no leading whitespace on the line.
2362 This should improve the reliability of identifying hanging side comments.
2363 Thanks to Peter Masiar for this suggestion.
2365 -Two new commands for outdenting, -olq (outdent-long-quotes) and -olc
2366 (outdent-long-comments), have been added. The original -oll
2367 (outdent-long-lines) remains, and now is an abbreviation for -olq and -olc.
2368 The new default is just -olq. This was necessary to avoid inconsistency with
2369 the new static block comment option.
2371 -Static block comments: to provide a way to display commented code
2372 better, the convention is used that comments with a leading '##' should
2373 not be formatted as usual. Please see '-sbc' (or '--static-block-comment')
2374 for documentation. It can be deactivated with with -nsbc, but
2375 should not normally be necessary. Thanks to Peter Masiar for this
2378 -Two changes were made to help show structure of complex lists:
2379 (1) breakpoints are forced after every ',' in a list where any of
2380 the list items spans multiple lines, and
2381 (2) List items which span multiple lines now get continuation indentation.
2383 The following example illustrates both of these points. Many thanks to
2384 Wolfgang Weisselberg for this snippet and a discussion of it; this is a
2385 significant formatting improvement. Note how it is easier to see the call
2386 parameters in the NEW version:
2389 assert( __LINE__, ( not defined $check )
2392 or $check eq "old", "Error in parameters",
2393 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
2394 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
2395 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef" );
2400 ( not defined $check )
2404 "Error in parameters",
2405 defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
2406 defined $db_new ? ( ref $db_new ? ref $db_new : $db_new ) : "undef",
2407 defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef"
2410 Another example shows how this helps displaying lists:
2413 %{ $self->{COMPONENTS} } = (
2415 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
2417 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
2420 The structure is clearer with the added indentation:
2423 %{ $self->{COMPONENTS} } = (
2425 { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
2427 { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
2430 -The structure of nested logical expressions is now displayed better.
2431 Thanks to Wolfgang Weisselberg for helpful discussions. For example,
2432 note how the status of the final 'or' is displayed in the following:
2436 and null( $op->sibling )
2437 and $op->ppaddr eq "pp_null"
2438 and class($op) eq "UNOP"
2439 and ( ( $op->first->ppaddr =~ /^pp_(and|or)$/
2440 and $op->first->first->sibling->ppaddr eq "pp_lineseq" )
2441 or ( $op->first->ppaddr eq "pp_lineseq"
2442 and not null $op->first->first->sibling
2443 and $op->first->first->sibling->ppaddr eq "pp_unstack" ) ) );
2448 and null( $op->sibling )
2449 and $op->ppaddr eq "pp_null"
2450 and class($op) eq "UNOP"
2453 $op->first->ppaddr =~ /^pp_(and|or)$/
2454 and $op->first->first->sibling->ppaddr eq "pp_lineseq"
2456 or ( $op->first->ppaddr eq "pp_lineseq"
2457 and not null $op->first->first->sibling
2458 and $op->first->first->sibling->ppaddr eq "pp_unstack" )
2462 -A break will always be put before a list item containing a comma-arrow.
2463 This will improve formatting of mixed lists of this form:
2467 'text', 225, 20, -text => 'A Simple Plot',
2475 -text => 'A Simple Plot',
2480 -For convenience, the command -dac (--delete-all-comments) now also
2481 deletes pod. Likewise, -tac (--tee-all-comments) now also sends pod
2482 to a '.TEE' file. Complete control over the treatment of pod and
2483 comments is still possible, as described in the updated help message
2486 -The logic which breaks open 'containers' has been rewritten to be completely
2487 symmetric in the following sense: if a line break is placed after an opening
2488 {, [, or (, then a break will be placed before the corresponding closing
2489 token. Thus, a container either remains closed or is completely cracked
2492 -Improved indentation of parenthesized lists. For example,
2497 atan2( $GPSTempCompLong - $GPSLongitude,
2498 $GPSLatitude - $GPSTempCompLat ) * 180 / 3.14159265 );
2501 $GPSCompCourse = int(
2503 $GPSTempCompLong - $GPSLongitude,
2504 $GPSLatitude - $GPSTempCompLat
2505 ) * 180 / 3.14159265
2508 Further improvements will be made in future releases.
2510 -Some improvements were made in formatting small lists.
2512 -Correspondence between Input and Output line numbers reported in a
2513 .LOG file should now be exact. They were sometimes off due to the size
2514 of intermediate buffers.
2516 -Corrected minor tokenization error in which a ';' in a foreach loop
2517 control was tokenized as a statement termination, which forced a
2530 foreach ( $i = 0 ; $i <= 10 ; $i += 2 ) {
2534 -Corrected a problem with reading config files, in which quote marks were not
2535 stripped. As a result, something like -wba="&& . || " would have the leading
2536 quote attached to the && and not work correctly. A workaround for older
2537 versions is to place a space around all tokens within the quotes, like this:
2540 -Removed any existing space between a label and its ':'
2543 This was necessary because the label and its colon are a single token.
2545 -Corrected tokenization error for the following (highly non-recommended)
2547 $user = @vars[1] / 100;
2549 -Resolved cause of a difference between perltidy under perl v5.6.1 and
2550 5.005_03; the problem was different behavior of \G regex position
2555 -Corrected a bug in which a break was not being made after a full-line
2556 comment within a short eval/sort/map/grep block. A flag was not being
2557 zeroed. The syntax error check catches this. Here is a snippet which
2558 illustrates the bug:
2561 #open Socket to Dispatcher
2562 $sock = &OpenSocket;
2565 The formatter mistakenly thought that it had found the following
2568 eval {#open Socket to Dispatcher$sock = &OpenSocket; };
2570 The patch fixes this. Many thanks to Henry Story for reporting this bug.
2572 -Changes were made to help diagnose and resolve problems in a
2574 (1) processing of command parameters has been into two separate
2575 batches so that any errors in a .perltidyrc file can be localized.
2576 (2) commands --help, --version, and as many of the --dump-xxx
2577 commands are handled immediately, without any command line processing
2579 (3) Perltidy will ignore any commands in the .perltidyrc file which
2580 cause immediate exit. These are: -h -v -ddf -dln -dop -dsn -dtt
2581 -dwls -dwrs -ss. Thanks to Wolfgang Weisselberg for helpful
2582 suggestions regarding these updates.
2584 -Syntax check has been reinstated as default for MSWin32 systems. This
2585 way Windows 2000 users will get syntax check by default, which seems
2586 like a better idea, since the number of Win 95/98 systems will be
2587 decreasing over time. Documentation revised to warn Windows 95/98
2588 users about the problem with empty '&1'. Too bad these systems
2589 all report themselves as MSWin32.
2593 -Fixed tokenization error in which a method call of the form
2597 got a space before the '::' like this:
2601 Thanks to David Holden for reporting this.
2603 -Added -html control over pod text, using a new abbreviation 'pd'. See
2604 updated perl2web man page. The default is to use the color of a comment,
2605 but italicized. Old .css style sheets will need a new line for
2606 .pd to use this. The old color was the color of a string, and there
2609 -.css lines are now printed in sorted order.
2611 -Fixed interpolation problem where html files had '$input_file' as title
2612 instead of actual input file name. Thanks to Simon Perreault for finding
2613 this and sending a patch, and also to Tobias Weber.
2615 -Breaks will now have the ':' placed at the start of a line,
2616 one per line by default because this shows logical structure
2617 more clearly. This coding has been completely redone. Some
2618 examples of new ?/: formatting:
2621 wantarray ? map( $dir::cwd->lookup($_)->path, @_ ) :
2622 $dir::cwd->lookup( $_[0] )->path;
2626 ? map( $dir::cwd->lookup($_)->path, @_ )
2627 : $dir::cwd->lookup( $_[0] )->path;
2633 } : { a => 6, b => 8 };
2641 : { a => 6, b => 8 };
2644 $self->note($self->{skip} ? "Hunk #$self->{hunk} ignored at 1.\n" :
2645 "Hunk #$self->{hunk} failed--$@");
2648 $self->note($self->{skip}
2649 ? "Hunk #$self->{hunk} ignored at 1.\n"
2650 : "Hunk #$self->{hunk} failed--$@");
2654 $opts{"t"} ? 'title' :
2655 $opts{"s"} ? 'subject' : $opts{"a"} ? 'author' : 'title';
2659 $opts{"t"} ? 'title'
2660 : $opts{"s"} ? 'subject'
2661 : $opts{"a"} ? 'author'
2664 You can use -wba=':' to recover the previous default which placed ':'
2665 at the end of a line. Thanks to Michael Cartmell for helpful
2666 discussions and examples.
2668 -Tokenizer updated to do syntax checking for matched ?/: pairs. Also,
2669 the tokenizer now outputs a unique serial number for every balanced
2670 pair of brace types and ?/: pairs. This greatly simplifies the
2673 -Long lines with repeated 'and', 'or', '&&', '||' will now have
2674 one such item per line. For example:
2677 if ( $opt_d || $opt_m || $opt_p || $opt_t || $opt_x
2678 || ( -e $archive && $opt_r ) )
2680 ( $pAr, $pNames ) = readAr($archive);
2689 || ( -e $archive && $opt_r ) )
2691 ( $pAr, $pNames ) = readAr($archive);
2695 if ( $vp->{X0} + 4 <= $x && $vp->{X0} + $vp->{W} - 4 >= $x
2696 && $vp->{Y0} + 4 <= $y && $vp->{Y0} + $vp->{H} - 4 >= $y )
2699 if ( $vp->{X0} + 4 <= $x
2700 && $vp->{X0} + $vp->{W} - 4 >= $x
2701 && $vp->{Y0} + 4 <= $y
2702 && $vp->{Y0} + $vp->{H} - 4 >= $y )
2704 -Long lines with multiple concatenated tokens will have concatenated
2705 terms (see below) placed one per line, except for short items. For
2710 "Device type:" . $ib->family . " ID:" . $ib->serial . " CRC:"
2711 . $ib->crc . ": " . $ib->model() . "\n";
2714 $report .= "Device type:"
2715 . $ib->family . " ID:"
2716 . $ib->serial . " CRC:"
2718 . $ib->crc . ": " . "\n";
2720 NOTE: at present 'short' means 8 characters or less. There is a
2721 tentative flag to change this (-scl), but it is undocumented and
2722 is likely to be changed or removed later, so only use it for testing.
2723 In the above example, the tokens " ID:", " CRC:", and "\n" are below
2726 -If a line which is short enough to fit on a single line was
2727 nevertheless broken in the input file at a 'good' location (see below),
2728 perltidy will try to retain a break. For example, the following line
2729 will be formatted as:
2732 or die "Cannot open $file ($!)";
2734 if it was broken in the input file, and like this if not:
2736 open SUM, "<$file" or die "Cannot open $file ($!)";
2738 GOOD: 'good' location means before 'and','or','if','unless','&&','||'
2740 The reason perltidy does not just always break at these points is that if
2741 there are multiple, similar statements, this would preclude alignment. So
2742 rather than check for this, perltidy just tries to follow the input style,
2743 in the hopes that the author made a good choice. Here is an example where
2744 we might not want to break before each 'if':
2746 ($Locale, @Locale) = ($English, @English) if (@English > @Locale);
2747 ($Locale, @Locale) = ($German, @German) if (@German > @Locale);
2748 ($Locale, @Locale) = ($French, @French) if (@French > @Locale);
2749 ($Locale, @Locale) = ($Spanish, @Spanish) if (@Spanish > @Locale);
2751 -Added wildcard file expansion for systems with shells which lack this.
2752 Now 'perltidy *.pl' should work under MSDOS/Windows. Thanks to Hugh Myers
2753 for suggesting this. This uses builtin glob() for now; I may change that.
2755 -Added new flag -sbl which, if specified, overrides the value of -bl
2756 for opening sub braces. This allows formatting of this type:
2762 if (!defined($_[0])) {
2763 print("Hello, World\n");
2769 Requested by Don Alexander.
2771 -Fixed minor parsing error which prevented a space after a $$ variable
2772 (pid) in some cases. Thanks to Michael Cartmell for noting this.
2777 -Improved line break choices 'and' and 'or' to display logic better.
2781 exists $self->{'build_dir'} and push @e,
2782 "Unwrapped into directory $self->{'build_dir'}";
2785 exists $self->{'build_dir'}
2786 and push @e, "Unwrapped into directory $self->{'build_dir'}";
2788 -Fixed error of multiple use of abbreviatioin '-dsc'. -dsc remains
2789 abbreviation for delete-side-comments; -dsm is new abbreviation for
2792 -Corrected and updated 'usage' help routine. Thanks to Slaven Rezic for
2795 -The default for Windows is, for now, not to do a 'perl -c' syntax
2796 check (but -syn will activate it). This is because of problems with
2797 command.com. James Freeman sent me a patch which tries to get around
2798 the problems, and it works in many cases, but testing revealed several
2799 issues that still need to be resolved. So for now, the default is no
2800 syntax check for Windows.
2802 -I added a -T flag when doing perl -c syntax check.
2803 This is because I test it on a large number of scripts from sources
2804 unknown, and who knows what might be hidden in initialization blocks?
2805 Also, deactivated the syntax check if perltidy is run as root. As a
2806 benign example, running the previous version of perltidy on the
2807 following file would cause it to disappear:
2810 print "Bye, bye baby!\n";
2814 The new version will not let that happen.
2816 -I am contemplating (but have not yet implemented) making '-lp' the
2817 default indentation, because it is stable now and may be closer to how
2818 perl is commonly formatted. This could be in the next release. The
2819 reason that '-lp' was not the original default is that the coding for
2820 it was complex and not ready for the initial release of perltidy. If
2821 anyone has any strong feelings about this, I'd like to hear. The
2822 current default could always be recovered with the '-nlp' flag.
2827 - sub definition names are now specially colored, red by default.
2828 The letter 'm' is used to identify them.
2829 - keyword 'sub' now has color of other keywords.
2830 - restored html keyword color to __END__ and __DATA__, which was
2831 accidentally removed in the previous version.
2833 -A new -se (--standard-error-output) flag has been implemented and
2834 documented which causes all errors to be written to standard output
2835 instead of a .ERR file.
2837 -A new -w (--warning-output) flag has been implemented and documented
2838 which causes perltidy to output certain non-critical messages to the
2839 error output file, .ERR. These include complaints about pod usage,
2840 for example. The default is to not include these.
2842 NOTE: This replaces an undocumented -w=0 or --warning-level flag
2843 which was tentatively introduced in the previous version to avoid some
2844 unwanted messages. The new default is the same as the old -w=0, so
2845 that is no longer needed.
2847 -Improved syntax checking and corrected tokenization of functions such
2848 as rand, srand, sqrt, ... These can accept either an operator or a term
2849 to their right. This has been corrected.
2851 -Corrected tokenization of semicolon: testing of the previous update showed
2852 that the semicolon in the following statement was being mis-tokenized. That
2853 did no harm, other than adding an extra blank space, but has been corrected.
2855 for (sort {strcoll($a,$b);} keys %investments) {
2859 -New syntax check: after wasting 5 minutes trying to resolve a syntax
2860 error in which I had an extra terminal ';' in a complex for (;;) statement,
2861 I spent a few more minutes adding a check for this in perltidy so it won't
2864 -The behavior of --break-before-subs (-bbs) and --break-before-blocks
2865 (-bbb) has been modified. Also, a new control parameter,
2866 --long-block-line-count=n (-lbl=n) has been introduced to give more
2867 control on -bbb. This was previously a hardwired value. The reason
2868 for the change is to reduce the number of unwanted blank lines that
2869 perltidy introduces, and make it less erratic. It's annoying to remove
2870 an unwanted blank line and have perltidy put it back. The goal is to
2871 be able to sprinkle a few blank lines in that dense script you
2872 inherited from Bubba. I did a lot of experimenting with different
2873 schemes for introducing blank lines before and after code blocks, and
2874 decided that there is no really good way to do it. But I think the new
2875 scheme is an improvement. You can always deactivate this with -nbbb.
2876 I've been meaning to work on this; thanks to Erik Thaysen for bringing
2879 -The .LOG file is seldom needed, and I get tired of deleting them, so
2880 they will now only be automatically saved if perltidy thinks that it
2881 made an error, which is almost never. You can still force the logfile
2882 to be saved with -log or -g.
2884 -Improved method for computing number of columns in a table. The old
2885 method always tried for an even number. The new method allows odd
2886 numbers when it is obvious that a list is not a hash initialization
2890 $name, $xsargs, $parobjs, $optypes,
2891 $hasp2child, $pmcode, $hdrcode, $inplacecode,
2892 $globalnew, $callcopy
2897 $name, $xsargs, $parobjs, $optypes, $hasp2child,
2898 $pmcode, $hdrcode, $inplacecode, $globalnew, $callcopy
2902 -I fiddled with the list threshold adjustment, and some small lists
2903 look better now. Here is the change for one of the lists in test file
2907 ("in", "in", "pt", "pt", "pc", "pi", "mm", "mm", "cm", "cm", "\\hsize", "%",
2908 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%");
2912 "in", "in", "pt", "pt", "pc", "pi",
2913 "mm", "mm", "cm", "cm", "\\hsize", "%",
2914 "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%"
2917 -Improved -lp formatting at '=' sign. A break was always being added after
2918 the '=' sign in a statement such as this, (to be sure there was enough room
2919 for the parameters):
2924 $biblionumber, $constraint,
2928 The updated version doesn't do this unless the space is really needed:
2930 new: my $fee = CalcReserveFee(
2932 $biblionumber, $constraint,
2936 -I updated the tokenizer to allow $#+ and $#-, which seem to be new to
2937 Perl 5.6. Some experimenting with a recent version of Perl indicated
2938 that it allows these non-alphanumeric '$#' array maximum index
2939 varaibles: $#: $#- $#+ so I updated the parser accordingly. Only $#:
2940 seems to be valid in older versions of Perl.
2942 -Fixed a rare formatting problem with -lp (and -gnu) which caused
2943 excessive indentation.
2945 -Many additional syntax checks have been added.
2947 -Revised method for testing here-doc target strings; the following
2948 was causing trouble with a regex test because of the '*' characters:
2952 Perl seems to allow almost anything to be a here doc target, so an
2953 exact string comparison is now used.
2955 -Made update to allow underscores in binary numbers, like '0b1100_0000'.
2957 -Corrected problem with scanning certain module names; a blank space was
2958 being inserted after 'warnings' in the following:
2959 use warnings::register;
2960 The problem was that warnings (and a couple of other key modules) were
2961 being tokenized as keywords. They should have just been identifiers.
2963 -Corrected tokenization of indirect objects after sort, system, and exec,
2964 after testing produced an incorrect error message for the following
2966 print sort $sortsubref @list;
2968 -Corrected minor problem where a line after a format had unwanted
2969 extra continuation indentation.
2971 -Delete-block-comments (and -dac) now retain any leading hash-bang line
2973 -Update for -lp (and -gnu) to not align the leading '=' of a list
2974 with a previous '=', since this interferes with alignment of parameters.
2976 old: my $hireDay = new Date;
2983 new: my $hireDay = new Date;
2990 -Modifications made to display tables more compactly when possible,
2991 without adding lines. For example,
2993 '1', "I", '2', "II", '3', "III", '4', "IV",
2994 '5', "V", '6', "VI", '7', "VII", '8', "VIII",
2997 '1', "I", '2', "II", '3', "III",
2998 '4', "IV", '5', "V", '6', "VI",
2999 '7', "VII", '8', "VIII", '9', "IX"
3001 -Corrected minor bug in which -pt=2 did not keep the right paren tight
3002 around a '++' or '--' token, like this:
3004 for ($i = 0 ; $i < length $key ; $i++ )
3006 The formatting for this should be, and now is:
3008 for ($i = 0 ; $i < length $key ; $i++)
3010 Thanks to Erik Thaysen for noting this.
3012 -Discovered a new bug involving here-docs during testing! See BUGS.html.
3014 -Finally fixed parsing of subroutine attributes (A Perl 5.6 feature).
3015 However, the attributes and prototypes must still be on the same line
3020 -Corrected minor, uncommon bug found during routine testing, in which a
3021 blank got inserted between a function name and its opening paren after
3022 a file test operator, but only in the case that the function had not
3023 been previously seen. Perl uses the existence (or lack thereof) of
3024 the blank to guess if it is a function call. That is,
3025 if (-l pid_filename()) {
3027 if (-l pid_filename ()) {
3028 which is a syntax error if pid_filename has not been seen by perl.
3030 -If the AutoLoader module is used, perltidy will continue formatting
3031 code after seeing an __END__ line. Use -nlal to deactivate this feature.
3032 Likewise, if the SelfLoader module is used, perltidy will continue
3033 formatting code after seeing a __DATA__ line. Use -nlsl to
3034 deactivate this feature. Thanks to Slaven Rezic for this suggestion.
3036 -pod text after __END__ and __DATA__ is now identified by perltidy
3037 so that -dp works correctly. Thanks to Slaven Rezic for this suggestion.
3039 -The first $VERSION line which might be eval'd by MakeMaker
3040 is now passed through unchanged. Use -npvl to deactivate this feature.
3041 Thanks to Manfred Winter for this suggestion.
3043 -Improved indentation of nested parenthesized expressions. Tests have
3044 given favorable results. Thanks to Wolfgang Weisselberg for helpful
3049 -Fixed a very rare problem in which an unwanted semicolon was inserted
3050 due to misidentification of anonymous hash reference curly as a code
3051 block curly. (No instances of this have been reported; I discovered it
3052 during testing). A workaround for older versions of perltidy is to use
3055 -Added -icb (-indent-closing-brace) parameter to indent a brace which
3056 terminates a code block to the same level as the previous line.
3057 Suggested by Andrew Cutler. For example,
3066 -Rewrote error message triggered by an unknown bareword in a print or
3067 printf filehandle position, and added flag -w=0 to prevent issuing this
3068 error message. Suggested by Byron Jones.
3070 -Added modification to align a one-line 'if' block with similar
3071 following 'elsif' one-line blocks, like this:
3072 if ( $something eq "simple" ) { &handle_simple }
3073 elsif ( $something eq "hard" ) { &handle_hard }
3074 (Suggested by Wolfgang Weisselberg).
3078 -Eliminated all constants with leading underscores because perl 5.005_03
3079 does not support that. For example, _SPACES changed to XX_SPACES.
3080 Thanks to kromJx for this update.
3084 -the directory of test files has been moved to a separate distribution
3085 file because it is getting large but is of little interest to most users.
3086 For the current distribution:
3087 perltidy-20010701.tgz contains the source and docs for perltidy
3088 perltidy-20010701-test.tgz contains the test files
3090 -fixed bug where temporary file perltidy.TMPI was not being deleted
3091 when input was from stdin.
3093 -adjusted line break logic to not break after closing brace of an
3094 eval block (suggested by Boris Zentner).
3096 -added flag -gnu (--gnu-style) to give an approximation to the GNU
3097 style as sometimes applied to perl. The programming style in GNU
3098 'automake' was used as a guide in setting the parameters; these
3099 parameters will probably be adjusted over time.
3101 -an empty code block now has one space for emphasis:
3102 if ( $cmd eq "bg_untested" ) {} # old
3103 if ( $cmd eq "bg_untested" ) { } # new
3104 If this bothers anyone, we could create a parameter.
3106 -the -bt (--brace-tightness) parameter has been split into two
3107 parameters to give more control. -bt now applies only to non-BLOCK
3108 braces, while a new parameter -bbt (block-brace-tightness) applies to
3109 curly braces which contain code BLOCKS. The default value is -bbt=0.
3111 -added flag -icp (--indent-closing-paren) which leaves a statement
3112 termination of the form );, };, or ]; indented with the same
3113 indentation as the previous line. For example,
3115 @month_of_year = ( # default, or -nicp
3116 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3120 @month_of_year = ( # -icp
3121 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
3125 -Vertical alignment updated to synchronize with tokens &&, ||,
3126 and, or, if, unless. Allowable space before forcing
3127 resynchronization has been increased. (Suggested by Wolfgang
3130 -html corrected to use -nohtml-bold-xxxxxxx or -nhbx to negate bold,
3131 and likewise -nohtml-italic-xxxxxxx or -nhbi to negate italic. There
3132 was no way to negate these previously. html documentation updated and
3133 corrected. (Suggested by Wolfgang Weisselberg).
3135 -Some modifications have been made which improve the -lp formatting in
3138 -Perltidy now retains or creates a blank line after an =cut to keep
3139 podchecker happy (Suggested by Manfred H. Winter). This appears to be
3140 a glitch in podchecker, but it was annoying.
3144 -Added -bli flag to give continuation indentation to braces, like this
3148 extra_indentation();
3151 -Corrected an error with the tab (-t) option which caused the last line
3152 of a multi-line quote to receive a leading tab. This error was in
3153 version 2001 06 08 but not 2001 04 06. If you formatted a script
3154 with -t with this version, please check it by running once with the
3155 -chk flag and perltidy will scan for this possible error.
3157 -Corrected an invalid pattern (\R should have been just R), changed
3158 $^W =1 to BEGIN {$^W=1} to use warnings in compile phase, and corrected
3159 several unnecessary 'my' declarations. Many thanks to Wolfgang Weisselberg,
3160 2001-06-12, for catching these errors.
3162 -A '-bar' flag has been added to require braces to always be on the
3163 right, even for multi-line if and foreach statements. For example,
3164 the default formatting of a long if statement would be:
3166 if ($bigwasteofspace1 && $bigwasteofspace2
3167 || $bigwasteofspace3 && $bigwasteofspace4)
3172 With -bar, the formatting is:
3174 if ($bigwasteofspace1 && $bigwasteofspace2
3175 || $bigwasteofspace3 && $bigwasteofspace4) {
3178 Suggested by Eli Fidler 2001-06-11.
3180 -Uploaded perltidy to sourceforge cvs 2001-06-10.
3182 -An '-lp' flag (--line-up-parentheses) has been added which causes lists
3183 to be indented with extra indentation in the manner sometimes
3184 associated with emacs or the GNU suggestions. Thanks to Ian Stuart for
3185 this suggestion and for extensive help in testing it.
3187 -Subroutine call parameter lists are now formatted as other lists.
3188 This should improve formatting of tables being passed via subroutine
3189 calls. This will also cause full indentation ('-i=n, default n= 4) of
3190 continued parameter list lines rather than just the number of spaces
3191 given with -ci=n, default n=2.
3193 -Added support for hanging side comments. Perltidy identifies a hanging
3194 side comment as a comment immediately following a line with a side
3195 comment or another hanging side comment. This should work in most
3196 cases. It can be deactivated with --no-hanging-side-comments (-nhsc).
3197 The manual has been updated to discuss this. Suggested by Brad
3198 Eisenberg some time ago, and finally implemented.
3202 -fixed problem with parsing command parameters containing quoted
3203 strings in .perltidyrc files. (Reported by Roger Espel Llima 2001-06-07).
3205 -added two command line flags, --want-break-after and
3206 --want-break-before, which allow changing whether perltidy
3207 breaks lines before or after any operators. Please see the revised
3208 man pages for details.
3210 -added system-wide configuration file capability.
3211 If perltidy does not find a .perltidyrc command line file in
3212 the current directory, nor in the home directory, it now looks
3213 for '/usr/local/etc/perltidyrc' and then for '/etc/perltidyrc'.
3214 (Suggested by Roger Espel Llima 2001-05-31).
3216 -fixed problem in which spaces were trimmed from lines of a multi-line
3217 quote. (Reported by Roger Espel Llima 2001-05-30). This is an
3218 uncommon situation, but serious, because it could conceivably change
3219 the proper function of a script.
3221 -fixed problem in which a semicolon was incorrectly added within
3222 an anonymous hash. (Reported by A.C. Yardley, 2001-5-23).
3223 (You would know if this happened, because perl would give a syntax
3224 error for the resulting script).
3226 -fixed problem in which an incorrect error message was produced
3227 after a version number on a 'use' line, like this ( Reported
3228 by Andres Kroonmaa, 2001-5-14):
3230 use CGI 2.42 qw(fatalsToBrowser);
3232 Other than the extraneous error message, this bug was harmless.
3236 -fixed serious bug in which the last line of some multi-line quotes or
3237 patterns was given continuation indentation spaces. This may make
3238 a pattern incorrect unless it uses the /x modifier. To find
3239 instances of this error in scripts which have been formatted with
3240 earlier versions of perltidy, run with the -chk flag, which has
3241 been added for this purpose (SLH, 2001-04-05).
3243 ** So, please check previously formatted scripts by running with -chk
3246 -continuation indentation has been reprogrammed to be hierarchical,
3247 which improves deeply nested structures.
3249 -fixed problem with undefined value in list formatting (reported by Michael
3252 -Switched to graphical display of nesting in .LOG files. If an
3253 old format string was "(1 [0 {2", the new string is "{{(". This
3254 is easier to read and also shows the order of nesting.
3256 -added outdenting of cuddled paren structures, like ")->pack(".
3258 -added line break and outdenting of ')->' so that instead of
3261 -text => "perltidy",
3262 -relief => 'ridge')->pack;
3264 the current default is:
3267 -text => "perltidy",
3271 (requested by Michael Langner 2001-03-31; in the future this could
3272 be controlled by a command-line parameter).
3274 -revised list indentation logic, so that lists following an assignment
3275 operator get one full indentation level, rather than just continuation
3276 indentation. Also corrected some minor glitches in the continuation
3279 -Fixed problem with unwanted continuation indentation after a blank line
3280 (reported by Erik Thaysen 2001-03-28):
3282 -minor update to avoid stranding a single '(' on one line
3286 -corrected serious error tokenizing filehandles, in which a sub call
3287 after a print or printf, like this:
3288 print usage() and exit;
3290 print usage () and exit;
3291 Unfortunately, this converts 'usage' to a filehandle. To fix this, rerun
3292 perltidy; it will look for this situation and issue a warning.
3294 -fixed another cuddled-else formatting bug (Reported by Craig Bourne)
3296 -added several diagnostic --dump routines
3298 -added token-level whitespace controls (suggested by Hans Ecke)
3302 -added support for special variables of the form ${^WANT_BITS}
3304 -space added between scalar and left paren in 'for' and 'foreach' loops,
3305 (suggestion by Michael Cartmell):
3307 for $i( 1 .. 20 ) # old
3308 for $i ( 1 .. 20 ) # new
3310 -html now outputs cascading style sheets (thanks to suggestion from
3313 -flags -o and -st now work with -html
3315 -added missing -html documentation for comments (noted by Alex Izvorski)
3317 -support for VMS added (thanks to Michael Cartmell for code patches and
3320 -v-strings implemented (noted by Hans Ecke and Michael Cartmell; extensive
3321 testing by Michael Cartmell)
3323 -fixed problem where operand may be empty at line 3970
3324 (\b should be just b in lines 3970, 3973) (Thanks to Erik Thaysen,
3325 Keith Marshall for bug reports)
3327 -fixed -ce bug (cuddled else), where lines like '} else {' were indented
3328 (Thanks to Shawn Stepper and Rick Measham for reporting this)
3332 -fixed undefined value in line 153 (only worked with -I set)
3333 (Thanks to Mike Stok, Phantom of the Opcodes, Ian Ehrenwald, and others)
3335 -fixed undefined value in line 1069 (filehandle problem with perl versions <
3336 5.6) (Thanks to Yuri Leikind, Mike Stok, Michael Holve, Jeff Kolber)
3340 -Initial announcement at freshmeat.net; started Change Log
3341 (Unfortunately this version was DOA, but it was fixed the next day)