SourceLayout: shuffle forward.h/cc to FwdState.h/cc

Our convenience libraries are using the filename forward.h for forward
declarations of symbols. This clashes with the old deprecated naming
of src/forward.h at times.

Rename the src/forward.* files to FwdState.* inline with current coding
guidelines and add a source maintenance check to avoid this problem in
future.

diff --git a/scripts/source-maintenance.sh b/scripts/source-maintenance.sh
index b201f5110f5ec0518c7172ad0aaf562462990fb6..6a4a003de9ce4a15caae8015b229231dceafb382 100755 (executable)
--- a/scripts/source-maintenance.sh
+++ b/scripts/source-maintenance.sh
@@ -85,6 +85,15 @@ for FILENAME in `ls -1`; do
                ;;
        esac
 
+       #
+       # forward.h means different things to Squid code depending on the path
+       # require the full path is explicit for every include
+       #
+       FI=`grep "#include \"forward.h\"" ${FILENAME}`;
+       if test "x${FI}" != "x" ; then
+               echo "ERROR: ${PWD}/${FILENAME} contains reference to forward.h without path"
+       fi
+
        #
        # DEBUG Section list maintenance
        #

diff --git a/src/forward.cc b/src/FwdState.cc
similarity index 99%
rename from src/forward.cc
rename to src/FwdState.cc
index 8f309573bfab002624bf27d5ec1460179617244f..210fea6084aba019d70685f491bcd00fe6dbe526 100644 (file)
--- a/src/forward.cc
+++ b/src/FwdState.cc
@@ -47,8 +47,8 @@
 #include "event.h"
 #include "fd.h"
 #include "fde.h"
-#include "forward.h"
 #include "ftp.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "gopher.h"
 #include "hier_code.h"

diff --git a/src/forward.h b/src/FwdState.h
similarity index 100%
rename from src/forward.h
rename to src/FwdState.h

diff --git a/src/Makefile.am b/src/Makefile.am
index 8d1eac4011db2741b6c901e034b05d7982e096bd..7e6b392df8f32ce85ff2e6604a27f44dc24ad5ca 100644 (file)
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -349,12 +349,12 @@ squid_SOURCES = \
        fde.h \
        FileMap.h \
        filemap.cc \
-       forward.cc \
-       forward.h \
        fqdncache.h \
        fqdncache.cc \
        ftp.h \
        ftp.cc \
+       FwdState.cc \
+       FwdState.h \
        Generic.h \
        globals.h \
        gopher.h \
@@ -1444,11 +1444,12 @@ tests_testCacheManager_SOURCES = \
        fde.cc \
        FileMap.h \
        filemap.cc \
-       forward.cc \
        fqdncache.h \
        fqdncache.cc \
        ftp.h \
        ftp.cc \
+       FwdState.cc \
+       FwdState.h \
        gopher.h \
        gopher.cc \
        hier_code.h \
@@ -1854,11 +1855,12 @@ tests_testEvent_SOURCES = \
        fde.cc \
        FileMap.h \
        filemap.cc \
-       forward.cc \
        fqdncache.h \
        fqdncache.cc \
        ftp.h \
        ftp.cc \
+       FwdState.cc \
+       FwdState.h \
        gopher.h \
        gopher.cc \
        helper.cc \
@@ -2101,11 +2103,12 @@ tests_testEventLoop_SOURCES = \
        fde.cc \
        FileMap.h \
        filemap.cc \
-       forward.cc \
        fqdncache.h \
        fqdncache.cc \
        ftp.h \
        ftp.cc \
+       FwdState.cc \
+       FwdState.h \
        gopher.h \
        gopher.cc \
        helper.cc \
@@ -2345,11 +2348,12 @@ tests_test_http_range_SOURCES = \
        fde.cc \
        FileMap.h \
        filemap.cc \
-       forward.cc \
        fqdncache.h \
        fqdncache.cc \
        ftp.h \
        ftp.cc \
+       FwdState.cc \
+       FwdState.h \
        gopher.h \
        gopher.cc \
        helper.cc \
@@ -2640,11 +2644,12 @@ tests_testHttpRequest_SOURCES = \
        fd.h \
        fd.cc \
        fde.cc \
-       forward.cc \
        fqdncache.h \
        fqdncache.cc \
        ftp.h \
        ftp.cc \
