view libinterp/corefcn/gripes.h @ 21134:2e5c1f766ac9

provide replacement hints for deprecated C++ functions * oct-conf-post.in.h (OCTAVE_DEPRECATED): Accept message argument. * error.h, errwarn.h, gripes.h, symtab.h, variables.h, * ov-base-sparse.h, ov-base.h, ov.h, Array.h, DiagArray2.h, * PermMatrix.h, Range.h, Sparse.h, dSparse.h, lo-array-errwarn.h, * lo-array-gripes.h, unwind-prot.h: Change all uses of OCTAVE_DEPRECATED.
author John W. Eaton <jwe@octave.org>
date Fri, 22 Jan 2016 12:15:12 -0500
parents 2e8aea678f2a
children 1473547f50f5
line wrap: on
line source

/*

Copyright (C) 1993-2015 John W. Eaton

This file is part of Octave.

Octave is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3 of the License, or (at your
option) any later version.

Octave is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with Octave; see the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

*/

// FIXME: All gripe_XXX functions deprecated in 4.2.  Remove file in 4.6
#if ! defined (octave_gripes_h)
#define octave_gripes_h 1

#include <string>

#include "lo-array-gripes.h"

class octave_value;
class octave_execution_exception;

////////////////////////////////////////////////////////////////////////////////
// Alphabetized list of gripes.
////////////////////////////////////////////////////////////////////////////////

OCTAVE_DEPRECATED ("use 'err_2_or_3_dim_plot' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_2_or_3_dim_plot (void);

OCTAVE_DEPRECATED ("use 'err_data_conversion' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_data_conversion (const char *from, const char *to);

OCTAVE_DEPRECATED ("use 'warn_data_file_in_path' instead")
OCTINTERP_API extern void
gripe_data_file_in_path (const std::string& fcn, const std::string& file);

OCTAVE_DEPRECATED ("use 'err_disabled_feature' or 'warn_disabled_feature' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_disabled_feature (const std::string& fcn,
                        const std::string& feature,
                        const std::string& pkg="Octave");

OCTAVE_DEPRECATED ("use 'warn_divide_by_zero' instead")
OCTINTERP_API extern void
gripe_divide_by_zero (void);

OCTAVE_DEPRECATED ("use 'warn_empty_arg' instead")
OCTINTERP_API extern void
gripe_empty_arg (const char *name, bool is_error);

OCTAVE_DEPRECATED ("use 'warn_implicit_conversion' instead")
OCTINTERP_API extern void
gripe_implicit_conversion (const char *id, const char *from, const char *to);

OCTAVE_DEPRECATED ("use 'warn_implicit_conversion' instead")
OCTINTERP_API extern void
gripe_implicit_conversion (const std::string& id, const std::string& from,
                           const std::string& to);

OCTAVE_DEPRECATED ("use 'err_indexed_cs_list' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_indexed_cs_list (void);

OCTAVE_DEPRECATED ("use 'err_invalid_conversion' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_invalid_conversion (const std::string& from, const std::string& to);

OCTAVE_DEPRECATED ("use 'err_invalid_inquiry_subscript' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_invalid_inquiry_subscript (void);

OCTAVE_DEPRECATED ("use 'warn_invalid_value_specified' instead")
OCTINTERP_API extern void
gripe_invalid_value_specified (const char *name);

OCTAVE_DEPRECATED ("use 'warn_logical_conversion' instead")
OCTINTERP_API extern void
gripe_logical_conversion (void);

OCTAVE_DEPRECATED ("use 'err_nonbraced_cs_list_assignment' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_nonbraced_cs_list_assignment (void);

OCTAVE_DEPRECATED ("use 'err_nonconformant' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_nonconformant (void);

OCTAVE_DEPRECATED ("use 'err_nonconformant' instead")
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_DEPRECATED ("use 'err_not_implemented' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_not_implemented (const char *);

// FIXME: Deprecated in 4.2, remove in 4.6
OCTAVE_DEPRECATED ("use 'err_disabled_feature' or 'warn_disabled_feature' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_not_supported (const char *);

OCTAVE_DEPRECATED ("use 'err_range_invalid' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_range_invalid (void);

OCTAVE_DEPRECATED ("use 'err_square_matrix_required' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_square_matrix_required (const char *name);

OCTAVE_DEPRECATED ("use 'err_string_invalid' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_string_invalid (void);

OCTAVE_DEPRECATED ("use 'err_unrecognized_data_fmt' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_unrecognized_data_fmt (const char *warn_for);

OCTAVE_DEPRECATED ("use 'err_unrecognized_float_fmt' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_unrecognized_float_fmt (void);

OCTAVE_DEPRECATED ("use 'err_user_returned_invalid' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_user_returned_invalid (const char *name);

OCTAVE_DEPRECATED ("use 'err_user_supplied_eval' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_user_supplied_eval (const char *name);

OCTAVE_DEPRECATED ("use 'err_user_supplied_eval' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_user_supplied_eval (octave_execution_exception& e, const char *name);

OCTAVE_DEPRECATED ("use 'warn_complex_cmp' instead")
OCTINTERP_API extern void
gripe_warn_complex_cmp (void);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (const char *name, const char *s,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (octave_execution_exception& e,
                      const char *name, const char *s,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (const char *name, const std::string& s,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (octave_execution_exception& e,
                      const char *name, const std::string& s,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' or 'warn_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (const char *name, const octave_value& tc,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (octave_execution_exception& e,
                      const char *name, const octave_value& tc,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (const std::string& name, const octave_value& tc,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (octave_execution_exception& e,
                      const std::string& name, const octave_value& tc,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (const char *s, bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (octave_execution_exception& e, const char *s,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (const std::string& s, bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (octave_execution_exception& e, const std::string& s,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (const octave_value& tc, bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg' instead")
OCTINTERP_API extern void
gripe_wrong_type_arg (octave_execution_exception& e, const octave_value& tc,
                      bool is_error = true);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg_for_binary_op' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_wrong_type_arg_for_binary_op (const octave_value& op);

OCTAVE_DEPRECATED ("use 'err_wrong_type_arg_for_unary_op' instead")
OCTAVE_NORETURN OCTINTERP_API extern void
gripe_wrong_type_arg_for_unary_op (const octave_value& op);

#endif