]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetLabel.cpp
Move Cursor.h from Clipboard.h
[lyx.git] / src / insets / InsetLabel.cpp
index c483f9488374731b21e4bf4e36c0bd1590290011..eeced084517b27d43b11552835fbfc6021f6d1fd 100644 (file)
@@ -18,6 +18,7 @@
 #include "Buffer.h"
 #include "BufferParams.h"
 #include "BufferView.h"
+#include "Cursor.h"
 #include "CutAndPaste.h"
 #include "DispatchResult.h"
 #include "FuncRequest.h"
@@ -25,9 +26,9 @@
 #include "InsetIterator.h"
 #include "Language.h"
 #include "LyX.h"
-#include "output_xhtml.h"
 #include "ParIterator.h"
-#include "sgml.h"
+#include "xml.h"
+#include "texstream.h"
 #include "Text.h"
 #include "TextClass.h"
 #include "TocBackend.h"
@@ -55,9 +56,11 @@ InsetLabel::InsetLabel(Buffer * buf, InsetCommandParams const & p)
 
 void InsetLabel::initView()
 {
-       // FIXME: This seems to be used only for inset creation so
-       // we probably just need to call updateLabel() here.
-       updateLabelAndRefs(getParam("name"));
+       // This seems to be used only for inset creation.
+       // Therefore we do not update refs here, since this would
+       // erroneously change refs from existing duplicate labels
+       // (#8141).
+       updateLabel(getParam("name"));
 }
 
 
