lyx_mirror/src/Format.cpp

424 lines
10 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/os.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 <algorithm>
// FIXME: Q_WS_MACX is not available, it's in Qt
#ifdef USE_MACOSX_PACKAGING
#include "support/linkback/LinkBackProxy.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.extension() == extension_;
}
private:
string extension_;
};
} //namespace anon
bool operator<(Format const & a, Format const & b)
{
// use the compare_ascii_no_case instead of compare_no_case,
// because in turkish, 'i' is not the lowercase version of 'I',
// and thus turkish locale breaks parsing of tags.
return compare_ascii_no_case(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,
int flags)
* 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
: name_(n), extension_(e), prettyname_(p), shortcut_(s), viewer_(v),
editor_(ed), flags_(flags)
{}
bool Format::dummy() const
{
return extension().empty();
}
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);
}
// 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;
}
string Formats::getFormatFromFile(FileName const & filename) const
{
if (filename.empty())
return string();
string const format = filename.guessFormatFromContents();
if (!format.empty())
return format;
// try to find a format from the file extension.
string const ext = getExtension(filename.absFileName());
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();
}
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(),
Format::document);
}
void Formats::add(string const & name, string const & extension,
string const & prettyname, string const & shortcut,
string const & viewer, string const & editor,
int flags)
{
FormatList::iterator it =
find_if(formatlist.begin(), formatlist.end(),
FormatNamesEqual(name));
if (it == formatlist.end())
formatlist.push_back(Format(name, extension, prettyname,
shortcut, viewer, editor, flags));
else
* 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
*it = Format(name, extension, prettyname, shortcut, viewer,
editor, 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") {
if (os::autoOpenFile(filename.absFileName(), os::VIEW))
return true;
else {
Alert::error(_("Cannot view file"),
bformat(_("Auto-view file %1$s failed"),
from_utf8(filename.absFileName())));
return false;
}
}
string command = libScriptSearch(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(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;
one.startscript(Systemcall::DontWait, command);
// 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 == "pdf" && 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") {
if (os::autoOpenFile(filename.absFileName(), os::EDIT))
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;
one.startscript(Systemcall::DontWait, command);
// 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;
}
Formats formats;
Formats system_formats;
} // namespace lyx