]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetText.cpp
Change tracking cue: InsetText and InsetCollapsible
[lyx.git] / src / insets / InsetText.cpp
index ed2633b429dad7d29596470ea797a273a36964de..99b1381f93d9961914dfd163d4c58ab0bd247bb7 100644 (file)
 #include "frontends/alert.h"
 #include "frontends/Painter.h"
 
+#include "support/bind.h"
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/gettext.h"
-#include "support/lstrings.h"
-
-#include "support/bind.h"
 #include "support/lassert.h"
+#include "support/lstrings.h"
+#include "support/RefChanger.h"
 
 #include <algorithm>
 
@@ -125,7 +125,7 @@ void InsetText::setMacrocontextPositionRecursive(DocIterator const & pos)
 void InsetText::clear()
 {
        ParagraphList & pars = paragraphs();
-       LASSERT(!pars.empty(), /**/);
+       LBUFERR(!pars.empty());
 
        // This is a gross hack...
        Layout const & old_layout = pars.begin()->layout();
@@ -215,24 +215,48 @@ void InsetText::draw(PainterInfo & pi, int x, int y) const
 {
        TextMetrics & tm = pi.base.bv->textMetrics(&text_);
 
+       int const w = tm.width() + TEXT_TO_INSET_OFFSET;
+       int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent();
+       int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
+       int const xframe = x + TEXT_TO_INSET_OFFSET / 2;
+       bool change_drawn = false;
        if (drawFrame_ || pi.full_repaint) {
-               int const w = tm.width() + TEXT_TO_INSET_OFFSET;
-               int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent();
-               int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
-               int const xframe = x + TEXT_TO_INSET_OFFSET / 2;
                if (pi.full_repaint)
                        pi.pain.fillRectangle(xframe, yframe, w, h,
                                pi.backgroundColor(this));
 
+               // Change color of the frame in tracked changes, like for tabulars.
+        // Only do so if the color is not custom. But do so even if RowPainter
+        // handles the strike-through already.
+               Color c;
+               if (pi.change_.changed()
+                   // Originally, these are the colors with role Text, from role() in
+                   // ColorCache.cpp.  The code is duplicated to avoid depending on Qt
+                   // types, and also maybe it need not match in the future.
+                   && (frameColor() == Color_foreground
+                       || frameColor() == Color_cursor
+                       || frameColor() == Color_preview
+                       || frameColor() == Color_tabularline
+                       || frameColor() == Color_previewframe)) {
+                       c = pi.change_.color();
+                       change_drawn = true;
+               } else
+                       c = frameColor();
                if (drawFrame_)
-                       pi.pain.rectangle(xframe, yframe, w, h, frameColor());
+                       pi.pain.rectangle(xframe, yframe, w, h, c);
        }
-       ColorCode const old_color = pi.background_color;
-       pi.background_color = pi.backgroundColor(this, false);
-
-       tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y);
-
-       pi.background_color = old_color;
+       {
+               Changer dummy = make_change(pi.background_color,
+                                           pi.backgroundColor(this, false));
+               // The change tracking cue must not be inherited
+               Changer dummy2 = make_change(pi.change_, Change());
+               tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y);
+       }
+       if (canPaintChange(*pi.base.bv) && (!change_drawn || pi.change_.deleted()))
+               // Do not draw the change tracking cue if already done by RowPainter and
+               // do not draw the cue for INSERTED if the information is already in the
+               // color of the frame
+               pi.change_.paintCue(pi, xframe, yframe, xframe + w, yframe + h);
 }
 
 
@@ -250,8 +274,7 @@ void InsetText::edit(Cursor & cur, bool front, EntryDirection entry_from)
                pos = temp_cur.pos();
        }
 
-       text_.setCursor(cur.top(), pit, pos);
-       cur.clearSelection();
+       cur.top().setPitPos(pit, pos);
        cur.finishUndo();
 }
 
@@ -266,7 +289,8 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        LYXERR(Debug::ACTION, "InsetText::doDispatch(): cmd: " << cmd);
 
