Mercurial > octave
view liboctave/version.cc @ 33365:fb44a9db1bc6
Replace `xint_value` and related functions with stricter versions (bug #65538)
The conversion function `xint_value`, `xbool_value`, and `xidx_type_value`
were being used to convert input arguments to integers, booleans, or index
values respectively, and to provide a meaningful error message if the
conversion failed. The problem, as described in bug #65538, is that this
allows user code like `all (true (3), 2.718)` to be silently converted to
`all (true (3), 2)` instead of giving an error that the dimension needs to
be an integer. The same happens with `cell (e, pi)`, which silently creates
a 2x3 cell array. In both cases, this permissive conversion is a Matlab
incompatibility.
This patch provides an analogue of `xint_value` called `yint_value` that uses a
stricter conversion to integer, and also does the same for `bool` and
`idx_type` conversions. With this patch, passing non-integer sizes now gives
an error, and passing non-boolean values to boolean arguments now give a warning.
* libinterp/octave-value/ov.h: Define new functions `strict_int_value` and
`strict_bool_value` and declare new function `strict_idx_type_value`.
Declare corresponding new wrapper functions `yint_value`, `ybool_value`,
and `yidx_type_value`.
* libinterp/octave-value/ov.cc: Define `strict_idx_type_value`.
Define `yint_value`, `ybool_value`, and `yidx_type_value`
using the existing XVALUE_EXTRACTOR macro.
* Replace the corresponding function calls in: __eigs__.cc, besselj.cc,
bitfcns.cc, data.cc, file-io.cc, interpreter.cc, jsondecode.cc, load-path.cc,
oct-stream.cc, ov-cell.cc, psi.cc, pt-eval.cc, sparse.cc, strfns.cc,
syscalls.cc, time.cc, utils.cc, variables.cc, __glpk__.cc, __ode15__.cc,
pt-eval.cc
* NEWS.10.md: Add note about the Matlab compatibility of this patch.
Incidentally, the new conversion functions allow a FIXME note inside `fcntl`
to be addressed and removed.
author | Arun Giridhar <arungiridhar@gmail.com> |
---|---|
date | Mon, 08 Apr 2024 21:43:05 -0400 |
parents | 2e484f9f1f18 |
children |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2013-2024 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 (HAVE_CONFIG_H) # include "config.h" #endif #include <string> #include "version.h" static std::string octave_warranty_statement (const std::string& extra_info = "") { return "There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or\n\ FITNESS FOR A PARTICULAR PURPOSE." + extra_info; } static std::string format_url (bool html, const std::string& url) { return html ? R"(<a href=")" + url + R"(">)" + url + "</a>" : url; } std::string octave_www_statement (bool html) { return "Home page: " + format_url (html, "https://octave.org"); } std::string octave_contrib_statement (bool html) { return "Improve Octave: " + format_url (html, "https://octave.org/get-involved"); } std::string octave_bugs_statement (bool html) { return "Support resources: " + format_url (html, "https://octave.org/support"); } std::string octave_name_version_and_copyright (bool html) { // The GNU coding standards say that on the first line printed by // --version, the version number should follow the last space on the // line. std::string br = (html ? "<br>\n" : "\n"); return "GNU Octave, version " OCTAVE_VERSION + br + OCTAVE_COPYRIGHT; } std::string octave_name_version_copyright_copying_and_warranty (bool html, const std::string& extra_info) { std::string br = (html ? "<br>\n" : "\n"); std::string sep = (html ? "\n</p>\n<p>\n" : "\n\n"); return octave_name_version_and_copyright (html) + br + "This is free software; see the source code for copying conditions." + br + octave_warranty_statement (extra_info) + sep + R"(Octave was configured for ")" + OCTAVE_CANONICAL_HOST_TYPE + R"(".)"; } std::string octave_name_version_copyright_copying_warranty_and_bugs (bool html, const std::string& extra_info) { std::string sep = (html ? "\n</p>\n<p>\n" : "\n"); std::string msg = (html ? "<p>\n" : "") + octave_name_version_copyright_copying_and_warranty (html, extra_info) + (html ? "" : "\n") + sep + octave_www_statement (html) + sep + octave_bugs_statement (html) + sep + octave_contrib_statement (html) + sep + (html ? "\n</p>" : ""); return msg; } std::string octave_startup_message (bool html) { std::string msg = octave_name_version_copyright_copying_warranty_and_bugs (html, " For details, type 'warranty'."); msg += (html ? "<p>\n" : "\n"); msg += "For changes from previous versions, type 'news'."; msg += (html ? "\n</p>" : ""); return msg; }