Build: do not include windows.h from header files #1932
+19
−18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Including <windows.h> is both 1) including a lot of code, and 2) leaving a lot of "damage" since it defines many things as preprocessor macros (e.g. "far", "near", "GetObject" etc. can't be used as identifiers). In two cases that <windows.h> was used in TBB headers, the code needed only a tiny amount of functions, so just manually declare their prototypes: - _machine.h: just needs SwitchToThread(), - enumerable_thread_specific.h: just needs four Tls functions (this achieves same result as uxlfoundation#576, but without any potential performance impacts due to extra function call). The exact API shape of WinAPI functions (__declspec(dllimport), __stdcall) and their argument types realistically can't ever change, or it would break all existing software. So it should be fine to just declare them manually like this.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Including
<windows.h>is both 1) including a lot of code, and 2) leaving a lot of "damage" since it defines many things as preprocessor macros (e.g.far,near,GetObjectetc. can't be used as identifiers).In two cases that
<windows.h>was used in TBB headers, the code needed only a tiny amount of functions, so just manually declare their prototypes:_machine.h: just needsSwitchToThread(),enumerable_thread_specific.h: just needs fourTlsfunctions (this achieves same result as Move enumerable_thread_specific Windows.h usage to cpp #576, but without any potential performance impacts due to extra function call).The exact API shape of WinAPI functions (
__declspec(dllimport),__stdcall) and their argument types realistically can't ever change, or it would break all existing software. So it should be fine to just declare them manually like this.Fixes #573
Type of change
Tests
Documentation
Breaks backward compatibility
Notify the following users
Other information