core/vul/vul_file.h

Go to the documentation of this file.

// This is core/vul/vul_file.h
#ifndef vul_file_h_
#define vul_file_h_
#ifdef VCL_NEEDS_PRAGMA_INTERFACE
#pragma interface
#endif
//:
// \file
// \brief A collection of miscellaneous filesystem-type utilities
// \author Andrew W. Fitzgibbon, Oxford RRG
// \date   02 Nov 98
//
// \verbatim
//  Modifications
//   981102 AWF Initial version.
//   PDA (Manchester) 21/03/2001: Tidied up the documentation
//   Feb.2002 - Peter Vanroose - brief doxygen comment placed on single line
//   Jun.2003 - Ian Scott      - added support for '\' file separator to dos version
// \endverbatim

#include <vcl_string.h>
#include <vxl_config.h>

//: A collection of miscellaneous filesystem-type utilities
//
struct vul_file
{
  //: Return current working directory
  static vcl_string get_cwd();

  //: change current working directory
  static bool change_directory(char const* dirname);
  static bool change_directory(vcl_string const& dirname) {
    return change_directory(dirname.c_str());
  }

  //: Make a writable directory.
  // You might imagine mkdir would be a better name,
  // and then you might imagine a world w/out ms.
  static bool make_directory(char const* filename);
  static bool make_directory(vcl_string const& filename) {
    return make_directory(filename.c_str());
  }

  //: Make a writable directory, including any necessary parents.
  // Returns true if successful, or if the directory already exists.
  static bool make_directory_path(char const* filename);
  static bool make_directory_path(vcl_string const& filename) {
    return make_directory_path(filename.c_str());
  }

  //: Return true iff filename is a directory.
  static bool is_directory(char const* filename);
  static bool is_directory(const vcl_string& filename) {
    return is_directory(filename.c_str());
  }

#if defined(VCL_WIN32) && !defined(__CYGWIN__)
  //: Return true iff filename is a drive, e.g., "c:" or "Z:".
  static bool is_drive(char const* filename);
  static bool is_drive(const vcl_string& filename) {
    return is_drive(filename.c_str());
  }
#endif

  //: Expand any leading ~ escapes in filename
  static vcl_string expand_tilde(char const* filename);
  static vcl_string expand_tilde(vcl_string const& filename) {
    return expand_tilde(filename.c_str());
  }

  //: Return true iff filename exists.  It may be any sort of file.
  static bool exists(char const* filename);
  static bool exists(vcl_string const& filename) {
    return exists(filename.c_str());
  }

  //: Return size of vul_file
  static unsigned long size(char const* filename);
  static unsigned long size(vcl_string filename) { return size(filename.c_str()); }

  //: Return dirname
  static vcl_string dirname(char const* filename);
  static vcl_string dirname(vcl_string const& filename) {
    return dirname(filename.c_str());
  }

  //: Return extension (including the '.').
  static vcl_string extension(char const* filename);
  static vcl_string extension(vcl_string const& filename) {
    return extension( filename.c_str() );
  }

  //: Return basename
  // Only strip specified suffix.
  static vcl_string basename(char const* filename, char const* suffix = 0);
  static vcl_string basename(vcl_string const& filename, char const* suffix = 0) {
    return basename(filename.c_str(), suffix );
  }

  //: Strips away directory of the filename
  static vcl_string strip_directory(char const* filename);
  static vcl_string strip_directory(vcl_string const &filename)
  { return strip_directory(filename.c_str()); }

  //: Strips away extension of the filename
  static vcl_string strip_extension(char const* filename);
  static vcl_string strip_extension(vcl_string const &filename)
  { return strip_extension(filename.c_str()); }

  //: Delete 1 or more files using the Local OS preferred globbing.
  // E.g. \c delete_file_glob("*"); will delete all the files in the
  // current directory on most operating systems.
  // \return true if successful.
  static bool delete_file_glob(vcl_string const& file_glob);
  static bool delete_file_glob(char const* file_glob)
  { return delete_file_glob(vcl_string(file_glob)); }


#if defined(VCL_WIN32) && VXL_USE_WIN_WCHAR_T

