Mercurial > jwe > octave
view scripts/prefs/rmpref.m @ 20834:27b333c88c8e
Overhaul m-files in prefs directory.
Update docstrings, re-code to match Matlab behavior, put input validation
first, add BIST tests.
* addpref.m, getpref.m, ispref.m, preferences.m, rmpref.m, setpref.m:
Update docstrings, re-code to match Matlab behavior, put input validation
first, add BIST tests.
* loadprefs.m, prefsfile.m, saveprefs.m: Update docstring. Remove ## note about testing.
* saveprefs.m: Update docstring. Remove ## note about testing. Change
function declaration to not return any value.
* scripts/prefs/private/prefdir.m: Move file from scripts/prefs to private
directory. Match variable names in doc to those in function.
* module.mk: Change build system to find prefdir.m in private directory.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 09 Dec 2015 12:01:31 -0800 |
parents | 03b9d17a2d95 |
children | 516bb87ea72e |
line wrap: on
line source
## Copyright (C) 2012-2015 John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} rmpref ("@var{group}", "@var{pref}") ## @deftypefnx {Function File} {} rmpref ("@var{group}", @{"@var{pref1}", "@var{pref2}", @dots{}@}) ## @deftypefnx {Function File} {} rmpref ("@var{group}") ## Remove the named preference @var{pref} from the preference group @var{group}. ## ## The named preference group must be a string. ## ## The preference @var{pref} may be a string or cell array of strings. ## ## If @var{pref} is not specified, remove the preference group @var{group}. ## ## It is an error to remove a nonexistent preference or group. ## @seealso{addpref, ispref, setpref, getpref} ## @end deftypefn ## Author: jwe function rmpref (group, pref) if (nargin < 1 || nargin > 2) print_usage (); elseif (! ischar (group)) error ("rmpref: GROUP must be a string"); elseif (nargin == 2 && ! (ischar (pref) || iscellstr (pref))) error ("rmpref: PREF must be a string or cell array of strings"); endif if (nargin == 1) if (! ispref (group)) error ("rmpref: group %s does not exist", group); endif prefs = loadprefs (); prefs = rmfield (prefs, group); saveprefs (prefs); else valid = ispref (group, pref); if (all (valid)) prefs = loadprefs (); prefs.(group) = rmfield (prefs.(group), pref); saveprefs (prefs); else if (! ispref (group)) error ("rmpref: group %s does not exist", group); elseif (ischar (pref)) error ("rmpref: preference %s does not exist", pref); else idx = find (! valid, 1); error ("rmpref: preference %s does not exist", pref{idx}); endif endif endif endfunction %!test %! HOME = getenv ("HOME"); %! unwind_protect %! setenv ("HOME", P_tmpdir ()); %! addpref ("group1", "pref1", [1 2 3]); %! addpref ("group2", {"prefA", "prefB", "prefC"}, {"strA", "strB", "strC"}); %! %! assert (ispref ("group1")); %! rmpref ("group1"); %! assert (! ispref ("group1")); %! %! assert (ispref ("group2", "prefB")); %! rmpref ("group2", "prefB"); %! assert (! ispref ("group2", "prefB")); %! %! fail ('rmpref ("group3")', ... %! "group group3 does not exist"); %! fail ('rmpref ("group3", "prefA")', ... %! "group group3 does not exist"); %! fail ('rmpref ("group2", "prefB")', %! "preference prefB does not exist"); %! fail ('rmpref ("group2", {"prefA", "prefB"})', %! "preference prefB does not exist"); %! %! unwind_protect_cleanup %! unlink (fullfile (P_tmpdir (), ".octave_prefs")); %! if (isempty (HOME)) %! unsetenv ("HOME"); %! else %! setenv ("HOME", HOME); %! endif %! end_unwind_protect ## Test input validation %!error rmpref () %!error rmpref (1,2,3) %!error <GROUP must be a string> rmpref (1) %!error <PREF must be a string> rmpref ("group1", 1)