Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prevent min/max conflicts between windows.h and std namespace #283

Merged
merged 2 commits into from
Sep 28, 2023
Merged

Prevent min/max conflicts between windows.h and std namespace #283

merged 2 commits into from
Sep 28, 2023

Commits on Aug 15, 2023

  1. Update miniz_zip.c to prevent compilation warning when compiling for … 

    …Windows in straight C mode

Summary:
Added conditional macro definition to prevent MSVC compiler warning C5105 when compiling for Windows in straight C mode

Details:
Since version 3.0.0 miniz_zip.c includes windows.h header file when compiling for Windows using MSVC. However, when compiling miniz_zip.c using MSVC17 in straight-C mode (no C++), this inclusion causes warning C5105:

winbase.h(9531,5): warning C5105: macro expansion producing 'defined' has undefined behavior

This warning is not produced when compiling in C++ mode.

In order to prevent the warning, any straight-C code that wants to include windows.h should make an additional define before including:
#ifndef __cplusplus
#define MICROSOFT_WINDOWS_WINBASE_H_DEFINE_INTERLOCKED_CPLUSPLUS_OVERLOADS 0
#endif
#include <windows.h>
    @nyq
    nyq authored Aug 15, 2023
    Configuration menu
    Copy the full SHA
    fd55960 View commit details
    Browse the repository at this point in the history

  2. Prevent min/max conflicts between windows.h and std namespace 

    Miniz started including windows.h from version 3.0.0 and on when compiling for Windows using MSVC.

windows.h header file is known to conflict with C++ std namespace by defining its own min/max macros. It is a common practice to disable these ancient macros in windows.h by declaring NOMINMAX macro prior to including windows.h in code.

While this issue does not affect miniz directly due to the fact that it is straight-C code and it does not use min/max from C++ std namespace, it does affect other projects like miniz-cpp which wrap and amalgamate miniz and then both compile in C++ mode and use min/max from std namespace.

It is therefore proposed to prefix inclusion of windows.h in miniz_zip.c by the following lines:

#ifndef NOMINMAX
#define NOMINMAX
#endif
    @nyq
    nyq authored Aug 15, 2023
    Configuration menu
    Copy the full SHA
    90a5b2f View commit details
    Browse the repository at this point in the history