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