Mercurial > octave

view scripts/prefs/rmpref.m @ 21546:f7f97d7e9294

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Wrap m-file docstrings to 79 characters + newline (80 total). * isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m, inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m, validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m, cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m, warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m, ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m, pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m, line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m, surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m, rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m, histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m: Wrap m-file docstrings to 79 characters + newline (80 total).
author Rik <rik@octave.org>
date Sun, 27 Mar 2016 15:50:01 -0700
parents 516bb87ea72e
children bac0d6f07a3e
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  {} {} rmpref ("@var{group}", "@var{pref}")
## @deftypefnx {} {} rmpref ("@var{group}", @{"@var{pref1}", "@var{pref2}", @dots{}@})
## @deftypefnx {} {} 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)