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 & /* argument */) const
157 bool InsetInfo::showInsetDialog(BufferView * bv) const
159 bv->showDialog("info");
164 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
165 FuncStatus & flag) const
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:
174 case LFUN_INSET_SETTINGS:
175 return InsetText::getStatus(cur, cmd, flag);
177 case LFUN_INSET_MODIFY:
178 flag.setEnabled(true);
188 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
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:
198 case LFUN_INSET_SETTINGS:
199 InsetText::doDispatch(cur, cmd);
202 case LFUN_INSET_MODIFY:
203 setInfo(to_utf8(cmd.argument()));
213 void InsetInfo::setInfo(string const & name)
219 name_ = trim(split(name, type, ' '));
220 type_ = nameTranslator().find(type);
225 void InsetInfo::error(string const & err)
227 InsetText::setText(bformat(_(err), from_utf8(name_)), buffer().params().getFont(),
232 void InsetInfo::setText(docstring const & str)
234 InsetText::setText(str, buffer().params().getFont(), false);
238 void InsetInfo::updateInfo()
242 BufferParams const & bp = buffer().params();
246 error("Unknown Info: %1$s");
249 case SHORTCUTS_INFO: {
250 FuncRequest func = lyxaction.lookupFunc(name_);
251 if (func.action == LFUN_UNKNOWN_ACTION) {
252 error("Unknown action %1$s");
255 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
256 if (bindings.empty()) {
257 error("No binding for action %1$s");
260 if (type_ == SHORTCUT_INFO)
261 setText(bindings.rbegin()->print(KeySequence::ForGui));
263 setText(theTopLevelKeymap().printBindings(func));
268 lyxrc.write(oss, true, name_);
269 string result = oss.str();
270 // remove leading \\name
271 result = result.substr(name_.size() + 2);
273 result = rtrim(result, "\n");
274 result = trim(result, "\"");
275 setText(from_utf8(result));
279 // check in packages.lst
280 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
282 case TEXTCLASS_INFO: {
283 // name_ is the class name
284 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
288 docstring_list names;
289 FuncRequest func = lyxaction.lookupFunc(name_);
290 if (func.action == LFUN_UNKNOWN_ACTION) {
291 error("Unknown action %1$s");
294 // iterate through the menubackend to find it
295 if (!theApp()->searchMenu(func, names)) {
296 error("No menu entry for action %1$s");
299 // if find, return its path.
301 Paragraph & info = paragraphs().front();
303 while (!names.empty()) {
304 // do not insert > for the top level menu item
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);
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));
323 InsetGraphicsParams igp;
325 InsetGraphics * inset = new InsetGraphics(buffer());
326 inset->setParams(igp);
327 paragraphs().front().insertInset(0, inset, Change(Change::UNCHANGED));
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()));
338 setText(_("Unknown buffer info"));
343 paragraphs().begin()->params().noindent(true);
347 bool InsetInfo::setMouseHover(bool mouse_hover)
349 mouse_hover_ = mouse_hover;
354 docstring InsetInfo::contextMenu(BufferView const &, int, int) const
356 return from_ascii("context-info");