]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInfo.cpp
Fix MSVC warning
[lyx.git] / src / insets / InsetInfo.cpp
index 581a24a25ac8e0cde4c7eb4337cf3853484787b7..0740fb4c91560231d88dd7c037afecb546df676b 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 "KeyMap.h"
 #include "LaTeXFeatures.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;
 
 namespace lyx {
 
+namespace {
+
+typedef Translator<InsetInfo::info_type, string> NameTranslator;
 
-InsetInfo::InsetInfo(Buffer const & buf, string const & name) 
-       : InsetText(buf), type_(UNKNOWN_INFO), name_(),
-         mouse_hover_(false)
+NameTranslator const initTranslator()
 {
-       setAutoBreakRows(true);
-       setDrawFrame(true);
-       setInfo(name);
-}
+       NameTranslator translator(InsetInfo::UNKNOWN_INFO, "unknown");
+
+       translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
+       translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
+       translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
+       translator.addPair(InsetInfo::PACKAGE_INFO, "package");
+       translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
+       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;
+}
 
-Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
+/// The translator between the information type enum and corresponding string.
+NameTranslator const & nameTranslator()
 {
-       cur.push(*this);
-       return InsetText::editXY(cur, x, y);
+       static NameTranslator const translator = initTranslator();
+       return translator;
 }
 
+} // namespace
 
-void InsetInfo::draw(PainterInfo & pi, int x, int y) const
-{
-       InsetText::draw(pi, x, y); 
-}
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetInfo
+//
+/////////////////////////////////////////////////////////////////////////
 
 
-string InsetInfo::infoType() const
+
+InsetInfo::InsetInfo(Buffer * buf, string const & name)
+       : InsetCollapsible(buf), initialized_(false), 
+         type_(UNKNOWN_INFO), name_()
 {
-       return nameTranslator().find(type_);
+       setInfo(name);
+       status_ = Collapsed;
 }
 
 
-docstring InsetInfo::toolTip(BufferView const &, int, int) const
+Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
 {
-       odocstringstream os;
-       os << _("Information regarding ")
-          << _(nameTranslator().find(type_))
-          << " " << from_utf8(name_);
-       return os.str();
+       // do not allow the cursor to be set in this Inset
+       return Inset::editXY(cur, x, y);
 }
 
-namespace {
 
-Translator<InsetInfo::info_type, string> const initTranslator()
-{      
-       Translator<InsetInfo::info_type, string> 
-               translator(InsetInfo::UNKNOWN_INFO, "unknown");
+string InsetInfo::infoType() const
+{
+       return nameTranslator().find(type_);
+}
 
-       translator.addPair(InsetInfo::SHORTCUTS_INFO, "shortcuts");
-       translator.addPair(InsetInfo::SHORTCUT_INFO, "shortcut");
-       translator.addPair(InsetInfo::LYXRC_INFO, "lyxrc");
-       translator.addPair(InsetInfo::PACKAGE_INFO, "package");
-       translator.addPair(InsetInfo::TEXTCLASS_INFO, "textclass");
-       translator.addPair(InsetInfo::MENU_INFO, "menu");
-       translator.addPair(InsetInfo::ICON_INFO, "icon");
-       translator.addPair(InsetInfo::BUFFER_INFO, "buffer");
 
-       return translator;
+docstring InsetInfo::layoutName() const
+{
+       return from_ascii("Info:" + infoType());
 }
 
-} // namespace anon
 
-Translator<InsetInfo::info_type, string> 
-       const & InsetInfo::nameTranslator() const
+docstring InsetInfo::toolTip(BufferView const &, int, int) const
 {
-       static Translator<info_type, string> const translator = initTranslator();
-       return translator;
+       return bformat(_("Information regarding %1$s '%2$s'"),
+                       _(infoType()), from_utf8(name_));
 }
 
-       
 
 void InsetInfo::read(Lexer & lex)
 {
@@ -125,55 +137,74 @@ void InsetInfo::read(Lexer & lex)
                        token = lex.getString();
                        type_ = nameTranslator().find(token);
                } else if (token == "arg") {
-                       lex.next();
+                       lex.next(true);
                        name_ = lex.getString();
                } else if (token == "\\end_inset")
                        break;
-       }       
+       }
        if (token != "\\end_inset") {
                lex.printError("Missing \\end_inset at this point");
                throw ExceptionMessage(WarningException,
                        _("Missing \\end_inset at this point."),
                        from_utf8(token));
        }
