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 "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 * buf, string const & name)
86 : InsetCollapsable(buf), type_(UNKNOWN_INFO), name_()
88 setAutoBreakRows(true);
94 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
96 // do not allow the cursor to be set in this Inset
97 return Inset::editXY(cur, x, y);
101 string InsetInfo::infoType() const
103 return nameTranslator().find(type_);
107 docstring InsetInfo::name() const
109 return from_ascii("Info:" + infoType());
113 docstring InsetInfo::toolTip(BufferView const &, int, int) const
115 return bformat(_("Information regarding %1$s '%2$s'"),
116 _(infoType()), from_utf8(name_));
120 void InsetInfo::read(Lexer & lex)
125 token = lex.getString();
126 if (token == "type") {
128 token = lex.getString();
129 type_ = nameTranslator().find(token);
130 } else if (token == "arg") {
132 name_ = lex.getString();
133 } else if (token == "\\end_inset")
136 if (token != "\\end_inset") {
137 lex.printError("Missing \\end_inset at this point");
138 throw ExceptionMessage(WarningException,
139 _("Missing \\end_inset at this point."),
146 void InsetInfo::write(ostream & os) const
148 os << "Info\ntype \"" << infoType()
149 << "\"\narg " << Lexer::quoteString(name_);
153 bool InsetInfo::validateModifyArgument(docstring const & arg) const
156 string const name = trim(split(to_utf8(arg), type, ' '));
157 switch (nameTranslator().find(type)) {
164 FuncRequest func = lyxaction.lookupFunc(name);
165 return func.action != LFUN_UNKNOWN_ACTION;
169 lyxrc.write(oss, true, name);
170 return !oss.str().empty();
176 return name == "name" || name == "path" || name == "class" ||
177 name == "vcs-revision" || name == "vcs-tree-revision" ||
178 name == "vcs-author" || name == "vcs-date" || name == "vcs-time";
184 bool InsetInfo::showInsetDialog(BufferView * bv) const
186 bv->showDialog("info");
191 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
192 FuncStatus & flag) const
194 switch (cmd.action) {
195 case LFUN_INSET_SETTINGS:
196 return InsetCollapsable::getStatus(cur, cmd, flag);
198 case LFUN_INSET_DIALOG_UPDATE:
199 flag.setEnabled(true);
202 case LFUN_INSET_MODIFY:
203 if (validateModifyArgument(cmd.argument())) {
204 flag.setEnabled(true);
215 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
217 // allow selection, copy but not cut, delete etc
218 switch (cmd.action) {
219 case LFUN_INSET_SETTINGS:
220 InsetCollapsable::doDispatch(cur, cmd);
223 case LFUN_INSET_MODIFY:
224 setInfo(to_utf8(cmd.argument()));
233 void InsetInfo::setInfo(string const & name)
239 name_ = trim(split(name, type, ' '));
240 type_ = nameTranslator().find(type);
245 void InsetInfo::error(string const & err)
247 setText(bformat(_(err), from_utf8(name_)),
248 Font(inherit_font, buffer().params().language), false);
252 void InsetInfo::setText(docstring const & str)
254 setText(str, Font(inherit_font, buffer().params().language), false);
258 void InsetInfo::updateInfo()
260 BufferParams const & bp = buffer().params();
264 error("Unknown Info: %1$s");
267 case SHORTCUTS_INFO: {
268 FuncRequest func = lyxaction.lookupFunc(name_);
269 if (func.action == LFUN_UNKNOWN_ACTION) {
270 error("Unknown action %1$s");
273 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
274 if (bindings.empty()) {
275 // It is impropriate to use error() for undefined shortcut
276 setText(_("undefined"));
279 if (type_ == SHORTCUT_INFO)
280 setText(bindings.begin()->print(KeySequence::Portable));
282 setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
287 lyxrc.write(oss, true, name_);
288 string result = oss.str();
289 // remove leading \\name
290 result = result.substr(name_.size() + 2);
292 result = rtrim(result, "\n");
293 result = trim(result, "\"");
294 setText(from_utf8(result));
298 // check in packages.lst
299 setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
301 case TEXTCLASS_INFO: {
302 // name_ is the class name
303 setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
307 docstring_list names;
308 FuncRequest func = lyxaction.lookupFunc(name_);
309 if (func.action == LFUN_UNKNOWN_ACTION) {
310 error("Unknown action %1$s");
313 // iterate through the menubackend to find it
314 if (!theApp()->searchMenu(func, names)) {
315 error("No menu entry for action %1$s");
318 // if found, return its path.
320 Paragraph & par = paragraphs().front();
321 Font const f(inherit_font, buffer().params().language);
323 //fu.fontInfo().setUnderbar(FONT_ON);
324 docstring_list::const_iterator beg = names.begin();
325 docstring_list::const_iterator end = names.end();
326 for (docstring_list::const_iterator it = beg ;
328 // do not insert > for the top level menu item
330 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
331 Change(Change::UNCHANGED));
332 //FIXME: add proper underlines here. This
333 // involves rewriting searchMenu used above to
334 // return a vector of menus. If we do not do
335 // that, we might as well use below
336 // Paragraph::insert on each string (JMarc)
337 for (size_type i = 0; i != it->length(); ++i)
338 par.insertChar(par.size(), (*it)[i],
339 f, Change(Change::UNCHANGED));
344 FuncRequest func = lyxaction.lookupFunc(name_);
345 docstring icon_name = theApp()->iconName(func, true);
346 //FIXME: We should use the icon directly instead of
347 // going through FileName. The code below won't work
348 // if the icon is embedded in the executable through
349 // the Qt resource system.
350 FileName file(to_utf8(icon_name));
353 InsetGraphics * inset = new InsetGraphics(buffer_);
354 InsetGraphicsParams igp;
356 inset->setParams(igp);
358 paragraphs().front().insertInset(0, inset,
359 Change(Change::UNCHANGED));
364 setText(from_utf8(buffer().fileName().onlyFileName()));
365 else if (name_ == "path")
366 setText(from_utf8(buffer().filePath()));
367 else if (name_ == "class")
368 setText(from_utf8(bp.documentClass().name()));
369 else if (name_ == "vcs-revision" && buffer().lyxvc().inUse() &&
370 !buffer().lyxvc().revisionInfo(LyXVC::File).empty())
371 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::File)));
372 else if (name_ == "vcs-tree-revision" && buffer().lyxvc().inUse() &&
373 !buffer().lyxvc().revisionInfo(LyXVC::Tree).empty())
374 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Tree)));
375 else if (name_ == "vcs-author" && buffer().lyxvc().inUse() &&
376 !buffer().lyxvc().revisionInfo(LyXVC::Author).empty())
377 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Author)));
378 else if (name_ == "vcs-time" && buffer().lyxvc().inUse() &&
379 !buffer().lyxvc().revisionInfo(LyXVC::Time).empty())
380 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Time)));
381 else if (name_ == "vcs-date" && buffer().lyxvc().inUse() &&
382 !buffer().lyxvc().revisionInfo(LyXVC::Date).empty())
383 setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Date)));
385 setText(_("Unknown buffer info"));
392 docstring InsetInfo::contextMenu(BufferView const &, int, int) const
394 return from_ascii("context-info");