From: Amos Jeffries <squid3@treenet.co.nz>
Date: Wed, 9 Jul 2008 11:55:41 +0000 (+1200)
Subject: Author: Kinkie <gkinkie@gmail.com>
X-Git-Tag: SQUID_3_1_0_1~49^2~160
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2236466c9b2e6577bec0ec4420118eb8b42afa9c;p=thirdparty%2Fsquid.git

Author: Kinkie <gkinkie@gmail.com>
Cleanups: rename List.h to CbDataList.h

include/List.h is in my very humble opinion misleadingly named, as it's
tied to CBDATA semantics and isn't really suited to be used as a generic
container class.

This patch renames the include file to CbDataList.h, and all datatypes
defined there are altered in the same manner.
---

diff --git a/include/List.h b/include/CbDataList.h
similarity index 72%
rename from include/List.h
rename to include/CbDataList.h
index a928eec838..0aa43dba40 100644
--- a/include/List.h
+++ b/include/CbDataList.h
@@ -38,48 +38,48 @@
 
 /// \ingroup POD
 template <class C>
-class List
+class CbDataList
 {
 
 public:
     void *operator new (size_t);
     void operator delete (void *);
-    List (C const &);
-    ~List();
+    CbDataList (C const &);
+    ~CbDataList();
 
     bool find(C const &)const;
     bool findAndTune(C const &);
-    List *next;
+    CbDataList *next;
     C element;
     bool empty() const { return this == NULL; }
 
 private:
-    CBDATA_CLASS(List);
+    CBDATA_CLASS(CbDataList);
 };
 
 /// \ingroup POD
 template<class C>
-class ListContainer
+class CbDataListContainer
 {
 
 public:
-    ListContainer();
-    ~ListContainer();
-    List<C> *push_back (C const &);
+    CbDataListContainer();
+    ~CbDataListContainer();
+    CbDataList<C> *push_back (C const &);
     C pop_front();
     bool empty() const;
 
-    List<C> *head;
+    CbDataList<C> *head;
 };
 
 /// \ingroup POD
 template<class C>
-class ListIterator
+class CbDataListIterator
 {
 public:
-    ListIterator(ListContainer<C> const &list) : next_entry(list.head) {}
+    CbDataListIterator(CbDataListContainer<C> const &list) : next_entry(list.head) {}
     const C & next() {
-	List<C> *entry = next_entry;
+	CbDataList<C> *entry = next_entry;
 	if (entry)
 	    next_entry = entry->next;
 	return entry->element;
@@ -89,40 +89,40 @@ public:
     }
 
 private:
-    List<C> *next_entry;
+    CbDataList<C> *next_entry;
 };
 
 /* implementation follows */
 
 /** \cond AUTODOCS-IGNORE */
 template <class C>
-cbdata_type List<C>::CBDATA_List = CBDATA_UNKNOWN;
+cbdata_type CbDataList<C>::CBDATA_CbDataList = CBDATA_UNKNOWN;
 /** \endcond */
 
 template <class C>
 void *
-List<C>::operator new (size_t byteCount)
+CbDataList<C>::operator new (size_t byteCount)
 {
-    CBDATA_INIT_TYPE(List);
+    CBDATA_INIT_TYPE(CbDataList);
 
-    List<C> *result = cbdataAlloc(List);
+    CbDataList<C> *result = cbdataAlloc(CbDataList);
 
     return result;
 }
 
 template <class C>
 void
-List<C>::operator delete (void *address)
+CbDataList<C>::operator delete (void *address)
 {
     cbdataFree(address);
 }
 
 template <class C>
-List<C>::List(C const &value) : next(NULL), element (value)
+CbDataList<C>::CbDataList(C const &value) : next(NULL), element (value)
 {}
 
 template <class C>
