Compare Revisions

XPCShell Reference

Revision 124595:

Revision 124595 by Varmaa on

Revision 124596:

Revision 124596 by Fredinfinite23 on

Title:
XPCShell Reference
XPCShell Reference
Slug:
XPCShell_Reference
XPCShell_Reference
Tags:
JavaScript, Tools, JavaScript:Tools, XPConnect, "Automated testing", "Developing Mozilla", "XPCOM:Language Bindings"
JavaScript, Tools, JavaScript:Tools, XPConnect, "Automated testing", "Developing Mozilla", "XPCOM:Language Bindings"
Content:

Revision 124595
Revision 124596
n11      The command-line syntax for <a href="en/Xpcshell">xpcshell<n11      The command-line syntax for <a href="/en/XPConnect/xpcshell
>/a> is:>" title="en/XPConnect/xpcshell">xpcshell</a> is:
n18        <tt>-f</tt>n18        <code>-f</code>
n21        This option specifies a script file to execute. <tt>xpcshn21        This option specifies a script file to execute. <code>xpc
>ell</tt> terminates upon script completion. You can specify multi>shell</code> terminates upon script completion. You can specify m
>ple JS files to execute by using multiple <tt>-f</tt> arguments, >ultiple JS files to execute by using multiple <code>-f</code> arg
>and the scripts will be executed in the order encountered.>uments, and the scripts will be executed in the order encountered
 >.
n26        Furthermore, XPCShell looks for <tt>xpcshell.js</tt> in tn26        Furthermore, XPCShell looks for <code>xpcshell.js</code
>he current directory. If that file is found, it is executed befor>in the current directory. If that file is found, it is executed b
>e any other JS files specified.>efore any other JS files specified.
27      </dd>
28      <dt>
29        <code>-g</code>
30      </dt>
31      <dd>
32        This option specifies which Gecko Runtime Environment dir
 >ectory (greDir) to use for XPCOM.
n31        <tt>-s</tt>n37        <code>-s</code>
n39        <tt>-v version</tt>n45        <code>-v version</code>
n42        This allows you to specify a specific version of JS to usn48        This allows you to specify a specific version of JS to us
>e, and should be set to an integral value specified by the <a hre>e, and should be set to an integral value specified by the <a hre
>f="en/JSVersion">JSVersion</a> enumerated type. For instance, spe>f="/En/SpiderMonkey/JSAPI_Reference/JSVersion" title="En/SpiderMo
>cifying <tt>-v 180</tt> will set the interpreter to use JavaScrip>nkey/JSAPI_Reference/JSVersion">JSVersion</a> enumerated type. Fo
>t version 1.8.>r instance, specifying <code>-v 180</code> will set the interpret
 >er to use JavaScript version 1.8.
n47        <tt>-w (lower case)</tt>n53        <code>-w (lower case)</code>
n55        <tt>-W (upper case)</tt>n61        <code>-W (upper case)</code>
n63        <tt>{{ mediawiki.external('scriptfile') }}</tt>n69        <code>{{ mediawiki.external('scriptfile') }}</code>
n71        <tt>{{ mediawiki.external('scriptarg…') }}</tt>n77        <code>{{ mediawiki.external('scriptarg…') }}</code>
n74        These are arguments to be passed to the script. These argn80        These are arguments to be passed to the script. These arg
>uments are only passed to “scriptfile” and not the scripts design>uments are only passed to “scriptfile” and not the scripts design
>ated by <tt>–f</tt> options. These arguments appear on the global>ated by <code>–f</code> options. These arguments appear on the gl
> property <tt>arguments</tt>.>obal property <code>arguments</code>.
n79        For instance, assume that you have a file called <tt>testn85        For instance, assume that you have a file called <code>te
>.js</tt> with the following contents:>st.js</code> with the following contents:
n104      Once you execute XPCShell without a script you'll be at then110      Once you execute XPCShell without a script you'll be at the
> <tt>JS&gt;</tt> command line. The following are some useful func> <code>JS&gt;</code> command line. The following are some useful 
>tions that can be invoked from the command line:>functions that can be invoked from the command line:
n108        <tt>clear(<i>object</i>)</tt>n114        <code>clear(<em>object</em>)</code>
n111        <tt>clear()</tt> removes all properties from an object. Fn117        <code>clear()</code> removes all properties from an objec
>or example, if you created <tt>anObject</tt> with a property name>t. For example, if you created <code>anObject</code> with a prope
>d <tt>value</tt> and then called <tt>clear(anObject)</tt>, the pr>rty named <code>value</code> and then called <code>clear(anObject
>operty <tt>value</tt> would no longer exist.>)</code>, the property <code>value</code> would no longer exist.
n116        <tt>gc(<i>heapDumpFilename</i>)</tt>n122        <code>gc(<em>heapDumpFilename</em>)</code>
n119        <tt>gc()</tt> will invoke garbage collection. It takes ann125        <code>gc()</code> will invoke garbage collection. It take
> optional argument that can be used to dump the heap to. If speci>s an optional argument that can be used to dump the heap to. If s
>fied, it should equate to a valid filename.>pecified, it should equate to a valid filename.
n124        <tt>load(<i>scriptFilename</i>)</tt>n130        <code>load(<em>scriptFilename</em>)</code>
n127        <tt>load()</tt> allows you to load and run a script from n133        <code>load()</code> allows you to load and run a script f
>the command line. For example, <tt>load("MyScript.js")</tt> will >rom the command line. For example, <code>load("MyScript.js")</cod
>execute the script <tt>MyScript.js</tt> in the current directory.>e> will execute the script <code>MyScript.js</code> in the curren
 >t directory.
