Validate editor preferences

src/editor/CSSInlineEditor.js

@@ -107,7 +107,7 @@ define(function (require, exports, module) {
      */
     function _addRule(selectorName, inlineEditor, path) {
         DocumentManager.getDocumentForPath(path).done(function (styleDoc) {
-            var newRuleInfo = CSSUtils.addRuleToDocument(styleDoc, selectorName, Editor.getUseTabChar(), Editor.getSpaceUnits());
+            var newRuleInfo = CSSUtils.addRuleToDocument(styleDoc, selectorName, inlineEditor.getUseTabChar(), inlineEditor.getSpaceUnits());
             inlineEditor.addAndSelectRange(selectorName, styleDoc, newRuleInfo.range.from.line, newRuleInfo.range.to.line);
             inlineEditor.editor.setCursorPos(newRuleInfo.pos.line, newRuleInfo.pos.ch);
         });

src/editor/Editor.js

@@ -67,12 +67,14 @@ define(function (require, exports, module) {
     var AnimationUtils     = require("utils/AnimationUtils"),
         Async              = require("utils/Async"),
         CodeMirror         = require("thirdparty/CodeMirror2/lib/codemirror"),
+        DeprecationWarning = require("utils/DeprecationWarning"),
         Menus              = require("command/Menus"),
         PerfUtils          = require("utils/PerfUtils"),
         PreferencesManager = require("preferences/PreferencesManager"),
         Strings            = require("strings"),
         TextRange          = require("document/TextRange").TextRange,
         TokenUtils         = require("utils/TokenUtils"),
+        ValidationUtils    = require("utils/ValidationUtils"),
         ViewUtils          = require("utils/ViewUtils"),
         _                  = require("thirdparty/lodash");
 
@@ -91,6 +93,14 @@ define(function (require, exports, module) {
 
     var cmOptions         = {};
 
+    /** @type {number} Constants */
+    var MIN_SPACE_UNITS         =  0,
+        MIN_TAB_SIZE            =  1,
+        DEFAULT_SPACE_UNITS     =  4,
+        DEFAULT_TAB_SIZE        =  4,
+        MAX_SPACE_UNITS         = 10,
+        MAX_TAB_SIZE            = 10;
+
     // Mappings from Brackets preferences to CodeMirror options
     cmOptions[CLOSE_BRACKETS]     = "autoCloseBrackets";
     cmOptions[CLOSE_TAGS]         = "autoCloseTags";
@@ -109,9 +119,17 @@ define(function (require, exports, module) {
     PreferencesManager.definePreference(SHOW_LINE_NUMBERS, "boolean", true);
     PreferencesManager.definePreference(SMART_INDENT,      "boolean", true);
     PreferencesManager.definePreference(SOFT_TABS,         "boolean", true);
-    PreferencesManager.definePreference(SPACE_UNITS,       "number",  4);
+    PreferencesManager.definePreference(SPACE_UNITS, "number", DEFAULT_SPACE_UNITS, {
+        validator: function (value) {
+            return ValidationUtils.isIntegerInRange(value, MIN_SPACE_UNITS, MAX_SPACE_UNITS);
+        }
+    });
     PreferencesManager.definePreference(STYLE_ACTIVE_LINE, "boolean", false);
-    PreferencesManager.definePreference(TAB_SIZE,          "number",  4);
+    PreferencesManager.definePreference(TAB_SIZE, "number", DEFAULT_TAB_SIZE, {
+        validator: function (value) {
+            return ValidationUtils.isIntegerInRange(value, MIN_TAB_SIZE, MAX_TAB_SIZE);
+        }
+    });
     PreferencesManager.definePreference(USE_TAB_CHAR,      "boolean", false);
     PreferencesManager.definePreference(WORD_WRAP,         "boolean", true);
 
@@ -884,7 +902,7 @@ define(function (require, exports, module) {
      */
     Editor.prototype.getColOffset = function (pos) {
         var line    = this._codeMirror.getRange({line: pos.line, ch: 0}, pos),
-            tabSize = Editor.getTabSize(),
+            tabSize = this.getTabSize(),
             column  = 0,
             i;
 
@@ -1878,103 +1896,251 @@ define(function (require, exports, module) {
     // Global settings that affect Editor instances that share the same preference locations
 
     /**
+     * @deprecated Use Editor instance method instead
      * Sets whether to use tab characters (vs. spaces) when inserting new text.
      * Affects any editors that share the same preference location.
      * @param {boolean} value
      */
     Editor.setUseTabChar = function (value) {
+        DeprecationWarning.deprecationWarning("Editor.setUseTabChar was called, use Editor.prototype.setUseTabChar (on Editor instance) instead.");
         PreferencesManager.set(USE_TAB_CHAR, value);
     };
 
-    /** @type {boolean} Gets whether the current editor uses tab characters (vs. spaces) when inserting new text */
+    /**
+     * @deprecated Use Editor instance method instead
+     * @type {boolean} Gets whether the current editor uses tab characters (vs. spaces) when inserting new text
+     */
     Editor.getUseTabChar = function () {
+        DeprecationWarning.deprecationWarning("Editor.getUseTabChar was called, use Editor.prototype.getUseTabChar (on Editor instance) instead.");
         return PreferencesManager.get(USE_TAB_CHAR);
     };
 
     /**
+     * @deprecated Use Editor instance method instead
      * Sets tab character width.
      * Affects any editors that share the same preference location.
      * @param {number} value
      */
     Editor.setTabSize = function (value) {
+        DeprecationWarning.deprecationWarning("Editor.setTabSize was called, use Editor.prototype.setTabSize (on Editor instance) instead.");
         PreferencesManager.set(TAB_SIZE, value);
     };
 
-    /** @type {number} Get indent unit  */
+    /**
+     * @deprecated Use Editor instance method instead
+     * @type {number} Get indent unit
+     */
     Editor.getTabSize = function () {
+        DeprecationWarning.deprecationWarning("Editor.getTabSize was called, use Editor.prototype.getTabSize (on Editor instance) instead.");
         return PreferencesManager.get(TAB_SIZE);
     };
 
     /**
+     * @deprecated Use Editor instance method instead
      * Sets indentation width.
      * Affects any editors that share the same preference location.
      * @param {number} value
      */
     Editor.setSpaceUnits = function (value) {
+        DeprecationWarning.deprecationWarning("Editor.setSpaceUnits was called, use Editor.prototype.setSpaceUnits (on Editor instance) instead.");
         PreferencesManager.set(SPACE_UNITS, value);
     };
 
-    /** @type {number} Get indentation width */
+    /**
+     * @deprecated Use Editor instance method instead
+     * @type {number} Get indentation width
+     */
     Editor.getSpaceUnits = function () {
+        DeprecationWarning.deprecationWarning("Editor.getSpaceUnits was called, use Editor.prototype.getSpaceUnits (on Editor instance) instead.");
         return PreferencesManager.get(SPACE_UNITS);
     };
 
     /**
+     * @deprecated Use Editor instance method instead
      * Sets the auto close brackets.
      * Affects any editors that share the same preference location.
      * @param {boolean} value
      */
     Editor.setCloseBrackets = function (value) {
+        DeprecationWarning.deprecationWarning("Editor.setCloseBrackets was called, use Editor.prototype.setCloseBrackets (on Editor instance) instead.");
         PreferencesManager.set(CLOSE_BRACKETS, value);
     };
 
-    /** @type {boolean} Gets whether the current editor uses auto close brackets */
+    /**
+     * @deprecated Use Editor instance method instead
+     * @type {boolean} Gets whether the current editor uses auto close brackets
+     */
     Editor.getCloseBrackets = function () {
+        DeprecationWarning.deprecationWarning("Editor.getCloseBrackets was called, use Editor.prototype.getCloseBrackets (on Editor instance) instead.");
         return PreferencesManager.get(CLOSE_BRACKETS);
     };
 
     /**
+     * @deprecated Use Editor instance method instead
      * Sets show line numbers option.
      * Affects any editors that share the same preference location.
      * @param {boolean} value
      */
     Editor.setShowLineNumbers = function (value) {
+        DeprecationWarning.deprecationWarning("Editor.setShowLineNumbers was called, use Editor.prototype.setShowLineNumbers (on Editor instance) instead.");
         PreferencesManager.set(SHOW_LINE_NUMBERS, value);
     };
 
-    /** @type {boolean} Returns true if show line numbers is enabled for the current editor */
+    /**
+     * @deprecated Use Editor instance method instead
+     * @type {boolean} Returns true if show line numbers is enabled for the current editor
+     */
     Editor.getShowLineNumbers = function () {
+        DeprecationWarning.deprecationWarning("Editor.getShowLineNumbers was called, use Editor.prototype.getShowLineNumbers (on Editor instance) instead.");
         return PreferencesManager.get(SHOW_LINE_NUMBERS);
     };
 
     /**
+     * @deprecated Use Editor instance method instead
      * Sets show active line option.
      * Affects any editors that share the same preference location.
      * @param {boolean} value
      */
     Editor.setShowActiveLine = function (value) {
+        DeprecationWarning.deprecationWarning("Editor.setShowActiveLine was called, use Editor.prototype.setShowActiveLine (on Editor instance) instead.");
         PreferencesManager.set(STYLE_ACTIVE_LINE, value);
     };
 
-    /** @type {boolean} Returns true if show active line is enabled for the current editor */
+    /**
+     * @deprecated Use Editor instance method instead
+     * @type {boolean} Returns true if show active line is enabled for the current editor
+     */
     Editor.getShowActiveLine = function () {
+        DeprecationWarning.deprecationWarning("Editor.getShowActiveLine was called, use Editor.prototype.getShowActiveLine (on Editor instance) instead.");
         return PreferencesManager.get(STYLE_ACTIVE_LINE);
     };
 
     /**
+     * @deprecated Use Editor instance method instead
      * Sets word wrap option.
      * Affects any editors that share the same preference location.
      * @param {boolean} value
      */
     Editor.setWordWrap = function (value) {
+        DeprecationWarning.deprecationWarning("Editor.setWordWrap was called, use Editor.prototype.setWordWrap (on Editor instance) instead.");
         PreferencesManager.set(WORD_WRAP, value);
     };
 
-    /** @type {boolean} Returns true if word wrap is enabled for the current editor */
+    /**
+     * @deprecated Use Editor instance method instead
+     * @type {boolean} Returns true if word wrap is enabled for the current editor
+     */
     Editor.getWordWrap = function () {
+        DeprecationWarning.deprecationWarning("Editor.getWordWrap was called, use Editor.prototype.getWordWrap (on Editor instance) instead.");
         return PreferencesManager.get(WORD_WRAP);
     };
 
+
+    /**
+     * Sets whether to use tab characters (vs. spaces) when inserting new text.
+     * Affects any editors that share the same preference location.
+     * @param {boolean} value
+     * @return {boolean} true if value was set
+     */
+    Editor.prototype.setUseTabChar = function (value) {
+        return PreferencesManager.set(USE_TAB_CHAR, value);
+    };
+
+    /** @type {boolean} Gets whether the current editor uses tab characters (vs. spaces) when inserting new text */
+    Editor.prototype.getUseTabChar = function () {
+        return PreferencesManager.get(USE_TAB_CHAR, this.document.file.fullPath);
+    };
+
+    /**
+     * Sets tab character width.
+     * Affects any editors that share the same preference location.
+     * @param {number} value
+     * @return {boolean} true if value was set
+     */
+    Editor.prototype.setTabSize = function (value) {
+        return PreferencesManager.set(TAB_SIZE, value);
+    };
+
+    /** @type {number} Get tab character width  */
+    Editor.prototype.getTabSize = function () {
+        return PreferencesManager.get(TAB_SIZE, this.document.file.fullPath);
+    };
+
+    /**
+     * Sets indentation width.
+     * Affects any editors that share the same preference location.
+     * @param {number} value
+     * @return {boolean} true if value was set
+     */
+    Editor.prototype.setSpaceUnits = function (value) {
+        return PreferencesManager.set(SPACE_UNITS, value);
+    };
+
+    /** @type {number} Get indentation width */
+    Editor.prototype.getSpaceUnits = function () {
+        return PreferencesManager.get(SPACE_UNITS, this.document.file.fullPath);
+    };
+
+    /**
+     * Sets the auto close brackets.
+     * Affects any editors that share the same preference location.
+     * @param {boolean} value
+     * @return {boolean} true if value was set
+     */
+    Editor.prototype.setCloseBrackets = function (value) {
+        return PreferencesManager.set(CLOSE_BRACKETS, value);
+    };
+
+    /** @type {boolean} Gets whether the current editor uses auto close brackets */
+    Editor.prototype.getCloseBrackets = function () {
+        return PreferencesManager.get(CLOSE_BRACKETS, this.document.file.fullPath);
+    };
+
+    /**
+     * Sets show line numbers option.
+     * Affects any editors that share the same preference location.
+     * @param {boolean} value
+     * @return {boolean} true if value was set
+     */
+    Editor.prototype.setShowLineNumbers = function (value) {
+        return PreferencesManager.set(SHOW_LINE_NUMBERS, value);
+    };
+
+    /** @type {boolean} Returns true if show line numbers is enabled for the current editor */
+    Editor.prototype.getShowLineNumbers = function () {
+        return PreferencesManager.get(SHOW_LINE_NUMBERS, this.document.file.fullPath);
+    };
+
+    /**
+     * Sets show active line option.
+     * Affects any editors that share the same preference location.
+     * @param {boolean} value
+     * @return {boolean} true if value was set
+     */
+    Editor.prototype.setShowActiveLine = function (value) {
+        return PreferencesManager.set(STYLE_ACTIVE_LINE, value);
+    };
+
+    /** @type {boolean} Returns true if show active line is enabled for the current editor */
+    Editor.prototype.getShowActiveLine = function () {
+        return PreferencesManager.get(STYLE_ACTIVE_LINE, this.document.file.fullPath);
+    };
+
+    /**
+     * Sets word wrap option.
+     * Affects any editors that share the same preference location.
+     * @param {boolean} value
+     * @return {boolean} true if value was set
+     */
+    Editor.prototype.setWordWrap = function (value) {
+        return PreferencesManager.set(WORD_WRAP, value);
+    };
+
+    /** @type {boolean} Returns true if word wrap is enabled for the current editor */
+    Editor.prototype.getWordWrap = function () {
+        return PreferencesManager.get(WORD_WRAP, this.document.file.fullPath);
+    };
+
     // Set up listeners for preference changes
     editorOptions.forEach(function (prefName) {
         PreferencesManager.on("change", prefName, function () {