src/support/FileName.h

   1 // -*- C++ -*-
   2 /**
   3  * \file FileName.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef FILENAME_H
  13 #define FILENAME_H
  14
  15 #include "support/os.h"
  16 #include "support/strfwd.h"
  17
  18 #include <ctime>
  19
  20
  21 namespace lyx {
  22 namespace support {
  23
  24 /// Defined in "FileNameList.h".
  25 class FileNameList;
  26
  27 /**
  28  * Class for storing file names.
  29  * The file name may be empty. If it is not empty it is an absolute path.
  30  * The file may or may not exist.
  31  */
  32 class FileName {
  33 public:
  34         /// Constructor for empty filenames
  35         FileName();
  36         /** Constructor for nonempty filenames.
  37          * explicit because we don't want implicit conversion of relative
  38          * paths in function arguments (e.g. of unlink).
  39          * \param abs_filename the file in question. Must have an absolute path.
  40          * Encoding is always UTF-8.
  41          */
  42         explicit FileName(std::string const & abs_filename);
  43
  44         /// copy constructor.
  45         FileName(FileName const &);
  46
  47         /// constructor with base name and suffix.
  48         FileName(FileName const & fn, std::string const & suffix);
  49
  50         ///
  51         FileName & operator=(FileName const &);
  52
  53         virtual ~FileName();
  54         /** Set a new filename.
  55          * \param filename the file in question. Must have an absolute path.
  56          * Encoding is always UTF-8.
  57          */
  58         void set(std::string const & filename);
  59         void set(FileName const & fn, std::string const & suffix);
  60         virtual void erase();
  61         /// Is this filename empty?
  62         bool empty() const;
  63         /// Is the filename absolute?
  64         static bool isAbsolute(std::string const & name);
  65
  66         /// get the absolute file name in UTF-8 encoding
  67         std::string absFileName() const;
  68
  69         /** returns an absolute pathname (whose resolution does not involve
  70           * '.', '..', or symbolic links) in UTF-8 encoding
  71           */
  72         std::string realPath() const;
  73
  74         /**
  75          * Get the file name in the encoding used by the file system.
  76          * Only use this for passing file names to external commands.
  77          * Warning: On Windows this is not unicode safe and should not
  78          * be used for accessing files with an fstream, for example.
  79          */
  80         std::string toFilesystemEncoding() const;
  81
  82         /**
  83          * Get the file name in a unicode safe encoding used by the file system.
  84          * Only use this for accessing the file with standard I/O functions
  85          * non explicitly unicode aware, e.g. with an fstream. This can also
  86          * be used for passing file names to external commands, but only if
  87          * you are sure that the stem of the name will not be used for
  88          * producing derivative files. For example, don't use this for passing
  89          * file names to LaTeX, as the stem of the .dvi file will not correspond
  90          * to the stem of the .tex file anymore.
  91          * Use os::CREATE if the file is to be accessed for writing.
  92          */
  93         std::string toSafeFilesystemEncoding(os::file_access how = os::EXISTING) const;
  94
  95         /// returns true if the file exists
  96         bool exists() const;
  97         /// refreshes the file info
  98         void refresh() const;
  99         /// \return true if this object points to a symbolic link.
 100         bool isSymLink() const;
 101         /// \return true if the file is empty.
 102         bool isFileEmpty() const;
 103         /// returns time of last write access
 104         std::time_t lastModified() const;
 105         /// generates a checksum of a file
 106         virtual unsigned long checksum() const;
 107         /// return true when file is readable but not writable
 108         bool isReadOnly() const;
 109         /// return true when it names a directory
 110         bool isDirectory() const;
 111         /// return true when directory is readable
 112         bool isReadableDirectory() const;
 113         /// return true when it is a file and readable
 114         virtual bool isReadableFile() const;
 115         /// return true when file/directory is writable
 116         bool isWritable() const;
 117         /// return true when file/directory is writable (write test file)
 118         bool isDirWritable() const;
 119         /// \return list other files in the directory having optional extension 'ext'.
 120         FileNameList dirList(std::string const & ext) const;
 121
 122         /// copy a file
 123         /// \return true when file/directory is writable (write test file)
 124         /// \warning This methods has different semantics when system level
 125         /// copy command, it will overwrite the \c target file if it exists,
 126         bool copyTo(FileName const & target) const;
 127
 128         /// remove pointed file.
 129         /// \return true on success.
 130         bool removeFile() const;
 131
 132         /// rename pointed file.
 133         /// \return false if the operation fails or if the \param target file
 134         /// already exists.
 135         /// \return true on success.
 136         bool renameTo(FileName const & target) const;
 137
 138         /// move pointed file to \param target.
 139         /// \return true on success.
 140         bool moveTo(FileName const & target) const;
 141
 142         /// change mode of pointed file.
 143         /// This methods does nothing and return true on platforms that does not
 144         /// support this.
 145         /// \return true on success.
 146         bool changePermission(unsigned long int mode) const;
 147
 148         /// remove pointed directory and all contents.
 149         /// \return true on success.
 150         bool destroyDirectory() const;
 151         /// Creates pointed directory.
 152         /// \return true on success.
 153         bool createDirectory(int permissions) const;
 154         /// Creates pointed path.
 155         /// \return true on success.
 156         bool createPath() const;
 157
 158         /// Get the contents of a file as a huge docstring.
 159         /// \param encoding defines the encoding of the file contents.
 160         /// Only four encodings are supported:
 161         /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
 162         /// current system locale.
 163         docstring fileContents(std::string const & encoding) const;
 164
 165         /// Change extension.
 166         /**
 167         * If oldname does not have an extension, it is appended.
 168         * If the extension is empty, any extension is removed from the name.
 169         */
 170         void changeExtension(std::string const & extension);
 171
 172         static FileName fromFilesystemEncoding(std::string const & name);
 173         /// Create a temporary file with the given mask.
 174         /// \p mask must be in filesystem encoding, if it contains a
 175         /// relative path, the template file will be created in the global
 176         /// temporary directory as given by 'package().temp_dir()'.
 177         /// CAUTION: This method may create race conditions.
 178         ///          Do not use, use the TempFile class instead.
 179         static FileName tempName(std::string const & mask);
 180         static FileName tempName(FileName const & temp_dir,
 181                 std::string const & mask);
 182
 183         /// get the current working directory
 184         static FileName getcwd();
 185
 186         static FileName tempPath();
 187
 188         /// filename without path
 189         std::string onlyFileName() const;
 190         /// filename without path and without extension
 191         std::string onlyFileNameWithoutExt() const;
 192         /// only extension after the last dot.
 193         std::string extension() const;
 194         /** checks if the file has the given extension
 195                 on Windows and Mac it compares case insensitive */
 196         bool hasExtension(const std::string & ext);
 197         /// path without file name
 198         FileName onlyPath() const;
 199         /// path of parent directory
 200         /// returns empty path for root directory
 201         FileName parentPath() const;
 202         /// used for display in the Gui
 203         docstring displayName(int threshold = 1000) const;
 204
 205         /// change to a directory, return success
 206         bool chdir() const;
 207
 208         /// \param buffer_path if empty, uses `pwd`
 209         docstring const relPath(std::string const & path) const;
 210
 211         docstring const absoluteFilePath() const;
 212
 213 private:
 214         friend bool equivalent(FileName const &, FileName const &);
 215         ///
 216         struct Private;
 217         Private * const d;
 218 };
 219
 220
 221 /// \return true if lhs and rhs represent the same file. E.g.,
 222 /// they might be hardlinks of one another.
 223 bool equivalent(FileName const & lhs, FileName const & rhs);
 224 /// \return true if the absolute path names are the same.
 225 bool operator==(FileName const &, FileName const &);
 226 ///
 227 bool operator!=(FileName const &, FileName const &);
 228 /// Lexically compares the absolute path names.
 229 bool operator<(FileName const &, FileName const &);
 230 /// Lexically compares the absolute path names.
 231 bool operator>(FileName const &, FileName const &);
 232 /// Writes the absolute path name to the stream.
 233 std::ostream & operator<<(std::ostream &, FileName const &);
 234
 235
 236 /**
 237  * Class for storing file names that appear in documents (e. g. child
 238  * documents, included figures etc).
 239  * The file name must not denote a file in our temporary directory, but a
 240  * file that the user chose.
 241  */
 242 class DocFileName : public FileName {
 243 public:
 244         DocFileName();
 245         /** \param abs_filename the file in question. Must have an absolute path.
 246          *  \param save_abs_path how is the filename to be output?
 247          */
 248         DocFileName(std::string const & abs_filename, bool save_abs_path = true);
 249         DocFileName(FileName const & abs_filename, bool save_abs_path = true);
 250
 251         /** \param filename the file in question. May have either a relative
 252          *  or an absolute path.
 253          *  \param buffer_path if \c filename has a relative path, generate
 254          *  the absolute path using this.
 255          */
 256         void set(std::string const & filename, std::string const & buffer_path);
 257         ///
 258         void erase();
 259         ///
 260         bool saveAbsPath() const { return save_abs_path_; }
 261         /// \param buffer_path if empty, uses `pwd`
 262         std::string relFileName(std::string const & buffer_path = empty_string()) const;
 263         /// \param buf_path if empty, uses `pwd`
 264         std::string outputFileName(std::string const & buf_path = empty_string()) const;
 265
 266         /** @returns a mangled representation of the absolute file name
 267          *  suitable for use in the temp dir when, for example, converting
 268          *  an image file to another format.
 269          *
 270          *  @param dir the directory that will contain this file with
 271          *  its mangled name. This information is used by the mangling
 272          *  algorithm when determining the maximum allowable length of
 273          *  the mangled name.
 274          *
 275          *  An example of a mangled name:
 276          *  C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
 277          *
 278          *  It is guaranteed that
 279          *  - two different filenames have different mangled names
 280          *  - two FileName instances with the same filename have identical
 281          *    mangled names.
 282          *
 283          *  Only the mangled file name is returned. It is not prepended
 284          *  with @c dir.
 285          */
 286         std::string
 287         mangledFileName(std::string const & dir = empty_string()) const;
 288
 289         /// \return the absolute file name without its .gz, .z, .Z extension
 290         std::string unzippedFileName() const;
 291
 292 private:
 293         /// Records whether we should save (or export) the filename as a relative
 294         /// or absolute path.
 295         bool save_abs_path_;
 296 };
 297
 298
 299 /// \return true if these have the same absolute path name AND
 300 /// if save_abs_path_ has the same value in both cases.
 301 bool operator==(DocFileName const &, DocFileName const &);
 302 ///
 303 bool operator!=(DocFileName const &, DocFileName const &);
 304
 305 } // namespace support
 306 } // namespace lyx
 307
 308 #endif