1+1=10

记记笔记，放松一下...

Link Confilict between SDL and Qt under Windows

Someone complain that, when using SDL and Qt in the same project under Windows, the linker will generate link error.

SDLmain.lib(SDL_win32_main.obj):-1: error: LNK2005: _WinMain@16 already defined in qtmaind.lib(qtmain_win.obj)

What happened behined this?

1
2
3
4
5
6
#include <QApplication>
#include <SDL.h>
int main(int argc, char** argv)
{
return 0;
}

WinMain vs main

The C and C++ standards require any program to have a function called main, which serves as the program's startup function. It can have one of the following signatures:

1
2
int main()
int main(int argc, char* argv[])

However, WinMain is selected by Microsoft as the conventional name used for the GUI application entry point.

1
2
3
4
5
6
int CALLBACK WinMain(
  _In_  HINSTANCE hInstance,
  _In_  HINSTANCE hPrevInstance,
  _In_  LPSTR lpCmdLine,
  _In_  int nCmdShow
);

As a crossplatform library, both SDL and Qt don't require user to use the WinMain function to create GUI application for Windows. Instead, they both provided a WinMain() for us.

WinMain provided by Qt

qtmain.lib provided by Qt

As a Qt developer, we all know that, when ceating a GUI application under windows. qtmain.lib(or libqtmain.a) will be linked to the application.

If we open the source file of the library, we can see that our main() entry is called by a wrapped function WinMain() in %QTDIR%/src/winmain/qtmain_win.cpp

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
/*
  WinMain() - Initializes Windows and calls user's startup function main().
  NOTE: WinMain() won't be called if the application was linked as a "console"
  application.
*/

extern "C"
int APIENTRY WinMain(HINSTANCE instance, HINSTANCE prevInstance, LPSTR, int cmdShow)
{
...
    int result = main(argc, argv.data());
...
}

Very insteresting, isn't it? But

This work well for MSVC though, but not for MinGW

Consider we have a simple windows application which contians both main() and WinMain()

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
#include <windows.h> 

int main()
{
  MessageBoxW (NULL, L"Hello World from main!", L"hello", MB_OK | MB_ICONINFORMATION); 
  return 0; 
}

int WINAPI WinMain (HINSTANCE hInstance, HINSTANCE hPrevInst, LPTSTR lpCmdLine, int nShowCmd) 
{ 
  MessageBoxW (NULL, L"Hello World from WinMain!", L"hello", MB_OK | MB_ICONINFORMATION); 
  return 0; 
}
  • For MSVC, WinMain() or main() will be used depending on whether /entry:WinMainCRTStartup is passed to the linker or not.
  • For MinGW, WinMain() will never be called if main() exists!

How to solve this problem for MinGW

Let's see what happened when build a Qt Gui application under Windows.

In Qt souce file qwindowdefs.h or qtmain_win.cpp, we can find following code.

1
2
3
#if defined(QT_NEEDS_QMAIN)
#define main qMain
#endif

So main() doesn't exist any more when QT_NEEDS_QMAIN is defined!

What happened for Gui Application?

We know that, 

1
CONFIG += windows

is the default config of qmake, and that's why we have to add

1
CONFIG += console

if when want to create a mormal console application.

The former will force the qmake to load a feature file called windows.prf, in which we can find fowllowing code:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
CONFIG -= console
contains(TEMPLATE, ".*app"){
    QMAKE_LFLAGS += $$QMAKE_LFLAGS_WINDOWS
    win32-g++:DEFINES += QT_NEEDS_QMAIN
    win32-borland:DEFINES += QT_NEEDS_QMAIN

    qt:for(entryLib, $$list($$unique(QMAKE_LIBS_QT_ENTRY))) {
        isEqual(entryLib, -lqtmain): {
            CONFIG(debug, debug|release): QMAKE_LIBS += $${entryLib}$${QT_LIBINFIX}d
            else: QMAKE_LIBS += $${entryLib}$${QT_LIBINFIX}
        } else {
            QMAKE_LIBS += $${entryLib}
        }
    }
}

As you can see, three things done here:

  • Windows subsystem instead of console subsystem is linked, so no black-cmd-window will be shown when the application running. Note that, $$QMAKE_LFLAGS_WINDOWS will be expanded to /subsystem:windows or -Wl,-subsystem,windows.
  • QT_NEEDS_QMAIN is defined for MinGW, so main() will be renamed to qMain which will be called by WinMain()
  • qtmain.lib is passed to the linked which provides the definition of WinMain().

WinMain provided by SDL

Now, consider that we have familiar what's happpened in Qt, it's time to go into the SDL.

WinMain is provided by SDLmain.lib

Source code is more or less like this

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/* This is where execution begins [console apps] */
int
console_main(int argc, char *argv[])
{
//...

    /* Run the application main() code */
    status = SDL_main(argc, argv);
//...
}

/* This is where execution begins [windowed apps] */
int WINAPI
WinMain(HINSTANCE hInst, HINSTANCE hPrev, LPSTR szCmdLine, int sw)
{
    char **argv;
    int argc;
    char *cmdline;
//...
    /* Run the main program */
    console_main(argc, argv);
//...
}

As we can see, a function named SDL_main() is called by WinMain here, but in where is this function defined?

```cpp SDL_main.h

define main SDL_main

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## How to solve the confilict between the two WinMain()

Very interesting ^_^

* Qt: WinMain() provided by qtmain.lib
* SDL: WinMain() provided by SDLmain.lib
* Qt: main() is redefined to qMain() for MinGW
* SDL: main() is redefined to SDL_main() always

Consider that

* WinMain() in SDLmain.lib provide some initialization for SDL, while WinMain() in qtmain.lib not provide such thing for Qt.
* SDLmain is provided for all platform, while qtmain is for Windows only.

We tended to use the WinMain() provided by SDLmain.lib instead of qtmain.lib

So we can simply add following line to the .pro file to solve the  ```_WinMain@16``` conflict.

win32:QMAKE_LIBS_QT_ENGTRY -= -lqtmain

1
2
3
4
5
6
7
8
9
Though this works very for MSVC, but not that well for MinGW. As this cause macro re-definition, and whether the application can be linked successfully will depend on the order of the headers included.

```cpp
//Qt
#if defined(QT_NEEDS_QMAIN)
#define main qMain
#endif
//SDL
#define main    SDL_main

So another line is needed

1
2
win32:QMAKE_LIBS_QT_ENGTRY -= -lqtmain
win32-g++:DEFINES -= QT_NEEDS_QMAIN

or we can disable windows application facility provided by qmake totally, then do it ourself.

1
2
CONFIG-= windows
QMAKE_LFLAGS += $$QMAKE_LFLAGS_WINDOWS

Reference

  • http://wiki.libsdl.org/moin.fcg/FAQWindows
  • http://blog.csdn.net/dbzhang800/article/details/6358996

Posted by Debao Zhang Qt SDL, Qt