1 files changed, 82 insertions, 0 deletions
diff --git a/toolkit/components/places/nsPlacesMacros.h b/toolkit/components/places/nsPlacesMacros.h
new file mode 100644
index 000000000..47ebe17ac
--- /dev/null
+++ b/toolkit/components/places/nsPlacesMacros.h
@@ -0,0 +1,82 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* 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 "nsIConsoleService.h"
+#include "nsIScriptError.h"
+
+#ifndef __FUNCTION__
+#define __FUNCTION__ __func__
+#endif
+
+// Call a method on each observer in a category cache, then call the same
+// method on the observer array.
+#define NOTIFY_OBSERVERS(canFire, cache, array, type, method)                  \
+  PR_BEGIN_MACRO                                                               \
+  if (canFire) {                                                               \
+    nsCOMArray<type> entries;                                                  \
+    cache.GetEntries(entries);                                                 \
+    for (int32_t idx = 0; idx < entries.Count(); ++idx)                        \
+        entries[idx]->method;                                                  \
+    ENUMERATE_WEAKARRAY(array, type, method)                                   \
+  }                                                                            \
+  PR_END_MACRO;
+
+#define NOTIFY_BOOKMARKS_OBSERVERS(canFire, cache, array, skipIf, method)      \
+  PR_BEGIN_MACRO                                                               \
+  if (canFire) {                                                               \
+    nsCOMArray<nsINavBookmarkObserver> entries;                                \
+    cache.GetEntries(entries);                                                 \
+    for (int32_t idx = 0; idx < entries.Count(); ++idx) {                      \
+      if (skipIf(entries[idx]))                                                \
+        continue;                                                              \
+      entries[idx]->method;                                                    \
+    }                                                                          \
+    for (uint32_t idx = 0; idx < array.Length(); ++idx) {                      \
+      const nsCOMPtr<nsINavBookmarkObserver> &e = array.ElementAt(idx).GetValue(); \
+      if (e) {                                                                 \
+        if (skipIf(e))                                                         \
+            continue;                                                          \
+        e->method;                                                             \
+      }                                                                        \
+    }                                                                          \
+  }                                                                            \
+  PR_END_MACRO;
+
+#define PLACES_FACTORY_SINGLETON_IMPLEMENTATION(_className, _sInstance)        \
+  _className * _className::_sInstance = nullptr;                                \
+                                                                               \
+  already_AddRefed<_className>                                                 \
+  _className::GetSingleton()                                                   \
+  {                                                                            \
+    if (_sInstance) {                                                          \
+      RefPtr<_className> ret = _sInstance;                                   \
+      return ret.forget();                                                     \
+    }                                                                          \
+    _sInstance = new _className();                                             \
+    RefPtr<_className> ret = _sInstance;                                     \
+    if (NS_FAILED(_sInstance->Init())) {                                       \
+      /* Null out ret before _sInstance so the destructor doesn't assert */    \
+      ret = nullptr;                                                           \
+      _sInstance = nullptr;                                                    \
+      return nullptr;                                                          \
+    }                                                                          \
+    return ret.forget();                                                       \
+  }
+
+#define PLACES_WARN_DEPRECATED()                                               \
+  PR_BEGIN_MACRO                                                               \
+  nsCString msg(__FUNCTION__);                                                 \
+  msg.AppendLiteral(" is deprecated and will be removed in the next version.");\
+  NS_WARNING(msg.get());                                                       \
+  nsCOMPtr<nsIConsoleService> cs = do_GetService(NS_CONSOLESERVICE_CONTRACTID);\
+  if (cs) {                                                                    \
+    nsCOMPtr<nsIScriptError> e = do_CreateInstance(NS_SCRIPTERROR_CONTRACTID); \
+    if (e && NS_SUCCEEDED(e->Init(NS_ConvertUTF8toUTF16(msg), EmptyString(),   \
+                                  EmptyString(), 0, 0,                         \
+                                  nsIScriptError::errorFlag, "Places"))) {     \
+      cs->LogMessage(e);                                                       \
+    }                                                                          \
+  }                                                                            \
+  PR_END_MACRO