Mercurial > octave
view libinterp/octave-value/ovl.h @ 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 | b00ddc40b89a |
children | 1891570abac8 |
line wrap: on
line source
/* Copyright (C) 1994-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 (octave_ovl_h) #define octave_ovl_h 1 #include "octave-config.h" #include <string> #include <vector> #include <initializer_list> #include "str-vec.h" #include "Array.h" #include "ov.h" #include "Cell.h" class OCTINTERP_API octave_value_list { public: octave_value_list (void) = default; explicit octave_value_list (octave_idx_type n) : m_data (n), m_names () { } octave_value_list (octave_idx_type n, const octave_value& val) : m_data (n, val), m_names () { } octave_value_list (const octave_value& tc) : m_data (1, tc), m_names () { } template<template <typename...> class OV_Container> octave_value_list (const OV_Container<octave_value>& args) : m_data (args.begin (), args.end ()), m_names () { } octave_value_list (const Array<octave_value>& a) : m_data (a.numel ()), m_names () { for (octave_idx_type i = 0; i < a.numel (); i++) m_data[i] = a(i); } octave_value_list (const Cell& c) : m_data (c.numel ()), m_names () { for (octave_idx_type i = 0; i < c.numel (); i++) m_data[i] = c(i); } octave_value_list (const octave_value_list& obj) = default; octave_value_list (octave_value_list&& obj) = default; // Concatenation constructors. octave_value_list (const std::list<octave_value>&); octave_value_list (const std::list<octave_value_list>&); ~octave_value_list (void) = default; octave_value_list& operator = (const octave_value_list& obj) = default; octave_value_list& operator = (octave_value_list&& obj) = default; Array<octave_value> array_value (void) const { Array<octave_value> retval; if (! m_data.empty ()) { retval.resize (dim_vector (1, length ())); for (octave_idx_type i = 0; i < retval.numel (); i++) retval.xelem (i) = m_data[i]; } return retval; } Cell cell_value (void) const { return array_value (); } // Assignment will resize on range errors. octave_value& operator () (octave_idx_type n) { return elem (n); } const octave_value& operator () (octave_idx_type n) const { return elem (n); } octave_idx_type length (void) const { return m_data.size (); } bool empty (void) const { return length () == 0; } void resize (octave_idx_type n, const octave_value& rfv = octave_value ()) { m_data.resize (n, rfv); } octave_value_list& prepend (const octave_value& val); octave_value_list& append (const octave_value& val); octave_value_list& append (const octave_value_list& lst); octave_value_list& reverse (void); octave_value_list slice (octave_idx_type offset, octave_idx_type len, bool tags = false) const { // linear_slice uses begin/end indices instead of offset and length. // Avoid calling with upper bound out of range. octave_idx_type tlen = len > 0 ? len : 0; std::vector<octave_value> slice_data (tlen); auto beg = m_data.begin () + offset; auto end = beg + len; std::copy (beg, end, slice_data.begin ()); octave_value_list retval = slice_data; if (tags && len > 0 && m_names.numel () > 0) retval.m_names = m_names.linear_slice (offset, std::min (offset + len, m_names.numel ())); return retval; } octave_value_list splice (octave_idx_type offset, octave_idx_type len, const octave_value_list& lst = octave_value_list ()) const; bool all_strings_p (void) const; bool all_scalars (void) const; bool any_cell (void) const; bool has_magic_colon (void) const; string_vector make_argv (const std::string& = "") const; void stash_name_tags (const string_vector& nm) { m_names = nm; } string_vector name_tags (void) const { return m_names; } void make_storable_values (void); octave_value& xelem (octave_idx_type i) { return m_data[i]; } void clear (void) { m_data.clear (); } private: std::vector<octave_value> m_data; // The list of strings can be used to tag each element of m_data with a name. // By default, it is empty. string_vector m_names; // elem will automatically resize array for out-of-bounds requests. octave_value& elem (octave_idx_type n) { if (n >= length ()) resize (n + 1); return m_data[n]; } const octave_value& elem (octave_idx_type n) const { return m_data[n]; } }; //! Construct an octave_value_list with less typing. //! //! Historically, this made it easier to create an octave_value_list //! from multiple octave_value arguments. It is no longer useful since //! octave_value_list has now a constructor accepting an initializer_list //! so all it does is save some typing. The following are equivalent: //! //! @code{.cc} //! return octave_value_list ({ov0, ov1, ov2}); //! return ovl (ov0, ov1, ov2); //! @endcode template<typename... OV_Args> inline octave_value_list ovl (const OV_Args&... args) { return octave_value_list (std::initializer_list<octave_value> ({args...})); } #endif