]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetText.cpp
Remove all BufferParam arguments in InsetXXX methods (since insets know about their...
[lyx.git] / src / insets / InsetText.cpp
index f780c89fc1f731336a58df5dc363e6f48f231049..a396041a30bbb453b7725cf64aa325835495df3e 100644 (file)
@@ -3,7 +3,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Jürgen Vigna
+ * \author Jürgen Vigna
  *
  * Full author contact details are available in file CREDITS.
  */
 #include <config.h>
 
 #include "InsetText.h"
-#include "InsetNewline.h"
 
-#include "Buffer.h"
+#include "insets/InsetOptArg.h"
+
 #include "buffer_funcs.h"
+#include "Buffer.h"
 #include "BufferParams.h"
 #include "BufferView.h"
+#include "CompletionList.h"
 #include "CoordCache.h"
-#include "CutAndPaste.h"
 #include "Cursor.h"
+#include "CutAndPaste.h"
 #include "DispatchResult.h"
 #include "ErrorList.h"
 #include "FuncRequest.h"
+#include "FuncStatus.h"
+#include "InsetCaption.h"
 #include "InsetList.h"
 #include "Intl.h"
-#include "lyxfind.h"
 #include "Lexer.h"
+#include "lyxfind.h"
 #include "LyXRC.h"
-#include "Text.h"
 #include "MetricsInfo.h"
-#include "OutputParams.h"
 #include "output_docbook.h"
 #include "output_latex.h"
+#include "output_xhtml.h"
+#include "OutputParams.h"
 #include "output_plaintext.h"
-#include "Paragraph.h"
 #include "paragraph_funcs.h"
+#include "Paragraph.h"
 #include "ParagraphParameters.h"
 #include "ParIterator.h"
 #include "Row.h"
 #include "sgml.h"
+#include "TexRow.h"
 #include "TextClass.h"
+#include "Text.h"
 #include "TextMetrics.h"
-#include "TexRow.h"
+#include "TocBackend.h"
 
 #include "frontends/alert.h"
 #include "frontends/Painter.h"
@@ -52,7 +58,7 @@
 #include "support/lstrings.h"
 
 #include <boost/bind.hpp>
-#include <boost/assert.hpp>
+#include "support/lassert.h"
 
 using namespace std;
 using namespace lyx::support;
@@ -65,43 +71,13 @@ namespace lyx {
 using graphics::PreviewLoader;
 
 
-class TextCompletionList : public Inset::CompletionList {
-public:
-       ///
-       TextCompletionList(Cursor const & cur)
-       : buf_(cur.buffer()), it_(buf_.registeredWords().begin()), pos_(0) {}
-       ///
-       virtual ~TextCompletionList() {}
-
-       ///
-       virtual size_t size() const {
-               return buf_.registeredWords().size();
-       }
-       ///
-       virtual docstring data(size_t idx) const {
-               std::set<docstring>::const_iterator it
-               = buf_.registeredWords().begin();
-               for (size_t i = 0; i < idx; ++i)
-                       it++;
-               return *it;
-       }
-
-private:
-       Buffer const & buf_;
-       std::set<docstring>::const_iterator const it_;
-       size_t pos_;
-};
-
-
 /////////////////////////////////////////////////////////////////////
 
-InsetText::InsetText(BufferParams const & bp)
+InsetText::InsetText(Buffer const & buf, UsePlain type)
        : drawFrame_(false), frame_color_(Color_insetframe)
 {
-       paragraphs().push_back(Paragraph());
-       Paragraph & ourpar = paragraphs().back();
-       ourpar.setEmptyOrDefaultLayout(bp.textClass());
-       ourpar.setInsetOwner(this);
+       setBuffer(const_cast<Buffer &>(buf));
+       initParagraphs(type);
 }
 
 
@@ -116,8 +92,27 @@ InsetText::InsetText(InsetText const & in)
 }
 
 
-InsetText::InsetText()
-{}
+void InsetText::setBuffer(Buffer & buf)
+{
+       ParagraphList::iterator end = paragraphs().end();
+       for (ParagraphList::iterator it = paragraphs().begin(); it != end; ++it)
+               it->setBuffer(buf);
+       Inset::setBuffer(buf);
+}
+
+
+void InsetText::initParagraphs(UsePlain type)
+{
+       LASSERT(paragraphs().empty(), /**/);
+       paragraphs().push_back(Paragraph());
+       Paragraph & ourpar = paragraphs().back();
+       ourpar.setInsetOwner(this);
+       DocumentClass const & dc = buffer_->params().documentClass();
+       if (type == DefaultLayout)
+               ourpar.setDefaultLayout(dc);
+       else
+               ourpar.setPlainLayout(dc);
+}
 
 
 void InsetText::setParagraphOwner()
@@ -130,9 +125,10 @@ void InsetText::setParagraphOwner()
 void InsetText::clear()
 {
        ParagraphList & pars = paragraphs();
+       LASSERT(!pars.empty(), /**/);
 
        // This is a gross hack...
-       LayoutPtr old_layout = pars.begin()->layout();
+       Layout const & old_layout = pars.begin()->layout();
 
        pars.clear();
        pars.push_back(Paragraph());
@@ -141,12 +137,6 @@ void InsetText::clear()
 }
 
 
-Inset * InsetText::clone() const
-{
-       return new InsetText(*this);
-}
-
-
 Dimension const InsetText::dimension(BufferView const & bv) const
 {
        TextMetrics const & tm = bv.textMetrics(&text_);
@@ -158,14 +148,14 @@ Dimension const InsetText::dimension(BufferView const & bv) const
 }
 
 
-void InsetText::write(Buffer const & buf, ostream & os) const
+void InsetText::write(ostream & os) const
 {
        os << "Text\n";
-       text_.write(buf, os);
+       text_.write(buffer(), os);
 }
 
 
-void InsetText::read(Buffer const & buf, Lexer & lex)
+void InsetText::read(Lexer & lex)
 {
        clear();
 
@@ -173,12 +163,11 @@ void InsetText::read(Buffer const & buf, Lexer & lex)
        Paragraph oldpar = *paragraphs().begin();
        paragraphs().clear();
        ErrorList errorList;
-       bool res = text_.read(buf, lex, errorList, this);
+       lex.setContext("InsetText::read");
+       bool res = text_.read(buffer(), lex, errorList, this);
 
-       if (!res) {
-               lex.printError("Missing \\end_inset at this point. "
-                                          "Read: `$$Token'");
-       }
+       if (!res)
+               lex.printError("Missing \\end_inset at this point. ");
 
        // sanity check
        // ensure we have at least one paragraph.
@@ -196,6 +185,13 @@ void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
        // Hand font through to contained lyxtext:
        tm.font_.fontInfo() = mi.base.font;
        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 
+       // to draw it partly out of view (bug 5890).
+       if (mi.base.textwidth < 1)
+               mi.base.textwidth = 1;
+
        if (hasFixedWidth())
                tm.metrics(mi, dim, mi.base.textwidth);
        else
@@ -217,15 +213,22 @@ void InsetText::draw(PainterInfo & pi, int x, int y) const
                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, backgroundColor());
+                       pi.pain.fillRectangle(xframe, yframe, w, h,
+                               pi.backgroundColor(this));
+
                if (drawFrame_)
                        pi.pain.rectangle(xframe, yframe, w, h, frameColor());
        }
