Mercurial > octave
view liboctave/system/file-stat.h @ 32628:ae4e19c0a2b1
maint: Place class name and class keyword on one line.
* libinterp/corefcn/Cell.h, libinterp/corefcn/__magick_read__.cc,
libinterp/corefcn/auto-shlib.h, libinterp/corefcn/base-text-renderer.h,
libinterp/corefcn/c-file-ptr-stream.h, libinterp/corefcn/call-stack.h,
libinterp/corefcn/dynamic-ld.h, libinterp/corefcn/event-manager.h,
libinterp/corefcn/event-queue.h, libinterp/corefcn/ft-text-renderer.cc,
libinterp/corefcn/gl-render.cc, libinterp/corefcn/gl-render.h,
libinterp/corefcn/gl2ps-print.cc, libinterp/corefcn/graphics.cc,
libinterp/corefcn/graphics.in.h, libinterp/corefcn/input.cc,
libinterp/corefcn/latex-text-renderer.cc, libinterp/corefcn/load-path.h,
libinterp/corefcn/mx-type-traits.h, libinterp/corefcn/oct-errno.h,
libinterp/corefcn/oct-fstrm.h, libinterp/corefcn/oct-iostrm.h,
libinterp/corefcn/oct-prcstrm.h, libinterp/corefcn/oct-procbuf.h,
libinterp/corefcn/oct-process.h, libinterp/corefcn/oct-stdstrm.h,
libinterp/corefcn/oct-stream.cc, libinterp/corefcn/oct-stream.h,
libinterp/corefcn/oct-strstrm.h, libinterp/corefcn/pager.h,
libinterp/corefcn/pr-flt-fmt.h, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pr-output.h, libinterp/corefcn/procstream.h,
libinterp/corefcn/syminfo.h, libinterp/corefcn/text-engine.h,
libinterp/corefcn/text-renderer.h, libinterp/corefcn/utils.h,
libinterp/octave-value/cdef-class.h, libinterp/octave-value/cdef-manager.h,
libinterp/octave-value/cdef-method.h, libinterp/octave-value/cdef-object.h,
libinterp/octave-value/cdef-package.h, libinterp/octave-value/cdef-property.h,
libinterp/octave-value/ov-base-diag.h, libinterp/octave-value/ov-base-int.h,
libinterp/octave-value/ov-base-mat.h, libinterp/octave-value/ov-base-scalar.h,
libinterp/octave-value/ov-base-sparse.h, libinterp/octave-value/ov-base.h,
libinterp/octave-value/ov-bool-mat.h, libinterp/octave-value/ov-bool-sparse.h,
libinterp/octave-value/ov-bool.h, libinterp/octave-value/ov-builtin.h,
libinterp/octave-value/ov-cell.h, libinterp/octave-value/ov-ch-mat.h,
libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-class.h,
libinterp/octave-value/ov-classdef.h, libinterp/octave-value/ov-colon.h,
libinterp/octave-value/ov-complex.h, libinterp/octave-value/ov-cs-list.h,
libinterp/octave-value/ov-cx-diag.h, libinterp/octave-value/ov-cx-mat.h,
libinterp/octave-value/ov-cx-sparse.h, libinterp/octave-value/ov-dld-fcn.h,
libinterp/octave-value/ov-fcn-handle.h, libinterp/octave-value/ov-fcn.h,
libinterp/octave-value/ov-float.h, libinterp/octave-value/ov-flt-complex.h,
libinterp/octave-value/ov-flt-cx-diag.h,
libinterp/octave-value/ov-flt-cx-mat.h,
libinterp/octave-value/ov-flt-re-diag.h,
libinterp/octave-value/ov-flt-re-mat.h, libinterp/octave-value/ov-int-traits.h,
libinterp/octave-value/ov-intx.h, libinterp/octave-value/ov-lazy-idx.h,
libinterp/octave-value/ov-legacy-range.cc,
libinterp/octave-value/ov-legacy-range.h,
libinterp/octave-value/ov-magic-int.h, libinterp/octave-value/ov-mex-fcn.h,
libinterp/octave-value/ov-null-mat.h, libinterp/octave-value/ov-perm.h,
libinterp/octave-value/ov-range-traits.h, libinterp/octave-value/ov-range.h,
libinterp/octave-value/ov-re-diag.h, libinterp/octave-value/ov-re-mat.h,
libinterp/octave-value/ov-re-sparse.h, libinterp/octave-value/ov-scalar.h,
libinterp/octave-value/ov-str-mat.h, libinterp/octave-value/ov-struct.h,
libinterp/octave-value/ov-typeinfo.h, libinterp/octave-value/ov-usr-fcn.h,
libinterp/octave-value/ov.h, libinterp/octave-value/ovl.h,
libinterp/parse-tree/comment-list.h, libinterp/parse-tree/lex.h,
libinterp/parse-tree/profiler.h, libinterp/parse-tree/pt-anon-scopes.h,
liboctave/array/Array.h, liboctave/array/CColVector.h,
liboctave/array/CDiagMatrix.h, liboctave/array/CMatrix.h,
liboctave/array/CNDArray.h, liboctave/array/CRowVector.h,
liboctave/array/CSparse.h, liboctave/array/DiagArray2.h,
liboctave/array/MArray.h, liboctave/array/MDiagArray2.h,
liboctave/array/MSparse.h, liboctave/array/MatrixType.h,
liboctave/array/Range.h, liboctave/array/Sparse.h,
liboctave/array/boolMatrix.h, liboctave/array/boolNDArray.h,
liboctave/array/boolSparse.h, liboctave/array/chMatrix.h,
liboctave/array/chNDArray.h, liboctave/array/dColVector.h,
liboctave/array/dDiagMatrix.h, liboctave/array/dMatrix.h,
liboctave/array/dNDArray.h, liboctave/array/dRowVector.h,
liboctave/array/dSparse.h, liboctave/array/dim-vector.h,
liboctave/array/fCColVector.h, liboctave/array/fCDiagMatrix.h,
liboctave/array/fCMatrix.h, liboctave/array/fCNDArray.h,
liboctave/array/fCRowVector.h, liboctave/array/fColVector.h,
liboctave/array/fDiagMatrix.h, liboctave/array/fMatrix.h,
liboctave/array/fNDArray.h, liboctave/array/fRowVector.h,
liboctave/array/idx-vector.h, liboctave/array/intNDArray.h,
liboctave/numeric/DAE.h, liboctave/numeric/DAEFunc.h,
liboctave/numeric/DAERT.h, liboctave/numeric/DAERTFunc.h,
liboctave/numeric/DASPK.h, liboctave/numeric/DASRT.h,
liboctave/numeric/DASSL.h, liboctave/numeric/DET.h, liboctave/numeric/EIG.h,
liboctave/numeric/LSODE.h, liboctave/numeric/ODE.h,
liboctave/numeric/ODEFunc.h, liboctave/numeric/ODES.h,
liboctave/numeric/ODESFunc.h, liboctave/numeric/Quad.h,
liboctave/numeric/aepbalance.h, liboctave/numeric/base-dae.h,
liboctave/numeric/base-de.h, liboctave/numeric/chol.h,
liboctave/numeric/fEIG.h, liboctave/numeric/gepbalance.h,
liboctave/numeric/gsvd.h, liboctave/numeric/hess.h, liboctave/numeric/lu.h,
liboctave/numeric/oct-fftw.h, liboctave/numeric/qr.h, liboctave/numeric/qrp.h,
liboctave/numeric/schur.h, liboctave/numeric/sparse-chol.h,
liboctave/numeric/sparse-lu.h, liboctave/numeric/sparse-qr.cc,
liboctave/numeric/sparse-qr.h, liboctave/numeric/svd.cc,
liboctave/numeric/svd.h, liboctave/system/dir-ops.h,
liboctave/system/file-stat.h, liboctave/system/oct-env.h,
liboctave/system/oct-group.h, liboctave/system/oct-password.h,
liboctave/system/oct-time.h, liboctave/system/oct-uname.h,
liboctave/util/action-container.h, liboctave/util/base-list.h,
liboctave/util/cmd-edit.cc, liboctave/util/cmd-edit.h,
liboctave/util/cmd-hist.cc, liboctave/util/cmd-hist.h,
liboctave/util/data-conv.h, liboctave/util/glob-match.h,
liboctave/util/lo-regexp.h, liboctave/util/oct-inttypes.h,
liboctave/util/oct-mutex.cc, liboctave/util/oct-mutex.h,
liboctave/util/oct-shlib.cc, liboctave/util/oct-shlib.h,
liboctave/util/oct-sort.h, liboctave/util/oct-string.h,
liboctave/util/octave-preserve-stream-state.h, liboctave/util/pathsearch.h,
liboctave/util/singleton-cleanup.h, liboctave/util/str-vec.h,
liboctave/util/unwind-prot.h, liboctave/util/url-transfer.h:
Place class name and class keyword on one line.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 21 Dec 2023 11:22:26 -0800 |
parents | 1daf8bfceac3 |
children | 4b601ca024d5 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1996-2023 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 (octave_file_stat_h) #define octave_file_stat_h 1 #include "octave-config.h" #include <string> #include "oct-time.h" #include <sys/types.h> OCTAVE_BEGIN_NAMESPACE(octave) OCTAVE_BEGIN_NAMESPACE(sys) class OCTAVE_API base_file_stat { public: base_file_stat () : m_initialized (false), m_fail (false), m_errmsg (), m_mode (), m_ino (), m_dev (), m_nlink (), m_uid (), m_gid (), m_size (), m_atime (), m_mtime (), m_ctime (), m_rdev (), m_blksize (), m_blocks () { } base_file_stat (const base_file_stat& fs) : m_initialized (fs.m_initialized), m_fail (fs.m_fail), m_errmsg (fs.m_errmsg), m_mode (fs.m_mode), m_ino (fs.m_ino), m_dev (fs.m_dev), m_nlink (fs.m_nlink), m_uid (fs.m_uid), m_gid (fs.m_gid), m_size (fs.m_size), m_atime (fs.m_atime), m_mtime (fs.m_mtime), m_ctime (fs.m_ctime), m_rdev (fs.m_rdev), m_blksize (fs.m_blksize), m_blocks (fs.m_blocks) { } base_file_stat& operator = (const base_file_stat& fs) { if (this != &fs) { m_initialized = fs.m_initialized; m_fail = fs.m_fail; m_errmsg = fs.m_errmsg; m_mode = fs.m_mode; m_ino = fs.m_ino; m_dev = fs.m_dev; m_nlink = fs.m_nlink; m_uid = fs.m_uid; m_gid = fs.m_gid; m_size = fs.m_size; m_atime = fs.m_atime; m_mtime = fs.m_mtime; m_ctime = fs.m_ctime; m_rdev = fs.m_rdev; m_blksize = fs.m_blksize; m_blocks = fs.m_blocks; } return *this; } // The minimum difference in file time stamp values. // FIXME: This value should come from the filesystem itself. // How can we get that info? sys::time time_resolution () const { static sys::time resolution (1.0); return resolution; } // File status and info. The is_XXX functions will return false for // file_stat objects that are not properly initialized. The others // should all return 0 (or the equivalent, for the given object) // which is likely not meaningful. bool is_blk () const; bool is_chr () const; bool is_dir () const; bool is_fifo () const; bool is_lnk () const; bool is_reg () const; bool is_sock () const; static bool is_blk (mode_t mode); static bool is_chr (mode_t mode); static bool is_dir (mode_t mode); static bool is_fifo (mode_t mode); static bool is_lnk (mode_t mode); static bool is_reg (mode_t mode); static bool is_sock (mode_t mode); static bool have_struct_stat_st_rdev (); static bool have_struct_stat_st_blksize (); static bool have_struct_stat_st_blocks (); ino_t ino () const { return m_ino; } dev_t dev () const { return m_dev; } nlink_t nlink () const { return m_nlink; } uid_t uid () const { return m_uid; } gid_t gid () const { return m_gid; } off_t size () const { return m_size; } sys::time atime () const { return m_atime; } sys::time mtime () const { return m_mtime; } sys::time ctime () const { return m_ctime; } dev_t rdev () const { return m_rdev; } long blksize () const { return m_blksize; } long blocks () const { return m_blocks; } mode_t mode () const { return m_mode; } std::string mode_as_string () const; bool ok () const { return m_initialized && ! m_fail; } operator bool () const { return ok (); } bool exists () const { return ok (); } std::string error () const { return ok () ? "" : m_errmsg; } // Has the file referenced by this object been modified since TIME? bool is_newer (const sys::time& time) const { return m_mtime > time; } // It's nice to be able to hide the file_stat object if we don't // really care about it. static int is_newer (const std::string&, const sys::time&); protected: virtual ~base_file_stat () = default; // TRUE means we have already called stat. bool m_initialized; // TRUE means the stat for this file failed. bool m_fail; // If a failure occurs, this contains the system error text. std::string m_errmsg; // file type and permissions mode_t m_mode; // serial number ino_t m_ino; // device number dev_t m_dev; // number of links nlink_t m_nlink; // user ID of owner uid_t m_uid; // group ID of owner gid_t m_gid; // size in bytes, for regular files off_t m_size; // time of last access sys::time m_atime; // time of last modification sys::time m_mtime; // time of last file status change sys::time m_ctime; // device number for special files dev_t m_rdev; // best I/O block size long m_blksize; // number of 512-byte blocks allocated long m_blocks; }; class OCTAVE_API file_stat : public base_file_stat { public: // This constructor must remain defined in the cpp file rather than in // the header file (bug #50234). file_stat (const std::string& n = "", bool fl = true); file_stat (const file_stat& fs) : base_file_stat (fs), m_file_name (fs.m_file_name), m_follow_links (fs.m_follow_links) { } file_stat& operator = (const file_stat& fs) { if (this != &fs) { base_file_stat::operator = (fs); m_file_name = fs.m_file_name; m_follow_links = fs.m_follow_links; } return *this; } // This destructor must remain as an empty destructor defined in the // cpp file rather than in the header file (bug #50234). ~file_stat (); void get_stats (bool force = false) { if (! m_initialized || force) update_internal (force); } void get_stats (const std::string& n, bool force = false) { if (n != m_file_name || ! m_initialized || force) { m_initialized = false; m_file_name = n; update_internal (force); } } private: // Name of the file. std::string m_file_name; // TRUE means follow symbolic links to the ultimate file (stat). // FALSE means get information about the link itself (lstat). bool m_follow_links; void update_internal (bool force = false); }; class OCTAVE_API file_fstat : public base_file_stat { public: file_fstat () = delete; file_fstat (int n) : base_file_stat (), m_fid (n) { update_internal (); } OCTAVE_DEFAULT_COPY_MOVE_DELETE (file_fstat) void get_stats (bool force = false) { if (! m_initialized || force) update_internal (force); } void get_stats (int n, bool force = false) { if (n != m_fid || ! m_initialized || force) { m_initialized = false; m_fid = n; update_internal (force); } } private: // Open file descriptor. int m_fid; void update_internal (bool force = false); }; OCTAVE_END_NAMESPACE(sys) OCTAVE_END_NAMESPACE(octave) #endif