src/paragraph_funcs.cpp

   1 /**
   2  * \file paragraph_funcs.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "paragraph_funcs.h"
  14
  15 #include "BufferParams.h"
  16 #include "Changes.h"
  17 #include "InsetList.h"
  18 #include "Layout.h"
  19 #include "Paragraph.h"
  20 #include "ParagraphParameters.h"
  21 #include "Text.h"
  22 #include "TextClass.h"
  23
  24 #include "support/debug.h"
  25
  26 #include "support/lassert.h"
  27 #include <boost/next_prior.hpp>
  28
  29 using namespace std;
  30
  31 namespace lyx {
  32
  33 static bool moveItem(Paragraph & fromPar, pos_type fromPos,
  34         Paragraph & toPar, pos_type toPos, BufferParams const & params)
  35 {
  36         // Note: moveItem() does not honour change tracking!
  37         // Therefore, it should only be used for breaking and merging paragraphs
  38
  39         Font const tmpFont = fromPar.getFontSettings(params, fromPos);
  40         Change const tmpChange = fromPar.lookupChange(fromPos);
  41
  42         Inset * tmpInset = fromPar.getInset(fromPos);
  43         if (tmpInset) {
  44                 // the inset is not in the paragraph any more
  45                 tmpInset = fromPar.releaseInset(fromPos);
  46                 return toPar.insertInset(toPos, tmpInset, tmpFont, tmpChange);
  47         }
  48
  49         char_type const tmpChar = fromPar.getChar(fromPos);
  50         fromPar.eraseChar(fromPos, false);
  51         toPar.insertChar(toPos, tmpChar, tmpFont, tmpChange);
  52         return true;
  53 }
  54
  55
  56 void breakParagraph(BufferParams const & bparams,
  57                     ParagraphList & pars, pit_type par_offset, pos_type pos,
  58                     bool keep_layout)
  59 {
  60         // create a new paragraph, and insert into the list
  61         ParagraphList::iterator tmp =
  62                 pars.insert(boost::next(pars.begin(), par_offset + 1),
  63                             Paragraph());
  64
  65         Paragraph & par = pars[par_offset];
  66
  67         // remember to set the inset_owner
  68         tmp->setInsetOwner(&par.inInset());
  69         // without doing that we get a crash when typing <Return> at the
  70         // end of a paragraph
  71         tmp->setPlainOrDefaultLayout(bparams.documentClass());
  72
  73         // layout stays the same with latex-environments
  74         if (keep_layout) {
  75                 tmp->setLayout(par.layout());
  76                 tmp->setLabelWidthString(par.params().labelWidthString());
  77                 tmp->params().depth(par.params().depth());
  78         } else if (par.params().depth() > 0) {
  79                 Paragraph const & hook = pars[outerHook(par_offset, pars)];
  80                 tmp->setLayout(hook.layout());
  81                 // not sure the line below is useful
  82                 tmp->setLabelWidthString(par.params().labelWidthString());
  83                 tmp->params().depth(hook.params().depth());
  84         }
  85
  86         bool const isempty = (par.allowEmpty() && par.empty());
  87
  88         if (!isempty && (par.size() > pos || par.empty())) {
  89                 tmp->setLayout(par.layout());
  90                 tmp->params().align(par.params().align());
  91                 tmp->setLabelWidthString(par.params().labelWidthString());
  92
  93                 tmp->params().depth(par.params().depth());
  94                 tmp->params().noindent(par.params().noindent());
  95
  96                 // move everything behind the break position
  97                 // to the new paragraph
  98
  99                 /* Note: if !keepempty, empty() == true, then we reach
 100                  * here with size() == 0. So pos_end becomes - 1. This
 101                  * doesn't cause problems because both loops below
 102                  * enforce pos <= pos_end and 0 <= pos
 103                  */
 104                 pos_type pos_end = par.size() - 1;
 105
 106                 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
 107                         if (moveItem(par, pos, *tmp, j, bparams)) {
 108                                 ++j;
 109                         }
 110                 }
 111         }
 112
 113         // Move over the end-of-par change information
 114         tmp->setChange(tmp->size(), par.lookupChange(par.size()));
 115         par.setChange(par.size(), Change(bparams.trackChanges ?
 116                                            Change::INSERTED : Change::UNCHANGED));
 117
 118         if (pos) {
 119                 // Make sure that we keep the language when
 120                 // breaking paragraph.
 121                 if (tmp->empty()) {
 122                         Font changed = tmp->getFirstFontSettings(bparams);
 123                         Font old = par.getFontSettings(bparams, par.size());
 124                         changed.setLanguage(old.language());
 125                         tmp->setFont(0, changed);
 126                 }
 127
 128                 return;
 129         }
 130
 131         if (!isempty) {
 132                 bool const soa = par.params().startOfAppendix();
 133                 par.params().clear();
 134                 // do not lose start of appendix marker (bug 4212)
 135                 par.params().startOfAppendix(soa);
 136                 par.setPlainOrDefaultLayout(bparams.documentClass());
 137         }
 138
 139         // layout stays the same with latex-environments
 140         if (keep_layout) {
 141                 par.setLayout(tmp->layout());
 142                 par.setLabelWidthString(tmp->params().labelWidthString());
 143                 par.params().depth(tmp->params().depth());
 144         }
 145 }
 146
 147
 148 void breakParagraphConservative(BufferParams const & bparams,
 149         ParagraphList & pars, pit_type par_offset, pos_type pos)
 150 {
 151         // create a new paragraph
 152         Paragraph & tmp = *pars.insert(boost::next(pars.begin(), par_offset + 1),
 153                                        Paragraph());
 154         Paragraph & par = pars[par_offset];
 155
 156         tmp.setInsetOwner(&par.inInset());
 157         tmp.makeSameLayout(par);
 158
 159         LASSERT(pos <= par.size(), /**/);
 160
 161         if (pos < par.size()) {
 162                 // move everything behind the break position to the new paragraph
 163                 pos_type pos_end = par.size() - 1;
 164
 165                 for (pos_type i = pos, j = 0; i <= pos_end; ++i) {
 166                         if (moveItem(par, pos, tmp, j, bparams)) {
 167                                 ++j;
 168                         }
 169                 }
 170                 // Move over the end-of-par change information
 171                 tmp.setChange(tmp.size(), par.lookupChange(par.size()));
 172                 par.setChange(par.size(), Change(bparams.trackChanges ?
 173                                            Change::INSERTED : Change::UNCHANGED));
 174         }
 175 }
 176
 177
 178 void mergeParagraph(BufferParams const & bparams,
 179         ParagraphList & pars, pit_type par_offset)
 180 {
 181         Paragraph & next = pars[par_offset + 1];
 182         Paragraph & par = pars[par_offset];
 183
 184         pos_type pos_end = next.size() - 1;
 185         pos_type pos_insert = par.size();
 186
 187         // the imaginary end-of-paragraph character (at par.size()) has to be
 188         // marked as unmodified. Otherwise, its change is adopted by the first
 189         // character of the next paragraph.
 190         if (par.lookupChange(par.size()).type != Change::UNCHANGED) {
 191                 LYXERR(Debug::CHANGES,
 192                    "merging par with inserted/deleted end-of-par character");
 193                 par.setChange(par.size(), Change(Change::UNCHANGED));
 194         }
 195
 196         Change change = next.lookupChange(next.size());
 197
 198         // move the content of the second paragraph to the end of the first one
 199         for (pos_type i = 0, j = pos_insert; i <= pos_end; ++i) {
 200                 if (moveItem(next, 0, par, j, bparams)) {
 201                         ++j;
 202                 }
 203         }
 204
 205         // move the change of the end-of-paragraph character
 206         par.setChange(par.size(), change);
 207
 208         pars.erase(boost::next(pars.begin(), par_offset + 1));
 209 }
 210
 211
 212 pit_type depthHook(pit_type pit, ParagraphList const & pars, depth_type depth)
 213 {
 214         pit_type newpit = pit;
 215
 216         if (newpit != 0)
 217                 --newpit;
 218
 219         while (newpit != 0 && pars[newpit].getDepth() > depth)
 220                 --newpit;
 221
 222         if (pars[newpit].getDepth() > depth)
 223                 return pit;
 224
 225         return newpit;
 226 }
 227
 228
 229 pit_type outerHook(pit_type par_offset, ParagraphList const & pars)
 230 {
 231         Paragraph const & par = pars[par_offset];
 232
 233         if (par.getDepth() == 0)
 234                 return pars.size();
 235         return depthHook(par_offset, pars, depth_type(par.getDepth() - 1));
 236 }
 237
 238
 239 bool isFirstInSequence(pit_type par_offset, ParagraphList const & pars)
 240 {
 241         Paragraph const & par = pars[par_offset];
 242
 243         pit_type dhook_offset = depthHook(par_offset, pars, par.getDepth());
 244
 245         if (dhook_offset == par_offset)
 246                 return true;
 247
 248         Paragraph const & dhook = pars[dhook_offset];
 249
 250         return dhook.layout() != par.layout()
 251                 || dhook.getDepth() != par.getDepth();
 252 }
 253
 254
 255 int getEndLabel(pit_type p, ParagraphList const & pars)
 256 {
 257         pit_type pit = p;
 258         depth_type par_depth = pars[p].getDepth();
 259         while (pit != pit_type(pars.size())) {
 260                 Layout const & layout = pars[pit].layout();
 261                 int const endlabeltype = layout.endlabeltype;
 262
 263                 if (endlabeltype != END_LABEL_NO_LABEL) {
 264                         if (p + 1 == pit_type(pars.size()))
 265                                 return endlabeltype;
 266
 267                         depth_type const next_depth =
 268                                 pars[p + 1].getDepth();
 269                         if (par_depth > next_depth ||
 270                             (par_depth == next_depth && layout != pars[p + 1].layout()))
 271                                 return endlabeltype;
 272                         break;
 273                 }
 274                 if (par_depth == 0)
 275                         break;
 276                 pit = outerHook(pit, pars);
 277                 if (pit != pit_type(pars.size()))
 278                         par_depth = pars[pit].getDepth();
 279         }
 280         return END_LABEL_NO_LABEL;
 281 }
 282
 283
 284 Font const outerFont(pit_type par_offset, ParagraphList const & pars)
 285 {
 286         depth_type par_depth = pars[par_offset].getDepth();
 287         FontInfo tmpfont = inherit_font;
 288
 289         // Resolve against environment font information
 290         while (par_offset != pit_type(pars.size())
 291                && par_depth
 292                && !tmpfont.resolved()) {
 293                 par_offset = outerHook(par_offset, pars);
 294                 if (par_offset != pit_type(pars.size())) {
 295                         tmpfont.realize(pars[par_offset].layout().font);
 296                         par_depth = pars[par_offset].getDepth();
 297                 }
 298         }
 299
 300         return Font(tmpfont);
 301 }
 302
 303
 304 void acceptChanges(ParagraphList & pars, BufferParams const & bparams)
 305 {
 306         pit_type pars_size = static_cast<pit_type>(pars.size());
 307
 308         // first, accept changes within each individual paragraph
 309         // (do not consider end-of-par)
 310         for (pit_type pit = 0; pit < pars_size; ++pit) {
 311                 if (!pars[pit].empty())   // prevent assertion failure
 312                         pars[pit].acceptChanges(bparams, 0, pars[pit].size());
 313         }
 314
 315         // next, accept imaginary end-of-par characters
 316         for (pit_type pit = 0; pit < pars_size; ++pit) {
 317                 pos_type pos = pars[pit].size();
 318
 319                 if (pars[pit].isInserted(pos)) {
 320                         pars[pit].setChange(pos, Change(Change::UNCHANGED));
 321                 } else if (pars[pit].isDeleted(pos)) {
 322                         if (pit == pars_size - 1) {
 323                                 // we cannot remove a par break at the end of the last
 324                                 // paragraph; instead, we mark it unchanged
 325                                 pars[pit].setChange(pos, Change(Change::UNCHANGED));
 326                         } else {
 327                                 mergeParagraph(bparams, pars, pit);
 328                                 --pit;
 329                                 --pars_size;
 330                         }
 331                 }
 332         }
 333 }
 334
 335
 336 } // namespace lyx