@@ -65,11 +68,13 @@ void InsetLabel::uniqueLabel(docstring & label) const
 {
        docstring const new_label = label;
        int i = 1;
-       while (buffer().insetLabel(label)) {
+       bool ambiguous = false;
+       while (buffer().activeLabel(label)) {
                label = new_label + '-' + convert<docstring>(i);
                ++i;
+               ambiguous = true;
        }
-       if (label != new_label) {
+       if (ambiguous) {
                // Warn the user that the label has been changed to something else.
                frontend::Alert::warning(_("Label names must be unique!"),
                        bformat(_("The label %1$s already exists,\n"
@@ -78,10 +83,11 @@ void InsetLabel::uniqueLabel(docstring & label) const
 }
 
 
-void InsetLabel::updateLabel(docstring const & new_label)
+void InsetLabel::updateLabel(docstring const & new_label, bool const active)
 {
        docstring label = new_label;
-       uniqueLabel(label);
+       if (active)
+               uniqueLabel(label);
        setParam("name", label);
 }
 
@@ -95,29 +101,45 @@ void InsetLabel::updateLabelAndRefs(docstring const & new_label,
        if (label == old_label)
                return;
 
-       buffer().undo().beginUndoGroup();
+       // This handles undo groups automagically
+       UndoGroupHelper ugh(&buffer());
        if (cursor)
                cursor->recordUndo();
-       setParam("name", label);
+       if (buffer().masterParams().track_changes) {
+               // With change tracking, we insert a new label and
+               // delete the old one
+               InsetCommandParams p(LABEL_CODE, "label");
+               p["name"] = label;
+               string const data = InsetCommand::params2string(p);
+               lyx::dispatch(FuncRequest(LFUN_INSET_INSERT, data));
+               lyx::dispatch(FuncRequest(LFUN_CHAR_DELETE_FORWARD));
+       } else
+               setParam("name", label);
        updateReferences(old_label, label);
-       buffer().undo().endUndoGroup();
 }
 
 
 void InsetLabel::updateReferences(docstring const & old_label,
                docstring const & new_label)
 {
-       Buffer::References & refs = buffer().references(old_label);
-       Buffer::References::iterator it = refs.begin();
-       Buffer::References::iterator end = refs.end();
-       for (; it != end; ++it) {
-               buffer().undo().recordUndo(it->second);
-               if (it->first->lyxCode() == MATH_REF_CODE) {
-                       InsetMathRef * mi = it->first->asInsetMath()->asRefInset();
-                       mi->changeTarget(new_label);
-               } else {
-                       InsetCommand * ref = it->first->asInsetCommand();
-                       ref->setParam("reference", new_label);
+       UndoGroupHelper ugh(nullptr);
+       if (buffer().masterParams().track_changes) {
+               // With change tracking, we insert a new ref and
+               // delete the old one
+               lyx::dispatch(FuncRequest(LFUN_MASTER_BUFFER_FORALL,
+                                         "inset-forall Ref inset-modify ref changetarget "
+                                         + old_label + " " + new_label));
+       } else {
+               for (auto const & p: buffer().references(old_label)) {
+                       ugh.resetBuffer(p.second.buffer());
+                       CursorData(p.second).recordUndo();
+                       if (p.first->lyxCode() == MATH_REF_CODE) {
+                               InsetMathRef * mi = p.first->asInsetMath()->asRefInset();
+                               mi->changeTarget(new_label);
+                       } else {
+                               InsetCommand * ref = p.first->asInsetCommand();
+                               ref->setParam("reference", new_label);
+                       }
                }
        }
 }
@@ -139,20 +161,37 @@ docstring InsetLabel::screenLabel() const
 }
 
 
-void InsetLabel::updateBuffer(ParIterator const & par, UpdateType utype)
+void InsetLabel::updateBuffer(ParIterator const & par, UpdateType utype, bool const /*deleted*/)
 {
        docstring const & label = getParam("name");
-       if (buffer().insetLabel(label)) {
-               // Problem: We already have an InsetLabel with the same name!
+
+       // Check if this one is active (i.e., neither deleted with change-tracking
+       // nor in an inset that does not produce output, such as notes or inactive branches)
+       Paragraph const & para = par.paragraph();
+       bool active = !para.isDeleted(par.pos()) && para.inInset().producesOutput();
+       // If not, check whether we are in a deleted/non-outputting inset
+       if (active) {
+               for (size_type sl = 0 ; sl < par.depth() ; ++sl) {
+                       Paragraph const & outer_par = par[sl].paragraph();
+                       if (outer_par.isDeleted(par[sl].pos())
+                           || !outer_par.inInset().producesOutput()) {
+                               active = false;
+                               break;
+                       }
+               }
+       }
+
+       if (buffer().activeLabel(label) && active) {
+               // Problem: We already have an active InsetLabel with the same name!
                screen_label_ = _("DUPLICATE: ") + label;
                return;
        }
-       buffer().setInsetLabel(label, this);
+       buffer().setInsetLabel(label, this, active);
        screen_label_ = label;
 
        if (utype == OutputUpdate) {
                // save info on the active counter
-               Counters const & cnts = 
+               Counters const & cnts =
                        buffer().masterBuffer()->params().documentClass().counters();
                active_counter_ = cnts.currentCounter();
                Language const * lang = par->getParLanguage(buffer().params());
@@ -167,26 +206,32 @@ void InsetLabel::updateBuffer(ParIterator const & par, UpdateType utype)
 }
 
 
-void InsetLabel::addToToc(DocIterator const & cpit) const
+void InsetLabel::addToToc(DocIterator const & cpit, bool output_active,
+                         UpdateType, TocBackend & backend) const
 {
        docstring const & label = getParam("name");
-       Toc & toc = buffer().tocBackend().toc("label");
-       if (buffer().insetLabel(label) != this) {
-               toc.push_back(TocItem(cpit, 0, screen_label_));
-               return;
-       }
-       toc.push_back(TocItem(cpit, 0, screen_label_));
-       Buffer::References const & refs = buffer().references(label);
-       Buffer::References::const_iterator it = refs.begin();
-       Buffer::References::const_iterator end = refs.end();
-       for (; it != end; ++it) {
-               DocIterator const ref_pit(it->second);
-               if (it->first->lyxCode() == MATH_REF_CODE)
-                       toc.push_back(TocItem(ref_pit, 1,
-                               it->first->asInsetMath()->asRefInset()->screenLabel()));
-               else
-                       toc.push_back(TocItem(ref_pit, 1,
-                               static_cast<InsetRef *>(it->first)->screenLabel()));
+
+       // inactive labels get a cross mark
+       if (buffer().insetLabel(label, true) != this)
+               output_active = false;
+
+       // We put both  active and inactive labels to the outliner
+       shared_ptr<Toc> toc = backend.toc("label");
+       toc->push_back(TocItem(cpit, 0, screen_label_, output_active));
+       // The refs get assigned only to the active label. If no active one exists,
+       // assign the (BROKEN) refs to the first inactive one.
+       if (buffer().insetLabel(label, true) == this || !buffer().activeLabel(label)) {
+               for (auto const & p : buffer().references(label)) {
+                       DocIterator const ref_pit(p.second);
+                       if (p.first->lyxCode() == MATH_REF_CODE)
+                               toc->push_back(TocItem(ref_pit, 1,
+                                               p.first->asInsetMath()->asRefInset()->screenLabel(),
+                                               output_active));
+                       else
+                               toc->push_back(TocItem(ref_pit, 1,
+                                               static_cast<InsetRef *>(p.first)->getTOCString(),
+                                               static_cast<InsetRef *>(p.first)->outputActive()));
+               }
        }
 }
 
@@ -196,10 +241,19 @@ bool InsetLabel::getStatus(Cursor & cur, FuncRequest const & cmd,
 {
        bool enabled;
        switch (cmd.action()) {
-       case LFUN_LABEL_INSERT_AS_REF:
-       case LFUN_LABEL_COPY_AS_REF:
+       case LFUN_LABEL_INSERT_AS_REFERENCE:
+       case LFUN_LABEL_COPY_AS_REFERENCE:
                enabled = true;
                break;
+       case LFUN_INSET_MODIFY:
+               if (cmd.getArg(0) == "changetype") {
+                       // this is handled by InsetCommand,
+                       // but not by InsetLabel.
+                       enabled = false;
+                       break;
+               }
+               // no "changetype":
+               // fall through
        default:
                return InsetCommand::getStatus(cur, cmd, status);
        }
@@ -214,6 +268,12 @@ void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
        switch (cmd.action()) {
 
        case LFUN_INSET_MODIFY: {
+               // the only other option here is "changetype", and we
+               // do not have different types.
+               if (cmd.getArg(0) != "label") {
+                       cur.undispatched();
+                       return;
+               }
                InsetCommandParams p(LABEL_CODE);
                // FIXME UNICODE
                InsetCommand::string2params(to_utf8(cmd.argument()), p);
@@ -229,7 +289,7 @@ void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
        }
 
-       case LFUN_LABEL_COPY_AS_REF: {
+       case LFUN_LABEL_COPY_AS_REFERENCE: {
                InsetCommandParams p(REF_CODE, "ref");
                p["reference"] = getParam("name");
                cap::clearSelection();
@@ -237,7 +297,7 @@ void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
        }
 
-       case LFUN_LABEL_INSERT_AS_REF: {
+       case LFUN_LABEL_INSERT_AS_REFERENCE: {
                InsetCommandParams p(REF_CODE, "ref");
                p["reference"] = getParam("name");
                string const data = InsetCommand::params2string(p);
@@ -252,7 +312,41 @@ void InsetLabel::doDispatch(Cursor & cur, FuncRequest & cmd)
 }
 
 
-int InsetLabel::plaintext(odocstream & os, OutputParams const &) const
+void InsetLabel::latex(otexstream & os, OutputParams const & runparams_in) const
+{
+       OutputParams runparams = runparams_in;
+       docstring command = getCommand(runparams);
+       docstring const label = getParam("name");
+       if (buffer().params().output_changes
+           && buffer().activeLabel(label)
+           && buffer().insetLabel(label, true) != this) {
+               // this is a deleted label and we have a non-deleted with the same id
+               // rename it for output to prevent wrong references
+               docstring newlabel = label;
+               int i = 1;
+               while (buffer().insetLabel(newlabel)) {
+                       newlabel = label + "-DELETED-" + convert<docstring>(i);
+                       ++i;
+               }
+               command = subst(command, label, newlabel);
+       }
+       // In macros with moving arguments, such as \section,
+       // we store the label and output it after the macro (#2154)
+       if (runparams_in.postpone_fragile_stuff)
+               runparams_in.post_macro += command;
+       else {
+               // protect label in moving argument (#9404),
+               // but not in subfloat caption (#11950)
+               if (runparams.moving_arg
+                   && runparams.inFloat != OutputParams::SUBFLOAT)
+                       os << "\\protect";
+               os << command;
+       }
+}
+
+
+int InsetLabel::plaintext(odocstringstream & os,
+        OutputParams const &, size_t) const
 {
        docstring const str = getParam("name");
        os << '<' << str << '>';
@@ -260,24 +354,28 @@ int InsetLabel::plaintext(odocstream & os, OutputParams const &) const
 }
 
 
-int InsetLabel::docbook(odocstream & os, OutputParams const & runparams) const
+void InsetLabel::docbook(XMLStream & xs, OutputParams const & runparams) const
 {
-       os << "<!-- anchor id=\""
-          << sgml::cleanID(buffer(), runparams, getParam("name"))
-          << "\" -->";
-       return 0;
+       // Output an anchor only if it has not been processed before.
+       docstring id = getParam("name");
+       docstring cleaned_id = xml::cleanID(id);
+       if (runparams.docbook_anchors_to_ignore.find(id) == runparams.docbook_anchors_to_ignore.end() &&
+               runparams.docbook_anchors_to_ignore.find(cleaned_id) == runparams.docbook_anchors_to_ignore.end()) {
+               docstring attr = from_utf8("xml:id=\"") + cleaned_id + from_utf8("\"");
+               xs << xml::CompTag("anchor", to_utf8(attr));
+       }
 }
 
 
-docstring InsetLabel::xhtml(XHTMLStream & xs, OutputParams const &) const
+docstring InsetLabel::xhtml(XMLStream & xs, OutputParams const &) const
 {
        // FIXME XHTML
        // Unfortunately, the name attribute has been deprecated, so we have to use
-       // id here to get the document to validate as XHTML 1.1. This will cause a 
+       // id here to get the document to validate as XHTML 1.1. This will cause a
        // problem with some browsers, though, I'm sure. (Guess which!) So we will
-       // have to figure out what to do about this later. 
-       string const attr = "id=\"" + html::cleanAttr(to_utf8(getParam("name"))) + "\"";
-       xs << html::CompTag("a", attr);
+       // have to figure out what to do about this later.
+       docstring const attr = "id=\"" + xml::cleanAttr(getParam("name")) + '"';
+       xs << xml::CompTag("a", to_utf8(attr));
        return docstring();
 }