Mercurial > octave
view scripts/+matlab/+lang/makeValidName.m @ 31551:fd29c7a50a78 stable
maint: use commas, semicolons consistently with Octave conventions.
* makeValidName.m: Remove %!test and move BIST %!asserts to column 1.
* base64decode.m, base64encode.m, which.m, logm.m, uniquetol.m, perms.m:
Delete semicolon (';') at end of %!assert BIST.
* lin2mu.m, interp2.m, interpn.m, lsqnonneg.m, pqpnonneg.m, uniquetol.m,
betainc.m, normalize.m: Add semicolon (';') to end of assert statement within
%!test BIST.
* __memoize__.m, tar_is_bsd.m, publish.m: Add semicolon (';') to line with
keyword "persistent".
* stft.m: Use comma (',') after "case" keyword when code immediately follows.
* gallery.m: Align commas used in case statements in massive switch block.
Remove unnecessary parentheses around a numeric case argument.
* ranks.m: Remove semicolon (';') from case statemnt argument.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 26 Nov 2022 06:32:08 -0800 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2017-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{varname} =} matlab.lang.makeValidName (@var{str}) ## @deftypefnx {} {@var{varname} =} matlab.lang.makeValidName (@dots{}, @qcode{"ReplacementStyle"}, @var{rs}) ## @deftypefnx {} {@var{varname} =} matlab.lang.makeValidName (@dots{}, @qcode{"Prefix"}, @var{pfx}) ## @deftypefnx {} {[@var{varname}, @var{ismodified}] =} matlab.lang.makeValidName (@dots{}) ## ## Create valid variable name @var{varname} from @var{str}. ## ## The input @var{str} must be a string or a cell array of strings. ## The output @var{varname} will be of the same type. ## ## A valid variable name is a sequence of letters, digits, and underscores that ## does not begin with a digit. ## ## The @qcode{"ReplacementStyle"} option specifies how invalid characters ## are handled. Acceptable values are ## ## @table @asis ## @item @qcode{"underscore"} (default) ## Replace all invalid characters with an underscore (@qcode{"_"}). ## ## @item @qcode{"delete"} ## Remove any invalid character. ## ## @item @qcode{"hex"} ## Replace all invalid characters with their hexadecimal representation. ## @end table ## ## Whitespace characters are always removed @strong{prior} to the application ## of the @qcode{"ReplacementStyle"}. Lowercase letters following a whitespace ## will be changed to uppercase. ## ## The @qcode{"Prefix"} option specifies the string @var{pfx} to add as a ## prefix to the input if it begins with a digit. @var{pfx} must be a valid ## variable name itself. The default prefix is @qcode{"x"}. ## ## The optional output @var{ismodified} is a logical array indicating whether ## the respective element in @var{str} was a valid name or not. ## ## @seealso{iskeyword, isvarname, matlab.lang.makeUniqueStrings} ## @end deftypefn function [varname, ismodified] = makeValidName (varargin) [varname, ismodified] = __make_valid_name__ (varargin{:}); endfunction ## Test char vector input %!test %! varname = matlab.lang.makeValidName ("octave"); %! assert (varname, "octave"); ## Test cellstr input %!test %! varname = matlab.lang.makeValidName ({"gnu", "octave"}); %! assert (varname, {"gnu", "octave"}); ## Test default flags %!test %! str = {"Octave", "3d plot", "GNU/Octave", "laplace_*"}; %! varname = matlab.lang.makeValidName (str); %! assert (varname, {"Octave", "x3dPlot", "GNU_Octave", "laplace__"}); ## Test ReplacementStyle flag %!test %! str = {"Octave", "3d plot", "GNU/Octave", "laplace_*"}; %! varname = matlab.lang.makeValidName (str, "ReplacementStyle", "underscore"); %! assert (varname, {"Octave", "x3dPlot", "GNU_Octave", "laplace__"}); %! varname = matlab.lang.makeValidName (str, "ReplacementStyle", "hex"); %! assert (varname, {"Octave", "x3dPlot", "GNU0x2FOctave", "laplace_0x2A"}); %! varname = matlab.lang.makeValidName (str, "ReplacementStyle", "delete"); %! assert (varname, {"Octave", "x3dPlot", "GNUOctave", "laplace_"}); ## Test Prefix flag %!test %! assert (matlab.lang.makeValidName ({"", " "}), {"x", "x"}); %! str = {"Octave", "3d plot", "GNU/Octave", "laplace_*"}; %! varname = matlab.lang.makeValidName (str, "prefix", "oct_"); %! assert (varname, {"Octave", "oct_3dPlot", "GNU_Octave", "laplace__"}); ## Test second output %!test %! str = {"Octave", "3d plot", "GNU/Octave", "laplace_*"}; %! [varname, modified] = matlab.lang.makeValidName (str); %! assert (modified, [false, true, true, true]); ## Test whitespace followed by a lowercase letter %!test %! varname = matlab.lang.makeValidName ("gnu octave"); %! assert (varname, "gnuOctave"); %! varname = matlab.lang.makeValidName (" octave "); %! assert (varname, "octave"); ## Check for keywords %!assert (matlab.lang.makeValidName ("for"), "xFor") %!assert (matlab.lang.makeValidName ("For"), "For") %!error matlab.lang.makeValidName ("for", "Prefix", "for") ## Test input validation %!error <Invalid call> matlab.lang.makeValidName () %!error <STR must be a string or cellstr> matlab.lang.makeValidName (42) %!error <options must occur in pairs> matlab.lang.makeValidName ("a", "opt1") %!error <option argument must be a string> %! matlab.lang.makeValidName ("a", 1, 2) %!error <'ReplacementStyle' value must be a string> %! matlab.lang.makeValidName ("a", "ReplacementStyle", 1); %!error <invalid 'ReplacementStyle' value 'foobar'> %! matlab.lang.makeValidName ("a", "ReplacementStyle", "foobar"); %!error <invalid 'Prefix' value '1_'> %! matlab.lang.makeValidName ("a", "Prefix", "1_"); %!error <unknown property 'foobar'> %! matlab.lang.makeValidName ("a", "foobar", 1);