annotate src/utils.h @ 8950:d865363208d6

include <iosfwd> instead of <iostream> in header files
author John W. Eaton <jwe@octave.org>
date Tue, 10 Mar 2009 13:55:52 -0400
parents eb63fbe60fab
children 5acd99c3e794
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
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2002,
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8041
diff changeset
4 2003, 2005, 2006, 2007, 2008 John W. Eaton
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
5
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
7
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 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
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6323
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6323
diff changeset
11 option) any later version.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 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
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 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
16 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
17
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6323
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6323
diff changeset
20 <http://www.gnu.org/licenses/>.
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
8950
d865363208d6 include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
29 #include <iosfwd>
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
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
39 extern OCTINTERP_API bool valid_identifier (const char *s);
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
40 extern OCTINTERP_API bool valid_identifier (const std::string& s);
607
ae3b8b2924a0 [project @ 1994-08-13 20:11:17 by jwe]
jwe
parents: 578
diff changeset
41
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
42 extern OCTINTERP_API bool
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
43 same_file (const std::string& f, const std::string& g);
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
44
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
45 extern OCTINTERP_API int almost_match (const std::string& std,
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
46 const std::string& s,
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
47 int min_match_len = 1,
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
48 int case_sens = 1);
607
ae3b8b2924a0 [project @ 1994-08-13 20:11:17 by jwe]
jwe
parents: 578
diff changeset
49
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
50 extern OCTINTERP_API int
3072
ca9677cdb62e [project @ 1997-07-15 02:45:42 by jwe]
jwe
parents: 3040
diff changeset
51 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
52 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
53 int max_toks);
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
54
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
55 extern OCTINTERP_API int empty_arg (const char *name, octave_idx_type nr,
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
56 octave_idx_type nc);
628
aecbe369233b [project @ 1994-08-19 13:27:51 by jwe]
jwe
parents: 607
diff changeset
57
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
58 extern OCTINTERP_API std::string
4243
7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe]
jwe
parents: 4216
diff changeset
59 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
60
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
61 extern OCTINTERP_API string_vector
4243
7e4d5b5520e5 [project @ 2002-12-27 05:30:59 by jwe]
jwe
parents: 4216
diff changeset
62 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
63
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
64 extern OCTINTERP_API std::string
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
65 file_in_path (const std::string&, const std::string&);
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
66
8041
a14bdf90be55 Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents: 7789
diff changeset
67 extern OCTINTERP_API std::string contents_file_in_path (const std::string&);
a14bdf90be55 Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents: 7789
diff changeset
68
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
69 extern OCTINTERP_API std::string fcn_file_in_path (const std::string&);
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
70 extern OCTINTERP_API std::string oct_file_in_path (const std::string&);
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
71 extern OCTINTERP_API std::string mex_file_in_path (const std::string&);
2042
31f4f775b8c6 [project @ 1996-03-28 09:06:28 by jwe]
jwe
parents: 1996
diff changeset
72
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
73 extern OCTINTERP_API 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
74
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
75 extern OCTINTERP_API const char *undo_string_escape (char c);
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4086
diff changeset
76
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
77 extern OCTINTERP_API 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
78
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
79 extern OCTINTERP_API void
4513
508238e65af7 [project @ 2003-09-19 21:40:57 by jwe]
jwe
parents: 4481
diff changeset
80 check_dimensions (dim_vector& dim, const char *warnfor);
4481
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
81
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
82 extern OCTINTERP_API void
4481
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
83 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
84 dim_vector& dim);
4481
cfbaee1f562f [project @ 2003-08-06 13:56:07 by jwe]
jwe
parents: 4478
diff changeset
85
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
86 extern OCTINTERP_API void
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
87 get_dimensions (const octave_value& a, const octave_value& b,
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
88 const char *warn_for, octave_idx_type& nr,
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
89 octave_idx_type& nc);
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
90
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
91 extern OCTINTERP_API void
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
92 get_dimensions (const octave_value& a,const char *warn_for,
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
93 octave_idx_type& nr, octave_idx_type& nc);
3354
87721841efd7 [project @ 1999-11-17 19:06:11 by jwe]
jwe
parents: 3350
diff changeset
94
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
95 extern OCTINTERP_API Matrix
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
96 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
97
7789
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
98 extern OCTINTERP_API FloatMatrix
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
99 float_identity_matrix (octave_idx_type nr, octave_idx_type nc);
82be108cc558 First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
100
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
101 extern OCTINTERP_API int
3622
52594f1c37b6 [project @ 2000-03-23 06:20:06 by jwe]
jwe
parents: 3620
diff changeset
102 octave_format (std::ostream& os, const char *fmt, ...);
3620
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
103
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
104 extern OCTINTERP_API int
3622
52594f1c37b6 [project @ 2000-03-23 06:20:06 by jwe]
jwe
parents: 3620
diff changeset
105 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
106
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
107 extern OCTINTERP_API char *octave_vsnprintf (const char *fmt, va_list args);
4302
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
108
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
109 extern OCTINTERP_API char *octave_snprintf (const char *fmt, ...);
4302
ebc2d8e4968b [project @ 2003-01-22 22:02:23 by jwe]
jwe
parents: 4243
diff changeset
110
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
111 extern OCTINTERP_API void octave_sleep (double seconds);
3308
7ae1928ca623 [project @ 1999-10-21 08:57:11 by jwe]
jwe
parents: 3174
diff changeset
112
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
113 extern "C" OCTINTERP_API void octave_sleep (unsigned int seconds);
4067
e97fb79fc1d5 [project @ 2002-09-26 22:43:25 by jwe]
jwe
parents: 3623
diff changeset
114
6109
c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe]
jwe
parents: 5864
diff changeset
115 extern "C" OCTINTERP_API void octave_usleep (unsigned int useconds);
4086
ddc722b38e87 [project @ 2002-10-03 19:08:45 by jwe]
jwe
parents: 4067
diff changeset
116
6323
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
117 extern "C" OCTINTERP_API int
ea65de49e18e [project @ 2007-02-17 02:51:02 by jwe]
jwe
parents: 6111
diff changeset
118 octave_raw_vsnprintf (char *buf, size_t n, const char *fmt, va_list args);
3620
0886bbb236cb [project @ 2000-03-23 05:17:23 by jwe]
jwe
parents: 3523
diff changeset
119
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
120 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
121
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
122 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
123 ;;; Local Variables: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
124 ;;; mode: C++ ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
125 ;;; End: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
126 */