src/insets/InsetInfo.cpp

   1 /**
   2  * \file InsetInfo.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Bo Peng
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10 #include <config.h>
  11
  12 #include "InsetInfo.h"
  13 #include "LyX.h"
  14 #include "Buffer.h"
  15 #include "BufferParams.h"
  16 #include "BufferView.h"
  17 #include "CutAndPaste.h"
  18 #include "FuncRequest.h"
  19 #include "FuncStatus.h"
  20 #include "InsetGraphics.h"
  21 #include "InsetSpecialChar.h"
  22 #include "KeyMap.h"
  23 #include "LaTeXFeatures.h"
  24 #include "Language.h"
  25 #include "LayoutFile.h"
  26 #include "Length.h"
  27 #include "LyXAction.h"
  28 #include "LyXRC.h"
  29 #include "LyXVC.h"
  30 #include "Lexer.h"
  31 #include "ParagraphParameters.h"
  32 #include "version.h"
  33
  34 #include "frontends/Application.h"
  35
  36 #include "support/convert.h"
  37 #include "support/debug.h"
  38 #include "support/docstream.h"
  39 #include "support/docstring_list.h"
  40 #include "support/ExceptionMessage.h"
  41 #include "support/FileName.h"
  42 #include "support/filetools.h"
  43 #include "support/gettext.h"
  44 #include "support/lstrings.h"
  45 #include "support/qstring_helpers.h"
  46 #include "support/Translator.h"
  47
  48 #include <sstream>
  49
  50 #include <QtGui/QImage>
  51
  52 using namespace std;
  53 using namespace lyx::support;
  54
  55 namespace lyx {
  56
  57 namespace {
  58
  59 typedef Translator<InsetInfo::info_type, string> NameTranslator;
  60
  61 NameTranslator const initTranslator()
  62 {
  63         NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
  64
  65         translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
  66         translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
  67         translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
  68         translator.addPair(InsetInfo::PACKAGE_INFO, "package");
  69         translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
  70         translator.addPair(InsetInfo::MENU_INFO, "menu");
  71         translator.addPair(InsetInfo::ICON_INFO, "icon");
  72         translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
  73         translator.addPair(InsetInfo::LYX_INFO, "lyxinfo");
  74
  75         return translator;
  76 }
  77
  78 /// The translator between the information type enum and corresponding string.
  79 NameTranslator const & nameTranslator()
  80 {
  81         static NameTranslator const translator = initTranslator();
  82         return translator;
  83 }
  84
  85 } // namespace
  86
  87 /////////////////////////////////////////////////////////////////////////
  88 //
  89 // InsetInfo
  90 //
  91 /////////////////////////////////////////////////////////////////////////
  92
  93
  94
  95 InsetInfo::InsetInfo(Buffer * buf, string const & name)
  96         : InsetCollapsible(buf), type_(UNKNOWN_INFO), name_()
  97 {
  98         setInfo(name);
  99         status_ = Collapsed;
 100 }
 101
 102
 103 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
 104 {
 105         // do not allow the cursor to be set in this Inset
 106         return Inset::editXY(cur, x, y);
 107 }
 108
 109
 110 string InsetInfo::infoType() const
 111 {
 112         return nameTranslator().find(type_);
 113 }
 114
 115
 116 docstring InsetInfo::layoutName() const
 117 {
 118         return from_ascii("Info:" + infoType());
 119 }
 120
 121
 122 docstring InsetInfo::toolTip(BufferView const &, int, int) const
 123 {
 124         return bformat(_("Information regarding %1$s '%2$s'"),
 125                         _(infoType()), from_utf8(name_));
 126 }
 127
 128
 129 void InsetInfo::read(Lexer & lex)
 130 {
 131         string token;
 132         while (lex.isOK()) {
 133                 lex.next();
 134                 token = lex.getString();
 135                 if (token == "type") {
 136                         lex.next();
 137                         token = lex.getString();
 138                         type_ = nameTranslator().find(token);
 139                 } else if (token == "arg") {
 140                         lex.next(true);
 141                         name_ = lex.getString();
 142                 } else if (token == "\\end_inset")
 143                         break;
 144         }
 145         if (token != "\\end_inset") {
 146                 lex.printError("Missing \\end_inset at this point");
 147                 throw ExceptionMessage(WarningException,
 148                         _("Missing \\end_inset at this point."),
 149                         from_utf8(token));
 150         }
 151         updateInfo();
 152 }
 153
 154
 155 void InsetInfo::write(ostream & os) const
 156 {
 157         os << "Info\ntype  \"" << infoType()
 158            << "\"\narg   " << Lexer::quoteString(name_);
 159 }
 160
 161
 162 bool InsetInfo::validateModifyArgument(docstring const & arg) const
 163 {
 164         string type;
 165         string const name = trim(split(to_utf8(arg), type, ' '));
 166
 167         switch (nameTranslator().find(type)) {
 168         case UNKNOWN_INFO:
 169                 return false;
 170
 171         case SHORTCUT_INFO:
 172         case SHORTCUTS_INFO:
 173         case MENU_INFO: {
 174                 FuncRequest func = lyxaction.lookupFunc(name);
 175                 return func.action() != LFUN_UNKNOWN_ACTION;
 176         }
 177
 178         case ICON_INFO: {
 179                 FuncCode const action = lyxaction.lookupFunc(name).action();
 180                 if (action == LFUN_UNKNOWN_ACTION) {
 181                         string dir = "images";
 182                         return !imageLibFileSearch(dir, name, "svgz,png").empty();
 183                 }
 184                 return true;
 185         }
 186
 187         case LYXRC_INFO: {
 188                 ostringstream oss;
 189                 lyxrc.write(oss, true, name);
 190                 return !oss.str().empty();
 191         }
 192
 193         case PACKAGE_INFO:
 194         case TEXTCLASS_INFO:
 195                 return true;
 196
 197         case BUFFER_INFO:
 198                 if (name == "name" || name == "path" || name == "class")
 199                         return true;
 200                 if (name == "vcs-revision" || name == "vcs-tree-revision" ||
 201                        name == "vcs-author" || name == "vcs-date" || name == "vcs-time")
 202                         return buffer().lyxvc().inUse();
 203                 return false;
 204
 205         case LYX_INFO:
 206                 return name == "version";
 207         }
 208
 209         return false;
 210 }
 211
 212
 213 bool InsetInfo::showInsetDialog(BufferView * bv) const
 214 {
 215         bv->showDialog("info");
 216         return true;
 217 }
 218
 219
 220 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
 221                 FuncStatus & flag) const
 222 {
 223         switch (cmd.action()) {
 224         case LFUN_INSET_SETTINGS:
 225                 return InsetCollapsible::getStatus(cur, cmd, flag);
 226
 227         case LFUN_INSET_DIALOG_UPDATE:
 228         case LFUN_INSET_COPY_AS:
 229                 flag.setEnabled(true);
 230                 return true;
 231
 232         case LFUN_INSET_MODIFY:
 233                 if (validateModifyArgument(cmd.argument())) {
 234                         flag.setEnabled(true);
 235                         return true;
 236                 }
 237                 //fall through
 238
 239         default:
 240                 return false;
 241         }
 242 }
 243
 244
 245 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
 246 {
 247         switch (cmd.action()) {
 248         case LFUN_INSET_MODIFY:
 249                 cur.recordUndo();
 250                 setInfo(to_utf8(cmd.argument()));
 251                 break;
 252
 253         case LFUN_INSET_COPY_AS: {
 254                 cap::clearSelection();
 255                 Cursor copy(cur);
 256                 copy.pushBackward(*this);
 257                 copy.pit() = 0;
 258                 copy.pos() = 0;
 259                 copy.resetAnchor();
 260                 copy.pit() = copy.lastpit();
 261                 copy.pos() = copy.lastpos();
 262                 copy.setSelection();
 263                 cap::copySelection(copy);
 264                 break;
 265         }
 266
 267         default:
 268                 InsetCollapsible::doDispatch(cur, cmd);
 269                 break;
 270         }
 271 }
 272
 273
 274 void InsetInfo::setInfo(string const & name)
 275 {
 276         if (name.empty())
 277                 return;
 278         // info_type name
 279         string type;
 280         name_ = trim(split(name, type, ' '));
 281         type_ = nameTranslator().find(type);
 282         updateInfo();
 283 }
 284
 285
 286 void InsetInfo::error(string const & err)
 287 {
 288         setText(bformat(_(err), from_utf8(name_)),
 289                 Font(inherit_font, buffer().params().language), false);
 290 }
 291
 292
 293 void InsetInfo::setText(docstring const & str)
 294 {
 295         setText(str, Font(inherit_font, buffer().params().language), false);
 296 }
 297
 298
 299 bool InsetInfo::forceLTR() const
 300 {
 301         return !buffer().params().language->rightToLeft();
 302 }
 303
 304
 305 void InsetInfo::updateInfo()
 306 {
 307         BufferParams const & bp = buffer().params();
 308
 309         switch (type_) {
 310         case UNKNOWN_INFO:
 311                 error("Unknown Info: %1$s");
 312                 break;
 313         case SHORTCUT_INFO:
 314         case SHORTCUTS_INFO: {
 315                 FuncRequest const func = lyxaction.lookupFunc(name_);
 316                 if (func.action() == LFUN_UNKNOWN_ACTION) {
 317                         error("Unknown action %1$s");
 318                         break;
 319                 }
 320                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
 321                 if (bindings.empty()) {
 322                         // It is impropriate to use error() for undefined shortcut
 323                         setText(_("undefined"));
 324                         break;
 325                 }
 326                 if (type_ == SHORTCUT_INFO)
 327                         setText(bindings.begin()->print(KeySequence::Portable));
 328                 else
 329                         setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
 330                 break;
 331         }
 332         case LYXRC_INFO: {
 333                 ostringstream oss;
 334                 if (name_.empty()) {
 335                         setText(_("undefined"));
 336                         break;
 337                 }
 338                 lyxrc.write(oss, true, name_);
 339                 string result = oss.str();
 340                 if (result.size() < 2) {
 341                         setText(_("undefined"));
 342                         break;
 343                 }
 344                 string::size_type loc = result.rfind("\n", result.size() - 2);
 345                 loc = loc == string::npos ? 0 : loc + 1;
 346                 if (result.size() < loc + name_.size() + 1
 347                           || result.substr(loc + 1, name_.size()) != name_) {
 348                         setText(_("undefined"));
 349                         break;
 350                 }
 351                 // remove leading comments and \\name and space
 352                 result = result.substr(loc + name_.size() + 2);
 353
 354                 // remove \n and ""
 355                 result = rtrim(result, "\n");
 356                 result = trim(result, "\"");
 357                 setText(from_utf8(result));
 358                 break;
 359         }
 360         case PACKAGE_INFO:
 361                 // check in packages.lst
 362                 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
 363                 break;
 364
 365         case TEXTCLASS_INFO: {
 366                 // name_ is the class name
 367                 LayoutFileList const & list = LayoutFileList::get();
 368                 bool available = false;
 369                 if (list.haveClass(name_))
 370                         available = list[name_].isTeXClassAvailable();
 371                 setText(available ? _("yes") : _("no"));
 372                 break;
 373         }
 374         case MENU_INFO: {
 375                 docstring_list names;
 376                 FuncRequest const func = lyxaction.lookupFunc(name_);
 377                 if (func.action() == LFUN_UNKNOWN_ACTION) {
 378                         error("Unknown action %1$s");
 379                         break;
 380                 }
 381                 // iterate through the menubackend to find it
 382                 if (!theApp()) {
 383                         error("Can't determine menu entry for action %1$s in batch mode");
 384                         break;
 385                 }
 386                 if (!theApp()->searchMenu(func, names)) {
 387                         error("No menu entry for action %1$s");
 388                         break;
 389                 }
 390                 // if found, return its path.
 391                 clear();
 392                 Paragraph & par = paragraphs().front();
 393                 Font const f(inherit_font, buffer().params().language);
 394                 //Font fu = f;
 395                 //fu.fontInfo().setUnderbar(FONT_ON);
 396                 docstring_list::const_iterator beg = names.begin();
 397                 docstring_list::const_iterator end = names.end();
 398                 for (docstring_list::const_iterator it = beg ;
 399                      it != end ; ++it) {
 400                         // do not insert > for the top level menu item
 401                         if (it != beg)
 402                                 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
 403                                                 f, Change(Change::UNCHANGED));
 404                         //FIXME: add proper underlines here. This
 405                         // involves rewriting searchMenu used above to
 406                         // return a vector of menus. If we do not do
 407                         // that, we might as well use below
 408                         // Paragraph::insert on each string (JMarc)
 409                         for (size_type i = 0; i != it->length(); ++i)
 410                                 par.insertChar(par.size(), (*it)[i],
 411                                                f, Change(Change::UNCHANGED));
 412                 }
 413                 break;
 414         }
 415         case ICON_INFO: {
 416                 FuncRequest func = lyxaction.lookupFunc(name_);
 417                 docstring icon_name = frontend::Application::iconName(func, true);
 418                 // FIXME: We should use the icon directly instead of
 419                 // going through FileName. The code below won't work
 420                 // if the icon is embedded in the executable through
 421                 // the Qt resource system.
 422                 // This is only a negligible performance problem:
 423                 // If the installed icon differs from the resource icon the
 424                 // installed one is preferred anyway, and all icons that are
 425                 // embedded in the resources are installed as well.
 426                 FileName file(to_utf8(icon_name));
 427                 if (file.onlyFileNameWithoutExt() == "unknown") {
 428                         string dir = "images";
 429                         FileName file2(imageLibFileSearch(dir, name_, "svgz,png"));
 430                         if (!file2.empty())
 431                                 file = file2;
 432                 }
 433                 if (!file.exists())
 434                         break;
 435                 int percent_scale = 100;
 436                 if (use_gui) {
 437                         // Compute the scale factor for the icon such that its
 438                         // width on screen is equal to 1em in pixels.
 439                         // The scale factor is rounded to the integer nearest
 440                         // to the float value of the ratio 100*iconsize/imgsize.
 441                         int imgsize = QImage(toqstr(file.absFileName())).width();
 442                         if (imgsize > 0) {
 443                                 int iconsize = Length(1, Length::EM).inPixels(1);
 444                                 percent_scale = (100 * iconsize + imgsize / 2)/imgsize;
 445                         }
 446                 }
 447                 InsetGraphics * inset = new InsetGraphics(buffer_);
 448                 InsetGraphicsParams igp;
 449                 igp.filename = file;
 450                 igp.lyxscale = percent_scale;
 451                 igp.scale = string();
 452                 igp.width = Length(1, Length::EM);
 453                 inset->setParams(igp);
 454                 clear();
 455                 Font const f(inherit_font, buffer().params().language);
 456                 paragraphs().front().insertInset(0, inset, f,
 457                                                  Change(Change::UNCHANGED));
 458                 break;
 459         }
 460         case BUFFER_INFO: {
 461                 if (name_ == "name") {
 462                         setText(from_utf8(buffer().fileName().onlyFileName()));
 463                         break;
 464                 }
 465                 if (name_ == "path") {
 466                         setText(from_utf8(os::latex_path(buffer().filePath())));
 467                         break;
 468                 }
 469                 if (name_ == "class") {
 470                         setText(from_utf8(bp.documentClass().name()));
 471                         break;
 472                 }
 473
 474                 // everything that follows is for version control.
 475                 // nothing that isn't version control should go below this line.
 476                 if (!buffer().lyxvc().inUse()) {
 477                         setText(_("No version control"));
 478                         break;
 479                 }
 480                 LyXVC::RevisionInfo itype = LyXVC::Unknown;
 481                 if (name_ == "vcs-revision")
 482                         itype = LyXVC::File;
 483                 else if (name_ == "vcs-tree-revision")
 484                         itype = LyXVC::Tree;
 485                 else if (name_ == "vcs-author")
 486                         itype = LyXVC::Author;
 487                 else if (name_ == "vcs-time")
 488                         itype = LyXVC::Time;
 489                 else if (name_ == "vcs-date")
 490                         itype = LyXVC::Date;
 491                 string binfo = buffer().lyxvc().revisionInfo(itype);
 492                 if (binfo.empty())
 493                         setText(from_ascii(name_) + " unknown");
 494                 else
 495                         setText(from_utf8(binfo));
 496                 break;
 497         }
 498         case LYX_INFO:
 499                 if (name_ == "version")
 500                         setText(from_ascii(lyx_version));
 501                 break;
 502         }
 503 }
 504
 505
 506 string InsetInfo::contextMenu(BufferView const &, int, int) const
 507 {
 508         //FIXME: We override the implementation of InsetCollapsible,
 509         //because this inset is not a collapsible inset.
 510         return contextMenuName();
 511 }
 512
 513
 514 string InsetInfo::contextMenuName() const
 515 {
 516         return "context-info";
 517 }
 518
 519
 520 } // namespace lyx