X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ba2a81d747036d40bb917d09c82b3562de707e99..80cc5fc7ad102221a1ce9e160eac3c29a0586664:/include/wx/unix/gsockunx.h

diff --git a/include/wx/unix/gsockunx.h b/include/wx/unix/gsockunx.h
index c73a168d5b..9fa9e77fbf 100644
--- a/include/wx/unix/gsockunx.h
+++ b/include/wx/unix/gsockunx.h
@@ -1,253 +1,212 @@
 /* -------------------------------------------------------------------------
- * Project: GSocket (Generic Socket) for WX
- * Name:    gsockunx.h
- * Purpose: GSocket Unix header
- * CVSID:   $Id$
+ * Project:     GSocket (Generic Socket) for WX
+ * Name:        gsockunx.h
+ * Copyright:   (c) Guilhem Lavaux
+ * Licence:     wxWindows Licence
+ * Purpose:     GSocket Unix header
+ * CVSID:       $Id$
  * -------------------------------------------------------------------------
  */
 
-#ifndef __GSOCK_UNX_H
-#define __GSOCK_UNX_H
+#ifndef _WX_UNIX_GSOCKUNX_H_
+#define _WX_UNIX_GSOCKUNX_H_
 
-#ifndef __GSOCKET_STANDALONE__
-#include "wx/setup.h"
-#endif
+#include <unistd.h>
 
-#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
+class wxGSocketIOHandler;
 
