]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNote.cpp
Fix bug #6315: counters in insets that don't produce output have ghost values.
[lyx.git] / src / insets / InsetNote.cpp
index 28c804818493b91ab069cdcd72c6692bcb013a86..d3c1b1e2b49938e7bf4fc4dab8d526502e1e07a2 100644 (file)
@@ -5,7 +5,7 @@
  *
  * \author Angus Leeming
  * \author Martin Vermeer
- * \author Jürgen Spitzmüller
+ * \author Jürgen Spitzmüller
  *
  * Full author contact details are available in file CREDITS.
  */
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "BufferView.h"
-<<<<<<< .mine
 #include "BufferParams.h"
-=======
 #include "Counters.h"
->>>>>>> .r19497
 #include "Cursor.h"
-#include "debug.h"
 #include "DispatchResult.h"
 #include "Exporter.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "gettext.h"
+#include "InsetIterator.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
-#include "MetricsInfo.h"
+#include "LyXRC.h"
 #include "OutputParams.h"
+#include "ParIterator.h"
+#include "TextClass.h"
+#include "TocBackend.h"
 
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
 #include "support/Translator.h"
 
+#include "frontends/Application.h"
+
 #include <algorithm>
 #include <sstream>
 
+using namespace std;
 
 namespace lyx {
 
-using std::string;
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-
-
 namespace {
 
-typedef Translator<std::string, InsetNoteParams::Type> NoteTranslator;
+typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
 typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
 
 NoteTranslator const init_notetranslator()
@@ -59,19 +57,15 @@ NoteTranslator const init_notetranslator()
        NoteTranslator translator("Note", InsetNoteParams::Note);
        translator.addPair("Comment", InsetNoteParams::Comment);
        translator.addPair("Greyedout", InsetNoteParams::Greyedout);
-       translator.addPair("Framed", InsetNoteParams::Framed);
-       translator.addPair("Shaded", InsetNoteParams::Shaded);
        return translator;
 }
 
 
 NoteTranslatorLoc const init_notetranslator_loc()
 {
-       NoteTranslatorLoc translator(_("Note"), InsetNoteParams::Note);
+       NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
        translator.addPair(_("Comment"), InsetNoteParams::Comment);
        translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
-       translator.addPair(_("Framed"), InsetNoteParams::Framed);
-       translator.addPair(_("Shaded"), InsetNoteParams::Shaded);
        return translator;
 }
 
@@ -115,71 +109,48 @@ void InsetNoteParams::read(Lexer & lex)
 }
 
 
-InsetNote::InsetNote(BufferParams const & bp, string const & label)
-       : InsetCollapsable(bp)
-{
-       params_.type = notetranslator().find(label);
-       setLayout(bp);
-       setButtonLabel();
-}
-
+/////////////////////////////////////////////////////////////////////
+//
+// InsetNote
+//
+/////////////////////////////////////////////////////////////////////
 
-InsetNote::InsetNote(InsetNote const & in)
-       : InsetCollapsable(in), params_(in.params_)
+InsetNote::InsetNote(Buffer * buf, string const & label)
+       : InsetCollapsable(buf)
 {
-       setButtonLabel();
+       params_.type = notetranslator().find(label);
 }
 
 
 InsetNote::~InsetNote()
 {
-       InsetNoteMailer(*this).hideDialog();
-}
-
-
-auto_ptr<Inset> InsetNote::doClone() const
-{
-       return auto_ptr<Inset>(new InsetNote(*this));
-}
-
-
-docstring const InsetNote::editMessage() const
-{
-       return _("Opened Note Inset");
+       hideDialogs("note", this);
 }
 
 
 docstring InsetNote::name() const 
 {
-       return from_ascii(string("Note") + string(":") + string(notetranslator().find(params_.type)));
+       return from_ascii("Note:" + notetranslator().find(params_.type));
 }
 
 
 Inset::DisplayType InsetNote::display() const
 {
-       switch (params_.type) {
-       case InsetNoteParams::Framed:
-       case InsetNoteParams::Shaded:
-               return AlignLeft;
-       default:
-               return Inline;
-       }
+       return Inline;
 }
 
 
-void InsetNote::write(Buffer const & buf, ostream & os) const
+void InsetNote::write(ostream & os) const
 {
        params_.write(os);
-       InsetCollapsable::write(buf, os);
+       InsetCollapsable::write(os);
 }
 
 
-void InsetNote::read(Buffer const & buf, Lexer & lex)
+void InsetNote::read(Lexer & lex)
 {
        params_.read(lex);
-       InsetCollapsable::read(buf, lex);
-       setLayout(buf.params());
-       setButtonLabel();
+       InsetCollapsable::read(lex);
 }
 
 
