]> git.saurik.com Git - apt.git/blame - apt-pkg/contrib/fileutl.h
- add --arch option for apt-ftparchive packages and contents commands
[apt.git] / apt-pkg / contrib / fileutl.h
CommitLineData
578bfd0a
AL
1// -*- mode: cpp; mode: fold -*-
2// Description /*{{{*/
233b185f 3// $Id: fileutl.h,v 1.26 2001/05/07 05:06:52 jgg Exp $
578bfd0a
AL
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 /*}}}*/
578bfd0a
AL
21#ifndef PKGLIB_FILEUTL_H
22#define PKGLIB_FILEUTL_H
23
6c139d6e 24
578bfd0a 25#include <string>
46e39c8e 26#include <vector>
578bfd0a 27
233b185f
AL
28using std::string;
29
8e06abb2 30class FileFd
578bfd0a
AL
31{
32 protected:
33 int iFd;
34
ddc1d8d0
AL
35 enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
36 HitEof = (1<<3)};
578bfd0a
AL
37 unsigned long Flags;
38 string FileName;
39
40 public:
f08fcf34 41 enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,WriteTemp};
578bfd0a 42
f604cf55
AL
43 inline bool Read(void *To,unsigned long Size,bool AllowEof)
44 {
45 unsigned long Jnk;
46 if (AllowEof)
47 return Read(To,Size,&Jnk);
48 return Read(To,Size);
49 }
50 bool Read(void *To,unsigned long Size,unsigned long *Actual = 0);
a05599f1 51 bool Write(const void *From,unsigned long Size);
578bfd0a 52 bool Seek(unsigned long To);
727f18af 53 bool Skip(unsigned long To);
6d5dd02a 54 bool Truncate(unsigned long To);
7f25bdff 55 unsigned long Tell();
578bfd0a 56 unsigned long Size();
13d87e2e 57 bool Open(string FileName,OpenMode Mode,unsigned long Perms = 0666);
578bfd0a 58 bool Close();
b2e465d6
AL
59 bool Sync();
60
578bfd0a
AL
61 // Simple manipulators
62 inline int Fd() {return iFd;};
869f717a 63 inline void Fd(int fd) {iFd = fd;};
578bfd0a
AL
64 inline bool IsOpen() {return iFd >= 0;};
65 inline bool Failed() {return (Flags & Fail) == Fail;};
66 inline void EraseOnFailure() {Flags |= DelOnFail;};
67 inline void OpFail() {Flags |= Fail;};
ddc1d8d0 68 inline bool Eof() {return (Flags & HitEof) == HitEof;};
c7b5ce1c
AL
69 inline string &Name() {return FileName;};
70
13d87e2e
AL
71 FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666) : iFd(-1),
72 Flags(0)
73 {
74 Open(FileName,Mode,Perms);
75 };
36375005 76 FileFd(int Fd = -1) : iFd(Fd), Flags(AutoClose) {};
8e06abb2
AL
77 FileFd(int Fd,bool) : iFd(Fd), Flags(0) {};
78 virtual ~FileFd();
578bfd0a
AL
79};
80
614adaa0 81bool RunScripts(const char *Cnf);
8b89e57f 82bool CopyFile(FileFd &From,FileFd &To);
578bfd0a
AL
83int GetLock(string File,bool Errors = true);
84bool FileExists(string File);
e29a6bb1 85// FIXME: next ABI-Break: merge the two method-headers
46e39c8e
MV
86std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
87 bool const &SortList);
e29a6bb1
DK
88std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
89 bool const &SortList, bool const &AllowNoExt);
90std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
91 bool const &SortList);
578bfd0a 92string SafeGetCWD();
3b5421b4
AL
93void SetCloseExec(int Fd,bool Close);
94void SetNonBlock(int Fd,bool Block);
1084d58a 95bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
75ef8f14 96pid_t ExecFork();
3826564e 97bool ExecWait(pid_t Pid,const char *Name,bool Reap = false);
578bfd0a 98
8ce4327b
AL
99// File string manipulators
100string flNotDir(string File);
d38b7b3d 101string flNotFile(string File);
421c8d10 102string flNoLink(string File);
b2e465d6
AL
103string flExtension(string File);
104string flCombine(string Dir,string File);
8ce4327b 105
578bfd0a 106#endif