Bug 706958 - Add ClearOnShutdown() function which will clear a smart pointer... (36337622) · Commits · The Tor Project / Applications / Mullvad Browser

hal/Hal.cpp

+2 −32

Original line number	Original line	Diff line number	Diff line
	@@ -47,12 +47,11 @@
	#include "nsIDOMDocument.h"		#include "nsIDOMDocument.h"
	#include "nsIDOMWindow.h"		#include "nsIDOMWindow.h"
	#include "nsPIDOMWindow.h"		#include "nsPIDOMWindow.h"
	#include "nsIObserver.h"
	#include "nsIObserverService.h"
	#include "mozilla/Services.h"		#include "mozilla/Services.h"
	#include "nsIWebNavigation.h"		#include "nsIWebNavigation.h"
	#include "nsITabChild.h"		#include "nsITabChild.h"
	#include "nsIDocShell.h"		#include "nsIDocShell.h"
			#include "mozilla/ClearOnShutdown.h"

	using namespace mozilla::dom;		using namespace mozilla::dom;
	using namespace mozilla::services;		using namespace mozilla::services;
	@@ -110,39 +109,10 @@ WindowIsActive(nsIDOMWindow *window)

	nsAutoPtr<WindowIdentifier::IDArrayType> gLastIDToVibrate;		nsAutoPtr<WindowIdentifier::IDArrayType> gLastIDToVibrate;

	// This observer makes sure we delete gLastIDToVibrate, so we don't
	// leak.
	class ShutdownObserver : public nsIObserver
	{
	public:
	ShutdownObserver() {}
	virtual ~ShutdownObserver() {}

	NS_DECL_ISUPPORTS

	NS_IMETHOD Observe(nsISupports subject, const char aTopic,
	const PRUnichar *aData)
	{
	MOZ_ASSERT(strcmp(aTopic, NS_XPCOM_SHUTDOWN_OBSERVER_ID) == 0);
	gLastIDToVibrate = nsnull;
	return NS_OK;
	}
	};

	NS_IMPL_ISUPPORTS1(ShutdownObserver, nsIObserver);

	void InitLastIDToVibrate()		void InitLastIDToVibrate()
	{		{
	gLastIDToVibrate = new WindowIdentifier::IDArrayType();		gLastIDToVibrate = new WindowIdentifier::IDArrayType();
			ClearOnShutdown(&gLastIDToVibrate);
	nsCOMPtr<nsIObserverService> observerService = GetObserverService();
	if (!observerService) {
	NS_WARNING("Could not get observer service!");
	return;
	}

	ShutdownObserver *obs = new ShutdownObserver();
	observerService->AddObserver(obs, NS_XPCOM_SHUTDOWN_OBSERVER_ID, false);
	}		}

	} // anonymous namespace		} // anonymous namespace

xpcom/base/ClearOnShutdown.h

0 → 100644

+119 −0

