filename.h

Go to the documentation of this file.

#ifndef FILENAME_CLASS
#define FILENAME_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : filename                                                          *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1993-$now By Author.  This program is free software; 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.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/byte_array.h>
#include <basis/contracts.h>
#include <structures/string_array.h>
 
// forward declarations.
class status_info;
 
//hmmm: this doesn't really belong here, does it...
// define useful constant for filesystem path length.
#ifndef MAX_ABS_PATH 
  #ifdef __WIN32__
    #define MAX_ABS_PATH MAX_PATH
  #else
    #ifdef __APPLE__
      #include <sys/syslimits.h>
    #else
      #include <limits.h>
    #endif
    #define MAX_ABS_PATH PATH_MAX
  #endif
/*
  #ifdef __WIN32__
  // winsock support...
//  #undef FD_SETSIZE
//  #define FD_SETSIZE 1000
    // if you don't set this, you can only select on a default of 64 sockets.
  #include <winsock2.h>
    #include <windows.h>
    #define MAX_ABS_PATH MAX_PATH
  #else
    #ifdef __APPLE__
      #include <sys/syslimits.h>
    #else
      #include <limits.h>
    #endif
    #define MAX_ABS_PATH PATH_MAX
  #endif
*/
#endif
 
namespace filesystem {
 
 
class filename : public basis::astring, public virtual basis::packable
{
public:
  filename();  
  filename(const basis::astring &name);
 
  filename(const basis::astring &directory, const basis::astring &name_of_file);
 
  filename(const filename &to_copy);  
 
  DEFINE_CLASS_NAME("filename");
 
  virtual ~filename();
 
  bool good() const;
 
  void reset(const basis::astring &name);
 
  const basis::astring &raw() const;
  basis::astring &raw();
 
  filename &operator = (const filename &to_copy);
  filename &operator = (const basis::astring &to_copy);
 
  void canonicalize();
 
  bool exists() const;
 
  bool unlink() const;
 
  filename parent() const;
 
  basis::astring pop();
 
  void push(const basis::astring &to_push);
 
  filename basename() const;
  filename dirname() const;
 
  basis::astring dirname(bool add_slash) const;
 
  bool had_directory() const { return _had_directory; }
 
  char drive(bool interact_with_fs = false) const;
 
  basis::astring extension() const;
 
  basis::astring rootname() const;
 
  // status functions return true if the characteristic embodied in
  // the name is also true.
 
  bool is_directory() const;
  bool is_writable() const;
  bool is_readable() const;
  bool is_executable() const;
 
  // is_normal makes sure that the file or directory is not a named pipe or other
  // special type of file.  symbolic links are considered normal.
  bool is_normal() const;
 
  enum write_modes {
    ALLOW_NEITHER = 0x0,
    ALLOW_READ = 0x1, ALLOW_WRITE = 0x2,
    ALLOW_BOTH = ALLOW_READ | ALLOW_WRITE
  };
 
  enum ownership_modes {
    NO_RIGHTS = 0x0,
    USER_RIGHTS = 0x1, GROUP_RIGHTS = 0x2, OTHER_RIGHTS = 0x4,
    ALL_RIGHTS = USER_RIGHTS | GROUP_RIGHTS | OTHER_RIGHTS
  };
 
  bool chmod(int write_mode, int owner_mode) const;
 
 
  enum directory_separator { pc_separator = '\\', unix_separator = '/' };
 
  static bool separator(char is_it);
 
  static basis::astring default_separator();
 
  static bool legal_character(char to_check);
 
  static void detooth_filename(basis::astring &to_clean, char replacement = '_');
 
  void separate(bool &rooted, structures::string_array &pieces) const;
 
  void join(bool rooted, const structures::string_array &pieces);
 
  // these implement the packing functionality.
  virtual void pack(basis::byte_array &packed_form) const;
  virtual bool unpack(basis::byte_array &packed_form);
  virtual int packed_size() const;
 
  bool compare_prefix(const filename &to_compare, basis::astring &sequel);
 
  bool compare_prefix(const filename &to_compare);
 
  bool compare_suffix(const filename &to_compare, basis::astring &prequel);
 
  bool compare_suffix(const filename &to_compare);
 
  static basis::astring null_device();
 
private:
  bool _had_directory;  
 
  int find_last_separator(const basis::astring &look_at) const;
 
  bool get_info(status_info *to_fill) const;
 
  // helper functions do the real work for comparing.
  bool base_compare_prefix(const filename &to_compare, structures::string_array &first,
          structures::string_array &second);
  bool base_compare_suffix(const filename &to_compare, structures::string_array &first,
          structures::string_array &second);
};
 
} //namespace.
 
#endif