changeset 21101:2e8aea678f2a

Deprecate gripe_XXX functions. * NEWS: Announce deprecation. * gripes.h: Add OCTAVE_DEPRECATED attribute to all functions. Add FIXME note about removal in 4.6. * gripes.cc: Add FIXME note about removal in 4.6. * lo-array-gripes.h: Add OCTAVE_DEPRECATED attribute to all functions. Add FIXME note about removal in 4.6. * lo-array-gripes.cc: Add FIXME note about removal in 4.6.
author Rik <rik@octave.org>
date Mon, 18 Jan 2016 19:23:56 -0800
parents e39e05d90788
children dfcb9d74b253
files NEWS libinterp/corefcn/gripes.cc libinterp/corefcn/gripes.h liboctave/util/lo-array-gripes.cc liboctave/util/lo-array-gripes.h
diffstat 5 files changed, 111 insertions(+), 100 deletions(-) [+]
line wrap: on
line diff
--- a/NEWS	Mon Jan 18 18:28:06 2016 -0800
+++ b/NEWS	Mon Jan 18 19:23:56 2016 -0800
@@ -112,6 +112,10 @@
     with liboctave then these must be updated to throw an exception and not
     return to the calling program.
 
+ ** The system for common errors and warnings has been renamed from gripe_XXX
+    to either err_XXX if error is called or warn_XXX if warning is called.
+    The gripe_XXX functions are deprecated and will be removed in version 4.6.
+
  ** New configure option, --enable-address-sanitizer-flags, to build Octave
     with memory allocator checks (similar to those in valgrind) built in.
 
--- a/libinterp/corefcn/gripes.cc	Mon Jan 18 18:28:06 2016 -0800
+++ b/libinterp/corefcn/gripes.cc	Mon Jan 18 19:23:56 2016 -0800
@@ -20,6 +20,8 @@
 
 */
 
+// FIXME: All gripe_XXX functions deprecated in 4.2.  Remove file in 4.6
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
--- a/libinterp/corefcn/gripes.h	Mon Jan 18 18:28:06 2016 -0800
+++ b/libinterp/corefcn/gripes.h	Mon Jan 18 19:23:56 2016 -0800
@@ -20,6 +20,7 @@
 
 */
 
+// FIXME: All gripe_XXX functions deprecated in 4.2.  Remove file in 4.6
 #if ! defined (octave_gripes_h)
 #define octave_gripes_h 1
 
