GNU Octave  4.2.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
gripes.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1993-2017 John W. Eaton
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
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
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
18 along with Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 // FIXME: All gripe_XXX functions deprecated in 4.2. Remove file in 4.6
24 #if ! defined (octave_gripes_h)
25 #define octave_gripes_h 1
26 
27 #include "octave-config.h"
28 
29 #include <string>
30 
31 #include "lo-array-gripes.h"
32 
33 class octave_value;
34 namespace octave
35 {
36  class execution_exception;
37 }
38 
39 ////////////////////////////////////////////////////////////////////////////////
40 // Alphabetized list of gripes.
41 ////////////////////////////////////////////////////////////////////////////////
42 
43 OCTAVE_DEPRECATED ("use 'err_2_or_3_dim_plot' instead")
44 OCTAVE_NORETURN OCTINTERP_API extern void
45 gripe_2_or_3_dim_plot (void);
46 
47 OCTAVE_DEPRECATED ("use 'err_data_conversion' instead")
48 OCTAVE_NORETURN OCTINTERP_API extern void
49 gripe_data_conversion (const char *from, const char *to);
50 
51 OCTAVE_DEPRECATED ("use 'warn_data_file_in_path' instead")
52 OCTINTERP_API extern void
53 gripe_data_file_in_path (const std::string& fcn, const std::string& file);
54 
55 OCTAVE_DEPRECATED ("use 'err_disabled_feature' or 'warn_disabled_feature' instead")
56 OCTAVE_NORETURN OCTINTERP_API extern void
57 gripe_disabled_feature (const std::string& fcn,
58  const std::string& feature,
59  const std::string& pkg="Octave");
60 
61 OCTAVE_DEPRECATED ("use 'warn_divide_by_zero' instead")
62 OCTINTERP_API extern void
63 gripe_divide_by_zero (void);
64 
65 OCTAVE_DEPRECATED ("use 'warn_empty_arg' instead")
66 OCTINTERP_API extern void
67 gripe_empty_arg (const char *name, bool is_error);
68 
69 OCTAVE_DEPRECATED ("use 'warn_implicit_conversion' instead")
70 OCTINTERP_API extern void
71 gripe_implicit_conversion (const char *id, const char *from, const char *to);
72 
73 OCTAVE_DEPRECATED ("use 'warn_implicit_conversion' instead")
74 OCTINTERP_API extern void
75 gripe_implicit_conversion (const std::string& id, const std::string& from,
76  const std::string& to);
77 
78 OCTAVE_DEPRECATED ("use 'err_indexed_cs_list' instead")
79 OCTAVE_NORETURN OCTINTERP_API extern void
80 gripe_indexed_cs_list (void);
81 
82 OCTAVE_DEPRECATED ("use 'err_invalid_conversion' instead")
83 OCTAVE_NORETURN OCTINTERP_API extern void
84 gripe_invalid_conversion (const std::string& from, const std::string& to);
85 
86 OCTAVE_DEPRECATED ("use 'err_invalid_inquiry_subscript' instead")
87 OCTAVE_NORETURN OCTINTERP_API extern void
88 gripe_invalid_inquiry_subscript (void);
89 
90 OCTAVE_DEPRECATED ("use 'warn_invalid_value_specified' instead")
91 OCTINTERP_API extern void
92 gripe_invalid_value_specified (const char *name);
93 
94 OCTAVE_DEPRECATED ("use 'warn_logical_conversion' instead")
95 OCTINTERP_API extern void
96 gripe_logical_conversion (void);
97 
98 OCTAVE_DEPRECATED ("use 'err_nonbraced_cs_list_assignment' instead")
99 OCTAVE_NORETURN OCTINTERP_API extern void
100 gripe_nonbraced_cs_list_assignment (void);
101 
102 OCTAVE_DEPRECATED ("use 'err_nonconformant' instead")
103 OCTAVE_NORETURN OCTINTERP_API extern void
104 gripe_nonconformant (void);
105 
106 OCTAVE_DEPRECATED ("use 'err_nonconformant' instead")
107 OCTAVE_NORETURN OCTINTERP_API extern void
108 gripe_nonconformant (octave_idx_type r1, octave_idx_type c1,
109  octave_idx_type r2, octave_idx_type c2);
110 
111 OCTAVE_DEPRECATED ("use 'err_not_implemented' instead")
112 OCTAVE_NORETURN OCTINTERP_API extern void
113 gripe_not_implemented (const char *);
114 
115 // FIXME: Deprecated in 4.2, remove in 4.6
116 OCTAVE_DEPRECATED ("use 'err_disabled_feature' or 'warn_disabled_feature' instead")
117 OCTAVE_NORETURN OCTINTERP_API extern void
118 gripe_not_supported (const char *);
119 
120 OCTAVE_DEPRECATED ("use 'err_range_invalid' instead")
121 OCTAVE_NORETURN OCTINTERP_API extern void
122 gripe_range_invalid (void);
123 
124 OCTAVE_DEPRECATED ("use 'err_square_matrix_required' instead")
125 OCTAVE_NORETURN OCTINTERP_API extern void
126 gripe_square_matrix_required (const char *name);
127 
128 OCTAVE_DEPRECATED ("use 'err_string_invalid' instead")
129 OCTAVE_NORETURN OCTINTERP_API extern void
130 gripe_string_invalid (void);
131 
132 OCTAVE_DEPRECATED ("use 'err_unrecognized_data_fmt' instead")
133 OCTAVE_NORETURN OCTINTERP_API extern void
134 gripe_unrecognized_data_fmt (const char *warn_for);
135 
136 OCTAVE_DEPRECATED ("use 'err_unrecognized_float_fmt' instead")
137 OCTAVE_NORETURN OCTINTERP_API extern void
138 gripe_unrecognized_float_fmt (void);
139 
140 OCTAVE_DEPRECATED ("use 'err_user_returned_invalid' instead")
141 OCTAVE_NORETURN OCTINTERP_API extern void
142 gripe_user_returned_invalid (const char *name);
143 
144 OCTAVE_DEPRECATED ("use 'err_user_supplied_eval' instead")
145 OCTAVE_NORETURN OCTINTERP_API extern void
146 gripe_user_supplied_eval (const char *name);
147 
148 OCTAVE_DEPRECATED ("use 'err_user_supplied_eval' instead")
149 OCTAVE_NORETURN OCTINTERP_API extern void
150 gripe_user_supplied_eval (octave::execution_exception& e, const char *name);
151 
152 OCTAVE_DEPRECATED ("use 'warn_complex_cmp' instead")
153 OCTINTERP_API extern void
154 gripe_warn_complex_cmp (void);
155 
156 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
157 OCTINTERP_API extern void
158 gripe_wrong_type_arg (const char *name, const char *s,
159  bool is_error = true);
160 
161 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
162 OCTINTERP_API extern void
163 gripe_wrong_type_arg (octave::execution_exception& e,
164  const char *name, const char *s,
165  bool is_error = true);
166 
167 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
168 OCTINTERP_API extern void
169 gripe_wrong_type_arg (const char *name, const std::string& s,
170  bool is_error = true);
171 
172 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
173 OCTINTERP_API extern void
174 gripe_wrong_type_arg (octave::execution_exception& e,
175  const char *name, const std::string& s,
176  bool is_error = true);
177 
178 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' or 'warn_wrong_type_arg' instead")
179 OCTINTERP_API extern void
180 gripe_wrong_type_arg (const char *name, const octave_value& tc,
181  bool is_error = true);
182 
183 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
184 OCTINTERP_API extern void
185 gripe_wrong_type_arg (octave::execution_exception& e,
186  const char *name, const octave_value& tc,
187  bool is_error = true);
188 
189 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
190 OCTINTERP_API extern void
191 gripe_wrong_type_arg (const std::string& name, const octave_value& tc,
192  bool is_error = true);
193 
194 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
195 OCTINTERP_API extern void
196 gripe_wrong_type_arg (octave::execution_exception& e,
197  const std::string& name, const octave_value& tc,
198  bool is_error = true);
199 
200 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
201 OCTINTERP_API extern void
202 gripe_wrong_type_arg (const char *s, bool is_error = true);
203 
204 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
205 OCTINTERP_API extern void
206 gripe_wrong_type_arg (octave::execution_exception& e, const char *s,
207  bool is_error = true);
208 
209 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
210 OCTINTERP_API extern void
211 gripe_wrong_type_arg (const std::string& s, bool is_error = true);
212 
213 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
214 OCTINTERP_API extern void
215 gripe_wrong_type_arg (octave::execution_exception& e, const std::string& s,
216  bool is_error = true);
217 
218 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
219 OCTINTERP_API extern void
220 gripe_wrong_type_arg (const octave_value& tc, bool is_error = true);
221 
222 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
223 OCTINTERP_API extern void
224 gripe_wrong_type_arg (octave::execution_exception& e, const octave_value& tc,
225  bool is_error = true);
226 
227 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg_for_binary_op' instead")
228 OCTAVE_NORETURN OCTINTERP_API extern void
229 gripe_wrong_type_arg_for_binary_op (const octave_value& op);
230 
231 OCTAVE_DEPRECATED ("use 'err_wrong_type_arg_for_unary_op' instead")
232 OCTAVE_NORETURN OCTINTERP_API extern void
233 gripe_wrong_type_arg_for_unary_op (const octave_value& op);
234 
235 #endif
warn_empty_arg
void warn_empty_arg(const char *name)
Definition: errwarn.cc:326
gripe_wrong_type_arg
OCTINTERP_API void gripe_wrong_type_arg(const char *name, const char *s, bool is_error=true)
Definition: gripes.cc:229
err_data_conversion
void err_data_conversion(const char *from, const char *to)
Definition: errwarn.cc:44
octave
Octave interface to the compression and uncompression libraries.
Definition: aepbalance.cc:47
file
For example cd octave end example noindent changes the current working directory to file
Definition: dirfns.cc:120
warn_invalid_value_specified
void warn_invalid_value_specified(const char *name)
Definition: errwarn.cc:347
octave_value
Definition: ov.h:70
execution_exception
err_nonbraced_cs_list_assignment
void err_nonbraced_cs_list_assignment(void)
Definition: errwarn.cc:80
gripe_user_supplied_eval
OCTAVE_NORETURN OCTINTERP_API void gripe_user_supplied_eval(const char *name)
Definition: gripes.cc:198
gripe_invalid_value_specified
OCTINTERP_API void gripe_invalid_value_specified(const char *name)
Definition: gripes.cc:116
gripe_not_implemented
OCTAVE_NORETURN OCTINTERP_API void gripe_not_implemented(const char *)
Definition: gripes.cc:149
or
OCTAVE_EXPORT octave_value_list or class The return code an ordinary file in Octave s or(after appending @samp{.m}) a function file in Octave's ode
Definition: variables.cc:582
warn_logical_conversion
void warn_logical_conversion(void)
Definition: errwarn.cc:353
err_unrecognized_data_fmt
void err_unrecognized_data_fmt(const char *name)
Definition: errwarn.cc:124
err_unrecognized_float_fmt
static OCTAVE_NORETURN void err_unrecognized_float_fmt(void)
Definition: data-conv.cc:614
err_string_invalid
void err_string_invalid(void)
Definition: errwarn.cc:118
std
STL namespace.
err_wrong_type_arg_for_unary_op
void err_wrong_type_arg_for_unary_op(const octave_value &op)
Definition: errwarn.cc:269
err_square_matrix_required
void err_square_matrix_required(const char *fcn, const char *name)
Definition: errwarn.cc:112
s
s
Definition: file-io.cc:2682
gripe_empty_arg
OCTINTERP_API void gripe_empty_arg(const char *name, bool is_error)
Definition: gripes.cc:74
e
i e
Definition: data.cc:2724
fcn
octave_function * fcn
Definition: ov-class.cc:1743
gripe_logical_conversion
OCTINTERP_API void gripe_logical_conversion(void)
Definition: gripes.cc:122
err_indexed_cs_list
void err_indexed_cs_list(void)
Definition: errwarn.cc:62
gripe_divide_by_zero
OCTINTERP_API void gripe_divide_by_zero(void)
Definition: gripes.cc:68
name
OCTAVE_EXPORT octave_value_list any number nd example oindent prints the prompt xample Pick a any number!nd example oindent and waits for the user to enter a value The string entered by the user is evaluated as an so it may be a literal a variable name
Definition: input.cc:871
gripe_2_or_3_dim_plot
OCTAVE_NORETURN OCTINTERP_API void gripe_2_or_3_dim_plot(void)
Definition: gripes.cc:40
OCTINTERP_API
#define OCTINTERP_API
Definition: mexproto.h:69
warn_data_file_in_path
void warn_data_file_in_path(const std::string &fcn, const std::string &file)
Definition: errwarn.cc:300
gripe_unrecognized_data_fmt
OCTAVE_NORETURN OCTINTERP_API void gripe_unrecognized_data_fmt(const char *warn_for)
Definition: gripes.cc:180
gripe_square_matrix_required
OCTAVE_NORETURN OCTINTERP_API void gripe_square_matrix_required(const char *name)
Definition: gripes.cc:168
err_range_invalid
void err_range_invalid(void)
Definition: errwarn.cc:106
err_wrong_type_arg_for_binary_op
void err_wrong_type_arg_for_binary_op(const octave_value &op)
Definition: errwarn.cc:262
warn_disabled_feature
void warn_disabled_feature(const std::string &fcn, const std::string &feature, const std::string &pkg)
Definition: errwarn.cc:308
gripe_user_returned_invalid
OCTAVE_NORETURN OCTINTERP_API void gripe_user_returned_invalid(const char *name)
Definition: gripes.cc:192
octave::err_nonconformant
void err_nonconformant(const char *op, octave_idx_type op1_len, octave_idx_type op2_len)
Definition: lo-array-errwarn.cc:61
warn_divide_by_zero
void warn_divide_by_zero(void)
Definition: errwarn.cc:320
warn_complex_cmp
void warn_complex_cmp(void)
Definition: errwarn.cc:293
gripe_wrong_type_arg_for_unary_op
OCTAVE_NORETURN OCTINTERP_API void gripe_wrong_type_arg_for_unary_op(const octave_value &op)
Definition: gripes.cc:463
gripe_range_invalid
OCTAVE_NORETURN OCTINTERP_API void gripe_range_invalid(void)
Definition: gripes.cc:162
to
may be zero for pure relative error test tem the relative tolerance must be greater than or equal to
Definition: Quad-opts.cc:233
err_wrong_type_arg
void err_wrong_type_arg(const char *name, const char *s)
Definition: errwarn.cc:156
gripe_unrecognized_float_fmt
OCTAVE_NORETURN OCTINTERP_API void gripe_unrecognized_float_fmt(void)
Definition: gripes.cc:186
err_user_supplied_eval
void err_user_supplied_eval(const char *name)
Definition: errwarn.cc:142
gripe_invalid_conversion
OCTAVE_NORETURN OCTINTERP_API void gripe_invalid_conversion(const std::string &from, const std::string &to)
Definition: gripes.cc:104
err_invalid_conversion
void err_invalid_conversion(const std::string &from, const std::string &to)
Definition: errwarn.cc:68
gripe_not_supported
OCTAVE_NORETURN OCTINTERP_API void gripe_not_supported(const char *)
Definition: gripes.cc:156
gripe_nonconformant
OCTAVE_NORETURN OCTINTERP_API void gripe_nonconformant(void)
Definition: gripes.cc:135
gripe_data_conversion
OCTAVE_NORETURN OCTINTERP_API void gripe_data_conversion(const char *from, const char *to)
Definition: gripes.cc:46
warn_implicit_conversion
void warn_implicit_conversion(const char *id, const char *from, const char *to)
Definition: errwarn.cc:332
warn_wrong_type_arg
void warn_wrong_type_arg(const char *name, const octave_value &tc)
Definition: errwarn.cc:360
gripe_disabled_feature
OCTAVE_NORETURN OCTINTERP_API void gripe_disabled_feature(const std::string &fcn, const std::string &feature, const std::string &pkg="Octave")
Definition: gripes.cc:60
err_invalid_inquiry_subscript
void err_invalid_inquiry_subscript(void)
Definition: errwarn.cc:74
octave_idx_type
gripe_implicit_conversion
OCTINTERP_API void gripe_implicit_conversion(const char *id, const char *from, const char *to)
Definition: gripes.cc:83
gripe_data_file_in_path
OCTINTERP_API void gripe_data_file_in_path(const std::string &fcn, const std::string &file)
Definition: gripes.cc:52
gripe_warn_complex_cmp
OCTINTERP_API void gripe_warn_complex_cmp(void)
Definition: gripes.cc:222
gripe_string_invalid
OCTAVE_NORETURN OCTINTERP_API void gripe_string_invalid(void)
Definition: gripes.cc:174
gripe_nonbraced_cs_list_assignment
OCTAVE_NORETURN OCTINTERP_API void gripe_nonbraced_cs_list_assignment(void)
Definition: gripes.cc:129
err_not_implemented
void err_not_implemented(const char *fcn)
Definition: errwarn.cc:100
gripe_indexed_cs_list
OCTAVE_NORETURN OCTINTERP_API void gripe_indexed_cs_list(void)
Definition: gripes.cc:98
err_disabled_feature
void err_disabled_feature(const std::string &fcn, const std::string &feature, const std::string &pkg)
Definition: errwarn.cc:50
gripe_wrong_type_arg_for_binary_op
OCTAVE_NORETURN OCTINTERP_API void gripe_wrong_type_arg_for_binary_op(const octave_value &op)
Definition: gripes.cc:456
gripe_invalid_inquiry_subscript
OCTAVE_NORETURN OCTINTERP_API void gripe_invalid_inquiry_subscript(void)
Definition: gripes.cc:110
err_user_returned_invalid
void err_user_returned_invalid(const char *name)
Definition: errwarn.cc:136
Generated on Wed May 10 2017 15:42:48 for GNU Octave by   doxygen 1.8.8