xpcom/base/nsIMemoryReporter.idl

   1 /* -*- Mode: C++; tab-width: 50; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * mozilla.org
  19  * Portions created by the Initial Developer are Copyright (C) 2008
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vladimir Vukicevic <vladimir@pobox.com> (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsISimpleEnumerator;
  42
  43 [scriptable, uuid(d298b942-3e66-4cd3-9ff5-46abc69147a7)]
  44 interface nsIMemoryReporter : nsISupports
  45 {
  46   /*
  47    * The path that this memory usage should be reported under.
  48    *
  49    * Normally "/"-delimited for organization.
  50    */
  51   readonly attribute string path;
  52
  53   /*
  54    * A human-readable description of this memory usage report
  55    */
  56   readonly attribute string description;
  57
  58   /*
  59    * The current amount of memory in use, as reported by this memory
  60    * reporter.
  61    */
  62   readonly attribute long long memoryUsed;
  63 };
  64
  65 [scriptable, uuid(63fc8fbd-509b-4fdb-93b4-2e6caeeddab1)]
  66 interface nsIMemoryReporterManager : nsISupports
  67 {
  68   /*
  69    * Return an enumerator of nsIMemoryReporters that are currently registered.
  70    */
  71   nsISimpleEnumerator enumerateReporters ();
  72
  73   /*
  74    * Register the given nsIMemoryReporter.  It is an error to register
  75    * more than one reporter with the same path.  After a reporter is
  76    * registered, it will be available via enumerateReporters().  The
  77    * Manager service will hold a strong reference to the given reporter.
  78    */
  79   void registerReporter (in nsIMemoryReporter reporter);
  80
  81   /*
  82    * Unregister the given memory reporter.
  83    */
  84   void unregisterReporter (in nsIMemoryReporter reporter);
  85 };
  86
  87 %{C++
  88
  89 #define NS_MEMORY_REPORTER_IMPLEMENT(_classname,_path,_desc,_usageFunction,_dataptr) \
  90     class MemoryReporter_##_classname : public nsIMemoryReporter {      \
  91     public:                                                             \
  92       NS_DECL_ISUPPORTS                                                 \
  93       NS_IMETHOD GetPath(char **memoryPath) { *memoryPath = strdup(_path); return NS_OK; } \
  94       NS_IMETHOD GetDescription(char **desc) { *desc = strdup(_desc); return NS_OK; } \
  95       NS_IMETHOD GetMemoryUsed(PRInt64 *memoryUsed) { *memoryUsed = _usageFunction(_dataptr); return NS_OK; } \
  96     };                                                                  \
  97     NS_IMPL_ISUPPORTS1(MemoryReporter_##_classname, nsIMemoryReporter)
  98
  99 #define NS_MEMORY_REPORTER_NAME(_classname)  MemoryReporter_##_classname
 100
 101 NS_COM nsresult NS_RegisterMemoryReporter (nsIMemoryReporter *reporter);
 102 NS_COM nsresult NS_UnregisterMemoryReporter (nsIMemoryReporter *reporter);
 103
 104 %}