Added SQLTCHAR for non-Windows platforms, and added missing

[wxWidgets.git] / src / common / socket.cpp

diff --git a/src/common/socket.cpp b/src/common/socket.cpp
index 003bd9dbcfb3afccda8e45f3cf037ae82951ccc5..f6d8b24360013c1889208513e2e4712bbbfcac7b 100644 (file)
--- a/src/common/socket.cpp
+++ b/src/common/socket.cpp
@@ -6,14 +6,14 @@
 // Copyright:  (C) 1999-1997, Guilhem Lavaux
 //             (C) 2000-1999, Guillermo Rodriguez Garcia
 // RCS_ID:     $Id$
 // Copyright:  (C) 1999-1997, Guilhem Lavaux
 //             (C) 2000-1999, Guillermo Rodriguez Garcia
 // RCS_ID:     $Id$

-// License:    see wxWindows license
+// License:    see wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ==========================================================================
 // Declarations
 // ==========================================================================
 
 /////////////////////////////////////////////////////////////////////////////
 
 // ==========================================================================
 // Declarations
 // ==========================================================================
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma implementation "socket.h"
 #endif
 
 #pragma implementation "socket.h"
 #endif
 


@@ -27,6 +27,7 @@
 #if wxUSE_SOCKETS
 
 #include "wx/app.h"
 #if wxUSE_SOCKETS
 
 #include "wx/app.h"

+#include "wx/apptrait.h"

 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"


@@ -37,13 +38,13 @@
 #include "wx/intl.h"
 #include "wx/event.h"
 
 #include "wx/intl.h"
 #include "wx/event.h"
 

-#if wxUSE_GUI
-  #include "wx/gdicmn.h"      // for wxPendingDelete
-#endif // wxUSE_GUI
-

 #include "wx/sckaddr.h"
 #include "wx/socket.h"
 
 #include "wx/sckaddr.h"
 #include "wx/socket.h"
 

+// DLL options compatibility check:
+#include "wx/build.h"
+WX_CHECK_BUILD_OPTIONS("wxNet")
+

 // --------------------------------------------------------------------------
 // macros and constants
 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------
 // macros and constants
 // --------------------------------------------------------------------------


@@ -51,30 +52,26 @@
 // discard buffer
 #define MAX_DISCARD_SIZE (10 * 1024)
 
 // discard buffer
 #define MAX_DISCARD_SIZE (10 * 1024)
 

-// what to do within waits: in wxBase we don't do anything as we don't have
-// the event loop anyhow (for now). In GUI apps we have 2 cases: from the main
-// thread itself we have to call wxYield() to let the events (including the
-// GUI events and the low-level (not wxWindows) events from GSocket) be
-// processed. From another thread it is enough to just call wxThread::Yield()
-// which will give away the rest of our time slice: the explanation is that
-// the events will be processed by the main thread anyhow, without calling
-// wxYield(), but we don't want to eat the CPU time uselessly while sitting
-// in the loop waiting for the data
-#if wxUSE_GUI
-    #if wxUSE_THREADS
-        #define PROCESS_EVENTS()        \
-        {                               \
-            if ( wxThread::IsMain() )   \
-                wxYield();              \
-            else                        \
-                wxThread::Yield();      \
-        }
-    #else // !wxUSE_THREADS
-        #define PROCESS_EVENTS() wxYield()
-    #endif // wxUSE_THREADS/!wxUSE_THREADS
-#else // !wxUSE_GUI
-    #define PROCESS_EVENTS()
-#endif // wxUSE_GUI/!wxUSE_GUI
+// what to do within waits: we have 2 cases: from the main thread itself we
+// have to call wxYield() to let the events (including the GUI events and the
+// low-level (not wxWindows) events from GSocket) be processed. From another
+// thread it is enough to just call wxThread::Yield() which will give away the
+// rest of our time slice: the explanation is that the events will be processed
+// by the main thread anyhow, without calling wxYield(), but we don't want to
+// eat the CPU time uselessly while sitting in the loop waiting for the data
+#if wxUSE_THREADS
+    #define PROCESS_EVENTS()        \
+    {                               \
+        if ( wxThread::IsMain() )   \
+            wxYield();              \
+        else                        \
+            wxThread::Yield();      \
+    }
+#else // !wxUSE_THREADS
+    #define PROCESS_EVENTS() wxYield()
+#endif // wxUSE_THREADS/!wxUSE_THREADS
+
+#define wxTRACE_Socket _T("wxSocket")

 
 // --------------------------------------------------------------------------
 // wxWin macros
 
 // --------------------------------------------------------------------------
 // wxWin macros


