Mercurial > octave
annotate libinterp/corefcn/utils.h @ 21526:b76d1de20f9a
Deprecate unused C++ functions oct_file_in_path, mex_file_in_path.
* utils.cc: Add note that functions were deprecated in 4.2, should be removed
in 4.6.
* utils.h (oct_file_in_path, mex_file_in_path): Add OCTAVE_DEPRECATED macro,
along with a string suggesting a replacement function, to the function
declaration.
| author | Rik <rik@octave.org> |
|---|---|
| date | Tue, 22 Mar 2016 14:36:15 -0700 |
| parents | 1473547f50f5 |
| children | bac0d6f07a3e |
| rev | line source |
|---|---|
| 1 | 1 /* |
| 2 | |
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19030
diff
changeset
|
3 Copyright (C) 1993-2015 John W. Eaton |
| 1 | 4 |
| 5 This file is part of Octave. | |
| 6 | |
| 7 Octave is free software; you can redistribute it and/or modify it | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 1 | 11 |
| 12 Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
| 7016 | 18 along with Octave; see the file COPYING. If not, see |
| 19 <http://www.gnu.org/licenses/>. | |
| 1 | 20 |
| 21 */ | |
| 22 | |
|
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 #if ! defined (octave_utils_h) |
| 383 | 24 #define octave_utils_h 1 |
| 1 | 25 |
|
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20925
diff
changeset
|
26 #include "octave-config.h" |
|
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
20925
diff
changeset
|
27 |
| 3620 | 28 #include <cstdarg> |
| 29 | |
|
8950
d865363208d6
include <iosfwd> instead of <iostream> in header files
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
30 #include <iosfwd> |
| 1755 | 31 #include <string> |
|
10033
f349847c4541
optimize cellfun (@subsref, args, {subs}, uniformoutput, true) case
Jaroslav Hajek <highegg@gmail.com>
parents:
9705
diff
changeset
|
32 #include <list> |
| 1755 | 33 |
| 4478 | 34 #include "dMatrix.h" |
| 1966 | 35 #include "lo-utils.h" |
| 36 | |
| 3354 | 37 class octave_value; |
| 2086 | 38 class octave_value_list; |
| 1755 | 39 class string_vector; |
| 1 | 40 |
| 6109 | 41 extern OCTINTERP_API bool valid_identifier (const char *s); |
| 42 extern OCTINTERP_API bool valid_identifier (const std::string& s); | |
| 607 | 43 |
| 6323 | 44 extern OCTINTERP_API bool |
| 45 same_file (const std::string& f, const std::string& g); | |
| 46 | |
| 47 extern OCTINTERP_API int almost_match (const std::string& std, | |
| 10313 | 48 const std::string& s, |
| 49 int min_match_len = 1, | |
| 50 int case_sens = 1); | |
| 607 | 51 |
| 6109 | 52 extern OCTINTERP_API int |
| 3072 | 53 keyword_almost_match (const char * const *std, int *min_len, |
| 10313 | 54 const std::string& s, int min_toks_to_match, |
| 55 int max_toks); | |
| 1755 | 56 |
| 6323 | 57 extern OCTINTERP_API int empty_arg (const char *name, octave_idx_type nr, |
| 10313 | 58 octave_idx_type nc); |
| 628 | 59 |
| 6109 | 60 extern OCTINTERP_API std::string |
| 4243 | 61 search_path_for_file (const std::string&, const string_vector&); |
| 4216 | 62 |
| 6109 | 63 extern OCTINTERP_API string_vector |
| 4243 | 64 search_path_for_all_files (const std::string&, const string_vector&); |
| 4216 | 65 |
| 6323 | 66 extern OCTINTERP_API std::string |
| 67 file_in_path (const std::string&, const std::string&); | |
| 68 | |
|
19030
9ef10e6a5987
make "file found in path" warnings consistent
John W. Eaton <jwe@octave.org>
parents:
17818
diff
changeset
|
69 extern OCTINTERP_API std::string |
|
9ef10e6a5987
make "file found in path" warnings consistent
John W. Eaton <jwe@octave.org>
parents:
17818
diff
changeset
|
70 find_data_file_in_load_path (const std::string& fcn, |
|
9ef10e6a5987
make "file found in path" warnings consistent
John W. Eaton <jwe@octave.org>
parents:
17818
diff
changeset
|
71 const std::string& file, |
|
9ef10e6a5987
make "file found in path" warnings consistent
John W. Eaton <jwe@octave.org>
parents:
17818
diff
changeset
|
72 bool require_regular_file = false); |
|
9ef10e6a5987
make "file found in path" warnings consistent
John W. Eaton <jwe@octave.org>
parents:
17818
diff
changeset
|
73 |
|
8041
a14bdf90be55
Add a search for Contents.m files to the help function
David Bateman <dbateman@free.fr>
parents:
7789
diff
changeset
|
74 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
|
75 |
| 6109 | 76 extern OCTINTERP_API std::string fcn_file_in_path (const std::string&); |
|
21526
b76d1de20f9a
Deprecate unused C++ functions oct_file_in_path, mex_file_in_path.
Rik <rik@octave.org>
parents:
21244
diff
changeset
|
77 |
|
b76d1de20f9a
Deprecate unused C++ functions oct_file_in_path, mex_file_in_path.
Rik <rik@octave.org>
parents:
21244
diff
changeset
|
78 OCTAVE_DEPRECATED ("use 'load_path::find_oct_file' instead") |
| 6109 | 79 extern OCTINTERP_API std::string oct_file_in_path (const std::string&); |
|
21526
b76d1de20f9a
Deprecate unused C++ functions oct_file_in_path, mex_file_in_path.
Rik <rik@octave.org>
parents:
21244
diff
changeset
|
80 |
|
b76d1de20f9a
Deprecate unused C++ functions oct_file_in_path, mex_file_in_path.
Rik <rik@octave.org>
parents:
21244
diff
changeset
|
81 OCTAVE_DEPRECATED ("use 'load_path::find_mex_file' instead") |
| 6109 | 82 extern OCTINTERP_API std::string mex_file_in_path (const std::string&); |
| 2042 | 83 |
| 6109 | 84 extern OCTINTERP_API std::string do_string_escapes (const std::string& s); |
| 3103 | 85 |
| 6109 | 86 extern OCTINTERP_API const char *undo_string_escape (char c); |
| 4143 | 87 |
| 6109 | 88 extern OCTINTERP_API std::string undo_string_escapes (const std::string& s); |
| 801 | 89 |
| 6109 | 90 extern OCTINTERP_API void |
| 4513 | 91 check_dimensions (dim_vector& dim, const char *warnfor); |
| 4481 | 92 |
| 6109 | 93 extern OCTINTERP_API void |
| 4481 | 94 get_dimensions (const octave_value& a, const char *warn_for, |
| 4513 | 95 dim_vector& dim); |
| 4481 | 96 |
| 6109 | 97 extern OCTINTERP_API void |
| 3354 | 98 get_dimensions (const octave_value& a, const octave_value& b, |
| 10313 | 99 const char *warn_for, octave_idx_type& nr, |
| 100 octave_idx_type& nc); | |
| 3354 | 101 |
| 6109 | 102 extern OCTINTERP_API void |
| 6323 | 103 get_dimensions (const octave_value& a,const char *warn_for, |
| 10313 | 104 octave_idx_type& nr, octave_idx_type& nc); |
| 3354 | 105 |
|
9705
5acd99c3e794
avoid recursive overloaded calls in builtin numel
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
106 extern OCTINTERP_API octave_idx_type |
|
5acd99c3e794
avoid recursive overloaded calls in builtin numel
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
107 dims_to_numel (const dim_vector& dims, const octave_value_list& idx); |
|
5acd99c3e794
avoid recursive overloaded calls in builtin numel
Jaroslav Hajek <highegg@gmail.com>
parents:
8950
diff
changeset
|
108 |
| 6323 | 109 extern OCTINTERP_API Matrix |
| 110 identity_matrix (octave_idx_type nr, octave_idx_type nc); | |
| 4478 | 111 |
|
7789
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
112 extern OCTINTERP_API FloatMatrix |
|
82be108cc558
First attempt at single precision tyeps
David Bateman <dbateman@free.fr>
parents:
7017
diff
changeset
|
113 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
|
114 |
|
13991
051a8f94b6f8
avoid memory issue with octave_vsnprintf
John W. Eaton <jwe@octave.org>
parents:
13932
diff
changeset
|
115 extern OCTINTERP_API size_t |
| 3622 | 116 octave_format (std::ostream& os, const char *fmt, ...); |
| 3620 | 117 |
|
13991
051a8f94b6f8
avoid memory issue with octave_vsnprintf
John W. Eaton <jwe@octave.org>
parents:
13932
diff
changeset
|
118 extern OCTINTERP_API size_t |
| 3622 | 119 octave_vformat (std::ostream& os, const char *fmt, va_list args); |
| 3620 | 120 |
|
14005
f8556baf1949
rename octave_vsnprintf and octave_snprintf
John W. Eaton <jwe@octave.org>
parents:
13991
diff
changeset
|
121 extern OCTINTERP_API std::string |
|
f8556baf1949
rename octave_vsnprintf and octave_snprintf
John W. Eaton <jwe@octave.org>
parents:
13991
diff
changeset
|
122 octave_vasprintf (const char *fmt, va_list args); |
| 4302 | 123 |
|
14005
f8556baf1949
rename octave_vsnprintf and octave_snprintf
John W. Eaton <jwe@octave.org>
parents:
13991
diff
changeset
|
124 extern OCTINTERP_API std::string octave_asprintf (const char *fmt, ...); |
| 4302 | 125 |
| 6109 | 126 extern OCTINTERP_API void octave_sleep (double seconds); |
| 3308 | 127 |
|
10086
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
128 extern OCTINTERP_API |
|
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
129 octave_value_list |
|
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
130 do_simple_cellfun (octave_value_list (*fun) (const octave_value_list&, int), |
|
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
131 const char *fun_name, const octave_value_list& args, |
|
10086
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
132 int nargout); |
|
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
133 |
|
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
134 extern OCTINTERP_API |
|
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
135 octave_value |
|
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
136 do_simple_cellfun (octave_value_list (*fun) (const octave_value_list&, int), |
|
76df75b10c80
allow more cells in strfind/strrep + supply a general mechanism
Jaroslav Hajek <highegg@gmail.com>
parents:
10033
diff
changeset
|
137 const char *fun_name, const octave_value_list& args); |
|
11512
e4e82740e9cd
prototype fixes for C language files
John W. Eaton <jwe@octave.org>
parents:
10313
diff
changeset
|
138 |
| 1 | 139 #endif |