3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
15 #include "bufferparams.h"
19 #include "lyxsocket.h"
21 #include "frontends/Alert.h" //to be removed?
23 #include "support/filetools.h"
24 #include "support/lstrings.h"
25 #include "support/os.h"
26 #include "support/systemcall.h"
28 #include <boost/filesystem/operations.hpp>
30 using lyx::support::absolutePath;
31 using lyx::support::bformat;
32 using lyx::support::compare_ascii_no_case;
33 using lyx::support::contains;
34 using lyx::support::libScriptSearch;
35 using lyx::support::makeDisplayPath;
36 using lyx::support::onlyPath;
37 using lyx::support::quoteName;
38 using lyx::support::subst;
39 using lyx::support::Systemcall;
40 using lyx::support::token;
45 namespace fs = boost::filesystem;
46 namespace os = lyx::support::os;
48 extern LyXServerSocket * lyxsocket;
52 string const token_from("$$i");
53 string const token_path("$$p");
54 string const token_socket("$$a");
57 class FormatNamesEqual : public std::unary_function<Format, bool> {
59 FormatNamesEqual(string const & name)
61 bool operator()(Format const & f) const
63 return f.name() == name_;
70 class FormatExtensionsEqual : public std::unary_function<Format, bool> {
72 FormatExtensionsEqual(string const & extension)
73 : extension_(extension) {}
74 bool operator()(Format const & f) const
76 return f.extension() == extension_;
84 bool operator<(Format const & a, Format const & b)
86 // use the compare_ascii_no_case instead of compare_no_case,
87 // because in turkish, 'i' is not the lowercase version of 'I',
88 // and thus turkish locale breaks parsing of tags.
90 return compare_ascii_no_case(a.prettyname(), b.prettyname()) < 0;
94 Format::Format(string const & n, string const & e, string const & p,
95 string const & s, string const & v, string const & ed,
97 : name_(n), extension_(e), prettyname_(p), shortcut_(s), viewer_(v),
98 editor_(ed), document_(d)
102 bool Format::dummy() const
104 return extension().empty();
108 bool Format::isChildFormat() const
112 return isdigit(name_[name_.length() - 1]);
116 string const Format::parentFormat() const
118 return name_.substr(0, name_.length() - 1);
122 // This method should return a reference, and throw an exception
123 // if the format named name cannot be found (Lgb)
124 Format const * Formats::getFormat(string const & name) const
126 FormatList::const_iterator cit =
127 find_if(formatlist.begin(), formatlist.end(),
128 FormatNamesEqual(name));
129 if (cit != formatlist.end())
136 string Formats::getFormatFromFile(string const & filename) const
138 if (filename.empty())
141 string const format = lyx::support::getFormatFromContents(filename);
145 // try to find a format from the file extension.
146 string const ext(lyx::support::getExtension(filename));
148 // this is ambigous if two formats have the same extension,
149 // but better than nothing
150 Formats::const_iterator cit =
151 find_if(formatlist.begin(), formatlist.end(),
152 FormatExtensionsEqual(ext));
153 if (cit != formats.end()) {
154 lyxerr[Debug::GRAPHICS]
155 << "\twill guess format from file extension: "
156 << ext << " -> " << cit->name() << std::endl;
165 string fixCommand(string const & cmd, string const & ext,
166 os::auto_open_mode mode)
168 // configure.py says we do not want a viewer/editor
172 // Does the OS manage this format?
173 if (os::canAutoOpenFile(ext, mode))
176 // if configure.py found nothing, clear the command
177 if (token(cmd, ' ', 0) == "auto")
180 // use the command found by configure.py
186 void Formats::setAutoOpen()
188 FormatList::iterator fit = formatlist.begin();
189 FormatList::iterator const fend = formatlist.end();
190 for ( ; fit != fend ; ++fit) {
191 fit->setViewer(fixCommand(fit->viewer(), fit->extension(), os::VIEW));
192 fit->setEditor(fixCommand(fit->editor(), fit->extension(), os::EDIT));
197 int Formats::getNumber(string const & name) const
199 FormatList::const_iterator cit =
200 find_if(formatlist.begin(), formatlist.end(),
201 FormatNamesEqual(name));
202 if (cit != formatlist.end())
203 return distance(formatlist.begin(), cit);
209 void Formats::add(string const & name)
211 if (!getFormat(name))
212 add(name, name, name, string(), string(), string(), true);
216 void Formats::add(string const & name, string const & extension,
217 string const & prettyname, string const & shortcut,
218 string const & viewer, string const & editor, bool document)
220 FormatList::iterator it =
221 find_if(formatlist.begin(), formatlist.end(),
222 FormatNamesEqual(name));
223 if (it == formatlist.end())
224 formatlist.push_back(Format(name, extension, prettyname,
225 shortcut, viewer, editor,
228 *it = Format(name, extension, prettyname, shortcut, viewer,
233 void Formats::erase(string const & name)
235 FormatList::iterator it =
236 find_if(formatlist.begin(), formatlist.end(),
237 FormatNamesEqual(name));
238 if (it != formatlist.end())
239 formatlist.erase(it);
245 std::sort(formatlist.begin(), formatlist.end());
249 void Formats::setViewer(string const & name, string const & command)
252 FormatList::iterator it =
253 find_if(formatlist.begin(), formatlist.end(),
254 FormatNamesEqual(name));
255 if (it != formatlist.end())
256 it->setViewer(command);
260 bool Formats::view(Buffer const & buffer, string const & filename,
261 string const & format_name) const
263 BOOST_ASSERT(absolutePath(filename));
264 if (filename.empty() || !fs::exists(filename)) {
265 Alert::error(_("Cannot view file"),
266 bformat(_("File does not exist: %1$s"),
271 Format const * format = getFormat(format_name);
272 if (format && format->viewer().empty() &&
273 format->isChildFormat())
274 format = getFormat(format->parentFormat());
275 if (!format || format->viewer().empty()) {
276 // FIXME: I believe this is the wrong place to show alerts, it should be done
277 // by the caller (this should be "utility" code)
278 Alert::error(_("Cannot view file"),
279 bformat(_("No information for viewing %1$s"),
280 prettyName(format_name)));
284 if (format->viewer() == "auto") {
285 if (os::autoOpenFile(filename, os::VIEW))
288 Alert::error(_("Cannot view file"),
289 bformat(_("Auto-view file %1$s failed"),
295 string command = libScriptSearch(format->viewer());
297 if (format_name == "dvi" &&
298 !lyxrc.view_dvi_paper_option.empty()) {
299 command += ' ' + lyxrc.view_dvi_paper_option;
300 string paper_size = buffer.params().paperSizeName();
301 if (paper_size == "letter")
303 command += ' ' + paper_size;
304 if (buffer.params().orientation == ORIENTATION_LANDSCAPE)
308 if (!contains(command, token_from))
309 command += ' ' + token_from;
311 command = subst(command, token_from, quoteName(filename));
312 command = subst(command, token_path, quoteName(onlyPath(filename)));
313 command = subst(command, token_socket, quoteName(lyxsocket->address()));
314 lyxerr[Debug::FILES] << "Executing command: " << command << std::endl;
315 buffer.message(_("Executing command: ") + command);
318 int const res = one.startscript(Systemcall::DontWait, command);
321 Alert::error(_("Cannot view file"),
322 bformat(_("An error occurred whilst running %1$s"),
323 makeDisplayPath(command, 50)));
330 bool Formats::edit(Buffer const & buffer, string const & filename,
331 string const & format_name) const
333 BOOST_ASSERT(absolutePath(filename));
334 if (filename.empty() || !fs::exists(filename)) {
335 Alert::error(_("Cannot edit file"),
336 bformat(_("File does not exist: %1$s"),
341 Format const * format = getFormat(format_name);
342 if (format && format->editor().empty() &&
343 format->isChildFormat())
344 format = getFormat(format->parentFormat());
345 if (!format || format->editor().empty()) {
346 // FIXME: I believe this is the wrong place to show alerts, it should
347 // be done by the caller (this should be "utility" code)
348 Alert::error(_("Cannot edit file"),
349 bformat(_("No information for editing %1$s"),
350 prettyName(format_name)));
354 if (format->editor() == "auto") {
355 if (os::autoOpenFile(filename, os::EDIT))
358 Alert::error(_("Cannot edit file"),
359 bformat(_("Auto-edit file %1$s failed"),
365 string command = format->editor();
367 if (!contains(command, token_from))
368 command += ' ' + token_from;
370 command = subst(command, token_from, quoteName(filename));
371 command = subst(command, token_path, quoteName(onlyPath(filename)));
372 command = subst(command, token_socket, quoteName(lyxsocket->address()));
373 lyxerr[Debug::FILES] << "Executing command: " << command << std::endl;
374 buffer.message(_("Executing command: ") + command);
377 int const res = one.startscript(Systemcall::DontWait, command);
380 Alert::error(_("Cannot edit file"),
381 bformat(_("An error occurred whilst running %1$s"),
382 makeDisplayPath(command, 50)));
389 string const Formats::prettyName(string const & name) const
391 Format const * format = getFormat(name);
393 return format->prettyname();
399 string const Formats::extension(string const & name) const
401 Format const * format = getFormat(name);
403 return format->extension();
413 Formats system_formats;