+       FwdState.cc \
+       FwdState.h \
        gopher.h \
        gopher.cc \
        helper.cc \
@@ -3601,11 +3606,12 @@ tests_testURL_SOURCES = \
        fde.cc \
        FileMap.h \
        filemap.cc \
-       forward.cc \
        fqdncache.h \
        fqdncache.cc \
        ftp.h \
        ftp.cc \
+       FwdState.cc \
+       FwdState.h \
        gopher.h \
        gopher.cc \
        helper.cc \

diff --git a/src/Server.h b/src/Server.h
index 818f3ccd9026917ee027f8eedb816157ae623f97..c02c54c924b18d667e7e2b82ec19f96f8556c34b 100644 (file)
--- a/src/Server.h
+++ b/src/Server.h
@@ -32,11 +32,11 @@
 #ifndef SQUID_SERVER_H
 #define SQUID_SERVER_H
 
-#include "StoreIOBuffer.h"
-#include "forward.h"
 #include "BodyPipe.h"
 #include "base/AsyncJob.h"
 #include "CommCalls.h"
+#include "FwdState.h"
+#include "StoreIOBuffer.h"
 #if USE_ADAPTATION
 #include "adaptation/forward.h"
 #include "adaptation/Initiator.h"

diff --git a/src/acl/Asn.cc b/src/acl/Asn.cc
index 20ad65016f1da7c902c7618a0e53262b51c78515..00c313ad6d667ec0b40b6e9be862deeaefa903ba 100644 (file)
--- a/src/acl/Asn.cc
+++ b/src/acl/Asn.cc
@@ -39,7 +39,7 @@
 #include "acl/DestinationIp.h"
 #include "acl/SourceAsn.h"
 #include "cache_cf.h"
-#include "src/forward.h"
+#include "FwdState.h"
 #include "HttpReply.h"
 #include "HttpRequest.h"
 #include "ipcache.h"

diff --git a/src/adaptation/icap/Xaction.cc b/src/adaptation/icap/Xaction.cc
index 7aa2d374a1b7fcca405469a8249fc97908e2dbdc..8f82586f77460fc040e8f1e2105f030ee72859f0 100644 (file)
--- a/src/adaptation/icap/Xaction.cc
+++ b/src/adaptation/icap/Xaction.cc
@@ -15,7 +15,7 @@
 #include "CommCalls.h"
 #include "err_detail_type.h"
 #include "fde.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "HttpMsg.h"
 #include "HttpReply.h"

diff --git a/src/client_side.cc b/src/client_side.cc
index c4e3106198d22b0d2d467c5ee333a626d6befb43..f77fd825627f13fdabf91d78f78a590b7c93ddd4 100644 (file)
--- a/src/client_side.cc
+++ b/src/client_side.cc
@@ -100,8 +100,8 @@
 #include "errorpage.h"
 #include "fd.h"
 #include "fde.h"
-#include "forward.h"
 #include "fqdncache.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "http.h"
 #include "HttpHdrContRange.h"

diff --git a/src/client_side_reply.cc b/src/client_side_reply.cc
index d5272e85642eea9f205eb65633d4c86d77a2cbe4..f4758c61c7f102e32d0bebb295405fde723975bf 100644 (file)
--- a/src/client_side_reply.cc
+++ b/src/client_side_reply.cc
@@ -38,7 +38,7 @@
 #include "fd.h"
 #include "fde.h"
 #include "format/Token.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "globals.h"
 #include "HttpHeaderTools.h"

diff --git a/src/ftp.cc b/src/ftp.cc
index fa7a13fccd6ec78a41e3634a9692fa32e62a06f7..bcd173a15bbdb1ff09a56383db8471715ee6da8d 100644 (file)
--- a/src/ftp.cc
+++ b/src/ftp.cc
@@ -40,7 +40,7 @@
 #include "errorpage.h"
 #include "fd.h"
 #include "fde.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "html_quote.h"
 #include "HttpHdrContRange.h"
 #include "HttpHeader.h"

diff --git a/src/gopher.cc b/src/gopher.cc
index bd1df5112e359af6e7ab8216965d1b2565a46f88..0d99ff4433fc26b732bee1ba15192fbfaf813d7d 100644 (file)
--- a/src/gopher.cc
+++ b/src/gopher.cc
@@ -34,7 +34,7 @@
 #include "comm/Write.h"
 #include "errorpage.h"
 #include "fd.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "html_quote.h"
 #include "HttpReply.h"

