3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
8 * Full author contact details are available in file CREDITS.
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"
22 #include <boost/filesystem/exception.hpp>
23 #include <boost/filesystem/operations.hpp>
37 /////////////////////////////////////////////////////////////////////
41 /////////////////////////////////////////////////////////////////////
44 FileName::FileName(string const & abs_filename)
47 BOOST_ASSERT(empty() || absolutePath(name_));
49 BOOST_ASSERT(!contains(name_, '\\'));
54 void FileName::set(string const & name)
57 BOOST_ASSERT(absolutePath(name_));
59 BOOST_ASSERT(!contains(name_, '\\'));
64 void FileName::erase()
70 string const FileName::toFilesystemEncoding() const
72 QByteArray const encoded = QFile::encodeName(toqstr(name_));
73 return string(encoded.begin(), encoded.end());
77 FileName const FileName::fromFilesystemEncoding(string const & name)
79 QByteArray const encoded(name.c_str(), name.length());
80 return FileName(fromqstr(QFile::decodeName(encoded)));
84 bool FileName::exists() const
86 return QFileInfo(toqstr(name_)).exists();
90 bool FileName::isReadOnly() const
92 QFileInfo const fi(toqstr(name_));
93 return fi.isReadable() && !fi.isWritable();
97 std::time_t FileName::lastModified() const
99 return boost::filesystem::last_write_time(toFilesystemEncoding());
103 bool operator==(FileName const & lhs, FileName const & rhs)
105 return lhs.absFilename() == rhs.absFilename();
109 bool operator!=(FileName const & lhs, FileName const & rhs)
111 return lhs.absFilename() != rhs.absFilename();
115 bool operator<(FileName const & lhs, FileName const & rhs)
117 return lhs.absFilename() < rhs.absFilename();
121 bool operator>(FileName const & lhs, FileName const & rhs)
123 return lhs.absFilename() > rhs.absFilename();
127 std::ostream & operator<<(std::ostream & os, FileName const & filename)
129 return os << filename.absFilename();
133 /////////////////////////////////////////////////////////////////////
137 /////////////////////////////////////////////////////////////////////
140 DocFileName::DocFileName()
141 : save_abs_path_(true)
145 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
146 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
150 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
151 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
155 void DocFileName::set(string const & name, string const & buffer_path)
157 save_abs_path_ = absolutePath(name);
158 name_ = save_abs_path_ ? name : makeAbsPath(name, buffer_path).absFilename();
159 zipped_valid_ = false;
163 void DocFileName::erase()
166 zipped_valid_ = false;
170 string const DocFileName::relFilename(string const & path) const
173 return to_utf8(makeRelPath(from_utf8(name_), from_utf8(path)));
177 string const DocFileName::outputFilename(string const & path) const
180 return save_abs_path_ ? name_ : to_utf8(makeRelPath(from_utf8(name_), from_utf8(path)));
184 string const DocFileName::mangledFilename(std::string const & dir) const
186 // We need to make sure that every DocFileName instance for a given
187 // filename returns the same mangled name.
188 typedef map<string, string> MangledMap;
189 static MangledMap mangledNames;
190 MangledMap::const_iterator const it = mangledNames.find(name_);
191 if (it != mangledNames.end())
195 string mname = os::internal_path(name_);
196 // Remove the extension.
197 mname = changeExtension(name_, string());
198 // The mangled name must be a valid LaTeX name.
199 // The list of characters to keep is probably over-restrictive,
200 // but it is not really a problem.
201 // Apart from non-ASCII characters, at least the following characters
202 // are forbidden: '/', '.', ' ', and ':'.
203 // On windows it is not possible to create files with '<', '>' or '?'
205 static string const keep = "abcdefghijklmnopqrstuvwxyz"
206 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
208 string::size_type pos = 0;
209 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
211 // Add the extension back on
212 mname = changeExtension(mname, getExtension(name_));
214 // Prepend a counter to the filename. This is necessary to make
215 // the mangled name unique.
216 static int counter = 0;
217 std::ostringstream s;
218 s << counter++ << mname;
221 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
222 // is longer than about 160 characters. MiKTeX's pdflatex
223 // is even pickier. A maximum length of 100 has been proven to work.
224 // If dir.size() > max length, all bets are off for YAP. We truncate
225 // the filename nevertheless, keeping a minimum of 10 chars.
227 string::size_type max_length = std::max(100 - ((int)dir.size() + 1), 10);
229 // If the mangled file name is too long, hack it to fit.
230 // We know we're guaranteed to have a unique file name because
232 if (mname.size() > max_length) {
233 int const half = (int(max_length) / 2) - 2;
235 mname = mname.substr(0, half) + "___" +
236 mname.substr(mname.size() - half);
240 mangledNames[name_] = mname;
245 bool DocFileName::isZipped() const
247 if (!zipped_valid_) {
248 zipped_ = zippedFile(*this);
249 zipped_valid_ = true;
255 string const DocFileName::unzippedFilename() const
257 return unzippedFileName(name_);
261 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
263 return lhs.absFilename() == rhs.absFilename() &&
264 lhs.saveAbsPath() == rhs.saveAbsPath();
268 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
270 return !(lhs == rhs);
273 } // namespace support