netwerk/protocol/http/src/nsHttpHeaderArray.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Darin Fisher <darin@netscape.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsHttpHeaderArray_h__
  40 #define nsHttpHeaderArray_h__
  41
  42 #include "nsTArray.h"
  43 #include "nsIHttpChannel.h"
  44 #include "nsIHttpHeaderVisitor.h"
  45 #include "nsCOMPtr.h"
  46 #include "nsString.h"
  47 #include "nsHttp.h"
  48
  49 class nsHttpHeaderArray
  50 {
  51 public:
  52     nsHttpHeaderArray() {}
  53    ~nsHttpHeaderArray() { Clear(); }
  54
  55     const char *PeekHeader(nsHttpAtom header);
  56
  57     nsresult SetHeader(nsHttpAtom header, const nsACString &value, PRBool merge = PR_FALSE);
  58     nsresult GetHeader(nsHttpAtom header, nsACString &value);
  59     void     ClearHeader(nsHttpAtom h);
  60
  61     // Find the location of the given header value, or null if none exists.
  62     const char *FindHeaderValue(nsHttpAtom header, const char *value) {
  63         return nsHttp::FindToken(PeekHeader(header), value,
  64                                  HTTP_HEADER_VALUE_SEPS);
  65     }
  66
  67     // Determine if the given header value exists.
  68     PRBool HasHeaderValue(nsHttpAtom header, const char *value) {
  69         return FindHeaderValue(header, value) != nsnull;
  70     }
  71
  72     nsresult VisitHeaders(nsIHttpHeaderVisitor *visitor);
  73
  74     // parse a header line, return the header atom and a pointer to the
  75     // header value (the substring of the header line -- do not free).
  76     void ParseHeaderLine(char *line, nsHttpAtom *header=nsnull, char **value=nsnull);
  77
  78     void Flatten(nsACString &, PRBool pruneProxyHeaders=PR_FALSE);
  79
  80     PRUint32 Count() { return mHeaders.Length(); }
  81
  82     const char *PeekHeaderAt(PRUint32 i, nsHttpAtom &header);
  83
  84     void Clear();
  85
  86 private:
  87     struct nsEntry
  88     {
  89         nsEntry() {}
  90
  91         nsHttpAtom header;
  92         nsCString  value;
  93
  94         struct MatchHeader {
  95           PRBool Equals(const nsEntry &entry, const nsHttpAtom &header) const {
  96             return entry.header == header;
  97           }
  98         };
  99     };
 100
 101     PRInt32 LookupEntry(nsHttpAtom header, nsEntry **);
 102     PRBool  CanAppendToHeader(nsHttpAtom header);
 103
 104 private:
 105     nsTArray<nsEntry> mHeaders;
 106 };
 107
 108 #endif