Original line number	Original line	Diff line number	Diff line
			/* -- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -- */
			/* vim: set sw=2 ts=8 et ft=cpp : */
			/* *** BEGIN LICENSE BLOCK ***
			* Version: MPL 1.1/GPL 2.0/LGPL 2.1
			*
			* The contents of this file are subject to the Mozilla Public License Version
			* 1.1 (the "License"); you may not use this file except in compliance with
			* the License. You may obtain a copy of the License at:
			* http://www.mozilla.org/MPL/
			*
			* Software distributed under the License is distributed on an "AS IS" basis,
			* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
			* for the specific language governing rights and limitations under the
			* License.
			*
			* The Original Code is Mozilla Code.
			*
			* The Initial Developer of the Original Code is
			* The Mozilla Foundation
			* Portions created by the Initial Developer are Copyright (C) 2011
			* the Initial Developer. All Rights Reserved.
			*
			* Contributor(s):
			* Justin Lebar <justin.lebar@gmail.com>
			*
			* Alternatively, the contents of this file may be used under the terms of
			* either the GNU General Public License Version 2 or later (the "GPL"), or
			* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
			* in which case the provisions of the GPL or the LGPL are applicable instead
			* of those above. If you wish to allow use of your version of this file only
			* under the terms of either the GPL or the LGPL, and not to allow others to
			* use your version of this file under the terms of the MPL, indicate your
			* decision by deleting the provisions above and replace them with the notice
			* and other provisions required by the GPL or the LGPL. If you do not delete
			* the provisions above, a recipient may use your version of this file under
			* the terms of any one of the MPL, the GPL or the LGPL.
			*
			* *** END LICENSE BLOCK *** */

			#ifndef mozilla_ClearOnShutdown_h

			#include <nsAutoPtr.h>
			#include <nsCOMPtr.h>
			#include <nsIObserver.h>
			#include <nsIObserverService.h>
			#include <mozilla/Services.h>

			/*
			* This header exports one method in the mozilla namespace:
			*
			* template<class SmartPtr>
			* void ClearOnShutdown(SmartPtr *aPtr)
			*
			* This function takes a pointer to a smart pointer (i.e., nsCOMPtr<T>*,
			* nsRefPtr<T>, or nsAutoPtr<T>) and nulls the smart pointer on shutdown.
			*
			* This is useful if you have a global smart pointer object which you don't
			* want to "leak" on shutdown.
			*
			* There is no way to undo a call to ClearOnShutdown, so you can call it only
			* on smart pointers which you know will live until the program shuts down.
			*/

			namespace mozilla {
			namespace ClearOnShutdown_Internal {

			template<class SmartPtr>
			class ShutdownObserver : public nsIObserver
			{
			public:
			ShutdownObserver(SmartPtr *aPtr)
			: mPtr(aPtr)
			{}

			virtual ~ShutdownObserver()
			{}

			NS_IMETHOD QueryInterface(REFNSIID aIID, void ** aInstancePtr);
			NS_INLINE_DECL_REFCOUNTING(ShutdownObserver)

			NS_IMETHOD Observe(nsISupports aSubject, const char aTopic,
			const PRUnichar *aData)
			{
			MOZ_ASSERT(strcmp(aTopic, NS_XPCOM_SHUTDOWN_OBSERVER_ID) == 0);

			if (mPtr) {
			*mPtr = NULL;
			}

			return NS_OK;
			}

			private:
			SmartPtr *mPtr;
			};

			// This is horrible, but I don't see a better way.
			template<class SmartPtr>
			NS_IMPL_QUERY_INTERFACE1(ShutdownObserver<SmartPtr>, nsIObserver)

			} // namespace ClearOnShutdown_Internal

			template<class SmartPtr>
			void ClearOnShutdown(SmartPtr *aPtr)
			{
			nsRefPtr<ClearOnShutdown_Internal::ShutdownObserver<SmartPtr> > observer =
			new ClearOnShutdown_Internal::ShutdownObserver<SmartPtr>(aPtr);

			nsCOMPtr<nsIObserverService> os = services::GetObserverService();
			if (!os) {
			NS_WARNING("Could not get observer service!");
			return;
			}
			os->AddObserver(observer, NS_XPCOM_SHUTDOWN_OBSERVER_ID, false);
			}

			} // namespace mozilla

			#endif

xpcom/base/Makefile.in

+1 −0

Original line number	Original line	Diff line number	Diff line
	@@ -100,6 +100,7 @@ EXPORTS_NAMESPACES = mozilla
	EXPORTS_mozilla = \		EXPORTS_mozilla = \
	FunctionTimer.h \		FunctionTimer.h \
	MapsMemoryReporter.h \		MapsMemoryReporter.h \
			ClearOnShutdown.h \
	$(NULL)		$(NULL)

	ifeq (windows,$(MOZ_WIDGET_TOOLKIT))		ifeq (windows,$(MOZ_WIDGET_TOOLKIT))