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