@@ -97,19 +94,61 @@ public:
   wxSocketEventFlags       m_eventmask;
   bool                     m_notify;
   void                    *m_clientData;
   wxSocketEventFlags       m_eventmask;
   bool                     m_notify;
   void                    *m_clientData;

-#if WXWIN_COMPATIBILITY
-  wxSocketBase::wxSockCbk  m_cbk;
-  char                    *m_cdata;
-#endif // WXWIN_COMPATIBILITY

 
 public:
   wxSocketState() : wxObject() {}
 
 public:
   wxSocketState() : wxObject() {}

+
+    DECLARE_NO_COPY_CLASS(wxSocketState)

 };
 
 // ==========================================================================
 // wxSocketBase
 // ==========================================================================
 
 };
 
 // ==========================================================================
 // wxSocketBase
 // ==========================================================================
 

+// --------------------------------------------------------------------------
+// Initialization and shutdown
+// --------------------------------------------------------------------------
+
+// FIXME-MT: all this is MT-unsafe, of course, we should protect all accesses
+//           to m_countInit with a crit section
+size_t wxSocketBase::m_countInit = 0;
+
+bool wxSocketBase::IsInitialized()
+{
+    return m_countInit > 0;
+}
+
+bool wxSocketBase::Initialize()
+{
+    if ( !m_countInit++ )
+    {
+        wxAppTraits *traits = wxAppConsole::GetInstance() ?
+                              wxAppConsole::GetInstance()->GetTraits() : NULL;
+        GSocketGUIFunctionsTable *functions = 
+            traits ? traits->GetSocketGUIFunctionsTable() : NULL;
+        GSocket_SetGUIFunctions(functions);
+        
+        if ( !GSocket_Init() )
+        {
+            m_countInit--;
+
+            return FALSE;
+        }
+    }
+
+    return TRUE;
+}
+
+void wxSocketBase::Shutdown()
+{
+    // we should be initialized
+    wxASSERT_MSG( m_countInit, _T("extra call to Shutdown()") );
+    if ( !--m_countInit )
+    {
+        GSocket_Cleanup();
+    }
+}
+

 // --------------------------------------------------------------------------
 // Ctor and dtor
 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------
 // Ctor and dtor
 // --------------------------------------------------------------------------


@@ -141,10 +180,13 @@ void wxSocketBase::Init()
   m_clientData   = NULL;
   m_notify       = FALSE;
   m_eventmask    = 0;
   m_clientData   = NULL;
   m_notify       = FALSE;
   m_eventmask    = 0;

-#if WXWIN_COMPATIBILITY
-  m_cbk          = NULL;
-  m_cdata        = NULL;
-#endif // WXWIN_COMPATIBILITY
+
+  if ( !IsInitialized() )
+  {
+      // this Initialize() will be undone by wxSocketModule::OnExit(), all the
+      // other calls to it should be matched by a call to Shutdown()
+      Initialize();
+  }

 }
 
 wxSocketBase::wxSocketBase()
 }
 
 wxSocketBase::wxSocketBase()


@@ -164,9 +206,9 @@ wxSocketBase::~wxSocketBase()
 {
   // Just in case the app called Destroy() *and* then deleted
   // the socket immediately: don't leave dangling pointers.
 {
   // Just in case the app called Destroy() *and* then deleted
   // the socket immediately: don't leave dangling pointers.

-#if wxUSE_GUI
-  wxPendingDelete.DeleteObject(this);
-#endif
+  wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+  if ( traits )
+      traits->RemoveFromPendingDelete(this);

 
   // Shutdown and close the socket
   if (!m_beingDeleted)
 
   // Shutdown and close the socket
   if (!m_beingDeleted)


@@ -194,12 +236,18 @@ bool wxSocketBase::Destroy()
   // Supress events from now on
   Notify(FALSE);
 
   // Supress events from now on
   Notify(FALSE);
 

-#if wxUSE_GUI
-  if ( !wxPendingDelete.Member(this) )
-    wxPendingDelete.Append(this);
-#else
-  delete this;
-#endif
+  // schedule this object for deletion
+  wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+  if ( traits )
+  {
+      // let the traits object decide what to do with us
+      traits->ScheduleForDestroy(this);
+  }
+  else // no app or no traits
+  {
+      // in wxBase we might have no app object at all, don't leak memory
+      delete this;
+  }

 
   return TRUE;
 }
 
   return TRUE;
 }


