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