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/FileNameList.h"
16 #include "support/debug.h"
17 #include "support/filetools.h"
18 #include "support/lassert.h"
19 #include "support/lstrings.h"
20 #include "support/qstring_helpers.h"
21 #include "support/os.h"
22 #include "support/Package.h"
23 #include "support/qstring_helpers.h"
30 #include <QTemporaryFile>
33 #include <boost/crc.hpp>
34 #include <boost/scoped_array.hpp>
43 #ifdef HAVE_SYS_TYPES_H
44 # include <sys/types.h>
46 #ifdef HAVE_SYS_STAT_H
47 # include <sys/stat.h>
62 #if defined(HAVE_MKSTEMP) && ! defined(HAVE_DECL_MKSTEMP)
63 extern "C" int mkstemp(char *);
66 #if !defined(HAVE_MKSTEMP) && defined(HAVE_MKTEMP)
70 # ifdef HAVE_PROCESS_H
75 // Three implementations of checksum(), depending on having mmap support or not.
76 #if defined(HAVE_MMAP) && defined(HAVE_MUNMAP)
79 #endif // SUM_WITH_MMAP
83 // OK, this is ugly, but it is the only workaround I found to compile
84 // with gcc (any version) on a system which uses a non-GNU toolchain.
85 // The problem is that gcc uses a weak symbol for a particular
86 // instantiation and that the system linker usually does not
87 // understand those weak symbols (seen on HP-UX, tru64, AIX and
88 // others). Thus we force an explicit instanciation of this particular
90 template struct boost::detail::crc_table_t<32, 0x04C11DB7, true>;
95 /////////////////////////////////////////////////////////////////////
99 /////////////////////////////////////////////////////////////////////
101 struct FileName::Private
105 Private(string const & abs_filename) : fi(toqstr(abs_filename))
107 name = fromqstr(fi.absoluteFilePath());
108 fi.setCaching(fi.exists() ? true : false);
111 inline void refresh()
113 // There seems to be a bug in Qt >= 4.2.0 and < 4.5.0, that causes problems with
114 // QFileInfo::refresh() on *nix. So we recreate the object in that case.
115 #if defined(_WIN32) || (QT_VERSION >= 0x040500)
118 fi = QFileInfo(fi.absoluteFilePath());
124 bool isFilesystemEqual(QString const & lhs, QString const & rhs)
126 return QString::compare(lhs, rhs, os::isFilesystemCaseSensitive() ?
127 Qt::CaseSensitive : Qt::CaseInsensitive) == 0;
130 /// The absolute file name in UTF-8 encoding.
136 /////////////////////////////////////////////////////////////////////
140 /////////////////////////////////////////////////////////////////////
143 FileName::FileName() : d(new Private)
148 FileName::FileName(string const & abs_filename)
149 : d(abs_filename.empty() ? new Private : new Private(abs_filename))
151 //LYXERR(Debug::FILES, "FileName(" << abs_filename << ')');
152 LASSERT(empty() || isAbsolute(d->name), /**/);
156 FileName::~FileName()
162 FileName::FileName(FileName const & rhs) : d(new Private)
164 d->name = rhs.d->name;
169 FileName::FileName(FileName const & rhs, string const & suffix) : d(new Private)
175 FileName & FileName::operator=(FileName const & rhs)
179 d->name = rhs.d->name;
185 bool FileName::empty() const
187 return d->name.empty();
191 bool FileName::isAbsolute(string const & name)
193 QFileInfo fi(toqstr(name));
194 return fi.isAbsolute();
198 string FileName::absFilename() const
204 string FileName::realPath() const
206 return os::real_path(toFilesystemEncoding());
210 void FileName::set(string const & name)
212 d->fi.setFile(toqstr(name));
213 d->name = fromqstr(d->fi.absoluteFilePath());
214 //LYXERR(Debug::FILES, "FileName::set(" << name << ')');
215 LASSERT(empty() || isAbsolute(d->name), /**/);
219 void FileName::set(FileName const & rhs, string const & suffix)
221 if (!rhs.d->fi.isDir())
222 d->fi.setFile(rhs.d->fi.filePath() + toqstr(suffix));
224 d->fi.setFile(QDir(rhs.d->fi.absoluteFilePath()), toqstr(suffix));
225 d->name = fromqstr(d->fi.absoluteFilePath());
226 //LYXERR(Debug::FILES, "FileName::set(" << d->name << ')');
227 LASSERT(empty() || isAbsolute(d->name), /**/);
231 void FileName::erase()
238 bool FileName::copyTo(FileName const & name) const
240 LYXERR(Debug::FILES, "Copying " << name);
241 QFile::remove(name.d->fi.absoluteFilePath());
242 bool success = QFile::copy(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
244 LYXERR0("FileName::copyTo(): Could not copy file "
245 << *this << " to " << name);
250 bool FileName::renameTo(FileName const & name) const
252 bool success = QFile::rename(d->fi.absoluteFilePath(), name.d->fi.absoluteFilePath());
254 LYXERR0("Could not rename file " << *this << " to " << name);
259 bool FileName::moveTo(FileName const & name) const
261 QFile::remove(name.d->fi.absoluteFilePath());
263 bool success = QFile::rename(d->fi.absoluteFilePath(),
264 name.d->fi.absoluteFilePath());
266 LYXERR0("Could not move file " << *this << " to " << name);
271 bool FileName::changePermission(unsigned long int mode) const
273 #if defined (HAVE_CHMOD) && defined (HAVE_MODE_T)
274 if (::chmod(toFilesystemEncoding().c_str(), mode_t(mode)) != 0) {
275 LYXERR0("File " << *this << ": cannot change permission to "
284 string FileName::toFilesystemEncoding() const
286 // FIXME: This doesn't work on Windows for non ascii file names with Qt < 4.4.
287 // Provided that Windows package uses Qt4.4, this isn't a problem.
288 QByteArray const encoded = QFile::encodeName(d->fi.absoluteFilePath());
289 return string(encoded.begin(), encoded.end());
293 FileName FileName::fromFilesystemEncoding(string const & name)
295 QByteArray const encoded(name.c_str(), name.length());
296 return FileName(fromqstr(QFile::decodeName(encoded)));
300 bool FileName::exists() const
302 return !empty() && d->fi.exists();
306 bool FileName::isSymLink() const
308 return !empty() && d->fi.isSymLink();
312 bool FileName::isFileEmpty() const
314 LASSERT(!empty(), return true);
315 return d->fi.size() == 0;
319 bool FileName::isDirectory() const
321 return !empty() && d->fi.isDir();
325 bool FileName::isReadOnly() const
327 LASSERT(!empty(), return true);
328 return d->fi.isReadable() && !d->fi.isWritable();
332 bool FileName::isReadableDirectory() const
334 return isDirectory() && d->fi.isReadable();
338 string FileName::onlyFileName() const
340 return fromqstr(d->fi.fileName());
344 string FileName::onlyFileNameWithoutExt() const
346 return fromqstr(d->fi.completeBaseName());
350 string FileName::extension() const
352 return fromqstr(d->fi.suffix());
356 bool FileName::hasExtension(const string & ext)
358 return Private::isFilesystemEqual(d->fi.suffix(), toqstr(ext));
362 FileName FileName::onlyPath() const
367 path.d->fi.setFile(d->fi.path());
368 path.d->name = fromqstr(path.d->fi.absoluteFilePath());
373 bool FileName::isReadableFile() const
375 return !empty() && d->fi.isFile() && d->fi.isReadable();
379 bool FileName::isWritable() const
381 return !empty() && d->fi.isWritable();
385 bool FileName::isDirWritable() const
387 LASSERT(isDirectory(), return false);
388 QFileInfo tmp(QDir(d->fi.absoluteFilePath()), "lyxwritetest");
389 QTemporaryFile qt_tmp(tmp.absoluteFilePath());
391 LYXERR(Debug::FILES, "Directory " << *this << " is writable");
394 LYXERR(Debug::FILES, "Directory " << *this << " is not writable");
399 FileNameList FileName::dirList(string const & ext) const
401 FileNameList dirlist;
402 if (!isDirectory()) {
403 LYXERR0("Directory '" << *this << "' does not exist!");
407 // If the directory is specified without a trailing '/', absoluteDir()
408 // would return the parent dir, so we must use absoluteFilePath() here.
409 QDir dir = d->fi.absoluteFilePath();
414 case '.': filter = "*" + toqstr(ext); break;
415 case '*': filter = toqstr(ext); break;
416 default: filter = "*." + toqstr(ext);
418 dir.setNameFilters(QStringList(filter));
419 LYXERR(Debug::FILES, "filtering on extension "
420 << fromqstr(filter) << " is requested.");
423 QFileInfoList list = dir.entryInfoList();
424 for (int i = 0; i != list.size(); ++i) {
425 FileName fi(fromqstr(list.at(i).absoluteFilePath()));
426 dirlist.push_back(fi);
427 LYXERR(Debug::FILES, "found file " << fi);
434 static string createTempFile(QString const & mask)
436 QTemporaryFile qt_tmp(mask);
438 string const temp_file = fromqstr(qt_tmp.fileName());
439 LYXERR(Debug::FILES, "Temporary file `" << temp_file << "' created.");
442 LYXERR(Debug::FILES, "Unable to create temporary file with following template: "
443 << qt_tmp.fileTemplate());
448 FileName FileName::tempName(FileName const & temp_dir, string const & mask)
450 QFileInfo tmp_fi(QDir(temp_dir.d->fi.absoluteFilePath()), toqstr(mask));
451 LYXERR(Debug::FILES, "Temporary file in " << tmp_fi.absoluteFilePath());
452 return FileName(createTempFile(tmp_fi.absoluteFilePath()));
456 FileName FileName::tempName(string const & mask)
458 return tempName(package().temp_dir(), mask);
462 FileName FileName::getcwd()
464 // return makeAbsPath("."); would create an infinite loop
466 return FileName(fromqstr(fi.absoluteFilePath()));
470 FileName FileName::tempPath()
472 return FileName(os::internal_path(fromqstr(QDir::tempPath())));
476 time_t FileName::lastModified() const
478 // QFileInfo caches information about the file. So, in case this file has
479 // been touched between the object creation and now, we refresh the file
482 return d->fi.lastModified().toTime_t();
486 bool FileName::chdir() const
488 return QDir::setCurrent(d->fi.absoluteFilePath());
492 unsigned long FileName::checksum() const
494 unsigned long result = 0;
497 //LYXERR0("File \"" << absFilename() << "\" does not exist!");
500 // a directory may be passed here so we need to test it. (bug 3622)
502 LYXERR0('"' << absFilename() << "\" is a directory!");
506 // This is used in the debug output at the end of the method.
508 if (lyxerr.debugging(Debug::FILES))
511 #if QT_VERSION >= 0x999999
512 // First version of checksum uses Qt4.4 mmap support.
513 // FIXME: This code is not ready with Qt4.4.2,
514 // see http://bugzilla.lyx.org/show_bug.cgi?id=5293
515 // FIXME: should we check if the MapExtension extension is supported?
516 // see QAbstractFileEngine::supportsExtension() and
517 // QAbstractFileEngine::MapExtension)
518 QFile qf(fi.filePath());
519 if (!qf.open(QIODevice::ReadOnly))
521 qint64 size = fi.size();
522 uchar * ubeg = qf.map(0, size);
523 uchar * uend = ubeg + size;
524 boost::crc_32_type ucrc;
525 ucrc.process_block(ubeg, uend);
528 result = ucrc.checksum();
532 string const encoded = toFilesystemEncoding();
533 char const * file = encoded.c_str();
536 //LYXERR(Debug::FILES, "using mmap (lightning fast)");
538 int fd = open(file, O_RDONLY);
545 void * mm = mmap(0, info.st_size, PROT_READ,
547 // Some platforms have the wrong type for MAP_FAILED (compaq cxx).
548 if (mm == reinterpret_cast<void*>(MAP_FAILED)) {
553 char * beg = static_cast<char*>(mm);
554 char * end = beg + info.st_size;
556 boost::crc_32_type crc;
557 crc.process_block(beg, end);
558 result = crc.checksum();
560 munmap(mm, info.st_size);
563 #else // no SUM_WITH_MMAP
565 //LYXERR(Debug::FILES, "lyx::sum() using istreambuf_iterator (fast)");
566 ifstream ifs(file, ios_base::in | ios_base::binary);
570 istreambuf_iterator<char> beg(ifs);
571 istreambuf_iterator<char> end;
572 boost::crc_32_type crc;
573 crc = for_each(beg, end, crc);
574 result = crc.checksum();
576 #endif // SUM_WITH_MMAP
579 LYXERR(Debug::FILES, "Checksumming \"" << absFilename() << "\" "
580 << result << " lasted " << t.elapsed() << " ms.");
585 bool FileName::removeFile() const
587 bool const success = QFile::remove(d->fi.absoluteFilePath());
589 if (!success && exists())
590 LYXERR0("Could not delete file " << *this);
595 static bool rmdir(QFileInfo const & fi)
597 QDir dir(fi.absoluteFilePath());
598 QFileInfoList list = dir.entryInfoList();
600 for (int i = 0; i != list.size(); ++i) {
601 if (list.at(i).fileName() == ".")
603 if (list.at(i).fileName() == "..")
606 if (list.at(i).isDir()) {
607 LYXERR(Debug::FILES, "Removing dir "
608 << fromqstr(list.at(i).absoluteFilePath()));
609 removed = rmdir(list.at(i));
612 LYXERR(Debug::FILES, "Removing file "
613 << fromqstr(list.at(i).absoluteFilePath()));
614 removed = dir.remove(list.at(i).fileName());
618 LYXERR0("Could not delete "
619 << fromqstr(list.at(i).absoluteFilePath()));
622 QDir parent = fi.absolutePath();
623 success &= parent.rmdir(fi.fileName());
628 bool FileName::destroyDirectory() const
630 bool const success = rmdir(d->fi);
632 LYXERR0("Could not delete " << *this);
638 // Only used in non Win32 platforms
639 static int mymkdir(char const * pathname, unsigned long int mode)
641 // FIXME: why don't we have mode_t in lyx::mkdir prototype ??
643 # if MKDIR_TAKES_ONE_ARG
645 return ::mkdir(pathname);
646 // FIXME: "Permissions of created directories are ignored on this system."
649 return ::mkdir(pathname, mode_t(mode));
651 #elif defined(_WIN32)
653 return CreateDirectory(pathname, 0) != 0 ? 0 : -1;
654 // FIXME: "Permissions of created directories are ignored on this system."
656 return ::_mkdir(pathname);
657 // FIXME: "Permissions of created directories are ignored on this system."
659 # error "Don't know how to create a directory on this system."
665 bool FileName::createDirectory(int permission) const
667 LASSERT(!empty(), return false);
669 // FIXME: "Permissions of created directories are ignored on this system."
672 return mymkdir(toFilesystemEncoding().c_str(), permission) == 0;
677 bool FileName::createPath() const
679 LASSERT(!empty(), return false);
680 LYXERR(Debug::FILES, "creating path '" << *this << "'.");
685 bool success = dir.mkpath(d->fi.absoluteFilePath());
687 LYXERR0("Cannot create path '" << *this << "'!");
692 docstring const FileName::absoluteFilePath() const
694 return qstring_to_ucs4(d->fi.absoluteFilePath());
698 docstring FileName::displayName(int threshold) const
700 return makeDisplayPath(absFilename(), threshold);
704 docstring FileName::fileContents(string const & encoding) const
706 if (!isReadableFile()) {
707 LYXERR0("File '" << *this << "' is not redable!");
711 QFile file(d->fi.absoluteFilePath());
712 if (!file.open(QIODevice::ReadOnly)) {
713 LYXERR0("File '" << *this
714 << "' could not be opened in read only mode!");
717 QByteArray contents = file.readAll();
720 if (contents.isEmpty()) {
721 LYXERR(Debug::FILES, "File '" << *this
722 << "' is either empty or some error happened while reading it.");
727 if (encoding.empty() || encoding == "UTF-8")
728 s = QString::fromUtf8(contents.data());
729 else if (encoding == "ascii")
730 s = QString::fromAscii(contents.data());
731 else if (encoding == "local8bit")
732 s = QString::fromLocal8Bit(contents.data());
733 else if (encoding == "latin1")
734 s = QString::fromLatin1(contents.data());
736 return qstring_to_ucs4(s);
740 void FileName::changeExtension(string const & extension)
742 // FIXME: use Qt native methods...
743 string const oldname = absFilename();
744 string::size_type const last_slash = oldname.rfind('/');
745 string::size_type last_dot = oldname.rfind('.');
746 if (last_dot < last_slash && last_slash != string::npos)
747 last_dot = string::npos;
750 // Make sure the extension starts with a dot
751 if (!extension.empty() && extension[0] != '.')
752 ext= '.' + extension;
756 set(oldname.substr(0, last_dot) + ext);
760 string FileName::guessFormatFromContents() const
762 // the different filetypes and what they contain in one of the first lines
763 // (dots are any characters). (Herbert 20020131)
766 // EPS %!PS-Adobe-3.0 EPSF...
773 // PBM P1... or P4 (B/W)
774 // PGM P2... or P5 (Grayscale)
775 // PPM P3... or P6 (color)
776 // PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
777 // SGI \001\332... (decimal 474)
779 // TIFF II... or MM...
781 // XPM /* XPM */ sometimes missing (f.ex. tgif-export)
782 // ...static char *...
783 // XWD \000\000\000\151 (0x00006900) decimal 105
785 // GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
786 // ZIP PK... http://www.halyava.ru/document/ind_arch.htm
787 // Z \037\235 UNIX compress
790 if (empty() || !isReadableFile())
793 ifstream ifs(toFilesystemEncoding().c_str());
795 // Couldn't open file...
799 static string const gzipStamp = "\037\213";
802 static string const zipStamp = "PK";
805 static string const compressStamp = "\037\235";
807 // Maximum strings to read
808 int const max_count = 50;
813 bool firstLine = true;
814 while ((count++ < max_count) && format.empty()) {
816 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
817 << "\tFile type not recognised before EOF!");
822 string const stamp = str.substr(0, 2);
823 if (firstLine && str.size() >= 2) {
824 // at first we check for a zipped file, because this
825 // information is saved in the first bytes of the file!
826 // also some graphic formats which save the information
827 // in the first line, too.
828 if (prefixIs(str, gzipStamp)) {
831 } else if (stamp == zipStamp) {
834 } else if (stamp == compressStamp) {
838 } else if (stamp == "BM") {
841 } else if (stamp == "\001\332") {
845 // Don't need to use str.at(0), str.at(1) because
846 // we already know that str.size() >= 2
847 } else if (str[0] == 'P') {
863 } else if ((stamp == "II") || (stamp == "MM")) {
866 } else if (prefixIs(str,"%TGIF")) {
869 } else if (prefixIs(str,"#FIG")) {
872 } else if (prefixIs(str,"GIF")) {
875 } else if (str.size() > 3) {
876 int const c = ((str[0] << 24) & (str[1] << 16) &
877 (str[2] << 8) & str[3]);
888 else if (contains(str,"EPSF"))
889 // dummy, if we have wrong file description like
890 // %!PS-Adobe-2.0EPSF"
893 else if (contains(str, "Grace"))
896 else if (contains(str, "JFIF"))
899 else if (contains(str, "%PDF"))
902 else if (contains(str, "PNG"))
905 else if (contains(str, "%!PS-Adobe")) {
908 if (contains(str,"EPSF"))
914 else if (contains(str, "_bits[]"))
917 else if (contains(str, "XPM") || contains(str, "static char *"))
920 else if (contains(str, "BITPIX"))
924 // Dia knows also compressed form
925 if ((format == "gzip") && (!compare_ascii_no_case(extension(), "dia")))
928 if (!format.empty()) {
929 LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
933 LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
934 << "\tCouldn't find a known format!");
939 bool FileName::isZippedFile() const
941 string const type = guessFormatFromContents();
942 return contains("gzip zip compress", type) && !type.empty();
946 docstring const FileName::relPath(string const & path) const
949 return makeRelPath(absoluteFilePath(), from_utf8(path));
953 // Note: According to Qt, QFileInfo::operator== is undefined when
954 // both files do not exist (Qt4.5 gives true for all non-existent
955 // files, while Qt4.4 compares the filenames).
957 // http://www.qtsoftware.com/developer/task-tracker/
958 // index_html?id=248471&method=entry.
959 bool equivalent(FileName const & l, FileName const & r)
961 // FIXME: In future use Qt.
962 // Qt 4.4: We need to solve this warning from Qt documentation:
963 // * Long and short file names that refer to the same file on Windows are
964 // treated as if they referred to different files.
965 // This is supposed to be fixed for Qt5.
966 FileName const lhs(os::internal_path(l.absFilename()));
967 FileName const rhs(os::internal_path(r.absFilename()));
970 // QFileInfo::operator==() returns false if the two QFileInfo are empty.
974 // Avoid unnecessary checks below.
980 if (!lhs.d->fi.isSymLink() && !rhs.d->fi.isSymLink()) {
981 // Qt already checks if the filesystem is case sensitive or not.
982 // see note above why the extra check with fileName is needed.
983 return lhs.d->fi == rhs.d->fi
984 && lhs.d->fi.fileName() == rhs.d->fi.fileName();
987 // FIXME: When/if QFileInfo support symlink comparison, remove this code.
988 QFileInfo fi1(lhs.d->fi);
990 fi1 = QFileInfo(fi1.symLinkTarget());
991 QFileInfo fi2(rhs.d->fi);
993 fi2 = QFileInfo(fi2.symLinkTarget());
994 // see note above why the extra check with fileName is needed.
995 return fi1 == fi2 && fi1.fileName() == fi2.fileName();
999 bool operator==(FileName const & lhs, FileName const & rhs)
1001 return os::isFilesystemCaseSensitive()
1002 ? lhs.absFilename() == rhs.absFilename()
1003 : !QString::compare(toqstr(lhs.absFilename()),
1004 toqstr(rhs.absFilename()), Qt::CaseInsensitive);
1008 bool operator!=(FileName const & lhs, FileName const & rhs)
1010 return !(operator==(lhs, rhs));
1014 bool operator<(FileName const & lhs, FileName const & rhs)
1016 return lhs.absFilename() < rhs.absFilename();
1020 bool operator>(FileName const & lhs, FileName const & rhs)
1022 return lhs.absFilename() > rhs.absFilename();
1026 ostream & operator<<(ostream & os, FileName const & filename)
1028 return os << filename.absFilename();
1032 /////////////////////////////////////////////////////////////////////
1036 /////////////////////////////////////////////////////////////////////
1039 DocFileName::DocFileName()
1040 : save_abs_path_(true)
1044 DocFileName::DocFileName(string const & abs_filename, bool save_abs)
1045 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
1049 DocFileName::DocFileName(FileName const & abs_filename, bool save_abs)
1050 : FileName(abs_filename), save_abs_path_(save_abs), zipped_valid_(false)
1054 void DocFileName::set(string const & name, string const & buffer_path)
1056 save_abs_path_ = isAbsolute(name);
1058 FileName::set(name);
1060 FileName::set(makeAbsPath(name, buffer_path).absFilename());
1061 zipped_valid_ = false;
1065 void DocFileName::erase()
1068 zipped_valid_ = false;
1072 string DocFileName::relFilename(string const & path) const
1075 return to_utf8(relPath(path));
1079 string DocFileName::outputFilename(string const & path) const
1081 return save_abs_path_ ? absFilename() : relFilename(path);
1085 string DocFileName::mangledFilename(string const & dir) const
1087 // We need to make sure that every DocFileName instance for a given
1088 // filename returns the same mangled name.
1089 typedef map<string, string> MangledMap;
1090 static MangledMap mangledNames;
1091 MangledMap::const_iterator const it = mangledNames.find(absFilename());
1092 if (it != mangledNames.end())
1093 return (*it).second;
1095 string const name = absFilename();
1096 // Now the real work
1097 string mname = os::internal_path(name);
1098 // Remove the extension.
1099 mname = support::changeExtension(name, string());
1100 // The mangled name must be a valid LaTeX name.
1101 // The list of characters to keep is probably over-restrictive,
1102 // but it is not really a problem.
1103 // Apart from non-ASCII characters, at least the following characters
1104 // are forbidden: '/', '.', ' ', and ':'.
1105 // On windows it is not possible to create files with '<', '>' or '?'
1107 static string const keep = "abcdefghijklmnopqrstuvwxyz"
1108 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1110 string::size_type pos = 0;
1111 while ((pos = mname.find_first_not_of(keep, pos)) != string::npos)
1113 // Add the extension back on
1114 mname = support::changeExtension(mname, getExtension(name));
1116 // Prepend a counter to the filename. This is necessary to make
1117 // the mangled name unique.
1118 static int counter = 0;
1120 s << counter++ << mname;
1123 // MiKTeX's YAP (version 2.4.1803) crashes if the file name
1124 // is longer than about 160 characters. MiKTeX's pdflatex
1125 // is even pickier. A maximum length of 100 has been proven to work.
1126 // If dir.size() > max length, all bets are off for YAP. We truncate
1127 // the filename nevertheless, keeping a minimum of 10 chars.
1129 string::size_type max_length = max(100 - ((int)dir.size() + 1), 10);
1131 // If the mangled file name is too long, hack it to fit.
1132 // We know we're guaranteed to have a unique file name because
1134 if (mname.size() > max_length) {
1135 int const half = (int(max_length) / 2) - 2;
1137 mname = mname.substr(0, half) + "___" +
1138 mname.substr(mname.size() - half);
1142 mangledNames[absFilename()] = mname;
1147 bool DocFileName::isZipped() const
1149 if (!zipped_valid_) {
1150 zipped_ = isZippedFile();
1151 zipped_valid_ = true;
1157 string DocFileName::unzippedFilename() const
1159 return unzippedFileName(absFilename());
1163 bool operator==(DocFileName const & lhs, DocFileName const & rhs)
1165 return static_cast<FileName const &>(lhs)
1166 == static_cast<FileName const &>(rhs)
1167 && lhs.saveAbsPath() == rhs.saveAbsPath();
1171 bool operator!=(DocFileName const & lhs, DocFileName const & rhs)
1173 return !(lhs == rhs);
1176 } // namespace support