-       if (isPassThru()) {
+       // See bug #9042, for instance.
+       if (isPassThru() && lyxCode() != ARG_CODE) {
                // Force any new text to latex_language FIXME: This
                // should only be necessary in constructor, but new
                // paragraphs that are created by pressing enter at
@@ -290,10 +314,11 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
 
        case LFUN_INSET_DISSOLVE: {
-               bool const main_inset = &buffer().inset() == this;
+               bool const main_inset = text_.isMainText();
                bool const target_inset = cmd.argument().empty() 
                        || cmd.getArg(0) == insetName(lyxCode());
-               bool const one_cell = nargs() == 1;
+               // cur.inset() is the tabular when this is a single cell (bug #9954)
+               bool const one_cell = cur.inset().nargs() == 1;
 
                if (!main_inset && target_inset && one_cell) {
                        // Text::dissolveInset assumes that the cursor
@@ -322,10 +347,11 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
 {
        switch (cmd.action()) {
        case LFUN_INSET_DISSOLVE: {
-               bool const main_inset = &buffer().inset() == this;
+               bool const main_inset = text_.isMainText();
                bool const target_inset = cmd.argument().empty() 
                        || cmd.getArg(0) == insetName(lyxCode());
-               bool const one_cell = nargs() == 1;
+               // cur.inset() is the tabular when this is a single cell (bug #9954)
+               bool const one_cell = cur.inset().nargs() == 1;
 
                if (target_inset)
                        status.setEnabled(!main_inset && one_cell);
@@ -338,11 +364,10 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
                        status.setEnabled(false);
                        return true;
                }
-               if (&buffer().inset() == this || !cur.paragraph().layout().latexargs().empty()
-                   || !cur.paragraph().layout().itemargs().empty())
+               if (text_.isMainText() || !cur.paragraph().layout().args().empty())
                        return text_.getStatus(cur, cmd, status);
 
-               Layout::LaTeXArgMap args = getLayout().latexargs();
+               Layout::LaTeXArgMap args = getLayout().args();
                Layout::LaTeXArgMap::const_iterator const lait = args.find(arg);
                if (lait != args.end()) {
                        status.setEnabled(true);
@@ -422,8 +447,8 @@ void InsetText::rejectChanges()
 void InsetText::validate(LaTeXFeatures & features) const
 {
        features.useInsetLayout(getLayout());
-       for_each(paragraphs().begin(), paragraphs().end(),
-                bind(&Paragraph::validate, _1, ref(features)));
+       for (Paragraph const & p : paragraphs())
+               p.validate(features);
 }
 
 
@@ -434,14 +459,18 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const
        // environment. Standard collapsable insets should not
        // redefine this, non-standard ones may call this.
        InsetLayout const & il = getLayout();
+       if (il.forceOwnlines())
+               os << breakln;
        if (!il.latexname().empty()) {
                if (il.latextype() == InsetLayout::COMMAND) {
                        // FIXME UNICODE
+                       // FIXME \protect should only be used for fragile
+                       //    commands, but we do not provide this information yet.
                        if (runparams.moving_arg)
                                os << "\\protect";
                        os << '\\' << from_utf8(il.latexname());
                        if (!il.latexargs().empty())
-                               getOptArg(os, runparams);
+                               getArgs(os, runparams);
                        if (!il.latexparam().empty())
                                os << from_utf8(il.latexparam());
                        os << '{';
@@ -455,14 +484,14 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const
                                                  runparams.lastpos);
                        os << "\\begin{" << from_utf8(il.latexname()) << "}";
                        if (!il.latexargs().empty())
-                               getOptArg(os, runparams);
+                               getArgs(os, runparams);
                        if (!il.latexparam().empty())
                                os << from_utf8(il.latexparam());
                        os << '\n';
                }
        } else {
                if (!il.latexargs().empty())
-                       getOptArg(os, runparams);
+                       getArgs(os, runparams);
                if (!il.latexparam().empty())
                        os << from_utf8(il.latexparam());
        }
@@ -475,6 +504,8 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const
                rp.pass_thru = true;
        if (il.isNeedProtect())
                rp.moving_arg = true;
+       if (!il.passThruChars().empty())
+               rp.pass_thru_chars += il.passThruChars();
        rp.par_begin = 0;
        rp.par_end = paragraphs().size();
 
@@ -488,21 +519,26 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const
        if (!il.latexname().empty()) {
                if (il.latextype() == InsetLayout::COMMAND) {
                        os << "}";
+                       if (!il.postcommandargs().empty())
+                               getArgs(os, runparams, true);
                } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
                        // A comment environment doesn't need a % before \n\end
                        if (il.isDisplay() || runparams.inComment)
-                           os << breakln;
+                               os << breakln;
                        else
-                           os << safebreakln;
-                       os << "\\end{" << from_utf8(il.latexname()) << "}\n";
+                               os << safebreakln;
+                       os << "\\end{" << from_utf8(il.latexname()) << "}" << breakln;
                        if (!il.isDisplay())
                                os.protectSpace(true);
                }
        }
+       if (il.forceOwnlines())
+               os << breakln;
 }
 
 
-int InsetText::plaintext(odocstream & os, OutputParams const & runparams) const
+int InsetText::plaintext(odocstringstream & os,
+        OutputParams const & runparams, size_t max_length) const
 {
        ParagraphList::const_iterator beg = paragraphs().begin();
        ParagraphList::const_iterator end = paragraphs().end();
@@ -516,12 +552,14 @@ int InsetText::plaintext(odocstream & os, OutputParams const & runparams) const
                                os << '\n';
                }
                odocstringstream oss;
-               writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed);
+               writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed, max_length);
                docstring const str = oss.str();
                os << str;
                // FIXME: len is not computed fully correctly; in principle,
                // we have to count the characters after the last '\n'
                len = str.size();
+               if (os.str().size() >= max_length)
+                       break;
        }
 
        return len;
@@ -581,6 +619,7 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
        InsetLayout const & il = getLayout();
        if (opts & WriteOuterTag)
                xs << html::StartTag(il.htmltag(), il.htmlattr());
+
        if ((opts & WriteLabel) && !il.counter().empty()) {
                BufferParams const & bp = buffer().masterBuffer()->params();
                Counters & cntrs = bp.documentClass().counters();
@@ -600,26 +639,36 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
 
        if (opts & WriteInnerTag)
                xs << html::StartTag(il.htmlinnertag(), il.htmlinnerattr());
-       OutputParams ours = runparams;
-       if (!il.isMultiPar() || opts == JustText)
-               ours.html_make_pars = false;
-       xhtmlParagraphs(text_, buffer(), xs, ours);
+
+       // we will eventually lose information about the containing inset
+       if (!allowMultiPar() || opts == JustText)
+               runparams.html_make_pars = false;
+       if (il.isPassThru())
+               runparams.pass_thru = true;
+
+       xhtmlParagraphs(text_, buffer(), xs, runparams);
+
        if (opts & WriteInnerTag)
                xs << html::EndTag(il.htmlinnertag());
+
        if (opts & WriteOuterTag)
                xs << html::EndTag(il.htmltag());
+
        return docstring();
 }
 
-void InsetText::getOptArg(otexstream & os,
-                       OutputParams const & runparams_in) const
+void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
+                       bool const post) const
 {
        OutputParams runparams = runparams_in;
        runparams.local_font =
                &paragraphs()[0].getFirstFontSettings(buffer().masterBuffer()->params());
        if (isPassThru())
                runparams.pass_thru = true;
-       latexArgInsets(paragraphs()[0], os, runparams, getLayout().latexargs());
+       if (post)
+               latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().postcommandargs(), "post:");
+       else
+               latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().latexargs());
 }
 
 
