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"
45 #include "frontends/Alert.h"
46 #include "frontends/font_metrics.h"
47 #include "frontends/LyXView.h"
48 #include "frontends/Painter.h"
50 #include "support/lyxalgo.h" // lyx::count
52 #include <boost/bind.hpp>
54 using bv_funcs::replaceSelection;
58 using lyx::graphics::PreviewLoader;
60 using lyx::support::isStrUnsignedInt;
61 using lyx::support::strToUnsignedInt;
72 InsetText::InsetText(BufferParams const & bp)
75 autoBreakRows_(false),
77 frame_color_(LColor::insetframe),
78 text_(0, this, true, paragraphs)
80 textwidth_ = 0; // broken
81 paragraphs.begin()->layout(bp.getLyXTextClass().defaultLayout());
82 if (bp.tracking_changes)
83 paragraphs.begin()->trackChanges();
88 InsetText::InsetText(InsetText const & in)
90 text_(in.text_.bv_owner, this, true, paragraphs)
97 void InsetText::operator=(InsetText const & in)
99 UpdatableInset::operator=(in);
100 paragraphs = in.paragraphs;
101 autoBreakRows_ = in.autoBreakRows_;
102 drawFrame_ = in.drawFrame_;
103 frame_color_ = in.frame_color_;
104 textwidth_ = in.textwidth_;
105 text_ = LyXText(in.text_.bv_owner, this, true, paragraphs);
110 void InsetText::init()
112 ParagraphList::iterator pit = paragraphs.begin();
113 ParagraphList::iterator end = paragraphs.end();
114 for (; pit != end; ++pit)
115 pit->setInsetOwner(this);
116 text_.paragraphs_ = ¶graphs;
119 in_insetAllowed = false;
125 void InsetText::clear(bool just_mark_erased)
127 if (just_mark_erased) {
128 ParagraphList::iterator it = paragraphs.begin();
129 ParagraphList::iterator end = paragraphs.end();
130 for (; it != end; ++it)
135 // This is a gross hack...
136 LyXLayout_ptr old_layout = paragraphs.begin()->layout();
139 paragraphs.push_back(Paragraph());
140 paragraphs.begin()->setInsetOwner(this);
141 paragraphs.begin()->layout(old_layout);
145 auto_ptr<InsetBase> InsetText::clone() const
147 return auto_ptr<InsetBase>(new InsetText(*this));
151 void InsetText::write(Buffer const & buf, ostream & os) const
154 writeParagraphData(buf, os);
158 void InsetText::writeParagraphData(Buffer const & buf, ostream & os) const
160 ParagraphList::const_iterator it = paragraphs.begin();
161 ParagraphList::const_iterator end = paragraphs.end();
162 Paragraph::depth_type dth = 0;
163 for (; it != end; ++it) {
164 it->write(buf, os, buf.params(), dth);
169 void InsetText::read(Buffer const & buf, LyXLex & lex)
172 Paragraph::depth_type depth = 0;
176 #warning John, look here. Doesnt make much sense.
177 if (buf.params().tracking_changes)
178 paragraphs.begin()->trackChanges();
180 // delete the initial paragraph
181 Paragraph oldpar = *paragraphs.begin();
183 ParagraphList::iterator pit = paragraphs.begin();
187 token = lex.getString();
190 if (token == "\\end_inset") {
194 if (token == "\\end_document") {
195 lex.printError("\\end_document read in inset! Error in document!");
200 const_cast<Buffer&>(buf).readParagraph(lex, token, paragraphs, pit, depth);
203 pit = paragraphs.begin();
204 ParagraphList::iterator const end = paragraphs.end();
205 for (; pit != end; ++pit)
206 pit->setInsetOwner(this);
208 if (token != "\\end_inset") {
209 lex.printError("Missing \\end_inset at this point. "
214 // ensure we have at least one par.
215 if (paragraphs.empty())
216 paragraphs.push_back(oldpar);
220 void InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
222 //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
223 textwidth_ = max(40, mi.base.textwidth - 30);
224 BufferView * bv = mi.base.bv;
226 text_.metrics(mi, dim);
227 dim.asc += TEXT_TO_INSET_OFFSET;
228 dim.des += TEXT_TO_INSET_OFFSET;
229 dim.wid += 2 * TEXT_TO_INSET_OFFSET;
234 int InsetText::textWidth() const
240 void InsetText::draw(PainterInfo & pi, int x, int y) const
242 // update our idea of where we are. Clearly, we should
243 // not have to know this information.
247 int const start_x = x;
249 BufferView * bv = pi.base.bv;
250 Painter & pain = pi.pain;
252 // repaint the background if needed
253 if (backgroundColor() != LColor::background)
254 clearInset(bv, start_x + TEXT_TO_INSET_OFFSET, y);
261 x += TEXT_TO_INSET_OFFSET;
263 paintTextInset(*bv, text_, x, y);
265 if (drawFrame_ == ALWAYS || drawFrame_ == LOCKED)
266 drawFrame(pain, start_x);
270 void InsetText::drawFrame(Painter & pain, int x) const
272 int const ttoD2 = TEXT_TO_INSET_OFFSET / 2;
273 int const frame_x = x + ttoD2;
274 int const frame_y = yo_ - dim_.asc + ttoD2;
275 int const frame_w = dim_.wid - TEXT_TO_INSET_OFFSET;
276 int const frame_h = dim_.asc + dim_.des - TEXT_TO_INSET_OFFSET;
277 pain.rectangle(frame_x, frame_y, frame_w, frame_h, frameColor());
281 void InsetText::updateLocal(BufferView * bv, bool /*mark_dirty*/)
286 if (!autoBreakRows_ && paragraphs.size() > 1)
287 collapseParagraphs(bv);
289 if (!text_.selection.set())
290 text_.selection.cursor = text_.cursor;
293 bv->owner()->view_state_changed();
294 bv->owner()->updateMenubar();
295 bv->owner()->updateToolbar();
296 if (old_par != text_.cursor.par()) {
297 bv->owner()->setLayout(cpar()->layout()->name());
298 old_par = text_.cursor.par();
303 string const InsetText::editMessage() const
305 return _("Opened Text Inset");
309 void InsetText::sanitizeEmptyText(BufferView * bv)
311 if (paragraphs.size() == 1
312 && paragraphs.begin()->empty()
313 && bv->getParentLanguage(this) != text_.current_font.language()) {
314 LyXFont font(LyXFont::ALL_IGNORE);
315 font.setLanguage(bv->getParentLanguage(this));
316 setFont(bv, font, false);
321 extern LCursor theTempCursor;
323 void InsetText::lfunMousePress(FuncRequest const & cmd)
325 lyxerr << "InsetText::lfunMousePress, inset: " << this << endl;
328 // use this to check mouse motion for selection
332 BufferView * bv = cmd.view();
333 no_selection = false;
334 text_.clearSelection();
337 bv->cursor() = theTempCursor;
338 lyxerr << "new global cursor: \n" << bv->cursor() << endl;
339 text_.setCursorFromCoordinates(cmd.x, cmd.y);
343 void InsetText::lfunMouseMotion(FuncRequest const & cmd)
345 lyxerr << "InsetText::lfunMouseMotion, inset: " << this << endl;
346 if (no_selection || (mouse_x == cmd.x && mouse_y == cmd.y))
349 BufferView * bv = cmd.view();
350 LyXCursor cur = text_.cursor;
351 text_.setCursorFromCoordinates(cmd.x, cmd.y + dim_.asc);
352 bv->x_target(text_.cursor.x());
353 if (cur != text_.cursor) {
354 text_.setSelection();
355 updateLocal(bv, false);
360 void InsetText::lfunMouseRelease(FuncRequest const &)
362 lyxerr << "InsetText::lfunMouseRelease, inset: " << this << endl;
367 void InsetText::edit(BufferView * bv, bool left)
369 lyxerr << "InsetText: edit left/right" << endl;
375 text_.setCursorIntern(0, 0);
377 text_.setCursor(paragraphs.size() - 1, paragraphs.back().size());
379 sanitizeEmptyText(bv);
380 updateLocal(bv, false);
381 bv->updateParagraphDialog();
385 void InsetText::edit(BufferView * bv, int x, int y)
387 lyxerr << "InsetText::edit xy" << endl;
389 sanitizeEmptyText(bv);
390 text_.setCursorFromCoordinates(x, y + dim_.asc);
391 text_.cursor.x(text_.cursor.x());
392 bv->x_target(text_.cursor.x());
394 text_.clearSelection();
397 updateLocal(bv, false);
398 bv->updateParagraphDialog();
402 DispatchResult InsetText::priv_dispatch(FuncRequest const & cmd,
403 idx_type &, pos_type &)
405 lyxerr << "InsetText::priv_dispatch (begin), act: "
406 << cmd.action << " " << endl;
407 BufferView * bv = cmd.view();
409 DispatchResult result;
410 result.dispatched(true);
412 bool was_empty = paragraphs.begin()->empty() && paragraphs.size() == 1;
413 if (cmd.action != LFUN_MOUSE_PRESS
414 && cmd.action != LFUN_MOUSE_MOTION
415 && cmd.action != LFUN_MOUSE_RELEASE)
416 no_selection = false;
418 switch (cmd.action) {
419 case LFUN_MOUSE_PRESS:
421 result = DispatchResult(true, true);
424 case LFUN_MOUSE_MOTION:
425 lfunMouseMotion(cmd);
426 result = DispatchResult(true, true);
429 case LFUN_MOUSE_RELEASE:
430 lfunMouseRelease(cmd);
431 result = DispatchResult(true, true);
434 case LFUN_SELFINSERT:
435 if (bv->buffer()->isReadonly()) {
436 // setErrorMessage(N_("Document is read only"));
439 if (!cmd.argument.empty()) {
440 /* Automatically delete the currently selected
441 * text and replace it with what is being
442 * typed in now. Depends on lyxrc settings
443 * "auto_region_delete", which defaults to
446 // This should not be needed here and is also WRONG!
447 recordUndo(bv, Undo::INSERT, text_.cursorPar());
451 if (lyxrc.auto_region_delete && text_.selection.set())
452 text_.cutSelection(false, false);
453 text_.clearSelection();
455 for (string::size_type i = 0; i < cmd.argument.length(); ++i)
456 bv->owner()->getIntl().getTransManager().
457 TranslateAndInsert(cmd.argument[i], &text_);
459 text_.selection.cursor = text_.cursor;
460 result.dispatched(true);
465 result = text_.moveRight();
471 result = text_.moveLeft();
476 result = text_.moveDown();
481 result = text_.moveUp();
485 if (crow() == text_.firstRow()) {
486 result.val(FINISHED_UP);
488 text_.cursorPrevious();
489 text_.clearSelection();
490 result.dispatched(true);
495 if (crow() == text_.lastRow()) {
496 result.val(FINISHED_DOWN);
499 text_.clearSelection();
500 result.dispatched(true);
505 if (text_.selection.set())
506 text_.cutSelection(true, false);
509 #warning should be also set dispatched here?
514 if (text_.selection.set())
515 text_.cutSelection(true, false);
518 #warning should be also set dispatched here?
522 case LFUN_BREAKPARAGRAPH:
523 if (!autoBreakRows_) {
524 result.dispatched(true);
527 replaceSelection(bv->getLyXText());
528 text_.breakParagraph(paragraphs, 0);
529 #warning should be also set dispatched here?
534 case LFUN_BREAKPARAGRAPHKEEPLAYOUT:
535 if (!autoBreakRows_) {
536 result.dispatched(true);
539 replaceSelection(bv->getLyXText());
540 text_.breakParagraph(paragraphs, 1);
541 #warning should be also set dispatched here?
546 case LFUN_BREAKLINE: {
547 if (!autoBreakRows_) {
548 result.dispatched(true);
551 replaceSelection(bv->getLyXText());
552 auto_ptr<InsetNewline> ins(new InsetNewline);
553 text_.insertInset(ins.release());
554 #warning should be also set dispatched here?
561 // do not set layouts on non breakable textinsets
562 if (autoBreakRows_) {
563 string cur_layout = cpar()->layout()->name();
565 // Derive layout number from given argument (string)
566 // and current buffer's textclass (number).
567 LyXTextClass const & tclass =
568 bv->buffer()->params().getLyXTextClass();
569 string layout = cmd.argument;
570 bool hasLayout = tclass.hasLayout(layout);
572 // If the entry is obsolete, use the new one instead.
574 string const & obs = tclass[layout]->obsoleted_by();
579 // see if we found the layout number:
581 FuncRequest lf(LFUN_MESSAGE, N_("Layout ") + cmd.argument + N_(" not known"));
582 bv->owner()->dispatch(lf);
586 if (cur_layout != layout) {
588 text_.setLayout(layout);
589 bv->owner()->setLayout(cpar()->layout()->name());
590 #warning should be also set dispatched here?
594 // reset the layout box
595 bv->owner()->setLayout(cpar()->layout()->name());
600 result = text_.dispatch(cmd);
604 /// If the action has deleted all text in the inset, we need to change the
605 // language to the language of the surronding text.
606 if (!was_empty && paragraphs.begin()->empty() &&
607 paragraphs.size() == 1) {
608 LyXFont font(LyXFont::ALL_IGNORE);
609 font.setLanguage(bv->getParentLanguage(this));
610 setFont(bv, font, false);
613 lyxerr << "InsetText::priv_dispatch (end)" << endl;
618 int InsetText::latex(Buffer const & buf, ostream & os,
619 OutputParams const & runparams) const
622 latexParagraphs(buf, paragraphs, os, texrow, runparams);
623 return texrow.rows();
627 int InsetText::plaintext(Buffer const & buf, ostream & os,
628 OutputParams const & runparams) const
630 ParagraphList::const_iterator beg = paragraphs.begin();
631 ParagraphList::const_iterator end = paragraphs.end();
632 ParagraphList::const_iterator it = beg;
633 for (; it != end; ++it)
634 asciiParagraph(buf, *it, os, runparams, it == beg);
636 //FIXME: Give the total numbers of lines
641 int InsetText::linuxdoc(Buffer const & buf, ostream & os,
642 OutputParams const & runparams) const
644 linuxdocParagraphs(buf, paragraphs, os, runparams);
649 int InsetText::docbook(Buffer const & buf, ostream & os,
650 OutputParams const & runparams) const
652 docbookParagraphs(buf, paragraphs, os, runparams);
657 void InsetText::validate(LaTeXFeatures & features) const
659 for_each(paragraphs.begin(), paragraphs.end(),
660 boost::bind(&Paragraph::validate, _1, boost::ref(features)));
664 void InsetText::getCursorPos(BufferView *, int & x, int & y) const
666 x = text_.cursor.x() + TEXT_TO_INSET_OFFSET;
667 y = text_.cursor.y() - dim_.asc + TEXT_TO_INSET_OFFSET;
671 int InsetText::insetInInsetY() const
677 bool InsetText::insertInset(BufferView * bv, InsetOld * inset)
679 inset->setOwner(this);
680 text_.insertInset(inset);
682 updateLocal(bv, true);
687 bool InsetText::insetAllowed(InsetOld::Code code) const
689 // in_insetAllowed is a really gross hack,
690 // to allow us to call the owner's insetAllowed
691 // without stack overflow, which can happen
692 // when the owner uses InsetCollapsable::insetAllowed()
696 in_insetAllowed = true;
698 ret = owner()->insetAllowed(code);
699 in_insetAllowed = false;
704 bool InsetText::showInsetDialog(BufferView *) const
710 void InsetText::getLabelList(Buffer const & buffer,
711 std::vector<string> & list) const
713 ParagraphList::const_iterator pit = paragraphs.begin();
714 ParagraphList::const_iterator pend = paragraphs.end();
715 for (; pit != pend; ++pit) {
716 InsetList::const_iterator beg = pit->insetlist.begin();
717 InsetList::const_iterator end = pit->insetlist.end();
718 for (; beg != end; ++beg)
719 beg->inset->getLabelList(buffer, list);
724 void InsetText::setFont(BufferView * bv, LyXFont const & font, bool toggleall,
727 if ((paragraphs.size() == 1 && paragraphs.begin()->empty())
728 || cpar()->empty()) {
729 text_.setFont(font, toggleall);
733 if (text_.selection.set())
734 text_.recUndo(text_.cursor.par());
738 text_.selection.cursor = text_.cursor;
739 text_.cursorBottom();
740 text_.setSelection();
743 text_.toggleFree(font, toggleall);
746 text_.clearSelection();
749 updateLocal(bv, true);
753 void InsetText::markNew(bool track_changes)
755 ParagraphList::iterator pit = paragraphs.begin();
756 ParagraphList::iterator end = paragraphs.end();
757 for (; pit != end; ++pit) {
761 // no-op when not tracking
768 void InsetText::setText(string const & data, LyXFont const & font)
771 for (unsigned int i = 0; i < data.length(); ++i)
772 paragraphs.begin()->insertChar(i, data[i], font);
776 void InsetText::setAutoBreakRows(bool flag)
778 if (flag != autoBreakRows_) {
779 autoBreakRows_ = flag;
786 void InsetText::setDrawFrame(DrawFrame how)
792 LColor_color InsetText::frameColor() const
794 return LColor::color(frame_color_);
798 void InsetText::setFrameColor(LColor_color col)
804 pos_type InsetText::cpos() const
806 return text_.cursor.pos();
810 ParagraphList::iterator InsetText::cpar() const
812 return text_.cursorPar();
816 RowList::iterator InsetText::crow() const
818 return cpar()->getRow(cpos());
822 void InsetText::setViewCache(BufferView const * bv) const
825 if (bv != text_.bv_owner) {
826 //lyxerr << "setting view cache from "
827 // << text_.bv_owner << " to " << bv << "\n";
828 text_.init(const_cast<BufferView *>(bv));
830 text_.bv_owner = const_cast<BufferView *>(bv);
835 void InsetText::removeNewlines()
837 ParagraphList::iterator it = paragraphs.begin();
838 ParagraphList::iterator end = paragraphs.end();
839 for (; it != end; ++it)
840 for (int i = 0; i < it->size(); ++i)
841 if (it->isNewline(i))
846 int InsetText::scroll(bool /*recursive*/) const
848 return UpdatableInset::scroll(false);
852 void InsetText::clearSelection(BufferView *)
854 text_.clearSelection();
858 void InsetText::clearInset(BufferView * bv, int start_x, int baseline) const
860 Painter & pain = bv->painter();
862 int h = dim_.asc + dim_.des;
863 int ty = baseline - dim_.asc;
869 if (ty + h > pain.paperHeight())
870 h = pain.paperHeight();
871 if (xo_ + w > pain.paperWidth())
872 w = pain.paperWidth();
873 pain.fillRectangle(start_x + 1, ty + 1, w - 3, h - 1, backgroundColor());
877 ParagraphList * InsetText::getParagraphs(int i) const
879 return (i == 0) ? const_cast<ParagraphList*>(¶graphs) : 0;
883 LyXText * InsetText::getText(int i) const
885 return (i == 0) ? const_cast<LyXText*>(&text_) : 0;
889 bool InsetText::checkInsertChar(LyXFont & font)
891 return owner() ? owner()->checkInsertChar(font) : true;
895 void InsetText::collapseParagraphs(BufferView * bv)
897 while (paragraphs.size() > 1) {
898 ParagraphList::iterator const first = paragraphs.begin();
899 ParagraphList::iterator second = first;
901 size_t const first_par_size = first->size();
903 if (!first->empty() &&
905 !first->isSeparator(first_par_size - 1)) {
906 first->insertChar(first_par_size, ' ');
909 #warning probably broken
910 if (text_.selection.set()) {
911 if (text_.selection.start.par() == 1) {
912 text_.selection.start.par(1);
913 text_.selection.start.pos(text_.selection.start.pos() + first_par_size);
915 if (text_.selection.end.par() == 2) {
916 text_.selection.end.par(1);
917 text_.selection.end.pos(text_.selection.end.pos() + first_par_size);
921 mergeParagraph(bv->buffer()->params(), paragraphs, first);
926 void InsetText::getDrawFont(LyXFont & font) const
929 owner()->getDrawFont(font);
933 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
935 #warning FIXME Check if Changes stuff needs changing here. (Lgb)
936 // And it probably does. You have to take a look at this John. (Lgb)
937 #warning John, have a look here. (Lgb)
938 ParagraphList::iterator pit = plist.begin();
939 ParagraphList::iterator ins = paragraphs.insert(paragraphs.end(), *pit);
941 mergeParagraph(buffer->params(), paragraphs, boost::prior(ins));
943 ParagraphList::iterator pend = plist.end();
944 for (; pit != pend; ++pit)
945 paragraphs.push_back(*pit);
949 void InsetText::addPreview(PreviewLoader & loader) const
951 ParagraphList::const_iterator pit = paragraphs.begin();
952 ParagraphList::const_iterator pend = paragraphs.end();
954 for (; pit != pend; ++pit) {
955 InsetList::const_iterator it = pit->insetlist.begin();
956 InsetList::const_iterator end = pit->insetlist.end();
957 for (; it != end; ++it)
958 it->inset->addPreview(loader);