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 "opsysdll.h"

#include <basis/packable.h>

// forward.
class string_array;


class OPSYSTEM_CLASS_STYLE filename : public packable
{
public:
  filename();  
  filename(const istring &name);

  filename(const istring &directory, const istring &name_of_file);

  filename(const filename &to_copy);  

  virtual ~filename();

  bool good() const;

  operator const istring &() const;
  const istring &raw() const;
  istring &raw();

  filename &operator = (const filename &to_copy);
  filename &operator = (const istring &to_copy);

  // standard comparisons.
  bool operator == (const filename &that) const;
  inline bool operator != (const filename &that) const
          { return !(*this == that); }

  void canonicalize();

  bool exists() const;

  bool unlink() const;

  filename parent() const;

  istring pop();

  void push(const istring &to_push);

  filename basename() const;
  filename dirname() const;

  istring dirname(bool add_slash) const;

  bool had_directory() const { return _had_directory; }

  char drive(bool interact_with_fs = false) const;

  istring extension() const;

  istring 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;

  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 istring default_separator();

  static bool legal_character(char to_check);

  static void detooth_filename(istring &to_clean, char replacement = '_');

  void separate(string_array &pieces) const;

  void join(const string_array &pieces);

  // these implement the packing functionality.
  virtual void pack(byte_array &packed_form) const;
  virtual bool unpack(byte_array &packed_form);

  bool compare_prefix(const filename &to_compare, istring &sequel);

  bool compare_prefix(const filename &to_compare);

  bool compare_suffix(const filename &to_compare, istring &prequel);

  bool compare_suffix(const filename &to_compare);

private:
  bool _had_directory;  
  istring *_contents;  

  int find_last_separator(const istring &look_at) const;

  typedef struct stat status_info;
  bool get_info(status_info &to_fill) const;

  // helper functions do the real work for comparing.
  bool base_compare_prefix(const filename &to_compare, string_array &first,
          string_array &second);
  bool base_compare_suffix(const filename &to_compare, string_array &first,
          string_array &second);
};

#endif

---