@@ -640,27 +689,6 @@ void InsetText::setText(docstring const & data, Font const & font, bool trackCha
 }
 
 
-void InsetText::setAutoBreakRows(bool flag)
-{
-       if (flag == text_.autoBreakRows_)
-               return;
-
-       text_.autoBreakRows_ = flag;
-       if (flag)
-               return;
-
-       // remove previously existing newlines
-       ParagraphList::iterator it = paragraphs().begin();
-       ParagraphList::iterator end = paragraphs().end();
-       for (; it != end; ++it)
-               for (int i = 0; i < it->size(); ++i)
-                       if (it->isNewline(i))
-                               // do not track the change, because the user
-                               // is not allowed to revert/reject it
-                               it->eraseChar(i, false);
-}
-
-
 void InsetText::setDrawFrame(bool flag)
 {
        drawFrame_ = flag;
@@ -772,6 +800,9 @@ void InsetText::updateBuffer(ParIterator const & it, UpdateType utype)
                // since we are saving and restoring the existing counters, etc.
                Counters const savecnt = tclass.counters();
                tclass.counters().reset();
+               // we need float information even in note insets (#9760)
+               tclass.counters().current_float(savecnt.current_float());
+               tclass.counters().isSubfloat(savecnt.isSubfloat());
                buffer().updateBuffer(it2, utype);
                tclass.counters() = savecnt;
        }
@@ -784,22 +815,36 @@ void InsetText::toString(odocstream & os) const
 }
 
 
-void InsetText::forToc(docstring & os, size_t maxlen) const
+void InsetText::forOutliner(docstring & os, size_t const maxlen,
+                                                       bool const shorten) const
 {
        if (!getLayout().isInToc())
                return;
-       text().forToc(os, maxlen, false);
+       text().forOutliner(os, maxlen, shorten);
 }
 
 