  //: Return current working directory
  //  This function is provided as an overloading
  static vcl_string get_cwd(char* /*dummy*/)
  { return get_cwd(); }

  //: Return current working directory
  static std::wstring get_cwd(wchar_t* dummy);

  //: change current working directory
  static bool change_directory(wchar_t const* dirname);
  static bool change_directory(std::wstring const& dirname) {
    return change_directory(dirname.c_str());
  }

  //: Make a writable directory.
  // You might imagine mkdir would be a better name,
  // and then you might imagine a world w/out ms.
  static bool make_directory(wchar_t const* filename);
  static bool make_directory(std::wstring const& filename) {
    return make_directory(filename.c_str());
  }

  //: Make a writable directory, including any necessary parents.
  // Returns true if successful, or if the directory already exists.
  static bool make_directory_path(wchar_t const* filename);
  static bool make_directory_path(std::wstring const& filename) {
    return make_directory_path(filename.c_str());
  }

  //: Return true iff filename is a directory.
  static bool is_directory(wchar_t const* filename);
  static bool is_directory(const std::wstring& filename) {
    return is_directory(filename.c_str());
  }

  //: Return true iff filename is a drive, e.g., "c:" or "Z:".
  static bool is_drive(wchar_t const* filename);
  static bool is_drive(const std::wstring& filename) {
    return is_drive(filename.c_str());
  }

  ////: Expand any leading ~ escapes in filename
  static std::wstring expand_tilde(wchar_t const* filename) {
    // ~ meaningless on win32
    return std::wstring(filename);
  }
  static std::wstring expand_tilde(std::wstring const& filename) {
    // ~ meaningless on win32
    return filename;
  }

  //: Return true iff filename exists.  It may be any sort of file.
  static bool exists(wchar_t const* filename);
  static bool exists(std::wstring const& filename) {
    return exists(filename.c_str());
  }

  ////: Return size of vul_file
  //static unsigned long size(wchar_t const* filename);
  //static unsigned long size(std::wstring filename) { return size(filename.c_str()); }

  //: Return dirname
  static std::wstring dirname(wchar_t const* filename);
  static std::wstring dirname(std::wstring const& filename) {
    return dirname(filename.c_str());
  }

  //: Return extension (including the '.').
  static std::wstring extension(wchar_t const* filename);
  static std::wstring extension(std::wstring const& filename) {
    return extension( filename.c_str() );
  }

  //: Return basename
  static std::wstring basename(wchar_t const* filename, wchar_t const* suffix = 0);
  static std::wstring basename(std::wstring const& filename, wchar_t const* suffix = 0) {
    return basename(filename.c_str(), suffix );
  }

  //: Strips away directory of the filename
  static std::wstring strip_directory(wchar_t const* filename);
  static std::wstring strip_directory(std::wstring const &filename)
  { return strip_directory(filename.c_str()); }

  //: Strips away extension of the filename
  static std::wstring strip_extension(wchar_t const* filename);
  static std::wstring strip_extension(std::wstring const &filename)
  { return strip_extension(filename.c_str()); }

#endif
};

inline bool vul_file_exists(char const *f) { return vul_file::exists(f); }
inline bool vul_file_exists(vcl_string  f) { return vul_file::exists(f); }

inline bool vul_file_is_directory(char const *f) { return vul_file::is_directory(f); }
inline bool vul_file_is_directory(vcl_string  f) { return vul_file::is_directory(f); }

inline unsigned long vul_file_size(char const *f) { return vul_file::size(f); }
inline unsigned long vul_file_size(vcl_string  f) { return vul_file::size(f); }

inline vcl_string vul_file_extension(char const *f) { return vul_file::extension(f); }
inline vcl_string vul_file_extension(vcl_string  f) { return vul_file_extension(f.c_str()); }

#endif // vul_file_h_