]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetText.cpp
Collapsable -> Collapsible (part 1)
[lyx.git] / src / insets / InsetText.cpp
index df4f6e219325cd34734ab72cb73e18bd426583f5..28484a4d76114704eb6725d6d5eeaeef35669774 100644 (file)
@@ -27,7 +27,6 @@
 #include "ErrorList.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "InsetCaption.h"
 #include "InsetList.h"
 #include "Intl.h"
 #include "Language.h"
@@ -138,7 +137,7 @@ void InsetText::clear()
 }
 
 
-Dimension const InsetText::dimension(BufferView const & bv) const
+Dimension const InsetText::dimensionHelper(BufferView const & bv) const
 {
        TextMetrics const & tm = bv.textMetrics(&text_);
        Dimension dim = tm.dimension();
@@ -196,7 +195,7 @@ void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
        mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
 
        // This can happen when a layout has a left and right margin,
-       // and the view is made very narrow. We can't do better than 
+       // and the view is made very narrow. We can't do better than
        // to draw it partly out of view (bug 5890).
        if (mi.base.textwidth < 1)
                mi.base.textwidth = 1;
@@ -291,7 +290,7 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
        LYXERR(Debug::ACTION, "InsetText::doDispatch(): cmd: " << cmd);
 
        // See bug #9042, for instance.
-       if (isPassThru() && lyxCode() != ARG_CODE) {
+       if (isPassThru()) {
                // 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
@@ -316,7 +315,7 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
 
        case LFUN_INSET_DISSOLVE: {
                bool const main_inset = text_.isMainText();
-               bool const target_inset = cmd.argument().empty() 
+               bool const target_inset = cmd.argument().empty()
                        || cmd.getArg(0) == insetName(lyxCode());
                // cur.inset() is the tabular when this is a single cell (bug #9954)
                bool const one_cell = cur.inset().nargs() == 1;
@@ -337,7 +336,7 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
        default:
                text_.dispatch(cur, cmd);
        }
-       
+
        if (!cur.result().dispatched())
                Inset::doDispatch(cur, cmd);
 }
@@ -349,7 +348,7 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
        switch (cmd.action()) {
        case LFUN_INSET_DISSOLVE: {
                bool const main_inset = text_.isMainText();
-               bool const target_inset = cmd.argument().empty() 
+               bool const target_inset = cmd.argument().empty()
                        || cmd.getArg(0) == insetName(lyxCode());
                // cur.inset() is the tabular when this is a single cell (bug #9954)
                bool const one_cell = cur.inset().nargs() == 1;
@@ -372,22 +371,14 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
                Layout::LaTeXArgMap::const_iterator const lait = args.find(arg);
                if (lait != args.end()) {
                        status.setEnabled(true);
-                       ParagraphList::const_iterator pit = paragraphs().begin();
-                       for (; pit != paragraphs().end(); ++pit) {
-                               InsetList::const_iterator it = pit->insetList().begin();
-                               InsetList::const_iterator end = pit->insetList().end();
-                               for (; it != end; ++it) {
-                                       if (it->inset->lyxCode() == ARG_CODE) {
-                                               InsetArgument const * ins =
-                                                       static_cast<InsetArgument const *>(it->inset);
+                       for (Paragraph const & par : paragraphs())
+                               for (auto const & table : par.insetList())
+                                       if (InsetArgument const * ins = table.inset->asInsetArgument())
                                                if (ins->name() == arg) {
                                                        // we have this already
                                                        status.setEnabled(false);
                                                        return true;
                                                }
-                                       }
-                               }
-                       }
                } else
                        status.setEnabled(false);
                return true;
@@ -399,7 +390,7 @@ bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
                bool ret = false;
                if (cur.text() == &text_)
                        ret = text_.getStatus(cur, cmd, status);
-               
+
                if (!ret)
                        ret = Inset::getStatus(cur, cmd, status);
                return ret;
@@ -457,7 +448,7 @@ void InsetText::latex(otexstream & os, OutputParams const & runparams) const
 {
        // This implements the standard way of handling the LaTeX
        // output of a text inset, either a command or an
-       // environment. Standard collapsable insets should not
+       // environment. Standard collapsible insets should not
        // redefine this, non-standard ones may call this.
        InsetLayout const & il = getLayout();
        if (il.forceOwnlines())
@@ -600,7 +591,7 @@ docstring InsetText::xhtml(XHTMLStream & xs, OutputParams const & runparams) con
 // One solution would be to make the footnote <span>, but the problem is
 // completely general, and so we'd have to make absolutely everything into
 // span. What I think will work is to check if we're about to write "div" and,
-// if so, try to close fonts, etc. 
+// if so, try to close fonts, etc.
 // There are probably limits to how well we can do here, though, and we will
 // have to rely upon users not putting footnotes inside noun-type insets.
 docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
@@ -611,7 +602,7 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
        OutputParams runparams = rp;
        runparams.par_begin = 0;
        runparams.par_end = text().paragraphs().size();
-       
+
        if (undefined()) {
                xs.startDivision(false);
                xhtmlParagraphs(text_, buffer(), xs, runparams);
@@ -629,7 +620,7 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
                cntrs.step(il.counter(), OutputUpdate);
                // FIXME: translate to paragraph language
                if (!il.htmllabel().empty()) {
-                       docstring const lbl = 
+                       docstring const lbl =
                                cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
                        // FIXME is this check necessary?
                        if (!lbl.empty()) {
@@ -662,6 +653,7 @@ docstring InsetText::insetAsXHTML(XHTMLStream & xs, OutputParams const & rp,
        return docstring();
 }
 
+
 void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
                        bool const post) const
 {
@@ -671,9 +663,11 @@ void InsetText::getArgs(otexstream & os, OutputParams const & runparams_in,
        if (isPassThru())
                runparams.pass_thru = true;
        if (post)
-               latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().postcommandargs(), "post:");
+               latexArgInsetsForParent(paragraphs(), os, runparams,
+                                       getLayout().postcommandargs(), "post:");
        else
-               latexArgInsets(paragraphs(), paragraphs().begin(), os, runparams, getLayout().latexargs());
+               latexArgInsetsForParent(paragraphs(), os, runparams,
+                                       getLayout().latexargs());
 }
 
 
@@ -769,8 +763,9 @@ ParagraphList & InsetText::paragraphs()
 bool InsetText::insetAllowed(InsetCode code) const
 {
        switch (code) {
-       // Arguments are also allowed in PassThru insets
+       // Arguments and (plain) quotes are also allowed in PassThru insets
        case ARG_CODE:
+       case QUOTE_CODE:
                return true;
        default:
                return !isPassThru();
@@ -830,20 +825,20 @@ void InsetText::forOutliner(docstring & os, size_t const maxlen,
 
 
 void InsetText::addToToc(DocIterator const & cdit, bool output_active,
-                                                UpdateType utype) const
+                                                UpdateType utype, TocBackend & backend) const
 {
        DocIterator dit = cdit;
        dit.push_back(CursorSlice(const_cast<InsetText &>(*this)));
-       iterateForToc(dit, output_active, utype);
+       iterateForToc(dit, output_active, utype, backend);
 }
 
 
 void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
-                                                         UpdateType utype) const
+                                                         UpdateType utype, TocBackend & backend) const
 {
        DocIterator dit = cdit;
        // This also ensures that any document has a table of contents
-       shared_ptr<Toc> toc = buffer().tocBackend().toc("tableofcontents");
+       shared_ptr<Toc> toc = backend.toc("tableofcontents");
 
        BufferParams const & bufparams = buffer_->params();
        int const min_toclevel = bufparams.documentClass().min_toclevel();
@@ -851,26 +846,48 @@ void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
        // 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
+       // For each paragraph,
+       // * Add a toc item for the paragraph if it is AddToToc--merging adjacent
+       //   paragraphs as needed.
+       // * Traverse its insets and let them add their toc items
+       // * Compute the main table of contents (this is hardcoded)
+       // * Add the list of changes
        ParagraphList const & pars = paragraphs();
        pit_type pend = paragraphs().size();
+       // Record pairs {start,end} of where a toc item was opened for a paragraph
+       // and where it must be closed
+       stack<pair<pit_type, pit_type>> addtotoc_stack;
+
        for (pit_type pit = 0; pit != pend; ++pit) {
                Paragraph const & par = pars[pit];
                dit.pit() = pit;
+               dit.pos() = 0;
+
+               // Custom AddToToc in paragraph layouts (i.e. theorems)
+               if (par.layout().addToToc() && text().isFirstInSequence(pit)) {
+                       pit_type end =
+                               openAddToTocForParagraph(pit, dit, output_active, backend);
+                       addtotoc_stack.push({pit, end});
+               }
+
                // if we find an optarg, we'll save it for use later.
-               InsetText const * arginset = 0;
-               InsetList::const_iterator it  = par.insetList().begin();
-               InsetList::const_iterator end = par.insetList().end();
-               for (; it != end; ++it) {
-                       Inset & inset = *it->inset;
-                       dit.pos() = it->pos;
-                       //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
-                       inset.addToToc(dit, doing_output, utype);
-                       if (inset.lyxCode() == ARG_CODE)
-                               arginset = inset.asInsetText();
+               InsetArgument const * arginset = nullptr;
+               for (auto const & table : par.insetList()) {
+                       dit.pos() = table.pos;
+                       table.inset->addToToc(dit, doing_output, utype, backend);
+                       if (InsetArgument const * x = table.inset->asInsetArgument())
+                               arginset = x;
+               }
+
+               // End custom AddToToc in paragraph layouts
+               while (!addtotoc_stack.empty() && addtotoc_stack.top().second == pit) {
+                       // execute the closing function
+                       closeAddToTocForParagraph(addtotoc_stack.top().first,
+                                                 addtotoc_stack.top().second, backend);
+                       addtotoc_stack.pop();
                }
-               // now the toc entry for the paragraph
+
+               // now the toc entry for the paragraph in the main table of contents
                int const toclevel = text().getTocLevel(pit);
                if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
                        // insert this into the table of contents
@@ -890,16 +907,43 @@ void InsetText::iterateForToc(DocIterator const & cdit, bool output_active,
                }
 
                // And now the list of changes.
-               par.addChangesToToc(dit, buffer(), doing_output);
+               par.addChangesToToc(dit, buffer(), doing_output, backend);
        }
 }
 
 
+pit_type InsetText::openAddToTocForParagraph(pit_type pit,
+                                             DocIterator const & dit,
+                                             bool output_active,
+                                             TocBackend & backend) const
+{
+       Paragraph const & par = paragraphs()[pit];
+       TocBuilder & b = backend.builder(par.layout().tocType());
+       docstring const label = par.labelString();
+       b.pushItem(dit, label + (label.empty() ? "" : " "), output_active);
+       return text().lastInSequence(pit);
+}
+
+
+void InsetText::closeAddToTocForParagraph(pit_type start, pit_type end,
+                                          TocBackend & backend) const
+{
+       Paragraph const & par = paragraphs()[start];
+       TocBuilder & b = backend.builder(par.layout().tocType());
+       if (par.layout().isTocCaption()) {
+               docstring str;
+               text().forOutliner(str, TOC_ENTRY_LENGTH, start, end);
+               b.argumentItem(str);
+       }
+       b.pop();
+}
+
+
 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
 {
        if (buffer().isClean())
                return Inset::notifyCursorLeaves(old, cur);
-       
+
        // find text inset in old cursor
        Cursor insetCur = old;
        int scriptSlice = insetCur.find(this);
@@ -908,10 +952,10 @@ bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
        LASSERT(scriptSlice != -1, return true);
        insetCur.cutOff(scriptSlice);
        LASSERT(&insetCur.inset() == this, return true);
-       
+
        // update the old paragraph's words
        insetCur.paragraph().updateWords();
-       
+
        return Inset::notifyCursorLeaves(old, cur);
 }
 
@@ -971,7 +1015,7 @@ bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
 }
 
 
-void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y, 
+void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
        Dimension & dim) const
 {
        TextMetrics const & tm = cur.bv().textMetrics(&text_);
@@ -983,7 +1027,7 @@ string InsetText::contextMenu(BufferView const &, int, int) const
 {
        string context_menu = contextMenuName();
        if (context_menu != InsetText::contextMenuName())
-               context_menu += ";" + InsetText::contextMenuName(); 
+               context_menu += ";" + InsetText::contextMenuName();
        return context_menu;
 }
 
@@ -1019,52 +1063,6 @@ docstring InsetText::toolTipText(docstring prefix, size_t const len) const
 }
 
 
-InsetCaption const * InsetText::getCaptionInset() const
-{
-       ParagraphList::const_iterator pit = paragraphs().begin();
-       for (; pit != paragraphs().end(); ++pit) {
-               InsetList::const_iterator it = pit->insetList().begin();
-               for (; it != pit->insetList().end(); ++it) {
-                       Inset & inset = *it->inset;
-                       if (inset.lyxCode() == CAPTION_CODE) {
-                               InsetCaption const * ins =
-                                       static_cast<InsetCaption const *>(it->inset);
-                               return ins;
-                       }
-               }
-       }
-       return 0;
-}
-
-
-docstring InsetText::getCaptionText(OutputParams const & runparams) const
-{
-       InsetCaption const * ins = getCaptionInset();
-       if (ins == 0)
-               return docstring();
-
-       odocstringstream ods;
-       ins->getCaptionAsPlaintext(ods, runparams);
-       return ods.str();
-}
-
-
-docstring InsetText::getCaptionHTML(OutputParams const & runparams) const
-{
-       InsetCaption const * ins = getCaptionInset();
-       if (ins == 0)
-               return docstring();
-
-       odocstringstream ods;
-       XHTMLStream xs(ods);
-       docstring def = ins->getCaptionAsHTML(xs, runparams);
-       if (!def.empty())
-               // should already have been escaped
-               xs << XHTMLStream::ESCAPE_NONE << def << '\n';
-       return ods.str();
-}
-
-
 InsetText::XHTMLOptions operator|(InsetText::XHTMLOptions a1, InsetText::XHTMLOptions a2)
 {
        return static_cast<InsetText::XHTMLOptions>((int)a1 | (int)a2);