]> git.lyx.org Git - lyx.git/blobdiff - src/Format.cpp
Account for old versions of Pygments
[lyx.git] / src / Format.cpp
index 8e31a1e96bded7db0958f57b71a275a3b37a3f97..4a33eb07c49e97c80ef4548979b00029500c9dc4 100644 (file)
@@ -22,6 +22,8 @@
 #include "support/filetools.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
+#include "support/mutex.h"
+#include "support/docstream.h"
 #include "support/os.h"
 #include "support/PathChanger.h"
 #include "support/Systemcall.h"
@@ -32,7 +34,7 @@
 #include <map>
 #include <ctime>
 
-// FIXME: Q_WS_MACX is not available, it's in Qt
+// FIXME: Q_OS_MAC is not available, it's in Qt
 #ifdef USE_MACOSX_PACKAGING
 #include "support/linkback/LinkBackProxy.h"
 #endif
@@ -100,33 +102,22 @@ private:
 };
 
 
-class FormatPrettyNameEqual : public unary_function<Format, bool> {
-public:
-       FormatPrettyNameEqual(string const & prettyname)
-               : prettyname_(prettyname)
-       {}
-       bool operator()(Format const & f) const
-       {
-               return f.prettyname() == prettyname_;
-       }
-private:
-       string prettyname_;
-};
-
 } //namespace anon
 
 bool Format::formatSorter(Format const * lhs, Format const * rhs)
 {
-       return _(lhs->prettyname()) < _(rhs->prettyname());
+       return compare_locale(translateIfPossible(lhs->prettyname()),
+                             translateIfPossible(rhs->prettyname())) < 0;
 }
 
 bool operator<(Format const & a, Format const & b)
 {
-       return _(a.prettyname()) < _(b.prettyname());
+       return compare_locale(translateIfPossible(a.prettyname()),
+                             translateIfPossible(b.prettyname())) < 0;
 }
 
 
