modules/pref.js

   1 /**
   2  * (C) Copyright 2004-2007 Shawn Betts
   3  * (C) Copyright 2007-2009,2011 John J. Foerch
   4  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   5  *
   6  * Use, modification, and distribution are subject to the terms specified in the
   7  * COPYING file.
   8 **/
   9
  10 function set_branch_pref (branch, name, value) {
  11     if (typeof(value) == "string") {
  12         branch.setCharPref(name, value);
  13     } else if (typeof(value) == "number") {
  14         branch.setIntPref(name, value);
  15     } else if (typeof(value) == "boolean") {
  16         branch.setBoolPref(name, value);
  17     }
  18 }
  19
  20 function default_pref (name, value) {
  21     var branch = preferences.getDefaultBranch(null);
  22     set_branch_pref(branch, name, value);
  23 }
  24
  25 function user_pref (name, value) {
  26     var branch = preferences.getBranch(null);
  27     set_branch_pref(branch, name, value);
  28 }
  29
  30 function get_branch_pref (branch, name) {
  31     switch (branch.getPrefType(name)) {
  32     case branch.PREF_STRING:
  33         return branch.getCharPref(name);
  34     case branch.PREF_INT:
  35         return branch.getIntPref(name);
  36     case branch.PREF_BOOL:
  37         return branch.getBoolPref(name);
  38     default:
  39         return null;
  40     }
  41 }
  42
  43 function get_localized_pref (name) {
  44     try {
  45         return preferences.getBranch(null).getComplexValue(name, Ci.nsIPrefLocalizedString).data;
  46     } catch (e) {
  47         return null;
  48     }
  49 }
  50
  51 function get_pref (name) {
  52     var branch = preferences.getBranch(null);
  53     return get_branch_pref(branch, name);
  54 }
  55
  56 function get_default_pref (name) {
  57     var branch = preferences.getDefaultBranch(null);
  58     return get_branch_pref(branch, name);
  59 }
  60
  61 function clear_pref (name) {
  62     var branch = preferences.getBranch(null);
  63     return branch.clearUserPref(name);
  64 }
  65
  66 function clear_default_pref (name) {
  67     var branch = preferences.getDefaultBranch(null);
  68     return branch.deleteBranch(name);
  69 }
  70
  71 function pref_has_user_value (name) {
  72     var branch = preferences.getBranch(null);
  73     return branch.prefHasUserValue(name);
  74 }
  75
  76 function pref_has_default_value (name) {
  77     var branch = preferences.getDefaultBranch(null);
  78     return branch.prefHasUserValue(name);
  79 }
  80
  81 function session_pref (name, value) {
  82     try {
  83         clear_pref (name);
  84     } catch (e) {}
  85     return default_pref(name, value);
  86 }
  87
  88 function watch_pref (pref, hook) {
  89     /* Extract pref into branch.pref */
  90     let match = pref.match(/^(.*[.])?([^.]*)$/);
  91     let br = match[1];
  92     let key = match[2];
  93     let branch = preferences.getBranch(br).QueryInterface(Ci.nsIPrefBranch2);
  94     let observer = {
  95         observe: function (subject, topic, data) {
  96             if (topic == "nsPref:changed" && data == key) {
  97                 hook();
  98             }
  99         }
 100     };
 101     branch.addObserver("", observer, false);
 102 }
 103
 104 provide("pref");