@@ -510,7 +558,6 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
 {
   wxUint32 total;
   bool error;
 {
   wxUint32 total;
   bool error;

-  int old_flags;

   struct
   {
     unsigned char sig[4];
   struct
   {
     unsigned char sig[4];


@@ -522,7 +569,6 @@ wxSocketBase& wxSocketBase::WriteMsg(const void *buffer, wxUint32 nbytes)
 
   error = TRUE;
   total = 0;
 
   error = TRUE;
   total = 0;

-  old_flags = m_flags;

   SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
 
   msg.sig[0] = (unsigned char) 0xad;
   SetFlags((m_flags & wxSOCKET_BLOCK) | wxSOCKET_WAITALL);
 
   msg.sig[0] = (unsigned char) 0xad;


@@ -576,7 +622,6 @@ wxSocketBase& wxSocketBase::Unread(const void *buffer, wxUint32 nbytes)
 
 wxSocketBase& wxSocketBase::Discard()
 {
 
 wxSocketBase& wxSocketBase::Discard()
 {

-  int old_flags;

   char *buffer = new char[MAX_DISCARD_SIZE];
   wxUint32 ret;
   wxUint32 total = 0;
   char *buffer = new char[MAX_DISCARD_SIZE];
   wxUint32 ret;
   wxUint32 total = 0;


@@ -584,7 +629,6 @@ wxSocketBase& wxSocketBase::Discard()
   // Mask read events
   m_reading = TRUE;
 
   // Mask read events
   m_reading = TRUE;
 

-  old_flags = m_flags;

   SetFlags(wxSOCKET_NOWAIT);
 
   do
   SetFlags(wxSOCKET_NOWAIT);
 
   do


@@ -732,6 +776,12 @@ bool wxSocketBase::GetPeer(wxSockAddress& addr_man) const
     return FALSE;
 
   peer = GSocket_GetPeer(m_socket);
     return FALSE;
 
   peer = GSocket_GetPeer(m_socket);

+
+    // copying a null address would just trigger an assert anyway
+
+  if (!peer)
+    return FALSE;
+

   addr_man.SetAddress(peer);
   GAddress_destroy(peer);
 
   addr_man.SetAddress(peer);
   GAddress_destroy(peer);
 


@@ -766,35 +816,27 @@ void wxSocketBase::SaveState()
   state->m_notify     = m_notify;
   state->m_eventmask  = m_eventmask;
   state->m_clientData = m_clientData;
   state->m_notify     = m_notify;
   state->m_eventmask  = m_eventmask;
   state->m_clientData = m_clientData;

-#if WXWIN_COMPATIBILITY
-  state->m_cbk        = m_cbk;
-  state->m_cdata      = m_cdata;
-#endif // WXWIN_COMPATIBILITY

 
   m_states.Append(state);
 }
 
 void wxSocketBase::RestoreState()
 {
 
   m_states.Append(state);
 }
 
 void wxSocketBase::RestoreState()
 {

-  wxNode *node;
+  wxList::compatibility_iterator node;

   wxSocketState *state;
 
   wxSocketState *state;
 

-  node = m_states.Last();
+  node = m_states.GetLast();

   if (!node)
     return;
 
   if (!node)
     return;
 

-  state = (wxSocketState *)node->Data();
+  state = (wxSocketState *)node->GetData();

 
   m_flags      = state->m_flags;
   m_notify     = state->m_notify;
   m_eventmask  = state->m_eventmask;
   m_clientData = state->m_clientData;
 
   m_flags      = state->m_flags;
   m_notify     = state->m_notify;
   m_eventmask  = state->m_eventmask;
   m_clientData = state->m_clientData;

-#if WXWIN_COMPATIBILITY
-  m_cbk        = state->m_cbk;
-  m_cdata      = state->m_cdata;
-#endif // WXWIN_COMPATIBILITY
-
-  delete node;
+  
+  m_states.Erase(node);

   delete state;
 }
 
   delete state;
 }
 


@@ -816,30 +858,6 @@ void wxSocketBase::SetFlags(wxSocketFlags flags)
 }
 
 
 }
 
 

-// --------------------------------------------------------------------------
-// Callbacks (now obsolete - use events instead)
-// --------------------------------------------------------------------------
-
-#if WXWIN_COMPATIBILITY
-
-wxSocketBase::wxSockCbk wxSocketBase::Callback(wxSockCbk cbk_)
-{
-  wxSockCbk old_cbk = cbk_;
-
-  m_cbk = cbk_;
-  return old_cbk;
-}
-
-char *wxSocketBase::CallbackData(char *data)
-{
-  char *old_data = m_cdata;
-
-  m_cdata = data;
-  return old_data;
-}
-
-#endif // WXWIN_COMPATIBILITY
-

 // --------------------------------------------------------------------------
 // Event handling
 // --------------------------------------------------------------------------
 // --------------------------------------------------------------------------
 // Event handling
 // --------------------------------------------------------------------------


@@ -862,9 +880,10 @@ char *wxSocketBase::CallbackData(char *data)
 // decoupled from wx_socket_callback and thus they suffer from a variety
 // of problems. Avoid them where possible and use events instead.
 
 // decoupled from wx_socket_callback and thus they suffer from a variety
 // of problems. Avoid them where possible and use events instead.
 

-static void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
-                                           GSocketEvent notification,
-                                           char *cdata)
+extern "C"
+void LINKAGEMODE wx_socket_callback(GSocket * WXUNUSED(socket),
+                                    GSocketEvent notification,
+                                    char *cdata)

 {
   wxSocketBase *sckobj = (wxSocketBase *)cdata;
 
 {
   wxSocketBase *sckobj = (wxSocketBase *)cdata;
 


@@ -933,11 +952,6 @@ void wxSocketBase::OnRequest(wxSocketNotify notification)
 
       m_handler->AddPendingEvent(event);
     }
 
       m_handler->AddPendingEvent(event);
     }

-
-#if WXWIN_COMPATIBILITY
-    if (m_cbk)
-      m_cbk(*this, notification, m_cdata);
-#endif // WXWIN_COMPATIBILITY

   }
 }
 
   }
 }
 


