wxUSE_PROPGRID is now recognized by source and header files

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

diff --git a/include/wx/unix/gsockunx.h b/include/wx/unix/gsockunx.h
index 2981d1293f1e59a6ff00c6378524fb6ba74f00e3..a6182dc0d43b4ab47fdef42d9d478c3502a84eda 100644 (file)
--- a/include/wx/unix/gsockunx.h
+++ b/include/wx/unix/gsockunx.h
@@ -1,46 +1,107 @@
 /* -------------------------------------------------------------------------
 /* -------------------------------------------------------------------------

- * 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

 
 

-#include "wx/setup.h"
-
-#if wxUSE_SOCKETS
-
-#include "wx/gsocket.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
-
-/* Definition of GSocket */
-struct _GSocket {
+#ifndef _WX_UNIX_GSOCKUNX_H_
+#define _WX_UNIX_GSOCKUNX_H_
+
+class wxGSocketIOHandler;
+
+class GSocket
+{
+public:
+    GSocket();
+    virtual ~GSocket();
+    bool IsOk() { return m_ok; }
+    void Close();
+    void Shutdown();
+    GSocketError SetLocal(GAddress *address);
+    GSocketError SetPeer(GAddress *address);
+    GAddress *GetLocal();
+    GAddress *GetPeer();
+    GSocketError SetServer();
+    GSocket *WaitConnection();
+    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(bool non_block);
+    void SetTimeout(unsigned long millisec);
+    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);
+    //attach or detach from main loop
+    void Notify(bool flag);
+    virtual void Detected_Read();
+    virtual void Detected_Write();
+    void SetInitialSocketBuffers(int recv, int send)
+    {
+        m_initialRecvBufferSize = recv;
+        m_initialSendBufferSize = send;
+    }
+
+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();
+    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;
+    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;
   int m_fd;

-  GAddress *m_local, *m_peer;
+  wxGSocketIOHandler *m_handler;
+  GAddress *m_local;
+  GAddress *m_peer;

   GSocketError m_error;
 
   GSocketError m_error;
 

-  bool m_non_blocking, m_server, m_stream, m_oriented;
+  bool m_non_blocking;
+  bool m_server;
+  bool m_stream;

   bool m_establishing;
   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 */
   /* Callbacks */

+  GSocketEventFlags m_detected;

   GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
   char *m_data[GSOCK_MAX_EVENT];
 
   GSocketCallback m_cbacks[GSOCK_MAX_EVENT];
   char *m_data[GSOCK_MAX_EVENT];
 

-  /* IO calls associated */
-  bool m_iocalls[GSOCK_MAX_EVENT];
-
-  char *m_gui_dependent;
+  // pointer for storing extra (usually GUI-specific) data
+  void *m_gui_dependent;

 };
 
 /* Definition of GAddress */
 };
 
 /* Definition of GAddress */

-struct _GAddress {
+struct _GAddress
+{

   struct sockaddr *m_addr;
   size_t m_len;
 
   struct sockaddr *m_addr;
   size_t m_len;
 


@@ -50,38 +111,130 @@ struct _GAddress {
   GSocketError m_error;
 };
 
   GSocketError m_error;
 };
 

-void _GSocket_Enable(GSocket *socket, GSocketEvent event);
-void _GSocket_Disable(GSocket *socket, GSocketEvent event);
-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);
-void _GSocket_Install_Callback(GSocket *socket, GSocketEvent count);
-void _GSocket_Uninstall_Callback(GSocket *socket, GSocketEvent count);
-void _GSocket_Detected_Read(GSocket *socket);
-void _GSocket_Detected_Write(GSocket *socket);
-void _GSocket_GUI_Init(GSocket *socket);
-void _GSocket_GUI_Destroy(GSocket *socket);
-
-/* Translaters returns false when memory is exhausted */
+/* GAddress */
+

 GSocketError _GAddress_translate_from(GAddress *address,
                                       struct sockaddr *addr, int len);
 GSocketError _GAddress_translate_from(GAddress *address,
                                       struct sockaddr *addr, int len);

-GSocketError _GAddress_translate_to(GAddress *address,
-                                    struct sockaddr **addr, int *len);
-
-/* Initialisers returns FALSE when an error happened in the initialisation */
-
-/* Internet address family */
+GSocketError _GAddress_translate_to  (GAddress *address,
+                                      struct sockaddr **addr, int *len);

 GSocketError _GAddress_Init_INET(GAddress *address);
 GSocketError _GAddress_Init_INET(GAddress *address);

-/* Local address family */

 GSocketError _GAddress_Init_UNIX(GAddress *address);
 
 GSocketError _GAddress_Init_UNIX(GAddress *address);
 

-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+// 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
+{
+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);
+    }
+
+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];
+    }
+};

 
 

-#endif
-    /* wxUSE_SOCKETS */
+// 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_ */