annotate scripts/miscellaneous/genvarname.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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19278
diff changeset
1 ## Copyright (C) 2008-2015 Bill Denney, Robert Platt
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
2 ##
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
3 ## This file is part of Octave.
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
4 ##
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
8 ## your option) any later version.
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
9 ##
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
13 ## General Public License for more details.
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
14 ##
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
18
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9037
diff changeset
20 ## @deftypefn {Function File} {@var{varname} =} genvarname (@var{str})
7975
ed4ec7875f98 trival doc fix for genvarname
David Bateman <dbateman@free.fr>
parents: 7657
diff changeset
21 ## @deftypefnx {Function File} {@var{varname} =} genvarname (@var{str}, @var{exclusions})
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
22 ## Create valid unique variable name(s) from @var{str}.
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
23 ##
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
24 ## If @var{str} is a cellstr, then a unique variable is created for each cell
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
25 ## in @var{str}.
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
26 ##
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
27 ## @example
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
28 ## @group
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
29 ## genvarname (@{"foo", "foo"@})
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
30 ## @result{}
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
31 ## @{
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
32 ## [1,1] = foo
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
33 ## [1,2] = foo1
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
34 ## @}
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
35 ## @end group
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
36 ## @end example
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
37 ##
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
38 ## If @var{exclusions} is given, then the variable(s) will be unique to each
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
39 ## other and to @var{exclusions} (@var{exclusions} may be either a string or a
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
40 ## cellstr).
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
41 ##
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
42 ## @example
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
43 ## @group
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
44 ## x = 3.141;
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
45 ## genvarname ("x", who ())
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
46 ## @result{} x1
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
47 ## @end group
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
48 ## @end example
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
49 ##
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
50 ## Note that the result is a char array or cell array of strings, not the
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
51 ## variables themselves. To define a variable, @code{eval()} can be used.
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
52 ## The following trivial example sets @code{x} to @code{42}.
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
53 ##
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
54 ## @example
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
55 ## @group
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
56 ## name = genvarname ("x");
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
57 ## eval ([name " = 42"]);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
58 ## @result{} x = 42
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
59 ## @end group
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
60 ## @end example
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
61 ##
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
62 ## This can be useful for creating unique struct field names.
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
63 ##
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
64 ## @example
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
65 ## @group
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
66 ## x = struct ();
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
67 ## for i = 1:3
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
68 ## x.(genvarname ("a", fieldnames (x))) = i;
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
69 ## endfor
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
70 ## @result{} x =
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
71 ## @{
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
72 ## a = 1
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
73 ## a1 = 2
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
74 ## a2 = 3
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
75 ## @}
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
76 ## @end group
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
77 ## @end example
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
78 ##
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
79 ## Since variable names may only contain letters, digits, and underscores,
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
80 ## @code{genvarname} will replace any sequence of disallowed characters with
20164
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
81 ## an underscore. Also, variables may not begin with a digit; in this case
df437a52bcaf doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19833
diff changeset
82 ## an @samp{x} is added before the variable name.
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
83 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16994
diff changeset
84 ## Variable names beginning and ending with two underscores @qcode{"__"} are
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
85 ## valid, but they are used internally by Octave and should generally be
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
86 ## avoided; therefore, @code{genvarname} will not generate such names.
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
87 ##
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
88 ## @code{genvarname} will also ensure that returned names do not clash with
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16994
diff changeset
89 ## keywords such as @qcode{"for"} and @qcode{"if"}. A number will be
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16994
diff changeset
90 ## appended if necessary. Note, however, that this does @strong{not} include
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
91 ## function names such as @qcode{"sin"}. Such names should be included in
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
92 ## @var{exclusions} if necessary.
19278
6ca096827123 Use tempname() rather than tmpnam() in core Octave.
Rik <rik@octave.org>
parents: 19194
diff changeset
93 ## @seealso{isvarname, iskeyword, exist, who, tempname, eval}
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
94 ## @end deftypefn
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
95
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
96 ## Authors: Rob Platt <robert.platt@postgrad.manchester.ac.uk>
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
97 ## Bill Denney <bill@denney.ws>
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
98
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
99 function varname = genvarname (str, exclusions = {})
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
100
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
101 if (nargin < 1 || nargin > 2)
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
102 print_usage ();
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
103 endif
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
104
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
105 strinput = ischar (str);
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
106 ## Process the inputs
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
107 if (strinput)
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
108 if (rows (str) != 1)
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
109 error ("genvarname: if more than one STR is given, it must be a cellstr");
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
110 endif
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
111 str = {str};
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
112 elseif (! iscellstr (str))
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
113 error ("genvarname: STR must be a string or cellstr");
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
114 endif
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
115
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
116 if (ischar (exclusions))
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
117 if (rows (exclusions) != 1)
8664
e07e93c04080 style fixes
John W. Eaton <jwe@octave.org>
parents: 7975
diff changeset
118 error ("genvarname: if more than one exclusion is given, it must be a cellstr");
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
119 endif
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
120 exclusions = {exclusions};
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
121 elseif (! iscellstr (exclusions))
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
122 error ("genvarname: EXCLUSIONS must be a string or cellstr");
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
123 else
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
124 exclusions = exclusions(:);
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
125 endif
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
126
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
127 varname = cell (size (str));
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
128 for i = 1:numel (str)
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
129 ## Perform any modifications to the varname to make sure that it is
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
130 ## a valid variable name.
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
131
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
132 ## remove invalid characters
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
133 str{i}(! (isalnum (str{i}) | str{i} == "_")) = "_";
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
134 ## do not use keywords
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
135 if (iskeyword (str{i}))
18594
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
136 firstcharacter = toupper (str{i}(1));
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
137 str{i} = ["x", firstcharacter, str{i}(2:end)];
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
138 endif
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
139 ## The variable cannot be empty
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
140 if (isempty (str{i}))
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
141 str{i} = "x";
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
142 endif
18594
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
143 ## Leading underscores are not Matlab compatible
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
144 if (str{i}(1) == "_")
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
145 str{i} = ["x", str{i}];
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
146 endif
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
147 ## it cannot start with a number
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
148 if (isdigit (str{i}(1)))
18594
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
149 str{i} = ["x", str{i}];
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
150 endif
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
151
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
152 ## make sure that the variable is unique relative to other variables
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
153 ## and the exclusions list
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
154 excluded = any (strcmp (str{i}, exclusions));
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
155 if (excluded && isdigit (str{i}(end)))
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
156 ## if it is not unique and ends with a digit, add an underscore to
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
157 ## make the variable name more readable ("x1_1" instead of "x11")
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
158 str{i} = [str{i}, "_"];
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
159 endif
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
160 varname(i) = str(i);
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
161 idx = 0;
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
162 while (excluded)
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
163 idx++;
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14552
diff changeset
164 varname{i} = sprintf ("%s%d", str{i}, idx);
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
165 excluded = any (strcmp (varname{i}, exclusions));
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
166 endwhile
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
167 exclusions(end+1) = varname(i);
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
168 endfor
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
169
14552
86854d032a37 maint: miscellaneous style fixes for .m files
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
170 if (strinput)
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
171 varname = varname{1};
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
172 endif
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
173
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
174 endfunction
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
175
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
176
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
177 ## a single argument
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
178 %!assert (genvarname ("a"), "a")
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
179 ## a single argument with a non-conflicting exception
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
180 %!assert (genvarname ("a", "b"), "a")
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
181 ## a single argument with a conflicting exception
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
182 %!assert (genvarname ("a", "a"), "a1")
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
183 ## a single argument as a cell
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
184 %!assert (genvarname ({"a"}), {"a"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
185 %!assert (genvarname ({"a"}, "b"), {"a"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
186 %!assert (genvarname ({"a"}, {"b"}), {"a"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
187 %!assert (genvarname ({"a"}, "a"), {"a1"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
188 %!assert (genvarname ({"a"}, {"a"}), {"a1"})
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
189 ## Test different arguments
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
190 ## orientation
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
191 %!assert (genvarname ({"a" "b"}), {"a" "b"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
192 %!assert (genvarname ({"a";"b"}), {"a";"b"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
193 %!assert (genvarname ({"a" "a"}), {"a" "a1"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
194 %!assert (genvarname ({"a" "b";"c" "d"}), {"a" "b";"c" "d"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
195 %!assert (genvarname ({"a" "a" "a";"a" "a" "a"}), {"a" "a2" "a4";"a1" "a3" "a5"})
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
196 ## more than one repetition
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
197 %!assert (genvarname ({"a" "a" "a"}), {"a" "a1" "a2"})
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
198 %!assert (genvarname ({"a" "a" "a"}, {"a" "a1" "a2"}), {"a3" "a4" "a5"})
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
199 ## more than one repetition not in order
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
200 %!assert (genvarname ({"a" "b" "a" "b" "a"}), {"a" "b" "a1" "b1" "a2"})
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
201 ## Variable name munging
18594
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
202 %!assert (genvarname ("__x__"), "x__x__")
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
203 %!assert (genvarname ("123456789"), "x123456789")
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
204 %!assert (genvarname ("_$1__"), "x__1__")
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
205 %!assert (genvarname ("__foo__", "x__foo__"), "x__foo__1")
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
206 %!assert (genvarname ("1million_and1", "x1million_and1"), "x1million_and1_1")
7657
76e7548add3f genvarname.m: new function
bill@denney.ws
parents:
diff changeset
207 %!assert (genvarname ({"", "", ""}), {"x", "x1", "x2"})
18594
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
208 %!assert (genvarname ("if"), "xIf")
56f3c564baaf genvarname: don't produce names with leading underscored (bug #41923)
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 17745
diff changeset
209 %!assert (genvarname ({"if", "if", "if"}), {"xIf", "xIf1", "xIf2"})
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
210 ## Exclusions in odd format
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
211 %!assert (genvarname ("x", {"a", "b"; "x", "d"}), "x1")
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
212
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
213 ## Test input validation
19194
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
214 %!error genvarname ()
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
215 %!error genvarname (1,2,3)
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
216 %!error <more than one STR is given, it must be a cellstr> genvarname (char ("a", "b", "c"))
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
217 %!error <STR must be a string or cellstr> genvarname (1)
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
218 %!error <more than one exclusion is given, it must be a cellstr> genvarname ("x", char ("a", "b", "c"))
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
219 %!error <EXCLUSIONS must be a string or cellstr> genvarname ("x", 1)
5b64aee2257b genvarname.m: Overhaul function.
Rik <rik@octave.org>
parents: 18594
diff changeset
220