extension/packages/prefs.coffee

   1 { classes: Cc, interfaces: Ci } = Components
   2
   3 PREF_BRANCH = 'extensions.VimFx.'
   4
   5 # Default values for the preference
   6 # All used preferences should be mentioned here becuase
   7 # preference type is derived from here
   8 DEFAULT_PREF_VALUES =
   9   addon_id:        'VimFx@akhodakivskiy.github.com'
  10   hint_chars:      'asdfgercvhjkl;uinm'
  11   disabled:        false
  12   scroll_step:     60
  13   scroll_time:     100
  14   black_list:      '*mail.google.com*'
  15   blur_on_esc:     true
  16   leave_dt_on_esc: false
  17
  18 getBranchPref = (branch, key, defaultValue) ->
  19   type = branch.getPrefType(key)
  20
  21   switch type
  22     when branch.PREF_BOOL
  23       return branch.getBoolPref(key)
  24     when branch.PREF_INT
  25       return branch.getIntPref(key)
  26     when branch.PREF_STRING
  27       return branch.getCharPref(key)
  28     else
  29       if defaultValue != undefined
  30         return defaultValue
  31
  32 getPref = do ->
  33   prefs = Cc['@mozilla.org/preferences-service;1'].getService(Ci.nsIPrefService)
  34   branch = prefs.getBranch(PREF_BRANCH)
  35
  36   return (key, defaultValue = undefined) ->
  37     value = getBranchPref(branch, key, defaultValue)
  38     return if value == undefined then getDefaultPref(key) else value
  39
  40 getDefaultPref = (key) -> return DEFAULT_PREF_VALUES[key]
  41
  42 getFirefoxPref = do ->
  43   prefs = Cc['@mozilla.org/preferences-service;1'].getService(Ci.nsIPrefService)
  44   branch = prefs.getBranch('')
  45
  46   return (key, defaultValue = undefined) ->
  47     return getBranchPref(branch, key, defaultValue)
  48
  49 # Assign and save Firefox preference value
  50 setPref = do ->
  51   prefs = Cc['@mozilla.org/preferences-service;1'].getService(Ci.nsIPrefService)
  52   branch = prefs.getBranch(PREF_BRANCH)
  53
  54   return (key, value) ->
  55     switch typeof value
  56       when 'boolean'
  57         branch.setBoolPref(key, value)
  58       when 'number'
  59         branch.setIntPref(key, value)
  60       when 'string'
  61         branch.setCharPref(key, value)
  62       else
  63         branch.clearUserPref(key)
  64
  65 DISABLED_COMMANDS = do ->
  66   str = getPref('disabled_commands')
  67   try
  68     return JSON.parse(str)
  69   catch err
  70     dc = []
  71     try
  72       for key in str.split('||')
  73         for c in key.split('|')
  74           dc.push(c) if c
  75
  76     return dc
  77
  78 # Enables command
  79 enableCommand = (key) ->
  80   for c in key.split('|')
  81     while (idx = DISABLED_COMMANDS.indexOf(c)) > -1
  82       DISABLED_COMMANDS.splice(idx, 1)
  83
  84   setPref('disabled_commands', JSON.stringify DISABLED_COMMANDS)
  85
  86 # Adds command to the disabled list
  87 disableCommand = (key) ->
  88   for c in key.split('|')
  89     if DISABLED_COMMANDS.indexOf(c) == -1
  90       DISABLED_COMMANDS.push(c)
  91
  92   setPref('disabled_commands', JSON.stringify DISABLED_COMMANDS)
  93
  94 # Checks if given command is disabled in the preferences
  95 isCommandDisabled = (key) ->
  96   for c in key.split('|')
  97     if DISABLED_COMMANDS.indexOf(c) > -1
  98       return true
  99
 100   return false
 101
 102 exports.getPref           = getPref
 103 exports.getDefaultPref    = getDefaultPref
 104 exports.getFirefoxPref    = getFirefoxPref
 105 exports.setPref           = setPref
 106 exports.isCommandDisabled = isCommandDisabled
 107 exports.disableCommand    = disableCommand
 108 exports.enableCommand     = enableCommand