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"
14 #include "insetnewline.h"
17 #include "bufferparams.h"
18 #include "BufferView.h"
19 #include "CutAndPaste.h"
22 #include "dispatchresult.h"
23 #include "errorlist.h"
24 #include "funcrequest.h"
32 #include "metricsinfo.h"
33 #include "output_docbook.h"
34 #include "output_latex.h"
35 #include "output_linuxdoc.h"
36 #include "output_plaintext.h"
37 #include "paragraph.h"
38 #include "paragraph_funcs.h"
39 #include "ParagraphParameters.h"
40 #include "rowpainter.h"
46 #include "frontends/Alert.h"
47 #include "frontends/font_metrics.h"
48 #include "frontends/LyXView.h"
49 #include "frontends/Painter.h"
51 #include "support/lyxalgo.h" // lyx::count
53 #include <boost/bind.hpp>
55 using bv_funcs::replaceSelection;
59 using lyx::graphics::PreviewLoader;
61 using lyx::support::isStrUnsignedInt;
62 using lyx::support::strToUnsignedInt;
73 InsetText::InsetText(BufferParams const & bp)
76 autoBreakRows_(false),
78 frame_color_(LColor::insetframe),
79 text_(0, this, true, paragraphs)
81 textwidth_ = 0; // broken
82 paragraphs.begin()->layout(bp.getLyXTextClass().defaultLayout());
83 if (bp.tracking_changes)
84 paragraphs.begin()->trackChanges();
89 InsetText::InsetText(InsetText const & in)
91 text_(in.text_.bv_owner, this, true, paragraphs)
98 void InsetText::operator=(InsetText const & in)
100 UpdatableInset::operator=(in);
101 paragraphs = in.paragraphs;
102 autoBreakRows_ = in.autoBreakRows_;
103 drawFrame_ = in.drawFrame_;
104 frame_color_ = in.frame_color_;
105 textwidth_ = in.textwidth_;
106 text_ = LyXText(in.text_.bv_owner, this, true, paragraphs);
111 void InsetText::init()
113 ParagraphList::iterator pit = paragraphs.begin();
114 ParagraphList::iterator end = paragraphs.end();
115 for (; pit != end; ++pit)
116 pit->setInsetOwner(this);
117 text_.paragraphs_ = ¶graphs;
119 in_insetAllowed = false;
123 void InsetText::clear(bool just_mark_erased)
125 if (just_mark_erased) {
126 ParagraphList::iterator it = paragraphs.begin();
127 ParagraphList::iterator end = paragraphs.end();
128 for (; it != end; ++it)
133 // This is a gross hack...
134 LyXLayout_ptr old_layout = paragraphs.begin()->layout();
137 paragraphs.push_back(Paragraph());
138 paragraphs.begin()->setInsetOwner(this);
139 paragraphs.begin()->layout(old_layout);
143 auto_ptr<InsetBase> InsetText::clone() const
145 return auto_ptr<InsetBase>(new InsetText(*this));
149 void InsetText::write(Buffer const & buf, ostream & os) const
152 writeParagraphData(buf, os);
156 void InsetText::writeParagraphData(Buffer const & buf, ostream & os) const
158 ParagraphList::const_iterator it = paragraphs.begin();
159 ParagraphList::const_iterator end = paragraphs.end();
160 Paragraph::depth_type dth = 0;
161 for (; it != end; ++it) {
162 it->write(buf, os, buf.params(), dth);
167 void InsetText::read(Buffer const & buf, LyXLex & lex)
170 Paragraph::depth_type depth = 0;
174 #warning John, look here. Doesnt make much sense.
175 if (buf.params().tracking_changes)
176 paragraphs.begin()->trackChanges();
178 // delete the initial paragraph
179 Paragraph oldpar = *paragraphs.begin();
181 ParagraphList::iterator pit = paragraphs.begin();
185 token = lex.getString();
188 if (token == "\\end_inset") {
192 if (token == "\\end_document") {
193 lex.printError("\\end_document read in inset! Error in document!");
198 const_cast<Buffer&>(buf).readParagraph(lex, token, paragraphs, pit, depth);
201 pit = paragraphs.begin();
202 ParagraphList::iterator const end = paragraphs.end();
203 for (; pit != end; ++pit)
204 pit->setInsetOwner(this);
206 if (token != "\\end_inset") {
207 lex.printError("Missing \\end_inset at this point. "
212 // ensure we have at least one par.
213 if (paragraphs.empty())
214 paragraphs.push_back(oldpar);
218 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
220 //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
221 textwidth_ = mi.base.textwidth;
222 mi.base.textwidth -= 2 * TEXT_TO_INSET_OFFSET;
223 setViewCache(mi.base.bv);
224 text_.metrics(mi, dim);
225 dim.asc += TEXT_TO_INSET_OFFSET;
226 dim.des += TEXT_TO_INSET_OFFSET;
227 dim.wid += 2 * TEXT_TO_INSET_OFFSET;
228 mi.base.textwidth += 2 * TEXT_TO_INSET_OFFSET;
233 void InsetText::draw(PainterInfo & pi, int x, int y) const
235 // update our idea of where we are
239 BufferView * bv = pi.base.bv;
240 Painter & pain = pi.pain;
242 // repaint the background if needed
243 if (backgroundColor() != LColor::background)
244 clearInset(bv, xo_ + TEXT_TO_INSET_OFFSET, y);
251 x += TEXT_TO_INSET_OFFSET;
252 y += bv->top_y() - text_.firstRow()->ascent_of_text();
256 paintTextInset(*bv, text_, x, y);
258 if (drawFrame_ == ALWAYS || drawFrame_ == LOCKED)
259 drawFrame(pain, xo_);
263 void InsetText::drawFrame(Painter & pain, int x) const
265 int const ttoD2 = TEXT_TO_INSET_OFFSET / 2;
266 int const frame_x = x + ttoD2;
267 int const frame_y = yo_ - dim_.asc + ttoD2;
268 int const frame_w = dim_.wid - TEXT_TO_INSET_OFFSET;
269 int const frame_h = dim_.asc + dim_.des - TEXT_TO_INSET_OFFSET;
270 pain.rectangle(frame_x, frame_y, frame_w, frame_h, frameColor());
274 void InsetText::updateLocal(BufferView * bv, bool /*mark_dirty*/)
279 if (!autoBreakRows_ && paragraphs.size() > 1)
280 collapseParagraphs(bv);
282 if (!text_.selection.set())
283 text_.selection.cursor = text_.cursor;
285 bv->owner()->view_state_changed();
286 bv->owner()->updateMenubar();
287 bv->owner()->updateToolbar();
288 if (old_par != text_.cursor.par()) {
289 bv->owner()->setLayout(cpar()->layout()->name());
290 old_par = text_.cursor.par();
295 string const InsetText::editMessage() const
297 return _("Opened Text Inset");
301 void InsetText::sanitizeEmptyText(BufferView * bv)
303 if (paragraphs.size() == 1
304 && paragraphs.begin()->empty()
305 && bv->getParentLanguage(this) != text_.current_font.language()) {
306 LyXFont font(LyXFont::ALL_IGNORE);
307 font.setLanguage(bv->getParentLanguage(this));
308 text_.setFont(font, false);
313 extern LCursor theTempCursor;
316 void InsetText::edit(BufferView * bv, bool left)
318 lyxerr << "InsetText: edit left/right" << endl;
324 text_.setCursorIntern(0, 0);
326 text_.setCursor(paragraphs.size() - 1, paragraphs.back().size());
328 sanitizeEmptyText(bv);
329 updateLocal(bv, false);
330 bv->updateParagraphDialog();
334 void InsetText::edit(BufferView * bv, int x, int y)
336 lyxerr << "InsetText::edit xy" << endl;
338 sanitizeEmptyText(bv);
339 text_.setCursorFromCoordinates(x - text_.xo_, y + bv->top_y()
341 text_.clearSelection();
344 updateLocal(bv, false);
345 bv->updateParagraphDialog();
349 DispatchResult InsetText::priv_dispatch(FuncRequest const & cmd,
350 idx_type &, pos_type &)
352 lyxerr << "InsetText::priv_dispatch (begin), act: "
353 << cmd.action << " " << endl;
355 BufferView * bv = cmd.view();
358 DispatchResult result;
359 result.dispatched(true);
361 bool was_empty = paragraphs.begin()->empty() && paragraphs.size() == 1;
363 switch (cmd.action) {
364 case LFUN_MOUSE_PRESS:
365 bv->cursor() = theTempCursor;
368 result = text_.dispatch(cmd);
372 // If the action has deleted all text in the inset, we need
373 // to change the language to the language of the surronding
375 if (!was_empty && paragraphs.begin()->empty() &&
376 paragraphs.size() == 1) {
377 LyXFont font(LyXFont::ALL_IGNORE);
378 font.setLanguage(bv->getParentLanguage(this));
379 text_.setFont(font, false);
382 lyxerr << "InsetText::priv_dispatch (end)" << endl;
387 int InsetText::latex(Buffer const & buf, ostream & os,
388 OutputParams const & runparams) const
391 latexParagraphs(buf, paragraphs, os, texrow, runparams);
392 return texrow.rows();
396 int InsetText::plaintext(Buffer const & buf, ostream & os,
397 OutputParams const & runparams) const
399 ParagraphList::const_iterator beg = paragraphs.begin();
400 ParagraphList::const_iterator end = paragraphs.end();
401 ParagraphList::const_iterator it = beg;
402 for (; it != end; ++it)
403 asciiParagraph(buf, *it, os, runparams, it == beg);
405 //FIXME: Give the total numbers of lines
410 int InsetText::linuxdoc(Buffer const & buf, ostream & os,
411 OutputParams const & runparams) const
413 linuxdocParagraphs(buf, paragraphs, os, runparams);
418 int InsetText::docbook(Buffer const & buf, ostream & os,
419 OutputParams const & runparams) const
421 docbookParagraphs(buf, paragraphs, os, runparams);
426 void InsetText::validate(LaTeXFeatures & features) const
428 for_each(paragraphs.begin(), paragraphs.end(),
429 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
433 void InsetText::getCursorPos(int & x, int & y) const
435 x = text_.cursor.x() + TEXT_TO_INSET_OFFSET;
436 y = text_.cursor.y() - dim_.asc + TEXT_TO_INSET_OFFSET;
440 int InsetText::insetInInsetY() const
446 bool InsetText::insertInset(BufferView * bv, InsetOld * inset)
448 inset->setOwner(this);
449 text_.insertInset(inset);
450 updateLocal(bv, true);
455 bool InsetText::insetAllowed(InsetOld::Code code) const
457 // in_insetAllowed is a really gross hack,
458 // to allow us to call the owner's insetAllowed
459 // without stack overflow, which can happen
460 // when the owner uses InsetCollapsable::insetAllowed()
464 in_insetAllowed = true;
466 ret = owner()->insetAllowed(code);
467 in_insetAllowed = false;
472 bool InsetText::showInsetDialog(BufferView *) const
478 void InsetText::getLabelList(Buffer const & buffer,
479 std::vector<string> & list) const
481 ParagraphList::const_iterator pit = paragraphs.begin();
482 ParagraphList::const_iterator pend = paragraphs.end();
483 for (; pit != pend; ++pit) {
484 InsetList::const_iterator beg = pit->insetlist.begin();
485 InsetList::const_iterator end = pit->insetlist.end();
486 for (; beg != end; ++beg)
487 beg->inset->getLabelList(buffer, list);
492 void InsetText::markNew(bool track_changes)
494 ParagraphList::iterator pit = paragraphs.begin();
495 ParagraphList::iterator end = paragraphs.end();
496 for (; pit != end; ++pit) {
500 // no-op when not tracking
507 void InsetText::setText(string const & data, LyXFont const & font)
510 for (unsigned int i = 0; i < data.length(); ++i)
511 paragraphs.begin()->insertChar(i, data[i], font);
515 void InsetText::setAutoBreakRows(bool flag)
517 if (flag != autoBreakRows_) {
518 autoBreakRows_ = flag;
525 void InsetText::setDrawFrame(DrawFrame how)
531 LColor_color InsetText::frameColor() const
533 return LColor::color(frame_color_);
537 void InsetText::setFrameColor(LColor_color col)
543 pos_type InsetText::cpos() const
545 return text_.cursor.pos();
549 ParagraphList::iterator InsetText::cpar() const
551 return text_.cursorPar();
555 RowList::iterator InsetText::crow() const
557 return cpar()->getRow(cpos());
561 void InsetText::setViewCache(BufferView const * bv) const
563 if (bv && bv != text_.bv_owner) {
564 //lyxerr << "setting view cache from "
565 // << text_.bv_owner << " to " << bv << "\n";
566 text_.bv_owner = const_cast<BufferView *>(bv);
571 void InsetText::removeNewlines()
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))
582 int InsetText::scroll(bool /*recursive*/) const
584 return UpdatableInset::scroll(false);
588 void InsetText::clearSelection(BufferView *)
590 text_.clearSelection();
594 void InsetText::clearInset(BufferView * bv, int x, int y) const
596 Painter & pain = bv->painter();
598 int h = dim_.asc + dim_.des;
599 int ty = y - dim_.asc;
605 if (ty + h > pain.paperHeight())
606 h = pain.paperHeight();
607 if (xo_ + w > pain.paperWidth())
608 w = pain.paperWidth();
609 pain.fillRectangle(x + 1, ty + 1, w - 3, h - 1, backgroundColor());
613 ParagraphList * InsetText::getParagraphs(int i) const
615 return (i == 0) ? const_cast<ParagraphList*>(¶graphs) : 0;
619 LyXText * InsetText::getText(int i) const
621 return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
625 bool InsetText::checkInsertChar(LyXFont & font)
627 return owner() ? owner()->checkInsertChar(font) : true;
631 void InsetText::collapseParagraphs(BufferView * bv)
633 while (paragraphs.size() > 1) {
634 ParagraphList::iterator const first = paragraphs.begin();
635 ParagraphList::iterator second = first;
637 size_t const first_par_size = first->size();
639 if (!first->empty() &&
641 !first->isSeparator(first_par_size - 1)) {
642 first->insertChar(first_par_size, ' ');
645 #warning probably broken
646 if (text_.selection.set()) {
647 if (text_.selection.start.par() == 1) {
648 text_.selection.start.par(1);
649 text_.selection.start.pos(text_.selection.start.pos() + first_par_size);
651 if (text_.selection.end.par() == 2) {
652 text_.selection.end.par(1);
653 text_.selection.end.pos(text_.selection.end.pos() + first_par_size);
657 mergeParagraph(bv->buffer()->params(), paragraphs, first);
662 void InsetText::getDrawFont(LyXFont & font) const
665 owner()->getDrawFont(font);
669 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
671 #warning FIXME Check if Changes stuff needs changing here. (Lgb)
672 // And it probably does. You have to take a look at this John. (Lgb)
673 #warning John, have a look here. (Lgb)
674 ParagraphList::iterator pit = plist.begin();
675 ParagraphList::iterator ins = paragraphs.insert(paragraphs.end(), *pit);
677 mergeParagraph(buffer->params(), paragraphs, boost::prior(ins));
679 ParagraphList::iterator pend = plist.end();
680 for (; pit != pend; ++pit)
681 paragraphs.push_back(*pit);
685 void InsetText::addPreview(PreviewLoader & loader) const
687 ParagraphList::const_iterator pit = paragraphs.begin();
688 ParagraphList::const_iterator pend = paragraphs.end();
690 for (; pit != pend; ++pit) {
691 InsetList::const_iterator it = pit->insetlist.begin();
692 InsetList::const_iterator end = pit->insetlist.end();
693 for (; it != end; ++it)
694 it->inset->addPreview(loader);