ufile.hpp

/************************************************************************
 *
 *  ufile.hpp
 *  Ubit GUI Toolkit - Version 6
 *  (C) 2009 | Eric Lecolinet | TELECOM ParisTech | http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE :
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 * YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU
 * GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION;
 * EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************/

#ifndef _ufile_hpp_
#define _ufile_hpp_ 1
#include <vector>
#include <ubit/unode.hpp>
namespace ubit {
  
  /* ==================================================== ======== ======= */
  struct UFileStat {
    enum {
      UnknownType   = -5,
      MiscError     = -4,
      NoMemory      = -3,
      InvalidData   = -2,
      CannotOpen    = -1,
      NotOpened     =  0,
      Opened        =  1
    };
  };
  
  typedef UFileStat UFilestat;
  
  /* ==================================================== ======== ======= */
  class UFileMode {
  public:
    UFileMode(const UStr& pathname);
    
    bool isValid() const;
    bool isDir()  const;
    bool isFile() const;
    bool isLink() const;
    bool isExec() const;
    
    static const int DIR, FILE, LINK; 
    int getMode() const {return mode;}
    
  protected:
    UFileMode() {}
    int mode;  //mode_t mode;
  };
  
  /* ==================================================== ======== ======= */
  class UFileInfo : public UFileMode {
  public:
    UFileInfo(const UStr& path);
    
    UFileInfo(const char* fullpath, const char* fname);  
    
    void setPath(const UStr& path);
    
    const UStr* getFileName() const {return pname;}
    
    unsigned long getSize() const {return size;}
    //< returns the size of the file.
    
    unsigned long getModTime() const {return modtime;}
    //< returns the time when file data was last modified.
    
    UIma& getIconImage() const;
    UIma& getMiniIconImage() const;
    void getInfoString(UStr& str) const;
    
    enum PrefixType {LOCAL, SSH, HTTP, FTP};  
    static int parsePrefix(const UStr& path);
    
  protected:
    friend class UFileDir;
    friend class UFilebox;
    unsigned long size;
    unsigned long modtime;
    uptr<UStr> pname;
    void stat(const char* path);
  };
  
  typedef std::vector<UFileInfo*> UFileInfos;
  
  /* ==================================================== ======== ======= */
  class UFileDir {
  public:
    UFileDir();
    UFileDir(const UStr& path);
    virtual ~UFileDir();
    
    void read(const UStr& path);
    void read(const UStr& path, const UStr& prefix, const UStr& filter, bool with_dot_files);
    void readRemote(const UStr& path, const UStr& prefix, const UStr& filter, bool with_dot_files);
    const UStr& getPath() const;
    const UFileInfos& getFileInfos() const {return file_infos;}
    
    static void expandDirPath(UStr& dirpath);
    
    // - - - Impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  private:
    friend class UIconbox;
    UFileInfo dir_info;
    UFileInfos file_infos;
    std::vector<UStr*> filters;
    static bool compareEntries(const UFileInfo*, const UFileInfo*);  
    static void parseFilter(std::vector<UStr*>& filters, const UStr& filter);
  };
  
  /* ==================================================== ======== ======= */
  class UFileCache {
  public:
    static void createCache();
    static void cleanCache();
    
    static const UStr& getCachePath();
    
    static UStr* createFullPath(const UStr& path);
    //  expands ~, ssh:, http:, ftp:.
    
    static const UStr* getOrCreateFullPath(const UStr& path);
    // same as createFullPath() but fullpath may be shared with path
    
    static bool getCachePath(const UStr& url, int path_type,
                             UStr& server, UStr& path, UStr& cachepath);
  protected:
    static UStr cache;
  };
  
}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */