MozillaZine

Dev : Tips : Disable XUL cache

From MozillaZine Knowledge Base

(Difference between revisions)
Revision as of 08:31, 18 August 2005
Sjors (Talk | contribs)
(The overlay problem)
<-- Previous diff
Revision as of 19:58, 28 August 2005
Asqueella (Talk | contribs)

Next diff -->
Line 1: Line 1:
{{extdev}} {{extdev}}
-==nglayout.debug.disable_xul_cache==+'''nglayout.debug.disable_xul_cache''' is a preference useful for extension developers. Basically when it is set to '''false''' (which is default), Mozilla caches chrome XUL and JavaScript (and more) in a file named XUL.mfl or similarly. This means you have to restart Mozilla to test your changes to chrome files.
-'''nglayout.debug.disable_xul_cache''' is a Mozilla [[Editing configuration|preference]] useful for extension developers. Basically when it is set to '''false''' (which is default), Mozilla caches chrome XUL and JavaScript (and more) in a file named XUL.mfl or similarly. Therefore, when making changes to your extension, you have to restart Mozilla in order to get new version used. As it is very inconvenient, many extension developers set this pref to '''true'''.+If you develop and extension you should disable the XUL cache by [[Editing configuration|setting]] this pref to '''true''', although it will make Mozilla slower at startup and when opening new windows.
==Getting rid of JARs== ==Getting rid of JARs==
-However even when '''nglayout.debug.disable_xul_cache''' is set to '''true''', Mozilla forbids rewriting *.jar files containing installed extensions. To overcome this and to avoid having to repackage every change you make, you can do one of the following:+However even when '''nglayout.debug.disable_xul_cache''' is set to '''true''', Mozilla forbids rewriting *.jar files containing installed extensions. To overcome this and to avoid having to repackage after making any changes, you can do one of the following:
-*Package your extension to use plain directories instead of a single JAR (before installing) - easiest, see [[Dev_:_Extensions#Packaging|Extensions Packaging]]+* Use the [[Getting_started_with_extension_development#reg-em|new features of Firefox/Thunderbird 1.5's Extension Manager]] ('''recommended''').
-*Unarchive the JAR file you want to edit and make it permanent by updating chrome.rdf to point to the unpacked files instead of the JAR (after installing)+* [[#Changing install.rdf|Package your extension to use plain directories]] instead of a single JAR before installing (you should use this if you have to develop using Firefox/Thunderbird 1.0 or older).
-*Use installed-chrome.txt to add your files to chrome, see [http://xulplanet.com/tutorials/xulapp/newpackage.html] and [http://www.mozilla.org/docs/tutorials/tinderstatus/] ''(not sure if it works in Firefox)''+* Unarchive the JAR file you want to edit and make it permanent by [[#Editing chrome.rdf|updating chrome.rdf]] to point to the unpacked files instead of the JAR (after installing).
 +* Use installed-chrome.txt to add your files to chrome, see [http://xulplanet.com/tutorials/xulapp/newpackage.html] and [http://www.mozilla.org/docs/tutorials/tinderstatus/] ''(not sure if it works in Firefox. Definitely not with 1.5)''
 + 
 +The following sections provide detailed instructions
===Changing install.rdf=== ===Changing install.rdf===
Line 16: Line 19:
checked back into a repository (e.g. a developer version). checked back into a repository (e.g. a developer version).
-Change the install.rdf from:+Change the [[install.rdf]] from:
<tt><Description about="urn:mozilla:extension:file:myextension.jar"></tt> <tt><Description about="urn:mozilla:extension:file:myextension.jar"></tt>
Line 44: Line 47:
The steps above help you test scripts that are not part of the overlay, like your settings dialog. But they can't help you test the overlay scripts because Firefox caches those. The steps above help you test scripts that are not part of the overlay, like your settings dialog. But they can't help you test the overlay scripts because Firefox caches those.
-The solution is to have the overlay script load its code from an external [[Dev : Extensions : Example Code : File IO|file]], which is reloaded and re-evaluated constantly.+The solution is to have the overlay script load its code from an external [[File IO|file]], which is reloaded and re-evaluated constantly.
Here's an example: Here's an example:

Revision as of 19:58, 28 August 2005

This page is part of the extension development documentation project.

Ask your questions in MozillaZine Forums. Also try browsing example code.

Note: development documentation is in process of being moved to Mozilla Development Center (MDC).

nglayout.debug.disable_xul_cache is a preference useful for extension developers. Basically when it is set to false (which is default), Mozilla caches chrome XUL and JavaScript (and more) in a file named XUL.mfl or similarly. This means you have to restart Mozilla to test your changes to chrome files.

If you develop and extension you should disable the XUL cache by setting this pref to true, although it will make Mozilla slower at startup and when opening new windows.

Contents

Getting rid of JARs

However even when nglayout.debug.disable_xul_cache is set to true, Mozilla forbids rewriting *.jar files containing installed extensions. To overcome this and to avoid having to repackage after making any changes, you can do one of the following:

The following sections provide detailed instructions

Changing install.rdf

Perhaps you would like to package your extension as a series of directories, rather than a jar file. This would allow, for example, an XPI that could be easily edited and perhaps checked back into a repository (e.g. a developer version).

Change the install.rdf from:

<Description about="urn:mozilla:extension:file:myextension.jar">

to:

<Description about="urn:mozilla:extension:file:myextension">

An example of this technique is available. Also, myk is planning to update his tinderstatus extension to demonstrate this technique.


Editing chrome.rdf

We assume that the extension is installed in profile in this section.

Important!! Backup your profile before editing chrome.rdf!

  1. Unpack the JAR file you have, say [profile]\extensions\{YOUR-EXTENSION'S-GUID}\chrome\my-ext.jar to the same directory. You will get (at least) [profile]\extensions\{YOUR-EXTENSION'S-GUID}\chrome\content directory.
  2. In [profile]\chrome\chrome.rdf look for my-ext.jar! and delete it. For example replace this line
    c:baseURL="jar:file:///D:/Firefox/Profiles/default/extensions/{GUID}/chrome/my-ext.jar!/content/my-ext/"

    with this:

    c:baseURL="file:///D:/Firefox/Profiles/default/extensions/{GUID}/chrome/content/my-ext/"
    Note, that you should also delete jar: at the beginning of the path.

The overlay problem

There is still another issue to be solved: a Javascript that's called from the overlay. The steps above help you test scripts that are not part of the overlay, like your settings dialog. But they can't help you test the overlay scripts because Firefox caches those.

The solution is to have the overlay script load its code from an external file, which is reloaded and re-evaluated constantly. Here's an example:

var TheExt = {

	//aFuncCall is a string to be evaluated as a function call
	inject : function (aFuncCall) {
                var codeFileName =  "injected.js";

		// Get profile directory
		var file = Components.classes["@mozilla.org/file/directory_service;1"].
		createInstance(Components.interfaces.nsIProperties).
		get("ProfD", Components.interfaces.nsIFile);

		// Get the file with the code
		file.append(codeFileName);
		if (!file.exists()) {
			dump ("Error: " + file.path + "does not exist.\n");
			return;
		}

		// Read the file into code
		var code = "";
		var fstream = Components.classes["@mozilla.org/network/file-input-stream;1"]
			.createInstance(Components.interfaces.nsIFileInputStream);
		var sstream = Components.classes["@mozilla.org/scriptableinputstream;1"]
			.createInstance(Components.interfaces.nsIScriptableInputStream);
		fstream.init(file, 1, 0, false);
		sstream.init(fstream);
		code += sstream.read(-1);
		sstream.close();
		fstream.close();
		
		// Run the code
		eval(code);	
		eval(aFuncCall);	
	},
	
	doAction : function() {
		this.inject("doAction()");
	}
}

dump ("Testing the extension.\n");
TheExt.doAction();

The file injected.js simply looks like this:

function doAction() {
	dump ("Action!\n")
}

You can add as many functions as you want. inject() evaluates all the functions in the file, but only executes the aFuncCall parameter.