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 a51169eaf0e79686a730aa600854cee8b345ed83..3ca8b48349e4ae395c8d6f798741eca4b3bbdc03 100644 (file)
--- a/src/msw/gsockmsw.cpp
+++ b/src/msw/gsockmsw.cpp
@@ -1,22 +1,31 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * Project: GSocket (Generic Socket)
- * Name:    gsockmsw.c
- * 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$

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

+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
+
+#ifdef __BORLANDC__
+    #pragma hdrstop
+#endif
+
+#if wxUSE_SOCKETS
+

 /*
 /*

- * TODO: for WinCE we need to replace WSAAsyncSelect
+ * DONE: for WinCE we need to replace WSAAsyncSelect

  * (Windows message-based notification of network events for a socket)
  * with another mechanism.
  * (Windows message-based notification of network events for a socket)
  * with another mechanism.

- * We may need to have a separate thread that polls for socket events
- * using select() and sends a message to the main thread.
- */
-
-/*
- * PLEASE don't put C++ comments here - this is a C source file.
+ * As WSAAsyncSelect is not present on WinCE, it now uses
+ * WSACreateEvent, WSAEventSelect, WSAWaitForMultipleEvents and WSAEnumNetworkEvents.
+ * When enabling eventhandling for a socket a new thread it created that keeps track of the events
+ * and posts a messageto the hidden window to use the standard message loop.

  */
 
 /* including rasasync.h (included from windows.h itself included from
  */
 
 /* including rasasync.h (included from windows.h itself included from


@@ -24,51 +33,23 @@
  * RPCNOTIFICATION_ROUTINE
  */
 #ifdef _MSC_VER
  * RPCNOTIFICATION_ROUTINE
  */
 #ifdef _MSC_VER

-#  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__
-#include <windows.h>
+#   pragma warning(disable:4115) /* named type definition in parentheses */

 #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"

 
 

-HINSTANCE wxGetInstance(void);
-#define INSTANCE wxGetInstance()
+wxFORCE_LINK_THIS_MODULE(gsockmsw)

 
 

-#else
-
-#include "gsockmsw.h"
-#include "gsocket.h"
-
-/* If not using wxWindows, a global var called hInst must
- * be available and it must contain the app's instance
- * handle.
- */
-#define INSTANCE hInst
-
-#endif /* __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"
+WX_DECLARE_HASH_MAP(int,bool,wxIntegerHash,wxIntegerEqual,SocketHash);

 #endif
 
 #include <string.h>
 #endif
 
 #include <string.h>


@@ -86,7 +67,7 @@ HINSTANCE wxGetInstance(void);
 #define CLASSNAME  TEXT("_GSocket_Internal_Window_Class")
 
 /* implemented in utils.cpp */
 #define CLASSNAME  TEXT("_GSocket_Internal_Window_Class")
 
 /* implemented in utils.cpp */

-extern WXDLLIMPEXP_BASE HWND
+extern "C" WXDLLIMPEXP_BASE HWND

 wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
 
 /* Maximum number of different GSocket objects at a given time.
 wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
 
 /* Maximum number of different GSocket objects at a given time.


@@ -99,18 +80,123 @@ wxCreateHiddenWindow(LPCTSTR *pclassname, LPCTSTR classname, WNDPROC wndproc);
 #error "MAXSOCKETS is too big!"
 #endif
 
 #error "MAXSOCKETS is too big!"
 #endif
 

+#ifndef __WXWINCE__
+typedef int (PASCAL *WSAAsyncSelectFunc)(SOCKET,HWND,u_int,long);
+#else
+/* Typedef the needed function prototypes and the WSANETWORKEVENTS structure
+*/
+typedef struct _WSANETWORKEVENTS {
+       long lNetworkEvents;
+       int iErrorCode[10];
+} WSANETWORKEVENTS, FAR * LPWSANETWORKEVENTS;
+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);
+#endif //__WXWINCE__
+
+LRESULT CALLBACK _GSocket_Internal_WinProc(HWND, UINT, WPARAM, LPARAM);

 
 /* Global variables */
 
 
 /* Global variables */
 

