- initial import of revision 374 from cnc
[apt.git] / apt-pkg / contrib / fileutl.h
1 // -*- mode: cpp; mode: fold -*-
2 // Description                                                          /*{{{*/
3 // $Id: fileutl.h,v 1.1 2002/07/23 17:54:51 niemeyer 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 #ifndef PKGLIB_FILEUTL_H
22 #define PKGLIB_FILEUTL_H
23
24 #ifdef __GNUG__
25 #pragma interface "apt-pkg/fileutl.h"
26 #endif 
27
28 #include <string>
29
30 using std::string;
31
32 class FileFd
33 {
34    protected:
35    int iFd;
36  
37    enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
38                     HitEof = (1<<3)};
39    unsigned long Flags;
40    string FileName;
41    
42    public:
43    enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,WriteTemp};
44    
45    inline bool Read(void *To,unsigned long Size,bool AllowEof)
46    {
47       unsigned long Jnk;
48       if (AllowEof)
49          return Read(To,Size,&Jnk);
50       return Read(To,Size);
51    }   
52    bool Read(void *To,unsigned long Size,unsigned long *Actual = 0);
53    bool Write(const void *From,unsigned long Size);
54    bool Seek(unsigned long To);
55    bool Skip(unsigned long To);
56    bool Truncate(unsigned long To);
57    unsigned long Tell();
58    unsigned long Size();
59    bool Open(string FileName,OpenMode Mode,unsigned long Perms = 0666);
60    bool Close();
61    bool Sync();
62    
63    // Simple manipulators
64    inline int Fd() {return iFd;};
65    inline void Fd(int fd) {iFd = fd;};
66    inline bool IsOpen() {return iFd >= 0;};
67    inline bool Failed() {return (Flags & Fail) == Fail;};
68    inline void EraseOnFailure() {Flags |= DelOnFail;};
69    inline void OpFail() {Flags |= Fail;};
70    inline bool Eof() {return (Flags & HitEof) == HitEof;};
71    inline string &Name() {return FileName;};
72    
73    FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666) : iFd(-1), 
74             Flags(0) 
75    {
76       Open(FileName,Mode,Perms);
77    };
78    FileFd(int Fd = -1) : iFd(Fd), Flags(AutoClose) {};
79    FileFd(int Fd,bool) : iFd(Fd), Flags(0) {};
80    virtual ~FileFd();
81 };
82
83 bool CopyFile(FileFd &From,FileFd &To);
84 int GetLock(string File,bool Errors = true);
85 bool FileExists(string File);
86 string SafeGetCWD();
87 void SetCloseExec(int Fd,bool Close);
88 void SetNonBlock(int Fd,bool Block);
89 bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
90 int ExecFork();
91 bool ExecWait(int Pid,const char *Name,bool Reap = false);
92
93 // File string manipulators
94 string flNotDir(string File);
95 string flNotFile(string File);
96 string flNoLink(string File);
97 string flExtension(string File);
98 string flCombine(string Dir,string File);
99
100 #endif