]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInfo.cpp
Connect to InsetInfo
[lyx.git] / src / insets / InsetInfo.cpp
index 2218ef660d50bd5435d59f41adbe33ad4f0c5f9d..0df2fd59411f9cf6b4f4d81cc33cede5b95870e4 100644 (file)
 
 #include "InsetInfo.h"
 
-#include <sstream>
-#include <stack>
-
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "FuncRequest.h"
+#include "FuncStatus.h"
+#include "InsetGraphics.h"
 #include "InsetSpecialChar.h"
 #include "KeyMap.h"
 #include "LaTeXFeatures.h"
+#include "LayoutFile.h"
 #include "LyXAction.h"
 #include "LyXRC.h"
+#include "LyXVC.h"
 #include "Lexer.h"
-#include "MenuBackend.h"
 #include "MetricsInfo.h"
 #include "ParagraphParameters.h"
-#include "TextClassList.h"
 
 #include "frontends/Application.h"
 
 #include "support/debug.h"
 #include "support/docstream.h"
+#include "support/docstring_list.h"
+#include "support/ExceptionMessage.h"
 #include "support/FileName.h"
+#include "support/filetools.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
-#include "support/ExceptionMessage.h"
+
+#include <sstream>
 
 using namespace std;
 using namespace lyx::support;
 
 namespace lyx {
 
+namespace {
 
-InsetInfo::InsetInfo(BufferParams const & bp, string const & name) 
-       : InsetText(bp), type_(UNKNOWN_INFO), name_(),
-         mouse_hover_(false)
+typedef Translator<InsetInfo::info_type, string> NameTranslator;
+
+NameTranslator const initTranslator()
+{      
+       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");
+
+       return translator;
+}
+
+/// The translator between the information type enum and corresponding string.
+NameTranslator const & nameTranslator()
 {
-       setAutoBreakRows(true);
-       setDrawFrame(true);
-       setInfo(name);
+       static NameTranslator const translator = initTranslator();
+       return translator;
 }
 
+} // namespace anon
+
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetInfo
+//
+/////////////////////////////////////////////////////////////////////////
 
-Inset * InsetInfo::editXY(Cursor &, int, int)
+
+       
+InsetInfo::InsetInfo(Buffer * buf, string const & name) 
+       : InsetCollapsable(buf), type_(UNKNOWN_INFO), name_()
 {
-       return this;
+       setAutoBreakRows(true);
+       setInfo(name);
+       status_ = Collapsed;
 }
 
 
-void InsetInfo::draw(PainterInfo & pi, int x, int y) const
+Inset * InsetInfo::editXY(Cursor & cur, int x, int y)
 {
-       InsetText::draw(pi, x, y); 
-       if (mouse_hover_) {
-               odocstringstream os;
-               os << _("Information regarding ")
-                  <<_(nameTranslator().find(type_))
-                  << _(" ") << from_utf8(name_);
-               pi.base.bv->message(os.str());
-       }
+       // do not allow the cursor to be set in this Inset
+       return Inset::editXY(cur, x, y);
 }
 
 
-namespace {
+string InsetInfo::infoType() const
+{
+       return nameTranslator().find(type_);
+}
 
-Translator<InsetInfo::info_type, string> const initTranslator()
-{      
-       Translator<InsetInfo::info_type, string> translator(InsetInfo::UNKNOWN_INFO, "unknown");
 
-       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::BUFFER_INFO, "buffer");
-
-       return translator;
+docstring InsetInfo::name() 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(Buffer const & buf, Lexer & lex)
+void InsetInfo::read(Lexer & lex)
 {
        string token;
        while (lex.isOK()) {
@@ -111,7 +129,7 @@ void InsetInfo::read(Buffer const & buf, 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;
@@ -122,33 +140,98 @@ void InsetInfo::read(Buffer const & buf, Lexer & lex)
                        _("Missing \\end_inset at this point."),
                        from_utf8(token));
        }
-       updateInfo(buf);
+       updateInfo();
 }
 
 
-void InsetInfo::write(Buffer const &, ostream & os) const
+void InsetInfo::write(ostream & os) const
 {
-       os << "Info\ntype  \""
-          << nameTranslator().find(type_)
-          << "\"\narg   \"" << name_ << '\"';
+       os << "Info\ntype  \"" << infoType() 
+          << "\"\narg   " << Lexer::quoteString(name_);
+}
+
+
+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: {
+               FuncRequest func = lyxaction.lookupFunc(name);
+               return func.action != LFUN_UNKNOWN_ACTION;
+       }
+       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 == "file-revision";
+       }
+       return false;
+}
+
+
+bool InsetInfo::showInsetDialog(BufferView * bv) const
+{
+       bv->showDialog("info");
+       return true;
+}
+
+
+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:
+               return InsetCollapsable::getStatus(cur, cmd, flag);
+
+       case LFUN_INSET_DIALOG_UPDATE:
+       case LFUN_INSET_MODIFY:
+       case LFUN_INSET_SETTINGS:
+               flag.setEnabled(true);
+               return true;
+
+       default:
+               return false;
+       }
 }
 
 
 void InsetInfo::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       // FIXME: we should allow selection, copy etc...
+       // 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:
-               // do not dispatch to InsetText
-               cur.dispatched();
+       case LFUN_COPY:
+       case LFUN_INSET_SETTINGS:
+               InsetCollapsable::doDispatch(cur, cmd);
+               break;
+
+       case LFUN_INSET_MODIFY:
+               setInfo(to_utf8(cmd.argument()));
+               cur.pos() = 0;
                break;
 
        default:
-               InsetText::doDispatch(cur, cmd);
                break;
        }
 }
@@ -162,25 +245,48 @@ void InsetInfo::setInfo(string const & name)
        string type;
        name_ = trim(split(name, type, ' '));
        type_ = nameTranslator().find(type);
