Include\accu.h incompatible with Windows.h

[jeffrlivedatacom]

BPO	14387
Nosy	@birkenfeld, @amauryfa, @pitrou, @kristjanvalur, @benjaminp, @skrah
Files	issue14387.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2012-04-28.08:22:58.091>
created_at = <Date 2012-03-22.11:53:03.417>
labels = ['build', 'OS-windows', 'release-blocker']
title = 'Include\\accu.h incompatible with Windows.h'
updated_at = <Date 2012-04-28.08:22:58.090>
user = 'https://bugs.python.org/jeffrlivedatacom'

bugs.python.org fields:

activity = <Date 2012-04-28.08:22:58.090>
actor = 'georg.brandl'
assignee = 'none'
closed = True
closed_date = <Date 2012-04-28.08:22:58.091>
closer = 'georg.brandl'
components = ['Build', 'Windows']
creation = <Date 2012-03-22.11:53:03.417>
creator = 'jeffr@livedata.com'
dependencies = []
files = ['24998']
hgrepos = []
issue_num = 14387
keywords = ['patch']
message_count = 28.0
messages = ['156546', '156547', '156560', '156561', '156588', '156589', '156590', '156596', '156598', '156607', '156608', '156610', '156613', '156616', '156624', '156625', '156626', '156628', '157277', '157351', '157356', '157370', '157372', '157373', '157374', '158018', '159510', '159511']
nosy_count = 8.0
nosy_names = ['georg.brandl', 'amaury.forgeotdarc', 'pitrou', 'kristjan.jonsson', 'benjamin.peterson', 'skrah', 'python-dev', 'jeffr@livedata.com']
pr_nums = []
priority = 'release blocker'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'compile error'
url = 'https://bugs.python.org/issue14387'
versions = ['Python 3.2', 'Python 3.3']

[jeffrlivedatacom]

Windows.h includes RpcNdr.h which does this:

#define small char

accu.h in Python\Include (Python 3.2.3rc2) has this in it:

typedef struct {
PyObject *large; /* A list of previously accumulated large strings */
PyObject *small; /* Pending small strings */
} _PyAccu;

An extension which includes both Windows.h and Python.h won't compile due to the Windows.h definition of "small".

The compiler error (VS2008) starts with:

c:\python32\include\accu.h(21) : error C2059: syntax error : 'type'

[amauryfa]

I suggest to remove accu.h from Python.h: all functions are private anyway, and it's only used by couple of files.

[python-dev]

New changeset f34ac2e9d5cf by Antoine Pitrou in branch '3.2':
Issue bpo-14387: Do not include accu.h from Python.h.
http://hg.python.org/cpython/rev/f34ac2e9d5cf

New changeset 5fe7d19ec49a by Antoine Pitrou in branch 'default':
Issue bpo-14387: Do not include accu.h from Python.h.
http://hg.python.org/cpython/rev/5fe7d19ec49a

[pitrou]

Fixed according to Amaury's suggestion.
Georg, Benjamin, I think this should probably go into the final releases.

[birkenfeld]

Sounds reasonable to me.

[skrah]

Hmm, I still get the error in 13cefcbcc7da:

c:\Users\stefan\pydev\cpython\Include\accu.h(21) : error C2059: syntax error : 'type'
c:\Users\stefan\pydev\cpython\Include\accu.h(22) : error C2059: syntax error : '}'
c:\Users\stefan\pydev\cpython\Include\accu.h(24) : error C2143: syntax error : missing ')' before '*
'
c:\Users\stefan\pydev\cpython\Include\accu.h(24) : error C2143: syntax error : missing '{' before '*
'
c:\Users\stefan\pydev\cpython\Include\accu.h(24) : error C2059: syntax error : ')'
c:\Users\stefan\pydev\cpython\Include\accu.h(25) : error C2143: syntax error : missing ')' before '*
'
c:\Users\stefan\pydev\cpython\Include\accu.h(25) : error C2143: syntax error : missing '{' before '*
'
c:\Users\stefan\pydev\cpython\Include\accu.h(25) : error C2371: 'PyObject' : redefinit

[...]

c:\users\stefan\pydev\cpython\objects\stringlib/unicode_format.h(128) : error C2143: syntax error :
missing ')' before '*'
c:\users\stefan\pydev\cpython\objects\stringlib/unicode_format.h(128) : error C2143: syntax error :
missing '{' before '*'
c:\users\stefan\pydev\cpython\objects\stringlib/unicode_format.h(128) : error C2371: 'PyObject' : re
definition; different basic types

[birkenfeld]

We can of course also rename "small".

[pitrou]

Hmm, I still get the error in 13cefcbcc7da:

Can you try to find a fix? I don't have anything to test here.

[jeffrlivedatacom]

The easiest fix would be to rename the "small" field in accu.h (and of course in any file that references that field.) I have no idea who uses this file.

Perhaps the 2nd easiest fix would be to put this after the #include of Windows.h

#ifdef small
#undef small
#endif

As long as any extension also including Windows.h included Windows.h BEFORE Python.h, this should fix the problem for an extension builder.

A further thought is to put

#define WIN32_LEAN_AND_MEAN

right before the #include Windows.h

This doesn't fix the extension problem in that every #include of Windows.h would need to do this (SQLITE doesn't right now) but if all Python needs from Windows.h is in the "WIN32_LEAN_AND_MEAN" subset, it seems like a good thing in general, no?