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