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 "CutAndPaste.h"
18 #include "FuncRequest.h"
19 #include "FuncStatus.h"
20 #include "InsetGraphics.h"
21 #include "InsetSpecialChar.h"
23 #include "LaTeXFeatures.h"
24 #include "LayoutFile.h"
26 #include "LyXAction.h"
30 #include "ParagraphParameters.h"
33 #include "frontends/Application.h"
35 #include "support/convert.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/docstring_list.h"
39 #include "support/ExceptionMessage.h"
40 #include "support/FileName.h"
41 #include "support/filetools.h"
42 #include "support/gettext.h"
43 #include "support/lstrings.h"
44 #include "support/qstring_helpers.h"
45 #include "support/Translator.h"
49 #include <QtGui/QImage>
52 using namespace lyx::support;
58 typedef Translator<InsetInfo::info_type, string> NameTranslator;
60 NameTranslator const initTranslator()
62 NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
64 translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
65 translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
66 translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
67 translator.addPair(InsetInfo::PACKAGE_INFO, "package");
68 translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
69 translator.addPair(InsetInfo::MENU_INFO, "menu");
70 translator.addPair(InsetInfo::ICON_INFO, "icon");
71 translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
72 translator.addPair(InsetInfo::LYX_INFO, "lyxinfo");
77 /// The translator between the information type enum and corresponding string.
78 NameTranslator const & nameTranslator()
80 static NameTranslator const translator = initTranslator();
86 /////////////////////////////////////////////////////////////////////////
90 /////////////////////////////////////////////////////////////////////////
94 InsetInfo::InsetInfo(Buffer * buf, string const & name)
95 : InsetCollapsible(buf), initialized_(false),
96 type_(UNKNOWN_INFO), name_()
103 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
105 // do not allow the cursor to be set in this Inset
106 return Inset::editXY(cur, x, y);
110 string InsetInfo::infoType() const
112 return nameTranslator().find(type_);
116 docstring InsetInfo::layoutName() const
118 return from_ascii("Info:" + infoType());
122 docstring InsetInfo::toolTip(BufferView const &, int, int) const
124 return bformat(_("Information regarding %1$s '%2$s'"),
125 _(infoType()), from_utf8(name_));
129 void InsetInfo::read(Lexer & lex)
134 token = lex.getString();
135 if (token == "type") {
137 token = lex.getString();
138 type_ = nameTranslator().find(token);
139 } else if (token == "arg") {
141 name_ = lex.getString();
142 } else if (token == "\\end_inset")
145 if (token != "\\end_inset") {
146 lex.printError("Missing \\end_inset at this point");
147 throw ExceptionMessage(WarningException,
148 _("Missing \\end_inset at this point."),
154 void InsetInfo::write(ostream & os) const
156 os << "Info\ntype \"" << infoType()
157 << "\"\narg " << Lexer::quoteString(name_);
161 bool InsetInfo::validateModifyArgument(docstring const & arg) const
164 string const name = trim(split(to_utf8(arg), type, ' '));
166 switch (nameTranslator().find(type)) {
173 FuncRequest func = lyxaction.lookupFunc(name);
174 return func.action() != LFUN_UNKNOWN_ACTION;
178 FuncCode const action = lyxaction.lookupFunc(name).action();
179 if (action == LFUN_UNKNOWN_ACTION) {
180 string dir = "images";
181 return !imageLibFileSearch(dir, name, "svgz,png").empty();
188 lyxrc.write(oss, true, name);
189 return !oss.str().empty();
197 if (name == "name" || name == "path" || name == "class")
199 if (name == "vcs-revision" || name == "vcs-tree-revision" ||
200 name == "vcs-author" || name == "vcs-date" || name == "vcs-time")
201 return buffer().lyxvc().inUse();
205 return name == "version";
212 bool InsetInfo::showInsetDialog(BufferView * bv) const
214 bv->showDialog("info");
219 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
220 FuncStatus & flag) const
222 switch (cmd.action()) {
223 case LFUN_INSET_SETTINGS:
224 return InsetCollapsible::getStatus(cur, cmd, flag);
226 case LFUN_INSET_DIALOG_UPDATE:
227 case LFUN_INSET_COPY_AS:
228 flag.setEnabled(true);
231 case LFUN_INSET_MODIFY:
232 if (validateModifyArgument(cmd.argument())) {
233 flag.setEnabled(true);
244 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
246 switch (cmd.action()) {
247 case LFUN_INSET_MODIFY:
249 setInfo(to_utf8(cmd.argument()));
250 cur.forceBufferUpdate();
251 initialized_ = false;
254 case LFUN_INSET_COPY_AS: {
255 cap::clearSelection();
257 copy.pushBackward(*this);
261 copy.pit() = copy.lastpit();
262 copy.pos() = copy.lastpos();
264 cap::copySelection(copy);
269 InsetCollapsible::doDispatch(cur, cmd);
275 void InsetInfo::setInfo(string const & name)
281 name_ = trim(split(name, type, ' '));
282 type_ = nameTranslator().find(type);
286 void InsetInfo::error(string const & err)
288 setText(bformat(_(err), from_utf8(name_)),
289 Font(inherit_font, buffer().params().language), false);
293 void InsetInfo::setText(docstring const & str)
295 setText(str, Font(inherit_font, buffer().params().language), false);
299 void InsetInfo::updateBuffer(ParIterator const & it, UpdateType utype) {
300 // If the Buffer is a clone, then we neither need nor want to do any
301 // of what follows. We want, rather, just to inherit how things were
302 // in the original Buffer. This is especially important for VCS.
303 // Otherwise, we could in principle have different settings here
304 // than in the Buffer we were exporting.
305 if (buffer().isClone())
308 BufferParams const & bp = buffer().params();
312 error("Unknown Info: %1$s");
313 initialized_ = false;
316 case SHORTCUTS_INFO: {
317 // shortcuts can change, so we need to re-do this each time
318 FuncRequest const func = lyxaction.lookupFunc(name_);
319 if (func.action() == LFUN_UNKNOWN_ACTION) {
320 error("Unknown action %1$s");
323 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
324 if (bindings.empty()) {
325 // It is impropriate to use error() for undefined shortcut
326 setText(_("undefined"));
329 if (type_ == SHORTCUT_INFO)
330 setText(bindings.begin()->print(KeySequence::Portable));
332 setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
336 // this information could change, if the preferences are changed,
337 // so we will recalculate each time through.
340 setText(_("undefined"));
343 // FIXME this uses the serialization mechanism to get the info
344 // we want, which i guess works but is a bit strange.
345 lyxrc.write(oss, true, name_);
346 string result = oss.str();
347 if (result.size() < 2) {
348 setText(_("undefined"));
351 string::size_type loc = result.rfind("\n", result.size() - 2);
352 loc = loc == string::npos ? 0 : loc + 1;
353 if (result.size() < loc + name_.size() + 1
354 || result.substr(loc + 1, name_.size()) != name_) {
355 setText(_("undefined"));
358 // remove leading comments and \\name and space
359 result = result.substr(loc + name_.size() + 2);
362 result = rtrim(result, "\n");
363 result = trim(result, "\"");
364 setText(from_utf8(result));
368 // only need to do this once.
371 // check in packages.lst
372 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
376 case TEXTCLASS_INFO: {
377 // the TextClass can change
378 LayoutFileList const & list = LayoutFileList::get();
379 bool available = false;
380 // name_ is the class name
381 if (list.haveClass(name_))
382 available = list[name_].isTeXClassAvailable();
383 setText(available ? _("yes") : _("no"));
387 // only need to do this once.
390 // and we will not keep trying if we fail
392 docstring_list names;
393 FuncRequest const func = lyxaction.lookupFunc(name_);
394 if (func.action() == LFUN_UNKNOWN_ACTION) {
395 error("Unknown action %1$s");
398 // iterate through the menubackend to find it
400 error("Can't determine menu entry for action %1$s in batch mode");
403 if (!theApp()->searchMenu(func, names)) {
404 error("No menu entry for action %1$s");
407 // if found, return its path.
409 Paragraph & par = paragraphs().front();
410 Font const f(inherit_font, buffer().params().language);
412 //fu.fontInfo().setUnderbar(FONT_ON);
413 for (docstring const & name : names) {
414 // do not insert > for the top level menu item
415 if (&name != &names.front())
416 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
417 f, Change(Change::UNCHANGED));
418 //FIXME: add proper underlines here. This
419 // involves rewriting searchMenu used above to
420 // return a vector of menus. If we do not do
421 // that, we might as well use below
422 // Paragraph::insert on each string (JMarc)
423 for (char_type c : name)
424 par.insertChar(par.size(), c, f, Change(Change::UNCHANGED));
429 // only need to do this once.
432 // and we will not keep trying if we fail
434 FuncRequest func = lyxaction.lookupFunc(name_);
435 docstring icon_name = frontend::Application::iconName(func, true);
436 // FIXME: We should use the icon directly instead of
437 // going through FileName. The code below won't work
438 // if the icon is embedded in the executable through
439 // the Qt resource system.
440 // This is only a negligible performance problem:
441 // If the installed icon differs from the resource icon the
442 // installed one is preferred anyway, and all icons that are
443 // embedded in the resources are installed as well.
444 FileName file(to_utf8(icon_name));
445 if (file.onlyFileNameWithoutExt() == "unknown") {
446 string dir = "images";
447 FileName file2(imageLibFileSearch(dir, name_, "svgz,png"));
453 int percent_scale = 100;
455 // Compute the scale factor for the icon such that its
456 // width on screen is equal to 1em in pixels.
457 // The scale factor is rounded to the integer nearest
458 // to the float value of the ratio 100*iconsize/imgsize.
459 int imgsize = QImage(toqstr(file.absFileName())).width();
461 int iconsize = Length(1, Length::EM).inPixels(1);
462 percent_scale = (100 * iconsize + imgsize / 2)/imgsize;
465 InsetGraphics * inset = new InsetGraphics(buffer_);
466 InsetGraphicsParams igp;
468 igp.lyxscale = percent_scale;
469 igp.scale = string();
470 igp.width = Length(1, Length::EM);
471 inset->setParams(igp);
473 Font const f(inherit_font, buffer().params().language);
474 paragraphs().front().insertInset(0, inset, f,
475 Change(Change::UNCHANGED));
479 // this could all change, so we will recalculate each time
480 if (name_ == "name") {
481 setText(from_utf8(buffer().fileName().onlyFileName()));
484 if (name_ == "path") {
485 setText(from_utf8(os::latex_path(buffer().filePath())));
488 if (name_ == "class") {
489 setText(from_utf8(bp.documentClass().name()));
493 ////////////////////////////////////////////////////////////////
494 // everything that follows is for version control.
495 // nothing that isn't version control should go below this line.
497 // this information could change, in principle, so we will
498 // recalculate each time through
499 if (!buffer().lyxvc().inUse()) {
500 setText(_("No version control"));
503 LyXVC::RevisionInfo itype = LyXVC::Unknown;
504 if (name_ == "vcs-revision")
506 else if (name_ == "vcs-tree-revision")
508 else if (name_ == "vcs-author")
509 itype = LyXVC::Author;
510 else if (name_ == "vcs-time")
512 else if (name_ == "vcs-date")
514 string binfo = buffer().lyxvc().revisionInfo(itype);
516 setText(from_ascii(name_) + " unknown");
518 setText(from_utf8(binfo));
522 // only need to do this once.
525 if (name_ == "version")
526 setText(from_ascii(lyx_version));
530 InsetCollapsible::updateBuffer(it, utype);
534 string InsetInfo::contextMenu(BufferView const &, int, int) const
536 //FIXME: We override the implementation of InsetCollapsible,
537 //because this inset is not a collapsible inset.
538 return contextMenuName();
542 string InsetInfo::contextMenuName() const
544 return "context-info";