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 "LayoutFile.h"
  15 #include "Buffer.h"
  16 #include "BufferParams.h"
  17 #include "BufferView.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 "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/FileName.h"
  36 #include "support/filetools.h"
  37 #include "support/gettext.h"
  38 #include "support/lstrings.h"
  39 #include "support/ExceptionMessage.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 & argument) const
 151 {
 152         // FIXME!
 153         return true;
 154 }
 155
 156
 157 bool InsetInfo::showInsetDialog(BufferView * bv) const
 158 {
 159         bv->showDialog("info");
 160         return true;
 161 }
 162
 163
 164 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
 165                 FuncStatus & flag) const
 166 {
 167         switch (cmd.action) {
 168         case LFUN_MOUSE_PRESS:
 169         case LFUN_MOUSE_RELEASE:
 170         case LFUN_MOUSE_MOTION:
 171         case LFUN_MOUSE_DOUBLE:
 172         case LFUN_MOUSE_TRIPLE:
 173         case LFUN_COPY:
 174         case LFUN_INSET_SETTINGS:
 175                 return InsetText::getStatus(cur, cmd, flag);
 176
 177         case LFUN_INSET_MODIFY:
 178                 flag.setEnabled(true);
 179                 break;
 180
 181         default:
 182                 return false;
 183         }
 184         return true;
 185 }
 186
 187
 188 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
 189 {
 190         // allow selection, copy but not cut, delete etc
 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                 InsetText::doDispatch(cur, cmd);
 200                 break;
 201
 202         case LFUN_INSET_MODIFY:
 203                 setInfo(to_utf8(cmd.argument()));
 204                 cur.pos() = 0;
 205                 break;
 206
 207         default:
 208                 break;
 209         }
 210 }
 211
 212
 213 void InsetInfo::setInfo(string const & name)
 214 {
 215         if (name.empty())
 216                 return;
 217         // info_type name
 218         string type;
 219         name_ = trim(split(name, type, ' '));
 220         type_ = nameTranslator().find(type);
 221         updateInfo();
 222 }
 223
 224
 225 void InsetInfo::error(string const & err)
 226 {
 227         InsetText::setText(bformat(_(err), from_utf8(name_)), buffer().params().getFont(),
 228                 false);
 229 }
 230
 231
 232 void InsetInfo::setText(docstring const & str)
 233 {
 234         InsetText::setText(str, buffer().params().getFont(), false);
 235 }
 236
 237
 238 void InsetInfo::updateInfo()
 239 {
 240         InsetText::clear();
 241
 242         BufferParams const & bp = buffer().params();
 243
 244         switch (type_) {
 245         case UNKNOWN_INFO:
 246                 error("Unknown Info: %1$s");
 247                 break;
 248         case SHORTCUT_INFO:
 249         case SHORTCUTS_INFO: {
 250                 FuncRequest func = lyxaction.lookupFunc(name_);
 251                 if (func.action == LFUN_UNKNOWN_ACTION) {
 252                         error("Unknown action %1$s");
 253                         break;
 254                 }
 255                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
 256                 if (bindings.empty()) {
 257                         error("No binding for action %1$s");
 258                         break;
 259                 }
 260                 if (type_ == SHORTCUT_INFO)
 261                         setText(bindings.rbegin()->print(KeySequence::ForGui));
 262                 else
 263                         setText(theTopLevelKeymap().printBindings(func));
 264                 break;
 265         }
 266         case LYXRC_INFO: {
 267                 ostringstream oss;
 268                 lyxrc.write(oss, true, name_);
 269                 string result = oss.str();
 270                 // remove leading \\name
 271                 result = result.substr(name_.size() + 2);
 272                 // remove \n and ""
 273                 result = rtrim(result, "\n");
 274                 result = trim(result, "\"");
 275                 setText(from_utf8(result));
 276                 break;
 277         }
 278         case PACKAGE_INFO:
 279                 // check in packages.lst
 280                 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
 281                 break;
 282         case TEXTCLASS_INFO: {
 283                 // name_ is the class name
 284                 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
 285                 break;
 286         }
 287         case MENU_INFO: {
 288                 docstring_list names;
 289                 FuncRequest func = lyxaction.lookupFunc(name_);
 290                 if (func.action == LFUN_UNKNOWN_ACTION) {
 291                         error("Unknown action %1$s");
 292                         break;
 293                 }
 294                 // iterate through the menubackend to find it
 295                 if (!theApp()->searchMenu(func, names)) {
 296                         error("No menu entry for action %1$s");
 297                         break;
 298                 }
 299                 // if find, return its path.
 300                 InsetText::clear();
 301                 Paragraph & info = paragraphs().front();
 302                 unsigned int i = 0;
 303                 while (!names.empty()) {
 304                         // do not insert > for the top level menu item
 305                         if (i != 0)
 306                                 info.insertInset(0, new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
 307                                         Change(Change::UNCHANGED));
 308                         for (i = 0; i != names.back().length(); ++i)
 309                                 info.insertChar(i, names.back()[i], bp.getFont(), false);
 310                         names.pop_back();
 311                 }
 312                 break;
 313         }
 314         case ICON_INFO: {
 315                 FuncRequest func = lyxaction.lookupFunc(name_);
 316                 docstring icon_name = theApp()->iconName(func, true);
 317                 //FIXME: We should use the icon directly instead of going through
 318                 // FileName. The code below won't work if the icon is embedded in the
 319                 // executable through the Qt resource system.
 320                 FileName file(to_utf8(icon_name));
 321                 if (!file.exists())
 322                         break;
 323                 InsetGraphicsParams igp;
 324                 igp.filename = file;
 325                 InsetGraphics * inset = new InsetGraphics(buffer());
 326                 inset->setParams(igp);
 327                 paragraphs().front().insertInset(0, inset, Change(Change::UNCHANGED));
 328                 break;
 329         }
 330         case BUFFER_INFO: {
 331                 if (name_ == "name")
 332                         setText(from_utf8(buffer().fileName().onlyFileName()));
 333                 else if (name_ == "path")
 334                         setText(from_utf8(buffer().filePath()));
 335                 else if (name_ == "class")
 336                         setText(from_utf8(bp.documentClass().name()));
 337                 else
 338                         setText(_("Unknown buffer info"));
 339                 break;
 340         }
 341         }
 342         // remove indent
 343         paragraphs().begin()->params().noindent(true);
 344 }
 345
 346
 347 bool InsetInfo::setMouseHover(bool mouse_hover)
 348 {
 349         mouse_hover_ = mouse_hover;
 350         return true;
 351 }
 352
 353
 354 docstring InsetInfo::contextMenu(BufferView const &, int, int) const
 355 {
 356         return from_ascii("context-info");
 357 }
 358
 359 } // namespace lyx