2014-06-30 08:39:45 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
2012-05-21 04:12:37 -07:00
|
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
#ifndef nsCycleCollector_h__
|
|
|
|
#define nsCycleCollector_h__
|
|
|
|
|
2010-08-11 17:03:23 -07:00
|
|
|
class nsICycleCollectorListener;
|
2014-05-13 10:13:00 -07:00
|
|
|
class nsICycleCollectorLogSink;
|
2013-04-30 10:41:22 -07:00
|
|
|
class nsISupports;
|
2014-05-13 10:13:00 -07:00
|
|
|
template<class T> struct already_AddRefed;
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2013-07-09 07:28:15 -07:00
|
|
|
#include "nsError.h"
|
|
|
|
#include "nsID.h"
|
|
|
|
|
2014-11-06 01:14:00 -08:00
|
|
|
#include "js/SliceBudget.h"
|
|
|
|
|
2013-06-18 12:02:16 -07:00
|
|
|
namespace mozilla {
|
|
|
|
class CycleCollectedJSRuntime;
|
2015-07-13 08:25:42 -07:00
|
|
|
} // namespace mozilla
|
2013-06-18 12:02:16 -07:00
|
|
|
|
2013-03-25 14:26:00 -07:00
|
|
|
bool nsCycleCollector_init();
|
|
|
|
|
2013-08-13 10:45:32 -07:00
|
|
|
void nsCycleCollector_startup();
|
2012-01-14 08:58:05 -08:00
|
|
|
|
|
|
|
typedef void (*CC_BeforeUnlinkCallback)(void);
|
|
|
|
void nsCycleCollector_setBeforeUnlinkCallback(CC_BeforeUnlinkCallback aCB);
|
|
|
|
|
|
|
|
typedef void (*CC_ForgetSkippableCallback)(void);
|
|
|
|
void nsCycleCollector_setForgetSkippableCallback(CC_ForgetSkippableCallback aCB);
|
|
|
|
|
2013-07-27 03:48:45 -07:00
|
|
|
void nsCycleCollector_forgetSkippable(bool aRemoveChildlessNodes = false,
|
|
|
|
bool aAsyncSnowWhiteFreeing = false);
|
2012-01-14 08:58:05 -08:00
|
|
|
|
2013-12-06 10:17:20 -08:00
|
|
|
void nsCycleCollector_prepareForGarbageCollection();
|
|
|
|
|
2014-05-06 17:25:26 -07:00
|
|
|
// If an incremental cycle collection is in progress, finish it.
|
|
|
|
void nsCycleCollector_finishAnyCurrentCollection();
|
|
|
|
|
2013-08-03 16:55:39 -07:00
|
|
|
void nsCycleCollector_dispatchDeferredDeletion(bool aContinuation = false);
|
|
|
|
bool nsCycleCollector_doDeferredDeletion();
|
2013-07-09 10:30:58 -07:00
|
|
|
|
2014-05-13 10:13:00 -07:00
|
|
|
already_AddRefed<nsICycleCollectorLogSink> nsCycleCollector_createLogSink();
|
|
|
|
|
2014-05-13 10:41:38 -07:00
|
|
|
void nsCycleCollector_collect(nsICycleCollectorListener* aManualListener);
|
2013-12-22 06:58:19 -08:00
|
|
|
|
2014-11-27 03:47:51 -08:00
|
|
|
void nsCycleCollector_collectSlice(js::SliceBudget& budget,
|
|
|
|
bool aPreferShorterSlices = false);
|
2014-05-06 17:25:26 -07:00
|
|
|
|
2012-08-22 08:56:38 -07:00
|
|
|
uint32_t nsCycleCollector_suspectedCount();
|
2007-03-27 02:49:06 -07:00
|
|
|
void nsCycleCollector_shutdown();
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2012-05-03 12:28:11 -07:00
|
|
|
// Helpers for interacting with JS
|
2014-05-13 10:41:38 -07:00
|
|
|
void nsCycleCollector_registerJSRuntime(mozilla::CycleCollectedJSRuntime* aRt);
|
2012-05-03 12:28:11 -07:00
|
|
|
void nsCycleCollector_forgetJSRuntime();
|
|
|
|
|
2010-08-11 17:03:23 -07:00
|
|
|
#define NS_CYCLE_COLLECTOR_LOGGER_CID \
|
|
|
|
{ 0x58be81b4, 0x39d2, 0x437c, \
|
|
|
|
{ 0x94, 0xea, 0xae, 0xde, 0x2c, 0x62, 0x08, 0xd3 } }
|
|
|
|
|
|
|
|
extern nsresult
|
2014-05-13 10:41:38 -07:00
|
|
|
nsCycleCollectorLoggerConstructor(nsISupports* aOuter,
|
2010-08-11 17:03:23 -07:00
|
|
|
const nsIID& aIID,
|
2014-05-13 10:41:38 -07:00
|
|
|
void** aInstancePtr);
|
2010-08-11 17:03:23 -07:00
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
#endif // nsCycleCollector_h__
|