@@ -34,159 +35,159 @@
 // Alphabetized list of gripes.
 ////////////////////////////////////////////////////////////////////////////////
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_2_or_3_dim_plot (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_data_conversion (const char *from, const char *to);
 
-extern OCTINTERP_API void
-gripe_data_file_in_path (const std::string& fcn, const std::string& file);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_data_file_in_path (const std::string& fcn, const std::string& file);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_disabled_feature (const std::string& fcn,
                              const std::string& feature,
                              const std::string& pkg="Octave");
 
-extern OCTINTERP_API void
-gripe_divide_by_zero (void);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_divide_by_zero (void);
 
-extern OCTINTERP_API void
-gripe_empty_arg (const char *name, bool is_error);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_empty_arg (const char *name, bool is_error);
 
-extern OCTINTERP_API void
-gripe_implicit_conversion (const char *id, const char *from, const char *to);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_implicit_conversion (const char *id, const char *from, const char *to);
 
-extern OCTINTERP_API void
-gripe_implicit_conversion (const std::string& id, const std::string& from,
-                           const std::string& to);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_implicit_conversion (const std::string& id, const std::string& from,
+                                const std::string& to);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_indexed_cs_list (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_invalid_conversion (const std::string& from, const std::string& to);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_invalid_inquiry_subscript (void);
 
-extern OCTINTERP_API void
-gripe_invalid_value_specified (const char *name);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_invalid_value_specified (const char *name);
 
-extern OCTINTERP_API void
-gripe_logical_conversion (void);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_logical_conversion (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_nonbraced_cs_list_assignment (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_nonconformant (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_nonconformant (octave_idx_type r1, octave_idx_type c1,
                           octave_idx_type r2, octave_idx_type c2);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_not_implemented (const char *);
 
 // FIXME: Deprecated in 4.2, remove in 4.6
 OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_not_supported (const char *);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_range_invalid (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_square_matrix_required (const char *name);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_string_invalid (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_unrecognized_data_fmt (const char *warn_for);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_unrecognized_float_fmt (void);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_user_returned_invalid (const char *name);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_user_supplied_eval (const char *name);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_user_supplied_eval (octave_execution_exception& e, const char *name);
 
-extern OCTINTERP_API void
-gripe_warn_complex_cmp (void);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_warn_complex_cmp (void);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (const char *name, const char *s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (const char *name, const char *s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (octave_execution_exception& e,
-                      const char *name, const char *s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (octave_execution_exception& e,
+                           const char *name, const char *s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (const char *name, const std::string& s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (const char *name, const std::string& s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (octave_execution_exception& e,
-                      const char *name, const std::string& s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (octave_execution_exception& e,
+                           const char *name, const std::string& s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (const char *name, const octave_value& tc,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (const char *name, const octave_value& tc,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (octave_execution_exception& e,
-                      const char *name, const octave_value& tc,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (octave_execution_exception& e,
+                           const char *name, const octave_value& tc,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (const std::string& name, const octave_value& tc,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (const std::string& name, const octave_value& tc,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (octave_execution_exception& e,
-                      const std::string& name, const octave_value& tc,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (octave_execution_exception& e,
+                           const std::string& name, const octave_value& tc,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (const char *s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (const char *s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (octave_execution_exception& e,
-                      const char *s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (octave_execution_exception& e,
+                           const char *s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (const std::string& s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (const std::string& s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (octave_execution_exception& e,
-                      const std::string& s,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (octave_execution_exception& e,
+                           const std::string& s,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (const octave_value& tc,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (const octave_value& tc,
+                           bool is_error = true);
 
-extern OCTINTERP_API void
-gripe_wrong_type_arg (octave_execution_exception& e,
-                      const octave_value& tc,
-                      bool is_error = true);
+OCTAVE_DEPRECATED OCTINTERP_API extern
+void gripe_wrong_type_arg (octave_execution_exception& e,
+                           const octave_value& tc,
+                           bool is_error = true);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_wrong_type_arg_for_binary_op (const octave_value& op);
 
-OCTAVE_NORETURN OCTINTERP_API extern
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTINTERP_API extern
 void gripe_wrong_type_arg_for_unary_op (const octave_value& op);
 
 #endif
--- a/liboctave/util/lo-array-gripes.cc	Mon Jan 18 18:28:06 2016 -0800
+++ b/liboctave/util/lo-array-gripes.cc	Mon Jan 18 19:23:56 2016 -0800
@@ -21,6 +21,8 @@
 
 */
 
+// FIXME: All gripe_XXX functions deprecated in 4.2.  Remove file in 4.6
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
--- a/liboctave/util/lo-array-gripes.h	Mon Jan 18 18:28:06 2016 -0800
+++ b/liboctave/util/lo-array-gripes.h	Mon Jan 18 19:23:56 2016 -0800
@@ -20,6 +20,8 @@
 
 */
 
+// FIXME: All gripe_XXX functions deprecated in 4.2.  Remove file in 4.6
+
 #if ! defined (octave_lo_array_gripes_h)
 #define octave_lo_array_gripes_h 1
 
@@ -27,59 +29,59 @@
 #include "dim-vector.h"
 #include "quit.h"
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_nan_to_logical_conversion (void);
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_nan_to_character_conversion (void);
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_nonconformant (const char *op,
                      octave_idx_type op1_len,
                      octave_idx_type op2_len);
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_nonconformant (const char *op,
                      octave_idx_type op1_nr, octave_idx_type op1_nc,
                      octave_idx_type op2_nr, octave_idx_type op2_nc);
 
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_nonconformant (const char *op, const dim_vector& op1_dims,
                      const dim_vector& op2_dims);
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_index_out_of_range (int nd, int dim,
                           octave_idx_type iext, octave_idx_type ext,
                           const dim_vector& d);
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_index_out_of_range (int nd, int dim,
                           octave_idx_type iext, octave_idx_type ext);
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_del_index_out_of_range (bool is1d, octave_idx_type iext,
                               octave_idx_type ext);
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_invalid_index (double, octave_idx_type nd = 0,
                      octave_idx_type dim = 0,
                      const std::string& var = "");
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_invalid_index (octave_idx_type n, octave_idx_type nd = 0,
                      octave_idx_type dim = 0,
                      const std::string& var = "");
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_invalid_index (const std::string& idx, octave_idx_type nd = 0,
                      octave_idx_type dim = 0,
                      const std::string& var = "");
 
-OCTAVE_NORETURN OCTAVE_API extern void
+OCTAVE_DEPRECATED OCTAVE_NORETURN OCTAVE_API extern void
 gripe_invalid_resize (void);
 
-extern void OCTAVE_API
-gripe_singular_matrix (double rcond = 0.0);
+OCTAVE_DEPRECATED OCTAVE_API extern
+void gripe_singular_matrix (double rcond = 0.0);
 
 #endif