use int instead of SOCKET to avoid including winsock.h from wx/gsocket.h

[wxWidgets.git] / src / msw / gsockmsw.cpp

diff --git a/src/msw/gsockmsw.cpp b/src/msw/gsockmsw.cpp
index 4fb65b9106583b21bbb7248b069eab277ee6cf91..3ca8b48349e4ae395c8d6f798741eca4b3bbdc03 100644 (file)
--- a/src/msw/gsockmsw.cpp
+++ b/src/msw/gsockmsw.cpp
@@ -1,9 +1,11 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * Project: GSocket (Generic Socket)
- * Name:    gsockmsw.cpp
- * Author:  Guillermo Rodriguez Garcia <guille@iies.es>
- * Purpose: GSocket GUI-specific MSW code
- * CVSID:   $Id$
+ * Project:     GSocket (Generic Socket)
+ * Name:        src/msw/gsockmsw.cpp
+ * Copyright:   (c) Guilhem Lavaux
+ * Licence:     wxWindows Licence
+ * Author:      Guillermo Rodriguez Garcia <guille@iies.es>
+ * Purpose:     GSocket GUI-specific MSW code
+ * CVSID:       $Id$

  * -------------------------------------------------------------------------
  */
 
  * -------------------------------------------------------------------------
  */
 


@@ -14,6 +16,8 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_SOCKETS
+

 /*
  * DONE: for WinCE we need to replace WSAAsyncSelect
  * (Windows message-based notification of network events for a socket)
 /*
  * DONE: for WinCE we need to replace WSAAsyncSelect
  * (Windows message-based notification of network events for a socket)


@@ -32,58 +36,19 @@
 #   pragma warning(disable:4115) /* named type definition in parentheses */
 #endif
 
 #   pragma warning(disable:4115) /* named type definition in parentheses */
 #endif
 

-/* This needs to be before the wx/defs/h inclusion
- * for some reason
- */
-
-#ifdef __WXWINCE__
-    /* windows.h results in tons of warnings at max warning level */
-#   ifdef _MSC_VER
-#       pragma warning(push, 1)
-#   endif
-#   include <windows.h>
-#   ifdef _MSC_VER
-#       pragma warning(pop)
-#       pragma warning(disable:4514)
-#   endif
-#endif
-
-#ifndef __GSOCKET_STANDALONE__
-#   include "wx/platform.h"
-#   include "wx/setup.h"
-#endif
-
-#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
-
-#ifndef __GSOCKET_STANDALONE__
-
-#include "wx/msw/gsockmsw.h"

 #include "wx/gsocket.h"
 #include "wx/gsocket.h"

+#include "wx/apptrait.h"
+#include "wx/link.h"

 
 

-extern "C" WXDLLIMPEXP_BASE HINSTANCE wxGetInstance(void);
-#define INSTANCE wxGetInstance()
-
-#else /* __GSOCKET_STANDALONE__ */
-
-#include "gsockmsw.h"
-#include "gsocket.h"
+wxFORCE_LINK_THIS_MODULE(gsockmsw)

 
 

-/* If not using wxWidgets, a global var called hInst must
- * be available and it must contain the app's instance
- * handle.
- */
-extern HINSTANCE hInst;
-#define INSTANCE hInst
-
-#endif /* !__GSOCKET_STANDALONE__/__GSOCKET_STANDALONE__ */
+extern "C" WXDLLIMPEXP_BASE HINSTANCE wxGetInstance();
+#define INSTANCE wxGetInstance()

 
 

-#ifndef __WXWINCE__
-#include <assert.h>
-#else
-#define assert(x)
+#ifdef __WXWINCE__

 #include <winsock.h>
 #include "wx/msw/wince/net.h"
 #include <winsock.h>
 #include "wx/msw/wince/net.h"

-#include <wx/hashmap.h>
+#include "wx/hashmap.h"

 WX_DECLARE_HASH_MAP(int,bool,wxIntegerHash,wxIntegerEqual,SocketHash);
 #endif
 
 WX_DECLARE_HASH_MAP(int,bool,wxIntegerHash,wxIntegerEqual,SocketHash);
 #endif
 


