`sprtf` library should work cross platform

[balthisar]

Although this is intended for debugging, its features should be platform agnostic. It doesn't affect release builds of Tidy, so this isn't a hard milestone.

[geoffmcl]

@balthisar I have been using my little sprtf module for a long, LONG time, and for sure it should be platform agnostic...

I have not yet had time to fully check whether tidy has my latest sprtf.[c|h] modules, but a quick review indicates a 2017/02/12 date, which is for sure fairly recent, but advise if any problem compiling it in unix/macOS as I do have versions that work fine in several unix projects...

In tidy code, the main thing seems to be replacing the clumsy _MSC_VER macro, #if !defined(NDEBUG) && defined(_MSC_VER), and some variations, with something more appropriate...

As advised, will help where I can... thanks...

[balthisar]

Candidate #626.

[balthisar]

Another one closed! On a roll...

[geoffmcl]

@balthisar yes, you are certainly On a roll... ;=))

So fast in fact that I did not have time to respond on this...

My concern is that all you have done mainly is to remove the defined(MSC_VER)...

On many that is fine because they have a second define, like defined(DEBUG_PPRINT), defined(DEBUG_INDENT), defined(DEBUG_MEMORY), or defined(DEBUG_ALLOCATION), and that is ok...

But that leaves many with just #if !defined(NDEBUG). Now that is also fine in the Windows build because NDEBUG is automatically added to the MSVC builds other than the Debug configuration...

But this is not the case in linux. If the user does not add -DCMAKE_BUILD_TYPE=Release, then I have seen cases where NDEBUG is not defined automatically...

I am just afraid linux users could end up seeing all this Debug ONLY output from the EXE they build... and I am sure they would be surprised, if not shocked by all the extra output, that I am sure they do not want to see...

I have not thought out a solution yet... and maybe my concern is unwarranted... but I would certainly feel better about the macro being changed to something that the user has to opt-in to use... not get accidentally...

And maybe there is a case for also being able to enable it in other than the Windows Debug build... that is none of it depends just on NDEBUG...

Will give this some thought, and maybe you have an idea... thanks...

[balthisar]

@geoffmcl, good point. It wasn't an issue on Ubuntu, but that's admittedly a small sample size. Perhaps a new define controlled in tidyplatform and cmakelists?

[geoffmcl]

@balthisar not sure what test you did in Ubuntu, but as predicted, if I just do -

$ cat version.txt
5.5.59
2017.10.06
$ cd build/cmake
$ cmake ../..
$ make
$ cat ../../version.txt > temp.html
$ ./tidy temp.html

That is without the option -DCMAKE_BUILD_TYPE=Release, the resultant tidy will output all the SPRTF debug stuff... very alarming if you have not seen it before... totally unexpected...

But could not find the ex.log - note: need to change this default in sprtf.c... but did find the ouput sent to ex.log.html... this need to be fixed in case set_log_file(...) is not called... but why no ex.log... puzzling... need to look at macro switches again in tidy.c...

And if I turn on -DCMAKE_VERBOSE_MAKEFILE=ON, and look carefully at the cc compile lines I can not find -DNDEBUG added... seem the Ubuntu cmake has no default build type, or it defaults to Debug... need to check more on this...

Thinking more about it, maybe replace all, well most - there may be some exceptions - need to check - #if !defined(NDEBUG) with say #if defined(DEBUG_TIDY), or something... still contemplating...

I would also add it as an option in CMakeLists.txt, so it can be turned on anytime... for any build type...

As to whether there should be some default in say tidyplatform.h not sure... How could it be done and still avoiding the problem if CMAKE_BUILD_TYPE is not defined by the user?

Maybe it could again be based on MSC_VER, since, as indicated, the MSVC solution files will always add -DNDEBUG in all builds except Debug... But this is mainly for my convenience, in that I do want this Debug stuff on for the Debug build, hopefully by default... as I had...

Still pondering, and experimenting... but feel something should be urgently done for the *nix builds, before we get the expect WTF message ;=))

What would be your idea? Thanks...

[balthisar]

I usually test with release, and given our build instructions don't mention that, I think you're right!

Let me push a hot fix in the next 45 minutes or so, since I screwed it up.

with say #if defined(DEBUG_TIDY)

Yup, this is what I'm going to do.

[geoffmcl]

@balthisar certainly agree with the hot fix using DEBUG_TIDY... thanks...

And check the Before: and After: showing the flags as below. I seem to get this output even in the Windows Release...

Before: HT20|HT32|H40S|H40T|H40F|H41S|H41T|H41F|X10S|X10T|X10F|XH11|XB10|----|HT50|XH50
After : ----|HT32|H40S|H40T|H40F|H41S|H41T|H41F|X10S|X10T|X10F|XH11|XB10|----|HT50|XH50
line 1 column 1 - Warning: missing <!DOCTYPE> declaration
line 1 column 1 - Warning: inserting implicit <body>
After : ----|HT32|H40S|H40T|----|H41S|H41T|----|X10S|X10T|----|XH11|XB10|----|HT50|XH50
line 1 column 1 - Warning: inserting missing 'title' element
Info: Document content looks like HTML5
Tidy found 3 warnings and 0 errors!

And maybe adjust the default file name in sprtf.c, if you get a chance... would suggest temptidy.txt for all cases... thanks...

[geoffmcl]

Yeah, the Before: After : stuff, Line 325 should also be changed to #if defined(DEBUG_TIDY)... thanks...

PS: Will shortly be out for a while, and may not get back to my machines tonight... my friend has a black blank screen and is screaming for help...