]> git.donarmstrong.com Git - perltidy.git/blob - CHANGES
Imported Upstream version 20140328
[perltidy.git] / CHANGES
1 Perltidy Change Log
2   2014 03 28
3       - Fixed RT #94190 and debian Bug #742004: perltidy.LOG file left behind.
4         Thanks to George Hartzell for debugging this.  The problem was
5         caused by the memoization speedup patch in version 20121207.  An
6         unwanted flag was being set which caused a LOG to be written if 
7         perltidy was called multiple times.
8
9       - New default behavior for LOG files: If the source is from an array or 
10         string (through a call to the perltidy module) then a LOG output is only
11         possible if a logfile stream is specified.  This is to prevent 
12         unexpected perltidy.LOG files. 
13
14       - Fixed debian Bug #740670, insecure temporary file usage.  File::Temp is now
15         used to get a temporary file.  Thanks to Don Anderson for a patch.
16   
17       - Any -b (--backup-and-modify-in-place) flag is silently ignored when a 
18         source stream, destination stream, or standard output is used.  
19         This is because the -b flag may have been in a .perltidyrc file and 
20         warnings break Test::NoWarnings.  Thanks to Marijn Brand.
21
22   2013 09 22
23       - Fixed RT #88020. --converge was not working with wide characters.
24
25       - Fixed RT #78156. package NAMESPACE VERSION syntax not accepted.
26
27       - First attempt to fix RT #88588.  INDEX END tag change in pod2html breaks 
28         perltidy -html. I put in a patch which should work but I don't yet have
29         a way of testing it.
30
31   2013 08 06
32       - Fixed RT #87107, spelling
33
34   2013 08 05
35       - Fixed RT #87502, incorrect of parsing of smartmatch before hash brace
36   
37       - Added feature request RT #87330, trim whitespace after POD.
38         The flag -trp (--trim-pod) will trim trailing whitespace from lines of POD
39
40   2013 07 17
41       - Fixed RT #86929, #86930, missing lhs of assignment.
42
43       - Fixed RT #84922, moved pod from Tidy.pm into Tidy.pod
44
45   2012 12 07
46      - The flag -cab=n or --comma-arrow-breakpoints=n has been generalized
47        to give better control over breaking open short containers.  The
48        possible values are now:
49
50          n=0 break at all commas after =>  
51          n=1 stable: break at all commas after => if container is open,
52              EXCEPT FOR one-line containers
53          n=2 break at all commas after =>, BUT try to form the maximum
54              maximum one-line container lengths
55          n=3 do not treat commas after => specially at all 
56          n=4 break everything: like n=0 but also break a short container with
57              a => not followed by a comma
58          n=5 stable: like n=1 but ALSO break at open one-line containers (default)
59
60        New values n=4 and n=5 have been added to allow short blocks to be
61        broken open.  The new default is n=5, stable.  It should more closely
62        follow the breaks in the input file, and previously formatted code
63        should remain unchanged.  If this causes problems use -cab=1 to recover 
64        the former behavior.  Thanks to Tony Maszeroski for the suggestion.
65
66        To illustrate the need for the new options, if perltidy is given
67        the following code, then the old default (-cab=1) was to close up 
68        the 'index' container even if it was open in the source.  The new 
69        default (-cab=5) will keep it open if it was open in the source.
70
71         our $fancypkg = {
72             'ALL' => {
73                 'index' => {
74                     'key' => 'value',
75                 },
76                 'alpine' => {
77                     'one'   => '+',
78                     'two'   => '+',
79                     'three' => '+',
80                 },
81             }
82         };
83
84      - New debug flag --memoize (-mem).  This version contains a 
85        patch supplied by Jonathan Swartz which can significantly speed up
86        repeated calls to Perl::Tidy::perltidy in a single process by caching
87        the result of parsing the formatting parameters.  A factor of up to 10
88        speedup was achieved for masontidy (https://metacpan.org/module/masontidy).
89        The memoization patch is on by default but can be deactivated for 
90        testing with -nmem (or --no-memoize).
91
92      - New flag -tso (--tight-secret-operators) causes certain perl operator
93        sequences (secret operators) to be formatted "tightly" (without spaces).  
94        The most common of these are 0 +  and + 0 which become 0+ and +0.  The
95        operators currently modified by this flag are: 
96             =( )=  0+  +0  ()x!! ~~<>  ,=>
97        Suggested by by Philippe Bruhat. See https://metacpan.org/module/perlsecret
98        This flag is off by default.
99    
100      - New flag -vmll (--variable-maximum-line-length) makes the maximum
101        line length increase with the nesting depth of a line of code.  
102        Basically, it causes the length of leading whitespace to be ignored when
103        setting line breaks, so the formatting of a block of code is independent
104        of its nesting depth.  Try this option if you have deeply nested 
105        code or data structures, perhaps in conjunction with the -wc flag
106        described next.  The default is not todo this.
107  
108      - New flag -wc=n (--whitespace-cycle=n) also addresses problems with
109        very deeply nested code and data structures.  When this parameter is
110        used and the nesting depth exceeds the value n, the leading whitespace 
111        will be reduced and start at 1 again.  The result is that deeply
112        nested blocks of code will shift back to the left. This occurs cyclically 
113        to any nesting depth.  This flag may be used either with or without -vmll.
114        The default is not to use this (-wc=0).
115
116      - Fixed RT #78764, error parsing smartmatch operator followed by anonymous
117        hash or array and then a ternary operator; two examples:
118
119         qr/3/ ~~ ['1234'] ? 1 : 0;
120         map { $_ ~~ [ '0', '1' ] ? 'x' : 'o' } @a;
121
122      - Fixed problem with specifying spaces around arrows using -wls='->'
123        and -wrs='->'.  Thanks to Alain Valleton for documenting this problem. 
124
125      - Implemented RT #53183, wishlist, lines of code with the same indentation
126        level which are contained with multiple stacked opening and closing tokens
127        (requested with flags -sot -sct) now have reduced indentation.  
128
129         # Default
130         $sender->MailMsg(
131             {
132                 to      => $addr,
133                 subject => $subject,
134                 msg     => $body
135             }
136         );
137
138         # OLD: perltidy -sot -sct 
139         $sender->MailMsg( {
140                 to      => $addr,
141                 subject => $subject,
142                 msg     => $body
143         } );
144
145         # NEW: perltidy -sot -sct 
146         $sender->MailMsg( {
147             to      => $addr,
148             subject => $subject,
149             msg     => $body
150         } );
151
152      - New flag -act=n (--all-containers-tightness=n) is an abbreviation for
153        -pt=n -sbt=n -bt=n -bbt=n, where n=0,1, or 2.  It simplifies input when all
154        containers have the same tightness. Using the same example:
155
156         # NEW: perltidy -sot -sct -act=2
157         $sender->MailMsg({
158             to      => $addr,
159             subject => $subject,
160             msg     => $body
161         });
162
163      - New flag -sac (--stack-all-containers) is an abbreviation for -sot -sct
164        This is part of wishlist item RT #53183. Using the same example again:
165
166         # NEW: perltidy -sac -act=2
167         $sender->MailMsg({
168             to      => $addr,
169             subject => $subject,
170             msg     => $body
171         });
172
173       - new flag -scbb (--stack-closing-block-brace) causes isolated closing 
174         block braces to stack as in the following example. (Wishlist item RT#73788)
175
176         DEFAULT:
177         for $w1 (@w1) {
178             for $w2 (@w2) {
179                 for $w3 (@w3) {
180                     for $w4 (@w4) {
181                         push( @lines, "$w1 $w2 $w3 $w4\n" );
182                     }
183                 }
184             }
185         }
186
187         perltidy -scbb:
188         for $w1 (@w1) {
189             for $w2 (@w2) {
190                 for $w3 (@w3) {
191                     for $w4 (@w4) {
192                         push( @lines, "$w1 $w2 $w3 $w4\n" );
193                     } } } }
194
195        There is, at present, no flag to place these closing braces at the end
196        of the previous line. It seems difficult to develop good rules for 
197        doing this for a wide variety of code and data structures.
198
199      - Parameters defining block types may use a wildcard '*' to indicate
200        all block types.  Previously it was not possible to include bare blocks.
201  
202      - A flag -sobb (--stack-opening-block-brace) has been introduced as an
203        alias for -bbvt=2 -bbvtl='*'.  So for example the following test code:
204
205        {{{{{{{ $testing }}}}}}}
206
207        cannot be formatted as above but can at least be kept vertically compact 
208        using perltidy -sobb -scbb
209
210        {   {   {   {   {   {   {   $testing
211                                } } } } } } }
212
213        Or even, perltidy -sobb -scbb -i=1 -bbt=2
214        {{{{{{{$testing
215              }}}}}}}
216
217
218      - Error message improved for conflicts due to -pbp; thanks to Djun Kim.
219   
220      - Fixed RT #80645, error parsing special array name '@$' when used as 
221        @{$} or $#{$}
222  
223      - Eliminated the -chk debug flag which was included in version 20010406 to
224        do a one-time check for a bug with multi-line quotes.  It has not been
225        needed since then.
226
227      - Numerous other minor formatting improvements.
228
229   2012 07 14
230      - Added flag -iscl (--ignore-side-comment-lengths) which causes perltidy 
231        to ignore the length of side comments when setting line breaks, 
232        RT #71848.  The default is to include the length of side comments when
233        breaking lines to stay within the length prescribed by the -l=n
234        maximum line length parameter.  For example,
235
236          Default behavior on a single line with long side comment:
237             $vmsfile =~ s/;[\d\-]*$//
238               ;    # Clip off version number; we can use a newer version as well
239    
240          perltidy -iscl leaves the line intact:
241
242             $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well
243
244      - Fixed RT #78182, side effects with STDERR.  Error handling has been
245        revised and the documentation has been updated.  STDERR can now be 
246        redirected to a string reference, and perltidy now returns an 
247        error flag instead of calling die when input errors are detected. 
248        If the error flag is set then no tidied output was produced.
249        See man Perl::Tidy for an example.
250
251      - Fixed RT #78156, erroneous warning message for package VERSION syntax.
252
253      - Added abbreviations -conv (--converge) to simplify iteration control.
254        -conv is equivalent to -it=4 and will insure that the tidied code is
255        converged to its final state with the minimum number of iterations.
256
257      - Minor formatting modifications have been made to insure convergence.
258
259      - Simplified and hopefully improved the method for guessing the starting 
260        indentation level of entabbed code.  Added flag -dt=n (--default_tabsize=n) 
261        which might be helpful if the guessing method does not work well for
262        some editors.
263
264      - Added support for stacked labels, upper case X/B in hex and binary, and
265        CORE:: namespace.
266
267      - Eliminated warning messages for using keyword names as constants.
268
269   2012 07 01
270      - Corrected problem introduced by using a chomp on scalar references, RT #77978
271
272      - Added support for Perl 5.14 package block syntax, RT #78114.
273
274      - A convergence test is made if three or more iterations are requested with
275        the -it=n parameter to avoid wasting computer time.  Several hundred Mb of
276        code gleaned from the internet were searched with the results that: 
277         - It is unusual for two iterations to be required unless a major 
278           style change is being made. 
279         - Only one case has been found where three iterations were required.  
280         - No cases requiring four iterations have been found with this version.
281        For the previous version several cases where found the results could
282        oscillate between two semi-stable states. This version corrects this.
283
284        So if it is important that the code be converged it is okay to set -it=4
285        with this version and it will probably stop after the second iteration.
286
287      - Improved ability to identify and retain good line break points in the
288        input stream, such as at commas and equals. You can always tell 
289        perltidy to ignore old breakpoints with -iob.  
290
291      - Fixed glitch in which a terminal closing hash brace followed by semicolon
292        was not outdented back to the leading line depth like other closing
293        tokens.  Thanks to Keith Neargarder for noting this.
294
295          OLD:
296             my ( $pre, $post ) = @{
297                 {
298                     "pp_anonlist" => [ "[", "]" ],
299                     "pp_anonhash" => [ "{", "}" ]
300                 }->{ $kid->ppaddr }
301               };   # terminal brace
302
303          NEW:
304             my ( $pre, $post ) = @{
305                 {
306                     "pp_anonlist" => [ "[", "]" ],
307                     "pp_anonhash" => [ "{", "}" ]
308                 }->{ $kid->ppaddr }
309             };    # terminal brace
310
311      - Removed extra indentation given to trailing 'if' and 'unless' clauses 
312        without parentheses because this occasionally produced undesirable 
313        results.  This only applies where parens are not used after the if or
314        unless.
315
316         OLD:
317             return undef
318               unless my ( $who, $actions ) =
319                   $clause =~ /^($who_re)((?:$action_re)+)$/o; 
320     
321         NEW:
322             return undef
323               unless my ( $who, $actions ) =
324               $clause =~ /^($who_re)((?:$action_re)+)$/o;
325
326   2012 06 19
327      - Updated perltidy to handle all quote modifiers defined for perl 5 version 16.
328
329      - Side comment text in perltidyrc configuration files must now begin with
330        at least one space before the #.  Thus:
331
332        OK:
333          -l=78 # Max line width is 78 cols
334        BAD: 
335          -l=78# Max line width is 78 cols
336
337        This is probably true of almost all existing perltidyrc files, 
338        but if you get an error message about bad parameters
339        involving a '#' the first time you run this version, please check the side
340        comments in your perltidyrc file, and add a space before the # if necessary.
341        You can quickly see the contents your perltidyrc file, if any, with the
342        command:
343
344          perltidy -dpro
345
346        The reason for this change is that some parameters naturally involve
347        the # symbol, and this can get interpreted as a side comment unless the
348        parameter is quoted.  For example, to define -sphb=# it used to be necessary
349        to write
350          -sbcp='#'
351        to keep the # from becoming part of a comment.  This was causing 
352        trouble for new users.  Now it can also be written without quotes: 
353          -sbcp=#
354
355      - Fixed bug in processing some .perltidyrc files containing parameters with
356        an opening brace character, '{'.  For example the following was
357        incorrectly processed:
358           --static-block-comment-prefix="^#{2,}[^\s#]"
359        Thanks to pdagosto.
360
361      - Added flag -boa (--break-at-old-attribute-breakpoints) which retains
362        any existing line breaks at attribute separation ':'. This is now the
363        default, use -nboa to deactivate.  Thanks to Daphne Phister for the patch.  
364        For example, given the following code, the line breaks at the ':'s will be
365        retained:
366        
367                         my @field
368                           : field
369                           : Default(1)
370                           : Get('Name' => 'foo') : Set('Name');
371
372        whereas the previous version would have output a single line.  If
373        the attributes are on a single line then they will remain on a single line.
374  
375      - Added new flags --blank-lines-before-subs=n (-blbs=n) and
376        --blank-lines-before-packages=n (-blbp=n) to put n blank lines before
377        subs and packages.  The old flag -bbs is now equivalent to -blbs=1 -blbp=1.
378        and -nbbs is equivalent to -blbs=0 -blbp=0. Requested by M. Schwern and
379        several others.
380
381      - Added feature -nsak='*' meaning no space between any keyword and opening 
382        paren.  This avoids listing entering a long list of keywords.  Requested
383        by M. Schwern.
384
385      - Added option to delete a backup of original file with in-place-modify (-b)
386        if there were no errors.  This can be requested with the flag -bext='/'.  
387        See documentation for details.  Requested by M. Schwern and others.
388
389      - Fixed bug where the module postfilter parameter was not applied when -b 
390        flag was used.  This was discovered during testing.
391
392      - Fixed in-place-modify (-b) to work with symbolic links to source files.
393        Thanks to Ted Johnson.
394
395      - Fixed bug where the Perl::Tidy module did not allow -b to be used 
396        in some cases.
397
398      - No extra blank line is added before a comment which follows
399        a short line ending in an opening token, for example like this:
400         OLD:
401                 if (
402
403                     # unless we follow a blank or comment line
404                     $last_line_leading_type !~ /^[#b]$/
405                     ...
406
407         NEW:
408                 if (
409                     # unless we follow a blank or comment line
410                     $last_line_leading_type !~ /^[#b]$/
411                     ...
412
413         The blank is not needed for readability in these cases because there
414         already is already space above the comment.  If a blank already 
415         exists there it will not be removed, so this change should not 
416         change code which has previously been formatted with perltidy. 
417         Thanks to R.W.Stauner.
418
419      - Likewise, no extra blank line is added above a comment consisting of a
420        single #, since nothing is gained in readability.
421
422      - Fixed error in which a blank line was removed after a #>>> directive. 
423        Thanks to Ricky Morse.
424
425      - Unnecessary semicolons after given/when/default blocks are now removed.
426
427      - Fixed bug where an unwanted blank line could be added before
428        pod text in __DATA__ or __END__ section.  Thanks to jidani.
429
430      - Changed exit flags from 1 to 0 to indicate success for -help, -version, 
431        and all -dump commands.  Also added -? as another way to dump the help.
432        Requested by Keith Neargarder.
433
434      - Fixed bug where .ERR and .LOG files were not written except for -it=2 or more
435
436      - Fixed bug where trailing blank lines at the end of a file were dropped when
437        -it>1.
438
439      - Fixed bug where a line occasionally ended with an extra space. This reduces
440        rhe number of instances where a second iteration gives a result different
441        from the first. 
442
443      - Updated documentation to note that the Tidy.pm module <stderr> parameter may
444        not be a reference to SCALAR or ARRAY; it must be a file.
445  
446      - Syntax check with perl now work when the Tidy.pm module is processing
447        references to arrays and strings.  Thanks to Charles Alderman.
448
449      - Zero-length files are no longer processed due to concerns for data loss
450        due to side effects in some scenarios.
451
452      - block labels, if any, are now included in closing side comment text
453        when the -csc flag is used.  Suggested by Aaron.  For example, 
454        the label L102 in the following block is now included in the -csc text:
455
456           L102: for my $i ( 1 .. 10 ) {
457             ...
458           } ## end L102: for my $i ( 1 .. 10 )
459
460   2010 12 17
461      - added new flag -it=n or --iterations=n
462        This flag causes perltidy to do n complete iterations.  
463        For most purposes the default of n=1 should be satisfactory.  However n=2
464        can be useful when a major style change is being made, or when code is being
465        beautified on check-in to a source code control system.  The run time will be
466        approximately proportional to n, and it should seldom be necessary to use a
467        value greater than n=2.  Thanks to Jonathan Swartz
468
469      - A configuration file pathname begins with three dots, e.g.
470        ".../.perltidyrc", indicates that the file should be searched for starting
471        in the current directory and working upwards. This makes it easier to have
472        multiple projects each with their own .perltidyrc in their root directories.
473        Thanks to Jonathan Swartz for this patch.
474
475      - Added flag --notidy which disables all formatting and causes the input to be
476        copied unchanged.  This can be useful in conjunction with hierarchical
477        F<.perltidyrc> files to prevent unwanted tidying.
478        Thanks to Jonathan Swartz for this patch.
479
480      - Added prefilters and postfilters in the call to the Tidy.pm module.
481        Prefilters and postfilters. The prefilter is a code reference that 
482        will be applied to the source before tidying, and the postfilter 
483        is a code reference to the result before outputting.  
484
485        Thanks to Jonathan Swartz for this patch.  He writes:
486        This is useful for all manner of customizations. For example, I use
487        it to convert the 'method' keyword to 'sub' so that perltidy will work for
488        Method::Signature::Simple code:
489
490        Perl::Tidy::perltidy(
491           prefilter => sub { $_ = $_[0]; s/^method (.*)/sub $1 \#__METHOD/gm; return $_ },
492           postfilter => sub { $_ = $_[0]; s/^sub (.*?)\s* \#__METHOD/method $1/gm; return $_ }
493        );
494
495      - The starting indentation level of sections of code entabbed with -et=n
496        is correctly guessed if it was also produced with the same -et=n flag.  This
497        keeps the indentation stable on repeated formatting passes within an editor.
498        Thanks to Sam Kington and Glenn.
499
500      - Functions with prototype '&' had a space between the function and opening
501        peren.  This space now only occurs if the flag --space-function-paren (-sfp)
502        is set.  Thanks to Zrajm Akfohg.
503
504      - Patch to never put spaces around a bare word in braces beginning with ^ as in:
505          my $before = ${^PREMATCH};
506        even if requested with the -bt=0 flag because any spaces cause a syntax error in perl.
507        Thanks to Fabrice Dulanoy.
508
509   2009 06 16
510      - Allow configuration file to be 'perltidy.ini' for Windows systems.
511        i.e. C:\Documents and Settings\User\perltidy.ini
512        and added documentation for setting configuation file under Windows in man
513        page.  Thanks to Stuart Clark.
514
515      - Corrected problem of unwanted semicolons in hash ref within given/when code.
516       Thanks to Nelo Onyiah.
517
518      - added new flag -cscb or --closing-side-comments-balanced
519       When using closing-side-comments, and the closing-side-comment-maximum-text
520       limit is exceeded, then the comment text must be truncated.  Previous
521       versions of perltidy terminate with three dots, and this can still be
522       achieved with -ncscb:
523    
524        perltidy -csc -ncscb
525
526        } ## end foreach my $foo (sort { $b cmp $a ...
527    
528       However this causes a problem with older editors which cannot recognize
529       comments or are not configured to doso because they cannot "bounce" around in
530       the text correctly.  The B<-cscb> flag tries to help them by 
531       appending appropriate terminal balancing structure:
532    
533        perltidy -csc -cscb
534
535        } ## end foreach my $foo (sort { $b cmp $a ... })
536    
537       Since there is much to be gained and little to be lost by doing this,
538       the default is B<-cscb>.  Use B<-ncscb> if you do not want this.
539
540       Thanks to Daniel Becker for suggesting this option.
541
542      - After an isolated closing eval block the continuation indentation will be
543        removed so that the braces line up more like other blocks.  Thanks to Yves Orton.
544
545      OLD:
546         eval {
547             #STUFF;
548             1;    # return true
549           }  
550           or do {
551             #handle error
552           };
553
554      NEW:
555         eval {
556             #STUFF;
557             1;    # return true
558         } or do {
559             #handle error
560         };
561
562      -A new flag -asbl (or --opening-anonymous-sub-brace-on-new-line) has
563       been added to put the opening brace of anonymous sub's on a new line,
564       as in the following snippet:
565
566         my $code = sub
567         {
568             my $arg = shift;
569             return $arg->(@_);
570         };
571
572       This was not possible before because the -sbl flag only applies to named
573       subs. Thanks to Benjamin Krupp.
574
575      -Fix tokenization bug with the following snippet
576        print 'hi' if { x => 1, }->{x};
577       which resulted in a semicolon being added after the comma.  The workaround
578       was to use -nasc, but this is no longer necessary.  Thanks to Brian Duggan. 
579
580      -Fixed problem in which an incorrect error message could be triggered
581      by the (unusual) combination of parameters  -lp -i=0 -l=2 -ci=0 for
582      example.  Thanks to Richard Jelinek.
583
584      -A new flag --keep-old-blank-lines=n has been added to
585      give more control over the treatment of old blank lines in
586      a script.  The manual has been revised to discuss the new
587      flag and clarify the treatment of old blank lines.  Thanks
588      to Oliver Schaefer.
589
590   2007 12 05
591      -Improved support for perl 5.10: New quote modifier 'p', new block type UNITCHECK, 
592      new keyword break, improved formatting of given/when.
593
594      -Corrected tokenization bug of something like $var{-q}.
595
596      -Numerous minor formatting improvements.
597
598      -Corrected list of operators controlled by -baao -bbao to include
599        . : ? && || and or err xor
600
601      -Corrected very minor error in log file involving incorrect comment
602      regarding need for upper case of labels.  
603
604      -Fixed problem where perltidy could run for a very long time
605      when given certain non-perl text files.
606
607      -Line breaks in un-parenthesized lists now try to follow
608      line breaks in the input file rather than trying to fill
609      lines.  This usually works better, but if this causes
610      trouble you can use -iob to ignore any old line breaks.
611      Example for the following input snippet:
612
613         print
614         "conformability (Not the same dimension)\n",
615         "\t", $have, " is ", text_unit($hu), "\n",
616         "\t", $want, " is ", text_unit($wu), "\n",
617         ;
618
619       OLD:
620         print "conformability (Not the same dimension)\n", "\t", $have, " is ",
621           text_unit($hu), "\n", "\t", $want, " is ", text_unit($wu), "\n",;
622
623       NEW:
624         print "conformability (Not the same dimension)\n",
625           "\t", $have, " is ", text_unit($hu), "\n",
626           "\t", $want, " is ", text_unit($wu), "\n",
627           ;
628
629   2007 08 01
630      -Added -fpsc option (--fixed-position-side-comment). Thanks to Ueli Hugenschmidt. 
631      For example -fpsc=40 tells perltidy to put side comments in column 40
632      if possible.  
633
634      -Added -bbao and -baao options (--break-before-all-operators and
635      --break-after-all-operators) to simplify command lines and configuration
636      files.  These define an initial preference for breaking at operators which can
637      be modified with -wba and -wbb flags.  For example to break before all operators
638      except an = one could use --bbao -wba='=' rather than listing every
639      single perl operator (except =) on a -wbb flag.
640
641      -Added -kis option (--keep-interior-semicolons).  Use the B<-kis> flag
642      to prevent breaking at a semicolon if there was no break there in the
643      input file.  To illustrate, consider the following input lines:
644
645         dbmclose(%verb_delim); undef %verb_delim;
646         dbmclose(%expanded); undef %expanded;
647         dbmclose(%global); undef %global;
648
649      Normally these would be broken into six lines, but 
650      perltidy -kis gives:
651
652         dbmclose(%verb_delim); undef %verb_delim;
653         dbmclose(%expanded);   undef %expanded;
654         dbmclose(%global);     undef %global;
655  
656      -Improved formatting of complex ternary statements, with indentation
657      of nested statements.  
658       OLD:
659         return defined( $cw->{Selected} )
660           ? (wantarray)
661           ? @{ $cw->{Selected} }
662           : $cw->{Selected}[0]
663           : undef;
664
665       NEW:
666         return defined( $cw->{Selected} )
667           ? (wantarray)
668               ? @{ $cw->{Selected} }
669               : $cw->{Selected}[0]
670           : undef;
671
672      -Text following un-parenthesized if/unless/while/until statements get a
673      full level of indentation.  Suggested by Jeff Armstorng and others. 
674      OLD:
675         return $ship->chargeWeapons("phaser-canon")
676           if $encounter->description eq 'klingon'
677           and $ship->firepower >= $encounter->firepower
678           and $location->status ne 'neutral';
679      NEW:
680         return $ship->chargeWeapons("phaser-canon")
681           if $encounter->description eq 'klingon'
682               and $ship->firepower >= $encounter->firepower
683               and $location->status ne 'neutral';
684
685   2007 05 08
686      -Fixed bug where #line directives were being indented.  Thanks to
687      Philippe Bruhat.
688
689   2007 05 04
690      -Fixed problem where an extra blank line was added after an =cut when either
691      (a) the =cut started (not stopped) a POD section, or (b) -mbl > 1. 
692      Thanks to J. Robert Ray and Bill Moseley.
693
694   2007 04 24
695      -ole (--output-line-ending) and -ple (--preserve-line-endings) should
696      now work on all systems rather than just unix systems. Thanks to Dan
697      Tyrell.
698
699      -Fixed problem of a warning issued for multiple subs for BEGIN subs
700      and other control subs. Thanks to Heiko Eissfeldt.
701  
702      -Fixed problem where no space was introduced between a keyword or
703      bareword and a colon, such as:
704
705      ( ref($result) eq 'HASH' && !%$result ) ? undef: $result;
706
707      Thanks to Niek.
708
709      -Added a utility program 'break_long_quotes.pl' to the examples directory of
710      the distribution.  It breaks long quoted strings into a chain of concatenated
711      sub strings no longer than a selected length.  Suggested by Michael Renner as
712      a perltidy feature but was judged to be best done in a separate program.
713
714      -Updated docs to remove extra < and >= from list of tokens 
715      after which breaks are made by default.  Thanks to Bob Kleemann.
716
717      -Removed improper uses of $_ to avoid conflicts with external calls, giving
718      error message similar to:
719         Modification of a read-only value attempted at 
720         /usr/share/perl5/Perl/Tidy.pm line 6907.
721      Thanks to Michael Renner.
722
723      -Fixed problem when errorfile was not a plain filename or filehandle
724      in a call to Tidy.pm.  The call
725      perltidy(source => \$input, destination => \$output, errorfile => \$err);
726      gave the following error message:
727       Not a GLOB reference at /usr/share/perl5/Perl/Tidy.pm line 3827.
728      Thanks to Michael Renner and Phillipe Bruhat.
729
730      -Fixed problem where -sot would not stack an opening token followed by
731      a side comment.  Thanks to Jens Schicke.
732
733      -improved breakpoints in complex math and other long statements. Example:
734      OLD:
735         return
736           log($n) + 0.577215664901532 + ( 1 / ( 2 * $n ) ) -
737           ( 1 / ( 12 * ( $n**2 ) ) ) + ( 1 / ( 120 * ( $n**4 ) ) );
738      NEW:
739         return
740           log($n) + 0.577215664901532 +
741           ( 1 / ( 2 * $n ) ) -
742           ( 1 / ( 12 * ( $n**2 ) ) ) +
743           ( 1 / ( 120 * ( $n**4 ) ) );
744
745      -more robust vertical alignment of complex terminal else blocks and ternary
746      statements.
747
748   2006 07 19
749      -Eliminated bug where a here-doc invoked through an 'e' modifier on a pattern
750      replacement text was not recognized.  The tokenizer now recursively scans
751      replacement text (but does not reformat it).
752
753      -improved vertical alignment of terminal else blocks and ternary statements.
754       Thanks to Chris for the suggestion. 
755
756       OLD:
757         if    ( IsBitmap() ) { return GetBitmap(); }
758         elsif ( IsFiles() )  { return GetFiles(); }
759         else { return GetText(); }
760
761       NEW:
762         if    ( IsBitmap() ) { return GetBitmap(); }
763         elsif ( IsFiles() )  { return GetFiles(); }
764         else                 { return GetText(); }
765
766       OLD:
767         $which_search =
768             $opts{"t"} ? 'title'
769           : $opts{"s"} ? 'subject'
770           : $opts{"a"} ? 'author'
771           : 'title';
772
773       NEW:
774         $which_search =
775             $opts{"t"} ? 'title'
776           : $opts{"s"} ? 'subject'
777           : $opts{"a"} ? 'author'
778           :              'title';
779
780      -improved indentation of try/catch blocks and other externally defined
781      functions accepting a block argument.  Thanks to jae.
782
783      -Added support for Perl 5.10 features say and smartmatch.
784
785      -Added flag -pbp (--perl-best-practices) as an abbreviation for parameters
786      suggested in Damian Conway's "Perl Best Practices".  -pbp is the same as:
787
788         -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
789         -wbb="% + - * / x != == >= <= =~ !~ < > | & >= < = 
790               **= += *= &= <<= &&= -= /= |= >>= ||= .= %= ^= x="
791
792       Please note that the -st here restricts input to standard input; use
793       -nst if necessary to override.
794
795      -Eliminated some needless breaks at equals signs in -lp indentation.
796
797         OLD:
798             $c =
799               Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
800                                   TOP + $y * (BOTTOM - TOP) / SIZE);
801         NEW:
802             $c = Math::Complex->make(LEFT + $x * (RIGHT - LEFT) / SIZE,
803                                      TOP + $y * (BOTTOM - TOP) / SIZE);
804
805      A break at an equals is sometimes useful for preventing complex statements 
806      from hitting the line length limit.  The decision to do this was 
807      over-eager in some cases and has been improved.  Thanks to Royce Reece.
808
809      -qw quotes contained in braces, square brackets, and parens are being
810      treated more like those containers as far as stacking of tokens.  Also
811      stack of closing tokens ending ');' will outdent to where the ');' would
812      have outdented if the closing stack is matched with a similar opening stack.
813
814       OLD: perltidy -soc -sct
815         __PACKAGE__->load_components(
816             qw(
817               PK::Auto
818               Core
819               )
820         );
821       NEW: perltidy -soc -sct
822         __PACKAGE__->load_components( qw(
823               PK::Auto
824               Core
825         ) );
826       Thanks to Aran Deltac
827
828      -Eliminated some undesirable or marginally desirable vertical alignments.
829      These include terminal colons, opening braces, and equals, and particularly
830      when just two lines would be aligned.
831
832      OLD:
833         my $accurate_timestamps = $Stamps{lnk};
834         my $has_link            = 
835             ...
836      NEW:
837         my $accurate_timestamps = $Stamps{lnk};
838         my $has_link =
839
840      -Corrected a problem with -mangle in which a space would be removed
841      between a keyword and variable beginning with ::.
842
843   2006 06 14
844      -Attribute argument lists are now correctly treated as quoted strings
845      and not formatted.  This is the most important update in this version.
846      Thanks to Borris Zentner, Greg Ferguson, Steve Kirkup.
847
848      -Updated to recognize the defined or operator, //, to be released in Perl 10.
849      Thanks to Sebastien Aperghis-Tramoni.
850
851      -A useful utility perltidyrc_dump.pl is included in the examples section.  It
852      will read any perltidyrc file and write it back out in a standard format
853      (though comments are lost).
854
855      -Added option to have perltidy read and return a hash with the contents of a
856      perltidyrc file.  This may be used by Leif Eriksen's tidyview code.  This
857      feature is used by the demonstration program 'perltidyrc_dump.pl' in the
858      examples directory.
859
860      -Improved error checking in perltidyrc files.  Unknown bare words were not
861      being caught.
862
863      -The --dump-options parameter now dumps parameters in the format required by a
864      perltidyrc file.
865
866      -V-Strings with underscores are now recognized.
867      For example: $v = v1.2_3; 
868
869      -cti=3 option added which gives one extra indentation level to closing 
870      tokens always.  This provides more predictable closing token placement
871      than cti=2.  If you are using cti=2 you might want to try cti=3.
872
873      -To identify all left-adjusted comments as static block comments, use C<-sbcp='^#'>.
874
875      -New parameters -fs, -fsb, -fse added to allow sections of code between #<<<
876      and #>>> to be passed through verbatim. This is enabled by default and turned
877      off by -nfs.  Flags -fsb and -fse allow other beginning and ending markers.
878      Thanks to Wolfgang Werner and Marion Berryman for suggesting this.  
879
880      -added flag -skp to put a space between all Perl keywords and following paren.
881      The default is to only do this for certain keywords.  Suggested by
882      H.Merijn Brand.
883
884      -added flag -sfp to put a space between a function name and following paren.
885      The default is not to do this.  Suggested by H.Merijn Brand.
886
887      -Added patch to avoid breaking GetOpt::Long::Configure set by calling program. 
888      Thanks to Philippe Bruhat.
889
890      -An error was fixed in which certain parameters in a .perltidyrc file given
891      without the equals sign were not recognized.  That is,
892      '--brace-tightness 0' gave an error but '--brace-tightness=0' worked
893      ok.  Thanks to Zac Hansen.
894
895      -An error preventing the -nwrs flag from working was corrected. Thanks to
896       Greg Ferguson.
897
898      -Corrected some alignment problems with entab option.
899
900      -A bug with the combination of -lp and -extrude was fixed (though this
901      combination doesn't really make sense).  The bug was that a line with
902      a single zero would be dropped.  Thanks to Cameron Hayne.
903
904      -Updated Windows detection code to avoid an undefined variable.
905      Thanks to Joe Yates and Russ Jones.
906
907      -Improved formatting for short trailing statements following a closing paren.
908      Thanks to Joe Matarazzo.
909
910      -The handling of the -icb (indent closing block braces) flag has been changed
911      slightly to provide more consistent and predictable formatting of complex
912      structures.  Instead of giving a closing block brace the indentation of the
913      previous line, it is now given one extra indentation level.  The two methods
914      give the same result if the previous line was a complete statement, as in this
915      example:
916
917             if ($task) {
918                 yyy();
919                 }    # -icb
920             else {
921                 zzz();
922                 }
923      The change also fixes a problem with empty blocks such as:
924
925         OLD, -icb:
926         elsif ($debug) {
927         }
928
929         NEW, -icb:
930         elsif ($debug) {
931             }
932
933      -A problem with -icb was fixed in which a closing brace was misplaced when
934      it followed a quote which spanned multiple lines.
935
936      -Some improved breakpoints for -wba='&& || and or'
937
938      -Fixed problem with misaligned cuddled else in complex statements
939      when the -bar flag was also used.  Thanks to Alex and Royce Reese.
940
941      -Corrected documentation to show that --outdent-long-comments is the default.
942      Thanks to Mario Lia.
943
944      -New flag -otr (opening-token-right) is similar to -bar (braces-always-right)
945      but applies to non-structural opening tokens.
946
947      -new flags -sot (stack-opening-token), -sct (stack-closing-token).
948      Suggested by Tony.
949
950   2003 10 21
951      -The default has been changed to not do syntax checking with perl.  
952        Use -syn if you want it.  Perltidy is very robust now, and the -syn
953        flag now causes more problems than it's worth because of BEGIN blocks
954        (which get executed with perl -c).  For example, perltidy will never
955        return when trying to beautify this code if -syn is used:
956
957             BEGIN { 1 while { }; }
958
959       Although this is an obvious error, perltidy is often run on untested
960       code which is more likely to have this sort of problem.  A more subtle
961       example is:
962
963             BEGIN { use FindBin; }
964
965       which may hang on some systems using -syn if a shared file system is
966       unavailable.
967
968      -Changed style -gnu to use -cti=1 instead of -cti=2 (see next item).
969       In most cases it looks better.  To recover the previous format, use
970       '-gnu -cti=2'
971
972      -Added flags -cti=n for finer control of closing token indentation.
973        -cti = 0 no extra indentation (default; same as -nicp)
974        -cti = 1 enough indentation so that the closing token
975             aligns with its opening token.
976        -cti = 2 one extra indentation level if the line has the form 
977               );   ];   or   };     (same as -icp).
978
979        The new option -cti=1 works well with -lp:
980
981        EXAMPLES:
982
983         # perltidy -lp -cti=1
984         @month_of_year = (
985                            'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
986                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
987                          );
988
989         # perltidy -lp -cti=2
990         @month_of_year = (
991                            'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
992                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
993                            );
994       This is backwards compatible with -icp. See revised manual for
995       details.  Suggested by Mike Pennington.
996   
997      -Added flag '--preserve-line-endings' or '-ple' to cause the output
998       line ending to be the same as in the input file, for unix, dos, 
999       or mac line endings.  Only works under unix. Suggested by 
1000       Rainer Hochschild.
1001
1002      -Added flag '--output-line-ending=s' or '-ole=s' where s=dos or win,
1003       unix, or mac.  Only works under unix.
1004
1005      -Files with Mac line endings should now be handled properly under unix
1006       and dos without being passed through a converter.
1007
1008      -You may now include 'and', 'or', and 'xor' in the list following
1009       '--want-break-after' to get line breaks after those keywords rather than
1010       before them.  Suggested by Rainer Hochschild.
1011
1012      -Corrected problem with command line option for -vtc=n and -vt=n. The
1013       equals sign was being eaten up by the Windows shell so perltidy didn't
1014       see it.
1015
1016   2003 07 26
1017      -Corrected cause of warning message with recent versions of Perl:
1018         "Possible precedence problem on bitwise & operator at ..."
1019       Thanks to Jim Files.
1020
1021      -fixed bug with -html with '=for pod2html' sections, in which code/pod
1022      output order was incorrect.  Thanks to Tassilo von Parseval.
1023
1024      -fixed bug when the -html flag is used, in which the following error
1025      message, plus others, appear:
1026          did not see <body> in pod2html output
1027      This was caused by a change in the format of html output by pod2html
1028      VERSION 1.04 (included with perl 5.8).  Thanks to Tassilo von Parseval.
1029
1030      -Fixed bug where an __END__ statement would be mistaken for a label
1031      if it is immediately followed by a line with a leading colon. Thanks
1032      to John Bayes.
1033  
1034      -Implemented guessing logic for brace types when it is ambiguous.  This
1035      has been on the TODO list a long time.  Thanks to Boris Zentner for
1036      an example.
1037
1038      -Long options may now be negated either as '--nolong-option' 
1039      or '--no-long-option'.  Thanks to Philip Newton for the suggestion.
1040
1041      -added flag --html-entities or -hent which controls the use of
1042      Html::Entities for html formatting.  Use --nohtml-entities or -nhent to
1043      prevent the use of Html::Entities to encode special symbols.  The
1044      default is -hent.  Html::Entities when formatting perl text to escape
1045      special symbols.  This may or may not be the right thing to do,
1046      depending on browser/language combinations.  Thanks to Burak Gursoy for
1047      this suggestion.
1048
1049      -Bareword strings with leading '-', like, '-foo' now count as 1 token
1050      for horizontal tightness.  This way $a{'-foo'}, $a{foo}, and $a{-foo}
1051      are now all treated similarly.  Thus, by default, OLD: $a{ -foo } will
1052      now be NEW: $a{-foo}.  Suggested by Mark Olesen.
1053
1054      -added 2 new flags to control spaces between keywords and opening parens:
1055        -sak=s  or --space-after-keyword=s,  and
1056        -nsak=s or --nospace-after-keyword=s, where 's' is a list of keywords.
1057
1058      The new default list of keywords which get a space is:
1059
1060        "my local our and or eq ne if else elsif until unless while for foreach
1061          return switch case given when"
1062
1063      Use -sak=s and -nsak=s to add and remove keywords from this list,
1064         respectively.
1065
1066      Explanation: Stephen Hildrey noted that perltidy was being inconsistent
1067      in placing spaces between keywords and opening parens, and sent a patch
1068      to give user control over this.  The above list was selected as being
1069      a reasonable default keyword list.  Previously, perltidy
1070      had a hardwired list which also included these keywords:
1071
1072             push pop shift unshift join split die
1073
1074      but did not have 'our'.  Example: if you prefer to make perltidy behave
1075      exactly as before, you can include the following two lines in your
1076      .perltidyrc file: 
1077
1078        -sak="push pop local shift unshift join split die"
1079        -nsak="our"
1080
1081      -Corrected html error in .toc file when -frm -html is used (extra ");
1082       browsers were tolerant of it.
1083
1084      -Improved alignment of chains of binary and ?/: operators. Example:
1085       OLD:
1086         $leapyear =
1087           $year % 4     ? 0
1088           : $year % 100 ? 1
1089           : $year % 400 ? 0
1090           : 1;
1091       NEW:
1092         $leapyear =
1093             $year % 4   ? 0
1094           : $year % 100 ? 1
1095           : $year % 400 ? 0
1096           : 1;
1097
1098      -improved breakpoint choices involving '->'
1099
1100      -Corrected tokenization of things like ${#} or ${©}. For example,
1101       ${©} is valid, but ${© } is a syntax error.
1102
1103      -Corrected minor tokenization errors with indirect object notation.
1104       For example, 'new A::()' works now.
1105
1106      -Minor tokenization improvements; all perl code distributed with perl 5.8 
1107       seems to be parsed correctly except for one instance (lextest.t) 
1108       of the known bug.
1109
1110   2002 11 30
1111      -Implemented scalar attributes.  Thanks to Sean Tobin for noting this.
1112
1113      -Fixed glitch introduced in previous release where -pre option
1114      was not outputting a leading html <pre> tag.
1115
1116      -Numerous minor improvements in vertical alignment, including the following:
1117
1118      -Improved alignment of opening braces in many cases.  Needed for improved
1119      switch/case formatting, and also suggested by Mark Olesen for sort/map/grep
1120      formatting.  For example:
1121
1122       OLD:
1123         @modified =
1124           map { $_->[0] }
1125           sort { $a->[1] <=> $b->[1] }
1126           map { [ $_, -M ] } @filenames;
1127
1128       NEW:
1129         @modified =
1130           map  { $_->[0] }
1131           sort { $a->[1] <=> $b->[1] }
1132           map  { [ $_, -M ] } @filenames;
1133
1134      -Eliminated alignments across unrelated statements. Example:
1135       OLD:
1136         $borrowerinfo->configure( -state => 'disabled' );
1137         $borrowerinfo->grid( -col        => 1, -row => 0, -sticky => 'w' );
1138
1139       NEW:  
1140         $borrowerinfo->configure( -state => 'disabled' );
1141         $borrowerinfo->grid( -col => 1, -row => 0, -sticky => 'w' );
1142
1143       Thanks to Mark Olesen for suggesting this.
1144
1145      -Improved alignement of '='s in certain cases.
1146       Thanks to Norbert Gruener for sending an example.
1147
1148      -Outdent-long-comments (-olc) has been re-instated as a default, since
1149       it works much better now.  Use -nolc if you want to prevent it.
1150
1151      -Added check for 'perltidy file.pl -o file.pl', which causes file.pl
1152      to be lost. (The -b option should be used instead). Thanks to mreister
1153      for reporting this problem.
1154
1155   2002 11 06
1156      -Switch/case or given/when syntax is now recognized.  Its vertical alignment
1157      is not great yet, but it parses ok.  The words 'switch', 'case', 'given',
1158      and 'when' are now treated as keywords.  If this causes trouble with older
1159      code, we could introduce a switch to deactivate it.  Thanks to Stan Brown
1160      and Jochen Schneider for recommending this.
1161
1162      -Corrected error parsing sub attributes with call parameters.
1163      Thanks to Marc Kerr for catching this.
1164
1165      -Sub prototypes no longer need to be on the same line as sub names.  
1166
1167      -a new flag -frm or --frames will cause html output to be in a
1168      frame, with table of contents in the left panel and formatted source
1169      in the right panel.  Try 'perltidy -html -frm somemodule.pm' for example.
1170
1171      -The new default for -html formatting is to pass the pod through Pod::Html.
1172      The result is syntax colored code within your pod documents. This can be
1173      deactivated with -npod.  Thanks to those who have written to discuss this,
1174      particularly Mark Olesen and Hugh Myers.
1175
1176      -the -olc (--outdent-long-comments) option works much better.  It now outdents
1177      groups of consecutive comments together, and by just the amount needed to
1178      avoid having any one line exceeding the maximum line length.
1179
1180      -block comments are now trimmed of trailing whitespace.
1181
1182      -if a directory specified with -opath does not exist, it will be created.
1183
1184      -a table of contents to packages and subs is output when -html is used.
1185      Use -ntoc to prevent this. 
1186
1187      -fixed an unusual bug in which a 'for' statement following a 'format'
1188      statement was not correctly tokenized.  Thanks to Boris Zentner for
1189      catching this.
1190
1191      -Tidy.pm is no longer dependent on modules IO::Scalar and IO::ScalarArray.  
1192      There were some speed issues.  Suggested by Joerg Walter.
1193
1194      -The treatment of quoted wildcards (file globs) is now system-independent. 
1195      For example
1196
1197         perltidy 'b*x.p[lm]'
1198
1199      would match box.pl, box.pm, brinx.pm under any operating system.  Of
1200      course, anything unquoted will be subject to expansion by any shell.
1201
1202      -default color for keywords under -html changed from 
1203      SaddleBrown (#8B4513) to magenta4 (#8B008B).
1204
1205      -fixed an arg parsing glitch in which something like:
1206        perltidy quick-help
1207      would trigger the help message and exit, rather than operate on the
1208      file 'quick-help'.
1209
1210   2002 09 22
1211      -New option '-b' or '--backup-and-modify-in-place' will cause perltidy to
1212      overwrite the original file with the tidied output file.  The original
1213      file will be saved with a '.bak' extension (which can be changed with
1214      -bext=s).  Thanks to Rudi Farkas for the suggestion.
1215
1216      -An index to all subs is included at the top of -html output, unless
1217      only the <pre> section is written.
1218
1219      -Anchor lines of the form <a name="mysub"></a> are now inserted at key points
1220      in html output, such as before sub definitions, for the convenience of
1221      postprocessing scripts.  Suggested by Howard Owen.
1222
1223      -The cuddled-else (-ce) flag now also makes cuddled continues, like
1224      this:
1225
1226         while ( ( $pack, $file, $line ) = caller( $i++ ) ) {
1227            # bla bla
1228         } continue {
1229             $prevpack = $pack;
1230         }
1231
1232      Suggested by Simon Perreault.  
1233
1234      -Fixed bug in which an extra blank line was added before an =head or 
1235      similar pod line after an __END__ or __DATA__ line each time 
1236      perltidy was run.  Also, an extra blank was being added after
1237      a terminal =cut.  Thanks to Mike Birdsall for reporting this.
1238
1239   2002 08 26
1240      -Fixed bug in which space was inserted in a hyphenated hash key:
1241         my $val = $myhash{USER-NAME};
1242       was converted to:
1243         my $val = $myhash{USER -NAME}; 
1244       Thanks to an anonymous bug reporter at sourceforge.
1245
1246      -Fixed problem with the '-io' ('--indent-only') where all lines 
1247       were double spaced.  Thanks to Nick Andrew for reporting this bug.
1248
1249      -Fixed tokenization error in which something like '-e1' was 
1250       parsed as a number. 
1251
1252      -Corrected a rare problem involving older perl versions, in which 
1253       a line break before a bareword caused problems with 'use strict'.
1254       Thanks to Wolfgang Weisselberg for noting this.
1255
1256      -More syntax error checking added.
1257
1258      -Outdenting labels (-ola) has been made the default, in order to follow the
1259       perlstyle guidelines better.  It's probably a good idea in general, but
1260       if you do not want this, use -nola in your .perltidyrc file.
1261   
1262      -Updated rules for padding logical expressions to include more cases.
1263       Thanks to Wolfgang Weisselberg for helpful discussions.
1264
1265      -Added new flag -osbc (--outdent-static-block-comments) which will
1266       outdent static block comments by 2 spaces (or whatever -ci equals).
1267       Requested by Jon Robison.
1268
1269   2002 04 25
1270      -Corrected a bug, introduced in the previous release, in which some
1271       closing side comments (-csc) could have incorrect text.  This is
1272       annoying but will be correct the next time perltidy is run with -csc.
1273
1274      -Implemented XHTML patch submitted by Ville Skyttä.
1275
1276      -Fixed bug where whitespace was being removed between 'Bar' and '()' 
1277       in a use statement like:
1278
1279            use Foo::Bar ();
1280
1281       Thanks to Ville Skyttä for reporting this.
1282
1283      -Whenever possible, if a logical expression is broken with leading
1284       '&&', '||', 'and', or 'or', then the leading line will be padded
1285       with additional space to produce alignment.  This has been on the
1286       todo list for a long time; thanks to Frank Steinhauer for reminding
1287       me to do it.  Notice the first line after the open parens here:
1288
1289             OLD: perltidy -lp
1290             if (
1291                  !param("rules.to.$linecount")
1292                  && !param("rules.from.$linecount")
1293                  && !param("rules.subject.$linecount")
1294                  && !(
1295                        param("rules.fieldname.$linecount")
1296                        && param("rules.fieldval.$linecount")
1297                  )
1298                  && !param("rules.size.$linecount")
1299                  && !param("rules.custom.$linecount")
1300               )
1301
1302             NEW: perltidy -lp
1303             if (
1304                     !param("rules.to.$linecount")
1305                  && !param("rules.from.$linecount")
1306                  && !param("rules.subject.$linecount")
1307                  && !(
1308                           param("rules.fieldname.$linecount")
1309                        && param("rules.fieldval.$linecount")
1310                  )
1311                  && !param("rules.size.$linecount")
1312                  && !param("rules.custom.$linecount")
1313               )
1314
1315   2002 04 16
1316      -Corrected a mistokenization of variables for a package with a name
1317       equal to a perl keyword.  For example: 
1318
1319          my::qx();
1320          package my;
1321          sub qx{print "Hello from my::qx\n";}
1322
1323       In this case, the leading 'my' was mistokenized as a keyword, and a
1324       space was being place between 'my' and '::'.  This has been
1325       corrected.  Thanks to Martin Sluka for discovering this. 
1326
1327      -A new flag -bol (--break-at-old-logic-breakpoints)
1328       has been added to control whether containers with logical expressions
1329       should be broken open.  This is the default.
1330
1331      -A new flag -bok (--break-at-old-keyword-breakpoints)
1332       has been added to follow breaks at old keywords which return lists,
1333       such as sort and map.  This is the default.
1334
1335      -A new flag -bot (--break-at-old-trinary-breakpoints) has been added to
1336       follow breaks at trinary (conditional) operators.  This is the default.
1337
1338      -A new flag -cab=n has been added to control breaks at commas after
1339       '=>' tokens.  The default is n=1, meaning break unless this breaks
1340       open an existing on-line container.
1341
1342      -A new flag -boc has been added to allow existing list formatting
1343       to be retained.  (--break-at-old-comma-breakpoints).  See updated manual.
1344
1345      -A new flag -iob (--ignore-old-breakpoints) has been added to
1346       prevent the locations of old breakpoints from influencing the output
1347       format.
1348
1349      -Corrected problem where nested parentheses were not getting full
1350       indentation.  This has been on the todo list for some time; thanks 
1351       to Axel Rose for a snippet demonstrating this issue.
1352
1353                 OLD: inner list is not indented
1354                 $this->sendnumeric(
1355                     $this->server,
1356                     (
1357                       $ret->name,        $user->username, $user->host,
1358                     $user->server->name, $user->nick,     "H"
1359                     ),
1360                 );
1361
1362                 NEW:
1363                 $this->sendnumeric(
1364                     $this->server,
1365                     (
1366                         $ret->name,          $user->username, $user->host,
1367                         $user->server->name, $user->nick,     "H"
1368                     ),
1369                 );
1370
1371      -Code cleaned up by removing the following unused, undocumented flags.
1372       They should not be in any .perltidyrc files because they were just
1373       experimental flags which were never documented.  Most of them placed
1374       artificial limits on spaces, and Wolfgang Weisselberg convinced me that
1375       most of them they do more harm than good by causing unexpected results.
1376
1377       --maximum-continuation-indentation (-mci)
1378       --maximum-whitespace-columns
1379       --maximum-space-to-comment (-xsc)
1380       --big-space-jump (-bsj)
1381
1382      -Pod file 'perltidy.pod' has been appended to the script 'perltidy', and
1383       Tidy.pod has been append to the module 'Tidy.pm'.  Older MakeMaker's
1384       were having trouble.
1385  
1386      -A new flag -isbc has been added for more control on comments. This flag
1387       has the effect that if there is no leading space on the line, then the
1388       comment will not be indented, and otherwise it may be.  If both -ibc and
1389       -isbc are set, then -isbc takes priority.  Thanks to Frank Steinhauer
1390       for suggesting this.
1391
1392      -A new document 'stylekey.pod' has been created to quickly guide new users
1393       through the maze of perltidy style parameters.  An html version is 
1394       on the perltidy web page.  Take a look! It should be very helpful.
1395
1396      -Parameters for controlling 'vertical tightness' have been added:
1397       -vt and -vtc are the main controls, but finer control is provided
1398       with -pvt, -pcvt, -bvt, -bcvt, -sbvt, -sbcvt.  Block brace vertical
1399       tightness controls have also been added.
1400       See updated manual and also see 'stylekey.pod'. Simple examples:
1401
1402         # perltidy -lp -vt=1 -vtc=1
1403         @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1404                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec' );
1405
1406         # perltidy -lp -vt=1 -vtc=0
1407         @month_of_year = ( 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
1408                            'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'
1409         );
1410
1411      -Lists which do not format well in uniform columns are now better
1412       identified and formated.
1413
1414         OLD:
1415         return $c->create( 'polygon', $x, $y, $x + $ruler_info{'size'},
1416             $y + $ruler_info{'size'}, $x - $ruler_info{'size'},
1417             $y + $ruler_info{'size'} );
1418
1419         NEW:
1420         return $c->create(
1421             'polygon', $x, $y,
1422             $x + $ruler_info{'size'},
1423             $y + $ruler_info{'size'},
1424             $x - $ruler_info{'size'},
1425             $y + $ruler_info{'size'}
1426         );
1427
1428         OLD:
1429           radlablist($f1, pad('Initial', $p), $b->{Init}->get_panel_ref, 'None ',
1430                      'None', 'Default', 'Default', 'Simple', 'Simple');
1431         NEW:
1432           radlablist($f1,
1433                      pad('Initial', $p),
1434                      $b->{Init}->get_panel_ref,
1435                      'None ', 'None', 'Default', 'Default', 'Simple', 'Simple');
1436
1437      -Corrected problem where an incorrect html filename was generated for 
1438       external calls to Tidy.pm module.  Fixed incorrect html title when
1439       Tidy.pm is called with IO::Scalar or IO::Array source.
1440
1441      -Output file permissons are now set as follows.  An output script file
1442       gets the same permission as the input file, except that owner
1443       read/write permission is added (otherwise, perltidy could not be
1444       rerun).  Html output files use system defaults.  Previously chmod 0755
1445       was used in all cases.  Thanks to Mark Olesen for bringing this up.
1446
1447      -Missing semicolons will not be added in multi-line blocks of type
1448       sort, map, or grep.  This brings perltidy into closer agreement
1449       with common practice.  Of course, you can still put semicolons 
1450       there if you like.  Thanks to Simon Perreault for a discussion of this.
1451
1452      -Most instances of extra semicolons are now deleted.  This is
1453       particularly important if the -csc option is used.  Thanks to Wolfgang
1454       Weisselberg for noting this.  For example, the following line
1455       (produced by 'h2xs' :) has an extra semicolon which will now be
1456       removed:
1457
1458          BEGIN { plan tests => 1 };
1459
1460      -New parameter -csce (--closing-side-comment-else-flag) can be used
1461       to control what text is appended to 'else' and 'elsif' blocks.
1462       Default is to just add leading 'if' text to an 'else'.  See manual.
1463
1464      -The -csc option now labels 'else' blocks with additinal information
1465       from the opening if statement and elsif statements, if space.
1466       Thanks to Wolfgang Weisselberg for suggesting this.
1467
1468      -The -csc option will now remove any old closing side comments
1469       below the line interval threshold. Thanks to Wolfgang Weisselberg for
1470       suggesting this.
1471
1472      -The abbreviation feature, which was broken in the previous version,
1473       is now fixed.  Thanks to Michael Cartmell for noting this.
1474
1475      -Vertical alignment is now done for '||='  .. somehow this was 
1476       overlooked.
1477
1478   2002 02 25
1479      -This version uses modules for the first time, and a standard perl
1480       Makefile.PL has been supplied.  However, perltidy may still be
1481       installed as a single script, without modules.  See INSTALL for
1482       details.
1483
1484      -The man page 'perl2web' has been merged back into the main 'perltidy'
1485       man page to simplify installation.  So you may remove that man page
1486       if you have an older installation.
1487
1488      -Added patch from Axel Rose for MacPerl.  The patch prompts the user
1489       for command line arguments before calling the module 
1490       Perl::Tidy::perltidy.
1491
1492      -Corrected bug with '-bar' which was introduced in the previous
1493       version.  A closing block brace was being indented.  Thanks to
1494       Alexandros M Manoussakis for reporting this.
1495
1496      -New parameter '--entab-leading-whitespace=n', or '-et=n', has been
1497       added for those who prefer tabs.  This behaves different from the
1498       existing '-t' parameter; see updated man page.  Suggested by Mark
1499       Olesen.
1500
1501      -New parameter '--perl-syntax-check-flags=s'  or '-pcsf=s' can be
1502       used to change the flags passed to perltidy in a syntax check.
1503       See updated man page.  Suggested by Mark Olesen. 
1504
1505      -New parameter '--output-path=s'  or '-opath=s' will cause output
1506       files to be placed in directory s.  See updated man page.  Thanks for
1507       Mark Olesen for suggesting this.
1508
1509      -New parameter --dump-profile (or -dpro) will dump to
1510       standard output information about the search for a
1511       configuration file, the name of whatever configuration file
1512       is selected, and its contents.  This should help debugging
1513       config files, especially on different Windows systems.
1514
1515      -The -w parameter now notes possible errors of the form:
1516
1517             $comment = s/^\s*(\S+)\..*/$1/;   # trim whitespace
1518
1519      -Corrections added for a leading ':' and for leaving a leading 'tcsh'
1520       line untouched.  Mark Olesen reported that lines of this form were
1521       accepted by perl but not by perltidy:
1522
1523             : # use -*- perl -*-
1524             eval 'exec perl -wS $0 "$@"'  # shell should exec 'perl'
1525             unless 1;                     # but Perl should skip this one
1526
1527       Perl will silently swallow a leading colon on line 1 of a
1528       script, and now perltidy will do likewise.  For example,
1529       this is a valid script, provided that it is the first line,
1530       but not otherwise:
1531
1532             : print "Hello World\n";
1533   
1534       Also, perltidy will now mark a first line with leading ':' followed by
1535       '#' as type SYSTEM (just as a #!  line), not to be formatted.
1536
1537      -List formatting improved for certain lists with special
1538       initial terms, such as occur with 'printf', 'sprintf',
1539       'push', 'pack', 'join', 'chmod'.  The special initial term is
1540       now placed on a line by itself.  For example, perltidy -gnu
1541
1542          OLD:
1543             $Addr = pack(
1544                          "C4",                hex($SourceAddr[0]),
1545                          hex($SourceAddr[1]), hex($SourceAddr[2]),
1546                          hex($SourceAddr[3])
1547                          );
1548
1549          NEW:
1550             $Addr = pack("C4",
1551                          hex($SourceAddr[0]), hex($SourceAddr[1]),
1552                          hex($SourceAddr[2]), hex($SourceAddr[3]));
1553
1554           OLD:
1555                 push (
1556                       @{$$self{states}}, '64', '66', '68',
1557                       '70',              '72', '74', '76',
1558                       '78',              '80', '82', '84',
1559                       '86',              '88', '90', '92',
1560                       '94',              '96', '98', '100',
1561                       '102',             '104'
1562                       );
1563
1564           NEW:
1565                 push (
1566                       @{$$self{states}},
1567                       '64', '66', '68', '70', '72',  '74',  '76',
1568                       '78', '80', '82', '84', '86',  '88',  '90',
1569                       '92', '94', '96', '98', '100', '102', '104'
1570                       );
1571
1572      -Lists of complex items, such as matricies, are now detected
1573       and displayed with just one item per row:
1574
1575         OLD:
1576         $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
1577             [ 1, tan( deg2rad($a) ), 0 ], [ tan( deg2rad($b) ), 1, 0 ],
1578             [ 0, 0, 1 ]
1579         );
1580
1581         NEW:
1582         $this->{'CURRENT'}{'gfx'}{'MatrixSkew'} = Text::PDF::API::Matrix->new(
1583             [ 1,                  tan( deg2rad($a) ), 0 ],
1584             [ tan( deg2rad($b) ), 1,                  0 ],
1585             [ 0,                  0,                  1 ]
1586         );
1587
1588      -The perl syntax check will be turned off for now when input is from
1589       standard input or standard output.  The reason is that this requires
1590       temporary files, which has produced far too many problems during
1591       Windows testing.  For example, the POSIX module under Windows XP/2000
1592       creates temporary names in the root directory, to which only the
1593       administrator should have permission to write.
1594
1595      -Merged patch sent by Yves Orton to handle appropriate
1596       configuration file locations for different Windows varieties
1597       (2000, NT, Me, XP, 95, 98).
1598
1599      -Added patch to properly handle a for/foreach loop without
1600       parens around a list represented as a qw.  I didn't know this
1601       was possible until Wolfgang Weisselberg pointed it out:
1602
1603             foreach my $key qw\Uno Due Tres Quadro\ {
1604                 print "Set $key\n";
1605             }
1606
1607       But Perl will give a syntax error without the $ variable; ie this will
1608       not work:
1609
1610             foreach qw\Uno Due Tres Quadro\ {
1611                 print "Set $_\n";
1612             }
1613
1614      -Merged Windows version detection code sent by Yves Orton.  Perltidy
1615       now automatically turns off syntax checking for Win 9x/ME versions,
1616       and this has solved a lot of robustness problems.  These systems 
1617       cannot reliably handle backtick operators.  See man page for
1618       details.
1619   
1620      -Merged VMS filename handling patch sent by Michael Cartmell.  (Invalid
1621       output filenames were being created in some cases). 
1622
1623      -Numerous minor improvements have been made for -lp style indentation.
1624
1625      -Long C-style 'for' expressions will be broken after each ';'.   
1626
1627       'perltidy -gnu' gives:
1628
1629         OLD:
1630         for ($status = $db->seq($key, $value, R_CURSOR()) ; $status == 0
1631              and $key eq $origkey ; $status = $db->seq($key, $value, R_NEXT())) 
1632
1633         NEW:
1634         for ($status = $db->seq($key, $value, R_CURSOR()) ;
1635              $status == 0 and $key eq $origkey ;
1636              $status = $db->seq($key, $value, R_NEXT()))
1637
1638      -For the -lp option, a single long term within parens
1639       (without commas) now has better alignment.  For example,
1640       perltidy -gnu
1641
1642                 OLD:
1643                 $self->throw("Must specify a known host, not $location,"
1644                       . " possible values ("
1645                       . join (",", sort keys %hosts) . ")");
1646
1647                 NEW:
1648                 $self->throw("Must specify a known host, not $location,"
1649                              . " possible values ("
1650                              . join (",", sort keys %hosts) . ")");
1651
1652   2001 12 31
1653      -This version is about 20 percent faster than the previous
1654       version as a result of optimization work.  The largest gain
1655       came from switching to a dispatch hash table in the
1656       tokenizer.
1657
1658      -perltidy -html will check to see if HTML::Entities is
1659       installed, and if so, it will use it to encode unsafe
1660       characters.
1661
1662      -Added flag -oext=ext to change the output file extension to
1663       be different from the default ('tdy' or 'html').  For
1664       example:
1665
1666         perltidy -html -oext=htm filename
1667
1668      will produce filename.htm
1669
1670      -Added flag -cscw to issue warnings if a closing side comment would replace
1671      an existing, different side comments.  See the man page for details.
1672      Thanks to Peter Masiar for helpful discussions.
1673
1674      -Corrected tokenization error of signed hex/octal/binary numbers. For
1675      example, the first hex number below would have been parsed correctly
1676      but the second one was not:
1677         if ( ( $tmp >= 0x80_00_00 ) || ( $tmp < -0x80_00_00 ) ) { }
1678
1679      -'**=' was incorrectly tokenized as '**' and '='.  This only
1680          caused a problem with the -extrude opton.
1681
1682      -Corrected a divide by zero when -extrude option is used
1683
1684      -The flag -w will now contain all errors reported by 'perl -c' on the
1685      input file, but otherwise they are not reported.  The reason is that
1686      perl will report lots of problems and syntax errors which are not of
1687      interest when only a small snippet is being formatted (such as missing
1688      modules and unknown bare words).  Perltidy will always report all
1689      significant syntax errors that it finds, such as unbalanced braces,
1690      unless the -q (quiet) flag is set.
1691
1692      -Merged modifications created by Hugh Myers into perltidy.
1693       These include a 'streamhandle' routine which allows perltidy
1694       as a module to operate on input and output arrays and strings
1695       in addition to files.  Documentation and new packaging as a
1696       module should be ready early next year; This is an elegant,
1697       powerful update; many thanks to Hugh for contributing it.
1698
1699   2001 11 28
1700      -added a tentative patch which tries to keep any existing breakpoints
1701      at lines with leading keywords map,sort,eval,grep. The idea is to
1702      improve formatting of sequences of list operations, as in a schwartzian
1703      transform.  Example:
1704
1705         INPUT:
1706         my @sorted = map { $_->[0] }
1707                      sort { $a->[1] <=> $b->[1] }
1708                      map { [ $_, rand ] } @list;
1709
1710         OLD:
1711         my @sorted =
1712           map { $_->[0] } sort { $a->[1] <=> $b->[1] } map { [ $_, rand ] } @list;
1713
1714         NEW:
1715         my @sorted = map { $_->[0] }
1716           sort { $a->[1] <=> $b->[1] }
1717           map { [ $_, rand ] } @list;
1718
1719       The new alignment is not as nice as the input, but this is an improvement.
1720       Thanks to Yves Orton for this suggestion.
1721
1722      -modified indentation logic so that a line with leading opening paren,
1723      brace, or square bracket will never have less indentation than the
1724      line with the corresponding opening token.  Here's a simple example:
1725
1726         OLD:
1727             $mw->Button(
1728                 -text    => "New Document",
1729                 -command => \&new_document
1730               )->pack(
1731                 -side   => 'bottom',
1732                 -anchor => 'e'
1733             );
1734
1735         Note how the closing ');' is lined up with the first line, even
1736         though it closes a paren in the 'pack' line.  That seems wrong.
1737  
1738         NEW:
1739             $mw->Button(
1740                 -text    => "New Document",
1741                 -command => \&new_document
1742               )->pack(
1743                 -side   => 'bottom',
1744                 -anchor => 'e'
1745               );
1746
1747        This seems nicer: you can up-arrow with an editor and arrive at the
1748        opening 'pack' line.
1749  
1750      -corrected minor glitch in which cuddled else (-ce) did not get applied
1751      to an 'unless' block, which should look like this:
1752
1753             unless ($test) {
1754
1755             } else {
1756
1757             }
1758
1759       Thanks to Jeremy Mates for reporting this.
1760
1761      -The man page has been reorganized to parameters easier to find.
1762  
1763      -Added check for multiple definitions of same subroutine.  It is easy
1764       to introduce this problem when cutting and pasting. Perl does not
1765       complain about it, but it can lead to disaster.
1766
1767      -The command -pro=filename  or -profile=filename may be used to specify a
1768       configuration file which will override the default name of .perltidyrc.
1769       There must not be a space on either side of the '=' sign.  I needed
1770       this to be able to easily test perltidy with a variety of different
1771       configuration files.
1772
1773      -Side comment alignment has been improved somewhat across frequent level
1774       changes, as in short if/else blocks.  Thanks to Wolfgang Weisselberg 
1775       for pointing out this problem.  For example:
1776     
1777         OLD:
1778         if ( ref $self ) {    # Called as a method
1779             $format = shift;
1780         }
1781         else {    # Regular procedure call
1782             $format = $self;
1783             undef $self;
1784         }
1785
1786         NEW:
1787         if ( ref $self ) {    # Called as a method
1788             $format = shift;
1789         }
1790         else {                # Regular procedure call
1791             $format = $self;
1792             undef $self;
1793         }
1794
1795      -New command -ssc (--static-side-comment) and related command allows
1796       side comments to be spaced close to preceding character.  This is
1797       useful for displaying commented code as side comments.
1798
1799      -New command -csc (--closing-side-comment) and several related
1800       commands allow comments to be added to (and deleted from) any or all
1801       closing block braces.  This can be useful if you have to maintain large
1802       programs, especially those that you didn't write.  See updated man page.
1803       Thanks to Peter Masiar for this suggestion.  For a simple example:
1804
1805             perltidy -csc
1806
1807             sub foo {
1808                 if ( !defined( $_[0] ) ) {
1809                     print("Hello, World\n");
1810                 }
1811                 else {
1812                     print( $_[0], "\n" );
1813                 }
1814             } ## end sub foo
1815
1816       This added '## end sub foo' to the closing brace.  
1817       To remove it, perltidy -ncsc.
1818
1819      -New commands -ola, for outdenting labels, and -okw, for outdenting
1820       selected control keywords, were implemented.  See the perltidy man
1821       page for details.  Thanks to Peter Masiar for this suggestion.
1822
1823      -Hanging side comment change: a comment will not be considered to be a
1824       hanging side comment if there is no leading whitespace on the line.
1825       This should improve the reliability of identifying hanging side comments.
1826       Thanks to Peter Masiar for this suggestion.
1827
1828      -Two new commands for outdenting, -olq (outdent-long-quotes) and -olc
1829       (outdent-long-comments), have been added.  The original -oll
1830       (outdent-long-lines) remains, and now is an abbreviation for -olq and -olc.
1831       The new default is just -olq.  This was necessary to avoid inconsistency with
1832       the new static block comment option.
1833
1834      -Static block comments:  to provide a way to display commented code
1835       better, the convention is used that comments with a leading '##' should
1836       not be formatted as usual.  Please see '-sbc' (or '--static-block-comment')
1837       for documentation.  It can be deactivated with with -nsbc, but
1838       should not normally be necessary. Thanks to Peter Masiar for this 
1839       suggestion.
1840
1841      -Two changes were made to help show structure of complex lists:
1842       (1) breakpoints are forced after every ',' in a list where any of
1843       the list items spans multiple lines, and
1844       (2) List items which span multiple lines now get continuation indentation.
1845
1846       The following example illustrates both of these points.  Many thanks to
1847       Wolfgang Weisselberg for this snippet and a discussion of it; this is a
1848       significant formatting improvement. Note how it is easier to see the call
1849       parameters in the NEW version:
1850
1851         OLD:
1852         assert( __LINE__, ( not defined $check )
1853             or ref $check
1854             or $check eq "new"
1855             or $check eq "old", "Error in parameters",
1856             defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
1857             defined $db_new  ? ( ref $db_new  ? ref $db_new  : $db_new )  : "undef",
1858             defined $old_db ? ( ref $old_db ? ref $old_db : $old_db ) : "undef" );
1859
1860         NEW: 
1861         assert(
1862             __LINE__,
1863             ( not defined $check )
1864               or ref $check
1865               or $check eq "new"
1866               or $check eq "old",
1867             "Error in parameters",
1868             defined $old_new ? ( ref $old_new ? ref $old_new : $old_new ) : "undef",
1869             defined $db_new  ? ( ref $db_new  ? ref $db_new  : $db_new )  : "undef",
1870             defined $old_db  ? ( ref $old_db  ? ref $old_db  : $old_db )  : "undef"
1871         );
1872
1873         Another example shows how this helps displaying lists:
1874
1875         OLD:
1876         %{ $self->{COMPONENTS} } = (
1877             fname =>
1878             { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
1879             street =>
1880             { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
1881         );
1882
1883         The structure is clearer with the added indentation:
1884     
1885         NEW:
1886         %{ $self->{COMPONENTS} } = (
1887             fname =>
1888               { type => 'name', adj => 'yes', font => 'Helvetica', 'index' => 0 },
1889             street =>
1890               { type => 'road', adj => 'yes', font => 'Helvetica', 'index' => 2 },
1891         );
1892
1893         -The structure of nested logical expressions is now displayed better.
1894         Thanks to Wolfgang Weisselberg for helpful discussions.  For example,
1895         note how the status of the final 'or' is displayed in the following:
1896
1897         OLD:
1898         return ( !null($op)
1899               and null( $op->sibling )
1900               and $op->ppaddr eq "pp_null"
1901               and class($op) eq "UNOP"
1902               and ( ( $op->first->ppaddr =~ /^pp_(and|or)$/
1903                 and $op->first->first->sibling->ppaddr eq "pp_lineseq" )
1904                 or ( $op->first->ppaddr eq "pp_lineseq"
1905                     and not null $op->first->first->sibling
1906                     and $op->first->first->sibling->ppaddr eq "pp_unstack" ) ) );
1907
1908         NEW:
1909         return (
1910             !null($op)
1911               and null( $op->sibling )
1912               and $op->ppaddr eq "pp_null"
1913               and class($op) eq "UNOP"
1914               and (
1915                 (
1916                     $op->first->ppaddr =~ /^pp_(and|or)$/
1917                     and $op->first->first->sibling->ppaddr eq "pp_lineseq"
1918                 )
1919                 or ( $op->first->ppaddr eq "pp_lineseq"
1920                     and not null $op->first->first->sibling
1921                     and $op->first->first->sibling->ppaddr eq "pp_unstack" )
1922               )
1923         );
1924
1925        -A break will always be put before a list item containing a comma-arrow.
1926        This will improve formatting of mixed lists of this form:
1927
1928             OLD:
1929             $c->create(
1930                 'text', 225, 20, -text => 'A Simple Plot',
1931                 -font => $font,
1932                 -fill => 'brown'
1933             );
1934
1935             NEW:
1936             $c->create(
1937                 'text', 225, 20,
1938                 -text => 'A Simple Plot',
1939                 -font => $font,
1940                 -fill => 'brown'
1941             );
1942
1943       -For convenience, the command -dac (--delete-all-comments) now also
1944       deletes pod.  Likewise, -tac (--tee-all-comments) now also sends pod
1945       to a '.TEE' file.  Complete control over the treatment of pod and
1946       comments is still possible, as described in the updated help message 
1947       and man page.
1948
1949       -The logic which breaks open 'containers' has been rewritten to be completely
1950       symmetric in the following sense: if a line break is placed after an opening
1951       {, [, or (, then a break will be placed before the corresponding closing
1952       token.  Thus, a container either remains closed or is completely cracked
1953       open.
1954
1955       -Improved indentation of parenthesized lists.  For example, 
1956
1957                 OLD:
1958                 $GPSCompCourse =
1959                   int(
1960                   atan2( $GPSTempCompLong - $GPSLongitude,
1961                   $GPSLatitude - $GPSTempCompLat ) * 180 / 3.14159265 );
1962
1963                 NEW:
1964                 $GPSCompCourse = int(
1965                     atan2(
1966                         $GPSTempCompLong - $GPSLongitude,
1967                         $GPSLatitude - $GPSTempCompLat
1968                       ) * 180 / 3.14159265
1969                 );
1970
1971        Further improvements will be made in future releases.
1972
1973       -Some improvements were made in formatting small lists.
1974
1975       -Correspondence between Input and Output line numbers reported in a 
1976        .LOG file should now be exact.  They were sometimes off due to the size
1977        of intermediate buffers.
1978
1979       -Corrected minor tokenization error in which a ';' in a foreach loop
1980        control was tokenized as a statement termination, which forced a 
1981        line break:
1982
1983             OLD:
1984             foreach ( $i = 0;
1985                 $i <= 10;
1986                 $i += 2
1987               )
1988             {
1989                 print "$i ";
1990             }
1991
1992             NEW:
1993             foreach ( $i = 0 ; $i <= 10 ; $i += 2 ) {
1994                 print "$i ";
1995             }
1996
1997       -Corrected a problem with reading config files, in which quote marks were not
1998        stripped.  As a result, something like -wba="&& . || " would have the leading
1999        quote attached to the && and not work correctly.  A workaround for older
2000        versions is to place a space around all tokens within the quotes, like this:
2001        -wba=" && . || "
2002
2003       -Removed any existing space between a label and its ':'
2004         OLD    : { }
2005         NEW: { }
2006        This was necessary because the label and its colon are a single token.
2007
2008       -Corrected tokenization error for the following (highly non-recommended) 
2009        construct:
2010         $user = @vars[1] / 100;
2011  
2012       -Resolved cause of a difference between perltidy under perl v5.6.1 and
2013       5.005_03; the problem was different behavior of \G regex position
2014       marker(!)
2015
2016   2001 10 20
2017      -Corrected a bug in which a break was not being made after a full-line
2018      comment within a short eval/sort/map/grep block.  A flag was not being
2019      zeroed.  The syntax error check catches this.  Here is a snippet which
2020      illustrates the bug:
2021
2022             eval {
2023                 #open Socket to Dispatcher
2024                 $sock = &OpenSocket;
2025             };
2026
2027      The formatter mistakenly thought that it had found the following 
2028      one-line block:
2029  
2030             eval {#open Socket to Dispatcher$sock = &OpenSocket; };
2031
2032      The patch fixes this. Many thanks to Henry Story for reporting this bug.
2033
2034      -Changes were made to help diagnose and resolve problems in a
2035      .perltidyrc file: 
2036        (1) processing of command parameters has been into two separate
2037        batches so that any errors in a .perltidyrc file can be localized.  
2038        (2) commands --help, --version, and as many of the --dump-xxx
2039        commands are handled immediately, without any command line processing
2040        at all.  
2041        (3) Perltidy will ignore any commands in the .perltidyrc file which
2042        cause immediate exit.  These are:  -h -v -ddf -dln -dop -dsn -dtt
2043        -dwls -dwrs -ss.  Thanks to Wolfgang Weisselberg for helpful
2044        suggestions regarding these updates.
2045
2046      -Syntax check has been reinstated as default for MSWin32 systems.  This
2047      way Windows 2000 users will get syntax check by default, which seems
2048      like a better idea, since the number of Win 95/98 systems will be
2049      decreasing over time.  Documentation revised to warn Windows 95/98
2050      users about the problem with empty '&1'.  Too bad these systems
2051      all report themselves as MSWin32.
2052
2053   2001 10 16
2054      -Fixed tokenization error in which a method call of the form
2055
2056         Module::->new();
2057  
2058       got a space before the '::' like this:
2059
2060         Module ::->new();
2061
2062       Thanks to David Holden for reporting this.
2063  
2064      -Added -html control over pod text, using a new abbreviation 'pd'.  See
2065      updated perl2web man page. The default is to use the color of a comment,
2066      but italicized.  Old .css style sheets will need a new line for
2067      .pd to use this.  The old color was the color of a string, and there
2068      was no control.  
2069  
2070      -.css lines are now printed in sorted order.
2071
2072      -Fixed interpolation problem where html files had '$input_file' as title
2073      instead of actual input file name.  Thanks to Simon Perreault for finding
2074      this and sending a patch, and also to Tobias Weber.
2075
2076      -Breaks will now have the ':' placed at the start of a line, 
2077      one per line by default because this shows logical structure
2078      more clearly. This coding has been completely redone. Some 
2079      examples of new ?/: formatting:
2080
2081            OLD:
2082                 wantarray ? map( $dir::cwd->lookup($_)->path, @_ ) :
2083                   $dir::cwd->lookup( $_[0] )->path;
2084
2085            NEW:
2086                 wantarray 
2087                   ? map( $dir::cwd->lookup($_)->path, @_ )
2088                   : $dir::cwd->lookup( $_[0] )->path;
2089
2090            OLD:
2091                     $a = ( $b > 0 ) ? {
2092                         a => 1,
2093                         b => 2
2094                     } : { a => 6, b => 8 };
2095
2096            NEW:
2097                     $a = ( $b > 0 )
2098                       ? {
2099                         a => 1,
2100                         b => 2
2101                       }
2102                       : { a => 6, b => 8 };
2103
2104         OLD: (-gnu):
2105         $self->note($self->{skip} ? "Hunk #$self->{hunk} ignored at 1.\n" :
2106                     "Hunk #$self->{hunk} failed--$@");
2107
2108         NEW: (-gnu):
2109         $self->note($self->{skip} 
2110                     ? "Hunk #$self->{hunk} ignored at 1.\n"
2111                     : "Hunk #$self->{hunk} failed--$@");
2112
2113         OLD:
2114             $which_search =
2115               $opts{"t"} ? 'title'   :
2116               $opts{"s"} ? 'subject' : $opts{"a"} ? 'author' : 'title';
2117
2118         NEW:
2119             $which_search =
2120               $opts{"t"} ? 'title'
2121               : $opts{"s"} ? 'subject'
2122               : $opts{"a"} ? 'author'
2123               : 'title';
2124  
2125      You can use -wba=':' to recover the previous default which placed ':'
2126      at the end of a line.  Thanks to Michael Cartmell for helpful
2127      discussions and examples.  
2128
2129      -Tokenizer updated to do syntax checking for matched ?/: pairs.  Also,
2130      the tokenizer now outputs a unique serial number for every balanced
2131      pair of brace types and ?/: pairs.  This greatly simplifies the
2132      formatter.
2133
2134      -Long lines with repeated 'and', 'or', '&&', '||'  will now have
2135      one such item per line.  For example:
2136
2137         OLD:
2138             if ( $opt_d || $opt_m || $opt_p || $opt_t || $opt_x
2139                 || ( -e $archive && $opt_r ) )
2140             {
2141                 ( $pAr, $pNames ) = readAr($archive);
2142             }
2143
2144         NEW:
2145             if ( $opt_d
2146                 || $opt_m
2147                 || $opt_p
2148                 || $opt_t
2149                 || $opt_x
2150                 || ( -e $archive && $opt_r ) )
2151             {
2152                 ( $pAr, $pNames ) = readAr($archive);
2153             }
2154
2155        OLD:
2156             if ( $vp->{X0} + 4 <= $x && $vp->{X0} + $vp->{W} - 4 >= $x
2157                 && $vp->{Y0} + 4 <= $y && $vp->{Y0} + $vp->{H} - 4 >= $y ) 
2158
2159        NEW:
2160             if ( $vp->{X0} + 4 <= $x
2161                 && $vp->{X0} + $vp->{W} - 4 >= $x
2162                 && $vp->{Y0} + 4 <= $y
2163                 && $vp->{Y0} + $vp->{H} - 4 >= $y )
2164
2165      -Long lines with multiple concatenated tokens will have concatenated
2166      terms (see below) placed one per line, except for short items.  For
2167      example:
2168
2169        OLD:
2170             $report .=
2171               "Device type:" . $ib->family . "  ID:" . $ib->serial . "  CRC:"
2172               . $ib->crc . ": " . $ib->model() . "\n";
2173
2174        NEW:
2175             $report .= "Device type:"
2176               . $ib->family . "  ID:"
2177               . $ib->serial . "  CRC:"
2178               . $ib->model()
2179               . $ib->crc . ": " . "\n";
2180
2181      NOTE: at present 'short' means 8 characters or less.  There is a
2182      tentative flag to change this (-scl), but it is undocumented and
2183      is likely to be changed or removed later, so only use it for testing.  
2184      In the above example, the tokens "  ID:", "  CRC:", and "\n" are below
2185      this limit.  
2186
2187      -If a line which is short enough to fit on a single line was
2188      nevertheless broken in the input file at a 'good' location (see below), 
2189      perltidy will try to retain a break.  For example, the following line
2190      will be formatted as:
2191  
2192         open SUM, "<$file"
2193           or die "Cannot open $file ($!)";
2194  
2195      if it was broken in the input file, and like this if not:
2196
2197         open SUM, "<$file" or die "Cannot open $file ($!)";
2198
2199      GOOD: 'good' location means before 'and','or','if','unless','&&','||'
2200
2201      The reason perltidy does not just always break at these points is that if
2202      there are multiple, similar statements, this would preclude alignment.  So
2203      rather than check for this, perltidy just tries to follow the input style,
2204      in the hopes that the author made a good choice. Here is an example where 
2205      we might not want to break before each 'if':
2206
2207         ($Locale, @Locale) = ($English, @English) if (@English > @Locale);
2208         ($Locale, @Locale) = ($German,  @German)  if (@German > @Locale);
2209         ($Locale, @Locale) = ($French,  @French)  if (@French > @Locale);
2210         ($Locale, @Locale) = ($Spanish, @Spanish) if (@Spanish > @Locale);
2211
2212      -Added wildcard file expansion for systems with shells which lack this.
2213      Now 'perltidy *.pl' should work under MSDOS/Windows.  Thanks to Hugh Myers 
2214      for suggesting this.  This uses builtin glob() for now; I may change that.
2215
2216      -Added new flag -sbl which, if specified, overrides the value of -bl
2217      for opening sub braces.  This allows formatting of this type:
2218
2219      perltidy -sbl 
2220
2221      sub foo
2222      {
2223         if (!defined($_[0])) {
2224             print("Hello, World\n");
2225         }
2226         else {
2227             print($_[0], "\n");
2228         }
2229      }
2230      Requested by Don Alexander.
2231
2232      -Fixed minor parsing error which prevented a space after a $$ variable
2233      (pid) in some cases.  Thanks to Michael Cartmell for noting this.
2234      For example, 
2235        old: $$< 700 
2236        new: $$ < 700
2237
2238      -Improved line break choices 'and' and 'or' to display logic better.
2239      For example:
2240
2241         OLD:
2242             exists $self->{'build_dir'} and push @e,
2243               "Unwrapped into directory $self->{'build_dir'}";
2244
2245         NEW:
2246             exists $self->{'build_dir'}
2247               and push @e, "Unwrapped into directory $self->{'build_dir'}";
2248
2249      -Fixed error of multiple use of abbreviatioin '-dsc'.  -dsc remains 
2250      abbreviation for delete-side-comments; -dsm is new abbreviation for 
2251      delete-semicolons.
2252
2253      -Corrected and updated 'usage' help routine.  Thanks to Slaven Rezic for 
2254      noting an error.
2255
2256      -The default for Windows is, for now, not to do a 'perl -c' syntax
2257      check (but -syn will activate it).  This is because of problems with
2258      command.com.  James Freeman sent me a patch which tries to get around
2259      the problems, and it works in many cases, but testing revealed several
2260      issues that still need to be resolved.  So for now, the default is no
2261      syntax check for Windows.
2262
2263      -I added a -T flag when doing perl -c syntax check.
2264      This is because I test it on a large number of scripts from sources
2265      unknown, and who knows what might be hidden in initialization blocks?
2266      Also, deactivated the syntax check if perltidy is run as root.  As a
2267      benign example, running the previous version of perltidy on the
2268      following file would cause it to disappear:
2269
2270             BEGIN{
2271                     print "Bye, bye baby!\n";
2272                     unlink $0;
2273             }
2274         
2275      The new version will not let that happen.
2276
2277      -I am contemplating (but have not yet implemented) making '-lp' the
2278      default indentation, because it is stable now and may be closer to how
2279      perl is commonly formatted.  This could be in the next release.  The
2280      reason that '-lp' was not the original default is that the coding for
2281      it was complex and not ready for the initial release of perltidy.  If
2282      anyone has any strong feelings about this, I'd like to hear.  The
2283      current default could always be recovered with the '-nlp' flag.
2284
2285   2001 09 03
2286      -html updates:
2287          - sub definition names are now specially colored, red by default.  
2288            The letter 'm' is used to identify them.
2289          - keyword 'sub' now has color of other keywords.
2290          - restored html keyword color to __END__ and __DATA__, which was 
2291            accidentally removed in the previous version.
2292
2293      -A new -se (--standard-error-output) flag has been implemented and
2294      documented which causes all errors to be written to standard output
2295      instead of a .ERR file.
2296
2297      -A new -w (--warning-output) flag has been implemented and documented
2298       which causes perltidy to output certain non-critical messages to the
2299       error output file, .ERR.  These include complaints about pod usage,
2300       for example.  The default is to not include these.
2301
2302       NOTE: This replaces an undocumented -w=0 or --warning-level flag
2303       which was tentatively introduced in the previous version to avoid some
2304       unwanted messages.  The new default is the same as the old -w=0, so
2305       that is no longer needed. 
2306
2307       -Improved syntax checking and corrected tokenization of functions such
2308       as rand, srand, sqrt, ...  These can accept either an operator or a term
2309       to their right.  This has been corrected.
2310  
2311      -Corrected tokenization of semicolon: testing of the previous update showed 
2312      that the semicolon in the following statement was being mis-tokenized.  That
2313      did no harm, other than adding an extra blank space, but has been corrected.
2314
2315               for (sort {strcoll($a,$b);} keys %investments) {
2316                  ...
2317               }
2318
2319      -New syntax check: after wasting 5 minutes trying to resolve a syntax
2320       error in which I had an extra terminal ';' in a complex for (;;) statement, 
2321       I spent a few more minutes adding a check for this in perltidy so it won't
2322       happen again.
2323
2324      -The behavior of --break-before-subs (-bbs) and --break-before-blocks
2325      (-bbb) has been modified.  Also, a new control parameter,
2326      --long-block-line-count=n (-lbl=n) has been introduced to give more
2327      control on -bbb.  This was previously a hardwired value.  The reason
2328      for the change is to reduce the number of unwanted blank lines that
2329      perltidy introduces, and make it less erratic.  It's annoying to remove
2330      an unwanted blank line and have perltidy put it back.  The goal is to
2331      be able to sprinkle a few blank lines in that dense script you
2332      inherited from Bubba.  I did a lot of experimenting with different
2333      schemes for introducing blank lines before and after code blocks, and
2334      decided that there is no really good way to do it.  But I think the new
2335      scheme is an improvement.  You can always deactivate this with -nbbb.
2336      I've been meaning to work on this; thanks to Erik Thaysen for bringing
2337      it to my attention.
2338
2339      -The .LOG file is seldom needed, and I get tired of deleting them, so
2340       they will now only be automatically saved if perltidy thinks that it
2341       made an error, which is almost never.  You can still force the logfile
2342       to be saved with -log or -g.
2343
2344      -Improved method for computing number of columns in a table.  The old
2345      method always tried for an even number.  The new method allows odd
2346      numbers when it is obvious that a list is not a hash initialization
2347      list.
2348
2349        old: my (
2350                  $name,       $xsargs, $parobjs, $optypes,
2351                  $hasp2child, $pmcode, $hdrcode, $inplacecode,
2352                  $globalnew,  $callcopy
2353               )
2354               = @_;
2355
2356        new: my (
2357                  $name,   $xsargs,  $parobjs,     $optypes,   $hasp2child,
2358                  $pmcode, $hdrcode, $inplacecode, $globalnew, $callcopy
2359               )
2360               = @_;
2361
2362      -I fiddled with the list threshold adjustment, and some small lists
2363      look better now.  Here is the change for one of the lists in test file
2364      'sparse.t':
2365      old:
2366        %units =
2367          ("in", "in", "pt", "pt", "pc", "pi", "mm", "mm", "cm", "cm", "\\hsize", "%",
2368            "\\vsize", "%", "\\textwidth", "%", "\\textheight", "%");
2369
2370      new:
2371        %units = (
2372                   "in",      "in", "pt",          "pt", "pc",           "pi",
2373                   "mm",      "mm", "cm",          "cm", "\\hsize",      "%",
2374                   "\\vsize", "%",  "\\textwidth", "%",  "\\textheight", "%"
2375                   );
2376
2377      -Improved -lp formatting at '=' sign.  A break was always being added after
2378      the '=' sign in a statement such as this, (to be sure there was enough room
2379      for the parameters):
2380
2381      old: my $fee =
2382             CalcReserveFee(
2383                             $env,          $borrnum,
2384                             $biblionumber, $constraint,
2385                             $bibitems
2386                             );
2387  
2388      The updated version doesn't do this unless the space is really needed:
2389
2390      new: my $fee = CalcReserveFee(
2391                                    $env,          $borrnum,
2392                                    $biblionumber, $constraint,
2393                                    $bibitems
2394                                    );
2395
2396      -I updated the tokenizer to allow $#+ and $#-, which seem to be new to
2397      Perl 5.6.  Some experimenting with a recent version of Perl indicated
2398      that it allows these non-alphanumeric '$#' array maximum index
2399      varaibles: $#: $#- $#+ so I updated the parser accordingly.  Only $#:
2400      seems to be valid in older versions of Perl.
2401
2402      -Fixed a rare formatting problem with -lp (and -gnu) which caused
2403      excessive indentation.
2404
2405      -Many additional syntax checks have been added.
2406
2407      -Revised method for testing here-doc target strings; the following
2408      was causing trouble with a regex test because of the '*' characters:
2409       print <<"*EOF*";
2410       bla bla
2411       *EOF*
2412      Perl seems to allow almost anything to be a here doc target, so an
2413      exact string comparison is now used.
2414
2415      -Made update to allow underscores in binary numbers, like '0b1100_0000'.
2416
2417      -Corrected problem with scanning certain module names; a blank space was 
2418      being inserted after 'warnings' in the following:
2419         use warnings::register;
2420      The problem was that warnings (and a couple of other key modules) were 
2421      being tokenized as keywords.  They should have just been identifiers.
2422
2423      -Corrected tokenization of indirect objects after sort, system, and exec,
2424      after testing produced an incorrect error message for the following
2425      line of code:
2426         print sort $sortsubref @list;
2427
2428      -Corrected minor problem where a line after a format had unwanted
2429      extra continuation indentation.  
2430
2431      -Delete-block-comments (and -dac) now retain any leading hash-bang line
2432
2433      -Update for -lp (and -gnu) to not align the leading '=' of a list
2434      with a previous '=', since this interferes with alignment of parameters.
2435
2436       old:  my $hireDay = new Date;
2437             my $self    = {
2438                          firstName => undef,
2439                          lastName  => undef,
2440                          hireDay   => $hireDay
2441                          };
2442     
2443       new:  my $hireDay = new Date;
2444             my $self = {
2445                          firstName => undef,
2446                          lastName  => undef,
2447                          hireDay   => $hireDay
2448                          };
2449
2450      -Modifications made to display tables more compactly when possible,
2451       without adding lines. For example,
2452       old:
2453                     '1', "I", '2', "II", '3', "III", '4', "IV",
2454                     '5', "V", '6', "VI", '7', "VII", '8', "VIII",
2455                     '9', "IX"
2456       new:
2457                     '1', "I",   '2', "II",   '3', "III",
2458                     '4', "IV",  '5', "V",    '6', "VI",
2459                     '7', "VII", '8', "VIII", '9', "IX"
2460
2461      -Corrected minor bug in which -pt=2 did not keep the right paren tight
2462      around a '++' or '--' token, like this:
2463
2464                 for ($i = 0 ; $i < length $key ; $i++ )
2465
2466      The formatting for this should be, and now is: 
2467
2468                 for ($i = 0 ; $i < length $key ; $i++)
2469
2470      Thanks to Erik Thaysen for noting this.
2471
2472      -Discovered a new bug involving here-docs during testing!  See BUGS.html.  
2473
2474      -Finally fixed parsing of subroutine attributes (A Perl 5.6 feature).
2475      However, the attributes and prototypes must still be on the same line
2476      as the sub name.
2477
2478   2001 07 31
2479      -Corrected minor, uncommon bug found during routine testing, in which a
2480      blank got inserted between a function name and its opening paren after
2481      a file test operator, but only in the case that the function had not
2482      been previously seen.  Perl uses the existence (or lack thereof) of 
2483      the blank to guess if it is a function call.  That is,
2484         if (-l pid_filename()) {
2485      became
2486         if (-l pid_filename ()) {
2487      which is a syntax error if pid_filename has not been seen by perl.
2488
2489      -If the AutoLoader module is used, perltidy will continue formatting
2490      code after seeing an __END__ line.  Use -nlal to deactivate this feature.  
2491      Likewise, if the SelfLoader module is used, perltidy will continue 
2492      formatting code after seeing a __DATA__ line.  Use -nlsl to
2493      deactivate this feature.  Thanks to Slaven Rezic for this suggestion.
2494
2495      -pod text after __END__ and __DATA__ is now identified by perltidy
2496      so that -dp works correctly.  Thanks to Slaven Rezic for this suggestion.
2497
2498      -The first $VERSION line which might be eval'd by MakeMaker
2499      is now passed through unchanged.  Use -npvl to deactivate this feature.
2500      Thanks to Manfred Winter for this suggestion.
2501
2502      -Improved indentation of nested parenthesized expressions.  Tests have
2503      given favorable results.  Thanks to Wolfgang Weisselberg for helpful
2504      examples.
2505
2506   2001 07 23
2507      -Fixed a very rare problem in which an unwanted semicolon was inserted
2508      due to misidentification of anonymous hash reference curly as a code
2509      block curly.  (No instances of this have been reported; I discovered it
2510      during testing).  A workaround for older versions of perltidy is to use
2511      -nasc.
2512
2513      -Added -icb (-indent-closing-brace) parameter to indent a brace which
2514      terminates a code block to the same level as the previous line.
2515      Suggested by Andrew Cutler.  For example, 
2516
2517             if ($task) {
2518                 yyy();
2519                 }    # -icb
2520             else {
2521                 zzz();
2522                 }
2523
2524      -Rewrote error message triggered by an unknown bareword in a print or
2525      printf filehandle position, and added flag -w=0 to prevent issuing this
2526      error message.  Suggested by Byron Jones.
2527
2528      -Added modification to align a one-line 'if' block with similar
2529      following 'elsif' one-line blocks, like this:
2530           if    ( $something eq "simple" )  { &handle_simple }
2531           elsif ( $something eq "hard" )    { &handle_hard }
2532      (Suggested by  Wolfgang Weisselberg).
2533
2534   2001 07 02
2535      -Eliminated all constants with leading underscores because perl 5.005_03
2536      does not support that.  For example, _SPACES changed to XX_SPACES.
2537      Thanks to kromJx for this update.
2538
2539   2001 07 01
2540      -the directory of test files has been moved to a separate distribution
2541      file because it is getting large but is of little interest to most users.
2542      For the current distribution:
2543        perltidy-20010701.tgz        contains the source and docs for perltidy
2544        perltidy-20010701-test.tgz   contains the test files
2545
2546      -fixed bug where temporary file perltidy.TMPI was not being deleted 
2547      when input was from stdin.
2548
2549      -adjusted line break logic to not break after closing brace of an
2550      eval block (suggested by Boris Zentner).
2551
2552      -added flag -gnu (--gnu-style) to give an approximation to the GNU
2553      style as sometimes applied to perl.  The programming style in GNU
2554      'automake' was used as a guide in setting the parameters; these
2555      parameters will probably be adjusted over time.
2556
2557      -an empty code block now has one space for emphasis:
2558        if ( $cmd eq "bg_untested" ) {}    # old
2559        if ( $cmd eq "bg_untested" ) { }   # new
2560      If this bothers anyone, we could create a parameter.
2561
2562      -the -bt (--brace-tightness) parameter has been split into two
2563      parameters to give more control. -bt now applies only to non-BLOCK
2564      braces, while a new parameter -bbt (block-brace-tightness) applies to
2565      curly braces which contain code BLOCKS. The default value is -bbt=0.
2566
2567      -added flag -icp (--indent-closing-paren) which leaves a statement
2568      termination of the form );, };, or ]; indented with the same
2569      indentation as the previous line.  For example,
2570
2571         @month_of_year = (          # default, or -nicp
2572             'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
2573             'Nov', 'Dec'
2574         );
2575
2576         @month_of_year = (          # -icp
2577             'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',
2578             'Nov', 'Dec'
2579             );
2580
2581      -Vertical alignment updated to synchronize with tokens &&, ||,
2582      and, or, if, unless.  Allowable space before forcing
2583      resynchronization has been increased.  (Suggested by  Wolfgang
2584      Weisselberg).
2585
2586      -html corrected to use -nohtml-bold-xxxxxxx or -nhbx to negate bold,
2587      and likewise -nohtml-italic-xxxxxxx or -nhbi to negate italic.  There
2588      was no way to negate these previously.  html documentation updated and
2589      corrected.  (Suggested by  Wolfgang Weisselberg).
2590
2591      -Some modifications have been made which improve the -lp formatting in
2592      a few cases.
2593
2594      -Perltidy now retains or creates a blank line after an =cut to keep
2595      podchecker happy (Suggested by Manfred H. Winter).  This appears to be
2596      a glitch in podchecker, but it was annoying.
2597
2598   2001 06 17
2599      -Added -bli flag to give continuation indentation to braces, like this
2600
2601             if ($bli_flag)
2602               {
2603                 extra_indentation();
2604               }
2605
2606      -Corrected an error with the tab (-t) option which caused the last line
2607      of a multi-line quote to receive a leading tab.  This error was in
2608      version 2001 06 08  but not 2001 04 06.  If you formatted a script
2609      with -t with this version, please check it by running once with the
2610      -chk flag and perltidy will scan for this possible error.
2611
2612      -Corrected an invalid pattern (\R should have been just R), changed
2613      $^W =1 to BEGIN {$^W=1} to use warnings in compile phase, and corrected
2614      several unnecessary 'my' declarations. Many thanks to Wolfgang Weisselberg,
2615      2001-06-12, for catching these errors.
2616  
2617      -A '-bar' flag has been added to require braces to always be on the
2618      right, even for multi-line if and foreach statements.  For example,
2619      the default formatting of a long if statement would be:
2620
2621             if ($bigwasteofspace1 && $bigwasteofspace2
2622               || $bigwasteofspace3 && $bigwasteofspace4)
2623             {
2624                 bigwastoftime();
2625             }
2626
2627      With -bar, the formatting is:
2628
2629             if ($bigwasteofspace1 && $bigwasteofspace2
2630               || $bigwasteofspace3 && $bigwasteofspace4) {
2631                 bigwastoftime();
2632             }
2633      Suggested by Eli Fidler 2001-06-11.
2634
2635      -Uploaded perltidy to sourceforge cvs 2001-06-10.
2636
2637      -An '-lp' flag (--line-up-parentheses) has been added which causes lists
2638      to be indented with extra indentation in the manner sometimes
2639      associated with emacs or the GNU suggestions.  Thanks to Ian Stuart for
2640      this suggestion and for extensive help in testing it. 
2641
2642      -Subroutine call parameter lists are now formatted as other lists.
2643      This should improve formatting of tables being passed via subroutine
2644      calls.  This will also cause full indentation ('-i=n, default n= 4) of
2645      continued parameter list lines rather than just the number of spaces
2646      given with -ci=n, default n=2.
2647  
2648      -Added support for hanging side comments.  Perltidy identifies a hanging
2649      side comment as a comment immediately following a line with a side
2650      comment or another hanging side comment.  This should work in most
2651      cases.  It can be deactivated with --no-hanging-side-comments (-nhsc).
2652      The manual has been updated to discuss this.  Suggested by Brad
2653      Eisenberg some time ago, and finally implemented.
2654
2655   2001 06 08
2656      -fixed problem with parsing command parameters containing quoted
2657      strings in .perltidyrc files. (Reported by Roger Espel Llima 2001-06-07).
2658
2659      -added two command line flags, --want-break-after and 
2660      --want-break-before, which allow changing whether perltidy
2661      breaks lines before or after any operators.  Please see the revised 
2662      man pages for details.
2663
2664      -added system-wide configuration file capability.
2665      If perltidy does not find a .perltidyrc command line file in
2666      the current directory, nor in the home directory, it now looks
2667      for '/usr/local/etc/perltidyrc' and then for '/etc/perltidyrc'.
2668      (Suggested by Roger Espel Llima 2001-05-31).
2669
2670      -fixed problem in which spaces were trimmed from lines of a multi-line
2671      quote. (Reported by Roger Espel Llima 2001-05-30).  This is an 
2672      uncommon situation, but serious, because it could conceivably change
2673      the proper function of a script.
2674
2675      -fixed problem in which a semicolon was incorrectly added within 
2676      an anonymous hash.  (Reported by A.C. Yardley, 2001-5-23).
2677      (You would know if this happened, because perl would give a syntax
2678      error for the resulting script).
2679
2680      -fixed problem in which an incorrect error message was produced
2681       after a version number on a 'use' line, like this ( Reported 
2682       by Andres Kroonmaa, 2001-5-14):
2683
2684                   use CGI 2.42 qw(fatalsToBrowser);
2685
2686       Other than the extraneous error message, this bug was harmless.
2687
2688   2001 04 06
2689      -fixed serious bug in which the last line of some multi-line quotes or
2690       patterns was given continuation indentation spaces.  This may make
2691       a pattern incorrect unless it uses the /x modifier.  To find
2692       instances of this error in scripts which have been formatted with
2693       earlier versions of perltidy, run with the -chk flag, which has
2694       been added for this purpose (SLH, 2001-04-05).
2695
2696       ** So, please check previously formatted scripts by running with -chk
2697       at least once **
2698
2699      -continuation indentation has been reprogrammed to be hierarchical, 
2700       which improves deeply nested structures.
2701
2702      -fixed problem with undefined value in list formatting (reported by Michael
2703       Langner 2001-04-05)
2704
2705      -Switched to graphical display of nesting in .LOG files.  If an
2706       old format string was "(1 [0 {2", the new string is "{{(".  This
2707       is easier to read and also shows the order of nesting.
2708
2709      -added outdenting of cuddled paren structures, like  ")->pack(".
2710
2711      -added line break and outdenting of ')->' so that instead of
2712
2713             $mw->Label(
2714               -text   => "perltidy",
2715               -relief => 'ridge')->pack;
2716  
2717       the current default is:
2718
2719             $mw->Label(
2720               -text   => "perltidy",
2721               -relief => 'ridge'
2722             )->pack;
2723
2724       (requested by Michael Langner 2001-03-31; in the future this could 
2725       be controlled by a command-line parameter).
2726
2727      -revised list indentation logic, so that lists following an assignment
2728       operator get one full indentation level, rather than just continuation 
2729       indentation.  Also corrected some minor glitches in the continuation 
2730       indentation logic. 
2731
2732      -Fixed problem with unwanted continuation indentation after a blank line 
2733      (reported by Erik Thaysen 2001-03-28):
2734
2735      -minor update to avoid stranding a single '(' on one line
2736
2737   2001 03 28:
2738      -corrected serious error tokenizing filehandles, in which a sub call 
2739      after a print or printf, like this:
2740         print usage() and exit;
2741      became this:
2742         print usage () and exit;
2743      Unfortunately, this converts 'usage' to a filehandle.  To fix this, rerun
2744      perltidy; it will look for this situation and issue a warning. 
2745
2746      -fixed another cuddled-else formatting bug (Reported by Craig Bourne)
2747
2748      -added several diagnostic --dump routines
2749  
2750      -added token-level whitespace controls (suggested by Hans Ecke)
2751
2752   2001 03 23:
2753      -added support for special variables of the form ${^WANT_BITS}
2754
2755      -space added between scalar and left paren in 'for' and 'foreach' loops,
2756       (suggestion by Michael Cartmell):
2757
2758         for $i( 1 .. 20 )   # old
2759         for $i ( 1 .. 20 )   # new
2760
2761      -html now outputs cascading style sheets (thanks to suggestion from
2762       Hans Ecke)
2763
2764      -flags -o and -st now work with -html
2765
2766      -added missing -html documentation for comments (noted by Alex Izvorski)
2767
2768      -support for VMS added (thanks to Michael Cartmell for code patches and 
2769        testing)
2770
2771      -v-strings implemented (noted by Hans Ecke and Michael Cartmell; extensive
2772        testing by Michael Cartmell)
2773
2774      -fixed problem where operand may be empty at line 3970 
2775       (\b should be just b in lines 3970, 3973) (Thanks to Erik Thaysen, 
2776       Keith Marshall for bug reports)
2777
2778      -fixed -ce bug (cuddled else), where lines like '} else {' were indented
2779       (Thanks to Shawn Stepper and Rick Measham for reporting this)
2780
2781   2001 03 04:
2782      -fixed undefined value in line 153 (only worked with -I set)
2783      (Thanks to Mike Stok, Phantom of the Opcodes, Ian Ehrenwald, and others)
2784
2785      -fixed undefined value in line 1069 (filehandle problem with perl versions <
2786      5.6) (Thanks to Yuri Leikind, Mike Stok, Michael Holve, Jeff Kolber)
2787
2788   2001 03 03:
2789      -Initial announcement at freshmeat.net; started Change Log
2790      (Unfortunately this version was DOA, but it was fixed the next day)
2791