Merging tip to branch

git-svn-id: svn://10.0.0.236/branches/XPCOM_M4_BRANCH@25638 18797224-902f-48f8-a5cc-f745e15eee43

mozilla/netwerk/cache/Makefile.in

@@ -1,38 +0,0 @@
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-#
-
-DEPTH		= ../..
-topsrcdir	= @top_srcdir@
-srcdir		= @srcdir@
-VPATH		= @srcdir@
-
-include $(DEPTH)/config/autoconf.mk
-
-DIRS		= \
-        public \
-        memcache \
-        filecache \
-        mgr \
-        build \
-		$(NULL)
-
-include $(topsrcdir)/config/rules.mk
-

mozilla/netwerk/cache/Makefile.win

@@ -1,33 +0,0 @@
-#!gmake
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-
-DEPTH=..\..
-DIRS= 	\
-	public                  \
-	mgr			\
-	memcache		\
-	filecache		\
-	build                   \
-	$(NULL)
-
-include <$(DEPTH)\config\rules.mak>
-

mozilla/netwerk/cache/build/makefile.win

@@ -1,51 +0,0 @@
-#!gmake
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-
-DEPTH=..\..\..
-MODULE=nkcache
-
-MAKE_OBJ_TYPE=DLL
-DLLNAME=nkcache
-DLL=.\$(OBJDIR)\$(DLLNAME).dll
-
-CPP_OBJS=                                    \
-        .\$(OBJDIR)\nsNetDataCacheModule.obj \
-	$(NULL)
-
-LLIBS=                                \
-        $(DIST)\lib\nkcachemgr_s.lib  \
-        $(DIST)\lib\nkfilecache_s.lib \
-        $(DIST)\lib\nkmemcache_s.lib  \
-        $(DIST)\lib\dbm32.lib         \
-        $(DIST)\lib\xpcom.lib         \
-        $(LIBNSPR)  
-
-INCS = $(INCS)                             \
-        -I$(DEPTH)\netwerk\cache\memcache  \
-        -I$(DEPTH)\netwerk\cache\filecache \
-        -I$(DEPTH)\netwerk\cache\mgr       \
-        $(NULL)
-
-include <$(DEPTH)\config\rules.mak>
-
-install:: $(DLL)
-	$(MAKE_INSTALL) .\$(OBJDIR)\$(DLLNAME).dll $(DIST)\bin\components
-	$(MAKE_INSTALL) .\$(OBJDIR)\$(DLLNAME).lib $(DIST)\lib
-

mozilla/netwerk/cache/build/nsNetDataCacheModule.cpp

@@ -1,49 +0,0 @@
- /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-#include "nsCOMPtr.h"
-#include "nsIModule.h"
-#include "nscore.h"
-#include "nsIComponentManager.h"
-#include "nsIServiceManager.h"
-#include "nsIGenericFactory.h"
-
-#include "nsINetDataCache.h"
-#include "nsINetDataCacheManager.h"
-#include "nsMemCacheCID.h"
-#include "nsMemCache.h"
-#include "nsNetDiskCache.h"
-#include "nsNetDiskCacheCID.h"
-#include "nsCacheManager.h"
-
-// Factory method to create a new nsMemCache instance.  Used
-// by nsNetDataCacheModule
-NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(nsMemCache, Init)
-NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(nsNetDiskCache, Init)
-NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(nsCacheManager, Init)
-
-static nsModuleComponentInfo components[] = {
-    { "Memory Cache", NS_MEM_CACHE_FACTORY_CID, NS_NETWORK_MEMORY_CACHE_PROGID, nsMemCacheConstructor },
-    { "File Cache",   NS_NETDISKCACHE_CID,      NS_NETWORK_FILE_CACHE_PROGID,   nsNetDiskCacheConstructor },
-    { "Cache Manager",NS_CACHE_MANAGER_CID,     NS_NETWORK_CACHE_MANAGER_PROGID,nsCacheManagerConstructor }
-};
-
-NS_IMPL_NSGETMODULE("Network Data Cache", components)

mozilla/netwerk/cache/filecache/Makefile.in

@@ -1,60 +0,0 @@
-# 
-# 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/
-# 
-# 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.
-# 
-# The Original Code is Mozilla Communicator.
-# 
-# The Initial Developer of the Original Code is Intel Corp.
-# Portions created by Intel Corp. are
-# Copyright (C) 1999, 1999 Intel Corp.  All
-# Rights Reserved.
-# 
-# Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
-#                 Carl Wong <carl.wong@intel.com>
-# 
-
-DEPTH		= ../../..
-topsrcdir	= @top_srcdir@
-VPATH       = @srcdir@
-srcdir		= @srcdir@
-
-include $(DEPTH)/config/autoconf.mk
-
-MODULE = nkcache
-
-LIBRARY_NAME = nkfilecache_s
-
-REQUIRES	= nspr dbm 
-
-EXTRA_DSO_LDOPTS  +=  -L$(DIST)/lib  -lmozdbm_s
-
-EXPORTS=nsNetDiskCacheCID.h \
-	nsNetDiskCache.h \
-	nsIDBAccessor.h \
-	nsDBAccessor.h \
-	$(NULL)
-
-CPPSRCS		= \
-        nsDBAccessor.cpp\
-        nsDBEnumerator.cpp \
-        nsNetDiskCache.cpp \
-        nsDiskCacheRecord.cpp \
-        nsDiskCacheRecordChannel.cpp \
-		$(NULL)
-
-EXTRA_LIBS	= $(NSPR_LIBS) 
-
-# we don't want the shared lib, but we want to force the creation of a
-# static lib.
-override NO_SHARED_LIB=1
-override NO_STATIC_LIB=
-
-include $(topsrcdir)/config/rules.mk
-

mozilla/netwerk/cache/filecache/nsDBAccessor.cpp

@@ -1,416 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-/*
- * This file is part of filecache implementation.
- * 
- * nsIDBAccessor is a interface that shields all the direct database access 
- * method from nsNetDiskCache. 
- * 
- * nsDBAccessor is a implementation of the nsIDBAccessor interface. It
- * uses dbm(Berkely) as the database. 
- * 
- * a nsDiskCacheRecord is mapped into two entries in the database, 
- *    key->recordID
- *    recordID->metadata
- */
-
-#include "nsDBAccessor.h"
-#include "nscore.h"
-
-#include "prtypes.h"
-#include "plhash.h"
-#include "nsCRT.h"
-
-nsDBAccessor::nsDBAccessor() :
-  mDB(0) ,
-  mDBFile(0) ,
-  mSessionID(0) ,
-  mSessionCntr(0) ,
-  mDBFilesize(0) 
-{
-  mLastSyncTime = PR_IntervalNow() ;
-
-  NS_INIT_REFCNT();
-}
-
-nsDBAccessor::~nsDBAccessor()
-{
-  Shutdown() ;
-}
-
-//
-// Implement nsISupports methods
-//
-NS_IMPL_ISUPPORTS(nsDBAccessor, NS_GET_IID(nsIDBAccessor))
-
-
-///////////////////////////////////////////////////////////
-// nsIDBAccessor methods 
-
-NS_IMETHODIMP
-nsDBAccessor::Init(nsIFileSpec* dbfile)
-{
-  char* dbname ;
-
-  // this should cover all platforms. 
-  dbfile->GetNativePath(&dbname) ;
-  
-  mDBFile = dbfile ;
-
-  // FUR - how is page size chosen ?  It's worth putting a comment
-  // in here about the possible usefulness of tuning these parameters
-  HASHINFO hash_info = {
-    16*1024 , /* bucket size */
-    0 ,       /* fill factor */
-    0 ,       /* number of elements */
-    0 ,       /* bytes to cache */
-    0 ,       /* hash function */
-    0} ;      /* byte order */
-
-  mDB = dbopen(dbname,
-               O_RDWR | O_CREAT ,
-               0600 ,
-               DB_HASH ,
-               & hash_info) ;
-
-  nsCRT::free(dbname) ;
-
-  if(!mDB)
-    return NS_ERROR_FAILURE ;
-
-  // set mSessionID
-  DBT db_key, db_data ;
-
-  db_key.data = NS_CONST_CAST(char*, SessionKey) ;
-  db_key.size = PL_strlen(SessionKey) ;
-
-  int status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
-  if(status == -1) {
-    NS_ERROR("ERROR: failed get session id in database.") ;
-    return NS_ERROR_FAILURE ;
-  }
-
-  if(status == 0) {
-    // get the last session id
-    PRInt16 *old_ID = NS_STATIC_CAST(PRInt16*, db_data.data) ;
-    if(*old_ID < ini_sessionID) {
-      NS_ERROR("ERROR: Bad Session ID in database, corrupted db.") ;
-      return NS_ERROR_FAILURE ;
-    }
-
-    mSessionID = *old_ID + 1 ;
-  } 
-  else if(status == 1) {
-    // must be a new db
-    mSessionID = ini_sessionID ;
-  }
-  db_data.data = NS_REINTERPRET_CAST(void*, &mSessionID) ;
-  db_data.size = sizeof(PRInt16) ;
-
-  // store the new session id
-  status = (*mDB->put)(mDB, &db_key, &db_data, 0) ;
-
-  if(status == 0) {
-    (*mDB->sync)(mDB, 0) ;
-
-    // initialize database filesize
-    return mDBFile->GetFileSize(&mDBFilesize) ;
-  } 
-  else {
-    NS_ERROR("reset session ID failure.") ;
-    return NS_ERROR_FAILURE ;
-  }
-  
-}
-
-NS_IMETHODIMP
-nsDBAccessor::Shutdown(void)
-{
-  if(mDB) {
-    (*mDB->sync)(mDB, 0) ;
-    (*mDB->close)(mDB) ;
-    mDB = nsnull ;
-  }
-
-  return NS_OK ;
-}
-  
-NS_IMETHODIMP
-nsDBAccessor::Get(PRInt32 aID, void** anEntry, PRUint32 *aLength) 
-{
-  if(!anEntry)
-    return NS_ERROR_NULL_POINTER ;
-
-  *anEntry = nsnull ;
-  *aLength = 0 ;
-
-  NS_ASSERTION(mDB, "no database") ;
-
-  DBT db_key, db_data ;
-
-  db_key.data = NS_REINTERPRET_CAST(void*, &aID) ;
-  db_key.size = sizeof(PRInt32) ;
-  
-  int status = 0 ;
-  status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
-
-  if(status == 0) {
-    *anEntry = db_data.data ;
-    *aLength = db_data.size ;
-    return NS_OK ;
-  } 
-  else if(status == 1)
-    return NS_OK ;
-  else
-    return NS_ERROR_FAILURE ;
-
-}
-
-NS_IMETHODIMP
-nsDBAccessor::Put(PRInt32 aID, void* anEntry, PRUint32 aLength)
-{
-  NS_ASSERTION(mDB, "no database") ;
-
-  DBT db_key, db_data ;
-
-  db_key.data = NS_REINTERPRET_CAST(void*, &aID) ;
-  db_key.size = sizeof(PRInt32) ;
-
-  db_data.data = anEntry ;
-  db_data.size = aLength ;
-
-  if(0 == (*mDB->put)(mDB, &db_key, &db_data, 0)) {
-    return Sync() ;
-  }
-  else {
-    return NS_ERROR_FAILURE ;
-  }
-}
-
-/*
- * It's more important to remove the id->metadata entry first since
- * key->id mapping is just a reference
- */
-NS_IMETHODIMP
-nsDBAccessor::Del(PRInt32 aID, void* anEntry, PRUint32 aLength)
-{
-  NS_ASSERTION(mDB, "no database") ;
-
-  DBT db_key ;
-
-  // delete recordID->metadata
-  db_key.data = NS_REINTERPRET_CAST(void*, &aID) ;
-  db_key.size = sizeof(PRInt32) ;
-
-  PRInt32 status = -1 ;
-  status = (*mDB->del)(mDB, &db_key, 0) ;
-
-  if(-1 == status) {
-    return NS_ERROR_FAILURE ;
-  } 
-
-  // delete key->recordID
-  db_key.data = anEntry ;
-  db_key.size = aLength ;
-  status = (*mDB->del)(mDB, &db_key, 0) ;
-  if(-1 == status) {
-    return NS_ERROR_FAILURE ;
-  } 
-
-  return Sync() ;
-}
-
-NS_IMETHODIMP
-nsDBAccessor::GetID(const char* key, PRUint32 length, PRInt32* aID) 
-{
-  NS_ASSERTION(mDB, "no database") ;
-
-  DBT db_key, db_data ;
-
-  db_key.data = NS_CONST_CAST(char*, key) ;
-  db_key.size = length ;
-
-  int status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
-  if(status == 0) {
-    // found recordID
-    *aID = *(NS_REINTERPRET_CAST(PRInt32*, db_data.data)) ;
-    return NS_OK ;
-  }
-  else if(status == 1) {
-    // create a new one
-    PRInt32 id = 0 ;
-    id = mSessionID << 16 | mSessionCntr++ ;
-
-    // add new id into mDB
-    db_data.data = NS_REINTERPRET_CAST(void*, &id) ;
-    db_data.size = sizeof(PRInt32) ;
-
-    status = (*mDB->put)(mDB, &db_key, &db_data, 0) ;
-    if(status != 0) {
-      NS_ERROR("updating db failure.") ;
-      return NS_ERROR_FAILURE ;
-    }
-    *aID = id ;
-    return Sync() ;
-  } 
-  else {
-    NS_ERROR("ERROR: keydb failure.") ;
-    return NS_ERROR_FAILURE ;
-  }
-}
-
-NS_IMETHODIMP
-nsDBAccessor::EnumEntry(void** anEntry, PRUint32* aLength, PRBool bReset) 
-{
-  if(!anEntry)
-    return NS_ERROR_NULL_POINTER ;
-
-  *anEntry = nsnull ;
-  *aLength = 0 ;
-
-  NS_ASSERTION(mDB, "no database") ;
-
-  PRUint32 flag ;
-
-  if(bReset) 
-    flag = R_FIRST ;
-  else
-    flag = R_NEXT ;
-
-  DBT db_key, db_data ;
-
-  PRUint32 len = PL_strlen(SessionKey) ;
-
-  int status ;
-
-  do {
-    status = (*mDB->seq)(mDB, &db_key, &db_data, flag) ;
-    flag = R_NEXT ;
-    if(status == -1)
-      return NS_ERROR_FAILURE ;
-    // get next if it's a key->recordID 
-    if(db_key.size > sizeof(PRInt32) && db_data.size == sizeof(PRInt32))
-      continue ;
-    // get next if it's a sessionID entry
-    if(db_key.size == len && db_data.size == sizeof(PRInt16))
-      continue ;
-    // recordID is always 32 bits long
-    if(db_key.size == sizeof(PRInt32))
-      break ;
-  } while(!status) ;
-
-  if (0 == status) {
-    *anEntry = db_data.data ;
-    *aLength = db_data.size ;
-  }
-  return NS_OK ;
-}
-
-/*
- * returns the cached database file size.
- * mDBFilesize will be updated during Sync().
- */
-NS_IMETHODIMP
-nsDBAccessor::GetDBFilesize(PRUint32* aSize)
-{
-  *aSize = mDBFilesize ;
-  return NS_OK ; 
-}
-
-NS_IMETHODIMP
-nsDBAccessor::GetSpecialEntry(void** anEntry, PRUint32* aLength)
-{
-  if(!anEntry)
-    return NS_ERROR_NULL_POINTER ;
-
-  *anEntry = nsnull ;
-  *aLength = 0 ;
-
-  DBT db_key, db_data ;
-
-  db_key.data = NS_CONST_CAST(char*, SpecialEntry) ;
-  db_key.size = PL_strlen(SpecialEntry) ;
-
-  int status = (*mDB->get)(mDB, &db_key, &db_data, 0) ;
-
-  if(status == -1) {
-    NS_ERROR("ERROR: failed get special entry in database.") ;
-    return NS_ERROR_FAILURE ;
-  }
-
-  if(status == 0) {
-    *anEntry = db_data.data ;
-    *aLength = db_data.size ;
-  } 
-  
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDBAccessor::SetSpecialEntry(void* anEntry, PRUint32 aLength)
-{
-  DBT db_key, db_data ;
-
-  db_key.data = NS_CONST_CAST(char*, SpecialEntry) ;
-  db_key.size = PL_strlen(SpecialEntry) ;
-
-  db_data.data = anEntry ;
-  db_data.size = aLength ;
-
-  if(0 == (*mDB->put)(mDB, &db_key, &db_data, 0)) {
-    (*mDB->sync)(mDB, 0) ;
-    return NS_OK ;
-  }
-  else {
-    return NS_ERROR_FAILURE ;
-  }
-}
-
-/*
- * sync routine is only called when the SyncInterval is reached. Otherwise
- * it just returns. If db synced, the filesize will be updated at the
- * same time.
- */
-nsresult
-nsDBAccessor::Sync(void)
-{
-  PRIntervalTime time = PR_IntervalNow() ;
-  PRIntervalTime duration = time - mLastSyncTime ;
-  
-  if (PR_IntervalToMilliseconds(duration) > SyncInterval) {
-    int status = (*mDB->sync)(mDB, 0) ;
-    if(status == 0) {
-//      printf("\tsynced\n") ;
-      mLastSyncTime = time ;
-      
-      // update db filesize here
-      return mDBFile->GetFileSize(&mDBFilesize) ;
-      
-    } else
-      return NS_ERROR_FAILURE ;
-  } else {
-//    printf("\tnot synced\n") ;
-    return NS_OK ;
-  }
-}

mozilla/netwerk/cache/filecache/nsDBAccessor.h

@@ -1,93 +0,0 @@
-/*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-/*
- * This file is part of filecache implementation.
- * 
- * nsIDBAccessor is a interface that shields all the direct database access 
- * method from nsNetDiskCache. 
- * 
- * nsDBAccessor is a implementation of the nsIDBAccessor interface. It
- * uses dbm(Berkely) as the database. 
- *
- */
-
-#ifndef _NSIDBACCESSOR_H_
-#define _NSIDBACCESSOR_H_
-
-#include "nsIDBAccessor.h"
-#include "mcom_db.h"
-#include "prinrval.h"
-#include "nsCOMPtr.h"
-
-// bogus string for the key of session id 
-static const char * const SessionKey = "SK" ;
-
-// bogus string for the size 
-static const char * const SpecialEntry = "SE" ;
-
-// initial session id number 
-static const PRInt16 ini_sessionID = 0xff ;
-
-static const PRUint16 SyncInterval = 1000 ;
-
-class nsDBAccessor : public nsIDBAccessor
-{
-  public:
-  NS_DECL_ISUPPORTS
-
-  nsDBAccessor() ;
-  virtual ~nsDBAccessor() ;
-  
-  NS_IMETHOD Init(nsIFileSpec* dbfile) ;
-  NS_IMETHOD Shutdown(void) ; 
-
-  NS_IMETHOD Put(PRInt32 aID, void* anEntry, PRUint32 aLength) ;
-
-  NS_IMETHOD Get(PRInt32 aID, void** anEntry, PRUint32 *aLength) ;
-
-  NS_IMETHOD Del(PRInt32 aID, void* anEntry, PRUint32 aLength) ;
-
-  NS_IMETHOD GetID(const char* key, PRUint32 length, PRInt32* aID) ;
-
-  NS_IMETHOD EnumEntry(void* *anEntry, PRUint32* aLength, PRBool bReset) ;
-  
-  NS_IMETHOD GetDBFilesize(PRUint32* aSize) ;
-  
-  NS_IMETHOD GetSpecialEntry(void** anEntry, PRUint32 *aLength) ;
-  NS_IMETHOD SetSpecialEntry(void* anEntry, PRUint32 aLength) ;
-
-  protected:
-  nsresult Sync(void) ;
-
-  private:
-  DB *                          mDB ;
-  nsCOMPtr<nsIFileSpec>         mDBFile ;
-  PRInt16                       mSessionID ;
-  PRInt16                       mSessionCntr ;
-  PRIntervalTime                mLastSyncTime ;
-  PRUint32                      mDBFilesize ; // cached DB filesize, 
-                                              // updated on every sync for now
-} ;
-
-#endif // _NSIDBACCESSOR_H_

mozilla/netwerk/cache/filecache/nsDBEnumerator.cpp

@@ -1,108 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-/*
- * This file is part of filecache implementation.
- *
- * It implements a simple iterator for the database, see nsDBAccessor. 
- */
-
-#include "nsDBEnumerator.h"
-#include "nsDiskCacheRecord.h"
-
-nsDBEnumerator::nsDBEnumerator(nsIDBAccessor* aDB, nsNetDiskCache* aCache) :
-  m_DB(aDB) ,
-  m_DiskCache(aCache) ,
-  m_tempEntry(0) ,
-  m_tempEntry_length(0) ,
-  m_CacheEntry(0) ,
-  m_bReset(PR_TRUE) 
-{
-  NS_INIT_REFCNT();
-
-}
-
-nsDBEnumerator::~nsDBEnumerator()
-{
-  NS_IF_RELEASE(m_CacheEntry) ;
-}
-
-//
-// Implement nsISupports methods
-//
-NS_IMPL_ISUPPORTS(nsDBEnumerator, NS_GET_IID(nsIEnumerator))
-
-/////////////////////////////////////////////////////////////////
-// nsISimpleEnumerator methods
-
-NS_IMETHODIMP
-nsDBEnumerator::HasMoreElements(PRBool *_retval)
-{
-  *_retval = PR_FALSE ;
-
-  nsresult rv = m_DB->EnumEntry(&m_tempEntry, &m_tempEntry_length, m_bReset) ;
-
-  if(NS_FAILED(rv)) {
-    // do some error recovery
-    m_DiskCache->DBRecovery() ;
-    return rv ;
-  }
-
-  m_bReset = PR_FALSE ;
-
-  if(m_tempEntry && m_tempEntry_length != 0)
-    *_retval = PR_TRUE ;
-
-  return NS_OK ;
-}
-
-// this routine does not create a new item by itself  
-// Rather it reuses the item inside the object. So if you need to use the 
-// item later, you have to
-// create a new item specifically, using copy constructor or some other dup 
-// function. And don't forget to release it after you're done
-//
-NS_IMETHODIMP
-nsDBEnumerator::GetNext(nsISupports **_retval)
-{
-  if(!m_CacheEntry) {
-    m_CacheEntry = new nsDiskCacheRecord(m_DB, m_DiskCache) ;
-    if(m_CacheEntry)
-      NS_ADDREF(m_CacheEntry) ;
-    else
-      return NS_ERROR_OUT_OF_MEMORY ;
-  }
-
-  if(!_retval)
-    return NS_ERROR_NULL_POINTER ;
-  *_retval = nsnull ;
-
-  nsresult rv = m_CacheEntry->RetrieveInfo(m_tempEntry, m_tempEntry_length) ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  *_retval = NS_STATIC_CAST(nsISupports*, m_CacheEntry) ;
-  NS_ADDREF(*_retval) ; // all good getter addref 
-
-  return NS_OK ;
-}

mozilla/netwerk/cache/filecache/nsDBEnumerator.h

@@ -1,60 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-/*
- * This file is part of filecache implementation.
- *
- * It implements a simple iterator for the database, see nsDBAccessor. 
- */
-
-#ifndef _NS_DBENUMERATOR_H_
-#define _NS_DBENUMERATOR_H_
-
-#include "nsISimpleEnumerator.h"
-#include "nsINetDataCacheRecord.h"
-#include "nsIDBAccessor.h"
-#include "nsCOMPtr.h"
-#include "nsNetDiskCache.h"
-#include "nsDiskCacheRecord.h"
-
-class nsCachedDiskData ; /* forward decl */
-
-class nsDBEnumerator : public nsISimpleEnumerator {
-public:
-    NS_DECL_ISUPPORTS
-
-    NS_DECL_NSISIMPLEENUMERATOR 
-
-    nsDBEnumerator(nsIDBAccessor* aDB, nsNetDiskCache* aCache) ;
-    virtual ~nsDBEnumerator() ;
-
-private:
-    nsCOMPtr<nsIDBAccessor>                m_DB ;
-    nsCOMPtr<nsNetDiskCache>               m_DiskCache ;
-    void *                                 m_tempEntry ;
-    PRUint32                               m_tempEntry_length ;
-    nsDiskCacheRecord*                     m_CacheEntry ;
-    PRBool                                 m_bReset ;
-};
-
-#endif // _NS_DBENUMERATOR_H_

mozilla/netwerk/cache/filecache/nsDiskCacheRecord.cpp

@@ -1,456 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-#include "nsDiskCacheRecord.h"
-#include "nsINetDataDiskCache.h"
-#include "nsNetDiskCacheCID.h"
-#include "nsDiskCacheRecordChannel.h"
-#include "nsFileStream.h"
-
-#include "nsIComponentManager.h"
-#include "nsIServiceManager.h"
-#include "nsIProtocolHandler.h"
-#include "nsIIOService.h"
-#include "nsIAllocator.h"
-
-#include "plstr.h"
-#include "prprf.h"
-#include "prmem.h"
-#include "prlog.h"
-#include "prtypes.h"
-#include "netCore.h"
-
-#include "nsDBAccessor.h"
-
-#if !defined(IS_LITTLE_ENDIAN) && !defined(IS_BIG_ENDIAN)
-ERROR! Must have a byte order
-#endif
-
-#ifdef IS_LITTLE_ENDIAN
-#define COPY_INT32(_a,_b)  memcpy(_a, _b, sizeof(int32))
-#else
-#define COPY_INT32(_a,_b)  /* swap */                   \
-    do {                                                \
-    ((char *)(_a))[0] = ((char *)(_b))[3];              \
-    ((char *)(_a))[1] = ((char *)(_b))[2];              \
-    ((char *)(_a))[2] = ((char *)(_b))[1];              \
-    ((char *)(_a))[3] = ((char *)(_b))[0];              \
-    } while(0)
-#endif
-
-nsDiskCacheRecord::nsDiskCacheRecord(nsIDBAccessor* db, nsNetDiskCache* aCache) :
-  mKey(0) ,
-  mKeyLength(0) ,
-  mRecordID(0) ,
-  mMetaData(0) ,
-  mMetaDataLength(0) ,
-  mDB(db) ,
-  mInfo(0) ,
-  mInfoSize(0) ,
-  mNumChannels(0) ,
-  mDiskCache(aCache) 
-{
-  NS_INIT_REFCNT();
-  NS_ASSERTION(mDiskCache, "Must have an nsNetDiskCache");
-  NS_ADDREF(mDiskCache);
-}
-
-// mem alloced. so caller should do free() on key. 
-NS_IMETHODIMP
-nsDiskCacheRecord::Init(const char* key, PRUint32 length, PRInt32 ID) 
-{
-  NS_NewFileSpec(getter_AddRefs(mFile));
-  if(!mFile)
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  // copy key
-  mKeyLength = length ;
-  mKey = NS_STATIC_CAST(char*, nsAllocator::Alloc(mKeyLength*sizeof(char))) ;
-  if(!mKey) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  memcpy(mKey, key, length) ;
-
-  // get RecordID
-  mRecordID = ID ;
-
-  // setup the file name
-  nsCOMPtr<nsIFileSpec> dbFolder ;
-  mDiskCache->GetDiskCacheFolder(getter_AddRefs(dbFolder)) ;
-
-  nsresult rv = mFile->FromFileSpec(dbFolder) ;
-  if(NS_FAILED(rv))
-    return NS_ERROR_FAILURE ;
-
-  // dir is a hash result of mRecordID%32, hope it's enough 
-  char filename[9], dirName[3] ;
-  
-  PR_snprintf(dirName, 3, "%02x", (((PRUint32)mRecordID) % 32)) ;
-  mFile->AppendRelativeUnixPath(dirName) ;
-
-  PR_snprintf(filename, 9, "%08x", mRecordID) ;
-  mFile->AppendRelativeUnixPath(filename) ;
-
-  return NS_OK ;
-}
-
-nsDiskCacheRecord::~nsDiskCacheRecord()
-{
-  if(mKey)
-    nsAllocator::Free(mKey) ;
-  if(mMetaData)
-    nsAllocator::Free(mMetaData) ;
-  if(mInfo) 
-    nsAllocator::Free(mInfo) ;
-
-  NS_IF_RELEASE(mDiskCache);
-}
-
-//
-// Implement nsISupports methods
-//
-NS_IMPL_ISUPPORTS(nsDiskCacheRecord, NS_GET_IID(nsINetDataCacheRecord))
-
-///////////////////////////////////////////////////////////////////////
-// nsINetDataCacheRecord methods
-
-// yes, mem alloced on *_retval.
-NS_IMETHODIMP
-nsDiskCacheRecord::GetKey(PRUint32 *length, char** _retval) 
-{
-  if(!_retval)
-    return NS_ERROR_NULL_POINTER ;
-
-  *length = mKeyLength ;
-  *_retval = NS_STATIC_CAST(char*, nsAllocator::Alloc(mKeyLength*sizeof(char))) ;
-  if(!*_retval)
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  memcpy(*_retval, mKey, mKeyLength) ;
-
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecord::GetRecordID(PRInt32* aRecordID)
-{
-  *aRecordID = mRecordID ;
-  return NS_OK ;
-}
-
-// yes, mem alloced on *_retval. 
-NS_IMETHODIMP
-nsDiskCacheRecord::GetMetaData(PRUint32 *length, char **_retval) 
-{
-  if(!_retval)
-    return NS_ERROR_NULL_POINTER ;
-
-  // always null the return value first. 
-  *_retval = nsnull ;
-
-  *length = mMetaDataLength ;
-
-  if(mMetaDataLength) {
-    *_retval = NS_STATIC_CAST(char*, nsAllocator::Alloc(mMetaDataLength*sizeof(char))) ;
-    if(!*_retval)
-      return NS_ERROR_OUT_OF_MEMORY ;
-
-    memcpy(*_retval, mMetaData, mMetaDataLength) ;
-  }
-
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecord::SetMetaData(PRUint32 length, const char* data)
-{
-  // set the mMetaData
-  mMetaDataLength = length ;
-  if(mMetaData)
-    nsAllocator::Free(mMetaData) ;
-  mMetaData = NS_STATIC_CAST(char*, nsAllocator::Alloc(mMetaDataLength*sizeof(char))) ;
-  if(!mMetaData) {
-    return NS_ERROR_OUT_OF_MEMORY ;
-  }
-  memcpy(mMetaData, data, length) ;
-
-  // Generate mInfo
-  nsresult rv = GenInfo() ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  // write through into mDB
-  rv = mDB->Put(mRecordID, mInfo, mInfoSize) ;
-
-  return rv ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecord::GetStoredContentLength(PRUint32 *aStoredContentLength)
-{
-  return mFile->GetFileSize(aStoredContentLength) ;
-}
-
-// untill nsIFileSpec::Truncate() is in, we have to do all this ugly stuff
-NS_IMETHODIMP
-nsDiskCacheRecord::SetStoredContentLength(PRUint32 aStoredContentLength)
-{
-  PRUint32 len = 0 ;
-  nsresult rv = mFile->GetFileSize(&len) ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  if(len < aStoredContentLength)
-  {
-    NS_ERROR("Error: can not set filesize to something bigger than itself.\n") ;
-    return NS_ERROR_FAILURE ;
-  }
-  else {
-    rv = mFile->Truncate(aStoredContentLength) ;
-    if(NS_FAILED(rv))
-      return rv ;
-    
-    mDiskCache->m_StorageInUse -= (len - aStoredContentLength) ;
-    return NS_OK ;
-  }
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecord::Delete(void)
-{
-  if(mNumChannels)
-    return NS_ERROR_NOT_AVAILABLE ;
-
-  PRUint32 len ;
-  mFile->GetFileSize(&len) ;
-
-  nsFileSpec cache_file ;
-  nsresult rv = mFile->GetFileSpec(&cache_file) ;
-
-  if(NS_FAILED(rv)) 
-    return NS_ERROR_FAILURE ;
-
-  cache_file.Delete(PR_TRUE) ;
-
-  // updata the storage size
-  mDiskCache->m_StorageInUse -= len ;
-
-  rv = mDB->Del(mRecordID, mKey, mKeyLength) ;
-  if(NS_FAILED(rv)) 
-    return NS_ERROR_FAILURE ;
-  else
-    return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecord::GetFilename(nsIFileSpec * *aFilename) 
-{
-  if(!aFilename)
-    return NS_ERROR_NULL_POINTER ;
-
-  *aFilename = mFile ;
-  NS_ADDREF(*aFilename) ;
-
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecord::NewChannel(nsILoadGroup *loadGroup, nsIChannel **_retval) 
-{
-  nsDiskCacheRecordChannel* channel = new nsDiskCacheRecordChannel(this, loadGroup) ;
-  if(!channel) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  nsresult rv = channel->Init() ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  NS_ADDREF(channel) ;
-  *_retval = NS_STATIC_CAST(nsIChannel*, channel) ;
-  return NS_OK ;
-}
-
-//////////////////////////////////////////////////////////////////////////
-// nsDiskCacheRecord methods
-
-// file name is represented by a url string. I hope this would be more
-// generic
-nsresult
-nsDiskCacheRecord::GenInfo() 
-{
-  if(mInfo)
-    nsAllocator::Free(mInfo) ;
-
-  char* file_url=nsnull ;
-  PRUint32 name_len ;
-  mFile->GetURLString(&file_url) ;
-  name_len = PL_strlen(file_url)+1 ;
-
-  mInfoSize  = sizeof(PRUint32) ;    // checksum for mInfoSize
-  mInfoSize += sizeof(PRInt32) ;     // RecordID
-  mInfoSize += sizeof(PRUint32) ;    // key length
-  mInfoSize += mKeyLength ;          // key 
-  mInfoSize += sizeof(PRUint32) ;    // metadata length
-  mInfoSize += mMetaDataLength ;     // metadata 
-  mInfoSize += sizeof(PRUint32) ;    // filename length
-  mInfoSize += name_len ;            // filename 
-
-  void* newInfo = nsAllocator::Alloc(mInfoSize*sizeof(char)) ;
-  if(!newInfo) {
-    return NS_ERROR_OUT_OF_MEMORY ;
-  }
-
-  // copy the checksum mInfoSize
-  char* cur_ptr = NS_STATIC_CAST(char*, newInfo) ;
-  COPY_INT32(cur_ptr, &mInfoSize) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // copy RecordID
-  COPY_INT32(cur_ptr, &mRecordID) ;
-  cur_ptr += sizeof(PRInt32) ;
-
-  // copy key length
-  COPY_INT32(cur_ptr, &mKeyLength) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // copy key
-  memcpy(cur_ptr, mKey, mKeyLength) ;
-  cur_ptr += mKeyLength ;
-
-  // copy metadata length
-  COPY_INT32(cur_ptr, &mMetaDataLength) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // copy metadata
-  memcpy(cur_ptr, mMetaData, mMetaDataLength) ;
-  cur_ptr += mMetaDataLength ;
-
-  // copy file name length 
-  COPY_INT32(cur_ptr, &name_len) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // copy file name
-  memcpy(cur_ptr, file_url, name_len) ;
-  cur_ptr += name_len ;
-
-  PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, newInfo) + mInfoSize);
-  mInfo = newInfo ;
-
-  return NS_OK ;
-}
-
-/*
- * This Method suppose to get all the info from the db record
- * and set them to accroding members. the original values
- * will all be overwritten. only minimal error checking is performed.
- */
-NS_IMETHODIMP
-nsDiskCacheRecord::RetrieveInfo(void* aInfo, PRUint32 aInfoLength) 
-{
-  // reset everything
-  if(mInfo) {
-    nsAllocator::Free(mInfo) ;
-    mInfo = nsnull ;
-  }
-
-  if(mKey) {
-    nsAllocator::Free(mKey) ;
-    mKey = nsnull ;
-  }
-  if(mMetaData) {
-    nsAllocator::Free(mMetaData) ;
-    mMetaData = nsnull ;
-  }
-
-  char * cur_ptr = NS_STATIC_CAST(char*, aInfo) ;
-
-  char* file_url ;
-  PRUint32 name_len ;
-
-  // set mInfoSize 
-  COPY_INT32(&mInfoSize, cur_ptr) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // check this at least
-  if(mInfoSize != aInfoLength) 
-    return NS_ERROR_FAILURE ;
-
-  // set mRecordID 
-  COPY_INT32(&mRecordID, cur_ptr) ;
-  cur_ptr += sizeof(PRInt32) ;
-
-  // set mKeyLength
-  COPY_INT32(&mKeyLength, cur_ptr) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // set mKey
-  mKey = NS_STATIC_CAST(char*, nsAllocator::Alloc(mKeyLength*sizeof(char))) ;
-  if(!mKey) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-  
-  memcpy(mKey, cur_ptr, mKeyLength) ;
-  cur_ptr += mKeyLength ;
-
-  PRInt32 id ;
-  mDB->GetID(mKey, mKeyLength, &id) ;
-  NS_ASSERTION(id==mRecordID, "\t ++++++ bad record, somethings wrong\n") ;
-
-  // set mMetaDataLength
-  COPY_INT32(&mMetaDataLength, cur_ptr) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // set mMetaData
-  mMetaData = NS_STATIC_CAST(char*, nsAllocator::Alloc(mMetaDataLength*sizeof(char))) ;
-  if(!mMetaData) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-  
-  memcpy(mMetaData, cur_ptr, mMetaDataLength) ;
-  cur_ptr += mMetaDataLength ;
-
-  // get mFile name length
-  COPY_INT32(&name_len, cur_ptr) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  // get mFile native name
-  file_url = NS_STATIC_CAST(char*, nsAllocator::Alloc(name_len*sizeof(char))) ;
-  if(!file_url) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-  
-  memcpy(file_url, cur_ptr, name_len) ;
-  cur_ptr += name_len ;
-
-  PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, aInfo) + mInfoSize);
-
-  // create mFile if Init() isn't called 
-  if(!mFile) {
-    NS_NewFileSpec(getter_AddRefs(mFile));
-    if(!mFile)
-      return NS_ERROR_OUT_OF_MEMORY ;
-  }
-
-  // setup mFile
-  mFile->SetURLString(file_url) ;
-
-  return NS_OK ;
-}
-

mozilla/netwerk/cache/filecache/nsDiskCacheRecord.h

@@ -1,71 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-#ifndef _NET_CACHEDDISKDATA_H_
-#define _NET_CACHEDDISKDATA_H_
-
-#include "nsINetDataCacheRecord.h"
-#include "nsCOMPtr.h"
-#include "nsIDBAccessor.h"
-#include "prtypes.h"
-#include "nsILoadGroup.h"
-#include "nsIFileChannel.h" 
-#include "nsNetDiskCache.h"
-
-class nsDiskCacheRecord : public nsINetDataCacheRecord
-{
-  public:
-
-  NS_DECL_ISUPPORTS
-  NS_DECL_NSINETDATACACHERECORD
-
-  protected: 
-
-  nsDiskCacheRecord(nsIDBAccessor* db, nsNetDiskCache* aCache) ;
-  virtual ~nsDiskCacheRecord() ;
-
-  NS_IMETHOD RetrieveInfo(void* aInfo, PRUint32 aInfoLength) ;
-  NS_IMETHOD Init(const char* key, PRUint32 length, PRInt32 ID) ;
-
-  nsresult GenInfo(void) ;
-
-  private:
-
-  char*                     mKey ;
-  PRUint32                  mKeyLength ;
-  PRInt32                   mRecordID ;
-  char*                     mMetaData ;
-  PRUint32                  mMetaDataLength ;
-  nsCOMPtr<nsIFileSpec>     mFile ;
-  nsCOMPtr<nsIDBAccessor>            mDB ; 
-  void*                     mInfo ;
-  PRUint32                  mInfoSize ;
-  PRUint32                  mNumChannels ;
-  nsNetDiskCache*           mDiskCache ;
-
-  friend class nsDiskCacheRecordChannel ;
-  friend class nsDBEnumerator ;
-  friend class nsNetDiskCache ;
-} ;
-
-#endif // _NET_CACHEDDISKDATA_H_

mozilla/netwerk/cache/filecache/nsDiskCacheRecordChannel.cpp

@@ -1,552 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-/*
- * Most of the code are taken from nsFileChannel.  
- */
-
-#include "nsDiskCacheRecordChannel.h"
-#include "nsIFileTransportService.h"
-//#include "nsIIOService.h"
-#include "nsIServiceManager.h"
-#include "nsIURL.h"
-#include "nsIOutputStream.h"
-#include "netCore.h"
-#include "nsIMIMEService.h"
-#include "nsISupportsUtils.h"
-
-//static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_CID);
-static NS_DEFINE_CID(kFileTransportServiceCID, NS_FILETRANSPORTSERVICE_CID);
-static NS_DEFINE_CID(kStandardURLCID, NS_STANDARDURL_CID);
-static NS_DEFINE_CID(kMIMEServiceCID, NS_MIMESERVICE_CID);
-
-// This is copied from nsMemCacheChannel, We should consolidate these two.
-class WriteStreamWrapper : public nsIOutputStream 
-{
-  public:
-  WriteStreamWrapper(nsDiskCacheRecordChannel* aChannel,
-                     nsIOutputStream *aBaseStream) ;
-
-  virtual ~WriteStreamWrapper() ;
-
-  static nsresult
-  Create(nsDiskCacheRecordChannel* aChannel, nsIOutputStream *aBaseStream, nsIOutputStream* *aWrapper) ;
-
-  NS_DECL_ISUPPORTS
-  NS_DECL_NSIBASESTREAM
-  NS_DECL_NSIOUTPUTSTREAM
-
-  private:
-  nsDiskCacheRecordChannel*         mChannel;
-  nsCOMPtr<nsIOutputStream>         mBaseStream;
-} ;
-
-// implement nsISupports
-NS_IMPL_ISUPPORTS(WriteStreamWrapper, NS_GET_IID(nsIOutputStream))
-
-WriteStreamWrapper::WriteStreamWrapper(nsDiskCacheRecordChannel* aChannel, 
-                                       nsIOutputStream *aBaseStream) 
-  : mChannel(aChannel), mBaseStream(aBaseStream)
-{ 
-  NS_INIT_REFCNT(); 
-  NS_ADDREF(mChannel);
-}
-
-WriteStreamWrapper::~WriteStreamWrapper()
-{
-  NS_RELEASE(mChannel);
-}
-
-nsresult 
-WriteStreamWrapper::Create(nsDiskCacheRecordChannel*aChannel, nsIOutputStream *aBaseStream, nsIOutputStream* * aWrapper) 
-{
-  WriteStreamWrapper *wrapper = new WriteStreamWrapper(aChannel, aBaseStream);
-  if (!wrapper) return NS_ERROR_OUT_OF_MEMORY;
-    NS_ADDREF(wrapper);
-  *aWrapper = wrapper;
-  return NS_OK;
-}
-
-NS_IMETHODIMP
-WriteStreamWrapper::Write(const char *aBuffer, PRUint32 aCount, PRUint32 *aNumWritten) 
-{
-  *aNumWritten = 0;
-  nsresult rv = mBaseStream->Write(aBuffer, aCount, aNumWritten);
-  mChannel->NotifyStorageInUse(*aNumWritten);
-  return rv;
-}
-
-NS_IMETHODIMP
-WriteStreamWrapper::Flush() 
-{ 
-  return mBaseStream->Flush(); 
-}
-
-NS_IMETHODIMP
-WriteStreamWrapper::Close() 
-{ 
-  return mBaseStream->Close(); 
-}
-
-nsDiskCacheRecordChannel::nsDiskCacheRecordChannel(nsDiskCacheRecord *aRecord, 
-                                                   nsILoadGroup *aLoadGroup)
-  : mRecord(aRecord) ,
-    mLoadGroup(aLoadGroup) 
-{
-  NS_INIT_REFCNT() ;
-  NS_ADDREF(mRecord);
-  mRecord->mNumChannels++ ;
-}
-
-nsDiskCacheRecordChannel::~nsDiskCacheRecordChannel()
-{
-  mRecord->mNumChannels-- ;
-  NS_RELEASE(mRecord);
-}
-
-//  I know that I gave conflicting advice on the issue of file
-//  transport versus file protocol handler, but I thought that the
-//  last word was that we would use the raw transport, when I wrote:
-//
-//   > I just thought of an argument for the other side of the coin, i.e. the
-//   > benefit of *not* reusing the file protocol handler: On the Mac, it's
-//   > expensive to convert from a string URL to an nsFileSpec, because the Mac
-//   > is brain-dead and scans every directory on the path to the file.  It's
-//   > cheaper to create a nsFileSpec for a cache file by combining a single,
-//   > static nsFileSpec that corresponds to the cache directory with the
-//   > relative path to the cache file (using nsFileSpec's operator +).  This
-//   > operation is optimized on the Mac to avoid the scanning operation.
-//
-//  The Mac guys will eat us alive if we do path string to nsFileSpec
-//  conversions for every cache file we open.
-
-nsresult 
-nsDiskCacheRecordChannel::Init(void) 
-{
-  nsresult rv = mRecord->mFile->GetFileSpec(&mSpec) ;
-  
-#ifdef XP_MAC
-
-  // Don't assume we actually created a good file spec
-  FSSpec theSpec = mSpec.GetFSSpec();
-  if (!theSpec.name[0]) {
-    NS_ERROR("failed to create a file spec");
-
-    // Since we didn't actually create the file spec
-    // we return an error
-    return NS_ERROR_MALFORMED_URI;
-  }
-#endif
-  
-  return rv ;
-
-}
-
-nsresult 
-nsDiskCacheRecordChannel::NotifyStorageInUse(PRInt32 aBytesUsed)
-{
-  return mRecord->mDiskCache->m_StorageInUse += aBytesUsed ;
-}
-
-// implement nsISupports
-NS_IMPL_ISUPPORTS4(nsDiskCacheRecordChannel, 
-                   nsIChannel, 
-                   nsIRequest,
-                   nsIStreamListener,
-                   nsIStreamObserver)
-
-// implement nsIRequest
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::IsPending(PRBool *aIsPending) 
-{
-  *aIsPending = PR_FALSE ;
-  if(!mFileTransport)
-    return NS_OK ;
-
-  return mFileTransport->IsPending(aIsPending) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::Cancel(void)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->Cancel() ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::Suspend(void)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->Suspend() ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::Resume(void)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->Resume() ;
-}
-
-// implement nsIChannel
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetOriginalURI(nsIURI* *aURI)
-{
-  // FUR - might need to implement this - not sure
-  return NS_ERROR_NOT_IMPLEMENTED ;
-}
-  
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetURI(nsIURI * *aURI)
-{
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->GetURI(aURI) ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::OpenInputStream(PRUint32 aStartPosition, 
-                                          PRInt32 aReadCount,
-                                          nsIInputStream* *aResult)
-{
-  nsresult rv ;
-
-  if(mFileTransport)
-    return NS_ERROR_IN_PROGRESS ;
-
-  NS_WITH_SERVICE(nsIFileTransportService, fts, kFileTransportServiceCID, &rv) ;
-  if(NS_FAILED(rv)) return rv ;
-  
-  rv = fts->CreateTransport(mSpec, "load", 0, 0, getter_AddRefs(mFileTransport)) ;
-  if(NS_FAILED(rv))
-    return rv ;
-  
-  // we don't need to worry about notification callbacks
-  
-  rv = mFileTransport->OpenInputStream(aStartPosition, aReadCount, aResult) ;
-  if(NS_FAILED(rv)) 
-    mFileTransport = nsnull ;
-
-  return rv ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::OpenOutputStream(PRUint32 startPosition, 
-                                           nsIOutputStream* *aResult)
-{
-  nsresult rv ;
-  NS_ENSURE_ARG(aResult) ;
-  
-  if(mFileTransport)
-    return NS_ERROR_IN_PROGRESS ;
-
-  nsCOMPtr<nsIOutputStream> outputStream ;
-
-  NS_WITH_SERVICE(nsIFileTransportService, fts, kFileTransportServiceCID, &rv) ;
-  if(NS_FAILED(rv)) return rv ;
-  
-  rv = fts->CreateTransport(mSpec, "load", 0, 0, getter_AddRefs(mFileTransport)) ;
-  if(NS_FAILED(rv))
-    return rv ;
- 
-  // we don't need to worry about notification callbacks
-  
-  rv = mFileTransport->OpenOutputStream(startPosition, getter_AddRefs(outputStream)) ;
-  if(NS_FAILED(rv)) {
-    mFileTransport = nsnull ;
-    return rv ;
-  }
- 
-  return WriteStreamWrapper::Create(this, outputStream, aResult) ;
-
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::AsyncOpen(nsIStreamObserver *observer, 
-                                    nsISupports *ctxt)
-{
-  return NS_ERROR_NOT_IMPLEMENTED ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::AsyncRead(PRUint32 aStartPosition, 
-                                    PRInt32 aReadCount,
-                                    nsISupports *aContext, 
-                                    nsIStreamListener *aListener)
-{
-  nsresult rv ;
-
-  if(mFileTransport)
-    return NS_ERROR_IN_PROGRESS ;
-  
-  mRealListener = aListener;
-  nsCOMPtr<nsIStreamListener> tempListener = this;
-
-  if (mLoadGroup) {
-    nsCOMPtr<nsILoadGroupListenerFactory> factory;
-    //
-    // Create a load group "proxy" listener...
-    //
-    rv = mLoadGroup->GetGroupListenerFactory(getter_AddRefs(factory));
-    if (factory) {
-      nsIStreamListener *newListener;
-      rv = factory->CreateLoadGroupListener(mRealListener, &newListener);
-      if (NS_SUCCEEDED(rv)) {
-        mRealListener = newListener;
-        NS_RELEASE(newListener);
-        }
-      }
-
-      rv = mLoadGroup->AddChannel(this, nsnull);
-      if (NS_FAILED(rv)) return rv;
-  }
-
-
-  NS_WITH_SERVICE(nsIFileTransportService, fts, kFileTransportServiceCID, &rv);
-  if (NS_FAILED(rv)) return rv;
-
-  rv = fts->CreateTransport(mSpec, "load", 0, 0, getter_AddRefs(mFileTransport));
-  if (NS_FAILED(rv)) return rv;
-
-  // no callbacks
-
-  rv = mFileTransport->AsyncRead(aStartPosition, 
-                                 aReadCount, 
-                                 aContext, 
-                                 tempListener);
-
-  if (NS_FAILED(rv)) {
-    // release the transport so that we don't think we're in progress
-    mFileTransport = nsnull;
-  }
-  return rv;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::AsyncWrite(nsIInputStream *fromStream, 
-                                     PRUint32 startPosition,
-                                     PRInt32 writeCount, 
-                                     nsISupports *ctxt,
-                                     nsIStreamObserver *observer)
-
-{
-  /*
-  if(!mFileTransport)
-    return NS_ERROR_FAILURE ;
-
-  return mFileTransport->AsyncWrite(fromStream, 
-                                    startPosition,
-                                    writeCount,
-                                    ctxt,
-                                    observer) ;
-  */
-
-  // I can't do this since the write is not monitored, and I won't be
-  // able to updata the storage. 
-  return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetLoadAttributes(nsLoadFlags *aLoadAttributes)
-{
-  // Not required to be implemented, since it is implemented by cache manager
-  NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
-  return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::SetLoadAttributes(nsLoadFlags aLoadAttributes)
-{
-  // Not required to be implemented, since it is implemented by cache manager
-  NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
-  return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-#define DUMMY_TYPE "text/html"
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetContentType(char * *aContentType)
-{
-  nsresult rv ;
-
-  if (mSpec.IsDirectory()) {
-    *aContentType = nsCRT::strdup("application/http-index-format");
-    return *aContentType ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
-  }
-  else {
-    // I wish I can make this simplier
-
-    char* urlStr ;
-    mRecord->mFile->GetURLString(&urlStr) ;
-
-    // file: URLs (currently) have no additional structure beyond that provided by standard
-    // URLs, so there is no "outer" given to CreateInstance 
-
-    nsCOMPtr<nsIURI> url;
-    rv = nsComponentManager::CreateInstance(kStandardURLCID, nsnull,
-                                            NS_GET_IID(nsIURI),
-                                            //(void**)&url);
-                                            getter_AddRefs(url)) ;
-    if (NS_FAILED(rv)) return rv;
-
-    rv = url->SetSpec((char*)urlStr);
-    if (NS_FAILED(rv)) 
-        return rv;
-
-    NS_WITH_SERVICE(nsIMIMEService, MIMEService, kMIMEServiceCID, &rv);
-    if (NS_FAILED(rv)) return rv;
-
-    rv = MIMEService->GetTypeFromURI(url, aContentType);
-    if (NS_SUCCEEDED(rv)) return rv;
-  }
-
-  // if all else fails treat it as text/html?
-  *aContentType = nsCRT::strdup(DUMMY_TYPE);
-  if (!*aContentType) {
-    return NS_ERROR_OUT_OF_MEMORY;
-  } else {
-    return NS_OK;
-  }
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetContentLength(PRInt32 *aContentLength)
-{
-  nsresult rv;
-  PRUint32 length;
-
-  rv = mRecord->mFile->GetFileSize(&length);
-  if (NS_SUCCEEDED(rv)) {
-    *aContentLength = (PRInt32)length;
-  } else {
-    *aContentLength = -1;
-  }
-  return rv;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetOwner(nsISupports* *aOwner)
-{
-  *aOwner = mOwner.get() ;
-  NS_IF_ADDREF(*aOwner) ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::SetOwner(nsISupports* aOwner) 
-{
-  mOwner = aOwner ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
-      return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::SetLoadGroup(nsILoadGroup* aLoadGroup)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
-      return NS_OK;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::GetNotificationCallbacks(nsIInterfaceRequestor* *aNotificationCallbacks)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
-      return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::SetNotificationCallbacks(nsIInterfaceRequestor* aNotificationCallbacks)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsDiskCacheRecordChannel method unexpectedly called");
-      return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-////////////////////////////////////////////////////////////////////////////////
-// nsIStreamListener methods:
-////////////////////////////////////////////////////////////////////////////////
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::OnStartRequest(nsIChannel* transportChannel, nsISupports* context)
-{
-  NS_ASSERTION(mRealListener, "No listener...");
-  return mRealListener->OnStartRequest(this, context);
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::OnStopRequest(nsIChannel* transportChannel, nsISupports* context,
-                             nsresult aStatus, const PRUnichar* aMsg)
-{
-  nsresult rv;
-
-  rv = mRealListener->OnStopRequest(this, context, aStatus, aMsg);
-
-  if (mLoadGroup) {
-    if (NS_SUCCEEDED(rv)) {
-      mLoadGroup->RemoveChannel(this, context, aStatus, aMsg);
-    }
-  }
-
-  // Release the reference to the consumer stream listener...
-  mRealListener = null_nsCOMPtr();
-  mFileTransport = null_nsCOMPtr();
-  return rv;
-}
-
-NS_IMETHODIMP
-nsDiskCacheRecordChannel::OnDataAvailable(nsIChannel* transportChannel, nsISupports* context,
-                               nsIInputStream *aIStream, PRUint32 aSourceOffset,
-                               PRUint32 aLength)
-{
-  nsresult rv;
-
-  rv = mRealListener->OnDataAvailable(this, context, aIStream,
-                                      aSourceOffset, aLength);
-
-  //
-  // If the connection is being aborted cancel the transport.  This will
-  // insure that the transport will go away even if it is blocked waiting
-  // for the consumer to empty the pipe...
-  //
-  if (NS_FAILED(rv)) {
-    mFileTransport->Cancel();
-  }
-  return rv;
-}
-

mozilla/netwerk/cache/filecache/nsDiskCacheRecordChannel.h

@@ -1,76 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-#ifndef _ns_DiskCacheRecordChannel_h_
-#define _ns_DiskCacheRecordChannel_h_
-
-#include "nsIChannel.h"
-#include "nsCOMPtr.h"
-#include "nsDiskCacheRecord.h"
-#include "nsIStreamListener.h"
-
-/*
- * This class is plagiarized from nsMemCacheChannel
- */
-
-class nsDiskCacheRecordChannel : public nsIChannel,
-                                 public nsIStreamListener 
-{
-  public:
-
-  nsDiskCacheRecordChannel(nsDiskCacheRecord *aRecord, nsILoadGroup *aLoadGroup);
-  virtual ~nsDiskCacheRecordChannel() ;
-
-  // Declare nsISupports methods
-  NS_DECL_ISUPPORTS
-
-  // Declare nsIRequest methods
-  NS_DECL_NSIREQUEST
-
-  // Declare nsIChannel methods
-  NS_DECL_NSICHANNEL
-
-  // Declare nsIStreamObserver methods
-  NS_DECL_NSISTREAMOBSERVER
-
-  // Declare nsIStreamListener methods
-  NS_DECL_NSISTREAMLISTENER
-
-  nsresult Init(void) ;
-
-  private:
-
-  nsresult NotifyStorageInUse(PRInt32 aBytesUsed) ;
-
-  nsDiskCacheRecord*                    mRecord ;
-  nsCOMPtr<nsILoadGroup>                mLoadGroup ;
-  nsCOMPtr<nsISupports>                 mOwner ;
-  nsCOMPtr<nsIChannel>                  mFileTransport ;
-  nsFileSpec                            mSpec ;
-  nsCOMPtr<nsIStreamListener>           mRealListener;
-
-  friend class WriteStreamWrapper ;
-} ;
-
-#endif // _ns_DiskCacheRecordChannel_h_
-

mozilla/netwerk/cache/filecache/nsIDBAccessor.h

@@ -1,66 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-#ifndef _NS_IDBACCESSOR_H_
-#define _NS_IDBACCESSOR_H_
-
-#include "nsISupports.h"
-#include "nsIFileSpec.h"
-
-// nsIDBAccessorIID {6AADD4D0-7785-11d3-87FE-000629D01344}
-#define NS_IDBACCESSOR_IID \
-{ 0x6aadd4d0, 0x7785, 0x11d3, \
- {0x87, 0xfe, 0x0, 0x6, 0x29, 0xd0, 0x13, 0x44}}
-
-// nsDBAccessorCID {6AADD4D1-7785-11d3-87FE-000629D01344}
-#define NS_DBACCESSOR_CID \
-{ 0x6aadd4d1, 0x7785, 0x11d3, \
-  { 0x87, 0xfe, 0x0, 0x6, 0x29, 0xd0, 0x13, 0x44 }} 
-
-class nsIDBAccessor : public nsISupports
-{
-  public:
-  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IDBACCESSOR_IID)
-
-  NS_IMETHOD Init(nsIFileSpec* DBFile) = 0 ;
-  NS_IMETHOD Shutdown(void) = 0 ;
-
-  NS_IMETHOD Put(PRInt32 aID, void* anEntry, PRUint32 aLength) = 0 ;
-
-  NS_IMETHOD Get(PRInt32 aID, void** anEntry, PRUint32 *aLength) = 0 ;
-
-  NS_IMETHOD Del(PRInt32 aID, void* anEntry, PRUint32 aLength) = 0 ;
-
-  NS_IMETHOD GetID(const char* key, PRUint32 length, PRInt32* aID) = 0 ;
-
-  NS_IMETHOD EnumEntry(void* *anEntry, PRUint32* aLength, PRBool bReset) = 0 ;
-  
-  NS_IMETHOD GetDBFilesize(PRUint32* aSize) = 0 ;
-    
-  NS_IMETHOD GetSpecialEntry(void** anEntry, PRUint32 *aLength) = 0 ;
-  NS_IMETHOD SetSpecialEntry(void* anEntry, PRUint32 aLength) = 0 ;
-
-} ;
-
-#endif // _NS_IDBACCESSOR_H_
-

mozilla/netwerk/cache/filecache/nsNetDiskCache.cpp

@@ -1,704 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-#include "nsNetDiskCache.h"
-#include "nscore.h"
-
-#include "plstr.h"
-#include "prprf.h"
-#include "prtypes.h"
-#include "prio.h"
-#include "prsystem.h" // Directory Seperator
-#include "plhash.h"
-#include "prclist.h"
-#include "prmem.h"
-#include "prlog.h"
-
-#include "nsIComponentManager.h"
-#include "nsIServiceManager.h"
-
-#include "nsIPref.h"
-#include "mcom_db.h"
-#include "nsDBEnumerator.h"
-
-#include "nsDiskCacheRecord.h"
-#include "netCore.h"
-
-#if !defined(IS_LITTLE_ENDIAN) && !defined(IS_BIG_ENDIAN)
-ERROR! Must have a byte order
-#endif
-
-#ifdef IS_LITTLE_ENDIAN
-#define COPY_INT32(_a,_b)  memcpy(_a, _b, sizeof(int32))
-#else
-#define COPY_INT32(_a,_b)  /* swap */                   \
-    do {                                                \
-    ((char *)(_a))[0] = ((char *)(_b))[3];              \
-    ((char *)(_a))[1] = ((char *)(_b))[2];              \
-    ((char *)(_a))[2] = ((char *)(_b))[1];              \
-    ((char *)(_a))[3] = ((char *)(_b))[0];              \
-    } while(0)
-#endif
-
-static NS_DEFINE_CID(kPrefCID, NS_PREF_CID) ;
-static NS_DEFINE_CID(kDBAccessorCID, NS_DBACCESSOR_CID) ;
-
-static const PRUint32 DISK_CACHE_SIZE_DEFAULT = 5*1024*1024 ; // 5MB
-static const char * const DISK_CACHE_PREF  = "browser.cache.disk_cache_size";
-static const char * const CACHE_DIR_PREF   = "browser.cache.directory";
-
-class nsDiskCacheRecord ;
-
-nsNetDiskCache::nsNetDiskCache() :
-  m_Enabled(PR_TRUE) ,
-  m_NumEntries(0) ,
-  m_pNextCache(0) ,
-  m_pDiskCacheFolder(0) ,
-  m_StorageInUse(0) ,
-  m_DB(0) ,
-  m_DBCorrupted(PR_FALSE) 
-{
-  // set it to INF for now 
-  m_MaxEntries = (PRUint32)-1 ;
-
-  NS_INIT_REFCNT();
-
-}
-
-nsNetDiskCache::~nsNetDiskCache()
-{
-  SetSpecialEntry() ;
-
-  NS_IF_RELEASE(m_DB) ;
-  
-
-  // FUR
-  // I think that, eventually, we also want a distinguished key in the DB which
-  // means "clean cache shutdown".  You clear this flag when the db is first
-  // opened and set it just before the db is closed.  If the db wasn't shutdown
-  // cleanly in a prior session, i.e. because the app crashed, on startup you
-  // scan all the individual files in directories and look for "orphans",
-  // i.e. cache files which don't have corresponding entries in the db.  That's
-  // also when storage-in-use and number of entries would be recomputed.
-  //
-  // We don't necessarily need all this functionality immediately, though.
-
-
-  if(m_DBCorrupted) {
-    
-    nsFileSpec cacheFolder ;
-    m_pDiskCacheFolder->GetFileSpec(&cacheFolder) ;
-    
-    char nameInt[6] ;
-
-    for(nsDirectoryIterator di(cacheFolder, PR_FALSE); di.Exists(); di++) {
-      char* filename = di.Spec().GetLeafName() ;
-      char* pname = nameInt ;
-      pname = PL_strncpyz(pname, filename, 6) ;
-
-      if(PL_strcmp(pname, "trash") == 0)
-        RemoveFolder(di.Spec()) ;
-      
-      nsCRT::free(filename) ;  
-    }
-  }
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::Init(void) 
-{
-  nsresult rv ;
-  
-  // don't initialize if no cache folder is set. 
-  if(!m_pDiskCacheFolder) return NS_OK ;
-
-  if(!m_DB) {
-    m_DB = new nsDBAccessor() ;
-    if(!m_DB)
-      return NS_ERROR_OUT_OF_MEMORY ;
-    else
-      NS_ADDREF(m_DB) ;
-  }
-
-  // create cache sub directories
-  nsCOMPtr<nsIFileSpec> cacheSubDir;
-  rv = NS_NewFileSpec(getter_AddRefs(cacheSubDir));
-
-  for (int i=0; i < 32; i++) {
-    rv = cacheSubDir->FromFileSpec(m_pDiskCacheFolder) ;
-    if(NS_FAILED(rv))
-      return rv ;
-
-    char dirName[3];
-    PR_snprintf (dirName, 3, "%0.2x", i);
-    cacheSubDir->AppendRelativeUnixPath (dirName) ;
-    CreateDir(cacheSubDir);
-  }
-
-  return InitDB() ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::InitDB(void)
-{
-  nsresult rv ; 
-
-  if(!m_DBFile) {
-    NS_NewFileSpec(getter_AddRefs(m_DBFile)) ;
-    if(!m_DBFile)
-      return NS_ERROR_OUT_OF_MEMORY ;
-  }
-
-  rv = m_DBFile->FromFileSpec(m_pDiskCacheFolder) ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  m_DBFile->AppendRelativeUnixPath("cache.db") ;
-
-  rv = m_DB->Init(m_DBFile) ;
-
-  if(rv == NS_ERROR_FAILURE) {
-    // try recovery if error 
-    DBRecovery() ;
-  }
-
-  rv = GetSpecialEntry() ;
-  if(rv == NS_ERROR_FAILURE) {
-    // try recovery if error 
-    DBRecovery() ;
-  }
-
-  return rv ;
-}
-
-//////////////////////////////////////////////////////////////////////////
-// nsISupports methods
-
-NS_IMPL_ISUPPORTS3(nsNetDiskCache,
-                   nsINetDataDiskCache,
-                   nsINetDataCache,
-                   nsISupports) 
-
-///////////////////////////////////////////////////////////////////////////
-// nsINetDataCache Method 
-
-NS_IMETHODIMP
-nsNetDiskCache::GetDescription(PRUnichar* *aDescription) 
-{
-  nsAutoString description("Disk Cache") ;
-  *aDescription = description.ToNewUnicode() ;
-  if(!*aDescription)
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  return NS_OK ;
-}
-
-/* don't alloc mem for nsICachedNetData. 
- * RecordID is generated using the same scheme in nsCacheDiskData,
- * see GetCachedNetData() for detail.
- */
-NS_IMETHODIMP
-nsNetDiskCache::Contains(const char* key, PRUint32 length, PRBool *_retval) 
-{
-  *_retval = PR_FALSE ;
-
-  NS_ASSERTION(m_DB, "no db.") ;
-
-  PRInt32 id = 0 ;
-  nsresult rv = m_DB->GetID(key, length, &id) ;
-
-  if(NS_FAILED(rv)) {
-    // try recovery if error 
-    DBRecovery() ;
-    return rv ;
-  }
-
-  void* info = 0 ;
-  PRUint32 info_size = 0 ;
-
-  rv = m_DB->Get(id, &info, &info_size) ;
-  if(NS_SUCCEEDED(rv) && info) 
-    *_retval = PR_TRUE ;
-        
-  if(NS_FAILED(rv)) {
-    // try recovery if error 
-    DBRecovery() ;
-  }
-
-  return rv ;
-}
-
-/* regardless if it's cached or not, a copy of nsNetDiskCache would 
- * always be returned. so release it appropriately. 
- * if mem alloced, updata m_NumEntries also.
- * for now, the new nsCachedNetData is not written into db yet since
- * we have nothing to write.
- */
-NS_IMETHODIMP
-nsNetDiskCache::GetCachedNetData(const char* key, PRUint32 length, nsINetDataCacheRecord **_retval) 
-{
-  NS_ASSERTION(m_DB, "no db.") ;
-
-  nsresult rv = 0 ;
-  if (!_retval)
-    return NS_ERROR_NULL_POINTER ;
-
-  *_retval = nsnull ;
-
-  PRInt32 id = 0 ;
-  rv = m_DB->GetID(key, length, &id) ;
-  if(NS_FAILED(rv)) {
-    // try recovery if error 
-    DBRecovery() ;
-    return rv ;
-  }
-
-  // construct an empty record
-  nsDiskCacheRecord* newRecord = new nsDiskCacheRecord(m_DB, this) ;
-  if(!newRecord) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-
-  rv = newRecord->Init(key, length, id) ;
-  if(NS_FAILED(rv)) {
-    delete newRecord ;
-    return rv ;
-  }
-
-  NS_ADDREF(newRecord) ; // addref for _retval 
-  *_retval = (nsINetDataCacheRecord*) newRecord ;
-  
-  void* info = 0 ;
-  PRUint32 info_size = 0 ;
-
-  rv = m_DB->Get(id, &info, &info_size) ;
-  if(NS_SUCCEEDED(rv) && info) {
-
-    // this is a previously cached record 
-    nsresult r1 ;
-    r1 = newRecord->RetrieveInfo(info, info_size) ;
-
-    if(NS_SUCCEEDED(rv)) 
-      return NS_OK ;
-    else { 
-      // probably a bad one
-      NS_RELEASE(newRecord) ;
-      *_retval = nsnull ;
-      return r1;
-    }
-    
-  } else if (NS_SUCCEEDED(rv) && !info) {
-    // this is a new record. 
-    m_NumEntries ++ ;
-    return NS_OK ;
-  } else {
-    // database error.
-    DBRecovery() ;
-    return rv ;
-  }
-}
-
-/* get an nsICachedNetData, mem needs to be de-alloced if not found. */
-NS_IMETHODIMP
-nsNetDiskCache::GetCachedNetDataByID(PRInt32 RecordID, nsINetDataCacheRecord **_retval) 
-{
-  NS_ASSERTION(m_DB, "no db.") ;
-
-  if (!_retval)
-    return NS_ERROR_NULL_POINTER ;
-
-  *_retval = nsnull ;
-  
-  nsresult rv ;
-
-  void* info = 0 ;
-  PRUint32 info_size = 0 ;
-
-  rv = m_DB->Get(RecordID, &info, &info_size) ;
-  if(NS_SUCCEEDED(rv) && info) {
-
-    // construct an empty record if only found in db
-    nsDiskCacheRecord* newRecord = new nsDiskCacheRecord(m_DB, this) ;
-    if(!newRecord) 
-      return NS_ERROR_OUT_OF_MEMORY ;
-
-    NS_ADDREF(newRecord) ; // addref for _retval
-    rv = newRecord->RetrieveInfo(info, info_size) ;
-
-    if(NS_SUCCEEDED(rv)) {
-      *_retval = (nsINetDataCacheRecord*) newRecord ;
-      return NS_OK ;
-    } 
-    else {
-      // bad record, I guess
-      NS_RELEASE(newRecord) ; // release if bad things happen
-      return rv ;
-    }
-  } else {
-    NS_ERROR("Error: RecordID not in DB\n") ;
-    DBRecovery() ;
-    return rv ;
-  }
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::GetEnabled(PRBool *aEnabled) 
-{
-  *aEnabled = m_Enabled ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::SetEnabled(PRBool aEnabled) 
-{
-  m_Enabled = aEnabled ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::GetFlags(PRUint32 *aFlags) 
-{
-  *aFlags = FILE_PER_URL_CACHE;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::GetNumEntries(PRUint32 *aNumEntries) 
-{
-  *aNumEntries = m_NumEntries ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::GetMaxEntries(PRUint32 *aMaxEntries)
-{
-  *aMaxEntries = m_MaxEntries ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::NewCacheEntryIterator(nsISimpleEnumerator **_retval) 
-{
-  NS_ASSERTION(m_DB, "no db.") ;
-
-  if(!_retval)
-    return NS_ERROR_NULL_POINTER ;
-
-  *_retval = nsnull ;
-
-  nsISimpleEnumerator* enumerator = new nsDBEnumerator(m_DB, this) ;
-  if(enumerator) {
-    NS_ADDREF(enumerator) ;
-    *_retval = enumerator ;
-    return NS_OK ;
-  }
-  else 
-    return NS_ERROR_OUT_OF_MEMORY ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::GetNextCache(nsINetDataCache * *aNextCache)
-{
-  if(!aNextCache)
-    return NS_ERROR_NULL_POINTER ;
-
-  *aNextCache = m_pNextCache ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::SetNextCache(nsINetDataCache *aNextCache)
-{
-  m_pNextCache = aNextCache ;
-  return NS_OK ;
-}
-
-// db size can always be measured at the last minute. Since it's hard
-// to know before hand. 
-NS_IMETHODIMP
-nsNetDiskCache::GetStorageInUse(PRUint32 *aStorageInUse)
-{
-  NS_ASSERTION(m_DB, "no db.") ;
-
-  PRUint32 total_size = m_StorageInUse ;
-
-  /*
-  PRUint32 len = 0 ;
-  // add the size of the db.
-  m_DB->GetDBFilesize(&len) ;
-  total_size += len ;
-  */
-
-  // we need size in kB
-  total_size = total_size >> 10 ;
-
-  *aStorageInUse = total_size ;
-  return NS_OK ;
-}
-
-/*
- * The whole cache dirs can be whiped clean since all the cache 
- * files are resides in seperate hashed dirs. It's safe to do so.
- */
- 
-NS_IMETHODIMP
-nsNetDiskCache::RemoveAll(void)
-{
-  NS_ASSERTION(m_DB, "no db.") ;
-  NS_ASSERTION(m_pDiskCacheFolder, "no cache folder.") ;
-
-  // remove all the sub folders
-  nsFileSpec cacheSubDir;
-
-  for (int i=0; i < 32; i++) {
-    m_pDiskCacheFolder->GetFileSpec(&cacheSubDir) ;
-
-    char dirName[3];
-    PR_snprintf (dirName, 3, "%0.2x", i);
-    cacheSubDir += dirName ;
-    RemoveFolder(cacheSubDir) ;
-  }
-
-  // don't forget the db file itself
-  m_DB->Shutdown() ;
-  nsFileSpec dbfile ;
-  m_DBFile->GetFileSpec(&dbfile) ;
-  dbfile.Delete(PR_TRUE) ;
-
-  // reinitilize
-  return Init() ;
-}
-
-//////////////////////////////////////////////////////////////////
-// nsINetDataDiskCache methods
-
-NS_IMETHODIMP
-nsNetDiskCache::GetDiskCacheFolder(nsIFileSpec * *aDiskCacheFolder)
-{
-  *aDiskCacheFolder = nsnull ;
-  NS_ASSERTION(m_pDiskCacheFolder, "no cache folder.") ;
-
-  *aDiskCacheFolder = m_pDiskCacheFolder ;
-  NS_ADDREF(*aDiskCacheFolder) ;
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::SetDiskCacheFolder(nsIFileSpec * aDiskCacheFolder)
-{
-  if(!m_pDiskCacheFolder) {
-    NS_NewFileSpec(getter_AddRefs(m_pDiskCacheFolder));
-    if(!m_pDiskCacheFolder) 
-      return NS_ERROR_OUT_OF_MEMORY ;
-    
-    m_pDiskCacheFolder = aDiskCacheFolder ;
-    return Init() ;
-  } 
-  else {
-    char *newfolder, *oldfolder ;
-    m_pDiskCacheFolder->GetNativePath(&oldfolder) ;
-    aDiskCacheFolder->GetNativePath(&newfolder) ;
-
-    if(PL_strcmp(newfolder, oldfolder) != 0) {
-      m_pDiskCacheFolder = aDiskCacheFolder ;
-
-      // do we need to blow away old cache before building a new one?
-      // return RemoveAll() ;
-
-      m_DB->Shutdown() ;
-      return Init() ;
-
-    } else 
-      return NS_OK ;
-  }
-}
-
-//////////////////////////////////////////////////////////////////
-// nsNetDiskCache methods
-
-// create a directory (recursively)
-NS_IMETHODIMP
-nsNetDiskCache::CreateDir(nsIFileSpec* dir_spec) 
-{
-  PRBool does_exist ;
-  nsCOMPtr<nsIFileSpec> p_spec ;
-
-  dir_spec->Exists(&does_exist) ;
-  if(does_exist) 
-    return NS_OK ;
-
-  nsresult rv = dir_spec->GetParent(getter_AddRefs(p_spec)) ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  p_spec->Exists(&does_exist) ;
-  if(!does_exist) {
-    CreateDir(p_spec) ;
-    rv = dir_spec->CreateDir() ;
-    if(NS_FAILED(rv))
-      return rv ;
-  }
-  else {
-    rv = dir_spec->CreateDir() ;
-    if(NS_FAILED(rv))
-      return rv ;
-  }
-  
-  return NS_OK ;
-}
-
-// We can't afford to make a *separate* pass over the whole db on every
-// startup, just to figure out m_NumEntries and m_StorageInUse.  (This is a
-// several second operation on a large db).  We'll likely need to store
-// distinguished keys in the db that contain these values and update them
-// incrementally, except when failure to shut down the db cleanly is detected.
-
-NS_IMETHODIMP
-nsNetDiskCache::GetSpecialEntry(void)
-{
-  void* pInfo ;
-  PRUint32 InfoSize ;
-
-  nsresult rv = m_DB->GetSpecialEntry(&pInfo, &InfoSize) ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  if(!pInfo && InfoSize == 0) {
-    // must be a new DB
-    m_NumEntries = 0 ;
-    m_StorageInUse = 0 ;
-  } 
-  else {
-    char * cur_ptr = NS_STATIC_CAST(char*, pInfo) ;
-    
-    // get m_NumEntries
-    COPY_INT32(&m_NumEntries, cur_ptr) ;
-    cur_ptr += sizeof(PRUint32) ;
-    
-    // get m_StorageInUse
-    COPY_INT32(&m_StorageInUse, cur_ptr) ;
-    cur_ptr += sizeof(PRUint32) ;
-    
-    PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, pInfo) + InfoSize);
-  }
-
-  return NS_OK ;
-}
-
-NS_IMETHODIMP
-nsNetDiskCache::SetSpecialEntry(void)
-{
-  PRUint32 InfoSize ;
-  
-  InfoSize = sizeof m_NumEntries ;
-  InfoSize += sizeof m_StorageInUse ;
-  
-  void* pInfo = nsAllocator::Alloc(InfoSize*sizeof(char)) ;
-  if(!pInfo) 
-    return NS_ERROR_OUT_OF_MEMORY ;
-  
-  char* cur_ptr = NS_STATIC_CAST(char*, pInfo) ;
-
-  COPY_INT32(cur_ptr, &m_NumEntries) ;
-  cur_ptr += sizeof(PRUint32) ;
-
-  COPY_INT32(cur_ptr, &m_StorageInUse) ;
-  cur_ptr += sizeof(PRUint32) ;
-  
-  PR_ASSERT(cur_ptr == NS_STATIC_CAST(char*, pInfo) + InfoSize);
-  
-  return m_DB->SetSpecialEntry(pInfo, InfoSize) ;
-}
-
-// this routine will be called everytime we have a db corruption. 
-// m_DB will be re-initialized, m_StorageInUse and m_NumEntries will
-// be reset.
-NS_IMETHODIMP
-nsNetDiskCache::DBRecovery(void)
-{
-  // rename all the sub cache dirs and remove them later during dtor. 
-  nsresult rv = RenameCacheSubDirs() ;
-  if(NS_FAILED(rv))
-    return rv ;
-
-  // remove corrupted db file, don't care if db->shutdown fails or not.
-  m_DB->Shutdown() ;
-  
-  nsFileSpec dbfile ;
-  m_DBFile->GetFileSpec(&dbfile) ;
-  dbfile.Delete(PR_TRUE) ;
-
-  // make sure it's not there any more
-  PRBool exists = dbfile.Exists() ;
-  if(exists) {
-    NS_ERROR("can't remove old db.") ;
-    return NS_ERROR_FAILURE ;
-  }
-
-  // reinitilize DB 
-  return InitDB() ;
-}
-
-// this routine will add string "trash" to current CacheSubDir names. 
-// e.g. 00->trash00, 1f->trash1f. and update the m_DBCorrupted. 
-
-NS_IMETHODIMP
-nsNetDiskCache::RenameCacheSubDirs(void) 
-{
-  nsCOMPtr<nsIFileSpec> cacheSubDir;
-  nsresult rv = NS_NewFileSpec(getter_AddRefs(cacheSubDir)) ;
-
-  for (int i=0; i < 32; i++) {
-    rv = cacheSubDir->FromFileSpec(m_pDiskCacheFolder) ;
-    if(NS_FAILED(rv))
-      return rv ;
-
-    char oldName[3], newName[8];
-    PR_snprintf(oldName, 3, "%0.2x", i) ;
-    cacheSubDir->AppendRelativeUnixPath(oldName) ;
-
-    // re-name the directory
-    PR_snprintf(newName, 8, "trash%0.2x", i) ;
-    rv = cacheSubDir->Rename(newName) ;
-    if(NS_FAILED(rv))
-      // TODO, error checking
-      return NS_ERROR_FAILURE ;
-  }
-
-  // update m_DBCorrupted 
-  m_DBCorrupted = PR_TRUE ;
-
-  return NS_OK ;
-}
-
-// this routine is used by dtor and RemoveAll() to clean up dirs.
-NS_IMETHODIMP
-nsNetDiskCache::RemoveFolder(nsFileSpec aFolder)
-{
-  for(nsDirectoryIterator di(aFolder, PR_FALSE); di.Exists(); di++) {
-    di.Spec().Delete(PR_TRUE) ;
-  }
-  
-  aFolder.Delete(PR_FALSE) ; // recursive delete
-  
-  return NS_OK ;
-}

mozilla/netwerk/cache/filecache/nsNetDiskCache.h

@@ -1,91 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-/*
- * This file is part of filecache implementation.
- *
- * nsNetDiskCache is the main disk cache module that will create 
- * the cache database, and then store and retrieve nsDiskCacheRecord 
- * objects from it. It also contains some basic error recovery procedure.
- */
-
-#ifndef __gen_nsNetDiskCache_h__
-#define __gen_nsNetDiskCache_h__
-
-#include "nsINetDataDiskCache.h"
-#include "nsNetDiskCacheCID.h"
-#include "nsCOMPtr.h"
-#include "nsIPref.h"
-#include "nsDBAccessor.h"
-
-class nsIURI; /* forward decl */
-class nsICachedNetData; /* forward decl */
-class nsISimpleEnumerator; /* forward decl */
-class nsIFileSpec; /* forward decl */
-
-/* starting interface:    nsNetDiskCache */
-
-class nsNetDiskCache : public nsINetDataDiskCache {
-  public: 
-
-  NS_DECL_ISUPPORTS
-  NS_DECL_NSINETDATACACHE
-  NS_DECL_NSINETDATADISKCACHE
-
-  NS_IMETHOD Init(void) ;
-
-  nsNetDiskCache() ;
-  virtual ~nsNetDiskCache() ;
-
-  protected:
-
-  NS_IMETHOD InitDB(void) ;
-  NS_IMETHOD CreateDir(nsIFileSpec* dir_spec) ;
-  NS_IMETHOD GetSpecialEntry(void) ;
-  NS_IMETHOD SetSpecialEntry(void) ;
-
-  NS_IMETHOD RenameCacheSubDirs(void) ;
-  NS_IMETHOD DBRecovery(void) ;
-  NS_IMETHOD RemoveFolder(nsFileSpec aFolder) ;
-
-  private:
-
-  PRBool 			                m_Enabled ;
-  PRUint32 			                m_NumEntries ;
-  nsCOMPtr<nsINetDataCache> 	    m_pNextCache ;
-  nsCOMPtr<nsIFileSpec>   	        m_pDiskCacheFolder ;
-  nsCOMPtr<nsIFileSpec>             m_DBFile ;
-
-  PRUint32                          m_MaxEntries ;
-  PRUint32                          m_StorageInUse ;
-  nsIDBAccessor*                    m_DB ;
-
-  // this is used to indicate a db corruption 
-  PRBool                            m_DBCorrupted ;
-
-  friend class nsDiskCacheRecord ;
-  friend class nsDiskCacheRecordChannel ;
-  friend class nsDBEnumerator ;
-} ;
-
-#endif /* __gen_nsNetDiskCache_h__ */

mozilla/netwerk/cache/filecache/nsNetDiskCacheCID.h

@@ -1,32 +0,0 @@
-/*
- * 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/
- * 
- * 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.
- * 
- * The Original Code is Mozilla Communicator.
- * 
- * The Initial Developer of the Original Code is Intel Corp.
- * Portions created by Intel Corp. are
- * Copyright (C) 1999, 1999 Intel Corp.  All
- * Rights Reserved.
- * 
- * Contributor(s): Yixiong Zou <yixiong.zou@intel.com>
- *                 Carl Wong <carl.wong@intel.com>
- */
-
-#ifndef _nsNetDiskCacheCID_h_
-#define _nsNetDiskCacheCID_h_
-
-#define NS_NETDISKCACHE_CID_STR "ECFEEA00-7201-11d3-87FE-000629D01344"
-
-#define NS_NETDISKCACHE_CID \
-{ 0xecfeea00, 0x7201, 0x11d3, \
- { 0x87, 0xfe, 0x0, 0x6, 0x29, 0xd0, 0x13, 0x44 }}
-
-#endif /* _nsNetDiskCacheCID_h_ */

mozilla/netwerk/cache/filecache/test/diskcache.cpp

@@ -1,836 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape Public License
- * Version 1.0 (the "NPL"); you may not use this file except in
- * compliance with the NPL.  You may obtain a copy of the NPL at
- * http://www.mozilla.org/NPL/
- *
- * Software distributed under the NPL is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
- * for the specific language governing rights and limitations under the
- * NPL.
- *
- * The Initial Developer of this code under the NPL is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
- * Reserved.
- */
-
-#include "nsIStreamListener.h"
-#include "nsIStreamObserver.h"
-#include "nsIServiceManager.h"
-#include "nsIInputStream.h"
-#include "nsIOutputStream.h"
-#include "nsIEventQueue.h"
-#include "nsIEventQueueService.h"
-#include "nsIChannel.h"
-#include "nsCOMPtr.h"
-#include "nsString.h"
-#include <stdio.h>
-#include <unistd.h>
-
-#include "nsINetDataCache.h"
-#include "nsINetDataCacheRecord.h"
-//#include "nsMemCacheCID.h"
-#include "nsNetDiskCache.h"
-#include "nsIPref.h"
-#include "prenv.h"
-#include "nsIFileStream.h"
-
-// Number of test entries to be placed in the cache
-#define NUM_CACHE_ENTRIES  250
-
-// Cache content stream length will have random length between zero and
-// MAX_CONTENT_LENGTH bytes
-#define MAX_CONTENT_LENGTH 20000
-
-// Length of random-data cache entry key
-#define CACHE_KEY_LENGTH 15
-
-// Length of random-data cache entry meta-data
-#define CACHE_METADATA_LENGTH 100
-
-//static NS_DEFINE_CID(kMemCacheCID, NS_MEM_CACHE_FACTORY_CID);
-static NS_DEFINE_CID(kEventQueueServiceCID, NS_EVENTQUEUESERVICE_CID);
-static NS_DEFINE_CID(kDiskCacheCID, NS_NETDISKCACHE_CID) ;
-static NS_DEFINE_CID(kPrefCID, NS_PREF_CID);
-static NS_DEFINE_IID(kIPrefIID, NS_IPREF_IID);
-
-// Mapping from test case number to RecordID
-static PRInt32 recordID[NUM_CACHE_ENTRIES];
-
-static PRInt32
-mapRecordIdToTestNum(PRInt32 aRecordID)
-{
-    int i;
-    for (i = 0; i < NUM_CACHE_ENTRIES; i++) {
-        if (recordID[i] == aRecordID)
-            return i;
-    }
-    return -1;
-}
-
-// A supply of stream data to either store or compare with
-class nsITestDataStream {
-public:
-    virtual ~nsITestDataStream() {};
-    virtual PRUint32 Next() = 0;
-    virtual void Read(char* aBuf, PRUint32 aCount) = 0;
-
-    virtual PRBool Match(char* aBuf, PRUint32 aCount) = 0;
-    virtual void Skip(PRUint32 aCount) = 0;
-};
-
-// A reproducible stream of random data.
-class RandomStream : public nsITestDataStream {
-public:
-    RandomStream(PRUint32 aSeed) {
-        mStartSeed = mState = aSeed;
-    }
-    
-    PRUint32 GetStartSeed() {
-        return mStartSeed;
-    }
-    
-    PRUint32 Next() {
-        mState = 1103515245 * mState + 12345;
-        return mState;
-    }
-
-    void Read(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            *aBuf++ = Next();
-        }
-    }
-
-    PRBool
-    Match(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            if (*aBuf++ != (char)(Next() & 0xff))
-                return PR_FALSE;
-        }
-        return PR_TRUE;
-    }
-
-    void
-    Skip(PRUint32 aCount) {
-        while (aCount--)
-            Next();
-    }
-
-protected:
-    
-    PRUint32 mState;
-    PRUint32 mStartSeed;
-};
-
-// A stream of data that increments on each byte that is read, modulo 256
-class CounterStream : public nsITestDataStream {
-public:
-    CounterStream(PRUint32 aSeed) {
-        mStartSeed = mState = aSeed;
-    }
-    
-    PRUint32 GetStartSeed() {
-        return mStartSeed;
-    }
-    
-    PRUint32 Next() {
-        mState += 1;
-        mState &= 0xff;
-        return mState;
-    }
-
-    void Read(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            *aBuf++ = Next();
-        }
-    }
-
-    PRBool
-    Match(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            if (*aBuf++ != (char)Next())
-                return PR_FALSE;
-        }
-        return PR_TRUE;
-    }
-
-    void
-    Skip(PRUint32 aCount) {
-        mState += aCount;
-        mState &= 0xff;
-    }
-
-protected:
-    
-    PRUint32 mState;
-    PRUint32 mStartSeed;
-};
-
-static int gNumReaders = 0;
-static PRUint32 gTotalBytesRead = 0;
-static PRUint32 gTotalDuration = 0;
-
-class nsReader : public nsIStreamListener {
-public:
-    NS_DECL_ISUPPORTS
-
-    nsReader()
-        : mStartTime(0), mBytesRead(0)
-    {
-        NS_INIT_REFCNT();
-        gNumReaders++;
-    }
-
-    virtual ~nsReader() {
-        delete mTestDataStream;
-        gNumReaders--;
-    }
-
-    nsresult 
-    Init(nsIChannel *aChannel, nsITestDataStream* aRandomStream, PRUint32 aExpectedStreamLength) {
-        mChannel = aChannel;
-        mTestDataStream = aRandomStream;
-        mExpectedStreamLength = aExpectedStreamLength;
-        mRefCnt = 1;
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnStartRequest(nsIChannel* channel,
-                              nsISupports* context) {
-        mStartTime = PR_IntervalNow();
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnDataAvailable(nsIChannel* channel, 
-                               nsISupports* context,
-                               nsIInputStream *aIStream, 
-                               PRUint32 aSourceOffset,
-                               PRUint32 aLength) {
-        char buf[1025];
-        while (aLength > 0) {
-            PRUint32 amt;
-            PRBool match;
-            aIStream->Read(buf, sizeof buf, &amt);
-            if (amt == 0) break;
-            aLength -= amt;
-            mBytesRead += amt;
-            match = mTestDataStream->Match(buf, amt);
-            NS_ASSERTION(match, "Stored data was corrupted on read");
-        }
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnStopRequest(nsIChannel* channel, 
-                             nsISupports* context,
-                             nsresult aStatus,
-                             const PRUnichar* aMsg) {
-        PRIntervalTime endTime;
-        PRIntervalTime duration;
-        
-        endTime = PR_IntervalNow();
-        duration = (endTime - mStartTime);
-
-        if (NS_FAILED(aStatus)) printf("channel failed.\n");
-        //        printf("read %d bytes\n", mBytesRead);
-
-        NS_ASSERTION(mBytesRead == mExpectedStreamLength,
-                     "Stream in cache is wrong length");
-
-        gTotalBytesRead += mBytesRead;
-        gTotalDuration += duration;
-
-        // Release channel
-        mChannel = 0;
-        return NS_OK;
-    }
-
-protected:
-    PRIntervalTime       mStartTime;
-    PRUint32             mBytesRead;
-    nsITestDataStream*   mTestDataStream;
-    PRUint32             mExpectedStreamLength;
-    nsCOMPtr<nsIChannel> mChannel;
-};
-
-NS_IMPL_ISUPPORTS2(nsReader, nsIStreamListener, nsIStreamObserver)
-
-static nsIEventQueue* eventQueue;
-
-nsresult
-InitQueue() {
-    nsresult rv;
-
-    NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueServiceCID, &rv);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue service");
-
-    rv = eventQService->CreateThreadEventQueue();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create event queue");
-  
-    rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQueue);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue for main thread");
-
-    return NS_OK;
-}
-
-// Process events until all streams are OnStopRequest'ed
-nsresult
-WaitForEvents() {
-    while (gNumReaders) {
-        eventQueue->ProcessPendingEvents();
-    }
-    return NS_OK;
-}
-
-// Read data for a single cache record and compare against testDataStream
-nsresult
-TestReadStream(nsINetDataCacheRecord *record, nsITestDataStream *testDataStream,
-               PRUint32 expectedStreamLength)
-{
-    nsCOMPtr<nsIChannel> channel;
-    nsresult rv;
-    PRUint32 actualContentLength;
-
-    rv = record->NewChannel(0, getter_AddRefs(channel));
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-    rv = record->GetStoredContentLength(&actualContentLength);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    NS_ASSERTION(actualContentLength == expectedStreamLength,
-                 "nsINetDataCacheRecord::GetContentLength() busted ?");
-    
-    nsReader *reader = new nsReader;
-    reader->AddRef();
-    rv = reader->Init(channel, testDataStream, expectedStreamLength);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    
-    rv = channel->AsyncRead(0, -1, 0, reader);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    reader->Release();
-
-    return NS_OK;
-}
-
-// Check that records can be retrieved using their record-ID, in addition
-// to using the opaque key.
-nsresult
-TestRecordID(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    RandomStream *randomStream;
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char *metaData;
-    PRUint32 testNum;
-    PRBool match;
-
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        rv = cache->GetCachedNetDataByID(recordID[testNum], getter_AddRefs(record));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't obtain record using record ID");
-
-        // Match against previously stored meta-data
-        rv = record->GetMetaData(&metaDataLength, &metaData);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
-        match = randomStream->Match(metaData, metaDataLength);
-        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
-
-        nsAllocator::Free(metaData);
-        delete randomStream;
-    }
-    return NS_OK;
-}
-
-// Check that all cache entries in the database are enumerated and that
-// no duplicates appear.
-nsresult
-TestEnumeration(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsCOMPtr<nsISupports> tempISupports;
-    nsCOMPtr<nsISimpleEnumerator> iterator;
-    RandomStream *randomStream;
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char *metaData;
-    PRUint32 testNum;
-    PRBool match;
-    PRInt32 recID;
-
-    int numRecords = 0;
-
-    // Iterate over all records in the cache
-    rv = cache->NewCacheEntryIterator(getter_AddRefs(iterator));
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create new cache entry iterator");
-
-    PRBool notDone;
-    while (1) {
-
-        // Done iterating ?
-        rv = iterator->HasMoreElements(&notDone);
-        if (NS_FAILED(rv)) return rv;
-        if (!notDone)
-            break;
-
-        // Get next record in iteration
-        rv = iterator->GetNext(getter_AddRefs(tempISupports));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "iterator bustage");
-        record = do_QueryInterface(tempISupports);
-
-        numRecords++;
-
-        // Get record ID
-        rv = record->GetRecordID(&recID);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
-        testNum = mapRecordIdToTestNum(recID);
-        NS_ASSERTION(testNum != -1, "Corrupted Record ID ?");
-
-        // Erase mapping from table, so that duplicate enumerations are detected
-        recordID[testNum] = -1;
-
-        // Make sure stream matches test data
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        // Match against previously stored meta-data
-        rv = record->GetMetaData(&metaDataLength, &metaData);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
-        match = randomStream->Match(metaData, metaDataLength);
-        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
-        nsAllocator::Free(metaData);
-
-        delete randomStream;
-    }
-
-    NS_ASSERTION(numRecords == NUM_CACHE_ENTRIES, "Iteration bug");
-
-    return NS_OK;
-}
-
-// Read the test data that was written in FillCache(), checking for
-// corruption, truncation.
-nsresult
-TestRead(nsINetDataCache *cache)
-{
-    nsresult rv;
-    PRBool inCache;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    RandomStream *randomStream;
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char *metaData, *storedCacheKey;
-    PRUint32 testNum, storedCacheKeyLength;
-    PRBool match;
-
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        // Ensure that entry is in the cache
-        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
-        
-        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        // Match against previously stored meta-data
-        match = record->GetMetaData(&metaDataLength, &metaData);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        match = randomStream->Match(metaData, metaDataLength);
-        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
-        nsAllocator::Free(metaData);
-
-        // Test GetKey() method
-        rv = record->GetKey(&storedCacheKeyLength, &storedCacheKey);
-        NS_ASSERTION(NS_SUCCEEDED(rv) &&
-                     (storedCacheKeyLength == sizeof cacheKey) &&
-                     !memcmp(storedCacheKey, &cacheKey[0], sizeof cacheKey),
-                     "nsINetDataCacheRecord::GetKey failed");
-        nsAllocator::Free(storedCacheKey);
-
-        PRUint32 expectedStreamLength = randomStream->Next() & 0xffff;
-
-        TestReadStream(record, randomStream, expectedStreamLength);
-    }
-
-    WaitForEvents();
-
-    // Compute rate in MB/s
-    double rate = gTotalBytesRead / PR_IntervalToMilliseconds(gTotalDuration);
-    rate *= NUM_CACHE_ENTRIES;
-    rate *= 1000;
-    rate /= (1024 * 1024);
-    printf("Read %d bytes at a rate of %5.1f MB per second \n",
-           gTotalBytesRead, rate);
-
-    return NS_OK;
-}
-
-// Repeatedly call SetStoredContentLength() on a cache entry and make
-// read the stream's data to ensure that it's not corrupted by the effect
-nsresult
-TestTruncation(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    RandomStream *randomStream;
-    char cacheKey[CACHE_KEY_LENGTH];
-
-    randomStream = new RandomStream(0);
-    randomStream->Read(cacheKey, sizeof cacheKey);
-
-    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-    randomStream->Skip(CACHE_METADATA_LENGTH);
-    PRUint32 initialStreamLength = randomStream->Next() & 0xffff;
-    delete randomStream;
-
-    PRUint32 i;
-    PRUint32 delta = initialStreamLength / 64;
-    for (i = initialStreamLength; i >= delta; i -= delta) {
-        PRUint32 expectedStreamLength = i;
-
-        // Do the truncation
-        record->SetStoredContentLength(expectedStreamLength);
-        randomStream = new RandomStream(0);
-        randomStream->Skip(CACHE_KEY_LENGTH + CACHE_METADATA_LENGTH + 1);
-
-        TestReadStream(record, randomStream, expectedStreamLength);
-        WaitForEvents();
-    }
-
-    return NS_OK;
-}
-
-// Write known data to random offsets in a single cache entry and test
-// resulting stream for correctness.
-nsresult
-TestOffsetWrites(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsCOMPtr<nsIChannel> channel;
-    nsCOMPtr<nsIOutputStream> outStream;
-    char buf[512];
-    char cacheKey[CACHE_KEY_LENGTH];
-    RandomStream *randomStream;
-
-    randomStream = new RandomStream(0);
-    randomStream->Read(cacheKey, sizeof cacheKey);
-
-    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
-
-
-    nsCOMPtr<nsIFileSpec> file ;
-    record->GetFilename(getter_AddRefs(file)) ;
-    char* name ;
-    file->GetUnixStyleFilePath(&name) ;
-    printf(" file name is %s \n", name) ;
-
-    // Write buffer-fulls of data at random offsets into the cache entry.
-    // Data written is (offset % 0xff)
-    PRUint32 startingOffset;
-    PRUint32 streamLength = 0;
-    PRUint32 len = 0 ;
-    CounterStream *counterStream;
-
-    int i = 0;
-    for (i = 0; i < 257; i++) {
-        rv = record->NewChannel(0, getter_AddRefs(channel));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        startingOffset = streamLength ? streamLength - (randomStream->Next() % sizeof buf): 0;
-        rv = channel->OpenOutputStream(startingOffset, getter_AddRefs(outStream));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        
-        truncate(name, startingOffset) ;
-
-        counterStream = new CounterStream(startingOffset);
-        counterStream->Read(buf, sizeof buf);
-
-      nsresult status ;
-      nsCOMPtr<nsIRandomAccessStore> ras = do_QueryInterface(outStream, &status);
-      if (NS_FAILED(status)) {
-      //        mState = END_WRITE;
-        return NS_ERROR_FAILURE;
-      }
-      PRIntn offset ;
-      ras->Tell(&offset) ;
-//      printf(" offset is %d \n", offset) ;
-
-        PRUint32 numWritten;
-        rv = outStream->Write(buf, sizeof buf, &numWritten);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(numWritten == sizeof buf, "Write() bug?");
-        streamLength = startingOffset + sizeof buf;
-
-        rv = outStream->Close();
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't close channel");
-        delete counterStream;
-
-        record->GetStoredContentLength(&len) ;
-        if(len != streamLength) 
-          printf(" offset = %d is wrong, filesize = %d\n", startingOffset, len) ;
-
-    }
-
-        /*
-        rv = record->NewChannel(0, getter_AddRefs(channel));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        startingOffset = 208;
-        rv = channel->OpenOutputStream(startingOffset, getter_AddRefs(outStream));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        
-        counterStream = new CounterStream(startingOffset);
-        counterStream->Read(buf, sizeof buf);
-
-      nsresult status ;
-      nsCOMPtr<nsIRandomAccessStore> ras = do_QueryInterface(outStream, &status);
-      if (NS_FAILED(status)) {
-      //        mState = END_WRITE;
-        return NS_ERROR_FAILURE;
-      }
-      PRIntn offset = 0 ;
-      ras->Tell(&offset) ;
-      printf(" offset is %d \n", offset) ;
-
-        PRUint32 numWritten;
-        rv = outStream->Write(buf, sizeof buf, &numWritten);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(numWritten == sizeof buf, "Write() bug?");
-        streamLength = startingOffset + sizeof buf;
-
-        rv = outStream->Close();
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't close channel");
-        delete counterStream;
-
-        record->GetStoredContentLength(&len) ;
-        if(len != streamLength) 
-          printf(" offset = %d is wrong, filesize = %d\n", startingOffset, len) ;
-          */
-    
-    delete randomStream;
-
-    counterStream = new CounterStream(0);
-    TestReadStream(record, counterStream, streamLength);
-    WaitForEvents();
-
-    return NS_OK;
-}
-
-// Create entries in the network data cache, using random data for the
-// key, the meta-data and the stored content data.
-nsresult
-FillCache(nsINetDataCache *cache)
-{
-    nsresult rv;
-    PRBool inCache;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsCOMPtr<nsIChannel> channel;
-    nsCOMPtr<nsIOutputStream> outStream;
-    char buf[1000];
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char metaData[CACHE_METADATA_LENGTH];
-    PRUint32 testNum;
-    char *data;
-    RandomStream *randomStream;
-
-    PRIntervalTime startTime = PR_IntervalNow();
-    
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        // No entry should be in cache until we add it
-        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(!inCache, "nsINetDataCache::Contains error");
-        
-        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
-
-        // Test nsINetDataCacheRecord::GetRecordID()
-        rv = record->GetRecordID(&recordID[testNum]);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
-
-        // Test nsINetDataCache::GetNumEntries()
-        PRUint32 numEntries = (PRUint32)-1;
-        rv = cache->GetNumEntries(&numEntries);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-        NS_ASSERTION(numEntries == testNum + 1, "GetNumEntries failure");
-
-        // Record meta-data should be initially empty
-        rv = record->GetMetaData(&metaDataLength, &data);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        if ((metaDataLength != 0) || (data != 0))
-            return NS_ERROR_FAILURE;
-
-        // Store random data as meta-data
-        randomStream->Read(metaData, sizeof metaData);
-        record->SetMetaData(sizeof metaData, metaData);
-
-        rv = record->NewChannel(0, getter_AddRefs(channel));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        rv = channel->OpenOutputStream(0, getter_AddRefs(outStream));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        
-        PRUint32 beforeOccupancy;
-        rv = cache->GetStorageInUse(&beforeOccupancy);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-
-        int streamLength = randomStream->Next() & 0xffff;
-        int remaining = streamLength;
-        while (remaining) {
-            PRUint32 numWritten;
-            int amount = PR_MIN(sizeof buf, remaining);
-            randomStream->Read(buf, amount);
-
-            rv = outStream->Write(buf, amount, &numWritten);
-            NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-            NS_ASSERTION(numWritten == (PRUint32)amount, "Write() bug?");
-            
-            remaining -= amount;
-        }
-        outStream->Close();
-
-        PRUint32 afterOccupancy;
-        rv = cache->GetStorageInUse(&afterOccupancy);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-        PRUint32 streamLengthInKB = streamLength >> 10;
-        NS_ASSERTION((afterOccupancy - beforeOccupancy) >= streamLengthInKB,
-                     "nsINetDataCache::GetStorageInUse() is busted");
-        
-
-        // *Now* there should be an entry in the cache
-        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
-
-        delete randomStream;
-    }
-
-    PRIntervalTime endTime = PR_IntervalNow();
-
-    return NS_OK;
-}
-
-nsresult NS_AutoregisterComponents()
-{
-  nsresult rv = nsComponentManager::AutoRegister(nsIComponentManager::NS_Startup,
-                                                 NULL /* default */);
-  return rv;
-}
-
-PRBool initPref ()
-{
-  nsresult rv;
-  NS_WITH_SERVICE(nsIPref, prefPtr, kPrefCID, &rv);
-  if (NS_FAILED(rv))
-    return false;
-
-  nsCOMPtr<nsIFileSpec> fileSpec;
-  rv = NS_NewFileSpec (getter_AddRefs(fileSpec));
-  if (NS_FAILED(rv))
-    return false;
-
-  nsCString defaultPrefFile = PR_GetEnv ("MOZILLA_FIVE_HOME");
-  if (defaultPrefFile.Length())
-    defaultPrefFile += "/";
-  else
-    defaultPrefFile = "./";
-  defaultPrefFile += "default_prefs.js";
-
-  fileSpec->SetUnixStyleFilePath (defaultPrefFile.GetBuffer());
-
-  PRBool exists = false;
-  fileSpec->Exists(&exists);
-  if (exists)
-    prefPtr->ReadUserPrefsFrom(fileSpec);
-  else
-    return false;
-  return true;
-}
-
-int
-main(int argc, char* argv[])
-{
-    initPref() ;
-    nsresult rv;
-    nsCOMPtr<nsINetDataCache> cache;
-
-    rv = NS_AutoregisterComponents();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't register XPCOM components");
-
-    rv = nsComponentManager::CreateInstance(kDiskCacheCID, nsnull,
-                                            NS_GET_IID(nsINetDataCache),
-                                            getter_AddRefs(cache));
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create memory cache factory");
-
-    InitQueue();
-
-    PRUnichar* description;
-    rv = cache->GetDescription(&description);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache description");
-    nsCAutoString descStr(description);
-    printf("Testing: %s\n", descStr.GetBuffer());
-
-    rv = cache->RemoveAll();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
-
-    PRUint32 startOccupancy;
-    rv = cache->GetStorageInUse(&startOccupancy);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-
-    PRUint32 numEntries = (PRUint32)-1;
-    rv = cache->GetNumEntries(&numEntries);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
-
-    rv = FillCache(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't fill cache with random test data");
-
-    rv = TestRead(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't read random test data from cache");
-
-    rv = TestRecordID(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't index records using record ID");
-
-    rv = TestEnumeration(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully enumerate records");
-
-    rv = TestTruncation(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully truncate records");
-
-    rv = TestOffsetWrites(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully write to records using non-zero offsets");
-
-    rv = cache->RemoveAll();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
-    rv = cache->GetNumEntries(&numEntries);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
-
-    PRUint32 endOccupancy;
-    rv = cache->GetStorageInUse(&endOccupancy);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-
-    NS_ASSERTION(startOccupancy == endOccupancy, "Cache occupancy not correctly computed ?");
-
-    return 0;
-}
-

mozilla/netwerk/cache/memcache/nsMemCache.cpp

@@ -1,334 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-/**
- * nsMemCache is the implementation of an in-memory network-data
- * cache, used to cache the responses to network retrieval commands.
- * Each cache entry may contain both content, e.g. GIF image data, and
- * associated metadata, e.g. HTTP headers.  Each entry is indexed by
- * two different keys: a record id number and an opaque key, which is
- * created by the cache manager by combining the URI with a "secondary
- * key", e.g. HTTP post data.
- */
-
-#include "nsMemCache.h"
-#include "nsMemCacheRecord.h"
-#include "nsIGenericFactory.h"
-#include "nsString.h"
-#include "nsHashtable.h"
-#include "nsHashtableEnumerator.h"
-#include "nsEnumeratorUtils.h"
-
-PRInt32 nsMemCache::gRecordSerialNumber = 0;
-
-nsMemCache::nsMemCache()
-    : mNumEntries(0), mOccupancy(0), mEnabled(PR_TRUE),
-      mHashTable(0)
-{
-    NS_INIT_REFCNT();
-}
-
-nsMemCache::~nsMemCache()
-{
-    nsresult rv;
-
-    rv = RemoveAll();
-    NS_ASSERTION(NS_SUCCEEDED(rv) && (mNumEntries == 0),
-                 "Failure to shut down memory cache. "
-                 "Somewhere, someone is holding references to at least one cache record");
-    delete mHashTable;
-}
-
-nsresult
-nsMemCache::Init()
-{
-    mHashTable = new nsHashtable(256);
-    if (!mHashTable)
-        return NS_ERROR_OUT_OF_MEMORY;
-    return NS_OK;
-}
-
-NS_IMPL_ISUPPORTS(nsMemCache, NS_GET_IID(nsINetDataCache))
-
-NS_IMETHODIMP
-nsMemCache::GetDescription(PRUnichar * *aDescription)
-{
-    nsAutoString description("Memory Cache");
-    *aDescription = description.ToNewUnicode();
-    if (!*aDescription)
-        return NS_ERROR_OUT_OF_MEMORY;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::Contains(const char *aKey, PRUint32 aKeyLength, PRBool *aFound)
-{
-    nsOpaqueKey *opaqueKey = new nsOpaqueKey(aKey, aKeyLength);
-    if (!opaqueKey)
-        return NS_ERROR_OUT_OF_MEMORY;
-    *aFound = mHashTable->Exists(opaqueKey);
-    delete opaqueKey;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::GetCachedNetData(const char *aKey, PRUint32 aKeyLength,
-                             nsINetDataCacheRecord* *aRecord)
-{
-    nsresult rv;
-    nsMemCacheRecord* record = 0;
-    nsOpaqueKey *opaqueKey2 = 0;
-    nsOpaqueKey *opaqueKey3 = 0;
-    nsOpaqueKey *opaqueKey;
-
-    opaqueKey = new nsOpaqueKey(aKey, aKeyLength);
-    if (!opaqueKey)
-        goto out_of_memory;
-    record = (nsMemCacheRecord*)mHashTable->Get(opaqueKey);
-    delete opaqueKey;
-
-    // No existing cache database entry was found.  Create a new one.
-    // This requires two mappings in the hash table:
-    //    Record ID  ==> record
-    //    Opaque key ==> record
-    if (!record) {
-        record = new nsMemCacheRecord;
-        if (!record)
-            goto out_of_memory;
-        rv = record->Init(aKey, aKeyLength, ++gRecordSerialNumber, this);
-        if (NS_FAILED(rv)) goto out_of_memory;
-
-        // Index the record by opaque key
-        opaqueKey2 = new nsOpaqueKey(record->mKey, record->mKeyLength);
-        if (!opaqueKey2) goto out_of_memory;
-        mHashTable->Put(opaqueKey2, record);
-        
-        // Index the record by it's record ID
-        char *recordIDbytes = NS_REINTERPRET_CAST(char *, &record->mRecordID);
-        opaqueKey3 = new nsOpaqueKey(recordIDbytes,
-                                     sizeof record->mRecordID);
-        if (!opaqueKey3) {
-            // Clean up the first record from the hash table
-            mHashTable->Remove(opaqueKey);
-            goto out_of_memory;
-        }
-        mHashTable->Put(opaqueKey3, record);
-        
-        // The hash table holds on to the record
-        record->AddRef();
-        
-        delete opaqueKey2;
-        delete opaqueKey3;
-        mNumEntries++;
-    }
-
-    record->AddRef();
-    *aRecord = record;
-    return NS_OK;
-
- out_of_memory:
-    delete opaqueKey2;
-    delete opaqueKey3;
-    delete record;
-    return NS_ERROR_OUT_OF_MEMORY;
-}
-
-NS_IMETHODIMP
-nsMemCache::GetCachedNetDataByID(PRInt32 RecordID,
-                                 nsINetDataCacheRecord* *aRecord)
-{
-    nsOpaqueKey opaqueKey(NS_REINTERPRET_CAST(const char *, &RecordID),
-                          sizeof RecordID);
-    *aRecord = (nsINetDataCacheRecord*)mHashTable->Get(&opaqueKey);
-    if (*aRecord) {
-        NS_ADDREF(*aRecord);
-        return NS_OK;
-    }
-    return NS_ERROR_FAILURE;
-}
-
-NS_METHOD
-nsMemCache::Delete(nsMemCacheRecord* aRecord)
-{
-    nsMemCacheRecord *removedRecord;
-
-    char *recordIDbytes = NS_REINTERPRET_CAST(char *, &aRecord->mRecordID);
-    nsOpaqueKey opaqueRecordIDKey(recordIDbytes,
-                                  sizeof aRecord->mRecordID);
-    removedRecord = (nsMemCacheRecord*)mHashTable->Remove(&opaqueRecordIDKey);
-    NS_ASSERTION(removedRecord == aRecord, "memory cache database inconsistent");
-
-    nsOpaqueKey opaqueKey(aRecord->mKey, aRecord->mKeyLength);
-    removedRecord = (nsMemCacheRecord*)mHashTable->Remove(&opaqueKey);
-    NS_ASSERTION(removedRecord == aRecord, "memory cache database inconsistent");
-
-    aRecord->Release();
-
-    mNumEntries--;
-    
-    return NS_OK;
-}
-    
-
-NS_IMETHODIMP
-nsMemCache::GetEnabled(PRBool *aEnabled)
-{
-    NS_ENSURE_ARG(aEnabled);
-    *aEnabled = mEnabled;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::SetEnabled(PRBool aEnabled)
-{
-    mEnabled = aEnabled;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::GetFlags(PRUint32 *aFlags)
-{
-    NS_ENSURE_ARG(aFlags);
-    *aFlags = MEMORY_CACHE;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::GetNumEntries(PRUint32 *aNumEntries)
-{
-    NS_ENSURE_ARG(aNumEntries);
-    *aNumEntries = mNumEntries;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::GetMaxEntries(PRUint32 *aMaxEntries)
-{
-    NS_ENSURE_ARG(aMaxEntries);
-    *aMaxEntries = MEM_CACHE_MAX_ENTRIES;
-    return NS_OK;
-}
-
-static NS_METHOD
-HashEntryConverter(nsHashKey *aKey, void *aValue,
-                   void *unused, nsISupports **retval)
-{
-    nsMemCacheRecord *record;
-    nsOpaqueKey *opaqueKey;
-
-    record = (nsMemCacheRecord*)aValue;
-    opaqueKey = (nsOpaqueKey*)aKey;
-
-    // Hash table keys that index cache entries by their record ID
-    // shouldn't be enumerated.
-    if ((opaqueKey->GetKeyLength() == sizeof(PRInt32))) {
-
-#ifdef DEBUG
-        PRInt32 recordID;
-        record->GetRecordID(&recordID);
-        NS_ASSERTION(*((PRInt32*)opaqueKey->GetKey()) == recordID,
-                     "Key has incorrect key length");
-#endif
-        return NS_ERROR_FAILURE;
-    }
-
-    NS_IF_ADDREF(record);
-    *retval = NS_STATIC_CAST(nsISupports*, record);
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::NewCacheEntryIterator(nsISimpleEnumerator* *aIterator)
-{
-    nsCOMPtr<nsIEnumerator> iterator;
-
-    NS_ENSURE_ARG(aIterator);
-    NS_NewHashtableEnumerator(mHashTable, HashEntryConverter,
-                              mHashTable, getter_AddRefs(iterator));
-    return NS_NewAdapterEnumerator(aIterator, iterator);
-}
-
-NS_IMETHODIMP
-nsMemCache::GetNextCache(nsINetDataCache* *aNextCache)
-{
-    NS_ENSURE_ARG(aNextCache);
-    *aNextCache = mNextCache;
-    NS_ADDREF(*aNextCache);
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::SetNextCache(nsINetDataCache* aNextCache)
-{
-    mNextCache = aNextCache;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::GetStorageInUse(PRUint32 *aStorageInUse)
-{
-    NS_ENSURE_ARG(aStorageInUse);
-
-    // Convert from bytes to KB
-    *aStorageInUse = (mOccupancy >> 10);
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCache::RemoveAll(void)
-{
-    PRBool failed;
-
-    nsCOMPtr<nsISimpleEnumerator> iterator;
-    nsCOMPtr<nsISupports> recordSupports;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsresult rv;
-
-    failed = PR_FALSE;
-    rv = NewCacheEntryIterator(getter_AddRefs(iterator));
-    if (NS_FAILED(rv))
-        return rv;
-
-    PRBool notDone;
-    while (1) {
-        rv = iterator->HasMoreElements(&notDone);
-        if (NS_FAILED(rv)) return rv;
-        if (!notDone)
-            break;
-        
-        iterator->GetNext(getter_AddRefs(recordSupports));
-        record = do_QueryInterface(recordSupports);
-        recordSupports = 0;
-
-        PRUint32 bytesUsed;
-        record->GetStoredContentLength(&bytesUsed);
-        rv = record->Delete();
-        if (NS_FAILED(rv)) {
-            failed = PR_TRUE;
-            continue;
-        }
-        mOccupancy -= bytesUsed;
-    }
-
-    if (failed)
-        return NS_ERROR_FAILURE;
-    return NS_OK;
-}

mozilla/netwerk/cache/memcache/nsMemCache.h

@@ -1,83 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-/**
- * nsMemCache is the implementation of an in-memory network-data
- * cache, used to cache the responses to network retrieval commands.
- * Each cache entry may contain both content, e.g. GIF image data, and
- * associated metadata, e.g. HTTP headers.  Each entry is indexed by
- * two different keys: a record id number and an opaque key, which is
- * created by the cache manager by combining the URI with a "secondary
- * key", e.g. HTTP post data.
- */
-
-#ifndef _nsMemCache_h_
-#define _nsMemCache_h_
-
-#include "nsINetDataCache.h"
-
-// Maximum number of URIs that may be resident in the cache
-#define MEM_CACHE_MAX_ENTRIES 1000
-
-#define MEM_CACHE_SEGMENT_SIZE       (1 << 12)
-#define MEM_CACHE_MAX_ENTRY_SIZE     (1 << 20)
-
-class nsHashtable;
-class nsMemCacheRecord;
-
-class nsMemCache : public nsINetDataCache
-{
-public:
-    nsMemCache();
-    virtual ~nsMemCache();
-    nsresult Init();
-
-    // nsISupports methods
-    NS_DECL_ISUPPORTS
-
-    // nsINetDataCache methods
-    NS_DECL_NSINETDATACACHE
-
-    // Factory
-    static NS_METHOD nsMemCacheConstructor(nsISupports *aOuter, REFNSIID aIID,
-                                           void **aResult);
-
-protected:
-
-    PRUint32         mNumEntries;
-    PRUint32         mOccupancy;   // Memory used, in bytes
-    PRBool           mEnabled;     // If false, bypass mem cache
-
-    nsINetDataCache* mNextCache;
-
-    // Mapping from either opaque key or record ID to nsMemCacheRecord
-    nsHashtable*     mHashTable;
-
-    // Used to assign record ID's
-    static PRInt32   gRecordSerialNumber;
-
-    NS_METHOD Delete(nsMemCacheRecord* aRecord);
-
-    friend class nsMemCacheRecord;
-    friend class nsMemCacheChannel;
-};
-
-#endif // _nsMemCache_h_

mozilla/netwerk/cache/memcache/nsMemCacheCID.h

@@ -1,36 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-//  XPCOM Class ID for the network data in-memory cache
-
-#ifndef nsMEMCACHECID_h__
-#define nsMEMCACHECID_h__
-
-// {e4710560-7de2-11d3-90cb-0040056a906e}
-#define NS_MEM_CACHE_FACTORY_CID                          \
-    {                                                     \
-        0xe4710560,                                       \
-	    0x7de2,                                           \
-        0x11d3,                                           \
-	    {0x90, 0xcb, 0x00, 0x40, 0x05, 0x6a, 0x90, 0x6e}  \
-    }
-
-#endif // nsMEMCACHECID_h__

mozilla/netwerk/cache/memcache/nsMemCacheChannel.cpp

@@ -1,462 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-#include "nsMemCache.h"
-#include "nsMemCacheChannel.h"
-#include "nsIStreamListener.h"
-#include "nsIChannel.h"
-#include "nsIStorageStream.h"
-#include "nsIOutputStream.h"
-#include "nsIServiceManager.h"
-#include "nsIEventQueueService.h"
-#include "nsNetUtil.h"
-#include "nsILoadGroup.h"
-
-static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_CID);
-static NS_DEFINE_CID(kEventQueueService, NS_EVENTQUEUESERVICE_CID);
-
-NS_IMPL_ISUPPORTS(nsMemCacheChannel, NS_GET_IID(nsIChannel))
-
-void
-nsMemCacheChannel::NotifyStorageInUse(PRInt32 aBytesUsed)
-{
-    mRecord->mCache->mOccupancy += aBytesUsed;
-}
-
-/**
- * This class acts as an adaptor around a synchronous input stream to add async
- * read capabilities.  It adds methods for initiating, suspending, resuming and
- * cancelling async reads. 
- */
-class AsyncReadStreamAdaptor : public nsIInputStream {
-public:
-    AsyncReadStreamAdaptor(nsMemCacheChannel* aChannel, nsIInputStream *aSyncStream):
-        mSyncStream(aSyncStream), mDataAvailCursor(0),
-        mRemaining(0), mAvailable(0), mChannel(aChannel), mAborted(PR_FALSE), mSuspended(PR_FALSE)
-        {
-            NS_INIT_REFCNT();
-            NS_ADDREF(mChannel);
-        }
-
-    virtual ~AsyncReadStreamAdaptor() { 
-        mChannel->mAsyncReadStream = 0;
-        NS_RELEASE(mChannel);
-    }
-    
-    NS_DECL_ISUPPORTS
-
-    nsresult
-    IsPending(PRBool* aIsPending) {
-        *aIsPending = (mRemaining != 0) && !mAborted;
-        return NS_OK;
-    }
-
-    nsresult
-    Cancel(void) {
-        mAborted = PR_TRUE;
-        return mStreamListener->OnStopRequest(mChannel, mContext, NS_BINDING_ABORTED, nsnull);
-    }
-
-    nsresult
-    Suspend(void) { mSuspended = PR_TRUE; return NS_OK; }
-
-    nsresult
-    Resume(void) {
-        if (!mSuspended)
-            return NS_ERROR_FAILURE;
-        mSuspended = PR_FALSE;
-        return NextListenerEvent();
-    }
-
-    NS_IMETHOD
-    Available(PRUint32 *aNumBytes) { return mAvailable; }
-
-    NS_IMETHOD
-    Read(char* aBuf, PRUint32 aCount, PRUint32 *aBytesRead) {
-        if (mAborted)
-            return NS_ERROR_ABORT;
-
-        *aBytesRead = 0;
-        aCount = PR_MIN(aCount, mAvailable);
-        nsresult rv = mSyncStream->Read(aBuf, aCount, aBytesRead);
-        mAvailable -= *aBytesRead;
-
-        if (NS_FAILED(rv) && (rv != NS_BASE_STREAM_WOULD_BLOCK)) {
-            Fail();
-            return rv;
-        }
-
-        if (!mSuspended && !mAvailable) {
-            rv = NextListenerEvent();
-            if (NS_FAILED(rv)) {
-                Fail();
-                return rv;
-            }
-        }
-
-        return NS_OK;
-    }
-
-    NS_IMETHOD
-    Close() {
-        nsresult rv = mSyncStream->Close();
-        mSyncStream = 0;
-        mContext = 0;
-        mStreamListener = 0;
-        return rv;
-    }
-
-    nsresult
-    AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
-              nsISupports* aContext, nsIStreamListener* aListener) {
-
-        nsresult rv;
-        nsIEventQueue *eventQ;
-
-        mContext = aContext;
-        mStreamListener = aListener;
-        mRemaining = aReadCount;
-
-        NS_WITH_SERVICE(nsIIOService, serv, kIOServiceCID, &rv);
-        if (NS_FAILED(rv)) return rv;
-
-        NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueService, &rv);
-        if (NS_FAILED(rv)) return rv;
-
-        rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQ);
-        if (NS_FAILED(rv)) return rv;
-
-        rv = NS_NewAsyncStreamListener(aListener, eventQ, 
-                                       getter_AddRefs(mStreamListener));
-        NS_RELEASE(eventQ);
-        if (NS_FAILED(rv)) return rv;
-
-        rv = mStreamListener->OnStartRequest(mChannel, aContext);
-        if (NS_FAILED(rv)) return rv;
-
-        return NextListenerEvent();
-    }
-
-protected:
-
-    nsresult
-    Fail(void) {
-        mAborted = PR_TRUE;
-        return mStreamListener->OnStopRequest(mChannel, mContext, NS_BINDING_FAILED, nsnull);
-    }
-
-    nsresult
-    NextListenerEvent() {
-        PRUint32 available;
-        nsresult rv = mSyncStream->Available(&available);
-        if (NS_FAILED(rv)) return rv;
-        available -= mAvailable;
-        available = PR_MIN(available, mRemaining);
-
-        if (available) {
-            PRUint32 size = PR_MIN(available, MEM_CACHE_SEGMENT_SIZE);
-            rv = mStreamListener->OnDataAvailable(mChannel, mContext, this,
-                                                  mDataAvailCursor, size);
-            mDataAvailCursor += size;
-            mRemaining -= size;
-            mAvailable += size;
-            return rv;
-        } else {
-            rv = mStreamListener->OnStopRequest(mChannel, mContext, NS_OK, nsnull);
-            AsyncReadStreamAdaptor* thisAlias = this;
-            NS_RELEASE(thisAlias);
-            return rv;
-        }
-    }
-    
-private:
-    nsCOMPtr<nsISupports>       mContext;        // Opaque context passed to AsyncRead()
-    nsCOMPtr<nsIStreamListener> mStreamListener; // Stream listener that has been proxied
-    nsCOMPtr<nsIInputStream>    mSyncStream;     // Underlying synchronous stream that is
-                                                 //   being converted to an async stream
-    PRUint32                    mDataAvailCursor;
-    PRUint32                    mRemaining;      // Size of AsyncRead request less bytes for
-                                                 //   consumer OnDataAvailable's that were fired
-    PRUint32                    mAvailable;      // Number of bytes for which OnDataAvailable fired
-    nsMemCacheChannel*          mChannel;        // Associated memory cache channel, strong link
-                                                 //   but can not use nsCOMPtr
-    PRBool                      mAborted;        // Abort() has been called
-    PRBool                      mSuspended;      // Suspend() has been called
-};
-
-NS_IMPL_ISUPPORTS(AsyncReadStreamAdaptor,  NS_GET_IID(nsIInputStream))
-
-// The only purpose of this output stream wrapper is to adjust the cache's
-// overall occupancy as new data flows into the cache entry.
-class MemCacheWriteStreamWrapper : public nsIOutputStream {
-public:
-    MemCacheWriteStreamWrapper(nsMemCacheChannel* aChannel, nsIOutputStream *aBaseStream):
-        mBaseStream(aBaseStream), mChannel(aChannel)
-        {
-            NS_INIT_REFCNT();
-            NS_ADDREF(mChannel);
-        }
-
-    virtual ~MemCacheWriteStreamWrapper() { NS_RELEASE(mChannel); };
-    
-    static nsresult
-    Create(nsMemCacheChannel* aChannel, nsIOutputStream *aBaseStream, nsIOutputStream* *aWrapper) {
-        MemCacheWriteStreamWrapper *wrapper =
-            new MemCacheWriteStreamWrapper(aChannel, aBaseStream);
-        if (!wrapper) return NS_ERROR_OUT_OF_MEMORY;
-        NS_ADDREF(wrapper);
-        *aWrapper = wrapper;
-        return NS_OK;
-    }
-    
-    NS_DECL_ISUPPORTS
-
-    NS_IMETHOD
-    Write(const char *aBuffer, PRUint32 aCount, PRUint32 *aNumWritten) {
-        *aNumWritten = 0;
-        nsresult rv = mBaseStream->Write(aBuffer, aCount, aNumWritten);
-        mChannel->NotifyStorageInUse(*aNumWritten);
-        return rv;
-    }
-
-    NS_IMETHOD
-    Flush() { return mBaseStream->Flush(); }
-
-    NS_IMETHOD
-    Close() { return mBaseStream->Close(); }
-
-private:
-    nsCOMPtr<nsIOutputStream>   mBaseStream;
-    nsMemCacheChannel*          mChannel;
-};
-
-NS_IMPL_ISUPPORTS(MemCacheWriteStreamWrapper,  NS_GET_IID(nsIOutputStream))
-
-nsMemCacheChannel::nsMemCacheChannel(nsMemCacheRecord *aRecord, nsILoadGroup *aLoadGroup)
-    : mRecord(aRecord)
-{
-    NS_INIT_REFCNT();
-    mRecord->mNumChannels++;
-}
-
-nsMemCacheChannel::~nsMemCacheChannel()
-{
-    mRecord->mNumChannels--;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::IsPending(PRBool* aIsPending)
-{
-    *aIsPending = PR_FALSE;
-    if (!mAsyncReadStream)
-        return NS_OK;
-    return mAsyncReadStream->IsPending(aIsPending);
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::Cancel(void)
-{
-    if (!mAsyncReadStream)
-        return NS_ERROR_FAILURE;
-    return mAsyncReadStream->Cancel();
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::Suspend(void)
-{
-    if (!mAsyncReadStream)
-        return NS_ERROR_FAILURE;
-    return mAsyncReadStream->Suspend();
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::Resume(void)
-{
-    if (!mAsyncReadStream)
-        return NS_ERROR_FAILURE;
-    return mAsyncReadStream->Resume();
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetOriginalURI(nsIURI * *aURI)
-{
-    // Not required
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetURI(nsIURI * *aURI)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::OpenInputStream(PRUint32 aStartPosition, PRInt32 aReadCount,
-                                   nsIInputStream* *aResult)
-{
-    nsresult rv;
-    NS_ENSURE_ARG(aResult);
-    if (mInputStream)
-        return NS_ERROR_NOT_AVAILABLE;
-
-    rv = mRecord->mStorageStream->NewInputStream(aStartPosition, getter_AddRefs(mInputStream));
-    *aResult = mInputStream;
-    NS_ADDREF(*aResult);
-    return rv;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::OpenOutputStream(PRUint32 startPosition, nsIOutputStream* *aResult)
-{
-    nsresult rv;
-    NS_ENSURE_ARG(aResult);
-
-    nsCOMPtr<nsIOutputStream> outputStream;
-
-    PRUint32 oldLength;
-    mRecord->mStorageStream->GetLength(&oldLength);
-    rv = mRecord->mStorageStream->GetOutputStream(startPosition, getter_AddRefs(outputStream));
-    if (NS_FAILED(rv)) return rv;
-    if (startPosition < oldLength)
-        NotifyStorageInUse(startPosition - oldLength);
-
-    return MemCacheWriteStreamWrapper::Create(this, outputStream, aResult);
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::AsyncOpen(nsIStreamObserver *observer, nsISupports *ctxt)
-{
-    // Not required
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
-                             nsISupports *aContext, nsIStreamListener *aListener)
-{
-    nsCOMPtr<nsIInputStream> inputStream;
-    nsresult rv = OpenInputStream(aStartPosition, aReadCount, getter_AddRefs(inputStream));
-    if (NS_FAILED(rv)) return rv;
-    
-    AsyncReadStreamAdaptor *asyncReadStreamAdaptor;
-    asyncReadStreamAdaptor = new AsyncReadStreamAdaptor(this, inputStream);
-    if (!asyncReadStreamAdaptor)
-        return NS_ERROR_OUT_OF_MEMORY;
-    NS_ADDREF(asyncReadStreamAdaptor);
-    mAsyncReadStream = asyncReadStreamAdaptor;
-
-    rv = asyncReadStreamAdaptor->AsyncRead(aStartPosition, aReadCount, aContext, aListener);
-    if (NS_FAILED(rv))
-        delete asyncReadStreamAdaptor;
-    return rv;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::AsyncWrite(nsIInputStream *fromStream, PRUint32 startPosition,
-                              PRInt32 writeCount, nsISupports *ctxt,
-                              nsIStreamObserver *observer)
-{
-    // Not required to be implemented
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetLoadAttributes(nsLoadFlags *aLoadAttributes)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::SetLoadAttributes(nsLoadFlags aLoadAttributes)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetContentType(char* *aContentType)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetContentLength(PRInt32 *aContentLength)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetOwner(nsISupports* *aOwner)
-{
-    *aOwner = mOwner.get();
-    NS_IF_ADDREF(*aOwner);
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::SetOwner(nsISupports* aOwner)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    mOwner = aOwner;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::SetLoadGroup(nsILoadGroup* aLoadGroup)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::GetNotificationCallbacks(nsIInterfaceRequestor* *aNotificationCallbacks)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheChannel::SetNotificationCallbacks(nsIInterfaceRequestor* aNotificationCallbacks)
-{
-    // Not required to be implemented, since it is implemented by cache manager
-    NS_ASSERTION(0, "nsMemCacheChannel method unexpectedly called");
-    return NS_ERROR_NOT_IMPLEMENTED;
-}

mozilla/netwerk/cache/memcache/nsMemCacheChannel.h

@@ -1,61 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-#ifndef _nsMemCacheChannel_h_
-#define _nsMemCacheChannel_h_
-
-#include "nsMemCacheRecord.h"
-#include "nsIChannel.h"
-#include "nsIInputStream.h"
-#include "nsCOMPtr.h"
-
-
-class AsyncReadStreamAdaptor;
-
-class nsMemCacheChannel : public nsIChannel
-{
-public:
-    // Constructors and Destructor
-    nsMemCacheChannel(nsMemCacheRecord *aRecord, nsILoadGroup *aLoadGroup);
-    virtual ~nsMemCacheChannel();
-
-    // Declare nsISupports methods
-    NS_DECL_ISUPPORTS
-
-    // Declare nsIRequest methods
-    NS_DECL_NSIREQUEST
-
-    // Declare nsIChannel methods
-    NS_DECL_NSICHANNEL
-
-protected:
-    void NotifyStorageInUse(PRInt32 aBytesUsed);
-
-    nsCOMPtr<nsMemCacheRecord>   mRecord;
-    nsCOMPtr<nsIInputStream>     mInputStream;
-    nsCOMPtr<nsISupports>        mOwner;
-    AsyncReadStreamAdaptor*      mAsyncReadStream; // non-owning pointer
-
-    friend class MemCacheWriteStreamWrapper;
-    friend class AsyncReadStreamAdaptor;
-};
-
-#endif // _nsMemCacheChannel_h_

mozilla/netwerk/cache/memcache/nsMemCacheRecord.cpp

@@ -1,164 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-#include "nsMemCache.h"
-#include "nsMemCacheRecord.h"
-#include "nsMemCacheChannel.h"
-#include "nsIAllocator.h"
-#include "nsStorageStream.h"
-
-static NS_DEFINE_IID(kINetDataCacheRecord, NS_INETDATACACHERECORD_IID);
-
-nsMemCacheRecord::nsMemCacheRecord()
-    : mKey(0), mKeyLength(0), mMetaData(0), mMetaDataLength(0), mNumChannels(0)
-{
-    NS_INIT_REFCNT();
-}
-
-nsMemCacheRecord::~nsMemCacheRecord()
-{
-    if (mMetaData)
-        delete[] mMetaData;
-    if (mKey)
-        delete[] mKey;
-}	
-     
-NS_IMPL_ISUPPORTS(nsMemCacheRecord, NS_GET_IID(nsINetDataCacheRecord))
-
-NS_IMETHODIMP
-nsMemCacheRecord::GetKey(PRUint32 *aLength, char **aResult)
-{
-    NS_ENSURE_ARG(aResult);
-    *aResult = (char *)nsAllocator::Alloc(mKeyLength);
-    if (!*aResult)
-        return NS_ERROR_OUT_OF_MEMORY;
-    memcpy(*aResult, mKey, mKeyLength);
-    *aLength = mKeyLength;
-    return NS_OK;
-}
-
-nsresult
-nsMemCacheRecord::Init(const char *aKey, PRUint32 aKeyLength,
-                       PRUint32 aRecordID, nsMemCache *aCache)
-{
-    nsresult rv;
-
-    NS_ASSERTION(!mKey, "Memory cache record key set multiple times");
-
-    rv = NS_NewStorageStream(MEM_CACHE_SEGMENT_SIZE, MEM_CACHE_MAX_ENTRY_SIZE,
-                             getter_AddRefs(mStorageStream));
-    if (NS_FAILED(rv)) return rv;
-
-    mKey = new char[aKeyLength];
-    if (!mKey)
-        return NS_ERROR_OUT_OF_MEMORY;
-    memcpy(mKey, aKey, aKeyLength);
-    mKeyLength = aKeyLength;
-    mRecordID = aRecordID;
-    mCache = aCache;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::GetRecordID(PRInt32 *aRecordID)
-{
-    NS_ENSURE_ARG(aRecordID);
-    *aRecordID = mRecordID;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::GetMetaData(PRUint32 *aLength, char **aResult)
-{
-    NS_ENSURE_ARG(aResult);
-
-    *aResult = 0;
-    if (mMetaDataLength) {
-        *aResult = (char*)nsAllocator::Alloc(mMetaDataLength);
-        if (!*aResult)
-            return NS_ERROR_OUT_OF_MEMORY;
-        memcpy(*aResult, mMetaData, mMetaDataLength);
-    }
-    *aLength = mMetaDataLength;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::SetMetaData(PRUint32 aLength, const char *aData)
-{
-    if (mMetaData)
-        delete[] mMetaData;
-    mMetaData = new char[aLength];
-    if (!mMetaData)
-        return NS_ERROR_OUT_OF_MEMORY;
-    memcpy(mMetaData, aData, aLength);
-    mMetaDataLength = aLength;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::GetStoredContentLength(PRUint32 *aStoredContentLength)
-{
-    NS_ENSURE_ARG(aStoredContentLength);
-    return mStorageStream->GetLength(aStoredContentLength);
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::SetStoredContentLength(PRUint32 aStoredContentLength)
-{
-    PRUint32 before, after;
-    mStorageStream->GetLength(&before);
-    nsresult rv = mStorageStream->SetLength(aStoredContentLength);
-    if (NS_FAILED(rv)) return rv;
-    mStorageStream->GetLength(&after);
-    mCache->mOccupancy -= (before - after);
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::Delete(void)
-{
-    if (mNumChannels)
-        return NS_ERROR_NOT_AVAILABLE;
-  
-    return mCache->Delete(this);
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::GetFilename(nsIFileSpec* *aFilename)
-{
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsMemCacheRecord::NewChannel(nsILoadGroup *aLoadGroup, nsIChannel* *aResult)
-{
-    NS_ENSURE_ARG(aResult);
-
-    nsMemCacheChannel* channel = new nsMemCacheChannel(this, aLoadGroup);
-    if (!channel)
-        return NS_ERROR_OUT_OF_MEMORY;
-
-    NS_ADDREF(channel);
-    *aResult = NS_STATIC_CAST(nsIChannel*, channel);
-    return NS_OK;
-
-}

mozilla/netwerk/cache/memcache/nsMemCacheRecord.h

@@ -1,65 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- */
-
-#ifndef _nsMemCacheRecord_h_
-#define _nsMemCacheRecord_h_
-
-#include "nsINetDataCacheRecord.h"
-#include "nsIStorageStream.h"
-#include "nsCOMPtr.h"
-
-class nsMemCache;
-
-class nsMemCacheRecord : public nsINetDataCacheRecord
-{
-
-public:
-    // Declare interface methods
-    NS_DECL_ISUPPORTS
-    NS_DECL_NSINETDATACACHERECORD
-
-protected:
-    // Constructors and Destructor
-    nsMemCacheRecord();
-    virtual ~nsMemCacheRecord();
-
-    nsresult Init(const char *aKey, PRUint32 aKeyLength,
-                  PRUint32 aRecordID, nsMemCache *aCache);
-
-    char*       mKey;              // opaque database key for this record
-    PRUint32    mKeyLength;        // length, in bytes, of mKey
-
-    PRInt32     mRecordID;         // An alternate key for this record
-
-    char*       mMetaData;         // opaque URI metadata
-    PRUint32    mMetaDataLength;   // length, in bytes, of mMetaData
-
-    nsMemCache* mCache;            // weak pointer to the cache database
-                                   //  that this record inhabits
-
-    nsCOMPtr<nsIStorageStream> mStorageStream;
-    PRUint32    mNumChannels;      // Count un-Release'ed nsIChannels
-
-    friend class nsMemCache;
-    friend class nsMemCacheChannel;
-};
-
-#endif // _nsMemCacheRecord_h_

mozilla/netwerk/cache/mgr/Makefile.in

@@ -1,55 +0,0 @@
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-#
-
-DEPTH		= ../../..
-topsrcdir	= @top_srcdir@
-srcdir		= @srcdir@
-VPATH		= @srcdir@
-
-include $(DEPTH)/config/autoconf.mk
-
-MODULE		= nkcache 
-LIBRARY_NAME	= nkcachemgr_s
-
-REQUIRES	= nspr
-
-EXPORTS		= \
-		nsCacheManager.h \
-		$(NULL)
-
-CPPSRCS		= \
-        nsCacheManager.cpp \
-        nsCachedNetData.cpp \
-        nsReplacementPolicy.cpp \
-        nsCacheEntryChannel.cpp \
-		$(NULL)
-
-LOCAL_INCLUDES	= -I$(srcdir)/../public -I$(srcdir)/../include
-
-EXTRA_LIBS	= $(NSPR_LIBS)
-
-# we don't want the shared lib, but we want to force the creation of a
-# static lib.
-override NO_SHARED_LIB=1
-override NO_STATIC_LIB=
-
-include $(topsrcdir)/config/rules.mk
-

mozilla/netwerk/cache/mgr/Makefile.win

@@ -1,45 +0,0 @@
-#!gmake
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-DEPTH=..\..\..
-
-include <$(DEPTH)/config/config.mak>
-
-MODULE = nkcache
-
-LIBRARY_NAME = nkcachemgr_s
-
-CPP_OBJS =                                   \
-	.\$(OBJDIR)\nsCacheManager.obj       \
-	.\$(OBJDIR)\nsCachedNetData.obj      \
-	.\$(OBJDIR)\nsReplacementPolicy.obj  \
-	.\$(OBJDIR)\nsCacheEntryChannel.obj  \
-	$(NULL)
-
-include <$(DEPTH)\config\rules.mak> 
-
-install:: $(LIBRARY)
-	$(MAKE_INSTALL) $(LIBRARY) $(DIST)\lib
-
-clobber::
-        rm -rf $(OBJDIR)
-        rm -f $(DIST)\lib\$(LIBRARY_NAME).lib
-

mozilla/netwerk/cache/mgr/nsCacheEntryChannel.cpp

@@ -1,261 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-
-#include "nsCacheManager.h"
-#include "nsCacheEntryChannel.h"
-#include "nsIOutputStream.h"
-#include "nsIIOService.h"
-#include "nsIServiceManager.h"
-#include "nsIStreamListener.h"
-
-nsCacheEntryChannel::nsCacheEntryChannel(nsCachedNetData* aCacheEntry, nsIChannel* aChannel,
-                                         nsILoadGroup* aLoadGroup):
-    nsChannelProxy(aChannel), mCacheEntry(aCacheEntry), mLoadGroup(aLoadGroup), mLoadAttributes(0)
-{
-    NS_ASSERTION(aCacheEntry->mChannelCount < 0xFF, "Overflowed channel counter");
-    mCacheEntry->mChannelCount++;
-    NS_INIT_REFCNT();
-}
-
-nsCacheEntryChannel::~nsCacheEntryChannel()
-{
-    mCacheEntry->mChannelCount--;
-}
-
-NS_IMPL_ISUPPORTS3(nsCacheEntryChannel, nsISupports, nsIChannel, nsIRequest)
-
-// A proxy for nsIOutputStream
-class CacheOutputStream : public nsIOutputStream {
-
-public:
-    CacheOutputStream(nsIOutputStream *aOutputStream, nsCachedNetData *aCacheEntry):
-        mOutputStream(aOutputStream), mCacheEntry(aCacheEntry), mStartTime(PR_Now())
-        { NS_INIT_REFCNT(); }
-
-    virtual ~CacheOutputStream() {
-        mCacheEntry->NoteDownloadTime(mStartTime, PR_Now());
-        mCacheEntry->ClearFlag(nsCachedNetData::UPDATE_IN_PROGRESS);
-    }
-    
-    NS_DECL_ISUPPORTS
-
-    NS_IMETHOD Close() {
-        return mOutputStream->Close();
-    }
-
-    NS_IMETHOD Flush() { return mOutputStream->Flush(); }
-
-    NS_IMETHOD
-    Write(const char *aBuf, PRUint32 aCount, PRUint32 *aActualBytes) {
-        nsresult rv;
-    
-        *aActualBytes = 0;
-        rv = mOutputStream->Write(aBuf, aCount, aActualBytes);
-        mCacheEntry->mLogicalLength += *aActualBytes;
-        if (NS_FAILED(rv)) return rv;
-        nsCacheManager::LimitCacheSize();
-        return rv;
-    }
-    
-protected:
-    nsCOMPtr<nsIOutputStream> mOutputStream;
-    nsCOMPtr<nsCachedNetData> mCacheEntry;
-
-    // Time at which stream was opened
-    PRTime mStartTime;
-};
-
-NS_IMPL_ISUPPORTS(CacheOutputStream, NS_GET_IID(nsIOutputStream))
-
-NS_IMETHODIMP
-nsCacheEntryChannel::OpenOutputStream(PRUint32 aStartPosition, nsIOutputStream* *aOutputStream)
-{
-    nsresult rv;
-    nsCOMPtr<nsIOutputStream> baseOutputStream;
-    
-    rv = mChannel->OpenOutputStream(aStartPosition, getter_AddRefs(baseOutputStream));
-    if (NS_FAILED(rv)) return rv;
-
-    mCacheEntry->NoteUpdate();
-    mCacheEntry->NoteAccess();
-    mCacheEntry->mLogicalLength = aStartPosition;
-
-    *aOutputStream = new CacheOutputStream(baseOutputStream, mCacheEntry);
-    if (!*aOutputStream)
-        return NS_ERROR_OUT_OF_MEMORY;
-    NS_ADDREF(*aOutputStream);
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheEntryChannel::OpenInputStream(PRUint32 aStartPosition, PRInt32 aReadCount,
-				     nsIInputStream* *aInputStream)
-{
-    mCacheEntry->NoteAccess();
-    return mChannel->OpenInputStream(aStartPosition, aReadCount, aInputStream);
-}
-
-class CacheManagerStreamListener: public nsIStreamListener  {
-
-    public:
-    
-    CacheManagerStreamListener(nsIStreamListener *aListener,
-                               nsILoadGroup *aLoadGroup, nsIChannel *aChannel):
-        mListener(aListener), mLoadGroup(aLoadGroup), mChannel(aChannel)
-        { NS_INIT_REFCNT(); }
-
-    virtual ~CacheManagerStreamListener() {}
-
-    private:
-
-    NS_DECL_ISUPPORTS
-
-    NS_IMETHOD
-    OnDataAvailable(nsIChannel *channel, nsISupports *aContext,
-                    nsIInputStream *inStr, PRUint32 sourceOffset, PRUint32 count) {
-        return mListener->OnDataAvailable(mChannel, aContext, inStr, sourceOffset, count);
-    }
-
-    NS_IMETHOD
-    OnStartRequest(nsIChannel *channel, nsISupports *aContext) {
-        if (mLoadGroup)
-            mLoadGroup->AddChannel(mChannel, aContext);
-        return mListener->OnStartRequest(mChannel, aContext);
-    }
-
-    NS_IMETHOD
-    OnStopRequest(nsIChannel *channel, nsISupports *aContext,
-                  nsresult status, const PRUnichar *errorMsg) {
-        nsresult rv;
-        rv = mListener->OnStopRequest(mChannel, aContext, status, errorMsg);
-        if (mLoadGroup)
-            mLoadGroup->RemoveChannel(mChannel, aContext, status, errorMsg);
-        return rv;
-    }
-
-    private:
-    
-    nsCOMPtr<nsIStreamListener>  mListener;
-    nsCOMPtr<nsILoadGroup>       mLoadGroup;
-    nsCOMPtr<nsIChannel>         mChannel;
-};
-
-NS_IMPL_ISUPPORTS2(CacheManagerStreamListener, nsIStreamListener, nsIStreamObserver)
-
-NS_IMETHODIMP
-nsCacheEntryChannel::AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
-                               nsISupports *aContext, nsIStreamListener *aListener)
-{
-    nsresult rv;
-
-    mCacheEntry->NoteAccess();
-
-    nsCOMPtr<nsIStreamListener> headListener;
-    if (mLoadGroup) {
-        mLoadGroup->GetDefaultLoadAttributes(&mLoadAttributes);
-
-        // Create a load group "proxy" listener...
-        nsCOMPtr<nsILoadGroupListenerFactory> factory;
-        rv = mLoadGroup->GetGroupListenerFactory(getter_AddRefs(factory));
-        if (NS_SUCCEEDED(rv) && factory) {
-            rv = factory->CreateLoadGroupListener(aListener, 
-                                                  getter_AddRefs(headListener));
-            if (NS_FAILED(rv)) return rv;
-        }
-
-    } else {
-        headListener = aListener;
-    }
-
-    CacheManagerStreamListener* cacheManagerStreamListener;
-    nsIChannel *channelForListener;
-
-    channelForListener = mProxyChannel ? mProxyChannel.get() : NS_STATIC_CAST(nsIChannel*, this);
-    cacheManagerStreamListener =
-        new CacheManagerStreamListener(headListener, mLoadGroup, channelForListener);
-    if (!cacheManagerStreamListener) return NS_ERROR_OUT_OF_MEMORY;
-    
-    NS_ADDREF(cacheManagerStreamListener);
-    rv = mChannel->AsyncRead(aStartPosition, aReadCount, aContext,
-                             cacheManagerStreamListener);
-    NS_RELEASE(cacheManagerStreamListener);
-
-    return rv;
-}
-
-// No async writes allowed to the cache yet
-NS_IMETHODIMP
-nsCacheEntryChannel::AsyncWrite(nsIInputStream *aFromStream, PRUint32 aStartPosition,
-				PRInt32 aWriteCount, nsISupports *aContext,
-				nsIStreamObserver *aObserver)
-{
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-NS_IMETHODIMP
-nsCacheEntryChannel::GetLoadGroup(nsILoadGroup* *aLoadGroup)
-{
-    *aLoadGroup = mLoadGroup;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheEntryChannel::GetLoadAttributes(nsLoadFlags *aLoadAttributes)
-{
-    *aLoadAttributes = mLoadAttributes;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheEntryChannel::SetLoadAttributes(nsLoadFlags aLoadAttributes)
-{
-    mLoadAttributes = aLoadAttributes;
-    return NS_OK;
-}
-
-static NS_DEFINE_CID(kIOServiceCID, NS_IOSERVICE_CID);
-
-NS_IMETHODIMP
-nsCacheEntryChannel::GetURI(nsIURI * *aURI)
-{
-    char* spec;
-    nsresult rv;
-
-    rv = mCacheEntry->GetUriSpec(&spec);
-    if (NS_FAILED(rv)) return rv;
-
-    NS_WITH_SERVICE(nsIIOService, serv, kIOServiceCID, &rv);
-    if (NS_FAILED(rv)) return rv;
-    
-    rv = serv->NewURI(spec, 0, aURI);
-    nsAllocator::Free(spec);
-    return rv;
-}
-
-NS_IMETHODIMP
-nsCacheEntryChannel::GetOriginalURI(nsIURI * *aURI)
-{
-    // FIXME - should return original URI passed into NewChannel() ?
-    return NS_ERROR_NOT_IMPLEMENTED;
-}

mozilla/netwerk/cache/mgr/nsCacheEntryChannel.h

@@ -1,82 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-
-#ifndef _nsCacheEntryChannel_h_
-#define _nsCacheEntryChannel_h_
-
-#include "nsCOMPtr.h"
-#include "nsIChannel.h"
-#include "nsCachedNetData.h"
-#include "nsILoadGroup.h"
-
-class nsIStreamListener;
-
-// A proxy for an nsIChannel, useful when only a few nsIChannel
-// methods must be overridden
-class nsChannelProxy : public nsIChannel {
-
-public:
-    NS_FORWARD_NSICHANNEL(mChannel->)
-    NS_FORWARD_NSIREQUEST(mChannel->)
-
-protected:
-    nsChannelProxy(nsIChannel* aChannel):mChannel(aChannel) {};
-    virtual ~nsChannelProxy() {};
-    nsCOMPtr<nsIChannel>      mChannel;
-};
-
-// Override several nsIChannel methods so that they interact with the cache manager
-class nsCacheEntryChannel : public nsChannelProxy {
-
-public:
-    NS_DECL_ISUPPORTS
-
-    NS_IMETHOD OpenOutputStream(PRUint32 aStartPosition, nsIOutputStream* *aOutputStream);
-    NS_IMETHOD OpenInputStream(PRUint32 aStartPosition, PRInt32 aReadCount,
-			       nsIInputStream* *aInputStream);
-    NS_IMETHOD AsyncRead(PRUint32 aStartPosition, PRInt32 aReadCount,
-			 nsISupports *aContext, nsIStreamListener *aListener);
-    NS_IMETHOD AsyncWrite(nsIInputStream *aFromStream, PRUint32 aStartPosition,
-			  PRInt32 aWriteCount, nsISupports *aContext,
-			  nsIStreamObserver *aObserver);
-    NS_IMETHOD GetLoadAttributes(nsLoadFlags *aLoadAttributes);
-    NS_IMETHOD SetLoadAttributes(nsLoadFlags aLoadAttributes);
-    NS_IMETHOD GetLoadGroup(nsILoadGroup* *aLoadGroup);
-    NS_IMETHOD GetURI(nsIURI * *aURI);
-    NS_IMETHOD GetOriginalURI(nsIURI * *aURI);
-
-protected:
-    nsCacheEntryChannel(nsCachedNetData* aCacheEntry, nsIChannel* aChannel, nsILoadGroup* aLoadGroup);
-    virtual ~nsCacheEntryChannel();
-
-    friend class nsCachedNetData;
-
-private:
-    nsCOMPtr<nsCachedNetData>    mCacheEntry;
-    nsCOMPtr<nsILoadGroup>       mLoadGroup;
-    nsCOMPtr<nsIChannel>         mProxyChannel;
-    nsLoadFlags                  mLoadAttributes;
-};
-
-#endif // _nsCacheEntryChannel_h_

mozilla/netwerk/cache/mgr/nsCacheManager.cpp

@@ -1,497 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * 
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-
-#include "nsINetDataCache.h"
-#include "nsCacheManager.h"
-#include "nsCachedNetData.h"
-#include "nsReplacementPolicy.h"
-#include "nsString.h"
-#include "nsIURI.h"
-#include "nsHashtable.h"
-#include "nsIComponentManager.h"
-#include "nsINetDataDiskCache.h"
-
-// Limit the number of entries in the cache to conserve memory space
-// in the nsReplacementPolicy code
-#define MAX_MEM_CACHE_ENTRIES    800
-#define MAX_DISK_CACHE_ENTRIES  3200
-
-// Cache capacities in MB, overridable via APIs
-#define DEFAULT_MEMORY_CACHE_CAPACITY  1024
-#define DEFAULT_DISK_CACHE_CAPACITY   10000
-
-#define CACHE_HIGH_WATER_MARK(capacity) ((PRUint32)(0.98 * (capacity)))
-#define CACHE_LOW_WATER_MARK(capacity)  ((PRUint32)(0.97 * (capacity)))
-
-nsCacheManager* gCacheManager = 0;
-
-NS_IMPL_ISUPPORTS(nsCacheManager, NS_GET_IID(nsINetDataCacheManager))
-
-nsCacheManager::nsCacheManager()
-    : mActiveCacheRecords(0),
-    mDiskCacheCapacity(DEFAULT_DISK_CACHE_CAPACITY),
-    mMemCacheCapacity(DEFAULT_MEMORY_CACHE_CAPACITY)
-{
-    NS_ASSERTION(!gCacheManager, "Multiple cache managers created");
-    gCacheManager = this;
-    NS_INIT_REFCNT();
-}
-
-nsCacheManager::~nsCacheManager()
-{
-    gCacheManager = 0;
-    delete mActiveCacheRecords;
-    delete mMemSpaceManager;
-    delete mDiskSpaceManager;
-}
-
-nsresult
-nsCacheManager::Init()
-{
-    nsresult rv;
-
-    mActiveCacheRecords = new nsHashtable(64);
-    if (!mActiveCacheRecords)
-        return NS_ERROR_OUT_OF_MEMORY;
-
-    // Instantiate the memory cache component
-    rv = nsComponentManager::CreateInstance(NS_NETWORK_MEMORY_CACHE_PROGID,
-                                            nsnull,
-                                            NS_GET_IID(nsINetDataCache),
-                                            getter_AddRefs(mMemCache));
-    if (NS_FAILED(rv))
-        return rv;
-
-    rv = nsComponentManager::CreateInstance(NS_NETWORK_FLAT_CACHE_PROGID,
-                                            nsnull,
-                                            NS_GET_IID(nsINetDataCache),
-
-                                            getter_AddRefs(mFlatCache));
-
-    if (NS_FAILED(rv)) {
-        // For now, we don't require a flat cache module to be present
-        if (rv != NS_ERROR_FACTORY_NOT_REGISTERED)
-            return rv;
-    }
-
-#ifdef FILE_CACHE_IS_READY
-    // Instantiate the file cache component
-    rv = nsComponentManager::CreateInstance(NS_NETWORK_FILE_CACHE_PROGID,
-                                            nsnull,
-                                            NS_GET_IID(nsINetDataCache),
-                                            getter_AddRefs(mFileCache));
-    if (NS_FAILED(rv)) {
-        NS_WARNING("No disk cache present");
-    }
-#endif
-
-    // Set up linked list of caches in search order
-    mCacheSearchChain = mMemCache;
-    if (mFlatCache) {
-        mMemCache->SetNextCache(mFlatCache);
-        mFlatCache->SetNextCache(mFileCache);
-    } else {
-        mMemCache->SetNextCache(mFileCache);
-    }
-
-    // TODO - Load any extension caches here
-
-    // Initialize replacement policy for memory cache module
-    mMemSpaceManager = new nsReplacementPolicy;
-    if (!mMemSpaceManager)
-        return NS_ERROR_OUT_OF_MEMORY;
-    rv = mMemSpaceManager->Init(MAX_MEM_CACHE_ENTRIES);
-    if (NS_FAILED(rv)) return rv;
-    rv = mMemSpaceManager->AddCache(mMemCache);
-
-    // Initialize replacement policy for disk cache modules (file
-    // cache and flat cache)
-    mDiskSpaceManager = new nsReplacementPolicy;
-    if (!mDiskSpaceManager)
-        return NS_ERROR_OUT_OF_MEMORY;
-    rv = mDiskSpaceManager->Init(MAX_DISK_CACHE_ENTRIES);
-    if (NS_FAILED(rv)) return rv;
-    if (mFileCache) {
-        rv = mDiskSpaceManager->AddCache(mFileCache);
-        if (NS_FAILED(rv)) return rv;
-    }
-    if (mFlatCache) {
-        rv = mDiskSpaceManager->AddCache(mFlatCache);
-        if (NS_FAILED(rv)) return rv;
-    }
-
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::GetCachedNetData(const char *aUriSpec, const char *aSecondaryKey,
-                                 PRUint32 aSecondaryKeyLength,
-                                 PRUint32 aFlags, nsICachedNetData* *aResult)
-{
-    nsCachedNetData *cachedData;
-    nsresult rv;
-    nsINetDataCache *cache;
-    nsReplacementPolicy *spaceManager;
-
-    if (aFlags & CACHE_AS_FILE) {
-        cache = mFileCache;
-        spaceManager = mDiskSpaceManager;
-
-        // Ensure that cache is initialized
-        if (mDiskCacheCapacity == (PRUint32)-1)
-            return NS_ERROR_NOT_AVAILABLE;
-
-    } else if ((aFlags & BYPASS_PERSISTENT_CACHE) ||
-               (!mFileCache && !mFlatCache) || !mDiskCacheCapacity) {
-        cache = mMemCache;
-        spaceManager = mMemSpaceManager;
-    } else {
-        cache = mFlatCache ? mFlatCache : mFileCache;
-        spaceManager = mDiskSpaceManager;
-    }
-
-    // Construct the cache key by appending the secondary key to the URI spec
-    nsCAutoString cacheKey(aUriSpec);
-
-    // Insert NUL at end of URI spec
-    cacheKey += '\0';
-    if (aSecondaryKey)
-        cacheKey.Append(aSecondaryKey, aSecondaryKeyLength);
-
-    nsStringKey key(cacheKey);
-    cachedData = (nsCachedNetData*)mActiveCacheRecords->Get(&key);
-
-    // There is no existing instance of nsCachedNetData for this URL.
-    // Make one from the corresponding record in the cache module.
-    if (cachedData) {
-        NS_ASSERTION(cache == cachedData->mCache,
-                     "Cannot yet handle simultaneously active requests for the "
-                     "same URL using different caches");
-        NS_ADDREF(cachedData);
-    } else {
-        rv = spaceManager->GetCachedNetData(cacheKey.GetBuffer(), cacheKey.Length(),
-                                            cache, &cachedData);
-        if (NS_FAILED(rv)) return rv;
-
-        mActiveCacheRecords->Put(&key, cachedData);
-    }
-    
-    *aResult = cachedData;
-    return NS_OK;
-}
-
-// Remove this cache entry from the list of active ones
-nsresult
-nsCacheManager::NoteDormant(nsCachedNetData* aEntry)
-{
-    nsresult rv;
-    PRUint32 keyLength;
-    char* key;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsCachedNetData* deletedEntry;
-
-    rv = aEntry->GetRecord(getter_AddRefs(record));
-    if (NS_FAILED(rv)) return rv;
-    
-    rv = record->GetKey(&keyLength, &key);
-    if (NS_FAILED(rv)) return rv;
-    
-    nsStringKey hashTableKey(nsCString(key, keyLength));
-    deletedEntry = (nsCachedNetData*)gCacheManager->mActiveCacheRecords->Remove(&hashTableKey);
-//  NS_ASSERTION(deletedEntry == aEntry, "Hash table inconsistency");
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::Contains(const char *aUriSpec, const char *aSecondaryKey,
-                         PRUint32 aSecondaryKeyLength,
-                         PRUint32 aFlags, PRBool *aResult)
-{
-    nsINetDataCache *cache;
-    nsReplacementPolicy *spaceManager;
-    nsCachedNetData *cachedData;
-
-    if (aFlags & CACHE_AS_FILE) {
-        cache = mFileCache;
-        spaceManager = mDiskSpaceManager;
-    } else if ((aFlags & BYPASS_PERSISTENT_CACHE) ||
-               (!mFileCache && !mFlatCache) || !mDiskCacheCapacity) {
-        cache = mMemCache;
-        spaceManager = mMemSpaceManager;
-    } else {
-        cache = mFlatCache ? mFlatCache : mFileCache;
-        spaceManager = mDiskSpaceManager;
-    }
-
-    // Construct the cache key by appending the secondary key to the URI spec
-    nsCAutoString cacheKey(aUriSpec);
-
-    // Insert NUL between URI spec and secondary key
-    cacheKey += '\0';
-    cacheKey.Append(aSecondaryKey, aSecondaryKeyLength);
-
-    // Locate the record using (URI + secondary key)
-    nsStringKey key(cacheKey);
-    cachedData = (nsCachedNetData*)mActiveCacheRecords->Get(&key);
-
-    if (cachedData && (cache == cachedData->mCache)) {
-        *aResult = PR_TRUE;
-        return NS_OK;
-    } else {
-        // No active cache entry, see if there is a dormant one
-        return cache->Contains(cacheKey.GetBuffer(), cacheKey.Length(), aResult);
-    }
-}
-
-NS_IMETHODIMP
-nsCacheManager::GetNumEntries(PRUint32 *aNumEntries)
-{
-    nsresult rv;
-    nsCOMPtr<nsISimpleEnumerator> iterator;
-    nsCOMPtr<nsISupports> cacheSupports;
-    nsCOMPtr<nsINetDataCache> cache;
-
-    PRUint32 totalEntries = 0;
-    
-    rv = NewCacheModuleIterator(getter_AddRefs(iterator));
-    if (NS_FAILED(rv)) return rv;
-    while (1) {
-        PRBool notDone;
-        rv = iterator->HasMoreElements(&notDone);
-        if (NS_FAILED(rv)) return rv;
-        if (!notDone)
-            break;
-        
-        iterator->GetNext(getter_AddRefs(cacheSupports));
-        cache = do_QueryInterface(cacheSupports);
-        
-        PRUint32 numEntries;
-        rv = cache->GetNumEntries(&numEntries);
-        if (NS_FAILED(rv)) return rv;
-        totalEntries += numEntries;
-    }
-    
-    *aNumEntries = totalEntries;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::NewCacheEntryIterator(nsISimpleEnumerator* *aResult)
-{
-    return NS_ERROR_NOT_IMPLEMENTED;
-}
-
-class CacheEnumerator : public nsISimpleEnumerator
-{
-public:
-    CacheEnumerator(nsINetDataCache* aFirstCache):mCache(aFirstCache)
-        { NS_INIT_REFCNT(); }
-
-    virtual ~CacheEnumerator() {};
-    
-    NS_DECL_ISUPPORTS
-
-    NS_IMETHODIMP
-    HasMoreElements(PRBool* aMoreElements) {
-        *aMoreElements = (mCache != 0);
-        return NS_OK;
-    }
-
-    NS_IMETHODIMP
-    GetNext(nsISupports* *aSupports) {
-        *aSupports = mCache;
-        if (!mCache)
-            return NS_ERROR_FAILURE;
-        NS_ADDREF(*aSupports);
-
-        nsCOMPtr<nsINetDataCache> nextCache;
-        nsresult rv = mCache->GetNextCache(getter_AddRefs(nextCache));
-        mCache = nextCache;
-        return rv;
-    }
-
-private:
-    nsCOMPtr<nsINetDataCache> mCache;
-};
-
-NS_IMPL_ISUPPORTS(CacheEnumerator, NS_GET_IID(nsISimpleEnumerator))
-
-NS_IMETHODIMP
-nsCacheManager::NewCacheModuleIterator(nsISimpleEnumerator* *aResult)
-{
-    *aResult = new CacheEnumerator(mCacheSearchChain);
-    if (!*aResult)
-        return NS_ERROR_OUT_OF_MEMORY;
-    NS_ADDREF(*aResult);
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::RemoveAll(void)
-{
-    nsresult rv, result;
-    nsCOMPtr<nsISimpleEnumerator> iterator;
-    nsCOMPtr<nsINetDataCache> cache;
-    nsCOMPtr<nsISupports> iSupports;
-
-    result = NS_OK;
-    rv = NewCacheModuleIterator(getter_AddRefs(iterator));
-    if (NS_FAILED(rv)) return rv;
-    while (1) {
-        PRBool notDone;
-        rv = iterator->HasMoreElements(&notDone);
-        if (NS_FAILED(rv)) return rv;
-        if (!notDone)
-            break;
-        
-        iterator->GetNext(getter_AddRefs(iSupports));
-        cache = do_QueryInterface(iSupports);
-
-        PRUint32 cacheFlags;
-        rv = cache->GetFlags(&cacheFlags);
-        if (NS_FAILED(rv)) return rv;
-        
-        if ((cacheFlags & nsINetDataCache::READ_ONLY) == 0) {
-            rv = cache->RemoveAll();
-            if (NS_FAILED(rv))
-                result = rv;
-        }
-    }
-
-    return result;
-}
-
-nsresult
-nsCacheManager::LimitMemCacheSize()
-{
-    nsresult rv;
-    nsReplacementPolicy* spaceManager;
-
-    NS_ASSERTION(gCacheManager, "No cache manager");
-
-    spaceManager = gCacheManager->mMemSpaceManager;
-
-    PRUint32 occupancy;
-    rv = spaceManager->GetStorageInUse(&occupancy);
-    if (NS_FAILED(rv)) return rv;
-
-    PRUint32 memCacheCapacity = gCacheManager->mMemCacheCapacity;
-    if (occupancy > CACHE_HIGH_WATER_MARK(memCacheCapacity))
-        return spaceManager->Evict(CACHE_LOW_WATER_MARK(memCacheCapacity));
-
-    return NS_OK;
-}
-
-nsresult
-nsCacheManager::LimitDiskCacheSize()
-{
-    nsresult rv;
-    nsReplacementPolicy* spaceManager;
-
-    NS_ASSERTION(gCacheManager, "No cache manager");
-
-    spaceManager = gCacheManager->mDiskSpaceManager;
-
-    PRUint32 occupancy;
-    rv = spaceManager->GetStorageInUse(&occupancy);
-    if (NS_FAILED(rv)) return rv;
-
-    PRUint32 diskCacheCapacity = gCacheManager->mDiskCacheCapacity;
-    if (occupancy > CACHE_HIGH_WATER_MARK(diskCacheCapacity))
-        return spaceManager->Evict(CACHE_LOW_WATER_MARK(diskCacheCapacity));
-
-    return NS_OK;
-}
-
-nsresult
-nsCacheManager::LimitCacheSize()
-{
-    nsresult rv;
-
-    rv = LimitDiskCacheSize();
-    if (NS_FAILED(rv)) return rv;
-
-    rv = LimitMemCacheSize();
-    if (NS_FAILED(rv)) return rv;
-
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::SetMemCacheCapacity(PRUint32 aCapacity)
-{
-    mMemCacheCapacity = aCapacity;
-    LimitCacheSize();
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::GetMemCacheCapacity(PRUint32* aCapacity)
-{
-    NS_ENSURE_ARG_POINTER(aCapacity);
-    *aCapacity = mMemCacheCapacity;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::SetDiskCacheCapacity(PRUint32 aCapacity)
-{
-    mDiskCacheCapacity = aCapacity;
-    LimitCacheSize();
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::GetDiskCacheCapacity(PRUint32* aCapacity)
-{
-    NS_ENSURE_ARG_POINTER(aCapacity);
-    *aCapacity = mDiskCacheCapacity;
-    return NS_OK;
-}
-
-NS_IMETHODIMP
-nsCacheManager::SetDiskCacheFolder(nsIFileSpec* aFolder)
-{
-    NS_ENSURE_ARG(aFolder);
-
-    if (!mFileCache)
-        return NS_ERROR_NOT_AVAILABLE;
-
-    nsCOMPtr<nsINetDataDiskCache> fileCache;
-    fileCache = do_QueryInterface(mFileCache);
-    return fileCache->SetDiskCacheFolder(aFolder);
-}
-
-NS_IMETHODIMP
-nsCacheManager::GetDiskCacheFolder(nsIFileSpec* *aFolder)
-{
-    NS_ENSURE_ARG(aFolder);
-
-    if (!mFileCache)
-        return NS_ERROR_NOT_AVAILABLE;
-
-    nsCOMPtr<nsINetDataDiskCache> fileCache;
-    fileCache = do_QueryInterface(mFileCache);
-    return fileCache->GetDiskCacheFolder(aFolder);
-}

mozilla/netwerk/cache/mgr/nsCacheManager.h

@@ -1,100 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-
-#ifndef _nsCacheManager_h_
-#define _nsCacheManager_h_
-
-// 2030f0b0-9567-11d3-90d3-0040056a906e
-#define NS_CACHE_MANAGER_CID                              \
-    {                                                     \
-        0x2030f0b0,                                       \
-        0x9567,                                           \
-        0x11d3,                                           \
-        {0x90, 0xd3, 0x00, 0x40, 0x05, 0x6a, 0x90, 0x6e}  \
-    }
-
-#include "nsINetDataCacheManager.h"
-#include "nsINetDataCache.h"
-#include "nsCOMPtr.h"
-
-class nsHashtable;
-class nsReplacementPolicy;
-class nsCachedNetData;
-
-class nsCacheManager : public nsINetDataCacheManager {
-
-public:
-    nsCacheManager();
-    virtual ~nsCacheManager();
-
-    NS_METHOD Init();
-
-    // nsISupports methods
-    NS_DECL_ISUPPORTS
-
-    // nsINetDataCacheManager methods
-    NS_DECL_NSINETDATACACHEMANAGER
-
-private:
-	
-    // Mapping from cache key to nsCachedNetData, but only for those cache
-    // entries with external references, i.e. those referred to outside the
-    // cache manager
-    nsHashtable*              mActiveCacheRecords;
-
-    // Memory cache
-    nsCOMPtr<nsINetDataCache> mMemCache;
-
-    // Flat-file database cache; All content aggregated into single disk file
-    nsCOMPtr<nsINetDataCache> mFlatCache;
-
-    // stream-as-file cache
-    nsCOMPtr<nsINetDataCache> mFileCache;
-
-    // Unified replacement policy for flat-cache and file-cache
-    nsReplacementPolicy*      mDiskSpaceManager;
-    
-    // Replacement policy for memory cache
-    nsReplacementPolicy*      mMemSpaceManager;
-
-    // List of caches in search order
-    nsINetDataCache*          mCacheSearchChain;
-
-    // Combined file/flat cache capacity, in KB
-    PRUint32                  mDiskCacheCapacity;
-
-    // Memory cache capacity, in KB
-    PRUint32                  mMemCacheCapacity;
-
-protected:
-    static nsresult NoteDormant(nsCachedNetData* aEntry);
-    static nsresult LimitCacheSize();
-    static nsresult LimitMemCacheSize();
-    static nsresult LimitDiskCacheSize();
-
-    friend class nsCachedNetData;
-    friend class CacheOutputStream;
-};
-
-#endif // _nsCacheManager_h_

mozilla/netwerk/cache/mgr/nsCachedNetData.h

@@ -1,242 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-
-#ifndef _nsCachedNetData_h_
-#define _nsCachedNetData_h_
-
-#include "nsICachedNetData.h"
-#include "nsCOMPtr.h"
-#include "nsINetDataCacheRecord.h"
-
-class nsINetDataCache;
-class nsIStreamAsFileObserver;
-class nsIStreamAsFile;
-class nsIArena;
-class StreamAsFileObserverClosure;
-class CacheMetaData;
-
-// Number of recent access times recorded
-#define MAX_K  3
-
-/**
- * FIXME - add comment.  There are a lot of these data structures resident in
- * memory, so be careful about adding members unnecessarily.
- */
-class nsCachedNetData : public nsICachedNetData {
-
-public:
-    NS_DECL_ISUPPORTS
-
-    // nsICachedNetData methods
-    NS_DECL_NSICACHEDNETDATA
-
-    NS_METHOD Init(nsINetDataCacheRecord *aRecord, nsINetDataCache *aCache);
-
-protected:
-
-    // Bits for mFlags, below
-    typedef enum {
-        DIRTY               = 1 << 0, // Cache entry data needs to be flushed to database
-
-    // ==== Flags that can be set by the protocol handler ====
-        ALLOW_PARTIAL       = 1 << 1, // Protocol handler supports partial fetching
-        UPDATE_IN_PROGRESS  = 1 << 2, // Protocol handler now modifying cache data
-
-    // ==== Cache-entry state flags.  At most one of these flags can be set ====
-        TRUNCATED_CONTENT   = 1 << 4, // Entry contains valid content, but it has
-                                      //   been truncated by cache manager
-
-        // A previously-used cache entry, which has been purged of all cached
-        // content and protocol-private data.  This cache entry can be refilled
-        // with new content or it may be retained in this vestigial state
-        // because the usage statistics it contains will be used by the
-        // replacement policy if the same URI is ever cached again.
-        VESTIGIAL           = 1 << 5,
-
-    // ==== Memory usage status bits.  At most one of these flags can be set ====
-        RECYCLED            = 1 << 8, // Previously associated database record has
-                                      //   been deleted; This cache entry is available
-                                      //   for recycling.
-
-        DORMANT             = 1 << 9, // No references to this cache entry, except by
-                                      //   the cache manager itself
-        
-    // ==== Setter bits ====
-        LAST_MODIFIED_KNOWN = 1 <<12, // Protocol handler called SetLastModifiedTime()
-        EXPIRATION_KNOWN    = 1 <<13, // Protocol handler called SetExpirationTime()
-        STALE_TIME_KNOWN    = 1 <<14, // Protocol handler called SetStaleTime()
-
-    // ==== Useful flag combinations ====
-        // Cache entry not eligible for eviction
-        UNEVICTABLE         = VESTIGIAL | RECYCLED | UPDATE_IN_PROGRESS,
-        
-        // State flags that are in-memory only, i.e. not persistent 
-        TRANSIENT_FLAGS     = DIRTY | RECYCLED | DORMANT
-    } Flag;
-
-    PRBool GetFlag(Flag aFlag) { return (mFlags & aFlag) != 0; }
-    nsresult GetFlag(PRBool *aResult, Flag aFlag) { *aResult = GetFlag(aFlag); return NS_OK; }
-
-    // Set a boolean flag for the cache entry
-    nsresult SetFlag(PRBool aValue, Flag aFlag);
-    nsresult SetFlag(Flag aFlag)   { return SetFlag(PR_TRUE,  aFlag); }
-    nsresult ClearFlag(Flag aFlag) { return SetFlag(PR_FALSE, aFlag); }
-
-    void ComputeProfit(PRUint32 aCurrentTime);
-    static int Compare(const void *a, const void *b, void *unused);
-
-    void NoteAccess();
-    void NoteUpdate();
-
-    // Get underlying raw cache database record.
-    nsresult GetRecord(nsINetDataCacheRecord* *aRecord);
-
-    nsresult GetRecordID(PRInt32 *aRecordID);
-
-    nsresult Evict(PRUint32 aTruncatedContentLength);
-    
-    nsresult GetFileSpec(nsIFileSpec* *aFileSpec);
-
-    void NoteDownloadTime(PRTime start, PRTime end);
-
-    // placement new for arena-allocation
-    void *operator new (size_t aSize, nsIArena *aArena);
-
-    friend class nsReplacementPolicy;
-    friend class nsCacheManager;
-    friend class StreamAsFile;
-    friend class nsCacheEntryChannel;
-    friend class CacheOutputStream;
-    friend class InterceptStreamListener;
-
-private:
-
-    nsCachedNetData() {};
-    virtual ~nsCachedNetData() {};
-
-    // Initialize internal fields of this nsCachedNetData instance from the
-    // underlying raw cache database record.
-    nsresult Deserialize(PRBool aDeserializeFlags);
-
-    // Notify stream-as-file observers about change in cache entry status
-    nsresult Notify(PRUint32 aMessage, nsresult aError);
-
-    // Add/Remove stream-as-file observers
-    nsresult AddObserver(nsIStreamAsFile *aStreamAsFile, nsIStreamAsFileObserver* aObserver);
-    nsresult RemoveObserver(nsIStreamAsFileObserver* aObserver);
-
-    // Mark cache entry to indicate a write out to the cache database is required
-    void SetDirty() { mFlags |= DIRTY; }
-
-    nsresult Resurrect(nsINetDataCacheRecord *aRecord);
-
-    nsresult CommitFlags();
-
-    CacheMetaData* FindTaggedMetaData(const char* aTag, PRBool aCreate);
-
-private:
-    
-    // List of nsIStreamAsFileObserver's that will receive notification events
-    // when the cache manager or a client desires to delete/truncate a cache
-    // entry file.
-    StreamAsFileObserverClosure* mObservers;
-
-    // Protocol-specific meta-data, opaque to the cache manager
-    CacheMetaData *mMetaData;
-
-    // Next in chain for a single bucket in the replacement policy hash table
-    // that maps from record ID to nsCachedNetData
-    nsCachedNetData* mNext;
-    
-    // See flag bits, above
-    // NOTE: 16 bit member is combined with members below for
-    //       struct packing efficiency.  Do not change order of members!
-    PRUint16    mFlags;
-
-protected:
-
-    // Number of nsCacheEntryChannels referring to this record
-    PRUint8     mChannelCount;
-
-    // Below members are statistics kept per cache-entry, used to decide how
-    // profitable it will be to evict a record from the cache relative to other
-    // existing records.  Note: times are measured in *seconds* since the
-    // 1/1/70 epoch, same as a unix time_t.
-
-    // Number of accesses for this cache record
-    // NOTE: 8 bit member is combined with members above for
-    //       struct packing efficiency.  Do not change order of members!
-    PRUint8     mNumAccesses;
-
-    // A reference to the underlying, raw cache database record, either as a
-    // pointer to an in-memory object or as a database record identifier
-    union {
-        nsINetDataCacheRecord* mRecord;
-
-        // Database record ID of associated cache record.  See
-        // nsINetDataCache::GetRecordByID().
-        PRInt32  mRecordID;
-    };
-
-    // Weak link to parent cache
-    nsINetDataCache* mCache;
-
-    // Length of stored content, which may be less than storage consumed if
-    // compression is used
-    PRUint32 mLogicalLength;
-
-    // Most recent cache entry access times, used to compute access frequency
-    PRUint32 mAccessTime[MAX_K];
-    
-    // We use modification time of the original document for replacement policy
-    // computations, i.e. to compute a document's age, but if we don't know it,
-    // we use the time that the document was last written to the cache.
-    union {
-        // Document modification time, if known.
-        PRUint32 mLastModifiedTime;
-
-        // Time of last cache update for this doc
-        PRUint32 mLastUpdateTime;
-    };
-
-    union {
-      // Time until which document is fresh, i.e. does not have to be validated
-      // with server and, therefore, data in cache is guaranteed usable
-      PRUint32 mExpirationTime;
-
-      // Heuristic time at which cached document is likely to be out-of-date
-      // with respect to canonical copy on server.  Used for cache replacement
-      // policy, not for validation.
-      PRUint32 mStaleTime;
-    };
-
-    // Download time per byte, measure roughly in units of KB/s
-    float mDownloadRate;
-    
-    // Heuristic estimate of cache entry future benefits, based on above values
-    float mProfit;
-};
-
-#endif // _nsCachedNetData_h_
-

mozilla/netwerk/cache/mgr/nsReplacementPolicy.cpp

@@ -1,666 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-
-#include "nsReplacementPolicy.h"
-#include "nsCachedNetData.h"
-
-#include "nsQuickSort.h"
-#include "nsIAllocator.h"
-#include "nsIEnumerator.h"
-#include "prtime.h"
-#include "prbit.h"
-#include "nsCOMPtr.h"
-#include <math.h>
-
-// Constant used to estimate frequency of access to a document based on size
-#define CACHE_CONST_B   1.35
-
-// A cache whose space is managed by this replacement policy
-class nsReplacementPolicy::CacheInfo {
-public:
-    CacheInfo(nsINetDataCache* aCache):mCache(aCache),mNext(0) {}
-
-    nsINetDataCache* mCache;
-    CacheInfo*       mNext;
-};
-
-nsReplacementPolicy::nsReplacementPolicy()
-    : mRankedEntries(0), mCaches(0), mRecordsRemovedSinceLastRanking(0),
-      mNumEntries(0), mCapacityRankedEntriesArray(0), mLastRankTime(0) {}
-
-nsReplacementPolicy::~nsReplacementPolicy()
-{
-    if (mRankedEntries)
-        nsAllocator::Free(mRankedEntries);
-    if (mMapRecordIdToEntry)
-        nsAllocator::Free(mMapRecordIdToEntry);
-}
-
-nsresult
-nsReplacementPolicy::Init(PRUint32 aMaxCacheEntries)
-{
-    nsresult rv;
-
-    rv = NS_NewHeapArena(getter_AddRefs(mArena), sizeof(nsCachedNetData) * 32);
-    if (NS_FAILED(rv)) return rv;
-
-    mMaxEntries = aMaxCacheEntries;
-
-    mHashArrayLength = PR_CeilingLog2(aMaxCacheEntries) >> 3;
-    size_t numBytes = mHashArrayLength * sizeof(*mMapRecordIdToEntry);
-    mMapRecordIdToEntry = (nsCachedNetData**)nsAllocator::Alloc(numBytes);
-    if (!mMapRecordIdToEntry)
-        return NS_ERROR_OUT_OF_MEMORY;
-
-    nsCRT::zero(mMapRecordIdToEntry, numBytes);
-
-    return NS_OK;
-}
-
-nsresult
-nsReplacementPolicy::AddCache(nsINetDataCache *aCache)
-{
-    CacheInfo *cacheInfo = new CacheInfo(aCache);
-    if (!cacheInfo)
-        return NS_ERROR_OUT_OF_MEMORY;
-    cacheInfo->mNext = mCaches;
-    mCaches = cacheInfo;
-    return NS_OK;
-}
-
-PRUint32
-nsReplacementPolicy::HashRecordID(PRInt32 aRecordID)
-{
-    return ((aRecordID >> 16) ^ aRecordID) & (mHashArrayLength - 1);
-}
-
-nsCachedNetData*
-nsReplacementPolicy::FindCacheEntryByRecordID(PRInt32 aRecordID, nsINetDataCache *aCache)
-{
-    nsresult rv;
-    nsCachedNetData* cacheEntry;
-    PRUint32 bucket = HashRecordID(aRecordID);
-
-    cacheEntry = mMapRecordIdToEntry[bucket];
-    for (;cacheEntry; cacheEntry = cacheEntry->mNext) {
-
-        PRInt32 recordID;
-        rv = cacheEntry->GetRecordID(&recordID);
-        if (NS_FAILED(rv))
-            continue;
-
-        if ((recordID == aRecordID) && (cacheEntry->mCache == aCache))
-            return cacheEntry;
-    }
-
-    return 0;
-}
-
-// Add a cache entry to the hash table that maps record ID to entries
-void
-nsReplacementPolicy::AddCacheEntry(nsCachedNetData* aCacheEntry, PRInt32 aRecordID)
-{
-    nsCachedNetData** cacheEntryp;
-    PRUint32 bucket = HashRecordID(aRecordID);
-
-    cacheEntryp = &mMapRecordIdToEntry[bucket];
-    while (*cacheEntryp)
-        cacheEntryp = &(*cacheEntryp)->mNext;
-    *cacheEntryp = aCacheEntry;
-    aCacheEntry->mNext = 0;
-}
-
-// Delete a cache entry from the hash table that maps record ID to entries
-nsresult
-nsReplacementPolicy::DeleteCacheEntry(nsCachedNetData* aCacheEntry)
-{
-    nsresult rv;
-    PRInt32 recordID;
-    rv = aCacheEntry->GetRecordID(&recordID);
-    if (NS_FAILED(rv)) return rv;
-
-    PRUint32 bucket = HashRecordID(recordID);
-
-    nsCachedNetData** cacheEntryp;
-    cacheEntryp = &mMapRecordIdToEntry[bucket];
-    while (*cacheEntryp) {
-        if (*cacheEntryp == aCacheEntry) {
-            *cacheEntryp = aCacheEntry->mNext;
-            return NS_OK;
-        }
-        cacheEntryp = &(*cacheEntryp)->mNext;
-    }
-    
-    NS_ASSERTION(0, "hash table inconsistency");
-    return NS_ERROR_FAILURE;
-}
-
-nsresult
-nsReplacementPolicy::AddAllRecordsInCache(nsINetDataCache *aCache)
-{
-    nsresult rv;
-    nsCOMPtr<nsISimpleEnumerator> iterator;
-    nsCOMPtr<nsISupports> iSupports;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    rv = aCache->NewCacheEntryIterator(getter_AddRefs(iterator));
-    if (!NS_SUCCEEDED(rv)) return rv;
-
-    while (1) {
-        PRBool notDone;
-
-        rv = iterator->HasMoreElements(&notDone);
-        if (NS_FAILED(rv)) return rv;
-        if (!notDone)
-            break;
-
-        rv = iterator->GetNext(getter_AddRefs(iSupports));
-        if (!NS_SUCCEEDED(rv)) return rv;
-        record = do_QueryInterface(iSupports);
-        
-        rv = AssociateCacheEntryWithRecord(record, aCache, 0);
-        if (!NS_SUCCEEDED(rv)) return rv;
-    }
-
-    return NS_OK;
-}
-
-// Get current time and convert to seconds since the epoch
-static PRUint32
-now32()
-{
-    double nowFP;
-    PRInt64 now64 = PR_Now();
-    LL_L2D(nowFP, now64);
-    PRUint32 now = (PRUint32)(nowFP * 1e-6);
-    return now;
-}
-
-void
-nsCachedNetData::NoteDownloadTime(PRTime start, PRTime end)
-{
-    double startFP, endFP, rate, duration;
-
-    LL_L2D(startFP, start);
-    LL_L2D(endFP, end);
-
-    duration = endFP - startFP;
-
-    // If the data arrives so fast that it can not be timed due to the clock
-    // granularity, assume a data arrival duration of 10 ms
-    if (!duration)
-        duration = 10000;
-
-    // Compute download rate in kB/s
-    rate = mLogicalLength / (duration * (1e-6 * 1024.0));
-    
-    if (mDownloadRate) {
-        // Exponentially smooth download rate
-        const double alpha = 0.5;
-        mDownloadRate = (float)(mDownloadRate * alpha + rate * (1.0 - alpha));
-    } else {
-        mDownloadRate = (float)rate;
-    }
-}
-
-// 1 hour
-#define MIN_HALFLIFE (60 * 60)
-
-// 1 week
-#define TYPICAL_HALFLIFE (7 * 24 * 60 * 60)
-
-/**
- * Estimate the profit that would be lost if the given cache entry was evicted
- * from the cache.  Profit is defined as the future expected download delay per
- * byte of cached content.  The profit computation is made based on projected
- * frequency of access, prior download performance and a heuristic staleness
- * criteria.  The technique used is a variation of that described in the
- * following paper:
- *
- *    "A Case for Delay-Conscious Caching of Web Documents"
- *    http://www.bell-labs.com/user/rvingral/www97.html
- *
- * Briefly, expected profit is:
- *
- *   (projected frequency of access) * (download time per byte) * (probability freshness)
- */
-void
-nsCachedNetData::ComputeProfit(PRUint32 aNow)
-{
-    PRUint32 K, now;
-
-    if (aNow)
-        now = aNow;
-    else
-        now = now32();
-    
-    K = PR_MIN(MAX_K, mNumAccesses);
-    if (!K) {
-        mProfit = 0;
-        return;
-    }
-
-    // Compute time, in seconds, since k'th most recent access
-    double timeSinceKthAccess = now - mAccessTime[K - 1];
-    if (timeSinceKthAccess <= 0.0)    // Sanity check
-        timeSinceKthAccess = 1.0;
-
-    // Estimate frequency of future document access based on past
-    //  access frequency
-    double frequencyAccess = K / timeSinceKthAccess;
-
-    // If we don't have much historical data on access frequency
-    //   use a heuristic based on document size as an estimate
-    if (mLogicalLength) {
-        if (K == 1) {
-            frequencyAccess /= pow(mLogicalLength, CACHE_CONST_B);
-        } else if (K == 2) {
-            frequencyAccess /= pow(mLogicalLength, CACHE_CONST_B / 2);
-        }
-    }
-
-    // Estimate likelihood that data in cache is fresh, i.e.
-    //  that it corresponds to the document on the server
-    double probabilityFreshness;
-    PRInt32 halfLife, age, docTime;
-    PRBool potentiallyStale;
-
-    docTime = GetFlag(LAST_MODIFIED_KNOWN) ? mLastModifiedTime : mLastUpdateTime;
-    age = now - docTime;
-
-    probabilityFreshness = 1.0; // Optimistic
-
-    if (GetFlag(EXPIRATION_KNOWN)) {
-        potentiallyStale = now > mExpirationTime;
-        halfLife = mExpirationTime - mLastModifiedTime;
-    } else if (GetFlag(STALE_TIME_KNOWN)) {
-        potentiallyStale = PR_TRUE;
-        halfLife = mStaleTime - docTime;
-    } else {
-        potentiallyStale = PR_TRUE;
-        halfLife = TYPICAL_HALFLIFE;
-    }
-    
-    if (potentiallyStale) {
-        if (halfLife < MIN_HALFLIFE)
-            halfLife = MIN_HALFLIFE;
-
-        probabilityFreshness = pow(0.5, (double)age / (double)halfLife);
-    }
-
-    mProfit = (float)(frequencyAccess * probabilityFreshness);
-    if (mDownloadRate)
-        mProfit /= mDownloadRate;
-}
-
-// Number of entries to grow mRankedEntries array when it's full
-#define STATS_GROWTH_INCREMENT  256
-
-
-// Sorting predicate for NS_Quicksort
-int
-nsCachedNetData::Compare(const void *a, const void *b, void *unused)
-{
-    nsCachedNetData* entryA = *(nsCachedNetData**)a;
-    nsCachedNetData* entryB = *(nsCachedNetData**)b;
-
-    // Percolate deleted or empty entries to the end of the mRankedEntries
-    // array, so that they can be recycled.
-    if (!entryA || entryA->GetFlag(RECYCLED)) {
-        if (!entryB || entryB->GetFlag(RECYCLED))
-            return 0;
-        else 
-            return +1;
-    } 
-    if (!entryB || entryB->GetFlag(RECYCLED))
-        return -1;
-
-    // Evicted entries (those with no content data) and active entries (those
-    // currently being updated) are collected towards the end of the sorted
-    // array just prior to the deleted cache entries, since evicted entries
-    // can't be re-evicted.
-    if (entryA->GetFlag(UPDATE_IN_PROGRESS)) {
-        if (entryB->GetFlag(UPDATE_IN_PROGRESS))
-            return 0;
-        else 
-            return +1;
-    } 
-    if (entryB->GetFlag(UPDATE_IN_PROGRESS))
-        return -1;
-
-    PRUint16 Ka = PR_MIN(MAX_K, entryA->mNumAccesses);
-    PRUint16 Kb = PR_MIN(MAX_K, entryB->mNumAccesses);
-
-    // Order cache entries by the number of times they've been accessed
-    if (Ka < Kb)
-        return -1;
-    if (Ka > Kb)
-        return +1;
-
-    /*
-     * Among records that have been accessed an equal number of times, order
-     * them by profit.
-     */
-    if (entryA->mProfit > entryB->mProfit)
-        return +1;
-    if (entryA->mProfit < entryB->mProfit)
-        return -1;
-    return 0;
-}
-
-/**
- * Rank cache entries in terms of their elegibility for eviction.
- */
-nsresult
-nsReplacementPolicy::RankRecords()
-{
-    PRUint32 i, now;
-
-    // Add all cache records if this is the first ranking
-    if (!mLastRankTime) {
-        nsresult rv;
-        CacheInfo *cacheInfo;
-
-        cacheInfo = mCaches;
-        while (cacheInfo) {
-            rv = AddAllRecordsInCache(cacheInfo->mCache);
-            if (NS_FAILED(rv)) return rv;
-
-            cacheInfo = cacheInfo->mNext;
-        }
-    }
-
-    // Get current time and convert to seconds since the epoch
-    now = now32();
-
-    // Recompute profit for every known cache record, except deleted ones
-    for (i = 0; i < mNumEntries; i++) {
-        nsCachedNetData* entry = mRankedEntries[i];
-        if (entry && !entry->GetFlag(nsCachedNetData::RECYCLED))
-            entry->ComputeProfit(now);
-    }
-    NS_QuickSort(mRankedEntries, mNumEntries, sizeof *mRankedEntries, 
-                 nsCachedNetData::Compare, 0);
-
-    mNumEntries -= mRecordsRemovedSinceLastRanking;
-    mRecordsRemovedSinceLastRanking = 0;
-    mLastRankTime = now;
-    return NS_OK;
-}
-
-// A heuristic policy to avoid the cost of re-ranking cache records by
-// profitability every single time space must be made available in the cache.
-void
-nsReplacementPolicy::MaybeRerankRecords()
-{
-    // Rank at most once per minute
-    PRUint32 now = now32();
-    if ((now - mLastRankTime) >= 60)
-        RankRecords();
-}
-
-void
-nsReplacementPolicy::CompactRankedEntriesArray()
-{
-    if (mRecordsRemovedSinceLastRanking || !mLastRankTime)
-        RankRecords();
-}
-
-nsresult
-nsReplacementPolicy::CheckForTooManyCacheEntries()
-{
-    if (mCapacityRankedEntriesArray == mMaxEntries) {
-        return DeleteOneEntry(0);
-    } else {
-        nsresult rv;
-        CacheInfo *cacheInfo;
-
-        cacheInfo = mCaches;
-        while (cacheInfo) {
-            PRUint32 numEntries, maxEntries;
-
-            rv = cacheInfo->mCache->GetNumEntries(&numEntries);
-            if (NS_FAILED(rv)) return rv;
-
-            rv = cacheInfo->mCache->GetMaxEntries(&maxEntries);
-            if (NS_FAILED(rv)) return rv;
-
-            if (numEntries == maxEntries)
-                return DeleteOneEntry(cacheInfo->mCache);
-
-            cacheInfo = cacheInfo->mNext;
-        }
-    }
-    return NS_OK;
-}
-
-
-/** 
- * Create a new association between a low-level cache database record and a
- * cache entry.  Add the entry to the set of entries eligible for eviction from
- * the cache.  This would typically be done when the cache entry is created.
- */
-nsresult
-nsReplacementPolicy::AssociateCacheEntryWithRecord(nsINetDataCacheRecord *aRecord,
-                                                   nsINetDataCache* aCache,
-                                                   nsCachedNetData** aResult)
-{
-    nsCachedNetData* cacheEntry;
-    nsresult rv;
-
-    // First, see if the record is already known to the replacement policy
-    PRInt32 recordID;
-    rv = aRecord->GetRecordID(&recordID);
-    if (NS_FAILED(rv)) return rv;
-    cacheEntry = FindCacheEntryByRecordID(recordID, aCache);
-    if (cacheEntry) {
-        if (aResult) {
-            if (cacheEntry->GetFlag(nsCachedNetData::DORMANT))
-                cacheEntry->Resurrect(aRecord);
-            NS_ADDREF(cacheEntry);
-            *aResult = cacheEntry;
-        }
-        return NS_OK;
-    }
-
-    // Compact the array of cache entry statistics, so that free entries appear
-    // at the end, for possible reuse.
-    if (mNumEntries && (mNumEntries == mCapacityRankedEntriesArray))
-        CompactRankedEntriesArray();
-
-    // If compaction doesn't yield available entries in the
-    // mRankedEntries array, then extend the array.
-    if (mNumEntries == mCapacityRankedEntriesArray) {
-        PRUint32 newCapacity;
-
-        rv = CheckForTooManyCacheEntries();
-        if (NS_FAILED(rv)) return rv;
-
-        newCapacity = mCapacityRankedEntriesArray + STATS_GROWTH_INCREMENT;
-        if (newCapacity > mMaxEntries)
-            newCapacity = mMaxEntries;
-
-        nsCachedNetData** newRankedEntriesArray; 
-        PRUint32 numBytes = sizeof(nsCachedNetData*) * newCapacity;
-        newRankedEntriesArray = 
-            (nsCachedNetData**)nsAllocator::Realloc(mRankedEntries, numBytes);
-        if (!newRankedEntriesArray)
-            return NS_ERROR_OUT_OF_MEMORY;
-        
-        mRankedEntries = newRankedEntriesArray;
-        mCapacityRankedEntriesArray = newCapacity;
-
-        PRUint32 i;
-        for (i = mNumEntries; i < newCapacity; i++)
-            mRankedEntries[i] = 0;
-    }
-
-    // Recycle the record after the last in-use record in the array
-    nsCachedNetData *entry = mRankedEntries[mNumEntries];
-    NS_ASSERTION(!entry || !entry->GetFlag(nsCachedNetData::RECYCLED),
-                 "Only deleted cache entries should appear at end of array");
-
-    if (!entry) {
-        entry = new(mArena) nsCachedNetData;
-        if (!entry)
-            return NS_ERROR_OUT_OF_MEMORY;
-        mRankedEntries[mNumEntries] = entry;
-    } else {
-        // Clear out recycled data structure
-        nsCRT::zero(entry, sizeof(*entry));
-    }
-
-    entry->Init(aRecord, aCache);
-    AddCacheEntry(entry, recordID);
-    
-    // Add one reference to the cache entry from the cache manager
-    NS_ADDREF(entry);
-
-    if (aResult) {
-        // And one reference from our caller
-        NS_ADDREF(entry);
-        *aResult = entry;
-    }
-
-    mNumEntries++;
-    return NS_OK;
-}
-
-nsresult
-nsReplacementPolicy::GetCachedNetData(const char* cacheKey, PRUint32 cacheKeyLength,
-                                      nsINetDataCache* aCache,
-                                      nsCachedNetData** aResult)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-
-    rv = aCache->GetCachedNetData(cacheKey, cacheKeyLength,
-                                  getter_AddRefs(record));
-    if (NS_FAILED(rv)) return rv;
-    return AssociateCacheEntryWithRecord(record, aCache, aResult);
-}
-
-/**
- * Delete the least desirable record from the cache database.  This is used
- * when the addition of another record would exceed either the cache manager or
- * the cache's maximum permitted number of records.
- */
-nsresult
-nsReplacementPolicy::DeleteOneEntry(nsINetDataCache *aCache)
-{
-    PRUint32 i;
-    nsresult rv;
-    nsCachedNetData *entry;
-
-    i = 0;
-    while (1) {
-        MaybeRerankRecords();
-        for (; i < mNumEntries; i++) {
-            entry = mRankedEntries[i];
-            if (!entry || entry->GetFlag(nsCachedNetData::RECYCLED))
-                continue;
-            if (!aCache || (entry->mCache == aCache))
-                break;
-        }
-
-        // Report error if no record found to delete
-        if (i == mNumEntries)
-            return NS_ERROR_FAILURE;
-        rv = entry->Delete();
-        if (NS_SUCCEEDED(rv)) {
-            rv = DeleteCacheEntry(entry);
-            return rv;
-        }
-    }
-}
-
-nsresult
-nsReplacementPolicy::GetStorageInUse(PRUint32* aStorageInUse)
-{
-    nsresult rv;
-    CacheInfo *cacheInfo;
-
-    *aStorageInUse = 0;
-    cacheInfo = mCaches;
-    while (cacheInfo) {
-        PRUint32 cacheStorage;
-        rv = cacheInfo->mCache->GetStorageInUse(&cacheStorage);
-        if (NS_FAILED(rv)) return rv;
-
-        *aStorageInUse += cacheStorage;
-        cacheInfo = cacheInfo->mNext;
-    }
-    return NS_OK;
-}
-
-/**
- * Delete the least desirable records from the cache until the occupancy of the
- * cache has been reduced by the given number of KB.  This is used when the
- * addition of more cache data would exceed the cache's capacity. 
- */
-nsresult
-nsReplacementPolicy::Evict(PRUint32 aTargetOccupancy)
-{
-    PRUint32 i;
-    nsCachedNetData *entry;
-    nsresult rv;
-    PRUint32 occupancy;
-    PRInt32 truncatedLength;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-
-    MaybeRerankRecords();
-    for (i = 0; i < mNumEntries; i++) {
-        rv = GetStorageInUse(&occupancy);
-        if (!NS_SUCCEEDED(rv)) return rv;
-        
-        if (occupancy <= aTargetOccupancy)
-            return NS_OK;
-
-        entry = mRankedEntries[i];
-
-        // Skip deleted/empty cache entries and ones that have already been evicted
-        if (!entry || entry->GetFlag(nsCachedNetData::UNEVICTABLE))
-            continue;
-
-        if (entry->GetFlag(nsCachedNetData::ALLOW_PARTIAL)) {
-            rv = entry->GetRecord(getter_AddRefs(record));
-            if (NS_FAILED(rv))
-                continue;
-
-            PRUint32 contentLength;
-            rv = record->GetStoredContentLength(&contentLength);
-            if (NS_FAILED(rv))
-                continue;
-            
-            // Additional cache storage required, in KB
-            PRUint32 storageToReclaim = (occupancy - aTargetOccupancy) << 10;
-            
-            truncatedLength = (PRInt32)(contentLength - storageToReclaim);
-            if (truncatedLength < 0)
-                truncatedLength = 0;
-        } else {
-            truncatedLength = 0;
-        }
-        rv = entry->Evict(truncatedLength);
-    }
-    return NS_ERROR_FAILURE;
-}

mozilla/netwerk/cache/mgr/nsReplacementPolicy.h

@@ -1,136 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1998-1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-
-/**
- * This class manages one or more caches that share a storage resource, e.g. a
- * file cache and a flat-database cache might each occupy space on the disk and
- * they would share a single instance of nsReplacementPolicy.  The replacement
- * policy heuristically chooses which cache entries to evict when storage is
- * required to accommodate incoming cache data.
- */
-
-#ifndef _nsReplacementPolicy_h_
-#define _nsReplacementPolicy_h_
-
-#include "nscore.h"
-#include "nsISupportsUtils.h"
-#include "nsINetDataCache.h"
-#include "nsICachedNetData.h"
-#include "nsIArena.h"
-#include "nsCOMPtr.h"
-#include "nsHashtable.h"
-
-class nsCachedNetData;
-struct PL_HashTable;
-
-/**
- * This private class is responsible for implementing the network data cache's
- * replacement policy, i.e. it decides which cache data should be evicted to
- * make room for new incoming data.
- */
-class nsReplacementPolicy {
-
-public:
-
-    nsReplacementPolicy();
-    ~nsReplacementPolicy();
-
-protected:
-
-    nsresult Init(PRUint32 aMaxCacheEntries);
-    nsresult AddCache(nsINetDataCache *aCache);
-    nsresult GetCachedNetData(const char* cacheKey, PRUint32 cacheKeyLength,
-                              nsINetDataCache* aCache,
-                              nsCachedNetData** aResult);
-    nsresult GetStorageInUse(PRUint32* aNumKBytes);
-
-    friend class nsCacheManager;
-
-private:
-    nsresult RankRecords();
-    void MaybeRerankRecords();
-    void CompactRankedEntriesArray();
-    nsresult DeleteOneEntry(nsINetDataCache* aCache);
-    nsresult Evict(PRUint32 aTargetOccupancy);
-
-    nsCachedNetData* FindCacheEntryByRecordID(PRInt32 aRecordID, nsINetDataCache *aCache);
-    void AddCacheEntry(nsCachedNetData* aCacheEntry, PRInt32 aRecordID);
-    nsresult DeleteCacheEntry(nsCachedNetData* aCacheEntry);
-    PRUint32 HashRecordID(PRInt32 aRecordID);
-    nsresult AssociateCacheEntryWithRecord(nsINetDataCacheRecord *aRecord,
-                                           nsINetDataCache* aCache,
-                                           nsCachedNetData** aResult);
-
-    nsresult AddAllRecordsInCache(nsINetDataCache *aCache);
-    nsresult CheckForTooManyCacheEntries();
-
-    class CacheInfo;
-
-private:
-
-    // Growable array of pointers to individual cache entries; It is sorted by
-    // profitability, such that low-numbered array indices refer to cache
-    // entries that are the least profitable to retain.  New cache entries are
-    // added to the end of the array.  Deleted cache entries are specially
-    // marked and percolate to the end of the array for recycling whenever
-    // mRankedEntries is sorted.  Evicted cache entries (those with no
-    // associated content data) are retained for the purpose of improving the
-    // replacement policy efficacy, and are percolated towards the end of the
-    // array, just prior to the deleted cache entries.
-    //
-    // The array is not in sorted order 100% of the time; For efficiency
-    // reasons, sorting is only done when heuristically deemed necessary.
-    nsCachedNetData**   mRankedEntries;
-
-    // Hash table buckets to map Record ID to cache entry.  We use this instead
-    // of a PL_HashTable to reduce storage requirements
-    nsCachedNetData**   mMapRecordIdToEntry;
-
-    // Length of mMapRecordIdToEntry array
-    PRUint32            mHashArrayLength;
-
-    // Linked list of caches that share this replacement policy
-    CacheInfo*          mCaches;
-
-    // Allocation area for cache entry (nsCachedNetData) instances
-    nsCOMPtr<nsIArena>  mArena;
-
-    // Bookkeeping
-    PRUint32            mRecordsRemovedSinceLastRanking;
-
-    // Maximum permitted length of mRankedEntries array
-    PRUint32            mMaxEntries;
-
-    // Number of occupied slots in mRankedEntries array
-    PRUint32            mNumEntries;
-
-    // Capacity of mRankedEntries array
-    PRUint32            mCapacityRankedEntriesArray;
-
-    // Time at which cache entries were last ranked by profitability
-    PRUint32            mLastRankTime;
-};
-
-
-#endif // _nsReplacementPolicy_h_

mozilla/netwerk/cache/public/Makefile.in

@@ -1,43 +0,0 @@
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-#
-
-DEPTH		= ../../..
-topsrcdir	= @top_srcdir@
-srcdir		= @srcdir@
-VPATH		= @srcdir@
-
-MODULE		= nkcache
-
-include $(DEPTH)/config/autoconf.mk
-
-XPIDLSRCS	= \
-		nsICachedNetData.idl          \
-	        nsINetDataCacheManager.idl    \
-		nsINetDataCache.idl           \
-		nsINetDataCacheRecord.idl     \
-	        nsINetDataDiskCache.idl       \
-		nsIStreamAsFile.idl           \
-	        $(NULL)
-
-EXPORTS		:= $(addprefix $(srcdir)/, $(EXPORTS))
-
-include $(topsrcdir)/config/rules.mk
-

mozilla/netwerk/cache/public/Makefile.win

@@ -1,41 +0,0 @@
-#!gmake
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-MODULE = nkcache
-
-DEPTH = ..\..\..
-include <$(DEPTH)/config/config.mak>
-
-
-EXPORTS =                   \
-        $(NULL)
-
-XPIDLSRCS =                             \
-        .\nsICachedNetData.idl          \
-        .\nsINetDataCacheManager.idl    \
-        .\nsINetDataCache.idl           \
-        .\nsINetDataCacheRecord.idl     \
-        .\nsINetDataDiskCache.idl       \
-        .\nsIStreamAsFile.idl           \
-        $(NULL)
-
-include <$(DEPTH)/config/rules.mak>
-

mozilla/netwerk/cache/public/nsICachedNetData.idl

@@ -1,229 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *
- * 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.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- */
-
-#include "nsrootidl.idl"
-#include "nsISupports.idl"
-
-interface nsIFileSpec;
-interface nsIURI;
-interface nsIObserver;
-interface nsIChannel;
-interface nsINetDataCache;
-interface nsINetDataCacheRecord;
-interface nsILoadGroup;
-interface nsIStreamListener;
-
-/**
- * The nsICachedNetData interface represents a single entry in a database that
- * caches data retrieved from the network. This interface is implemented by the
- * cache manager on top of the low-level nsINetDataCacheRecord and
- * nsINetDataCache interfaces that are implemented by the database.
- *
- * Each cache record may contain both content and metadata.  The content may
- * be, for example, GIF image data or HTML, and it is accessed through
- * nsIChannel's streaming API.  The opaque metadata, which may contain HTTP
- * headers among other things, is stored as a byte array.  Each entry in the
- * cache is indexed by two different keys: a record id number and a key created
- * by combining the URI with a "secondary key", e.g. HTTP post data.
- *
- * @See nsINetDataCacheRecord
- * @See nsINetDataCache
- * @See nsINetDataDiskCache
- * @See nsINetDataCacheManager
- */
-[scriptable, uuid(6aeb2a40-6d43-11d3-90c8-000064657374)]
-interface nsICachedNetData : nsISupports
-{
-    /**
-     * String form of the URI provided as an argument to the call to
-     * nsINetDataCacheManager::GetCachedNetData() that created this record.
-     */
-    readonly attribute string uriSpec;
-    
-    /**
-     * Getter for the opaque secondary database key provided as an argument to
-     * the call to nsINetDataCacheManager::GetCachedNetData() that created this
-     * record.
-     */
-    void getSecondaryKey(out unsigned long length,
-                         [retval, size_is(length)] out string secondaryKey);
-
-    /**
-     * This flag may be set by a protocol handler to indicate that it supports
-     * partial fetching of data.  In that case, the cache manager is permitted
-     * to truncate the entry's content to accommodate incoming data for other
-     * cache entries rather than deleting it wholesale.
-     */
-    attribute boolean allowPartial;
-    
-    /**
-     * This flag indicates that the write stream supplying content data for the
-     * cache did not complete normally and, therefore, the content may be
-     * truncated.
-     */
-    readonly attribute boolean partialFlag;
-
-    /**
-     * This flag can be set and cleared by a protocol handler as a form of
-     * self-notification, so as to avoid race conditions in which a protocol
-     * handler issues two identical network requests to fill the same cache
-     * entry.  The cache manager itself largely ignores this flag.
-     */
-    attribute boolean updateInProgress;
-
-    /**
-     * inUse is set if any existing channels are associated with this cache
-     * entry or if the updateInProgess flag is set.  This can be used to
-     * prevent writing to a cache entry by a protocol handler if it's being
-     * read or written elsewhere.
-     */
-    readonly attribute boolean inUse;
-
-    /**
-     * Date/time that the document was last stored on the origin server, as
-     * supplied by the protocol handler.  This value is used as input to the
-     * cache replacement policy, i.e. it is not used for validation.  If the
-     * protocol can't supply a last-modified time, this attribute should remain
-     * unset.  When unset, the value of this attribute is zero.
-     *
-     * FIXME: Should use nsIDateTime interface, once it's created
-     * instead of PRTime, for improved scriptability ? 
-     */
-    attribute PRTime lastModifiedTime;
-
-    /**
-     * Supplied by the protocol handler, the expirationTime attribute specifies
-     * the time until which the document is guaranteed fresh, i.e. the document
-     * does not have to be validated with the server and, therefore, any data
-     * in cache is definitely usable.  The value of this attribute serves as a
-     * hint to the cache replacement policy.  Only one of either staleTime or
-     * expirationTime may be set for a single cache record.  When unset, the
-     * value of this attribute is zero. 
-     */
-    attribute PRTime expirationTime;
-
-    /**
-     * Date/time supplied by the protocol handler, at which point the content
-     * is *likely* to be stale, i.e. the data in the cache may be out-of-date
-     * with respect to the data on the server.  This heuristic date does not
-     * necessarily correspond to the HTTP Expires header, as it does not
-     * determine when cached network data must be validated with the origin
-     * server, but only serves as a hint to the cache replacement policy.  Only
-     * one of either staleTime or expirationTime may be set for a single cache
-     * record.  When unset, the value of this attribute is zero.
-     */
-    attribute PRTime staleTime;
-
-    /**
-     * Date/time of last access of the data in this cache record, as determined
-     * by the cache manager.
-     */
-    readonly attribute PRTime lastAccessTime;
-
-    /**
-     * Number of times this record has been accessed since it was first stored.
-     */
-    readonly attribute PRUint16 numberAccesses;
-
-    /**
-     * Accessor methods for opaque meta-data which can be read and updated
-     * independently of the content data.
-     *
-     * The aTag argument can be used to accommodate multiple clients of the
-     * cache API, each of which wants to store its own private meta-data into
-     * the cache.  For example, there could be a "headers" tag that the HTTP
-     * protocol handler uses to store http response headers and a "image size"
-     * tag used to store the image dimensions of a GIF file.  The aData
-     * argument refers to an opaque blob of arbitrary bytes.
-     *
-     * IMPORTANT: If aData does not contain byte-oriented data, i.e. it's not a
-     *            string, the contents of aData must be byte-swapped by the,
-     *            caller, so as to make the cache files endian-independent.
-     */
-    void getAnnotation(in string aTag, 
-                       out PRUint32 aLength, [size_is(aLength), retval] out string aData);
-    void setAnnotation(in string aTag,
-                       in  PRUint32 aLength, [size_is(aLength)] in string aData);
-
-    /**
-     * As a getter, return the number of content bytes stored in the cache,
-     * i.e. via the nsIChannel streaming APIs.  This may be less than the
-     * complete content length if a partial cache fill occurred.  The cached
-     * content can be truncated by setting the value of this attribute.  The
-     * value of the attribute represents a logical, not a physical, length.  If
-     * compression has been used, the content may consume less storage than
-     * indicated by this attribute.
-     *
-     * When this attribute is set to zero the associated cache disk file, if
-     * any, should be deleted.
-     */
-    attribute PRUint32 storedContentLength;
-
-    /** 
-     * Notify any observers associated with this cache entry of the deletion
-     * request.  If all observers drop their reference to the cache entry,
-     * proceed to delete the underlying cache database record and associated
-     * content storage.
-     */
-    void delete();
-
-    /**
-     * Flush any changes in this entry's data to the cache database.  This
-     * method will automatically be called when the last reference to the cache
-     * is dropped, but it can also be called explicitly for a synchronous
-     * effect.
-     */
-    void commit();
-
-    /**
-     * Parent container cache for this entry.
-     */
-    readonly attribute nsINetDataCache cache;
-
-    /**
-     * Create a channel for reading or writing a stream of content into the
-     * entry.  It is expected that many of the nsIChannel methods return
-     * NS_NOT_IMPLEMENTED, including:
-     *
-     *    + GetURI()
-     *    + GetContentType()
-     *    + GetContentLength()
-     *
-     * Though nsIChannel provides for both async and synchronous I/O APIs, both
-     * may not be implemented.  Only AsyncRead() and OpenOutputStream() is
-     * required.  The aProxyChannel argument allows another channel to be
-     * specified as the proffered argument to nsIStreamListener methods rather
-     * than the cache's own channel.
-     */
-    nsIChannel newChannel(in nsILoadGroup aLoadGroup,
-                          in nsIChannel aProxyChannel);
-
-    /**
-     * This method can be used by a caching protocol handler to store data in
-     * the cache by forking an asynchronous read stream so that it is
-     * simultaneously sent to a requester and written into the cache.  This
-     * method implicitly sets the updateInProgress flag, if it has not already
-     * been set.
-     */
-    nsIStreamListener interceptAsyncRead(in nsIStreamListener aOriginalListener,
-                                         in PRUint32 aStartOffset);
-};

mozilla/netwerk/cache/public/nsINetDataCache.idl

@@ -1,143 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *
- * 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.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- */
-
-#include "nsISupports.idl"
-
-interface nsIURI;
-interface nsINetDataCacheRecord;
-interface nsISimpleEnumerator;
-interface nsIFileSpec;
-
-/**
- * The nsINetDataCache defines the low-level API for a network-data
- * cache, used to cache the responses to network retrieval commands.
- * This interface, along with nsINetDataCacheRecord, is implemented by
- * the memory cache, the file cache and, optionally, by some extension
- * caches.  This interface is essentially a pseudo-private API for the
- * cache manager.  Other clients should never use this interface.
- *
- * Each cache entry may contain both content, e.g. GIF image data, and
- * associated metadata, e.g. HTTP headers.  Each entry is indexed by two
- * different keys: a record id number and a key created by combining the URI
- * with a "secondary key", e.g. HTTP post data.
- *
- * The nsINetDataCache interface is agnostic as to where the data is
- * stored and whether the storage is volatile or persistent.  The
- * memory cache, any disk caches and any extension caches must all
- * implement this interface.
- *
- */
-[scriptable, uuid(ccfc58c0-6dde-11d3-90c8-000064657374)]
-interface nsINetDataCache : nsISupports
-{
-	/**
-	 * Human-readable description of the cache module, e.g. "Disk Cache"
-	 */
-	readonly attribute wstring description;
-  
-    /**
-     * Returns true if cached data is available for the given opaque key,
-     * even if only partial data is stored.
-     */
-    boolean contains([size_is(length)] in string key, in PRUint32 length);
-
-    /**
-     * Fetch the cache entry record for the given opaque key.  If one does not
-     * exist, create a new, empty record.
-     */
-    nsINetDataCacheRecord getCachedNetData([size_is(length)] in string key,
-                                           in PRUint32 length);
-
-    /**
-     * Fetch the cache entry record for the given URI using the record ID as a key.
-     */
-    nsINetDataCacheRecord getCachedNetDataByID(in PRInt32 RecordID);
-
-	/**
-	 * False indicates that this cache is entirely bypassed.
-	 */
-    attribute boolean enabled;
-
-    /**
-     * Constants for flags attribute, below
-     */
-
-    // Used for extension caches, e.g. a CD-ROM cache
-    const long READ_ONLY          = 1 << 0;
-
-    // One of these bits must be set
-    const long MEMORY_CACHE       = 1 << 1;
-    const long FLAT_FILE_CACHE    = 1 << 2;
-    const long FILE_PER_URL_CACHE = 1 << 3;
-
-	/**
-	 * See constants defined above.
-	 */
-	readonly attribute PRUint32 flags;
-
-    /**
-     * Total number of URI entries stored in the cache.
-     */
-    readonly attribute PRUint32 numEntries;
-
-    /**
-     * Maximum number of URI entries that may be stored in the cache.
-     */
-    readonly attribute PRUint32 maxEntries;
-
-    /**
-     * Enumerate the URI entries stored in the cache.
-     */
-    nsISimpleEnumerator newCacheEntryIterator();
-
-	/**
-	 * Contains a reference to the next cache in search order.  For the memory
-	 * cache, this attribute always references the disk cache.  For the disk
-	 * cache, it contains a reference to the first extension cache.
-	 */
-    attribute nsINetDataCache nextCache;
-
-    /**
-     * An estimate of the amount of storage occupied by the cache, in kB.
-     * Actual use may be slightly higher than reported due to cache overhead
-     * and heap fragmentation (in the memory cache) or block quantization (in
-     * the disk cache).
-	 */
-    readonly attribute PRUint32 storageInUse;
-
-    /**
-     * Remove all entries from a writable cache.  This could be used, for
-     * example, after a guest ends a browser session.  This is equivalent to
-     * setting the cache's Capacity to zero, except that all cache entries,
-     * even those in active use, will be deleted.  Also, any global cache
-     * database files will be deleted.
-	 */
-    void removeAll();
-};
-
-%{ C++
-// ProgID prefix for Components that implement this interface
-#define NS_NETWORK_CACHE_PROGID "component://netscape/network/cache"
-#define NS_NETWORK_MEMORY_CACHE_PROGID NS_NETWORK_CACHE_PROGID "?name=memory-cache"
-#define NS_NETWORK_FLAT_CACHE_PROGID   NS_NETWORK_CACHE_PROGID "?name=flat-cache"
-#define NS_NETWORK_FILE_CACHE_PROGID   NS_NETWORK_CACHE_PROGID "?name=file-cache"
-%}

mozilla/netwerk/cache/public/nsINetDataCacheManager.idl

@@ -1,163 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *
- * 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.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- */
-
-#include "nsISupports.idl"
-
-interface nsISimpleEnumerator;
-interface nsICachedNetData;
-interface nsINetDataCache;
-interface nsINetDataDiskCache;
-interface nsIURI;
-interface nsIFileSpec;
-
-/**
- * The network-response cache manager is partly responsible for the caching of
- * content and associated metadata that has been retrieved via the network.
- * (The remaining responsibility for caching lies with individual network
- * protocol handlers.)
- *
- * The cache manager supervises the actions of individual cache components,
- * such as the memory cache, the disk cache and any extension caches, e.g. a
- * read-only CD-ROM cache.
- *
- * @See nsINetDataCache
- * @See nsICachedNetData
- */
-[scriptable, uuid(71c8ab00-6d5c-11d3-90c8-000064657374)]
-interface nsINetDataCacheManager : nsISupports
-{
-    /**
-     * Flag for the GetCachedNetData() method: If set, the memory cache is
-     * neither searched nor will any data be stored into it.  This might be
-     * appropriate, for example, with images, because they have their own
-     * cache for storing *decoded* images.
-     */
-    const unsigned long BYPASS_MEMORY_CACHE       = 1 << 0;
-
-    /**
-     * Flag for the GetCachedNetData() method: If set, the disk cache
-     * is neither searched nor will any be data stored into it.
-     * However, read-only extension caches may be searched.  This
-     * might be used to avoid leaving persistent records of secure
-     * data.
-     */
-    const unsigned long BYPASS_PERSISTENT_CACHE   = 1 << 1;
-
-    /**
-     * Flag for the GetCachedNetData() method: If set, any stream
-     * content is stored in the cache as a single disk file.  Content
-     * will not be cached in the memory cache nor is it cached in a
-     * flat-file cache database.  This is used to implement the jar
-     * protocol handler and to provide the stream-as-file semantics
-     * required by the classic bowser plugin API.
-     */
-    const unsigned long CACHE_AS_FILE             = 1 << 2;
-
-    /**
-     * Fetch the cache entry record for the given URI.  If one does not exist,
-     * create a new, empty record.  The normal search order for caches is:
-     *   + Memory cache
-     *   + Disk cache
-     *   + File cache (stream-as-file cache)
-     *   + All extension caches
-     *
-     * When writing, data is typically stored in both the memory cache and the
-     * disk cache.  Both the search order and this write policy can be modified by
-     * setting one or more of the flag argument bits, as defined above.
-     *
-     * The optionally-NULL secondaryKey argument can be used, e.g. for form
-     * post data or for HTTP headers in the case of HTTP.
-     */
-    nsICachedNetData getCachedNetData(in string uri,
-                                      [size_is(secondaryKeyLength)] in string secondaryKey,
-                                      in PRUint32 secondaryKeyLength,
-                                      in PRUint32 flags);
-
-    /**
-     * Returns true if cached content is available for the given URI, even if
-     * only partial data is stored.  The flags argument behaves the same as for
-     * the GetCachedNetData() method, above.
-     */
-    boolean contains(in string uri,
-                     [size_is(secondaryKeyLength)] in string secondaryKey,
-                     in PRUint32 secondaryKeyLength,
-                     in PRUint32 flags);
-
-    /**
-     * Total number of unexpired URI entries stored in all caches.  This number
-     * does not take into account duplicate URIs, e.g. because the memory cache
-     * and the disk cache might each contain an entry for the same URI.
-     */
-    readonly attribute PRUint32 numEntries;
-
-    /**
-     * Enumerate the unexpired URI entries stored in all caches.  Some URIs may
-     * be enumerated more than once, e.g.  because the the memory cache and the
-     * disk cache might each contain an entry for the same URI.
-     */
-    nsISimpleEnumerator newCacheEntryIterator();
-
-    /*
-     * Enumerate all the loaded nsINetDataCache-implementing cache modules.
-     * The first module enumerated will be the memory cache, the second will be
-     * the disk cache, then the file cache, followed by all the extension
-     * caches, in search order. 
-     */
-    nsISimpleEnumerator newCacheModuleIterator();
-
-    /**
-     * Remove all entries from all writable caches.  This could be used, for
-     * example, after a guest ends a browser session.  This is equivalent to
-     * setting the DiskCacheCapacity to zero, except that all cache entries,
-     * even those in active use, will be deleted.  Also, any global cache
-     * database files will be deleted.
-     */
-    void RemoveAll();
-
-    /**
-     * The disk cache is made up of the file cache (for stream-as-file
-     * requests) and a (possibly independent) persistent cache that handles all
-     * other cache requests.  This attribute sets/gets the combined capacity of
-     * these caches, measured in KBytes.  Setting the capacity lower than the
-     * current amount of space currently in use may cause cache entries to be
-     * evicted from the cache to accomodate the requested capacity.
-     */
-    attribute PRUint32 diskCacheCapacity;
-
-    /**
-     * This attribute sets/gets the capacity of the memory cache, measured in
-     * KBytes.  Setting the capacity lower than the current amount of space
-     * currently in use may cause cache entries to be evicted from the cache to
-     * accomodate the requested capacity.
-     */
-    attribute PRUint32 memCacheCapacity;
-
-	/**
-	 * This attribute must be set before attempting to store into the disk cache.
-	 */
-    attribute nsIFileSpec diskCacheFolder;
-};
-
-%{ C++
-// ProgID prefix for Components that implement this interface
-#define NS_NETWORK_CACHE_MANAGER_PROGID NS_NETWORK_CACHE_PROGID "?name=manager"
-%}

mozilla/netwerk/cache/public/nsINetDataCacheRecord.idl

@@ -1,125 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *
- * 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.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- */
-
-#include "nsISupports.idl"
-#include "nsrootidl.idl"
-
-interface nsIFileSpec;
-interface nsIChannel;
-interface nsINetDataCache;
-
-/**
- * The nsINetDataCacheRecord represents a single entry in a database that
- * caches data retrieved from the network. On top of this low-level interface
- * to the raw record data, the cache manager implements a higher-level record
- * interface, nsICachedNetData.  Each instance of nsINetDataCacheRecord is
- * (internally) associated with a parent database, an instance of the
- * nsINetDataCache interface.  This interface is essentially a pseudo-private
- * API for the cache manager.  Other clients should never use this interface.
- *
- * Each cache record may contain both content and metadata.  The content may
- * be, for example, GIF image data or HTML, and it is accessed through
- * nsIChannel's streaming API.  The opaque metadata, which may contain HTTP
- * headers among other things, is accessed as a contiguous byte array.  Each
- * entry in the cache is indexed by two different keys: a unique record id
- * number, generated by the cache, and an opaque string.  The latter contains
- * the URI and other secondary key information, e.g. HTTP form post key/value
- * pairs.
- *
- * The nsINetDataCacheRecord interface is agnostic as to where the data is
- * stored and whether the storage is volatile or persistent.  The memory cache,
- * the disk cache, a flat-file cache and any read-only extension caches must
- * all implement this interface.
- *
- * @See nsICachedNetData
- * @See nsINetDataCache
- * @See nsINetDataDiskCache
- * @See nsINetDataCacheManager
- */
-
-interface nsILoadGroup;
-
-[scriptable, uuid(fdcdd6a0-7461-11d3-90ca-0040056a906e)]
-interface nsINetDataCacheRecord : nsISupports
-{
-    /**
-     * As far as the nsINetDataCacheRecord implementation is concerned, the
-     * cache entry database key is an opaque blob, but it's intended to contain
-     * both the URI and any secondary keys, such as HTTP post data.
-     */
-    void getKey(out unsigned long length, [size_is(length), retval] out string key);
-
-    /**
-     * A persistent record number assigned by the cache which must be unique
-     * among all entries stored within the same cache.  The record ID serves as
-     * an alternate key to the cache record.  Providing that they satisfy the
-     * afforementioned uniqueness requirement, record IDs can be assigned any
-     * value by the database except that they may never be zero.
-     */
-    readonly attribute PRInt32 recordID;
-
-    /**
-     * Opaque data which can be updated for each cache entry independently of
-     * the content data.  This data is a combination of protocol-independent
-     * data provided by the cache manager and protocol-specific meta-data,
-     * e.g. HTTP headers.
-     */
-    void getMetaData(out PRUint32 length, [size_is(length), retval] out string metaData);
-    void setMetaData(in  PRUint32 length, [size_is(length)] in string data);
-
-    /**
-     * Number of content bytes stored in the cache, i.e. via the nsIChannel
-     * streaming APIs.  This may be less than the complete content length if a
-     * partial cache fill occurred.  Additionally, the cached content can be
-     * truncated by reducing the value of this attribute.  When this attribute
-     * is set to zero the associated cache disk file, if any, should be
-     * deleted.
-     */
-    attribute PRUint32 storedContentLength;
-
-    /** 
-     * Delete this cache entry and its associated content.
-     */
-    void delete();
-
-    /**
-     * Create a channel for reading or writing a stream of content into the
-     * entry.  However, many of the nsIChannel methods may return
-     * NS_NOT_IMPLEMENTED, including:
-     *
-     *    + GetURI()
-     *    + GetContentType()
-     *    + GetContentLength()
-     */
-    nsIChannel newChannel(in nsILoadGroup loadGroup);
-
-    /**
-     * If a cache is implemented such that it stores each URI's content in an
-     * individual disk file, this method will identify the file corresponding
-     * to this record.  This may be used to implement the "stream-as-file"
-     * semantics required by some plugins and by the 'jar:' protocol handler.
-     * However, not all cache implementations are *required* to store the data
-     * from each URI in an individual file, so it is acceptable for an
-     * implementation of this method to signal NS_NOT_IMPLEMENTED.
-     */
-    readonly attribute nsIFileSpec filename;
-};

mozilla/netwerk/cache/public/nsINetDataDiskCache.idl

@@ -1,42 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *
- * 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.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- */
-
-#include "nsINetDataCache.idl"
-
-interface nsIFileSpec;
-
-/**
-/**
- * A network-data disk cache is used to persistently cache the responses to
- * network retrieval commands.  Each cache entry may contain both content,
- * e.g. GIF image data, and associated metadata, e.g. HTTP headers.
- */
-[scriptable, uuid(6408e390-6f13-11d3-90c8-000064657374)]
-interface nsINetDataDiskCache : nsINetDataCache
-{
-	/**
-	 * This attribute must be set before calling any other methods of this
-	 * interface.
-	 */
-    attribute nsIFileSpec diskCacheFolder;
-};
-

mozilla/netwerk/cache/public/nsIStreamAsFile.idl

@@ -1,106 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *  
- * 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.
- *  
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- * 
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation. Portions created by Netscape are
- * Copyright (C) 1999 Netscape Communications Corporation. All
- * Rights Reserved.
- * 
- * Contributor(s): 
- *   Scott Furman, fur@netscape.com
- */
-#include "nsrootidl.idl"
-#include "nsISupports.idl"
-
-interface nsIFileSpec;
-interface nsIStreamAsFileObserver;
-
-/**
- * In addition to enhancing effective network response time via caching, the
- * cache manager serves a second purpose by providing the stream-as-file
- * service required by traditional browser plugins and the jar: protocol
- * handler.  The interface below provides a means for a client to determine the
- * filename associated with a stream and to detect modification/deletion of
- * that file.
- */
-[scriptable, uuid(0eedbbf0-92d9-11d3-90d3-0040056a906e)]
-interface nsIStreamAsFile : nsISupports
-{
-    /**
-     * Filename containing stream-as-file
-     */
-    readonly attribute nsIFileSpec fileSpec;
-
-    /**
-     * Add an observer for this cache record.  When the cache wants to delete
-     * or truncate a record, so as to make space for another cache entry's
-     * content data, it will call <code>aObserver</code>'s Observe() method,
-     * passing the nsIStreamAsFile instance as the <code>aSubject</code>
-     * argument and an appropriate message.  If the observer does not wish to
-     * inhibit deletion/truncation, it should Release() any references it has to the
-     * cache record.
-     *
-     * @See nsIStreamAsFileObserver
-     */
-    void addObserver(in nsIStreamAsFileObserver aObserver);
-
-    /**
-     * Delete an observer that was added by the AddObserver() method.
-     */
-    void removeObserver(in nsIStreamAsFileObserver aObserver);
-};
-
-/**
- * This interface can be implemented by a client to receive notifications of
- * either modification or deletion of a file created by the cache manager using
- * the stream-as-file semantics.
- */
-[scriptable, uuid(a26e27c0-92da-11d3-90d3-0040056a906e)]
-interface nsIStreamAsFileObserver : nsISupports
-{
-    /**
-     * Flag bits for argument to Observe() method.
-     */
-    const long NOTIFY_AVAILABLE    = 1 << 0; // Stream-as-file now available for reading
-    const long NOTIFY_ERROR        = 1 << 1; // Error while loading stream / creating file
-    const long REQUEST_DELETION    = 1 << 2; // Cache manager wishes to delete/truncate file
-    const long INVALIDATE          = 1 << 3; // File is out-of-date
-
-    // Convenience value
-    const long MAKE_UNAVAILABLE    = REQUEST_DELETION | INVALIDATE;
-    
-    /**
-     * Receive either a notification or a request concerning a file that has
-     * been opened using stream-as-file.  The aMessage and aError arguments
-     * have varying values depending on the nature of the notification.
-     * aMessage is set to NOTIFY_AVAILABLE when a complete stream has been read
-     * and stored on disk in a file.  At that point, and no sooner, may the
-     * filename attribute of the associated nsIStreamAsFile be accessed via the
-     * associated nsIStreamAsFile interface.  If the aMessage argument is
-     * NOTIFY_ERROR, the aError argument contains the relevant error code.  If
-     * the aMessage argument is either REQUEST_DELETION or REQUEST_TRUNCATION,
-     * the callee should immediately Release() all references to the
-     * nsIStreamAsFile (and any references to its associated nsICachedNetData
-     * instances), unless it wishes to inhibit the requested file modification.
-     * If the aMessage argument is INVALIDATE, the cache manager is replacing
-     * the file with a more recent version.  If a client wants to continue
-     * using the (now out-of-date) file, it must delete it when it has finished,
-     * as the cache manager will effectively relinquished ownership of the
-     * file.
-     */
-    void ObserveStreamAsFile(in nsIStreamAsFile aStreamAsFile,
-			     in PRUint32 aMessage,
-			     in nsresult aError);
-};

mozilla/netwerk/makefile.win

@@ -1,39 +0,0 @@
-#!gmake
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-DEPTH = ..
-
-MODULE = necko
-
-DIRS=            \
-	base     \
-	dns      \
-	build    \
-	protocol \
-	socket   \
-	util     \
-	mime     \
-	streamconv \
-	cache    \
-	test     \
-	$(NULL)
-
-include <$(DEPTH)\config\rules.mak>

mozilla/netwerk/protocol/http/public/nsIHTTPHeader.idl

@@ -1,32 +0,0 @@
-/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *
- * 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.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- */
-
-#include "nsISupports.idl"
-
-interface nsIAtom;
-                  
-[scriptable, uuid(a3ec67f0-465a-11d3-9a89-0080c7cb1080)]
-interface nsIHTTPHeader : nsISupports
-{
-    nsIAtom GetField();
-    string GetValue();
-};

mozilla/netwerk/test/TestCacheMgr.cpp

@@ -1,603 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape Public License
- * Version 1.0 (the "NPL"); you may not use this file except in
- * compliance with the NPL.  You may obtain a copy of the NPL at
- * http://www.mozilla.org/NPL/
- *
- * Software distributed under the NPL is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
- * for the specific language governing rights and limitations under the
- * NPL.
- *
- * The Initial Developer of this code under the NPL is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
- * Reserved.
- */
-
-#include "nsIStreamListener.h"
-#include "nsIStreamObserver.h"
-#include "nsIServiceManager.h"
-#include "nsIInputStream.h"
-#include "nsIOutputStream.h"
-#include "nsIEventQueue.h"
-#include "nsIEventQueueService.h"
-#include "nsIChannel.h"
-#include "nsCOMPtr.h"
-
-#include "nsINetDataCache.h"
-#include "nsINetDataCacheManager.h"
-#include "nsICachedNetData.h"
-
-
-// Number of test entries to be placed in the cache
-// FIXME - temporary
-#define NUM_CACHE_ENTRIES  25
-
-// Cache content stream length will have random length between zero and
-// MAX_CONTENT_LENGTH bytes
-#define MAX_CONTENT_LENGTH 20000
-
-// Limits, converted to KB
-#define DISK_CACHE_CAPACITY  ((MAX_CONTENT_LENGTH * 4) >> 10)
-#define MEM_CACHE_CAPACITY   ((MAX_CONTENT_LENGTH * 3) >> 10)
-
-// Length of random-data cache entry URI key
-#define CACHE_KEY_LENGTH 13
-
-// Length of random-data cache entry secondary key
-#define CACHE_SECONDARY_KEY_LENGTH 10
-
-// Length of random-data cache entry meta-data
-#define CACHE_PROTOCOL_PRIVATE_LENGTH 10
-
-// Mapping from test case number to RecordID
-static PRInt32 recordID[NUM_CACHE_ENTRIES];
-
-static PRInt32
-mapRecordIdToTestNum(PRInt32 aRecordID)
-{
-    int i;
-    for (i = 0; i < NUM_CACHE_ENTRIES; i++) {
-        if (recordID[i] == aRecordID)
-            return i;
-    }
-    return -1;
-}
-
-// A supply of stream data to either store or compare with
-class nsITestDataStream {
-public:
-    virtual ~nsITestDataStream() {};
-    virtual PRUint32 Next() = 0;
-    virtual void Read(char* aBuf, PRUint32 aCount) = 0;
-    virtual void ReadString(char* aBuf, PRUint32 aCount) = 0;
-
-    virtual PRBool Match(char* aBuf, PRUint32 aCount) = 0;
-    virtual PRBool MatchString(char* aBuf, PRUint32 aCount) = 0;
-    virtual void Skip(PRUint32 aCount) = 0;
-    virtual void SkipString(PRUint32 aCount) = 0;
-};
-
-// A reproducible stream of random data.
-class RandomStream : public nsITestDataStream {
-public:
-    RandomStream(PRUint32 aSeed) {
-        mStartSeed = mState = aSeed;
-    }
-    
-    PRUint32 GetStartSeed() {
-        return mStartSeed;
-    }
-    
-    PRUint32 Next() {
-        mState = 1103515245 * mState + 12345 ^ (mState >> 16);
-        return mState;
-    }
-
-    PRUint8 NextChar() {
-        PRUint8 c;
-        do {
-            c = Next();
-        } while (!isalnum(c));
-        return c;
-    }
-
-    void Read(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            *aBuf++ = Next();
-        }
-    }
-
-    // Same as Read(), but using only printable chars and
-    //   with a terminating NUL
-    void ReadString(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            *aBuf++ = NextChar();
-        }
-        *aBuf = 0;
-    }
-
-    PRBool
-    Match(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            if (*aBuf++ != (char)(Next() & 0xff))
-                return PR_FALSE;
-        }
-        return PR_TRUE;
-    }
-
-    PRBool
-    MatchString(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            if (*aBuf++ != (char)(NextChar() & 0xff))
-                return PR_FALSE;
-        }
-        
-        // Check for terminating NUL character
-        if (*aBuf)
-            return PR_FALSE;
-        return PR_TRUE;
-    }
-
-    void
-    Skip(PRUint32 aCount) {
-        while (aCount--)
-            Next();
-    }
-
-    void
-    SkipString(PRUint32 aCount) {
-        while (aCount--)
-            NextChar();
-    }
-
-protected:
-    
-    PRUint32 mState;
-    PRUint32 mStartSeed;
-};
-
-static int gNumReaders = 0;
-static PRUint32 gTotalBytesRead = 0;
-static PRUint32 gTotalBytesWritten = 0;
-static PRUint32 gTotalDuration = 0;
-
-class nsReader : public nsIStreamListener {
-public:
-    NS_DECL_ISUPPORTS
-
-    nsReader()
-        : mStartTime(0), mBytesRead(0)
-    {
-        NS_INIT_REFCNT();
-        gNumReaders++;
-    }
-
-    virtual ~nsReader() {
-        delete mTestDataStream;
-        gNumReaders--;
-    }
-
-    nsresult 
-    Init(nsITestDataStream* aRandomStream, PRUint32 aExpectedStreamLength) {
-        mTestDataStream = aRandomStream;
-        mExpectedStreamLength = aExpectedStreamLength;
-        mRefCnt = 1;
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnStartRequest(nsIChannel* channel,
-                              nsISupports* context) {
-        mStartTime = PR_IntervalNow();
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnDataAvailable(nsIChannel* channel, 
-                               nsISupports* context,
-                               nsIInputStream *aIStream, 
-                               PRUint32 aSourceOffset,
-                               PRUint32 aLength) {
-        char buf[1025];
-        while (aLength > 0) {
-            PRUint32 amt;
-            PRBool match;
-            aIStream->Read(buf, sizeof buf, &amt);
-            if (amt == 0) break;
-            aLength -= amt;
-            mBytesRead += amt;
-            match = mTestDataStream->Match(buf, amt);
-            NS_ASSERTION(match, "Stored data was corrupted on read");
-        }
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnStopRequest(nsIChannel* channel, 
-                             nsISupports* context,
-                             nsresult aStatus,
-                             const PRUnichar* aMsg) {
-        PRIntervalTime endTime;
-        PRIntervalTime duration;
-        
-        endTime = PR_IntervalNow();
-        duration = (endTime - mStartTime);
-
-        if (NS_FAILED(aStatus)) printf("channel failed.\n");
-        //        printf("read %d bytes\n", mBytesRead);
-
-        //FIXME        NS_ASSERTION(mBytesRead == mExpectedStreamLength,
-        // "Stream in cache is wrong length");
-
-        gTotalBytesRead += mBytesRead;
-        gTotalDuration += duration;
-
-        return NS_OK;
-    }
-
-protected:
-    PRIntervalTime       mStartTime;
-    PRUint32             mBytesRead;
-    nsITestDataStream*   mTestDataStream;
-    PRUint32             mExpectedStreamLength;
-};
-
-NS_IMPL_ISUPPORTS2(nsReader, nsIStreamListener, nsIStreamObserver)
-
-static nsIEventQueue* eventQueue;
-
-static NS_DEFINE_CID(kEventQueueServiceCID, NS_EVENTQUEUESERVICE_CID);
-
-nsresult
-InitQueue() {
-    nsresult rv;
-
-    NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueServiceCID, &rv);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue service");
-
-    rv = eventQService->CreateThreadEventQueue();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create event queue");
-  
-    rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQueue);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue for main thread");
-
-    return NS_OK;
-}
-
-// Process events until all streams are OnStopRequest'ed
-nsresult
-WaitForEvents() {
-    while (gNumReaders) {
-        eventQueue->ProcessPendingEvents();
-    }
-    return NS_OK;
-}
-
-// Read data for a single cache record and compare against testDataStream
-nsresult
-TestReadStream(nsICachedNetData *cacheEntry, nsITestDataStream *testDataStream,
-               PRUint32 expectedStreamLength)
-{
-    nsCOMPtr<nsIChannel> channel;
-    nsresult rv;
-    PRUint32 actualContentLength;
-
-    rv = cacheEntry->NewChannel(0, 0, getter_AddRefs(channel));
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-    rv = cacheEntry->GetStoredContentLength(&actualContentLength);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    // FIXME    NS_ASSERTION(actualContentLength == expectedStreamLength,
-    //                 "nsICachedNetData::GetContentLength() busted ?");
-    
-    nsReader *reader = new nsReader;
-    reader->AddRef();
-    rv = reader->Init(testDataStream, expectedStreamLength);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    
-    rv = channel->AsyncRead(0, -1, 0, reader);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    reader->Release();
-
-    return NS_OK;
-}
-
-// Convert PRTime to unix-style time_t, i.e. seconds since the epoch
-static PRUint32
-convertPRTimeToSeconds(PRTime aTime64)
-{
-    double fpTime;
-    LL_L2D(fpTime, aTime64);
-    return (PRUint32)(fpTime * 1e-6 + 0.5);
-}
-
-// Convert unix-style time_t, i.e. seconds since the epoch, to PRTime
-static PRTime
-convertSecondsToPRTime(PRUint32 aSeconds)
-{
-    PRInt64 t64;
-    LL_L2I(t64, aSeconds);
-    LL_MUL(t64, t64, 1000000);
-    return t64;
-}
-
-// Read the test data that was written in FillCache(), checking for
-// corruption, truncation.
-nsresult
-TestRead(nsINetDataCacheManager *aCache, PRUint32 aFlags)
-{
-    nsresult rv;
-    PRBool inCache;
-    nsCOMPtr<nsICachedNetData> cacheEntry;
-    RandomStream *randomStream;
-    char uriCacheKey[CACHE_KEY_LENGTH];
-    char secondaryCacheKey[CACHE_SECONDARY_KEY_LENGTH];
-    char *storedUriKey;
-    PRUint32 testNum;
-
-    gTotalBytesRead = 0;
-    gTotalDuration = 0;
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->ReadString(uriCacheKey, sizeof uriCacheKey - 1);
-        randomStream->Read(secondaryCacheKey, sizeof secondaryCacheKey);
-
-        // Ensure that entry is in the cache
-        rv = aCache->Contains(uriCacheKey,
-                              secondaryCacheKey, sizeof secondaryCacheKey,
-                              aFlags, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(inCache, "nsINetDataCacheManager::Contains error");
-        
-        rv = aCache->GetCachedNetData(uriCacheKey,
-                                      secondaryCacheKey, sizeof secondaryCacheKey,
-                                      aFlags,
-                                      getter_AddRefs(cacheEntry));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        // Test GetUriSpec() method
-        rv = cacheEntry->GetUriSpec(&storedUriKey);
-        NS_ASSERTION(NS_SUCCEEDED(rv) &&
-                     !memcmp(storedUriKey, &uriCacheKey[0], sizeof uriCacheKey),
-                     "nsICachedNetData::GetKey failed");
-        nsAllocator::Free(storedUriKey);
-
-        // Test GetSecondaryKey() method
-        PRUint32 storedSecondaryKeyLength;
-        char* storedSecondaryKey;
-        rv = cacheEntry->GetSecondaryKey(&storedSecondaryKeyLength, &storedSecondaryKey);
-        NS_ASSERTION(NS_SUCCEEDED(rv) &&
-                     !memcmp(storedSecondaryKey, &secondaryCacheKey[0],
-                             sizeof secondaryCacheKey),
-                     "nsICachedNetData::GetSecondaryKey failed");
-
-        // Compare against stored protocol data
-        char *storedProtocolData;
-        PRUint32 storedProtocolDataLength;
-        rv = cacheEntry->GetAnnotation("test data", &storedProtocolDataLength, &storedProtocolData);
-        NS_ASSERTION(NS_SUCCEEDED(rv) &&
-                     storedProtocolDataLength == CACHE_PROTOCOL_PRIVATE_LENGTH,
-                     "nsICachedNetData::GetAnnotation() failed");
-        randomStream->Match(storedProtocolData, storedProtocolDataLength);
-
-        // Test GetAllowPartial()
-        PRBool allowPartial;
-        rv = cacheEntry->GetAllowPartial(&allowPartial);
-        NS_ASSERTION(NS_SUCCEEDED(rv) &&
-                     (allowPartial == (PRBool)(randomStream->Next() & 1)),
-                     "nsICachedNetData::GetAllowPartial() failed");
-
-        // Test GetExpirationTime()
-        PRTime expirationTime;
-        PRTime expectedExpirationTime = convertSecondsToPRTime(randomStream->Next() & 0xffffff);
-        rv = cacheEntry->GetExpirationTime(&expirationTime);
-
-        NS_ASSERTION(NS_SUCCEEDED(rv) && LL_EQ(expirationTime, expectedExpirationTime),
-                     "nsICachedNetData::GetExpirationTime() failed");
-
-        PRUint32 expectedStreamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
-
-        TestReadStream(cacheEntry, randomStream, expectedStreamLength);
-    }
-
-    WaitForEvents();
-
-    // Compute rate in MB/s
-    double rate = gTotalBytesRead / PR_IntervalToMilliseconds(gTotalDuration);
-    rate *= NUM_CACHE_ENTRIES;
-    rate *= 1000;
-    rate /= (1024 * 1024);
-    printf("Read  %7d bytes at a rate of %5.1f MB per second \n",
-           gTotalBytesRead, rate);
-
-    return NS_OK;
-}
-
-// Create entries in the network data cache, using random data for the
-// key, the meta-data and the stored content data.
-nsresult
-FillCache(nsINetDataCacheManager *aCache, PRUint32 aFlags, PRUint32 aCacheCapacity)
-{
-    nsresult rv;
-    PRBool inCache;
-    nsCOMPtr<nsICachedNetData> cacheEntry;
-    nsCOMPtr<nsIChannel> channel;
-    nsCOMPtr<nsIOutputStream> outStream;
-    nsCOMPtr<nsINetDataCache> containingCache;
-    char buf[1000];
-    PRUint32 protocolDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char secondaryCacheKey[CACHE_SECONDARY_KEY_LENGTH];
-    char protocolData[CACHE_PROTOCOL_PRIVATE_LENGTH];
-    PRUint32 testNum;
-    RandomStream *randomStream;
-
-    gTotalBytesWritten = 0;
-    PRIntervalTime startTime = PR_IntervalNow();
-    
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->ReadString(cacheKey, sizeof cacheKey - 1);
-        randomStream->Read(secondaryCacheKey, sizeof secondaryCacheKey);
-
-        // No entry should be in cache until we add it
-        rv = aCache->Contains(cacheKey,
-                              secondaryCacheKey, sizeof secondaryCacheKey,
-                              aFlags, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(!inCache, "nsINetDataCacheManager::Contains error");
-        
-        rv = aCache->GetCachedNetData(cacheKey,
-                                      secondaryCacheKey, sizeof secondaryCacheKey,
-                                      aFlags,
-                                      getter_AddRefs(cacheEntry));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access cacheEntry via cache key");
-
-        // Test nsINetDataCacheManager::GetNumEntries()
-        PRUint32 numEntries = (PRUint32)-1;
-        rv = aCache->GetNumEntries(&numEntries);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-        NS_ASSERTION(numEntries == testNum + 1, "GetNumEntries failure");
-
-        // Record meta-data should be initially empty
-        char *protocolDatap;
-        rv = cacheEntry->GetAnnotation("test data", &protocolDataLength, &protocolDatap);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        if ((protocolDataLength != 0) || (protocolDatap != 0))
-            return NS_ERROR_FAILURE;
-
-        // Store random data as meta-data
-        randomStream->Read(protocolData, sizeof protocolData);
-        cacheEntry->SetAnnotation("test data", sizeof protocolData, protocolData);
-
-        // Store random data as allow-partial flag
-        PRBool allowPartial = randomStream->Next() & 1;
-        rv = cacheEntry->SetAllowPartial(allowPartial);
-        NS_ASSERTION(NS_SUCCEEDED(rv),
-                     "nsICachedNetData::SetAllowPartial() failed");
-
-        // Store random data as expiration time
-        PRTime expirationTime = convertSecondsToPRTime(randomStream->Next() & 0xffffff);
-        rv = cacheEntry->SetExpirationTime(expirationTime);
-        NS_ASSERTION(NS_SUCCEEDED(rv),
-                     "nsICachedNetData::SetExpirationTime() failed");
-
-        // Cache manager complains if expiration set without setting last-modified time
-        rv = cacheEntry->SetLastModifiedTime(expirationTime);
-
-        rv = cacheEntry->NewChannel(0, 0, getter_AddRefs(channel));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        rv = cacheEntry->GetCache(getter_AddRefs(containingCache));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        rv = channel->OpenOutputStream(0, getter_AddRefs(outStream));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        
-        int streamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
-        int remaining = streamLength;
-        while (remaining) {
-            PRUint32 numWritten;
-            int amount = PR_MIN(sizeof buf, remaining);
-            randomStream->Read(buf, amount);
-
-            rv = outStream->Write(buf, amount, &numWritten);
-            NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-            NS_ASSERTION(numWritten == (PRUint32)amount, "Write() bug?");
-            
-            remaining -= amount;
-
-            PRUint32 storageInUse;
-            rv = containingCache->GetStorageInUse(&storageInUse);
-            NS_ASSERTION(NS_SUCCEEDED(rv) && (storageInUse <= aCacheCapacity),
-                         "Cache manager failed to limit cache growth");
-        }
-        outStream->Close();
-        gTotalBytesWritten += streamLength;
-
-        // *Now* there should be an entry in the cache
-        rv = aCache->Contains(cacheKey,
-                              secondaryCacheKey, sizeof secondaryCacheKey,
-                              aFlags, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(inCache, "nsINetDataCacheManager::Contains error");
-
-        delete randomStream;
-    }
-
-    PRIntervalTime endTime = PR_IntervalNow();
-
-    // Compute rate in MB/s
-    double rate = gTotalBytesWritten / PR_IntervalToMilliseconds(endTime - startTime);
-    rate *= 1000;
-    rate /= (1024 * 1024);
-    printf("Wrote %7d bytes at a rate of %5.1f MB per second \n",
-           gTotalBytesWritten, rate);
-
-    return NS_OK;
-}
-
-nsresult NS_AutoregisterComponents()
-{
-  nsresult rv = nsComponentManager::AutoRegister(nsIComponentManager::NS_Startup,
-                                                 NULL /* default */);
-  return rv;
-}
-
-nsresult
-Test(nsINetDataCacheManager *aCache, PRUint32 aFlags, PRUint32 aCacheCapacity)
-{
-    nsresult rv;
-
-    rv = aCache->RemoveAll();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
-
-    PRUint32 numEntries = (PRUint32)-1;
-    rv = aCache->GetNumEntries(&numEntries);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
-
-    rv = FillCache(aCache, aFlags, aCacheCapacity);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't fill cache with random test data");
-
-    rv = TestRead(aCache, aFlags);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't read random test data from cache");
-
-    rv = aCache->RemoveAll();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
-
-    rv = aCache->GetNumEntries(&numEntries);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
-
-    return 0;
-}
-int
-main(int argc, char* argv[])
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheManager> cache;
-
-    rv = NS_AutoregisterComponents();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't register XPCOM components");
-
-    rv = nsComponentManager::CreateInstance(NS_NETWORK_CACHE_MANAGER_PROGID,
-                                            nsnull,
-                                            NS_GET_IID(nsINetDataCacheManager),
-                                            getter_AddRefs(cache));
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create cache manager factory") ;
-
-    cache->SetDiskCacheCapacity(DISK_CACHE_CAPACITY);
-    cache->SetMemCacheCapacity(MEM_CACHE_CAPACITY);
-
-    InitQueue();
-    
-    Test(cache, nsINetDataCacheManager::BYPASS_PERSISTENT_CACHE, MEM_CACHE_CAPACITY);
-    Test(cache, nsINetDataCacheManager::BYPASS_MEMORY_CACHE, DISK_CACHE_CAPACITY);
-    return 0;
-}
-

mozilla/netwerk/test/TestRawCache.cpp

@@ -1,820 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- *
- * The contents of this file are subject to the Netscape Public License
- * Version 1.0 (the "NPL"); you may not use this file except in
- * compliance with the NPL.  You may obtain a copy of the NPL at
- * http://www.mozilla.org/NPL/
- *
- * Software distributed under the NPL is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
- * for the specific language governing rights and limitations under the
- * NPL.
- *
- * The Initial Developer of this code under the NPL is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
- * Reserved.
- */
-
-#include "nsIStreamListener.h"
-#include "nsIStreamObserver.h"
-#include "nsIServiceManager.h"
-#include "nsIInputStream.h"
-#include "nsIOutputStream.h"
-#include "nsIEventQueue.h"
-#include "nsIEventQueueService.h"
-#include "nsIChannel.h"
-#include "nsCOMPtr.h"
-#include "nsString.h"
-#include <stdio.h>
-
-#include "nsINetDataCache.h"
-#include "nsINetDataDiskCache.h"
-#include "nsINetDataCacheRecord.h"
-#include "nsMemCacheCID.h"
-// file cache include
-#include "nsNetDiskCacheCID.h"
-#include "nsIPref.h"
-#include "prenv.h"
-#include "nsIFileStream.h"
-
-
-// Number of test entries to be placed in the cache
-#define NUM_CACHE_ENTRIES  250
-
-// Cache content stream length will have random length between zero and
-// MAX_CONTENT_LENGTH bytes
-#define MAX_CONTENT_LENGTH 20000
-
-// Length of random-data cache entry key
-#define CACHE_KEY_LENGTH 15
-
-// Length of random-data cache entry meta-data
-#define CACHE_METADATA_LENGTH 100
-
-static NS_DEFINE_CID(kMemCacheCID, NS_MEM_CACHE_FACTORY_CID);
-static NS_DEFINE_CID(kEventQueueServiceCID, NS_EVENTQUEUESERVICE_CID);
-
-// file cache cid
-static NS_DEFINE_CID(kDiskCacheCID, NS_NETDISKCACHE_CID) ;
-static NS_DEFINE_CID(kPrefCID, NS_PREF_CID);
-static NS_DEFINE_IID(kIPrefIID, NS_IPREF_IID);
-
-// Mapping from test case number to RecordID
-static PRInt32 recordID[NUM_CACHE_ENTRIES];
-
-static PRInt32
-mapRecordIdToTestNum(PRInt32 aRecordID)
-{
-    int i;
-    for (i = 0; i < NUM_CACHE_ENTRIES; i++) {
-        if (recordID[i] == aRecordID)
-            return i;
-    }
-    return -1;
-}
-
-// A supply of stream data to either store or compare with
-class nsITestDataStream {
-public:
-    virtual ~nsITestDataStream() {};
-    virtual PRUint32 Next() = 0;
-    virtual void Read(char* aBuf, PRUint32 aCount) = 0;
-
-    virtual PRBool Match(char* aBuf, PRUint32 aCount) = 0;
-    virtual void Skip(PRUint32 aCount) = 0;
-};
-
-// A reproducible stream of random data.
-class RandomStream : public nsITestDataStream {
-public:
-    RandomStream(PRUint32 aSeed) {
-        mStartSeed = mState = aSeed;
-    }
-    
-    PRUint32 GetStartSeed() {
-        return mStartSeed;
-    }
-    
-    PRUint32 Next() {
-        mState = 1103515245 * mState + 12345;
-        return mState;
-    }
-
-    void Read(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            *aBuf++ = Next();
-        }
-    }
-
-    PRBool
-    Match(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            if (*aBuf++ != (char)(Next() & 0xff))
-                return PR_FALSE;
-        }
-        return PR_TRUE;
-    }
-
-    void
-    Skip(PRUint32 aCount) {
-        while (aCount--)
-            Next();
-    }
-
-protected:
-    
-    PRUint32 mState;
-    PRUint32 mStartSeed;
-};
-
-// A stream of data that increments on each byte that is read, modulo 256
-class CounterStream : public nsITestDataStream {
-public:
-    CounterStream(PRUint32 aSeed) {
-        mStartSeed = mState = aSeed;
-    }
-    
-    PRUint32 GetStartSeed() {
-        return mStartSeed;
-    }
-    
-    PRUint32 Next() {
-        mState += 1;
-        mState &= 0xff;
-        return mState;
-    }
-
-    void Read(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            *aBuf++ = Next();
-        }
-    }
-
-    PRBool
-    Match(char* aBuf, PRUint32 aCount) {
-        PRUint32 i;
-        for (i = 0; i < aCount; i++) {
-            if (*aBuf++ != (char)Next())
-                return PR_FALSE;
-        }
-        return PR_TRUE;
-    }
-
-    void
-    Skip(PRUint32 aCount) {
-        mState += aCount;
-        mState &= 0xff;
-    }
-
-protected:
-    
-    PRUint32 mState;
-    PRUint32 mStartSeed;
-};
-
-static int gNumReaders = 0;
-static PRUint32 gTotalBytesRead = 0;
-static PRUint32 gTotalDuration = 0;
-
-class nsReader : public nsIStreamListener {
-public:
-    NS_DECL_ISUPPORTS
-
-    nsReader()
-        : mStartTime(0), mBytesRead(0)
-    {
-        NS_INIT_REFCNT();
-        gNumReaders++;
-    }
-
-    virtual ~nsReader() {
-        delete mTestDataStream;
-        gNumReaders--;
-    }
-
-    nsresult 
-    Init(nsITestDataStream* aRandomStream, PRUint32 aExpectedStreamLength) {
-        mTestDataStream = aRandomStream;
-        mExpectedStreamLength = aExpectedStreamLength;
-        mRefCnt = 1;
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnStartRequest(nsIChannel* channel,
-                              nsISupports* context) {
-        mStartTime = PR_IntervalNow();
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnDataAvailable(nsIChannel* channel, 
-                               nsISupports* context,
-                               nsIInputStream *aIStream, 
-                               PRUint32 aSourceOffset,
-                               PRUint32 aLength) {
-        char buf[1025];
-        while (aLength > 0) {
-            PRUint32 amt;
-            PRBool match;
-            aIStream->Read(buf, sizeof buf, &amt);
-            if (amt == 0) break;
-            aLength -= amt;
-            mBytesRead += amt;
-            match = mTestDataStream->Match(buf, amt);
-            NS_ASSERTION(match, "Stored data was corrupted on read");
-        }
-        return NS_OK;
-    }
-
-    NS_IMETHOD OnStopRequest(nsIChannel* channel, 
-                             nsISupports* context,
-                             nsresult aStatus,
-                             const PRUnichar* aMsg) {
-        PRIntervalTime endTime;
-        PRIntervalTime duration;
-        
-        endTime = PR_IntervalNow();
-        duration = (endTime - mStartTime);
-
-        if (NS_FAILED(aStatus)) printf("channel failed.\n");
-        //        printf("read %d bytes\n", mBytesRead);
-
-        NS_ASSERTION(mBytesRead == mExpectedStreamLength,
-                     "Stream in cache is wrong length");
-
-        gTotalBytesRead += mBytesRead;
-        gTotalDuration += duration;
-
-        return NS_OK;
-    }
-
-protected:
-    PRIntervalTime       mStartTime;
-    PRUint32             mBytesRead;
-    nsITestDataStream*   mTestDataStream;
-    PRUint32             mExpectedStreamLength;
-};
-
-NS_IMPL_ISUPPORTS2(nsReader, nsIStreamListener, nsIStreamObserver)
-
-static nsIEventQueue* eventQueue;
-
-nsresult
-InitQueue() {
-    nsresult rv;
-
-    NS_WITH_SERVICE(nsIEventQueueService, eventQService, kEventQueueServiceCID, &rv);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue service");
-
-    rv = eventQService->CreateThreadEventQueue();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create event queue");
-  
-    rv = eventQService->GetThreadEventQueue(PR_CurrentThread(), &eventQueue);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get event queue for main thread");
-
-    return NS_OK;
-}
-
-// Process events until all streams are OnStopRequest'ed
-nsresult
-WaitForEvents() {
-    while (gNumReaders) {
-        eventQueue->ProcessPendingEvents();
-    }
-    return NS_OK;
-}
-
-// Read data for a single cache record and compare against testDataStream
-nsresult
-TestReadStream(nsINetDataCacheRecord *record, nsITestDataStream *testDataStream,
-               PRUint32 expectedStreamLength)
-{
-    nsCOMPtr<nsIChannel> channel;
-    nsresult rv;
-    PRUint32 actualContentLength;
-
-    rv = record->NewChannel(0, getter_AddRefs(channel));
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-    rv = record->GetStoredContentLength(&actualContentLength);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    NS_ASSERTION(actualContentLength == expectedStreamLength,
-                 "nsINetDataCacheRecord::GetContentLength() busted ?");
-    
-    nsReader *reader = new nsReader;
-    rv = reader->Init(testDataStream, expectedStreamLength);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    
-    rv = channel->AsyncRead(0, -1, 0, reader);
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-    reader->Release();
-
-    return NS_OK;
-}
-
-// Check that records can be retrieved using their record-ID, in addition
-// to using the opaque key.
-nsresult
-TestRecordID(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    RandomStream *randomStream;
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char *metaData;
-    PRUint32 testNum;
-    PRBool match;
-
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        rv = cache->GetCachedNetDataByID(recordID[testNum], getter_AddRefs(record));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't obtain record using record ID");
-
-        // Match against previously stored meta-data
-        rv = record->GetMetaData(&metaDataLength, &metaData);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
-        match = randomStream->Match(metaData, metaDataLength);
-        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
-
-        nsAllocator::Free(metaData);
-        delete randomStream;
-    }
-    return NS_OK;
-}
-
-// Check that all cache entries in the database are enumerated and that
-// no duplicates appear.
-nsresult
-TestEnumeration(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsCOMPtr<nsISupports> tempISupports;
-    nsCOMPtr<nsISimpleEnumerator> iterator;
-    RandomStream *randomStream;
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char *metaData;
-    PRUint32 testNum;
-    PRBool match;
-    PRInt32 recID;
-
-    int numRecords = 0;
-
-    // Iterate over all records in the cache
-    rv = cache->NewCacheEntryIterator(getter_AddRefs(iterator));
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create new cache entry iterator");
-
-    PRBool notDone;
-    while (1) {
-
-        // Done iterating ?
-        rv = iterator->HasMoreElements(&notDone);
-        if (NS_FAILED(rv)) return rv;
-        if (!notDone)
-            break;
-
-        // Get next record in iteration
-        rv = iterator->GetNext(getter_AddRefs(tempISupports));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "iterator bustage");
-        record = do_QueryInterface(tempISupports);
-
-        numRecords++;
-
-        // Get record ID
-        rv = record->GetRecordID(&recID);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
-        testNum = mapRecordIdToTestNum(recID);
-        NS_ASSERTION(testNum != -1, "Corrupted Record ID ?");
-
-        // Erase mapping from table, so that duplicate enumerations are detected
-        recordID[testNum] = -1;
-
-        // Make sure stream matches test data
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        // Match against previously stored meta-data
-        rv = record->GetMetaData(&metaDataLength, &metaData);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get record meta-data");
-        match = randomStream->Match(metaData, metaDataLength);
-        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
-        nsAllocator::Free(metaData);
-
-        delete randomStream;
-    }
-
-    NS_ASSERTION(numRecords == NUM_CACHE_ENTRIES, "Iteration bug");
-
-    return NS_OK;
-}
-
-// Read the test data that was written in FillCache(), checking for
-// corruption, truncation.
-nsresult
-TestRead(nsINetDataCache *cache)
-{
-    nsresult rv;
-    PRBool inCache;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    RandomStream *randomStream;
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char *metaData, *storedCacheKey;
-    PRUint32 testNum, storedCacheKeyLength;
-    PRBool match;
-
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        // Ensure that entry is in the cache
-        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
-        
-        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        // Match against previously stored meta-data
-        match = record->GetMetaData(&metaDataLength, &metaData);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        match = randomStream->Match(metaData, metaDataLength);
-        NS_ASSERTION(match, "Meta-data corrupted or incorrect");
-        nsAllocator::Free(metaData);
-
-        // Test GetKey() method
-        rv = record->GetKey(&storedCacheKeyLength, &storedCacheKey);
-        NS_ASSERTION(NS_SUCCEEDED(rv) &&
-                     (storedCacheKeyLength == sizeof cacheKey) &&
-                     !memcmp(storedCacheKey, &cacheKey[0], sizeof cacheKey),
-                     "nsINetDataCacheRecord::GetKey failed");
-        nsAllocator::Free(storedCacheKey);
-
-        PRUint32 expectedStreamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
-
-        TestReadStream(record, randomStream, expectedStreamLength);
-    }
-
-    WaitForEvents();
-
-    // Compute rate in MB/s
-    double rate = gTotalBytesRead / PR_IntervalToMilliseconds(gTotalDuration);
-    rate *= NUM_CACHE_ENTRIES;
-    rate *= 1000;
-    rate /= (1024 * 1024);
-    printf("Read %d bytes at a rate of %5.1f MB per second \n",
-           gTotalBytesRead, rate);
-
-    return NS_OK;
-}
-
-// Repeatedly call SetStoredContentLength() on a cache entry and make
-// read the stream's data to ensure that it's not corrupted by the effect
-nsresult
-TestTruncation(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    RandomStream *randomStream;
-    char cacheKey[CACHE_KEY_LENGTH];
-
-    randomStream = new RandomStream(0);
-    randomStream->Read(cacheKey, sizeof cacheKey);
-
-    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-    NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-    randomStream->Skip(CACHE_METADATA_LENGTH);
-    PRUint32 initialStreamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
-    delete randomStream;
-
-    PRUint32 i;
-    PRUint32 delta = initialStreamLength / 64;
-    for (i = initialStreamLength; i >= delta; i -= delta) {
-        PRUint32 expectedStreamLength = i;
-
-        // Do the truncation
-        record->SetStoredContentLength(expectedStreamLength);
-        randomStream = new RandomStream(0);
-        randomStream->Skip(CACHE_KEY_LENGTH + CACHE_METADATA_LENGTH + 1);
-
-        PRUint32 afterContentLength;
-        rv = record->GetStoredContentLength(&afterContentLength);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        NS_ASSERTION(afterContentLength == expectedStreamLength,
-                     "nsINetDataCacheRecord::SetContentLength() failed to truncate record");
-
-        TestReadStream(record, randomStream, expectedStreamLength);
-        WaitForEvents();
-    }
-
-    return NS_OK;
-}
-
-// Write known data to random offsets in a single cache entry and test
-// resulting stream for correctness.
-nsresult
-TestOffsetWrites(nsINetDataCache *cache)
-{
-    nsresult rv;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsCOMPtr<nsIChannel> channel;
-    nsCOMPtr<nsIOutputStream> outStream;
-    char buf[512];
-    char cacheKey[CACHE_KEY_LENGTH];
-    RandomStream *randomStream;
-
-    randomStream = new RandomStream(0);
-    randomStream->Read(cacheKey, sizeof cacheKey);
-
-    rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
-
-
-    // Write buffer-fulls of data at random offsets into the cache entry.
-    // Data written is (offset % 0xff)
-    PRUint32 startingOffset;
-    PRUint32 streamLength = 0;
-    CounterStream *counterStream;
-    int i;
-    for (i = 0; i < 100; i++) {
-        rv = record->NewChannel(0, getter_AddRefs(channel));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        startingOffset = streamLength ? streamLength - (randomStream->Next() % sizeof buf): 0;
-        rv = channel->OpenOutputStream(startingOffset, getter_AddRefs(outStream));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        
-        counterStream = new CounterStream(startingOffset);
-        counterStream->Read(buf, sizeof buf);
-
-        PRUint32 numWritten;
-        rv = outStream->Write(buf, sizeof buf, &numWritten);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(numWritten == sizeof buf, "Write() bug?");
-        streamLength = startingOffset + sizeof buf;
-
-        rv = outStream->Close();
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't close channel");
-        delete counterStream;
-    }
-    
-    delete randomStream;
-
-    counterStream = new CounterStream(0);
-    TestReadStream(record, counterStream, streamLength);
-    WaitForEvents();
-
-    return NS_OK;
-}
-
-// Create entries in the network data cache, using random data for the
-// key, the meta-data and the stored content data.
-nsresult
-FillCache(nsINetDataCache *cache)
-{
-    nsresult rv;
-    PRBool inCache;
-    nsCOMPtr<nsINetDataCacheRecord> record;
-    nsCOMPtr<nsIChannel> channel;
-    nsCOMPtr<nsIOutputStream> outStream;
-    char buf[1000];
-    PRUint32 metaDataLength;
-    char cacheKey[CACHE_KEY_LENGTH];
-    char metaData[CACHE_METADATA_LENGTH];
-    PRUint32 testNum;
-    char *data;
-    RandomStream *randomStream;
-    PRUint32 totalBytesWritten = 0;
-
-    PRIntervalTime startTime = PR_IntervalNow();
-    
-    for (testNum = 0; testNum < NUM_CACHE_ENTRIES; testNum++) {
-        randomStream = new RandomStream(testNum);
-        randomStream->Read(cacheKey, sizeof cacheKey);
-
-        // No entry should be in cache until we add it
-        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(!inCache, "nsINetDataCache::Contains error");
-        
-        rv = cache->GetCachedNetData(cacheKey, sizeof cacheKey, getter_AddRefs(record));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't access record via opaque cache key");
-
-        // Test nsINetDataCacheRecord::GetRecordID()
-        rv = record->GetRecordID(&recordID[testNum]);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get Record ID");
-
-        // Test nsINetDataCache::GetNumEntries()
-        PRUint32 numEntries = (PRUint32)-1;
-        rv = cache->GetNumEntries(&numEntries);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-        NS_ASSERTION(numEntries == testNum + 1, "GetNumEntries failure");
-
-        // Record meta-data should be initially empty
-        rv = record->GetMetaData(&metaDataLength, &data);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        if ((metaDataLength != 0) || (data != 0))
-            return NS_ERROR_FAILURE;
-
-        // Store random data as meta-data
-        randomStream->Read(metaData, sizeof metaData);
-        record->SetMetaData(sizeof metaData, metaData);
-
-        rv = record->NewChannel(0, getter_AddRefs(channel));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-
-        rv = channel->OpenOutputStream(0, getter_AddRefs(outStream));
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        
-        PRUint32 beforeOccupancy;
-        rv = cache->GetStorageInUse(&beforeOccupancy);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-
-        int streamLength = randomStream->Next() % MAX_CONTENT_LENGTH;
-        int remaining = streamLength;
-        while (remaining) {
-            PRUint32 numWritten;
-            int amount = PR_MIN(sizeof buf, remaining);
-            randomStream->Read(buf, amount);
-
-            rv = outStream->Write(buf, amount, &numWritten);
-            NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-            NS_ASSERTION(numWritten == (PRUint32)amount, "Write() bug?");
-            
-            remaining -= amount;
-        }
-        outStream->Close();
-        totalBytesWritten += streamLength;
-
-        PRUint32 afterOccupancy;
-        rv = cache->GetStorageInUse(&afterOccupancy);
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-        PRUint32 streamLengthInKB = streamLength >> 10;
-        NS_ASSERTION((afterOccupancy - beforeOccupancy) >= streamLengthInKB,
-                     "nsINetDataCache::GetStorageInUse() is busted");
-        
-
-        // *Now* there should be an entry in the cache
-        rv = cache->Contains(cacheKey, sizeof cacheKey, &inCache);
-        NS_ASSERTION(NS_SUCCEEDED(rv), " ");
-        NS_ASSERTION(inCache, "nsINetDataCache::Contains error");
-
-        delete randomStream;
-    }
-
-    PRIntervalTime endTime = PR_IntervalNow();
-
-    // Compute rate in MB/s
-    double rate = totalBytesWritten / PR_IntervalToMilliseconds(endTime - startTime);
-    rate *= 1000;
-    rate /= (1024 * 1024);
-    printf("Wrote %7d bytes at a rate of %5.1f MB per second \n",
-           totalBytesWritten, rate);
-
-    return NS_OK;
-}
-
-nsresult NS_AutoregisterComponents()
-{
-  nsresult rv = nsComponentManager::AutoRegister(nsIComponentManager::NS_Startup,
-                                                 NULL /* default */);
-  return rv;
-}
-
-PRBool initPref ()
-{
-    nsresult rv;
-    NS_WITH_SERVICE(nsIPref, prefPtr, kPrefCID, &rv);
-    if (NS_FAILED(rv))
-        return false;
-               
-    nsCOMPtr<nsIFileSpec> fileSpec;
-    rv = NS_NewFileSpec (getter_AddRefs(fileSpec));
-    if (NS_FAILED(rv))
-        return false;
-                            
-    nsCString defaultPrefFile = PR_GetEnv ("MOZILLA_FIVE_HOME");
-    if (defaultPrefFile.Length())
-        defaultPrefFile += "/";
-    else
-        defaultPrefFile = "./";
-    defaultPrefFile += "default_prefs.js";
-                                                 
-    fileSpec->SetUnixStyleFilePath (defaultPrefFile.GetBuffer());
-                                                    
-    PRBool exists = false;
-    fileSpec->Exists(&exists);
-    if (exists)
-        prefPtr->ReadUserPrefsFrom(fileSpec);
-    else
-        return false;
-    return true;
-}
-
-int
-main(int argc, char* argv[])
-{
-    nsresult rv;
-
-    if(argc <2) {
-      printf(" %s -f to test filecache\n", argv[0]) ;
-      printf(" %s -m to test memcache\n", argv[0]) ;
-      return -1 ;
-    }
-
-
-    rv = NS_AutoregisterComponents();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't register XPCOM components");
-
-    nsCOMPtr<nsINetDataCache> cache;
-
-    if (PL_strcasecmp(argv[1], "-m") == 0) {
-        rv = nsComponentManager::CreateInstance(kMemCacheCID, nsnull,
-                                            NS_GET_IID(nsINetDataCache),
-                                            getter_AddRefs(cache));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create memory cache factory");
-    } else if (PL_strcasecmp(argv[1], "-f") == 0) {
-
-        nsCOMPtr<nsINetDataDiskCache> diskcache ;
-
-        rv = nsComponentManager::CreateInstance(kDiskCacheCID, nsnull,
-                                            NS_GET_IID(nsINetDataDiskCache),
-                                             getter_AddRefs(diskcache));
-        NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't create disk cache factory") ;
-        
-        nsCOMPtr<nsIFileSpec> folder ;
-        NS_NewFileSpec(getter_AddRefs(folder)) ;
-        folder->SetUnixStyleFilePath("/tmp") ;
-        diskcache->SetDiskCacheFolder(folder) ;
-
-        cache = diskcache ;
-
-    } else {
-      printf("  %s -f to test filecache\n", argv[0]) ;
-      printf(" %s -m to test memcache\n", argv[0]) ;
-      return -1 ;
-    }
-
-    InitQueue();
-
-    PRUnichar* description;
-    rv = cache->GetDescription(&description);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache description");
-    nsCAutoString descStr(description);
-    printf("Testing: %s\n", descStr.GetBuffer());
-
-    rv = cache->RemoveAll();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
-
-    PRUint32 startOccupancy;
-    rv = cache->GetStorageInUse(&startOccupancy);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-
-    PRUint32 numEntries = (PRUint32)-1;
-    rv = cache->GetNumEntries(&numEntries);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
-
-    rv = FillCache(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't fill cache with random test data");
-
-    rv = TestRead(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't read random test data from cache");
-
-    rv = TestRecordID(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't index records using record ID");
-
-    rv = TestEnumeration(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully enumerate records");
-
-    rv = TestTruncation(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully truncate records");
-
-    rv = TestOffsetWrites(cache);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't successfully write to records using non-zero offsets");
-
-    rv = cache->RemoveAll();
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't clear cache");
-    rv = cache->GetNumEntries(&numEntries);
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get number of cache entries");
-    NS_ASSERTION(numEntries == 0, "Couldn't clear cache");
-
-    PRUint32 endOccupancy;
-    rv = cache->GetStorageInUse(&endOccupancy);
-
-    NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't get cache occupancy");
-
-    NS_ASSERTION(startOccupancy == endOccupancy, "Cache occupancy not correctly computed ?");
-
-    return 0;
-}
-

mozilla/netwerk/test/makefile.win

@@ -1,82 +0,0 @@
-#!nmake
-#
-# The contents of this file are subject to the Netscape 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/NPL/
-#
-# 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.
-#
-# The Original Code is mozilla.org code.
-#
-# The Initial Developer of the Original Code is Netscape
-# Communications Corporation.  Portions created by Netscape are
-# Copyright (C) 1998 Netscape Communications Corporation. All
-# Rights Reserved.
-#
-# Contributor(s): 
-
-DEPTH=..\..
-
-MAKE_OBJ_TYPE	= EXE
-PROG1 = .\$(OBJDIR)\TestFileInput.exe
-PROG2 = .\$(OBJDIR)\TestSocketInput.exe
-PROG3 = .\$(OBJDIR)\TestSocketIO.exe
-PROG4 = .\$(OBJDIR)\TestProtocols.exe
-PROG5 = .\$(OBJDIR)\TestSocketTransport.exe
-PROG6 = .\$(OBJDIR)\urltest.exe
-PROG7 = .\$(OBJDIR)\TestFileInput2.exe
-PROG8 = .\$(OBJDIR)\TestFileTransport.exe
-PROG9 = .\$(OBJDIR)\TestRes.exe
-PROGA = .\$(OBJDIR)\TestRawCache.exe
-PROGB = .\$(OBJDIR)\TestCacheMgr.exe
-PROGRAMS = \
-#$(PROG1) $(PROG2) $(PROG3) $(PROG4) $(PROG5) $(PROG6) $(PROG7) $(PROG8) $(PROG9)\
-          $(PROGA) $(PROGB)
-
-LCFLAGS=-DUSE_NSREG -GX
-
-REQUIRES=libreg
-
-INCS = $(INCS)                  \
-        -I$(DEPTH)\dist\include \
-        $(NULL)
-
-LLIBS=                 \
- $(DIST)\lib\xpcom.lib \
- $(LIBNSPR)            \
- $(NULL)
-
-include <$(DEPTH)\config\rules.mak>
-
-install:: $(PROGRAMS)
-	-for %p in ($(PROGRAMS)) do $(MAKE_INSTALL) %p $(DIST)\bin
-
-clobber::
-	-for %p in ($(PROGRAMS)) do $(RM) %p $(DIST)\bin\%p
-
-$(PROG1): $(OBJDIR) TestFileInput.cpp
-
-$(PROG2): $(OBJDIR) TestSocketInput.cpp
-
-$(PROG3): $(OBJDIR) TestSocketIO.cpp
-
-$(PROG4): $(OBJDIR) TestProtocols.cpp
-
-$(PROG5): $(OBJDIR) TestSocketTransport.cpp
-
-$(PROG6): $(OBJDIR) urltest.cpp
-
-$(PROG7): $(OBJDIR) TestFileInput2.cpp
-
-$(PROG8): $(OBJDIR) TestFileTransport.cpp
-
-$(PROG9): $(OBJDIR) TestRes.cpp
-
-$(PROGA): $(OBJDIR) TestRawCache.cpp
-
-$(PROGB): $(OBJDIR) TestCacheMgr.cpp
-

mozilla/string/obsolete/nsXPIDLString.cpp

@@ -0,0 +1,162 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsDebug.h"
+#include "nsXPIDLString.h"
+#include "plstr.h"
+
+// XXX change to use nsIAllocator or whatever
+#define XPIDL_STRING_ALLOC(__size)  new PRUnichar[(__size)]
+#define XPIDL_CSTRING_ALLOC(__size) new char[(__size)]
+#define XPIDL_FREE(__ptr)           delete[] (__ptr)
+
+////////////////////////////////////////////////////////////////////////
+// nsXPIDLString
+
+nsXPIDLString::nsXPIDLString()
+    : mBufOwner(PR_FALSE),
+      mBuf(0)
+{
+}
+
+
+nsXPIDLString::~nsXPIDLString()
+{
+    if (mBufOwner && mBuf)
+        XPIDL_FREE(mBuf);
+}
+
+
+nsXPIDLString::operator const PRUnichar*()
+{
+    return mBuf;
+}
+
+
+PRUnichar*
+nsXPIDLString::Copy(const PRUnichar* aString)
+{
+    NS_ASSERTION(aString, "null ptr");
+    if (! aString)
+        return 0;
+
+    PRInt32 len = 0;
+
+    {
+        const PRUnichar* p = aString;
+        while (*p++)
+            len++;
+    }
+
+    PRUnichar* result = XPIDL_STRING_ALLOC(len + 1);
+    if (result) {
+        PRUnichar* q = result;
+        while (*aString) {
+            *q = *aString;
+            q++;
+            aString++;
+        }
+        *q = '\0';
+    }
+    return result;
+}
+
+
+PRUnichar**
+nsXPIDLString::StartAssignmentByValue()
+{
+    if (mBufOwner && mBuf)
+        XPIDL_FREE(mBuf);
+
+    mBufOwner = PR_TRUE;
+    return &mBuf;
+}
+
+
+const PRUnichar**
+nsXPIDLString::StartAssignmentByReference()
+{
+    if (mBufOwner && mBuf)
+        XPIDL_FREE(mBuf);
+
+    mBufOwner = PR_FALSE;
+    return (const PRUnichar**) &mBuf;
+}
+
+
+////////////////////////////////////////////////////////////////////////
+// nsXPIDLCString
+
+nsXPIDLCString::nsXPIDLCString()
+    : mBufOwner(PR_FALSE),
+      mBuf(0)
+{
+}
+
+
+nsXPIDLCString::~nsXPIDLCString()
+{
+    if (mBufOwner && mBuf)
+        XPIDL_FREE(mBuf);
+}
+
+
+nsXPIDLCString::operator const char*()
+{
+    return mBuf;
+}
+
+
+char*
+nsXPIDLCString::Copy(const char* aCString)
+{
+    NS_ASSERTION(aCString, "null ptr");
+    if (! aCString)
+        return 0;
+
+    PRInt32 len = PL_strlen(aCString);
+    char* result = XPIDL_CSTRING_ALLOC(len + 1);
+    if (result)
+        PL_strcpy(result, aCString);
+
+    return result;
+}
+
+
+char**
+nsXPIDLCString::StartAssignmentByValue()
+{
+    if (mBufOwner && mBuf)
+        XPIDL_FREE(mBuf);
+
+    mBufOwner = PR_TRUE;
+    return &mBuf;
+}
+
+
+const char**
+nsXPIDLCString::StartAssignmentByReference()
+{
+    if (mBufOwner && mBuf)
+        XPIDL_FREE(mBuf);
+
+    mBufOwner = PR_FALSE;
+    return (const char**) &mBuf;
+}
+
+

mozilla/string/obsolete/nsXPIDLString.h

@@ -0,0 +1,294 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+/*
+
+  A set of string wrapper classes that ease transition to use of XPIDL
+  interfaces. nsXPIDLString and nsXPIDLCString are to XPIDL `wstring'
+  and `string' out params as nsCOMPtr is to generic XPCOM interface
+  pointers. They help you deal with object ownership.
+
+  Consider the following interface:
+
+    interface nsIFoo {
+      attribute string Bar;
+    };
+
+  This will generated the following C++ header file:
+
+    class nsIFoo {
+      NS_IMETHOD SetBar(const PRUnichar* aValue);
+      NS_IMETHOD GetBar(PRUnichar* *aValue);
+    };
+
+  The GetBar() method will allocate a copy of the nsIFoo object's
+  "bar" attribute, and leave you to deal with freeing it:
+
+    nsIFoo* aFoo; // assume we get this somehow
+    PRUnichar* bar;
+    aFoo->GetFoo(&bar);
+    // Use bar here...
+    delete[] bar;
+
+  (Strictly speaking, The `delete[] bar' would use the proper XPCOM
+  de-allocator, we'll ignore that for now.) This makes your life
+  harder, because you need to convolute your code to ensure that you
+  don't leak `bar'.
+
+  Enter nsXPIDLString, which manages the ownership of the allocated
+  string, and automatically destroys it when the nsXPIDLString goes
+  out of scope:
+
+    nsIFoo* aFoo;
+    nsXPIDLString bar;
+    aFoo->GetFoo( getter_Copies(bar) );
+    // Use bar here...
+
+  Like nsCOMPtr, nsXPIDLString uses some syntactic sugar to make it
+  painfully clear exactly what the code expects. You need to wrap an
+  nsXPIDLString object with either `getter_Copies()' or
+  `getter_Shares()': these tell the nsXPIDLString how ownership is
+  being handled. In the case of `getter_Copies()', the callee is
+  allocating a copy (which is usually the case). In the case of
+  `getter_Shares()', the callee is returning a const reference to `the
+  real deal' (this can be done using the [shared] attribute in XPIDL).
+
+ */
+
+#ifndef nsXPIDLString_h__
+#define nsXPIDLString_h__
+
+#include "nsCom.h"
+#include "prtypes.h"
+
+#ifndef __PRUNICHAR__
+#define __PRUNICHAR__
+typedef PRUint16 PRUnichar;
+#endif /* __PRUNICHAR__ */
+
+////////////////////////////////////////////////////////////////////////
+// nsXPIDLString
+//
+//   A wrapper for Unicode strings. With the |getter_Copies()| and
+//   |getter_Shares()| helper functions, this can be used instead of
+//   the "naked" |PRUnichar*| interface for |wstring| parameters in
+//   XPIDL interfaces.
+//
+
+class NS_COM nsXPIDLString {
+private:
+    PRUnichar* mBuf;
+    PRBool     mBufOwner;
+
+    PRUnichar** StartAssignmentByValue();
+    const PRUnichar** StartAssignmentByReference();
+
+public:
+    /**
+     * Construct a new, uninitialized wrapper for a Unicode string.
+     */
+    nsXPIDLString();
+
+    virtual ~nsXPIDLString();
+
+    /**
+     * Return an immutable reference to the Unicode string.
+     */
+    operator const PRUnichar*();
+
+    /**
+     * Make a copy of the Unicode string. Use this function in the
+     * callee to ensure that the correct memory allocator is used.
+     */
+    static PRUnichar* Copy(const PRUnichar* aString);
+
+    // A helper class for assignment-by-value. This class is an
+    // implementation detail and should not be considered part of the
+    // public interface.
+    class NS_COM GetterCopies {
+    private:
+        nsXPIDLString& mXPIDLString;
+
+    public:
+        GetterCopies(nsXPIDLString& aXPIDLString)
+            : mXPIDLString(aXPIDLString) {}
+
+        operator PRUnichar**() {
+            return mXPIDLString.StartAssignmentByValue();
+        }
+
+        friend GetterCopies getter_Copies(nsXPIDLString& aXPIDLString);
+    };
+
+    friend class GetterCopies;
+
+    // A helper class for assignment-by-reference. This class is an
+    // implementation detail and should not be considered part of the
+    // public interface.
+    class NS_COM GetterShares {
+    private:
+        nsXPIDLString& mXPIDLString;
+
+    public:
+        GetterShares(nsXPIDLString& aXPIDLString)
+            : mXPIDLString(aXPIDLString) {}
+
+        operator const PRUnichar**() {
+            return mXPIDLString.StartAssignmentByReference();
+        }
+
+        friend GetterShares getter_Shares(nsXPIDLString& aXPIDLString);
+    };
+
+    friend class GetterShares;
+
+private:
+    // not to be implemented
+    nsXPIDLString(nsXPIDLString& aXPIDLString) {}
+    nsXPIDLString& operator =(nsXPIDLString& aXPIDLString) { return *this; }
+};
+
+
+/**
+ * Use this function to "wrap" the nsXPIDLString object that is to
+ * receive an |out| value.
+ */
+inline nsXPIDLString::GetterCopies
+getter_Copies(nsXPIDLString& aXPIDLString)
+{
+    return nsXPIDLString::GetterCopies(aXPIDLString);
+}
+
+/**
+ * Use this function to "wrap" the nsXPIDLString object that is to
+ * receive a |[shared] out| value.
+ */
+inline nsXPIDLString::GetterShares
+getter_Shares(nsXPIDLString& aXPIDLString)
+{
+    return nsXPIDLString::GetterShares(aXPIDLString);
+}
+
+
+
+////////////////////////////////////////////////////////////////////////
+// nsXPIDLCString
+//
+//   A wrapper for Unicode strings. With the |getter_Copies()| and
+//   |getter_Shares()| helper functions, this can be used instead of
+//   the "naked" |char*| interface for |wstring| parameters in XPIDL
+//   interfaces.
+//
+
+class NS_COM nsXPIDLCString {
+private:
+    char*  mBuf;
+    PRBool mBufOwner;
+
+    char** StartAssignmentByValue();
+    const char** StartAssignmentByReference();
+
+public:
+    /**
+     * Construct a new, uninitialized wrapper for a single-byte string.
+     */
+    nsXPIDLCString();
+
+    virtual ~nsXPIDLCString();
+
+    /**
+     * Return an immutable reference to the single-byte string.
+     */
+    operator const char*();
+
+    /**
+     * Make a copy of the single-byte string. Use this function in the
+     * callee to ensure that the correct memory allocator is used.
+     */
+    static char* Copy(const char* aString);
+
+    // A helper class for assignment-by-value. This class is an
+    // implementation detail and should not be considered part of the
+    // public interface.
+    class NS_COM GetterCopies {
+    private:
+        nsXPIDLCString& mXPIDLString;
+
+    public:
+        GetterCopies(nsXPIDLCString& aXPIDLString)
+            : mXPIDLString(aXPIDLString) {}
+
+        operator char**() {
+            return mXPIDLString.StartAssignmentByValue();
+        }
+
+        friend GetterCopies getter_Copies(nsXPIDLCString& aXPIDLString);
+    };
+
+    friend class GetterCopies;
+
+    // A helper class for assignment-by-reference. This class is an
+    // implementation detail and should not be considered part of the
+    // public interface.
+    class NS_COM GetterShares {
+    private:
+        nsXPIDLCString& mXPIDLString;
+
+    public:
+        GetterShares(nsXPIDLCString& aXPIDLString)
+            : mXPIDLString(aXPIDLString) {}
+
+        operator const char**() {
+            return mXPIDLString.StartAssignmentByReference();
+        }
+
+        friend GetterShares getter_Shares(nsXPIDLCString& aXPIDLString);
+    };
+
+    friend class GetterShares;
+
+private:
+    // not to be implemented
+    nsXPIDLCString(nsXPIDLCString& aXPIDLString) {}
+    nsXPIDLCString& operator =(nsXPIDLCString& aXPIDLString) { return *this; }
+};
+
+/**
+ * Use this function to "wrap" the nsXPIDLCString object that is to
+ * receive an |out| value.
+ */
+inline nsXPIDLCString::GetterCopies
+getter_Copies(nsXPIDLCString& aXPIDLString)
+{
+    return nsXPIDLCString::GetterCopies(aXPIDLString);
+}
+
+
+/**
+ * Use this function to "wrap" the nsXPIDLCString object that is to
+ * receive a |[shared] out| value.
+ */
+inline nsXPIDLCString::GetterShares
+getter_Shares(nsXPIDLCString& aXPIDLString)
+{
+    return nsXPIDLCString::GetterShares(aXPIDLString);
+}
+
+
+
+#endif // nsXPIDLString_h__

mozilla/xpcom/Makefile.in

@@ -0,0 +1,30 @@
+#!gmake
+# The contents of this file are subject to the Netscape Public License
+# Version 1.0 (the "NPL"); you may not use this file except in
+# compliance with the NPL.  You may obtain a copy of the NPL at
+# http://www.mozilla.org/NPL/
+#
+# Software distributed under the NPL is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+# for the specific language governing rights and limitations under the
+# NPL.
+#
+# The Initial Developer of this code under the NPL is Netscape
+# Communications Corporation.  Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+# Reserved.
+
+DEPTH	= ..
+topsrcdir	= @top_srcdir@
+VPATH		= @srcdir@
+srcdir		= @srcdir@
+
+include $(DEPTH)/config/autoconf.mk
+
+DIRS	= public src idl libxpt
+
+ifdef ENABLE_TESTS
+DIRS += tests
+endif
+
+include $(topsrcdir)/config/rules.mk

mozilla/xpcom/base/nsAgg.h

@@ -0,0 +1,170 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsAgg_h___
+#define nsAgg_h___
+
+#include "nsISupports.h"
+
+/**
+ * Outer objects can implement nsIOuter if they choose, allowing them to 
+ * get notification if their inner objects (children) are effectively freed.
+ * This allows them to reset any state associated with the inner object and
+ * potentially unload it.
+ */
+class nsIOuter : public nsISupports {
+public:
+
+    /**
+     * This method is called whenever an inner object's refcount is about to
+     * become zero and the inner object should be released by the outer. This
+     * allows the outer to clean up any state associated with the inner and 
+     * potentially unload the inner object. This method should call 
+     * inner->Release().
+     */
+    NS_IMETHOD
+    ReleaseInner(nsISupports* inner) = 0;
+
+};
+
+#define NS_IOUTER_IID                                \
+{ /* ea0bf9f0-3d67-11d2-8163-006008119d7a */         \
+    0xea0bf9f0,                                      \
+    0x3d67,                                          \
+    0x11d2,                                          \
+    {0x81, 0x63, 0x00, 0x60, 0x08, 0x11, 0x9d, 0x7a} \
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+// Put this in your class's declaration:
+#define NS_DECL_AGGREGATED                                                  \
+    NS_DECL_ISUPPORTS                                                       \
+                                                                            \
+protected:                                                                  \
+                                                                            \
+    /* You must implement this operation instead of the nsISupports */      \
+    /* methods if you inherit from nsAggregated. */                         \
+    NS_IMETHOD                                                              \
+    AggregatedQueryInterface(const nsIID& aIID, void** aInstancePtr);       \
+                                                                            \
+    class Internal : public nsISupports {                                   \
+    public:                                                                 \
+                                                                            \
+        Internal() {}                                                       \
+                                                                            \
+        NS_IMETHOD QueryInterface(const nsIID& aIID,                        \
+                                        void** aInstancePtr);               \
+        NS_IMETHOD_(nsrefcnt) AddRef(void);                                 \
+        NS_IMETHOD_(nsrefcnt) Release(void);                                \
+                                                                            \
+    };                                                                      \
+                                                                            \
+    friend class Internal;                                                  \
+                                                                            \
+    nsISupports*        fOuter;                                             \
+    Internal            fAggregated;                                        \
+                                                                            \
+    nsISupports* GetInner(void) { return &fAggregated; }                    \
+                                                                            \
+public:                                                                     \
+
+
+// Put this in your class's constructor:
+#define NS_INIT_AGGREGATED(outer)                                           \
+  PR_BEGIN_MACRO                                                            \
+    NS_INIT_REFCNT();                                                       \
+    fOuter = outer;                                                         \
+  PR_END_MACRO
+
+
+// Put this in your class's implementation file:
+#define NS_IMPL_AGGREGATED(_class)                                          \
+NS_IMETHODIMP                                                               \
+_class::QueryInterface(const nsIID& aIID, void** aInstancePtr)              \
+{                                                                           \
+    /* try our own interfaces first before delegating to outer */           \
+    nsresult rslt = AggregatedQueryInterface(aIID, aInstancePtr);           \
+    if (rslt != NS_OK && fOuter)                                            \
+        return fOuter->QueryInterface(aIID, aInstancePtr);                  \
+    else                                                                    \
+        return rslt;                                                        \
+}                                                                           \
+                                                                            \
+NS_IMETHODIMP_(nsrefcnt)                                                    \
+_class::AddRef(void)                                                        \
+{                                                                           \
+    ++mRefCnt; /* keep track of our refcount as well as outer's */          \
+    if (fOuter)                                                             \
+        return NS_ADDREF(fOuter);                                           \
+    else                                                                    \
+        return mRefCnt;                                                     \
+}                                                                           \
+                                                                            \
+NS_IMETHODIMP_(nsrefcnt)                                                    \
+_class::Release(void)                                                       \
+{                                                                           \
+    if (fOuter) {                                                           \
+        nsISupports* outer = fOuter;    /* in case we release ourself */    \
+        nsIOuter* outerIntf;                                                \
+        static NS_DEFINE_IID(kIOuterIID, NS_IOUTER_IID);                    \
+        if (mRefCnt == 1 &&                                                 \
+            outer->QueryInterface(kIOuterIID,                               \
+                                  (void**)&outerIntf) == NS_OK) {           \
+            outerIntf->ReleaseInner(GetInner());                            \
+            outerIntf->Release();                                           \
+        }                                                                   \
+        else                                                                \
+            --mRefCnt; /* keep track of our refcount as well as outer's */  \
+        return outer->Release();                                            \
+    }                                                                       \
+    else {                                                                  \
+        if (--mRefCnt == 0) {                                               \
+            delete this;                                                    \
+            return 0;                                                       \
+        }                                                                   \
+        return mRefCnt;                                                     \
+    }                                                                       \
+}                                                                           \
+                                                                            \
+NS_IMETHODIMP                                                               \
+_class::Internal::QueryInterface(const nsIID& aIID, void** aInstancePtr)    \
+{                                                                           \
+    _class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
+    return agg->AggregatedQueryInterface(aIID, aInstancePtr);               \
+}                                                                           \
+                                                                            \
+NS_IMETHODIMP_(nsrefcnt)                                                    \
+_class::Internal::AddRef(void)                                              \
+{                                                                           \
+    _class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
+    return ++agg->mRefCnt;                                                  \
+}                                                                           \
+                                                                            \
+NS_IMETHODIMP_(nsrefcnt)                                                    \
+_class::Internal::Release(void)                                             \
+{                                                                           \
+    _class* agg = (_class*)((char*)(this) - offsetof(_class, fAggregated)); \
+    if (--agg->mRefCnt == 0) {                                              \
+        delete agg;                                                         \
+        return 0;                                                           \
+    }                                                                       \
+    return agg->mRefCnt;                                                    \
+}                                                                           \
+
+#endif /* nsAgg_h___ */

mozilla/xpcom/base/nsAllocator.cpp

@@ -0,0 +1,129 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+////////////////////////////////////////////////////////////////////////////////
+// Implementation of nsIAllocator using NSPR
+////////////////////////////////////////////////////////////////////////////////
+
+#include "nsAllocator.h"
+
+static NS_DEFINE_IID(kISupportsIID, NS_ISUPPORTS_IID);
+static NS_DEFINE_IID(kIAllocatorIID, NS_IALLOCATOR_IID);
+
+nsAllocator::nsAllocator(nsISupports* outer)
+{
+    NS_INIT_AGGREGATED(outer);
+}
+
+nsAllocator::~nsAllocator(void)
+{
+}
+
+NS_IMPL_AGGREGATED(nsAllocator);
+
+NS_METHOD
+nsAllocator::AggregatedQueryInterface(const nsIID& aIID, void** aInstancePtr) 
+{
+    if (NULL == aInstancePtr) {                                            
+        return NS_ERROR_NULL_POINTER;                                        
+    }                                                                      
+    if (aIID.Equals(kIAllocatorIID) || 
+        aIID.Equals(kISupportsIID)) {
+        *aInstancePtr = (void*) this; 
+        AddRef(); 
+        return NS_OK; 
+    } 
+    return NS_NOINTERFACE;
+}
+
+NS_METHOD
+nsAllocator::Create(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr)
+{
+    if (outer && !aIID.Equals(kISupportsIID))
+        return NS_NOINTERFACE;   // XXX right error?
+    nsAllocator* mm = new nsAllocator(outer);
+    if (mm == NULL)
+        return NS_ERROR_OUT_OF_MEMORY;
+    mm->AddRef();
+    if (aIID.Equals(kISupportsIID))
+        *aInstancePtr = mm->GetInner();
+    else
+        *aInstancePtr = mm;
+    return NS_OK;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+NS_METHOD_(void*)
+nsAllocator::Alloc(PRUint32 size)
+{
+    return PR_Malloc(size);
+}
+
+NS_METHOD_(void*)
+nsAllocator::Realloc(void* ptr, PRUint32 size)
+{
+    return PR_Realloc(ptr, size);
+}
+
+NS_METHOD
+nsAllocator::Free(void* ptr)
+{
+    PR_Free(ptr);
+    return NS_OK;
+}
+
+NS_METHOD
+nsAllocator::HeapMinimize(void)
+{
+#ifdef XP_MAC
+    // This used to live in the memory allocators no Mac, but does no more
+    // Needs to be hooked up in the new world.
+//    CallCacheFlushers(0x7fffffff);
+#endif
+    return NS_OK;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+nsAllocatorFactory::nsAllocatorFactory(void)
+{
+}
+
+nsAllocatorFactory::~nsAllocatorFactory(void)
+{
+}
+
+static NS_DEFINE_IID(kIFactoryIID, NS_IFACTORY_IID);
+NS_IMPL_ISUPPORTS(nsAllocatorFactory, kIFactoryIID);
+
+NS_METHOD
+nsAllocatorFactory::CreateInstance(nsISupports *aOuter,
+                                   REFNSIID aIID,
+                                   void **aResult)
+{
+    return nsAllocator::Create(aOuter, aIID, aResult);
+}
+
+NS_METHOD
+nsAllocatorFactory::LockFactory(PRBool aLock)
+{
+    return NS_OK;       // XXX what?
+}
+
+////////////////////////////////////////////////////////////////////////////////

mozilla/xpcom/base/nsAllocator.h

@@ -0,0 +1,92 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+////////////////////////////////////////////////////////////////////////////////
+// Implementation of nsIAllocator using NSPR
+////////////////////////////////////////////////////////////////////////////////
+
+#ifndef nsAllocator_h__
+#define nsAllocator_h__
+
+#include "nsIAllocator.h"
+#include "prmem.h"
+#include "nsAgg.h"
+#include "nsIFactory.h"
+
+class nsAllocator : public nsIAllocator {
+public:
+    static const nsCID& CID() { static nsCID cid = NS_ALLOCATOR_CID; return cid; }
+
+    /**
+     * Allocates a block of memory of a particular size. 
+     *
+     * @param size - the size of the block to allocate
+     * @result the block of memory
+     */
+    NS_IMETHOD_(void*) Alloc(PRUint32 size);
+
+    /**
+     * Reallocates a block of memory to a new size.
+     *
+     * @param ptr - the block of memory to reallocate
+     * @param size - the new size
+     * @result the rellocated block of memory
+     */
+    NS_IMETHOD_(void*) Realloc(void* ptr, PRUint32 size);
+
+    /**
+     * Frees a block of memory. 
+     *
+     * @param ptr - the block of memory to free
+     */
+    NS_IMETHOD Free(void* ptr);
+
+    /**
+     * Attempts to shrink the heap.
+     */
+    NS_IMETHOD HeapMinimize(void);
+
+    ////////////////////////////////////////////////////////////////////////////
+
+    nsAllocator(nsISupports* outer);
+    virtual ~nsAllocator(void);
+
+    NS_DECL_AGGREGATED
+
+    static NS_METHOD
+    Create(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr);
+};
+
+////////////////////////////////////////////////////////////////////////////////
+
+class nsAllocatorFactory : public nsIFactory {
+public:
+    NS_IMETHOD CreateInstance(nsISupports *aOuter,
+                              REFNSIID aIID,
+                              void **aResult);
+
+    NS_IMETHOD LockFactory(PRBool aLock);
+
+    nsAllocatorFactory(void);
+    ~nsAllocatorFactory(void);
+
+    NS_DECL_ISUPPORTS
+};
+
+////////////////////////////////////////////////////////////////////////////////
+#endif // nsAllocator_h__

mozilla/xpcom/base/nsCOMPtr.cpp

@@ -0,0 +1,54 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsCOMPtr.h"
+
+void
+nsCOMPtr_base::assign_with_AddRef( nsISupports* rawPtr )
+	{
+    if ( rawPtr )
+    	NSCAP_ADDREF(rawPtr);
+    if ( mRawPtr )
+      NSCAP_RELEASE(mRawPtr);
+    mRawPtr = rawPtr;
+	}
+
+void
+nsCOMPtr_base::assign_with_QueryInterface( nsISupports* rawPtr, const nsIID& iid, nsresult* result )
+  {
+    nsresult status = NS_OK;
+    if ( !rawPtr || !NS_SUCCEEDED( status = rawPtr->QueryInterface(iid, NSCAP_REINTERPRET_CAST(void**, &rawPtr)) ) )
+      rawPtr = 0;
+
+    if ( mRawPtr )
+      NSCAP_RELEASE(mRawPtr);
+
+    mRawPtr = rawPtr;
+
+    if ( result )
+      *result = status;
+  }
+
+void**
+nsCOMPtr_base::begin_assignment()
+  {
+    if ( mRawPtr )
+      NSCAP_RELEASE(mRawPtr);
+    mRawPtr = 0;
+    return NSCAP_REINTERPRET_CAST(void**, &mRawPtr);
+  }

mozilla/xpcom/base/nsCOMPtr.h

@@ -0,0 +1,493 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsCOMPtr_h___
+#define nsCOMPtr_h___
+
+
+
+  // Wrapping includes can speed up compiles (see "Large Scale C++ Software Design")
+#ifndef nsDebug_h___
+  #include "nsDebug.h"
+    // for |NS_PRECONDITION|
+#endif
+
+#ifndef nsISupports_h___
+  #include "nsISupports.h"
+    // for |nsresult|, |NS_ADDREF|, et al
+#endif
+
+/*
+	Having problems?
+	
+  See the User Manual at:
+    <http://www.meer.net/ScottCollins/doc/nsCOMPtr.html>, or
+    <http://www.mozilla.org/projects/xpcom/nsCOMPtr.html>
+*/
+
+
+
+
+/*
+  TO DO...
+  
+  	+ make StartAssignment optionally inlined
+    + make constructor for |nsQueryInterface| explicit (suddenly construct/assign from raw pointer becomes illegal)
+    + Improve internal documentation
+      + mention *&
+      + alternatives for comparison
+      + do_QueryInterface
+*/
+
+/*
+  WARNING:
+    This file defines several macros for internal use only.  These macros begin with the
+    prefix |NSCAP_|.  Do not use these macros in your own code.  They are for internal use
+    only for cross-platform compatibility, and are subject to change without notice.
+*/
+
+
+  /*
+    Set up some |#define|s to turn off a couple of troublesome C++ features.
+    Interestingly, none of the compilers barf on template stuff.  These are set up automatically
+    by the autoconf system for all Unixes.  (Temporarily, I hope) I have to define them
+    myself for Mac and Windows.
+  */
+
+	// under Metrowerks (Mac), we don't have autoconf yet
+#ifdef __MWERKS__
+	#define HAVE_CPP_USING
+	#define HAVE_CPP_EXPLICIT
+	#define HAVE_CPP_NEW_CASTS
+#endif
+
+	// under VC++ (Windows), we don't have autoconf yet
+#ifdef _MSC_VER
+	#define HAVE_CPP_EXPLICIT
+	#define HAVE_CPP_USING
+	#define HAVE_CPP_NEW_CASTS
+
+  #if (_MSC_VER<1100)
+		  // before 5.0, VC++ couldn't handle explicit
+    #undef HAVE_CPP_EXPLICIT
+  #elif (_MSC_VER==1100)
+      // VC++5.0 has an internal compiler error (sometimes) without this
+    #undef HAVE_CPP_USING
+  #endif
+
+	#define NSCAP_FEATURE_INLINE_STARTASSIGNMENT
+		// under VC++, we win by inlining StartAssignment
+#endif
+
+
+	/*
+		If the compiler doesn't support |explicit|, we'll just make it go away, trusting
+		that the builds under compilers that do have it will keep us on the straight and narrow.
+	*/
+#ifndef HAVE_CPP_EXPLICIT
+  #define explicit
+#endif
+
+#ifdef HAVE_CPP_NEW_CASTS
+	#define NSCAP_REINTERPRET_CAST(T,x)	reinterpret_cast<T>(x)
+#else
+	#define NSCAP_REINTERPRET_CAST(T,x) ((T)(x))
+#endif
+
+#ifdef NSCAP_FEATURE_DEBUG_MACROS
+  #define NSCAP_ADDREF(ptr)    NS_ADDREF(ptr)
+  #define NSCAP_RELEASE(ptr)   NS_RELEASE(ptr)
+#else
+  #define NSCAP_ADDREF(ptr)    (ptr)->AddRef()
+  #define NSCAP_RELEASE(ptr)   (ptr)->Release()
+#endif
+
+  /*
+    WARNING:
+      VC++4.2 is very picky.  To compile under VC++4.2, the classes must be defined
+      in an order that satisfies:
+    
+        nsDerivedSafe < nsCOMPtr
+        nsDontAddRef < nsCOMPtr
+        nsCOMPtr < nsGetterAddRefs
+
+      The other compilers probably won't complain, so please don't reorder these
+      classes, on pain of breaking 4.2 compatibility.
+  */
+
+
+template <class T>
+class nsDerivedSafe : public T
+    /*
+      No client should ever see or have to type the name of this class.  It is the
+      artifact that makes it a compile-time error to call |AddRef| and |Release|
+      on a |nsCOMPtr|.
+
+      See |nsCOMPtr::operator->|, |nsCOMPtr::operator*|, et al.
+    */
+  {
+    private:
+#ifdef HAVE_CPP_USING
+      using T::AddRef;
+      using T::Release;
+#else
+      NS_IMETHOD_(nsrefcnt) AddRef(void);
+      NS_IMETHOD_(nsrefcnt) Release(void);
+#endif
+
+      void operator delete( void*, size_t );                  // NOT TO BE IMPLEMENTED
+        // declaring |operator delete| private makes calling delete on an interface pointer a compile error
+
+      nsDerivedSafe<T>& operator=( const nsDerivedSafe<T>& ); // NOT TO BE IMPLEMENTED
+        // you may not call |operator=()| through a dereferenced |nsCOMPtr|, because you'd get the wrong one
+  };
+
+#if !defined(HAVE_CPP_USING) && defined(NEED_CPP_UNUSED_IMPLEMENTATIONS)
+template <class T>
+nsrefcnt
+nsDerivedSafe<T>::AddRef()
+  {
+    return 0;
+  }
+
+template <class T>
+nsrefcnt
+nsDerivedSafe<T>::Release()
+  {
+    return 0;
+  }
+
+#endif
+
+
+
+
+template <class T>
+struct nsDontQueryInterface
+    /*
+      ...
+    */
+  {
+    explicit
+    nsDontQueryInterface( T* aRawPtr )
+        : mRawPtr(aRawPtr)
+      {
+        // nothing else to do here
+      }
+
+    T* mRawPtr;
+  };
+
+template <class T>
+inline
+nsDontQueryInterface<T>
+dont_QueryInterface( T* aRawPtr )
+  {
+    return nsDontQueryInterface<T>(aRawPtr);
+  }
+
+
+
+
+struct nsQueryInterface
+  {
+    explicit
+    nsQueryInterface( nsISupports* aRawPtr, nsresult* error = 0 )
+        : mRawPtr(aRawPtr),
+          mErrorPtr(error)
+      {
+        // nothing else to do here
+      }
+
+    nsISupports* mRawPtr;
+    nsresult*    mErrorPtr;
+  };
+
+inline
+nsQueryInterface
+do_QueryInterface( nsISupports* aRawPtr, nsresult* error = 0 )
+  {
+    return nsQueryInterface(aRawPtr, error);
+  }
+
+
+
+
+template <class T>
+struct nsDontAddRef
+    /*
+      ...cooperates with |nsCOMPtr| to allow you to assign in a pointer _without_
+      |AddRef|ing it.  You would rarely use this directly, but rather through the
+      machinery of |getter_AddRefs| in the argument list to functions that |AddRef|
+      their results before returning them to the caller.
+
+      See also |getter_AddRefs()| and |class nsGetterAddRefs|.
+    */
+  {
+    explicit
+    nsDontAddRef( T* aRawPtr )
+        : mRawPtr(aRawPtr)
+      {
+        // nothing else to do here
+      }
+
+    T* mRawPtr;
+  };
+
+	// This call is now deprecated.  Use |getter_AddRefs()| instead.
+template <class T>
+inline
+nsDontAddRef<T>
+dont_AddRef( T* aRawPtr )
+    /*
+      ...makes typing easier, because it deduces the template type, e.g., 
+      you write |dont_AddRef(fooP)| instead of |nsDontAddRef<IFoo>(fooP)|.
+    */
+  {
+    return nsDontAddRef<T>(aRawPtr);
+  }
+
+template <class T>
+inline
+nsDontAddRef<T>
+getter_AddRefs( T* aRawPtr )
+	{
+		return nsDontAddRef<T>(aRawPtr);
+	}
+
+
+
+class nsCOMPtr_base
+  {
+    public:
+
+      nsCOMPtr_base( nsISupports* rawPtr = 0 )
+          : mRawPtr(rawPtr)
+        {
+          // nothing else to do here
+        }
+
+     ~nsCOMPtr_base()
+        {
+          if ( mRawPtr )
+            NSCAP_RELEASE(mRawPtr);
+        }
+
+      NS_EXPORT void    assign_with_AddRef( nsISupports* );
+      NS_EXPORT void    assign_with_QueryInterface( nsISupports*, const nsIID&, nsresult* );
+      NS_EXPORT void**  begin_assignment();
+
+    protected:
+      nsISupports* mRawPtr;
+  };
+
+
+
+template <class T>
+class nsCOMPtr : private nsCOMPtr_base
+    /*
+      ...
+    */
+  {
+    public:
+      typedef T element_type;
+
+      nsCOMPtr()
+          // : nsCOMPtr_base(0)
+        {
+          // nothing else to do here
+        }
+
+      nsCOMPtr( const nsQueryInterface& aSmartPtr )
+          // : nsCOMPtr_base(0)
+        {
+          assign_with_QueryInterface(aSmartPtr.mRawPtr, T::GetIID(), aSmartPtr.mErrorPtr);
+        }
+
+      nsCOMPtr( const nsDontAddRef<T>& aSmartPtr )
+          : nsCOMPtr_base(aSmartPtr.mRawPtr)
+        {
+          // nothing else to do here
+        }
+
+      nsCOMPtr( const nsDontQueryInterface<T>& aSmartPtr )
+          : nsCOMPtr_base(aSmartPtr.mRawPtr)
+        {
+          if ( mRawPtr )
+            NSCAP_ADDREF(mRawPtr);
+        }
+
+      nsCOMPtr( const nsCOMPtr<T>& aSmartPtr )
+          : nsCOMPtr_base(aSmartPtr.mRawPtr)
+        {
+          if ( mRawPtr )
+            NSCAP_ADDREF(mRawPtr);
+        }
+
+      nsCOMPtr<T>&
+      operator=( const nsQueryInterface& rhs )
+        {
+          assign_with_QueryInterface(rhs.mRawPtr, T::GetIID(), rhs.mErrorPtr);
+          return *this;
+        }
+
+      nsCOMPtr<T>&
+      operator=( const nsDontAddRef<T>& rhs )
+        {
+          if ( mRawPtr )
+            NSCAP_RELEASE(mRawPtr);
+          mRawPtr = rhs.mRawPtr;
+          return *this;
+        }
+
+      nsCOMPtr<T>&
+      operator=( const nsDontQueryInterface<T>& rhs )
+        {
+          assign_with_AddRef(rhs.mRawPtr);
+          return *this;
+        }
+
+      nsCOMPtr<T>&
+      operator=( const nsCOMPtr<T>& rhs )
+        {
+          assign_with_AddRef(rhs.mRawPtr);
+          return *this;
+        }
+
+      nsDerivedSafe<T>*
+      get() const
+          // returns a |nsDerivedSafe<T>*| to deny clients the use of |AddRef| and |Release|
+        {
+          return NSCAP_REINTERPRET_CAST(nsDerivedSafe<T>*, mRawPtr);
+        }
+
+      nsDerivedSafe<T>*
+      operator->() const
+          // returns a |nsDerivedSafe<T>*| to deny clients the use of |AddRef| and |Release|
+        {
+          NS_PRECONDITION(mRawPtr != 0, "You can't dereference a NULL nsCOMPtr with operator->().");
+          return get();
+        }
+
+      nsDerivedSafe<T>&
+      operator*() const
+          // returns a |nsDerivedSafe<T>*| to deny clients the use of |AddRef| and |Release|
+        {
+          NS_PRECONDITION(mRawPtr != 0, "You can't dereference a NULL nsCOMPtr with operator*().");
+          return *get();
+        }
+
+      operator nsDerivedSafe<T>*() const
+        {
+          return get();
+        }
+
+#if 0
+    private:
+      friend class nsGetterAddRefs<T>;
+
+      /*
+        In a perfect world, the following member function, |StartAssignment|, would be private.
+        It is and should be only accessed by the closely related class |nsGetterAddRefs<T>|.
+
+        Unfortunately, some compilers---most notably VC++5.0---fail to grok the
+        friend declaration above or in any alternate acceptable form.  So, physically
+        it will be public (until our compilers get smarter); but it is not to be
+        considered part of the logical public interface.
+      */
+#endif
+
+      T**
+      StartAssignment()
+        {
+#ifndef NSCAP_FEATURE_INLINE_STARTASSIGNMENT
+          return NSCAP_REINTERPRET_CAST(T**, begin_assignment());
+#else
+					if ( mRawPtr )
+					  NSCAP_RELEASE(mRawPtr);
+					mRawPtr = 0;
+					return NSCAP_REINTERPRET_CAST(T**, &mRawPtr);
+#endif
+        }
+  };
+
+
+template <class T>
+class nsGetterAddRefs
+    /*
+      ...
+
+      This class is designed to be used for anonymous temporary objects in the
+      argument list of calls that return COM interface pointers, e.g.,
+
+        nsCOMPtr<IFoo> fooP;
+        ...->QueryInterface(iid, nsGetterAddRefs<IFoo>(fooP))
+        ...->QueryInterface(iid, getter_AddRefs(fooP))
+
+      When initialized with a |nsCOMPtr|, as in the example above, it returns
+      a |void**| (or |T**| if needed) that the outer call (|QueryInterface| in this
+      case) can fill in.
+    */
+  {
+    public:
+      explicit
+      nsGetterAddRefs( nsCOMPtr<T>& aSmartPtr )
+          : mTargetSmartPtr(aSmartPtr)
+        {
+          // nothing else to do
+        }
+
+      operator void**()
+        {
+          // NS_PRECONDITION(mTargetSmartPtr != 0, "getter_AddRefs into no destination");
+          return NSCAP_REINTERPRET_CAST(void**, mTargetSmartPtr.StartAssignment());
+        }
+
+      T*&
+      operator*()
+        {
+          // NS_PRECONDITION(mTargetSmartPtr != 0, "getter_AddRefs into no destination");
+          return *(mTargetSmartPtr.StartAssignment());
+        }
+
+      operator T**()
+        {
+          // NS_PRECONDITION(mTargetSmartPtr != 0, "getter_AddRefs into no destination");
+          return mTargetSmartPtr.StartAssignment();
+        }
+
+    private:
+      nsCOMPtr<T>& mTargetSmartPtr;
+  };
+
+template <class T>
+inline
+nsGetterAddRefs<T>
+getter_AddRefs( nsCOMPtr<T>& aSmartPtr )
+    /*
+      Used around a |nsCOMPtr| when 
+      ...makes the class |nsGetterAddRefs<T>| invisible.
+    */
+  {
+    return nsGetterAddRefs<T>(aSmartPtr);
+  }
+
+
+
+
+#endif // !defined(nsCOMPtr_h___)

mozilla/xpcom/base/nsCom.h

@@ -0,0 +1,227 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsCom_h__
+#define nsCom_h__
+
+/*
+ * API Import/Export macros
+ */
+
+#ifdef _IMPL_NS_COM
+#ifdef XP_PC
+#define NS_COM _declspec(dllexport)
+#else  /* !XP_PC */
+#define NS_COM
+#endif /* !XP_PC */
+#else  /* !_IMPL_NS_COM */
+#ifdef XP_PC
+#define NS_COM _declspec(dllimport)
+#else  /* !XP_PC */
+#define NS_COM
+#endif /* !XP_PC */
+#endif /* !_IMPL_NS_COM */
+
+/*
+ * DLL Export macro
+ */
+
+#if defined(XP_PC)
+
+#define NS_EXPORT _declspec(dllexport)
+#define NS_EXPORT_(type) _declspec(dllexport) type __stdcall
+
+#define NS_IMETHOD_(type) virtual type __stdcall
+#define NS_IMETHOD virtual nsresult __stdcall
+#define NS_IMETHODIMP_(type) type __stdcall
+#define NS_IMETHODIMP nsresult __stdcall
+
+#define NS_METHOD_(type) type __stdcall
+#define NS_METHOD nsresult __stdcall
+
+#define NS_CALLBACK_(_type, _name) _type (__stdcall * _name)
+#define NS_CALLBACK(_name) nsresult (__stdcall * _name)
+
+#elif defined(XP_MAC)
+
+#define NS_EXPORT __declspec(export)
+#define NS_EXPORT_(type) __declspec(export) type
+
+#define NS_IMETHOD_(type) virtual type
+#define NS_IMETHOD virtual nsresult
+#define NS_IMETHODIMP_(type) type
+#define NS_IMETHODIMP nsresult
+
+#define NS_METHOD_(type) type
+#define NS_METHOD nsresult
+
+#define NS_CALLBACK_(_type, _name) _type (* _name)
+#define NS_CALLBACK(_name) nsresult (* _name)
+
+#else  /* !XP_PC && !XP_MAC */
+
+#define NS_EXPORT
+#define NS_EXPORT_(type) type
+
+#define NS_IMETHOD_(type) virtual type
+#define NS_IMETHOD virtual nsresult
+#define NS_IMETHODIMP_(type) type
+#define NS_IMETHODIMP nsresult
+
+#define NS_METHOD_(type) type
+#define NS_METHOD nsresult
+
+#define NS_CALLBACK_(_type, _name) _type (* _name)
+#define NS_CALLBACK(_name) nsresult (* _name)
+
+#endif /* !XP_PC */
+
+/* use these functions to associate get/set methods with a
+   C++ member variable
+*/
+
+#define NS_METHOD_GETTER(_method, _type, _member) \
+_method(_type* aResult) \
+{\
+    if (!aResult) return NS_ERROR_NULL_POINTER; \
+    *aResult = _member; \
+    return NS_OK; \
+}
+    
+#define NS_METHOD_SETTER(_method, _type, _member) \
+_method(_type aResult) \
+{ \
+    _member = aResult; \
+    return NS_OK; \
+}
+
+/*
+ * special for strings to get/set char* strings
+ * using PL_strdup and PR_FREEIF
+ */
+#define NS_METHOD_GETTER_STR(_method,_member) \
+_method(char* *aString)\
+{\
+    if (!aString) return NS_ERROR_NULL_POINTER; \
+    *aString = PL_strdup(_member); \
+    return NS_OK; \
+}
+
+#define NS_METHOD_SETTER_STR(_method, _member) \
+_method(char *aString)\
+{\
+    PR_FREEIF(_member);\
+    if (aString) _member = PL_strdup(aString); \
+    else _member = nsnull;\
+    return NS_OK; \
+}
+
+/* Getter/Setter macros.
+   Usage:
+   NS_IMPL_[CLASS_]GETTER[_<type>](method, [type,] member);
+   NS_IMPL_[CLASS_]SETTER[_<type>](method, [type,] member);
+   NS_IMPL_[CLASS_]GETSET[_<type>]([class, ]postfix, [type,] member);
+   
+   where:
+   CLASS_  - implementation is inside a class definition
+             (otherwise the class name is needed)
+             Do NOT use in publicly exported header files, because
+             the implementation may be included many times over.
+             Instead, use the non-CLASS_ version.
+   _<type> - For more complex (STR, IFACE) data types
+             (otherwise the simple data type is needed)
+   method  - name of the method, such as GetWidth or SetColor
+   type    - simple data type if required
+   member  - class member variable such as m_width or mColor
+   class   - the class name, such as Window or MyObject
+   postfix - Method part after Get/Set such as "Width" for "GetWidth"
+   
+   Example:
+   class Window {
+   public:
+     NS_IMPL_CLASS_GETSET(Width, int, m_width);
+     NS_IMPL_CLASS_GETTER_STR(GetColor, m_color);
+     NS_IMETHOD SetColor(char *color);
+     
+   private:
+     int m_width;     // read/write
+     char *m_color;   // readonly
+   };
+
+   // defined outside of class
+   NS_IMPL_SETTER_STR(Window::GetColor, m_color);
+
+   Questions/Comments to alecf@netscape.com
+*/
+
+   
+/*
+ * Getter/Setter implementation within a class definition
+ */
+
+/* simple data types */
+#define NS_IMPL_CLASS_GETTER(_method, _type, _member) \
+NS_IMETHOD NS_METHOD_GETTER(_method, _type, _member)
+
+#define NS_IMPL_CLASS_SETTER(_method, _type, _member) \
+NS_IMETHOD NS_METHOD_SETTER(_method, _type, _member)
+
+#define NS_IMPL_CLASS_GETSET(_postfix, _type, _member) \
+NS_IMPL_CLASS_GETTER(Get##_postfix, _type, _member) \
+NS_IMPL_CLASS_SETTER(Set##_postfix, _type, _member)
+
+/* strings */
+#define NS_IMPL_CLASS_GETTER_STR(_method, _member) \
+NS_IMETHOD NS_METHOD_GETTER_STR(_method, _member)
+
+#define NS_IMPL_CLASS_SETTER_STR(_method, _member) \
+NS_IMETHOD NS_METHOD_SETTER_STR(_method, _member)
+
+#define NS_IMPL_CLASS_GETSET_STR(_postfix, _member) \
+NS_IMPL_CLASS_GETTER_STR(Get##_postfix, _member) \
+NS_IMPL_CLASS_SETTER_STR(Set##_postfix, _member)
+
+/* Getter/Setter implementation outside of a class definition */
+
+/* simple data types */
+#define NS_IMPL_GETTER(_method, _type, _member) \
+NS_IMETHODIMP NS_METHOD_GETTER(_method, _type, _member)
+
+#define NS_IMPL_SETTER(_method, _type, _member) \
+NS_IMETHODIMP NS_METHOD_SETTER(_method, _type, _member)
+
+#define NS_IMPL_GETSET(_class, _postfix, _type, _member) \
+NS_IMPL_GETTER(_class::Get##_postfix, _type, _member) \
+NS_IMPL_SETTER(_class::Set##_postfix, _type, _member)
+
+/* strings */
+#define NS_IMPL_GETTER_STR(_method, _member) \
+NS_IMETHODIMP NS_METHOD_GETTER_STR(_method, _member)
+
+#define NS_IMPL_SETTER_STR(_method, _member) \
+NS_IMETHODIMP NS_METHOD_SETTER_STR(_method, _member)
+
+#define NS_IMPL_GETSET_STR(_class, _postfix, _member) \
+NS_IMPL_GETTER_STR(_class::Get##_postfix, _member) \
+NS_IMPL_SETTER_STR(_class::Set##_postfix, _member)
+
+
+
+#endif
+
+

mozilla/xpcom/base/nsDebug.cpp

@@ -0,0 +1,178 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsDebug.h"
+#include "prlog.h"
+#include "prinit.h"
+
+#if defined(XP_UNIX)
+/* for abort() */
+#include <stdlib.h>
+#endif
+
+#if defined(_WIN32)
+#include <windows.h>
+#elif defined(XP_MAC)
+   #define TEMP_MAC_HACK
+   
+   //------------------------
+   #ifdef TEMP_MAC_HACK
+	   #include <MacTypes.h>
+	   #include <Processes.h>
+
+	   // TEMPORARY UNTIL WE HAVE MACINTOSH ENVIRONMENT VARIABLES THAT CAN TURN ON
+	   // LOGGING ON MACINTOSH
+	   // At this moment, NSPR's logging is a no-op on Macintosh.
+
+	   #include <stdarg.h>
+	   #include <stdio.h>
+	 
+	   #undef PR_LOG
+	   #define PR_LOG(module,level,args) dprintf args
+	   static void dprintf(const char *format, ...)
+	   {
+	      va_list ap;
+	      Str255 buffer;
+	      
+	      va_start(ap, format);
+	      buffer[0] = vsnprintf((char *)buffer + 1, sizeof(buffer) - 1, format, ap);
+	      va_end(ap);
+	      
+	      DebugStr(buffer);
+	   }
+   #endif // TEMP_MAC_HACK
+   //------------------------
+#elif defined(XP_UNIX)
+#include<stdlib.h>
+#endif
+
+
+/**
+ * Implementation of the nsDebug methods. Note that this code is
+ * always compiled in, in case some other module that uses it is
+ * compiled with debugging even if this library is not.
+ */
+
+static PRLogModuleInfo* gDebugLog;
+
+static void InitLog(void)
+{
+  if (0 == gDebugLog) {
+    gDebugLog = PR_NewLogModule("nsDebug");
+    gDebugLog->level = PR_LOG_DEBUG;
+  }
+}
+
+NS_COM void nsDebug::Abort(const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("Abort: at file %s, line %d", aFile, aLine));
+  PR_LogFlush();
+#if defined(_WIN32)
+  long* __p = (long*) 0x7;
+  *__p = 0x7;
+#elif defined(XP_MAC)
+  ExitToShell();
+#elif defined(XP_UNIX)
+  PR_Abort();
+#endif
+}
+
+NS_COM void nsDebug::Break(const char* aFile, PRIntn aLine)
+{
+#ifndef TEMP_MAC_HACK
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("Break: at file %s, line %d", aFile, aLine));
+  PR_LogFlush();
+  //XXX this works on win32 only for now. For all the other platforms call Abort
+#if defined(_WIN32)
+  ::DebugBreak();
+#else
+  Abort(aFile, aLine);
+#endif
+#endif // TEMP_MAC_HACK
+}
+
+NS_COM void nsDebug::PreCondition(const char* aStr, const char* aExpr,
+                                  const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("PreCondition: \"%s\" (%s) at file %s, line %d", aStr, aExpr,
+          aFile, aLine));
+  Break(aFile, aLine);
+}
+
+NS_COM void nsDebug::PostCondition(const char* aStr, const char* aExpr,
+                                   const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("PostCondition: \"%s\" (%s) at file %s, line %d", aStr, aExpr,
+          aFile, aLine));
+  Break(aFile, aLine);
+}
+
+NS_COM void nsDebug::Assertion(const char* aStr, const char* aExpr,
+                               const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("Assertion: \"%s\" (%s) at file %s, line %d", aStr, aExpr,
+          aFile, aLine));
+  Break(aFile, aLine);
+}
+
+NS_COM void nsDebug::NotYetImplemented(const char* aMessage,
+                                       const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("NotYetImplemented: \"%s\" at file %s, line %d", aMessage,
+          aFile, aLine));
+  Break(aFile, aLine);
+}
+
+NS_COM void nsDebug::NotReached(const char* aMessage,
+                                const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("NotReached: \"%s\" at file %s, line %d", aMessage, aFile, aLine));
+  Break(aFile, aLine);
+}
+
+NS_COM void nsDebug::Error(const char* aMessage,
+                           const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("Error: \"%s\" at file %s, line %d", aMessage, aFile, aLine));
+  Break(aFile, aLine);
+}
+
+NS_COM void nsDebug::Warning(const char* aMessage,
+                             const char* aFile, PRIntn aLine)
+{
+  InitLog();
+  PR_LOG(gDebugLog, PR_LOG_ERROR,
+         ("Warning: \"%s\" at file %s, line %d", aMessage, aFile, aLine));
+  PR_LogFlush();
+}

mozilla/xpcom/base/nsDebug.h

@@ -0,0 +1,179 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsDebug_h___
+#define nsDebug_h___
+
+#include "nsCom.h"
+#include "prtypes.h"
+
+#ifdef DEBUG
+#define NS_DEBUG
+#endif
+
+/**
+ * Namespace for debugging methods. Note that your code must use the
+ * macros defined later in this file so that the debug code can be
+ * conditionally compiled out.
+ */
+class nsDebug {
+public:
+  // XXX add in log controls here
+  // XXX probably want printf type arguments
+
+  /**
+   * Abort the executing program. This works on all architectures.
+   */
+  static NS_COM void Abort(const char* aFile, PRIntn aLine);
+
+  /**
+   * Break the executing program into the debugger. 
+   */
+  static NS_COM void Break(const char* aFile, PRIntn aLine);
+
+  /**
+   * Log a pre-condition message to the debug log
+   */
+  static NS_COM void PreCondition(const char* aStr, const char* aExpr,
+                                  const char* aFile, PRIntn aLine);
+
+  /**
+   * Log a post-condition message to the debug log
+   */
+  static NS_COM void PostCondition(const char* aStr, const char* aExpr,
+                                   const char* aFile, PRIntn aLine);
+
+  /**
+   * Log an assertion message to the debug log
+   */
+  static NS_COM void Assertion(const char* aStr, const char* aExpr,
+                               const char* aFile, PRIntn aLine);
+
+  /**
+   * Log a not-yet-implemented message to the debug log
+   */
+  static NS_COM void NotYetImplemented(const char* aMessage,
+                                       const char* aFile, PRIntn aLine);
+
+  /**
+   * Log a not-reached message to the debug log
+   */
+  static NS_COM void NotReached(const char* aMessage,
+                                const char* aFile, PRIntn aLine);
+
+  /**
+   * Log an error message to the debug log. This call returns.
+   */
+  static NS_COM void Error(const char* aMessage,
+                           const char* aFile, PRIntn aLine);
+
+  /**
+   * Log a warning message to the debug log.
+   */
+  static NS_COM void Warning(const char* aMessage,
+                             const char* aFile, PRIntn aLine);
+};
+
+#ifdef NS_DEBUG
+/**
+ * Test a precondition for truth. If the expression is not true then
+ * trigger a program failure.
+ */
+#define NS_PRECONDITION(expr,str) \
+if (!(expr))                      \
+  nsDebug::PreCondition(str, #expr, __FILE__, __LINE__)
+
+/**
+ * Test an assertion for truth. If the expression is not true then
+ * trigger a program failure.
+ */
+#define NS_ASSERTION(expr,str) \
+if (!(expr))                   \
+  nsDebug::Assertion(str, #expr, __FILE__, __LINE__)
+
+/**
+ * Test an assertion for truth. If the expression is not true then
+ * trigger a program failure. The expression will still be
+ * executed in release mode.
+ */
+#define NS_VERIFY(expr,str) \
+if (!(expr))                \
+  nsDebug::Assertion(str, #expr, __FILE__, __LINE__)
+
+/**
+ * Test a post-condition for truth. If the expression is not true then
+ * trigger a program failure.
+ */
+#define NS_POSTCONDITION(expr,str) \
+if (!(expr))                       \
+  nsDebug::PostCondition(str, #expr, __FILE__, __LINE__)
+
+/**
+ * This macros triggers a program failure if executed. It indicates that
+ * an attempt was made to execute some unimplimented functionality.
+ */
+#define NS_NOTYETIMPLEMENTED(str) \
+  nsDebug::NotYetImplemented(str, __FILE__, __LINE__)
+
+/**
+ * This macros triggers a program failure if executed. It indicates that
+ * an attempt was made to execute some unimplimented functionality.
+ */
+#define NS_NOTREACHED(str) \
+  nsDebug::NotReached(str, __FILE__, __LINE__)
+
+/**
+ * Log an error message.
+ */
+#define NS_ERROR(str) \
+  nsDebug::Error(str, __FILE__, __LINE__)
+
+/**
+ * Log a warning message.
+ */
+#define NS_WARNING(str) \
+  nsDebug::Warning(str, __FILE__, __LINE__)
+
+/**
+ * Trigger an abort
+ */
+#define NS_ABORT() \
+  nsDebug::Abort(__FILE__, __LINE__)
+
+/**
+ * Cause a break
+ */
+#define NS_BREAK() \
+  nsDebug::Break(__FILE__, __LINE__)
+
+#else /* NS_DEBUG */
+
+#define NS_PRECONDITION(expr,str)  {}
+#define NS_ASSERTION(expr,str)     {}
+#define NS_VERIFY(expr,str)        expr
+#define NS_POSTCONDITION(expr,str) {}
+#define NS_NOTYETIMPLEMENTED(str)  {}
+#define NS_NOTREACHED(str)         {}
+#define NS_ERROR(str)              {}
+#define NS_WARNING(str)            {}
+#define NS_ABORT()                 {}
+#define NS_BREAK()                 {}
+
+#endif /* ! NS_DEBUG */
+
+#endif /* nsDebug_h___ */

mozilla/xpcom/base/nsError.h

@@ -1,23 +1,19 @@
 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /*
- * The contents of this file are subject to the Netscape 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/NPL/
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
  *
- * 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.
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
  *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
+ * The Initial Developer of this code under the NPL is Netscape
  * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
  */
 
 #ifndef nsError_h
@@ -69,11 +65,9 @@ typedef PRUint32 nsresult;
 #define NS_ERROR_MODULE_UCONV      11
 #define NS_ERROR_MODULE_REG        12
 #define NS_ERROR_MODULE_FILES      13
-#define NS_ERROR_MODULE_DOM        14
-#define NS_ERROR_MODULE_IMGLIB     15
+
 #define NS_ERROR_MODULE_MAILNEWS   16
 #define NS_ERROR_MODULE_EDITOR     17
-#define NS_ERROR_MODULE_XPCONNECT  18
 
 /**
  * @name Standard Error Handling Macros
@@ -113,6 +107,12 @@ typedef PRUint32 nsresult;
  * @name Standard Macros for retrieving error bits
  */
 
+#if PR_BYTES_PER_INT == 4
+#define NS_IS_ERROR(err)           (((nsresult)(err))<0)
+#else
+#define NS_IS_ERROR(err)           (((((PRUint32)(err)) >> 31) & 0x1) == NS_ERROR_SEVERITY_ERROR)
+#endif
+
 #define NS_ERROR_GET_CODE(err)     ((err) & 0xffff)
 #define NS_ERROR_GET_MODULE(err)   (((((err) >> 16) - NS_ERROR_MODULE_BASE_OFFSET) & 0x1fff))
 #define NS_ERROR_GET_SEVERITY(err) (((err) >> 31) & 0x1)
@@ -166,15 +166,12 @@ typedef PRUint32 nsresult;
 /* Returned when a class doesn't allow aggregation */
 #define NS_ERROR_NO_AGGREGATION            ((nsresult) 0x80040110L)
 
-/* Returned when an operation can't complete due to an unavailable resource */
+/* Returned when a class doesn't allow aggregation */
 #define NS_ERROR_NOT_AVAILABLE             ((nsresult) 0x80040111L)
 
 /* Returned when a class is not registered */
 #define NS_ERROR_FACTORY_NOT_REGISTERED    ((nsresult) 0x80040154L)
 
-/* Returned when a class cannot be registered, but may be tried again later */
-#define NS_ERROR_FACTORY_REGISTER_AGAIN    ((nsresult) 0x80040155L)
-
 /* Returned when a dynamically loaded factory couldn't be found */
 #define NS_ERROR_FACTORY_NOT_LOADED        ((nsresult) 0x800401f8L)
 
@@ -185,34 +182,6 @@ typedef PRUint32 nsresult;
 /* Returned when a factory already is registered */
 #define NS_ERROR_FACTORY_EXISTS            (NS_ERROR_BASE + 0x100)
 
-
-/* For COM compatibility reasons, we want to use exact error code numbers
-   for NS_ERROR_PROXY_INVALID_IN_PARAMETER and NS_ERROR_PROXY_INVALID_OUT_PARAMETER.
-   The first matches:
-
-     #define RPC_E_INVALID_PARAMETER          _HRESULT_TYPEDEF_(0x80010010L)
-   
-   Errors returning this mean that the xpcom proxy code could not create a proxy for
-   one of the in paramaters.
-
-   Because of this, we are ignoring the convention if using a base and offset for
-   error numbers.
-
-*/
-
-/* Returned when a proxy could not be create a proxy for one of the IN parameters
-   This is returned only when the "real" meathod has NOT been invoked. 
-*/
-
-#define NS_ERROR_PROXY_INVALID_IN_PARAMETER        ((nsresult) 0x80010010L)
-
-/* Returned when a proxy could not be create a proxy for one of the OUT parameters
-   This is returned only when the "real" meathod has ALREADY been invoked. 
-*/
-
-#define NS_ERROR_PROXY_INVALID_OUT_PARAMETER        ((nsresult) 0x80010011L)
-
-
 /*@}*/
 
 ////////////////////////////////////////////////////////////////////////////////

mozilla/xpcom/base/nsIAllocator.h

@@ -0,0 +1,83 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsIAllocator_h___
+#define nsIAllocator_h___
+
+#include "nsISupports.h"
+
+/**
+ * Unlike IMalloc, this interface returns nsresults and doesn't
+ * implement the problematic GetSize and DidAlloc routines.
+ */
+
+#define NS_IALLOCATOR_IID                            \
+{ /* 56def700-b1b9-11d2-8177-006008119d7a */         \
+    0x56def700,                                      \
+    0xb1b9,                                          \
+    0x11d2,                                          \
+    {0x81, 0x77, 0x00, 0x60, 0x08, 0x11, 0x9d, 0x7a} \
+}
+
+class nsIAllocator : public nsISupports {
+public:
+    static const nsIID& GetIID() { static nsIID iid = NS_IALLOCATOR_IID; return iid; }
+    
+    /**
+     * Allocates a block of memory of a particular size. 
+     *
+     * @param size - the size of the block to allocate
+     * @result the block of memory
+     */
+    NS_IMETHOD_(void*) Alloc(PRUint32 size) = 0;
+
+    /**
+     * Reallocates a block of memory to a new size.
+     *
+     * @param ptr - the block of memory to reallocate
+     * @param size - the new size
+     * @result the rellocated block of memory
+     */
+    NS_IMETHOD_(void*) Realloc(void* ptr, PRUint32 size) = 0;
+
+    /**
+     * Frees a block of memory. 
+     *
+     * @param ptr - the block of memory to free
+     */
+    NS_IMETHOD Free(void* ptr) = 0;
+
+    /**
+     * Attempts to shrink the heap.
+     */
+    NS_IMETHOD HeapMinimize(void) = 0;
+
+};
+
+// To get the global memory manager service:
+#define NS_ALLOCATOR_CID                             \
+{ /* aafe6770-b1bb-11d2-8177-006008119d7a */         \
+    0xaafe6770,                                      \
+    0xb1bb,                                          \
+    0x11d2,                                          \
+    {0x81, 0x77, 0x00, 0x60, 0x08, 0x11, 0x9d, 0x7a} \
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+#endif /* nsIAllocator_h___ */

mozilla/xpcom/base/nsID.cpp

@@ -0,0 +1,73 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+#include "nsID.h"
+#include "prprf.h"
+
+static const char gIDFormat[] = 
+  "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}";
+
+static const char gIDFormat2[] = 
+  "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x";
+
+/* 
+ * Turns a {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} string into
+ * an nsID
+ */
+
+NS_COM PRBool nsID::Parse(char *aIDStr)
+{
+  PRInt32 count = 0;
+  PRInt32 n1, n2, n3[8];
+  PRInt32 n0;
+
+  if (NULL != aIDStr) {
+    count = PR_sscanf(aIDStr,
+                      (aIDStr[0] == '{') ? gIDFormat : gIDFormat2,
+                      &n0, &n1, &n2, 
+                      &n3[0],&n3[1],&n3[2],&n3[3],
+                      &n3[4],&n3[5],&n3[6],&n3[7]);
+
+    m0 = (PRInt32) n0;
+    m1 = (PRInt16) n1;
+    m2 = (PRInt16) n2;
+    for (int i = 0; i < 8; i++) {
+      m3[i] = (PRInt8) n3[i];
+    }
+  }
+  return (PRBool) (count == 11);
+}
+
+/*
+ * Returns an allocated string in {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
+ * format. Caller should delete [] the string.
+ */
+
+NS_COM char *nsID::ToString() const 
+{
+  char *res = new char[39];
+
+  if (res != NULL) {
+    PR_snprintf(res, 39, gIDFormat,
+                m0, (PRUint32) m1, (PRUint32) m2,
+                (PRUint32) m3[0], (PRUint32) m3[1], (PRUint32) m3[2],
+                (PRUint32) m3[3], (PRUint32) m3[4], (PRUint32) m3[5],
+                (PRUint32) m3[6], (PRUint32) m3[7]);
+  }
+  return res;
+}
+

mozilla/xpcom/base/nsID.h

@@ -0,0 +1,101 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsID_h__
+#define nsID_h__
+
+#include "prtypes.h"
+#include "string.h"
+#include "nsCom.h"
+
+/**
+ * A "unique identifier". This is modeled after OSF DCE UUIDs.
+ */
+
+struct nsID {
+  /**
+   * @name Indentifier values
+   */
+
+  //@{
+  PRUint32 m0;
+  PRUint16 m1;
+  PRUint16 m2;
+  PRUint8 m3[8];
+  //@}
+
+  /**
+   * @name Methods
+   */
+
+  //@{
+  /**
+   * Equivalency method. Compares this nsID with another.
+   * @return <b>PR_TRUE</b> if they are the same, <b>PR_FALSE</b> if not.
+   */
+
+  inline PRBool Equals(const nsID& other) const {
+    return (PRBool)
+      ((((PRUint32*) &m0)[0] == ((PRUint32*) &other.m0)[0]) &&
+       (((PRUint32*) &m0)[1] == ((PRUint32*) &other.m0)[1]) &&
+       (((PRUint32*) &m0)[2] == ((PRUint32*) &other.m0)[2]) &&
+       (((PRUint32*) &m0)[3] == ((PRUint32*) &other.m0)[3]));
+  }
+
+  /**
+   * nsID Parsing method. Turns a {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
+   * string into an nsID
+   */
+  NS_COM PRBool Parse(char *aIDStr);
+
+  /**
+   * nsID string encoder. Returns an allocated string in 
+   * {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} format. Caller should free string.
+   */
+  NS_COM char* ToString() const;
+  //@}
+};
+
+/**
+ * Declare an ID. If NS_IMPL_IDS is set, a variable <i>_name</i> is declared
+ * with the given values, otherwise <i>_name</i> is declared as an 
+ * <tt>extern</tt> variable.
+ */
+
+#ifdef NS_IMPL_IDS
+#define NS_DECLARE_ID(_name,m0,m1,m2,m30,m31,m32,m33,m34,m35,m36,m37) \
+  extern "C" const nsID _name = {m0,m1,m2,{m30,m31,m32,m33,m34,m35,m36,m37}}
+#else
+#define NS_DECLARE_ID(_name,m0,m1,m2,m30,m31,m32,m33,m34,m35,m36,m37) \
+  extern "C" const nsID _name
+#endif
+
+/*
+ * Class IDs
+ */
+
+typedef nsID nsCID;
+
+// Define an CID
+#define NS_DEFINE_CID(_name, _cidspec) \
+  const nsCID _name = _cidspec
+
+#define REFNSCID const nsCID&
+
+#endif
+

mozilla/xpcom/base/nsIID.h

@@ -0,0 +1,42 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef __nsIID_h
+#define __nsIID_h
+
+/**
+ * An "interface id" which can be used to uniquely identify a given
+ * interface.
+ */
+
+typedef nsID nsIID;
+
+/**
+ * A macro shorthand for <tt>const nsIID&<tt>
+ */
+
+#define REFNSIID const nsIID&
+
+/**
+ * Define an IID (obsolete)
+ */
+ 
+#define NS_DEFINE_IID(_name, _iidspec) \
+  const nsIID _name = _iidspec
+
+#endif /* __nsIID_h */

mozilla/xpcom/base/nsIPtr.h

@@ -0,0 +1,142 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsIPtr_h___
+#define nsIPtr_h___
+
+#include "nsISupports.h"
+
+/*
+ * nsIPtr is an "auto-release pointer" class for nsISupports based interfaces
+ *
+ * It's intent is to be a "set and forget" pointer to help with managing
+ * active references to nsISupports bases objects.
+ * 
+ * The pointer object ensures that the underlying pointer is always 
+ * released whenever the value is changed or when the object leaves scope.
+ *
+ * Proper care needs to be taken when assigning pointers to a nsIPtr. 
+ * When asigning from a C pointer (nsISupports*), the pointer presumes
+ * an active reference and subsumes it. When assigning from another nsIPtr,
+ * a new reference is established.
+ *
+ * There are 3 ways to assign a value to a nsIPtr.
+ * 1) Direct construction or assignment from a C pointer.
+ * 2) Direct construction or assignment form another nsIPtr.
+ * 3) Usage of an "out parameter" method.
+ *    a) AssignRef() releases the underlying pointer and returns a reference to it.
+ *       Useful for pointer reference out paramaters.
+ *    b) AssignPtr() releases the underlying pointer and returns a pointer to it.
+ *    c) Query() releases the underlying pointer and returns a (void**) pointer to it.
+ *       Useful for calls to QueryInterface()
+ * 4) The SetAddRef() method. This is equivalent to an assignment followed by an AddRef().
+ *
+ *    examples:
+ *
+ *    class It {
+ *      void    NS_NewFoo(nsIFoo** aFoo);
+ *      nsIFoo* GetFoo(void);
+ *      void    GetBar(nsIBar*& aBar);
+ *    };
+ *
+ *    nsIFooPtr foo = it->GetFoo();
+ *    nsIBarPtr bar;
+ *
+ *    it->NS_NewFoo(foo.AssignPtr());
+ *    it->GetBar(bar.AssignRef());
+ *    it->QueryInterface(kIFooIID, foo.Query());
+ *    bar.SetAddRef(new Bar());
+ *
+ * Advantages:
+ * Set and forget. Once a pointer is assigned to a nsIPtr, it is impossible
+ * to forget to release it.
+ * Always pre-initialized. You can't forget to initialize the pointer.
+ *
+ * Disadvantages:
+ * Usage of this class doesn't eliminate the need to think about ref counts
+ * and assign values properly, AddRef'ing as needed. 
+ * The nsIPtr doesn't typecast exactly like a C pointer. In order to achieve
+ * typecasting, it may be necessary to first cast to a C pointer of the 
+ * underlying type.
+ *
+ */
+
+#define NS_DEF_PTR(cls)                                                       \
+class cls##Ptr {                                                              \
+public:                                                                       \
+  cls##Ptr(void)  : mPtr(0) {}                                                \
+  cls##Ptr(const cls##Ptr& aCopy) : mPtr(aCopy.mPtr)                          \
+    { NS_IF_ADDREF(mPtr);  }                                                  \
+  cls##Ptr(cls* aInterface)       : mPtr(aInterface)  {}                      \
+  ~cls##Ptr(void)     { NS_IF_RELEASE(mPtr);  }                               \
+  cls##Ptr& operator=(const cls##Ptr& aCopy)                                  \
+    { if(mPtr == aCopy.mPtr) return *this;                                    \
+      NS_IF_ADDREF(aCopy.mPtr);                                               \
+      NS_IF_RELEASE(mPtr);                                                    \
+      mPtr = aCopy.mPtr;  return *this; }                                     \
+  cls##Ptr& operator=(cls* aInterface)                                        \
+    { if(mPtr == aInterface) return *this;                                    \
+      NS_IF_RELEASE(mPtr); mPtr = aInterface;                                 \
+      return *this; }                                                         \
+  cls##Ptr& operator=(PRInt32 aInt)                                           \
+    { NS_IF_RELEASE(mPtr);                                                    \
+      return *this; }                                                         \
+  void  SetAddRef(cls* aInterface)                                            \
+    { if(aInterface == mPtr)  return;                                         \
+      NS_IF_ADDREF(aInterface);                                               \
+      NS_IF_RELEASE(mPtr); mPtr = aInterface;  }                              \
+  cls*  AddRef(void)  { NS_ADDREF(mPtr); return mPtr;  }                      \
+  cls*  IfAddRef(void)                                                        \
+    { NS_IF_ADDREF(mPtr); return mPtr;  }                                     \
+  cls*& AssignRef(void)                                                       \
+    { NS_IF_RELEASE(mPtr);  return mPtr; }                                    \
+  cls** AssignPtr(void)                                                       \
+    { NS_IF_RELEASE(mPtr);  return &mPtr; }                                   \
+  void** Query(void)                                                          \
+    { NS_IF_RELEASE(mPtr);  return (void**)&mPtr; }                           \
+  PRBool  IsNull() const                                                      \
+    { return PRBool(0 == mPtr); }                                             \
+  PRBool  IsNotNull() const                                                   \
+    { return PRBool(0 != mPtr); }                                             \
+  PRBool  operator==(const cls##Ptr& aCopy) const                             \
+    { return PRBool(mPtr == aCopy.mPtr);  }                                   \
+  PRBool  operator==(cls* aInterface) const                                   \
+    { return PRBool(mPtr == aInterface);  }                                   \
+  PRBool  operator!=(const cls##Ptr& aCopy) const                             \
+    { return PRBool(mPtr != aCopy.mPtr);  }                                   \
+  PRBool  operator!=(cls* aInterface) const                                   \
+    { return PRBool(mPtr != aInterface);  }                                   \
+  cls*  operator->(void)  { return mPtr;  }                                   \
+  cls&  operator*(void)   { return *mPtr; }                                   \
+  operator cls*(void)     { return mPtr;  }                                   \
+  const cls*  operator->(void) const  { return mPtr;  }                       \
+  const cls&  operator*(void) const   { return *mPtr; }                       \
+  operator const cls* (void) const    { return mPtr;  }                       \
+private:                                                                      \
+  void* operator new(size_t size) { return 0; }                               \
+  void operator delete(void* aPtr)  {}                                        \
+  cls*  mPtr;                                                                 \
+public:                                                                       \
+friend inline PRBool operator==(const cls* aInterface, const cls##Ptr& aPtr)  \
+{ return PRBool(aInterface == aPtr.mPtr); }                                   \
+friend inline PRBool operator!=(const cls* aInterface, const cls##Ptr& aPtr)  \
+{ return PRBool(aInterface != aPtr.mPtr); }                                   \
+}
+
+#endif // nsIPtr_h___
+

mozilla/xpcom/base/nsISupports.idl

@@ -0,0 +1,46 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+%{C++
+#include "nsDebug.h"
+#include "nsTraceRefcnt.h"
+#include "nsIID.h"
+%}
+#include "nsID.idl"
+%{C++
+#include "nsError.h"
+
+#include "nsISupportsUtils.h"
+%}
+
+native nsQIResult(void *);
+native voidStar(void*);
+native voidStarRef(void**);
+native nsIIDRef(REFNSIID);
+
+typedef unsigned long   nsrefcnt;
+
+[
+ object,
+	uuid(00000000-0000-0000-c000-000000000046)
+]
+interface nsISupports {
+  void QueryInterface(in nsIIDRef uuid, out nsQIResult result);
+  [notxpcom] nsrefcnt AddRef();
+  [notxpcom] nsrefcnt Release();
+};

mozilla/xpcom/base/nsISupportsUtils.h

@@ -0,0 +1,557 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef __nsISupportsUtils_h
+#define __nsISupportsUtils_h
+
+
+/**
+ * A macro to build the static const IID accessor method
+ */
+
+#define NS_DEFINE_STATIC_IID_ACCESSOR(the_iid) \
+  static const nsIID& GetIID() {static nsIID iid = the_iid; return iid;}
+
+/**
+ * A macro to build the static const CID accessor method
+ */
+
+#define NS_DEFINE_STATIC_CID_ACCESSOR(the_cid) \
+  static const nsID& GetCID() {static nsID cid = the_cid; return cid;}
+
+/**
+ * Some convenience macros for implementing AddRef and Release
+ */
+
+/**
+ * Declare the reference count variable and the implementations of the
+ * AddRef and QueryInterface methods.
+ */
+
+#define NS_DECL_ISUPPORTS                                                   \
+public:                                                                     \
+  NS_IMETHOD QueryInterface(REFNSIID aIID,                                  \
+                            void** aInstancePtr);                           \
+  NS_IMETHOD_(nsrefcnt) AddRef(void);                                       \
+  NS_IMETHOD_(nsrefcnt) Release(void);                                      \
+protected:                                                                  \
+  nsrefcnt mRefCnt;                                                         \
+public:
+
+#define NS_DECL_ISUPPORTS_EXPORTED                                          \
+public:                                                                     \
+  NS_EXPORT NS_IMETHOD QueryInterface(REFNSIID aIID,                        \
+                            void** aInstancePtr);                           \
+  NS_EXPORT NS_IMETHOD_(nsrefcnt) AddRef(void);                             \
+  NS_EXPORT NS_IMETHOD_(nsrefcnt) Release(void);                            \
+protected:                                                                  \
+  nsrefcnt mRefCnt;                                                         \
+public:
+
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Initialize the reference count variable. Add this to each and every
+ * constructor you implement.
+ */
+#define NS_INIT_REFCNT() mRefCnt = 0
+#define NS_INIT_ISUPPORTS() NS_INIT_REFCNT() // what it should have been called in the first place
+
+/**
+ * Use this macro to implement the AddRef method for a given <i>_class</i>
+ * @param _class The name of the class implementing the method
+ */
+#define NS_IMPL_ADDREF(_class)                               \
+NS_IMETHODIMP_(nsrefcnt) _class::AddRef(void)                                \
+{                                                            \
+  NS_PRECONDITION(PRInt32(mRefCnt) >= 0, "illegal refcnt");  \
+  return ++mRefCnt;                                          \
+}
+
+/**
+ * Use this macro to implement the Release method for a given <i>_class</i>
+ * @param _class The name of the class implementing the method
+ */
+#define NS_IMPL_RELEASE(_class)                        \
+NS_IMETHODIMP_(nsrefcnt) _class::Release(void)                         \
+{                                                      \
+  NS_PRECONDITION(0 != mRefCnt, "dup release");        \
+  if (--mRefCnt == 0) {                                \
+    NS_DELETEXPCOM(this);                              \
+    return 0;                                          \
+  }                                                    \
+  return mRefCnt;                                      \
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+/*
+ * Some convenience macros for implementing QueryInterface
+ */
+
+/** 
+ * This implements query interface with two assumptions: First, the
+ * class in question implements nsISupports and it's own interface and
+ * nothing else. Second, the implementation of the class's primary
+ * inheritance chain leads to it's own interface.
+ *
+ * @param _class The name of the class implementing the method
+ * @param _classiiddef The name of the #define symbol that defines the IID
+ * for the class (e.g. NS_ISUPPORTS_IID)
+ */
+
+#define NS_IMPL_QUERY_INTERFACE(_class,_classiiddef)                     \
+NS_IMETHODIMP _class::QueryInterface(REFNSIID aIID, void** aInstancePtr)      \
+{                                                                        \
+  if (NULL == aInstancePtr) {                                            \
+    return NS_ERROR_NULL_POINTER;                                        \
+  }                                                                      \
+                                                                         \
+  *aInstancePtr = NULL;                                                  \
+                                                                         \
+  static NS_DEFINE_IID(kISupportsIID, NS_ISUPPORTS_IID);                 \
+  static NS_DEFINE_IID(kClassIID, _classiiddef);                         \
+  if (aIID.Equals(kClassIID)) {                                          \
+    *aInstancePtr = (void*) this;                                        \
+    NS_ADDREF_THIS();                                                    \
+    return NS_OK;                                                        \
+  }                                                                      \
+  if (aIID.Equals(kISupportsIID)) {                                      \
+    *aInstancePtr = (void*) ((nsISupports*)this);                        \
+    NS_ADDREF_THIS();                                                    \
+    return NS_OK;                                                        \
+  }                                                                      \
+  return NS_NOINTERFACE;                                                 \
+}
+
+/**
+ * Convenience macro for implementing all nsISupports methods for
+ * a simple class.
+ * @param _class The name of the class implementing the method
+ * @param _classiiddef The name of the #define symbol that defines the IID
+ * for the class (e.g. NS_ISUPPORTS_IID)
+ */
+
+#define NS_IMPL_ISUPPORTS(_class,_classiiddef) \
+  NS_IMPL_ADDREF(_class)                       \
+  NS_IMPL_RELEASE(_class)                      \
+  NS_IMPL_QUERY_INTERFACE(_class,_classiiddef)
+
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Declare that you're going to inherit from something that already
+ * implements nsISupports, but also implements an additional interface, thus
+ * causing an ambiguity. In this case you don't need another mRefCnt, you 
+ * just need to forward the definitions to the appropriate superclass. E.g.
+ *
+ * class Bar : public Foo, public nsIBar {  // both provide nsISupports
+ * public: 
+ *   NS_DECL_ISUPPORTS_INHERITED
+ *   ...other nsIBar and Bar methods...
+ * };
+ */
+#define NS_DECL_ISUPPORTS_INHERITED                                         \
+public:                                                                     \
+  NS_IMETHOD QueryInterface(REFNSIID aIID,                                  \
+                            void** aInstancePtr);                           \
+  NS_IMETHOD_(nsrefcnt) AddRef(void);                                       \
+  NS_IMETHOD_(nsrefcnt) Release(void);                                      \
+
+/**
+ * These macros can be used in conjunction with NS_DECL_ISUPPORTS_INHERITED
+ * to implement the nsISupports methods, forwarding the invocations to a
+ * superclass that already implements nsISupports. 
+ *
+ * Note that I didn't make these inlined because they're virtual methods.
+ */
+
+#define NS_IMPL_ADDREF_INHERITED(Class, Super)                                \
+NS_IMETHODIMP_(nsrefcnt) Class::AddRef(void)                                                  \
+{                                                                             \
+  return Super::AddRef();                                                     \
+}                                                                             \
+
+#define NS_IMPL_RELEASE_INHERITED(Class, Super)                               \
+NS_IMETHODIMP_(nsrefcnt) Class::Release(void)                                                 \
+{                                                                             \
+  return Super::Release();                                                    \
+}                                                                             \
+
+#define NS_IMPL_QUERY_INTERFACE_INHERITED(Class, Super, AdditionalInterface)  \
+NS_IMETHODIMP Class::QueryInterface(REFNSIID aIID, void** aInstancePtr)            \
+{                                                                             \
+  if (!aInstancePtr) return NS_ERROR_NULL_POINTER;                            \
+  if (aIID.Equals(AdditionalInterface::GetIID())) {                           \
+    *aInstancePtr = NS_STATIC_CAST(AdditionalInterface*, this);               \
+    NS_ADDREF_THIS();                                                         \
+    return NS_OK;                                                             \
+  }                                                                           \
+  return Super::QueryInterface(aIID, aInstancePtr);                           \
+}                                                                             \
+
+#define NS_IMPL_ISUPPORTS_INHERITED(Class, Super, AdditionalInterface)        \
+    NS_IMPL_QUERY_INTERFACE_INHERITED(Class, Super, AdditionalInterface)      \
+    NS_IMPL_ADDREF_INHERITED(Class, Super)                                    \
+    NS_IMPL_RELEASE_INHERITED(Class, Super)                                   \
+
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ *
+ * Threadsafe implementations of the ISupports convenience macros
+ *
+ */
+
+/**
+ * IID for the nsIsThreadsafe interface
+ * {88210890-47a6-11d2-bec3-00805f8a66dc}
+ *
+ * This interface is *only* used for debugging purposes to determine if
+ * a given component is threadsafe.
+ */
+#define NS_ISTHREADSAFE_IID      \
+{ 0x88210890, 0x47a6, 0x11d2,    \
+  {0xbe, 0xc3, 0x00, 0x80, 0x5f, 0x8a, 0x66, 0xdc} }
+
+#if defined(NS_MT_SUPPORTED)
+
+#define NS_LOCK_INSTANCE()                                                  \
+  PR_CEnterMonitor((void*)this)
+
+#define NS_UNLOCK_INSTANCE()                                                \
+  PR_CExitMonitor((void*)this)
+
+/**
+ * Use this macro to implement the AddRef method for a given <i>_class</i>
+ * @param _class The name of the class implementing the method
+ */
+#if defined(XP_PC)
+#define NS_IMPL_THREADSAFE_ADDREF(_class)                                   \
+NS_IMETHODIMP_(nsrefcnt) _class::AddRef(void)                                               \
+{                                                                           \
+  NS_PRECONDITION(PRInt32(mRefCnt) >= 0, "illegal refcnt");                 \
+  return InterlockedIncrement((LONG*)&mRefCnt);                             \
+}
+
+#else /* ! XP_PC */
+#define NS_IMPL_THREADSAFE_ADDREF(_class)                                   \
+nsrefcnt _class::AddRef(void)                                               \
+{                                                                           \
+  nsrefcnt count;                                                           \
+  NS_LOCK_INSTANCE();                                                       \
+  NS_PRECONDITION(PRInt32(mRefCnt) >= 0, "illegal refcnt");                 \
+  count = ++mRefCnt;                                                        \
+  NS_UNLOCK_INSTANCE();                                                     \
+  return count;                                                             \
+}
+#endif /* ! XP_PC */
+
+/**
+ * Use this macro to implement the Release method for a given <i>_class</i>
+ * @param _class The name of the class implementing the method
+ */
+#if defined(XP_PC)
+#define NS_IMPL_THREADSAFE_RELEASE(_class)             \
+NS_IMETHODIMP_(nsrefcnt) _class::Release(void)                         \
+{                                                      \
+  NS_PRECONDITION(0 != mRefCnt, "dup release");        \
+  if (0 == InterlockedDecrement((LONG*)&mRefCnt)) {    \
+    NS_DELETEXPCOM(this);                              \
+    return 0;                                          \
+  }                                                    \
+  return mRefCnt; /* Not threadsafe but who cares. */  \
+}
+
+#else /* ! XP_PC */
+#define NS_IMPL_THREADSAFE_RELEASE(_class)             \
+nsrefcnt _class::Release(void)                         \
+{                                                      \
+  nsrefcnt count;                                      \
+  NS_PRECONDITION(0 != mRefCnt, "dup release");        \
+  NS_LOCK_INSTANCE();                                  \
+  count = --mRefCnt;                                   \
+  NS_UNLOCK_INSTANCE();                                \
+  if (0 == count) {                                    \
+    NS_DELETEXPCOM(this);                              \
+    return 0;                                          \
+  }                                                    \
+  return count;                                        \
+}
+#endif /* ! XP_PC */
+
+////////////////////////////////////////////////////////////////////////////////
+
+/*
+ * Some convenience macros for implementing QueryInterface
+ */
+
+/** 
+ * This implements query interface with two assumptions: First, the
+ * class in question implements nsISupports and it's own interface and
+ * nothing else. Second, the implementation of the class's primary
+ * inheritance chain leads to it's own interface.
+ *
+ * @param _class The name of the class implementing the method
+ * @param _classiiddef The name of the #define symbol that defines the IID
+ * for the class (e.g. NS_ISUPPORTS_IID)
+ */
+#if defined(NS_DEBUG)
+#define NS_VERIFY_THREADSAFE_INTERFACE(_iface)                              \
+ if (NULL != (_iface)) {                                                    \
+   nsISupports* tmp;                                                        \
+   static NS_DEFINE_IID(kIsThreadsafeIID, NS_ISTHREADSAFE_IID);             \
+   NS_PRECONDITION((NS_OK == _iface->QueryInterface(kIsThreadsafeIID,       \
+                                                    (void**)&tmp)),         \
+                   "Interface is not threadsafe");                          \
+ }
+
+#define NS_IMPL_THREADSAFE_QUERY_INTERFACE(_class,_classiiddef)          \
+NS_IMETHODIMP _class::QueryInterface(REFNSIID aIID, void** aInstancePtr)      \
+{                                                                        \
+  if (NULL == aInstancePtr) {                                            \
+    return NS_ERROR_NULL_POINTER;                                        \
+  }                                                                      \
+                                                                         \
+  *aInstancePtr = NULL;                                                  \
+                                                                         \
+  static NS_DEFINE_IID(kISupportsIID, NS_ISUPPORTS_IID);                 \
+  static NS_DEFINE_IID(kIsThreadsafeIID, NS_ISTHREADSAFE_IID);           \
+  static NS_DEFINE_IID(kClassIID, _classiiddef);                         \
+  if (aIID.Equals(kClassIID)) {                                          \
+    *aInstancePtr = (void*) this;                                        \
+    NS_ADDREF_THIS();                                                    \
+    return NS_OK;                                                        \
+  }                                                                      \
+  if (aIID.Equals(kISupportsIID)) {                                      \
+    *aInstancePtr = (void*) ((nsISupports*)this);                        \
+    NS_ADDREF_THIS();                                                    \
+    return NS_OK;                                                        \
+  }                                                                      \
+  if (aIID.Equals(kIsThreadsafeIID)) {                                   \
+    return NS_OK;                                                        \
+  }                                                                      \
+  return NS_NOINTERFACE;                                                 \
+}
+
+#else   /* !NS_DEBUG */
+
+#define NS_VERIFY_THREADSAFE_INTERFACE(_iface)
+#define NS_IMPL_THREADSAFE_QUERY_INTERFACE(_class,_classiiddef)          \
+ NS_IMPL_QUERY_INTERFACE(_class, _classiiddef)
+
+#endif /* !NS_DEBUG */
+
+/**
+ * Convenience macro for implementing all nsISupports methods for
+ * a simple class.
+ * @param _class The name of the class implementing the method
+ * @param _classiiddef The name of the #define symbol that defines the IID
+ * for the class (e.g. NS_ISUPPORTS_IID)
+ */
+
+#define NS_IMPL_THREADSAFE_ISUPPORTS(_class,_classiiddef) \
+  NS_IMPL_THREADSAFE_ADDREF(_class)                       \
+  NS_IMPL_THREADSAFE_RELEASE(_class)                      \
+  NS_IMPL_THREADSAFE_QUERY_INTERFACE(_class,_classiiddef)
+
+#else /* !NS_MT_SUPPORTED */
+
+#define NS_LOCK_INSTANCE()
+
+#define NS_UNLOCK_INSTANCE()
+
+#define NS_IMPL_THREADSAFE_ADDREF(_class)  NS_IMPL_ADDREF(_class)
+
+#define NS_IMPL_THREADSAFE_RELEASE(_class) NS_IMPL_RELEASE(_class)
+
+#define NS_VERIFY_THREADSAFE_INTERFACE(_iface)
+
+#define NS_IMPL_THREADSAFE_QUERY_INTERFACE(_class,_classiiddef) \
+ NS_IMPL_QUERY_INTERFACE(_class, _classiiddef)
+
+#define NS_IMPL_THREADSAFE_ISUPPORTS(_class,_classiiddef) \
+  NS_IMPL_ADDREF(_class)                                  \
+  NS_IMPL_RELEASE(_class)                                 \
+  NS_IMPL_QUERY_INTERFACE(_class,_classiiddef)
+
+#endif /* !NS_MT_SUPPORTED */
+
+////////////////////////////////////////////////////////////////////////////////
+// Debugging Macros
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Macro for instantiating a new object that implements nsISupports.
+ * Use this in your factory methods to allow for refcnt tracing.
+ * Note that you can only use this if you adhere to the no arguments
+ * constructor com policy (which you really should!).
+ * @param _result Where the new instance pointer is stored
+ * @param _type The type of object to call "new" with.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_NEWXPCOM(_result,_type)                              \
+  PR_BEGIN_MACRO                                                \
+    _result = new _type();                                      \
+    nsTraceRefcnt::Create(_result, #_type, __FILE__, __LINE__); \
+  PR_END_MACRO
+#else
+#define NS_NEWXPCOM(_result,_type) \
+  _result = new _type()
+#endif
+
+/**
+ * Macro for deleting an object that implements nsISupports.
+ * Use this in your Release methods to allow for refcnt tracing.
+ * @param _ptr The object to delete.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_DELETEXPCOM(_ptr)                            \
+  PR_BEGIN_MACRO                                        \
+    nsTraceRefcnt::Destroy((_ptr), __FILE__, __LINE__); \
+    delete (_ptr);                                      \
+  PR_END_MACRO
+#else
+#define NS_DELETEXPCOM(_ptr)    \
+  delete (_ptr)
+#endif
+
+/**
+ * Macro for adding a reference to an interface.
+ * @param _ptr The interface pointer.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_ADDREF(_ptr)                                       \
+  ((nsrefcnt) nsTraceRefcnt::AddRef((_ptr), (_ptr)->AddRef(), \
+                                    __FILE__, __LINE__))
+#else
+#define NS_ADDREF(_ptr) \
+  (_ptr)->AddRef()
+#endif
+
+/**
+ * Macro for adding a reference to this. This macro should be used
+ * because NS_ADDREF (when tracing) may require an ambiguous cast
+ * from the pointers primary type to nsISupports. This macro sidesteps
+ * that entire problem.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_ADDREF_THIS() \
+  ((nsrefcnt) nsTraceRefcnt::AddRef(this, AddRef(), __FILE__, __LINE__))
+#else
+#define NS_ADDREF_THIS() \
+  AddRef()
+#endif
+
+/**
+ * Macro for adding a reference to an interface that checks for NULL.
+ * @param _ptr The interface pointer.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_IF_ADDREF(_ptr)                                                 \
+  ((0 != (_ptr))                                                           \
+   ? ((nsrefcnt) nsTraceRefcnt::AddRef((_ptr), (_ptr)->AddRef(), __FILE__, \
+                                       __LINE__))                          \
+   : 0)
+#else
+#define NS_IF_ADDREF(_ptr) \
+  ((0 != (_ptr)) ? (_ptr)->AddRef() : 0)
+#endif
+
+/**
+ * Macro for releasing a reference to an interface.
+ *
+ * Note that when MOZ_TRACE_XPCOM_REFCNT is defined that the release will
+ * be done before the trace message is logged. If the reference count
+ * goes to zero and implementation of Release logs a message, the two
+ * messages will be logged out of order.
+ *
+ * @param _ptr The interface pointer.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_RELEASE(_ptr)                                                   \
+  PR_BEGIN_MACRO                                                           \
+    nsTraceRefcnt::Release((_ptr), (_ptr)->Release(), __FILE__, __LINE__); \
+    (_ptr) = 0;                                                            \
+  PR_END_MACRO
+#else
+#define NS_RELEASE(_ptr)    \
+  PR_BEGIN_MACRO            \
+    (_ptr)->Release();      \
+    (_ptr) = 0;             \
+  PR_END_MACRO
+#endif
+
+/**
+ * Macro for releasing a reference to an interface, except that this
+ * macro preserves the return value from the underlying Release call.
+ * The interface pointer argument will only be NULLed if the reference count
+ * goes to zero.
+ *
+ * Note that when MOZ_TRACE_XPCOM_REFCNT is defined that the release will
+ * be done before the trace message is logged. If the reference count
+ * goes to zero and implementation of Release logs a message, the two
+ * messages will be logged out of order.
+ *
+ * @param _ptr The interface pointer.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_RELEASE2(_ptr, _result)                                          \
+  PR_BEGIN_MACRO                                                            \
+    _result = ((nsrefcnt) nsTraceRefcnt::Release((_ptr), (_ptr)->Release(), \
+                                                 __FILE__, __LINE__));      \
+    if (0 == (_result)) (_ptr) = 0;                                         \
+  PR_END_MACRO
+#else
+#define NS_RELEASE2(_ptr, _result)  \
+  PR_BEGIN_MACRO                    \
+    _result = (_ptr)->Release();    \
+    if (0 == (_result)) (_ptr) = 0; \
+  PR_END_MACRO
+#endif
+
+/**
+ * Macro for releasing a reference to an interface that checks for NULL;
+ *
+ * Note that when MOZ_TRACE_XPCOM_REFCNT is defined that the release will
+ * be done before the trace message is logged. If the reference count
+ * goes to zero and implementation of Release logs a message, the two
+ * messages will be logged out of order.
+ *
+ * @param _ptr The interface pointer.
+ */
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#define NS_IF_RELEASE(_ptr)                                         \
+  PR_BEGIN_MACRO                                                    \
+    ((0 != (_ptr))                                                  \
+    ? ((nsrefcnt) nsTraceRefcnt::Release((_ptr), (_ptr)->Release(), \
+                                          __FILE__, __LINE__))      \
+    : 0);                                                           \
+    (_ptr) = 0;                                                     \
+  PR_END_MACRO
+#else
+#define NS_IF_RELEASE(_ptr)                   \
+  PR_BEGIN_MACRO                              \
+    ((0 != (_ptr)) ? (_ptr)->Release() : 0);  \
+    (_ptr) = 0;                               \
+  PR_END_MACRO
+#endif
+
+////////////////////////////////////////////////////////////////////////////////
+
+#endif /* __nsISupportsUtils_h */

mozilla/xpcom/base/nsTraceRefcnt.cpp

@@ -0,0 +1,317 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (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/NPL/
+ *
+ * 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.
+ *
+ * The Original Code is Mozilla Communicator client code.
+ *
+ * The Initial Developer of the Original Code is Netscape Communications
+ * Corporation.  Portions created by Netscape are Copyright (C) 1998
+ * Netscape Communications Corporation.  All Rights Reserved.
+ */
+#include "nsISupports.h"
+#include "prprf.h"
+#include "prlog.h"
+
+#if defined(_WIN32)
+#include <windows.h>
+#endif
+
+static PRLogModuleInfo* gTraceRefcntLog;
+
+#if defined(NS_MT_SUPPORTED)
+#include "prlock.h"
+
+static PRLock* gTraceLock;
+
+#define LOCK_TRACELOG()   PR_Lock(gTraceLock)
+#define UNLOCK_TRACELOG() PR_Unlock(gTraceLock)
+#else /* ! NT_MT_SUPPORTED */
+#define LOCK_TRACELOG()
+#define UNLOCK_TRACELOG()
+#endif /* ! NS_MT_SUPPORTED */
+
+static void InitTraceLog(void)
+{
+  if (0 == gTraceRefcntLog) {
+    gTraceRefcntLog = PR_NewLogModule("xpcomrefcnt");
+
+#if defined(NS_MT_SUPPORTED)
+    gTraceLock = PR_NewLock();
+#endif /* NS_MT_SUPPORTED */
+  }
+}
+
+#if defined(MOZ_TRACE_XPCOM_REFCNT)
+#if defined(_WIN32)
+#include "imagehlp.h"
+#include <stdio.h>
+
+#if 0
+static BOOL __stdcall
+EnumSymbolsCB(LPSTR aSymbolName,
+              ULONG aSymbolAddress,
+              ULONG aSymbolSize,
+              PVOID aUserContext)
+{
+  int* countp = (int*) aUserContext;
+  int count = *countp;
+  if (count < 3) {
+    printf("  %p[%4d]: %s\n", aSymbolAddress, aSymbolSize, aSymbolName);
+    count++;
+    *countp = count++;
+  }
+  return TRUE;
+}
+
+static BOOL __stdcall
+EnumModulesCB(LPSTR aModuleName,
+              ULONG aBaseOfDll,
+              PVOID aUserContext)
+{
+  HANDLE myProcess = ::GetCurrentProcess();
+
+  printf("module=%s dll=%x\n", aModuleName, aBaseOfDll);
+//  int count = 0;
+//  SymEnumerateSymbols(myProcess, aBaseOfDll, EnumSymbolsCB, (void*) &count);
+  return TRUE;
+}
+#endif
+
+/**
+ * Walk the stack, translating PC's found into strings and recording the
+ * chain in aBuffer. For this to work properly, the dll's must be rebased
+ * so that the address in the file agrees with the address in memory.
+ * Otherwise StackWalk will return FALSE when it hits a frame in a dll's
+ * whose in memory address doesn't match it's in-file address.
+ *
+ * Fortunately, there is a handy dandy routine in IMAGEHLP.DLL that does
+ * the rebasing and accordingly I've made a tool to use it to rebase the
+ * DLL's in one fell swoop (see xpcom/tools/windows/rebasedlls.cpp).
+ */
+void
+nsTraceRefcnt::WalkTheStack(char* aBuffer, int aBufLen)
+{
+  CONTEXT context;
+  STACKFRAME frame;
+  char* cp = aBuffer;
+
+  aBuffer[0] = '\0';
+  aBufLen--;                    // leave room for nul
+
+  HANDLE myProcess = ::GetCurrentProcess();
+  HANDLE myThread = ::GetCurrentThread();
+
+  // Get the context information for this thread. That way we will
+  // know where our sp, fp, pc, etc. are and can fill in the
+  // STACKFRAME with the initial values.
+  context.ContextFlags = CONTEXT_FULL;
+  GetThreadContext(myThread, &context);
+
+  if (!SymInitialize(myProcess, ".;..\\lib", TRUE)) {
+    return;
+  }
+
+#if 0
+  SymEnumerateModules(myProcess, EnumModulesCB, NULL);
+#endif
+
+  // Setup initial stack frame to walk from
+  memset(&frame, 0, sizeof(frame));
+  frame.AddrPC.Mode = AddrModeFlat;
+  frame.AddrPC.Offset = context.Eip;
+  frame.AddrReturn.Mode = AddrModeFlat;
+  frame.AddrReturn.Offset = context.Ebp;
+  frame.AddrFrame.Mode = AddrModeFlat;
+  frame.AddrFrame.Offset = context.Ebp;
+  frame.AddrStack.Mode = AddrModeFlat;
+  frame.AddrStack.Offset = context.Esp;
+  frame.Params[0] = context.Eax;
+  frame.Params[1] = context.Ecx;
+  frame.Params[2] = context.Edx;
+  frame.Params[3] = context.Ebx;
+
+  // Now walk the stack and map the pc's to symbol names that we stuff
+  // append to *cp.
+
+  int skip = 2;
+  int syms = 0;
+  while (aBufLen > 0) {
+    char symbolBuffer[sizeof(IMAGEHLP_SYMBOL) + 512];
+    PIMAGEHLP_SYMBOL pSymbol = (PIMAGEHLP_SYMBOL) symbolBuffer;
+    pSymbol->SizeOfStruct = sizeof(symbolBuffer);
+    pSymbol->MaxNameLength = 512;
+
+    DWORD oldAddress = frame.AddrPC.Offset;
+    BOOL b = ::StackWalk(IMAGE_FILE_MACHINE_I386, myProcess, myThread,
+                         &frame, &context, NULL,
+                         SymFunctionTableAccess,
+                         SymGetModuleBase,
+                         NULL);
+    if (!b || (0 == frame.AddrPC.Offset)) {
+      if (syms <= 1) {
+        skip = 7;
+      }
+      break;
+    }
+    if (--skip >= 0) {
+      continue;
+    }
+    DWORD disp;
+    if (SymGetSymFromAddr(myProcess, frame.AddrPC.Offset, &disp, pSymbol)) {
+      int nameLen = strlen(pSymbol->Name);
+      if (nameLen + 2 > aBufLen) {
+        break;
+      }
+      memcpy(cp, pSymbol->Name, nameLen);
+      cp += nameLen;
+      *cp++ = ' ';
+      aBufLen -= nameLen + 1;
+      syms++;
+    }
+    else {
+      if (11 > aBufLen) {
+        break;
+      }
+      char tmp[30];
+      PR_snprintf(tmp, sizeof(tmp), "0x%08x ", frame.AddrPC.Offset);
+      memcpy(cp, tmp, 11);
+      cp += 11;
+      aBufLen -= 11;
+      syms++;
+    }
+  }
+  *cp = 0;
+}
+
+#endif /* _WIN32 */
+
+#else /* MOZ_TRACE_XPCOM_REFCNT */
+void
+nsTraceRefcnt::WalkTheStack(char* aBuffer, int aBufLen)
+{
+  aBuffer[0] = '\0';
+}
+#endif /* MOZ_TRACE_XPCOM_REFCNT */
+
+NS_COM void
+nsTraceRefcnt::LoadLibrarySymbols(const char* aLibraryName,
+                                  void* aLibrayHandle)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#if defined(_WIN32)
+  InitTraceLog();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    HANDLE myProcess = ::GetCurrentProcess();
+
+    if (!SymInitialize(myProcess, ".;..\\lib", TRUE)) {
+      return;
+    }
+
+    BOOL b = ::SymLoadModule(myProcess,
+                             NULL,
+                             (char*)aLibraryName,
+                             (char*)aLibraryName,
+                             0,
+                             0);
+//  DWORD lastError = 0;
+//  if (!b) lastError = ::GetLastError();
+//  printf("loading symbols for library %s => %s [%d]\n", aLibraryName,
+//         b ? "true" : "false", lastError);
+  }
+#endif
+#endif
+}
+
+NS_COM unsigned long
+nsTraceRefcnt::AddRef(void* aPtr,
+                      unsigned long aNewRefcnt,
+                      const char* aFile,
+                      PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("AddRef: %p: %d=>%d [%s] in %s (line %d)",
+            aPtr, aNewRefcnt-1, aNewRefcnt, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+  return aNewRefcnt;
+
+}
+
+NS_COM unsigned long
+nsTraceRefcnt::Release(void* aPtr,
+                       unsigned long aNewRefcnt,
+                       const char* aFile,
+                       PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("Release: %p: %d=>%d [%s] in %s (line %d)",
+            aPtr, aNewRefcnt+1, aNewRefcnt, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+  return aNewRefcnt;
+}
+
+NS_COM void
+nsTraceRefcnt::Create(void* aPtr,
+                      const char* aType,
+                      const char* aFile,
+                      PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("Create: %p[%s]: [%s] in %s (line %d)",
+            aPtr, aType, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+}
+
+NS_COM void
+nsTraceRefcnt::Destroy(void* aPtr,
+                      const char* aFile,
+                      PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("Destroy: %p: [%s] in %s (line %d)",
+            aPtr, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+}

mozilla/xpcom/base/nsTraceRefcnt.h

@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (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/NPL/
+ *
+ * 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.
+ *
+ * The Original Code is Mozilla Communicator client code.
+ *
+ * The Initial Developer of the Original Code is Netscape Communications
+ * Corporation.  Portions created by Netscape are Copyright (C) 1998
+ * Netscape Communications Corporation.  All Rights Reserved.
+ */
+#ifndef nsTraceRefcnt_h___
+#define nsTraceRefcnt_h___
+
+#include "nsCom.h"
+
+/**
+ * This class is used to support tracing (and logging using nspr) of
+ * addref and release calls. Note that only calls that use the
+ * NS_ADDREF and related macros in nsISupports can be traced.
+ *
+ * The name of the nspr log module is "xpcomrefcnt" (case matters).
+ *
+ * This code only performs tracing built with debugging AND when
+ * built with -DMOZ_TRACE_XPCOM_REFCNT (because it's expensive!).
+ */
+class nsTraceRefcnt {
+public:
+  static NS_COM unsigned long AddRef(void* aPtr,
+                                     unsigned long aNewRefcnt,
+                                     const char* aFile,
+                                     int aLine);
+
+  static NS_COM unsigned long Release(void* aPtr,
+                                      unsigned long aNewRefcnt,
+                                      const char* aFile,
+                                      int aLine);
+
+  static NS_COM void Create(void* aPtr,
+                            const char* aType,
+                            const char* aFile,
+                            int aLine);
+
+  static NS_COM void Destroy(void* aPtr,
+                             const char* aFile,
+                             int aLine);
+
+  static NS_COM void LoadLibrarySymbols(const char* aLibraryName,
+                                        void* aLibrayHandle);
+
+  static NS_COM void WalkTheStack(char* aBuffer, int aBufLen);
+};
+
+#endif /* nsTraceRefcnt_h___ */

mozilla/xpcom/base/nsTraceRefcntImpl.cpp

@@ -0,0 +1,317 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (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/NPL/
+ *
+ * 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.
+ *
+ * The Original Code is Mozilla Communicator client code.
+ *
+ * The Initial Developer of the Original Code is Netscape Communications
+ * Corporation.  Portions created by Netscape are Copyright (C) 1998
+ * Netscape Communications Corporation.  All Rights Reserved.
+ */
+#include "nsISupports.h"
+#include "prprf.h"
+#include "prlog.h"
+
+#if defined(_WIN32)
+#include <windows.h>
+#endif
+
+static PRLogModuleInfo* gTraceRefcntLog;
+
+#if defined(NS_MT_SUPPORTED)
+#include "prlock.h"
+
+static PRLock* gTraceLock;
+
+#define LOCK_TRACELOG()   PR_Lock(gTraceLock)
+#define UNLOCK_TRACELOG() PR_Unlock(gTraceLock)
+#else /* ! NT_MT_SUPPORTED */
+#define LOCK_TRACELOG()
+#define UNLOCK_TRACELOG()
+#endif /* ! NS_MT_SUPPORTED */
+
+static void InitTraceLog(void)
+{
+  if (0 == gTraceRefcntLog) {
+    gTraceRefcntLog = PR_NewLogModule("xpcomrefcnt");
+
+#if defined(NS_MT_SUPPORTED)
+    gTraceLock = PR_NewLock();
+#endif /* NS_MT_SUPPORTED */
+  }
+}
+
+#if defined(MOZ_TRACE_XPCOM_REFCNT)
+#if defined(_WIN32)
+#include "imagehlp.h"
+#include <stdio.h>
+
+#if 0
+static BOOL __stdcall
+EnumSymbolsCB(LPSTR aSymbolName,
+              ULONG aSymbolAddress,
+              ULONG aSymbolSize,
+              PVOID aUserContext)
+{
+  int* countp = (int*) aUserContext;
+  int count = *countp;
+  if (count < 3) {
+    printf("  %p[%4d]: %s\n", aSymbolAddress, aSymbolSize, aSymbolName);
+    count++;
+    *countp = count++;
+  }
+  return TRUE;
+}
+
+static BOOL __stdcall
+EnumModulesCB(LPSTR aModuleName,
+              ULONG aBaseOfDll,
+              PVOID aUserContext)
+{
+  HANDLE myProcess = ::GetCurrentProcess();
+
+  printf("module=%s dll=%x\n", aModuleName, aBaseOfDll);
+//  int count = 0;
+//  SymEnumerateSymbols(myProcess, aBaseOfDll, EnumSymbolsCB, (void*) &count);
+  return TRUE;
+}
+#endif
+
+/**
+ * Walk the stack, translating PC's found into strings and recording the
+ * chain in aBuffer. For this to work properly, the dll's must be rebased
+ * so that the address in the file agrees with the address in memory.
+ * Otherwise StackWalk will return FALSE when it hits a frame in a dll's
+ * whose in memory address doesn't match it's in-file address.
+ *
+ * Fortunately, there is a handy dandy routine in IMAGEHLP.DLL that does
+ * the rebasing and accordingly I've made a tool to use it to rebase the
+ * DLL's in one fell swoop (see xpcom/tools/windows/rebasedlls.cpp).
+ */
+void
+nsTraceRefcnt::WalkTheStack(char* aBuffer, int aBufLen)
+{
+  CONTEXT context;
+  STACKFRAME frame;
+  char* cp = aBuffer;
+
+  aBuffer[0] = '\0';
+  aBufLen--;                    // leave room for nul
+
+  HANDLE myProcess = ::GetCurrentProcess();
+  HANDLE myThread = ::GetCurrentThread();
+
+  // Get the context information for this thread. That way we will
+  // know where our sp, fp, pc, etc. are and can fill in the
+  // STACKFRAME with the initial values.
+  context.ContextFlags = CONTEXT_FULL;
+  GetThreadContext(myThread, &context);
+
+  if (!SymInitialize(myProcess, ".;..\\lib", TRUE)) {
+    return;
+  }
+
+#if 0
+  SymEnumerateModules(myProcess, EnumModulesCB, NULL);
+#endif
+
+  // Setup initial stack frame to walk from
+  memset(&frame, 0, sizeof(frame));
+  frame.AddrPC.Mode = AddrModeFlat;
+  frame.AddrPC.Offset = context.Eip;
+  frame.AddrReturn.Mode = AddrModeFlat;
+  frame.AddrReturn.Offset = context.Ebp;
+  frame.AddrFrame.Mode = AddrModeFlat;
+  frame.AddrFrame.Offset = context.Ebp;
+  frame.AddrStack.Mode = AddrModeFlat;
+  frame.AddrStack.Offset = context.Esp;
+  frame.Params[0] = context.Eax;
+  frame.Params[1] = context.Ecx;
+  frame.Params[2] = context.Edx;
+  frame.Params[3] = context.Ebx;
+
+  // Now walk the stack and map the pc's to symbol names that we stuff
+  // append to *cp.
+
+  int skip = 2;
+  int syms = 0;
+  while (aBufLen > 0) {
+    char symbolBuffer[sizeof(IMAGEHLP_SYMBOL) + 512];
+    PIMAGEHLP_SYMBOL pSymbol = (PIMAGEHLP_SYMBOL) symbolBuffer;
+    pSymbol->SizeOfStruct = sizeof(symbolBuffer);
+    pSymbol->MaxNameLength = 512;
+
+    DWORD oldAddress = frame.AddrPC.Offset;
+    BOOL b = ::StackWalk(IMAGE_FILE_MACHINE_I386, myProcess, myThread,
+                         &frame, &context, NULL,
+                         SymFunctionTableAccess,
+                         SymGetModuleBase,
+                         NULL);
+    if (!b || (0 == frame.AddrPC.Offset)) {
+      if (syms <= 1) {
+        skip = 7;
+      }
+      break;
+    }
+    if (--skip >= 0) {
+      continue;
+    }
+    DWORD disp;
+    if (SymGetSymFromAddr(myProcess, frame.AddrPC.Offset, &disp, pSymbol)) {
+      int nameLen = strlen(pSymbol->Name);
+      if (nameLen + 2 > aBufLen) {
+        break;
+      }
+      memcpy(cp, pSymbol->Name, nameLen);
+      cp += nameLen;
+      *cp++ = ' ';
+      aBufLen -= nameLen + 1;
+      syms++;
+    }
+    else {
+      if (11 > aBufLen) {
+        break;
+      }
+      char tmp[30];
+      PR_snprintf(tmp, sizeof(tmp), "0x%08x ", frame.AddrPC.Offset);
+      memcpy(cp, tmp, 11);
+      cp += 11;
+      aBufLen -= 11;
+      syms++;
+    }
+  }
+  *cp = 0;
+}
+
+#endif /* _WIN32 */
+
+#else /* MOZ_TRACE_XPCOM_REFCNT */
+void
+nsTraceRefcnt::WalkTheStack(char* aBuffer, int aBufLen)
+{
+  aBuffer[0] = '\0';
+}
+#endif /* MOZ_TRACE_XPCOM_REFCNT */
+
+NS_COM void
+nsTraceRefcnt::LoadLibrarySymbols(const char* aLibraryName,
+                                  void* aLibrayHandle)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+#if defined(_WIN32)
+  InitTraceLog();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    HANDLE myProcess = ::GetCurrentProcess();
+
+    if (!SymInitialize(myProcess, ".;..\\lib", TRUE)) {
+      return;
+    }
+
+    BOOL b = ::SymLoadModule(myProcess,
+                             NULL,
+                             (char*)aLibraryName,
+                             (char*)aLibraryName,
+                             0,
+                             0);
+//  DWORD lastError = 0;
+//  if (!b) lastError = ::GetLastError();
+//  printf("loading symbols for library %s => %s [%d]\n", aLibraryName,
+//         b ? "true" : "false", lastError);
+  }
+#endif
+#endif
+}
+
+NS_COM unsigned long
+nsTraceRefcnt::AddRef(void* aPtr,
+                      unsigned long aNewRefcnt,
+                      const char* aFile,
+                      PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("AddRef: %p: %d=>%d [%s] in %s (line %d)",
+            aPtr, aNewRefcnt-1, aNewRefcnt, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+  return aNewRefcnt;
+
+}
+
+NS_COM unsigned long
+nsTraceRefcnt::Release(void* aPtr,
+                       unsigned long aNewRefcnt,
+                       const char* aFile,
+                       PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("Release: %p: %d=>%d [%s] in %s (line %d)",
+            aPtr, aNewRefcnt+1, aNewRefcnt, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+  return aNewRefcnt;
+}
+
+NS_COM void
+nsTraceRefcnt::Create(void* aPtr,
+                      const char* aType,
+                      const char* aFile,
+                      PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("Create: %p[%s]: [%s] in %s (line %d)",
+            aPtr, aType, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+}
+
+NS_COM void
+nsTraceRefcnt::Destroy(void* aPtr,
+                      const char* aFile,
+                      PRIntn aLine)
+{
+#ifdef MOZ_TRACE_XPCOM_REFCNT
+  InitTraceLog();
+
+  LOCK_TRACELOG();
+  if (PR_LOG_TEST(gTraceRefcntLog,PR_LOG_DEBUG)) {
+    char sb[1000];
+    WalkTheStack(sb, sizeof(sb));
+    PR_LOG(gTraceRefcntLog, PR_LOG_DEBUG,
+           ("Destroy: %p: [%s] in %s (line %d)",
+            aPtr, sb, aFile, aLine));
+  }
+  UNLOCK_TRACELOG();
+#endif
+}

mozilla/xpcom/base/nsTraceRefcntImpl.h

@@ -0,0 +1,61 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (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/NPL/
+ *
+ * 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.
+ *
+ * The Original Code is Mozilla Communicator client code.
+ *
+ * The Initial Developer of the Original Code is Netscape Communications
+ * Corporation.  Portions created by Netscape are Copyright (C) 1998
+ * Netscape Communications Corporation.  All Rights Reserved.
+ */
+#ifndef nsTraceRefcnt_h___
+#define nsTraceRefcnt_h___
+
+#include "nsCom.h"
+
+/**
+ * This class is used to support tracing (and logging using nspr) of
+ * addref and release calls. Note that only calls that use the
+ * NS_ADDREF and related macros in nsISupports can be traced.
+ *
+ * The name of the nspr log module is "xpcomrefcnt" (case matters).
+ *
+ * This code only performs tracing built with debugging AND when
+ * built with -DMOZ_TRACE_XPCOM_REFCNT (because it's expensive!).
+ */
+class nsTraceRefcnt {
+public:
+  static NS_COM unsigned long AddRef(void* aPtr,
+                                     unsigned long aNewRefcnt,
+                                     const char* aFile,
+                                     int aLine);
+
+  static NS_COM unsigned long Release(void* aPtr,
+                                      unsigned long aNewRefcnt,
+                                      const char* aFile,
+                                      int aLine);
+
+  static NS_COM void Create(void* aPtr,
+                            const char* aType,
+                            const char* aFile,
+                            int aLine);
+
+  static NS_COM void Destroy(void* aPtr,
+                             const char* aFile,
+                             int aLine);
+
+  static NS_COM void LoadLibrarySymbols(const char* aLibraryName,
+                                        void* aLibrayHandle);
+
+  static NS_COM void WalkTheStack(char* aBuffer, int aBufLen);
+};
+
+#endif /* nsTraceRefcnt_h___ */

mozilla/xpcom/build/dlldeps.cpp

@@ -1,126 +0,0 @@
-/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
- *
- * The contents of this file are subject to the Netscape 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/NPL/
- *
- * 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.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
- * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
- */
-
-// Force references to all of the symbols that we want exported from
-// the dll that are located in the .lib files we link with
-
-#include "nsVoidArray.h"
-#include "nsIAtom.h"
-#include "nsFileSpec.h"
-//#include "nsIBuffer.h"
-//#include "nsIByteBufferInputStream.h"
-#include "nsFileStream.h"
-#include "nsFileSpecStreaming.h"
-#include "nsSpecialSystemDirectory.h"
-#include "nsIThread.h"
-#include "nsDeque.h"
-#include "nsObserver.h"
-#include "nsTraceRefcnt.h"
-#include "nsXPIDLString.h"
-#include "nsIEnumerator.h"
-#include "nsEnumeratorUtils.h"
-#include "nsQuickSort.h"
-#include "nsString2.h"
-#include "nsProxyEventPrivate.h"
-#include "xpt_xdr.h"
-#include "nsInterfaceInfo.h"
-#include "xptcall.h"
-#include "nsIFileSpec.h"
-#include "nsIGenericFactory.h"
-#include "nsAVLTree.h"
-#include "nsHashtableEnumerator.h"
-#include "nsPipe2.h"
-#include "nsCWeakReference.h"
-#include "nsWeakReference.h"
-#include "nsISizeOfHandler.h"
-#include "nsTextFormater.h"
-#include "nsStorageStream.h"
-#include "nsIBinaryInputStream.h"
-#ifdef DEBUG
-#include "pure.h"
-#endif
-
-class dummyComparitor: public nsAVLNodeComparitor {
-public:
-  virtual PRInt32 operator()(void* anItem1,void* anItem2)
-  {
-    return 0;
-  }
-}; 
-
-#ifdef DEBUG
-extern NS_COM void
-TestSegmentedBuffer();
-#endif
-
-void XXXNeverCalled()
-{
-    nsTextFormater::snprintf(nsnull,0,nsnull);
-    dummyComparitor dummy;
-    nsVoidArray();
-    nsAVLTree(dummy, nsnull);
-    NS_GetNumberOfAtoms();
-    nsFileURL(NULL);
-//    NS_NewPipe(NULL, NULL, 0, 0, 0, NULL);
-    NS_NewPipe(NULL, NULL, NULL, 0, 0);
-    nsFileSpec s;
-    NS_NewIOFileStream(NULL, s, 0, 0);
-    nsInputFileStream(s, 0, 0);
-    nsPersistentFileDescriptor d;
-    ReadDescriptor(NULL, d);
-    new nsSpecialSystemDirectory(nsSpecialSystemDirectory::OS_DriveDirectory);
-    nsIThread::GetCurrent(NULL);
-    nsDeque(NULL);
-    NS_NewObserver(NULL, NULL);
-    nsTraceRefcnt::DumpStatistics();
-    nsXPIDLCString::Copy(NULL);
-    NS_NewEmptyEnumerator(NULL);
-    nsArrayEnumerator(NULL);
-    NS_NewIntersectionEnumerator(NULL, NULL, NULL);
-    NS_QuickSort(NULL, 0, 0, NULL, NULL);
-    nsString2();
-    nsProxyObject(NULL, 0, NULL);
-    XPT_DoString(NULL, NULL);
-    XPT_DoHeader(NULL, NULL);
-    nsInterfaceInfo* info = NULL;
-    info->GetName(NULL);
-#ifdef DEBUG
-    info->print(NULL);
-    PurePrintf(0);
-#endif
-    XPTC_InvokeByIndex(NULL, 0, 0, NULL);
-    NS_NewFileSpec(NULL);
-    xptc_dummy();
-    xptc_dummy2();
-    XPTI_GetInterfaceInfoManager();
-    NS_NewGenericFactory(NULL, NULL, NULL);
-    NS_NewHashtableEnumerator(NULL, NULL, NULL, NULL);
-    nsCWeakProxy(0, 0);
-    nsCWeakReferent(0);
-    NS_GetWeakReference(NULL);
-#ifdef DEBUG
-    TestSegmentedBuffer();
-#endif
-    NS_NewSizeOfHandler(0);
-    nsStorageStream();
-    NS_NewBinaryInputStream(0, 0);
-}

mozilla/xpcom/components/mozIClassRegistry.h

@@ -0,0 +1,168 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+#ifndef __mozIClassRegistry_h
+#define __mozIClassRegistry_h
+
+#include "nsIComponentManager.h"
+
+/*---------------------------- mozIClassRegistry -------------------------------
+| This interface provides access to a mapping from mnemonic interface names    |
+| to shared libraries where implementations of those interfaces can be located.|
+|                                                                              |
+| This interface is designed to provide two things:                            |
+|   1. A means of less static binding between clients and the code that        |
+|      implements the XPCOM interfaces those clients use.  This accomplished   |
+|      by the mapping from interface names to nsCID (and the shared libraries  |
+|      that implement those classes).                                          |
+|   2. A means of dynamically changing the mapping from interface name to      |
+|      implementation.  The canonical example of this is to switch to a        |
+|      "native" widget set versus an "XP" (implemented using gfx) set.         |
+|                                                                              |
+| The first goal is achieved by storing (in a "Netscape Registry" file, see    |
+| nsReg.h) information that maps interface/class "names" to information about  |
+| where to load implementations of those interfaces.  That information         |
+| includes the interface ID, class ID (of the implementation class), and the   |
+| name of the shared library that contains the implementation.                 |
+|                                                                              |
+| The class registry object will register those classes with the "repository"  |
+| (see nsComponentManager.h) the first time a request is made to create an           |
+| instance.  Subsequent requests will simply be forwarded to the repository    |
+| after the appropriate interface and class IDs are determined.                |
+|                                                                              |
+| The second goal is accomplished by permitting the mnemonic interface         |
+| "names" to be "overloaded", that is, mapped to distinct implementations      |
+| by separate class registry objects.  Further, class registries can be        |
+| cascaded: they can be chained together so that when a name is not            |
+| recognized by one registry, it can pass the request to the next registry in  |
+| the chain.  Users can control resolution by making the request of a          |
+| registry further up/down the chain.                                          |
+|                                                                              |
+| For example, consider the case of "native" vs. "gfx" widgets.  This might    |
+| be structured by a class registry arrangment like this:                      |
+|                                                                              |
+|      nativeWidgetRegistry          baseWidgetRegistry                        |
+|          +----------+                 +----------+                           |
+|          |      ----+---------------->|          |                           |
+|          +----------+                 +----------+                           |
+|          |toolbar| -+-----+           |toolbar| -+-----+                     |
+|          +----------+     |           +----------+     |                     |
+|          |button | -+-----+           |button | -+-----+                     |
+|          +----------+     |           +----------+     |                     |
+|                           V                            V                     |
+|                  +-----------------+          +-----------------+            |
+|                  |   native.dll    |          |    base.dll     |            |
+|                  +-----------------+          +-----------------+            |
+|                                                                              |
+|  If a specialized implementation of widgets is present (e.g., native.dll)    |
+|  then a corresponding class registry object is created and added to the      |
+|  head of the registry chain.  Object creation requests (normal ones) are     |
+|  resolved to the native implementation.  If such a library is not present,   |
+|  then the resolution is to the base implementation.  If objects of the       |
+|  base implementation are required, then creation requests can be directed    |
+|  directly to the baseWidgetRegistry object, rather than the head of the      |
+|  registry chain.                                                             |
+|                                                                              |
+|  It is intended that there be a single instance of this interface, accessed  |
+|  via the Service Manager (see nsServiceManager.h).                           |
+------------------------------------------------------------------------------*/
+struct mozIClassRegistry : public ISupports {
+
+    /*------------------------------ CreateInstance ----------------------------
+    | Create an instance of the requested class/interface.  The interface      |
+    | ID is required to specify how the result will be treated.  The class     |
+    | named by aName must support this interface.  The result is placed in     |
+    | ncomment aResult (NULL if the request fails).  "start" specifies the     |
+    | registry at which the search for an implementation of the named          |
+    | interface should start.  It defaults to 0 (indicating to start at the    |
+    | head of the registry chain).                                             |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD CreateInstance( const char *anInterfaceName,
+                               const nsIID &aIID,
+                               void*      *aResult,
+                               const char *start = 0 ) = 0;
+
+    /*--------------------------- CreateEnumerator -----------------------------
+    | Creates an nsIEnumerator interface object that can be used to examine    |
+    | the contents of the registry.  "pattern" specifies either "*" or the     |
+    | name of a specific interface that you want to query.  "result" will      |
+    | be set to point to a new object (which will be freed on the last call    |
+    | to its Release() member).  See nsIEnumerator.h for details on how to     |                                          
+    | use the returned interface pointer.                                      |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD CreateEnumerator( const char     *pattern,
+                                 nsIEnumerator* *result ) = 0;
+}; // mozIClassRegistry
+
+
+/*-------------------------- mozIClassRegistryEntry ----------------------------
+| Objects of this class represent the individual elements that comprise a      |
+| mozIClassRegistry interface.  You obtain such objects by applying the        |
+| CreateEnumerator member function to the class registry and then applying     |
+| the CurrentItem member function to the resulting nsIEnumerator interface.    |
+|                                                                              |
+| Each entry can be queried for the following information:                     |
+|   o sub-registry name                                                        |
+|   o interface name                                                           |
+|   o Class ID                                                                 |
+|   o IIDs implemented                                                         |
+|                                                                              |
+| The information obtained from the entry (specifically, the const char*       |
+| strings) remains valid for the life of the entry (i.e., until you            |
+| Release() it).                                                               |
+|                                                                              |
+| Here is an example of code that uses this interface to dump the contents     |
+| of a mozIClassRegistry:                                                      |
+|                                                                              |
+|    mozIClassRegistry *reg = nsServiceManager::GetService( kIDRegistry );     |
+|    nsIEnumerator *enum;                                                      |
+|    reg->CreateEnumerator( "*", &enum );                                      |
+|    for ( enum->First(); !enum->IsDone(); enum->Next(); ) {                   |
+|       mozIClassRegistryEntry *entry;                                         |
+|       enum->CurrentItem( &entry );                                           |
+|       const char *subreg;                                                    |
+|       const char *name;                                                      |
+|       nsCID cid;                                                             |
+|       int   numIIDs;                                                         |
+|       entry->GetSubRegistryName( &subreg );                                  |
+|       entry->GetInterfaceName( &name );                                      |
+|       entry->GetClassID( &cid );                                             |
+|       entry->GetNumIIDs( &numIIDs );                                         |
+|       cout << subreg << "/" << name << " = " << cid.ToString() << endl;      |
+|       for ( int i = 0; i < numIIDs; i++ ) {                                  |
+|           nsIID iid;                                                         |
+|           entry->GetInterfaceID( i, &iid );                                  |
+|           cout << "/tIID[" << i << "] = " << iid.ToString() << endl;         |
+|       }                                                                      |
+|       entry->Release();                                                      |
+|    }                                                                         |
+|    enum->Release();                                                          |
+------------------------------------------------------------------------------*/
+struct mozIClassRegistryEntry : public nsISupports {
+    NS_IMETHOD GetSubRegistryName( const char **result ) = 0;
+    NS_IMETHOD GetInterfaceName( const char **result ) = 0;
+    NS_IMETHOD GetClassID( nsCID *result ) = 0;
+    NS_IMETHOD GetNumIIDs( int *result ) = 0;
+    NS_IMETHOD GetInterfaceID( int n, nsIID *result ) = 0;
+}; // mozIClassRegistryEntry
+
+// {5D41A440-8E37-11d2-8059-00600811A9C3}
+#define MOZ_ICLASSREGISTRY_IID { 0x5d41a440, 0x8e37, 0x11d2, { 0x80, 0x59, 0x0, 0x60, 0x8, 0x11, 0xa9, 0xc3 } }
+// {D1B54831-AC07-11d2-805E-00600811A9C3}
+#define MOZ_ICLASSREGISTRYENTRY_IID { 0xd1b54831, 0xac07, 0x11d2, { 0x80, 0x5e, 0x0, 0x60, 0x8, 0x11, 0xa9, 0xc3 } }
+
+#endif

mozilla/xpcom/components/mozIRegistry.h

@@ -0,0 +1,326 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+#ifndef __mozIRegistry_h
+#define __mozIRegistry_h
+
+#include "nsISupports.h"
+
+class nsIEnumerator;
+
+/*------------------------------- mozIRegistry ---------------------------------
+| This interface provides access to a tree of arbitrary values.                |
+|                                                                              |
+| Each node of the tree contains either a value or a subtree or both.          |
+|                                                                              |
+| The value at any of these leaf nodes can be any of these "primitive" types:  |
+|   o string (null terminated UTF string)                                      |
+|   o array of 32-bit integers                                                 |
+|   o arbitrary array of bytes                                                 |
+|   o file identifier                                                          |
+| Of course, since you can store an arbitrary array of bytes, you can put      |
+| any data you like into a registry (although you have the burden of           |
+| encoding/decoding your data in that case).                                   |
+|                                                                              |
+| Each branch of the tree is labelled with a string "key."  The entire path    |
+| from a given point of the tree to another point further down can be          |
+| presented as a single string composed of each branch's label, concatenated   |
+| to the next, with an intervening forward slash ('/').  The term "key"        |
+| refers to both specific tree branch labels and to such concatenated paths.   |
+|                                                                              |
+| The branches from a given node must have unique labels.  Distinct nodes can  |
+| have branches with the same label.                                           |
+|                                                                              |
+| For example, here's a small registry tree:                                   |
+|                                            |                                 |
+|                                           /\                                 |
+|                                         /    \                               |
+|                                       /        \                             |
+|                                     /            \                           |
+|                              "Classes"          "Users"                      |
+|                                 /                  \                         |
+|                               /                      \                       |
+|                             /                      ["joe"]                   |
+|                           /                          / \                     |
+|                          |                          /   \                    |
+|                         /\                         /     \                   |
+|                       /    \                    "joe"   "bob"                |
+|                     /        \                    /       \                  |
+|                                                  /         \                 |
+|        "{xxxx-xx-1}"       "{xxxx-xx-2}"  ["c:/joe"]   ["d:/Robert"]         |
+|             |                    |                                           |
+|            /\                   /\                                           |
+|          /    \               /    \                                         |
+|        /        \           /        \                                       |
+|    "Library" "Version"  "Library" "Version"                                  |
+|       /         \          /          \                                      |
+| ["foo.dll"]      2   ["bar.dll"]       1                                     |
+|                                                                              |
+| In this example, there are 2 keys under the root: "Classes" and "Users".     |
+| The first denotes a subtree only (which has two subtrees, ...).  The second  |
+| denotes both a value ["joe"] and two subtrees labelled "joe" and "bob".      |
+| The value at the node "/Users" is ["joe"], at "/Users/bob" is ["d:/Robert"]. |
+| The value at "/Classes/{xxxx-xx-1}/Version" is 2.                            |
+|                                                                              |
+| The registry interface provides functions that let you navigate the tree     |
+| and manipulate it's contents.                                                |
+|                                                                              |
+| Please note that the registry itself does not impose any structure or        |
+| meaning on the contents of the tree.  For example, the registry doesn't      |
+| control whether the value at the key "/Users" is the label for the subtree   |
+| with information about the last active user.  That meaning is applied by     |
+| the code that stores these values and uses them for that purpose.            |
+|                                                                              |
+| [Any resemblence between this example and actual contents of any actual      |
+| registry is purely coincidental.]                                            |
+------------------------------------------------------------------------------*/
+struct mozIRegistry : public nsISupports {
+    /*------------------------------ Constants ---------------------------------
+    | The following enumerated types and values are used by the registry       |
+    | interface.                                                               |
+    --------------------------------------------------------------------------*/
+    typedef enum {
+        String = 1,
+        Int32,
+        Bytes,
+        File
+    } DataType;
+
+    /*-------------------------------- Types -----------------------------------
+    | The following data types are used by this interface.  All are basically  |
+    | opaque types.  You obtain objects of these types via certain member      |
+    | function calls and re-use them later (without having to know what they   |
+    | contain).                                                                |
+    |                                                                          |
+    |   Key       - Placeholder to represent a particular node in a registry   |
+    |               tree.  There are 3 enumerated values that correspond to    |
+    |               specific nodes:                                            |
+    |                   Common      - Where most stuff goes.                   |
+    |                   Users       - Special subtree to hold info about       |
+    |                                 "users"; if you don't know what goes     |
+    |                                 here, don't mess with it.                |
+    |                   CurrentUser - Subtree under Users corresponding to     |
+    |                                 whatever user is designed the "current"  |
+    |                                 one; see note above.                     |
+    |               You can specify any of these enumerated values as "keys"   |
+    |               on any member function that takes a mozRegistry::Key.      |
+    |   ValueInfo - Structure describing a registry value.                     |
+    --------------------------------------------------------------------------*/
+    typedef uint32 Key;
+
+    enum { Users = 1, Common = 2, CurrentUser = 3 };
+
+    struct ValueInfo {
+        DataType type;
+        uint32   length;
+    };
+
+    /*--------------------------- Opening/Closing ------------------------------
+    | These functions open the specified registry file (Open() with a non-null |
+    | argument) or the default "standard" registry file (Open() with a null    |
+    | argument or OpenDefault()).                                              |
+    |                                                                          |
+    | Once opened, you can access the registry contents via the read/write     |
+    | or query functions.                                                      |
+    |                                                                          |
+    | The registry file will be closed automatically when the registry object  |
+    | is destroyed.  You can close the file prior to that by using the         |
+    | Close() function.                                                        |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD Open( const char *regFile = 0 ) = 0;
+    NS_IMETHOD OpenDefault() = 0;
+    NS_IMETHOD Close() = 0;
+
+    /*----------------------- Reading/Writing Values ---------------------------
+    | These functions read/write the registry values at a given node.          |
+    |                                                                          |
+    | All functions require you to specify where in the registry key to        |
+    | get/set the value.  The location is specified using two components:      |
+    |   o A "base key" indicating where to start from; this is a value of type |
+    |     mozIRegistry::Key.  You use either one of the special "root" key     |
+    |     values or a subkey obtained via some other member function call.     |
+    |   o A "relative path," expressed as a sequence of subtree names          |
+    |     separated by forward slashes.  This path describes how to get from   |
+    |     the base key to the node at which you want to store the data.  This  |
+    |     component can be a null pointer which means the value goes directly  |
+    |     at the node denoted by the base key.                                 |
+    |                                                                          |
+    | When you request a value of a given type, the data stored at the         |
+    | specified node must be of the type requested.  If not, an error results. |
+    |                                                                          |
+    | GetString - Obtains a newly allocated copy of a string type value.  The  |
+    |             caller is obligated to free the returned string using        |
+    |             PR_Free.                                                     |
+    | SetString - Stores the argument string at the specified node.            |
+    | GetInt    - Obtains an int32 value at the specified node.  The result    |
+    |             is returned into an int32 location you specify.              |
+    | SetInt    - Stores a given int32 value at a node.                        |
+    | GetBytes  - Obtains a byte array value; this returns both an allocated   |
+    |             array of bytes and a length (necessary because there may be  |
+    |             embedded null bytes in the array).  You must free the        |
+    |             resulting array using PR_Free.                               |
+    | SetBytes  - Stores a given array of bytes; you specify the bytes via a   |
+    |             pointer and a length.                                        |
+    | GetIntArray - Obtains the array of int32 values stored at a given node.  |
+    |             The result is composed of two values: a pointer to an        |
+    |             array of integer values (which must be freed using           |
+    |             PR_Free) and the number of elements in that array.           |
+    | SetIntArray - Stores a set of int32 values at a given node.  You must    |
+    |             provide a pointer to the array and the number of entries.    |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD GetString( Key baseKey, const char *path, char **result ) = 0;
+    NS_IMETHOD SetString( Key baseKey, const char *path, const char *value ) = 0;
+    NS_IMETHOD GetInt( Key baseKey, const char *path, int32 *result ) = 0;
+    NS_IMETHOD SetInt( Key baseKey, const char *path, int32 value ) = 0;
+    NS_IMETHOD GetBytes( Key baseKey, const char *path, void **result, uint32 *len ) = 0;
+    NS_IMETHOD SetBytes( Key baseKey, const char *path, void *value, uint32 len ) = 0;
+    NS_IMETHOD GetIntArray( Key baseKey, const char *path, int32 **result, uint32 *len ) = 0;
+    NS_IMETHOD SetIntArray( Key baseKey, const char *path, const int32 *value, uint32 len ) = 0;
+
+    /*------------------------------ Navigation --------------------------------
+    | These functions let you navigate through the registry tree, querying     |
+    | its contents.                                                            |
+    |                                                                          |
+    | As above, all these functions requires a starting tree location ("base   |
+    | key")  specified as a mozIRegistry::Key.  Some also require a path       |
+    | name to locate the registry node location relative to this base key.     |
+    |                                                                          |
+    | AddSubtree           - Adds a new registry subtree at the specified      |
+    |                        location.  Returns the resulting key in           |
+    |                        the location specified by the third argument      |
+    |                        (unless that pointer is 0).                       |
+    | RemoveNode           - Removes the specified registry subtree or         |
+    |                        value at the specified location.                  |
+    | GetSubtree           - Returns a mozIRegistry::Key that can be used      |
+    |                        to refer to the specified registry location.      |
+    | EnumerateSubtrees    - Returns a nsIEnumerator object that you can       |
+    |                        use to enumerate all the subtrees descending      |
+    |                        from a specified location.  You must free the     |
+    |                        enumerator via Release() when you're done with    |
+    |                        it.                                               |
+    | EnumerateAllSubtrees - Like EnumerateSubtrees, but will recursively      |
+    |                        enumerate lower-level subtrees, too.              |
+    | GetValueInfo         - Returns a uint32 value that designates the type   |
+    |                        of data stored at this location in the registry;  |
+    |                        the possible values are defined by the enumerated |
+    |                        type mozIRegistry::DataType.                      |
+    | GetValueLength       - Returns a uint32 value that indicates the length  |
+    |                        of this registry value; the length is the number  |
+    |                        of characters (for Strings), the number of bytes  |
+    |                        (for Bytes), or the number of int32 values (for   |
+    |                        Int32).                                           |
+    | EnumerateValues      - Returns a nsIEnumerator that you can use to       |
+    |                        enumerate all the value nodes descending from     |
+    |                        a specified location.                             |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD AddSubtree( Key baseKey, const char *path, Key *result ) = 0;
+    NS_IMETHOD RemoveSubtree( Key baseKey, const char *path ) = 0;
+    NS_IMETHOD GetSubtree( Key baseKey, const char *path, Key *result ) = 0;
+
+    NS_IMETHOD EnumerateSubtrees( Key baseKey, nsIEnumerator **result ) = 0;
+    NS_IMETHOD EnumerateAllSubtrees( Key baseKey, nsIEnumerator **result ) = 0;
+
+    NS_IMETHOD GetValueType( Key baseKey, const char *path, uint32 *result ) = 0;
+    NS_IMETHOD GetValueLength( Key baseKey, const char *path, uint32 *result ) = 0;
+
+    NS_IMETHOD EnumerateValues( Key baseKey, nsIEnumerator **result ) = 0;
+
+    /*------------------------------ User Name ---------------------------------
+    | These functions manipulate the current "user name."  This value controls |
+    | the behavior of certain registry functions (namely, ?).                  |
+    |                                                                          |
+    | GetCurrentUserName allocates a copy of the current user name (which the  |
+    | caller should free using PR_Free).                                       |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD GetCurrentUserName( char **result ) = 0;
+    NS_IMETHOD SetCurrentUserName( const char *name ) = 0;
+
+    /*------------------------------ Utilities ---------------------------------
+    | Various utility functions:                                               |
+    |                                                                          |
+    | Pack() is used to compress the contents of an open registry file.        |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD Pack() = 0;
+
+}; // mozIRegistry
+
+/*----------------------------- mozIRegistryNode -------------------------------
+| This interface is implemented by all the objects obtained from the           |
+| nsIEnumerators that mozIRegistry provides when you call either of the        |
+| subtree enumeration functions EnumerateSubtrees or EnumerateAllSubtrees.     |
+|                                                                              |
+| You can call this function to get the name of this subtree.  This is the     |
+| relative path from the base key from which you got this interface.           |
+|                                                                              |
+|   GetName - Returns the path name of this node; this is the relative path    |
+|             from the base key from which this subtree was obtained.  The     |
+|             function allocates a copy of the name; the caller must free it   |
+|             using PR_Free.                                                   |
+------------------------------------------------------------------------------*/
+struct mozIRegistryNode : public nsISupports {
+    NS_IMETHOD GetName( char **result ) = 0;
+}; // mozIRegistryNode
+
+/*----------------------------- mozIRegistryValue ------------------------------
+| This interface is implemented by the objects obtained from the               |
+| nsIEnumerators that mozIRegistry provides when you call the                  |
+| EnumerateValues function.  An object supporting this interface is            |
+| returned when you call the CurrentItem() function on that enumerator.        |
+|                                                                              |
+| You use the member functions of this interface to obtain information         |
+| about each registry value.                                                   |
+|                                                                              |
+|   GetName      - Returns the path name of this node; this is the relative    |
+|                  path\ from the base key from which this value was obtained. |
+|                  The function allocates a copy of the name; the caller must  |
+|                  subsequently free it via PR_Free.                           |
+|   GetValueType - Returns (into a location provided by the caller) the type   |
+|                  of the value; the types are defined by the enumerated       |
+|                  type mozIRegistry::DataType.                                |
+|   GetValueLength - Returns a uint32 value that indicates the length          |
+|                    of this registry value; the length is the number          |
+|                    of characters (for Strings), the number of bytes          |
+|                    (for Bytes), or the number of int32 values (for           |
+|                    Int32).                                                   |
+------------------------------------------------------------------------------*/
+struct mozIRegistryValue : public nsISupports {
+    NS_IMETHOD GetName( char **result ) = 0;
+    NS_IMETHOD GetValueType( uint32 *result ) = 0;
+    NS_IMETHOD GetValueLength( uint32 *result ) = 0;
+}; // mozIRegistryEntry
+
+
+/*------------------------------- Error Codes ----------------------------------
+------------------------------------------------------------------------------*/
+#define NS_ERROR_REG_BADTYPE          NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 1 )
+#define NS_ERROR_REG_NO_MORE          NS_ERROR_GENERATE_SUCCESS( NS_ERROR_MODULE_REG, 2 )
+#define NS_ERROR_REG_NOT_FOUND        NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 3 )
+#define NS_ERROR_REG_NOFILE	          NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 4 )
+#define NS_ERROR_REG_BUFFER_TOO_SMALL NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 5 )
+#define NS_ERROR_REG_NAME_TOO_LONG    NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 6 )
+#define NS_ERROR_REG_NO_PATH          NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 7 )
+#define NS_ERROR_REG_READ_ONLY        NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 8 )
+#define NS_ERROR_REG_BAD_UTF8         NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 9 )
+
+// {5D41A440-8E37-11d2-8059-00600811A9C3}
+#define MOZ_IREGISTRY_IID { 0x5d41a440, 0x8e37, 0x11d2, { 0x80, 0x59, 0x0, 0x60, 0x8, 0x11, 0xa9, 0xc3 } }
+// {D1B54831-AC07-11d2-805E-00600811A9C3}
+#define MOZ_IREGISTRYNODE_IID { 0xd1b54831, 0xac07, 0x11d2, { 0x80, 0x5e, 0x0, 0x60, 0x8, 0x11, 0xa9, 0xc3 } }
+// {5316C380-B2F8-11d2-A374-0080C6F80E4B}
+#define MOZ_IREGISTRYVALUE_IID { 0x5316c380, 0xb2f8, 0x11d2, { 0xa3, 0x74, 0x0, 0x80, 0xc6, 0xf8, 0xe, 0x4b } }
+
+#endif

mozilla/xpcom/components/nsComponentManager.h

@@ -0,0 +1,248 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsComponentManager_h__
+#define nsComponentManager_h__
+
+#include "nsIComponentManager.h"
+#include "nsIRegistry.h"
+#include "nsHashtable.h"
+#include "prtime.h"
+#include "prmon.h"
+
+class nsFactoryEntry;
+class nsDll;
+
+////////////////////////////////////////////////////////////////////////////////
+/*
+ *** Quick Registration NOT FOR PUBLIC CONSUMPTION ***
+ *
+ * Quick Registration
+ *
+ * For quick registration, dlls can define
+ *		NSQuickRegisterClassData g_NSQuickRegisterData[];
+ * and export the symbol "g_NSQuickRegisterData"
+ *
+ * Quick registration is tried only if the symbol "NSRegisterSelf"
+ * is not found. If it is found but fails registration, quick registration
+ * will not kick in.
+ *
+ * The array is terminated by having a NULL last element. Specifically, the
+ * array will be assumed to end when
+ *		(g_NSQuickRegisterData[i].classIdStr == NULL)
+ *
+ */
+#define NS_QUICKREGISTER_DATA_SYMBOL "g_NSQuickRegisterData"
+
+////////////////////////////////////////////////////////////////////////////////
+
+class nsComponentManagerImpl : public nsIComponentManager {
+public:
+    NS_DECL_ISUPPORTS
+
+    // nsIComponentManager methods:
+    NS_IMETHOD FindFactory(const nsCID &aClass,
+                           nsIFactory **aFactory);
+
+    // Finds a class ID for a specific Program ID
+    NS_IMETHOD ProgIDToCLSID(const char *aProgID,
+                             nsCID *aClass);
+  
+    // Finds a Program ID for a specific class ID
+    // caller frees the result with delete[]
+    NS_IMETHOD CLSIDToProgID(nsCID *aClass,
+                             char* *aClassName,
+                             char* *aProgID);
+  
+    // Creates a class instance for a specific class ID
+    NS_IMETHOD CreateInstance(const nsCID &aClass, 
+                              nsISupports *aDelegate,
+                              const nsIID &aIID,
+                              void **aResult);
+
+    // Convenience routine, creates a class instance for a specific ProgID
+    NS_IMETHOD CreateInstance(const char *aProgID,
+                              nsISupports *aDelegate,
+                              const nsIID &aIID,
+                              void **aResult);
+
+    // Creates a class instance for a specific class ID
+    /*
+      NS_IMETHOD CreateInstance2(const nsCID &aClass, 
+      nsISupports *aDelegate,
+      const nsIID &aIID,
+      void *aSignature,
+      void **aResult);
+    */
+
+    // Manually registry a factory for a class
+    NS_IMETHOD RegisterFactory(const nsCID &aClass,
+                               const char *aClassName,
+                               const char *aProgID,
+                               nsIFactory *aFactory,
+                               PRBool aReplace);
+
+    // Manually register a dynamically loaded component.
+    NS_IMETHOD RegisterComponent(const nsCID &aClass,
+                                 const char *aClassName,
+                                 const char *aProgID,
+                                 const char *aLibrary,
+                                 PRBool aReplace,
+                                 PRBool aPersist);
+
+    // Manually unregister a factory for a class
+    NS_IMETHOD UnregisterFactory(const nsCID &aClass,
+                                 nsIFactory *aFactory);
+
+    // Manually unregister a dynamically loaded factory for a class
+    NS_IMETHOD UnregisterFactory(const nsCID &aClass,
+                                 const char *aLibrary);
+
+    // Manually unregister a dynamically loaded component
+    NS_IMETHOD UnregisterComponent(const nsCID &aClass,
+                                   const char *aLibrary);
+
+    // Unload dynamically loaded factories that are not in use
+    NS_IMETHOD FreeLibraries(void);
+
+    //////////////////////////////////////////////////////////////////////////////
+    // DLL registration support
+    /* Autoregistration will try only files with these extensions.
+     * All extensions are case insensitive.
+     * ".dll",    // Windows
+     * ".dso",    // Unix
+     * ".so",     // Unix
+     * ".sl",     // Unix: HP
+     * "_dll",    // Mac
+     * ".dlm",    // new for all platforms
+     */
+    NS_IMETHOD AutoRegister(RegistrationTime when, const char* pathlist);
+    // Pathlist is a semicolon separated list of pathnames
+    NS_IMETHOD AddToDefaultPathList(const char *pathlist);
+    NS_IMETHOD SyncComponentsInPathList(const char *pathlist);
+    NS_IMETHOD SyncComponentsInDir(const char *path);
+    NS_IMETHOD SyncComponentsInFile(const char *fullname);
+
+    // nsComponentManagerImpl methods:
+    nsComponentManagerImpl();
+    virtual ~nsComponentManagerImpl();
+
+    static nsComponentManagerImpl* gComponentManager;
+    nsresult Init(void);
+
+protected:
+    nsresult LoadFactory(nsFactoryEntry *aEntry, nsIFactory **aFactory);
+    nsresult SelfRegisterDll(nsDll *dll);
+    nsresult SelfUnregisterDll(nsDll *dll);
+
+    nsresult PlatformVersionCheck();
+    nsresult PlatformCreateDll(const char *fullname, nsDll* *result);
+    nsresult PlatformMarkNoComponents(nsDll *dll);
+    struct QuickRegisterData {
+        const char *CIDString;	// {98765-8776-8958758759-958785}
+        const char *className;	// "Layout Engine"
+        const char *progID;	// "Gecko.LayoutEngine.1"
+    };
+    nsresult PlatformRegister(QuickRegisterData* regd, nsDll *dll);
+    nsresult PlatformUnregister(QuickRegisterData* regd, const char *aLibrary);
+    nsresult PlatformFind(const nsCID &aCID, nsFactoryEntry* *result);
+    nsresult PlatformProgIDToCLSID(const char *aProgID, nsCID *aClass);
+    nsresult PlatformCLSIDToProgID(nsCID *aClass, char* *aClassName, char* *aProgID);
+	void     PlatformGetFileInfo(nsIRegistry::Key Key,PRTime *lastModifiedTime,PRUint32 *fileSize);
+
+protected:
+    nsHashtable*  mFactories;
+    nsHashtable*  mProgIDs;
+    PRMonitor*    mMon;
+    nsHashtable*  mDllStore;
+	nsIRegistry*  mRegistry;
+};
+
+#define NS_MAX_FILENAME_LEN	1024
+
+#define NS_ERROR_IS_DIR NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_XPCOM, 24)
+
+#ifdef XP_UNIX
+/* The default registry on the unix system is $HOME/.mozilla/registry per
+ * vr_findGlobalRegName(). vr_findRegFile() will create the registry file
+ * if it doesn't exist. But it wont create directories.
+ *
+ * Hence we need to create the directory if it doesn't exist already.
+ *
+ * Why create it here as opposed to the app ?
+ * ------------------------------------------
+ * The app cannot create the directory in main() as most of the registry
+ * and initialization happens due to use of static variables.
+ * And we dont want to be dependent on the order in which
+ * these static stuff happen.
+ *
+ * Permission for the $HOME/.mozilla will be Read,Write,Execute
+ * for user only. Nothing to group and others.
+ */
+#define NS_MOZILLA_DIR_NAME		".mozilla"
+#define NS_MOZILLA_DIR_PERMISSION	00700
+#endif /* XP_UNIX */
+
+/**
+ * When using the registry we put a version number in it.
+ * If the version number that is in the registry doesn't match
+ * the following, we ignore the registry. This lets news versions
+ * of the software deal with old formats of registry and not
+ *
+ * alpha0.20 : First time we did versioning
+ * alpha0.30 : Changing autoreg to begin registration from ./components on unix
+ * alpha0.40 : repository -> component manager
+ * alpha0.50 : using nsIRegistry
+ */
+#define NS_XPCOM_COMPONENT_MANAGER_VERSION_STRING "alpha0.51"
+
+////////////////////////////////////////////////////////////////////////////////
+/**
+ * Class: nsFactoryEntry()
+ *
+ * There are two types of FactoryEntries.
+ *
+ * 1. {CID, dll} mapping.
+ *		Factory is a consequence of the dll. These can be either session
+ *		specific or persistent based on whether we write this
+ *		to the registry or not.
+ *
+ * 2. {CID, factory} mapping
+ *		These are strictly session specific and in memory only.
+ */
+
+class nsFactoryEntry {
+public:
+    nsFactoryEntry();
+    nsFactoryEntry(const nsCID &aClass, nsIFactory *aFactory);
+    ~nsFactoryEntry();
+
+    nsresult Init(nsHashtable* dllHashtable, const nsCID &aClass, const char *aLibrary,
+                  PRTime lastModTime, PRUint32 fileSize);
+
+    nsCID cid;
+    nsIFactory *factory;
+
+    // DO NOT DELETE THIS. Many nsFactoryEntry(s) could be sharing the same Dll.
+    // This gets deleted from the dllStore going away.
+    nsDll *dll;	
+};
+
+////////////////////////////////////////////////////////////////////////////////
+
+#endif // nsComponentManager_h__

mozilla/xpcom/components/nsGenericFactory.cpp

@@ -0,0 +1,88 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsGenericFactory.h"
+
+nsGenericFactory::nsGenericFactory(ConstructorProcPtr constructor)
+	: mConstructor(constructor), mDestructor(NULL)
+{
+	NS_INIT_ISUPPORTS();
+}
+
+nsGenericFactory::~nsGenericFactory()
+{
+	if (mDestructor != NULL)
+		(*mDestructor) ();
+}
+
+NS_METHOD nsGenericFactory::QueryInterface(const nsIID& aIID, void** aInstancePtr)
+{
+    if (NULL == aInstancePtr) {                                            
+        return NS_ERROR_NULL_POINTER;                                        
+    }                                                                      
+    if (aIID.Equals(nsIFactory::GetIID()) ||
+    	aIID.Equals(nsIGenericFactory::GetIID()) ||
+        aIID.Equals(nsISupports::GetIID())) {
+        *aInstancePtr = (void*) this;
+        AddRef();
+        return NS_OK; 
+    } 
+    return NS_NOINTERFACE;
+}
+
+NS_IMPL_ADDREF(nsGenericFactory)
+NS_IMPL_RELEASE(nsGenericFactory)
+
+NS_IMETHODIMP nsGenericFactory::CreateInstance(nsISupports *aOuter, REFNSIID aIID, void **aResult)
+{
+	return mConstructor(aOuter, aIID, aResult);
+}
+
+NS_IMETHODIMP nsGenericFactory::LockFactory(PRBool aLock)
+{
+	return NS_OK;
+}
+
+NS_IMETHODIMP nsGenericFactory::SetConstructor(ConstructorProcPtr constructor)
+{
+	mConstructor = constructor;
+	return NS_OK;
+}
+
+NS_IMETHODIMP nsGenericFactory::SetDestructor(DestructorProcPtr destructor)
+{
+	mDestructor = destructor;
+	return NS_OK;
+}
+
+NS_METHOD nsGenericFactory::Create(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr)
+{
+	// sorry, aggregation not spoken here.
+	nsresult res = NS_ERROR_NO_AGGREGATION;
+	if (outer == NULL) {
+		nsGenericFactory* factory = new nsGenericFactory;
+		if (factory != NULL) {
+			res = factory->QueryInterface(aIID, aInstancePtr);
+			if (res != NS_OK)
+				delete factory;
+		} else {
+			res = NS_ERROR_OUT_OF_MEMORY;
+		}
+	}
+	return res;
+}

mozilla/xpcom/components/nsGenericFactory.h

@@ -0,0 +1,60 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsGenericFactory_h___
+#define nsGenericFactory_h___
+
+#include "nsIGenericFactory.h"
+
+/**
+ * Most factories follow this simple pattern, so why not just use a function pointer
+ * for most creation operations?
+ */
+class nsGenericFactory : public nsIGenericFactory {
+public:
+    static const nsCID& CID() { static nsCID cid = NS_GENERICFACTORY_CID; return cid; }
+
+	nsGenericFactory(ConstructorProcPtr constructor = NULL);
+	virtual ~nsGenericFactory();
+	
+	NS_DECL_ISUPPORTS
+	
+	NS_IMETHOD CreateInstance(nsISupports *aOuter, REFNSIID aIID, void **aResult);
+
+	NS_IMETHOD LockFactory(PRBool aLock);
+
+	/**
+	 * Establishes the generic factory's constructor function, which will be called
+	 * by CreateInstance.
+	 */
+    NS_IMETHOD SetConstructor(ConstructorProcPtr constructor);
+
+	/**
+	 * Establishes the generic factory's destructor function, which will be called
+	 * whe the generic factory is deleted. This is used to notify the DLL that
+	 * an instance of one of its generic factories is going away.
+	 */
+    NS_IMETHOD SetDestructor(DestructorProcPtr destructor);
+
+	static NS_METHOD Create(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr);
+private:
+	ConstructorProcPtr mConstructor;
+	DestructorProcPtr mDestructor;
+};
+
+#endif /* nsGenericFactory_h___ */

mozilla/xpcom/components/nsIComponentManager.h

@@ -0,0 +1,258 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsIComponentManager_h__
+#define nsIComponentManager_h__
+
+#include "prtypes.h"
+#include "nsCom.h"
+#include "nsID.h"
+#include "nsError.h"
+#include "nsISupports.h"
+#include "nsIFactory.h"
+
+/*
+ * Prototypes for dynamic library export functions. Your DLL/DSO needs to export
+ * these methods to play in the component world.
+ */
+
+extern "C" NS_EXPORT nsresult NSGetFactory(nsISupports* aServMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" NS_EXPORT PRBool   NSCanUnload(nsISupports* aServMgr);
+extern "C" NS_EXPORT nsresult NSRegisterSelf(nsISupports* aServMgr, const char *fullpath);
+extern "C" NS_EXPORT nsresult NSUnregisterSelf(nsISupports* aServMgr, const char *fullpath);
+
+typedef nsresult (*nsFactoryProc)(nsISupports* aServMgr,
+                                  const nsCID &aClass,
+                                  const char *aClassName,
+                                  const char *aProgID,
+                                  nsIFactory **aFactory);
+typedef PRBool   (*nsCanUnloadProc)(nsISupports* aServMgr);
+typedef nsresult (*nsRegisterProc)(nsISupports* aServMgr, const char *path);
+typedef nsresult (*nsUnregisterProc)(nsISupports* aServMgr, const char *path);
+
+#define NS_ICOMPONENTMANAGER_IID                     \
+{ /* 8458a740-d5dc-11d2-92fb-00e09805570f */         \
+    0x8458a740,                                      \
+    0xd5dc,                                          \
+    0x11d2,                                          \
+    {0x92, 0xfb, 0x00, 0xe0, 0x98, 0x05, 0x57, 0x0f} \
+}
+
+#define NS_COMPONENTMANAGER_CID                      \
+{ /* 91775d60-d5dc-11d2-92fb-00e09805570f */         \
+    0x91775d60,                                      \
+    0xd5dc,                                          \
+    0x11d2,                                          \
+    {0x92, 0xfb, 0x00, 0xe0, 0x98, 0x05, 0x57, 0x0f} \
+}
+
+/*
+ * nsIComponentManager interface
+ */
+
+class nsIComponentManager : public nsISupports {
+public:
+
+  NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICOMPONENTMANAGER_IID)
+
+  NS_IMETHOD FindFactory(const nsCID &aClass,
+                         nsIFactory **aFactory) = 0;
+
+  // Finds a class ID for a specific Program ID
+  NS_IMETHOD ProgIDToCLSID(const char *aProgID,
+                           nsCID *aClass) = 0;
+  
+  // Finds a Program ID for a specific class ID
+  // caller frees the result with delete[]
+  NS_IMETHOD CLSIDToProgID(nsCID *aClass,
+                           char* *aClassName,
+                           char* *aProgID) = 0;
+  
+  // Creates a class instance for a specific class ID
+  NS_IMETHOD CreateInstance(const nsCID &aClass, 
+                            nsISupports *aDelegate,
+                            const nsIID &aIID,
+                            void **aResult) = 0;
+
+  // Convenience routine, creates a class instance for a specific ProgID
+  NS_IMETHOD CreateInstance(const char *aProgID,
+                            nsISupports *aDelegate,
+                            const nsIID &aIID,
+                            void **aResult) = 0;
+
+  // Creates a class instance for a specific class ID
+  /*
+  NS_IMETHOD CreateInstance2(const nsCID &aClass, 
+                             nsISupports *aDelegate,
+                             const nsIID &aIID,
+                             void *aSignature,
+                             void **aResult) = 0;
+  */
+
+  // Manually registry a factory for a class
+  NS_IMETHOD RegisterFactory(const nsCID &aClass,
+                             const char *aClassName,
+                             const char *aProgID,
+                             nsIFactory *aFactory,
+                             PRBool aReplace) = 0;
+
+  // Manually register a dynamically loaded component.
+  NS_IMETHOD RegisterComponent(const nsCID &aClass,
+                               const char *aClassName,
+                               const char *aProgID,
+                               const char *aLibrary,
+                               PRBool aReplace,
+                               PRBool aPersist) = 0;
+
+  // Manually unregister a factory for a class
+  NS_IMETHOD UnregisterFactory(const nsCID &aClass,
+                               nsIFactory *aFactory) = 0;
+
+  // Manually unregister a dynamically loaded factory for a class
+  NS_IMETHOD UnregisterFactory(const nsCID &aClass,
+                               const char *aLibrary) = 0;
+
+  // Manually unregister a dynamically loaded component
+  NS_IMETHOD UnregisterComponent(const nsCID &aClass,
+                                 const char *aLibrary) = 0;
+
+  // Unload dynamically loaded factories that are not in use
+  NS_IMETHOD FreeLibraries(void) = 0;
+
+  //////////////////////////////////////////////////////////////////////////////
+  // DLL registration support
+  /* Autoregistration will try only files with these extensions.
+   * All extensions are case insensitive.
+   * ".dll",    // Windows
+   * ".dso",    // Unix
+   * ".so",     // Unix
+   * ".sl",     // Unix: HP
+   * "_dll",    // Mac
+   * ".dlm",    // new for all platforms
+   */
+  enum RegistrationTime {
+	NS_Startup = 0,
+	NS_Script = 1,
+	NS_Timer = 2
+  };
+
+  NS_IMETHOD AutoRegister(RegistrationTime when, const char* pathlist) = 0;
+  // Pathlist is a semicolon separated list of pathnames
+  NS_IMETHOD AddToDefaultPathList(const char *pathlist) = 0;
+  NS_IMETHOD SyncComponentsInPathList(const char *pathlist) = 0;
+  NS_IMETHOD SyncComponentsInDir(const char *path) = 0;
+  NS_IMETHOD SyncComponentsInFile(const char *fullname) = 0;
+};
+
+////////////////////////////////////////////////////////////////////////////////
+
+extern NS_COM nsresult
+NS_GetGlobalComponentManager(nsIComponentManager* *result);
+
+////////////////////////////////////////////////////////////////////////////////
+// Global Static Component Manager Methods
+// (for when you need to link with xpcom)
+
+class NS_COM nsComponentManager {
+public:
+  static nsresult Initialize(void);
+
+  // Finds a factory for a specific class ID
+  static nsresult FindFactory(const nsCID &aClass,
+                              nsIFactory **aFactory);
+
+  // Finds a class ID for a specific Program ID
+  static nsresult ProgIDToCLSID(const char *aProgID,
+                                nsCID *aClass);
+  
+  // Finds a Program ID for a specific class ID
+  // caller frees the result with delete[]
+  static nsresult CLSIDToProgID(nsCID *aClass,
+                                char* *aClassName,
+                                char* *aProgID);
+  
+  // Creates a class instance for a specific class ID
+  static nsresult CreateInstance(const nsCID &aClass, 
+                                 nsISupports *aDelegate,
+                                 const nsIID &aIID,
+                                 void **aResult);
+
+  // Convenience routine, creates a class instance for a specific ProgID
+  static nsresult CreateInstance(const char *aProgID,
+                                 nsISupports *aDelegate,
+                                 const nsIID &aIID,
+                                 void **aResult);
+
+  // Creates a class instance for a specific class ID
+  /*
+  static nsresult CreateInstance2(const nsCID &aClass, 
+                                  nsISupports *aDelegate,
+                                  const nsIID &aIID,
+                                  void *aSignature,
+                                  void **aResult);
+  */
+
+  // Manually registry a factory for a class
+  static nsresult RegisterFactory(const nsCID &aClass,
+                                  const char *aClassName,
+                                  const char *aProgID,
+                                  nsIFactory *aFactory,
+                                  PRBool aReplace);
+
+  // Manually register a dynamically loaded component.
+  static nsresult RegisterComponent(const nsCID &aClass,
+                                    const char *aClassName,
+                                    const char *aProgID,
+                                    const char *aLibrary,
+                                    PRBool aReplace,
+                                    PRBool aPersist);
+
+  // Manually unregister a factory for a class
+  static nsresult UnregisterFactory(const nsCID &aClass,
+                                    nsIFactory *aFactory);
+
+  // Manually unregister a dynamically loaded factory for a class
+  static nsresult UnregisterFactory(const nsCID &aClass,
+                                    const char *aLibrary);
+
+  // Manually unregister a dynamically loaded component
+  static nsresult UnregisterComponent(const nsCID &aClass,
+                                      const char *aLibrary);
+
+  // Unload dynamically loaded factories that are not in use
+  static nsresult FreeLibraries(void);
+
+  //////////////////////////////////////////////////////////////////////////////
+  // DLL registration support
+  static nsresult AutoRegister(nsIComponentManager::RegistrationTime when,
+                               const char* pathlist);
+  // Pathlist is a semicolon separated list of pathnames
+  static nsresult AddToDefaultPathList(const char *pathlist);
+  static nsresult SyncComponentsInPathList(const char *pathlist);
+  static nsresult SyncComponentsInDir(const char *path);
+  static nsresult SyncComponentsInFile(const char *fullname);
+
+};
+
+////////////////////////////////////////////////////////////////////////////////
+
+#endif

mozilla/xpcom/components/nsIFactory.h

@@ -0,0 +1,68 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef __nsIFactory_h
+#define __nsIFactory_h
+
+#include "prtypes.h"
+#include "nsISupports.h"
+
+/*
+ * nsIFactory interface
+ */
+
+// {00000001-0000-0000-c000-000000000046}
+#define NS_IFACTORY_IID \
+{ 0x00000001, 0x0000, 0x0000, \
+  { 0xc0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 } }
+
+class nsIFactory: public nsISupports {
+public:
+  static const nsIID& GetIID() { static nsIID iid = NS_IFACTORY_IID; return iid; }
+
+  NS_IMETHOD CreateInstance(nsISupports *aOuter,
+                            REFNSIID aIID,
+                            void **aResult) = 0;
+
+  NS_IMETHOD LockFactory(PRBool aLock) = 0;
+};
+
+#if 0
+/* Excluding IFactory2 until there is proof of its use - dp */
+/**
+ * nsIFactory2 allows passing in a signature token when creating an
+ * instance. This allows instance recycling.
+ */
+
+// {19997C41-A343-11d1-B665-00805F8A2676}
+#define NS_IFACTORY2_IID \
+{ 0x19997c41, 0xa343, 0x11d1, \
+  { 0xb6, 0x65, 0x0, 0x80, 0x5f, 0x8a, 0x26, 0x76 } }
+
+class nsIFactory2: public nsIFactory {
+public:
+  static const nsIID& GetIID() { static nsIID iid = NS_IFACTORY2_IID; return iid; }
+
+  NS_IMETHOD CreateInstance2(nsISupports *aOuter,
+                             REFNSIID aIID,
+                             void *aSignature,
+                             void **aResult) = 0;
+};
+#endif /* 0 */
+
+#endif

mozilla/xpcom/components/nsIFactory.idl

@@ -0,0 +1,33 @@
+/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsISupports.idl"
+%{ C++
+#include "nsCID.h"
+%}
+
+[object, uuid(19997C41-A343-11d1-B665-00805F8A2676)]
+interface nsIFactory :  nsISupports {
+
+  voidStar CreateInstance(in nsISupports aOuter,
+                          in nsIID iid);
+
+  void LockFactory(in boolean lock);
+
+};
+

mozilla/xpcom/components/nsIGenericFactory.h

@@ -1,23 +1,19 @@
 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  *
- * The contents of this file are subject to the Netscape 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/NPL/
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
  *
- * 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.
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
  *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is Netscape
+ * The Initial Developer of this code under the NPL is Netscape
  * Communications Corporation.  Portions created by Netscape are
- * Copyright (C) 1998 Netscape Communications Corporation. All
- * Rights Reserved.
- *
- * Contributor(s): 
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
  */
 
 #ifndef nsIGenericFactory_h___
@@ -33,8 +29,6 @@
 #define NS_IGENERICFACTORY_IID \
 { 0x3bc97f00, 0xccdf, 0x11d2, { 0xba, 0xb8, 0xb5, 0x48, 0x65, 0x44, 0x61, 0xfc } }
 
-#define NS_GENERICFACTORY_PROGID "component:/netscape/generic-factory"
-#define NS_GENERICFACTORY_CLASSNAME "Generic Factory"
 /**
  * Provides a Generic nsIFactory implementation that can be used by
  * DLLs with very simple factory needs.
@@ -60,111 +54,4 @@ public:
     NS_IMETHOD SetDestructor(DestructorProcPtr destructor) = 0;
 };
 
-extern NS_COM nsresult
-NS_NewGenericFactory(nsIGenericFactory* *result,
-                     nsIGenericFactory::ConstructorProcPtr constructor,
-                     nsIGenericFactory::DestructorProcPtr destructor = NULL);
-
-////////////////////////////////////////////////////////////////////////////////
-// Generic Modules
-// 
-// (See xpcom/sample/nsSampleModule.cpp to see how to use this.)
-
-#include "nsIModule.h"
-
-/**
- * Use this type to define a list of module component info to pass to 
- * NS_NewGenericModule. E.g.:
- *     static nsModuleComponentInfo components[] = { ... };
- * See xpcom/sample/nsSampleModule.cpp for more info.
- */
-struct nsModuleComponentInfo {
-    const char*                                 mDescription;
-    nsCID                                       mCID;
-    const char*                                 mProgID;
-    nsIGenericFactory::ConstructorProcPtr       mConstructor;
-};
-
-extern NS_COM nsresult
-NS_NewGenericModule(const char* moduleName,
-                    PRUint32 componentCount,
-                    nsModuleComponentInfo* components,
-                    nsIModule* *result);
-
-#define NS_IMPL_NSGETMODULE(_name, _components)                              \
-extern "C" NS_EXPORT nsresult NSGetModule(nsIComponentManager *servMgr,      \
-                                          nsIFileSpec* location,             \
-                                          nsIModule** result)                \
-{                                                                            \
-    return NS_NewGenericModule((_name),                                      \
-                               sizeof(_components) / sizeof(_components[0]), \
-                               (_components), result);                       \
-}
-
-////////////////////////////////////////////////////////////////////////////////
-
-#define NS_GENERIC_FACTORY_CONSTRUCTOR(_InstanceClass)                          \
-static NS_IMETHODIMP                                                            \
-_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, void **aResult) \
-{                                                                               \
-    nsresult rv;                                                                \
-                                                                                \
-    _InstanceClass * inst;                                                      \
-                                                                                \
-    if (NULL == aResult) {                                                      \
-        rv = NS_ERROR_NULL_POINTER;                                             \
-        return rv;                                                              \
-    }                                                                           \
-    *aResult = NULL;                                                            \
-    if (NULL != aOuter) {                                                       \
-        rv = NS_ERROR_NO_AGGREGATION;                                           \
-        return rv;                                                              \
-    }                                                                           \
-                                                                                \
-    NS_NEWXPCOM(inst, _InstanceClass);                                          \
-    if (NULL == inst) {                                                         \
-        rv = NS_ERROR_OUT_OF_MEMORY;                                            \
-        return rv;                                                              \
-    }                                                                           \
-    NS_ADDREF(inst);                                                            \
-    rv = inst->QueryInterface(aIID, aResult);                                   \
-    NS_RELEASE(inst);                                                           \
-                                                                                \
-    return rv;                                                                  \
-}                                                                               \
-
-
-#define NS_GENERIC_FACTORY_CONSTRUCTOR_INIT(_InstanceClass, _InitMethod)        \
-static NS_IMETHODIMP                                                            \
-_InstanceClass##Constructor(nsISupports *aOuter, REFNSIID aIID, void **aResult) \
-{                                                                               \
-    nsresult rv;                                                                \
-                                                                                \
-    _InstanceClass * inst;                                                      \
-                                                                                \
-    if (NULL == aResult) {                                                      \
-        rv = NS_ERROR_NULL_POINTER;                                             \
-        return rv;                                                              \
-    }                                                                           \
-    *aResult = NULL;                                                            \
-    if (NULL != aOuter) {                                                       \
-        rv = NS_ERROR_NO_AGGREGATION;                                           \
-        return rv;                                                              \
-    }                                                                           \
-                                                                                \
-    NS_NEWXPCOM(inst, _InstanceClass);                                          \
-    if (NULL == inst) {                                                         \
-        rv = NS_ERROR_OUT_OF_MEMORY;                                            \
-        return rv;                                                              \
-    }                                                                           \
-    NS_ADDREF(inst);                                                            \
-	rv = inst->_InitMethod();                                                   \
-    if(NS_SUCCEEDED(rv)) {                                                      \
-        rv = inst->QueryInterface(aIID, aResult);                               \
-    }                                                                           \
-    NS_RELEASE(inst);                                                           \
-                                                                                \
-    return rv;                                                                  \
-}                                                                               \
-
 #endif /* nsIGenericFactory_h___ */

mozilla/xpcom/components/nsIRegistry.h

@@ -0,0 +1,350 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+#ifndef __nsIRegistry_h
+#define __nsIRegistry_h
+
+#include "nsISupports.h"
+
+// {5D41A440-8E37-11d2-8059-00600811A9C3}
+#define NS_IREGISTRY_IID { 0x5d41a440, 0x8e37, 0x11d2, { 0x80, 0x59, 0x0, 0x60, 0x8, 0x11, 0xa9, 0xc3 } }
+#define NS_REGISTRY_PROGID "component://netscape/registry"
+#define NS_REGISTRY_CLASSNAME "Mozilla Registry"
+
+// {D1B54831-AC07-11d2-805E-00600811A9C3}
+#define NS_IREGISTRYNODE_IID { 0xd1b54831, 0xac07, 0x11d2, { 0x80, 0x5e, 0x0, 0x60, 0x8, 0x11, 0xa9, 0xc3 } }
+// {5316C380-B2F8-11d2-A374-0080C6F80E4B}
+#define NS_IREGISTRYVALUE_IID { 0x5316c380, 0xb2f8, 0x11d2, { 0xa3, 0x74, 0x0, 0x80, 0xc6, 0xf8, 0xe, 0x4b } }
+
+
+class nsIEnumerator;
+
+/*-------------------------------- nsIRegistry ---------------------------------
+| This interface provides access to a tree of arbitrary values.                |
+|                                                                              |
+| Each node of the tree contains either a value or a subtree or both.          |
+|                                                                              |
+| The value at any of these leaf nodes can be any of these "primitive" types:  |
+|   o string (null terminated UTF string)                                      |
+|   o array of 32-bit integers                                                 |
+|   o arbitrary array of bytes                                                 |
+|   o file identifier                                                          |
+| Of course, since you can store an arbitrary array of bytes, you can put      |
+| any data you like into a registry (although you have the burden of           |
+| encoding/decoding your data in that case).                                   |
+|                                                                              |
+| Each branch of the tree is labelled with a string "key."  The entire path    |
+| from a given point of the tree to another point further down can be          |
+| presented as a single string composed of each branch's label, concatenated   |
+| to the next, with an intervening forward slash ('/').  The term "key"        |
+| refers to both specific tree branch labels and to such concatenated paths.   |
+|                                                                              |
+| The branches from a given node must have unique labels.  Distinct nodes can  |
+| have branches with the same label.                                           |
+|                                                                              |
+| For example, here's a small registry tree:                                   |
+|                                            |                                 |
+|                                           /\                                 |
+|                                         /    \                               |
+|                                       /        \                             |
+|                                     /            \                           |
+|                              "Classes"          "Users"                      |
+|                                 /                  \                         |
+|                               /                      \                       |
+|                             /                      ["joe"]                   |
+|                           /                          / \                     |
+|                          |                          /   \                    |
+|                         /\                         /     \                   |
+|                       /    \                    "joe"   "bob"                |
+|                     /        \                    /       \                  |
+|                                                  /         \                 |
+|        "{xxxx-xx-1}"       "{xxxx-xx-2}"  ["c:/joe"]   ["d:/Robert"]         |
+|             |                    |                                           |
+|            /\                   /\                                           |
+|          /    \               /    \                                         |
+|        /        \           /        \                                       |
+|    "Library" "Version"  "Library" "Version"                                  |
+|       /         \          /          \                                      |
+| ["foo.dll"]      2   ["bar.dll"]       1                                     |
+|                                                                              |
+| In this example, there are 2 keys under the root: "Classes" and "Users".     |
+| The first denotes a subtree only (which has two subtrees, ...).  The second  |
+| denotes both a value ["joe"] and two subtrees labelled "joe" and "bob".      |
+| The value at the node "/Users" is ["joe"], at "/Users/bob" is ["d:/Robert"]. |
+| The value at "/Classes/{xxxx-xx-1}/Version" is 2.                            |
+|                                                                              |
+| The registry interface provides functions that let you navigate the tree     |
+| and manipulate it's contents.                                                |
+|                                                                              |
+| Please note that the registry itself does not impose any structure or        |
+| meaning on the contents of the tree.  For example, the registry doesn't      |
+| control whether the value at the key "/Users" is the label for the subtree   |
+| with information about the last active user.  That meaning is applied by     |
+| the code that stores these values and uses them for that purpose.            |
+|                                                                              |
+| [Any resemblence between this example and actual contents of any actual      |
+| registry is purely coincidental.]                                            |
+------------------------------------------------------------------------------*/
+struct nsIRegistry : public nsISupports {
+    /*------------------------------ Constants ---------------------------------
+    | The following enumerated types and values are used by the registry       |
+    | interface.                                                               |
+    --------------------------------------------------------------------------*/
+    typedef enum {
+        String = 1,
+        Int32,
+        Bytes,
+        File
+    } DataType;
+
+    /*-------------------------------- Types -----------------------------------
+    | The following data types are used by this interface.  All are basically  |
+    | opaque types.  You obtain objects of these types via certain member      |
+    | function calls and re-use them later (without having to know what they   |
+    | contain).                                                                |
+    |                                                                          |
+    |   Key       - Placeholder to represent a particular node in a registry   |
+    |               tree.  There are 3 enumerated values that correspond to    |
+    |               specific nodes:                                            |
+    |                   Common      - Where most stuff goes.                   |
+    |                   Users       - Special subtree to hold info about       |
+    |                                 "users"; if you don't know what goes     |
+    |                                 here, don't mess with it.                |
+    |                   CurrentUser - Subtree under Users corresponding to     |
+    |                                 whatever user is designed the "current"  |
+    |                                 one; see note above.                     |
+    |               You can specify any of these enumerated values as "keys"   |
+    |               on any member function that takes a nsRegistry::Key.       |
+    |   ValueInfo - Structure describing a registry value.                     |
+    --------------------------------------------------------------------------*/
+    typedef uint32 Key;
+
+    enum { Users = 1, Common = 2, CurrentUser = 3 };
+
+    struct ValueInfo {
+        DataType type;
+        uint32   length;
+    };
+
+  static const nsIID& GetIID() { static nsIID iid = NS_IREGISTRY_IID; return iid; }
+
+    /*--------------------------- Opening/Closing ------------------------------
+    | These functions open the specified registry file (Open() with a non-null |
+    | argument) or the default "standard" registry file (Open() with a null    |
+    | argument or OpenDefault()).                                              |
+    |                                                                          |
+    | Once opened, you can access the registry contents via the read/write     |
+    | or query functions.                                                      |
+    |                                                                          |
+    | The registry file will be closed automatically when the registry object  |
+    | is destroyed.  You can close the file prior to that by using the         |
+    | Close() function.                                                        |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD Open( const char *regFile = 0 ) = 0;
+    NS_IMETHOD OpenDefault() = 0;
+    NS_IMETHOD Close() = 0;
+
+    /*----------------------- Reading/Writing Values ---------------------------
+    | These functions read/write the registry values at a given node.          |
+    |                                                                          |
+    | All functions require you to specify where in the registry key to        |
+    | get/set the value.  The location is specified using two components:      |
+    |   o A "base key" indicating where to start from; this is a value of type |
+    |     nsIRegistry::Key.  You use either one of the special "root" key      |
+    |     values or a subkey obtained via some other member function call.     |
+    |   o A "relative path," expressed as a sequence of subtree names          |
+    |     separated by forward slashes.  This path describes how to get from   |
+    |     the base key to the node at which you want to store the data.  This  |
+    |     component can be a null pointer which means the value goes directly  |
+    |     at the node denoted by the base key.                                 |
+    |                                                                          |
+    | When you request a value of a given type, the data stored at the         |
+    | specified node must be of the type requested.  If not, an error results. |
+    |                                                                          |
+    | GetString - Obtains a newly allocated copy of a string type value.  The  |
+    |             caller is obligated to free the returned string using        |
+    |             PR_Free.                                                     |
+    | SetString - Stores the argument string at the specified node.            |
+    | GetInt    - Obtains an int32 value at the specified node.  The result    |
+    |             is returned into an int32 location you specify.              |
+    | SetInt    - Stores a given int32 value at a node.                        |
+    | GetBytes  - Obtains a byte array value; this returns both an allocated   |
+    |             array of bytes and a length (necessary because there may be  |
+    |             embedded null bytes in the array).  You must free the        |
+    |             resulting array using PR_Free.                               |
+    | SetBytes  - Stores a given array of bytes; you specify the bytes via a   |
+    |             pointer and a length.                                        |
+    | GetIntArray - Obtains the array of int32 values stored at a given node.  |
+    |             The result is composed of two values: a pointer to an        |
+    |             array of integer values (which must be freed using           |
+    |             PR_Free) and the number of elements in that array.           |
+    | SetIntArray - Stores a set of int32 values at a given node.  You must    |
+    |             provide a pointer to the array and the number of entries.    |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD GetString( Key baseKey, const char *path, char **result ) = 0;
+    NS_IMETHOD SetString( Key baseKey, const char *path, const char *value ) = 0;
+    NS_IMETHOD GetInt( Key baseKey, const char *path, int32 *result ) = 0;
+    NS_IMETHOD SetInt( Key baseKey, const char *path, int32 value ) = 0;
+    NS_IMETHOD GetBytes( Key baseKey, const char *path, void **result, uint32 *len ) = 0;
+    NS_IMETHOD SetBytes( Key baseKey, const char *path, void *value, uint32 len ) = 0;
+    NS_IMETHOD GetIntArray( Key baseKey, const char *path, int32 **result, uint32 *len ) = 0;
+    NS_IMETHOD SetIntArray( Key baseKey, const char *path, const int32 *value, uint32 len ) = 0;
+
+    /*------------------------------ Navigation --------------------------------
+    | These functions let you navigate through the registry tree, querying     |
+    | its contents.                                                            |
+    |                                                                          |
+    | As above, all these functions requires a starting tree location ("base   |
+    | key")  specified as a nsIRegistry::Key.  Some also require a path        |
+    | name to locate the registry node location relative to this base key.     |
+    |                                                                          |
+    | AddSubtree           - Adds a new registry subtree at the specified      |
+    |                        location.  Returns the resulting key in           |
+    |                        the location specified by the third argument      |
+    |                        (unless that pointer is 0).                       |
+	| AddSubtreeRaw        - Adds a new registry subtree at the specified      |
+    |                        location.  Returns the resulting key in           |
+    |                        the location specified by the third argument      |
+    |                        (unless that pointer is 0).                       |
+	|                        Does not interpret special chars in key names.    |
+    |                                                                          |
+    | RemoveSubtree        - Removes the specified registry subtree or         |
+    |                        value at the specified location.                  |
+    | RemoveSubtreeRaw     - Removes the specified registry subtree or         |
+    |                        value at the specified location.                  |
+    |                        Does not interpret special chars in key names.    |
+    |                                                                          |
+    | GetSubtree           - Returns a nsIRegistry::Key that can be used       |
+    |                        to refer to the specified registry location.      |
+	| GetSubtreeRaw        - Returns a nsIRegistry::Key that can be used       |
+    |                        to refer to the specified registry location.      |
+	|                        Does not interpret special chars in key names.    |
+    |                                                                          |
+    | EnumerateSubtrees    - Returns a nsIEnumerator object that you can       |
+    |                        use to enumerate all the subtrees descending      |
+    |                        from a specified location.  You must free the     |
+    |                        enumerator via Release() when you're done with    |
+    |                        it.                                               |
+    | EnumerateAllSubtrees - Like EnumerateSubtrees, but will recursively      |
+    |                        enumerate lower-level subtrees, too.              |
+    | GetValueInfo         - Returns a uint32 value that designates the type   |
+    |                        of data stored at this location in the registry;  |
+    |                        the possible values are defined by the enumerated |
+    |                        type nsIRegistry::DataType.                       |
+    | GetValueLength       - Returns a uint32 value that indicates the length  |
+    |                        of this registry value; the length is the number  |
+    |                        of characters (for Strings), the number of bytes  |
+    |                        (for Bytes), or the number of int32 values (for   |
+    |                        Int32).                                           |
+    | EnumerateValues      - Returns a nsIEnumerator that you can use to       |
+    |                        enumerate all the value nodes descending from     |
+    |                        a specified location.                             |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD AddSubtree( Key baseKey, const char *path, Key *result ) = 0;
+    NS_IMETHOD RemoveSubtree( Key baseKey, const char *path ) = 0;
+    NS_IMETHOD GetSubtree( Key baseKey, const char *path, Key *result ) = 0;
+
+	NS_IMETHOD AddSubtreeRaw( Key baseKey, const char *keyname, Key *result ) = 0;
+    NS_IMETHOD RemoveSubtreeRaw( Key baseKey, const char *keyname ) = 0;
+	NS_IMETHOD GetSubtreeRaw( Key baseKey, const char *keyname, Key *result ) = 0;
+
+    NS_IMETHOD EnumerateSubtrees( Key baseKey, nsIEnumerator **result ) = 0;
+    NS_IMETHOD EnumerateAllSubtrees( Key baseKey, nsIEnumerator **result ) = 0;
+
+    NS_IMETHOD GetValueType( Key baseKey, const char *path, uint32 *result ) = 0;
+    NS_IMETHOD GetValueLength( Key baseKey, const char *path, uint32 *result ) = 0;
+
+    NS_IMETHOD EnumerateValues( Key baseKey, nsIEnumerator **result ) = 0;
+
+    /*------------------------------ User Name ---------------------------------
+    | These functions manipulate the current "user name."  This value controls |
+    | the behavior of certain registry functions (namely, ?).                  |
+    |                                                                          |
+    | GetCurrentUserName allocates a copy of the current user name (which the  |
+    | caller should free using PR_Free).                                       |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD GetCurrentUserName( char **result ) = 0;
+    NS_IMETHOD SetCurrentUserName( const char *name ) = 0;
+
+    /*------------------------------ Utilities ---------------------------------
+    | Various utility functions:                                               |
+    |                                                                          |
+    | Pack() is used to compress the contents of an open registry file.        |
+    --------------------------------------------------------------------------*/
+    NS_IMETHOD Pack() = 0;
+
+}; // nsIRegistry
+
+/*------------------------------ nsIRegistryNode -------------------------------
+| This interface is implemented by all the objects obtained from the           |
+| nsIEnumerators that nsIRegistry provides when you call either of the         |
+| subtree enumeration functions EnumerateSubtrees or EnumerateAllSubtrees.     |
+|                                                                              |
+| You can call this function to get the name of this subtree.  This is the     |
+| relative path from the base key from which you got this interface.           |
+|                                                                              |
+|   GetName - Returns the path name of this node; this is the relative path    |
+|             from the base key from which this subtree was obtained.  The     |
+|             function allocates a copy of the name; the caller must free it   |
+|             using PR_Free.                                                   |
+------------------------------------------------------------------------------*/
+struct nsIRegistryNode : public nsISupports {
+    NS_IMETHOD GetName( char **result ) = 0;
+}; // nsIRegistryNode
+
+/*------------------------------ nsIRegistryValue ------------------------------
+| This interface is implemented by the objects obtained from the               |
+| nsIEnumerators that nsIRegistry provides when you call the                   |
+| EnumerateValues function.  An object supporting this interface is            |
+| returned when you call the CurrentItem() function on that enumerator.        |
+|                                                                              |
+| You use the member functions of this interface to obtain information         |
+| about each registry value.                                                   |
+|                                                                              |
+|   GetName      - Returns the path name of this node; this is the relative    |
+|                  path\ from the base key from which this value was obtained. |
+|                  The function allocates a copy of the name; the caller must  |
+|                  subsequently free it via PR_Free.                           |
+|   GetValueType - Returns (into a location provided by the caller) the type   |
+|                  of the value; the types are defined by the enumerated       |
+|                  type nsIRegistry::DataType.                                 |
+|   GetValueLength - Returns a uint32 value that indicates the length          |
+|                    of this registry value; the length is the number          |
+|                    of characters (for Strings), the number of bytes          |
+|                    (for Bytes), or the number of int32 values (for           |
+|                    Int32).                                                   |
+------------------------------------------------------------------------------*/
+struct nsIRegistryValue : public nsISupports {
+    NS_IMETHOD GetName( char **result ) = 0;
+    NS_IMETHOD GetValueType( uint32 *result ) = 0;
+    NS_IMETHOD GetValueLength( uint32 *result ) = 0;
+}; // nsIRegistryEntry
+
+
+/*------------------------------- Error Codes ----------------------------------
+------------------------------------------------------------------------------*/
+#define NS_ERROR_REG_BADTYPE          NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 1 )
+#define NS_ERROR_REG_NO_MORE          NS_ERROR_GENERATE_SUCCESS( NS_ERROR_MODULE_REG, 2 )
+#define NS_ERROR_REG_NOT_FOUND        NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 3 )
+#define NS_ERROR_REG_NOFILE	          NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 4 )
+#define NS_ERROR_REG_BUFFER_TOO_SMALL NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 5 )
+#define NS_ERROR_REG_NAME_TOO_LONG    NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 6 )
+#define NS_ERROR_REG_NO_PATH          NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 7 )
+#define NS_ERROR_REG_READ_ONLY        NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 8 )
+#define NS_ERROR_REG_BAD_UTF8         NS_ERROR_GENERATE_FAILURE( NS_ERROR_MODULE_REG, 9 )
+
+#endif

mozilla/xpcom/components/nsIServiceManager.h

@@ -0,0 +1,361 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef nsIServiceManager_h___
+#define nsIServiceManager_h___
+
+#include "nsIComponentManager.h"
+#include "nsID.h"
+
+class nsIShutdownListener;
+
+#define NS_ISERVICEMANAGER_IID                       \
+{ /* cf0df3b0-3401-11d2-8163-006008119d7a */         \
+    0xcf0df3b0,                                      \
+    0x3401,                                          \
+    0x11d2,                                          \
+    {0x81, 0x63, 0x00, 0x60, 0x08, 0x11, 0x9d, 0x7a} \
+}
+
+/**
+ * The nsIServiceManager manager interface provides a means to obtain
+ * global services in an application. The service manager depends on the 
+ * repository to find and instantiate factories to obtain services.
+ *
+ * Users of the service manager must first obtain a pointer to the global
+ * service manager by calling NS_GetGlobalServiceManager. After that, 
+ * they can request specific services by calling GetService. When they are
+ * finished with a service the release it by calling ReleaseService (instead
+ * of releasing the service object directly):
+ *
+ *    nsICacheManager* cm;
+ *    nsServiceManager::GetService(kCacheManagerCID, kICacheManagerIID, (nsISupports**)&cm);
+ *
+ *    ... use cm, and then sometime later ...
+ *
+ *    nsServiceManager::ReleaseService(kCacheManagerCID, cm);
+ *
+ * A user of a service may keep references to particular services indefinitely
+ * and only must call ReleaseService when it shuts down. However if the user
+ * wishes to voluntarily cooperate with the shutdown of the service it is 
+ * using, it may supply an nsIShutdownListener to provide for asynchronous
+ * release of the services it is using. The shutdown listener's OnShutdown
+ * method will be called for a service that is being shut down, and it is
+ * its responsiblity to release references obtained from that service if at
+ * all possible.
+ *
+ * The process of shutting down a particular service is initiated by calling
+ * the service manager's ShutdownService method. This will iterate through
+ * all the registered shutdown listeners for the service being shut down, and
+ * then will attempt to unload the library associated with the service if
+ * possible. The status result of ShutdownService indicates whether the 
+ * service was successfully shut down, failed, or was not in service.
+ *
+ * XXX QUESTIONS:
+ * - Should a "service" be more than nsISupports? Should it be a factory 
+ *   and/or have Startup(), Shutdown(), etc.
+ * - If the asynchronous OnShutdown operation gets called, does the user
+ *   of a service still need to call ReleaseService? (Or should they _not_
+ *   call it?)
+ */
+class nsIServiceManager : public nsISupports {
+public:
+
+    NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISERVICEMANAGER_IID);
+
+    /**
+     * RegisterService may be called explicitly to register a service
+     * with the service manager. If a service is not registered explicitly,
+     * the component manager will be used to create an instance according
+     * to the class ID specified.
+     */
+    NS_IMETHOD
+    RegisterService(const nsCID& aClass, nsISupports* aService) = 0;
+
+    /**
+     * Requests a service to be shut down, possibly unloading its DLL.
+     *
+     * @returns NS_OK - if shutdown was successful and service was unloaded,
+     * @returns NS_ERROR_SERVICE_NOT_FOUND - if shutdown failed because
+     *          the service was not currently loaded
+     * @returns NS_ERROR_SERVICE_IN_USE - if shutdown failed because some
+     *          user of the service wouldn't voluntarily release it by using
+     *          a shutdown listener.
+     */
+    NS_IMETHOD
+    UnregisterService(const nsCID& aClass) = 0;
+
+    NS_IMETHOD
+    GetService(const nsCID& aClass, const nsIID& aIID,
+               nsISupports* *result,
+               nsIShutdownListener* shutdownListener = NULL) = 0;
+
+    NS_IMETHOD
+    ReleaseService(const nsCID& aClass, nsISupports* service,
+                   nsIShutdownListener* shutdownListener = NULL) = 0;
+
+    ////////////////////////////////////////////////////////////////////////////
+    // let's do it again, this time with ProgIDs...
+
+    NS_IMETHOD
+    RegisterService(const char* aProgID, nsISupports* aService) = 0;
+
+    NS_IMETHOD
+    UnregisterService(const char* aProgID) = 0;
+
+    NS_IMETHOD
+    GetService(const char* aProgID, const nsIID& aIID,
+               nsISupports* *result,
+               nsIShutdownListener* shutdownListener = NULL) = 0;
+
+    NS_IMETHOD
+    ReleaseService(const char* aProgID, nsISupports* service,
+                   nsIShutdownListener* shutdownListener = NULL) = 0;
+
+};
+
+#define NS_ERROR_SERVICE_NOT_FOUND      NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_XPCOM, 22)
+#define NS_ERROR_SERVICE_IN_USE         NS_ERROR_GENERATE_SUCCESS(NS_ERROR_MODULE_XPCOM, 23)
+
+////////////////////////////////////////////////////////////////////////////////
+
+#define NS_ISHUTDOWNLISTENER_IID                     \
+{ /* 56decae0-3406-11d2-8163-006008119d7a */         \
+    0x56decae0,                                      \
+    0x3406,                                          \
+    0x11d2,                                          \
+    {0x81, 0x63, 0x00, 0x60, 0x08, 0x11, 0x9d, 0x7a} \
+}
+
+class nsIShutdownListener : public nsISupports {
+public:
+
+    NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISHUTDOWNLISTENER_IID);
+
+    NS_IMETHOD
+    OnShutdown(const nsCID& aClass, nsISupports* service) = 0;
+
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// Interface to Global Services
+
+class NS_COM nsServiceManager {
+public:
+
+    static nsresult RegisterService(const nsCID& aClass, nsISupports* aService);
+
+    static nsresult UnregisterService(const nsCID& aClass);
+
+    static nsresult GetService(const nsCID& aClass, const nsIID& aIID,
+                               nsISupports* *result,
+                               nsIShutdownListener* shutdownListener = NULL);
+
+    static nsresult ReleaseService(const nsCID& aClass, nsISupports* service,
+                                   nsIShutdownListener* shutdownListener = NULL);
+
+    // Since the global Service Manager is truly global, there's no need to
+    // release it.
+    static nsresult GetGlobalServiceManager(nsIServiceManager* *result);
+
+    // This method can be called when shutting down the application. It  
+    // releases all the global services, and deletes the global service manager.
+    static nsresult ShutdownGlobalServiceManager(nsIServiceManager* *result);
+
+    static nsIServiceManager* mGlobalServiceManager;
+
+};
+
+////////////////////////////////////////////////////////////////////////////////
+// nsService: Template to make using services easier. Now you can replace this:
+//
+//      nsIMyService* service;
+//      rv = nsServiceManager::GetService(cid, iid, &service);
+//      if (NS_SUCCEEDED(rv)) {
+//              service->Doit(...);     // use my service
+//              rv = nsServiceManager::ReleaseService(cid, service);
+//      }
+//
+// with this:
+//
+//      nsService<nsIMyService> service(cid, &rv);
+//      if (NS_SUCCEEDED(rv)) {
+//              service->Doit(...);     // use my service
+//      }
+//
+// and the automatic destructor will take care of releasing the service.
+
+#if 0   // sorry the T::GetIID() construct doesn't work with egcs
+
+template<class T> class nsService {
+protected:
+  nsCID mCID;
+  T* mService;
+
+public:
+  nsService(nsISupports* aServMgr, const nsCID& aClass, nsresult *rv)
+    : mCID(aClass), mService(0)
+  {
+    nsIServiceManager* servMgr;
+    *rv = aServMgr->QueryInterface(nsIServiceManager::GetIID(), (void**)&servMgr);
+    if (NS_SUCCEEDED(*rv)) {
+      *rv = servMgr->GetService(mCID, T::GetIID(), (nsISupports**)&mService);
+      NS_RELEASE(servMgr);
+    }
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get service.");
+  }
+
+  nsService(nsISupports* aServMgr, const char* aProgID, nsresult *rv)
+    : mService(0)
+  {
+    *rv = nsComponentManager::ProgIDToCLSID(aProgID, &mCID);
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get CLSID.");
+    if (NS_FAILED(*rv)) return;
+  
+    nsIServiceManager* servMgr;
+    *rv = aServMgr->QueryInterface(nsIServiceManager::GetIID(), (void**)&servMgr);
+    if (NS_SUCCEEDED(*rv)) {
+      *rv = servMgr->GetService(mCID, T::GetIID(), (nsISupports**)&mService);
+      NS_RELEASE(servMgr);
+    }
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get service.");
+  }
+
+  nsService(const nsCID& aClass, nsresult *rv)
+    : mCID(aClass), mService(0) {
+    *rv = nsServiceManager::GetService(aClass, T::GetIID(),
+                                       (nsISupports**)&mService);
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get service.");
+  }
+
+  ~nsService() {
+    if (mService) {       // mService could be null if the constructor fails
+      nsresult rv = nsServiceManager::ReleaseService(mCID, mService);
+      NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't release service.");
+    }
+  }
+
+  T* operator->() const {
+    NS_PRECONDITION(mService != 0, "Your code should test the error result from the constructor.");
+    return mService;
+  }
+
+  PRBool operator==(const T* other) {
+    return mService == other;
+  }
+
+  operator T*() const {
+    return mService;
+  }
+
+};
+
+#else
+
+class nsService {
+protected:
+  nsCID mCID;
+  nsISupports* mService;
+
+public:
+  nsService(nsISupports* aServMgr, const nsCID& aClass, const nsIID& aIID, nsresult *rv)
+    : mCID(aClass), mService(0)
+  {
+    nsIServiceManager* servMgr;
+    *rv = aServMgr->QueryInterface(nsIServiceManager::GetIID(), (void**)&servMgr);
+    if (NS_SUCCEEDED(*rv)) {
+      *rv = servMgr->GetService(mCID, aIID, &mService);
+      NS_RELEASE(servMgr);
+    }
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get service.");
+  }
+
+  nsService(nsISupports* aServMgr, const char* aProgID, const nsIID& aIID, nsresult *rv)
+    : mService(0)
+  {
+    *rv = nsComponentManager::ProgIDToCLSID(aProgID, &mCID);
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get CLSID.");
+    if (NS_FAILED(*rv)) return;
+  
+    nsIServiceManager* servMgr;
+    *rv = aServMgr->QueryInterface(nsIServiceManager::GetIID(), (void**)&servMgr);
+    if (NS_SUCCEEDED(*rv)) {
+      *rv = servMgr->GetService(mCID, aIID, &mService);
+      NS_RELEASE(servMgr);
+    }
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get service.");
+  }
+
+  nsService(const nsCID& aClass, const nsIID& aIID, nsresult *rv)
+    : mCID(aClass), mService(0) {
+    *rv = nsServiceManager::GetService(aClass, aIID,
+                                       (nsISupports**)&mService);
+    NS_ASSERTION(NS_SUCCEEDED(*rv), "Couldn't get service.");
+  }
+
+  ~nsService() {
+    if (mService) {       // mService could be null if the constructor fails
+      nsresult rv = NS_OK;
+      rv = nsServiceManager::ReleaseService(mCID, mService);
+      NS_ASSERTION(NS_SUCCEEDED(rv), "Couldn't release service.");
+    }
+  }
+
+  nsISupports* operator->() const {
+    NS_PRECONDITION(mService != 0, "Your code should test the error result from the constructor.");
+    return mService;
+  }
+
+  PRBool operator==(const nsISupports* other) {
+    return mService == other;
+  }
+
+  operator nsISupports*() const {
+    return mService;
+  }
+
+};
+
+#define NS_WITH_SERVICE(T, var, cid, rvAddr)      \
+  nsService _serv##var(cid, T::GetIID(), rvAddr); \
+  T* var = (T*)(nsISupports*)_serv##var;
+
+#define NS_WITH_SERVICE1(T, var, isupports, cid, rvAddr)     \
+  nsService _serv##var(isupports, cid, T::GetIID(), rvAddr); \
+  T* var = (T*)(nsISupports*)_serv##var;
+
+#endif
+
+////////////////////////////////////////////////////////////////////////////////
+// NS_NewServiceManager: For when you want to create a service manager
+// in a given context.
+
+extern NS_COM nsresult
+NS_NewServiceManager(nsIServiceManager* *result);
+
+////////////////////////////////////////////////////////////////////////////////
+// Initialization of XPCOM. Creates the global ComponentManager, ServiceManager
+// and registers xpcom components with the ComponentManager. Should be called
+// before any call can be made to XPCOM. Currently we are coping with this
+// not being called and internally initializing XPCOM if not already.
+extern NS_COM nsresult
+NS_InitXPCOM(nsIServiceManager* *result);
+
+////////////////////////////////////////////////////////////////////////////////
+
+#endif /* nsIServiceManager_h___ */

mozilla/xpcom/components/nsIServiceProvider.h

@@ -0,0 +1,31 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef __nsIServerProvider_h
+#define __nsIServerProvider_h
+#include "nsISupports.h"
+
+typedef nsID nsSID;
+#define NSSIDREF const nsSID&
+
+class nsIServiceProvider: public nsISupports {
+public:
+  NS_IMETHOD QueryService(NSSIDREF aSID, NSIIDREF sIID, (void **) pService);
+};
+
+#endif /* __nsIServerProvider_h */

mozilla/xpcom/components/nsMacRepository.h

@@ -0,0 +1,164 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+#ifdef XP_MAC
+#ifdef MOZ_NGLAYOUT
+
+#error "nsMacRepository.h became obsolete when the shared lib conversion was completed."
+
+// The Mac NGLayout is not based on shared libraries yet.
+// All the DLLs are built as static libraries and we present them as
+// shared libraries by redefining PR_LoadLibrary(), PR_UnloadLibrary()
+// and PR_FindSymbol() below.
+//
+// If you add or remove shared libraries on other platforms, you must
+//	- Add the library name to the defines below.
+//	- Rename the "NSGetFactory" and "NSCanUnload" procs for the Mac:
+//    just append the library name to the function name.
+//	- Add the library and its procs to the static list below.
+
+
+typedef struct MacLibrary
+{
+	char *			name;
+	nsFactoryProc	factoryProc;
+	nsCanUnloadProc	unloadProc;
+} MacLibrary;
+
+// library names
+#define WIDGET_DLL		"WIDGET_DLL"
+#define GFXWIN_DLL		"GFXWIN_DLL"
+#define VIEW_DLL		"VIEW_DLL"
+#define WEB_DLL			"WEB_DLL"
+#define PLUGIN_DLL		"PLUGIN_DLL"
+#define PREF_DLL		"PREF_DLL"
+#define PARSER_DLL		"PARSER_DLL"
+#define DOM_DLL    		"DOM_DLL"
+#define LAYOUT_DLL		"LAYOUT_DLL"
+#define NETLIB_DLL		"NETLIB_DLL"
+#define EDITOR_DLL		"EDITOR_DLL"
+
+#ifdef IMPL_MAC_REPOSITORY
+
+extern "C" nsresult		NSGetFactory_WIDGET_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_GFXWIN_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_VIEW_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_WEB_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+#if 0
+extern "C" nsresult		NSGetFactory_PLUGIN_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+#endif
+extern "C" nsresult		NSGetFactory_PREF_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_PARSER_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_DOM_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_LAYOUT_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_NETLIB_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+extern "C" nsresult		NSGetFactory_EDITOR_DLL(nsISupports* serviceMgr,
+                                           const nsCID &aClass,
+                                           const char *aClassName,
+                                           const char *aProgID,
+                                           nsIFactory **aFactory);
+
+extern "C" PRBool		NSCanUnload_PREF_DLL(void);
+
+// library list
+static MacLibrary	libraries[] = {
+#if 0
+	WIDGET_DLL,		NSGetFactory_WIDGET_DLL,	NULL,
+	GFXWIN_DLL,		NSGetFactory_GFXWIN_DLL,	NULL,
+	VIEW_DLL,		NSGetFactory_VIEW_DLL,		NULL,
+	WEB_DLL,		NSGetFactory_WEB_DLL,		NULL,
+	//PLUGIN_DLL,		NSGetFactory_PLUGIN_DLL,	NULL,
+	PREF_DLL,		NSGetFactory_PREF_DLL,		NSCanUnload_PREF_DLL,
+	PARSER_DLL,		NSGetFactory_PARSER_DLL,	NULL,
+	DOM_DLL,		NSGetFactory_DOM_DLL,		NULL,
+	LAYOUT_DLL,		NSGetFactory_LAYOUT_DLL,	NULL,
+	NETLIB_DLL,		NSGetFactory_NETLIB_DLL,	NULL,
+	//EDITOR_DLL,		NSGetFactory_EDITOR_DLL,	NULL,		// FIX ME
+#endif
+	NULL
+};
+
+static void* FindMacSymbol(char* libName, const char *symbolName)
+{
+	MacLibrary * macLib;
+
+	for (macLib = libraries; ; macLib ++)
+	{
+		if (macLib->name == NULL)
+			return NULL;
+
+		if (PL_strcmp(macLib->name, libName) == 0)
+			break;
+	}
+
+	if (PL_strcmp(symbolName, "NSGetFactory") == 0) {
+		return macLib->factoryProc;
+	}
+	else if (PL_strcmp(symbolName, "NSCanUnload") == 0) {
+		return macLib->unloadProc;
+	}
+	return NULL;
+}
+
+#define PR_LoadLibrary(libName)			(PRLibrary *)libName
+#define PR_UnloadLibrary(lib)			lib = NULL
+#define PR_FindSymbol(lib, symbolName)	FindMacSymbol((char*)lib, symbolName)
+
+#endif // IMPL_MAC_REPOSITORY
+
+#endif // MOZ_NGLAYOUT
+#endif // XP_MAC

mozilla/xpcom/components/nsRepository.cpp

@@ -0,0 +1,194 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsIComponentManager.h"
+
+nsresult
+nsComponentManager::Initialize(void)
+{
+    return NS_OK;
+}
+
+nsresult
+nsComponentManager::FindFactory(const nsCID &aClass,
+                                nsIFactory **aFactory)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->FindFactory(aClass, aFactory);
+}
+
+nsresult
+nsComponentManager::ProgIDToCLSID(const char *aProgID,
+                                  nsCID *aClass)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->ProgIDToCLSID(aProgID, aClass);
+}
+  
+nsresult
+nsComponentManager::CLSIDToProgID(nsCID *aClass,
+                                  char* *aClassName,
+                                  char* *aProgID)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->CLSIDToProgID(aClass, aClassName, aProgID);
+}
+  
+nsresult
+nsComponentManager::CreateInstance(const nsCID &aClass, 
+                                   nsISupports *aDelegate,
+                                   const nsIID &aIID,
+                                   void **aResult)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->CreateInstance(aClass, aDelegate, aIID, aResult);
+}
+
+nsresult
+nsComponentManager::CreateInstance(const char *aProgID,
+                                   nsISupports *aDelegate,
+                                   const nsIID &aIID,
+                                   void **aResult)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->CreateInstance(aProgID, aDelegate, aIID, aResult);
+}
+
+nsresult
+nsComponentManager::RegisterFactory(const nsCID &aClass,
+                                    const char *aClassName,
+                                    const char *aProgID,
+                                    nsIFactory *aFactory,
+                                    PRBool aReplace)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->RegisterFactory(aClass, aClassName, aProgID,
+                               aFactory, aReplace);
+}
+
+nsresult
+nsComponentManager::RegisterComponent(const nsCID &aClass,
+                                      const char *aClassName,
+                                      const char *aProgID,
+                                      const char *aLibrary,
+                                      PRBool aReplace,
+                                      PRBool aPersist)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->RegisterComponent(aClass, aClassName, aProgID,
+                                 aLibrary, aReplace, aPersist);
+}
+
+nsresult
+nsComponentManager::UnregisterFactory(const nsCID &aClass,
+                                      nsIFactory *aFactory)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->UnregisterFactory(aClass, aFactory);
+}
+
+nsresult
+nsComponentManager::UnregisterFactory(const nsCID &aClass,
+                                      const char *aLibrary)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->UnregisterFactory(aClass, aLibrary);
+}
+
+nsresult
+nsComponentManager::UnregisterComponent(const nsCID &aClass,
+                                        const char *aLibrary)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->UnregisterComponent(aClass, aLibrary);
+}
+
+nsresult
+nsComponentManager::FreeLibraries(void)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->FreeLibraries();
+}
+
+nsresult
+nsComponentManager::AutoRegister(nsIComponentManager::RegistrationTime when,
+                                 const char* pathlist)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->AutoRegister(when, pathlist);
+}
+
+nsresult
+nsComponentManager::AddToDefaultPathList(const char *pathlist)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->AddToDefaultPathList(pathlist);
+}
+
+nsresult
+nsComponentManager::SyncComponentsInPathList(const char *pathlist)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->SyncComponentsInPathList(pathlist);
+}
+
+nsresult
+nsComponentManager::SyncComponentsInDir(const char *path)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->SyncComponentsInDir(path);
+}
+
+nsresult
+nsComponentManager::SyncComponentsInFile(const char *fullname)
+{
+    nsIComponentManager* cm;
+    nsresult rv = NS_GetGlobalComponentManager(&cm);
+    if (NS_FAILED(rv)) return rv;
+    return cm->SyncComponentsInFile(fullname);
+}

mozilla/xpcom/components/nsRepository.h

@@ -0,0 +1,28 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#ifndef __nsRespository_h
+#define __nsRespository_h
+
+#include "nsIComponentManager.h"
+
+// XXX nsRepository is obsolete! Use nsComponentManager now!
+
+#define nsRepository            nsComponentManager
+
+#endif

mozilla/xpcom/components/nsServiceManager.cpp

@@ -0,0 +1,560 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+#include "nsIServiceManager.h"
+#include "nsVector.h"
+#include "nsHashtable.h"
+#include "prcmon.h"
+#include "prthread.h" /* XXX: only used for the NSPR initialization hack (rick) */
+
+static NS_DEFINE_CID(kComponentManagerCID, NS_COMPONENTMANAGER_CID);
+
+class nsServiceEntry {
+public:
+
+    nsServiceEntry(const nsCID& cid, nsISupports* service);
+    ~nsServiceEntry();
+
+    nsresult AddListener(nsIShutdownListener* listener);
+    nsresult RemoveListener(nsIShutdownListener* listener);
+    nsresult NotifyListeners(void);
+
+    const nsCID& mClassID;
+    nsISupports* mService;
+    nsVector* mListeners;        // nsVector<nsIShutdownListener>
+    PRBool mShuttingDown;
+
+};
+
+nsServiceEntry::nsServiceEntry(const nsCID& cid, nsISupports* service)
+    : mClassID(cid), mService(service), mListeners(NULL), mShuttingDown(PR_FALSE)
+{
+}
+
+nsServiceEntry::~nsServiceEntry()
+{
+    if (mListeners) {
+        NS_ASSERTION(mListeners->GetSize() == 0, "listeners not removed or notified");
+#if 0
+        PRUint32 size = mListeners->GetSize();
+        for (PRUint32 i = 0; i < size; i++) {
+            nsIShutdownListener* listener = (nsIShutdownListener*)(*mListeners)[i];
+            NS_RELEASE(listener);
+        }
+#endif
+        delete mListeners;
+    }
+}
+
+nsresult
+nsServiceEntry::AddListener(nsIShutdownListener* listener)
+{
+    if (listener == NULL)
+        return NS_OK;
+    if (mListeners == NULL) {
+        mListeners = new nsVector();
+        if (mListeners == NULL)
+            return NS_ERROR_OUT_OF_MEMORY;
+    }
+    PRInt32 rv = mListeners->Add(listener);
+    NS_ADDREF(listener);
+    return rv == -1 ? NS_ERROR_FAILURE : NS_OK;
+}
+
+nsresult
+nsServiceEntry::RemoveListener(nsIShutdownListener* listener)
+{
+    if (listener == NULL)
+        return NS_OK;
+    NS_ASSERTION(mListeners, "no listeners added yet");
+    PRUint32 size = mListeners->GetSize();
+    for (PRUint32 i = 0; i < size; i++) {
+        if ((*mListeners)[i] == listener) {
+            mListeners->Remove(i);
+            NS_RELEASE(listener);
+            return NS_OK;
+        }
+    }
+    NS_ASSERTION(0, "unregistered shutdown listener");
+    return NS_ERROR_FAILURE;
+}
+
+nsresult
+nsServiceEntry::NotifyListeners(void)
+{
+    if (mListeners) {
+        PRUint32 size = mListeners->GetSize();
+        for (PRUint32 i = 0; i < size; i++) {
+            nsIShutdownListener* listener = (nsIShutdownListener*)(*mListeners)[0];
+            nsresult rv = listener->OnShutdown(mClassID, mService);
+            if (NS_FAILED(rv)) return rv;
+            NS_RELEASE(listener);
+            mListeners->Remove(0);
+        }
+        NS_ASSERTION(mListeners->GetSize() == 0, "failed to notify all listeners");
+        delete mListeners;
+        mListeners = NULL;
+    }
+    return NS_OK;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+class nsServiceManagerImpl : public nsIServiceManager {
+public:
+
+    NS_IMETHOD
+    RegisterService(const nsCID& aClass, nsISupports* aService);
+
+    NS_IMETHOD
+    UnregisterService(const nsCID& aClass);
+
+    NS_IMETHOD
+    GetService(const nsCID& aClass, const nsIID& aIID,
+               nsISupports* *result,
+               nsIShutdownListener* shutdownListener = NULL);
+
+    NS_IMETHOD
+    ReleaseService(const nsCID& aClass, nsISupports* service,
+                   nsIShutdownListener* shutdownListener = NULL);
+
+    NS_IMETHOD
+    RegisterService(const char* aProgID, nsISupports* aService);
+
+    NS_IMETHOD
+    UnregisterService(const char* aProgID);
+
+    NS_IMETHOD
+    GetService(const char* aProgID, const nsIID& aIID,
+               nsISupports* *result,
+               nsIShutdownListener* shutdownListener = NULL);
+
+    NS_IMETHOD
+    ReleaseService(const char* aProgID, nsISupports* service,
+                   nsIShutdownListener* shutdownListener = NULL);
+
+    nsServiceManagerImpl(void);
+
+    NS_DECL_ISUPPORTS
+
+protected:
+
+    virtual ~nsServiceManagerImpl(void);
+
+    nsHashtable/*<nsServiceEntry>*/* mServices;
+};
+
+nsServiceManagerImpl::nsServiceManagerImpl(void)
+{
+    NS_INIT_REFCNT();
+    mServices = new nsHashtable();
+    NS_ASSERTION(mServices, "out of memory already?");
+}
+
+static PRBool
+DeleteEntry(nsHashKey *aKey, void *aData, void* closure)
+{
+    nsServiceEntry* entry = (nsServiceEntry*)aData;
+    NS_RELEASE(entry->mService);
+    delete entry;
+    return PR_TRUE;
+}
+
+nsServiceManagerImpl::~nsServiceManagerImpl(void)
+{
+    if (mServices) {
+        mServices->Enumerate(DeleteEntry);
+        delete mServices;
+    }
+}
+
+static NS_DEFINE_IID(kIServiceManagerIID, NS_ISERVICEMANAGER_IID);
+static NS_DEFINE_IID(kISupportsIID, NS_ISUPPORTS_IID);
+
+NS_IMPL_ADDREF(nsServiceManagerImpl);
+NS_IMPL_RELEASE(nsServiceManagerImpl);
+
+NS_IMETHODIMP
+nsServiceManagerImpl::QueryInterface(const nsIID& aIID, void* *aInstancePtr)
+{
+    if (NULL == aInstancePtr) {
+        return NS_ERROR_NULL_POINTER; 
+    } 
+    *aInstancePtr = NULL; 
+    if (aIID.Equals(kIServiceManagerIID) ||
+        aIID.Equals(kISupportsIID)) {
+        *aInstancePtr = (void*) this; 
+        AddRef(); 
+        return NS_OK; 
+    } 
+    return NS_NOINTERFACE; 
+}
+
+NS_IMETHODIMP
+nsServiceManagerImpl::GetService(const nsCID& aClass, const nsIID& aIID,
+                                 nsISupports* *result,
+                                 nsIShutdownListener* shutdownListener)
+{
+    nsresult rv = NS_OK;
+    /* XXX: This is a hack to force NSPR initialization..  This should be 
+     *      removed once PR_CEnterMonitor(...) initializes NSPR... (rick)
+     */
+    (void)PR_GetCurrentThread();
+    PR_CEnterMonitor(this);
+
+    nsIDKey key(aClass);
+    nsServiceEntry* entry = (nsServiceEntry*)mServices->Get(&key);
+
+    if (entry) {
+        nsISupports* service;
+        rv = entry->mService->QueryInterface(aIID, (void**)&service);
+        if (NS_SUCCEEDED(rv)) {
+            rv = entry->AddListener(shutdownListener);
+            if (NS_SUCCEEDED(rv)) {
+                *result = service;
+
+                // If someone else requested the service to be shut down, 
+                // and we just asked to get it again before it could be 
+                // released, then cancel their shutdown request:
+                if (entry->mShuttingDown) {
+                    entry->mShuttingDown = PR_FALSE;
+                    NS_ADDREF(service);      // Released in UnregisterService
+                }
+            }
+        }
+    }
+    else {
+        nsISupports* service;
+        rv = nsComponentManager::CreateInstance(aClass, NULL, aIID, (void**)&service);
+        if (NS_SUCCEEDED(rv)) {
+            entry = new nsServiceEntry(aClass, service);
+            if (entry == NULL) {
+                NS_RELEASE(service);
+                rv = NS_ERROR_OUT_OF_MEMORY;
+            }
+            else {
+                rv = entry->AddListener(shutdownListener);
+                if (NS_SUCCEEDED(rv)) {
+                    mServices->Put(&key, entry);
+                    *result = service;
+                    NS_ADDREF(service);      // Released in UnregisterService
+                }
+                else {
+                    NS_RELEASE(service);
+                    delete entry;
+                }
+            }
+        }
+    }
+
+    PR_CExitMonitor(this);
+    return rv;
+}
+
+NS_IMETHODIMP
+nsServiceManagerImpl::ReleaseService(const nsCID& aClass, nsISupports* service,
+                                     nsIShutdownListener* shutdownListener)
+{
+    nsresult rv = NS_OK;
+    PR_CEnterMonitor(this);
+
+    nsIDKey key(aClass);
+    nsServiceEntry* entry = (nsServiceEntry*)mServices->Get(&key);
+
+    NS_ASSERTION(entry, "service not found");
+    // NS_ASSERTION(entry->mService == service, "service looked failed");
+
+    if (entry) {
+        rv = entry->RemoveListener(shutdownListener);
+        nsrefcnt cnt;
+        NS_RELEASE2(service, cnt);
+        if (NS_SUCCEEDED(rv) && cnt == 0) {
+            mServices->Remove(&key);
+            delete entry;
+            rv = nsComponentManager::FreeLibraries();
+        }
+    }
+
+    PR_CExitMonitor(this);
+    return rv;
+}
+
+NS_IMETHODIMP
+nsServiceManagerImpl::RegisterService(const nsCID& aClass, nsISupports* aService)
+{
+    nsresult rv = NS_OK;
+    PR_CEnterMonitor(this);
+
+    nsIDKey key(aClass);
+    nsServiceEntry* entry = (nsServiceEntry*)mServices->Get(&key);
+    if (entry) {
+        rv = NS_ERROR_FAILURE;
+    }
+    else {
+        nsServiceEntry* entry = new nsServiceEntry(aClass, aService);
+        if (entry == NULL) 
+            rv = NS_ERROR_OUT_OF_MEMORY;
+        else {
+            mServices->Put(&key, entry);
+            NS_ADDREF(aService);      // Released in UnregisterService
+        }
+    }
+    PR_CExitMonitor(this);
+    return rv;
+}
+
+NS_IMETHODIMP
+nsServiceManagerImpl::UnregisterService(const nsCID& aClass)
+{
+    nsresult rv = NS_OK;
+    PR_CEnterMonitor(this);
+
+    nsIDKey key(aClass);
+    nsServiceEntry* entry = (nsServiceEntry*)mServices->Get(&key);
+
+    if (entry == NULL) {
+        rv = NS_ERROR_SERVICE_NOT_FOUND;
+    }
+    else {
+        rv = entry->NotifyListeners();         // break the cycles
+        entry->mShuttingDown = PR_TRUE;
+        nsrefcnt cnt;
+        NS_RELEASE2(entry->mService, cnt);       // AddRef in GetService
+        if (NS_SUCCEEDED(rv) && cnt == 0) {
+            mServices->Remove(&key);
+            delete entry;
+            rv = nsComponentManager::FreeLibraries();
+        }
+        else
+            rv = NS_ERROR_SERVICE_IN_USE;
+    }
+
+    PR_CExitMonitor(this);
+    return rv;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// let's do it again, this time with ProgIDs...
+
+NS_IMETHODIMP
+nsServiceManagerImpl::RegisterService(const char* aProgID, nsISupports* aService)
+{
+    nsCID aClass;
+    nsresult rv;
+    rv = nsComponentManager::ProgIDToCLSID(aProgID, &aClass);
+    if (NS_FAILED(rv)) return rv;
+    return RegisterService(aClass, aService);
+}
+
+NS_IMETHODIMP
+nsServiceManagerImpl::UnregisterService(const char* aProgID)
+{
+    nsCID aClass;
+    nsresult rv;
+    rv = nsComponentManager::ProgIDToCLSID(aProgID, &aClass);
+    if (NS_FAILED(rv)) return rv;
+    return UnregisterService(aClass);
+}
+
+NS_IMETHODIMP
+nsServiceManagerImpl::GetService(const char* aProgID, const nsIID& aIID,
+                                 nsISupports* *result,
+                                 nsIShutdownListener* shutdownListener)
+{
+    nsCID aClass;
+    nsresult rv;
+    rv = nsComponentManager::ProgIDToCLSID(aProgID, &aClass);
+    if (NS_FAILED(rv)) return rv;
+    return GetService(aClass, aIID, result, shutdownListener);
+}
+
+NS_IMETHODIMP
+nsServiceManagerImpl::ReleaseService(const char* aProgID, nsISupports* service,
+                                     nsIShutdownListener* shutdownListener)
+{
+    nsCID aClass;
+    nsresult rv;
+    rv = nsComponentManager::ProgIDToCLSID(aProgID, &aClass);
+    if (NS_FAILED(rv)) return rv;
+    return ReleaseService(aClass, service, shutdownListener);
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+nsresult
+NS_NewServiceManager(nsIServiceManager* *result)
+{
+    nsServiceManagerImpl* servMgr = new nsServiceManagerImpl();
+    if (servMgr == NULL)
+        return NS_ERROR_OUT_OF_MEMORY;
+    NS_ADDREF(servMgr);
+    *result = servMgr;
+    return NS_OK;
+}
+
+////////////////////////////////////////////////////////////////////////////////
+// Global service manager interface (see nsIServiceManager.h)
+
+nsresult
+nsServiceManager::GetGlobalServiceManager(nsIServiceManager* *result)
+{
+    nsresult rv = NS_OK;
+    if (mGlobalServiceManager == NULL) {
+        // XPCOM not initialized yet. Let us do initialization of our module.
+        rv = NS_InitXPCOM(NULL);
+    }
+    // No ADDREF as we are advicing no release of this.
+    if (NS_SUCCEEDED(rv)) *result = mGlobalServiceManager;
+
+    return rv;
+}
+
+nsresult
+nsServiceManager::ShutdownGlobalServiceManager(nsIServiceManager* *result)
+{
+    if (mGlobalServiceManager != NULL) {
+        NS_RELEASE(mGlobalServiceManager);
+        mGlobalServiceManager = NULL;
+    }
+    return NS_OK;
+}
+
+nsresult
+nsServiceManager::GetService(const nsCID& aClass, const nsIID& aIID,
+                             nsISupports* *result,
+                             nsIShutdownListener* shutdownListener)
+{
+    nsIServiceManager* mgr;
+    nsresult rv = GetGlobalServiceManager(&mgr);
+    if (NS_FAILED(rv)) return rv;
+    return mgr->GetService(aClass, aIID, result, shutdownListener);
+}
+
+nsresult
+nsServiceManager::ReleaseService(const nsCID& aClass, nsISupports* service,
+                                 nsIShutdownListener* shutdownListener)
+{
+    nsIServiceManager* mgr;
+    nsresult rv = GetGlobalServiceManager(&mgr);
+    if (NS_FAILED(rv)) return rv;
+    return mgr->ReleaseService(aClass, service, shutdownListener);
+}
+
+nsresult
+nsServiceManager::RegisterService(const nsCID& aClass, nsISupports* aService)
+{
+    nsIServiceManager* mgr;
+    nsresult rv = GetGlobalServiceManager(&mgr);
+    if (NS_FAILED(rv)) return rv;
+    return mgr->RegisterService(aClass, aService);
+}
+
+nsresult
+nsServiceManager::UnregisterService(const nsCID& aClass)
+{
+    nsIServiceManager* mgr;
+    nsresult rv = GetGlobalServiceManager(&mgr);
+    if (NS_FAILED(rv)) return rv;
+    return mgr->UnregisterService(aClass);
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
+// XPCOM initialization
+//
+// To Control the order of initialization of these key components I am putting
+// this function.
+//
+//	- nsServiceManager
+//		- nsComponentManager
+//			- nsRegistry
+//
+// Here are key points to remember:
+//	- A global of all these need to exist. nsServiceManager is an independent object.
+//	  nsComponentManager uses both the globalServiceManager and its own registry.
+//
+//	- A static object of both the nsComponentManager and nsServiceManager
+//	  are in use. Hence InitXPCOM() gets triggered from both
+//	  NS_GetGlobale{Service/Component}Manager() calls.
+//
+//	- There exists no global Registry. Registry can be created from the component manager.
+//
+#include "nsComponentManager.h"
+#include "nsIRegistry.h"
+#include "nsXPComCIID.h"
+extern "C" NS_EXPORT nsresult
+NS_RegistryGetFactory(nsISupports* servMgr, nsIFactory** aFactory);
+
+nsIServiceManager* nsServiceManager::mGlobalServiceManager = NULL;
+nsComponentManagerImpl* nsComponentManagerImpl::gComponentManager = NULL;
+
+nsresult NS_InitXPCOM(nsIServiceManager* *result)
+{
+    nsresult rv = NS_OK;
+
+    // 1. Create the Global Service Manager
+    nsIServiceManager* servMgr = NULL;
+    if (nsServiceManager::mGlobalServiceManager == NULL)
+    {
+        rv = NS_NewServiceManager(&servMgr);
+        if (NS_FAILED(rv)) return rv;
+        nsServiceManager::mGlobalServiceManager = servMgr;
+        NS_ADDREF(servMgr);
+        if (result && *result) *result = servMgr;
+    }
+
+    // 2. Create the Component Manager and register with global service manager
+    //    It is understood that the component manager can use the global service manager.
+    nsComponentManagerImpl *compMgr = NULL;
+    if (nsComponentManagerImpl::gComponentManager == NULL)
+    {
+        compMgr = new nsComponentManagerImpl();
+        if (compMgr == NULL)
+            return NS_ERROR_OUT_OF_MEMORY;
+        NS_ADDREF(compMgr);
+        nsresult rv = compMgr->Init();
+        if (NS_FAILED(rv))
+        {
+            NS_RELEASE(compMgr);
+            return rv;
+        }
+        nsComponentManagerImpl::gComponentManager = compMgr;
+    }
+    
+    rv = servMgr->RegisterService(kComponentManagerCID, compMgr);
+    if (NS_FAILED(rv))
+    {
+        return rv;
+    }
+
+
+    // 3. Register the RegistryFactory with the component manager so that
+    //    clients can create new registry objects.
+    nsIFactory *registryFactory = NULL;
+    rv = NS_RegistryGetFactory(servMgr, &registryFactory);
+    if (NS_FAILED(rv)) return (rv);
+
+    NS_DEFINE_CID(kRegistryCID, NS_REGISTRY_CID);
+
+    rv = compMgr->RegisterFactory(kRegistryCID, NS_REGISTRY_CLASSNAME,
+                                  NS_REGISTRY_PROGID, registryFactory,
+                                  PR_TRUE);
+    NS_RELEASE(registryFactory);
+
+   return (rv); 
+}

mozilla/xpcom/components/nsXPComFactory.h

@@ -0,0 +1,158 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (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/NPL/
+ *
+ * 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.
+ *
+ * The Original Code is Mozilla Communicator client code.
+ *
+ * The Initial Developer of the Original Code is Netscape Communications
+ * Corporation.  Portions created by Netscape are Copyright (C) 1998
+ * Netscape Communications Corporation.  All Rights Reserved.
+ */
+
+#ifndef nsXPComFactory_h__
+#define nsXPComFactory_h__
+
+#include "nsIFactory.h"
+
+/*
+ * This file contains a macro for the implementation of a simple XPCOM factory.
+ *
+ * To implement a factory for a given component, you need to declare the
+ * factory class using the NS_DEF_FACTORY() macro.
+ *
+ * The first macro argument is the name for the factory.  
+ * 
+ * The second macro argument is a function (provided by you) which 
+ * can be called by your DLL's NSGetFactory(...) entry point.
+ *
+ * Example:
+ *
+ *   NS_DEF_FACTORY(SomeComponent,SomeComponentImpl)
+ *
+ *   Declares:
+ *   
+ *     class nsSomeComponentFactory : public nsIFactory {};
+ *
+ * NOTE that the NS_DEF_FACTORY takes care of enforcing the "ns" prefix
+ * and appending the "Factory" suffix to the given name.
+ *
+ *   To use the new factory:
+ *
+ *     nsresult NS_New_SomeComponent_Factory(nsIFactory** aResult)
+ *     {
+ *       nsresult rv = NS_OK;
+ *       nsIFactory* inst = new nsSomeComponentFactory;
+ *       if (NULL == inst) {
+ *         rv = NS_ERROR_OUT_OF_MEMORY;
+ *       } else {
+ *         NS_ADDREF(inst);
+ *       }
+ *       *aResult = inst;
+ *       return rv;
+ *     }
+ *
+ * NOTE:
+ * ----
+ *  The factories created by this macro are not thread-safe and do not
+ *  support aggregation.
+ *
+ */
+#define NS_DEF_FACTORY(_name,_type)                               \
+class ns##_name##Factory : public nsIFactory                      \
+{                                                                 \
+public:                                                           \
+  ns##_name##Factory() { NS_INIT_REFCNT(); }                      \
+                                                                  \
+  NS_IMETHOD_(nsrefcnt) AddRef (void)                             \
+  {                                                               \
+    return ++mRefCnt;                                             \
+  }                                                               \
+                                                                  \
+  NS_IMETHOD_(nsrefcnt) Release(void)                             \
+  {                                                               \
+    NS_PRECONDITION(0 != mRefCnt, "dup release");                 \
+    if (--mRefCnt == 0) {                                         \
+      NS_DELETEXPCOM(this);                                       \
+      return 0;                                                   \
+    }                                                             \
+    return mRefCnt;                                               \
+  }                                                               \
+                                                                  \
+  NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr)   \
+  {                                                               \
+    if (NULL == aInstancePtr) {                                   \
+      return NS_ERROR_NULL_POINTER;                               \
+    }                                                             \
+                                                                  \
+    *aInstancePtr = NULL;                                         \
+                                                                  \
+    static NS_DEFINE_IID(kIFactoryIID,  NS_IFACTORY_IID);         \
+    static NS_DEFINE_IID(kISupportsIID, NS_ISUPPORTS_IID);        \
+    if (aIID.Equals(kIFactoryIID)) {                              \
+      *aInstancePtr = (void*) this;                               \
+      NS_ADDREF_THIS();                                           \
+      return NS_OK;                                               \
+    }                                                             \
+    if (aIID.Equals(kISupportsIID)) {                             \
+      *aInstancePtr = (void*) ((nsISupports*)this);               \
+      NS_ADDREF_THIS();                                           \
+      return NS_OK;                                               \
+    }                                                             \
+    return NS_NOINTERFACE;                                        \
+  }                                                               \
+                                                                  \
+  NS_IMETHOD CreateInstance(nsISupports *aOuter,                  \
+                            const nsIID &aIID,                    \
+                            void **aResult)                       \
+  {                                                               \
+    nsresult rv;                                                  \
+                                                                  \
+    _type * inst;                                                 \
+                                                                  \
+    if (NULL == aResult) {                                        \
+      rv = NS_ERROR_NULL_POINTER;                                 \
+      goto done;                                                  \
+    }                                                             \
+    *aResult = NULL;                                              \
+    if (NULL != aOuter) {                                         \
+      rv = NS_ERROR_NO_AGGREGATION;                               \
+      goto done;                                                  \
+    }                                                             \
+                                                                  \
+    NS_NEWXPCOM(inst, _type);                                     \
+    if (NULL == inst) {                                           \
+      rv = NS_ERROR_OUT_OF_MEMORY;                                \
+      goto done;                                                  \
+    }                                                             \
+    NS_ADDREF(inst);                                              \
+    rv = inst->QueryInterface(aIID, aResult);                     \
+    NS_RELEASE(inst);                                             \
+                                                                  \
+  done:                                                           \
+    return rv;                                                    \
+  }                                                               \
+                                                                  \
+  NS_IMETHOD LockFactory(PRBool aLock)                            \
+  {                                                               \
+    return NS_OK;                                                 \
+  }                                                               \
+                                                                  \
+                                                                  \
+protected:                                                        \
+  virtual ~ns##_name##Factory()                                   \
+  {                                                               \
+    NS_ASSERTION(mRefCnt == 0, "non-zero refcnt at destruction"); \
+  }                                                               \
+                                                                  \
+  nsrefcnt mRefCnt;                                               \
+};
+
+#endif /* nsXPComFactory_h__ */

mozilla/xpcom/components/xcDll.cpp

@@ -0,0 +1,171 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+/* nsDll
+ *
+ * Abstraction of a Dll. Stores modifiedTime and size for easy detection of
+ * change in dll.
+ *
+ * dp Suresh <dp@netscape.com>
+ */
+
+#include "xcDll.h"
+#include "plstr.h"	// strdup and strfree
+
+nsDll::nsDll(const char *libFullPath) : m_fullpath(NULL), m_instance(NULL),
+	m_status(DLL_OK)
+{
+	m_lastModTime = LL_ZERO;
+	m_size = 0;
+	
+	if (libFullPath == NULL)
+	{
+		m_status = DLL_INVALID_PARAM;
+		return;
+	}
+	m_fullpath = PL_strdup(libFullPath);
+	if (m_fullpath == NULL)
+	{
+		// No more memory
+		m_status = DLL_NO_MEM;
+		return;
+	}
+
+	PRFileInfo statinfo;
+	if (PR_GetFileInfo(m_fullpath, &statinfo) != PR_SUCCESS)
+	{
+		// The stat things works only if people pass in the full pathname.
+		// Even if our stat fails, we could be able to load it because of
+		// LD_LIBRARY_PATH and other such paths where dlls are searched for
+
+		// XXX we need a way of marking this occurance.
+		// XXX m_status = DLL_STAT_ERROR;
+	}
+	else 
+	{
+		m_size = statinfo.size;
+		m_lastModTime = statinfo.modifyTime;
+		if (statinfo.type != PR_FILE_FILE)
+		{
+			// Not a file. Cant work with it.
+			m_status = DLL_NOT_FILE;
+			return;
+		}
+	}
+	m_status = DLL_OK;			
+}
+
+
+nsDll::nsDll(const char *libFullPath, PRTime lastModTime, PRUint32 fileSize)
+:  m_fullpath(NULL), m_instance(NULL), m_status(DLL_OK)
+{
+	m_lastModTime = lastModTime;
+	m_size = fileSize;
+	
+	if (libFullPath == NULL)
+	{
+		m_status = DLL_INVALID_PARAM;
+		return;
+	}
+	m_fullpath = PL_strdup(libFullPath);
+	if (m_fullpath == NULL)
+	{
+		// No more memory
+		m_status = DLL_NO_MEM;
+		return;
+	}
+
+	m_status = DLL_OK;			
+}
+
+nsDll::~nsDll(void)
+{
+	if (m_instance != NULL)
+		Unload();
+	if (m_fullpath != NULL) PL_strfree(m_fullpath);
+	m_fullpath = NULL;
+}
+
+
+PRBool nsDll::Load(void)
+{
+#ifdef	XP_MAC
+	char		*macFileName = NULL;
+	int		loop;
+#endif
+
+	if (m_status != DLL_OK)
+	{
+		return (PR_FALSE);
+	}
+	if (m_instance != NULL)
+	{
+		// Already loaded
+		return (PR_TRUE);
+	}
+#ifdef	XP_MAC
+	// err = ConvertUnixPathToMacPath(m_fullpath, &macFileName);
+	if ((macFileName = PL_strdup(m_fullpath)) != NULL)
+	{
+		if (macFileName[0] == '/')
+		{
+			for (loop=0; loop<PL_strlen(macFileName); loop++)
+			{
+				if (macFileName[loop] == '/')	macFileName[loop] = ':';
+			}
+			m_instance = PR_LoadLibrary(&macFileName[1]);		// skip over initial slash
+		}
+		else
+		{
+			m_instance = PR_LoadLibrary(macFileName);
+		}
+	}
+	
+#else
+	// This is the only right way of doing this...
+	m_instance = PR_LoadLibrary(m_fullpath);
+#endif /* XP_MAC */
+	return ((m_instance == NULL) ? PR_FALSE : PR_TRUE);
+	
+}
+
+PRBool nsDll::Unload(void)
+{
+	if (m_status != DLL_OK || m_instance == NULL)
+		return (PR_FALSE);
+	PRStatus ret = PR_UnloadLibrary(m_instance);
+	if (ret == PR_SUCCESS)
+	{
+		m_instance = NULL;
+		return (PR_TRUE);
+	}
+	else
+		return (PR_FALSE);
+}
+
+void * nsDll::FindSymbol(const char *symbol)
+{
+	if (symbol == NULL)
+		return (NULL);
+	
+	// If not already loaded, load it now.
+	if (Load() != PR_TRUE)
+		return (NULL);
+
+	return (PR_FindSymbol(m_instance, symbol));
+}

mozilla/xpcom/components/xcDll.h

@@ -0,0 +1,71 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+/* Dll
+ *
+ * Programmatic representation of a dll. Stores modifiedTime and size for
+ * easy detection of change in dll.
+ *
+ * dp Suresh <dp@netscape.com>
+ */
+
+#include "prio.h"
+#include "prlink.h"
+
+typedef enum nsDllStatus
+{
+	DLL_OK = 0,
+	DLL_NO_MEM = 1,
+	DLL_STAT_ERROR = 2,
+	DLL_NOT_FILE = 3,
+	DLL_INVALID_PARAM = 4
+} nsDllStatus;
+
+class nsDll
+{
+private:
+	char *m_fullpath;		// system format full filename of dll
+	PRTime m_lastModTime;	// last modified time
+	PRUint32 m_size;		// size of the dynamic library
+	PRLibrary *m_instance;	// Load instance
+	nsDllStatus m_status;		// holds current status
+
+public:
+ 
+	nsDll(const char *libFullPath);
+	nsDll(const char *libFullPath, PRTime lastModTime, PRUint32 fileSize);
+
+	~nsDll(void);
+
+	// Status checking on operations completed
+	nsDllStatus GetStatus(void) { return (m_status); }
+
+	// Dll Loading
+	PRBool Load(void);
+	PRBool Unload(void);
+	PRBool IsLoaded(void)
+	{
+		return ((m_instance != 0) ? PR_TRUE : PR_FALSE);
+	}
+	void *FindSymbol(const char *symbol);
+	
+	const char *GetFullPath(void) { return (m_fullpath); }
+	PRTime GetLastModifiedTime(void) { return(m_lastModTime); }
+	PRUint32 GetSize(void) { return(m_size); }
+	PRLibrary *GetInstance(void) { return (m_instance); }
+};

mozilla/xpcom/components/xcDllStore.cpp

@@ -0,0 +1,88 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+/* THIS FILE IS OBSOLETE */
+ 
+/* nsDllStore
+ *
+ * Stores dll and their accociated info in a hash keyed on the system format
+ * full dll path name e.g C:\Program Files\Netscape\Program\raptor.dll
+ *
+ * NOTE: dll names are considered to be case sensitive.
+ */
+
+#include "xcDllStore.h"
+
+static PR_CALLBACK PRIntn _deleteDllInfo(PLHashEntry *he, PRIntn i, void *arg)
+{
+	delete (nsDll *)he->value;
+	return (HT_ENUMERATE_NEXT);
+}
+
+nsDllStore::nsDllStore(void) : m_dllHashTable(NULL)
+{
+	PRUint32 initSize = 128;
+
+	m_dllHashTable = PL_NewHashTable(initSize, PL_HashString,
+		PL_CompareStrings, PL_CompareValues, NULL, NULL);
+}
+
+
+nsDllStore::~nsDllStore(void)
+{
+	if (m_dllHashTable)
+	{
+		// Delete each of the nsDll stored before deleting the Hash Table
+		PL_HashTableEnumerateEntries(m_dllHashTable, _deleteDllInfo, NULL);
+		PL_HashTableDestroy(m_dllHashTable);
+	}
+	m_dllHashTable = NULL;
+}
+
+
+nsDll* nsDllStore::Get(const char *dll)
+{
+	nsDll *dllInfo = NULL;
+	if (m_dllHashTable)
+	{
+		dllInfo = (nsDll *)PL_HashTableLookup(m_dllHashTable, dll);
+	}
+	return (dllInfo);
+}
+
+
+nsDll* nsDllStore::Remove(const char *dll)
+{
+	if (m_dllHashTable == NULL)
+	{
+		return (NULL);
+	}
+	nsDll *dllInfo = Get(dll);
+	PL_HashTableRemove(m_dllHashTable, dll);
+	return (dllInfo);
+}
+
+PRBool nsDllStore::Put(const char *dll, nsDll *dllInfo)
+{
+	if (m_dllHashTable == NULL)
+		return(PR_FALSE);
+
+	PLHashEntry *entry =
+		PL_HashTableAdd(m_dllHashTable, (void *)dll, (void *)dllInfo);
+	return ((entry != NULL) ? PR_TRUE : PR_FALSE);
+}

mozilla/xpcom/components/xcDllStore.h

@@ -0,0 +1,49 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/*
+ * The contents of this file are subject to the Netscape Public License
+ * Version 1.0 (the "NPL"); you may not use this file except in
+ * compliance with the NPL.  You may obtain a copy of the NPL at
+ * http://www.mozilla.org/NPL/
+ *
+ * Software distributed under the NPL is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
+ * for the specific language governing rights and limitations under the
+ * NPL.
+ *
+ * The Initial Developer of this code under the NPL is Netscape
+ * Communications Corporation.  Portions created by Netscape are
+ * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
+ * Reserved.
+ */
+
+ 
+/* nsDllStore
+ *
+ * Stores dll and their accociated info in a hash keyed on the system format
+ * full dll path name e.g C:\Program Files\Netscape\Program\raptor.dll
+ *
+ * NOTE: dll names are considered to be case sensitive.
+ */
+
+#include "plhash.h"
+#include "xcDll.h"
+
+class nsDllStore
+{
+private:
+	PLHashTable *m_dllHashTable;
+
+public:
+	// Constructor
+	nsDllStore(void);
+	~nsDllStore(void);
+
+	// Caller is not expected to delete nsDll returned
+	// The nsDll returned in NOT removed from the hash
+	nsDll* Get(const char *filename);
+	PRBool Put(const char *filename, nsDll *dllInfo);
+
+	// The nsDll returned is removed from the hash
+	// Caller is expected to delete the returned nsDll
+	nsDll* Remove(const char *filename);
+};