@@ -1021,26 +1035,32 @@ wxSocketServer::wxSocketServer(wxSockAddress& addr_man,
                                wxSocketFlags flags)
               : wxSocketBase(flags, wxSOCKET_SERVER)
 {
                                wxSocketFlags flags)
               : wxSocketBase(flags, wxSOCKET_SERVER)
 {

-  // Create the socket
-  m_socket = GSocket_new();
+    wxLogTrace( wxTRACE_Socket, _T("Opening wxSocketServer") );

 
 

-  if (!m_socket)
-    return;
+    m_socket = GSocket_new();

 
 

-  // Setup the socket as server
-  GSocket_SetLocal(m_socket, addr_man.GetAddress());
-  if (GSocket_SetServer(m_socket) != GSOCK_NOERROR)
-  {
-    GSocket_destroy(m_socket);
-    m_socket = NULL;
-    return;
-  }
+    if (!m_socket)
+    {
+        wxLogTrace( wxTRACE_Socket, _T("*** GSocket_new failed") );
+        return;
+    }

 
 

-  GSocket_SetTimeout(m_socket, m_timeout * 1000);
-  GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
-                                GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
-                                wx_socket_callback, (char *)this);
+        // Setup the socket as server
+
+    GSocket_SetLocal(m_socket, addr_man.GetAddress());
+    if (GSocket_SetServer(m_socket) != GSOCK_NOERROR)
+    {
+        GSocket_destroy(m_socket);
+        m_socket = NULL;
+
+        wxLogTrace( wxTRACE_Socket, _T("*** GSocket_SetServer failed") );
+        return;
+    }

 
 

+    GSocket_SetTimeout(m_socket, m_timeout * 1000);
+    GSocket_SetCallback(m_socket, GSOCK_INPUT_FLAG | GSOCK_OUTPUT_FLAG |
+                                  GSOCK_LOST_FLAG | GSOCK_CONNECTION_FLAG,
+                                  wx_socket_callback, (char *)this);

 }
 
 // --------------------------------------------------------------------------
 }
 
 // --------------------------------------------------------------------------


@@ -1239,16 +1259,28 @@ wxDatagramSocket& wxDatagramSocket::SendTo( wxSockAddress& addr,
 // wxSocketModule
 // ==========================================================================
 
 // wxSocketModule
 // ==========================================================================
 

-class WXDLLEXPORT wxSocketModule : public wxModule
+class wxSocketModule : public wxModule

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxSocketModule)
-

 public:
 public:

-  bool OnInit() { return GSocket_Init() != 0; }
-  void OnExit() { GSocket_Cleanup(); }
+    virtual bool OnInit()
+    {
+        // wxSocketBase will call GSocket_Init() itself when/if needed
+        return TRUE;
+    }
+
+    virtual void OnExit()
+    {
+        if ( wxSocketBase::IsInitialized() )
+            wxSocketBase::Shutdown();
+    }
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxSocketModule)

 };
 
 IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
 
 #endif
   // wxUSE_SOCKETS
 };
 
 IMPLEMENT_DYNAMIC_CLASS(wxSocketModule, wxModule)
 
 #endif
   // wxUSE_SOCKETS

+
+// vi:sts=4:sw=4:et