@@ -187,61 +158,32 @@ void InsetNote::setButtonLabel()
 {
        docstring const label = notetranslator_loc().find(params_.type);
        setLabel(label);
-       setLabelFont(layout_.labelfont);
-}
-
-
-Color_color InsetNote::backgroundColor() const
-{
-       Color_color c;
-       switch (params_.type) {
-       case InsetNoteParams::Note:
-               c = Color::notebg;
-               break;
-       case InsetNoteParams::Comment:
-               c = Color::commentbg;
-               break;
-       case InsetNoteParams::Greyedout:
-               c = Color::greyedoutbg;
-               break;
-       case InsetNoteParams::Framed:
-               c = Color::greyedoutbg;
-               break;
-       case InsetNoteParams::Shaded:
-               c = Color::shadedbg;
-               break;
-       }
-       return c;
 }
 
 
 bool InsetNote::showInsetDialog(BufferView * bv) const
 {
-       InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
+       bv->showDialog("note", params2string(params()),
+               const_cast<InsetNote *>(this));
        return true;
 }
 
 
 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY:
-               InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
-               // get a bp from cur:
-               setLayout(cur.buffer().params());
+               cur.recordUndoInset(ATOMIC_UNDO, this);
+               string2params(to_utf8(cmd.argument()), params_);
                setButtonLabel();
+               // what we really want here is a TOC update, but that means
+               // a full buffer update
+               cur.forceBufferUpdate();
                break;
 
        case LFUN_INSET_DIALOG_UPDATE:
-               InsetNoteMailer(*this).updateDialog(&cur.bv());
-               break;
-
-       case LFUN_MOUSE_RELEASE:
-               if (cmd.button() == mouse_button::button3 && hitButton(cmd))
-                       InsetNoteMailer(*this).showDialog(&cur.bv());
-               else
-                       InsetCollapsable::doDispatch(cur, cmd);
+               cur.bv().updateDialog("note", params2string(params()));
                break;
 
        default:
@@ -254,11 +196,21 @@ void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
                FuncStatus & flag) const
 {
-       switch (cmd.action) {
+       switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY:
+               // disallow comment and greyed out in commands
+               flag.setEnabled(!cur.paragraph().layout().isCommand() ||
+                               cmd.getArg(2) == "Note");
+               if (cmd.getArg(0) == "note") {
+                       InsetNoteParams params;
+                       string2params(to_utf8(cmd.argument()), params);
+                       flag.setOnOff(params_.type == params.type);
+               }
+               return true;
+
        case LFUN_INSET_DIALOG_UPDATE:
-               flag.enabled(true);
+               flag.setEnabled(true);
                return true;
 
        default:
@@ -266,39 +218,46 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
        }
 }
 
-void InsetNote::updateLabels(Buffer const & buf, ParIterator const & it)
+
+void InsetNote::addToToc(DocIterator const & cpit)
 {
-       TextClass const & tclass = buf.params().getTextClass();
-       Counters savecnt = tclass.counters();
-       InsetCollapsable::updateLabels(buf, it);
-       tclass.counters() = savecnt;
+       DocIterator pit = cpit;
+       pit.push_back(CursorSlice(*this));
+
+       Toc & toc = buffer().tocBackend().toc("note");
+       docstring str;
+       str = notetranslator_loc().find(params_.type) + from_ascii(": ")
+               + text().getPar(0).asString();
+       toc.push_back(TocItem(pit, 0, str, toolTipText()));
+       // Proceed with the rest of the inset.
+       InsetCollapsable::addToToc(cpit);
 }
 
 
-int InsetNote::latex(Buffer const & buf, odocstream & os,
-                    OutputParams const & runparams_in) const
+bool InsetNote::isMacroScope() const
+{
+       // LyX note has no latex output
+       if (params_.type == InsetNoteParams::Note)
+               return true;
+
+       return InsetCollapsable::isMacroScope();
+}
+
+
+int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
 {
        if (params_.type == InsetNoteParams::Note)
                return 0;
 
        OutputParams runparams(runparams_in);
-       string type;
        if (params_.type == InsetNoteParams::Comment) {
-               type = "comment";
                runparams.inComment = true;
                // Ignore files that are exported inside a comment
                runparams.exportdata.reset(new ExportData);
-       } else if (params_.type == InsetNoteParams::Greyedout)
-               type = "lyxgreyedout";
-       else if (params_.type == InsetNoteParams::Framed)
-               type = "framed";
-       else if (params_.type == InsetNoteParams::Shaded)
-               type = "shaded";
+       } 
 
        odocstringstream ss;
-       ss << "%\n\\begin{" << from_ascii(type) << "}\n";
-       InsetText::latex(buf, ss, runparams);
-       ss << "\n\\end{" << from_ascii(type) << "}\n";
+       InsetCollapsable::latex(ss, runparams);
        // the space after the comment in 'a[comment] b' will be eaten by the
        // comment environment since the space before b is ignored with the
        // following latex output:
