src/format.C

   1 /**
   2  * \file format.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Dekel Tsur
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "format.h"
  14 #include "buffer.h"
  15 #include "bufferparams.h"
  16 #include "lyxrc.h"
  17 #include "debug.h"
  18 #include "gettext.h"
  19 #include "lyxsocket.h"
  20
  21 #include "frontends/Application.h"
  22 #include "frontends/Alert.h" //to be removed?
  23
  24 #include "support/filetools.h"
  25 #include "support/lstrings.h"
  26 #include "support/os.h"
  27 #include "support/systemcall.h"
  28
  29 #include <boost/filesystem/operations.hpp>
  30
  31 using lyx::docstring;
  32 using lyx::support::absolutePath;
  33 using lyx::support::bformat;
  34 using lyx::support::compare_ascii_no_case;
  35 using lyx::support::contains;
  36 using lyx::support::libScriptSearch;
  37 using lyx::support::makeDisplayPath;
  38 using lyx::support::onlyPath;
  39 using lyx::support::quoteName;
  40 using lyx::support::subst;
  41 using lyx::support::Systemcall;
  42 using lyx::support::token;
  43
  44 using std::string;
  45 using std::distance;
  46
  47 namespace fs = boost::filesystem;
  48 namespace os = lyx::support::os;
  49
  50 namespace {
  51
  52 string const token_from("$$i");
  53 string const token_path("$$p");
  54 string const token_socket("$$a");
  55
  56
  57 class FormatNamesEqual : public std::unary_function<Format, bool> {
  58 public:
  59         FormatNamesEqual(string const & name)
  60                 : name_(name) {}
  61         bool operator()(Format const & f) const
  62         {
  63                 return f.name() == name_;
  64         }
  65 private:
  66         string name_;
  67 };
  68
  69
  70 class FormatExtensionsEqual : public std::unary_function<Format, bool> {
  71 public:
  72         FormatExtensionsEqual(string const & extension)
  73                 : extension_(extension) {}
  74         bool operator()(Format const & f) const
  75         {
  76                 return f.extension() == extension_;
  77         }
  78 private:
  79         string extension_;
  80 };
  81
  82 } //namespace anon
  83
  84 bool operator<(Format const & a, Format const & b)
  85 {
  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.
  89
  90         return compare_ascii_no_case(a.prettyname(), b.prettyname()) < 0;
  91 }
  92
  93
  94 Format::Format(string const & n, string const & e, string const & p,
  95                string const & s, string const & v, string const & ed,
  96                int flags)
  97         : name_(n), extension_(e), prettyname_(p), shortcut_(s), viewer_(v),
  98           editor_(ed), flags_(flags)
  99 {}
 100
 101
 102 bool Format::dummy() const
 103 {
 104         return extension().empty();
 105 }
 106
 107
 108 bool Format::isChildFormat() const
 109 {
 110         if (name_.empty())
 111                 return false;
 112         return isdigit(name_[name_.length() - 1]);
 113 }
 114
 115
 116 string const Format::parentFormat() const
 117 {
 118         return name_.substr(0, name_.length() - 1);
 119 }
 120
 121
 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
 125 {
 126         FormatList::const_iterator cit =
 127                 find_if(formatlist.begin(), formatlist.end(),
 128                         FormatNamesEqual(name));
 129         if (cit != formatlist.end())
 130                 return &(*cit);
 131         else
 132                 return 0;
 133 }
 134
 135
 136 string Formats::getFormatFromFile(string const & filename) const
 137 {
 138         if (filename.empty())
 139                 return string();
 140
 141         string const format = lyx::support::getFormatFromContents(filename);
 142         if (!format.empty())
 143                 return format;
 144
 145         // try to find a format from the file extension.
 146         string const ext(lyx::support::getExtension(filename));
 147         if (!ext.empty()) {
 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;
 157                         return cit->name();
 158                 }
 159         }
 160         return string();
 161 }
 162
 163 namespace {
 164
 165 string fixCommand(string const & cmd, string const & ext,
 166                   os::auto_open_mode mode)
 167 {
 168         // configure.py says we do not want a viewer/editor
 169         if (cmd.empty())
 170                 return cmd;
 171
 172         // Does the OS manage this format?
 173         if (os::canAutoOpenFile(ext, mode))
 174                 return "auto";
 175
 176         // if configure.py found nothing, clear the command
 177         if (token(cmd, ' ', 0) == "auto")
 178                 return string();
 179
 180         // use the command found by configure.py
 181         return cmd;
 182 }
 183
 184 }
 185
 186 void Formats::setAutoOpen()
 187 {
 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));
 193         }
 194 }
 195
 196
 197 int Formats::getNumber(string const & name) const
 198 {
 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);
 204         else
 205                 return -1;
 206 }
 207
 208
 209 void Formats::add(string const & name)
 210 {
 211         if (!getFormat(name))
 212                 add(name, name, name, string(), string(), string(),
 213                     Format::document);
 214 }
 215
 216
 217 void Formats::add(string const & name, string const & extension,
 218                   string const & prettyname, string const & shortcut,
 219                   string const & viewer, string const & editor,
 220                   int flags)
 221 {
 222         FormatList::iterator it =
 223                 find_if(formatlist.begin(), formatlist.end(),
 224                         FormatNamesEqual(name));
 225         if (it == formatlist.end())
 226                 formatlist.push_back(Format(name, extension, prettyname,
 227                                             shortcut, viewer, editor, flags));
 228         else
 229                 *it = Format(name, extension, prettyname, shortcut, viewer,
 230                              editor, flags);
 231 }
 232
 233
 234 void Formats::erase(string const & name)
 235 {
 236         FormatList::iterator it =
 237                 find_if(formatlist.begin(), formatlist.end(),
 238                         FormatNamesEqual(name));
 239         if (it != formatlist.end())
 240                 formatlist.erase(it);
 241 }
 242
 243
 244 void Formats::sort()
 245 {
 246         std::sort(formatlist.begin(), formatlist.end());
 247 }
 248
 249
 250 void Formats::setViewer(string const & name, string const & command)
 251 {
 252         add(name);
 253         FormatList::iterator it =
 254                 find_if(formatlist.begin(), formatlist.end(),
 255                         FormatNamesEqual(name));
 256         if (it != formatlist.end())
 257                 it->setViewer(command);
 258 }
 259
 260
 261 bool Formats::view(Buffer const & buffer, string const & filename,
 262                    string const & format_name) const
 263 {
 264         BOOST_ASSERT(absolutePath(filename));
 265         if (filename.empty() || !fs::exists(filename)) {
 266                 Alert::error(_("Cannot view file"),
 267                         bformat(_("File does not exist: %1$s"),
 268                                 lyx::from_utf8(filename)));
 269                 return false;
 270         }
 271
 272         Format const * format = getFormat(format_name);
 273         if (format && format->viewer().empty() &&
 274             format->isChildFormat())
 275                 format = getFormat(format->parentFormat());
 276         if (!format || format->viewer().empty()) {
 277 // FIXME: I believe this is the wrong place to show alerts, it should be done
 278 // by the caller (this should be "utility" code)
 279                 Alert::error(_("Cannot view file"),
 280                         bformat(_("No information for viewing %1$s"),
 281                                 prettyName(format_name)));
 282                 return false;
 283         }
 284         // viewer is 'auto'
 285         if (format->viewer() == "auto") {
 286                 if (os::autoOpenFile(filename, os::VIEW))
 287                         return true;
 288                 else {
 289                         Alert::error(_("Cannot view file"),
 290                                 bformat(_("Auto-view file %1$s failed"),
 291                                         lyx::from_utf8(filename)));
 292                         return false;
 293                 }
 294         }
 295
 296         string command = libScriptSearch(format->viewer());
 297
 298         if (format_name == "dvi" &&
 299             !lyxrc.view_dvi_paper_option.empty()) {
 300                 command += ' ' + lyxrc.view_dvi_paper_option;
 301                 string paper_size = buffer.params().paperSizeName();
 302                 if (paper_size == "letter")
 303                         paper_size = "us";
 304                 command += ' ' + paper_size;
 305                 if (buffer.params().orientation == ORIENTATION_LANDSCAPE)
 306                         command += 'r';
 307         }
 308
 309         if (!contains(command, token_from))
 310                 command += ' ' + token_from;
 311
 312         command = subst(command, token_from, quoteName(filename));
 313         command = subst(command, token_path, quoteName(onlyPath(filename)));
 314         command = subst(command, token_socket, quoteName(theApp->socket().address()));
 315         lyxerr[Debug::FILES] << "Executing command: " << command << std::endl;
 316         buffer.message(_("Executing command: ") + lyx::from_utf8(command));
 317
 318         Systemcall one;
 319         int const res = one.startscript(Systemcall::DontWait, command);
 320
 321         if (res) {
 322                 Alert::error(_("Cannot view file"),
 323                              bformat(_("An error occurred whilst running %1$s"),
 324                                makeDisplayPath(command, 50)));
 325                 return false;
 326         }
 327         return true;
 328 }
 329
 330
 331 bool Formats::edit(Buffer const & buffer, string const & filename,
 332                          string const & format_name) const
 333 {
 334         BOOST_ASSERT(absolutePath(filename));
 335         if (filename.empty() || !fs::exists(filename)) {
 336                 Alert::error(_("Cannot edit file"),
 337                         bformat(_("File does not exist: %1$s"),
 338                                 lyx::from_utf8(filename)));
 339                 return false;
 340         }
 341
 342         Format const * format = getFormat(format_name);
 343         if (format && format->editor().empty() &&
 344             format->isChildFormat())
 345                 format = getFormat(format->parentFormat());
 346         if (!format || format->editor().empty()) {
 347 // FIXME: I believe this is the wrong place to show alerts, it should
 348 // be done by the caller (this should be "utility" code)
 349                 Alert::error(_("Cannot edit file"),
 350                         bformat(_("No information for editing %1$s"),
 351                                 prettyName(format_name)));
 352                 return false;
 353         }
 354         // editor is 'auto'
 355         if (format->editor() == "auto") {
 356                 if (os::autoOpenFile(filename, os::EDIT))
 357                         return true;
 358                 else {
 359                         Alert::error(_("Cannot edit file"),
 360                                 bformat(_("Auto-edit file %1$s failed"),
 361                                         lyx::from_utf8(filename)));
 362                         return false;
 363                 }
 364         }
 365
 366         string command = format->editor();
 367
 368         if (!contains(command, token_from))
 369                 command += ' ' + token_from;
 370
 371         command = subst(command, token_from, quoteName(filename));
 372         command = subst(command, token_path, quoteName(onlyPath(filename)));
 373         command = subst(command, token_socket, quoteName(theApp->socket().address()));
 374         lyxerr[Debug::FILES] << "Executing command: " << command << std::endl;
 375         buffer.message(_("Executing command: ") + lyx::from_utf8(command));
 376
 377         Systemcall one;
 378         int const res = one.startscript(Systemcall::DontWait, command);
 379
 380         if (res) {
 381                 Alert::error(_("Cannot edit file"),
 382                              bformat(_("An error occurred whilst running %1$s"),
 383                                makeDisplayPath(command, 50)));
 384                 return false;
 385         }
 386         return true;
 387 }
 388
 389
 390 docstring const Formats::prettyName(string const & name) const
 391 {
 392         Format const * format = getFormat(name);
 393         if (format)
 394                 return lyx::from_utf8(format->prettyname());
 395         else
 396                 return lyx::from_utf8(name);
 397 }
 398
 399
 400 string const Formats::extension(string const & name) const
 401 {
 402         Format const * format = getFormat(name);
 403         if (format)
 404                 return format->extension();
 405         else
 406                 return name;
 407 }
 408
 409
 410
 411
 412 Formats formats;
 413
 414 Formats system_formats;