gecko-dev/ipc/mscom/EnsureMTA.cpp
Nicholas Nethercote 34dcc7b852 Bug 1299384 - Use MOZ_MUST_USE with NS_warn_if_impl(). r=erahm.
This change avoids lots of false positives for Coverity's CHECKED_RETURN
warning, caused by NS_WARN_IF's current use in both statement-style and
expression-style.

In the case where the code within the NS_WARN_IF has side-effects, I made the
following change.

> NS_WARN_IF(NS_FAILED(FunctionWithSideEffects()));
> -->
> Unused << NS_WARN_IF(NS_FAILED(FunctionWithSideEffects()));

In the case where the code within the NS_WARN_IF lacks side-effects, I made the
following change.

> NS_WARN_IF(!condWithoutSideEffects);
> -->
> NS_WARNING_ASSERTION(condWithoutSideEffects, "msg");

This has two improvements.
- The condition is not evaluated in non-debug builds.
- The sense of the condition is inverted to the familiar "this condition should
  be true" sense used in assertions.

A common variation on the side-effect-free case is the following.

> nsresult rv = Fn();
> NS_WARN_IF_(NS_FAILED(rv));
> -->
> DebugOnly<nsresult rv> = Fn();
> NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "Fn failed");

--HG--
extra : rebase_source : 58788245021096efa8372a9dc1d597a611d45611
2016-09-02 17:12:24 +10:00

79 lines
1.8 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */
#include "mozilla/mscom/EnsureMTA.h"
#include "mozilla/ClearOnShutdown.h"
#include "mozilla/StaticPtr.h"
#include "nsThreadUtils.h"
#include "private/pprthred.h"
namespace {
class EnterMTARunnable : public mozilla::Runnable
{
public:
NS_IMETHOD Run() override
{
mozilla::DebugOnly<HRESULT> hr = ::CoInitializeEx(nullptr,
COINIT_MULTITHREADED);
MOZ_ASSERT(SUCCEEDED(hr));
return NS_OK;
}
};
class BackgroundMTAData
{
public:
BackgroundMTAData()
{
nsCOMPtr<nsIRunnable> runnable = new EnterMTARunnable();
nsresult rv = NS_NewNamedThread("COM MTA",
getter_AddRefs(mThread), runnable);
NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "NS_NewNamedThread failed");
MOZ_ASSERT(NS_SUCCEEDED(rv));
}
~BackgroundMTAData()
{
if (mThread) {
mThread->Dispatch(NS_NewRunnableFunction(&::CoUninitialize),
NS_DISPATCH_NORMAL);
mThread->Shutdown();
}
}
nsCOMPtr<nsIThread> GetThread() const
{
return mThread;
}
private:
nsCOMPtr<nsIThread> mThread;
};
} // anonymous namespace
static mozilla::StaticAutoPtr<BackgroundMTAData> sMTAData;
namespace mozilla {
namespace mscom {
/* static */ nsCOMPtr<nsIThread>
EnsureMTA::GetMTAThread()
{
if (!sMTAData) {
sMTAData = new BackgroundMTAData();
ClearOnShutdown(&sMTAData, ShutdownPhase::ShutdownThreads);
}
return sMTAData->GetThread();
}
} // namespace mscom
} // namespace mozilla