]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Docs: fix various doxygen compiler issues
authorAmos Jeffries <squid3@treenet.co.nz>
Sat, 11 Jan 2014 01:35:50 +0000 (17:35 -0800)
committerAmos Jeffries <squid3@treenet.co.nz>
Sat, 11 Jan 2014 01:35:50 +0000 (17:35 -0800)
25 files changed:
compat/compat.dox
include/CbDataList.h
squid3.dox
src/CommCalls.h
src/DiskIO/DiskThreads/DiskThreadsDiskFile.cc
src/HttpParser.h
src/acl/Acl.h
src/acl/Asn.cc
src/acl/InnerNode.cc
src/acl/IntRange.cc
src/acl/MethodData.cc
src/acl/ProtocolData.cc
src/acl/SslErrorData.cc
src/adaptation/AccessCheck.cc
src/adaptation/icap/ServiceRep.cc
src/adaptation/icap/ServiceRep.h
src/auth/AclMaxUserIp.cc
src/auth/AclMaxUserIp.h
src/auth/AclProxyAuth.cc
src/auth/AclProxyAuth.h
src/comm.cc
src/format/Quoting.cc
src/ip/QosConfig.h
src/ssl/cert_validate_message.h
src/ssl/crtd_message.h

index d9af22df681ff3c22775cc75a177b44e8023d62a..29e75f3fdd20df2ade155282ea36cfcdd410bf75 100644 (file)
@@ -4,7 +4,7 @@
 \title Squid Portability
 
 
-\section 1 Aim
+\section sec1 Aim
 
 \par 
 Squid aims to build and run on many modern systems. To do this we have traditionally
@@ -18,7 +18,7 @@ The Portability library libcompat-squid.la has been created to correct the three
 stable build portability, code cleanliness, and clearer licensing.
 
 
-\section 2 Requirements
+\section sec2 Requirements
 
 \par
 The system calls used by Squid are not required to be standard. Often we depend on
@@ -26,17 +26,17 @@ some non-standard call which can give great performance benefits.
 But they are required to meet several other criteria:
  \li  They must be of actual benefit to Squid during its operation.
  \li  A better alternative must not exist.
- \li  If not available on all OS an open-source GPLv2+ implementation must be available
-      to be included with the Squid sources and used when required.
+ \li  If not available on all OS an open-source GPLv2+ compatible implementation must be
+      available to be included with the Squid sources and used when required.
 
 \par
-To be built into the libcompat-squid.la as a layer below all Squid-bundled binaries. The code
-must also qualify by being provided natively by some OS where Squid builds. \br
+To be built into the libcompat-squid.la as a layer below all Squid-bundled binaries. The
+code must also qualify by being provided natively by some OS where Squid builds. \br
 Code and Algorithms which do not meet this final criteria are relegated to the slightly
 higher level of basic component, rather than portability.
 
 
-\section 3 Component Types
+\section sec3 Component Types
 
 \par Macro re-definition
 Where the only difference between systems is their naming scheme. One of the schemes is
@@ -62,16 +62,16 @@ same name with an 'x' pre-pended. Currently these extra protections are added on
 handling and memory allocation.
 
 
-\section 4 Layout
+\section sec4 Layout
 The internal code structure of libcompat-squid.la files has a hierarchy. The API has a flat
 global scope separate from the file layout. The API is pulled in by including compat/compat.h.
-The strict dependency requirements which exist within the compat API make including
+The strict dependency requirements which exist within the compat API make including an
 individual part separately a risky operation.
 
 \par
-Squid coding guidelines require each .c and .cc file to include squid.h first
-in their included files. squid.h begin with an order-specific sequence of defines and
-includes compat/compat.h to incorporate the compat layer appropriately in every soure file.
+Squid coding guidelines require each .c and .cc file to include squid.h first in their
+included files. squid.h begins with an order-specific sequence of defines and includes
+compat/compat.h to incorporate the compat layer appropriately in every source file.
 
 \par
 Internally the compat/ directory contains the public API file compat/compat.h which structures
@@ -84,9 +84,9 @@ special compat layer handling. Hacks for specific systems should be restricted t
 as much as possible.
 
 \par
