Mercurial > octave

view oct-conf-post-public.in.h @ 31500:6bd338605fd3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Overhaul scanf functionality for correctness and Matlab compatibility (bug #63383, bug #62723) Return correct third output (error message) and fourth output (position) in many more cases. Functionality is still not correct in all situations and new corner cases were discovered while coding. Add BIST tests for correct behavior, some of which fail still. * oct-stream.cc (BEGIN_C_CONVERSION, BEGIN_S_CONVERSION): After reading characters, clear the failbit if the last character that was attempted to be read was EOF. This is not a true failure. * oct-stream.cc (BEGIN_CHAR_CLASS_CONVERSION): Move initialization of "width" variable to be with its definition as int. When reading characters and the read character is not in the character class, call putback(c) to place the character back into the input stream (cause of misplaced position output). After reading characters, clear the failbit if the last character that was attempted to be read was EOF. This is not a true failure. * oct-stream.cc (FINISH_CHARACTER_CONVERSION): Check for "width > 0", i.e., there were characters read, before updating outputs like conversion_count and position. * oct-stream.cc (base_stream::do_scanf): Remove test for "! eof" and just check for failbit. If failbit is set then issue a warning about pattern failing to match. * lo-utils.cc (read_fp_value): If reading has failed (failbit set) then clear eofbit which may have been set during the process. The calling routine will use seek() to restore file position to point before attempted read so EOF should no longer be set on stream. * io.tst: Add many more BIST cases.
author Rik <rik@octave.org>
date Mon, 21 Nov 2022 13:11:26 -0800
parents d5415300e53b
children dfa5d9c3ae72
line wrap: on
line source

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1993-2022 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// 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
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////

#if defined (__cplusplus)
#  include <cinttypes>
#else
#  include <inttypes.h>
#endif

#  define OCTAVE_NAMESPACE_BEGIN namespace octave {
#  define OCTAVE_NAMESPACE_END }

/* The C++ standard is evolving to allow attribute hints in a
   compiler-independent manner.  In C++ 2011 support for noreturn was
   added.  In C++ 2014 support for deprecated was added.  The Octave
   code base has been future-proofed by using macros of the form
   OCTAVE_ATTRIBUTE_NAME in place of vendor specific attribute
   mechanisms.  As compilers evolve, the underlying implementation can
   be changed with the macro definitions below.  FIXME: Update macros
   to use C++ standard attribute syntax when Octave moves to C++ 2014
   standard.  */

#if defined (__GNUC__)
   /* The following attributes are used with gcc and clang compilers.  */
#  if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
#    define OCTAVE_DEPRECATED(ver, msg) __attribute__ ((__deprecated__ ("[" #ver "]: " msg)))
#  else
#    define OCTAVE_DEPRECATED(ver, msg) __attribute__ ((__deprecated__))
#  endif
#  define HAVE_OCTAVE_DEPRECATED_ATTR 1

#  define OCTAVE_NORETURN __attribute__ ((__noreturn__))
#  define HAVE_OCTAVE_NORETURN_ATTR 1

#  define OCTAVE_UNUSED __attribute__ ((__unused__))
#  define HAVE_OCTAVE_UNUSED_ATTR 1
#else
#  define OCTAVE_DEPRECATED(ver, msg)
#  define OCTAVE_NORETURN
#  define OCTAVE_UNUSED

/* #  undef HAVE_OCTAVE_DEPRECATED_ATTR */
/* #  undef HAVE_OCTAVE_NORETURN_ATTR */
/* #  undef HAVE_OCTAVE_UNUSED_ATTR */
#endif

#if defined (__MINGW32__)
  /* MinGW requires special handling due to different format specifiers
   * on different platforms.  The macro __MINGW_PRINTF_FORMAT maps to
   * either gnu_printf or ms_printf depending on where we are compiling
   * to avoid warnings on format specifiers that are legal.
   * See: https://bugzilla.mozilla.org/show_bug.cgi?id=1331349  */
#  if defined (__cplusplus)
#    include <cstdio>
#  else
#    include <stdio.h>
#  endif

#  define OCTAVE_FORMAT_PRINTF(stringIndex, firstToCheck) \
     __attribute__ ((format (__MINGW_PRINTF_FORMAT, stringIndex, firstToCheck)))

#  define HAVE_OCTAVE_FORMAT_PRINTF_ATTR 1
#elif defined (__GNUC__)
   /* The following attributes are used with gcc and clang compilers.  */
#  define OCTAVE_FORMAT_PRINTF(index, first) \
     __attribute__ ((__format__(printf, index, first)))

#  define HAVE_OCTAVE_FORMAT_PRINTF_ATTR 1
#else
#  define OCTAVE_FORMAT_PRINTF(index, first)

/* #  undef HAVE_OCTAVE_FORMAT_PRINTF_ATTR */
#endif

#if ! defined (OCTAVE_FALLTHROUGH)
#  if defined (__cplusplus) && __cplusplus > 201402L
#    define OCTAVE_FALLTHROUGH [[fallthrough]]
#  elif defined (__GNUC__) && __GNUC__ < 7
#    define OCTAVE_FALLTHROUGH ((void) 0)
#  else
#    define OCTAVE_FALLTHROUGH __attribute__ ((__fallthrough__))
#  endif
#endif

#if defined (__cplusplus)
template <typename T>
static inline void
octave_unused_parameter (const T&)
{ }
#else
#  define octave_unused_parameter(param) (void) param;
#endif

#if defined (OCTAVE_ENABLE_LIB_VISIBILITY_FLAGS)
#  if defined (_WIN32) || defined (__CYGWIN__)
#    if defined (__GNUC__)
       /* GCC */
#      define OCTAVE_EXPORT __attribute__ ((dllexport))
#      define OCTAVE_IMPORT __attribute__ ((dllimport))
#    else
       /* MSVC */
#      define OCTAVE_EXPORT __declspec(dllexport)
#      define OCTAVE_IMPORT __declspec(dllimport)
#    endif
#  else
     /* All other platforms. */
#    define OCTAVE_EXPORT __attribute__ ((visibility ("default")))
#    define OCTAVE_IMPORT
#  endif
#else
#  define OCTAVE_EXPORT
#  define OCTAVE_IMPORT
#endif

/* API macros for liboctave */
#if defined (OCTAVE_DLL)
#  define OCTAVE_API OCTAVE_EXPORT
#  define OCTAVE_EXCEPTION_API OCTAVE_EXPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTAVE_TEMPLATE_API
#    if defined(__MINGW32__)
#      define OCTAVE_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#      define OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API
#    else
#      define OCTAVE_EXTERN_TEMPLATE_API
#      define OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API OCTAVE_EXPORT
#    endif
#    define OCTAVE_OVERRIDABLE_FUNC_API OCTAVE_EXPORT
#  else
#    define OCTAVE_TEMPLATE_API OCTAVE_EXPORT
#    define OCTAVE_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#    define OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API
#    define OCTAVE_OVERRIDABLE_FUNC_API
#  endif
#else
#  define OCTAVE_API OCTAVE_IMPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTAVE_EXCEPTION_API OCTAVE_IMPORT
#  else
#    define OCTAVE_EXCEPTION_API OCTAVE_EXPORT
#  endif
#  define OCTAVE_TEMPLATE_API
#  define OCTAVE_EXTERN_TEMPLATE_API OCTAVE_IMPORT
#  define OCTAVE_CLASS_TEMPLATE_INSTANTIATION_API
#  define OCTAVE_OVERRIDABLE_FUNC_API
#endif

/* API macros for liboctinterp */
#if defined (OCTINTERP_DLL)
#  define OCTINTERP_API OCTAVE_EXPORT
#  define OCTINTERP_EXCEPTION_API OCTAVE_EXPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTINTERP_TEMPLATE_API
#    if defined(__MINGW32__)
#      define OCTINTERP_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#      define OCTINTERP_CLASS_TEMPLATE_INSTANTIATION_API
#    else
#      define OCTINTERP_EXTERN_TEMPLATE_API
#      define OCTINTERP_CLASS_TEMPLATE_INSTANTIATION_API OCTAVE_EXPORT
#    endif
#    define OCTINTERP_OVERRIDABLE_FUNC_API OCTAVE_EXPORT
#  else
#    define OCTINTERP_TEMPLATE_API OCTAVE_EXPORT
#    define OCTINTERP_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#    define OCTINTERP_CLASS_TEMPLATE_INSTANTIATION_API
#    define OCTINTERP_OVERRIDABLE_FUNC_API
#  endif
#else
#  define OCTINTERP_API OCTAVE_IMPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTINTERP_EXCEPTION_API OCTAVE_IMPORT
#  else
#    define OCTINTERP_EXCEPTION_API OCTAVE_EXPORT
#  endif
#  define OCTINTERP_TEMPLATE_API
#  define OCTINTERP_EXTERN_TEMPLATE_API OCTAVE_IMPORT
#  define OCTINTERP_CLASS_TEMPLATE_INSTANTIATION_API
#  define OCTINTERP_OVERRIDABLE_FUNC_API
#endif

/* API macros for the Array class in liboctave and liboctinterp */
#if (defined (OCTAVE_DLL) || defined (OCTINTERP_DLL))
#  define OCTARRAY_API OCTAVE_EXPORT
#  define OCTARRAY_EXCEPTION_API OCTAVE_EXPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTARRAY_TEMPLATE_API
#    if defined(__MINGW32__)
#      define OCTARRAY_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#      define OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API
#    else
#      define OCTARRAY_EXTERN_TEMPLATE_API
#      define OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API OCTAVE_EXPORT
#    endif
#    define OCTARRAY_OVERRIDABLE_FUNC_API OCTAVE_EXPORT
#  else
#    define OCTARRAY_TEMPLATE_API OCTAVE_EXPORT
#    define OCTARRAY_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#    define OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API
#    define OCTARRAY_OVERRIDABLE_FUNC_API
#  endif
#else
#  define OCTARRAY_API OCTAVE_IMPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTARRAY_EXCEPTION_API OCTAVE_IMPORT
#  else
#    define OCTARRAY_EXCEPTION_API OCTAVE_EXPORT
#  endif
#  define OCTARRAY_TEMPLATE_API
#  define OCTARRAY_EXTERN_TEMPLATE_API OCTAVE_IMPORT
#  define OCTARRAY_CLASS_TEMPLATE_INSTANTIATION_API
#  define OCTARRAY_OVERRIDABLE_FUNC_API
#endif

/* API macros for libinterp/graphics */
#if defined (OCTGRAPHICS_DLL)
#  define OCTGRAPHICS_API OCTAVE_EXPORT
#  define OCTGRAPHICS_EXCEPTION_API OCTAVE_EXPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTGRAPHICS_TEMPLATE_API
#    if defined(__MINGW32__)
#      define OCTGRAPHICS_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#      define OCTGRAPHICS_CLASS_TEMPLATE_INSTANTIATION_API
#    else
#      define OCTGRAPHICS_EXTERN_TEMPLATE_API
#      define OCTGRAPHICS_CLASS_TEMPLATE_INSTANTIATION_API OCTAVE_EXPORT
#    endif
#    define OCTGRAPHICS_OVERRIDABLE_FUNC_API OCTAVE_EXPORT
#  else
#    define OCTGRAPHICS_TEMPLATE_API OCTAVE_EXPORT
#    define OCTGRAPHICS_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#    define OCTGRAPHICS_CLASS_TEMPLATE_INSTANTIATION_API
#    define OCTGRAPHICS_OVERRIDABLE_FUNC_API
#  endif
#else
#  define OCTGRAPHICS_API OCTAVE_IMPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTGRAPHICS_EXCEPTION_API OCTAVE_IMPORT
#  else
#    define OCTGRAPHICS_EXCEPTION_API OCTAVE_EXPORT
#  endif
#  define OCTGRAPHICS_TEMPLATE_API
#  define OCTGRAPHICS_EXTERN_TEMPLATE_API OCTAVE_IMPORT
#  define OCTGRAPHICS_CLASS_TEMPLATE_INSTANTIATION_API
#  define OCTGRAPHICS_OVERRIDABLE_FUNC_API
#endif

/* API macros for libgui */
#if defined (OCTGUI_DLL)
#  define OCTGUI_API OCTAVE_EXPORT
#  define OCTGUI_EXCEPTION_API OCTAVE_EXPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTGUI_TEMPLATE_API
#    if defined(__MINGW32__)
#      define OCTGUI_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#      define OCTGUI_CLASS_TEMPLATE_INSTANTIATION_API
#    else
#      define OCTGUI_EXTERN_TEMPLATE_API
#      define OCTGUI_CLASS_TEMPLATE_INSTANTIATION_API OCTAVE_EXPORT
#    endif
#    define OCTGUI_OVERRIDABLE_FUNC_API OCTAVE_EXPORT
#  else
#    define OCTGUI_TEMPLATE_API OCTAVE_EXPORT
#    define OCTGUI_EXTERN_TEMPLATE_API OCTAVE_EXPORT
#    define OCTGUI_CLASS_TEMPLATE_INSTANTIATION_API
#    define OCTGUI_OVERRIDABLE_FUNC_API
#  endif
#else
#  define OCTGUI_API OCTAVE_IMPORT
#  if defined (_WIN32) || defined (__CYGWIN__)
#    define OCTGUI_EXCEPTION_API OCTAVE_IMPORT
#  else
#    define OCTGUI_EXCEPTION_API OCTAVE_EXPORT
#  endif
#  define OCTGUI_TEMPLATE_API
#  define OCTGUI_EXTERN_TEMPLATE_API OCTAVE_IMPORT
#  define OCTGUI_CLASS_TEMPLATE_INSTANTIATION_API
#  define OCTGUI_OVERRIDABLE_FUNC_API
#endif

#if defined (OCTAVE_ENABLE_64)
#  define OCTAVE_IDX_TYPE_FORMAT PRId64
#else
#  define OCTAVE_IDX_TYPE_FORMAT PRId32
#endif

#if OCTAVE_SIZEOF_F77_INT_TYPE == 8
#  define OCTAVE_F77_INT_TYPE_FORMAT PRId64
#else
#  define OCTAVE_F77_INT_TYPE_FORMAT PRId32
#endif

#define OCTAVE_HAVE_F77_INT_TYPE 1

/* time type in API is always 64 bits wide */
#define OCTAVE_TIME_T int64_t

#if defined (__cplusplus) && ! defined (OCTAVE_THREAD_LOCAL)
#  define OCTAVE_THREAD_LOCAL
#endif

typedef OCTAVE_IDX_TYPE octave_idx_type;
typedef OCTAVE_F77_INT_TYPE octave_f77_int_type;

/* Backward compatibility */

#if defined (OCTAVE_ENABLE_64)
#  define USE_64_BIT_IDX_T 1
#endif

#if defined (OCTAVE_ENABLE_OPENMP)
#  define HAVE_OPENMP 1
#endif

#if defined (OCTAVE_ENABLE_FLOAT_TRUNCATE)
#  define OCTAVE_FLOAT_TRUNCATE volatile
#else
#  define OCTAVE_FLOAT_TRUNCATE
#endif