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