]> git.lyx.org Git - lyx.git/blob - src/insets/InsetInfo.cpp
Use auto const & when possible to avoid copies
[lyx.git] / src / insets / InsetInfo.cpp
1 /**
2  * \file InsetInfo.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Bo Peng
7  * \author Jürgen Spitzmüller
8  *
9  * Full author contact details are available in file CREDITS.
10  */
11 #include <config.h>
12
13 #include "InsetInfo.h"
14 #include "LyX.h"
15 #include "Buffer.h"
16 #include "BufferParams.h"
17 #include "BufferView.h"
18 #include "Changes.h"
19 #include "Cursor.h"
20 #include "CutAndPaste.h"
21 #include "Font.h"
22 #include "FuncRequest.h"
23 #include "FuncStatus.h"
24 #include "InsetGraphics.h"
25 #include "InsetSpecialChar.h"
26 #include "KeyMap.h"
27 #include "LaTeXFeatures.h"
28 #include "Language.h"
29 #include "LayoutFile.h"
30 #include "LyXAction.h"
31 #include "LyXRC.h"
32 #include "LyXVC.h"
33 #include "Lexer.h"
34 #include "Paragraph.h"
35 #include "ParIterator.h"
36 #include "ParagraphParameters.h"
37 #include "version.h"
38
39 #include "frontends/Application.h"
40
41 #include "support/Changer.h"
42 #include "support/convert.h"
43 #include "support/debug.h"
44 #include "support/docstream.h"
45 #include "support/docstring_list.h"
46 #include "support/ExceptionMessage.h"
47 #include "support/FileName.h"
48 #include "support/filetools.h"
49 #include "support/gettext.h"
50 #include "support/Length.h"
51 #include "support/Messages.h"
52 #include "support/lstrings.h"
53 #include "support/qstring_helpers.h"
54 #include "support/Translator.h"
55
56 #include <sstream>
57
58 #include <QtGui/QImage>
59 #include <QDate>
60 #include <QLocale>
61
62 using namespace std;
63 using namespace lyx::support;
64
65 namespace lyx {
66
67 namespace {
68
69 typedef Translator<InsetInfoParams::info_type, string> NameTranslator;
70
71 NameTranslator const initTranslator()
72 {
73         NameTranslator translator(InsetInfoParams::UNKNOWN_INFO, "unknown");
74
75         translator.addPair(InsetInfoParams::SHORTCUTS_INFO, "shortcuts");
76         translator.addPair(InsetInfoParams::SHORTCUT_INFO, "shortcut");
77         translator.addPair(InsetInfoParams::LYXRC_INFO, "lyxrc");
78         translator.addPair(InsetInfoParams::PACKAGE_INFO, "package");
79         translator.addPair(InsetInfoParams::TEXTCLASS_INFO, "textclass");
80         translator.addPair(InsetInfoParams::MENU_INFO, "menu");
81         translator.addPair(InsetInfoParams::L7N_INFO, "l7n");
82         translator.addPair(InsetInfoParams::ICON_INFO, "icon");
83         translator.addPair(InsetInfoParams::BUFFER_INFO, "buffer");
84         translator.addPair(InsetInfoParams::LYX_INFO, "lyxinfo");
85         translator.addPair(InsetInfoParams::VCS_INFO, "vcs");
86         translator.addPair(InsetInfoParams::DATE_INFO, "date");
87         translator.addPair(InsetInfoParams::MODDATE_INFO, "moddate");
88         translator.addPair(InsetInfoParams::FIXDATE_INFO, "fixdate");
89         translator.addPair(InsetInfoParams::TIME_INFO, "time");
90         translator.addPair(InsetInfoParams::MODTIME_INFO, "modtime");
91         translator.addPair(InsetInfoParams::FIXTIME_INFO, "fixtime");
92
93         return translator;
94 }
95
96 /// The translator between the information type enum and corresponding string.
97 NameTranslator const & nameTranslator()
98 {
99         static NameTranslator const translator = initTranslator();
100         return translator;
101 }
102
103
104 typedef Translator<InsetInfoParams::info_type, string> DefaultValueTranslator;
105
106 DefaultValueTranslator const initDVTranslator()
107 {
108         DefaultValueTranslator translator(InsetInfoParams::UNKNOWN_INFO, "");
109
110         translator.addPair(InsetInfoParams::SHORTCUTS_INFO, "info-insert");
111         translator.addPair(InsetInfoParams::SHORTCUT_INFO, "info-insert");
112         translator.addPair(InsetInfoParams::LYXRC_INFO, "user_name");
113         translator.addPair(InsetInfoParams::PACKAGE_INFO, "graphics");
114         translator.addPair(InsetInfoParams::TEXTCLASS_INFO, "article");
115         translator.addPair(InsetInfoParams::MENU_INFO, "info-insert");
116         translator.addPair(InsetInfoParams::L7N_INFO, "");
117         translator.addPair(InsetInfoParams::ICON_INFO, "info-insert");
118         translator.addPair(InsetInfoParams::BUFFER_INFO, "name-noext");
119         translator.addPair(InsetInfoParams::LYX_INFO, "version");
120         translator.addPair(InsetInfoParams::VCS_INFO, "revision");
121         translator.addPair(InsetInfoParams::DATE_INFO, "loclong");
122         translator.addPair(InsetInfoParams::MODDATE_INFO, "loclong");
123         translator.addPair(InsetInfoParams::FIXDATE_INFO, "loclong");
124         translator.addPair(InsetInfoParams::TIME_INFO, "long");
125         translator.addPair(InsetInfoParams::MODTIME_INFO, "long");
126         translator.addPair(InsetInfoParams::FIXTIME_INFO, "long");
127
128         return translator;
129 }
130
131 /// The translator between the information type enum and some sensible default value.
132 DefaultValueTranslator const & defaultValueTranslator()
133 {
134         static DefaultValueTranslator const translator = initDVTranslator();
135         return translator;
136 }
137
138 } // namespace
139
140
141 /////////////////////////////////////////////////////////////////////
142 //
143 // InsetInfoParams
144 //
145 ///////////////////////////////////////////////////////////////////////
146
147 InsetInfoParams infoparams;
148
149 namespace{
150 set<string> getTexFileList(string const & filename)
151 {
152         set<string> list;
153         FileName const file = libFileSearch(string(), filename);
154         if (file.empty())
155                 return list;
156
157         // FIXME Unicode.
158         vector<docstring> doclist =
159                 getVectorFromString(file.fileContents("UTF-8"), from_ascii("\n"));
160
161         // Normalise paths like /foo//bar ==> /foo/bar
162         // No "auto const &" because doc is modified later
163         // coverity[auto_causes_copy]
164         for (auto doc : doclist) {
165                 doc = subst(doc, from_ascii("\r"), docstring());
166                 while (contains(doc, from_ascii("//")))
167                         doc = subst(doc, from_ascii("//"), from_ascii("/"));
168                 if (!doc.empty())
169                         list.insert(removeExtension(onlyFileName(to_utf8(doc))));
170         }
171
172         // remove duplicates
173         return list;
174 }
175
176 bool translateString(docstring const & in, docstring & out, string const & lcode)
177 {
178         out = translateIfPossible(in, lcode);
179         return in != out;
180 }
181 } // namespace anon
182
183
184 docstring InsetInfoParams::getDate(string const & iname, QDate const date) const
185 {
186         QLocale loc;
187         if (lang)
188                 loc = QLocale(toqstr(lang->code()));
189         if (iname == "long")
190                 return qstring_to_ucs4(loc.toString(date, QLocale::LongFormat));
191         else if (iname == "short")
192                 return qstring_to_ucs4(loc.toString(date, QLocale::ShortFormat));
193         else if (iname == "ISO")
194                 return qstring_to_ucs4(date.toString(Qt::ISODate));
195         else if (iname == "loclong")
196                 return lang ? qstring_to_ucs4(loc.toString(date, toqstr(lang->dateFormat(0))))
197                             : _("No long date format (language unknown)!");
198         else if (iname == "locmedium")
199                 return lang ? qstring_to_ucs4(loc.toString(date, toqstr(lang->dateFormat(1))))
200                             : _("No medium date format (language unknown)!");
201         else if (iname == "locshort")
202                 return lang ? qstring_to_ucs4(loc.toString(date, toqstr(lang->dateFormat(2))))
203                                 : _("No short date format (language unknown)!");
204         else
205                 return qstring_to_ucs4(loc.toString(date, toqstr(iname)));
206 }
207
208
209 docstring InsetInfoParams::getTime(string const & iname, QTime const time) const
210 {
211         QLocale loc;
212         if (lang)
213                 loc = QLocale(toqstr(lang->code()));
214         if (iname == "long")
215                 return qstring_to_ucs4(loc.toString(time, QLocale::LongFormat));
216         else if (iname == "short")
217                 return qstring_to_ucs4(loc.toString(time, QLocale::ShortFormat));
218         else if (iname == "ISO")
219                 return qstring_to_ucs4(time.toString(Qt::ISODate));
220         else
221                 return qstring_to_ucs4(loc.toString(time, toqstr(iname)));
222 }
223
224
225 vector<pair<string,docstring>> InsetInfoParams::getArguments(Buffer const * buf,
226                                                              string const & itype) const
227 {
228         vector<pair<string,docstring>> result;
229
230         switch (nameTranslator().find(itype)) {
231         case UNKNOWN_INFO:
232                 result.push_back(make_pair("invalid", _("Please select a valid type!")));
233                 break;
234
235         case SHORTCUT_INFO:
236         case SHORTCUTS_INFO:
237         case MENU_INFO:
238         case ICON_INFO: {
239                 result.push_back(make_pair("custom", _("Custom")));
240                 for (auto const & name_code : lyxaction) {
241                         string const lfun = name_code.first;
242                         if (!lfun.empty())
243                                 result.push_back(make_pair(lfun, from_ascii(lfun)));
244                 }
245                 break;
246         }
247
248         case L7N_INFO:
249                 result.push_back(make_pair("custom", _("Custom")));
250                 break;
251
252         case LYXRC_INFO: {
253                 result.push_back(make_pair("custom", _("Custom")));
254                 set<string> rcs = lyxrc.getRCs();
255                 for (auto const & rc : rcs)
256                         result.push_back(make_pair(rc, from_ascii(rc)));
257                 break;
258         }
259
260         case PACKAGE_INFO:
261         case TEXTCLASS_INFO: {
262                 result.push_back(make_pair("custom", _("Custom")));
263                 string const filename = (itype == "package") ? "styFiles.lst"
264                                                             : "clsFiles.lst";
265                 set<string> flist = getTexFileList(filename);
266                 for (auto const & f : flist)
267                         result.push_back(make_pair(f, from_utf8(f)));
268                 break;
269         }
270
271         case BUFFER_INFO:
272                 result.push_back(make_pair("name", _("File name (with extension)")));
273                 result.push_back(make_pair("name-noext", _("File name (without extension)")));
274                 result.push_back(make_pair("path", _("File path")));
275                 result.push_back(make_pair("class", _("Used text class")));
276                 break;
277
278         case VCS_INFO: {
279                 if (!buf->lyxvc().inUse()) {
280                         result.push_back(make_pair("invalid", _("No version control!")));
281                         break;
282                 }
283                 result.push_back(make_pair("revision", _("Revision[[Version Control]]")));
284                 result.push_back(make_pair("revision-abbrev", _("Abbreviated revision[[Version Control]]")));
285                 result.push_back(make_pair("tree-revision", _("Tree revision")));
286                 result.push_back(make_pair("author", _("Author")));
287                 result.push_back(make_pair("date", _("Date")));
288                 result.push_back(make_pair("time", _("Time[[of day]]")));
289                 break;
290         }
291
292         case LYX_INFO:
293                 result.push_back(make_pair("version", _("LyX version")));
294                 result.push_back(make_pair("layoutformat", _("LyX layout format")));
295                 break;
296
297         case FIXDATE_INFO:
298         case DATE_INFO:
299         case MODDATE_INFO: {
300                 string const dt = split(name, '@');
301                 QDate date;
302                 if (itype == "moddate")
303 #if (QT_VERSION >= QT_VERSION_CHECK(5, 8, 0))
304                         date = QDateTime::fromSecsSinceEpoch(buf->fileName().lastModified()).date();
305 #else
306                         date = QDateTime::fromTime_t(buf->fileName().lastModified()).date();
307 #endif
308                 else if (itype == "fixdate" && !dt.empty()) {
309                         QDate const gdate = QDate::fromString(toqstr(dt), Qt::ISODate);
310                         date = (gdate.isValid()) ? gdate : QDate::currentDate();
311                 } else
312                         date = QDate::currentDate();
313                 result.push_back(make_pair("long",getDate("long", date)));
314                 result.push_back(make_pair("short", getDate("short", date)));
315                 result.push_back(make_pair("loclong", getDate("loclong", date)));
316                 result.push_back(make_pair("locmedium", getDate("locmedium", date)));
317                 result.push_back(make_pair("locshort", getDate("locshort", date)));
318                 result.push_back(make_pair("ISO", getDate("ISO", date)));
319                 result.push_back(make_pair("yyyy", getDate("yyyy", date)));
320                 result.push_back(make_pair("MMMM", getDate("MMMM", date)));
321                 result.push_back(make_pair("MMM", getDate("MMM", date)));
322                 result.push_back(make_pair("dddd", getDate("dddd", date)));
323                 result.push_back(make_pair("ddd", getDate("ddd", date)));
324                 result.push_back(make_pair("custom", _("Custom")));
325                 break;
326         }
327         case FIXTIME_INFO:
328         case TIME_INFO:
329         case MODTIME_INFO: {
330                 string const tt = split(name, '@');
331                 QTime time;
332                 if (itype == "modtime")
333 #if (QT_VERSION >= QT_VERSION_CHECK(5, 8, 0))
334                         time = QDateTime::fromSecsSinceEpoch(buf->fileName().lastModified()).time();
335 #else
336                         time = QDateTime::fromTime_t(buf->fileName().lastModified()).time();
337 #endif
338                 else if (itype == "fixtime" && !tt.empty()) {
339                         QTime const gtime = QTime::fromString(toqstr(tt), Qt::ISODate);
340                         time = (gtime.isValid()) ? gtime : QTime::currentTime();
341                 } else
342                         time = QTime::currentTime();
343                 result.push_back(make_pair("long",getTime("long", time)));
344                 result.push_back(make_pair("short", getTime("short", time)));
345                 result.push_back(make_pair("ISO", getTime("ISO", time)));
346                 result.push_back(make_pair("custom", _("Custom")));
347                 break;
348         }
349         }
350
351         return result;
352 }
353
354
355 bool InsetInfoParams::validateArgument(Buffer const * buf, docstring const & arg,
356                                        bool const usedefaults) const
357 {
358         string type;
359         string name = trim(split(to_utf8(arg), type, ' '));
360         if (name.empty() && usedefaults)
361                 name = defaultValueTranslator().find(type);
362
363         switch (nameTranslator().find(type)) {
364         case UNKNOWN_INFO:
365                 return false;
366
367         case SHORTCUT_INFO:
368         case SHORTCUTS_INFO:
369         case MENU_INFO: {
370                 FuncRequest func = lyxaction.lookupFunc(name);
371                 return func.action() != LFUN_UNKNOWN_ACTION;
372         }
373
374         case L7N_INFO:
375                 return !name.empty();
376
377         case ICON_INFO: {
378                 FuncCode const action = lyxaction.lookupFunc(name).action();
379                 if (action == LFUN_UNKNOWN_ACTION) {
380                         string dir = "images";
381                         return !imageLibFileSearch(dir, name, "svgz,png").empty();
382                 }
383                 return true;
384         }
385
386         case LYXRC_INFO: {
387                 set<string> rcs = lyxrc.getRCs();
388                 return rcs.find(name) != rcs.end();
389         }
390
391         case PACKAGE_INFO:
392         case TEXTCLASS_INFO:
393                 return true;
394
395         case BUFFER_INFO:
396                 return (name == "name" || name == "name-noext"
397                         || name == "path" || name == "class");
398
399         case VCS_INFO:
400                 if (name == "revision" || name == "revision-abbrev" || name == "tree-revision"
401                     || name == "author" || name == "date" || name == "time")
402                         return buf->lyxvc().inUse();
403                 return false;
404
405         case LYX_INFO:
406                 return name == "version" || name == "layoutformat";
407
408         case FIXDATE_INFO: {
409                 string date;
410                 string piece;
411                 date = split(name, piece, '@');
412                 if (!date.empty() && !QDate::fromString(toqstr(date), Qt::ISODate).isValid())
413                         return false;
414                 if (!piece.empty())
415                         name = piece;
416         }
417         // fall through
418         case DATE_INFO:
419         case MODDATE_INFO: {
420                 if (name == "long" || name == "short" || name == "ISO")
421                         return true;
422                 else {
423                         QDate date = QDate::currentDate();
424                         return !date.toString(toqstr(name)).isEmpty();
425                 }
426         }
427         case FIXTIME_INFO: {
428                 string time;
429                 string piece;
430                 time = split(name, piece, '@');
431                 if (!time.empty() && !QTime::fromString(toqstr(time), Qt::ISODate).isValid())
432                         return false;
433                 if (!piece.empty())
434                         name = piece;
435         }
436         // fall through
437         case TIME_INFO:
438         case MODTIME_INFO: {
439                 if (name == "long" || name == "short" || name == "ISO")
440                         return true;
441                 else {
442                         QTime time = QTime::currentTime();
443                         return !time.toString(toqstr(name)).isEmpty();
444                 }
445         }
446         }
447
448         return false;
449 }
450
451
452
453
454 string InsetInfoParams::infoType() const
455 {
456         return nameTranslator().find(type);
457 }
458
459
460
461 /////////////////////////////////////////////////////////////////////////
462 //
463 // InsetInfo
464 //
465 /////////////////////////////////////////////////////////////////////////
466
467
468
469 InsetInfo::InsetInfo(Buffer * buf, string const & info)
470         : InsetCollapsible(buf), initialized_(false)
471 {
472         params_.type = InsetInfoParams::UNKNOWN_INFO;
473         params_.force_ltr = false;
474         setInfo(info);
475         status_ = Collapsed;
476 }
477
478
479 Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
480 {
481         // do not allow the cursor to be set in this Inset
482         return Inset::editXY(cur, x, y);
483 }
484
485
486 docstring InsetInfo::layoutName() const
487 {
488         return from_ascii("Info:" + params_.infoType());
489 }
490
491
492 docstring InsetInfo::toolTip(BufferView const &, int, int) const
493 {
494         docstring result;
495         switch (nameTranslator().find(params_.infoType())) {
496         case InsetInfoParams::UNKNOWN_INFO:
497                 result = _("Invalid information inset");
498                 break;
499         case InsetInfoParams::SHORTCUT_INFO:
500                 result = bformat(_("The keybard shortcut for the function '%1$s'"),
501                                 from_utf8(params_.name));
502                 break;
503         case InsetInfoParams::SHORTCUTS_INFO:
504                 result = bformat(_("The keybard shortcuts for the function '%1$s'"),
505                                 from_utf8(params_.name));
506                 break;
507         case InsetInfoParams::MENU_INFO: 
508                 result = bformat(_("The menu location for the function '%1$s'"),
509                                 from_utf8(params_.name));
510                 break;
511         case InsetInfoParams::L7N_INFO: 
512                 result = bformat(_("The localization for the string '%1$s'"),
513                                 from_utf8(params_.name));
514                 break;
515         case InsetInfoParams::ICON_INFO:
516                 result = bformat(_("The toolbar icon for the function '%1$s'"),
517                                 from_utf8(params_.name));
518                 break;
519         case InsetInfoParams::LYXRC_INFO:
520                 result = bformat(_("The preference setting for the preference key '%1$s'"),
521                                 from_utf8(params_.name));
522                 break;
523         case InsetInfoParams::PACKAGE_INFO:
524                 result = bformat(_("Availability of the LaTeX package '%1$s'"),
525                                 from_utf8(params_.name));
526                 break;
527         case InsetInfoParams::TEXTCLASS_INFO:
528                 result = bformat(_("Availability of the LaTeX class '%1$s'"),
529                                 from_utf8(params_.name));
530                 break;
531         case InsetInfoParams::BUFFER_INFO:
532                 if (params_.name == "name")
533                         result = _("The name of this file (incl. extension)");
534                 else if (params_.name == "name-noext")
535                         result = _("The name of this file (without extension)");
536                 else if (params_.name == "path")
537                         result = _("The path where this file is saved");
538                 else if (params_.name == "class")
539                         result = _("The class this document uses");
540                 break;
541         case InsetInfoParams::VCS_INFO:
542                 if (params_.name == "revision")
543                         result = _("Version control revision");
544                 else if (params_.name == "revision-abbrev")
545                         result = _("Version control abbreviated revision");
546                 else if (params_.name == "tree-revision")
547                         result = _("Version control tree revision");
548                 else if (params_.name == "author")
549                          result = _("Version control author");
550                 else if (params_.name == "date")
551                         result = _("Version control date");
552                 else if (params_.name == "time")
553                         result = _("Version control time");
554                 break;
555         case InsetInfoParams::LYX_INFO:
556                 if (params_.name == "version")
557                         result = _("The current LyX version");
558                 else if (params_.name == "layoutformat")
559                         result = _("The current LyX layout format");
560                 break;
561         case InsetInfoParams::DATE_INFO:
562                 result = _("The current date");
563                 break;
564         case InsetInfoParams::MODDATE_INFO:
565                 result = _("The date of last save");
566                 break;
567         case InsetInfoParams::FIXDATE_INFO:
568                 result = _("A static date");
569                 break;
570         case InsetInfoParams::TIME_INFO:
571                 result = _("The current time");
572                 break;
573         case InsetInfoParams::MODTIME_INFO:
574                 result = _("The time of last save");
575                 break;
576         case InsetInfoParams::FIXTIME_INFO:
577                 result = _("A static time");
578                 break;
579         }
580
581         return result;
582 }
583
584
585 void InsetInfo::read(Lexer & lex)
586 {
587         string token;
588         while (lex.isOK()) {
589                 lex.next();
590                 token = lex.getString();
591                 if (token == "type") {
592                         lex.next();
593                         token = lex.getString();
594                         params_.type = nameTranslator().find(token);
595                 } else if (token == "arg") {
596                         lex.next(true);
597                         params_.name = lex.getString();
598                 } else if (token == "\\end_inset")
599                         break;
600         }
601         if (token != "\\end_inset") {
602                 lex.printError("Missing \\end_inset at this point");
603                 throw ExceptionMessage(WarningException,
604                         _("Missing \\end_inset at this point."),
605                         from_utf8(token));
606         }
607 }
608
609
610 void InsetInfo::write(ostream & os) const
611 {
612         os << "Info\ntype  \"" << params_.infoType()
613            << "\"\narg   " << Lexer::quoteString(params_.name);
614 }
615
616
617 bool InsetInfo::showInsetDialog(BufferView * bv) const
618 {
619         bv->showDialog("info");
620         return true;
621 }
622
623
624 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
625                 FuncStatus & flag) const
626 {
627         switch (cmd.action()) {
628         case LFUN_INSET_SETTINGS:
629                 return InsetCollapsible::getStatus(cur, cmd, flag);
630
631         case LFUN_INSET_DIALOG_UPDATE:
632         case LFUN_INSET_COPY_AS:
633         case LFUN_INSET_DISSOLVE:
634                 flag.setEnabled(true);
635                 return true;
636
637         case LFUN_INSET_MODIFY:
638                 if (nameTranslator().find(cmd.getArg(0)) == InsetInfoParams::UNKNOWN_INFO)
639                         return Inset::getStatus(cur, cmd, flag);
640                 if (params_.validateArgument(&buffer(), cmd.argument())) {
641                         flag.setEnabled(true);
642                         string typestr;
643                         string name = trim(split(to_utf8(cmd.argument()), typestr, ' '));
644                         InsetInfoParams::info_type type = nameTranslator().find(typestr);
645                         string origname = params_.name;
646                         if (type == InsetInfoParams::FIXDATE_INFO
647                             || type == InsetInfoParams::FIXTIME_INFO)
648                                 split(params_.name, origname, '@');
649                         flag.setOnOff(type == params_.type && name == origname);
650                         return true;
651                 }
652                 //fall through
653
654         default:
655                 return false;
656         }
657 }
658
659
660 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
661 {
662         switch (cmd.action()) {
663         case LFUN_INSET_MODIFY:
664                 if (nameTranslator().find(cmd.getArg(0)) == InsetInfoParams::UNKNOWN_INFO) {
665                         cur.undispatched();
666                         break;
667                 }
668                 cur.recordUndo();
669                 setInfo(to_utf8(cmd.argument()));
670                 cur.forceBufferUpdate();
671                 initialized_ = false;
672                 break;
673
674         case LFUN_INSET_COPY_AS: {
675                 cap::clearSelection();
676                 Cursor copy(cur);
677                 copy.pushBackward(*this);
678                 copy.pit() = 0;
679                 copy.pos() = 0;
680                 copy.resetAnchor();
681                 copy.pit() = copy.lastpit();
682                 copy.pos() = copy.lastpos();
683                 copy.setSelection();
684                 cap::copySelection(copy);
685                 break;
686         }
687
688         default:
689                 InsetCollapsible::doDispatch(cur, cmd);
690                 break;
691         }
692 }
693
694
695 void InsetInfo::setInfo(string const & info)
696 {
697         if (info.empty())
698                 return;
699
700         string saved_date_specifier;
701         // Store old date specifier for potential re-use
702         if (!params_.name.empty())
703                 saved_date_specifier = split(params_.name, '@');
704         // info_type name
705         string type;
706         params_.name = trim(split(info, type, ' '));
707         params_.type = nameTranslator().find(type);
708         if (params_.name.empty())
709                 params_.name = defaultValueTranslator().find(params_.type);
710         if (params_.type == InsetInfoParams::FIXDATE_INFO) {
711                 string const date_specifier = split(params_.name, '@');
712                 // If an explicit new fix date is specified, use that
713                 // Otherwise, use the old one or, if there is none,
714                 // the current date
715                 if (date_specifier.empty()) {
716                         if (saved_date_specifier.empty())
717                                 params_.name += "@" + fromqstr(QDate::currentDate().toString(Qt::ISODate));
718                         else
719                                 params_.name += "@" + saved_date_specifier;
720                 }
721         }
722         else if (params_.type == InsetInfoParams::FIXTIME_INFO) {
723                 string const time_specifier = split(params_.name, '@');
724                 // If an explicit new fix time is specified, use that
725                 // Otherwise, use the old one or, if there is none,
726                 // the current time
727                 if (time_specifier.empty()) {
728                         if (saved_date_specifier.empty())
729                                 params_.name += "@" + fromqstr(QTime::currentTime().toString(Qt::ISODate));
730                         else
731                                 params_.name += "@" + saved_date_specifier;
732                 }
733         }
734 }
735
736
737 void InsetInfo::error(docstring const & err, Language const * lang)
738 {
739         docstring const res = translateIfPossible(err, lang->code());
740         bool const translated = res != err;
741         // If the string is not translated, we use default lang (English)
742         Font const f = translated ? Font(inherit_font, lang) : Font(inherit_font);
743         setText(bformat(res, from_utf8(params_.name)), f, false);
744 }
745
746
747 void InsetInfo::info(docstring const & err, Language const * lang)
748 {
749         docstring const res = translateIfPossible(err, lang->code());
750         bool const translated = res != err;
751         // If the string is not translated, we use default lang (English)
752         Font const f = translated ? Font(inherit_font, lang) : Font(inherit_font);
753         setText(translateIfPossible(err, lang->code()), f, false);
754 }
755
756
757 void InsetInfo::setText(docstring const & str, Language const * lang)
758 {
759         setText(str, Font(inherit_font, lang), false);
760 }
761
762
763 bool InsetInfo::forceLTR(OutputParams const &) const
764 {
765         return params_.force_ltr;
766 }
767
768
769 bool InsetInfo::forceLocalFontSwitch() const
770 {
771         return params_.type == InsetInfoParams::MENU_INFO
772                 || params_.type == InsetInfoParams::SHORTCUTS_INFO
773                 || params_.type == InsetInfoParams::SHORTCUT_INFO
774                 || params_.type == InsetInfoParams::L7N_INFO;
775 }
776
777
778 void InsetInfo::metrics(MetricsInfo & mi, Dimension & dim) const
779 {
780         const_cast<InsetInfo *>(this)->build();
781         InsetCollapsible::metrics(mi, dim);
782 }
783
784
785 void InsetInfo::draw(PainterInfo & pi, int x, int y) const
786 {
787         Changer chg = changeVar(lyxrc.mark_foreign_language, false);
788         InsetCollapsible::draw(pi, x, y);
789 }
790
791 void InsetInfo::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
792
793 {
794         // If the Buffer is a clone, then we neither need nor want to do any
795         // of what follows. We want, rather, just to inherit how things were
796         // in the original Buffer. This is especially important for VCS.
797         // Otherwise, we could in principle have different settings here
798         // than in the Buffer we were exporting.
799         if (buffer().isClone())
800                 return;
801         BufferParams const & bp = buffer().params();
802         params_.lang = it.paragraph().getFontSettings(bp, it.pos()).language();
803         InsetCollapsible::updateBuffer(it, utype, deleted);
804 }
805
806
807 void InsetInfo::build()
808 {
809         // If the Buffer is a clone, then we neither need nor want to do any
810         // of what follows. We want, rather, just to inherit how things were
811         // in the original Buffer. This is especially important for VCS.
812         // Otherwise, we could in principle have different settings here
813         // than in the Buffer we were exporting.
814         if (buffer().isClone())
815                 return;
816
817         Language const * tryguilang = languages.getFromCode(Messages::guiLanguage());
818         // Some info insets use the language of the GUI (if available)
819         Language const * guilang = tryguilang ? tryguilang : params_.lang;
820
821         params_.force_ltr = !params_.lang->rightToLeft();
822         // This is just to get the string into the po files
823         docstring gui;
824         switch (params_.type) {
825         case InsetInfoParams::UNKNOWN_INFO:
826                 gui = _("Unknown Info!");
827                 info(from_ascii("Unknown Info!"), params_.lang);
828                 initialized_ = false;
829                 break;
830         case InsetInfoParams::SHORTCUT_INFO:
831         case InsetInfoParams::SHORTCUTS_INFO: {
832                 // shortcuts can change, so we need to re-do this each time
833                 FuncRequest const func = lyxaction.lookupFunc(params_.name);
834                 if (func.action() == LFUN_UNKNOWN_ACTION) {
835                         gui = _("Unknown action %1$s");
836                         error(from_ascii("Unknown action %1$s"), params_.lang);
837                         break;
838                 }
839                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
840                 if (bindings.empty()) {
841                         gui = _("undefined");
842                         info(from_ascii("undefined"), params_.lang);
843                         break;
844                 }
845                 docstring sequence;
846                 docstring seq_untranslated;
847                 if (params_.type == InsetInfoParams::SHORTCUT_INFO) {
848                         sequence = bindings.begin()->print(KeySequence::ForGui);
849                         seq_untranslated = bindings.begin()->print(KeySequence::ForGui, true);
850                 } else {
851                         sequence = theTopLevelKeymap().printBindings(func, KeySequence::ForGui);
852                         seq_untranslated = theTopLevelKeymap().printBindings(func, KeySequence::ForGui, true);
853                 }
854                 // QKeySequence returns special characters for keys on the mac
855                 // Since these are not included in many fonts, we
856                 // re-translate them to textual names (see #10641)
857                 odocstringstream ods;
858                 string const lcode = params_.lang->code();
859                 docstring trans;
860                 bool is_translated = sequence != seq_untranslated;
861                 for (char_type const c : sequence) {
862                         switch(c) {
863                         case 0x21b5://Return
864                                 gui = _("Return[[Key]]");
865                                 is_translated = translateString(from_ascii("Return[[Key]]"), trans, lcode);
866                                 ods << trans;
867                                 break;
868                         case 0x21b9://Tab both directions (Win)
869                                 gui = _("Tab[[Key]]");
870                                 is_translated = translateString(from_ascii("Tab[[Key]]"), trans, lcode);
871                                 ods << trans;
872                                 break;
873                         case 0x21de://Qt::Key_PageUp
874                                 gui = _("PgUp");
875                                 is_translated = translateString(from_ascii("PgUp"), trans, lcode);
876                                 ods << trans;
877                                 break;
878                         case 0x21df://Qt::Key_PageDown
879                                 gui = _("PgDown");
880                                 is_translated = translateString(from_ascii("PgDown"), trans, lcode);
881                                 ods << trans;
882                                 break;
883                         case 0x21e4://Qt::Key_Backtab
884                                 gui = _("Backtab");
885                                 is_translated = translateString(from_ascii("Backtab"), trans, lcode);
886                                 ods << trans;
887                                 break;
888                         case 0x21e5://Qt::Key_Tab
889                                 gui = _("Tab");
890                                 is_translated = translateString(from_ascii("Tab"), trans, lcode);
891                                 ods << trans;
892                                 break;
893                         case 0x21e7://Shift
894                                 gui = _("Shift");
895                                 is_translated = translateString(from_ascii("Shift"), trans, lcode);
896                                 ods << trans;
897                                 break;
898                         case 0x21ea://Qt::Key_CapsLock
899                                 gui = _("CapsLock");
900                                 is_translated = translateString(from_ascii("CapsLock"), trans, lcode);
901                                 ods << trans;
902                                 break;
903                         case 0x2303://Control
904                                 gui = _("Control[[Key]]");
905                                 is_translated = translateString(from_ascii("Control[[Key]]"), trans, lcode);
906                                 ods << trans;
907                                 break;
908                         case 0x2318://CMD
909                                 gui = _("Command[[Key]]");
910                                 is_translated = translateString(from_ascii("Command[[Key]]"), trans, lcode);
911                                 ods << trans;
912                                 break;
913                         case 0x2324://Qt::Key_Enter
914                                 gui = _("Return[[Key]]");
915                                 is_translated = translateString(from_ascii("Return[[Key]]"), trans, lcode);
916                                 ods << trans;
917                                 break;
918                         case 0x2325://Option key
919                                 gui = _("Option[[Key]]");
920                                 is_translated = translateString(from_ascii("Option[[Key]]"), trans, lcode);
921                                 ods << trans;
922                                 break;
923                         case 0x2326://Qt::Key_Delete
924                                 gui = _("Delete[[Key]]");
925                                 is_translated = translateString(from_ascii("Delete[[Key]]"), trans, lcode);
926                                 ods << trans;
927                                 break;
928                         case 0x232b://Qt::Key_Backspace
929                                 gui = _("Fn+Del");
930                                 is_translated = translateString(from_ascii("Fn+Del"), trans, lcode);
931                                 ods << trans;
932                                 break;
933                         case 0x238b://Qt::Key_Escape
934                                 gui = _("Esc");
935                                 is_translated = translateString(from_ascii("Esc"), trans, lcode);
936                                 ods << trans;
937                                 break;
938                         default:
939                                 ods.put(c);
940                         }
941                 }
942                 setText(ods.str(), is_translated ? guilang : nullptr);
943                 params_.force_ltr = !is_translated || (!guilang->rightToLeft() && !params_.lang->rightToLeft());
944                 break;
945         }
946         case InsetInfoParams::LYXRC_INFO: {
947                 // this information could change, if the preferences are changed,
948                 // so we will recalculate each time through.
949                 ostringstream oss;
950                 if (params_.name.empty()) {
951                         gui = _("undefined");
952                         info(from_ascii("undefined"), params_.lang);
953                         break;
954                 }
955                 // FIXME this uses the serialization mechanism to get the info
956                 // we want, which i guess works but is a bit strange.
957                 lyxrc.write(oss, true, params_.name);
958                 string result = oss.str();
959                 if (result.size() < 2) {
960                         gui = _("undefined");
961                         info(from_ascii("undefined"), params_.lang);
962                         break;
963                 }
964                 string::size_type loc = result.rfind("\n", result.size() - 2);
965                 loc = loc == string::npos ? 0 : loc + 1;
966                 if (result.size() < loc + params_.name.size() + 1
967                           || result.substr(loc + 1, params_.name.size()) != params_.name) {
968                         gui = _("undefined");
969                         info(from_ascii("undefined"), params_.lang);
970                         break;
971                 }
972                 // remove leading comments and \\name and space
973                 result = result.substr(loc + params_.name.size() + 2);
974
975                 // remove \n and ""
976                 result = rtrim(result, "\n");
977                 result = trim(result, "\"");
978                 gui = _("not set");
979                 if (result.empty())
980                         result = "not set";
981                 setText(from_utf8(result), params_.lang);
982                 break;
983         }
984         case InsetInfoParams::PACKAGE_INFO:
985                 // only need to do this once.
986                 if (initialized_)
987                         break;
988                 // check in packages.lst
989                 if (LaTeXFeatures::isAvailable(params_.name)) {
990                         gui = _("yes");
991                         info(from_ascii("yes"), params_.lang);
992                 } else {
993                         gui = _("no");
994                         info(from_ascii("no"), params_.lang);
995                 }
996                 initialized_ = true;
997                 break;
998
999         case InsetInfoParams::TEXTCLASS_INFO: {
1000                 // the TextClass can change
1001                 LayoutFileList const & list = LayoutFileList::get();
1002                 bool available = false;
1003                 // params_.name is the class name
1004                 if (list.haveClass(params_.name))
1005                         available = list[params_.name].isTeXClassAvailable();
1006                 if (available) {
1007                         gui = _("yes");
1008                         info(from_ascii("yes"), params_.lang);
1009                 } else {
1010                         gui = _("no");
1011                         info(from_ascii("no"), params_.lang);
1012                 }
1013                 break;
1014         }
1015         case InsetInfoParams::MENU_INFO: {
1016                 // only need to do this once.
1017                 if (initialized_)
1018                         break;
1019                 docstring_list names;
1020                 FuncRequest func = lyxaction.lookupFunc(params_.name);
1021                 if (func.action() == LFUN_UNKNOWN_ACTION) {
1022                         gui = _("Unknown action %1$s");
1023                         error(from_ascii("Unknown action %1$s"), params_.lang);
1024                         break;
1025                 }
1026                 if (func.action() == LFUN_BUFFER_VIEW || func.action() == LFUN_BUFFER_UPDATE)
1027                         // The default output format is in the menu without argument,
1028                         // so strip it here.
1029                         if (func.argument() == from_ascii(buffer().params().getDefaultOutputFormat()))
1030                                 func = FuncRequest(func.action());
1031                 // iterate through the menubackend to find it
1032                 if (!theApp()) {
1033                         gui = _("Can't determine menu entry for action %1$s in batch mode");
1034                         error(from_ascii("Can't determine menu entry for action %1$s in batch mode"), params_.lang);
1035                         initialized_ = true;
1036                         break;
1037                 }
1038                 // and we will not keep trying if we fail
1039                 initialized_ = theApp()->hasBufferView();
1040                 if (!theApp()->searchMenu(func, names)) {
1041                         gui = _("No menu entry for action %1$s");
1042                         error(from_ascii("No menu entry for action %1$s"), params_.lang);
1043                         break;
1044                 }
1045                 // if found, return its path.
1046                 clear();
1047                 Paragraph & par = paragraphs().front();
1048                 Font const f(inherit_font, guilang);
1049                 params_.force_ltr = !guilang->rightToLeft();
1050                 //Font fu = f;
1051                 //fu.fontInfo().setUnderbar(FONT_ON);
1052                 for (docstring const & name : names) {
1053                         // do not insert > for the top level menu item
1054                         if (&name != &names.front())
1055                                 par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
1056                                                 f, Change(Change::UNCHANGED));
1057                         //FIXME: add proper underlines here. This
1058                         // involves rewriting searchMenu used above to
1059                         // return a vector of menus. If we do not do
1060                         // that, we might as well use below
1061                         // Paragraph::insert on each string (JMarc)
1062                         for (char_type c : name)
1063                                 par.insertChar(par.size(), c, f, Change(Change::UNCHANGED));
1064                 }
1065                 break;
1066         }
1067         case InsetInfoParams::L7N_INFO: {
1068                 docstring locstring = _(params_.name);
1069                 // Remove trailing colons
1070                 locstring = rtrim(locstring, ":");
1071                 // Remove menu accelerators
1072                 if (contains(locstring, from_ascii("|"))) {
1073                         docstring nlocstring;
1074                         rsplit(locstring, nlocstring, '|');
1075                         locstring = nlocstring;
1076                 }
1077                 // Remove Qt accelerators, but keep literal ampersands
1078                 locstring = subst(locstring, from_ascii(" & "), from_ascii("</amp;>"));
1079                 locstring = subst(locstring, from_ascii("&"), docstring());
1080                 locstring = subst(locstring, from_ascii("</amp;>"), from_ascii(" & "));
1081                 setText(locstring, guilang);
1082                 params_.force_ltr = !guilang->rightToLeft() && !params_.lang->rightToLeft();
1083                 break;
1084         }
1085         case InsetInfoParams::ICON_INFO: {
1086                 // only need to do this once.
1087                 if (initialized_)
1088                         break;
1089                 // and we will not keep trying if we fail
1090                 initialized_ = true;
1091                 FuncRequest func = lyxaction.lookupFunc(params_.name);
1092                 docstring icon_name = frontend::Application::iconName(func, true);
1093                 FileName file(to_utf8(icon_name));
1094                 if (file.onlyFileNameWithoutExt() == "unknown") {
1095                         string dir = "images";
1096                         FileName file2(imageLibFileSearch(dir, params_.name, "svgz,png"));
1097                         if (!file2.empty())
1098                                 file = file2;
1099                 }
1100                 if (!file.exists())
1101                         break;
1102                 int percent_scale = 100;
1103                 if (use_gui) {
1104                         // Compute the scale factor for the icon such that its
1105                         // width on screen is equal to 1em in pixels.
1106                         // The scale factor is rounded to the integer nearest
1107                         // to the float value of the ratio 100*iconsize/imgsize.
1108                         int imgsize = QImage(toqstr(file.absFileName())).width();
1109                         if (imgsize > 0) {
1110                                 int iconsize = Length(1, Length::EM).inPixels(1);
1111                                 percent_scale = (100 * iconsize + imgsize / 2)/imgsize;
1112                         }
1113                 }
1114                 InsetGraphics * inset = new InsetGraphics(buffer_);
1115                 InsetGraphicsParams igp;
1116                 igp.filename = file;
1117                 igp.lyxscale = percent_scale;
1118                 igp.scale = string();
1119                 igp.width = Length(1, Length::EM);
1120                 if (contains(file.absoluteFilePath(), from_ascii("math"))
1121                     || contains(file.absoluteFilePath(), from_ascii("ert-insert"))
1122                     || suffixIs(file.onlyPath().absoluteFilePath(), from_ascii("ipa")))
1123                         igp.darkModeSensitive = true;
1124                 inset->setParams(igp);
1125                 clear();
1126                 Font const f(inherit_font, params_.lang);
1127                 paragraphs().front().insertInset(0, inset, f,
1128                                                  Change(Change::UNCHANGED));
1129                 break;
1130         }
1131         case InsetInfoParams::BUFFER_INFO: {
1132                 // this could all change, so we will recalculate each time
1133                 if (params_.name == "name")
1134                         setText(from_utf8(buffer().fileName().onlyFileName()), params_.lang);
1135                 else if (params_.name == "name-noext")
1136                         setText(from_utf8(buffer().fileName().onlyFileNameWithoutExt()), params_.lang);
1137                 else if (params_.name == "path")
1138                         setText(from_utf8(os::latex_path(buffer().filePath())), params_.lang);
1139                 else if (params_.name == "class")
1140                         setText(from_utf8(buffer().params().documentClass().name()), params_.lang);
1141                 break;
1142         }
1143         case InsetInfoParams::VCS_INFO: {
1144                 // this information could change, in principle, so we will 
1145                 // recalculate each time through
1146                 if (!buffer().lyxvc().inUse()) {
1147                         gui = _("No version control!");
1148                         info(from_ascii("No version control!"), params_.lang);
1149                         break;
1150                 }
1151                 LyXVC::RevisionInfo itype = LyXVC::Unknown;
1152                 if (params_.name == "revision")
1153                         itype = LyXVC::File;
1154                 else if (params_.name == "revision-abbrev")
1155                         itype = LyXVC::FileAbbrev;
1156                 else if (params_.name == "tree-revision")
1157                         itype = LyXVC::Tree;
1158                 else if (params_.name == "author")
1159                         itype = LyXVC::Author;
1160                 else if (params_.name == "time")
1161                         itype = LyXVC::Time;
1162                 else if (params_.name == "date")
1163                         itype = LyXVC::Date;
1164                 string binfo = buffer().lyxvc().revisionInfo(itype);
1165                 if (binfo.empty()) {
1166                         gui = _("%1$s[[vcs data]] unknown");
1167                         error(from_ascii("%1$s[[vcs data]] unknown"), params_.lang);
1168                 } else
1169                         setText(from_utf8(binfo), params_.lang);
1170                 break;
1171         }
1172         case InsetInfoParams::LYX_INFO:
1173                 // only need to do this once.
1174                 if (initialized_)
1175                         break;
1176                 if (params_.name == "version")
1177                         setText(from_ascii(lyx_version), params_.lang);
1178                 else if (params_.name == "layoutformat")
1179                         setText(convert<docstring>(LAYOUT_FORMAT), params_.lang);
1180                 initialized_ = true;
1181                 break;
1182         case InsetInfoParams::DATE_INFO:
1183         case InsetInfoParams::MODDATE_INFO:
1184         case InsetInfoParams::FIXDATE_INFO: {
1185                 string date_format = params_.name;
1186                 string const date_specifier = (params_.type == InsetInfoParams::FIXDATE_INFO
1187                                                && contains(params_.name, '@'))
1188                                 ? split(params_.name, date_format, '@') : string();
1189                 QDate date;
1190                 if (params_.type == InsetInfoParams::MODDATE_INFO)
1191 #if (QT_VERSION >= QT_VERSION_CHECK(5, 8, 0))
1192                         date = QDateTime::fromSecsSinceEpoch(buffer().fileName().lastModified()).date();
1193 #else
1194                         date = QDateTime::fromTime_t(buffer().fileName().lastModified()).date();
1195 #endif
1196                 else if (params_.type == InsetInfoParams::FIXDATE_INFO && !date_specifier.empty())
1197                         date = QDate::fromString(toqstr(date_specifier), Qt::ISODate);
1198                 else
1199                         date = QDate::currentDate();
1200                 setText(params_.getDate(date_format, date), params_.lang);
1201                 break;
1202         }
1203         case InsetInfoParams::TIME_INFO:
1204         case InsetInfoParams::MODTIME_INFO:
1205         case InsetInfoParams::FIXTIME_INFO: {
1206                 string time_format = params_.name;
1207                 string const time_specifier = (params_.type == InsetInfoParams::FIXTIME_INFO
1208                                                && contains(params_.name, '@'))
1209                                 ? split(params_.name, time_format, '@') : string();
1210                 QTime time;
1211                 if (params_.type == InsetInfoParams::MODTIME_INFO)
1212 #if (QT_VERSION >= QT_VERSION_CHECK(5, 8, 0))
1213                         time = QDateTime::fromSecsSinceEpoch(buffer().fileName().lastModified()).time();
1214 #else
1215                         time = QDateTime::fromTime_t(buffer().fileName().lastModified()).time();
1216 #endif
1217                 else if (params_.type == InsetInfoParams::FIXTIME_INFO && !time_specifier.empty())
1218                         time = QTime::fromString(toqstr(time_specifier), Qt::ISODate);
1219                 else
1220                         time = QTime::currentTime();
1221                 setText(params_.getTime(time_format, time), params_.lang);
1222                 break;
1223         }
1224         }
1225
1226         // Just to do something with that string
1227         LYXERR(Debug::INFO, "info inset text: " << gui);
1228 }
1229
1230
1231 void InsetInfo::validate(LaTeXFeatures & features) const
1232 {
1233         const_cast<InsetInfo *>(this)->build();
1234         InsetCollapsible::validate(features);
1235 }
1236
1237
1238 string InsetInfo::contextMenu(BufferView const &, int, int) const
1239 {
1240         //FIXME: We override the implementation of InsetCollapsible,
1241         //because this inset is not a collapsible inset.
1242         return contextMenuName();
1243 }
1244
1245
1246 string InsetInfo::contextMenuName() const
1247 {
1248         return "context-info";
1249 }
1250
1251
1252 } // namespace lyx