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 "InsetList.h"
34 #include "MetricsInfo.h"
35 #include "output_docbook.h"
36 #include "output_latex.h"
37 #include "OutputParams.h"
38 #include "output_plaintext.h"
39 #include "paragraph_funcs.h"
40 #include "Paragraph.h"
41 #include "ParagraphParameters.h"
42 #include "ParIterator.h"
46 #include "TextClass.h"
48 #include "TextMetrics.h"
49 #include "TocBackend.h"
51 #include "frontends/alert.h"
52 #include "frontends/Painter.h"
54 #include "support/debug.h"
55 #include "support/gettext.h"
56 #include "support/lstrings.h"
58 #include <boost/bind.hpp>
59 #include "support/lassert.h"
62 using namespace lyx::support;
69 using graphics::PreviewLoader;
72 /////////////////////////////////////////////////////////////////////
74 InsetText::InsetText(Buffer const & buf, UsePlain type)
75 : drawFrame_(false), frame_color_(Color_insetframe)
77 setBuffer(const_cast<Buffer &>(buf));
82 InsetText::InsetText(InsetText const & in)
85 text_.autoBreakRows_ = in.text_.autoBreakRows_;
86 drawFrame_ = in.drawFrame_;
87 frame_color_ = in.frame_color_;
88 text_.paragraphs() = in.text_.paragraphs();
93 void InsetText::setBuffer(Buffer & buf)
95 ParagraphList::iterator end = paragraphs().end();
96 for (ParagraphList::iterator it = paragraphs().begin(); it != end; ++it)
98 Inset::setBuffer(buf);
102 void InsetText::initParagraphs(UsePlain type)
104 LASSERT(paragraphs().empty(), /**/);
105 paragraphs().push_back(Paragraph());
106 Paragraph & ourpar = paragraphs().back();
107 ourpar.setInsetOwner(this);
108 DocumentClass const & dc = buffer_->params().documentClass();
109 if (type == DefaultLayout)
110 ourpar.setDefaultLayout(dc);
112 ourpar.setPlainLayout(dc);
116 void InsetText::setParagraphOwner()
118 for_each(paragraphs().begin(), paragraphs().end(),
119 bind(&Paragraph::setInsetOwner, _1, this));
123 void InsetText::clear()
125 ParagraphList & pars = paragraphs();
126 LASSERT(!pars.empty(), /**/);
128 // This is a gross hack...
129 Layout const & old_layout = pars.begin()->layout();
132 pars.push_back(Paragraph());
133 pars.begin()->setInsetOwner(this);
134 pars.begin()->setLayout(old_layout);
138 Dimension const InsetText::dimension(BufferView const & bv) const
140 TextMetrics const & tm = bv.textMetrics(&text_);
141 Dimension dim = tm.dimension();
142 dim.wid += 2 * TEXT_TO_INSET_OFFSET;
143 dim.des += TEXT_TO_INSET_OFFSET;
144 dim.asc += TEXT_TO_INSET_OFFSET;
149 void InsetText::write(ostream & os) const
152 text_.write(buffer(), os);
156 void InsetText::read(Lexer & lex)
160 // delete the initial paragraph
161 Paragraph oldpar = *paragraphs().begin();
162 paragraphs().clear();
164 lex.setContext("InsetText::read");
165 bool res = text_.read(buffer(), lex, errorList, this);
168 lex.printError("Missing \\end_inset at this point. ");
171 // ensure we have at least one paragraph.
172 if (paragraphs().empty())
173 paragraphs().push_back(oldpar);
177 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
179 TextMetrics & tm = mi.base.bv->textMetrics(&text_);
181 //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
183 // Hand font through to contained lyxtext:
184 tm.font_.fontInfo() = mi.base.font;
185 mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
187 tm.metrics(mi, dim, mi.base.textwidth);
190 mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
191 dim.asc += TEXT_TO_INSET_OFFSET;
192 dim.des += TEXT_TO_INSET_OFFSET;
193 dim.wid += 2 * TEXT_TO_INSET_OFFSET;
197 void InsetText::draw(PainterInfo & pi, int x, int y) const
199 TextMetrics & tm = pi.base.bv->textMetrics(&text_);
201 if (drawFrame_ || pi.full_repaint) {
202 int const w = tm.width() + TEXT_TO_INSET_OFFSET;
203 int const yframe = y - TEXT_TO_INSET_OFFSET - tm.ascent();
204 int const h = tm.height() + 2 * TEXT_TO_INSET_OFFSET;
205 int const xframe = x + TEXT_TO_INSET_OFFSET / 2;
207 pi.pain.fillRectangle(xframe, yframe, w, h,
208 pi.backgroundColor(this));
211 pi.pain.rectangle(xframe, yframe, w, h, frameColor());
213 ColorCode const old_color = pi.background_color;
214 pi.background_color = pi.backgroundColor(this, false);
216 tm.draw(pi, x + TEXT_TO_INSET_OFFSET, y);
218 pi.background_color = old_color;
222 docstring InsetText::editMessage() const
224 return _("Opened Text Inset");
228 void InsetText::edit(Cursor & cur, bool front, EntryDirection entry_from)
230 pit_type const pit = front ? 0 : paragraphs().size() - 1;
231 pos_type pos = front ? 0 : paragraphs().back().size();
233 // if visual information is not to be ignored, move to extreme right/left
234 if (entry_from != ENTRY_DIRECTION_IGNORE) {
235 Cursor temp_cur = cur;
236 temp_cur.pit() = pit;
237 temp_cur.pos() = pos;
238 temp_cur.posVisToRowExtremity(entry_from == ENTRY_DIRECTION_LEFT);
239 pos = temp_cur.pos();
242 text_.setCursor(cur.top(), pit, pos);
243 cur.clearSelection();
248 Inset * InsetText::editXY(Cursor & cur, int x, int y)
250 return cur.bv().textMetrics(&text_).editXY(cur, x, y);
254 void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
256 LYXERR(Debug::ACTION, "InsetText::doDispatch()"
257 << " [ cmd.action = " << cmd.action << ']');
259 // Dispatch only to text_ if the cursor is inside
260 // the text_. It is not for context menus (bug 5797).
261 if (cur.text() == &text_)
262 text_.dispatch(cur, cmd);
264 //FIXME we probably also want to dispatch to Inset when
265 //text_ could do nothing with the FuncRequest.
266 Inset::doDispatch(cur, cmd);
270 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
271 FuncStatus & status) const
273 switch (cmd.action) {
275 status.setEnabled(!forcePlainLayout());
278 case LFUN_LAYOUT_PARAGRAPH:
279 case LFUN_PARAGRAPH_PARAMS:
280 case LFUN_PARAGRAPH_PARAMS_APPLY:
281 case LFUN_PARAGRAPH_SPACING:
282 case LFUN_PARAGRAPH_UPDATE:
283 status.setEnabled(allowParagraphCustomization());
286 // Dispatch only to text_ if the cursor is inside
287 // the text_. It is not for context menus (bug 5797).
288 if (cur.text() == &text_)
289 return text_.getStatus(cur, cmd, status);
291 return Inset::getStatus(cur, cmd, status);
296 void InsetText::setChange(Change const & change)
298 ParagraphList::iterator pit = paragraphs().begin();
299 ParagraphList::iterator end = paragraphs().end();
300 for (; pit != end; ++pit) {
301 pit->setChange(change);
306 void InsetText::acceptChanges(BufferParams const & bparams)
308 text_.acceptChanges(bparams);
312 void InsetText::rejectChanges(BufferParams const & bparams)
314 text_.rejectChanges(bparams);
318 int InsetText::latex(odocstream & os, OutputParams const & runparams) const
321 latexParagraphs(buffer(), text_, os, texrow, runparams);
322 return texrow.rows();
326 int InsetText::plaintext(odocstream & os, OutputParams const & runparams) const
328 ParagraphList::const_iterator beg = paragraphs().begin();
329 ParagraphList::const_iterator end = paragraphs().end();
330 ParagraphList::const_iterator it = beg;
331 bool ref_printed = false;
333 for (; it != end; ++it) {
336 if (runparams.linelen > 0)
339 odocstringstream oss;
340 writePlaintextParagraph(buffer(), *it, oss, runparams, ref_printed);
341 docstring const str = oss.str();
343 // FIXME: len is not computed fully correctly; in principle,
344 // we have to count the characters after the last '\n'
352 int InsetText::docbook(odocstream & os, OutputParams const & runparams) const
354 docbookParagraphs(paragraphs(), buffer(), os, runparams);
359 void InsetText::validate(LaTeXFeatures & features) const
361 for_each(paragraphs().begin(), paragraphs().end(),
362 bind(&Paragraph::validate, _1, ref(features)));
366 void InsetText::cursorPos(BufferView const & bv,
367 CursorSlice const & sl, bool boundary, int & x, int & y) const
369 x = bv.textMetrics(&text_).cursorX(sl, boundary) + TEXT_TO_INSET_OFFSET;
370 y = bv.textMetrics(&text_).cursorY(sl, boundary);
374 bool InsetText::showInsetDialog(BufferView *) const
380 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
383 Paragraph & first = paragraphs().front();
384 for (unsigned int i = 0; i < data.length(); ++i)
385 first.insertChar(i, data[i], font, trackChanges);
389 void InsetText::setAutoBreakRows(bool flag)
391 if (flag == text_.autoBreakRows_)
394 text_.autoBreakRows_ = flag;
398 // remove previously existing newlines
399 ParagraphList::iterator it = paragraphs().begin();
400 ParagraphList::iterator end = paragraphs().end();
401 for (; it != end; ++it)
402 for (int i = 0; i < it->size(); ++i)
403 if (it->isNewline(i))
404 // do not track the change, because the user
405 // is not allowed to revert/reject it
406 it->eraseChar(i, false);
410 void InsetText::setDrawFrame(bool flag)
416 ColorCode InsetText::frameColor() const
422 void InsetText::setFrameColor(ColorCode col)
428 void InsetText::appendParagraphs(ParagraphList & plist)
430 // There is little we can do here to keep track of changes.
431 // As of 2006/10/20, appendParagraphs is used exclusively by
432 // LyXTabular::setMultiColumn. In this context, the paragraph break
433 // is lost irreversibly and the appended text doesn't really change
435 ParagraphList & pl = paragraphs();
437 ParagraphList::iterator pit = plist.begin();
438 ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
440 mergeParagraph(buffer().params(), pl,
441 distance(pl.begin(), ins) - 1);
443 for_each(pit, plist.end(),
444 bind(&ParagraphList::push_back, ref(pl), _1));
448 void InsetText::addPreview(PreviewLoader & loader) const
450 ParagraphList::const_iterator pit = paragraphs().begin();
451 ParagraphList::const_iterator pend = paragraphs().end();
453 for (; pit != pend; ++pit) {
454 InsetList::const_iterator it = pit->insetList().begin();
455 InsetList::const_iterator end = pit->insetList().end();
456 for (; it != end; ++it)
457 it->inset->addPreview(loader);
462 ParagraphList const & InsetText::paragraphs() const
464 return text_.paragraphs();
468 ParagraphList & InsetText::paragraphs()
470 return text_.paragraphs();
474 void InsetText::updateLabels(ParIterator const & it)
476 ParIterator it2 = it;
478 LASSERT(&it2.inset() == this && it2.pit() == 0, return);
479 if (producesOutput()) {
480 buffer().updateLabels(it2);
482 DocumentClass const & tclass = buffer().masterBuffer()->params().documentClass();
483 Counters const savecnt = tclass.counters();
484 buffer().updateLabels(it2);
485 tclass.counters() = savecnt;
490 void InsetText::addToToc(DocIterator const & cdit)
492 DocIterator dit = cdit;
493 dit.push_back(CursorSlice(*this));
494 Toc & toc = buffer().tocBackend().toc("tableofcontents");
496 BufferParams const & bufparams = buffer_->params();
497 const int min_toclevel = bufparams.documentClass().min_toclevel();
499 // For each paragraph, traverse its insets and let them add
501 ParagraphList & pars = paragraphs();
502 pit_type pend = paragraphs().size();
503 for (pit_type pit = 0; pit != pend; ++pit) {
504 Paragraph const & par = pars[pit];
506 // the string that goes to the toc (could be the optarg)
508 InsetList::const_iterator it = par.insetList().begin();
509 InsetList::const_iterator end = par.insetList().end();
510 for (; it != end; ++it) {
511 Inset & inset = *it->inset;
513 //lyxerr << (void*)&inset << " code: " << inset.lyxCode() << std::endl;
515 switch (inset.lyxCode()) {
517 if (!tocstring.empty())
520 Paragraph const & insetpar =
521 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
522 if (!par.labelString().empty())
523 tocstring = par.labelString() + ' ';
524 tocstring += insetpar.asString(AS_STR_INSETS);
531 /// now the toc entry for the paragraph
532 int const toclevel = par.layout().toclevel;
533 if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel) {
535 // insert this into the table of contents
536 if (tocstring.empty())
537 tocstring = par.asString(AS_STR_LABEL | AS_STR_INSETS);
538 toc.push_back(TocItem(dit, toclevel - min_toclevel, tocstring));
541 // And now the list of changes.
542 par.addChangesToToc(dit, buffer());
547 bool InsetText::notifyCursorLeaves(Cursor const & old, Cursor & cur)
549 if (buffer().isClean())
550 return Inset::notifyCursorLeaves(old, cur);
552 // find text inset in old cursor
553 Cursor insetCur = old;
554 int scriptSlice = insetCur.find(this);
555 LASSERT(scriptSlice != -1, /**/);
556 insetCur.cutOff(scriptSlice);
557 LASSERT(&insetCur.inset() == this, /**/);
559 // update the old paragraph's words
560 insetCur.paragraph().updateWords(insetCur.top());
562 return Inset::notifyCursorLeaves(old, cur);
566 bool InsetText::completionSupported(Cursor const & cur) const
568 //LASSERT(&cur.bv().cursor().inset() != this, return false);
569 return text_.completionSupported(cur);
573 bool InsetText::inlineCompletionSupported(Cursor const & cur) const
575 return completionSupported(cur);
579 bool InsetText::automaticInlineCompletion() const
581 return lyxrc.completion_inline_text;
585 bool InsetText::automaticPopupCompletion() const
587 return lyxrc.completion_popup_text;
591 bool InsetText::showCompletionCursor() const
593 return lyxrc.completion_cursor_text;
597 CompletionList const * InsetText::createCompletionList(Cursor const & cur) const
599 return completionSupported(cur) ? text_.createCompletionList(cur) : 0;
603 docstring InsetText::completionPrefix(Cursor const & cur) const
605 if (!completionSupported(cur))
607 return text_.completionPrefix(cur);
611 bool InsetText::insertCompletion(Cursor & cur, docstring const & s,
614 if (!completionSupported(cur))
617 return text_.insertCompletion(cur, s, finished);
621 void InsetText::completionPosAndDim(Cursor const & cur, int & x, int & y,
622 Dimension & dim) const
624 TextMetrics const & tm = cur.bv().textMetrics(&text_);
625 tm.completionPosAndDim(cur, x, y, dim);
629 docstring InsetText::contextMenu(BufferView const &, int, int) const
631 return from_ascii("context-edit");