-compat/compat_shared.h file contains the shared portability definitions which are shared
-across a great many systems. These should be written with protective macros to prevent any
-symbols or code being defined which is not necessary. Protections here must not be system-specific.
+compat/compat_shared.h file contains the portability definitions which are shared across a
+great many systems. These should be written with protective macros to prevent any symbols or
+code being defined which is not necessary. Protections here must not be system-specific.
 
 \par
 Also in compat/ directory are the .h and .c files for emulators detected by autoconf. These
index 97ff706fe357b3101cfe696d7b7617ddf3aa96cb..822fa303f69d33484e4294f2e2165ac59f697e4e 100644 (file)
@@ -95,7 +95,7 @@ private:
 
 /* implementation follows */
 
-/** \cond AUTODOCS-IGNORE */
+/** \cond AUTODOCS_IGNORE */
 template <class C>
 cbdata_type CbDataList<C>::CBDATA_CbDataList = CBDATA_UNKNOWN;
 /** \endcond */
index bea99b3bc59a7e423ef4ec16fea3ecf9b7887cef..bb2e735027837a5015ff880d8fdaf7201de87bb1 100644 (file)
@@ -1262,6 +1262,7 @@ PREDEFINED             = __cplusplus \
                          X_ACCELERATOR_VARY \
                          USE_ARP_ACL \
                          USE_ASYNC_IO \
+                         USE_AUTH \
                          USE_CACHE_DIGESTS \
                          USE_CLASSFUL \
                          USE_DELAY_POOLS \
@@ -1303,8 +1304,14 @@ EXPAND_AS_DEFINED      = AsyncCallWrapper \
                          AsyncCallEnter \
                          AsyncCallExit \
                          CBDATA_CLASS2 \
+                         CBDATA_CLASS_INIT \
+                         CBDATA_NAMESPACED_CLASS_INIT \
                          MEMPROXY_CLASS_INLINE \
-                         MEMPROXY_CLASS
+                         MEMPROXY_CLASS \
+                         MEMPROXY_CLASS_INIT \
+                         STUB \
+                         STUB_NOP \
+                         STUB_RETVAL
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
 # doxygen's preprocessor will remove all function-like macros that are alone 
index 9ec9f4ff6674d2a801ab4a692995cc400674725d..dba72d15546af996d1e1cf013b14eaba1cc577cb 100644 (file)
@@ -66,13 +66,13 @@ public:
     void *data; // cbdata-protected
 
     /** The connection which this call pertains to.
-     * \itemize On accept() calls this is the new client connection.
-     * \itemize On connect() finished calls this is the newely opened connection.
-     * \itemize On write calls this is the connection just written to.
-     * \itemize On read calls this is the connection just read from.
-     * \itemize On close calls this describes the connection which is now closed.
-     * \itemize On timeouts this is the connection whose operation timed out.
-     *          NP: timeouts might also return to the connect/read/write handler with COMM_ERR_TIMEOUT.
+     *  - On accept() calls this is the new client connection.
+     *  - On connect() finished calls this is the newely opened connection.
+     *  - On write calls this is the connection just written to.
+     *  - On read calls this is the connection just read from.
+     *  - On close calls this describes the connection which is now closed.
+     *  - On timeouts this is the connection whose operation timed out.
+     *   + NP: timeouts might also return to the connect/read/write handler with COMM_ERR_TIMEOUT.
      */
     Comm::ConnectionPointer conn;
 
index 660391a970f9b9bca0b1d3240ab596536c373b45..fe7a59c28694be97425fc832bf0e67099c2d5854 100644 (file)
@@ -350,7 +350,7 @@ DiskThreadsDiskFile::writeDone(int rvfd, int errflag, size_t len, RefCount<Write
     --loop_detect;
 }
 
-/** \cond AUTODOCS-IGNORE */
+/** \cond AUTODOCS_IGNORE */
 template <class RT>
 cbdata_type IoResult<RT>::CBDATA_IoResult = CBDATA_UNKNOWN;
 /** \endcond */
index 7e941528dbea23ff4e1b61fc66465ee86e8e4100..095d3466c72f65c52a56a852f0f47418dbdbbf41 100644 (file)
@@ -11,9 +11,8 @@
  *
  * Works on a raw character I/O buffer and tokenizes the content into
  * either an error state or, an HTTP procotol request major segments:
- *
- * \item Request Line (method, URL, protocol, version)
- * \item Mime header block
+ *  1. Request Line (method, URL, protocol, version)
+ *  2. Mime header block
  */
 class HttpParser
 {
index 9bcdc16833e76750c5deef84e829ab8be45552fb..bef60f7dfbc504a9b1cb41ea621f5ba8927c34c0 100644 (file)
@@ -101,10 +101,10 @@ public:
     void *operator new(size_t);
     void operator delete(void *);
 
-    static ACL *Factory (char const *);
+    static ACL *Factory(char const *);
     static void ParseAclLine(ConfigParser &parser, ACL ** head);
     static void Initialize();
-    static ACLFindByName(const char *name);
+    static ACL *FindByName(const char *name);
 
     ACL();
     explicit ACL(const ACLFlag flgs[]) : cfgline(NULL), next(NULL), flags(flgs) { memset(name, '\0', sizeof(name)); }
@@ -119,15 +119,15 @@ public:
     /// Updates the checklist state on match, async, and failure.
     bool matches(ACLChecklist *checklist) const;
 
-    virtual ACL *clone()const = 0;
+    virtual ACL *clone() const = 0;
 
     /// parses node represenation in squid.conf; dies on failures
     virtual void parse() = 0;
     virtual char const *typeString() const = 0;
     virtual bool isProxyAuth() const;
     virtual wordlist *dump() const = 0;
-    virtual bool empty () const = 0;
-    virtual bool valid () const;
+    virtual bool empty() const = 0;
+    virtual bool valid() const;
 
     int cacheMatchAcl(dlink_list * cache, ACLChecklist *);
     virtual int matchForCache(ACLChecklist *checklist);
@@ -146,14 +146,14 @@ public:
     {
 
     public:
-        Prototype ();
-        Prototype (ACL const *, char const *);
+        Prototype();
+        Prototype(ACL const *, char const *);
         ~Prototype();
         static bool Registered(char const *);
-        static ACL *Factory (char const *);
+        static ACL *Factory(char const *);
 
     private:
-        ACL const*prototype;
+        ACL const *prototype;
         char const *typeString;
 
     private:
index 33062e8aba4e2ca8d1ae9c6d70282bc15ffdcc2e..bea2a9ab8cec7bf896ceb73d520dc423466e0dfa 100644 (file)
@@ -75,7 +75,7 @@ struct squid_radix_node_head *AS_tree_head;
 
 /* explicit instantiation required for some systems */
 
-/// \cond AUTODOCS-IGNORE
+/// \cond AUTODOCS_IGNORE
 template cbdata_type CbDataList<int>::CBDATA_CbDataList;
 /// \endcond
 
index c8042ecc5e749f772f3c9158eb30ec1c33117f75..b8bc27c7c414f2890389e66388eee27f4ebaeefd 100644 (file)
@@ -80,7 +80,7 @@ Acl::InnerNode::match(ACLChecklist *checklist)
 }
 
 bool
-Acl::InnerNode::resumeMatchingAt(ACLChecklist *checklist, Nodes::const_iterator pos) const
+Acl::InnerNode::resumeMatchingAt(ACLChecklist *checklist, Acl::Nodes::const_iterator pos) const
 {
     debugs(28, 5, "checking " << name << " at " << (pos-nodes.begin()));
     const int result = doMatch(checklist, pos);
index 40eeb67f14d58f6444f05e5b91f4cbe7d3103ae3..1e4c1a453ea1ad195f12fb5250af96a7c4aa5343 100644 (file)
@@ -40,7 +40,7 @@
 #include "wordlist.h"
 
 /* explicit instantiation required for some systems */
-/** \cond AUTODOCS-IGNORE */
+/** \cond AUTODOCS_IGNORE */
 template cbdata_type CbDataList< Range<int> >::CBDATA_CbDataList;
 /** \endcond */
 
index b9a8fefd8a7f24ee2acfc5f07969cf4fa40935db..3b4e294657f4c03e71a6ceb7ceb7278765b92ec6 100644 (file)
@@ -64,7 +64,7 @@ ACLMethodData::match(HttpRequestMethod toFind)
 
 /* explicit instantiation required for some systems */
 
-/// \cond AUTODOCS-IGNORE
+/// \cond AUTODOCS_IGNORE
 template cbdata_type CbDataList<HttpRequestMethod>::CBDATA_CbDataList;
 /// \endcond
 
index dc2a453a2b16b36836b038acb40977f3fe12d2e8..f0b6899a9c6b889f1171369f6e19b254e051a351 100644 (file)
@@ -62,7 +62,7 @@ ACLProtocolData::match(AnyP::ProtocolType toFind)
 
 /* explicit instantiation required for some systems */
 
-/// \cond AUTODOCS-IGNORE
+/// \cond AUTODOCS_IGNORE
 template cbdata_type CbDataList<AnyP::ProtocolType>::CBDATA_CbDataList;
 /// \endcond
 
index 4ac522228deab0c32c0db2ddd100814e95ad9d4a..e71ffb157a9397981d9b41609caabfbf61c3012f 100644 (file)
@@ -62,7 +62,7 @@ ACLSslErrorData::match(const Ssl::CertErrors *toFind)
 }
 
 /* explicit instantiation required for some systems */
-/** \cond AUTODOCS-IGNORE */
+/** \cond AUTODOCS_IGNORE */
 // AYJ: 2009-05-20 : Removing. clashes with template <int> instantiation for other ACLs.
 // template cbdata_type Ssl::Errors::CBDATA_CbDataList;
 /** \endcond */
index 10cd0fb917022fb70ce77349638e7313fb284f65..3e50fc67c818618a272323d48e1848114a03f83e 100644 (file)
@@ -14,7 +14,7 @@
 #include "HttpReply.h"
 #include "HttpRequest.h"
 
-/** \cond AUTODOCS-IGNORE */
+/** \cond AUTODOCS_IGNORE */
 cbdata_type Adaptation::AccessCheck::CBDATA_AccessCheck = CBDATA_UNKNOWN;
 /** \endcond */
 
index 59502373a4e92770a05dfba8567d6f0b675506bc..16b86f030bdfec46586101f914001c8db82e68c4 100644 (file)
@@ -711,7 +711,7 @@ bool Adaptation::Icap::ServiceRep::detached() const
     return isDetached;
 }
 
