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/strfwd.h"
  16
  17 #include <ctime>
  18
  19
  20 namespace lyx {
  21 namespace support {
  22
  23 /// Defined in "FileNameList.h".
  24 class FileNameList;
  25
  26 /**
  27  * Class for storing file names.
  28  * The file name may be empty. If it is not empty it is an absolute path.
  29  * The file may or may not exist.
  30  */
  31 class FileName {
  32 public:
  33         /// Constructor for empty filenames
  34         FileName();
  35         /** Constructor for nonempty filenames.
  36          * explicit because we don't want implicit conversion of relative
  37          * paths in function arguments (e.g. of unlink).
  38          * \param abs_filename the file in question. Must have an absolute path.
  39          * Encoding is always UTF-8.
  40          */
  41         explicit FileName(std::string const & abs_filename);
  42
  43         /// copy constructor.
  44         FileName(FileName const &);
  45
  46         ///
  47         FileName & operator=(FileName const &);
  48
  49         virtual ~FileName();
  50         /** Set a new filename.
  51          * \param filename the file in question. Must have an absolute path.
  52          * Encoding is always UTF-8.
  53          */
  54         virtual void set(std::string const & filename);
  55         virtual void erase();
  56         /// Is this filename empty?
  57         bool empty() const;
  58         /// get the absolute file name in UTF-8 encoding
  59         std::string absFilename() const;
  60         /**
  61          * Get the file name in the encoding used by the file system.
  62          * Only use this for accessing the file, e.g. with an fstream.
  63          */
  64         std::string toFilesystemEncoding() const;
  65
  66         /// returns true if the file exists
  67         bool exists() const;
  68         /// \return true if this object points to a symbolic link.
  69         bool isSymLink() const;
  70         /// \return true if the file is empty.
  71         bool isFileEmpty() const;
  72         /// returns time of last write access
  73         std::time_t lastModified() const;
  74         /// generates a checksum of a file
  75         unsigned long checksum() const;
  76         /// return true when file is readable but not writabel
  77         bool isReadOnly() const;
  78         /// return true when it names a directory
  79         bool isDirectory() const;
  80         /// return true when file/directory is readable
  81         bool isReadableDirectory() const;
  82         /// return true when it is a file and readable
  83         bool isReadableFile() const;
  84         /// return true when file/directory is writable
  85         bool isWritable() const;
  86         /// return true when file/directory is writable (write test file)
  87         bool isDirWritable() const;
  88         /// \return list other files in the directory having optional extension 'ext'.
  89         FileNameList dirList(std::string const & ext) const;
  90
  91         /// copy a file
  92         /// \return true when file/directory is writable (write test file)
  93         /// \warning This methods has different semantics when system level
  94         /// copy command, it will overwrite the \c target file if it exists,
  95         bool copyTo(FileName const & target) const;
  96
  97         /// remove pointed file.
  98         /// \return true on success.
  99         bool removeFile() const;
 100
 101         /// rename pointed file.
 102         /// \return false if the operation fails or if the \param target file
 103         /// already exists.
 104         /// \return true on success.
 105         bool renameTo(FileName const & target) const;
 106
 107         /// move pointed file to \param target.
 108         /// \return true on success.
 109         bool moveTo(FileName const & target) const;
 110
 111         /// change mode of pointed file.
 112         /// This methods does nothing and return true on platforms that does not
 113         /// support this.
 114         /// \return true on success.
 115         bool changePermission(unsigned long int mode) const;
 116
 117         /// remove pointed directory and all contents.
 118         /// \return true on success.
 119         bool destroyDirectory() const;
 120         /// Creates pointed directory.
 121         /// \return true on success.
 122         bool createDirectory(int permissions) const;
 123         /// Creates pointed path.
 124         /// \return true on success.
 125         bool createPath() const;
 126
 127         /// Get the contents of a file as a huge docstring.
 128         /// \param encoding defines the encoding of the file contents.
 129         /// Only four encodings are supported:
 130         /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
 131         /// current system locale.
 132         docstring fileContents(std::string const & encoding) const;
 133
 134         /// Change extension.
 135         /**
 136         * If oldname does not have an extension, it is appended.
 137         * If the extension is empty, any extension is removed from the name.
 138         */
 139         void changeExtension(std::string const & extension);
 140
 141         /** Guess the file format name (as in Format::name()) from contents.
 142          Normally you don't want to use this directly, but rather
 143          Formats::getFormatFromFile().
 144          */
 145         std::string guessFormatFromContents() const;
 146
 147         /// check for zipped file
 148         bool isZippedFile() const;
 149
 150         static FileName fromFilesystemEncoding(std::string const & name);
 151         /// (securely) create a temporary file in the given dir with the given mask
 152         /// \p mask must be in filesystem encoding
 153         static FileName tempName(FileName const & dir = FileName(),
 154                                                 std::string const & mask = empty_string());
 155
 156         /// filename without path
 157         std::string onlyFileName() const;
 158         /// path without file name
 159         FileName onlyPath() const;
 160         /// used for display in the Gui
 161         docstring displayName(int threshold = 1000) const;
 162
 163         /// change to a directory, return success
 164         bool chdir() const;
 165
 166         /// \param buffer_path if empty, uses `pwd`
 167         docstring const relPath(std::string const & path) const;
 168
 169         docstring const absoluteFilePath() const;
 170
 171 private:
 172         ///
 173         struct Private;
 174         Private * const d;
 175 };
 176
 177
 178 bool operator==(FileName const &, FileName const &);
 179 bool operator!=(FileName const &, FileName const &);
 180 bool operator<(FileName const &, FileName const &);
 181 bool operator>(FileName const &, FileName const &);
 182 std::ostream & operator<<(std::ostream &, FileName const &);
 183
 184
 185 /**
 186  * Class for storing file names that appear in documents (e. g. child
 187  * documents, included figures etc).
 188  * The file name must not denote a file in our temporary directory, but a
 189  * file that the user chose.
 190  */
 191 class DocFileName : public FileName {
 192 public:
 193         DocFileName();
 194         /** \param abs_filename the file in question. Must have an absolute path.
 195          *  \param save_abs_path how is the file to be output to file?
 196          */
 197         DocFileName(std::string const & abs_filename, bool save_abs_path = true);
 198         DocFileName(FileName const & abs_filename, bool save_abs_path = true);
 199
 200         /** \param filename the file in question. May have either a relative
 201          *  or an absolute path.
 202          *  \param buffer_path if \c filename has a relative path, generate
 203          *  the absolute path using this.
 204          */
 205         void set(std::string const & filename, std::string const & buffer_path);
 206
 207         void erase();
 208
 209         bool saveAbsPath() const { return save_abs_path_; }
 210         /// \param buffer_path if empty, uses `pwd`
 211         std::string relFilename(std::string const & buffer_path = empty_string()) const;
 212         /// \param buf_path if empty, uses `pwd`
 213         std::string outputFilename(std::string const & buf_path = empty_string()) const;
 214
 215         /** @returns a mangled representation of the absolute file name
 216          *  suitable for use in the temp dir when, for example, converting
 217          *  an image file to another format.
 218          *
 219          *  @param dir the directory that will contain this file with
 220          *  its mangled name. This information is used by the mangling
 221          *  algorithm when determining the maximum allowable length of
 222          *  the mangled name.
 223          *
 224          *  An example of a mangled name:
 225          *  C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
 226          *
 227          *  It is guaranteed that
 228          *  - two different filenames have different mangled names
 229          *  - two FileName instances with the same filename have identical
 230          *    mangled names.
 231          *
 232          *  Only the mangled file name is returned. It is not prepended
 233          *  with @c dir.
 234          */
 235         std::string
 236         mangledFilename(std::string const & dir = empty_string()) const;
 237
 238         /// \return true if the file is compressed.
 239         bool isZipped() const;
 240         /// \return the absolute file name without its .gz, .z, .Z extension
 241         std::string unzippedFilename() const;
 242
 243 private:
 244         bool save_abs_path_;
 245         /// Cache for isZipped() because zippedFile() is expensive
 246         mutable bool zipped_;
 247         /// Is zipped_ valid?
 248         mutable bool zipped_valid_;
 249 };
 250
 251
 252 bool operator==(DocFileName const &, DocFileName const &);
 253 bool operator!=(DocFileName const &, DocFileName const &);
 254
 255 } // namespace support
 256 } // namespace lyx
 257
 258 #endif