-List<C>::~List()
+CbDataList<C>::~CbDataList()
 {
     if (next)
         delete next;
@@ -130,9 +130,9 @@ List<C>::~List()
 
 template <class C>
 bool
-List<C>::find (C const &toFind) const
+CbDataList<C>::find (C const &toFind) const
 {
-    List<C> const *node = NULL;
+    CbDataList<C> const *node = NULL;
 
     for (node = this; node; node = node->next)
         if (node->element == toFind)
@@ -143,11 +143,11 @@ List<C>::find (C const &toFind) const
 
 template <class C>
 bool
-List<C>::findAndTune(C const & toFind)
+CbDataList<C>::findAndTune(C const & toFind)
 {
-    List<C> *prev = NULL;
+    CbDataList<C> *prev = NULL;
 
-    for (List<C> *node = this; node; node = node->
+    for (CbDataList<C> *node = this; node; node = node->
                                             next) {
         if (node->element == toFind) {
             if (prev != NULL) {
@@ -168,24 +168,24 @@ List<C>::findAndTune(C const & toFind)
 }
 
 template <class C>
-ListContainer<C>::ListContainer() : head (NULL)
+CbDataListContainer<C>::CbDataListContainer() : head (NULL)
 {}
 
 template <class C>
-ListContainer<C>::~ListContainer()
+CbDataListContainer<C>::~CbDataListContainer()
 {
     if (head)
         delete head;
 }
 
 template <class C>
-List<C> *
-ListContainer<C>::push_back (C const &element)
+CbDataList<C> *
+CbDataListContainer<C>::push_back (C const &element)
 {
-    List<C> *node = new List<C> (element);
+    CbDataList<C> *node = new CbDataList<C> (element);
 
     if (head) {
-        List<C> *tempNode = NULL;
+        CbDataList<C> *tempNode = NULL;
 
         for (tempNode = head; tempNode->next; tempNode = tempNode->next);
         tempNode->next = node;
@@ -197,11 +197,11 @@ ListContainer<C>::push_back (C const &element)
 
 template <class C>
 C
-ListContainer<C>::pop_front()
+CbDataListContainer<C>::pop_front()
 {
     if (head) {
         C result = head->element;
-        List<C> *node = head;
+        CbDataList<C> *node = head;
         head = head->next;
         node->next = NULL;
         delete node;
@@ -213,7 +213,7 @@ ListContainer<C>::pop_front()
 
 template <class C>
 bool
-ListContainer<C>::empty() const
+CbDataListContainer<C>::empty() const
 {
     return head == NULL;
 }
diff --git a/src/ACLASN.h b/src/ACLASN.h
index 65b4f00be9..9a837c8f47 100644
--- a/src/ACLASN.h
+++ b/src/ACLASN.h
@@ -36,7 +36,7 @@
 #define SQUID_ACLASN_H
 
 #include "ACLData.h"
-#include "List.h"
+#include "CbDataList.h"
 #include "ACLStrategised.h"
 #include "ACLChecklist.h"
 #include "IPAddress.h"
@@ -45,7 +45,7 @@
 
 class CacheManager;
 
-SQUIDCEXTERN int asnMatchIp(List<int> *, IPAddress &);
+SQUIDCEXTERN int asnMatchIp(CbDataList<int> *, IPAddress &);
 
 /// \ingroup ACLAPI
 SQUIDCEXTERN void asnInit(void);
@@ -77,7 +77,7 @@ private:
     static ACLStrategised<IPAddress> SourceRegistryEntry_;
     static ACL::Prototype DestinationRegistryProtoype;
     static ACLStrategised<IPAddress> DestinationRegistryEntry_;
-    List<int> *data;
+    CbDataList<int> *data;
 };
 
 MEMPROXY_CLASS_INLINE(ACLASN)          /**DOCS_NOSEMI*/
diff --git a/src/ACLIntRange.cc b/src/ACLIntRange.cc
index 2a86c620b1..21b29641ac 100644
--- a/src/ACLIntRange.cc
+++ b/src/ACLIntRange.cc
@@ -40,7 +40,7 @@
 #include "Parsing.h"
 
 /* explicit instantiation required for some systems */
-template cbdata_type List< Range<int> >::CBDATA_List;
+template cbdata_type CbDataList< Range<int> >::CBDATA_CbDataList;
 
 void
 ACLIntRange::parse()
@@ -83,7 +83,7 @@ bool
 ACLIntRange::match(int i)
 {
     RangeType const toFind (i, i+1);
-    ListIterator<RangeType> iter(ranges);
+    CbDataListIterator<RangeType> iter(ranges);
 
     while (!iter.end()) {
         const RangeType & element = iter.next();
@@ -113,7 +113,7 @@ ACLIntRange::dump ()
 {
     wordlist *W = NULL;
     char buf[32];
-    ListIterator<RangeType> iter(ranges);
+    CbDataListIterator<RangeType> iter(ranges);
 
     while (!iter.end()) {
         const RangeType & element = iter.next();
diff --git a/src/ACLIntRange.h b/src/ACLIntRange.h
index 18406f016c..72d8b2b058 100644
--- a/src/ACLIntRange.h
+++ b/src/ACLIntRange.h
@@ -36,7 +36,7 @@
 #define SQUID_ACLINTRANGE_H
 
 #include "ACLData.h"
-#include "List.h"
+#include "CbDataList.h"
 #include "Range.h"
 
 /// \ingroup ACLAPI
@@ -55,7 +55,7 @@ public:
 
 private:
     typedef Range<int> RangeType;
-    ListContainer <RangeType> ranges;
+    CbDataListContainer <RangeType> ranges;
 };
 
 #endif /* SQUID_ACLINTRANGE_H */
diff --git a/src/ACLMethodData.cc b/src/ACLMethodData.cc
index c7dae82597..f00e254120 100644
--- a/src/ACLMethodData.cc
+++ b/src/ACLMethodData.cc
@@ -64,15 +64,14 @@ ACLMethodData::match(HttpRequestMethod toFind)
 /* explicit instantiation required for some systems */
 
 /// \cond AUTODOCS-IGNORE
-template cbdata_type List<HttpRequestMethod>
-::CBDATA_List;
+template cbdata_type CbDataList<HttpRequestMethod>::CBDATA_CbDataList;
 /// \endcond
 
 wordlist *
 ACLMethodData::dump()
 {
     wordlist *W = NULL;
-    List<HttpRequestMethod> *data = values;
+    CbDataList<HttpRequestMethod> *data = values;
 
     while (data != NULL) {
         wordlistAdd(&W, RequestMethodStr(data->element));
@@ -85,12 +84,12 @@ ACLMethodData::dump()
 void
 ACLMethodData::parse()
 {
-    List<HttpRequestMethod> **Tail;
+    CbDataList<HttpRequestMethod> **Tail;
     char *t = NULL;
 
     for (Tail = &values; *Tail; Tail = &((*Tail)->next));
     while ((t = strtokFile())) {
-        List<HttpRequestMethod> *q = new List<HttpRequestMethod> (HttpRequestMethod(t, NULL));
+        CbDataList<HttpRequestMethod> *q = new CbDataList<HttpRequestMethod> (HttpRequestMethod(t, NULL));
         *(Tail) = q;
         Tail = &q->next;
     }
diff --git a/src/ACLMethodData.h b/src/ACLMethodData.h
index 0be431e319..5ac338e7c6 100644
--- a/src/ACLMethodData.h
+++ b/src/ACLMethodData.h
@@ -37,7 +37,7 @@
 
 #include "ACL.h"
 #include "ACLData.h"
-#include "List.h"
+#include "CbDataList.h"
 
 /// \ingroup ACLAPI
 class ACLMethodData : public ACLData<HttpRequestMethod>
@@ -56,7 +56,7 @@ public:
     bool empty() const;
     virtual ACLData<HttpRequestMethod> *clone() const;
 
-    List<HttpRequestMethod> *values;
+    CbDataList<HttpRequestMethod> *values;
 };
 
 MEMPROXY_CLASS_INLINE(ACLMethodData);
diff --git a/src/ACLProtocolData.cc b/src/ACLProtocolData.cc
index a17ac99a4f..db567b4549 100644
--- a/src/ACLProtocolData.cc
+++ b/src/ACLProtocolData.cc
@@ -63,14 +63,14 @@ ACLProtocolData::match(protocol_t toFind)
 /* explicit instantiation required for some systems */
 
 /// \cond AUTODOCS-IGNORE
-template cbdata_type List<protocol_t>::CBDATA_List;
+template cbdata_type CbDataList<protocol_t>::CBDATA_CbDataList;
 /// \endcond
 
 wordlist *
 ACLProtocolData::dump()
 {
     wordlist *W = NULL;
-    List<protocol_t> *data = values;
+    CbDataList<protocol_t> *data = values;
 
     while (data != NULL) {
         wordlistAdd(&W, ProtocolStr[data->element]);
@@ -83,12 +83,12 @@ ACLProtocolData::dump()
 void
 ACLProtocolData::parse()
 {
-    List<protocol_t> **Tail;
+    CbDataList<protocol_t> **Tail;
     char *t = NULL;
 
     for (Tail = &values; *Tail; Tail = &((*Tail)->next));
     while ((t = strtokFile())) {
-        List<protocol_t> *q = new List<protocol_t> (urlParseProtocol(t));
+        CbDataList<protocol_t> *q = new CbDataList<protocol_t> (urlParseProtocol(t));
         *(Tail) = q;
         Tail = &q->next;
     }
diff --git a/src/ACLProtocolData.h b/src/ACLProtocolData.h
index 1a162e4900..2e7b120118 100644
--- a/src/ACLProtocolData.h
+++ b/src/ACLProtocolData.h
@@ -37,7 +37,7 @@
 #define SQUID_ACLPROTOCOLDATA_H
 #include "ACL.h"
 #include "ACLData.h"
-#include "List.h"
+#include "CbDataList.h"
 
 class ACLProtocolData : public ACLData<protocol_t>
 {
@@ -55,7 +55,7 @@ public:
     bool empty() const;
     virtual ACLData<protocol_t> *clone() const;
 
-    List<protocol_t> *values;
+    CbDataList<protocol_t> *values;
 };
 
 MEMPROXY_CLASS_INLINE(ACLProtocolData);
diff --git a/src/ACLSslErrorData.cc b/src/ACLSslErrorData.cc
index 39a5035607..6b63f81aff 100644
--- a/src/ACLSslErrorData.cc
+++ b/src/ACLSslErrorData.cc
@@ -29,13 +29,13 @@ ACLSslErrorData::match(ssl_error_t toFind)
 
 /* explicit instantiation required for some systems */
 
-template cbdata_type List<ssl_error_t>::CBDATA_List;
+template cbdata_type CbDataList<ssl_error_t>::CBDATA_CbDataList;
 
 wordlist *
 ACLSslErrorData::dump()
 {
     wordlist *W = NULL;
-    List<ssl_error_t> *data = values;
+    CbDataList<ssl_error_t> *data = values;
 
     while (data != NULL) {
         wordlistAdd(&W, sslFindErrorString(data->element));
@@ -48,12 +48,12 @@ ACLSslErrorData::dump()
 void
 ACLSslErrorData::parse()
 {
-    List<ssl_error_t> **Tail;
+    CbDataList<ssl_error_t> **Tail;
     char *t = NULL;
 
     for (Tail = &values; *Tail; Tail = &((*Tail)->next));
     while ((t = strtokFile())) {
-        List<ssl_error_t> *q = new List<ssl_error_t>(sslParseErrorString(t));
+        CbDataList<ssl_error_t> *q = new CbDataList<ssl_error_t>(sslParseErrorString(t));
         *(Tail) = q;
         Tail = &q->next;
     }
diff --git a/src/ACLSslErrorData.h b/src/ACLSslErrorData.h
index 54230cd6cc..0e13ffa814 100644
--- a/src/ACLSslErrorData.h
+++ b/src/ACLSslErrorData.h
@@ -7,7 +7,7 @@
 #define SQUID_ACLSSL_ERRORDATA_H
 #include "ACL.h"
 #include "ACLData.h"
-#include "List.h"
+#include "CbDataList.h"
 #include "ssl_support.h"
 
 class ACLSslErrorData : public ACLData<ssl_error_t>
@@ -26,7 +26,7 @@ public:
     bool empty() const;
     virtual ACLData<ssl_error_t> *clone() const;
 
-    List<ssl_error_t> *values;
+    CbDataList<ssl_error_t> *values;
 };
 
 MEMPROXY_CLASS_INLINE(ACLSslErrorData);
diff --git a/src/CommRead.h b/src/CommRead.h
index 6b7d2a24f8..42d83334a7 100644
--- a/src/CommRead.h
+++ b/src/CommRead.h
@@ -43,7 +43,7 @@
 #include "squid.h"
 #include "comm.h"
 #include "CommCalls.h"
-#include "List.h"
+#include "CbDataList.h"
 
 class CommRead
 {
@@ -92,10 +92,10 @@ public:
 
 private:
     static PF CloseHandler;
-    static DeferredRead popHead(ListContainer<DeferredRead> &deferredReads);
+    static DeferredRead popHead(CbDataListContainer<DeferredRead> &deferredReads);
     void kickARead(DeferredRead const &);
     void flushReads();
-    ListContainer<DeferredRead> deferredReads;
+    CbDataListContainer<DeferredRead> deferredReads;
 };
 
 
diff --git a/src/StoreSearch.h b/src/StoreSearch.h
index 1f3e10f11e..ea9cfc2221 100644
--- a/src/StoreSearch.h
+++ b/src/StoreSearch.h
@@ -47,7 +47,7 @@ public:
     virtual ~StoreSearch() {}
 
     /* not ready yet
-    void asList(void (*) (List<StoreEntryPointer), void *cbdata);
+    void asList(void (*) (CbDataList<StoreEntryPointer), void *cbdata);
     */
     /* callback the client when a new StoreEntry is available
      * or an error occurs 
diff --git a/src/asn.cc b/src/asn.cc
index ce9f739adf..a0b3bffcfc 100644
--- a/src/asn.cc
+++ b/src/asn.cc
@@ -72,7 +72,7 @@ struct squid_radix_node_head *AS_tree_head;
 /* explicit instantiation required for some systems */
 
 /// \cond AUTODOCS-IGNORE
-template cbdata_type List<int>::CBDATA_List;
+template cbdata_type CbDataList<int>::CBDATA_CbDataList;
 /// \endcond
 
 /**
@@ -82,7 +82,7 @@ template cbdata_type List<int>::CBDATA_List;
  */
 struct as_info
 {
-    List<int> *as_number;
+    CbDataList<int> *as_number;
     time_t expires;		/* NOTUSED */
 };
 
@@ -128,13 +128,13 @@ static OBJH asnStats;
 /* PUBLIC */
 
 int
-asnMatchIp(List<int> *data, IPAddress &addr)
+asnMatchIp(CbDataList<int> *data, IPAddress &addr)
 {
     struct squid_radix_node *rn;
     as_info *e;
     m_ADDR m_addr;
-    List<int> *a = NULL;
-    List<int> *b = NULL;
+    CbDataList<int> *a = NULL;
+    CbDataList<int> *b = NULL;
 
     debugs(53, 3, "asnMatchIp: Called for " << addr );
 
@@ -174,7 +174,7 @@ asnMatchIp(List<int> *data, IPAddress &addr)
 void
 ACLASN::prepareForUse()
 {
-    for (List<int> *i = data; i; i = i->
+    for (CbDataList<int> *i = data; i; i = i->
                                      next)
         asnCacheStart(i->element);
 }
@@ -388,8 +388,8 @@ asnAddNet(char *as_string, int as_number)
     rtentry_t *e;
 
     struct squid_radix_node *rn;
-    List<int> **Tail = NULL;
-    List<int> *q = NULL;
+    CbDataList<int> **Tail = NULL;
+    CbDataList<int> *q = NULL;
     as_info *asinfo = NULL;
 
     IPAddress mask;
@@ -439,14 +439,14 @@ asnAddNet(char *as_string, int as_number)
             debugs(53, 3, "asnAddNet: Warning: Found a network with multiple AS numbers!");
 
             for (Tail = &asinfo->as_number; *Tail; Tail = &(*Tail)->next);
-            q = new List<int> (as_number);
+            q = new CbDataList<int> (as_number);
 
             *(Tail) = q;
 
             e->e_info = asinfo;
         }
     } else {
-        q = new List<int> (as_number);
+        q = new CbDataList<int> (as_number);
         asinfo = (as_info *)xmalloc(sizeof(as_info));
         asinfo->as_number = q;
         rn = squid_rn_addroute(&e->e_addr, &e->e_mask, AS_tree_head, e->e_nodes);
@@ -492,8 +492,8 @@ destroyRadixNode(struct squid_radix_node *rn, void *w)
 static void
 destroyRadixNodeInfo(as_info * e_info)
 {
-    List<int> *prev = NULL;
-    List<int> *data = e_info->as_number;
+    CbDataList<int> *prev = NULL;
+    CbDataList<int> *data = e_info->as_number;
 
     while (data) {
         prev = data;
@@ -509,7 +509,7 @@ printRadixNode(struct squid_radix_node *rn, void *_sentry)
 {
     StoreEntry *sentry = (StoreEntry *)_sentry;
     rtentry_t *e = (rtentry_t *) rn;
-    List<int> *q;
+    CbDataList<int> *q;
     as_info *asinfo;
     char buf[MAX_IPSTRLEN];
     IPAddress addr;
@@ -551,7 +551,7 @@ ACLASN::dump()
 {
     wordlist *W = NULL;
     char buf[32];
-    List<int> *ldata = data;
+    CbDataList<int> *ldata = data;
 
     while (ldata != NULL) {
         snprintf(buf, sizeof(buf), "%d", ldata->element);
@@ -571,14 +571,14 @@ ACLASN::empty () const
 void
 ACLASN::parse()
 {
-    List<int> **curlist = &data;
-    List<int> **Tail;
-    List<int> *q = NULL;
+    CbDataList<int> **curlist = &data;
+    CbDataList<int> **Tail;
+    CbDataList<int> *q = NULL;
     char *t = NULL;
 
     for (Tail = curlist; *Tail; Tail = &((*Tail)->next));
     while ((t = strtokFile())) {
-        q = new List<int> (atoi(t));
+        q = new CbDataList<int> (atoi(t));
         *(Tail) = q;
         Tail = &q->next;
     }
diff --git a/src/comm.cc b/src/comm.cc
index 6f07ef0882..63b2c40007 100644
--- a/src/comm.cc
+++ b/src/comm.cc
@@ -2509,13 +2509,13 @@ DeferredReadManager::~DeferredReadManager() {
 /* explicit instantiation required for some systems */
 
 /// \cond AUTODOCS-IGNORE
-template cbdata_type List<DeferredRead>::CBDATA_List;
+template cbdata_type CbDataList<DeferredRead>::CBDATA_CbDataList;
 /// \endcond
 
 void
 DeferredReadManager::delayRead(DeferredRead const &aRead) {
     debugs(5, 3, "Adding deferred read on FD " << aRead.theRead.fd);
-    List<DeferredRead> *temp = deferredReads.push_back(aRead);
+    CbDataList<DeferredRead> *temp = deferredReads.push_back(aRead);
     comm_add_close_handler (aRead.theRead.fd, CloseHandler, temp);
 }
 
@@ -2524,13 +2524,13 @@ DeferredReadManager::CloseHandler(int fd, void *thecbdata) {
     if (!cbdataReferenceValid (thecbdata))
         return;
 
-    List<DeferredRead> *temp = (List<DeferredRead> *)thecbdata;
+    CbDataList<DeferredRead> *temp = (CbDataList<DeferredRead> *)thecbdata;
 
     temp->element.markCancelled();
 }
 
 DeferredRead
-DeferredReadManager::popHead(ListContainer<DeferredRead> &deferredReads) {
+DeferredReadManager::popHead(CbDataListContainer<DeferredRead> &deferredReads) {
     assert (!deferredReads.empty());
 
     if (!deferredReads.head->element.cancelled)
@@ -2543,7 +2543,7 @@ DeferredReadManager::popHead(ListContainer<DeferredRead> &deferredReads) {
 
 void
 DeferredReadManager::kickReads(int const count) {
-    /* if we had List::size() we could consolidate this and flushReads */
+    /* if we had CbDataList::size() we could consolidate this and flushReads */
 
     if (count < 1) {
         flushReads();
@@ -2563,9 +2563,9 @@ DeferredReadManager::kickReads(int const count) {
 
 void
 DeferredReadManager::flushReads() {
-    ListContainer<DeferredRead> reads;
+    CbDataListContainer<DeferredRead> reads;
     reads = deferredReads;
-    deferredReads = ListContainer<DeferredRead>();
+    deferredReads = CbDataListContainer<DeferredRead>();
 
     while (!reads.empty()) {
         DeferredRead aRead = popHead(reads);