-       updateInfo();
 }
 
 
 void InsetInfo::write(ostream & os) const
 {
-       os << "Info\ntype  \"" << nameTranslator().find(type_)
-          << "\"\narg   \"" << name_ << '\"';
+       os << "Info\ntype  \"" << infoType()
+          << "\"\narg   " << Lexer::quoteString(name_);
 }
 
 
-bool InsetInfo::validate(docstring const & arg) const
+bool InsetInfo::validateModifyArgument(docstring const & arg) const
 {
        string type;
-       string name;
+       string const name = trim(split(to_utf8(arg), type, ' '));
 
-       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";
+               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;
 }
 
@@ -188,47 +219,53 @@ 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 InsetText::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
 
-       case LFUN_INSET_MODIFY:
+       case LFUN_INSET_DIALOG_UPDATE:
+       case LFUN_INSET_COPY_AS:
                flag.setEnabled(true);
-               break;
+               return true;
+
+       case LFUN_INSET_MODIFY:
+               if (validateModifyArgument(cmd.argument())) {
+                       flag.setEnabled(true);
+                       return true;
+               }
+               //fall through
 
        default:
                return false;
        }
-       return true;
 }
 
 
 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:
-               InsetText::doDispatch(cur, cmd);
-               break;
-
+       switch (cmd.action()) {
        case LFUN_INSET_MODIFY:
+               cur.recordUndo();
                setInfo(to_utf8(cmd.argument()));
-               cur.pos() = 0;
+               initialized_ = false;
+               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;
        }
 }
@@ -242,37 +279,39 @@ void InsetInfo::setInfo(string const & name)
        string type;
        name_ = trim(split(name, type, ' '));
        type_ = nameTranslator().find(type);
-       updateInfo();
 }
 
 
 void InsetInfo::error(string const & err)
 {
-       InsetText::setText(bformat(_(err), from_utf8(name_)), buffer().params().getFont(),
-               false);
+       setText(bformat(_(err), from_utf8(name_)),
+               Font(inherit_font, buffer().params().language), false);
 }
 
 
 void InsetInfo::setText(docstring const & str)
 {
-       InsetText::setText(str, buffer().params().getFont(), false);
+       setText(str, Font(inherit_font, buffer().params().language), false);
 }
 
 
