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