]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInfo.cpp
Add override statements to please clang
[lyx.git] / src / insets / InsetInfo.cpp
index 05de0309578c7c956fc724d0c4bf03f11a7f3791..65ce972af305a88ec083e5a5b79332aa66456195 100644 (file)
 #include <config.h>
 
 #include "InsetInfo.h"
-
+#include "LyX.h"
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "BufferView.h"
+#include "CutAndPaste.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
 #include "InsetGraphics.h"
 #include "InsetSpecialChar.h"
 #include "KeyMap.h"
 #include "LaTeXFeatures.h"
+#include "Language.h"
 #include "LayoutFile.h"
+#include "Length.h"
 #include "LyXAction.h"
 #include "LyXRC.h"
 #include "LyXVC.h"
 #include "Lexer.h"
-#include "MetricsInfo.h"
 #include "ParagraphParameters.h"
+#include "version.h"
 
 #include "frontends/Application.h"
 
+#include "support/convert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
 #include "support/docstring_list.h"
 #include "support/filetools.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
+#include "support/qstring_helpers.h"
+#include "support/Translator.h"
 
 #include <sstream>
 
+#include <QtGui/QImage>
+
 using namespace std;
 using namespace lyx::support;
 
@@ -51,7 +59,7 @@ namespace {
 typedef Translator<InsetInfo::info_type, string> NameTranslator;
 
 NameTranslator const initTranslator()
-{      
+{
        NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
 
        translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
@@ -62,6 +70,7 @@ NameTranslator const initTranslator()
        translator.addPair(InsetInfo::MENU_INFO, "menu");
        translator.addPair(InsetInfo::ICON_INFO, "icon");
        translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
+       translator.addPair(InsetInfo::LYX_INFO, "lyxinfo");
 
        return translator;
 }
@@ -73,7 +82,7 @@ NameTranslator const & nameTranslator()
        return translator;
 }
 
-} // namespace anon
+} // namespace
 
 /////////////////////////////////////////////////////////////////////////
 //
@@ -82,11 +91,11 @@ NameTranslator const & nameTranslator()
 /////////////////////////////////////////////////////////////////////////
 
 
-       
-InsetInfo::InsetInfo(Buffer * buf, string const & name) 
-       : InsetCollapsable(buf), type_(UNKNOWN_INFO), name_()
+
+InsetInfo::InsetInfo(Buffer * buf, string const & name)
+       : InsetCollapsible(buf), type_(UNKNOWN_INFO), name_(),
+       force_ltr_(false)
 {
-       setAutoBreakRows(true);
        setInfo(name);
        status_ = Collapsed;
 }
@@ -105,7 +114,7 @@ string InsetInfo::infoType() const
 }
 
 
-docstring InsetInfo::name() const 
+docstring InsetInfo::layoutName() const
 {
        return from_ascii("Info:" + infoType());
 }
@@ -133,7 +142,7 @@ void InsetInfo::read(Lexer & lex)
                        name_ = lex.getString();
                } else if (token == "\\end_inset")
                        break;
