annotate src/utils.h @ 5851:acb4a1e0b311 ss-2-9-6

[project @ 2006-06-09 16:34:42 by jwe]
author jwe
date Fri, 09 Jun 2006 16:37:20 +0000
parents 1138ced03f14
children e884ab4f29ee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2440
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
4
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
6
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
10 later version.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
11
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
16
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5275
diff changeset
20 02110-1301, USA.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
21
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
22 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
23
383
0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe]
jwe
parents: 339
diff changeset
24 #if !defined (octave_utils_h)
0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe]
jwe
parents: 339
diff changeset
25 #define octave_utils_h 1
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
26
3620
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
27 #include <cstdarg>
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
28
3503
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe]
jwe
parents: 3354
diff changeset
29 #include <iostream>
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
30 #include <string>
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
31
4478
7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe]
jwe
parents: 4302
diff changeset
32 #include "dMatrix.h"
1966
4b8e9571bbdf [project @ 1996-02-17 02:52:04 by jwe]
jwe
parents: 1884
diff changeset
33 #include "lo-utils.h"
4b8e9571bbdf [project @ 1996-02-17 02:52:04 by jwe]
jwe
parents: 1884
diff changeset
34
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
35 class octave_value;
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 2042
diff changeset
36 class octave_value_list;
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
37 class string_vector;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
38
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
39 extern bool valid_identifier (const char *s);
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
40 extern bool valid_identifier (const std::string& s);
607
ae3b8b2924a0 [project @ 1994-08-13 20:11:17 by jwe]
jwe
parents: 578
diff changeset
41
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
42 extern int almost_match (const std::string& std, const std::string& s,
287
6027a905fc06 [project @ 1994-01-13 01:41:00 by jwe]
jwe
parents: 241
diff changeset
43 int min_match_len = 1, int case_sens = 1);
607
ae3b8b2924a0 [project @ 1994-08-13 20:11:17 by jwe]
jwe
parents: 578
diff changeset
44
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
45 extern int
3072
ca9677cdb62e [project @ 1997-07-15 02:45:42 by jwe]
jwe
parents: 3040
diff changeset
46 keyword_almost_match (const char * const *std, int *min_len,
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
47 const std::string& s, int min_toks_to_match,
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
48 int max_toks);
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
49
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4513
diff changeset
50 extern int empty_arg (const char *name, octave_idx_type nr, octave_idx_type nc);
628
aecbe369233b [project @ 1994-08-19 13:27:51 by jwe]
jwe
parents: 607
diff changeset
51
4216
e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe]
jwe
parents: 4153
diff changeset
52 extern std::string
4243
7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe]
jwe
parents: 4216
diff changeset
53 search_path_for_file (const std::string&, const string_vector&);
4216
e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe]
jwe
parents: 4153
diff changeset
54
e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe]
jwe
parents: 4153
diff changeset
55 extern string_vector
4243
7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe]
jwe
parents: 4216
diff changeset
56 search_path_for_all_files (const std::string&, const string_vector&);
4216
e613ffa9f0e6 [project @ 2002-12-04 17:37:09 by jwe]
jwe
parents: 4153
diff changeset
57
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
58 extern std::string file_in_path (const std::string&, const std::string&);
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
59 extern std::string fcn_file_in_path (const std::string&);
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
60 extern std::string oct_file_in_path (const std::string&);
2042
31f4f775b8c6 [project @ 1996-03-28 09:06:28 by jwe]
jwe
parents: 1996
diff changeset
61
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
62 extern std::string do_string_escapes (const std::string& s);
3103
98d862e12945 [project @ 1997-11-18 10:46:30 by jwe]
jwe
parents: 3072
diff changeset
63
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
64 extern const char *undo_string_escape (char c);
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
65
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3503
diff changeset
66 extern std::string undo_string_escapes (const std::string& s);
801
cbc37d8d0fdf [project @ 1994-10-13 17:03:23 by jwe]
jwe
parents: 707
diff changeset
67
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
68 extern void
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4481
diff changeset
69 check_dimensions (dim_vector& dim, const char *warnfor);
4481
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
70
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
71 extern void
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
72 get_dimensions (const octave_value& a, const char *warn_for,
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4481
diff changeset
73 dim_vector& dim);
4481
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
74
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
75 extern void
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
76 get_dimensions (const octave_value& a, const octave_value& b,
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4513
diff changeset
77 const char *warn_for, octave_idx_type& nr, octave_idx_type& nc);
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
78
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
79 extern void
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
80 get_dimensions (const octave_value& a,
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4513
diff changeset
81 const char *warn_for, octave_idx_type& nr, octave_idx_type& nc);
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
82
5275
23b37da9fd5b [project @ 2005-04-08 16:07:35 by jwe]
jwe
parents: 4513
diff changeset
83 extern Matrix identity_matrix (octave_idx_type nr, octave_idx_type nc);
4478
7afd4bf05aa8 [project @ 2003-07-30 19:15:31 by jwe]
jwe
parents: 4302
diff changeset
84
3620
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
85 extern int
3622
52594f1c37b6 [project @ 2000-03-23 06:20:06 by jwe]
jwe
parents: 3620
diff changeset
86 octave_format (std::ostream& os, const char *fmt, ...);
3620
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
87
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
88 extern int
3622
52594f1c37b6 [project @ 2000-03-23 06:20:06 by jwe]
jwe
parents: 3620
diff changeset
89 octave_vformat (std::ostream& os, const char *fmt, va_list args);
3620
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
90
4302
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
91 extern char *octave_vsnprintf (const char *fmt, va_list args);
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
92
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
93 extern char *octave_snprintf (const char *fmt, ...);
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
94
4086
ddc722b38e87 [project @ 2002-10-03 19:08:45 by jwe]
jwe
parents: 4067
diff changeset
95 extern void octave_sleep (double seconds);
3308
7ae1928ca623 [project @ 1999-10-21 08:57:11 by jwe]
jwe
parents: 3174
diff changeset
96
4067
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 3623
diff changeset
97 extern "C" void octave_sleep (unsigned int seconds);
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 3623
diff changeset
98
4086
ddc722b38e87 [project @ 2002-10-03 19:08:45 by jwe]
jwe
parents: 4067
diff changeset
99 extern "C" void octave_usleep (unsigned int useconds);
ddc722b38e87 [project @ 2002-10-03 19:08:45 by jwe]
jwe
parents: 4067
diff changeset
100
3350
729ad2b6a052 [project @ 1999-11-12 16:18:16 by jwe]
jwe
parents: 3308
diff changeset
101 extern "C" int octave_strcasecmp (const char *s1, const char *s2);
729ad2b6a052 [project @ 1999-11-12 16:18:16 by jwe]
jwe
parents: 3308
diff changeset
102
729ad2b6a052 [project @ 1999-11-12 16:18:16 by jwe]
jwe
parents: 3308
diff changeset
103 extern "C" int octave_strncasecmp (const char *s1, const char *s2, size_t n);
729ad2b6a052 [project @ 1999-11-12 16:18:16 by jwe]
jwe
parents: 3308
diff changeset
104
4302
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
105 extern "C" int octave_raw_vsnprintf (char *buf, size_t n, const char *fmt,
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
106 va_list args);
3620
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
107
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
108 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
109
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
110 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
111 ;;; Local Variables: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
112 ;;; mode: C++ ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
113 ;;; End: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
114 */