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
  23 #include "insets/InsetCode.h"
  24
  25
  26 namespace lyx {
  27
  28
  29 class Buffer;
  30 class BufferParams;
  31 class Counters;
  32 class Inset;
  33 class InsetBibitem;
  34 class LaTeXFeatures;
  35 class Inset_code;
  36 class Language;
  37 class Font;
  38 class Font_size;
  39 class MetricsInfo;
  40 class OutputParams;
  41 class PainterInfo;
  42 class ParagraphParameters;
  43 class TexRow;
  44
  45
  46 class FontSpan {
  47 public:
  48         /// Invalid font span containing no character
  49         FontSpan() : first(0), last(-1) {}
  50         /// Span including first and last
  51         FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
  52
  53 public:
  54         /// Range including first and last.
  55         pos_type first, last;
  56 };
  57
  58
  59 /// A Paragraph holds all text, attributes and insets in a text paragraph
  60 /// \todo FIXME: any reference to ParagraphMetrics (including inheritance)
  61 /// should go in order to complete the Model/View separation of this class.
  62 class Paragraph  {
  63 public:
  64         ///
  65         enum {
  66                 /// Note that this is 1 right now to avoid
  67                 /// crashes where getChar() is called wrongly
  68                 /// (returning 0) - if this was 0, then we'd
  69                 /// try getInset() and crash. We should fix
  70                 /// all these places.
  71                 //META_INSET = 1 // as in trunk
  72                 META_INSET = 0x200001  // above 0x10ffff, for ucs-4
  73         };
  74         ///
  75         typedef char_type value_type;
  76         ///
  77         typedef std::vector<value_type> TextContainer;
  78
  79         ///
  80         Paragraph();
  81         ///
  82         Paragraph(Paragraph const &);
  83         ///
  84         Paragraph & operator=(Paragraph const &);
  85         ///
  86         ~Paragraph();
  87         ///
  88         int id() const;
  89
  90
  91         ///
  92         Language const * getParLanguage(BufferParams const &) const;
  93         ///
  94         bool isRTL(BufferParams const &) const;
  95         ///
  96         void changeLanguage(BufferParams const & bparams,
  97                             Language const * from, Language const * to);
  98         ///
  99         bool isMultiLingual(BufferParams const &) const;
 100
 101         ///
 102         docstring const asString(Buffer const &, bool label) const;
 103         ///
 104         docstring const asString(Buffer const & buffer,
 105                                    pos_type beg,
 106                                    pos_type end,
 107                                    bool label) const;
 108
 109         ///
 110         void write(Buffer const &, std::ostream &, BufferParams const &,
 111                    depth_type & depth) const;
 112         ///
 113         void validate(LaTeXFeatures &) const;
 114
 115         ///
 116         int startTeXParParams(BufferParams const &, odocstream &, TexRow &,
 117                               bool) const;
 118
 119         ///
 120         int endTeXParParams(BufferParams const &, odocstream &, TexRow &,
 121                             bool) const;
 122
 123
 124         ///
 125         bool simpleTeXOnePar(Buffer const &, BufferParams const &,
 126                              Font const & outerfont, odocstream &,
 127                              TexRow & texrow, OutputParams const &) const;
 128
 129         /// Can we drop the standard paragraph wrapper?
 130         bool emptyTag() const;
 131
 132         /// Get the id of the paragraph, usefull for docbook
 133         std::string getID(Buffer const & buf,
 134                           OutputParams const & runparams) const;
 135
 136         /// Get the first word of a paragraph, return the position where it left
 137         pos_type getFirstWord(Buffer const & buf,
 138                                    odocstream & os,
 139                                    OutputParams const & runparams) const;
 140
 141         /// Checks if the paragraph contains only text and no inset or font change.
 142         bool onlyText(Buffer const & buf, Font const & outerfont,
 143                       pos_type initial) const;
 144
 145         /// Writes to stream the docbook representation
 146         void simpleDocBookOnePar(Buffer const & buf,
 147                                  odocstream &,
 148                                  OutputParams const & runparams,
 149                                  Font const & outerfont,
 150                                  pos_type initial = 0) const;
 151
 152         ///
 153         bool hasSameLayout(Paragraph const & par) const;
 154
 155         ///
 156         void makeSameLayout(Paragraph const & par);
 157
 158         ///
 159         void setInsetOwner(Inset * inset);
 160         ///
 161         Inset * inInset() const;
 162         ///
 163         InsetCode ownerCode() const;
 164         ///
 165         bool forceDefaultParagraphs() const;
 166
 167         ///
 168         pos_type size() const { return text_.size(); }
 169         ///
 170         bool empty() const { return text_.empty(); }
 171
 172         ///
 173         LayoutPtr const & layout() const;
 174         ///
 175         void layout(LayoutPtr const & new_layout);
 176
 177         /// This is the item depth, only used by enumerate and itemize
 178         signed char itemdepth;
 179
 180         ///
 181         InsetBibitem * bibitem() const;  // ale970302
 182
 183         /// look up change at given pos
 184         Change const & lookupChange(pos_type pos) const;
 185
 186         /// is there a change within the given range ?
 187         bool isChanged(pos_type start, pos_type end) const;
 188         /// is there an unchanged char at the given pos ?
 189         bool isUnchanged(pos_type pos) const {
 190                 return lookupChange(pos).type == Change::UNCHANGED;
 191         }
 192         /// is there an insertion at the given pos ?
 193         bool isInserted(pos_type pos) const {
 194                 return lookupChange(pos).type == Change::INSERTED;
 195         }
 196         /// is there a deletion at the given pos ?
 197         bool isDeleted(pos_type pos) const {
 198                 return lookupChange(pos).type == Change::DELETED;
 199         }
 200
 201         /// will the paragraph be physically merged with the next
 202         /// one if the imaginary end-of-par character is logically deleted?
 203         bool isMergedOnEndOfParDeletion(bool trackChanges) const;
 204
 205         /// set change for the entire par
 206         void setChange(Change const & change);
 207
 208         /// set change at given pos
 209         void setChange(pos_type pos, Change const & change);
 210
 211         /// accept changes within the given range
 212         void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
 213
 214         /// reject changes within the given range
 215         void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
 216
 217         /// Paragraphs can contain "manual labels", for example, Description
 218         /// environment. The text for this user-editable label is stored in
 219         /// the paragraph alongside the text of the rest of the paragraph
 220         /// (the body). This function returns the starting position of the
 221         /// body of the text in the paragraph.
 222         pos_type beginOfBody() const;
 223         /// recompute this value
 224         void setBeginOfBody();
 225
 226         ///
 227         docstring const & getLabelstring() const;
 228
 229         /// the next two functions are for the manual labels
 230         docstring const getLabelWidthString() const;
 231         /// Set label width string.
 232         void setLabelWidthString(docstring const & s);
 233         /// translate \p label to the paragraph language if possible.
 234         docstring const translateIfPossible(docstring const & label,
 235                 BufferParams const & bparams) const;
 236         /// Expand the counters for the labelstring of \c layout
 237         docstring expandLabel(LayoutPtr const &, BufferParams const &,
 238                 bool process_appendix = true) const;
 239         /// Actual paragraph alignment used
 240         char getAlign() const;
 241         /// The nesting depth of a paragraph
 242         depth_type getDepth() const;
 243         /// The maximal possible depth of a paragraph after this one
 244         depth_type getMaxDepthAfter() const;
 245         ///
 246         void applyLayout(LayoutPtr const & new_layout);
 247
 248         /// (logically) erase the char at pos; return true if it was actually erased
 249         bool eraseChar(pos_type pos, bool trackChanges);
 250         /// (logically) erase the given range; return the number of chars actually erased
 251         int eraseChars(pos_type start, pos_type end, bool trackChanges);
 252
 253         /** Get uninstantiated font setting. Returns the difference
 254             between the characters font and the layoutfont.
 255             This is what is stored in the fonttable
 256         */
 257         Font const
 258         getFontSettings(BufferParams const &, pos_type pos) const;
 259         ///
 260         Font const getFirstFontSettings(BufferParams const &) const;
 261
 262         /** Get fully instantiated font. If pos == -1, use the layout
 263             font attached to this paragraph.
 264             If pos == -2, use the label font of the layout attached here.
 265             In all cases, the font is instantiated, i.e. does not have any
 266             attributes with values Font::INHERIT, Font::IGNORE or
 267             Font::TOGGLE.
 268         */
 269         Font const getFont(BufferParams const &, pos_type pos,
 270                               Font const & outerfont) const;
 271         Font const getLayoutFont(BufferParams const &,
 272                                     Font const & outerfont) const;
 273         Font const getLabelFont(BufferParams const &,
 274                                    Font const & outerfont) const;
 275         /**
 276          * The font returned by the above functions is the same in a
 277          * span of characters. This method will return the first and
 278          * the last positions in the paragraph for which that font is
 279          * the same. This can be used to avoid unnecessary calls to getFont.
 280          */
 281         FontSpan fontSpan(pos_type pos) const;
 282         ///
 283         /// this is a bottleneck.
 284         value_type getChar(pos_type pos) const { return text_[pos]; }
 285         /// Get the char, but mirror all bracket characters if it is right-to-left
 286         value_type getUChar(BufferParams const &, pos_type pos) const;
 287         /// pos <= size() (there is a dummy font change at the end of each par)
 288         void setFont(pos_type pos, Font const & font);
 289         /// Returns the height of the highest font in range
 290         Font_size highestFontInRange(pos_type startpos,
 291                                         pos_type endpos, Font_size def_size) const;
 292         ///
 293         void insert(pos_type pos, docstring const & str,
 294                     Font const & font, Change const & change);
 295         ///
 296         void insertChar(pos_type pos, value_type c, bool trackChanges);
 297         ///
 298         void insertChar(pos_type pos, value_type c,
 299                         Font const &, bool trackChanges);
 300         ///
 301         void insertChar(pos_type pos, value_type c,
 302                         Font const &, Change const & change);
 303         ///
 304         void insertInset(pos_type pos, Inset * inset,
 305                          Change const & change);
 306         ///
 307         void insertInset(pos_type pos, Inset * inset,
 308                          Font const &, Change const & change);
 309         ///
 310         bool insetAllowed(InsetCode code);
 311         ///
 312         Inset * getInset(pos_type pos) {
 313                 return insetlist.get(pos);
 314         }
 315         ///
 316         Inset const * getInset(pos_type pos) const {
 317                 return insetlist.get(pos);
 318         }
 319
 320         ///
 321         bool isHfill(pos_type pos) const;
 322
 323         /// hinted by profiler
 324         bool isInset(pos_type pos) const {
 325                 return getChar(pos) == static_cast<value_type>(META_INSET);
 326         }
 327         ///
 328         bool isNewline(pos_type pos) const;
 329         /// return true if the char is a word separator
 330         bool isSeparator(pos_type pos) const { return getChar(pos) == ' '; }
 331         ///
 332         bool isLineSeparator(pos_type pos) const;
 333         /// True if the character/inset at this point can be part of a word.
 334         /// Note that digits in particular are considered as letters
 335         bool isLetter(pos_type pos) const;
 336
 337         /// returns -1 if inset not found
 338         int getPositionOfInset(Inset const * inset) const;
 339
 340         /// returns true if at least one line break or line separator has been deleted
 341         /// at the beginning of the paragraph (either physically or logically)
 342         bool stripLeadingSpaces(bool trackChanges);
 343
 344         /// return true if we allow multiple spaces
 345         bool isFreeSpacing() const;
 346
 347         /// return true if we allow this par to stay empty
 348         bool allowEmpty() const;
 349         ///
 350         char_type transformChar(char_type c, pos_type pos) const;
 351         ///
 352         ParagraphParameters & params();
 353         ///
 354         ParagraphParameters const & params() const;
 355
 356         /// Check if we are in a Biblio environment and insert or
 357         /// delete InsetBibitems as necessary.
 358         /// \retval int 1, if we had to add an inset, in which case
 359         /// the cursor will need to move cursor forward; -pos, if we deleted
 360         /// an inset, in which case pos is the position from which the inset
 361         /// was deleted, and the cursor will need to be moved back one if it
 362         /// was previously past that position. Return 0 otherwise.
 363         int checkBiblio(bool track_changes);
 364
 365         /// For each author, set 'used' to true if there is a change
 366         /// by this author in the paragraph.
 367         void checkAuthors(AuthorList const & authorList);
 368
 369 public:
 370         ///
 371         InsetList insetlist;
 372
 373 private:
 374
 375         ///
 376         LayoutPtr layout_;
 377         /**
 378          * Keeping this here instead of in the pimpl makes LyX >10% faster
 379          * for average tasks as buffer loading/switching etc.
 380          */
 381         TextContainer text_;
 382         /// end of label
 383         pos_type begin_of_body_;
 384
 385         /// Pimpl away stuff
 386         class Pimpl;
 387         ///
 388         friend class Paragraph::Pimpl;
 389         ///
 390         Pimpl * pimpl_;
 391 };
 392
 393 } // namespace lyx
 394
 395 #endif // PARAGRAPH_H