lyx_mirror/src/Format.cpp

853 lines
21 KiB
C++
Raw Normal View History

/**
* \file Format.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Dekel Tsur
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "Format.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "LyXRC.h"
#include "ServerSocket.h"
#include "frontends/alert.h" //to be removed?
#include "support/debug.h"
#include "support/filetools.h"
#include "support/gettext.h"
#include "support/lstrings.h"
#include "support/mutex.h"
#include "support/os.h"
#include "support/PathChanger.h"
Rename files in src/support, step one. src/support/package.h src/support/Package.h Package src/support/package.C.in src/support/Package.C.in Package src/support/path.h src/support/Path.h Path src/support/fs_extras.h src/support/fs_extras.h NOCLASSES src/support/RandomAccessList.h src/support/RandomAccessList.h RandomAccessList src/support/lyxmanip.h src/support/lyxmanip.h NOCLASSES src/support/rename.C src/support/rename.cpp NOCLASSES src/support/abort.C src/support/abort.cpp NOCLASSES src/support/lyxlib.h src/support/lyxlib.h NOCLASSES src/support/ExceptionMessage.h src/support/ExceptionMessage.h ExceptionMessage src/support/copy.C src/support/copy.cpp NOCLASSES src/support/limited_stack.h src/support/limited_stack.h limited_stack src/support/filefilterlist.C src/support/FileFilterList.cpp ['FileFilterList', 'Filter'] src/support/cow_ptr.h src/support/cow_ptr.h cow_ptr src/support/os_unix.C src/support/os_unix.cpp NOCLASSES src/support/socktools.h src/support/socktools.h NOCLASSES src/support/forkedcontr.h src/support/ForkedcallsController.h ForkedcallsController src/support/os.h src/support/os.h NOCLASSES src/support/FileMonitor.h src/support/FileMonitor.h FileMonitor src/support/copied_ptr.h src/support/copied_ptr.h copied_ptr src/support/translator.h src/support/Translator.h Translator src/support/filetools.C src/support/filetools.cpp NOCLASSES src/support/unlink.C src/support/unlink.cpp NOCLASSES src/support/os_win32.C src/support/os_win32.cpp GetFolderPath src/support/lstrings.C src/support/lstrings.cpp NOCLASSES src/support/qstring_helpers.C src/support/qstring_helpers.cpp NOCLASSES src/support/getcwd.C src/support/getcwd.cpp NOCLASSES src/support/systemcall.C src/support/Systemcall.cpp Systemcall src/support/lyxalgo.h src/support/lyxalgo.h NOCLASSES src/support/filefilterlist.h src/support/FileFilterList.h ['FileFilterList', 'Filter'] src/support/unicode.C src/support/unicode.cpp IconvProcessor src/support/userinfo.C src/support/userinfo.cpp NOCLASSES src/support/lyxtime.C src/support/lyxtime.cpp NOCLASSES src/support/kill.C src/support/kill.cpp NOCLASSES src/support/docstring.C src/support/docstring.cpp to_local8bit_failure src/support/os_cygwin.C src/support/os_cygwin.cpp NOCLASSES src/support/lyxsum.C src/support/lyxsum.cpp NOCLASSES src/support/environment.C src/support/environment.cpp NOCLASSES src/support/filetools.h src/support/filetools.h NOCLASSES src/support/textutils.C src/support/textutils.cpp NOCLASSES src/support/mkdir.C src/support/mkdir.cpp NOCLASSES src/support/forkedcall.C src/support/Forkedcall.cpp ['ForkedProcess', 'Forkedcall'] src/support/tempname.C src/support/tempname.cpp NOCLASSES src/support/os_win32.h src/support/os_win32.h GetFolderPath src/support/types.h src/support/types.h NOCLASSES src/support/lstrings.h src/support/lstrings.h NOCLASSES src/support/forkedcallqueue.C src/support/ForkedCallQueue.cpp ForkedCallQueue src/support/qstring_helpers.h src/support/qstring_helpers.h NOCLASSES src/support/convert.C src/support/convert.cpp NOCLASSES src/support/filename.C src/support/FileName.cpp ['FileName', 'DocFileName'] src/support/tests/convert.C src/support/tests/convert.cpp NOCLASSES src/support/tests/filetools.C src/support/tests/filetools.cpp NOCLASSES src/support/tests/lstrings.C src/support/tests/lstrings.cpp NOCLASSES src/support/tests/boost.C src/support/tests/boost.cpp NOCLASSES src/support/docstream.C src/support/docstream.cpp ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/std_istream.h src/support/std_istream.h NOCLASSES src/support/systemcall.h src/support/Systemcall.h Systemcall src/support/chdir.C src/support/chdir.cpp NOCLASSES src/support/std_ostream.h src/support/std_ostream.h NOCLASSES src/support/unicode.h src/support/unicode.h IconvProcessor src/support/path.C src/support/Path.cpp Path src/support/fs_extras.C src/support/fs_extras.cpp NOCLASSES src/support/userinfo.h src/support/userinfo.h NOCLASSES src/support/lyxtime.h src/support/lyxtime.h NOCLASSES src/support/docstring.h src/support/docstring.h to_local8bit_failure src/support/debugstream.h src/support/debugstream.h basic_debugstream src/support/environment.h src/support/environment.h NOCLASSES src/support/textutils.h src/support/textutils.h NOCLASSES src/support/forkedcall.h src/support/Forkedcall.h ['ForkedProcess', 'Forkedcall'] src/support/socktools.C src/support/socktools.cpp NOCLASSES src/support/forkedcallqueue.h src/support/ForkedCallQueue.h ForkedCallQueue src/support/forkedcontr.C src/support/ForkedcallsController.cpp ForkedcallsController src/support/os.C src/support/os.cpp NOCLASSES src/support/convert.h src/support/convert.h NOCLASSES src/support/filename.h src/support/FileName.h ['FileName', 'DocFileName'] src/support/docstream.h src/support/docstream.h ['iconv_codecvt_facet_exception', 'idocfstream', 'odocfstream'] src/support/FileMonitor.C src/support/FileMonitor.cpp FileMonitor git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@18024 a592a061-630c-0410-9148-cb99ea01b6c8
2007-04-26 05:12:52 +00:00
#include "support/Systemcall.h"
#include "support/textutils.h"
#include "support/Translator.h"
#include <algorithm>
#include <map>
#include <ctime>
// FIXME: Q_WS_MACX is not available, it's in Qt
#ifdef USE_MACOSX_PACKAGING
#include "support/linkback/LinkBackProxy.h"
#endif
#ifdef HAVE_MAGIC_H
#include <magic.h>
#endif
using namespace std;
using namespace lyx::support;
namespace lyx {
namespace Alert = frontend::Alert;
namespace os = support::os;
namespace {
string const token_from_format("$$i");
string const token_path_format("$$p");
string const token_socket_format("$$a");
class FormatNamesEqual : public unary_function<Format, bool> {
public:
FormatNamesEqual(string const & name)
: name_(name)
{}
bool operator()(Format const & f) const
{
return f.name() == name_;
}
private:
string name_;
};
class FormatExtensionsEqual : public unary_function<Format, bool> {
public:
FormatExtensionsEqual(string const & extension)
: extension_(extension)
{}
bool operator()(Format const & f) const
{
return f.hasExtension(extension_);
}
private:
string extension_;
};
class FormatMimeEqual : public unary_function<Format, bool> {
public:
FormatMimeEqual(string const & mime)
: mime_(mime)
{}
bool operator()(Format const & f) const
{
// The test for empty mime strings is needed since we allow
// formats with empty mime types.
return f.mime() == mime_ && !mime_.empty();
}
private:
string mime_;
};
} //namespace anon
bool Format::formatSorter(Format const * lhs, Format const * rhs)
{
return compare_locale(_(lhs->prettyname()), _(rhs->prettyname())) < 0;
}
bool operator<(Format const & a, Format const & b)
{
return compare_locale(_(a.prettyname()), _(b.prettyname())) < 0;
}
* src/format.[Ch] (document_): new flag, telling whether this is a document format and we want to show this format in the export and view menus (documentFormat): accessor for document_ * src/format.h: Add some documentation * src/frontends/qt3/QPrefsDialog.C (QPrefsDialog::QPrefsDialog): handle new documentCB checkbox (QPrefsDialog::switch_format): ditto (QPrefsDialog::updateFormatsButtons): ditto (QPrefsDialog::new_format): ditto (QPrefsDialog::modify_format): ditto * src/frontends/qt3/ui/QPrefFileformatsModule.ui: Add documentCB checkbox * src/frontends/qt4/QPrefsDialog.C (QPrefsDialog::QPrefsDialog): handle new documentCB checkbox (QPrefsDialog::switch_format): ditto (QPrefsDialog::updateFormatsButtons): ditto (QPrefsDialog::new_format): ditto (QPrefsDialog::modify_format): ditto * src/frontends/qt4/ui/QPrefFileformatsUi.ui: Add documentCB checkbox * src/frontends/xforms/FormPreferences.C (FormPreferences::Formats::build): handle new check_document checkbox (FormPreferences::Formats::input): ditto (FormPreferences::Formats::Add): ditto (FormPreferences::Formats::Browser): ditto * src/frontends/xforms/forms/form_preferences.fd: Add check_document checkbox * src/lyxrc.C (LyXRC::read): Remove compatibility code for 1.3 \format entries. Read the new format flags (but don't require them for 1.4 compatibility) (LyXRC::write): Write the new format flags * src/MenuBackend.C (expandFormats): Remove the hardcoded exception for image formats and use Format::isDocument() instead * lib/doc/Customization.lyx: Document auto viever/editor and the "document format" flag git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@13887 a592a061-630c-0410-9148-cb99ea01b6c8
2006-05-20 12:03:40 +00:00
Format::Format(string const & n, string const & e, string const & p,
* src/format.[Ch] (document_): new flag, telling whether this is a document format and we want to show this format in the export and view menus (documentFormat): accessor for document_ * src/format.h: Add some documentation * src/frontends/qt3/QPrefsDialog.C (QPrefsDialog::QPrefsDialog): handle new documentCB checkbox (QPrefsDialog::switch_format): ditto (QPrefsDialog::updateFormatsButtons): ditto (QPrefsDialog::new_format): ditto (QPrefsDialog::modify_format): ditto * src/frontends/qt3/ui/QPrefFileformatsModule.ui: Add documentCB checkbox * src/frontends/qt4/QPrefsDialog.C (QPrefsDialog::QPrefsDialog): handle new documentCB checkbox (QPrefsDialog::switch_format): ditto (QPrefsDialog::updateFormatsButtons): ditto (QPrefsDialog::new_format): ditto (QPrefsDialog::modify_format): ditto * src/frontends/qt4/ui/QPrefFileformatsUi.ui: Add documentCB checkbox * src/frontends/xforms/FormPreferences.C (FormPreferences::Formats::build): handle new check_document checkbox (FormPreferences::Formats::input): ditto (FormPreferences::Formats::Add): ditto (FormPreferences::Formats::Browser): ditto * src/frontends/xforms/forms/form_preferences.fd: Add check_document checkbox * src/lyxrc.C (LyXRC::read): Remove compatibility code for 1.3 \format entries. Read the new format flags (but don't require them for 1.4 compatibility) (LyXRC::write): Write the new format flags * src/MenuBackend.C (expandFormats): Remove the hardcoded exception for image formats and use Format::isDocument() instead * lib/doc/Customization.lyx: Document auto viever/editor and the "document format" flag git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@13887 a592a061-630c-0410-9148-cb99ea01b6c8
2006-05-20 12:03:40 +00:00
string const & s, string const & v, string const & ed,
string const & m, int flags)
: name_(n), prettyname_(p), shortcut_(s), viewer_(v),
editor_(ed), mime_(m), flags_(flags)
{
extension_list_ = getVectorFromString(e, ",");
LYXERR(Debug::GRAPHICS, "New Format: n=" << n << ", flags=" << flags);
}
bool Format::dummy() const
{
return extension().empty();
}
string const Format::extensions() const
{
return getStringFromVector(extension_list_, ", ");
}
bool Format::hasExtension(string const & e) const
{
return (find(extension_list_.begin(), extension_list_.end(), e)
!= extension_list_.end());
}
bool Format::isChildFormat() const
{
if (name_.empty())
return false;
return isDigitASCII(name_[name_.length() - 1]);
}
string const Format::parentFormat() const
{
return name_.substr(0, name_.length() - 1);
}
void Format::setExtensions(string const & e)
{
extension_list_ = getVectorFromString(e, ",");
}
// This method should return a reference, and throw an exception
// if the format named name cannot be found (Lgb)
Format const * Formats::getFormat(string const & name) const
{
FormatList::const_iterator cit =
find_if(formatlist.begin(), formatlist.end(),
FormatNamesEqual(name));
if (cit != formatlist.end())
return &(*cit);
else
return 0;
}
namespace {
/** Guess the file format name (as in Format::name()) from contents.
* Normally you don't want to use this directly, but rather
* Formats::getFormatFromFile().
*/
string guessFormatFromContents(FileName const & fn)
{
// the different filetypes and what they contain in one of the first lines
// (dots are any characters). (Herbert 20020131)
// AGR Grace...
// BMP BM...
// EPS %!PS-Adobe-3.0 EPSF...
// FIG #FIG...
// FITS ...BITPIX...
// GIF GIF...
// JPG \377\330... (0xFFD8)
// PDF %PDF-...
// PNG .PNG...
// PBM P1... or P4 (B/W)
// PGM P2... or P5 (Grayscale)
// PPM P3... or P6 (color)
// PS %!PS-Adobe-2.0 or 1.0, no "EPSF"!
// SGI \001\332... (decimal 474)
// TGIF %TGIF...
// TIFF II... or MM...
// XBM ..._bits[]...
// XPM /* XPM */ sometimes missing (f.ex. tgif-export)
// ...static char *...
// XWD \000\000\000\151 (0x00006900) decimal 105
//
// GZIP \037\213 http://www.ietf.org/rfc/rfc1952.txt
// ZIP PK... http://www.halyava.ru/document/ind_arch.htm
// Z \037\235 UNIX compress
// paranoia check
if (fn.empty() || !fn.isReadableFile())
return string();
ifstream ifs(fn.toFilesystemEncoding().c_str());
if (!ifs)
// Couldn't open file...
return string();
// gnuzip
static string const gzipStamp = "\037\213";
// PKZIP
static string const zipStamp = "PK";
// ZIP containers (koffice, openoffice.org etc).
static string const nonzipStamp = "\008\0\0\0mimetypeapplication/";
// 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;
string str;
string format;
bool firstLine = true;
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);
if (firstLine && str.size() >= 2) {
// at first we check for a zipped file, because this
// information is saved in the first bytes of the file!
// also some graphic formats which save the information
// in the first line, too.
if (prefixIs(str, gzipStamp)) {
format = "gzip";
} else if (stamp == zipStamp &&
!contains(str, nonzipStamp)) {
format = "zip";
} else if (stamp == compressStamp) {
format = "compress";
// the graphics part
} 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
// we already know that str.size() >= 2
} else if (str[0] == 'P') {
switch (str[1]) {
case '1':
case '4':
format = "pbm";
break;
case '2':
case '5':
format = "pgm";
break;
case '3':
case '6':
format = "ppm";
}
break;
} else if ((stamp == "II") || (stamp == "MM")) {
format = "tiff";
} else if (prefixIs(str,"%TGIF")) {
format = "tgif";
} else if (prefixIs(str,"#FIG")) {
format = "fig";
} else if (prefixIs(str,"GIF")) {
format = "gif";
} else if (str.size() > 3) {
int const c = ((str[0] << 24) & (str[1] << 16) &
(str[2] << 8) & str[3]);
if (c == 105) {
format = "xwd";
}
}
firstLine = false;
}
if (!format.empty())
break;
else if (contains(str,"EPSF"))
// dummy, if we have wrong file description like
// %!PS-Adobe-2.0EPSF"
format = "eps";
else if (contains(str, "Grace"))
format = "agr";
else if (contains(str, "%PDF"))
// autodetect pdf format for graphics inclusion
format = "pdf6";
else if (contains(str, "PNG"))
format = "png";
else if (contains(str, "%!PS-Adobe")) {
// eps or ps
ifs >> str;
if (contains(str,"EPSF"))
format = "eps";
else
format = "ps";
}
else if (contains(str, "_bits[]"))
format = "xbm";
else if (contains(str, "XPM") || contains(str, "static char *"))
format = "xpm";
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() && 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;
}
LYXERR(Debug::GRAPHICS, "filetools(getFormatFromContents)\n"
<< "\tCouldn't find a known format!");
return string();
}
}
string Formats::getFormatFromFile(FileName const & filename) const
{
if (filename.empty())
return string();
string psformat;
#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 {
char const * result = magic_file(magic_cookie,
filename.toFilesystemEncoding().c_str());
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(),
FormatMimeEqual(mime));
if (cit != formats.end()) {
LYXERR(Debug::GRAPHICS, "\tgot format from MIME type: "
<< mime << " -> " << 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())
return format;
}
}
#endif
// 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).
string const format = guessFormatFromContents(filename);
if (!psformat.empty()) {
if (isPostScriptFileFormat(format))
return format;
else
return psformat;
}
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())
return format;
// try to find a format from the file extension.
return getFormatFromExtension(ext);
}
string Formats::getFormatFromExtension(string const & ext) const
{
if (!ext.empty()) {
// this is ambigous if two formats have the same extension,
// but better than nothing
Formats::const_iterator cit =
find_if(formatlist.begin(), formatlist.end(),
FormatExtensionsEqual(ext));
if (cit != formats.end()) {
LYXERR(Debug::GRAPHICS, "\twill guess format from file extension: "
<< ext << " -> " << cit->name());
return cit->name();
}
}
return string();
}
/// Used to store last timestamp of file and whether it is (was) zipped
struct ZippedInfo {
bool zipped;
std::time_t timestamp;
ZippedInfo(bool zipped, std::time_t timestamp)
: zipped(zipped), timestamp(timestamp) { }
};
/// 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;
string const & format = getFormatFromFile(filename);
bool zipped = (format == "gzip" || format == "zip");
zipped_.insert(make_pair(fname, ZippedInfo(zipped, timestamp)));
return zipped;
}
bool Formats::isZippedFileFormat(string const & format)
{
return contains("gzip zip compress", format) && !format.empty();
}
bool Formats::isPostScriptFileFormat(string const & format)
{
return format == "ps" || format == "eps";
}
static string fixCommand(string const & cmd, string const & ext,
os::auto_open_mode mode)
{
// configure.py says we do not want a viewer/editor
if (cmd.empty())
return cmd;
// Does the OS manage this format?
if (os::canAutoOpenFile(ext, mode))
return "auto";
// if configure.py found nothing, clear the command
if (token(cmd, ' ', 0) == "auto")
return string();
// use the command found by configure.py
return cmd;
}
void Formats::setAutoOpen()
{
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));
}
}
int Formats::getNumber(string const & name) const
{
FormatList::const_iterator cit =
find_if(formatlist.begin(), formatlist.end(),
FormatNamesEqual(name));
if (cit != formatlist.end())
return distance(formatlist.begin(), cit);
else
return -1;
}
void Formats::add(string const & name)
{
if (!getFormat(name))
add(name, name, name, string(), string(), string(),
string(), Format::document);
}
void Formats::add(string const & name, string const & extensions,
string 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(),
FormatNamesEqual(name));
if (it == formatlist.end())
formatlist.push_back(Format(name, extensions, prettyname,
shortcut, viewer, editor, mime, flags));
else
*it = Format(name, extensions, prettyname, shortcut, viewer,
editor, mime, flags);
}
void Formats::erase(string const & name)
{
FormatList::iterator it =
find_if(formatlist.begin(), formatlist.end(),
FormatNamesEqual(name));
if (it != formatlist.end())
formatlist.erase(it);
}
void Formats::sort()
{
std::sort(formatlist.begin(), formatlist.end());
}
void Formats::setViewer(string const & name, string const & command)
{
add(name);
FormatList::iterator it =
find_if(formatlist.begin(), formatlist.end(),
FormatNamesEqual(name));
if (it != formatlist.end())
it->setViewer(command);
}
void Formats::setEditor(string const & name, string const & command)
{
add(name);
FormatList::iterator it =
find_if(formatlist.begin(), formatlist.end(),
FormatNamesEqual(name));
if (it != formatlist.end())
it->setEditor(command);
}
bool Formats::view(Buffer const & buffer, FileName const & filename,
string const & format_name) const
{
if (filename.empty() || !filename.exists()) {
Alert::error(_("Cannot view file"),
bformat(_("File does not exist: %1$s"),
from_utf8(filename.absFileName())));
return false;
}
Format const * format = getFormat(format_name);
if (format && format->viewer().empty() &&
format->isChildFormat())
format = getFormat(format->parentFormat());
if (!format || format->viewer().empty()) {
// FIXME: I believe this is the wrong place to show alerts, it should be done
// by the caller (this should be "utility" code)
Alert::error(_("Cannot view file"),
bformat(_("No information for viewing %1$s"),
prettyName(format_name)));
return false;
}
// viewer is 'auto'
if (format->viewer() == "auto") {
Introduce the possibility of setting a prefix for the TEXINPUTS environment variable. This is done in the preferences, much like as the PATH prefix. A single '.' in the paths will get replaced with the current document dir and also non-absolute paths will be prefixed with that dir. The default semantics of TEXINPUTS apply, such that, for example, if a path is terminated with a double slash, all subdirectories will be also searched by both the TeX engine and ancillary programs such as dvi previewers or dvips. As an example, if the prefix is set to ".:figs", the TEXINPUTS variable will be set as ".:<docdir>:<docdir>/figs:$ORIGTEXINPUTS", where <docdir> is the document directory. The initial '.' is necessary to address the actual current dir (this will be the temp dir at preview time), while if TEXINPUTS was initially unset, such that $ORIGTEXINPUTS is empty, a colon (or semicolon on Windows) will end the path list. This is very important, because we don't want to replace the system directories but to complement them and, in order to do that, an empty element has to be present in the list. Indeed, according to the TEXINPUTS semantics, an empty element means the standard search path. This works whether TEXINPUTS is originally set or not, because if the original TEXINPUTS starts with a colon (meaning that the standard search path is wanted there) we will have an empty element at that point, otherwise the final colon will simply serve as a path separator. Of course, on Windows a ';' has to be used as a path separator. LyX will take care of transforming the platform path list into one understandable by the TeX engine. For example, this will be the case for a Cygwin version of LyX using a native Windows TeX engine or viceversa. I tested all of this and it works for me. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@38681 a592a061-630c-0410-9148-cb99ea01b6c8
2011-05-09 23:25:51 +00:00
if (os::autoOpenFile(filename.absFileName(), os::VIEW, buffer.filePath()))
return true;
else {
Alert::error(_("Cannot view file"),
bformat(_("Auto-view file %1$s failed"),
from_utf8(filename.absFileName())));
return false;
}
}
string command = format->viewer();
if (format_name == "dvi" &&
!lyxrc.view_dvi_paper_option.empty()) {
string paper_size = buffer.params().paperSizeName(BufferParams::XDVI);
if (!paper_size.empty()) {
command += ' ' + lyxrc.view_dvi_paper_option;
command += ' ' + paper_size;
if (buffer.params().orientation == ORIENTATION_LANDSCAPE &&
buffer.params().papersize != PAPER_CUSTOM)
command += 'r';
}
}
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_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));
PathChanger p(filename.onlyPath());
Systemcall one;
Introduce the possibility of setting a prefix for the TEXINPUTS environment variable. This is done in the preferences, much like as the PATH prefix. A single '.' in the paths will get replaced with the current document dir and also non-absolute paths will be prefixed with that dir. The default semantics of TEXINPUTS apply, such that, for example, if a path is terminated with a double slash, all subdirectories will be also searched by both the TeX engine and ancillary programs such as dvi previewers or dvips. As an example, if the prefix is set to ".:figs", the TEXINPUTS variable will be set as ".:<docdir>:<docdir>/figs:$ORIGTEXINPUTS", where <docdir> is the document directory. The initial '.' is necessary to address the actual current dir (this will be the temp dir at preview time), while if TEXINPUTS was initially unset, such that $ORIGTEXINPUTS is empty, a colon (or semicolon on Windows) will end the path list. This is very important, because we don't want to replace the system directories but to complement them and, in order to do that, an empty element has to be present in the list. Indeed, according to the TEXINPUTS semantics, an empty element means the standard search path. This works whether TEXINPUTS is originally set or not, because if the original TEXINPUTS starts with a colon (meaning that the standard search path is wanted there) we will have an empty element at that point, otherwise the final colon will simply serve as a path separator. Of course, on Windows a ';' has to be used as a path separator. LyX will take care of transforming the platform path list into one understandable by the TeX engine. For example, this will be the case for a Cygwin version of LyX using a native Windows TeX engine or viceversa. I tested all of this and it works for me. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@38681 a592a061-630c-0410-9148-cb99ea01b6c8
2011-05-09 23:25:51 +00:00
one.startscript(Systemcall::DontWait, command, buffer.filePath());
// we can't report any sort of error, since we aren't waiting
return true;
}
bool Formats::edit(Buffer const & buffer, FileName const & filename,
string const & format_name) const
{
if (filename.empty() || !filename.exists()) {
Alert::error(_("Cannot edit file"),
bformat(_("File does not exist: %1$s"),
from_utf8(filename.absFileName())));
return false;
}
// LinkBack files look like PDF, but have the .linkback extension
string const ext = getExtension(filename.absFileName());
if (format_name == "pdf6" && ext == "linkback") {
#ifdef USE_MACOSX_PACKAGING
return editLinkBackFile(filename.absFileName().c_str());
#else
Alert::error(_("Cannot edit file"),
_("LinkBack files can only be edited on Apple Mac OSX."));
return false;
#endif // USE_MACOSX_PACKAGING
}
Format const * format = getFormat(format_name);
if (format && format->editor().empty() &&
format->isChildFormat())
format = getFormat(format->parentFormat());
if (!format || format->editor().empty()) {
// FIXME: I believe this is the wrong place to show alerts, it should
// be done by the caller (this should be "utility" code)
Alert::error(_("Cannot edit file"),
bformat(_("No information for editing %1$s"),
prettyName(format_name)));
return false;
}
// editor is 'auto'
if (format->editor() == "auto") {
Introduce the possibility of setting a prefix for the TEXINPUTS environment variable. This is done in the preferences, much like as the PATH prefix. A single '.' in the paths will get replaced with the current document dir and also non-absolute paths will be prefixed with that dir. The default semantics of TEXINPUTS apply, such that, for example, if a path is terminated with a double slash, all subdirectories will be also searched by both the TeX engine and ancillary programs such as dvi previewers or dvips. As an example, if the prefix is set to ".:figs", the TEXINPUTS variable will be set as ".:<docdir>:<docdir>/figs:$ORIGTEXINPUTS", where <docdir> is the document directory. The initial '.' is necessary to address the actual current dir (this will be the temp dir at preview time), while if TEXINPUTS was initially unset, such that $ORIGTEXINPUTS is empty, a colon (or semicolon on Windows) will end the path list. This is very important, because we don't want to replace the system directories but to complement them and, in order to do that, an empty element has to be present in the list. Indeed, according to the TEXINPUTS semantics, an empty element means the standard search path. This works whether TEXINPUTS is originally set or not, because if the original TEXINPUTS starts with a colon (meaning that the standard search path is wanted there) we will have an empty element at that point, otherwise the final colon will simply serve as a path separator. Of course, on Windows a ';' has to be used as a path separator. LyX will take care of transforming the platform path list into one understandable by the TeX engine. For example, this will be the case for a Cygwin version of LyX using a native Windows TeX engine or viceversa. I tested all of this and it works for me. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@38681 a592a061-630c-0410-9148-cb99ea01b6c8
2011-05-09 23:25:51 +00:00
if (os::autoOpenFile(filename.absFileName(), os::EDIT, buffer.filePath()))
return true;
else {
Alert::error(_("Cannot edit file"),
bformat(_("Auto-edit file %1$s failed"),
from_utf8(filename.absFileName())));
return false;
}
}
string command = format->editor();
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_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;
Introduce the possibility of setting a prefix for the TEXINPUTS environment variable. This is done in the preferences, much like as the PATH prefix. A single '.' in the paths will get replaced with the current document dir and also non-absolute paths will be prefixed with that dir. The default semantics of TEXINPUTS apply, such that, for example, if a path is terminated with a double slash, all subdirectories will be also searched by both the TeX engine and ancillary programs such as dvi previewers or dvips. As an example, if the prefix is set to ".:figs", the TEXINPUTS variable will be set as ".:<docdir>:<docdir>/figs:$ORIGTEXINPUTS", where <docdir> is the document directory. The initial '.' is necessary to address the actual current dir (this will be the temp dir at preview time), while if TEXINPUTS was initially unset, such that $ORIGTEXINPUTS is empty, a colon (or semicolon on Windows) will end the path list. This is very important, because we don't want to replace the system directories but to complement them and, in order to do that, an empty element has to be present in the list. Indeed, according to the TEXINPUTS semantics, an empty element means the standard search path. This works whether TEXINPUTS is originally set or not, because if the original TEXINPUTS starts with a colon (meaning that the standard search path is wanted there) we will have an empty element at that point, otherwise the final colon will simply serve as a path separator. Of course, on Windows a ';' has to be used as a path separator. LyX will take care of transforming the platform path list into one understandable by the TeX engine. For example, this will be the case for a Cygwin version of LyX using a native Windows TeX engine or viceversa. I tested all of this and it works for me. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@38681 a592a061-630c-0410-9148-cb99ea01b6c8
2011-05-09 23:25:51 +00:00
one.startscript(Systemcall::DontWait, command, buffer.filePath());
// we can't report any sort of error, since we aren't waiting
return true;
}
docstring const Formats::prettyName(string const & name) const
{
Format const * format = getFormat(name);
if (format)
return from_utf8(format->prettyname());
else
return from_utf8(name);
}
string const Formats::extension(string const & name) const
{
Format const * format = getFormat(name);
if (format)
return format->extension();
else
return name;
}
string const Formats::extensions(string const & name) const
{
Format const * format = getFormat(name);
if (format)
return format->extensions();
else
return name;
}
namespace {
typedef Translator<OutputParams::FLAVOR, string> FlavorTranslator;
FlavorTranslator initFlavorTranslator()
{
FlavorTranslator f(OutputParams::LATEX, "latex");
f.addPair(OutputParams::DVILUATEX, "dviluatex");
f.addPair(OutputParams::LUATEX, "luatex");
f.addPair(OutputParams::PDFLATEX, "pdflatex");
f.addPair(OutputParams::XETEX, "xetex");
f.addPair(OutputParams::XML, "docbook-xml");
f.addPair(OutputParams::HTML, "xhtml");
f.addPair(OutputParams::TEXT, "text");
return f;
}
FlavorTranslator const & flavorTranslator()
{
static FlavorTranslator const translator = initFlavorTranslator();
return translator;
}
}
std::string flavor2format(OutputParams::FLAVOR flavor)
{
return flavorTranslator().find(flavor);
}
/* Not currently needed, but I'll leave the code in case it is.
OutputParams::FLAVOR format2flavor(std::string fmt)
{
return flavorTranslator().find(fmt);
} */
Formats formats;
Formats system_formats;
} // namespace lyx