src/paragraph.h

   1 // -*- C++ -*-
   2 /**
   3  * \file paragraph.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author André Pönitz
  11  * \author Jürgen Vigna
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #ifndef PARAGRAPH_H
  17 #define PARAGRAPH_H
  18
  19 #include "changes.h"
  20 #include "InsetList.h"
  21 #include "lyxlayout_ptr_fwd.h"
  22 #include "RowList_fwd.h"
  23
  24 #include "insets/insetbase.h" // only for InsetBase::Code
  25
  26 #include "support/types.h"
  27
  28 #include <boost/assert.hpp>
  29
  30 #include <string>
  31
  32 class Buffer;
  33 class BufferParams;
  34 class BufferView;
  35 class Counters;
  36 class InsetBase;
  37 class InsetBibitem;
  38 class InsetOld_code;
  39 class Language;
  40 class LaTeXFeatures;
  41 class OutputParams;
  42 class LyXFont;
  43 class LyXFont_size;
  44 class ParagraphParameters;
  45 class TexRow;
  46 class UpdatableInset;
  47
  48 /// A Paragraph holds all text, attributes and insets in a text paragraph
  49 class Paragraph  {
  50 public:
  51         ///
  52         enum {
  53                 /// Note that this is 1 right now to avoid
  54                 /// crashes where getChar() is called wrongly
  55                 /// (returning 0) - if this was 0, then we'd
  56                 /// try getInset() and crash. We should fix
  57                 /// all these places.
  58                 META_INSET = 1
  59         };
  60         ///
  61         typedef char value_type;
  62         ///
  63         typedef lyx::depth_type depth_type;
  64         ///
  65         typedef std::vector<value_type> TextContainer;
  66
  67         ///
  68         Paragraph();
  69         ///
  70         Paragraph(Paragraph const &);
  71         ///
  72         Paragraph & operator=(Paragraph const &);
  73         ///
  74         ~Paragraph();
  75
  76         ///
  77         int id() const;
  78
  79         ///
  80         Language const * getParLanguage(BufferParams const &) const;
  81         ///
  82         bool isRightToLeftPar(BufferParams const &) const;
  83         ///
  84         void changeLanguage(BufferParams const & bparams,
  85                             Language const * from, Language const * to);
  86         ///
  87         bool isMultiLingual(BufferParams const &) const;
  88
  89         ///
  90         std::string const asString(Buffer const &,
  91                                    OutputParams const & runparams,
  92                                    bool label) const;
  93         ///
  94         std::string const asString(Buffer const &, bool label) const;
  95         ///
  96         std::string const Paragraph::asString(Buffer const & buffer,
  97                                               lyx::pos_type beg,
  98                                               lyx::pos_type end,
  99                                               bool label) const;
 100         ///
 101         std::string const asString(Buffer const &,
 102                                    OutputParams const & runparams,
 103                                    lyx::pos_type beg,
 104                                    lyx::pos_type end,
 105                                    bool label) const;
 106
 107         ///
 108         void write(Buffer const &, std::ostream &, BufferParams const &,
 109                    depth_type & depth) const;
 110         ///
 111         void validate(LaTeXFeatures &) const;
 112
 113         ///
 114         int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
 115
 116         ///
 117         int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
 118
 119
 120         ///
 121         bool simpleTeXOnePar(Buffer const &, BufferParams const &,
 122                              LyXFont const & outerfont, std::ostream &,
 123                              TexRow & texrow, OutputParams const &) const;
 124
 125         ///
 126         void simpleLinuxDocOnePar(Buffer const & buf,
 127                                   std::ostream & os,
 128                                   LyXFont const & outerfont,
 129                                   OutputParams const & runparams,
 130                                   lyx::depth_type depth) const;
 131
 132         /// Get the id of the paragraph, usefull for docbook
 133         std::string getDocbookId() const;
 134
 135         ///
 136         void simpleDocBookOnePar(Buffer const & buf,
 137                                  std::ostream &,
 138                                  LyXFont const & outerfont,
 139                                  OutputParams const & runparams,
 140                                  lyx::depth_type depth) const;
 141
 142         ///
 143         bool hasSameLayout(Paragraph const & par) const;
 144
 145         ///
 146         void makeSameLayout(Paragraph const & par);
 147
 148         ///
 149         void setInsetOwner(UpdatableInset * inset);
 150         ///
 151         UpdatableInset * inInset() const;
 152         ///
 153         InsetBase::Code ownerCode() const;
 154         ///
 155         bool autoBreakRows() const;
 156         ///
 157         bool forceDefaultParagraphs() const;
 158
 159         ///
 160         lyx::pos_type size() const { return text_.size(); }
 161         ///
 162         bool empty() const { return text_.empty(); }
 163         ///
 164         void setContentsFromPar(Paragraph const & par);
 165         ///
 166         void clearContents();
 167
 168         ///
 169         LyXLayout_ptr const & layout() const;
 170         ///
 171         void layout(LyXLayout_ptr const & new_layout);
 172
 173         /// This is the item depth, only used by enumerate and itemize
 174         signed char itemdepth;
 175
 176         ///
 177         InsetBibitem * bibitem() const;  // ale970302
 178
 179         /// initialise tracking for this par
 180         void trackChanges(Change::Type = Change::UNCHANGED);
 181
 182         /// stop tracking
 183         void untrackChanges();
 184
 185         /// set entire paragraph to new text for change tracking
 186         void cleanChanges();
 187
 188         /// look up change type at given pos
 189         Change::Type lookupChange(lyx::pos_type pos) const;
 190
 191         /// look up change at given pos
 192         Change const lookupChangeFull(lyx::pos_type pos) const;
 193
 194         /// is there a change within the given range ?
 195         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
 196
 197         /// is there a non-addition in this range ?
 198         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
 199
 200         /// set change at pos
 201         void setChange(lyx::pos_type pos, Change::Type type);
 202
 203         /// accept change
 204         void acceptChange(lyx::pos_type start, lyx::pos_type end);
 205
 206         /// reject change
 207         void rejectChange(lyx::pos_type start, lyx::pos_type end);
 208
 209         /// mark whole par as erased
 210         void markErased();
 211
 212         /// Paragraphs can contain "manual labels", for example, Description
 213         /// environment. The text for this user-editable label is stored in
 214         /// the paragraph alongside the text of the rest of the paragraph
 215         /// (the body). This function returns the starting position of the
 216         /// body of the text in the paragraph.
 217         lyx::pos_type beginOfBody() const;
 218         /// recompute this value
 219         void setBeginOfBody();
 220
 221         ///
 222         std::string const & getLabelstring() const;
 223
 224         /// the next two functions are for the manual labels
 225         std::string const getLabelWidthString() const;
 226         ///
 227         void setLabelWidthString(std::string const & s);
 228         ///
 229         char getAlign() const;
 230         /// The nesting depth of a paragraph
 231         depth_type getDepth() const;
 232         /// The maximal possible depth of a paragraph after this one
 233         depth_type getMaxDepthAfter() const;
 234         ///
 235         void applyLayout(LyXLayout_ptr const & new_layout);
 236
 237         /// definite erase
 238         void eraseIntern(lyx::pos_type pos);
 239         /// erase the char at the given position
 240         bool erase(lyx::pos_type pos);
 241         /// erase the given range. Returns the number of chars actually erased
 242         int erase(lyx::pos_type start, lyx::pos_type end);
 243
 244         /** Get uninstantiated font setting. Returns the difference
 245             between the characters font and the layoutfont.
 246             This is what is stored in the fonttable
 247         */
 248         LyXFont const
 249         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 250         ///
 251         LyXFont const getFirstFontSettings() const;
 252
 253         /** Get fully instantiated font. If pos == -1, use the layout
 254             font attached to this paragraph.
 255             If pos == -2, use the label font of the layout attached here.
 256             In all cases, the font is instantiated, i.e. does not have any
 257             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 258             LyXFont::TOGGLE.
 259         */
 260         LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
 261                               LyXFont const & outerfont) const;
 262         LyXFont const getLayoutFont(BufferParams const &,
 263                                     LyXFont const & outerfont) const;
 264         LyXFont const getLabelFont(BufferParams const &,
 265                                    LyXFont const & outerfont) const;
 266         /**
 267          * The font returned by the above functions is the same in a
 268          * span of characters. This method will return the last position
 269          * in the paragraph for which that font is the same.
 270          * This can be used to avoid unnecessary calls to getFont.
 271          */
 272         lyx::pos_type getEndPosOfFontSpan(lyx::pos_type pos) const;
 273         ///
 274         /// this is a bottleneck.
 275         value_type getChar(lyx::pos_type pos) const
 276         {
 277                 BOOST_ASSERT(pos >= 0);
 278                 BOOST_ASSERT(pos < int(text_.size()));
 279                 return text_[pos];
 280         }
 281         ///
 282         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 283         /// The position must already exist.
 284         void setChar(lyx::pos_type pos, value_type c);
 285         /// pos <= size() (there is a dummy font change at the end of each par)
 286         void setFont(lyx::pos_type pos, LyXFont const & font);
 287         /// Returns the height of the highest font in range
 288         LyXFont_size highestFontInRange(lyx::pos_type startpos,
 289                                         lyx::pos_type endpos,
 290                                         LyXFont_size def_size) const;
 291         ///
 292         void insert(lyx::pos_type pos, std::string const & str,
 293                     LyXFont const & font);
 294         ///
 295         void insertChar(lyx::pos_type pos, value_type c,
 296                         Change change = Change(Change::INSERTED));
 297         ///
 298         void insertChar(lyx::pos_type pos, value_type c,
 299                 LyXFont const &, Change change = Change(Change::INSERTED));
 300         ///
 301         bool checkInsertChar(LyXFont &);
 302         ///
 303         void insertInset(lyx::pos_type pos, InsetBase * inset,
 304                          Change change = Change(Change::INSERTED));
 305         ///
 306         void insertInset(lyx::pos_type pos, InsetBase * inset,
 307                 LyXFont const &, Change change = Change(Change::INSERTED));
 308         ///
 309         bool insetAllowed(InsetOld_code code);
 310         ///
 311         InsetBase * getInset(lyx::pos_type pos);
 312         ///
 313         InsetBase const * getInset(lyx::pos_type pos) const;
 314
 315         ///
 316         bool isHfill(lyx::pos_type pos) const;
 317         /// hinted by profiler
 318         bool isInset(lyx::pos_type pos) const { return getChar(pos) == META_INSET; }
 319         ///
 320         bool isNewline(lyx::pos_type pos) const;
 321         ///
 322         bool isSeparator(lyx::pos_type pos) const;
 323         ///
 324         bool isLineSeparator(lyx::pos_type pos) const;
 325         ///
 326         bool isKomma(lyx::pos_type pos) const;
 327         /// Used by the spellchecker
 328         bool isLetter(lyx::pos_type pos) const;
 329         ///
 330         bool isWord(lyx::pos_type pos) const;
 331
 332         /// returns -1 if inset not found
 333         int getPositionOfInset(InsetBase const * inset) const;
 334
 335         ///
 336         int stripLeadingSpaces();
 337
 338         /// return true if we allow multiple spaces
 339         bool isFreeSpacing() const;
 340
 341         /// return true if we allow this par to stay empty
 342         bool allowEmpty() const;
 343         ////
 344         unsigned char transformChar(unsigned char c, lyx::pos_type pos) const;
 345         ///
 346         ParagraphParameters & params();
 347         ///
 348         ParagraphParameters const & params() const;
 349
 350         ///
 351         RowList::iterator getRow(lyx::pos_type pos);
 352         ///
 353         RowList::const_iterator getRow(lyx::pos_type pos) const;
 354         ///
 355         size_t row(lyx::pos_type pos) const;
 356
 357         ///
 358         InsetList insetlist;
 359
 360         ///
 361         mutable RowList rows;
 362         /// last draw y position (baseline of top row)
 363         int y;
 364         /// total height of paragraph
 365         unsigned int height;
 366         /// total width of paragraph, may differ from workwidth
 367         unsigned int width;
 368
 369 private:
 370         ///
 371         LyXLayout_ptr layout_;
 372         /// keeping this here instead of in the pimpl makes LyX >10% faster
 373         // for average tasks as buffer loading/switching etc.
 374         TextContainer text_;
 375         /// end of label
 376         lyx::pos_type begin_of_body_;
 377
 378         struct Pimpl;
 379         ///
 380         friend struct Paragraph::Pimpl;
 381         ///
 382         Pimpl * pimpl_;
 383
 384 };
 385
 386
 387 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
 388 {
 389         return par.lookupChange(pos) == Change::INSERTED;
 390 }
 391
 392
 393 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
 394 {
 395         return par.lookupChange(pos) == Change::DELETED;
 396 }
 397
 398 #endif // PARAGRAPH_H