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 "LayoutFile.h"
  25 #include "Length.h"
  26 #include "LyXAction.h"
  27 #include "LyXRC.h"
  28 #include "LyXVC.h"
  29 #include "Lexer.h"
  30 #include "ParagraphParameters.h"
  31 #include "version.h"
  32
  33 #include "frontends/Application.h"
  34
  35 #include "support/convert.h"
  36 #include "support/debug.h"
  37 #include "support/docstream.h"
  38 #include "support/docstring_list.h"
  39 #include "support/ExceptionMessage.h"
  40 #include "support/FileName.h"
  41 #include "support/filetools.h"
  42 #include "support/gettext.h"
  43 #include "support/lstrings.h"
  44 #include "support/qstring_helpers.h"
  45 #include "support/Translator.h"
  46
  47 #include <sstream>
  48
  49 #include <QtGui/QImage>
  50
  51 using namespace std;
  52 using namespace lyx::support;
  53
  54 namespace lyx {
  55
  56 namespace {
  57
  58 typedef Translator<InsetInfo::info_type, string> NameTranslator;
  59
  60 NameTranslator const initTranslator()
  61 {
  62         NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
  63
  64         translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
  65         translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
  66         translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
  67         translator.addPair(InsetInfo::PACKAGE_INFO, "package");
  68         translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
  69         translator.addPair(InsetInfo::MENU_INFO, "menu");
  70         translator.addPair(InsetInfo::ICON_INFO, "icon");
  71         translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
  72         translator.addPair(InsetInfo::LYX_INFO, "lyxinfo");
  73
  74         return translator;
  75 }
  76
  77 /// The translator between the information type enum and corresponding string.
  78 NameTranslator const & nameTranslator()
  79 {
  80         static NameTranslator const translator = initTranslator();
  81         return translator;
  82 }
  83
  84 } // namespace
  85
  86 /////////////////////////////////////////////////////////////////////////
  87 //
  88 // InsetInfo
  89 //
  90 /////////////////////////////////////////////////////////////////////////
  91
  92
  93
  94 InsetInfo::InsetInfo(Buffer * buf, string const & name)
  95         : InsetCollapsible(buf), initialized_(false),
  96           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 }
 152
 153
 154 void InsetInfo::write(ostream & os) const
 155 {
 156         os << "Info\ntype  \"" << infoType()
 157            << "\"\narg   " << Lexer::quoteString(name_);
 158 }
 159
 160
 161 bool InsetInfo::validateModifyArgument(docstring const & arg) const
 162 {
 163         string type;
 164         string const name = trim(split(to_utf8(arg), type, ' '));
 165
 166         switch (nameTranslator().find(type)) {
 167         case UNKNOWN_INFO:
 168                 return false;
 169
 170         case SHORTCUT_INFO:
 171         case SHORTCUTS_INFO:
 172         case MENU_INFO: {
 173                 FuncRequest func = lyxaction.lookupFunc(name);
 174                 return func.action() != LFUN_UNKNOWN_ACTION;
 175         }
 176
 177         case ICON_INFO: {
 178                 FuncCode const action = lyxaction.lookupFunc(name).action();
 179                 if (action == LFUN_UNKNOWN_ACTION) {
 180                         string dir = "images";
 181                         return !imageLibFileSearch(dir, name, "svgz,png").empty();
 182                 }
 183                 return true;
 184         }
 185
 186         case LYXRC_INFO: {
 187                 ostringstream oss;
 188                 lyxrc.write(oss, true, name);
 189                 return !oss.str().empty();
 190         }
 191
 192         case PACKAGE_INFO:
 193         case TEXTCLASS_INFO:
 194                 return true;
 195
 196         case BUFFER_INFO:
 197                 if (name == "name" || name == "path" || name == "class")
 198                         return true;
 199                 if (name == "vcs-revision" || name == "vcs-tree-revision" ||
 200                        name == "vcs-author" || name == "vcs-date" || name == "vcs-time")
 201                         return buffer().lyxvc().inUse();
 202                 return false;
 203
 204         case LYX_INFO:
 205                 return name == "version";
 206         }
 207
 208         return false;
 209 }
 210
 211
 212 bool InsetInfo::showInsetDialog(BufferView * bv) const
 213 {
 214         bv->showDialog("info");
 215         return true;
 216 }
 217
 218
 219 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
 220                 FuncStatus & flag) const
 221 {
 222         switch (cmd.action()) {
 223         case LFUN_INSET_SETTINGS:
 224                 return InsetCollapsible::getStatus(cur, cmd, flag);
 225
 226         case LFUN_INSET_DIALOG_UPDATE:
 227         case LFUN_INSET_COPY_AS:
 228                 flag.setEnabled(true);
 229                 return true;
 230
 231         case LFUN_INSET_MODIFY:
 232                 if (validateModifyArgument(cmd.argument())) {
 233                         flag.setEnabled(true);
 234                         return true;
 235                 }
 236                 //fall through
 237
 238         default:
 239                 return false;
 240         }
 241 }
 242
 243
 244 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
 245 {
 246         switch (cmd.action()) {
 247         case LFUN_INSET_MODIFY:
 248                 cur.recordUndo();
 249                 setInfo(to_utf8(cmd.argument()));
 250                 initialized_ = false;
 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 }
 283
 284
 285 void InsetInfo::error(string const & err)
 286 {
 287         setText(bformat(_(err), from_utf8(name_)),
 288                 Font(inherit_font, buffer().params().language), false);
 289 }
 290
 291
 292 void InsetInfo::setText(docstring const & str)
 293 {
 294         setText(str, Font(inherit_font, buffer().params().language), false);
 295 }
 296
 297
 298 void InsetInfo::updateBuffer(ParIterator const & it, UpdateType utype) {
 299         BufferParams const & bp = buffer().params();
 300
 301         switch (type_) {
 302         case UNKNOWN_INFO:
 303                 error("Unknown Info: %1$s");
 304                 initialized_ = false;
 305                 break;
 306         case SHORTCUT_INFO:
 307         case SHORTCUTS_INFO: {
 308                 // only need to do this once.
 309                 if (initialized_)
 310                         break;
 311                 // and we will not keep trying if we fail
 312                 initialized_ = true;
 313                 FuncRequest const func = lyxaction.lookupFunc(name_);
 314                 if (func.action() == LFUN_UNKNOWN_ACTION) {
 315                         error("Unknown action %1$s");
 316                         break;
 317                 }
 318                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
 319                 if (bindings.empty()) {
 320                         // It is impropriate to use error() for undefined shortcut
 321                         setText(_("undefined"));
 322                         break;
 323                 }
 324                 if (type_ == SHORTCUT_INFO)
 325                         setText(bindings.begin()->print(KeySequence::Portable));
 326                 else
 327                         setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
 328                 break;
 329         }
 330         case LYXRC_INFO: {
 331                 // this information could actually change, if the preferences are changed,
 332                 // so we will recalculate each time through.
 333                 ostringstream oss;
 334                 if (name_.empty()) {
 335                         setText(_("undefined"));
 336                         break;
 337                 }
 338                 // FIXME this uses the serialization mechanism to get the info
 339                 // we want, which i guess works but is a bit strange.
 340                 lyxrc.write(oss, true, name_);
 341                 string result = oss.str();
 342                 if (result.size() < 2) {
 343                         setText(_("undefined"));
 344                         break;
 345                 }
 346                 string::size_type loc = result.rfind("\n", result.size() - 2);
 347                 loc = loc == string::npos ? 0 : loc + 1;
 348                 if (result.size() < loc + name_.size() + 1
 349                           || result.substr(loc + 1, name_.size()) != name_) {
 350                         setText(_("undefined"));
 351                         break;
 352                 }
 353                 // remove leading comments and \\name and space
 354                 result = result.substr(loc + name_.size() + 2);
 355
 356                 // remove \n and ""
 357                 result = rtrim(result, "\n");
 358                 result = trim(result, "\"");
 359                 setText(from_utf8(result));
 360                 break;
 361         }
 362         case PACKAGE_INFO:
 363                 // only need to do this once.
 364                 if (initialized_)
 365                         break;
 366                 // check in packages.lst
 367                 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
 368                 initialized_ = true;
 369                 break;
 370
 371         case TEXTCLASS_INFO: {
 372                 // only need to do this once.
 373                 if (initialized_)
 374                         break;
 375                 // name_ is the class name
 376                 LayoutFileList const & list = LayoutFileList::get();
 377                 bool available = false;
 378                 if (list.haveClass(name_))
 379                         available = list[name_].isTeXClassAvailable();
 380                 setText(available ? _("yes") : _("no"));
 381                 initialized_ = true;
 382                 break;
 383         }
 384         case MENU_INFO: {
 385                 // only need to do this once.
 386                 if (initialized_)
 387                         break;
 388                 // and we will not keep trying if we fail
 389                 initialized_ = true;
 390                 docstring_list names;
 391                 FuncRequest const func = lyxaction.lookupFunc(name_);
 392                 if (func.action() == LFUN_UNKNOWN_ACTION) {
 393                         error("Unknown action %1$s");
 394                         break;
 395                 }
 396                 // iterate through the menubackend to find it
 397                 if (!theApp()) {
 398                         error("Can't determine menu entry for action %1$s in batch mode");
 399                         break;
 400                 }
 401                 if (!theApp()->searchMenu(func, names)) {
 402                         error("No menu entry for action %1$s");
 403                         break;
 404                 }
 405                 // if found, return its path.
 406                 clear();
 407                 Paragraph & par = paragraphs().front();
 408                 Font const f(inherit_font, buffer().params().language);
 409                 //Font fu = f;
 410                 //fu.fontInfo().setUnderbar(FONT_ON);
 411                 for (docstring const & name : names) {
 412                         // do not insert > for the top level menu item
 413                         if (&name != &names.front())
 414                                 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
 415                                                 f, Change(Change::UNCHANGED));
 416                         //FIXME: add proper underlines here. This
 417                         // involves rewriting searchMenu used above to
 418                         // return a vector of menus. If we do not do
 419                         // that, we might as well use below
 420                         // Paragraph::insert on each string (JMarc)
 421                         for (char_type c : name)
 422                                 par.insertChar(par.size(), c, f, Change(Change::UNCHANGED));
 423                 }
 424                 break;
 425         }
 426         case ICON_INFO: {
 427                 // only need to do this once.
 428                 if (initialized_)
 429                         break;
 430                 // and we will not keep trying if we fail
 431                 initialized_ = true;
 432                 FuncRequest func = lyxaction.lookupFunc(name_);
 433                 docstring icon_name = frontend::Application::iconName(func, true);
 434                 // FIXME: We should use the icon directly instead of
 435                 // going through FileName. The code below won't work
 436                 // if the icon is embedded in the executable through
 437                 // the Qt resource system.
 438                 // This is only a negligible performance problem:
 439                 // If the installed icon differs from the resource icon the
 440                 // installed one is preferred anyway, and all icons that are
 441                 // embedded in the resources are installed as well.
 442                 FileName file(to_utf8(icon_name));
 443                 if (file.onlyFileNameWithoutExt() == "unknown") {
 444                         string dir = "images";
 445                         FileName file2(imageLibFileSearch(dir, name_, "svgz,png"));
 446                         if (!file2.empty())
 447                                 file = file2;
 448                 }
 449                 if (!file.exists())
 450                         break;
 451                 int percent_scale = 100;
 452                 if (use_gui) {
 453                         // Compute the scale factor for the icon such that its
 454                         // width on screen is equal to 1em in pixels.
 455                         // The scale factor is rounded to the integer nearest
 456                         // to the float value of the ratio 100*iconsize/imgsize.
 457                         int imgsize = QImage(toqstr(file.absFileName())).width();
 458                         if (imgsize > 0) {
 459                                 int iconsize = Length(1, Length::EM).inPixels(1);
 460                                 percent_scale = (100 * iconsize + imgsize / 2)/imgsize;
 461                         }
 462                 }
 463                 InsetGraphics * inset = new InsetGraphics(buffer_);
 464                 InsetGraphicsParams igp;
 465                 igp.filename = file;
 466                 igp.lyxscale = percent_scale;
 467                 igp.scale = string();
 468                 igp.width = Length(1, Length::EM);
 469                 inset->setParams(igp);
 470                 clear();
 471                 Font const f(inherit_font, buffer().params().language);
 472                 paragraphs().front().insertInset(0, inset, f,
 473                                                  Change(Change::UNCHANGED));
 474                 break;
 475         }
 476         case BUFFER_INFO: {
 477                 // this could all change, so we will recalculate each time
 478                 if (name_ == "name") {
 479                         setText(from_utf8(buffer().fileName().onlyFileName()));
 480                         break;
 481                 }
 482                 if (name_ == "path") {
 483                         setText(from_utf8(os::latex_path(buffer().filePath())));
 484                         break;
 485                 }
 486                 if (name_ == "class") {
 487                         setText(from_utf8(bp.documentClass().name()));
 488                         break;
 489                 }
 490
 491                 ////////////////////////////////////////////////////////////////
 492                 // everything that follows is for version control.
 493                 // nothing that isn't version control should go below this line.
 494
 495                 // this information could change, in principle, so we will
 496                 // recalculate each time through
 497                 if (!buffer().lyxvc().inUse()) {
 498                         setText(_("No version control"));
 499                         break;
 500                 }
 501                 LyXVC::RevisionInfo itype = LyXVC::Unknown;
 502                 if (name_ == "vcs-revision")
 503                         itype = LyXVC::File;
 504                 else if (name_ == "vcs-tree-revision")
 505                         itype = LyXVC::Tree;
 506                 else if (name_ == "vcs-author")
 507                         itype = LyXVC::Author;
 508                 else if (name_ == "vcs-time")
 509                         itype = LyXVC::Time;
 510                 else if (name_ == "vcs-date")
 511                         itype = LyXVC::Date;
 512                 string binfo = buffer().lyxvc().revisionInfo(itype);
 513                 if (binfo.empty())
 514                         setText(from_ascii(name_) + " unknown");
 515                 else
 516                         setText(from_utf8(binfo));
 517                 break;
 518         }
 519         case LYX_INFO:
 520                 // only need to do this once.
 521                 if (initialized_)
 522                         break;
 523                 if (name_ == "version")
 524                         setText(from_ascii(lyx_version));
 525                 initialized_ = true;
 526                 break;
 527         }
 528         InsetCollapsible::updateBuffer(it, utype);
 529 }
 530
 531
 532 string InsetInfo::contextMenu(BufferView const &, int, int) const
 533 {
 534         //FIXME: We override the implementation of InsetCollapsible,
 535         //because this inset is not a collapsible inset.
 536         return contextMenuName();
 537 }
 538
 539
 540 string InsetInfo::contextMenuName() const
 541 {
 542         return "context-info";
 543 }
 544
 545
 546 } // namespace lyx