3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
12 #include "InsetInfo.h"
14 #include "LayoutFile.h"
16 #include "BufferParams.h"
17 #include "BufferView.h"
18 #include "FuncRequest.h"
19 #include "InsetSpecialChar.h"
21 #include "LaTeXFeatures.h"
22 #include "LyXAction.h"
25 #include "MetricsInfo.h"
26 #include "ParagraphParameters.h"
28 #include "frontends/Application.h"
30 #include "support/debug.h"
31 #include "support/docstream.h"
32 #include "support/docstring_list.h"
33 #include "support/FileName.h"
34 #include "support/gettext.h"
35 #include "support/lstrings.h"
36 #include "support/ExceptionMessage.h"
41 using namespace lyx::support;
46 InsetInfo::InsetInfo(Buffer const & buf, string const & name)
47 : InsetText(buf), type_(UNKNOWN_INFO), name_(),
50 setAutoBreakRows(true);
56 Inset * InsetInfo::editXY(Cursor &, int, int)
62 void InsetInfo::draw(PainterInfo & pi, int x, int y) const
64 InsetText::draw(pi, x, y);
67 os << _("Information regarding ")
68 <<_(nameTranslator().find(type_))
69 << " " << from_utf8(name_);
70 pi.base.bv->message(os.str());
77 Translator<InsetInfo::info_type, string> const initTranslator()
79 Translator<InsetInfo::info_type, string>
80 translator(InsetInfo::UNKNOWN_INFO, "unknown");
82 translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
83 translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
84 translator.addPair(InsetInfo::PACKAGE_INFO, "package");
85 translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
86 translator.addPair(InsetInfo::MENU_INFO, "menu");
87 translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
94 Translator<InsetInfo::info_type, string>
95 const & InsetInfo::nameTranslator() const
97 static Translator<info_type, string> const translator = initTranslator();
103 void InsetInfo::read(Lexer & lex)
108 token = lex.getString();
109 if (token == "type") {
111 token = lex.getString();
112 type_ = nameTranslator().find(token);
113 } else if (token == "arg") {
115 name_ = lex.getString();
116 } else if (token == "\\end_inset")
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."),
129 void InsetInfo::write(ostream & os) const
131 os << "Info\ntype \"" << nameTranslator().find(type_)
132 << "\"\narg \"" << name_ << '\"';
136 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
138 // FIXME: we should allow selection, copy etc...
139 switch (cmd.action) {
140 case LFUN_MOUSE_PRESS:
141 case LFUN_MOUSE_RELEASE:
142 case LFUN_MOUSE_MOTION:
143 case LFUN_MOUSE_DOUBLE:
144 case LFUN_MOUSE_TRIPLE:
145 // do not dispatch to InsetText
150 InsetText::doDispatch(cur, cmd);
156 void InsetInfo::setInfo(string const & name)
162 name_ = trim(split(name, type, ' '));
163 type_ = nameTranslator().find(type);
167 void InsetInfo::updateInfo()
171 BufferParams const & bp = buffer().params();
175 setText(_("Unknown Info: ") + from_utf8(name_),
176 bp.getFont(), false);
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);
187 lyxrc.write(oss, true, name_);
188 string result = oss.str();
189 // remove leading \\name
190 result = result.substr(name_.size() + 2);
192 result = rtrim(result, "\n");
193 result = trim(result, "\"");
194 setText(from_utf8(result), bp.getFont(), false);
198 // check in packages.lst
199 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"),
200 bp.getFont(), false);
202 case TEXTCLASS_INFO: {
203 // name_ is the class name
204 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"),
205 bp.getFont(), false);
209 docstring_list names;
210 FuncRequest func = lyxaction.lookupFunc(name_);
211 if (func.action == LFUN_UNKNOWN_ACTION) {
212 setText(bformat(_("Unknown action %1$s"), from_utf8(name_)), bp.getFont(), false);
215 // iterate through the menubackend to find it
216 if (!theApp()->searchMenu(func, names)) {
217 setText(bformat(_("No menu entry for action %1$s"), from_utf8(name_)),
218 bp.getFont(), false);
221 // if find, return its path.
223 Paragraph & info = paragraphs().front();
225 while (!names.empty()) {
226 // do not insert > for the top level menu item
228 info.insertInset(0, new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
229 Change(Change::UNCHANGED));
230 for (i = 0; i != names.back().length(); ++i)
231 info.insertChar(i, names.back()[i], bp.getFont(), false);
238 setText(from_utf8(buffer().fileName().onlyFileName()),
239 bp.getFont(), false);
240 else if (name_ == "path")
241 setText(from_utf8(buffer().filePath()), bp.getFont(), false);
242 else if (name_ == "class")
243 setText(from_utf8(bp.documentClass().name()), bp.getFont(), false);
245 setText(_("Unknown buffer info"), bp.getFont(), false);
250 paragraphs().begin()->params().noindent(true);
254 bool InsetInfo::setMouseHover(bool mouse_hover)
256 mouse_hover_ = mouse_hover;