FXStat.h

/********************************************************************************
*                                                                               *
*                        F i l e   S t a t i s t i c s                          *
*                                                                               *
*********************************************************************************
* Copyright (C) 2005,2024 by Jeroen van der Zijp.   All Rights Reserved.        *
*********************************************************************************
* This library is free software; you can redistribute it and/or modify          *
* it under the terms of the GNU Lesser General Public License as published by   *
* the Free Software Foundation; either version 3 of the License, or             *
* (at your option) any later version.                                           *
*                                                                               *
* This library 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 Lesser General Public License for more details.                           *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public License      *
* along with this program.  If not, see <http://www.gnu.org/licenses/>          *
********************************************************************************/
#ifndef FXSTAT_H
#define FXSTAT_H

namespace FX {


class FXFile;


class FXAPI FXStat {
private:
  FXuint  modeFlags;            
  FXuint  userNumber;           
  FXuint  groupNumber;          
  FXuint  linkCount;            
  FXTime  createTime;           
  FXTime  accessTime;           
  FXTime  modifyTime;           
  FXlong  fileVolume;           
  FXlong  fileIndex;            
  FXlong  fileSize;             
public:

  FXStat():modeFlags(0),userNumber(0),groupNumber(0),linkCount(0),createTime(0),accessTime(0),modifyTime(0),fileVolume(0),fileIndex(0),fileSize(0){ }

  FXuint mode() const { return modeFlags; }

  FXuint user() const { return userNumber; }

  FXuint group() const { return groupNumber; }

  FXuint links() const { return linkCount; }

  FXTime created() const { return createTime; }

  FXTime accessed() const { return accessTime; }

  FXTime modified() const { return modifyTime; }

  FXlong volume() const { return fileVolume; }

  FXlong index() const { return fileIndex; }

  FXlong size() const { return fileSize; }

  FXbool isHidden() const;

  FXbool isDirectory() const;

  FXbool isFile() const;

  FXbool isLink() const;

  FXbool isSetUid() const;

  FXbool isSetGid() const;

  FXbool isSetSticky() const;

  FXbool isDevice() const;

  FXbool isCharacter() const;

  FXbool isBlock() const;

  FXbool isSocket() const;

  FXbool isFifo() const;

  FXbool isReadable() const;

  FXbool isWritable() const;

  FXbool isExecutable() const;

  FXbool isOwnerReadWriteExecute() const;

  FXbool isOwnerReadable() const;

  FXbool isOwnerWritable() const;

  FXbool isOwnerExecutable() const;

  FXbool isGroupReadWriteExecute() const;

  FXbool isGroupReadable() const;

  FXbool isGroupWritable() const;

  FXbool isGroupExecutable() const;

  FXbool isOtherReadWriteExecute() const;

  FXbool isOtherReadable() const;

  FXbool isOtherWritable() const;

  FXbool isOtherExecutable() const;


  static FXbool statFile(const FXString& file,FXStat& info);

  static FXbool statLink(const FXString& file,FXStat& info);

  static FXbool stat(const FXFile& file,FXStat& info);


  static FXuint mode(const FXString& file);

  static FXbool mode(const FXString& file,FXuint perm);

  static FXbool exists(const FXString& file);

  static FXlong size(const FXString& file);

  static FXlong volume(const FXString& file);

  static FXlong index(const FXString& file);

  static FXuint links(const FXString& file);

  static FXTime modified(const FXString& file);

  static FXbool modified(const FXString& file,FXTime ns);

  static FXTime accessed(const FXString& file);

  static FXbool accessed(const FXString& file,FXTime ns);

  static FXTime created(const FXString& file);

  static FXbool created(const FXString& file,FXTime ns);

  static FXbool isHidden(const FXString& file);

  static FXbool isFile(const FXString& file);

  static FXbool isLink(const FXString& file);

  static FXbool isDirectory(const FXString& file);

  static FXbool isReadable(const FXString& file);

  static FXbool isWritable(const FXString& file);

  static FXbool isExecutable(const FXString& file);

  static FXbool isOwnerReadWriteExecute(const FXString& file);

  static FXbool isOwnerReadable(const FXString& file);

  static FXbool isOwnerWritable(const FXString& file);

  static FXbool isOwnerExecutable(const FXString& file);

  static FXbool isGroupReadWriteExecute(const FXString& file);

  static FXbool isGroupReadable(const FXString& file);

  static FXbool isGroupWritable(const FXString& file);

  static FXbool isGroupExecutable(const FXString& file);

  static FXbool isOtherReadWriteExecute(const FXString& file);

  static FXbool isOtherReadable(const FXString& file);

  static FXbool isOtherWritable(const FXString& file);

  static FXbool isOtherExecutable(const FXString& file);

  static FXbool isSetUid(const FXString& file);

  static FXbool isSetGid(const FXString& file);

  static FXbool isSetSticky(const FXString& file);

  static FXbool isAccessible(const FXString& file,FXuint m=FXIO::ReadWrite);

  static FXbool isSame(const FXString& file1,const FXString& file2);
  
  static FXbool getTotalDiskSpace(const FXString& path,FXulong& space);

  static FXbool getAvailableDiskSpace(const FXString& path,FXulong& space);
  };

}

#endif