2 * \file paragraph_funcs.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "paragraph_funcs.h"
16 #include "bufferparams.h"
24 #include "outputparams.h"
25 #include "paragraph_pimpl.h"
26 #include "pariterator.h"
31 #include "support/filetools.h"
32 #include "support/lstrings.h"
33 #include "support/lyxlib.h"
41 using lyx::support::ascii_lowercase;
42 using lyx::support::bformat;
43 using lyx::support::compare_ascii_no_case;
44 using lyx::support::compare_no_case;
45 using lyx::support::contains;
46 using lyx::support::split;
47 using lyx::support::subst;
53 using std::istringstream;
60 bool moveItem(Paragraph & from, Paragraph & to,
61 BufferParams const & params, pos_type i, pos_type j,
62 Change change = Change(Change::INSERTED));
64 bool moveItem(Paragraph & from, Paragraph & to,
65 BufferParams const & params, pos_type i, pos_type j,
68 Paragraph::value_type const tmpchar = from.getChar(i);
69 LyXFont tmpfont = from.getFontSettings(params, i);
71 if (tmpchar == Paragraph::META_INSET) {
72 InsetBase * tmpinset = 0;
73 if (from.getInset(i)) {
74 // the inset is not in a paragraph anymore
75 tmpinset = from.insetlist.release(i);
76 from.insetlist.erase(i);
79 if (!to.insetAllowed(tmpinset->lyxCode())) {
84 to.insertInset(j, tmpinset, tmpfont, change);
86 if (!to.checkInsertChar(tmpfont))
88 to.insertChar(j, tmpchar, tmpfont, change);
96 void breakParagraph(BufferParams const & bparams,
97 ParagraphList & pars, pit_type par_offset, pos_type pos, int flag)
99 // create a new paragraph, and insert into the list
100 ParagraphList::iterator tmp =
101 pars.insert(pars.begin() + par_offset + 1, Paragraph());
103 Paragraph & par = pars[par_offset];
105 // we will invalidate the row cache
108 // without doing that we get a crash when typing <Return> at the
109 // end of a paragraph
110 tmp->layout(bparams.getLyXTextClass().defaultLayout());
111 // remember to set the inset_owner
112 tmp->setInsetOwner(par.inInset());
114 if (bparams.tracking_changes)
117 // this is an idea for a more userfriendly layout handling, I will
118 // see what the users say
120 // layout stays the same with latex-environments
122 tmp->layout(par.layout());
123 tmp->setLabelWidthString(par.params().labelWidthString());
126 bool const isempty = (par.allowEmpty() && par.empty());
128 if (!isempty && (par.size() > pos || par.empty() || flag == 2)) {
129 tmp->layout(par.layout());
130 tmp->params().align(par.params().align());
131 tmp->setLabelWidthString(par.params().labelWidthString());
133 tmp->params().depth(par.params().depth());
134 tmp->params().noindent(par.params().noindent());
136 // copy everything behind the break-position
137 // to the new paragraph
139 /* Note: if !keepempty, empty() == true, then we reach
140 * here with size() == 0. So pos_end becomes - 1. This
141 * doesn't cause problems because both loops below
142 * enforce pos <= pos_end and 0 <= pos
144 pos_type pos_end = par.size() - 1;
146 for (pos_type i = pos, j = pos; i <= pos_end; ++i) {
147 Change::Type change = par.lookupChange(i);
148 if (moveItem(par, *tmp, bparams, i, j - pos)) {
149 tmp->setChange(j - pos, change);
154 for (pos_type i = pos_end; i >= pos; --i)
159 // Make sure that we keep the language when
160 // breaking paragrpah.
162 LyXFont changed = tmp->getFirstFontSettings();
163 LyXFont old = par.getFontSettings(bparams, par.size());
164 changed.setLanguage(old.language());
165 tmp->setFont(0, changed);
171 par.params().clear();
173 par.layout(bparams.getLyXTextClass().defaultLayout());
175 // layout stays the same with latex-environments
177 par.layout(tmp->layout());
178 par.setLabelWidthString(tmp->params().labelWidthString());
179 par.params().depth(tmp->params().depth());
182 // subtle, but needed to get empty pars working right
183 if (bparams.tracking_changes) {
186 } else if (!tmp->size()) {
193 void breakParagraphConservative(BufferParams const & bparams,
194 ParagraphList & pars, pit_type par_offset, pos_type pos)
196 // create a new paragraph
197 Paragraph & tmp = *pars.insert(pars.begin() + par_offset + 1, Paragraph());
198 Paragraph & par = pars[par_offset];
200 if (bparams.tracking_changes)
203 tmp.makeSameLayout(par);
205 // When can pos > size()?
206 // I guess pos == size() is possible.
207 if (par.size() > pos) {
208 // copy everything behind the break-position to the new
210 pos_type pos_end = par.size() - 1;
212 for (pos_type i = pos, j = pos; i <= pos_end; ++i) {
213 Change::Type change = par.lookupChange(i);
214 if (moveItem(par, tmp, bparams, i, j - pos, change))
217 // If tracking changes, set all the text that is to be
218 // erased to Type::INSERTED.
219 for (pos_type k = pos_end; k >= pos; --k) {
220 if (bparams.tracking_changes)
221 par.setChange(k, Change::INSERTED);
228 void mergeParagraph(BufferParams const & bparams,
229 ParagraphList & pars, pit_type par_offset)
231 Paragraph & next = pars[par_offset + 1];
232 Paragraph & par = pars[par_offset];
234 pos_type pos_end = next.size() - 1;
235 pos_type pos_insert = par.size();
237 // ok, now copy the paragraph
238 for (pos_type i = 0, j = 0; i <= pos_end; ++i) {
239 Change::Type change = next.lookupChange(i);
240 if (moveItem(next, par, bparams, i, pos_insert + j, change))
244 pars.erase(pars.begin() + par_offset + 1);
248 pit_type depthHook(pit_type pit,
249 ParagraphList const & pars, Paragraph::depth_type depth)
251 pit_type newpit = pit;
256 while (newpit != 0 && pars[newpit].getDepth() > depth)
259 if (pars[newpit].getDepth() > depth)
266 pit_type outerHook(pit_type par_offset, ParagraphList const & pars)
268 Paragraph const & par = pars[par_offset];
270 if (par.getDepth() == 0)
272 return depthHook(par_offset, pars, Paragraph::depth_type(par.getDepth() - 1));
276 bool isFirstInSequence(pit_type par_offset, ParagraphList const & pars)
278 Paragraph const & par = pars[par_offset];
280 pit_type dhook_offset = depthHook(par_offset, pars, par.getDepth());
282 Paragraph const & dhook = pars[dhook_offset];
284 return dhook_offset == par_offset
285 || dhook.layout() != par.layout()
286 || dhook.getDepth() != par.getDepth();
290 int getEndLabel(pit_type p, ParagraphList const & pars)
293 Paragraph::depth_type par_depth = pars[p].getDepth();
294 while (pit != pit_type(pars.size())) {
295 LyXLayout_ptr const & layout = pars[pit].layout();
296 int const endlabeltype = layout->endlabeltype;
298 if (endlabeltype != END_LABEL_NO_LABEL) {
299 if (p + 1 == pit_type(pars.size()))
302 Paragraph::depth_type const next_depth =
303 pars[p + 1].getDepth();
304 if (par_depth > next_depth ||
305 (par_depth == next_depth && layout != pars[p + 1].layout()))
311 pit = outerHook(pit, pars);
312 if (pit != pit_type(pars.size()))
313 par_depth = pars[pit].getDepth();
315 return END_LABEL_NO_LABEL;
319 LyXFont const outerFont(pit_type par_offset, ParagraphList const & pars)
321 Paragraph::depth_type par_depth = pars[par_offset].getDepth();
322 LyXFont tmpfont(LyXFont::ALL_INHERIT);
324 // Resolve against environment font information
325 while (par_offset != pit_type(pars.size())
327 && !tmpfont.resolved()) {
328 par_offset = outerHook(par_offset, pars);
329 if (par_offset != pit_type(pars.size())) {
330 tmpfont.realize(pars[par_offset].layout()->font);
331 par_depth = pars[par_offset].getDepth();
339 /// return the number of InsetOptArg in a paragraph
340 int numberOfOptArgs(Paragraph const & par)
344 InsetList::const_iterator it = par.insetlist.begin();
345 InsetList::const_iterator end = par.insetlist.end();
346 for (; it != end ; ++it) {
347 if (it->inset->lyxCode() == InsetBase::OPTARG_CODE)