xpcom/system/nsIXULRuntime.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 the Mozilla XUL Toolkit.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Benjamin Smedberg <benjamin@smedbergs.us>
  18  *
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 /**
  41  * Provides information about the XUL runtime.
  42  * @status UNSTABLE - This interface is not frozen and will probably change in
  43  *                    future releases. If you need this functionality to be
  44  *                    stable/frozen, please contact Benjamin Smedberg.
  45  */
  46
  47 [scriptable, uuid(7685dac8-3637-4660-a544-928c5ec0e714)]
  48 interface nsIXULRuntime : nsISupports
  49 {
  50   /**
  51    * Whether the application was launched in safe mode.
  52    */
  53   readonly attribute boolean inSafeMode;
  54
  55   /**
  56    * Whether to write console errors to a log file. If a component
  57    * encounters startup errors that might prevent the app from showing
  58    * proper UI, it should set this flag to "true".
  59    */
  60   attribute boolean logConsoleErrors;
  61
  62   /**
  63    * A string tag identifying the current operating system. This is taken
  64    * from the OS_TARGET configure variable. It will always be available.
  65    */
  66   readonly attribute AUTF8String OS;
  67
  68   /**
  69    * A string tag identifying the binary ABI of the current processor and
  70    * compiler vtable. This is taken from the TARGET_XPCOM_ABI configure
  71    * variable. It may not be available on all platforms, especially
  72    * unusual processor or compiler combinations.
  73    *
  74    * The result takes the form <processor>-<compilerABI>, for example:
  75    *   x86-msvc
  76    *   ppc-gcc3
  77    *
  78    * This value should almost always be used in combination with "OS".
  79    *
  80    * @throw NS_ERROR_NOT_AVAILABLE if not available.
  81    */
  82   readonly attribute AUTF8String XPCOMABI;
  83
  84   /**
  85    * A string tag identifying the target widget toolkit in use.
  86    * This is taken from the MOZ_WIDGET_TOOLKIT configure variable.
  87    */
  88   readonly attribute AUTF8String widgetToolkit;
  89
  90   /**
  91    * The legal values of processType.
  92    */
  93   const unsigned long PROCESS_TYPE_DEFAULT = 0;
  94   const unsigned long PROCESS_TYPE_PLUGIN = 1;
  95   const unsigned long PROCESS_TYPE_CONTENT = 2;
  96   const unsigned long PROCESS_TYPE_JETPACK = 3;
  97   const unsigned long PROCESS_TYPE_IPDLUNITTEST = 4;
  98
  99   /**
 100    * The type of the caller's process.  Returns one of the values above.
 101    */
 102   readonly attribute unsigned long processType;
 103
 104   /**
 105    * Signal the apprunner to invalidate caches on the next restart.
 106    * This will cause components to be autoregistered and all
 107    * fastload data to be re-created.
 108    */
 109   void invalidateCachesOnRestart();
 110
 111   /**
 112    * Starts a child process. This method is intented to pre-start a
 113    * content child process so that when it is actually needed, it is
 114    * ready to go.
 115    *
 116    * @throw NS_ERROR_NOT_AVAILABLE if not available.
 117    */
 118   void ensureContentProcess();
 119 };