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"
15 #include "BufferParams.h"
16 #include "BufferView.h"
17 #include "FuncRequest.h"
18 #include "FuncStatus.h"
19 #include "InsetGraphics.h"
20 #include "InsetSpecialChar.h"
22 #include "LaTeXFeatures.h"
23 #include "LayoutFile.h"
24 #include "LyXAction.h"
27 #include "MetricsInfo.h"
28 #include "ParagraphParameters.h"
30 #include "frontends/Application.h"
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"
44 using namespace lyx::support;
49 InsetInfo::InsetInfo(Buffer const & buf, string const & name)
50 : InsetText(buf), type_(UNKNOWN_INFO), name_(),
53 setAutoBreakRows(true);
59 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
62 return InsetText::editXY(cur, x, y);
66 void InsetInfo::draw(PainterInfo & pi, int x, int y) const
68 InsetText::draw(pi, x, y);
72 string InsetInfo::infoType() const
74 return nameTranslator().find(type_);
78 docstring InsetInfo::toolTip(BufferView const &, int, int) const
81 os << _("Information regarding ")
82 << _(nameTranslator().find(type_))
83 << " " << from_utf8(name_);
89 Translator<InsetInfo::info_type, string> const initTranslator()
91 Translator<InsetInfo::info_type, string>
92 translator(InsetInfo::UNKNOWN_INFO, "unknown");
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");
108 Translator<InsetInfo::info_type, string>
109 const & InsetInfo::nameTranslator() const
111 static Translator<info_type, string> const translator = initTranslator();
117 void InsetInfo::read(Lexer & lex)
122 token = lex.getString();
123 if (token == "type") {
125 token = lex.getString();
126 type_ = nameTranslator().find(token);
127 } else if (token == "arg") {
129 name_ = lex.getString();
130 } else if (token == "\\end_inset")
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."),
143 void InsetInfo::write(ostream & os) const
145 os << "Info\ntype \"" << nameTranslator().find(type_)
146 << "\"\narg \"" << name_ << '\"';
150 bool InsetInfo::validate(docstring const & arg) const
153 string const name = trim(split(to_utf8(arg), type, ' '));
154 switch (nameTranslator().find(type)) {
161 FuncRequest func = lyxaction.lookupFunc(name);
162 return func.action != LFUN_UNKNOWN_ACTION;
166 lyxrc.write(oss, true, name);
167 return !oss.str().empty();
173 return name == "name" || name == "path" || name == "class";
179 bool InsetInfo::showInsetDialog(BufferView * bv) const
181 bv->showDialog("info");
186 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
187 FuncStatus & flag) const
189 switch (cmd.action) {
190 case LFUN_MOUSE_PRESS:
191 case LFUN_MOUSE_RELEASE:
192 case LFUN_MOUSE_MOTION:
193 case LFUN_MOUSE_DOUBLE:
194 case LFUN_MOUSE_TRIPLE:
196 case LFUN_INSET_SETTINGS:
197 return InsetText::getStatus(cur, cmd, flag);
199 case LFUN_INSET_MODIFY:
200 flag.setEnabled(true);
210 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
212 // allow selection, copy but not cut, delete etc
213 switch (cmd.action) {
214 case LFUN_MOUSE_PRESS:
215 case LFUN_MOUSE_RELEASE:
216 case LFUN_MOUSE_MOTION:
217 case LFUN_MOUSE_DOUBLE:
218 case LFUN_MOUSE_TRIPLE:
220 case LFUN_INSET_SETTINGS:
221 InsetText::doDispatch(cur, cmd);
224 case LFUN_INSET_MODIFY:
225 setInfo(to_utf8(cmd.argument()));
235 void InsetInfo::setInfo(string const & name)
241 name_ = trim(split(name, type, ' '));
242 type_ = nameTranslator().find(type);
247 void InsetInfo::error(string const & err)
249 InsetText::setText(bformat(_(err), from_utf8(name_)), buffer().params().getFont(),
254 void InsetInfo::setText(docstring const & str)
256 InsetText::setText(str, buffer().params().getFont(), false);
260 void InsetInfo::updateInfo()
264 BufferParams const & bp = buffer().params();
268 error("Unknown Info: %1$s");
271 case SHORTCUTS_INFO: {
272 FuncRequest func = lyxaction.lookupFunc(name_);
273 if (func.action == LFUN_UNKNOWN_ACTION) {
274 error("Unknown action %1$s");
277 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
278 if (bindings.empty()) {
279 // It is impropriate to use error() for undefined shortcut
280 setText(_("undefined"));
283 if (type_ == SHORTCUT_INFO)
284 setText(bindings.rbegin()->print(KeySequence::Portable));
286 setText(theTopLevelKeymap().printBindings(func));
291 lyxrc.write(oss, true, name_);
292 string result = oss.str();
293 // remove leading \\name
294 result = result.substr(name_.size() + 2);
296 result = rtrim(result, "\n");
297 result = trim(result, "\"");
298 setText(from_utf8(result));
302 // check in packages.lst
303 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
305 case TEXTCLASS_INFO: {
306 // name_ is the class name
307 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
311 docstring_list names;
312 FuncRequest func = lyxaction.lookupFunc(name_);
313 if (func.action == LFUN_UNKNOWN_ACTION) {
314 error("Unknown action %1$s");
317 // iterate through the menubackend to find it
318 if (!theApp()->searchMenu(func, names)) {
319 error("No menu entry for action %1$s");
322 // if find, return its path.
324 Paragraph & info = paragraphs().front();
326 while (!names.empty()) {
327 // do not insert > for the top level menu item
329 info.insertInset(0, new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
330 Change(Change::UNCHANGED));
331 for (i = 0; i != names.back().length(); ++i)
332 info.insertChar(i, names.back()[i], bp.getFont(), false);
338 FuncRequest func = lyxaction.lookupFunc(name_);
339 docstring icon_name = theApp()->iconName(func, true);
340 //FIXME: We should use the icon directly instead of going through
341 // FileName. The code below won't work if the icon is embedded in the
342 // executable through the Qt resource system.
343 FileName file(to_utf8(icon_name));
346 InsetGraphicsParams igp;
348 InsetGraphics * inset = new InsetGraphics(buffer());
349 inset->setParams(igp);
350 paragraphs().front().insertInset(0, inset, Change(Change::UNCHANGED));
355 setText(from_utf8(buffer().fileName().onlyFileName()));
356 else if (name_ == "path")
357 setText(from_utf8(buffer().filePath()));
358 else if (name_ == "class")
359 setText(from_utf8(bp.documentClass().name()));
361 setText(_("Unknown buffer info"));
366 paragraphs().begin()->params().noindent(true);
370 bool InsetInfo::setMouseHover(bool mouse_hover)
372 mouse_hover_ = mouse_hover;
377 docstring InsetInfo::contextMenu(BufferView const &, int, int) const
379 return from_ascii("context-info");