3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
13 #include "InsetText.h"
15 #include "insets/InsetOptArg.h"
17 #include "buffer_funcs.h"
19 #include "BufferParams.h"
20 #include "BufferView.h"
21 #include "CompletionList.h"
22 #include "CoordCache.h"
24 #include "CutAndPaste.h"
25 #include "DispatchResult.h"
26 #include "ErrorList.h"
27 #include "FuncRequest.h"
28 #include "FuncStatus.h"
29 #include "InsetCaption.h"
30 #include "InsetList.h"
33 #include "LaTeXFeatures.h"
37 #include "MetricsInfo.h"
38 #include "output_docbook.h"
39 #include "output_latex.h"
40 #include "output_xhtml.h"
41 #include "OutputParams.h"
42 #include "output_plaintext.h"
43 #include "Paragraph.h"
44 #include "ParagraphParameters.h"
45 #include "ParIterator.h"
49 #include "TextClass.h"
51 #include "TextMetrics.h"
52 #include "TocBackend.h"
54 #include "frontends/alert.h"
55 #include "frontends/Painter.h"
57 #include "support/debug.h"
58 #include "support/gettext.h"
59 #include "support/lstrings.h"
61 #include <boost/bind.hpp>
62 #include "support/lassert.h"
65 using namespace lyx::support;
72 using graphics::PreviewLoader;
75 /////////////////////////////////////////////////////////////////////
77 InsetText::InsetText(Buffer const & buf, UsePlain type)
78 : drawFrame_(false), frame_color_(Color_insetframe), text_(this)
80 setBuffer(const_cast<Buffer &>(buf));
85 InsetText::InsetText(InsetText const & in)
86 : Inset(in), text_(this)
88 text_.autoBreakRows_ = in.text_.autoBreakRows_;
89 drawFrame_ = in.drawFrame_;
90 frame_color_ = in.frame_color_;
91 text_.paragraphs() = in.text_.paragraphs();
96 void InsetText::setBuffer(Buffer & buf)
98 ParagraphList::iterator end = paragraphs().end();
99 for (ParagraphList::iterator it = paragraphs().begin(); it != end; ++it)
101 Inset::setBuffer(buf);
105 void InsetText::initParagraphs(UsePlain type)
107 LASSERT(paragraphs().empty(), /**/);
108 paragraphs().push_back(Paragraph());
109 Paragraph & ourpar = paragraphs().back();
110 ourpar.setInsetOwner(this);
111 DocumentClass const & dc = buffer_->params().documentClass();
112 if (type == DefaultLayout)
113 ourpar.setDefaultLayout(dc);
115 ourpar.setPlainLayout(dc);
119 void InsetText::setParagraphOwner()
121 for_each(paragraphs().begin(), paragraphs().end(),
122 bind(&Paragraph::setInsetOwner, _1, this));
126 void InsetText::clear()
128 ParagraphList & pars = paragraphs();
129 LASSERT(!pars.empty(), /**/);
131 // This is a gross hack...
132 Layout const & old_layout = pars.begin()->layout();
135 pars.push_back(Paragraph());
136 pars.begin()->setInsetOwner(this);
137 pars.begin()->setLayout(old_layout);
141 Dimension const InsetText::dimension(BufferView const & bv) const
143 TextMetrics const & tm = bv.textMetrics(&text_);
144 Dimension dim = tm.dimension();
145 dim.wid += 2 * TEXT_TO_INSET_OFFSET;
146 dim.des += TEXT_TO_INSET_OFFSET;
147 dim.asc += TEXT_TO_INSET_OFFSET;
152 void InsetText::write(ostream & os) const
159 void InsetText::read(Lexer & lex)
163 // delete the initial paragraph
164 Paragraph oldpar = *paragraphs().begin();
165 paragraphs().clear();
167 lex.setContext("InsetText::read");
168 bool res = text_.read(lex, errorList, this);
171 lex.printError("Missing \\end_inset at this point. ");
174 // ensure we have at least one paragraph.
175 if (paragraphs().empty())
176 paragraphs().push_back(oldpar);
177 // Force default font, if so requested
178 // This avoids paragraphs in buffer language that would have a
179 // foreign language after a document language change, and it ensures
180 // that all new text in ERT and similar gets the "latex" language,
181 // since new text inherits the language from the last position of the
182 // existing text. As a side effect this makes us also robust against
183 // bugs in LyX that might lead to font changes in ERT in .lyx files.
188 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
190 TextMetrics & tm = mi.base.bv->textMetrics(&text_);
192 //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
194 // Hand font through to contained lyxtext:
195 tm.font_.fontInfo() = mi.base.font;
196 mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
198 // This can happen when a layout has a left and right margin,
199 // and the view is made very narrow. We can't do better than
200 // to draw it partly out of view (bug 5890).
201 if (mi.base.textwidth < 1)
202 mi.base.textwidth = 1;
205 tm.metrics(mi, dim, mi.base.textwidth);
208 mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
209 dim.asc += TEXT_TO_INSET_OFFSET;
210 dim.des += TEXT_TO_INSET_OFFSET;
211 dim.wid += 2 * TEXT_TO_INSET_OFFSET;
215 void InsetText::draw(PainterInfo & pi, int x, int y) const
217 TextMetrics & tm = pi.base.bv->textMetrics(&text_);
219 if (drawFrame_ || pi.full_repaint) {
220 int const w = tm.width() + TEXT_TO_INSET_OFFSET;
221 int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent();
222 int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
223 int const xframe = x + TEXT_TO_INSET_OFFSET / 2;
225 pi.pain.fillRectangle(xframe, yframe, w, h,
226 pi.backgroundColor(this));
229 pi.pain.rectangle(xframe, yframe, w, h, frameColor());
231 ColorCode const old_color = pi.background_color;
232 pi.background_color = pi.backgroundColor(this, false);
234 tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y);
236 pi.background_color = old_color;
240 void InsetText::edit(Cursor & cur, bool front, EntryDirection entry_from)
242 pit_type const pit = front ? 0 : paragraphs().size() - 1;
243 pos_type pos = front ? 0 : paragraphs().back().size();
245 // if visual information is not to be ignored, move to extreme right/left
246 if (entry_from != ENTRY_DIRECTION_IGNORE) {
247 Cursor temp_cur = cur;
248 temp_cur.pit() = pit;
249 temp_cur.pos() = pos;
250 temp_cur.posVisToRowExtremity(entry_from == ENTRY_DIRECTION_LEFT);
251 pos = temp_cur.pos();
254 text_.setCursor(cur.top(), pit, pos);
255 cur.clearSelection();
260 Inset * InsetText::editXY(Cursor & cur, int x, int y)
262 return cur.bv().textMetrics(&text_).editXY(cur, x, y);
266 void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
268 LYXERR(Debug::ACTION, "InsetText::doDispatch()"
269 << " [ cmd.action = " << cmd.action << ']');
271 if (getLayout().isPassThru()) {
272 // Force any new text to latex_language FIXME: This
273 // should only be necessary in constructor, but new
274 // paragraphs that are created by pressing enter at
275 // the start of an existing paragraph get the buffer
276 // language and not latex_language, so we take this
277 // brute force approach.
278 cur.current_font.setLanguage(latex_language);
279 cur.real_current_font.setLanguage(latex_language);
282 switch (cmd.action) {
284 case LFUN_CLIPBOARD_PASTE:
285 case LFUN_SELECTION_PASTE:
286 case LFUN_PRIMARY_SELECTION_PASTE:
287 text_.dispatch(cur, cmd);
288 // If we we can only store plain text, we must reset all
290 // FIXME: Change only the pasted paragraphs
294 case LFUN_INSET_DISSOLVE: {
295 bool const main_inset = &buffer().inset() == this;
296 bool const target_inset = cmd.argument().empty()
297 || cmd.getArg(0) == insetName(lyxCode());
298 bool const one_cell = nargs() == 1;
300 if (!main_inset && target_inset && one_cell) {
301 // Text::dissolveInset assumes that the cursor
302 // is inside the Inset.
303 if (&cur.inset() != this)
304 cur.pushBackward(*this);
305 cur.beginUndoGroup();
306 text_.dispatch(cur, cmd);
314 text_.dispatch(cur, cmd);
317 if (!cur.result().dispatched())
318 Inset::doDispatch(cur, cmd);
322 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
323 FuncStatus & status) const
325 switch (cmd.action) {
327 status.setEnabled(!forcePlainLayout());
330 case LFUN_LAYOUT_PARAGRAPH:
331 case LFUN_PARAGRAPH_PARAMS:
332 case LFUN_PARAGRAPH_PARAMS_APPLY:
333 case LFUN_PARAGRAPH_UPDATE:
334 status.setEnabled(allowParagraphCustomization());
337 case LFUN_INSET_DISSOLVE: {
338 bool const main_inset = &buffer().inset() == this;
339 bool const target_inset = cmd.argument().empty()
340 || cmd.getArg(0) == insetName(lyxCode());
341 bool const one_cell = nargs() == 1;
344 status.setEnabled(!main_inset && one_cell);
349 // Dispatch only to text_ if the cursor is inside
350 // the text_. It is not for context menus (bug 5797).
352 if (cur.text() == &text_)
353 ret = text_.getStatus(cur, cmd, status);
356 ret = Inset::getStatus(cur, cmd, status);
362 void InsetText::fixParagraphsFont()
364 if (!getLayout().isPassThru())
367 Font font(inherit_font, buffer().params().language);
368 font.setLanguage(latex_language);
369 ParagraphList::iterator par = paragraphs().begin();
370 ParagraphList::iterator const end = paragraphs().end();
372 par->resetFonts(font);
373 par->params().clear();
379 void InsetText::setChange(Change const & change)
381 ParagraphList::iterator pit = paragraphs().begin();
382 ParagraphList::iterator end = paragraphs().end();
383 for (; pit != end; ++pit) {
384 pit->setChange(change);
389 void InsetText::acceptChanges()
391 text_.acceptChanges();
395 void InsetText::rejectChanges()
397 text_.rejectChanges();
401 void InsetText::validate(LaTeXFeatures & features) const
403 features.useInsetLayout(getLayout());
404 for_each(paragraphs().begin(), paragraphs().end(),
405 bind(&Paragraph::validate, _1, ref(features)));
409 int InsetText::latex(odocstream & os, OutputParams const & runparams) const
411 // This implements the standard way of handling the LaTeX
412 // output of a text inset, either a command or an
413 // environment. Standard collapsable insets should not
414 // redefine this, non-standard ones may call this.
415 InsetLayout const & il = getLayout();
417 if (!il.latexname().empty()) {
418 if (il.latextype() == InsetLayout::COMMAND) {
420 if (runparams.moving_arg)
422 os << '\\' << from_utf8(il.latexname());
423 if (!il.latexparam().empty())
424 os << from_utf8(il.latexparam());
426 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
427 os << "%\n\\begin{" << from_utf8(il.latexname()) << "}\n";
428 if (!il.latexparam().empty())
429 os << from_utf8(il.latexparam());
433 OutputParams rp = runparams;
436 if (il.isNeedProtect())
437 rp.moving_arg = true;
439 // Output the contents of the inset
441 latexParagraphs(buffer(), text_, os, texrow, rp);
442 rows += texrow.rows();
444 if (!il.latexname().empty()) {
445 if (il.latextype() == InsetLayout::COMMAND) {
447 } else if (il.latextype() == InsetLayout::ENVIRONMENT) {
448 os << "\n\\end{" << from_utf8(il.latexname()) << "}\n";
456 int InsetText::plaintext(odocstream & os, OutputParams const & runparams) const
458 ParagraphList::const_iterator beg = paragraphs().begin();
459 ParagraphList::const_iterator end = paragraphs().end();
460 ParagraphList::const_iterator it = beg;
461 bool ref_printed = false;
463 for (; it != end; ++it) {
466 if (runparams.linelen > 0)
469 odocstringstream oss;
470 writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed);
471 docstring const str = oss.str();
473 // FIXME: len is not computed fully correctly; in principle,
474 // we have to count the characters after the last '\n'
482 int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
484 ParagraphList::const_iterator const beg = paragraphs().begin();
487 sgml::openTag(os, getLayout().latexname(),
488 beg->getID(buffer(), runparams) + getLayout().latexparam());
490 docbookParagraphs(text_, buffer(), os, runparams);
493 sgml::closeTag(os, getLayout().latexname());
499 docstring InsetText::xhtml(odocstream & os, OutputParams const & runparams) const
502 xhtmlParagraphs(text_, buffer(), os, runparams);
506 InsetLayout const & il = getLayout();
507 bool const opened = html::openTag(os, il.htmltag(), il.htmlattr());
508 if (!il.counter().empty()) {
509 BufferParams const & bp = buffer().masterBuffer()->params();
510 Counters & cntrs = bp.documentClass().counters();
511 cntrs.step(il.counter());
512 // FIXME: translate to paragraph language
513 if (!il.htmllabel().empty()) {
514 docstring const lbl =
515 cntrs.counterLabel(from_utf8(il.htmllabel()), bp.language->code());
516 // FIXME is this check necessary?
518 bool const lopen = html::openTag(os, il.htmllabeltag(), il.htmllabelattr());
521 html::closeTag(os, il.htmllabeltag());
526 bool innertag_opened = false;
527 if (!il.htmlinnertag().empty())
528 innertag_opened = html::openTag(os, il.htmlinnertag(), il.htmlinnerattr());
530 xhtmlParagraphs(text_, buffer(), os, runparams);
533 html::closeTag(os, il.htmlinnertag());
535 html::closeTag(os, il.htmltag());
540 void InsetText::cursorPos(BufferView const & bv,
541 CursorSlice const & sl, bool boundary, int & x, int & y) const
543 x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET;
544 y = bv.textMetrics(&text_).cursorY(sl, boundary);
548 bool InsetText::showInsetDialog(BufferView *) const
554 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
557 Paragraph & first = paragraphs().front();
558 for (unsigned int i = 0; i < data.length(); ++i)
559 first.insertChar(i, data[i], font, trackChanges);
563 void InsetText::setAutoBreakRows(bool flag)
565 if (flag == text_.autoBreakRows_)
568 text_.autoBreakRows_ = flag;
572 // remove previously existing newlines
573 ParagraphList::iterator it = paragraphs().begin();
574 ParagraphList::iterator end = paragraphs().end();
575 for (; it != end; ++it)
576 for (int i = 0; i < it->size(); ++i)
577 if (it->isNewline(i))
578 // do not track the change, because the user
579 // is not allowed to revert/reject it
580 it->eraseChar(i, false);
584 void InsetText::setDrawFrame(bool flag)
590 ColorCode InsetText::frameColor() const
596 void InsetText::setFrameColor(ColorCode col)
602 void InsetText::appendParagraphs(ParagraphList & plist)
604 // There is little we can do here to keep track of changes.
605 // As of 2006/10/20, appendParagraphs is used exclusively by
606 // LyXTabular::setMultiColumn. In this context, the paragraph break
607 // is lost irreversibly and the appended text doesn't really change
609 ParagraphList & pl = paragraphs();
611 ParagraphList::iterator pit = plist.begin();
612 ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
614 mergeParagraph(buffer().params(), pl,
615 distance(pl.begin(), ins) - 1);
617 for_each(pit, plist.end(),
618 bind(&ParagraphList::push_back, ref(pl), _1));
622 void InsetText::addPreview(PreviewLoader & loader) const
624 ParagraphList::const_iterator pit = paragraphs().begin();
625 ParagraphList::const_iterator pend = paragraphs().end();
627 for (; pit != pend; ++pit) {
628 InsetList::const_iterator it = pit->insetList().begin();
629 InsetList::const_iterator end = pit->insetList().end();
630 for (; it != end; ++it)
631 it->inset->addPreview(loader);
636 ParagraphList const & InsetText::paragraphs() const
638 return text_.paragraphs();
642 ParagraphList & InsetText::paragraphs()
644 return text_.paragraphs();
648 void InsetText::updateLabels(ParIterator const & it)
650 ParIterator it2 = it;
652 LASSERT(&it2.inset() == this && it2.pit() == 0, return);
653 if (producesOutput())
654 buffer().updateLabels(it2);
656 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
657 Counters const savecnt = tclass.counters();
658 buffer().updateLabels(it2);
659 tclass.counters() = savecnt;
664 void InsetText::tocString(odocstream & os) const
666 if (!getLayout().isInToc())
668 os << text().asString(0, 1, AS_STR_LABEL | AS_STR_INSETS);
673 void InsetText::addToToc(DocIterator const & cdit)
675 DocIterator dit = cdit;
676 dit.push_back(CursorSlice(*this));
677 Toc & toc = buffer().tocBackend().toc("tableofcontents");
679 BufferParams const & bufparams = buffer_->params();
680 const int min_toclevel = bufparams.documentClass().min_toclevel();
682 // For each paragraph, traverse its insets and let them add
684 ParagraphList & pars = paragraphs();
685 pit_type pend = paragraphs().size();
686 for (pit_type pit = 0; pit != pend; ++pit) {
687 Paragraph const & par = pars[pit];
689 // the string that goes to the toc (could be the optarg)
691 InsetList::const_iterator it = par.insetList().begin();
692 InsetList::const_iterator end = par.insetList().end();
693 for (; it != end; ++it) {
694 Inset & inset = *it->inset;
696 //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
698 switch (inset.lyxCode()) {
700 if (!tocstring.empty())
703 Paragraph const & insetpar =
704 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
705 if (!par.labelString().empty())
706 tocstring = par.labelString() + ' ';
707 tocstring += insetpar.asString(AS_STR_INSETS);
714 // now the toc entry for the paragraph
715 int const toclevel = par.layout().toclevel;
716 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
718 // insert this into the table of contents
719 if (tocstring.empty())
720 tocstring = par.asString(AS_STR_LABEL | AS_STR_INSETS);
721 toc.push_back(TocItem(dit, toclevel - min_toclevel, tocstring));
724 // And now the list of changes.
725 par.addChangesToToc(dit, buffer());
730 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
732 if (buffer().isClean())
733 return Inset::notifyCursorLeaves(old, cur);
735 // find text inset in old cursor
736 Cursor insetCur = old;
737 int scriptSlice = insetCur.find(this);
738 LASSERT(scriptSlice != -1, /**/);
739 insetCur.cutOff(scriptSlice);
740 LASSERT(&insetCur.inset() == this, /**/);
742 // update the old paragraph's words
743 insetCur.paragraph().updateWords();
745 return Inset::notifyCursorLeaves(old, cur);
749 bool InsetText::completionSupported(Cursor const & cur) const
751 //LASSERT(&cur.bv().cursor().inset() != this, return false);
752 return text_.completionSupported(cur);
756 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
758 return completionSupported(cur);
762 bool InsetText::automaticInlineCompletion() const
764 return lyxrc.completion_inline_text;
768 bool InsetText::automaticPopupCompletion() const
770 return lyxrc.completion_popup_text;
774 bool InsetText::showCompletionCursor() const
776 return lyxrc.completion_cursor_text;
780 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
782 return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
786 docstring InsetText::completionPrefix(Cursor const & cur) const
788 if (!completionSupported(cur))
790 return text_.completionPrefix(cur);
794 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
797 if (!completionSupported(cur))
800 return text_.insertCompletion(cur, s, finished);
804 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
805 Dimension & dim) const
807 TextMetrics const & tm = cur.bv().textMetrics(&text_);
808 tm.completionPosAndDim(cur, x, y, dim);
812 docstring InsetText::contextMenu(BufferView const &, int, int) const
814 return from_ascii("context-edit");
818 InsetCaption const * InsetText::getCaptionInset() const
820 ParagraphList::const_iterator pit = paragraphs().begin();
821 for (; pit != paragraphs().end(); ++pit) {
822 InsetList::const_iterator it = pit->insetList().begin();
823 for (; it != pit->insetList().end(); ++it) {
824 Inset & inset = *it->inset;
825 if (inset.lyxCode() == CAPTION_CODE) {
826 InsetCaption const * ins =
827 static_cast<InsetCaption const *>(it->inset);
836 docstring InsetText::getCaptionText(OutputParams const & runparams) const
838 InsetCaption const * ins = getCaptionInset();
842 odocstringstream ods;
843 ins->getCaptionAsPlaintext(ods, runparams);
848 docstring InsetText::getCaptionHTML(OutputParams const & runparams) const
850 InsetCaption const * ins = getCaptionInset();
854 odocstringstream ods;
855 docstring def = ins->getCaptionAsHTML(ods, runparams);