apt-pkg/contrib/fileutl.h

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: fileutl.h,v 1.9 1998/11/23 07:03:07 jgg Exp $
   4 /* ######################################################################
   5
   6    File Utilities
   7
   8    CopyFile - Buffered copy of a single file
   9    GetLock - dpkg compatible lock file manipulation (fcntl)
  10    FileExists - Returns true if the file exists
  11    SafeGetCWD - Returns the CWD in a string with overrun protection
  12
  13    The file class is a handy abstraction for various functions+classes
  14    that need to accept filenames.
  15
  16    This source is placed in the Public Domain, do with it what you will
  17    It was originally written by Jason Gunthorpe.
  18
  19    ##################################################################### */
  20                                                                         /*}}}*/
  21 // Header section: pkglib
  22 #ifndef PKGLIB_FILEUTL_H
  23 #define PKGLIB_FILEUTL_H
  24
  25 #ifdef __GNUG__
  26 #pragma interface "apt-pkg/fileutl.h"
  27 #endif
  28
  29 #include <string>
  30
  31 class FileFd
  32 {
  33    protected:
  34    int iFd;
  35
  36    enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2)};
  37    unsigned long Flags;
  38    string FileName;
  39
  40    public:
  41    enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny};
  42
  43    bool Read(void *To,unsigned long Size);
  44    bool Write(void *From,unsigned long Size);
  45    bool Seek(unsigned long To);
  46    unsigned long Size();
  47    bool Close();
  48
  49    // Simple manipulators
  50    inline int Fd() {return iFd;};
  51    inline bool IsOpen() {return iFd >= 0;};
  52    inline bool Failed() {return (Flags & Fail) == Fail;};
  53    inline void EraseOnFailure() {Flags |= DelOnFail;};
  54    inline void OpFail() {Flags |= Fail;};
  55
  56    FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666);
  57    FileFd(int Fd) : iFd(Fd), Flags(AutoClose) {};
  58    FileFd(int Fd,bool) : iFd(Fd), Flags(0) {};
  59    virtual ~FileFd();
  60 };
  61
  62 bool CopyFile(FileFd &From,FileFd &To);
  63 int GetLock(string File,bool Errors = true);
  64 bool FileExists(string File);
  65 string SafeGetCWD();
  66 void SetCloseExec(int Fd,bool Close);
  67 void SetNonBlock(int Fd,bool Block);
  68 bool WaitFd(int Fd);
  69
  70 // File string manipulators
  71 string flNotDir(string File);
  72 string flNotFile(string File);
  73
  74 #endif