+       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;
 }
 
 
-docstring const InsetText::editMessage() const
+docstring InsetText::editMessage() const
 {
        return _("Opened Text Inset");
 }
@@ -261,14 +264,45 @@ void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        LYXERR(Debug::ACTION, "InsetText::doDispatch()"
                << " [ cmd.action = " << cmd.action << ']');
-       text_.dispatch(cur, cmd);
+
+       // Dispatch only to text_ if the cursor is inside
+       // the text_. It is not for context menus (bug 5797).
+       if (cur.text() == &text_)
+               text_.dispatch(cur, cmd);
+       else
+               cur.undispatched();
+       
+       if (!cur.result().dispatched())
+               Inset::doDispatch(cur, cmd);
 }
 
 
 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
        FuncStatus & status) const
 {
-       return text_.getStatus(cur, cmd, status);
+       switch (cmd.action) {
+       case LFUN_LAYOUT:
+               status.setEnabled(!forcePlainLayout());
+               return true;
+
+       case LFUN_LAYOUT_PARAGRAPH:
+       case LFUN_PARAGRAPH_PARAMS:
+       case LFUN_PARAGRAPH_PARAMS_APPLY:
+       case LFUN_PARAGRAPH_SPACING:
+       case LFUN_PARAGRAPH_UPDATE:
+               status.setEnabled(allowParagraphCustomization());
+               return true;
+       default:
+               // Dispatch only to text_ if the cursor is inside
+               // the text_. It is not for context menus (bug 5797).
+               bool ret = false;
+               if (cur.text() == &text_)
+                       ret = text_.getStatus(cur, cmd, status);
+               
+               if (!ret)
+                       ret = Inset::getStatus(cur, cmd, status);
+               return ret;
+       }
 }
 
 
@@ -282,29 +316,27 @@ void InsetText::setChange(Change const & change)
 }
 
 
-void InsetText::acceptChanges(BufferParams const & bparams)
+void InsetText::acceptChanges()
 {
-       text_.acceptChanges(bparams);
+       text_.acceptChanges(buffer().params());
 }
 
 
-void InsetText::rejectChanges(BufferParams const & bparams)
+void InsetText::rejectChanges()
 {
-       text_.rejectChanges(bparams);
+       text_.rejectChanges(buffer().params());
 }
 
 
-int InsetText::latex(Buffer const & buf, odocstream & os,
-                    OutputParams const & runparams) const
+int InsetText::latex(odocstream & os, OutputParams const & runparams) const
 {
        TexRow texrow;
-       latexParagraphs(buf, text_, os, texrow, runparams);
+       latexParagraphs(buffer(), text_, os, texrow, runparams);
        return texrow.rows();
 }
 
 
-int InsetText::plaintext(Buffer const & buf, odocstream & os,
-                        OutputParams const & runparams) const
+int InsetText::plaintext(odocstream & os, OutputParams const & runparams) const
 {
        ParagraphList::const_iterator beg = paragraphs().begin();
        ParagraphList::const_iterator end = paragraphs().end();
@@ -318,7 +350,7 @@ int InsetText::plaintext(Buffer const & buf, odocstream & os,
                                os << '\n';
                }
                odocstringstream oss;
-               writePlaintextParagraph(buf, *it, oss, runparams, ref_printed);
+               writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed);
                docstring const str = oss.str();
                os << str;
                // FIXME: len is not computed fully correctly; in principle,
@@ -330,14 +362,20 @@ int InsetText::plaintext(Buffer const & buf, odocstream & os,
 }
 
 
-int InsetText::docbook(Buffer const & buf, odocstream & os,
-                      OutputParams const & runparams) const
+int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
 {
-       docbookParagraphs(paragraphs(), buf, os, runparams);
+       docbookParagraphs(paragraphs(), buffer(), os, runparams);
        return 0;
 }
 
 
