ossimFilename.h

Go to the documentation of this file.

//---
//
// License: MIT
//
// Author: Ken Melero
//
// Description: This class provides manipulation of filenames.
//
//---
// $Id$

#ifndef ossimFilename_HEADER
#define ossimFilename_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimString.h>

class ossimLocalTm;

class OSSIM_DLL ossimFilename : public ossimString
{
public:
   enum AccessModes
   {
      OSSIM_READ_WRITE = 6,
      OSSIM_READ       = 4,
      OSSIM_WRITE      = 2,
      OSSIM_EXE        = 1, // The PC docs say that this is ignored
      OSSIM_EXIST      = 0
   };
   ossimFilename();
   ossimFilename(const ossimFilename& src);
   ossimFilename(const ossimString& src);
   ossimFilename(const std::string& src);
   ossimFilename(const char* src);
   const ossimFilename& operator=(const ossimFilename& f);

   template <class Iter> ossimFilename(Iter s, Iter e);

   static const ossimFilename NIL;

   bool operator == (const ossimFilename& rhs)const;
   
   bool operator == (const ossimString& rhs)const;
   bool operator == (const char* rhs)const;

//    friend std::ostream& operator<<(std::ostream& os,
   //                                const ossimFilename& s);
   
   // void convertBackToForwardSlashes();
   // void convertForwardToBackSlashes();

   bool setTimes(ossimLocalTm* accessTime,
                 ossimLocalTm* modTime,
                 ossimLocalTm* createTime)const;
   bool getTimes(ossimLocalTm* accessTime,
                 ossimLocalTm* modTime,
                 ossimLocalTm* createTime)const;
   ossim_int64 lastAccessed() const;
   
   bool touch()const;
   
   ossimFilename expand() const;
   
   // Methods to test ossimFilename for various states.
   bool        exists()       const;
   bool        isFile()       const;
   bool        isDir()        const;
   bool        isReadable()   const;
   bool        isUrl()        const;
   bool        isWriteable()  const;
   bool        isExecutable() const;
   
   ossim_int64 fileSize()     const;
   
   // Methods to access parts of the ossimFilename.

   ossimString   ext() const;

   ossimFilename path() const;

   ossimFilename drive() const;
   
   ossimFilename file() const;

   ossimFilename fileNoExtension() const;

   ossimFilename noExtension() const;

   ossimFilename& setExtension(const ossimString& e);

   ossimFilename& setDrive(const ossimString& d);
   ossimFilename& setPath(const ossimString& p);
   ossimFilename& setFile(const ossimString& f);
   
   void split(ossimString& drivePart,
              ossimString& pathPart,
              ossimString& filePart,
              ossimString& extPart)const;
   
   void merge(const ossimString& drivePart,
              const ossimString& pathPart,
              const ossimString& filePart,
              const ossimString& extPart);
   ossimFilename dirCat(const ossimFilename& file) const;

   bool createDirectory(bool recurseFlag=true,
                        int perm=0775)const;

   static bool remove(const ossimFilename& pathname);

   static bool wildcardRemove(const ossimFilename& pathname);

   bool rename(const ossimFilename& destFile, bool overwriteDestinationFlag=true)const;
   
   bool remove()const;
   bool wildcardRemove()const;

   bool copyFileTo(const ossimFilename& outputFile) const;

   bool isRelative() const;
   
   bool needsExpansion() const;

   char getPathSeparator() const;
   
   ossimFilename& appendTimestamp();

   ossimFilename& append(const ossimString& append_this_to_filename);

   std::string native() const;

protected:

   void converPathSeparator();

   //    void convertToNative();

   static const char OSSIM_NATIVE_PATH_SEPARATOR;
   static const char OSSIM_FILENAME_PATH_SEPARATOR;
};

// inline std::ostream& operator<<(std::ostream& os, const ossimFilename& f)
// {
//   return os << f.string().c_str();
// }

#endif