-Adaptation::Icap::ConnWaiterDialer::ConnWaiterDialer(const CbcPointer<ModXact> &xact,
+Adaptation::Icap::ConnWaiterDialer::ConnWaiterDialer(const CbcPointer<Adaptation::Icap::ModXact> &xact,
         Adaptation::Icap::ConnWaiterDialer::Parent::Method aHandler):
         Parent(xact, aHandler)
 {
index 7097198fc67d4b9d36e0f6411f5b1a2f78abeff0..fad4d76eac86dbca824275e8d9cbf52ace815994 100644 (file)
@@ -216,7 +216,7 @@ class ConnWaiterDialer: public NullaryMemFunT<ModXact>
 public:
     typedef NullaryMemFunT<ModXact> Parent;
     ServiceRep::Pointer theService;
-    ConnWaiterDialer(const CbcPointer<ModXact> &xact, Parent::Method aHandler);
+    ConnWaiterDialer(const CbcPointer<Adaptation::Icap::ModXact> &xact, Adaptation::Icap::ConnWaiterDialer::Parent::Method aHandler);
     ConnWaiterDialer(const Adaptation::Icap::ConnWaiterDialer &aConnWaiter);
     ~ConnWaiterDialer();
 };
index e1023d91e04e3921e8b6ea6983f643cf57808413..43af041f2cd715f9294dd65d853f0f69c7eef715 100644 (file)
 #include "Parsing.h"
 #include "wordlist.h"
 
-ACLFlag
-ACLMaxUserIP::SupportedFlags[] = {ACL_F_STRICT, ACL_F_END};
+ACLFlag ACLMaxUserIP::SupportedFlags[] = {ACL_F_STRICT, ACL_F_END};
 
-ACL *
-ACLMaxUserIP::clone() const
-{
-    return new ACLMaxUserIP(*this);
-}
-
-ACLMaxUserIP::ACLMaxUserIP (char const *theClass) : ACL(SupportedFlags), class_ (theClass), maximum(0)
+ACLMaxUserIP::ACLMaxUserIP(char const *theClass) :
+        ACL(SupportedFlags),
+        class_(theClass),
+        maximum(0)
 {}
 
-ACLMaxUserIP::ACLMaxUserIP (ACLMaxUserIP const & old) : class_ (old.class_), maximum (old.maximum)
+ACLMaxUserIP::ACLMaxUserIP(ACLMaxUserIP const &old) :
+        class_(old.class_),
+        maximum(old.maximum)
 {
    flags = old.flags;
 }
@@ -33,6 +31,12 @@ ACLMaxUserIP::ACLMaxUserIP (ACLMaxUserIP const & old) : class_ (old.class_), max
 ACLMaxUserIP::~ACLMaxUserIP()
 {}
 
+ACL *
+ACLMaxUserIP::clone() const
+{
+    return new ACLMaxUserIP(*this);
+}
+
 char const *
 ACLMaxUserIP::typeString() const
 {
@@ -40,13 +44,13 @@ ACLMaxUserIP::typeString() const
 }
 
 bool
-ACLMaxUserIP::empty () const
+ACLMaxUserIP::empty() const
 {
     return false;
 }
 
 bool
-ACLMaxUserIP::valid () const
+ACLMaxUserIP::valid() const
 {
     return maximum > 0;
 }
index 13414edfe13e15e81d083e4bc9b78da15f5a00f4..58ae3fd22e1e359e20fa2b42cb2459172283f3fa 100644 (file)
 /// \ingroup ACLAPI
 class ACLMaxUserIP : public ACL
 {
-
 public:
     MEMPROXY_CLASS(ACLMaxUserIP);
 
-    ACLMaxUserIP(char const *);
-    ACLMaxUserIP(ACLMaxUserIP const &);
+    ACLMaxUserIP(char const *theClass);
+    ACLMaxUserIP(ACLMaxUserIP const &old);
     ~ACLMaxUserIP();
-    ACLMaxUserIP&operator=(ACLMaxUserIP const &);
+    ACLMaxUserIP &operator =(ACLMaxUserIP const &);
 
-    virtual ACL *clone()const;
+    virtual ACL *clone() const;
     virtual char const *typeString() const;
     virtual void parse();
-    virtual int match(ACLChecklist *checklist);
+    virtual int match(ACLChecklist *cl);
     virtual wordlist *dump() const;
-    virtual bool empty () const;
-    virtual bool valid () const;
+    virtual bool empty() const;
+    virtual bool valid() const;
     virtual bool requiresRequest() const {return true;}
 
     int getMaximum() const {return maximum;}
@@ -67,9 +66,9 @@ public:
 private:
     static Prototype RegistryProtoype;
     static ACLMaxUserIP RegistryEntry_;
-    static ACLFlag  SupportedFlags[];
+    static ACLFlag SupportedFlags[];
 
-    int match(Auth::UserRequest::Pointer, Ip::Address const &);
+    int match(Auth::UserRequest::Pointer auth_user_request, Ip::Address const &src_addr);
     char const *class_;
     int maximum;
 };
index 91e2bc164764f04d6fe4265eb1da7a3f75d7eaf1..8be5df9ce935a613d3e7785d4f12e388a586f14e 100644 (file)
@@ -49,13 +49,13 @@ ACLProxyAuth::~ACLProxyAuth()
     delete data;
 }
 
-ACLProxyAuth::ACLProxyAuth(ACLData<char const *> *newData, char const *theType) : data (newData), type_(theType) {}
+ACLProxyAuth::ACLProxyAuth(ACLData<char const *> *newData, char const *theType) : data(newData), type_(theType) {}
 
-ACLProxyAuth::ACLProxyAuth (ACLProxyAuth const &old) : data (old.data->clone()), type_(old.type_)
+ACLProxyAuth::ACLProxyAuth(ACLProxyAuth const &old) : data(old.data->clone()), type_(old.type_)
 {}
 
 ACLProxyAuth &
-ACLProxyAuth::operator= (ACLProxyAuth const &rhs)
+ACLProxyAuth::operator=(ACLProxyAuth const &rhs)
 {
     data = rhs.data->clone();
     type_ = rhs.type_;
@@ -106,13 +106,13 @@ ACLProxyAuth::dump() const
 }
 
 bool
-ACLProxyAuth::empty () const
+ACLProxyAuth::empty() const
 {
     return data->empty();
 }
 
 bool
-ACLProxyAuth::valid () const
+ACLProxyAuth::valid() const
 {
     if (authenticateSchemeCount() == 0) {
         debugs(28, DBG_CRITICAL, "Can't use proxy auth because no authentication schemes were compiled.");
index cdcb5aefc63886bb1a7630955bfe72d1053d51f2..636c8576660d7f8498d917a5950935126f8f568a 100644 (file)
@@ -43,7 +43,7 @@ class ProxyAuthLookup : public ACLChecklist::AsyncState
 
 public:
     static ProxyAuthLookup *Instance();
-    virtual void checkForAsync(ACLChecklist *)const;
+    virtual void checkForAsync(ACLChecklist *) const;
 
 private:
     static ProxyAuthLookup instance_;
@@ -52,14 +52,13 @@ private:
 
 class ACLProxyAuth : public ACL
 {
-
 public:
     MEMPROXY_CLASS(ACLProxyAuth);
 
     ~ACLProxyAuth();
     ACLProxyAuth(ACLData<char const *> *, char const *);
-    ACLProxyAuth (ACLProxyAuth const &);
-    ACLProxyAuth &operator(ACLProxyAuth const &);
+    ACLProxyAuth(ACLProxyAuth const &);
+    ACLProxyAuth &operator =(ACLProxyAuth const &);
 
     virtual char const *typeString() const;
     virtual void parse();
@@ -67,8 +66,8 @@ public:
 
     virtual int match(ACLChecklist *checklist);
     virtual wordlist *dump() const;
-    virtual bool valid () const;
-    virtual bool empty () const;
+    virtual bool valid() const;
+    virtual bool empty() const;
     virtual bool requiresRequest() const {return true;}
 
     virtual ACL *clone() const;
index 017a4c33154a0a4594aef9b6d8953505bfaaeda0..9f19f1dbb4d5e8ad12a59517b27dd611b517ed78 100644 (file)
@@ -1927,7 +1927,7 @@ DeferredReadManager::~DeferredReadManager()
 
 /* explicit instantiation required for some systems */
 
-/// \cond AUTODOCS-IGNORE
+/// \cond AUTODOCS_IGNORE
 template cbdata_type CbDataList<DeferredRead>::CBDATA_CbDataList;
 /// \endcond
 
index c27c7b053252c7e718a64eeb00829c8845a00ea1..6856f8ebe54a9343e6109801d8b4895baa5c42b1 100644 (file)
@@ -19,64 +19,6 @@ static const char c2x[] =
     "e0e1e2e3e4e5e6e7e8e9eaebecedeeef"
     "f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff";
 
-#if DEAD_USING_QUOTEMIMEBLOB
-/** copy of Log::QuoteMimeBlob. Bugs there will be found here.
- * This omits [] characters but is otherwise identical to Log::QuoteMimeBlob when OLD_LOG_MIME = 1
- */
-static char *
-username_quote(const char *header)
-{
-    int c;
-    int i;
-    char *buf;
-    char *buf_cursor;
-
-    if (header == NULL) {
-        buf = static_cast<char *>(xcalloc(1, 1));
-        *buf = '\0';
-        return buf;
-    }
-
-    buf = static_cast<char *>(xcalloc(1, (strlen(header) * 3) + 1));
-    buf_cursor = buf;
-    /*
-     * We escape: space \x00-\x1F and space (0x40) and \x7F-\xFF
-     * to prevent garbage in the logs. CR and LF are also there just in case.
-     */
-
-    while ((c = *(const unsigned char *) header++) != '\0') {
-        if (c == '\r') {
-            *buf_cursor = '\\';
-            ++buf_cursor;
-            *buf_cursor = 'r';
-            ++buf_cursor;
-        } else if (c == '\n') {
-            *buf_cursor = '\\';
-            ++buf_cursor;
-            *buf_cursor = 'n';
-            ++buf_cursor;
-        } else if (c <= 0x1F
-                   || c >= 0x7F
-                   || c == '%'
-                   || c == ' ') {
-            *buf_cursor = '%';
-            ++buf_cursor;
-            i = c * 2;
-            *buf_cursor = c2x[i];
-            ++buf_cursor;
-            *buf_cursor = c2x[i + 1];
-            ++buf_cursor;
-        } else {
-            *buf_cursor = (char) c;
-            ++buf_cursor;
-        }
-    }
-
-    *buf_cursor = '\0';
-    return buf;
-}
-#endif // DEAD
-
 char *
 Format::QuoteUrlEncodeUsername(const char *name)
 {
@@ -87,7 +29,6 @@ Format::QuoteUrlEncodeUsername(const char *name)
         return NULL;
 
     return QuoteMimeBlob(name);
-//    return username_quote(name);
 }
 
 char *
@@ -106,7 +47,7 @@ Format::QuoteMimeBlob(const char *header)
 
     buf = static_cast<char *>(xcalloc(1, (strlen(header) * 3) + 1));
     buf_cursor = buf;
-    /**
+    /*
      * Whe OLD_LOG_MIME is defined we escape: \x00-\x1F"#%;<>?{}|\\\\^~`\[\]\x7F-\xFF
      * which is the default escape list for the CPAN Perl5 URI module
      * modulo the inclusion of space (x40) to make the raw logs a bit
index c382b1e3cf85dfa1a0c0fd64f28162679b95c583..6922363fbf7d14d5c2c3cebf9751762d0ac3d03c 100644 (file)
@@ -142,7 +142,7 @@ class Config
 public:
 
     Config();
-    ~Config() {};
+    ~Config() {}
 
     void parseConfigLine();
 
index d3d2221c5628355c0606c752a03c4c225bf68f86..31b4e2c1138e3d08442fca7fcb009174791f18eb 100644 (file)
@@ -1,12 +1,10 @@
-/*
- */
-
 #ifndef SQUID_SSL_CERT_VALIDATE_MESSAGE_H
 #define SQUID_SSL_CERT_VALIDATE_MESSAGE_H
 
 #include "HelperReply.h"
 #include "ssl/crtd_message.h"
 #include "ssl/support.h"
+
 #include <vector>
 
 namespace Ssl
@@ -41,7 +39,7 @@ public:
     public:
         RecvdError(): id(0), error_no(SSL_ERROR_NONE), cert(NULL) {}
         RecvdError(const RecvdError &);
-        RecvdError & operator = (const RecvdError &);
+        RecvdError & operator =(const RecvdError &);
         void setCert(X509 *);  ///< Sets cert to the given certificate
         int id; ///<  The id of the error
         ssl_error_t error_no; ///< The OpenSSL error code
@@ -62,9 +60,9 @@ public:
  * This class is responsible for composing or parsing messages destined to
  * or comming from a cert validator helper.
  * The messages format is:
- *   <response/request code> <whitespace> <body length> <whitespace> <key=value> ...\1
+ *   response/request-code SP body-length SP [key=value ...] \x01
  */
-class CertValidationMsg: public CrtdMessage
+class CertValidationMsg : public CrtdMessage
 {
 private:
     /**
@@ -78,7 +76,7 @@ private:
         X509_Pointer cert;       ///< A pointer to certificate
         CertItem(): cert(NULL) {}
         CertItem(const CertItem &);
-        CertItem & operator = (const CertItem &);
+        CertItem & operator =(const CertItem &);
         void setCert(X509 *); ///< Sets cert to the given certificate
     };
 
@@ -110,4 +108,5 @@ public:
 };
 
 }//namespace Ssl
+
 #endif // SQUID_SSL_CERT_VALIDATE_MESSAGE_H
index 459472716b43573d6afcb66e57ce52860188e09a..747bd8e8e9edf3e8410ba6b0f7d413e8268a737c 100644 (file)
@@ -15,7 +15,7 @@ class CertificateProperties;
 /**
  * This class is responsible for composing and parsing messages destined to, or comming
  * from an ssl_crtd server. Format of these mesages is:
- *   <response/request code> <whitespace> <body length> <whitespace> <body>
+ *   response/request-code SP body length SP body
  */
 class CrtdMessage
 {
@@ -98,4 +98,5 @@ protected:
 };
 
 } //namespace Ssl
+
 #endif // SQUID_SSL_CRTD_MESSAGE_H