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"
28 #include "MetricsInfo.h"
29 #include "ParagraphParameters.h"
31 #include "frontends/Application.h"
33 #include "support/debug.h"
34 #include "support/docstream.h"
35 #include "support/docstring_list.h"
36 #include "support/ExceptionMessage.h"
37 #include "support/FileName.h"
38 #include "support/filetools.h"
39 #include "support/gettext.h"
40 #include "support/lstrings.h"
45 using namespace lyx::support;
51 typedef Translator<InsetInfo::info_type, string> NameTranslator;
53 NameTranslator const initTranslator()
55 NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
57 translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
58 translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
59 translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
60 translator.addPair(InsetInfo::PACKAGE_INFO, "package");
61 translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
62 translator.addPair(InsetInfo::MENU_INFO, "menu");
63 translator.addPair(InsetInfo::ICON_INFO, "icon");
64 translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
69 /// The translator between the information type enum and corresponding string.
70 NameTranslator const & nameTranslator()
72 static NameTranslator const translator = initTranslator();
78 /////////////////////////////////////////////////////////////////////////
82 /////////////////////////////////////////////////////////////////////////
86 InsetInfo::InsetInfo(Buffer * buf, string const & name)
87 : InsetCollapsable(buf), type_(UNKNOWN_INFO), name_()
89 setAutoBreakRows(true);
95 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
97 // do not allow the cursor to be set in this Inset
98 return Inset::editXY(cur, x, y);
102 string InsetInfo::infoType() const
104 return nameTranslator().find(type_);
108 docstring InsetInfo::name() const
110 return from_ascii("Info:" + infoType());
114 docstring InsetInfo::toolTip(BufferView const &, int, int) const
116 return bformat(_("Information regarding %1$s '%2$s'"),
117 _(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."),
147 void InsetInfo::write(ostream & os) const
149 os << "Info\ntype \"" << infoType()
150 << "\"\narg " << Lexer::quoteString(name_);
154 bool InsetInfo::validateModifyArgument(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" ||
178 name == "vcs-revision" || name == "vcs-tree-revision" ||
179 name == "vcs-author" || name == "vcs-date" || name == "vcs-time";
185 bool InsetInfo::showInsetDialog(BufferView * bv) const
187 bv->showDialog("info");
192 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
193 FuncStatus & flag) const
195 switch (cmd.action) {
196 case LFUN_INSET_SETTINGS:
197 return InsetCollapsable::getStatus(cur, cmd, flag);
199 case LFUN_INSET_DIALOG_UPDATE:
200 flag.setEnabled(true);
203 case LFUN_INSET_MODIFY:
204 if (validateModifyArgument(cmd.argument())) {
205 flag.setEnabled(true);
216 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
218 // allow selection, copy but not cut, delete etc
219 switch (cmd.action) {
220 case LFUN_INSET_SETTINGS:
221 InsetCollapsable::doDispatch(cur, cmd);
224 case LFUN_INSET_MODIFY:
225 setInfo(to_utf8(cmd.argument()));
234 void InsetInfo::setInfo(string const & name)
240 name_ = trim(split(name, type, ' '));
241 type_ = nameTranslator().find(type);
246 void InsetInfo::error(string const & err)
248 setText(bformat(_(err), from_utf8(name_)),
249 Font(inherit_font, buffer().params().language), false);
253 void InsetInfo::setText(docstring const & str)
255 setText(str, Font(inherit_font, buffer().params().language), false);
259 void InsetInfo::updateInfo()
261 BufferParams const & bp = buffer().params();
265 error("Unknown Info: %1$s");
268 case SHORTCUTS_INFO: {
269 FuncRequest func = lyxaction.lookupFunc(name_);
270 if (func.action == LFUN_UNKNOWN_ACTION) {
271 error("Unknown action %1$s");
274 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
275 if (bindings.empty()) {
276 // It is impropriate to use error() for undefined shortcut
277 setText(_("undefined"));
280 if (type_ == SHORTCUT_INFO)
281 setText(bindings.begin()->print(KeySequence::Portable));
283 setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
288 lyxrc.write(oss, true, name_);
289 string result = oss.str();
290 // remove leading \\name
291 result = result.substr(name_.size() + 2);
293 result = rtrim(result, "\n");
294 result = trim(result, "\"");
295 setText(from_utf8(result));
299 // check in packages.lst
300 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
302 case TEXTCLASS_INFO: {
303 // name_ is the class name
304 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
308 docstring_list names;
309 FuncRequest func = lyxaction.lookupFunc(name_);
310 if (func.action == LFUN_UNKNOWN_ACTION) {
311 error("Unknown action %1$s");
314 // iterate through the menubackend to find it
315 if (!theApp()->searchMenu(func, names)) {
316 error("No menu entry for action %1$s");
319 // if found, return its path.
321 Paragraph & par = paragraphs().front();
322 Font const f(inherit_font, buffer().params().language);
324 //fu.fontInfo().setUnderbar(FONT_ON);
325 docstring_list::const_iterator beg = names.begin();
326 docstring_list::const_iterator end = names.end();
327 for (docstring_list::const_iterator it = beg ;
329 // do not insert > for the top level menu item
331 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
332 Change(Change::UNCHANGED));
333 //FIXME: add proper underlines here. This
334 // involves rewriting searchMenu used above to
335 // return a vector of menus. If we do not do
336 // that, we might as well use below
337 // Paragraph::insert on each string (JMarc)
338 for (size_type i = 0; i != it->length(); ++i)
339 par.insertChar(par.size(), (*it)[i],
340 f, Change(Change::UNCHANGED));
345 FuncRequest func = lyxaction.lookupFunc(name_);
346 docstring icon_name = theApp()->iconName(func, true);
347 //FIXME: We should use the icon directly instead of
348 // going through FileName. The code below won't work
349 // if the icon is embedded in the executable through
350 // the Qt resource system.
351 FileName file(to_utf8(icon_name));
354 InsetGraphics * inset = new InsetGraphics(buffer_);
355 InsetGraphicsParams igp;
357 inset->setParams(igp);
359 paragraphs().front().insertInset(0, inset,
360 Change(Change::UNCHANGED));
365 setText(from_utf8(buffer().fileName().onlyFileName()));
366 else if (name_ == "path")
367 setText(from_utf8(buffer().filePath()));
368 else if (name_ == "class")
369 setText(from_utf8(bp.documentClass().name()));
370 else if (name_ == "vcs-revision" && buffer().lyxvc().inUse() &&
371 !buffer().lyxvc().revisionInfo(LyXVC::File).empty())
372 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::File)));
373 else if (name_ == "vcs-tree-revision" && buffer().lyxvc().inUse() &&
374 !buffer().lyxvc().revisionInfo(LyXVC::Tree).empty())
375 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Tree)));
376 else if (name_ == "vcs-author" && buffer().lyxvc().inUse() &&
377 !buffer().lyxvc().revisionInfo(LyXVC::Author).empty())
378 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Author)));
379 else if (name_ == "vcs-time" && buffer().lyxvc().inUse() &&
380 !buffer().lyxvc().revisionInfo(LyXVC::Time).empty())
381 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Time)));
382 else if (name_ == "vcs-date" && buffer().lyxvc().inUse() &&
383 !buffer().lyxvc().revisionInfo(LyXVC::Date).empty())
384 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Date)));
386 setText(_("Unknown buffer info"));
393 docstring InsetInfo::contextMenu(BufferView const &, int, int) const
395 return from_ascii("context-info");