2 # Copyright Anton Khodakivskiy 2012, 2013, 2014.
3 # Copyright Simon Lydell 2013, 2014, 2015.
5 # This file is part of VimFx.
7 # VimFx is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # VimFx is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with VimFx. If not, see <http://www.gnu.org/licenses/>.
21 # This file provides an API a bit more easy to use than the very low-level
24 defaults = require('./defaults')
30 user: prefs.getBranch(defaults.BRANCH)
31 default: prefs.getDefaultBranch(defaults.BRANCH)
34 default: prefs.getDefaultBranch('')
36 get = (branch, key) ->
37 return switch branch.getPrefType(key)
39 branch.getBoolPref(key)
41 branch.getIntPref(key)
42 when branch.PREF_STRING
43 branch.getComplexValue(key, Ci.nsISupportsString).data
45 set = (branch, key, value) ->
48 branch.setBoolPref(key, value)
50 branch.setIntPref(key, value) # `value` will be `Math.floor`ed.
52 str = Cc['@mozilla.org/supports-string;1']
53 .createInstance(Ci.nsISupportsString)
55 branch.setComplexValue(key, Ci.nsISupportsString, str)
58 branch.clearUserPref(key)
60 throw new Error("VimFx: Prefs may only be set to a boolean, number,
61 string or null. Got: #{ typeof value }")
63 has = (branch, key) ->
64 branch.prefHasUserValue(key)
66 tmp = (branch, pref, temporaryValue) ->
67 previousValue = if has(branch, pref) then get(branch, pref) else null
68 set(branch, pref, temporaryValue)
69 return -> set(branch, pref, previousValue)
71 observe = (branch, domain, callback) ->
72 observer = {observe: (branch, topic, changedPref) -> callback(changedPref)}
73 branch.addObserver(domain, observer, false)
75 branch.removeObserver(domain, observer)
79 get: get.bind(null, branches.addon.user)
80 set: set.bind(null, branches.addon.user)
81 has: has.bind(null, branches.addon.user)
82 tmp: tmp.bind(null, branches.addon.user)
83 observe: observe.bind(null, branches.addon.user)
85 get: get.bind(null, branches.addon.default)
86 set: set.bind(null, branches.addon.default)
88 @set(key, value) for key, value of defaults.all_prefs
91 get: get.bind(null, branches.root.user)
92 set: set.bind(null, branches.root.user)
93 has: has.bind(null, branches.root.user)
94 tmp: tmp.bind(null, branches.root.user)
96 get: get.bind(null, branches.root.default)
97 set: set.bind(null, branches.root.default)
98 unbound: {get, set, has, tmp, observe}