The Tor Browser: accessible/src/base/Logging.h@b8a032363ba2 (annotated)

accessible/src/base/Logging.h@b8a032363ba2 (annotated)

accessible/src/base/Logging.h

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* vim: set ts=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_a11y_logs_h__
 #define mozilla_a11y_logs_h__
 #include "nscore.h"
 #include "nsStringFwd.h"
 class nsIDocument;
 class nsINode;
 class nsIRequest;
 class nsISelection;
 class nsISupports;
 class nsIWebProgress;
 namespace mozilla {
 namespace a11y {
 class AccEvent;
 class Accessible;
 class DocAccessible;
 class OuterDocAccessible;
 namespace logging {
 enum EModules {
   eDocLoad = 1 << 0,
   eDocCreate = 1 << 1,
   eDocDestroy = 1 << 2,
   eDocLifeCycle = eDocLoad | eDocCreate | eDocDestroy,
   eEvents = 1 << 3,
   ePlatforms = 1 << 4,
   eStack = 1 << 5,
   eText = 1 << 6,
   eTree = 1 << 7,
   eDOMEvents = 1 << 8,
   eFocus = 1 << 9,
   eSelection = 1 << 10,
   eNotifications = eDOMEvents | eSelection | eFocus
 };
 /**
  * Return true if any of the given modules is logged.
  */
 bool IsEnabled(uint32_t aModules);
 /**
  * Return true if the given module is logged.
  */
 bool IsEnabled(const nsAString& aModules);
 /**
  * Log the document loading progress.
  */
 void DocLoad(const char* aMsg, nsIWebProgress* aWebProgress,
              nsIRequest* aRequest, uint32_t aStateFlags);
 void DocLoad(const char* aMsg, nsIDocument* aDocumentNode);
 void DocCompleteLoad(DocAccessible* aDocument, bool aIsLoadEventTarget);
 /**
  * Log that document load event was fired.
  */
 void DocLoadEventFired(AccEvent* aEvent);
 /**
  * Log that document laod event was handled.
  */
 void DocLoadEventHandled(AccEvent* aEvent);
 /**
  * Log the document was created.
  */
 void DocCreate(const char* aMsg, nsIDocument* aDocumentNode,
                DocAccessible* aDocument = nullptr);
 /**
  * Log the document was destroyed.
  */
 void DocDestroy(const char* aMsg, nsIDocument* aDocumentNode,
                 DocAccessible* aDocument = nullptr);
 /**
  * Log the outer document was destroyed.
  */
 void OuterDocDestroy(OuterDocAccessible* OuterDoc);
 /**
  * Log the focus notification target.
  */
 void FocusNotificationTarget(const char* aMsg, const char* aTargetDescr,
                              Accessible* aTarget);
 void FocusNotificationTarget(const char* aMsg, const char* aTargetDescr,
                              nsINode* aTargetNode);
 void FocusNotificationTarget(const char* aMsg, const char* aTargetDescr,
                              nsISupports* aTargetThing);
 /**
  * Log a cause of active item descendant change (submessage).
  */
 void ActiveItemChangeCausedBy(const char* aMsg, Accessible* aTarget);
 /**
  * Log the active widget (submessage).
  */
 void ActiveWidget(Accessible* aWidget);
 /**
  * Log the focus event was dispatched (submessage).
  */
 void FocusDispatched(Accessible* aTarget);
 /**
  * Log the selection change.
  */
 void SelChange(nsISelection* aSelection, DocAccessible* aDocument,
                int16_t aReason);
 /**
  * Log the message ('title: text' format) on new line. Print the start and end
  * boundaries of the message body designated by '{' and '}' (2 spaces indent for
  * body).
  */
 void MsgBegin(const char* aTitle, const char* aMsgText, ...);
 void MsgEnd();
 /**
  * Print start and end boundaries of the message body designated by '{' and '}'
  * (2 spaces indent for body).
  */
 void SubMsgBegin();
 void SubMsgEnd();
 /**
  * Log the entry into message body (4 spaces indent).
  */
 void MsgEntry(const char* aEntryText, ...);
 /**
  * Log the text, two spaces offset is used.
  */
 void Text(const char* aText);
 /**
  * Log the accessible object address as message entry (4 spaces indent).
  */
 void Address(const char* aDescr, Accessible* aAcc);
 /**
  * Log the DOM node info as message entry.
  */
 void Node(const char* aDescr, nsINode* aNode);
 /**
  * Log the document accessible info as message entry.
  */
 void Document(DocAccessible* aDocument);
 /**
  * Log the accessible and its DOM node as a message entry.
  */
 void AccessibleNNode(const char* aDescr, Accessible* aAccessible);
 void AccessibleNNode(const char* aDescr, nsINode* aNode);
 /**
  * Log the DOM event.
  */
 void DOMEvent(const char* aDescr, nsINode* aOrigTarget,
               const nsAString& aEventType);
 /**
  * Log the call stack, two spaces offset is used.
  */
 void Stack();
 /**
  * Enable logging of the specified modules, all other modules aren't logged.
  */
 void Enable(const nsAFlatCString& aModules);
 /**
  * Enable logging of modules specified by A11YLOG environment variable,
  * all other modules aren't logged.
  */
 void CheckEnv();
 } // namespace logs
 } // namespace a11y
 } // namespace mozilla
 #endif

The Tor Browser / annotate

accessible/src/base/Logging.h@b8a032363ba2 (annotated)

accessible/src/base/Logging.h