Mercurial > octave-antonio
view scripts/strings/regexptranslate.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 9fc020886ae9 |
children |
line wrap: on
line source
## Copyright (C) 2008-2015 David Bateman ## ## 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} {} regexptranslate (@var{op}, @var{s}) ## Translate a string for use in a regular expression. ## ## This may include either wildcard replacement or special character escaping. ## ## The behavior is controlled by @var{op} which can take the following ## values ## ## @table @asis ## @item @qcode{"wildcard"} ## The wildcard characters @code{.}, @code{*}, and @code{?} are replaced with ## wildcards that are appropriate for a regular expression. For example: ## ## @example ## @group ## regexptranslate ("wildcard", "*.m") ## @result{} ".*\.m" ## @end group ## @end example ## ## @item @qcode{"escape"} ## The characters @code{$.?[]}, that have special meaning for regular ## expressions are escaped so that they are treated literally. For example: ## ## @example ## @group ## regexptranslate ("escape", "12.5") ## @result{} "12\.5" ## @end group ## @end example ## ## @end table ## @seealso{regexp, regexpi, regexprep} ## @end deftypefn function y = regexptranslate (op, s) if (nargin != 2) print_usage (); endif if (! ischar (op)) error ("regexptranslate: operation OP must be a string"); endif op = tolower (op); if (strcmp ("wildcard", op)) y = regexprep (regexprep (regexprep (s, '\.', '\.'), '\*', '.*'), '\?', '.'); elseif (strcmp ("escape", op)) y = regexprep (s, '([^\w])', '\\$1'); else error ("regexptranslate: invalid operation OP"); endif endfunction %!assert (regexptranslate ("wildcard", "/a*b?c."), "/a.*b.c\\.") %!assert (regexptranslate ("escape", '$.?[abc]'), '\$\.\?\[abc\]') ## Test input validation %!error <Invalid call to regexptranslate> regexptranslate () %!error <Invalid call to regexptranslate> regexptranslate ("wildcard") %!error <Invalid call to regexptranslate> regexptranslate ("a", "b", "c") %!error <invalid operation> regexptranslate ("foo", "abc") %!error <operation OP must be a string> regexptranslate (10, "abc")