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 "FontEnums.h"
  20 #include "Layout.h"
  21
  22 #include "insets/InsetCode.h"
  23
  24 #include "support/strfwd.h"
  25 #include "support/types.h"
  26
  27 namespace lyx {
  28
  29 class AuthorList;
  30 class Buffer;
  31 class BufferParams;
  32 class Change;
  33 class Counters;
  34 class Cursor;
  35 class CursorSlice;
  36 class DocIterator;
  37 class DocumentClass;
  38 class Inset;
  39 class InsetBibitem;
  40 class LaTeXFeatures;
  41 class Inset_code;
  42 class InsetList;
  43 class Language;
  44 class Font;
  45 class Font_size;
  46 class MetricsInfo;
  47 class OutputParams;
  48 class PainterInfo;
  49 class ParagraphParameters;
  50 class TexRow;
  51 class Toc;
  52
  53 class FontSpan {
  54 public:
  55         /// Invalid font span containing no character
  56         FontSpan() : first(0), last(-1) {}
  57         /// Span including first and last
  58         FontSpan(pos_type f, pos_type l) : first(f), last(l) {}
  59
  60 public:
  61         /// Range including first and last.
  62         pos_type first, last;
  63 };
  64
  65 ///
  66 enum TextCase {
  67         ///
  68         text_lowercase = 0,
  69         ///
  70         text_capitalization = 1,
  71         ///
  72         text_uppercase = 2
  73 };
  74
  75
  76 ///
  77 enum AsStringParameter
  78 {
  79         AS_STR_NONE = 0, ///< No option, only printable characters.
  80         AS_STR_LABEL = 1, ///< Prefix with paragraph label.
  81         AS_STR_INSETS = 2, ///< Go into insets.
  82         AS_STR_NEWLINES = 4 ///< Get also newline characters.
  83 };
  84
  85
  86 /// A Paragraph holds all text, attributes and insets in a text paragraph
  87 class Paragraph
  88 {
  89 public:
  90         ///
  91         Paragraph();
  92         ///
  93         Paragraph(Paragraph const &);
  94         /// Partial copy constructor.
  95         /// Copy the Paragraph contents from \p beg to \p end (without end).
  96         Paragraph(Paragraph const & par, pos_type beg, pos_type end);
  97         ///
  98         Paragraph & operator=(Paragraph const &);
  99         ///
 100         ~Paragraph();
 101         ///
 102         int id() const;
 103
 104         ///
 105         void addChangesToToc(DocIterator const & cdit, Buffer const & buf) const;
 106         ///
 107         Language const * getParLanguage(BufferParams const &) const;
 108         ///
 109         bool isRTL(BufferParams const &) const;
 110         ///
 111         void changeLanguage(BufferParams const & bparams,
 112                             Language const * from, Language const * to);
 113         ///
 114         bool isMultiLingual(BufferParams const &) const;
 115
 116         /// Convert the paragraph to a string.
 117         /// \param AsStringParameter options. This can contain any combination of
 118         /// asStringParameter values. Valid examples:
 119         ///             asString(AS_STR_LABEL)
 120         ///             asString(AS_STR_LABEL | AS_STR_INSETS)
 121         ///             asString(AS_STR_INSETS)
 122         docstring asString(int options = AS_STR_NONE) const;
 123         ///
 124         docstring asString(pos_type beg, pos_type end,
 125                 int options = AS_STR_NONE) const;
 126
 127         /// Extract only the explicitly visible text (without any formatting),
 128         /// descending into insets
 129         docstring stringify(pos_type beg, pos_type end, int options, OutputParams & runparams) const;
 130
 131         ///
 132         void write(std::ostream &, BufferParams const &,
 133                    depth_type & depth) const;
 134         ///
 135         void validate(LaTeXFeatures &) const;
 136
 137         ///
 138         bool latex(BufferParams const &, Font const & outerfont, odocstream &,
 139                    TexRow & texrow, OutputParams const &,
 140                    int start_pos = 0, int end_pos = -1) const;
 141
 142         /// Can we drop the standard paragraph wrapper?
 143         bool emptyTag() const;
 144
 145         /// Get the id of the paragraph, usefull for docbook
 146         std::string getID(Buffer const & buf, OutputParams const & runparams) const;
 147
 148         /// Output the first word of a paragraph, return the position where it left.
 149         pos_type firstWordDocBook(odocstream & os, OutputParams const & runparams) const;
 150
 151         /// Output the first word of a paragraph, return the position where it left.
 152         pos_type firstWordLyXHTML(odocstream & os, OutputParams const & runparams) const;
 153
 154         /// Writes to stream the docbook representation
 155         void simpleDocBookOnePar(Buffer const & buf,
 156                                  odocstream &,
 157                                  OutputParams const & runparams,
 158                                  Font const & outerfont,
 159                                  pos_type initial = 0) const;
 160         ///
 161         void simpleLyXHTMLOnePar(Buffer const & buf,
 162                                  odocstream &,
 163                                  OutputParams const & runparams,
 164                                  Font const & outerfont,
 165                                  pos_type initial = 0) const;
 166
 167         ///
 168         bool hasSameLayout(Paragraph const & par) const;
 169
 170         ///
 171         void makeSameLayout(Paragraph const & par);
 172
 173         ///
 174         void setInsetOwner(Inset const * inset);
 175         ///
 176         Inset const & inInset() const;
 177         ///
 178         InsetCode ownerCode() const;
 179         ///
 180         bool forcePlainLayout() const;
 181         ///
 182         bool allowParagraphCustomization() const;
 183         ///
 184         bool usePlainLayout() const;
 185         ///
 186         pos_type size() const;
 187         ///
 188         bool empty() const;
 189
 190         ///
 191         Layout const & layout() const;
 192         /// Do not pass a temporary to this!
 193         void setLayout(Layout const & layout);
 194         ///
 195         void setPlainOrDefaultLayout(DocumentClass const & tc);
 196         ///
 197         void setDefaultLayout(DocumentClass const & tc);
 198         ///
 199         void setPlainLayout(DocumentClass const & tc);
 200
 201         /// This is the item depth, only used by enumerate and itemize
 202         signed char itemdepth;
 203
 204         /// look up change at given pos
 205         Change const & lookupChange(pos_type pos) const;
 206
 207         /// is there a change within the given range ?
 208         bool isChanged(pos_type start, pos_type end) const;
 209         /// is there an unchanged char at the given pos ?
 210         bool isUnchanged(pos_type pos) const;
 211         /// is there an insertion at the given pos ?
 212         bool isInserted(pos_type pos) const;
 213         /// is there a deletion at the given pos ?
 214         bool isDeleted(pos_type pos) const;
 215         /// is the whole paragraph deleted ?
 216         bool isFullyDeleted(pos_type start, pos_type end) const;
 217
 218         /// will the paragraph be physically merged with the next
 219         /// one if the imaginary end-of-par character is logically deleted?
 220         bool isMergedOnEndOfParDeletion(bool trackChanges) const;
 221
 222         /// set change for the entire par
 223         void setChange(Change const & change);
 224
 225         /// set change at given pos
 226         void setChange(pos_type pos, Change const & change);
 227
 228         /// accept changes within the given range
 229         void acceptChanges(BufferParams const & bparams, pos_type start, pos_type end);
 230
 231         /// reject changes within the given range
 232         void rejectChanges(BufferParams const & bparams, pos_type start, pos_type end);
 233
 234         /// Paragraphs can contain "manual labels", for example, Description
 235         /// environment. The text for this user-editable label is stored in
 236         /// the paragraph alongside the text of the rest of the paragraph
 237         /// (the body). This function returns the starting position of the
 238         /// body of the text in the paragraph.
 239         pos_type beginOfBody() const;
 240         /// recompute this value
 241         void setBeginOfBody();
 242
 243         ///
 244         docstring const & labelString() const;
 245
 246         /// the next two functions are for the manual labels
 247         docstring const getLabelWidthString() const;
 248         /// Set label width string.
 249         void setLabelWidthString(docstring const & s);
 250         /// translate \p label to the paragraph language if possible.
 251         docstring const translateIfPossible(docstring const & label,
 252                 BufferParams const & bparams) const;
 253         /// Expand the counters for the labelstring of \c layout
 254         docstring expandLabel(Layout const &, BufferParams const &,
 255                 bool process_appendix = true) const;
 256         /// Actual paragraph alignment used
 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(Layout const & new_layout);
 264
 265         /// (logically) erase the char at pos; return true if it was actually erased
 266         bool eraseChar(pos_type pos, bool trackChanges);
 267         /// (logically) erase the given range; return the number of chars actually erased
 268         int eraseChars(pos_type start, pos_type end, bool trackChanges);
 269
 270         ///
 271         void resetFonts(Font const & font);
 272
 273         /** Get uninstantiated font setting. Returns the difference
 274             between the characters font and the layoutfont.
 275             This is what is stored in the fonttable
 276         */
 277         Font const &
 278         getFontSettings(BufferParams const &, pos_type pos) const;
 279         ///
 280         Font const & getFirstFontSettings(BufferParams const &) const;
 281
 282         /** Get fully instantiated font. If pos == -1, use the layout
 283             font attached to this paragraph.
 284             If pos == -2, use the label font of the layout attached here.
 285             In all cases, the font is instantiated, i.e. does not have any
 286             attributes with values FONT_INHERIT, FONT_IGNORE or
 287             FONT_TOGGLE.
 288         */
 289         Font const getFont(BufferParams const &, pos_type pos,
 290                               Font const & outerfont) const;
 291         Font const getLayoutFont(BufferParams const &,
 292                                     Font const & outerfont) const;
 293         Font const getLabelFont(BufferParams const &,
 294                                    Font const & outerfont) const;
 295         /**
 296          * The font returned by the above functions is the same in a
 297          * span of characters. This method will return the first and
 298          * the last positions in the paragraph for which that font is
 299          * the same. This can be used to avoid unnecessary calls to getFont.
 300          */
 301         FontSpan fontSpan(pos_type pos) const;
 302         ///
 303         char_type getChar(pos_type pos) const;
 304         /// Get the char, but mirror all bracket characters if it is right-to-left
 305         char_type getUChar(BufferParams const &, pos_type pos) const;
 306         /// pos <= size() (there is a dummy font change at the end of each par)
 307         void setFont(pos_type pos, Font const & font);
 308         /// Returns the height of the highest font in range
 309         FontSize highestFontInRange(pos_type startpos,
 310                                         pos_type endpos, FontSize def_size) const;
 311         ///
 312         void insert(pos_type pos, docstring const & str,
 313                     Font const & font, Change const & change);
 314
 315         ///
 316         void appendString(docstring const & s, Font const & font,
 317                 Change const & change);
 318         ///
 319         void appendChar(char_type c, Font const & font, Change const & change);
 320         ///
 321         void insertChar(pos_type pos, char_type c, bool trackChanges);
 322         ///
 323         void insertChar(pos_type pos, char_type c,
 324                         Font const &, bool trackChanges);
 325         ///
 326         void insertChar(pos_type pos, char_type c,
 327                         Font const &, Change const & change);
 328         /// Insert \p inset at position \p pos with \p change traking status.
 329         /// \return true if successful.
 330         bool insertInset(pos_type pos, Inset * inset,
 331                          Change const & change);
 332         /// Insert \p inset at position \p pos with \p change traking status and
 333         /// \p font.
 334         /// \return true if successful.
 335         bool insertInset(pos_type pos, Inset * inset,
 336                          Font const & font, Change const & change);
 337         ///
 338         Inset * getInset(pos_type pos);
 339         ///
 340         Inset const * getInset(pos_type pos) const;
 341
 342         /// Release inset at given position.
 343         /// \warning does not honour change tracking!
 344         /// Therefore, it should only be used for breaking and merging
 345         /// paragraphs
 346         Inset * releaseInset(pos_type pos);
 347
 348         ///
 349         InsetList const & insetList() const;
 350         ///
 351         void setBuffer(Buffer &);
 352
 353         ///
 354         bool isHfill(pos_type pos) const;
 355
 356         /// hinted by profiler
 357         bool isInset(pos_type pos) const;
 358         ///
 359         bool isNewline(pos_type pos) const;
 360         /// return true if the char is a word separator
 361         bool isSeparator(pos_type pos) const;
 362         ///
 363         bool isLineSeparator(pos_type pos) const;
 364         /// True if the character/inset at this point can be part of a word.
 365         /// Note that digits in particular are considered as letters
 366         bool isLetter(pos_type pos) const;
 367         /// True if the element at this point is a character that is not a letter.
 368         bool isChar(pos_type pos) const;
 369         /// True if the element at this point is a space
 370         bool isSpace(pos_type pos) const;
 371
 372         /// returns true if at least one line break or line separator has been deleted
 373         /// at the beginning of the paragraph (either physically or logically)
 374         bool stripLeadingSpaces(bool trackChanges);
 375
 376         /// return true if we allow multiple spaces
 377         bool isFreeSpacing() const;
 378
 379         /// return true if we allow this par to stay empty
 380         bool allowEmpty() const;
 381         ///
 382         char_type transformChar(char_type c, pos_type pos) const;
 383         ///
 384         ParagraphParameters & params();
 385         ///
 386         ParagraphParameters const & params() const;
 387
 388         /// Check if we are in a Biblio environment and insert or
 389         /// delete InsetBibitems as necessary.
 390         /// \retval int 1, if we had to add an inset, in which case
 391         /// the cursor will need to move cursor forward; -pos, if we deleted
 392         /// an inset, in which case pos is the position from which the inset
 393         /// was deleted, and the cursor will need to be moved back one if it
 394         /// was previously past that position. Return 0 otherwise.
 395         int checkBiblio(Buffer const & buffer);
 396
 397         /// For each author, set 'used' to true if there is a change
 398         /// by this author in the paragraph.
 399         void checkAuthors(AuthorList const & authorList);
 400
 401         ///
 402         void changeCase(BufferParams const & bparams, pos_type pos,
 403                 pos_type & right, TextCase action);
 404
 405         /// find \param str string inside Paragraph.
 406         /// \return true if the specified string is at the specified position
 407         /// \param del specifies whether deleted strings in ct mode will be considered
 408         bool find(
 409                 docstring const & str, ///< string to search
 410                 bool cs, ///<
 411                 bool mw, ///<
 412                 pos_type pos, ///< start from here.
 413                 bool del = true) const;
 414
 415         void locateWord(pos_type & from, pos_type & to,
 416                 word_location const loc) const;
 417         ///
 418         void updateWords();
 419         /// Spellcheck word at position \p pos.
 420         /// \return true if pointed word is misspelled.
 421         bool isMisspelled(pos_type pos) const;
 422
 423 private:
 424         ///
 425         void deregisterWords();
 426         ///
 427         void collectWords();
 428         ///
 429         void registerWords();
 430
 431         /// Pimpl away stuff
 432         class Private;
 433         ///
 434         friend class Paragraph::Private;
 435         ///
 436         Private * d;
 437 };
 438
 439 } // namespace lyx
 440
 441 #endif // PARAGRAPH_H