+       updateInfo();
+}
+
+
+void InsetInfo::error(string const & err)
+{
+       setText(bformat(_(err), from_utf8(name_)), 
+               Font(inherit_font, buffer().params().language), false);
 }
 
 
-void InsetInfo::updateInfo(Buffer const & buf)
+void InsetInfo::setText(docstring const & str)
 {
-       InsetText::clear();
+       setText(str, Font(inherit_font, buffer().params().language), false);
+}
+
 
-       BufferParams const & bp = buf.params(); 
+void InsetInfo::updateInfo()
+{
+       BufferParams const & bp = buffer().params();    
 
        switch (type_) {
        case UNKNOWN_INFO:
-               setText(_("Unknown Info: ") + from_utf8(name_),
-                       bp.getFont(), false);
+               error("Unknown Info: %1$s");
                break;
-       case SHORTCUT_INFO: {
+       case SHORTCUT_INFO:
+       case SHORTCUTS_INFO: {
                FuncRequest func = lyxaction.lookupFunc(name_);
-               if (func.action != LFUN_UNKNOWN_ACTION)
-                       setText(theTopLevelKeymap().printBindings(func),
-                               bp.getFont(), false);
+               if (func.action == LFUN_UNKNOWN_ACTION) {
+                       error("Unknown action %1$s");
+                       break;
+               }
+               KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func);
+               if (bindings.empty()) {
+                       // It is impropriate to use error() for undefined shortcut
+                       setText(_("undefined"));
+                       break;
+               }
+               if (type_ == SHORTCUT_INFO)
+                       setText(bindings.begin()->print(KeySequence::Portable));
+               else
+                       setText(theTopLevelKeymap().printBindings(func, KeySequence::Portable));
                break;
        }
        case LYXRC_INFO: {
@@ -192,71 +298,96 @@ void InsetInfo::updateInfo(Buffer const & buf)
                // remove \n and ""
                result = rtrim(result, "\n");
                result = trim(result, "\"");
-               setText(from_utf8(result), bp.getFont(), false);
+               setText(from_utf8(result));
                break;
        }
        case PACKAGE_INFO:
                // check in packages.lst
-               setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"),
-                       bp.getFont(), false);
+               setText(LaTeXFeatures::isAvailable(name_) ? _("yes") : _("no"));
                break;
        case TEXTCLASS_INFO: {
                // name_ is the class name
-               pair<bool, lyx::textclass_type> pp =
-                       textclasslist.numberOfClass(name_);
-               setText(pp.first ? _("yes") : _("no"),
-                       bp.getFont(), false);
+               setText(LayoutFileList::get().haveClass(name_) ? _("yes") : _("no"));
                break;
        }
        case MENU_INFO: {
-               stack<docstring> names;
+               docstring_list names;
                FuncRequest func = lyxaction.lookupFunc(name_);
                if (func.action == LFUN_UNKNOWN_ACTION) {
-                       setText(_("No menu entry for "), bp.getFont(), false);
+                       error("Unknown action %1$s");
                        break;
                }
                // iterate through the menubackend to find it
-               Menu menu = theApp()->menuBackend().getMenubar();
-               if (!menu.searchFunc(func, names)) {
-                       setText(_("No menu entry for "), bp.getFont(), false);
+               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);
+               docstring_list::const_iterator beg = names.begin();
+               docstring_list::const_iterator end = names.end();
+               for (docstring_list::const_iterator it = beg ; 
+                    it != end ; ++it) {
                        // 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.top().length(); ++i)
-                               info.insertChar(i, names.top()[i], bp.getFont(), false);
-                       names.pop();
+                       if (it != beg)
+                               par.insertInset(par.size(), new InsetSpecialChar(InsetSpecialChar::MENU_SEPARATOR),
+                                               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], 
+                                              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
+               // going through FileName. The code below won't work
+               // if the icon is embedded in the executable through
+               // the Qt resource system.
+               FileName file(to_utf8(icon_name));
+               if (!file.exists())
+                       break;
+               InsetGraphics * inset = new InsetGraphics(buffer_);
+               InsetGraphicsParams igp;
+               igp.filename = file;
+               inset->setParams(igp);
+               clear();
+               paragraphs().front().insertInset(0, inset, 
+                                                Change(Change::UNCHANGED));
+               break;
+       }
        case BUFFER_INFO: {
                if (name_ == "name")
-                       setText(from_utf8(buf.fileName().onlyFileName()), bp.getFont(), false);
+                       setText(from_utf8(buffer().fileName().onlyFileName()));
                else if (name_ == "path")
-                       setText(from_utf8(buf.filePath()), bp.getFont(), false);
+                       setText(from_utf8(buffer().filePath()));
                else if (name_ == "class")
-                       setText(from_utf8(bp.getTextClass().name()), bp.getFont(), false);
+                       setText(from_utf8(bp.documentClass().name()));
+               else if (name_ == "file-revision" && buffer().lyxvc().inUse() &&
+                        !buffer().lyxvc().revisionInfo(LyXVC::File).empty())
+                       setText(from_utf8(buffer().lyxvc().revisionInfo(LyXVC::File)));
                else
-                       setText(_("Unknown buffer info"), bp.getFont(), false);
+                       setText(_("Unknown buffer info"));
                break;
        }
        }
-       // remove indent
-       paragraphs().begin()->params().noindent(true);
 }
 
 
-bool InsetInfo::setMouseHover(bool mouse_hover)
+docstring InsetInfo::contextMenu(BufferView const &, int, int) const
 {
-       mouse_hover_ = mouse_hover;
-       return true;
+       return from_ascii("context-info");
 }
 
+
 } // namespace lyx