xpcom/base/nsIDebug.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is XPCOM
  15  *
  16  * The Initial Developer of the Original Code is Doug Turner <dougt@meer.net>
  17  *
  18  * Portions created by the Initial Developer are Copyright (C) 2003
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37
  38 #include "nsISupports.idl"
  39
  40 /**
  41  *   For use by consumers in scripted languages (JavaScript, Java, Python,
  42  *   Perl, ...).
  43  *
  44  * @note C/C++ consumers who are planning to use the nsIDebug interface with
  45  *   the "@mozilla.org/xpcom;1" contract should use NS_DebugBreak from xpcom
  46  *   glue instead.
  47  *
  48  */
  49
  50 [scriptable, uuid(3bf0c3d7-3bd9-4cf2-a971-33572c503e1e)]
  51 interface nsIDebug : nsISupports
  52 {
  53   /**
  54    * Show an assertion and trigger nsIDebug.break().
  55    *
  56    * @param aStr assertion message
  57    * @param aExpr expression that failed
  58    * @param aFile file containing assertion
  59    * @param aLine line number of assertion
  60    *
  61    */
  62   void assertion(in string aStr,
  63                  in string aExpr,
  64                  in string aFile,
  65                  in long aLine);
  66
  67   /**
  68    * Show a warning.
  69    *
  70    * @param aStr warning message
  71    * @param aFile file containing assertion
  72    * @param aLine line number of assertion
  73    */
  74   void warning(in string aStr,
  75                in string aFile,
  76                in long aLine);
  77
  78   /**
  79    * Request to break into a debugger.
  80    *
  81    * @param aFile file containing break request
  82    * @param aLine line number of break request
  83    */
  84   void break(in string aFile,
  85              in long aLine);
  86
  87   /**
  88    * Request the process to trigger a fatal abort.
  89    *
  90    * @param aFile file containing abort request
  91    * @param aLine line number of abort request
  92    */
  93   void abort(in string aFile,
  94              in long aLine);
  95 };
  96