gecko/xpcom/sample/nsSample.js
Jim Blandy 4d6a633bba Bug 914753: Make Emacs file variable header lines correct, or at least consistent. DONTBUILD r=ehsan
The -*- file variable lines -*- establish per-file settings that Emacs will
pick up. This patch makes the following changes to those lines (and touches
nothing else):

 - Never set the buffer's mode.

   Years ago, Emacs did not have a good JavaScript mode, so it made sense
   to use Java or C++ mode in .js files. However, Emacs has had js-mode for
   years now; it's perfectly serviceable, and is available and enabled by
   default in all major Emacs packagings.

   Selecting a mode in the -*- file variable line -*- is almost always the
   wrong thing to do anyway. It overrides Emacs's default choice, which is
   (now) reasonable; and even worse, it overrides settings the user might
   have made in their '.emacs' file for that file extension. It's only
   useful when there's something specific about that particular file that
   makes a particular mode appropriate.

 - Correctly propagate settings that establish the correct indentation
   level for this file: c-basic-offset and js2-basic-offset should be
   js-indent-level. Whatever value they're given should be preserved;
   different parts of our tree use different indentation styles.

 - We don't use tabs in Mozilla JS code. Always set indent-tabs-mode: nil.
   Remove tab-width: settings, at least in files that don't contain tab
   characters.

 - Remove js2-mode settings that belong in the user's .emacs file, like
   js2-skip-preprocessor-directives.
2014-06-24 22:12:07 -07:00

61 lines
2.1 KiB
JavaScript

/* -*- indent-tabs-mode: nil; js-indent-level: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
/**
* We set up a sample component. The constructor is empty, all the interesting
* stuff goes in the prototype.
*/
function mySample() { }
mySample.prototype = {
/**
* .classID is required for generateNSGetFactory to work correctly.
* Make sure this CID matches the "component" in your .manifest file.
*/
classID: Components.ID("{dea98e50-1dd1-11b2-9344-8902b4805a2e}"),
/**
* .classDescription and .contractID are only used for
* backwards compatibility with Gecko 1.9.2 and
* XPCOMUtils.generateNSGetModule.
*/
classDescription: "nsSample: JS version", // any human-readable string
contractID: "@mozilla.org/jssample;1",
/**
* List all the interfaces your component supports.
* @note nsISupports is generated automatically; you don't need to list it.
*/
QueryInterface: XPCOMUtils.generateQI([Components.interfaces.nsISample]),
/*
* get and set are new Magic in JS1.5, borrowing the intent -- if not
* the exact syntax -- from the JS2 design. They define accessors for
* properties on the JS object, follow the expected rules for prototype
* delegation, and make a mean cup of coffee.
*/
get value() { return this.val; },
set value(newval) { return this.val = newval; },
writeValue: function (aPrefix) {
debug("mySample::writeValue => " + aPrefix + this.val + "\n");
},
poke: function (aValue) { this.val = aValue; },
val: "<default value>"
};
/**
* XPCOMUtils.generateNSGetFactory was introduced in Mozilla 2 (Firefox 4).
* XPCOMUtils.generateNSGetModule is for Mozilla 1.9.2 (Firefox 3.6).
*/
if (XPCOMUtils.generateNSGetFactory)
this.NSGetFactory = XPCOMUtils.generateNSGetFactory([mySample]);
else
var NSGetModule = XPCOMUtils.generateNSGetModule([mySample]);