@@ -124,7 +89,7 @@ typedef struct _WSANETWORKEVENTS {
        long lNetworkEvents;
        int iErrorCode[10];
 } WSANETWORKEVENTS, FAR * LPWSANETWORKEVENTS;
        long lNetworkEvents;
        int iErrorCode[10];
 } WSANETWORKEVENTS, FAR * LPWSANETWORKEVENTS;

-typedef HANDLE (PASCAL *WSACreateEventFunc)(void);
+typedef HANDLE (PASCAL *WSACreateEventFunc)();

 typedef int (PASCAL *WSAEventSelectFunc)(SOCKET,HANDLE,long);
 typedef int (PASCAL *WSAWaitForMultipleEventsFunc)(long,HANDLE,BOOL,long,BOOL);
 typedef int (PASCAL *WSAEnumNetworkEventsFunc)(SOCKET,HANDLE,LPWSANETWORKEVENTS);
 typedef int (PASCAL *WSAEventSelectFunc)(SOCKET,HANDLE,long);
 typedef int (PASCAL *WSAWaitForMultipleEventsFunc)(long,HANDLE,BOOL,long,BOOL);
 typedef int (PASCAL *WSAEnumNetworkEventsFunc)(SOCKET,HANDLE,LPWSANETWORKEVENTS);


@@ -152,10 +117,10 @@ static WSAEnumNetworkEventsFunc gs_WSAEnumNetworkEvents = NULL;
 /* This structure will be used to pass data on to the thread that handles socket events.
 */
 typedef struct thread_data{
 /* This structure will be used to pass data on to the thread that handles socket events.
 */
 typedef struct thread_data{

-       HWND hEvtWin;
-       unsigned long msgnumber;
-       unsigned long fd;
-       unsigned long lEvent;
+    HWND hEvtWin;
+    unsigned long msgnumber;
+    unsigned long fd;
+    unsigned long lEvent;

 }thread_data;
 #endif
 
 }thread_data;
 #endif
 


@@ -169,55 +134,69 @@ static HMODULE gs_wsock32dll = 0;
 */
 DWORD WINAPI SocketThread(LPVOID data)
 {
 */
 DWORD WINAPI SocketThread(LPVOID data)
 {

-       WSANETWORKEVENTS NetworkEvents;
-       thread_data* d = (thread_data *)data;
-
-       HANDLE  NetworkEvent = gs_WSACreateEvent();
-       gs_WSAEventSelect(d->fd, NetworkEvent, d->lEvent);
-
-       while(socketHash[d->fd] == true)
-       {
-               if ((gs_WSAWaitForMultipleEvents(1, &NetworkEvent, FALSE,INFINITE, FALSE)) == WAIT_FAILED)
-               {
-                        printf("WSAWaitForMultipleEvents failed with error %d\n", WSAGetLastError());
-                return 0;
-               }
-               if (gs_WSAEnumNetworkEvents(d->fd ,NetworkEvent, &NetworkEvents) == SOCKET_ERROR)
-               {
-                        printf("WSAEnumNetworkEvents failed with error %d\n", WSAGetLastError());
-                        return 0;
-               }
-               
-               long flags = NetworkEvents.lNetworkEvents;
-               if (flags & FD_READ)
-                       ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_READ);
-               if (flags & FD_WRITE)
-                       ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_WRITE);
-               if (flags & FD_OOB)
-                       ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_OOB);
-               if (flags & FD_ACCEPT)
-                       ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_ACCEPT);
-               if (flags & FD_CONNECT)
-                       ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_CONNECT);
-               if (flags & FD_CLOSE)
-                       ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_CLOSE);
-               
-       }
-       gs_WSAEventSelect(d->fd, NetworkEvent, 0);
-       ExitThread(0);
-       return 0;
+    WSANETWORKEVENTS NetworkEvents;
+    thread_data* d = (thread_data *)data;
+
+    HANDLE NetworkEvent = gs_WSACreateEvent();
+    gs_WSAEventSelect(d->fd, NetworkEvent, d->lEvent);
+
+    while(socketHash[d->fd] == true)
+    {
+        if ((gs_WSAWaitForMultipleEvents(1, &NetworkEvent, FALSE,INFINITE, FALSE)) == WAIT_FAILED)
+        {
+            printf("WSAWaitForMultipleEvents failed with error %d\n", WSAGetLastError());
+            return 0;
+        }
+        if (gs_WSAEnumNetworkEvents(d->fd ,NetworkEvent, &NetworkEvents) == SOCKET_ERROR)
+        {
+            printf("WSAEnumNetworkEvents failed with error %d\n", WSAGetLastError());
+            return 0;
+        }
+
+        long flags = NetworkEvents.lNetworkEvents;
+        if (flags & FD_READ)
+            ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_READ);
+        if (flags & FD_WRITE)
+            ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_WRITE);
+        if (flags & FD_OOB)
+            ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_OOB);
+        if (flags & FD_ACCEPT)
+            ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_ACCEPT);
+        if (flags & FD_CONNECT)
+            ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_CONNECT);
+        if (flags & FD_CLOSE)
+            ::PostMessage(d->hEvtWin, d->msgnumber,d->fd, FD_CLOSE);
+
+    }
+    gs_WSAEventSelect(d->fd, NetworkEvent, 0);
+    ExitThread(0);
+    return 0;

 }
 #endif
 
 }
 #endif
 