+docstring InsetText::xhtml(odocstream & os, OutputParams const & runparams) const
+{
+       xhtmlParagraphs(paragraphs(), buffer(), os, runparams);
+       return docstring();
+}
+
+
 void InsetText::validate(LaTeXFeatures & features) const
 {
        for_each(paragraphs().begin(), paragraphs().end(),
@@ -407,7 +445,7 @@ void InsetText::setFrameColor(ColorCode col)
 }
 
 
-void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
+void InsetText::appendParagraphs(ParagraphList & plist)
 {
        // There is little we can do here to keep track of changes.
        // As of 2006/10/20, appendParagraphs is used exclusively by
@@ -419,7 +457,7 @@ void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
        ParagraphList::iterator pit = plist.begin();
        ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
        ++pit;
-       mergeParagraph(buffer->params(), pl,
+       mergeParagraph(buffer().params(), pl,
                       distance(pl.begin(), ins) - 1);
 
        for_each(pit, plist.end(),
@@ -441,15 +479,6 @@ void InsetText::addPreview(PreviewLoader & loader) const
 }
 
 
-//FIXME: instead of this hack, which only works by chance,
-// cells should have their own insetcell type, which returns CELL_CODE!
-bool InsetText::neverIndent(Buffer const & buffer) const
-{
-       // this is only true for tabular cells
-       return !text_.isMainText(buffer) && lyxCode() == TEXT_CODE;
-}
-
-
 ParagraphList const & InsetText::paragraphs() const
 {
        return text_.paragraphs();
@@ -462,24 +491,102 @@ ParagraphList & InsetText::paragraphs()
 }
 
 
-void InsetText::updateLabels(Buffer const & buf, ParIterator const & it)
+void InsetText::updateLabels(ParIterator const & it)
 {
        ParIterator it2 = it;
        it2.forwardPos();
-       BOOST_ASSERT(&it2.inset() == this && it2.pit() == 0);
-       lyx::updateLabels(buf, it2);
+       LASSERT(&it2.inset() == this && it2.pit() == 0, return);
+       if (producesOutput())
+               buffer().updateLabels(it2);
+       else {
+               DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
+               Counters const savecnt = tclass.counters();
+               buffer().updateLabels(it2);
+               tclass.counters() = savecnt;
+       }
+}
+
+
+void InsetText::addToToc(DocIterator const & cdit)
+{
+       DocIterator dit = cdit;
+       dit.push_back(CursorSlice(*this));
+       Toc & toc = buffer().tocBackend().toc("tableofcontents");
+
+       BufferParams const & bufparams = buffer_->params();
+       const int min_toclevel = bufparams.documentClass().min_toclevel();
+
+       // For each paragraph, traverse its insets and let them add
+       // their toc items
+       ParagraphList & pars = paragraphs();
+       pit_type pend = paragraphs().size();
+       for (pit_type pit = 0; pit != pend; ++pit) {
+               Paragraph const & par = pars[pit];
+               dit.pit() = pit;
+               // the string that goes to the toc (could be the optarg)
+               docstring tocstring;
+               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);
+                       switch (inset.lyxCode()) {
+                       case OPTARG_CODE: {
+                               if (!tocstring.empty())
+                                       break;
+                               dit.pos() = 0;
+                               Paragraph const & insetpar =
+                                       *static_cast<InsetOptArg&>(inset).paragraphs().begin();
+                               if (!par.labelString().empty())
+                                       tocstring = par.labelString() + ' ';
+                               tocstring += insetpar.asString(AS_STR_INSETS);
+                               break;
+                       }
+                       default:
+                               break;
+                       }
+               }
+               // now the toc entry for the paragraph
+               int const toclevel = par.layout().toclevel;
+               if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
+                       dit.pos() = 0;
+                       // insert this into the table of contents
+                       if (tocstring.empty())
+                               tocstring = par.asString(AS_STR_LABEL | AS_STR_INSETS);
+                       toc.push_back(TocItem(dit, toclevel - min_toclevel, tocstring));
+               }
+               
+               // And now the list of changes.
+               par.addChangesToToc(dit, buffer());
+       }
+}
+
+
+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);
+       LASSERT(scriptSlice != -1, /**/);
+       insetCur.cutOff(scriptSlice);
+       LASSERT(&insetCur.inset() == this, /**/);
+       
+       // update the old paragraph's words
+       insetCur.paragraph().updateWords();
+       
+       return Inset::notifyCursorLeaves(old, cur);
 }
 
 
 bool InsetText::completionSupported(Cursor const & cur) const
 {
-       Cursor const & bvCur = cur.bv().cursor();
-       if (&bvCur.inset() != this)
-               return false;
-       Paragraph const & par = cur.paragraph();
-       return cur.pos() > 0
-               && (cur.pos() >= par.size() || !par.isLetter(cur.pos()))
-               && par.isLetter(cur.pos() - 1);
+       //LASSERT(&cur.bv().cursor().inset() != this, return false);
+       return text_.completionSupported(cur);
 }
 
 