-       }       
+       }
        if (token != "\\end_inset") {
                lex.printError("Missing \\end_inset at this point");
                throw ExceptionMessage(WarningException,
@@ -146,7 +155,7 @@ void InsetInfo::read(Lexer & lex)
 
 void InsetInfo::write(ostream & os) const
 {
-       os << "Info\ntype  \"" << infoType() 
+       os << "Info\ntype  \"" << infoType()
           << "\"\narg   " << Lexer::quoteString(name_);
 }
 
@@ -155,29 +164,49 @@ bool InsetInfo::validateModifyArgument(docstring const & arg) const
 {
        string type;
        string const name = trim(split(to_utf8(arg), type, ' '));
+
        switch (nameTranslator().find(type)) {
        case UNKNOWN_INFO:
                return false;
+
        case SHORTCUT_INFO:
        case SHORTCUTS_INFO:
-       case MENU_INFO:
-       case ICON_INFO: {
+       case MENU_INFO: {
                FuncRequest func = lyxaction.lookupFunc(name);
-               return func.action != LFUN_UNKNOWN_ACTION;
+               return func.action() != LFUN_UNKNOWN_ACTION;
        }
+
+       case ICON_INFO: {
+               FuncCode const action = lyxaction.lookupFunc(name).action();
+               if (action == LFUN_UNKNOWN_ACTION) {
+                       string dir = "images";
+                       return !imageLibFileSearch(dir, name, "svgz,png").empty();
+               }
+               return true;
+       }
+
        case LYXRC_INFO: {
                ostringstream oss;
                lyxrc.write(oss, true, name);
                return !oss.str().empty();
        }
+
        case PACKAGE_INFO:
        case TEXTCLASS_INFO:
                return true;
+
        case BUFFER_INFO:
-               return name == "name" || name == "path" || name == "class" ||
-                      name == "vcs-revision" || name == "vcs-tree-revision" ||
-                      name == "vcs-author" || name == "vcs-date" || name == "vcs-time";
+               if (name == "name" || name == "path" || name == "class")
+                       return true;
+               if (name == "vcs-revision" || name == "vcs-tree-revision" ||
+                      name == "vcs-author" || name == "vcs-date" || name == "vcs-time")
+                       return buffer().lyxvc().inUse();
+               return false;
+
+       case LYX_INFO:
+               return name == "version";
        }
+
        return false;
 }
 
@@ -192,21 +221,22 @@ bool InsetInfo::showInsetDialog(BufferView * bv) const
 bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
                FuncStatus & flag) const
 {
-       switch (cmd.action) {
-       case LFUN_MOUSE_PRESS:
-       case LFUN_MOUSE_RELEASE:
-       case LFUN_MOUSE_MOTION:
-       case LFUN_MOUSE_DOUBLE:
-       case LFUN_MOUSE_TRIPLE:
-       case LFUN_COPY:
+       switch (cmd.action()) {
        case LFUN_INSET_SETTINGS:
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
 
        case LFUN_INSET_DIALOG_UPDATE:
-       case LFUN_INSET_MODIFY:
+       case LFUN_INSET_COPY_AS:
                flag.setEnabled(true);
                return true;
 
+       case LFUN_INSET_MODIFY:
+               if (validateModifyArgument(cmd.argument())) {
+                       flag.setEnabled(true);
+                       return true;
+               }
+               //fall through
+
        default:
                return false;
        }
@@ -215,24 +245,28 @@ bool InsetInfo::getStatus(Cursor & cur, FuncRequest const & cmd,
 
 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       // allow selection, copy but not cut, delete etc
-       switch (cmd.action) {
-       case LFUN_MOUSE_PRESS:
-       case LFUN_MOUSE_RELEASE:
-       case LFUN_MOUSE_MOTION:
-       case LFUN_MOUSE_DOUBLE:
-       case LFUN_MOUSE_TRIPLE:
-       case LFUN_COPY:
-       case LFUN_INSET_SETTINGS:
-               InsetCollapsable::doDispatch(cur, cmd);
-               break;
-
+       switch (cmd.action()) {
        case LFUN_INSET_MODIFY:
+               cur.recordUndo();
                setInfo(to_utf8(cmd.argument()));
-               cur.pos() = 0;
                break;
 
+       case LFUN_INSET_COPY_AS: {
+               cap::clearSelection();
+               Cursor copy(cur);
+               copy.pushBackward(*this);
+               copy.pit() = 0;
+               copy.pos() = 0;
+               copy.resetAnchor();
+               copy.pit() = copy.lastpit();
+               copy.pos() = copy.lastpos();
+               copy.setSelection();
+               cap::copySelection(copy);
+               break;
+       }
+
        default:
+               InsetCollapsible::doDispatch(cur, cmd);
                break;
        }
 }
@@ -252,7 +286,7 @@ void InsetInfo::setInfo(string const & name)
 
 void InsetInfo::error(string const & err)
 {
-       setText(bformat(_(err), from_utf8(name_)), 
+       setText(bformat(_(err), from_utf8(name_)),
                Font(inherit_font, buffer().params().language), false);
 }
 
@@ -263,18 +297,25 @@ void InsetInfo::setText(docstring const & str)
 }
 
 
+bool InsetInfo::forceLTR() const
+{
+       return !buffer().params().language->rightToLeft() || force_ltr_;
+}
+
+
 void InsetInfo::updateInfo()
 {
-       BufferParams const & bp = buffer().params();    
+       BufferParams const & bp = buffer().params();
 
+       force_ltr_ = false;
        switch (type_) {
        case UNKNOWN_INFO:
                error("Unknown Info: %1$s");
                break;
        case SHORTCUT_INFO:
        case SHORTCUTS_INFO: {
-               FuncRequest func = lyxaction.lookupFunc(name_);
-               if (func.action == LFUN_UNKNOWN_ACTION) {
+               FuncRequest const func = lyxaction.lookupFunc(name_);
+               if (func.action() == LFUN_UNKNOWN_ACTION) {
                        error("Unknown action %1$s");
                        break;
                }
@@ -284,18 +325,106 @@ void InsetInfo::updateInfo()
                        setText(_("undefined"));
                        break;
                }
+               docstring sequence;
                if (type_ == SHORTCUT_INFO)
-                       setText(bindings.begin()->print(KeySequence::Portable));
+                       sequence = bindings.begin()->print(KeySequence::ForGui);
                else
-                       setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
+                       sequence = theTopLevelKeymap().printBindings(func, KeySequence::ForGui);
+               // QKeySequence returns special characters for keys on the mac
+               // Since these are not included in many fonts, we
+               // re-translate them to textual names (see #10641)
+               odocstringstream ods;
+               docstring gui;
+               string const lcode = bp.language->code();
+               for (size_t n = 0; n < sequence.size(); ++n) {
+                       char_type const c = sequence[n];
+                       switch(c) {
+                       case 0x21b5://Return
+                               gui = _("Return[[Key]]");
+                               ods << translateIfPossible(from_ascii("Return[[Key]]"), lcode);
+                               break;
+                       case 0x21b9://Tab both directions (Win)
+                               gui = _("Tab[[Key]]");
+                               ods << translateIfPossible(from_ascii("Tab[[Key]]"), lcode);
+                               break;
+                       case 0x21de://Qt::Key_PageUp
+                               gui = _("PgUp");
+                               ods << translateIfPossible(from_ascii("PgUp"), lcode);
+                               break;
+                       case 0x21df://Qt::Key_PageDown
+                               gui = _("PgDown");
+                               ods << translateIfPossible(from_ascii("PgDown"), lcode);
+                               break;
+                       case 0x21e4://Qt::Key_Backtab
+                               gui = _("Backtab");
+                               ods << translateIfPossible(from_ascii("Backtab"), lcode);
+                               break;
+                       case 0x21e5://Qt::Key_Tab
+                               gui = _("Tab");
+                               ods << translateIfPossible(from_ascii("Tab"), lcode);
+                               break;
+                       case 0x21e7://Shift
+                               gui = _("Shift");
+                               ods << translateIfPossible(from_ascii("Shift"), lcode);
+                               break;
+                       case 0x21ea://Qt::Key_CapsLock
+                               gui = _("CapsLock");
+                               ods << translateIfPossible(from_ascii("CapsLock"), lcode);
+                               break;
+                       case 0x2318://CMD
+                               gui = _("Command[[Key]]");
+                               ods << translateIfPossible(from_ascii("Command[[Key]]"), lcode);
+                               break;
+                       case 0x2324://Qt::Key_Enter
+                               gui = _("Return[[Key]]");
+                               ods << translateIfPossible(from_ascii("Return[[Key]]"), lcode);
+                               break;
+                       case 0x2325://Option key
+                               gui = _("Option[[Key]]");
+                               ods << translateIfPossible(from_ascii("Option[[Key]]"), lcode);
+                               break;
+                       case 0x2326://Qt::Key_Delete
+                               gui = _("Delete[[Key]]");
+                               ods << translateIfPossible(from_ascii("Delete[[Key]]"), lcode);
+                               break;
+                       case 0x232b://Qt::Key_Backspace
+                               gui = _("Fn+Del");
+                               ods << translateIfPossible(from_ascii("Fn+Delete"), lcode);
+                               break;
+                       case 0x238b://Qt::Key_Escape
+                               gui = _("Esc");
+                               ods << translateIfPossible(from_ascii("Esc"), lcode);
+                               break;
+                       default:
+                               ods.put(c);
+                       }
+               }
+               setText(ods.str());
+               force_ltr_ = !bp.language->rightToLeft();
                break;
        }
        case LYXRC_INFO: {
                ostringstream oss;
+               if (name_.empty()) {
+                       setText(_("undefined"));
+                       break;
+               }
                lyxrc.write(oss, true, name_);
                string result = oss.str();
-               // remove leading \\name
-               result = result.substr(name_.size() + 2);
+               if (result.size() < 2) {
+                       setText(_("undefined"));
+                       break;
+               }
+               string::size_type loc = result.rfind("\n", result.size() - 2);
+               loc = loc == string::npos ? 0 : loc + 1;
+               if (result.size() < loc + name_.size() + 1
+                         || result.substr(loc + 1, name_.size()) != name_) {
+                       setText(_("undefined"));
+                       break;
+               }
+               // remove leading comments and \\name and space
+               result = result.substr(loc + name_.size() + 2);
+
                // remove \n and ""
                result = rtrim(result, "\n");
                result = trim(result, "\"");
@@ -306,19 +435,28 @@ void InsetInfo::updateInfo()
                // check in packages.lst
                setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
                break;
+
        case TEXTCLASS_INFO: {
                // name_ is the class name
-               setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
+               LayoutFileList const & list = LayoutFileList::get();
+               bool available = false;
+               if (list.haveClass(name_))
+                       available = list[name_].isTeXClassAvailable();
+               setText(available ? _("yes") : _("no"));
                break;
        }
        case MENU_INFO: {
                docstring_list names;
-               FuncRequest func = lyxaction.lookupFunc(name_);
-               if (func.action == LFUN_UNKNOWN_ACTION) {
+               FuncRequest const func = lyxaction.lookupFunc(name_);
+               if (func.action() == LFUN_UNKNOWN_ACTION) {
                        error("Unknown action %1$s");
                        break;
                }
                // iterate through the menubackend to find it
+               if (!theApp()) {
+                       error("Can't determine menu entry for action %1$s in batch mode");
+                       break;
+               }
                if (!theApp()->searchMenu(func, names)) {
                        error("No menu entry for action %1$s");
                        break;
@@ -331,75 +469,125 @@ void InsetInfo::updateInfo()
                //fu.fontInfo().setUnderbar(FONT_ON);
                docstring_list::const_iterator beg = names.begin();
                docstring_list::const_iterator end = names.end();
-               for (docstring_list::const_iterator it = beg ; 
+               for (docstring_list::const_iterator it = beg ;
                     it != end ; ++it) {
                        // do not insert > for the top level menu item
                        if (it != beg)
                                par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
-                                               Change(Change::UNCHANGED));
+                                               f, Change(Change::UNCHANGED));
                        //FIXME: add proper underlines here. This
                        // involves rewriting searchMenu used above to
                        // return a vector of menus. If we do not do
                        // that, we might as well use below
                        // Paragraph::insert on each string (JMarc)
                        for (size_type i = 0; i != it->length(); ++i)
-                               par.insertChar(par.size(), (*it)[i], 
+                               par.insertChar(par.size(), (*it)[i],
                                               f, Change(Change::UNCHANGED));
                }
                break;
        }
        case ICON_INFO: {
                FuncRequest func = lyxaction.lookupFunc(name_);
-               docstring icon_name = theApp()->iconName(func, true);
-               //FIXME: We should use the icon directly instead of
+               docstring icon_name = frontend::Application::iconName(func, true);
+               // FIXME: We should use the icon directly instead of
                // going through FileName. The code below won't work
                // if the icon is embedded in the executable through
                // the Qt resource system.
+               // This is only a negligible performance problem:
+               // If the installed icon differs from the resource icon the
+               // installed one is preferred anyway, and all icons that are
+               // embedded in the resources are installed as well.
                FileName file(to_utf8(icon_name));
+               if (file.onlyFileNameWithoutExt() == "unknown") {
+                       string dir = "images";
+                       FileName file2(imageLibFileSearch(dir, name_, "svgz,png"));
+                       if (!file2.empty())
+                               file = file2;
+               }
                if (!file.exists())
                        break;
+               int percent_scale = 100;
+               if (use_gui) {
+                       // Compute the scale factor for the icon such that its
+                       // width on screen is equal to 1em in pixels.
+                       // The scale factor is rounded to the integer nearest
+                       // to the float value of the ratio 100*iconsize/imgsize.
+                       int imgsize = QImage(toqstr(file.absFileName())).width();
+                       if (imgsize > 0) {
+                               int iconsize = Length(1, Length::EM).inPixels(1);
+                               percent_scale = (100 * iconsize + imgsize / 2)/imgsize;
+                       }
+               }
                InsetGraphics * inset = new InsetGraphics(buffer_);
                InsetGraphicsParams igp;
                igp.filename = file;
+               igp.lyxscale = percent_scale;
+               igp.scale = string();
+               igp.width = Length(1, Length::EM);
                inset->setParams(igp);
                clear();
-               paragraphs().front().insertInset(0, inset, 
+               Font const f(inherit_font, buffer().params().language);
+               paragraphs().front().insertInset(0, inset, f,
                                                 Change(Change::UNCHANGED));
                break;
        }
        case BUFFER_INFO: {
-               if (name_ == "name")
+               if (name_ == "name") {
                        setText(from_utf8(buffer().fileName().onlyFileName()));
-               else if (name_ == "path")
-                       setText(from_utf8(buffer().filePath()));
-               else if (name_ == "class")
+                       break;
+               }
+               if (name_ == "path") {
+                       setText(from_utf8(os::latex_path(buffer().filePath())));
+                       break;
+               }
+               if (name_ == "class") {
                        setText(from_utf8(bp.documentClass().name()));
-               else if (name_ == "vcs-revision" && buffer().lyxvc().inUse() &&
-                        !buffer().lyxvc().revisionInfo(LyXVC::File).empty())
-                       setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::File)));
-               else if (name_ == "vcs-tree-revision" && buffer().lyxvc().inUse() &&
-                        !buffer().lyxvc().revisionInfo(LyXVC::Tree).empty())
-                       setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Tree)));
-               else if (name_ == "vcs-author" && buffer().lyxvc().inUse() &&
-                        !buffer().lyxvc().revisionInfo(LyXVC::Author).empty())
-                       setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Author)));
-               else if (name_ == "vcs-time" && buffer().lyxvc().inUse() &&
-                        !buffer().lyxvc().revisionInfo(LyXVC::Time).empty())
-                       setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Time)));
-               else if (name_ == "vcs-date" && buffer().lyxvc().inUse() &&
-                        !buffer().lyxvc().revisionInfo(LyXVC::Date).empty())
-                       setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::Date)));
+                       break;
+               }
+
+               // everything that follows is for version control.
+               // nothing that isn't version control should go below this line.
+               if (!buffer().lyxvc().inUse()) {
+                       setText(_("No version control"));
+                       break;
+               }
+               LyXVC::RevisionInfo itype = LyXVC::Unknown;
+               if (name_ == "vcs-revision")
+                       itype = LyXVC::File;
+               else if (name_ == "vcs-tree-revision")
+                       itype = LyXVC::Tree;
+               else if (name_ == "vcs-author")
+                       itype = LyXVC::Author;
+               else if (name_ == "vcs-time")
+                       itype = LyXVC::Time;
+               else if (name_ == "vcs-date")
+                       itype = LyXVC::Date;
+               string binfo = buffer().lyxvc().revisionInfo(itype);
+               if (binfo.empty())
+                       setText(from_ascii(name_) + " unknown");
                else
-                       setText(_("Unknown buffer info"));
+                       setText(from_utf8(binfo));
                break;
        }
+       case LYX_INFO:
+               if (name_ == "version")
+                       setText(from_ascii(lyx_version));
+               break;
        }
 }
 
 
-docstring InsetInfo::contextMenu(BufferView const &, int, int) const
+string InsetInfo::contextMenu(BufferView const &, int, int) const
+{
+       //FIXME: We override the implementation of InsetCollapsible,
+       //because this inset is not a collapsible inset.
+       return contextMenuName();
+}
+
+
+string InsetInfo::contextMenuName() const
 {
-       return from_ascii("context-info");
+       return "context-info";
 }