-#ifndef __GSOCKET_STANDALONE__
-#include "wx/gsocket.h"
-#else
-#include "gsocket.h"
-#endif
-
-#ifndef TRUE
-#define TRUE 1
-#endif
-
-#ifndef FALSE
-#define FALSE 0
-#endif
-
-#ifdef wxUSE_GSOCKET_CPLUSPLUS
-class GSocketGUIFunctionsTableConcrete: public GSocketGUIFunctionsTable
-{
-public:
-    virtual bool OnInit();
-    virtual void OnExit();
-    virtual bool CanUseEventLoop();
-    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);
-};
-#endif /* def wxUSE_GSOCKET_CPLUSPLUS */
-
-#ifdef wxUSE_GSOCKET_CPLUSPLUS
-class GSocket
+class GSocket : public GSocketBase
 {
 public:
-    GSocket();
+    GSocket(wxSocketBase& wxsocket);
     virtual ~GSocket();
-    bool IsOk() { return m_ok; }
-    void Close();
-    void Shutdown();
-    GSocketError SetLocal(GAddress *address);
-    GSocketError SetPeer(GAddress *address);
-    GAddress *GetLocal();
-    GAddress *GetPeer();
+
+    virtual void Shutdown();
+    virtual GSocket *WaitConnection(wxSocketBase& wxsocket);
+
     GSocketError SetServer();
-    GSocket *WaitConnection();
-    int SetReusable();
+    bool SetReusable();
+    bool SetBroadcast();
+    bool DontDoBind();
     GSocketError Connect(GSocketStream stream);
     GSocketError SetNonOriented();
     int Read(char *buffer, int size);
     int Write(const char *buffer, int size);
-    GSocketEventFlags Select(GSocketEventFlags flags);
-    void SetNonBlocking(int non_block);
-    void SetTimeout(unsigned long millisec);
+    void SetNonBlocking(bool non_block);
     GSocketError WXDLLIMPEXP_NET GetError();
-    void SetCallback(GSocketEventFlags flags,
-        GSocketCallback callback, char *cdata);
-    void UnsetCallback(GSocketEventFlags flags);
     GSocketError GetSockOpt(int level, int optname, void *optval, int *optlen);
     GSocketError SetSockOpt(int level, int optname,
         const void *optval, int optlen);
-    /* API compatibility functions */
-    static void _GSocket_Detected_Read(GSocket *socket);
-    static void _GSocket_Detected_Write(GSocket *socket);
-    virtual void Detected_Read();
-    virtual void Detected_Write();
-protected:
-    void Enable(GSocketEvent event);
-    void Disable(GSocketEvent event);
+    //attach or detach from main loop
+    void Notify(bool flag);
+    void Detected_Read();
+    void Detected_Write();
+
+private:
+    // enable or disable notifications for socket input/output events but only
+    // if m_use_events is true; do nothing otherwise
+    void EnableEvents()
+    {
+        if ( m_use_events )
+            DoEnableEvents(true);
+    }
+
+    void DisableEvents()
+    {
+        if ( m_use_events )
+            DoEnableEvents(false);
+    }
+
+    // really enable or disable socket input/output events, regardless of
+    // m_use_events value
+    void DoEnableEvents(bool enable);
+
+
+    // enable or disable events for the given event if m_use_events; do nothing
+    // otherwise
+    //
+    // notice that these functions also update m_detected: EnableEvent() clears
+    // the corresponding bit in it and DisableEvent() sets it
+    void EnableEvent(GSocketEvent event);
+    void DisableEvent(GSocketEvent event);
+
+
     GSocketError Input_Timeout();
     GSocketError Output_Timeout();
     int Recv_Stream(char *buffer, int size);
     int Recv_Dgram(char *buffer, int size);
     int Send_Stream(const char *buffer, int size);
     int Send_Dgram(const char *buffer, int size);
-    bool m_ok;
 public:
     /* DFE: We can't protect these data member until the GUI code is updated */
     /* protected: */
-#else /* def wxUSE_GSOCKET_CPLUSPLUS */
+  wxGSocketIOHandler *m_handler;
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-/* Definition of GSocket */
-struct _GSocket
-{
-#endif /* def wxUSE_GSOCKET_CPLUSPLUS */
-  int m_fd;
-  GAddress *m_local;
-  GAddress *m_peer;
-  GSocketError m_error;
-
-  int m_non_blocking;
-  int m_server;
-  int m_stream;
-  int m_establishing;
-  int m_reusable;
-  unsigned long m_timeout;
-
-  /* Callbacks */
-  GSocketEventFlags m_detected;
-  GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
-  char *m_data[GSOCK_MAX_EVENT];
-
-  char *m_gui_dependent;
-
-#ifndef wxUSE_GSOCKET_CPLUSPLUS
-  /* Function pointers */
-  struct GSocketBaseFunctionsTable *m_functions;
-#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
+  // true if socket should fire events
+  bool m_use_events;
+
+  // pointer for storing extra (usually GUI-specific) data
+  void *m_gui_dependent;
+
+private:
+    // notify the associated wxSocket about a change in socket state and shut
+    // down the socket if the event is GSOCK_LOST
+    void OnStateChange(GSocketEvent event);
 };
-#ifndef wxUSE_GSOCKET_CPLUSPLUS
-#ifdef __cplusplus
-}
-#endif  /* __cplusplus */
-#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-/* Definition of GAddress */
-struct _GAddress
+
+// A version of GSocketManager which uses FDs for socket IO
+//
+// This class uses GSocket::m_gui_dependent field to store the 2 (for input and
+// output) FDs associated with the socket.
+class GSocketFDBasedManager : public GSocketManager
 {
-  struct sockaddr *m_addr;
-  size_t m_len;
+public:
+    // no special initialization/cleanup needed when using FDs
+    virtual bool OnInit() { return true; }
+    virtual void OnExit() { }
+
+    // allocate/free the storage we need
+    virtual bool Init_Socket(GSocket *socket)
+    {
+        socket->m_gui_dependent = malloc(sizeof(int)*2);
+        int * const fds = static_cast<int *>(socket->m_gui_dependent);
+
+        fds[0] = -1;
+        fds[1] = -1;
+
+        return true;
+    }
+
+    virtual void Close_Socket(GSocket *socket)
+    {
+        Uninstall_Callback(socket, GSOCK_INPUT);
+        Uninstall_Callback(socket, GSOCK_OUTPUT);
 
-  GAddressType m_family;
-  int m_realfamily;
+        close(socket->m_fd);
+    }
 
-  GSocketError m_error;
+    virtual void Destroy_Socket(GSocket *socket)
+    {
+        free(socket->m_gui_dependent);
+    }
+
+protected:
+    // identifies either input or output direction
+    //
+    // NB: the values of this enum shouldn't change
+    enum SocketDir
+    {
+        FD_INPUT,
+        FD_OUTPUT
+    };
+
+    // get the FD index corresponding to the given GSocketEvent
+    SocketDir GetDirForEvent(GSocket *socket, GSocketEvent event)
+    {
+        switch ( event )
+        {
+            default:
+                wxFAIL_MSG( "unexpected socket event" );
+                // fall through
+
+            case GSOCK_LOST:
+                // fall through
+
+            case GSOCK_INPUT:
+                return FD_INPUT;
+
+            case GSOCK_OUTPUT:
+                return FD_OUTPUT;
+
+            case GSOCK_CONNECTION:
+                // FIXME: explain this?
+                return socket->m_server ? FD_INPUT : FD_OUTPUT;
+        }
+    }
+
+    // access the FDs we store
+    int& FD(GSocket *socket, SocketDir d)
+    {
+        return static_cast<int *>(socket->m_gui_dependent)[d];
+    }
 };
