Bug 1287002: Add RAII class for entering a COM apartment; r=jimm
authorAaron Klotz <aklotz@mozilla.com>
Fri, 03 Jun 2016 12:30:31 -0600
changeset 330514 1021393b4763a25937de84d4ab4699d2ebf88e16
parent 330513 9c96b9d1b0600f166ead8eddf12563911c8a40b5
child 330515 88553f61add42e93353efa42246736172e22d020
push id9858
push userjlund@mozilla.com
push dateMon, 01 Aug 2016 14:37:10 +0000
treeherdermozilla-aurora@203106ef6cb6 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersjimm
bugs1287002
milestone50.0a1
Bug 1287002: Add RAII class for entering a COM apartment; r=jimm MozReview-Commit-ID: DEwU3vU1P5P
ipc/mscom/COMApartmentRegion.h
ipc/mscom/moz.build
new file mode 100644
--- /dev/null
+++ b/ipc/mscom/COMApartmentRegion.h
@@ -0,0 +1,62 @@
+/* -*- 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/. */
+
+#ifndef mozilla_mscom_COMApartmentRegion_h
+#define mozilla_mscom_COMApartmentRegion_h
+
+#include "mozilla/Assertions.h"
+#include "mozilla/Attributes.h"
+
+#include <objbase.h>
+
+namespace mozilla {
+namespace mscom {
+
+template<COINIT T>
+class MOZ_RAII COMApartmentRegion
+{
+public:
+  COMApartmentRegion()
+    : mInitResult(::CoInitializeEx(nullptr, T))
+  {
+    // If this fires then we're probably mixing apartments on the same thread
+    MOZ_ASSERT(IsValid());
+  }
+
+  ~COMApartmentRegion()
+  {
+    if (IsValid()) {
+      ::CoUninitialize();
+    }
+  }
+
+  bool IsValidOutermost() const
+  {
+    return mInitResult == S_OK;
+  }
+
+  bool IsValid() const
+  {
+    return SUCCEEDED(mInitResult);
+  }
+
+private:
+  COMApartmentRegion(const COMApartmentRegion&) = delete;
+  COMApartmentRegion& operator=(const COMApartmentRegion&) = delete;
+  COMApartmentRegion(COMApartmentRegion&&) = delete;
+  COMApartmentRegion& operator=(COMApartmentRegion&&) = delete;
+
+  HRESULT mInitResult;
+};
+
+typedef COMApartmentRegion<COINIT_APARTMENTTHREADED> STARegion;
+typedef COMApartmentRegion<COINIT_MULTITHREADED> MTARegion;
+
+} // namespace mscom
+} // namespace mozilla
+
+#endif // mozilla_mscom_COMApartmentRegion_h
+
--- a/ipc/mscom/moz.build
+++ b/ipc/mscom/moz.build
@@ -1,15 +1,16 @@
 # -*- Mode: python; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 40 -*-
 # vim: set filetype=python:
 # 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/.
 
 EXPORTS.mozilla.mscom += [
+    'COMApartmentRegion.h',
 ]
 
 UNIFIED_SOURCES += [
 ]
 
 include('/ipc/chromium/chromium-config.mozbuild')
 
 FINAL_LIBRARY = 'xul'