New Beta Tidy.exe

[Jos]

Uploaded a new beta version of Tidy.exe v 2.2.0.11 (Feb 1, 2011) and tidy.ini which has the following updates:

Additions/Changes:

- removed the 4096 record limit.

- added support for UTF8 with BOM files.

- added option /region_indent or /ri which will indent #region-#endregion sections.

- Set variable name case for variables as defined in the Constants included files.

Parameter /prc or /properconstants support is added for this function because it will slow down the Tidy process and by default it is off.

e.g.: #Tidy_Parameters=/prc=1

Tidy.ini:

[ProgramSettings]

* * * (tabchar) Indent setting: 0 = Tabs > 0 = Number of Space

tabchar = 0

* * * Update Functions / Keywords / Macros / UDFs To Proper Case

proper = 1

* * * Update Constants defined in the "constant Include files"

properconstants = 0

BugFixes:

- Fixed proper casing Keywords when they "look like a Function" e.g. switch ($a=1)

- Fixed space removal after ( when /Delim=0

- Fixed space addition Between sting and closing brace in case of a Dot after the Brace.

This was a major rewrite of the internal file-handling, reading and memory handling of the script records so need it to be tested.

While testing I would advice to run winmerge automatically so you can actually check what was changed by tidy to ensure you do not screw up a working script.

I use this line in Tidy.ini to accomplish this:

ShowDiffPgm = """C:\Program Files (x86)\WinMerge\winmergeu.exe" "%new%" "%old%"""

Could use some members to do some good testing to ensure things still work properly.

Thanks

jos

Edited February 4, 2011 by Jos

[GEOSoft]

I shall begin testing tomorrow, just to appease you oh most revered one.

[Valuater]

I love this program, it makes me look good.

I know how much I hate to re-enter a working program and try to re-write it... or even up-date it. Thanks for the effort Jos, It is appreciated by many!!!

I will start testing and post any helpful feedback.

Valuater

8)

Edited September 28, 2010 by Valuater

[water]

Many thanks for this great program!

I will start testing right now!

[bo8ster]

No issues spotted, tired with different statement types, indentation, spaces and function.

Outstanding tool for AutoIt use it a lot, thanks!

[stoyan]

Hello all,

here are my observations so far

The changes in my tidy.ini

endfunc_comment = 0

The original code:

EndFunc   ;==>{function name here}

Note the three spaces before the ';' sign.

The tidied up code:

EndFunc ;==>{fucuntion name here}

There is only one space before the ';' sign.

I'm really not sure what the expected behavior would be. The same happens with the tidy.exe v.2.1

Edited September 30, 2010 by stoyan

[Jos]

I'm really not sure what the expected behavior would be. The same happens with the tidy.exe v.2.1

It is expected behaviour to strip the spaces at the end of the code and add a space and then the end-of-line comment.

Jos

[stoyan]

It is expected behaviour to strip the spaces at the end of the code and add a space and then the end-of-line comment.

My bug reports a bad, I have to practice. What I meant with the previous port was that with 'endfunc_comment = 0' the output is different then the one with 'endfunc_comment = 1'. The difference is in those two spaces before the comment character.

The description in the ini says

Added comment To EndFunc statement E.g. "EndFunc   ;==>UDF_Name"

It wasn't clear to me what to expect when turn this feature on or off.

[Jos]

No worries, appreciate the feedback!

Understand that it is different and probably could be called inconsistent, but when 'endfunc_comment = 1' is used the fixed text is added with the extra spaces.

When 'endfunc_comment = 0' is used it follows the standard behaviour which is what I described.

Jos

[stoyan]

Here's one for real.

Consider the following:

#include <Array.au3>
if $cmdline[0] > 0 Then
    _ArrayDisplay($cmdline)
endif

When tidied the result is:

#include <Array.au3>
f $cmdline[0] > 0 Then
_ArrayDisplay($cmdline)
ndif

If new line is added just before the 'EndIf' the result is

#include <Array.au3>
f $cmdline[0] > 0 Then
_ArrayDisplay($cmdline)
;### Tidy Error: next line creates a negative tablevel.
;### Tidy Error: next line creates a negative tablevel for the line after it.
EndIf

The result gets even more devastating the larger the file is.

This occurs if and only if the line ending in the target file are UNIX type. Not tried the mixed line endings case.

I guess you've got an assumption about the length of the new line white space.

Ideally the fix will result in adding a switch in the ini about the preferred line ending char(s).

Edit: Or keep them intact altogether.

Edited October 1, 2010 by stoyan

[stoyan]

One more.

Source:

#include <Array.au3>
If $cmdline[0] > 0 Then
    _ArrayDisplay($cmdline)
EndIf

The result:

#include < Array.au3 >
f $cmdline[0] > 0 Then
_ArrayDisplay($cmdline)
ndif

Note the include line

The source file is UTF-8 with BOM and UNIX LE.

Edit: The includes related issue is not LE related.

Edited October 1, 2010 by stoyan

[Jos]

Ideally the fix will result in adding a switch in the ini about the preferred line ending char(s).

Edit: Or keep them intact altogether.

Understand the bug and will have a look at that to support also single char line endings.

Will also look at the UTF8 file issue... could you PM me the original file as you use it?

Thanks

Jos

[Jos]

Uploaded v 2.2.0.1 which fixes the Single char line endings issue.

Jos

[Jos]

Uploaded v 2.2.0.2 which fixes the UTF8 issue reported by stoyan.

Thanks for the testing

[stoyan]

could you PM me the original file as you use it?

Just for further reference I'm attaching the test files.

I can confirm that the two issues are fixed in v 2.2.0.2

Thank you.

testcase.zip

[stoyan]

Unfortunately you аssume LE consistency.

LE - mixed;UTF-8+BOM.zip

[Jos]

You seriously have files that have partially CRLF and partially CR or LF?

[Melba23]

A foolish consistency is the hobgoblin of little minds

Ralph Waldo Emerson

But consistency in file line endings I would consider anything but foolish. I would call it entirely normal - if not essential!

M23

[Richard Robertson]

I believe that there should be an option in Tidy to normalize the line endings.

[Valik]

For what it's worth, my opinion is that Tidy should read in files with mixed line endings and then just normalize them. It doesn't need to be complex, just normalize to the first line ending or something (or use a hard-coded setting). Some simple logic to read in files with mixed line endings is to just replace the CRLF combination with LF, then replace all remaining CR with LF. Any existing LF will go unchanged. Then on writing just convert LF to the desired normalized ending.