src/support/filename.C

   1 /**
   2  * \file filename.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "support/filename.h"
  14 #include "support/filetools.h"
  15 #include "support/lstrings.h"
  16 #include "support/os.h"
  17 #include "support/qstring_helpers.h"
  18
  19 #include <QFile>
  20
  21 #include <boost/assert.hpp>
  22
  23 #include <map>
  24 #include <sstream>
  25 #include <algorithm>
  26
  27
  28 using std::map;
  29 using std::string;
  30
  31
  32 namespace lyx {
  33 namespace support {
  34
  35
  36 FileName::FileName()
  37 {}
  38
  39
  40 FileName::~FileName()
  41 {}
  42
  43
  44 FileName::FileName(string const & abs_filename)
  45         : name_(abs_filename)
  46 {
  47         BOOST_ASSERT(empty() || absolutePath(name_));
  48 #if defined(_WIN32)
  49         BOOST_ASSERT(!contains(name_, '\\'));
  50 #endif
  51 }
  52
  53
  54 void FileName::set(string const & name)
  55 {
  56         name_ = name;
  57         BOOST_ASSERT(absolutePath(name_));
  58 #if defined(_WIN32)
  59         BOOST_ASSERT(!contains(name_, '\\'));
  60 #endif
  61 }
  62
  63
  64 void FileName::erase()
  65 {
  66         name_.erase();
  67 }
  68
  69
  70 string const FileName::toFilesystemEncoding() const
  71 {
  72         QByteArray const encoded = QFile::encodeName(toqstr(name_));
  73         return string(encoded.begin(), encoded.end());
  74 }
  75
  76
  77 FileName const FileName::fromFilesystemEncoding(string const & name)
  78 {
  79         QByteArray const encoded(name.c_str(), name.length());
  80         return FileName(fromqstr(QFile::decodeName(encoded)));
  81 }
  82
  83
  84 bool operator==(FileName const & lhs, FileName const & rhs)
  85 {
  86         return lhs.absFilename() == rhs.absFilename();
  87 }
  88
  89
  90 bool operator!=(FileName const & lhs, FileName const & rhs)
  91 {
  92         return lhs.absFilename() != rhs.absFilename();
  93 }
  94
  95
  96 bool operator<(FileName const & lhs, FileName const & rhs)
  97 {
  98         return lhs.absFilename() < rhs.absFilename();
  99 }
 100
 101
 102 bool operator>(FileName const & lhs, FileName const & rhs)
 103 {
 104         return lhs.absFilename() > rhs.absFilename();
 105 }
 106
 107
 108 std::ostream & operator<<(std::ostream & os, FileName const & filename)
 109 {
 110         return os << filename.absFilename();
 111 }
 112
 113
 114 DocFileName::DocFileName()
 115         : save_abs_path_(true)
 116 {}
 117
 118
 119 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
 120         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 121 {}
 122
 123
 124 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
 125         : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
 126 {}
 127
 128
 129 void DocFileName::set(string const & name, string const & buffer_path)
 130 {
 131         save_abs_path_ = absolutePath(name);
 132         name_ = save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename();
 133         zipped_valid_ = false;
 134 }
 135
 136
 137 void DocFileName::erase()
 138 {
 139         name_.erase();
 140         zipped_valid_ = false;
 141 }
 142
 143
 144 string const DocFileName::relFilename(string const & path) const
 145 {
 146         return makeRelPath(name_, path);
 147 }
 148
 149
 150 string const DocFileName::outputFilename(string const & path) const
 151 {
 152         return save_abs_path_ ? name_ : makeRelPath(name_, path);
 153 }
 154
 155
 156 string const DocFileName::mangledFilename(std::string const & dir) const
 157 {
 158         // We need to make sure that every DocFileName instance for a given
 159         // filename returns the same mangled name.
 160         typedef map<string, string> MangledMap;
 161         static MangledMap mangledNames;
 162         MangledMap::const_iterator const it = mangledNames.find(name_);
 163         if (it != mangledNames.end())
 164                 return (*it).second;
 165
 166         // Now the real work
 167         string mname = os::internal_path(name_);
 168         // Remove the extension.
 169         mname = changeExtension(name_, string());
 170         // The mangled name must be a valid LaTeX name.
 171         // The list of characters to keep is probably over-restrictive,
 172         // but it is not really a problem.
 173         // Apart from non-ASCII characters, at least the following characters
 174         // are forbidden: '/', '.', ' ', and ':'.
 175         // On windows it is not possible to create files with '<', '>' or '?'
 176         // in the name.
 177         static string const keep = "abcdefghijklmnopqrstuvwxyz"
 178                                    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 179                                    "+,-0123456789;=";
 180         string::size_type pos = 0;
 181         while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
 182                 mname[pos++] = '_';
 183         // Add the extension back on
 184         mname = changeExtension(mname, getExtension(name_));
 185
 186         // Prepend a counter to the filename. This is necessary to make
 187         // the mangled name unique.
 188         static int counter = 0;
 189         std::ostringstream s;
 190         s << counter++ << mname;
 191         mname = s.str();
 192
 193         // MiKTeX's YAP (version 2.4.1803) crashes if the file name
 194         // is longer than about 160 characters. MiKTeX's pdflatex
 195         // is even pickier. A maximum length of 100 has been proven to work.
 196         // If dir.size() > max length, all bets are off for YAP. We truncate
 197         // the filename nevertheless, keeping a minimum of 10 chars.
 198
 199         string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
 200
 201         // If the mangled file name is too long, hack it to fit.
 202         // We know we're guaranteed to have a unique file name because
 203         // of the counter.
 204         if (mname.size() > max_length) {
 205                 int const half = (int(max_length) / 2) - 2;
 206                 if (half > 0) {
 207                         mname = mname.substr(0, half) + "___" +
 208                                 mname.substr(mname.size() - half);
 209                 }
 210         }
 211
 212         mangledNames[name_] = mname;
 213         return mname;
 214 }
 215
 216
 217 bool DocFileName::isZipped() const
 218 {
 219         if (!zipped_valid_) {
 220                 zipped_ = zippedFile(*this);
 221                 zipped_valid_ = true;
 222         }
 223         return zipped_;
 224 }
 225
 226
 227 string const DocFileName::unzippedFilename() const
 228 {
 229         return unzippedFileName(name_);
 230 }
 231
 232
 233 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
 234 {
 235         return lhs.absFilename() == rhs.absFilename() &&
 236                 lhs.saveAbsPath() == rhs.saveAbsPath();
 237 }
 238
 239
 240 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
 241 {
 242         return !(lhs == rhs);
 243 }
 244
 245 } // namespace support
 246 } // namespace lyx