xpcom/base/nsConsoleService.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /*
   8  * nsConsoleService class declaration.
   9  */
  10
  11 #ifndef __nsconsoleservice_h__
  12 #define __nsconsoleservice_h__
  13
  14 #include <cstdint>
  15 #include <utility>
  16
  17 #include "mozilla/Assertions.h"
  18 #include "mozilla/LinkedList.h"
  19 #include "mozilla/Mutex.h"
  20
  21 #include "MainThreadUtils.h"
  22 #include "nsCOMPtr.h"
  23 #include "nsInterfaceHashtable.h"
  24 #include "nsHashKeys.h"
  25
  26 #include "nsIConsoleListener.h"
  27 #include "nsIConsoleMessage.h"
  28 #include "nsIConsoleService.h"
  29 #include "nsIObserver.h"
  30 #include "nsISupports.h"
  31
  32 template <class T>
  33 class nsCOMArray;
  34
  35 class nsConsoleService final : public nsIConsoleService, public nsIObserver {
  36  public:
  37   nsConsoleService();
  38   nsresult Init();
  39
  40   NS_DECL_THREADSAFE_ISUPPORTS
  41   NS_DECL_NSICONSOLESERVICE
  42   NS_DECL_NSIOBSERVER
  43
  44   void SetIsDelivering() {
  45     MOZ_ASSERT(NS_IsMainThread());
  46     MOZ_ASSERT(!mDeliveringMessage);
  47     mDeliveringMessage = true;
  48   }
  49
  50   void SetDoneDelivering() {
  51     MOZ_ASSERT(NS_IsMainThread());
  52     MOZ_ASSERT(mDeliveringMessage);
  53     mDeliveringMessage = false;
  54   }
  55
  56   typedef nsInterfaceHashtable<nsISupportsHashKey, nsIConsoleListener>
  57       ListenerHash;
  58   void CollectCurrentListeners(nsCOMArray<nsIConsoleListener>& aListeners);
  59
  60  private:
  61   class MessageElement : public mozilla::LinkedListElement<MessageElement> {
  62    public:
  63     explicit MessageElement(nsIConsoleMessage* aMessage) : mMessage(aMessage) {}
  64
  65     nsIConsoleMessage* Get() { return mMessage.get(); }
  66
  67     // Swap directly into an nsCOMPtr to avoid spurious refcount
  68     // traffic off the main thread in debug builds from
  69     // NSCAP_ASSERT_NO_QUERY_NEEDED().
  70     void swapMessage(nsCOMPtr<nsIConsoleMessage>& aRetVal) {
  71       mMessage.swap(aRetVal);
  72     }
  73
  74     ~MessageElement();
  75
  76    private:
  77     nsCOMPtr<nsIConsoleMessage> mMessage;
  78
  79     MessageElement(const MessageElement&) = delete;
  80     MessageElement& operator=(const MessageElement&) = delete;
  81     MessageElement(MessageElement&&) = delete;
  82     MessageElement& operator=(MessageElement&&) = delete;
  83   };
  84
  85   ~nsConsoleService();
  86
  87   nsresult MaybeForwardScriptError(nsIConsoleMessage* aMessage, bool* sent);
  88
  89   void ClearMessagesForWindowID(const uint64_t innerID);
  90   void ClearMessages() MOZ_REQUIRES(mLock);
  91
  92   mozilla::LinkedList<MessageElement> mMessages MOZ_GUARDED_BY(mLock);
  93
  94   // The current size of mMessages.
  95   uint32_t mCurrentSize MOZ_GUARDED_BY(mLock);
  96
  97   // The maximum size of mMessages.
  98   const uint32_t mMaximumSize;
  99
 100   // Are we currently delivering a console message on the main thread? If
 101   // so, we suppress incoming messages on the main thread only, to avoid
 102   // infinite repitition.
 103   // Only touched on MainThread
 104   bool mDeliveringMessage;
 105
 106   // Listeners to notify whenever a new message is logged.
 107   ListenerHash mListeners MOZ_GUARDED_BY(mLock);
 108
 109   // To serialize interesting methods.
 110   mozilla::Mutex mLock;
 111 };
 112
 113 #endif /* __nsconsoleservice_h__ */