]> git.lyx.org Git - lyx.git/blobdiff - src/format.C
Small formatting and comment cleanup.
[lyx.git] / src / format.C
index 20caaf8d69ea131527f138735225fdafeaf976c7..fa327785dadd188a85976ccb42f90777708a94f2 100644 (file)
@@ -5,33 +5,83 @@
  *
  * \author Dekel Tsur
  *
- * Full author contact details are available in file CREDITS
+ * 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 "debug.h"
 #include "gettext.h"
-#include "LString.h"
+#include "lyxsocket.h"
 
+#include "frontends/Application.h"
 #include "frontends/Alert.h" //to be removed?
 
-#include "support/lstrings.h"
 #include "support/filetools.h"
-#include "support/path.h"
+#include "support/lstrings.h"
+#include "support/os.h"
 #include "support/systemcall.h"
-#include "support/lyxfunctional.h"
 
-using namespace lyx::support;
+#include <boost/filesystem/operations.hpp>
+
+
+namespace lyx {
+
+using support::absolutePath;
+using support::bformat;
+using support::compare_ascii_no_case;
+using support::contains;
+using support::FileName;
+using support::libScriptSearch;
+using support::makeDisplayPath;
+using support::onlyPath;
+using support::quoteName;
+using support::subst;
+using support::Systemcall;
+using support::token;
 
+using std::string;
+using std::distance;
+
+namespace Alert = frontend::Alert;
+namespace fs = boost::filesystem;
+namespace os = support::os;
 
 namespace {
 
 string const token_from("$$i");
 string const token_path("$$p");
+string const token_socket("$$a");
+
+
+class FormatNamesEqual : public std::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 std::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
 
@@ -44,12 +94,12 @@ bool operator<(Format const & a, Format const & b)
        return compare_ascii_no_case(a.prettyname(), b.prettyname()) < 0;
 }
 
+
 Format::Format(string const & n, string const & e, string const & p,
-       string const & s, string const & v): name_(n),
-                                           extension_(e),
-                                           prettyname_(p),
-                                           shortcut_(s),
-                                           viewer_(v)
+              string const & s, string const & v, string const & ed,
+               int flags)
+       : name_(n), extension_(e), prettyname_(p), shortcut_(s), viewer_(v),
+         editor_(ed), flags_(flags)
 {}
 
 
@@ -79,7 +129,7 @@ Format const * Formats::getFormat(string const & name) const
 {
        FormatList::const_iterator cit =
                find_if(formatlist.begin(), formatlist.end(),
-                       lyx::compare_memfun(&Format::name, name));
+                       FormatNamesEqual(name));
        if (cit != formatlist.end())
                return &(*cit);
        else
@@ -87,13 +137,74 @@ Format const * Formats::getFormat(string const & name) const
 }
 
 
+string Formats::getFormatFromFile(FileName const & filename) const
+{
+       if (filename.empty())
+               return string();
+
+       string const format = support::getFormatFromContents(filename);
+       if (!format.empty())
+               return format;
+
+       // try to find a format from the file extension.
+       string const ext(support::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() << std::endl;
+                       return cit->name();
+               }
+       }
+       return string();
+}
+
+namespace {
+
+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(),
-                       lyx::compare_memfun(&Format::name, name));
+                       FormatNamesEqual(name));
        if (cit != formatlist.end())
-               return cit - formatlist.begin();
+               return distance(formatlist.begin(), cit);
        else
                return -1;
 }
@@ -102,23 +213,25 @@ int Formats::getNumber(string const & name) const
 void Formats::add(string const & name)
 {
        if (!getFormat(name))
-               add(name, name, name, string());
+               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 & prettyname, string const & shortcut,
+                  string const & viewer, string const & editor,
+                  int flags)
 {
        FormatList::iterator it =
                find_if(formatlist.begin(), formatlist.end(),
-                       lyx::compare_memfun(&Format::name, name));
+                       FormatNamesEqual(name));
        if (it == formatlist.end())
                formatlist.push_back(Format(name, extension, prettyname,
-                                           shortcut, ""));
-       else {
-               string viewer = it->viewer();
-               *it = Format(name, extension, prettyname, shortcut, viewer);
-       }
+                                           shortcut, viewer, editor, flags));
+       else
+               *it = Format(name, extension, prettyname, shortcut, viewer,
+                            editor, flags);
 }
 
 
@@ -126,7 +239,7 @@ void Formats::erase(string const & name)
 {
        FormatList::iterator it =
                find_if(formatlist.begin(), formatlist.end(),
-                       lyx::compare_memfun(&Format::name, name));
+                       FormatNamesEqual(name));
        if (it != formatlist.end())
                formatlist.erase(it);
 }
@@ -143,76 +256,148 @@ void Formats::setViewer(string const & name, string const & command)
        add(name);
        FormatList::iterator it =
                find_if(formatlist.begin(), formatlist.end(),
-                       lyx::compare_memfun(&Format::name, name));
+                       FormatNamesEqual(name));
        if (it != formatlist.end())
                it->setViewer(command);
 }
 
 
