don't duplicate base class m_acceleratorTable as m_accelTable in wxMenuBar, this...

[wxWidgets.git] / include / wx / unix / gsockunx.h

diff --git a/include/wx/unix/gsockunx.h b/include/wx/unix/gsockunx.h
index ed3640f507a10d5424ffc740e07a6091279bdb88..1c59a3f65c6749a2e7a013a6aa140b147133d680 100644 (file)
--- a/include/wx/unix/gsockunx.h
+++ b/include/wx/unix/gsockunx.h
@@ -1,47 +1,17 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * 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
-
-#if wxUSE_SOCKETS || defined(__GSOCKET_STANDALONE__)
-
-#ifndef __GSOCKET_STANDALONE__
-#include "wx/gsocket.h"
-#else
-#include "gsocket.h"
-#endif
-
-#ifndef TRUE
-#define TRUE 1
-#endif
-
-#ifndef FALSE
-#define FALSE 0
-#endif
-
-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);
-};
+class wxGSocketIOHandler;

 
 class GSocket
 {
 
 class GSocket
 {


@@ -57,13 +27,15 @@ public:
     GAddress *GetPeer();
     GSocketError SetServer();
     GSocket *WaitConnection();
     GAddress *GetPeer();
     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);
     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 SetNonBlocking(bool non_block);

     void SetTimeout(unsigned long millisec);
     GSocketError WXDLLIMPEXP_NET GetError();
     void SetCallback(GSocketEventFlags flags,
     void SetTimeout(unsigned long millisec);
     GSocketError WXDLLIMPEXP_NET GetError();
     void SetCallback(GSocketEventFlags flags,


@@ -72,12 +44,20 @@ public:
     GSocketError GetSockOpt(int level, int optname, void *optval, int *optlen);
     GSocketError SetSockOpt(int level, int optname,
         const void *optval, int optlen);
     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);
+    //attach or detach from main loop
+    void Notify(bool flag);

     virtual void Detected_Read();
     virtual void Detected_Write();
     virtual void Detected_Read();
     virtual void Detected_Write();

+    void SetInitialSocketBuffers(int recv, int send)
+    {
+        m_initialRecvBufferSize = recv;
+        m_initialSendBufferSize = send;
+    }
+

 protected:
 protected:

+    //enable or disable event callback using gsocket gui callback table
+    void EnableEvents(bool flag = true);
+    void DisableEvents() { EnableEvents(false); }

     void Enable(GSocketEvent event);
     void Disable(GSocketEvent event);
     GSocketError Input_Timeout();
     void Enable(GSocketEvent event);
     void Disable(GSocketEvent event);
     GSocketError Input_Timeout();


@@ -87,68 +67,153 @@ protected:
     int Send_Stream(const char *buffer, int size);
     int Send_Dgram(const char *buffer, int size);
     bool m_ok;
     int Send_Stream(const char *buffer, int size);
     int Send_Dgram(const char *buffer, int size);
     bool m_ok;

+    int m_initialRecvBufferSize;
+    int m_initialSendBufferSize;

 public:
     /* DFE: We can't protect these data member until the GUI code is updated */
     /* protected: */
   int m_fd;
 public:
     /* DFE: We can't protect these data member until the GUI code is updated */
     /* protected: */
   int m_fd;

+  wxGSocketIOHandler *m_handler;

   GAddress *m_local;
   GAddress *m_peer;
   GSocketError m_error;
 
   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;
+  bool m_non_blocking;
+  bool m_server;
+  bool m_stream;
+  bool m_establishing;
+  bool m_reusable;
+  bool m_broadcast;
+  bool m_dobind;

   unsigned long m_timeout;
 
   unsigned long m_timeout;
 

+  // true if socket should fire events
+  bool m_use_events;
+

   /* Callbacks */
   GSocketEventFlags m_detected;
   GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
   char *m_data[GSOCK_MAX_EVENT];
 
   /* Callbacks */
   GSocketEventFlags m_detected;
   GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
   char *m_data[GSOCK_MAX_EVENT];
 

-  char *m_gui_dependent;
-
+  // pointer for storing extra (usually GUI-specific) data
+  void *m_gui_dependent;

 };
 
 };
 

-#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;
-
-  GAddressType m_family;
-  int m_realfamily;
+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 = wx_static_cast(int *, socket->m_gui_dependent);
+
+        fds[0] = -1;
+        fds[1] = -1;
+
+        return true;
+    }
+    virtual void Destroy_Socket(GSocket *socket)
+    {
+        free(socket->m_gui_dependent);
+    }
+
+    virtual void Enable_Events(GSocket *socket)
+    {
+        Install_Callback(socket, GSOCK_INPUT);
+        Install_Callback(socket, GSOCK_OUTPUT);
+    }
+    virtual void Disable_Events(GSocket *socket)
+    {
+        Uninstall_Callback(socket, GSOCK_INPUT);
+        Uninstall_Callback(socket, GSOCK_OUTPUT);
+    }

 
 

-  GSocketError m_error;
+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 wx_static_cast(int *, socket->m_gui_dependent)[d];
+    }

 };
 };

-#ifdef __cplusplus
-}
-#endif  /* __cplusplus */
-
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __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__) */
+// 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  /* __GSOCK_UNX_H */
+#endif  /* _WX_UNIX_GSOCKUNX_H_ */