n132        <tt>print(<i>obj1</i>, <i>obj2</i>, <i>…</i>)</tt>n138        <code>print(<em>obj1</em>, <em>obj2</em>, <em>…</em>)</co
 >de>
n135        <tt>print()</tt> is useful to print something to the scren141        <code>print()</code> is useful to print something to the 
>en. It dumps whatever is passed to the screen, putting spaces bet>screen. It dumps whatever is passed to the screen, putting spaces
>ween arguments and appending a newline at the end. An example <tt> between arguments and appending a newline at the end. An example
>>print(1, 2, 3)</tt> Will print <tt>1 2 3&lt;newline&gt;</tt>.> <code>print(1, 2, 3)</code> Will print <code>1 2 3&lt;newline&gt
 >;</code>.
n140        <tt>dump(<i>object</i>)</tt>n146        <code>dump(<em>object</em>)</code>
n143        <tt>dump()</tt> is almost like <tt>print</tt>. It only han149        <code>dump()</code> is almost like <code>print</code>. It
>ndles one parameter and it doesn't append a newline.> only handles one parameter and it doesn't append a newline.
n148        <tt>dumpXPC(<i>depth</i>)</tt>n154        <code>dumpXPC(<em>depth</em>)</code>
n151        This function dumps the XPConnect object. See the documenn157        This function dumps the XPConnect object. See the documen
>tation on <tt>debugDump()</tt> for the <a href="en/NsIXPConnect">>tation on <code>debugDump()</code> for the <a href="/en/NsIXPConn
>nsIXPConnect</a> interface for more information.>ect" title="en/NsIXPConnect">nsIXPConnect</a> interface for more 
 >information.
n156        <tt>version(<i>newVersion</i>)</tt>n162        <code>version(<em>newVersion</em>)</code>
n159        <tt>version()</tt> returns the JavaScript engine version n165        <code>version()</code> returns the JavaScript engine vers
>number. If you pass a number to it, it will set the version numbe>ion number. If you pass a number to it, it will set the version n
>r (and return the old version number). See the above documentatio>umber (and return the old version number). See the above document
>n on the <tt>-v</tt> command-line argument for more information.>ation on the <code>-v</code> command-line argument for more infor
 >mation.
n164        <tt>quit(<i>exitCode</i>)</tt>n170        <code>quit(<em>exitCode</em>)</code>
n167        <tt>quit()</tt> exits the shell. You can specify argumentn173        <code>quit()</code> exits the shell. You can specify argu
>s that will get translated to an exit code. <tt>quit(5)</tt> will>ments that will get translated to an exit code. <code>quit(5)</co
> exit XPCShell with a result code of 5.>de> will exit XPCShell with a result code of 5.
tt188    </div>
189    <p>
182    </div>{{ languages( { "fr": "fr/Xpcshell" } ) }}190      {{ languages( { "fr": "fr/Xpcshell" } ) }}
191    </p>

Back to History