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 "buffer_funcs.h"
18 #include "BufferParams.h"
19 #include "BufferView.h"
20 #include "CoordCache.h"
21 #include "CutAndPaste.h"
24 #include "DispatchResult.h"
25 #include "ErrorList.h"
26 #include "FuncRequest.h"
34 #include "MetricsInfo.h"
35 #include "OutputParams.h"
36 #include "output_docbook.h"
37 #include "output_latex.h"
38 #include "output_plaintext.h"
39 #include "Paragraph.h"
40 #include "paragraph_funcs.h"
41 #include "ParagraphParameters.h"
42 #include "ParIterator.h"
48 #include "frontends/alert.h"
49 #include "frontends/Painter.h"
51 #include "support/lyxalgo.h" // count
53 #include <boost/bind.hpp>
54 #include <boost/current_function.hpp>
55 #include <boost/signal.hpp>
62 using graphics::PreviewLoader;
64 using support::isStrUnsignedInt;
77 int InsetText::border_ = 2;
80 InsetText::InsetText(BufferParams const & bp)
81 : drawFrame_(false), frame_color_(Color::insetframe)
83 paragraphs().push_back(Paragraph());
84 paragraphs().back().layout(bp.getTextClass().defaultLayout());
85 // Dispose of the infamous L-shaped cursor.
86 text_.current_font.setLanguage(bp.language);
87 text_.real_current_font.setLanguage(bp.language);
92 InsetText::InsetText(InsetText const & in)
95 text_.autoBreakRows_ = in.text_.autoBreakRows_;
96 drawFrame_ = in.drawFrame_;
97 frame_color_ = in.frame_color_;
98 text_.paragraphs() = in.text_.paragraphs();
99 // Hand current buffer language down to "cloned" textinsets
100 // e.g. tabular cells
101 text_.current_font = in.text_.current_font;
102 text_.real_current_font = in.text_.real_current_font;
107 InsetText::InsetText()
111 void InsetText::init()
113 for_each(paragraphs().begin(), paragraphs().end(),
114 bind(&Paragraph::setInsetOwner, _1, this));
118 void InsetText::clear()
120 ParagraphList & pars = paragraphs();
122 // This is a gross hack...
123 LayoutPtr old_layout = pars.begin()->layout();
126 pars.push_back(Paragraph());
127 pars.begin()->setInsetOwner(this);
128 pars.begin()->layout(old_layout);
132 Inset * InsetText::clone() const
134 return new InsetText(*this);
138 void InsetText::write(Buffer const & buf, ostream & os) const
141 text_.write(buf, os);
145 void InsetText::read(Buffer const & buf, Lexer & lex)
149 // delete the initial paragraph
150 Paragraph oldpar = *paragraphs().begin();
151 paragraphs().clear();
153 bool res = text_.read(buf, lex, errorList);
157 lex.printError("Missing \\end_inset at this point. "
162 // ensure we have at least one paragraph.
163 if (paragraphs().empty())
164 paragraphs().push_back(oldpar);
168 bool InsetText::metrics(MetricsInfo & mi, Dimension & dim) const
170 TextMetrics & tm = mi.base.bv->textMetrics(&text_);
172 //lyxerr << "InsetText::metrics: width: " << mi.base.textwidth << endl;
173 mi.base.textwidth -= 2 * border_;
174 font_ = mi.base.font;
175 // Hand font through to contained lyxtext:
176 text_.font_ = mi.base.font;
180 dim.wid += 2 * border_;
181 mi.base.textwidth += 2 * border_;
182 bool const changed = dim_ != dim;
188 void InsetText::draw(PainterInfo & pi, int x, int y) const
190 // update our idea of where we are
191 setPosCache(pi, x, y);
193 TextMetrics & tm = pi.base.bv->textMetrics(&text_);
195 if (drawFrame_ || pi.full_repaint) {
196 int const w = hasFixedWidth() ?
197 tm.maxWidth() : tm.width() + 2 * border_;
198 int const a = tm.ascent() + border_;
199 int const h = a + tm.descent() + border_;
201 pi.pain.fillRectangle(x, y - a, w, h, backgroundColor());
203 pi.pain.rectangle(x, y - a, w, h, frameColor());
205 tm.draw(pi, x + border_, y);
209 void InsetText::drawSelection(PainterInfo & pi, int x, int y) const
211 if (!pi.base.bv->cursor().selection())
214 TextMetrics & tm = pi.base.bv->textMetrics(&text_);
215 int const w = tm.width() + 2 * border_;
216 int const a = tm.ascent() + border_;
217 int const h = a + tm.descent() + border_;
218 pi.pain.fillRectangle(x, y - a,
219 (hasFixedWidth() ? tm.maxWidth() : w),
220 h, backgroundColor());
221 text_.drawSelection(pi, x + border_, y);
225 docstring const InsetText::editMessage() const
227 return _("Opened Text Inset");
231 void InsetText::edit(Cursor & cur, bool left)
233 //lyxerr << "InsetText: edit left/right" << endl;
234 int const pit = left ? 0 : paragraphs().size() - 1;
235 int const pos = left ? 0 : paragraphs().back().size();
236 text_.setCursor(cur.top(), pit, pos);
237 cur.clearSelection();
242 Inset * InsetText::editXY(Cursor & cur, int x, int y)
244 return text_.editXY(cur, x, y);
248 void InsetText::doDispatch(Cursor & cur, FuncRequest & cmd)
250 LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
251 << " [ cmd.action = "
252 << cmd.action << ']' << endl;
253 text_.dispatch(cur, cmd);
257 bool InsetText::getStatus(Cursor & cur, FuncRequest const & cmd,
258 FuncStatus & status) const
260 return text_.getStatus(cur, cmd, status);
264 void InsetText::setChange(Change const & change)
266 ParagraphList::iterator pit = paragraphs().begin();
267 ParagraphList::iterator end = paragraphs().end();
268 for (; pit != end; ++pit) {
269 pit->setChange(change);
274 void InsetText::acceptChanges(BufferParams const & bparams)
276 text_.acceptChanges(bparams);
280 void InsetText::rejectChanges(BufferParams const & bparams)
282 text_.rejectChanges(bparams);
286 int InsetText::latex(Buffer const & buf, odocstream & os,
287 OutputParams const & runparams) const
290 latexParagraphs(buf, paragraphs(), os, texrow, runparams);
291 return texrow.rows();
295 int InsetText::plaintext(Buffer const & buf, odocstream & os,
296 OutputParams const & runparams) const
298 ParagraphList::const_iterator beg = paragraphs().begin();
299 ParagraphList::const_iterator end = paragraphs().end();
300 ParagraphList::const_iterator it = beg;
301 bool ref_printed = false;
303 for (; it != end; ++it) {
306 if (runparams.linelen > 0)
309 odocstringstream oss;
310 writePlaintextParagraph(buf, *it, oss, runparams, ref_printed);
311 docstring const str = oss.str();
313 // FIXME: len is not computed fully correctly; in principle,
314 // we have to count the characters after the last '\n'
322 int InsetText::docbook(Buffer const & buf, odocstream & os,
323 OutputParams const & runparams) const
325 docbookParagraphs(paragraphs(), buf, os, runparams);
330 void InsetText::validate(LaTeXFeatures & features) const
332 for_each(paragraphs().begin(), paragraphs().end(),
333 bind(&Paragraph::validate, _1, ref(features)));
337 void InsetText::cursorPos(BufferView const & bv,
338 CursorSlice const & sl, bool boundary, int & x, int & y) const
340 x = text_.cursorX(bv, sl, boundary) + border_;
341 y = text_.cursorY(bv, sl, boundary);
345 bool InsetText::showInsetDialog(BufferView *) const
351 void InsetText::setText(docstring const & data, Font const & font, bool trackChanges)
354 Paragraph & first = paragraphs().front();
355 for (unsigned int i = 0; i < data.length(); ++i)
356 first.insertChar(i, data[i], font, trackChanges);
360 void InsetText::setAutoBreakRows(bool flag)
362 if (flag == text_.autoBreakRows_)
365 text_.autoBreakRows_ = flag;
369 // remove previously existing newlines
370 ParagraphList::iterator it = paragraphs().begin();
371 ParagraphList::iterator end = paragraphs().end();
372 for (; it != end; ++it)
373 for (int i = 0; i < it->size(); ++i)
374 if (it->isNewline(i))
375 // do not track the change, because the user
376 // is not allowed to revert/reject it
377 it->eraseChar(i, false);
381 void InsetText::setDrawFrame(bool flag)
387 Color_color InsetText::frameColor() const
389 return Color::color(frame_color_);
393 void InsetText::setFrameColor(Color_color col)
399 void InsetText::appendParagraphs(Buffer * buffer, ParagraphList & plist)
401 // There is little we can do here to keep track of changes.
402 // As of 2006/10/20, appendParagraphs is used exclusively by
403 // LyXTabular::setMultiColumn. In this context, the paragraph break
404 // is lost irreversibly and the appended text doesn't really change
406 ParagraphList & pl = paragraphs();
408 ParagraphList::iterator pit = plist.begin();
409 ParagraphList::iterator ins = pl.insert(pl.end(), *pit);
411 mergeParagraph(buffer->params(), pl,
412 std::distance(pl.begin(), ins) - 1);
414 for_each(pit, plist.end(),
415 bind(&ParagraphList::push_back, ref(pl), _1));
419 void InsetText::addPreview(PreviewLoader & loader) const
421 ParagraphList::const_iterator pit = paragraphs().begin();
422 ParagraphList::const_iterator pend = paragraphs().end();
424 for (; pit != pend; ++pit) {
425 InsetList::const_iterator it = pit->insetlist.begin();
426 InsetList::const_iterator end = pit->insetlist.end();
427 for (; it != end; ++it)
428 it->inset->addPreview(loader);
433 //FIXME: instead of this hack, which only works by chance,
434 // cells should have their own insetcell type, which returns CELL_CODE!
435 bool InsetText::neverIndent(Buffer const & buffer) const
437 // this is only true for tabular cells
438 return !text_.isMainText(buffer) && lyxCode() == TEXT_CODE;
442 ParagraphList const & InsetText::paragraphs() const
444 return text_.paragraphs();
448 ParagraphList & InsetText::paragraphs()
450 return text_.paragraphs();
454 void InsetText::updateLabels(Buffer const & buf, ParIterator const & it)
456 ParIterator it2 = it;
458 BOOST_ASSERT(&it2.inset() == this && it2.pit() == 0);
459 lyx::updateLabels(buf, it2);