Back to index

lightning-sunbird  0.9+nobinonly
nsMemory.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsMemory_h__
00039 #define nsMemory_h__
00040 
00041 #include "nsXPCOM.h"
00042 #include "nsIMemory.h"
00043 
00044 #define NS_MEMORY_CONTRACTID "@mozilla.org/xpcom/memory-service;1"
00045 #define NS_MEMORY_CLASSNAME  "Global Memory Service"
00046 #define NS_MEMORY_CID                                \
00047 { /* 30a04e40-38e7-11d4-8cf5-0060b0fc14a3 */         \
00048     0x30a04e40,                                      \
00049     0x38e7,                                          \
00050     0x11d4,                                          \
00051     {0x8c, 0xf5, 0x00, 0x60, 0xb0, 0xfc, 0x14, 0xa3} \
00052 }
00053 
00054 
00064 class nsMemory
00065 {
00066 public:
00067     static NS_HIDDEN_(void*) Alloc(size_t size)
00068         { return NS_Alloc(size); }
00069 
00070     static NS_HIDDEN_(void*) Realloc(void* ptr, PRSize size)
00071         { return NS_Realloc(ptr, size); }
00072 
00073     static NS_HIDDEN_(void) Free(void* ptr)
00074         { NS_Free(ptr); }
00075 
00076     static NS_COM_GLUE nsresult   HeapMinimize(PRBool aImmediate);
00077     static NS_COM_GLUE void*      Clone(const void* ptr, PRSize size);
00078     static NS_COM_GLUE nsIMemory* GetGlobalMemoryService();       // AddRefs
00079 };
00080 
00110 #define NS_FREE_XPCOM_POINTER_ARRAY(size, array, freeFunc)                    \
00111     PR_BEGIN_MACRO                                                            \
00112         PRInt32 iter_ = PRInt32(size);                                        \
00113         while (--iter_ >= 0)                                                  \
00114             freeFunc((array)[iter_]);                                         \
00115         NS_Free((array));                                                     \
00116     PR_END_MACRO
00117 
00118 // convenience macros for commonly used calls.  mmmmm.  syntactic sugar.
00119 
00130 #define NS_FREE_XPCOM_ALLOCATED_POINTER_ARRAY(size, array)                    \
00131     NS_FREE_XPCOM_POINTER_ARRAY((size), (array), NS_Free)
00132 
00148 #define NS_FREE_XPCOM_ISUPPORTS_POINTER_ARRAY(size, array)                    \
00149     NS_FREE_XPCOM_POINTER_ARRAY((size), (array), NS_IF_RELEASE)
00150 
00156 #define NS_ARRAY_LENGTH(array_) \
00157   (sizeof(array_)/sizeof(array_[0]))
00158 
00159 
00160 #endif // nsMemory_h__
00161