-void InsetText::addToToc(DocIterator const & cdit) const
+void InsetText::addToToc(DocIterator const & cdit, bool output_active,
+                                                UpdateType utype) const
 {
        DocIterator dit = cdit;
        dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
-       Toc & toc = buffer().tocBackend().toc("tableofcontents");
+       iterateForToc(dit, output_active, utype);
+}
+
+
+void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
+                                                         UpdateType utype) const
+{
+       DocIterator dit = cdit;
+       // This also ensures that any document has a table of contents
+       shared_ptr<Toc> toc = buffer().tocBackend().toc("tableofcontents");
 
        BufferParams const & bufparams = buffer_->params();
        int const min_toclevel = bufparams.documentClass().min_toclevel();
+       // we really should have done this before we got here, but it
+       // can't hurt too much to do it again
+       bool const doing_output = output_active && producesOutput();
 
        // For each paragraph, traverse its insets and let them add
        // their toc items
@@ -816,29 +861,31 @@ void InsetText::addToToc(DocIterator const & cdit) const
                        Inset & inset = *it->inset;
                        dit.pos() = it->pos;
                        //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
-                       inset.addToToc(dit);
+                       inset.addToToc(dit, doing_output, utype);
                        if (inset.lyxCode() == ARG_CODE)
                                arginset = inset.asInsetText();
                }
                // now the toc entry for the paragraph
-               int const toclevel = par.layout().toclevel;
+               int const toclevel = text().getTocLevel(pit);
                if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
                        // insert this into the table of contents
                        docstring tocstring;
+                       int const length = (doing_output && utype == OutputUpdate) ?
+                               INT_MAX : TOC_ENTRY_LENGTH;
                        if (arginset) {
                                tocstring = par.labelString();
                                if (!tocstring.empty())
                                        tocstring += ' ';
-                               arginset->text().forToc(tocstring, TOC_ENTRY_LENGTH);
+                               arginset->text().forOutliner(tocstring, length);
                        } else
-                               par.forToc(tocstring, TOC_ENTRY_LENGTH);
+                               par.forOutliner(tocstring, length);
                        dit.pos() = 0;
-                       toc.push_back(TocItem(dit, toclevel - min_toclevel,
-                               tocstring, tocstring));
+                       toc->push_back(TocItem(dit, toclevel - min_toclevel,
+                                              tocstring, doing_output));
                }
-               
+
                // And now the list of changes.
-               par.addChangesToToc(dit, buffer());
+               par.addChangesToToc(dit, buffer(), doing_output);
        }
 }
 
@@ -851,9 +898,11 @@ bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
        // find text inset in old cursor
        Cursor insetCur = old;
        int scriptSlice = insetCur.find(this);
-       LASSERT(scriptSlice != -1, /**/);
+       // we can try to continue here. returning true means
+       // the cursor is "now" invalid. which it was.
+       LASSERT(scriptSlice != -1, return true);
        insetCur.cutOff(scriptSlice);
-       LASSERT(&insetCur.inset() == this, /**/);
+       LASSERT(&insetCur.inset() == this, return true);
        
        // update the old paragraph's words
        insetCur.paragraph().updateWords();
@@ -864,7 +913,7 @@ bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 
 bool InsetText::completionSupported(Cursor const & cur) const
 {
-       //LASSERT(&cur.bv().cursor().inset() != this, return false);
+       //LASSERT(&cur.bv().cursor().inset() == this, return false);
        return text_.completionSupported(cur);
 }
 
@@ -940,11 +989,10 @@ string InsetText::contextMenuName() const
 }
 
 
-docstring InsetText::toolTipText(docstring prefix,
-               size_t numlines, size_t len) const
+docstring InsetText::toolTipText(docstring prefix, size_t const len) const
 {
-       size_t const max_length = numlines * len;
        OutputParams rp(&buffer().params().encoding());
+       rp.for_tooltip = true;
        odocstringstream oss;
        oss << prefix;
 
@@ -952,17 +1000,17 @@ docstring InsetText::toolTipText(docstring prefix,
        ParagraphList::const_iterator end = paragraphs().end();
        ParagraphList::const_iterator it = beg;
        bool ref_printed = false;
-       docstring str;
 
        for (; it != end; ++it) {
                if (it != beg)
                        oss << '\n';
-               writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed);
-               str = oss.str();
-               if (str.length() > max_length)
+               writePlaintextParagraph(buffer(), *it, oss, rp, ref_printed, len);
+               if (oss.tellp() >= 0 && size_t(oss.tellp()) > len)
                        break;
        }
-       return support::wrapParas(str, 4, len, numlines);
+       docstring str = oss.str();
+       support::truncateWithEllipsis(str, len);
+       return str;
 }