extension/packages/prefs.coffee

   1 { classes: Cc, interfaces: Ci } = Components
   2
   3 { unload } = require 'unload'
   4
   5 PREF_BRANCH = 'extensions.VimFx.'
   6
   7 # Default values for the preference
   8 # All used preferences should be mentioned here becuase
   9 # preference type is derived from here
  10 DEFAULT_PREF_VALUES =
  11   addon_id:           'VimFx@akhodakivskiy.github.com'
  12   hint_chars:         'fjdkslaghrueiwovncm' # preferably use letters only
  13   disabled:           false
  14   scroll_step_lines:  6
  15   black_list:         '*mail.google.com*'
  16   hints_bloom_data:   ''
  17   hints_bloom_on:     true
  18
  19
  20 getBranchPref = (branch, key, defaultValue) ->
  21   type = branch.getPrefType(key)
  22
  23   switch type
  24     when branch.PREF_BOOL
  25       return branch.getBoolPref(key)
  26     when branch.PREF_INT
  27       return branch.getIntPref(key)
  28     when branch.PREF_STRING
  29       return branch.getCharPref(key)
  30     else
  31       if defaultValue != undefined
  32         return defaultValue
  33
  34 isPrefSet = do ->
  35   prefs = Cc['@mozilla.org/preferences-service;1'].getService(Ci.nsIPrefService)
  36   branch = prefs.getBranch(PREF_BRANCH)
  37
  38   return (key) ->
  39     branch.prefHasUserValue(key)
  40
  41 getPref = do ->
  42   prefs = Cc['@mozilla.org/preferences-service;1'].getService(Ci.nsIPrefService)
  43   branch = prefs.getBranch(PREF_BRANCH)
  44
  45   return (key, defaultValue = undefined) ->
  46     value = getBranchPref(branch, key, defaultValue)
  47     return if value == undefined then getDefaultPref(key) else value
  48
  49 getDefaultPref = (key) -> return DEFAULT_PREF_VALUES[key]
  50
  51 getFirefoxPref = do ->
  52   prefs = Cc['@mozilla.org/preferences-service;1'].getService(Ci.nsIPrefService)
  53   branch = prefs.getBranch('')
  54
  55   return (key, defaultValue = undefined) ->
  56     return getBranchPref(branch, key, defaultValue)
  57
  58 # Assign and save Firefox preference value
  59 setPref = do ->
  60   prefs = Cc['@mozilla.org/preferences-service;1'].getService(Ci.nsIPrefService)
  61   branch = prefs.getBranch(PREF_BRANCH)
  62
  63   return (key, value) ->
  64     switch typeof value
  65       when 'boolean'
  66         branch.setBoolPref(key, value)
  67       when 'number'
  68         branch.setIntPref(key, value)
  69       when 'string'
  70         branch.setCharPref(key, value)
  71       else
  72         branch.clearUserPref(key)
  73
  74 initPrefValues = ->
  75   for key, value of DEFAULT_PREF_VALUES
  76     if not isPrefSet(key)
  77       setPref(key, value)
  78
  79 exports.isPrefSet         = isPrefSet
  80 exports.getPref           = getPref
  81 exports.getDefaultPref    = getDefaultPref
  82 exports.getFirefoxPref    = getFirefoxPref
  83 exports.setPref           = setPref
  84 exports.initPrefValues    = initPrefValues