-extern HINSTANCE INSTANCE;

 static HWND hWin;
 static CRITICAL_SECTION critical;
 static GSocket* socketList[MAXSOCKETS];
 static int firstAvailable;
 
 static HWND hWin;
 static CRITICAL_SECTION critical;
 static GSocket* socketList[MAXSOCKETS];
 static int firstAvailable;
 

+#ifndef __WXWINCE__
+static WSAAsyncSelectFunc gs_WSAAsyncSelect = NULL;
+#else
+static SocketHash socketHash;
+static unsigned int currSocket;
+HANDLE hThread[MAXSOCKETS];
+static WSACreateEventFunc gs_WSACreateEvent = NULL;
+static WSAEventSelectFunc gs_WSAEventSelect = NULL;
+static WSAWaitForMultipleEventsFunc gs_WSAWaitForMultipleEvents = NULL;
+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{
+    HWND hEvtWin;
+    unsigned long msgnumber;
+    unsigned long fd;
+    unsigned long lEvent;
+}thread_data;
+#endif
+
+static HMODULE gs_wsock32dll = 0;
+
+
+#ifdef __WXWINCE__
+/* This thread handles socket events on WinCE using WSAEventSelect() as WSAAsyncSelect is not supported.
+*  When an event occures for the socket, it is checked what kind of event happend and the correct message gets posted
+*  so that the hidden window can handle it as it would in other MSW builds.
+*/
+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;
+}
+#endif
+
+// ----------------------------------------------------------------------------
+// MSW implementation of GSocketManager
+// ----------------------------------------------------------------------------
+
+class GSocketMSWManager : public GSocketManager
+{
+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 */
 

-int _GSocket_GUI_Init(void)
+bool GSocketMSWManager::OnInit()

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


@@ -118,7 +204,7 @@ int _GSocket_GUI_Init(void)
   /* Create internal window for event notifications */
   hWin = wxCreateHiddenWindow(&pclassname, CLASSNAME, _GSocket_Internal_WinProc);
   if (!hWin)
   /* Create internal window for event notifications */
   hWin = wxCreateHiddenWindow(&pclassname, CLASSNAME, _GSocket_Internal_WinProc);
   if (!hWin)

-      return FALSE;
+      return false;

 
   /* Initialize socket list */
   InitializeCriticalSection(&critical);
 
   /* Initialize socket list */
   InitializeCriticalSection(&critical);


@@ -129,22 +215,74 @@ int _GSocket_GUI_Init(void)
   }
   firstAvailable = 0;
 
   }
   firstAvailable = 0;
 

