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;
50 typedef Translator<InsetInfo::info_type, string> NameTranslator;
52 NameTranslator const initTranslator()
54 NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
56 translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
57 translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
58 translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
59 translator.addPair(InsetInfo::PACKAGE_INFO, "package");
60 translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
61 translator.addPair(InsetInfo::MENU_INFO, "menu");
62 translator.addPair(InsetInfo::ICON_INFO, "icon");
63 translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
68 /// The translator between the information type enum and corresponding string.
69 NameTranslator const & nameTranslator()
71 static NameTranslator const translator = initTranslator();
77 /////////////////////////////////////////////////////////////////////////
81 /////////////////////////////////////////////////////////////////////////
85 InsetInfo::InsetInfo(Buffer const & buf, string const & name)
86 : InsetCollapsable(buf, Collapsed), type_(UNKNOWN_INFO), name_()
88 setAutoBreakRows(true);
93 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
96 return InsetCollapsable::editXY(cur, x, y);
100 string InsetInfo::infoType() const
102 return nameTranslator().find(type_);
106 docstring InsetInfo::name() const
108 return from_ascii("Info:" + infoType());
112 docstring InsetInfo::toolTip(BufferView const &, int, int) const
115 os << _("Information regarding ")
116 << _(infoType()) << " " << from_utf8(name_);
121 void InsetInfo::read(Lexer & lex)
126 token = lex.getString();
127 if (token == "type") {
129 token = lex.getString();
130 type_ = nameTranslator().find(token);
131 } else if (token == "arg") {
133 name_ = lex.getString();
134 } else if (token == "\\end_inset")
137 if (token != "\\end_inset") {
138 lex.printError("Missing \\end_inset at this point");
139 throw ExceptionMessage(WarningException,
140 _("Missing \\end_inset at this point."),
143 setLayout(buffer().params());
148 void InsetInfo::write(ostream & os) const
150 os << "Info\ntype \"" << infoType() << "\"\narg \"" << name_ << '\"';
154 bool InsetInfo::validate(docstring const & arg) const
157 string const name = trim(split(to_utf8(arg), type, ' '));
158 switch (nameTranslator().find(type)) {
165 FuncRequest func = lyxaction.lookupFunc(name);
166 return func.action != LFUN_UNKNOWN_ACTION;
170 lyxrc.write(oss, true, name);
171 return !oss.str().empty();
177 return name == "name" || name == "path" || name == "class";
183 bool InsetInfo::showInsetDialog(BufferView * bv) const
185 bv->showDialog("info");
190 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
191 FuncStatus & flag) const
193 switch (cmd.action) {
194 case LFUN_MOUSE_PRESS:
195 case LFUN_MOUSE_RELEASE:
196 case LFUN_MOUSE_MOTION:
197 case LFUN_MOUSE_DOUBLE:
198 case LFUN_MOUSE_TRIPLE:
200 case LFUN_INSET_SETTINGS:
201 return InsetCollapsable::getStatus(cur, cmd, flag);
203 case LFUN_INSET_MODIFY:
204 flag.setEnabled(true);
214 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
216 // allow selection, copy but not cut, delete etc
217 switch (cmd.action) {
218 case LFUN_MOUSE_PRESS:
219 case LFUN_MOUSE_RELEASE:
220 case LFUN_MOUSE_MOTION:
221 case LFUN_MOUSE_DOUBLE:
222 case LFUN_MOUSE_TRIPLE:
224 case LFUN_INSET_SETTINGS:
225 InsetCollapsable::doDispatch(cur, cmd);
228 case LFUN_INSET_MODIFY:
229 setInfo(to_utf8(cmd.argument()));
239 void InsetInfo::setInfo(string const & name)
245 name_ = trim(split(name, type, ' '));
246 type_ = nameTranslator().find(type);
247 setLayout(buffer().params());
252 void InsetInfo::error(string const & err)
254 setText(bformat(_(err), from_utf8(name_)), Font(inherit_font), false);
258 void InsetInfo::setText(docstring const & str)
260 setText(str, Font(inherit_font), false);
264 void InsetInfo::updateInfo()
266 BufferParams const & bp = buffer().params();
270 error("Unknown Info: %1$s");
273 case SHORTCUTS_INFO: {
274 FuncRequest func = lyxaction.lookupFunc(name_);
275 if (func.action == LFUN_UNKNOWN_ACTION) {
276 error("Unknown action %1$s");
279 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
280 if (bindings.empty()) {
281 // It is impropriate to use error() for undefined shortcut
282 setText(_("undefined"));
285 if (type_ == SHORTCUT_INFO)
286 setText(bindings.rbegin()->print(KeySequence::Portable),
287 Font(getLayout().font()), false);
289 setText(theTopLevelKeymap().printBindings(func),
290 Font(getLayout().font()), false);
295 lyxrc.write(oss, true, name_);
296 string result = oss.str();
297 // remove leading \\name
298 result = result.substr(name_.size() + 2);
300 result = rtrim(result, "\n");
301 result = trim(result, "\"");
302 setText(from_utf8(result));
306 // check in packages.lst
307 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
309 case TEXTCLASS_INFO: {
310 // name_ is the class name
311 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
315 docstring_list names;
316 FuncRequest func = lyxaction.lookupFunc(name_);
317 if (func.action == LFUN_UNKNOWN_ACTION) {
318 error("Unknown action %1$s");
321 // iterate through the menubackend to find it
322 if (!theApp()->searchMenu(func, names)) {
323 error("No menu entry for action %1$s");
326 // if found, return its path.
328 Paragraph & par = paragraphs().front();
329 Font const f = Font(getLayout().font());
331 //fu.fontInfo().setUnderbar(FONT_ON);
332 docstring_list::const_iterator beg = names.begin();
333 docstring_list::const_iterator end = names.end();
334 for (docstring_list::const_iterator it = beg ;
336 // do not insert > for the top level menu item
338 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
339 Change(Change::UNCHANGED));
340 //FIXME: add proper underlines here. This
341 // involves rewriting searchMenu used above to
342 // return a vector of menus. If we do not do
343 // that, we might as well use below
344 // Paragraph::insert on each string (JMarc)
345 for (size_type i = 0; i != it->length(); ++i)
346 par.insertChar(par.size(), (*it)[i],
347 f, Change(Change::UNCHANGED));
352 FuncRequest func = lyxaction.lookupFunc(name_);
353 docstring icon_name = theApp()->iconName(func, true);
354 //FIXME: We should use the icon directly instead of
355 // going through FileName. The code below won't work
356 // if the icon is embedded in the executable through
357 // the Qt resource system.
358 FileName file(to_utf8(icon_name));
361 InsetGraphics * inset = new InsetGraphics(buffer());
362 InsetGraphicsParams igp;
364 inset->setParams(igp);
366 paragraphs().front().insertInset(0, inset,
367 Change(Change::UNCHANGED));
372 setText(from_utf8(buffer().fileName().onlyFileName()));
373 else if (name_ == "path")
374 setText(from_utf8(buffer().filePath()));
375 else if (name_ == "class")
376 setText(from_utf8(bp.documentClass().name()));
378 setText(_("Unknown buffer info"));
385 docstring InsetInfo::contextMenu(BufferView const &, int, int) const
387 return from_ascii("context-info");