Mercurial > octave
view liboctave/util/lo-utils.cc @ 27918:b442ec6dda5c
use centralized file for copyright info for individual contributors
* COPYRIGHT.md: New file.
* In most other files, use "Copyright (C) YYYY-YYYY The Octave Project
Developers" instead of tracking individual names in separate source
files. The motivation is to reduce the effort required to update the
notices each year.
Until now, the Octave source files contained copyright notices that
list individual contributors. I adopted these file-scope copyright
notices because that is what everyone was doing 30 years ago in the
days before distributed version control systems. But now, with many
contributors and modern version control systems, having these
file-scope copyright notices causes trouble when we update copyright
years or refactor code.
Over time, the file-scope copyright notices may become outdated as new
contributions are made or code is moved from one file to
another. Sometimes people contribute significant patches but do not
add a line claiming copyright. Other times, people add a copyright
notice for their contribution but then a later refactoring moves part
or all of their contribution to another file and the notice is not
moved with the code. As a practical matter, moving such notices is
difficult -- determining what parts are due to a particular
contributor requires a time-consuming search through the project
history. Even managing the yearly update of copyright years is
problematic. We have some contributors who are no longer
living. Should we update the copyright dates for their contributions
when we release new versions? Probably not, but we do still want to
claim copyright for the project as a whole.
To minimize the difficulty of maintaining the copyright notices, I
would like to change Octave's sources to use what is described here:
https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html
in the section "Maintaining centralized copyright notices":
The centralized notice approach consolidates all copyright
notices in a single location, usually a top-level file.
This file should contain all of the copyright notices
provided project contributors, unless the contribution was
clearly insignificant. It may also credit -- without a copyright
notice -- anyone who helped with the project but did not
contribute code or other copyrighted material.
This approach captures less information about contributions
within individual files, recognizing that the DVCS is better
equipped to record those details. As we mentioned before, it
does have one disadvantage as compared to the file-scope
approach: if a single file is separated from the distribution,
the recipient won't see the contributors' copyright notices.
But this can be easily remedied by including a single
copyright notice in each file's header, pointing to the
top-level file:
Copyright YYYY-YYYY The Octave Project Developers
See the COPYRIGHT file at the top-level directory
of this distribution or at https://octave.org/COPYRIGHT.html.
followed by the usual GPL copyright statement.
For more background, see the discussion here:
https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html
Most files in the following directories have been skipped intentinally
in this changeset:
doc
libgui/qterminal
liboctave/external
m4
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 15:38:17 -0500 |
parents | c61301840704 |
children | 1891570abac8 |
line wrap: on
line source
/* Copyright (C) 1996-2019 The Octave Project Developers See the file COPYRIGHT.md in the top-level directory of this distribution or <https://octave.org/COPYRIGHT.html/>. 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 <cstdlib> #include <cstring> #include <complex> #include <istream> #include <limits> #include <ostream> #include <string> #include "quit.h" #include "lo-error.h" #include "lo-ieee.h" #include "lo-mappers.h" #include "lo-utils.h" bool xis_int_or_inf_or_nan (double x) { return octave::math::isnan (x) || octave::math::x_nint (x) == x; } bool xis_one_or_zero (double x) { return x == 0 || x == 1; } bool xis_zero (double x) { return x == 0; } bool xtoo_large_for_float (double x) { return (octave::math::isfinite (x) && fabs (x) > std::numeric_limits<float>::max ()); } bool xtoo_large_for_float (const Complex& x) { return (xtoo_large_for_float (x.real ()) || xtoo_large_for_float (x.imag ())); } bool xis_int_or_inf_or_nan (float x) { return octave::math::isnan (x) || octave::math::x_nint (x) == x; } bool xis_one_or_zero (float x) { return x == 0 || x == 1; } bool xis_zero (float x) { return x == 0; } // Save a string. char * strsave (const char *s) { if (! s) return nullptr; int len = strlen (s); char *tmp = new char [len+1]; tmp = strcpy (tmp, s); return tmp; } std::string octave_fgets (FILE *f) { bool eof; return octave_fgets (f, eof); } std::string octave_fgets (FILE *f, bool& eof) { eof = false; std::string retval; int grow_size = 1024; int max_size = grow_size; char *buf = static_cast<char *> (std::malloc (max_size)); if (! buf) (*current_liboctave_error_handler) ("octave_fgets: unable to malloc %d bytes", max_size); char *bufptr = buf; int len = 0; do { if (std::fgets (bufptr, grow_size, f)) { len = strlen (bufptr); if (len == grow_size - 1) { int tmp = bufptr - buf + grow_size - 1; grow_size *= 2; max_size += grow_size; auto tmpbuf = static_cast<char *> (std::realloc (buf, max_size)); if (! tmpbuf) { free (buf); (*current_liboctave_error_handler) ("octave_fgets: unable to realloc %d bytes", max_size); } buf = tmpbuf; bufptr = buf + tmp; if (*(bufptr-1) == '\n') { *bufptr = '\0'; retval = buf; } } else if (bufptr[len-1] != '\n') { bufptr[len++] = '\n'; bufptr[len] = '\0'; retval = buf; } else retval = buf; } else { if (len == 0) { eof = true; free (buf); buf = nullptr; } break; } } while (retval.empty ()); free (buf); octave_quit (); return retval; } std::string octave_fgetl (FILE *f) { bool eof; return octave_fgetl (f, eof); } std::string octave_fgetl (FILE *f, bool& eof) { std::string retval = octave_fgets (f, eof); if (! retval.empty () && retval.back () == '\n') retval.pop_back (); return retval; } // Note that the caller is responsible for repositioning the stream on failure. template <typename T> T read_inf_nan_na (std::istream& is, char c0) { T val = 0.0; switch (c0) { case 'i': case 'I': { char c1 = is.get (); if (c1 == 'n' || c1 == 'N') { char c2 = is.get (); if (c2 == 'f' || c2 == 'F') val = std::numeric_limits<T>::infinity (); else is.setstate (std::ios::failbit); } else is.setstate (std::ios::failbit); } break; case 'n': case 'N': { char c1 = is.get (); if (c1 == 'a' || c1 == 'A') { char c2 = is.get (); if (c2 == 'n' || c2 == 'N') val = std::numeric_limits<T>::quiet_NaN (); else { val = octave::numeric_limits<T>::NA (); if (c2 != std::istream::traits_type::eof ()) is.putback (c2); else is.clear (is.rdstate () & ~std::ios::failbit); } } else is.setstate (std::ios::failbit); } break; default: (*current_liboctave_error_handler) ("read_inf_nan_na: invalid character '%c'", c0); } return val; } // Read a double value. Discard any sign on NaN and NA. template <typename T> double octave_read_fp_value (std::istream& is) { T val = 0.0; // FIXME: resetting stream position is likely to fail unless we are // reading from a file. std::streampos pos = is.tellg (); char c1 = ' '; while (isspace (c1)) c1 = is.get (); bool neg = false; switch (c1) { case '-': neg = true; OCTAVE_FALLTHROUGH; case '+': { char c2 = 0; c2 = is.get (); if (c2 == 'i' || c2 == 'I' || c2 == 'n' || c2 == 'N') val = read_inf_nan_na<T> (is, c2); else { is.putback (c2); is >> val; } if (neg && ! is.fail ()) val = -val; } break; case 'i': case 'I': case 'n': case 'N': val = read_inf_nan_na<T> (is, c1); break; default: is.putback (c1); is >> val; break; } std::ios::iostate status = is.rdstate (); if (status & std::ios::failbit) { // Convert MAX_VAL returned by C++ streams for very large numbers to Inf if (val == std::numeric_limits<T>::max ()) { if (neg) val = -std::numeric_limits<T>::infinity (); else val = std::numeric_limits<T>::infinity (); is.clear (status & ~std::ios::failbit); } else { // True error. Reset stream to original position and pass status on. is.clear (); is.seekg (pos); is.setstate (status); } } return val; } template <typename T> std::complex<T> octave_read_cx_fp_value (std::istream& is) { T re = 0.0; T im = 0.0; std::complex<T> cx = 0.0; char ch = ' '; while (isspace (ch)) ch = is.get (); if (ch == '(') { re = octave_read_value<T> (is); ch = is.get (); if (ch == ',') { im = octave_read_value<T> (is); ch = is.get (); if (ch == ')') cx = std::complex<T> (re, im); else is.setstate (std::ios::failbit); } else if (ch == ')') cx = re; else is.setstate (std::ios::failbit); } else { is.putback (ch); cx = octave_read_value<double> (is); } return cx; } template <> OCTAVE_API double octave_read_value (std::istream& is) { return octave_read_fp_value<double> (is); } template <> OCTAVE_API Complex octave_read_value (std::istream& is) { return octave_read_cx_fp_value<double> (is); } template <> OCTAVE_API float octave_read_value (std::istream& is) { return octave_read_fp_value<float> (is); } template <> OCTAVE_API FloatComplex octave_read_value (std::istream& is) { return octave_read_cx_fp_value<float> (is); } void octave_write_double (std::ostream& os, double d) { if (lo_ieee_is_NA (d)) os << "NA"; else if (lo_ieee_isnan (d)) os << "NaN"; else if (lo_ieee_isinf (d)) os << (d < 0 ? "-Inf" : "Inf"); else os << d; } void octave_write_complex (std::ostream& os, const Complex& c) { os << '('; octave_write_double (os, real (c)); os << ','; octave_write_double (os, imag (c)); os << ')'; } void octave_write_float (std::ostream& os, float d) { if (lo_ieee_is_NA (d)) os << "NA"; else if (lo_ieee_isnan (d)) os << "NaN"; else if (lo_ieee_isinf (d)) os << (d < 0 ? "-Inf" : "Inf"); else os << d; } void octave_write_float_complex (std::ostream& os, const FloatComplex& c) { os << '('; octave_write_float (os, real (c)); os << ','; octave_write_float (os, imag (c)); os << ')'; }