-Format::Format(string const & n, string const & e, string const & p,
+Format::Format(string const & n, string const & e, docstring const & p,
               string const & s, string const & v, string const & ed,
               string const & m, int flags)
        : name_(n), prettyname_(p), shortcut_(s), viewer_(v),
@@ -181,9 +172,9 @@ void Format::setExtensions(string const & e)
 Format const * Formats::getFormat(string const & name) const
 {
        FormatList::const_iterator cit =
-               find_if(formatlist.begin(), formatlist.end(),
+               find_if(formatlist_.begin(), formatlist_.end(),
                        FormatNamesEqual(name));
-       if (cit != formatlist.end())
+       if (cit != formatlist_.end())
                return &(*cit);
        else
                return 0;
@@ -206,7 +197,7 @@ string guessFormatFromContents(FileName const & fn)
        // FIG  #FIG...
        // FITS ...BITPIX...
        // GIF  GIF...
-       // JPG  JFIF
+       // JPG  \377\330...     (0xFFD8)
        // PDF  %PDF-...
        // PNG  .PNG...
        // PBM  P1... or P4     (B/W)
@@ -246,6 +237,10 @@ string guessFormatFromContents(FileName const & fn)
        // compress
        static string const compressStamp = "\037\235";
 
+       // DOS binary EPS according to Adobe TN-5002
+       static string const binEPSStamp = "\xC5\xD0\xD3\xC6";
+
+
        // Maximum strings to read
        int const max_count = 50;
        int count = 0;
@@ -253,12 +248,12 @@ string guessFormatFromContents(FileName const & fn)
        string str;
        string format;
        bool firstLine = true;
-       while ((count++ < max_count) && format.empty()) {
-               if (ifs.eof()) {
-                       LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
-                               << "\tFile type not recognised before EOF!");
+       bool backslash = false;
+       bool maybelatex = false;
+       int dollars = 0;
+       while ((count++ < max_count) && format.empty() && !maybelatex) {
+               if (ifs.eof())
                        break;
-               }
 
                getline(ifs, str);
                string const stamp = str.substr(0, 2);
@@ -281,8 +276,13 @@ string guessFormatFromContents(FileName const & fn)
                        } else if (stamp == "BM") {
                                format =  "bmp";
 
+                       } else if (stamp == "\377\330") {
+                               format =  "jpg";
+
                        } else if (stamp == "\001\332") {
                                format =  "sgi";
+                       } else if (prefixIs(str, binEPSStamp)) {
+                               format =  "eps";
 
                        // PBM family
                        // Don't need to use str.at(0), str.at(1) because
@@ -336,9 +336,6 @@ string guessFormatFromContents(FileName const & fn)
                else if (contains(str, "Grace"))
                        format = "agr";
 
-               else if (contains(str, "JFIF"))
-                       format = "jpg";
-
                else if (contains(str, "%PDF"))
                        // autodetect pdf format for graphics inclusion
                        format = "pdf6";
@@ -363,9 +360,34 @@ string guessFormatFromContents(FileName const & fn)
 
                else if (contains(str, "BITPIX"))
                        format = "fits";
+
+               else if (contains(str, "\\documentclass") ||
+                        contains(str, "\\chapter") ||
+                        contains(str, "\\section") ||
+                        contains(str, "\\begin") ||
+                        contains(str, "\\end") ||
+                        contains(str, "$$") ||
+                        contains(str, "\\[") ||
+                        contains(str, "\\]"))
+                       maybelatex = true;
+               else {
+                       if (contains(str, '\\'))
+                               backslash = true;
+                       dollars += count_char(str, '$');
+                       if (backslash && dollars > 1)
+                               // inline equation
+                               maybelatex = true;
+               }
        }
 
-       if (!format.empty()) {
+       if (format.empty() && maybelatex && !isBinaryFile(fn))
+               format = "latex";
+
+       if (format.empty()) {
+               if (ifs.eof())
+                       LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
+                              "\tFile type not recognised before EOF!");
+       } else {
                LYXERR(Debug::GRAPHICS, "Recognised Fileformat: " << format);
                return format;
        }
@@ -383,50 +405,89 @@ string Formats::getFormatFromFile(FileName const & filename) const
        if (filename.empty())
                return string();
 
+       string psformat;
+       string format;
 #ifdef HAVE_MAGIC_H
        if (filename.exists()) {
                magic_t magic_cookie = magic_open(MAGIC_MIME);
                if (magic_cookie) {
-                       string format;
                        if (magic_load(magic_cookie, NULL) != 0) {
                                LYXERR(Debug::GRAPHICS, "Formats::getFormatFromFile\n"
                                        << "\tCouldn't load magic database - "
                                        << magic_error(magic_cookie));
                        } else {
-                               string mime = magic_file(magic_cookie,
+                               char const * result = magic_file(magic_cookie,
                                        filename.toFilesystemEncoding().c_str());
-                               mime = token(mime, ';', 0);
-                               // we need our own ps/eps detection
-                               if ((mime != "application/postscript") && (mime != "text/plain")) {
+                               string mime;
+                               if (result)
+                                       mime = token(result, ';', 0);
+                               else {
+                                       LYXERR(Debug::GRAPHICS, "Formats::getFormatFromFile\n"
+                                               << "\tCouldn't query magic database - "
+                                               << magic_error(magic_cookie));
+                               }
+                               // our own detection is better for binary files (can be anything)
+                               // and different plain text formats
+                               if (!mime.empty() && mime != "application/octet-stream" &&
+                                   mime != "text/plain") {
                                        Formats::const_iterator cit =
-                                               find_if(formatlist.begin(), formatlist.end(),
+                                               find_if(formatlist_.begin(), formatlist_.end(),
                                                        FormatMimeEqual(mime));
-                                       if (cit != formats.end()) {
+                                       if (cit != formatlist_.end()) {
                                                LYXERR(Debug::GRAPHICS, "\tgot format from MIME type: "
                                                        << mime << " -> " << cit->name());
-                                               format = cit->name();
+                                               // See special eps/ps handling below
+                                               if (mime == "application/postscript")
+                                                       psformat = cit->name();
+                                               else
+                                                       format = cit->name();
                                        }
                                }
                        }
                        magic_close(magic_cookie);
-                       if (!format.empty())
+                       // libmagic recognizes as latex also some formats of ours
+                       // such as pstex and pdftex. Therefore we have to perform
+                       // additional checks in this case (bug 9244).
+                       if (!format.empty() && format != "latex")
                                return format;
                }
        }
 #endif
 
-       string const format = guessFormatFromContents(filename);
        string const ext = getExtension(filename.absFileName());
-       if (isZippedFileFormat(format) && !ext.empty()) {
-               string const & fmt_name = formats.getFormatFromExtension(ext);
-               if (!fmt_name.empty()) {
-                       Format const * p_format = formats.getFormat(fmt_name);
-                       if (p_format && p_format->zippedNative())
-                               return p_format->name();
+       if (format.empty()) {
+               // libmagic does not distinguish eps and ps.
+               // Therefore we need to use our own detection here, but only if it
+               // recognizes either ps or eps. Otherwise the libmagic guess will
+               // be better (bug 9146).
+               format = guessFormatFromContents(filename);
+               if (!psformat.empty()) {
+                       if (isPostScriptFileFormat(format))
+                               return format;
+                       else
+                               return psformat;
+               }
+
+               if (isZippedFileFormat(format) && !ext.empty()) {
+                       string const & fmt_name = getFormatFromExtension(ext);
+                       if (!fmt_name.empty()) {
+                               Format const * p_format = getFormat(fmt_name);
+                               if (p_format && p_format->zippedNative())
+                                       return p_format->name();
+                       }
                }
+               // Don't simply return latex (bug 9244).
+               if (!format.empty() && format != "latex")
+                       return format;
+       }
+
+       // Both libmagic and our guessing from contents may return as latex
+       // also lyx files and our pstex and pdftex formats. In this case we
+       // give precedence to the format determined by the extension.
+       if (format == "latex") {
+               format = getFormatFromExtension(ext);
+               return format.empty() ? "latex" : format;
        }
-       if (!format.empty())
-               return format;
 
        // try to find a format from the file extension.
        return getFormatFromExtension(ext);
@@ -439,9 +500,9 @@ string Formats::getFormatFromExtension(string const & ext) const
                // this is ambigous if two formats have the same extension,
                // but better than nothing
                Formats::const_iterator cit =
-                       find_if(formatlist.begin(), formatlist.end(),
+                       find_if(formatlist_.begin(), formatlist_.end(),
                                FormatExtensionsEqual(ext));
-               if (cit != formats.end()) {
+               if (cit != formatlist_.end()) {
                        LYXERR(Debug::GRAPHICS, "\twill guess format from file extension: "
                                << ext << " -> " << cit->name());
                        return cit->name();
@@ -451,19 +512,6 @@ string Formats::getFormatFromExtension(string const & ext) const
 }
 
 
-string Formats::getFormatFromPrettyName(string const & prettyname) const
-{
-       if (!prettyname.empty()) {
-               Formats::const_iterator cit =
-                       find_if(formatlist.begin(), formatlist.end(),
-                               FormatPrettyNameEqual(prettyname));
-               if (cit != formats.end())
-                       return cit->name();
-       }
-       return string();
-}
-
-
 /// Used to store last timestamp of file and whether it is (was) zipped
 struct ZippedInfo {
        bool zipped;
@@ -475,14 +523,20 @@ struct ZippedInfo {
 
 /// Mapping absolute pathnames of files to their ZippedInfo metadata.
 static std::map<std::string, ZippedInfo> zipped_;
+static Mutex zipped_mutex;
 
 
 bool Formats::isZippedFile(support::FileName const & filename) const {
        string const & fname = filename.absFileName();
        time_t timestamp = filename.lastModified();
+       Mutex::Locker lock(&zipped_mutex);
        map<string, ZippedInfo>::iterator it = zipped_.find(fname);
        if (it != zipped_.end() && it->second.timestamp == timestamp)
                return it->second.zipped;
+       // FIXME perf: This very expensive function is called on startup on each
+       // file whic is going to be parsed, and also on svgz icons. Maybe there is a
+       // quicker way to check whether a file is zipped?  I.e. for icons we
+       // probably just need to check the extension (svgz vs svg).
        string const & format = getFormatFromFile(filename);
        bool zipped = (format == "gzip" || format == "zip");
        zipped_.insert(make_pair(fname, ZippedInfo(zipped, timestamp)));
@@ -523,8 +577,8 @@ static string fixCommand(string const & cmd, string const & ext,
 
 void Formats::setAutoOpen()
 {
-       FormatList::iterator fit = formatlist.begin();
-       FormatList::iterator const fend = formatlist.end();
+       FormatList::iterator fit = formatlist_.begin();
+       FormatList::iterator const fend = formatlist_.end();
        for ( ; fit != fend ; ++fit) {
                fit->setViewer(fixCommand(fit->viewer(), fit->extension(), os::VIEW));
                fit->setEditor(fixCommand(fit->editor(), fit->extension(), os::EDIT));
@@ -535,10 +589,10 @@ void Formats::setAutoOpen()
 int Formats::getNumber(string const & name) const
 {
        FormatList::const_iterator cit =
-               find_if(formatlist.begin(), formatlist.end(),
+               find_if(formatlist_.begin(), formatlist_.end(),
                        FormatNamesEqual(name));
-       if (cit != formatlist.end())
-               return distance(formatlist.begin(), cit);
+       if (cit != formatlist_.end())
+               return distance(formatlist_.begin(), cit);
        else
                return -1;
 }
@@ -547,21 +601,21 @@ int Formats::getNumber(string const & name) const
 void Formats::add(string const & name)
 {
        if (!getFormat(name))
-               add(name, name, name, string(), string(), string(),
+               add(name, name, from_utf8(name), string(), string(), string(),
                    string(), Format::document);
 }
 
 
 void Formats::add(string const & name, string const & extensions,
-                 string const & prettyname, string const & shortcut,
+                 docstring const & prettyname, string const & shortcut,
                  string const & viewer, string const & editor,
                  string const & mime, int flags)
 {
        FormatList::iterator it =
-               find_if(formatlist.begin(), formatlist.end(),
+               find_if(formatlist_.begin(), formatlist_.end(),
                        FormatNamesEqual(name));
-       if (it == formatlist.end())
-               formatlist.push_back(Format(name, extensions, prettyname,
+       if (it == formatlist_.end())
+               formatlist_.push_back(Format(name, extensions, prettyname,
                                            shortcut, viewer, editor, mime, flags));
        else
                *it = Format(name, extensions, prettyname, shortcut, viewer,
@@ -572,16 +626,16 @@ void Formats::add(string const & name, string const & extensions,
 void Formats::erase(string const & name)
 {
        FormatList::iterator it =
-               find_if(formatlist.begin(), formatlist.end(),
+               find_if(formatlist_.begin(), formatlist_.end(),
                        FormatNamesEqual(name));
-       if (it != formatlist.end())
-               formatlist.erase(it);
+       if (it != formatlist_.end())
+               formatlist_.erase(it);
 }
 
 
 void Formats::sort()
 {
-       std::sort(formatlist.begin(), formatlist.end());
+       std::sort(formatlist_.begin(), formatlist_.end());
 }
 
 
@@ -589,9 +643,9 @@ void Formats::setViewer(string const & name, string const & command)
 {
        add(name);
        FormatList::iterator it =
-               find_if(formatlist.begin(), formatlist.end(),
+               find_if(formatlist_.begin(), formatlist_.end(),
                        FormatNamesEqual(name));
-       if (it != formatlist.end())
+       if (it != formatlist_.end())
                it->setViewer(command);
 }
 
@@ -600,9 +654,9 @@ void Formats::setEditor(string const & name, string const & command)
 {
        add(name);
        FormatList::iterator it =
-               find_if(formatlist.begin(), formatlist.end(),
+               find_if(formatlist_.begin(), formatlist_.end(),
                        FormatNamesEqual(name));
-       if (it != formatlist.end())
+       if (it != formatlist_.end())
                it->setEditor(command);
 }
 
@@ -641,7 +695,7 @@ bool Formats::view(Buffer const & buffer, FileName const & filename,
                }
        }
 
-       string command = libScriptSearch(format->viewer());
+       string command = format->viewer();
 
        if (format_name == "dvi" &&
            !lyxrc.view_dvi_paper_option.empty()) {
@@ -658,8 +712,10 @@ bool Formats::view(Buffer const & buffer, FileName const & filename,
        if (!contains(command, token_from_format))
                command += ' ' + token_from_format;
 
-       command = subst(command, token_from_format, quoteName(onlyFileName(filename.toFilesystemEncoding())));
-       command = subst(command, token_path_format, quoteName(onlyPath(filename.toFilesystemEncoding())));
+       command = subst(command, token_from_format,
+                       quoteName(onlyFileName(filename.toFilesystemEncoding()), quote_shell_filename));
+       command = subst(command, token_path_format,
+                       quoteName(onlyPath(filename.toFilesystemEncoding()), quote_shell_filename));
        command = subst(command, token_socket_format, quoteName(theServerSocket().address()));
        LYXERR(Debug::FILES, "Executing command: " << command);
        // FIXME UNICODE utf8 can be wrong for files
@@ -667,7 +723,8 @@ bool Formats::view(Buffer const & buffer, FileName const & filename,
 
        PathChanger p(filename.onlyPath());
        Systemcall one;
-       one.startscript(Systemcall::DontWait, command, buffer.filePath());
+       one.startscript(Systemcall::DontWait, command,
+                       buffer.filePath(), buffer.layoutPos());
 
        // we can't report any sort of error, since we aren't waiting
        return true;
@@ -726,15 +783,18 @@ bool Formats::edit(Buffer const & buffer, FileName const & filename,
        if (!contains(command, token_from_format))
                command += ' ' + token_from_format;
 
-       command = subst(command, token_from_format, quoteName(filename.toFilesystemEncoding()));
-       command = subst(command, token_path_format, quoteName(onlyPath(filename.toFilesystemEncoding())));
+       command = subst(command, token_from_format,
+                       quoteName(filename.toFilesystemEncoding(), quote_shell_filename));
+       command = subst(command, token_path_format,
+                       quoteName(onlyPath(filename.toFilesystemEncoding()), quote_shell_filename));
        command = subst(command, token_socket_format, quoteName(theServerSocket().address()));
        LYXERR(Debug::FILES, "Executing command: " << command);
        // FIXME UNICODE utf8 can be wrong for files
        buffer.message(_("Executing command: ") + from_utf8(command));
 
        Systemcall one;
-       one.startscript(Systemcall::DontWait, command, buffer.filePath());
+       one.startscript(Systemcall::DontWait, command,
+                       buffer.filePath(), buffer.layoutPos());
 
        // we can't report any sort of error, since we aren't waiting
        return true;
@@ -745,7 +805,7 @@ docstring const Formats::prettyName(string const & name) const
 {
        Format const * format = getFormat(name);
        if (format)
-               return from_utf8(format->prettyname());
+               return format->prettyname();
        else
                return from_utf8(name);
 }
@@ -786,13 +846,14 @@ FlavorTranslator initFlavorTranslator()
        f.addPair(OutputParams::XML, "docbook-xml");
        f.addPair(OutputParams::HTML, "xhtml");
        f.addPair(OutputParams::TEXT, "text");
+       f.addPair(OutputParams::LYX, "lyx");
        return f;
 }
 
 
 FlavorTranslator const & flavorTranslator()
 {
-       static FlavorTranslator translator = initFlavorTranslator();
+       static FlavorTranslator const translator = initFlavorTranslator();
        return translator;
 }
 
@@ -811,9 +872,4 @@ OutputParams::FLAVOR format2flavor(std::string fmt)
        return flavorTranslator().find(fmt);
 } */
 
-Formats formats;
-
-Formats system_formats;
-
-
 } // namespace lyx