xpcom/base/nsICycleCollectorListener.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is XPCOM cycle collector.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Mozilla Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2010
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsISupports.idl"
  38
  39 /**
  40  * Interface to pass to the cycle collector to get information about the CC
  41  * graph while it's being built. The order of calls will be call to begin();
  42  * then for every node in the graph a call to noteObject() and calls to
  43  * noteEdge() for every edge starting at that node; then a call to
  44  * beginDescriptions(); then for every black node in the CC graph a call to
  45  * either describeRefcountedObject() or to describeGCedObject(); and then a
  46  * call to end(). If begin() returns an error none of the other functions will
  47  * be called.
  48  */
  49 [scriptable, uuid(194b749a-4ceb-4dd1-928d-d30b5f14c23e)]
  50 interface nsICycleCollectorListener : nsISupports
  51 {
  52     void begin();
  53     void noteObject(in unsigned long long aAddress,
  54                     in string aObjectDescription);
  55     void noteEdge(in unsigned long long aFromAddress,
  56                   in unsigned long long aToAddress,
  57                   in string aEdgeName);
  58     void beginDescriptions();
  59     void describeRefcountedObject(in unsigned long long aAddress,
  60                                   in unsigned long aKnownEdges,
  61                                   in unsigned long aTotalEdges);
  62     void describeGCedObject(in unsigned long long aAddress, in boolean aMarked);
  63     void end();
  64 };