nucleus/library/filesystem/filename.h

   1 #ifndef FILENAME_CLASS
   2 #define FILENAME_CLASS
   3
   4 /*****************************************************************************\
   5 *                                                                             *
   6 *  Name   : filename                                                          *
   7 *  Author : Chris Koeritz                                                     *
   8 *                                                                             *
   9 *******************************************************************************
  10 * Copyright (c) 1993-$now By Author.  This program is free software; you can  *
  11 * redistribute it and/or modify it under the terms of the GNU General Public  *
  12 * License as published by the Free Software Foundation; either version 2 of   *
  13 * the License or (at your option) any later version.  This is online at:      *
  14 *     http://www.fsf.org/copyleft/gpl.html                                    *
  15 * Please send any updates to: fred@gruntose.com                               *
  16 \*****************************************************************************/
  17
  18 #include <basis/astring.h>
  19 #include <basis/byte_array.h>
  20 #include <basis/contracts.h>
  21 #include <structures/string_array.h>
  22
  23 // forward declarations.
  24 class status_info;
  25
  26 //hmmm: this doesn't really belong here, does it...
  27 // define useful constant for filesystem path length.
  28 #ifndef MAX_ABS_PATH
  29   #ifdef __WIN32__
  30   // winsock support...
  31 //  #undef FD_SETSIZE
  32 //  #define FD_SETSIZE 1000
  33     // if you don't set this, you can only select on a default of 64 sockets.
  34   #include <winsock2.h>
  35     #include <windows.h>
  36     #define MAX_ABS_PATH MAX_PATH
  37   #else
  38     #ifdef __APPLE__
  39       #include <sys/syslimits.h>
  40     #else
  41       #include <limits.h>
  42     #endif
  43     #define MAX_ABS_PATH PATH_MAX
  44   #endif
  45 #endif
  46
  47
  48 namespace filesystem {
  49
  50 //! Provides operations commonly needed on file names.
  51
  52 class filename : public basis::astring, public virtual basis::packable
  53 {
  54 public:
  55   filename();  //!< blank constructor.
  56   filename(const basis::astring &name);
  57     //!< creates a filename from any part of a full pathname, if possible.
  58     /*!< if the name contains quotes, they are stripped out. */
  59   filename(const basis::astring &directory, const basis::astring &name_of_file);
  60     //!< constructs a filename from a "directory" and the "name_of_file".
  61     /*!< the "name_of_file" can itself be a directory. */
  62   filename(const filename &to_copy);  //!< copy constructor.
  63
  64   DEFINE_CLASS_NAME("filename");
  65
  66   virtual ~filename();
  67
  68   bool good() const;
  69     //!< returns true if the filename seems to be valid.
  70     /*!< this means that not only was the pathname parsed and found valid,
  71     but the file actually exists. */
  72
  73   void reset(const basis::astring &name);
  74     //!< changes the file name held by the object.
  75
  76   const basis::astring &raw() const;
  77     //!< returns the astring that we're holding onto for the path.
  78   basis::astring &raw();
  79     //!< accesses the astring that we're holding onto for the path.
  80     /*!< important note: if you change the string with this non-const raw()
  81     method, you MUST call canonicalize() on it again afterwards. */
  82
  83   filename &operator = (const filename &to_copy);
  84     //!< provides assignment for this object, plus a simple string.
  85   filename &operator = (const basis::astring &to_copy);
  86     //!< provides assignment for this object, plus a simple string.
  87     /*!< the latter version invokes canonicalize to clean the string up. */
  88
  89   void canonicalize();
  90     //!< cleans up the filename as needed for the current operating system.
  91     /*!< reforms the name by replacing any alternate directory separators with
  92     the operating system's preferred character. */
  93
  94   bool exists() const;
  95     //!< returns true if the file exists.
  96
  97   bool unlink() const;
  98     //!< actually removes the file, if possible.
  99     /*!< if the file was successfully deleted, then true is returned. */
 100
 101   filename parent() const;
 102     //!< returns the parent filename for this one.
 103
 104   basis::astring pop();
 105     //!< removes the deepest component of the pathname.
 106     /*!< the component might be a file or directory name, but popping beyond
 107     the top-level directory will not succeed.  the returned string contains
 108     the component that was removed.  it will be a blank string if nothing
 109     could be popped. */
 110
 111   void push(const basis::astring &to_push);
 112     //!< pushes a new filename onto the current pathname.
 113     /*!< this only makes sense as a real pathname if this is currently a
 114     directory name and the component "to_push" is a child of that directory
 115     (or one intends to create that component as a child).  this is the
 116     opposite of pop. */
 117
 118   filename basename() const;
 119     //!< returns the base of the filename; no directory.
 120   filename dirname() const;
 121     //!< returns the directory for the filename.
 122     /*!< if no directory name can be found in the filename, then "." is
 123     returned. */
 124   basis::astring dirname(bool add_slash) const;
 125     //!< returns the directory for the filename and optionally adds a slash.
 126     /*!< if "add_slash" is true, then the default directory separator will be
 127     present on the end of the string. */
 128   bool had_directory() const { return _had_directory; }
 129     //!< returns true if the name that we were given had a non-empty directory.
 130     /*!< this allows one to distinguish between a file with the current
 131     directory (.) attached and a file with no directory specified. */
 132
 133   char drive(bool interact_with_fs = false) const;
 134     //!< returns the drive letter for the file, without the colon.
 135     /*!< this only makes sense for a fully qualified MS-DOS style name.  if no
 136     drive letter is found, then '\0' is returned.  if "interact_with_fs" is
 137     true, then the file system will be checked for the actual drive if no
 138     drive letter was found in the contents. */
 139
 140   basis::astring extension() const;
 141     //!< returns the extension for the file, if one is present.
 142
 143   basis::astring rootname() const;
 144     //!< returns the root part of the basename without an extension.
 145
 146   // status functions return true if the characteristic embodied in
 147   // the name is also true.
 148
 149   bool is_directory() const;
 150   bool is_writable() const;
 151   bool is_readable() const;
 152   bool is_executable() const;
 153
 154   // is_normal makes sure that the file or directory is not a named pipe or other
 155   // special type of file.  symbolic links are considered normal.
 156   bool is_normal() const;
 157
 158   enum write_modes {
 159     ALLOW_NEITHER = 0x0,
 160     ALLOW_READ = 0x1, ALLOW_WRITE = 0x2,
 161     ALLOW_BOTH = ALLOW_READ | ALLOW_WRITE
 162   };
 163
 164   enum ownership_modes {
 165     NO_RIGHTS = 0x0,
 166     USER_RIGHTS = 0x1, GROUP_RIGHTS = 0x2, OTHER_RIGHTS = 0x4,
 167     ALL_RIGHTS = USER_RIGHTS | GROUP_RIGHTS | OTHER_RIGHTS
 168   };
 169
 170   bool chmod(int write_mode, int owner_mode) const;
 171     //!< changes the access rights on the file.
 172
 173   //! the default separator for directories per operating system.
 174   /*! the PC uses the backward slash to separate file and directory names from
 175   each other, while Unix uses the forward slash. */
 176   enum directory_separator { pc_separator = '\\', unix_separator = '/' };
 177
 178   static bool separator(char is_it);
 179     //!< returns true if the character "is_it" in question is a separator.
 180
 181   static basis::astring default_separator();
 182     //!< returns the default separator character for this OS.
 183
 184   static bool legal_character(char to_check);
 185     //!< returns true if "to_check" is a valid character in a filename.
 186     /*!< this does not consider separator characters; it only looks at the
 187     the name components.  also, it is appropriate for the union of the
 188     operating systems we support. */
 189
 190   static void detooth_filename(basis::astring &to_clean, char replacement = '_');
 191     //!< takes any known illegal file system characters out of "to_clean".
 192     /*!< this prepares "to_clean" for use as a component in a larger filename
 193     by ensuring that the file system will not reject the name (as long as a
 194     suitable directory path is prepended to the name and permissions allow
 195     the file to be created or accessed).  the "replacement" is used as the
 196     character that is substituted instead of illegal characters. */
 197
 198   void separate(bool &rooted, structures::string_array &pieces) const;
 199     //!< breaks the filename into its component parts.
 200     /*!< this returns an array containing the component names for the path in
 201     this filename object.  if the "rooted" flag is set to true, then the path
 202     was absolute (i.e. started at '/' in unix.  this notion is not needed for
 203     dos/windoze, as the first component will be something like 'a:'). */
 204
 205   void join(bool rooted, const structures::string_array &pieces);
 206     //!< undoes a separate() operation to get the filename back.
 207     /*!< "this" is set to a filename made from each of the "pieces".  if there
 208     are any directory separators inside the pieces themselves, then they will
 209     be removed by canonicalize().  if separate() said the path was rooted,
 210     then join needs to be told that. */
 211
 212   // these implement the packing functionality.
 213   virtual void pack(basis::byte_array &packed_form) const;
 214   virtual bool unpack(basis::byte_array &packed_form);
 215   virtual int packed_size() const;
 216
 217   bool compare_prefix(const filename &to_compare, basis::astring &sequel);
 218     //!< examines "this" filename to see if it's a prefix of "to_compare".
 219     /*!< this returns true if all of "this" is the same as the first portion
 220     of "to_compare".  that is, if "this" is a prefix of "to_compare", then
 221     true is returned.  this will always fail if there are fewer components in
 222     "to_compare".  it will always succeed if the two filenames are identical.
 223     on success, the "sequel" is set to the portion of "to_compare" that's
 224     not included in this filename. */
 225
 226   bool compare_prefix(const filename &to_compare);
 227     //!< this simpler form doesn't bother with computing the sequel.
 228
 229   bool compare_suffix(const filename &to_compare, basis::astring &prequel);
 230     //!< compares the back end of a filename to this.
 231     /*!< this is similar to compare_prefix() but it checks to see if the
 232     back end of "this" filename is the same as "to_compare".  if "this" is
 233     longer than "to_compare", then failure occurs.  only if all of the bits
 234     in "this" are seen in the back of "to_compare" is true returned. */
 235
 236   bool compare_suffix(const filename &to_compare);
 237
 238   static basis::astring null_device();
 239     //!< returns the name for the black hole device that consumes all input, i.e. /dev/null.
 240
 241 private:
 242   bool _had_directory;  //!< true if _some_ directory was specified on init.
 243 ///  basis::astring *_contents;  //!< the full path is held here.
 244
 245   int find_last_separator(const basis::astring &look_at) const;
 246     //!< locates the last separator character in the filename.
 247
 248   bool get_info(status_info *to_fill) const;
 249     //!< returns information for the filename.
 250
 251   // helper functions do the real work for comparing.
 252   bool base_compare_prefix(const filename &to_compare, structures::string_array &first,
 253           structures::string_array &second);
 254   bool base_compare_suffix(const filename &to_compare, structures::string_array &first,
 255           structures::string_array &second);
 256 };
 257
 258 } //namespace.
 259
 260 #endif
 261