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         /// \param overwrite: set to true if we should erase the \c target
  94         /// file if it exists,
  95         bool copyTo(FileName const & target, bool overwrite = false) const;
  96
  97         /// remove pointed file.
  98         /// \retrun true on success.
  99         bool removeFile() const;
 100
 101         /// rename pointed file.
 102         /// \retrun true on success.
 103         bool renameTo(FileName const & target) const;
 104
 105
 106         /// remove directory and all contents, returns true on success
 107         bool destroyDirectory() const;
 108         /// Creates directory. Returns true on success
 109         bool createDirectory(int permissions) const;
 110
 111         /// Get the contents of a file as a huge docstring.
 112         /// \param encoding defines the encoding of the file contents.
 113         /// Only four encodings are supported:
 114         /// "UTF-8", "ascii", "latin1" and "local8bit" which uses the
 115         /// current system locale.
 116         docstring fileContents(std::string const & encoding) const;
 117
 118         /// Change extension.
 119         /**
 120         * If oldname does not have an extension, it is appended.
 121         * If the extension is empty, any extension is removed from the name.
 122         */
 123         void changeExtension(std::string const & extension);
 124
 125         /** Guess the file format name (as in Format::name()) from contents.
 126          Normally you don't want to use this directly, but rather
 127          Formats::getFormatFromFile().
 128          */
 129         std::string guessFormatFromContents() const;
 130
 131         /// check for zipped file
 132         bool isZippedFile() const;
 133
 134         static FileName fromFilesystemEncoding(std::string const & name);
 135         /// (securely) create a temporary file in the given dir with the given mask
 136         /// \p mask must be in filesystem encoding
 137         static FileName tempName(FileName const & dir = FileName(),
 138                                                 std::string const & mask = empty_string());
 139
 140         /// filename without path
 141         std::string onlyFileName() const;
 142         /// path without file name
 143         FileName onlyPath() const;
 144         /// used for display in the Gui
 145         docstring displayName(int threshold = 1000) const;
 146
 147         /// change to a directory, return success
 148         bool chdir() const;
 149
 150         /// \param buffer_path if empty, uses `pwd`
 151         docstring const relPath(std::string const & path) const;
 152
 153         docstring const absoluteFilePath() const;
 154
 155 private:
 156         ///
 157         struct Private;
 158         Private * const d;
 159 };
 160
 161
 162 bool operator==(FileName const &, FileName const &);
 163 bool operator!=(FileName const &, FileName const &);
 164 bool operator<(FileName const &, FileName const &);
 165 bool operator>(FileName const &, FileName const &);
 166 std::ostream & operator<<(std::ostream &, FileName const &);
 167
 168
 169 /**
 170  * Class for storing file names that appear in documents (e. g. child
 171  * documents, included figures etc).
 172  * The file name must not denote a file in our temporary directory, but a
 173  * file that the user chose.
 174  */
 175 class DocFileName : public FileName {
 176 public:
 177         DocFileName();
 178         /** \param abs_filename the file in question. Must have an absolute path.
 179          *  \param save_abs_path how is the file to be output to file?
 180          */
 181         DocFileName(std::string const & abs_filename, bool save_abs_path = true);
 182         DocFileName(FileName const & abs_filename, bool save_abs_path = true);
 183
 184         /** \param filename the file in question. May have either a relative
 185          *  or an absolute path.
 186          *  \param buffer_path if \c filename has a relative path, generate
 187          *  the absolute path using this.
 188          */
 189         void set(std::string const & filename, std::string const & buffer_path);
 190
 191         void erase();
 192
 193         bool saveAbsPath() const { return save_abs_path_; }
 194         /// \param buffer_path if empty, uses `pwd`
 195         std::string relFilename(std::string const & buffer_path = empty_string()) const;
 196         /// \param buf_path if empty, uses `pwd`
 197         std::string outputFilename(std::string const & buf_path = empty_string()) const;
 198
 199         /** @returns a mangled representation of the absolute file name
 200          *  suitable for use in the temp dir when, for example, converting
 201          *  an image file to another format.
 202          *
 203          *  @param dir the directory that will contain this file with
 204          *  its mangled name. This information is used by the mangling
 205          *  algorithm when determining the maximum allowable length of
 206          *  the mangled name.
 207          *
 208          *  An example of a mangled name:
 209          *  C:/foo bar/baz.eps -> 0C__foo_bar_baz.eps
 210          *
 211          *  It is guaranteed that
 212          *  - two different filenames have different mangled names
 213          *  - two FileName instances with the same filename have identical
 214          *    mangled names.
 215          *
 216          *  Only the mangled file name is returned. It is not prepended
 217          *  with @c dir.
 218          */
 219         std::string
 220         mangledFilename(std::string const & dir = empty_string()) const;
 221
 222         /// \return true if the file is compressed.
 223         bool isZipped() const;
 224         /// \return the absolute file name without its .gz, .z, .Z extension
 225         std::string unzippedFilename() const;
 226
 227 private:
 228         bool save_abs_path_;
 229         /// Cache for isZipped() because zippedFile() is expensive
 230         mutable bool zipped_;
 231         /// Is zipped_ valid?
 232         mutable bool zipped_valid_;
 233 };
 234
 235
 236 bool operator==(DocFileName const &, DocFileName const &);
 237 bool operator!=(DocFileName const &, DocFileName const &);
 238
 239 } // namespace support
 240 } // namespace lyx
 241
 242 #endif