octave: liboctave/util/file-info.h annotate

annotate liboctave/util/file-info.h @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	ce4436d2b206
children	243b51ec9ff0

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 29657 diff changeset	3 // Copyright (C) 2001-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	25
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	26 #if ! defined (octave_file_info_h)
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	27 #define octave_file_info_h 1
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	28
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	29 #include "octave-config.h"
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	30
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	31 #include <deque>
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	32 #include <map>
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	33 #include <string>
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	34 #include <vector>
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	35
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	36 #include "oct-time.h"
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	37
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	38 namespace octave
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	39 {
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	40 class file_info
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	41 {
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	42 public:
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	43
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	44 file_info (void)
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	45 : m_file_buf (), m_offsets (), m_timestamp (static_cast<time_t> (0))
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	46 { }
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	47
23730 85f1d31956c0 make echo work for command-line functions John W. Eaton <jwe@octave.org> parents: 23728 diff changeset	48 file_info (const std::string& text, const sys::time& timestamp)
85f1d31956c0 make echo work for command-line functions John W. Eaton <jwe@octave.org> parents: 23728 diff changeset	49 : m_file_buf (text), m_offsets (get_line_offsets (m_file_buf)),
85f1d31956c0 make echo work for command-line functions John W. Eaton <jwe@octave.org> parents: 23728 diff changeset	50 m_timestamp (timestamp)
85f1d31956c0 make echo work for command-line functions John W. Eaton <jwe@octave.org> parents: 23728 diff changeset	51 { }
85f1d31956c0 make echo work for command-line functions John W. Eaton <jwe@octave.org> parents: 23728 diff changeset	52
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	53 file_info (const std::string& fname)
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	54 : m_file_buf (snarf_file (fname)),
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	55 m_offsets (get_line_offsets (m_file_buf)),
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	56 m_timestamp ()
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	57 { }
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	58
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	59 file_info (const file_info&) = default;
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	60
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	61 file_info& operator = (const file_info&) = default;
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	62
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	63 ~file_info (void) = default;
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	64
29572 aef11bb4e6d1 use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	65 OCTAVE_API std::string get_line (std::size_t line) const;
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	66
29230 6b3faa844395 Set API tags in files in liboctave/util (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	67 OCTAVE_API std::deque<std::string>
29572 aef11bb4e6d1 use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	68 get_lines (std::size_t line, std::size_t num_lines) const;
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	69
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	70 std::size_t num_lines (void) const { return m_offsets.size (); }
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	71
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	72 std::string text (void) const { return m_file_buf; }
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	73
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	74 std::vector<std::size_t> line_offsets (void) const { return m_offsets; }
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	75
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	76 sys::time timestamp (void) const { return m_timestamp; }
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	77
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	78 std::size_t size (void) const { return m_file_buf.length (); }
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	79
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	80 private:
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	81
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	82 // File contents as a string.
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	83 std::string m_file_buf;
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	84
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	85 // Offsets to line beginnings.
29654 d13d090cb03a use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	86 std::vector<std::size_t> m_offsets;
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	87
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	88 sys::time m_timestamp;
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	89
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	90 // Read entire file called fname and return the contents as a string
29230 6b3faa844395 Set API tags in files in liboctave/util (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	91 static OCTAVE_API std::string snarf_file (const std::string& fname);
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	92
29572 aef11bb4e6d1 use std::size_t and std::ptrdiff_t in C++ code (bug #60471) John W. Eaton <jwe@octave.org> parents: 29359 diff changeset	93 static OCTAVE_API std::vector<std::size_t>
29230 6b3faa844395 Set API tags in files in liboctave/util (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	94 get_line_offsets (const std::string& buf);
23728 b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	95 };
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	96 }
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	97
b40b7243a782 new class for caching file contents for debug and echo John W. Eaton <jwe@octave.org> parents: diff changeset	98 #endif

Mercurial > octave

annotate liboctave/util/file-info.h @ 30564:796f54d4ddbf stable