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