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 "dimension.h"
  21 #include "InsetList.h"
  22 #include "lyxlayout_ptr_fwd.h"
  23 #include "RowList_fwd.h"
  24
  25 #include "insets/insetbase.h" // only for InsetBase::Code
  26
  27 #include "support/types.h"
  28
  29 #include <string>
  30
  31 class Buffer;
  32 class BufferParams;
  33 class BufferView;
  34 class Counters;
  35 class InsetBase;
  36 class InsetBibitem;
  37 class LaTeXFeatures;
  38 class InsetBase_code;
  39 class Language;
  40 class LyXFont;
  41 class LyXFont_size;
  42 class MetricsInfo;
  43 class OutputParams;
  44 class PainterInfo;
  45 class ParagraphParameters;
  46 class TexRow;
  47
  48
  49 class FontSpan {
  50 public:
  51         /// Invalid font span containing no character
  52         FontSpan() : first(0), last(-1) {}
  53         /// Span including first and last
  54         FontSpan(lyx::pos_type f, lyx::pos_type l) : first(f), last(l) {}
  55
  56 public:
  57         /// Range including first and last.
  58         lyx::pos_type first, last;
  59 };
  60
  61
  62 /// A Paragraph holds all text, attributes and insets in a text paragraph
  63 class Paragraph  {
  64 public:
  65         ///
  66         enum {
  67                 /// Note that this is 1 right now to avoid
  68                 /// crashes where getChar() is called wrongly
  69                 /// (returning 0) - if this was 0, then we'd
  70                 /// try getInset() and crash. We should fix
  71                 /// all these places.
  72                 //META_INSET = 1 // as in trunk
  73                 META_INSET = 0x200001  // above 0x10ffff, for ucs-4
  74         };
  75         enum ChangeTracking
  76         {
  77                 /// Change tracking is "on" in this buffer
  78                 trackingOn,
  79                 /// Change tracking is "off" in this buffer
  80                 trackingOff,
  81                 /// Change tracking is "unknown" in this buffer
  82                 trackingUnknown
  83         };
  84         ///
  85         typedef lyx::char_type value_type;
  86         ///
  87         typedef lyx::depth_type depth_type;
  88         ///
  89         typedef std::vector<value_type> TextContainer;
  90
  91         ///
  92         Paragraph();
  93         ///
  94         Paragraph(Paragraph const &);
  95         ///
  96         Paragraph & operator=(Paragraph const &);
  97         ///
  98         ~Paragraph();
  99         ///
 100         int id() const;
 101
 102
 103         ///
 104         Language const * getParLanguage(BufferParams const &) const;
 105         ///
 106         bool isRightToLeftPar(BufferParams const &) const;
 107         ///
 108         void changeLanguage(BufferParams const & bparams,
 109                             Language const * from, Language const * to);
 110         ///
 111         bool isMultiLingual(BufferParams const &) const;
 112
 113         ///
 114         std::string const asString(Buffer const &,
 115                                    OutputParams const & runparams,
 116                                    bool label) const;
 117         ///
 118         std::string const asString(Buffer const &, bool label) const;
 119         ///
 120         std::string const asString(Buffer const & buffer,
 121                                    lyx::pos_type beg,
 122                                    lyx::pos_type end,
 123                                    bool label) const;
 124         ///
 125         std::string const asString(Buffer const &,
 126                                    OutputParams const & runparams,
 127                                    lyx::pos_type beg,
 128                                    lyx::pos_type end,
 129                                    bool label) const;
 130
 131         ///
 132         void write(Buffer const &, std::ostream &, BufferParams const &,
 133                    depth_type & depth) const;
 134         ///
 135         void validate(LaTeXFeatures &) const;
 136
 137         ///
 138         int startTeXParParams(BufferParams const &, std::ostream &, bool) const;
 139
 140         ///
 141         int endTeXParParams(BufferParams const &, std::ostream &, bool) const;
 142
 143
 144         ///
 145         bool simpleTeXOnePar(Buffer const &, BufferParams const &,
 146                              LyXFont const & outerfont, std::ostream &,
 147                              TexRow & texrow, OutputParams const &) const;
 148
 149         /// Can we drop the standard paragraph wrapper?
 150         bool emptyTag() const;
 151
 152         /// Get the id of the paragraph, usefull for docbook
 153         std::string getID(Buffer const & buf,
 154                           OutputParams const & runparams) const;
 155
 156         // Get the first word of a paragraph, return the position where it left
 157         lyx::pos_type getFirstWord(Buffer const & buf,
 158                                    std::ostream & os,
 159                                    OutputParams const & runparams) const;
 160
 161         /// Checks if the paragraph contains only text and no inset or font change.
 162         bool onlyText(Buffer const & buf, LyXFont const & outerfont,
 163                       lyx::pos_type initial) const;
 164
 165         /// Writes to stream the docbook representation
 166         void simpleDocBookOnePar(Buffer const & buf,
 167                                  std::ostream &,
 168                                  OutputParams const & runparams,
 169                                  LyXFont const & outerfont,
 170                                  lyx::pos_type initial = 0) const;
 171
 172         ///
 173         bool hasSameLayout(Paragraph const & par) const;
 174
 175         ///
 176         void makeSameLayout(Paragraph const & par);
 177
 178         ///
 179         void setInsetOwner(InsetBase * inset);
 180         ///
 181         InsetBase * inInset() const;
 182         ///
 183         InsetBase::Code ownerCode() const;
 184         ///
 185         bool forceDefaultParagraphs() const;
 186
 187         ///
 188         lyx::pos_type size() const { return text_.size(); }
 189         ///
 190         bool empty() const { return text_.empty(); }
 191         ///
 192         void setContentsFromPar(Paragraph const & par);
 193         ///
 194         void clearContents();
 195
 196         ///
 197         LyXLayout_ptr const & layout() const;
 198         ///
 199         void layout(LyXLayout_ptr const & new_layout);
 200
 201         /// This is the item depth, only used by enumerate and itemize
 202         signed char itemdepth;
 203
 204         ///
 205         InsetBibitem * bibitem() const;  // ale970302
 206
 207         /// initialise tracking for this par
 208         void trackChanges(Change::Type = Change::UNCHANGED);
 209
 210         /// stop tracking
 211         void untrackChanges();
 212
 213         /// set entire paragraph to new text for change tracking
 214         void cleanChanges(ChangeTracking ct = trackingUnknown);
 215
 216         /// look up change at given pos
 217         Change const lookupChange(lyx::pos_type pos) const;
 218
 219         /// is there a change within the given range ?
 220         bool isChanged(lyx::pos_type start, lyx::pos_type end) const;
 221
 222         /// is there a non-addition in this range ?
 223         bool isChangeEdited(lyx::pos_type start, lyx::pos_type end) const;
 224
 225         /// set change type at given pos
 226         void setChangeType(lyx::pos_type pos, Change::Type type);
 227
 228         /// set change at given pos
 229         void setChange(lyx::pos_type pos, Change change);
 230
 231         /// accept change
 232         void acceptChange(lyx::pos_type start, lyx::pos_type end);
 233
 234         /// reject change
 235         void rejectChange(lyx::pos_type start, lyx::pos_type end);
 236
 237         /// mark whole par as erased or not
 238         void markErased(bool erased);
 239
 240         /// Paragraphs can contain "manual labels", for example, Description
 241         /// environment. The text for this user-editable label is stored in
 242         /// the paragraph alongside the text of the rest of the paragraph
 243         /// (the body). This function returns the starting position of the
 244         /// body of the text in the paragraph.
 245         lyx::pos_type beginOfBody() const;
 246         /// recompute this value
 247         void setBeginOfBody();
 248
 249         ///
 250         std::string const & getLabelstring() const;
 251
 252         /// the next two functions are for the manual labels
 253         std::string const getLabelWidthString() const;
 254         ///
 255         void setLabelWidthString(std::string const & s);
 256         ///
 257         char getAlign() const;
 258         /// The nesting depth of a paragraph
 259         depth_type getDepth() const;
 260         /// The maximal possible depth of a paragraph after this one
 261         depth_type getMaxDepthAfter() const;
 262         ///
 263         void applyLayout(LyXLayout_ptr const & new_layout);
 264
 265         /// definite erase
 266         void eraseIntern(lyx::pos_type pos);
 267         /// erase the char at the given position
 268         bool erase(lyx::pos_type pos);
 269         /// erase the given range. Returns the number of chars actually erased
 270         int erase(lyx::pos_type start, lyx::pos_type end);
 271
 272         /** Get uninstantiated font setting. Returns the difference
 273             between the characters font and the layoutfont.
 274             This is what is stored in the fonttable
 275         */
 276         LyXFont const
 277         getFontSettings(BufferParams const &, lyx::pos_type pos) const;
 278         ///
 279         LyXFont const getFirstFontSettings(BufferParams const &) const;
 280
 281         /** Get fully instantiated font. If pos == -1, use the layout
 282             font attached to this paragraph.
 283             If pos == -2, use the label font of the layout attached here.
 284             In all cases, the font is instantiated, i.e. does not have any
 285             attributes with values LyXFont::INHERIT, LyXFont::IGNORE or
 286             LyXFont::TOGGLE.
 287         */
 288         LyXFont const getFont(BufferParams const &, lyx::pos_type pos,
 289                               LyXFont const & outerfont) const;
 290         LyXFont const getLayoutFont(BufferParams const &,
 291                                     LyXFont const & outerfont) const;
 292         LyXFont const getLabelFont(BufferParams const &,
 293                                    LyXFont const & outerfont) const;
 294         /**
 295          * The font returned by the above functions is the same in a
 296          * span of characters. This method will return the first and
 297          * the last positions in the paragraph for which that font is
 298          * the same. This can be used to avoid unnecessary calls to
 299    * getFont.
 300          */
 301         FontSpan fontSpan(lyx::pos_type pos) const;
 302         ///
 303         /// this is a bottleneck.
 304         value_type getChar(lyx::pos_type pos) const { return text_[pos]; }
 305         /// Get the char, but mirror all bracket characters if it is right-to-left
 306         value_type getUChar(BufferParams const &, lyx::pos_type pos) const;
 307         /// The position must already exist.
 308         void setChar(lyx::pos_type pos, value_type c);
 309         /// pos <= size() (there is a dummy font change at the end of each par)
 310         void setFont(lyx::pos_type pos, LyXFont const & font);
 311         /// Returns the height of the highest font in range
 312         LyXFont_size highestFontInRange(lyx::pos_type startpos,
 313                                         lyx::pos_type endpos,
 314                                         LyXFont_size def_size) const;
 315         ///
 316         void insert(lyx::pos_type pos, std::string const & str,
 317                     LyXFont const & font);
 318         ///
 319         void insertChar(lyx::pos_type pos, value_type c,
 320                         Change change = Change::INSERTED);
 321         ///
 322         void insertChar(lyx::pos_type pos, value_type c,
 323                 LyXFont const &, Change change = Change::INSERTED);
 324         ///
 325         void insertInset(lyx::pos_type pos, InsetBase * inset,
 326                          Change change = Change::INSERTED);
 327         ///
 328         void insertInset(lyx::pos_type pos, InsetBase * inset,
 329                 LyXFont const &, Change change = Change::INSERTED);
 330         ///
 331         bool insetAllowed(InsetBase_code code);
 332         ///
 333         InsetBase * getInset(lyx::pos_type pos) {
 334                 return insetlist.get(pos);
 335         }
 336         ///
 337         InsetBase const * getInset(lyx::pos_type pos) const {
 338                 return insetlist.get(pos);
 339         }
 340
 341         ///
 342         bool isHfill(lyx::pos_type pos) const {
 343         return isInset(pos)
 344                 && getInset(pos)->lyxCode() == InsetBase::HFILL_CODE;
 345         }
 346         /// hinted by profiler
 347         bool isInset(lyx::pos_type pos) const {
 348                 return getChar(pos) == static_cast<value_type>(META_INSET);
 349         }
 350         ///
 351         bool isNewline(lyx::pos_type pos) const;
 352         /// return true if the char is a word separator
 353         bool isSeparator(lyx::pos_type pos) const { return getChar(pos) == ' '; }
 354         ///
 355         bool isLineSeparator(lyx::pos_type pos) const;
 356         /// True if the character/inset at this point can be part of a word
 357         // Note that digits in particular are considered as letters
 358         bool isLetter(lyx::pos_type pos) const;
 359
 360         /// returns -1 if inset not found
 361         int getPositionOfInset(InsetBase const * inset) const;
 362
 363         /// Returns the number of line breaks and white-space stripped at the start
 364         int stripLeadingSpaces();
 365
 366         /// return true if we allow multiple spaces
 367         bool isFreeSpacing() const;
 368
 369         /// return true if we allow this par to stay empty
 370         bool allowEmpty() const;
 371         ///
 372         lyx::char_type transformChar(lyx::char_type c, lyx::pos_type pos) const;
 373         ///
 374         ParagraphParameters & params();
 375         ///
 376         ParagraphParameters const & params() const;
 377
 378         ///
 379         Row & getRow(lyx::pos_type pos, bool boundary);
 380         ///
 381         Row const & getRow(lyx::pos_type pos, bool boundary) const;
 382         ///
 383         size_t pos2row(lyx::pos_type pos) const;
 384
 385         /// total height of paragraph
 386         unsigned int height() const { return dim_.height(); }
 387         /// total width of paragraph, may differ from workwidth
 388         unsigned int width() const { return dim_.width(); }
 389         /// ascend of paragraph above baseline
 390         unsigned int ascent() const { return dim_.ascent(); }
 391         /// descend of paragraph below baseline
 392         unsigned int descent() const { return dim_.descent(); }
 393         /// LyXText updates the rows using this access point
 394         RowList & rows() { return rows_; }
 395         /// The painter and others use this
 396         RowList const & rows() const { return rows_; }
 397         ///
 398         RowSignature & rowSignature() const { return rowSignature_; }
 399
 400         /// LyXText::redoParagraph updates this
 401         Dimension & dim() { return dim_; }
 402
 403         /// dump some information to lyxerr
 404         void dump() const;
 405
 406 public:
 407         ///
 408         InsetList insetlist;
 409
 410 private:
 411         /// cached dimensions of paragraph
 412         Dimension dim_;
 413
 414         ///
 415         mutable RowList rows_;
 416         ///
 417         mutable RowSignature rowSignature_;
 418
 419         ///
 420         LyXLayout_ptr layout_;
 421         /**
 422          * Keeping this here instead of in the pimpl makes LyX >10% faster
 423          * for average tasks as buffer loading/switching etc.
 424          */
 425         TextContainer text_;
 426         /// end of label
 427         lyx::pos_type begin_of_body_;
 428
 429         /// Pimpl away stuff
 430         class Pimpl;
 431         ///
 432         friend class Paragraph::Pimpl;
 433         ///
 434         Pimpl * pimpl_;
 435 };
 436
 437
 438 inline bool isInsertedText(Paragraph const & par, lyx::pos_type pos)
 439 {
 440         return par.lookupChange(pos).type == Change::INSERTED;
 441 }
 442
 443
 444 inline bool isDeletedText(Paragraph const & par, lyx::pos_type pos)
 445 {
 446         return par.lookupChange(pos).type == Change::DELETED;
 447 }
 448
 449 #endif // PARAGRAPH_H