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 <sstream>
  15 #include <stack>
  16
  17 #include "BufferParams.h"
  18 #include "BufferView.h"
  19 #include "debug.h"
  20 #include "FuncRequest.h"
  21 #include "gettext.h"
  22 #include "InsetSpecialChar.h"
  23 #include "KeyMap.h"
  24 #include "LaTeXFeatures.h"
  25 #include "LyXAction.h"
  26 #include "Lexer.h"
  27 #include "MenuBackend.h"
  28 #include "MetricsInfo.h"
  29 #include "ParagraphParameters.h"
  30 #include "TextClassList.h"
  31 #include "support/lstrings.h"
  32 #include "support/ExceptionMessage.h"
  33
  34 using std::pair;
  35 using std::string;
  36 using std::ostream;
  37 using std::ostringstream;
  38 using std::stack;
  39
  40 namespace lyx {
  41
  42 using support::prefixIs;
  43 using support::trim;
  44 using support::split;
  45 using support::rtrim;
  46 using support::ExceptionMessage;
  47 using support::WarningException;
  48
  49 InsetInfo::InsetInfo(BufferParams const & bp, string const & name)
  50         : InsetText(bp), bp_(bp), 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         return this;
  62 }
  63
  64
  65 void InsetInfo::draw(PainterInfo & pi, int x, int y) const
  66 {
  67         InsetText::draw(pi, x, y);
  68         if (mouse_hover_) {
  69                 odocstringstream os;
  70                 os << _("Information regarding ")
  71                    <<_(nameTranslator().find(type_))
  72                    << _(" ") << from_utf8(name_);
  73                 pi.base.bv->message(os.str());
  74         }
  75 }
  76
  77
  78 namespace {
  79
  80 Translator<InsetInfo::info_type, string> const initTranslator()
  81 {
  82         Translator<InsetInfo::info_type, string> translator(InsetInfo::UNKNOWN_INFO, "unknown");
  83
  84         translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
  85         translator.addPair(InsetInfo::PACKAGE_INFO, "package");
  86         translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
  87         translator.addPair(InsetInfo::MENU_INFO, "menu");
  88
  89         return translator;
  90 }
  91
  92 } // namespace anon
  93
  94 Translator<InsetInfo::info_type, std::string> const & InsetInfo::nameTranslator() const
  95 {
  96         static Translator<info_type, string> const translator =
  97                 initTranslator();
  98         return translator;
  99 }
 100
 101
 102
 103 void InsetInfo::read(Buffer const & buf, Lexer & lex)
 104 {
 105         string token;
 106         while (lex.isOK()) {
 107                 lex.next();
 108                 token = lex.getString();
 109                 if (token == "type") {
 110                         lex.next();
 111                         token = lex.getString();
 112                         type_ = nameTranslator().find(token);
 113                 } else if (token == "arg") {
 114                         lex.next();
 115                         name_ = lex.getString();
 116                 } else if (token == "\\end_inset")
 117                         break;
 118         }
 119         if (token != "\\end_inset") {
 120                 lex.printError("Missing \\end_inset at this point");
 121                 throw ExceptionMessage(WarningException,
 122                         _("Missing \\end_inset at this point."),
 123                         from_utf8(token));
 124         }
 125         updateInfo();
 126 }
 127
 128
 129 void InsetInfo::write(Buffer const & buf, std::ostream & os) const
 130 {
 131         os << "Info\ntype  \""
 132            << nameTranslator().find(type_)
 133            << "\"\narg   \"" << name_ << '\"';
 134 }
 135
 136
 137 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
 138 {
 139         // FIXME: we should allow selection, copy etc...
 140         switch (cmd.action) {
 141         case LFUN_MOUSE_PRESS:
 142         case LFUN_MOUSE_RELEASE:
 143         case LFUN_MOUSE_MOTION:
 144         case LFUN_MOUSE_DOUBLE:
 145         case LFUN_MOUSE_TRIPLE:
 146                 // do not dispatch to InsetText
 147                 cur.dispatched();
 148                 break;
 149
 150         default:
 151                 InsetText::doDispatch(cur, cmd);
 152                 break;
 153         }
 154 }
 155
 156
 157 void InsetInfo::setInfo(string const & name)
 158 {
 159         if (name.empty())
 160                 return;
 161         // info_type name
 162         string type;
 163         name_ = trim(split(name, type, ' '));
 164         type_ = nameTranslator().find(type);
 165         updateInfo();
 166 }
 167
 168
 169 void InsetInfo::updateInfo()
 170 {
 171         InsetText::clear();
 172
 173         switch (type_) {
 174         case UNKNOWN_INFO:
 175                 setText(_("Unknown Info: ") + from_utf8(name_),
 176                         bp_.getFont(), false);
 177                 break;
 178         case SHORTCUT_INFO: {
 179                 FuncRequest func = lyxaction.lookupFunc(name_);
 180                 if (func.action != LFUN_UNKNOWN_ACTION)
 181                         setText(theTopLevelKeymap().printbindings(func),
 182                                 bp_.getFont(), false);
 183                 break;
 184         }
 185         case PACKAGE_INFO:
 186                 // check in packages.lst
 187                 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"),
 188                         bp_.getFont(), false);
 189                 break;
 190         case TEXTCLASS_INFO: {
 191                 // name_ is the class name
 192                 pair<bool, lyx::textclass_type> pp =
 193                         textclasslist.numberOfClass(name_);
 194                 setText(pp.first ? _("yes") : _("no"),
 195                         bp_.getFont(), false);
 196                 break;
 197         }
 198         case MENU_INFO: {
 199                 stack<docstring> names;
 200                 FuncRequest func = lyxaction.lookupFunc(name_);
 201                 if (func.action == LFUN_UNKNOWN_ACTION) {
 202                         setText(_("No menu entry for "), bp_.getFont(), false);
 203                         break;
 204                 }
 205                 // iterate through the menubackend to find it
 206                 Menu menu = menubackend.getMenubar();
 207                 if (!menu.searchFunc(func, names)) {
 208                         setText(_("No menu entry for "), bp_.getFont(), false);
 209                         break;
 210                 }
 211                 // if find, return its path.
 212                 InsetText::clear();
 213                 Paragraph & info = paragraphs().front();
 214                 unsigned int i = 0;
 215                 while (!names.empty()) {
 216                         // do not insert > for the top level menu item
 217                         if (i != 0)
 218                                 info.insertInset(0, new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
 219                                         Change(Change::UNCHANGED));
 220                         for (i = 0; i < names.top().length(); ++i)
 221                                 info.insertChar(i, names.top()[i], bp_.getFont(), false);
 222                         names.pop();
 223                 }
 224                 break;
 225         }
 226         }
 227         // remove indent
 228         paragraphs().begin()->params().noindent(true);
 229 }
 230
 231
 232 bool InsetInfo::setMouseHover(bool mouse_hover)
 233 {
 234         mouse_hover_ = mouse_hover;
 235         return true;
 236 }
 237
 238 } // namespace lyx