-void InsetInfo::updateInfo()
-{
-       InsetText::clear();
-
-       BufferParams const & bp = buffer().params();    
+void InsetInfo::updateBuffer(ParIterator const & it, UpdateType utype) {
+       BufferParams const & bp = buffer().params();
 
        switch (type_) {
        case UNKNOWN_INFO:
                error("Unknown Info: %1$s");
+               initialized_ = false;
                break;
        case SHORTCUT_INFO:
        case SHORTCUTS_INFO: {
-               FuncRequest func = lyxaction.lookupFunc(name_);
-               if (func.action == LFUN_UNKNOWN_ACTION) {
+               // only need to do this once.
+               if (initialized_)
+                       break;
+               // and we will not keep trying if we fail
+               initialized_ = true;
+               FuncRequest const func = lyxaction.lookupFunc(name_);
+               if (func.action() == LFUN_UNKNOWN_ACTION) {
                        error("Unknown action %1$s");
                        break;
                }
@@ -283,17 +322,37 @@ void InsetInfo::updateInfo()
                        break;
                }
                if (type_ == SHORTCUT_INFO)
-                       setText(bindings.rbegin()->print(KeySequence::ForGui));
+                       setText(bindings.begin()->print(KeySequence::Portable));
                else
-                       setText(theTopLevelKeymap().printBindings(func));
+                       setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
                break;
        }
        case LYXRC_INFO: {
+               // this information could actually change, if the preferences are changed,
+               // so we will recalculate each time through.
                ostringstream oss;
+               if (name_.empty()) {
+                       setText(_("undefined"));
+                       break;
+               }
+               // FIXME this uses the serialization mechanism to get the info
+               // we want, which i guess works but is a bit strange.
                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, "\"");
@@ -301,84 +360,187 @@ void InsetInfo::updateInfo()
                break;
        }
        case PACKAGE_INFO:
+               // only need to do this once.
+               if (initialized_)
+                       break;
                // check in packages.lst
                setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
+               initialized_ = true;
                break;
+
        case TEXTCLASS_INFO: {
+               // only need to do this once.
+               if (initialized_)
+                       break;
                // 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"));
+               initialized_ = true;
                break;
        }
        case MENU_INFO: {
+               // only need to do this once.
+               if (initialized_)
+                       break;
+               // and we will not keep trying if we fail
+               initialized_ = true;
                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;
                }
-               // if find, return its path.
-               InsetText::clear();
-               Paragraph & info = paragraphs().front();
-               unsigned int i = 0;
-               while (!names.empty()) {
+               // if found, return its path.
+               clear();
+               Paragraph & par = paragraphs().front();
+               Font const f(inherit_font, buffer().params().language);
+               //Font fu = f;
+               //fu.fontInfo().setUnderbar(FONT_ON);
+               for (docstring const & name : names) {
                        // do not insert > for the top level menu item
-                       if (i != 0)
-                               info.insertInset(0, new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
-                                       Change(Change::UNCHANGED));
-                       for (i = 0; i != names.back().length(); ++i)
-                               info.insertChar(i, names.back()[i], bp.getFont(), false);
-                       names.pop_back();
+                       if (&name != &names.front())
+                               par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
+                                               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 (char_type c : name)
+                               par.insertChar(par.size(), c, f, Change(Change::UNCHANGED));
                }
                break;
        }
        case ICON_INFO: {
+               // only need to do this once.
+               if (initialized_)
+                       break;
+               // and we will not keep trying if we fail
+               initialized_ = true;
                FuncRequest func = lyxaction.lookupFunc(name_);
-               docstring icon_name = theApp()->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.
+               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;
-               InsetGraphics * inset = new InsetGraphics(buffer());
+               igp.lyxscale = percent_scale;
+               igp.scale = string();
+               igp.width = Length(1, Length::EM);
                inset->setParams(igp);
-               paragraphs().front().insertInset(0, inset, Change(Change::UNCHANGED));
+               clear();
+               Font const f(inherit_font, buffer().params().language);
+               paragraphs().front().insertInset(0, inset, f,
+                                                Change(Change::UNCHANGED));
                break;
        }
        case BUFFER_INFO: {
-               if (name_ == "name")
+               // this could all change, so we will recalculate each time
+               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()));
+                       break;
+               }
+
+               ////////////////////////////////////////////////////////////////
+               // everything that follows is for version control.
+               // nothing that isn't version control should go below this line.
+               
+               // this information could change, in principle, so we will 
+               // recalculate each time through
+               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:
+               // only need to do this once.
+               if (initialized_)
+                       break;
+               if (name_ == "version")
+                       setText(from_ascii(lyx_version));
+               initialized_ = true;
+               break;
        }
-       // remove indent
-       paragraphs().begin()->params().noindent(true);
+       InsetCollapsible::updateBuffer(it, utype);
 }
 
 
-bool InsetInfo::setMouseHover(bool mouse_hover)
+string InsetInfo::contextMenu(BufferView const &, int, int) const
 {
-       mouse_hover_ = mouse_hover;
-       return true;
+       //FIXME: We override the implementation of InsetCollapsible,
+       //because this inset is not a collapsible inset.
+       return contextMenuName();
 }
 
 
-docstring InsetInfo::contextMenu(BufferView const &, int, int) const
+string InsetInfo::contextMenuName() const
 {
-       return from_ascii("context-info");
+       return "context-info";
 }
 
+
 } // namespace lyx