octave: libinterp/corefcn/utils.cc annotate

annotate libinterp/corefcn/utils.cc @ 29091:b924b916dc91

matlab.lang.makeValidName: reimplement in C++ (patch #9998) Rationale: `matlab.lang.makeValidName` was pure Octave code and only available from the interpreter via `octave::feval`. This is too slow for an Octave function ensuring a valid variable name, especially, when called many times from C++. For example in jsondecode. * libinterp/corefcn/utils.h: new function `octave::make_valid_name` and new helper class `octave::make_valid_name_options`. * libinterp/corefcn/utils.cc: new functions `F__make_valid_name__` and `octave::make_valid_name` and new helper class `octave::make_valid_name_options`. * scripts/+matlab/+lang/makeValidName.m: replace Octave code implementation by `F__make_valid_name__` call.

author	Kai T. Ohlhus <k.ohlhus@gmail.com>
date	Mon, 23 Nov 2020 16:11:46 +0900
parents	06c8e0877864
children	d09dde091073

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	3 // Copyright (C) 1993-2020 The Octave Project Developers
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	25
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21660 diff changeset	26 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21200 diff changeset	27 # include "config.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	28 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	29
3716 08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3622 diff changeset	30 #include <cerrno>
1346 9e41dbb74bca [project @ 1995-09-05 06:37:49 by jwe] jwe parents: 1345 diff changeset	31 #include <cstring>
1343 94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1321 diff changeset	32
3503 d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe] jwe parents: 3446 diff changeset	33 #include <fstream>
15215 9020dddc925a use std::numeric_limits for integer max and min values John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	34 #include <limits>
25438 cb1606f78f6b prefer <istream>, <ostream>, or <iosfwd> to <iostream> where possible John W. Eaton <jwe@octave.org> parents: 25173 diff changeset	35 #include <ostream>
1728 42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1711 diff changeset	36 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe] jwe parents: 1711 diff changeset	37
3040 443851377f3f [project @ 1997-06-06 09:29:28 by jwe] jwe parents: 3014 diff changeset	38 #include "dir-ops.h"
443851377f3f [project @ 1997-06-06 09:29:28 by jwe] jwe parents: 3014 diff changeset	39 #include "file-ops.h"
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2909 diff changeset	40 #include "file-stat.h"
4732 b484cdca27be [project @ 2004-02-04 04:32:48 by jwe] jwe parents: 4661 diff changeset	41 #include "lo-mappers.h"
11006 aca961a3f387 provide gethostname function John W. Eaton <jwe@octave.org> parents: 10987 diff changeset	42 #include "lo-utils.h"
21888 00f1249f2483 create wrappers for some gnulib functions John W. Eaton <jwe@octave.org> parents: 21867 diff changeset	43 #include "nanosleep-wrapper.h"
1651 e846e361a265 [project @ 1995-12-20 06:59:12 by jwe] jwe parents: 1618 diff changeset	44 #include "oct-cmplx.h"
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2909 diff changeset	45 #include "oct-env.h"
19269 65554f5847ac don't include oct-locbuf.h in header files unnecessarily John W. Eaton <jwe@octave.org> parents: 19152 diff changeset	46 #include "oct-locbuf.h"
27279 1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	47 #include "oct-string.h"
3040 443851377f3f [project @ 1997-06-06 09:29:28 by jwe] jwe parents: 3014 diff changeset	48 #include "pathsearch.h"
19269 65554f5847ac don't include oct-locbuf.h in header files unnecessarily John W. Eaton <jwe@octave.org> parents: 19152 diff changeset	49 #include "quit.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	50 #include "str-vec.h"
21888 00f1249f2483 create wrappers for some gnulib functions John W. Eaton <jwe@octave.org> parents: 21867 diff changeset	51 #include "vasprintf-wrapper.h"
1651 e846e361a265 [project @ 1995-12-20 06:59:12 by jwe] jwe parents: 1618 diff changeset	52
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	53 #include "Cell.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	54 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	55 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 21041 diff changeset	56 #include "errwarn.h"
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	57 #include "graphics.h"
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	58 #include "interpreter-private.h"
22094 9203833cab7d move new interpreter class to separate file John W. Eaton <jwe@octave.org> parents: 22022 diff changeset	59 #include "interpreter.h"
10502 f13bf183a003 isvarname: keywords are not valid variable names Judd Storrs <jstorrs@gmail.com> parents: 10315 diff changeset	60 #include "lex.h"
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	61 #include "load-path.h"
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	62 #include "oct-errno.h"
1742 a02f140ed897 [project @ 1996-01-12 11:09:39 by jwe] jwe parents: 1728 diff changeset	63 #include "oct-hist.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	64 #include "ovl.h"
10613 e103fb2182ce use internal variable instead of warning state to control whether to allow non-integer ranges as indices John W. Eaton <jwe@octave.org> parents: 10605 diff changeset	65 #include "ov-range.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	66 #include "pager.h"
10605 1834132fb50b allow non-integer ranges as indices conditionally John W. Eaton <jwe@octave.org> parents: 10502 diff changeset	67 #include "parse.h"
1690 a38bd8df9d33 [project @ 1996-01-05 21:36:24 by jwe] jwe parents: 1670 diff changeset	68 #include "sysdep.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	69 #include "unwind-prot.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	70 #include "utils.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	71 #include "variables.h"
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	72
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	73 namespace octave
4143 62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe] jwe parents: 4135 diff changeset	74 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	75 // Return TRUE if S is a valid identifier.
4143 62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe] jwe parents: 4135 diff changeset	76
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	77 bool valid_identifier (const char *s)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	78 {
26203 3c445cd7f1a4 Don't accept '$' as a valid character in variable names. Rik <rik@octave.org> parents: 26059 diff changeset	79 if (! s \|\| ! (isalpha (s) \|\| s == '_'))
4143 62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe] jwe parents: 4135 diff changeset	80 return false;
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe] jwe parents: 4135 diff changeset	81
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	82 while (*++s != '\0')
26203 3c445cd7f1a4 Don't accept '$' as a valid character in variable names. Rik <rik@octave.org> parents: 26059 diff changeset	83 if (! (isalnum (s) \|\| s == '_'))
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	84 return false;
4143 62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe] jwe parents: 4135 diff changeset	85
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	86 return true;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	87 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	88
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	89 bool valid_identifier (const std::string& s)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	90 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	91 return valid_identifier (s.c_str ());
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	92 }
4143 62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe] jwe parents: 4135 diff changeset	93 }
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe] jwe parents: 4135 diff changeset	94
8746 5dd06f19e9be handle commands in the lexer John W. Eaton <jwe@octave.org> parents: 8715 diff changeset	95 DEFUN (isvarname, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	96 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	97 @deftypefn {} {} isvarname (@var{name})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	98 Return true if @var{name} is a valid variable name.
26204 82b9b970ff19 doc: Explain what a valid variable name is in isvarname documentation. Rik <rik@octave.org> parents: 26203 diff changeset	99
82b9b970ff19 doc: Explain what a valid variable name is in isvarname documentation. Rik <rik@octave.org> parents: 26203 diff changeset	100 A valid variable name is composed of letters, digits, and underscores ("_"),
82b9b970ff19 doc: Explain what a valid variable name is in isvarname documentation. Rik <rik@octave.org> parents: 26203 diff changeset	101 and the first character must not be a digit.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	102 @seealso{iskeyword, exist, who}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	103 @end deftypefn */)
4264 4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe] jwe parents: 4254 diff changeset	104 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	105 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5814 diff changeset	106 print_usage ();
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	107
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	108 octave_value retval = false;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	109
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	110 if (args(0).is_string ())
15435 13ffb3130b2f Fix isvarname to return false if input is not a string (bug #37389) Rik <rik@octave.org> parents: 15215 diff changeset	111 {
13ffb3130b2f Fix isvarname to return false if input is not a string (bug #37389) Rik <rik@octave.org> parents: 15215 diff changeset	112 std::string varname = args(0).string_value ();
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	113
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	114 retval = (octave::valid_identifier (varname)
26059 da2bbcf1fbcd Deprecate C++ function is_keyword in favor of iskeyword for readability. Rik <rik@octave.org> parents: 25961 diff changeset	115 && ! octave::iskeyword (varname));
15435 13ffb3130b2f Fix isvarname to return false if input is not a string (bug #37389) Rik <rik@octave.org> parents: 15215 diff changeset	116 }
4264 4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe] jwe parents: 4254 diff changeset	117
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe] jwe parents: 4254 diff changeset	118 return retval;
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe] jwe parents: 4254 diff changeset	119 }
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe] jwe parents: 4254 diff changeset	120
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	121 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	122 %!assert (isvarname ("foo"), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	123 %!assert (isvarname ("_foo"), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	124 %!assert (isvarname ("_1"), true)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	125 %!assert (isvarname ("1foo"), false)
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	126 %!assert (isvarname (""), false)
15435 13ffb3130b2f Fix isvarname to return false if input is not a string (bug #37389) Rik <rik@octave.org> parents: 15215 diff changeset	127 %!assert (isvarname (12), false)
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	128 %!assert (isvarname ("foo+bar"), false)
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	129
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	130 %!error isvarname ()
21581 6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21526 diff changeset	131 %!error isvarname ("foo", "bar")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	132 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	133
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	134 namespace octave
6323 ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe] jwe parents: 6144 diff changeset	135 {
29091 b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	136 bool
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	137 make_valid_name (std::string& str, const make_valid_name_options& options)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	138 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	139 // If `isvarname (str)`, no modifications necessary.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	140 if (valid_identifier (str) && ! iskeyword (str))
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	141 return false;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	142
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	143 // Change whitespace followed by lowercase letter to uppercase, except
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	144 // for the first
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	145 bool previous = false;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	146 bool any_non_space = false;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	147 for (char& c : str)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	148 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	149 c = ((any_non_space && previous && std::isalpha (c)) ? std::toupper (c)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	150 : c);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	151 previous = std::isspace (c);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	152 any_non_space \|= (! previous); // once true, always true
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	153 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	154
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	155 // Remove any whitespace.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	156 str.erase (std::remove_if (str.begin(), str.end(),
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	157 [] (unsigned char x)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	158 { return std::isspace(x); }),
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	159 str.end());
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	160 if (str.empty ())
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	161 str = options.get_prefix ();
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	162
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	163 // Add prefix and capitalize first character, if `str` is a reserved
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	164 // keyword.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	165 if (iskeyword (str))
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	166 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	167 str[0] = std::toupper (str[0]);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	168 str = options.get_prefix () + str;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	169 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	170
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	171 // Add prefix if first character is not a letter or underscore.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	172 if (! std::isalpha (str[0]) && str[0] != '_')
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	173 str = options.get_prefix () + str;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	174
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	175 // Replace non alphanumerics or underscores
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	176 if (options.get_replacement_style () == "underscore")
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	177 for (char& c : str)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	178 c = (std::isalnum (c) ? c : '_');
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	179 else if (options.get_replacement_style () == "delete")
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	180 str.erase (std::remove_if (str.begin(), str.end(),
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	181 [] (unsigned char x)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	182 { return ! std::isalnum (x) && x != '_'; }),
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	183 str.end());
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	184 else if (options.get_replacement_style () == "hex")
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	185 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	186 const std::string permitted_chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	187 "abcdefghijklmnopqrstuvwxyz"
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	188 "_0123456789";
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	189 // Get the first non-permitted char.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	190 size_t pos = str.find_first_not_of (permitted_chars);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	191 // Buffer for hex string "0xFF" (+1 for null terminator).
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	192 char hex_str[5];
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	193 // Repeat until end of string.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	194 while (pos != std::string::npos)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	195 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	196 // Replace non-permitted char by it's hex value.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	197 std::snprintf (hex_str, sizeof (hex_str), "0x%02X", str[pos]);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	198 str.replace (pos, 1, hex_str);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	199 // Get the next occurrence from the last position.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	200 // (-1 for null terminator)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	201 pos = str.find_first_not_of (permitted_chars,
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	202 pos + sizeof (hex_str) - 1);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	203 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	204 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	205
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	206 return true;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	207 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	208
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	209 make_valid_name_options::make_valid_name_options (const octave_value_list& args)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	210 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	211 auto nargs = args.length ();
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	212 if (nargs == 0)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	213 return;
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	214
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	215 // nargs = 2, 4, 6, ... permitted
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	216 if (nargs % 2)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	217 error ("makeValidName: property/value options must occur in pairs");
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	218
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	219 auto str_to_lower = [] (std::string& s)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	220 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	221 std::transform (s.begin(), s.end(), s.begin(),
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	222 [] (unsigned char c)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	223 { return std::tolower(c); });
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	224 };
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	225
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	226 for (auto i = 0; i < nargs; i = i + 2)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	227 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	228 std::string parameter = args(i).xstring_value ("makeValidName: "
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	229 "option argument must be a string");
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	230 str_to_lower (parameter);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	231 if (parameter == "replacementstyle")
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	232 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	233 m_replacement_style = args(i + 1).xstring_value ("makeValidName: "
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	234 "'ReplacementStyle' value must be a string");
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	235 str_to_lower (m_replacement_style);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	236 if ((m_replacement_style != "underscore")
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	237 && (m_replacement_style != "delete")
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	238 && (m_replacement_style != "hex"))
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	239 error ("makeValidName: invalid 'ReplacementStyle' value '%s'",
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	240 m_replacement_style.c_str ());
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	241 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	242 else if (parameter == "prefix")
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	243 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	244 m_prefix = args(i + 1).xstring_value ("makeValidName: "
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	245 "'Prefix' value must be a string");
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	246 if (! octave::valid_identifier (m_prefix)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	247 \|\| octave::iskeyword (m_prefix))
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	248 error ("makeValidName: invalid 'Prefix' value '%s'",
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	249 m_prefix.c_str ());
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	250 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	251 else
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	252 error ("makeValidName: unknown property '%s'", parameter.c_str ());
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	253 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	254 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	255 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	256
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	257 DEFUN (__make_valid_name__, args, ,
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	258 doc: /* -- texinfo --
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	259 @deftypefn {} {@var{varname} =} __make_valid_name__ (@var{str})
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	260 @deftypefnx {} {@var{varname} =} __make_valid_name__ (@var{str}, @qcode{"ReplacementStyle"})
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	261 @deftypefnx {} {@var{varname} =} __make_valid_name__ (@var{str}, @qcode{"ReplacementStyle"}, @qcode{"Prefix"})
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	262 @deftypefnx {} {[@var{varname}, @var{ismodified}] =} __make_valid_name__ (@dots{})
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	263 Return a valid variable name @var{varname} from input @var{str}.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	264
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	265 For more documentation, see @code{matlab.lang.makeValidName}.
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	266
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	267 @seealso{isvarname, matlab.lang.makeValidName}
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	268 @end deftypefn */)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	269 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	270 auto nargin = args.length ();
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	271 if (nargin < 1)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	272 print_usage ();
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	273
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	274 octave::make_valid_name_options options (args.slice (1, nargin - 1));
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	275
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	276 if (args(0).is_string ())
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	277 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	278 std::string varname = args(0).string_value ();
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	279 bool is_modified = octave::make_valid_name (varname, options);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	280 return ovl (varname, is_modified);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	281 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	282 else if (args(0).iscellstr ())
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	283 {
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	284 Array<std::string> varnames = args(0).cellstr_value ();
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	285 Array<bool> is_modified (varnames.dims ());
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	286 for (auto i = 0; i < varnames.numel (); i++)
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	287 is_modified(i) = octave::make_valid_name (varnames(i), options);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	288 return ovl (varnames, is_modified);
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	289 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	290 else
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	291 error ("makeValidName: STR must be a string or cellstr");
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	292 }
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	293
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	294 namespace octave
b924b916dc91 matlab.lang.makeValidName: reimplement in C++ (patch #9998) Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 28888 diff changeset	295 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	296 // Return TRUE if F and G are both names for the same file.
6323 ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe] jwe parents: 6144 diff changeset	297
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	298 bool same_file (const std::string& f, const std::string& g)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	299 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	300 return same_file_internal (f, g);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	301 }
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	302 }
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	303
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	304 DEFUN (is_same_file, args, ,
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	305 doc: /* -- texinfo --
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	306 @deftypefn {} {@var{same} =} is_same_file (@var{filepath1}, @var{filepath2})
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	307 Return true if @var{filepath1} and @var{filepath2} refer to the same file.
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	308
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	309 If either @var{filepath1} or @var{filepath2} is a cell array of strings, then
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	310 an array of the same size is returned, containing the values described above
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	311 for every member of the cell array. The other argument may also be a cell
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	312 array of strings (of the same size) or a string.
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	313
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	314 Programming Notes: Depending on the operating system and file system, the same
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	315 file or folder can be referred to with different paths. In particular, paths
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	316 on the Windows platform may differ in case (@file{file1} vs.@: @file {FILE1}),
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	317 file separator (@samp{\} vs.@: @samp{/}), and format (@file{A~spaces.txt} (8.3
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	318 convention) vs.@: @file{A filename with spaces.txt}). This function returns
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	319 true if the paths in @var{filepath1} and @var{filepath2} actually refer to the
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	320 same file or folder, and false otherwise.
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	321
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	322 Note that unlike @code{strcmp}, this function requires that @var{filepath1}
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	323 and @var{filepath2} exist, as well as point to the same location, in order to
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	324 return true.
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	325
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	326 @seealso{canonicalize_file_name, strcmp}
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	327 @end deftypefn */)
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	328 {
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	329 if (args.length () != 2)
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	330 print_usage ();
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	331
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	332 octave_value retval;
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	333
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	334 bool s1_string = args(0).is_string ();
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	335 bool s1_cellstr = args(0).iscellstr ();
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	336 bool s2_string = args(1).is_string ();
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	337 bool s2_cellstr = args(1).iscellstr ();
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	338
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	339 if (s1_string && s2_string)
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	340 {
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	341 std::string file1 = args(0).string_value ();
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	342 std::string file2 = args(1).string_value ();
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	343
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	344 retval = octave::same_file (file1, file2);
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	345 }
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	346 else if ((s1_string && s2_cellstr) \|\| (s1_cellstr && s2_string))
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	347 {
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	348 octave_value str_arg, cellstr_arg;
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	349
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	350 if (s1_string)
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	351 {
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	352 str_arg = args(0);
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	353 cellstr_arg = args(1);
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	354 }
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	355 else
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	356 {
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	357 str_arg = args(1);
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	358 cellstr_arg = args(0);
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	359 }
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	360
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	361 const Array<std::string> cellstr = cellstr_arg.cellstr_value ();
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	362 const std::string str = str_arg.string_value ();
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	363
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	364 boolNDArray output (cellstr.dims (), false);
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	365
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	366 for (octave_idx_type idx = 0; idx < cellstr.numel (); idx++)
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	367 output(idx) = octave::same_file (str, cellstr(idx));
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	368
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	369 retval = output;
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	370 }
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	371 else if (s1_cellstr && s2_cellstr)
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	372 {
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	373 const Array<std::string> cellstr1 = args(0).cellstr_value ();
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	374 const Array<std::string> cellstr2 = args(1).cellstr_value ();
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	375
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	376 const dim_vector size1 = cellstr1.dims ();
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	377 const dim_vector size2 = cellstr2.dims ();
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	378
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	379 if (size1 != size2)
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	380 error ("is_same_file: cellstr arrays FILEPATH1 and FILEPATH2 must be the same size");
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	381
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	382 boolNDArray output (size1, false);
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	383
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	384 for (octave_idx_type idx = 0; idx < cellstr1.numel (); idx++)
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	385 output(idx) = octave::same_file (cellstr1(idx), cellstr2(idx));
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	386
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	387 retval = output;
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	388 }
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	389 else
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	390 error ("is_same_file: FILEPATH1 and FILEPATH2 must be strings or cell arrays of strings");
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	391
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	392 return retval;
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	393 }
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	394
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	395 /*
27580 e7df1df55f0e Fix BIST test for is_same_file on Windows platforms. Rik <rik@octave.org> parents: 27571 diff changeset	396 %!testif ; ! ispc ()
e7df1df55f0e Fix BIST test for is_same_file on Windows platforms. Rik <rik@octave.org> parents: 27571 diff changeset	397 %! assert (is_same_file ("~", tilde_expand ("~")));
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	398 %!testif ; ispc ()
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	399 %! assert (is_same_file (tolower (getenv ("OCTAVE_HOME")),
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	400 %! toupper (getenv ("OCTAVE_HOME"))), true);
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	401 %!assert (is_same_file ({pwd(), ".", tempdir()}, canonicalize_file_name (".")),
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	402 %! [true, true, false])
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	403
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	404 %!error is_same_file ()
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	405 %!error is_same_file ("foo")
27571 24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	406 %!error is_same_file ("foo", "bar", "baz")
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	407 %!error <must be strings or cell arrays of strings> is_same_file ("foo", 1)
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	408 %!error <must be strings or cell arrays of strings> is_same_file (1, "foo")
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	409 %!error <must be strings or cell arrays of strings> is_same_file ("foo", {1})
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	410 %!error <must be strings or cell arrays of strings> is_same_file ({1}, "foo")
24618a510749 Polish implementation of is_same_file(). Rik <rik@octave.org> parents: 27569 diff changeset	411 %!error <arrays .* must be the same size> is_same_file ({"1", "2"}, {"1"; "2"})
27569 29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	412 */
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	413
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	414
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	415 namespace octave
29ccef7e5295 New function "is_same_file". Markus Mützel <markus.muetzel@gmx.de> parents: 27474 diff changeset	416 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	417 int almost_match (const std::string& std, const std::string& s,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	418 int min_match_len, int case_sens)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	419 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	420 int stdlen = std.length ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	421 int slen = s.length ();
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	422
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	423 return (slen <= stdlen
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	424 && slen >= min_match_len
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	425 && (case_sens
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	426 ? (strncmp (std.c_str (), s.c_str (), slen) == 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	427 : (octave_strncasecmp (std.c_str (), s.c_str (), slen) == 0)));
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	428 }
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	429
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	430 // Ugh.
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 578 diff changeset	431
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	432 int keyword_almost_match (const char * const std, int min_len,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	433 const std::string& s,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	434 int min_toks_to_match, int max_toks)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	435 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	436 int status = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	437 int tok_count = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	438 int toks_matched = 0;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	439
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	440 if (s.empty () \|\| max_toks < 1)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	441 return status;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	442
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	443 char *kw = strsave (s.c_str ());
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	444
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	445 char *t = kw;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	446 while (*t != '\0')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	447 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	448 if (*t == '\t')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	449 *t = ' ';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	450 t++;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	451 }
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	452
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	453 char *beg = kw;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	454 while (*beg == ' ')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	455 beg++;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	456
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	457 if (*beg == '\0')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	458 return status;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	459
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	460 const char *to_match = new const char [max_toks + 1];
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	461 const char * const *s1 = std;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	462 const char **s2 = to_match;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	463
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	464 if (! s1 \|\| ! s2)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	465 goto done;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	466
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	467 s2[tok_count] = beg;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	468 char *end;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	469 while ((end = strchr (beg, ' ')) != nullptr)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	470 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	471 *end = '\0';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	472 beg = end + 1;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	473
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	474 while (*beg == ' ')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	475 beg++;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	476
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	477 if (*beg == '\0')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	478 break;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	479
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	480 tok_count++;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	481 if (tok_count >= max_toks)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	482 goto done;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	483
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	484 s2[tok_count] = beg;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	485 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	486 s2[tok_count+1] = nullptr;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	487
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	488 s2 = to_match;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	489
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	490 for (;;)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	491 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	492 if (! almost_match (s1, s2, min_len[toks_matched], 0))
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	493 goto done;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	494
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	495 toks_matched++;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	496
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	497 s1++;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	498 s2++;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	499
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	500 if (! *s2)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	501 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	502 status = (toks_matched >= min_toks_to_match);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	503 goto done;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	504 }
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	505
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	506 if (! *s1)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	507 goto done;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	508 }
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	509
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	510 done:
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	511
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	512 delete [] kw;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	513 delete [] to_match;
287 6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe] jwe parents: 278 diff changeset	514
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	515 return status;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	516 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	517
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	518 // See if the given file is in the path.
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 578 diff changeset	519
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	520 std::string search_path_for_file (const std::string& path,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	521 const string_vector& names)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	522 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	523 directory_path p (path);
686 0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe] jwe parents: 679 diff changeset	524
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	525 return sys::env::make_absolute (p.find_first_of (names.std_list ()));
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	526 }
686 0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe] jwe parents: 679 diff changeset	527
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	528 // Find all locations of the given file in the path.
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	529
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	530 string_vector search_path_for_all_files (const std::string& path,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	531 const string_vector& names)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	532 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	533 directory_path p (path);
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	534
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	535 string_vector sv = p.find_all_first_of (names.std_list ());
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	536
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	537 octave_idx_type len = sv.numel ();
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	538
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	539 for (octave_idx_type i = 0; i < len; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	540 sv[i] = sys::env::make_absolute (sv[i]);
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	541
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	542 return sv;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	543 }
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	544
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	545 static string_vector make_absolute (const string_vector& sv)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	546 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	547 octave_idx_type len = sv.numel ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	548
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	549 string_vector retval (len);
6379 41c1deed5613 [project @ 2007-03-02 18:43:20 by jwe] jwe parents: 6323 diff changeset	550
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	551 for (octave_idx_type i = 0; i < len; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	552 retval[i] = sys::env::make_absolute (sv[i]);
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	553
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	554 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	555 }
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	556 }
e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	557
23519 4fe410bd918d use DEFMETHOD for some built-in functions John W. Eaton <jwe@octave.org> parents: 23468 diff changeset	558 DEFMETHOD (file_in_loadpath, interp, args, ,
4fe410bd918d use DEFMETHOD for some built-in functions John W. Eaton <jwe@octave.org> parents: 23468 diff changeset	559 doc: /* -- texinfo --
23988 bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	560 @deftypefn {} {@var{fname} =} file_in_loadpath (@var{file})
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	561 @deftypefnx {} {@var{fname} =} file_in_loadpath (@var{file}, "all")
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	562 Return the absolute name of @var{file} if it can be found in the list of
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	563 directories specified by @code{path}.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	564
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	565 If no file is found, return an empty character string.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	566
23988 bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	567 When @var{file} is already an absolute name, the name is checked against the
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	568 file system instead of Octave's loadpath. In this case, if @var{file} exists
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	569 it will be returned in @var{fname}, otherwise an empty string is returned.
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	570
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	571 If the first argument is a cell array of strings, search each directory of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	572 the loadpath for element of the cell array and return the first that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	573 matches.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	574
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	575 If the second optional argument @qcode{"all"} is supplied, return a cell
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	576 array containing the list of all files that have the same name in the path.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	577 If no files are found, return an empty cell array.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	578 @seealso{file_in_path, dir_in_loadpath, path}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	579 @end deftypefn */)
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3174 diff changeset	580 {
4243 7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe] jwe parents: 4233 diff changeset	581 int nargin = args.length ();
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3174 diff changeset	582
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	583 if (nargin < 1 \|\| nargin > 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	584 print_usage ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	585
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20973 diff changeset	586 string_vector names = args(0).xstring_vector_value ("file_in_loadpath: FILE argument must be a string");
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	587
20973 7af34656efed maint: utils.cc: Clean up code. Rik <rik@octave.org> parents: 20966 diff changeset	588 if (names.empty ())
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	589 error ("file_in_loadpath: FILE argument must not be empty");
4243 7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe] jwe parents: 4233 diff changeset	590
23519 4fe410bd918d use DEFMETHOD for some built-in functions John W. Eaton <jwe@octave.org> parents: 23468 diff changeset	591 octave::load_path& lp = interp.get_load_path ();
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	592
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	593 if (nargin == 1)
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	594 return ovl (octave::sys::env::make_absolute (lp.find_first_of (names)));
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	595 else
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	596 {
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	597 std::string opt = args(1).xstring_value ("file_in_loadpath: optional second argument must be a string");
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	598
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	599 if (opt != "all")
23803 90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes. Rik <rik@octave.org> parents: 23795 diff changeset	600 error (R"(file_in_loadpath: "all" is only valid second argument)");
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	601
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	602 return ovl (Cell (octave::make_absolute (lp.find_all_first_of (names))));
4216 e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe] jwe parents: 4212 diff changeset	603 }
3195 7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3174 diff changeset	604 }
7a5a5da64756 [project @ 1998-10-28 22:54:04 by jwe] jwe parents: 3174 diff changeset	605
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	606 /*
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	607 %!test
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	608 %! f = file_in_loadpath ("plot.m");
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	609 %! assert (ischar (f));
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	610 %! assert (! isempty (f));
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	611
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	612 %!test
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	613 %! f = file_in_loadpath ("$$probably_!! _not_&&_a_!! _file$$");
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	614 %! assert (f, "");
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	615
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	616 %!test
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	617 %! lst = file_in_loadpath ("$$probably_!! _not_&&_a_!! _file$$", "all");
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	618 %! assert (lst, {});
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	619
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	620 %!error file_in_loadpath ()
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	621 %!error file_in_loadpath ("foo", "bar", 1)
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	622 %!error file_in_loadpath ([])
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	623 %!error file_in_loadpath ("plot.m", "bar")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	624 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	625
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1884 diff changeset	626 DEFUN (file_in_path, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	627 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	628 @deftypefn {} {} file_in_path (@var{path}, @var{file})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	629 @deftypefnx {} {} file_in_path (@var{path}, @var{file}, "all")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	630 Return the absolute name of @var{file} if it can be found in @var{path}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	631
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	632 The value of @var{path} should be a colon-separated list of directories in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	633 the format described for @code{path}. If no file is found, return an empty
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	634 character string. For example:
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	635
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	636 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	637 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	638 file_in_path (EXEC_PATH, "sh")
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	639 @result{} "/bin/sh"
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	640 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	641 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	642
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	643 If the second argument is a cell array of strings, search each directory of
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	644 the path for element of the cell array and return the first that matches.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	645
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	646 If the third optional argument @qcode{"all"} is supplied, return a cell
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	647 array containing the list of all files that have the same name in the path.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	648 If no files are found, return an empty cell array.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	649 @seealso{file_in_loadpath, dir_in_loadpath, path}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	650 @end deftypefn */)
686 0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe] jwe parents: 679 diff changeset	651 {
4243 7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe] jwe parents: 4233 diff changeset	652 int nargin = args.length ();
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	653
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	654 if (nargin < 2 \|\| nargin > 3)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	655 print_usage ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	656
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	657 std::string path = args(0).xstring_value ("file_in_path: PATH must be a string");
20582 ba2b07c13913 use new string_value method to handle value extraction errors John W. Eaton <jwe@octave.org> parents: 20559 diff changeset	658
20990 fc9cca99b2de Deprecate all_strings, replace with string_vector_value. Rik <rik@octave.org> parents: 20973 diff changeset	659 string_vector names = args(1).xstring_vector_value ("file_in_path: FILE argument must be a string");
4243 7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe] jwe parents: 4233 diff changeset	660
20973 7af34656efed maint: utils.cc: Clean up code. Rik <rik@octave.org> parents: 20966 diff changeset	661 if (names.empty ())
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	662 error ("file_in_path: FILE argument must not be empty");
4243 7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe] jwe parents: 4233 diff changeset	663
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	664 if (nargin == 2)
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	665 return ovl (octave::search_path_for_file (path, names));
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	666 else
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	667 {
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	668 std::string opt = args(2).xstring_value ("file_in_path: optional third argument must be a string");
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	669
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	670 if (opt != "all")
23803 90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes. Rik <rik@octave.org> parents: 23795 diff changeset	671 error (R"(file_in_path: "all" is only valid third argument)");
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	672
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	673 return ovl (Cell (octave::make_absolute (octave::search_path_for_all_files (path, names))));
686 0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe] jwe parents: 679 diff changeset	674 }
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe] jwe parents: 679 diff changeset	675 }
0faebdd7df57 [project @ 1994-09-09 21:09:24 by jwe] jwe parents: 679 diff changeset	676
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	677 /*
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	678 %!test
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	679 %! f = file_in_path (path (), "plot.m");
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	680 %! assert (ischar (f));
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	681 %! assert (! isempty (f));
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	682
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	683 %!test
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	684 %! f = file_in_path (path (), "$$probably_!! _not_&&_a_!! _file$$");
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	685 %! assert (f, "");
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	686
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	687 %!test
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	688 %! lst = file_in_path (path (), "$$probably_!! _not_&&_a_!! _file$$", "all");
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	689 %! assert (lst, {});
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	690
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	691 %!error file_in_path ()
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	692 %!error file_in_path ("foo")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	693 %!error file_in_path ("foo", "bar", "baz", 1)
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	694 %!error file_in_path ([])
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	695 %!error file_in_path (path (), [])
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	696 %!error file_in_path (path (), "plot.m", "bar")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	697 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	698
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	699 namespace octave
526 a01a9db8ab69 [project @ 1994-07-20 18:46:24 by jwe] jwe parents: 478 diff changeset	700 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	701 std::string file_in_path (const std::string& name, const std::string& suffix)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	702 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	703 std::string nm = name;
526 a01a9db8ab69 [project @ 1994-07-20 18:46:24 by jwe] jwe parents: 478 diff changeset	704
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	705 if (! suffix.empty ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	706 nm.append (suffix);
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	707
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	708 load_path& lp = __get_load_path__ ("file_in_path");
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	709
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	710 return sys::env::make_absolute (lp.find_file (nm));
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	711 }
526 a01a9db8ab69 [project @ 1994-07-20 18:46:24 by jwe] jwe parents: 478 diff changeset	712
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	713 std::string find_data_file_in_load_path (const std::string& fcn,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	714 const std::string& file,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	715 bool require_regular_file)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	716 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	717 std::string fname = file;
19030 9ef10e6a5987 make "file found in path" warnings consistent John W. Eaton <jwe@octave.org> parents: 18812 diff changeset	718
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	719 if (! (sys::env::absolute_pathname (fname)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	720 \|\| sys::env::rooted_relative_pathname (fname)))
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	721 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	722 // Load path will also search "." first, but we don't want to
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	723 // issue a warning if the file is found in the current directory,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	724 // so do an explicit check for that.
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	725 sys::file_stat fs (fname);
19030 9ef10e6a5987 make "file found in path" warnings consistent John W. Eaton <jwe@octave.org> parents: 18812 diff changeset	726
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	727 bool local_file_ok
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	728 = fs.exists () && (fs.is_reg () \|\| ! require_regular_file);
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	729
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	730 if (! local_file_ok)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	731 {
27277 db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 27160 diff changeset	732 load_path& lp = __get_load_path__ ("find_data_file_in_load_path");
19030 9ef10e6a5987 make "file found in path" warnings consistent John W. Eaton <jwe@octave.org> parents: 18812 diff changeset	733
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	734 // Not directly found; search load path.
27277 db687716fed6 style fixes: generally aim to break long lines before operators, not after John W. Eaton <jwe@octave.org> parents: 27160 diff changeset	735 std::string tmp = sys::env::make_absolute (lp.find_file (fname));
19030 9ef10e6a5987 make "file found in path" warnings consistent John W. Eaton <jwe@octave.org> parents: 18812 diff changeset	736
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	737 if (! tmp.empty ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	738 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	739 warn_data_file_in_path (fcn, tmp);
19030 9ef10e6a5987 make "file found in path" warnings consistent John W. Eaton <jwe@octave.org> parents: 18812 diff changeset	740
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	741 fname = tmp;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	742 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	743 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	744 }
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 578 diff changeset	745
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	746 return fname;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	747 }
908 efb4cbdaac26 [project @ 1994-11-09 23:03:37 by jwe] jwe parents: 826 diff changeset	748
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	749 // See if there is an function file in the path.
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	750 // If so, return the full path to the file.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11575 diff changeset	751
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	752 std::string fcn_file_in_path (const std::string& name)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	753 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	754 std::string retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	755
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	756 int len = name.length ();
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	757
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	758 if (len > 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	759 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	760 if (sys::env::absolute_pathname (name))
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	761 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	762 sys::file_stat fs (name);
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	763
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	764 if (fs.exists () && ! fs.is_dir ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	765 retval = name;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	766 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	767 else if (len > 2 && name[len - 2] == '.' && name[len - 1] == 'm')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	768 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	769 load_path& lp = __get_load_path__ ("fcn_file_in_path");
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	770
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	771 retval = lp.find_fcn_file (name.substr (0, len-2));
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	772 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	773 else
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	774 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	775 std::string fname = name;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	776 size_t pos = name.find_first_of ('>');
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	777 if (pos != std::string::npos)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	778 fname = name.substr (0, pos);
8041 a14bdf90be55 Add a search for Contents.m files to the help function David Bateman <dbateman@free.fr> parents: 8021 diff changeset	779
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	780 load_path& lp = __get_load_path__ ("fcn_file_in_path");
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	781
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	782 retval = lp.find_fcn_file (fname);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	783 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	784 }
8041 a14bdf90be55 Add a search for Contents.m files to the help function David Bateman <dbateman@free.fr> parents: 8021 diff changeset	785
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	786 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	787 }
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	788
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	789 // See if there is a directory called "name" in the path and if it
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	790 // contains a Contents.m file. If so, return the full path to this file.
8041 a14bdf90be55 Add a search for Contents.m files to the help function David Bateman <dbateman@free.fr> parents: 8021 diff changeset	791
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	792 std::string contents_file_in_path (const std::string& dir)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	793 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	794 std::string retval;
8041 a14bdf90be55 Add a search for Contents.m files to the help function David Bateman <dbateman@free.fr> parents: 8021 diff changeset	795
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	796 if (! dir.empty ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	797 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	798 load_path& lp = __get_load_path__ ("contents_in_file_path");
8041 a14bdf90be55 Add a search for Contents.m files to the help function David Bateman <dbateman@free.fr> parents: 8021 diff changeset	799
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	800 std::string tcontents
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	801 = sys::file_ops::concat (lp.find_dir (dir), "Contents.m");
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	802
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	803 sys::file_stat fs (tcontents);
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	804
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	805 if (fs.exists ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	806 retval = sys::env::make_absolute (tcontents);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	807 }
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	808
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	809 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	810 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	811
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	812 // Replace backslash escapes in a string with the real values.
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	813
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	814 std::string do_string_escapes (const std::string& s)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	815 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	816 std::string retval;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	817
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	818 size_t i = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	819 size_t j = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	820 size_t len = s.length ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	821
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	822 retval.resize (len);
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	823
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	824 while (j < len)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	825 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	826 if (s[j] == '\\' && j+1 < len)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	827 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	828 switch (s[++j])
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	829 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	830 case 'a': // alarm
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	831 retval[i] = '\a';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	832 break;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	833
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	834 case 'b': // backspace
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	835 retval[i] = '\b';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	836 break;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	837
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	838 case 'f': // formfeed
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	839 retval[i] = '\f';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	840 break;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	841
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	842 case 'n': // newline
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	843 retval[i] = '\n';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	844 break;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	845
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	846 case 'r': // carriage return
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	847 retval[i] = '\r';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	848 break;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	849
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	850 case 't': // horizontal tab
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	851 retval[i] = '\t';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	852 break;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	853
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	854 case 'v': // vertical tab
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	855 retval[i] = '\v';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	856 break;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	857
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	858 case '\\': // backslash
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	859 retval[i] = '\\';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	860 break;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	861
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	862 case '\'': // quote
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	863 retval[i] = '\'';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	864 break;
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	865
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	866 case '"': // double quote
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	867 retval[i] = '"';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	868 break;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	869
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	870 case '0':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	871 case '1':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	872 case '2':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	873 case '3':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	874 case '4':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	875 case '5':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	876 case '6':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	877 case '7': // octal input
20210 29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	878 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	879 size_t k;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	880 int tmpi = s[j] - '0';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	881 for (k = j+1; k < std::min (j+3, len); k++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	882 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	883 int digit = s[k] - '0';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	884 if (digit < 0 \|\| digit > 7)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	885 break;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	886 tmpi <<= 3;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	887 tmpi += digit;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	888 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	889 retval[i] = tmpi;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	890 j = k - 1;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	891 break;
20210 29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	892 }
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	893
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	894 case 'x': // hex input
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	895 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	896 size_t k;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	897 int tmpi = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	898 for (k = j+1; k < std::min (j+3, len); k++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	899 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	900 if (! isxdigit (s[k]))
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	901 break;
20210 29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	902
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	903 tmpi <<= 4;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	904 int digit = s[k];
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	905 if (digit >= 'a')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	906 tmpi += digit - 'a' + 10;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	907 else if (digit >= 'A')
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	908 tmpi += digit - 'A' + 10;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	909 else
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	910 tmpi += digit - '0';
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	911 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	912
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	913 if (k == j+1)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	914 warning (R"(malformed hex escape sequence '\x' -- converting to '\0')");
20210 29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	915
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	916 retval[i] = tmpi;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	917 j = k - 1;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	918 break;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	919 }
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	920
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	921 default:
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	922 warning (R"(unrecognized escape sequence '\%c' -- converting to '%c')", s[j], s[j]);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	923 retval[i] = s[j];
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	924 break;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	925 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	926 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	927 else
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	928 retval[i] = s[j];
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	929
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	930 i++;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	931 j++;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	932 }
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	933
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	934 retval.resize (i);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	935
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	936 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	937 }
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	938 }
98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	939
98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	940 DEFUN (do_string_escapes, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	941 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	942 @deftypefn {} {} do_string_escapes (@var{string})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	943 Convert escape sequences in @var{string} to the characters they represent.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	944
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	945 Escape sequences begin with a leading backslash
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	946 (@qcode{'@xbackslashchar{}'}) followed by 1--3 characters
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	947 (.e.g., @qcode{"@xbackslashchar{}n"} => newline).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	948 @seealso{undo_string_escapes}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	949 @end deftypefn */)
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	950 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	951 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5814 diff changeset	952 print_usage ();
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	953
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	954 std::string str = args(0).xstring_value ("do_string_escapes: STRING argument must be of type string");
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	955
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	956 return ovl (octave::do_string_escapes (str));
3103 98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	957 }
98d862e12945 [project @ 1997-11-18 10:46:30 by jwe] jwe parents: 3072 diff changeset	958
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	959 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	960 %!assert (do_string_escapes ('foo\nbar'), "foo\nbar")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	961 %!assert (do_string_escapes ("foo\\nbar"), "foo\nbar")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	962 %!assert (do_string_escapes ("foo\\nbar"), ["foo", char(10), "bar"])
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	963 %!assert ("foo\nbar", ["foo", char(10), "bar"])
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	964
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	965 %!assert (do_string_escapes ('\0\a\b\f\n\r\t\v'), "\0\a\b\f\n\r\t\v")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	966 %!assert (do_string_escapes ("\\0\\a\\b\\f\\n\\r\\t\\v"), "\0\a\b\f\n\r\t\v")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	967 %!assert (do_string_escapes ("\\0\\a\\b\\f\\n\\r\\t\\v"),
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	968 %! char ([0, 7, 8, 12, 10, 13, 9, 11]))
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	969 %!assert ("\0\a\b\f\n\r\t\v", char ([0, 7, 8, 12, 10, 13, 9, 11]))
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	970
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	971 %!assert (do_string_escapes ('\\'), "\\")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	972 %!assert (do_string_escapes ("\\\\"), "\\")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	973 %!assert (do_string_escapes ("\\\\"), char (92))
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	974
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	975 %!assert (do_string_escapes ('\''single-quoted\'''), "'single-quoted'")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	976 %!assert (do_string_escapes ("\\'single-quoted\\'"), "'single-quoted'")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	977 %!assert (do_string_escapes ('\"double-quoted\"'), "\"double-quoted\"")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	978 %!assert (do_string_escapes ("\\\"double-quoted\\\""), "\"double-quoted\"")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	979
20210 29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	980 %!assert (do_string_escapes ('A\4B'), ["A" char(4) "B"])
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	981 %!assert (do_string_escapes ('A\45B'), ["A" char(37) "B"])
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	982 %!assert (do_string_escapes ('A\123B'), ["A" char(83) "B"])
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	983 %!assert (sprintf ('\117\143\164\141\166\145'), "Octave")
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	984
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	985 %!assert (do_string_escapes ('A\x4G'), ["A" char(4) "G"])
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	986 %!assert (do_string_escapes ('A\x4AG'), ["A" char(74) "G"])
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	987 %!assert (sprintf ('\x4f\x63\x74\x61\x76\x65'), "Octave")
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	988
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	989 %!error do_string_escapes ()
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	990 %!error do_string_escapes ("foo", "bar")
20210 29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	991 %!error <STRING argument> do_string_escapes (3)
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	992 %!warning <malformed hex escape sequence> do_string_escapes ('\xG');
29eb47fe8e8c Add support for octal and hex escape sequences in single-quoted printf arguments (bug #39774). Rik <rik@octave.org>* parents: 20194 diff changeset	993 %!warning <unrecognized escape sequence> do_string_escapes ('\G');
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	994 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	995
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	996 namespace octave
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	997 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	998 const char * undo_string_escape (char c)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	999 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1000 if (! c)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1001 return "";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1002
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1003 switch (c)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1004 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1005 case '\0':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1006 return R"(\0)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1007
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1008 case '\a':
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1009 return R"(\a)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1010
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1011 case '\b': // backspace
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1012 return R"(\b)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1013
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1014 case '\f': // formfeed
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1015 return R"(\f)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1016
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1017 case '\n': // newline
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1018 return R"(\n)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1019
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1020 case '\r': // carriage return
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1021 return R"(\r)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1022
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1023 case '\t': // horizontal tab
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1024 return R"(\t)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1025
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1026 case '\v': // vertical tab
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1027 return R"(\v)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1028
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1029 case '\\': // backslash
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1030 return R"(\\)";
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1031
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1032 case '"': // double quote
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1033 return R"(\")";
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1034
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1035 default:
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1036 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1037 static char retval[2] {'\0', '\0'};
20973 7af34656efed maint: utils.cc: Clean up code. Rik <rik@octave.org> parents: 20966 diff changeset	1038
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1039 retval[0] = c;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1040 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1041 }
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1750 diff changeset	1042 }
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1043 }
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1044
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1045 std::string undo_string_escapes (const std::string& s)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1046 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1047 std::string retval;
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1048
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1049 for (size_t i = 0; i < s.length (); i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1050 retval.append (undo_string_escape (s[i]));
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1051
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1052 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1053 }
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1054 }
cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1055
1957 0e6a0a271998 [project @ 1996-02-15 01:08:15 by jwe] jwe parents: 1884 diff changeset	1056 DEFUN (undo_string_escapes, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1057 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1058 @deftypefn {} {} undo_string_escapes (@var{s})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1059 Convert special characters in strings back to their escaped forms.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1060
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1061 For example, the expression
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1062
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1063 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1064 bell = "\a";
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1065 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1066
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1067 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1068 assigns the value of the alert character (control-g, ASCII code 7) to the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1069 string variable @code{bell}. If this string is printed, the system will
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1070 ring the terminal bell (if it is possible). This is normally the desired
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1071 outcome. However, sometimes it is useful to be able to print the original
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1072 representation of the string, with the special characters replaced by their
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1073 escape sequences. For example,
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1074
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1075 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1076 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1077 octave:13> undo_string_escapes (bell)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1078 ans = \a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1079 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1080 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1081
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1082 @noindent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1083 replaces the unprintable alert character with its printable representation.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1084 @seealso{do_string_escapes}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1085 @end deftypefn */)
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1086 {
20819 f428cbe7576f eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	1087 if (args.length () != 1)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5814 diff changeset	1088 print_usage ();
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1089
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1090 std::string str = args(0).xstring_value ("undo_string_escapes: S argument must be a string");
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1091
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1092 return ovl (octave::undo_string_escapes (str));
801 cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1093 }
cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe] jwe parents: 738 diff changeset	1094
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1095 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1096 %!assert (undo_string_escapes ("foo\nbar"), 'foo\nbar')
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1097 %!assert (undo_string_escapes ("foo\nbar"), "foo\\nbar")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1098 %!assert (undo_string_escapes (["foo", char(10), "bar"]), "foo\\nbar")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1099
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1100 %!assert (undo_string_escapes ("\a\b\f\n\r\t\v"), '\a\b\f\n\r\t\v')
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1101 %!assert (undo_string_escapes ("\a\b\f\n\r\t\v"), "\\a\\b\\f\\n\\r\\t\\v")
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1102 %!assert (undo_string_escapes (char ([7, 8, 12, 10, 13, 9, 11])),
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1103 %! "\\a\\b\\f\\n\\r\\t\\v")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1104
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1105 %!assert (undo_string_escapes ("\\"), '\\')
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1106 %!assert (undo_string_escapes ("\\"), "\\\\")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1107 %!assert (undo_string_escapes (char (92)), "\\\\")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1108
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1109 %!assert (undo_string_escapes ("\"double-quoted\""), '\"double-quoted\"')
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1110 %!assert (undo_string_escapes ("\"double-quoted\""), "\\\"double-quoted\\\"")
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1111
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	1112 %!error undo_string_escapes ()
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1113 %!error undo_string_escapes ("foo", "bar")
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1114 %!error undo_string_escapes (3)
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1115 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1116
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1117 DEFUN (is_absolute_filename, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1118 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1119 @deftypefn {} {} is_absolute_filename (@var{file})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1120 Return true if @var{file} is an absolute filename.
25781 e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25659 diff changeset	1121 @seealso{is_rooted_relative_filename, make_absolute_filename, isfolder}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1122 @end deftypefn */)
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1123 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1124 if (args.length () != 1)
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1125 print_usage ();
1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1126
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1127 return ovl (args(0).is_string ()
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	1128 && octave::sys::env::absolute_pathname (args(0).string_value ()));
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1129 }
1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1130
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1131 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1132 ## FIXME: We need system-dependent tests here.
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1133
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	1134 %!error is_absolute_filename ()
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1135 %!error is_absolute_filename ("foo", "bar")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1136 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1137
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1138 DEFUN (is_rooted_relative_filename, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1139 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1140 @deftypefn {} {} is_rooted_relative_filename (@var{file})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1141 Return true if @var{file} is a rooted-relative filename.
25781 e04c56bbbace isdir.m: Make m-file a legacy function (bug #54489) Rik <rik@octave.org> parents: 25659 diff changeset	1142 @seealso{is_absolute_filename, make_absolute_filename, isfolder}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1143 @end deftypefn */)
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1144 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1145 if (args.length () != 1)
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1146 print_usage ();
1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1147
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1148 return ovl (args(0).is_string ()
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	1149 && octave::sys::env::rooted_relative_pathname (args(0).string_value ()));
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1150 }
1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1151
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1152 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1153 ## FIXME: We need system-dependent tests here.
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1154
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	1155 %!error is_rooted_relative_filename ()
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1156 %!error is_rooted_relative_filename ("foo", "bar")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1157 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1158
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1159 DEFUN (make_absolute_filename, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1160 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1161 @deftypefn {} {} make_absolute_filename (@var{file})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1162 Return the full name of @var{file} beginning from the root of the file
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1163 system.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1164
28292 5bf3f462c11e Document that make_absolute_filename and canonicalize_file_name do not Philip Nienhuis <prnienhuis@users.sf.net> parents: 28012 diff changeset	1165 No check is done for the existence of @var{file}. No tilde expansion of
5bf3f462c11e Document that make_absolute_filename and canonicalize_file_name do not Philip Nienhuis <prnienhuis@users.sf.net> parents: 28012 diff changeset	1166 @var{file} is performed.
5bf3f462c11e Document that make_absolute_filename and canonicalize_file_name do not Philip Nienhuis <prnienhuis@users.sf.net> parents: 28012 diff changeset	1167 @seealso{canonicalize_file_name, is_absolute_filename, is_rooted_relative_filename, isfolder, tilde_expand}
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1168 @end deftypefn */)
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1169 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1170 if (args.length () != 1)
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1171 print_usage ();
1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1172
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1173 std::string nm = args(0).xstring_value ("make_absolute_filename: FILE argument must be a filename");
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1174
21732 6a1eded90355 use namespace for system env class John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	1175 return ovl (octave::sys::env::make_absolute (nm));
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1176 }
1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1177
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1178 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1179 ## FIXME: We need system-dependent tests here.
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1180
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	1181 %!error make_absolute_filename ()
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1182 %!error make_absolute_filename ("foo", "bar")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1183 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1184
23519 4fe410bd918d use DEFMETHOD for some built-in functions John W. Eaton <jwe@octave.org> parents: 23468 diff changeset	1185 DEFMETHOD (dir_in_loadpath, interp, args, ,
4fe410bd918d use DEFMETHOD for some built-in functions John W. Eaton <jwe@octave.org> parents: 23468 diff changeset	1186 doc: /* -- texinfo --
23988 bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1187 @deftypefn {} {@var{dirname} =} dir_in_loadpath (@var{dir})
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1188 @deftypefnx {} {@var{dirname} =} dir_in_loadpath (@var{dir}, "all")
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1189 Return the absolute name of the loadpath element matching @var{dir} if it can
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1190 be found in the list of directories specified by @code{path}.
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1191
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1192 If no match is found, return an empty character string.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1193
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1194 The match is performed at the end of each path element. For example, if
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1195 @var{dir} is @qcode{"foo/bar"}, it matches the path element
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1196 @nospell{@qcode{"/some/dir/foo/bar"}}, but not
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1197 @nospell{@qcode{"/some/dir/foo/bar/baz"}}
23988 bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1198 @nospell{@qcode{"/some/dir/allfoo/bar"}}. When @var{dir} is an absolute name,
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1199 rather than just a path fragment, it is matched against the file system
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1200 instead of Octave's loadpath. In this case, if @var{dir} exists it will be
bdde51fda657 doc: Improve docstrings for file_in_loadpath, dir_in_loadpath (bug #51706). Rik <rik@octave.org> parents: 23925 diff changeset	1201 returned in @var{dirname}, otherwise an empty string is returned.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1202
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1203 If the optional second argument is supplied, return a cell array containing
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1204 all name matches rather than just the first.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1205 @seealso{file_in_path, file_in_loadpath, path}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1206 @end deftypefn */)
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1207 {
9806 8e345f2fe4d6 improved support for Contents.m files John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	1208 int nargin = args.length ();
8e345f2fe4d6 improved support for Contents.m files John W. Eaton <jwe@octave.org> parents: 9758 diff changeset	1209
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1210 if (nargin < 1 \|\| nargin > 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1211 print_usage ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1212
20812 d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20800 diff changeset	1213 std::string dir;
d9ca869ca124 maint: Clean-up more instances of print_usage(). Rik <rik@octave.org> parents: 20800 diff changeset	1214
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1215 dir = args(0).xstring_value ("dir_in_loadpath: DIR must be a directory name");
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1216
23519 4fe410bd918d use DEFMETHOD for some built-in functions John W. Eaton <jwe@octave.org> parents: 23468 diff changeset	1217 octave::load_path& lp = interp.get_load_path ();
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	1218
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1219 if (nargin == 1)
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	1220 return ovl (lp.find_dir (dir));
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1221 else
23438 d24d01273bd0 eliminate load-path singleton John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	1222 return ovl (Cell (lp.find_matching_dirs (dir)));
8229 1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1223 }
1bf51192fa1d imported patch rundemos John W. Eaton <jwe@octave.org> parents: 8041 diff changeset	1224
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1225 /*
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1226 %!test
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1227 %! f = dir_in_loadpath ("plot");
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1228 %! assert (ischar (f));
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1229 %! assert (! isempty (f));
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1230
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1231 %!test
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	1232 %! f = dir_in_loadpath ("$$probably_!! _not_&&_a_!! _dir$$");
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1233 %! assert (f, "");
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1234
ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1235 %!test
20955 77f5591878bf maint: Use '! expr' rather than '!expr' to conform to coding guidelines. Rik <rik@octave.org> parents: 20940 diff changeset	1236 %! lst = dir_in_loadpath ("$$probably_!! _not_&&_a_!! _dir$$", "all");
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1237 %! assert (lst, {});
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1238
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	1239 %!error dir_in_loadpath ()
18110 2217bc116aa9 maint: Dummy merge with gui-release, ignoring all recent backout merges Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 18105 diff changeset	1240 %!error dir_in_loadpath ("foo", "bar", 1)
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1241 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1242
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1243 DEFUNX ("errno", Ferrno, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1244 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1245 @deftypefn {} {@var{err} =} errno ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1246 @deftypefnx {} {@var{err} =} errno (@var{val})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1247 @deftypefnx {} {@var{err} =} errno (@var{name})
25106 d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1248 Query or set the system-dependent variable errno.
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1249
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1250 When called with no inputs, return the current value of errno.
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1251
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1252 When called with a numeric input @var{val}, set the current value of errno
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1253 to the specified value. The previous value of errno is returned as @var{err}.
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1254
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1255 When called with a character string @var{name}, return the numeric value of
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1256 errno which corresponds to the specified error code. If @var{name} is not
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1257 a recognized error code then -1 is returned.
d7ad543255c5 doc: Shorten very long first sentences of docstrings (bug #53388). Rik <rik@octave.org> parents: 25103 diff changeset	1258
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1259 @seealso{errno_list}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1260 @end deftypefn */)
3716 08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3622 diff changeset	1261 {
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1262 int nargin = args.length ();
d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1263
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1264 if (nargin > 1)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1265 print_usage ();
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1266
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1267 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1268
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1269 if (nargin == 1)
d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1270 {
d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1271 if (args(0).is_string ())
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10257 diff changeset	1272 {
57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10257 diff changeset	1273 std::string nm = args(0).string_value ();
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1274
19743 67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation. Rik <rik@octave.org> parents: 19697 diff changeset	1275 retval = octave_errno::lookup (nm);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10257 diff changeset	1276 }
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1277 else
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10257 diff changeset	1278 {
20703 85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	1279 int val = args(0).xint_value ("errno: argument must be string or integer");
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1280
20703 85e5efae848a eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20700 diff changeset	1281 retval = octave_errno::set (val);
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10257 diff changeset	1282 }
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1283 }
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1284 else
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1285 retval = octave_errno::get ();
3716 08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3622 diff changeset	1286
08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3622 diff changeset	1287 return retval;
08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3622 diff changeset	1288 }
08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3622 diff changeset	1289
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1290 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1291 %!assert (isnumeric (errno ()))
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1292
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1293 %!test
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1294 %! lst = errno_list ();
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1295 %! fns = fieldnames (lst);
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1296 %! oldval = errno (fns{1});
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1297 %! assert (isnumeric (oldval));
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1298 %! errno (oldval);
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1299 %! newval = errno ();
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1300 %! assert (oldval, newval);
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1301
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1302 %!error errno ("foo", 1)
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1303 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1304
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1305 DEFUN (errno_list, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1306 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1307 @deftypefn {} {} errno_list ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1308 Return a structure containing the system-dependent errno values.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1309 @seealso{errno}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1310 @end deftypefn */)
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1311 {
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1312 if (args.length () != 0)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5814 diff changeset	1313 print_usage ();
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1314
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1315 return ovl (octave_errno::list ());
5465 d6163c0effd5 [project @ 2005-09-23 15:42:48 by jwe] jwe parents: 5458 diff changeset	1316 }
3716 08fe5f74c7d4 [project @ 2000-09-07 04:59:03 by jwe] jwe parents: 3622 diff changeset	1317
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1318 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1319 %!assert (isstruct (errno_list ()))
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1320
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1321 %!error errno_list ("foo")
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1322 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1323
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1324 namespace octave
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3350 diff changeset	1325 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1326 static void check_dimensions (octave_idx_type& nr, octave_idx_type& nc,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1327 const char *warnfor)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1328 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1329 if (nr < 0 \|\| nc < 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1330 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1331 warning_with_id ("Octave:neg-dim-as-zero",
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1332 "%s: converting negative dimension to zero", warnfor);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1333
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1334 nr = (nr < 0) ? 0 : nr;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1335 nc = (nc < 0) ? 0 : nc;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1336 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1337 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1338
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1339 void check_dimensions (dim_vector& dim, const char *warnfor)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1340 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1341 bool neg = false;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1342
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1343 for (int i = 0; i < dim.ndims (); i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1344 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1345 if (dim(i) < 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1346 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1347 dim(i) = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1348 neg = true;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1349 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1350 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1351
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1352 if (neg)
5781 faafc2d98b8d [project @ 2006-05-02 19:40:19 by jwe] jwe parents: 5775 diff changeset	1353 warning_with_id ("Octave:neg-dim-as-zero",
10315 57a59eae83cc untabify src C++ source files John W. Eaton <jwe@octave.org> parents: 10257 diff changeset	1354 "%s: converting negative dimension to zero", warnfor);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1355 }
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4478 diff changeset	1356
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1357 void get_dimensions (const octave_value& a, const char *warn_for,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1358 dim_vector& dim)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1359 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1360 // We support dimensions to be specified by any vector, even if it's a
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1361 // vector of dimensions 0x1, 1x0, 1x1x0, or 1x1x6. If the vector ends
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1362 // up being empty, the final dimensions end up being 0x0.
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1363 if (! a.dims ().isvector ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1364 error ("%s (A): use %s (size (A)) instead", warn_for, warn_for);
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4478 diff changeset	1365
25927 d6581134daaa Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Rik <rik@octave.org> parents: 25781 diff changeset	1366 const Array<octave_idx_type> v = a.octave_idx_type_vector_value (true);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1367 const octave_idx_type n = v.numel ();
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4478 diff changeset	1368
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1369 dim.resize (n); // even if n < 2, resize sets it back to 2
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1370 if (n == 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1371 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1372 dim(0) = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1373 dim(1) = 0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1374 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1375 else if (n == 1)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1376 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1377 dim(0) = v(0);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1378 dim(1) = v(0);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1379 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1380 else
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1381 for (octave_idx_type i = 0; i < n; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1382 dim(i) = v(i);
21405 120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21301 diff changeset	1383
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1384 check_dimensions (dim, warn_for);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1385 }
21405 120bb822c6f4 Handle empty vectors for size of ones(), zeros(), inf(), etc... (bug #47298) Carnë Draug <carandraug@octave.org> parents: 21301 diff changeset	1386
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1387 void get_dimensions (const octave_value& a, const char *warn_for,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1388 octave_idx_type& nr, octave_idx_type& nc)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1389 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1390 if (a.is_scalar_type ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1391 {
25928 a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	1392 nr = nc = a.idx_type_value (true);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1393 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1394 else
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1395 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1396 nr = a.rows ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1397 nc = a.columns ();
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4478 diff changeset	1398
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1399 if ((nr != 1 \|\| nc != 2) && (nr != 2 \|\| nc != 1))
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1400 error ("%s (A): use %s (size (A)) instead", warn_for, warn_for);
4481 cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe] jwe parents: 4478 diff changeset	1401
25928 a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	1402 Array<octave_idx_type> v = a.octave_idx_type_vector_value (true);
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	1403 nr = v(0);
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	1404 nc = v(1);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1405 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1406
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1407 check_dimensions (nr, nc, warn_for);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1408 }
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3350 diff changeset	1409
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1410 void get_dimensions (const octave_value& a, const octave_value& b,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1411 const char *warn_for, octave_idx_type& nr,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1412 octave_idx_type& nc)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1413 {
25928 a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	1414 nr = (a.isempty () ? 0 : a.idx_type_value (true));
a533a7c4d2cc Emit an error when utility matrices (zeros, ones, rand, etc.) are given a fractional dimension in a dimension vector (bug #54781). Kai T. Ohlhus <k.ohlhus@gmail.com> parents: 25927 diff changeset	1415 nc = (b.isempty () ? 0 : b.idx_type_value (true));
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3350 diff changeset	1416
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1417 check_dimensions (nr, nc, warn_for);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1418 }
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3350 diff changeset	1419
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1420 octave_idx_type dims_to_numel (const dim_vector& dims,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1421 const octave_value_list& idx_arg)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1422 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1423 octave_idx_type retval;
3354 87721841efd7 [project @ 1999-11-17 19:06:11 by jwe] jwe parents: 3350 diff changeset	1424
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1425 octave_idx_type len = idx_arg.length ();
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9487 diff changeset	1426
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1427 if (len == 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1428 retval = dims.numel ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1429 else
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1430 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1431 const dim_vector dv = dims.redim (len);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1432 retval = 1;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1433 for (octave_idx_type i = 0; i < len; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1434 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1435 octave_value idxi = idx_arg(i);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1436 if (idxi.is_magic_colon ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1437 retval *= dv(i);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1438 else if (idxi.isnumeric ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1439 retval *= idxi.numel ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1440 else
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1441 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1442 try
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1443 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1444 idx_vector jdx = idxi.index_vector ();
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1445
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1446 retval *= jdx.length (dv(i));
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1447 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1448 catch (const index_exception& e)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1449 {
28012 9a965fec21c1 refactor index_exception classes to accommodate std::exception::what method John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	1450 error ("dims_to_numel: invalid index %s", e.what ());
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1451 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1452 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1453 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1454 }
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	1455
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1456 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1457 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1458
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1459 Matrix identity_matrix (octave_idx_type nr, octave_idx_type nc)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1460 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1461 Matrix m (nr, nc, 0.0);
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9487 diff changeset	1462
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1463 if (nr > 0 && nc > 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1464 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1465 octave_idx_type n = std::min (nr, nc);
9705 5acd99c3e794 avoid recursive overloaded calls in builtin numel Jaroslav Hajek <highegg@gmail.com> parents: 9487 diff changeset	1466
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1467 for (octave_idx_type i = 0; i < n; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1468 m (i, i) = 1.0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1469 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1470
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1471 return m;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1472 }
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 4457 diff changeset	1473
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1474 FloatMatrix float_identity_matrix (octave_idx_type nr, octave_idx_type nc)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1475 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1476 FloatMatrix m (nr, nc, 0.0);
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 4457 diff changeset	1477
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1478 if (nr > 0 && nc > 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1479 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1480 octave_idx_type n = std::min (nr, nc);
4478 7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe] jwe parents: 4457 diff changeset	1481
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1482 for (octave_idx_type i = 0; i < n; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1483 m (i, i) = 1.0;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1484 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7481 diff changeset	1485
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1486 return m;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1487 }
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7481 diff changeset	1488
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1489 size_t format (std::ostream& os, const char *fmt, ...)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1490 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1491 size_t retval;
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7481 diff changeset	1492
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1493 va_list args;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1494 va_start (args, fmt);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1495
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1496 retval = vformat (os, fmt, args);
7789 82be108cc558 First attempt at single precision tyeps David Bateman <dbateman@free.fr> parents: 7481 diff changeset	1497
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1498 va_end (args);
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1499
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1500 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1501 }
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1502
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1503 size_t vformat (std::ostream& os, const char *fmt, va_list args)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1504 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1505 std::string s = vasprintf (fmt, args);
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1506
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1507 os << s;
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1508
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1509 return s.length ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1510 }
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1511
27279 1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1512 size_t format (std::ostream& os, const std::string& enc, const char *fmt, ...)
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1513 {
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1514 size_t retval;
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1515
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1516 va_list args;
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1517 va_start (args, fmt);
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1518
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1519 retval = vformat (os, enc, fmt, args);
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1520
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1521 va_end (args);
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1522
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1523 return retval;
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1524 }
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1525
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1526 size_t vformat (std::ostream& os, const std::string& enc, const char *fmt,
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1527 va_list args)
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1528 {
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1529 std::string s = vasprintf (fmt, args);
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1530
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1531 if (enc.compare ("utf-8"))
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1532 os << string::u8_to_encoding ("printf", s, enc);
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1533 else
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1534 os << s;
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1535
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1536 return s.length ();
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1537 }
1c8b20731af4 Convert encoding just before writing to stream (bug #55452). Markus Mützel <markus.muetzel@gmx.de> parents: 27277 diff changeset	1538
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1539 std::string vasprintf (const char *fmt, va_list args)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1540 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1541 std::string retval;
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1542
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1543 char *result;
4135 e865976c2084 [project @ 2002-10-30 01:32:43 by jwe] jwe parents: 4124 diff changeset	1544
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1545 int status = octave_vasprintf_wrapper (&result, fmt, args);
13991 051a8f94b6f8 avoid memory issue with octave_vsnprintf John W. Eaton <jwe@octave.org> parents: 13932 diff changeset	1546
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1547 if (status >= 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1548 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1549 retval = result;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1550 ::free (result);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1551 }
4302 ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe] jwe parents: 4264 diff changeset	1552
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1553 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1554 }
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1555
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1556 std::string asprintf (const char *fmt, ...)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1557 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1558 std::string retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1559
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1560 va_list args;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1561 va_start (args, fmt);
3620 0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe] jwe parents: 3566 diff changeset	1562
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1563 retval = vasprintf (fmt, args);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1564
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1565 va_end (args);
4302 ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe] jwe parents: 4264 diff changeset	1566
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1567 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1568 }
4302 ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe] jwe parents: 4264 diff changeset	1569
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1570 // FIXME: sleep is complicated because we want it to be interruptible.
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1571 // With the way this program handles signals, the sleep system call
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1572 // won't respond to SIGINT. Maybe there is a better way than
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1573 // breaking this up into multiple shorter intervals?
4302 ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe] jwe parents: 4264 diff changeset	1574
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1575 void sleep (double seconds, bool do_graphics_events)
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1576 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1577 if (seconds <= 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1578 return;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1579
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1580 // Allow free access to graphics resources while the interpreter thread
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1581 // is asleep
27335 50216d7a2f6b eliminate static wrapper functions in gh_manager class John W. Eaton <jwe@octave.org> parents: 27279 diff changeset	1582
50216d7a2f6b eliminate static wrapper functions in gh_manager class John W. Eaton <jwe@octave.org> parents: 27279 diff changeset	1583 gh_manager& gh_mgr = __get_gh_manager__ ("sleep");
50216d7a2f6b eliminate static wrapper functions in gh_manager class John W. Eaton <jwe@octave.org> parents: 27279 diff changeset	1584
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1585 if (do_graphics_events)
27335 50216d7a2f6b eliminate static wrapper functions in gh_manager class John W. Eaton <jwe@octave.org> parents: 27279 diff changeset	1586 gh_mgr.unlock ();
26617 98afb8bbd1f6 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	1587
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1588 if (math::isinf (seconds))
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1589 {
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1590 // Wait for kbhit
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1591 int c = -1;
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1592 flush_stdout ();
26617 98afb8bbd1f6 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	1593
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1594 struct timespec one_tenth = { 0, 100000000 };
26617 98afb8bbd1f6 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	1595
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1596 while (c < 0)
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1597 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1598 octave_nanosleep_wrapper (&one_tenth, nullptr);
24604 6b3c78f84d3b allow octave_sleep to be interruptible (bug #52876) John W. Eaton <jwe@octave.org> parents: 24534 diff changeset	1599
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1600 octave_quit ();
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1601
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1602 if (do_graphics_events)
27335 50216d7a2f6b eliminate static wrapper functions in gh_manager class John W. Eaton <jwe@octave.org> parents: 27279 diff changeset	1603 gh_mgr.process_events ();
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1604
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1605 c = kbhit (false);
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1606 }
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1607 }
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1608 else
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1609 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1610 sys::time now;
27094 f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1611 double end_time = now.double_value () + seconds;
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1612 double remaining_time = seconds;
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1613
27094 f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1614 // Split pause into 100 ms time steps to allow the execution of
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1615 // graphics events and interrupts.
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1616 struct timespec nano_laps = { 0, 100000000 };
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1617
27094 f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1618 while (remaining_time > 0.1)
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1619 {
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1620 octave_quit ();
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1621
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1622 if (do_graphics_events)
27094 f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1623 {
27335 50216d7a2f6b eliminate static wrapper functions in gh_manager class John W. Eaton <jwe@octave.org> parents: 27279 diff changeset	1624 gh_mgr.process_events ();
27094 f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1625
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1626 now.stamp ();
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1627 remaining_time = end_time - now.double_value ();
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1628
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1629 if (remaining_time < 0.1)
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1630 break;
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1631 }
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1632
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1633 octave_nanosleep_wrapper (&nano_laps, nullptr);
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1634
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1635 now.stamp ();
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1636 remaining_time = end_time - now.double_value ();
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1637 }
f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1638
27094 f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1639 if (remaining_time > 0.0)
25961 f7b205562f1d Allow graphics events to be processed while pause is active (bug #53729) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 25928 diff changeset	1640 {
27094 f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1641 nano_laps = { 0, static_cast<int> (remaining_time * 1e9) };
f16471efcdf4 Fix Fpause timing accuracy when graphics events are processed (bug #56336) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 26617 diff changeset	1642 octave_nanosleep_wrapper (&nano_laps, nullptr);
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1643 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1644 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1645 }
4086 ddc722b38e87 [project @ 2002-10-03 19:08:45 by jwe] jwe parents: 4064 diff changeset	1646 }
ddc722b38e87 [project @ 2002-10-03 19:08:45 by jwe] jwe parents: 4064 diff changeset	1647
27474 3fec8e9fa2aa make recover_from_exception a member function John W. Eaton <jwe@octave.org> parents: 27471 diff changeset	1648 DEFMETHOD (isindex, interp, args, ,
3fec8e9fa2aa make recover_from_exception a member function John W. Eaton <jwe@octave.org> parents: 27471 diff changeset	1649 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1650 @deftypefn {} {} isindex (@var{ind})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1651 @deftypefnx {} {} isindex (@var{ind}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1652 Return true if @var{ind} is a valid index.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1653
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1654 Valid indices are either positive integers (although possibly of real data
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1655 type), or logical arrays.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1656
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1657 If present, @var{n} specifies the maximum extent of the dimension to be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1658 indexed. When possible the internal result is cached so that subsequent
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1659 indexing using @var{ind} will not perform the check again.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1660
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1661 Implementation Note: Strings are first converted to double values before the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1662 checks for valid indices are made. Unless a string contains the NULL
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1663 character @nospell{"@xbackslashchar{}0"}, it will always be a valid index.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1664 @end deftypefn */)
9487 2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1665 {
2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1666 int nargin = args.length ();
20800 fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1667
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1668 if (nargin < 1 \|\| nargin > 2)
fb128aafc322 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	1669 print_usage ();
9487 2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1670
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1671 octave_idx_type n = 0;
9487 2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1672 if (nargin == 2)
2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1673 n = args(1).idx_type_value ();
2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1674
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1675 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1676
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1677 try
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1678 {
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1679 idx_vector idx = args(0).index_vector (true);
18130 e473c4853afc enable non-integer ranges as indices by default and deprecate preference John W. Eaton <jwe@octave.org> parents: 18105 diff changeset	1680
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1681 if (nargin == 2)
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1682 retval = idx.extent (n) <= n;
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1683 else
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1684 retval = true;
0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1685 }
22327 d0562b3159c7 move more classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22323 diff changeset	1686 catch (const octave::execution_exception&)
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1687 {
27474 3fec8e9fa2aa make recover_from_exception a member function John W. Eaton <jwe@octave.org> parents: 27471 diff changeset	1688 interp.recover_from_exception ();
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20713 diff changeset	1689
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1690 retval = false;
9487 2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1691 }
2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1692
2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1693 return retval;
2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1694 }
2894af292e69 implement isindex function Jaroslav Hajek <highegg@gmail.com> parents: 9173 diff changeset	1695
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1696 /*
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1697 %!assert (isindex ([1, 2, 3]))
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1698 %!assert (isindex (1:3))
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1699 %!assert (isindex (1:3, 2), false)
14429 eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1700 %!assert (isindex ([1, 2, -3]), false)
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1701
28888 06c8e0877864 maint: Backed out changeset 09c071328135. Rik <rik@octave.org> parents: 28887 diff changeset	1702 %!error isindex ()
19138 ebeb3defae37 codesprint: Add tests to various interpreter utility functions Mike Miller <mtmiller@ieee.org> parents: 19128 diff changeset	1703 %!error isindex (1:3, 2, 3)
13094 7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1704 */
7d4f5a033330 new tests for utils.cc John W. Eaton <jwe@octave.org> parents: 12668 diff changeset	1705
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1706 namespace octave
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1707 {
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1708 octave_value_list
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1709 do_simple_cellfun (octave_value_list (*fun) (const octave_value_list&, int),
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1710 const char *fun_name, const octave_value_list& args,
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1711 int nargout)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1712 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1713 octave_value_list new_args = args;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1714 octave_value_list retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1715 int nargin = args.length ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1716 OCTAVE_LOCAL_BUFFER (bool, iscell, nargin);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1717 OCTAVE_LOCAL_BUFFER (Cell, cells, nargin);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1718 OCTAVE_LOCAL_BUFFER (Cell, rcells, nargout);
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1719
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1720 const Cell *ccells = cells;
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1721
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1722 octave_idx_type numel = 1;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1723 dim_vector dims (1, 1);
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1724
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1725 for (int i = 0; i < nargin; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1726 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1727 octave_value arg = new_args(i);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1728 iscell[i] = arg.iscell ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1729 if (iscell[i])
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1730 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1731 cells[i] = arg.cell_value ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1732 octave_idx_type n = ccells[i].numel ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1733 if (n == 1)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1734 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1735 iscell[i] = false;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1736 new_args(i) = ccells[i](0);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1737 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1738 else if (numel == 1)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1739 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1740 numel = n;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1741 dims = ccells[i].dims ();
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1742 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1743 else if (dims != ccells[i].dims ())
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1744 error ("%s: cell arguments must have matching sizes", fun_name);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1745 }
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1746 }
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1747
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1748 for (int i = 0; i < nargout; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1749 rcells[i].clear (dims);
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1750
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1751 for (octave_idx_type j = 0; j < numel; j++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1752 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1753 for (int i = 0; i < nargin; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1754 if (iscell[i])
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1755 new_args(i) = ccells[i](j);
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1756
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1757 octave_quit ();
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1758
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1759 const octave_value_list tmp = fun (new_args, nargout);
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1760
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1761 if (tmp.length () < nargout)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1762 error ("%s: do_simple_cellfun: internal error", fun_name);
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20819 diff changeset	1763
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1764 for (int i = 0; i < nargout; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1765 rcells[i](j) = tmp(i);
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1766 }
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1767
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1768 retval.resize (nargout);
20559 0650b8431037 eliminate more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20542 diff changeset	1769
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1770 for (int i = 0; i < nargout; i++)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1771 retval(i) = rcells[i];
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1772
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1773 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1774 }
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1775
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1776 octave_value
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1777 do_simple_cellfun (octave_value_list (*fun) (const octave_value_list&, int),
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1778 const char *fun_name, const octave_value_list& args)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1779 {
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1780 octave_value retval;
20973 7af34656efed maint: utils.cc: Clean up code. Rik <rik@octave.org> parents: 20966 diff changeset	1781
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 27094 diff changeset	1782 const octave_value_list tmp = do_simple_cellfun (fun, fun_name, args, 1);
20973 7af34656efed maint: utils.cc: Clean up code. Rik <rik@octave.org> parents: 20966 diff changeset	1783
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1784 if (tmp.length () > 0)
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1785 retval = tmp(0);
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1786
25646 4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1787 return retval;
4d565baa475e move libinterp/utils functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25440 diff changeset	1788 }
10086 76df75b10c80 allow more cells in strfind/strrep + supply a general mechanism Jaroslav Hajek <highegg@gmail.com> parents: 10070 diff changeset	1789 }
17818 f1b59ef34eda attempt to avoid setting persistent state on i/o streams (bug #40396) John W. Eaton <jwe@octave.org> parents: 17787 diff changeset	1790
19128 4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1791 DEFUN (isstudent, args, ,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1792 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1793 @deftypefn {} {} isstudent ()
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1794 Return true if running in the student edition of @sc{matlab}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1795
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1796 @code{isstudent} always returns false in Octave.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1797 @seealso{false}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21942 diff changeset	1798 @end deftypefn */)
19128 4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1799 {
4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1800 if (args.length () != 0)
4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1801 print_usage ();
4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1802
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20926 diff changeset	1803 return ovl (false);
19128 4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1804 }
4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1805
4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1806 /*
19152 0f9c5a15c8fa doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19138 diff changeset	1807 %!assert (isstudent (), false)
0f9c5a15c8fa doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19138 diff changeset	1808
0f9c5a15c8fa doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19138 diff changeset	1809 %!error isstudent (1)
19128 4990d5988cf5 new function, isstudent (bug #43155) John W. Eaton <jwe@octave.org> parents: 19030 diff changeset	1810 */

Mercurial > octave

annotate libinterp/corefcn/utils.cc @ 29091:b924b916dc91