Back to index

lightning-sunbird  0.9+nobinonly
nsHttpHeaderArray.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Darin Fisher <darin@netscape.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsHttpHeaderArray_h__
00040 #define nsHttpHeaderArray_h__
00041 
00042 #include "nsVoidArray.h"
00043 #include "nsIHttpChannel.h"
00044 #include "nsIHttpHeaderVisitor.h"
00045 #include "nsCOMPtr.h"
00046 #include "nsString.h"
00047 #include "nsHttp.h"
00048 
00049 class nsHttpHeaderArray
00050 {
00051 public:
00052     nsHttpHeaderArray() {}
00053    ~nsHttpHeaderArray() { Clear(); }
00054 
00055     const char *PeekHeader(nsHttpAtom header);
00056 
00057     nsresult SetHeader(nsHttpAtom header, const nsACString &value, PRBool merge = PR_FALSE);
00058     nsresult GetHeader(nsHttpAtom header, nsACString &value);
00059     void     ClearHeader(nsHttpAtom h);
00060 
00061     nsresult VisitHeaders(nsIHttpHeaderVisitor *visitor);
00062 
00063     // parse a header line, return the header atom and a pointer to the 
00064     // header value (the substring of the header line -- do not free).
00065     void ParseHeaderLine(char *line, nsHttpAtom *header=nsnull, char **value=nsnull);
00066 
00067     void Flatten(nsACString &, PRBool pruneProxyHeaders=PR_FALSE);
00068 
00069     PRUint32 Count() { return (PRUint32) mHeaders.Count(); }
00070 
00071     const char *PeekHeaderAt(PRUint32 i, nsHttpAtom &header);
00072 
00073     void Clear();
00074 
00075 private:
00076     struct nsEntry
00077     {
00078         nsEntry(nsHttpAtom h, const nsACString &v)
00079             : header(h) { value = v; }
00080 
00081         nsHttpAtom header;
00082         nsCString  value;
00083     };
00084 
00085     PRInt32 LookupEntry(nsHttpAtom header, nsEntry **);
00086     PRBool  CanAppendToHeader(nsHttpAtom header);
00087 
00088 private:
00089     nsAutoVoidArray mHeaders;
00090 };
00091 
00092 #endif