accessible/src/base/Logging.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=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 file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_a11y_logs_h__
   8 #define mozilla_a11y_logs_h__
   9
  10 #include "nscore.h"
  11 #include "nsAString.h"
  12
  13 class nsIDocument;
  14 class nsINode;
  15 class nsIRequest;
  16 class nsISelection;
  17 class nsIWebProgress;
  18
  19 namespace mozilla {
  20 namespace a11y {
  21
  22 class AccEvent;
  23 class Accessible;
  24 class DocAccessible;
  25 class OuterDocAccessible;
  26
  27 namespace logging {
  28
  29 enum EModules {
  30   eDocLoad = 1 << 0,
  31   eDocCreate = 1 << 1,
  32   eDocDestroy = 1 << 2,
  33   eDocLifeCycle = eDocLoad | eDocCreate | eDocDestroy,
  34
  35   eEvents = 1 << 3,
  36   ePlatforms = 1 << 4,
  37   eStack = 1 << 5,
  38   eText = 1 << 6,
  39   eTree = 1 << 7,
  40
  41   eDOMEvents = 1 << 8,
  42   eFocus = 1 << 9,
  43   eSelection = 1 << 10,
  44   eNotifications = eDOMEvents | eSelection | eFocus
  45 };
  46
  47 /**
  48  * Return true if any of the given modules is logged.
  49  */
  50 bool IsEnabled(uint32_t aModules);
  51
  52 /**
  53  * Return true if the given module is logged.
  54  */
  55 bool IsEnabled(const nsAString& aModules);
  56
  57 /**
  58  * Log the document loading progress.
  59  */
  60 void DocLoad(const char* aMsg, nsIWebProgress* aWebProgress,
  61              nsIRequest* aRequest, uint32_t aStateFlags);
  62 void DocLoad(const char* aMsg, nsIDocument* aDocumentNode);
  63 void DocCompleteLoad(DocAccessible* aDocument, bool aIsLoadEventTarget);
  64
  65 /**
  66  * Log that document load event was fired.
  67  */
  68 void DocLoadEventFired(AccEvent* aEvent);
  69
  70 /**
  71  * Log that document laod event was handled.
  72  */
  73 void DocLoadEventHandled(AccEvent* aEvent);
  74
  75 /**
  76  * Log the document was created.
  77  */
  78 void DocCreate(const char* aMsg, nsIDocument* aDocumentNode,
  79                DocAccessible* aDocument = nullptr);
  80
  81 /**
  82  * Log the document was destroyed.
  83  */
  84 void DocDestroy(const char* aMsg, nsIDocument* aDocumentNode,
  85                 DocAccessible* aDocument = nullptr);
  86
  87 /**
  88  * Log the outer document was destroyed.
  89  */
  90 void OuterDocDestroy(OuterDocAccessible* OuterDoc);
  91
  92 /**
  93  * Log the focus notification target.
  94  */
  95 void FocusNotificationTarget(const char* aMsg, const char* aTargetDescr,
  96                              Accessible* aTarget);
  97 void FocusNotificationTarget(const char* aMsg, const char* aTargetDescr,
  98                              nsINode* aTargetNode);
  99 void FocusNotificationTarget(const char* aMsg, const char* aTargetDescr,
 100                              nsISupports* aTargetThing);
 101
 102 /**
 103  * Log a cause of active item descendant change (submessage).
 104  */
 105 void ActiveItemChangeCausedBy(const char* aMsg, Accessible* aTarget);
 106
 107 /**
 108  * Log the active widget (submessage).
 109  */
 110 void ActiveWidget(Accessible* aWidget);
 111
 112 /**
 113  * Log the focus event was dispatched (submessage).
 114  */
 115 void FocusDispatched(Accessible* aTarget);
 116
 117 /**
 118  * Log the selection change.
 119  */
 120 void SelChange(nsISelection* aSelection, DocAccessible* aDocument);
 121
 122 /**
 123  * Log the message ('title: text' format) on new line. Print the start and end
 124  * boundaries of the message body designated by '{' and '}' (2 spaces indent for
 125  * body).
 126  */
 127 void MsgBegin(const char* aTitle, const char* aMsgText, ...);
 128 void MsgEnd();
 129
 130 /**
 131  * Print start and end boundaries of the message body designated by '{' and '}'
 132  * (2 spaces indent for body).
 133  */
 134 void SubMsgBegin();
 135 void SubMsgEnd();
 136
 137 /**
 138  * Log the entry into message body (4 spaces indent).
 139  */
 140 void MsgEntry(const char* aEntryText, ...);
 141
 142 /**
 143  * Log the text, two spaces offset is used.
 144  */
 145 void Text(const char* aText);
 146
 147 /**
 148  * Log the accessible object address as message entry (4 spaces indent).
 149  */
 150 void Address(const char* aDescr, Accessible* aAcc);
 151
 152 /**
 153  * Log the DOM node info as message entry.
 154  */
 155 void Node(const char* aDescr, nsINode* aNode);
 156
 157 /**
 158  * Log the document accessible info as message entry.
 159  */
 160 void Document(DocAccessible* aDocument);
 161
 162 /**
 163  * Log the accessible and its DOM node as a message entry.
 164  */
 165 void AccessibleNNode(const char* aDescr, Accessible* aAccessible);
 166 void AccessibleNNode(const char* aDescr, nsINode* aNode);
 167
 168 /**
 169  * Log the DOM event.
 170  */
 171 void DOMEvent(const char* aDescr, nsINode* aOrigTarget,
 172               const nsAString& aEventType);
 173
 174 /**
 175  * Log the call stack, two spaces offset is used.
 176  */
 177 void Stack();
 178
 179 /**
 180  * Enable logging of the specified modules, all other modules aren't logged.
 181  */
 182 void Enable(const nsAFlatCString& aModules);
 183
 184 /**
 185  * Enable logging of modules specified by A11YLOG environment variable,
 186  * all other modules aren't logged.
 187  */
 188 void CheckEnv();
 189
 190 } // namespace logs
 191 } // namespace a11y
 192 } // namespace mozilla
 193
 194 #endif
 195