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
  14 #include "Buffer.h"
  15 #include "BufferParams.h"
  16 #include "BufferView.h"
  17 #include "FuncRequest.h"
  18 #include "FuncStatus.h"
  19 #include "InsetGraphics.h"
  20 #include "InsetSpecialChar.h"
  21 #include "KeyMap.h"
  22 #include "LaTeXFeatures.h"
  23 #include "LayoutFile.h"
  24 #include "LyXAction.h"
  25 #include "LyXRC.h"
  26 #include "LyXVC.h"
  27 #include "Lexer.h"
  28 #include "ParagraphParameters.h"
  29
  30 #include "frontends/Application.h"
  31
  32 #include "support/debug.h"
  33 #include "support/docstream.h"
  34 #include "support/docstring_list.h"
  35 #include "support/ExceptionMessage.h"
  36 #include "support/FileName.h"
  37 #include "support/filetools.h"
  38 #include "support/gettext.h"
  39 #include "support/lstrings.h"
  40
  41 #include <sstream>
  42
  43 using namespace std;
  44 using namespace lyx::support;
  45
  46 namespace lyx {
  47
  48 namespace {
  49
  50 typedef Translator<InsetInfo::info_type, string> NameTranslator;
  51
  52 NameTranslator const initTranslator()
  53 {
  54         NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
  55
  56         translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
  57         translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
  58         translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
  59         translator.addPair(InsetInfo::PACKAGE_INFO, "package");
  60         translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
  61         translator.addPair(InsetInfo::MENU_INFO, "menu");
  62         translator.addPair(InsetInfo::ICON_INFO, "icon");
  63         translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
  64         translator.addPair(InsetInfo::LYX_INFO, "lyxinfo");
  65
  66         return translator;
  67 }
  68
  69 /// The translator between the information type enum and corresponding string.
  70 NameTranslator const & nameTranslator()
  71 {
  72         static NameTranslator const translator = initTranslator();
  73         return translator;
  74 }
  75
  76 } // namespace anon
  77
  78 /////////////////////////////////////////////////////////////////////////
  79 //
  80 // InsetInfo
  81 //
  82 /////////////////////////////////////////////////////////////////////////
  83
  84
  85
  86 InsetInfo::InsetInfo(Buffer * buf, string const & name)
  87         : InsetCollapsable(buf), type_(UNKNOWN_INFO), name_()
  88 {
  89         setAutoBreakRows(true);
  90         setInfo(name);
  91         status_ = Collapsed;
  92 }
  93
  94
  95 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
  96 {
  97         // do not allow the cursor to be set in this Inset
  98         return Inset::editXY(cur, x, y);
  99 }
 100
 101
 102 string InsetInfo::infoType() const
 103 {
 104         return nameTranslator().find(type_);
 105 }
 106
 107
 108 docstring InsetInfo::name() const
 109 {
 110         return from_ascii("Info:" + infoType());
 111 }
 112
 113
 114 docstring InsetInfo::toolTip(BufferView const &, int, int) const
 115 {
 116         return bformat(_("Information regarding %1$s '%2$s'"),
 117                         _(infoType()), from_utf8(name_));
 118 }
 119
 120
 121 void InsetInfo::read(Lexer & lex)
 122 {
 123         string token;
 124         while (lex.isOK()) {
 125                 lex.next();
 126                 token = lex.getString();
 127                 if (token == "type") {
 128                         lex.next();
 129                         token = lex.getString();
 130                         type_ = nameTranslator().find(token);
 131                 } else if (token == "arg") {
 132                         lex.next(true);
 133                         name_ = lex.getString();
 134                 } else if (token == "\\end_inset")
 135                         break;
 136         }
 137         if (token != "\\end_inset") {
 138                 lex.printError("Missing \\end_inset at this point");
 139                 throw ExceptionMessage(WarningException,
 140                         _("Missing \\end_inset at this point."),
 141                         from_utf8(token));
 142         }
 143         updateInfo();
 144 }
 145
 146
 147 void InsetInfo::write(ostream & os) const
 148 {
 149         os << "Info\ntype  \"" << infoType()
 150            << "\"\narg   " << Lexer::quoteString(name_);
 151 }
 152
 153
 154 bool InsetInfo::validateModifyArgument(docstring const & arg) const
 155 {
 156         string type;
 157         string const name = trim(split(to_utf8(arg), type, ' '));
 158
 159         switch (nameTranslator().find(type)) {
 160         case UNKNOWN_INFO:
 161                 return false;
 162
 163         case SHORTCUT_INFO:
 164         case SHORTCUTS_INFO:
 165         case MENU_INFO:
 166         case ICON_INFO: {
 167                 FuncRequest func = lyxaction.lookupFunc(name);
 168                 return func.action() != LFUN_UNKNOWN_ACTION;
 169         }
 170
 171         case LYXRC_INFO: {
 172                 ostringstream oss;
 173                 lyxrc.write(oss, true, name);
 174                 return !oss.str().empty();
 175         }
 176
 177         case PACKAGE_INFO:
 178         case TEXTCLASS_INFO:
 179                 return true;
 180
 181         case BUFFER_INFO:
 182                 if (name == "name" || name == "path" || name == "class")
 183                         return true;
 184                 if (name == "vcs-revision" || name == "vcs-tree-revision" ||
 185                        name == "vcs-author" || name == "vcs-date" || name == "vcs-time")
 186                         return buffer().lyxvc().inUse();
 187                 return false;
 188
 189         case LYX_INFO:
 190                 return name == "version";
 191         }
 192
 193         return false;
 194 }
 195
 196
 197 bool InsetInfo::showInsetDialog(BufferView * bv) const
 198 {
 199         bv->showDialog("info");
 200         return true;
 201 }
 202
 203
 204 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
 205                 FuncStatus & flag) const
 206 {
 207         switch (cmd.action()) {
 208         case LFUN_INSET_SETTINGS:
 209                 return InsetCollapsable::getStatus(cur, cmd, flag);
 210
 211         case LFUN_INSET_DIALOG_UPDATE:
 212                 flag.setEnabled(true);
 213                 return true;
 214
 215         case LFUN_INSET_MODIFY:
 216                 if (validateModifyArgument(cmd.argument())) {
 217                         flag.setEnabled(true);
 218                         return true;
 219                 }
 220                 //fall through
 221
 222         default:
 223                 return false;
 224         }
 225 }
 226
 227
 228 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
 229 {
 230         switch (cmd.action()) {
 231         case LFUN_INSET_MODIFY:
 232                 setInfo(to_utf8(cmd.argument()));
 233                 break;
 234
 235         default:
 236                 InsetCollapsable::doDispatch(cur, cmd);
 237                 break;
 238         }
 239 }
 240
 241
 242 void InsetInfo::setInfo(string const & name)
 243 {
 244         if (name.empty())
 245                 return;
 246         // info_type name
 247         string type;
 248         name_ = trim(split(name, type, ' '));
 249         type_ = nameTranslator().find(type);
 250         updateInfo();
 251 }
 252
 253
 254 void InsetInfo::error(string const & err)
 255 {
 256         setText(bformat(_(err), from_utf8(name_)),
 257                 Font(inherit_font, buffer().params().language), false);
 258 }
 259
 260
 261 void InsetInfo::setText(docstring const & str)
 262 {
 263         setText(str, Font(inherit_font, buffer().params().language), false);
 264 }
 265
 266
 267 void InsetInfo::updateInfo()
 268 {
 269         BufferParams const & bp = buffer().params();
 270
 271         switch (type_) {
 272         case UNKNOWN_INFO:
 273                 error("Unknown Info: %1$s");
 274                 break;
 275         case SHORTCUT_INFO:
 276         case SHORTCUTS_INFO: {
 277                 FuncRequest const func = lyxaction.lookupFunc(name_);
 278                 if (func.action() == LFUN_UNKNOWN_ACTION) {
 279                         error("Unknown action %1$s");
 280                         break;
 281                 }
 282                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
 283                 if (bindings.empty()) {
 284                         // It is impropriate to use error() for undefined shortcut
 285                         setText(_("undefined"));
 286                         break;
 287                 }
 288                 if (type_ == SHORTCUT_INFO)
 289                         setText(bindings.begin()->print(KeySequence::Portable));
 290                 else
 291                         setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
 292                 break;
 293         }
 294         case LYXRC_INFO: {
 295                 ostringstream oss;
 296                 lyxrc.write(oss, true, name_);
 297                 string result = oss.str();
 298                 // remove leading \\name
 299                 result = result.substr(name_.size() + 2);
 300                 // remove \n and ""
 301                 result = rtrim(result, "\n");
 302                 result = trim(result, "\"");
 303                 setText(from_utf8(result));
 304                 break;
 305         }
 306         case PACKAGE_INFO:
 307                 // check in packages.lst
 308                 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
 309                 break;
 310         case TEXTCLASS_INFO: {
 311                 // name_ is the class name
 312                 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
 313                 break;
 314         }
 315         case MENU_INFO: {
 316                 docstring_list names;
 317                 FuncRequest const func = lyxaction.lookupFunc(name_);
 318                 if (func.action() == LFUN_UNKNOWN_ACTION) {
 319                         error("Unknown action %1$s");
 320                         break;
 321                 }
 322                 // iterate through the menubackend to find it
 323                 if (!theApp()->searchMenu(func, names)) {
 324                         error("No menu entry for action %1$s");
 325                         break;
 326                 }
 327                 // if found, return its path.
 328                 clear();
 329                 Paragraph & par = paragraphs().front();
 330                 Font const f(inherit_font, buffer().params().language);
 331                 //Font fu = f;
 332                 //fu.fontInfo().setUnderbar(FONT_ON);
 333                 docstring_list::const_iterator beg = names.begin();
 334                 docstring_list::const_iterator end = names.end();
 335                 for (docstring_list::const_iterator it = beg ;
 336                      it != end ; ++it) {
 337                         // do not insert > for the top level menu item
 338                         if (it != beg)
 339                                 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
 340                                                 Change(Change::UNCHANGED));
 341                         //FIXME: add proper underlines here. This
 342                         // involves rewriting searchMenu used above to
 343                         // return a vector of menus. If we do not do
 344                         // that, we might as well use below
 345                         // Paragraph::insert on each string (JMarc)
 346                         for (size_type i = 0; i != it->length(); ++i)
 347                                 par.insertChar(par.size(), (*it)[i],
 348                                                f, Change(Change::UNCHANGED));
 349                 }
 350                 break;
 351         }
 352         case ICON_INFO: {
 353                 FuncRequest func = lyxaction.lookupFunc(name_);
 354                 docstring icon_name = theApp()->iconName(func, true);
 355                 //FIXME: We should use the icon directly instead of
 356                 // going through FileName. The code below won't work
 357                 // if the icon is embedded in the executable through
 358                 // the Qt resource system.
 359                 FileName file(to_utf8(icon_name));
 360                 if (!file.exists())
 361                         break;
 362                 InsetGraphics * inset = new InsetGraphics(buffer_);
 363                 InsetGraphicsParams igp;
 364                 igp.filename = file;
 365                 inset->setParams(igp);
 366                 clear();
 367                 paragraphs().front().insertInset(0, inset,
 368                                                  Change(Change::UNCHANGED));
 369                 break;
 370         }
 371         case BUFFER_INFO: {
 372                 if (name_ == "name") {
 373                         setText(from_utf8(buffer().fileName().onlyFileName()));
 374                         break;
 375                 }
 376                 if (name_ == "path") {
 377                         setText(from_utf8(buffer().filePath()));
 378                         break;
 379                 }
 380                 if (name_ == "class") {
 381                         setText(from_utf8(bp.documentClass().name()));
 382                         break;
 383                 }
 384
 385                 // everything that follows is for version control.
 386                 // nothing that isn't version control should go below this line.
 387                 if (!buffer().lyxvc().inUse()) {
 388                         setText(_("No version control"));
 389                         break;
 390                 }
 391                 LyXVC::RevisionInfo itype = LyXVC::Unknown;
 392                 if (name_ == "vcs-revision")
 393                         itype = LyXVC::File;
 394                 else if (name_ == "vcs-tree-revision")
 395                         itype = LyXVC::Tree;
 396                 else if (name_ == "vcs-author")
 397                         itype = LyXVC::Author;
 398                 else if (name_ == "vcs-time")
 399                         itype = LyXVC::Time;
 400                 else if (name_ == "vcs-date")
 401                         itype = LyXVC::Date;
 402                 string binfo = buffer().lyxvc().revisionInfo(itype);
 403                 if (binfo.empty())
 404                         setText(bformat(_("[[%1$s unknown]]"), from_utf8(name_)));
 405                 else
 406                         setText(from_utf8(binfo));
 407                 break;
 408         }
 409         case LYX_INFO:
 410                 if (name_ == "version")
 411                         setText(from_ascii(PACKAGE_VERSION));
 412                 break;
 413         }
 414 }
 415
 416
 417 docstring InsetInfo::contextMenu(BufferView const &, int, int) const
 418 {
 419         return from_ascii("context-info");
 420 }
 421
 422
 423 } // namespace lyx