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