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 "lyxrc.h"
  16 #include "debug.h"
  17 #include "gettext.h"
  18
  19 #include "frontends/Alert.h" //to be removed?
  20
  21 #include "support/filetools.h"
  22 #include "support/path.h"
  23 #include "support/systemcall.h"
  24 #include "support/lyxfunctional.h"
  25
  26 using namespace lyx::support;
  27
  28
  29 namespace {
  30
  31 string const token_from("$$i");
  32 string const token_path("$$p");
  33
  34 } //namespace anon
  35
  36 bool operator<(Format const & a, Format const & b)
  37 {
  38         // use the compare_ascii_no_case instead of compare_no_case,
  39         // because in turkish, 'i' is not the lowercase version of 'I',
  40         // and thus turkish locale breaks parsing of tags.
  41
  42         return compare_ascii_no_case(a.prettyname(), b.prettyname()) < 0;
  43 }
  44
  45 Format::Format(string const & n, string const & e, string const & p,
  46        string const & s, string const & v): name_(n),
  47                                             extension_(e),
  48                                             prettyname_(p),
  49                                             shortcut_(s),
  50                                             viewer_(v)
  51 {}
  52
  53
  54 bool Format::dummy() const
  55 {
  56         return extension().empty();
  57 }
  58
  59
  60 bool Format::isChildFormat() const
  61 {
  62         if (name_.empty())
  63                 return false;
  64         return isdigit(name_[name_.length() - 1]);
  65 }
  66
  67
  68 string const Format::parentFormat() const
  69 {
  70         return name_.substr(0, name_.length() - 1);
  71 }
  72
  73
  74 // This method should return a reference, and throw an exception
  75 // if the format named name cannot be found (Lgb)
  76 Format const * Formats::getFormat(string const & name) const
  77 {
  78         FormatList::const_iterator cit =
  79                 find_if(formatlist.begin(), formatlist.end(),
  80                         lyx::compare_memfun(&Format::name, name));
  81         if (cit != formatlist.end())
  82                 return &(*cit);
  83         else
  84                 return 0;
  85 }
  86
  87
  88 int Formats::getNumber(string const & name) const
  89 {
  90         FormatList::const_iterator cit =
  91                 find_if(formatlist.begin(), formatlist.end(),
  92                         lyx::compare_memfun(&Format::name, name));
  93         if (cit != formatlist.end())
  94                 return cit - formatlist.begin();
  95         else
  96                 return -1;
  97 }
  98
  99
 100 void Formats::add(string const & name)
 101 {
 102         if (!getFormat(name))
 103                 add(name, name, name, string());
 104 }
 105
 106
 107 void Formats::add(string const & name, string const & extension,
 108                   string const & prettyname, string const & shortcut)
 109 {
 110         FormatList::iterator it =
 111                 find_if(formatlist.begin(), formatlist.end(),
 112                         lyx::compare_memfun(&Format::name, name));
 113         if (it == formatlist.end())
 114                 formatlist.push_back(Format(name, extension, prettyname,
 115                                             shortcut, ""));
 116         else {
 117                 string viewer = it->viewer();
 118                 *it = Format(name, extension, prettyname, shortcut, viewer);
 119         }
 120 }
 121
 122
 123 void Formats::erase(string const & name)
 124 {
 125         FormatList::iterator it =
 126                 find_if(formatlist.begin(), formatlist.end(),
 127                         lyx::compare_memfun(&Format::name, name));
 128         if (it != formatlist.end())
 129                 formatlist.erase(it);
 130 }
 131
 132
 133 void Formats::sort()
 134 {
 135         std::sort(formatlist.begin(), formatlist.end());
 136 }
 137
 138
 139 void Formats::setViewer(string const & name, string const & command)
 140 {
 141         add(name);
 142         FormatList::iterator it =
 143                 find_if(formatlist.begin(), formatlist.end(),
 144                         lyx::compare_memfun(&Format::name, name));
 145         if (it != formatlist.end())
 146                 it->setViewer(command);
 147 }
 148
 149
 150 bool Formats::view(Buffer const & buffer, string const & filename,
 151                    string const & format_name) const
 152 {
 153         if (filename.empty())
 154                 return false;
 155
 156         Format const * format = getFormat(format_name);
 157         if (format && format->viewer().empty() &&
 158             format->isChildFormat())
 159                 format = getFormat(format->parentFormat());
 160         if (!format || format->viewer().empty()) {
 161 // I believe this is the wrong place to show alerts, it should be done by
 162 // the caller (this should be "utility" code
 163                 Alert::error(_("Cannot view file"),
 164                         bformat(_("No information for viewing %1$s"),
 165                                 prettyName(format_name)));
 166                 return false;
 167         }
 168
 169         string command = format->viewer();
 170
 171         if (format_name == "dvi" &&
 172             !lyxrc.view_dvi_paper_option.empty()) {
 173                 command += ' ' + lyxrc.view_dvi_paper_option;
 174                 string paper_size = buffer.params().paperSizeName();
 175                 if (paper_size == "letter")
 176                         paper_size = "us";
 177                 command += ' ' + paper_size;
 178                 if (buffer.params().orientation == ORIENTATION_LANDSCAPE)
 179                         command += 'r';
 180         }
 181
 182         if (!contains(command, token_from))
 183                 command += ' ' + token_from;
 184
 185         command = subst(command, token_from,
 186                         QuoteName(OnlyFilename(filename)));
 187         command = subst(command, token_path, QuoteName(OnlyPath(filename)));
 188
 189         lyxerr[Debug::FILES] << "Executing command: " << command << std::endl;
 190         buffer.message(_("Executing command: ") + command);
 191
 192         Path p(OnlyPath(filename));
 193         Systemcall one;
 194         int const res = one.startscript(Systemcall::DontWait, command);
 195
 196         if (res) {
 197                 Alert::error(_("Cannot view file"),
 198                              bformat(_("An error occurred whilst running %1$s"),
 199                                command.substr(0, 50)));
 200                 return false;
 201         }
 202         return true;
 203 }
 204
 205
 206 string const Formats::prettyName(string const & name) const
 207 {
 208         Format const * format = getFormat(name);
 209         if (format)
 210                 return format->prettyname();
 211         else
 212                 return name;
 213 }
 214
 215
 216 string const Formats::extension(string const & name) const
 217 {
 218         Format const * format = getFormat(name);
 219         if (format)
 220                 return format->extension();
 221         else
 222                 return name;
 223 }
 224
 225
 226
 227
 228 Formats formats;
 229
 230 Formats system_formats;