xpcom/base/nsIDebug2.idl

   1 /* vim: set shiftwidth=4 tabstop=8 autoindent cindent expandtab: */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /* interface to expose information about calls to NS_DebugBreak */
   7
   8 #include "nsISupports.idl"
   9
  10 /**
  11  *   @note C/C++ consumers who are planning to use the nsIDebug2 interface with
  12  *   the "@mozilla.org/xpcom;1" contract should use NS_DebugBreak from xpcom
  13  *   glue instead.
  14  *
  15  */
  16
  17 [builtinclass, scriptable, uuid(9641dc15-10fb-42e3-a285-18be90a5c10b)]
  18 interface nsIDebug2 : nsISupports
  19 {
  20     /**
  21      * Whether XPCOM was compiled with DEBUG defined.  This often
  22      * correlates to whether other code (e.g., Firefox, XULRunner) was
  23      * compiled with DEBUG defined.
  24      */
  25     readonly attribute boolean isDebugBuild;
  26
  27     /**
  28      * The number of assertions since process start.
  29      */
  30     readonly attribute long assertionCount;
  31
  32     /**
  33      * Whether a debugger is currently attached.
  34      * Supports Windows + Mac
  35      */
  36     readonly attribute boolean isDebuggerAttached;
  37
  38     /**
  39      * Show an assertion and trigger nsIDebug2.break().
  40      *
  41      * @param aStr assertion message
  42      * @param aExpr expression that failed
  43      * @param aFile file containing assertion
  44      * @param aLine line number of assertion
  45      */
  46     void assertion(in string aStr,
  47                    in string aExpr,
  48                    in string aFile,
  49                    in long aLine);
  50
  51     /**
  52      * Show a warning.
  53      *
  54      * @param aStr warning message
  55      * @param aFile file containing assertion
  56      * @param aLine line number of assertion
  57      */
  58     void warning(in string aStr,
  59                  in string aFile,
  60                  in long aLine);
  61
  62     /**
  63      * Request to break into a debugger.
  64      *
  65      * @param aFile file containing break request
  66      * @param aLine line number of break request
  67      */
  68     void break(in string aFile,
  69                in long aLine);
  70
  71     /**
  72      * Request the process to trigger a fatal abort.
  73      *
  74      * @param aFile file containing abort request
  75      * @param aLine line number of abort request
  76      */
  77     void abort(in string aFile,
  78                in long aLine);
  79
  80     /**
  81      * Request the process to trigger a fatal panic!() from Rust code.
  82      *
  83      * @param aMessage the string to pass to panic!().
  84      */
  85     void rustPanic(in string aMessage);
  86
  87     /**
  88      * Request the process to log a message for a target and level from Rust code.
  89      *
  90      * @param aTarget the string representing the log target.
  91      * @param aMessage the string representing the log message.
  92      */
  93     void rustLog(in string aTarget,
  94                  in string aMessage);
  95
  96     /**
  97      * Cause an Out of Memory Crash.
  98      */
  99     void crashWithOOM();
 100 };