@@ -501,26 +608,15 @@ bool InsetText::automaticPopupCompletion() const
 }
 
 
-Inset::CompletionList const 
-* InsetText::createCompletionList(Cursor const & cur) const
+bool InsetText::showCompletionCursor() const
 {
-       if (!completionSupported(cur))
-               return 0;
-
-       return new TextCompletionList(cur);
+       return lyxrc.completion_cursor_text;
 }
 
 
-docstring InsetText::previousWord(Buffer const & buffer, CursorSlice const & sl) const
+CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
 {
-       CursorSlice from = sl;
-       CursorSlice to = sl;
-       text_.getWord(from, to, PREVIOUS_WORD);
-       if (sl == from || to == from)
-               return docstring();
-       
-       Paragraph const & par = sl.paragraph();
-       return par.asString(buffer, from.pos(), to.pos(), false);
+       return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
 }
 
 
@@ -528,49 +624,75 @@ docstring InsetText::completionPrefix(Cursor const & cur) const
 {
        if (!completionSupported(cur))
                return docstring();
-       
-       return previousWord(cur.buffer(), cur.top());
+       return text_.completionPrefix(cur);
 }
 
 
 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
-                                    bool /*finished*/)
+       bool finished)
 {
        if (!completionSupported(cur))
                return false;
 
-       BOOST_ASSERT(cur.bv().cursor() == cur);
-       cur.insert(s);
-       cur.bv().cursor() = cur;
-       return true;
+       return text_.insertCompletion(cur, s, finished);
 }
 
 
 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y, 
-                                       Dimension & dim) const
+       Dimension & dim) const
 {
-       Cursor const & bvcur = cur.bv().cursor();
-       
-       // get word in front of cursor
-       docstring word = previousWord(cur.buffer(), bvcur.top());
-       DocIterator wordStart = bvcur;
-       wordStart.pos() -= word.length();
-       
-       // get position on screen of the word start and end
-       Point lxy = cur.bv().getPos(wordStart, false);
-       Point rxy = cur.bv().getPos(bvcur, bvcur.boundary());
-       
-       // calculate dimensions of the word
        TextMetrics const & tm = cur.bv().textMetrics(&text_);
-       dim = tm.rowHeight(bvcur.pit(), wordStart.pos(), bvcur.pos(), false);
-       dim.wid = abs(rxy.x_ - lxy.x_);
-       
-       // calculate position of word
-       y = lxy.y_;
-       x = min(rxy.x_, lxy.x_);
-       
-       //lyxerr << "wid=" << dim.width() << " x=" << x << " y=" << y << " lxy.x_=" << lxy.x_ << " rxy.x_=" << rxy.x_ << " word=" << word << std::endl;
-       //lyxerr << " wordstart=" << wordStart << " bvcur=" << bvcur << " cur=" << cur << std::endl;
+       tm.completionPosAndDim(cur, x, y, dim);
+}
+
+
+docstring InsetText::contextMenu(BufferView const &, int, int) const
+{
+       return from_ascii("context-edit");
+}
+
+
+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;
+       docstring def = ins->getCaptionAsHTML(ods, runparams);
+       if (!def.empty())
+               ods << def << '\n';
+       return ods.str();
 }