-#ifdef __cplusplus
-}
-#endif  /* __cplusplus */
-
-/* Compatibility methods to support old C API (from gsocket.h) */
-#ifdef wxUSE_GSOCKET_CPLUSPLUS
-inline void GSocket_Shutdown(GSocket *socket)
-{   socket->Shutdown(); }
-inline GSocketError GSocket_SetLocal(GSocket *socket, GAddress *address)
-{   return socket->SetLocal(address); }
-inline GSocketError GSocket_SetPeer(GSocket *socket, GAddress *address)
-{   return socket->SetPeer(address); }
-inline GAddress *GSocket_GetLocal(GSocket *socket)
-{   return socket->GetLocal(); }
-inline GAddress *GSocket_GetPeer(GSocket *socket)
-{   return socket->GetPeer(); }
-inline GSocketError GSocket_SetServer(GSocket *socket)
-{   return socket->SetServer(); }
-inline GSocket *GSocket_WaitConnection(GSocket *socket)
-{   return socket->WaitConnection(); }
-inline int GSocket_SetReusable(GSocket *socket)
-{   return socket->SetReusable(); }
-inline GSocketError GSocket_Connect(GSocket *socket, GSocketStream stream)
-{   return socket->Connect(stream); }
-inline GSocketError GSocket_SetNonOriented(GSocket *socket)
-{   return socket->SetNonOriented(); }
-inline int GSocket_Read(GSocket *socket, char *buffer, int size)
-{   return socket->Read(buffer,size); }
-inline int GSocket_Write(GSocket *socket, const char *buffer, int size)
-{   return socket->Write(buffer,size); }
-inline GSocketEventFlags GSocket_Select(GSocket *socket, GSocketEventFlags flags)
-{   return socket->Select(flags); }
-inline void GSocket_SetNonBlocking(GSocket *socket, int non_block)
-{   socket->SetNonBlocking(non_block); }
-inline void GSocket_SetTimeout(GSocket *socket, unsigned long millisec)
-{   socket->SetTimeout(millisec); }
-inline GSocketError GSocket_GetError(GSocket *socket)
-{   return socket->GetError(); }
-inline void GSocket_SetCallback(GSocket *socket, GSocketEventFlags flags,
-                         GSocketCallback fallback, char *cdata)
-{   socket->SetCallback(flags,fallback,cdata); }
-inline void GSocket_UnsetCallback(GSocket *socket, GSocketEventFlags flags)
-{   socket->UnsetCallback(flags); }
-inline GSocketError GSocket_GetSockOpt(GSocket *socket, int level, int optname,
-                        void *optval, int *optlen)
-{   return socket->GetSockOpt(level,optname,optval,optlen); }
-inline GSocketError GSocket_SetSockOpt(GSocket *socket, int level, int optname,
-                        const void *optval, int optlen)
-{   return socket->SetSockOpt(level,optname,optval,optlen); }
-inline void GSocket_destroy(GSocket *socket)
-{   delete socket; }
-
-#endif /* def wxUSE_GSOCKET_CPLUSPLUS */
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
-/* Input / Output */
-
-GSocketError _GSocket_Input_Timeout(GSocket *socket);
-GSocketError _GSocket_Output_Timeout(GSocket *socket);
-int _GSocket_Recv_Stream(GSocket *socket, char *buffer, int size);
-int _GSocket_Recv_Dgram(GSocket *socket, char *buffer, int size);
-int _GSocket_Send_Stream(GSocket *socket, const char *buffer, int size);
-int _GSocket_Send_Dgram(GSocket *socket, const char *buffer, int size);
-
-/* Callbacks */
-
-int  _GSocket_GUI_Init(void);
-void _GSocket_GUI_Cleanup(void);
-
-int  _GSocket_GUI_Init_Socket(GSocket *socket);
-void _GSocket_GUI_Destroy_Socket(GSocket *socket);
-
-void _GSocket_Enable_Events(GSocket *socket);
-void _GSocket_Disable_Events(GSocket *socket);
-void _GSocket_Install_Callback(GSocket *socket, GSocketEvent event);
-void _GSocket_Uninstall_Callback(GSocket *socket, GSocketEvent event);
-
-void _GSocket_Enable(GSocket *socket, GSocketEvent event);
-void _GSocket_Disable(GSocket *socket, GSocketEvent event);
-
-#ifndef wxUSE_GSOCKET_CPLUSPLUS
-void _GSocket_Detected_Read(GSocket *socket);
-void _GSocket_Detected_Write(GSocket *socket);
-#endif /* ndef wxUSE_GSOCKET_CPLUSPLUS */
-
-/* GAddress */
-
-GSocketError _GAddress_translate_from(GAddress *address,
-                                      struct sockaddr *addr, int len);
-GSocketError _GAddress_translate_to  (GAddress *address,
-                                      struct sockaddr **addr, int *len);
-GSocketError _GAddress_Init_INET(GAddress *address);
-GSocketError _GAddress_Init_UNIX(GAddress *address);
-
-
-#ifdef __cplusplus
-}
-#endif  /* __cplusplus */
-
-#endif  /* wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__) */
-
-#endif  /* __GSOCK_UNX_H */
+
+// Common base class for all ports using X11-like (and hence implemented in
+// X11, Motif and GTK) AddInput() and RemoveInput() functions
+class GSocketInputBasedManager : public GSocketFDBasedManager
+{
+public:
+    virtual void Install_Callback(GSocket *socket, GSocketEvent event)
+    {
+        wxCHECK_RET( socket->m_fd != -1,
+                        "shouldn't be called on invalid socket" );
+
+        const SocketDir d = GetDirForEvent(socket, event);
+
+        int& fd = FD(socket, d);
+        if ( fd != -1 )
+            RemoveInput(fd);
+
+        fd = AddInput(socket, d);
+    }
+
+    virtual void Uninstall_Callback(GSocket *socket, GSocketEvent event)
+    {
+        const SocketDir d = GetDirForEvent(socket, event);
+
+        int& fd = FD(socket, d);
+        if ( fd != -1 )
+        {
+            RemoveInput(fd);
+            fd = -1;
+        }
+    }
+
+private:
+    // these functions map directly to XtAdd/RemoveInput() or
+    // gdk_input_add/remove()
+    virtual int AddInput(GSocket *socket, SocketDir d) = 0;
+    virtual void RemoveInput(int fd) = 0;
+};
+
+#endif  /* _WX_UNIX_GSOCKUNX_H_ */