+// ----------------------------------------------------------------------------
+// MSW implementation of GSocketManager
+// ----------------------------------------------------------------------------

 
 

-bool GSocketGUIFunctionsTableConcrete::CanUseEventLoop()
+class GSocketMSWManager : public GSocketManager

 {
 {

-    return true;
-}
+public:
+    virtual bool OnInit();
+    virtual void OnExit();
+
+    virtual bool Init_Socket(GSocket *socket);
+    virtual void Destroy_Socket(GSocket *socket);
+
+    virtual void Install_Callback(GSocket *socket, GSocketEvent event);
+    virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event);
+
+    virtual void Enable_Events(GSocket *socket);
+    virtual void Disable_Events(GSocket *socket);
+};

 
 /* Global initializers */
 
 
 /* Global initializers */
 

-bool GSocketGUIFunctionsTableConcrete::OnInit()
+bool GSocketMSWManager::OnInit()

 {
   static LPCTSTR pclassname = NULL;
   int i;
 {
   static LPCTSTR pclassname = NULL;
   int i;


@@ -250,7 +229,7 @@ bool GSocketGUIFunctionsTableConcrete::OnInit()
 #else
 /*  On WinCE we load ws2.dll which will provide the needed functions.
 */
 #else
 /*  On WinCE we load ws2.dll which will provide the needed functions.
 */

-       gs_wsock32dll = LoadLibrary(wxT("ws2.dll"));
+  gs_wsock32dll = LoadLibrary(wxT("ws2.dll"));

   if (!gs_wsock32dll)
       return false;
   gs_WSAEventSelect =(WSAEventSelectFunc)GetProcAddress(gs_wsock32dll,
   if (!gs_wsock32dll)
       return false;
   gs_WSAEventSelect =(WSAEventSelectFunc)GetProcAddress(gs_wsock32dll,


@@ -259,32 +238,32 @@ bool GSocketGUIFunctionsTableConcrete::OnInit()
       return false;
 
   gs_WSACreateEvent =(WSACreateEventFunc)GetProcAddress(gs_wsock32dll,
       return false;
 
   gs_WSACreateEvent =(WSACreateEventFunc)GetProcAddress(gs_wsock32dll,

-                                                                                                               wxT("WSACreateEvent"));
+                                                        wxT("WSACreateEvent"));

   if (!gs_WSACreateEvent)
       return false;
 
   gs_WSAWaitForMultipleEvents =(WSAWaitForMultipleEventsFunc)GetProcAddress(gs_wsock32dll,
   if (!gs_WSACreateEvent)
       return false;
 
   gs_WSAWaitForMultipleEvents =(WSAWaitForMultipleEventsFunc)GetProcAddress(gs_wsock32dll,

-                                                                                                               wxT("WSAWaitForMultipleEvents"));
+                                                                            wxT("WSAWaitForMultipleEvents"));

   if (!gs_WSAWaitForMultipleEvents)
       return false;
 
   gs_WSAEnumNetworkEvents =(WSAEnumNetworkEventsFunc)GetProcAddress(gs_wsock32dll,
   if (!gs_WSAWaitForMultipleEvents)
       return false;
 
   gs_WSAEnumNetworkEvents =(WSAEnumNetworkEventsFunc)GetProcAddress(gs_wsock32dll,

-                                                                                                               wxT("WSAEnumNetworkEvents"));
+                                                                    wxT("WSAEnumNetworkEvents"));

   if (!gs_WSAEnumNetworkEvents)
       return false;
 
   currSocket = 0;
 #endif
   if (!gs_WSAEnumNetworkEvents)
       return false;
 
   currSocket = 0;
 #endif

- 
+

   return true;
 }
 
   return true;
 }
 

-void GSocketGUIFunctionsTableConcrete::OnExit()
+void GSocketMSWManager::OnExit()

 {
 #ifdef __WXWINCE__
 /* Delete the threads here */
 {
 #ifdef __WXWINCE__
 /* Delete the threads here */

-       for(unsigned int i=0; i < currSocket; i++)
-               CloseHandle(hThread[i]);
+    for(unsigned int i=0; i < currSocket; i++)
+        CloseHandle(hThread[i]);

 #endif
   /* Destroy internal window */
   DestroyWindow(hWin);
 #endif
   /* Destroy internal window */
   DestroyWindow(hWin);


@@ -303,7 +282,7 @@ void GSocketGUIFunctionsTableConcrete::OnExit()
 
 /* Per-socket GUI initialization / cleanup */
 
 
 /* Per-socket GUI initialization / cleanup */
 

-bool GSocketGUIFunctionsTableConcrete::Init_Socket(GSocket *socket)
+bool GSocketMSWManager::Init_Socket(GSocket *socket)

 {
   int i;
 
 {
   int i;
 


@@ -330,14 +309,40 @@ bool GSocketGUIFunctionsTableConcrete::Init_Socket(GSocket *socket)
   return true;
 }
 
   return true;
 }
 

-void GSocketGUIFunctionsTableConcrete::Destroy_Socket(GSocket *socket)
+void GSocketMSWManager::Destroy_Socket(GSocket *socket)

 {
   /* Remove the socket from the list */
   EnterCriticalSection(&critical);
 {
   /* Remove the socket from the list */
   EnterCriticalSection(&critical);

-  socketList[(socket->m_msgnumber - WM_USER)] = NULL;
+
+  const int msgnum = socket->m_msgnumber;
+  if ( msgnum )
+  {
+      // we need to remove any pending messages for this socket to avoid having
+      // them sent to a new socket which could reuse the same message number as
+      // soon as we destroy this one
+      MSG msg;
+      while ( ::PeekMessage(&msg, hWin, msgnum, msgnum, PM_REMOVE) )
+          ;
+
+      socketList[msgnum - WM_USER] = NULL;
+  }
+  //else: the socket has never been created successfully
+

   LeaveCriticalSection(&critical);
 }
 
   LeaveCriticalSection(&critical);
 }
 

+void GSocketMSWManager::Install_Callback(GSocket * WXUNUSED(socket),
+                                         GSocketEvent WXUNUSED(event))
+{
+    wxFAIL_MSG( _T("not used under MSW") );
+}
+
+void GSocketMSWManager::Uninstall_Callback(GSocket * WXUNUSED(socket),
+                                           GSocketEvent WXUNUSED(event))
+{
+    wxFAIL_MSG( _T("not used under MSW") );
+}
+

 /* Windows proc for asynchronous event handling */
 
 LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd,
 /* Windows proc for asynchronous event handling */
 
 LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd,


@@ -362,7 +367,7 @@ LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd,
      * destroyed) and for safety, check that the m_fd field
      * is what we expect it to be.
      */
      * destroyed) and for safety, check that the m_fd field
      * is what we expect it to be.
      */

-    if ((socket != NULL) && (socket->m_fd == wParam))
+    if ((socket != NULL) && ((WPARAM)socket->m_fd == wParam))

     {
       switch WSAGETSELECTEVENT(lParam)
       {
     {
       switch WSAGETSELECTEVENT(lParam)
       {


@@ -414,10 +419,8 @@ LRESULT CALLBACK _GSocket_Internal_WinProc(HWND hWnd,
  *  events for internal processing, but we will only notify users
  *  when an appropiate callback function has been installed.
  */
  *  events for internal processing, but we will only notify users
  *  when an appropiate callback function has been installed.
  */

-void GSocketGUIFunctionsTableConcrete::Enable_Events(GSocket *socket)
+void GSocketMSWManager::Enable_Events(GSocket *socket)

 {
 {

-  assert (socket != NULL);
-

   if (socket->m_fd != INVALID_SOCKET)
   {
     /* We could probably just subscribe to all events regardless
   if (socket->m_fd != INVALID_SOCKET)
   {
     /* We could probably just subscribe to all events regardless


@@ -433,13 +436,13 @@ void GSocketGUIFunctionsTableConcrete::Enable_Events(GSocket *socket)
 *  All needed parameters get passed through the thread_data structure.
 */
 
 *  All needed parameters get passed through the thread_data structure.
 */
 

-       thread_data* d = new thread_data;
-       d->lEvent = lEvent;
-       d->hEvtWin = hWin;
-       d->msgnumber = socket->m_msgnumber;
-       d->fd = socket->m_fd;
-       socketHash[socket->m_fd] = true;
-       hThread[currSocket++] = CreateThread(NULL, 0, &SocketThread,(LPVOID)d, 0, NULL);
+    thread_data* d = new thread_data;
+    d->lEvent = lEvent;
+    d->hEvtWin = hWin;
+    d->msgnumber = socket->m_msgnumber;
+    d->fd = socket->m_fd;
+    socketHash[socket->m_fd] = true;
+    hThread[currSocket++] = CreateThread(NULL, 0, &SocketThread,(LPVOID)d, 0, NULL);

 #endif
   }
 }
 #endif
   }
 }


@@ -447,27 +450,30 @@ void GSocketGUIFunctionsTableConcrete::Enable_Events(GSocket *socket)
 /* _GSocket_Disable_Events:
  *  Disable event notifications (when shutdowning the socket)
  */
 /* _GSocket_Disable_Events:
  *  Disable event notifications (when shutdowning the socket)
  */

-void GSocketGUIFunctionsTableConcrete::Disable_Events(GSocket *socket)
+void GSocketMSWManager::Disable_Events(GSocket *socket)

 {
 {

-  assert (socket != NULL);
-

   if (socket->m_fd != INVALID_SOCKET)
   {
 #ifndef __WXWINCE__
     gs_WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, 0);
 #else
   if (socket->m_fd != INVALID_SOCKET)
   {
 #ifndef __WXWINCE__
     gs_WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, 0);
 #else

-       //Destroy the thread
-       socketHash[socket->m_fd] = false;
+    //Destroy the thread
+    socketHash[socket->m_fd] = false;

 #endif
   }
 }
 
 #endif
   }
 }
 

-#else /* !wxUSE_SOCKETS */
-
-/*
- * Translation unit shouldn't be empty, so include this typedef to make the
- * compiler (VC++ 6.0, for example) happy
- */
-typedef void (*wxDummy)();
+// set the wxBase variable to point to our GSocketManager implementation
+//
+// see comments in wx/msw/apptbase.h for the explanation of why do we do it
+// like this
+static struct ManagerSetter
+{
+    ManagerSetter()
+    {
+        static GSocketMSWManager s_manager;
+        wxAppTraits::SetDefaultSocketManager(&s_manager);
+    }
+} gs_managerSetter;

 
 

-#endif  /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
+#endif  // wxUSE_SOCKETS