octave: liboctave/system/file-stat.h annotate

annotate liboctave/system/file-stat.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

rev	line source
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	1 /*
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	2
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 1996-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 diff changeset	7
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	8
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23696 diff changeset	11 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23696 diff changeset	13 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 (at your option) any later version.
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	19 GNU General Public License for more details.
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	20
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	21 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6108 diff changeset	22 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23696 diff changeset	23 <https://www.gnu.org/licenses/>.
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	24
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	25 */
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	26
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	27 #if ! defined (octave_file_stat_h)
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	28 #define octave_file_stat_h 1
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	29
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	31
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	32 #include <string>
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	33
3260 cd454a6fa1a4 [project @ 1999-08-02 21:55:15 by jwe] jwe parents: 3145 diff changeset	34 #include "oct-time.h"
cd454a6fa1a4 [project @ 1999-08-02 21:55:15 by jwe] jwe parents: 3145 diff changeset	35
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	36 #include <sys/types.h>
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	37
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	38 namespace octave
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	39 {
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	40 namespace sys
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	41 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	42 class
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	43 OCTAVE_API
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	44 base_file_stat
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	45 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	46 public:
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	47
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	48 base_file_stat (void)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	49 : initialized (false), fail (false), errmsg (), m_mode (),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	50 m_ino (), m_dev (), m_nlink (), m_uid (), m_gid (),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	51 m_size (), m_atime (), m_mtime (), m_ctime (), m_rdev (),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	52 m_blksize (), m_blocks () { }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	53
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	54 base_file_stat (const base_file_stat& fs)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	55 : initialized (fs.initialized), fail (fs.fail), errmsg (fs.errmsg),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	56 m_mode (fs.m_mode), m_ino (fs.m_ino), m_dev (fs.m_dev),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	57 m_nlink (fs.m_nlink), m_uid (fs.m_uid), m_gid (fs.m_gid),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	58 m_size (fs.m_size), m_atime (fs.m_atime), m_mtime (fs.m_mtime),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	59 m_ctime (fs.m_ctime), m_rdev (fs.m_rdev),
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	60 m_blksize (fs.m_blksize), m_blocks (fs.m_blocks) { }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	61
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	62 base_file_stat& operator = (const base_file_stat& fs)
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	63 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	64 if (this != &fs)
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	65 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	66 initialized = fs.initialized;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	67 fail = fs.fail;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	68 errmsg = fs.errmsg;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	69 m_mode = fs.m_mode;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	70 m_ino = fs.m_ino;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	71 m_dev = fs.m_dev;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	72 m_nlink = fs.m_nlink;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	73 m_uid = fs.m_uid;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	74 m_gid = fs.m_gid;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	75 m_size = fs.m_size;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	76 m_atime = fs.m_atime;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	77 m_mtime = fs.m_mtime;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	78 m_ctime = fs.m_ctime;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	79 m_rdev = fs.m_rdev;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	80 m_blksize = fs.m_blksize;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	81 m_blocks = fs.m_blocks;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	82 }
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	83
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	84 return *this;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	85 }
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	86
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	87 // The minimum difference in file time stamp values.
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	88 // FIXME: This value should come from the filesystem itself.
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	89 // How can we get that info?
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	90 sys::time time_resolution (void) const
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	91 {
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	92 static sys::time resolution (1.0);
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	93 return resolution;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	94 }
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	95
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	96 // File status and info. The is_XXX functions will return false for
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	97 // file_stat objects that are not properly initialized. The others
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	98 // should all return 0 (or the equivalent, for the given object)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	99 // which is likely not meaningful.
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	100
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	101 bool is_blk (void) const;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	102 bool is_chr (void) const;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	103 bool is_dir (void) const;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	104 bool is_fifo (void) const;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	105 bool is_lnk (void) const;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	106 bool is_reg (void) const;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	107 bool is_sock (void) const;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	108
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	109 static bool is_blk (mode_t mode);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	110 static bool is_chr (mode_t mode);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	111 static bool is_dir (mode_t mode);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	112 static bool is_fifo (mode_t mode);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	113 static bool is_lnk (mode_t mode);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	114 static bool is_reg (mode_t mode);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	115 static bool is_sock (mode_t mode);
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	116
21935 2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	117 static bool have_struct_stat_st_rdev (void);
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	118 static bool have_struct_stat_st_blksize (void);
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	119 static bool have_struct_stat_st_blocks (void);
2f33052c68ff hide sys/stat.h header John W. Eaton <jwe@octave.org> parents: 21752 diff changeset	120
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	121 ino_t ino (void) const { return m_ino; }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	122 dev_t dev (void) const { return m_dev; }
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5307 diff changeset	123
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	124 nlink_t nlink (void) const { return m_nlink; }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	125
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	126 uid_t uid (void) const { return m_uid; }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	127 gid_t gid (void) const { return m_gid; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	128
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	129 off_t size (void) const { return m_size; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	130
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	131 sys::time atime (void) const { return m_atime; }
08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	132 sys::time mtime (void) const { return m_mtime; }
08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	133 sys::time ctime (void) const { return m_ctime; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	134
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	135 dev_t rdev (void) const { return m_rdev; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	136
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	137 long blksize (void) const { return m_blksize; }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	138 long blocks (void) const { return m_blocks; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	139
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	140 mode_t mode (void) const { return m_mode; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	141
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	142 std::string mode_as_string (void) const;
5476 941f0fc6b596 [project @ 2005-09-29 22:46:07 by jwe] jwe parents: 5307 diff changeset	143
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	144 bool ok (void) const { return initialized && ! fail; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	145
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	146 operator bool () const { return ok (); }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	147
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	148 bool exists (void) const { return ok (); }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	149
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	150 std::string error (void) const { return ok () ? "" : errmsg; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	151
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	152 // Has the file referenced by this object been modified since TIME?
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	153 bool is_newer (const sys::time& time) const { return m_mtime > time; }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	154
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	155 // It's nice to be able to hide the file_stat object if we don't
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	156 // really care about it.
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	157 static int is_newer (const std::string&, const sys::time&);
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	158
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	159 protected:
11506 964b7fd379f1 more constructor/destructor fixes John W. Eaton <jwe@octave.org> parents: 10312 diff changeset	160
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	161 virtual ~base_file_stat (void) = default;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	162
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	163 // TRUE means we have already called stat.
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	164 bool initialized;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	165
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	166 // TRUE means the stat for this file failed.
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	167 bool fail;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	168
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	169 // If a failure occurs, this contains the system error text.
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	170 std::string errmsg;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	171
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	172 // file type and permissions
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	173 mode_t m_mode;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	174
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	175 // serial number
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	176 ino_t m_ino;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	177
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	178 // device number
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	179 dev_t m_dev;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	180
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	181 // number of links
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	182 nlink_t m_nlink;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	183
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	184 // user ID of owner
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	185 uid_t m_uid;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	186
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	187 // group ID of owner
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	188 gid_t m_gid;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	189
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	190 // size in bytes, for regular files
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	191 off_t m_size;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	192
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	193 // time of last access
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	194 sys::time m_atime;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	195
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	196 // time of last modification
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	197 sys::time m_mtime;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	198
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	199 // time of last file status change
23696 08036a7f3660 remove octave:: namespace tag from symbols used inside octave namespace John W. Eaton <jwe@octave.org> parents: 23615 diff changeset	200 sys::time m_ctime;
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	201
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	202 // device number for special files
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	203 dev_t m_rdev;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	204
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	205 // best I/O block size
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	206 long m_blksize;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	207
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	208 // number of 512-byte blocks allocated
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	209 long m_blocks;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	210 };
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	211
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	212 class
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	213 OCTAVE_API
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	214 file_stat : public base_file_stat
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	215 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	216 public:
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	217
23206 525c36d5f985 Workaround segfault in file_stat (bug #50234). Rik <rik@octave.org> parents: 23083 diff changeset	218 // This constructor must remain defined in the cpp file rather than in
525c36d5f985 Workaround segfault in file_stat (bug #50234). Rik <rik@octave.org> parents: 23083 diff changeset	219 // the header file (bug #50234).
525c36d5f985 Workaround segfault in file_stat (bug #50234). Rik <rik@octave.org> parents: 23083 diff changeset	220 file_stat (const std::string& n = "", bool fl = true);
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	221
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	222 file_stat (const file_stat& fs)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	223 : base_file_stat (fs), file_name (fs.file_name),
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	224 follow_links (fs.follow_links) { }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	225
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	226 file_stat& operator = (const file_stat& fs)
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	227 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	228 if (this != &fs)
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	229 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	230 base_file_stat::operator = (fs);
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	231
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	232 file_name = fs.file_name;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	233 follow_links = fs.follow_links;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	234 }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	235
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	236 return *this;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	237 }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	238
23206 525c36d5f985 Workaround segfault in file_stat (bug #50234). Rik <rik@octave.org> parents: 23083 diff changeset	239 // This destructor must remain as an empty destructor defined in the
525c36d5f985 Workaround segfault in file_stat (bug #50234). Rik <rik@octave.org> parents: 23083 diff changeset	240 // cpp file rather than in the header file (bug #50234).
525c36d5f985 Workaround segfault in file_stat (bug #50234). Rik <rik@octave.org> parents: 23083 diff changeset	241 ~file_stat (void);
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	242
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	243 void get_stats (bool force = false)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	244 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	245 if (! initialized \|\| force)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	246 update_internal (force);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	247 }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	248
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	249 void get_stats (const std::string& n, bool force = false)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	250 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	251 if (n != file_name \|\| ! initialized \|\| force)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	252 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	253 initialized = false;
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	254
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	255 file_name = n;
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	256
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	257 update_internal (force);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	258 }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	259 }
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	260
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	261 private:
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	262
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	263 // Name of the file.
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	264 std::string file_name;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	265
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	266 // TRUE means follow symbolic links to the ultimate file (stat).
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	267 // FALSE means get information about the link itself (lstat).
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	268 bool follow_links;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	269
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	270 void update_internal (bool force = false);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	271 };
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	272
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	273 class
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	274 OCTAVE_API
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	275 file_fstat : public base_file_stat
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	276 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	277 public:
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	278
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	279 file_fstat (int n) : base_file_stat (), fid (n)
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	280 {
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	281 update_internal ();
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	282 }
424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	283
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	284 file_fstat (const file_fstat& fs)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	285 : base_file_stat (fs), fid (fs.fid) { }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	286
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	287 file_fstat& operator = (const file_fstat& fs)
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	288 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	289 if (this != &fs)
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	290 {
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	291 base_file_stat::operator = (fs);
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	292
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	293 fid = fs.fid;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	294 }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	295
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	296 return *this;
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	297 }
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	298
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	299 ~file_fstat (void) = default;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	300
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	301 void get_stats (bool force = false)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	302 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	303 if (! initialized \|\| force)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	304 update_internal (force);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	305 }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	306
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	307 void get_stats (int n, bool force = false)
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	308 {
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	309 if (n != fid \|\| ! initialized \|\| force)
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	310 {
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	311 initialized = false;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	312
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	313 fid = n;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	314
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	315 update_internal (force);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	316 }
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	317 }
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	318
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	319 private:
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	320
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	321 // Open file descriptor.
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	322 int fid;
8549 424ba638d8f1 [mq]: fstat file-io.cc (Ffstat): new function parents: 7017 diff changeset	323
21736 0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	324 void update_internal (bool force = false);
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	325 };
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	326 }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	327 }
0504351a45e6 use namespace for file_stat classes John W. Eaton <jwe@octave.org> parents: 21730 diff changeset	328
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: diff changeset	329 #endif

Mercurial > octave

annotate liboctave/system/file-stat.h @ 27919:1891570abac8