git.saurik.com Git - apt.git/blame_incremental

... / ...

Commit	Line	Data
	1	// -- mode: cpp; mode: fold --
	2	// Description /{{{/
	3	// $Id: fileutl.h,v 1.26 2001/05/07 05:06:52 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	#ifndef PKGLIB_FILEUTL_H
	22	#define PKGLIB_FILEUTL_H
	23
	24	#include <apt-pkg/macros.h>
	25
	26	#include <string>
	27	#include <vector>
	28
	29	#include <zlib.h>
	30
	31	/* Define this for python-apt */
	32	#define APT_HAS_GZIP 1
	33
	34	using std::string;
	35
	36	class FileFd
	37	{
	38	protected:
	39	int iFd;
	40
	41	enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
	42	HitEof = (1<<3), Replace = (1<<4) };
	43	unsigned long Flags;
	44	string FileName;
	45	string TemporaryFileName;
	46	gzFile gz;
	47
	48	public:
	49	enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,WriteTemp,ReadOnlyGzip,
	50	WriteAtomic};
	51
	52	inline bool Read(void *To,unsigned long Size,bool AllowEof)
	53	{
	54	unsigned long Jnk;
	55	if (AllowEof)
	56	return Read(To,Size,&Jnk);
	57	return Read(To,Size);
	58	}
	59	bool Read(void To,unsigned long Size,unsigned long Actual = 0);
	60	bool Write(const void *From,unsigned long Size);
	61	bool Seek(unsigned long To);
	62	bool Skip(unsigned long To);
	63	bool Truncate(unsigned long To);
	64	unsigned long Tell();
	65	unsigned long Size();
	66	bool Open(string FileName,OpenMode Mode,unsigned long Perms = 0666);
	67	bool OpenDescriptor(int Fd, OpenMode Mode, bool AutoClose=false);
	68	bool Close();
	69	bool Sync();
	70
	71	// Simple manipulators
	72	inline int Fd() {return iFd;};
	73	inline void Fd(int fd) {iFd = fd;};
	74	inline bool IsOpen() {return iFd >= 0;};
	75	inline bool Failed() {return (Flags & Fail) == Fail;};
	76	inline void EraseOnFailure() {Flags \|= DelOnFail;};
	77	inline void OpFail() {Flags \|= Fail;};
	78	inline bool Eof() {return (Flags & HitEof) == HitEof;};
	79	inline string &Name() {return FileName;};
	80
	81	FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666) : iFd(-1),
	82	Flags(0), gz(NULL)
	83	{
	84	Open(FileName,Mode,Perms);
	85	};
	86	FileFd(int Fd = -1) : iFd(Fd), Flags(AutoClose), gz(NULL) {};
	87	FileFd(int Fd,bool) : iFd(Fd), Flags(0), gz(NULL) {};
	88	virtual ~FileFd();
	89	};
	90
	91	bool RunScripts(const char *Cnf);
	92	bool CopyFile(FileFd &From,FileFd &To);
	93	int GetLock(string File,bool Errors = true);
	94	bool FileExists(string File);
	95	bool DirectoryExists(string const &Path) __attrib_const;
	96	bool CreateDirectory(string const &Parent, string const &Path);
	97	std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
	98	bool const &SortList, bool const &AllowNoExt=false);
	99	std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
	100	bool const &SortList);
	101	string SafeGetCWD();
	102	void SetCloseExec(int Fd,bool Close);
	103	void SetNonBlock(int Fd,bool Block);
	104	bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
	105	pid_t ExecFork();
	106	bool ExecWait(pid_t Pid,const char *Name,bool Reap = false);
	107
	108	// File string manipulators
	109	string flNotDir(string File);
	110	string flNotFile(string File);
	111	string flNoLink(string File);
	112	string flExtension(string File);
	113	string flCombine(string Dir,string File);
	114
	115	#endif