-  return TRUE;
+  /* Load WSAAsyncSelect from wsock32.dll (we don't link against it
+     statically to avoid dependency on wsock32.dll for apps that don't use
+     sockets): */
+#ifndef __WXWINCE__
+  gs_wsock32dll = LoadLibrary(wxT("wsock32.dll"));
+  if (!gs_wsock32dll)
+      return false;
+  gs_WSAAsyncSelect =(WSAAsyncSelectFunc)GetProcAddress(gs_wsock32dll,
+                                                        "WSAAsyncSelect");
+  if (!gs_WSAAsyncSelect)
+      return false;
+#else
+/*  On WinCE we load ws2.dll which will provide the needed functions.
+*/
+  gs_wsock32dll = LoadLibrary(wxT("ws2.dll"));
+  if (!gs_wsock32dll)
+      return false;
+  gs_WSAEventSelect =(WSAEventSelectFunc)GetProcAddress(gs_wsock32dll,
+                                                        wxT("WSAEventSelect"));
+  if (!gs_WSAEventSelect)
+      return false;
+
+  gs_WSACreateEvent =(WSACreateEventFunc)GetProcAddress(gs_wsock32dll,
+                                                        wxT("WSACreateEvent"));
+  if (!gs_WSACreateEvent)
+      return false;
+
+  gs_WSAWaitForMultipleEvents =(WSAWaitForMultipleEventsFunc)GetProcAddress(gs_wsock32dll,
+                                                                            wxT("WSAWaitForMultipleEvents"));
+  if (!gs_WSAWaitForMultipleEvents)
+      return false;
+
+  gs_WSAEnumNetworkEvents =(WSAEnumNetworkEventsFunc)GetProcAddress(gs_wsock32dll,
+                                                                    wxT("WSAEnumNetworkEvents"));
+  if (!gs_WSAEnumNetworkEvents)
+      return false;
+
+  currSocket = 0;
+#endif
+
+  return true;

 }
 
 }
 

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

 {
 {

+#ifdef __WXWINCE__
+/* Delete the threads here */
+    for(unsigned int i=0; i < currSocket; i++)
+        CloseHandle(hThread[i]);
+#endif

   /* Destroy internal window */
   DestroyWindow(hWin);
   UnregisterClass(CLASSNAME, INSTANCE);
 
   /* Destroy internal window */
   DestroyWindow(hWin);
   UnregisterClass(CLASSNAME, INSTANCE);
 

+  /* Unlock wsock32.dll */
+  if (gs_wsock32dll)
+  {
+      FreeLibrary(gs_wsock32dll);
+      gs_wsock32dll = 0;
+  }
+

   /* Delete critical section */
   DeleteCriticalSection(&critical);
 }
 
 /* Per-socket GUI initialization / cleanup */
 
   /* Delete critical section */
   DeleteCriticalSection(&critical);
 }
 
 /* Per-socket GUI initialization / cleanup */
 

-int _GSocket_GUI_Init_Socket(GSocket *socket)
+bool GSocketMSWManager::Init_Socket(GSocket *socket)

 {
   int i;
 
 {
   int i;
 


@@ -159,7 +297,7 @@ int _GSocket_GUI_Init_Socket(GSocket *socket)
     if (i == firstAvailable)    /* abort! */
     {
       LeaveCriticalSection(&critical);
     if (i == firstAvailable)    /* abort! */
     {
       LeaveCriticalSection(&critical);

-      return FALSE;
+      return false;

     }
   }
   socketList[i] = socket;
     }
   }
   socketList[i] = socket;


@@ -168,17 +306,43 @@ int _GSocket_GUI_Init_Socket(GSocket *socket)
 
   LeaveCriticalSection(&critical);
 
 
   LeaveCriticalSection(&critical);
 

-  return TRUE;
+  return true;

 }
 
 }
 

-void _GSocket_GUI_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,


@@ -203,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)
       {


@@ -255,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 _GSocket_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


@@ -266,30 +428,52 @@ void _GSocket_Enable_Events(GSocket *socket)
      */
     long lEvent = socket->m_server?
                   FD_ACCEPT : (FD_READ | FD_WRITE | FD_CONNECT | FD_CLOSE);
      */
     long lEvent = socket->m_server?
                   FD_ACCEPT : (FD_READ | FD_WRITE | FD_CONNECT | FD_CLOSE);

-
-    WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, lEvent);
+#ifndef __WXWINCE__
+    gs_WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, lEvent);
+#else
+/*
+*  WinCE creates a thread for socket event handling.
+*  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);
+#endif

   }
 }
 
 /* _GSocket_Disable_Events:
  *  Disable event notifications (when shutdowning the socket)
  */
   }
 }
 
 /* _GSocket_Disable_Events:
  *  Disable event notifications (when shutdowning the socket)
  */

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

 {
 {

-  assert (socket != NULL);
-

   if (socket->m_fd != INVALID_SOCKET)
   {
   if (socket->m_fd != INVALID_SOCKET)
   {

-    WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, 0);
+#ifndef __WXWINCE__
+    gs_WSAAsyncSelect(socket->m_fd, hWin, socket->m_msgnumber, 0);
+#else
+    //Destroy the thread
+    socketHash[socket->m_fd] = false;
+#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