Revision Content

Overview

The Gecko SDK, also known as the XULRunner SDK, is a set of XPIDL files, headers and tools to develop XPCOM components which can then in turn e.g. be accessed from XUL using JavaScript.

Note that in order to develop such components, you do not need the full sources of e.g. Firefox, since you do not access parts of the front end from within a component. Furthermore, since a component contains basic functionality, it is intended to run with every product of the Mozilla platform. Therefore it makes no sense to use a particular product to build general functionality. That's the reason why the Gecko SDK was devised.

Do not confuse the Gecko/XULRunner SDK with XULRunner itself. The Gecko SDK is a collection of header files and tools used to develop general XPCOM components which add functionality to the existing platform, whereas XULRunner is a framework which can be used to run standalone or embedded applications based on the Mozilla framework.

The Gecko SDK contains all of the necessary tools and headers for making scriptable NPAPI plugins including the xpidl compiler/linker and the latest npapi.h.

Get the SDK

Updates

There is no need to download or rebuild the Gecko SDK corresponding to security updates of Mozilla (e.g., Mozilla 1.7.3) since the headers and glue libs in the Gecko SDK are usually not changed as a result of security updates. You do have to get and distribute the newest Gecko components (gklayout.dll etc.), though.

Downloading

When downloading the Gecko SDK, it is important to choose the version that corresponds to the earliest version of Mozilla that you wish to target. In other words, you shouldn't download the 1.9 Gecko SDK if you want to use your component with Firefox 1.5. This is important because binary compatibility is ensured only with future versions of the Gecko runtime.

