xpcom/base/nsCycleCollectionNoteRootCallback.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsCycleCollectionNoteRootCallback_h__
   8 #define nsCycleCollectionNoteRootCallback_h__
   9
  10 #include "nscore.h"
  11
  12 class nsCycleCollectionParticipant;
  13 class nsISupports;
  14 class JSObject;
  15
  16 namespace JS {
  17 class GCCellPtr;
  18 }
  19
  20 class nsCycleCollectionNoteRootCallback {
  21  public:
  22   // aRoot must be canonical (ie the result of QIing to
  23   // nsCycleCollectionISupports).
  24   NS_IMETHOD_(void)
  25   NoteXPCOMRoot(nsISupports* aRoot,
  26                 nsCycleCollectionParticipant* aParticipant) = 0;
  27
  28   NS_IMETHOD_(void) NoteJSRoot(JSObject* aRoot) = 0;
  29   NS_IMETHOD_(void)
  30   NoteNativeRoot(void* aRoot, nsCycleCollectionParticipant* aParticipant) = 0;
  31
  32   NS_IMETHOD_(void)
  33   NoteWeakMapping(JSObject* aMap, JS::GCCellPtr aKey, JSObject* aKeyDelegate,
  34                   JS::GCCellPtr aVal) = 0;
  35
  36   bool WantAllTraces() const { return mWantAllTraces; }
  37
  38  protected:
  39   nsCycleCollectionNoteRootCallback() : mWantAllTraces(false) {}
  40
  41   bool mWantAllTraces;
  42 };
  43
  44 #endif  // nsCycleCollectionNoteRootCallback_h__