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