-bool Formats::view(Buffer const * buffer, string const & filename,
+bool Formats::view(Buffer const & buffer, FileName const & filename,
                   string const & format_name) const
 {
-       if (filename.empty())
+       if (filename.empty() || !fs::exists(filename.toFilesystemEncoding())) {
+               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()) {
-// I believe this is the wrong place to show alerts, it should be done by
-// the caller (this should be "utility" code
+// 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 = format->viewer();
+       string command = libScriptSearch(format->viewer());
 
        if (format_name == "dvi" &&
            !lyxrc.view_dvi_paper_option.empty()) {
                command += ' ' + lyxrc.view_dvi_paper_option;
-               string paper_size = papersize(buffer);
+               string paper_size = buffer.params().paperSizeName();
                if (paper_size == "letter")
                        paper_size = "us";
                command += ' ' + paper_size;
-               if (buffer->params.orientation
-                   == BufferParams::ORIENTATION_LANDSCAPE)
+               if (buffer.params().orientation == ORIENTATION_LANDSCAPE)
                        command += 'r';
        }
 
        if (!contains(command, token_from))
                command += ' ' + token_from;
 
-       command = subst(command, token_from,
-                       QuoteName(OnlyFilename(filename)));
-       command = subst(command, token_path, QuoteName(OnlyPath(filename)));
-
+       command = subst(command, token_from, quoteName(filename.toFilesystemEncoding()));
+       command = subst(command, token_path, quoteName(onlyPath(filename.toFilesystemEncoding())));
+       command = subst(command, token_socket, quoteName(theLyXServerSocket().address()));
        lyxerr[Debug::FILES] << "Executing command: " << command << std::endl;
-       buffer->message(_("Executing command: ") + command);
+       // FIXME UNICODE utf8 can be wrong for files
+       buffer.message(_("Executing command: ") + from_utf8(command));
 
-       Path p(OnlyPath(filename));
        Systemcall one;
        int const res = one.startscript(Systemcall::DontWait, command);
 
        if (res) {
                Alert::error(_("Cannot view file"),
                             bformat(_("An error occurred whilst running %1$s"),
-                              command.substr(0, 50)));
+                              makeDisplayPath(command, 50)));
+               return false;
+       }
+       return true;
+}
+
+
+bool Formats::edit(Buffer const & buffer, FileName const & filename,
+                        string const & format_name) const
+{
+       if (filename.empty() || !fs::exists(filename.toFilesystemEncoding())) {
+               Alert::error(_("Cannot edit file"),
+                       bformat(_("File does not exist: %1$s"),
+                               from_utf8(filename.absFilename())));
+               return false;
+       }
+
+       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))
+               command += ' ' + token_from;
+
+       command = subst(command, token_from, quoteName(filename.toFilesystemEncoding()));
+       command = subst(command, token_path, quoteName(onlyPath(filename.toFilesystemEncoding())));
+       command = subst(command, token_socket, quoteName(theLyXServerSocket().address()));
+       lyxerr[Debug::FILES] << "Executing command: " << command << std::endl;
+       // FIXME UNICODE utf8 can be wrong for files
+       buffer.message(_("Executing command: ") + from_utf8(command));
+
+       Systemcall one;
+       int const res = one.startscript(Systemcall::DontWait, command);
+
+       if (res) {
+               Alert::error(_("Cannot edit file"),
+                            bformat(_("An error occurred whilst running %1$s"),
+                              makeDisplayPath(command, 50)));
                return false;
        }
        return true;
 }
 
 
-string const Formats::prettyName(string const & name) const
+docstring const Formats::prettyName(string const & name) const
 {
        Format const * format = getFormat(name);
        if (format)
-               return format->prettyname();
+               return from_utf8(format->prettyname());
        else
-               return name;
+               return from_utf8(name);
 }
 
 
@@ -226,32 +411,11 @@ string const Formats::extension(string const & name) const
 }
 
 
-string const papersize(Buffer const * buffer)
-{
-       char real_papersize = buffer->params.papersize;
-       if (real_papersize == BufferParams::PAPER_DEFAULT)
-               real_papersize = lyxrc.default_papersize;
-
-       switch (real_papersize) {
-       case BufferParams::PAPER_A3PAPER:
-               return "a3";
-       case BufferParams::PAPER_A4PAPER:
-               return "a4";
-       case BufferParams::PAPER_A5PAPER:
-               return "a5";
-       case BufferParams::PAPER_B5PAPER:
-               return "b5";
-       case BufferParams::PAPER_EXECUTIVEPAPER:
-               return "foolscap";
-       case BufferParams::PAPER_LEGALPAPER:
-               return "legal";
-       case BufferParams::PAPER_USLETTER:
-       default:
-               return "letter";
-       }
-}
 
 
 Formats formats;
 
 Formats system_formats;
+
+
+} // namespace lyx