diff --git a/src/icmp/net_db.cc b/src/icmp/net_db.cc
index 8f110cfcaad4262dca6deb0a505caa5ef19e1db8..c17d7754b514a4e4cb2662cff49f2f162b3db11c 100644 (file)
--- a/src/icmp/net_db.cc
+++ b/src/icmp/net_db.cc
@@ -44,7 +44,7 @@
 #include "disk.h"
 #include "event.h"
 #include "fde.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "HttpReply.h"
 #include "HttpRequest.h"
 #include "icmp/net_db.h"

diff --git a/src/main.cc b/src/main.cc
index ccbc6473a1f413d5880382379e616dd8fd6c7317..f6f034382115ebdc6b8fdeb81073730dedb76ed2 100644 (file)
--- a/src/main.cc
+++ b/src/main.cc
@@ -53,9 +53,9 @@
 #include "ExternalACL.h"
 #include "fd.h"
 #include "format/Token.h"
-#include "forward.h"
 #include "fs/Module.h"
 #include "fqdncache.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "htcp.h"
 #include "HttpHeader.h"

diff --git a/src/neighbors.cc b/src/neighbors.cc
index dba073d9593233648e8f25a642c0ae1c220451ac..16bab38a1ee305a162d7fc7700ca0101a0bdf89a 100644 (file)
--- a/src/neighbors.cc
+++ b/src/neighbors.cc
@@ -39,7 +39,7 @@
 #include "comm/Connection.h"
 #include "comm/ConnOpener.h"
 #include "event.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "htcp.h"
 #include "HttpRequest.h"

diff --git a/src/peer_digest.cc b/src/peer_digest.cc
index a00e26f3ac2f803d7f1ccad6e4d99d0f0cdf5ad2..ed91f01fed9e7f6eb352e6e4d751209ab3db78cd 100644 (file)
--- a/src/peer_digest.cc
+++ b/src/peer_digest.cc
@@ -36,7 +36,7 @@
 #include "CacheDigest.h"
 #include "CachePeer.h"
 #include "event.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "HttpReply.h"
 #include "HttpRequest.h"

diff --git a/src/peer_select.cc b/src/peer_select.cc
index 88e1be680419aaeafb9ce869af015ca3c3a5fdd6..440319483cde7e5889f67ca9817c3b86e7b232b5 100644 (file)
--- a/src/peer_select.cc
+++ b/src/peer_select.cc
@@ -38,7 +38,7 @@
 #include "DnsLookupDetails.h"
 #include "errorpage.h"
 #include "event.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "hier_code.h"
 #include "htcp.h"

diff --git a/src/ssl/ServerBump.cc b/src/ssl/ServerBump.cc
index 38e7234092a04412e6bd3489e3b1fdd12eb1cd01..44bae5e54494b9b62988b919c6ac074a8378bd56 100644 (file)
--- a/src/ssl/ServerBump.cc
+++ b/src/ssl/ServerBump.cc
@@ -6,7 +6,7 @@
 #include "squid.h"
 
 #include "client_side.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "ssl/ServerBump.h"
 #include "Store.h"
 #include "StoreClient.h"

diff --git a/src/urn.cc b/src/urn.cc
index 1b9d45b4fb377ce828f31ed82b3425a94e3c32a2..2d7c964312932760011266a585cdfeca76aeffba 100644 (file)
--- a/src/urn.cc
+++ b/src/urn.cc
@@ -32,7 +32,7 @@
 
 #include "squid.h"
 #include "errorpage.h"
-#include "forward.h"
+#include "FwdState.h"
 #include "globals.h"
 #include "HttpReply.h"
 #include "HttpRequest.h"

diff --git a/src/whois.cc b/src/whois.cc
index f163fea2e2a8b4b495d2db0e63f9a20206416c86..da1a4dbaf56fc7e0322d1921754ef2de301d8753 100644 (file)
--- a/src/whois.cc
+++ b/src/whois.cc
@@ -35,10 +35,10 @@
 #include "comm.h"
 #include "comm/Write.h"
 #include "errorpage.h"
+#include "FwdState.h"
 #include "HttpReply.h"
 #include "HttpRequest.h"
 #include "HttpRequest.h"
-#include "forward.h"
 #include "SquidConfig.h"
 #include "StatCounters.h"
 #include "Store.h"