rename the newly public CheckDirectory method to CreateAPTDirectoryIfNeeded

[apt.git] / apt-pkg / contrib / fileutl.h

diff --git a/apt-pkg/contrib/fileutl.h b/apt-pkg/contrib/fileutl.h
index 0c477caf0351affef20de3733ef643ea8da9490d..419506273fe230f94bc68f02ce123ce0476275c1 100644 (file)
--- a/apt-pkg/contrib/fileutl.h
+++ b/apt-pkg/contrib/fileutl.h
@@ -1,6 +1,6 @@
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/
 // -*- mode: cpp; mode: fold -*-
 // Description                                                         /*{{{*/

-// $Id: fileutl.h,v 1.11 1998/12/08 05:24:43 jgg Exp $
+// $Id: fileutl.h,v 1.26 2001/05/07 05:06:52 jgg Exp $

 /* ######################################################################
    
    File Utilities
 /* ######################################################################
    
    File Utilities


@@ -18,58 +18,107 @@
    
    ##################################################################### */
                                                                        /*}}}*/
    
    ##################################################################### */
                                                                        /*}}}*/

-// Header section: pkglib

 #ifndef PKGLIB_FILEUTL_H
 #define PKGLIB_FILEUTL_H
 
 #ifndef PKGLIB_FILEUTL_H
 #define PKGLIB_FILEUTL_H
 

-#ifdef __GNUG__
-#pragma interface "apt-pkg/fileutl.h"
-#endif 
+#include <apt-pkg/macros.h>

 
 #include <string>
 
 #include <string>

+#include <vector>
+
+#include <zlib.h>
+
+/* Define this for python-apt */
+#define APT_HAS_GZIP 1
+
+using std::string;

 
 class FileFd
 {
    protected:
    int iFd;
  
 
 class FileFd
 {
    protected:
    int iFd;
  

-   enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2)};
+   enum LocalFlags {AutoClose = (1<<0),Fail = (1<<1),DelOnFail = (1<<2),
+                    HitEof = (1<<3), Replace = (1<<4) };

    unsigned long Flags;
    string FileName;
    unsigned long Flags;
    string FileName;

-   
+   string TemporaryFileName;
+   gzFile gz;
+

    public:
    public:

-   enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny};
+   enum OpenMode {ReadOnly,WriteEmpty,WriteExists,WriteAny,WriteTemp,ReadOnlyGzip,
+                  WriteAtomic};

    
    

-   bool Read(void *To,unsigned long Size);
+   inline bool Read(void *To,unsigned long Size,bool AllowEof)
+   {
+      unsigned long Jnk;
+      if (AllowEof)
+        return Read(To,Size,&Jnk);
+      return Read(To,Size);
+   }   
+   bool Read(void *To,unsigned long Size,unsigned long *Actual = 0);

    bool Write(const void *From,unsigned long Size);
    bool Seek(unsigned long To);
    bool Write(const void *From,unsigned long Size);
    bool Seek(unsigned long To);

+   bool Skip(unsigned long To);
+   bool Truncate(unsigned long To);
+   unsigned long Tell();

    unsigned long Size();
    unsigned long Size();

+   bool Open(string FileName,OpenMode Mode,unsigned long Perms = 0666);
+   bool OpenDescriptor(int Fd, OpenMode Mode, bool AutoClose=false);

    bool Close();
    bool Close();

-
+   bool Sync();
+   

    // Simple manipulators
    inline int Fd() {return iFd;};
    // Simple manipulators
    inline int Fd() {return iFd;};

+   inline void Fd(int fd) {iFd = fd;};

    inline bool IsOpen() {return iFd >= 0;};
    inline bool Failed() {return (Flags & Fail) == Fail;};
    inline void EraseOnFailure() {Flags |= DelOnFail;};
    inline void OpFail() {Flags |= Fail;};
    inline bool IsOpen() {return iFd >= 0;};
    inline bool Failed() {return (Flags & Fail) == Fail;};
    inline void EraseOnFailure() {Flags |= DelOnFail;};
    inline void OpFail() {Flags |= Fail;};

+   inline bool Eof() {return (Flags & HitEof) == HitEof;};

    inline string &Name() {return FileName;};
    
    inline string &Name() {return FileName;};
    

-   FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666);
-   FileFd(int Fd) : iFd(Fd), Flags(AutoClose) {};
-   FileFd(int Fd,bool) : iFd(Fd), Flags(0) {};
+   FileFd(string FileName,OpenMode Mode,unsigned long Perms = 0666) : iFd(-1), 
+            Flags(0), gz(NULL)
+   {
+      Open(FileName,Mode,Perms);
+   };
+   FileFd(int Fd = -1) : iFd(Fd), Flags(AutoClose), gz(NULL) {};
+   FileFd(int Fd,bool) : iFd(Fd), Flags(0), gz(NULL) {};

    virtual ~FileFd();
 };
 
    virtual ~FileFd();
 };
 

+bool RunScripts(const char *Cnf);

 bool CopyFile(FileFd &From,FileFd &To);
 int GetLock(string File,bool Errors = true);
 bool FileExists(string File);
 bool CopyFile(FileFd &From,FileFd &To);
 int GetLock(string File,bool Errors = true);
 bool FileExists(string File);

+bool DirectoryExists(string const &Path) __attrib_const;
+bool CreateDirectory(string const &Parent, string const &Path);
+
+/** \brief Ensure the existence of the given Path
+ *
+ *  \param Parent directory of the Path directory - a trailing
+ *  /apt/ will be removed before CreateDirectory call.
+ *  \param Path which should exist after (successful) call
+ */
+bool CreateAPTDirectoryIfNeeded(string const &Parent, string const &Path);
+
+std::vector<string> GetListOfFilesInDir(string const &Dir, string const &Ext,
+                                       bool const &SortList, bool const &AllowNoExt=false);
+std::vector<string> GetListOfFilesInDir(string const &Dir, std::vector<string> const &Ext,
+                                       bool const &SortList);

 string SafeGetCWD();
 void SetCloseExec(int Fd,bool Close);
 void SetNonBlock(int Fd,bool Block);
 string SafeGetCWD();
 void SetCloseExec(int Fd,bool Close);
 void SetNonBlock(int Fd,bool Block);

-bool WaitFd(int Fd);
+bool WaitFd(int Fd,bool write = false,unsigned long timeout = 0);
+pid_t ExecFork();
+bool ExecWait(pid_t Pid,const char *Name,bool Reap = false);

 
 // File string manipulators
 string flNotDir(string File);
 string flNotFile(string File);
 
 // File string manipulators
 string flNotDir(string File);
 string flNotFile(string File);

+string flNoLink(string File);
+string flExtension(string File);
+string flCombine(string Dir,string File);

 
 #endif
 
 #endif