2001-02-23 13:18:01 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
|
|
*
|
2004-04-18 22:01:16 +00:00
|
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
2003-09-11 16:57:40 +00:00
|
|
|
*
|
2004-04-18 22:01:16 +00:00
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
2003-09-11 16:57:40 +00:00
|
|
|
*
|
2004-04-18 22:01:16 +00:00
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
2003-09-11 16:57:40 +00:00
|
|
|
*
|
2004-04-18 22:01:16 +00:00
|
|
|
* The Original Code is nsCacheMetaData.h, released
|
|
|
|
* February 22, 2001.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2001
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
2003-09-11 16:57:40 +00:00
|
|
|
*
|
|
|
|
* Contributor(s):
|
2004-04-18 22:01:16 +00:00
|
|
|
* Gordon Sheridan <gordon@netscape.com>
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
2001-02-23 13:18:01 +00:00
|
|
|
|
|
|
|
#ifndef _nsCacheMetaData_h_
|
|
|
|
#define _nsCacheMetaData_h_
|
|
|
|
|
|
|
|
#include "nspr.h"
|
|
|
|
#include "pldhash.h"
|
|
|
|
#include "nscore.h"
|
2007-08-30 17:51:07 +00:00
|
|
|
#include "nsString.h"
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2001-04-04 03:30:45 +00:00
|
|
|
class nsICacheMetaDataVisitor;
|
|
|
|
|
2001-02-23 13:18:01 +00:00
|
|
|
class nsCacheMetaData {
|
|
|
|
public:
|
|
|
|
nsCacheMetaData();
|
2003-03-25 15:20:10 +00:00
|
|
|
~nsCacheMetaData() { Clear(); }
|
2001-03-02 01:51:41 +00:00
|
|
|
|
2003-03-25 15:20:10 +00:00
|
|
|
void Clear();
|
|
|
|
PRBool IsEmpty() { return (mData == nsnull); }
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2003-03-25 15:20:10 +00:00
|
|
|
const char * GetElement(const char * key);
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2003-03-25 15:20:10 +00:00
|
|
|
nsresult SetElement(const char * key,
|
|
|
|
const char * value);
|
2001-02-23 13:18:01 +00:00
|
|
|
|
2003-09-11 16:57:40 +00:00
|
|
|
PRUint32 Size(void) { return mMetaSize; }
|
2001-03-13 15:43:17 +00:00
|
|
|
|
2001-06-13 23:37:41 +00:00
|
|
|
nsresult FlattenMetaData(char * buffer, PRUint32 bufSize);
|
2003-09-11 16:57:40 +00:00
|
|
|
|
2004-10-20 05:00:23 +00:00
|
|
|
nsresult UnflattenMetaData(const char * buffer, PRUint32 bufSize);
|
2001-02-28 07:13:32 +00:00
|
|
|
|
2001-04-04 03:30:45 +00:00
|
|
|
nsresult VisitElements(nsICacheMetaDataVisitor * visitor);
|
|
|
|
|
2001-02-23 13:18:01 +00:00
|
|
|
private:
|
2001-02-28 07:13:32 +00:00
|
|
|
|
2003-03-25 15:20:10 +00:00
|
|
|
struct MetaElement
|
|
|
|
{
|
|
|
|
struct MetaElement * mNext;
|
2007-08-30 17:51:07 +00:00
|
|
|
nsCString mKey;
|
2003-03-25 15:20:10 +00:00
|
|
|
char mValue[1]; // actually, bigger than 1
|
2001-02-28 07:13:32 +00:00
|
|
|
|
2003-03-25 15:20:10 +00:00
|
|
|
// MetaElement and mValue are allocated together via:
|
2003-09-11 16:57:40 +00:00
|
|
|
void *operator new(size_t size,
|
|
|
|
const char *value,
|
|
|
|
PRUint32 valueSize) CPP_THROW_NEW;
|
2003-03-25 15:20:10 +00:00
|
|
|
};
|
2001-02-28 07:13:32 +00:00
|
|
|
|
2003-03-25 15:20:10 +00:00
|
|
|
MetaElement * mData;
|
2003-09-11 16:57:40 +00:00
|
|
|
PRUint32 mMetaSize;
|
2001-02-23 13:18:01 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // _nsCacheMetaData_h
|