xpcom/system/nsIXULRuntime.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6
   7 %{C++
   8
   9 namespace mozilla {
  10 // Simple C++ getter for nsIXULRuntime::browserTabsRemote
  11 bool BrowserTabsRemote();
  12 // Simple C++ getter for nsIXULRuntime::browserTabsRemoteAutostart
  13 // This getter is a temporary function that checks for special
  14 // conditions in which e10s support is not great yet, and should
  15 // therefore be disabled. Bug 1065561 tracks its removal.
  16 bool BrowserTabsRemoteAutostart();
  17 }
  18
  19 %}
  20
  21 /**
  22  * Provides information about the XUL runtime.
  23  * @status UNSTABLE - This interface is not frozen and will probably change in
  24  *                    future releases. If you need this functionality to be
  25  *                    stable/frozen, please contact Benjamin Smedberg.
  26  */
  27
  28 [scriptable, uuid(e652d3b8-c77c-4601-a84d-b0716d2b32c0)]
  29 interface nsIXULRuntime : nsISupports
  30 {
  31   /**
  32    * Whether the application was launched in safe mode.
  33    */
  34   readonly attribute boolean inSafeMode;
  35
  36   /**
  37    * Whether to write console errors to a log file. If a component
  38    * encounters startup errors that might prevent the app from showing
  39    * proper UI, it should set this flag to "true".
  40    */
  41   attribute boolean logConsoleErrors;
  42
  43   /**
  44    * A string tag identifying the current operating system. This is taken
  45    * from the OS_TARGET configure variable. It will always be available.
  46    */
  47   readonly attribute AUTF8String OS;
  48
  49   /**
  50    * A string tag identifying the binary ABI of the current processor and
  51    * compiler vtable. This is taken from the TARGET_XPCOM_ABI configure
  52    * variable. It may not be available on all platforms, especially
  53    * unusual processor or compiler combinations.
  54    *
  55    * The result takes the form <processor>-<compilerABI>, for example:
  56    *   x86-msvc
  57    *   ppc-gcc3
  58    *
  59    * This value should almost always be used in combination with "OS".
  60    *
  61    * @throw NS_ERROR_NOT_AVAILABLE if not available.
  62    */
  63   readonly attribute AUTF8String XPCOMABI;
  64
  65   /**
  66    * A string tag identifying the target widget toolkit in use.
  67    * This is taken from the MOZ_WIDGET_TOOLKIT configure variable.
  68    */
  69   readonly attribute AUTF8String widgetToolkit;
  70
  71   /**
  72    * The legal values of processType.
  73    */
  74   const unsigned long PROCESS_TYPE_DEFAULT = 0;
  75   const unsigned long PROCESS_TYPE_PLUGIN = 1;
  76   const unsigned long PROCESS_TYPE_CONTENT = 2;
  77   const unsigned long PROCESS_TYPE_IPDLUNITTEST = 3;
  78   const unsigned long PROCESS_TYPE_GMPLUGIN = 4;
  79
  80   /**
  81    * The type of the caller's process.  Returns one of the values above.
  82    */
  83   readonly attribute unsigned long processType;
  84
  85   /**
  86    * The system process ID of the caller's process.
  87    */
  88   readonly attribute unsigned long processID;
  89
  90   /**
  91    * If true, browser tabs may be opened in a different process from the main
  92    * browser UI.
  93    */
  94   readonly attribute boolean browserTabsRemote;
  95
  96   /**
  97    * If true, browser tabs may be opened by default in a different process
  98    * from the main browser UI.
  99    */
 100   readonly attribute boolean browserTabsRemoteAutostart;
 101
 102   /**
 103    * Signal the apprunner to invalidate caches on the next restart.
 104    * This will cause components to be autoregistered and all
 105    * fastload data to be re-created.
 106    */
 107   void invalidateCachesOnRestart();
 108
 109   /**
 110    * Starts a child process. This method is intented to pre-start a
 111    * content child process so that when it is actually needed, it is
 112    * ready to go.
 113    *
 114    * @throw NS_ERROR_NOT_AVAILABLE if not available.
 115    */
 116   void ensureContentProcess();
 117
 118   /**
 119    * Modification time of the profile lock before the profile was locked on
 120    * this startup. Used to know the last time the profile was used and not
 121    * closed cleanly. This is set to 0 if there was no existing profile lock.
 122    */
 123   readonly attribute PRTime replacedLockTime;
 124
 125   /**
 126    * Local ID of the minidump generated when the process crashed
 127    * on the previous run. Can be passed directly to CrashSubmit.submit.
 128    */
 129   readonly attribute DOMString lastRunCrashID;
 130
 131   /**
 132    * True if this is a RELEASE_BUILD.
 133    */
 134   readonly attribute boolean isReleaseBuild;
 135
 136   /**
 137    * True if this build uses official branding (MOZ_OFFICIAL_BRANDING).
 138    */
 139   readonly attribute boolean isOfficialBranding;
 140
 141   /**
 142    * The default update channel (MOZ_UPDATE_CHANNEL).
 143    */
 144   readonly attribute AUTF8String defaultUpdateChannel;
 145
 146   /**
 147    * The distribution ID for this build (MOZ_DISTRIBUTION_ID).
 148    */
 149   readonly attribute AUTF8String distributionID;
 150 };