added explanatory comment

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

diff --git a/src/common/protocol.cpp b/src/common/protocol.cpp
index 8d83bc6dbbde786c0f7bdeec26ad3f469b1edc60..7f1ba9d358f0d6a900091286215afdb9ee5eb8c5 100644 (file)
--- a/src/common/protocol.cpp
+++ b/src/common/protocol.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        protocol.cpp
+// Name:        src/common/protocol.cpp
 // Purpose:     Implement protocol base class
 // Author:      Guilhem Lavaux
 // Modified by:
@@ -9,22 +9,22 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "protocol.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-  #pragma hdrstop
+    #pragma hdrstop
 #endif
 
 #if wxUSE_PROTOCOL
 
 #include "wx/protocol/protocol.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/module.h"
+#endif
+
 #include "wx/url.h"
-#include "wx/module.h"
 
 #include <stdlib.h>
 
@@ -45,8 +45,12 @@ wxProtoInfo::wxProtoInfo(const wxChar *name, const wxChar *serv,
 {
     m_cinfo = info;
     m_needhost = need_host1;
+#if wxUSE_URL
     next = wxURL::ms_protocols;
     wxURL::ms_protocols = this;
+#else
+    next = NULL;
+#endif
 }
 
 /////////////////////////////////////////////////////////////////
@@ -74,56 +78,88 @@ bool wxProtocol::Reconnect()
     if (!GetPeer(addr))
     {
         Close();
-        return FALSE;
+        return false;
     }
 
     if (!Close())
-        return FALSE;
-        
+        return false;
+
     if (!Connect(addr))
-        return FALSE;
+        return false;
 
-    return TRUE;
+    return true;
 }
 
 // ----------------------------------------------------------------------------
 // Read a line from socket
 // ----------------------------------------------------------------------------
 
-// TODO ReadLine() should use buffers private to wxProtocol for efficiency!
-
-// static
-wxProtocolError wxProtocol::ReadLine(wxSocketBase *socket, wxString& result)
+/* static */
+wxProtocolError wxProtocol::ReadLine(wxSocketBase *sock, wxString& result)
 {
-    result.Empty();
-    char ch, chLast = '\0';
-    while ( !socket->Read(&ch, sizeof(ch)).Error() )
+    static const int LINE_BUF = 4095;
+
+    result.clear();
+
+    wxCharBuffer buf(LINE_BUF);
+    char *pBuf = buf.data();
+    while ( sock->WaitForRead() )
     {
-        switch ( ch )
+        // peek at the socket to see if there is a CRLF
+        sock->Peek(pBuf, LINE_BUF);
+
+        size_t nRead = sock->LastCount();
+        if ( !nRead && sock->Error() )
+            return wxPROTO_NETERR;
+
+        // look for "\r\n" paying attention to a special case: "\r\n" could
+        // have been split by buffer boundary, so check also for \r at the end
+        // of the last chunk and \n at the beginning of this one
+        pBuf[nRead] = '\0';
+        const char *eol = strchr(pBuf, '\n');
+
+        // if we found '\n', is there a '\r' as well?
+        if ( eol )
         {
-            case '\r':
-                // remember it, if the following is '\n', we're done
-                chLast = '\r';
-                break;
-
-            case '\n':
-                // only ends line if the previous character was '\r'
-                if ( chLast == '\r' )
+            if ( eol == pBuf )
+            {
+                // check for case of "\r\n" being split
+                if ( result.empty() || result.Last() != _T('\r') )
                 {
-                    // EOL found
-                    return wxPROTO_NOERR;
+                    // ignore the stray '\n'
+                    eol = NULL;
                 }
-                //else: fall through
+                //else: ok, got real EOL
+
+                // read just this '\n' and restart
+                nRead = 1;
+            }
+            else // '\n' in the middle of the buffer
+            {
+                // in any case, read everything up to and including '\n'
+                nRead = eol - pBuf + 1;
 
-            default:
-                // normal char
-                if ( chLast )
+                if ( eol[-1] != '\r' )
                 {
-                    result += wxString::FromAscii( chLast );
-                    chLast = '\0';
+                    // as above, simply ignore stray '\n'
+                    eol = NULL;
                 }
+            }
+        }
+
+        sock->Read(pBuf, nRead);
+        if ( sock->LastCount() != nRead )
+            return wxPROTO_NETERR;
+
+        pBuf[nRead] = '\0';
+        result += wxString::FromAscii(pBuf);
 
-                result += wxString::FromAscii( ch );
+        if ( eol )
+        {
+            // remove trailing "\r\n"
+            result.RemoveLast(2);
+
+            return wxPROTO_NOERR;
         }
     }
 
@@ -152,29 +188,28 @@ wxProtocolError GetLine(wxSocketBase *sock, wxString& result)
 
     // Not implemented on all systems
     // ret = (char *)memccpy(tmp_str, tmp_buf, '\n', avail);
-    found = FALSE;
+    found = false;
     for (ret=tmp_str;ret < (tmp_str+avail); ret++)
-        if (*ret == '\n') 
+        if (*ret == '\n')
         {
-            found = TRUE;
+            found = true;
             break;
         }
 
     if (!found)
         return wxPROTO_PROTERR;
-        
+
     *ret = 0;
 
     result = wxString::FromAscii( tmp_str );
-    result = result.Left(result.Length()-1);
+    result = result.Left(result.length()-1);
 
     size = ret-tmp_str+1;
     sock->Unread(&tmp_buf[size], avail-size);
-  
+
     return wxPROTO_NOERR;
 #undef PROTO_BSIZE
 }
 #endif // wxUSE_SOCKETS
 
 #endif // wxUSE_PROTOCOL
-