Like the previously mentioned compile problem with transcode, PHP’s tidy extension appears to have a macro-induced collision problem on OS X Tiger. In particular the compile run blows up with:
In file included from /usr/include/tidy/tidy.h:70,
/usr/include/tidy/platform.h:515: error: duplicate 'unsigned'
/usr/include/tidy/platform.h:515: warning: useless type name in empty declaration
This exhibits a similar red herring, in that the compiler says a system include file (tidy/platform.h) is causing the issue. In actuality, this is most likely due to a preprocessor macro issue in PHP. In platform.h:515, we see:
typedef unsigned long ulong;
Now, in main/php_config.h:121:
#define ulong unsigned long
Since php_config.h is set to be included before platform.h, on this particular build configuration, platform.h:515 now becomes:
typedef unsigned long unsigned long;
Hence the compiler error message and the red-herring about your system include file (platform.h).
Since php_config.h is included by just about every main PHP source file, the easier solution is to switch the include order of tidy.h and the php default includes. As such, in tidy.c, we go from this:
You may also wish to wrap it with #if HAVE_TIDY and #endif, to preserve the original logic (note that tidy.h was originally within the #if), but in my case it seemed to have gone okay without it.
In my case, this compiled just fine with no further complaints. I don’t like doing this – perhaps the PHP-tidy devs had reasons for putting the includes in this order. But from a pragmatic point of view… hey, it compiles.
Again, the moral of the story: when screwing around with macros, try to avoid naming it something that will collide with system libraries.
Updated Feb 6, 2008
As jhardi notes in the comments section, the folks behind tidy have patched their latest version to work around this issue. Kudos to the tidy devs, and to the others who found this bug way before I even had to care about it.
Minor rant: so…this workaround requires that we upgrade tidy. Since Mac OS X doesn’t regularly update its Unix-y interiors , we’re left with the choice of overwriting an Apple system library, or shadowing it and remembering that we shadowed it. I picked option #1, since it’s unlikely that anything is going to blow up due to a new tidy library, but some people are understandably wary of overwriting system libraries (this is, in fact, one of the reasons why package managers like MacPorts stick copies in alternate directories instead).
This still leaves the current stable PHP not compiling with older tidy versions, on the Mac and any other platform using that typedef. And, as a bonus, there is a possibility that we might be doing this again if PHP ever decides to add another library that uses the word “ulong” somewhere.
That’s just lovely. I hope they address this in their future releases.
2 Replies to “php 5.2.5 compile error – macro issue”
I just wanted to say thanks a lot for this post, as I just ran into the identical problem. After applying your workaround successfully, I did some more research before submitting a bug to PHP, and it turns out that Tidy has made a fix (even though it isn’t their fault).
Here’s the Tidy fix and a related PHP bug report with more info.
I installed the latest Tidy from CVS, and just finished rebuilding PHP, and make went fine without any hacks. (I’m PHP 5.2.5 on OS X 10.4.11.) So, next time around, just upgrade Tidy and you should be fine.
Anyway, thanks again, I’d probably still be smacking myself on the forehead without your post.
thanks for your comment and links. upgraded tidy on my end as well so I don’t have to do this again.
though honestly, PHP should fix their own issues.