dom/console/ConsoleInstance.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 #ifndef mozilla_dom_ConsoleInstance_h
   8 #define mozilla_dom_ConsoleInstance_h
   9
  10 #include "mozilla/dom/Console.h"
  11
  12 namespace mozilla::dom {
  13
  14 class ConsoleInstance final : public nsISupports, public nsWrapperCache {
  15  public:
  16   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  17   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(ConsoleInstance)
  18
  19   explicit ConsoleInstance(JSContext* aCx,
  20                            const ConsoleInstanceOptions& aOptions);
  21
  22   // WebIDL methods
  23   JSObject* WrapObject(JSContext* aCx,
  24                        JS::Handle<JSObject*> aGivenProto) override;
  25
  26   nsPIDOMWindowInner* GetParentObject() const { return nullptr; }
  27
  28   MOZ_CAN_RUN_SCRIPT
  29   void Log(JSContext* aCx, const Sequence<JS::Value>& aData);
  30
  31   MOZ_CAN_RUN_SCRIPT
  32   void Info(JSContext* aCx, const Sequence<JS::Value>& aData);
  33
  34   MOZ_CAN_RUN_SCRIPT
  35   void Warn(JSContext* aCx, const Sequence<JS::Value>& aData);
  36
  37   MOZ_CAN_RUN_SCRIPT
  38   void Error(JSContext* aCx, const Sequence<JS::Value>& aData);
  39
  40   MOZ_CAN_RUN_SCRIPT
  41   void Exception(JSContext* aCx, const Sequence<JS::Value>& aData);
  42
  43   MOZ_CAN_RUN_SCRIPT
  44   void Debug(JSContext* aCx, const Sequence<JS::Value>& aData);
  45
  46   MOZ_CAN_RUN_SCRIPT
  47   void Table(JSContext* aCx, const Sequence<JS::Value>& aData);
  48
  49   MOZ_CAN_RUN_SCRIPT
  50   void Trace(JSContext* aCx, const Sequence<JS::Value>& aData);
  51
  52   MOZ_CAN_RUN_SCRIPT
  53   void Dir(JSContext* aCx, const Sequence<JS::Value>& aData);
  54
  55   MOZ_CAN_RUN_SCRIPT
  56   void Dirxml(JSContext* aCx, const Sequence<JS::Value>& aData);
  57
  58   MOZ_CAN_RUN_SCRIPT
  59   void Group(JSContext* aCx, const Sequence<JS::Value>& aData);
  60
  61   MOZ_CAN_RUN_SCRIPT
  62   void GroupCollapsed(JSContext* aCx, const Sequence<JS::Value>& aData);
  63
  64   MOZ_CAN_RUN_SCRIPT
  65   void GroupEnd(JSContext* aCx);
  66
  67   MOZ_CAN_RUN_SCRIPT
  68   void Time(JSContext* aCx, const nsAString& aLabel);
  69
  70   MOZ_CAN_RUN_SCRIPT
  71   void TimeLog(JSContext* aCx, const nsAString& aLabel,
  72                const Sequence<JS::Value>& aData);
  73
  74   MOZ_CAN_RUN_SCRIPT
  75   void TimeEnd(JSContext* aCx, const nsAString& aLabel);
  76
  77   MOZ_CAN_RUN_SCRIPT
  78   void TimeStamp(JSContext* aCx, const JS::Handle<JS::Value> aData);
  79
  80   MOZ_CAN_RUN_SCRIPT
  81   void Profile(JSContext* aCx, const Sequence<JS::Value>& aData);
  82
  83   MOZ_CAN_RUN_SCRIPT
  84   void ProfileEnd(JSContext* aCx, const Sequence<JS::Value>& aData);
  85
  86   MOZ_CAN_RUN_SCRIPT
  87   void Assert(JSContext* aCx, bool aCondition,
  88               const Sequence<JS::Value>& aData);
  89
  90   MOZ_CAN_RUN_SCRIPT
  91   void Count(JSContext* aCx, const nsAString& aLabel);
  92
  93   MOZ_CAN_RUN_SCRIPT
  94   void CountReset(JSContext* aCx, const nsAString& aLabel);
  95
  96   MOZ_CAN_RUN_SCRIPT
  97   void Clear(JSContext* aCx);
  98
  99   bool ShouldLog(ConsoleLogLevel aLevel);
 100
 101   // For testing only.
 102   void ReportForServiceWorkerScope(const nsAString& aScope,
 103                                    const nsAString& aMessage,
 104                                    const nsAString& aFilename,
 105                                    uint32_t aLineNumber, uint32_t aColumnNumber,
 106                                    ConsoleLevel aLevel);
 107
 108  private:
 109   ~ConsoleInstance();
 110
 111   void SetLogLevel();
 112   static void MaxLogLevelPrefChangedCallback(const char* /* aPrefName */,
 113                                              void* /* aClosure */);
 114
 115   ConsoleLogLevel mMaxLogLevel;
 116   nsCString mMaxLogLevelPref;
 117   RefPtr<Console> mConsole;
 118 };
 119
 120 }  // namespace mozilla::dom
 121
 122 #endif  // mozilla_dom_ConsoleInstance_h