Unfortunately, this is caused by a problem with the SDK build process which cannot currently be resolved (see Bugzilla bug #430274). To get around it, you'll need to first install MacPorts as outlined in the Mac OS X Build Prerequisites and install libidl with it. On 64-bit versions of Mac OS X, you'll need to install libidl with the +universal flag.

Once that's done, you should perform the following command:

ln -s /opt/local/lib/libintl.8.dylib /opt/local/lib/libintl.3.dylib

This should fix the problem.

Building the SDK

To build the SDK, you should build XULRunner (the Gecko SDK is built as part of the XULRunner build process, which is why it's sometimes called the XULRunner SDK). See the Build Documentation for complete details. After the XULRunner build is complete running make sdk from your object directory will create a package of the sdk in dist.

Revision Source

<h2 name="Overview">Overview</h2>
<p>The Gecko SDK, also known as the XULRunner SDK, is a set of <a href="/en/XPIDL" title="en/XPIDL">XPIDL</a> files, headers and tools to develop <a href="/en/XPCOM" title="en/XPCOM">XPCOM</a> components which can then in turn e.g. be accessed from <a href="/en/XUL" title="en/XUL">XUL</a> using <a href="/en/JavaScript" title="en/JavaScript">JavaScript</a>.</p>
<p>Note that in order to develop such components, you do not need the full sources of e.g. Firefox, since you do not access parts of the front end from within a component. Furthermore, since a component contains basic functionality, it is intended to run with every product of the Mozilla platform. Therefore it makes no sense to use a particular product to build general functionality. That's the reason why the Gecko SDK was devised.</p>
<p>Do not confuse the Gecko/XULRunner SDK with <a href="/en/XULRunner" title="en/XULRunner">XULRunner</a> itself. The Gecko SDK is a collection of header files and tools used to develop general XPCOM components which add functionality to the existing platform, whereas XULRunner is a framework which can be used to run standalone or embedded applications based on the Mozilla framework.</p>
<p>The Gecko SDK contains all of the necessary tools and headers for making scriptable NPAPI plugins including the xpidl compiler/linker and the latest <code>npapi.h</code>.</p>
<h2 name="Get_the_SDK">Get the SDK</h2>
<h3 name="Updates">Updates</h3>
<p>There is no need to download or rebuild the Gecko SDK corresponding to security updates of Mozilla (e.g., Mozilla 1.7.3) since the headers and glue libs in the Gecko SDK are usually not changed as a result of security updates. You <strong>do have to</strong> get and distribute the newest Gecko components (gklayout.dll etc.), though.</p>
<h3 name="Downloading">Downloading</h3>
<p>When downloading the Gecko SDK, it is important to choose the version that corresponds to the earliest version of Mozilla that you wish to target. In other words, you shouldn't download the 1.9 Gecko SDK if you want to use your component with Firefox 1.5. This is important because binary compatibility is ensured only with future versions of the Gecko runtime.</p>
<table class="standard-table"> <tbody> <tr> <th>Download Link</th> <th>Gecko 2.0 (Firefox 4.0)</th> <th>Gecko 1.9.2 (Firefox 3.6)</th> <th>Gecko 1.9.1 (Firefox 3.5)</th> <th>Gecko 1.9 (Firefox 3.0)</th> <th>Gecko 1.8 (Firefox 1.5 and 2.0)</th> </tr> <tr> <th>Windows</th> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.win32.sdk.zip" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.win32.sdk.zip">Download</a></td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.win32.sdk.zip" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.win32.sdk.zip">Download</a></td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.win32.sdk.zip" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.win32.sdk.zip">Download</a></td> <td><a class="link-ftp" href="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.win32.sdk.zip" title="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.win32.sdk.zip">Download</a></td> <td><a class="link-ftp" href="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.8.0.4/sdk/gecko-sdk-win32-msvc-1.8.0.4.zip" title="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.8.0.4/sdk/gecko-sdk-win32-msvc-1.8.0.4.zip">Download</a></td> </tr> <tr> <th>Mac x86_64</th> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.mac-x86_64.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.mac-x86_64.sdk.tar.bz2">Download</a></td> <td>N/A</td> <td>N/A</td> <td>N/A</td> <td>N/A</td> </tr> <tr> <th>Mac i386</th> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.mac-i386.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.mac-i386.sdk.tar.bz2">Download</a></td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.mac-i386.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.mac-i386.sdk.tar.bz2">Download</a></td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.mac-i386.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.mac-i386.sdk.tar.bz2">Download</a></td> <td><a class="link-ftp" href="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.mac-i386.sdk.tar.bz2" title="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.mac-i386.sdk.tar.bz2">Download</a></td> <td>N/A</td> </tr> <tr> <th>Mac ppc</th> <td>N/A</td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.mac-powerpc.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.mac-powerpc.sdk.tar.bz2">Download</a></td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.mac-powerpc.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.mac-powerpc.sdk.tar.bz2">Download</a></td> <td><a class="link-ftp" href="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.mac-powerpc.sdk.tar.bz2" title="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.mac-powerpc.sdk.tar.bz2">Download</a></td> <td><a class="link-ftp" href="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.8.0.4/sdk/gecko-sdk-mac-1.8.0.4.zip" title="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.8.0.4/sdk/gecko-sdk-mac-1.8.0.4.zip">Download</a></td> </tr> <tr> <th>Linux x86_64</th> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.linux-x86_64.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.linux-x86_64.sdk.tar.bz2">Download</a></td> <td>N/A</td> <td>N/A</td> <td>N/A</td> <td>N/A</td> </tr> <tr> <th>Linux i686</th> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.linux-i686.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/2.0b12/sdk/xulrunner-2.0b12.en-US.linux-i686.sdk.tar.bz2">Download</a></td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.linux-i686.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.2.14/sdk/xulrunner-1.9.2.14.en-US.linux-i686.sdk.tar.bz2">Download</a></td> <td><a class="external" href="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.linux-i686.sdk.tar.bz2" title="http://releases.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.1.17/sdk/xulrunner-1.9.1.17.en-US.linux-i686.sdk.tar.bz2">Download</a></td> <td><a class="link-ftp" href="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.linux-i686.sdk.tar.bz2" title="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.9.0.17/sdk/xulrunner-1.9.0.17.en-US.linux-i686.sdk.tar.bz2">Download</a></td> <td><a class="link-ftp" href="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.8.0.4/sdk/gecko-sdk-i686-pc-linux-gnu-1.8.0.4.tar.bz2" title="ftp://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/1.8.0.4/sdk/gecko-sdk-i686-pc-linux-gnu-1.8.0.4.tar.bz2">Download</a></td> </tr> </tbody>
</table>
<p>The SDK is not officially released for other platforms; if you need it, you will probably need to build it yourself.</p>
<p>Unpack the SDK tarball to some suitable location.</p>
<h4 name="Issues_with_the_OS_X_SDK">Issues with the OS X SDK</h4>
<p>If you need to use the <code>xpidl</code> utility to compile IDL files on OS X, it's likely that you will receive a strange error when running the tool that looks something along the lines of this:</p>
<pre>dyld: Library not loaded: /opt/local/lib/libintl.3.dylib
Referenced from: /Users/varmaa/xulrunner-sdk/bin/./xpidl
Reason: image not found
Trace/BPT trap
</pre>
<p>Unfortunately, this is caused by a problem with the SDK build process which cannot currently be resolved (see Bugzilla bug #<a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=430274">430274</a>). To get around it, you'll need to first install MacPorts as outlined in the <a href="/En/Developer_Guide/Build_Instructions/Mac_OS_X_Prerequisites" title="en/Mac_OS_X_Build_Prerequisites">Mac OS X Build Prerequisites</a> and install <code>libidl</code> with it. On 64-bit versions of Mac OS X, you'll need to install <code>libidl</code> with the <code>+universal</code> flag.<code><br>
</code></p>
<p>Once that's done, you should perform the following command:</p>
<pre>ln -s /opt/local/lib/libintl.8.dylib /opt/local/lib/libintl.3.dylib</pre>
<p>This should fix the problem.</p>
<h3 name="Building_the_SDK">Building the SDK</h3>
<p>To build the SDK, you should build <a href="/en/XULRunner" title="en/XULRunner">XULRunner</a> (the Gecko SDK is built as part of the XULRunner build process, which is why it's sometimes called the XULRunner SDK). See the <a href="/En/Developer_Guide/Build_Instructions" title="en/Build_Documentation">Build Documentation</a> for complete details. After the XULRunner build is complete running <code>make sdk</code> from your object directory will create a package of the sdk in <code>dist</code>.</p>
<h2 name="Contents_of_the_SDK">Contents of the SDK</h2>
<p>The SDK contains the following:</p>
<ul>1.9.2 <li>IDL files for frozen interfaces (under <code>idl/</code>)</li> <li>Header files for frozen interfaces, XPCOM functions, and NSPR functions (under <code>include/</code>)</li> <li>Import libraries or shared libraries (under <code>lib/</code>)</li> <li>Static utility libraries (under <code>lib/</code>)</li> <li>Various tools (under <code>bin/</code>)</li>
</ul>
<p>For more information about safely linking XPCOM components using the XPCOM "glue" library, see <a href="/en/XPCOM_Glue" title="en/XPCOM_Glue">XPCOM Glue</a>.</p>
<h2 name="Resources">Using the Mozilla Build System with the SDK</h2>
<p>It's possible to use the <a class="internal" href="/Talk:en/Creating_Custom_Firefox_Extensions_with_the_Mozilla_Build_System" title="Talk:En/Creating Custom Firefox Extensions with the Mozilla Build System">Mozilla Build System</a> with the SDK. This can be done by downloading the source code for Firefox and using the <code>--with-libxul-sdk</code> option to <code>configure</code>.</p>
<h2 name="Resources">Resources</h2>
<ul> <li><a href="/User:Andywang/xpidl" title="User:Andywang/xpidl">static xpidl.exe</a> (non-official) If you are looking for a static linked xpidl.exe, you can download here.</li> <li><a class="external" href="http://www.oxymoronical.com/view/1114">Mac Intel Gecko 1.8 SDK</a> The official Mac 1.8 SDK is a ppc version. This is an unofficial intel build.</li>
</ul>
<p>{{ languages( { "zh-cn": "cn/Gecko_SDK", "fr": "fr/SDK_Gecko", "ja": "ja/Gecko_SDK" } ) }}</p>