@@ -317,11 +276,11 @@ int InsetNote::latex(Buffer const & buf, odocstream & os,
        os << str;
        runparams_in.encoding = runparams.encoding;
        // Return how many newlines we issued.
-       return int(std::count(str.begin(), str.end(), '\n'));
+       return int(count(str.begin(), str.end(), '\n'));
 }
 
 
-int InsetNote::plaintext(Buffer const & buf, odocstream & os,
+int InsetNote::plaintext(odocstream & os,
                         OutputParams const & runparams_in) const
 {
        if (params_.type == InsetNoteParams::Note)
@@ -333,16 +292,15 @@ int InsetNote::plaintext(Buffer const & buf, odocstream & os,
                // Ignore files that are exported inside a comment
                runparams.exportdata.reset(new ExportData);
        }
-       os << '[' << buf.B_("note") << ":\n";
-       InsetText::plaintext(buf, os, runparams);
+       os << '[' << buffer().B_("note") << ":\n";
+       InsetText::plaintext(os, runparams);
        os << "\n]";
 
        return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 }
 
 
-int InsetNote::docbook(Buffer const & buf, odocstream & os,
-                      OutputParams const & runparams_in) const
+int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
 {
        if (params_.type == InsetNoteParams::Note)
                return 0;
@@ -355,7 +313,7 @@ int InsetNote::docbook(Buffer const & buf, odocstream & os,
                runparams.exportdata.reset(new ExportData);
        }
 
-       int const n = InsetText::docbook(buf, os, runparams);
+       int const n = InsetText::docbook(os, runparams);
 
        if (params_.type == InsetNoteParams::Comment)
                os << "\n</remark>\n";
@@ -366,49 +324,53 @@ int InsetNote::docbook(Buffer const & buf, odocstream & os,
 }
 
 
+docstring InsetNote::xhtml(XHTMLStream & xs, OutputParams const & rp) const
+{
+       if (params_.type == InsetNoteParams::Note)
+               return docstring();
+
+       return InsetCollapsable::xhtml(xs, rp);
+}
+
+
 void InsetNote::validate(LaTeXFeatures & features) const
 {
-       if (params_.type == InsetNoteParams::Comment)
+       switch (params_.type) {
+       case InsetNoteParams::Comment:
                features.require("verbatim");
-       if (params_.type == InsetNoteParams::Greyedout) {
+               break;
+       case InsetNoteParams::Greyedout:
                features.require("color");
                features.require("lyxgreyedout");
+               InsetCollapsable::validate(features);
+               break;
+       case InsetNoteParams::Note:
+               break;
        }
-       if (params_.type == InsetNoteParams::Shaded) {
-               features.require("color");
-               features.require("framed");
-       }
-       if (params_.type == InsetNoteParams::Framed)
-               features.require("framed");
-       InsetText::validate(features);
 }
 
 
+docstring InsetNote::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-note");
+}
 
-string const InsetNoteMailer::name_("note");
-
-InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
-       : inset_(inset)
-{}
-
-
-string const InsetNoteMailer::inset2string(Buffer const &) const
+bool InsetNote::allowSpellCheck() const
 {
-       return params2string(inset_.params());
+       return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
 }
 
 
-string const InsetNoteMailer::params2string(InsetNoteParams const & params)
+string InsetNote::params2string(InsetNoteParams const & params)
 {
        ostringstream data;
-       data << name_ << ' ';
+       data << "note" << ' ';
        params.write(data);
        return data.str();
 }
 
 
-void InsetNoteMailer::string2params(string const & in,
-                                   InsetNoteParams & params)
+void InsetNote::string2params(string const & in, InsetNoteParams & params)
 {
        params = InsetNoteParams();
 
@@ -416,20 +378,16 @@ void InsetNoteMailer::string2params(string const & in,
                return;
 
        istringstream data(in);
-       Lexer lex(0,0);
+       Lexer lex;
        lex.setStream(data);
-
-       string name;
-       lex >> name;
-       if (!lex || name != name_)
-               return print_mailer_error("InsetNoteMailer", in, 1, name_);
-
-       // This is part of the inset proper that is usually swallowed
-       // by Text::readInset
-       string id;
-       lex >> id;
-       if (!lex || id != "Note")
-               return print_mailer_error("InsetBoxMailer", in, 2, "Note");
+       lex.setContext("InsetNote::string2params");
+       lex >> "note";
+       // There are cases, such as when we are called via getStatus() from
+       // Dialog::canApply(), where we are just called with "note" rather
+       // than a full "note Note TYPE".
+       if (!lex.isOK())
+               return;
+       lex >> "Note";
 
        params.read(lex);
 }